libvirt.c 97.3 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 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"
13
#include "libvirt/libvirt.h"
D
Daniel Veillard 已提交
14

15
#include <stdio.h>
16
#include <stdlib.h>
17
#include <string.h>
18 19 20
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
21
#include <assert.h>
22

23 24
#include <libxml/parser.h>
#include <libxml/xpath.h>
25
#include <libxml/uri.h>
26 27
#include "getpass.h"

28
#ifdef HAVE_WINSOCK2_H
29 30
#include <winsock2.h>
#endif
31

D
Daniel Veillard 已提交
32
#include "internal.h"
33
#include "driver.h"
34

35
#include "uuid.h"
36
#include "test.h"
37
#include "xen_unified.h"
38
#include "remote_internal.h"
39
#include "qemu_driver.h"
40 41 42
#ifdef WITH_OPENVZ
#include "openvz_driver.h"
#endif
43

D
Daniel Veillard 已提交
44 45 46 47 48 49
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
 * - use reference counting to garantee coherent pointer state ?
 */

50
static virDriverPtr virDriverTab[MAX_DRIVERS];
51
static int virDriverTabCount = 0;
52
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
53
static int virNetworkDriverTabCount = 0;
54 55
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
56 57
static int initialized = 0;

58 59 60
#define DEBUG(fmt,...) VIR_DEBUG(__FILE__, fmt, __VA_ARGS__)
#define DEBUG0(msg) VIR_DEBUG(__FILE__, "%s", msg)

61
#ifdef ENABLE_DEBUG
62 63
int debugFlag = 0;
#endif
64

65 66 67 68 69 70 71 72
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;
73
        size_t len;
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

        if (printf("%s:", cred[i].prompt) < 0)
            return -1;
        if (fflush(stdout) != 0)
            return -1;

        switch (cred[i].type) {
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
92 93 94
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
95 96 97 98 99 100 101 102
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
103 104 105

        default:
            return -1;
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
        }

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

    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,
};

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;

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
#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);
    if (err != 0)
        return -1;
}
#endif

166 167 168 169 170 171 172 173 174 175 176 177
/**
 * 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)
{
178 179 180
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
181 182
    if (initialized)
        return(0);
183
    initialized = 1;
184

185 186 187 188 189 190 191 192
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
    if (debugEnv && *debugEnv && *debugEnv != '0')
        debugFlag = 1;
#endif

    DEBUG0("register drivers");

193 194 195 196
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

197 198 199
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

200
    /*
201 202
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
203
     */
204
#ifdef WITH_TEST
205
    if (testRegister() == -1) return -1;
206
#endif
207
#ifdef WITH_QEMU 
208
    if (qemudRegister() == -1) return -1;
209
#endif
210 211
#ifdef WITH_XEN
    if (xenUnifiedRegister () == -1) return -1;
212
#endif
213 214 215
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
#endif
216 217
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
218
#endif
D
Daniel P. Berrange 已提交
219

220 221 222 223 224
    return(0);
}



D
Daniel Veillard 已提交
225 226 227
/**
 * virLibConnError:
 * @conn: the connection if available
228
 * @error: the error number
D
Daniel Veillard 已提交
229 230 231 232 233
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
234 235
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
236
    const char *errmsg;
237

D
Daniel Veillard 已提交
238 239 240 241
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
242
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
243 244 245 246
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
247
 * virLibConnWarning:
D
Daniel Veillard 已提交
248
 * @conn: the connection if available
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
 * @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;

    errmsg = __virErrorMsg(error, info);
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
271 272 273 274 275
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
276 277 278
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
279 280
    virConnectPtr conn = NULL;
    const char *errmsg;
281

D
Daniel Veillard 已提交
282 283 284 285 286 287 288
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
289
    __virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
290 291 292
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

293
/**
294 295 296 297
 * virLibNetworkError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
298
 *
299
 * Handle an error at the connection level
300
 */
301 302 303 304 305 306 307 308 309 310 311 312 313 314
static void
virLibNetworkError(virNetworkPtr network, 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_NETWORK) {
        conn = network->conn;
    }
315
    __virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
316 317 318 319 320 321 322 323 324 325 326 327 328 329
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
 * 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)
{
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
    if (virInitialize() < 0)
      return -1;

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

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

    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
345 346 347 348 349 350 351 352 353 354 355 356 357
}

/**
 * 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)
{
358 359 360 361 362 363 364 365 366 367 368 369 370
    if (virInitialize() < 0)
      return -1;

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

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

371 372 373 374 375 376 377
    if (driver->no < 0) {
    	virLibConnError
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

378 379
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
380 381
}

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
/**
 * 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) {
    	virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

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

int __virStateInitialize(void) {
    int i, ret = 0;

413 414 415
    if (virInitialize() < 0)
        return -1;

416 417 418 419
    if (virInitialize() < 0)
        return -1;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
420 421
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
422 423 424 425 426 427 428 429 430
            ret = -1;
    }
    return ret;
}

int __virStateCleanup(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
431 432
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
433 434 435 436 437 438 439 440 441
            ret = -1;
    }
    return ret;
}

int __virStateReload(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
442 443
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
444 445 446 447 448 449 450 451 452
            ret = -1;
    }
    return ret;
}

int __virStateActive(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
453 454
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
455 456 457 458 459 460 461
            ret = 1;
    }
    return ret;
}



462 463 464
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
465
 * @type: the type of connection/driver looked at
466 467 468 469 470 471 472 473 474 475 476 477
 * @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
 * @type is unknown or not availble, an error code will be returned and 
 * @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
478 479 480
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
481
    int i;
482
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
483

484
    if (!initialized)
485 486
        if (virInitialize() < 0)
	    return -1;
487

488
    if (libVer == NULL)
489
        return (-1);
490 491 492
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
493 494
        if (type == NULL)
	    type = "Xen";
495
	for (i = 0;i < virDriverTabCount;i++) {
496
	    if ((virDriverTab[i] != NULL) &&
497
	        (!strcasecmp(virDriverTab[i]->name, type))) {
498 499 500 501
		*typeVer = virDriverTab[i]->ver;
		break;
	    }
	}
502
        if (i >= virDriverTabCount) {
503
            *typeVer = 0;
504
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
505 506 507 508
            return (-1);
        }
    }
    return (0);
509 510
}

511
static virConnectPtr
512 513 514
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
515
{
516
    int i, res;
517
    virConnectPtr ret = NULL;
518
    xmlURIPtr uri;
519

520 521 522 523 524 525 526 527
    /* Convert NULL or "" to xen:/// for back compat */
    if (!name || name[0] == '\0')
        name = "xen:///";

    /* Convert xen -> xen:/// for back compat */
    if (!strcasecmp(name, "xen"))
        name = "xen:///";

528 529 530 531 532 533
    /* Convert xen:// -> xen:/// because xmlParseURI cannot parse the
     * former.  This allows URIs such as xen://localhost to work.
     */
    if (STREQ (name, "xen://"))
        name = "xen:///";

534
    if (!initialized)
535 536
        if (virInitialize() < 0)
	    return NULL;
537

538
    ret = virGetConnect();
539
    if (ret == NULL) {
540
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
541 542 543 544 545 546 547
        return NULL;
    }

    uri = xmlParseURI (name);
    if (!uri) {
        virLibConnError (ret, VIR_ERR_INVALID_ARG,
                         _("could not parse connection URI"));
548 549 550
        goto failed;
    }

551 552 553 554 555 556 557 558 559 560 561
    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,
          uri->scheme, uri->opaque, uri->authority, uri->server,
          uri->user, uri->port, uri->path);
562

563 564 565 566 567 568
    ret->name = strdup (name);
    if (!ret->name) {
        virLibConnError (ret, VIR_ERR_NO_MEMORY, "allocating conn->name");
        goto failed;
    }

569
    for (i = 0; i < virDriverTabCount; i++) {
570 571
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
572
        res = virDriverTab[i]->open (ret, uri, auth, flags);
573 574 575 576 577
        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")));
578 579 580 581 582
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
583 584
    }

585
    if (!ret->driver) {
586 587
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
588
        goto failed;
589 590
    }

591
    for (i = 0; i < virNetworkDriverTabCount; i++) {
592
        res = virNetworkDriverTab[i]->open (ret, uri, auth, flags);
593 594 595 596 597
        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")));
598
        if (res == VIR_DRV_OPEN_ERROR) {
599 600 601 602
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK, 
                                   "Is the daemon running ?");
            }
603 604
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
605 606 607
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
608
    }
609

610 611
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;
612

613 614
    xmlFreeURI (uri);

615
    return ret;
616 617

failed:
618
    if (ret->name) free (ret->name);
619
    if (ret->driver) ret->driver->close (ret);
620
    if (uri) xmlFreeURI(uri);
621
	virUnrefConnect(ret);
622
    return NULL;
623 624
}

625 626
/**
 * virConnectOpen:
627
 * @name: URI of the hypervisor
628 629 630 631 632
 *
 * This function should be called first to get a connection to the 
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
633 634
 *
 * URIs are documented at http://libvirt.org/uri.html
635 636 637 638
 */
virConnectPtr
virConnectOpen (const char *name)
{
639
    DEBUG("name=%s", name);
640
    return do_open (name, NULL, 0);
641 642
}

643
/**
644
 * virConnectOpenReadOnly:
645
 * @name: URI of the hypervisor
646
 *
647 648 649
 * This function should be called first to get a restricted connection to the 
 * libbrary functionalities. The set of APIs usable are then restricted
 * on the available methods to control the domains.
650 651
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
652 653
 *
 * URIs are documented at http://libvirt.org/uri.html
654
 */
655
virConnectPtr
656 657
virConnectOpenReadOnly(const char *name)
{
658
    DEBUG("name=%s", name);
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
 * This function should be called first to get a connection to the 
 * Hypervisor. If neccessary, authentication will be performed fetching
 * credentials via the callback
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
 *
 * URIs are documented at http://libvirt.org/uri.html
 */
virConnectPtr
virConnectOpenAuth(const char *name,
                   virConnectAuthPtr auth,
                   int flags)
{
    DEBUG("name=%s", name);
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
683 684 685
}

/**
686
 * virConnectClose:
D
Daniel Veillard 已提交
687 688 689 690 691 692 693 694 695 696
 * @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
697 698
virConnectClose(virConnectPtr conn)
{
699 700
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
701
    if (!VIR_IS_CONNECT(conn))
702
        return (-1);
703 704 705

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
706
    conn->driver->close (conn);
707

708
    if (virUnrefConnect(conn) < 0)
709
        return (-1);
710
    return (0);
D
Daniel Veillard 已提交
711 712
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726
/* Not for public use.  This function is part of the internal
 * implementation of driver features in the remote case.
 */
int
__virDrvSupportsFeature (virConnectPtr conn, int feature)
{
    DEBUG("conn=%p, feature=%d", conn, feature);

    if (!VIR_IS_CONNECT(conn))
        return (-1);

    return VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
}

727 728 729 730 731 732 733
/**
 * 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.
734 735 736
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
737 738
 */
const char *
739 740
virConnectGetType(virConnectPtr conn)
{
741
    const char *ret;
742
    DEBUG("conn=%p", conn);
743

D
Daniel Veillard 已提交
744
    if (!VIR_IS_CONNECT(conn)) {
745
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
746
        return (NULL);
D
Daniel Veillard 已提交
747
    }
748 749 750 751

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
752
    }
753
    return conn->driver->name;
754 755
}

D
Daniel Veillard 已提交
756
/**
757
 * virConnectGetVersion:
D
Daniel Veillard 已提交
758
 * @conn: pointer to the hypervisor connection
759
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
760
 *
761 762 763
 * Get the version level of the Hypervisor running. This may work only with 
 * hypervisor call, i.e. with priviledged access to the hypervisor, not
 * with a Read-Only connection.
D
Daniel Veillard 已提交
764
 *
765 766 767
 * 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 已提交
768
 */
769
int
770 771
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
772 773
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
774
    if (!VIR_IS_CONNECT(conn)) {
775
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
776
        return (-1);
D
Daniel Veillard 已提交
777
    }
778

D
Daniel Veillard 已提交
779 780
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
781
        return (-1);
D
Daniel Veillard 已提交
782
    }
783

784 785
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
786

787 788
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
789 790
}

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
/**
 * 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)
{
806 807
    DEBUG("conn=%p", conn);

808
    if (!VIR_IS_CONNECT(conn)) {
809
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
        return NULL;
    }

    if (conn->driver->getHostname)
        return conn->driver->getHostname (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
838 839
    char *name;

840 841
    DEBUG("conn=%p", conn);

842
    if (!VIR_IS_CONNECT(conn)) {
843
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
844 845 846
        return NULL;
    }

847 848 849
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
850 851 852
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

853 854 855 856 857 858
    name = strdup (conn->name);
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
859 860
}

861 862 863 864 865
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
866
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
867 868 869 870 871 872 873 874 875
 * 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)
{
876 877
    DEBUG("conn=%p, type=%s", conn, type);

878
    if (!VIR_IS_CONNECT(conn)) {
879
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
880 881 882
        return (-1);
    }

883 884
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
885

886 887
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
888 889
}

890
/**
891
 * virConnectListDomains:
892 893 894 895 896 897 898 899 900
 * @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
901 902
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
903 904
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
905
    if (!VIR_IS_CONNECT(conn)) {
906
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
907
        return (-1);
D
Daniel Veillard 已提交
908
    }
909

910
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
911
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
912
        return (-1);
D
Daniel Veillard 已提交
913
    }
914

915 916
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
917

918 919
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
920 921
}

K
 
Karel Zak 已提交
922 923 924 925
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
926 927
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
928 929 930
 * Returns the number of domain found or -1 in case of error
 */
int
931 932
virConnectNumOfDomains(virConnectPtr conn)
{
933 934
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
935
    if (!VIR_IS_CONNECT(conn)) {
936
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
937
        return (-1);
D
Daniel Veillard 已提交
938
    }
K
Karel Zak 已提交
939

940 941
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
942

943 944
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
945 946
}

947 948 949 950
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
951
 * Provides the connection pointer associated with a domain.  The
952 953 954
 * reference counter on the connection is not increased by this
 * call.
 *
955 956 957 958
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
959 960 961 962 963
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
964 965
    DEBUG("dom=%p", dom);

966
    if (!VIR_IS_DOMAIN (dom)) {
967
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
968 969 970 971 972
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
973
/**
974
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
975
 * @conn: pointer to the hypervisor connection
976
 * @xmlDesc: an XML description of the domain
977
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
978
 *
979 980 981
 * Launch a new Linux guest domain, based on an XML description similar
 * to the one returned by virDomainGetXMLDesc()
 * This function may requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
982 983 984
 * 
 * Returns a new domain object or NULL in case of failure
 */
985
virDomainPtr
986 987
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
988
{
989 990
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
991
    if (!VIR_IS_CONNECT(conn)) {
992
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
993
        return (NULL);
D
Daniel Veillard 已提交
994 995 996
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
997
        return (NULL);
D
Daniel Veillard 已提交
998
    }
999 1000 1001 1002
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
1003

1004 1005 1006 1007 1008
    if (conn->driver->domainCreateLinux)
        return conn->driver->domainCreateLinux (conn, xmlDesc, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
D
Daniel Veillard 已提交
1009 1010
}

1011

1012
/**
1013
 * virDomainLookupByID:
1014 1015 1016 1017 1018
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
 *
1019 1020
 * 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.
1021
 */
1022
virDomainPtr
1023 1024
virDomainLookupByID(virConnectPtr conn, int id)
{
1025 1026
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1027
    if (!VIR_IS_CONNECT(conn)) {
1028
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1029
        return (NULL);
D
Daniel Veillard 已提交
1030 1031 1032
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1033
        return (NULL);
D
Daniel Veillard 已提交
1034
    }
1035

1036 1037
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1038

1039 1040
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1041 1042 1043 1044 1045
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1046
 * @uuid: the raw UUID for the domain
1047 1048 1049
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1050 1051
 * 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.
1052 1053
 */
virDomainPtr
1054 1055
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1056 1057
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1058
    if (!VIR_IS_CONNECT(conn)) {
1059
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1060
        return (NULL);
D
Daniel Veillard 已提交
1061 1062 1063
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1064
        return (NULL);
D
Daniel Veillard 已提交
1065
    }
1066

1067 1068
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1069

1070 1071
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1072 1073
}

K
Karel Zak 已提交
1074 1075 1076 1077 1078 1079 1080
/**
 * 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.
 *
1081 1082
 * 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 已提交
1083 1084 1085 1086
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1087 1088
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1089 1090
    int ret;

1091 1092
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1093
    if (!VIR_IS_CONNECT(conn)) {
1094
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
	
    }
    /* 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);
    
1116
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
1117 1118 1119
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
1120
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1121 1122 1123 1124 1125
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1126 1127 1128 1129 1130
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1131
 * Try to lookup a domain on the given hypervisor based on its name.
1132
 *
1133 1134
 * 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.
1135 1136
 */
virDomainPtr
1137 1138
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1139 1140
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1141
    if (!VIR_IS_CONNECT(conn)) {
1142
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1143
        return (NULL);
D
Daniel Veillard 已提交
1144 1145 1146
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1147
        return (NULL);
D
Daniel Veillard 已提交
1148
    }
1149

1150 1151 1152 1153 1154
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1155 1156
}

D
Daniel Veillard 已提交
1157
/**
1158
 * virDomainDestroy:
D
Daniel Veillard 已提交
1159 1160 1161 1162
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
 * already and all resources used by it are given back to the hypervisor.
1163 1164
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
1165
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1166 1167
 *
 * Returns 0 in case of success and -1 in case of failure.
1168
 */
D
Daniel Veillard 已提交
1169
int
1170 1171
virDomainDestroy(virDomainPtr domain)
{
1172
    virConnectPtr conn;
1173

1174 1175
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1176
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1177
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1178
        return (-1);
D
Daniel Veillard 已提交
1179
    }
1180

1181
    conn = domain->conn;
1182 1183 1184 1185
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1186

1187 1188
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1189

1190 1191
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
}

/**
 * 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
1204 1205
virDomainFree(virDomainPtr domain)
{
1206 1207
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1208
    if (!VIR_IS_DOMAIN(domain)) {
1209
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1210
        return (-1);
D
Daniel Veillard 已提交
1211
    }
1212
    if (virUnrefDomain(domain) < 0)
1213 1214
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1215 1216 1217
}

/**
1218
 * virDomainSuspend:
D
Daniel Veillard 已提交
1219 1220 1221 1222
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
 * to CPU resources and I/O but the memory used by the domain at the 
1223
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1224
 * the domain.
1225
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
1226 1227 1228 1229
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1230 1231
virDomainSuspend(virDomainPtr domain)
{
1232
    virConnectPtr conn;
1233
    DEBUG("domain=%p", domain);
1234

D
Daniel Veillard 已提交
1235
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1236
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1237
        return (-1);
D
Daniel Veillard 已提交
1238
    }
1239 1240 1241 1242
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1243

1244 1245
    conn = domain->conn;

1246 1247
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1248

1249 1250
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1251 1252 1253
}

/**
1254
 * virDomainResume:
D
Daniel Veillard 已提交
1255 1256 1257
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1258
 * it was frozen by calling virSuspendDomain().
1259
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1260 1261 1262 1263
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1264 1265
virDomainResume(virDomainPtr domain)
{
1266
    virConnectPtr conn;
1267
    DEBUG("domain=%p", domain);
1268

D
Daniel Veillard 已提交
1269
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1270
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1271
        return (-1);
D
Daniel Veillard 已提交
1272
    }
1273 1274 1275 1276
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1277

1278 1279
    conn = domain->conn;

1280 1281
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1282

1283 1284
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1285 1286
}

1287 1288 1289 1290 1291 1292
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1293 1294 1295
 * 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.
1296 1297 1298 1299
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1300 1301
virDomainSave(virDomainPtr domain, const char *to)
{
1302
    char filepath[4096];
1303
    virConnectPtr conn;
1304
    DEBUG("domain=%p, to=%s", domain, to);
1305

D
Daniel Veillard 已提交
1306
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1307
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1308
        return (-1);
D
Daniel Veillard 已提交
1309
    }
1310 1311 1312 1313
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1314
    conn = domain->conn;
D
Daniel Veillard 已提交
1315 1316
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1317
        return (-1);
D
Daniel Veillard 已提交
1318
    }
1319

1320 1321 1322 1323 1324
    /*
     * 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] != '/') {
1325
        unsigned int len, t;
1326

1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
        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];
1337 1338 1339

    }

1340 1341 1342
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1343
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1344
    return -1;
1345 1346 1347 1348
}

/**
 * virDomainRestore:
1349
 * @conn: pointer to the hypervisor connection
1350 1351 1352 1353 1354 1355 1356
 * @from: path to the 
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1357 1358
virDomainRestore(virConnectPtr conn, const char *from)
{
1359
    char filepath[4096];
1360
    DEBUG("conn=%p, from=%s", conn, from);
1361

D
Daniel Veillard 已提交
1362
    if (!VIR_IS_CONNECT(conn)) {
1363
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1364
        return (-1);
D
Daniel Veillard 已提交
1365
    }
1366 1367 1368 1369
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1370 1371
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1372
        return (-1);
D
Daniel Veillard 已提交
1373 1374
    }

1375 1376 1377 1378 1379
    /*
     * 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] != '/') {
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
        unsigned int len, t;

        t = strlen(from);
        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], from);
        from = &filepath[0];
    }

1394 1395 1396
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1397
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1398
    return -1;
D
Daniel Veillard 已提交
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1421
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    }

1454 1455 1456
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1457
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1458
    return -1;
1459 1460
}

1461 1462 1463 1464 1465
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1466 1467
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1468 1469 1470 1471 1472 1473 1474
 *
 * 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
1475 1476
virDomainShutdown(virDomainPtr domain)
{
1477
    virConnectPtr conn;
1478
    DEBUG("domain=%p", domain);
1479

D
Daniel Veillard 已提交
1480
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1481
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1482
        return (-1);
D
Daniel Veillard 已提交
1483
    }
1484 1485 1486 1487
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1488

1489 1490
    conn = domain->conn;

1491 1492
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1493

1494
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1495
    return -1;
1496 1497
}

1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
/**
 * 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)
{
1512
    virConnectPtr conn;
1513
    DEBUG("domain=%p, flags=%u", domain, flags);
1514 1515

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1516
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1517 1518
        return (-1);
    }
1519 1520 1521 1522
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1523

1524 1525
    conn = domain->conn;

1526 1527
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1528

1529
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1530
    return -1;
1531 1532
}

1533
/**
1534
 * virDomainGetName:
1535 1536 1537 1538 1539 1540 1541 1542
 * @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 *
1543 1544
virDomainGetName(virDomainPtr domain)
{
1545 1546
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1547
    if (!VIR_IS_DOMAIN(domain)) {
1548
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1549
        return (NULL);
D
Daniel Veillard 已提交
1550
    }
1551
    return (domain->name);
1552 1553
}

1554 1555 1556
/**
 * virDomainGetUUID:
 * @domain: a domain object
1557
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1558 1559 1560 1561 1562 1563
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1564 1565
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1566 1567
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1568
    if (!VIR_IS_DOMAIN(domain)) {
1569
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1570
        return (-1);
D
Daniel Veillard 已提交
1571 1572 1573
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1574
        return (-1);
D
Daniel Veillard 已提交
1575 1576
    }

1577
    if (domain->id == 0) {
1578
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1579
    } else {
1580
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1581 1582
    }
    return (0);
1583 1584
}

K
Karel Zak 已提交
1585 1586 1587
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1588
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1589 1590 1591 1592 1593 1594 1595 1596 1597
 *
 * Get the UUID for a domain as string. For more information about 
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1598
    unsigned char uuid[VIR_UUID_BUFLEN];
1599
    DEBUG("domain=%p, buf=%p", domain, buf);
1600

K
Karel Zak 已提交
1601
    if (!VIR_IS_DOMAIN(domain)) {
1602
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1603 1604 1605 1606 1607 1608 1609 1610
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    
    if (virDomainGetUUID(domain, &uuid[0]))
1611
        return (-1);
K
Karel Zak 已提交
1612

1613
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1614 1615 1616
    return (0);
}

1617
/**
1618
 * virDomainGetID:
1619 1620 1621 1622 1623 1624 1625
 * @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
1626 1627
virDomainGetID(virDomainPtr domain)
{
1628 1629
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1630
    if (!VIR_IS_DOMAIN(domain)) {
1631
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1632
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1633
    }
1634
    return (domain->id);
1635 1636
}

1637 1638 1639 1640 1641 1642
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1643 1644
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1645 1646
 */
char *
1647 1648
virDomainGetOSType(virDomainPtr domain)
{
1649
    virConnectPtr conn;
1650
    DEBUG("domain=%p", domain);
1651

D
Daniel Veillard 已提交
1652
    if (!VIR_IS_DOMAIN(domain)) {
1653
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1654
        return (NULL);
D
Daniel Veillard 已提交
1655
    }
1656

1657 1658 1659 1660
    conn = domain->conn;

    if (conn->driver->domainGetOSType)
        return conn->driver->domainGetOSType (domain);
1661

1662
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1663
    return NULL;
1664 1665
}

1666
/**
1667
 * virDomainGetMaxMemory:
1668 1669 1670 1671 1672 1673 1674 1675 1676
 * @domain: a domain object or NULL
 * 
 * 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
1677 1678
virDomainGetMaxMemory(virDomainPtr domain)
{
1679
    virConnectPtr conn;
1680
    DEBUG("domain=%p", domain);
1681

D
Daniel Veillard 已提交
1682
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1683
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1684
        return (0);
D
Daniel Veillard 已提交
1685
    }
1686

1687 1688
    conn = domain->conn;

1689 1690 1691
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1692
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1693
    return 0;
1694 1695
}

D
Daniel Veillard 已提交
1696
/**
1697
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1698 1699 1700 1701 1702 1703
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
 * 
 * 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.
1704
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1705 1706 1707 1708
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1709 1710
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1711
    virConnectPtr conn;
1712
    DEBUG("domain=%p, memory=%lu", domain, memory);
1713

1714 1715 1716 1717 1718
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1719
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1720
        return (-1);
1721
    }
1722 1723 1724 1725 1726 1727 1728 1729
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1730
    conn = domain->conn;
1731

1732 1733 1734
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

1735
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1736
    return -1;
1737
}
1738

1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
 * 
 * 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.
 * This function may requires priviledged access to the hypervisor.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
1755
    DEBUG("domain=%p, memory=%lu", domain, memory);
1756

1757 1758 1759 1760 1761
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1762
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1763
        return (-1);
1764
    }
1765 1766 1767 1768 1769 1770
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1771
        return (-1);
1772 1773 1774
    }

    conn = domain->conn;
1775

1776 1777 1778
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

1779
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1780
    return -1;
D
Daniel Veillard 已提交
1781 1782
}

1783 1784
/**
 * virDomainGetInfo:
1785
 * @domain: a domain object
1786 1787 1788
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1789
 * used to get the domain is limited only a partial set of the information
1790 1791 1792 1793 1794
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1795 1796
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1797
    virConnectPtr conn;
1798
    DEBUG("domain=%p, info=%p", domain, info);
1799

D
Daniel Veillard 已提交
1800
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1801
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1802
        return (-1);
D
Daniel Veillard 已提交
1803 1804 1805
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1806
        return (-1);
D
Daniel Veillard 已提交
1807
    }
1808

1809
    memset(info, 0, sizeof(virDomainInfo));
1810

1811 1812 1813 1814
    conn = domain->conn;

    if (conn->driver->domainGetInfo)
        return conn->driver->domainGetInfo (domain, info);
1815

1816
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1817
    return -1;
1818
}
1819

1820 1821 1822
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
1823
 * @flags: an OR'ed set of virDomainXMLFlags
1824 1825 1826 1827 1828 1829 1830 1831
 *
 * Provide an XML description of the domain. The description may be reused
 * later to relaunch the domain with virDomainCreateLinux().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
1832 1833
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1834
    virConnectPtr conn;
1835
    DEBUG("domain=%p, flags=%d", domain, flags);
1836

D
Daniel Veillard 已提交
1837
    if (!VIR_IS_DOMAIN(domain)) {
1838
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1839
        return (NULL);
D
Daniel Veillard 已提交
1840
    }
1841

1842 1843 1844 1845 1846
    conn = domain->conn;

    if (conn->driver->domainDumpXML)
        return conn->driver->domainDumpXML (domain, flags);

1847
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1848
    return NULL;
1849
}
1850

1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915
/**
 * virDomainMigrate:
 * @domain: a domain object
 * @dconn: destination host (a connection object)
 * @flags: flags
 * @dname: (optional) rename domain to this at destination
 * @uri: (optional) dest hostname/URI as seen from the source host
 * @bandwidth: (optional) specify migration bandwidth limit in Mbps
 *
 * Migrate the domain object from its current host to the destination
 * host given by dconn (a connection to the destination host).
 *
 * Flags may be one of more of the following:
 *   VIR_MIGRATE_LIVE   Attempt a live migration.
 *
 * If a hypervisor supports renaming domains during migration,
 * then you may set the dname parameter to the new name (otherwise
 * it keeps the same name).  If this is not supported by the
 * hypervisor, dname must be NULL or else you will get an error.
 *
 * Since typically the two hypervisors connect directly to each
 * other in order to perform the migration, you may need to specify
 * a path from the source to the destination.  This is the purpose
 * of the uri parameter.  If uri is NULL, then libvirt will try to
 * find the best method.  Uri may specify the hostname or IP address
 * of the destination host as seen from the source.  Or uri may be
 * a URI giving transport, hostname, user, port, etc. in the usual
 * form.  Refer to driver documentation for the particular URIs
 * supported.
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter.  If set to 0,
 * libvirt will choose a suitable default.  Some hypervisors do
 * not support this feature and will return an error if bandwidth
 * is not 0.
 *
 * To see which features are supported by the current hypervisor,
 * see virConnectGetCapabilities, /capabilities/host/migration_features.
 *
 * There are many limitations on migration imposed by the underlying
 * technology - for example it may not be possible to migrate between
 * different processors even with the same architecture, or between
 * different types of hypervisor.
 *
 * Returns the new domain object if the migration was successful,
 *   or NULL in case of error.  Note that the new domain object
 *   exists in the scope of the destination connection (dconn).
 */
virDomainPtr
virDomainMigrate (virDomainPtr domain,
                  virConnectPtr dconn,
                  unsigned long flags,
                  const char *dname,
                  const char *uri,
                  unsigned long bandwidth)
{
    virConnectPtr conn;
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
    int cookielen = 0, ret;
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
1916
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    /* Check that migration is supported by both drivers. */
    if (!VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn,
                                   VIR_DRV_FEATURE_MIGRATION_V1) ||
        !VIR_DRV_SUPPORTS_FEATURE (dconn->driver, dconn,
                                   VIR_DRV_FEATURE_MIGRATION_V1)) {
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
        return NULL;
    }

    /* 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.
     */
    ret = dconn->driver->domainMigratePrepare
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname, bandwidth);
    if (ret == -1) goto done;
    if (uri == NULL && uri_out == NULL) {
        virLibConnError (conn, VIR_ERR_INTERNAL_ERROR,
                         "domainMigratePrepare did not set uri");
        goto done;
    }
    if (uri_out) uri = uri_out; /* Did domainMigratePrepare change URI? */

    assert (uri != NULL);

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

    if (ret == -1) goto done;

    /* Get the destination domain and return it or error.
     * 'domain' no longer actually exists at this point (or so we hope), but
     * we still use the object in memory in order to get the name.
     */
    dname = dname ? dname : domain->name;
    if (dconn->driver->domainMigrateFinish)
        ddomain = dconn->driver->domainMigrateFinish
            (dconn, dname, cookie, cookielen, uri, flags);
    else
        ddomain = virDomainLookupByName (dconn, dname);

 done:
    if (uri_out) free (uri_out);
    if (cookie) free (cookie);
    return ddomain;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
__virDomainMigratePrepare (virConnectPtr dconn,
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, flags=%lu, dname=%s, bandwidth=%lu", dconn, cookie, cookielen, uri_in, uri_out, flags, dname, bandwidth);

    if (!VIR_IS_CONNECT (dconn)) {
1998
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
        return -1;
    }

    if (dconn->driver->domainMigratePrepare)
        return dconn->driver->domainMigratePrepare (dconn, cookie, cookielen,
                                                    uri_in, uri_out,
                                                    flags, dname, bandwidth);

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
__virDomainMigratePerform (virDomainPtr domain,
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
    DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags, dname, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2027
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
        return -1;
    }
    conn = domain->conn;

    if (conn->driver->domainMigratePerform)
        return conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                   uri,
                                                   flags, dname, bandwidth);

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
virDomainPtr
__virDomainMigrateFinish (virConnectPtr dconn,
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
    DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, flags=%lu", dconn, dname, cookie, cookielen, uri, flags);

    if (!VIR_IS_CONNECT (dconn)) {
2055
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068
        return NULL;
    }

    if (dconn->driver->domainMigrateFinish)
        return dconn->driver->domainMigrateFinish (dconn, dname,
                                                   cookie, cookielen,
                                                   uri, flags);

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}


2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
 * 
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2079 2080
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2081 2082
    DEBUG("conn=%p, info=%p", conn, info);

2083
    if (!VIR_IS_CONNECT(conn)) {
2084
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2085 2086 2087 2088 2089 2090 2091
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2092 2093 2094
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2095
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2096
    return -1;
2097
}
2098

2099 2100 2101 2102 2103 2104
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2105 2106
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2107 2108 2109 2110 2111
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2112 2113
    DEBUG("conn=%p", conn);

2114
    if (!VIR_IS_CONNECT (conn)) {
2115
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2116 2117 2118
        return NULL;
    }

2119 2120
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2121

2122
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2123 2124 2125
    return NULL;
}

2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
 * 
 * provides the free memory availble on the Node
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2137 2138
    DEBUG("conn=%p", conn);

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

    if (conn->driver->getFreeMemory)
        return conn->driver->getFreeMemory (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return 0;
}

2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
/**
 * 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;
2165
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2166 2167

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2168
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2169 2170 2171 2172 2173 2174 2175 2176 2177
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
        return schedtype;
    }

2178
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
    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,
				virSchedParameterPtr params, int *nparams)
{
    virConnectPtr conn;
2202
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2203 2204

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2205
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2206 2207 2208 2209 2210 2211 2212
        return -1;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerParameters)
        return conn->driver->domainGetSchedulerParameters (domain, params, nparams);

2213
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
    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
virDomainSetSchedulerParameters(virDomainPtr domain, 
				virSchedParameterPtr params, int nparams)
{
    virConnectPtr conn;
2234
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2235 2236

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2237
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2238 2239 2240 2241 2242 2243 2244
        return -1;
    }
    conn = domain->conn;

    if (conn->driver->domainSetSchedulerParameters)
        return conn->driver->domainSetSchedulerParameters (domain, params, nparams);

2245
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2246 2247 2248 2249
    return -1;
}


2250
/**
2251
 * virDomainBlockStats:
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
 * @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);

    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
2286
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
        return -1;
    }
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
            return -1;

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/**
2304
 * virDomainInterfaceStats:
2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
 * @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);

    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
2338
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
        return -1;
    }
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
            return -1;

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}



2357

2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374
/************************************************************************
 *									*
 *		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
 *
 * define a domain, but does not start it
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
2375 2376
    DEBUG("conn=%p, xml=%s", conn, xml);

2377
    if (!VIR_IS_CONNECT(conn)) {
2378
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2379 2380
        return (NULL);
    }
2381 2382 2383 2384
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
2385 2386 2387 2388 2389
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2390 2391
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2392

2393
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2394
    return NULL;
2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
 * undefine a domain but does not stop it if it is running
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
2407
    virConnectPtr conn;
2408
    DEBUG("domain=%p", domain);
2409 2410

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2411
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2412 2413
        return (-1);
    }
2414 2415
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2416 2417 2418 2419
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

2420 2421
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2422

2423
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2424
    return -1;
2425 2426 2427 2428 2429 2430
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2431
 * Provides the number of inactive domains.
2432 2433 2434 2435 2436 2437
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2438 2439
    DEBUG("conn=%p", conn);

2440
    if (!VIR_IS_CONNECT(conn)) {
2441
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2442 2443 2444
        return (-1);
    }

2445 2446
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2447

2448
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2449
    return -1;
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
 * list the defined domains, stores the pointers to the names in @names
 * 
 * Returns the number of names provided in the array or -1 in case of error
 */
int
2463
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2464
                             int maxnames) {
2465 2466
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2467
    if (!VIR_IS_CONNECT(conn)) {
2468
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2469 2470 2471
        return (-1);
    }

2472
    if ((names == NULL) || (maxnames < 0)) {
2473 2474 2475 2476
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2477 2478
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2479

2480
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2481
    return -1;
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
}

/**
 * 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) {
2495
    virConnectPtr conn;
2496
    DEBUG("domain=%p", domain);
2497

2498 2499 2500 2501
    if (domain == NULL) {
        TODO
	return (-1);
    }
2502
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2503
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2504 2505
        return (-1);
    }
2506 2507
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2508 2509 2510
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2511

2512 2513 2514
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2515
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2516
    return -1;
2517 2518
}

2519 2520 2521
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2522
 * @autostart: the value returned
2523
 *
2524
 * Provides a boolean value indicating whether the domain
2525 2526 2527 2528 2529 2530 2531
 * 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,
2532 2533 2534
                      int *autostart)
{
    virConnectPtr conn;
2535
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2536 2537

    if (!VIR_IS_DOMAIN(domain)) {
2538
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2539 2540 2541 2542 2543 2544 2545
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2546 2547 2548 2549 2550
    conn = domain->conn;

    if (conn->driver->domainGetAutostart)
        return conn->driver->domainGetAutostart (domain, autostart);

2551
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2552
    return -1;
2553 2554 2555 2556 2557
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
2558
 * @autostart: whether the domain should be automatically started 0 or 1
2559 2560 2561 2562 2563 2564 2565 2566
 *
 * 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,
2567 2568 2569
                      int autostart)
{
    virConnectPtr conn;
2570
    DEBUG("domain=%p, autostart=%d", domain, autostart);
2571 2572

    if (!VIR_IS_DOMAIN(domain)) {
2573
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2574 2575 2576
        return (-1);
    }

2577 2578 2579 2580 2581
    conn = domain->conn;

    if (conn->driver->domainSetAutostart)
        return conn->driver->domainSetAutostart (domain, autostart);

2582
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2583
    return -1;
2584 2585
}

2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
/**
 * 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.
 * This function requires priviledged access to the hypervisor.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
2602
    virConnectPtr conn;
2603
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
2604

2605 2606 2607 2608 2609
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2610
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2611 2612
        return (-1);
    }
2613 2614 2615 2616
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2617

2618 2619 2620 2621
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2622
    conn = domain->conn;
2623

2624 2625
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
2626

2627
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2628
    return -1;
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652
}

/**
 * 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.
 * 
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
 * This function requires priviledged access to the hypervisor.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
2653
    virConnectPtr conn;
2654
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
2655

2656 2657 2658 2659 2660
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2661
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2662 2663
        return (-1);
    }
2664 2665 2666 2667
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2668

2669
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
2670 2671 2672
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2673

2674 2675
    conn = domain->conn;

2676 2677 2678
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

2679
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2680
    return -1;
2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707
}

/**
 * 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)
 *	If cpumaps is NULL, then no cupmap information is returned by the API.
 *	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...).
 * 
 * Extract information about virtual CPUs of domain, store it in info array
 * and also in cpumaps if this pointer is'nt NULL.
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
		  unsigned char *cpumaps, int maplen)
{
2708
    virConnectPtr conn;
2709
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
2710 2711 2712 2713 2714 2715

    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2716
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2717 2718 2719 2720 2721 2722 2723 2724 2725 2726
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2727

2728 2729
    conn = domain->conn;

2730 2731 2732 2733
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

2734
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2735
    return -1;
2736
}
2737

2738 2739 2740 2741
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
 * 
2742 2743 2744 2745 2746
 * 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.
2747 2748 2749 2750
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
2751 2752
virDomainGetMaxVcpus(virDomainPtr domain)
{
2753
    virConnectPtr conn;
2754
    DEBUG("domain=%p", domain);
2755 2756

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2757
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2758 2759 2760 2761 2762
        return (-1);
    }

    conn = domain->conn;

2763 2764 2765
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

2766
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2767
    return -1;
2768 2769 2770
}


2771 2772 2773 2774 2775 2776 2777 2778 2779 2780
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * 
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
2781
virDomainAttachDevice(virDomainPtr domain, const char *xml)
2782 2783
{
    virConnectPtr conn;
2784
    DEBUG("domain=%p, xml=%s", domain, xml);
2785 2786

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2787
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2788 2789 2790 2791 2792 2793 2794 2795
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2796 2797 2798
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

2799
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2800
    return -1;
2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * 
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
2813
virDomainDetachDevice(virDomainPtr domain, const char *xml)
2814 2815
{
    virConnectPtr conn;
2816
    DEBUG("domain=%p, xml=%s", domain, xml);
2817 2818

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2819
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2820 2821 2822 2823 2824 2825 2826 2827
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2828 2829 2830
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

2831
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2832
    return -1;
2833
}
2834

2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
/**
 * virNodeGetCellsFreeMemory:
 * @conn: pointer to the hypervisor connection
 * @freeMems: pointer to the array of unsigned long long
 * @startCell: index of first cell to return freeMems info on.
 * @maxCells: Maximum number of cells for which freeMems information can
 *            be returned.
 *
 * This call returns the amount of free memory in one or more NUMA cells.
 * The @freeMems array must be allocated by the caller and will be filled
 * with the amount of free memory in kilobytes for each cell requested,
 * starting with startCell (in freeMems[0]), up to either
 * (startCell + maxCells), or the number of additional cells in the node,
 * whichever is smaller.
 *
 * Returns the number of entries filled in freeMems, or -1 in case of error.
 */

int
virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems,
                          int startCell, int maxCells)
{
2857 2858 2859
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

2860 2861 2862 2863 2864
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
2865
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (conn->driver->nodeGetCellsFreeMemory)
        return conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

2877 2878 2879 2880
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
2881
 * Provides the connection pointer associated with a network.  The
2882 2883 2884
 * reference counter on the connection is not increased by this
 * call.
 *
2885 2886 2887 2888
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
2889 2890 2891 2892 2893
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
2894 2895
    DEBUG("net=%p", net);

2896
    if (!VIR_IS_NETWORK (net)) {
2897
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
2898 2899 2900 2901 2902
        return NULL;
    }
    return net->conn;
}

2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913
/**
 * 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)
{
2914 2915
    DEBUG("conn=%p", conn);

2916
    if (!VIR_IS_CONNECT(conn)) {
2917
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2918 2919 2920
        return (-1);
    }

2921 2922
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
2923

2924
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2925
    return -1;
2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
}

/**
 * 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
2939
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
2940
{
2941 2942
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2943
    if (!VIR_IS_CONNECT(conn)) {
2944
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2945 2946 2947
        return (-1);
    }

2948
    if ((names == NULL) || (maxnames < 0)) {
2949 2950 2951 2952
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2953 2954
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
2955

2956
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2957
    return -1;
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970
}

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

2973
    if (!VIR_IS_CONNECT(conn)) {
2974
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2975 2976 2977
        return (-1);
    }

2978 2979
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
2980

2981
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2982
    return -1;
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995
}

/**
 * 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
2996
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
2997 2998
                              int maxnames)
{
2999 3000
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3001
    if (!VIR_IS_CONNECT(conn)) {
3002
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3003 3004 3005
        return (-1);
    }

3006
    if ((names == NULL) || (maxnames < 0)) {
3007 3008 3009 3010
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3011 3012 3013
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3014

3015
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3016
    return -1;
3017 3018 3019 3020 3021 3022 3023 3024 3025
}

/**
 * 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.
 *
3026 3027
 * 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.
3028 3029 3030 3031
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3032 3033
    DEBUG("conn=%p, name=%s", conn, name);

3034
    if (!VIR_IS_CONNECT(conn)) {
3035
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3036 3037 3038 3039 3040 3041 3042
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3043 3044 3045
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

3046
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3047
    return NULL;
3048 3049 3050 3051 3052 3053 3054 3055 3056
}

/**
 * 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.
 *
3057 3058
 * 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.
3059 3060 3061 3062
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3063 3064
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3065
    if (!VIR_IS_CONNECT(conn)) {
3066
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3067 3068 3069 3070 3071 3072 3073
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3074 3075
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3076

3077
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3078
    return NULL;
3079 3080 3081 3082 3083 3084 3085 3086 3087
}

/**
 * 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.
 *
3088 3089
 * 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.
3090 3091 3092 3093 3094 3095 3096
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3097
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3098 3099

    if (!VIR_IS_CONNECT(conn)) {
3100
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    /* 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) {
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

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

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

3147
    if (!VIR_IS_CONNECT(conn)) {
3148
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }

3160 3161 3162
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3163
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3164
    return NULL;
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176
}

/**
 * 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
3177 3178
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3179 3180
    DEBUG("conn=%p, xml=%s", conn, xml);

3181
    if (!VIR_IS_CONNECT(conn)) {
3182
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3194 3195
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3196

3197
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3198
    return NULL;
3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3215
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3216 3217 3218 3219 3220 3221 3222 3223
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3224 3225
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3226

3227
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3228
    return -1;
3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240
}

/**
 * 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
3241 3242
virNetworkCreate(virNetworkPtr network)
{
3243
    virConnectPtr conn;
3244 3245
    DEBUG("network=%p", network);

3246 3247 3248 3249 3250
    if (network == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3251
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3252 3253 3254 3255 3256 3257 3258 3259
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3260 3261 3262
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3263
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3264
    return -1;
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
 * already and all resources used by it are given back to the hypervisor.
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
 * This function may requires priviledged access
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
3283
    DEBUG("network=%p", network);
3284 3285

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3286
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3287 3288 3289 3290 3291 3292 3293 3294 3295
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3296 3297
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3298

3299
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3300
    return -1;
3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314
}

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

3317
    if (!VIR_IS_NETWORK(network)) {
3318
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3319 3320
        return (-1);
    }
3321
    if (virUnrefNetwork(network) < 0)
3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337
        return (-1);
    return(0);
}

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

3340
    if (!VIR_IS_NETWORK(network)) {
3341
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358
        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)
{
3359 3360
    DEBUG("network=%p, uuid=%p", network, uuid);

3361
    if (!VIR_IS_NETWORK(network)) {
3362
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    return (0);
}

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

    if (!VIR_IS_NETWORK(network)) {
3392
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3393 3394 3395 3396 3397 3398 3399 3400
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
3401
        return (-1);
3402

3403
    virUUIDFormat(uuid, buf);
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420
    return (0);
}

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

3424
    if (!VIR_IS_NETWORK(network)) {
3425
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3426 3427 3428 3429 3430 3431 3432
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3433 3434 3435 3436 3437
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkDumpXML)
        return conn->networkDriver->networkDumpXML (network, flags);

3438
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3439
    return NULL;
3440
}
3441 3442 3443 3444 3445

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3446
 * Provides a bridge interface name to which a domain may connect
3447 3448 3449 3450 3451 3452 3453 3454
 * 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)
{
3455
    virConnectPtr conn;
3456
    DEBUG("network=%p", network);
3457

3458
    if (!VIR_IS_NETWORK(network)) {
3459
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3460 3461 3462
        return (NULL);
    }

3463 3464 3465 3466 3467
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName)
        return conn->networkDriver->networkGetBridgeName (network);

3468
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3469
    return NULL;
3470
}
3471 3472 3473 3474

/**
 * virNetworkGetAutostart:
 * @network: a network object
3475
 * @autostart: the value returned
3476
 *
3477
 * Provides a boolean value indicating whether the network
3478 3479 3480 3481 3482 3483 3484
 * 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,
3485 3486 3487
                       int *autostart)
{
    virConnectPtr conn;
3488
    DEBUG("network=%p, autostart=%p", network, autostart);
3489 3490

    if (!VIR_IS_NETWORK(network)) {
3491
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3492 3493 3494 3495 3496 3497 3498
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3499 3500 3501 3502 3503
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkGetAutostart)
        return conn->networkDriver->networkGetAutostart (network, autostart);

3504
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3505
    return -1;
3506 3507 3508 3509 3510
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3511
 * @autostart: whether the network should be automatically started 0 or 1
3512 3513 3514 3515 3516 3517 3518 3519
 *
 * 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,
3520 3521 3522
                       int autostart)
{
    virConnectPtr conn;
3523
    DEBUG("network=%p, autostart=%d", network, autostart);
3524 3525

    if (!VIR_IS_NETWORK(network)) {
3526
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3527 3528 3529
        return (-1);
    }

3530 3531 3532 3533 3534
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkSetAutostart)
        return conn->networkDriver->networkSetAutostart (network, autostart);

3535
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3536
    return -1;
3537
}
3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551

/*
 * vim: set tabstop=4:
 * vim: set shiftwidth=4:
 * vim: set expandtab:
 */
/*
 * Local variables:
 *  indent-tabs-mode: nil
 *  c-indent-level: 4
 *  c-basic-offset: 4
 *  tab-width: 4
 * End:
 */