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

#ifndef __DOMAIN_CONF_H
25
# define __DOMAIN_CONF_H
26

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

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

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

typedef struct _virDomainControllerDef virDomainControllerDef;
typedef virDomainControllerDef *virDomainControllerDefPtr;

typedef struct _virDomainLeaseDef virDomainLeaseDef;
typedef virDomainLeaseDef *virDomainLeaseDefPtr;

typedef struct _virDomainFSDef virDomainFSDef;
typedef virDomainFSDef *virDomainFSDefPtr;

typedef struct _virDomainNetDef virDomainNetDef;
typedef virDomainNetDef *virDomainNetDefPtr;

typedef struct _virDomainInputDef virDomainInputDef;
typedef virDomainInputDef *virDomainInputDefPtr;

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

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

typedef struct _virDomainVideoDef virDomainVideoDef;
typedef virDomainVideoDef *virDomainVideoDefPtr;

typedef struct _virDomainHostdevDef virDomainHostdevDef;
typedef virDomainHostdevDef *virDomainHostdevDefPtr;

typedef struct _virDomainWatchdogDef virDomainWatchdogDef;
typedef virDomainWatchdogDef *virDomainWatchdogDefPtr;

typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;

typedef struct _virDomainHubDef virDomainHubDef;
typedef virDomainHubDef *virDomainHubDefPtr;

typedef struct _virDomainRedirdevDef virDomainRedirdevDef;
typedef virDomainRedirdevDef *virDomainRedirdevDefPtr;

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

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

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

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

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

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

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

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

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

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

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

187
    VIR_DOMAIN_VIRT_LAST
188 189
};

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

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

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

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

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

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

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

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

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

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

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

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

    VIR_DOMAIN_CONTROLLER_MASTER_LAST
};

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

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

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

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

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

329 330 331 332 333

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


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

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

372

373 374 375 376
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

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

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

387 388 389 390

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

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

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

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


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

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

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

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

    VIR_DOMAIN_DISK_BUS_LAST
};

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

    VIR_DOMAIN_DISK_CACHE_LAST
};

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

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

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

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

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

516 517 518 519 520 521 522
enum virDomainDiskTray {
    VIR_DOMAIN_DISK_TRAY_CLOSED,
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
};

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

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

    VIR_DOMAIN_DISK_IO_LAST
};

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

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

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

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

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

632
    char *mirror;
633
    int mirrorFormat; /* enum virStorageFileFormat */
634 635
    bool mirroring;

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

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

L
Lei Li 已提交
648 649
    virDomainBlockIoTuneInfo blkdeviotune;

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

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
674 675 676
};


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

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

689

690 691 692 693 694 695
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,
696
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
697
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
698
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
699

700
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
701 702
};

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

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

719 720 721 722 723 724 725
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

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


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

    VIR_DOMAIN_FS_TYPE_LAST
};

750 751 752 753 754 755 756 757 758
/* 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
};

759 760 761 762 763 764 765 766 767
/* 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
};

768 769 770 771 772 773 774 775
/* Filesystem Write policy */
enum virDomainFSWrpolicy {
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
};

776 777 778
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

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


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

807
    VIR_DOMAIN_NET_TYPE_LAST
808 809
};

810 811 812 813 814 815
/* 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 */

816
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
817
};
818

819 820 821 822 823 824
/* 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,

825
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
826 827
};

828 829 830 831 832 833 834 835 836
/* 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
};

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

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

E
Eric Blake 已提交
930 931 932 933
/* 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"

934
enum virDomainChrDeviceType {
935
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
936 937
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
938
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
939

940
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
941 942
};

G
Guannan Ren 已提交
943 944 945 946 947 948 949
enum virDomainChrSerialTargetType {
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
};

950
enum virDomainChrChannelTargetType {
951 952
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
953 954
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

955
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
956 957
};

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

968
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
969 970
};

971
enum virDomainChrType {
972 973 974 975 976 977 978 979 980 981
    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,
982
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
983

984
    VIR_DOMAIN_CHR_TYPE_LAST
985 986 987 988 989
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
990 991
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
992

993
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
994 995
};

E
Eric Blake 已提交
996 997 998
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
999
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1000

1001
    VIR_DOMAIN_CHR_SPICEVMC_LAST
E
Eric Blake 已提交
1002 1003
};

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

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

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

    virDomainChrSourceDef source;
1047 1048

    virDomainDeviceInfo info;
1049 1050 1051

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1052 1053
};

E
Eric Blake 已提交
1054 1055 1056 1057 1058
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

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

# 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 已提交
1079 1080 1081 1082 1083
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1084 1085 1086 1087
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

1088
    VIR_DOMAIN_INPUT_TYPE_LAST
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
};

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;
1102
    virDomainDeviceInfo info;
1103 1104
};

1105 1106 1107 1108 1109 1110 1111
enum virDomainSoundCodecType {
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
};

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

    VIR_DOMAIN_SOUND_MODEL_LAST
};

1122 1123 1124 1125 1126
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1127 1128
struct _virDomainSoundDef {
    int model;
1129
    virDomainDeviceInfo info;
1130

1131
    size_t ncodecs;
1132
    virDomainSoundCodecDefPtr *codecs;
1133 1134
};

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

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

struct _virDomainWatchdogDef {
    int model;
    int action;
1156
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1157 1158
};

1159 1160 1161 1162 1163 1164 1165

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,
1166
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1167 1168 1169 1170 1171

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


1172 1173 1174
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1175 1176
    unsigned int support3d :1;
    unsigned int support2d :1;
1177 1178 1179
};


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

1190 1191 1192 1193
/* 3 possible graphics console modes */
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1194 1195
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1196
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1197

1198
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1199 1200
};

1201 1202 1203 1204 1205 1206 1207 1208 1209
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
};

1210 1211 1212 1213 1214 1215
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 */
1216
    int connected; /* action if connected */
1217 1218
};

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

    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
};
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 1275 1276 1277
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 已提交
1278 1279 1280 1281 1282 1283 1284 1285
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
};

1286 1287 1288 1289 1290 1291 1292 1293 1294
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
};

1295 1296 1297 1298 1299 1300 1301 1302
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
};

1303 1304 1305 1306 1307
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

1308
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1309 1310
};

M
Marc-André Lureau 已提交
1311 1312 1313
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

1314
    VIR_DOMAIN_HUB_TYPE_LAST
M
Marc-André Lureau 已提交
1315 1316
};

1317 1318 1319 1320 1321 1322 1323 1324
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
};

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

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

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

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

1408 1409 1410 1411 1412 1413 1414 1415
enum virDomainMemDump {
    VIR_DOMAIN_MEM_DUMP_DEFAULT = 0,
    VIR_DOMAIN_MEM_DUMP_ON,
    VIR_DOMAIN_MEM_DUMP_OFF,

    VIR_DOMAIN_MEM_DUMP_LAST,
};

1416 1417 1418
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1419
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


1430
enum virDomainSmbiosMode {
1431
    VIR_DOMAIN_SMBIOS_NONE = 0,
1432 1433 1434 1435 1436 1437 1438
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1439

1440
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1441 1442 1443 1444 1445 1446 1447

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1448
    VIR_DOMAIN_BOOT_LAST
1449 1450
};

1451 1452 1453 1454
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
1455 1456

    VIR_DOMAIN_BOOT_MENU_LAST
1457 1458
};

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

    VIR_DOMAIN_FEATURE_LAST
};

1471 1472 1473 1474
enum virDomainFeatureState {
    VIR_DOMAIN_FEATURE_STATE_DEFAULT = 0,
    VIR_DOMAIN_FEATURE_STATE_ON,
    VIR_DOMAIN_FEATURE_STATE_OFF,
1475

1476
    VIR_DOMAIN_FEATURE_STATE_LAST
1477 1478
};

1479 1480 1481 1482 1483 1484
enum virDomainHyperv {
    VIR_DOMAIN_HYPERV_RELAXED = 0,

    VIR_DOMAIN_HYPERV_LAST
};

1485 1486 1487 1488 1489 1490 1491 1492 1493
enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
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
};

1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
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)

1517 1518 1519 1520 1521
enum virDomainPMState {
    VIR_DOMAIN_PM_STATE_DEFAULT = 0,
    VIR_DOMAIN_PM_STATE_ENABLED,
    VIR_DOMAIN_PM_STATE_DISABLED,

1522
    VIR_DOMAIN_PM_STATE_LAST
1523 1524
};

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

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

M
Michal Privoznik 已提交
1563
    virDomainBIOSDef bios;
1564 1565
};

1566 1567 1568 1569 1570 1571
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 已提交
1572
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1573

1574
    VIR_DOMAIN_TIMER_NAME_LAST
1575 1576
};

1577 1578 1579 1580
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1581

1582
    VIR_DOMAIN_TIMER_TRACK_LAST
1583 1584 1585 1586 1587 1588 1589 1590
};

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

1591
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1592 1593 1594 1595 1596 1597 1598
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1599
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1600

1601
    VIR_DOMAIN_TIMER_MODE_LAST
1602 1603
};

O
Osier Yang 已提交
1604
enum virDomainCpuPlacementMode {
1605
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1606 1607
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1608
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
O
Osier Yang 已提交
1609 1610
};

1611 1612 1613 1614 1615 1616 1617 1618
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1619 1620 1621 1622 1623 1624 1625
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 */

1626 1627 1628 1629
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1630 1631 1632 1633 1634 1635

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

1636 1637 1638
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1639
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1640
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1641

1642
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1643 1644
};

1645 1646 1647 1648
enum virDomainClockBasis {
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1649
    VIR_DOMAIN_CLOCK_BASIS_LAST
1650 1651
};

1652 1653 1654 1655
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1656

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

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

1672
    size_t ntimers;
1673
    virDomainTimerDefPtr *timers;
1674 1675
};

1676
# define VIR_DOMAIN_CPUMASK_LEN 1024
1677

E
Eric Blake 已提交
1678 1679 1680
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1681
    int vcpuid;
H
Hu Tao 已提交
1682
    virBitmapPtr cpumask;
1683 1684
};

H
Hu Tao 已提交
1685 1686
void virDomainVcpuPinDefFree(virDomainVcpuPinDefPtr def);
void virDomainVcpuPinDefArrayFree(virDomainVcpuPinDefPtr *def, int nvcpupin);
1687 1688 1689 1690

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

E
Eric Blake 已提交
1691
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1692 1693 1694
                                int nvcpupin,
                                int vcpu);

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

1699 1700 1701 1702 1703 1704 1705
typedef struct _virBlkioDeviceWeight virBlkioDeviceWeight;
typedef virBlkioDeviceWeight *virBlkioDeviceWeightPtr;
struct _virBlkioDeviceWeight {
    char *path;
    unsigned int weight;
};

1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
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;
1723 1724
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734

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

    virDomainDeviceInfo info;
};

1735 1736 1737 1738
void virBlkioDeviceWeightArrayClear(virBlkioDeviceWeightPtr deviceWeights,
                                    int ndevices);


1739 1740 1741 1742 1743 1744
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1745 1746 1747 1748 1749 1750 1751
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1752
    char *title;
1753
    char *description;
1754

1755 1756
    struct {
        unsigned int weight;
1757 1758 1759

        size_t ndevices;
        virBlkioDeviceWeightPtr devices;
1760 1761
    } blkio;

1762
    struct {
1763 1764 1765
        unsigned long long max_balloon; /* in kibibytes */
        unsigned long long cur_balloon; /* in kibibytes */
        bool hugepage_backed;
1766
        int dump_core; /* enum virDomainMemDump */
1767 1768 1769 1770
        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 */
1771
    } mem;
E
Eric Blake 已提交
1772 1773
    unsigned short vcpus;
    unsigned short maxvcpus;
O
Osier Yang 已提交
1774
    int placement_mode;
H
Hu Tao 已提交
1775
    virBitmapPtr cpumask;
1776

1777 1778
    struct {
        unsigned long shares;
1779 1780
        unsigned long long period;
        long long quota;
1781 1782
        unsigned long long emulator_period;
        long long emulator_quota;
1783
        int nvcpupin;
E
Eric Blake 已提交
1784
        virDomainVcpuPinDefPtr *vcpupin;
T
Tang Chen 已提交
1785
        virDomainVcpuPinDefPtr emulatorpin;
1786 1787
    } cputune;

G
Gao feng 已提交
1788
    virNumaTuneDef numatune;
1789

1790 1791 1792 1793 1794
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

1795 1796
    int onLockFailure; /* enum virDomainLockFailureAction */

1797 1798 1799 1800 1801 1802
    struct {
        /* These options are actually type of enum virDomainPMState */
        int s3;
        int s4;
    } pm;

1803 1804 1805
    virDomainOSDef os;
    char *emulator;
    int features;
1806
    /* enum virDomainFeatureState */
1807
    int apic_eoi;
1808 1809
    /* These options are of type virDomainFeatureState */
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
1810

1811
    virDomainClockDef clock;
1812

1813
    size_t ngraphics;
1814
    virDomainGraphicsDefPtr *graphics;
1815

1816
    size_t ndisks;
1817 1818
    virDomainDiskDefPtr *disks;

1819
    size_t ncontrollers;
1820 1821
    virDomainControllerDefPtr *controllers;

1822
    size_t nfss;
1823 1824
    virDomainFSDefPtr *fss;

1825
    size_t nnets;
1826 1827
    virDomainNetDefPtr *nets;

1828
    size_t ninputs;
1829 1830
    virDomainInputDefPtr *inputs;

1831
    size_t nsounds;
1832 1833
    virDomainSoundDefPtr *sounds;

1834
    size_t nvideos;
1835 1836
    virDomainVideoDefPtr *videos;

1837
    size_t nhostdevs;
1838 1839
    virDomainHostdevDefPtr *hostdevs;

1840
    size_t nredirdevs;
1841 1842
    virDomainRedirdevDefPtr *redirdevs;

1843
    size_t nsmartcards;
E
Eric Blake 已提交
1844 1845
    virDomainSmartcardDefPtr *smartcards;

1846
    size_t nserials;
1847 1848
    virDomainChrDefPtr *serials;

1849
    size_t nparallels;
1850 1851
    virDomainChrDefPtr *parallels;

1852
    size_t nchannels;
1853 1854
    virDomainChrDefPtr *channels;

1855
    size_t nconsoles;
1856 1857
    virDomainChrDefPtr *consoles;

1858
    size_t nleases;
1859 1860
    virDomainLeaseDefPtr *leases;

1861
    size_t nhubs;
M
Marc-André Lureau 已提交
1862 1863
    virDomainHubDefPtr *hubs;

1864 1865 1866
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

1867
    /* Only 1 */
R
Richard Jones 已提交
1868
    virDomainWatchdogDefPtr watchdog;
1869
    virDomainMemballoonDefPtr memballoon;
1870
    virCPUDefPtr cpu;
1871
    virSysinfoDefPtr sysinfo;
1872
    virDomainRedirFilterDefPtr redirfilter;
1873
    virDomainRNGDefPtr rng;
1874 1875 1876

    void *namespaceData;
    virDomainXMLNamespace ns;
1877 1878 1879

    /* Application-specific custom metadata */
    xmlNodePtr metadata;
1880 1881
};

1882 1883 1884 1885 1886 1887
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 */
1888
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
1889
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
1890 1891 1892 1893

    VIR_DOMAIN_TAINT_LAST
};

1894
/* Guest VM runtime state */
J
Jiri Denemark 已提交
1895 1896 1897 1898 1899 1900
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

1901 1902 1903
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1904
    virObjectLockable parent;
1905

1906
    pid_t pid;
J
Jiri Denemark 已提交
1907
    virDomainStateReason state;
1908 1909 1910

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1911
    unsigned int updated : 1;
1912 1913 1914

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

1916
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
1917 1918
    virDomainSnapshotObjPtr current_snapshot;

1919 1920
    bool hasManagedSave;

1921 1922
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1923 1924

    int taint;
1925 1926
};

1927 1928
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
1929

1930 1931 1932

/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
1933 1934
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949

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

1950 1951
virDomainXMLOptionPtr
virDomainXMLOptionNew(virDomainXMLPrivateDataCallbacksPtr priv,
1952 1953 1954
                    virDomainXMLNamespacePtr xmlns);

virDomainXMLNamespacePtr
1955
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
1956 1957
    ATTRIBUTE_NONNULL(1);

1958
static inline bool
D
Daniel P. Berrange 已提交
1959
virDomainObjIsActive(virDomainObjPtr dom)
1960 1961 1962 1963
{
    return dom->def->id != -1;
}

1964
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
1965
    ATTRIBUTE_NONNULL(1);
1966

1967
virDomainObjListPtr virDomainObjListNew(void);
1968

1969 1970 1971 1972 1973 1974
virDomainObjPtr virDomainObjListFindByID(const virDomainObjListPtr doms,
                                         int id);
virDomainObjPtr virDomainObjListFindByUUID(const virDomainObjListPtr doms,
                                           const unsigned char *uuid);
virDomainObjPtr virDomainObjListFindByName(const virDomainObjListPtr doms,
                                           const char *name);
1975

1976 1977
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
1978 1979 1980 1981

void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
1982
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
1983
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
1984 1985 1986
int virDomainDiskFindControllerModel(virDomainDefPtr def,
                                     virDomainDiskDefPtr disk,
                                     int controllerType);
1987 1988 1989
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
1990
void virDomainControllerDefFree(virDomainControllerDefPtr def);
1991
void virDomainFSDefFree(virDomainFSDefPtr def);
1992
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
1993
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
1994
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
1995
void virDomainChrDefFree(virDomainChrDefPtr def);
1996
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
1997 1998
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
1999
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2000
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2001
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
2002
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2003
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2004 2005
virDomainHostdevDefPtr virDomainHostdevDefAlloc(void);
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2006
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2007
void virDomainHubDefFree(virDomainHubDefPtr def);
2008
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2009
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2010
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2011 2012 2013
virDomainDeviceDefPtr virDomainDeviceDefCopy(virCapsPtr caps,
                                             const virDomainDefPtr def,
                                             virDomainDeviceDefPtr src);
2014 2015
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2016 2017
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
2018
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
2019
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
2020
void virDomainDefClearCCWAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
2021
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
2022

2023
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2024 2025
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2026 2027 2028 2029 2030 2031
                                           void *opaque);

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

2032 2033
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
2034 2035
virDomainChrDefPtr virDomainChrDefNew(void);

2036 2037 2038 2039
enum {
    VIR_DOMAIN_OBJ_LIST_ADD_LIVE = (1 << 0),
    VIR_DOMAIN_OBJ_LIST_ADD_CHECK_LIVE = (1 << 1),
};
2040
virDomainObjPtr virDomainObjListAdd(virDomainObjListPtr doms,
2041
                                    virDomainXMLOptionPtr xmlopt,
2042
                                    const virDomainDefPtr def,
2043 2044
                                    unsigned int flags,
                                    virDomainDefPtr *oldDef);
2045 2046
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
2047 2048
                           bool live,
                           virDomainDefPtr *oldDef);
2049
int virDomainObjSetDefTransient(virCapsPtr caps,
2050
                                virDomainXMLOptionPtr xmlopt,
2051 2052
                                virDomainObjPtr domain,
                                bool live);
2053 2054
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2055
                             virDomainXMLOptionPtr xmlopt,
2056
                             virDomainObjPtr domain);
2057 2058 2059

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
2060
                                virDomainXMLOptionPtr xmlopt,
2061 2062 2063 2064
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

2065
virDomainDefPtr virDomainDefCopy(virCapsPtr caps, virDomainXMLOptionPtr xmlopt,
2066
                                 virDomainDefPtr src, bool migratable);
2067
virDomainDefPtr
2068
virDomainObjCopyPersistentDef(virCapsPtr caps, virDomainXMLOptionPtr xmlopt,
2069
                              virDomainObjPtr dom);
2070

2071 2072
void virDomainObjListRemove(virDomainObjListPtr doms,
                            virDomainObjPtr dom);
2073

2074
virDomainDeviceDefPtr virDomainDeviceDefParse(virCapsPtr caps,
2075
                                              virDomainDefPtr def,
2076
                                              const char *xmlStr,
L
Laine Stump 已提交
2077
                                              unsigned int flags);
2078
virDomainDefPtr virDomainDefParseString(virCapsPtr caps,
2079
                                        virDomainXMLOptionPtr xmlopt,
2080
                                        const char *xmlStr,
M
Matthias Bolte 已提交
2081
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2082
                                        unsigned int flags);
2083
virDomainDefPtr virDomainDefParseFile(virCapsPtr caps,
2084
                                      virDomainXMLOptionPtr xmlopt,
2085
                                      const char *filename,
M
Matthias Bolte 已提交
2086
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2087
                                      unsigned int flags);
2088
virDomainDefPtr virDomainDefParseNode(virCapsPtr caps,
2089
                                      virDomainXMLOptionPtr xmlopt,
2090
                                      xmlDocPtr doc,
2091
                                      xmlNodePtr root,
M
Matthias Bolte 已提交
2092
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2093
                                      unsigned int flags);
2094

2095 2096 2097
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2098
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
2099

2100
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
2101
                         unsigned int flags);
2102 2103 2104
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
2105

2106 2107 2108
int virDomainDefCompatibleDevice(virDomainDefPtr def,
                                 virDomainDeviceDefPtr dev);

2109
int virDomainVcpuPinAdd(virDomainVcpuPinDefPtr **vcpupin_list,
H
Hu Tao 已提交
2110
                        int *nvcpupin,
2111 2112 2113 2114
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
2115
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
2116

2117 2118 2119 2120 2121 2122
int virDomainEmulatorPinAdd(virDomainDefPtr def,
                              unsigned char *cpumap,
                              int maplen);

int virDomainEmulatorPinDel(virDomainDefPtr def);

2123 2124
void virDomainRNGDefFree(virDomainRNGDefPtr def);

2125 2126 2127
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2128 2129 2130 2131
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2132
int virDomainDiskDefAssignAddress(virCapsPtr caps, virDomainDiskDefPtr def);
2133

2134 2135 2136 2137
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
E
Eric Blake 已提交
2138
bool virDomainHasDiskMirror(virDomainObjPtr vm);
2139

2140 2141
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2142
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2143
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2144

L
Laine Stump 已提交
2145
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2146 2147
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2148 2149 2150
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
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);

2169
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2170 2171
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2172
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2173
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2174
virNetDevVPortProfilePtr
2175
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2176
virNetDevBandwidthPtr
2177
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2178
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2179

2180 2181 2182 2183
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2184 2185
int virDomainControllerFind(virDomainDefPtr def, int type, int idx);
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2186 2187 2188 2189 2190 2191 2192 2193

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def);
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2194 2195 2196 2197 2198
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2199

2200
int virDomainSaveXML(const char *configDir,
2201 2202 2203
                     virDomainDefPtr def,
                     const char *xml);

2204
int virDomainSaveConfig(const char *configDir,
2205
                        virDomainDefPtr def);
2206
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
2207
                        const char *statusDir,
2208
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
2209

2210 2211 2212 2213
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2214 2215
int virDomainObjListLoadAllConfigs(virDomainObjListPtr doms,
                                   virCapsPtr caps,
2216
                                   virDomainXMLOptionPtr xmlopt,
2217 2218 2219 2220 2221 2222
                                   const char *configDir,
                                   const char *autostartDir,
                                   int liveStatus,
                                   unsigned int expectedVirtTypes,
                                   virDomainLoadConfigNotify notify,
                                   void *opaque);
2223

2224
int virDomainDeleteConfig(const char *configDir,
2225
                          const char *autostartDir,
2226 2227
                          virDomainObjPtr dom);

2228
char *virDomainConfigFile(const char *dir,
2229 2230
                          const char *name);

2231 2232 2233 2234
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2235
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
2236
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2237 2238
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
2239

2240 2241 2242 2243 2244 2245 2246 2247 2248
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

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

2249 2250 2251 2252 2253 2254 2255
typedef int (*virDomainObjListIterator)(virDomainObjPtr dom,
                                        void *opaque);

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

E
Eric Blake 已提交
2256 2257 2258 2259 2260 2261 2262 2263 2264
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

2265 2266 2267 2268 2269 2270 2271 2272 2273
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
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 已提交
2284 2285 2286 2287 2288 2289 2290
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2291 2292 2293 2294 2295 2296
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

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

2297 2298 2299
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2300
virSecurityLabelDefPtr
2301
virDomainDefGenSecurityLabelDef(const char *model);
2302

2303
virSecurityDeviceLabelDefPtr
2304 2305 2306 2307
virDomainDiskDefGenSecurityLabelDef(const char *model);

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

2309 2310
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2311

2312 2313
VIR_ENUM_DECL(virDomainTaint)

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

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

2403
VIR_ENUM_DECL(virDomainSeclabel)
2404
VIR_ENUM_DECL(virDomainClockOffset)
2405
VIR_ENUM_DECL(virDomainClockBasis)
2406

2407
VIR_ENUM_DECL(virDomainTimerName)
2408
VIR_ENUM_DECL(virDomainTimerTrack)
2409 2410
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
2411
VIR_ENUM_DECL(virDomainCpuPlacementMode)
2412

2413
VIR_ENUM_DECL(virDomainStartupPolicy)
2414

O
Osier Yang 已提交
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
# 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)

2449 2450 2451 2452
int virDomainObjListExport(virDomainObjListPtr doms,
                           virConnectPtr conn,
                           virDomainPtr **domains,
                           unsigned int flags);
O
Osier Yang 已提交
2453

2454 2455 2456
virDomainVcpuPinDefPtr virDomainLookupVcpuPin(virDomainDefPtr def,
                                              int vcpuid);

2457
#endif /* __DOMAIN_CONF_H */