libvirt.c 67.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>

D
Daniel Veillard 已提交
24
#include "internal.h"
25
#include "driver.h"
26

27
#include "xml.h"
28
#include "test.h"
29
#include "xen_unified.h"
D
Daniel P. Berrange 已提交
30
#include "qemu_internal.h"
31

D
Daniel Veillard 已提交
32 33 34 35 36 37
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
 * - use reference counting to garantee coherent pointer state ?
 */

38
static virDriverPtr virDriverTab[MAX_DRIVERS];
39
static int virDriverTabCount = 0;
40
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
41
static int virNetworkDriverTabCount = 0;
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
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)
{
    if (initialized)
        return(0);
58
    initialized = 1;
59

60 61 62
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

63
    /*
64 65
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
66
     */
67
#ifdef WITH_TEST
68
    if (testRegister() == -1) return -1;
69 70
#endif
#ifdef WITH_QEMU
71
    if (qemuRegister() == -1) return -1;
72
#endif
73 74 75
#ifdef WITH_XEN
    if (xenUnifiedRegister () == -1) return -1;
#endif
D
Daniel P. Berrange 已提交
76

77 78 79 80 81
    return(0);
}



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

D
Daniel Veillard 已提交
95 96 97 98
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
99
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
100 101 102 103 104 105 106 107 108 109 110 111
                    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
112 113 114
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
115 116
    virConnectPtr conn = NULL;
    const char *errmsg;
117

D
Daniel Veillard 已提交
118 119 120 121 122 123 124
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
125
    __virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
126 127 128
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

129
/**
130 131 132 133
 * virLibNetworkError:
 * @conn: the connection if available
 * @error: the error noumber
 * @info: extra information string
134
 *
135
 * Handle an error at the connection level
136
 */
137 138 139 140 141 142 143 144 145 146 147 148 149 150
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;
    }
151
    __virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
152 153 154 155 156 157 158 159 160 161 162 163 164 165
                    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)
{
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    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++;
181 182 183 184 185 186 187 188 189 190 191 192 193
}

/**
 * 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)
{
194 195 196 197 198 199 200 201 202 203 204 205 206
    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);
    }

207 208 209 210 211 212 213
    if (driver->no < 0) {
    	virLibConnError
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

214 215
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
216 217
}

218 219 220
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
221
 * @type: the type of connection/driver looked at
222 223 224 225 226 227 228 229 230 231 232 233
 * @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
234 235 236
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
237 238
    int i;

239
    if (!initialized)
240 241
        if (virInitialize() < 0)
	    return -1;
242

243
    if (libVer == NULL)
244
        return (-1);
245 246 247
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
248 249
        if (type == NULL)
	    type = "Xen";
250
	for (i = 0;i < virDriverTabCount;i++) {
251
	    if ((virDriverTab[i] != NULL) &&
252
	        (!strcasecmp(virDriverTab[i]->name, type))) {
253 254 255 256
		*typeVer = virDriverTab[i]->ver;
		break;
	    }
	}
257
        if (i >= virDriverTabCount) {
258
            *typeVer = 0;
259
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
260 261 262 263
            return (-1);
        }
    }
    return (0);
264 265
}

266 267
static virConnectPtr
do_open (const char *name, int flags)
268
{
269
    int i, res;
270
    virConnectPtr ret = NULL;
271

272
    if (!initialized)
273 274
        if (virInitialize() < 0)
	    return NULL;
275

276
    ret = virGetConnect();
277
    if (ret == NULL) {
278
        virLibConnError(NULL, VIR_ERR_NO_MEMORY, _("allocating connection"));
279 280 281
        goto failed;
    }

282 283 284 285 286 287 288
    for (i = 0; i < virDriverTabCount; i++) {
        res = virDriverTab[i]->open (ret, name, flags);
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
289 290
    }

291 292 293
    if (!ret->driver) {
        virLibConnError (NULL, VIR_ERR_NO_SUPPORT, name);
        goto failed;
294 295
    }

296 297
    for (i = 0; i < virNetworkDriverTabCount; i++) {
        res = virNetworkDriverTab[i]->open (ret, name, flags);
298 299
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
300 301 302
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
303
    }
304

305 306 307 308
    if (flags & VIR_DRV_OPEN_RO) {
        ret->flags = VIR_CONNECT_RO;
    }

309
    return ret;
310 311

failed:
312
    if (ret->driver) ret->driver->close (ret);
313
	virFreeConnect(ret);
314
    return (NULL);
315 316
}

317 318 319 320 321 322 323 324 325 326 327 328
/**
 * virConnectOpen:
 * @name: optional argument currently unused, pass NULL
 *
 * 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
 */
virConnectPtr
virConnectOpen (const char *name)
{
329
    return do_open (name, 0);
330 331
}

332
/**
333
 * virConnectOpenReadOnly:
334 335
 * @name: optional argument currently unused, pass NULL
 *
336 337 338
 * 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.
339 340 341
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
 */
342
virConnectPtr
343 344
virConnectOpenReadOnly(const char *name)
{
345
    return do_open (name, VIR_DRV_OPEN_RO);
D
Daniel Veillard 已提交
346 347 348
}

/**
349
 * virConnectClose:
D
Daniel Veillard 已提交
350 351 352 353 354 355 356 357 358 359
 * @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
360 361
virConnectClose(virConnectPtr conn)
{
K
Karel Zak 已提交
362
    if (!VIR_IS_CONNECT(conn))
363
        return (-1);
364 365 366 367 368

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

369 370
    if (virFreeConnect(conn) < 0)
        return (-1);
371
    return (0);
D
Daniel Veillard 已提交
372 373
}

374 375 376 377 378 379 380 381 382
/**
 * 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 *
383 384
virConnectGetType(virConnectPtr conn)
{
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

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
395
    }
396
    return conn->driver->name;
397 398
}

D
Daniel Veillard 已提交
399
/**
400
 * virConnectGetVersion:
D
Daniel Veillard 已提交
401
 * @conn: pointer to the hypervisor connection
402
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
403
 *
404 405 406
 * 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 已提交
407
 *
408 409 410
 * 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 已提交
411
 */
412
int
413 414
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
D
Daniel Veillard 已提交
415 416
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
417
        return (-1);
D
Daniel Veillard 已提交
418
    }
419

D
Daniel Veillard 已提交
420 421
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
422
        return (-1);
D
Daniel Veillard 已提交
423
    }
424

425 426
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
427

428 429
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
430 431
}

432 433 434 435 436
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
437
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
438 439 440 441 442 443 444 445 446 447 448 449 450 451
 * 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)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

452 453
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
454

455 456
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
457 458
}

459
/**
460
 * virConnectListDomains:
461 462 463 464 465 466 467 468 469
 * @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
470 471
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
D
Daniel Veillard 已提交
472 473
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
474
        return (-1);
D
Daniel Veillard 已提交
475
    }
476

D
Daniel Veillard 已提交
477 478
    if ((ids == NULL) || (maxids <= 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
479
        return (-1);
D
Daniel Veillard 已提交
480
    }
481

482 483
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
484

485 486
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
487 488
}

K
 
Karel Zak 已提交
489 490 491 492
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
493 494
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
495 496 497
 * Returns the number of domain found or -1 in case of error
 */
int
498 499
virConnectNumOfDomains(virConnectPtr conn)
{
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
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
507

508 509
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
510 511
}

D
Daniel Veillard 已提交
512
/**
513
 * virDomainCreateLinux:
D
Daniel Veillard 已提交
514
 * @conn: pointer to the hypervisor connection
515
 * @xmlDesc: an XML description of the domain
516
 * @flags: an optional set of virDomainFlags
D
Daniel Veillard 已提交
517
 *
518 519 520
 * 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 已提交
521 522 523
 * 
 * Returns a new domain object or NULL in case of failure
 */
524
virDomainPtr
525 526
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
527
{
D
Daniel Veillard 已提交
528 529
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
530
        return (NULL);
D
Daniel Veillard 已提交
531 532 533
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
534
        return (NULL);
D
Daniel Veillard 已提交
535
    }
536 537 538 539
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
D
Daniel Veillard 已提交
540

541 542 543 544 545
    if (conn->driver->domainCreateLinux)
        return conn->driver->domainCreateLinux (conn, xmlDesc, flags);

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

548

549
/**
550
 * virDomainLookupByID:
551 552 553 554 555 556 557
 * @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
 */
558
virDomainPtr
559 560
virDomainLookupByID(virConnectPtr conn, int id)
{
D
Daniel Veillard 已提交
561 562
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
563
        return (NULL);
D
Daniel Veillard 已提交
564 565 566
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
567
        return (NULL);
D
Daniel Veillard 已提交
568
    }
569

570 571
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
572

573 574
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
575 576 577 578 579
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
580
 * @uuid: the raw UUID for the domain
581 582 583 584 585 586
 *
 * 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
587 588
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
D
Daniel Veillard 已提交
589 590
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
591
        return (NULL);
D
Daniel Veillard 已提交
592 593 594
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
595
        return (NULL);
D
Daniel Veillard 已提交
596
    }
597

598 599
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
600

601 602
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
603 604
}

K
Karel Zak 已提交
605 606 607 608 609 610 611 612 613 614 615 616
/**
 * 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)
{
617 618
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    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);
    
644
    if (ret!=VIR_UUID_BUFLEN) {
K
Karel Zak 已提交
645 646 647
	virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
	return (NULL);
    }
648
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
649 650 651 652 653
        uuid[i] = raw[i] & 0xFF;
    
    return virDomainLookupByUUID(conn, &uuid[0]);
}

654 655 656 657 658
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
659
 * Try to lookup a domain on the given hypervisor based on its name.
660 661 662 663
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
664 665
virDomainLookupByName(virConnectPtr conn, const char *name)
{
D
Daniel Veillard 已提交
666 667
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
668
        return (NULL);
D
Daniel Veillard 已提交
669 670 671
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
672
        return (NULL);
D
Daniel Veillard 已提交
673
    }
674

675 676 677 678 679
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
682
/**
683
 * virDomainDestroy:
D
Daniel Veillard 已提交
684 685 686 687
 * @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.
688 689
 * The data structure is freed and should not be used thereafter if the
 * call does not return an error.
690
 * This function may requires priviledged access
D
Daniel Veillard 已提交
691 692
 *
 * Returns 0 in case of success and -1 in case of failure.
693
 */
D
Daniel Veillard 已提交
694
int
695 696
virDomainDestroy(virDomainPtr domain)
{
697
    virConnectPtr conn;
698

D
Daniel Veillard 已提交
699 700
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
701
        return (-1);
D
Daniel Veillard 已提交
702
    }
703

704
    conn = domain->conn;
705 706 707 708
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
709

710 711
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
712

713 714
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
715 716 717 718 719 720 721 722 723 724 725 726
}

/**
 * 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
727 728
virDomainFree(virDomainPtr domain)
{
D
Daniel Veillard 已提交
729 730
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
731
        return (-1);
D
Daniel Veillard 已提交
732
    }
733 734 735
    if (virFreeDomain(domain->conn, domain) < 0)
        return (-1);
    return(0);
D
Daniel Veillard 已提交
736 737 738
}

/**
739
 * virDomainSuspend:
D
Daniel Veillard 已提交
740 741 742 743
 * @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 
744
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
745
 * the domain.
746
 * This function may requires priviledged access.
D
Daniel Veillard 已提交
747 748 749 750
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
751 752
virDomainSuspend(virDomainPtr domain)
{
753
    virConnectPtr conn;
754

D
Daniel Veillard 已提交
755 756
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
757
        return (-1);
D
Daniel Veillard 已提交
758
    }
759 760 761 762
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
763

764 765
    conn = domain->conn;

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

769 770
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
771 772 773
}

/**
774
 * virDomainResume:
D
Daniel Veillard 已提交
775 776 777
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
778
 * it was frozen by calling virSuspendDomain().
779
 * This function may requires priviledged access
D
Daniel Veillard 已提交
780 781 782 783
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
784 785
virDomainResume(virDomainPtr domain)
{
786
    virConnectPtr conn;
787

D
Daniel Veillard 已提交
788 789
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
790
        return (-1);
D
Daniel Veillard 已提交
791
    }
792 793 794 795
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
796

797 798
    conn = domain->conn;

799 800
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
801

802 803
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
804 805
}

806 807 808 809 810 811
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
812 813 814
 * 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.
815 816 817 818
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
819 820
virDomainSave(virDomainPtr domain, const char *to)
{
821
    char filepath[4096];
822
    virConnectPtr conn;
823

D
Daniel Veillard 已提交
824 825
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
826
        return (-1);
D
Daniel Veillard 已提交
827
    }
828 829 830 831
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
832
    conn = domain->conn;
D
Daniel Veillard 已提交
833 834
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
835
        return (-1);
D
Daniel Veillard 已提交
836
    }
837

838 839 840 841 842
    /*
     * 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] != '/') {
843
        unsigned int len, t;
844

845 846 847 848 849 850 851 852 853 854
        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];
855 856 857

    }

858 859 860 861 862
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
863 864 865 866
}

/**
 * virDomainRestore:
867
 * @conn: pointer to the hypervisor connection
868 869 870 871 872 873 874
 * @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
875 876
virDomainRestore(virConnectPtr conn, const char *from)
{
877
    char filepath[4096];
878

D
Daniel Veillard 已提交
879 880
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
881
        return (-1);
D
Daniel Veillard 已提交
882
    }
883 884 885 886
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
D
Daniel Veillard 已提交
887 888
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
889
        return (-1);
D
Daniel Veillard 已提交
890 891
    }

892 893 894 895 896
    /*
     * 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] != '/') {
897 898 899 900 901 902 903 904 905 906 907 908 909 910
        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];
    }

911 912 913 914 915
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
}

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

    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];

    }

970 971 972 973 974
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
975 976
}

977 978 979 980 981
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
982 983
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
984 985 986 987 988 989 990
 *
 * 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
991 992
virDomainShutdown(virDomainPtr domain)
{
993
    virConnectPtr conn;
994

D
Daniel Veillard 已提交
995 996
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
997
        return (-1);
D
Daniel Veillard 已提交
998
    }
999 1000 1001 1002
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1003

1004 1005
    conn = domain->conn;

1006 1007
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1008

1009 1010
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1011 1012
}

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
/**
 * 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)
{
1027
    virConnectPtr conn;
1028 1029 1030 1031 1032

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1033 1034 1035 1036
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1037

1038 1039
    conn = domain->conn;

1040 1041
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1042

1043 1044
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1045 1046
}

1047
/**
1048
 * virDomainGetName:
1049 1050 1051 1052 1053 1054 1055 1056
 * @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 *
1057 1058
virDomainGetName(virDomainPtr domain)
{
D
Daniel Veillard 已提交
1059 1060
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1061
        return (NULL);
D
Daniel Veillard 已提交
1062
    }
1063
    return (domain->name);
1064 1065
}

1066 1067 1068
/**
 * virDomainGetUUID:
 * @domain: a domain object
1069
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1070 1071 1072 1073 1074 1075
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1076 1077
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
D
Daniel Veillard 已提交
1078 1079
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1080
        return (-1);
D
Daniel Veillard 已提交
1081 1082 1083
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1084
        return (-1);
D
Daniel Veillard 已提交
1085 1086
    }

1087
    if (domain->id == 0) {
1088
        memset(uuid, 0, VIR_UUID_BUFLEN);
D
Daniel Veillard 已提交
1089
    } else {
1090 1091 1092 1093 1094
#if 0
        /* Probably legacy code: It appears that we always fill in
         * the UUID when creating the virDomain structure, so this
         * shouldn't be necessary.
         */
1095 1096 1097 1098 1099 1100 1101 1102
        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))
1103
            xenDaemonDomainLookupByName_ids(domain->conn, domain->name,
1104
                                &domain->uuid[0]);
1105
#endif
1106
        memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);
1107 1108
    }
    return (0);
1109 1110
}

K
Karel Zak 已提交
1111 1112 1113
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1114
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123
 *
 * 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)
{
1124
    unsigned char uuid[VIR_UUID_BUFLEN];
1125

K
Karel Zak 已提交
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
    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]))
1136
        return (-1);
K
Karel Zak 已提交
1137

1138
    snprintf(buf, VIR_UUID_STRING_BUFLEN,
K
Karel Zak 已提交
1139 1140 1141 1142 1143 1144 1145 1146
	"%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);
}

1147
/**
1148
 * virDomainGetID:
1149 1150 1151 1152 1153 1154 1155
 * @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
1156 1157
virDomainGetID(virDomainPtr domain)
{
D
Daniel Veillard 已提交
1158 1159
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1160
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1161
    }
1162
    return (domain->id);
1163 1164
}

1165 1166 1167 1168 1169 1170
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1171 1172
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1173 1174
 */
char *
1175 1176
virDomainGetOSType(virDomainPtr domain)
{
1177
    virConnectPtr conn;
1178

D
Daniel Veillard 已提交
1179 1180
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1181
        return (NULL);
D
Daniel Veillard 已提交
1182
    }
1183

1184 1185 1186 1187
    conn = domain->conn;

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

1189 1190
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
1191 1192
}

1193
/**
1194
 * virDomainGetMaxMemory:
1195 1196 1197 1198 1199 1200 1201 1202 1203
 * @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
1204 1205
virDomainGetMaxMemory(virDomainPtr domain)
{
1206
    virConnectPtr conn;
1207

D
Daniel Veillard 已提交
1208 1209
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1210
        return (0);
D
Daniel Veillard 已提交
1211
    }
1212

1213 1214
    conn = domain->conn;

1215 1216 1217 1218 1219
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return 0;
1220 1221
}

D
Daniel Veillard 已提交
1222
/**
1223
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1224 1225 1226 1227 1228 1229
 * @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.
1230
 * This function requires priviledged access to the hypervisor.
D
Daniel Veillard 已提交
1231 1232 1233 1234
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1235 1236
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1237
    virConnectPtr conn;
1238

1239 1240 1241 1242 1243 1244
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1245
        return (-1);
1246
    }
1247 1248 1249 1250 1251 1252 1253 1254
    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);
    }
1255
    conn = domain->conn;
1256

1257 1258 1259 1260 1261
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1262
}
1263

1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/**
 * 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;
1280

1281 1282 1283 1284 1285 1286 1287
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
1288
    }
1289 1290 1291 1292 1293 1294
    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__);
1295
        return (-1);
1296 1297 1298
    }

    conn = domain->conn;
1299

1300 1301 1302 1303 1304
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1305 1306
}

1307 1308
/**
 * virDomainGetInfo:
1309
 * @domain: a domain object
1310 1311 1312
 * @info: pointer to a virDomainInfo structure allocated by the user
 * 
 * Extract information about a domain. Note that if the connection
1313
 * used to get the domain is limited only a partial set of the information
1314 1315 1316 1317 1318
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1319 1320
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
1321
    virConnectPtr conn;
1322

D
Daniel Veillard 已提交
1323 1324
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1325
        return (-1);
D
Daniel Veillard 已提交
1326 1327 1328
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1329
        return (-1);
D
Daniel Veillard 已提交
1330
    }
1331

1332
    memset(info, 0, sizeof(virDomainInfo));
1333

1334 1335 1336 1337
    conn = domain->conn;

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

1339 1340
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1341
}
1342

1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
/**
 * 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 *
1355 1356
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
1357 1358
    virConnectPtr conn;

D
Daniel Veillard 已提交
1359 1360
    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1361
        return (NULL);
D
Daniel Veillard 已提交
1362 1363 1364
    }
    if (flags != 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1365
        return (NULL);
D
Daniel Veillard 已提交
1366
    }
1367

1368 1369 1370 1371 1372 1373 1374
    conn = domain->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
1375
}
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386

/**
 * 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
1387 1388
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
1389 1390 1391 1392 1393 1394 1395 1396 1397
    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);
    }

1398 1399 1400 1401 1402
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1403
}
1404

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
 * Returns NULL in case of error, or a pointer to an opaque
 * virCapabilities structure (virCapabilitiesPtr).
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

1423 1424
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
1425

1426
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
1427 1428 1429
    return NULL;
}

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
/************************************************************************
 *									*
 *		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) {
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
1451 1452 1453 1454
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (NULL);
    }
1455 1456 1457 1458 1459
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

1460 1461
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
1462

1463 1464
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
}

/**
 * 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) {
1477
    virConnectPtr conn;
1478 1479 1480 1481 1482

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1483 1484
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
1485 1486 1487 1488
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

1489 1490
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
1491

1492 1493
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1494 1495 1496 1497 1498 1499
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
1500
 * Provides the number of inactive domains.
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

1512 1513
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
1514

1515 1516
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
}

/**
 * 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
1530
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
1531
                             int maxnames) {
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
    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);
    }

1542 1543
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
1544

1545 1546
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
}

/**
 * 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) {
1560
    virConnectPtr conn;
1561

1562 1563 1564 1565
    if (domain == NULL) {
        TODO
	return (-1);
    }
1566 1567 1568 1569
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1570 1571
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
1572 1573 1574
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1575

1576 1577 1578 1579 1580
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1581 1582
}

1583 1584 1585
/**
 * virDomainGetAutostart:
 * @domain: a domain object
1586
 * @autostart: the value returned
1587
 *
1588
 * Provides a boolean value indicating whether the domain
1589 1590 1591 1592 1593 1594 1595
 * 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,
1596 1597 1598
                      int *autostart)
{
    virConnectPtr conn;
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608

    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

1609 1610 1611 1612 1613 1614 1615
    conn = domain->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1616 1617 1618 1619 1620
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
1621
 * @autostart: whether the domain should be automatically started 0 or 1
1622 1623 1624 1625 1626 1627 1628 1629
 *
 * 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,
1630 1631 1632
                      int autostart)
{
    virConnectPtr conn;
1633 1634 1635 1636 1637 1638

    if (!VIR_IS_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }

1639 1640 1641 1642 1643 1644 1645
    conn = domain->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1646 1647
}

1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
/**
 * 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)
{
1664 1665
    virConnectPtr conn;

1666 1667 1668 1669 1670 1671 1672 1673
    if (domain == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
1674 1675 1676 1677
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }
1678

1679 1680 1681 1682
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1683
    conn = domain->conn;
1684

1685 1686
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
1687

1688 1689
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
}

/**
 * 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)
{
1714 1715
    virConnectPtr conn;

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

1729
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
1730 1731 1732
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1733

1734 1735
    conn = domain->conn;

1736 1737 1738 1739 1740
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
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
}

/**
 * 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)
{
1768
    virConnectPtr conn;
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785

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

1787 1788
    conn = domain->conn;

1789 1790 1791 1792 1793 1794
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1795
}
1796

1797 1798 1799 1800
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
 * 
1801 1802 1803 1804 1805
 * 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.
1806 1807 1808 1809
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
1810 1811
virDomainGetMaxVcpus(virDomainPtr domain)
{
1812 1813 1814 1815 1816 1817 1818 1819 1820
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(domain, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }

    conn = domain->conn;

1821 1822 1823 1824 1825
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
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
/**
 * 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)
{
    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;

1853 1854 1855 1856 1857
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883
}

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

1884 1885 1886 1887 1888
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1889
}
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906

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

1907 1908
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
1909

1910 1911
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
}

/**
 * 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
1925
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
{
    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);
    }

1937 1938
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
1939

1940 1941
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
}

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

1960 1961
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
1962

1963 1964
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
}

/**
 * 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
1978
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
1979 1980
                              int maxnames)
{
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
    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);
    }

1991 1992 1993
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
1994

1995 1996
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
}

/**
 * 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.
 *
 * Returns a new network object or NULL in case of failure
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2020 2021 2022 2023 2024
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
}

/**
 * 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.
 *
 * Returns a new network object or NULL in case of failure
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2048 2049
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
2050

2051 2052
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129
}

/**
 * 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.
 *
 * Returns a new network object or NULL in case of failure
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    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);

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

2130 2131 2132 2133 2134
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
}

/**
 * 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
2147 2148
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        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);
    }

2162 2163
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
2164

2165 2166
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190
}

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

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

2191 2192
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
2193

2194 2195
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
}

/**
 * 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
2208 2209
virNetworkCreate(virNetworkPtr network)
{
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
    virConnectPtr conn;
    if (network == NULL) {
        TODO
	return (-1);
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
	return (-1);
    }

2225 2226 2227 2228 2229
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
}

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

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }

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

2260 2261
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
2262

2263 2264
    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382
}

/**
 * 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)
{
    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        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)
{
    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        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)
{
    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        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];

    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    snprintf(buf, VIR_UUID_STRING_BUFLEN,
	"%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);
}

/**
 * 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)
{
2383 2384
    virConnectPtr conn;

2385 2386 2387 2388 2389 2390 2391 2392 2393
    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2394 2395 2396 2397 2398 2399 2400
    conn = network->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2401
}
2402 2403 2404 2405 2406

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
2407
 * Provides a bridge interface name to which a domain may connect
2408 2409 2410 2411 2412 2413 2414 2415
 * 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)
{
2416 2417
    virConnectPtr conn;

2418 2419 2420 2421 2422
    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (NULL);
    }

2423 2424 2425 2426 2427 2428 2429
    conn = network->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return NULL;
2430
}
2431 2432 2433 2434

/**
 * virNetworkGetAutostart:
 * @network: a network object
2435
 * @autostart: the value returned
2436
 *
2437
 * Provides a boolean value indicating whether the network
2438 2439 2440 2441 2442 2443 2444
 * 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,
2445 2446 2447
                       int *autostart)
{
    virConnectPtr conn;
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457

    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2458 2459 2460 2461 2462 2463 2464
    conn = network->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
2465 2466 2467 2468 2469
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
2470
 * @autostart: whether the network should be automatically started 0 or 1
2471 2472 2473 2474 2475 2476 2477 2478
 *
 * 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,
2479 2480 2481
                       int autostart)
{
    virConnectPtr conn;
2482 2483 2484 2485 2486 2487

    if (!VIR_IS_NETWORK(network)) {
        virLibNetworkError(network, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }

2488 2489 2490 2491 2492 2493 2494
    conn = network->conn;

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

    virLibConnError (conn, VIR_ERR_CALL_FAILED, __FUNCTION__);
    return -1;
2495
}
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509

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