libvirt.c 92.9 KB
Newer Older
D
Daniel Veillard 已提交
1
/*
2
 * libvirt.c: Main interfaces for the libvirt library to handle virtualization
D
Daniel Veillard 已提交
3 4
 *           domains from a process running in domain 0
 *
5
 * Copyright (C) 2005,2006 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 25
#include <libxml/parser.h>
#include <libxml/xpath.h>

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

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

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

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

52 53 54 55 56 57 58 59 60 61 62 63 64
/* 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 */

65 66 67 68 69 70 71 72 73 74 75 76
/**
 * 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)
{
77
    DEBUG0;
78 79
    if (initialized)
        return(0);
80
    initialized = 1;
81

82 83 84
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

85
    /*
86 87
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
88
     */
89
#ifdef WITH_TEST
90
    if (testRegister() == -1) return -1;
91
#endif
92
#ifdef WITH_QEMU 
93
    if (qemudRegister() == -1) return -1;
94
#endif
95 96
#ifdef WITH_XEN
    if (xenUnifiedRegister () == -1) return -1;
97
#endif
98 99 100
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
#endif
101 102
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
103
#endif
D
Daniel P. Berrange 已提交
104

105 106 107 108 109
    return(0);
}



D
Daniel Veillard 已提交
110 111 112
/**
 * virLibConnError:
 * @conn: the connection if available
113
 * @error: the error number
D
Daniel Veillard 已提交
114 115 116 117 118
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
119 120
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
121
    const char *errmsg;
122

D
Daniel Veillard 已提交
123 124 125 126
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
127
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
128 129 130 131
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
132
 * virLibConnWarning:
D
Daniel Veillard 已提交
133
 * @conn: the connection if available
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
 * @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 已提交
156 157 158 159 160
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
161 162 163
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
164 165
    virConnectPtr conn = NULL;
    const char *errmsg;
166

D
Daniel Veillard 已提交
167 168 169 170 171 172 173
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
174
    __virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
175 176 177
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

178
/**
179 180 181 182
 * virLibNetworkError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
183
 *
184
 * Handle an error at the connection level
185
 */
186 187 188 189 190 191 192 193 194 195 196 197 198 199
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;
    }
200
    __virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
201 202 203 204 205 206 207 208 209 210 211 212 213 214
                    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)
{
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    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++;
230 231 232 233 234 235 236 237 238 239 240 241 242
}

/**
 * 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)
{
243 244 245 246 247 248 249 250 251 252 253 254 255
    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);
    }

256 257 258 259 260 261 262
    if (driver->no < 0) {
    	virLibConnError
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

263 264
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
265 266
}

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
/**
 * 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;

298 299 300
    if (virInitialize() < 0)
        return -1;

301 302 303 304
    if (virInitialize() < 0)
        return -1;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
305 306
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
307 308 309 310 311 312 313 314 315
            ret = -1;
    }
    return ret;
}

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
316 317
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
318 319 320 321 322 323 324 325 326
            ret = -1;
    }
    return ret;
}

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
327 328
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
329 330 331 332 333 334 335 336 337
            ret = -1;
    }
    return ret;
}

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
338 339
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
340 341 342 343 344 345 346
            ret = 1;
    }
    return ret;
}



347 348 349
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
350
 * @type: the type of connection/driver looked at
351 352 353 354 355 356 357 358 359 360 361 362
 * @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
363 364 365
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
366
    int i;
367
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
368

369
    if (!initialized)
370 371
        if (virInitialize() < 0)
	    return -1;
372

373
    if (libVer == NULL)
374
        return (-1);
375 376 377
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
378 379
        if (type == NULL)
	    type = "Xen";
380
	for (i = 0;i < virDriverTabCount;i++) {
381
	    if ((virDriverTab[i] != NULL) &&
382
	        (!strcasecmp(virDriverTab[i]->name, type))) {
383 384 385 386
		*typeVer = virDriverTab[i]->ver;
		break;
	    }
	}
387
        if (i >= virDriverTabCount) {
388
            *typeVer = 0;
389
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
390 391 392 393
            return (-1);
        }
    }
    return (0);
394 395
}

396 397
static virConnectPtr
do_open (const char *name, int flags)
398
{
399
    int i, res;
400
    virConnectPtr ret = NULL;
401

402 403 404 405 406 407 408 409
    /* 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:///";

410
    if (!initialized)
411 412
        if (virInitialize() < 0)
	    return NULL;
413

414
    ret = virGetConnect();
415
    if (ret == NULL) {
416
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
417 418 419
        goto failed;
    }

420 421 422 423
#ifdef ENABLE_DEBUG
    fprintf (stderr, "libvirt: do_open: proceeding with name=%s\n", name);
#endif

424
    for (i = 0; i < virDriverTabCount; i++) {
425 426 427 428
#ifdef ENABLE_DEBUG
        fprintf (stderr, "libvirt: do_open: trying driver %d (%s) ...\n",
                 i, virDriverTab[i]->name);
#endif
429
        res = virDriverTab[i]->open (ret, name, flags);
430
#ifdef ENABLE_DEBUG
431 432
        fprintf (stderr, "libvirt: do_open: driver %d %s returned %s\n",
                 i, virDriverTab[i]->name,
433 434 435 436
                 res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
                 (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
                  (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
437 438 439 440 441
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
442 443
    }

444
    if (!ret->driver) {
445 446
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
447
        goto failed;
448 449
    }

450 451
    for (i = 0; i < virNetworkDriverTabCount; i++) {
        res = virNetworkDriverTab[i]->open (ret, name, flags);
452 453 454 455 456 457 458
#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
459
        if (res == VIR_DRV_OPEN_ERROR) {
460 461 462 463
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK, 
                                   "Is the daemon running ?");
            }
464 465
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
466 467 468
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
469
    }
470

471 472 473 474
    if (flags & VIR_DRV_OPEN_RO) {
        ret->flags = VIR_CONNECT_RO;
    }

475
    return ret;
476 477

failed:
478
    if (ret->driver) ret->driver->close (ret);
479
	virFreeConnect(ret);
480
    return (NULL);
481 482
}

483 484
/**
 * virConnectOpen:
485
 * @name: URI of the hypervisor
486 487 488 489 490
 *
 * 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
491 492
 *
 * URIs are documented at http://libvirt.org/uri.html
493 494 495 496
 */
virConnectPtr
virConnectOpen (const char *name)
{
497
    DEBUG("name=%s", name);
498
    return do_open (name, 0);
499 500
}

501
/**
502
 * virConnectOpenReadOnly:
503
 * @name: URI of the hypervisor
504
 *
505 506 507
 * 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.
508 509
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
510 511
 *
 * URIs are documented at http://libvirt.org/uri.html
512
 */
513
virConnectPtr
514 515
virConnectOpenReadOnly(const char *name)
{
516
    DEBUG("name=%s", name);
517
    return do_open (name, VIR_DRV_OPEN_RO);
D
Daniel Veillard 已提交
518 519 520
}

/**
521
 * virConnectClose:
D
Daniel Veillard 已提交
522 523 524 525 526 527 528 529 530 531
 * @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
532 533
virConnectClose(virConnectPtr conn)
{
534 535
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
536
    if (!VIR_IS_CONNECT(conn))
537
        return (-1);
538 539 540

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
541
    conn->driver->close (conn);
542

543 544
    if (virFreeConnect(conn) < 0)
        return (-1);
545
    return (0);
D
Daniel Veillard 已提交
546 547
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561
/* 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);
}

562 563 564 565 566 567 568
/**
 * 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.
569 570 571
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
572 573
 */
const char *
574 575
virConnectGetType(virConnectPtr conn)
{
576
    const char *ret;
577
    DEBUG("conn=%p", conn);
578

D
Daniel Veillard 已提交
579
    if (!VIR_IS_CONNECT(conn)) {
580
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
581
        return (NULL);
D
Daniel Veillard 已提交
582
    }
583 584 585 586

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
587
    }
588
    return conn->driver->name;
589 590
}

D
Daniel Veillard 已提交
591
/**
592
 * virConnectGetVersion:
D
Daniel Veillard 已提交
593
 * @conn: pointer to the hypervisor connection
594
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
595
 *
596 597 598
 * 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 已提交
599
 *
600 601 602
 * 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 已提交
603
 */
604
int
605 606
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
607 608
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
609
    if (!VIR_IS_CONNECT(conn)) {
610
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
611
        return (-1);
D
Daniel Veillard 已提交
612
    }
613

D
Daniel Veillard 已提交
614 615
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
616
        return (-1);
D
Daniel Veillard 已提交
617
    }
618

619 620
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
621

622 623
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
624 625
}

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/**
 * 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)
{
641 642
    DEBUG("conn=%p", conn);

643
    if (!VIR_IS_CONNECT(conn)) {
644
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
        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)
{
673 674
    DEBUG("conn=%p", conn);

675
    if (!VIR_IS_CONNECT(conn)) {
676
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
677 678 679 680 681 682 683 684 685 686
        return NULL;
    }

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

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

687 688 689 690 691
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
692
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
693 694 695 696 697 698 699 700 701
 * 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)
{
702 703
    DEBUG("conn=%p, type=%s", conn, type);

704
    if (!VIR_IS_CONNECT(conn)) {
705
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
706 707 708
        return (-1);
    }

709 710
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
711

712 713
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
714 715
}

716
/**
717
 * virConnectListDomains:
718 719 720 721 722 723 724 725 726
 * @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
727 728
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
729 730
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
731
    if (!VIR_IS_CONNECT(conn)) {
732
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
733
        return (-1);
D
Daniel Veillard 已提交
734
    }
735

736
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
737
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
738
        return (-1);
D
Daniel Veillard 已提交
739
    }
740

741 742
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
743

744 745
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
746 747
}

K
 
Karel Zak 已提交
748 749 750 751
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
752 753
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
754 755 756
 * Returns the number of domain found or -1 in case of error
 */
int
757 758
virConnectNumOfDomains(virConnectPtr conn)
{
759 760
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
761
    if (!VIR_IS_CONNECT(conn)) {
762
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
763
        return (-1);
D
Daniel Veillard 已提交
764
    }
K
Karel Zak 已提交
765

766 767
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
768

769 770
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
771 772
}

773 774 775 776
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
777
 * Provides the connection pointer associated with a domain.  The
778 779 780
 * reference counter on the connection is not increased by this
 * call.
 *
781 782 783 784
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
785 786 787 788 789
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
790 791
    DEBUG("dom=%p", dom);

792
    if (!VIR_IS_DOMAIN (dom)) {
793
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
794 795 796 797 798
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
799
/**
800
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
801
 * @conn: pointer to the hypervisor connection
802
 * @xmlDesc: an XML description of the domain
803
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
804
 *
805 806 807
 * 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 已提交
808 809 810
 * 
 * Returns a new domain object or NULL in case of failure
 */
811
virDomainPtr
812 813
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
814
{
815 816
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
817
    if (!VIR_IS_CONNECT(conn)) {
818
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
819
        return (NULL);
D
Daniel Veillard 已提交
820 821 822
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
823
        return (NULL);
D
Daniel Veillard 已提交
824
    }
825 826 827 828
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
829

830 831 832 833 834
    if (conn->driver->domainCreateLinux)
        return conn->driver->domainCreateLinux (conn, xmlDesc, flags);

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

837

838
/**
839
 * virDomainLookupByID:
840 841 842 843 844
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
 *
845 846
 * 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.
847
 */
848
virDomainPtr
849 850
virDomainLookupByID(virConnectPtr conn, int id)
{
851 852
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
853
    if (!VIR_IS_CONNECT(conn)) {
854
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
855
        return (NULL);
D
Daniel Veillard 已提交
856 857 858
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
859
        return (NULL);
D
Daniel Veillard 已提交
860
    }
861

862 863
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
864

865 866
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
867 868 869 870 871
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
872
 * @uuid: the raw UUID for the domain
873 874 875
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
876 877
 * 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.
878 879
 */
virDomainPtr
880 881
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
882 883
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
884
    if (!VIR_IS_CONNECT(conn)) {
885
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
886
        return (NULL);
D
Daniel Veillard 已提交
887 888 889
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
890
        return (NULL);
D
Daniel Veillard 已提交
891
    }
892

893 894
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
895

896 897
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
898 899
}

K
Karel Zak 已提交
900 901 902 903 904 905 906
/**
 * 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.
 *
907 908
 * 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 已提交
909 910 911 912
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
913 914
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
915 916
    int ret;

917 918
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
919
    if (!VIR_IS_CONNECT(conn)) {
920
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
        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);
    
942
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
943 944 945
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
946
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
947 948 949 950 951
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

952 953 954 955 956
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
957
 * Try to lookup a domain on the given hypervisor based on its name.
958
 *
959 960
 * 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.
961 962
 */
virDomainPtr
963 964
virDomainLookupByName(virConnectPtr conn, const char *name)
{
965 966
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
967
    if (!VIR_IS_CONNECT(conn)) {
968
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
969
        return (NULL);
D
Daniel Veillard 已提交
970 971 972
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
973
        return (NULL);
D
Daniel Veillard 已提交
974
    }
975

976 977 978 979 980
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
981 982
}

D
Daniel Veillard 已提交
983
/**
984
 * virDomainDestroy:
D
Daniel Veillard 已提交
985 986 987 988
 * @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.
989 990
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
991
 * This function may requires priviledged access
D
Daniel Veillard 已提交
992 993
 *
 * Returns 0 in case of success and -1 in case of failure.
994
 */
D
Daniel Veillard 已提交
995
int
996 997
virDomainDestroy(virDomainPtr domain)
{
998
    virConnectPtr conn;
999

1000 1001
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1002
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1003
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1004
        return (-1);
D
Daniel Veillard 已提交
1005
    }
1006

1007
    conn = domain->conn;
1008 1009 1010 1011
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1012

1013 1014
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1015

1016 1017
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
}

/**
 * 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
1030 1031
virDomainFree(virDomainPtr domain)
{
1032 1033
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1034
    if (!VIR_IS_DOMAIN(domain)) {
1035
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1036
        return (-1);
D
Daniel Veillard 已提交
1037
    }
1038 1039 1040
    if (virFreeDomain(domain->conn, domain) < 0)
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1041 1042 1043
}

/**
1044
 * virDomainSuspend:
D
Daniel Veillard 已提交
1045 1046 1047 1048
 * @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 
1049
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1050
 * the domain.
1051
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
1052 1053 1054 1055
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1056 1057
virDomainSuspend(virDomainPtr domain)
{
1058
    virConnectPtr conn;
1059
    DEBUG("domain=%p", domain);
1060

D
Daniel Veillard 已提交
1061
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1062
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1063
        return (-1);
D
Daniel Veillard 已提交
1064
    }
1065 1066 1067 1068
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1069

1070 1071
    conn = domain->conn;

1072 1073
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1074

1075 1076
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1077 1078 1079
}

/**
1080
 * virDomainResume:
D
Daniel Veillard 已提交
1081 1082 1083
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1084
 * it was frozen by calling virSuspendDomain().
1085
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1086 1087 1088 1089
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1090 1091
virDomainResume(virDomainPtr domain)
{
1092
    virConnectPtr conn;
1093
    DEBUG("domain=%p", domain);
1094

D
Daniel Veillard 已提交
1095
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1096
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1097
        return (-1);
D
Daniel Veillard 已提交
1098
    }
1099 1100 1101 1102
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1103

1104 1105
    conn = domain->conn;

1106 1107
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1108

1109 1110
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1111 1112
}

1113 1114 1115 1116 1117 1118
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1119 1120 1121
 * 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.
1122 1123 1124 1125
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1126 1127
virDomainSave(virDomainPtr domain, const char *to)
{
1128
    char filepath[4096];
1129
    virConnectPtr conn;
1130
    DEBUG("domain=%p, to=%s", domain, to);
1131

D
Daniel Veillard 已提交
1132
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1133
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1134
        return (-1);
D
Daniel Veillard 已提交
1135
    }
1136 1137 1138 1139
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1140
    conn = domain->conn;
D
Daniel Veillard 已提交
1141 1142
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1143
        return (-1);
D
Daniel Veillard 已提交
1144
    }
1145

1146 1147 1148 1149 1150
    /*
     * 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] != '/') {
1151
        unsigned int len, t;
1152

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
        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];
1163 1164 1165

    }

1166 1167 1168
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1169
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1170
    return -1;
1171 1172 1173 1174
}

/**
 * virDomainRestore:
1175
 * @conn: pointer to the hypervisor connection
1176 1177 1178 1179 1180 1181 1182
 * @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
1183 1184
virDomainRestore(virConnectPtr conn, const char *from)
{
1185
    char filepath[4096];
1186
    DEBUG("conn=%p, from=%s", conn, from);
1187

D
Daniel Veillard 已提交
1188
    if (!VIR_IS_CONNECT(conn)) {
1189
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1190
        return (-1);
D
Daniel Veillard 已提交
1191
    }
1192 1193 1194 1195
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1196 1197
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1198
        return (-1);
D
Daniel Veillard 已提交
1199 1200
    }

1201 1202 1203 1204 1205
    /*
     * 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] != '/') {
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
        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];
    }

1220 1221 1222
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1223
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1224
    return -1;
D
Daniel Veillard 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1247
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
        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];

    }

1280 1281 1282
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1283
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1284
    return -1;
1285 1286
}

1287 1288 1289 1290 1291
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1292 1293
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1294 1295 1296 1297 1298 1299 1300
 *
 * 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
1301 1302
virDomainShutdown(virDomainPtr domain)
{
1303
    virConnectPtr conn;
1304
    DEBUG("domain=%p", domain);
1305

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

1315 1316
    conn = domain->conn;

1317 1318
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1319

1320
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1321
    return -1;
1322 1323
}

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
/**
 * 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)
{
1338
    virConnectPtr conn;
1339
    DEBUG("domain=%p, flags=%u", domain, flags);
1340 1341

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1342
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1343 1344
        return (-1);
    }
1345 1346 1347 1348
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1349

1350 1351
    conn = domain->conn;

1352 1353
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1354

1355
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1356
    return -1;
1357 1358
}

1359
/**
1360
 * virDomainGetName:
1361 1362 1363 1364 1365 1366 1367 1368
 * @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 *
1369 1370
virDomainGetName(virDomainPtr domain)
{
1371 1372
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1373
    if (!VIR_IS_DOMAIN(domain)) {
1374
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1375
        return (NULL);
D
Daniel Veillard 已提交
1376
    }
1377
    return (domain->name);
1378 1379
}

1380 1381 1382
/**
 * virDomainGetUUID:
 * @domain: a domain object
1383
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1384 1385 1386 1387 1388 1389
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1390 1391
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1392 1393
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1394
    if (!VIR_IS_DOMAIN(domain)) {
1395
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1396
        return (-1);
D
Daniel Veillard 已提交
1397 1398 1399
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1400
        return (-1);
D
Daniel Veillard 已提交
1401 1402
    }

1403
    if (domain->id == 0) {
1404
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1405
    } else {
1406
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1407 1408
    }
    return (0);
1409 1410
}

K
Karel Zak 已提交
1411 1412 1413
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1414
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1415 1416 1417 1418 1419 1420 1421 1422 1423
 *
 * 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)
{
1424
    unsigned char uuid[VIR_UUID_BUFLEN];
1425
    DEBUG("domain=%p, buf=%p", domain, buf);
1426

K
Karel Zak 已提交
1427
    if (!VIR_IS_DOMAIN(domain)) {
1428
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1429 1430 1431 1432 1433 1434 1435 1436
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    
    if (virDomainGetUUID(domain, &uuid[0]))
1437
        return (-1);
K
Karel Zak 已提交
1438

1439
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1440 1441 1442
    return (0);
}

1443
/**
1444
 * virDomainGetID:
1445 1446 1447 1448 1449 1450 1451
 * @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
1452 1453
virDomainGetID(virDomainPtr domain)
{
1454 1455
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1456
    if (!VIR_IS_DOMAIN(domain)) {
1457
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1458
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1459
    }
1460
    return (domain->id);
1461 1462
}

1463 1464 1465 1466 1467 1468
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1469 1470
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1471 1472
 */
char *
1473 1474
virDomainGetOSType(virDomainPtr domain)
{
1475
    virConnectPtr conn;
1476
    DEBUG("domain=%p", domain);
1477

D
Daniel Veillard 已提交
1478
    if (!VIR_IS_DOMAIN(domain)) {
1479
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1480
        return (NULL);
D
Daniel Veillard 已提交
1481
    }
1482

1483 1484 1485 1486
    conn = domain->conn;

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

1488
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1489
    return NULL;
1490 1491
}

1492
/**
1493
 * virDomainGetMaxMemory:
1494 1495 1496 1497 1498 1499 1500 1501 1502
 * @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
1503 1504
virDomainGetMaxMemory(virDomainPtr domain)
{
1505
    virConnectPtr conn;
1506
    DEBUG("domain=%p", domain);
1507

D
Daniel Veillard 已提交
1508
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1509
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1510
        return (0);
D
Daniel Veillard 已提交
1511
    }
1512

1513 1514
    conn = domain->conn;

1515 1516 1517
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1518
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1519
    return 0;
1520 1521
}

D
Daniel Veillard 已提交
1522
/**
1523
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1524 1525 1526 1527 1528 1529
 * @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.
1530
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1531 1532 1533 1534
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1535 1536
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1537
    virConnectPtr conn;
1538
    DEBUG("domain=%p, memory=%lu", domain, memory);
1539

1540 1541 1542 1543 1544
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1545
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1546
        return (-1);
1547
    }
1548 1549 1550 1551 1552 1553 1554 1555
    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);
    }
1556
    conn = domain->conn;
1557

1558 1559 1560
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

1561
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1562
    return -1;
1563
}
1564

1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
/**
 * 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;
1581
    DEBUG("domain=%p, memory=%lu", domain, memory);
1582

1583 1584 1585 1586 1587
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1588
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1589
        return (-1);
1590
    }
1591 1592 1593 1594 1595 1596
    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__);
1597
        return (-1);
1598 1599 1600
    }

    conn = domain->conn;
1601

1602 1603 1604
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

1605
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1606
    return -1;
D
Daniel Veillard 已提交
1607 1608
}

1609 1610
/**
 * virDomainGetInfo:
1611
 * @domain: a domain object
1612 1613 1614
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1615
 * used to get the domain is limited only a partial set of the information
1616 1617 1618 1619 1620
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1621 1622
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1623
    virConnectPtr conn;
1624
    DEBUG("domain=%p, info=%p", domain, info);
1625

D
Daniel Veillard 已提交
1626
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1627
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1628
        return (-1);
D
Daniel Veillard 已提交
1629 1630 1631
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1632
        return (-1);
D
Daniel Veillard 已提交
1633
    }
1634

1635
    memset(info, 0, sizeof(virDomainInfo));
1636

1637 1638 1639 1640
    conn = domain->conn;

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

1642
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1643
    return -1;
1644
}
1645

1646 1647 1648
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
1649
 * @flags: an OR'ed set of virDomainXMLFlags
1650 1651 1652 1653 1654 1655 1656 1657
 *
 * 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 *
1658 1659
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1660
    virConnectPtr conn;
1661
    DEBUG("domain=%p, flags=%d", domain, flags);
1662

D
Daniel Veillard 已提交
1663
    if (!VIR_IS_DOMAIN(domain)) {
1664
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1665
        return (NULL);
D
Daniel Veillard 已提交
1666 1667 1668
    }
    if (flags != 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1669
        return (NULL);
D
Daniel Veillard 已提交
1670
    }
1671

1672 1673 1674 1675 1676
    conn = domain->conn;

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

1677
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1678
    return NULL;
1679
}
1680

1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
/**
 * 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)) {
1746
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
        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)) {
1828
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1829 1830 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
        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)) {
1857
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
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
        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)) {
1885
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
        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;
}


1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
/**
 * 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
1909 1910
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
1911 1912
    DEBUG("conn=%p, info=%p", conn, info);

1913
    if (!VIR_IS_CONNECT(conn)) {
1914
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1915 1916 1917 1918 1919 1920 1921
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

1922 1923 1924
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

1925
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1926
    return -1;
1927
}
1928

1929 1930 1931 1932 1933 1934
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
1935 1936
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
1937 1938 1939 1940 1941
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
1942 1943
    DEBUG("conn=%p", conn);

1944
    if (!VIR_IS_CONNECT (conn)) {
1945
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1946 1947 1948
        return NULL;
    }

1949 1950
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
1951

1952
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1953 1954 1955
    return NULL;
}

1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
/**
 * 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)
{
    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;
}

1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992
/**
 * 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;
1993
    DEBUG("domain=%p, nparams=%p", domain, nparams);
1994 1995

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1996
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1997 1998 1999 2000 2001 2002 2003 2004 2005
        return NULL;
    }
    conn = domain->conn;

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

2006
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
    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;
2030
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2031 2032

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2033
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2034 2035 2036 2037 2038 2039 2040
        return -1;
    }
    conn = domain->conn;

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

2041
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
    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;
2062
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2063 2064

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2065
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2066 2067 2068 2069 2070 2071 2072
        return -1;
    }
    conn = domain->conn;

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

2073
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2074 2075 2076 2077
    return -1;
}


2078
/**
2079
 * virDomainBlockStats:
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
 * @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)) {
2114
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131
        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;
}

/**
2132
 * virDomainInterfaceStats:
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165
 * @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)) {
2166
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
        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;
}



2185

2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
/************************************************************************
 *									*
 *		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) {
2203 2204
    DEBUG("conn=%p, xml=%s", conn, xml);

2205
    if (!VIR_IS_CONNECT(conn)) {
2206
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2207 2208
        return (NULL);
    }
2209 2210 2211 2212
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
2213 2214 2215 2216 2217
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2218 2219
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2220

2221
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2222
    return NULL;
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
}

/**
 * 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) {
2235
    virConnectPtr conn;
2236
    DEBUG("domain=%p", domain);
2237 2238

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2239
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2240 2241
        return (-1);
    }
2242 2243
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2244 2245 2246 2247
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

2248 2249
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2250

2251
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2252
    return -1;
2253 2254 2255 2256 2257 2258
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2259
 * Provides the number of inactive domains.
2260 2261 2262 2263 2264 2265
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2266 2267
    DEBUG("conn=%p", conn);

2268
    if (!VIR_IS_CONNECT(conn)) {
2269
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2270 2271 2272
        return (-1);
    }

2273 2274
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2275

2276
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2277
    return -1;
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
}

/**
 * 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
2291
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2292
                             int maxnames) {
2293 2294
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2295
    if (!VIR_IS_CONNECT(conn)) {
2296
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2297 2298 2299
        return (-1);
    }

2300
    if ((names == NULL) || (maxnames < 0)) {
2301 2302 2303 2304
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2305 2306
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2307

2308
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2309
    return -1;
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
}

/**
 * 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) {
2323
    virConnectPtr conn;
2324
    DEBUG("domain=%p", domain);
2325

2326 2327 2328 2329
    if (domain == NULL) {
        TODO
	return (-1);
    }
2330
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2331
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2332 2333
        return (-1);
    }
2334 2335
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2336 2337 2338
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2339

2340 2341 2342
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2343
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2344
    return -1;
2345 2346
}

2347 2348 2349
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2350
 * @autostart: the value returned
2351
 *
2352
 * Provides a boolean value indicating whether the domain
2353 2354 2355 2356 2357 2358 2359
 * 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,
2360 2361 2362
                      int *autostart)
{
    virConnectPtr conn;
2363
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2364 2365

    if (!VIR_IS_DOMAIN(domain)) {
2366
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2367 2368 2369 2370 2371 2372 2373
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2374 2375 2376 2377 2378
    conn = domain->conn;

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

2379
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2380
    return -1;
2381 2382 2383 2384 2385
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
2386
 * @autostart: whether the domain should be automatically started 0 or 1
2387 2388 2389 2390 2391 2392 2393 2394
 *
 * 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,
2395 2396 2397
                      int autostart)
{
    virConnectPtr conn;
2398
    DEBUG("domain=%p, autostart=%d", domain, autostart);
2399 2400

    if (!VIR_IS_DOMAIN(domain)) {
2401
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2402 2403 2404
        return (-1);
    }

2405 2406 2407 2408 2409
    conn = domain->conn;

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

2410
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2411
    return -1;
2412 2413
}

2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
/**
 * 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)
{
2430
    virConnectPtr conn;
2431
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
2432

2433 2434 2435 2436 2437
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2438
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2439 2440
        return (-1);
    }
2441 2442 2443 2444
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2445

2446 2447 2448 2449
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2450
    conn = domain->conn;
2451

2452 2453
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
2454

2455
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2456
    return -1;
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480
}

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

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

2497
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
2498 2499 2500
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2501

2502 2503
    conn = domain->conn;

2504 2505 2506
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

2507
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2508
    return -1;
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
}

/**
 * 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)
{
2536
    virConnectPtr conn;
2537
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
2538 2539 2540 2541 2542 2543

    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2544
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
        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);
    }
2555

2556 2557
    conn = domain->conn;

2558 2559 2560 2561
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

2562
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2563
    return -1;
2564
}
2565

2566 2567 2568 2569
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
 * 
2570 2571 2572 2573 2574
 * 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.
2575 2576 2577 2578
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
2579 2580
virDomainGetMaxVcpus(virDomainPtr domain)
{
2581
    virConnectPtr conn;
2582
    DEBUG("domain=%p", domain);
2583 2584

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2585
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2586 2587 2588 2589 2590
        return (-1);
    }

    conn = domain->conn;

2591 2592 2593
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

2594
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2595
    return -1;
2596 2597 2598
}


2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
/**
 * 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
2609
virDomainAttachDevice(virDomainPtr domain, const char *xml)
2610 2611
{
    virConnectPtr conn;
2612
    DEBUG("domain=%p, xml=%s", domain, xml);
2613 2614

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

2624 2625 2626
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

2627
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2628
    return -1;
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
}

/**
 * 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
2641
virDomainDetachDevice(virDomainPtr domain, const char *xml)
2642 2643
{
    virConnectPtr conn;
2644
    DEBUG("domain=%p, xml=%s", domain, xml);
2645 2646

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2647
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2648 2649 2650 2651 2652 2653 2654 2655
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2656 2657 2658
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

2659
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2660
    return -1;
2661
}
2662

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
/**
 * 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)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
2690
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
        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;
}

2702 2703 2704 2705
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
2706
 * Provides the connection pointer associated with a network.  The
2707 2708 2709
 * reference counter on the connection is not increased by this
 * call.
 *
2710 2711 2712 2713
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
2714 2715 2716 2717 2718
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
2719 2720
    DEBUG("net=%p", net);

2721
    if (!VIR_IS_NETWORK (net)) {
2722
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
2723 2724 2725 2726 2727
        return NULL;
    }
    return net->conn;
}

2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738
/**
 * 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)
{
2739 2740
    DEBUG("conn=%p", conn);

2741
    if (!VIR_IS_CONNECT(conn)) {
2742
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2743 2744 2745
        return (-1);
    }

2746 2747
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
2748

2749
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2750
    return -1;
2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763
}

/**
 * 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
2764
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
2765
{
2766 2767
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2768
    if (!VIR_IS_CONNECT(conn)) {
2769
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2770 2771 2772
        return (-1);
    }

2773
    if ((names == NULL) || (maxnames < 0)) {
2774 2775 2776 2777
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2778 2779
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
2780

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

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

2798
    if (!VIR_IS_CONNECT(conn)) {
2799
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2800 2801 2802
        return (-1);
    }

2803 2804
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
2805

2806
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2807
    return -1;
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820
}

/**
 * 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
2821
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
2822 2823
                              int maxnames)
{
2824 2825
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2826
    if (!VIR_IS_CONNECT(conn)) {
2827
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2828 2829 2830
        return (-1);
    }

2831
    if ((names == NULL) || (maxnames < 0)) {
2832 2833 2834 2835
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2836 2837 2838
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
2839

2840
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2841
    return -1;
2842 2843 2844 2845 2846 2847 2848 2849 2850
}

/**
 * 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.
 *
2851 2852
 * 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.
2853 2854 2855 2856
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
2857 2858
    DEBUG("conn=%p, name=%s", conn, name);

2859
    if (!VIR_IS_CONNECT(conn)) {
2860
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2861 2862 2863 2864 2865 2866 2867
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2868 2869 2870
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

2871
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2872
    return NULL;
2873 2874 2875 2876 2877 2878 2879 2880 2881
}

/**
 * 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.
 *
2882 2883
 * 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.
2884 2885 2886 2887
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
2888 2889
    DEBUG("conn=%p, uuid=%s", conn, uuid);

2890
    if (!VIR_IS_CONNECT(conn)) {
2891
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2892 2893 2894 2895 2896 2897 2898
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2899 2900
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
2901

2902
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2903
    return NULL;
2904 2905 2906 2907 2908 2909 2910 2911 2912
}

/**
 * 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.
 *
2913 2914
 * 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.
2915 2916 2917 2918 2919 2920 2921
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
2922
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
2923 2924

    if (!VIR_IS_CONNECT(conn)) {
2925
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969
        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)
{
2970 2971
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

2972
    if (!VIR_IS_CONNECT(conn)) {
2973
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984
        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);
    }

2985 2986 2987
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

2988
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2989
    return NULL;
2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001
}

/**
 * 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
3002 3003
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3004 3005
    DEBUG("conn=%p, xml=%s", conn, xml);

3006
    if (!VIR_IS_CONNECT(conn)) {
3007
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
        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);
    }

3019 3020
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3021

3022
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3023
    return NULL;
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3040
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3041 3042 3043 3044 3045 3046 3047 3048
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3049 3050
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3051

3052
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3053
    return -1;
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
}

/**
 * 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
3066 3067
virNetworkCreate(virNetworkPtr network)
{
3068
    virConnectPtr conn;
3069 3070
    DEBUG("network=%p", network);

3071 3072 3073 3074 3075
    if (network == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3076
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3077 3078 3079 3080 3081 3082 3083 3084
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3085 3086 3087
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3088
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3089
    return -1;
3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3111
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3112 3113 3114 3115 3116 3117 3118 3119 3120
        return (-1);
    }

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

3121 3122
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3123

3124
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3125
    return -1;
3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
}

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

3142
    if (!VIR_IS_NETWORK(network)) {
3143
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162
        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)
{
3163 3164
    DEBUG("network=%p", network);

3165
    if (!VIR_IS_NETWORK(network)) {
3166
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
        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)
{
3184 3185
    DEBUG("network=%p, uuid=%p", network, uuid);

3186
    if (!VIR_IS_NETWORK(network)) {
3187
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213
        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];
3214
    DEBUG("network=%p, buf=%p", network, buf);
3215 3216

    if (!VIR_IS_NETWORK(network)) {
3217
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3218 3219 3220 3221 3222 3223 3224 3225
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
3226
        return (-1);
3227

3228
    virUUIDFormat(uuid, buf);
3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245
    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)
{
3246
    virConnectPtr conn;
3247
    DEBUG("network=%p, flags=%d", network, flags);
3248

3249
    if (!VIR_IS_NETWORK(network)) {
3250
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3251 3252 3253 3254 3255 3256 3257
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3258 3259 3260 3261 3262
    conn = network->conn;

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

3263
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3264
    return NULL;
3265
}
3266 3267 3268 3269 3270

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3271
 * Provides a bridge interface name to which a domain may connect
3272 3273 3274 3275 3276 3277 3278 3279
 * 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)
{
3280
    virConnectPtr conn;
3281
    DEBUG("network=%p", network);
3282

3283
    if (!VIR_IS_NETWORK(network)) {
3284
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3285 3286 3287
        return (NULL);
    }

3288 3289 3290 3291 3292
    conn = network->conn;

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

3293
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3294
    return NULL;
3295
}
3296 3297 3298 3299

/**
 * virNetworkGetAutostart:
 * @network: a network object
3300
 * @autostart: the value returned
3301
 *
3302
 * Provides a boolean value indicating whether the network
3303 3304 3305 3306 3307 3308 3309
 * 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,
3310 3311 3312
                       int *autostart)
{
    virConnectPtr conn;
3313
    DEBUG("network=%p, autostart=%p", network, autostart);
3314 3315

    if (!VIR_IS_NETWORK(network)) {
3316
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3317 3318 3319 3320 3321 3322 3323
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3324 3325 3326 3327 3328
    conn = network->conn;

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

3329
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3330
    return -1;
3331 3332 3333 3334 3335
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3336
 * @autostart: whether the network should be automatically started 0 or 1
3337 3338 3339 3340 3341 3342 3343 3344
 *
 * 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,
3345 3346 3347
                       int autostart)
{
    virConnectPtr conn;
3348
    DEBUG("network=%p, autostart=%d", network, autostart);
3349 3350

    if (!VIR_IS_NETWORK(network)) {
3351
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3352 3353 3354
        return (-1);
    }

3355 3356 3357 3358 3359
    conn = network->conn;

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

3360
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3361
    return -1;
3362
}
3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376

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