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

D
Daniel Veillard 已提交
27
#include "internal.h"
28
#include "driver.h"
29

30
#include "uuid.h"
31
#include "test.h"
32
#include "xen_unified.h"
33
#include "remote_internal.h"
34
#include "qemu_driver.h"
35 36 37
#ifdef WITH_OPENVZ
#include "openvz_driver.h"
#endif
38

D
Daniel Veillard 已提交
39 40 41 42 43 44
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
 * - use reference counting to garantee coherent pointer state ?
 */

45
static virDriverPtr virDriverTab[MAX_DRIVERS];
46
static int virDriverTabCount = 0;
47
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
48
static int virNetworkDriverTabCount = 0;
49 50
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
51 52
static int initialized = 0;

53 54 55 56 57 58 59 60 61 62 63 64 65
/* If configured with --enable-debug=yes then library calls
 * are printed to stderr for debugging.
 */
#ifdef ENABLE_DEBUG
#define DEBUG(fs,...)                                                   \
    fprintf (stderr, "libvirt: %s (" fs ")\n", __func__, __VA_ARGS__)
#define DEBUG0                                                          \
    fprintf (stderr, "libvirt: %s ()\n", __func__)
#else
#define DEBUG0
#define DEBUG(fs,...)
#endif /* !ENABLE_DEBUG */

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 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
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;

        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;
            }
            if (buf[strlen(buf)-1] == '\n')
                buf[strlen(buf)-1] = '\0';
            break;

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

        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;

147 148 149 150 151 152 153 154 155 156 157 158
/**
 * 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)
{
159
    DEBUG0;
160 161
    if (initialized)
        return(0);
162
    initialized = 1;
163

164 165 166
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

167
    /*
168 169
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
170
     */
171
#ifdef WITH_TEST
172
    if (testRegister() == -1) return -1;
173
#endif
174
#ifdef WITH_QEMU 
175
    if (qemudRegister() == -1) return -1;
176
#endif
177 178
#ifdef WITH_XEN
    if (xenUnifiedRegister () == -1) return -1;
179
#endif
180 181 182
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
#endif
183 184
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
185
#endif
D
Daniel P. Berrange 已提交
186

187 188 189 190 191
    return(0);
}



D
Daniel Veillard 已提交
192 193 194
/**
 * virLibConnError:
 * @conn: the connection if available
195
 * @error: the error number
D
Daniel Veillard 已提交
196 197 198 199 200
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
201 202
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
203
    const char *errmsg;
204

D
Daniel Veillard 已提交
205 206 207 208
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
209
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
210 211 212 213
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
214
 * virLibConnWarning:
D
Daniel Veillard 已提交
215
 * @conn: the connection if available
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
 * @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 已提交
238 239 240 241 242
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
243 244 245
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
246 247
    virConnectPtr conn = NULL;
    const char *errmsg;
248

D
Daniel Veillard 已提交
249 250 251 252 253 254 255
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
256
    __virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
257 258 259
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

260
/**
261 262 263 264
 * virLibNetworkError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
265
 *
266
 * Handle an error at the connection level
267
 */
268 269 270 271 272 273 274 275 276 277 278 279 280 281
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;
    }
282
    __virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
283 284 285 286 287 288 289 290 291 292 293 294 295 296
                    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)
{
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
    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++;
312 313 314 315 316 317 318 319 320 321 322 323 324
}

/**
 * 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)
{
325 326 327 328 329 330 331 332 333 334 335 336 337
    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);
    }

338 339 340 341 342 343 344
    if (driver->no < 0) {
    	virLibConnError
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

345 346
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
347 348
}

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

380 381 382
    if (virInitialize() < 0)
        return -1;

383 384 385 386
    if (virInitialize() < 0)
        return -1;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
387 388
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
389 390 391 392 393 394 395 396 397
            ret = -1;
    }
    return ret;
}

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
398 399
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
400 401 402 403 404 405 406 407 408
            ret = -1;
    }
    return ret;
}

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
409 410
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
411 412 413 414 415 416 417 418 419
            ret = -1;
    }
    return ret;
}

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

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



429 430 431
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
432
 * @type: the type of connection/driver looked at
433 434 435 436 437 438 439 440 441 442 443 444
 * @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
445 446 447
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
448
    int i;
449
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
450

451
    if (!initialized)
452 453
        if (virInitialize() < 0)
	    return -1;
454

455
    if (libVer == NULL)
456
        return (-1);
457 458 459
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
460 461
        if (type == NULL)
	    type = "Xen";
462
	for (i = 0;i < virDriverTabCount;i++) {
463
	    if ((virDriverTab[i] != NULL) &&
464
	        (!strcasecmp(virDriverTab[i]->name, type))) {
465 466 467 468
		*typeVer = virDriverTab[i]->ver;
		break;
	    }
	}
469
        if (i >= virDriverTabCount) {
470
            *typeVer = 0;
471
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
472 473 474 475
            return (-1);
        }
    }
    return (0);
476 477
}

478
static virConnectPtr
479 480 481
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
482
{
483
    int i, res;
484
    virConnectPtr ret = NULL;
485
    xmlURIPtr uri;
486

487 488 489 490 491 492 493 494
    /* 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:///";

495 496 497 498 499 500
    /* Convert xen:// -> xen:/// because xmlParseURI cannot parse the
     * former.  This allows URIs such as xen://localhost to work.
     */
    if (STREQ (name, "xen://"))
        name = "xen:///";

501
    if (!initialized)
502 503
        if (virInitialize() < 0)
	    return NULL;
504

505
    ret = virGetConnect();
506
    if (ret == NULL) {
507
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
508 509 510 511 512 513 514
        return NULL;
    }

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

518
#ifdef ENABLE_DEBUG
519 520 521 522 523 524 525 526 527 528 529 530
    fprintf (stderr,
             "libvirt: do_open: 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);
531 532
#endif

533 534 535 536 537 538
    ret->name = strdup (name);
    if (!ret->name) {
        virLibConnError (ret, VIR_ERR_NO_MEMORY, "allocating conn->name");
        goto failed;
    }

539
    for (i = 0; i < virDriverTabCount; i++) {
540 541 542 543
#ifdef ENABLE_DEBUG
        fprintf (stderr, "libvirt: do_open: trying driver %d (%s) ...\n",
                 i, virDriverTab[i]->name);
#endif
544
        res = virDriverTab[i]->open (ret, uri, auth, flags);
545
#ifdef ENABLE_DEBUG
546 547
        fprintf (stderr, "libvirt: do_open: driver %d %s returned %s\n",
                 i, virDriverTab[i]->name,
548 549 550 551
                 res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
                 (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
                  (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
552 553 554 555 556
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
557 558
    }

559
    if (!ret->driver) {
560 561
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
562
        goto failed;
563 564
    }

565
    for (i = 0; i < virNetworkDriverTabCount; i++) {
566
        res = virNetworkDriverTab[i]->open (ret, uri, auth, flags);
567 568 569 570 571 572 573
#ifdef ENABLE_DEBUG
        fprintf (stderr, "libvirt: do_open: network driver %d %s returned %s\n",
                 i, virNetworkDriverTab[i]->name,
                 res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
                 (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
                  (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
574
        if (res == VIR_DRV_OPEN_ERROR) {
575 576 577 578
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK, 
                                   "Is the daemon running ?");
            }
579 580
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
581 582 583
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
584
    }
585

586 587
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;
588

589 590
    xmlFreeURI (uri);

591
    return ret;
592 593

failed:
594
    if (ret->name) free (ret->name);
595
    if (ret->driver) ret->driver->close (ret);
596
    if (uri) xmlFreeURI(uri);
597
	virFreeConnect(ret);
598
    return NULL;
599 600
}

601 602
/**
 * virConnectOpen:
603
 * @name: URI of the hypervisor
604 605 606 607 608
 *
 * 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
609 610
 *
 * URIs are documented at http://libvirt.org/uri.html
611 612 613 614
 */
virConnectPtr
virConnectOpen (const char *name)
{
615
    DEBUG("name=%s", name);
616
    return do_open (name, NULL, 0);
617 618
}

619
/**
620
 * virConnectOpenReadOnly:
621
 * @name: URI of the hypervisor
622
 *
623 624 625
 * 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.
626 627
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
628 629
 *
 * URIs are documented at http://libvirt.org/uri.html
630
 */
631
virConnectPtr
632 633
virConnectOpenReadOnly(const char *name)
{
634
    DEBUG("name=%s", name);
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
    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 已提交
659 660 661
}

/**
662
 * virConnectClose:
D
Daniel Veillard 已提交
663 664 665 666 667 668 669 670 671 672
 * @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
673 674
virConnectClose(virConnectPtr conn)
{
675 676
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
677
    if (!VIR_IS_CONNECT(conn))
678
        return (-1);
679 680 681

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
682
    conn->driver->close (conn);
683

684 685
    if (conn->name) free (conn->name);

686 687
    if (virFreeConnect(conn) < 0)
        return (-1);
688
    return (0);
D
Daniel Veillard 已提交
689 690
}

691 692 693 694 695 696 697 698 699 700 701 702 703 704
/* 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);
}

705 706 707 708 709 710 711
/**
 * 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.
712 713 714
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
715 716
 */
const char *
717 718
virConnectGetType(virConnectPtr conn)
{
719
    const char *ret;
720
    DEBUG("conn=%p", conn);
721

D
Daniel Veillard 已提交
722
    if (!VIR_IS_CONNECT(conn)) {
723
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
724
        return (NULL);
D
Daniel Veillard 已提交
725
    }
726 727 728 729

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
730
    }
731
    return conn->driver->name;
732 733
}

D
Daniel Veillard 已提交
734
/**
735
 * virConnectGetVersion:
D
Daniel Veillard 已提交
736
 * @conn: pointer to the hypervisor connection
737
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
738
 *
739 740 741
 * 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 已提交
742
 *
743 744 745
 * 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 已提交
746
 */
747
int
748 749
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
750 751
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
752
    if (!VIR_IS_CONNECT(conn)) {
753
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
754
        return (-1);
D
Daniel Veillard 已提交
755
    }
756

D
Daniel Veillard 已提交
757 758
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
759
        return (-1);
D
Daniel Veillard 已提交
760
    }
761

762 763
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
764

765 766
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
767 768
}

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
/**
 * 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)
{
784 785
    DEBUG("conn=%p", conn);

786
    if (!VIR_IS_CONNECT(conn)) {
787
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
        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)
{
816 817
    char *name;

818 819
    DEBUG("conn=%p", conn);

820
    if (!VIR_IS_CONNECT(conn)) {
821
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
822 823 824
        return NULL;
    }

825 826 827
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
828 829 830
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

831 832 833 834 835 836
    name = strdup (conn->name);
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
837 838
}

839 840 841 842 843
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
844
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
845 846 847 848 849 850 851 852 853
 * 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)
{
854 855
    DEBUG("conn=%p, type=%s", conn, type);

856
    if (!VIR_IS_CONNECT(conn)) {
857
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
858 859 860
        return (-1);
    }

861 862
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
863

864 865
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
866 867
}

868
/**
869
 * virConnectListDomains:
870 871 872 873 874 875 876 877 878
 * @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
879 880
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
881 882
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
883
    if (!VIR_IS_CONNECT(conn)) {
884
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
885
        return (-1);
D
Daniel Veillard 已提交
886
    }
887

888
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
889
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
890
        return (-1);
D
Daniel Veillard 已提交
891
    }
892

893 894
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
895

896 897
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
898 899
}

K
 
Karel Zak 已提交
900 901 902 903
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
904 905
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
906 907 908
 * Returns the number of domain found or -1 in case of error
 */
int
909 910
virConnectNumOfDomains(virConnectPtr conn)
{
911 912
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
913
    if (!VIR_IS_CONNECT(conn)) {
914
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
915
        return (-1);
D
Daniel Veillard 已提交
916
    }
K
Karel Zak 已提交
917

918 919
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
920

921 922
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
923 924
}

925 926 927 928
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
929
 * Provides the connection pointer associated with a domain.  The
930 931 932
 * reference counter on the connection is not increased by this
 * call.
 *
933 934 935 936
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
937 938 939 940 941
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
942 943
    DEBUG("dom=%p", dom);

944
    if (!VIR_IS_DOMAIN (dom)) {
945
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
946 947 948 949 950
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
951
/**
952
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
953
 * @conn: pointer to the hypervisor connection
954
 * @xmlDesc: an XML description of the domain
955
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
956
 *
957 958 959
 * 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 已提交
960 961 962
 * 
 * Returns a new domain object or NULL in case of failure
 */
963
virDomainPtr
964 965
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
966
{
967 968
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
969
    if (!VIR_IS_CONNECT(conn)) {
970
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
971
        return (NULL);
D
Daniel Veillard 已提交
972 973 974
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
975
        return (NULL);
D
Daniel Veillard 已提交
976
    }
977 978 979 980
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
981

982 983 984 985 986
    if (conn->driver->domainCreateLinux)
        return conn->driver->domainCreateLinux (conn, xmlDesc, flags);

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

989

990
/**
991
 * virDomainLookupByID:
992 993 994 995 996
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
 *
997 998
 * 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.
999
 */
1000
virDomainPtr
1001 1002
virDomainLookupByID(virConnectPtr conn, int id)
{
1003 1004
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1005
    if (!VIR_IS_CONNECT(conn)) {
1006
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1007
        return (NULL);
D
Daniel Veillard 已提交
1008 1009 1010
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1011
        return (NULL);
D
Daniel Veillard 已提交
1012
    }
1013

1014 1015
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1016

1017 1018
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1019 1020 1021 1022 1023
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1024
 * @uuid: the raw UUID for the domain
1025 1026 1027
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1028 1029
 * 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.
1030 1031
 */
virDomainPtr
1032 1033
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1034 1035
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1036
    if (!VIR_IS_CONNECT(conn)) {
1037
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1038
        return (NULL);
D
Daniel Veillard 已提交
1039 1040 1041
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1042
        return (NULL);
D
Daniel Veillard 已提交
1043
    }
1044

1045 1046
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1047

1048 1049
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1050 1051
}

K
Karel Zak 已提交
1052 1053 1054 1055 1056 1057 1058
/**
 * 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.
 *
1059 1060
 * 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 已提交
1061 1062 1063 1064
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1065 1066
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1067 1068
    int ret;

1069 1070
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1071
    if (!VIR_IS_CONNECT(conn)) {
1072
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
        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);
    
1094
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
1095 1096 1097
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
1098
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1099 1100 1101 1102 1103
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1104 1105 1106 1107 1108
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1109
 * Try to lookup a domain on the given hypervisor based on its name.
1110
 *
1111 1112
 * 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.
1113 1114
 */
virDomainPtr
1115 1116
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1117 1118
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1119
    if (!VIR_IS_CONNECT(conn)) {
1120
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1121
        return (NULL);
D
Daniel Veillard 已提交
1122 1123 1124
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1125
        return (NULL);
D
Daniel Veillard 已提交
1126
    }
1127

1128 1129 1130 1131 1132
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1133 1134
}

D
Daniel Veillard 已提交
1135
/**
1136
 * virDomainDestroy:
D
Daniel Veillard 已提交
1137 1138 1139 1140
 * @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.
1141 1142
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
1143
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1144 1145
 *
 * Returns 0 in case of success and -1 in case of failure.
1146
 */
D
Daniel Veillard 已提交
1147
int
1148 1149
virDomainDestroy(virDomainPtr domain)
{
1150
    virConnectPtr conn;
1151

1152 1153
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1154
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1155
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1156
        return (-1);
D
Daniel Veillard 已提交
1157
    }
1158

1159
    conn = domain->conn;
1160 1161 1162 1163
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1164

1165 1166
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1167

1168 1169
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
}

/**
 * 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
1182 1183
virDomainFree(virDomainPtr domain)
{
1184 1185
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1186
    if (!VIR_IS_DOMAIN(domain)) {
1187
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1188
        return (-1);
D
Daniel Veillard 已提交
1189
    }
1190 1191 1192
    if (virFreeDomain(domain->conn, domain) < 0)
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1193 1194 1195
}

/**
1196
 * virDomainSuspend:
D
Daniel Veillard 已提交
1197 1198 1199 1200
 * @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 
1201
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1202
 * the domain.
1203
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
1204 1205 1206 1207
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1208 1209
virDomainSuspend(virDomainPtr domain)
{
1210
    virConnectPtr conn;
1211
    DEBUG("domain=%p", domain);
1212

D
Daniel Veillard 已提交
1213
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1214
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1215
        return (-1);
D
Daniel Veillard 已提交
1216
    }
1217 1218 1219 1220
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1221

1222 1223
    conn = domain->conn;

1224 1225
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1226

1227 1228
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1229 1230 1231
}

/**
1232
 * virDomainResume:
D
Daniel Veillard 已提交
1233 1234 1235
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1236
 * it was frozen by calling virSuspendDomain().
1237
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1238 1239 1240 1241
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1242 1243
virDomainResume(virDomainPtr domain)
{
1244
    virConnectPtr conn;
1245
    DEBUG("domain=%p", domain);
1246

D
Daniel Veillard 已提交
1247
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1248
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1249
        return (-1);
D
Daniel Veillard 已提交
1250
    }
1251 1252 1253 1254
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1255

1256 1257
    conn = domain->conn;

1258 1259
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1260

1261 1262
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1263 1264
}

1265 1266 1267 1268 1269 1270
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1271 1272 1273
 * 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.
1274 1275 1276 1277
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1278 1279
virDomainSave(virDomainPtr domain, const char *to)
{
1280
    char filepath[4096];
1281
    virConnectPtr conn;
1282
    DEBUG("domain=%p, to=%s", domain, to);
1283

D
Daniel Veillard 已提交
1284
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1285
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1286
        return (-1);
D
Daniel Veillard 已提交
1287
    }
1288 1289 1290 1291
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1292
    conn = domain->conn;
D
Daniel Veillard 已提交
1293 1294
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1295
        return (-1);
D
Daniel Veillard 已提交
1296
    }
1297

1298 1299 1300 1301 1302
    /*
     * 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] != '/') {
1303
        unsigned int len, t;
1304

1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
        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];
1315 1316 1317

    }

1318 1319 1320
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1321
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1322
    return -1;
1323 1324 1325 1326
}

/**
 * virDomainRestore:
1327
 * @conn: pointer to the hypervisor connection
1328 1329 1330 1331 1332 1333 1334
 * @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
1335 1336
virDomainRestore(virConnectPtr conn, const char *from)
{
1337
    char filepath[4096];
1338
    DEBUG("conn=%p, from=%s", conn, from);
1339

D
Daniel Veillard 已提交
1340
    if (!VIR_IS_CONNECT(conn)) {
1341
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1342
        return (-1);
D
Daniel Veillard 已提交
1343
    }
1344 1345 1346 1347
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1348 1349
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1350
        return (-1);
D
Daniel Veillard 已提交
1351 1352
    }

1353 1354 1355 1356 1357
    /*
     * 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] != '/') {
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
        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];
    }

1372 1373 1374
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1375
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1376
    return -1;
D
Daniel Veillard 已提交
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1399
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
        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];

    }

1432 1433 1434
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1435
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1436
    return -1;
1437 1438
}

1439 1440 1441 1442 1443
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1444 1445
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1446 1447 1448 1449 1450 1451 1452
 *
 * 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
1453 1454
virDomainShutdown(virDomainPtr domain)
{
1455
    virConnectPtr conn;
1456
    DEBUG("domain=%p", domain);
1457

D
Daniel Veillard 已提交
1458
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1459
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1460
        return (-1);
D
Daniel Veillard 已提交
1461
    }
1462 1463 1464 1465
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1466

1467 1468
    conn = domain->conn;

1469 1470
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1471

1472
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1473
    return -1;
1474 1475
}

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
/**
 * 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)
{
1490
    virConnectPtr conn;
1491
    DEBUG("domain=%p, flags=%u", domain, flags);
1492 1493

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1494
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1495 1496
        return (-1);
    }
1497 1498 1499 1500
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1501

1502 1503
    conn = domain->conn;

1504 1505
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1506

1507
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1508
    return -1;
1509 1510
}

1511
/**
1512
 * virDomainGetName:
1513 1514 1515 1516 1517 1518 1519 1520
 * @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 *
1521 1522
virDomainGetName(virDomainPtr domain)
{
1523 1524
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1525
    if (!VIR_IS_DOMAIN(domain)) {
1526
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1527
        return (NULL);
D
Daniel Veillard 已提交
1528
    }
1529
    return (domain->name);
1530 1531
}

1532 1533 1534
/**
 * virDomainGetUUID:
 * @domain: a domain object
1535
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1536 1537 1538 1539 1540 1541
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1542 1543
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1544 1545
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1546
    if (!VIR_IS_DOMAIN(domain)) {
1547
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1548
        return (-1);
D
Daniel Veillard 已提交
1549 1550 1551
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1552
        return (-1);
D
Daniel Veillard 已提交
1553 1554
    }

1555
    if (domain->id == 0) {
1556
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1557
    } else {
1558
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1559 1560
    }
    return (0);
1561 1562
}

K
Karel Zak 已提交
1563 1564 1565
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1566
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575
 *
 * 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)
{
1576
    unsigned char uuid[VIR_UUID_BUFLEN];
1577
    DEBUG("domain=%p, buf=%p", domain, buf);
1578

K
Karel Zak 已提交
1579
    if (!VIR_IS_DOMAIN(domain)) {
1580
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1581 1582 1583 1584 1585 1586 1587 1588
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    
    if (virDomainGetUUID(domain, &uuid[0]))
1589
        return (-1);
K
Karel Zak 已提交
1590

1591
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1592 1593 1594
    return (0);
}

1595
/**
1596
 * virDomainGetID:
1597 1598 1599 1600 1601 1602 1603
 * @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
1604 1605
virDomainGetID(virDomainPtr domain)
{
1606 1607
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1608
    if (!VIR_IS_DOMAIN(domain)) {
1609
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1610
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1611
    }
1612
    return (domain->id);
1613 1614
}

1615 1616 1617 1618 1619 1620
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1621 1622
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1623 1624
 */
char *
1625 1626
virDomainGetOSType(virDomainPtr domain)
{
1627
    virConnectPtr conn;
1628
    DEBUG("domain=%p", domain);
1629

D
Daniel Veillard 已提交
1630
    if (!VIR_IS_DOMAIN(domain)) {
1631
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1632
        return (NULL);
D
Daniel Veillard 已提交
1633
    }
1634

1635 1636 1637 1638
    conn = domain->conn;

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

1640
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1641
    return NULL;
1642 1643
}

1644
/**
1645
 * virDomainGetMaxMemory:
1646 1647 1648 1649 1650 1651 1652 1653 1654
 * @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
1655 1656
virDomainGetMaxMemory(virDomainPtr domain)
{
1657
    virConnectPtr conn;
1658
    DEBUG("domain=%p", domain);
1659

D
Daniel Veillard 已提交
1660
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1661
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1662
        return (0);
D
Daniel Veillard 已提交
1663
    }
1664

1665 1666
    conn = domain->conn;

1667 1668 1669
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1670
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1671
    return 0;
1672 1673
}

D
Daniel Veillard 已提交
1674
/**
1675
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1676 1677 1678 1679 1680 1681
 * @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.
1682
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1683 1684 1685 1686
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1687 1688
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1689
    virConnectPtr conn;
1690
    DEBUG("domain=%p, memory=%lu", domain, memory);
1691

1692 1693 1694 1695 1696
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1697
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1698
        return (-1);
1699
    }
1700 1701 1702 1703 1704 1705 1706 1707
    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);
    }
1708
    conn = domain->conn;
1709

1710 1711 1712
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

1713
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1714
    return -1;
1715
}
1716

1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
/**
 * 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;
1733
    DEBUG("domain=%p, memory=%lu", domain, memory);
1734

1735 1736 1737 1738 1739
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1740
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1741
        return (-1);
1742
    }
1743 1744 1745 1746 1747 1748
    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__);
1749
        return (-1);
1750 1751 1752
    }

    conn = domain->conn;
1753

1754 1755 1756
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

1757
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1758
    return -1;
D
Daniel Veillard 已提交
1759 1760
}

1761 1762
/**
 * virDomainGetInfo:
1763
 * @domain: a domain object
1764 1765 1766
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1767
 * used to get the domain is limited only a partial set of the information
1768 1769 1770 1771 1772
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1773 1774
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1775
    virConnectPtr conn;
1776
    DEBUG("domain=%p, info=%p", domain, info);
1777

D
Daniel Veillard 已提交
1778
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1779
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1780
        return (-1);
D
Daniel Veillard 已提交
1781 1782 1783
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1784
        return (-1);
D
Daniel Veillard 已提交
1785
    }
1786

1787
    memset(info, 0, sizeof(virDomainInfo));
1788

1789 1790 1791 1792
    conn = domain->conn;

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

1794
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1795
    return -1;
1796
}
1797

1798 1799 1800
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
1801
 * @flags: an OR'ed set of virDomainXMLFlags
1802 1803 1804 1805 1806 1807 1808 1809
 *
 * 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 *
1810 1811
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1812
    virConnectPtr conn;
1813
    DEBUG("domain=%p, flags=%d", domain, flags);
1814

D
Daniel Veillard 已提交
1815
    if (!VIR_IS_DOMAIN(domain)) {
1816
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1817
        return (NULL);
D
Daniel Veillard 已提交
1818 1819 1820
    }
    if (flags != 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1821
        return (NULL);
D
Daniel Veillard 已提交
1822
    }
1823

1824 1825 1826 1827 1828
    conn = domain->conn;

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

1829
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1830
    return NULL;
1831
}
1832

1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 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
/**
 * 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)) {
1898
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 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
        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)) {
1980
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
        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)) {
2009
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
        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)) {
2037
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
        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;
}


2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
/**
 * 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
2061 2062
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2063 2064
    DEBUG("conn=%p, info=%p", conn, info);

2065
    if (!VIR_IS_CONNECT(conn)) {
2066
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2067 2068 2069 2070 2071 2072 2073
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2074 2075 2076
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2077
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2078
    return -1;
2079
}
2080

2081 2082 2083 2084 2085 2086
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2087 2088
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2089 2090 2091 2092 2093
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2094 2095
    DEBUG("conn=%p", conn);

2096
    if (!VIR_IS_CONNECT (conn)) {
2097
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2098 2099 2100
        return NULL;
    }

2101 2102
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2103

2104
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2105 2106 2107
    return NULL;
}

2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118
/**
 * 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)
{
2119 2120
    DEBUG("conn=%p", conn);

2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
    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;
}

2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
/**
 * 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;
2147
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2148 2149

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2150
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2151 2152 2153 2154 2155 2156 2157 2158 2159
        return NULL;
    }
    conn = domain->conn;

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

2160
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
    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;
2184
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2185 2186

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2187
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2188 2189 2190 2191 2192 2193 2194
        return -1;
    }
    conn = domain->conn;

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

2195
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215
    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;
2216
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2217 2218

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2219
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2220 2221 2222 2223 2224 2225 2226
        return -1;
    }
    conn = domain->conn;

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

2227
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2228 2229 2230 2231
    return -1;
}


2232
/**
2233
 * virDomainBlockStats:
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
 * @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)) {
2268
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
        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;
}

/**
2286
 * virDomainInterfaceStats:
2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
 * @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)) {
2320
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
        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;
}



2339

2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
/************************************************************************
 *									*
 *		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) {
2357 2358
    DEBUG("conn=%p, xml=%s", conn, xml);

2359
    if (!VIR_IS_CONNECT(conn)) {
2360
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2361 2362
        return (NULL);
    }
2363 2364 2365 2366
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
2367 2368 2369 2370 2371
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2372 2373
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2374

2375
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2376
    return NULL;
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
}

/**
 * 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) {
2389
    virConnectPtr conn;
2390
    DEBUG("domain=%p", domain);
2391 2392

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2393
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2394 2395
        return (-1);
    }
2396 2397
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2398 2399 2400 2401
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

2402 2403
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2404

2405
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2406
    return -1;
2407 2408 2409 2410 2411 2412
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2413
 * Provides the number of inactive domains.
2414 2415 2416 2417 2418 2419
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2420 2421
    DEBUG("conn=%p", conn);

2422
    if (!VIR_IS_CONNECT(conn)) {
2423
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2424 2425 2426
        return (-1);
    }

2427 2428
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2429

2430
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2431
    return -1;
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444
}

/**
 * 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
2445
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2446
                             int maxnames) {
2447 2448
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2449
    if (!VIR_IS_CONNECT(conn)) {
2450
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2451 2452 2453
        return (-1);
    }

2454
    if ((names == NULL) || (maxnames < 0)) {
2455 2456 2457 2458
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2459 2460
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2461

2462
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2463
    return -1;
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
}

/**
 * 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) {
2477
    virConnectPtr conn;
2478
    DEBUG("domain=%p", domain);
2479

2480 2481 2482 2483
    if (domain == NULL) {
        TODO
	return (-1);
    }
2484
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2485
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2486 2487
        return (-1);
    }
2488 2489
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2490 2491 2492
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2493

2494 2495 2496
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2497
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2498
    return -1;
2499 2500
}

2501 2502 2503
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2504
 * @autostart: the value returned
2505
 *
2506
 * Provides a boolean value indicating whether the domain
2507 2508 2509 2510 2511 2512 2513
 * 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,
2514 2515 2516
                      int *autostart)
{
    virConnectPtr conn;
2517
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2518 2519

    if (!VIR_IS_DOMAIN(domain)) {
2520
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2521 2522 2523 2524 2525 2526 2527
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2528 2529 2530 2531 2532
    conn = domain->conn;

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

2533
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2534
    return -1;
2535 2536 2537 2538 2539
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
2540
 * @autostart: whether the domain should be automatically started 0 or 1
2541 2542 2543 2544 2545 2546 2547 2548
 *
 * 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,
2549 2550 2551
                      int autostart)
{
    virConnectPtr conn;
2552
    DEBUG("domain=%p, autostart=%d", domain, autostart);
2553 2554

    if (!VIR_IS_DOMAIN(domain)) {
2555
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2556 2557 2558
        return (-1);
    }

2559 2560 2561 2562 2563
    conn = domain->conn;

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

2564
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2565
    return -1;
2566 2567
}

2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
/**
 * 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)
{
2584
    virConnectPtr conn;
2585
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
2586

2587 2588 2589 2590 2591
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2592
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2593 2594
        return (-1);
    }
2595 2596 2597 2598
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2599

2600 2601 2602 2603
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2604
    conn = domain->conn;
2605

2606 2607
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
2608

2609
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2610
    return -1;
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634
}

/**
 * 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)
{
2635
    virConnectPtr conn;
2636
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
2637

2638 2639 2640 2641 2642
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2643
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2644 2645
        return (-1);
    }
2646 2647 2648 2649
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2650

2651
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
2652 2653 2654
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2655

2656 2657
    conn = domain->conn;

2658 2659 2660
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

2661
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2662
    return -1;
2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
}

/**
 * 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)
{
2690
    virConnectPtr conn;
2691
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
2692 2693 2694 2695 2696 2697

    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2698
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2699 2700 2701 2702 2703 2704 2705 2706 2707 2708
        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);
    }
2709

2710 2711
    conn = domain->conn;

2712 2713 2714 2715
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

2716
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2717
    return -1;
2718
}
2719

2720 2721 2722 2723
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
 * 
2724 2725 2726 2727 2728
 * 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.
2729 2730 2731 2732
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
2733 2734
virDomainGetMaxVcpus(virDomainPtr domain)
{
2735
    virConnectPtr conn;
2736
    DEBUG("domain=%p", domain);
2737 2738

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2739
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2740 2741 2742 2743 2744
        return (-1);
    }

    conn = domain->conn;

2745 2746 2747
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

2748
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2749
    return -1;
2750 2751 2752
}


2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
/**
 * 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
2763
virDomainAttachDevice(virDomainPtr domain, const char *xml)
2764 2765
{
    virConnectPtr conn;
2766
    DEBUG("domain=%p, xml=%s", domain, xml);
2767 2768

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2769
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2770 2771 2772 2773 2774 2775 2776 2777
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2778 2779 2780
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

2781
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2782
    return -1;
2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
}

/**
 * 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
2795
virDomainDetachDevice(virDomainPtr domain, const char *xml)
2796 2797
{
    virConnectPtr conn;
2798
    DEBUG("domain=%p, xml=%s", domain, xml);
2799 2800

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2801
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2802 2803 2804 2805 2806 2807 2808 2809
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2810 2811 2812
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

2813
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2814
    return -1;
2815
}
2816

2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
/**
 * 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)
{
2839 2840 2841
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

2842 2843 2844 2845 2846
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
2847
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858
        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;
}

2859 2860 2861 2862
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
2863
 * Provides the connection pointer associated with a network.  The
2864 2865 2866
 * reference counter on the connection is not increased by this
 * call.
 *
2867 2868 2869 2870
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
2871 2872 2873 2874 2875
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
2876 2877
    DEBUG("net=%p", net);

2878
    if (!VIR_IS_NETWORK (net)) {
2879
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
2880 2881 2882 2883 2884
        return NULL;
    }
    return net->conn;
}

2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
/**
 * 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)
{
2896 2897
    DEBUG("conn=%p", conn);

2898
    if (!VIR_IS_CONNECT(conn)) {
2899
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2900 2901 2902
        return (-1);
    }

2903 2904
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
2905

2906
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2907
    return -1;
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920
}

/**
 * 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
2921
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
2922
{
2923 2924
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2925
    if (!VIR_IS_CONNECT(conn)) {
2926
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2927 2928 2929
        return (-1);
    }

2930
    if ((names == NULL) || (maxnames < 0)) {
2931 2932 2933 2934
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2935 2936
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
2937

2938
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2939
    return -1;
2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952
}

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

2955
    if (!VIR_IS_CONNECT(conn)) {
2956
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2957 2958 2959
        return (-1);
    }

2960 2961
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
2962

2963
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2964
    return -1;
2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
}

/**
 * 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
2978
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
2979 2980
                              int maxnames)
{
2981 2982
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2983
    if (!VIR_IS_CONNECT(conn)) {
2984
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2985 2986 2987
        return (-1);
    }

2988
    if ((names == NULL) || (maxnames < 0)) {
2989 2990 2991 2992
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2993 2994 2995
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
2996

2997
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2998
    return -1;
2999 3000 3001 3002 3003 3004 3005 3006 3007
}

/**
 * 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.
 *
3008 3009
 * 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.
3010 3011 3012 3013
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3014 3015
    DEBUG("conn=%p, name=%s", conn, name);

3016
    if (!VIR_IS_CONNECT(conn)) {
3017
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3018 3019 3020 3021 3022 3023 3024
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3025 3026 3027
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

3028
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3029
    return NULL;
3030 3031 3032 3033 3034 3035 3036 3037 3038
}

/**
 * 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.
 *
3039 3040
 * 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.
3041 3042 3043 3044
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3045 3046
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3047
    if (!VIR_IS_CONNECT(conn)) {
3048
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3049 3050 3051 3052 3053 3054 3055
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3056 3057
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3058

3059
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3060
    return NULL;
3061 3062 3063 3064 3065 3066 3067 3068 3069
}

/**
 * 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.
 *
3070 3071
 * 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.
3072 3073 3074 3075 3076 3077 3078
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3079
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3080 3081

    if (!VIR_IS_CONNECT(conn)) {
3082
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
        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)
{
3127 3128
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3129
    if (!VIR_IS_CONNECT(conn)) {
3130
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
        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);
    }

3142 3143 3144
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3145
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3146
    return NULL;
3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
}

/**
 * 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
3159 3160
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3161 3162
    DEBUG("conn=%p, xml=%s", conn, xml);

3163
    if (!VIR_IS_CONNECT(conn)) {
3164
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
        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);
    }

3176 3177
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3178

3179
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3180
    return NULL;
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3197
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3198 3199 3200 3201 3202 3203 3204 3205
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3206 3207
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3208

3209
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3210
    return -1;
3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
}

/**
 * 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
3223 3224
virNetworkCreate(virNetworkPtr network)
{
3225
    virConnectPtr conn;
3226 3227
    DEBUG("network=%p", network);

3228 3229 3230 3231 3232
    if (network == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3233
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3234 3235 3236 3237 3238 3239 3240 3241
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3242 3243 3244
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3245
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3246
    return -1;
3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3268
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3269 3270 3271 3272 3273 3274 3275 3276 3277
        return (-1);
    }

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

3278 3279
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3280

3281
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3282
    return -1;
3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296
}

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

3299
    if (!VIR_IS_NETWORK(network)) {
3300
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319
        return (-1);
    }
    if (virFreeNetwork(network->conn, network) < 0)
        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)
{
3320 3321
    DEBUG("network=%p", network);

3322
    if (!VIR_IS_NETWORK(network)) {
3323
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
        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)
{
3341 3342
    DEBUG("network=%p, uuid=%p", network, uuid);

3343
    if (!VIR_IS_NETWORK(network)) {
3344
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370
        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];
3371
    DEBUG("network=%p, buf=%p", network, buf);
3372 3373

    if (!VIR_IS_NETWORK(network)) {
3374
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3375 3376 3377 3378 3379 3380 3381 3382
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
3383
        return (-1);
3384

3385
    virUUIDFormat(uuid, buf);
3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402
    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)
{
3403
    virConnectPtr conn;
3404
    DEBUG("network=%p, flags=%d", network, flags);
3405

3406
    if (!VIR_IS_NETWORK(network)) {
3407
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3408 3409 3410 3411 3412 3413 3414
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3415 3416 3417 3418 3419
    conn = network->conn;

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

3420
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3421
    return NULL;
3422
}
3423 3424 3425 3426 3427

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3428
 * Provides a bridge interface name to which a domain may connect
3429 3430 3431 3432 3433 3434 3435 3436
 * 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)
{
3437
    virConnectPtr conn;
3438
    DEBUG("network=%p", network);
3439

3440
    if (!VIR_IS_NETWORK(network)) {
3441
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3442 3443 3444
        return (NULL);
    }

3445 3446 3447 3448 3449
    conn = network->conn;

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

3450
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3451
    return NULL;
3452
}
3453 3454 3455 3456

/**
 * virNetworkGetAutostart:
 * @network: a network object
3457
 * @autostart: the value returned
3458
 *
3459
 * Provides a boolean value indicating whether the network
3460 3461 3462 3463 3464 3465 3466
 * 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,
3467 3468 3469
                       int *autostart)
{
    virConnectPtr conn;
3470
    DEBUG("network=%p, autostart=%p", network, autostart);
3471 3472

    if (!VIR_IS_NETWORK(network)) {
3473
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3474 3475 3476 3477 3478 3479 3480
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3481 3482 3483 3484 3485
    conn = network->conn;

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

3486
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3487
    return -1;
3488 3489 3490 3491 3492
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3493
 * @autostart: whether the network should be automatically started 0 or 1
3494 3495 3496 3497 3498 3499 3500 3501
 *
 * 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,
3502 3503 3504
                       int autostart)
{
    virConnectPtr conn;
3505
    DEBUG("network=%p, autostart=%d", network, autostart);
3506 3507

    if (!VIR_IS_NETWORK(network)) {
3508
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3509 3510 3511
        return (-1);
    }

3512 3513 3514 3515 3516
    conn = network->conn;

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

3517
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3518
    return -1;
3519
}
3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533

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