domain_conf.h 77.2 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
4
 * Copyright (C) 2006-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 24
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#ifndef __DOMAIN_CONF_H
25
# define __DOMAIN_CONF_H
26

27 28 29
# include <libxml/parser.h>
# include <libxml/tree.h>
# include <libxml/xpath.h>
30

31 32 33 34
# include "internal.h"
# include "capabilities.h"
# include "storage_encryption_conf.h"
# include "cpu_conf.h"
35
# include "virutil.h"
36
# include "virthread.h"
37
# include "virhash.h"
38
# include "virsocketaddr.h"
39
# include "nwfilter_params.h"
40
# include "virnetdevmacvlan.h"
41
# include "virsysinfo.h"
42
# include "virnetdevvportprofile.h"
A
Ansis Atteka 已提交
43
# include "virnetdevopenvswitch.h"
44
# include "virnetdevbandwidth.h"
45
# include "virnetdevvlan.h"
46
# include "virobject.h"
47
# include "device_conf.h"
48
# include "virbitmap.h"
49
# include "virstoragefile.h"
G
Gao feng 已提交
50
# include "virnuma.h"
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/* forward declarations of all device types, required by
 * virDomainDeviceDef
 */
typedef struct _virDomainDiskDef virDomainDiskDef;
typedef virDomainDiskDef *virDomainDiskDefPtr;

typedef struct _virDomainControllerDef virDomainControllerDef;
typedef virDomainControllerDef *virDomainControllerDefPtr;

typedef struct _virDomainLeaseDef virDomainLeaseDef;
typedef virDomainLeaseDef *virDomainLeaseDefPtr;

typedef struct _virDomainFSDef virDomainFSDef;
typedef virDomainFSDef *virDomainFSDefPtr;

typedef struct _virDomainNetDef virDomainNetDef;
typedef virDomainNetDef *virDomainNetDefPtr;

typedef struct _virDomainInputDef virDomainInputDef;
typedef virDomainInputDef *virDomainInputDefPtr;

73 74 75
typedef struct _virDomainSoundCodecDef virDomainSoundCodecDef;
typedef virDomainSoundCodecDef *virDomainSoundCodecDefPtr;

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
typedef struct _virDomainSoundDef virDomainSoundDef;
typedef virDomainSoundDef *virDomainSoundDefPtr;

typedef struct _virDomainVideoDef virDomainVideoDef;
typedef virDomainVideoDef *virDomainVideoDefPtr;

typedef struct _virDomainHostdevDef virDomainHostdevDef;
typedef virDomainHostdevDef *virDomainHostdevDefPtr;

typedef struct _virDomainWatchdogDef virDomainWatchdogDef;
typedef virDomainWatchdogDef *virDomainWatchdogDefPtr;

typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;

typedef struct _virDomainHubDef virDomainHubDef;
typedef virDomainHubDef *virDomainHubDefPtr;

typedef struct _virDomainRedirdevDef virDomainRedirdevDef;
typedef virDomainRedirdevDef *virDomainRedirdevDefPtr;

97 98 99 100 101 102
typedef struct _virDomainRedirFilterUsbDevDef virDomainRedirFilterUsbDevDef;
typedef virDomainRedirFilterUsbDevDef *virDomainRedirFilterUsbDevDefPtr;

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

103 104 105 106 107 108 109 110 111
typedef struct _virDomainSmartcardDef virDomainSmartcardDef;
typedef virDomainSmartcardDef *virDomainSmartcardDefPtr;

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

112 113 114 115 116 117
typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

118 119 120
typedef struct _virDomainRNGDef virDomainRNGDef;
typedef virDomainRNGDef *virDomainRNGDefPtr;

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
/* Flags for the 'type' field in virDomainDeviceDef */
typedef enum {
    VIR_DOMAIN_DEVICE_NONE = 0,
    VIR_DOMAIN_DEVICE_DISK,
    VIR_DOMAIN_DEVICE_LEASE,
    VIR_DOMAIN_DEVICE_FS,
    VIR_DOMAIN_DEVICE_NET,
    VIR_DOMAIN_DEVICE_INPUT,
    VIR_DOMAIN_DEVICE_SOUND,
    VIR_DOMAIN_DEVICE_VIDEO,
    VIR_DOMAIN_DEVICE_HOSTDEV,
    VIR_DOMAIN_DEVICE_WATCHDOG,
    VIR_DOMAIN_DEVICE_CONTROLLER,
    VIR_DOMAIN_DEVICE_GRAPHICS,
    VIR_DOMAIN_DEVICE_HUB,
    VIR_DOMAIN_DEVICE_REDIRDEV,
    VIR_DOMAIN_DEVICE_SMARTCARD,
    VIR_DOMAIN_DEVICE_CHR,
    VIR_DOMAIN_DEVICE_MEMBALLOON,
140
    VIR_DOMAIN_DEVICE_RNG,
141

142
    VIR_DOMAIN_DEVICE_LAST
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
} virDomainDeviceType;

typedef struct _virDomainDeviceDef virDomainDeviceDef;
typedef virDomainDeviceDef *virDomainDeviceDefPtr;
struct _virDomainDeviceDef {
    int type; /* enum virDomainDeviceType */
    union {
        virDomainDiskDefPtr disk;
        virDomainControllerDefPtr controller;
        virDomainLeaseDefPtr lease;
        virDomainFSDefPtr fs;
        virDomainNetDefPtr net;
        virDomainInputDefPtr input;
        virDomainSoundDefPtr sound;
        virDomainVideoDefPtr video;
        virDomainHostdevDefPtr hostdev;
        virDomainWatchdogDefPtr watchdog;
        virDomainGraphicsDefPtr graphics;
        virDomainHubDefPtr hub;
        virDomainRedirdevDefPtr redirdev;
        virDomainSmartcardDefPtr smartcard;
        virDomainChrDefPtr chr;
        virDomainMemballoonDefPtr memballoon;
166
        virDomainRNGDefPtr rng;
167 168 169
    } data;
};

170 171 172 173 174 175 176 177 178 179 180 181 182
/* Different types of hypervisor */
/* NB: Keep in sync with virDomainVirtTypeToString impl */
enum virDomainVirtType {
    VIR_DOMAIN_VIRT_QEMU,
    VIR_DOMAIN_VIRT_KQEMU,
    VIR_DOMAIN_VIRT_KVM,
    VIR_DOMAIN_VIRT_XEN,
    VIR_DOMAIN_VIRT_LXC,
    VIR_DOMAIN_VIRT_UML,
    VIR_DOMAIN_VIRT_OPENVZ,
    VIR_DOMAIN_VIRT_TEST,
    VIR_DOMAIN_VIRT_VMWARE,
    VIR_DOMAIN_VIRT_HYPERV,
183
    VIR_DOMAIN_VIRT_VBOX,
184
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
185
    VIR_DOMAIN_VIRT_PARALLELS,
186

187
    VIR_DOMAIN_VIRT_LAST
188 189
};

190 191 192
enum virDomainDeviceAddressType {
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_NONE,
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_PCI,
193
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_DRIVE,
194
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
195
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCID,
196
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_USB,
197
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_SPAPRVIO,
198
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_S390,
199
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCW,
200 201 202 203

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

204 205 206 207 208 209 210 211
enum virDomainPciRombarMode {
    VIR_DOMAIN_PCI_ROMBAR_DEFAULT = 0,
    VIR_DOMAIN_PCI_ROMBAR_ON,
    VIR_DOMAIN_PCI_ROMBAR_OFF,

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

212 213 214 215 216
typedef struct _virDomainDeviceDriveAddress virDomainDeviceDriveAddress;
typedef virDomainDeviceDriveAddress *virDomainDeviceDriveAddressPtr;
struct _virDomainDeviceDriveAddress {
    unsigned int controller;
    unsigned int bus;
217
    unsigned int target;
218 219 220
    unsigned int unit;
};

221 222 223 224 225
typedef struct _virDomainDeviceVirtioSerialAddress virDomainDeviceVirtioSerialAddress;
typedef virDomainDeviceVirtioSerialAddress *virDomainDeviceVirtioSerialAddressPtr;
struct _virDomainDeviceVirtioSerialAddress {
    unsigned int controller;
    unsigned int bus;
226
    unsigned int port;
227 228
};

229 230 231 232 233 234 235 236 237 238 239 240 241
# define VIR_DOMAIN_DEVICE_CCW_MAX_CSSID    254
# define VIR_DOMAIN_DEVICE_CCW_MAX_SSID       3
# define VIR_DOMAIN_DEVICE_CCW_MAX_DEVNO  65535

typedef struct _virDomainDeviceCCWAddress virDomainDeviceCCWAddress;
typedef virDomainDeviceCCWAddress *virDomainDeviceCCWAddressPtr;
struct _virDomainDeviceCCWAddress {
    unsigned int cssid;
    unsigned int ssid;
    unsigned int devno;
    bool         assigned;
};

E
Eric Blake 已提交
242 243 244 245 246 247 248
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

249 250 251 252
typedef struct _virDomainDeviceUSBAddress virDomainDeviceUSBAddress;
typedef virDomainDeviceUSBAddress *virDomainDeviceUSBAddressPtr;
struct _virDomainDeviceUSBAddress {
    unsigned int bus;
253
    char *port;
254 255
};

256 257 258 259 260 261 262
typedef struct _virDomainDeviceSpaprVioAddress virDomainDeviceSpaprVioAddress;
typedef virDomainDeviceSpaprVioAddress *virDomainDeviceSpaprVioAddressPtr;
struct _virDomainDeviceSpaprVioAddress {
    unsigned long long reg;
    bool has_reg;
};

263 264 265 266 267 268 269 270 271 272 273 274 275
enum virDomainControllerMaster {
    VIR_DOMAIN_CONTROLLER_MASTER_NONE,
    VIR_DOMAIN_CONTROLLER_MASTER_USB,

    VIR_DOMAIN_CONTROLLER_MASTER_LAST
};

typedef struct _virDomainDeviceUSBMaster virDomainDeviceUSBMaster;
typedef virDomainDeviceUSBMaster *virDomainDeviceUSBMasterPtr;
struct _virDomainDeviceUSBMaster {
    unsigned int startport;
};

276 277 278
typedef struct _virDomainDeviceInfo virDomainDeviceInfo;
typedef virDomainDeviceInfo *virDomainDeviceInfoPtr;
struct _virDomainDeviceInfo {
279 280 281 282
    /* If adding to this struct, ensure that
     * virDomainDeviceInfoIsSet() is updated
     * to consider the new fields
     */
D
Daniel P. Berrange 已提交
283
    char *alias;
284 285
    int type;
    union {
286
        virDevicePCIAddress pci;
287
        virDomainDeviceDriveAddress drive;
288
        virDomainDeviceVirtioSerialAddress vioserial;
E
Eric Blake 已提交
289
        virDomainDeviceCcidAddress ccid;
290
        virDomainDeviceUSBAddress usb;
291
        virDomainDeviceSpaprVioAddress spaprvio;
292
        virDomainDeviceCCWAddress ccw;
293
    } addr;
294 295 296 297
    int mastertype;
    union {
        virDomainDeviceUSBMaster usb;
    } master;
298 299
    /* rombar and romfile are only used for pci hostdev and network
     * devices. */
300
    int rombar;         /* enum virDomainPciRombarMode */
301
    char *romfile;
302 303
    /* bootIndex is only used for disk, network interface, hostdev
     * and redirdev devices */
304
    int bootIndex;
305 306
};

E
Eric Blake 已提交
307
enum virDomainSeclabelType {
308 309
    VIR_DOMAIN_SECLABEL_DEFAULT,
    VIR_DOMAIN_SECLABEL_NONE,
E
Eric Blake 已提交
310 311 312
    VIR_DOMAIN_SECLABEL_DYNAMIC,
    VIR_DOMAIN_SECLABEL_STATIC,

313
    VIR_DOMAIN_SECLABEL_LAST
E
Eric Blake 已提交
314 315 316 317 318 319 320 321 322 323 324 325
};

/* Security configuration for domain */
typedef struct _virSecurityLabelDef virSecurityLabelDef;
typedef virSecurityLabelDef *virSecurityLabelDefPtr;
struct _virSecurityLabelDef {
    char *model;        /* name of security model */
    char *label;        /* security label string */
    char *imagelabel;   /* security image label string */
    char *baselabel;    /* base name of label string */
    int type;           /* virDomainSeclabelType */
    bool norelabel;
326
    bool implicit;      /* true if seclabel is auto-added */
E
Eric Blake 已提交
327 328
};

329 330 331 332 333

/* Security configuration for domain */
typedef struct _virSecurityDeviceLabelDef virSecurityDeviceLabelDef;
typedef virSecurityDeviceLabelDef *virSecurityDeviceLabelDefPtr;
struct _virSecurityDeviceLabelDef {
334
    char *model;
335 336 337 338 339
    char *label;        /* image label string */
    bool norelabel;
};


340 341 342 343 344 345 346 347
typedef struct _virDomainHostdevOrigStates virDomainHostdevOrigStates;
typedef virDomainHostdevOrigStates *virDomainHostdevOrigStatesPtr;
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
348
            bool unbind_from_stub;
349 350 351 352

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
353
            bool remove_slot;
354 355 356 357

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
358
            bool reprobe;
359 360 361 362 363 364
        } pci;

        /* Perhaps 'usb' in future */
    } states;
};

365 366 367 368 369 370 371
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

372

373 374 375 376
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

377
    VIR_DOMAIN_HOSTDEV_MODE_LAST
378 379 380 381 382 383 384 385 386
};

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

387 388 389 390

typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys;
typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr;
struct _virDomainHostdevSubsys {
391
    int type; /* enum virDomainHostdevSubsysType */
392 393
    union {
        struct {
394 395
            bool autoAddress; /* bus/device were filled automatically based
                                 on vedor/product */
396 397 398 399 400 401
            unsigned bus;
            unsigned device;

            unsigned vendor;
            unsigned product;
        } usb;
402
        virDevicePCIAddress pci; /* host address */
403 404 405
    } u;
};

406 407 408 409

enum virDomainHostdevCapsType {
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,
410
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_NET,
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_LAST
};

typedef struct _virDomainHostdevCaps virDomainHostdevCaps;
typedef virDomainHostdevCaps *virDomainHostdevCapsPtr;
struct _virDomainHostdevCaps {
    int type; /* enum virDOmainHostdevCapsType */
    union {
        struct {
            char *block;
        } storage;
        struct {
            char *chardev;
        } misc;
426 427 428
        struct {
            char *iface;
        } net;
429 430 431 432
    } u;
};


433 434
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
435
    virDomainDeviceDef parent; /* higher level Def containing this */
436
    int mode; /* enum virDomainHostdevMode */
437
    int startupPolicy; /* enum virDomainStartupPolicy */
438
    bool managed;
439
    bool missing;
440
    union {
441
        virDomainHostdevSubsys subsys;
442
        virDomainHostdevCaps caps;
443 444
    } source;
    virDomainHostdevOrigStates origstates;
445
    virDomainDeviceInfoPtr info; /* Guest address */
446 447
};

448 449 450 451
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
452
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
453
    VIR_DOMAIN_DISK_TYPE_NETWORK,
454
    VIR_DOMAIN_DISK_TYPE_VOLUME,
455 456 457 458 459 460 461 462 463

    VIR_DOMAIN_DISK_TYPE_LAST
};

/* Three types of disk frontend */
enum virDomainDiskDevice {
    VIR_DOMAIN_DISK_DEVICE_DISK,
    VIR_DOMAIN_DISK_DEVICE_CDROM,
    VIR_DOMAIN_DISK_DEVICE_FLOPPY,
464
    VIR_DOMAIN_DISK_DEVICE_LUN,
465 466 467 468 469 470 471 472 473 474

    VIR_DOMAIN_DISK_DEVICE_LAST
};

enum virDomainDiskBus {
    VIR_DOMAIN_DISK_BUS_IDE,
    VIR_DOMAIN_DISK_BUS_FDC,
    VIR_DOMAIN_DISK_BUS_SCSI,
    VIR_DOMAIN_DISK_BUS_VIRTIO,
    VIR_DOMAIN_DISK_BUS_XEN,
475
    VIR_DOMAIN_DISK_BUS_USB,
476
    VIR_DOMAIN_DISK_BUS_UML,
477
    VIR_DOMAIN_DISK_BUS_SATA,
478 479 480 481

    VIR_DOMAIN_DISK_BUS_LAST
};

482 483 484 485 486
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
487
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
488
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
489 490 491 492

    VIR_DOMAIN_DISK_CACHE_LAST
};

493 494 495
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
496
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
497
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
498
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
499 500 501 502

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
503 504 505 506
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,
507
    VIR_DOMAIN_DISK_PROTOCOL_GLUSTER,
508
    VIR_DOMAIN_DISK_PROTOCOL_ISCSI,
M
MORITA Kazutaka 已提交
509 510 511 512

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

513 514 515 516 517 518 519 520
enum virDomainDiskProtocolTransport {
    VIR_DOMAIN_DISK_PROTO_TRANS_TCP,
    VIR_DOMAIN_DISK_PROTO_TRANS_UNIX,
    VIR_DOMAIN_DISK_PROTO_TRANS_RDMA,

    VIR_DOMAIN_DISK_PROTO_TRANS_LAST
};

521 522 523 524 525 526 527
enum virDomainDiskTray {
    VIR_DOMAIN_DISK_TRAY_CLOSED,
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
};

J
J.B. Joret 已提交
528 529 530 531 532 533 534 535 536
enum  virDomainDiskGeometryTrans {
    VIR_DOMAIN_DISK_TRANS_DEFAULT = 0,
    VIR_DOMAIN_DISK_TRANS_NONE,
    VIR_DOMAIN_DISK_TRANS_AUTO,
    VIR_DOMAIN_DISK_TRANS_LBA,

    VIR_DOMAIN_DISK_TRANS_LAST
};

M
MORITA Kazutaka 已提交
537 538 539 540 541
typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
542 543
    int transport; /* enum virDomainDiskProtocolTransport */
    char *socket;  /* path to unix socket */
M
MORITA Kazutaka 已提交
544 545
};

M
Matthias Dahl 已提交
546 547 548 549 550 551 552 553
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

554 555 556 557 558 559 560 561
enum virDomainIoEventFd {
    VIR_DOMAIN_IO_EVENT_FD_DEFAULT = 0,
    VIR_DOMAIN_IO_EVENT_FD_ON,
    VIR_DOMAIN_IO_EVENT_FD_OFF,

    VIR_DOMAIN_IO_EVENT_FD_LAST
};

562 563 564 565 566 567 568 569
enum virDomainVirtioEventIdx {
    VIR_DOMAIN_VIRTIO_EVENT_IDX_DEFAULT = 0,
    VIR_DOMAIN_VIRTIO_EVENT_IDX_ON,
    VIR_DOMAIN_VIRTIO_EVENT_IDX_OFF,

    VIR_DOMAIN_VIRTIO_EVENT_IDX_LAST
};

O
Osier Yang 已提交
570 571 572 573 574 575 576 577
enum virDomainDiskCopyOnRead {
    VIR_DOMAIN_DISK_COPY_ON_READ_DEFAULT = 0,
    VIR_DOMAIN_DISK_COPY_ON_READ_ON,
    VIR_DOMAIN_DISK_COPY_ON_READ_OFF,

    VIR_DOMAIN_DISK_COPY_ON_READ_LAST
};

578 579 580 581 582 583 584 585 586
enum virDomainStartupPolicy {
    VIR_DOMAIN_STARTUP_POLICY_DEFAULT = 0,
    VIR_DOMAIN_STARTUP_POLICY_MANDATORY,
    VIR_DOMAIN_STARTUP_POLICY_REQUISITE,
    VIR_DOMAIN_STARTUP_POLICY_OPTIONAL,

    VIR_DOMAIN_STARTUP_POLICY_LAST
};

587 588 589 590 591 592 593 594
enum virDomainDiskSecretType {
    VIR_DOMAIN_DISK_SECRET_TYPE_NONE,
    VIR_DOMAIN_DISK_SECRET_TYPE_UUID,
    VIR_DOMAIN_DISK_SECRET_TYPE_USAGE,

    VIR_DOMAIN_DISK_SECRET_TYPE_LAST
};

O
Osier Yang 已提交
595 596 597 598 599 600 601 602
enum virDomainDiskSGIO {
    VIR_DOMAIN_DISK_SGIO_DEFAULT = 0,
    VIR_DOMAIN_DISK_SGIO_FILTERED,
    VIR_DOMAIN_DISK_SGIO_UNFILTERED,

    VIR_DOMAIN_DISK_SGIO_LAST
};

L
Lei Li 已提交
603 604 605 606 607 608 609 610 611 612 613
typedef struct _virDomainBlockIoTuneInfo virDomainBlockIoTuneInfo;
struct _virDomainBlockIoTuneInfo {
    unsigned long long total_bytes_sec;
    unsigned long long read_bytes_sec;
    unsigned long long write_bytes_sec;
    unsigned long long total_iops_sec;
    unsigned long long read_iops_sec;
    unsigned long long write_iops_sec;
};
typedef virDomainBlockIoTuneInfo *virDomainBlockIoTuneInfoPtr;

614 615 616 617
typedef struct _virDomainDiskSourcePoolDef virDomainDiskSourcePoolDef;
struct _virDomainDiskSourcePoolDef {
    char *pool; /* pool name */
    char *volume; /* volume name */
618
    int voltype; /* enum virStorageVolType, internal only */
619 620 621
};
typedef virDomainDiskSourcePoolDef *virDomainDiskSourcePoolDefPtr;

622 623 624 625 626 627 628
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
629
    int tray_status;
M
MORITA Kazutaka 已提交
630
    int protocol;
631
    size_t nhosts;
M
MORITA Kazutaka 已提交
632
    virDomainDiskHostDefPtr hosts;
633
    virDomainDiskSourcePoolDefPtr srcpool;
634 635 636 637 638 639 640 641
    struct {
        char *username;
        int secretType; /* enum virDomainDiskSecretType */
        union {
            unsigned char uuid[VIR_UUID_BUFLEN];
            char *usage;
        } secret;
    } auth;
642
    char *driverName;
643
    int format; /* enum virStorageFileFormat */
644
    virStorageFileMetadataPtr backingChain;
L
Lei Li 已提交
645

646
    char *mirror;
647
    int mirrorFormat; /* enum virStorageFileFormat */
648 649
    bool mirroring;

J
J.B. Joret 已提交
650 651 652 653 654 655 656
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
        int trans;
    } geometry;

657 658 659
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
660
    } blockio;
661

L
Lei Li 已提交
662 663
    virDomainBlockIoTuneInfo blkdeviotune;

664
    char *serial;
O
Osier Yang 已提交
665
    char *wwn;
666 667
    char *vendor;
    char *product;
668
    int cachemode;
669 670
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
M
Matthias Dahl 已提交
671
    int iomode;
672
    int ioeventfd;
673
    int event_idx;
O
Osier Yang 已提交
674
    int copy_on_read;
E
Eric Blake 已提交
675
    int snapshot; /* enum virDomainSnapshotLocation, snapshot_conf.h */
676
    int startupPolicy; /* enum virDomainStartupPolicy */
677
    bool readonly;
678
    bool shared;
679
    bool transient;
680
    virDomainDeviceInfo info;
681
    virStorageEncryptionPtr encryption;
682 683
    bool rawio_specified;
    int rawio; /* no = 0, yes = 1 */
O
Osier Yang 已提交
684
    int sgio; /* enum virDomainDiskSGIO */
685 686 687

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
688 689 690
};


691 692 693 694 695
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
696
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
697
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
698
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
699 700 701 702

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

703

704 705 706 707 708 709
enum virDomainControllerModelSCSI {
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_AUTO,
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_BUSLOGIC,
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSILOGIC,
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1068,
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VMPVSCSI,
710
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
711
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
712
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
713

714
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
715 716
};

M
Marc-André Lureau 已提交
717 718 719 720 721 722 723 724 725 726
enum virDomainControllerModelUSB {
    VIR_DOMAIN_CONTROLLER_MODEL_USB_PIIX3_UHCI,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_PIIX4_UHCI,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_EHCI,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_EHCI1,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI1,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI2,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI3,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_VT82C686B_UHCI,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_PCI_OHCI,
G
Gerd Hoffmann 已提交
727
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
728
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
729 730 731 732

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

733 734 735 736 737 738 739
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

740 741 742 743
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
    int idx;
744
    int model; /* -1 == undef */
745
    unsigned int queues;
746 747 748
    union {
        virDomainVirtioSerialOpts vioserial;
    } opts;
749 750 751 752
    virDomainDeviceInfo info;
};


753 754
/* Two types of disk backends */
enum virDomainFSType {
755 756 757 758 759 760
    VIR_DOMAIN_FS_TYPE_MOUNT, /* Mounts (binds) a host dir on a guest dir */
    VIR_DOMAIN_FS_TYPE_BLOCK, /* Mounts a host block dev on a guest dir */
    VIR_DOMAIN_FS_TYPE_FILE,  /* Loopback mounts a host file on a guest dir */
    VIR_DOMAIN_FS_TYPE_TEMPLATE, /* Expands a OS template to a guest dir */
    VIR_DOMAIN_FS_TYPE_RAM,   /* Mount a RAM filesystem on a guest dir */
    VIR_DOMAIN_FS_TYPE_BIND,  /* Binds a guest dir to another guest dir */
761 762 763 764

    VIR_DOMAIN_FS_TYPE_LAST
};

765 766 767 768 769 770 771 772 773
/* Filesystem driver type */
enum virDomainFSDriverType {
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
};

774 775 776 777 778 779 780 781 782
/* Filesystem mount access mode  */
enum virDomainFSAccessMode {
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
};

783 784 785 786 787 788 789 790
/* Filesystem Write policy */
enum virDomainFSWrpolicy {
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
};

791 792 793
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

794 795
struct _virDomainFSDef {
    int type;
796
    int fsdriver;
797
    int accessmode;
798
    int wrpolicy; /* enum virDomainFSWrpolicy */
799
    unsigned long long usage;
800 801
    char *src;
    char *dst;
802
    bool readonly;
803
    virDomainDeviceInfo info;
804 805
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
806 807 808
};


809
/* network config types */
810 811 812 813 814 815 816 817
enum virDomainNetType {
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
    VIR_DOMAIN_NET_TYPE_SERVER,
    VIR_DOMAIN_NET_TYPE_CLIENT,
    VIR_DOMAIN_NET_TYPE_MCAST,
    VIR_DOMAIN_NET_TYPE_NETWORK,
    VIR_DOMAIN_NET_TYPE_BRIDGE,
D
Daniel Veillard 已提交
818
    VIR_DOMAIN_NET_TYPE_INTERNAL,
819
    VIR_DOMAIN_NET_TYPE_DIRECT,
820
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
821

822
    VIR_DOMAIN_NET_TYPE_LAST
823 824
};

825 826 827 828 829 830
/* the backend driver used for virtio interfaces */
enum virDomainNetBackendType {
    VIR_DOMAIN_NET_BACKEND_TYPE_DEFAULT, /* prefer kernel, fall back to user */
    VIR_DOMAIN_NET_BACKEND_TYPE_QEMU,    /* userland */
    VIR_DOMAIN_NET_BACKEND_TYPE_VHOST,   /* kernel */

831
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
832
};
833

834 835 836 837 838 839
/* the TX algorithm used for virtio interfaces */
enum virDomainNetVirtioTxModeType {
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_DEFAULT, /* default for this version of qemu */
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_IOTHREAD,
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_TIMER,

840
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
841 842
};

843 844 845 846 847 848 849 850 851
/* link interface states */
enum virDomainNetInterfaceLinkState {
        VIR_DOMAIN_NET_INTERFACE_LINK_STATE_DEFAULT = 0, /* Default link state (up) */
        VIR_DOMAIN_NET_INTERFACE_LINK_STATE_UP,          /* Link is up. ("cable" connected) */
        VIR_DOMAIN_NET_INTERFACE_LINK_STATE_DOWN ,       /* Link is down. ("cable" disconnected) */

        VIR_DOMAIN_NET_INTERFACE_LINK_STATE_LAST
};

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
/* Config that was actually used to bring up interface, after
 * resolving network reference. This is private data, only used within
 * libvirt, but still must maintain backward compatibility, because
 * different versions of libvirt may read the same data file.
 */
typedef struct _virDomainActualNetDef virDomainActualNetDef;
typedef virDomainActualNetDef *virDomainActualNetDefPtr;
struct _virDomainActualNetDef {
    int type; /* enum virDomainNetType */
    union {
        struct {
            char *brname;
        } bridge;
        struct {
            char *linkdev;
            int mode; /* enum virMacvtapMode from util/macvtap.h */
        } direct;
869 870 871
        struct {
            virDomainHostdevDef def;
        } hostdev;
872
    } data;
873
    virNetDevVPortProfilePtr virtPortProfile;
874
    virNetDevBandwidthPtr bandwidth;
875
    virNetDevVlan vlan;
876
    unsigned int class_id; /* class ID for bandwidth 'floor' */
877 878
};

879 880
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
S
Stefan Berger 已提交
881
    enum virDomainNetType type;
882
    virMacAddr mac;
883
    char *model;
884 885 886
    union {
        struct {
            enum virDomainNetBackendType name; /* which driver backend to use */
887
            enum virDomainNetVirtioTxModeType txmode;
888
            enum virDomainIoEventFd ioeventfd;
889
            enum virDomainVirtioEventIdx event_idx;
890 891
        } virtio;
    } driver;
892 893 894 895 896 897 898 899 900 901 902
    union {
        struct {
            char *dev;
            char *ipaddr;
        } ethernet;
        struct {
            char *address;
            int port;
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
903 904 905 906 907 908 909 910 911 912
            char *portgroup;
            /* actual has info about the currently used physical
             * device (if the network is of type
             * bridge/private/vepa/passthrough). This is saved in the
             * domain state, but never written to persistent config,
             * since it needs to be re-allocated whenever the domain
             * is restarted. It is also never shown to the user, and
             * the user cannot specify it in XML documents.
             */
            virDomainActualNetDefPtr actual;
913 914 915
        } network;
        struct {
            char *brname;
916
            char *ipaddr;
917
        } bridge;
D
Daniel Veillard 已提交
918 919 920
        struct {
            char *name;
        } internal;
921 922
        struct {
            char *linkdev;
923
            int mode; /* enum virMacvtapMode from util/macvtap.h */
924
        } direct;
925 926 927
        struct {
            virDomainHostdevDef def;
        } hostdev;
928
    } data;
929 930
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
931 932 933 934
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
935
    char *script;
936
    char *ifname;
937
    virDomainDeviceInfo info;
938 939
    char *filter;
    virNWFilterHashTablePtr filterparams;
940
    virNetDevBandwidthPtr bandwidth;
941
    virNetDevVlan vlan;
942
    int linkstate;
943 944
};

E
Eric Blake 已提交
945 946 947 948
/* Used for prefix of ifname of any network name generated dynamically
 * by libvirt, and cannot be used for a persistent network name.  */
# define VIR_NET_GENERATED_PREFIX "vnet"

949
enum virDomainChrDeviceType {
950
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
951 952
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
953
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
954

955
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
956 957
};

G
Guannan Ren 已提交
958 959 960 961 962 963 964
enum virDomainChrSerialTargetType {
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
};

965
enum virDomainChrChannelTargetType {
966 967
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
968 969
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

970
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
971 972
};

973
enum virDomainChrConsoleTargetType {
974 975
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
976 977
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
978
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
979 980
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
981 982
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
983

984
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
985 986
};

987
enum virDomainChrType {
988 989 990 991 992 993 994 995 996 997
    VIR_DOMAIN_CHR_TYPE_NULL,
    VIR_DOMAIN_CHR_TYPE_VC,
    VIR_DOMAIN_CHR_TYPE_PTY,
    VIR_DOMAIN_CHR_TYPE_DEV,
    VIR_DOMAIN_CHR_TYPE_FILE,
    VIR_DOMAIN_CHR_TYPE_PIPE,
    VIR_DOMAIN_CHR_TYPE_STDIO,
    VIR_DOMAIN_CHR_TYPE_UDP,
    VIR_DOMAIN_CHR_TYPE_TCP,
    VIR_DOMAIN_CHR_TYPE_UNIX,
998
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
999

1000
    VIR_DOMAIN_CHR_TYPE_LAST
1001 1002 1003 1004 1005
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1006 1007
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1008

1009
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1010 1011
};

E
Eric Blake 已提交
1012 1013 1014
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1015
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1016

1017
    VIR_DOMAIN_CHR_SPICEVMC_LAST
E
Eric Blake 已提交
1018 1019
};

1020 1021 1022 1023 1024
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
1025
    union {
E
Eric Blake 已提交
1026
        /* no <source> for null, vc, stdio */
1027 1028 1029 1030 1031 1032
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
1033
            bool listen;
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
1044
            bool listen;
1045
        } nix;
E
Eric Blake 已提交
1046
        int spicevmc;
1047
    } data;
1048 1049 1050 1051 1052
};

/* A complete character device, both host and domain views.  */
struct _virDomainChrDef {
    int deviceType;
G
Guannan Ren 已提交
1053 1054

    bool targetTypeAttr;
1055 1056 1057 1058 1059 1060 1061 1062
    int targetType;
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

    virDomainChrSourceDef source;
1063 1064

    virDomainDeviceInfo info;
1065 1066 1067

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1068 1069
};

E
Eric Blake 已提交
1070 1071 1072 1073 1074
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1075
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
E
Eric Blake 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
};

# define VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES 3
# define VIR_DOMAIN_SMARTCARD_DEFAULT_DATABASE "/etc/pki/nssdb"

struct _virDomainSmartcardDef {
    int type; /* virDomainSmartcardType */
    union {
        /* no extra data for 'host' */
        struct {
            char *file[VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES];
            char *database;
        } cert; /* 'host-certificates' */
        virDomainChrSourceDef passthru; /* 'passthrough' */
    } data;

    virDomainDeviceInfo info;
};

M
Marc-André Lureau 已提交
1095 1096 1097 1098 1099
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
enum virDomainTPMModel {
    VIR_DOMAIN_TPM_MODEL_TIS,

    VIR_DOMAIN_TPM_MODEL_LAST
};

enum virDomainTPMBackendType {
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,

    VIR_DOMAIN_TPM_TYPE_LAST
};

# define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"

typedef struct _virDomainTPMDef virDomainTPMDef;
typedef virDomainTPMDef *virDomainTPMDefPtr;
struct _virDomainTPMDef {
    enum virDomainTPMBackendType type;
    virDomainDeviceInfo info;
    enum virDomainTPMModel model;
    union {
        struct {
            virDomainChrSourceDef source;
        } passthrough;
    } data;
};

1127 1128 1129 1130
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

1131
    VIR_DOMAIN_INPUT_TYPE_LAST
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
};

enum virDomainInputBus {
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,

    VIR_DOMAIN_INPUT_BUS_LAST
};

struct _virDomainInputDef {
    int type;
    int bus;
1145
    virDomainDeviceInfo info;
1146 1147
};

1148 1149 1150 1151 1152 1153 1154
enum virDomainSoundCodecType {
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
};

1155 1156 1157 1158
enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1159
    VIR_DOMAIN_SOUND_MODEL_AC97,
1160
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1161 1162 1163 1164

    VIR_DOMAIN_SOUND_MODEL_LAST
};

1165 1166 1167 1168 1169
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1170 1171
struct _virDomainSoundDef {
    int model;
1172
    virDomainDeviceInfo info;
1173

1174
    size_t ncodecs;
1175
    virDomainSoundCodecDefPtr *codecs;
1176 1177
};

R
Richard Jones 已提交
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
enum virDomainWatchdogModel {
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
};

enum virDomainWatchdogAction {
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
1190
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1191 1192 1193 1194 1195 1196 1197 1198
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

struct _virDomainWatchdogDef {
    int model;
    int action;
1199
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1200 1201
};

1202 1203 1204 1205 1206 1207 1208

enum virDomainVideoType {
    VIR_DOMAIN_VIDEO_TYPE_VGA,
    VIR_DOMAIN_VIDEO_TYPE_CIRRUS,
    VIR_DOMAIN_VIDEO_TYPE_VMVGA,
    VIR_DOMAIN_VIDEO_TYPE_XEN,
    VIR_DOMAIN_VIDEO_TYPE_VBOX,
1209
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1210 1211 1212 1213 1214

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


1215 1216 1217
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1218 1219
    bool support3d;
    bool support2d;
1220 1221 1222
};


1223 1224
struct _virDomainVideoDef {
    int type;
1225 1226
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1227
    unsigned int heads;
1228
    bool primary;
1229
    virDomainVideoAccelDefPtr accel;
1230
    virDomainDeviceInfo info;
1231 1232
};

1233
/* graphics console modes */
1234 1235 1236
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1237 1238
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1239
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1240

1241
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1242 1243
};

1244 1245 1246 1247 1248 1249 1250 1251 1252
enum virDomainGraphicsAuthConnectedType {
    VIR_DOMAIN_GRAPHICS_AUTH_CONNECTED_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_AUTH_CONNECTED_FAIL,
    VIR_DOMAIN_GRAPHICS_AUTH_CONNECTED_DISCONNECT,
    VIR_DOMAIN_GRAPHICS_AUTH_CONNECTED_KEEP,

    VIR_DOMAIN_GRAPHICS_AUTH_CONNECTED_LAST
};

1253 1254 1255 1256
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
1257
    bool expires; /* Whether there is an expiry time set */
1258
    time_t validTo;  /* seconds since epoch */
1259
    int connected; /* action if connected */
1260 1261
};

1262 1263 1264 1265 1266 1267 1268
enum virDomainGraphicsSpiceChannelName {
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MAIN,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_DISPLAY,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_INPUT,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_CURSOR,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_PLAYBACK,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_RECORD,
E
Eric Blake 已提交
1269
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1270
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
};

enum virDomainGraphicsSpiceChannelMode {
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_ANY,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_SECURE,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_INSECURE,

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_LAST
};
1282

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
enum virDomainGraphicsSpiceImageCompression {
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_AUTO_GLZ,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_AUTO_LZ,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_QUIC,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_GLZ,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_LZ,
    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_OFF,

    VIR_DOMAIN_GRAPHICS_SPICE_IMAGE_COMPRESSION_LAST
};

enum virDomainGraphicsSpiceJpegCompression {
    VIR_DOMAIN_GRAPHICS_SPICE_JPEG_COMPRESSION_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_JPEG_COMPRESSION_AUTO,
    VIR_DOMAIN_GRAPHICS_SPICE_JPEG_COMPRESSION_NEVER,
    VIR_DOMAIN_GRAPHICS_SPICE_JPEG_COMPRESSION_ALWAYS,

    VIR_DOMAIN_GRAPHICS_SPICE_JPEG_COMPRESSION_LAST
};

enum virDomainGraphicsSpiceZlibCompression {
    VIR_DOMAIN_GRAPHICS_SPICE_ZLIB_COMPRESSION_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_ZLIB_COMPRESSION_AUTO,
    VIR_DOMAIN_GRAPHICS_SPICE_ZLIB_COMPRESSION_NEVER,
    VIR_DOMAIN_GRAPHICS_SPICE_ZLIB_COMPRESSION_ALWAYS,

    VIR_DOMAIN_GRAPHICS_SPICE_ZLIB_COMPRESSION_LAST
};

enum virDomainGraphicsSpicePlaybackCompression {
    VIR_DOMAIN_GRAPHICS_SPICE_PLAYBACK_COMPRESSION_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_PLAYBACK_COMPRESSION_ON,
    VIR_DOMAIN_GRAPHICS_SPICE_PLAYBACK_COMPRESSION_OFF,

    VIR_DOMAIN_GRAPHICS_SPICE_PLAYBACK_COMPRESSION_LAST
};

P
Peng Zhou 已提交
1321 1322 1323 1324 1325 1326 1327 1328
enum virDomainGraphicsSpiceMouseMode {
    VIR_DOMAIN_GRAPHICS_SPICE_MOUSE_MODE_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_MOUSE_MODE_SERVER,
    VIR_DOMAIN_GRAPHICS_SPICE_MOUSE_MODE_CLIENT,

    VIR_DOMAIN_GRAPHICS_SPICE_MOUSE_MODE_LAST
};

1329 1330 1331 1332 1333 1334 1335 1336 1337
enum virDomainGraphicsSpiceStreamingMode {
    VIR_DOMAIN_GRAPHICS_SPICE_STREAMING_MODE_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_STREAMING_MODE_FILTER,
    VIR_DOMAIN_GRAPHICS_SPICE_STREAMING_MODE_ALL,
    VIR_DOMAIN_GRAPHICS_SPICE_STREAMING_MODE_OFF,

    VIR_DOMAIN_GRAPHICS_SPICE_STREAMING_MODE_LAST
};

1338 1339 1340 1341 1342 1343 1344 1345
enum virDomainGraphicsSpiceClipboardCopypaste {
    VIR_DOMAIN_GRAPHICS_SPICE_CLIPBOARD_COPYPASTE_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_CLIPBOARD_COPYPASTE_YES,
    VIR_DOMAIN_GRAPHICS_SPICE_CLIPBOARD_COPYPASTE_NO,

    VIR_DOMAIN_GRAPHICS_SPICE_CLIPBOARD_COPYPASTE_LAST
};

1346 1347 1348 1349 1350
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

1351
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1352 1353
};

M
Marc-André Lureau 已提交
1354 1355 1356
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

1357
    VIR_DOMAIN_HUB_TYPE_LAST
M
Marc-André Lureau 已提交
1358 1359
};

1360 1361 1362 1363 1364 1365 1366 1367
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
};

1368
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1369 1370 1371 1372 1373
    /* Port value discipline:
     * Value -1 is legacy syntax indicating that it should be auto-allocated.
     * Value 0 means port wasn't specified in XML at all.
     * Positive value is actual port number given in XML.
     */
1374 1375 1376 1377
    int type;
    union {
        struct {
            int port;
1378
            bool autoport;
1379
            char *keymap;
1380
            char *socket;
1381
            virDomainGraphicsAuthDef auth;
1382 1383 1384 1385
        } vnc;
        struct {
            char *display;
            char *xauth;
1386
            bool fullscreen;
1387
        } sdl;
1388 1389
        struct {
            int port;
1390 1391 1392
            bool autoport;
            bool replaceUser;
            bool multiUser;
1393 1394 1395
        } rdp;
        struct {
            char *display;
1396
            bool fullscreen;
1397
        } desktop;
1398 1399 1400
        struct {
            int port;
            int tlsPort;
P
Peng Zhou 已提交
1401
            int mousemode;
1402
            char *keymap;
1403
            virDomainGraphicsAuthDef auth;
1404
            bool autoport;
1405
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1406
            int defaultMode; /* enum virDomainGraphicsSpiceChannelMode */
1407 1408 1409 1410
            int image;
            int jpeg;
            int zlib;
            int playback;
1411
            int streaming;
1412
            int copypaste;
1413
        } spice;
1414
    } data;
1415 1416 1417 1418 1419
    /* nListens, listens, and *port are only useful if type is vnc,
     * rdp, or spice. They've been extracted from the union only to
     * simplify parsing code.*/
    size_t nListens;
    virDomainGraphicsListenDefPtr listens;
1420 1421
};

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
enum virDomainRedirdevBus {
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
};

struct _virDomainRedirdevDef {
    int bus; /* enum virDomainRedirdevBus */

    union {
        virDomainChrSourceDef chr;
    } source;

    virDomainDeviceInfo info; /* Guest address */
};
1437

1438 1439 1440 1441 1442
struct _virDomainRedirFilterUsbDevDef {
    int usbClass;
    int vendor;
    int product;
    int version;
1443
    bool allow;
1444 1445 1446 1447 1448 1449 1450
};

struct _virDomainRedirFilterDef {
    size_t nusbdevs;
    virDomainRedirFilterUsbDevDefPtr *usbdevs;
};

1451 1452 1453 1454 1455 1456 1457 1458
enum virDomainMemDump {
    VIR_DOMAIN_MEM_DUMP_DEFAULT = 0,
    VIR_DOMAIN_MEM_DUMP_ON,
    VIR_DOMAIN_MEM_DUMP_OFF,

    VIR_DOMAIN_MEM_DUMP_LAST,
};

1459 1460 1461
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1462
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


1473
enum virDomainSmbiosMode {
1474
    VIR_DOMAIN_SMBIOS_NONE = 0,
1475 1476 1477 1478 1479 1480 1481
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1482

1483
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1484 1485 1486 1487 1488 1489 1490

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1491
    VIR_DOMAIN_BOOT_LAST
1492 1493
};

1494 1495 1496 1497
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
1498 1499

    VIR_DOMAIN_BOOT_MENU_LAST
1500 1501
};

1502 1503 1504 1505
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1506
    VIR_DOMAIN_FEATURE_HAP,
1507
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1508
    VIR_DOMAIN_FEATURE_PRIVNET,
1509
    VIR_DOMAIN_FEATURE_HYPERV,
1510 1511 1512 1513

    VIR_DOMAIN_FEATURE_LAST
};

1514 1515 1516 1517
enum virDomainFeatureState {
    VIR_DOMAIN_FEATURE_STATE_DEFAULT = 0,
    VIR_DOMAIN_FEATURE_STATE_ON,
    VIR_DOMAIN_FEATURE_STATE_OFF,
1518

1519
    VIR_DOMAIN_FEATURE_STATE_LAST
1520 1521
};

1522 1523 1524 1525 1526 1527
enum virDomainHyperv {
    VIR_DOMAIN_HYPERV_RELAXED = 0,

    VIR_DOMAIN_HYPERV_LAST
};

1528 1529 1530 1531 1532 1533 1534 1535 1536
enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
enum virDomainLifecycleCrashAction {
    VIR_DOMAIN_LIFECYCLE_CRASH_DESTROY,
    VIR_DOMAIN_LIFECYCLE_CRASH_RESTART,
    VIR_DOMAIN_LIFECYCLE_CRASH_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_CRASH_PRESERVE,
    VIR_DOMAIN_LIFECYCLE_CRASH_COREDUMP_DESTROY,
    VIR_DOMAIN_LIFECYCLE_CRASH_COREDUMP_RESTART,

    VIR_DOMAIN_LIFECYCLE_CRASH_LAST
};

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
typedef enum {
    VIR_DOMAIN_LOCK_FAILURE_DEFAULT,
    VIR_DOMAIN_LOCK_FAILURE_POWEROFF,
    VIR_DOMAIN_LOCK_FAILURE_RESTART,
    VIR_DOMAIN_LOCK_FAILURE_PAUSE,
    VIR_DOMAIN_LOCK_FAILURE_IGNORE,

    VIR_DOMAIN_LOCK_FAILURE_LAST
} virDomainLockFailureAction;

VIR_ENUM_DECL(virDomainLockFailure)

1560 1561 1562 1563 1564
enum virDomainPMState {
    VIR_DOMAIN_PM_STATE_DEFAULT = 0,
    VIR_DOMAIN_PM_STATE_ENABLED,
    VIR_DOMAIN_PM_STATE_DISABLED,

1565
    VIR_DOMAIN_PM_STATE_LAST
1566 1567
};

M
Michal Privoznik 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
enum virDomainBIOSUseserial {
    VIR_DOMAIN_BIOS_USESERIAL_DEFAULT = 0,
    VIR_DOMAIN_BIOS_USESERIAL_YES,
    VIR_DOMAIN_BIOS_USESERIAL_NO
};

typedef struct _virDomainBIOSDef virDomainBIOSDef;
typedef virDomainBIOSDef *virDomainBIOSDefPtr;
struct _virDomainBIOSDef {
    int useserial;
1578 1579 1580
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1581 1582
};

1583 1584 1585 1586 1587
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
1588
    virArch arch;
1589
    char *machine;
1590
    size_t nBootDevs;
1591
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
1592
    /* enum virDomainBootMenu */
1593
    int bootmenu;
1594
    char *init;
1595
    char **initargv;
1596 1597 1598
    char *kernel;
    char *initrd;
    char *cmdline;
1599
    char *dtb;
1600 1601 1602 1603
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
1604
    int smbios_mode;
1605

M
Michal Privoznik 已提交
1606
    virDomainBIOSDef bios;
1607 1608
};

1609 1610 1611 1612 1613 1614
enum virDomainTimerNameType {
    VIR_DOMAIN_TIMER_NAME_PLATFORM = 0,
    VIR_DOMAIN_TIMER_NAME_PIT,
    VIR_DOMAIN_TIMER_NAME_RTC,
    VIR_DOMAIN_TIMER_NAME_HPET,
    VIR_DOMAIN_TIMER_NAME_TSC,
P
Paolo Bonzini 已提交
1615
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1616

1617
    VIR_DOMAIN_TIMER_NAME_LAST
1618 1619
};

1620 1621 1622 1623
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1624

1625
    VIR_DOMAIN_TIMER_TRACK_LAST
1626 1627 1628 1629 1630 1631 1632 1633
};

enum virDomainTimerTickpolicyType {
    VIR_DOMAIN_TIMER_TICKPOLICY_DELAY = 0,
    VIR_DOMAIN_TIMER_TICKPOLICY_CATCHUP,
    VIR_DOMAIN_TIMER_TICKPOLICY_MERGE,
    VIR_DOMAIN_TIMER_TICKPOLICY_DISCARD,

1634
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1635 1636 1637 1638 1639 1640 1641
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1642
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1643

1644
    VIR_DOMAIN_TIMER_MODE_LAST
1645 1646
};

O
Osier Yang 已提交
1647
enum virDomainCpuPlacementMode {
1648
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1649 1650
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1651
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
O
Osier Yang 已提交
1652 1653
};

1654 1655 1656 1657 1658 1659 1660 1661
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1662 1663 1664 1665 1666 1667 1668
typedef struct _virDomainTimerDef virDomainTimerDef;
typedef virDomainTimerDef *virDomainTimerDefPtr;
struct _virDomainTimerDef {
    int name;
    int present;    /* unspecified = -1, no = 0, yes = 1 */
    int tickpolicy; /* none|catchup|merge|discard */

1669 1670 1671 1672
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1673 1674 1675 1676 1677 1678

    /* frequency & mode are only valid for name='tsc' */
    unsigned long frequency; /* in Hz, unspecified = 0 */
    int mode;       /* auto|native|emulate|paravirt */
};

1679 1680 1681
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1682
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1683
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1684

1685
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1686 1687
};

1688 1689 1690 1691
enum virDomainClockBasis {
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1692
    VIR_DOMAIN_CLOCK_BASIS_LAST
1693 1694
};

1695 1696 1697 1698
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1699

1700
    union {
1701 1702 1703
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
1704
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
1705 1706 1707 1708
        struct {
            long long adjustment;
            int basis;
        } variable;
1709 1710 1711 1712 1713

        /* Timezone name, when
         * offset == VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME */
        char *timezone;
    } data;
1714

1715
    size_t ntimers;
1716
    virDomainTimerDefPtr *timers;
1717 1718
};

1719
# define VIR_DOMAIN_CPUMASK_LEN 1024
1720

E
Eric Blake 已提交
1721 1722 1723
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1724
    int vcpuid;
H
Hu Tao 已提交
1725
    virBitmapPtr cpumask;
1726 1727
};

H
Hu Tao 已提交
1728 1729
void virDomainVcpuPinDefFree(virDomainVcpuPinDefPtr def);
void virDomainVcpuPinDefArrayFree(virDomainVcpuPinDefPtr *def, int nvcpupin);
1730 1731 1732 1733

virDomainVcpuPinDefPtr *virDomainVcpuPinDefCopy(virDomainVcpuPinDefPtr *src,
                                                int nvcpupin);

E
Eric Blake 已提交
1734
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1735 1736 1737
                                int nvcpupin,
                                int vcpu);

E
Eric Blake 已提交
1738
virDomainVcpuPinDefPtr virDomainVcpuPinFindByVcpu(virDomainVcpuPinDefPtr *def,
1739 1740 1741
                                                  int nvcpupin,
                                                  int vcpu);

1742 1743 1744 1745 1746 1747 1748
typedef struct _virBlkioDeviceWeight virBlkioDeviceWeight;
typedef virBlkioDeviceWeight *virBlkioDeviceWeightPtr;
struct _virBlkioDeviceWeight {
    char *path;
    unsigned int weight;
};

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
enum virDomainRNGModel {
    VIR_DOMAIN_RNG_MODEL_VIRTIO,

    VIR_DOMAIN_RNG_MODEL_LAST
};

enum virDomainRNGBackend {
    VIR_DOMAIN_RNG_BACKEND_RANDOM,
    VIR_DOMAIN_RNG_BACKEND_EGD,
    /* VIR_DOMAIN_RNG_BACKEND_POOL, */

    VIR_DOMAIN_RNG_BACKEND_LAST
};

struct _virDomainRNGDef {
    int model;
    int backend;
1766 1767
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
1768 1769 1770 1771 1772 1773 1774 1775 1776 1777

    union {
        char *file; /* file name for 'random' source */
        virDomainChrSourceDefPtr chardev; /* a char backend for
                                             the EGD source */
    } source;

    virDomainDeviceInfo info;
};

1778 1779 1780
void virBlkioDeviceWeightArrayClear(virBlkioDeviceWeightPtr deviceWeights,
                                    int ndevices);

1781 1782 1783 1784 1785
typedef struct _virDomainResourceDef virDomainResourceDef;
typedef virDomainResourceDef *virDomainResourceDefPtr;
struct _virDomainResourceDef {
    char *partition;
};
1786

1787 1788 1789 1790 1791 1792
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1793 1794 1795 1796 1797 1798 1799
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1800
    char *title;
1801
    char *description;
1802

1803 1804
    struct {
        unsigned int weight;
1805 1806 1807

        size_t ndevices;
        virBlkioDeviceWeightPtr devices;
1808 1809
    } blkio;

1810
    struct {
1811 1812 1813
        unsigned long long max_balloon; /* in kibibytes */
        unsigned long long cur_balloon; /* in kibibytes */
        bool hugepage_backed;
1814
        int dump_core; /* enum virDomainMemDump */
1815 1816 1817 1818
        unsigned long long hard_limit; /* in kibibytes */
        unsigned long long soft_limit; /* in kibibytes */
        unsigned long long min_guarantee; /* in kibibytes */
        unsigned long long swap_hard_limit; /* in kibibytes */
1819
    } mem;
E
Eric Blake 已提交
1820 1821
    unsigned short vcpus;
    unsigned short maxvcpus;
O
Osier Yang 已提交
1822
    int placement_mode;
H
Hu Tao 已提交
1823
    virBitmapPtr cpumask;
1824

1825 1826
    struct {
        unsigned long shares;
1827 1828
        unsigned long long period;
        long long quota;
1829 1830
        unsigned long long emulator_period;
        long long emulator_quota;
1831
        int nvcpupin;
E
Eric Blake 已提交
1832
        virDomainVcpuPinDefPtr *vcpupin;
T
Tang Chen 已提交
1833
        virDomainVcpuPinDefPtr emulatorpin;
1834 1835
    } cputune;

G
Gao feng 已提交
1836
    virNumaTuneDef numatune;
1837
    virDomainResourceDefPtr resource;
1838

1839 1840 1841 1842 1843
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

1844 1845
    int onLockFailure; /* enum virDomainLockFailureAction */

1846 1847 1848 1849 1850 1851
    struct {
        /* These options are actually type of enum virDomainPMState */
        int s3;
        int s4;
    } pm;

1852 1853 1854
    virDomainOSDef os;
    char *emulator;
    int features;
1855
    /* enum virDomainFeatureState */
1856
    int apic_eoi;
1857 1858
    /* These options are of type virDomainFeatureState */
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
1859

1860
    virDomainClockDef clock;
1861

1862
    size_t ngraphics;
1863
    virDomainGraphicsDefPtr *graphics;
1864

1865
    size_t ndisks;
1866 1867
    virDomainDiskDefPtr *disks;

1868
    size_t ncontrollers;
1869 1870
    virDomainControllerDefPtr *controllers;

1871
    size_t nfss;
1872 1873
    virDomainFSDefPtr *fss;

1874
    size_t nnets;
1875 1876
    virDomainNetDefPtr *nets;

1877
    size_t ninputs;
1878 1879
    virDomainInputDefPtr *inputs;

1880
    size_t nsounds;
1881 1882
    virDomainSoundDefPtr *sounds;

1883
    size_t nvideos;
1884 1885
    virDomainVideoDefPtr *videos;

1886
    size_t nhostdevs;
1887 1888
    virDomainHostdevDefPtr *hostdevs;

1889
    size_t nredirdevs;
1890 1891
    virDomainRedirdevDefPtr *redirdevs;

1892
    size_t nsmartcards;
E
Eric Blake 已提交
1893 1894
    virDomainSmartcardDefPtr *smartcards;

1895
    size_t nserials;
1896 1897
    virDomainChrDefPtr *serials;

1898
    size_t nparallels;
1899 1900
    virDomainChrDefPtr *parallels;

1901
    size_t nchannels;
1902 1903
    virDomainChrDefPtr *channels;

1904
    size_t nconsoles;
1905 1906
    virDomainChrDefPtr *consoles;

1907
    size_t nleases;
1908 1909
    virDomainLeaseDefPtr *leases;

1910
    size_t nhubs;
M
Marc-André Lureau 已提交
1911 1912
    virDomainHubDefPtr *hubs;

1913 1914 1915
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

1916
    /* Only 1 */
R
Richard Jones 已提交
1917
    virDomainWatchdogDefPtr watchdog;
1918
    virDomainMemballoonDefPtr memballoon;
1919
    virDomainTPMDefPtr tpm;
1920
    virCPUDefPtr cpu;
1921
    virSysinfoDefPtr sysinfo;
1922
    virDomainRedirFilterDefPtr redirfilter;
1923
    virDomainRNGDefPtr rng;
1924 1925 1926

    void *namespaceData;
    virDomainXMLNamespace ns;
1927 1928 1929

    /* Application-specific custom metadata */
    xmlNodePtr metadata;
1930 1931
};

1932 1933 1934 1935 1936 1937
enum virDomainTaintFlags {
    VIR_DOMAIN_TAINT_CUSTOM_ARGV,      /* Custom ARGV passthrough from XML */
    VIR_DOMAIN_TAINT_CUSTOM_MONITOR,   /* Custom monitor commands issued */
    VIR_DOMAIN_TAINT_HIGH_PRIVILEGES,  /* Running with undesirably high privileges */
    VIR_DOMAIN_TAINT_SHELL_SCRIPTS,    /* Network configuration using opaque shell scripts */
    VIR_DOMAIN_TAINT_DISK_PROBING,     /* Relying on potentially unsafe disk format probing */
1938
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
1939
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
1940 1941 1942 1943

    VIR_DOMAIN_TAINT_LAST
};

1944
/* Guest VM runtime state */
J
Jiri Denemark 已提交
1945 1946 1947 1948 1949 1950
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

1951 1952 1953
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1954
    virObjectLockable parent;
1955

1956
    pid_t pid;
J
Jiri Denemark 已提交
1957
    virDomainStateReason state;
1958 1959 1960

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1961
    unsigned int updated : 1;
1962 1963 1964

    virDomainDefPtr def; /* The current definition */
    virDomainDefPtr newDef; /* New definition to activate at shutdown */
1965

1966
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
1967 1968
    virDomainSnapshotObjPtr current_snapshot;

1969 1970
    bool hasManagedSave;

1971 1972
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1973 1974

    int taint;
1975 1976
};

1977 1978
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
1979

1980 1981 1982

/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
1983 1984
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
1985 1986 1987 1988 1989 1990

typedef void *(*virDomainXMLPrivateDataAllocFunc)(void);
typedef void (*virDomainXMLPrivateDataFreeFunc)(void *);
typedef int (*virDomainXMLPrivateDataFormatFunc)(virBufferPtr, void *);
typedef int (*virDomainXMLPrivateDataParseFunc)(xmlXPathContextPtr, void *);

1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
                                             virCapsPtr caps,
                                             void *opaque);
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
                                                   virDomainDefPtr def,
                                                   virCapsPtr caps,
                                                   void *opaque);

typedef struct _virDomainDefParserConfig virDomainDefParserConfig;
typedef virDomainDefParserConfig *virDomainDefParserConfigPtr;
struct _virDomainDefParserConfig {
2002
    /* driver domain definition callbacks */
2003 2004 2005
    virDomainDefPostParseCallback domainPostParseCallback;
    virDomainDeviceDefPostParseCallback devicesPostParseCallback;

2006
    /* private data for the callbacks */
2007 2008
    void *priv;
    virFreeCallback privFree;
2009 2010 2011

    /* data */
    bool hasWideScsiBus;
2012
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2013 2014
};

2015 2016 2017 2018 2019 2020 2021 2022 2023
typedef struct _virDomainXMLPrivateDataCallbacks virDomainXMLPrivateDataCallbacks;
typedef virDomainXMLPrivateDataCallbacks *virDomainXMLPrivateDataCallbacksPtr;
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
};

2024 2025 2026
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
                                            virDomainXMLNamespacePtr xmlns);
2027

2028 2029
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2030
virDomainXMLNamespacePtr
2031
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2032 2033
    ATTRIBUTE_NONNULL(1);

2034
static inline bool
D
Daniel P. Berrange 已提交
2035
virDomainObjIsActive(virDomainObjPtr dom)
2036 2037 2038 2039
{
    return dom->def->id != -1;
}

2040
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2041
    ATTRIBUTE_NONNULL(1);
2042

2043
virDomainObjListPtr virDomainObjListNew(void);
2044

2045 2046 2047 2048 2049 2050
virDomainObjPtr virDomainObjListFindByID(const virDomainObjListPtr doms,
                                         int id);
virDomainObjPtr virDomainObjListFindByUUID(const virDomainObjListPtr doms,
                                           const unsigned char *uuid);
virDomainObjPtr virDomainObjListFindByName(const virDomainObjListPtr doms,
                                           const char *name);
2051

2052 2053
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
2054

2055
void virDomainResourceDefFree(virDomainResourceDefPtr resource);
2056 2057 2058
void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
2059
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2060
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
H
Han Cheng 已提交
2061 2062 2063
int virDomainDeviceFindControllerModel(virDomainDefPtr def,
                                       virDomainDeviceInfoPtr info,
                                       int controllerType);
2064 2065 2066
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2067
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2068
void virDomainFSDefFree(virDomainFSDefPtr def);
2069
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
2070
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2071
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2072
void virDomainChrDefFree(virDomainChrDefPtr def);
2073
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
2074 2075
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
2076
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2077
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2078
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
2079
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2080
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2081 2082
virDomainHostdevDefPtr virDomainHostdevDefAlloc(void);
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2083
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2084
void virDomainHubDefFree(virDomainHubDefPtr def);
2085
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2086
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2087
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2088
virDomainDeviceDefPtr virDomainDeviceDefCopy(virDomainDeviceDefPtr src,
2089
                                             const virDomainDefPtr def,
2090 2091
                                             virCapsPtr caps,
                                             virDomainXMLOptionPtr xmlopt);
2092 2093
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2094 2095
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
2096
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
2097
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
2098
void virDomainDefClearCCWAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
2099
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
2100
void virDomainTPMDefFree(virDomainTPMDefPtr def);
2101

2102
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2103 2104
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2105 2106 2107 2108 2109 2110
                                           void *opaque);

int virDomainDeviceInfoIterate(virDomainDefPtr def,
                               virDomainDeviceInfoCallback cb,
                               void *opaque);

2111 2112
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
2113 2114
virDomainChrDefPtr virDomainChrDefNew(void);

2115 2116 2117 2118
enum {
    VIR_DOMAIN_OBJ_LIST_ADD_LIVE = (1 << 0),
    VIR_DOMAIN_OBJ_LIST_ADD_CHECK_LIVE = (1 << 1),
};
2119 2120
virDomainObjPtr virDomainObjListAdd(virDomainObjListPtr doms,
                                    const virDomainDefPtr def,
2121
                                    virDomainXMLOptionPtr xmlopt,
2122 2123
                                    unsigned int flags,
                                    virDomainDefPtr *oldDef);
2124 2125
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
2126 2127
                           bool live,
                           virDomainDefPtr *oldDef);
2128
int virDomainObjSetDefTransient(virCapsPtr caps,
2129
                                virDomainXMLOptionPtr xmlopt,
2130 2131
                                virDomainObjPtr domain,
                                bool live);
2132 2133
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2134
                             virDomainXMLOptionPtr xmlopt,
2135
                             virDomainObjPtr domain);
2136 2137 2138

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
2139
                                virDomainXMLOptionPtr xmlopt,
2140 2141 2142 2143
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

2144 2145 2146 2147 2148 2149 2150
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virCapsPtr caps,
                                 virDomainXMLOptionPtr xmlopt,
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt);
2151

2152 2153
void virDomainObjListRemove(virDomainObjListPtr doms,
                            virDomainObjPtr dom);
2154

2155
virDomainDeviceDefPtr virDomainDeviceDefParse(const char *xmlStr,
2156
                                              virDomainDefPtr def,
2157 2158
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2159
                                              unsigned int flags);
2160 2161
virDomainDefPtr virDomainDefParseString(const char *xmlStr,
                                        virCapsPtr caps,
2162
                                        virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2163
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2164
                                        unsigned int flags);
2165 2166
virDomainDefPtr virDomainDefParseFile(const char *filename,
                                      virCapsPtr caps,
2167
                                      virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2168
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2169
                                      unsigned int flags);
2170
virDomainDefPtr virDomainDefParseNode(xmlDocPtr doc,
2171
                                      xmlNodePtr root,
2172 2173
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2174
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2175
                                      unsigned int flags);
2176

2177 2178 2179
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2180
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
2181

2182
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
2183
                         unsigned int flags);
2184 2185 2186
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
2187

2188 2189 2190
int virDomainDefCompatibleDevice(virDomainDefPtr def,
                                 virDomainDeviceDefPtr dev);

2191
int virDomainVcpuPinAdd(virDomainVcpuPinDefPtr **vcpupin_list,
H
Hu Tao 已提交
2192
                        int *nvcpupin,
2193 2194 2195 2196
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
2197
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
2198

2199 2200 2201 2202 2203 2204
int virDomainEmulatorPinAdd(virDomainDefPtr def,
                              unsigned char *cpumap,
                              int maplen);

int virDomainEmulatorPinDel(virDomainDefPtr def);

2205 2206
void virDomainRNGDefFree(virDomainRNGDefPtr def);

2207 2208 2209
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2210 2211 2212 2213
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2214 2215
int virDomainDiskDefAssignAddress(virDomainXMLOptionPtr xmlopt,
                                  virDomainDiskDefPtr def);
2216

2217 2218 2219 2220
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
E
Eric Blake 已提交
2221
bool virDomainHasDiskMirror(virDomainObjPtr vm);
2222

2223 2224
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2225
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2226
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2227

L
Laine Stump 已提交
2228
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2229 2230
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2231 2232 2233
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251
int virDomainGraphicsListenGetType(virDomainGraphicsDefPtr def, size_t ii)
            ATTRIBUTE_NONNULL(1);
int virDomainGraphicsListenSetType(virDomainGraphicsDefPtr def, size_t ii, int val)
            ATTRIBUTE_NONNULL(1);
const char *virDomainGraphicsListenGetAddress(virDomainGraphicsDefPtr def,
                                              size_t ii)
            ATTRIBUTE_NONNULL(1);
int virDomainGraphicsListenSetAddress(virDomainGraphicsDefPtr def,
                                      size_t ii, const char *address,
                                      int len, bool setType)
            ATTRIBUTE_NONNULL(1);
const char *virDomainGraphicsListenGetNetwork(virDomainGraphicsDefPtr def,
                                              size_t ii)
            ATTRIBUTE_NONNULL(1);
int virDomainGraphicsListenSetNetwork(virDomainGraphicsDefPtr def,
                                      size_t ii, const char *network, int len)
            ATTRIBUTE_NONNULL(1);

2252
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2253 2254
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2255
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2256
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2257
virNetDevVPortProfilePtr
2258
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2259
virNetDevBandwidthPtr
2260
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2261
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2262

2263 2264 2265 2266
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2267 2268
int virDomainControllerFind(virDomainDefPtr def, int type, int idx);
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2269 2270 2271 2272 2273 2274 2275 2276

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def);
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2277 2278 2279 2280 2281
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2282

2283
int virDomainSaveXML(const char *configDir,
2284 2285 2286
                     virDomainDefPtr def,
                     const char *xml);

2287
int virDomainSaveConfig(const char *configDir,
2288
                        virDomainDefPtr def);
2289
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
2290
                        const char *statusDir,
2291
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
2292

2293 2294 2295 2296
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2297 2298 2299 2300
int virDomainObjListLoadAllConfigs(virDomainObjListPtr doms,
                                   const char *configDir,
                                   const char *autostartDir,
                                   int liveStatus,
2301 2302
                                   virCapsPtr caps,
                                   virDomainXMLOptionPtr xmlopt,
2303 2304 2305
                                   unsigned int expectedVirtTypes,
                                   virDomainLoadConfigNotify notify,
                                   void *opaque);
2306

2307
int virDomainDeleteConfig(const char *configDir,
2308
                          const char *autostartDir,
2309 2310
                          virDomainObjPtr dom);

2311
char *virDomainConfigFile(const char *dir,
2312 2313
                          const char *name);

2314 2315 2316 2317
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2318
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
2319
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2320 2321
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
2322

2323 2324 2325 2326 2327 2328 2329 2330 2331
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

int virDomainObjListGetActiveIDs(virDomainObjListPtr doms,
                                 int *ids,
                                 int maxids);
int virDomainObjListGetInactiveNames(virDomainObjListPtr doms,
                                     char **const names,
                                     int maxnames);

2332 2333 2334 2335 2336 2337 2338
typedef int (*virDomainObjListIterator)(virDomainObjPtr dom,
                                        void *opaque);

int virDomainObjListForEach(virDomainObjListPtr doms,
                            virDomainObjListIterator callback,
                            void *opaque);

E
Eric Blake 已提交
2339 2340 2341 2342 2343 2344 2345 2346 2347
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

int virDomainSmartcardDefForeach(virDomainDefPtr def,
                                 bool abortOnError,
                                 virDomainSmartcardDefIterator iter,
                                 void *opaque);

2348 2349 2350 2351 2352 2353 2354 2355 2356
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

int virDomainChrDefForeach(virDomainDefPtr def,
                           bool abortOnError,
                           virDomainChrDefIterator iter,
                           void *opaque);

2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
typedef int (*virDomainDiskDefPathIterator)(virDomainDiskDefPtr disk,
                                            const char *path,
                                            size_t depth,
                                            void *opaque);

int virDomainDiskDefForeachPath(virDomainDiskDefPtr disk,
                                bool ignoreOpenFailure,
                                virDomainDiskDefPathIterator iter,
                                void *opaque);

J
Jiri Denemark 已提交
2367 2368 2369 2370 2371 2372 2373
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2374 2375 2376 2377 2378 2379
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

virSecurityDeviceLabelDefPtr
virDomainDiskDefGetSecurityLabelDef(virDomainDiskDefPtr def, const char *model);

2380 2381 2382
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2383
virSecurityLabelDefPtr
2384
virDomainDefGenSecurityLabelDef(const char *model);
2385

2386
virSecurityDeviceLabelDefPtr
2387 2388 2389 2390
virDomainDiskDefGenSecurityLabelDef(const char *model);

void virSecurityLabelDefFree(virSecurityLabelDefPtr def);
void virSecurityDeviceLabelDefFree(virSecurityDeviceLabelDefPtr def);
2391

2392 2393
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2394

2395 2396
VIR_ENUM_DECL(virDomainTaint)

2397 2398
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
2399
VIR_ENUM_DECL(virDomainBootMenu)
2400
VIR_ENUM_DECL(virDomainFeature)
2401
VIR_ENUM_DECL(virDomainFeatureState)
2402
VIR_ENUM_DECL(virDomainLifecycle)
2403
VIR_ENUM_DECL(virDomainLifecycleCrash)
2404
VIR_ENUM_DECL(virDomainPMState)
2405
VIR_ENUM_DECL(virDomainDevice)
2406
VIR_ENUM_DECL(virDomainDeviceAddress)
2407 2408
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
2409
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
2410
VIR_ENUM_DECL(virDomainDiskBus)
2411
VIR_ENUM_DECL(virDomainDiskCache)
2412
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
2413
VIR_ENUM_DECL(virDomainDiskProtocol)
2414
VIR_ENUM_DECL(virDomainDiskProtocolTransport)
M
Matthias Dahl 已提交
2415
VIR_ENUM_DECL(virDomainDiskIo)
2416
VIR_ENUM_DECL(virDomainDiskSecretType)
O
Osier Yang 已提交
2417
VIR_ENUM_DECL(virDomainDiskSGIO)
2418
VIR_ENUM_DECL(virDomainDiskTray)
2419
VIR_ENUM_DECL(virDomainIoEventFd)
2420
VIR_ENUM_DECL(virDomainVirtioEventIdx)
O
Osier Yang 已提交
2421
VIR_ENUM_DECL(virDomainDiskCopyOnRead)
2422
VIR_ENUM_DECL(virDomainController)
2423
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
2424
VIR_ENUM_DECL(virDomainControllerModelUSB)
2425
VIR_ENUM_DECL(virDomainFS)
2426
VIR_ENUM_DECL(virDomainFSDriverType)
2427
VIR_ENUM_DECL(virDomainFSAccessMode)
2428
VIR_ENUM_DECL(virDomainFSWrpolicy)
2429
VIR_ENUM_DECL(virDomainNet)
2430
VIR_ENUM_DECL(virDomainNetBackend)
2431
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
2432
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
2433
VIR_ENUM_DECL(virDomainChrDevice)
2434
VIR_ENUM_DECL(virDomainChrChannelTarget)
2435
VIR_ENUM_DECL(virDomainChrConsoleTarget)
G
Guannan Ren 已提交
2436
VIR_ENUM_DECL(virDomainChrSerialTarget)
E
Eric Blake 已提交
2437
VIR_ENUM_DECL(virDomainSmartcard)
2438
VIR_ENUM_DECL(virDomainChr)
2439
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
2440
VIR_ENUM_DECL(virDomainChrSpicevmc)
2441
VIR_ENUM_DECL(virDomainSoundCodec)
2442
VIR_ENUM_DECL(virDomainSoundModel)
2443
VIR_ENUM_DECL(virDomainMemDump)
2444
VIR_ENUM_DECL(virDomainMemballoonModel)
2445
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
2446 2447
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
2448
VIR_ENUM_DECL(virDomainVideo)
2449 2450
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
2451
VIR_ENUM_DECL(virDomainHostdevCaps)
2452
VIR_ENUM_DECL(virDomainPciRombarMode)
M
Marc-André Lureau 已提交
2453
VIR_ENUM_DECL(virDomainHub)
2454
VIR_ENUM_DECL(virDomainRedirdevBus)
2455 2456 2457
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2458
VIR_ENUM_DECL(virDomainGraphicsListen)
2459
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2460 2461
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2462 2463 2464 2465
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
VIR_ENUM_DECL(virDomainGraphicsSpicePlaybackCompression)
2466
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
2467
VIR_ENUM_DECL(virDomainGraphicsSpiceClipboardCopypaste)
P
Peng Zhou 已提交
2468
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
2469
VIR_ENUM_DECL(virDomainHyperv)
2470 2471
VIR_ENUM_DECL(virDomainRNGModel)
VIR_ENUM_DECL(virDomainRNGBackend)
2472 2473
VIR_ENUM_DECL(virDomainTPMModel)
VIR_ENUM_DECL(virDomainTPMBackend)
2474 2475
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
2476 2477 2478 2479 2480 2481 2482
VIR_ENUM_DECL(virDomainNostateReason)
VIR_ENUM_DECL(virDomainRunningReason)
VIR_ENUM_DECL(virDomainBlockedReason)
VIR_ENUM_DECL(virDomainPausedReason)
VIR_ENUM_DECL(virDomainShutdownReason)
VIR_ENUM_DECL(virDomainShutoffReason)
VIR_ENUM_DECL(virDomainCrashedReason)
2483
VIR_ENUM_DECL(virDomainPMSuspendedReason)
J
Jiri Denemark 已提交
2484 2485 2486 2487

const char *virDomainStateReasonToString(virDomainState state, int reason);
int virDomainStateReasonFromString(virDomainState state, const char *reason);

2488
VIR_ENUM_DECL(virDomainSeclabel)
2489
VIR_ENUM_DECL(virDomainClockOffset)
2490
VIR_ENUM_DECL(virDomainClockBasis)
2491

2492
VIR_ENUM_DECL(virDomainTimerName)
2493
VIR_ENUM_DECL(virDomainTimerTrack)
2494 2495
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
2496
VIR_ENUM_DECL(virDomainCpuPlacementMode)
2497

2498
VIR_ENUM_DECL(virDomainStartupPolicy)
2499

O
Osier Yang 已提交
2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
# define VIR_CONNECT_LIST_DOMAINS_FILTERS_ACTIVE   \
                (VIR_CONNECT_LIST_DOMAINS_ACTIVE | \
                 VIR_CONNECT_LIST_DOMAINS_INACTIVE)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_PERSISTENT   \
                (VIR_CONNECT_LIST_DOMAINS_PERSISTENT | \
                 VIR_CONNECT_LIST_DOMAINS_TRANSIENT)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_STATE     \
                (VIR_CONNECT_LIST_DOMAINS_RUNNING | \
                 VIR_CONNECT_LIST_DOMAINS_PAUSED  | \
                 VIR_CONNECT_LIST_DOMAINS_SHUTOFF | \
                 VIR_CONNECT_LIST_DOMAINS_OTHER)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_MANAGEDSAVE   \
                (VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE | \
                 VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_AUTOSTART   \
                (VIR_CONNECT_LIST_DOMAINS_AUTOSTART | \
                 VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_SNAPSHOT       \
                (VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT | \
                 VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT)

# define VIR_CONNECT_LIST_DOMAINS_FILTERS_ALL                   \
                (VIR_CONNECT_LIST_DOMAINS_FILTERS_ACTIVE      | \
                 VIR_CONNECT_LIST_DOMAINS_FILTERS_PERSISTENT  | \
                 VIR_CONNECT_LIST_DOMAINS_FILTERS_STATE       | \
                 VIR_CONNECT_LIST_DOMAINS_FILTERS_MANAGEDSAVE | \
                 VIR_CONNECT_LIST_DOMAINS_FILTERS_AUTOSTART   | \
                 VIR_CONNECT_LIST_DOMAINS_FILTERS_SNAPSHOT)

2534 2535 2536 2537
int virDomainObjListExport(virDomainObjListPtr doms,
                           virConnectPtr conn,
                           virDomainPtr **domains,
                           unsigned int flags);
O
Osier Yang 已提交
2538

2539 2540 2541
virDomainVcpuPinDefPtr virDomainLookupVcpuPin(virDomainDefPtr def,
                                              int vcpuid);

2542 2543
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

2544
#endif /* __DOMAIN_CONF_H */