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

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

21 22 23
#include <libxml/parser.h>
#include <libxml/xpath.h>

24
#include <xs.h>
25

D
Daniel Veillard 已提交
26
#include "internal.h"
27
#include "driver.h"
28
#include "xen_internal.h"
29
#include "xend_internal.h"
30
#include "xs_internal.h"
31
#include "xm_internal.h"
32
#include "proxy_internal.h"
33
#include "xml.h"
34
#include "test.h"
35

D
Daniel Veillard 已提交
36 37 38 39
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
 * - use reference counting to garantee coherent pointer state ?
40
 * - memory wrappers for malloc/free ?
D
Daniel Veillard 已提交
41 42
 */

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
static virDriverPtr virDriverTab[MAX_DRIVERS];
static int initialized = 0;

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

    if (initialized)
        return(0);
62
    initialized = 1;
63

64 65 66
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

67 68 69
    /*
     * should not be needed but...
     */
70
    for (i = 0;i < MAX_DRIVERS;i++)
71 72 73 74 75 76
         virDriverTab[i] = NULL;

    /*
     * Note that the order is important the first ones have a higher priority
     */
    xenHypervisorRegister();
77
    xenProxyRegister();
78 79
    xenDaemonRegister();
    xenStoreRegister();
80
    xenXMRegister();
81
    testRegister();
82 83 84 85 86
    return(0);
}



D
Daniel Veillard 已提交
87 88 89 90 91 92 93 94 95
/**
 * virLibConnError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
96 97
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
98
    const char *errmsg;
99

D
Daniel Veillard 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    if (error == VIR_ERR_OK)
        return;

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

/**
 * virLibConnError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
117 118 119
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
120 121
    virConnectPtr conn = NULL;
    const char *errmsg;
122

D
Daniel Veillard 已提交
123 124 125 126 127 128 129 130 131 132 133
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
    __virRaiseError(conn, domain, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

134 135 136 137 138 139 140 141 142 143 144 145 146
/**
 * 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)
{
    int i;

147
    if (!initialized)
148 149
        if (virInitialize() < 0)
	    return -1;
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return(-1);
    }
    for (i = 0;i < MAX_DRIVERS;i++) {
        if (virDriverTab[i] == driver)
	    return(i);
    }
    for (i = 0;i < MAX_DRIVERS;i++) {
        if (virDriverTab[i] == NULL) {
	    virDriverTab[i] = driver;
	    return(i);
	}
    }
    virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
    return(-1);
}

169 170 171
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
172
 * @type: the type of connection/driver looked at
173 174 175 176 177 178 179 180 181 182 183 184
 * @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
185 186 187
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
188 189
    int i;

190
    if (!initialized)
191 192
        if (virInitialize() < 0)
	    return -1;
193

194
    if (libVer == NULL)
195
        return (-1);
196 197 198
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
199 200 201 202 203 204 205 206 207 208
        if (type == NULL)
	    type = "Xen";
	for (i = 0;i < MAX_DRIVERS;i++) {
	    if ((virDriverTab[i] != NULL) &&
	        (!strcmp(virDriverTab[i]->name, type))) {
		*typeVer = virDriverTab[i]->ver;
		break;
	    }
	}
        if (i >= MAX_DRIVERS) {
209
            *typeVer = 0;
210
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
211 212 213 214
            return (-1);
        }
    }
    return (0);
215 216
}

D
Daniel Veillard 已提交
217
/**
218
 * virConnectOpen:
D
Daniel Veillard 已提交
219 220 221
 * @name: optional argument currently unused, pass NULL
 *
 * This function should be called first to get a connection to the 
222
 * Hypervisor and xen store
D
Daniel Veillard 已提交
223 224 225
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
 */
226
virConnectPtr
227 228
virConnectOpen(const char *name)
{
229
    int i, res, for_xen = 0;
230
    virConnectPtr ret = NULL;
231

232
    if (!initialized)
233 234
        if (virInitialize() < 0)
	    return NULL;
235

236 237 238
    if (name == NULL) {
        name = "Xen";
	for_xen = 1;
239
    } else if (!strncasecmp(name, "xen", 3)) {
240 241 242
	for_xen = 1;
    }

243
    ret = virGetConnect();
244
    if (ret == NULL) {
245
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
246 247 248
        goto failed;
    }

249 250
    for (i = 0;i < MAX_DRIVERS;i++) {
        if ((virDriverTab[i] != NULL) && (virDriverTab[i]->open != NULL)) {
251
	    res = virDriverTab[i]->open(ret, name, VIR_DRV_OPEN_QUIET);
252 253 254 255
	    /*
	     * For a default connect to Xen make sure we manage to contact
	     * all related drivers.
	     */
256
	    if ((res < 0) && (for_xen) &&
257 258
	        (!strncasecmp(virDriverTab[i]->name, "xen", 3)) &&
		(virDriverTab[i]->no != VIR_DRV_XEN_PROXY))
259 260 261 262 263 264 265 266 267 268 269
		goto failed;
	    if (res == 0)
	        ret->drivers[ret->nb_drivers++] = virDriverTab[i];
	}
    }

    if (ret->nb_drivers == 0) {
	/* we failed to find an adequate driver */
	virLibConnError(NULL, VIR_ERR_NO_SUPPORT, name);
	goto failed;
    }
270

271
    return (ret);
272 273 274

failed:
    if (ret != NULL) {
275 276 277 278
	for (i = 0;i < ret->nb_drivers;i++) {
	    if ((ret->drivers[i] != NULL) && (ret->drivers[i]->close != NULL))
	        ret->drivers[i]->close(ret);
	}
279
	virFreeConnect(ret);
280
    }
281
    return (NULL);
282 283 284
}

/**
285
 * virConnectOpenReadOnly:
286 287
 * @name: optional argument currently unused, pass NULL
 *
288 289 290
 * 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.
291 292 293
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
 */
294
virConnectPtr
295 296
virConnectOpenReadOnly(const char *name)
{
297
    int i, res;
298
    virConnectPtr ret = NULL;
299

300
    if (!initialized)
301 302
        if (virInitialize() < 0)
	    return NULL;
303

304 305 306
    if (name == NULL)
        name = "Xen";

307
    ret = virGetConnect();
D
Daniel Veillard 已提交
308
    if (ret == NULL) {
309
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
310
        goto failed;
D
Daniel Veillard 已提交
311
    }
312

313 314 315 316 317 318
    for (i = 0;i < MAX_DRIVERS;i++) {
        if ((virDriverTab[i] != NULL) && (virDriverTab[i]->open != NULL)) {
	    res = virDriverTab[i]->open(ret, name,
	                                VIR_DRV_OPEN_QUIET | VIR_DRV_OPEN_RO);
	    if (res == 0)
	        ret->drivers[ret->nb_drivers++] = virDriverTab[i];
319

320 321 322 323 324
	}
    }
    if (ret->nb_drivers == 0) {
	if (name == NULL)
	    virLibConnError(NULL, VIR_ERR_NO_CONNECT,
325
			    _("Xen Daemon or Xen Store"));
326 327 328 329
	else
	    /* we failed to find an adequate driver */
	    virLibConnError(NULL, VIR_ERR_NO_SUPPORT, name);
	goto failed;
D
Daniel Veillard 已提交
330
    }
331 332
    ret->flags = VIR_CONNECT_RO;

333
    return (ret);
334 335

failed:
336
    if (ret != NULL) {
337 338 339 340
	for (i = 0;i < ret->nb_drivers;i++) {
	    if ((ret->drivers[i] != NULL) && (ret->drivers[i]->close != NULL))
	        ret->drivers[i]->close(ret);
	}
341
	virFreeConnect(ret);
342
    }
343
    return (NULL);
D
Daniel Veillard 已提交
344 345 346
}

/**
347
 * virConnectClose:
D
Daniel Veillard 已提交
348 349 350 351 352 353 354 355 356 357
 * @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
358 359
virConnectClose(virConnectPtr conn)
{
360 361
    int i;

K
Karel Zak 已提交
362
    if (!VIR_IS_CONNECT(conn))
363
        return (-1);
364 365 366 367
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) && (conn->drivers[i]->close != NULL))
	    conn->drivers[i]->close(conn);
    }
368 369
    if (virFreeConnect(conn) < 0)
        return (-1);
370
    return (0);
D
Daniel Veillard 已提交
371 372
}

373 374 375 376 377 378 379 380 381
/**
 * 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.
 */
const char *
382 383
virConnectGetType(virConnectPtr conn)
{
384
    int i;
385
    const char *ret;
386

D
Daniel Veillard 已提交
387
    if (!VIR_IS_CONNECT(conn)) {
388
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
389
        return (NULL);
D
Daniel Veillard 已提交
390
    }
391 392 393 394 395 396 397 398
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->type != NULL)) {
	    ret = conn->drivers[i]->type(conn);
	    if (ret != NULL)
	        return(ret);
	}
    }
399 400 401 402 403 404 405
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->name != NULL)) {
	    return(conn->drivers[i]->name);
	}
    }
    return(NULL);
406 407
}

D
Daniel Veillard 已提交
408
/**
409
 * virConnectGetVersion:
D
Daniel Veillard 已提交
410
 * @conn: pointer to the hypervisor connection
411
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
412
 *
413 414 415
 * 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 已提交
416
 *
417 418 419
 * 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 已提交
420
 */
421
int
422 423
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
424
    int ret, i;
425

D
Daniel Veillard 已提交
426 427
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
428
        return (-1);
D
Daniel Veillard 已提交
429
    }
430

D
Daniel Veillard 已提交
431 432
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
433
        return (-1);
D
Daniel Veillard 已提交
434
    }
435

436 437 438 439 440 441 442 443 444
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->version != NULL)) {
	    ret = conn->drivers[i]->version(conn, hvVer);
	    if (ret == 0)
	        return(0);
	}
    }
    return (-1);
445 446 447
}

/**
448
 * virConnectListDomains:
449 450 451 452 453 454 455 456 457
 * @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
458 459
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
460
    int ret = -1;
461
    int i;
462

D
Daniel Veillard 已提交
463 464
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
465
        return (-1);
D
Daniel Veillard 已提交
466
    }
467

D
Daniel Veillard 已提交
468 469
    if ((ids == NULL) || (maxids <= 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
470
        return (-1);
D
Daniel Veillard 已提交
471
    }
472

473 474 475 476 477 478 479 480 481 482
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->listDomains != NULL)) {
	    ret = conn->drivers[i]->listDomains(conn, ids, maxids);
	    if (ret >= 0)
	        return(ret);
	}
    }

483
    return (-1);
D
Daniel Veillard 已提交
484 485
}

K
 
Karel Zak 已提交
486 487 488 489
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
490 491
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
492 493 494
 * Returns the number of domain found or -1 in case of error
 */
int
495 496
virConnectNumOfDomains(virConnectPtr conn)
{
K
 
Karel Zak 已提交
497
    int ret = -1;
498
    int i;
K
 
Karel Zak 已提交
499

D
Daniel Veillard 已提交
500 501
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
502
        return (-1);
D
Daniel Veillard 已提交
503
    }
K
Karel Zak 已提交
504

505 506 507 508 509 510 511 512 513 514
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->numOfDomains != NULL)) {
	    ret = conn->drivers[i]->numOfDomains(conn);
	    if (ret >= 0)
	        return(ret);
	}
    }

515
    return(-1);
K
 
Karel Zak 已提交
516 517
}

D
Daniel Veillard 已提交
518
/**
519
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
520
 * @conn: pointer to the hypervisor connection
521
 * @xmlDesc: an XML description of the domain
522
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
523
 *
524 525 526
 * 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 已提交
527 528 529
 * 
 * Returns a new domain object or NULL in case of failure
 */
530
virDomainPtr
531 532
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
533
{
534 535
    virDomainPtr ret;
    int i;
K
Karel Zak 已提交
536

D
Daniel Veillard 已提交
537 538
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
539
        return (NULL);
D
Daniel Veillard 已提交
540 541 542
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
543
        return (NULL);
D
Daniel Veillard 已提交
544
    }
545 546 547 548
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
549

550 551 552 553 554 555 556
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainCreateLinux != NULL)) {
	    ret = conn->drivers[i]->domainCreateLinux(conn, xmlDesc, flags);
	    if (ret != NULL)
	        return(ret);
	}
557
    }
558
    return(NULL);
D
Daniel Veillard 已提交
559 560
}

561

562
/**
563
 * virDomainLookupByID:
564 565 566 567 568 569 570
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
 *
 * Returns a new domain object or NULL in case of failure
 */
571
virDomainPtr
572 573
virDomainLookupByID(virConnectPtr conn, int id)
{
574
    virDomainPtr ret;
575
    int i;
576

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

586 587 588 589 590 591 592 593 594 595
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainLookupByID != NULL)) {
	    ret = conn->drivers[i]->domainLookupByID(conn, id);
	    if (ret)
	        return(ret);
	}
    }

596
    return (NULL);
597 598 599 600 601
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
602
 * @uuid: the raw UUID for the domain
603 604 605 606 607 608
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
609 610
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
611
    virDomainPtr ret;
612
    int i;
613

D
Daniel Veillard 已提交
614 615
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
616
        return (NULL);
D
Daniel Veillard 已提交
617 618 619
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
620
        return (NULL);
D
Daniel Veillard 已提交
621
    }
622 623 624 625 626 627 628 629 630 631 632

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainLookupByUUID != NULL)) {
	    ret = conn->drivers[i]->domainLookupByUUID(conn, uuid);
	    if (ret)
	        return(ret);
	}
    }

633
    return (NULL);
634 635
}

K
Karel Zak 已提交
636 637 638 639 640 641 642 643 644 645 646 647
/**
 * 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.
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
648 649
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
    int ret;

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        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);
    
675
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
676 677 678
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
679
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
680 681 682 683 684
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

685 686 687 688 689
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
690
 * Try to lookup a domain on the given hypervisor based on its name.
691 692 693 694
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
695 696
virDomainLookupByName(virConnectPtr conn, const char *name)
{
697
    virDomainPtr ret = NULL;
698
    int i;
699

D
Daniel Veillard 已提交
700 701
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
702
        return (NULL);
D
Daniel Veillard 已提交
703 704 705
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
706
        return (NULL);
D
Daniel Veillard 已提交
707
    }
708

709 710 711 712 713 714 715 716 717
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainLookupByName != NULL)) {
	    ret = conn->drivers[i]->domainLookupByName(conn, name);
	    if (ret)
	        return(ret);
	}
    }
718
    return (NULL);
719 720
}

D
Daniel Veillard 已提交
721
/**
722
 * virDomainDestroy:
D
Daniel Veillard 已提交
723 724 725 726
 * @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.
727 728
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
729
 * This function may requires priviledged access
D
Daniel Veillard 已提交
730 731
 *
 * Returns 0 in case of success and -1 in case of failure.
732
 */
D
Daniel Veillard 已提交
733
int
734 735
virDomainDestroy(virDomainPtr domain)
{
736
    int i;
737
    virConnectPtr conn;
738

D
Daniel Veillard 已提交
739 740
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
741
        return (-1);
D
Daniel Veillard 已提交
742
    }
743

744
    conn = domain->conn;
745 746 747 748
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
749

750 751 752 753
    /*
     * Go though the driver registered entry points but use the 
     * XEN_HYPERVISOR directly only as a last mechanism
     */
754 755
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
756 757 758
	    (conn->drivers[i]->no != VIR_DRV_XEN_HYPERVISOR) &&
	    (conn->drivers[i]->domainDestroy != NULL)) {
	    if (conn->drivers[i]->domainDestroy(domain) == 0)
759
	        return (0);
760 761 762 763 764
	}
    }
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->no == VIR_DRV_XEN_HYPERVISOR) &&
765 766
	    (conn->drivers[i]->domainDestroy != NULL)) {
	    if (conn->drivers[i]->domainDestroy(domain) == 0)
767
	        return (0);
768
	}
769 770
    }

771
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
772
    return (-1);
773 774 775 776 777 778 779 780 781 782 783 784
}

/**
 * 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
785 786
virDomainFree(virDomainPtr domain)
{
D
Daniel Veillard 已提交
787 788
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
789
        return (-1);
D
Daniel Veillard 已提交
790
    }
791 792 793
    if (virFreeDomain(domain->conn, domain) < 0)
        return (-1);
    return(0);
D
Daniel Veillard 已提交
794 795 796
}

/**
797
 * virDomainSuspend:
D
Daniel Veillard 已提交
798 799 800 801
 * @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 
802
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
803
 * the domain.
804
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
805 806 807 808
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
809 810
virDomainSuspend(virDomainPtr domain)
{
811
    int i;
812
    virConnectPtr conn;
813

D
Daniel Veillard 已提交
814 815
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
816
        return (-1);
D
Daniel Veillard 已提交
817
    }
818 819 820 821
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
822

823 824
    conn = domain->conn;

825 826 827 828 829 830 831 832 833
    /*
     * Go though the driver registered entry points but use the 
     * XEN_HYPERVISOR directly only as a last mechanism
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->no != VIR_DRV_XEN_HYPERVISOR) &&
	    (conn->drivers[i]->domainSuspend != NULL)) {
	    if (conn->drivers[i]->domainSuspend(domain) == 0)
834
	        return (0);
835 836
	}
    }
837 838
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
839
	    (conn->drivers[i]->no == VIR_DRV_XEN_HYPERVISOR) &&
840 841
	    (conn->drivers[i]->domainSuspend != NULL)) {
	    if (conn->drivers[i]->domainSuspend(domain) == 0)
842
	        return (0);
843 844 845 846
	}
    }

        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
847
    return (-1);
D
Daniel Veillard 已提交
848 849 850
}

/**
851
 * virDomainResume:
D
Daniel Veillard 已提交
852 853 854
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
855
 * it was frozen by calling virSuspendDomain().
856
 * This function may requires priviledged access
D
Daniel Veillard 已提交
857 858 859 860
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
861 862
virDomainResume(virDomainPtr domain)
{
863
    int i;
864
    virConnectPtr conn;
865

D
Daniel Veillard 已提交
866 867
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
868
        return (-1);
D
Daniel Veillard 已提交
869
    }
870 871 872 873
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
874

875 876
    conn = domain->conn;

877 878 879 880 881 882 883 884 885 886 887 888
    /*
     * Go though the driver registered entry points but use the 
     * XEN_HYPERVISOR directly only as a last mechanism
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->no != VIR_DRV_XEN_HYPERVISOR) &&
	    (conn->drivers[i]->domainResume != NULL)) {
	    if (conn->drivers[i]->domainResume(domain) == 0)
	        return(0);
	}
    }
889 890
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
891
	    (conn->drivers[i]->no == VIR_DRV_XEN_HYPERVISOR) &&
892 893
	    (conn->drivers[i]->domainResume != NULL)) {
	    if (conn->drivers[i]->domainResume(domain) == 0)
894
	        return(0);
895 896 897
	}
    }

898 899
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
D
Daniel Veillard 已提交
900 901
}

902 903 904 905 906 907
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
908 909 910
 * 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.
911 912 913 914
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
915 916
virDomainSave(virDomainPtr domain, const char *to)
{
917
    int ret, i;
918
    char filepath[4096];
919
    virConnectPtr conn;
920

D
Daniel Veillard 已提交
921 922
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
923
        return (-1);
D
Daniel Veillard 已提交
924
    }
925 926 927 928
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
929
    conn = domain->conn;
D
Daniel Veillard 已提交
930 931
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
932
        return (-1);
D
Daniel Veillard 已提交
933
    }
934

935 936 937 938 939
    /*
     * 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] != '/') {
940
        unsigned int len, t;
941

942 943 944 945 946 947 948 949 950 951
        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];
952 953 954

    }

955 956 957 958 959 960 961 962 963 964 965
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainSave != NULL)) {
	    ret = conn->drivers[i]->domainSave(domain, to);
	    if (ret == 0)
	        return(0);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
966 967 968 969
}

/**
 * virDomainRestore:
970
 * @conn: pointer to the hypervisor connection
971 972 973 974 975 976 977
 * @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
978 979
virDomainRestore(virConnectPtr conn, const char *from)
{
980
    int ret, i;
981
    char filepath[4096];
982

D
Daniel Veillard 已提交
983 984
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
985
        return (-1);
D
Daniel Veillard 已提交
986
    }
987 988 989 990
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
991 992
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
993
        return (-1);
D
Daniel Veillard 已提交
994 995
    }

996 997 998 999 1000
    /*
     * 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] != '/') {
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        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];
    }

1015 1016 1017 1018 1019 1020 1021 1022 1023
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainSave != NULL)) {
	    ret = conn->drivers[i]->domainRestore(conn, from);
	    if (ret == 0)
	        return(0);
	}
    }
D
Daniel Veillard 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
}

/**
 * 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)
{
    int ret, i;
    char filepath[4096];
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        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];

    }

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainCoreDump != NULL)) {
	    ret = conn->drivers[i]->domainCoreDump(domain, to, flags);
	    if (ret == 0)
	        return(0);
	}
    }
1090 1091
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
1092 1093
}

1094 1095 1096 1097 1098
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1099 1100
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1101 1102 1103 1104 1105 1106 1107
 *
 * 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
1108 1109
virDomainShutdown(virDomainPtr domain)
{
1110 1111
    int ret = -1, i;
    virConnectPtr conn;
1112

D
Daniel Veillard 已提交
1113 1114
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1115
        return (-1);
D
Daniel Veillard 已提交
1116
    }
1117 1118 1119 1120
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1121

1122 1123 1124 1125 1126 1127 1128 1129 1130
    conn = domain->conn;

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainShutdown != NULL)) {
	    if (conn->drivers[i]->domainShutdown(domain) == 0)
	        ret = 0;
	}
1131
    }
1132

1133 1134 1135
    if (ret != 0) {
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
        return (ret);
1136
    }
1137

1138
    return (ret);
1139 1140
}

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
/**
 * 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)
{
1155 1156
    int ret = -1, i;
    virConnectPtr conn;
1157 1158 1159 1160 1161

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1162 1163 1164 1165
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1166

1167 1168 1169 1170 1171 1172 1173 1174 1175
    conn = domain->conn;

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainReboot != NULL)) {
	    if (conn->drivers[i]->domainReboot(domain, flags) == 0)
	        ret = 0;
	}
1176 1177
    }

1178 1179 1180
    if (ret != 0) {
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
        return (ret);
1181
    }
1182

1183 1184 1185
    return (ret);
}

1186
/**
1187
 * virDomainGetName:
1188 1189 1190 1191 1192 1193 1194 1195
 * @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 *
1196 1197
virDomainGetName(virDomainPtr domain)
{
D
Daniel Veillard 已提交
1198 1199
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1200
        return (NULL);
D
Daniel Veillard 已提交
1201
    }
1202
    return (domain->name);
1203 1204
}

1205 1206 1207
/**
 * virDomainGetUUID:
 * @domain: a domain object
1208
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1209 1210 1211 1212 1213 1214
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1215 1216
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
D
Daniel Veillard 已提交
1217 1218
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1219
        return (-1);
D
Daniel Veillard 已提交
1220 1221 1222
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1223
        return (-1);
D
Daniel Veillard 已提交
1224 1225
    }

1226
    if (domain->id == 0) {
1227
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1228
    } else {
1229 1230 1231 1232 1233 1234 1235 1236
        if ((domain->uuid[0] == 0) && (domain->uuid[1] == 0) &&
            (domain->uuid[2] == 0) && (domain->uuid[3] == 0) &&
            (domain->uuid[4] == 0) && (domain->uuid[5] == 0) &&
            (domain->uuid[6] == 0) && (domain->uuid[7] == 0) &&
            (domain->uuid[8] == 0) && (domain->uuid[9] == 0) &&
            (domain->uuid[10] == 0) && (domain->uuid[11] == 0) &&
            (domain->uuid[12] == 0) && (domain->uuid[13] == 0) &&
            (domain->uuid[14] == 0) && (domain->uuid[15] == 0))
1237
            xenDaemonDomainLookupByName_ids(domain->conn, domain->name,
1238
                                &domain->uuid[0]);
1239
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1240 1241
    }
    return (0);
1242 1243
}

K
Karel Zak 已提交
1244 1245 1246
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1247
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1248 1249 1250 1251 1252 1253 1254 1255 1256
 *
 * 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)
{
1257
    unsigned char uuid[VIR_UUID_BUFLEN];
1258

K
Karel Zak 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    
    if (virDomainGetUUID(domain, &uuid[0]))
	return (-1);

1271
    snprintf(buf, VIR_UUID_STRING_BUFLEN,
K
Karel Zak 已提交
1272 1273 1274 1275 1276 1277 1278 1279
	"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
                      uuid[0], uuid[1], uuid[2], uuid[3],
                      uuid[4], uuid[5], uuid[6], uuid[7],
                      uuid[8], uuid[9], uuid[10], uuid[11],
                      uuid[12], uuid[13], uuid[14], uuid[15]);
    return (0);
}

1280
/**
1281
 * virDomainGetID:
1282 1283 1284 1285 1286 1287 1288
 * @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
1289 1290
virDomainGetID(virDomainPtr domain)
{
D
Daniel Veillard 已提交
1291 1292
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1293
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1294
    }
1295
    return (domain->id);
1296 1297
}

1298 1299 1300 1301 1302 1303
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1304 1305
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1306 1307
 */
char *
1308 1309
virDomainGetOSType(virDomainPtr domain)
{
1310 1311
    char *str = NULL;
    int i;
1312

D
Daniel Veillard 已提交
1313 1314
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1315
        return (NULL);
D
Daniel Veillard 已提交
1316
    }
1317

1318 1319 1320 1321 1322 1323 1324
    for (i = 0;i < domain->conn->nb_drivers;i++) {
	if ((domain->conn->drivers[i] != NULL) &&
	    (domain->conn->drivers[i]->domainGetOSType != NULL)) {
	    str = domain->conn->drivers[i]->domainGetOSType(domain);
	    if (str != NULL)
	        break;
	}
1325
    }
1326

1327
    return (str);
1328 1329
}

1330
/**
1331
 * virDomainGetMaxMemory:
1332 1333 1334 1335 1336 1337 1338 1339 1340
 * @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
1341 1342
virDomainGetMaxMemory(virDomainPtr domain)
{
1343
    unsigned long ret = 0;
1344 1345
    virConnectPtr conn;
    int i;
1346

D
Daniel Veillard 已提交
1347 1348
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1349
        return (0);
D
Daniel Veillard 已提交
1350
    }
1351

1352 1353
    conn = domain->conn;

1354
    /*
1355 1356
     * in that case instead of trying only though one method try all availble.
     * If needed that can be changed back if it's a performcance problem.
1357
     */
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainGetMaxMemory != NULL)) {
	    ret = conn->drivers[i]->domainGetMaxMemory(domain);
	    if (ret != 0)
	        return(ret);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
1368 1369
}

D
Daniel Veillard 已提交
1370
/**
1371
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1372 1373 1374 1375 1376 1377
 * @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.
1378
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1379 1380 1381 1382
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1383 1384
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1385 1386
    int ret = -1 , i;
    virConnectPtr conn;
1387

1388 1389 1390 1391 1392 1393
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1394
        return (-1);
1395
    }
1396 1397 1398 1399 1400 1401 1402 1403
    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);
    }
1404
    conn = domain->conn;
1405

1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
    /*
     * in that case instead of trying only though one method try all availble.
     * If needed that can be changed back if it's a performcance problem.
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainSetMaxMemory != NULL)) {
	    if (conn->drivers[i]->domainSetMaxMemory(domain, memory) == 0)
	        ret = 0;
	}
    }
    if (ret != 0) {
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
1419
        return (-1);
1420 1421 1422
    }
    return (ret);
}
1423

1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
/**
 * 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)
{
    int ret = -1 , i;
    virConnectPtr conn;
1441

1442 1443 1444 1445 1446 1447 1448
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
1449
    }
1450 1451 1452 1453 1454 1455
    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__);
1456
        return (-1);
1457 1458 1459
    }

    conn = domain->conn;
1460

1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
    /*
     * in that case instead of trying only though one method try all availble.
     * If needed that can be changed back if it's a performcance problem.
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainSetMemory != NULL)) {
	    if (conn->drivers[i]->domainSetMemory(domain, memory) == 0)
	        ret = 0;
	}
    }
    if (ret != 0) {
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
        return (-1);
    }
1476
    return (ret);
D
Daniel Veillard 已提交
1477 1478
}

1479 1480
/**
 * virDomainGetInfo:
1481
 * @domain: a domain object
1482 1483 1484
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1485
 * used to get the domain is limited only a partial set of the information
1486 1487 1488 1489 1490
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1491 1492
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1493
    int i;
1494

D
Daniel Veillard 已提交
1495 1496
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1497
        return (-1);
D
Daniel Veillard 已提交
1498 1499 1500
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1501
        return (-1);
D
Daniel Veillard 已提交
1502
    }
1503

1504
    memset(info, 0, sizeof(virDomainInfo));
1505

1506 1507 1508 1509 1510 1511 1512 1513
    for (i = 0;i < domain->conn->nb_drivers;i++) {
	if ((domain->conn->drivers[i] != NULL) &&
	    (domain->conn->drivers[i]->domainGetInfo != NULL)) {
	    if (domain->conn->drivers[i]->domainGetInfo(domain, info) == 0)
	        return 0;
	}
    }

1514
    return (-1);
1515
}
1516

1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * 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 *
1529 1530
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1531 1532
    int i;
    char *ret = NULL;
D
Daniel Veillard 已提交
1533 1534
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1535
        return (NULL);
D
Daniel Veillard 已提交
1536 1537 1538
    }
    if (flags != 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1539
        return (NULL);
D
Daniel Veillard 已提交
1540
    }
1541

1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
    for (i = 0;i < domain->conn->nb_drivers;i++) {
	if ((domain->conn->drivers[i] != NULL) &&
	    (domain->conn->drivers[i]->domainDumpXML != NULL)) {
            ret = domain->conn->drivers[i]->domainDumpXML(domain, flags);
	    if (ret)
	        break;
	}
    }
    if (!ret) {
        virLibConnError(domain->conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
        return (NULL);
    }
    return(ret);
1555
}
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593

/**
 * 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
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info) {
    int i;
    int ret = -1;

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

    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->nodeGetInfo != NULL)) {
	    ret = conn->drivers[i]->nodeGetInfo(conn, info);
	    if (ret == 0)
	        break;
	}
    }
    if (ret != 0) {
        virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
        return (-1);
    }
    return(0);
}
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612

/************************************************************************
 *									*
 *		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) {
    virDomainPtr ret = NULL;
1613
    int i;
1614 1615 1616 1617 1618

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
1619 1620 1621 1622
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
1623 1624 1625 1626 1627
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

1628 1629 1630 1631 1632 1633 1634 1635
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainDefineXML != NULL)) {
            ret = conn->drivers[i]->domainDefineXML(conn, xml);
	    if (ret)
	        return(ret);
	}
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
    }

    return(ret);
}

/**
 * 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) {
1651 1652
    int ret, i;
    virConnectPtr conn;
1653 1654 1655 1656 1657

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1658 1659
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
1660 1661 1662 1663
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

1664 1665 1666 1667 1668 1669 1670 1671 1672
    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainUndefine != NULL)) {
	    ret = conn->drivers[i]->domainUndefine(domain);
	    if (ret >= 0)
	        return(ret);
	}
    }
1673

1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
    return(-1);
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of active domains.
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
    int ret = -1;
    int i;

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

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->numOfDefinedDomains != NULL)) {
	    ret = conn->drivers[i]->numOfDefinedDomains(conn);
	    if (ret >= 0)
	        return(ret);
	}
    }

    return(-1);
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
}

/**
 * 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
virConnectListDefinedDomains(virConnectPtr conn, const char **names,
                             int maxnames) {
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
    int ret = -1;
    int i;

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

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

    /* Go though the driver registered entry points */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->listDefinedDomains != NULL)) {
	    ret = conn->drivers[i]->listDefinedDomains(conn, names, maxnames);
	    if (ret >= 0)
	        return(ret);
	}
    }

    return (-1);
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
}

/**
 * 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) {
1759 1760 1761 1762 1763 1764
    int i, ret = -1;
    virConnectPtr conn;
    if (domain == NULL) {
        TODO
	return (-1);
    }
1765 1766 1767 1768
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1769 1770
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
1771 1772 1773
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783

    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainCreate != NULL)) {
	    ret = conn->drivers[i]->domainCreate(domain);
	    if (ret == 0)
	        return(ret);
	}
    }
    return(ret);
1784 1785
}

1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
/**
 * 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)
{
1802 1803 1804
    int i;
    virConnectPtr conn;

1805 1806 1807 1808 1809 1810 1811 1812
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1813 1814 1815 1816
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1817

1818 1819 1820 1821
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1822
    conn = domain->conn;
1823

1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
    /*
     * Go though the driver registered entry points but use the 
     * XEN_HYPERVISOR directly only as a last mechanism
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->no != VIR_DRV_XEN_HYPERVISOR) &&
	    (conn->drivers[i]->domainSetVcpus != NULL)) {
	    if (conn->drivers[i]->domainSetVcpus(domain, nvcpus) == 0)
	        return(0);
	}
    }
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->no == VIR_DRV_XEN_HYPERVISOR) &&
	    (conn->drivers[i]->domainSetVcpus != NULL)) {
	    if (conn->drivers[i]->domainSetVcpus(domain, nvcpus) == 0)
	        return(0);
	}
    }

    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
}

/**
 * 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)
{
1871 1872 1873
    int i;
    virConnectPtr conn;

1874 1875 1876 1877 1878 1879 1880 1881
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1882 1883 1884 1885
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1886

1887
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
1888 1889 1890
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
    conn = domain->conn;

    /*
     * Go though the driver registered entry points
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainPinVcpu != NULL)) {
	    if (conn->drivers[i]->domainPinVcpu(domain, vcpu,
	                                        cpumap, maplen) == 0)
	        return(0);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
}

/**
 * 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)
{
    int ret;
1934 1935
    int i;
    virConnectPtr conn;
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952

    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        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);
    }
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968
    conn = domain->conn;

    /*
     * Go though the driver registered entry points
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainGetVcpus != NULL)) {
	    ret = conn->drivers[i]->domainGetVcpus(domain, info, maxinfo,
	                                           cpumaps, maplen);
	    if (ret >= 0)
	        return(ret);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
1969
}
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051

/**
 * 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
virDomainAttachDevice(virDomainPtr domain, char *xml)
{
    int ret;
    int i;
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

    /*
     * Go though the driver registered entry points
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainAttachDevice != NULL)) {
	    ret = conn->drivers[i]->domainAttachDevice(domain, xml);
	    if (ret >= 0)
	        return(ret);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
}

/**
 * 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
virDomainDetachDevice(virDomainPtr domain, char *xml)
{
    int ret;
    int i;
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
    conn = domain->conn;

    /*
     * Go though the driver registered entry points
     */
    for (i = 0;i < conn->nb_drivers;i++) {
	if ((conn->drivers[i] != NULL) &&
	    (conn->drivers[i]->domainDetachDevice != NULL)) {
	    ret = conn->drivers[i]->domainDetachDevice(domain, xml);
	    if (ret >= 0)
	        return(ret);
	}
    }
    virLibConnError(conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return (-1);
}