domain_conf.h 87.6 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 "virthread.h"
36
# include "virhash.h"
37
# include "virsocketaddr.h"
38
# include "nwfilter_params.h"
39
# include "virnetdevmacvlan.h"
40
# include "virsysinfo.h"
41
# include "virnetdevvportprofile.h"
A
Ansis Atteka 已提交
42
# include "virnetdevopenvswitch.h"
43
# include "virnetdevbandwidth.h"
44
# include "virnetdevvlan.h"
45
# include "virobject.h"
46
# include "device_conf.h"
47
# include "virbitmap.h"
48
# include "virstoragefile.h"
G
Gao feng 已提交
49
# include "virnuma.h"
50

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

typedef struct _virDomainControllerDef virDomainControllerDef;
typedef virDomainControllerDef *virDomainControllerDefPtr;

typedef struct _virDomainLeaseDef virDomainLeaseDef;
typedef virDomainLeaseDef *virDomainLeaseDefPtr;

typedef struct _virDomainFSDef virDomainFSDef;
typedef virDomainFSDef *virDomainFSDefPtr;

typedef struct _virDomainNetDef virDomainNetDef;
typedef virDomainNetDef *virDomainNetDefPtr;

typedef struct _virDomainInputDef virDomainInputDef;
typedef virDomainInputDef *virDomainInputDefPtr;

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

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

typedef struct _virDomainVideoDef virDomainVideoDef;
typedef virDomainVideoDef *virDomainVideoDefPtr;

typedef struct _virDomainHostdevDef virDomainHostdevDef;
typedef virDomainHostdevDef *virDomainHostdevDefPtr;

typedef struct _virDomainWatchdogDef virDomainWatchdogDef;
typedef virDomainWatchdogDef *virDomainWatchdogDefPtr;

typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;

typedef struct _virDomainHubDef virDomainHubDef;
typedef virDomainHubDef *virDomainHubDefPtr;

typedef struct _virDomainRedirdevDef virDomainRedirdevDef;
typedef virDomainRedirdevDef *virDomainRedirdevDefPtr;

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

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

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

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

L
Li Zhang 已提交
111 112 113
typedef struct _virDomainNVRAMDef virDomainNVRAMDef;
typedef virDomainNVRAMDef *virDomainNVRAMDefPtr;

114 115 116 117 118 119
typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

120 121 122
typedef struct _virDomainRNGDef virDomainRNGDef;
typedef virDomainRNGDef *virDomainRNGDefPtr;

123 124 125 126 127 128
typedef struct _virDomainIdMapEntry virDomainIdMapEntry;
typedef virDomainIdMapEntry *virDomainIdMapEntryPtr;

typedef struct _virDomainIdMapDef virDomainIdMapDef;
typedef virDomainIdMapDef *virDomainIdMapDefPtr;

H
Hu Tao 已提交
129 130 131
typedef struct _virDomainPanicDef virDomainPanicDef;
typedef virDomainPanicDef *virDomainPanicDefPtr;

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/* 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,
L
Li Zhang 已提交
151
    VIR_DOMAIN_DEVICE_NVRAM,
152
    VIR_DOMAIN_DEVICE_RNG,
153

154
    VIR_DOMAIN_DEVICE_LAST
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
} 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;
L
Li Zhang 已提交
178
        virDomainNVRAMDefPtr nvram;
179
        virDomainRNGDefPtr rng;
180 181 182
    } data;
};

183 184 185 186 187 188 189 190 191 192 193 194 195
/* 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,
196
    VIR_DOMAIN_VIRT_VBOX,
197
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
198
    VIR_DOMAIN_VIRT_PARALLELS,
199

200
    VIR_DOMAIN_VIRT_LAST
201 202
};

203 204 205
enum virDomainDeviceAddressType {
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_NONE,
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_PCI,
206
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_DRIVE,
207
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
208
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCID,
209
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_USB,
210
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_SPAPRVIO,
211
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_S390,
212
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCW,
213
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_MMIO,
H
Hu Tao 已提交
214
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_ISA,
215 216 217 218

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

219 220 221 222 223 224 225 226
enum virDomainPciRombarMode {
    VIR_DOMAIN_PCI_ROMBAR_DEFAULT = 0,
    VIR_DOMAIN_PCI_ROMBAR_ON,
    VIR_DOMAIN_PCI_ROMBAR_OFF,

    VIR_DOMAIN_PCI_ROMBAR_LAST
};

227 228 229 230 231
typedef struct _virDomainDeviceDriveAddress virDomainDeviceDriveAddress;
typedef virDomainDeviceDriveAddress *virDomainDeviceDriveAddressPtr;
struct _virDomainDeviceDriveAddress {
    unsigned int controller;
    unsigned int bus;
232
    unsigned int target;
233 234 235
    unsigned int unit;
};

236 237 238 239 240
typedef struct _virDomainDeviceVirtioSerialAddress virDomainDeviceVirtioSerialAddress;
typedef virDomainDeviceVirtioSerialAddress *virDomainDeviceVirtioSerialAddressPtr;
struct _virDomainDeviceVirtioSerialAddress {
    unsigned int controller;
    unsigned int bus;
241
    unsigned int port;
242 243
};

244 245 246 247 248 249 250 251 252 253 254 255 256
# 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 已提交
257 258 259 260 261 262 263
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

264 265 266 267
typedef struct _virDomainDeviceUSBAddress virDomainDeviceUSBAddress;
typedef virDomainDeviceUSBAddress *virDomainDeviceUSBAddressPtr;
struct _virDomainDeviceUSBAddress {
    unsigned int bus;
268
    char *port;
269 270
};

271 272 273 274 275 276 277
typedef struct _virDomainDeviceSpaprVioAddress virDomainDeviceSpaprVioAddress;
typedef virDomainDeviceSpaprVioAddress *virDomainDeviceSpaprVioAddressPtr;
struct _virDomainDeviceSpaprVioAddress {
    unsigned long long reg;
    bool has_reg;
};

278 279 280 281 282 283 284 285 286 287 288 289 290
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;
};

H
Hu Tao 已提交
291 292 293 294 295 296 297
typedef struct _virDomainDeviceISAAddress virDomainDeviceISAAddress;
typedef virDomainDeviceISAAddress *virDomainDeviceISAAddressPtr;
struct _virDomainDeviceISAAddress {
    unsigned int iobase;
    unsigned int irq;
};

298 299 300
typedef struct _virDomainDeviceInfo virDomainDeviceInfo;
typedef virDomainDeviceInfo *virDomainDeviceInfoPtr;
struct _virDomainDeviceInfo {
301 302 303 304
    /* If adding to this struct, ensure that
     * virDomainDeviceInfoIsSet() is updated
     * to consider the new fields
     */
D
Daniel P. Berrange 已提交
305
    char *alias;
306 307
    int type;
    union {
308
        virDevicePCIAddress pci;
309
        virDomainDeviceDriveAddress drive;
310
        virDomainDeviceVirtioSerialAddress vioserial;
E
Eric Blake 已提交
311
        virDomainDeviceCcidAddress ccid;
312
        virDomainDeviceUSBAddress usb;
313
        virDomainDeviceSpaprVioAddress spaprvio;
314
        virDomainDeviceCCWAddress ccw;
H
Hu Tao 已提交
315
        virDomainDeviceISAAddress isa;
316
    } addr;
317 318 319 320
    int mastertype;
    union {
        virDomainDeviceUSBMaster usb;
    } master;
321 322
    /* rombar and romfile are only used for pci hostdev and network
     * devices. */
323
    int rombar;         /* enum virDomainPciRombarMode */
324
    char *romfile;
325 326
    /* bootIndex is only used for disk, network interface, hostdev
     * and redirdev devices */
327
    int bootIndex;
328 329
};

E
Eric Blake 已提交
330
enum virDomainSeclabelType {
331 332
    VIR_DOMAIN_SECLABEL_DEFAULT,
    VIR_DOMAIN_SECLABEL_NONE,
E
Eric Blake 已提交
333 334 335
    VIR_DOMAIN_SECLABEL_DYNAMIC,
    VIR_DOMAIN_SECLABEL_STATIC,

336
    VIR_DOMAIN_SECLABEL_LAST
E
Eric Blake 已提交
337 338 339 340 341 342 343 344 345 346 347 348
};

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

352 353 354 355 356

/* Security configuration for domain */
typedef struct _virSecurityDeviceLabelDef virSecurityDeviceLabelDef;
typedef virSecurityDeviceLabelDef *virSecurityDeviceLabelDefPtr;
struct _virSecurityDeviceLabelDef {
357
    char *model;
358
    char *label;        /* image label string */
359 360
    bool norelabel;     /* true to skip label attempts */
    bool labelskip;     /* live-only; true if skipping failed label attempt */
361 362 363
};


364 365 366 367 368 369 370 371
typedef struct _virDomainHostdevOrigStates virDomainHostdevOrigStates;
typedef virDomainHostdevOrigStates *virDomainHostdevOrigStatesPtr;
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
372
            bool unbind_from_stub;
373 374 375 376

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
377
            bool remove_slot;
378 379 380 381

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
382
            bool reprobe;
383 384 385 386 387 388
        } pci;

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

389 390 391 392 393 394 395
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

396

397 398 399 400
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

401
    VIR_DOMAIN_HOSTDEV_MODE_LAST
402 403 404 405 406
};

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,
H
Han Cheng 已提交
407
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI,
408 409 410 411

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

412 413
/* the backend driver used for PCI hostdev devices */
typedef enum {
414
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_DEFAULT, /* detect automaticaly, prefer VFIO */
415 416
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_KVM,    /* force legacy kvm style */
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_VFIO,   /* force vfio */
417 418 419 420 421

    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_TYPE_LAST
} virDomainHostdevSubsysPciBackendType;

VIR_ENUM_DECL(virDomainHostdevSubsysPciBackend)
422 423 424 425

typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys;
typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr;
struct _virDomainHostdevSubsys {
426
    int type; /* enum virDomainHostdevSubsysType */
427 428
    union {
        struct {
429 430
            bool autoAddress; /* bus/device were filled automatically based
                                 on vedor/product */
431 432 433 434 435 436
            unsigned bus;
            unsigned device;

            unsigned vendor;
            unsigned product;
        } usb;
437 438
        struct {
            virDevicePCIAddress addr; /* host address */
439
            int backend; /* enum virDomainHostdevSubsysPciBackendType */
440
        } pci;
H
Han Cheng 已提交
441 442 443 444 445
        struct {
            char *adapter;
            unsigned bus;
            unsigned target;
            unsigned unit;
O
Osier Yang 已提交
446
            int sgio; /* enum virDomainDeviceSGIO */
H
Han Cheng 已提交
447
        } scsi;
448 449 450
    } u;
};

451 452 453 454

enum virDomainHostdevCapsType {
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,
455
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_NET,
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

    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;
471 472 473
        struct {
            char *iface;
        } net;
474 475 476 477
    } u;
};


478 479
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
480
    virDomainDeviceDef parent; /* higher level Def containing this */
481
    int mode; /* enum virDomainHostdevMode */
482
    int startupPolicy; /* enum virDomainStartupPolicy */
483
    bool managed;
484
    bool missing;
O
Osier Yang 已提交
485
    bool readonly;
486
    bool shareable;
487
    union {
488
        virDomainHostdevSubsys subsys;
489
        virDomainHostdevCaps caps;
490 491
    } source;
    virDomainHostdevOrigStates origstates;
492
    virDomainDeviceInfoPtr info; /* Guest address */
493 494
};

495 496 497 498
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
499
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
500
    VIR_DOMAIN_DISK_TYPE_NETWORK,
501
    VIR_DOMAIN_DISK_TYPE_VOLUME,
502 503 504 505 506 507 508 509 510

    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,
511
    VIR_DOMAIN_DISK_DEVICE_LUN,
512 513 514 515 516 517 518 519 520 521

    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,
522
    VIR_DOMAIN_DISK_BUS_USB,
523
    VIR_DOMAIN_DISK_BUS_UML,
524
    VIR_DOMAIN_DISK_BUS_SATA,
525
    VIR_DOMAIN_DISK_BUS_SD,
526 527 528 529

    VIR_DOMAIN_DISK_BUS_LAST
};

530 531 532 533 534
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
535
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
536
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
537 538 539 540

    VIR_DOMAIN_DISK_CACHE_LAST
};

541 542 543
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
544
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
545
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
546
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
547 548 549 550

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
551 552 553 554
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,
555
    VIR_DOMAIN_DISK_PROTOCOL_GLUSTER,
556
    VIR_DOMAIN_DISK_PROTOCOL_ISCSI,
557
    VIR_DOMAIN_DISK_PROTOCOL_HTTP,
558
    VIR_DOMAIN_DISK_PROTOCOL_HTTPS,
559
    VIR_DOMAIN_DISK_PROTOCOL_FTP,
560
    VIR_DOMAIN_DISK_PROTOCOL_FTPS,
561
    VIR_DOMAIN_DISK_PROTOCOL_TFTP,
M
MORITA Kazutaka 已提交
562 563 564 565

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

566 567 568 569 570 571 572 573
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
};

574 575 576 577 578 579 580
enum virDomainDiskTray {
    VIR_DOMAIN_DISK_TRAY_CLOSED,
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
};

J
J.B. Joret 已提交
581 582 583 584 585 586 587 588 589
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 已提交
590 591 592 593 594
typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
595 596
    int transport; /* enum virDomainDiskProtocolTransport */
    char *socket;  /* path to unix socket */
M
MORITA Kazutaka 已提交
597 598
};

M
Matthias Dahl 已提交
599 600 601 602 603 604 605 606
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

607 608 609 610 611 612 613 614
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
};

615 616 617 618 619 620 621 622
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 已提交
623 624 625 626 627 628 629 630
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
};

631 632 633 634 635 636 637 638 639
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
};

640 641 642 643 644 645 646 647
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
};

648 649 650 651
enum virDomainDeviceSGIO {
    VIR_DOMAIN_DEVICE_SGIO_DEFAULT = 0,
    VIR_DOMAIN_DEVICE_SGIO_FILTERED,
    VIR_DOMAIN_DEVICE_SGIO_UNFILTERED,
O
Osier Yang 已提交
652

653
    VIR_DOMAIN_DEVICE_SGIO_LAST
O
Osier Yang 已提交
654 655
};

O
Osier Yang 已提交
656 657
enum virDomainDiskDiscard {
    VIR_DOMAIN_DISK_DISCARD_DEFAULT = 0,
O
Osier Yang 已提交
658 659
    VIR_DOMAIN_DISK_DISCARD_UNMAP,
    VIR_DOMAIN_DISK_DISCARD_IGNORE,
O
Osier Yang 已提交
660 661 662 663

    VIR_DOMAIN_DISK_DISCARD_LAST
};

L
Lei Li 已提交
664 665 666 667 668 669 670 671 672 673 674
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;

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
/*
 * Used for volume "type" disk to indicate how to represent
 * the disk source if the specified "pool" is of iscsi type.
 */
enum virDomainDiskSourcePoolMode {
    VIR_DOMAIN_DISK_SOURCE_POOL_MODE_DEFAULT = 0,

    /* Use the path as it shows up on host, e.g.
     * /dev/disk/by-path/ip-$ip-iscsi-$iqn:iscsi.iscsi-pool0-lun-1
     */
    VIR_DOMAIN_DISK_SOURCE_POOL_MODE_HOST,

    /* Use the URI from the storage pool source element host attribute. E.g.
     * file=iscsi://demo.org:6000/iqn.1992-01.com.example/1.
     */
    VIR_DOMAIN_DISK_SOURCE_POOL_MODE_DIRECT,

    VIR_DOMAIN_DISK_SOURCE_POOL_MODE_LAST
};

695 696 697 698
typedef struct _virDomainDiskSourcePoolDef virDomainDiskSourcePoolDef;
struct _virDomainDiskSourcePoolDef {
    char *pool; /* pool name */
    char *volume; /* volume name */
699
    int voltype; /* enum virStorageVolType, internal only */
700
    int pooltype; /* enum virStoragePoolType, internal only */
701
    int actualtype; /* enum virDomainDiskType, internal only */
702
    int mode; /* enum virDomainDiskSourcePoolMode */
703 704 705
};
typedef virDomainDiskSourcePoolDef *virDomainDiskSourcePoolDefPtr;

706 707 708 709 710 711 712
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
713
    int tray_status;
714
    int removable;
M
MORITA Kazutaka 已提交
715
    int protocol;
716
    size_t nhosts;
M
MORITA Kazutaka 已提交
717
    virDomainDiskHostDefPtr hosts;
718
    virDomainDiskSourcePoolDefPtr srcpool;
719 720 721 722 723 724 725 726
    struct {
        char *username;
        int secretType; /* enum virDomainDiskSecretType */
        union {
            unsigned char uuid[VIR_UUID_BUFLEN];
            char *usage;
        } secret;
    } auth;
727
    char *driverName;
728
    int format; /* enum virStorageFileFormat */
729
    virStorageFileMetadataPtr backingChain;
L
Lei Li 已提交
730

731
    char *mirror;
732
    int mirrorFormat; /* enum virStorageFileFormat */
733 734
    bool mirroring;

J
J.B. Joret 已提交
735 736 737 738 739 740 741
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
        int trans;
    } geometry;

742 743 744
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
745
    } blockio;
746

L
Lei Li 已提交
747 748
    virDomainBlockIoTuneInfo blkdeviotune;

749
    char *serial;
O
Osier Yang 已提交
750
    char *wwn;
751 752
    char *vendor;
    char *product;
753
    int cachemode;
754 755
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
M
Matthias Dahl 已提交
756
    int iomode;
757
    int ioeventfd;
758
    int event_idx;
O
Osier Yang 已提交
759
    int copy_on_read;
E
Eric Blake 已提交
760
    int snapshot; /* enum virDomainSnapshotLocation, snapshot_conf.h */
761
    int startupPolicy; /* enum virDomainStartupPolicy */
762
    bool readonly;
763
    bool shared;
764
    bool transient;
765
    virDomainDeviceInfo info;
766
    virStorageEncryptionPtr encryption;
767 768
    bool rawio_specified;
    int rawio; /* no = 0, yes = 1 */
769
    int sgio; /* enum virDomainDeviceSGIO */
O
Osier Yang 已提交
770
    int discard; /* enum virDomainDiskDiscard */
771 772 773

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
774 775 776
};


777 778 779 780 781
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
782
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
783
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
784
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
J
Ján Tomko 已提交
785
    VIR_DOMAIN_CONTROLLER_TYPE_PCI,
786 787 788 789

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

790

791
typedef enum {
J
Ján Tomko 已提交
792
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_ROOT,
L
Laine Stump 已提交
793
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT,
J
Ján Tomko 已提交
794
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_BRIDGE,
795
    VIR_DOMAIN_CONTROLLER_MODEL_DMI_TO_PCI_BRIDGE,
J
Ján Tomko 已提交
796 797

    VIR_DOMAIN_CONTROLLER_MODEL_PCI_LAST
798
} virDomainControllerModelPCI;
J
Ján Tomko 已提交
799

800 801 802 803 804 805
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,
806
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
807
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
808
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
809

810
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
811 812
};

M
Marc-André Lureau 已提交
813 814 815 816 817 818 819 820 821 822
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 已提交
823
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
824
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
825 826 827 828

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
};

829 830 831 832 833 834 835
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

836 837 838 839 840 841 842
typedef struct _virDomainPciControllerOpts virDomainPciControllerOpts;
typedef virDomainPciControllerOpts *virDomainPciControllerOptsPtr;
struct _virDomainPciControllerOpts {
    bool pcihole64;
    unsigned long pcihole64size;
};

843 844 845
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
846
    unsigned int idx;
847
    int model; /* -1 == undef */
848
    unsigned int queues;
849 850
    union {
        virDomainVirtioSerialOpts vioserial;
851
        virDomainPciControllerOpts pciopts;
852
    } opts;
853 854 855 856
    virDomainDeviceInfo info;
};


857 858
/* Two types of disk backends */
enum virDomainFSType {
859 860 861 862 863 864
    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 */
865 866 867 868

    VIR_DOMAIN_FS_TYPE_LAST
};

869 870 871 872 873
/* Filesystem driver type */
enum virDomainFSDriverType {
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,
874
    VIR_DOMAIN_FS_DRIVER_TYPE_LOOP,
875
    VIR_DOMAIN_FS_DRIVER_TYPE_NBD,
876 877 878 879

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
};

880 881 882 883 884 885 886 887 888
/* 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
};

889 890 891 892 893 894 895 896
/* Filesystem Write policy */
enum virDomainFSWrpolicy {
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
};

897 898 899
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

900 901
struct _virDomainFSDef {
    int type;
902 903
    int fsdriver; /* enum virDomainFSDriverType */
    int accessmode; /* enum virDomainFSAccessMode */
904
    int wrpolicy; /* enum virDomainFSWrpolicy */
905
    int format; /* enum virStorageFileFormat */
906
    unsigned long long usage; /* in bytes */
907 908
    char *src;
    char *dst;
909
    bool readonly;
910
    virDomainDeviceInfo info;
911 912
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
913 914 915
};


916
/* network config types */
917 918 919 920 921 922 923 924
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 已提交
925
    VIR_DOMAIN_NET_TYPE_INTERNAL,
926
    VIR_DOMAIN_NET_TYPE_DIRECT,
927
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
928

929
    VIR_DOMAIN_NET_TYPE_LAST
930 931
};

932 933 934 935 936 937
/* 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 */

938
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
939
};
940

941 942 943 944 945 946
/* 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,

947
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
948 949
};

950 951 952 953 954 955 956 957 958
/* 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
};

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
/* 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;
976 977 978
        struct {
            virDomainHostdevDef def;
        } hostdev;
979
    } data;
980
    virNetDevVPortProfilePtr virtPortProfile;
981
    virNetDevBandwidthPtr bandwidth;
982
    virNetDevVlan vlan;
983
    unsigned int class_id; /* class ID for bandwidth 'floor' */
984 985
};

986 987
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
S
Stefan Berger 已提交
988
    enum virDomainNetType type;
989
    virMacAddr mac;
990
    char *model;
991 992 993
    union {
        struct {
            enum virDomainNetBackendType name; /* which driver backend to use */
994
            enum virDomainNetVirtioTxModeType txmode;
995
            enum virDomainIoEventFd ioeventfd;
996
            enum virDomainVirtioEventIdx event_idx;
997
            unsigned int queues; /* Multiqueue virtio-net */
998 999
        } virtio;
    } driver;
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    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;
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
            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;
1021 1022 1023
        } network;
        struct {
            char *brname;
1024
            char *ipaddr;
1025
        } bridge;
D
Daniel Veillard 已提交
1026 1027 1028
        struct {
            char *name;
        } internal;
1029 1030
        struct {
            char *linkdev;
1031
            int mode; /* enum virMacvtapMode from util/macvtap.h */
1032
        } direct;
1033 1034 1035
        struct {
            virDomainHostdevDef def;
        } hostdev;
1036
    } data;
1037 1038
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
1039 1040 1041 1042
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
1043
    char *script;
1044
    char *ifname;
1045
    virDomainDeviceInfo info;
1046 1047
    char *filter;
    virNWFilterHashTablePtr filterparams;
1048
    virNetDevBandwidthPtr bandwidth;
1049
    virNetDevVlan vlan;
1050
    int linkstate;
1051 1052
};

E
Eric Blake 已提交
1053 1054 1055 1056
/* 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"

1057
enum virDomainChrDeviceType {
1058
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
1059 1060
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
1061
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
1062

1063
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
1064 1065
};

G
Guannan Ren 已提交
1066 1067 1068 1069 1070 1071 1072
enum virDomainChrSerialTargetType {
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
};

1073
enum virDomainChrChannelTargetType {
1074 1075
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
1076 1077
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

1078
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
1079 1080
};

1081
enum virDomainChrConsoleTargetType {
1082 1083
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
1084 1085
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
1086
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
1087 1088
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
1089 1090
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
1091

1092
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
1093 1094
};

1095
enum virDomainChrType {
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
    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,
1106
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
1107

1108
    VIR_DOMAIN_CHR_TYPE_LAST
1109 1110 1111 1112 1113
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1114 1115
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1116

1117
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1118 1119
};

E
Eric Blake 已提交
1120 1121 1122
enum virDomainChrSpicevmcName {
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1123
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1124

1125
    VIR_DOMAIN_CHR_SPICEVMC_LAST
E
Eric Blake 已提交
1126 1127
};

1128 1129 1130 1131 1132
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
1133
    union {
E
Eric Blake 已提交
1134
        /* no <source> for null, vc, stdio */
1135 1136 1137 1138 1139 1140
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
1141
            bool listen;
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
1152
            bool listen;
1153
        } nix;
E
Eric Blake 已提交
1154
        int spicevmc;
1155
    } data;
1156 1157 1158 1159 1160
};

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

    bool targetTypeAttr;
1163 1164 1165 1166 1167 1168 1169 1170
    int targetType;
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

    virDomainChrSourceDef source;
1171 1172

    virDomainDeviceInfo info;
1173 1174 1175

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1176 1177
};

E
Eric Blake 已提交
1178 1179 1180 1181 1182
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1183
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
E
Eric Blake 已提交
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
};

# 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 已提交
1203 1204 1205 1206 1207
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

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
enum virDomainTPMModel {
    VIR_DOMAIN_TPM_MODEL_TIS,

    VIR_DOMAIN_TPM_MODEL_LAST
};

enum virDomainTPMBackendType {
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,

    VIR_DOMAIN_TPM_TYPE_LAST
};

# define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"

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

1235 1236 1237 1238
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

1239
    VIR_DOMAIN_INPUT_TYPE_LAST
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
};

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;
1253
    virDomainDeviceInfo info;
1254 1255
};

1256 1257 1258 1259 1260 1261 1262
enum virDomainSoundCodecType {
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
};

1263 1264 1265 1266
enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1267
    VIR_DOMAIN_SOUND_MODEL_AC97,
1268
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1269
    VIR_DOMAIN_SOUND_MODEL_ICH9,
1270 1271 1272 1273

    VIR_DOMAIN_SOUND_MODEL_LAST
};

1274 1275 1276 1277 1278
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1279 1280
struct _virDomainSoundDef {
    int model;
1281
    virDomainDeviceInfo info;
1282

1283
    size_t ncodecs;
1284
    virDomainSoundCodecDefPtr *codecs;
1285 1286
};

R
Richard Jones 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
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 已提交
1299
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1300 1301 1302 1303 1304 1305 1306 1307
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

struct _virDomainWatchdogDef {
    int model;
    int action;
1308
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1309 1310
};

1311 1312 1313 1314 1315 1316 1317

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,
1318
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1319 1320 1321 1322 1323

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


1324 1325 1326
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1327 1328
    bool support3d;
    bool support2d;
1329 1330 1331
};


1332 1333
struct _virDomainVideoDef {
    int type;
1334 1335
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1336
    unsigned int heads;
1337
    bool primary;
1338
    virDomainVideoAccelDefPtr accel;
1339
    virDomainDeviceInfo info;
1340 1341
};

1342
/* graphics console modes */
1343 1344 1345
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1346 1347
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1348
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1349

1350
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1351 1352
};

1353 1354 1355 1356 1357 1358 1359 1360 1361
enum virDomainGraphicsVNCSharePolicy {
    VIR_DOMAIN_GRAPHICS_VNC_SHARE_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_VNC_SHARE_ALLOW_EXCLUSIVE,
    VIR_DOMAIN_GRAPHICS_VNC_SHARE_FORCE_SHARED,
    VIR_DOMAIN_GRAPHICS_VNC_SHARE_IGNORE,

    VIR_DOMAIN_GRAPHICS_VNC_SHARE_LAST
};

1362 1363 1364 1365 1366 1367 1368 1369 1370
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
};

1371 1372 1373 1374
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
1375
    bool expires; /* Whether there is an expiry time set */
1376
    time_t validTo;  /* seconds since epoch */
1377
    int connected; /* action if connected */
1378 1379
};

1380 1381 1382 1383 1384 1385 1386
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 已提交
1387
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1388
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399

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

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
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 已提交
1439 1440 1441 1442 1443 1444 1445 1446
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
};

1447 1448 1449 1450 1451 1452 1453 1454 1455
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
};

1456 1457 1458 1459 1460 1461 1462 1463
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
};

1464 1465 1466 1467 1468 1469 1470 1471
enum virDomainGraphicsSpiceAgentFileTransfer {
    VIR_DOMAIN_GRAPHICS_SPICE_AGENT_FILE_TRANSFER_DEFAULT = 0,
    VIR_DOMAIN_GRAPHICS_SPICE_AGENT_FILE_TRANSFER_YES,
    VIR_DOMAIN_GRAPHICS_SPICE_AGENT_FILE_TRANSFER_NO,

    VIR_DOMAIN_GRAPHICS_SPICE_AGENT_FILE_TRANSFER_LAST
};

1472 1473 1474 1475 1476
enum virDomainGraphicsListenType {
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,

1477
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1478 1479
};

M
Marc-André Lureau 已提交
1480 1481 1482
enum virDomainHubType {
    VIR_DOMAIN_HUB_TYPE_USB,

1483
    VIR_DOMAIN_HUB_TYPE_LAST
M
Marc-André Lureau 已提交
1484 1485
};

1486 1487 1488 1489 1490 1491
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
    int type;   /* enum virDomainGraphicsListenType */
    char *address;
    char *network;
1492
    bool fromConfig;    /* true if the @address is config file originated */
1493 1494
};

1495
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1496 1497 1498 1499 1500
    /* 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.
     */
1501 1502 1503 1504
    int type;
    union {
        struct {
            int port;
M
Martin Kletzander 已提交
1505
            int websocket;
1506
            bool autoport;
1507
            char *keymap;
1508
            char *socket;
1509
            virDomainGraphicsAuthDef auth;
1510
            int sharePolicy;
1511 1512 1513 1514
        } vnc;
        struct {
            char *display;
            char *xauth;
1515
            bool fullscreen;
1516
        } sdl;
1517 1518
        struct {
            int port;
1519 1520 1521
            bool autoport;
            bool replaceUser;
            bool multiUser;
1522 1523 1524
        } rdp;
        struct {
            char *display;
1525
            bool fullscreen;
1526
        } desktop;
1527 1528 1529
        struct {
            int port;
            int tlsPort;
P
Peng Zhou 已提交
1530
            int mousemode;
1531
            char *keymap;
1532
            virDomainGraphicsAuthDef auth;
1533
            bool autoport;
1534
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1535
            int defaultMode; /* enum virDomainGraphicsSpiceChannelMode */
1536 1537 1538 1539
            int image;
            int jpeg;
            int zlib;
            int playback;
1540
            int streaming;
1541
            int copypaste;
1542
            int filetransfer;
1543
        } spice;
1544
    } data;
1545 1546 1547 1548 1549
    /* 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;
1550 1551
};

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
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 */
};
1567

1568 1569 1570 1571 1572
struct _virDomainRedirFilterUsbDevDef {
    int usbClass;
    int vendor;
    int product;
    int version;
1573
    bool allow;
1574 1575 1576 1577 1578 1579 1580
};

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

1581 1582 1583 1584 1585 1586 1587 1588
enum virDomainMemDump {
    VIR_DOMAIN_MEM_DUMP_DEFAULT = 0,
    VIR_DOMAIN_MEM_DUMP_ON,
    VIR_DOMAIN_MEM_DUMP_OFF,

    VIR_DOMAIN_MEM_DUMP_LAST,
};

1589 1590 1591
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1592
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1593 1594 1595 1596 1597 1598 1599

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
1600
    unsigned int period; /* seconds between collections */
1601 1602
};

L
Li Zhang 已提交
1603 1604 1605
struct _virDomainNVRAMDef {
    virDomainDeviceInfo info;
};
1606

1607
enum virDomainSmbiosMode {
1608
    VIR_DOMAIN_SMBIOS_NONE = 0,
1609 1610 1611 1612 1613 1614 1615
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

1616

1617
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1618 1619 1620 1621 1622 1623 1624

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1625
    VIR_DOMAIN_BOOT_LAST
1626 1627
};

1628 1629 1630 1631
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
1632 1633

    VIR_DOMAIN_BOOT_MENU_LAST
1634 1635
};

1636 1637 1638 1639
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1640
    VIR_DOMAIN_FEATURE_HAP,
1641
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1642
    VIR_DOMAIN_FEATURE_PRIVNET,
1643
    VIR_DOMAIN_FEATURE_HYPERV,
1644
    VIR_DOMAIN_FEATURE_PVSPINLOCK,
1645 1646 1647 1648

    VIR_DOMAIN_FEATURE_LAST
};

1649 1650 1651 1652
enum virDomainFeatureState {
    VIR_DOMAIN_FEATURE_STATE_DEFAULT = 0,
    VIR_DOMAIN_FEATURE_STATE_ON,
    VIR_DOMAIN_FEATURE_STATE_OFF,
1653

1654
    VIR_DOMAIN_FEATURE_STATE_LAST
1655 1656
};

1657 1658
enum virDomainHyperv {
    VIR_DOMAIN_HYPERV_RELAXED = 0,
1659 1660
    VIR_DOMAIN_HYPERV_VAPIC,
    VIR_DOMAIN_HYPERV_SPINLOCKS,
1661 1662 1663 1664

    VIR_DOMAIN_HYPERV_LAST
};

1665 1666 1667 1668 1669 1670 1671 1672 1673
enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
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
};

1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
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)

1697 1698 1699 1700 1701
enum virDomainPMState {
    VIR_DOMAIN_PM_STATE_DEFAULT = 0,
    VIR_DOMAIN_PM_STATE_ENABLED,
    VIR_DOMAIN_PM_STATE_DISABLED,

1702
    VIR_DOMAIN_PM_STATE_LAST
1703 1704
};

M
Michal Privoznik 已提交
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
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;
1715 1716 1717
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1718 1719
};

1720 1721 1722 1723 1724
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
1725
    virArch arch;
1726
    char *machine;
1727
    size_t nBootDevs;
1728
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
1729
    /* enum virDomainBootMenu */
1730
    int bootmenu;
1731
    char *init;
1732
    char **initargv;
1733 1734 1735
    char *kernel;
    char *initrd;
    char *cmdline;
1736
    char *dtb;
1737 1738 1739 1740
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
1741
    int smbios_mode;
1742

M
Michal Privoznik 已提交
1743
    virDomainBIOSDef bios;
1744 1745
};

1746 1747 1748 1749 1750 1751
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 已提交
1752
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1753
    VIR_DOMAIN_TIMER_NAME_HYPERVCLOCK,
1754

1755
    VIR_DOMAIN_TIMER_NAME_LAST
1756 1757
};

1758 1759 1760 1761
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1762

1763
    VIR_DOMAIN_TIMER_TRACK_LAST
1764 1765 1766 1767 1768 1769 1770 1771
};

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

1772
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1773 1774 1775 1776 1777 1778 1779
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1780
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1781

1782
    VIR_DOMAIN_TIMER_MODE_LAST
1783 1784
};

O
Osier Yang 已提交
1785
enum virDomainCpuPlacementMode {
1786
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1787 1788
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1789
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
O
Osier Yang 已提交
1790 1791
};

1792 1793 1794 1795 1796 1797 1798 1799
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1800 1801 1802 1803 1804 1805 1806
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 */

1807 1808 1809 1810
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1811 1812 1813 1814 1815 1816

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

1817 1818 1819
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1820
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1821
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1822

1823
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1824 1825
};

1826 1827 1828 1829
enum virDomainClockBasis {
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1830
    VIR_DOMAIN_CLOCK_BASIS_LAST
1831 1832
};

1833 1834 1835 1836
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1837

1838
    union {
1839 1840 1841
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
1842
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
1843 1844 1845
        struct {
            long long adjustment;
            int basis;
1846 1847 1848 1849 1850

            /* Store the base date (-rtc base=$date, in seconds
             * since the Epoch) of guest process, internal only
             */
            unsigned long long basedate;
1851
        } variable;
1852 1853 1854 1855 1856

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

1858
    size_t ntimers;
1859
    virDomainTimerDefPtr *timers;
1860 1861
};

1862
# define VIR_DOMAIN_CPUMASK_LEN 1024
1863

E
Eric Blake 已提交
1864 1865 1866
typedef struct _virDomainVcpuPinDef virDomainVcpuPinDef;
typedef virDomainVcpuPinDef *virDomainVcpuPinDefPtr;
struct _virDomainVcpuPinDef {
1867
    int vcpuid;
H
Hu Tao 已提交
1868
    virBitmapPtr cpumask;
1869 1870
};

H
Hu Tao 已提交
1871 1872
void virDomainVcpuPinDefFree(virDomainVcpuPinDefPtr def);
void virDomainVcpuPinDefArrayFree(virDomainVcpuPinDefPtr *def, int nvcpupin);
1873 1874 1875 1876

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

E
Eric Blake 已提交
1877
int virDomainVcpuPinIsDuplicate(virDomainVcpuPinDefPtr *def,
1878 1879 1880
                                int nvcpupin,
                                int vcpu);

E
Eric Blake 已提交
1881
virDomainVcpuPinDefPtr virDomainVcpuPinFindByVcpu(virDomainVcpuPinDefPtr *def,
1882 1883 1884
                                                  int nvcpupin,
                                                  int vcpu);

1885 1886 1887
typedef struct _virBlkioDevice virBlkioDevice;
typedef virBlkioDevice *virBlkioDevicePtr;
struct _virBlkioDevice {
1888 1889
    char *path;
    unsigned int weight;
1890 1891 1892 1893
    unsigned int riops;
    unsigned int wiops;
    unsigned long long rbps;
    unsigned long long wbps;
1894 1895
};

1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
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;
1913 1914
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924

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

    virDomainDeviceInfo info;
};

1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
struct _virDomainIdMapEntry {
    unsigned int start;
    unsigned int target;
    unsigned int count;
};

struct _virDomainIdMapDef {
    size_t nuidmap;
    virDomainIdMapEntryPtr uidmap;

    size_t ngidmap;
    virDomainIdMapEntryPtr gidmap;
};


H
Hu Tao 已提交
1940 1941 1942 1943 1944
struct _virDomainPanicDef {
    virDomainDeviceInfo info;
};


1945
void virBlkioDeviceArrayClear(virBlkioDevicePtr deviceWeights,
1946
                              int ndevices);
1947

1948 1949 1950 1951 1952
typedef struct _virDomainResourceDef virDomainResourceDef;
typedef virDomainResourceDef *virDomainResourceDefPtr;
struct _virDomainResourceDef {
    char *partition;
};
1953

1954 1955 1956 1957 1958 1959
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
1960 1961 1962 1963 1964 1965 1966
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1967
    char *title;
1968
    char *description;
1969

1970 1971
    struct {
        unsigned int weight;
1972 1973

        size_t ndevices;
1974
        virBlkioDevicePtr devices;
1975 1976
    } blkio;

1977
    struct {
1978 1979 1980
        unsigned long long max_balloon; /* in kibibytes */
        unsigned long long cur_balloon; /* in kibibytes */
        bool hugepage_backed;
1981
        bool nosharepages;
1982
        bool locked;
1983
        int dump_core; /* enum virDomainMemDump */
1984 1985 1986 1987
        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 */
1988
    } mem;
E
Eric Blake 已提交
1989 1990
    unsigned short vcpus;
    unsigned short maxvcpus;
O
Osier Yang 已提交
1991
    int placement_mode;
H
Hu Tao 已提交
1992
    virBitmapPtr cpumask;
1993

1994 1995
    struct {
        unsigned long shares;
1996 1997
        unsigned long long period;
        long long quota;
1998 1999
        unsigned long long emulator_period;
        long long emulator_quota;
2000
        int nvcpupin;
E
Eric Blake 已提交
2001
        virDomainVcpuPinDefPtr *vcpupin;
T
Tang Chen 已提交
2002
        virDomainVcpuPinDefPtr emulatorpin;
2003 2004
    } cputune;

G
Gao feng 已提交
2005
    virNumaTuneDef numatune;
2006
    virDomainResourceDefPtr resource;
2007
    virDomainIdMapDef idmap;
2008

2009 2010 2011 2012 2013
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

2014 2015
    int onLockFailure; /* enum virDomainLockFailureAction */

2016 2017 2018 2019 2020 2021
    struct {
        /* These options are actually type of enum virDomainPMState */
        int s3;
        int s4;
    } pm;

2022 2023
    virDomainOSDef os;
    char *emulator;
2024
    int features[VIR_DOMAIN_FEATURE_LAST];
2025
    /* enum virDomainFeatureState */
2026
    int apic_eoi;
2027 2028
    /* These options are of type virDomainFeatureState */
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
2029
    unsigned int hyperv_spinlocks;
2030

2031
    virDomainClockDef clock;
2032

2033
    size_t ngraphics;
2034
    virDomainGraphicsDefPtr *graphics;
2035

2036
    size_t ndisks;
2037 2038
    virDomainDiskDefPtr *disks;

2039
    size_t ncontrollers;
2040 2041
    virDomainControllerDefPtr *controllers;

2042
    size_t nfss;
2043 2044
    virDomainFSDefPtr *fss;

2045
    size_t nnets;
2046 2047
    virDomainNetDefPtr *nets;

2048
    size_t ninputs;
2049 2050
    virDomainInputDefPtr *inputs;

2051
    size_t nsounds;
2052 2053
    virDomainSoundDefPtr *sounds;

2054
    size_t nvideos;
2055 2056
    virDomainVideoDefPtr *videos;

2057
    size_t nhostdevs;
2058 2059
    virDomainHostdevDefPtr *hostdevs;

2060
    size_t nredirdevs;
2061 2062
    virDomainRedirdevDefPtr *redirdevs;

2063
    size_t nsmartcards;
E
Eric Blake 已提交
2064 2065
    virDomainSmartcardDefPtr *smartcards;

2066
    size_t nserials;
2067 2068
    virDomainChrDefPtr *serials;

2069
    size_t nparallels;
2070 2071
    virDomainChrDefPtr *parallels;

2072
    size_t nchannels;
2073 2074
    virDomainChrDefPtr *channels;

2075
    size_t nconsoles;
2076 2077
    virDomainChrDefPtr *consoles;

2078
    size_t nleases;
2079 2080
    virDomainLeaseDefPtr *leases;

2081
    size_t nhubs;
M
Marc-André Lureau 已提交
2082 2083
    virDomainHubDefPtr *hubs;

2084 2085 2086
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

2087
    /* Only 1 */
R
Richard Jones 已提交
2088
    virDomainWatchdogDefPtr watchdog;
2089
    virDomainMemballoonDefPtr memballoon;
L
Li Zhang 已提交
2090
    virDomainNVRAMDefPtr nvram;
2091
    virDomainTPMDefPtr tpm;
2092
    virCPUDefPtr cpu;
2093
    virSysinfoDefPtr sysinfo;
2094
    virDomainRedirFilterDefPtr redirfilter;
2095
    virDomainRNGDefPtr rng;
H
Hu Tao 已提交
2096
    virDomainPanicDefPtr panic;
2097 2098 2099

    void *namespaceData;
    virDomainXMLNamespace ns;
2100 2101 2102

    /* Application-specific custom metadata */
    xmlNodePtr metadata;
2103 2104
};

2105 2106 2107 2108 2109 2110
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 */
2111
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
2112
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
2113 2114 2115 2116

    VIR_DOMAIN_TAINT_LAST
};

2117
/* Guest VM runtime state */
J
Jiri Denemark 已提交
2118 2119 2120 2121 2122 2123
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

2124 2125 2126
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
2127
    virObjectLockable parent;
2128

2129
    pid_t pid;
J
Jiri Denemark 已提交
2130
    virDomainStateReason state;
2131 2132 2133

    unsigned int autostart : 1;
    unsigned int persistent : 1;
2134
    unsigned int updated : 1;
2135 2136 2137

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

2139
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
2140 2141
    virDomainSnapshotObjPtr current_snapshot;

2142 2143
    bool hasManagedSave;

2144 2145
    void *privateData;
    void (*privateDataFreeFunc)(void *);
2146 2147

    int taint;
2148 2149
};

2150 2151
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
2152

2153 2154 2155
typedef bool (*virDomainObjListFilter)(virConnectPtr conn,
                                       virDomainDefPtr def);

2156 2157 2158

/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
2159 2160
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
2161 2162 2163 2164 2165 2166

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

2167 2168
/* Called once after everything else has been parsed, for adjusting
 * overall domain defaults.  */
2169 2170 2171
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
                                             virCapsPtr caps,
                                             void *opaque);
2172 2173
/* Called once per device, for adjusting per-device settings while
 * leaving the overall domain otherwise unchanged.  */
2174
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
2175
                                                   const virDomainDef *def,
2176 2177 2178 2179 2180 2181
                                                   virCapsPtr caps,
                                                   void *opaque);

typedef struct _virDomainDefParserConfig virDomainDefParserConfig;
typedef virDomainDefParserConfig *virDomainDefParserConfigPtr;
struct _virDomainDefParserConfig {
2182
    /* driver domain definition callbacks */
2183 2184 2185
    virDomainDefPostParseCallback domainPostParseCallback;
    virDomainDeviceDefPostParseCallback devicesPostParseCallback;

2186
    /* private data for the callbacks */
2187 2188
    void *priv;
    virFreeCallback privFree;
2189 2190 2191

    /* data */
    bool hasWideScsiBus;
2192
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2193 2194
};

2195 2196 2197 2198 2199 2200 2201 2202 2203
typedef struct _virDomainXMLPrivateDataCallbacks virDomainXMLPrivateDataCallbacks;
typedef virDomainXMLPrivateDataCallbacks *virDomainXMLPrivateDataCallbacksPtr;
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
};

2204 2205 2206
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
                                            virDomainXMLNamespacePtr xmlns);
2207

2208 2209
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2210
virDomainXMLNamespacePtr
2211
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2212 2213
    ATTRIBUTE_NONNULL(1);

2214 2215 2216 2217 2218
int
virDomainDefPostParse(virDomainDefPtr def,
                      virCapsPtr caps,
                      virDomainXMLOptionPtr xmlopt);

2219
static inline bool
D
Daniel P. Berrange 已提交
2220
virDomainObjIsActive(virDomainObjPtr dom)
2221 2222 2223 2224
{
    return dom->def->id != -1;
}

2225
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2226
    ATTRIBUTE_NONNULL(1);
2227

2228
virDomainObjListPtr virDomainObjListNew(void);
2229

2230
virDomainObjPtr virDomainObjListFindByID(virDomainObjListPtr doms,
2231
                                         int id);
2232
virDomainObjPtr virDomainObjListFindByUUID(virDomainObjListPtr doms,
2233
                                           const unsigned char *uuid);
2234
virDomainObjPtr virDomainObjListFindByName(virDomainObjListPtr doms,
2235
                                           const char *name);
2236

2237 2238
bool virDomainObjTaint(virDomainObjPtr obj,
                       enum virDomainTaintFlags taint);
2239

H
Hu Tao 已提交
2240
void virDomainPanicDefFree(virDomainPanicDefPtr panic);
2241
void virDomainResourceDefFree(virDomainResourceDefPtr resource);
2242 2243 2244
void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
2245
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2246
void virDomainDiskAuthClear(virDomainDiskDefPtr def);
2247
void virDomainDiskHostDefClear(virDomainDiskHostDefPtr def);
2248 2249 2250
void virDomainDiskHostDefFree(size_t nhosts, virDomainDiskHostDefPtr hosts);
virDomainDiskHostDefPtr virDomainDiskHostDefCopy(size_t nhosts,
                                                 virDomainDiskHostDefPtr hosts);
H
Han Cheng 已提交
2251 2252 2253
int virDomainDeviceFindControllerModel(virDomainDefPtr def,
                                       virDomainDeviceInfoPtr info,
                                       int controllerType);
2254 2255 2256
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2257
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2258
void virDomainFSDefFree(virDomainFSDefPtr def);
2259
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
2260
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2261
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2262
void virDomainChrDefFree(virDomainChrDefPtr def);
2263
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
2264 2265
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
2266
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2267
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2268
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
L
Li Zhang 已提交
2269
void virDomainNVRAMDefFree(virDomainNVRAMDefPtr def);
R
Richard Jones 已提交
2270
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2271
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2272 2273
virDomainHostdevDefPtr virDomainHostdevDefAlloc(void);
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2274
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2275
void virDomainHubDefFree(virDomainHubDefPtr def);
2276
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2277
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2278
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2279
virDomainDeviceDefPtr virDomainDeviceDefCopy(virDomainDeviceDefPtr src,
2280
                                             const virDomainDef *def,
2281 2282
                                             virCapsPtr caps,
                                             virDomainXMLOptionPtr xmlopt);
2283 2284
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2285 2286
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
2287
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
2288
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
2289
void virDomainDefClearCCWAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
2290
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
2291
void virDomainTPMDefFree(virDomainTPMDefPtr def);
2292

2293
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2294 2295
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2296 2297 2298 2299 2300 2301
                                           void *opaque);

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

2302 2303
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
2304 2305
virDomainChrDefPtr virDomainChrDefNew(void);

2306 2307 2308 2309
virDomainDefPtr virDomainDefNew(const char *name,
                                const unsigned char *uuid,
                                int id);

2310 2311 2312 2313
enum {
    VIR_DOMAIN_OBJ_LIST_ADD_LIVE = (1 << 0),
    VIR_DOMAIN_OBJ_LIST_ADD_CHECK_LIVE = (1 << 1),
};
2314
virDomainObjPtr virDomainObjListAdd(virDomainObjListPtr doms,
2315
                                    virDomainDefPtr def,
2316
                                    virDomainXMLOptionPtr xmlopt,
2317 2318
                                    unsigned int flags,
                                    virDomainDefPtr *oldDef);
2319
void virDomainObjAssignDef(virDomainObjPtr domain,
2320
                           virDomainDefPtr def,
2321 2322
                           bool live,
                           virDomainDefPtr *oldDef);
2323
int virDomainObjSetDefTransient(virCapsPtr caps,
2324
                                virDomainXMLOptionPtr xmlopt,
2325 2326
                                virDomainObjPtr domain,
                                bool live);
2327 2328
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2329
                             virDomainXMLOptionPtr xmlopt,
2330
                             virDomainObjPtr domain);
2331 2332 2333

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
2334
                                virDomainXMLOptionPtr xmlopt,
2335 2336 2337 2338
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

2339 2340 2341 2342 2343 2344 2345
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virCapsPtr caps,
                                 virDomainXMLOptionPtr xmlopt,
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt);
2346

2347 2348
void virDomainObjListRemove(virDomainObjListPtr doms,
                            virDomainObjPtr dom);
2349 2350
void virDomainObjListRemoveLocked(virDomainObjListPtr doms,
                                  virDomainObjPtr dom);
2351

2352
virDomainDeviceDefPtr virDomainDeviceDefParse(const char *xmlStr,
2353
                                              const virDomainDef *def,
2354 2355
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2356
                                              unsigned int flags);
2357 2358
virDomainDefPtr virDomainDefParseString(const char *xmlStr,
                                        virCapsPtr caps,
2359
                                        virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2360
                                        unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2361
                                        unsigned int flags);
2362 2363
virDomainDefPtr virDomainDefParseFile(const char *filename,
                                      virCapsPtr caps,
2364
                                      virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2365
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2366
                                      unsigned int flags);
2367
virDomainDefPtr virDomainDefParseNode(xmlDocPtr doc,
2368
                                      xmlNodePtr root,
2369 2370
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
M
Matthias Bolte 已提交
2371
                                      unsigned int expectedVirtTypes,
L
Laine Stump 已提交
2372
                                      unsigned int flags);
2373

2374 2375 2376
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2377
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
2378

2379
char *virDomainDefFormat(virDomainDefPtr def,
L
Laine Stump 已提交
2380
                         unsigned int flags);
2381 2382 2383
int virDomainDefFormatInternal(virDomainDefPtr def,
                               unsigned int flags,
                               virBufferPtr buf);
2384

2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
int virDomainDiskSourceDefFormatInternal(virBufferPtr buf,
                                         int type,
                                         const char *src,
                                         int policy,
                                         int protocol,
                                         size_t nhosts,
                                         virDomainDiskHostDefPtr hosts,
                                         size_t nseclabels,
                                         virSecurityDeviceLabelDefPtr *seclabels,
                                         virDomainDiskSourcePoolDefPtr srcpool,
                                         unsigned int flags);

2397 2398 2399
int virDomainDefCompatibleDevice(virDomainDefPtr def,
                                 virDomainDeviceDefPtr dev);

2400
int virDomainVcpuPinAdd(virDomainVcpuPinDefPtr **vcpupin_list,
H
Hu Tao 已提交
2401
                        int *nvcpupin,
2402 2403 2404 2405
                        unsigned char *cpumap,
                        int maplen,
                        int vcpu);

E
Eric Blake 已提交
2406
int virDomainVcpuPinDel(virDomainDefPtr def, int vcpu);
2407

2408 2409 2410 2411 2412 2413
int virDomainEmulatorPinAdd(virDomainDefPtr def,
                              unsigned char *cpumap,
                              int maplen);

int virDomainEmulatorPinDel(virDomainDefPtr def);

2414 2415
void virDomainRNGDefFree(virDomainRNGDefPtr def);

2416 2417 2418
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2419
int virDomainDiskInsert(virDomainDefPtr def,
2420 2421
                        virDomainDiskDefPtr disk)
    ATTRIBUTE_RETURN_CHECK;
2422 2423
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2424 2425
int virDomainDiskDefAssignAddress(virDomainXMLOptionPtr xmlopt,
                                  virDomainDiskDefPtr def);
2426

2427 2428 2429 2430
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
2431 2432 2433 2434 2435 2436 2437 2438
int virDomainDiskSourceDefParse(xmlNodePtr node,
                                int type,
                                char **source,
                                int *proto,
                                size_t *nhosts,
                                virDomainDiskHostDefPtr *hosts,
                                virDomainDiskSourcePoolDefPtr *srcpool);

E
Eric Blake 已提交
2439
bool virDomainHasDiskMirror(virDomainObjPtr vm);
2440

2441 2442
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2443
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2444
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2445
void virDomainNetRemoveHostdev(virDomainDefPtr def, virDomainNetDefPtr net);
2446

L
Laine Stump 已提交
2447
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2448 2449
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2450 2451 2452
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2453
int virDomainGraphicsListenGetType(virDomainGraphicsDefPtr def, size_t i)
2454
            ATTRIBUTE_NONNULL(1);
2455
int virDomainGraphicsListenSetType(virDomainGraphicsDefPtr def, size_t i, int val)
2456 2457
            ATTRIBUTE_NONNULL(1);
const char *virDomainGraphicsListenGetAddress(virDomainGraphicsDefPtr def,
2458
                                              size_t i)
2459 2460
            ATTRIBUTE_NONNULL(1);
int virDomainGraphicsListenSetAddress(virDomainGraphicsDefPtr def,
2461
                                      size_t i, const char *address,
2462 2463 2464
                                      int len, bool setType)
            ATTRIBUTE_NONNULL(1);
const char *virDomainGraphicsListenGetNetwork(virDomainGraphicsDefPtr def,
2465
                                              size_t i)
2466 2467
            ATTRIBUTE_NONNULL(1);
int virDomainGraphicsListenSetNetwork(virDomainGraphicsDefPtr def,
2468
                                      size_t i, const char *network, int len)
2469 2470
            ATTRIBUTE_NONNULL(1);

2471
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2472 2473
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2474
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2475
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2476
virNetDevVPortProfilePtr
2477
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2478
virNetDevBandwidthPtr
2479
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2480
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2481

2482
int virDomainControllerInsert(virDomainDefPtr def,
2483 2484
                              virDomainControllerDefPtr controller)
    ATTRIBUTE_RETURN_CHECK;
2485 2486
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2487 2488
int virDomainControllerFind(virDomainDefPtr def, int type, int idx);
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2489 2490 2491 2492 2493

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
2494 2495
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def)
    ATTRIBUTE_RETURN_CHECK;
2496 2497
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2498 2499 2500 2501 2502
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2503

2504
void
2505 2506 2507 2508 2509
virDomainChrGetDomainPtrs(const virDomainDef *vmdef,
                          enum virDomainChrDeviceType type,
                          const virDomainChrDef ***arrPtr,
                          size_t *cntPtr)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
2510 2511 2512
virDomainChrDefPtr
virDomainChrFind(virDomainDefPtr def,
                 virDomainChrDefPtr target);
2513 2514 2515
bool
virDomainChrEquals(virDomainChrDefPtr src,
                   virDomainChrDefPtr tgt);
2516 2517 2518 2519 2520 2521 2522
int
virDomainChrInsert(virDomainDefPtr vmdef,
                   virDomainChrDefPtr chr);
virDomainChrDefPtr
virDomainChrRemove(virDomainDefPtr vmdef,
                   virDomainChrDefPtr chr);

2523
int virDomainSaveXML(const char *configDir,
2524 2525 2526
                     virDomainDefPtr def,
                     const char *xml);

2527
int virDomainSaveConfig(const char *configDir,
2528
                        virDomainDefPtr def);
2529
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
2530
                        const char *statusDir,
2531
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
2532

2533 2534 2535 2536
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2537 2538 2539 2540
int virDomainObjListLoadAllConfigs(virDomainObjListPtr doms,
                                   const char *configDir,
                                   const char *autostartDir,
                                   int liveStatus,
2541 2542
                                   virCapsPtr caps,
                                   virDomainXMLOptionPtr xmlopt,
2543 2544 2545
                                   unsigned int expectedVirtTypes,
                                   virDomainLoadConfigNotify notify,
                                   void *opaque);
2546

2547
int virDomainDeleteConfig(const char *configDir,
2548
                          const char *autostartDir,
2549 2550
                          virDomainObjPtr dom);

2551
char *virDomainConfigFile(const char *dir,
2552 2553
                          const char *name);

2554 2555 2556 2557
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2558
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
2559
int virDomainFSInsert(virDomainDefPtr def, virDomainFSDefPtr fs);
2560
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2561 2562
virDomainFSDefPtr virDomainFSRemove(virDomainDefPtr def, size_t i);

2563 2564
int virDomainVideoDefaultType(const virDomainDef *def);
int virDomainVideoDefaultRAM(const virDomainDef *def, int type);
2565

2566 2567 2568 2569
int virDomainObjListNumOfDomains(virDomainObjListPtr doms,
                                 bool active,
                                 virDomainObjListFilter filter,
                                 virConnectPtr conn);
2570 2571 2572

int virDomainObjListGetActiveIDs(virDomainObjListPtr doms,
                                 int *ids,
2573 2574 2575
                                 int maxids,
                                 virDomainObjListFilter filter,
                                 virConnectPtr conn);
2576 2577
int virDomainObjListGetInactiveNames(virDomainObjListPtr doms,
                                     char **const names,
2578 2579 2580
                                     int maxnames,
                                     virDomainObjListFilter filter,
                                     virConnectPtr conn);
2581

2582 2583 2584 2585 2586 2587 2588
typedef int (*virDomainObjListIterator)(virDomainObjPtr dom,
                                        void *opaque);

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

E
Eric Blake 已提交
2589 2590 2591 2592 2593 2594 2595 2596 2597
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

2598 2599 2600 2601 2602 2603 2604 2605 2606
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
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 已提交
2617 2618 2619 2620 2621 2622 2623
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2624 2625 2626 2627 2628 2629
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

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

2630 2631 2632
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2633
virSecurityLabelDefPtr
2634
virDomainDefGenSecurityLabelDef(const char *model);
2635

2636
virSecurityDeviceLabelDefPtr
2637 2638 2639 2640
virDomainDiskDefGenSecurityLabelDef(const char *model);

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

2642 2643
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2644

2645 2646
VIR_ENUM_DECL(virDomainTaint)

2647 2648
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
2649
VIR_ENUM_DECL(virDomainBootMenu)
2650
VIR_ENUM_DECL(virDomainFeature)
2651
VIR_ENUM_DECL(virDomainFeatureState)
2652
VIR_ENUM_DECL(virDomainLifecycle)
2653
VIR_ENUM_DECL(virDomainLifecycleCrash)
2654
VIR_ENUM_DECL(virDomainPMState)
2655
VIR_ENUM_DECL(virDomainDevice)
2656
VIR_ENUM_DECL(virDomainDeviceAddress)
2657 2658
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
2659
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
2660
VIR_ENUM_DECL(virDomainDiskBus)
2661
VIR_ENUM_DECL(virDomainDiskCache)
2662
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
2663
VIR_ENUM_DECL(virDomainDiskProtocol)
2664
VIR_ENUM_DECL(virDomainDiskProtocolTransport)
M
Matthias Dahl 已提交
2665
VIR_ENUM_DECL(virDomainDiskIo)
2666
VIR_ENUM_DECL(virDomainDiskSecretType)
2667
VIR_ENUM_DECL(virDomainDeviceSGIO)
2668
VIR_ENUM_DECL(virDomainDiskTray)
O
Osier Yang 已提交
2669
VIR_ENUM_DECL(virDomainDiskDiscard)
2670
VIR_ENUM_DECL(virDomainDiskSourcePoolMode)
2671
VIR_ENUM_DECL(virDomainIoEventFd)
2672
VIR_ENUM_DECL(virDomainVirtioEventIdx)
O
Osier Yang 已提交
2673
VIR_ENUM_DECL(virDomainDiskCopyOnRead)
2674
VIR_ENUM_DECL(virDomainController)
J
Ján Tomko 已提交
2675
VIR_ENUM_DECL(virDomainControllerModelPCI)
2676
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
2677
VIR_ENUM_DECL(virDomainControllerModelUSB)
2678
VIR_ENUM_DECL(virDomainFS)
2679
VIR_ENUM_DECL(virDomainFSDriverType)
2680
VIR_ENUM_DECL(virDomainFSAccessMode)
2681
VIR_ENUM_DECL(virDomainFSWrpolicy)
2682
VIR_ENUM_DECL(virDomainNet)
2683
VIR_ENUM_DECL(virDomainNetBackend)
2684
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
2685
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
2686
VIR_ENUM_DECL(virDomainChrDevice)
2687
VIR_ENUM_DECL(virDomainChrChannelTarget)
2688
VIR_ENUM_DECL(virDomainChrConsoleTarget)
G
Guannan Ren 已提交
2689
VIR_ENUM_DECL(virDomainChrSerialTarget)
E
Eric Blake 已提交
2690
VIR_ENUM_DECL(virDomainSmartcard)
2691
VIR_ENUM_DECL(virDomainChr)
2692
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
2693
VIR_ENUM_DECL(virDomainChrSpicevmc)
2694
VIR_ENUM_DECL(virDomainSoundCodec)
2695
VIR_ENUM_DECL(virDomainSoundModel)
2696
VIR_ENUM_DECL(virDomainMemDump)
2697
VIR_ENUM_DECL(virDomainMemballoonModel)
2698
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
2699 2700
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
2701
VIR_ENUM_DECL(virDomainVideo)
2702 2703
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
2704
VIR_ENUM_DECL(virDomainHostdevCaps)
2705
VIR_ENUM_DECL(virDomainPciRombarMode)
M
Marc-André Lureau 已提交
2706
VIR_ENUM_DECL(virDomainHub)
2707
VIR_ENUM_DECL(virDomainRedirdevBus)
2708 2709 2710
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2711
VIR_ENUM_DECL(virDomainGraphicsListen)
2712
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2713
VIR_ENUM_DECL(virDomainGraphicsSpiceAgentFileTransfer)
2714 2715
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2716 2717 2718 2719
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
VIR_ENUM_DECL(virDomainGraphicsSpicePlaybackCompression)
2720
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
2721
VIR_ENUM_DECL(virDomainGraphicsSpiceClipboardCopypaste)
P
Peng Zhou 已提交
2722
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
2723
VIR_ENUM_DECL(virDomainGraphicsVNCSharePolicy)
2724
VIR_ENUM_DECL(virDomainHyperv)
2725 2726
VIR_ENUM_DECL(virDomainRNGModel)
VIR_ENUM_DECL(virDomainRNGBackend)
2727 2728
VIR_ENUM_DECL(virDomainTPMModel)
VIR_ENUM_DECL(virDomainTPMBackend)
2729 2730
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
2731 2732 2733 2734 2735 2736 2737
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)
2738
VIR_ENUM_DECL(virDomainPMSuspendedReason)
J
Jiri Denemark 已提交
2739 2740 2741 2742

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

2743
VIR_ENUM_DECL(virDomainSeclabel)
2744
VIR_ENUM_DECL(virDomainClockOffset)
2745
VIR_ENUM_DECL(virDomainClockBasis)
2746

2747
VIR_ENUM_DECL(virDomainTimerName)
2748
VIR_ENUM_DECL(virDomainTimerTrack)
2749 2750
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
2751
VIR_ENUM_DECL(virDomainCpuPlacementMode)
2752

2753
VIR_ENUM_DECL(virDomainStartupPolicy)
2754

O
Osier Yang 已提交
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
# 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)

2789 2790 2791
int virDomainObjListExport(virDomainObjListPtr doms,
                           virConnectPtr conn,
                           virDomainPtr **domains,
2792
                           virDomainObjListFilter filter,
2793
                           unsigned int flags);
O
Osier Yang 已提交
2794

2795 2796 2797
virDomainVcpuPinDefPtr virDomainLookupVcpuPin(virDomainDefPtr def,
                                              int vcpuid);

2798 2799 2800 2801 2802 2803
int
virDomainDefMaybeAddController(virDomainDefPtr def,
                               int type,
                               int idx,
                               int model);

2804 2805
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

2806 2807
int virDomainDefFindDevice(virDomainDefPtr def,
                           const char *devAlias,
2808 2809
                           virDomainDeviceDefPtr dev,
                           bool reportError);
2810

2811 2812 2813
bool virDomainDiskSourceIsBlockType(virDomainDiskDefPtr def)
    ATTRIBUTE_NONNULL(1);

2814 2815
void virDomainChrSourceDefClear(virDomainChrSourceDefPtr def);

2816 2817 2818 2819 2820 2821 2822
char *virDomainObjGetMetadata(virDomainObjPtr vm,
                              int type,
                              const char *uri,
                              virCapsPtr caps,
                              virDomainXMLOptionPtr xmlopt,
                              unsigned int flags);

2823 2824 2825 2826 2827 2828 2829 2830 2831 2832
int virDomainObjSetMetadata(virDomainObjPtr vm,
                            int type,
                            const char *metadata,
                            const char *key,
                            const char *uri,
                            virCapsPtr caps,
                            virDomainXMLOptionPtr xmlopt,
                            const char *configDir,
                            unsigned int flags);

2833
#endif /* __DOMAIN_CONF_H */