domain_conf.h 100.3 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
4
 * Copyright (C) 2006-2016 Red Hat, Inc.
5
 * Copyright (C) 2006-2008 Daniel P. Berrange
6
 * Copyright (c) 2015 SUSE LINUX Products GmbH, Nuernberg, Germany.
7 8 9 10 11 12 13 14 15 16 17 18
 *
 * 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
19
 * License along with this library.  If not, see
O
Osier Yang 已提交
20
 * <http://www.gnu.org/licenses/>.
21 22 23 24 25
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#ifndef __DOMAIN_CONF_H
26
# define __DOMAIN_CONF_H
27

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

32 33
# include "internal.h"
# include "capabilities.h"
34
# include "virstorageencryption.h"
35
# include "cpu_conf.h"
36
# include "virthread.h"
37
# include "virhash.h"
38
# include "virsocketaddr.h"
39
# include "networkcommon_conf.h"
40
# include "nwfilter_params.h"
41
# include "numa_conf.h"
42
# include "virnetdevmacvlan.h"
43
# include "virsysinfo.h"
44
# include "virnetdevip.h"
45 46
# include "virnetdevvportprofile.h"
# include "virnetdevbandwidth.h"
47
# include "virnetdevvlan.h"
48
# include "virobject.h"
49
# include "device_conf.h"
50
# include "virbitmap.h"
51
# include "virstoragefile.h"
52
# include "virseclabel.h"
53
# include "virprocess.h"
54
# include "virgic.h"
Q
Qiaowei Ren 已提交
55
# include "virperf.h"
56
# include "virtypedparam.h"
57

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
/* 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;

79 80 81
typedef struct _virDomainSoundCodecDef virDomainSoundCodecDef;
typedef virDomainSoundCodecDef *virDomainSoundCodecDefPtr;

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
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;

103 104
typedef struct _virDomainRedirFilterUSBDevDef virDomainRedirFilterUSBDevDef;
typedef virDomainRedirFilterUSBDevDef *virDomainRedirFilterUSBDevDefPtr;
105 106 107 108

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

109 110 111 112 113 114 115 116 117
typedef struct _virDomainSmartcardDef virDomainSmartcardDef;
typedef virDomainSmartcardDef *virDomainSmartcardDefPtr;

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

L
Li Zhang 已提交
118 119 120
typedef struct _virDomainNVRAMDef virDomainNVRAMDef;
typedef virDomainNVRAMDef *virDomainNVRAMDefPtr;

121 122 123 124 125 126
typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

127 128 129
typedef struct _virDomainRNGDef virDomainRNGDef;
typedef virDomainRNGDef *virDomainRNGDefPtr;

130 131 132 133 134 135
typedef struct _virDomainIdMapEntry virDomainIdMapEntry;
typedef virDomainIdMapEntry *virDomainIdMapEntryPtr;

typedef struct _virDomainIdMapDef virDomainIdMapDef;
typedef virDomainIdMapDef *virDomainIdMapDefPtr;

H
Hu Tao 已提交
136 137 138
typedef struct _virDomainPanicDef virDomainPanicDef;
typedef virDomainPanicDef *virDomainPanicDefPtr;

139 140 141
typedef struct _virDomainMemoryDef virDomainMemoryDef;
typedef virDomainMemoryDef *virDomainMemoryDefPtr;

M
Michele Paolino 已提交
142 143 144 145 146 147
/* forward declarations virDomainChrSourceDef, required by
 * virDomainNetDef
 */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;

148 149 150
typedef struct _virDomainShmemDef virDomainShmemDef;
typedef virDomainShmemDef *virDomainShmemDefPtr;

151 152 153
typedef struct _virDomainTPMDef virDomainTPMDef;
typedef virDomainTPMDef *virDomainTPMDefPtr;

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
/* 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 已提交
173
    VIR_DOMAIN_DEVICE_NVRAM,
174
    VIR_DOMAIN_DEVICE_RNG,
175
    VIR_DOMAIN_DEVICE_SHMEM,
176
    VIR_DOMAIN_DEVICE_TPM,
177
    VIR_DOMAIN_DEVICE_PANIC,
178
    VIR_DOMAIN_DEVICE_MEMORY,
179

180
    VIR_DOMAIN_DEVICE_LAST
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
} 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 已提交
204
        virDomainNVRAMDefPtr nvram;
205
        virDomainRNGDefPtr rng;
206
        virDomainShmemDefPtr shmem;
207
        virDomainTPMDefPtr tpm;
208
        virDomainPanicDefPtr panic;
209
        virDomainMemoryDefPtr memory;
210 211 212
    } data;
};

213 214
/* Different types of hypervisor */
/* NB: Keep in sync with virDomainVirtTypeToString impl */
215
typedef enum {
216
    VIR_DOMAIN_VIRT_NONE = 0,
217 218 219 220 221 222 223 224 225 226
    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,
227
    VIR_DOMAIN_VIRT_VBOX,
228
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
229
    VIR_DOMAIN_VIRT_PARALLELS,
R
Roman Bogorodskiy 已提交
230
    VIR_DOMAIN_VIRT_BHYVE,
231
    VIR_DOMAIN_VIRT_VZ,
232

233
    VIR_DOMAIN_VIRT_LAST
234
} virDomainVirtType;
235

236 237 238 239 240 241 242 243 244 245 246 247
typedef enum {
    VIR_DOMAIN_OSTYPE_HVM,
    VIR_DOMAIN_OSTYPE_XEN,
    VIR_DOMAIN_OSTYPE_LINUX,
    VIR_DOMAIN_OSTYPE_EXE,
    VIR_DOMAIN_OSTYPE_UML,

    VIR_DOMAIN_OSTYPE_LAST
} virDomainOSType;
VIR_ENUM_DECL(virDomainOS)


248 249 250 251 252 253 254 255
typedef struct _virDomainHostdevOrigStates virDomainHostdevOrigStates;
typedef virDomainHostdevOrigStates *virDomainHostdevOrigStatesPtr;
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
256
            bool unbind_from_stub;
257 258 259 260

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
261
            bool remove_slot;
262 263 264 265

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
266
            bool reprobe;
267 268 269 270 271 272
        } pci;

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

273 274 275 276 277 278 279
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

280

281
typedef enum {
282 283 284
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

285
    VIR_DOMAIN_HOSTDEV_MODE_LAST
286
} virDomainHostdevMode;
287

288
typedef enum {
289 290
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,
H
Han Cheng 已提交
291
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI,
292 293

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
294
} virDomainHostdevSubsysType;
295

296 297
/* the backend driver used for PCI hostdev devices */
typedef enum {
298
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_DEFAULT, /* detect automaticaly, prefer VFIO */
299 300
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_KVM,    /* force legacy kvm style */
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_VFIO,   /* force vfio */
301
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_XEN,    /* force legacy xen style, use pciback */
302 303

    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_TYPE_LAST
304
} virDomainHostdevSubsysPCIBackendType;
305

306
VIR_ENUM_DECL(virDomainHostdevSubsysPCIBackend)
307

308 309 310 311 312 313 314 315 316
typedef enum {
    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_NONE,
    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_ISCSI,

    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_LAST,
} virDomainHostdevSCSIProtocolType;

VIR_ENUM_DECL(virDomainHostdevSubsysSCSIProtocol)

317 318 319 320 321 322 323 324 325 326 327 328
typedef struct _virDomainHostdevSubsysUSB virDomainHostdevSubsysUSB;
typedef virDomainHostdevSubsysUSB *virDomainHostdevSubsysUSBPtr;
struct _virDomainHostdevSubsysUSB {
    bool autoAddress; /* bus/device were filled automatically based
                         on vendor/product */
    unsigned bus;
    unsigned device;

    unsigned vendor;
    unsigned product;
};

329 330 331
typedef struct _virDomainHostdevSubsysPCI virDomainHostdevSubsysPCI;
typedef virDomainHostdevSubsysPCI *virDomainHostdevSubsysPCIPtr;
struct _virDomainHostdevSubsysPCI {
332
    virPCIDeviceAddress addr; /* host address */
333 334 335
    int backend; /* enum virDomainHostdevSubsysPCIBackendType */
};

336 337 338
typedef struct _virDomainHostdevSubsysSCSIHost virDomainHostdevSubsysSCSIHost;
typedef virDomainHostdevSubsysSCSIHost *virDomainHostdevSubsysSCSIHostPtr;
struct _virDomainHostdevSubsysSCSIHost {
339 340 341
    char *adapter;
    unsigned bus;
    unsigned target;
342
    unsigned long long unit;
343 344
};

345 346 347 348 349 350 351 352 353
typedef struct _virDomainHostdevSubsysSCSIiSCSI virDomainHostdevSubsysSCSIiSCSI;
typedef virDomainHostdevSubsysSCSIiSCSI *virDomainHostdevSubsysSCSIiSCSIPtr;
struct _virDomainHostdevSubsysSCSIiSCSI {
    char *path;
    size_t nhosts;
    virStorageNetHostDefPtr hosts;
    virStorageAuthDefPtr auth;
};

354 355 356
typedef struct _virDomainHostdevSubsysSCSI virDomainHostdevSubsysSCSI;
typedef virDomainHostdevSubsysSCSI *virDomainHostdevSubsysSCSIPtr;
struct _virDomainHostdevSubsysSCSI {
357
    int protocol; /* enum virDomainHostdevSCSIProtocolType */
358
    int sgio; /* enum virDomainDeviceSGIO */
359
    int rawio; /* enum virTristateBool */
360 361
    union {
        virDomainHostdevSubsysSCSIHost host;
362
        virDomainHostdevSubsysSCSIiSCSI iscsi;
363
    } u;
364 365
};

366 367 368
typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys;
typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr;
struct _virDomainHostdevSubsys {
369
    int type; /* enum virDomainHostdevSubsysType */
370
    union {
371
        virDomainHostdevSubsysUSB usb;
372
        virDomainHostdevSubsysPCI pci;
373
        virDomainHostdevSubsysSCSI scsi;
374 375 376
    } u;
};

377

378
typedef enum {
379 380
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,
381
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_NET,
382 383

    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_LAST
384
} virDomainHostdevCapsType;
385 386 387 388 389 390 391 392 393 394 395 396

typedef struct _virDomainHostdevCaps virDomainHostdevCaps;
typedef virDomainHostdevCaps *virDomainHostdevCapsPtr;
struct _virDomainHostdevCaps {
    int type; /* enum virDOmainHostdevCapsType */
    union {
        struct {
            char *block;
        } storage;
        struct {
            char *chardev;
        } misc;
397 398
        struct {
            char *iface;
399
            size_t nips;
400
            virNetDevIPAddrPtr *ips;
401
            size_t nroutes;
402
            virNetDevIPRoutePtr *routes;
403
        } net;
404 405 406 407
    } u;
};


408 409
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
410
    virDomainDeviceDef parent; /* higher level Def containing this */
411 412
    virObjectPtr privateData;

413
    int mode; /* enum virDomainHostdevMode */
414
    int startupPolicy; /* enum virDomainStartupPolicy */
415
    bool managed;
416
    bool missing;
O
Osier Yang 已提交
417
    bool readonly;
418
    bool shareable;
419
    union {
420
        virDomainHostdevSubsys subsys;
421
        virDomainHostdevCaps caps;
422 423
    } source;
    virDomainHostdevOrigStates origstates;
424
    virDomainDeviceInfoPtr info; /* Guest address */
425 426
};

427

E
Eric Blake 已提交
428 429
/* Types of disk frontend (guest view).  For backends (host view), see
 * virStorageType in util/virstoragefile.h */
430
typedef enum {
431 432 433
    VIR_DOMAIN_DISK_DEVICE_DISK,
    VIR_DOMAIN_DISK_DEVICE_CDROM,
    VIR_DOMAIN_DISK_DEVICE_FLOPPY,
434
    VIR_DOMAIN_DISK_DEVICE_LUN,
435 436

    VIR_DOMAIN_DISK_DEVICE_LAST
437
} virDomainDiskDevice;
438

439
typedef enum {
440 441 442 443 444
    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,
445
    VIR_DOMAIN_DISK_BUS_USB,
446
    VIR_DOMAIN_DISK_BUS_UML,
447
    VIR_DOMAIN_DISK_BUS_SATA,
448
    VIR_DOMAIN_DISK_BUS_SD,
449 450

    VIR_DOMAIN_DISK_BUS_LAST
451
} virDomainDiskBus;
452

453
typedef enum {
454 455 456 457
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
458
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
459
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
460 461

    VIR_DOMAIN_DISK_CACHE_LAST
462
} virDomainDiskCache;
463

464
typedef enum {
465 466
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
467
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
468
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
469
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
470 471

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
472
} virDomainDiskErrorPolicy;
473

M
MORITA Kazutaka 已提交
474

475
typedef enum {
476
    VIR_DOMAIN_DISK_TRAY_CLOSED = 0,
477 478 479
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
480
} virDomainDiskTray;
481

482
typedef enum {
J
J.B. Joret 已提交
483 484 485 486 487 488
    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
489
} virDomainDiskGeometryTrans;
J
J.B. Joret 已提交
490

491
typedef enum {
492
    VIR_DOMAIN_DISK_IO_DEFAULT = 0,
M
Matthias Dahl 已提交
493 494 495 496
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
497
} virDomainDiskIo;
M
Matthias Dahl 已提交
498

499
typedef enum {
500 501 502 503 504 505
    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
506
} virDomainStartupPolicy;
507

508

509
typedef enum {
510 511 512
    VIR_DOMAIN_DEVICE_SGIO_DEFAULT = 0,
    VIR_DOMAIN_DEVICE_SGIO_FILTERED,
    VIR_DOMAIN_DEVICE_SGIO_UNFILTERED,
O
Osier Yang 已提交
513

514
    VIR_DOMAIN_DEVICE_SGIO_LAST
515
} virDomainDeviceSGIO;
O
Osier Yang 已提交
516

517
typedef enum {
O
Osier Yang 已提交
518
    VIR_DOMAIN_DISK_DISCARD_DEFAULT = 0,
O
Osier Yang 已提交
519 520
    VIR_DOMAIN_DISK_DISCARD_UNMAP,
    VIR_DOMAIN_DISK_DISCARD_IGNORE,
O
Osier Yang 已提交
521 522

    VIR_DOMAIN_DISK_DISCARD_LAST
523
} virDomainDiskDiscard;
O
Osier Yang 已提交
524

525 526 527 528 529 530 531 532 533
typedef enum {
    VIR_DOMAIN_DISK_DETECT_ZEROES_DEFAULT = 0,
    VIR_DOMAIN_DISK_DETECT_ZEROES_OFF,
    VIR_DOMAIN_DISK_DETECT_ZEROES_ON,
    VIR_DOMAIN_DISK_DETECT_ZEROES_UNMAP,

    VIR_DOMAIN_DISK_DETECT_ZEROES_LAST
} virDomainDiskDetectZeroes;

L
Lei Li 已提交
534 535 536 537 538 539 540 541
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;
542 543 544 545 546 547 548
    unsigned long long total_bytes_sec_max;
    unsigned long long read_bytes_sec_max;
    unsigned long long write_bytes_sec_max;
    unsigned long long total_iops_sec_max;
    unsigned long long read_iops_sec_max;
    unsigned long long write_iops_sec_max;
    unsigned long long size_iops_sec;
L
Lei Li 已提交
549 550 551
};
typedef virDomainBlockIoTuneInfo *virDomainBlockIoTuneInfoPtr;

552

553 554 555 556 557 558 559 560 561 562
typedef enum {
    VIR_DOMAIN_DISK_MIRROR_STATE_NONE = 0, /* No job, or job still not synced */
    VIR_DOMAIN_DISK_MIRROR_STATE_READY, /* Job in second phase */
    VIR_DOMAIN_DISK_MIRROR_STATE_ABORT, /* Job aborted, waiting for event */
    VIR_DOMAIN_DISK_MIRROR_STATE_PIVOT, /* Job pivoted, waiting for event */

    VIR_DOMAIN_DISK_MIRROR_STATE_LAST
} virDomainDiskMirrorState;


563 564
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
565
    virStorageSourcePtr src; /* non-NULL.  XXX Allow NULL for empty cdrom? */
566

567 568
    virObjectPtr privateData;

569 570 571 572
    int device; /* enum virDomainDiskDevice */
    int bus; /* enum virDomainDiskBus */
    char *dst;
    int tray_status; /* enum virDomainDiskTray */
J
Ján Tomko 已提交
573
    int removable; /* enum virTristateSwitch */
L
Lei Li 已提交
574

575
    virStorageSourcePtr mirror;
576
    int mirrorState; /* enum virDomainDiskMirrorState */
E
Eric Blake 已提交
577
    int mirrorJob; /* virDomainBlockJobType */
578

J
J.B. Joret 已提交
579 580 581 582
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
583
        int trans; /* enum virDomainDiskGeometryTrans */
J
J.B. Joret 已提交
584 585
    } geometry;

586 587 588
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
589
    } blockio;
590

L
Lei Li 已提交
591 592
    virDomainBlockIoTuneInfo blkdeviotune;

593
    char *serial;
O
Osier Yang 已提交
594
    char *wwn;
595 596
    char *vendor;
    char *product;
597
    int cachemode; /* enum virDomainDiskCache */
598 599
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
600
    int iomode; /* enum virDomainDiskIo */
J
Ján Tomko 已提交
601 602 603
    int ioeventfd; /* enum virTristateSwitch */
    int event_idx; /* enum virTristateSwitch */
    int copy_on_read; /* enum virTristateSwitch */
604
    int snapshot; /* virDomainSnapshotLocation, snapshot_conf.h */
605
    int startupPolicy; /* enum virDomainStartupPolicy */
606
    bool transient;
607
    virDomainDeviceInfo info;
608
    int rawio; /* enum virTristateBool */
609
    int sgio; /* enum virDomainDeviceSGIO */
O
Osier Yang 已提交
610
    int discard; /* enum virDomainDiskDiscard */
611
    unsigned int iothread; /* unused = 0, > 0 specific thread # */
612
    int detect_zeroes; /* enum virDomainDiskDetectZeroes */
613
    char *domain_name; /* backend domain name */
614 615 616
};


617
typedef enum {
618 619 620 621
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
622
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
623
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
624
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
J
Ján Tomko 已提交
625
    VIR_DOMAIN_CONTROLLER_TYPE_PCI,
626 627

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
628
} virDomainControllerType;
629

630

631
typedef enum {
J
Ján Tomko 已提交
632
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_ROOT,
L
Laine Stump 已提交
633
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT,
J
Ján Tomko 已提交
634
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_BRIDGE,
635
    VIR_DOMAIN_CONTROLLER_MODEL_DMI_TO_PCI_BRIDGE,
636
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT_PORT,
637
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_UPSTREAM_PORT,
638
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_DOWNSTREAM_PORT,
639
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_EXPANDER_BUS,
640
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_EXPANDER_BUS,
J
Ján Tomko 已提交
641 642

    VIR_DOMAIN_CONTROLLER_MODEL_PCI_LAST
643
} virDomainControllerModelPCI;
J
Ján Tomko 已提交
644

645 646 647 648
typedef enum {
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_NONE,
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCI_BRIDGE,
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_I82801B11_BRIDGE,
649
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_IOH3420,
650
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_X3130_UPSTREAM,
651
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_XIO3130_DOWNSTREAM,
652
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB,
653
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB_PCIE,
654 655 656 657

    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_LAST
} virDomainControllerPCIModelName;

658
typedef enum {
659 660 661 662 663
    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,
664
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
665
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
666
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
667

668
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
669
} virDomainControllerModelSCSI;
670

671
typedef enum {
M
Marc-André Lureau 已提交
672 673 674 675 676 677 678 679 680
    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 已提交
681
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
682
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
683 684

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
685
} virDomainControllerModelUSB;
M
Marc-André Lureau 已提交
686

687 688 689 690 691 692 693
# define IS_USB2_CONTROLLER(ctrl) \
    (((ctrl)->type == VIR_DOMAIN_CONTROLLER_TYPE_USB) && \
     ((ctrl)->model == VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_EHCI1 || \
      (ctrl)->model == VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI1 || \
      (ctrl)->model == VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI2 || \
      (ctrl)->model == VIR_DOMAIN_CONTROLLER_MODEL_USB_ICH9_UHCI3))

694 695 696 697 698 699 700
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

701 702 703
typedef struct _virDomainPCIControllerOpts virDomainPCIControllerOpts;
typedef virDomainPCIControllerOpts *virDomainPCIControllerOptsPtr;
struct _virDomainPCIControllerOpts {
704 705
    bool pcihole64;
    unsigned long pcihole64size;
706 707 708 709 710 711 712

    /* the exact controller name is in the "model" subelement, e.g.:
     * <controller type='pci' model='pcie-root-port'>
     *   <model name='ioh3420''/>
     *   ...
     */
    int modelName; /* the exact name of the device in hypervisor */
713 714 715 716 717 718 719 720

    /* the following items are attributes of the "target" subelement
     * of controller type='pci'. They are bits of configuration that
     * are specified on the qemu commandline and are visible to the
     * guest OS, so they must be preserved to ensure ABI
     * compatibility.
     */
    int chassisNr; /* used by pci-bridge, -1 == unspecified */
721 722 723 724
    /* chassis & port used by
     * pcie-root-port/pcie-switch-downstream-port, -1 = unspecified */
    int chassis;
    int port;
725 726 727 728 729
    int busNr; /* used by pci-expander-bus, -1 == unspecified */
    /* numaNode is a *subelement* of target (to match existing
     * item in memory target config) -1 == unspecified
     */
    int numaNode;
730
};
731

732 733 734 735 736 737
typedef struct _virDomainUSBControllerOpts virDomainUSBControllerOpts;
typedef virDomainUSBControllerOpts *virDomainUSBControllerOptsPtr;
struct _virDomainUSBControllerOpts {
    int ports;   /* -1 == undef */
};

738 739 740
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
741
    int idx;
742
    int model; /* -1 == undef */
743
    unsigned int queues;
744 745
    unsigned int cmd_per_lun;
    unsigned int max_sectors;
746
    int ioeventfd; /* enum virTristateSwitch */
747
    unsigned int iothread; /* unused = 0, > 0 specific thread # */
748 749
    union {
        virDomainVirtioSerialOpts vioserial;
750
        virDomainPCIControllerOpts pciopts;
751
        virDomainUSBControllerOpts usbopts;
752
    } opts;
753 754 755 756
    virDomainDeviceInfo info;
};


G
Giuseppe Scrivano 已提交
757
/* Types of disk backends */
758
typedef enum {
759 760 761 762 763 764
    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 */
765 766

    VIR_DOMAIN_FS_TYPE_LAST
767
} virDomainFSType;
768

769
/* Filesystem driver type */
770
typedef enum {
771 772 773
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,
774
    VIR_DOMAIN_FS_DRIVER_TYPE_LOOP,
775
    VIR_DOMAIN_FS_DRIVER_TYPE_NBD,
D
Dmitry Guryanov 已提交
776
    VIR_DOMAIN_FS_DRIVER_TYPE_PLOOP,
777 778

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
779
} virDomainFSDriverType;
780

781
/* Filesystem mount access mode  */
782
typedef enum {
783 784 785 786 787
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
788
} virDomainFSAccessMode;
789

790
/* Filesystem Write policy */
791
typedef enum {
792 793 794 795
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
796
} virDomainFSWrpolicy;
797

798 799 800
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

801 802
struct _virDomainFSDef {
    int type;
803 804
    int fsdriver; /* enum virDomainFSDriverType */
    int accessmode; /* enum virDomainFSAccessMode */
805
    int wrpolicy; /* enum virDomainFSWrpolicy */
806
    int format; /* virStorageFileFormat */
807
    unsigned long long usage; /* in bytes */
808 809
    char *src;
    char *dst;
810
    bool readonly;
811
    virDomainDeviceInfo info;
812 813
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
814
    bool symlinksResolved;
815 816 817
};


818
/* network config types */
819
typedef enum {
820 821
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
M
Michele Paolino 已提交
822
    VIR_DOMAIN_NET_TYPE_VHOSTUSER,
823 824 825 826 827
    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 已提交
828
    VIR_DOMAIN_NET_TYPE_INTERNAL,
829
    VIR_DOMAIN_NET_TYPE_DIRECT,
830
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
831
    VIR_DOMAIN_NET_TYPE_UDP,
832

833
    VIR_DOMAIN_NET_TYPE_LAST
834
} virDomainNetType;
835

836
/* the backend driver used for virtio interfaces */
837
typedef enum {
838 839 840 841
    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 */

842
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
843
} virDomainNetBackendType;
844

845
/* the TX algorithm used for virtio interfaces */
846
typedef enum {
847 848 849 850
    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,

851
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
852
} virDomainNetVirtioTxModeType;
853

854
/* link interface states */
855
typedef enum {
856 857 858 859 860
        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
861
} virDomainNetInterfaceLinkState;
862

863 864 865 866 867 868 869 870 871 872 873 874
/* 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;
875
            int macTableManager; /* enum virNetworkBridgeMACTableManagerType */
876 877 878 879 880
        } bridge;
        struct {
            char *linkdev;
            int mode; /* enum virMacvtapMode from util/macvtap.h */
        } direct;
881 882 883
        struct {
            virDomainHostdevDef def;
        } hostdev;
884
    } data;
885
    virNetDevVPortProfilePtr virtPortProfile;
886
    virNetDevBandwidthPtr bandwidth;
887
    virNetDevVlan vlan;
888
    int trustGuestRxFilters; /* enum virTristateBool */
889
    unsigned int class_id; /* class ID for bandwidth 'floor' */
890 891
};

892 893
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
894
    virDomainNetType type;
895
    virMacAddr mac;
896
    char *model;
897 898
    union {
        struct {
899 900
            virDomainNetBackendType name; /* which driver backend to use */
            virDomainNetVirtioTxModeType txmode;
J
Ján Tomko 已提交
901 902
            virTristateSwitch ioeventfd;
            virTristateSwitch event_idx;
903
            unsigned int queues; /* Multiqueue virtio-net */
904 905 906 907 908 909 910
            struct {
                virTristateSwitch csum;
                virTristateSwitch gso;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
911
                virTristateSwitch mrg_rxbuf;
912 913 914 915 916 917 918 919
            } host;
            struct {
                virTristateSwitch csum;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
            } guest;
920 921
        } virtio;
    } driver;
922 923 924 925
    struct {
        char *tap;
        char *vhost;
    } backend;
926
    union {
M
Michele Paolino 已提交
927
        virDomainChrSourceDefPtr vhostuser;
928 929 930
        struct {
            char *address;
            int port;
931 932
            char *localaddr;
            int localport;
933 934 935
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
936 937 938 939 940 941 942 943 944 945
            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;
946 947 948 949
        } network;
        struct {
            char *brname;
        } bridge;
D
Daniel Veillard 已提交
950 951 952
        struct {
            char *name;
        } internal;
953 954
        struct {
            char *linkdev;
955
            int mode; /* enum virMacvtapMode from util/macvtap.h */
956
        } direct;
957 958 959
        struct {
            virDomainHostdevDef def;
        } hostdev;
960
    } data;
961 962
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
963 964 965 966
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
967
    char *script;
968
    char *domain_name; /* backend domain name */
969
    char *ifname;
970 971
    char *ifname_guest;
    char *ifname_guest_actual;
972
    virDomainDeviceInfo info;
973 974
    char *filter;
    virNWFilterHashTablePtr filterparams;
975
    virNetDevBandwidthPtr bandwidth;
976
    virNetDevVlan vlan;
977
    int trustGuestRxFilters; /* enum virTristateBool */
978
    int linkstate;
979
    size_t nips;
980
    virNetDevIPAddrPtr *ips;
981
    size_t nroutes;
982
    virNetDevIPRoutePtr *routes;
983 984
};

E
Eric Blake 已提交
985 986 987 988
/* 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"

989 990 991 992 993 994 995 996 997 998
typedef enum {
    VIR_DOMAIN_CHR_DEVICE_STATE_DEFAULT = 0,
    VIR_DOMAIN_CHR_DEVICE_STATE_CONNECTED,
    VIR_DOMAIN_CHR_DEVICE_STATE_DISCONNECTED,

    VIR_DOMAIN_CHR_DEVICE_STATE_LAST
} virDomainChrDeviceState;

VIR_ENUM_DECL(virDomainChrDeviceState)

999
typedef enum {
1000
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
1001 1002
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
1003
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
1004

1005
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
1006
} virDomainChrDeviceType;
1007

1008
typedef enum {
G
Guannan Ren 已提交
1009 1010
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,
M
Michal Privoznik 已提交
1011
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_PCI,
G
Guannan Ren 已提交
1012 1013

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
1014
} virDomainChrSerialTargetType;
G
Guannan Ren 已提交
1015

1016
typedef enum {
1017 1018
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
1019 1020
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

1021
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
1022
} virDomainChrChannelTargetType;
1023

1024
typedef enum {
1025 1026
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
1027 1028
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
1029
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
1030 1031
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
1032 1033
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
1034

1035
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
1036
} virDomainChrConsoleTargetType;
1037

1038
typedef enum {
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
    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,
1049
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
1050
    VIR_DOMAIN_CHR_TYPE_SPICEPORT,
1051
    VIR_DOMAIN_CHR_TYPE_NMDM,
1052

1053
    VIR_DOMAIN_CHR_TYPE_LAST
1054
} virDomainChrType;
1055

1056
typedef enum {
1057 1058
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1059 1060
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1061

1062
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1063
} virDomainChrTcpProtocol;
1064

1065
typedef enum {
E
Eric Blake 已提交
1066 1067
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1068
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1069

1070
    VIR_DOMAIN_CHR_SPICEVMC_LAST
1071
} virDomainChrSpicevmcName;
E
Eric Blake 已提交
1072

1073 1074 1075
/* The host side information for a character device.  */
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
1076
    union {
E
Eric Blake 已提交
1077
        /* no <source> for null, vc, stdio */
1078 1079
        struct {
            char *path;
1080
            int append; /* enum virTristateSwitch */
1081
        } file; /* pty, file, pipe, or device */
1082 1083 1084 1085
        struct {
            char *master;
            char *slave;
        } nmdm;
1086 1087 1088
        struct {
            char *host;
            char *service;
1089
            bool listen;
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
1100
            bool listen;
1101
        } nix;
E
Eric Blake 已提交
1102
        int spicevmc;
1103 1104 1105
        struct {
            char *channel;
        } spiceport;
1106
    } data;
1107 1108
    char *logfile;
    int logappend;
1109 1110 1111 1112
};

/* A complete character device, both host and domain views.  */
struct _virDomainChrDef {
1113
    int deviceType; /* enum virDomainChrDeviceType */
G
Guannan Ren 已提交
1114 1115

    bool targetTypeAttr;
1116 1117 1118 1119
    int targetType; /* enum virDomainChrConsoleTargetType ||
                       enum virDomainChrChannelTargetType ||
                       enum virDomainChrSerialTargetType according to deviceType */

1120 1121 1122 1123 1124 1125
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

1126 1127
    virDomainChrDeviceState state;

1128
    virDomainChrSourceDef source;
1129 1130

    virDomainDeviceInfo info;
1131 1132 1133

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1134 1135
};

1136
typedef enum {
E
Eric Blake 已提交
1137 1138 1139 1140
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1141
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
1142
} virDomainSmartcardType;
E
Eric Blake 已提交
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

# 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 已提交
1161 1162 1163 1164 1165
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1166
typedef enum {
1167 1168 1169
    VIR_DOMAIN_TPM_MODEL_TIS,

    VIR_DOMAIN_TPM_MODEL_LAST
1170
} virDomainTPMModel;
1171

1172
typedef enum {
1173 1174 1175
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,

    VIR_DOMAIN_TPM_TYPE_LAST
1176
} virDomainTPMBackendType;
1177 1178 1179 1180

# define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"

struct _virDomainTPMDef {
1181
    virDomainTPMBackendType type;
1182
    virDomainDeviceInfo info;
1183
    virDomainTPMModel model;
1184 1185 1186 1187 1188 1189 1190
    union {
        struct {
            virDomainChrSourceDef source;
        } passthrough;
    } data;
};

1191
typedef enum {
1192 1193
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,
L
Li Zhang 已提交
1194
    VIR_DOMAIN_INPUT_TYPE_KBD,
1195
    VIR_DOMAIN_INPUT_TYPE_PASSTHROUGH,
1196

1197
    VIR_DOMAIN_INPUT_TYPE_LAST
1198
} virDomainInputType;
1199

1200
typedef enum {
1201 1202 1203
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,
1204
    VIR_DOMAIN_INPUT_BUS_PARALLELS, /* pseudo device for VNC in containers */
1205
    VIR_DOMAIN_INPUT_BUS_VIRTIO,
1206 1207

    VIR_DOMAIN_INPUT_BUS_LAST
1208
} virDomainInputBus;
1209 1210 1211 1212

struct _virDomainInputDef {
    int type;
    int bus;
1213 1214 1215
    struct {
        char *evdev;
    } source;
1216
    virDomainDeviceInfo info;
1217 1218
};

1219
typedef enum {
1220 1221 1222 1223
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
1224
} virDomainSoundCodecType;
1225

1226
typedef enum {
1227 1228 1229
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1230
    VIR_DOMAIN_SOUND_MODEL_AC97,
1231
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1232
    VIR_DOMAIN_SOUND_MODEL_ICH9,
1233
    VIR_DOMAIN_SOUND_MODEL_USB,
1234 1235

    VIR_DOMAIN_SOUND_MODEL_LAST
1236
} virDomainSoundModel;
1237

1238 1239 1240 1241 1242
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1243 1244
struct _virDomainSoundDef {
    int model;
1245
    virDomainDeviceInfo info;
1246

1247
    size_t ncodecs;
1248
    virDomainSoundCodecDefPtr *codecs;
1249 1250
};

1251
typedef enum {
R
Richard Jones 已提交
1252 1253
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,
1254
    VIR_DOMAIN_WATCHDOG_MODEL_DIAG288,
R
Richard Jones 已提交
1255 1256

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
1257
} virDomainWatchdogModel;
R
Richard Jones 已提交
1258

1259
typedef enum {
R
Richard Jones 已提交
1260 1261 1262 1263
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
1264
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1265
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,
1266
    VIR_DOMAIN_WATCHDOG_ACTION_INJECTNMI,
R
Richard Jones 已提交
1267 1268

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
1269
} virDomainWatchdogAction;
R
Richard Jones 已提交
1270 1271 1272 1273

struct _virDomainWatchdogDef {
    int model;
    int action;
1274
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1275 1276
};

1277

1278
typedef enum {
1279 1280 1281 1282 1283
    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,
1284
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1285
    VIR_DOMAIN_VIDEO_TYPE_PARALLELS, /* pseudo device for VNC in containers */
M
Marc-André Lureau 已提交
1286
    VIR_DOMAIN_VIDEO_TYPE_VIRTIO,
1287 1288

    VIR_DOMAIN_VIDEO_TYPE_LAST
1289
} virDomainVideoType;
1290 1291


1292 1293 1294
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1295 1296
    int accel2d; /* enum virTristateBool */
    int accel3d; /* enum virTristateBool */
1297 1298 1299
};


1300 1301
struct _virDomainVideoDef {
    int type;
1302 1303
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1304
    unsigned int vram64; /* kibibytes (multiples of 1024) */
1305
    unsigned int vgamem; /* kibibytes (multiples of 1024) */
1306
    unsigned int heads;
1307
    bool primary;
1308
    virDomainVideoAccelDefPtr accel;
1309
    virDomainDeviceInfo info;
1310 1311
};

1312
/* graphics console modes */
1313
typedef enum {
1314 1315
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1316 1317
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1318
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1319

1320
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1321
} virDomainGraphicsType;
1322

1323
typedef enum {
1324 1325 1326 1327 1328 1329
    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
1330
} virDomainGraphicsVNCSharePolicy;
1331

1332
typedef enum {
1333 1334 1335 1336 1337 1338
    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
1339
} virDomainGraphicsAuthConnectedType;
1340

1341 1342 1343 1344
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
1345
    bool expires; /* Whether there is an expiry time set */
1346
    time_t validTo;  /* seconds since epoch */
1347
    int connected; /* action if connected */
1348 1349
};

1350
typedef enum {
1351 1352 1353 1354 1355 1356
    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 已提交
1357
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1358
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1359 1360

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
1361
} virDomainGraphicsSpiceChannelName;
1362

1363
typedef enum {
1364 1365 1366 1367 1368
    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
1369
} virDomainGraphicsSpiceChannelMode;
1370

1371
typedef enum {
1372 1373 1374 1375 1376 1377 1378 1379 1380
    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
1381
} virDomainGraphicsSpiceImageCompression;
1382

1383
typedef enum {
1384 1385 1386 1387 1388 1389
    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
1390
} virDomainGraphicsSpiceJpegCompression;
1391

1392
typedef enum {
1393 1394 1395 1396 1397 1398
    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
1399
} virDomainGraphicsSpiceZlibCompression;
1400

1401
typedef enum {
P
Peng Zhou 已提交
1402 1403 1404 1405 1406
    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
1407
} virDomainGraphicsSpiceMouseMode;
P
Peng Zhou 已提交
1408

1409
typedef enum {
1410 1411 1412 1413 1414 1415
    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
1416
} virDomainGraphicsSpiceStreamingMode;
1417

1418
typedef enum {
1419 1420 1421
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,
1422
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_SOCKET,
1423

1424
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1425
} virDomainGraphicsListenType;
1426

1427
typedef enum {
M
Marc-André Lureau 已提交
1428 1429
    VIR_DOMAIN_HUB_TYPE_USB,

1430
    VIR_DOMAIN_HUB_TYPE_LAST
1431
} virDomainHubType;
M
Marc-André Lureau 已提交
1432

1433 1434 1435
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
1436
    virDomainGraphicsListenType type;
1437 1438
    char *address;
    char *network;
1439
    char *socket;
1440
    bool fromConfig;    /* true if the @address is config file originated */
1441
    bool autoGenerated;
1442 1443
};

1444
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1445 1446 1447 1448 1449
    /* 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.
     */
1450
    virDomainGraphicsType type;
1451 1452 1453
    union {
        struct {
            int port;
1454
            bool portReserved;
M
Martin Kletzander 已提交
1455
            int websocket;
1456
            bool autoport;
1457
            char *keymap;
1458
            virDomainGraphicsAuthDef auth;
1459
            int sharePolicy;
1460 1461 1462 1463
        } vnc;
        struct {
            char *display;
            char *xauth;
1464
            bool fullscreen;
1465
        } sdl;
1466 1467
        struct {
            int port;
1468 1469 1470
            bool autoport;
            bool replaceUser;
            bool multiUser;
1471 1472 1473
        } rdp;
        struct {
            char *display;
1474
            bool fullscreen;
1475
        } desktop;
1476 1477 1478
        struct {
            int port;
            int tlsPort;
1479 1480
            bool portReserved;
            bool tlsPortReserved;
1481
            virDomainGraphicsSpiceMouseMode mousemode;
1482
            char *keymap;
1483
            virDomainGraphicsAuthDef auth;
1484
            bool autoport;
1485
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1486
            virDomainGraphicsSpiceChannelMode defaultMode;
1487 1488 1489 1490
            int image;
            int jpeg;
            int zlib;
            int playback;
1491
            int streaming;
1492 1493 1494
            virTristateBool copypaste;
            virTristateBool filetransfer;
            virTristateBool gl;
1495
        } spice;
1496
    } data;
1497 1498 1499 1500 1501
    /* 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;
1502 1503
};

1504
typedef enum {
1505 1506 1507
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
1508
} virDomainRedirdevBus;
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518

struct _virDomainRedirdevDef {
    int bus; /* enum virDomainRedirdevBus */

    union {
        virDomainChrSourceDef chr;
    } source;

    virDomainDeviceInfo info; /* Guest address */
};
1519

1520
struct _virDomainRedirFilterUSBDevDef {
1521 1522 1523 1524
    int usbClass;
    int vendor;
    int product;
    int version;
1525
    bool allow;
1526 1527 1528 1529
};

struct _virDomainRedirFilterDef {
    size_t nusbdevs;
1530
    virDomainRedirFilterUSBDevDefPtr *usbdevs;
1531 1532
};

1533 1534 1535
enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1536
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1537 1538 1539 1540 1541 1542 1543

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
1544
    int period; /* seconds between collections */
1545
    int autodeflate; /* enum virTristateSwitch */
1546 1547
};

L
Li Zhang 已提交
1548 1549 1550
struct _virDomainNVRAMDef {
    virDomainDeviceInfo info;
};
1551

1552 1553 1554 1555 1556
struct _virDomainShmemDef {
    char *name;
    unsigned long long size;
    struct {
        bool enabled;
1557
        virDomainChrSourceDef chr;
1558 1559 1560 1561 1562 1563 1564 1565 1566
    } server;
    struct {
        bool enabled;
        unsigned vectors;
        virTristateSwitch ioeventfd;
    } msi;
    virDomainDeviceInfo info;
};

1567
typedef enum {
1568
    VIR_DOMAIN_SMBIOS_NONE = 0,
1569 1570 1571 1572 1573
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
1574
} virDomainSmbiosMode;
1575

1576

1577
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1578

1579
typedef enum {
1580 1581 1582 1583 1584
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1585
    VIR_DOMAIN_BOOT_LAST
1586
} virDomainBootOrder;
1587

1588
typedef enum {
1589 1590 1591
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1592
    VIR_DOMAIN_FEATURE_HAP,
1593
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1594
    VIR_DOMAIN_FEATURE_PRIVNET,
1595
    VIR_DOMAIN_FEATURE_HYPERV,
1596
    VIR_DOMAIN_FEATURE_KVM,
1597
    VIR_DOMAIN_FEATURE_PVSPINLOCK,
1598
    VIR_DOMAIN_FEATURE_CAPABILITIES,
1599
    VIR_DOMAIN_FEATURE_PMU,
1600
    VIR_DOMAIN_FEATURE_VMPORT,
M
Michal Privoznik 已提交
1601
    VIR_DOMAIN_FEATURE_GIC,
1602 1603

    VIR_DOMAIN_FEATURE_LAST
1604
} virDomainFeature;
1605

1606 1607
# define VIR_DOMAIN_HYPERV_VENDOR_ID_MAX 12

1608
typedef enum {
1609
    VIR_DOMAIN_HYPERV_RELAXED = 0,
1610 1611
    VIR_DOMAIN_HYPERV_VAPIC,
    VIR_DOMAIN_HYPERV_SPINLOCKS,
1612 1613 1614 1615 1616 1617
    VIR_DOMAIN_HYPERV_VPINDEX,
    VIR_DOMAIN_HYPERV_RUNTIME,
    VIR_DOMAIN_HYPERV_SYNIC,
    VIR_DOMAIN_HYPERV_STIMER,
    VIR_DOMAIN_HYPERV_RESET,
    VIR_DOMAIN_HYPERV_VENDOR_ID,
1618 1619

    VIR_DOMAIN_HYPERV_LAST
1620
} virDomainHyperv;
1621

1622 1623 1624 1625 1626 1627
typedef enum {
    VIR_DOMAIN_KVM_HIDDEN = 0,

    VIR_DOMAIN_KVM_LAST
} virDomainKVM;

1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
typedef enum {
    VIR_DOMAIN_CAPABILITIES_POLICY_DEFAULT = 0,
    VIR_DOMAIN_CAPABILITIES_POLICY_ALLOW,
    VIR_DOMAIN_CAPABILITIES_POLICY_DENY,

    VIR_DOMAIN_CAPABILITIES_POLICY_LAST
} virDomainCapabilitiesPolicy;

/* The capabilities are ordered alphabetically to help check for new ones */
typedef enum {
    VIR_DOMAIN_CAPS_FEATURE_AUDIT_CONTROL = 0,
    VIR_DOMAIN_CAPS_FEATURE_AUDIT_WRITE,
    VIR_DOMAIN_CAPS_FEATURE_BLOCK_SUSPEND,
    VIR_DOMAIN_CAPS_FEATURE_CHOWN,
    VIR_DOMAIN_CAPS_FEATURE_DAC_OVERRIDE,
    VIR_DOMAIN_CAPS_FEATURE_DAC_READ_SEARCH,
    VIR_DOMAIN_CAPS_FEATURE_FOWNER,
    VIR_DOMAIN_CAPS_FEATURE_FSETID,
    VIR_DOMAIN_CAPS_FEATURE_IPC_LOCK,
    VIR_DOMAIN_CAPS_FEATURE_IPC_OWNER,
    VIR_DOMAIN_CAPS_FEATURE_KILL,
    VIR_DOMAIN_CAPS_FEATURE_LEASE,
    VIR_DOMAIN_CAPS_FEATURE_LINUX_IMMUTABLE,
    VIR_DOMAIN_CAPS_FEATURE_MAC_ADMIN,
    VIR_DOMAIN_CAPS_FEATURE_MAC_OVERRIDE,
    VIR_DOMAIN_CAPS_FEATURE_MKNOD,
    VIR_DOMAIN_CAPS_FEATURE_NET_ADMIN,
    VIR_DOMAIN_CAPS_FEATURE_NET_BIND_SERVICE,
    VIR_DOMAIN_CAPS_FEATURE_NET_BROADCAST,
    VIR_DOMAIN_CAPS_FEATURE_NET_RAW,
    VIR_DOMAIN_CAPS_FEATURE_SETGID,
    VIR_DOMAIN_CAPS_FEATURE_SETFCAP,
    VIR_DOMAIN_CAPS_FEATURE_SETPCAP,
    VIR_DOMAIN_CAPS_FEATURE_SETUID,
    VIR_DOMAIN_CAPS_FEATURE_SYS_ADMIN,
    VIR_DOMAIN_CAPS_FEATURE_SYS_BOOT,
    VIR_DOMAIN_CAPS_FEATURE_SYS_CHROOT,
    VIR_DOMAIN_CAPS_FEATURE_SYS_MODULE,
    VIR_DOMAIN_CAPS_FEATURE_SYS_NICE,
    VIR_DOMAIN_CAPS_FEATURE_SYS_PACCT,
    VIR_DOMAIN_CAPS_FEATURE_SYS_PTRACE,
    VIR_DOMAIN_CAPS_FEATURE_SYS_RAWIO,
    VIR_DOMAIN_CAPS_FEATURE_SYS_RESOURCE,
    VIR_DOMAIN_CAPS_FEATURE_SYS_TIME,
    VIR_DOMAIN_CAPS_FEATURE_SYS_TTY_CONFIG,
    VIR_DOMAIN_CAPS_FEATURE_SYSLOG,
    VIR_DOMAIN_CAPS_FEATURE_WAKE_ALARM,
    VIR_DOMAIN_CAPS_FEATURE_LAST
} virDomainCapsFeature;

1678
typedef enum {
1679 1680 1681 1682 1683 1684
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
1685
} virDomainLifecycleAction;
1686

1687
typedef enum {
1688 1689 1690 1691 1692 1693 1694 1695
    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
1696
} virDomainLifecycleCrashAction;
1697

1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
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)

M
Michal Privoznik 已提交
1710 1711 1712
typedef struct _virDomainBIOSDef virDomainBIOSDef;
typedef virDomainBIOSDef *virDomainBIOSDefPtr;
struct _virDomainBIOSDef {
J
Ján Tomko 已提交
1713
    int useserial; /* enum virTristateBool */
1714 1715 1716
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1717 1718
};

1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
typedef enum {
    VIR_DOMAIN_LOADER_TYPE_ROM = 0,
    VIR_DOMAIN_LOADER_TYPE_PFLASH,

    VIR_DOMAIN_LOADER_TYPE_LAST
} virDomainLoader;

VIR_ENUM_DECL(virDomainLoader)

typedef struct _virDomainLoaderDef virDomainLoaderDef;
typedef virDomainLoaderDef *virDomainLoaderDefPtr;
struct _virDomainLoaderDef {
    char *path;
    int readonly;   /* enum virTristateBool */
    virDomainLoader type;
    char *nvram;    /* path to non-volatile RAM */
1735
    char *templt;   /* user override of path to master nvram */
1736 1737 1738 1739
};

void virDomainLoaderDefFree(virDomainLoaderDefPtr loader);

1740 1741 1742 1743
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
1744
    int type;
1745
    virArch arch;
1746
    char *machine;
1747
    size_t nBootDevs;
1748
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
J
Ján Tomko 已提交
1749
    int bootmenu; /* enum virTristateBool */
1750 1751
    unsigned int bm_timeout;
    bool bm_timeout_set;
1752
    char *init;
1753
    char **initargv;
1754 1755 1756
    char *kernel;
    char *initrd;
    char *cmdline;
1757
    char *dtb;
1758
    char *root;
J
Ján Tomko 已提交
1759
    char *slic_table;
1760
    virDomainLoaderDefPtr loader;
1761 1762
    char *bootloader;
    char *bootloaderArgs;
1763
    int smbios_mode;
1764

M
Michal Privoznik 已提交
1765
    virDomainBIOSDef bios;
1766 1767
};

1768
typedef enum {
1769 1770 1771 1772 1773
    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 已提交
1774
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1775
    VIR_DOMAIN_TIMER_NAME_HYPERVCLOCK,
1776

1777
    VIR_DOMAIN_TIMER_NAME_LAST
1778
} virDomainTimerNameType;
1779

1780
typedef enum {
1781 1782 1783
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1784

1785
    VIR_DOMAIN_TIMER_TRACK_LAST
1786
} virDomainTimerTrackType;
1787

1788
typedef enum {
1789 1790 1791 1792 1793
    VIR_DOMAIN_TIMER_TICKPOLICY_DELAY = 0,
    VIR_DOMAIN_TIMER_TICKPOLICY_CATCHUP,
    VIR_DOMAIN_TIMER_TICKPOLICY_MERGE,
    VIR_DOMAIN_TIMER_TICKPOLICY_DISCARD,

1794
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1795
} virDomainTimerTickpolicyType;
1796

1797
typedef enum {
1798 1799 1800 1801
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1802
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1803

1804
    VIR_DOMAIN_TIMER_MODE_LAST
1805
} virDomainTimerModeType;
1806

1807
typedef enum {
1808
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1809 1810
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1811
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
1812
} virDomainCpuPlacementMode;
O
Osier Yang 已提交
1813

1814 1815 1816
typedef struct _virDomainThreadSchedParam virDomainThreadSchedParam;
typedef virDomainThreadSchedParam *virDomainThreadSchedParamPtr;
struct _virDomainThreadSchedParam {
1817
    virProcessSchedPolicy policy;
1818 1819 1820
    int priority;
};

1821 1822 1823 1824 1825 1826 1827 1828
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1829 1830 1831 1832 1833 1834 1835
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 */

1836 1837 1838 1839
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1840 1841 1842 1843 1844 1845

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

1846
typedef enum {
1847 1848
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
1849
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
1850
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
1851

1852
    VIR_DOMAIN_CLOCK_OFFSET_LAST
1853
} virDomainClockOffsetType;
1854

1855
typedef enum {
1856 1857 1858
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

1859
    VIR_DOMAIN_CLOCK_BASIS_LAST
1860
} virDomainClockBasis;
1861

1862 1863 1864 1865
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
1866

1867
    union {
1868 1869 1870
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
1871
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
1872 1873 1874
        struct {
            long long adjustment;
            int basis;
1875 1876 1877 1878 1879 1880 1881

            /* domain start-time adjustment. This is a
             * private/internal read-only value that only exists when
             * a domain is running, and only if the clock
             * offset='variable'
             */
            long long adjustment0;
1882
        } variable;
1883 1884 1885 1886 1887

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

1889
    size_t ntimers;
1890
    virDomainTimerDefPtr *timers;
1891 1892
};

1893

1894 1895 1896
typedef struct _virBlkioDevice virBlkioDevice;
typedef virBlkioDevice *virBlkioDevicePtr;
struct _virBlkioDevice {
1897 1898
    char *path;
    unsigned int weight;
1899 1900 1901 1902
    unsigned int riops;
    unsigned int wiops;
    unsigned long long rbps;
    unsigned long long wbps;
1903 1904
};

1905
typedef enum {
1906 1907 1908
    VIR_DOMAIN_RNG_MODEL_VIRTIO,

    VIR_DOMAIN_RNG_MODEL_LAST
1909
} virDomainRNGModel;
1910

1911
typedef enum {
1912 1913 1914 1915 1916
    VIR_DOMAIN_RNG_BACKEND_RANDOM,
    VIR_DOMAIN_RNG_BACKEND_EGD,
    /* VIR_DOMAIN_RNG_BACKEND_POOL, */

    VIR_DOMAIN_RNG_BACKEND_LAST
1917
} virDomainRNGBackend;
1918 1919 1920 1921

struct _virDomainRNGDef {
    int model;
    int backend;
1922 1923
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933

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

    virDomainDeviceInfo info;
};

1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947
typedef enum {
    VIR_DOMAIN_MEMORY_MODEL_NONE,
    VIR_DOMAIN_MEMORY_MODEL_DIMM, /* dimm hotpluggable memory device */

    VIR_DOMAIN_MEMORY_MODEL_LAST
} virDomainMemoryModel;

struct _virDomainMemoryDef {
    /* source */
    virBitmapPtr sourceNodes;
    unsigned long long pagesize; /* kibibytes */

    /* target */
    int model; /* virDomainMemoryModel */
1948
    int targetNode;
1949 1950 1951 1952 1953 1954 1955
    unsigned long long size; /* kibibytes */

    virDomainDeviceInfo info;
};

void virDomainMemoryDefFree(virDomainMemoryDefPtr def);

1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
struct _virDomainIdMapEntry {
    unsigned int start;
    unsigned int target;
    unsigned int count;
};

struct _virDomainIdMapDef {
    size_t nuidmap;
    virDomainIdMapEntryPtr uidmap;

    size_t ngidmap;
    virDomainIdMapEntryPtr gidmap;
};


1971 1972 1973 1974 1975
typedef enum {
    VIR_DOMAIN_PANIC_MODEL_DEFAULT,
    VIR_DOMAIN_PANIC_MODEL_ISA,
    VIR_DOMAIN_PANIC_MODEL_PSERIES,
    VIR_DOMAIN_PANIC_MODEL_HYPERV,
1976
    VIR_DOMAIN_PANIC_MODEL_S390,
1977 1978 1979 1980

    VIR_DOMAIN_PANIC_MODEL_LAST
} virDomainPanicModel;

H
Hu Tao 已提交
1981
struct _virDomainPanicDef {
1982
    int model; /* virDomainPanicModel */
H
Hu Tao 已提交
1983 1984 1985 1986
    virDomainDeviceInfo info;
};


1987
void virBlkioDeviceArrayClear(virBlkioDevicePtr deviceWeights,
1988
                              int ndevices);
1989

1990 1991 1992 1993 1994
typedef struct _virDomainResourceDef virDomainResourceDef;
typedef virDomainResourceDef *virDomainResourceDefPtr;
struct _virDomainResourceDef {
    char *partition;
};
1995

1996
typedef struct _virDomainHugePage virDomainHugePage;
1997 1998
typedef virDomainHugePage *virDomainHugePagePtr;

1999
struct _virDomainHugePage {
2000 2001 2002 2003
    virBitmapPtr nodemask;      /* guest's NUMA node mask */
    unsigned long long size;    /* hugepage size in KiB */
};

2004 2005
# define VIR_DOMAIN_CPUMASK_LEN 1024

2006 2007 2008 2009 2010 2011
typedef struct _virDomainIOThreadIDDef virDomainIOThreadIDDef;
typedef virDomainIOThreadIDDef *virDomainIOThreadIDDefPtr;

struct _virDomainIOThreadIDDef {
    bool autofill;
    unsigned int iothread_id;
2012
    int thread_id;
2013
    virBitmapPtr cpumask;
2014 2015

    virDomainThreadSchedParam sched;
2016 2017 2018 2019
};

void virDomainIOThreadIDDefFree(virDomainIOThreadIDDefPtr def);

2020

2021 2022 2023 2024
typedef struct _virDomainCputune virDomainCputune;
typedef virDomainCputune *virDomainCputunePtr;

struct _virDomainCputune {
2025
    unsigned long long shares;
2026 2027 2028
    bool sharesSpecified;
    unsigned long long period;
    long long quota;
2029
    unsigned long long global_period;
2030
    long long global_quota;
2031 2032
    unsigned long long emulator_period;
    long long emulator_quota;
2033
    virBitmapPtr emulatorpin;
2034 2035
};

2036 2037 2038 2039 2040 2041

typedef struct _virDomainVcpuInfo virDomainVcpuInfo;
typedef virDomainVcpuInfo *virDomainVcpuInfoPtr;

struct _virDomainVcpuInfo {
    bool online;
2042
    virBitmapPtr cpumask;
2043 2044

    virDomainThreadSchedParam sched;
2045 2046
};

2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
typedef struct _virDomainBlkiotune virDomainBlkiotune;
typedef virDomainBlkiotune *virDomainBlkiotunePtr;

struct _virDomainBlkiotune {
    unsigned int weight;

    size_t ndevices;
    virBlkioDevicePtr devices;
};

typedef struct _virDomainMemtune virDomainMemtune;
typedef virDomainMemtune *virDomainMemtunePtr;

struct _virDomainMemtune {
2061 2062 2063
    /* total memory size including memory modules in kibibytes, this field
     * should be accessed only via accessors */
    unsigned long long total_memory;
2064 2065
    unsigned long long cur_balloon; /* in kibibytes, capped at ulong thanks
                                       to virDomainGetInfo */
2066 2067 2068 2069

    virDomainHugePagePtr hugepages;
    size_t nhugepages;

2070 2071 2072 2073
    /* maximum supported memory for a guest, for hotplugging */
    unsigned long long max_memory; /* in kibibytes */
    unsigned int memory_slots; /* maximum count of RAM memory slots */

2074 2075 2076
    bool nosharepages;
    bool locked;
    int dump_core; /* enum virTristateSwitch */
2077 2078 2079 2080
    unsigned long long hard_limit; /* in kibibytes, limit at off_t bytes */
    unsigned long long soft_limit; /* in kibibytes, limit at off_t bytes */
    unsigned long long min_guarantee; /* in kibibytes, limit at off_t bytes */
    unsigned long long swap_hard_limit; /* in kibibytes, limit at off_t bytes */
2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091
};

typedef struct _virDomainPowerManagement virDomainPowerManagement;
typedef virDomainPowerManagement *virDomainPowerManagementPtr;

struct _virDomainPowerManagement {
    /* These options are of type enum virTristateBool */
    int s3;
    int s4;
};

Q
Qiaowei Ren 已提交
2092 2093 2094 2095 2096 2097 2098
typedef struct _virDomainPerfDef virDomainPerfDef;
typedef virDomainPerfDef *virDomainPerfDefPtr;
struct _virDomainPerfDef {
    /* These options are of type enum virTristateBool */
    int events[VIR_PERF_EVENT_LAST];
};

2099 2100 2101 2102 2103 2104 2105
typedef struct _virDomainKeyWrapDef virDomainKeyWrapDef;
typedef virDomainKeyWrapDef *virDomainKeyWrapDefPtr;
struct _virDomainKeyWrapDef {
    int aes; /* enum virTristateSwitch */
    int dea; /* enum virTristateSwitch */
};

2106 2107 2108 2109 2110 2111
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
2112 2113
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
2114
struct _virDomainDef {
2115
    virDomainVirtType virtType;
2116 2117 2118
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
2119
    char *title;
2120
    char *description;
2121

2122 2123
    virDomainBlkiotune blkio;
    virDomainMemtune mem;
2124

2125
    virDomainVcpuInfoPtr vcpus;
2126
    size_t maxvcpus;
O
Osier Yang 已提交
2127
    int placement_mode;
H
Hu Tao 已提交
2128
    virBitmapPtr cpumask;
2129

2130
    unsigned int iothreads;
2131 2132
    size_t niothreadids;
    virDomainIOThreadIDDefPtr *iothreadids;
2133

2134
    virDomainCputune cputune;
2135

2136
    virDomainNumaPtr numa;
2137
    virDomainResourceDefPtr resource;
2138
    virDomainIdMapDef idmap;
2139

2140 2141 2142 2143 2144
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

2145 2146
    int onLockFailure; /* enum virDomainLockFailureAction */

2147
    virDomainPowerManagement pm;
2148

Q
Qiaowei Ren 已提交
2149 2150
    virDomainPerfDefPtr perf;

2151 2152
    virDomainOSDef os;
    char *emulator;
2153 2154 2155
    /* These three options are of type virTristateSwitch,
     * except VIR_DOMAIN_FEATURE_CAPABILITIES that is of type
     * virDomainCapabilitiesPolicy */
2156
    int features[VIR_DOMAIN_FEATURE_LAST];
2157
    int apic_eoi;
2158
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
2159
    int kvm_features[VIR_DOMAIN_KVM_LAST];
2160
    unsigned int hyperv_spinlocks;
2161
    virGICVersion gic_version;
2162
    char *hyperv_vendor_id;
2163

J
Ján Tomko 已提交
2164
    /* These options are of type virTristateSwitch: ON = keep, OFF = drop */
2165 2166
    int caps_features[VIR_DOMAIN_CAPS_FEATURE_LAST];

2167
    virDomainClockDef clock;
2168

2169
    size_t ngraphics;
2170
    virDomainGraphicsDefPtr *graphics;
2171

2172
    size_t ndisks;
2173 2174
    virDomainDiskDefPtr *disks;

2175
    size_t ncontrollers;
2176 2177
    virDomainControllerDefPtr *controllers;

2178
    size_t nfss;
2179 2180
    virDomainFSDefPtr *fss;

2181
    size_t nnets;
2182 2183
    virDomainNetDefPtr *nets;

2184
    size_t ninputs;
2185 2186
    virDomainInputDefPtr *inputs;

2187
    size_t nsounds;
2188 2189
    virDomainSoundDefPtr *sounds;

2190
    size_t nvideos;
2191 2192
    virDomainVideoDefPtr *videos;

2193
    size_t nhostdevs;
2194 2195
    virDomainHostdevDefPtr *hostdevs;

2196
    size_t nredirdevs;
2197 2198
    virDomainRedirdevDefPtr *redirdevs;

2199
    size_t nsmartcards;
E
Eric Blake 已提交
2200 2201
    virDomainSmartcardDefPtr *smartcards;

2202
    size_t nserials;
2203 2204
    virDomainChrDefPtr *serials;

2205
    size_t nparallels;
2206 2207
    virDomainChrDefPtr *parallels;

2208
    size_t nchannels;
2209 2210
    virDomainChrDefPtr *channels;

2211
    size_t nconsoles;
2212 2213
    virDomainChrDefPtr *consoles;

2214
    size_t nleases;
2215 2216
    virDomainLeaseDefPtr *leases;

2217
    size_t nhubs;
M
Marc-André Lureau 已提交
2218 2219
    virDomainHubDefPtr *hubs;

2220 2221 2222
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

2223 2224 2225
    size_t nrngs;
    virDomainRNGDefPtr *rngs;

2226 2227 2228
    size_t nshmems;
    virDomainShmemDefPtr *shmems;

2229 2230 2231
    size_t nmems;
    virDomainMemoryDefPtr *mems;

D
Dmitry Andreev 已提交
2232 2233 2234
    size_t npanics;
    virDomainPanicDefPtr *panics;

2235
    /* Only 1 */
R
Richard Jones 已提交
2236
    virDomainWatchdogDefPtr watchdog;
2237
    virDomainMemballoonDefPtr memballoon;
L
Li Zhang 已提交
2238
    virDomainNVRAMDefPtr nvram;
2239
    virDomainTPMDefPtr tpm;
2240
    virCPUDefPtr cpu;
2241
    virSysinfoDefPtr sysinfo;
2242
    virDomainRedirFilterDefPtr redirfilter;
2243 2244 2245

    void *namespaceData;
    virDomainXMLNamespace ns;
2246

2247 2248
    virDomainKeyWrapDefPtr keywrap;

2249 2250
    /* Application-specific custom metadata */
    xmlNodePtr metadata;
2251 2252
};

2253
int virDomainDefSetVcpusMax(virDomainDefPtr def, unsigned int vcpus);
2254
bool virDomainDefHasVcpusOffline(const virDomainDef *def);
2255
unsigned int virDomainDefGetVcpusMax(const virDomainDef *def);
2256
int virDomainDefSetVcpus(virDomainDefPtr def, unsigned int vcpus);
2257
unsigned int virDomainDefGetVcpus(const virDomainDef *def);
2258
virBitmapPtr virDomainDefGetOnlineVcpumap(const virDomainDef *def);
2259 2260
virDomainVcpuInfoPtr virDomainDefGetVcpu(virDomainDefPtr def, unsigned int vcpu)
    ATTRIBUTE_RETURN_CHECK;
2261

2262
unsigned long long virDomainDefGetMemoryInitial(const virDomainDef *def);
2263
void virDomainDefSetMemoryTotal(virDomainDefPtr def, unsigned long long size);
2264
unsigned long long virDomainDefGetMemoryTotal(const virDomainDef *def);
2265
bool virDomainDefHasMemoryHotplug(const virDomainDef *def);
2266

2267 2268 2269 2270 2271 2272 2273
typedef enum {
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_AES,
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_DEA,

    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_LAST
} virDomainKeyWrapCipherName;

2274
typedef enum {
2275 2276 2277 2278 2279
    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 */
2280
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
2281
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
2282
    VIR_DOMAIN_TAINT_HOOK,             /* Domain (possibly) changed via hook script */
2283
    VIR_DOMAIN_TAINT_CDROM_PASSTHROUGH,/* CDROM passthrough */
Y
Yuri Chornoivan 已提交
2284
    VIR_DOMAIN_TAINT_CUSTOM_DTB,       /* Custom device tree blob was specified */
2285 2286

    VIR_DOMAIN_TAINT_LAST
2287
} virDomainTaintFlags;
2288

2289
/* Guest VM runtime state */
J
Jiri Denemark 已提交
2290 2291 2292 2293 2294 2295
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

2296 2297 2298
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
2299
    virObjectLockable parent;
2300
    virCond cond;
2301

2302
    pid_t pid;
J
Jiri Denemark 已提交
2303
    virDomainStateReason state;
2304 2305 2306

    unsigned int autostart : 1;
    unsigned int persistent : 1;
2307
    unsigned int updated : 1;
2308
    unsigned int removing : 1;
2309 2310 2311

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

2313
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
2314 2315
    virDomainSnapshotObjPtr current_snapshot;

2316 2317
    bool hasManagedSave;

2318 2319
    void *privateData;
    void (*privateDataFreeFunc)(void *);
2320 2321

    int taint;
2322 2323 2324

    unsigned long long original_memlock; /* Original RLIMIT_MEMLOCK, zero if no
                                          * restore will be required later */
2325 2326
};

2327 2328
typedef bool (*virDomainObjListACLFilter)(virConnectPtr conn,
                                          virDomainDefPtr def);
2329

2330

2331 2332
typedef enum {
    VIR_DOMAIN_DEF_FEATURE_WIDE_SCSI = (1 << 0),
2333
    VIR_DOMAIN_DEF_FEATURE_MEMORY_HOTPLUG = (1 << 1),
2334
    VIR_DOMAIN_DEF_FEATURE_OFFLINE_VCPUPIN = (1 << 2),
2335
    VIR_DOMAIN_DEF_FEATURE_NAME_SLASH = (1 << 3),
2336 2337 2338
} virDomainDefFeatures;


2339 2340
/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
2341 2342
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
2343

2344 2345
/* Called once after everything else has been parsed, for adjusting
 * overall domain defaults.  */
2346 2347
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
                                             virCapsPtr caps,
2348
                                             unsigned int parseFlags,
2349
                                             void *opaque);
2350 2351
/* Called once per device, for adjusting per-device settings while
 * leaving the overall domain otherwise unchanged.  */
2352
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
2353
                                                   const virDomainDef *def,
2354
                                                   virCapsPtr caps,
2355
                                                   unsigned int parseFlags,
2356
                                                   void *opaque);
2357 2358 2359 2360 2361 2362 2363
/* Drive callback for assigning device addresses, called at the end
 * of parsing, after all defaults and implicit devices have been added.  */
typedef int (*virDomainDefAssignAddressesCallback)(virDomainDef *def,
                                                   virCapsPtr caps,
                                                   unsigned int parseFlags,
                                                   void *opaque);

2364 2365 2366 2367 2368 2369
/* Called in appropriate places where the domain conf parser can return failure
 * for configurations that were previously accepted. This shall not modify the
 * config. */
typedef int (*virDomainDefValidateCallback)(const virDomainDef *def,
                                            virCapsPtr caps,
                                            void *opaque);
2370

2371 2372 2373 2374 2375 2376
/* Called once per device, for adjusting per-device settings while
 * leaving the overall domain otherwise unchanged.  */
typedef int (*virDomainDeviceDefValidateCallback)(const virDomainDeviceDef *dev,
                                                  const virDomainDef *def,
                                                  void *opaque);

2377 2378 2379
typedef struct _virDomainDefParserConfig virDomainDefParserConfig;
typedef virDomainDefParserConfig *virDomainDefParserConfigPtr;
struct _virDomainDefParserConfig {
2380
    /* driver domain definition callbacks */
2381 2382
    virDomainDefPostParseCallback domainPostParseCallback;
    virDomainDeviceDefPostParseCallback devicesPostParseCallback;
2383
    virDomainDefAssignAddressesCallback assignAddressesCallback;
2384

2385 2386
    /* validation callbacks */
    virDomainDefValidateCallback domainValidateCallback;
2387
    virDomainDeviceDefValidateCallback deviceValidateCallback;
2388

2389
    /* private data for the callbacks */
2390 2391
    void *priv;
    virFreeCallback privFree;
2392 2393

    /* data */
2394
    unsigned int features; /* virDomainDefFeatures */
2395
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2396 2397
};

2398 2399 2400 2401 2402 2403 2404 2405 2406
typedef void *(*virDomainXMLPrivateDataAllocFunc)(void);
typedef void (*virDomainXMLPrivateDataFreeFunc)(void *);
typedef virObjectPtr (*virDomainXMLPrivateDataNewFunc)(void);
typedef int (*virDomainXMLPrivateDataFormatFunc)(virBufferPtr,
                                                 virDomainObjPtr);
typedef int (*virDomainXMLPrivateDataParseFunc)(xmlXPathContextPtr,
                                                virDomainObjPtr,
                                                virDomainDefParserConfigPtr);

2407 2408 2409 2410 2411
typedef struct _virDomainXMLPrivateDataCallbacks virDomainXMLPrivateDataCallbacks;
typedef virDomainXMLPrivateDataCallbacks *virDomainXMLPrivateDataCallbacksPtr;
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
2412
    virDomainXMLPrivateDataNewFunc    diskNew;
2413
    virDomainXMLPrivateDataNewFunc    hostdevNew;
2414 2415 2416 2417
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
};

2418 2419 2420
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
                                            virDomainXMLNamespacePtr xmlns);
2421

2422 2423
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2424
virDomainXMLNamespacePtr
2425
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2426 2427
    ATTRIBUTE_NONNULL(1);

2428 2429 2430
int
virDomainDefPostParse(virDomainDefPtr def,
                      virCapsPtr caps,
2431
                      unsigned int parseFlags,
2432 2433
                      virDomainXMLOptionPtr xmlopt);

2434
int virDomainDefValidate(virDomainDefPtr def,
2435 2436 2437 2438
                         virCapsPtr caps,
                         unsigned int parseFlags,
                         virDomainXMLOptionPtr xmlopt);

2439
static inline bool
D
Daniel P. Berrange 已提交
2440
virDomainObjIsActive(virDomainObjPtr dom)
2441 2442 2443 2444
{
    return dom->def->id != -1;
}

2445
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2446
    ATTRIBUTE_NONNULL(1);
2447

M
Michal Privoznik 已提交
2448 2449
void virDomainObjEndAPI(virDomainObjPtr *vm);

2450
bool virDomainObjTaint(virDomainObjPtr obj,
2451
                       virDomainTaintFlags taint);
2452

2453 2454 2455 2456
void virDomainObjBroadcast(virDomainObjPtr vm);
int virDomainObjWait(virDomainObjPtr vm);
int virDomainObjWaitUntil(virDomainObjPtr vm,
                          unsigned long long whenms);
2457

H
Hu Tao 已提交
2458
void virDomainPanicDefFree(virDomainPanicDefPtr panic);
2459
void virDomainResourceDefFree(virDomainResourceDefPtr resource);
2460 2461
void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
2462
virDomainDiskDefPtr virDomainDiskDefNew(virDomainXMLOptionPtr xmlopt);
2463
void virDomainDiskDefFree(virDomainDiskDefPtr def);
2464
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2465 2466
int virDomainDiskGetType(virDomainDiskDefPtr def);
void virDomainDiskSetType(virDomainDiskDefPtr def, int type);
2467
const char *virDomainDiskGetSource(virDomainDiskDef const *def);
2468 2469 2470 2471 2472 2473 2474
int virDomainDiskSetSource(virDomainDiskDefPtr def, const char *src)
    ATTRIBUTE_RETURN_CHECK;
const char *virDomainDiskGetDriver(virDomainDiskDefPtr def);
int virDomainDiskSetDriver(virDomainDiskDefPtr def, const char *name)
    ATTRIBUTE_RETURN_CHECK;
int virDomainDiskGetFormat(virDomainDiskDefPtr def);
void virDomainDiskSetFormat(virDomainDiskDefPtr def, int format);
2475
int virDomainDeviceFindControllerModel(const virDomainDef *def,
H
Han Cheng 已提交
2476 2477
                                       virDomainDeviceInfoPtr info,
                                       int controllerType);
2478 2479 2480
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2481
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2482 2483
virDomainControllerDefPtr
virDomainControllerDefNew(virDomainControllerType type);
2484
void virDomainFSDefFree(virDomainFSDefPtr def);
2485
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
2486
void virDomainNetDefClear(virDomainNetDefPtr def);
2487
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2488
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2489
void virDomainChrDefFree(virDomainChrDefPtr def);
2490
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
2491 2492
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
2493
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2494
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2495
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
L
Li Zhang 已提交
2496
void virDomainNVRAMDefFree(virDomainNVRAMDefPtr def);
R
Richard Jones 已提交
2497
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2498
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2499
virDomainHostdevDefPtr virDomainHostdevDefAlloc(virDomainXMLOptionPtr xmlopt);
2500
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2501
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2502
void virDomainHubDefFree(virDomainHubDefPtr def);
2503
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2504
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2505
void virDomainShmemDefFree(virDomainShmemDefPtr def);
2506
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2507
virDomainDeviceDefPtr virDomainDeviceDefCopy(virDomainDeviceDefPtr src,
2508
                                             const virDomainDef *def,
2509 2510
                                             virCapsPtr caps,
                                             virDomainXMLOptionPtr xmlopt);
2511 2512
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2513
virDomainDeviceInfoPtr virDomainDeviceGetInfo(virDomainDeviceDefPtr device);
2514 2515
int virDomainDeviceInfoCopy(virDomainDeviceInfoPtr dst,
                            virDomainDeviceInfoPtr src);
2516
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
2517
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
2518
void virDomainDefClearCCWAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
2519
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
2520
void virDomainTPMDefFree(virDomainTPMDefPtr def);
2521

2522
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2523 2524
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2525 2526 2527 2528 2529 2530
                                           void *opaque);

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

2531 2532 2533 2534
bool virDomainDefHasDeviceAddress(virDomainDefPtr def,
                                  virDomainDeviceInfoPtr info)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;

2535 2536
void virDomainDefFree(virDomainDefPtr vm);

M
Michal Novotny 已提交
2537 2538
virDomainChrDefPtr virDomainChrDefNew(void);

2539 2540 2541 2542
virDomainDefPtr virDomainDefNew(void);
virDomainDefPtr virDomainDefNewFull(const char *name,
                                    const unsigned char *uuid,
                                    int id);
2543

2544
void virDomainObjAssignDef(virDomainObjPtr domain,
2545
                           virDomainDefPtr def,
2546 2547
                           bool live,
                           virDomainDefPtr *oldDef);
2548
int virDomainObjSetDefTransient(virCapsPtr caps,
2549
                                virDomainXMLOptionPtr xmlopt,
2550
                                virDomainObjPtr domain);
2551 2552
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2553
                             virDomainXMLOptionPtr xmlopt,
2554
                             virDomainObjPtr domain);
2555 2556 2557 2558 2559 2560 2561 2562

int virDomainObjUpdateModificationImpact(virDomainObjPtr vm,
                                         unsigned int *flags);

int virDomainObjGetDefs(virDomainObjPtr vm,
                        unsigned int flags,
                        virDomainDefPtr *liveDef,
                        virDomainDefPtr *persDef);
2563
virDomainDefPtr virDomainObjGetOneDef(virDomainObjPtr vm, unsigned int flags);
2564 2565 2566

int
virDomainLiveConfigHelperMethod(virCapsPtr caps,
2567
                                virDomainXMLOptionPtr xmlopt,
2568 2569 2570 2571
                                virDomainObjPtr dom,
                                unsigned int *flags,
                                virDomainDefPtr *persistentDef);

2572 2573 2574 2575 2576 2577 2578
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virCapsPtr caps,
                                 virDomainXMLOptionPtr xmlopt,
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt);
2579

2580 2581 2582
typedef enum {
    /* parse internal domain status information */
    VIR_DOMAIN_DEF_PARSE_STATUS          = 1 << 0,
2583 2584 2585 2586
    /* Parse only parts of the XML that would be present in an inactive libvirt
     * XML. Note that the flag does not imply that ABI incompatible
     * transformations can be used, since it's used to strip runtime info when
     * restoring save images/migration. */
2587 2588 2589 2590 2591
    VIR_DOMAIN_DEF_PARSE_INACTIVE        = 1 << 1,
    /* parse <actual> element */
    VIR_DOMAIN_DEF_PARSE_ACTUAL_NET      = 1 << 2,
    /* parse original states of host PCI device */
    VIR_DOMAIN_DEF_PARSE_PCI_ORIG_STATES = 1 << 3,
2592
    /* internal flag passed to device info sub-parser to allow using <rom> */
2593
    VIR_DOMAIN_DEF_PARSE_ALLOW_ROM       = 1 << 4,
2594
    /* internal flag passed to device info sub-parser to allow specifying boot order */
2595 2596
    VIR_DOMAIN_DEF_PARSE_ALLOW_BOOT      = 1 << 5,
    /* parse only source half of <disk> */
2597
    VIR_DOMAIN_DEF_PARSE_DISK_SOURCE     = 1 << 6,
2598
    /* perform RNG schema validation on the passed XML document */
2599
    VIR_DOMAIN_DEF_PARSE_VALIDATE_SCHEMA = 1 << 7,
2600
    /* don't validate os.type and arch against capabilities. Prevents
2601
     * VMs from disappearing when qemu is removed and libvirtd is restarted */
2602
    VIR_DOMAIN_DEF_PARSE_SKIP_OSTYPE_CHECKS = 1 << 8,
2603 2604
    /* allow updates in post parse callback that would break ABI otherwise */
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE = 1 << 9,
2605 2606
    /* skip definition validation checks meant to be executed on define time only */
    VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE = 1 << 10,
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624
} virDomainDefParseFlags;

typedef enum {
    VIR_DOMAIN_DEF_FORMAT_SECURE          = 1 << 0,
    VIR_DOMAIN_DEF_FORMAT_INACTIVE        = 1 << 1,
    VIR_DOMAIN_DEF_FORMAT_UPDATE_CPU      = 1 << 2,
    VIR_DOMAIN_DEF_FORMAT_MIGRATABLE      = 1 << 3,
    /* format internal domain status information */
    VIR_DOMAIN_DEF_FORMAT_STATUS          = 1 << 4,
    /* format <actual> element */
    VIR_DOMAIN_DEF_FORMAT_ACTUAL_NET      = 1 << 5,
    /* format original states of host PCI device */
    VIR_DOMAIN_DEF_FORMAT_PCI_ORIG_STATES = 1 << 6,
    VIR_DOMAIN_DEF_FORMAT_ALLOW_ROM       = 1 << 7,
    VIR_DOMAIN_DEF_FORMAT_ALLOW_BOOT      = 1 << 8,
    VIR_DOMAIN_DEF_FORMAT_CLOCK_ADJUST    = 1 << 9,
} virDomainDefFormatFlags;

2625
virDomainDeviceDefPtr virDomainDeviceDefParse(const char *xmlStr,
2626
                                              const virDomainDef *def,
2627 2628
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2629
                                              unsigned int flags);
2630 2631 2632 2633
virStorageSourcePtr virDomainDiskDefSourceParse(const char *xmlStr,
                                                const virDomainDef *def,
                                                virDomainXMLOptionPtr xmlopt,
                                                unsigned int flags);
2634 2635
virDomainDefPtr virDomainDefParseString(const char *xmlStr,
                                        virCapsPtr caps,
2636
                                        virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2637
                                        unsigned int flags);
2638 2639
virDomainDefPtr virDomainDefParseFile(const char *filename,
                                      virCapsPtr caps,
2640
                                      virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2641
                                      unsigned int flags);
2642
virDomainDefPtr virDomainDefParseNode(xmlDocPtr doc,
2643
                                      xmlNodePtr root,
2644 2645
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2646
                                      unsigned int flags);
2647 2648 2649 2650 2651
virDomainObjPtr virDomainObjParseNode(xmlDocPtr xml,
                                      xmlNodePtr root,
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
2652 2653 2654 2655
virDomainObjPtr virDomainObjParseFile(const char *filename,
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
2656

2657 2658 2659
bool virDomainDefCheckABIStability(virDomainDefPtr src,
                                   virDomainDefPtr dst);

2660
int virDomainDefAddImplicitDevices(virDomainDefPtr def);
2661

2662
virDomainIOThreadIDDefPtr virDomainIOThreadIDFind(const virDomainDef *def,
2663 2664 2665 2666 2667
                                                  unsigned int iothread_id);
virDomainIOThreadIDDefPtr virDomainIOThreadIDAdd(virDomainDefPtr def,
                                                 unsigned int iothread_id);
void virDomainIOThreadIDDel(virDomainDefPtr def, unsigned int iothread_id);

2668 2669
unsigned int virDomainDefFormatConvertXMLFlags(unsigned int flags);

2670
char *virDomainDefFormat(virDomainDefPtr def,
2671
                         virCapsPtr caps,
L
Laine Stump 已提交
2672
                         unsigned int flags);
2673 2674
char *virDomainObjFormat(virDomainXMLOptionPtr xmlopt,
                         virDomainObjPtr obj,
2675
                         virCapsPtr caps,
2676
                         unsigned int flags);
2677
int virDomainDefFormatInternal(virDomainDefPtr def,
2678
                               virCapsPtr caps,
2679 2680
                               unsigned int flags,
                               virBufferPtr buf);
2681

2682 2683 2684 2685
int virDomainDiskSourceFormat(virBufferPtr buf,
                              virStorageSourcePtr src,
                              int policy,
                              unsigned int flags);
2686

2687 2688
int virDomainNetDefFormat(virBufferPtr buf,
                          virDomainNetDefPtr def,
2689
                          char *prefix,
2690 2691
                          unsigned int flags);

2692 2693 2694 2695 2696 2697
typedef enum {
    VIR_DOMAIN_DEVICE_ACTION_ATTACH,
    VIR_DOMAIN_DEVICE_ACTION_DETACH,
    VIR_DOMAIN_DEVICE_ACTION_UPDATE,
} virDomainDeviceAction;

2698
int virDomainDefCompatibleDevice(virDomainDefPtr def,
2699 2700
                                 virDomainDeviceDefPtr dev,
                                 virDomainDeviceAction action);
2701

2702 2703
void virDomainRNGDefFree(virDomainRNGDefPtr def);

2704
int virDomainDiskIndexByAddress(virDomainDefPtr def,
2705
                                virPCIDeviceAddressPtr pci_controller,
2706 2707
                                unsigned int bus, unsigned int target,
                                unsigned int unit);
2708
virDomainDiskDefPtr virDomainDiskByAddress(virDomainDefPtr def,
2709
                                           virPCIDeviceAddressPtr pci_controller,
2710 2711 2712
                                           unsigned int bus,
                                           unsigned int target,
                                           unsigned int unit);
2713 2714
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
2715 2716 2717
virDomainDiskDefPtr virDomainDiskByName(virDomainDefPtr def,
                                        const char *name,
                                        bool allow_ambiguous);
2718
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
2719
int virDomainDiskInsert(virDomainDefPtr def,
2720 2721
                        virDomainDiskDefPtr disk)
    ATTRIBUTE_RETURN_CHECK;
2722 2723
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
2724
int virDomainDiskDefAssignAddress(virDomainXMLOptionPtr xmlopt,
2725 2726
                                  virDomainDiskDefPtr def,
                                  const virDomainDef *vmdef);
2727

2728 2729 2730 2731
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
2732
int virDomainDiskSourceParse(xmlNodePtr node,
2733
                             xmlXPathContextPtr ctxt,
2734
                             virStorageSourcePtr src);
2735

2736 2737
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
2738
bool virDomainHasNet(virDomainDefPtr def, virDomainNetDefPtr net);
2739
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
2740
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
2741
void virDomainNetRemoveHostdev(virDomainDefPtr def, virDomainNetDefPtr net);
2742

L
Laine Stump 已提交
2743
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
2744 2745
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
2746 2747 2748
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

2749 2750
virDomainGraphicsListenDefPtr
virDomainGraphicsGetListen(virDomainGraphicsDefPtr def, size_t i);
2751 2752
int virDomainGraphicsListenAppendAddress(virDomainGraphicsDefPtr def,
                                         const char *address)
2753
            ATTRIBUTE_NONNULL(1);
2754 2755 2756
int virDomainGraphicsListenAppendSocket(virDomainGraphicsDefPtr def,
                                        const char *socket)
            ATTRIBUTE_NONNULL(1);
2757

2758
int virDomainNetGetActualType(virDomainNetDefPtr iface);
2759
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
2760
int virDomainNetGetActualBridgeMACTableManager(virDomainNetDefPtr iface);
2761
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
2762
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
2763
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
2764
virNetDevVPortProfilePtr
2765
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
2766
virNetDevBandwidthPtr
2767
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
2768
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
2769
bool virDomainNetGetActualTrustGuestRxFilters(virDomainNetDefPtr iface);
2770
int virDomainNetAppendIPAddress(virDomainNetDefPtr def,
2771 2772 2773
                                const char *address,
                                int family,
                                unsigned int prefix);
2774

2775
int virDomainControllerInsert(virDomainDefPtr def,
2776 2777
                              virDomainControllerDefPtr controller)
    ATTRIBUTE_RETURN_CHECK;
2778 2779
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
2780
int virDomainControllerFind(const virDomainDef *def, int type, int idx);
2781
int virDomainControllerFindByType(virDomainDefPtr def, int type);
2782
int virDomainControllerFindByPCIAddress(virDomainDefPtr def,
2783
                                        virPCIDeviceAddressPtr addr);
2784
int virDomainControllerFindUnusedIndex(virDomainDef const *def, int type);
2785
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
2786
const char *virDomainControllerAliasFind(const virDomainDef *def,
2787 2788
                                         int type, int idx)
    ATTRIBUTE_NONNULL(1);
2789 2790 2791 2792 2793

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
2794 2795
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def)
    ATTRIBUTE_RETURN_CHECK;
2796 2797
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
2798 2799 2800 2801 2802
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
2803

2804
void
2805
virDomainChrGetDomainPtrs(const virDomainDef *vmdef,
2806
                          virDomainChrDeviceType type,
2807 2808 2809
                          const virDomainChrDef ***arrPtr,
                          size_t *cntPtr)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
2810 2811 2812
virDomainChrDefPtr
virDomainChrFind(virDomainDefPtr def,
                 virDomainChrDefPtr target);
2813 2814 2815
bool
virDomainChrEquals(virDomainChrDefPtr src,
                   virDomainChrDefPtr tgt);
2816
int
2817 2818 2819 2820 2821
virDomainChrPreAlloc(virDomainDefPtr vmdef,
                     virDomainChrDefPtr chr);
void
virDomainChrInsertPreAlloced(virDomainDefPtr vmdef,
                             virDomainChrDefPtr chr);
2822 2823 2824 2825
virDomainChrDefPtr
virDomainChrRemove(virDomainDefPtr vmdef,
                   virDomainChrDefPtr chr);

2826 2827 2828
ssize_t virDomainRNGFind(virDomainDefPtr def, virDomainRNGDefPtr rng);
virDomainRNGDefPtr virDomainRNGRemove(virDomainDefPtr def, size_t idx);

2829 2830 2831 2832
ssize_t virDomainRedirdevDefFind(virDomainDefPtr def,
                                 virDomainRedirdevDefPtr redirdev);
virDomainRedirdevDefPtr virDomainRedirdevDefRemove(virDomainDefPtr def, size_t idx);

2833
int virDomainSaveXML(const char *configDir,
2834 2835 2836
                     virDomainDefPtr def,
                     const char *xml);

2837
int virDomainSaveConfig(const char *configDir,
2838
                        virCapsPtr caps,
2839
                        virDomainDefPtr def);
2840
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
2841
                        const char *statusDir,
2842 2843
                        virDomainObjPtr obj,
                        virCapsPtr caps) ATTRIBUTE_RETURN_CHECK;
2844

2845 2846 2847 2848
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

2849
int virDomainDeleteConfig(const char *configDir,
2850
                          const char *autostartDir,
2851 2852
                          virDomainObjPtr dom);

2853
char *virDomainConfigFile(const char *dir,
2854 2855
                          const char *name);

2856 2857 2858 2859
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

2860
virDomainFSDefPtr virDomainGetFilesystemForTarget(virDomainDefPtr def,
2861
                                                  const char *target);
2862
int virDomainFSInsert(virDomainDefPtr def, virDomainFSDefPtr fs);
2863
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
2864 2865
virDomainFSDefPtr virDomainFSRemove(virDomainDefPtr def, size_t i);

2866
int virDomainVideoDefaultType(const virDomainDef *def);
2867 2868
unsigned int virDomainVideoDefaultRAM(const virDomainDef *def,
                                      const virDomainVideoType type);
2869

E
Eric Blake 已提交
2870 2871 2872 2873 2874 2875 2876 2877 2878
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

2879 2880 2881 2882 2883 2884 2885 2886 2887
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
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 已提交
2898 2899 2900 2901 2902 2903 2904
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

2905 2906 2907
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

2908 2909 2910
virSecurityDeviceLabelDefPtr
virDomainChrDefGetSecurityLabelDef(virDomainChrDefPtr def, const char *model);

2911 2912
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
2913

2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
int virDomainMemoryInsert(virDomainDefPtr def, virDomainMemoryDefPtr mem)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
virDomainMemoryDefPtr virDomainMemoryRemove(virDomainDefPtr def, int idx)
    ATTRIBUTE_NONNULL(1);
int virDomainMemoryFindByDef(virDomainDefPtr def, virDomainMemoryDefPtr mem)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
int virDomainMemoryFindInactiveByDef(virDomainDefPtr def,
                                     virDomainMemoryDefPtr mem)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;

2924
VIR_ENUM_DECL(virDomainTaint)
2925 2926 2927
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
VIR_ENUM_DECL(virDomainFeature)
2928 2929
VIR_ENUM_DECL(virDomainCapabilitiesPolicy)
VIR_ENUM_DECL(virDomainCapsFeature)
2930
VIR_ENUM_DECL(virDomainLifecycle)
2931
VIR_ENUM_DECL(virDomainLifecycleCrash)
2932
VIR_ENUM_DECL(virDomainDevice)
2933
VIR_ENUM_DECL(virDomainDeviceAddress)
2934
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
2935
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
2936
VIR_ENUM_DECL(virDomainDiskBus)
2937
VIR_ENUM_DECL(virDomainDiskCache)
2938
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
Matthias Dahl 已提交
2939
VIR_ENUM_DECL(virDomainDiskIo)
2940
VIR_ENUM_DECL(virDomainDeviceSGIO)
2941
VIR_ENUM_DECL(virDomainDiskTray)
O
Osier Yang 已提交
2942
VIR_ENUM_DECL(virDomainDiskDiscard)
2943
VIR_ENUM_DECL(virDomainDiskDetectZeroes)
2944
VIR_ENUM_DECL(virDomainDiskMirrorState)
2945
VIR_ENUM_DECL(virDomainController)
J
Ján Tomko 已提交
2946
VIR_ENUM_DECL(virDomainControllerModelPCI)
2947
VIR_ENUM_DECL(virDomainControllerPCIModelName)
2948
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
2949
VIR_ENUM_DECL(virDomainControllerModelUSB)
2950
VIR_ENUM_DECL(virDomainFS)
2951
VIR_ENUM_DECL(virDomainFSDriver)
2952
VIR_ENUM_DECL(virDomainFSAccessMode)
2953
VIR_ENUM_DECL(virDomainFSWrpolicy)
2954
VIR_ENUM_DECL(virDomainNet)
2955
VIR_ENUM_DECL(virDomainNetBackend)
2956
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
2957
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
2958
VIR_ENUM_DECL(virDomainChrDevice)
2959
VIR_ENUM_DECL(virDomainChrChannelTarget)
2960
VIR_ENUM_DECL(virDomainChrConsoleTarget)
G
Guannan Ren 已提交
2961
VIR_ENUM_DECL(virDomainChrSerialTarget)
E
Eric Blake 已提交
2962
VIR_ENUM_DECL(virDomainSmartcard)
2963
VIR_ENUM_DECL(virDomainChr)
2964
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
2965
VIR_ENUM_DECL(virDomainChrSpicevmc)
2966
VIR_ENUM_DECL(virDomainSoundCodec)
2967
VIR_ENUM_DECL(virDomainSoundModel)
2968
VIR_ENUM_DECL(virDomainKeyWrapCipherName)
2969
VIR_ENUM_DECL(virDomainMemballoonModel)
2970
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
2971 2972
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
2973
VIR_ENUM_DECL(virDomainPanicModel)
2974
VIR_ENUM_DECL(virDomainVideo)
2975 2976
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
2977
VIR_ENUM_DECL(virDomainHostdevCaps)
M
Marc-André Lureau 已提交
2978
VIR_ENUM_DECL(virDomainHub)
2979
VIR_ENUM_DECL(virDomainRedirdevBus)
2980 2981 2982
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
2983
VIR_ENUM_DECL(virDomainGraphicsListen)
2984
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
2985 2986
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
2987 2988 2989
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
2990
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
P
Peng Zhou 已提交
2991
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
2992
VIR_ENUM_DECL(virDomainGraphicsVNCSharePolicy)
2993
VIR_ENUM_DECL(virDomainHyperv)
2994
VIR_ENUM_DECL(virDomainKVM)
2995 2996
VIR_ENUM_DECL(virDomainRNGModel)
VIR_ENUM_DECL(virDomainRNGBackend)
2997 2998
VIR_ENUM_DECL(virDomainTPMModel)
VIR_ENUM_DECL(virDomainTPMBackend)
2999 3000
VIR_ENUM_DECL(virDomainMemoryModel)
VIR_ENUM_DECL(virDomainMemoryBackingModel)
3001 3002
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
3003 3004 3005 3006 3007 3008 3009
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)
3010
VIR_ENUM_DECL(virDomainPMSuspendedReason)
J
Jiri Denemark 已提交
3011 3012 3013 3014

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

3015
VIR_ENUM_DECL(virDomainSeclabel)
3016
VIR_ENUM_DECL(virDomainClockOffset)
3017
VIR_ENUM_DECL(virDomainClockBasis)
3018

3019
VIR_ENUM_DECL(virDomainTimerName)
3020
VIR_ENUM_DECL(virDomainTimerTrack)
3021 3022
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
3023
VIR_ENUM_DECL(virDomainCpuPlacementMode)
3024

3025
VIR_ENUM_DECL(virDomainStartupPolicy)
3026

3027 3028
virDomainControllerDefPtr
virDomainDefAddController(virDomainDefPtr def, int type, int idx, int model);
3029 3030
int
virDomainDefAddUSBController(virDomainDefPtr def, int idx, int model);
3031 3032 3033 3034 3035
int
virDomainDefMaybeAddController(virDomainDefPtr def,
                               int type,
                               int idx,
                               int model);
3036 3037 3038 3039
int
virDomainDefMaybeAddInput(virDomainDefPtr def,
                          int type,
                          int bus);
3040

3041 3042
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

3043 3044
int virDomainDefFindDevice(virDomainDefPtr def,
                           const char *devAlias,
3045 3046
                           virDomainDeviceDefPtr dev,
                           bool reportError);
3047

3048 3049
void virDomainChrSourceDefClear(virDomainChrSourceDefPtr def);

3050 3051 3052 3053 3054 3055 3056
char *virDomainObjGetMetadata(virDomainObjPtr vm,
                              int type,
                              const char *uri,
                              virCapsPtr caps,
                              virDomainXMLOptionPtr xmlopt,
                              unsigned int flags);

3057 3058 3059 3060 3061 3062 3063
int virDomainObjSetMetadata(virDomainObjPtr vm,
                            int type,
                            const char *metadata,
                            const char *key,
                            const char *uri,
                            virCapsPtr caps,
                            virDomainXMLOptionPtr xmlopt,
3064
                            const char *stateDir,
3065 3066 3067
                            const char *configDir,
                            unsigned int flags);

3068 3069 3070 3071 3072 3073 3074 3075
int
virDomainParseMemory(const char *xpath,
                     const char *units_xpath,
                     xmlXPathContextPtr ctxt,
                     unsigned long long *mem,
                     bool required,
                     bool capped);

3076 3077 3078
bool virDomainDefNeedsPlacementAdvice(virDomainDefPtr def)
    ATTRIBUTE_NONNULL(1);

3079 3080
int virDomainDiskDefCheckDuplicateInfo(const virDomainDiskDef *a,
                                       const virDomainDiskDef *b)
3081
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3082

3083 3084 3085 3086 3087 3088 3089 3090
int virDomainDefGetVcpuPinInfoHelper(virDomainDefPtr def,
                                     int maplen,
                                     int ncpumaps,
                                     unsigned char *cpumaps,
                                     int hostcpus,
                                     virBitmapPtr autoCpuset)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;

3091 3092
bool virDomainDefHasMemballoon(const virDomainDef *def) ATTRIBUTE_NONNULL(1);

M
Martin Kletzander 已提交
3093 3094
char *virDomainObjGetShortName(virDomainObjPtr vm);

3095 3096 3097 3098 3099
int
virDomainGetBlkioParametersAssignFromDef(virDomainDefPtr def,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         int maxparams);
3100
#endif /* __DOMAIN_CONF_H */