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

12
#include "config.h"
13
#include "libvirt/libvirt.h"
D
Daniel Veillard 已提交
14

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

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

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

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

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

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

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

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

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

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

106 107 108 109 110
    return(0);
}



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

412 413 414 415 416 417
    /* Convert xen:// -> xen:/// because xmlParseURI cannot parse the
     * former.  This allows URIs such as xen://localhost to work.
     */
    if (STREQ (name, "xen://"))
        name = "xen:///";

418
    if (!initialized)
419 420
        if (virInitialize() < 0)
	    return NULL;
421

422
    ret = virGetConnect();
423
    if (ret == NULL) {
424
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
425 426 427 428 429 430 431
        return NULL;
    }

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

435
#ifdef ENABLE_DEBUG
436 437 438 439 440 441 442 443 444 445 446 447
    fprintf (stderr,
             "libvirt: do_open: name \"%s\" to URI components:\n"
             "  scheme %s\n"
             "  opaque %s\n"
             "  authority %s\n"
             "  server %s\n"
             "  user %s\n"
             "  port %d\n"
             "  path %s\n",
             name,
             uri->scheme, uri->opaque, uri->authority, uri->server,
             uri->user, uri->port, uri->path);
448 449
#endif

450 451 452 453 454 455
    ret->name = strdup (name);
    if (!ret->name) {
        virLibConnError (ret, VIR_ERR_NO_MEMORY, "allocating conn->name");
        goto failed;
    }

456
    for (i = 0; i < virDriverTabCount; i++) {
457 458 459 460
#ifdef ENABLE_DEBUG
        fprintf (stderr, "libvirt: do_open: trying driver %d (%s) ...\n",
                 i, virDriverTab[i]->name);
#endif
461
        res = virDriverTab[i]->open (ret, uri, flags);
462
#ifdef ENABLE_DEBUG
463 464
        fprintf (stderr, "libvirt: do_open: driver %d %s returned %s\n",
                 i, virDriverTab[i]->name,
465 466 467 468
                 res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
                 (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
                  (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
469 470 471 472 473
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
474 475
    }

476
    if (!ret->driver) {
477 478
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
479
        goto failed;
480 481
    }

482
    for (i = 0; i < virNetworkDriverTabCount; i++) {
483
        res = virNetworkDriverTab[i]->open (ret, uri, flags);
484 485 486 487 488 489 490
#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
491
        if (res == VIR_DRV_OPEN_ERROR) {
492 493 494 495
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK, 
                                   "Is the daemon running ?");
            }
496 497
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
498 499 500
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
501
    }
502

503 504 505 506
    if (flags & VIR_DRV_OPEN_RO) {
        ret->flags = VIR_CONNECT_RO;
    }

507 508
    xmlFreeURI (uri);

509
    return ret;
510 511

failed:
512
    if (ret->name) free (ret->name);
513
    if (ret->driver) ret->driver->close (ret);
514
    if (uri) xmlFreeURI(uri);
515
	virFreeConnect(ret);
516
    return NULL;
517 518
}

519 520
/**
 * virConnectOpen:
521
 * @name: URI of the hypervisor
522 523 524 525 526
 *
 * 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
527 528
 *
 * URIs are documented at http://libvirt.org/uri.html
529 530 531 532
 */
virConnectPtr
virConnectOpen (const char *name)
{
533
    DEBUG("name=%s", name);
534
    return do_open (name, 0);
535 536
}

537
/**
538
 * virConnectOpenReadOnly:
539
 * @name: URI of the hypervisor
540
 *
541 542 543
 * 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.
544 545
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
546 547
 *
 * URIs are documented at http://libvirt.org/uri.html
548
 */
549
virConnectPtr
550 551
virConnectOpenReadOnly(const char *name)
{
552
    DEBUG("name=%s", name);
553
    return do_open (name, VIR_DRV_OPEN_RO);
D
Daniel Veillard 已提交
554 555 556
}

/**
557
 * virConnectClose:
D
Daniel Veillard 已提交
558 559 560 561 562 563 564 565 566 567
 * @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
568 569
virConnectClose(virConnectPtr conn)
{
570 571
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
572
    if (!VIR_IS_CONNECT(conn))
573
        return (-1);
574 575 576

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
577
    conn->driver->close (conn);
578

579 580
    if (conn->name) free (conn->name);

581 582
    if (virFreeConnect(conn) < 0)
        return (-1);
583
    return (0);
D
Daniel Veillard 已提交
584 585
}

586 587 588 589 590 591 592 593 594 595 596 597 598 599
/* 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);
}

600 601 602 603 604 605 606
/**
 * 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.
607 608 609
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
610 611
 */
const char *
612 613
virConnectGetType(virConnectPtr conn)
{
614
    const char *ret;
615
    DEBUG("conn=%p", conn);
616

D
Daniel Veillard 已提交
617
    if (!VIR_IS_CONNECT(conn)) {
618
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
619
        return (NULL);
D
Daniel Veillard 已提交
620
    }
621 622 623 624

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
625
    }
626
    return conn->driver->name;
627 628
}

D
Daniel Veillard 已提交
629
/**
630
 * virConnectGetVersion:
D
Daniel Veillard 已提交
631
 * @conn: pointer to the hypervisor connection
632
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
633
 *
634 635 636
 * 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 已提交
637
 *
638 639 640
 * 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 已提交
641
 */
642
int
643 644
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
645 646
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
647
    if (!VIR_IS_CONNECT(conn)) {
648
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
649
        return (-1);
D
Daniel Veillard 已提交
650
    }
651

D
Daniel Veillard 已提交
652 653
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
654
        return (-1);
D
Daniel Veillard 已提交
655
    }
656

657 658
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
659

660 661
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
662 663
}

664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
/**
 * 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)
{
679 680
    DEBUG("conn=%p", conn);

681
    if (!VIR_IS_CONNECT(conn)) {
682
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
        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)
{
711 712
    char *name;

713 714
    DEBUG("conn=%p", conn);

715
    if (!VIR_IS_CONNECT(conn)) {
716
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
717 718 719
        return NULL;
    }

720 721 722
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
723 724 725
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

726 727 728 729 730 731
    name = strdup (conn->name);
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
732 733
}

734 735 736 737 738
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
739
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
740 741 742 743 744 745 746 747 748
 * 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)
{
749 750
    DEBUG("conn=%p, type=%s", conn, type);

751
    if (!VIR_IS_CONNECT(conn)) {
752
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
753 754 755
        return (-1);
    }

756 757
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
758

759 760
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
761 762
}

763
/**
764
 * virConnectListDomains:
765 766 767 768 769 770 771 772 773
 * @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
774 775
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
776 777
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
778
    if (!VIR_IS_CONNECT(conn)) {
779
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
780
        return (-1);
D
Daniel Veillard 已提交
781
    }
782

783
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
784
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
785
        return (-1);
D
Daniel Veillard 已提交
786
    }
787

788 789
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
790

791 792
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
793 794
}

K
 
Karel Zak 已提交
795 796 797 798
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
799 800
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
801 802 803
 * Returns the number of domain found or -1 in case of error
 */
int
804 805
virConnectNumOfDomains(virConnectPtr conn)
{
806 807
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
808
    if (!VIR_IS_CONNECT(conn)) {
809
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
810
        return (-1);
D
Daniel Veillard 已提交
811
    }
K
Karel Zak 已提交
812

813 814
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
815

816 817
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
818 819
}

820 821 822 823
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
824
 * Provides the connection pointer associated with a domain.  The
825 826 827
 * reference counter on the connection is not increased by this
 * call.
 *
828 829 830 831
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
832 833 834 835 836
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
837 838
    DEBUG("dom=%p", dom);

839
    if (!VIR_IS_DOMAIN (dom)) {
840
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
841 842 843 844 845
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
846
/**
847
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
848
 * @conn: pointer to the hypervisor connection
849
 * @xmlDesc: an XML description of the domain
850
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
851
 *
852 853 854
 * 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 已提交
855 856 857
 * 
 * Returns a new domain object or NULL in case of failure
 */
858
virDomainPtr
859 860
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
861
{
862 863
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
864
    if (!VIR_IS_CONNECT(conn)) {
865
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
866
        return (NULL);
D
Daniel Veillard 已提交
867 868 869
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
870
        return (NULL);
D
Daniel Veillard 已提交
871
    }
872 873 874 875
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
876

877 878 879 880 881
    if (conn->driver->domainCreateLinux)
        return conn->driver->domainCreateLinux (conn, xmlDesc, flags);

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

884

885
/**
886
 * virDomainLookupByID:
887 888 889 890 891
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
 *
892 893
 * 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.
894
 */
895
virDomainPtr
896 897
virDomainLookupByID(virConnectPtr conn, int id)
{
898 899
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
900
    if (!VIR_IS_CONNECT(conn)) {
901
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
902
        return (NULL);
D
Daniel Veillard 已提交
903 904 905
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
906
        return (NULL);
D
Daniel Veillard 已提交
907
    }
908

909 910
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
911

912 913
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
914 915 916 917 918
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
919
 * @uuid: the raw UUID for the domain
920 921 922
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
923 924
 * 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.
925 926
 */
virDomainPtr
927 928
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
929 930
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
931
    if (!VIR_IS_CONNECT(conn)) {
932
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
933
        return (NULL);
D
Daniel Veillard 已提交
934 935 936
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
937
        return (NULL);
D
Daniel Veillard 已提交
938
    }
939

940 941
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
942

943 944
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
945 946
}

K
Karel Zak 已提交
947 948 949 950 951 952 953
/**
 * 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.
 *
954 955
 * 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 已提交
956 957 958 959
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
960 961
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
962 963
    int ret;

964 965
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
966
    if (!VIR_IS_CONNECT(conn)) {
967
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
        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);
    
989
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
990 991 992
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
993
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
994 995 996 997 998
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

999 1000 1001 1002 1003
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1004
 * Try to lookup a domain on the given hypervisor based on its name.
1005
 *
1006 1007
 * 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.
1008 1009
 */
virDomainPtr
1010 1011
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1012 1013
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1014
    if (!VIR_IS_CONNECT(conn)) {
1015
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1016
        return (NULL);
D
Daniel Veillard 已提交
1017 1018 1019
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1020
        return (NULL);
D
Daniel Veillard 已提交
1021
    }
1022

1023 1024 1025 1026 1027
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
1030
/**
1031
 * virDomainDestroy:
D
Daniel Veillard 已提交
1032 1033 1034 1035
 * @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.
1036 1037
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
1038
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1039 1040
 *
 * Returns 0 in case of success and -1 in case of failure.
1041
 */
D
Daniel Veillard 已提交
1042
int
1043 1044
virDomainDestroy(virDomainPtr domain)
{
1045
    virConnectPtr conn;
1046

1047 1048
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1049
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1050
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1051
        return (-1);
D
Daniel Veillard 已提交
1052
    }
1053

1054
    conn = domain->conn;
1055 1056 1057 1058
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1059

1060 1061
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1062

1063 1064
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
}

/**
 * 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
1077 1078
virDomainFree(virDomainPtr domain)
{
1079 1080
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1081
    if (!VIR_IS_DOMAIN(domain)) {
1082
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1083
        return (-1);
D
Daniel Veillard 已提交
1084
    }
1085 1086 1087
    if (virFreeDomain(domain->conn, domain) < 0)
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1088 1089 1090
}

/**
1091
 * virDomainSuspend:
D
Daniel Veillard 已提交
1092 1093 1094 1095
 * @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 
1096
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1097
 * the domain.
1098
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
1099 1100 1101 1102
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1103 1104
virDomainSuspend(virDomainPtr domain)
{
1105
    virConnectPtr conn;
1106
    DEBUG("domain=%p", domain);
1107

D
Daniel Veillard 已提交
1108
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1109
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1110
        return (-1);
D
Daniel Veillard 已提交
1111
    }
1112 1113 1114 1115
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1116

1117 1118
    conn = domain->conn;

1119 1120
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1121

1122 1123
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1124 1125 1126
}

/**
1127
 * virDomainResume:
D
Daniel Veillard 已提交
1128 1129 1130
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1131
 * it was frozen by calling virSuspendDomain().
1132
 * This function may requires priviledged access
D
Daniel Veillard 已提交
1133 1134 1135 1136
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1137 1138
virDomainResume(virDomainPtr domain)
{
1139
    virConnectPtr conn;
1140
    DEBUG("domain=%p", domain);
1141

D
Daniel Veillard 已提交
1142
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1143
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1144
        return (-1);
D
Daniel Veillard 已提交
1145
    }
1146 1147 1148 1149
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1150

1151 1152
    conn = domain->conn;

1153 1154
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1155

1156 1157
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1158 1159
}

1160 1161 1162 1163 1164 1165
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1166 1167 1168
 * 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.
1169 1170 1171 1172
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1173 1174
virDomainSave(virDomainPtr domain, const char *to)
{
1175
    char filepath[4096];
1176
    virConnectPtr conn;
1177
    DEBUG("domain=%p, to=%s", domain, to);
1178

D
Daniel Veillard 已提交
1179
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1180
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1181
        return (-1);
D
Daniel Veillard 已提交
1182
    }
1183 1184 1185 1186
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1187
    conn = domain->conn;
D
Daniel Veillard 已提交
1188 1189
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1190
        return (-1);
D
Daniel Veillard 已提交
1191
    }
1192

1193 1194 1195 1196 1197
    /*
     * 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] != '/') {
1198
        unsigned int len, t;
1199

1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
        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];
1210 1211 1212

    }

1213 1214 1215
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1216
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1217
    return -1;
1218 1219 1220 1221
}

/**
 * virDomainRestore:
1222
 * @conn: pointer to the hypervisor connection
1223 1224 1225 1226 1227 1228 1229
 * @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
1230 1231
virDomainRestore(virConnectPtr conn, const char *from)
{
1232
    char filepath[4096];
1233
    DEBUG("conn=%p, from=%s", conn, from);
1234

D
Daniel Veillard 已提交
1235
    if (!VIR_IS_CONNECT(conn)) {
1236
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1237
        return (-1);
D
Daniel Veillard 已提交
1238
    }
1239 1240 1241 1242
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
1243 1244
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1245
        return (-1);
D
Daniel Veillard 已提交
1246 1247
    }

1248 1249 1250 1251 1252
    /*
     * 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] != '/') {
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
        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];
    }

1267 1268 1269
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1270
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1271
    return -1;
D
Daniel Veillard 已提交
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1294
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
        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];

    }

1327 1328 1329
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1330
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1331
    return -1;
1332 1333
}

1334 1335 1336 1337 1338
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1339 1340
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1341 1342 1343 1344 1345 1346 1347
 *
 * 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
1348 1349
virDomainShutdown(virDomainPtr domain)
{
1350
    virConnectPtr conn;
1351
    DEBUG("domain=%p", domain);
1352

D
Daniel Veillard 已提交
1353
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1354
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1355
        return (-1);
D
Daniel Veillard 已提交
1356
    }
1357 1358 1359 1360
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1361

1362 1363
    conn = domain->conn;

1364 1365
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1366

1367
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1368
    return -1;
1369 1370
}

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
/**
 * 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)
{
1385
    virConnectPtr conn;
1386
    DEBUG("domain=%p, flags=%u", domain, flags);
1387 1388

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1389
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1390 1391
        return (-1);
    }
1392 1393 1394 1395
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1396

1397 1398
    conn = domain->conn;

1399 1400
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1401

1402
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1403
    return -1;
1404 1405
}

1406
/**
1407
 * virDomainGetName:
1408 1409 1410 1411 1412 1413 1414 1415
 * @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 *
1416 1417
virDomainGetName(virDomainPtr domain)
{
1418 1419
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1420
    if (!VIR_IS_DOMAIN(domain)) {
1421
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1422
        return (NULL);
D
Daniel Veillard 已提交
1423
    }
1424
    return (domain->name);
1425 1426
}

1427 1428 1429
/**
 * virDomainGetUUID:
 * @domain: a domain object
1430
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1431 1432 1433 1434 1435 1436
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1437 1438
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1439 1440
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1441
    if (!VIR_IS_DOMAIN(domain)) {
1442
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1443
        return (-1);
D
Daniel Veillard 已提交
1444 1445 1446
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1447
        return (-1);
D
Daniel Veillard 已提交
1448 1449
    }

1450
    if (domain->id == 0) {
1451
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1452
    } else {
1453
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1454 1455
    }
    return (0);
1456 1457
}

K
Karel Zak 已提交
1458 1459 1460
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1461
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470
 *
 * 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)
{
1471
    unsigned char uuid[VIR_UUID_BUFLEN];
1472
    DEBUG("domain=%p, buf=%p", domain, buf);
1473

K
Karel Zak 已提交
1474
    if (!VIR_IS_DOMAIN(domain)) {
1475
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1476 1477 1478 1479 1480 1481 1482 1483
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    
    if (virDomainGetUUID(domain, &uuid[0]))
1484
        return (-1);
K
Karel Zak 已提交
1485

1486
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1487 1488 1489
    return (0);
}

1490
/**
1491
 * virDomainGetID:
1492 1493 1494 1495 1496 1497 1498
 * @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
1499 1500
virDomainGetID(virDomainPtr domain)
{
1501 1502
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1503
    if (!VIR_IS_DOMAIN(domain)) {
1504
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1505
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1506
    }
1507
    return (domain->id);
1508 1509
}

1510 1511 1512 1513 1514 1515
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1516 1517
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1518 1519
 */
char *
1520 1521
virDomainGetOSType(virDomainPtr domain)
{
1522
    virConnectPtr conn;
1523
    DEBUG("domain=%p", domain);
1524

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

1530 1531 1532 1533
    conn = domain->conn;

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

1535
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1536
    return NULL;
1537 1538
}

1539
/**
1540
 * virDomainGetMaxMemory:
1541 1542 1543 1544 1545 1546 1547 1548 1549
 * @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
1550 1551
virDomainGetMaxMemory(virDomainPtr domain)
{
1552
    virConnectPtr conn;
1553
    DEBUG("domain=%p", domain);
1554

D
Daniel Veillard 已提交
1555
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1556
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1557
        return (0);
D
Daniel Veillard 已提交
1558
    }
1559

1560 1561
    conn = domain->conn;

1562 1563 1564
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1565
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1566
    return 0;
1567 1568
}

D
Daniel Veillard 已提交
1569
/**
1570
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1571 1572 1573 1574 1575 1576
 * @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.
1577
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1578 1579 1580 1581
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1582 1583
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1584
    virConnectPtr conn;
1585
    DEBUG("domain=%p, memory=%lu", domain, memory);
1586

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

1605 1606 1607
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

1608
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1609
    return -1;
1610
}
1611

1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
/**
 * 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;
1628
    DEBUG("domain=%p, memory=%lu", domain, memory);
1629

1630 1631 1632 1633 1634
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1635
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1636
        return (-1);
1637
    }
1638 1639 1640 1641 1642 1643
    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__);
1644
        return (-1);
1645 1646 1647
    }

    conn = domain->conn;
1648

1649 1650 1651
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

1652
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1653
    return -1;
D
Daniel Veillard 已提交
1654 1655
}

1656 1657
/**
 * virDomainGetInfo:
1658
 * @domain: a domain object
1659 1660 1661
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1662
 * used to get the domain is limited only a partial set of the information
1663 1664 1665 1666 1667
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1668 1669
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1670
    virConnectPtr conn;
1671
    DEBUG("domain=%p, info=%p", domain, info);
1672

D
Daniel Veillard 已提交
1673
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1674
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1675
        return (-1);
D
Daniel Veillard 已提交
1676 1677 1678
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1679
        return (-1);
D
Daniel Veillard 已提交
1680
    }
1681

1682
    memset(info, 0, sizeof(virDomainInfo));
1683

1684 1685 1686 1687
    conn = domain->conn;

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

1689
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1690
    return -1;
1691
}
1692

1693 1694 1695
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
1696
 * @flags: an OR'ed set of virDomainXMLFlags
1697 1698 1699 1700 1701 1702 1703 1704
 *
 * 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 *
1705 1706
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1707
    virConnectPtr conn;
1708
    DEBUG("domain=%p, flags=%d", domain, flags);
1709

D
Daniel Veillard 已提交
1710
    if (!VIR_IS_DOMAIN(domain)) {
1711
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1712
        return (NULL);
D
Daniel Veillard 已提交
1713 1714 1715
    }
    if (flags != 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1716
        return (NULL);
D
Daniel Veillard 已提交
1717
    }
1718

1719 1720 1721 1722 1723
    conn = domain->conn;

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

1724
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1725
    return NULL;
1726
}
1727

1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 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
/**
 * 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)) {
1793
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
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 1828 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 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
        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)) {
1875
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
        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)) {
1904
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
        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)) {
1932
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
        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;
}


1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
/**
 * 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
1956 1957
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
1958 1959
    DEBUG("conn=%p, info=%p", conn, info);

1960
    if (!VIR_IS_CONNECT(conn)) {
1961
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1962 1963 1964 1965 1966 1967 1968
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

1969 1970 1971
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

1972
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1973
    return -1;
1974
}
1975

1976 1977 1978 1979 1980 1981
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
1982 1983
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
1984 1985 1986 1987 1988
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
1989 1990
    DEBUG("conn=%p", conn);

1991
    if (!VIR_IS_CONNECT (conn)) {
1992
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1993 1994 1995
        return NULL;
    }

1996 1997
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
1998

1999
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2000 2001 2002
    return NULL;
}

2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
/**
 * 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)
{
2014 2015
    DEBUG("conn=%p", conn);

2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
    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;
}

2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041
/**
 * 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;
2042
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2043 2044

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2045
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2046 2047 2048 2049 2050 2051 2052 2053 2054
        return NULL;
    }
    conn = domain->conn;

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

2055
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
    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;
2079
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2080 2081

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2082
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2083 2084 2085 2086 2087 2088 2089
        return -1;
    }
    conn = domain->conn;

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

2090
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
    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;
2111
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2112 2113

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2114
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2115 2116 2117 2118 2119 2120 2121
        return -1;
    }
    conn = domain->conn;

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

2122
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2123 2124 2125 2126
    return -1;
}


2127
/**
2128
 * virDomainBlockStats:
2129 2130 2131 2132 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
 * @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)) {
2163
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
        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;
}

/**
2181
 * virDomainInterfaceStats:
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
 * @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)) {
2215
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
        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;
}



2234

2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251
/************************************************************************
 *									*
 *		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) {
2252 2253
    DEBUG("conn=%p, xml=%s", conn, xml);

2254
    if (!VIR_IS_CONNECT(conn)) {
2255
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2256 2257
        return (NULL);
    }
2258 2259 2260 2261
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
2262 2263 2264 2265 2266
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2267 2268
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2269

2270
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2271
    return NULL;
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
}

/**
 * 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) {
2284
    virConnectPtr conn;
2285
    DEBUG("domain=%p", domain);
2286 2287

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2288
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2289 2290
        return (-1);
    }
2291 2292
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2293 2294 2295 2296
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

2297 2298
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2299

2300
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2301
    return -1;
2302 2303 2304 2305 2306 2307
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2308
 * Provides the number of inactive domains.
2309 2310 2311 2312 2313 2314
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2315 2316
    DEBUG("conn=%p", conn);

2317
    if (!VIR_IS_CONNECT(conn)) {
2318
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2319 2320 2321
        return (-1);
    }

2322 2323
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2324

2325
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2326
    return -1;
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339
}

/**
 * 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
2340
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2341
                             int maxnames) {
2342 2343
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2344
    if (!VIR_IS_CONNECT(conn)) {
2345
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2346 2347 2348
        return (-1);
    }

2349
    if ((names == NULL) || (maxnames < 0)) {
2350 2351 2352 2353
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2354 2355
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2356

2357
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2358
    return -1;
2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
}

/**
 * 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) {
2372
    virConnectPtr conn;
2373
    DEBUG("domain=%p", domain);
2374

2375 2376 2377 2378
    if (domain == NULL) {
        TODO
	return (-1);
    }
2379
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2380
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2381 2382
        return (-1);
    }
2383 2384
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2385 2386 2387
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2388

2389 2390 2391
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2392
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2393
    return -1;
2394 2395
}

2396 2397 2398
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2399
 * @autostart: the value returned
2400
 *
2401
 * Provides a boolean value indicating whether the domain
2402 2403 2404 2405 2406 2407 2408
 * 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,
2409 2410 2411
                      int *autostart)
{
    virConnectPtr conn;
2412
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2413 2414

    if (!VIR_IS_DOMAIN(domain)) {
2415
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2416 2417 2418 2419 2420 2421 2422
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2423 2424 2425 2426 2427
    conn = domain->conn;

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

2428
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2429
    return -1;
2430 2431 2432 2433 2434
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
2435
 * @autostart: whether the domain should be automatically started 0 or 1
2436 2437 2438 2439 2440 2441 2442 2443
 *
 * 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,
2444 2445 2446
                      int autostart)
{
    virConnectPtr conn;
2447
    DEBUG("domain=%p, autostart=%d", domain, autostart);
2448 2449

    if (!VIR_IS_DOMAIN(domain)) {
2450
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2451 2452 2453
        return (-1);
    }

2454 2455 2456 2457 2458
    conn = domain->conn;

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

2459
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2460
    return -1;
2461 2462
}

2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
/**
 * 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)
{
2479
    virConnectPtr conn;
2480
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
2481

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

2495 2496 2497 2498
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2499
    conn = domain->conn;
2500

2501 2502
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
2503

2504
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2505
    return -1;
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
}

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

2533 2534 2535 2536 2537
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2538
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2539 2540
        return (-1);
    }
2541 2542 2543 2544
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
2545

2546
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
2547 2548 2549
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2550

2551 2552
    conn = domain->conn;

2553 2554 2555
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

2556
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2557
    return -1;
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
}

/**
 * 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)
{
2585
    virConnectPtr conn;
2586
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
2587 2588 2589 2590 2591 2592

    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2593
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2594 2595 2596 2597 2598 2599 2600 2601 2602 2603
        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);
    }
2604

2605 2606
    conn = domain->conn;

2607 2608 2609 2610
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

2611
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2612
    return -1;
2613
}
2614

2615 2616 2617 2618
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
 * 
2619 2620 2621 2622 2623
 * 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.
2624 2625 2626 2627
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
2628 2629
virDomainGetMaxVcpus(virDomainPtr domain)
{
2630
    virConnectPtr conn;
2631
    DEBUG("domain=%p", domain);
2632 2633

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2634
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2635 2636 2637 2638 2639
        return (-1);
    }

    conn = domain->conn;

2640 2641 2642
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

2643
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2644
    return -1;
2645 2646 2647
}


2648 2649 2650 2651 2652 2653 2654 2655 2656 2657
/**
 * 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
2658
virDomainAttachDevice(virDomainPtr domain, const char *xml)
2659 2660
{
    virConnectPtr conn;
2661
    DEBUG("domain=%p, xml=%s", domain, xml);
2662 2663

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2664
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2665 2666 2667 2668 2669 2670 2671 2672
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2673 2674 2675
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

2676
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2677
    return -1;
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
}

/**
 * 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
2690
virDomainDetachDevice(virDomainPtr domain, const char *xml)
2691 2692
{
    virConnectPtr conn;
2693
    DEBUG("domain=%p, xml=%s", domain, xml);
2694 2695

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2696
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2697 2698 2699 2700 2701 2702 2703 2704
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

2705 2706 2707
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

2708
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2709
    return -1;
2710
}
2711

2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
/**
 * 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)
{
2734 2735 2736
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

2737 2738 2739 2740 2741
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
2742
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753
        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;
}

2754 2755 2756 2757
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
2758
 * Provides the connection pointer associated with a network.  The
2759 2760 2761
 * reference counter on the connection is not increased by this
 * call.
 *
2762 2763 2764 2765
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
2766 2767 2768 2769 2770
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
2771 2772
    DEBUG("net=%p", net);

2773
    if (!VIR_IS_NETWORK (net)) {
2774
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
2775 2776 2777 2778 2779
        return NULL;
    }
    return net->conn;
}

2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790
/**
 * 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)
{
2791 2792
    DEBUG("conn=%p", conn);

2793
    if (!VIR_IS_CONNECT(conn)) {
2794
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2795 2796 2797
        return (-1);
    }

2798 2799
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
2800

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

/**
 * 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
2816
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
2817
{
2818 2819
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2820
    if (!VIR_IS_CONNECT(conn)) {
2821
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2822 2823 2824
        return (-1);
    }

2825
    if ((names == NULL) || (maxnames < 0)) {
2826 2827 2828 2829
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2830 2831
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
2832

2833
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2834
    return -1;
2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
}

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

2850
    if (!VIR_IS_CONNECT(conn)) {
2851
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2852 2853 2854
        return (-1);
    }

2855 2856
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
2857

2858
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2859
    return -1;
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872
}

/**
 * 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
2873
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
2874 2875
                              int maxnames)
{
2876 2877
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2878
    if (!VIR_IS_CONNECT(conn)) {
2879
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2880 2881 2882
        return (-1);
    }

2883
    if ((names == NULL) || (maxnames < 0)) {
2884 2885 2886 2887
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2888 2889 2890
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
2891

2892
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2893
    return -1;
2894 2895 2896 2897 2898 2899 2900 2901 2902
}

/**
 * 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.
 *
2903 2904
 * 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.
2905 2906 2907 2908
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
2909 2910
    DEBUG("conn=%p, name=%s", conn, name);

2911
    if (!VIR_IS_CONNECT(conn)) {
2912
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2913 2914 2915 2916 2917 2918 2919
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2920 2921 2922
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

2923
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2924
    return NULL;
2925 2926 2927 2928 2929 2930 2931 2932 2933
}

/**
 * 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.
 *
2934 2935
 * 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.
2936 2937 2938 2939
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
2940 2941
    DEBUG("conn=%p, uuid=%s", conn, uuid);

2942
    if (!VIR_IS_CONNECT(conn)) {
2943
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2944 2945 2946 2947 2948 2949 2950
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2951 2952
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
2953

2954
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2955
    return NULL;
2956 2957 2958 2959 2960 2961 2962 2963 2964
}

/**
 * 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.
 *
2965 2966
 * 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.
2967 2968 2969 2970 2971 2972 2973
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
2974
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
2975 2976

    if (!VIR_IS_CONNECT(conn)) {
2977
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021
        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)
{
3022 3023
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3024
    if (!VIR_IS_CONNECT(conn)) {
3025
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
        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);
    }

3037 3038 3039
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3040
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3041
    return NULL;
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053
}

/**
 * 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
3054 3055
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3056 3057
    DEBUG("conn=%p, xml=%s", conn, xml);

3058
    if (!VIR_IS_CONNECT(conn)) {
3059
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070
        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);
    }

3071 3072
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3073

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

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3092
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3093 3094 3095 3096 3097 3098 3099 3100
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3101 3102
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3103

3104
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3105
    return -1;
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117
}

/**
 * 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
3118 3119
virNetworkCreate(virNetworkPtr network)
{
3120
    virConnectPtr conn;
3121 3122
    DEBUG("network=%p", network);

3123 3124 3125 3126 3127
    if (network == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3128
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3129 3130 3131 3132 3133 3134 3135 3136
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

3137 3138 3139
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3140
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3141
    return -1;
3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3163
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3164 3165 3166 3167 3168 3169 3170 3171 3172
        return (-1);
    }

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

3173 3174
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3175

3176
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3177
    return -1;
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191
}

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

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

3217
    if (!VIR_IS_NETWORK(network)) {
3218
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235
        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)
{
3236 3237
    DEBUG("network=%p, uuid=%p", network, uuid);

3238
    if (!VIR_IS_NETWORK(network)) {
3239
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265
        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];
3266
    DEBUG("network=%p, buf=%p", network, buf);
3267 3268

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

    if (virNetworkGetUUID(network, &uuid[0]))
3278
        return (-1);
3279

3280
    virUUIDFormat(uuid, buf);
3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297
    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)
{
3298
    virConnectPtr conn;
3299
    DEBUG("network=%p, flags=%d", network, flags);
3300

3301
    if (!VIR_IS_NETWORK(network)) {
3302
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3303 3304 3305 3306 3307 3308 3309
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3310 3311 3312 3313 3314
    conn = network->conn;

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

3315
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3316
    return NULL;
3317
}
3318 3319 3320 3321 3322

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3323
 * Provides a bridge interface name to which a domain may connect
3324 3325 3326 3327 3328 3329 3330 3331
 * 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)
{
3332
    virConnectPtr conn;
3333
    DEBUG("network=%p", network);
3334

3335
    if (!VIR_IS_NETWORK(network)) {
3336
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3337 3338 3339
        return (NULL);
    }

3340 3341 3342 3343 3344
    conn = network->conn;

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

3345
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3346
    return NULL;
3347
}
3348 3349 3350 3351

/**
 * virNetworkGetAutostart:
 * @network: a network object
3352
 * @autostart: the value returned
3353
 *
3354
 * Provides a boolean value indicating whether the network
3355 3356 3357 3358 3359 3360 3361
 * 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,
3362 3363 3364
                       int *autostart)
{
    virConnectPtr conn;
3365
    DEBUG("network=%p, autostart=%p", network, autostart);
3366 3367

    if (!VIR_IS_NETWORK(network)) {
3368
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3369 3370 3371 3372 3373 3374 3375
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3376 3377 3378 3379 3380
    conn = network->conn;

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

3381
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3382
    return -1;
3383 3384 3385 3386 3387
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3388
 * @autostart: whether the network should be automatically started 0 or 1
3389 3390 3391 3392 3393 3394 3395 3396
 *
 * 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,
3397 3398 3399
                       int autostart)
{
    virConnectPtr conn;
3400
    DEBUG("network=%p, autostart=%d", network, autostart);
3401 3402

    if (!VIR_IS_NETWORK(network)) {
3403
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3404 3405 3406
        return (-1);
    }

3407 3408 3409 3410 3411
    conn = network->conn;

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

3412
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3413
    return -1;
3414
}
3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428

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