capabilities.c 26.8 KB
Newer Older
1 2 3
/*
 * capabilities.c: hypervisor capabilities
 *
4
 * Copyright (C) 2006-2008, 2010-2011, 2013 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17
 * Copyright (C) 2006-2008 Daniel P. Berrange
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with this library.  If not, see
O
Osier Yang 已提交
19
 * <http://www.gnu.org/licenses/>.
20 21 22 23
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

24 25
#include <config.h>

26 27
#include <strings.h>

28
#include "capabilities.h"
29
#include "virbuffer.h"
30
#include "viralloc.h"
31
#include "viruuid.h"
32
#include "cpu_conf.h"
33
#include "virerror.h"
34 35 36 37


#define VIR_FROM_THIS VIR_FROM_CAPABILITIES

38 39
VIR_ENUM_DECL(virCapsHostPMTarget)
VIR_ENUM_IMPL(virCapsHostPMTarget, VIR_NODE_SUSPEND_TARGET_LAST,
40
              "suspend_mem", "suspend_disk", "suspend_hybrid");
41

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
static virClassPtr virCapsClass;
static void virCapabilitiesDispose(void *obj);

static int virCapabilitiesOnceInit(void)
{
    if (!(virCapsClass = virClassNew(virClassForObject(),
                                     "virCaps",
                                     sizeof(virCaps),
                                     virCapabilitiesDispose)))
        return -1;

    return 0;
}

VIR_ONCE_GLOBAL_INIT(virCapabilities)

58 59
/**
 * virCapabilitiesNew:
60
 * @hostarch: host machine architecture
61 62
 * @offlineMigrate: non-zero if offline migration is available
 * @liveMigrate: non-zero if live migration is available
63
 *
64 65 66
 * Allocate a new capabilities object
 */
virCapsPtr
67
virCapabilitiesNew(virArch hostarch,
68 69 70 71 72
                   int offlineMigrate,
                   int liveMigrate)
{
    virCapsPtr caps;

73 74 75 76
    if (virCapabilitiesInitialize() < 0)
        return NULL;

    if (!(caps = virObjectNew(virCapsClass)))
77
        return NULL;
78

79
    caps->host.arch = hostarch;
80 81 82 83 84 85
    caps->host.offlineMigrate = offlineMigrate;
    caps->host.liveMigrate = liveMigrate;

    return caps;
}

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
void
virCapabilitiesClearHostNUMACellCPUTopology(virCapsHostNUMACellCPUPtr cpus,
                                            size_t ncpus)
{
    size_t i;

    if (!cpus)
        return;

    for (i = 0; i < ncpus; i++) {
        virBitmapFree(cpus[i].siblings);
        cpus[i].siblings = NULL;
    }
}

101 102 103
static void
virCapabilitiesFreeHostNUMACell(virCapsHostNUMACellPtr cell)
{
104 105 106
    if (cell == NULL)
        return;

107 108
    virCapabilitiesClearHostNUMACellCPUTopology(cell->cpus, cell->ncpus);

109 110
    VIR_FREE(cell->cpus);
    VIR_FREE(cell);
111 112
}

113 114 115 116 117 118 119 120 121 122
static void
virCapabilitiesFreeGuestMachine(virCapsGuestMachinePtr machine)
{
    if (machine == NULL)
        return;
    VIR_FREE(machine->name);
    VIR_FREE(machine->canonical);
    VIR_FREE(machine);
}

123 124 125 126
static void
virCapabilitiesFreeGuestDomain(virCapsGuestDomainPtr dom)
{
    int i;
127 128 129
    if (dom == NULL)
        return;

130 131
    VIR_FREE(dom->info.emulator);
    VIR_FREE(dom->info.loader);
132
    for (i = 0; i < dom->info.nmachines; i++)
133
        virCapabilitiesFreeGuestMachine(dom->info.machines[i]);
134 135
    VIR_FREE(dom->info.machines);
    VIR_FREE(dom->type);
136

137
    VIR_FREE(dom);
138 139 140 141 142
}

static void
virCapabilitiesFreeGuestFeature(virCapsGuestFeaturePtr feature)
{
143 144
    if (feature == NULL)
        return;
145 146
    VIR_FREE(feature->name);
    VIR_FREE(feature);
147 148 149 150 151 152
}

static void
virCapabilitiesFreeGuest(virCapsGuestPtr guest)
{
    int i;
153 154 155
    if (guest == NULL)
        return;

156
    VIR_FREE(guest->ostype);
157

158 159
    VIR_FREE(guest->arch.defaultInfo.emulator);
    VIR_FREE(guest->arch.defaultInfo.loader);
160
    for (i = 0; i < guest->arch.defaultInfo.nmachines; i++)
161
        virCapabilitiesFreeGuestMachine(guest->arch.defaultInfo.machines[i]);
162
    VIR_FREE(guest->arch.defaultInfo.machines);
163

164
    for (i = 0; i < guest->arch.ndomains; i++)
165
        virCapabilitiesFreeGuestDomain(guest->arch.domains[i]);
166
    VIR_FREE(guest->arch.domains);
167

168
    for (i = 0; i < guest->nfeatures; i++)
169
        virCapabilitiesFreeGuestFeature(guest->features[i]);
170
    VIR_FREE(guest->features);
171

172
    VIR_FREE(guest);
173 174
}

175 176 177 178 179
void
virCapabilitiesFreeNUMAInfo(virCapsPtr caps)
{
    int i;

180
    for (i = 0; i < caps->host.nnumaCell; i++)
181 182
        virCapabilitiesFreeHostNUMACell(caps->host.numaCell[i]);
    VIR_FREE(caps->host.numaCell);
183
    caps->host.nnumaCell = 0;
184
}
185

186 187 188 189
static void
virCapabilitiesDispose(void *object)
{
    virCapsPtr caps = object;
190 191
    int i;

192
    for (i = 0; i < caps->nguests; i++)
193
        virCapabilitiesFreeGuest(caps->guests[i]);
194
    VIR_FREE(caps->guests);
195

196
    for (i = 0; i < caps->host.nfeatures; i++)
197 198
        VIR_FREE(caps->host.features[i]);
    VIR_FREE(caps->host.features);
199 200

    virCapabilitiesFreeNUMAInfo(caps);
201

202
    for (i = 0; i < caps->host.nmigrateTrans; i++)
203 204
        VIR_FREE(caps->host.migrateTrans[i]);
    VIR_FREE(caps->host.migrateTrans);
205

206 207 208 209 210 211
    for (i = 0; i < caps->host.nsecModels; i++) {
        VIR_FREE(caps->host.secModels[i].model);
        VIR_FREE(caps->host.secModels[i].doi);
    }
    VIR_FREE(caps->host.secModels);

212
    virCPUDefFree(caps->host.cpu);
213 214 215 216 217 218 219 220 221 222 223 224 225 226
}


/**
 * virCapabilitiesAddHostFeature:
 * @caps: capabilities to extend
 * @name: name of new feature
 *
 * Registers a new host CPU feature, eg 'pae', or 'vmx'
 */
int
virCapabilitiesAddHostFeature(virCapsPtr caps,
                              const char *name)
{
E
Eric Blake 已提交
227 228
    if (VIR_RESIZE_N(caps->host.features, caps->host.nfeatures_max,
                     caps->host.nfeatures, 1) < 0)
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
        return -1;

    if ((caps->host.features[caps->host.nfeatures] = strdup(name)) == NULL)
        return -1;
    caps->host.nfeatures++;

    return 0;
}

/**
 * virCapabilitiesAddHostMigrateTransport:
 * @caps: capabilities to extend
 * @name: name of migration transport
 *
 * Registers a new domain migration transport URI
 */
int
virCapabilitiesAddHostMigrateTransport(virCapsPtr caps,
                                       const char *name)
{
E
Eric Blake 已提交
249 250
    if (VIR_RESIZE_N(caps->host.migrateTrans, caps->host.nmigrateTrans_max,
                     caps->host.nmigrateTrans, 1) < 0)
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
        return -1;

    if ((caps->host.migrateTrans[caps->host.nmigrateTrans] = strdup(name)) == NULL)
        return -1;
    caps->host.nmigrateTrans++;

    return 0;
}


/**
 * virCapabilitiesAddHostNUMACell:
 * @caps: capabilities to extend
 * @num: ID number of NUMA cell
 * @ncpus: number of CPUs in cell
266
 * @cpus: array of CPU definition structures, the pointer is stolen
267 268 269 270 271 272 273 274
 *
 * Registers a new NUMA cell for a host, passing in a
 * array of CPU IDs belonging to the cell
 */
int
virCapabilitiesAddHostNUMACell(virCapsPtr caps,
                               int num,
                               int ncpus,
275
                               unsigned long long mem,
276
                               virCapsHostNUMACellCPUPtr cpus)
277
{
278
    virCapsHostNUMACellPtr cell;
279

E
Eric Blake 已提交
280 281
    if (VIR_RESIZE_N(caps->host.numaCell, caps->host.nnumaCell_max,
                     caps->host.nnumaCell, 1) < 0)
282 283
        return -1;

284
    if (VIR_ALLOC(cell) < 0)
285 286
        return -1;

287 288
    cell->ncpus = ncpus;
    cell->num = num;
289
    cell->mem = mem;
290
    cell->cpus = cpus;
291

E
Eric Blake 已提交
292
    caps->host.numaCell[caps->host.nnumaCell++] = cell;
293 294 295 296

    return 0;
}

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317

/**
 * virCapabilitiesSetHostCPU:
 * @caps: capabilities to extend
 * @cpu: CPU definition
 *
 * Sets host CPU specification
 */
int
virCapabilitiesSetHostCPU(virCapsPtr caps,
                          virCPUDefPtr cpu)
{
    if (cpu == NULL)
        return -1;

    caps->host.cpu = cpu;

    return 0;
}


318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * virCapabilitiesAllocMachines:
 * @machines: machine variants for emulator ('pc', or 'isapc', etc)
 * @nmachines: number of machine variants for emulator
 *
 * Allocate a table of virCapsGuestMachinePtr from the supplied table
 * of machine names.
 */
virCapsGuestMachinePtr *
virCapabilitiesAllocMachines(const char *const *names, int nnames)
{
    virCapsGuestMachinePtr *machines;
    int i;

    if (VIR_ALLOC_N(machines, nnames) < 0)
        return NULL;

    for (i = 0; i < nnames; i++) {
        if (VIR_ALLOC(machines[i]) < 0 ||
            !(machines[i]->name = strdup(names[i]))) {
            virCapabilitiesFreeMachines(machines, nnames);
            return NULL;
        }
    }

    return machines;
}

/**
 * virCapabilitiesFreeMachines:
 * @machines: table of vircapsGuestMachinePtr
 *
 * Free a table of virCapsGuestMachinePtr
 */
void
virCapabilitiesFreeMachines(virCapsGuestMachinePtr *machines,
                            int nmachines)
{
    int i;
    if (!machines)
        return;
    for (i = 0; i < nmachines && machines[i]; i++) {
        virCapabilitiesFreeGuestMachine(machines[i]);
        machines[i] = NULL;
    }
    VIR_FREE(machines);
}
365 366 367 368 369

/**
 * virCapabilitiesAddGuest:
 * @caps: capabilities to extend
 * @ostype: guest operating system type ('hvm' or 'xen')
370
 * @arch: guest CPU architecture
371 372 373 374 375 376 377 378 379 380 381 382 383
 * @wordsize: number of bits in CPU word
 * @emulator: path to default device emulator for arch/ostype
 * @loader: path to default BIOS loader for arch/ostype
 * @nmachines: number of machine variants for emulator
 * @machines: machine variants for emulator ('pc', or 'isapc', etc)
 *
 * Registers a new guest operating system. This should be
 * followed by registration of at least one domain for
 * running the guest
 */
virCapsGuestPtr
virCapabilitiesAddGuest(virCapsPtr caps,
                        const char *ostype,
384
                        virArch arch,
385 386 387
                        const char *emulator,
                        const char *loader,
                        int nmachines,
388
                        virCapsGuestMachinePtr *machines)
389
{
390
    virCapsGuestPtr guest;
391

392
    if (VIR_ALLOC(guest) < 0)
393 394 395 396 397
        goto no_memory;

    if ((guest->ostype = strdup(ostype)) == NULL)
        goto no_memory;

398 399
    guest->arch.id = arch;
    guest->arch.wordsize = virArchGetWordSize(arch);
400 401 402 403 404 405 406 407

    if (emulator &&
        (guest->arch.defaultInfo.emulator = strdup(emulator)) == NULL)
        goto no_memory;
    if (loader &&
        (guest->arch.defaultInfo.loader = strdup(loader)) == NULL)
        goto no_memory;

E
Eric Blake 已提交
408 409
    if (VIR_RESIZE_N(caps->guests, caps->nguests_max,
                     caps->nguests, 1) < 0)
410
        goto no_memory;
E
Eric Blake 已提交
411
    caps->guests[caps->nguests++] = guest;
412

D
Daniel P. Berrange 已提交
413 414 415 416 417
    if (nmachines) {
        guest->arch.defaultInfo.nmachines = nmachines;
        guest->arch.defaultInfo.machines = machines;
    }

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    return guest;

 no_memory:
    virCapabilitiesFreeGuest(guest);
    return NULL;
}


/**
 * virCapabilitiesAddGuestDomain:
 * @guest: guest to support
 * @hvtype: hypervisor type ('xen', 'qemu', 'kvm')
 * @emulator: specialized device emulator for domain
 * @loader: specialized BIOS loader for domain
 * @nmachines: number of machine variants for emulator
 * @machines: specialized machine variants for emulator
 *
 * Registers a virtual domain capable of running a
 * guest operating system
 */
virCapsGuestDomainPtr
virCapabilitiesAddGuestDomain(virCapsGuestPtr guest,
                              const char *hvtype,
                              const char *emulator,
                              const char *loader,
                              int nmachines,
444
                              virCapsGuestMachinePtr *machines)
445
{
446
    virCapsGuestDomainPtr dom;
447

448
    if (VIR_ALLOC(dom) < 0)
449 450 451 452 453 454 455 456 457 458 459 460
        goto no_memory;

    if ((dom->type = strdup(hvtype)) == NULL)
        goto no_memory;

    if (emulator &&
        (dom->info.emulator = strdup(emulator)) == NULL)
        goto no_memory;
    if (loader &&
        (dom->info.loader = strdup(loader)) == NULL)
        goto no_memory;

E
Eric Blake 已提交
461 462
    if (VIR_RESIZE_N(guest->arch.domains, guest->arch.ndomains_max,
                     guest->arch.ndomains, 1) < 0)
463 464 465 466
        goto no_memory;
    guest->arch.domains[guest->arch.ndomains] = dom;
    guest->arch.ndomains++;

D
Daniel P. Berrange 已提交
467 468 469 470
    if (nmachines) {
        dom->info.nmachines = nmachines;
        dom->info.machines = machines;
    }
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

    return dom;

 no_memory:
    virCapabilitiesFreeGuestDomain(dom);
    return NULL;
}


/**
 * virCapabilitiesAddGuestFeature:
 * @guest: guest to associate feature with
 * @name: name of feature ('pae', 'acpi', 'apic')
 * @defaultOn: non-zero if it defaults to on
 * @toggle: non-zero if its state can be toggled
 *
 * Registers a feature for a guest domain
 */
virCapsGuestFeaturePtr
virCapabilitiesAddGuestFeature(virCapsGuestPtr guest,
                               const char *name,
                               int defaultOn,
                               int toggle)
{
495
    virCapsGuestFeaturePtr feature;
496

497
    if (VIR_ALLOC(feature) < 0)
498 499 500 501 502 503 504
        goto no_memory;

    if ((feature->name = strdup(name)) == NULL)
        goto no_memory;
    feature->defaultOn = defaultOn;
    feature->toggle = toggle;

E
Eric Blake 已提交
505 506
    if (VIR_RESIZE_N(guest->features, guest->nfeatures_max,
                     guest->nfeatures, 1) < 0)
507
        goto no_memory;
E
Eric Blake 已提交
508
    guest->features[guest->nfeatures++] = feature;
509 510 511 512 513 514 515 516

    return feature;

 no_memory:
    virCapabilitiesFreeGuestFeature(feature);
    return NULL;
}

517 518 519
/**
 * virCapabilitiesSupportsGuestArch:
 * @caps: capabilities to query
520
 * @arch: Architecture to search for
521 522 523 524 525 526
 *
 * Returns non-zero if the capabilities support the
 * requested architecture
 */
extern int
virCapabilitiesSupportsGuestArch(virCapsPtr caps,
527
                                 virArch arch)
528 529
{
    int i;
530
    for (i = 0; i < caps->nguests; i++) {
531
        if (caps->guests[i]->arch.id == arch)
532 533 534 535 536
            return 1;
    }
    return 0;
}

537 538 539 540 541 542 543 544 545 546 547 548 549 550

/**
 * virCapabilitiesSupportsGuestOSType:
 * @caps: capabilities to query
 * @ostype: OS type to search for (eg 'hvm', 'xen')
 *
 * Returns non-zero if the capabilities support the
 * requested operating system type
 */
extern int
virCapabilitiesSupportsGuestOSType(virCapsPtr caps,
                                   const char *ostype)
{
    int i;
551
    for (i = 0; i < caps->nguests; i++) {
552 553 554 555 556 557 558
        if (STREQ(caps->guests[i]->ostype, ostype))
            return 1;
    }
    return 0;
}


559
/**
560
 * virCapabilitiesSupportsGuestOSTypeArch:
561 562
 * @caps: capabilities to query
 * @ostype: OS type to search for (eg 'hvm', 'xen')
563
 * @arch: Architecture to search for
564 565 566 567 568
 *
 * Returns non-zero if the capabilities support the
 * requested operating system type
 */
extern int
569 570
virCapabilitiesSupportsGuestOSTypeArch(virCapsPtr caps,
                                       const char *ostype,
571
                                       virArch arch)
572 573
{
    int i;
574
    for (i = 0; i < caps->nguests; i++) {
575
        if (STREQ(caps->guests[i]->ostype, ostype) &&
576
            caps->guests[i]->arch.id == arch)
577 578 579 580 581 582
            return 1;
    }
    return 0;
}


583 584 585 586 587 588 589 590
/**
 * virCapabilitiesDefaultGuestArch:
 * @caps: capabilities to query
 * @ostype: OS type to search for
 *
 * Returns the first architecture able to run the
 * requested operating system type
 */
591
extern virArch
592
virCapabilitiesDefaultGuestArch(virCapsPtr caps,
593 594
                                const char *ostype,
                                const char *domain)
595
{
596
    int i, j;
597 598

    /* First try to find one matching host arch */
599
    for (i = 0; i < caps->nguests; i++) {
600
        if (STREQ(caps->guests[i]->ostype, ostype)) {
601
            for (j = 0; j < caps->guests[i]->arch.ndomains; j++) {
602 603 604
                if (STREQ(caps->guests[i]->arch.domains[j]->type, domain) &&
                    caps->guests[i]->arch.id == caps->host.arch)
                    return caps->guests[i]->arch.id;
605 606
            }
        }
607
    }
608 609

    /* Otherwise find the first match */
610
    for (i = 0; i < caps->nguests; i++) {
611
        if (STREQ(caps->guests[i]->ostype, ostype)) {
612
            for (j = 0; j < caps->guests[i]->arch.ndomains; j++) {
613 614 615 616 617 618 619
                if (STREQ(caps->guests[i]->arch.domains[j]->type, domain))
                    return caps->guests[i]->arch.id;
            }
        }
    }

    return VIR_ARCH_NONE;
620 621 622 623 624 625 626
}

/**
 * virCapabilitiesDefaultGuestMachine:
 * @caps: capabilities to query
 * @ostype: OS type to search for
 * @arch: architecture to search for
627
 * @domain: domain type to search for
628 629
 *
 * Returns the first machine variant associated with
630 631
 * the requested operating system type, architecture
 * and domain type
632 633 634 635
 */
extern const char *
virCapabilitiesDefaultGuestMachine(virCapsPtr caps,
                                   const char *ostype,
636
                                   virArch arch,
637
                                   const char *domain)
638 639
{
    int i;
640

641
    for (i = 0; i < caps->nguests; i++) {
642 643 644
        virCapsGuestPtr guest = caps->guests[i];
        int j;

645 646
        if (!STREQ(guest->ostype, ostype) ||
            guest->arch.id != arch)
647 648 649
            continue;

        for (j = 0; j < guest->arch.ndomains; j++) {
650
            virCapsGuestDomainPtr dom = guest->arch.domains[j];
651 652 653 654 655 656 657 658 659 660 661

            if (!STREQ(dom->type, domain))
                continue;

            if (!dom->info.nmachines)
                break;

            return dom->info.machines[0]->name;
        }

        if (guest->arch.defaultInfo.nmachines)
662
            return caps->guests[i]->arch.defaultInfo.machines[0]->name;
663
    }
664

665 666 667 668
    return NULL;
}

/**
669
 * virCapabilitiesDefaultGuestEmulator:
670 671 672 673 674 675 676 677 678 679 680 681
 * @caps: capabilities to query
 * @ostype: OS type to search for ('xen', 'hvm')
 * @arch: architecture to search for
 * @domain: domain type ('xen', 'qemu', 'kvm')
 *
 * Returns the first emulator path associated with
 * the requested operating system type, architecture
 * and domain type
 */
extern const char *
virCapabilitiesDefaultGuestEmulator(virCapsPtr caps,
                                    const char *ostype,
682
                                    virArch arch,
683 684 685
                                    const char *domain)
{
    int i, j;
686
    for (i = 0; i < caps->nguests; i++) {
687 688
        char *emulator;
        if (STREQ(caps->guests[i]->ostype, ostype) &&
689
            caps->guests[i]->arch.id == arch) {
690
            emulator = caps->guests[i]->arch.defaultInfo.emulator;
691
            for (j = 0; j < caps->guests[i]->arch.ndomains; j++) {
692 693 694 695 696 697 698 699 700 701 702
                if (STREQ(caps->guests[i]->arch.domains[j]->type, domain)) {
                    if (caps->guests[i]->arch.domains[j]->info.emulator)
                        emulator = caps->guests[i]->arch.domains[j]->info.emulator;
                }
            }
            return emulator;
        }
    }
    return NULL;
}

703
static int
704 705 706 707 708 709
virCapabilitiesFormatNUMATopology(virBufferPtr xml,
                                  size_t ncells,
                                  virCapsHostNUMACellPtr *cells)
{
    int i;
    int j;
710
    char *siblings;
711 712 713 714 715

    virBufferAddLit(xml, "    <topology>\n");
    virBufferAsprintf(xml, "      <cells num='%zu'>\n", ncells);
    for (i = 0; i < ncells; i++) {
        virBufferAsprintf(xml, "        <cell id='%d'>\n", cells[i]->num);
716 717 718 719 720 721 722

        /* Print out the numacell memory total if it is available */
        if (cells[i]->mem)
            virBufferAsprintf(xml,
                              "          <memory unit='KiB'>%llu</memory>\n",
                              cells[i]->mem);

723
        virBufferAsprintf(xml, "          <cpus num='%d'>\n", cells[i]->ncpus);
724 725
        for (j = 0; j < cells[i]->ncpus; j++) {
            virBufferAsprintf(xml, "            <cpu id='%d'",
726
                              cells[i]->cpus[j].id);
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

            if (cells[i]->cpus[j].siblings) {
                if (!(siblings = virBitmapFormat(cells[i]->cpus[j].siblings))) {
                    virReportOOMError();
                    return -1;
                }

                virBufferAsprintf(xml,
                                  " socket_id='%d' core_id='%d' siblings='%s'",
                                  cells[i]->cpus[j].socket_id,
                                  cells[i]->cpus[j].core_id,
                                  siblings);
                VIR_FREE(siblings);
            }
            virBufferAddLit(xml, "/>\n");
        }

744 745 746 747 748
        virBufferAddLit(xml, "          </cpus>\n");
        virBufferAddLit(xml, "        </cell>\n");
    }
    virBufferAddLit(xml, "      </cells>\n");
    virBufferAddLit(xml, "    </topology>\n");
749 750

    return 0;
751
}
752 753 754 755 756 757 758 759 760 761 762 763

/**
 * virCapabilitiesFormatXML:
 * @caps: capabilities to format
 *
 * Convert the capabilities object into an XML representation
 *
 * Returns the XML document as a string
 */
char *
virCapabilitiesFormatXML(virCapsPtr caps)
{
764
    virBuffer xml = VIR_BUFFER_INITIALIZER;
765
    int i, j, k;
766
    char host_uuid[VIR_UUID_STRING_BUFLEN];
767

768 769
    virBufferAddLit(&xml, "<capabilities>\n\n");
    virBufferAddLit(&xml, "  <host>\n");
770 771
    if (virUUIDIsValid(caps->host.host_uuid)) {
        virUUIDFormat(caps->host.host_uuid, host_uuid);
772
        virBufferAsprintf(&xml,"    <uuid>%s</uuid>\n", host_uuid);
773
    }
774
    virBufferAddLit(&xml, "    <cpu>\n");
775 776 777
    if (caps->host.arch)
        virBufferAsprintf(&xml, "      <arch>%s</arch>\n",
                          virArchToString(caps->host.arch));
778 779

    if (caps->host.nfeatures) {
780
        virBufferAddLit(&xml, "      <features>\n");
781
        for (i = 0; i < caps->host.nfeatures; i++) {
782
            virBufferAsprintf(&xml, "        <%s/>\n",
783
                              caps->host.features[i]);
784
        }
785
        virBufferAddLit(&xml, "      </features>\n");
786
    }
787

788
    virBufferAdjustIndent(&xml, 6);
789
    virCPUDefFormatBuf(&xml, caps->host.cpu, 0);
790
    virBufferAdjustIndent(&xml, -6);
791

792
    virBufferAddLit(&xml, "    </cpu>\n");
793

794 795 796 797 798 799 800 801 802 803
    /* The PM query was successful. */
    if (caps->host.powerMgmt) {
        /* The host supports some PM features. */
        unsigned int pm = caps->host.powerMgmt;
        virBufferAddLit(&xml, "    <power_management>\n");
        while (pm) {
            int bit = ffs(pm) - 1;
            virBufferAsprintf(&xml, "      <%s/>\n",
                              virCapsHostPMTargetTypeToString(bit));
            pm &= ~(1U << bit);
804
        }
805 806 807 808
        virBufferAddLit(&xml, "    </power_management>\n");
    } else {
        /* The host does not support any PM feature. */
        virBufferAddLit(&xml, "    <power_management/>\n");
809 810
    }

811
    if (caps->host.offlineMigrate) {
812 813 814
        virBufferAddLit(&xml, "    <migration_features>\n");
        if (caps->host.liveMigrate)
            virBufferAddLit(&xml, "      <live/>\n");
815
        if (caps->host.nmigrateTrans) {
816
            virBufferAddLit(&xml, "      <uri_transports>\n");
817
            for (i = 0; i < caps->host.nmigrateTrans; i++) {
818
                virBufferAsprintf(&xml, "        <uri_transport>%s</uri_transport>\n",
819
                                      caps->host.migrateTrans[i]);
820
            }
821
            virBufferAddLit(&xml, "      </uri_transports>\n");
822
        }
823
        virBufferAddLit(&xml, "    </migration_features>\n");
824 825
    }

826
    if (caps->host.nnumaCell &&
827
        virCapabilitiesFormatNUMATopology(&xml, caps->host.nnumaCell,
828 829
                                          caps->host.numaCell) < 0)
        return NULL;
830

831
    for (i = 0; i < caps->host.nsecModels; i++) {
832
        virBufferAddLit(&xml, "    <secmodel>\n");
833
        virBufferAsprintf(&xml, "      <model>%s</model>\n",
834
                          caps->host.secModels[i].model);
835
        virBufferAsprintf(&xml, "      <doi>%s</doi>\n",
836
                          caps->host.secModels[i].doi);
837 838 839
        virBufferAddLit(&xml, "    </secmodel>\n");
    }

840
    virBufferAddLit(&xml, "  </host>\n\n");
841 842


843
    for (i = 0; i < caps->nguests; i++) {
844
        virBufferAddLit(&xml, "  <guest>\n");
845
        virBufferAsprintf(&xml, "    <os_type>%s</os_type>\n",
846
                          caps->guests[i]->ostype);
847 848 849
        if (caps->guests[i]->arch.id)
            virBufferAsprintf(&xml, "    <arch name='%s'>\n",
                              virArchToString(caps->guests[i]->arch.id));
850
        virBufferAsprintf(&xml, "      <wordsize>%d</wordsize>\n",
851 852
                          caps->guests[i]->arch.wordsize);
        if (caps->guests[i]->arch.defaultInfo.emulator)
853
            virBufferAsprintf(&xml, "      <emulator>%s</emulator>\n",
854 855
                              caps->guests[i]->arch.defaultInfo.emulator);
            if (caps->guests[i]->arch.defaultInfo.loader)
856
                virBufferAsprintf(&xml, "      <loader>%s</loader>\n",
857
                                  caps->guests[i]->arch.defaultInfo.loader);
858

859
        for (j = 0; j < caps->guests[i]->arch.defaultInfo.nmachines; j++) {
860 861 862
            virCapsGuestMachinePtr machine = caps->guests[i]->arch.defaultInfo.machines[j];
            virBufferAddLit(&xml, "      <machine");
            if (machine->canonical)
863 864
                virBufferAsprintf(&xml, " canonical='%s'", machine->canonical);
            virBufferAsprintf(&xml, ">%s</machine>\n", machine->name);
865 866
        }

867
        for (j = 0; j < caps->guests[i]->arch.ndomains; j++) {
868
            virBufferAsprintf(&xml, "      <domain type='%s'>\n",
869 870
                                  caps->guests[i]->arch.domains[j]->type);
            if (caps->guests[i]->arch.domains[j]->info.emulator)
871
                virBufferAsprintf(&xml, "        <emulator>%s</emulator>\n",
872 873
                                  caps->guests[i]->arch.domains[j]->info.emulator);
            if (caps->guests[i]->arch.domains[j]->info.loader)
874
                virBufferAsprintf(&xml, "        <loader>%s</loader>\n",
875
                                  caps->guests[i]->arch.domains[j]->info.loader);
876

877
            for (k = 0; k < caps->guests[i]->arch.domains[j]->info.nmachines; k++) {
878
                virCapsGuestMachinePtr machine = caps->guests[i]->arch.domains[j]->info.machines[k];
879
                virBufferAddLit(&xml, "        <machine");
880
                if (machine->canonical)
881 882
                    virBufferAsprintf(&xml, " canonical='%s'", machine->canonical);
                virBufferAsprintf(&xml, ">%s</machine>\n", machine->name);
883
            }
884
            virBufferAddLit(&xml, "      </domain>\n");
885 886
        }

887
        virBufferAddLit(&xml, "    </arch>\n");
888 889

        if (caps->guests[i]->nfeatures) {
890
            virBufferAddLit(&xml, "    <features>\n");
891

892
            for (j = 0; j < caps->guests[i]->nfeatures; j++) {
893 894
                if (STREQ(caps->guests[i]->features[j]->name, "pae") ||
                    STREQ(caps->guests[i]->features[j]->name, "nonpae") ||
895
                    STREQ(caps->guests[i]->features[j]->name, "ia64_be") ||
896 897
                    STREQ(caps->guests[i]->features[j]->name, "cpuselection") ||
                    STREQ(caps->guests[i]->features[j]->name, "deviceboot")) {
898
                    virBufferAsprintf(&xml, "      <%s/>\n",
899
                                      caps->guests[i]->features[j]->name);
900
                } else {
901
                    virBufferAsprintf(&xml, "      <%s default='%s' toggle='%s'/>\n",
902 903 904
                                      caps->guests[i]->features[j]->name,
                                      caps->guests[i]->features[j]->defaultOn ? "on" : "off",
                                      caps->guests[i]->features[j]->toggle ? "yes" : "no");
905 906 907
                }
            }

908
            virBufferAddLit(&xml, "    </features>\n");
909 910
        }

911
        virBufferAddLit(&xml, "  </guest>\n\n");
912 913
    }

914
    virBufferAddLit(&xml, "</capabilities>\n");
915

916 917
    if (virBufferError(&xml)) {
        virBufferFreeAndReset(&xml);
918
        return NULL;
919
    }
920

921
    return virBufferContentAndReset(&xml);
922
}