domain_conf.h 114.7 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 "virnetdev.h"
45
# include "virnetdevip.h"
46 47
# include "virnetdevvportprofile.h"
# include "virnetdevbandwidth.h"
48
# include "virnetdevvlan.h"
49
# include "virobject.h"
50
# include "device_conf.h"
51
# include "virbitmap.h"
52
# include "virstoragefile.h"
53
# include "virseclabel.h"
54
# include "virprocess.h"
55
# include "virgic.h"
Q
Qiaowei Ren 已提交
56
# include "virperf.h"
57
# include "virtypedparam.h"
58
# include "virsavecookie.h"
59
# include "virresctrl.h"
60

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

82 83 84
typedef struct _virDomainSoundCodecDef virDomainSoundCodecDef;
typedef virDomainSoundCodecDef *virDomainSoundCodecDefPtr;

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

106 107
typedef struct _virDomainRedirFilterUSBDevDef virDomainRedirFilterUSBDevDef;
typedef virDomainRedirFilterUSBDevDef *virDomainRedirFilterUSBDevDefPtr;
108 109 110 111

typedef struct _virDomainRedirFilterDef virDomainRedirFilterDef;
typedef virDomainRedirFilterDef *virDomainRedirFilterDefPtr;

112 113 114 115 116 117 118 119 120
typedef struct _virDomainSmartcardDef virDomainSmartcardDef;
typedef virDomainSmartcardDef *virDomainSmartcardDefPtr;

typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;

L
Li Zhang 已提交
121 122 123
typedef struct _virDomainNVRAMDef virDomainNVRAMDef;
typedef virDomainNVRAMDef *virDomainNVRAMDefPtr;

124 125 126 127 128 129
typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;

130 131 132
typedef struct _virDomainRNGDef virDomainRNGDef;
typedef virDomainRNGDef *virDomainRNGDefPtr;

133 134 135 136 137 138
typedef struct _virDomainIdMapEntry virDomainIdMapEntry;
typedef virDomainIdMapEntry *virDomainIdMapEntryPtr;

typedef struct _virDomainIdMapDef virDomainIdMapDef;
typedef virDomainIdMapDef *virDomainIdMapDefPtr;

H
Hu Tao 已提交
139 140 141
typedef struct _virDomainPanicDef virDomainPanicDef;
typedef virDomainPanicDef *virDomainPanicDefPtr;

142 143 144
typedef struct _virDomainMemoryDef virDomainMemoryDef;
typedef virDomainMemoryDef *virDomainMemoryDefPtr;

M
Michele Paolino 已提交
145 146 147 148 149 150
/* forward declarations virDomainChrSourceDef, required by
 * virDomainNetDef
 */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;

151 152 153
typedef struct _virDomainShmemDef virDomainShmemDef;
typedef virDomainShmemDef *virDomainShmemDefPtr;

154 155 156
typedef struct _virDomainTPMDef virDomainTPMDef;
typedef virDomainTPMDef *virDomainTPMDefPtr;

J
Ján Tomko 已提交
157 158 159
typedef struct _virDomainIOMMUDef virDomainIOMMUDef;
typedef virDomainIOMMUDef *virDomainIOMMUDefPtr;

160 161 162
typedef struct _virDomainVirtioOptions virDomainVirtioOptions;
typedef virDomainVirtioOptions *virDomainVirtioOptionsPtr;

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/* 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 已提交
182
    VIR_DOMAIN_DEVICE_NVRAM,
183
    VIR_DOMAIN_DEVICE_RNG,
184
    VIR_DOMAIN_DEVICE_SHMEM,
185
    VIR_DOMAIN_DEVICE_TPM,
186
    VIR_DOMAIN_DEVICE_PANIC,
187
    VIR_DOMAIN_DEVICE_MEMORY,
J
Ján Tomko 已提交
188
    VIR_DOMAIN_DEVICE_IOMMU,
189

190
    VIR_DOMAIN_DEVICE_LAST
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
} 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 已提交
214
        virDomainNVRAMDefPtr nvram;
215
        virDomainRNGDefPtr rng;
216
        virDomainShmemDefPtr shmem;
217
        virDomainTPMDefPtr tpm;
218
        virDomainPanicDefPtr panic;
219
        virDomainMemoryDefPtr memory;
J
Ján Tomko 已提交
220
        virDomainIOMMUDefPtr iommu;
221 222 223
    } data;
};

224 225
/* Different types of hypervisor */
/* NB: Keep in sync with virDomainVirtTypeToString impl */
226
typedef enum {
227
    VIR_DOMAIN_VIRT_NONE = 0,
228 229 230 231 232 233 234 235 236 237
    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,
238
    VIR_DOMAIN_VIRT_VBOX,
239
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
240
    VIR_DOMAIN_VIRT_PARALLELS,
R
Roman Bogorodskiy 已提交
241
    VIR_DOMAIN_VIRT_BHYVE,
242
    VIR_DOMAIN_VIRT_VZ,
243

244
    VIR_DOMAIN_VIRT_LAST
245
} virDomainVirtType;
246

247 248 249 250 251 252 253 254 255 256 257 258
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)


259 260 261 262 263 264 265 266
typedef struct _virDomainHostdevOrigStates virDomainHostdevOrigStates;
typedef virDomainHostdevOrigStates *virDomainHostdevOrigStatesPtr;
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
267
            bool unbind_from_stub;
268 269 270 271

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
272
            bool remove_slot;
273 274 275 276

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
277
            bool reprobe;
278 279 280 281 282 283
        } pci;

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

284 285 286 287 288 289 290
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

291

292
typedef enum {
293 294 295
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

296
    VIR_DOMAIN_HOSTDEV_MODE_LAST
297
} virDomainHostdevMode;
298

299
typedef enum {
300 301
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,
H
Han Cheng 已提交
302
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI,
303
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI_HOST,
304
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_MDEV,
305 306

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
307
} virDomainHostdevSubsysType;
308

309 310
/* the backend driver used for PCI hostdev devices */
typedef enum {
N
Nitesh Konkar 已提交
311
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_DEFAULT, /* detect automatically, prefer VFIO */
312 313
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_KVM,    /* force legacy kvm style */
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_VFIO,   /* force vfio */
314
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_XEN,    /* force legacy xen style, use pciback */
315 316

    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_TYPE_LAST
317
} virDomainHostdevSubsysPCIBackendType;
318

319
VIR_ENUM_DECL(virDomainHostdevSubsysPCIBackend)
320

321 322 323 324 325 326 327 328 329
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)

330 331 332 333 334 335 336 337 338 339 340 341
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;
};

342 343 344
typedef struct _virDomainHostdevSubsysPCI virDomainHostdevSubsysPCI;
typedef virDomainHostdevSubsysPCI *virDomainHostdevSubsysPCIPtr;
struct _virDomainHostdevSubsysPCI {
345
    virPCIDeviceAddress addr; /* host address */
346 347 348
    int backend; /* enum virDomainHostdevSubsysPCIBackendType */
};

349 350 351
typedef struct _virDomainHostdevSubsysSCSIHost virDomainHostdevSubsysSCSIHost;
typedef virDomainHostdevSubsysSCSIHost *virDomainHostdevSubsysSCSIHostPtr;
struct _virDomainHostdevSubsysSCSIHost {
352 353 354
    char *adapter;
    unsigned bus;
    unsigned target;
355
    unsigned long long unit;
356 357
};

358 359 360
typedef struct _virDomainHostdevSubsysSCSIiSCSI virDomainHostdevSubsysSCSIiSCSI;
typedef virDomainHostdevSubsysSCSIiSCSI *virDomainHostdevSubsysSCSIiSCSIPtr;
struct _virDomainHostdevSubsysSCSIiSCSI {
361
    virStorageSourcePtr src;
362 363
};

364 365 366
typedef struct _virDomainHostdevSubsysSCSI virDomainHostdevSubsysSCSI;
typedef virDomainHostdevSubsysSCSI *virDomainHostdevSubsysSCSIPtr;
struct _virDomainHostdevSubsysSCSI {
367
    int protocol; /* enum virDomainHostdevSCSIProtocolType */
368
    int sgio; /* enum virDomainDeviceSGIO */
369
    int rawio; /* enum virTristateBool */
370 371
    union {
        virDomainHostdevSubsysSCSIHost host;
372
        virDomainHostdevSubsysSCSIiSCSI iscsi;
373
    } u;
374 375
};

376 377 378 379 380 381 382
typedef struct _virDomainHostdevSubsysMediatedDev virDomainHostdevSubsysMediatedDev;
typedef virDomainHostdevSubsysMediatedDev *virDomainHostdevSubsysMediatedDevPtr;
struct _virDomainHostdevSubsysMediatedDev {
    int model;                          /* enum virMediatedDeviceModelType */
    char uuidstr[VIR_UUID_STRING_BUFLEN];   /* mediated device's uuid string */
};

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
typedef enum {
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_HOST_PROTOCOL_TYPE_NONE,
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_HOST_PROTOCOL_TYPE_VHOST,

    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_HOST_PROTOCOL_TYPE_LAST,
} virDomainHostdevSubsysSCSIHostProtocolType;

VIR_ENUM_DECL(virDomainHostdevSubsysSCSIHostProtocol)

typedef struct _virDomainHostdevSubsysSCSIVHost virDomainHostdevSubsysSCSIVHost;
typedef virDomainHostdevSubsysSCSIVHost *virDomainHostdevSubsysSCSIVHostPtr;
struct _virDomainHostdevSubsysSCSIVHost {
    int protocol; /* enum virDomainHostdevSubsysSCSIHostProtocolType */
    char *wwpn;
};

399 400 401
typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys;
typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr;
struct _virDomainHostdevSubsys {
402
    int type; /* enum virDomainHostdevSubsysType */
403
    union {
404
        virDomainHostdevSubsysUSB usb;
405
        virDomainHostdevSubsysPCI pci;
406
        virDomainHostdevSubsysSCSI scsi;
407
        virDomainHostdevSubsysSCSIVHost scsi_host;
408
        virDomainHostdevSubsysMediatedDev mdev;
409 410 411
    } u;
};

412

413
typedef enum {
414 415
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,
416
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_NET,
417 418

    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_LAST
419
} virDomainHostdevCapsType;
420 421 422 423 424 425 426 427 428 429 430 431

typedef struct _virDomainHostdevCaps virDomainHostdevCaps;
typedef virDomainHostdevCaps *virDomainHostdevCapsPtr;
struct _virDomainHostdevCaps {
    int type; /* enum virDOmainHostdevCapsType */
    union {
        struct {
            char *block;
        } storage;
        struct {
            char *chardev;
        } misc;
432
        struct {
433 434
            char *ifname;
            virNetDevIPInfo ip;
435
        } net;
436 437 438 439
    } u;
};


440 441
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
442
    virDomainDeviceDef parent; /* higher level Def containing this */
443

444
    int mode; /* enum virDomainHostdevMode */
445
    int startupPolicy; /* enum virDomainStartupPolicy */
446
    bool managed;
447
    bool missing;
O
Osier Yang 已提交
448
    bool readonly;
449
    bool shareable;
450
    union {
451
        virDomainHostdevSubsys subsys;
452
        virDomainHostdevCaps caps;
453 454
    } source;
    virDomainHostdevOrigStates origstates;
455
    virDomainDeviceInfoPtr info; /* Guest address */
456 457
};

458

E
Eric Blake 已提交
459 460
/* Types of disk frontend (guest view).  For backends (host view), see
 * virStorageType in util/virstoragefile.h */
461
typedef enum {
462 463 464
    VIR_DOMAIN_DISK_DEVICE_DISK,
    VIR_DOMAIN_DISK_DEVICE_CDROM,
    VIR_DOMAIN_DISK_DEVICE_FLOPPY,
465
    VIR_DOMAIN_DISK_DEVICE_LUN,
466 467

    VIR_DOMAIN_DISK_DEVICE_LAST
468
} virDomainDiskDevice;
469

470
typedef enum {
471 472 473 474 475
    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,
476
    VIR_DOMAIN_DISK_BUS_USB,
477
    VIR_DOMAIN_DISK_BUS_UML,
478
    VIR_DOMAIN_DISK_BUS_SATA,
479
    VIR_DOMAIN_DISK_BUS_SD,
480 481

    VIR_DOMAIN_DISK_BUS_LAST
482
} virDomainDiskBus;
483

484
typedef enum {
485 486 487 488
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
489
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
490
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
491 492

    VIR_DOMAIN_DISK_CACHE_LAST
493
} virDomainDiskCache;
494

495
typedef enum {
496 497
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
498
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
499
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
500
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
501 502

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
503
} virDomainDiskErrorPolicy;
504

M
MORITA Kazutaka 已提交
505

506
typedef enum {
507
    VIR_DOMAIN_DISK_TRAY_CLOSED = 0,
508 509 510
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
511
} virDomainDiskTray;
512

513
typedef enum {
J
J.B. Joret 已提交
514 515 516 517 518 519
    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
520
} virDomainDiskGeometryTrans;
J
J.B. Joret 已提交
521

522
typedef enum {
523
    VIR_DOMAIN_DISK_IO_DEFAULT = 0,
M
Matthias Dahl 已提交
524 525 526 527
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
528
} virDomainDiskIo;
M
Matthias Dahl 已提交
529

530
typedef enum {
531 532 533 534 535 536
    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
537
} virDomainStartupPolicy;
538

539

540
typedef enum {
541 542 543
    VIR_DOMAIN_DEVICE_SGIO_DEFAULT = 0,
    VIR_DOMAIN_DEVICE_SGIO_FILTERED,
    VIR_DOMAIN_DEVICE_SGIO_UNFILTERED,
O
Osier Yang 已提交
544

545
    VIR_DOMAIN_DEVICE_SGIO_LAST
546
} virDomainDeviceSGIO;
O
Osier Yang 已提交
547

548
typedef enum {
O
Osier Yang 已提交
549
    VIR_DOMAIN_DISK_DISCARD_DEFAULT = 0,
O
Osier Yang 已提交
550 551
    VIR_DOMAIN_DISK_DISCARD_UNMAP,
    VIR_DOMAIN_DISK_DISCARD_IGNORE,
O
Osier Yang 已提交
552 553

    VIR_DOMAIN_DISK_DISCARD_LAST
554
} virDomainDiskDiscard;
O
Osier Yang 已提交
555

556 557 558 559 560 561 562 563 564
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 已提交
565 566 567 568 569 570 571 572
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;
573 574 575 576 577 578 579
    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;
580
    char *group_name;
581 582 583 584 585 586
    unsigned long long total_bytes_sec_max_length;
    unsigned long long read_bytes_sec_max_length;
    unsigned long long write_bytes_sec_max_length;
    unsigned long long total_iops_sec_max_length;
    unsigned long long read_iops_sec_max_length;
    unsigned long long write_iops_sec_max_length;
L
Lei Li 已提交
587 588 589
};
typedef virDomainBlockIoTuneInfo *virDomainBlockIoTuneInfoPtr;

590

591 592 593 594 595 596 597 598 599
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;

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
typedef enum {
    VIR_DOMAIN_MEMORY_SOURCE_NONE = 0,  /* No memory source defined */
    VIR_DOMAIN_MEMORY_SOURCE_FILE,      /* Memory source is set as file */
    VIR_DOMAIN_MEMORY_SOURCE_ANONYMOUS, /* Memory source is set as anonymous */

    VIR_DOMAIN_MEMORY_SOURCE_LAST,
} virDomainMemorySource;

typedef enum {
    VIR_DOMAIN_MEMORY_ALLOCATION_NONE = 0,  /* No memory allocation defined */
    VIR_DOMAIN_MEMORY_ALLOCATION_IMMEDIATE, /* Memory allocation is set as immediate */
    VIR_DOMAIN_MEMORY_ALLOCATION_ONDEMAND,  /* Memory allocation is set as ondemand */

    VIR_DOMAIN_MEMORY_ALLOCATION_LAST,
} virDomainMemoryAllocation;

616

617 618
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
619
    virStorageSourcePtr src; /* non-NULL.  XXX Allow NULL for empty cdrom? */
620

621 622
    virObjectPtr privateData;

623 624 625 626
    int device; /* enum virDomainDiskDevice */
    int bus; /* enum virDomainDiskBus */
    char *dst;
    int tray_status; /* enum virDomainDiskTray */
J
Ján Tomko 已提交
627
    int removable; /* enum virTristateSwitch */
L
Lei Li 已提交
628

629
    virStorageSourcePtr mirror;
630
    int mirrorState; /* enum virDomainDiskMirrorState */
E
Eric Blake 已提交
631
    int mirrorJob; /* virDomainBlockJobType */
632

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

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

L
Lei Li 已提交
645 646
    virDomainBlockIoTuneInfo blkdeviotune;

647
    char *serial;
O
Osier Yang 已提交
648
    char *wwn;
649 650
    char *vendor;
    char *product;
651
    int cachemode; /* enum virDomainDiskCache */
652 653
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
654
    int iomode; /* enum virDomainDiskIo */
J
Ján Tomko 已提交
655 656 657
    int ioeventfd; /* enum virTristateSwitch */
    int event_idx; /* enum virTristateSwitch */
    int copy_on_read; /* enum virTristateSwitch */
658
    int snapshot; /* virDomainSnapshotLocation, snapshot_conf.h */
659
    int startupPolicy; /* enum virDomainStartupPolicy */
660
    bool transient;
661
    virDomainDeviceInfo info;
662
    int rawio; /* enum virTristateBool */
663
    int sgio; /* enum virDomainDeviceSGIO */
O
Osier Yang 已提交
664
    int discard; /* enum virDomainDiskDiscard */
665
    unsigned int iothread; /* unused = 0, > 0 specific thread # */
666
    int detect_zeroes; /* enum virDomainDiskDetectZeroes */
667
    char *domain_name; /* backend domain name */
L
Lin Ma 已提交
668
    unsigned int queues;
J
Ján Tomko 已提交
669
    virDomainVirtioOptionsPtr virtio;
670 671 672
};


673
typedef enum {
674 675 676 677
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
678
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
679
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
680
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
J
Ján Tomko 已提交
681
    VIR_DOMAIN_CONTROLLER_TYPE_PCI,
682 683

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
684
} virDomainControllerType;
685

686

687
typedef enum {
J
Ján Tomko 已提交
688
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_ROOT,
L
Laine Stump 已提交
689
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT,
J
Ján Tomko 已提交
690
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_BRIDGE,
691
    VIR_DOMAIN_CONTROLLER_MODEL_DMI_TO_PCI_BRIDGE,
692
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT_PORT,
693
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_UPSTREAM_PORT,
694
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_DOWNSTREAM_PORT,
695
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_EXPANDER_BUS,
696
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_EXPANDER_BUS,
J
Ján Tomko 已提交
697 698

    VIR_DOMAIN_CONTROLLER_MODEL_PCI_LAST
699
} virDomainControllerModelPCI;
J
Ján Tomko 已提交
700

701 702 703 704
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,
705
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_IOH3420,
706
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_X3130_UPSTREAM,
707
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_XIO3130_DOWNSTREAM,
708
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB,
709
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB_PCIE,
710
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCIE_ROOT_PORT,
711
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_SPAPR_PCI_HOST_BRIDGE,
712 713 714 715

    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_LAST
} virDomainControllerPCIModelName;

716
typedef enum {
717 718 719 720 721
    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,
722
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
723
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
724
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
725

726
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
727
} virDomainControllerModelSCSI;
728

729
typedef enum {
M
Marc-André Lureau 已提交
730 731 732 733 734 735 736 737 738
    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 已提交
739
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
740 741
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QUSB1,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QUSB2,
742
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QEMU_XHCI,
743
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
744 745

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
746
} virDomainControllerModelUSB;
M
Marc-André Lureau 已提交
747

748 749 750 751 752 753 754 755
typedef enum {
    VIR_DOMAIN_CONTROLLER_MODEL_IDE_PIIX3,
    VIR_DOMAIN_CONTROLLER_MODEL_IDE_PIIX4,
    VIR_DOMAIN_CONTROLLER_MODEL_IDE_ICH6,

    VIR_DOMAIN_CONTROLLER_MODEL_IDE_LAST
} virDomainControllerModelIDE;

756 757 758 759 760 761 762
# 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))

763 764 765 766 767 768 769
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

770 771 772
typedef struct _virDomainPCIControllerOpts virDomainPCIControllerOpts;
typedef virDomainPCIControllerOpts *virDomainPCIControllerOptsPtr;
struct _virDomainPCIControllerOpts {
773 774
    bool pcihole64;
    unsigned long pcihole64size;
775 776 777 778 779 780 781

    /* 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 */
782 783 784 785 786 787 788 789

    /* 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 */
790 791 792 793
    /* chassis & port used by
     * pcie-root-port/pcie-switch-downstream-port, -1 = unspecified */
    int chassis;
    int port;
794
    int busNr; /* used by pci-expander-bus, -1 == unspecified */
795
    int targetIndex; /* used by spapr-pci-host-bridge, -1 == unspecified */
796 797 798 799
    /* numaNode is a *subelement* of target (to match existing
     * item in memory target config) -1 == unspecified
     */
    int numaNode;
800
};
801

802 803 804 805 806 807
typedef struct _virDomainUSBControllerOpts virDomainUSBControllerOpts;
typedef virDomainUSBControllerOpts *virDomainUSBControllerOptsPtr;
struct _virDomainUSBControllerOpts {
    int ports;   /* -1 == undef */
};

808 809 810
/* Stores the virtual disk controller configuration */
struct _virDomainControllerDef {
    int type;
811
    int idx;
812
    int model; /* -1 == undef */
813
    unsigned int queues;
814 815
    unsigned int cmd_per_lun;
    unsigned int max_sectors;
816
    int ioeventfd; /* enum virTristateSwitch */
817
    unsigned int iothread; /* unused = 0, > 0 specific thread # */
818 819
    union {
        virDomainVirtioSerialOpts vioserial;
820
        virDomainPCIControllerOpts pciopts;
821
        virDomainUSBControllerOpts usbopts;
822
    } opts;
823
    virDomainDeviceInfo info;
824
    virDomainVirtioOptionsPtr virtio;
825 826 827
};


G
Giuseppe Scrivano 已提交
828
/* Types of disk backends */
829
typedef enum {
830 831 832 833 834 835
    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 */
836
    VIR_DOMAIN_FS_TYPE_VOLUME, /* Mounts storage pool volume to a guest */
837 838

    VIR_DOMAIN_FS_TYPE_LAST
839
} virDomainFSType;
840

841
/* Filesystem driver type */
842
typedef enum {
843 844 845
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,
846
    VIR_DOMAIN_FS_DRIVER_TYPE_LOOP,
847
    VIR_DOMAIN_FS_DRIVER_TYPE_NBD,
D
Dmitry Guryanov 已提交
848
    VIR_DOMAIN_FS_DRIVER_TYPE_PLOOP,
849 850

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
851
} virDomainFSDriverType;
852

853
/* Filesystem mount access mode  */
854
typedef enum {
855 856 857 858 859
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
860
} virDomainFSAccessMode;
861

862
/* Filesystem Write policy */
863
typedef enum {
864 865 866 867
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
868
} virDomainFSWrpolicy;
869

870 871 872
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

873 874
struct _virDomainFSDef {
    int type;
875 876
    int fsdriver; /* enum virDomainFSDriverType */
    int accessmode; /* enum virDomainFSAccessMode */
877
    int wrpolicy; /* enum virDomainFSWrpolicy */
878
    int format; /* virStorageFileFormat */
879
    unsigned long long usage; /* in bytes */
880
    virStorageSourcePtr src;
881
    char *dst;
882
    bool readonly;
883
    virDomainDeviceInfo info;
884 885
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
886
    bool symlinksResolved;
887
    virDomainVirtioOptionsPtr virtio;
888 889 890
};


891
/* network config types */
892
typedef enum {
893 894
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
M
Michele Paolino 已提交
895
    VIR_DOMAIN_NET_TYPE_VHOSTUSER,
896 897 898 899 900
    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 已提交
901
    VIR_DOMAIN_NET_TYPE_INTERNAL,
902
    VIR_DOMAIN_NET_TYPE_DIRECT,
903
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
904
    VIR_DOMAIN_NET_TYPE_UDP,
905

906
    VIR_DOMAIN_NET_TYPE_LAST
907
} virDomainNetType;
908

909
/* the backend driver used for virtio interfaces */
910
typedef enum {
911 912 913 914
    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 */

915
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
916
} virDomainNetBackendType;
917

918
/* the TX algorithm used for virtio interfaces */
919
typedef enum {
920 921 922 923
    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,

924
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
925
} virDomainNetVirtioTxModeType;
926

927
/* link interface states */
928
typedef enum {
929 930 931 932 933
        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
934
} virDomainNetInterfaceLinkState;
935

936 937 938 939 940 941 942 943 944 945 946 947
/* 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;
948
            int macTableManager; /* enum virNetworkBridgeMACTableManagerType */
949 950 951 952 953
        } bridge;
        struct {
            char *linkdev;
            int mode; /* enum virMacvtapMode from util/macvtap.h */
        } direct;
954 955 956
        struct {
            virDomainHostdevDef def;
        } hostdev;
957
    } data;
958
    virNetDevVPortProfilePtr virtPortProfile;
959
    virNetDevBandwidthPtr bandwidth;
960
    virNetDevVlan vlan;
961
    int trustGuestRxFilters; /* enum virTristateBool */
962
    unsigned int class_id; /* class ID for bandwidth 'floor' */
963 964
};

965 966
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
967
    virDomainNetType type;
968
    virMacAddr mac;
969
    char *model;
970 971
    union {
        struct {
972 973
            virDomainNetBackendType name; /* which driver backend to use */
            virDomainNetVirtioTxModeType txmode;
J
Ján Tomko 已提交
974 975
            virTristateSwitch ioeventfd;
            virTristateSwitch event_idx;
976
            unsigned int queues; /* Multiqueue virtio-net */
977
            unsigned int rx_queue_size;
978
            unsigned int tx_queue_size;
979 980 981 982 983 984 985
            struct {
                virTristateSwitch csum;
                virTristateSwitch gso;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
986
                virTristateSwitch mrg_rxbuf;
987 988 989 990 991 992 993 994
            } host;
            struct {
                virTristateSwitch csum;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
            } guest;
995 996
        } virtio;
    } driver;
997 998 999 1000
    struct {
        char *tap;
        char *vhost;
    } backend;
1001
    union {
M
Michele Paolino 已提交
1002
        virDomainChrSourceDefPtr vhostuser;
1003 1004 1005
        struct {
            char *address;
            int port;
1006 1007
            char *localaddr;
            int localport;
1008 1009 1010
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
            char *portgroup;
            /* actual has info about the currently used physical
             * device (if the network is of type
             * bridge/private/vepa/passthrough). This is saved in the
             * domain state, but never written to persistent config,
             * since it needs to be re-allocated whenever the domain
             * is restarted. It is also never shown to the user, and
             * the user cannot specify it in XML documents.
             */
            virDomainActualNetDefPtr actual;
1021 1022 1023 1024
        } network;
        struct {
            char *brname;
        } bridge;
D
Daniel Veillard 已提交
1025 1026 1027
        struct {
            char *name;
        } internal;
1028 1029
        struct {
            char *linkdev;
1030
            int mode; /* enum virMacvtapMode from util/macvtap.h */
1031
        } direct;
1032 1033 1034
        struct {
            virDomainHostdevDef def;
        } hostdev;
1035
    } data;
1036 1037
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
1038 1039 1040 1041
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
1042
    char *script;
1043
    char *domain_name; /* backend domain name */
1044 1045
    char *ifname; /* interface name on the host (<target dev='x'/>) */
    virNetDevIPInfo hostIP;
1046
    char *ifname_guest_actual;
1047 1048
    char *ifname_guest;
    virNetDevIPInfo guestIP;
1049
    virDomainDeviceInfo info;
1050 1051
    char *filter;
    virNWFilterHashTablePtr filterparams;
1052
    virNetDevBandwidthPtr bandwidth;
1053
    virNetDevVlan vlan;
1054
    int trustGuestRxFilters; /* enum virTristateBool */
1055
    int linkstate;
1056
    unsigned int mtu;
1057
    virNetDevCoalescePtr coalesce;
1058
    virDomainVirtioOptionsPtr virtio;
1059 1060
};

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
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)

1071
typedef enum {
1072
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
1073 1074
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
1075
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
1076

1077
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
1078
} virDomainChrDeviceType;
1079

1080
typedef enum {
1081 1082
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA,
G
Guannan Ren 已提交
1083
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,
M
Michal Privoznik 已提交
1084
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_PCI,
1085
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SPAPR_VIO,
1086
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SYSTEM,
1087
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP,
G
Guannan Ren 已提交
1088 1089

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
1090
} virDomainChrSerialTargetType;
G
Guannan Ren 已提交
1091

1092
typedef enum {
1093 1094
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
1095
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,
J
Joao Martins 已提交
1096
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_XEN,
1097

1098
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
1099
} virDomainChrChannelTargetType;
1100

1101
typedef enum {
1102 1103
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
1104 1105
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
1106
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
1107 1108
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
1109 1110
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
1111

1112
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
1113
} virDomainChrConsoleTargetType;
1114

1115 1116 1117 1118 1119
typedef enum {
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_NONE = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_ISA_SERIAL,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_USB_SERIAL,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_PCI_SERIAL,
1120
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SPAPR_VTY,
1121
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_PL011,
1122 1123
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPCONSOLE,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPLMCONSOLE,
1124 1125 1126 1127 1128 1129

    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_LAST
} virDomainChrSerialTargetModel;

VIR_ENUM_DECL(virDomainChrSerialTargetModel);

1130
typedef enum {
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    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,
1141
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
1142
    VIR_DOMAIN_CHR_TYPE_SPICEPORT,
1143
    VIR_DOMAIN_CHR_TYPE_NMDM,
1144

1145
    VIR_DOMAIN_CHR_TYPE_LAST
1146
} virDomainChrType;
1147

1148
typedef enum {
1149
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW = 0,
1150
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1151 1152
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1153

1154
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1155
} virDomainChrTcpProtocol;
1156

1157
typedef enum {
E
Eric Blake 已提交
1158 1159
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1160
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1161

1162
    VIR_DOMAIN_CHR_SPICEVMC_LAST
1163
} virDomainChrSpicevmcName;
E
Eric Blake 已提交
1164

1165 1166 1167 1168 1169 1170 1171 1172 1173

struct _virDomainChrSourceReconnectDef {
    virTristateBool enabled;
    unsigned int timeout;
};
typedef struct _virDomainChrSourceReconnectDef virDomainChrSourceReconnectDef;
typedef virDomainChrSourceReconnectDef *virDomainChrSourceReconnectDefPtr;


1174 1175 1176
/* The host side information for a character device.  */
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
1177
    virObjectPtr privateData;
1178
    union {
E
Eric Blake 已提交
1179
        /* no <source> for null, vc, stdio */
1180 1181
        struct {
            char *path;
1182
            int append; /* enum virTristateSwitch */
1183
        } file; /* pty, file, pipe, or device */
1184 1185 1186 1187
        struct {
            char *master;
            char *slave;
        } nmdm;
1188 1189 1190
        struct {
            char *host;
            char *service;
1191
            bool listen;
1192
            int protocol;
1193
            bool tlscreds;
1194
            int haveTLS; /* enum virTristateBool */
1195
            bool tlsFromConfig;
1196
            virDomainChrSourceReconnectDef reconnect;
1197 1198 1199 1200 1201 1202 1203 1204 1205
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
1206
            bool listen;
1207
            virDomainChrSourceReconnectDef reconnect;
1208
        } nix;
E
Eric Blake 已提交
1209
        int spicevmc;
1210 1211 1212
        struct {
            char *channel;
        } spiceport;
1213
    } data;
1214 1215
    char *logfile;
    int logappend;
1216 1217 1218

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1219 1220 1221 1222
};

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

1225 1226 1227
    int targetType; /* enum virDomainChrConsoleTargetType ||
                       enum virDomainChrChannelTargetType ||
                       enum virDomainChrSerialTargetType according to deviceType */
1228
    int targetModel; /* enum virDomainChrSerialTargetModel */
1229

1230 1231 1232 1233 1234 1235
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

1236 1237
    virDomainChrDeviceState state;

1238
    virDomainChrSourceDefPtr source;
1239 1240

    virDomainDeviceInfo info;
1241 1242
};

1243
typedef enum {
E
Eric Blake 已提交
1244 1245 1246 1247
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1248
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
1249
} virDomainSmartcardType;
E
Eric Blake 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261

# 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' */
1262
        virDomainChrSourceDefPtr passthru; /* 'passthrough' */
E
Eric Blake 已提交
1263 1264 1265 1266 1267
    } data;

    virDomainDeviceInfo info;
};

M
Marc-André Lureau 已提交
1268 1269 1270 1271 1272
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1273
typedef enum {
1274 1275 1276
    VIR_DOMAIN_TPM_MODEL_TIS,

    VIR_DOMAIN_TPM_MODEL_LAST
1277
} virDomainTPMModel;
1278

1279
typedef enum {
1280 1281 1282
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,

    VIR_DOMAIN_TPM_TYPE_LAST
1283
} virDomainTPMBackendType;
1284 1285 1286 1287

# define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"

struct _virDomainTPMDef {
1288
    virDomainTPMBackendType type;
1289
    virDomainDeviceInfo info;
1290
    virDomainTPMModel model;
1291 1292 1293 1294 1295 1296 1297
    union {
        struct {
            virDomainChrSourceDef source;
        } passthrough;
    } data;
};

1298
typedef enum {
1299 1300
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,
L
Li Zhang 已提交
1301
    VIR_DOMAIN_INPUT_TYPE_KBD,
1302
    VIR_DOMAIN_INPUT_TYPE_PASSTHROUGH,
1303

1304
    VIR_DOMAIN_INPUT_TYPE_LAST
1305
} virDomainInputType;
1306

1307
typedef enum {
1308 1309 1310
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,
1311
    VIR_DOMAIN_INPUT_BUS_PARALLELS, /* pseudo device for VNC in containers */
1312
    VIR_DOMAIN_INPUT_BUS_VIRTIO,
1313 1314

    VIR_DOMAIN_INPUT_BUS_LAST
1315
} virDomainInputBus;
1316 1317 1318 1319

struct _virDomainInputDef {
    int type;
    int bus;
1320 1321 1322
    struct {
        char *evdev;
    } source;
1323
    virDomainDeviceInfo info;
1324
    virDomainVirtioOptionsPtr virtio;
1325 1326
};

1327
typedef enum {
1328 1329 1330 1331
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
1332
} virDomainSoundCodecType;
1333

1334
typedef enum {
1335 1336 1337
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1338
    VIR_DOMAIN_SOUND_MODEL_AC97,
1339
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1340
    VIR_DOMAIN_SOUND_MODEL_ICH9,
1341
    VIR_DOMAIN_SOUND_MODEL_USB,
1342 1343

    VIR_DOMAIN_SOUND_MODEL_LAST
1344
} virDomainSoundModel;
1345

1346 1347 1348 1349 1350
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1351 1352
struct _virDomainSoundDef {
    int model;
1353
    virDomainDeviceInfo info;
1354

1355
    size_t ncodecs;
1356
    virDomainSoundCodecDefPtr *codecs;
1357 1358
};

1359
typedef enum {
R
Richard Jones 已提交
1360 1361
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,
1362
    VIR_DOMAIN_WATCHDOG_MODEL_DIAG288,
R
Richard Jones 已提交
1363 1364

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
1365
} virDomainWatchdogModel;
R
Richard Jones 已提交
1366

1367
typedef enum {
R
Richard Jones 已提交
1368 1369 1370 1371
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
1372
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1373
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,
1374
    VIR_DOMAIN_WATCHDOG_ACTION_INJECTNMI,
R
Richard Jones 已提交
1375 1376

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
1377
} virDomainWatchdogAction;
R
Richard Jones 已提交
1378 1379 1380 1381

struct _virDomainWatchdogDef {
    int model;
    int action;
1382
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1383 1384
};

1385

1386
typedef enum {
1387
    VIR_DOMAIN_VIDEO_TYPE_DEFAULT,
1388 1389 1390 1391 1392
    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,
1393
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1394
    VIR_DOMAIN_VIDEO_TYPE_PARALLELS, /* pseudo device for VNC in containers */
M
Marc-André Lureau 已提交
1395
    VIR_DOMAIN_VIDEO_TYPE_VIRTIO,
F
Fabian Freyer 已提交
1396
    VIR_DOMAIN_VIDEO_TYPE_GOP,
1397 1398

    VIR_DOMAIN_VIDEO_TYPE_LAST
1399
} virDomainVideoType;
1400 1401


1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
typedef enum {
    VIR_DOMAIN_VIDEO_VGACONF_IO = 0,
    VIR_DOMAIN_VIDEO_VGACONF_ON,
    VIR_DOMAIN_VIDEO_VGACONF_OFF,

    VIR_DOMAIN_VIDEO_VGACONF_LAST
} virDomainVideoVGAConf;

VIR_ENUM_DECL(virDomainVideoVGAConf)

1412 1413 1414
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1415 1416
    int accel2d; /* enum virTristateBool */
    int accel3d; /* enum virTristateBool */
1417 1418 1419
};


1420 1421 1422 1423 1424 1425
typedef struct _virDomainVideoDriverDef virDomainVideoDriverDef;
typedef virDomainVideoDriverDef *virDomainVideoDriverDefPtr;
struct _virDomainVideoDriverDef {
   virDomainVideoVGAConf vgaconf;
};

1426 1427
struct _virDomainVideoDef {
    int type;
1428 1429
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1430
    unsigned int vram64; /* kibibytes (multiples of 1024) */
1431
    unsigned int vgamem; /* kibibytes (multiples of 1024) */
1432
    unsigned int heads;
1433
    bool primary;
1434
    virDomainVideoAccelDefPtr accel;
1435
    virDomainVideoDriverDefPtr driver;
1436
    virDomainDeviceInfo info;
J
Ján Tomko 已提交
1437
    virDomainVirtioOptionsPtr virtio;
1438 1439
};

1440
/* graphics console modes */
1441
typedef enum {
1442 1443
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1444 1445
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1446
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1447

1448
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1449
} virDomainGraphicsType;
1450

1451
typedef enum {
1452 1453 1454 1455 1456 1457
    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
1458
} virDomainGraphicsVNCSharePolicy;
1459

1460
typedef enum {
1461 1462 1463 1464 1465 1466
    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
1467
} virDomainGraphicsAuthConnectedType;
1468

1469 1470 1471 1472
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
1473
    bool expires; /* Whether there is an expiry time set */
1474
    time_t validTo;  /* seconds since epoch */
1475
    int connected; /* action if connected */
1476 1477
};

1478
typedef enum {
1479 1480 1481 1482 1483 1484
    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 已提交
1485
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1486
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1487 1488

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
1489
} virDomainGraphicsSpiceChannelName;
1490

1491
typedef enum {
1492 1493 1494 1495 1496
    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
1497
} virDomainGraphicsSpiceChannelMode;
1498

1499
typedef enum {
1500 1501 1502 1503 1504 1505 1506 1507 1508
    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
1509
} virDomainGraphicsSpiceImageCompression;
1510

1511
typedef enum {
1512 1513 1514 1515 1516 1517
    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
1518
} virDomainGraphicsSpiceJpegCompression;
1519

1520
typedef enum {
1521 1522 1523 1524 1525 1526
    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
1527
} virDomainGraphicsSpiceZlibCompression;
1528

1529
typedef enum {
P
Peng Zhou 已提交
1530 1531 1532 1533 1534
    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
1535
} virDomainGraphicsSpiceMouseMode;
P
Peng Zhou 已提交
1536

1537
typedef enum {
1538 1539 1540 1541 1542 1543
    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
1544
} virDomainGraphicsSpiceStreamingMode;
1545

1546
typedef enum {
1547 1548 1549
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,
1550
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_SOCKET,
1551

1552
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1553
} virDomainGraphicsListenType;
1554

1555
typedef enum {
M
Marc-André Lureau 已提交
1556 1557
    VIR_DOMAIN_HUB_TYPE_USB,

1558
    VIR_DOMAIN_HUB_TYPE_LAST
1559
} virDomainHubType;
M
Marc-André Lureau 已提交
1560

1561 1562 1563
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
1564
    virDomainGraphicsListenType type;
1565 1566
    char *address;
    char *network;
1567
    char *socket;
1568
    bool fromConfig;    /* true if the @address is config file originated */
1569
    bool autoGenerated;
1570 1571
};

1572
struct _virDomainGraphicsDef {
M
Michal Privoznik 已提交
1573 1574 1575 1576 1577
    /* 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.
     */
1578
    virDomainGraphicsType type;
1579 1580 1581
    union {
        struct {
            int port;
1582
            bool portReserved;
M
Martin Kletzander 已提交
1583
            int websocket;
1584
            bool websocketGenerated;
1585
            bool autoport;
1586
            char *keymap;
1587
            virDomainGraphicsAuthDef auth;
1588
            int sharePolicy;
1589 1590 1591 1592
        } vnc;
        struct {
            char *display;
            char *xauth;
1593
            bool fullscreen;
1594
        } sdl;
1595 1596
        struct {
            int port;
1597 1598 1599
            bool autoport;
            bool replaceUser;
            bool multiUser;
1600 1601 1602
        } rdp;
        struct {
            char *display;
1603
            bool fullscreen;
1604
        } desktop;
1605 1606 1607
        struct {
            int port;
            int tlsPort;
1608 1609
            bool portReserved;
            bool tlsPortReserved;
1610
            virDomainGraphicsSpiceMouseMode mousemode;
1611
            char *keymap;
1612
            virDomainGraphicsAuthDef auth;
1613
            bool autoport;
1614
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1615
            virDomainGraphicsSpiceChannelMode defaultMode;
1616 1617 1618 1619
            int image;
            int jpeg;
            int zlib;
            int playback;
1620
            int streaming;
1621 1622 1623
            virTristateBool copypaste;
            virTristateBool filetransfer;
            virTristateBool gl;
1624
            char *rendernode;
1625
        } spice;
1626
    } data;
1627 1628 1629 1630 1631
    /* 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;
1632 1633
};

1634
typedef enum {
1635 1636 1637
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
1638
} virDomainRedirdevBus;
1639 1640 1641 1642

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

1643
    virDomainChrSourceDefPtr source;
1644 1645 1646

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

1648
struct _virDomainRedirFilterUSBDevDef {
1649 1650 1651 1652
    int usbClass;
    int vendor;
    int product;
    int version;
1653
    bool allow;
1654 1655 1656 1657
};

struct _virDomainRedirFilterDef {
    size_t nusbdevs;
1658
    virDomainRedirFilterUSBDevDefPtr *usbdevs;
1659 1660
};

1661
typedef enum {
1662 1663
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1664
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1665 1666

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
1667
} virDomainMemballoonModel;
1668 1669 1670 1671

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
1672
    int period; /* seconds between collections */
1673
    int autodeflate; /* enum virTristateSwitch */
1674
    virDomainVirtioOptionsPtr virtio;
1675 1676
};

L
Li Zhang 已提交
1677 1678 1679
struct _virDomainNVRAMDef {
    virDomainDeviceInfo info;
};
1680

1681 1682
typedef enum {
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM,
1683 1684
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_PLAIN,
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_DOORBELL,
1685 1686 1687 1688

    VIR_DOMAIN_SHMEM_MODEL_LAST
} virDomainShmemModel;

1689 1690 1691
struct _virDomainShmemDef {
    char *name;
    unsigned long long size;
1692
    int model; /* enum virDomainShmemModel */
1693 1694
    struct {
        bool enabled;
1695
        virDomainChrSourceDef chr;
1696 1697 1698 1699 1700 1701 1702 1703 1704
    } server;
    struct {
        bool enabled;
        unsigned vectors;
        virTristateSwitch ioeventfd;
    } msi;
    virDomainDeviceInfo info;
};

1705
typedef enum {
1706
    VIR_DOMAIN_SMBIOS_NONE = 0,
1707 1708 1709 1710 1711
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
1712
} virDomainSmbiosMode;
1713

1714

1715
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1716

1717
typedef enum {
1718 1719 1720 1721 1722
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1723
    VIR_DOMAIN_BOOT_LAST
1724
} virDomainBootOrder;
1725

1726
typedef enum {
1727 1728 1729
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1730
    VIR_DOMAIN_FEATURE_HAP,
1731
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1732
    VIR_DOMAIN_FEATURE_PRIVNET,
1733
    VIR_DOMAIN_FEATURE_HYPERV,
1734
    VIR_DOMAIN_FEATURE_KVM,
1735
    VIR_DOMAIN_FEATURE_PVSPINLOCK,
1736
    VIR_DOMAIN_FEATURE_CAPABILITIES,
1737
    VIR_DOMAIN_FEATURE_PMU,
1738
    VIR_DOMAIN_FEATURE_VMPORT,
M
Michal Privoznik 已提交
1739
    VIR_DOMAIN_FEATURE_GIC,
M
Michal Privoznik 已提交
1740
    VIR_DOMAIN_FEATURE_SMM,
1741
    VIR_DOMAIN_FEATURE_IOAPIC,
1742
    VIR_DOMAIN_FEATURE_HPT,
M
Marc-André Lureau 已提交
1743
    VIR_DOMAIN_FEATURE_VMCOREINFO,
1744 1745

    VIR_DOMAIN_FEATURE_LAST
1746
} virDomainFeature;
1747

1748 1749
# define VIR_DOMAIN_HYPERV_VENDOR_ID_MAX 12

1750
typedef enum {
1751
    VIR_DOMAIN_HYPERV_RELAXED = 0,
1752 1753
    VIR_DOMAIN_HYPERV_VAPIC,
    VIR_DOMAIN_HYPERV_SPINLOCKS,
1754 1755 1756 1757 1758 1759
    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,
1760 1761

    VIR_DOMAIN_HYPERV_LAST
1762
} virDomainHyperv;
1763

1764 1765 1766 1767 1768 1769
typedef enum {
    VIR_DOMAIN_KVM_HIDDEN = 0,

    VIR_DOMAIN_KVM_LAST
} virDomainKVM;

1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
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;

1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
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 已提交
1832 1833 1834
typedef struct _virDomainBIOSDef virDomainBIOSDef;
typedef virDomainBIOSDef *virDomainBIOSDefPtr;
struct _virDomainBIOSDef {
J
Ján Tomko 已提交
1835
    int useserial; /* enum virTristateBool */
1836 1837 1838
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1839 1840
};

1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
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;
1856
    int secure;     /* enum virTristateBool */
1857
    char *nvram;    /* path to non-volatile RAM */
1858
    char *templt;   /* user override of path to master nvram */
1859 1860 1861 1862
};

void virDomainLoaderDefFree(virDomainLoaderDefPtr loader);

1863 1864 1865 1866 1867 1868 1869 1870 1871
typedef enum {
    VIR_DOMAIN_IOAPIC_QEMU = 0,
    VIR_DOMAIN_IOAPIC_KVM,

    VIR_DOMAIN_IOAPIC_LAST
} virDomainIOAPIC;

VIR_ENUM_DECL(virDomainIOAPIC);

1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
typedef enum {
    VIR_DOMAIN_HPT_RESIZING_ENABLED = 0,
    VIR_DOMAIN_HPT_RESIZING_DISABLED,
    VIR_DOMAIN_HPT_RESIZING_REQUIRED,

    VIR_DOMAIN_HPT_RESIZING_LAST
} virDomainHPTResizing;

VIR_ENUM_DECL(virDomainHPTResizing);

1882
/* Operating system configuration data & machine / arch */
1883 1884 1885 1886 1887 1888 1889
typedef struct _virDomainOSEnv virDomainOSEnv;
typedef virDomainOSEnv *virDomainOSEnvPtr;
struct _virDomainOSEnv {
    char *name;
    char *value;
};

1890 1891 1892
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
1893
    int type;
1894
    virArch arch;
1895
    char *machine;
1896
    size_t nBootDevs;
1897
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
J
Ján Tomko 已提交
1898
    int bootmenu; /* enum virTristateBool */
1899 1900
    unsigned int bm_timeout;
    bool bm_timeout_set;
1901
    char *init;
1902
    char **initargv;
1903
    virDomainOSEnvPtr *initenv;
1904
    char *initdir;
1905 1906
    char *inituser;
    char *initgroup;
1907 1908 1909
    char *kernel;
    char *initrd;
    char *cmdline;
1910
    char *dtb;
1911
    char *root;
J
Ján Tomko 已提交
1912
    char *slic_table;
1913
    virDomainLoaderDefPtr loader;
1914 1915
    char *bootloader;
    char *bootloaderArgs;
1916
    int smbios_mode;
1917

M
Michal Privoznik 已提交
1918
    virDomainBIOSDef bios;
1919 1920
};

1921
typedef enum {
1922 1923 1924 1925 1926
    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 已提交
1927
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1928
    VIR_DOMAIN_TIMER_NAME_HYPERVCLOCK,
1929

1930
    VIR_DOMAIN_TIMER_NAME_LAST
1931
} virDomainTimerNameType;
1932

1933
typedef enum {
1934 1935 1936
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1937

1938
    VIR_DOMAIN_TIMER_TRACK_LAST
1939
} virDomainTimerTrackType;
1940

1941
typedef enum {
1942 1943 1944 1945 1946
    VIR_DOMAIN_TIMER_TICKPOLICY_DELAY = 0,
    VIR_DOMAIN_TIMER_TICKPOLICY_CATCHUP,
    VIR_DOMAIN_TIMER_TICKPOLICY_MERGE,
    VIR_DOMAIN_TIMER_TICKPOLICY_DISCARD,

1947
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1948
} virDomainTimerTickpolicyType;
1949

1950
typedef enum {
1951 1952 1953 1954
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1955
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1956

1957
    VIR_DOMAIN_TIMER_MODE_LAST
1958
} virDomainTimerModeType;
1959

1960
typedef enum {
1961
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1962 1963
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1964
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
1965
} virDomainCpuPlacementMode;
O
Osier Yang 已提交
1966

1967 1968 1969
typedef struct _virDomainThreadSchedParam virDomainThreadSchedParam;
typedef virDomainThreadSchedParam *virDomainThreadSchedParamPtr;
struct _virDomainThreadSchedParam {
1970
    virProcessSchedPolicy policy;
1971 1972 1973
    int priority;
};

1974 1975 1976 1977 1978 1979 1980 1981
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1982 1983 1984 1985 1986 1987 1988
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 */

1989 1990 1991 1992
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
1993 1994 1995 1996 1997 1998

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

1999
typedef enum {
2000 2001
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
2002
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
2003
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
2004

2005
    VIR_DOMAIN_CLOCK_OFFSET_LAST
2006
} virDomainClockOffsetType;
2007

2008
typedef enum {
2009 2010 2011
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

2012
    VIR_DOMAIN_CLOCK_BASIS_LAST
2013
} virDomainClockBasis;
2014

2015 2016 2017 2018
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
2019

2020
    union {
2021 2022 2023
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
2024
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
2025 2026 2027
        struct {
            long long adjustment;
            int basis;
2028 2029 2030 2031 2032 2033 2034

            /* 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;
2035
        } variable;
2036 2037 2038 2039 2040

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

2042
    size_t ntimers;
2043
    virDomainTimerDefPtr *timers;
2044 2045
};

2046

2047 2048 2049
typedef struct _virBlkioDevice virBlkioDevice;
typedef virBlkioDevice *virBlkioDevicePtr;
struct _virBlkioDevice {
2050 2051
    char *path;
    unsigned int weight;
2052 2053 2054 2055
    unsigned int riops;
    unsigned int wiops;
    unsigned long long rbps;
    unsigned long long wbps;
2056 2057
};

2058
typedef enum {
2059 2060 2061
    VIR_DOMAIN_RNG_MODEL_VIRTIO,

    VIR_DOMAIN_RNG_MODEL_LAST
2062
} virDomainRNGModel;
2063

2064
typedef enum {
2065 2066 2067 2068 2069
    VIR_DOMAIN_RNG_BACKEND_RANDOM,
    VIR_DOMAIN_RNG_BACKEND_EGD,
    /* VIR_DOMAIN_RNG_BACKEND_POOL, */

    VIR_DOMAIN_RNG_BACKEND_LAST
2070
} virDomainRNGBackend;
2071 2072 2073 2074

struct _virDomainRNGDef {
    int model;
    int backend;
2075 2076
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
2077 2078 2079 2080 2081 2082 2083 2084

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

    virDomainDeviceInfo info;
2085
    virDomainVirtioOptionsPtr virtio;
2086 2087
};

2088 2089 2090
typedef enum {
    VIR_DOMAIN_MEMORY_MODEL_NONE,
    VIR_DOMAIN_MEMORY_MODEL_DIMM, /* dimm hotpluggable memory device */
M
Michal Privoznik 已提交
2091
    VIR_DOMAIN_MEMORY_MODEL_NVDIMM, /* nvdimm memory device */
2092 2093 2094 2095 2096

    VIR_DOMAIN_MEMORY_MODEL_LAST
} virDomainMemoryModel;

struct _virDomainMemoryDef {
2097 2098
    virDomainMemoryAccess access;

2099 2100 2101
    /* source */
    virBitmapPtr sourceNodes;
    unsigned long long pagesize; /* kibibytes */
M
Michal Privoznik 已提交
2102
    char *nvdimmPath;
2103 2104 2105

    /* target */
    int model; /* virDomainMemoryModel */
2106
    int targetNode;
2107
    unsigned long long size; /* kibibytes */
2108
    unsigned long long labelsize; /* kibibytes; valid only for NVDIMM */
2109 2110 2111 2112 2113 2114

    virDomainDeviceInfo info;
};

void virDomainMemoryDefFree(virDomainMemoryDefPtr def);

2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129
struct _virDomainIdMapEntry {
    unsigned int start;
    unsigned int target;
    unsigned int count;
};

struct _virDomainIdMapDef {
    size_t nuidmap;
    virDomainIdMapEntryPtr uidmap;

    size_t ngidmap;
    virDomainIdMapEntryPtr gidmap;
};


2130 2131 2132 2133 2134
typedef enum {
    VIR_DOMAIN_PANIC_MODEL_DEFAULT,
    VIR_DOMAIN_PANIC_MODEL_ISA,
    VIR_DOMAIN_PANIC_MODEL_PSERIES,
    VIR_DOMAIN_PANIC_MODEL_HYPERV,
2135
    VIR_DOMAIN_PANIC_MODEL_S390,
2136 2137 2138 2139

    VIR_DOMAIN_PANIC_MODEL_LAST
} virDomainPanicModel;

H
Hu Tao 已提交
2140
struct _virDomainPanicDef {
2141
    int model; /* virDomainPanicModel */
H
Hu Tao 已提交
2142 2143 2144 2145
    virDomainDeviceInfo info;
};


2146
void virBlkioDeviceArrayClear(virBlkioDevicePtr deviceWeights,
2147
                              int ndevices);
2148

2149 2150 2151 2152 2153
typedef struct _virDomainResourceDef virDomainResourceDef;
typedef virDomainResourceDef *virDomainResourceDefPtr;
struct _virDomainResourceDef {
    char *partition;
};
2154

2155
typedef struct _virDomainHugePage virDomainHugePage;
2156 2157
typedef virDomainHugePage *virDomainHugePagePtr;

2158
struct _virDomainHugePage {
2159 2160 2161 2162
    virBitmapPtr nodemask;      /* guest's NUMA node mask */
    unsigned long long size;    /* hugepage size in KiB */
};

2163 2164
# define VIR_DOMAIN_CPUMASK_LEN 1024

2165 2166 2167 2168 2169 2170
typedef struct _virDomainIOThreadIDDef virDomainIOThreadIDDef;
typedef virDomainIOThreadIDDef *virDomainIOThreadIDDefPtr;

struct _virDomainIOThreadIDDef {
    bool autofill;
    unsigned int iothread_id;
2171
    int thread_id;
2172
    virBitmapPtr cpumask;
2173 2174

    virDomainThreadSchedParam sched;
2175 2176 2177 2178
};

void virDomainIOThreadIDDefFree(virDomainIOThreadIDDefPtr def);

2179

2180 2181 2182 2183
typedef struct _virDomainCputune virDomainCputune;
typedef virDomainCputune *virDomainCputunePtr;

struct _virDomainCputune {
2184
    unsigned long long shares;
2185 2186 2187
    bool sharesSpecified;
    unsigned long long period;
    long long quota;
2188
    unsigned long long global_period;
2189
    long long global_quota;
2190 2191
    unsigned long long emulator_period;
    long long emulator_quota;
2192 2193
    unsigned long long iothread_period;
    long long iothread_quota;
2194
    virBitmapPtr emulatorpin;
2195 2196
};

2197

2198 2199 2200 2201 2202 2203 2204 2205 2206
typedef struct _virDomainCachetuneDef virDomainCachetuneDef;
typedef virDomainCachetuneDef *virDomainCachetuneDefPtr;

struct _virDomainCachetuneDef {
    virBitmapPtr vcpus;
    virResctrlAllocPtr alloc;
};


2207 2208
typedef struct _virDomainVcpuDef virDomainVcpuDef;
typedef virDomainVcpuDef *virDomainVcpuDefPtr;
2209

2210
struct _virDomainVcpuDef {
2211
    bool online;
2212 2213 2214
    virTristateBool hotpluggable;
    unsigned int order;

2215
    virBitmapPtr cpumask;
2216 2217

    virDomainThreadSchedParam sched;
2218 2219

    virObjectPtr privateData;
2220 2221
};

2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235
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 {
2236 2237 2238
    /* total memory size including memory modules in kibibytes, this field
     * should be accessed only via accessors */
    unsigned long long total_memory;
2239 2240
    unsigned long long cur_balloon; /* in kibibytes, capped at ulong thanks
                                       to virDomainGetInfo */
2241 2242 2243 2244

    virDomainHugePagePtr hugepages;
    size_t nhugepages;

2245 2246 2247 2248
    /* 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 */

2249 2250 2251
    bool nosharepages;
    bool locked;
    int dump_core; /* enum virTristateSwitch */
2252 2253 2254 2255
    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 */
2256 2257 2258 2259

    int source; /* enum virDomainMemorySource */
    int access; /* enum virDomainMemoryAccess */
    int allocation; /* enum virDomainMemoryAllocation */
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
};

typedef struct _virDomainPowerManagement virDomainPowerManagement;
typedef virDomainPowerManagement *virDomainPowerManagementPtr;

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

Q
Qiaowei Ren 已提交
2271 2272 2273 2274 2275 2276 2277
typedef struct _virDomainPerfDef virDomainPerfDef;
typedef virDomainPerfDef *virDomainPerfDefPtr;
struct _virDomainPerfDef {
    /* These options are of type enum virTristateBool */
    int events[VIR_PERF_EVENT_LAST];
};

2278 2279 2280 2281 2282 2283 2284
typedef struct _virDomainKeyWrapDef virDomainKeyWrapDef;
typedef virDomainKeyWrapDef *virDomainKeyWrapDefPtr;
struct _virDomainKeyWrapDef {
    int aes; /* enum virTristateSwitch */
    int dea; /* enum virTristateSwitch */
};

J
Ján Tomko 已提交
2285 2286 2287 2288 2289 2290 2291 2292
typedef enum {
    VIR_DOMAIN_IOMMU_MODEL_INTEL,

    VIR_DOMAIN_IOMMU_MODEL_LAST
} virDomainIOMMUModel;

struct _virDomainIOMMUDef {
    virDomainIOMMUModel model;
2293
    virTristateSwitch intremap;
2294
    virTristateSwitch caching_mode;
2295
    virTristateSwitch eim;
J
Ján Tomko 已提交
2296
    virTristateSwitch iotlb;
J
Ján Tomko 已提交
2297
};
2298 2299 2300 2301 2302 2303

struct _virDomainVirtioOptions {
    virTristateSwitch iommu;
    virTristateSwitch ats;
};

2304 2305 2306 2307 2308 2309
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
2310 2311
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
2312
struct _virDomainDef {
2313
    virDomainVirtType virtType;
2314 2315 2316
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
2317
    char *title;
2318
    char *description;
2319

2320 2321
    virDomainBlkiotune blkio;
    virDomainMemtune mem;
2322

2323
    virDomainVcpuDefPtr *vcpus;
2324
    size_t maxvcpus;
2325 2326
    /* set if the vcpu definition was specified individually */
    bool individualvcpus;
O
Osier Yang 已提交
2327
    int placement_mode;
H
Hu Tao 已提交
2328
    virBitmapPtr cpumask;
2329

2330 2331
    size_t niothreadids;
    virDomainIOThreadIDDefPtr *iothreadids;
2332

2333
    virDomainCputune cputune;
2334

2335 2336 2337
    virDomainCachetuneDefPtr *cachetunes;
    size_t ncachetunes;

2338
    virDomainNumaPtr numa;
2339
    virDomainResourceDefPtr resource;
2340
    virDomainIdMapDef idmap;
2341

2342 2343 2344 2345 2346
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

2347 2348
    int onLockFailure; /* enum virDomainLockFailureAction */

2349
    virDomainPowerManagement pm;
2350

2351
    virDomainPerfDef perf;
Q
Qiaowei Ren 已提交
2352

2353 2354
    virDomainOSDef os;
    char *emulator;
2355 2356 2357
    /* These three options are of type virTristateSwitch,
     * except VIR_DOMAIN_FEATURE_CAPABILITIES that is of type
     * virDomainCapabilitiesPolicy */
2358
    int features[VIR_DOMAIN_FEATURE_LAST];
2359
    int apic_eoi;
2360
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
2361
    int kvm_features[VIR_DOMAIN_KVM_LAST];
2362
    unsigned int hyperv_spinlocks;
2363
    virGICVersion gic_version;
2364
    char *hyperv_vendor_id;
2365
    virDomainIOAPIC ioapic;
2366
    virDomainHPTResizing hpt_resizing;
2367

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

2371
    virDomainClockDef clock;
2372

2373
    size_t ngraphics;
2374
    virDomainGraphicsDefPtr *graphics;
2375

2376
    size_t ndisks;
2377 2378
    virDomainDiskDefPtr *disks;

2379
    size_t ncontrollers;
2380 2381
    virDomainControllerDefPtr *controllers;

2382
    size_t nfss;
2383 2384
    virDomainFSDefPtr *fss;

2385
    size_t nnets;
2386 2387
    virDomainNetDefPtr *nets;

2388
    size_t ninputs;
2389 2390
    virDomainInputDefPtr *inputs;

2391
    size_t nsounds;
2392 2393
    virDomainSoundDefPtr *sounds;

2394
    size_t nvideos;
2395 2396
    virDomainVideoDefPtr *videos;

2397
    size_t nhostdevs;
2398 2399
    virDomainHostdevDefPtr *hostdevs;

2400
    size_t nredirdevs;
2401 2402
    virDomainRedirdevDefPtr *redirdevs;

2403
    size_t nsmartcards;
E
Eric Blake 已提交
2404 2405
    virDomainSmartcardDefPtr *smartcards;

2406
    size_t nserials;
2407 2408
    virDomainChrDefPtr *serials;

2409
    size_t nparallels;
2410 2411
    virDomainChrDefPtr *parallels;

2412
    size_t nchannels;
2413 2414
    virDomainChrDefPtr *channels;

2415
    size_t nconsoles;
2416 2417
    virDomainChrDefPtr *consoles;

2418
    size_t nleases;
2419 2420
    virDomainLeaseDefPtr *leases;

2421
    size_t nhubs;
M
Marc-André Lureau 已提交
2422 2423
    virDomainHubDefPtr *hubs;

2424 2425 2426
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

2427 2428 2429
    size_t nrngs;
    virDomainRNGDefPtr *rngs;

2430 2431 2432
    size_t nshmems;
    virDomainShmemDefPtr *shmems;

2433 2434 2435
    size_t nmems;
    virDomainMemoryDefPtr *mems;

D
Dmitry Andreev 已提交
2436 2437 2438
    size_t npanics;
    virDomainPanicDefPtr *panics;

2439
    /* Only 1 */
R
Richard Jones 已提交
2440
    virDomainWatchdogDefPtr watchdog;
2441
    virDomainMemballoonDefPtr memballoon;
L
Li Zhang 已提交
2442
    virDomainNVRAMDefPtr nvram;
2443
    virDomainTPMDefPtr tpm;
2444
    virCPUDefPtr cpu;
2445
    virSysinfoDefPtr sysinfo;
2446
    virDomainRedirFilterDefPtr redirfilter;
J
Ján Tomko 已提交
2447
    virDomainIOMMUDefPtr iommu;
2448 2449 2450

    void *namespaceData;
    virDomainXMLNamespace ns;
2451

2452 2453
    virDomainKeyWrapDefPtr keywrap;

2454 2455
    /* Application-specific custom metadata */
    xmlNodePtr metadata;
2456 2457 2458 2459 2460 2461

    /* internal fields */
    bool postParseFailed; /* set to true if one of the custom post parse
                             callbacks failed for a non-critical reason
                             (was not able to fill in some data) and thus
                             should be re-run before starting */
2462 2463
};

2464

2465
unsigned long long virDomainDefGetMemoryInitial(const virDomainDef *def);
2466
void virDomainDefSetMemoryTotal(virDomainDefPtr def, unsigned long long size);
2467
unsigned long long virDomainDefGetMemoryTotal(const virDomainDef *def);
2468
bool virDomainDefHasMemoryHotplug(const virDomainDef *def);
2469

2470 2471 2472 2473 2474 2475 2476
typedef enum {
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_AES,
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_DEA,

    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_LAST
} virDomainKeyWrapCipherName;

2477
typedef enum {
2478 2479 2480 2481 2482
    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 */
2483
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
2484
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
2485
    VIR_DOMAIN_TAINT_HOOK,             /* Domain (possibly) changed via hook script */
2486
    VIR_DOMAIN_TAINT_CDROM_PASSTHROUGH,/* CDROM passthrough */
Y
Yuri Chornoivan 已提交
2487
    VIR_DOMAIN_TAINT_CUSTOM_DTB,       /* Custom device tree blob was specified */
2488
    VIR_DOMAIN_TAINT_CUSTOM_GA_COMMAND, /* Custom guest agent command */
2489 2490

    VIR_DOMAIN_TAINT_LAST
2491
} virDomainTaintFlags;
2492

2493
/* Guest VM runtime state */
J
Jiri Denemark 已提交
2494 2495 2496 2497 2498 2499
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

2500 2501 2502
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
2503
    virObjectLockable parent;
2504
    virCond cond;
2505

2506
    pid_t pid;
J
Jiri Denemark 已提交
2507
    virDomainStateReason state;
2508 2509 2510

    unsigned int autostart : 1;
    unsigned int persistent : 1;
2511
    unsigned int updated : 1;
2512
    unsigned int removing : 1;
2513 2514 2515

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

2517
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
2518 2519
    virDomainSnapshotObjPtr current_snapshot;

2520 2521
    bool hasManagedSave;

2522 2523
    void *privateData;
    void (*privateDataFreeFunc)(void *);
2524 2525

    int taint;
2526 2527 2528

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

2531 2532
typedef bool (*virDomainObjListACLFilter)(virConnectPtr conn,
                                          virDomainDefPtr def);
2533

2534

2535 2536
/* NB: Any new flag to this list be considered to be set in
 * virt-aa-helper code if the flag prevents parsing. */
2537 2538
typedef enum {
    VIR_DOMAIN_DEF_FEATURE_WIDE_SCSI = (1 << 0),
2539
    VIR_DOMAIN_DEF_FEATURE_MEMORY_HOTPLUG = (1 << 1),
2540
    VIR_DOMAIN_DEF_FEATURE_OFFLINE_VCPUPIN = (1 << 2),
2541
    VIR_DOMAIN_DEF_FEATURE_NAME_SLASH = (1 << 3),
2542
    VIR_DOMAIN_DEF_FEATURE_INDIVIDUAL_VCPUS = (1 << 4),
2543
    VIR_DOMAIN_DEF_FEATURE_USER_ALIAS = (1 << 5),
2544 2545 2546
} virDomainDefFeatures;


2547 2548
/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
2549 2550
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
2551

2552 2553 2554 2555 2556 2557 2558 2559 2560

/* Called after everything else has been parsed, for adjusting basics.
 * This has similar semantics to virDomainDefPostParseCallback, but no
 * parseOpaque is used. This callback is run prior to
 * virDomainDefPostParseCallback. */
typedef int (*virDomainDefPostParseBasicCallback)(virDomainDefPtr def,
                                                  virCapsPtr caps,
                                                  void *opaque);

2561
/* Called once after everything else has been parsed, for adjusting
2562 2563 2564
 * overall domain defaults.
 * @parseOpaque is opaque data passed by virDomainDefParse* caller,
 * @opaque is opaque data set by driver (usually pointer to driver
2565 2566 2567 2568
 * private data). Non-fatal failures should be reported by returning 1. In
 * cases when that is allowed, such failure is translated to a success return
 * value and the failure is noted in def->postParseFailed. Drivers should then
 * re-run the post parse callback when attempting to use such definition. */
2569 2570
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
                                             virCapsPtr caps,
2571
                                             unsigned int parseFlags,
2572 2573
                                             void *opaque,
                                             void *parseOpaque);
2574
/* Called once per device, for adjusting per-device settings while
2575 2576 2577 2578
 * leaving the overall domain otherwise unchanged.
 * @parseOpaque is opaque data passed by virDomainDefParse* caller,
 * @opaque is opaque data set by driver (usually pointer to driver
 * private data). */
2579
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
2580
                                                   const virDomainDef *def,
2581
                                                   virCapsPtr caps,
2582
                                                   unsigned int parseFlags,
2583 2584
                                                   void *opaque,
                                                   void *parseOpaque);
2585
/* Drive callback for assigning device addresses, called at the end
2586 2587 2588 2589
 * of parsing, after all defaults and implicit devices have been added.
 * @parseOpaque is opaque data passed by virDomainDefParse* caller,
 * @opaque is opaque data set by driver (usually pointer to driver
 * private data). */
2590 2591 2592
typedef int (*virDomainDefAssignAddressesCallback)(virDomainDef *def,
                                                   virCapsPtr caps,
                                                   unsigned int parseFlags,
2593 2594
                                                   void *opaque,
                                                   void *parseOpaque);
2595

2596 2597 2598 2599 2600 2601 2602
typedef int (*virDomainDefPostParseDataAlloc)(const virDomainDef *def,
                                              virCapsPtr caps,
                                              unsigned int parseFlags,
                                              void *opaque,
                                              void **parseOpaque);
typedef void (*virDomainDefPostParseDataFree)(void *parseOpaque);

2603 2604 2605 2606 2607 2608
/* 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);
2609

2610 2611 2612 2613 2614 2615
/* 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);

2616 2617 2618
typedef struct _virDomainDefParserConfig virDomainDefParserConfig;
typedef virDomainDefParserConfig *virDomainDefParserConfigPtr;
struct _virDomainDefParserConfig {
2619
    /* driver domain definition callbacks */
2620
    virDomainDefPostParseBasicCallback domainPostParseBasicCallback;
2621
    virDomainDefPostParseDataAlloc domainPostParseDataAlloc;
2622 2623
    virDomainDefPostParseCallback domainPostParseCallback;
    virDomainDeviceDefPostParseCallback devicesPostParseCallback;
2624
    virDomainDefAssignAddressesCallback assignAddressesCallback;
2625
    virDomainDefPostParseDataFree domainPostParseDataFree;
2626

2627 2628
    /* validation callbacks */
    virDomainDefValidateCallback domainValidateCallback;
2629
    virDomainDeviceDefValidateCallback deviceValidateCallback;
2630

2631
    /* private data for the callbacks */
2632 2633
    void *priv;
    virFreeCallback privFree;
2634 2635

    /* data */
2636
    unsigned int features; /* virDomainDefFeatures */
2637
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2638 2639
};

2640
typedef void *(*virDomainXMLPrivateDataAllocFunc)(void *);
2641 2642 2643 2644 2645 2646 2647 2648
typedef void (*virDomainXMLPrivateDataFreeFunc)(void *);
typedef virObjectPtr (*virDomainXMLPrivateDataNewFunc)(void);
typedef int (*virDomainXMLPrivateDataFormatFunc)(virBufferPtr,
                                                 virDomainObjPtr);
typedef int (*virDomainXMLPrivateDataParseFunc)(xmlXPathContextPtr,
                                                virDomainObjPtr,
                                                virDomainDefParserConfigPtr);

2649 2650 2651 2652 2653 2654
typedef int (*virDomainXMLPrivateDataStorageSourceParseFunc)(xmlXPathContextPtr ctxt,
                                                             virStorageSourcePtr src);
typedef int (*virDomainXMLPrivateDataStorageSourceFormatFunc)(virStorageSourcePtr src,
                                                              virBufferPtr buf);


2655 2656 2657 2658 2659
typedef struct _virDomainXMLPrivateDataCallbacks virDomainXMLPrivateDataCallbacks;
typedef virDomainXMLPrivateDataCallbacks *virDomainXMLPrivateDataCallbacksPtr;
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
2660 2661
    /* note that private data for devices are not copied when using
     * virDomainDefCopy and similar functions */
2662
    virDomainXMLPrivateDataNewFunc    diskNew;
2663
    virDomainXMLPrivateDataNewFunc    vcpuNew;
2664
    virDomainXMLPrivateDataNewFunc    chrSourceNew;
2665 2666
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
2667 2668
    virDomainXMLPrivateDataStorageSourceParseFunc storageParse;
    virDomainXMLPrivateDataStorageSourceFormatFunc storageFormat;
2669 2670
};

2671 2672 2673 2674 2675 2676 2677 2678 2679
typedef bool (*virDomainABIStabilityDomain)(const virDomainDef *src,
                                            const virDomainDef *dst);

typedef struct _virDomainABIStability virDomainABIStability;
typedef virDomainABIStability *virDomainABIStabilityPtr;
struct _virDomainABIStability {
    virDomainABIStabilityDomain domain;
};

2680 2681
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
2682
                                            virDomainXMLNamespacePtr xmlns,
2683 2684 2685 2686 2687
                                            virDomainABIStabilityPtr abi,
                                            virSaveCookieCallbacksPtr saveCookie);

virSaveCookieCallbacksPtr
virDomainXMLOptionGetSaveCookie(virDomainXMLOptionPtr xmlopt);
2688

2689 2690
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2691
virDomainXMLNamespacePtr
2692
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2693 2694
    ATTRIBUTE_NONNULL(1);

2695 2696 2697 2698 2699
int virDomainDefPostParse(virDomainDefPtr def,
                          virCapsPtr caps,
                          unsigned int parseFlags,
                          virDomainXMLOptionPtr xmlopt,
                          void *parseOpaque);
2700

2701 2702 2703 2704
int virDomainDeviceValidateAliasForHotplug(virDomainObjPtr vm,
                                           virDomainDeviceDefPtr dev,
                                           unsigned int flags);

2705 2706
bool virDomainDeviceAliasIsUserAlias(const char *aliasStr);

2707
int virDomainDefValidate(virDomainDefPtr def,
2708 2709 2710 2711
                         virCapsPtr caps,
                         unsigned int parseFlags,
                         virDomainXMLOptionPtr xmlopt);

2712
static inline bool
D
Daniel P. Berrange 已提交
2713
virDomainObjIsActive(virDomainObjPtr dom)
2714 2715 2716 2717
{
    return dom->def->id != -1;
}

2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
int virDomainDefSetVcpusMax(virDomainDefPtr def,
                            unsigned int vcpus,
                            virDomainXMLOptionPtr xmlopt);
bool virDomainDefHasVcpusOffline(const virDomainDef *def);
unsigned int virDomainDefGetVcpusMax(const virDomainDef *def);
int virDomainDefSetVcpus(virDomainDefPtr def, unsigned int vcpus);
unsigned int virDomainDefGetVcpus(const virDomainDef *def);
virBitmapPtr virDomainDefGetOnlineVcpumap(const virDomainDef *def);
virDomainVcpuDefPtr virDomainDefGetVcpu(virDomainDefPtr def, unsigned int vcpu)
    ATTRIBUTE_RETURN_CHECK;
2728
void virDomainDefVcpuOrderClear(virDomainDefPtr def);
P
Peter Krempa 已提交
2729 2730
int  virDomainDefGetVcpusTopology(const virDomainDef *def,
                                  unsigned int *maxvcpus);
2731

2732
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2733
    ATTRIBUTE_NONNULL(1);
2734

M
Michal Privoznik 已提交
2735 2736
void virDomainObjEndAPI(virDomainObjPtr *vm);

2737
bool virDomainObjTaint(virDomainObjPtr obj,
2738
                       virDomainTaintFlags taint);
2739

2740 2741 2742 2743
void virDomainObjBroadcast(virDomainObjPtr vm);
int virDomainObjWait(virDomainObjPtr vm);
int virDomainObjWaitUntil(virDomainObjPtr vm,
                          unsigned long long whenms);
2744

H
Hu Tao 已提交
2745
void virDomainPanicDefFree(virDomainPanicDefPtr panic);
2746
void virDomainResourceDefFree(virDomainResourceDefPtr resource);
2747
void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
J
Ján Tomko 已提交
2748
const char *virDomainInputDefGetPath(virDomainInputDefPtr input);
2749
void virDomainInputDefFree(virDomainInputDefPtr def);
2750
virDomainDiskDefPtr virDomainDiskDefNew(virDomainXMLOptionPtr xmlopt);
2751
void virDomainDiskDefFree(virDomainDiskDefPtr def);
2752
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2753 2754
int virDomainDiskGetType(virDomainDiskDefPtr def);
void virDomainDiskSetType(virDomainDiskDefPtr def, int type);
2755
const char *virDomainDiskGetSource(virDomainDiskDef const *def);
2756 2757
int virDomainDiskSetSource(virDomainDiskDefPtr def, const char *src)
    ATTRIBUTE_RETURN_CHECK;
2758
void virDomainDiskEmptySource(virDomainDiskDefPtr def);
2759 2760 2761 2762 2763
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);
2764 2765 2766
virDomainControllerDefPtr
virDomainDeviceFindSCSIController(const virDomainDef *def,
                                  virDomainDeviceInfoPtr info);
2767 2768 2769
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2770 2771

virDomainControllerDefPtr virDomainControllerDefNew(virDomainControllerType type);
2772
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2773
bool virDomainControllerIsPSeriesPHB(const virDomainControllerDef *cont);
2774

2775
virDomainFSDefPtr virDomainFSDefNew(void);
2776
void virDomainFSDefFree(virDomainFSDefPtr def);
2777
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
2778
void virDomainNetDefClear(virDomainNetDefPtr def);
2779
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2780
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2781
void virDomainChrDefFree(virDomainChrDefPtr def);
2782
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
2783 2784
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr src,
                              virDomainChrSourceDefPtr dest);
2785
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
2786
void virDomainSoundDefFree(virDomainSoundDefPtr def);
2787
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
L
Li Zhang 已提交
2788
void virDomainNVRAMDefFree(virDomainNVRAMDefPtr def);
R
Richard Jones 已提交
2789
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
C
Cole Robinson 已提交
2790
virDomainVideoDefPtr virDomainVideoDefNew(void);
2791
void virDomainVideoDefFree(virDomainVideoDefPtr def);
J
John Ferlan 已提交
2792
virDomainHostdevDefPtr virDomainHostdevDefNew(void);
2793
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2794
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2795
void virDomainHubDefFree(virDomainHubDefPtr def);
2796
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
2797
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
2798
void virDomainShmemDefFree(virDomainShmemDefPtr def);
2799
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
2800
virDomainDeviceDefPtr virDomainDeviceDefCopy(virDomainDeviceDefPtr src,
2801
                                             const virDomainDef *def,
2802 2803
                                             virCapsPtr caps,
                                             virDomainXMLOptionPtr xmlopt);
2804 2805
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
2806
virDomainDeviceInfoPtr virDomainDeviceGetInfo(virDomainDeviceDefPtr device);
2807
void virDomainTPMDefFree(virDomainTPMDefPtr def);
2808

2809
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2810 2811
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2812 2813 2814 2815 2816 2817
                                           void *opaque);

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

2818 2819 2820 2821
bool virDomainDefHasDeviceAddress(virDomainDefPtr def,
                                  virDomainDeviceInfoPtr info)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;

2822 2823
void virDomainDefFree(virDomainDefPtr vm);

2824
virDomainChrDefPtr virDomainChrDefNew(virDomainXMLOptionPtr xmlopt);
M
Michal Novotny 已提交
2825

2826 2827 2828 2829
virDomainDefPtr virDomainDefNew(void);
virDomainDefPtr virDomainDefNewFull(const char *name,
                                    const unsigned char *uuid,
                                    int id);
2830

2831
void virDomainObjAssignDef(virDomainObjPtr domain,
2832
                           virDomainDefPtr def,
2833 2834
                           bool live,
                           virDomainDefPtr *oldDef);
2835
int virDomainObjSetDefTransient(virCapsPtr caps,
2836
                                virDomainXMLOptionPtr xmlopt,
2837
                                virDomainObjPtr domain);
2838
void virDomainObjRemoveTransientDef(virDomainObjPtr domain);
2839 2840
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
2841
                             virDomainXMLOptionPtr xmlopt,
2842
                             virDomainObjPtr domain);
2843 2844 2845 2846 2847 2848 2849 2850

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

int virDomainObjGetDefs(virDomainObjPtr vm,
                        unsigned int flags,
                        virDomainDefPtr *liveDef,
                        virDomainDefPtr *persDef);
2851 2852 2853
virDomainDefPtr virDomainObjGetOneDefState(virDomainObjPtr vm,
                                           unsigned int flags,
                                           bool *state);
2854
virDomainDefPtr virDomainObjGetOneDef(virDomainObjPtr vm, unsigned int flags);
2855

2856 2857 2858
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virCapsPtr caps,
                                 virDomainXMLOptionPtr xmlopt,
2859
                                 void *parseOpaque,
2860 2861 2862 2863
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt);
2864

2865 2866 2867
typedef enum {
    /* parse internal domain status information */
    VIR_DOMAIN_DEF_PARSE_STATUS          = 1 << 0,
2868 2869 2870 2871
    /* 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. */
2872 2873 2874 2875 2876
    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,
2877
    /* internal flag passed to device info sub-parser to allow using <rom> */
2878
    VIR_DOMAIN_DEF_PARSE_ALLOW_ROM       = 1 << 4,
2879
    /* internal flag passed to device info sub-parser to allow specifying boot order */
2880 2881
    VIR_DOMAIN_DEF_PARSE_ALLOW_BOOT      = 1 << 5,
    /* parse only source half of <disk> */
2882
    VIR_DOMAIN_DEF_PARSE_DISK_SOURCE     = 1 << 6,
2883
    /* perform RNG schema validation on the passed XML document */
2884
    VIR_DOMAIN_DEF_PARSE_VALIDATE_SCHEMA = 1 << 7,
2885
    /* don't validate os.type and arch against capabilities. Prevents
2886
     * VMs from disappearing when qemu is removed and libvirtd is restarted */
2887
    VIR_DOMAIN_DEF_PARSE_SKIP_OSTYPE_CHECKS = 1 << 8,
2888 2889
    /* allow updates in post parse callback that would break ABI otherwise */
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE = 1 << 9,
2890 2891
    /* skip definition validation checks meant to be executed on define time only */
    VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE = 1 << 10,
2892 2893
    /* skip parsing of security labels */
    VIR_DOMAIN_DEF_PARSE_SKIP_SECLABEL        = 1 << 11,
2894 2895 2896 2897
    /* Allows updates in post parse callback for incoming persistent migration
     * that would break ABI otherwise.  This should be used only if it's safe
     * to do such change. */
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE_MIGRATION = 1 << 12,
2898 2899 2900 2901 2902
    /* Allows to ignore certain failures in the post parse callbacks, which
     * may happen due to missing packages and can be fixed by re-running the
     * post parse callbacks before starting. Failure of the post parse callback
     * is recorded as def->postParseFail */
    VIR_DOMAIN_DEF_PARSE_ALLOW_POST_PARSE_FAIL = 1 << 13,
2903 2904 2905 2906 2907
} virDomainDefParseFlags;

typedef enum {
    VIR_DOMAIN_DEF_FORMAT_SECURE          = 1 << 0,
    VIR_DOMAIN_DEF_FORMAT_INACTIVE        = 1 << 1,
2908
    VIR_DOMAIN_DEF_FORMAT_MIGRATABLE      = 1 << 2,
2909
    /* format internal domain status information */
2910
    VIR_DOMAIN_DEF_FORMAT_STATUS          = 1 << 3,
2911
    /* format <actual> element */
2912
    VIR_DOMAIN_DEF_FORMAT_ACTUAL_NET      = 1 << 4,
2913
    /* format original states of host PCI device */
2914 2915 2916 2917
    VIR_DOMAIN_DEF_FORMAT_PCI_ORIG_STATES = 1 << 5,
    VIR_DOMAIN_DEF_FORMAT_ALLOW_ROM       = 1 << 6,
    VIR_DOMAIN_DEF_FORMAT_ALLOW_BOOT      = 1 << 7,
    VIR_DOMAIN_DEF_FORMAT_CLOCK_ADJUST    = 1 << 8,
2918 2919
} virDomainDefFormatFlags;

2920 2921 2922 2923 2924 2925 2926 2927 2928
/* Use these flags to skip specific domain ABI consistency checks done
 * in virDomainDefCheckABIStabilityFlags.
 */
typedef enum {
    /* Set when domain lock must be released and there exists the possibility
     * that some external action could alter the value, such as cur_balloon. */
    VIR_DOMAIN_DEF_ABI_CHECK_SKIP_VOLATILE = 1 << 0,
} virDomainDefABICheckFlags;

2929
virDomainDeviceDefPtr virDomainDeviceDefParse(const char *xmlStr,
2930
                                              const virDomainDef *def,
2931 2932
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt,
L
Laine Stump 已提交
2933
                                              unsigned int flags);
2934 2935 2936 2937
virStorageSourcePtr virDomainDiskDefSourceParse(const char *xmlStr,
                                                const virDomainDef *def,
                                                virDomainXMLOptionPtr xmlopt,
                                                unsigned int flags);
2938 2939
virDomainDefPtr virDomainDefParseString(const char *xmlStr,
                                        virCapsPtr caps,
2940
                                        virDomainXMLOptionPtr xmlopt,
2941
                                        void *parseOpaque,
L
Laine Stump 已提交
2942
                                        unsigned int flags);
2943 2944
virDomainDefPtr virDomainDefParseFile(const char *filename,
                                      virCapsPtr caps,
2945
                                      virDomainXMLOptionPtr xmlopt,
2946
                                      void *parseOpaque,
L
Laine Stump 已提交
2947
                                      unsigned int flags);
2948
virDomainDefPtr virDomainDefParseNode(xmlDocPtr doc,
2949
                                      xmlNodePtr root,
2950 2951
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
2952
                                      void *parseOpaque,
L
Laine Stump 已提交
2953
                                      unsigned int flags);
2954 2955 2956 2957 2958
virDomainObjPtr virDomainObjParseNode(xmlDocPtr xml,
                                      xmlNodePtr root,
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
2959 2960 2961 2962
virDomainObjPtr virDomainObjParseFile(const char *filename,
                                      virCapsPtr caps,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
2963

2964
bool virDomainDefCheckABIStability(virDomainDefPtr src,
2965 2966
                                   virDomainDefPtr dst,
                                   virDomainXMLOptionPtr xmlopt);
2967

2968 2969
bool virDomainDefCheckABIStabilityFlags(virDomainDefPtr src,
                                        virDomainDefPtr dst,
2970
                                        virDomainXMLOptionPtr xmlopt,
2971 2972
                                        unsigned int flags);

2973
int virDomainDefAddImplicitDevices(virDomainDefPtr def);
2974

2975
virDomainIOThreadIDDefPtr virDomainIOThreadIDFind(const virDomainDef *def,
2976 2977 2978 2979 2980
                                                  unsigned int iothread_id);
virDomainIOThreadIDDefPtr virDomainIOThreadIDAdd(virDomainDefPtr def,
                                                 unsigned int iothread_id);
void virDomainIOThreadIDDel(virDomainDefPtr def, unsigned int iothread_id);

2981 2982
unsigned int virDomainDefFormatConvertXMLFlags(unsigned int flags);

2983
char *virDomainDefFormat(virDomainDefPtr def,
2984
                         virCapsPtr caps,
L
Laine Stump 已提交
2985
                         unsigned int flags);
2986 2987
char *virDomainObjFormat(virDomainXMLOptionPtr xmlopt,
                         virDomainObjPtr obj,
2988
                         virCapsPtr caps,
2989
                         unsigned int flags);
2990
int virDomainDefFormatInternal(virDomainDefPtr def,
2991
                               virCapsPtr caps,
2992
                               unsigned int flags,
2993 2994
                               virBufferPtr buf,
                               virDomainXMLOptionPtr xmlopt);
2995

2996 2997 2998
int virDomainDiskSourceFormat(virBufferPtr buf,
                              virStorageSourcePtr src,
                              int policy,
2999 3000
                              unsigned int flags,
                              virDomainXMLOptionPtr xmlopt);
3001

3002 3003
int virDomainNetDefFormat(virBufferPtr buf,
                          virDomainNetDefPtr def,
3004
                          char *prefix,
3005 3006
                          unsigned int flags);

3007 3008 3009 3010 3011 3012
typedef enum {
    VIR_DOMAIN_DEVICE_ACTION_ATTACH,
    VIR_DOMAIN_DEVICE_ACTION_DETACH,
    VIR_DOMAIN_DEVICE_ACTION_UPDATE,
} virDomainDeviceAction;

3013
int virDomainDefCompatibleDevice(virDomainDefPtr def,
3014
                                 virDomainDeviceDefPtr dev);
3015

3016 3017
void virDomainRNGDefFree(virDomainRNGDefPtr def);

3018
int virDomainDiskIndexByAddress(virDomainDefPtr def,
3019
                                virPCIDeviceAddressPtr pci_controller,
3020 3021
                                unsigned int bus, unsigned int target,
                                unsigned int unit);
3022
virDomainDiskDefPtr virDomainDiskByAddress(virDomainDefPtr def,
3023
                                           virPCIDeviceAddressPtr pci_controller,
3024 3025 3026
                                           unsigned int bus,
                                           unsigned int target,
                                           unsigned int unit);
3027 3028
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
3029 3030 3031
virDomainDiskDefPtr virDomainDiskByName(virDomainDefPtr def,
                                        const char *name,
                                        bool allow_ambiguous);
3032
const char *virDomainDiskPathByName(virDomainDefPtr, const char *name);
3033
int virDomainDiskInsert(virDomainDefPtr def,
3034 3035
                        virDomainDiskDefPtr disk)
    ATTRIBUTE_RETURN_CHECK;
3036 3037
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
3038
int virDomainDiskDefAssignAddress(virDomainXMLOptionPtr xmlopt,
3039 3040
                                  virDomainDiskDefPtr def,
                                  const virDomainDef *vmdef);
3041

3042 3043 3044 3045
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
3046
int virDomainDiskSourceParse(xmlNodePtr node,
3047
                             xmlXPathContextPtr ctxt,
3048
                             virStorageSourcePtr src,
3049 3050
                             unsigned int flags,
                             virDomainXMLOptionPtr xmlopt);
3051

3052 3053
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
3054
virDomainNetDefPtr virDomainNetFindByName(virDomainDefPtr def, const char *ifname);
3055
bool virDomainHasNet(virDomainDefPtr def, virDomainNetDefPtr net);
3056
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
3057
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
3058
void virDomainNetRemoveHostdev(virDomainDefPtr def, virDomainNetDefPtr net);
3059

L
Laine Stump 已提交
3060
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
3061 3062
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
3063 3064 3065
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

3066 3067
virDomainGraphicsListenDefPtr
virDomainGraphicsGetListen(virDomainGraphicsDefPtr def, size_t i);
3068 3069
int virDomainGraphicsListenAppendAddress(virDomainGraphicsDefPtr def,
                                         const char *address)
3070
            ATTRIBUTE_NONNULL(1);
3071 3072 3073
int virDomainGraphicsListenAppendSocket(virDomainGraphicsDefPtr def,
                                        const char *socket)
            ATTRIBUTE_NONNULL(1);
3074

3075
virDomainNetType virDomainNetGetActualType(const virDomainNetDef *iface);
3076
const char *virDomainNetGetActualBridgeName(virDomainNetDefPtr iface);
3077
int virDomainNetGetActualBridgeMACTableManager(virDomainNetDefPtr iface);
3078
const char *virDomainNetGetActualDirectDev(virDomainNetDefPtr iface);
3079
int virDomainNetGetActualDirectMode(virDomainNetDefPtr iface);
3080
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
3081
virNetDevVPortProfilePtr
3082
virDomainNetGetActualVirtPortProfile(virDomainNetDefPtr iface);
3083
virNetDevBandwidthPtr
3084
virDomainNetGetActualBandwidth(virDomainNetDefPtr iface);
3085
virNetDevVlanPtr virDomainNetGetActualVlan(virDomainNetDefPtr iface);
3086
bool virDomainNetGetActualTrustGuestRxFilters(virDomainNetDefPtr iface);
3087
int virDomainNetAppendIPAddress(virDomainNetDefPtr def,
3088 3089 3090
                                const char *address,
                                int family,
                                unsigned int prefix);
3091

3092
int virDomainControllerInsert(virDomainDefPtr def,
3093 3094
                              virDomainControllerDefPtr controller)
    ATTRIBUTE_RETURN_CHECK;
3095 3096
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
3097
int virDomainControllerFind(const virDomainDef *def, int type, int idx);
3098
int virDomainControllerFindByType(virDomainDefPtr def, int type);
3099
int virDomainControllerFindByPCIAddress(virDomainDefPtr def,
3100
                                        virPCIDeviceAddressPtr addr);
3101
int virDomainControllerFindUnusedIndex(virDomainDef const *def, int type);
3102
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
3103
const char *virDomainControllerAliasFind(const virDomainDef *def,
3104 3105
                                         int type, int idx)
    ATTRIBUTE_NONNULL(1);
3106 3107 3108 3109 3110

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
3111 3112
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def)
    ATTRIBUTE_RETURN_CHECK;
3113 3114
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
3115 3116 3117 3118 3119
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
3120

3121
void
3122
virDomainChrGetDomainPtrs(const virDomainDef *vmdef,
3123
                          virDomainChrDeviceType type,
3124 3125 3126
                          const virDomainChrDef ***arrPtr,
                          size_t *cntPtr)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
3127 3128 3129
virDomainChrDefPtr
virDomainChrFind(virDomainDefPtr def,
                 virDomainChrDefPtr target);
3130 3131 3132
bool
virDomainChrEquals(virDomainChrDefPtr src,
                   virDomainChrDefPtr tgt);
3133
int
3134 3135 3136 3137 3138
virDomainChrPreAlloc(virDomainDefPtr vmdef,
                     virDomainChrDefPtr chr);
void
virDomainChrInsertPreAlloced(virDomainDefPtr vmdef,
                             virDomainChrDefPtr chr);
3139 3140 3141 3142
virDomainChrDefPtr
virDomainChrRemove(virDomainDefPtr vmdef,
                   virDomainChrDefPtr chr);

3143 3144 3145
ssize_t virDomainRNGFind(virDomainDefPtr def, virDomainRNGDefPtr rng);
virDomainRNGDefPtr virDomainRNGRemove(virDomainDefPtr def, size_t idx);

3146 3147 3148 3149
ssize_t virDomainRedirdevDefFind(virDomainDefPtr def,
                                 virDomainRedirdevDefPtr redirdev);
virDomainRedirdevDefPtr virDomainRedirdevDefRemove(virDomainDefPtr def, size_t idx);

3150
int virDomainSaveXML(const char *configDir,
3151 3152 3153
                     virDomainDefPtr def,
                     const char *xml);

3154
int virDomainSaveConfig(const char *configDir,
3155
                        virCapsPtr caps,
3156
                        virDomainDefPtr def);
3157
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
3158
                        const char *statusDir,
3159 3160
                        virDomainObjPtr obj,
                        virCapsPtr caps) ATTRIBUTE_RETURN_CHECK;
3161

3162 3163 3164 3165
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

3166
int virDomainDeleteConfig(const char *configDir,
3167
                          const char *autostartDir,
3168 3169
                          virDomainObjPtr dom);

3170
char *virDomainConfigFile(const char *dir,
3171 3172
                          const char *name);

3173 3174 3175 3176
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

3177
virDomainFSDefPtr virDomainGetFilesystemForTarget(virDomainDefPtr def,
3178
                                                  const char *target);
3179
int virDomainFSInsert(virDomainDefPtr def, virDomainFSDefPtr fs);
3180
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
3181 3182
virDomainFSDefPtr virDomainFSRemove(virDomainDefPtr def, size_t i);

3183
int virDomainVideoDefaultType(const virDomainDef *def);
3184 3185
unsigned int virDomainVideoDefaultRAM(const virDomainDef *def,
                                      const virDomainVideoType type);
3186

E
Eric Blake 已提交
3187 3188 3189 3190 3191 3192 3193 3194 3195
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

3196 3197 3198 3199 3200 3201 3202 3203 3204
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

3205 3206 3207 3208 3209
typedef int (*virDomainDiskDefPathIterator)(virDomainDiskDefPtr disk,
                                            const char *path,
                                            size_t depth,
                                            void *opaque);

3210 3211 3212 3213 3214 3215 3216
typedef int (*virDomainUSBDeviceDefIterator)(virDomainDeviceInfoPtr info,
                                             void *opaque);
int virDomainUSBDeviceDefForeach(virDomainDefPtr def,
                                 virDomainUSBDeviceDefIterator iter,
                                 void *opaque,
                                 bool skipHubs);

3217 3218 3219 3220 3221
int virDomainDiskDefForeachPath(virDomainDiskDefPtr disk,
                                bool ignoreOpenFailure,
                                virDomainDiskDefPathIterator iter,
                                void *opaque);

J
Jiri Denemark 已提交
3222 3223 3224 3225 3226 3227 3228
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

3229 3230 3231
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

3232
virSecurityDeviceLabelDefPtr
3233 3234
virDomainChrSourceDefGetSecurityLabelDef(virDomainChrSourceDefPtr def,
                                         const char *model);
3235

3236 3237
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
3238

3239 3240 3241 3242 3243 3244 3245 3246 3247 3248
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;

3249 3250 3251 3252 3253 3254 3255 3256
int virDomainShmemDefInsert(virDomainDefPtr def, virDomainShmemDefPtr shmem)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
bool virDomainShmemDefEquals(virDomainShmemDefPtr src, virDomainShmemDefPtr dst)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
ssize_t virDomainShmemDefFind(virDomainDefPtr def, virDomainShmemDefPtr shmem)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
virDomainShmemDefPtr virDomainShmemDefRemove(virDomainDefPtr def, size_t idx)
    ATTRIBUTE_NONNULL(1);
3257 3258 3259
ssize_t virDomainInputDefFind(const virDomainDef *def,
                              const virDomainInputDef *input)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
3260

3261
VIR_ENUM_DECL(virDomainTaint)
3262 3263 3264
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
VIR_ENUM_DECL(virDomainFeature)
3265 3266
VIR_ENUM_DECL(virDomainCapabilitiesPolicy)
VIR_ENUM_DECL(virDomainCapsFeature)
3267
VIR_ENUM_DECL(virDomainLifecycle)
3268
VIR_ENUM_DECL(virDomainLifecycleAction)
3269
VIR_ENUM_DECL(virDomainDevice)
3270
VIR_ENUM_DECL(virDomainDeviceAddress)
3271
VIR_ENUM_DECL(virDomainDiskDevice)
J
J.B. Joret 已提交
3272
VIR_ENUM_DECL(virDomainDiskGeometryTrans)
3273
VIR_ENUM_DECL(virDomainDiskBus)
3274
VIR_ENUM_DECL(virDomainDiskCache)
3275
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
Matthias Dahl 已提交
3276
VIR_ENUM_DECL(virDomainDiskIo)
3277
VIR_ENUM_DECL(virDomainDeviceSGIO)
3278
VIR_ENUM_DECL(virDomainDiskTray)
O
Osier Yang 已提交
3279
VIR_ENUM_DECL(virDomainDiskDiscard)
3280
VIR_ENUM_DECL(virDomainDiskDetectZeroes)
3281
VIR_ENUM_DECL(virDomainDiskMirrorState)
3282
VIR_ENUM_DECL(virDomainController)
J
Ján Tomko 已提交
3283
VIR_ENUM_DECL(virDomainControllerModelPCI)
3284
VIR_ENUM_DECL(virDomainControllerPCIModelName)
3285
VIR_ENUM_DECL(virDomainControllerModelSCSI)
M
Marc-André Lureau 已提交
3286
VIR_ENUM_DECL(virDomainControllerModelUSB)
3287
VIR_ENUM_DECL(virDomainControllerModelIDE)
3288
VIR_ENUM_DECL(virDomainFS)
3289
VIR_ENUM_DECL(virDomainFSDriver)
3290
VIR_ENUM_DECL(virDomainFSAccessMode)
3291
VIR_ENUM_DECL(virDomainFSWrpolicy)
3292
VIR_ENUM_DECL(virDomainNet)
3293
VIR_ENUM_DECL(virDomainNetBackend)
3294
VIR_ENUM_DECL(virDomainNetVirtioTxMode)
3295
VIR_ENUM_DECL(virDomainNetInterfaceLinkState)
3296
VIR_ENUM_DECL(virDomainChrDevice)
3297
VIR_ENUM_DECL(virDomainChrChannelTarget)
3298
VIR_ENUM_DECL(virDomainChrConsoleTarget)
G
Guannan Ren 已提交
3299
VIR_ENUM_DECL(virDomainChrSerialTarget)
E
Eric Blake 已提交
3300
VIR_ENUM_DECL(virDomainSmartcard)
3301
VIR_ENUM_DECL(virDomainChr)
3302
VIR_ENUM_DECL(virDomainChrTcpProtocol)
E
Eric Blake 已提交
3303
VIR_ENUM_DECL(virDomainChrSpicevmc)
3304
VIR_ENUM_DECL(virDomainSoundCodec)
3305
VIR_ENUM_DECL(virDomainSoundModel)
3306
VIR_ENUM_DECL(virDomainKeyWrapCipherName)
3307
VIR_ENUM_DECL(virDomainMemballoonModel)
3308
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
3309 3310
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
3311
VIR_ENUM_DECL(virDomainPanicModel)
3312
VIR_ENUM_DECL(virDomainVideo)
3313 3314
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
3315
VIR_ENUM_DECL(virDomainHostdevCaps)
M
Marc-André Lureau 已提交
3316
VIR_ENUM_DECL(virDomainHub)
3317
VIR_ENUM_DECL(virDomainRedirdevBus)
3318 3319 3320
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
3321
VIR_ENUM_DECL(virDomainGraphicsListen)
3322
VIR_ENUM_DECL(virDomainGraphicsAuthConnected)
3323 3324
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
3325 3326 3327
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression)
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression)
3328
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode)
P
Peng Zhou 已提交
3329
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode)
3330
VIR_ENUM_DECL(virDomainGraphicsVNCSharePolicy)
3331
VIR_ENUM_DECL(virDomainHyperv)
3332
VIR_ENUM_DECL(virDomainKVM)
3333 3334
VIR_ENUM_DECL(virDomainRNGModel)
VIR_ENUM_DECL(virDomainRNGBackend)
3335 3336
VIR_ENUM_DECL(virDomainTPMModel)
VIR_ENUM_DECL(virDomainTPMBackend)
3337 3338
VIR_ENUM_DECL(virDomainMemoryModel)
VIR_ENUM_DECL(virDomainMemoryBackingModel)
3339 3340
VIR_ENUM_DECL(virDomainMemorySource)
VIR_ENUM_DECL(virDomainMemoryAllocation)
J
Ján Tomko 已提交
3341
VIR_ENUM_DECL(virDomainIOMMUModel)
3342
VIR_ENUM_DECL(virDomainShmemModel)
3343 3344
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
J
Jiri Denemark 已提交
3345 3346 3347 3348 3349 3350 3351
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)
3352
VIR_ENUM_DECL(virDomainPMSuspendedReason)
J
Jiri Denemark 已提交
3353 3354 3355 3356

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

3357
VIR_ENUM_DECL(virDomainSeclabel)
3358
VIR_ENUM_DECL(virDomainClockOffset)
3359
VIR_ENUM_DECL(virDomainClockBasis)
3360

3361
VIR_ENUM_DECL(virDomainTimerName)
3362
VIR_ENUM_DECL(virDomainTimerTrack)
3363 3364
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
3365
VIR_ENUM_DECL(virDomainCpuPlacementMode)
3366

3367
VIR_ENUM_DECL(virDomainStartupPolicy)
3368

3369 3370
virDomainControllerDefPtr
virDomainDefAddController(virDomainDefPtr def, int type, int idx, int model);
3371 3372
int
virDomainDefAddUSBController(virDomainDefPtr def, int idx, int model);
3373 3374 3375 3376 3377
int
virDomainDefMaybeAddController(virDomainDefPtr def,
                               int type,
                               int idx,
                               int model);
3378 3379 3380 3381
int
virDomainDefMaybeAddInput(virDomainDefPtr def,
                          int type,
                          int bus);
3382

3383 3384
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

3385 3386
int virDomainDefFindDevice(virDomainDefPtr def,
                           const char *devAlias,
3387 3388
                           virDomainDeviceDefPtr dev,
                           bool reportError);
3389

3390 3391
const char *virDomainChrSourceDefGetPath(virDomainChrSourceDefPtr chr);

3392 3393
void virDomainChrSourceDefClear(virDomainChrSourceDefPtr def);

3394 3395 3396 3397 3398
char *virDomainObjGetMetadata(virDomainObjPtr vm,
                              int type,
                              const char *uri,
                              unsigned int flags);

3399 3400 3401 3402 3403 3404 3405
int virDomainObjSetMetadata(virDomainObjPtr vm,
                            int type,
                            const char *metadata,
                            const char *key,
                            const char *uri,
                            virCapsPtr caps,
                            virDomainXMLOptionPtr xmlopt,
3406
                            const char *stateDir,
3407 3408 3409
                            const char *configDir,
                            unsigned int flags);

3410 3411 3412 3413 3414 3415 3416 3417
int
virDomainParseMemory(const char *xpath,
                     const char *units_xpath,
                     xmlXPathContextPtr ctxt,
                     unsigned long long *mem,
                     bool required,
                     bool capped);

3418 3419 3420
bool virDomainDefNeedsPlacementAdvice(virDomainDefPtr def)
    ATTRIBUTE_NONNULL(1);

3421 3422
int virDomainDiskDefCheckDuplicateInfo(const virDomainDiskDef *a,
                                       const virDomainDiskDef *b)
3423
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3424

3425 3426 3427 3428 3429 3430 3431 3432
int virDomainDefGetVcpuPinInfoHelper(virDomainDefPtr def,
                                     int maplen,
                                     int ncpumaps,
                                     unsigned char *cpumaps,
                                     int hostcpus,
                                     virBitmapPtr autoCpuset)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;

3433 3434
bool virDomainDefHasMemballoon(const virDomainDef *def) ATTRIBUTE_NONNULL(1);

3435
char *virDomainDefGetShortName(const virDomainDef *def) ATTRIBUTE_NONNULL(1);
M
Martin Kletzander 已提交
3436

3437 3438 3439 3440 3441
int
virDomainGetBlkioParametersAssignFromDef(virDomainDefPtr def,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         int maxparams);
3442

3443 3444 3445
int virDomainDiskSetBlockIOTune(virDomainDiskDefPtr disk,
                                virDomainBlockIoTuneInfo *info);

3446 3447 3448 3449 3450
char *
virDomainGenerateMachineName(const char *drivername,
                             int id,
                             const char *name,
                             bool privileged);
3451 3452 3453

bool
virDomainNetTypeSharesHostView(const virDomainNetDef *net);
3454

3455 3456 3457 3458
bool
virDomainDefLifecycleActionAllowed(virDomainLifecycle type,
                                   virDomainLifecycleAction action);

3459
#endif /* __DOMAIN_CONF_H */