xen_unified.c 34.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/*
 * xen_unified.c: Unified Xen driver.
 *
 * Copyright (C) 2007 Red Hat, Inc.
 *
 * See COPYING.LIB for the License of this software
 *
 * Richard W.M. Jones <rjones@redhat.com>
 */

11
#include <config.h>
12

13 14 15 16 17 18 19 20 21 22 23 24 25
#ifdef WITH_XEN

/* Note:
 *
 * This driver provides a unified interface to the five
 * separate underlying Xen drivers (xen_internal, proxy_internal,
 * xend_internal, xs_internal and xm_internal).  Historically
 * the body of libvirt.c handled the five Xen drivers,
 * and contained Xen-specific code.
 */

#include <stdint.h>
#include <unistd.h>
26
#include <string.h>
27
#include <errno.h>
28 29
#include <sys/types.h>
#include <xen/dom0_ops.h>
30
#include <libxml/uri.h>
31 32 33 34 35 36 37 38 39 40

#include "internal.h"

#include "xen_unified.h"

#include "xen_internal.h"
#include "proxy_internal.h"
#include "xend_internal.h"
#include "xs_internal.h"
#include "xm_internal.h"
41
#include "xml.h"
42
#include "util.h"
43

44 45
#define DEBUG(fmt,...) VIR_DEBUG(__FILE__, fmt,__VA_ARGS__)

46 47
static int
xenUnifiedNodeGetInfo (virConnectPtr conn, virNodeInfoPtr info);
48 49 50 51 52 53
static int
xenUnifiedDomainGetMaxVcpus (virDomainPtr dom);
static int
xenUnifiedDomainGetVcpus (virDomainPtr dom,
                          virVcpuInfoPtr info, int maxinfo,
                          unsigned char *cpumaps, int maplen);
54

55
/* The five Xen drivers below us. */
56 57 58 59 60 61
static struct xenUnifiedDriver *drivers[XEN_UNIFIED_NR_DRIVERS] = {
    [XEN_UNIFIED_HYPERVISOR_OFFSET] = &xenHypervisorDriver,
    [XEN_UNIFIED_PROXY_OFFSET] = &xenProxyDriver,
    [XEN_UNIFIED_XEND_OFFSET] = &xenDaemonDriver,
    [XEN_UNIFIED_XS_OFFSET] = &xenStoreDriver,
    [XEN_UNIFIED_XM_OFFSET] = &xenXMDriver,
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
};

/**
 * xenUnifiedError:
 * @conn: the connection
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the xend daemon interface
 */
static void
xenUnifiedError (virConnectPtr conn, virErrorNumber error, const char *info)
{
    const char *errmsg;

    errmsg = __virErrorMsg (error, info);
    __virRaiseError (conn, NULL, NULL, VIR_FROM_XEN, error, VIR_ERR_ERROR,
79
                     errmsg, info, NULL, 0, 0, errmsg, info);
80 81
}

82 83
/*
 * Helper functions currently used in the NUMA code
84 85
 * Those variables should not be accessed directly but through helper
 * functions xenNbCells() and xenNbCpu() available to all Xen backends
86 87 88 89 90 91 92 93 94
 */
static int nbNodeCells = -1;
static int nbNodeCpus = -1;

/**
 * xenNumaInit:
 * @conn: pointer to the hypervisor connection
 *
 * Initializer for previous variables. We currently assume that
R
Richard W.M. Jones 已提交
95
 * the number of physical CPU and the number of NUMA cell is fixed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
 * until reboot which might be false in future Xen implementations.
 */
static void
xenNumaInit(virConnectPtr conn) {
    virNodeInfo nodeInfo;
    int ret;

    ret = xenUnifiedNodeGetInfo(conn, &nodeInfo);
    if (ret < 0)
        return;
    nbNodeCells = nodeInfo.nodes;
    nbNodeCpus = nodeInfo.cpus;
}

/**
 * xenNbCells:
 * @conn: pointer to the hypervisor connection
 *
R
Richard W.M. Jones 已提交
114
 * Number of NUMA cells present in the actual Node
115 116 117 118 119 120 121 122 123 124 125 126 127
 *
 * Returns the number of NUMA cells available on that Node
 */
int xenNbCells(virConnectPtr conn) {
    if (nbNodeCells < 0)
        xenNumaInit(conn);
    return(nbNodeCells);
}

/**
 * xenNbCpus:
 * @conn: pointer to the hypervisor connection
 *
128
 * Number of CPUs present in the actual Node
129
 *
130
 * Returns the number of CPUs available on that Node
131 132 133 134 135 136 137
 */
int xenNbCpus(virConnectPtr conn) {
    if (nbNodeCpus < 0)
        xenNumaInit(conn);
    return(nbNodeCpus);
}

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/**
 * xenDomainUsedCpus:
 * @dom: the domain
 *
 * Analyze which set of CPUs are used by the domain and
 * return a string providing the ranges.
 *
 * Returns the string which needs to be freed by the caller or
 *         NULL if the domain uses all CPU or in case of error.
 */
char *
xenDomainUsedCpus(virDomainPtr dom)
{
    char *res = NULL;
    int nb_cpu, ncpus;
    int nb_vcpu;
    char *cpulist = NULL;
    unsigned char *cpumap = NULL;
    size_t cpumaplen;
    int nb = 0;
    int n, m;
    virVcpuInfoPtr cpuinfo = NULL;
    virNodeInfo nodeinfo;

    if (!VIR_IS_CONNECTED_DOMAIN(dom))
        return (NULL);

    nb_cpu = xenNbCpus(dom->conn);
    if (nb_cpu <= 0)
        return(NULL);
    nb_vcpu = xenUnifiedDomainGetMaxVcpus(dom);
    if (nb_vcpu <= 0)
        return(NULL);
    if (xenUnifiedNodeGetInfo(dom->conn, &nodeinfo) < 0)
        return(NULL);

174
    cpulist = calloc(nb_cpu, sizeof(*cpulist));
175 176
    if (cpulist == NULL)
        goto done;
177
    cpuinfo = malloc(sizeof(*cpuinfo) * nb_vcpu);
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    if (cpuinfo == NULL)
        goto done;
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
    cpumap = (unsigned char *) calloc(nb_vcpu, cpumaplen);
    if (cpumap == NULL)
        goto done;

    if ((ncpus = xenUnifiedDomainGetVcpus(dom, cpuinfo, nb_vcpu,
                                          cpumap, cpumaplen)) >= 0) {
	for (n = 0 ; n < ncpus ; n++) {
	    for (m = 0 ; m < nb_cpu; m++) {
	        if ((cpulist[m] == 0) &&
	 	    (VIR_CPU_USABLE(cpumap, cpumaplen, n, m))) {
		    cpulist[m] = 1;
		    nb++;
		    /* if all CPU are used just return NULL */
194
		    if (nb == nb_cpu)
195
		        goto done;
196

197 198 199 200 201 202 203
		}
	    }
	}
        res = virSaveCpuSet(dom->conn, cpulist, nb_cpu);
    }

done:
204 205 206
    free(cpulist);
    free(cpumap);
    free(cpuinfo);
207 208 209
    return(res);
}

210 211 212 213 214 215 216 217 218 219 220
/*----- Dispatch functions. -----*/

/* These dispatch functions follow the model used historically
 * by libvirt.c -- trying each low-level Xen driver in turn
 * until one succeeds.  However since we know what low-level
 * drivers can perform which functions, it is probably better
 * in future to optimise these dispatch functions to just call
 * the single function (or small number of appropriate functions)
 * in the low level drivers directly.
 */

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
static const char *
xenUnifiedProbe (void)
{
#ifdef __linux__
    if (virFileExists("/proc/xen"))
        return("xen:///");
#endif
#ifdef __sun__
    FILE *fh;

    if (fh = fopen("/dev/xen/domcaps", "r")) {
	fclose(fh);
        return("xen:///");
    }
#endif
    return(NULL);
}

239
static int
240
xenUnifiedOpen (virConnectPtr conn, xmlURIPtr uri, virConnectAuthPtr auth, int flags)
241
{
242 243
    int i, j;
    xenUnifiedPrivatePtr priv;
244

245
    /* Refuse any scheme which isn't "xen://" or "http://". */
246 247
    if (uri->scheme &&
        strcasecmp(uri->scheme, "xen") != 0 &&
248
        strcasecmp(uri->scheme, "http") != 0)
249 250 251 252 253 254 255
        return VIR_DRV_OPEN_DECLINED;

    /* xmlParseURI will parse a naked string like "foo" as a URI with
     * a NULL scheme.  That's not useful for us because we want to only
     * allow full pathnames (eg. ///var/lib/xen/xend-socket).  Decline
     * anything else.
     */
256
    if (!uri->scheme && (!uri->path || uri->path[0] != '/'))
257
        return VIR_DRV_OPEN_DECLINED;
258 259

    /* Refuse any xen:// URI with a server specified - allow remote to do it */
260
    if (uri->scheme && strcasecmp(uri->scheme, "xen") == 0 && uri->server)
261
        return VIR_DRV_OPEN_DECLINED;
262 263

    /* Allocate per-connection private data. */
264
    priv = calloc (1, sizeof *priv);
265
    if (!priv) {
266
        xenUnifiedError (NULL, VIR_ERR_NO_MEMORY, "allocating private data");
267 268 269 270 271 272 273 274 275 276 277 278
        return VIR_DRV_OPEN_ERROR;
    }
    conn->privateData = priv;

    priv->handle = -1;
    priv->xendConfigVersion = -1;
    priv->type = -1;
    priv->len = -1;
    priv->addr = NULL;
    priv->xshandle = NULL;
    priv->proxy = -1;

279 280
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i) {
        priv->opened[i] = 0;
281

282 283 284 285 286
        /* Only use XM driver for Xen <= 3.0.3 (ie xendConfigVersion <= 2) */
        if (drivers[i] == &xenXMDriver &&
            priv->xendConfigVersion > 2)
            continue;

287
        /* Ignore proxy for root */
288
        if (i == XEN_UNIFIED_PROXY_OFFSET && getuid() == 0)
289 290
            continue;

291
        if (drivers[i]->open) {
292
            DEBUG("trying Xen sub-driver %d", i);
293
            if (drivers[i]->open (conn, uri, auth, flags) == VIR_DRV_OPEN_SUCCESS)
294
                priv->opened[i] = 1;
295 296
            DEBUG("Xen sub-driver %d open %s\n",
                  i, priv->opened[i] ? "ok" : "failed");
297
        }
298 299 300

        /* If as root, then all drivers must succeed.
           If non-root, then only proxy must succeed */
301 302
        if (!priv->opened[i] &&
            (getuid() == 0 || i == XEN_UNIFIED_PROXY_OFFSET)) {
303
            for (j = 0; j < i; ++j)
304
                if (priv->opened[j]) drivers[j]->close (conn);
305 306 307 308
            free (priv);
            /* The assumption is that one of the underlying drivers
             * has set virterror already.
             */
309 310
            return VIR_DRV_OPEN_ERROR;
        }
311 312
    }

313
    return VIR_DRV_OPEN_SUCCESS;
314 315
}

316 317 318
#define GET_PRIVATE(conn) \
    xenUnifiedPrivatePtr priv = (xenUnifiedPrivatePtr) (conn)->privateData

319 320 321
static int
xenUnifiedClose (virConnectPtr conn)
{
322
    GET_PRIVATE(conn);
323
    int i;
324

325 326
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->close)
327
            (void) drivers[i]->close (conn);
328

329 330
    free (conn->privateData);
    conn->privateData = NULL;
331

332
    return 0;
333 334 335 336 337
}

static const char *
xenUnifiedType (virConnectPtr conn)
{
338
    GET_PRIVATE(conn);
339
    int i;
340

341
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
342 343
        if (priv->opened[i])
            return "Xen";
344

345
    return NULL;
346 347
}

348 349 350 351 352 353 354 355 356 357
/* Which features are supported by this driver? */
static int
xenUnifiedSupportsFeature (virConnectPtr conn ATTRIBUTE_UNUSED, int feature)
{
    switch (feature) {
    case VIR_DRV_FEATURE_MIGRATION_V1: return 1;
    default: return 0;
    }
}

358 359 360
static int
xenUnifiedVersion (virConnectPtr conn, unsigned long *hvVer)
{
361
    GET_PRIVATE(conn);
362
    int i;
363

364 365 366
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->version &&
367 368
            drivers[i]->version (conn, hvVer) == 0)
            return 0;
369

370
    return -1;
371 372
}

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
/* NB: Even if connected to the proxy, we're still on the
 * same machine.
 */
static char *
xenUnifiedGetHostname (virConnectPtr conn)
{
    int r;
    char hostname [HOST_NAME_MAX+1], *str;

    r = gethostname (hostname, HOST_NAME_MAX+1);
    if (r == -1) {
        xenUnifiedError (conn, VIR_ERR_SYSTEM_ERROR, strerror (errno));
        return NULL;
    }
    str = strdup (hostname);
    if (str == NULL) {
        xenUnifiedError (conn, VIR_ERR_SYSTEM_ERROR, strerror (errno));
        return NULL;
    }
    return str;
}

395 396 397
static int
xenUnifiedGetMaxVcpus (virConnectPtr conn, const char *type)
{
398
    GET_PRIVATE(conn);
399

400 401 402 403
    if (type && STRCASENEQ (type, "Xen")) {
        xenUnifiedError (conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }
404

405 406 407 408 409 410
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET])
        return xenHypervisorGetMaxVcpus (conn, type);
    else {
        xenUnifiedError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
        return -1;
    }
411 412 413 414 415
}

static int
xenUnifiedNodeGetInfo (virConnectPtr conn, virNodeInfoPtr info)
{
416
    GET_PRIVATE(conn);
417
    int i;
418

419 420 421
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->nodeGetInfo &&
422 423
            drivers[i]->nodeGetInfo (conn, info) == 0)
            return 0;
424

425
    return -1;
426 427 428 429 430
}

static char *
xenUnifiedGetCapabilities (virConnectPtr conn)
{
431
    GET_PRIVATE(conn);
432 433
    int i;
    char *ret;
434

435 436
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->getCapabilities) {
437 438 439
            ret = drivers[i]->getCapabilities (conn);
            if (ret) return ret;
        }
440

441
    return NULL;
442 443 444 445 446
}

static int
xenUnifiedListDomains (virConnectPtr conn, int *ids, int maxids)
{
447
    GET_PRIVATE(conn);
448
    int i, ret;
449

450 451
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->listDomains) {
452 453 454
            ret = drivers[i]->listDomains (conn, ids, maxids);
            if (ret >= 0) return ret;
        }
455

456
    return -1;
457 458 459 460 461
}

static int
xenUnifiedNumOfDomains (virConnectPtr conn)
{
462
    GET_PRIVATE(conn);
463
    int i, ret;
464

465 466
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->numOfDomains) {
467 468 469
            ret = drivers[i]->numOfDomains (conn);
            if (ret >= 0) return ret;
        }
470

471
    return -1;
472 473 474 475
}

static virDomainPtr
xenUnifiedDomainCreateLinux (virConnectPtr conn,
476
                             const char *xmlDesc, unsigned int flags)
477
{
478
    GET_PRIVATE(conn);
479 480
    int i;
    virDomainPtr ret;
481

482 483
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainCreateLinux) {
484 485 486
            ret = drivers[i]->domainCreateLinux (conn, xmlDesc, flags);
            if (ret) return ret;
        }
487

488
    return NULL;
489 490
}

491 492 493 494
/* Assumption made in underlying drivers:
 * If the domain is "not found" and there is no other error, then
 * the Lookup* functions return a NULL but do not set virterror.
 */
495 496 497
static virDomainPtr
xenUnifiedDomainLookupByID (virConnectPtr conn, int id)
{
498
    GET_PRIVATE(conn);
499
    virDomainPtr ret;
500

501 502 503 504 505
    /* Reset any connection-level errors in virterror first, in case
     * there is one hanging around from a previous call.
     */
    virConnResetLastError (conn);

506 507 508 509 510 511 512
    /* Try hypervisor/xenstore combo. */
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET]) {
        ret = xenHypervisorLookupDomainByID (conn, id);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

513 514 515 516 517 518 519 520 521 522 523 524 525
    /* Try proxy. */
    if (priv->opened[XEN_UNIFIED_PROXY_OFFSET]) {
        ret = xenProxyLookupByID (conn, id);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Try xend. */
    if (priv->opened[XEN_UNIFIED_XEND_OFFSET]) {
        ret = xenDaemonLookupByID (conn, id);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }
526

527 528
    /* Not found. */
    xenUnifiedError (conn, VIR_ERR_NO_DOMAIN, __FUNCTION__);
529
    return NULL;
530 531 532 533
}

static virDomainPtr
xenUnifiedDomainLookupByUUID (virConnectPtr conn,
534
                              const unsigned char *uuid)
535
{
536
    GET_PRIVATE(conn);
537
    virDomainPtr ret;
538

539 540 541 542 543
    /* Reset any connection-level errors in virterror first, in case
     * there is one hanging around from a previous call.
     */
    virConnResetLastError (conn);

544 545 546 547 548 549 550
    /* Try hypervisor/xenstore combo. */
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET]) {
        ret = xenHypervisorLookupDomainByUUID (conn, uuid);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

551 552 553 554 555 556 557 558 559 560 561 562 563
    /* Try proxy. */
    if (priv->opened[XEN_UNIFIED_PROXY_OFFSET]) {
        ret = xenProxyLookupByUUID (conn, uuid);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Try xend. */
    if (priv->opened[XEN_UNIFIED_XEND_OFFSET]) {
        ret = xenDaemonLookupByUUID (conn, uuid);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }
564

565 566 567 568 569 570 571 572 573
    /* Try XM for inactive domains. */
    if (priv->opened[XEN_UNIFIED_XM_OFFSET]) {
        ret = xenXMDomainLookupByUUID (conn, uuid);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Not found. */
    xenUnifiedError (conn, VIR_ERR_NO_DOMAIN, __FUNCTION__);
574
    return NULL;
575 576 577 578
}

static virDomainPtr
xenUnifiedDomainLookupByName (virConnectPtr conn,
579
                              const char *name)
580
{
581
    GET_PRIVATE(conn);
582
    virDomainPtr ret;
583

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
    /* Reset any connection-level errors in virterror first, in case
     * there is one hanging around from a previous call.
     */
    virConnResetLastError (conn);

    /* Try proxy. */
    if (priv->opened[XEN_UNIFIED_PROXY_OFFSET]) {
        ret = xenProxyLookupByName (conn, name);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Try xend. */
    if (priv->opened[XEN_UNIFIED_XEND_OFFSET]) {
        ret = xenDaemonLookupByName (conn, name);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Try xenstore for inactive domains. */
    if (priv->opened[XEN_UNIFIED_XS_OFFSET]) {
        ret = xenStoreLookupByName (conn, name);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }

    /* Try XM for inactive domains. */
    if (priv->opened[XEN_UNIFIED_XM_OFFSET]) {
        ret = xenXMDomainLookupByName (conn, name);
        if (ret || conn->err.code != VIR_ERR_OK)
            return ret;
    }
616

617 618
    /* Not found. */
    xenUnifiedError (conn, VIR_ERR_NO_DOMAIN, __FUNCTION__);
619
    return NULL;
620 621 622 623 624
}

static int
xenUnifiedDomainSuspend (virDomainPtr dom)
{
625
    GET_PRIVATE(dom->conn);
626
    int i;
627

628 629 630
    /* Try non-hypervisor methods first, then hypervisor direct method
     * as a last resort.
     */
631
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
632
        if (i != XEN_UNIFIED_HYPERVISOR_OFFSET &&
633
            priv->opened[i] &&
634 635 636
            drivers[i]->domainSuspend &&
            drivers[i]->domainSuspend (dom) == 0)
            return 0;
637

638 639 640
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET] &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainSuspend &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainSuspend (dom) == 0)
641
        return 0;
642

643
    return -1;
644 645 646 647 648
}

static int
xenUnifiedDomainResume (virDomainPtr dom)
{
649
    GET_PRIVATE(dom->conn);
650
    int i;
651

652 653 654
    /* Try non-hypervisor methods first, then hypervisor direct method
     * as a last resort.
     */
655
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
656
        if (i != XEN_UNIFIED_HYPERVISOR_OFFSET &&
657
            priv->opened[i] &&
658 659 660
            drivers[i]->domainResume &&
            drivers[i]->domainResume (dom) == 0)
            return 0;
661

662 663 664
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET] &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainResume &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainResume (dom) == 0)
665
        return 0;
666

667
    return -1;
668 669 670 671 672
}

static int
xenUnifiedDomainShutdown (virDomainPtr dom)
{
673
    GET_PRIVATE(dom->conn);
674
    int i;
675

676 677 678
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainShutdown &&
679 680
            drivers[i]->domainShutdown (dom) == 0)
            return 0;
681

682
    return -1;
683 684 685 686 687
}

static int
xenUnifiedDomainReboot (virDomainPtr dom, unsigned int flags)
{
688
    GET_PRIVATE(dom->conn);
689
    int i;
690

691 692 693
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainReboot &&
694 695
            drivers[i]->domainReboot (dom, flags) == 0)
            return 0;
696

697
    return -1;
698 699 700 701 702
}

static int
xenUnifiedDomainDestroy (virDomainPtr dom)
{
703
    GET_PRIVATE(dom->conn);
704
    int i;
705

706 707 708
    /* Try non-hypervisor methods first, then hypervisor direct method
     * as a last resort.
     */
709
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
710
        if (i != XEN_UNIFIED_HYPERVISOR_OFFSET &&
711
            priv->opened[i] &&
712 713 714
            drivers[i]->domainDestroy &&
            drivers[i]->domainDestroy (dom) == 0)
            return 0;
715

716
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET] &&
717 718
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainDestroy &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainDestroy (dom) == 0)
719
        return 0;
720

721
    return -1;
722 723 724 725 726
}

static char *
xenUnifiedDomainGetOSType (virDomainPtr dom)
{
727
    GET_PRIVATE(dom->conn);
728 729
    int i;
    char *ret;
730

731 732
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainGetOSType) {
733 734 735
            ret = drivers[i]->domainGetOSType (dom);
            if (ret) return ret;
        }
736

737
    return NULL;
738 739 740 741 742
}

static unsigned long
xenUnifiedDomainGetMaxMemory (virDomainPtr dom)
{
743
    GET_PRIVATE(dom->conn);
744 745
    int i;
    unsigned long ret;
746

747 748
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainGetMaxMemory) {
749 750 751
            ret = drivers[i]->domainGetMaxMemory (dom);
            if (ret != 0) return ret;
        }
752

753
    return 0;
754 755 756 757 758
}

static int
xenUnifiedDomainSetMaxMemory (virDomainPtr dom, unsigned long memory)
{
759
    GET_PRIVATE(dom->conn);
760
    int i;
761

762 763 764
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainSetMaxMemory &&
765 766
            drivers[i]->domainSetMaxMemory (dom, memory) == 0)
            return 0;
767

768
    return -1;
769 770 771 772 773
}

static int
xenUnifiedDomainSetMemory (virDomainPtr dom, unsigned long memory)
{
774
    GET_PRIVATE(dom->conn);
775
    int i;
776

777 778 779
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainSetMemory &&
780 781
            drivers[i]->domainSetMemory (dom, memory) == 0)
            return 0;
782

783
    return -1;
784 785 786 787 788
}

static int
xenUnifiedDomainGetInfo (virDomainPtr dom, virDomainInfoPtr info)
{
789
    GET_PRIVATE(dom->conn);
790
    int i;
791

792 793 794
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainGetInfo &&
795 796
            drivers[i]->domainGetInfo (dom, info) == 0)
            return 0;
797

798
    return -1;
799 800 801 802 803
}

static int
xenUnifiedDomainSave (virDomainPtr dom, const char *to)
{
804
    GET_PRIVATE(dom->conn);
805
    int i;
806

807 808 809
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainSave &&
810 811
            drivers[i]->domainSave (dom, to) == 0)
            return 0;
812

813
    return -1;
814 815 816 817 818
}

static int
xenUnifiedDomainRestore (virConnectPtr conn, const char *from)
{
819
    GET_PRIVATE(conn);
820
    int i;
821

822 823 824
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainRestore &&
825 826
            drivers[i]->domainRestore (conn, from) == 0)
            return 0;
827

828
    return -1;
829 830 831 832 833
}

static int
xenUnifiedDomainCoreDump (virDomainPtr dom, const char *to, int flags)
{
834
    GET_PRIVATE(dom->conn);
835
    int i;
836

837 838 839
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainCoreDump &&
840 841
            drivers[i]->domainCoreDump (dom, to, flags) == 0)
            return 0;
842

843
    return -1;
844 845 846 847 848
}

static int
xenUnifiedDomainSetVcpus (virDomainPtr dom, unsigned int nvcpus)
{
849
    GET_PRIVATE(dom->conn);
850
    int i;
851

852 853 854
    /* Try non-hypervisor methods first, then hypervisor direct method
     * as a last resort.
     */
855
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
856
        if (i != XEN_UNIFIED_HYPERVISOR_OFFSET &&
857
            priv->opened[i] &&
858 859 860
            drivers[i]->domainSetVcpus &&
            drivers[i]->domainSetVcpus (dom, nvcpus) == 0)
            return 0;
861

862 863 864
    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET] &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainSetVcpus &&
        drivers[XEN_UNIFIED_HYPERVISOR_OFFSET]->domainSetVcpus (dom, nvcpus) == 0)
865
        return 0;
866

867
    return -1;
868 869 870 871
}

static int
xenUnifiedDomainPinVcpu (virDomainPtr dom, unsigned int vcpu,
872
                         unsigned char *cpumap, int maplen)
873
{
874
    GET_PRIVATE(dom->conn);
875
    int i;
876

877 878 879
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] &&
            drivers[i]->domainPinVcpu &&
880 881
            drivers[i]->domainPinVcpu (dom, vcpu, cpumap, maplen) == 0)
            return 0;
882

883
    return -1;
884 885 886 887
}

static int
xenUnifiedDomainGetVcpus (virDomainPtr dom,
888 889
                          virVcpuInfoPtr info, int maxinfo,
                          unsigned char *cpumaps, int maplen)
890
{
891
    GET_PRIVATE(dom->conn);
892
    int i, ret;
893

894 895
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainGetVcpus) {
896 897 898 899
            ret = drivers[i]->domainGetVcpus (dom, info, maxinfo, cpumaps, maplen);
            if (ret > 0)
                return ret;
        }
900
    return -1;
901 902 903 904 905
}

static int
xenUnifiedDomainGetMaxVcpus (virDomainPtr dom)
{
906
    GET_PRIVATE(dom->conn);
907
    int i, ret;
908

909 910
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainGetMaxVcpus) {
911 912 913
            ret = drivers[i]->domainGetMaxVcpus (dom);
            if (ret != 0) return ret;
        }
914

915
    return -1;
916 917 918 919 920
}

static char *
xenUnifiedDomainDumpXML (virDomainPtr dom, int flags)
{
921
    GET_PRIVATE(dom->conn);
922

923 924 925 926 927 928 929 930 931
    if (dom->id == -1 && priv->xendConfigVersion < 3 ) {
        if (priv->opened[XEN_UNIFIED_XM_OFFSET])
            return xenXMDomainDumpXML(dom, flags);
    } else {
        if (priv->opened[XEN_UNIFIED_XEND_OFFSET]) {
            char *cpus, *res;
            cpus = xenDomainUsedCpus(dom);
            res = xenDaemonDomainDumpXML(dom, flags, cpus);
	        free(cpus);
932
            return(res);
933
        }
934 935
        if (priv->opened[XEN_UNIFIED_PROXY_OFFSET])
            return xenProxyDomainDumpXML(dom, flags);
936
    }
937

938
    xenUnifiedError (dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
939
    return NULL;
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 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
static int
xenUnifiedDomainMigratePrepare (virConnectPtr dconn,
                                char **cookie,
                                int *cookielen,
                                const char *uri_in,
                                char **uri_out,
                                unsigned long flags,
                                const char *dname,
                                unsigned long resource)
{
    GET_PRIVATE(dconn);

    if (priv->opened[XEN_UNIFIED_XEND_OFFSET])
        return xenDaemonDomainMigratePrepare (dconn, cookie, cookielen,
                                              uri_in, uri_out,
                                              flags, dname, resource);

    xenUnifiedError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

static int
xenUnifiedDomainMigratePerform (virDomainPtr dom,
                                const char *cookie,
                                int cookielen,
                                const char *uri,
                                unsigned long flags,
                                const char *dname,
                                unsigned long resource)
{
    GET_PRIVATE(dom->conn);

    if (priv->opened[XEN_UNIFIED_XEND_OFFSET])
        return xenDaemonDomainMigratePerform (dom, cookie, cookielen, uri,
                                              flags, dname, resource);

    xenUnifiedError (dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

static virDomainPtr
xenUnifiedDomainMigrateFinish (virConnectPtr dconn,
                               const char *dname,
                               const char *cookie ATTRIBUTE_UNUSED,
                               int cookielen ATTRIBUTE_UNUSED,
                               const char *uri ATTRIBUTE_UNUSED,
                               unsigned long flags ATTRIBUTE_UNUSED)
{
    return xenUnifiedDomainLookupByName (dconn, dname);
}

993 994
static int
xenUnifiedListDefinedDomains (virConnectPtr conn, char **const names,
995
                              int maxnames)
996
{
997
    GET_PRIVATE(conn);
998 999
    int i;
    int ret;
1000

1001 1002
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->listDefinedDomains) {
1003 1004 1005
            ret = drivers[i]->listDefinedDomains (conn, names, maxnames);
            if (ret >= 0) return ret;
        }
1006

1007
    return -1;
1008 1009 1010 1011 1012
}

static int
xenUnifiedNumOfDefinedDomains (virConnectPtr conn)
{
1013
    GET_PRIVATE(conn);
1014 1015
    int i;
    int ret;
1016

1017 1018
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->numOfDefinedDomains) {
1019 1020 1021
            ret = drivers[i]->numOfDefinedDomains (conn);
            if (ret >= 0) return ret;
        }
1022

1023
    return -1;
1024 1025 1026 1027 1028
}

static int
xenUnifiedDomainCreate (virDomainPtr dom)
{
1029
    GET_PRIVATE(dom->conn);
1030
    int i;
1031

1032 1033
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainCreate &&
1034 1035
            drivers[i]->domainCreate (dom) == 0)
            return 0;
1036

1037
    return -1;
1038 1039 1040 1041 1042
}

static virDomainPtr
xenUnifiedDomainDefineXML (virConnectPtr conn, const char *xml)
{
1043
    GET_PRIVATE(conn);
1044 1045
    int i;
    virDomainPtr ret;
1046

1047 1048
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainDefineXML) {
1049 1050 1051
            ret = drivers[i]->domainDefineXML (conn, xml);
            if (ret) return ret;
        }
1052

1053
    return NULL;
1054 1055 1056 1057 1058
}

static int
xenUnifiedDomainUndefine (virDomainPtr dom)
{
1059
    GET_PRIVATE(dom->conn);
1060
    int i;
1061

1062 1063
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainUndefine &&
1064 1065
            drivers[i]->domainUndefine (dom) == 0)
            return 0;
1066

1067
    return -1;
1068 1069 1070
}

static int
1071
xenUnifiedDomainAttachDevice (virDomainPtr dom, const char *xml)
1072
{
1073
    GET_PRIVATE(dom->conn);
1074
    int i;
1075

1076 1077
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainAttachDevice &&
1078 1079
            drivers[i]->domainAttachDevice (dom, xml) == 0)
            return 0;
1080

1081
    return -1;
1082 1083 1084
}

static int
1085
xenUnifiedDomainDetachDevice (virDomainPtr dom, const char *xml)
1086
{
1087
    GET_PRIVATE(dom->conn);
1088
    int i;
1089

1090 1091
    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i)
        if (priv->opened[i] && drivers[i]->domainDetachDevice &&
1092 1093
            drivers[i]->domainDetachDevice (dom, xml) == 0)
            return 0;
1094

1095
    return -1;
1096 1097
}

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
static char *
xenUnifiedDomainGetSchedulerType (virDomainPtr dom, int *nparams)
{
    GET_PRIVATE(dom->conn);
    int i;
    char *schedulertype;

    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; i++) {
        if (priv->opened[i] && drivers[i]->domainGetSchedulerType) {
            schedulertype = drivers[i]->domainGetSchedulerType (dom, nparams);
	    if (schedulertype != NULL)
1109
		return(schedulertype);
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
        }
    }
    return(NULL);
}

static int
xenUnifiedDomainGetSchedulerParameters (virDomainPtr dom,
                    virSchedParameterPtr params, int *nparams)
{
    GET_PRIVATE(dom->conn);
    int i, ret;

    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i) {
        if (priv->opened[i] && drivers[i]->domainGetSchedulerParameters) {
           ret = drivers[i]->domainGetSchedulerParameters(dom, params, nparams);
	   if (ret == 0)
	       return(0);
	}
    }
    return(-1);
}

static int
xenUnifiedDomainSetSchedulerParameters (virDomainPtr dom,
                    virSchedParameterPtr params, int nparams)
{
    GET_PRIVATE(dom->conn);
    int i, ret;

    for (i = 0; i < XEN_UNIFIED_NR_DRIVERS; ++i) {
        if (priv->opened[i] && drivers[i]->domainSetSchedulerParameters) {
           ret = drivers[i]->domainSetSchedulerParameters(dom, params, nparams);
	   if (ret == 0)
	       return 0;
	}
    }

    return(-1);
}

1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
static int
xenUnifiedDomainBlockStats (virDomainPtr dom, const char *path,
                            struct _virDomainBlockStats *stats)
{
    GET_PRIVATE (dom->conn);

    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET])
        return xenHypervisorDomainBlockStats (dom, path, stats);

    xenUnifiedError (dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

static int
xenUnifiedDomainInterfaceStats (virDomainPtr dom, const char *path,
                                struct _virDomainInterfaceStats *stats)
{
    GET_PRIVATE (dom->conn);

    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET])
        return xenHypervisorDomainInterfaceStats (dom, path, stats);

    xenUnifiedError (dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

1176 1177 1178 1179 1180 1181 1182
static int
xenUnifiedNodeGetCellsFreeMemory (virConnectPtr conn, unsigned long long *freeMems,
                                  int startCell, int maxCells)
{
    GET_PRIVATE (conn);

    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET])
1183
        return xenHypervisorNodeGetCellsFreeMemory (conn, freeMems,
1184 1185 1186 1187 1188 1189
                                                    startCell, maxCells);

    xenUnifiedError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

1190 1191 1192 1193 1194 1195 1196 1197
static unsigned long long
xenUnifiedNodeGetFreeMemory (virConnectPtr conn)
{
    unsigned long long freeMem = 0;
    int ret;
    GET_PRIVATE (conn);

    if (priv->opened[XEN_UNIFIED_HYPERVISOR_OFFSET]) {
1198
        ret = xenHypervisorNodeGetCellsFreeMemory (conn, &freeMem,
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
                                                    -1, 1);
	if (ret != 1)
	    return (0);
	return(freeMem);
    }

    xenUnifiedError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return(0);
}

1209 1210
/*----- Register with libvirt.c, and initialise Xen drivers. -----*/

1211 1212 1213
#define HV_VERSION ((DOM0_INTERFACE_VERSION >> 24) * 1000000 +         \
                    ((DOM0_INTERFACE_VERSION >> 16) & 0xFF) * 1000 +   \
                    (DOM0_INTERFACE_VERSION & 0xFFFF))
1214 1215 1216

/* The interface which we export upwards to libvirt.c. */
static virDriver xenUnifiedDriver = {
1217
    .no = VIR_DRV_XEN_UNIFIED,
1218
    .name = "Xen",
1219
    .ver = HV_VERSION,
1220
    .probe 			= xenUnifiedProbe,
1221 1222
    .open 			= xenUnifiedOpen,
    .close 			= xenUnifiedClose,
1223
    .supports_feature   = xenUnifiedSupportsFeature,
1224 1225
    .type 			= xenUnifiedType,
    .version 			= xenUnifiedVersion,
1226
    .getHostname    = xenUnifiedGetHostname,
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    .getMaxVcpus 			= xenUnifiedGetMaxVcpus,
    .nodeGetInfo 			= xenUnifiedNodeGetInfo,
    .getCapabilities 		= xenUnifiedGetCapabilities,
    .listDomains 			= xenUnifiedListDomains,
    .numOfDomains 		= xenUnifiedNumOfDomains,
    .domainCreateLinux 		= xenUnifiedDomainCreateLinux,
    .domainLookupByID 		= xenUnifiedDomainLookupByID,
    .domainLookupByUUID 		= xenUnifiedDomainLookupByUUID,
    .domainLookupByName 		= xenUnifiedDomainLookupByName,
    .domainSuspend 		= xenUnifiedDomainSuspend,
    .domainResume 		= xenUnifiedDomainResume,
    .domainShutdown 		= xenUnifiedDomainShutdown,
    .domainReboot 		= xenUnifiedDomainReboot,
    .domainDestroy 		= xenUnifiedDomainDestroy,
    .domainGetOSType 		= xenUnifiedDomainGetOSType,
    .domainGetMaxMemory 		= xenUnifiedDomainGetMaxMemory,
    .domainSetMaxMemory 		= xenUnifiedDomainSetMaxMemory,
    .domainSetMemory 		= xenUnifiedDomainSetMemory,
    .domainGetInfo 		= xenUnifiedDomainGetInfo,
    .domainSave 			= xenUnifiedDomainSave,
    .domainRestore 		= xenUnifiedDomainRestore,
    .domainCoreDump 		= xenUnifiedDomainCoreDump,
    .domainSetVcpus 		= xenUnifiedDomainSetVcpus,
    .domainPinVcpu 		= xenUnifiedDomainPinVcpu,
    .domainGetVcpus 		= xenUnifiedDomainGetVcpus,
    .domainGetMaxVcpus 		= xenUnifiedDomainGetMaxVcpus,
    .domainDumpXML 		= xenUnifiedDomainDumpXML,
    .listDefinedDomains 		= xenUnifiedListDefinedDomains,
    .numOfDefinedDomains 		= xenUnifiedNumOfDefinedDomains,
    .domainCreate 		= xenUnifiedDomainCreate,
    .domainDefineXML 		= xenUnifiedDomainDefineXML,
    .domainUndefine 		= xenUnifiedDomainUndefine,
    .domainAttachDevice 		= xenUnifiedDomainAttachDevice,
    .domainDetachDevice 		= xenUnifiedDomainDetachDevice,
1261 1262 1263
    .domainGetSchedulerType	= xenUnifiedDomainGetSchedulerType,
    .domainGetSchedulerParameters	= xenUnifiedDomainGetSchedulerParameters,
    .domainSetSchedulerParameters	= xenUnifiedDomainSetSchedulerParameters,
1264 1265 1266
    .domainMigratePrepare		= xenUnifiedDomainMigratePrepare,
    .domainMigratePerform		= xenUnifiedDomainMigratePerform,
    .domainMigrateFinish		= xenUnifiedDomainMigrateFinish,
1267 1268
    .domainBlockStats	= xenUnifiedDomainBlockStats,
    .domainInterfaceStats = xenUnifiedDomainInterfaceStats,
1269
    .nodeGetCellsFreeMemory = xenUnifiedNodeGetCellsFreeMemory,
1270
    .getFreeMemory = xenUnifiedNodeGetFreeMemory,
1271 1272
};

1273 1274 1275 1276 1277 1278 1279
/**
 * xenUnifiedRegister:
 *
 * Register xen related drivers
 *
 * Returns the driver priority or -1 in case of error.
 */
1280 1281 1282
int
xenUnifiedRegister (void)
{
1283 1284 1285 1286 1287 1288
    /* Ignore failures here. */
    (void) xenHypervisorInit ();
    (void) xenProxyInit ();
    (void) xenDaemonInit ();
    (void) xenStoreInit ();
    (void) xenXMInit ();
1289

1290
    return virRegisterDriver (&xenUnifiedDriver);
1291 1292 1293
}

#endif /* WITH_XEN */
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307

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