domain_conf.h 74.8 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"
50

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/* 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;

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

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
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;

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

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

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

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

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

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

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

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/* 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,
139
    VIR_DOMAIN_DEVICE_RNG,
140

141
    VIR_DOMAIN_DEVICE_LAST
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
} 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;
165
        virDomainRNGDefPtr rng;
166 167 168
    } data;
};

169 170 171 172 173 174 175 176 177 178 179 180 181
/* 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,
182
    VIR_DOMAIN_VIRT_VBOX,
183
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
184
    VIR_DOMAIN_VIRT_PARALLELS,
185

186
    VIR_DOMAIN_VIRT_LAST
187 188
};

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

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

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

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

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

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

228 229 230 231 232 233 234 235 236 237 238 239 240
# 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 已提交
241 242 243 244 245 246 247
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

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

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

262 263 264 265 266 267 268 269 270 271 272 273 274
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;
};

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

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

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

/* 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;
325
    bool implicit;      /* true if seclabel is auto-added */
E
Eric Blake 已提交
326 327
};

328 329 330 331 332

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


339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
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;
};

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

371

372 373 374 375
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

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

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

386 387 388 389

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

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

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

enum virDomainHostdevCapsType {
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,

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


428 429
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
430
    virDomainDeviceDef parent; /* higher level Def containing this */
431
    int mode; /* enum virDomainHostdevMode */
432
    int startupPolicy; /* enum virDomainStartupPolicy */
433
    unsigned int managed : 1;
434
    unsigned int missing : 1;
435
    union {
436
        virDomainHostdevSubsys subsys;
437
        virDomainHostdevCaps caps;
438 439
    } source;
    virDomainHostdevOrigStates origstates;
440
    virDomainDeviceInfoPtr info; /* Guest address */
441 442
};

443 444 445 446
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
447
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
448
    VIR_DOMAIN_DISK_TYPE_NETWORK,
449 450 451 452 453 454 455 456 457

    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,
458
    VIR_DOMAIN_DISK_DEVICE_LUN,
459 460 461 462 463 464 465 466 467 468

    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,
469
    VIR_DOMAIN_DISK_BUS_USB,
470
    VIR_DOMAIN_DISK_BUS_UML,
471
    VIR_DOMAIN_DISK_BUS_SATA,
472 473 474 475

    VIR_DOMAIN_DISK_BUS_LAST
};

476 477 478 479 480
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
481
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
482
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
483 484 485 486

    VIR_DOMAIN_DISK_CACHE_LAST
};

487 488 489
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
490
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
491
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
492
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
493 494 495 496

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
497 498 499 500
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,
501
    VIR_DOMAIN_DISK_PROTOCOL_GLUSTER,
M
MORITA Kazutaka 已提交
502 503 504 505

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

506 507 508 509 510 511 512 513
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
};

514 515 516 517 518 519 520
enum virDomainDiskTray {
    VIR_DOMAIN_DISK_TRAY_CLOSED,
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
};

J
J.B. Joret 已提交
521 522 523 524 525 526 527 528 529
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 已提交
530 531 532 533 534
typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
535 536
    int transport; /* enum virDomainDiskProtocolTransport */
    char *socket;  /* path to unix socket */
M
MORITA Kazutaka 已提交
537 538
};

M
Matthias Dahl 已提交
539 540 541 542 543 544 545 546
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

547 548 549 550 551 552 553 554
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
};

555 556 557 558 559 560 561 562
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 已提交
563 564 565 566 567 568 569 570
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
};

571 572 573 574 575 576 577 578 579
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
};

580 581 582 583 584 585 586 587
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 已提交
588 589 590 591 592 593 594 595
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 已提交
596 597 598 599 600 601 602 603 604 605 606
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;

607 608 609 610 611 612 613
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
614
    int tray_status;
M
MORITA Kazutaka 已提交
615
    int protocol;
616
    size_t nhosts;
M
MORITA Kazutaka 已提交
617
    virDomainDiskHostDefPtr hosts;
618 619 620 621 622 623 624 625
    struct {
        char *username;
        int secretType; /* enum virDomainDiskSecretType */
        union {
            unsigned char uuid[VIR_UUID_BUFLEN];
            char *usage;
        } secret;
    } auth;
626
    char *driverName;
627
    int format; /* enum virStorageFileFormat */
628
    virStorageFileMetadataPtr backingChain;
L
Lei Li 已提交
629

630
    char *mirror;
631
    int mirrorFormat; /* enum virStorageFileFormat */
632 633
    bool mirroring;

J
J.B. Joret 已提交
634 635 636 637 638 639 640
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
        int trans;
    } geometry;

641 642 643
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
644
    } blockio;
645

L
Lei Li 已提交
646 647
    virDomainBlockIoTuneInfo blkdeviotune;

648
    char *serial;
O
Osier Yang 已提交
649
    char *wwn;
650 651
    char *vendor;
    char *product;
652
    int cachemode;
653 654
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
M
Matthias Dahl 已提交
655
    int iomode;
656
    int ioeventfd;
657
    int event_idx;
O
Osier Yang 已提交
658
    int copy_on_read;
E
Eric Blake 已提交
659
    int snapshot; /* enum virDomainSnapshotLocation, snapshot_conf.h */
660
    int startupPolicy; /* enum virDomainStartupPolicy */
661 662
    unsigned int readonly : 1;
    unsigned int shared : 1;
663
    unsigned int transient : 1;
664
    virDomainDeviceInfo info;
665
    virStorageEncryptionPtr encryption;
666 667
    bool rawio_specified;
    int rawio; /* no = 0, yes = 1 */
O
Osier Yang 已提交
668
    int sgio; /* enum virDomainDiskSGIO */
669 670 671

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
672 673 674
};


675 676 677 678 679
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
680
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
681
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
682
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
683 684 685 686

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

687

688 689 690 691 692 693
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,
694
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
695
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
696

697
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
698 699
};

M
Marc-André Lureau 已提交
700 701 702 703 704 705 706 707 708 709
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 已提交
710
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
711
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
712 713 714 715

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

716 717 718 719 720 721 722
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

723 724 725 726
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
    int idx;
727
    int model; /* -1 == undef */
728 729 730
    union {
        virDomainVirtioSerialOpts vioserial;
    } opts;
731 732 733 734
    virDomainDeviceInfo info;
};


735 736
/* Two types of disk backends */
enum virDomainFSType {
737 738 739 740 741 742
    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 */
743 744 745 746

    VIR_DOMAIN_FS_TYPE_LAST
};

747 748 749 750 751 752 753 754 755
/* 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
};

756 757 758 759 760 761 762 763 764
/* 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
};

765 766 767 768 769 770 771 772
/* Filesystem Write policy */
enum virDomainFSWrpolicy {
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
};

773 774 775
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

776 777
struct _virDomainFSDef {
    int type;
778
    int fsdriver;
779
    int accessmode;
780
    int wrpolicy; /* enum virDomainFSWrpolicy */
781
    unsigned long long usage;
782 783 784
    char *src;
    char *dst;
    unsigned int readonly : 1;
785
    virDomainDeviceInfo info;
786 787
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
788 789 790
};


791
/* network config types */
792 793 794 795 796 797 798 799
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 已提交
800
    VIR_DOMAIN_NET_TYPE_INTERNAL,
801
    VIR_DOMAIN_NET_TYPE_DIRECT,
802
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
803

804
    VIR_DOMAIN_NET_TYPE_LAST
805 806
};

807 808 809 810 811 812
/* 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 */

813
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
814
};
815

816 817 818 819 820 821
/* 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,

822
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
823 824
};

825 826 827 828 829 830 831 832 833
/* 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
};

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
/* 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;
851 852 853
        struct {
            virDomainHostdevDef def;
        } hostdev;
854
    } data;
855
    virNetDevVPortProfilePtr virtPortProfile;
856
    virNetDevBandwidthPtr bandwidth;
857
    virNetDevVlan vlan;
858
    unsigned int class_id; /* class ID for bandwidth 'floor' */
859 860
};

861 862
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
S
Stefan Berger 已提交
863
    enum virDomainNetType type;
864
    virMacAddr mac;
865
    char *model;
866 867 868
    union {
        struct {
            enum virDomainNetBackendType name; /* which driver backend to use */
869
            enum virDomainNetVirtioTxModeType txmode;
870
            enum virDomainIoEventFd ioeventfd;
871
            enum virDomainVirtioEventIdx event_idx;
872 873
        } virtio;
    } driver;
874 875 876 877 878 879 880 881 882 883 884
    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;
885 886 887 888 889 890 891 892 893 894
            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;
895 896 897
        } network;
        struct {
            char *brname;
898
            char *ipaddr;
899
        } bridge;
D
Daniel Veillard 已提交
900 901 902
        struct {
            char *name;
        } internal;
903 904
        struct {
            char *linkdev;
905
            int mode; /* enum virMacvtapMode from util/macvtap.h */
906
        } direct;
907 908 909
        struct {
            virDomainHostdevDef def;
        } hostdev;
910
    } data;
911 912
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
913 914 915 916
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
917
    char *script;
918
    char *ifname;
919
    virDomainDeviceInfo info;
920 921
    char *filter;
    virNWFilterHashTablePtr filterparams;
922
    virNetDevBandwidthPtr bandwidth;
923
    virNetDevVlan vlan;
924
    int linkstate;
925 926
};

E
Eric Blake 已提交
927 928 929 930
/* 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"

931
enum virDomainChrDeviceType {
932
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
933 934
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
935
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
936

937
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
938 939
};

G
Guannan Ren 已提交
940 941 942 943 944 945 946
enum virDomainChrSerialTargetType {
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
};

947
enum virDomainChrChannelTargetType {
948 949
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
950 951
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

952
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
953 954
};

955 956 957 958
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 已提交
959
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
960 961
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
962 963
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
964

965
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
966 967
};

968
enum virDomainChrType {
969 970 971 972 973 974 975 976 977 978
    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,
979
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
980

981
    VIR_DOMAIN_CHR_TYPE_LAST
982 983 984 985 986
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
987 988
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
989

990
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
991 992
};

E
Eric Blake 已提交
993 994 995
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
996
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
997

998
    VIR_DOMAIN_CHR_SPICEVMC_LAST
E
Eric Blake 已提交
999 1000
};

1001 1002 1003 1004 1005
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
1006
    union {
E
Eric Blake 已提交
1007
        /* no <source> for null, vc, stdio */
1008 1009 1010 1011 1012 1013
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
1014
            bool listen;
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
1025
            bool listen;
1026
        } nix;
E
Eric Blake 已提交
1027
        int spicevmc;
1028
    } data;
1029 1030 1031 1032 1033
};

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

    bool targetTypeAttr;
1036 1037 1038 1039 1040 1041 1042 1043
    int targetType;
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

    virDomainChrSourceDef source;
1044 1045

    virDomainDeviceInfo info;
1046 1047 1048

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1049 1050
};

E
Eric Blake 已提交
1051 1052 1053 1054 1055
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1056
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
E
Eric Blake 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
};

# 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 已提交
1076 1077 1078 1079 1080
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1081 1082 1083 1084
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

1085
    VIR_DOMAIN_INPUT_TYPE_LAST
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
};

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;
1099
    virDomainDeviceInfo info;
1100 1101
};

1102 1103 1104 1105 1106 1107 1108
enum virDomainSoundCodecType {
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
};

1109 1110 1111 1112
enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1113
    VIR_DOMAIN_SOUND_MODEL_AC97,
1114
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1115 1116 1117 1118

    VIR_DOMAIN_SOUND_MODEL_LAST
};

1119 1120 1121 1122 1123
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1124 1125
struct _virDomainSoundDef {
    int model;
1126
    virDomainDeviceInfo info;
1127

1128
    size_t ncodecs;
1129
    virDomainSoundCodecDefPtr *codecs;
1130 1131
};

R
Richard Jones 已提交
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
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 已提交
1144
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1145 1146 1147 1148 1149 1150 1151 1152
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

struct _virDomainWatchdogDef {
    int model;
    int action;
1153
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1154 1155
};

1156 1157 1158 1159 1160 1161 1162

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,
1163
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1164 1165 1166 1167 1168

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


1169 1170 1171
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1172 1173
    unsigned int support3d :1;
    unsigned int support2d :1;
1174 1175 1176
};


1177 1178
struct _virDomainVideoDef {
    int type;
1179 1180
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1181
    unsigned int heads;
1182
    bool primary;
1183
    virDomainVideoAccelDefPtr accel;
1184
    virDomainDeviceInfo info;
1185 1186
};

1187 1188 1189 1190
/* 3 possible graphics console modes */
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1191 1192
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1193
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1194

1195
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1196 1197
};

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

1207 1208 1209 1210 1211 1212
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 */
1213
    int connected; /* action if connected */
1214 1215
};

1216 1217 1218 1219 1220 1221 1222
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 已提交
1223
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1224
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235

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

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
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 已提交
1275 1276 1277 1278 1279 1280 1281 1282
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
};

1283 1284 1285 1286 1287 1288 1289 1290 1291
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
};

1292 1293 1294 1295 1296 1297 1298 1299
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
};

1300 1301 1302 1303 1304
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

1305
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1306 1307
};

M
Marc-André Lureau 已提交
1308 1309 1310
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

1311
    VIR_DOMAIN_HUB_TYPE_LAST
M
Marc-André Lureau 已提交
1312 1313
};

1314 1315 1316 1317 1318 1319 1320 1321
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
};

1322
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1323 1324 1325 1326 1327
    /* 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.
     */
1328 1329 1330 1331
    int type;
    union {
        struct {
            int port;
1332
            unsigned int autoport :1;
1333
            char *keymap;
1334
            char *socket;
1335
            virDomainGraphicsAuthDef auth;
1336 1337 1338 1339
        } vnc;
        struct {
            char *display;
            char *xauth;
1340
            int fullscreen;
1341
        } sdl;
1342 1343
        struct {
            int port;
1344 1345 1346
            unsigned int autoport :1;
            unsigned int replaceUser :1;
            unsigned int multiUser :1;
1347 1348 1349
        } rdp;
        struct {
            char *display;
1350
            unsigned int fullscreen :1;
1351
        } desktop;
1352 1353 1354
        struct {
            int port;
            int tlsPort;
P
Peng Zhou 已提交
1355
            int mousemode;
1356
            char *keymap;
1357
            virDomainGraphicsAuthDef auth;
1358
            unsigned int autoport :1;
1359
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1360
            int defaultMode; /* enum virDomainGraphicsSpiceChannelMode */
1361 1362 1363 1364
            int image;
            int jpeg;
            int zlib;
            int playback;
1365
            int streaming;
1366
            int copypaste;
1367
        } spice;
1368
    } data;
1369 1370 1371 1372 1373
    /* 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;
1374 1375
};

1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
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 */
};
1391

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
struct _virDomainRedirFilterUsbDevDef {
    int usbClass;
    int vendor;
    int product;
    int version;
    unsigned int allow :1;
};

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

1405 1406 1407 1408 1409 1410 1411 1412
enum virDomainMemDump {
    VIR_DOMAIN_MEM_DUMP_DEFAULT = 0,
    VIR_DOMAIN_MEM_DUMP_ON,
    VIR_DOMAIN_MEM_DUMP_OFF,

    VIR_DOMAIN_MEM_DUMP_LAST,
};

1413 1414 1415
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1416
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


1427
enum virDomainSmbiosMode {
1428
    VIR_DOMAIN_SMBIOS_NONE = 0,
1429 1430 1431 1432 1433 1434 1435
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1436

1437
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1438 1439 1440 1441 1442 1443 1444

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1445
    VIR_DOMAIN_BOOT_LAST
1446 1447
};

1448 1449 1450 1451
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
1452 1453

    VIR_DOMAIN_BOOT_MENU_LAST
1454 1455
};

1456 1457 1458 1459
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1460
    VIR_DOMAIN_FEATURE_HAP,
1461
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1462
    VIR_DOMAIN_FEATURE_PRIVNET,
1463
    VIR_DOMAIN_FEATURE_HYPERV,
1464 1465 1466 1467

    VIR_DOMAIN_FEATURE_LAST
};

1468 1469 1470 1471
enum virDomainFeatureState {
    VIR_DOMAIN_FEATURE_STATE_DEFAULT = 0,
    VIR_DOMAIN_FEATURE_STATE_ON,
    VIR_DOMAIN_FEATURE_STATE_OFF,
1472

1473
    VIR_DOMAIN_FEATURE_STATE_LAST
1474 1475
};

1476 1477 1478 1479 1480 1481
enum virDomainHyperv {
    VIR_DOMAIN_HYPERV_RELAXED = 0,

    VIR_DOMAIN_HYPERV_LAST
};

1482 1483 1484 1485 1486 1487 1488 1489 1490
enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
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
};

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
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)

1514 1515 1516 1517 1518
enum virDomainPMState {
    VIR_DOMAIN_PM_STATE_DEFAULT = 0,
    VIR_DOMAIN_PM_STATE_ENABLED,
    VIR_DOMAIN_PM_STATE_DISABLED,

1519
    VIR_DOMAIN_PM_STATE_LAST
1520 1521
};

M
Michal Privoznik 已提交
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
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;
1532 1533 1534
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1535 1536
};

1537 1538 1539 1540 1541
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
1542
    virArch arch;
1543
    char *machine;
1544
    size_t nBootDevs;
1545
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
1546
    /* enum virDomainBootMenu */
1547
    int bootmenu;
1548
    char *init;
1549
    char **initargv;
1550 1551 1552
    char *kernel;
    char *initrd;
    char *cmdline;
1553
    char *dtb;
1554 1555 1556 1557
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
1558
    int smbios_mode;
1559

M
Michal Privoznik 已提交
1560
    virDomainBIOSDef bios;
1561 1562
};

1563 1564 1565 1566 1567 1568
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 已提交
1569
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1570

1571
    VIR_DOMAIN_TIMER_NAME_LAST
1572 1573
};

1574 1575 1576 1577
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1578

1579
    VIR_DOMAIN_TIMER_TRACK_LAST
1580 1581 1582 1583 1584 1585 1586 1587
};

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

1588
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1589 1590 1591 1592 1593 1594 1595
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1596
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1597

1598
    VIR_DOMAIN_TIMER_MODE_LAST
1599 1600
};

O
Osier Yang 已提交
1601
enum virDomainCpuPlacementMode {
1602
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1603 1604
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1605
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
O
Osier Yang 已提交
1606 1607
};

1608 1609 1610 1611 1612
enum virDomainNumatuneMemPlacementMode {
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_DEFAULT = 0,
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_STATIC,
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_AUTO,

1613
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_LAST
1614 1615
};

1616 1617 1618 1619 1620 1621 1622 1623
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1624 1625 1626 1627 1628 1629 1630
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 */

1631 1632 1633 1634
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1635 1636 1637 1638 1639 1640

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

1641 1642 1643
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1644
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1645
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1646

1647
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1648 1649
};

1650 1651 1652 1653
enum virDomainClockBasis {
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1654
    VIR_DOMAIN_CLOCK_BASIS_LAST
1655 1656
};

1657 1658 1659 1660
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1661

1662
    union {
1663 1664 1665
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
1666
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
1667 1668 1669 1670
        struct {
            long long adjustment;
            int basis;
        } variable;
1671 1672 1673 1674 1675

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

1677
    size_t ntimers;
1678
    virDomainTimerDefPtr *timers;
1679 1680
};

1681
# define VIR_DOMAIN_CPUMASK_LEN 1024
1682

E
Eric Blake 已提交
1683 1684 1685
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1686
    int vcpuid;
H
Hu Tao 已提交
1687
    virBitmapPtr cpumask;
1688 1689
};

H
Hu Tao 已提交
1690 1691
void virDomainVcpuPinDefFree(virDomainVcpuPinDefPtr def);
void virDomainVcpuPinDefArrayFree(virDomainVcpuPinDefPtr *def, int nvcpupin);
1692 1693 1694 1695

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

E
Eric Blake 已提交
1696
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1697 1698 1699
                                int nvcpupin,
                                int vcpu);

E
Eric Blake 已提交
1700
virDomainVcpuPinDefPtr virDomainVcpuPinFindByVcpu(virDomainVcpuPinDefPtr *def,
1701 1702 1703
                                                  int nvcpupin,
                                                  int vcpu);

1704 1705 1706 1707
typedef struct _virDomainNumatuneDef virDomainNumatuneDef;
typedef virDomainNumatuneDef *virDomainNumatuneDefPtr;
struct _virDomainNumatuneDef {
    struct {
1708
        virBitmapPtr nodemask;
1709
        int mode;
1710
        int placement_mode; /* enum virDomainNumatuneMemPlacementMode */
1711 1712 1713 1714 1715
    } memory;

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

1716 1717 1718 1719 1720 1721 1722
typedef struct _virBlkioDeviceWeight virBlkioDeviceWeight;
typedef virBlkioDeviceWeight *virBlkioDeviceWeightPtr;
struct _virBlkioDeviceWeight {
    char *path;
    unsigned int weight;
};

1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
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;
1740 1741
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

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

    virDomainDeviceInfo info;
};

1752 1753 1754 1755
void virBlkioDeviceWeightArrayClear(virBlkioDeviceWeightPtr deviceWeights,
                                    int ndevices);


1756 1757 1758 1759 1760 1761
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1762 1763 1764 1765 1766 1767 1768
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1769
    char *title;
1770
    char *description;
1771

1772 1773
    struct {
        unsigned int weight;
1774 1775 1776

        size_t ndevices;
        virBlkioDeviceWeightPtr devices;
1777 1778
    } blkio;

1779
    struct {
1780 1781 1782
        unsigned long long max_balloon; /* in kibibytes */
        unsigned long long cur_balloon; /* in kibibytes */
        bool hugepage_backed;
1783
        int dump_core; /* enum virDomainMemDump */
1784 1785 1786 1787
        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 */
1788
    } mem;
E
Eric Blake 已提交
1789 1790
    unsigned short vcpus;
    unsigned short maxvcpus;
O
Osier Yang 已提交
1791
    int placement_mode;
H
Hu Tao 已提交
1792
    virBitmapPtr cpumask;
1793

1794 1795
    struct {
        unsigned long shares;
1796 1797
        unsigned long long period;
        long long quota;
1798 1799
        unsigned long long emulator_period;
        long long emulator_quota;
1800
        int nvcpupin;
E
Eric Blake 已提交
1801
        virDomainVcpuPinDefPtr *vcpupin;
T
Tang Chen 已提交
1802
        virDomainVcpuPinDefPtr emulatorpin;
1803 1804
    } cputune;

1805 1806
    virDomainNumatuneDef numatune;

1807 1808 1809 1810 1811
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

1812 1813
    int onLockFailure; /* enum virDomainLockFailureAction */

1814 1815 1816 1817 1818 1819
    struct {
        /* These options are actually type of enum virDomainPMState */
        int s3;
        int s4;
    } pm;

1820 1821 1822
    virDomainOSDef os;
    char *emulator;
    int features;
1823
    /* enum virDomainFeatureState */
1824
    int apic_eoi;
1825 1826
    /* These options are of type virDomainFeatureState */
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
1827

1828
    virDomainClockDef clock;
1829

1830
    size_t ngraphics;
1831
    virDomainGraphicsDefPtr *graphics;
1832

1833
    size_t ndisks;
1834 1835
    virDomainDiskDefPtr *disks;

1836
    size_t ncontrollers;
1837 1838
    virDomainControllerDefPtr *controllers;

1839
    size_t nfss;
1840 1841
    virDomainFSDefPtr *fss;

1842
    size_t nnets;
1843 1844
    virDomainNetDefPtr *nets;

1845
    size_t ninputs;
1846 1847
    virDomainInputDefPtr *inputs;

1848
    size_t nsounds;
1849 1850
    virDomainSoundDefPtr *sounds;

1851
    size_t nvideos;
1852 1853
    virDomainVideoDefPtr *videos;

1854
    size_t nhostdevs;
1855 1856
    virDomainHostdevDefPtr *hostdevs;

1857
    size_t nredirdevs;
1858 1859
    virDomainRedirdevDefPtr *redirdevs;

1860
    size_t nsmartcards;
E
Eric Blake 已提交
1861 1862
    virDomainSmartcardDefPtr *smartcards;

1863
    size_t nserials;
1864 1865
    virDomainChrDefPtr *serials;

1866
    size_t nparallels;
1867 1868
    virDomainChrDefPtr *parallels;

1869
    size_t nchannels;
1870 1871
    virDomainChrDefPtr *channels;

1872
    size_t nconsoles;
1873 1874
    virDomainChrDefPtr *consoles;

1875
    size_t nleases;
1876 1877
    virDomainLeaseDefPtr *leases;

1878
    size_t nhubs;
M
Marc-André Lureau 已提交
1879 1880
    virDomainHubDefPtr *hubs;

1881 1882 1883
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

1884
    /* Only 1 */
R
Richard Jones 已提交
1885
    virDomainWatchdogDefPtr watchdog;
1886
    virDomainMemballoonDefPtr memballoon;
1887
    virCPUDefPtr cpu;
1888
    virSysinfoDefPtr sysinfo;
1889
    virDomainRedirFilterDefPtr redirfilter;
1890
    virDomainRNGDefPtr rng;
1891 1892 1893

    void *namespaceData;
    virDomainXMLNamespace ns;
1894 1895 1896

    /* Application-specific custom metadata */
    xmlNodePtr metadata;
1897 1898
};

1899 1900 1901 1902 1903 1904
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 */
1905
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
1906
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
1907 1908 1909 1910

    VIR_DOMAIN_TAINT_LAST
};

1911
/* Guest VM runtime state */
J
Jiri Denemark 已提交
1912 1913 1914 1915 1916 1917
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

1918 1919 1920
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1921
    virObjectLockable parent;
1922

1923
    pid_t pid;
J
Jiri Denemark 已提交
1924
    virDomainStateReason state;
1925 1926 1927

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1928
    unsigned int updated : 1;
1929 1930 1931

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

1933
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
1934 1935
    virDomainSnapshotObjPtr current_snapshot;

1936 1937
    bool hasManagedSave;

1938 1939
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1940 1941

    int taint;
1942 1943
};

1944 1945
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
1946

1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974

/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
typedef struct _virDomainXMLConf virDomainXMLConf;
typedef virDomainXMLConf *virDomainXMLConfPtr;

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

typedef struct _virDomainXMLPrivateDataCallbacks virDomainXMLPrivateDataCallbacks;
typedef virDomainXMLPrivateDataCallbacks *virDomainXMLPrivateDataCallbacksPtr;
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
};

virDomainXMLConfPtr
virDomainXMLConfNew(virDomainXMLPrivateDataCallbacksPtr priv,
                    virDomainXMLNamespacePtr xmlns);

virDomainXMLNamespacePtr
virDomainXMLConfGetNamespace(virDomainXMLConfPtr xmlconf)
    ATTRIBUTE_NONNULL(1);

1975
static inline bool
D
Daniel P. Berrange 已提交
1976
virDomainObjIsActive(virDomainObjPtr dom)
1977 1978 1979 1980
{
    return dom->def->id != -1;
}

1981 1982
virDomainObjPtr virDomainObjNew(virDomainXMLConfPtr caps)
    ATTRIBUTE_NONNULL(1);
1983

1984
virDomainObjListPtr virDomainObjListNew(void);
1985

1986 1987 1988 1989 1990 1991
virDomainObjPtr virDomainObjListFindByID(const virDomainObjListPtr doms,
                                         int id);
virDomainObjPtr virDomainObjListFindByUUID(const virDomainObjListPtr doms,
                                           const unsigned char *uuid);
virDomainObjPtr virDomainObjListFindByName(const virDomainObjListPtr doms,
                                           const char *name);
1992

1993 1994
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
1995 1996 1997 1998

void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
1999
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2000
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
2001 2002 2003
int virDomainDiskFindControllerModel(virDomainDefPtr def,
                                     virDomainDiskDefPtr disk,
                                     int controllerType);
2004 2005 2006
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2007
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2008
void virDomainFSDefFree(virDomainFSDefPtr def);
2009
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
2010
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2011
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2012
void virDomainChrDefFree(virDomainChrDefPtr def);
2013
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
2014 2015
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
2016
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2017
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2018
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
2019
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2020
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2021 2022
virDomainHostdevDefPtr virDomainHostdevDefAlloc(void);
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2023
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2024
void virDomainHubDefFree(virDomainHubDefPtr def);
2025
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2026
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2027
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2028 2029 2030
virDomainDeviceDefPtr virDomainDeviceDefCopy(virCapsPtr caps,
                                             const virDomainDefPtr def,
                                             virDomainDeviceDefPtr src);
2031 2032
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2033 2034
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
2035
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
2036
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
2037
void virDomainDefClearCCWAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
2038
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
2039

2040
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2041 2042
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2043 2044 2045 2046 2047 2048
                                           void *opaque);

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

2049 2050
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
2051 2052
virDomainChrDefPtr virDomainChrDefNew(void);

2053 2054 2055 2056
enum {
    VIR_DOMAIN_OBJ_LIST_ADD_LIVE = (1 << 0),
    VIR_DOMAIN_OBJ_LIST_ADD_CHECK_LIVE = (1 << 1),
};
2057
virDomainObjPtr virDomainObjListAdd(virDomainObjListPtr doms,
2058
                                    virDomainXMLConfPtr xmlconf,
2059
                                    const virDomainDefPtr def,
2060 2061
                                    unsigned int flags,
                                    virDomainDefPtr *oldDef);
2062 2063
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
2064 2065
                           bool live,
                           virDomainDefPtr *oldDef);
2066
int virDomainObjSetDefTransient(virCapsPtr caps,
2067
                                virDomainXMLConfPtr xmlconf,
2068 2069
                                virDomainObjPtr domain,
                                bool live);
2070 2071
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2072
                             virDomainXMLConfPtr xmlconf,
2073
                             virDomainObjPtr domain);
2074 2075 2076

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
2077
                                virDomainXMLConfPtr xmlconf,
2078 2079 2080 2081
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

2082 2083
virDomainDefPtr virDomainDefCopy(virCapsPtr caps, virDomainXMLConfPtr xmlconf,
                                 virDomainDefPtr src, bool migratable);
2084
virDomainDefPtr
2085 2086
virDomainObjCopyPersistentDef(virCapsPtr caps, virDomainXMLConfPtr xmlconf,
                              virDomainObjPtr dom);
2087

2088 2089
void virDomainObjListRemove(virDomainObjListPtr doms,
                            virDomainObjPtr dom);
2090

2091
virDomainDeviceDefPtr virDomainDeviceDefParse(virCapsPtr caps,
2092
                                              virDomainDefPtr def,
2093
                                              const char *xmlStr,
L
Laine Stump 已提交
2094
                                              unsigned int flags);
2095
virDomainDefPtr virDomainDefParseString(virCapsPtr caps,
2096
                                        virDomainXMLConfPtr xmlconf,
2097
                                        const char *xmlStr,
M
Matthias Bolte 已提交
2098
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2099
                                        unsigned int flags);
2100
virDomainDefPtr virDomainDefParseFile(virCapsPtr caps,
2101
                                      virDomainXMLConfPtr xmlconf,
2102
                                      const char *filename,
M
Matthias Bolte 已提交
2103
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2104
                                      unsigned int flags);
2105
virDomainDefPtr virDomainDefParseNode(virCapsPtr caps,
2106
                                      virDomainXMLConfPtr xmlconf,
2107
                                      xmlDocPtr doc,
2108
                                      xmlNodePtr root,
M
Matthias Bolte 已提交
2109
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2110
                                      unsigned int flags);
2111

2112 2113 2114
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2115
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
2116

2117
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
2118
                         unsigned int flags);
2119 2120 2121
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
2122

2123 2124 2125
int virDomainDefCompatibleDevice(virDomainDefPtr def,
                                 virDomainDeviceDefPtr dev);

2126
int virDomainVcpuPinAdd(virDomainVcpuPinDefPtr **vcpupin_list,
H
Hu Tao 已提交
2127
                        int *nvcpupin,
2128 2129 2130 2131
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
2132
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
2133

2134 2135 2136 2137 2138 2139
int virDomainEmulatorPinAdd(virDomainDefPtr def,
                              unsigned char *cpumap,
                              int maplen);

int virDomainEmulatorPinDel(virDomainDefPtr def);

2140 2141
void virDomainRNGDefFree(virDomainRNGDefPtr def);

2142 2143 2144
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2145 2146 2147 2148
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2149
int virDomainDiskDefAssignAddress(virCapsPtr caps, virDomainDiskDefPtr def);
2150

2151 2152 2153 2154
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
E
Eric Blake 已提交
2155
bool virDomainHasDiskMirror(virDomainObjPtr vm);
2156

2157 2158
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2159
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2160
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2161

L
Laine Stump 已提交
2162
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2163 2164
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2165 2166 2167
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185
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);

2186
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2187 2188
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2189
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2190
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2191
virNetDevVPortProfilePtr
2192
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2193
virNetDevBandwidthPtr
2194
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2195
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2196

2197 2198 2199 2200
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2201 2202
int virDomainControllerFind(virDomainDefPtr def, int type, int idx);
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2203 2204 2205 2206 2207 2208 2209 2210

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def);
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2211 2212 2213 2214 2215
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2216

2217
int virDomainSaveXML(const char *configDir,
2218 2219 2220
                     virDomainDefPtr def,
                     const char *xml);

2221
int virDomainSaveConfig(const char *configDir,
2222
                        virDomainDefPtr def);
2223
int virDomainSaveStatus(virDomainXMLConfPtr xmlconf,
2224
                        const char *statusDir,
2225
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
2226

2227 2228 2229 2230
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2231 2232
int virDomainObjListLoadAllConfigs(virDomainObjListPtr doms,
                                   virCapsPtr caps,
2233
                                   virDomainXMLConfPtr xmlconf,
2234 2235 2236 2237 2238 2239
                                   const char *configDir,
                                   const char *autostartDir,
                                   int liveStatus,
                                   unsigned int expectedVirtTypes,
                                   virDomainLoadConfigNotify notify,
                                   void *opaque);
2240

2241
int virDomainDeleteConfig(const char *configDir,
2242
                          const char *autostartDir,
2243 2244
                          virDomainObjPtr dom);

2245
char *virDomainConfigFile(const char *dir,
2246 2247
                          const char *name);

2248 2249 2250 2251
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2252
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
2253
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2254 2255
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
2256

2257 2258 2259 2260 2261 2262 2263 2264 2265
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

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

2266 2267 2268 2269 2270 2271 2272
typedef int (*virDomainObjListIterator)(virDomainObjPtr dom,
                                        void *opaque);

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

E
Eric Blake 已提交
2273 2274 2275 2276 2277 2278 2279 2280 2281
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

2282 2283 2284 2285 2286 2287 2288 2289 2290
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
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 已提交
2301 2302 2303 2304 2305 2306 2307
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2308 2309 2310 2311 2312 2313
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

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

2314 2315 2316
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2317 2318 2319
virSecurityLabelDefPtr
virDomainDefAddSecurityLabelDef(virDomainDefPtr def, const char *model);

2320 2321 2322
virSecurityDeviceLabelDefPtr
virDomainDiskDefAddSecurityLabelDef(virDomainDiskDefPtr def, const char *model);

2323 2324
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2325

2326 2327
VIR_ENUM_DECL(virDomainTaint)

2328 2329
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
2330
VIR_ENUM_DECL(virDomainBootMenu)
2331
VIR_ENUM_DECL(virDomainFeature)
2332
VIR_ENUM_DECL(virDomainFeatureState)
2333
VIR_ENUM_DECL(virDomainLifecycle)
2334
VIR_ENUM_DECL(virDomainLifecycleCrash)
2335
VIR_ENUM_DECL(virDomainPMState)
2336
VIR_ENUM_DECL(virDomainDevice)
2337
VIR_ENUM_DECL(virDomainDeviceAddress)
2338 2339
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
2340
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
2341
VIR_ENUM_DECL(virDomainDiskBus)
2342
VIR_ENUM_DECL(virDomainDiskCache)
2343
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
2344
VIR_ENUM_DECL(virDomainDiskProtocol)
2345
VIR_ENUM_DECL(virDomainDiskProtocolTransport)
M
Matthias Dahl 已提交
2346
VIR_ENUM_DECL(virDomainDiskIo)
2347
VIR_ENUM_DECL(virDomainDiskSecretType)
O
Osier Yang 已提交
2348
VIR_ENUM_DECL(virDomainDiskSGIO)
2349
VIR_ENUM_DECL(virDomainDiskTray)
2350
VIR_ENUM_DECL(virDomainIoEventFd)
2351
VIR_ENUM_DECL(virDomainVirtioEventIdx)
O
Osier Yang 已提交
2352
VIR_ENUM_DECL(virDomainDiskCopyOnRead)
2353
VIR_ENUM_DECL(virDomainController)
2354
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
2355
VIR_ENUM_DECL(virDomainControllerModelUSB)
2356
VIR_ENUM_DECL(virDomainFS)
2357
VIR_ENUM_DECL(virDomainFSDriverType)
2358
VIR_ENUM_DECL(virDomainFSAccessMode)
2359
VIR_ENUM_DECL(virDomainFSWrpolicy)
2360
VIR_ENUM_DECL(virDomainNet)
2361
VIR_ENUM_DECL(virDomainNetBackend)
2362
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
2363
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
2364
VIR_ENUM_DECL(virDomainChrDevice)
2365
VIR_ENUM_DECL(virDomainChrChannelTarget)
2366
VIR_ENUM_DECL(virDomainChrConsoleTarget)
G
Guannan Ren 已提交
2367
VIR_ENUM_DECL(virDomainChrSerialTarget)
E
Eric Blake 已提交
2368
VIR_ENUM_DECL(virDomainSmartcard)
2369
VIR_ENUM_DECL(virDomainChr)
2370
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
2371
VIR_ENUM_DECL(virDomainChrSpicevmc)
2372
VIR_ENUM_DECL(virDomainSoundCodec)
2373
VIR_ENUM_DECL(virDomainSoundModel)
2374
VIR_ENUM_DECL(virDomainMemDump)
2375
VIR_ENUM_DECL(virDomainMemballoonModel)
2376
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
2377 2378
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
2379
VIR_ENUM_DECL(virDomainVideo)
2380 2381
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
2382
VIR_ENUM_DECL(virDomainHostdevCaps)
2383
VIR_ENUM_DECL(virDomainPciRombarMode)
M
Marc-André Lureau 已提交
2384
VIR_ENUM_DECL(virDomainHub)
2385
VIR_ENUM_DECL(virDomainRedirdevBus)
2386 2387 2388
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2389
VIR_ENUM_DECL(virDomainGraphicsListen)
2390
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2391 2392
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2393 2394 2395 2396
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
VIR_ENUM_DECL(virDomainGraphicsSpicePlaybackCompression)
2397
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
2398
VIR_ENUM_DECL(virDomainGraphicsSpiceClipboardCopypaste)
P
Peng Zhou 已提交
2399
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
2400
VIR_ENUM_DECL(virDomainNumatuneMemMode)
2401
VIR_ENUM_DECL(virDomainNumatuneMemPlacementMode)
2402
VIR_ENUM_DECL(virDomainHyperv)
2403 2404
VIR_ENUM_DECL(virDomainRNGModel)
VIR_ENUM_DECL(virDomainRNGBackend)
2405 2406
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
2407 2408 2409 2410 2411 2412 2413
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)
2414
VIR_ENUM_DECL(virDomainPMSuspendedReason)
J
Jiri Denemark 已提交
2415 2416 2417 2418

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

2419
VIR_ENUM_DECL(virDomainSeclabel)
2420
VIR_ENUM_DECL(virDomainClockOffset)
2421
VIR_ENUM_DECL(virDomainClockBasis)
2422

2423
VIR_ENUM_DECL(virDomainTimerName)
2424
VIR_ENUM_DECL(virDomainTimerTrack)
2425 2426
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
2427
VIR_ENUM_DECL(virDomainCpuPlacementMode)
2428

2429
VIR_ENUM_DECL(virDomainStartupPolicy)
2430

O
Osier Yang 已提交
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
# 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)

2465 2466 2467 2468
int virDomainObjListExport(virDomainObjListPtr doms,
                           virConnectPtr conn,
                           virDomainPtr **domains,
                           unsigned int flags);
O
Osier Yang 已提交
2469

2470 2471 2472
virDomainVcpuPinDefPtr virDomainLookupVcpuPin(virDomainDefPtr def,
                                              int vcpuid);

2473
#endif /* __DOMAIN_CONF_H */