libvirt.c 229.9 KB
Newer Older
D
Daniel Veillard 已提交
1
/*
2
 * libvirt.c: Main interfaces for the libvirt library to handle virtualization
D
Daniel Veillard 已提交
3 4
 *           domains from a process running in domain 0
 *
5
 * Copyright (C) 2005,2006,2008,2009 Red Hat, Inc.
D
Daniel Veillard 已提交
6 7 8 9 10 11
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
 */

12
#include <config.h>
D
Daniel Veillard 已提交
13

14
#include <stdio.h>
15
#include <stdlib.h>
16
#include <string.h>
17 18 19
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
20
#include <assert.h>
21 22 23
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
24
#include <time.h>
25

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

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

35
#include "virterror_internal.h"
36
#include "logging.h"
37 38
#include "datatypes.h"
#include "libvirt_internal.h"
39
#include "driver.h"
40

41
#include "uuid.h"
42
#include "util.h"
43
#include "memory.h"
44

45
#ifndef WITH_DRIVER_MODULES
46
#ifdef WITH_TEST
47
#include "test.h"
48 49
#endif
#ifdef WITH_XEN
50
#include "xen_unified.h"
51 52
#endif
#ifdef WITH_REMOTE
53
#include "remote_internal.h"
54
#endif
55 56 57
#ifdef WITH_OPENVZ
#include "openvz_driver.h"
#endif
58 59 60
#ifdef WITH_PHYP
#include "phyp/phyp_driver.h"
#endif
61 62 63
#ifdef WITH_VBOX
#include "vbox/vbox_driver.h"
#endif
64 65 66
#ifdef WITH_ESX
#include "esx/esx_driver.h"
#endif
67
#endif
68

69 70
#define VIR_FROM_THIS VIR_FROM_NONE

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

77 78
#define MAX_DRIVERS 10

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

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

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

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

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

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

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

    return 0;
}
#endif

128 129 130 131 132 133 134 135
static int virConnectAuthCallbackDefault(virConnectCredentialPtr cred,
                                         unsigned int ncred,
                                         void *cbdata ATTRIBUTE_UNUSED) {
    int i;

    for (i = 0 ; i < ncred ; i++) {
        char buf[1024];
        char *bufptr = buf;
136
        size_t len;
137 138

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

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

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

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

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

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

        default:
            return -1;
191 192
        }

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

    return 0;
}

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

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

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

239 240 241 242 243 244 245 246 247 248
#if HAVE_WINSOCK2_H
static int
winsock_init (void)
{
    WORD winsock_version, err;
    WSADATA winsock_data;

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

253 254 255 256 257 258 259 260 261 262 263 264 265 266
/**
 * 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);
267

268
    initialized = 1;
269

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

275
    virLogSetFromEnv();
276 277 278

    DEBUG0("register drivers");

279 280 281 282
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

283 284 285
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

286
    /*
287 288
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
289
     */
290 291 292 293 294 295 296 297 298
#ifdef WITH_DRIVER_MODULES
    /* We don't care if any of these fail, because the whole point
     * is to allow users to only install modules they want to use.
     * If they try to use a open a connection for a module that
     * is not loaded they'll get a suitable error at that point
     */
    virDriverLoadModule("test");
    virDriverLoadModule("xen");
    virDriverLoadModule("openvz");
299
    virDriverLoadModule("vbox");
300
    virDriverLoadModule("esx");
301 302
    virDriverLoadModule("remote");
#else
303
#ifdef WITH_TEST
304
    if (testRegister() == -1) return -1;
305
#endif
306
#ifdef WITH_XEN
307
    if (xenRegister () == -1) return -1;
308
#endif
309 310
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
D
Daniel Veillard 已提交
311
#endif
312 313 314
#ifdef WITH_PHYP
    if (phypRegister() == -1) return -1;
#endif
315 316 317
#ifdef WITH_VBOX
    if (vboxRegister() == -1) return -1;
#endif
318 319 320
#ifdef WITH_ESX
    if (esxRegister() == -1) return -1;
#endif
321 322
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
323
#endif
324
#endif
D
Daniel P. Berrange 已提交
325

326 327 328
    return(0);
}

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


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

D
Daniel Veillard 已提交
377 378 379
    if (error == VIR_ERR_OK)
        return;

380 381 382
    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 已提交
383 384 385
}

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

401 402 403
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
404 405 406 407 408 409
}

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

D
Daniel Veillard 已提交
421 422 423
    if (error == VIR_ERR_OK)
        return;

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

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

    if (error == VIR_ERR_OK)
        return;

450
    errmsg = virErrorMsg(error, info);
451 452 453
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
454 455
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
456 457
}

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

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

502
    errmsg = virErrorMsg(error, info);
503 504 505
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

506 507
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
508 509 510 511 512
}

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

528
    errmsg = virErrorMsg(error, info);
529 530 531
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

532 533
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
534 535
}

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

562 563 564 565 566 567 568 569 570 571 572
/**
 * 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)
{
573 574 575 576 577
    if (virInitialize() < 0)
      return -1;

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

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

586 587 588
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

589 590
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
591 592
}

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

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

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

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

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

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

648 649 650
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

651 652 653 654
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

679 680 681
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

682 683 684 685
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

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

710
    if (driver->no < 0) {
711
        virLibConnError
712 713 714 715 716
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

717 718 719
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

720 721
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
722 723
}

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

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

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

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
768
        if (virStateDriverTab[i]->initialize &&
769
            virStateDriverTab[i]->initialize(privileged) < 0)
770 771 772 773 774
            ret = -1;
    }
    return ret;
}

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
829
#endif
830

831 832


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

854
    if (!initialized)
855
        if (virInitialize() < 0)
856
            return -1;
857

858
    if (libVer == NULL)
859
        return (-1);
860 861 862
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
863
        if (type == NULL)
864
            type = "Xen";
865 866 867 868 869

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

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

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

933 934
    virResetLastError();

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

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

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

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

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

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

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

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

D
Daniel Veillard 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
    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;
        }
    }
1051 1052 1053

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

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

1099
    return ret;
1100 1101

failed:
1102 1103
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1104 1105 1106

    virUnrefConnect(ret);

1107
    return NULL;
1108 1109
}

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

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

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

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

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

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

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

1215 1216 1217 1218
    virResetLastError();

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

1222
    return virUnrefConnect(conn);
D
Daniel Veillard 已提交
1223 1224
}

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
/**
 * 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 已提交
1239 1240
 *
 * Returns 0 in case of success, -1 in case of failure
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&conn->lock);
    DEBUG("conn=%p refs=%d", conn, conn->refs);
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1256 1257
/*
 * Not for public use.  This function is part of the internal
1258 1259 1260
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1261
virDrvSupportsFeature (virConnectPtr conn, int feature)
1262
{
1263
    int ret;
1264 1265
    DEBUG("conn=%p, feature=%d", conn, feature);

1266 1267 1268 1269
    virResetLastError();

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

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

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

1296 1297
    virResetLastError();

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

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

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

1328 1329
    virResetLastError();

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

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

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

1347
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1348 1349 1350 1351

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

1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
 * running (the result of the gethostname(2) system call).  If
 * we are connected to a remote system, then this returns the
 * hostname of the remote system.
 *
 * Returns the hostname which must be freed by the caller, or
 * NULL if there was an error.
 */
char *
virConnectGetHostname (virConnectPtr conn)
{
1370 1371
    DEBUG("conn=%p", conn);

1372 1373
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1387 1388 1389 1390

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

1415 1416
    virResetLastError();

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

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

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

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

1452 1453
    virResetLastError();

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

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

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

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

1488 1489
    virResetLastError();

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

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

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

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

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

1527 1528
    virResetLastError();

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

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

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

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

1567 1568 1569
    virResetLastError();

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

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

1597 1598
    virResetLastError();

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

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

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

1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
/**
 * virDomainCreateLinux:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the domain
 * @flags: callers should always pass 0
 *
 * Deprecated after 0.4.6.
 * Renamed to virDomainCreateXML() providing identical functionality.
 * This existing name will left indefinitely for API compatability.
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
    return(virDomainCreateXML(conn, xmlDesc, flags));
}
1645

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

1663 1664
    virResetLastError();

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

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

1682
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1683 1684 1685 1686

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

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

1705 1706
    virResetLastError();

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

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

1724
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1725 1726 1727 1728

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

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

1749 1750
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1751 1752
    virResetLastError();

K
Karel Zak 已提交
1753
    if (!VIR_IS_CONNECT(conn)) {
1754
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1755 1756 1757 1758
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1759
        goto error;
K
Karel Zak 已提交
1760
    }
1761 1762
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
     */
    ret = sscanf(uuidstr,
                 "%02x%02x%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x%02x%02x%02x%02x",
                 raw + 0, raw + 1, raw + 2, raw + 3,
                 raw + 4, raw + 5, raw + 6, raw + 7,
                 raw + 8, raw + 9, raw + 10, raw + 11,
                 raw + 12, raw + 13, raw + 14, raw + 15);
1774

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

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

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

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

1805 1806
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1825 1826 1827 1828

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

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

1848 1849
    DEBUG("domain=%p", domain);

1850 1851
    virResetLastError();

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

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

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

1871
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1872 1873 1874 1875

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

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

1893 1894 1895
    virResetLastError();

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

1904 1905
/**
 * virDomainRef:
D
Daniel Veillard 已提交
1906
 * @domain: the domain to hold a reference on
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
 *
 * 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 已提交
1918 1919
 *
 * Returns 0 in case of success and -1 in case of failure.
1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&domain->conn->lock);
    DEBUG("domain=%p refs=%d", domain, domain->refs);
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
1936
/**
1937
 * virDomainSuspend:
D
Daniel Veillard 已提交
1938 1939 1940
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1941
 * to CPU resources and I/O but the memory used by the domain at the
1942
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1943
 * the domain.
1944
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1945 1946 1947 1948
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1949 1950
virDomainSuspend(virDomainPtr domain)
{
1951
    virConnectPtr conn;
1952
    DEBUG("domain=%p", domain);
1953

1954 1955
    virResetLastError();

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

1965 1966
    conn = domain->conn;

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

1975
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1976 1977 1978 1979

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

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

1999 2000
    virResetLastError();

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

2010 2011
    conn = domain->conn;

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

2020
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2021 2022 2023 2024

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

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

2047 2048
    virResetLastError();

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

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

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

    }

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

2091
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2092 2093 2094 2095

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

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

2114 2115
    virResetLastError();

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

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

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

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

2162
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2163 2164 2165 2166

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

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

2189 2190
    virResetLastError();

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

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

    }

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

2239
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2240 2241 2242 2243

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

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

2266 2267
    virResetLastError();

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

2277 2278
    conn = domain->conn;

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

2287
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2288 2289 2290 2291

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

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

2312 2313
    virResetLastError();

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

2323 2324
    conn = domain->conn;

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

2333
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2334 2335 2336 2337

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

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

2355 2356
    virResetLastError();

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

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

2378 2379
    virResetLastError();

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

2391 2392
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2393
    return (0);
2394 2395
}

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

2412 2413
    virResetLastError();

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

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

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

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

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

2448 2449
    virResetLastError();

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

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

2472 2473 2474
    virResetLastError();

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

2479 2480
    conn = domain->conn;

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

2489
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2490 2491 2492 2493

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

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

2513 2514
    virResetLastError();

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

2520 2521
    conn = domain->conn;

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

2530
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2531 2532 2533 2534

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

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

2556 2557
    virResetLastError();

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

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

2580
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2581 2582 2583 2584

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

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

2606 2607
    virResetLastError();

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

    conn = domain->conn;
2622

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

2631
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2632 2633 2634 2635

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

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

2656 2657
    virResetLastError();

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

2667
    memset(info, 0, sizeof(virDomainInfo));
2668

2669 2670
    conn = domain->conn;

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

2679
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2680 2681 2682 2683

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

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

2704 2705 2706
    virResetLastError();

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

2711 2712
    conn = domain->conn;

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

2719 2720
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

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

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

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

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

    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

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

    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
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;
    int cookielen = 0;

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

    /* 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__);
        return NULL;
    }
    dom_xml = domain->conn->driver->domainDumpXML (domain,
                                                   VIR_DOMAIN_XML_SECURE);
    if (!dom_xml)
        return NULL;

    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"));
        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);
    if (ret == -1)
        goto done;

    /* 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:
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039
/**
 * virDomainMigrate:
 * @domain: a domain object
 * @dconn: destination host (a connection object)
 * @flags: flags
 * @dname: (optional) rename domain to this at destination
 * @uri: (optional) dest hostname/URI as seen from the source host
 * @bandwidth: (optional) specify migration bandwidth limit in Mbps
 *
 * Migrate the domain object from its current host to the destination
 * host given by dconn (a connection to the destination host).
 *
 * Flags may be one of more of the following:
 *   VIR_MIGRATE_LIVE   Attempt a live migration.
 *
 * If a hypervisor supports renaming domains during migration,
 * then you may set the dname parameter to the new name (otherwise
 * it keeps the same name).  If this is not supported by the
 * hypervisor, dname must be NULL or else you will get an error.
 *
 * Since typically the two hypervisors connect directly to each
 * other in order to perform the migration, you may need to specify
 * a path from the source to the destination.  This is the purpose
 * of the uri parameter.  If uri is NULL, then libvirt will try to
 * find the best method.  Uri may specify the hostname or IP address
 * of the destination host as seen from the source.  Or uri may be
 * a URI giving transport, hostname, user, port, etc. in the usual
 * form.  Refer to driver documentation for the particular URIs
 * supported.
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter.  If set to 0,
 * libvirt will choose a suitable default.  Some hypervisors do
 * not support this feature and will return an error if bandwidth
 * is not 0.
 *
 * To see which features are supported by the current hypervisor,
 * see virConnectGetCapabilities, /capabilities/host/migration_features.
 *
 * There are many limitations on migration imposed by the underlying
 * technology - for example it may not be possible to migrate between
 * different processors even with the same architecture, or between
 * different types of hypervisor.
 *
 * Returns the new domain object if the migration was successful,
 *   or NULL in case of error.  Note that the new domain object
 *   exists in the scope of the destination connection (dconn).
 */
virDomainPtr
virDomainMigrate (virDomainPtr domain,
                  virConnectPtr dconn,
                  unsigned long flags,
                  const char *dname,
                  const char *uri,
                  unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
3040
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
3041

3042 3043
    virResetLastError();

3044
    /* First checkout the source */
3045
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3046
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3047 3048
        return NULL;
    }
3049 3050
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3051
        goto error;
3052 3053
    }

3054 3055 3056
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (domain->conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
3057
        goto error;
3058 3059
    }
    if (dconn->flags & VIR_CONNECT_RO) {
3060 3061
        /* NB, deliberately report error against source object, not dest */
        virLibDomainError (domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3062
        goto error;
3063 3064
    }

3065
    /* Check that migration is supported by both drivers. */
3066
    if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
D
Daniel Veillard 已提交
3067 3068 3069
                                  VIR_DRV_FEATURE_MIGRATION_V1) &&
        VIR_DRV_SUPPORTS_FEATURE (dconn->driver, dconn,
                                  VIR_DRV_FEATURE_MIGRATION_V1))
3070 3071
        ddomain = virDomainMigrateVersion1 (domain, dconn, flags, dname, uri, bandwidth);
    else if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
D
Daniel Veillard 已提交
3072 3073 3074
                                       VIR_DRV_FEATURE_MIGRATION_V2) &&
             VIR_DRV_SUPPORTS_FEATURE (dconn->driver, dconn,
                                       VIR_DRV_FEATURE_MIGRATION_V2))
3075
        ddomain = virDomainMigrateVersion2 (domain, dconn, flags, dname, uri, bandwidth);
D
Daniel Veillard 已提交
3076
    else {
3077
        virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3078
        goto error;
3079 3080
    }

3081 3082
     if (ddomain == NULL)
         goto error;
D
Daniel Veillard 已提交
3083

3084
    return ddomain;
3085 3086 3087 3088 3089

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

D
Daniel Veillard 已提交
3092 3093
/*
 * Not for public use.  This function is part of the internal
3094 3095 3096
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3097
virDomainMigratePrepare (virConnectPtr dconn,
3098 3099 3100 3101 3102 3103 3104
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
3105
{
J
John Levon 已提交
3106 3107 3108
    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);
3109

3110 3111
    virResetLastError();

3112
    if (!VIR_IS_CONNECT (dconn)) {
3113
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3114 3115 3116
        return -1;
    }

3117 3118
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3119
        goto error;
3120 3121
    }

3122 3123 3124 3125 3126 3127 3128 3129 3130
    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;
    }
3131 3132

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3133 3134 3135 3136

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3137 3138 3139
    return -1;
}

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

3158 3159 3160
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3161
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3162 3163 3164 3165
        return -1;
    }
    conn = domain->conn;

3166 3167
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3168
        goto error;
3169 3170
    }

3171 3172 3173 3174 3175 3176 3177 3178 3179
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3180 3181

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3182 3183 3184 3185

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

D
Daniel Veillard 已提交
3189 3190
/*
 * Not for public use.  This function is part of the internal
3191 3192 3193
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3194
virDomainMigrateFinish (virConnectPtr dconn,
3195 3196 3197 3198 3199 3200
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3201 3202 3203
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3204

3205 3206
    virResetLastError();

3207
    if (!VIR_IS_CONNECT (dconn)) {
3208
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3209 3210 3211
        return NULL;
    }

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

3217 3218 3219 3220 3221 3222 3223 3224 3225
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3226 3227

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

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


D
Daniel Veillard 已提交
3236 3237
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3238 3239 3240
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3241 3242 3243 3244 3245 3246 3247 3248 3249
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 已提交
3250
{
J
John Levon 已提交
3251 3252 3253 3254
    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 已提交
3255

3256 3257
    virResetLastError();

D
Daniel Veillard 已提交
3258 3259 3260 3261 3262
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3263 3264
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3265
        goto error;
3266 3267
    }

3268 3269 3270 3271 3272 3273 3274 3275 3276 3277
    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 已提交
3278 3279

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3280 3281 3282 3283

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

D
Daniel Veillard 已提交
3287 3288
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3289 3290 3291
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3292 3293 3294 3295 3296 3297 3298
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3299
{
J
John Levon 已提交
3300 3301 3302
    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 已提交
3303

3304 3305
    virResetLastError();

D
Daniel Veillard 已提交
3306 3307 3308 3309 3310
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3311 3312
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3313
        goto error;
3314 3315
    }

3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
    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 已提交
3326 3327

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3328 3329 3330 3331

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3332
    return NULL;
3333 3334 3335
}


3336 3337 3338 3339
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3340
 *
3341 3342 3343 3344 3345
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3346 3347
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3348 3349
    DEBUG("conn=%p, info=%p", conn, info);

3350 3351
    virResetLastError();

3352
    if (!VIR_IS_CONNECT(conn)) {
3353
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3354 3355 3356 3357
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3358
        goto error;
3359 3360
    }

3361 3362 3363 3364 3365 3366 3367
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3368

3369
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3370 3371 3372 3373

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

3377 3378 3379 3380 3381 3382
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3383 3384
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3385 3386 3387 3388 3389
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3390 3391
    DEBUG("conn=%p", conn);

3392 3393
    virResetLastError();

3394
    if (!VIR_IS_CONNECT (conn)) {
3395
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3396 3397 3398
        return NULL;
    }

3399 3400 3401 3402 3403 3404 3405
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3406

3407
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3408 3409 3410 3411

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

3415 3416 3417
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
3418
 *
D
Daniel Veillard 已提交
3419
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
3420 3421
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
3422
 *
D
Daniel Veillard 已提交
3423
 * Returns the available free memory in bytes or 0 in case of error
3424 3425 3426 3427
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
3428 3429
    DEBUG("conn=%p", conn);

3430 3431
    virResetLastError();

3432 3433 3434 3435 3436
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3437 3438 3439 3440 3441 3442 3443
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3444 3445

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3446 3447 3448 3449

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3450 3451 3452
    return 0;
}

3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466
/**
 * 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;
3467
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3468

3469 3470
    virResetLastError();

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

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3479 3480
        if (!schedtype)
            goto error;
3481 3482 3483
        return schedtype;
    }

3484
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3485 3486 3487 3488

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

3514 3515
    virResetLastError();

3516
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3517
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3518 3519 3520 3521
        return -1;
    }
    conn = domain->conn;

3522 3523 3524 3525 3526 3527 3528
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3529

3530
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3531 3532 3533 3534

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550
    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
3551
virDomainSetSchedulerParameters(virDomainPtr domain,
3552
                                virSchedParameterPtr params, int nparams)
3553 3554
{
    virConnectPtr conn;
3555
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3556

3557 3558
    virResetLastError();

3559
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3560
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3561 3562
        return -1;
    }
3563 3564
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3565
        goto error;
3566
    }
3567 3568
    conn = domain->conn;

3569 3570 3571 3572 3573 3574 3575
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3576

3577
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3578 3579 3580 3581

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3582 3583 3584 3585
    return -1;
}


3586
/**
3587
 * virDomainBlockStats:
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 3615 3616
 * @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);

3617 3618
    virResetLastError();

3619
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3620
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3621 3622
        return -1;
    }
3623
    if (!path || !stats || size > sizeof stats2) {
3624 3625 3626
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3627 3628 3629 3630
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3631
            goto error;
3632 3633 3634 3635 3636 3637

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3638 3639 3640 3641

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3642 3643 3644 3645
    return -1;
}

/**
3646
 * virDomainInterfaceStats:
3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674
 * @dom: pointer to the domain object
 * @path: path to the interface
 * @stats: network interface stats (returned)
 * @size: size of stats structure
 *
 * This function returns network interface stats for interfaces
 * attached to the domain.
 *
 * The path parameter is the name of the network interface.
 *
 * Domains may have more than network interface.  To get stats for
 * each you should make multiple calls to this function.
 *
 * Individual fields within the stats structure may be returned
 * as -1, which indicates that the hypervisor does not support
 * that particular statistic.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainInterfaceStats (virDomainPtr dom, const char *path,
                         virDomainInterfaceStatsPtr stats, size_t size)
{
    virConnectPtr conn;
    struct _virDomainInterfaceStats stats2 = { -1, -1, -1, -1,
                                               -1, -1, -1, -1 };
    DEBUG("domain=%p, path=%s, stats=%p, size=%zi", dom, path, stats, size);

3675 3676
    virResetLastError();

3677
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3678
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3679 3680
        return -1;
    }
3681
    if (!path || !stats || size > sizeof stats2) {
3682 3683 3684
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3685 3686 3687 3688
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3689
            goto error;
3690 3691 3692 3693 3694 3695

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3696 3697 3698 3699

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

R
Richard W.M. Jones 已提交
3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
/**
 * 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 已提交
3736 3737 3738 3739
 * 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 已提交
3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753
 * 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);

3754 3755
    virResetLastError();

R
Richard W.M. Jones 已提交
3756 3757 3758 3759 3760
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3761

3762 3763
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3764
        goto error;
3765 3766
    }

R
Richard W.M. Jones 已提交
3767 3768 3769
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3770
        goto error;
R
Richard W.M. Jones 已提交
3771 3772 3773 3774 3775
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3776
        goto error;
R
Richard W.M. Jones 已提交
3777 3778 3779 3780 3781 3782
    }

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

3786 3787 3788 3789 3790 3791 3792 3793
    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 已提交
3794 3795

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3796 3797 3798 3799

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

R
Richard W.M. Jones 已提交
3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
/**
 * 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);

3845 3846
    virResetLastError();

R
Richard W.M. Jones 已提交
3847 3848 3849 3850 3851 3852
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3853 3854
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3855
        goto error;
3856 3857
    }

3858
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
3859 3860 3861 3862 3863 3864
     * 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.
     *
3865
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
3866 3867 3868
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
3869 3870 3871
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
3872 3873 3874 3875 3876 3877 3878 3879
     * 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.
     */
3880 3881

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
R
Richard W.M. Jones 已提交
3882
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
3883
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
3884
        goto error;
R
Richard W.M. Jones 已提交
3885 3886 3887 3888 3889 3890
    }

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

3894 3895 3896 3897 3898 3899 3900 3901
    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 已提交
3902 3903

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3904 3905 3906 3907

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

3911

3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922
/************************************************************************
 *									*
 *		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
 *
3923 3924
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
3925 3926
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
3927 3928 3929 3930 3931
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3932 3933
    DEBUG("conn=%p, xml=%s", conn, xml);

3934 3935
    virResetLastError();

3936
    if (!VIR_IS_CONNECT(conn)) {
3937
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3938 3939
        return (NULL);
    }
3940 3941
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3942
        goto error;
3943
    }
3944 3945
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3946
        goto error;
3947 3948
    }

3949 3950 3951 3952 3953 3954 3955
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3956

3957
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3958 3959 3960 3961

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3962
    return NULL;
3963 3964 3965 3966 3967 3968
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3969
 * Undefine a domain but does not stop it if it is running
3970 3971 3972 3973 3974
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3975
    virConnectPtr conn;
3976
    DEBUG("domain=%p", domain);
3977

3978 3979
    virResetLastError();

3980
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3981
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3982 3983
        return (-1);
    }
3984 3985
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3986
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3987
        goto error;
3988 3989
    }

3990 3991 3992 3993 3994 3995 3996
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3997

3998
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3999 4000 4001 4002

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4003
    return -1;
4004 4005 4006 4007 4008 4009
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
4010
 * Provides the number of defined but inactive domains.
4011 4012 4013 4014 4015 4016
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
4017 4018
    DEBUG("conn=%p", conn);

4019 4020
    virResetLastError();

4021
    if (!VIR_IS_CONNECT(conn)) {
4022
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4023 4024 4025
        return (-1);
    }

4026 4027 4028 4029 4030 4031 4032
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4033

4034
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4035 4036 4037 4038

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

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4048 4049
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4050
 *
4051 4052 4053
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4054
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4055
                             int maxnames) {
4056 4057
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4058 4059
    virResetLastError();

4060
    if (!VIR_IS_CONNECT(conn)) {
4061
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4062 4063 4064
        return (-1);
    }

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

4070 4071 4072 4073 4074 4075 4076
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4077

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

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

/**
 * 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) {
4097
    virConnectPtr conn;
4098
    DEBUG("domain=%p", domain);
4099

4100 4101
    virResetLastError();

4102
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4103
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4104 4105
        return (-1);
    }
4106 4107
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4108
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4109
        goto error;
4110
    }
4111

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

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

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

4128 4129 4130
/**
 * virDomainGetAutostart:
 * @domain: a domain object
4131
 * @autostart: the value returned
4132
 *
4133
 * Provides a boolean value indicating whether the domain
4134 4135 4136 4137 4138 4139 4140
 * 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,
4141 4142 4143
                      int *autostart)
{
    virConnectPtr conn;
4144
    DEBUG("domain=%p, autostart=%p", domain, autostart);
4145

4146 4147 4148
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4149
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4150 4151 4152 4153
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4154
        goto error;
4155 4156
    }

4157 4158
    conn = domain->conn;

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

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

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

/**
 * virDomainSetAutostart:
 * @domain: a domain object
4178
 * @autostart: whether the domain should be automatically started 0 or 1
4179 4180 4181 4182 4183 4184 4185 4186
 *
 * 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,
4187 4188 4189
                      int autostart)
{
    virConnectPtr conn;
4190
    DEBUG("domain=%p, autostart=%d", domain, autostart);
4191

4192 4193 4194
    virResetLastError();

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

4199 4200
    conn = domain->conn;

4201 4202
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4203
        goto error;
4204 4205
    }

4206 4207 4208 4209 4210 4211 4212
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4213

4214
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4215 4216 4217 4218

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

4222 4223 4224 4225 4226 4227 4228 4229
/**
 * 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.
4230
 * This function requires privileged access to the hypervisor.
4231 4232 4233 4234 4235 4236 4237
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
4238
    virConnectPtr conn;
4239
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
4240

4241 4242
    virResetLastError();

4243
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4244
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4245 4246
        return (-1);
    }
4247 4248
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4249
        goto error;
4250
    }
4251

4252 4253
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4254
        goto error;
4255
    }
4256
    conn = domain->conn;
4257

4258 4259 4260 4261 4262 4263 4264
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4265

4266
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4267 4268 4269 4270

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

/**
 * 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.
4286
 *
4287
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4288
 * This function requires privileged access to the hypervisor.
4289 4290 4291 4292 4293 4294 4295
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4296
    virConnectPtr conn;
4297
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4298

4299 4300
    virResetLastError();

4301
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4302
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4303 4304
        return (-1);
    }
4305 4306
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4307
        goto error;
4308
    }
4309

4310
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4311
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4312
       goto error;
4313
    }
4314

4315 4316
    conn = domain->conn;

4317 4318 4319 4320 4321 4322 4323
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4324

4325
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4326 4327 4328 4329

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4330
    return -1;
4331 4332 4333 4334 4335 4336 4337 4338 4339
}

/**
 * virDomainGetVcpus:
 * @domain: pointer to domain object, or NULL for Domain0
 * @info: pointer to an array of virVcpuInfo structures (OUT)
 * @maxinfo: number of structures in info array
 * @cpumaps: pointer to an bit map of real CPUs for all vcpus of this
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
4340
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4341 4342 4343 4344 4345 4346 4347
 *	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...).
4348
 *
4349
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4350
 * and also in cpumaps if this pointer isn't NULL.
4351 4352 4353 4354 4355
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4356
                  unsigned char *cpumaps, int maplen)
4357
{
4358
    virConnectPtr conn;
4359
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
4360

4361 4362
    virResetLastError();

4363
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4364
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4365 4366 4367 4368
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4369
        goto error;
4370 4371 4372
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4373
        goto error;
4374
    }
4375

4376 4377
    conn = domain->conn;

4378 4379 4380 4381 4382 4383 4384 4385
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4386

4387
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4388 4389 4390 4391

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

4395 4396 4397
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4398
 *
4399 4400 4401 4402 4403
 * 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.
4404 4405 4406 4407
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4408 4409
virDomainGetMaxVcpus(virDomainPtr domain)
{
4410
    virConnectPtr conn;
4411
    DEBUG("domain=%p", domain);
4412

4413 4414
    virResetLastError();

4415
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4416
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4417 4418 4419 4420 4421
        return (-1);
    }

    conn = domain->conn;

4422 4423 4424 4425 4426 4427 4428
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4429

4430
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4431 4432 4433 4434

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

4438 4439 4440 4441 4442
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
4443 4444 4445
 * 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.
4446
 *
4447
 * Returns 0 in case of success, -1 in case of failure
4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

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

    if (seclabel == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4461
        goto error;
4462 4463 4464 4465
    }

    conn = domain->conn;

4466 4467 4468 4469 4470 4471 4472 4473 4474
    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__);
4475

4476 4477 4478
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4479
    return -1;
4480 4481 4482 4483 4484 4485 4486
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
4487 4488 4489
 * 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.
4490
 *
4491
 * Returns 0 in case of success, -1 in case of failure
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

    if (secmodel == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4503 4504 4505 4506 4507 4508 4509 4510 4511
        goto error;
    }

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

4514
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4515

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

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

4537 4538
    virResetLastError();

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

4549 4550 4551 4552 4553 4554 4555
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4556

4557
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4558 4559 4560 4561

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4562
    return -1;
4563 4564 4565 4566 4567 4568
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4569
 *
4570 4571 4572 4573 4574
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4575
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4576 4577
{
    virConnectPtr conn;
4578
    DEBUG("domain=%p, xml=%s", domain, xml);
4579

4580 4581
    virResetLastError();

4582
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4583
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4584 4585 4586 4587
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4588
        goto error;
4589 4590 4591
    }
    conn = domain->conn;

4592 4593 4594 4595 4596 4597 4598
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4599

4600
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4601 4602 4603 4604

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

4608 4609 4610 4611 4612 4613 4614 4615 4616 4617
/**
 * 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
4618
 * with the amount of free memory in bytes for each cell requested,
4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629
 * 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)
{
4630 4631 4632
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4633 4634
    virResetLastError();

4635 4636 4637 4638 4639
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4640
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4641
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4642
        goto error;
4643 4644
    }

4645 4646 4647 4648 4649 4650 4651
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4652 4653

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4654 4655 4656 4657

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

4661 4662 4663 4664
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4665
 * Provides the connection pointer associated with a network.  The
4666 4667 4668
 * reference counter on the connection is not increased by this
 * call.
 *
4669 4670 4671 4672
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4673 4674 4675 4676 4677
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4678 4679
    DEBUG("net=%p", net);

4680 4681 4682
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4683
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4684 4685 4686 4687 4688
        return NULL;
    }
    return net->conn;
}

4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699
/**
 * 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)
{
4700 4701
    DEBUG("conn=%p", conn);

4702 4703
    virResetLastError();

4704
    if (!VIR_IS_CONNECT(conn)) {
4705
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4706 4707 4708
        return (-1);
    }

4709 4710 4711 4712 4713 4714 4715
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4716

4717
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4718 4719 4720 4721

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

/**
 * 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
4736
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4737
{
4738 4739
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4740 4741
    virResetLastError();

4742
    if (!VIR_IS_CONNECT(conn)) {
4743
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4744 4745 4746
        return (-1);
    }

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

4752 4753 4754 4755 4756 4757 4758
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4759

4760
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4761 4762 4763 4764

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4765
    return -1;
4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778
}

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

4781 4782
    virResetLastError();

4783
    if (!VIR_IS_CONNECT(conn)) {
4784
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4785 4786 4787
        return (-1);
    }

4788 4789 4790 4791 4792 4793 4794
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4795

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

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

/**
 * 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
4815
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4816 4817
                              int maxnames)
{
4818 4819
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4820 4821
    virResetLastError();

4822
    if (!VIR_IS_CONNECT(conn)) {
4823
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4824 4825 4826
        return (-1);
    }

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

4832 4833 4834 4835 4836 4837 4838 4839
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4840

4841
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4842 4843 4844 4845

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4846
    return -1;
4847 4848 4849 4850 4851 4852 4853 4854 4855
}

/**
 * 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.
 *
4856 4857
 * 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.
4858 4859 4860 4861
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4862 4863
    DEBUG("conn=%p, name=%s", conn, name);

4864 4865
    virResetLastError();

4866
    if (!VIR_IS_CONNECT(conn)) {
4867
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4868 4869 4870 4871
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4872
        goto  error;
4873 4874
    }

4875 4876 4877 4878 4879 4880 4881
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4882

4883
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4884 4885 4886 4887

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4888
    return NULL;
4889 4890 4891 4892 4893 4894 4895 4896 4897
}

/**
 * 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.
 *
4898 4899
 * 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.
4900 4901 4902 4903
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4904 4905
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4906 4907
    virResetLastError();

4908
    if (!VIR_IS_CONNECT(conn)) {
4909
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4910 4911 4912 4913
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4914
        goto error;
4915 4916
    }

4917 4918 4919 4920 4921 4922 4923
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4924

4925
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4926 4927 4928 4929

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4930
    return NULL;
4931 4932 4933 4934 4935 4936 4937 4938 4939
}

/**
 * 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.
 *
4940 4941
 * 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.
4942 4943 4944 4945 4946 4947 4948
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4949
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4950

4951 4952
    virResetLastError();

4953
    if (!VIR_IS_CONNECT(conn)) {
4954
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4955 4956 4957 4958
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4959
        goto error;
4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976
    }

    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
     */
    ret = sscanf(uuidstr,
                 "%02x%02x%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x%02x%02x%02x%02x",
                 raw + 0, raw + 1, raw + 2, raw + 3,
                 raw + 4, raw + 5, raw + 6, raw + 7,
                 raw + 8, raw + 9, raw + 10, raw + 11,
                 raw + 12, raw + 13, raw + 14, raw + 15);

    if (ret!=VIR_UUID_BUFLEN) {
4977
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4978
        goto error;
4979 4980 4981 4982 4983
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4984 4985 4986 4987 4988

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

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

5006 5007
    virResetLastError();

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

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

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

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

/**
 * 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
5047 5048
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
5049 5050
    DEBUG("conn=%p, xml=%s", conn, xml);

5051 5052
    virResetLastError();

5053
    if (!VIR_IS_CONNECT(conn)) {
5054
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5055 5056 5057 5058
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5059
        goto error;
5060 5061 5062
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5063
        goto error;
5064 5065
    }

5066 5067 5068 5069 5070 5071 5072
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5073

5074
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5075 5076 5077 5078

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5079
    return NULL;
5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092
}

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

5095 5096
    virResetLastError();

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

5107 5108 5109 5110 5111 5112 5113
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5114

5115
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5116 5117 5118 5119

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5120
    return -1;
5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132
}

/**
 * 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
5133 5134
virNetworkCreate(virNetworkPtr network)
{
5135
    virConnectPtr conn;
5136 5137
    DEBUG("network=%p", network);

5138 5139
    virResetLastError();

5140
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5141
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5142 5143 5144 5145 5146
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5147
        goto error;
5148 5149
    }

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

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

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

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
5171 5172 5173
 * 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
5174 5175 5176 5177 5178 5179 5180
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
5181
    DEBUG("network=%p", network);
5182

5183 5184
    virResetLastError();

5185
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5186
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5187 5188 5189 5190 5191 5192
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5193
        goto error;
5194 5195
    }

5196 5197 5198 5199 5200 5201 5202
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5203

5204
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5205 5206 5207 5208

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5209
    return -1;
5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
}

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

5226 5227 5228
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5229
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5230 5231
        return (-1);
    }
5232
    if (virUnrefNetwork(network) < 0)
5233 5234 5235 5236
        return (-1);
    return(0);
}

5237 5238
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
5239
 * @network: the network to hold a reference on
5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250
 *
 * 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 已提交
5251 5252
 *
 * Returns 0 in case of success, -1 in case of failure.
5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&network->conn->lock);
    DEBUG("network=%p refs=%d", network, network->refs);
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279
/**
 * 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)
{
5280 5281
    DEBUG("network=%p", network);

5282 5283
    virResetLastError();

5284
    if (!VIR_IS_NETWORK(network)) {
5285
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302
        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)
{
5303 5304
    DEBUG("network=%p, uuid=%p", network, uuid);

5305 5306
    virResetLastError();

5307
    if (!VIR_IS_NETWORK(network)) {
5308
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5309 5310 5311 5312
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5313
        goto error;
5314 5315 5316 5317 5318
    }

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

    return (0);
5319 5320 5321 5322 5323

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339
}

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

5342 5343
    virResetLastError();

5344
    if (!VIR_IS_NETWORK(network)) {
5345
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5346 5347 5348 5349
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5350
        goto error;
5351 5352 5353
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5354
        return (-1);
5355

5356
    virUUIDFormat(uuid, buf);
5357
    return (0);
5358 5359 5360 5361 5362

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the network. The description may be reused
 * later to relaunch the network with virNetworkCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNetworkGetXMLDesc(virNetworkPtr network, int flags)
{
5379
    virConnectPtr conn;
5380
    DEBUG("network=%p, flags=%d", network, flags);
5381

5382 5383 5384
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5385
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5386 5387 5388 5389
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5390
        goto error;
5391 5392
    }

5393 5394
    conn = network->conn;

5395 5396 5397 5398 5399 5400 5401
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5402

5403
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5404 5405 5406 5407

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5408
    return NULL;
5409
}
5410 5411 5412 5413 5414

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5415
 * Provides a bridge interface name to which a domain may connect
5416 5417 5418 5419 5420 5421 5422 5423
 * 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)
{
5424
    virConnectPtr conn;
5425
    DEBUG("network=%p", network);
5426

5427 5428 5429
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5430
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5431 5432 5433
        return (NULL);
    }

5434 5435
    conn = network->conn;

5436 5437 5438 5439 5440 5441 5442
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5443

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

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

/**
 * virNetworkGetAutostart:
 * @network: a network object
5455
 * @autostart: the value returned
5456
 *
5457
 * Provides a boolean value indicating whether the network
5458 5459 5460 5461 5462 5463 5464
 * 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,
5465 5466 5467
                       int *autostart)
{
    virConnectPtr conn;
5468
    DEBUG("network=%p, autostart=%p", network, autostart);
5469

5470 5471 5472
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5473
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5474 5475 5476 5477
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5478
        goto error;
5479 5480
    }

5481 5482
    conn = network->conn;

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

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

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

/**
 * virNetworkSetAutostart:
 * @network: a network object
5502
 * @autostart: whether the network should be automatically started 0 or 1
5503 5504 5505 5506 5507 5508 5509 5510
 *
 * 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,
5511 5512 5513
                       int autostart)
{
    virConnectPtr conn;
5514
    DEBUG("network=%p, autostart=%d", network, autostart);
5515

5516 5517 5518
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5519
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5520 5521 5522
        return (-1);
    }

5523 5524
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5525
        goto error;
5526 5527
    }

5528 5529
    conn = network->conn;

5530 5531 5532 5533 5534 5535 5536
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5537

5538
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5539 5540 5541 5542

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

D
Daniel Veillard 已提交
5546 5547
/**
 * virInterfaceGetConnect:
D
Daniel Veillard 已提交
5548
 * @iface: pointer to a interface
D
Daniel Veillard 已提交
5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560
 *
 * 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
5561
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
5562
{
5563
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5564 5565 5566

    virResetLastError();

5567
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
5568 5569 5570
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return NULL;
    }
5571
    return iface->conn;
D
Daniel Veillard 已提交
5572 5573 5574 5575 5576 5577
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
5578
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
5579
 *
5580
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
5616 5617
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735
/**
 * virConnectNumOfDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of defined (inactive) interfaces on the physical host.
 *
 * Returns the number of defined interface found or -1 in case of error
 */
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

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

    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

D
Daniel Veillard 已提交
5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821
/**
 * virInterfaceLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the interface
 *
 * Try to lookup an interface on the given hypervisor based on its name.
 *
 * Returns a new interface object or NULL in case of failure.  If the
 * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
 */
virInterfacePtr
virInterfaceLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%s", conn, name);

    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

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

    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

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

    virResetLastError();

5836
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5837 5838 5839
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5840
    return (iface->name);
D
Daniel Veillard 已提交
5841 5842 5843 5844
}

/**
 * virInterfaceGetMACString:
5845
 * @iface: a interface object
D
Daniel Veillard 已提交
5846 5847 5848 5849 5850 5851 5852 5853 5854
 *
 * Get the MAC for a interface as string. For more information about
 * MAC see RFC4122.
 *
 * Returns a pointer to the MAC address (in null-terminated ASCII
 * format) or NULL, the string need not be deallocated its lifetime
 * will be the same as the interface object.
 */
const char *
5855
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
5856
{
5857
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5858 5859 5860

    virResetLastError();

5861
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5862 5863 5864
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5865
    return (iface->mac);
D
Daniel Veillard 已提交
5866 5867 5868 5869
}

/**
 * virInterfaceGetXMLDesc:
5870
 * @iface: a interface object
D
Daniel Veillard 已提交
5871 5872 5873 5874 5875 5876 5877 5878 5879
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the interface. The description may be reused
 * later to recreate the interface with virInterfaceCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
5880
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5881 5882
{
    virConnectPtr conn;
5883
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5884 5885 5886

    virResetLastError();

5887
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5888 5889 5890 5891
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
5892
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
5893 5894 5895
        goto error;
    }

5896
    conn = iface->conn;
D
Daniel Veillard 已提交
5897 5898 5899

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
5900
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
5901 5902 5903 5904 5905 5906 5907 5908 5909
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5910
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961
    return NULL;
}

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

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceUndefine:
5962
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5963 5964 5965 5966 5967 5968 5969
 *
 * 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
5970
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
5971
    virConnectPtr conn;
5972
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5973 5974 5975

    virResetLastError();

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

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
5988
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
5989 5990 5991 5992 5993 5994 5995 5996 5997
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceCreate:
6004
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
6005 6006 6007 6008 6009 6010 6011
 * @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
6012
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6013 6014
{
    virConnectPtr conn;
6015
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6016 6017 6018

    virResetLastError();

6019
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6020 6021 6022
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
6023
    conn = iface->conn;
D
Daniel Veillard 已提交
6024
    if (conn->flags & VIR_CONNECT_RO) {
6025
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6026 6027 6028 6029 6030
        goto error;
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceDestroy:
6047
 * @iface: an interface object
D
Daniel Veillard 已提交
6048 6049 6050 6051 6052 6053 6054 6055 6056
 * @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
6057
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6058 6059
{
    virConnectPtr conn;
6060
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6061 6062 6063

    virResetLastError();

6064
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6065 6066 6067 6068
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }

6069
    conn = iface->conn;
D
Daniel Veillard 已提交
6070
    if (conn->flags & VIR_CONNECT_RO) {
6071
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6072 6073 6074 6075 6076
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
6077
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
6078 6079 6080 6081 6082 6083 6084 6085 6086
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
6087
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
6088 6089 6090 6091 6092
    return -1;
}

/**
 * virInterfaceRef:
6093
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108
 *
 * Increment the reference count on the interface. For each
 * additional call to this method, there shall be a corresponding
 * call to virInterfaceFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a interface would increment
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6109
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
6110
{
6111
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
6112 6113 6114
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
6115 6116 6117 6118
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
6119 6120 6121 6122 6123
    return 0;
}

/**
 * virInterfaceFree:
6124
 * @iface: a interface object
D
Daniel Veillard 已提交
6125 6126 6127 6128 6129 6130 6131
 *
 * 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
6132
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
6133
{
6134
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6135 6136 6137

    virResetLastError();

6138
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6139 6140 6141
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
6142
    if (virUnrefInterface(iface) < 0)
D
Daniel Veillard 已提交
6143 6144 6145 6146
        return (-1);
    return(0);
}

6147 6148 6149

/**
 * virStoragePoolGetConnect:
6150
 * @pool: pointer to a pool
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166
 *
 * 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);

6167 6168 6169
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return NULL;
    }
    return pool->conn;
}

/**
 * virConnectNumOfStoragePools:
 * @conn: pointer to hypervisor connection
 *
 * Provides the number of active storage pools
 *
 * Returns the number of pools found, or -1 on error
 */
int
virConnectNumOfStoragePools	(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

6189 6190
    virResetLastError();

6191 6192 6193 6194 6195
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6196 6197 6198 6199 6200 6201 6202
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6203 6204

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6205 6206 6207 6208

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230
    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);

6231 6232
    virResetLastError();

6233 6234 6235 6236 6237 6238 6239
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

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

6243 6244 6245 6246 6247 6248 6249
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6250 6251 6252

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6253 6254 6255 6256
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272
}


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

6273 6274
    virResetLastError();

6275 6276 6277 6278 6279
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6280 6281 6282 6283 6284 6285 6286
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6287 6288

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6289 6290 6291 6292

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

6316 6317
    virResetLastError();

6318 6319 6320 6321 6322 6323 6324
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

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

6328 6329 6330 6331 6332 6333 6334
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6335 6336

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6337 6338 6339 6340

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6341 6342 6343 6344
    return -1;
}


6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371
/**
 * 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)
{
6372 6373 6374 6375
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

6376 6377
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6378
        goto error;
6379 6380 6381
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6382
        goto error;
6383 6384
    }

6385 6386
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6387
        goto error;
6388 6389
    }

6390 6391 6392 6393 6394 6395 6396
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
6397 6398

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6399 6400 6401 6402

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


6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421
/**
 * 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);

6422 6423
    virResetLastError();

6424 6425 6426 6427 6428 6429
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6430
        goto error;
6431 6432
    }

6433 6434 6435 6436 6437 6438 6439
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6440 6441

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6442 6443 6444 6445

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464
    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);

6465 6466
    virResetLastError();

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

6476 6477 6478 6479 6480 6481 6482
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6483 6484 6485

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/**
 * 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,
6504
                                 const char *uuidstr)
6505 6506 6507 6508
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

6509 6510
    virResetLastError();

6511 6512 6513 6514 6515 6516
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6517
        goto error;
6518 6519 6520 6521
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6522
        goto error;
6523 6524 6525
    }

    return virStoragePoolLookupByUUID(conn, uuid);
6526 6527 6528 6529 6530

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546
}


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

6547 6548 6549
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
6550 6551 6552 6553
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

6554 6555 6556 6557 6558 6559 6560
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
6561 6562 6563

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

6564 6565 6566 6567
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6568 6569 6570 6571 6572 6573
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
6574
 * @flags: future flags, use 0 for now
6575 6576
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
6577
 * pool is not persistent, so its definition will disappear
6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588
 * 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);

6589 6590
    virResetLastError();

6591 6592 6593 6594 6595 6596
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6597
        goto error;
6598 6599 6600
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6601
        goto error;
6602 6603
    }

6604 6605 6606 6607 6608 6609 6610
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6611 6612

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6613 6614 6615 6616

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

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
6624
 * @flags: future flags, use 0 for now
6625 6626
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
6627
 * pool is persistent, until explicitly undefined.
6628 6629 6630 6631 6632 6633 6634 6635 6636 6637
 *
 * 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);

6638 6639
    virResetLastError();

6640 6641 6642 6643 6644 6645
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6646
        goto error;
6647 6648 6649
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6650
        goto error;
6651 6652
    }

6653 6654 6655 6656 6657 6658 6659
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
6660 6661 6662

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6663 6664 6665 6666
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6667 6668 6669 6670 6671
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
6672
 * @flags: future flags, use 0 for now
6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684
 *
 * 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);

6685 6686
    virResetLastError();

6687 6688 6689 6690 6691 6692 6693
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6694
        goto error;
6695 6696
    }

6697 6698 6699 6700 6701 6702 6703
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6704 6705 6706

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6707 6708 6709 6710
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6711 6712 6713 6714 6715 6716 6717 6718 6719
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
6720
 * Returns 0 on success, -1 on failure
6721 6722 6723 6724 6725 6726 6727
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

6728 6729
    virResetLastError();

6730 6731 6732 6733 6734 6735 6736
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6737
        goto error;
6738 6739
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6750 6751 6752 6753
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6754 6755 6756 6757 6758 6759
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
6760
 * @flags: future flags, use 0 for now
6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772
 *
 * 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);

6773 6774
    virResetLastError();

6775 6776 6777 6778 6779 6780 6781
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6782
        goto error;
6783 6784
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6795 6796 6797 6798
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819
}


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

6820 6821
    virResetLastError();

6822 6823 6824 6825 6826 6827 6828 6829
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6830
        goto error;
6831 6832
    }

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

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

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

6867 6868
    virResetLastError();

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

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6877
        goto error;
6878 6879
    }

6880 6881 6882 6883 6884 6885 6886
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6887 6888

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6889 6890 6891 6892

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910
    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);

6911 6912 6913
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6914 6915 6916 6917 6918 6919 6920 6921 6922 6923
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6924 6925
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
6926
 * @pool: the pool to hold a reference on
6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937
 *
 * 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 已提交
6938 6939
 *
 * Returns 0 in case of success, -1 in case of failure.
6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&pool->conn->lock);
    DEBUG("pool=%p refs=%d", pool, pool->refs);
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
/**
 * virStoragePoolRefresh:
 * @pool: pointer to storage pool
 * @flags: flags to control refresh behaviour (currently unused, use 0)
 *
 * Request that the pool refresh its list of volumes. This may
 * involve communicating with a remote server, and/or initializing
 * new devices at the OS layer
 *
 * Return 0 if the volume list was refreshed, -1 on failure
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p flags=%u", pool, flags);

6973 6974
    virResetLastError();

6975 6976 6977 6978 6979 6980 6981 6982
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6983
        goto error;
6984 6985
    }

6986 6987 6988 6989 6990 6991 6992
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6993 6994

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6995 6996 6997 6998

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
 * Return the name of the pool, or NULL on error
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

7016 7017
    virResetLastError();

7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    return (pool->name);
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
 * Return 0 on success, or -1 on error;
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
    DEBUG("pool=%p, uuid=%p", pool, uuid);

7041 7042
    virResetLastError();

7043 7044 7045 7046 7047 7048
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (uuid == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7049
        goto error;
7050 7051 7052 7053 7054 7055
    }

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

    return (0);

7056 7057 7058 7059
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077
}

/**
 * virStoragePoolGetUUIDString:
 * @pool: pointer to storage pool
 * @buf: buffer of VIR_UUID_STRING_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool as a string
 *
 * Return 0 on success, or -1 on error;
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("pool=%p, buf=%p", pool, buf);

7078 7079
    virResetLastError();

7080 7081 7082 7083 7084 7085
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (buf == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7086
        goto error;
7087 7088 7089
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
7090
        goto error;
7091 7092 7093 7094

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

7095 7096 7097 7098
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118
}


/**
 * virStoragePoolGetInfo:
 * @pool: pointer to storage pool
 * @info: pointer at which to store info
 *
 * Get volatile information about the storage pool
 * such as free space / usage summary
 *
 * returns 0 on success, or -1 on failure.
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("pool=%p, info=%p", pool, info);

7119 7120
    virResetLastError();

7121 7122 7123 7124 7125 7126
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (info == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7127
        goto error;
7128 7129 7130 7131 7132 7133
    }

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

    conn = pool->conn;

7134 7135 7136 7137 7138 7139 7140
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7141 7142 7143

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7144 7145 7146 7147
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7148 7149 7150 7151 7152 7153
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
7154
 * @flags: flags for XML format options (set of virDomainXMLFlags)
7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
 * returns a XML document, or NULL on error
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

7169 7170 7171
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7172 7173 7174 7175 7176
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7177
        goto error;
7178 7179 7180 7181
    }

    conn = pool->conn;

7182 7183 7184 7185 7186 7187 7188
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
7189 7190 7191

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7192 7193 7194 7195
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return NULL;
7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215
}


/**
 * virStoragePoolGetAutostart:
 * @pool: pointer to storage pool
 * @autostart: location in which to store autostart flag
 *
 * Fetches the value of the autostart flag, which determines
 * whether the pool is automatically started at boot time
 *
 * return 0 on success, -1 on failure
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%p", pool, autostart);

7216 7217 7218
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7219 7220 7221 7222 7223
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7224
        goto error;
7225 7226 7227 7228
    }

    conn = pool->conn;

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

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
 * returns 0 on success, -1 on failure
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%d", pool, autostart);

7262 7263 7264
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7265
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7266
        goto error;
7267 7268
    }

7269 7270
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7271
        goto error;
7272 7273
    }

7274 7275
    conn = pool->conn;

7276 7277 7278 7279 7280 7281 7282
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7283 7284

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7285 7286 7287 7288

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

7306 7307
    virResetLastError();

7308 7309 7310 7311 7312
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

7313 7314 7315 7316 7317 7318 7319
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7320 7321

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347
    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);

7348 7349
    virResetLastError();

7350 7351 7352 7353 7354 7355 7356
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7357
        goto error;
7358 7359
    }

7360 7361 7362 7363 7364 7365 7366
    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;
    }
7367 7368

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7369 7370 7371 7372

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7373 7374 7375 7376 7377 7378
    return -1;
}


/**
 * virStorageVolGetConnect:
7379
 * @vol: pointer to a pool
7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395
 *
 * 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);

7396 7397
    virResetLastError();

7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421
    if (!VIR_IS_STORAGE_VOL (vol)) {
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return NULL;
    }
    return vol->conn;
}


/**
 * virStorageVolLookupByName:
 * @pool: pointer to storage pool
 * @name: name of storage volume
 *
 * Fetch a pointer to a storage volume based on its name
 * within a pool
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
    DEBUG("pool=%p, name=%s", pool, name);

7422 7423
    virResetLastError();

7424 7425 7426 7427 7428 7429
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7430
        goto error;
7431 7432
    }

7433 7434 7435 7436 7437 7438 7439
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
7440 7441

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7442 7443 7444 7445

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466
    return NULL;
}



/**
 * virStorageVolLookupByKey:
 * @conn: pointer to hypervisor connection
 * @key: globally unique key
 *
 * Fetch a pointer to a storage volume based on its
 * globally unique key
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
    DEBUG("conn=%p, key=%s", conn, key);

7467 7468
    virResetLastError();

7469 7470 7471 7472 7473 7474
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7475
        goto error;
7476 7477
    }

7478 7479 7480 7481 7482 7483 7484
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
7485 7486

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7487 7488 7489 7490

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509
    return NULL;
}

/**
 * virStorageVolLookupByPath:
 * @conn: pointer to hypervisor connection
 * @path: locally unique path
 *
 * Fetch a pointer to a storage volume based on its
 * locally (host) unique path
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
    DEBUG("conn=%p, path=%s", conn, path);

7510 7511
    virResetLastError();

7512 7513 7514 7515 7516 7517
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7518
        goto error;
7519 7520
    }

7521 7522 7523 7524 7525 7526 7527
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
7528 7529

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7530 7531 7532 7533

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551
    return NULL;
}


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

7552 7553
    virResetLastError();

7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    return (vol->name);
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
7567
 * unique, so the same volume will have the same
7568 7569 7570 7571 7572 7573 7574 7575 7576
 * key no matter what host it is accessed from
 *
 * return the volume key, or NULL on error
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7577 7578
    virResetLastError();

7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    return (vol->key);
}


/**
 * virStorageVolCreateXML:
 * @pool: pointer to storage pool
 * @xmldesc: description of volume to create
 * @flags: flags for creation (unused, pass 0)
 *
 * Create a storage volume within a pool based
 * on an XML description. Not all pools support
 * creation of volumes
 *
 * return the storage volume, or NULL on error
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
    DEBUG("pool=%p, flags=%u", pool, flags);

7606 7607
    virResetLastError();

7608
    if (!VIR_IS_STORAGE_POOL(pool)) {
7609
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7610 7611 7612 7613 7614
        return (NULL);
    }

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

7618 7619 7620 7621 7622 7623 7624
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7625 7626

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7627 7628 7629 7630

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


7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693
/**
 * virStorageVolCreateXMLFrom:
 * @pool: pointer to parent pool for the new volume
 * @xmldesc: description of volume to create
 * @clonevol: storage volume to use as input
 * @flags: flags for creation (unused, pass 0)
 *
 * Create a storage volume in the parent pool, using the
 * 'clonevol' volume as input. Information for the new
 * volume (name, perms)  are passed via a typical volume
 * XML description.
 *
 * return the storage volume, or NULL on error
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
    DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);

    virResetLastError();

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

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

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

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

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

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


7694 7695 7696
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
7697
 * @flags: future flags, use 0 for now
7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709
 *
 * Delete the storage volume from the pool
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

7710 7711
    virResetLastError();

7712 7713 7714 7715 7716 7717 7718 7719
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }

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

7723 7724 7725 7726 7727 7728 7729
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7730 7731

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7732 7733 7734 7735

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7736 7737 7738 7739 7740 7741 7742 7743 7744
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
7745
 * storage volume continues to exist.
7746 7747 7748 7749 7750 7751 7752 7753
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7754 7755
    virResetLastError();

7756 7757 7758 7759 7760 7761 7762 7763 7764 7765
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


7766 7767
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
7768
 * @vol: the vol to hold a reference on
7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779
 *
 * 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 已提交
7780 7781
 *
 * Returns 0 in case of success, -1 in case of failure.
7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&vol->conn->lock);
    DEBUG("vol=%p refs=%d", vol, vol->refs);
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813
/**
 * virStorageVolGetInfo:
 * @vol: pointer to storage volume
 * @info: pointer at which to store info
 *
 * Fetches volatile information about the storage
 * volume such as its current allocation
 *
 * Return 0 on success, or -1 on failure
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("vol=%p, info=%p", vol, info);

7814 7815
    virResetLastError();

7816 7817 7818 7819 7820 7821
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (info == NULL) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
7822
        goto error;
7823 7824 7825 7826 7827 7828
    }

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

    conn = vol->conn;

7829 7830 7831 7832 7833 7834 7835
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7836 7837

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7838 7839 7840 7841

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


/**
 * virStorageVolGetXMLDesc:
 * @vol: pointer to storage volume
 * @flags: flags for XML generation (unused, pass 0)
 *
 * Fetch an XML document describing all aspects of
 * the storage volume
 *
 * Return the XML document, or NULL on error
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

7863 7864
    virResetLastError();

7865 7866 7867 7868 7869 7870
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
7871
        goto error;
7872 7873 7874 7875
    }

    conn = vol->conn;

7876 7877 7878 7879 7880 7881 7882
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
7883 7884 7885

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7886 7887 7888 7889
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910
}


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

7911 7912
    virResetLastError();

7913 7914 7915 7916 7917 7918 7919
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

7920 7921 7922 7923 7924 7925 7926
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
7927 7928

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7933 7934
    return NULL;
}
7935 7936


7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952
/**
 * 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 已提交
7953
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7954

7955 7956
    virResetLastError();

7957 7958 7959 7960 7961 7962
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7963
        goto error;
7964 7965
    }

7966 7967 7968 7969 7970 7971 7972
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7973 7974

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7975 7976 7977 7978

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006
    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);

8007 8008
    virResetLastError();

8009 8010 8011 8012 8013 8014
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8015
        goto error;
8016 8017
    }

8018 8019 8020 8021 8022 8023 8024
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8025 8026

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8027 8028 8029 8030

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

8048 8049
    virResetLastError();

8050 8051 8052 8053 8054 8055 8056
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8057
        goto error;
8058 8059
    }

8060 8061 8062 8063 8064 8065 8066
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8067 8068

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8069 8070 8071 8072

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090
    return NULL;
}


/**
 * virNodeDeviceGetXMLDesc:
 * @dev: pointer to the node device
 * @flags: flags for XML generation (unused, pass 0)
 *
 * Fetch an XML document describing all aspects of
 * the device.
 *
 * Return the XML document, or NULL on error
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

8091 8092
    virResetLastError();

8093 8094 8095 8096 8097
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8098 8099 8100 8101 8102 8103 8104
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
8105 8106

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8107 8108 8109 8110

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8111 8112 8113 8114 8115 8116 8117 8118
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8119 8120 8121
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

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

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8139 8140
 * Accessor for the parent of the device
 *
8141 8142 8143 8144 8145 8146 8147
 * 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);

8148 8149
    virResetLastError();

8150 8151 8152 8153 8154
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8155 8156 8157 8158 8159
    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__);
8160
            virSetConnError(dev->conn);
8161 8162 8163 8164
            return NULL;
        }
    }
    return dev->parent;
8165 8166 8167 8168 8169 8170
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8171 8172
 * Accessor for the number of capabilities supported by the device.
 *
8173 8174 8175 8176 8177 8178
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

8179 8180
    virResetLastError();

8181 8182 8183 8184 8185
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8186 8187 8188 8189 8190 8191 8192
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
8193 8194

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8195 8196 8197 8198

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218
    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);

8219 8220
    virResetLastError();

8221 8222 8223 8224 8225
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8226 8227 8228 8229 8230 8231 8232
    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;
    }
8233 8234

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8235 8236 8237 8238

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255
    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);

8256 8257
    virResetLastError();

8258 8259 8260 8261 8262 8263 8264 8265 8266 8267
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return (-1);
    }
    if (virUnrefNodeDevice(dev) < 0)
        return (-1);
    return(0);
}


8268 8269
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
8270
 * @dev: the dev to hold a reference on
8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281
 *
 * 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 已提交
8282 8283
 *
 * Returns 0 in case of success, -1 in case of failure.
8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&dev->conn->lock);
    DEBUG("dev=%p refs=%d", dev, dev->refs);
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

8299
/**
D
Daniel Veillard 已提交
8300
 * virNodeDeviceDettach:
8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314
 * @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 已提交
8315 8316
 *
 * Returns 0 in case of success, -1 in case of failure.
8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

/**
 * virNodeDeviceReAttach:
 * @dev: pointer to the node device
 *
 * Re-attach a previously dettached node device to the node so that it
 * may be used by the node again.
 *
 * Depending on the hypervisor, this may involve operations such
 * as resetting the device, unbinding it from a dummy device driver
 * and binding it to its appropriate driver.
 *
 * If the device is currently in use by a guest, this method may fail.
D
Daniel Veillard 已提交
8358 8359
 *
 * Returns 0 in case of success, -1 in case of failure.
8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

/**
 * virNodeDeviceReset:
 * @dev: pointer to the node device
 *
 * Reset a previously dettached node device to the node before or
 * after assigning it to a guest.
 *
 * The exact reset semantics depends on the hypervisor and device
 * type but, for example, KVM will attempt to reset PCI devices with
 * a Function Level Reset, Secondary Bus Reset or a Power Management
 * D-State reset.
 *
 * If the reset will affect other devices which are currently in use,
 * this function may fail.
D
Daniel Veillard 已提交
8403 8404
 *
 * Returns 0 in case of success, -1 in case of failure.
8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

8434

8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531
/**
 * virNodeDeviceCreateXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the device to be created
 * @flags: callers should always pass 0
 *
 * Create a new device on the VM host machine, for example, virtual
 * HBAs created using vport_create.
 *
 * Returns a node device object if successful, NULL in case of failure
 */
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
                       const char *xmlDesc,
                       unsigned int flags)
{
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

    virResetLastError();

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

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

    virResetLastError();

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

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

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

        return 0;
    }

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

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


8532 8533 8534 8535 8536 8537 8538 8539 8540
/*
 * 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 已提交
8541
 * @freecb: optional function to deallocate opaque when not used anymore
8542 8543 8544 8545
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
8546 8547 8548 8549 8550 8551 8552
 * 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.
 *
8553 8554 8555 8556 8557
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
8558 8559
                              void *opaque,
                              virFreeCallback freecb)
8560
{
8561 8562
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
8563 8564 8565 8566 8567 8568 8569

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8570
        goto error;
8571 8572
    }

8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
 * Removes a Domain Event Callback.
 * De-registering for a domain callback will disable
 * delivery of this event type
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
8603 8604 8605
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
8606 8607 8608 8609 8610 8611 8612

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8613 8614 8615 8616 8617 8618 8619 8620
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
8621 8622
    }

8623 8624 8625 8626
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8627 8628
    return -1;
}