domain_conf.h 117.5 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 {
688
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_DEFAULT = -1,
J
Ján Tomko 已提交
689
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_ROOT,
L
Laine Stump 已提交
690
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT,
J
Ján Tomko 已提交
691
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_BRIDGE,
692
    VIR_DOMAIN_CONTROLLER_MODEL_DMI_TO_PCI_BRIDGE,
693
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT_PORT,
694
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_UPSTREAM_PORT,
695
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_DOWNSTREAM_PORT,
696
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_EXPANDER_BUS,
697
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_EXPANDER_BUS,
J
Ján Tomko 已提交
698 699

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

702
typedef enum {
703
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_NONE = 0,
704 705
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCI_BRIDGE,
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_I82801B11_BRIDGE,
706
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_IOH3420,
707
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_X3130_UPSTREAM,
708
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_XIO3130_DOWNSTREAM,
709
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB,
710
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB_PCIE,
711
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCIE_ROOT_PORT,
712
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_SPAPR_PCI_HOST_BRIDGE,
713 714 715 716

    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_LAST
} virDomainControllerPCIModelName;

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

728
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
729
} virDomainControllerModelSCSI;
730

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

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
749
} virDomainControllerModelUSB;
M
Marc-André Lureau 已提交
750

751
typedef enum {
752
    VIR_DOMAIN_CONTROLLER_MODEL_IDE_DEFAULT = -1,
753 754 755 756 757 758 759
    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;

760 761 762 763 764 765 766
# 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))

767 768 769 770 771 772 773
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

774 775 776
typedef struct _virDomainPCIControllerOpts virDomainPCIControllerOpts;
typedef virDomainPCIControllerOpts *virDomainPCIControllerOptsPtr;
struct _virDomainPCIControllerOpts {
777 778
    bool pcihole64;
    unsigned long pcihole64size;
779 780 781 782 783 784 785

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

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

806 807 808 809 810 811
typedef struct _virDomainUSBControllerOpts virDomainUSBControllerOpts;
typedef virDomainUSBControllerOpts *virDomainUSBControllerOptsPtr;
struct _virDomainUSBControllerOpts {
    int ports;   /* -1 == undef */
};

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


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

    VIR_DOMAIN_FS_TYPE_LAST
843
} virDomainFSType;
844

845
/* Filesystem driver type */
846
typedef enum {
847 848 849
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,
850
    VIR_DOMAIN_FS_DRIVER_TYPE_LOOP,
851
    VIR_DOMAIN_FS_DRIVER_TYPE_NBD,
D
Dmitry Guryanov 已提交
852
    VIR_DOMAIN_FS_DRIVER_TYPE_PLOOP,
853 854

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
855
} virDomainFSDriverType;
856

857
/* Filesystem mount access mode  */
858
typedef enum {
859 860 861 862 863
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
864
} virDomainFSAccessMode;
865

866
/* Filesystem Write policy */
867
typedef enum {
868 869 870 871
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
872
} virDomainFSWrpolicy;
873

874 875 876
/* Allow 2 MB ram usage */
# define VIR_DOMAIN_FS_RAM_DEFAULT_USAGE (1024 * 2)

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


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

910
    VIR_DOMAIN_NET_TYPE_LAST
911
} virDomainNetType;
912

913
/* the backend driver used for virtio interfaces */
914
typedef enum {
915 916 917 918
    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 */

919
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
920
} virDomainNetBackendType;
921

922
/* the TX algorithm used for virtio interfaces */
923
typedef enum {
924 925 926 927
    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,

928
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
929
} virDomainNetVirtioTxModeType;
930

931
/* link interface states */
932
typedef enum {
933 934 935 936 937
        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
938
} virDomainNetInterfaceLinkState;
939

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

969 970
/* Stores the virtual network interface configuration */
struct _virDomainNetDef {
971
    virDomainNetType type;
972
    virMacAddr mac;
973
    bool mac_generated; /* true if mac was *just now* auto-generated by libvirt */
974
    char *model;
975 976
    union {
        struct {
977 978
            virDomainNetBackendType name; /* which driver backend to use */
            virDomainNetVirtioTxModeType txmode;
J
Ján Tomko 已提交
979 980
            virTristateSwitch ioeventfd;
            virTristateSwitch event_idx;
981
            unsigned int queues; /* Multiqueue virtio-net */
982
            unsigned int rx_queue_size;
983
            unsigned int tx_queue_size;
984 985 986 987 988 989 990
            struct {
                virTristateSwitch csum;
                virTristateSwitch gso;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
991
                virTristateSwitch mrg_rxbuf;
992 993 994 995 996 997 998 999
            } host;
            struct {
                virTristateSwitch csum;
                virTristateSwitch tso4;
                virTristateSwitch tso6;
                virTristateSwitch ecn;
                virTristateSwitch ufo;
            } guest;
1000 1001
        } virtio;
    } driver;
1002 1003 1004 1005
    struct {
        char *tap;
        char *vhost;
    } backend;
1006
    union {
M
Michele Paolino 已提交
1007
        virDomainChrSourceDefPtr vhostuser;
1008 1009 1010
        struct {
            char *address;
            int port;
1011 1012
            char *localaddr;
            int localport;
1013 1014 1015
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
            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;
1026 1027 1028 1029
        } network;
        struct {
            char *brname;
        } bridge;
D
Daniel Veillard 已提交
1030 1031 1032
        struct {
            char *name;
        } internal;
1033 1034
        struct {
            char *linkdev;
1035
            int mode; /* enum virMacvtapMode from util/macvtap.h */
1036
        } direct;
1037 1038 1039
        struct {
            virDomainHostdevDef def;
        } hostdev;
1040
    } data;
1041 1042
    /* virtPortProfile is used by network/bridge/direct/hostdev */
    virNetDevVPortProfilePtr virtPortProfile;
1043 1044 1045 1046
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
1047
    char *script;
1048
    char *domain_name; /* backend domain name */
1049 1050
    char *ifname; /* interface name on the host (<target dev='x'/>) */
    virNetDevIPInfo hostIP;
1051
    char *ifname_guest_actual;
1052 1053
    char *ifname_guest;
    virNetDevIPInfo guestIP;
1054
    virDomainDeviceInfo info;
1055 1056
    char *filter;
    virNWFilterHashTablePtr filterparams;
1057
    virNetDevBandwidthPtr bandwidth;
1058
    virNetDevVlan vlan;
1059
    int trustGuestRxFilters; /* enum virTristateBool */
1060
    int linkstate;
1061
    unsigned int mtu;
1062
    virNetDevCoalescePtr coalesce;
1063
    virDomainVirtioOptionsPtr virtio;
1064 1065
};

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
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)

1076
typedef enum {
1077
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
1078 1079
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
1080
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
1081

1082
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
1083
} virDomainChrDeviceType;
1084

1085
typedef enum {
1086 1087
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA,
G
Guannan Ren 已提交
1088
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,
M
Michal Privoznik 已提交
1089
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_PCI,
1090
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SPAPR_VIO,
1091
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SYSTEM,
1092
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP,
G
Guannan Ren 已提交
1093 1094

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
1095
} virDomainChrSerialTargetType;
G
Guannan Ren 已提交
1096

1097
typedef enum {
1098 1099
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
1100
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,
J
Joao Martins 已提交
1101
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_XEN,
1102

1103
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
1104
} virDomainChrChannelTargetType;
1105

1106
typedef enum {
1107 1108
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
1109 1110
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
1111
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
1112 1113
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
1114 1115
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
1116

1117
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
1118
} virDomainChrConsoleTargetType;
1119

1120 1121 1122 1123 1124
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,
1125
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SPAPR_VTY,
1126
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_PL011,
1127 1128
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPCONSOLE,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPLMCONSOLE,
1129 1130 1131 1132 1133 1134

    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_LAST
} virDomainChrSerialTargetModel;

VIR_ENUM_DECL(virDomainChrSerialTargetModel);

1135
typedef enum {
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
    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,
1146
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
1147
    VIR_DOMAIN_CHR_TYPE_SPICEPORT,
1148
    VIR_DOMAIN_CHR_TYPE_NMDM,
1149

1150
    VIR_DOMAIN_CHR_TYPE_LAST
1151
} virDomainChrType;
1152

1153
typedef enum {
1154
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW = 0,
1155
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1156 1157
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1158

1159
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1160
} virDomainChrTcpProtocol;
1161

1162
typedef enum {
E
Eric Blake 已提交
1163 1164
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1165
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1166

1167
    VIR_DOMAIN_CHR_SPICEVMC_LAST
1168
} virDomainChrSpicevmcName;
E
Eric Blake 已提交
1169

1170 1171 1172 1173 1174 1175 1176 1177 1178

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


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

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1224 1225 1226 1227
};

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

1230 1231 1232
    int targetType; /* enum virDomainChrConsoleTargetType ||
                       enum virDomainChrChannelTargetType ||
                       enum virDomainChrSerialTargetType according to deviceType */
1233
    int targetModel; /* enum virDomainChrSerialTargetModel */
1234

1235 1236 1237 1238 1239 1240
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

1241 1242
    virDomainChrDeviceState state;

1243
    virDomainChrSourceDefPtr source;
1244 1245

    virDomainDeviceInfo info;
1246 1247
};

1248
typedef enum {
E
Eric Blake 已提交
1249 1250 1251 1252
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1253
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
1254
} virDomainSmartcardType;
E
Eric Blake 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266

# 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' */
1267
        virDomainChrSourceDefPtr passthru; /* 'passthrough' */
E
Eric Blake 已提交
1268 1269 1270 1271 1272
    } data;

    virDomainDeviceInfo info;
};

M
Marc-André Lureau 已提交
1273 1274 1275 1276 1277
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1278
typedef enum {
1279 1280 1281
    VIR_DOMAIN_TPM_MODEL_TIS,

    VIR_DOMAIN_TPM_MODEL_LAST
1282
} virDomainTPMModel;
1283

1284
typedef enum {
1285 1286 1287
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,

    VIR_DOMAIN_TPM_TYPE_LAST
1288
} virDomainTPMBackendType;
1289 1290 1291 1292

# define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"

struct _virDomainTPMDef {
1293
    virDomainTPMBackendType type;
1294
    virDomainDeviceInfo info;
1295
    virDomainTPMModel model;
1296 1297 1298 1299 1300 1301 1302
    union {
        struct {
            virDomainChrSourceDef source;
        } passthrough;
    } data;
};

1303
typedef enum {
1304 1305
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,
L
Li Zhang 已提交
1306
    VIR_DOMAIN_INPUT_TYPE_KBD,
1307
    VIR_DOMAIN_INPUT_TYPE_PASSTHROUGH,
1308

1309
    VIR_DOMAIN_INPUT_TYPE_LAST
1310
} virDomainInputType;
1311

1312
typedef enum {
1313 1314 1315
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,
1316
    VIR_DOMAIN_INPUT_BUS_PARALLELS, /* pseudo device for VNC in containers */
1317
    VIR_DOMAIN_INPUT_BUS_VIRTIO,
1318 1319

    VIR_DOMAIN_INPUT_BUS_LAST
1320
} virDomainInputBus;
1321 1322 1323 1324

struct _virDomainInputDef {
    int type;
    int bus;
1325 1326 1327
    struct {
        char *evdev;
    } source;
1328
    virDomainDeviceInfo info;
1329
    virDomainVirtioOptionsPtr virtio;
1330 1331
};

1332
typedef enum {
1333 1334 1335 1336
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
1337
} virDomainSoundCodecType;
1338

1339
typedef enum {
1340 1341 1342
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1343
    VIR_DOMAIN_SOUND_MODEL_AC97,
1344
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1345
    VIR_DOMAIN_SOUND_MODEL_ICH9,
1346
    VIR_DOMAIN_SOUND_MODEL_USB,
1347 1348

    VIR_DOMAIN_SOUND_MODEL_LAST
1349
} virDomainSoundModel;
1350

1351 1352 1353 1354 1355
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1356 1357
struct _virDomainSoundDef {
    int model;
1358
    virDomainDeviceInfo info;
1359

1360
    size_t ncodecs;
1361
    virDomainSoundCodecDefPtr *codecs;
1362 1363
};

1364
typedef enum {
R
Richard Jones 已提交
1365 1366
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,
1367
    VIR_DOMAIN_WATCHDOG_MODEL_DIAG288,
R
Richard Jones 已提交
1368 1369

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
1370
} virDomainWatchdogModel;
R
Richard Jones 已提交
1371

1372
typedef enum {
R
Richard Jones 已提交
1373 1374 1375 1376
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
1377
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1378
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,
1379
    VIR_DOMAIN_WATCHDOG_ACTION_INJECTNMI,
R
Richard Jones 已提交
1380 1381

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
1382
} virDomainWatchdogAction;
R
Richard Jones 已提交
1383 1384 1385 1386

struct _virDomainWatchdogDef {
    int model;
    int action;
1387
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1388 1389
};

1390

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

    VIR_DOMAIN_VIDEO_TYPE_LAST
1404
} virDomainVideoType;
1405 1406


1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
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)

1417 1418 1419
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
1420 1421
    int accel2d; /* enum virTristateBool */
    int accel3d; /* enum virTristateBool */
1422 1423 1424
};


1425 1426 1427 1428 1429 1430
typedef struct _virDomainVideoDriverDef virDomainVideoDriverDef;
typedef virDomainVideoDriverDef *virDomainVideoDriverDefPtr;
struct _virDomainVideoDriverDef {
   virDomainVideoVGAConf vgaconf;
};

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

1445
/* graphics console modes */
1446
typedef enum {
1447 1448
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1449 1450
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1451
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1452

1453
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1454
} virDomainGraphicsType;
1455

1456
typedef enum {
1457 1458 1459 1460 1461 1462
    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
1463
} virDomainGraphicsVNCSharePolicy;
1464

1465
typedef enum {
1466 1467 1468 1469 1470 1471
    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
1472
} virDomainGraphicsAuthConnectedType;
1473

1474 1475 1476 1477
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
1478
    bool expires; /* Whether there is an expiry time set */
1479
    time_t validTo;  /* seconds since epoch */
1480
    int connected; /* action if connected */
1481 1482
};

1483
typedef enum {
1484 1485 1486 1487 1488 1489
    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 已提交
1490
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1491
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1492 1493

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
1494
} virDomainGraphicsSpiceChannelName;
1495

1496
typedef enum {
1497 1498 1499 1500 1501
    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
1502
} virDomainGraphicsSpiceChannelMode;
1503

1504
typedef enum {
1505 1506 1507 1508 1509 1510 1511 1512 1513
    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
1514
} virDomainGraphicsSpiceImageCompression;
1515

1516
typedef enum {
1517 1518 1519 1520 1521 1522
    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
1523
} virDomainGraphicsSpiceJpegCompression;
1524

1525
typedef enum {
1526 1527 1528 1529 1530 1531
    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
1532
} virDomainGraphicsSpiceZlibCompression;
1533

1534
typedef enum {
P
Peng Zhou 已提交
1535 1536 1537 1538 1539
    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
1540
} virDomainGraphicsSpiceMouseMode;
P
Peng Zhou 已提交
1541

1542
typedef enum {
1543 1544 1545 1546 1547 1548
    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
1549
} virDomainGraphicsSpiceStreamingMode;
1550

1551
typedef enum {
1552 1553 1554
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,
1555
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_SOCKET,
1556

1557
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1558
} virDomainGraphicsListenType;
1559

1560
typedef enum {
M
Marc-André Lureau 已提交
1561 1562
    VIR_DOMAIN_HUB_TYPE_USB,

1563
    VIR_DOMAIN_HUB_TYPE_LAST
1564
} virDomainHubType;
M
Marc-André Lureau 已提交
1565

1566 1567 1568
typedef struct _virDomainGraphicsListenDef virDomainGraphicsListenDef;
typedef virDomainGraphicsListenDef *virDomainGraphicsListenDefPtr;
struct _virDomainGraphicsListenDef {
1569
    virDomainGraphicsListenType type;
1570 1571
    char *address;
    char *network;
1572
    char *socket;
1573
    bool fromConfig;    /* true if the @address is config file originated */
1574
    bool autoGenerated;
1575 1576
};

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

1639
typedef enum {
1640 1641 1642
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
1643
} virDomainRedirdevBus;
1644 1645 1646 1647

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

1648
    virDomainChrSourceDefPtr source;
1649 1650 1651

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

1653
struct _virDomainRedirFilterUSBDevDef {
1654 1655 1656 1657
    int usbClass;
    int vendor;
    int product;
    int version;
1658
    bool allow;
1659 1660 1661 1662
};

struct _virDomainRedirFilterDef {
    size_t nusbdevs;
1663
    virDomainRedirFilterUSBDevDefPtr *usbdevs;
1664 1665
};

1666
typedef enum {
1667 1668
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1669
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1670 1671

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
1672
} virDomainMemballoonModel;
1673 1674 1675 1676

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
1677
    int period; /* seconds between collections */
1678
    int autodeflate; /* enum virTristateSwitch */
1679
    virDomainVirtioOptionsPtr virtio;
1680 1681
};

L
Li Zhang 已提交
1682 1683 1684
struct _virDomainNVRAMDef {
    virDomainDeviceInfo info;
};
1685

1686 1687
typedef enum {
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM,
1688 1689
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_PLAIN,
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_DOORBELL,
1690 1691 1692 1693

    VIR_DOMAIN_SHMEM_MODEL_LAST
} virDomainShmemModel;

1694 1695 1696
struct _virDomainShmemDef {
    char *name;
    unsigned long long size;
1697
    int model; /* enum virDomainShmemModel */
1698 1699
    struct {
        bool enabled;
1700
        virDomainChrSourceDef chr;
1701 1702 1703 1704 1705 1706 1707 1708 1709
    } server;
    struct {
        bool enabled;
        unsigned vectors;
        virTristateSwitch ioeventfd;
    } msi;
    virDomainDeviceInfo info;
};

1710
typedef enum {
1711
    VIR_DOMAIN_SMBIOS_NONE = 0,
1712 1713 1714 1715 1716
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
1717
} virDomainSmbiosMode;
1718

1719

1720
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
1721

1722
typedef enum {
1723 1724 1725 1726 1727
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1728
    VIR_DOMAIN_BOOT_LAST
1729
} virDomainBootOrder;
1730

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

    VIR_DOMAIN_FEATURE_LAST
1751
} virDomainFeature;
1752

1753 1754
# define VIR_DOMAIN_HYPERV_VENDOR_ID_MAX 12

1755
typedef enum {
1756
    VIR_DOMAIN_HYPERV_RELAXED = 0,
1757 1758
    VIR_DOMAIN_HYPERV_VAPIC,
    VIR_DOMAIN_HYPERV_SPINLOCKS,
1759 1760 1761 1762 1763 1764
    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,
1765 1766

    VIR_DOMAIN_HYPERV_LAST
1767
} virDomainHyperv;
1768

1769 1770 1771 1772 1773 1774
typedef enum {
    VIR_DOMAIN_KVM_HIDDEN = 0,

    VIR_DOMAIN_KVM_LAST
} virDomainKVM;

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 1820 1821 1822 1823 1824
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;

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

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

void virDomainLoaderDefFree(virDomainLoaderDefPtr loader);

1868
typedef enum {
1869 1870
    VIR_DOMAIN_IOAPIC_NONE = 0,
    VIR_DOMAIN_IOAPIC_QEMU,
1871 1872 1873 1874 1875 1876 1877
    VIR_DOMAIN_IOAPIC_KVM,

    VIR_DOMAIN_IOAPIC_LAST
} virDomainIOAPIC;

VIR_ENUM_DECL(virDomainIOAPIC);

1878
typedef enum {
1879 1880
    VIR_DOMAIN_HPT_RESIZING_NONE = 0,
    VIR_DOMAIN_HPT_RESIZING_ENABLED,
1881 1882 1883 1884 1885 1886 1887 1888
    VIR_DOMAIN_HPT_RESIZING_DISABLED,
    VIR_DOMAIN_HPT_RESIZING_REQUIRED,

    VIR_DOMAIN_HPT_RESIZING_LAST
} virDomainHPTResizing;

VIR_ENUM_DECL(virDomainHPTResizing);

1889
/* Operating system configuration data & machine / arch */
1890 1891 1892 1893 1894 1895 1896
typedef struct _virDomainOSEnv virDomainOSEnv;
typedef virDomainOSEnv *virDomainOSEnvPtr;
struct _virDomainOSEnv {
    char *name;
    char *value;
};

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

M
Michal Privoznik 已提交
1925
    virDomainBIOSDef bios;
1926 1927
};

1928
typedef enum {
1929 1930 1931 1932 1933
    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 已提交
1934
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
1935
    VIR_DOMAIN_TIMER_NAME_HYPERVCLOCK,
1936

1937
    VIR_DOMAIN_TIMER_NAME_LAST
1938
} virDomainTimerNameType;
1939

1940
typedef enum {
1941 1942 1943
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
1944

1945
    VIR_DOMAIN_TIMER_TRACK_LAST
1946
} virDomainTimerTrackType;
1947

1948
typedef enum {
1949 1950 1951 1952 1953
    VIR_DOMAIN_TIMER_TICKPOLICY_DELAY = 0,
    VIR_DOMAIN_TIMER_TICKPOLICY_CATCHUP,
    VIR_DOMAIN_TIMER_TICKPOLICY_MERGE,
    VIR_DOMAIN_TIMER_TICKPOLICY_DISCARD,

1954
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
1955
} virDomainTimerTickpolicyType;
1956

1957
typedef enum {
1958 1959 1960 1961
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
1962
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
1963

1964
    VIR_DOMAIN_TIMER_MODE_LAST
1965
} virDomainTimerModeType;
1966

1967
typedef enum {
1968
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
1969 1970
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

1971
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
1972
} virDomainCpuPlacementMode;
O
Osier Yang 已提交
1973

1974 1975 1976
typedef struct _virDomainThreadSchedParam virDomainThreadSchedParam;
typedef virDomainThreadSchedParam *virDomainThreadSchedParamPtr;
struct _virDomainThreadSchedParam {
1977
    virProcessSchedPolicy policy;
1978 1979 1980
    int priority;
};

1981 1982 1983 1984 1985 1986 1987 1988
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

1989 1990 1991 1992 1993 1994 1995
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 */

1996 1997 1998 1999
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
2000 2001 2002 2003 2004 2005

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

2006
typedef enum {
2007 2008
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
2009
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
2010
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
2011

2012
    VIR_DOMAIN_CLOCK_OFFSET_LAST
2013
} virDomainClockOffsetType;
2014

2015
typedef enum {
2016 2017 2018
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

2019
    VIR_DOMAIN_CLOCK_BASIS_LAST
2020
} virDomainClockBasis;
2021

2022 2023 2024 2025
typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
2026

2027
    union {
2028 2029 2030
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
2031
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
2032 2033 2034
        struct {
            long long adjustment;
            int basis;
2035 2036 2037 2038 2039 2040 2041

            /* 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;
2042
        } variable;
2043 2044 2045 2046 2047

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

2049
    size_t ntimers;
2050
    virDomainTimerDefPtr *timers;
2051 2052
};

2053

2054 2055 2056
typedef struct _virBlkioDevice virBlkioDevice;
typedef virBlkioDevice *virBlkioDevicePtr;
struct _virBlkioDevice {
2057 2058
    char *path;
    unsigned int weight;
2059 2060 2061 2062
    unsigned int riops;
    unsigned int wiops;
    unsigned long long rbps;
    unsigned long long wbps;
2063 2064
};

2065
typedef enum {
2066 2067 2068
    VIR_DOMAIN_RNG_MODEL_VIRTIO,

    VIR_DOMAIN_RNG_MODEL_LAST
2069
} virDomainRNGModel;
2070

2071
typedef enum {
2072 2073 2074 2075 2076
    VIR_DOMAIN_RNG_BACKEND_RANDOM,
    VIR_DOMAIN_RNG_BACKEND_EGD,
    /* VIR_DOMAIN_RNG_BACKEND_POOL, */

    VIR_DOMAIN_RNG_BACKEND_LAST
2077
} virDomainRNGBackend;
2078 2079 2080 2081

struct _virDomainRNGDef {
    int model;
    int backend;
2082 2083
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
2084 2085 2086 2087 2088 2089 2090 2091

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

    virDomainDeviceInfo info;
2092
    virDomainVirtioOptionsPtr virtio;
2093 2094
};

2095 2096 2097
typedef enum {
    VIR_DOMAIN_MEMORY_MODEL_NONE,
    VIR_DOMAIN_MEMORY_MODEL_DIMM, /* dimm hotpluggable memory device */
M
Michal Privoznik 已提交
2098
    VIR_DOMAIN_MEMORY_MODEL_NVDIMM, /* nvdimm memory device */
2099 2100 2101 2102 2103

    VIR_DOMAIN_MEMORY_MODEL_LAST
} virDomainMemoryModel;

struct _virDomainMemoryDef {
2104 2105
    virDomainMemoryAccess access;

2106 2107 2108
    /* source */
    virBitmapPtr sourceNodes;
    unsigned long long pagesize; /* kibibytes */
M
Michal Privoznik 已提交
2109
    char *nvdimmPath;
2110 2111 2112

    /* target */
    int model; /* virDomainMemoryModel */
2113
    int targetNode;
2114
    unsigned long long size; /* kibibytes */
2115
    unsigned long long labelsize; /* kibibytes; valid only for NVDIMM */
2116 2117 2118 2119 2120 2121

    virDomainDeviceInfo info;
};

void virDomainMemoryDefFree(virDomainMemoryDefPtr def);

2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
struct _virDomainIdMapEntry {
    unsigned int start;
    unsigned int target;
    unsigned int count;
};

struct _virDomainIdMapDef {
    size_t nuidmap;
    virDomainIdMapEntryPtr uidmap;

    size_t ngidmap;
    virDomainIdMapEntryPtr gidmap;
};


2137 2138 2139 2140 2141
typedef enum {
    VIR_DOMAIN_PANIC_MODEL_DEFAULT,
    VIR_DOMAIN_PANIC_MODEL_ISA,
    VIR_DOMAIN_PANIC_MODEL_PSERIES,
    VIR_DOMAIN_PANIC_MODEL_HYPERV,
2142
    VIR_DOMAIN_PANIC_MODEL_S390,
2143 2144 2145 2146

    VIR_DOMAIN_PANIC_MODEL_LAST
} virDomainPanicModel;

H
Hu Tao 已提交
2147
struct _virDomainPanicDef {
2148
    int model; /* virDomainPanicModel */
H
Hu Tao 已提交
2149 2150 2151 2152
    virDomainDeviceInfo info;
};


2153
void virBlkioDeviceArrayClear(virBlkioDevicePtr deviceWeights,
2154
                              int ndevices);
2155

2156 2157 2158 2159 2160
typedef struct _virDomainResourceDef virDomainResourceDef;
typedef virDomainResourceDef *virDomainResourceDefPtr;
struct _virDomainResourceDef {
    char *partition;
};
2161

2162
typedef struct _virDomainHugePage virDomainHugePage;
2163 2164
typedef virDomainHugePage *virDomainHugePagePtr;

2165
struct _virDomainHugePage {
2166 2167 2168 2169
    virBitmapPtr nodemask;      /* guest's NUMA node mask */
    unsigned long long size;    /* hugepage size in KiB */
};

2170 2171
# define VIR_DOMAIN_CPUMASK_LEN 1024

2172 2173 2174 2175 2176 2177
typedef struct _virDomainIOThreadIDDef virDomainIOThreadIDDef;
typedef virDomainIOThreadIDDef *virDomainIOThreadIDDefPtr;

struct _virDomainIOThreadIDDef {
    bool autofill;
    unsigned int iothread_id;
2178
    int thread_id;
2179
    virBitmapPtr cpumask;
2180 2181

    virDomainThreadSchedParam sched;
2182 2183 2184 2185
};

void virDomainIOThreadIDDefFree(virDomainIOThreadIDDefPtr def);

2186

2187 2188 2189 2190
typedef struct _virDomainCputune virDomainCputune;
typedef virDomainCputune *virDomainCputunePtr;

struct _virDomainCputune {
2191
    unsigned long long shares;
2192 2193 2194
    bool sharesSpecified;
    unsigned long long period;
    long long quota;
2195
    unsigned long long global_period;
2196
    long long global_quota;
2197 2198
    unsigned long long emulator_period;
    long long emulator_quota;
2199 2200
    unsigned long long iothread_period;
    long long iothread_quota;
2201
    virBitmapPtr emulatorpin;
2202 2203
};

2204

2205 2206 2207 2208 2209 2210 2211 2212 2213
typedef struct _virDomainCachetuneDef virDomainCachetuneDef;
typedef virDomainCachetuneDef *virDomainCachetuneDefPtr;

struct _virDomainCachetuneDef {
    virBitmapPtr vcpus;
    virResctrlAllocPtr alloc;
};


2214 2215
typedef struct _virDomainVcpuDef virDomainVcpuDef;
typedef virDomainVcpuDef *virDomainVcpuDefPtr;
2216

2217
struct _virDomainVcpuDef {
2218
    bool online;
2219 2220 2221
    virTristateBool hotpluggable;
    unsigned int order;

2222
    virBitmapPtr cpumask;
2223 2224

    virDomainThreadSchedParam sched;
2225 2226

    virObjectPtr privateData;
2227 2228
};

2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242
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 {
2243 2244 2245
    /* total memory size including memory modules in kibibytes, this field
     * should be accessed only via accessors */
    unsigned long long total_memory;
2246 2247
    unsigned long long cur_balloon; /* in kibibytes, capped at ulong thanks
                                       to virDomainGetInfo */
2248 2249 2250 2251

    virDomainHugePagePtr hugepages;
    size_t nhugepages;

2252 2253 2254 2255
    /* 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 */

2256 2257 2258
    bool nosharepages;
    bool locked;
    int dump_core; /* enum virTristateSwitch */
2259 2260 2261 2262
    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 */
2263 2264 2265 2266

    int source; /* enum virDomainMemorySource */
    int access; /* enum virDomainMemoryAccess */
    int allocation; /* enum virDomainMemoryAllocation */
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277
};

typedef struct _virDomainPowerManagement virDomainPowerManagement;
typedef virDomainPowerManagement *virDomainPowerManagementPtr;

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

Q
Qiaowei Ren 已提交
2278 2279 2280 2281 2282 2283 2284
typedef struct _virDomainPerfDef virDomainPerfDef;
typedef virDomainPerfDef *virDomainPerfDefPtr;
struct _virDomainPerfDef {
    /* These options are of type enum virTristateBool */
    int events[VIR_PERF_EVENT_LAST];
};

2285 2286 2287 2288 2289 2290 2291
typedef struct _virDomainKeyWrapDef virDomainKeyWrapDef;
typedef virDomainKeyWrapDef *virDomainKeyWrapDefPtr;
struct _virDomainKeyWrapDef {
    int aes; /* enum virTristateSwitch */
    int dea; /* enum virTristateSwitch */
};

J
Ján Tomko 已提交
2292 2293 2294 2295 2296 2297 2298 2299
typedef enum {
    VIR_DOMAIN_IOMMU_MODEL_INTEL,

    VIR_DOMAIN_IOMMU_MODEL_LAST
} virDomainIOMMUModel;

struct _virDomainIOMMUDef {
    virDomainIOMMUModel model;
2300
    virTristateSwitch intremap;
2301
    virTristateSwitch caching_mode;
2302
    virTristateSwitch eim;
J
Ján Tomko 已提交
2303
    virTristateSwitch iotlb;
J
Ján Tomko 已提交
2304
};
2305 2306 2307 2308 2309 2310

struct _virDomainVirtioOptions {
    virTristateSwitch iommu;
    virTristateSwitch ats;
};

2311 2312 2313 2314 2315 2316
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
2317 2318
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
2319
struct _virDomainDef {
2320
    virDomainVirtType virtType;
2321 2322 2323
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
2324
    char *title;
2325
    char *description;
2326

2327 2328
    virDomainBlkiotune blkio;
    virDomainMemtune mem;
2329

2330
    virDomainVcpuDefPtr *vcpus;
2331
    size_t maxvcpus;
2332 2333
    /* set if the vcpu definition was specified individually */
    bool individualvcpus;
O
Osier Yang 已提交
2334
    int placement_mode;
H
Hu Tao 已提交
2335
    virBitmapPtr cpumask;
2336

2337 2338
    size_t niothreadids;
    virDomainIOThreadIDDefPtr *iothreadids;
2339

2340
    virDomainCputune cputune;
2341

2342 2343 2344
    virDomainCachetuneDefPtr *cachetunes;
    size_t ncachetunes;

2345
    virDomainNumaPtr numa;
2346
    virDomainResourceDefPtr resource;
2347
    virDomainIdMapDef idmap;
2348

2349 2350 2351 2352 2353
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

2354 2355
    int onLockFailure; /* enum virDomainLockFailureAction */

2356
    virDomainPowerManagement pm;
2357

2358
    virDomainPerfDef perf;
Q
Qiaowei Ren 已提交
2359

2360 2361
    virDomainOSDef os;
    char *emulator;
2362 2363 2364
    /* Most {caps_,hyperv_,kvm_,}feature options utilize a virTristateSwitch
     * to handle support. A few assign specific data values to the option.
     * See virDomainDefFeaturesCheckABIStability() for details. */
2365
    int features[VIR_DOMAIN_FEATURE_LAST];
2366
    int caps_features[VIR_DOMAIN_CAPS_FEATURE_LAST];
2367
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
2368
    int kvm_features[VIR_DOMAIN_KVM_LAST];
2369
    unsigned int hyperv_spinlocks;
2370
    virGICVersion gic_version;
2371
    char *hyperv_vendor_id;
2372
    int apic_eoi;
2373

2374
    virDomainClockDef clock;
2375

2376
    size_t ngraphics;
2377
    virDomainGraphicsDefPtr *graphics;
2378

2379
    size_t ndisks;
2380 2381
    virDomainDiskDefPtr *disks;

2382
    size_t ncontrollers;
2383 2384
    virDomainControllerDefPtr *controllers;

2385
    size_t nfss;
2386 2387
    virDomainFSDefPtr *fss;

2388
    size_t nnets;
2389 2390
    virDomainNetDefPtr *nets;

2391
    size_t ninputs;
2392 2393
    virDomainInputDefPtr *inputs;

2394
    size_t nsounds;
2395 2396
    virDomainSoundDefPtr *sounds;

2397
    size_t nvideos;
2398 2399
    virDomainVideoDefPtr *videos;

2400
    size_t nhostdevs;
2401 2402
    virDomainHostdevDefPtr *hostdevs;

2403
    size_t nredirdevs;
2404 2405
    virDomainRedirdevDefPtr *redirdevs;

2406
    size_t nsmartcards;
E
Eric Blake 已提交
2407 2408
    virDomainSmartcardDefPtr *smartcards;

2409
    size_t nserials;
2410 2411
    virDomainChrDefPtr *serials;

2412
    size_t nparallels;
2413 2414
    virDomainChrDefPtr *parallels;

2415
    size_t nchannels;
2416 2417
    virDomainChrDefPtr *channels;

2418
    size_t nconsoles;
2419 2420
    virDomainChrDefPtr *consoles;

2421
    size_t nleases;
2422 2423
    virDomainLeaseDefPtr *leases;

2424
    size_t nhubs;
M
Marc-André Lureau 已提交
2425 2426
    virDomainHubDefPtr *hubs;

2427 2428 2429
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

2430 2431 2432
    size_t nrngs;
    virDomainRNGDefPtr *rngs;

2433 2434 2435
    size_t nshmems;
    virDomainShmemDefPtr *shmems;

2436 2437 2438
    size_t nmems;
    virDomainMemoryDefPtr *mems;

D
Dmitry Andreev 已提交
2439 2440 2441
    size_t npanics;
    virDomainPanicDefPtr *panics;

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

    void *namespaceData;
    virDomainXMLNamespace ns;
2454

2455 2456
    virDomainKeyWrapDefPtr keywrap;

2457 2458
    /* Application-specific custom metadata */
    xmlNodePtr metadata;
2459 2460 2461 2462 2463 2464

    /* 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 */
2465 2466
};

2467

2468
unsigned long long virDomainDefGetMemoryInitial(const virDomainDef *def);
2469
void virDomainDefSetMemoryTotal(virDomainDefPtr def, unsigned long long size);
2470
unsigned long long virDomainDefGetMemoryTotal(const virDomainDef *def);
2471
bool virDomainDefHasMemoryHotplug(const virDomainDef *def);
2472

2473 2474 2475 2476 2477 2478 2479
typedef enum {
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_AES,
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_DEA,

    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_LAST
} virDomainKeyWrapCipherName;

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

    VIR_DOMAIN_TAINT_LAST
2494
} virDomainTaintFlags;
2495

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

2503 2504 2505
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
2506
    virObjectLockable parent;
2507
    virCond cond;
2508

2509
    pid_t pid;
J
Jiri Denemark 已提交
2510
    virDomainStateReason state;
2511 2512 2513

    unsigned int autostart : 1;
    unsigned int persistent : 1;
2514
    unsigned int updated : 1;
2515
    unsigned int removing : 1;
2516 2517 2518

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

2520
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
2521 2522
    virDomainSnapshotObjPtr current_snapshot;

2523 2524
    bool hasManagedSave;

2525 2526
    void *privateData;
    void (*privateDataFreeFunc)(void *);
2527 2528

    int taint;
2529 2530 2531

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

2534 2535
typedef bool (*virDomainObjListACLFilter)(virConnectPtr conn,
                                          virDomainDefPtr def);
2536

2537

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


2550 2551
/* This structure holds various callbacks and data needed
 * while parsing and creating domain XMLs */
2552 2553
typedef struct _virDomainXMLOption virDomainXMLOption;
typedef virDomainXMLOption *virDomainXMLOptionPtr;
2554

2555 2556 2557 2558 2559 2560 2561 2562 2563

/* 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);

2564
/* Called once after everything else has been parsed, for adjusting
2565 2566 2567
 * overall domain defaults.
 * @parseOpaque is opaque data passed by virDomainDefParse* caller,
 * @opaque is opaque data set by driver (usually pointer to driver
2568 2569 2570 2571
 * 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. */
2572 2573
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
                                             virCapsPtr caps,
2574
                                             unsigned int parseFlags,
2575 2576
                                             void *opaque,
                                             void *parseOpaque);
2577
/* Called once per device, for adjusting per-device settings while
2578 2579 2580 2581
 * 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). */
2582
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
2583
                                                   const virDomainDef *def,
2584
                                                   virCapsPtr caps,
2585
                                                   unsigned int parseFlags,
2586 2587
                                                   void *opaque,
                                                   void *parseOpaque);
2588
/* Drive callback for assigning device addresses, called at the end
2589 2590 2591 2592
 * 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). */
2593 2594 2595
typedef int (*virDomainDefAssignAddressesCallback)(virDomainDef *def,
                                                   virCapsPtr caps,
                                                   unsigned int parseFlags,
2596 2597
                                                   void *opaque,
                                                   void *parseOpaque);
2598

2599 2600 2601 2602 2603 2604 2605
typedef int (*virDomainDefPostParseDataAlloc)(const virDomainDef *def,
                                              virCapsPtr caps,
                                              unsigned int parseFlags,
                                              void *opaque,
                                              void **parseOpaque);
typedef void (*virDomainDefPostParseDataFree)(void *parseOpaque);

2606 2607 2608 2609 2610 2611
/* 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);
2612

2613 2614 2615 2616 2617 2618
/* 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);

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

2630 2631
    /* validation callbacks */
    virDomainDefValidateCallback domainValidateCallback;
2632
    virDomainDeviceDefValidateCallback deviceValidateCallback;
2633

2634
    /* private data for the callbacks */
2635 2636
    void *priv;
    virFreeCallback privFree;
2637 2638

    /* data */
2639
    unsigned int features; /* virDomainDefFeatures */
2640
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2641 2642
};

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

2652 2653 2654 2655 2656 2657
typedef int (*virDomainXMLPrivateDataStorageSourceParseFunc)(xmlXPathContextPtr ctxt,
                                                             virStorageSourcePtr src);
typedef int (*virDomainXMLPrivateDataStorageSourceFormatFunc)(virStorageSourcePtr src,
                                                              virBufferPtr buf);


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

2674 2675 2676 2677 2678 2679 2680 2681 2682
typedef bool (*virDomainABIStabilityDomain)(const virDomainDef *src,
                                            const virDomainDef *dst);

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

2683 2684
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
2685
                                            virDomainXMLNamespacePtr xmlns,
2686 2687 2688 2689 2690
                                            virDomainABIStabilityPtr abi,
                                            virSaveCookieCallbacksPtr saveCookie);

virSaveCookieCallbacksPtr
virDomainXMLOptionGetSaveCookie(virDomainXMLOptionPtr xmlopt);
2691

2692 2693
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2694
virDomainXMLNamespacePtr
2695
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2696 2697
    ATTRIBUTE_NONNULL(1);

2698 2699 2700 2701 2702
int virDomainDefPostParse(virDomainDefPtr def,
                          virCapsPtr caps,
                          unsigned int parseFlags,
                          virDomainXMLOptionPtr xmlopt,
                          void *parseOpaque);
2703
bool virDomainDefHasUSB(const virDomainDef *def);
2704

2705 2706 2707 2708
int virDomainDeviceValidateAliasForHotplug(virDomainObjPtr vm,
                                           virDomainDeviceDefPtr dev,
                                           unsigned int flags);

2709 2710
bool virDomainDeviceAliasIsUserAlias(const char *aliasStr);

2711
int virDomainDefValidate(virDomainDefPtr def,
2712 2713 2714 2715
                         virCapsPtr caps,
                         unsigned int parseFlags,
                         virDomainXMLOptionPtr xmlopt);

2716
static inline bool
D
Daniel P. Berrange 已提交
2717
virDomainObjIsActive(virDomainObjPtr dom)
2718 2719 2720 2721
{
    return dom->def->id != -1;
}

2722 2723 2724 2725 2726 2727 2728 2729 2730 2731
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;
2732
void virDomainDefVcpuOrderClear(virDomainDefPtr def);
P
Peter Krempa 已提交
2733 2734
int  virDomainDefGetVcpusTopology(const virDomainDef *def,
                                  unsigned int *maxvcpus);
2735

2736
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2737
    ATTRIBUTE_NONNULL(1);
2738

M
Michal Privoznik 已提交
2739 2740
void virDomainObjEndAPI(virDomainObjPtr *vm);

2741
bool virDomainObjTaint(virDomainObjPtr obj,
2742
                       virDomainTaintFlags taint);
2743

2744 2745 2746 2747
void virDomainObjBroadcast(virDomainObjPtr vm);
int virDomainObjWait(virDomainObjPtr vm);
int virDomainObjWaitUntil(virDomainObjPtr vm,
                          unsigned long long whenms);
2748

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

virDomainControllerDefPtr virDomainControllerDefNew(virDomainControllerType type);
2776
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2777
bool virDomainControllerIsPSeriesPHB(const virDomainControllerDef *cont);
2778

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

2813
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
2814 2815
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
2816 2817 2818 2819 2820 2821
                                           void *opaque);

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

2822 2823 2824 2825
bool virDomainDefHasDeviceAddress(virDomainDefPtr def,
                                  virDomainDeviceInfoPtr info)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;

2826 2827
void virDomainDefFree(virDomainDefPtr vm);

2828
virDomainChrDefPtr virDomainChrDefNew(virDomainXMLOptionPtr xmlopt);
M
Michal Novotny 已提交
2829

2830 2831 2832 2833
virDomainDefPtr virDomainDefNew(void);
virDomainDefPtr virDomainDefNewFull(const char *name,
                                    const unsigned char *uuid,
                                    int id);
2834

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

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

int virDomainObjGetDefs(virDomainObjPtr vm,
                        unsigned int flags,
                        virDomainDefPtr *liveDef,
                        virDomainDefPtr *persDef);
2855 2856 2857
virDomainDefPtr virDomainObjGetOneDefState(virDomainObjPtr vm,
                                           unsigned int flags,
                                           bool *state);
2858
virDomainDefPtr virDomainObjGetOneDef(virDomainObjPtr vm, unsigned int flags);
2859

2860 2861 2862
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virCapsPtr caps,
                                 virDomainXMLOptionPtr xmlopt,
2863
                                 void *parseOpaque,
2864 2865 2866 2867
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
                                              virCapsPtr caps,
                                              virDomainXMLOptionPtr xmlopt);
2868

2869 2870 2871
typedef enum {
    /* parse internal domain status information */
    VIR_DOMAIN_DEF_PARSE_STATUS          = 1 << 0,
2872 2873 2874 2875
    /* 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. */
2876 2877 2878 2879 2880
    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,
2881
    /* internal flag passed to device info sub-parser to allow using <rom> */
2882
    VIR_DOMAIN_DEF_PARSE_ALLOW_ROM       = 1 << 4,
2883
    /* internal flag passed to device info sub-parser to allow specifying boot order */
2884 2885
    VIR_DOMAIN_DEF_PARSE_ALLOW_BOOT      = 1 << 5,
    /* parse only source half of <disk> */
2886
    VIR_DOMAIN_DEF_PARSE_DISK_SOURCE     = 1 << 6,
2887
    /* perform RNG schema validation on the passed XML document */
2888
    VIR_DOMAIN_DEF_PARSE_VALIDATE_SCHEMA = 1 << 7,
2889
    /* don't validate os.type and arch against capabilities. Prevents
2890
     * VMs from disappearing when qemu is removed and libvirtd is restarted */
2891
    VIR_DOMAIN_DEF_PARSE_SKIP_OSTYPE_CHECKS = 1 << 8,
2892 2893
    /* allow updates in post parse callback that would break ABI otherwise */
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE = 1 << 9,
2894 2895
    /* skip definition validation checks meant to be executed on define time only */
    VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE = 1 << 10,
2896 2897
    /* skip parsing of security labels */
    VIR_DOMAIN_DEF_PARSE_SKIP_SECLABEL        = 1 << 11,
2898 2899 2900 2901
    /* 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,
2902 2903 2904 2905 2906
    /* 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,
2907 2908 2909 2910 2911
} virDomainDefParseFlags;

typedef enum {
    VIR_DOMAIN_DEF_FORMAT_SECURE          = 1 << 0,
    VIR_DOMAIN_DEF_FORMAT_INACTIVE        = 1 << 1,
2912
    VIR_DOMAIN_DEF_FORMAT_MIGRATABLE      = 1 << 2,
2913
    /* format internal domain status information */
2914
    VIR_DOMAIN_DEF_FORMAT_STATUS          = 1 << 3,
2915
    /* format <actual> element */
2916
    VIR_DOMAIN_DEF_FORMAT_ACTUAL_NET      = 1 << 4,
2917
    /* format original states of host PCI device */
2918 2919 2920 2921
    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,
2922 2923
} virDomainDefFormatFlags;

2924 2925 2926 2927 2928 2929 2930 2931 2932
/* 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;

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

2968
bool virDomainDefCheckABIStability(virDomainDefPtr src,
2969 2970
                                   virDomainDefPtr dst,
                                   virDomainXMLOptionPtr xmlopt);
2971

2972 2973
bool virDomainDefCheckABIStabilityFlags(virDomainDefPtr src,
                                        virDomainDefPtr dst,
2974
                                        virDomainXMLOptionPtr xmlopt,
2975 2976
                                        unsigned int flags);

2977
int virDomainDefAddImplicitDevices(virDomainDefPtr def);
2978

2979
virDomainIOThreadIDDefPtr virDomainIOThreadIDFind(const virDomainDef *def,
2980 2981 2982 2983 2984
                                                  unsigned int iothread_id);
virDomainIOThreadIDDefPtr virDomainIOThreadIDAdd(virDomainDefPtr def,
                                                 unsigned int iothread_id);
void virDomainIOThreadIDDel(virDomainDefPtr def, unsigned int iothread_id);

2985 2986
unsigned int virDomainDefFormatConvertXMLFlags(unsigned int flags);

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

3000 3001 3002
int virDomainDiskSourceFormat(virBufferPtr buf,
                              virStorageSourcePtr src,
                              int policy,
3003 3004
                              unsigned int flags,
                              virDomainXMLOptionPtr xmlopt);
3005

3006 3007
int virDomainNetDefFormat(virBufferPtr buf,
                          virDomainNetDefPtr def,
3008
                          char *prefix,
3009 3010
                          unsigned int flags);

3011 3012 3013 3014 3015 3016
typedef enum {
    VIR_DOMAIN_DEVICE_ACTION_ATTACH,
    VIR_DOMAIN_DEVICE_ACTION_DETACH,
    VIR_DOMAIN_DEVICE_ACTION_UPDATE,
} virDomainDeviceAction;

3017
int virDomainDefCompatibleDevice(virDomainDefPtr def,
3018 3019
                                 virDomainDeviceDefPtr dev,
                                 virDomainDeviceDefPtr oldDev);
3020

3021 3022
void virDomainRNGDefFree(virDomainRNGDefPtr def);

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

3047 3048 3049 3050
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
3051
int virDomainDiskSourceParse(xmlNodePtr node,
3052
                             xmlXPathContextPtr ctxt,
3053
                             virStorageSourcePtr src,
3054 3055
                             unsigned int flags,
                             virDomainXMLOptionPtr xmlopt);
3056

3057 3058
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
3059
virDomainNetDefPtr virDomainNetFindByName(virDomainDefPtr def, const char *ifname);
3060
bool virDomainHasNet(virDomainDefPtr def, virDomainNetDefPtr net);
3061
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
3062
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
3063
void virDomainNetRemoveHostdev(virDomainDefPtr def, virDomainNetDefPtr net);
3064

L
Laine Stump 已提交
3065
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
3066 3067
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
3068 3069 3070
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

3071 3072
virDomainGraphicsListenDefPtr
virDomainGraphicsGetListen(virDomainGraphicsDefPtr def, size_t i);
3073 3074
int virDomainGraphicsListenAppendAddress(virDomainGraphicsDefPtr def,
                                         const char *address)
3075
            ATTRIBUTE_NONNULL(1);
3076 3077 3078
int virDomainGraphicsListenAppendSocket(virDomainGraphicsDefPtr def,
                                        const char *socket)
            ATTRIBUTE_NONNULL(1);
3079

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

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

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
3116 3117
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def)
    ATTRIBUTE_RETURN_CHECK;
3118 3119
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
3120 3121 3122 3123 3124
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
3125

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

3148 3149 3150
ssize_t virDomainRNGFind(virDomainDefPtr def, virDomainRNGDefPtr rng);
virDomainRNGDefPtr virDomainRNGRemove(virDomainDefPtr def, size_t idx);

3151 3152 3153 3154
ssize_t virDomainRedirdevDefFind(virDomainDefPtr def,
                                 virDomainRedirdevDefPtr redirdev);
virDomainRedirdevDefPtr virDomainRedirdevDefRemove(virDomainDefPtr def, size_t idx);

3155
int virDomainSaveXML(const char *configDir,
3156 3157 3158
                     virDomainDefPtr def,
                     const char *xml);

3159
int virDomainSaveConfig(const char *configDir,
3160
                        virCapsPtr caps,
3161
                        virDomainDefPtr def);
3162
int virDomainSaveStatus(virDomainXMLOptionPtr xmlopt,
3163
                        const char *statusDir,
3164 3165
                        virDomainObjPtr obj,
                        virCapsPtr caps) ATTRIBUTE_RETURN_CHECK;
3166

3167 3168 3169 3170
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

3171
int virDomainDeleteConfig(const char *configDir,
3172
                          const char *autostartDir,
3173 3174
                          virDomainObjPtr dom);

3175
char *virDomainConfigFile(const char *dir,
3176 3177
                          const char *name);

3178 3179 3180 3181
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

3182
virDomainFSDefPtr virDomainGetFilesystemForTarget(virDomainDefPtr def,
3183
                                                  const char *target);
3184
int virDomainFSInsert(virDomainDefPtr def, virDomainFSDefPtr fs);
3185
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
3186 3187
virDomainFSDefPtr virDomainFSRemove(virDomainDefPtr def, size_t i);

3188
int virDomainVideoDefaultType(const virDomainDef *def);
3189 3190
unsigned int virDomainVideoDefaultRAM(const virDomainDef *def,
                                      const virDomainVideoType type);
3191

E
Eric Blake 已提交
3192 3193 3194 3195 3196 3197 3198 3199 3200
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

3201 3202 3203 3204 3205 3206 3207 3208 3209
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

3210 3211 3212 3213 3214
typedef int (*virDomainDiskDefPathIterator)(virDomainDiskDefPtr disk,
                                            const char *path,
                                            size_t depth,
                                            void *opaque);

3215 3216 3217 3218 3219 3220 3221
typedef int (*virDomainUSBDeviceDefIterator)(virDomainDeviceInfoPtr info,
                                             void *opaque);
int virDomainUSBDeviceDefForeach(virDomainDefPtr def,
                                 virDomainUSBDeviceDefIterator iter,
                                 void *opaque,
                                 bool skipHubs);

3222 3223 3224 3225 3226
int virDomainDiskDefForeachPath(virDomainDiskDefPtr disk,
                                bool ignoreOpenFailure,
                                virDomainDiskDefPathIterator iter,
                                void *opaque);

J
Jiri Denemark 已提交
3227 3228 3229 3230 3231 3232 3233
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

3234 3235 3236
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

3237
virSecurityDeviceLabelDefPtr
3238 3239
virDomainChrSourceDefGetSecurityLabelDef(virDomainChrSourceDefPtr def,
                                         const char *model);
3240

3241 3242
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
3243

3244 3245 3246 3247 3248 3249 3250 3251 3252 3253
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;

3254 3255 3256 3257 3258 3259 3260 3261
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);
3262 3263 3264
ssize_t virDomainInputDefFind(const virDomainDef *def,
                              const virDomainInputDef *input)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
3265

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

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

3362
VIR_ENUM_DECL(virDomainSeclabel)
3363
VIR_ENUM_DECL(virDomainClockOffset)
3364
VIR_ENUM_DECL(virDomainClockBasis)
3365

3366
VIR_ENUM_DECL(virDomainTimerName)
3367
VIR_ENUM_DECL(virDomainTimerTrack)
3368 3369
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)
O
Osier Yang 已提交
3370
VIR_ENUM_DECL(virDomainCpuPlacementMode)
3371

3372
VIR_ENUM_DECL(virDomainStartupPolicy)
3373

3374 3375
virDomainControllerDefPtr
virDomainDefAddController(virDomainDefPtr def, int type, int idx, int model);
3376 3377
int
virDomainDefAddUSBController(virDomainDefPtr def, int idx, int model);
3378 3379 3380 3381 3382
int
virDomainDefMaybeAddController(virDomainDefPtr def,
                               int type,
                               int idx,
                               int model);
3383 3384 3385 3386
int
virDomainDefMaybeAddInput(virDomainDefPtr def,
                          int type,
                          int bus);
3387

3388 3389
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

3390 3391
int virDomainDefFindDevice(virDomainDefPtr def,
                           const char *devAlias,
3392 3393
                           virDomainDeviceDefPtr dev,
                           bool reportError);
3394

3395 3396
const char *virDomainChrSourceDefGetPath(virDomainChrSourceDefPtr chr);

3397 3398
void virDomainChrSourceDefClear(virDomainChrSourceDefPtr def);

3399 3400 3401 3402 3403
char *virDomainObjGetMetadata(virDomainObjPtr vm,
                              int type,
                              const char *uri,
                              unsigned int flags);

3404 3405 3406 3407 3408 3409 3410
int virDomainObjSetMetadata(virDomainObjPtr vm,
                            int type,
                            const char *metadata,
                            const char *key,
                            const char *uri,
                            virCapsPtr caps,
                            virDomainXMLOptionPtr xmlopt,
3411
                            const char *stateDir,
3412 3413 3414
                            const char *configDir,
                            unsigned int flags);

3415 3416 3417 3418 3419 3420 3421 3422
int
virDomainParseMemory(const char *xpath,
                     const char *units_xpath,
                     xmlXPathContextPtr ctxt,
                     unsigned long long *mem,
                     bool required,
                     bool capped);

3423 3424 3425
bool virDomainDefNeedsPlacementAdvice(virDomainDefPtr def)
    ATTRIBUTE_NONNULL(1);

3426 3427
int virDomainDiskDefCheckDuplicateInfo(const virDomainDiskDef *a,
                                       const virDomainDiskDef *b)
3428
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3429

3430 3431 3432 3433 3434 3435 3436
int virDomainStorageSourceFormat(virBufferPtr attrBuf,
                                 virBufferPtr childBuf,
                                 virStorageSourcePtr src,
                                 unsigned int flags,
                                 bool skipSeclabels)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3);

3437 3438 3439 3440 3441 3442 3443 3444
int virDomainDefGetVcpuPinInfoHelper(virDomainDefPtr def,
                                     int maplen,
                                     int ncpumaps,
                                     unsigned char *cpumaps,
                                     int hostcpus,
                                     virBitmapPtr autoCpuset)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;

3445 3446
bool virDomainDefHasMemballoon(const virDomainDef *def) ATTRIBUTE_NONNULL(1);

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

3449 3450 3451 3452 3453
int
virDomainGetBlkioParametersAssignFromDef(virDomainDefPtr def,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         int maxparams);
3454

3455 3456 3457
int virDomainDiskSetBlockIOTune(virDomainDiskDefPtr disk,
                                virDomainBlockIoTuneInfo *info);

3458 3459 3460 3461 3462
char *
virDomainGenerateMachineName(const char *drivername,
                             int id,
                             const char *name,
                             bool privileged);
3463 3464 3465

bool
virDomainNetTypeSharesHostView(const virDomainNetDef *net);
3466

3467 3468 3469 3470
bool
virDomainDefLifecycleActionAllowed(virDomainLifecycle type,
                                   virDomainLifecycleAction action);

3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482
typedef int
(*virDomainNetAllocateActualDeviceImpl)(virDomainDefPtr dom,
                                        virDomainNetDefPtr iface);

typedef void
(*virDomainNetNotifyActualDeviceImpl)(virDomainDefPtr dom,
                                      virDomainNetDefPtr iface);

typedef int
(*virDomainNetReleaseActualDeviceImpl)(virDomainDefPtr dom,
                                       virDomainNetDefPtr iface);

3483 3484 3485 3486 3487 3488 3489 3490 3491
typedef bool
(*virDomainNetBandwidthChangeAllowedImpl)(virDomainNetDefPtr iface,
                                          virNetDevBandwidthPtr newBandwidth);

typedef int
(*virDomainNetBandwidthUpdateImpl)(virDomainNetDefPtr iface,
                                   virNetDevBandwidthPtr newBandwidth);


3492 3493 3494
void
virDomainNetSetDeviceImpl(virDomainNetAllocateActualDeviceImpl allocate,
                          virDomainNetNotifyActualDeviceImpl notify,
3495 3496
                          virDomainNetReleaseActualDeviceImpl release,
                          virDomainNetBandwidthChangeAllowedImpl bandwidthChangeAllowed,
3497
                          virDomainNetBandwidthUpdateImpl bandwidthUpdate);
3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513

int
virDomainNetAllocateActualDevice(virDomainDefPtr dom,
                                 virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

void
virDomainNetNotifyActualDevice(virDomainDefPtr dom,
                               virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

int
virDomainNetReleaseActualDevice(virDomainDefPtr dom,
                                virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

3514 3515 3516 3517 3518 3519 3520 3521 3522
bool
virDomainNetBandwidthChangeAllowed(virDomainNetDefPtr iface,
                              virNetDevBandwidthPtr newBandwidth)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

int
virDomainNetBandwidthUpdate(virDomainNetDefPtr iface,
                            virNetDevBandwidthPtr newBandwidth)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3523

3524 3525 3526 3527
int
virDomainNetResolveActualType(virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1);

3528

3529
int virDomainDiskTranslateSourcePool(virDomainDiskDefPtr def);
3530 3531


3532
#endif /* __DOMAIN_CONF_H */