libvirt.c 320.8 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-2010 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
#ifdef HAVE_SYS_WAIT_H
22
# include <sys/wait.h>
23
#endif
24
#include <time.h>
D
Daniel P. Berrange 已提交
25
#include <gcrypt.h>
26

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

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

36
#include "virterror_internal.h"
37
#include "logging.h"
38
#include "datatypes.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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
# ifdef WITH_TEST
#  include "test/test_driver.h"
# endif
# ifdef WITH_XEN
#  include "xen/xen_driver.h"
# endif
# ifdef WITH_REMOTE
#  include "remote/remote_driver.h"
# endif
# ifdef WITH_OPENVZ
#  include "openvz/openvz_driver.h"
# endif
# ifdef WITH_PHYP
#  include "phyp/phyp_driver.h"
# endif
# ifdef WITH_VBOX
#  include "vbox/vbox_driver.h"
# endif
# ifdef WITH_ESX
#  include "esx/esx_driver.h"
# endif
67 68 69
# ifdef WITH_XENAPI
#  include "xenapi/xenapi_driver.h"
# endif
70
#endif
71

72 73
#define VIR_FROM_THIS VIR_FROM_NONE

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

80 81
#define MAX_DRIVERS 10

82
static virDriverPtr virDriverTab[MAX_DRIVERS];
83
static int virDriverTabCount = 0;
84
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
85
static int virNetworkDriverTabCount = 0;
D
Daniel Veillard 已提交
86 87
static virInterfaceDriverPtr virInterfaceDriverTab[MAX_DRIVERS];
static int virInterfaceDriverTabCount = 0;
88 89
static virStorageDriverPtr virStorageDriverTab[MAX_DRIVERS];
static int virStorageDriverTabCount = 0;
90 91
static virDeviceMonitorPtr virDeviceMonitorTab[MAX_DRIVERS];
static int virDeviceMonitorTabCount = 0;
92 93
static virSecretDriverPtr virSecretDriverTab[MAX_DRIVERS];
static int virSecretDriverTabCount = 0;
S
Stefan Berger 已提交
94 95
static virNWFilterDriverPtr virNWFilterDriverTab[MAX_DRIVERS];
static int virNWFilterDriverTabCount = 0;
A
Atsushi SAKAI 已提交
96
#ifdef WITH_LIBVIRTD
97 98
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
A
Atsushi SAKAI 已提交
99
#endif
100 101
static int initialized = 0;

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
#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

135 136 137 138 139 140 141 142
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;
143
        size_t len;
144 145

        switch (cred[i].type) {
146 147 148 149
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

150
#if defined(POLKIT_AUTH)
151
            if (virConnectAuthGainPolkit(cred[i].prompt) < 0)
152
                return -1;
153 154 155 156 157 158 159
#else
            /*
             * Ignore & carry on. Although we can't auth
             * directly, the user may have authenticated
             * themselves already outside context of libvirt
             */
#endif
160 161
            break;
        }
162

163 164 165 166
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
167
            if (printf("%s: ", cred[i].prompt) < 0)
168 169 170 171
                return -1;
            if (fflush(stdout) != 0)
                return -1;

172 173 174 175 176 177 178
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
179 180 181
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
182 183 184 185
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
186
            if (printf("%s: ", cred[i].prompt) < 0)
187 188 189 190
                return -1;
            if (fflush(stdout) != 0)
                return -1;

191 192 193 194
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
195 196 197

        default:
            return -1;
198 199
        }

D
Daniel P. Berrange 已提交
200 201 202 203 204 205 206 207 208
        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);
        }
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    }

    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,
224
    VIR_CRED_EXTERNAL,
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
};

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;

246 247 248 249 250 251 252 253 254 255
#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 已提交
256
    return err == 0 ? 0 : -1;
257 258 259
}
#endif

D
Daniel P. Berrange 已提交
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
static int virTLSMutexInit (void **priv)
{                                                                             \
    virMutexPtr lock = NULL;

    if (VIR_ALLOC(lock) < 0)
        return ENOMEM;

    if (virMutexInit(lock) < 0) {
        VIR_FREE(lock);
        return errno;
    }

    *priv = lock;
    return 0;
}

static int virTLSMutexDestroy(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexDestroy(lock);
    VIR_FREE(lock);
    return 0;
}

static int virTLSMutexLock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexLock(lock);
    return 0;
}

static int virTLSMutexUnlock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexUnlock(lock);
    return 0;
}

static struct gcry_thread_cbs virTLSThreadImpl = {
299 300
    /* GCRY_THREAD_OPTION_VERSION was added in gcrypt 1.4.2 */
#ifdef GCRY_THREAD_OPTION_VERSION
D
Daniel P. Berrange 已提交
301
    (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8)),
302 303 304
#else
    GCRY_THREAD_OPTION_PTHREAD,
#endif
D
Daniel P. Berrange 已提交
305 306 307 308 309 310 311 312 313
    NULL,
    virTLSMutexInit,
    virTLSMutexDestroy,
    virTLSMutexLock,
    virTLSMutexUnlock,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
};


314 315 316 317 318 319 320 321 322 323 324 325 326 327
/**
 * 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)
{
    if (initialized)
        return(0);
328

329
    initialized = 1;
330

331
    if (virThreadInitialize() < 0 ||
332 333
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
334 335
        return -1;

D
Daniel P. Berrange 已提交
336 337 338
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

339
    virLogSetFromEnv();
340 341 342

    DEBUG0("register drivers");

343 344 345 346
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

347 348 349
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

350
    /*
351 352
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
353
     */
354 355 356
#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.
D
Dan Kenigsberg 已提交
357
     * If they try to open a connection for a module that
358 359 360 361 362
     * is not loaded they'll get a suitable error at that point
     */
    virDriverLoadModule("test");
    virDriverLoadModule("xen");
    virDriverLoadModule("openvz");
363
    virDriverLoadModule("vbox");
364
    virDriverLoadModule("esx");
365
    virDriverLoadModule("xenapi");
366 367
    virDriverLoadModule("remote");
#else
368
# ifdef WITH_TEST
369
    if (testRegister() == -1) return -1;
370 371
# endif
# ifdef WITH_XEN
372
    if (xenRegister () == -1) return -1;
373 374
# endif
# ifdef WITH_OPENVZ
375
    if (openvzRegister() == -1) return -1;
376 377
# endif
# ifdef WITH_PHYP
378
    if (phypRegister() == -1) return -1;
379 380
# endif
# ifdef WITH_VBOX
381
    if (vboxRegister() == -1) return -1;
382 383
# endif
# ifdef WITH_ESX
384
    if (esxRegister() == -1) return -1;
385
# endif
386 387 388
# ifdef WITH_XENAPI
    if (xenapiRegister() == -1) return -1;
# endif
389
# ifdef WITH_REMOTE
390
    if (remoteRegister () == -1) return -1;
391
# endif
392
#endif
D
Daniel P. Berrange 已提交
393

394 395 396
    return(0);
}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
#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
430 431


D
Daniel Veillard 已提交
432 433 434
/**
 * virLibConnError:
 * @conn: the connection if available
435
 * @error: the error number
D
Daniel Veillard 已提交
436 437 438 439 440
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
441 442
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
443
    const char *errmsg;
444

D
Daniel Veillard 已提交
445 446 447
    if (error == VIR_ERR_OK)
        return;

448 449 450
    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 已提交
451 452 453
}

/**
454
 * virLibConnWarning:
D
Daniel Veillard 已提交
455
 * @conn: the connection if available
456 457 458 459 460 461 462 463 464 465 466 467 468
 * @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;

469 470 471
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
472 473 474 475 476 477
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
478 479 480 481 482
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
483 484 485
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
486 487
    virConnectPtr conn = NULL;
    const char *errmsg;
488

D
Daniel Veillard 已提交
489 490 491
    if (error == VIR_ERR_OK)
        return;

492
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
493 494 495
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
496 497
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
498 499
}

500
/**
501 502
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
503
 * @error: the error number
504
 * @info: extra information string
505
 *
506
 * Handle an error at the connection level
507
 */
508 509 510 511 512 513 514 515 516 517
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

518
    errmsg = virErrorMsg(error, info);
519 520 521
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
522 523
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
524 525
}

D
Daniel Veillard 已提交
526 527 528 529 530 531 532 533 534
/**
 * virLibInterfaceError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
535
virLibInterfaceError(virInterfacePtr iface, virErrorNumber error,
D
Daniel Veillard 已提交
536 537 538 539 540 541 542 543 544 545
                   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) {
546
        conn = iface->conn;
D
Daniel Veillard 已提交
547 548 549 550 551
    }
    virRaiseError(conn, NULL, NULL, VIR_FROM_INTERFACE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

552 553 554
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
555
 * @error: the error number
556 557 558 559 560 561 562 563 564 565 566 567 568 569
 * @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;

570
    errmsg = virErrorMsg(error, info);
571 572 573
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

574 575
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
576 577 578 579 580
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
581
 * @error: the error number
582 583 584 585 586 587 588 589 590 591 592 593 594 595
 * @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;

596
    errmsg = virErrorMsg(error, info);
597 598 599
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

600 601
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
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
/**
 * 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);
}

630
#define virLibStreamError(conn, code, ...)                      \
631
    virReportErrorHelper(conn, VIR_FROM_NONE, code, __FILE__,   \
632
                         __FUNCTION__, __LINE__, __VA_ARGS__)
633

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * virLibSecretError:
 * @secret: the secret if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the secret level
 */
static void
virLibSecretError(virSecretPtr secret, 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_SECRET)
        conn = secret->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_SECRET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

S
Stefan Berger 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
/**
 * virLibNWFilterError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibNWFilterError(virNWFilterPtr pool, 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_NWFILTER)
        conn = pool->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_NWFILTER, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

685 686 687 688 689 690 691 692 693 694 695
/**
 * 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)
{
696 697 698 699 700
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
705 706
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
707 708
    }

709 710 711
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

712 713
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
714 715
}

D
Daniel Veillard 已提交
716 717
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
718
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
719
 *
L
Laine Stump 已提交
720
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
 *
 * 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++;
}

747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
/**
 * 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) {
767
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
768 769 770
        return(-1);
    }

771 772 773
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

774 775 776 777
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
/**
 * 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);
    }

802 803 804
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

805 806 807 808
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
/**
 * virRegisterSecretDriver:
 * @driver: pointer to a secret driver block
 *
 * Register a secret driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterSecretDriver(virSecretDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

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

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

    DEBUG ("registering %s as secret driver %d",
           driver->name, virSecretDriverTabCount);

    virSecretDriverTab[virSecretDriverTabCount] = driver;
    return virSecretDriverTabCount++;
}

S
Stefan Berger 已提交
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
/**
 * virRegisterNWFilterDriver:
 * @driver: pointer to a network filter driver block
 *
 * Register a network filter virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterNWFilterDriver(virNWFilterDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

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

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

    DEBUG ("registering %s as network filter driver %d",
           driver->name, virNWFilterDriverTabCount);

    virNWFilterDriverTab[virNWFilterDriverTabCount] = driver;
    return virNWFilterDriverTabCount++;
}


872 873 874 875 876 877 878 879 880 881 882
/**
 * 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)
{
883 884 885 886 887
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
892 893
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
894 895
    }

896
    if (driver->no < 0) {
897
        virLibConnError
898 899 900 901 902
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

903 904 905
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

906 907
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
908 909
}

A
Atsushi SAKAI 已提交
910
#ifdef WITH_LIBVIRTD
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
/**
 * 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) {
931
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
932 933 934 935 936 937 938
        return(-1);
    }

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

939 940
/**
 * virStateInitialize:
941
 * @privileged: set to 1 if running with root priviledge, 0 otherwise
942 943 944
 *
 * Initialize all virtualization drivers.
 *
945
 * Returns 0 if all succeed, -1 upon any failure.
946
 */
947
int virStateInitialize(int privileged) {
948 949 950 951 952 953
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
954
        if (virStateDriverTab[i]->initialize &&
955 956 957
            virStateDriverTab[i]->initialize(privileged) < 0) {
            VIR_ERROR("Initialization of %s state driver failed",
                      virStateDriverTab[i]->name);
958
            ret = -1;
959
        }
960 961 962 963
    }
    return ret;
}

964 965 966 967 968
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
969
 * Returns 0 if all succeed, -1 upon any failure.
970
 */
D
Daniel P. Berrange 已提交
971
int virStateCleanup(void) {
972 973 974
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
975 976
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
977 978 979 980 981
            ret = -1;
    }
    return ret;
}

982 983 984 985 986
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
987
 * Returns 0 if all succeed, -1 upon any failure.
988
 */
D
Daniel P. Berrange 已提交
989
int virStateReload(void) {
990 991 992
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
993 994
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
995 996 997 998 999
            ret = -1;
    }
    return ret;
}

1000 1001 1002 1003 1004
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
1005
 * Returns 0 if none are active, 1 if at least one is.
1006
 */
D
Daniel P. Berrange 已提交
1007
int virStateActive(void) {
1008 1009 1010
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
1011 1012
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
1013 1014 1015 1016 1017
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
1018
#endif
1019

1020 1021


1022 1023 1024
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
1025
 * @type: the type of connection/driver looked at
1026 1027 1028 1029 1030
 * @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 已提交
1031
 * @type is unknown or not available, an error code will be returned and
1032 1033 1034 1035 1036 1037
 * @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
1038 1039 1040
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
1041
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
1042

1043
    if (!initialized)
1044
        if (virInitialize() < 0)
1045
            goto error;
1046

1047
    if (libVer == NULL)
1048
        goto error;
1049 1050 1051
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
1052
        if (type == NULL)
1053
            type = "Xen";
1054 1055 1056 1057 1058

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

1061
# if WITH_XEN
1062 1063
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
1064 1065
# endif
# if WITH_TEST
1066 1067
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1068 1069
# endif
# if WITH_QEMU
1070 1071
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1072 1073
# endif
# if WITH_LXC
1074 1075
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1076 1077
# endif
# if WITH_PHYP
1078 1079
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1080 1081
# endif
# if WITH_OPENVZ
1082 1083
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1084 1085
# endif
# if WITH_VBOX
1086 1087
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1088 1089
# endif
# if WITH_UML
1090 1091
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1092 1093
# endif
# if WITH_ONE
D
Daniel Veillard 已提交
1094 1095
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1096 1097
# endif
# if WITH_ESX
1098 1099
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1100
# endif
1101 1102 1103 1104
# if WITH_XENAPI
        if (STRCASEEQ(type, "XenAPI"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
1105
# if WITH_REMOTE
1106 1107
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
1108
# endif
1109
        if (*typeVer == 0) {
1110
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
1111
            goto error;
1112
        }
1113
#endif /* WITH_DRIVER_MODULES */
1114 1115
    }
    return (0);
1116 1117 1118 1119

error:
    virDispatchError(NULL);
    return -1;
1120 1121
}

1122
static virConnectPtr
1123 1124 1125
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
1126
{
1127
    int i, res;
1128 1129
    virConnectPtr ret;

1130 1131
    virResetLastError();

1132 1133 1134
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
1135

1136 1137 1138 1139 1140 1141 1142 1143
    /*
     *  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) {
1144
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
1145 1146
            name = defname;
        } else {
1147
            name = NULL;
1148
        }
1149
    }
1150

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
    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;
        }
1168

1169 1170 1171 1172 1173 1174 1175 1176 1177
        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,
1178 1179 1180 1181
              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));
1182 1183
    } else {
        DEBUG0("no name, allowing driver auto-select");
1184 1185
    }

1186 1187 1188
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1189
    for (i = 0; i < virDriverTabCount; i++) {
1190 1191
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
1192
        res = virDriverTab[i]->open (ret, auth, flags);
1193 1194 1195 1196 1197
        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")));
1198 1199 1200 1201 1202
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1203 1204
    }

1205
    if (!ret->driver) {
1206 1207
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
1208
        goto failed;
1209 1210
    }

1211
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1212
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1213 1214 1215 1216 1217
        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")));
1218
        if (res == VIR_DRV_OPEN_ERROR) {
1219
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
1220
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
1221 1222
                                   "Is the daemon running ?");
            }
1223 1224
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1225 1226 1227
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1228
    }
1229

D
Daniel Veillard 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
    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;
        }
    }
1248 1249 1250

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1251
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1252 1253 1254 1255 1256 1257
        DEBUG("storage driver %d %s returned %s",
              i, virStorageDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
1258
            if (STREQ(virStorageDriverTab[i]->name, "remote")) {
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
                virLibConnWarning (NULL, VIR_WAR_NO_STORAGE,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->storageDriver = virStorageDriverTab[i];
            break;
        }
    }

1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
    /* 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;
1283 1284
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
        DEBUG("secret driver %d %s returned %s",
              i, virSecretDriverTab[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(virSecretDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_SECRET,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->secretDriver = virSecretDriverTab[i];
            break;
        }
    }

S
Stefan Berger 已提交
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
        DEBUG("nwfilter driver %d %s returned %s",
              i, virNWFilterDriverTab[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(virNWFilterDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NWFILTER,
                                   _("Is the daemon running ?"));
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->nwfilterDriver = virNWFilterDriverTab[i];
            break;
        }
    }

1336
    return ret;
1337 1338

failed:
1339 1340
    virUnrefConnect(ret);

1341
    return NULL;
1342 1343
}

1344 1345
/**
 * virConnectOpen:
1346
 * @name: URI of the hypervisor
1347
 *
1348
 * This function should be called first to get a connection to the
1349 1350 1351
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1352
 *
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
 * If @name is NULL then probing will be done to determine a suitable
 * default driver to activate. This involves trying each hypervisor
 * in turn until one successfully opens. If the LIBVIRT_DEFAULT_URI
 * environment variable is set, then it will be used in preference
 * to probing for a driver.
 *
 * If connecting to an unprivileged hypervisor driver which requires
 * the libvirtd daemon to be active, it will automatically be launched
 * if not already running. This can be prevented by setting the
 * environment variable LIBVIRT_AUTOSTART=0
 *
1364
 * URIs are documented at http://libvirt.org/uri.html
1365 1366 1367 1368
 */
virConnectPtr
virConnectOpen (const char *name)
{
1369
    virConnectPtr ret = NULL;
1370 1371
    if (!initialized)
        if (virInitialize() < 0)
1372
            goto error;
1373

1374
    DEBUG("name=%s", name);
1375 1376 1377 1378 1379 1380 1381 1382
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1383 1384
}

1385
/**
1386
 * virConnectOpenReadOnly:
1387
 * @name: URI of the hypervisor
1388
 *
1389
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1390
 * library functionalities. The set of APIs usable are then restricted
1391
 * on the available methods to control the domains.
1392
 *
1393 1394 1395
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1396
 * Returns a pointer to the hypervisor connection or NULL in case of error
1397 1398
 *
 * URIs are documented at http://libvirt.org/uri.html
1399
 */
1400
virConnectPtr
1401 1402
virConnectOpenReadOnly(const char *name)
{
1403
    virConnectPtr ret = NULL;
1404 1405
    if (!initialized)
        if (virInitialize() < 0)
1406
            goto error;
1407

1408
    DEBUG("name=%s", name);
1409 1410 1411 1412 1413 1414 1415 1416
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1417 1418 1419 1420 1421 1422 1423 1424
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1425
 * This function should be called first to get a connection to the
1426
 * Hypervisor. If necessary, authentication will be performed fetching
1427 1428
 * credentials via the callback
 *
1429 1430 1431
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1432 1433 1434 1435 1436 1437 1438 1439 1440
 * 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)
{
1441
    virConnectPtr ret = NULL;
1442 1443
    if (!initialized)
        if (virInitialize() < 0)
1444
            goto error;
1445

1446
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1447 1448 1449 1450 1451 1452 1453 1454
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1455 1456 1457
}

/**
1458
 * virConnectClose:
D
Daniel Veillard 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
 * @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
1469 1470
virConnectClose(virConnectPtr conn)
{
1471
    int ret = -1;
1472 1473
    DEBUG("conn=%p", conn);

1474 1475 1476 1477
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1478
        goto error;
1479
    }
1480

1481 1482 1483 1484 1485 1486 1487 1488
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return ret;
D
Daniel Veillard 已提交
1489 1490
}

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
/**
 * 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 已提交
1505 1506
 *
 * Returns 0 in case of success, -1 in case of failure
1507 1508 1509 1510 1511 1512
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
1513
        virDispatchError(NULL);
1514 1515 1516 1517 1518 1519 1520 1521 1522
        return(-1);
    }
    virMutexLock(&conn->lock);
    DEBUG("conn=%p refs=%d", conn, conn->refs);
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1523 1524
/*
 * Not for public use.  This function is part of the internal
1525 1526 1527
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1528
virDrvSupportsFeature (virConnectPtr conn, int feature)
1529
{
1530
    int ret;
1531 1532
    DEBUG("conn=%p, feature=%d", conn, feature);

1533 1534 1535 1536
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1537
        virDispatchError(NULL);
1538
        return (-1);
1539
    }
1540

1541
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
1542 1543

    if (ret < 0)
1544
        virDispatchError(conn);
1545

1546
    return ret;
1547 1548
}

1549 1550 1551 1552 1553 1554 1555
/**
 * 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.
1556 1557 1558
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1559 1560
 */
const char *
1561 1562
virConnectGetType(virConnectPtr conn)
{
1563
    const char *ret;
1564
    DEBUG("conn=%p", conn);
1565

1566 1567
    virResetLastError();

D
Daniel Veillard 已提交
1568
    if (!VIR_IS_CONNECT(conn)) {
1569
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1570
        virDispatchError(NULL);
1571
        return (NULL);
D
Daniel Veillard 已提交
1572
    }
1573 1574 1575 1576

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1577
    }
1578
    return conn->driver->name;
1579 1580
}

D
Daniel Veillard 已提交
1581
/**
1582
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1583
 * @conn: pointer to the hypervisor connection
1584
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1585
 *
1586
 * Get the version level of the Hypervisor running. This may work only with
1587
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1588
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1589
 *
1590 1591 1592
 * 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 已提交
1593
 */
1594
int
1595 1596
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1597 1598
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1599 1600
    virResetLastError();

D
Daniel Veillard 已提交
1601
    if (!VIR_IS_CONNECT(conn)) {
1602
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1603
        virDispatchError(NULL);
1604
        return -1;
D
Daniel Veillard 已提交
1605
    }
1606

D
Daniel Veillard 已提交
1607 1608
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1609
        goto error;
D
Daniel Veillard 已提交
1610
    }
1611

1612 1613 1614 1615 1616 1617
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1618

1619
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1620 1621

error:
1622
    virDispatchError(conn);
1623
    return -1;
1624 1625
}

1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
/**
 * virConnectGetLibVersion:
 * @conn: pointer to the hypervisor connection
 * @libVer: returns the libvirt library version used on the connection (OUT)
 *
 * Provides @libVer, which is the version of libvirt used by the
 *   daemon running on the @conn host
 *
 * Returns -1 in case of failure, 0 otherwise, and values for @libVer have
 *      the format major * 1,000,000 + minor * 1,000 + release.
 */
int
virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer)
{
    int ret = -1;
    DEBUG("conn=%p, libVir=%p", conn, libVer);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1647
        virDispatchError(NULL);
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
        return -1;
    }

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

    if (conn->driver->libvirtVersion) {
        ret = conn->driver->libvirtVersion(conn, libVer);
        if (ret < 0)
            goto error;
        return ret;
    }

   *libVer = LIBVIR_VERSION_NUMBER;
    ret = 0;
error:
1666
    virDispatchError(conn);
1667 1668 1669
    return ret;
}

1670 1671 1672 1673 1674
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1675
 * running (the result of the gethostname system call).  If
1676 1677 1678 1679 1680 1681 1682 1683 1684
 * 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)
{
1685 1686
    DEBUG("conn=%p", conn);

1687 1688
    virResetLastError();

1689
    if (!VIR_IS_CONNECT(conn)) {
1690
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1691
        virDispatchError(NULL);
1692 1693 1694
        return NULL;
    }

1695 1696 1697 1698 1699 1700
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1701 1702

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1703 1704

error:
1705
    virDispatchError(conn);
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    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)
{
1727
    char *name;
1728 1729
    DEBUG("conn=%p", conn);

1730 1731
    virResetLastError();

1732
    if (!VIR_IS_CONNECT(conn)) {
1733
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1734
        virDispatchError(NULL);
1735 1736 1737
        return NULL;
    }

1738
    name = (char *)xmlSaveUri(conn->uri);
1739
    if (!name) {
1740
        virReportOOMError();
1741
        goto error;
1742 1743
    }
    return name;
1744 1745

error:
1746
    virDispatchError(conn);
1747
    return NULL;
1748 1749
}

1750 1751 1752 1753 1754
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1755
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1756 1757 1758 1759 1760 1761 1762 1763 1764
 * 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)
{
1765 1766
    DEBUG("conn=%p, type=%s", conn, type);

1767 1768
    virResetLastError();

1769
    if (!VIR_IS_CONNECT(conn)) {
1770
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1771
        virDispatchError(NULL);
1772
        return -1;
1773 1774
    }

1775 1776 1777 1778 1779 1780
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1781

1782
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1783
error:
1784
    virDispatchError(conn);
1785
    return -1;
1786 1787
}

1788
/**
1789
 * virConnectListDomains:
1790 1791 1792 1793 1794 1795 1796 1797 1798
 * @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
1799 1800
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1801 1802
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1803 1804
    virResetLastError();

D
Daniel Veillard 已提交
1805
    if (!VIR_IS_CONNECT(conn)) {
1806
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1807
        virDispatchError(NULL);
1808
        return -1;
D
Daniel Veillard 已提交
1809
    }
1810

1811
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1812
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1813
        goto error;
D
Daniel Veillard 已提交
1814
    }
1815

1816 1817 1818 1819 1820 1821
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1822

1823
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1824
error:
1825
    virDispatchError(conn);
1826
    return -1;
D
Daniel Veillard 已提交
1827 1828
}

K
 
Karel Zak 已提交
1829 1830 1831 1832
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1833 1834
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1835 1836 1837
 * Returns the number of domain found or -1 in case of error
 */
int
1838 1839
virConnectNumOfDomains(virConnectPtr conn)
{
1840 1841
    DEBUG("conn=%p", conn);

1842 1843
    virResetLastError();

D
Daniel Veillard 已提交
1844
    if (!VIR_IS_CONNECT(conn)) {
1845
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1846
        virDispatchError(NULL);
1847
        return -1;
D
Daniel Veillard 已提交
1848
    }
K
Karel Zak 已提交
1849

1850 1851 1852 1853 1854 1855
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1856

1857
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1858
error:
1859
    virDispatchError(conn);
1860
    return -1;
K
 
Karel Zak 已提交
1861 1862
}

1863 1864 1865 1866
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1867
 * Provides the connection pointer associated with a domain.  The
1868 1869 1870
 * reference counter on the connection is not increased by this
 * call.
 *
1871 1872 1873 1874
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1875 1876 1877 1878 1879
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1880 1881
    DEBUG("dom=%p", dom);

1882 1883 1884
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1885
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1886
        virDispatchError(NULL);
1887 1888 1889 1890 1891
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1892
/**
1893
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1894
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1895
 * @xmlDesc: string containing an XML description of the domain
1896
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1897
 *
1898
 * Launch a new guest domain, based on an XML description similar
1899
 * to the one returned by virDomainGetXMLDesc()
1900
 * This function may requires privileged access to the hypervisor.
1901 1902 1903
 * 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).
1904
 *
D
Daniel Veillard 已提交
1905 1906
 * Returns a new domain object or NULL in case of failure
 */
1907
virDomainPtr
1908 1909
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1910
{
1911 1912
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

1913 1914
    virResetLastError();

D
Daniel Veillard 已提交
1915
    if (!VIR_IS_CONNECT(conn)) {
1916
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1917
        virDispatchError(NULL);
1918
        return (NULL);
D
Daniel Veillard 已提交
1919 1920 1921
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1922
        goto error;
D
Daniel Veillard 已提交
1923
    }
1924 1925
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1926
        goto error;
1927
    }
D
Daniel Veillard 已提交
1928

1929 1930 1931 1932 1933 1934 1935
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1936 1937

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1938
error:
1939
    virDispatchError(conn);
1940
    return NULL;
D
Daniel Veillard 已提交
1941 1942
}

1943 1944 1945 1946 1947 1948 1949 1950
/**
 * 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.
1951
 * This existing name will left indefinitely for API compatibility.
1952 1953 1954 1955 1956 1957 1958 1959 1960
 *
 * 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));
}
1961

1962
/**
1963
 * virDomainLookupByID:
1964 1965 1966 1967
 * @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 已提交
1968 1969
 * 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.
1970
 *
1971 1972
 * 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.
1973
 */
1974
virDomainPtr
1975 1976
virDomainLookupByID(virConnectPtr conn, int id)
{
1977 1978
    DEBUG("conn=%p, id=%d", conn, id);

1979 1980
    virResetLastError();

D
Daniel Veillard 已提交
1981
    if (!VIR_IS_CONNECT(conn)) {
1982
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1983
        virDispatchError(NULL);
1984
        return (NULL);
D
Daniel Veillard 已提交
1985 1986 1987
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1988
        goto error;
D
Daniel Veillard 已提交
1989
    }
1990

1991 1992 1993 1994 1995 1996 1997
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1998

1999
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2000 2001

error:
2002
    virDispatchError(conn);
2003
    return NULL;
2004 2005 2006 2007 2008
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
2009
 * @uuid: the raw UUID for the domain
2010 2011 2012
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
2013 2014
 * 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.
2015 2016
 */
virDomainPtr
2017 2018
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
2019 2020
    DEBUG("conn=%p, uuid=%s", conn, uuid);

2021 2022
    virResetLastError();

D
Daniel Veillard 已提交
2023
    if (!VIR_IS_CONNECT(conn)) {
2024
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2025
        virDispatchError(NULL);
2026
        return (NULL);
D
Daniel Veillard 已提交
2027 2028 2029
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2030
        goto error;
D
Daniel Veillard 已提交
2031
    }
2032

2033 2034 2035 2036 2037 2038 2039
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
2040

2041
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2042 2043

error:
2044
    virDispatchError(conn);
2045
    return NULL;
2046 2047
}

K
Karel Zak 已提交
2048 2049 2050 2051 2052 2053 2054
/**
 * 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.
 *
2055 2056
 * 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 已提交
2057 2058 2059 2060
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
2061
    unsigned char uuid[VIR_UUID_BUFLEN];
2062 2063
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

2064 2065
    virResetLastError();

K
Karel Zak 已提交
2066
    if (!VIR_IS_CONNECT(conn)) {
2067
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2068
        virDispatchError(NULL);
K
Karel Zak 已提交
2069 2070 2071 2072
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2073
        goto error;
K
Karel Zak 已提交
2074
    }
2075 2076

    if (virUUIDParse(uuidstr, uuid) < 0) {
2077
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2078
        goto error;
K
Karel Zak 已提交
2079
    }
2080

K
Karel Zak 已提交
2081
    return virDomainLookupByUUID(conn, &uuid[0]);
2082 2083

error:
2084
    virDispatchError(conn);
2085
    return NULL;
K
Karel Zak 已提交
2086 2087
}

2088 2089 2090 2091 2092
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
2093
 * Try to lookup a domain on the given hypervisor based on its name.
2094
 *
2095 2096
 * 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.
2097 2098
 */
virDomainPtr
2099 2100
virDomainLookupByName(virConnectPtr conn, const char *name)
{
2101 2102
    DEBUG("conn=%p, name=%s", conn, name);

2103 2104
    virResetLastError();

D
Daniel Veillard 已提交
2105
    if (!VIR_IS_CONNECT(conn)) {
2106
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2107
        virDispatchError(NULL);
2108
        return (NULL);
D
Daniel Veillard 已提交
2109 2110 2111
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2112
        goto error;
D
Daniel Veillard 已提交
2113
    }
2114

2115 2116 2117 2118 2119 2120 2121
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2122 2123

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2124 2125

error:
2126
    virDispatchError(conn);
2127
    return NULL;
2128 2129
}

D
Daniel Veillard 已提交
2130
/**
2131
 * virDomainDestroy:
D
Daniel Veillard 已提交
2132 2133 2134
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2135 2136 2137
 * 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 已提交
2138 2139
 *
 * Returns 0 in case of success and -1 in case of failure.
2140
 */
D
Daniel Veillard 已提交
2141
int
2142 2143
virDomainDestroy(virDomainPtr domain)
{
2144
    virConnectPtr conn;
2145

2146 2147
    DEBUG("domain=%p", domain);

2148 2149
    virResetLastError();

D
Daniel Veillard 已提交
2150
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2151
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2152
        virDispatchError(NULL);
2153
        return (-1);
D
Daniel Veillard 已提交
2154
    }
2155

2156
    conn = domain->conn;
2157 2158
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2159
        goto error;
2160
    }
2161

2162 2163 2164 2165 2166 2167 2168
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2169

2170
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2171 2172

error:
2173
    virDispatchError(conn);
2174
    return -1;
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
}

/**
 * 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
2187 2188
virDomainFree(virDomainPtr domain)
{
2189 2190
    DEBUG("domain=%p", domain);

2191 2192 2193
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2194
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2195
        virDispatchError(NULL);
2196
        return (-1);
D
Daniel Veillard 已提交
2197
    }
2198 2199
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2200
        return -1;
2201
    }
2202
    return(0);
D
Daniel Veillard 已提交
2203 2204
}

2205 2206
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2207
 * @domain: the domain to hold a reference on
2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
 *
 * 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 已提交
2219 2220
 *
 * Returns 0 in case of success and -1 in case of failure.
2221 2222 2223 2224 2225 2226
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
2227
        virDispatchError(NULL);
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237
        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 已提交
2238
/**
2239
 * virDomainSuspend:
D
Daniel Veillard 已提交
2240 2241 2242
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2243
 * to CPU resources and I/O but the memory used by the domain at the
2244
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2245
 * the domain.
2246
 * This function may requires privileged access.
D
Daniel Veillard 已提交
2247 2248 2249 2250
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2251 2252
virDomainSuspend(virDomainPtr domain)
{
2253
    virConnectPtr conn;
2254
    DEBUG("domain=%p", domain);
2255

2256 2257
    virResetLastError();

D
Daniel Veillard 已提交
2258
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2259
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2260
        virDispatchError(NULL);
2261
        return (-1);
D
Daniel Veillard 已提交
2262
    }
2263 2264
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2265
        goto error;
2266
    }
D
Daniel Veillard 已提交
2267

2268 2269
    conn = domain->conn;

2270 2271 2272 2273 2274 2275 2276
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2277

2278
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2279 2280

error:
2281
    virDispatchError(domain->conn);
2282
    return -1;
D
Daniel Veillard 已提交
2283 2284 2285
}

/**
2286
 * virDomainResume:
D
Daniel Veillard 已提交
2287 2288
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2289
 * Resume a suspended domain, the process is restarted from the state where
2290
 * it was frozen by calling virSuspendDomain().
2291
 * This function may requires privileged access
D
Daniel Veillard 已提交
2292 2293 2294 2295
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2296 2297
virDomainResume(virDomainPtr domain)
{
2298
    virConnectPtr conn;
2299
    DEBUG("domain=%p", domain);
2300

2301 2302
    virResetLastError();

D
Daniel Veillard 已提交
2303
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2304
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2305
        virDispatchError(NULL);
2306
        return (-1);
D
Daniel Veillard 已提交
2307
    }
2308 2309
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2310
        goto error;
2311
    }
D
Daniel Veillard 已提交
2312

2313 2314
    conn = domain->conn;

2315 2316 2317 2318 2319 2320 2321
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2322

2323
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2324 2325

error:
2326
    virDispatchError(domain->conn);
2327
    return -1;
D
Daniel Veillard 已提交
2328 2329
}

2330 2331 2332 2333 2334 2335
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2336 2337 2338
 * 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.
2339 2340 2341 2342
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2343 2344
virDomainSave(virDomainPtr domain, const char *to)
{
2345
    char filepath[4096];
2346
    virConnectPtr conn;
2347
    DEBUG("domain=%p, to=%s", domain, to);
2348

2349 2350
    virResetLastError();

D
Daniel Veillard 已提交
2351
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2352
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2353
        virDispatchError(NULL);
2354
        return (-1);
D
Daniel Veillard 已提交
2355
    }
2356 2357
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2358
        goto error;
2359
    }
2360
    conn = domain->conn;
D
Daniel Veillard 已提交
2361 2362
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2363
        goto error;
D
Daniel Veillard 已提交
2364
    }
2365

2366 2367 2368 2369 2370
    /*
     * 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] != '/') {
2371
        unsigned int len, t;
2372

2373 2374 2375 2376 2377 2378 2379 2380 2381 2382
        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];
2383 2384 2385

    }

2386 2387 2388 2389 2390 2391 2392
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2393

2394
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2395 2396

error:
2397
    virDispatchError(domain->conn);
2398
    return -1;
2399 2400 2401 2402
}

/**
 * virDomainRestore:
2403
 * @conn: pointer to the hypervisor connection
2404
 * @from: path to the
2405 2406 2407 2408 2409 2410
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2411 2412
virDomainRestore(virConnectPtr conn, const char *from)
{
2413
    char filepath[4096];
2414
    DEBUG("conn=%p, from=%s", conn, from);
2415

2416 2417
    virResetLastError();

D
Daniel Veillard 已提交
2418
    if (!VIR_IS_CONNECT(conn)) {
2419
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2420
        virDispatchError(NULL);
2421
        return (-1);
D
Daniel Veillard 已提交
2422
    }
2423 2424
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2425
        goto error;
2426
    }
D
Daniel Veillard 已提交
2427 2428
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2429
        goto error;
D
Daniel Veillard 已提交
2430 2431
    }

2432 2433 2434 2435 2436
    /*
     * 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] != '/') {
2437 2438 2439
        unsigned int len, t;

        t = strlen(from);
2440 2441 2442 2443 2444
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2445 2446
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2447 2448 2449 2450 2451
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2452 2453 2454 2455 2456
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2457 2458 2459 2460 2461 2462 2463
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2464

2465
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2466 2467

error:
2468
    virDispatchError(conn);
2469
    return -1;
D
Daniel Veillard 已提交
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488
}

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

2491 2492
    virResetLastError();

D
Daniel Veillard 已提交
2493
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2494
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2495
        virDispatchError(NULL);
D
Daniel Veillard 已提交
2496 2497 2498 2499
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2500
        goto error;
D
Daniel Veillard 已提交
2501 2502 2503 2504
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2505
        goto error;
D
Daniel Veillard 已提交
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515
    }

    /*
     * 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);
2516 2517 2518 2519 2520
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibDomainError(domain, VIR_ERR_SYSTEM_ERROR,
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2521 2522
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2523 2524 2525 2526 2527
        if (len > sizeof(filepath) - (t + 3)) {
            virLibDomainError(domain, VIR_ERR_INTERNAL_ERROR,
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2528 2529 2530 2531 2532 2533
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

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

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

error:
2545
    virDispatchError(domain->conn);
2546
    return -1;
2547 2548
}

2549 2550 2551 2552 2553
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2554 2555
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2556 2557 2558 2559 2560 2561 2562
 *
 * 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
2563 2564
virDomainShutdown(virDomainPtr domain)
{
2565
    virConnectPtr conn;
2566
    DEBUG("domain=%p", domain);
2567

2568 2569
    virResetLastError();

D
Daniel Veillard 已提交
2570
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2571
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2572
        virDispatchError(NULL);
2573
        return (-1);
D
Daniel Veillard 已提交
2574
    }
2575 2576
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2577
        goto error;
2578
    }
2579

2580 2581
    conn = domain->conn;

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

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

error:
2593
    virDispatchError(domain->conn);
2594
    return -1;
2595 2596
}

2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610
/**
 * 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)
{
2611
    virConnectPtr conn;
2612
    DEBUG("domain=%p, flags=%u", domain, flags);
2613

2614 2615
    virResetLastError();

2616
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2617
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2618
        virDispatchError(NULL);
2619 2620
        return (-1);
    }
2621 2622
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2623
        goto error;
2624
    }
2625

2626 2627
    conn = domain->conn;

2628 2629 2630 2631 2632 2633 2634
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2635

2636
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2637 2638

error:
2639
    virDispatchError(domain->conn);
2640
    return -1;
2641 2642
}

2643
/**
2644
 * virDomainGetName:
2645 2646 2647 2648 2649 2650 2651 2652
 * @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 *
2653 2654
virDomainGetName(virDomainPtr domain)
{
2655 2656
    DEBUG("domain=%p", domain);

2657 2658
    virResetLastError();

D
Daniel Veillard 已提交
2659
    if (!VIR_IS_DOMAIN(domain)) {
2660
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2661
        virDispatchError(NULL);
2662
        return (NULL);
D
Daniel Veillard 已提交
2663
    }
2664
    return (domain->name);
2665 2666
}

2667 2668 2669
/**
 * virDomainGetUUID:
 * @domain: a domain object
2670
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2671 2672 2673 2674 2675 2676
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2677 2678
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2679 2680
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2681 2682
    virResetLastError();

D
Daniel Veillard 已提交
2683
    if (!VIR_IS_DOMAIN(domain)) {
2684
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2685
        virDispatchError(NULL);
2686
        return (-1);
D
Daniel Veillard 已提交
2687 2688 2689
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2690
        virDispatchError(domain->conn);
2691
        return (-1);
D
Daniel Veillard 已提交
2692 2693
    }

2694 2695
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2696
    return (0);
2697 2698
}

K
Karel Zak 已提交
2699 2700 2701
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2702
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2703
 *
2704
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2705 2706 2707 2708 2709 2710 2711
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2712
    unsigned char uuid[VIR_UUID_BUFLEN];
2713
    DEBUG("domain=%p, buf=%p", domain, buf);
2714

2715 2716
    virResetLastError();

K
Karel Zak 已提交
2717
    if (!VIR_IS_DOMAIN(domain)) {
2718
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2719
        virDispatchError(NULL);
K
Karel Zak 已提交
2720 2721 2722 2723
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2724
        goto error;
K
Karel Zak 已提交
2725
    }
2726

K
Karel Zak 已提交
2727
    if (virDomainGetUUID(domain, &uuid[0]))
2728
        goto error;
K
Karel Zak 已提交
2729

2730
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2731
    return (0);
2732 2733

error:
2734
    virDispatchError(domain->conn);
2735
    return -1;
K
Karel Zak 已提交
2736 2737
}

2738
/**
2739
 * virDomainGetID:
2740 2741 2742 2743 2744 2745 2746
 * @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
2747 2748
virDomainGetID(virDomainPtr domain)
{
2749 2750
    DEBUG("domain=%p", domain);

2751 2752
    virResetLastError();

D
Daniel Veillard 已提交
2753
    if (!VIR_IS_DOMAIN(domain)) {
2754
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2755
        virDispatchError(NULL);
2756
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2757
    }
2758
    return (domain->id);
2759 2760
}

2761 2762 2763 2764 2765 2766
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2767 2768
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2769 2770
 */
char *
2771 2772
virDomainGetOSType(virDomainPtr domain)
{
2773
    virConnectPtr conn;
2774
    DEBUG("domain=%p", domain);
2775

2776 2777 2778
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2779
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2780
        virDispatchError(NULL);
2781
        return (NULL);
D
Daniel Veillard 已提交
2782
    }
2783

2784 2785
    conn = domain->conn;

2786 2787 2788 2789 2790 2791 2792
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2793

2794
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2795 2796

error:
2797
    virDispatchError(domain->conn);
2798
    return NULL;
2799 2800
}

2801
/**
2802
 * virDomainGetMaxMemory:
2803
 * @domain: a domain object or NULL
2804
 *
2805 2806 2807 2808 2809 2810 2811
 * 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
2812 2813
virDomainGetMaxMemory(virDomainPtr domain)
{
2814
    virConnectPtr conn;
2815
    DEBUG("domain=%p", domain);
2816

2817 2818
    virResetLastError();

D
Daniel Veillard 已提交
2819
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2820
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2821
        virDispatchError(NULL);
2822
        return (0);
D
Daniel Veillard 已提交
2823
    }
2824

2825 2826
    conn = domain->conn;

2827 2828 2829 2830 2831 2832 2833
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2834

2835
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2836 2837

error:
2838
    virDispatchError(domain->conn);
2839
    return 0;
2840 2841
}

D
Daniel Veillard 已提交
2842
/**
2843
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2844 2845
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2846
 *
D
Daniel Veillard 已提交
2847 2848 2849
 * 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.
2850
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2851
 *
2852 2853 2854
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
D
Daniel Veillard 已提交
2855 2856 2857
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2858 2859
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2860
    virConnectPtr conn;
2861
    DEBUG("domain=%p, memory=%lu", domain, memory);
2862

2863 2864
    virResetLastError();

2865
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2866
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2867
        virDispatchError(NULL);
2868
        return (-1);
2869
    }
2870 2871
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2872
        goto error;
2873 2874 2875
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2876
        goto error;
2877
    }
2878
    conn = domain->conn;
2879

2880 2881 2882 2883 2884 2885 2886
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2887

2888
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2889 2890

error:
2891
    virDispatchError(domain->conn);
2892
    return -1;
2893
}
2894

2895 2896 2897 2898
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2899
 *
2900 2901 2902
 * 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.
2903
 * This function may requires privileged access to the hypervisor.
2904
 *
2905 2906 2907
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
2908 2909 2910 2911 2912 2913
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2914
    DEBUG("domain=%p, memory=%lu", domain, memory);
2915

2916 2917
    virResetLastError();

2918
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2919
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2920
        virDispatchError(NULL);
2921
        return (-1);
2922
    }
2923 2924
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2925
        goto error;
2926 2927 2928
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2929
        goto error;
2930 2931 2932
    }

    conn = domain->conn;
2933

2934 2935 2936 2937 2938 2939 2940
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2941

2942
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2943 2944

error:
2945
    virDispatchError(domain->conn);
2946
    return -1;
D
Daniel Veillard 已提交
2947 2948
}

2949 2950
/**
 * virDomainGetInfo:
2951
 * @domain: a domain object
2952
 * @info: pointer to a virDomainInfo structure allocated by the user
2953
 *
2954
 * Extract information about a domain. Note that if the connection
2955
 * used to get the domain is limited only a partial set of the information
2956 2957 2958 2959 2960
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2961 2962
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2963
    virConnectPtr conn;
2964
    DEBUG("domain=%p, info=%p", domain, info);
2965

2966 2967
    virResetLastError();

D
Daniel Veillard 已提交
2968
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2969
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2970
        virDispatchError(NULL);
2971
        return (-1);
D
Daniel Veillard 已提交
2972 2973 2974
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2975
        goto error;
D
Daniel Veillard 已提交
2976
    }
2977

2978
    memset(info, 0, sizeof(virDomainInfo));
2979

2980 2981
    conn = domain->conn;

2982 2983 2984 2985 2986 2987 2988
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2989

2990
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2991 2992

error:
2993
    virDispatchError(domain->conn);
2994
    return -1;
2995
}
2996

2997 2998 2999
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3000
 * @flags: an OR'ed set of virDomainXMLFlags
3001 3002
 *
 * Provide an XML description of the domain. The description may be reused
3003
 * later to relaunch the domain with virDomainCreateXML().
3004 3005 3006 3007 3008
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3009 3010
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
3011
    virConnectPtr conn;
3012
    DEBUG("domain=%p, flags=%d", domain, flags);
3013

3014 3015 3016
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3017
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3018
        virDispatchError(NULL);
3019
        return (NULL);
D
Daniel Veillard 已提交
3020
    }
3021

3022 3023
    conn = domain->conn;

3024 3025 3026 3027 3028 3029
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3030 3031
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

3032 3033 3034 3035 3036 3037 3038
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
3039

3040
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3041 3042

error:
3043
    virDispatchError(domain->conn);
3044
    return NULL;
3045
}
3046

3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071
/**
 * 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__);
3072
        virDispatchError(NULL);
3073 3074 3075 3076 3077
        return (NULL);
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3078
        goto error;
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094
    }

    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:
3095
    virDispatchError(conn);
3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
    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__);
3124
        virDispatchError(NULL);
3125 3126 3127 3128 3129
        return (NULL);
    }

    if (nativeFormat == NULL || domainXml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3130
        goto error;
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146
    }

    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:
3147
    virDispatchError(conn);
3148 3149 3150 3151
    return NULL;
}


3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162
static virDomainPtr
virDomainMigrateVersion1 (virDomainPtr domain,
                          virConnectPtr dconn,
                          unsigned long flags,
                          const char *dname,
                          const char *uri,
                          unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
3163 3164 3165 3166 3167 3168 3169
    int cookielen = 0, ret;
    virDomainInfo info;

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233

    /* 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.
     */
    if (dconn->driver->domainMigratePrepare
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname,
         bandwidth) == -1)
        goto done;

    if (uri == NULL && uri_out == NULL) {
        virLibConnError (domain->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);

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    if (domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth) == -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);

 done:
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

static virDomainPtr
virDomainMigrateVersion2 (virDomainPtr domain,
                          virConnectPtr dconn,
                          unsigned long flags,
                          const char *dname,
                          const char *uri,
                          unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
    char *dom_xml = NULL;
    int cookielen = 0, ret;
3234
    virDomainInfo info;
3235
    virErrorPtr orig_err = NULL;
3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254

    /* 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.
     */

    /* 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 (!domain->conn->driver->domainDumpXML) {
        virLibConnError (domain->conn, VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
3255
        virDispatchError(domain->conn);
3256 3257 3258 3259 3260 3261 3262
        return NULL;
    }
    dom_xml = domain->conn->driver->domainDumpXML (domain,
                                                   VIR_DOMAIN_XML_SECURE);
    if (!dom_xml)
        return NULL;

3263 3264 3265 3266 3267
    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }

3268 3269 3270 3271 3272 3273 3274 3275 3276 3277
    ret = dconn->driver->domainMigratePrepare2
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname,
         bandwidth, dom_xml);
    VIR_FREE (dom_xml);
    if (ret == -1)
        goto done;

    if (uri == NULL && uri_out == NULL) {
        virLibConnError (domain->conn, VIR_ERR_INTERNAL_ERROR,
                         _("domainMigratePrepare2 did not set uri"));
3278
        virDispatchError(domain->conn);
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare2 change URI? */
    assert (uri != NULL);

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    ret = domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth);

3291 3292 3293 3294
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

3295 3296 3297 3298 3299 3300 3301 3302 3303
    /* 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);

 done:
3304 3305 3306 3307
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
3308 3309 3310 3311 3312
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330

 /*
  * This is sort of a migration v3
  *
  * In this version, the client does not talk to the destination
  * libvirtd. The source libvirtd will still try to talk to the
  * destination libvirtd though, and will do the prepare/perform/finish
  * steps.
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
                           unsigned long flags,
                           const char *dname,
                           const char *uri,
                           unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
        virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3331
        virDispatchError(domain->conn);
3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347
        return -1;
    }

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
}


C
Chris Lalancette 已提交
3348
/*
3349
 * This is a variation on v1 & 2  migration
C
Chris Lalancette 已提交
3350
 *
3351 3352 3353 3354 3355 3356
 * This is for hypervisors which can directly handshake
 * without any libvirtd involvement on destination either
 * from client, or source libvirt.
 *
 * eg, XenD can talk direct to XenD, so libvirtd on dest
 * does not need to be involved at all, or even running
C
Chris Lalancette 已提交
3357
 */
3358 3359 3360 3361 3362 3363 3364 3365 3366
static int
virDomainMigrateDirect (virDomainPtr domain,
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
        virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3367
        virDispatchError(domain->conn);
3368 3369 3370
        return -1;
    }

C
Chris Lalancette 已提交
3371 3372 3373
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
3374 3375 3376 3377 3378 3379 3380
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
C
Chris Lalancette 已提交
3381 3382
}

3383

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396
/**
 * 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:
3397 3398 3399
 *   VIR_MIGRATE_LIVE      Do not pause the VM during migration
 *   VIR_MIGRATE_PEER2PEER Direct connection between source & destination hosts
 *   VIR_MIGRATE_TUNNELLED Tunnel migration data over the libvirt RPC channel
C
Chris Lalancette 已提交
3400 3401 3402 3403
 *   VIR_MIGRATE_PERSIST_DEST If the migration is successful, persist the domain
 *                            on the destination host.
 *   VIR_MIGRATE_UNDEFINE_SOURCE If the migration is successful, undefine the
 *                               domain on the source host.
3404
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
3405 3406 3407 3408 3409
 *
 * VIR_MIGRATE_TUNNELLED requires that VIR_MIGRATE_PEER2PEER be set.
 * Applications using the VIR_MIGRATE_PEER2PEER flag will probably
 * prefer to invoke virDomainMigrateToURI, avoiding the need to
 * open connection to the destination host themselves.
3410 3411 3412 3413 3414 3415
 *
 * 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.
 *
3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
 * If the VIR_MIGRATE_PEER2PEER flag is set, the uri parameter
 * must be a valid libvirt connection URI, by which the source
 * libvirt driver can connect to the destination libvirt. If
 * omitted, the dconn connection object will be queried for its
 * current URI.
 *
 * If the VIR_MIGRATE_PEER2PEER flag is NOT set, the URI parameter
 * takes a hypervisor specific format. The hypervisor capabilities
 * XML includes details of the support URI schemes. If omitted
 * the dconn will be asked for a default URI.
 *
3427
 * In either case it is typically only necessary to specify a
3428 3429
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
 *
 * 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)
{
    virDomainPtr ddomain = NULL;
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
3459
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
3460

3461 3462
    virResetLastError();

3463
    /* First checkout the source */
3464
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3465
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3466
        virDispatchError(NULL);
3467 3468
        return NULL;
    }
3469 3470
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3471
        goto error;
3472 3473
    }

3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
        virLibConnError(domain->conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

3485 3486 3487 3488 3489 3490
    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            char *dstURI = NULL;
            if (uri == NULL) {
                dstURI = virConnectGetURI(dconn);
3491
                if (!dstURI)
3492 3493
                    return NULL;
            }
3494

3495 3496 3497 3498 3499
            if (virDomainMigratePeer2Peer(domain, flags, dname, uri ? uri : dstURI, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
3500

3501 3502 3503 3504 3505 3506
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
3507
    } else {
3508 3509 3510 3511 3512 3513
        if (flags & VIR_MIGRATE_TUNNELLED) {
            virLibConnError(domain->conn, VIR_ERR_OPERATION_INVALID,
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                     VIR_DRV_FEATURE_MIGRATION_V1) &&
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                     VIR_DRV_FEATURE_MIGRATION_V1))
            ddomain = virDomainMigrateVersion1(domain, dconn, flags, dname, uri, bandwidth);
        else if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                          VIR_DRV_FEATURE_MIGRATION_V2) &&
                 VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                          VIR_DRV_FEATURE_MIGRATION_V2))
            ddomain = virDomainMigrateVersion2(domain, dconn, flags, dname, uri, bandwidth);
        else {
3526
            /* This driver does not support any migration method */
C
Chris Lalancette 已提交
3527 3528 3529
            virLibConnError(domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
3530 3531
    }

3532 3533
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
3534

3535
    return ddomain;
3536 3537

error:
3538
    virDispatchError(domain->conn);
3539
    return NULL;
3540 3541
}

3542 3543 3544 3545 3546 3547 3548 3549 3550 3551

/**
 * virDomainMigrateToURI:
 * @domain: a domain object
 * @duri: mandatory URI for the destination host
 * @flags: flags
 * @dname: (optional) rename domain to this at destination
 * @bandwidth: (optional) specify migration bandwidth limit in Mbps
 *
 * Migrate the domain object from its current host to the destination
D
Dan Kenigsberg 已提交
3552
 * host given by duri.
3553 3554 3555 3556 3557
 *
 * Flags may be one of more of the following:
 *   VIR_MIGRATE_LIVE      Do not pause the VM during migration
 *   VIR_MIGRATE_PEER2PEER Direct connection between source & destination hosts
 *   VIR_MIGRATE_TUNNELLED Tunnel migration data over the libvirt RPC channel
3558 3559 3560 3561
 *   VIR_MIGRATE_PERSIST_DEST If the migration is successful, persist the domain
 *                            on the destination host.
 *   VIR_MIGRATE_UNDEFINE_SOURCE If the migration is successful, undefine the
 *                               domain on the source host.
3562
 *
3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
 * The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.
 * If the VIR_MIGRATE_PEER2PEER flag is NOT set, the duri parameter
 * takes a hypervisor specific format. The uri_transports element of the
 * hypervisor capabilities XML includes details of the supported URI
 * schemes. Not all hypervisors will support this mode of migration, so
 * if the VIR_MIGRATE_PEER2PEER flag is not set, then it may be necessary
 * to use the alternative virDomainMigrate API providing and explicit
 * virConnectPtr for the destination host.
 *
 * If the VIR_MIGRATE_PEER2PEER flag IS set, the duri parameter
3573
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
3574
 * libvirt driver can connect to the destination libvirt.
3575
 *
3576 3577 3578 3579 3580 3581 3582
 * VIR_MIGRATE_TUNNELLED requires that VIR_MIGRATE_PEER2PEER be set.
 *
 * If a hypervisor supports renaming domains during migration,
 * the dname parameter specifies the new name for the domain.
 * Setting dname to NULL keeps the domain name the same.  If domain
 * renaming is not supported by the hypervisor, dname must be NULL or
 * else an error will be returned.
3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614
 *
 * 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 0 if the migration succeeded, -1 upon error.
 */
int
virDomainMigrateToURI (virDomainPtr domain,
                       const char *duri,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    DEBUG("domain=%p, duri=%p, flags=%lu, dname=%s, bandwidth=%lu",
          domain, NULLSTR(duri), flags, NULLSTR(dname), bandwidth);

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3615
        virDispatchError(NULL);
3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (duri == NULL) {
        virLibConnError (domain->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            if (virDomainMigratePeer2Peer (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* No peer to peer migration supported */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
            if (virDomainMigrateDirect (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    }

    return 0;

error:
3653
    virDispatchError(domain->conn);
3654 3655 3656 3657
    return -1;
}


D
Daniel Veillard 已提交
3658 3659
/*
 * Not for public use.  This function is part of the internal
3660 3661 3662
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3663
virDomainMigratePrepare (virConnectPtr dconn,
3664 3665 3666 3667 3668 3669 3670
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
3671
{
J
John Levon 已提交
3672 3673 3674
    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);
3675

3676 3677
    virResetLastError();

3678
    if (!VIR_IS_CONNECT (dconn)) {
3679
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3680
        virDispatchError(NULL);
3681 3682 3683
        return -1;
    }

3684 3685
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3686
        goto error;
3687 3688
    }

3689 3690 3691 3692 3693 3694 3695 3696 3697
    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;
    }
3698 3699

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3700 3701

error:
3702
    virDispatchError(dconn);
3703 3704 3705
    return -1;
}

D
Daniel Veillard 已提交
3706 3707
/*
 * Not for public use.  This function is part of the internal
3708 3709 3710
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3711
virDomainMigratePerform (virDomainPtr domain,
3712 3713 3714 3715 3716 3717 3718 3719
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
J
John Levon 已提交
3720 3721 3722
    VIR_DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
              "dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags,
              NULLSTR(dname), bandwidth);
3723

3724 3725 3726
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3727
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3728
        virDispatchError(NULL);
3729 3730 3731 3732
        return -1;
    }
    conn = domain->conn;

3733 3734
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3735
        goto error;
3736 3737
    }

3738 3739 3740 3741 3742 3743 3744 3745 3746
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3747 3748

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3749 3750

error:
3751
    virDispatchError(domain->conn);
3752 3753 3754
    return -1;
}

D
Daniel Veillard 已提交
3755 3756
/*
 * Not for public use.  This function is part of the internal
3757 3758 3759
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3760
virDomainMigrateFinish (virConnectPtr dconn,
3761 3762 3763 3764 3765 3766
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3767 3768 3769
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3770

3771 3772
    virResetLastError();

3773
    if (!VIR_IS_CONNECT (dconn)) {
3774
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3775
        virDispatchError(NULL);
3776 3777 3778
        return NULL;
    }

3779 3780
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3781
        goto error;
3782 3783
    }

3784 3785 3786 3787 3788 3789 3790 3791 3792
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3793 3794

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3795 3796

error:
3797
    virDispatchError(dconn);
3798
    return NULL;
D
Daniel Veillard 已提交
3799 3800 3801
}


D
Daniel Veillard 已提交
3802 3803
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3804 3805 3806
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3807 3808 3809 3810 3811 3812 3813 3814 3815
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 已提交
3816
{
J
John Levon 已提交
3817 3818 3819 3820
    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 已提交
3821

3822 3823
    virResetLastError();

D
Daniel Veillard 已提交
3824 3825
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3826
        virDispatchError(NULL);
D
Daniel Veillard 已提交
3827 3828 3829
        return -1;
    }

3830 3831
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3832
        goto error;
3833 3834
    }

3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
    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 已提交
3845 3846

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3847 3848

error:
3849
    virDispatchError(dconn);
D
Daniel Veillard 已提交
3850 3851 3852
    return -1;
}

D
Daniel Veillard 已提交
3853 3854
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3855 3856 3857
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3858 3859 3860 3861 3862 3863 3864
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3865
{
J
John Levon 已提交
3866 3867 3868
    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 已提交
3869

3870 3871
    virResetLastError();

D
Daniel Veillard 已提交
3872 3873
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3874
        virDispatchError(NULL);
D
Daniel Veillard 已提交
3875 3876 3877
        return NULL;
    }

3878 3879
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3880
        goto error;
3881 3882
    }

3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
    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 已提交
3893 3894

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3895 3896

error:
3897
    virDispatchError(dconn);
D
Daniel Veillard 已提交
3898
    return NULL;
3899 3900 3901
}


C
Chris Lalancette 已提交
3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigratePrepareTunnel(virConnectPtr conn,
                              virStreamPtr st,
                              unsigned long flags,
                              const char *dname,
                              unsigned long bandwidth,
                              const char *dom_xml)

{
3915 3916
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
3917 3918 3919 3920 3921 3922
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3923
        virDispatchError(NULL);
C
Chris Lalancette 已提交
3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
        return -1;
    }

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

    if (conn != st->conn) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
3938
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
3939 3940 3941 3942 3943 3944 3945 3946 3947 3948
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
3949
    virDispatchError(conn);
C
Chris Lalancette 已提交
3950 3951 3952 3953
    return -1;
}


3954 3955 3956 3957
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3958
 *
3959 3960 3961 3962 3963
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3964 3965
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3966 3967
    DEBUG("conn=%p, info=%p", conn, info);

3968 3969
    virResetLastError();

3970
    if (!VIR_IS_CONNECT(conn)) {
3971
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3972
        virDispatchError(NULL);
3973 3974 3975 3976
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3977
        goto error;
3978 3979
    }

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

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

error:
3991
    virDispatchError(conn);
3992
    return -1;
3993
}
3994

3995 3996 3997 3998 3999 4000
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
4001 4002
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
4003 4004 4005 4006 4007
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
4008 4009
    DEBUG("conn=%p", conn);

4010 4011
    virResetLastError();

4012
    if (!VIR_IS_CONNECT (conn)) {
4013
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4014
        virDispatchError(NULL);
4015 4016 4017
        return NULL;
    }

4018 4019 4020 4021 4022 4023 4024
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
4025

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

error:
4029
    virDispatchError(conn);
4030 4031 4032
    return NULL;
}

4033 4034 4035
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
4036
 *
D
Daniel Veillard 已提交
4037
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
4038 4039
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
4040
 *
D
Daniel Veillard 已提交
4041
 * Returns the available free memory in bytes or 0 in case of error
4042 4043 4044 4045
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
4046 4047
    DEBUG("conn=%p", conn);

4048 4049
    virResetLastError();

4050 4051
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4052
        virDispatchError(NULL);
4053 4054 4055
        return 0;
    }

4056 4057 4058 4059 4060 4061 4062
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
4063 4064

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4065 4066

error:
4067
    virDispatchError(conn);
4068 4069 4070
    return 0;
}

4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084
/**
 * 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;
4085
    DEBUG("domain=%p, nparams=%p", domain, nparams);
4086

4087 4088
    virResetLastError();

4089
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4090
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4091
        virDispatchError(NULL);
4092 4093 4094 4095 4096 4097
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
4098 4099
        if (!schedtype)
            goto error;
4100 4101 4102
        return schedtype;
    }

4103
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4104 4105

error:
4106
    virDispatchError(domain->conn);
4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126
    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,
4127
                                virSchedParameterPtr params, int *nparams)
4128 4129
{
    virConnectPtr conn;
4130
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
4131

4132 4133
    virResetLastError();

4134
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4135
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4136
        virDispatchError(NULL);
4137 4138 4139 4140
        return -1;
    }
    conn = domain->conn;

4141 4142 4143 4144 4145 4146 4147
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4148

4149
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4150 4151

error:
4152
    virDispatchError(domain->conn);
4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168
    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
4169
virDomainSetSchedulerParameters(virDomainPtr domain,
4170
                                virSchedParameterPtr params, int nparams)
4171 4172
{
    virConnectPtr conn;
4173
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
4174

4175 4176
    virResetLastError();

4177
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4178
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4179
        virDispatchError(NULL);
4180 4181
        return -1;
    }
4182 4183
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4184
        goto error;
4185
    }
4186 4187
    conn = domain->conn;

4188 4189 4190 4191 4192 4193 4194
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4195

4196
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4197 4198

error:
4199
    virDispatchError(domain->conn);
4200 4201 4202 4203
    return -1;
}


4204
/**
4205
 * virDomainBlockStats:
4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
 * @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);

4235 4236
    virResetLastError();

4237
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4238
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4239
        virDispatchError(NULL);
4240 4241
        return -1;
    }
4242
    if (!path || !stats || size > sizeof stats2) {
4243 4244 4245
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
4246 4247 4248 4249
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
4250
            goto error;
4251 4252 4253 4254 4255 4256

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4257 4258

error:
4259
    virDispatchError(dom->conn);
4260 4261 4262 4263
    return -1;
}

/**
4264
 * virDomainInterfaceStats:
4265 4266 4267 4268 4269 4270 4271 4272 4273 4274
 * @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.
 *
D
Dan Kenigsberg 已提交
4275
 * Domains may have more than one network interface.  To get stats for
4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292
 * 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);

4293 4294
    virResetLastError();

4295
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4296
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4297
        virDispatchError(NULL);
4298 4299
        return -1;
    }
4300
    if (!path || !stats || size > sizeof stats2) {
4301 4302 4303
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
4304 4305 4306 4307
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
4308
            goto error;
4309 4310 4311 4312 4313 4314

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4315 4316

error:
4317
    virDispatchError(dom->conn);
4318 4319 4320
    return -1;
}

4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367
/**
 * virDomainMemoryStats:
 * @dom: pointer to the domain object
 * @stats: nr_stats-sized array of stat structures (returned)
 * @nr_stats: number of memory statistics requested
 * @flags: unused, always pass 0
 *
 * This function provides memory statistics for the domain.
 *
 * Up to 'nr_stats' elements of 'stats' will be populated with memory statistics
 * from the domain.  Only statistics supported by the domain, the driver, and
 * this version of libvirt will be returned.
 *
 * Memory Statistics:
 *
 * VIR_DOMAIN_MEMORY_STAT_SWAP_IN:
 *     The total amount of data read from swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_SWAP_OUT:
 *     The total amount of memory written out to swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT:
 *     The number of page faults that required disk IO to service.
 * VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT:
 *     The number of page faults serviced without disk IO.
 * VIR_DOMAIN_MEMORY_STAT_UNUSED:
 *     The amount of memory which is not being used for any purpose (in kb).
 * VIR_DOMAIN_MEMORY_STAT_AVAILABLE:
 *     The total amount of memory available to the domain's OS (in kb).
 *
 * Returns: The number of stats provided or -1 in case of failure.
 */
int virDomainMemoryStats (virDomainPtr dom, virDomainMemoryStatPtr stats,
                          unsigned int nr_stats, unsigned int flags)
{
    virConnectPtr conn;
    unsigned long nr_stats_ret = 0;
    DEBUG("domain=%p, stats=%p, nr_stats=%u", dom, stats, nr_stats);

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        goto error;
    }

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4368
        virDispatchError(NULL);
4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387
        return -1;
    }
    if (!stats || nr_stats == 0)
        return 0;

    if (nr_stats > VIR_DOMAIN_MEMORY_STAT_NR)
        nr_stats = VIR_DOMAIN_MEMORY_STAT_NR;

    conn = dom->conn;
    if (conn->driver->domainMemoryStats) {
        nr_stats_ret = conn->driver->domainMemoryStats (dom, stats, nr_stats);
        if (nr_stats_ret == -1)
            goto error;
        return nr_stats_ret;
    }

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
4388
    virDispatchError(dom->conn);
4389 4390 4391
    return -1;
}

R
Richard W.M. Jones 已提交
4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424
/**
 * 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 已提交
4425 4426 4427 4428
 * 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 已提交
4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442
 * 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);

4443 4444
    virResetLastError();

R
Richard W.M. Jones 已提交
4445 4446
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4447
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4448 4449 4450
        return -1;
    }
    conn = dom->conn;
4451

4452 4453
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4454
        goto error;
4455 4456
    }

R
Richard W.M. Jones 已提交
4457 4458 4459
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
4460
        goto error;
R
Richard W.M. Jones 已提交
4461 4462 4463 4464 4465
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
4466
        goto error;
R
Richard W.M. Jones 已提交
4467 4468 4469 4470 4471 4472
    }

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

4476 4477 4478 4479 4480 4481 4482 4483
    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 已提交
4484 4485

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4486 4487

error:
4488
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4489 4490
    return -1;
}
4491

R
Richard W.M. Jones 已提交
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533
/**
 * 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);

4534 4535
    virResetLastError();

R
Richard W.M. Jones 已提交
4536 4537
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4538
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4539 4540 4541 4542
        return -1;
    }
    conn = dom->conn;

4543 4544
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4545
        goto error;
4546 4547
    }

4548
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
4549 4550 4551 4552 4553 4554
     * 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.
     *
4555
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
4556 4557 4558
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
4559 4560 4561
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
4562 4563 4564 4565 4566 4567 4568 4569
     * 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.
     */
4570 4571

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
R
Richard W.M. Jones 已提交
4572
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
4573
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
4574
        goto error;
R
Richard W.M. Jones 已提交
4575 4576 4577 4578 4579 4580
    }

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

4584 4585 4586 4587 4588 4589 4590 4591
    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 已提交
4592 4593

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4594 4595

error:
4596
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4597 4598 4599
    return -1;
}

4600

4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611
/************************************************************************
 *									*
 *		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
 *
4612 4613
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
4614 4615
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
4616 4617 4618 4619 4620
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
4621 4622
    DEBUG("conn=%p, xml=%s", conn, xml);

4623 4624
    virResetLastError();

4625
    if (!VIR_IS_CONNECT(conn)) {
4626
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4627
        virDispatchError(NULL);
4628 4629
        return (NULL);
    }
4630 4631
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4632
        goto error;
4633
    }
4634 4635
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4636
        goto error;
4637 4638
    }

4639 4640 4641 4642 4643 4644 4645
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4646

4647
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4648 4649

error:
4650
    virDispatchError(conn);
4651
    return NULL;
4652 4653 4654 4655 4656 4657
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
4658
 * Undefine a domain but does not stop it if it is running
4659 4660 4661 4662 4663
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
4664
    virConnectPtr conn;
4665
    DEBUG("domain=%p", domain);
4666

4667 4668
    virResetLastError();

4669
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4670
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4671
        virDispatchError(NULL);
4672 4673
        return (-1);
    }
4674 4675
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4676
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4677
        goto error;
4678 4679
    }

4680 4681 4682 4683 4684 4685 4686
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4687

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

error:
4691
    virDispatchError(domain->conn);
4692
    return -1;
4693 4694 4695 4696 4697 4698
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
4699
 * Provides the number of defined but inactive domains.
4700 4701 4702 4703 4704 4705
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(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
        virDispatchError(NULL);
4713 4714 4715
        return (-1);
    }

4716 4717 4718 4719 4720 4721 4722
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4723

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

error:
4727
    virDispatchError(conn);
4728
    return -1;
4729 4730 4731 4732 4733 4734 4735 4736
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4737 4738
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4739
 *
4740 4741 4742
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4743
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
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
        virDispatchError(NULL);
4752 4753 4754
        return (-1);
    }

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

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

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

error:
4771
    virDispatchError(conn);
4772
    return -1;
4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785
}

/**
 * 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) {
4786
    virConnectPtr conn;
4787
    DEBUG("domain=%p", domain);
4788

4789 4790
    virResetLastError();

4791
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4792
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4793
        virDispatchError(NULL);
4794 4795
        return (-1);
    }
4796 4797
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4798
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4799
        goto error;
4800
    }
4801

4802 4803 4804 4805 4806 4807 4808
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4809

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

error:
4813
    virDispatchError(domain->conn);
4814
    return -1;
4815 4816
}

4817 4818 4819
/**
 * virDomainGetAutostart:
 * @domain: a domain object
4820
 * @autostart: the value returned
4821
 *
4822
 * Provides a boolean value indicating whether the domain
4823 4824 4825 4826 4827 4828 4829
 * 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,
4830 4831 4832
                      int *autostart)
{
    virConnectPtr conn;
4833
    DEBUG("domain=%p, autostart=%p", domain, autostart);
4834

4835 4836 4837
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4838
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4839
        virDispatchError(NULL);
4840 4841 4842 4843
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4844
        goto error;
4845 4846
    }

4847 4848
    conn = domain->conn;

4849 4850 4851 4852 4853 4854 4855
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4856

4857
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4858 4859

error:
4860
    virDispatchError(domain->conn);
4861
    return -1;
4862 4863 4864 4865 4866
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
4867
 * @autostart: whether the domain should be automatically started 0 or 1
4868 4869 4870 4871 4872 4873 4874 4875
 *
 * 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,
4876 4877 4878
                      int autostart)
{
    virConnectPtr conn;
4879
    DEBUG("domain=%p, autostart=%d", domain, autostart);
4880

4881 4882 4883
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4884
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4885
        virDispatchError(NULL);
4886 4887 4888
        return (-1);
    }

4889 4890
    conn = domain->conn;

4891 4892
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4893
        goto error;
4894 4895
    }

4896 4897 4898 4899 4900 4901 4902
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4903

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

error:
4907
    virDispatchError(domain->conn);
4908
    return -1;
4909 4910
}

4911 4912 4913 4914 4915 4916 4917 4918
/**
 * 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.
4919
 * This function requires privileged access to the hypervisor.
4920
 *
4921 4922 4923
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
4924 4925 4926 4927 4928 4929
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
4930
    virConnectPtr conn;
4931
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
4932

4933 4934
    virResetLastError();

4935
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4936
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4937
        virDispatchError(NULL);
4938 4939
        return (-1);
    }
4940 4941
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4942
        goto error;
4943
    }
4944

4945 4946
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4947
        goto error;
4948
    }
4949
    conn = domain->conn;
4950

4951 4952 4953 4954 4955 4956 4957
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4958

4959
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4960 4961

error:
4962
    virDispatchError(domain->conn);
4963
    return -1;
4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977
}

/**
 * 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.
4978
 *
4979
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4980
 * This function requires privileged access to the hypervisor.
4981
 *
4982 4983 4984
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
4985 4986 4987 4988 4989 4990
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4991
    virConnectPtr conn;
4992
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4993

4994 4995
    virResetLastError();

4996
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4997
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4998
        virDispatchError(NULL);
4999 5000
        return (-1);
    }
5001 5002
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5003
        goto error;
5004
    }
5005

5006
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
5007
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5008
       goto error;
5009
    }
5010

5011 5012
    conn = domain->conn;

5013 5014 5015 5016 5017 5018 5019
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5020

5021
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5022 5023

error:
5024
    virDispatchError(domain->conn);
5025
    return -1;
5026 5027 5028 5029 5030 5031 5032
}

/**
 * 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
D
Dan Kenigsberg 已提交
5033
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
5034
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
5035
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
5036 5037 5038 5039 5040 5041 5042
 *	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...).
5043
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
5044
 *
5045
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
5046
 * and also in cpumaps if this pointer isn't NULL.
5047 5048 5049 5050 5051
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
5052
                  unsigned char *cpumaps, int maplen)
5053
{
5054
    virConnectPtr conn;
5055
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
5056

5057 5058
    virResetLastError();

5059
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5060
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5061
        virDispatchError(NULL);
5062 5063 5064 5065
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5066
        goto error;
5067
    }
5068 5069 5070 5071 5072

    /* Ensure that domainGetVcpus (aka remoteDomainGetVcpus) does not
       try to memcpy anything into a NULL pointer.  */
    if ((cpumaps == NULL && maplen != 0)
        || (cpumaps && maplen <= 0)) {
5073
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5074
        goto error;
5075
    }
5076

5077 5078
    conn = domain->conn;

5079 5080 5081 5082 5083 5084 5085 5086
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5087

5088
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5089 5090

error:
5091
    virDispatchError(domain->conn);
5092
    return -1;
5093
}
5094

5095 5096 5097
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
5098
 *
5099 5100 5101 5102 5103
 * 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.
5104 5105 5106 5107
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
5108 5109
virDomainGetMaxVcpus(virDomainPtr domain)
{
5110
    virConnectPtr conn;
5111
    DEBUG("domain=%p", domain);
5112

5113 5114
    virResetLastError();

5115
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5116
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5117
        virDispatchError(NULL);
5118 5119 5120 5121 5122
        return (-1);
    }

    conn = domain->conn;

5123 5124 5125 5126 5127 5128 5129
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5130

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

error:
5134
    virDispatchError(domain->conn);
5135
    return -1;
5136 5137
}

5138 5139 5140 5141 5142
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
5143 5144 5145
 * Extract security label of an active domain. The 'label' field
 * in the @seclabel argument will be initialized to the empty
 * string if the domain is not running under a security model.
5146
 *
5147
 * Returns 0 in case of success, -1 in case of failure
5148 5149 5150 5151 5152 5153 5154 5155
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5156
        virDispatchError(NULL);
5157 5158 5159 5160 5161
        return -1;
    }

    if (seclabel == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5162
        goto error;
5163 5164 5165 5166
    }

    conn = domain->conn;

5167 5168 5169 5170 5171 5172 5173 5174 5175
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5176

5177
error:
5178
    virDispatchError(domain->conn);
5179
    return -1;
5180 5181 5182 5183 5184 5185 5186
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
5187 5188 5189
 * Extract the security model of a hypervisor. The 'model' field
 * in the @secmodel argument may be initialized to the empty
 * string if the driver has not activated a security model.
5190
 *
5191
 * Returns 0 in case of success, -1 in case of failure
5192 5193 5194 5195 5196
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
    if (!VIR_IS_CONNECT(conn)) {
5197 5198
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5199 5200 5201 5202 5203
        return -1;
    }

    if (secmodel == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5204 5205 5206 5207 5208 5209 5210 5211 5212
        goto error;
    }

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

5215
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5216

5217
error:
5218
    virDispatchError(conn);
5219
    return -1;
5220
}
5221

5222 5223 5224 5225
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5226
 *
5227 5228
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
5229
 *
5230 5231 5232 5233
 * For compatibility, this method can also be used to change the media
 * in an existing CDROM/Floppy device, however, applications are
 * recommended to use the virDomainUpdateDeviceFlag method instead.
 *
5234 5235 5236
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5237
virDomainAttachDevice(virDomainPtr domain, const char *xml)
5238 5239
{
    virConnectPtr conn;
5240
    DEBUG("domain=%p, xml=%s", domain, xml);
5241

5242 5243
    virResetLastError();

5244
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5245
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5246
        virDispatchError(NULL);
5247 5248 5249 5250
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5251
        goto error;
5252 5253 5254
    }
    conn = domain->conn;

5255
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainAttachDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Attach a virtual device to a domain, using the flags parameter
 * to control how the device is attached.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device allocation is made based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * allocated to the active domain instance only and is not added to the
 * persisted domain configuration.  VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be allocated to the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports modifying the
 * persisted device allocation.
 *
5288 5289 5290 5291
 * For compatibility, this method can also be used to change the media
 * in an existing CDROM/Floppy device, however, applications are
 * recommended to use the virDomainUpdateDeviceFlag method instead.
 *
J
Jim Fehlig 已提交
5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
5314
        int ret;
J
Jim Fehlig 已提交
5315
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
5316 5317 5318 5319
        if (ret < 0)
            goto error;
        return ret;
    }
5320

J
Jim Fehlig 已提交
5321
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5322 5323

error:
5324
    virDispatchError(domain->conn);
5325
    return -1;
5326 5327 5328 5329 5330 5331
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5332
 *
5333 5334
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
5335 5336 5337 5338
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5339
virDomainDetachDevice(virDomainPtr domain, const char *xml)
5340 5341
{
    virConnectPtr conn;
5342
    DEBUG("domain=%p, xml=%s", domain, xml);
5343

5344 5345
    virResetLastError();

5346
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5347
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5348
        virDispatchError(NULL);
5349 5350 5351 5352
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5353
        goto error;
5354 5355 5356
    }
    conn = domain->conn;

5357 5358 5359
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413
         if (ret < 0)
             goto error;
         return ret;
     }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainDetachDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Detach a virtual device from a domain, using the flags parameter
 * to control how the device is detached.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device allocation is removed based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * deallocated from the active domain instance only and is not from the
 * persisted domain configuration.  VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be deallocated from the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports removing the
 * persisted device allocation.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainDetachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainUpdateDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Change a virtual device on a domain, using the flags parameter
 * to control how the device is changed.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device change is made based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * changed on the active domain instance only and is not added to the
 * persisted domain configuration. VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be changed on the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports modifying the
 * persisted device allocation.
 *
 * This method is used for actions such changing CDROM/Floppy device
 * media, altering the graphics configuration such as password,
 * reconfiguring the NIC device backend connectivity, etc.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainUpdateDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
5472 5473 5474 5475
        if (ret < 0)
            goto error;
        return ret;
    }
5476

J
Jim Fehlig 已提交
5477
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5478 5479

error:
5480
    virDispatchError(domain->conn);
5481
    return -1;
5482
}
5483

5484 5485 5486 5487 5488 5489 5490 5491 5492 5493
/**
 * 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
5494
 * with the amount of free memory in bytes for each cell requested,
5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505
 * 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)
{
5506 5507 5508
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

5509 5510
    virResetLastError();

5511
    if (!VIR_IS_CONNECT(conn)) {
5512 5513
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5514 5515 5516
        return (-1);
    }

D
Daniel Veillard 已提交
5517
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
5518
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5519
        goto error;
5520 5521
    }

5522 5523 5524 5525 5526 5527 5528
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
5529 5530

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5531 5532

error:
5533
    virDispatchError(conn);
5534 5535 5536
    return -1;
}

5537 5538 5539 5540
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
5541
 * Provides the connection pointer associated with a network.  The
5542 5543 5544
 * reference counter on the connection is not increased by this
 * call.
 *
5545 5546 5547 5548
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
5549 5550 5551 5552 5553
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
5554 5555
    DEBUG("net=%p", net);

5556 5557 5558
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
5559
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5560
        virDispatchError(NULL);
5561 5562 5563 5564 5565
        return NULL;
    }
    return net->conn;
}

5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576
/**
 * 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)
{
5577 5578
    DEBUG("conn=%p", conn);

5579 5580
    virResetLastError();

5581
    if (!VIR_IS_CONNECT(conn)) {
5582
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5583
        virDispatchError(NULL);
5584 5585 5586
        return (-1);
    }

5587 5588 5589 5590 5591 5592 5593
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5594

5595
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5596 5597

error:
5598
    virDispatchError(conn);
5599
    return -1;
5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612
}

/**
 * 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
5613
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
5614
{
5615 5616
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

5617 5618
    virResetLastError();

5619
    if (!VIR_IS_CONNECT(conn)) {
5620
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5621
        virDispatchError(NULL);
5622 5623 5624
        return (-1);
    }

5625
    if ((names == NULL) || (maxnames < 0)) {
5626
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5627
        goto error;
5628 5629
    }

5630 5631 5632 5633 5634 5635 5636
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5637

5638
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5639 5640

error:
5641
    virDispatchError(conn);
5642
    return -1;
5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655
}

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

5658 5659
    virResetLastError();

5660
    if (!VIR_IS_CONNECT(conn)) {
5661
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5662
        virDispatchError(NULL);
5663 5664 5665
        return (-1);
    }

5666 5667 5668 5669 5670 5671 5672
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5673

5674
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5675 5676

error:
5677
    virDispatchError(conn);
5678
    return -1;
5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691
}

/**
 * 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
5692
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
5693 5694
                              int maxnames)
{
5695 5696
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

5697 5698
    virResetLastError();

5699
    if (!VIR_IS_CONNECT(conn)) {
5700
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5701
        virDispatchError(NULL);
5702 5703 5704
        return (-1);
    }

5705
    if ((names == NULL) || (maxnames < 0)) {
5706
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5707
        goto error;
5708 5709
    }

5710 5711 5712 5713 5714 5715 5716 5717
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5718

5719
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5720 5721

error:
5722
    virDispatchError(conn);
5723
    return -1;
5724 5725 5726 5727 5728 5729 5730 5731 5732
}

/**
 * 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.
 *
5733 5734
 * 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.
5735 5736 5737 5738
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
5739 5740
    DEBUG("conn=%p, name=%s", conn, name);

5741 5742
    virResetLastError();

5743
    if (!VIR_IS_CONNECT(conn)) {
5744
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5745
        virDispatchError(NULL);
5746 5747 5748 5749
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5750
        goto  error;
5751 5752
    }

5753 5754 5755 5756 5757 5758 5759
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
5760

5761
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5762 5763

error:
5764
    virDispatchError(conn);
5765
    return NULL;
5766 5767 5768 5769 5770 5771 5772 5773 5774
}

/**
 * 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.
 *
5775 5776
 * 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.
5777 5778 5779 5780
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
5781 5782
    DEBUG("conn=%p, uuid=%s", conn, uuid);

5783 5784
    virResetLastError();

5785
    if (!VIR_IS_CONNECT(conn)) {
5786
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5787
        virDispatchError(NULL);
5788 5789 5790 5791
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5792
        goto error;
5793 5794
    }

5795 5796 5797 5798 5799 5800 5801
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
5802

5803
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5804 5805

error:
5806
    virDispatchError(conn);
5807
    return NULL;
5808 5809 5810 5811 5812 5813 5814 5815 5816
}

/**
 * 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.
 *
5817 5818
 * 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.
5819 5820 5821 5822 5823
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
5824
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
5825

5826 5827
    virResetLastError();

5828
    if (!VIR_IS_CONNECT(conn)) {
5829
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5830
        virDispatchError(NULL);
5831 5832 5833 5834
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5835
        goto error;
5836 5837
    }

5838
    if (virUUIDParse(uuidstr, uuid) < 0) {
5839
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5840
        goto error;
5841 5842 5843
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
5844 5845

error:
5846
    virDispatchError(conn);
5847
    return NULL;
5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862
}

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

5865 5866
    virResetLastError();

5867
    if (!VIR_IS_CONNECT(conn)) {
5868
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5869
        virDispatchError(NULL);
5870 5871 5872 5873
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5874
        goto error;
5875 5876 5877
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5878
        goto error;
5879 5880
    }

5881 5882 5883 5884 5885 5886 5887
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
5888

5889
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5890 5891

error:
5892
    virDispatchError(conn);
5893
    return NULL;
5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905
}

/**
 * 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
5906 5907
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
5908 5909
    DEBUG("conn=%p, xml=%s", conn, xml);

5910 5911
    virResetLastError();

5912
    if (!VIR_IS_CONNECT(conn)) {
5913
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5914
        virDispatchError(NULL);
5915 5916 5917 5918
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5919
        goto error;
5920 5921 5922
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5923
        goto error;
5924 5925
    }

5926 5927 5928 5929 5930 5931 5932
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5933

5934
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5935 5936

error:
5937
    virDispatchError(conn);
5938
    return NULL;
5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951
}

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

5954 5955
    virResetLastError();

5956
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5957
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5958
        virDispatchError(NULL);
5959 5960 5961 5962 5963
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5964
        goto error;
5965 5966
    }

5967 5968 5969 5970 5971 5972 5973
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5974

5975
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5976 5977

error:
5978
    virDispatchError(network->conn);
5979
    return -1;
5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991
}

/**
 * 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
5992 5993
virNetworkCreate(virNetworkPtr network)
{
5994
    virConnectPtr conn;
5995 5996
    DEBUG("network=%p", network);

5997 5998
    virResetLastError();

5999
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6000
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6001
        virDispatchError(NULL);
6002 6003 6004 6005 6006
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6007
        goto error;
6008 6009
    }

6010 6011 6012 6013 6014 6015 6016
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6017

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

error:
6021
    virDispatchError(network->conn);
6022
    return -1;
6023 6024 6025 6026 6027 6028 6029
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
6030 6031 6032
 * 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
6033 6034 6035 6036 6037 6038 6039
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
6040
    DEBUG("network=%p", network);
6041

6042 6043
    virResetLastError();

6044
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6045
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6046
        virDispatchError(NULL);
6047 6048 6049 6050 6051 6052
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6053
        goto error;
6054 6055
    }

6056 6057 6058 6059 6060 6061 6062
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6063

6064
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6065 6066

error:
6067
    virDispatchError(network->conn);
6068
    return -1;
6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082
}

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

6085 6086 6087
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6088
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6089
        virDispatchError(NULL);
6090 6091
        return (-1);
    }
6092 6093
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
6094
        return (-1);
6095
    }
6096 6097 6098
    return(0);
}

6099 6100
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
6101
 * @network: the network to hold a reference on
6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112
 *
 * 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 已提交
6113 6114
 *
 * Returns 0 in case of success, -1 in case of failure.
6115 6116 6117 6118 6119 6120
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
6121
        virDispatchError(NULL);
6122 6123 6124 6125 6126 6127 6128 6129 6130
        return(-1);
    }
    virMutexLock(&network->conn->lock);
    DEBUG("network=%p refs=%d", network, network->refs);
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142
/**
 * 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)
{
6143 6144
    DEBUG("network=%p", network);

6145 6146
    virResetLastError();

6147
    if (!VIR_IS_NETWORK(network)) {
6148
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6149
        virDispatchError(NULL);
6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166
        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)
{
6167 6168
    DEBUG("network=%p, uuid=%p", network, uuid);

6169 6170
    virResetLastError();

6171
    if (!VIR_IS_NETWORK(network)) {
6172
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6173
        virDispatchError(NULL);
6174 6175 6176 6177
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6178
        goto error;
6179 6180 6181 6182 6183
    }

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

    return (0);
6184 6185

error:
6186
    virDispatchError(network->conn);
6187
    return -1;
6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203
}

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

6206 6207
    virResetLastError();

6208
    if (!VIR_IS_NETWORK(network)) {
6209
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6210
        virDispatchError(NULL);
6211 6212 6213 6214
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6215
        goto error;
6216 6217 6218
    }

    if (virNetworkGetUUID(network, &uuid[0]))
6219
        goto error;
6220

6221
    virUUIDFormat(uuid, buf);
6222
    return (0);
6223 6224

error:
6225
    virDispatchError(network->conn);
6226
    return -1;
6227 6228 6229 6230 6231
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
6232
 * @flags: an OR'ed set of extraction flags, not used yet
6233 6234 6235 6236 6237 6238 6239 6240 6241 6242
 *
 * 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)
{
6243
    virConnectPtr conn;
6244
    DEBUG("network=%p, flags=%d", network, flags);
6245

6246 6247 6248
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6249
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6250
        virDispatchError(NULL);
6251 6252 6253 6254
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6255
        goto error;
6256 6257
    }

6258 6259
    conn = network->conn;

6260 6261 6262 6263 6264 6265 6266
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
6267

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

error:
6271
    virDispatchError(network->conn);
6272
    return NULL;
6273
}
6274 6275 6276 6277 6278

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
6279
 * Provides a bridge interface name to which a domain may connect
6280 6281 6282 6283 6284 6285 6286 6287
 * 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)
{
6288
    virConnectPtr conn;
6289
    DEBUG("network=%p", network);
6290

6291 6292 6293
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6294
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6295
        virDispatchError(NULL);
6296 6297 6298
        return (NULL);
    }

6299 6300
    conn = network->conn;

6301 6302 6303 6304 6305 6306 6307
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
6308

6309
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6310 6311

error:
6312
    virDispatchError(network->conn);
6313
    return NULL;
6314
}
6315 6316 6317 6318

/**
 * virNetworkGetAutostart:
 * @network: a network object
6319
 * @autostart: the value returned
6320
 *
6321
 * Provides a boolean value indicating whether the network
6322 6323 6324 6325 6326 6327 6328
 * 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,
6329 6330 6331
                       int *autostart)
{
    virConnectPtr conn;
6332
    DEBUG("network=%p, autostart=%p", network, autostart);
6333

6334 6335 6336
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6337
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6338
        virDispatchError(NULL);
6339 6340 6341 6342
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6343
        goto error;
6344 6345
    }

6346 6347
    conn = network->conn;

6348 6349 6350 6351 6352 6353 6354
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6355

6356
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6357 6358

error:
6359
    virDispatchError(network->conn);
6360
    return -1;
6361 6362 6363 6364 6365
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
6366
 * @autostart: whether the network should be automatically started 0 or 1
6367 6368 6369 6370 6371 6372 6373 6374
 *
 * 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,
6375 6376 6377
                       int autostart)
{
    virConnectPtr conn;
6378
    DEBUG("network=%p, autostart=%d", network, autostart);
6379

6380 6381 6382
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6383
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6384
        virDispatchError(NULL);
6385 6386 6387
        return (-1);
    }

6388 6389
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6390
        goto error;
6391 6392
    }

6393 6394
    conn = network->conn;

6395 6396 6397 6398 6399 6400 6401
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6402

6403
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6404 6405

error:
6406
    virDispatchError(network->conn);
6407
    return -1;
6408
}
6409

D
Daniel Veillard 已提交
6410 6411
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
6412
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424
 *
 * 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
6425
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
6426
{
6427
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6428 6429 6430

    virResetLastError();

6431
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
6432
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6433
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6434 6435
        return NULL;
    }
6436
    return iface->conn;
D
Daniel Veillard 已提交
6437 6438 6439 6440 6441 6442
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
6443
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
6444
 *
6445
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
6446 6447 6448 6449 6450 6451 6452 6453 6454 6455
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6456
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470
        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:
6471
    virDispatchError(conn);
D
Daniel Veillard 已提交
6472 6473 6474 6475 6476 6477 6478 6479 6480
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
6481 6482
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494
 *
 * 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__);
6495
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514
        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:
6515
    virDispatchError(conn);
D
Daniel Veillard 已提交
6516 6517 6518
    return -1;
}

6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535
/**
 * virConnectNumOfDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of defined (inactive) interfaces on the physical host.
 *
 * Returns the number of defined interface found or -1 in case of error
 */
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6536
        virDispatchError(NULL);
6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550
        return (-1);
    }

    if (conn->interfaceDriver && conn->interfaceDriver->numOfDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->numOfDefinedInterfaces (conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6551
    virDispatchError(conn);
6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576
    return -1;
}

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

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6577
        virDispatchError(NULL);
6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596
        return (-1);
    }

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

    if (conn->interfaceDriver && conn->interfaceDriver->listDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->listDefinedInterfaces (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6597
    virDispatchError(conn);
6598 6599 6600
    return -1;
}

D
Daniel Veillard 已提交
6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619
/**
 * 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__);
6620
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638
        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:
6639
    virDispatchError(conn);
D
Daniel Veillard 已提交
6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661
    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__);
6662
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680
        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:
6681
    virDispatchError(conn);
D
Daniel Veillard 已提交
6682 6683 6684 6685 6686
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
6687
 * @iface: an interface object
D
Daniel Veillard 已提交
6688 6689 6690 6691 6692 6693 6694
 *
 * 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 *
6695
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
6696
{
6697
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6698 6699 6700

    virResetLastError();

6701
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6702
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6703
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6704 6705
        return (NULL);
    }
6706
    return (iface->name);
D
Daniel Veillard 已提交
6707 6708 6709 6710
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
6711
 * @iface: an interface object
D
Daniel Veillard 已提交
6712
 *
L
Laine Stump 已提交
6713
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
6714 6715 6716 6717 6718 6719 6720
 * 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 *
6721
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
6722
{
6723
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6724 6725 6726

    virResetLastError();

6727
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6728
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6729
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6730 6731
        return (NULL);
    }
6732
    return (iface->mac);
D
Daniel Veillard 已提交
6733 6734 6735 6736
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
6737
 * @iface: an interface object
6738 6739 6740 6741 6742
 * @flags: an OR'ed set of extraction flags. Current valid bits:
 *
 *      VIR_INTERFACE_XML_INACTIVE - return the static configuration,
 *                                   suitable for use redefining the
 *                                   interface via virInterfaceDefineXML()
D
Daniel Veillard 已提交
6743
 *
6744 6745 6746 6747 6748
 * Provide an XML description of the interface. If
 * VIR_INTERFACE_XML_INACTIVE is set, the description may be reused
 * later to redefine the interface with virInterfaceDefineXML(). If it
 * is not set, the ip address and netmask will be the current live
 * setting of the interface, not the settings from the config files.
D
Daniel Veillard 已提交
6749 6750 6751 6752 6753
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
6754
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6755 6756
{
    virConnectPtr conn;
6757
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6758 6759 6760

    virResetLastError();

6761
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6762
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6763
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6764 6765
        return (NULL);
    }
6766
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
6767
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
6768 6769 6770
        goto error;
    }

6771
    conn = iface->conn;
D
Daniel Veillard 已提交
6772 6773 6774

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
6775
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
6776 6777 6778 6779 6780 6781 6782 6783
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6784
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806
    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__);
6807
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829
        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:
6830
    virDispatchError(conn);
D
Daniel Veillard 已提交
6831 6832 6833 6834 6835
    return NULL;
}

/**
 * virInterfaceUndefine:
6836
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
6837 6838 6839 6840 6841 6842 6843
 *
 * 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
6844
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
6845
    virConnectPtr conn;
6846
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6847 6848 6849

    virResetLastError();

6850
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6851
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6852
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6853 6854
        return (-1);
    }
6855
    conn = iface->conn;
D
Daniel Veillard 已提交
6856
    if (conn->flags & VIR_CONNECT_RO) {
6857
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6858 6859 6860 6861 6862
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
6863
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
6864 6865 6866 6867 6868 6869 6870 6871
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6872
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
6873 6874 6875 6876 6877
    return -1;
}

/**
 * virInterfaceCreate:
6878
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
6879 6880 6881 6882 6883 6884 6885
 * @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
6886
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6887 6888
{
    virConnectPtr conn;
6889
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6890 6891 6892

    virResetLastError();

6893
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6894
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6895
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6896 6897
        return (-1);
    }
6898
    conn = iface->conn;
D
Daniel Veillard 已提交
6899
    if (conn->flags & VIR_CONNECT_RO) {
6900
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6901 6902 6903 6904 6905
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
6906
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
6907 6908 6909 6910 6911 6912 6913 6914
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6915
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
6916 6917 6918 6919 6920
    return -1;
}

/**
 * virInterfaceDestroy:
6921
 * @iface: an interface object
D
Daniel Veillard 已提交
6922 6923 6924 6925 6926 6927 6928 6929 6930
 * @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
6931
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6932 6933
{
    virConnectPtr conn;
6934
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6935 6936 6937

    virResetLastError();

6938
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6939
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6940
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6941 6942 6943
        return (-1);
    }

6944
    conn = iface->conn;
D
Daniel Veillard 已提交
6945
    if (conn->flags & VIR_CONNECT_RO) {
6946
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6947 6948 6949 6950 6951
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
6952
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
6953 6954 6955 6956 6957 6958 6959 6960
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6961
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
6962 6963 6964 6965 6966
    return -1;
}

/**
 * virInterfaceRef:
6967
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
6968 6969 6970 6971 6972 6973 6974 6975 6976
 *
 * 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
L
Laine Stump 已提交
6977
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
6978 6979 6980 6981 6982
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6983
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
6984
{
6985
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
6986
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
6987
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6988 6989
        return(-1);
    }
6990 6991 6992 6993
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
6994 6995 6996 6997 6998
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
6999
 * @iface: an interface object
D
Daniel Veillard 已提交
7000 7001 7002 7003 7004 7005 7006
 *
 * 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
7007
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
7008
{
7009
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7010 7011 7012

    virResetLastError();

7013
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7014
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7015
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7016 7017
        return (-1);
    }
7018 7019
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7020
        return (-1);
7021
    }
D
Daniel Veillard 已提交
7022 7023 7024
    return(0);
}

7025 7026 7027

/**
 * virStoragePoolGetConnect:
7028
 * @pool: pointer to a pool
7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044
 *
 * 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);

7045 7046 7047
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
7048
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7049
        virDispatchError(NULL);
7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067
        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);

7068 7069
    virResetLastError();

7070 7071
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7072
        virDispatchError(NULL);
7073 7074 7075
        return (-1);
    }

7076 7077 7078 7079 7080 7081 7082
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7083 7084

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7085 7086

error:
7087
    virDispatchError(conn);
7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109
    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);

7110 7111
    virResetLastError();

7112 7113
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7114
        virDispatchError(NULL);
7115 7116 7117 7118 7119
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7120
        goto error;
7121 7122
    }

7123 7124 7125 7126 7127 7128 7129
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7130 7131 7132

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7133
error:
7134
    virDispatchError(conn);
7135
    return -1;
7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151
}


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

7152 7153
    virResetLastError();

7154 7155
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7156
        virDispatchError(NULL);
7157 7158 7159
        return (-1);
    }

7160 7161 7162 7163 7164 7165 7166
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7167 7168

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7169 7170

error:
7171
    virDispatchError(conn);
7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194
    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);

7195 7196
    virResetLastError();

7197 7198
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7199
        virDispatchError(NULL);
7200 7201 7202 7203 7204
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7205
        goto error;
7206 7207
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7217 7218

error:
7219
    virDispatchError(conn);
7220 7221 7222 7223
    return -1;
}


7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250
/**
 * 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)
{
7251 7252 7253 7254
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

7255 7256
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7257
        virDispatchError(NULL);
7258
        return NULL;
7259 7260 7261
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7262
        goto error;
7263 7264
    }

7265 7266
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7267
        goto error;
7268 7269
    }

7270 7271 7272 7273 7274 7275 7276
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
7277 7278

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7279 7280

error:
7281
    virDispatchError(conn);
7282 7283 7284 7285
    return NULL;
}


7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300
/**
 * 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);

7301 7302
    virResetLastError();

7303 7304
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7305
        virDispatchError(NULL);
7306 7307 7308 7309
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7310
        goto error;
7311 7312
    }

7313 7314 7315 7316 7317 7318 7319
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7320 7321

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7322 7323

error:
7324
    virDispatchError(conn);
7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343
    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);

7344 7345
    virResetLastError();

7346 7347
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7348
        virDispatchError(NULL);
7349 7350 7351 7352
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7353
        goto error;
7354 7355
    }

7356 7357 7358 7359 7360 7361 7362
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7363 7364 7365

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7366
error:
7367
    virDispatchError(conn);
7368
    return NULL;
7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382
}


/**
 * 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,
7383
                                 const char *uuidstr)
7384 7385 7386 7387
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

7388 7389
    virResetLastError();

7390 7391
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7392
        virDispatchError(NULL);
7393 7394 7395 7396
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7397
        goto error;
7398 7399 7400 7401
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7402
        goto error;
7403 7404 7405
    }

    return virStoragePoolLookupByUUID(conn, uuid);
7406 7407

error:
7408
    virDispatchError(conn);
7409
    return NULL;
7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425
}


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

7426 7427 7428
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
7429
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7430
        virDispatchError(NULL);
7431 7432 7433
        return (NULL);
    }

7434 7435 7436 7437 7438 7439 7440
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
7441 7442 7443

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

7444
error:
7445
    virDispatchError(vol->conn);
7446
    return NULL;
7447 7448 7449 7450 7451 7452
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
7453
 * @flags: future flags, use 0 for now
7454 7455
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
7456
 * pool is not persistent, so its definition will disappear
7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467
 * 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);

7468 7469
    virResetLastError();

7470 7471
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7472
        virDispatchError(NULL);
7473 7474 7475 7476
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7477
        goto error;
7478 7479 7480
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7481
        goto error;
7482 7483
    }

7484 7485 7486 7487 7488 7489 7490
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7491 7492

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7493 7494

error:
7495
    virDispatchError(conn);
7496 7497 7498 7499 7500 7501 7502
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
7503
 * @flags: future flags, use 0 for now
7504 7505
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
7506
 * pool is persistent, until explicitly undefined.
7507 7508 7509 7510 7511 7512 7513 7514 7515 7516
 *
 * 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);

7517 7518
    virResetLastError();

7519 7520
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7521
        virDispatchError(NULL);
7522 7523 7524 7525
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7526
        goto error;
7527 7528 7529
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7530
        goto error;
7531 7532
    }

7533 7534 7535 7536 7537 7538 7539
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
7540 7541 7542

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7543
error:
7544
    virDispatchError(conn);
7545
    return NULL;
7546 7547 7548 7549 7550
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
7551
 * @flags: future flags, use 0 for now
7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563
 *
 * 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);

7564 7565
    virResetLastError();

7566 7567
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7568
        virDispatchError(NULL);
7569 7570 7571 7572 7573
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7574
        goto error;
7575 7576
    }

7577 7578 7579 7580 7581 7582 7583
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7584 7585 7586

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7587
error:
7588
    virDispatchError(pool->conn);
7589
    return -1;
7590 7591 7592 7593 7594 7595 7596 7597 7598
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
7599
 * Returns 0 on success, -1 on failure
7600 7601 7602 7603 7604 7605 7606
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

7607 7608
    virResetLastError();

7609 7610
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7611
        virDispatchError(NULL);
7612 7613 7614 7615 7616
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7617
        goto error;
7618 7619
    }

7620 7621 7622 7623 7624 7625 7626
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7627 7628 7629

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7630
error:
7631
    virDispatchError(pool->conn);
7632
    return -1;
7633 7634 7635 7636 7637 7638
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
7639
 * @flags: future flags, use 0 for now
7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651
 *
 * 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);

7652 7653
    virResetLastError();

7654 7655
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7656
        virDispatchError(NULL);
7657 7658 7659 7660 7661
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7662
        goto error;
7663 7664
    }

7665 7666 7667 7668 7669 7670 7671
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7672 7673 7674

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7675
error:
7676
    virDispatchError(pool->conn);
7677
    return -1;
7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698
}


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

7699 7700
    virResetLastError();

7701 7702
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7703
        virDispatchError(NULL);
7704 7705 7706 7707 7708 7709
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7710
        goto error;
7711 7712
    }

7713 7714 7715 7716 7717 7718 7719
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7720 7721

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7722 7723

error:
7724
    virDispatchError(pool->conn);
7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745
    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);

7746 7747
    virResetLastError();

7748 7749
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7750
        virDispatchError(NULL);
7751 7752 7753 7754 7755 7756
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7757
        goto error;
7758 7759
    }

7760 7761 7762 7763 7764 7765 7766
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7767 7768

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7769 7770

error:
7771
    virDispatchError(pool->conn);
7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789
    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);

7790 7791 7792
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7793
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7794
        virDispatchError(NULL);
7795 7796
        return (-1);
    }
7797 7798
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
7799
        return (-1);
7800
    }
7801 7802 7803 7804 7805
    return(0);

}


7806 7807
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
7808
 * @pool: the pool to hold a reference on
7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819
 *
 * 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 已提交
7820 7821
 *
 * Returns 0 in case of success, -1 in case of failure.
7822 7823 7824 7825 7826 7827
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
7828
        virDispatchError(NULL);
7829 7830 7831 7832 7833 7834 7835 7836 7837
        return(-1);
    }
    virMutexLock(&pool->conn->lock);
    DEBUG("pool=%p refs=%d", pool, pool->refs);
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

7838 7839 7840 7841 7842 7843 7844 7845 7846
/**
 * 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
 *
7847
 * Returns 0 if the volume list was refreshed, -1 on failure
7848 7849 7850 7851 7852 7853 7854 7855
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p flags=%u", pool, flags);

7856 7857
    virResetLastError();

7858 7859
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7860
        virDispatchError(NULL);
7861 7862 7863 7864 7865 7866
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7867
        goto error;
7868 7869
    }

7870 7871 7872 7873 7874 7875 7876
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7877 7878

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7879 7880

error:
7881
    virDispatchError(pool->conn);
7882 7883 7884 7885 7886 7887 7888 7889 7890 7891
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
7892
 * Returns the name of the pool, or NULL on error
7893 7894 7895 7896 7897 7898
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

7899 7900
    virResetLastError();

7901 7902
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7903
        virDispatchError(NULL);
7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916
        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
 *
7917
 * Returns 0 on success, or -1 on error;
7918 7919 7920 7921 7922 7923 7924
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
    DEBUG("pool=%p, uuid=%p", pool, uuid);

7925 7926
    virResetLastError();

7927 7928
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7929
        virDispatchError(NULL);
7930 7931 7932 7933
        return (-1);
    }
    if (uuid == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7934
        goto error;
7935 7936 7937 7938 7939 7940
    }

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

    return (0);

7941
error:
7942
    virDispatchError(pool->conn);
7943
    return -1;
7944 7945 7946 7947 7948 7949 7950 7951 7952
}

/**
 * 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
 *
7953
 * Returns 0 on success, or -1 on error;
7954 7955 7956 7957 7958 7959 7960 7961
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("pool=%p, buf=%p", pool, buf);

7962 7963
    virResetLastError();

7964 7965
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7966
        virDispatchError(NULL);
7967 7968 7969 7970
        return (-1);
    }
    if (buf == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7971
        goto error;
7972 7973 7974
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
7975
        goto error;
7976 7977 7978 7979

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

7980
error:
7981
    virDispatchError(pool->conn);
7982
    return -1;
7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993
}


/**
 * 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
 *
7994
 * Returns 0 on success, or -1 on failure.
7995 7996 7997 7998 7999 8000 8001 8002
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("pool=%p, info=%p", pool, info);

8003 8004
    virResetLastError();

8005 8006
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8007
        virDispatchError(NULL);
8008 8009 8010 8011
        return (-1);
    }
    if (info == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8012
        goto error;
8013 8014 8015 8016 8017 8018
    }

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

    conn = pool->conn;

8019 8020 8021 8022 8023 8024 8025
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
8026 8027 8028

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8029
error:
8030
    virDispatchError(pool->conn);
8031
    return -1;
8032 8033 8034 8035 8036 8037
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
8038
 * @flags: flags for XML format options (set of virDomainXMLFlags)
8039 8040 8041 8042 8043
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
8044
 * Returns a XML document, or NULL on error
8045 8046 8047 8048 8049 8050 8051 8052
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

8053 8054 8055
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8056
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8057
        virDispatchError(NULL);
8058 8059 8060 8061
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8062
        goto error;
8063 8064 8065 8066
    }

    conn = pool->conn;

8067 8068 8069 8070 8071 8072 8073
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
8074 8075 8076

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8077
error:
8078
    virDispatchError(pool->conn);
8079
    return NULL;
8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090
}


/**
 * 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
 *
8091
 * Returns 0 on success, -1 on failure
8092 8093 8094 8095 8096 8097 8098 8099
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%p", pool, autostart);

8100 8101 8102
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8103
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8104
        virDispatchError(NULL);
8105 8106 8107 8108
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8109
        goto error;
8110 8111 8112 8113
    }

    conn = pool->conn;

8114 8115 8116 8117 8118 8119 8120
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8121 8122

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8123 8124

error:
8125
    virDispatchError(pool->conn);
8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
8137
 * Returns 0 on success, -1 on failure
8138 8139 8140 8141 8142 8143 8144 8145
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%d", pool, autostart);

8146 8147 8148
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8149
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8150
        virDispatchError(NULL);
8151
        return -1;
8152 8153
    }

8154 8155
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8156
        goto error;
8157 8158
    }

8159 8160
    conn = pool->conn;

8161 8162 8163 8164 8165 8166 8167
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8168 8169

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8170 8171

error:
8172
    virDispatchError(pool->conn);
8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189
    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);

8190 8191
    virResetLastError();

8192 8193
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8194
        virDispatchError(NULL);
8195 8196 8197
        return (-1);
    }

8198 8199 8200 8201 8202 8203 8204
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8205 8206

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

error:
8209
    virDispatchError(pool->conn);
8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231
    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);

8232 8233
    virResetLastError();

8234 8235
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8236
        virDispatchError(NULL);
8237 8238 8239 8240 8241
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8242
        goto error;
8243 8244
    }

8245 8246 8247 8248 8249 8250 8251
    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;
    }
8252 8253

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

error:
8256
    virDispatchError(pool->conn);
8257 8258 8259 8260 8261 8262
    return -1;
}


/**
 * virStorageVolGetConnect:
8263
 * @vol: pointer to a pool
8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279
 *
 * 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);

8280 8281
    virResetLastError();

8282 8283
    if (!VIR_IS_STORAGE_VOL (vol)) {
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8284
        virDispatchError(NULL);
8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298
        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
 *
8299
 * Returns a storage volume, or NULL if not found / error
8300 8301 8302 8303 8304 8305 8306
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
    DEBUG("pool=%p, name=%s", pool, name);

8307 8308
    virResetLastError();

8309 8310
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8311
        virDispatchError(NULL);
8312 8313 8314 8315
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8316
        goto error;
8317 8318
    }

8319 8320 8321 8322 8323 8324 8325
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
8326 8327

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

error:
8330
    virDispatchError(pool->conn);
8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343
    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
 *
8344
 * Returns a storage volume, or NULL if not found / error
8345 8346 8347 8348 8349 8350 8351
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
    DEBUG("conn=%p, key=%s", conn, key);

8352 8353
    virResetLastError();

8354 8355
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8356
        virDispatchError(NULL);
8357 8358 8359 8360
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8361
        goto error;
8362 8363
    }

8364 8365 8366 8367 8368 8369 8370
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
8371 8372

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8373 8374

error:
8375
    virDispatchError(conn);
8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386
    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
 *
8387
 * Returns a storage volume, or NULL if not found / error
8388 8389 8390 8391 8392 8393 8394
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
    DEBUG("conn=%p, path=%s", conn, path);

8395 8396
    virResetLastError();

8397 8398
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8399
        virDispatchError(NULL);
8400 8401 8402 8403
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8404
        goto error;
8405 8406
    }

8407 8408 8409 8410 8411 8412 8413
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
8414 8415

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8416 8417

error:
8418
    virDispatchError(conn);
8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
8430
 * Returns the volume name, or NULL on error
8431 8432 8433 8434 8435 8436
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8437 8438
    virResetLastError();

8439 8440
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8441
        virDispatchError(NULL);
8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452
        return (NULL);
    }
    return (vol->name);
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
8453
 * unique, so the same volume will have the same
8454 8455
 * key no matter what host it is accessed from
 *
8456
 * Returns the volume key, or NULL on error
8457 8458 8459 8460 8461 8462
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8463 8464
    virResetLastError();

8465 8466
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8467
        virDispatchError(NULL);
8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483
        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
 *
8484
 * Returns the storage volume, or NULL on error
8485 8486 8487 8488 8489 8490 8491 8492
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
    DEBUG("pool=%p, flags=%u", pool, flags);

8493 8494
    virResetLastError();

8495
    if (!VIR_IS_STORAGE_POOL(pool)) {
8496
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8497
        virDispatchError(NULL);
8498 8499 8500 8501 8502
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8503
        goto error;
8504 8505
    }

8506 8507 8508 8509 8510 8511 8512
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
8513 8514

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

error:
8517
    virDispatchError(pool->conn);
8518 8519 8520 8521
    return NULL;
}


8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533
/**
 * 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.
 *
8534
 * Returns the storage volume, or NULL on error
8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547
 */
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__);
8548
        virDispatchError(NULL);
8549 8550 8551 8552 8553
        return (NULL);
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8554
        goto error;
8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575
    }

    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:
8576
    virDispatchError(pool->conn);
8577 8578 8579 8580
    return NULL;
}


8581 8582 8583
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
8584
 * @flags: future flags, use 0 for now
8585 8586 8587
 *
 * Delete the storage volume from the pool
 *
8588
 * Returns 0 on success, or -1 on error
8589 8590 8591 8592 8593 8594 8595 8596
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

8597 8598
    virResetLastError();

8599 8600
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8601
        virDispatchError(NULL);
8602 8603 8604 8605 8606 8607
        return (-1);
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStorageVolError(vol, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8608
        goto error;
8609 8610
    }

8611 8612 8613 8614 8615 8616 8617
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8618 8619

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8620 8621

error:
8622
    virDispatchError(vol->conn);
8623 8624 8625 8626
    return -1;
}


8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673
/**
 * virStorageVolWipe:
 * @vol: pointer to storage volume
 * @flags: future flags, use 0 for now
 *
 * Ensure data previously on a volume is not accessible to future reads
 *
 * Returns 0 on success, or -1 on error
 */
int
virStorageVolWipe(virStorageVolPtr vol,
                  unsigned int flags)
{
    virConnectPtr conn;
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStorageVolError(vol, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(vol->conn);
    return -1;
}


8674 8675 8676 8677 8678
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
8679
 * storage volume continues to exist.
8680
 *
8681
 * Returns 0 on success, or -1 on error
8682 8683 8684 8685 8686 8687
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8688 8689
    virResetLastError();

8690 8691
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8692
        virDispatchError(NULL);
8693 8694
        return (-1);
    }
8695 8696
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
8697
        return (-1);
8698
    }
8699 8700 8701 8702
    return(0);
}


8703 8704
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
8705
 * @vol: the vol to hold a reference on
8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716
 *
 * 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 已提交
8717 8718
 *
 * Returns 0 in case of success, -1 in case of failure.
8719 8720 8721 8722 8723 8724
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
8725
        virDispatchError(NULL);
8726 8727 8728 8729 8730 8731 8732 8733 8734
        return(-1);
    }
    virMutexLock(&vol->conn->lock);
    DEBUG("vol=%p refs=%d", vol, vol->refs);
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

8735 8736 8737 8738 8739 8740 8741 8742
/**
 * 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
 *
8743
 * Returns 0 on success, or -1 on failure
8744 8745 8746 8747 8748 8749 8750 8751
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("vol=%p, info=%p", vol, info);

8752 8753
    virResetLastError();

8754 8755
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8756
        virDispatchError(NULL);
8757 8758 8759 8760
        return (-1);
    }
    if (info == NULL) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
8761
        goto error;
8762 8763 8764 8765 8766 8767
    }

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

    conn = vol->conn;

8768 8769 8770 8771 8772 8773 8774
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
8775 8776

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8777 8778

error:
8779
    virDispatchError(vol->conn);
8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791
    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
 *
8792
 * Returns the XML document, or NULL on error
8793 8794 8795 8796 8797 8798 8799 8800
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

8801 8802
    virResetLastError();

8803 8804
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8805
        virDispatchError(NULL);
8806 8807 8808 8809
        return (NULL);
    }
    if (flags != 0) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
8810
        goto error;
8811 8812 8813 8814
    }

    conn = vol->conn;

8815 8816 8817 8818 8819 8820 8821
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
8822 8823 8824

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8825
error:
8826
    virDispatchError(vol->conn);
8827
    return NULL;
8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848
}


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

8849 8850
    virResetLastError();

8851 8852
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8853
        virDispatchError(NULL);
8854 8855 8856 8857 8858
        return (NULL);
    }

    conn = vol->conn;

8859 8860 8861 8862 8863 8864 8865
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
8866 8867

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8868 8869

error:
8870
    virDispatchError(vol->conn);
8871 8872
    return NULL;
}
8873 8874


8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890
/**
 * 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 已提交
8891
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
8892

8893 8894
    virResetLastError();

8895 8896
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8897
        virDispatchError(NULL);
8898 8899 8900 8901
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8902
        goto error;
8903 8904
    }

8905 8906 8907 8908 8909 8910 8911
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8912 8913

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8914 8915

error:
8916
    virDispatchError(conn);
8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944
    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);

8945 8946
    virResetLastError();

8947 8948
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8949
        virDispatchError(NULL);
8950 8951 8952 8953
        return (-1);
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8954
        goto error;
8955 8956
    }

8957 8958 8959 8960 8961 8962 8963
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8964 8965

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8966 8967

error:
8968
    virDispatchError(conn);
8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985
    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);

8986 8987
    virResetLastError();

8988 8989
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8990
        virDispatchError(NULL);
8991 8992 8993 8994 8995
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8996
        goto error;
8997 8998
    }

8999 9000 9001 9002 9003 9004 9005
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
9006 9007

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9008 9009

error:
9010
    virDispatchError(conn);
9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022
    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.
 *
9023
 * Returns the XML document, or NULL on error
9024 9025 9026 9027 9028
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9029 9030
    virResetLastError();

9031 9032
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9033
        virDispatchError(NULL);
9034 9035 9036
        return NULL;
    }

9037 9038 9039 9040 9041 9042 9043
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
9044 9045

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

error:
9048
    virDispatchError(dev->conn);
9049 9050 9051 9052 9053 9054 9055 9056
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9057 9058 9059
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
9060 9061 9062 9063 9064 9065 9066
 */
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__);
9067
        virDispatchError(NULL);
9068 9069 9070 9071 9072 9073 9074 9075 9076 9077
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9078 9079
 * Accessor for the parent of the device
 *
9080 9081 9082 9083 9084 9085 9086
 * 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);

9087 9088
    virResetLastError();

9089 9090
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9091
        virDispatchError(NULL);
9092 9093 9094
        return NULL;
    }

9095 9096 9097 9098 9099
    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__);
9100
            virDispatchError(dev->conn);
9101 9102 9103 9104
            return NULL;
        }
    }
    return dev->parent;
9105 9106 9107 9108 9109 9110
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9111 9112
 * Accessor for the number of capabilities supported by the device.
 *
9113 9114 9115 9116 9117 9118
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9119 9120
    virResetLastError();

9121 9122
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9123
        virDispatchError(NULL);
9124 9125 9126
        return -1;
    }

9127 9128 9129 9130 9131 9132 9133
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
9134 9135

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

error:
9138
    virDispatchError(dev->conn);
9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158
    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);

9159 9160
    virResetLastError();

9161 9162
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9163
        virDispatchError(NULL);
9164 9165 9166
        return -1;
    }

9167 9168 9169 9170 9171 9172 9173
    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;
    }
9174 9175

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

error:
9178
    virDispatchError(dev->conn);
9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195
    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);

9196 9197
    virResetLastError();

9198 9199
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9200
        virDispatchError(NULL);
9201 9202
        return (-1);
    }
9203 9204
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
9205
        return (-1);
9206
    }
9207 9208 9209 9210
    return(0);
}


9211 9212
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
9213
 * @dev: the dev to hold a reference on
9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224
 *
 * 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 已提交
9225 9226
 *
 * Returns 0 in case of success, -1 in case of failure.
9227 9228 9229 9230 9231 9232
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
9233
        virDispatchError(NULL);
9234 9235 9236 9237 9238 9239 9240 9241 9242
        return(-1);
    }
    virMutexLock(&dev->conn->lock);
    DEBUG("dev=%p refs=%d", dev, dev->refs);
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

9243
/**
D
Daniel Veillard 已提交
9244
 * virNodeDeviceDettach:
9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258
 * @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 已提交
9259 9260
 *
 * Returns 0 in case of success, -1 in case of failure.
9261 9262 9263 9264 9265 9266 9267 9268 9269 9270
 */
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__);
9271
        virDispatchError(NULL);
9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285
        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:
9286
    virDispatchError(dev->conn);
9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301
    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 已提交
9302 9303
 *
 * Returns 0 in case of success, -1 in case of failure.
9304 9305 9306 9307 9308 9309 9310 9311 9312 9313
 */
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__);
9314
        virDispatchError(NULL);
9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328
        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:
9329
    virDispatchError(dev->conn);
9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346
    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 已提交
9347 9348
 *
 * Returns 0 in case of success, -1 in case of failure.
9349 9350 9351 9352 9353 9354 9355 9356 9357 9358
 */
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__);
9359
        virDispatchError(NULL);
9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373
        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:
9374
    virDispatchError(dev->conn);
9375 9376 9377
    return (-1);
}

9378

9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400
/**
 * 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__);
9401
        virDispatchError(NULL);
9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425
        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:
9426
    virDispatchError(conn);
9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448
    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__);
9449
        virDispatchError(NULL);
9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470
        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:
9471
    virDispatchError(dev->conn);
9472 9473 9474 9475
    return -1;
}


9476 9477 9478 9479 9480 9481 9482 9483 9484
/*
 * 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 已提交
9485
 * @freecb: optional function to deallocate opaque when not used anymore
9486
 *
9487 9488 9489 9490 9491 9492
 * Adds a callback to receive notifications of domain lifecycle events
 * occurring on a connection
 *
 * Use of this method is no longer recommended. Instead applications
 * should try virConnectDomainEventRegisterAny which has a more flexible
 * API contract
9493
 *
9494 9495 9496 9497 9498 9499 9500
 * 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.
 *
9501 9502 9503 9504 9505
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
9506 9507
                              void *opaque,
                              virFreeCallback freecb)
9508
{
9509 9510
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
9511 9512 9513

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9514
        virDispatchError(NULL);
9515 9516 9517 9518
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9519
        goto error;
9520 9521
    }

9522 9523 9524 9525 9526 9527 9528 9529 9530 9531
    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:
9532
    virDispatchError(conn);
9533 9534 9535 9536 9537 9538 9539 9540
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
9541 9542 9543 9544 9545 9546
 * Removes a callback previously registered with the virConnectDomainEventRegister
 * funtion.
 *
 * Use of this method is no longer recommended. Instead applications
 * should try virConnectDomainEventUnregisterAny which has a more flexible
 * API contract
9547 9548 9549 9550 9551 9552 9553
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
9554 9555 9556
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
9557 9558 9559

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9560
        virDispatchError(NULL);
9561 9562 9563 9564
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9565 9566 9567 9568 9569 9570 9571 9572
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
9573 9574
    }

9575 9576
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
9577
    virDispatchError(conn);
9578 9579
    return -1;
}
9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601

/**
 * virSecretGetConnect:
 * @secret: A virSecret secret
 *
 * Provides the connection pointer associated with a secret.  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 secret object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virSecretGetConnect (virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
        virLibSecretError (NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
9602
        virDispatchError(NULL);
9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624
        return NULL;
    }
    return secret->conn;
}

/**
 * virConnectNumOfSecrets:
 * @conn: virConnect connection
 *
 * Fetch number of currently defined secrets.
 *
 * Returns the number currently defined secrets.
 */
int
virConnectNumOfSecrets(virConnectPtr conn)
{
    VIR_DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9625
        virDispatchError(NULL);
9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9642
    virDispatchError(conn);
9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664
    return -1;
}

/**
 * virConnectListSecrets:
 * @conn: virConnect connection
 * @uuids: Pointer to an array to store the UUIDs
 * @maxuuids: size of the array.
 *
 * List UUIDs of defined secrets, store pointers to names in uuids.
 *
 * Returns the number of UUIDs provided in the array, or -1 on failure.
 */
int
virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids)
{
    VIR_DEBUG("conn=%p, uuids=%p, maxuuids=%d", conn, uuids, maxuuids);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9665
        virDispatchError(NULL);
9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->listSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->listSecrets(conn, uuids, maxuuids);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9685
    virDispatchError(conn);
9686 9687 9688 9689
    return -1;
}

/**
9690 9691 9692
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
9693
 *
9694 9695
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
9696
 *
9697 9698
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
9699 9700
 */
virSecretPtr
9701
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
9702
{
9703
    DEBUG("conn=%p, uuid=%s", conn, uuid);
9704 9705 9706 9707 9708

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9709
        virDispatchError(NULL);
9710
        return (NULL);
9711 9712 9713 9714 9715 9716
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

9717 9718
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
9719
        virSecretPtr ret;
9720 9721
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
9722 9723 9724 9725 9726 9727 9728
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9729
    virDispatchError(conn);
9730 9731 9732
    return NULL;
}

9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753
/**
 * virSecretLookupByUUIDString:
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the secret
 *
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the printable string value to describe the UUID
 *
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
 */
virSecretPtr
virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9754
        virDispatchError(NULL);
9755 9756 9757 9758 9759 9760
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
9761 9762

    if (virUUIDParse(uuidstr, uuid) < 0) {
9763 9764 9765 9766 9767 9768 9769
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
9770
    virDispatchError(conn);
9771 9772 9773 9774
    return NULL;
}


9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798
/**
 * virSecretLookupByUsage:
 * @conn: pointer to the hypervisor connection
 * @usageType: the type of secret usage
 * @usageID: identifier of the object using the secret
 *
 * Try to lookup a secret on the given hypervisor based on its usage
 * The usageID is unique within the set of secrets sharing the
 * same usageType value.
 *
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
 */
virSecretPtr
virSecretLookupByUsage(virConnectPtr conn,
                       int usageType,
                       const char *usageID)
{
    DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9799
        virDispatchError(NULL);
9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818
        return (NULL);
    }
    if (usageID == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9819
    virDispatchError(conn);
9820 9821 9822 9823
    return NULL;
}


9824 9825 9826 9827 9828 9829
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
9830
 * If XML specifies a UUID, locates the specified secret and replaces all
9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847
 * attributes of the secret specified by UUID by attributes specified in xml
 * (any attributes not specified in xml are discarded).
 *
 * Otherwise, creates a new secret with an automatically chosen UUID, and
 * initializes its attributes from xml.
 *
 * Returns a the secret on success, NULL on failure.
 */
virSecretPtr
virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
    VIR_DEBUG("conn=%p, xml=%s, flags=%u", conn, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9848
        virDispatchError(NULL);
9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871
        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->secretDriver != NULL && conn->secretDriver->defineXML != NULL) {
        virSecretPtr ret;

        ret = conn->secretDriver->defineXML(conn, xml, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9872
    virDispatchError(conn);
9873 9874 9875 9876
    return NULL;
}

/**
9877
 * virSecretGetUUID:
9878
 * @secret: A virSecret secret
9879
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
9880 9881 9882
 *
 * Fetches the UUID of the secret.
 *
9883 9884
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
9885
 */
9886 9887
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
9888 9889 9890 9891 9892 9893 9894
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
9895
        virDispatchError(NULL);
9896 9897 9898 9899
        return -1;
    }
    if (uuid == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
9900
        virDispatchError(secret->conn);
9901
        return -1;
9902 9903
    }

9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925
    memcpy(uuid, &secret->uuid[0], VIR_UUID_BUFLEN);

    return 0;
}

/**
 * virSecretGetUUIDString:
 * @secret: a secret object
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
 *
 * Get the UUID for a secret as string. For more information about
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virSecretGetUUIDString(virSecretPtr secret, char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("secret=%p, buf=%p", secret, buf);

    virResetLastError();
9926

9927 9928
    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
9929
        virDispatchError(NULL);
9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943
        return (-1);
    }
    if (buf == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

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

error:
9944
    virDispatchError(secret->conn);
9945
    return -1;
9946 9947
}

9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969
/**
 * virSecretGetUsageType:
 * @secret: a secret object
 *
 * Get the type of object which uses this secret. The returned
 * value is one of the constants defined in the virSecretUsageType
 * enumeration. More values may be added to this enumeration in
 * the future, so callers should expect to see usage types they
 * do not explicitly know about.
 *
 * Returns a positive integer identifying the type of object,
 * or -1 upon error.
 */
int
virSecretGetUsageType(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
9970
        virDispatchError(NULL);
9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000
        return (-1);
    }
    return (secret->usageType);
}

/**
 * virSecretGetUsageID:
 * @secret: a secret object
 *
 * Get the unique identifier of the object with which this
 * secret is to be used. The format of the identifier is
 * dependant on the usage type of the secret. For a secret
 * with a usage type of VIR_SECRET_USAGE_TYPE_VOLUME the
 * identifier will be a fully qualfied path name. The
 * identifiers are intended to be unique within the set of
 * all secrets sharing the same usage type. ie, there shall
 * only ever be one secret for each volume path.
 *
 * Returns a string identifying the object using the secret,
 * or NULL upon error
 */
const char *
virSecretGetUsageID(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10001
        virDispatchError(NULL);
10002 10003 10004 10005 10006
        return (NULL);
    }
    return (secret->usageID);
}

10007

10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028
/**
 * virSecretGetXMLDesc:
 * @secret: A virSecret secret
 * @flags: flags, use 0 for now
 *
 * Fetches an XML document describing attributes of the secret.
 *
 * Returns the XML document on success, NULL on failure.  The caller must
 * free() the XML.
 */
char *
virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, flags=%u", secret, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10029
        virDispatchError(NULL);
10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045
        return NULL;
    }

    conn = secret->conn;
    if (conn->secretDriver != NULL && conn->secretDriver->getXMLDesc != NULL) {
        char *ret;

        ret = conn->secretDriver->getXMLDesc(secret, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10046
    virDispatchError(conn);
10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073
    return NULL;
}

/**
 * virSecretSetValue:
 * @secret: A virSecret secret
 * @value: Value of the secret
 * @value_size: Size of the value
 * @flags: flags, use 0 for now
 *
 * Sets the value of a secret.
 *
 * Returns 0 on success, -1 on failure.
 */
int
virSecretSetValue(virSecretPtr secret, const unsigned char *value,
                  size_t value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%u", secret, value,
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10074
        virDispatchError(NULL);
10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (value == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->setValue != NULL) {
        int ret;

        ret = conn->secretDriver->setValue(secret, value, value_size, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10099
    virDispatchError(conn);
10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124
    return -1;
}

/**
 * virSecretGetValue:
 * @secret: A virSecret connection
 * @value_size: Place for storing size of the secret value
 * @flags: flags, use 0 for now
 *
 * Fetches the value of a secret.
 *
 * Returns the secret value on success, NULL on failure.  The caller must
 * free() the secret value.
 */
unsigned char *
virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value_size=%p, flags=%u", secret, value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10125
        virDispatchError(NULL);
10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (value_size == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

10138 10139
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151
    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

        ret = conn->secretDriver->getValue(secret, value_size, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10152
    virDispatchError(conn);
10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175
    return NULL;
}

/**
 * virSecretUndefine:
 * @secret: A virSecret secret
 *
 * Deletes the specified secret.  This does not free the associated
 * virSecretPtr object.
 *
 * Returns 0 on success, -1 on failure.
 */
int
virSecretUndefine(virSecretPtr secret)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10176
        virDispatchError(NULL);
10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10197
    virDispatchError(conn);
10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221
    return -1;
}

/**
 * virSecretRef:
 * @secret: the secret to hold a reference on
 *
 * Increment the reference count on the secret. For each additional call to
 * this method, there shall be a corresponding call to virSecretFree 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 secret would
 * increment the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virSecretRef(virSecretPtr secret)
{
    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10222
        virDispatchError(NULL);
10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237
        return -1;
    }
    virMutexLock(&secret->conn->lock);
    DEBUG("secret=%p refs=%d", secret, secret->refs);
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
10238
 * Returns 0 on success, or -1 on error
10239 10240 10241 10242 10243 10244 10245 10246 10247 10248
 */
int
virSecretFree(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10249
        virDispatchError(NULL);
10250 10251
        return -1;
    }
10252 10253
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
10254
        return -1;
10255
    }
10256 10257
    return 0;
}
10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290


/**
 * virStreamNew:
 * @conn: pointer to the connection
 * @flags: control features of the stream
 *
 * Creates a new stream object which can be used to perform
 * streamed I/O with other public API function.
 *
 * When no longer needed, a stream object must be released
 * with virStreamFree. If a data stream has been used,
 * then the application must call virStreamFinish or
 * virStreamAbort before free'ing to, in order to notify
 * the driver of termination.
 *
 * If a non-blocking data stream is required passed
 * VIR_STREAM_NONBLOCK for flags, otherwise pass 0.
 *
 * Returns the new stream, or NULL upon error
 */
virStreamPtr
virStreamNew(virConnectPtr conn,
             unsigned int flags)
{
    virStreamPtr st;

    DEBUG("conn=%p, flags=%u", conn, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10291
        virDispatchError(NULL);
10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318
        return (NULL);
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;

    return st;
}


/**
 * virStreamRef:
 * @stream: pointer to the stream
 *
 * Increment the reference count on the stream. For each
 * additional call to this method, there shall be a corresponding
 * call to virStreamFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * Returns 0 in case of success, -1 in case of failure
 */
int
virStreamRef(virStreamPtr stream)
{
    if ((!VIR_IS_CONNECTED_STREAM(stream))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
10319
        virDispatchError(NULL);
10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338
        return(-1);
    }
    virMutexLock(&stream->conn->lock);
    DEBUG("stream=%p refs=%d", stream, stream->refs);
    stream->refs++;
    virMutexUnlock(&stream->conn->lock);
    return 0;
}


/**
 * virStreamSend:
 * @stream: pointer to the stream object
 * @data: buffer to write to stream
 * @nbytes: size of @data buffer
 *
 * Write a series of bytes to the stream. This method may
 * block the calling application for an arbitrary amount
 * of time. Once an application has finished sending data
10339
 * it should call virStreamFinish to wait for successful
10340 10341 10342 10343 10344 10345 10346 10347 10348
 * confirmation from the driver, or detect any error
 *
 * This method may not be used if a stream source has been
 * registered
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
10349
 * An example using this with a hypothetical file upload
10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403
 * API looks like
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_RDONLY)
 *
 *   virConnectUploadFile(conn, "demo.iso", st);
 *
 *   while (1) {
 *       char buf[1024];
 *       int got = read(fd, buf, 1024);
 *       if (got < 0) {
 *          virStreamAbort(st);
 *          break;
 *       }
 *       if (got == 0) {
 *          virStreamFinish(st);
 *          break;
 *       }
 *       int offset = 0;
 *       while (offset < got) {
 *          int sent = virStreamSend(st, buf+offset, got-offset)
 *          if (sent < 0) {
 *             virStreamAbort(st);
 *             goto done;
 *          }
 *          offset += sent;
 *       }
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ... report an error ....
 * done:
 *   virStreamFree(st);
 *   close(fd);
 *
 * Returns the number of bytes written, which may be less
 * than requested.
 *
 * Returns -1 upon error, at which time the stream will
 * be marked as aborted, and the caller should now release
 * the stream with virStreamFree.
 *
 * Returns -2 if the outgoing transmit buffers are full &
 * the stream is marked as non-blocking.
 */
int virStreamSend(virStreamPtr stream,
                  const char *data,
                  size_t nbytes)
{
    DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10404
        virDispatchError(NULL);
10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamSend) {
        int ret;
        ret = (stream->driver->streamSend)(stream, data, nbytes);
        if (ret == -2)
            return -2;
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10422
    virDispatchError(stream->conn);
10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
 * @data: buffer to write to stream
 * @nbytes: size of @data buffer
 *
 * Write a series of bytes to the stream. This method may
 * block the calling application for an arbitrary amount
 * of time.
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
10441
 * An example using this with a hypothetical file download
10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498
 * API looks like
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_WRONLY, 0600)
 *
 *   virConnectDownloadFile(conn, "demo.iso", st);
 *
 *   while (1) {
 *       char buf[1024];
 *       int got = virStreamRecv(st, buf, 1024);
 *       if (got < 0)
 *          break;
 *       if (got == 0) {
 *          virStreamFinish(st);
 *          break;
 *       }
 *       int offset = 0;
 *       while (offset < got) {
 *          int sent = write(fd, buf+offset, got-offset)
 *          if (sent < 0) {
 *             virStreamAbort(st);
 *             goto done;
 *          }
 *          offset += sent;
 *       }
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ... report an error ....
 * done:
 *   virStreamFree(st);
 *   close(fd);
 *
 *
 * Returns the number of bytes read, which may be less
 * than requested.
 *
 * Returns 0 when the end of the stream is reached, at
 * which time the caller should invoke virStreamFinish()
 * to get confirmation of stream completion.
 *
 * Returns -1 upon error, at which time the stream will
 * be marked as aborted, and the caller should now release
 * the stream with virStreamFree.
 *
 * Returns -2 if there is no data pending to be read & the
 * stream is marked as non-blocking.
 */
int virStreamRecv(virStreamPtr stream,
                  char *data,
                  size_t nbytes)
{
    DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10499
        virDispatchError(NULL);
10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamRecv) {
        int ret;
        ret = (stream->driver->streamRecv)(stream, data, nbytes);
        if (ret == -2)
            return -2;
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10517
    virDispatchError(stream->conn);
10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531
    return -1;
}


/**
 * virStreamSendAll:
 * @stream: pointer to the stream object
 * @handler: source callback for reading data from application
 * @opaque: application defined data
 *
 * Send the entire data stream, reading the data from the
 * requested data source. This is simply a convenient alternative
 * to virStreamSend, for apps that do blocking-I/o.
 *
D
Dan Kenigsberg 已提交
10532
 * An example using this with a hypothetical file upload
10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553
 * API looks like
 *
 *   int mysource(virStreamPtr st, char *buf, int nbytes, void *opaque) {
 *       int *fd = opaque;
 *
 *       return read(*fd, buf, nbytes);
 *   }
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_RDONLY)
 *
 *   virConnectUploadFile(conn, st);
 *   if (virStreamSendAll(st, mysource, &fd) < 0) {
 *      ...report an error ...
 *      goto done;
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ...report an error...
 *   virStreamFree(st);
 *   close(fd);
 *
10554
 * Returns 0 if all the data was successfully sent. The caller
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574
 * should invoke virStreamFinish(st) to flush the stream upon
 * success and then virStreamFree
 *
 * Returns -1 upon any error, with virStreamAbort() already
 * having been called,  so the caller need only call
 * virStreamFree()
 */
int virStreamSendAll(virStreamPtr stream,
                     virStreamSourceFunc handler,
                     void *opaque)
{
    char *bytes = NULL;
    int want = 1024*64;
    int ret = -1;
    DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10575
        virDispatchError(NULL);
10576 10577 10578 10579 10580 10581 10582 10583 10584 10585
        return (-1);
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
        virLibConnError(NULL, VIR_ERR_OPERATION_INVALID,
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
10586
        virReportOOMError();
10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612
        goto cleanup;
    }

    for (;;) {
        int got, offset = 0;
        got = (handler)(stream, bytes, want, opaque);
        if (got < 0) {
            virStreamAbort(stream);
            goto cleanup;
        }
        if (got == 0)
            break;
        while (offset < got) {
            int done;
            done = virStreamSend(stream, bytes + offset, got - offset);
            if (done < 0)
                goto cleanup;
            offset += done;
        }
    }
    ret = 0;

cleanup:
    VIR_FREE(bytes);

    if (ret != 0)
10613
        virDispatchError(stream->conn);
10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628

    return ret;
}


/**
 * virStreamRecvAll:
 * @stream: pointer to the stream object
 * @handler: sink callback for writing data to application
 * @opaque: application defined data
 *
 * Receive the entire data stream, sending the data to the
 * requested data sink. This is simply a convenient alternative
 * to virStreamRecv, for apps that do blocking-I/o.
 *
D
Dan Kenigsberg 已提交
10629
 * An example using this with a hypothetical file download
10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650
 * API looks like
 *
 *   int mysink(virStreamPtr st, const char *buf, int nbytes, void *opaque) {
 *       int *fd = opaque;
 *
 *       return write(*fd, buf, nbytes);
 *   }
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_WRONLY)
 *
 *   virConnectUploadFile(conn, st);
 *   if (virStreamRecvAll(st, mysink, &fd) < 0) {
 *      ...report an error ...
 *      goto done;
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ...report an error...
 *   virStreamFree(st);
 *   close(fd);
 *
10651
 * Returns 0 if all the data was successfully received. The caller
10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671
 * should invoke virStreamFinish(st) to flush the stream upon
 * success and then virStreamFree
 *
 * Returns -1 upon any error, with virStreamAbort() already
 * having been called,  so the caller need only call
 * virStreamFree()
 */
int virStreamRecvAll(virStreamPtr stream,
                     virStreamSinkFunc handler,
                     void *opaque)
{
    char *bytes = NULL;
    int want = 1024*64;
    int ret = -1;
    DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10672
        virDispatchError(NULL);
10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683
        return (-1);
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
        virLibConnError(NULL, VIR_ERR_OPERATION_INVALID,
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
10684
        virReportOOMError();
10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710
        goto cleanup;
    }

    for (;;) {
        int got, offset = 0;
        got = virStreamRecv(stream, bytes, want);
        if (got < 0)
            goto cleanup;
        if (got == 0)
            break;
        while (offset < got) {
            int done;
            done = (handler)(stream, bytes + offset, got - offset, opaque);
            if (done < 0) {
                virStreamAbort(stream);
                goto cleanup;
            }
            offset += done;
        }
    }
    ret = 0;

cleanup:
    VIR_FREE(bytes);

    if (ret != 0)
10711
        virDispatchError(stream->conn);
10712 10713 10714 10715 10716 10717

    return ret;
}


/**
M
Matthias Bolte 已提交
10718
 * virStreamEventAddCallback:
10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743
 * @stream: pointer to the stream object
 * @events: set of events to monitor
 * @cb: callback to invoke when an event occurs
 * @opaque: application defined data
 * @ff: callback to free @opaque data
 *
 * Register a callback to be notified when a stream
 * becomes writable, or readable. This is most commonly
 * used in conjunction with non-blocking data streams
 * to integrate into an event loop
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamEventAddCallback(virStreamPtr stream,
                              int events,
                              virStreamEventCallback cb,
                              void *opaque,
                              virFreeCallback ff)
{
    DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10744
        virDispatchError(NULL);
10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10760
    virDispatchError(stream->conn);
10761 10762 10763 10764 10765
    return -1;
}


/**
M
Matthias Bolte 已提交
10766
 * virStreamEventUpdateCallback:
10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785
 * @stream: pointer to the stream object
 * @events: set of events to monitor
 *
 * Changes the set of events to monitor for a stream. This allows
 * for event notification to be changed without having to
 * unregister & register the callback completely. This method
 * is guarenteed to succeed if a callback is already registered
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
    DEBUG("stream=%p, events=%d", stream, events);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10786
        virDispatchError(NULL);
10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10802
    virDispatchError(stream->conn);
10803 10804 10805 10806
    return -1;
}

/**
M
Matthias Bolte 已提交
10807
 * virStreamEventRemoveCallback:
10808 10809
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
10810
 * Remove an event callback from the stream
10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10822
        virDispatchError(NULL);
10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10838
    virDispatchError(stream->conn);
10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864
    return -1;
}

/**
 * virStreamFinish:
 * @stream: pointer to the stream object
 *
 * Indicate that there is no further data is to be transmitted
 * on the stream. For output streams this should be called once
 * all data has been written. For input streams this should be
 * called once virStreamRecv returns end-of-file.
 *
 * This method is a synchronization point for all asynchronous
 * errors, so if this returns a success code the application can
 * be sure that all data has been successfully processed.
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamFinish(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10865
        virDispatchError(NULL);
10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10881
    virDispatchError(stream->conn);
10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905
    return -1;
}

/**
 * virStreamAbort:
 * @stream: pointer to the stream object
 *
 * Request that the in progress data transfer be cancelled
 * abnormally before the end of the stream has been reached.
 * For output streams this can be used to inform the driver
 * that the stream is being terminated early. For input
 * streams this can be used to inform the driver that it
 * should stop sending data.
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamAbort(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10906
        virDispatchError(NULL);
10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamAbort) {
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

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

error:
10922
    virDispatchError(stream->conn);
10923 10924 10925 10926 10927 10928 10929 10930 10931 10932
    return -1;
}

/**
 * virStreamFree:
 * @stream: pointer to the stream object
 *
 * Decrement the reference count on a stream, releasing
 * the stream object if the reference count has hit zero.
 *
D
Dan Kenigsberg 已提交
10933
 * There must not be an active data transfer in progress
10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947
 * when releasing the stream. If a stream needs to be
 * disposed of prior to end of stream being reached, then
 * the virStreamAbort function should be called first.
 *
 * Returns 0 upon success, or -1 on error
 */
int virStreamFree(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10948
        virDispatchError(NULL);
10949 10950 10951 10952 10953
        return (-1);
    }

    /* XXX Enforce shutdown before free'ing resources ? */

10954 10955
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
10956
        return (-1);
10957
    }
10958 10959
    return (0);
}
10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977


/**
 * virDomainIsActive:
 * @dom: pointer to the domain object
 *
 * Determine if the domain is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virDomainIsActive(virDomainPtr dom)
{
    DEBUG("dom=%p", dom);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10978
        virDispatchError(NULL);
10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990
        return (-1);
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
10991
    virDispatchError(dom->conn);
10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011
    return -1;
}

/**
 * virDomainIsPersistent:
 * @dom: pointer to the domain object
 *
 * Determine if the domain has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virDomainIsPersistent(virDomainPtr dom)
{
    DEBUG("dom=%p", dom);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11012
        virDispatchError(NULL);
11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024
        return (-1);
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11025
    virDispatchError(dom->conn);
11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044
    return -1;
}

/**
 * virNetworkIsActive:
 * @net: pointer to the network object
 *
 * Determine if the network is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virNetworkIsActive(virNetworkPtr net)
{
    DEBUG("net=%p", net);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11045
        virDispatchError(NULL);
11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057
        return (-1);
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(net->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11058
    virDispatchError(net->conn);
11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079
    return -1;
}


/**
 * virNetworkIsPersistent:
 * @net: pointer to the network object
 *
 * Determine if the network has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virNetworkIsPersistent(virNetworkPtr net)
{
    DEBUG("net=%p", net);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11080
        virDispatchError(NULL);
11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092
        return (-1);
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(net->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11093
    virDispatchError(net->conn);
11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113
    return -1;
}


/**
 * virStoragePoolIsActive:
 * @pool: pointer to the storage pool object
 *
 * Determine if the storage pool is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virStoragePoolIsActive(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11114
        virDispatchError(NULL);
11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126
        return (-1);
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11127
    virDispatchError(pool->conn);
11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148
    return -1;
}


/**
 * virStoragePoolIsPersistent:
 * @pool: pointer to the storage pool object
 *
 * Determine if the storage pool has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virStoragePoolIsPersistent(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11149
        virDispatchError(NULL);
11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161
        return (-1);
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11162
    virDispatchError(pool->conn);
11163 11164 11165 11166
    return -1;
}


S
Stefan Berger 已提交
11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672

/**
 * virConnectNumOfNWFilters:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of nwfilters.
 *
 * Returns the number of nwfilters found or -1 in case of error
 */
int
virConnectNumOfNWFilters(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

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

    if (conn->nwfilterDriver && conn->nwfilterDriver->numOfNWFilters) {
        int ret;
        ret = conn->nwfilterDriver->numOfNWFilters (conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}


/**
 * virConnectListNWFilters:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of network filters
 * @maxnames: size of @names
 *
 * Collect the list of network filters, and store their names in @names
 *
 * Returns the number of network filters found or -1 in case of error
 */
int
virConnectListNWFilters(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__);
        virDispatchError(NULL);
        return -1;
    }

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

    if (conn->nwfilterDriver && conn->nwfilterDriver->listNWFilters) {
        int ret;
        ret = conn->nwfilterDriver->listNWFilters (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}


/**
 * virNWFilterLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the network filter
 *
 * Try to lookup a network filter on the given hypervisor based on its name.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * network filter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByName(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__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virNWFilterLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the network filter
 *
 * Try to lookup a network filter on the given hypervisor based on its UUID.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * nwfdilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
    DEBUG("conn=%p, uuid=%s", conn, uuid);

    virResetLastError();

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

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virNWFIlterLookupByUUIDString:
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the nwfilter
 *
 * Try to lookup an nwfilter on the given hypervisor based on its UUID.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * nwfilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

    virResetLastError();

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

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

    return virNWFilterLookupByUUID(conn, &uuid[0]);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virNWFilterFree:
 * @nwfilter: a nwfilter object
 *
 * Free the nwfilter 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
virNWFilterFree(virNWFilterPtr nwfilter)
{
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefNWFilter(nwfilter) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}

/**
 * virNWFilterGetName:
 * @nwfilter: a nwfilter object
 *
 * Get the public name for the network filter
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the nwfilter object.
 */
const char *
virNWFilterGetName(virNWFilterPtr nwfilter)
{
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    return (nwfilter->name);
}

/**
 * virNWFilterGetUUID:
 * @nwfilter: a nwfilter object
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
 *
 * Get the UUID for a network filter
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid)
{
    DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

    return 0;

error:
    virDispatchError(nwfilter->conn);
    return -1;
}

/**
 * virNWFilterGetUUIDString:
 * @nwfilter: a nwfilter object
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
 *
 * Get the UUID for a network filter as string. For more information about
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (virNWFilterGetUUID(nwfilter, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
    return 0;

error:
    virDispatchError(nwfilter->conn);
    return -1;
}


/**
 * virNWFilterDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: an XML description of the nwfilter
 *
 * Define a new network filter, based on an XML description
 * similar to the one returned by virNWFilterGetXMLDesc()
 *
 * Returns a new nwfilter object or NULL in case of failure
 */
virNWFilterPtr
virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
{
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc, 0);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}


/**
 * virNWFilterUndefine:
 * @nwfilter: a nwfilter object
 *
 * Undefine the nwfilter object. This call will not succeed if
 * a running VM is referencing the filter. This does not free the
 * associated virNWFilterPtr object.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNWFilterUndefine(virNWFilterPtr nwfilter)
{
    virConnectPtr conn;
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNWFilterError(nwfilter, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(nwfilter->conn);
    return -1;
}


/**
 * virNWFilterGetXMLDesc:
 * @nwfilter: a nwfilter object
 * @flags: an OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the network filter. The description may be
 * reused later to redefine the network filter with virNWFilterCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, int flags)
{
    virConnectPtr conn;
    DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (flags != 0) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(nwfilter->conn);
    return NULL;
}


/**
 * virNWFilterRef:
 * @nwfilter: the nwfilter to hold a reference on
 *
 * Increment the reference count on the nwfilter. For each
 * additional call to this method, there shall be a corresponding
 * call to virNWFilterFree 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 an nwfilter would increment
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virNWFilterRef(virNWFilterPtr nwfilter)
{
    if ((!VIR_IS_CONNECTED_NWFILTER(nwfilter))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
    DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688
/**
 * virInterfaceIsActive:
 * @iface: pointer to the interface object
 *
 * Determine if the interface is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virInterfaceIsActive(virInterfacePtr iface)
{
    DEBUG("iface=%p", iface);

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11689
        virDispatchError(NULL);
11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701
        return (-1);
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(iface->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11702
    virDispatchError(iface->conn);
11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722
    return -1;
}


/**
 * virConnectIsEncrypted:
 * @conn: pointer to the connection object
 *
 * Determine if the connection to the hypervisor is encrypted
 *
 * Returns 1 if encrypted, 0 if not encrypted, -1 on error
 */
int virConnectIsEncrypted(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11723
        virDispatchError(NULL);
11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735
        return (-1);
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11736
    virDispatchError(conn);
11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759
    return -1;
}

/**
 * virConnectIsSecure:
 * @conn: pointer to the connection object
 *
 * Determine if the connection to the hypervisor is secure
 *
 * A connection will be classed as secure if it is either
 * encrypted, or running over a channel which is not exposed
 * to eavesdropping (eg a UNIX domain socket, or pipe)
 *
 * Returns 1 if secure, 0 if secure, -1 on error
 */
int virConnectIsSecure(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11760
        virDispatchError(NULL);
11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772
        return (-1);
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11773
    virDispatchError(conn);
11774 11775
    return -1;
}
J
Jiri Denemark 已提交
11776 11777 11778 11779 11780


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
11781 11782 11783 11784
 * @xmlDesc: XML describing the CPU to compare with host CPU
 * @flags: currently unused, pass 0
 *
 * Compares the given CPU description with the host CPU
J
Jiri Denemark 已提交
11785 11786 11787 11788 11789 11790 11791 11792
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
11793
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
11794 11795 11796 11797 11798

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11799
        virDispatchError(NULL);
J
Jiri Denemark 已提交
11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->cpuCompare) {
        int ret;

        ret = conn->driver->cpuCompare(conn, xmlDesc, flags);
        if (ret == VIR_CPU_COMPARE_ERROR)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11819
    virDispatchError(conn);
J
Jiri Denemark 已提交
11820 11821
    return VIR_CPU_COMPARE_ERROR;
}
11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878


/**
 * virConnectBaselineCPU:
 *
 * @conn: virConnect connection
 * @xmlCPUs: array of XML descriptions of host CPUs
 * @ncpus: number of CPUs in xmlCPUs
 * @flags: fine-tuning flags, currently unused, pass 0.
 *
 * Computes the most feature-rich CPU which is compatible with all given
 * host CPUs.
 *
 * Returns XML description of the computed CPU or NULL on error.
 */
char *
virConnectBaselineCPU(virConnectPtr conn,
                      const char **xmlCPUs,
                      unsigned int ncpus,
                      unsigned int flags)
{
    unsigned int i;

    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%u",
              conn, xmlCPUs, ncpus, flags);
    if (xmlCPUs) {
        for (i = 0; i < ncpus; i++)
            VIR_DEBUG("xmlCPUs[%u]=%s", i, NULLSTR(xmlCPUs[i]));
    }

    virResetLastError();

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

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}
11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926


/**
 * virDomainGetJobInfo:
 * @domain: a domain object
 * @info: pointer to a virDomainJobInfo structure allocated by the user
 *
 * Extract information about progress of a background job on a domain.
 * Will return an error if the domain is not active.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("domain=%p, info=%p", domain, info);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

    conn = domain->conn;

    if (conn->driver->domainGetJobInfo) {
        int ret;
        ret = conn->driver->domainGetJobInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}
11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973


/**
 * virDomainAbortJob:
 * @domain: a domain object
 *
 * Requests that the current background job be aborted at the
 * soonest opportunity. This will block until the job has
 * either completed, or aborted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainAbortJob(virDomainPtr domain)
{
    virConnectPtr conn;

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

    virResetLastError();

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

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}
11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017


/**
 * virDomainMigrateSetMaxDowntime:
 * @domain: a domain object
 * @downtime: maximum tolerable downtime for live migration, in milliseconds
 * @flags: fine-tuning flags, currently unused, use 0
 *
 * Sets maximum tolerable time for which the domain is allowed to be paused
 * at the end of live migration. It's supposed to be called while the domain is
 * being live-migrated as a reaction to migration progress.
 *
 * Returns 0 in case of success, -1 otherwise.
 */
int
virDomainMigrateSetMaxDowntime(virDomainPtr domain,
                               unsigned long long downtime,
                               unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("domain=%p, downtime=%llu, flags=%u", domain, downtime, flags);

    virResetLastError();

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

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virConnectDomainEventRegisterAny:
 * @conn: pointer to the connection
 * @dom: pointer to the domain
 * @eventID: the event type to receive
 * @cb: callback to the function handling domain events
 * @opaque: opaque data to pass on to the callback
 * @freecb: optional function to deallocate opaque when not used anymore
 *
 * Adds a callback to receive notifications of arbitrary domain events
 * occurring on a domain.
 *
 * If dom is NULL, then events will be monitored for any domain. If dom
 * is non-NULL, then only the specific domain will be monitored
 *
 * Most types of event have a callback providing a custom set of parameters
 * for the event. When registering an event, it is thus neccessary to use
 * the VIR_DOMAIN_EVENT_CALLBACK() macro to cast the supplied function pointer
 * to match the signature of this method.
 *
 * 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.
 *
 * The return value from this method is a positive integer identifier
 * for the callback. To unregister a callback, this callback ID should
 * be passed to the virDomainEventUnregisterAny method
 *
 * Returns a callback identifier on success, -1 on failure
 */
int
virConnectDomainEventRegisterAny(virConnectPtr conn,
                                 virDomainPtr dom,
                                 int eventID,
                                 virConnectDomainEventGenericCallback cb,
                                 void *opaque,
                                 virFreeCallback freecb)
{
    DEBUG("conn=%p dom=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p", conn, dom, eventID, cb, opaque, freecb);
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(conn);
        return (-1);
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if ((conn->driver) && (conn->driver->domainEventRegisterAny)) {
        int ret;
        ret = conn->driver->domainEventRegisterAny(conn, dom, eventID, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}
12096

12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132
/**
 * virConnectDomainEventDeregisterAny:
 * @conn: pointer to the connection
 * @callbackID: the callback identifier
 *
 * Removes an event callback. The callbackID parameter should be the
 * vaule obtained from a previous virDomainEventRegisterAny method.
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregisterAny(virConnectPtr conn,
                                   int callbackID)
{
    DEBUG("conn=%p, callbackID=%d", conn, callbackID);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (callbackID < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
12133 12134 12135 12136
error:
    virDispatchError(conn);
    return -1;
}