domain_conf.h 70.9 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
E
Eric Blake 已提交
4
 * Copyright (C) 2006-2012 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 40
# include "nwfilter_params.h"
# include "nwfilter_conf.h"
41
# include "virnetdevmacvlan.h"
42
# include "virsysinfo.h"
43
# include "virnetdevvportprofile.h"
A
Ansis Atteka 已提交
44
# include "virnetdevopenvswitch.h"
45
# include "virnetdevbandwidth.h"
46
# include "virnetdevvlan.h"
47
# include "virobject.h"
48
# include "device_conf.h"
49
# include "virbitmap.h"
50
# include "virstoragefile.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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* 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,

138
    VIR_DOMAIN_DEVICE_LAST
139 140 141 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;
    } data;
};

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

182
    VIR_DOMAIN_VIRT_LAST
183 184
};

185 186 187
enum virDomainDeviceAddressType {
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_NONE,
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_PCI,
188
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_DRIVE,
189
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
190
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCID,
191
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_USB,
192
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_SPAPRVIO,
193
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_S390,
194 195 196 197

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

198 199 200 201 202 203 204 205
enum virDomainPciRombarMode {
    VIR_DOMAIN_PCI_ROMBAR_DEFAULT = 0,
    VIR_DOMAIN_PCI_ROMBAR_ON,
    VIR_DOMAIN_PCI_ROMBAR_OFF,

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

206 207 208 209 210
typedef struct _virDomainDeviceDriveAddress virDomainDeviceDriveAddress;
typedef virDomainDeviceDriveAddress *virDomainDeviceDriveAddressPtr;
struct _virDomainDeviceDriveAddress {
    unsigned int controller;
    unsigned int bus;
211
    unsigned int target;
212 213 214
    unsigned int unit;
};

215 216 217 218 219
typedef struct _virDomainDeviceVirtioSerialAddress virDomainDeviceVirtioSerialAddress;
typedef virDomainDeviceVirtioSerialAddress *virDomainDeviceVirtioSerialAddressPtr;
struct _virDomainDeviceVirtioSerialAddress {
    unsigned int controller;
    unsigned int bus;
220
    unsigned int port;
221 222
};

E
Eric Blake 已提交
223 224 225 226 227 228 229
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

230 231 232 233
typedef struct _virDomainDeviceUSBAddress virDomainDeviceUSBAddress;
typedef virDomainDeviceUSBAddress *virDomainDeviceUSBAddressPtr;
struct _virDomainDeviceUSBAddress {
    unsigned int bus;
234
    char *port;
235 236
};

237 238 239 240 241 242 243
typedef struct _virDomainDeviceSpaprVioAddress virDomainDeviceSpaprVioAddress;
typedef virDomainDeviceSpaprVioAddress *virDomainDeviceSpaprVioAddressPtr;
struct _virDomainDeviceSpaprVioAddress {
    unsigned long long reg;
    bool has_reg;
};

244 245 246 247 248 249 250 251 252 253 254 255 256
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;
};

257 258 259
typedef struct _virDomainDeviceInfo virDomainDeviceInfo;
typedef virDomainDeviceInfo *virDomainDeviceInfoPtr;
struct _virDomainDeviceInfo {
260 261 262 263
    /* If adding to this struct, ensure that
     * virDomainDeviceInfoIsSet() is updated
     * to consider the new fields
     */
D
Daniel P. Berrange 已提交
264
    char *alias;
265 266
    int type;
    union {
267
        virDevicePCIAddress pci;
268
        virDomainDeviceDriveAddress drive;
269
        virDomainDeviceVirtioSerialAddress vioserial;
E
Eric Blake 已提交
270
        virDomainDeviceCcidAddress ccid;
271
        virDomainDeviceUSBAddress usb;
272
        virDomainDeviceSpaprVioAddress spaprvio;
273
    } addr;
274 275 276 277
    int mastertype;
    union {
        virDomainDeviceUSBMaster usb;
    } master;
278 279
    /* rombar and romfile are only used for pci hostdev and network
     * devices. */
280
    int rombar;         /* enum virDomainPciRombarMode */
281
    char *romfile;
282 283
    /* bootIndex is only used for disk, network interface, hostdev
     * and redirdev devices */
284
    int bootIndex;
285 286
};

E
Eric Blake 已提交
287
enum virDomainSeclabelType {
288 289
    VIR_DOMAIN_SECLABEL_DEFAULT,
    VIR_DOMAIN_SECLABEL_NONE,
E
Eric Blake 已提交
290 291 292
    VIR_DOMAIN_SECLABEL_DYNAMIC,
    VIR_DOMAIN_SECLABEL_STATIC,

293
    VIR_DOMAIN_SECLABEL_LAST
E
Eric Blake 已提交
294 295 296 297 298 299 300 301 302 303 304 305
};

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

309 310 311 312 313

/* Security configuration for domain */
typedef struct _virSecurityDeviceLabelDef virSecurityDeviceLabelDef;
typedef virSecurityDeviceLabelDef *virSecurityDeviceLabelDefPtr;
struct _virSecurityDeviceLabelDef {
314
    char *model;
315 316 317 318 319
    char *label;        /* image label string */
    bool norelabel;
};


320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
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;
};

345 346 347 348 349 350 351
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

352

353 354 355 356
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

357
    VIR_DOMAIN_HOSTDEV_MODE_LAST
358 359 360 361 362 363 364 365 366
};

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

367 368 369 370

typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys;
typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr;
struct _virDomainHostdevSubsys {
371
    int type; /* enum virDomainHostdevSubsysType */
372 373
    union {
        struct {
374 375
            bool autoAddress; /* bus/device were filled automatically based
                                 on vedor/product */
376 377 378 379 380 381
            unsigned bus;
            unsigned device;

            unsigned vendor;
            unsigned product;
        } usb;
382
        virDevicePCIAddress pci; /* host address */
383 384 385
    } u;
};

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408

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


409 410
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
411
    virDomainDeviceDef parent; /* higher level Def containing this */
412
    int mode; /* enum virDomainHostdevMode */
413
    int startupPolicy; /* enum virDomainStartupPolicy */
414
    unsigned int managed : 1;
415
    unsigned int missing : 1;
416
    union {
417
        virDomainHostdevSubsys subsys;
418
        virDomainHostdevCaps caps;
419 420
    } source;
    virDomainHostdevOrigStates origstates;
421
    virDomainDeviceInfoPtr info; /* Guest address */
422 423
};

424 425 426 427
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
428
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
429
    VIR_DOMAIN_DISK_TYPE_NETWORK,
430 431 432 433 434 435 436 437 438

    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,
439
    VIR_DOMAIN_DISK_DEVICE_LUN,
440 441 442 443 444 445 446 447 448 449

    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,
450
    VIR_DOMAIN_DISK_BUS_USB,
451
    VIR_DOMAIN_DISK_BUS_UML,
452
    VIR_DOMAIN_DISK_BUS_SATA,
453 454 455 456

    VIR_DOMAIN_DISK_BUS_LAST
};

457 458 459 460 461
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
462
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
463
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
464 465 466 467

    VIR_DOMAIN_DISK_CACHE_LAST
};

468 469 470
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
471
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
472
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
473
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
474 475 476 477

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
478 479 480 481
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,
482
    VIR_DOMAIN_DISK_PROTOCOL_GLUSTER,
M
MORITA Kazutaka 已提交
483 484 485 486

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

487 488 489 490 491 492 493 494
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
};

495 496 497 498 499 500 501
enum virDomainDiskTray {
    VIR_DOMAIN_DISK_TRAY_CLOSED,
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
};

J
J.B. Joret 已提交
502 503 504 505 506 507 508 509 510
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 已提交
511 512 513 514 515
typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
516 517
    int transport; /* enum virDomainDiskProtocolTransport */
    char *socket;  /* path to unix socket */
M
MORITA Kazutaka 已提交
518 519
};

M
Matthias Dahl 已提交
520 521 522 523 524 525 526 527
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

528 529 530 531 532 533 534 535
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
};

536 537 538 539 540 541 542 543
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 已提交
544 545 546 547 548 549 550 551
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
};

552 553 554 555 556 557 558 559 560
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
};

561 562 563 564 565 566 567 568
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 已提交
569 570 571 572 573 574 575 576
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 已提交
577 578 579 580 581 582 583 584 585 586 587
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;

588 589 590 591 592 593 594
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
595
    int tray_status;
M
MORITA Kazutaka 已提交
596
    int protocol;
597
    size_t nhosts;
M
MORITA Kazutaka 已提交
598
    virDomainDiskHostDefPtr hosts;
599 600 601 602 603 604 605 606
    struct {
        char *username;
        int secretType; /* enum virDomainDiskSecretType */
        union {
            unsigned char uuid[VIR_UUID_BUFLEN];
            char *usage;
        } secret;
    } auth;
607
    char *driverName;
608
    int format; /* enum virStorageFileFormat */
609
    virStorageFileMetadataPtr backingChain;
L
Lei Li 已提交
610

611
    char *mirror;
612
    int mirrorFormat; /* enum virStorageFileFormat */
613 614
    bool mirroring;

J
J.B. Joret 已提交
615 616 617 618 619 620 621
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
        int trans;
    } geometry;

622 623 624
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
625
    } blockio;
626

L
Lei Li 已提交
627 628
    virDomainBlockIoTuneInfo blkdeviotune;

629
    char *serial;
O
Osier Yang 已提交
630
    char *wwn;
631 632
    char *vendor;
    char *product;
633
    int cachemode;
634 635
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
M
Matthias Dahl 已提交
636
    int iomode;
637
    int ioeventfd;
638
    int event_idx;
O
Osier Yang 已提交
639
    int copy_on_read;
E
Eric Blake 已提交
640
    int snapshot; /* enum virDomainSnapshotLocation, snapshot_conf.h */
641
    int startupPolicy; /* enum virDomainStartupPolicy */
642 643
    unsigned int readonly : 1;
    unsigned int shared : 1;
644
    unsigned int transient : 1;
645
    virDomainDeviceInfo info;
646
    virStorageEncryptionPtr encryption;
647 648
    bool rawio_specified;
    int rawio; /* no = 0, yes = 1 */
O
Osier Yang 已提交
649
    int sgio; /* enum virDomainDiskSGIO */
650 651 652

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
653 654 655
};


656 657 658 659 660
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
661
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
662
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
663
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
664 665 666 667

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

668

669 670 671 672 673 674
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,
675
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
676
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
677

678
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
679 680
};

M
Marc-André Lureau 已提交
681 682 683 684 685 686 687 688 689 690
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 已提交
691
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
692
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
693 694 695 696

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

697 698 699 700 701 702 703
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

704 705 706 707
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
    int idx;
708
    int model; /* -1 == undef */
709 710 711
    union {
        virDomainVirtioSerialOpts vioserial;
    } opts;
712 713 714 715
    virDomainDeviceInfo info;
};


716 717
/* Two types of disk backends */
enum virDomainFSType {
718 719 720 721 722 723
    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 */
724 725 726 727

    VIR_DOMAIN_FS_TYPE_LAST
};

728 729 730 731 732 733 734 735 736
/* 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
};

737 738 739 740 741 742 743 744 745
/* 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
};

746 747 748 749 750 751 752 753
/* Filesystem Write policy */
enum virDomainFSWrpolicy {
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
};

754 755 756
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

757 758
struct _virDomainFSDef {
    int type;
759
    int fsdriver;
760
    int accessmode;
761
    int wrpolicy; /* enum virDomainFSWrpolicy */
762
    unsigned long long usage;
763 764 765
    char *src;
    char *dst;
    unsigned int readonly : 1;
766
    virDomainDeviceInfo info;
767 768
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
769 770 771
};


772 773 774 775 776 777 778 779 780
/* 5 different types of networking config */
enum virDomainNetType {
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
    VIR_DOMAIN_NET_TYPE_SERVER,
    VIR_DOMAIN_NET_TYPE_CLIENT,
    VIR_DOMAIN_NET_TYPE_MCAST,
    VIR_DOMAIN_NET_TYPE_NETWORK,
    VIR_DOMAIN_NET_TYPE_BRIDGE,
D
Daniel Veillard 已提交
781
    VIR_DOMAIN_NET_TYPE_INTERNAL,
782
    VIR_DOMAIN_NET_TYPE_DIRECT,
783
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
784

785
    VIR_DOMAIN_NET_TYPE_LAST
786 787
};

788 789 790 791 792 793
/* 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 */

794
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
795
};
796

797 798 799 800 801 802
/* 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,

803
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
804 805
};

806 807 808 809 810 811 812 813 814
/* 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
};

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
/* 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;
832 833 834
        struct {
            virDomainHostdevDef def;
        } hostdev;
835
    } data;
836
    virNetDevVPortProfilePtr virtPortProfile;
837
    virNetDevBandwidthPtr bandwidth;
838
    virNetDevVlan vlan;
839
    unsigned int class_id; /* class ID for bandwidth 'floor' */
840 841
};

842 843
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
S
Stefan Berger 已提交
844
    enum virDomainNetType type;
845
    virMacAddr mac;
846
    char *model;
847 848 849
    union {
        struct {
            enum virDomainNetBackendType name; /* which driver backend to use */
850
            enum virDomainNetVirtioTxModeType txmode;
851
            enum virDomainIoEventFd ioeventfd;
852
            enum virDomainVirtioEventIdx event_idx;
853 854
        } virtio;
    } driver;
855 856 857 858 859 860 861 862 863 864 865
    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;
866 867 868 869 870 871 872 873 874 875
            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;
876 877 878
        } network;
        struct {
            char *brname;
879
            char *ipaddr;
880
        } bridge;
D
Daniel Veillard 已提交
881 882 883
        struct {
            char *name;
        } internal;
884 885
        struct {
            char *linkdev;
886
            int mode; /* enum virMacvtapMode from util/macvtap.h */
887
        } direct;
888 889 890
        struct {
            virDomainHostdevDef def;
        } hostdev;
891
    } data;
892 893
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
894 895 896 897
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
898
    char *script;
899
    char *ifname;
900
    virDomainDeviceInfo info;
901 902
    char *filter;
    virNWFilterHashTablePtr filterparams;
903
    virNetDevBandwidthPtr bandwidth;
904
    virNetDevVlan vlan;
905
    int linkstate;
906 907
};

E
Eric Blake 已提交
908 909 910 911
/* 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"

912
enum virDomainChrDeviceType {
913
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
914 915
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
916
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
917

918
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
919 920 921
};

enum virDomainChrChannelTargetType {
922 923
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
924 925
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

926
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
927 928
};

929 930 931 932
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 已提交
933
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
934 935
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
936

937
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
938 939
};

940
enum virDomainChrType {
941 942 943 944 945 946 947 948 949 950
    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,
951
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
952

953
    VIR_DOMAIN_CHR_TYPE_LAST
954 955 956 957 958
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
959 960
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
961

962
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
963 964
};

E
Eric Blake 已提交
965 966 967
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
968
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
969

970
    VIR_DOMAIN_CHR_SPICEVMC_LAST
E
Eric Blake 已提交
971 972
};

973 974 975 976 977
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
978
    union {
E
Eric Blake 已提交
979
        /* no <source> for null, vc, stdio */
980 981 982 983 984 985
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
986
            bool listen;
987 988 989 990 991 992 993 994 995 996
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
997
            bool listen;
998
        } nix;
E
Eric Blake 已提交
999
        int spicevmc;
1000
    } data;
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
};

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

    virDomainChrSourceDef source;
1014 1015

    virDomainDeviceInfo info;
1016 1017 1018

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1019 1020
};

E
Eric Blake 已提交
1021 1022 1023 1024 1025
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1026
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
E
Eric Blake 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
};

# 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 已提交
1046 1047 1048 1049 1050
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1051 1052 1053 1054
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

1055
    VIR_DOMAIN_INPUT_TYPE_LAST
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
};

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;
1069
    virDomainDeviceInfo info;
1070 1071
};

1072 1073 1074 1075 1076 1077 1078
enum virDomainSoundCodecType {
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
};

1079 1080 1081 1082
enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1083
    VIR_DOMAIN_SOUND_MODEL_AC97,
1084
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1085 1086 1087 1088

    VIR_DOMAIN_SOUND_MODEL_LAST
};

1089 1090 1091 1092 1093
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1094 1095
struct _virDomainSoundDef {
    int model;
1096
    virDomainDeviceInfo info;
1097

1098
    size_t ncodecs;
1099
    virDomainSoundCodecDefPtr *codecs;
1100 1101
};

R
Richard Jones 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
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 已提交
1114
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1115 1116 1117 1118 1119 1120 1121 1122
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

struct _virDomainWatchdogDef {
    int model;
    int action;
1123
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1124 1125
};

1126 1127 1128 1129 1130 1131 1132

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,
1133
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1134 1135 1136 1137 1138

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


1139 1140 1141
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1142 1143
    unsigned int support3d :1;
    unsigned int support2d :1;
1144 1145 1146
};


1147 1148 1149 1150
struct _virDomainVideoDef {
    int type;
    unsigned int vram;
    unsigned int heads;
1151
    bool primary;
1152
    virDomainVideoAccelDefPtr accel;
1153
    virDomainDeviceInfo info;
1154 1155
};

1156 1157 1158 1159
/* 3 possible graphics console modes */
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1160 1161
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1162
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1163

1164
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1165 1166
};

1167 1168 1169 1170 1171 1172 1173 1174 1175
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
};

1176 1177 1178 1179 1180 1181
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 */
1182
    int connected; /* action if connected */
1183 1184
};

1185 1186 1187 1188 1189 1190 1191
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 已提交
1192
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1193
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204

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

1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
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 已提交
1244 1245 1246 1247 1248 1249 1250 1251
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
};

1252 1253 1254 1255 1256 1257 1258 1259 1260
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
};

1261 1262 1263 1264 1265 1266 1267 1268
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
};

1269 1270 1271 1272 1273
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

1274
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1275 1276
};

M
Marc-André Lureau 已提交
1277 1278 1279
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

1280
    VIR_DOMAIN_HUB_TYPE_LAST
M
Marc-André Lureau 已提交
1281 1282
};

1283 1284 1285 1286 1287 1288 1289 1290
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
};

1291
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1292 1293 1294 1295 1296
    /* 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.
     */
1297 1298 1299 1300
    int type;
    union {
        struct {
            int port;
1301
            unsigned int autoport :1;
1302
            char *keymap;
1303
            char *socket;
1304
            virDomainGraphicsAuthDef auth;
1305 1306 1307 1308
        } vnc;
        struct {
            char *display;
            char *xauth;
1309
            int fullscreen;
1310
        } sdl;
1311 1312
        struct {
            int port;
1313 1314 1315
            unsigned int autoport :1;
            unsigned int replaceUser :1;
            unsigned int multiUser :1;
1316 1317 1318
        } rdp;
        struct {
            char *display;
1319
            unsigned int fullscreen :1;
1320
        } desktop;
1321 1322 1323
        struct {
            int port;
            int tlsPort;
P
Peng Zhou 已提交
1324
            int mousemode;
1325
            char *keymap;
1326
            virDomainGraphicsAuthDef auth;
1327
            unsigned int autoport :1;
1328
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1329
            int defaultMode; /* enum virDomainGraphicsSpiceChannelMode */
1330 1331 1332 1333
            int image;
            int jpeg;
            int zlib;
            int playback;
1334
            int streaming;
1335
            int copypaste;
1336
        } spice;
1337
    } data;
1338 1339 1340 1341 1342
    /* 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;
1343 1344
};

1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
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 */
};
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
struct _virDomainRedirFilterUsbDevDef {
    int usbClass;
    int vendor;
    int product;
    int version;
    unsigned int allow :1;
};

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

1374 1375 1376 1377 1378 1379 1380 1381
enum virDomainMemDump {
    VIR_DOMAIN_MEM_DUMP_DEFAULT = 0,
    VIR_DOMAIN_MEM_DUMP_ON,
    VIR_DOMAIN_MEM_DUMP_OFF,

    VIR_DOMAIN_MEM_DUMP_LAST,
};

1382 1383 1384
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1385
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


1396 1397 1398 1399 1400 1401 1402 1403 1404
enum virDomainSmbiosMode {
    VIR_DOMAIN_SMBIOS_NONE,
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1405

1406
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1407 1408 1409 1410 1411 1412 1413

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1414
    VIR_DOMAIN_BOOT_LAST
1415 1416
};

1417 1418 1419 1420
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
1421 1422

    VIR_DOMAIN_BOOT_MENU_LAST
1423 1424
};

1425 1426 1427 1428
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1429
    VIR_DOMAIN_FEATURE_HAP,
1430
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1431
    VIR_DOMAIN_FEATURE_PRIVNET,
1432
    VIR_DOMAIN_FEATURE_HYPERV,
1433 1434 1435 1436

    VIR_DOMAIN_FEATURE_LAST
};

1437 1438 1439 1440
enum virDomainFeatureState {
    VIR_DOMAIN_FEATURE_STATE_DEFAULT = 0,
    VIR_DOMAIN_FEATURE_STATE_ON,
    VIR_DOMAIN_FEATURE_STATE_OFF,
1441

1442
    VIR_DOMAIN_FEATURE_STATE_LAST
1443 1444
};

1445 1446 1447 1448 1449 1450
enum virDomainHyperv {
    VIR_DOMAIN_HYPERV_RELAXED = 0,

    VIR_DOMAIN_HYPERV_LAST
};

1451 1452 1453 1454 1455 1456 1457 1458 1459
enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
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
};

1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
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)

1483 1484 1485 1486 1487
enum virDomainPMState {
    VIR_DOMAIN_PM_STATE_DEFAULT = 0,
    VIR_DOMAIN_PM_STATE_ENABLED,
    VIR_DOMAIN_PM_STATE_DISABLED,

1488
    VIR_DOMAIN_PM_STATE_LAST
1489 1490
};

M
Michal Privoznik 已提交
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
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;
1501 1502 1503
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1504 1505
};

1506 1507 1508 1509 1510
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
1511
    virArch arch;
1512
    char *machine;
1513
    size_t nBootDevs;
1514
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
1515
    /* enum virDomainBootMenu */
1516
    int bootmenu;
1517
    char *init;
1518
    char **initargv;
1519 1520 1521 1522 1523 1524 1525
    char *kernel;
    char *initrd;
    char *cmdline;
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
1526
    int smbios_mode;
1527

M
Michal Privoznik 已提交
1528
    virDomainBIOSDef bios;
1529 1530
};

1531 1532 1533 1534 1535 1536
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 已提交
1537
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1538

1539
    VIR_DOMAIN_TIMER_NAME_LAST
1540 1541
};

1542 1543 1544 1545
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1546

1547
    VIR_DOMAIN_TIMER_TRACK_LAST
1548 1549 1550 1551 1552 1553 1554 1555
};

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

1556
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1557 1558 1559 1560 1561 1562 1563
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1564
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1565

1566
    VIR_DOMAIN_TIMER_MODE_LAST
1567 1568
};

O
Osier Yang 已提交
1569
enum virDomainCpuPlacementMode {
1570
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1571 1572
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1573
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
O
Osier Yang 已提交
1574 1575
};

1576 1577 1578 1579 1580
enum virDomainNumatuneMemPlacementMode {
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_DEFAULT = 0,
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_STATIC,
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_AUTO,

1581
    VIR_DOMAIN_NUMATUNE_MEM_PLACEMENT_MODE_LAST
1582 1583
};

1584 1585 1586 1587 1588 1589 1590 1591
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1592 1593 1594 1595 1596 1597 1598
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 */

1599 1600 1601 1602
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1603 1604 1605 1606 1607 1608

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

1609 1610 1611
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1612
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1613
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1614

1615
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1616 1617
};

1618 1619 1620 1621
enum virDomainClockBasis {
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1622
    VIR_DOMAIN_CLOCK_BASIS_LAST
1623 1624
};

1625 1626 1627 1628
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1629

1630
    union {
1631 1632 1633
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
1634
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
1635 1636 1637 1638
        struct {
            long long adjustment;
            int basis;
        } variable;
1639 1640 1641 1642 1643

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

1645
    size_t ntimers;
1646
    virDomainTimerDefPtr *timers;
1647 1648
};

1649
# define VIR_DOMAIN_CPUMASK_LEN 1024
1650

E
Eric Blake 已提交
1651 1652 1653
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1654
    int vcpuid;
H
Hu Tao 已提交
1655
    virBitmapPtr cpumask;
1656 1657
};

H
Hu Tao 已提交
1658 1659
void virDomainVcpuPinDefFree(virDomainVcpuPinDefPtr def);
void virDomainVcpuPinDefArrayFree(virDomainVcpuPinDefPtr *def, int nvcpupin);
1660 1661 1662 1663

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

E
Eric Blake 已提交
1664
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1665 1666 1667
                                int nvcpupin,
                                int vcpu);

E
Eric Blake 已提交
1668
virDomainVcpuPinDefPtr virDomainVcpuPinFindByVcpu(virDomainVcpuPinDefPtr *def,
1669 1670 1671
                                                  int nvcpupin,
                                                  int vcpu);

1672 1673 1674 1675
typedef struct _virDomainNumatuneDef virDomainNumatuneDef;
typedef virDomainNumatuneDef *virDomainNumatuneDefPtr;
struct _virDomainNumatuneDef {
    struct {
1676
        virBitmapPtr nodemask;
1677
        int mode;
1678
        int placement_mode; /* enum virDomainNumatuneMemPlacementMode */
1679 1680 1681 1682 1683
    } memory;

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

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
typedef struct _virBlkioDeviceWeight virBlkioDeviceWeight;
typedef virBlkioDeviceWeight *virBlkioDeviceWeightPtr;
struct _virBlkioDeviceWeight {
    char *path;
    unsigned int weight;
};

void virBlkioDeviceWeightArrayClear(virBlkioDeviceWeightPtr deviceWeights,
                                    int ndevices);


1695 1696 1697 1698 1699 1700
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1701 1702 1703 1704 1705 1706 1707
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1708
    char *title;
1709
    char *description;
1710

1711 1712
    struct {
        unsigned int weight;
1713 1714 1715

        size_t ndevices;
        virBlkioDeviceWeightPtr devices;
1716 1717
    } blkio;

1718
    struct {
1719 1720 1721
        unsigned long long max_balloon; /* in kibibytes */
        unsigned long long cur_balloon; /* in kibibytes */
        bool hugepage_backed;
1722
        int dump_core; /* enum virDomainMemDump */
1723 1724 1725 1726
        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 */
1727
    } mem;
E
Eric Blake 已提交
1728 1729
    unsigned short vcpus;
    unsigned short maxvcpus;
O
Osier Yang 已提交
1730
    int placement_mode;
H
Hu Tao 已提交
1731
    virBitmapPtr cpumask;
1732

1733 1734
    struct {
        unsigned long shares;
1735 1736
        unsigned long long period;
        long long quota;
1737 1738
        unsigned long long emulator_period;
        long long emulator_quota;
1739
        int nvcpupin;
E
Eric Blake 已提交
1740
        virDomainVcpuPinDefPtr *vcpupin;
T
Tang Chen 已提交
1741
        virDomainVcpuPinDefPtr emulatorpin;
1742 1743
    } cputune;

1744 1745
    virDomainNumatuneDef numatune;

1746 1747 1748 1749 1750
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

1751 1752
    int onLockFailure; /* enum virDomainLockFailureAction */

1753 1754 1755 1756 1757 1758
    struct {
        /* These options are actually type of enum virDomainPMState */
        int s3;
        int s4;
    } pm;

1759 1760 1761
    virDomainOSDef os;
    char *emulator;
    int features;
1762
    /* enum virDomainFeatureState */
1763
    int apic_eoi;
1764 1765
    /* These options are of type virDomainFeatureState */
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
1766

1767
    virDomainClockDef clock;
1768

1769
    size_t ngraphics;
1770
    virDomainGraphicsDefPtr *graphics;
1771

1772
    size_t ndisks;
1773 1774
    virDomainDiskDefPtr *disks;

1775
    size_t ncontrollers;
1776 1777
    virDomainControllerDefPtr *controllers;

1778
    size_t nfss;
1779 1780
    virDomainFSDefPtr *fss;

1781
    size_t nnets;
1782 1783
    virDomainNetDefPtr *nets;

1784
    size_t ninputs;
1785 1786
    virDomainInputDefPtr *inputs;

1787
    size_t nsounds;
1788 1789
    virDomainSoundDefPtr *sounds;

1790
    size_t nvideos;
1791 1792
    virDomainVideoDefPtr *videos;

1793
    size_t nhostdevs;
1794 1795
    virDomainHostdevDefPtr *hostdevs;

1796
    size_t nredirdevs;
1797 1798
    virDomainRedirdevDefPtr *redirdevs;

1799
    size_t nsmartcards;
E
Eric Blake 已提交
1800 1801
    virDomainSmartcardDefPtr *smartcards;

1802
    size_t nserials;
1803 1804
    virDomainChrDefPtr *serials;

1805
    size_t nparallels;
1806 1807
    virDomainChrDefPtr *parallels;

1808
    size_t nchannels;
1809 1810
    virDomainChrDefPtr *channels;

1811
    size_t nconsoles;
1812 1813
    virDomainChrDefPtr *consoles;

1814
    size_t nleases;
1815 1816
    virDomainLeaseDefPtr *leases;

1817
    size_t nhubs;
M
Marc-André Lureau 已提交
1818 1819
    virDomainHubDefPtr *hubs;

1820 1821 1822
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

1823
    /* Only 1 */
R
Richard Jones 已提交
1824
    virDomainWatchdogDefPtr watchdog;
1825
    virDomainMemballoonDefPtr memballoon;
1826
    virCPUDefPtr cpu;
1827
    virSysinfoDefPtr sysinfo;
1828
    virDomainRedirFilterDefPtr redirfilter;
1829 1830 1831

    void *namespaceData;
    virDomainXMLNamespace ns;
1832 1833 1834

    /* Application-specific custom metadata */
    xmlNodePtr metadata;
1835 1836
};

1837 1838 1839 1840 1841 1842
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 */
1843
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
1844
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
1845 1846 1847 1848

    VIR_DOMAIN_TAINT_LAST
};

1849
/* Guest VM runtime state */
J
Jiri Denemark 已提交
1850 1851 1852 1853 1854 1855
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

1856 1857 1858
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1859 1860
    virObject object;

1861
    virMutex lock;
1862

1863
    pid_t pid;
J
Jiri Denemark 已提交
1864
    virDomainStateReason state;
1865 1866 1867

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1868
    unsigned int updated : 1;
1869 1870 1871

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

1873
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
1874 1875
    virDomainSnapshotObjPtr current_snapshot;

1876 1877
    bool hasManagedSave;

1878 1879
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1880 1881

    int taint;
1882 1883
};

1884 1885 1886
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
struct _virDomainObjList {
1887 1888 1889
    /* uuid string -> virDomainObj  mapping
     * for O(1), lockless lookup-by-uuid */
    virHashTable *objs;
1890
};
1891

1892
static inline bool
D
Daniel P. Berrange 已提交
1893
virDomainObjIsActive(virDomainObjPtr dom)
1894 1895 1896 1897
{
    return dom->def->id != -1;
}

1898
virDomainObjPtr virDomainObjNew(virCapsPtr caps);
1899

1900 1901
int virDomainObjListInit(virDomainObjListPtr objs);
void virDomainObjListDeinit(virDomainObjListPtr objs);
1902

1903
virDomainObjPtr virDomainFindByID(const virDomainObjListPtr doms,
1904
                                  int id);
1905
virDomainObjPtr virDomainFindByUUID(const virDomainObjListPtr doms,
1906
                                    const unsigned char *uuid);
1907
virDomainObjPtr virDomainFindByName(const virDomainObjListPtr doms,
1908 1909
                                    const char *name);

1910 1911
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
1912 1913 1914 1915

void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
1916
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
1917
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
1918 1919 1920
int virDomainDiskFindControllerModel(virDomainDefPtr def,
                                     virDomainDiskDefPtr disk,
                                     int controllerType);
1921
void virDomainControllerDefFree(virDomainControllerDefPtr def);
1922
void virDomainFSDefFree(virDomainFSDefPtr def);
1923
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
1924
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
1925
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
1926
void virDomainChrDefFree(virDomainChrDefPtr def);
1927
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
1928 1929
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
1930
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
1931
void virDomainSoundDefFree(virDomainSoundDefPtr def);
1932
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
1933
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
1934
void virDomainVideoDefFree(virDomainVideoDefPtr def);
1935 1936
virDomainHostdevDefPtr virDomainHostdevDefAlloc(void);
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
1937
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
1938
void virDomainHubDefFree(virDomainHubDefPtr def);
1939
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
1940
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
1941
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
1942 1943 1944
virDomainDeviceDefPtr virDomainDeviceDefCopy(virCapsPtr caps,
                                             const virDomainDefPtr def,
                                             virDomainDeviceDefPtr src);
1945 1946
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
1947 1948
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
1949
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
1950
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
1951
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
1952

1953
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
1954 1955
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
1956 1957 1958 1959 1960 1961
                                           void *opaque);

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

1962 1963
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
1964 1965
virDomainChrDefPtr virDomainChrDefNew(void);

1966 1967
/* live == true means def describes an active domain (being migrated or
 * restored) as opposed to a new persistent configuration of the domain */
1968
virDomainObjPtr virDomainAssignDef(virCapsPtr caps,
1969
                                   virDomainObjListPtr doms,
1970 1971
                                   const virDomainDefPtr def,
                                   bool live);
1972 1973 1974
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
                           bool live);
1975
int virDomainObjSetDefTransient(virCapsPtr caps,
1976 1977
                                virDomainObjPtr domain,
                                bool live);
1978 1979 1980
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
                             virDomainObjPtr domain);
1981 1982 1983 1984 1985 1986 1987

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

1988 1989
virDomainDefPtr virDomainDefCopy(virCapsPtr caps, virDomainDefPtr src,
                                 bool migratable);
1990 1991 1992
virDomainDefPtr
virDomainObjCopyPersistentDef(virCapsPtr caps, virDomainObjPtr dom);

1993
void virDomainRemoveInactive(virDomainObjListPtr doms,
1994 1995
                             virDomainObjPtr dom);

1996
virDomainDeviceDefPtr virDomainDeviceDefParse(virCapsPtr caps,
1997
                                              virDomainDefPtr def,
1998
                                              const char *xmlStr,
L
Laine Stump 已提交
1999
                                              unsigned int flags);
2000
virDomainDefPtr virDomainDefParseString(virCapsPtr caps,
2001
                                        const char *xmlStr,
M
Matthias Bolte 已提交
2002
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2003
                                        unsigned int flags);
2004
virDomainDefPtr virDomainDefParseFile(virCapsPtr caps,
2005
                                      const char *filename,
M
Matthias Bolte 已提交
2006
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2007
                                      unsigned int flags);
2008
virDomainDefPtr virDomainDefParseNode(virCapsPtr caps,
2009
                                      xmlDocPtr doc,
2010
                                      xmlNodePtr root,
M
Matthias Bolte 已提交
2011
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2012
                                      unsigned int flags);
2013

2014 2015 2016
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2017
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
2018

2019
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
2020
                         unsigned int flags);
2021 2022 2023
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
2024

2025 2026 2027
int virDomainDefCompatibleDevice(virDomainDefPtr def,
                                 virDomainDeviceDefPtr dev);

2028
int virDomainVcpuPinAdd(virDomainVcpuPinDefPtr **vcpupin_list,
H
Hu Tao 已提交
2029
                        int *nvcpupin,
2030 2031 2032 2033
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
2034
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
2035

2036 2037 2038 2039 2040 2041
int virDomainEmulatorPinAdd(virDomainDefPtr def,
                              unsigned char *cpumap,
                              int maplen);

int virDomainEmulatorPinDel(virDomainDefPtr def);

2042 2043 2044
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2045 2046 2047 2048
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2049
int virDomainDiskDefAssignAddress(virCapsPtr caps, virDomainDiskDefPtr def);
2050

2051 2052 2053 2054
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
E
Eric Blake 已提交
2055
bool virDomainHasDiskMirror(virDomainObjPtr vm);
2056

2057 2058
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2059
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2060
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2061

L
Laine Stump 已提交
2062
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2063 2064
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2065 2066 2067
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
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);

2086
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2087 2088
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2089
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2090
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2091
virNetDevVPortProfilePtr
2092
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2093
virNetDevBandwidthPtr
2094
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2095
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2096

2097 2098 2099 2100
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2101 2102
int virDomainControllerFind(virDomainDefPtr def, int type, int idx);
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2103 2104 2105 2106 2107 2108 2109 2110

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def);
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2111 2112 2113 2114 2115
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2116

2117
int virDomainSaveXML(const char *configDir,
2118 2119 2120
                     virDomainDefPtr def,
                     const char *xml);

2121
int virDomainSaveConfig(const char *configDir,
2122
                        virDomainDefPtr def);
2123
int virDomainSaveStatus(virCapsPtr caps,
2124
                        const char *statusDir,
2125
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
2126

2127 2128 2129 2130
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2131
int virDomainLoadAllConfigs(virCapsPtr caps,
2132
                            virDomainObjListPtr doms,
2133
                            const char *configDir,
2134
                            const char *autostartDir,
2135
                            int liveStatus,
M
Matthias Bolte 已提交
2136
                            unsigned int expectedVirtTypes,
2137 2138
                            virDomainLoadConfigNotify notify,
                            void *opaque);
2139

2140
int virDomainDeleteConfig(const char *configDir,
2141
                          const char *autostartDir,
2142 2143
                          virDomainObjPtr dom);

2144
char *virDomainConfigFile(const char *dir,
2145 2146
                          const char *name);

2147 2148 2149 2150
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2151
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
2152
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2153 2154
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
2155

2156 2157 2158 2159
int virDomainObjIsDuplicate(virDomainObjListPtr doms,
                            virDomainDefPtr def,
                            unsigned int check_active);

D
Daniel P. Berrange 已提交
2160 2161
void virDomainObjLock(virDomainObjPtr obj);
void virDomainObjUnlock(virDomainObjPtr obj);
2162

2163 2164 2165 2166 2167 2168 2169 2170 2171
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

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

E
Eric Blake 已提交
2172 2173 2174 2175 2176 2177 2178 2179 2180
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

2181 2182 2183 2184 2185 2186 2187 2188 2189
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
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 已提交
2200 2201 2202 2203 2204 2205 2206
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2207 2208 2209 2210 2211 2212
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

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

2213 2214 2215
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2216 2217 2218
virSecurityLabelDefPtr
virDomainDefAddSecurityLabelDef(virDomainDefPtr def, const char *model);

2219 2220
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2221

2222 2223
VIR_ENUM_DECL(virDomainTaint)

2224 2225
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
2226
VIR_ENUM_DECL(virDomainBootMenu)
2227
VIR_ENUM_DECL(virDomainFeature)
2228
VIR_ENUM_DECL(virDomainFeatureState)
2229
VIR_ENUM_DECL(virDomainLifecycle)
2230
VIR_ENUM_DECL(virDomainLifecycleCrash)
2231
VIR_ENUM_DECL(virDomainPMState)
2232
VIR_ENUM_DECL(virDomainDevice)
2233
VIR_ENUM_DECL(virDomainDeviceAddress)
2234 2235
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
2236
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
2237
VIR_ENUM_DECL(virDomainDiskBus)
2238
VIR_ENUM_DECL(virDomainDiskCache)
2239
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
2240
VIR_ENUM_DECL(virDomainDiskProtocol)
2241
VIR_ENUM_DECL(virDomainDiskProtocolTransport)
M
Matthias Dahl 已提交
2242
VIR_ENUM_DECL(virDomainDiskIo)
2243
VIR_ENUM_DECL(virDomainDiskSecretType)
O
Osier Yang 已提交
2244
VIR_ENUM_DECL(virDomainDiskSGIO)
2245
VIR_ENUM_DECL(virDomainDiskTray)
2246
VIR_ENUM_DECL(virDomainIoEventFd)
2247
VIR_ENUM_DECL(virDomainVirtioEventIdx)
O
Osier Yang 已提交
2248
VIR_ENUM_DECL(virDomainDiskCopyOnRead)
2249
VIR_ENUM_DECL(virDomainController)
2250
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
2251
VIR_ENUM_DECL(virDomainControllerModelUSB)
2252
VIR_ENUM_DECL(virDomainFS)
2253
VIR_ENUM_DECL(virDomainFSDriverType)
2254
VIR_ENUM_DECL(virDomainFSAccessMode)
2255
VIR_ENUM_DECL(virDomainFSWrpolicy)
2256
VIR_ENUM_DECL(virDomainNet)
2257
VIR_ENUM_DECL(virDomainNetBackend)
2258
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
2259
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
2260
VIR_ENUM_DECL(virDomainChrDevice)
2261
VIR_ENUM_DECL(virDomainChrChannelTarget)
2262
VIR_ENUM_DECL(virDomainChrConsoleTarget)
E
Eric Blake 已提交
2263
VIR_ENUM_DECL(virDomainSmartcard)
2264
VIR_ENUM_DECL(virDomainChr)
2265
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
2266
VIR_ENUM_DECL(virDomainChrSpicevmc)
2267
VIR_ENUM_DECL(virDomainSoundCodec)
2268
VIR_ENUM_DECL(virDomainSoundModel)
2269
VIR_ENUM_DECL(virDomainMemDump)
2270
VIR_ENUM_DECL(virDomainMemballoonModel)
2271
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
2272 2273
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
2274
VIR_ENUM_DECL(virDomainVideo)
2275 2276
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
2277
VIR_ENUM_DECL(virDomainHostdevCaps)
2278
VIR_ENUM_DECL(virDomainPciRombarMode)
M
Marc-André Lureau 已提交
2279
VIR_ENUM_DECL(virDomainHub)
2280
VIR_ENUM_DECL(virDomainRedirdevBus)
2281 2282 2283
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2284
VIR_ENUM_DECL(virDomainGraphicsListen)
2285
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2286 2287
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2288 2289 2290 2291
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
VIR_ENUM_DECL(virDomainGraphicsSpicePlaybackCompression)
2292
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
2293
VIR_ENUM_DECL(virDomainGraphicsSpiceClipboardCopypaste)
P
Peng Zhou 已提交
2294
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
2295
VIR_ENUM_DECL(virDomainNumatuneMemMode)
2296
VIR_ENUM_DECL(virDomainNumatuneMemPlacementMode)
2297
VIR_ENUM_DECL(virDomainHyperv)
2298 2299
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
VIR_ENUM_DECL(virDomainNostateReason)
VIR_ENUM_DECL(virDomainRunningReason)
VIR_ENUM_DECL(virDomainBlockedReason)
VIR_ENUM_DECL(virDomainPausedReason)
VIR_ENUM_DECL(virDomainShutdownReason)
VIR_ENUM_DECL(virDomainShutoffReason)
VIR_ENUM_DECL(virDomainCrashedReason)

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

2311
VIR_ENUM_DECL(virDomainSeclabel)
2312
VIR_ENUM_DECL(virDomainClockOffset)
2313
VIR_ENUM_DECL(virDomainClockBasis)
2314

2315
VIR_ENUM_DECL(virDomainTimerName)
2316
VIR_ENUM_DECL(virDomainTimerTrack)
2317 2318
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
2319
VIR_ENUM_DECL(virDomainCpuPlacementMode)
2320

2321
VIR_ENUM_DECL(virDomainStartupPolicy)
2322

O
Osier Yang 已提交
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
# 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)

int virDomainList(virConnectPtr conn, virHashTablePtr domobjs,
                  virDomainPtr **domains, unsigned int flags);

2360 2361 2362
virDomainVcpuPinDefPtr virDomainLookupVcpuPin(virDomainDefPtr def,
                                              int vcpuid);

2363
#endif /* __DOMAIN_CONF_H */