domain_conf.h 62.5 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
4
 * Copyright (C) 2006-2011 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * 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
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * 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 35 36 37
# include "internal.h"
# include "capabilities.h"
# include "storage_encryption_conf.h"
# include "cpu_conf.h"
# include "util.h"
# include "threads.h"
# include "hash.h"
38
# include "virsocketaddr.h"
39 40
# include "nwfilter_params.h"
# include "nwfilter_conf.h"
41
# include "virnetdevmacvlan.h"
42
# include "sysinfo.h"
43 44
# include "virnetdevvportprofile.h"
# include "virnetdevbandwidth.h"
45 46 47 48 49 50 51 52 53 54 55 56 57 58

/* 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,
59
    VIR_DOMAIN_VIRT_VBOX,
60
    VIR_DOMAIN_VIRT_PHYP,
61 62 63 64

    VIR_DOMAIN_VIRT_LAST,
};

65 66 67
enum virDomainDeviceAddressType {
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_NONE,
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_PCI,
68
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_DRIVE,
69
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
70
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCID,
71
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_USB,
72
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_SPAPRVIO,
73 74 75 76

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

77 78 79 80 81 82 83 84
enum virDomainDeviceAddressPciMulti {
    VIR_DOMAIN_DEVICE_ADDRESS_PCI_MULTI_DEFAULT = 0,
    VIR_DOMAIN_DEVICE_ADDRESS_PCI_MULTI_ON,
    VIR_DOMAIN_DEVICE_ADDRESS_PCI_MULTI_OFF,

    VIR_DOMAIN_DEVICE_ADDRESS_PCI_MULTI_LAST
};

85 86 87 88 89 90 91
typedef struct _virDomainDevicePCIAddress virDomainDevicePCIAddress;
typedef virDomainDevicePCIAddress *virDomainDevicePCIAddressPtr;
struct _virDomainDevicePCIAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
92
    int          multi;  /* enum virDomainDeviceAddressPciMulti */
93 94
};

95 96 97 98 99 100 101 102
typedef struct _virDomainDeviceDriveAddress virDomainDeviceDriveAddress;
typedef virDomainDeviceDriveAddress *virDomainDeviceDriveAddressPtr;
struct _virDomainDeviceDriveAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

103 104 105 106 107
typedef struct _virDomainDeviceVirtioSerialAddress virDomainDeviceVirtioSerialAddress;
typedef virDomainDeviceVirtioSerialAddress *virDomainDeviceVirtioSerialAddressPtr;
struct _virDomainDeviceVirtioSerialAddress {
    unsigned int controller;
    unsigned int bus;
108
    unsigned int port;
109 110
};

E
Eric Blake 已提交
111 112 113 114 115 116 117
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

118 119 120 121
typedef struct _virDomainDeviceUSBAddress virDomainDeviceUSBAddress;
typedef virDomainDeviceUSBAddress *virDomainDeviceUSBAddressPtr;
struct _virDomainDeviceUSBAddress {
    unsigned int bus;
122
    char *port;
123 124
};

125 126 127 128 129 130 131
typedef struct _virDomainDeviceSpaprVioAddress virDomainDeviceSpaprVioAddress;
typedef virDomainDeviceSpaprVioAddress *virDomainDeviceSpaprVioAddressPtr;
struct _virDomainDeviceSpaprVioAddress {
    unsigned long long reg;
    bool has_reg;
};

132 133 134 135 136 137 138 139 140 141 142 143 144
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;
};

145 146 147
typedef struct _virDomainDeviceInfo virDomainDeviceInfo;
typedef virDomainDeviceInfo *virDomainDeviceInfoPtr;
struct _virDomainDeviceInfo {
D
Daniel P. Berrange 已提交
148
    char *alias;
149 150 151
    int type;
    union {
        virDomainDevicePCIAddress pci;
152
        virDomainDeviceDriveAddress drive;
153
        virDomainDeviceVirtioSerialAddress vioserial;
E
Eric Blake 已提交
154
        virDomainDeviceCcidAddress ccid;
155
        virDomainDeviceUSBAddress usb;
156
        virDomainDeviceSpaprVioAddress spaprvio;
157
    } addr;
158 159 160 161
    int mastertype;
    union {
        virDomainDeviceUSBMaster usb;
    } master;
162 163
};

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
typedef struct _virDomainHostdevOrigStates virDomainHostdevOrigStates;
typedef virDomainHostdevOrigStates *virDomainHostdevOrigStatesPtr;
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
            unsigned int unbind_from_stub : 1;

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
            unsigned int remove_slot : 1;

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
            unsigned int reprobe :1;
        } pci;

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

189 190 191 192 193 194 195 196 197
typedef struct _virDomainLeaseDef virDomainLeaseDef;
typedef virDomainLeaseDef *virDomainLeaseDefPtr;
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

198

199 200 201 202
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
203
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
204
    VIR_DOMAIN_DISK_TYPE_NETWORK,
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

    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,

    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,
224
    VIR_DOMAIN_DISK_BUS_USB,
225
    VIR_DOMAIN_DISK_BUS_UML,
226
    VIR_DOMAIN_DISK_BUS_SATA,
227 228 229 230

    VIR_DOMAIN_DISK_BUS_LAST
};

231 232 233 234 235
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
236
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
237
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
238 239 240 241

    VIR_DOMAIN_DISK_CACHE_LAST
};

242 243 244
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
245
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
246
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
247
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
248 249 250 251

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
};

M
Matthias Dahl 已提交
267 268 269 270 271 272 273 274
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

275 276 277 278 279 280 281 282
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
};

283 284 285 286 287 288 289 290
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
};

291 292 293 294 295 296 297 298 299
enum virDomainDiskSnapshot {
    VIR_DOMAIN_DISK_SNAPSHOT_DEFAULT = 0,
    VIR_DOMAIN_DISK_SNAPSHOT_NO,
    VIR_DOMAIN_DISK_SNAPSHOT_INTERNAL,
    VIR_DOMAIN_DISK_SNAPSHOT_EXTERNAL,

    VIR_DOMAIN_DISK_SNAPSHOT_LAST
};

300 301 302 303 304
enum virDomainSnapshotState {
    /* Inherit the VIR_DOMAIN_* states from virDomainState.  */
    VIR_DOMAIN_DISK_SNAPSHOT = VIR_DOMAIN_LAST,
};

305 306 307 308 309 310 311 312 313
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
};

314 315 316 317 318 319 320 321
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
};

L
Lei Li 已提交
322 323 324 325 326 327 328 329 330 331 332
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;

333 334 335 336 337 338 339 340 341
/* Stores the virtual disk configuration */
typedef struct _virDomainDiskDef virDomainDiskDef;
typedef virDomainDiskDef *virDomainDiskDefPtr;
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
M
MORITA Kazutaka 已提交
342 343 344
    int protocol;
    int nhosts;
    virDomainDiskHostDefPtr hosts;
345 346 347 348 349 350 351 352
    struct {
        char *username;
        int secretType; /* enum virDomainDiskSecretType */
        union {
            unsigned char uuid[VIR_UUID_BUFLEN];
            char *usage;
        } secret;
    } auth;
353 354
    char *driverName;
    char *driverType;
L
Lei Li 已提交
355 356 357

    virDomainBlockIoTuneInfo blkdeviotune;

358
    char *serial;
359
    int cachemode;
360 361
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
362
    int bootIndex;
M
Matthias Dahl 已提交
363
    int iomode;
364
    int ioeventfd;
365
    int event_idx;
366
    int snapshot; /* enum virDomainDiskSnapshot */
367
    int startupPolicy; /* enum virDomainStartupPolicy */
368 369
    unsigned int readonly : 1;
    unsigned int shared : 1;
370
    unsigned int transient : 1;
371
    virDomainDeviceInfo info;
372
    virStorageEncryptionPtr encryption;
373 374 375
};


376 377 378 379 380
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
381
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
382
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
383
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
384 385 386 387

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

388

389 390 391 392 393 394
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,
395

396
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
397 398
};

M
Marc-André Lureau 已提交
399 400 401 402 403 404 405 406 407 408 409 410 411 412
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,

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

413 414 415 416 417 418 419
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

420 421 422 423 424 425
/* Stores the virtual disk controller configuration */
typedef struct _virDomainControllerDef virDomainControllerDef;
typedef virDomainControllerDef *virDomainControllerDefPtr;
struct _virDomainControllerDef {
    int type;
    int idx;
426
    int model; /* -1 == undef */
427 428 429
    union {
        virDomainVirtioSerialOpts vioserial;
    } opts;
430 431 432 433
    virDomainDeviceInfo info;
};


434 435 436 437 438 439 440 441 442 443
/* Two types of disk backends */
enum virDomainFSType {
    VIR_DOMAIN_FS_TYPE_MOUNT,   /* Better named 'bind' */
    VIR_DOMAIN_FS_TYPE_BLOCK,
    VIR_DOMAIN_FS_TYPE_FILE,
    VIR_DOMAIN_FS_TYPE_TEMPLATE,

    VIR_DOMAIN_FS_TYPE_LAST
};

444 445 446 447 448 449 450 451 452
/* 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
};

453 454 455 456 457 458 459 460 461
/* 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
};

462 463 464 465
typedef struct _virDomainFSDef virDomainFSDef;
typedef virDomainFSDef *virDomainFSDefPtr;
struct _virDomainFSDef {
    int type;
466
    int fsdriver;
467
    int accessmode;
468 469 470
    char *src;
    char *dst;
    unsigned int readonly : 1;
471
    virDomainDeviceInfo info;
472 473 474
};


475 476 477 478 479 480 481 482 483
/* 5 different types of networking config */
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 已提交
484
    VIR_DOMAIN_NET_TYPE_INTERNAL,
485
    VIR_DOMAIN_NET_TYPE_DIRECT,
486 487 488 489

    VIR_DOMAIN_NET_TYPE_LAST,
};

490 491 492 493 494 495 496 497
/* 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 */

    VIR_DOMAIN_NET_BACKEND_TYPE_LAST,
};
498

499 500 501 502 503 504 505 506 507
/* 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,

    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST,
};

508 509 510 511 512 513 514 515 516
/* 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
};

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
/* 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 */
533
            virNetDevVPortProfilePtr virtPortProfile;
534 535
        } direct;
    } data;
536
    virNetDevBandwidthPtr bandwidth;
537 538
};

539 540 541 542
/* Stores the virtual network interface configuration */
typedef struct _virDomainNetDef virDomainNetDef;
typedef virDomainNetDef *virDomainNetDefPtr;
struct _virDomainNetDef {
S
Stefan Berger 已提交
543
    enum virDomainNetType type;
544
    unsigned char mac[VIR_MAC_BUFLEN];
545
    char *model;
546 547 548
    union {
        struct {
            enum virDomainNetBackendType name; /* which driver backend to use */
549
            enum virDomainNetVirtioTxModeType txmode;
550
            enum virDomainIoEventFd ioeventfd;
551
            enum virDomainVirtioEventIdx event_idx;
552 553
        } virtio;
    } driver;
554 555 556 557 558 559 560 561 562 563 564 565
    union {
        struct {
            char *dev;
            char *script;
            char *ipaddr;
        } ethernet;
        struct {
            char *address;
            int port;
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
566
            char *portgroup;
567
            virNetDevVPortProfilePtr virtPortProfile;
568 569 570 571 572 573 574 575 576
            /* 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;
577 578 579
        } network;
        struct {
            char *brname;
580
            char *script;
581
            char *ipaddr;
582
        } bridge;
D
Daniel Veillard 已提交
583 584 585
        struct {
            char *name;
        } internal;
586 587
        struct {
            char *linkdev;
588
            int mode; /* enum virMacvtapMode from util/macvtap.h */
589
            virNetDevVPortProfilePtr virtPortProfile;
590
        } direct;
591
    } data;
592 593 594 595
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
596
    char *ifname;
597
    int bootIndex;
598
    virDomainDeviceInfo info;
599 600
    char *filter;
    virNWFilterHashTablePtr filterparams;
601
    virNetDevBandwidthPtr bandwidth;
602
    int linkstate;
603 604
};

E
Eric Blake 已提交
605 606 607 608
/* 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"

609
enum virDomainChrDeviceType {
610
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
611 612
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
613
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
614

615 616 617 618 619 620 621 622
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST,
};

enum virDomainChrChannelTargetType {
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST,
623 624
};

625 626 627 628
enum virDomainChrConsoleTargetType {
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
629
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
630 631
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
632 633 634 635

    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST,
};

636
enum virDomainChrType {
637 638 639 640 641 642 643 644 645 646
    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,
647
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
648 649 650 651 652 653 654

    VIR_DOMAIN_CHR_TYPE_LAST,
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
655 656
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
657 658 659 660

    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST,
};

E
Eric Blake 已提交
661 662 663
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
664
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
665 666 667 668

    VIR_DOMAIN_CHR_SPICEVMC_LAST,
};

669 670 671 672 673
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
674
    union {
E
Eric Blake 已提交
675
        /* no <source> for null, vc, stdio */
676 677 678 679 680 681
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
682
            bool listen;
683 684 685 686 687 688 689 690 691 692
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
693
            bool listen;
694
        } nix;
E
Eric Blake 已提交
695
        int spicevmc;
696
    } data;
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
};

/* A complete character device, both host and domain views.  */
typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;
struct _virDomainChrDef {
    int deviceType;
    int targetType;
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

    virDomainChrSourceDef source;
712 713

    virDomainDeviceInfo info;
714 715
};

E
Eric Blake 已提交
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

    VIR_DOMAIN_SMARTCARD_TYPE_LAST,
};

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

typedef struct _virDomainSmartcardDef virDomainSmartcardDef;
typedef virDomainSmartcardDef *virDomainSmartcardDefPtr;
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 已提交
743 744 745 746 747 748 749
typedef struct _virDomainHubDef virDomainHubDef;
typedef virDomainHubDef *virDomainHubDefPtr;
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

    VIR_DOMAIN_INPUT_TYPE_LAST,
};

enum virDomainInputBus {
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,

    VIR_DOMAIN_INPUT_BUS_LAST
};

typedef struct _virDomainInputDef virDomainInputDef;
typedef virDomainInputDef *virDomainInputDefPtr;
struct _virDomainInputDef {
    int type;
    int bus;
770
    virDomainDeviceInfo info;
771 772 773 774 775 776
};

enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
777
    VIR_DOMAIN_SOUND_MODEL_AC97,
778
    VIR_DOMAIN_SOUND_MODEL_ICH6,
779 780 781 782 783 784 785 786

    VIR_DOMAIN_SOUND_MODEL_LAST
};

typedef struct _virDomainSoundDef virDomainSoundDef;
typedef virDomainSoundDef *virDomainSoundDefPtr;
struct _virDomainSoundDef {
    int model;
787
    virDomainDeviceInfo info;
788 789
};

R
Richard Jones 已提交
790 791 792 793 794 795 796 797 798 799 800 801
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 已提交
802
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
803 804 805 806 807 808 809 810 811 812
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

typedef struct _virDomainWatchdogDef virDomainWatchdogDef;
typedef virDomainWatchdogDef *virDomainWatchdogDefPtr;
struct _virDomainWatchdogDef {
    int model;
    int action;
813
    virDomainDeviceInfo info;
R
Richard Jones 已提交
814 815
};

816 817 818 819 820 821 822

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,
823
    VIR_DOMAIN_VIDEO_TYPE_QXL,
824 825 826 827 828

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


829 830 831
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
832 833
    unsigned int support3d :1;
    unsigned int support2d :1;
834 835 836
};


837 838 839 840 841 842
typedef struct _virDomainVideoDef virDomainVideoDef;
typedef virDomainVideoDef *virDomainVideoDefPtr;
struct _virDomainVideoDef {
    int type;
    unsigned int vram;
    unsigned int heads;
843
    virDomainVideoAccelDefPtr accel;
844
    virDomainDeviceInfo info;
845 846
};

847 848 849 850
/* 3 possible graphics console modes */
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
851 852
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
853
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
854 855 856 857

    VIR_DOMAIN_GRAPHICS_TYPE_LAST,
};

858 859 860 861 862 863 864 865 866
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
};

867 868 869 870 871 872
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
    unsigned int expires: 1; /* Whether there is an expiry time set */
    time_t validTo;  /* seconds since epoch */
873
    int connected; /* action if connected */
874 875
};

876 877 878 879 880 881 882
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 已提交
883
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
884 885 886 887 888 889 890 891 892 893 894

    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
};
895

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
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
};

934 935 936 937 938 939 940 941 942
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
};

943 944 945 946 947 948 949 950
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
};

951 952 953 954 955 956 957 958
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST,
};

M
Marc-André Lureau 已提交
959 960 961 962 963 964
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

    VIR_DOMAIN_HUB_TYPE_LAST,
};

965 966 967 968 969 970 971 972
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
};

973 974 975 976 977 978 979
typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;
struct _virDomainGraphicsDef {
    int type;
    union {
        struct {
            int port;
980
            unsigned int autoport :1;
981
            char *keymap;
982
            char *socket;
983
            virDomainGraphicsAuthDef auth;
984 985 986 987
        } vnc;
        struct {
            char *display;
            char *xauth;
988
            int fullscreen;
989
        } sdl;
990 991
        struct {
            int port;
992 993 994
            unsigned int autoport :1;
            unsigned int replaceUser :1;
            unsigned int multiUser :1;
995 996 997
        } rdp;
        struct {
            char *display;
998
            unsigned int fullscreen :1;
999
        } desktop;
1000 1001 1002 1003
        struct {
            int port;
            int tlsPort;
            char *keymap;
1004
            virDomainGraphicsAuthDef auth;
1005
            unsigned int autoport :1;
1006
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1007 1008 1009 1010
            int image;
            int jpeg;
            int zlib;
            int playback;
1011
            int streaming;
1012
            int copypaste;
1013
        } spice;
1014
    } data;
1015 1016 1017 1018 1019
    /* 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;
1020 1021
};

1022 1023 1024
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,
1025

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
    VIR_DOMAIN_HOSTDEV_MODE_LAST,
};

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

1036 1037 1038 1039 1040 1041 1042 1043
enum virDomainPciRombarMode {
    VIR_DOMAIN_PCI_ROMBAR_DEFAULT = 0,
    VIR_DOMAIN_PCI_ROMBAR_ON,
    VIR_DOMAIN_PCI_ROMBAR_OFF,

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

1044 1045 1046 1047
typedef struct _virDomainHostdevDef virDomainHostdevDef;
typedef virDomainHostdevDef *virDomainHostdevDefPtr;
struct _virDomainHostdevDef {
    int mode; /* enum virDomainHostdevMode */
1048
    unsigned int managed : 1;
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
    union {
        struct {
            int type; /* enum virDomainHostdevBusType */
            union {
                struct {
                    unsigned bus;
                    unsigned device;

                    unsigned vendor;
                    unsigned product;
                } usb;
1060
                virDomainDevicePCIAddress pci; /* host address */
1061
            } u;
1062 1063 1064 1065 1066
        } subsys;
        struct {
            /* TBD: struct capabilities see:
             * https://www.redhat.com/archives/libvir-list/2008-July/msg00429.html
             */
1067
            int dummy;
1068 1069
        } caps;
    } source;
1070
    int bootIndex;
1071
    virDomainDeviceInfo info; /* Guest address */
1072
    int rombar;               /* enum virDomainPciRombarMode */
1073
    virDomainHostdevOrigStates origstates;
1074
};
1075

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
enum virDomainRedirdevBus {
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
};

typedef struct _virDomainRedirdevDef virDomainRedirdevDef;
typedef virDomainRedirdevDef *virDomainRedirdevDefPtr;
struct _virDomainRedirdevDef {
    int bus; /* enum virDomainRedirdevBus */

    union {
        virDomainChrSourceDef chr;
    } source;

    virDomainDeviceInfo info; /* Guest address */
};
1093 1094 1095 1096

enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1097
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;
struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


1110 1111 1112 1113 1114 1115 1116 1117 1118
enum virDomainSmbiosMode {
    VIR_DOMAIN_SMBIOS_NONE,
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1119 1120 1121
/* Flags for the 'type' field in next struct */
enum virDomainDeviceType {
    VIR_DOMAIN_DEVICE_DISK,
1122
    VIR_DOMAIN_DEVICE_LEASE,
1123
    VIR_DOMAIN_DEVICE_FS,
1124 1125 1126
    VIR_DOMAIN_DEVICE_NET,
    VIR_DOMAIN_DEVICE_INPUT,
    VIR_DOMAIN_DEVICE_SOUND,
1127
    VIR_DOMAIN_DEVICE_VIDEO,
1128
    VIR_DOMAIN_DEVICE_HOSTDEV,
R
Richard Jones 已提交
1129
    VIR_DOMAIN_DEVICE_WATCHDOG,
1130
    VIR_DOMAIN_DEVICE_CONTROLLER,
1131
    VIR_DOMAIN_DEVICE_GRAPHICS,
M
Marc-André Lureau 已提交
1132
    VIR_DOMAIN_DEVICE_HUB,
1133
    VIR_DOMAIN_DEVICE_REDIRDEV,
1134 1135

    VIR_DOMAIN_DEVICE_LAST,
1136 1137 1138 1139 1140 1141 1142 1143
};

typedef struct _virDomainDeviceDef virDomainDeviceDef;
typedef virDomainDeviceDef *virDomainDeviceDefPtr;
struct _virDomainDeviceDef {
    int type;
    union {
        virDomainDiskDefPtr disk;
1144
        virDomainControllerDefPtr controller;
1145
        virDomainLeaseDefPtr lease;
1146
        virDomainFSDefPtr fs;
1147 1148 1149
        virDomainNetDefPtr net;
        virDomainInputDefPtr input;
        virDomainSoundDefPtr sound;
1150
        virDomainVideoDefPtr video;
1151
        virDomainHostdevDefPtr hostdev;
R
Richard Jones 已提交
1152
        virDomainWatchdogDefPtr watchdog;
1153
        virDomainGraphicsDefPtr graphics;
M
Marc-André Lureau 已提交
1154
        virDomainHubDefPtr hub;
1155
        virDomainRedirdevDefPtr redirdev;
1156 1157 1158 1159
    } data;
};


1160
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

    VIR_DOMAIN_BOOT_LAST,
};

1171 1172 1173 1174 1175 1176
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
};

1177 1178 1179 1180
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1181
    VIR_DOMAIN_FEATURE_HAP,
1182
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195

    VIR_DOMAIN_FEATURE_LAST
};

enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
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
};

M
Michal Privoznik 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
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;
};

1219 1220 1221 1222 1223 1224 1225 1226 1227
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
    char *arch;
    char *machine;
    int nBootDevs;
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
1228
    int bootmenu;
1229
    char *init;
1230 1231 1232 1233 1234 1235 1236
    char *kernel;
    char *initrd;
    char *cmdline;
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
1237
    int smbios_mode;
M
Michal Privoznik 已提交
1238
    virDomainBIOSDef bios;
1239 1240
};

1241 1242 1243 1244 1245 1246 1247
enum virDomainSeclabelType {
    VIR_DOMAIN_SECLABEL_DYNAMIC,
    VIR_DOMAIN_SECLABEL_STATIC,

    VIR_DOMAIN_SECLABEL_LAST,
};

1248 1249 1250 1251 1252 1253 1254
/* 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 */
1255
    char *baselabel;    /* base name of label string */
1256
    int type;           /* virDomainSeclabelType */
1257
    bool norelabel;
1258 1259
};

1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
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,

    VIR_DOMAIN_TIMER_NAME_LAST,
};

1270 1271 1272 1273
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1274

1275
    VIR_DOMAIN_TIMER_TRACK_LAST,
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
};

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

    VIR_DOMAIN_TIMER_TICKPOLICY_LAST,
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1292
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1293 1294 1295 1296

    VIR_DOMAIN_TIMER_MODE_LAST,
};

1297 1298 1299 1300 1301 1302 1303 1304
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1305 1306 1307 1308 1309 1310 1311
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 */

1312 1313 1314 1315
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1316 1317 1318 1319 1320 1321

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

1322 1323 1324
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1325
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1326
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1327 1328 1329 1330 1331 1332 1333 1334

    VIR_DOMAIN_CLOCK_OFFSET_LAST,
};

typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1335

1336 1337 1338 1339 1340 1341 1342 1343 1344
    union {
        /* Adjustment in seconds, relative to UTC, when
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
        long long adjustment;

        /* Timezone name, when
         * offset == VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME */
        char *timezone;
    } data;
1345 1346 1347

    int ntimers;
    virDomainTimerDefPtr *timers;
1348 1349
};

1350
# define VIR_DOMAIN_CPUMASK_LEN 1024
1351

E
Eric Blake 已提交
1352 1353 1354
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1355 1356 1357 1358
    int vcpuid;
    char *cpumask;
};

E
Eric Blake 已提交
1359
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1360 1361 1362
                                int nvcpupin,
                                int vcpu);

E
Eric Blake 已提交
1363
virDomainVcpuPinDefPtr virDomainVcpuPinFindByVcpu(virDomainVcpuPinDefPtr *def,
1364 1365 1366
                                                  int nvcpupin,
                                                  int vcpu);

1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
typedef struct _virDomainNumatuneDef virDomainNumatuneDef;
typedef virDomainNumatuneDef *virDomainNumatuneDefPtr;
struct _virDomainNumatuneDef {
    struct {
        char *nodemask;
        int mode;
    } memory;

    /* Future NUMA tuning related stuff should go here. */
};

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
typedef struct _virBlkioDeviceWeight virBlkioDeviceWeight;
typedef virBlkioDeviceWeight *virBlkioDeviceWeightPtr;
struct _virBlkioDeviceWeight {
    char *path;
    unsigned int weight;
};

void virBlkioDeviceWeightArrayClear(virBlkioDeviceWeightPtr deviceWeights,
                                    int ndevices);


1389 1390 1391 1392 1393 1394
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1395 1396 1397 1398 1399 1400 1401
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1402
    char *description;
1403

1404 1405
    struct {
        unsigned int weight;
1406 1407 1408

        size_t ndevices;
        virBlkioDeviceWeightPtr devices;
1409 1410
    } blkio;

1411 1412 1413 1414 1415 1416 1417 1418 1419
    struct {
        unsigned long max_balloon;
        unsigned long cur_balloon;
        unsigned long hugepage_backed;
        unsigned long hard_limit;
        unsigned long soft_limit;
        unsigned long min_guarantee;
        unsigned long swap_hard_limit;
    } mem;
E
Eric Blake 已提交
1420 1421
    unsigned short vcpus;
    unsigned short maxvcpus;
1422 1423 1424
    int cpumasklen;
    char *cpumask;

1425 1426
    struct {
        unsigned long shares;
1427 1428
        unsigned long long period;
        long long quota;
1429
        int nvcpupin;
E
Eric Blake 已提交
1430
        virDomainVcpuPinDefPtr *vcpupin;
1431 1432
    } cputune;

1433 1434
    virDomainNumatuneDef numatune;

1435 1436 1437 1438 1439 1440 1441 1442 1443
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

    virDomainOSDef os;
    char *emulator;
    int features;

1444
    virDomainClockDef clock;
1445

1446 1447
    int ngraphics;
    virDomainGraphicsDefPtr *graphics;
1448 1449 1450 1451

    int ndisks;
    virDomainDiskDefPtr *disks;

1452 1453 1454
    int ncontrollers;
    virDomainControllerDefPtr *controllers;

1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
    int nfss;
    virDomainFSDefPtr *fss;

    int nnets;
    virDomainNetDefPtr *nets;

    int ninputs;
    virDomainInputDefPtr *inputs;

    int nsounds;
    virDomainSoundDefPtr *sounds;

1467 1468 1469
    int nvideos;
    virDomainVideoDefPtr *videos;

1470 1471 1472
    int nhostdevs;
    virDomainHostdevDefPtr *hostdevs;

1473 1474 1475
    int nredirdevs;
    virDomainRedirdevDefPtr *redirdevs;

E
Eric Blake 已提交
1476 1477 1478
    int nsmartcards;
    virDomainSmartcardDefPtr *smartcards;

1479 1480 1481 1482 1483 1484
    int nserials;
    virDomainChrDefPtr *serials;

    int nparallels;
    virDomainChrDefPtr *parallels;

1485 1486 1487
    int nchannels;
    virDomainChrDefPtr *channels;

1488 1489 1490
    int nconsoles;
    virDomainChrDefPtr *consoles;

1491
    size_t nleases;
1492 1493
    virDomainLeaseDefPtr *leases;

M
Marc-André Lureau 已提交
1494 1495 1496
    int nhubs;
    virDomainHubDefPtr *hubs;

1497
    /* Only 1 */
1498
    virSecurityLabelDef seclabel;
R
Richard Jones 已提交
1499
    virDomainWatchdogDefPtr watchdog;
1500
    virDomainMemballoonDefPtr memballoon;
1501
    virCPUDefPtr cpu;
1502
    virSysinfoDefPtr sysinfo;
1503 1504 1505

    void *namespaceData;
    virDomainXMLNamespace ns;
1506 1507
};

1508 1509 1510 1511 1512 1513
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 */
1514
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
1515 1516 1517 1518

    VIR_DOMAIN_TAINT_LAST
};

1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
/* Items related to snapshot state */

/* Stores disk-snapshot information */
typedef struct _virDomainSnapshotDiskDef virDomainSnapshotDiskDef;
typedef virDomainSnapshotDiskDef *virDomainSnapshotDiskDefPtr;
struct _virDomainSnapshotDiskDef {
    char *name; /* name matching the <target dev='...' of the domain */
    int index; /* index within snapshot->dom->disks that matches name */
    int snapshot; /* enum virDomainDiskSnapshot */
    char *file; /* new source file when snapshot is external */
    char *driverType; /* file format type of new file */
};

/* Stores the complete snapshot metadata */
1533 1534 1535
typedef struct _virDomainSnapshotDef virDomainSnapshotDef;
typedef virDomainSnapshotDef *virDomainSnapshotDefPtr;
struct _virDomainSnapshotDef {
1536
    /* Public XML.  */
1537 1538 1539 1540
    char *name;
    char *description;
    char *parent;
    long long creationTime; /* in seconds */
1541
    int state; /* enum virDomainSnapshotState */
1542 1543 1544 1545

    size_t ndisks; /* should not exceed dom->ndisks */
    virDomainSnapshotDiskDef *disks;

1546
    virDomainDefPtr dom;
1547

1548 1549
    /* Internal use.  */
    bool current; /* At most one snapshot in the list should have this set */
1550 1551 1552 1553 1554 1555
};

typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;
struct _virDomainSnapshotObj {
    virDomainSnapshotDefPtr def;
1556

1557 1558 1559 1560
    virDomainSnapshotObjPtr parent; /* NULL if root */
    virDomainSnapshotObjPtr sibling; /* NULL if last child of parent */
    size_t nchildren;
    virDomainSnapshotObjPtr first_child; /* NULL if no children */
1561 1562 1563 1564 1565 1566 1567 1568
};

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;
struct _virDomainSnapshotObjList {
    /* name string -> virDomainSnapshotObj  mapping
     * for O(1), lockless lookup-by-name */
    virHashTable *objs;
1569 1570 1571

    size_t nroots;
    virDomainSnapshotObjPtr first_root;
1572 1573
};

1574 1575
typedef enum {
    VIR_DOMAIN_SNAPSHOT_PARSE_REDEFINE = 1 << 0,
1576 1577
    VIR_DOMAIN_SNAPSHOT_PARSE_DISKS    = 1 << 1,
    VIR_DOMAIN_SNAPSHOT_PARSE_INTERNAL = 1 << 2,
1578 1579
} virDomainSnapshotParseFlags;

1580
virDomainSnapshotDefPtr virDomainSnapshotDefParseString(const char *xmlStr,
1581 1582
                                                        virCapsPtr caps,
                                                        unsigned int expectedVirtTypes,
1583
                                                        unsigned int flags);
1584
void virDomainSnapshotDefFree(virDomainSnapshotDefPtr def);
1585
char *virDomainSnapshotDefFormat(const char *domain_uuid,
1586
                                 virDomainSnapshotDefPtr def,
1587
                                 unsigned int flags,
1588
                                 int internal);
1589 1590 1591
int virDomainSnapshotAlignDisks(virDomainSnapshotDefPtr snapshot,
                                int default_snapshot,
                                bool require_match);
1592 1593 1594 1595 1596
virDomainSnapshotObjPtr virDomainSnapshotAssignDef(virDomainSnapshotObjListPtr snapshots,
                                                   const virDomainSnapshotDefPtr def);

int virDomainSnapshotObjListInit(virDomainSnapshotObjListPtr objs);
int virDomainSnapshotObjListGetNames(virDomainSnapshotObjListPtr snapshots,
1597 1598 1599 1600
                                     char **const names, int maxnames,
                                     unsigned int flags);
int virDomainSnapshotObjListNum(virDomainSnapshotObjListPtr snapshots,
                                unsigned int flags);
1601 1602 1603 1604 1605
int virDomainSnapshotObjListGetNamesFrom(virDomainSnapshotObjPtr snapshot,
                                         char **const names, int maxnames,
                                         unsigned int flags);
int virDomainSnapshotObjListNumFrom(virDomainSnapshotObjPtr snapshot,
                                    unsigned int flags);
1606 1607 1608 1609
virDomainSnapshotObjPtr virDomainSnapshotFindByName(const virDomainSnapshotObjListPtr snapshots,
                                                    const char *name);
void virDomainSnapshotObjListRemove(virDomainSnapshotObjListPtr snapshots,
                                    virDomainSnapshotObjPtr snapshot);
E
Eric Blake 已提交
1610
int virDomainSnapshotForEachChild(virDomainSnapshotObjPtr snapshot,
1611 1612
                                  virHashIterator iter,
                                  void *data);
E
Eric Blake 已提交
1613
int virDomainSnapshotForEachDescendant(virDomainSnapshotObjPtr snapshot,
1614 1615
                                       virHashIterator iter,
                                       void *data);
1616 1617 1618
int virDomainSnapshotUpdateRelations(virDomainSnapshotObjListPtr snapshots);
void virDomainSnapshotDropParent(virDomainSnapshotObjListPtr snapshots,
                                 virDomainSnapshotObjPtr snapshot);
1619

1620
/* Guest VM runtime state */
J
Jiri Denemark 已提交
1621 1622 1623 1624 1625 1626
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

1627 1628 1629
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1630
    virMutex lock;
1631
    int refs;
1632

1633
    int pid;
J
Jiri Denemark 已提交
1634
    virDomainStateReason state;
1635 1636 1637

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1638
    unsigned int updated : 1;
1639 1640 1641

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

C
Chris Lalancette 已提交
1643 1644 1645
    virDomainSnapshotObjList snapshots;
    virDomainSnapshotObjPtr current_snapshot;

1646 1647
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1648 1649

    int taint;
1650 1651
};

1652 1653 1654
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
struct _virDomainObjList {
1655 1656 1657
    /* uuid string -> virDomainObj  mapping
     * for O(1), lockless lookup-by-uuid */
    virHashTable *objs;
1658
};
1659

1660
static inline bool
D
Daniel P. Berrange 已提交
1661
virDomainObjIsActive(virDomainObjPtr dom)
1662 1663 1664 1665
{
    return dom->def->id != -1;
}

1666

1667 1668
int virDomainObjListInit(virDomainObjListPtr objs);
void virDomainObjListDeinit(virDomainObjListPtr objs);
1669

1670
virDomainObjPtr virDomainFindByID(const virDomainObjListPtr doms,
1671
                                  int id);
1672
virDomainObjPtr virDomainFindByUUID(const virDomainObjListPtr doms,
1673
                                    const unsigned char *uuid);
1674
virDomainObjPtr virDomainFindByName(const virDomainObjListPtr doms,
1675 1676
                                    const char *name);

1677 1678
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
1679 1680 1681 1682

void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
1683
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
1684
void virDomainControllerDefFree(virDomainControllerDefPtr def);
1685
void virDomainFSDefFree(virDomainFSDefPtr def);
1686
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
1687
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
1688
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
1689
void virDomainChrDefFree(virDomainChrDefPtr def);
1690
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
1691 1692
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
1693
void virDomainSoundDefFree(virDomainSoundDefPtr def);
1694
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
1695
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
1696
void virDomainVideoDefFree(virDomainVideoDefPtr def);
1697
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
1698
void virDomainHubDefFree(virDomainHubDefPtr def);
1699
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
1700
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
1701 1702 1703
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
int virDomainDevicePCIAddressIsValid(virDomainDevicePCIAddressPtr addr);
1704
int virDomainDeviceDriveAddressIsValid(virDomainDeviceDriveAddressPtr addr);
1705
int virDomainDeviceVirtioSerialAddressIsValid(virDomainDeviceVirtioSerialAddressPtr addr);
1706
int virDomainDeviceUSBAddressIsValid(virDomainDeviceUSBAddressPtr addr);
1707
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
1708
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
1709
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
1710

1711 1712 1713 1714 1715 1716 1717 1718
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
                                           virDomainDeviceInfoPtr dev,
                                           void *opaque);

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

1719
void virDomainDefFree(virDomainDefPtr vm);
1720 1721
void virDomainObjRef(virDomainObjPtr vm);
/* Returns 1 if the object was freed, 0 if more refs exist */
1722
int virDomainObjUnref(virDomainObjPtr vm) ATTRIBUTE_RETURN_CHECK;
1723

M
Michal Novotny 已提交
1724 1725
virDomainChrDefPtr virDomainChrDefNew(void);

1726 1727
/* live == true means def describes an active domain (being migrated or
 * restored) as opposed to a new persistent configuration of the domain */
1728
virDomainObjPtr virDomainAssignDef(virCapsPtr caps,
1729
                                   virDomainObjListPtr doms,
1730 1731
                                   const virDomainDefPtr def,
                                   bool live);
1732 1733 1734
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
                           bool live);
1735
int virDomainObjSetDefTransient(virCapsPtr caps,
1736 1737
                                virDomainObjPtr domain,
                                bool live);
1738 1739 1740
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
                             virDomainObjPtr domain);
1741 1742 1743 1744 1745 1746 1747

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

1748 1749 1750
virDomainDefPtr
virDomainObjCopyPersistentDef(virCapsPtr caps, virDomainObjPtr dom);

1751
void virDomainRemoveInactive(virDomainObjListPtr doms,
1752 1753
                             virDomainObjPtr dom);

1754
virDomainDeviceDefPtr virDomainDeviceDefParse(virCapsPtr caps,
1755
                                              const virDomainDefPtr def,
1756
                                              const char *xmlStr,
L
Laine Stump 已提交
1757
                                              unsigned int flags);
1758
virDomainDefPtr virDomainDefParseString(virCapsPtr caps,
1759
                                        const char *xmlStr,
M
Matthias Bolte 已提交
1760
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
1761
                                        unsigned int flags);
1762
virDomainDefPtr virDomainDefParseFile(virCapsPtr caps,
1763
                                      const char *filename,
M
Matthias Bolte 已提交
1764
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
1765
                                      unsigned int flags);
1766
virDomainDefPtr virDomainDefParseNode(virCapsPtr caps,
1767
                                      xmlDocPtr doc,
1768
                                      xmlNodePtr root,
M
Matthias Bolte 已提交
1769
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
1770
                                      unsigned int flags);
1771

1772 1773 1774
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

1775
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
1776

1777
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
1778
                         unsigned int flags);
1779 1780 1781
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
1782

1783
int virDomainCpuSetParse(const char *str,
1784 1785 1786
                         char sep,
                         char *cpuset,
                         int maxcpu);
1787
char *virDomainCpuSetFormat(char *cpuset,
1788 1789
                            int maxcpu);

E
Eric Blake 已提交
1790
int virDomainVcpuPinAdd(virDomainDefPtr def,
1791 1792 1793 1794
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
1795
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
1796

1797 1798 1799
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
1800 1801 1802 1803
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
1804
int virDomainDiskDefAssignAddress(virCapsPtr caps, virDomainDiskDefPtr def);
1805

1806
void virDomainDiskRemove(virDomainDefPtr def, size_t i);
1807
int virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
1808

1809 1810 1811 1812
int virDomainNetIndexByMac(virDomainDefPtr def, const unsigned char *mac);
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
int virDomainNetRemoveByMac(virDomainDefPtr def, const unsigned char *mac);

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
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);

1831
int virDomainNetGetActualType(virDomainNetDefPtr iface);
1832 1833
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
1834
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
1835
virNetDevVPortProfilePtr
1836
virDomainNetGetActualDirectVirtPortProfile(virDomainNetDefPtr iface);
1837
virNetDevBandwidthPtr
1838
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
1839

1840 1841 1842 1843 1844
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);

1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def);
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
void virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
int virDomainLeaseRemove(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);

1857
int virDomainSaveXML(const char *configDir,
1858 1859 1860
                     virDomainDefPtr def,
                     const char *xml);

1861
int virDomainSaveConfig(const char *configDir,
1862
                        virDomainDefPtr def);
1863
int virDomainSaveStatus(virCapsPtr caps,
1864
                        const char *statusDir,
1865
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
1866

1867 1868 1869 1870
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

1871
int virDomainLoadAllConfigs(virCapsPtr caps,
1872
                            virDomainObjListPtr doms,
1873
                            const char *configDir,
1874
                            const char *autostartDir,
1875
                            int liveStatus,
M
Matthias Bolte 已提交
1876
                            unsigned int expectedVirtTypes,
1877 1878
                            virDomainLoadConfigNotify notify,
                            void *opaque);
1879

1880
int virDomainDeleteConfig(const char *configDir,
1881
                          const char *autostartDir,
1882 1883
                          virDomainObjPtr dom);

1884
char *virDomainConfigFile(const char *dir,
1885 1886
                          const char *name);

1887 1888 1889 1890
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

1891
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
1892 1893
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
1894

1895 1896 1897 1898
int virDomainObjIsDuplicate(virDomainObjListPtr doms,
                            virDomainDefPtr def,
                            unsigned int check_active);

D
Daniel P. Berrange 已提交
1899 1900
void virDomainObjLock(virDomainObjPtr obj);
void virDomainObjUnlock(virDomainObjPtr obj);
1901

1902 1903 1904 1905 1906 1907 1908 1909 1910
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

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

E
Eric Blake 已提交
1911 1912 1913 1914 1915 1916 1917 1918 1919
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

1920 1921 1922 1923 1924 1925 1926 1927 1928
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
typedef int (*virDomainDiskDefPathIterator)(virDomainDiskDefPtr disk,
                                            const char *path,
                                            size_t depth,
                                            void *opaque);

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

J
Jiri Denemark 已提交
1940 1941 1942 1943 1944 1945 1946
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

1947 1948 1949
typedef const char* (*virLifecycleToStringFunc)(int type);
typedef int (*virLifecycleFromStringFunc)(const char *type);

1950 1951
VIR_ENUM_DECL(virDomainTaint)

1952 1953 1954 1955
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
VIR_ENUM_DECL(virDomainFeature)
VIR_ENUM_DECL(virDomainLifecycle)
1956
VIR_ENUM_DECL(virDomainLifecycleCrash)
1957
VIR_ENUM_DECL(virDomainDevice)
1958
VIR_ENUM_DECL(virDomainDeviceAddress)
1959
VIR_ENUM_DECL(virDomainDeviceAddressPciMulti)
1960 1961 1962
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
VIR_ENUM_DECL(virDomainDiskBus)
1963
VIR_ENUM_DECL(virDomainDiskCache)
1964
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
1965
VIR_ENUM_DECL(virDomainDiskProtocol)
M
Matthias Dahl 已提交
1966
VIR_ENUM_DECL(virDomainDiskIo)
1967
VIR_ENUM_DECL(virDomainDiskSecretType)
1968
VIR_ENUM_DECL(virDomainDiskSnapshot)
1969
VIR_ENUM_DECL(virDomainIoEventFd)
1970
VIR_ENUM_DECL(virDomainVirtioEventIdx)
1971
VIR_ENUM_DECL(virDomainController)
1972
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
1973
VIR_ENUM_DECL(virDomainControllerModelUSB)
1974
VIR_ENUM_DECL(virDomainFS)
1975
VIR_ENUM_DECL(virDomainFSDriverType)
1976
VIR_ENUM_DECL(virDomainFSAccessMode)
1977
VIR_ENUM_DECL(virDomainNet)
1978
VIR_ENUM_DECL(virDomainNetBackend)
1979
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
1980
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
1981
VIR_ENUM_DECL(virDomainChrDevice)
1982
VIR_ENUM_DECL(virDomainChrChannelTarget)
1983
VIR_ENUM_DECL(virDomainChrConsoleTarget)
E
Eric Blake 已提交
1984
VIR_ENUM_DECL(virDomainSmartcard)
1985
VIR_ENUM_DECL(virDomainChr)
1986
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
1987
VIR_ENUM_DECL(virDomainChrSpicevmc)
1988
VIR_ENUM_DECL(virDomainSoundModel)
1989
VIR_ENUM_DECL(virDomainMemballoonModel)
1990
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
1991 1992
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
1993
VIR_ENUM_DECL(virDomainVideo)
1994 1995
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
1996
VIR_ENUM_DECL(virDomainPciRombarMode)
M
Marc-André Lureau 已提交
1997
VIR_ENUM_DECL(virDomainHub)
1998
VIR_ENUM_DECL(virDomainRedirdevBus)
1999 2000 2001
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2002
VIR_ENUM_DECL(virDomainGraphicsListen)
2003
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2004 2005
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2006 2007 2008 2009
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
VIR_ENUM_DECL(virDomainGraphicsSpicePlaybackCompression)
2010
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
2011
VIR_ENUM_DECL(virDomainGraphicsSpiceClipboardCopypaste)
2012
VIR_ENUM_DECL(virDomainNumatuneMemMode)
2013
VIR_ENUM_DECL(virDomainSnapshotState)
2014 2015
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
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)

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

2027
VIR_ENUM_DECL(virDomainSeclabel)
2028
VIR_ENUM_DECL(virDomainClockOffset)
2029

2030
VIR_ENUM_DECL(virDomainTimerName)
2031
VIR_ENUM_DECL(virDomainTimerTrack)
2032 2033 2034
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)

2035
VIR_ENUM_DECL(virDomainStartupPolicy)
2036 2037 2038

virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def,
                                    const char *device);
2039
#endif /* __DOMAIN_CONF_H */