domain_conf.h 124.1 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
4
 * Copyright (C) 2006-2019 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 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#pragma once

#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xpath.h>

#include "internal.h"
#include "virconftypes.h"
#include "capabilities.h"
#include "virstorageencryption.h"
#include "cpu_conf.h"
#include "virthread.h"
#include "virhash.h"
#include "virsocketaddr.h"
#include "networkcommon_conf.h"
#include "nwfilter_params.h"
#include "numa_conf.h"
#include "virnetdevmacvlan.h"
#include "virsysinfo.h"
#include "virnetdev.h"
#include "virnetdevip.h"
#include "virnetdevvportprofile.h"
#include "virnetdevbandwidth.h"
#include "virnetdevvlan.h"
47
#include "virnetworkportdef.h"
48 49 50 51 52 53 54 55 56 57 58 59
#include "virobject.h"
#include "device_conf.h"
#include "virbitmap.h"
#include "virstoragefile.h"
#include "virseclabel.h"
#include "virprocess.h"
#include "virgic.h"
#include "virperf.h"
#include "virtypedparam.h"
#include "virsavecookie.h"
#include "virresctrl.h"
#include "virenum.h"
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
/* 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 已提交
80
    VIR_DOMAIN_DEVICE_NVRAM,
81
    VIR_DOMAIN_DEVICE_RNG,
82
    VIR_DOMAIN_DEVICE_SHMEM,
83
    VIR_DOMAIN_DEVICE_TPM,
84
    VIR_DOMAIN_DEVICE_PANIC,
85
    VIR_DOMAIN_DEVICE_MEMORY,
J
Ján Tomko 已提交
86
    VIR_DOMAIN_DEVICE_IOMMU,
J
Ján Tomko 已提交
87
    VIR_DOMAIN_DEVICE_VSOCK,
88

89
    VIR_DOMAIN_DEVICE_LAST
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
} virDomainDeviceType;

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 已提交
111
        virDomainNVRAMDefPtr nvram;
112
        virDomainRNGDefPtr rng;
113
        virDomainShmemDefPtr shmem;
114
        virDomainTPMDefPtr tpm;
115
        virDomainPanicDefPtr panic;
116
        virDomainMemoryDefPtr memory;
J
Ján Tomko 已提交
117
        virDomainIOMMUDefPtr iommu;
J
Ján Tomko 已提交
118
        virDomainVsockDefPtr vsock;
119 120 121
    } data;
};

122
/* Different types of hypervisor */
123
typedef enum {
124
    VIR_DOMAIN_VIRT_NONE = 0,
125 126 127 128 129 130 131 132 133 134
    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,
135
    VIR_DOMAIN_VIRT_VBOX,
136
    VIR_DOMAIN_VIRT_PHYP,
D
Dmitry Guryanov 已提交
137
    VIR_DOMAIN_VIRT_PARALLELS,
R
Roman Bogorodskiy 已提交
138
    VIR_DOMAIN_VIRT_BHYVE,
139
    VIR_DOMAIN_VIRT_VZ,
140

141
    VIR_DOMAIN_VIRT_LAST
142
} virDomainVirtType;
143

144 145 146 147 148 149
typedef enum {
    VIR_DOMAIN_OSTYPE_HVM,
    VIR_DOMAIN_OSTYPE_XEN,
    VIR_DOMAIN_OSTYPE_LINUX,
    VIR_DOMAIN_OSTYPE_EXE,
    VIR_DOMAIN_OSTYPE_UML,
150
    VIR_DOMAIN_OSTYPE_XENPVH,
151 152 153

    VIR_DOMAIN_OSTYPE_LAST
} virDomainOSType;
154
VIR_ENUM_DECL(virDomainOS);
155 156


157 158 159 160 161 162
struct _virDomainHostdevOrigStates {
    union {
        struct {
            /* Does the device need to unbind from stub when
             * reattaching to host?
             */
163
            bool unbind_from_stub;
164 165 166 167

            /* Does it need to use remove_slot when reattaching
             * the device to host?
             */
168
            bool remove_slot;
169 170 171 172

            /* Does it need to reprobe driver for the device when
             * reattaching to host?
             */
173
            bool reprobe;
174 175 176 177 178 179
        } pci;

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

180 181 182 183 184 185 186
struct _virDomainLeaseDef {
    char *lockspace;
    char *key;
    char *path;
    unsigned long long offset;
};

187

188
typedef enum {
189 190 191
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,

192
    VIR_DOMAIN_HOSTDEV_MODE_LAST
193
} virDomainHostdevMode;
194

195
typedef enum {
196 197
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,
H
Han Cheng 已提交
198
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI,
199
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_SCSI_HOST,
200
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_MDEV,
201 202

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
203
} virDomainHostdevSubsysType;
204

205 206
/* the backend driver used for PCI hostdev devices */
typedef enum {
N
Nitesh Konkar 已提交
207
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_DEFAULT, /* detect automatically, prefer VFIO */
208 209
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_KVM,    /* force legacy kvm style */
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_VFIO,   /* force vfio */
210
    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_XEN,    /* force legacy xen style, use pciback */
211 212

    VIR_DOMAIN_HOSTDEV_PCI_BACKEND_TYPE_LAST
213
} virDomainHostdevSubsysPCIBackendType;
214

215
VIR_ENUM_DECL(virDomainHostdevSubsysPCIBackend);
216

217 218 219 220 221 222 223
typedef enum {
    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_NONE,
    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_ISCSI,

    VIR_DOMAIN_HOSTDEV_SCSI_PROTOCOL_TYPE_LAST,
} virDomainHostdevSCSIProtocolType;

224
VIR_ENUM_DECL(virDomainHostdevSubsysSCSIProtocol);
225

226 227 228 229 230 231 232 233 234 235
struct _virDomainHostdevSubsysUSB {
    bool autoAddress; /* bus/device were filled automatically based
                         on vendor/product */
    unsigned bus;
    unsigned device;

    unsigned vendor;
    unsigned product;
};

236
struct _virDomainHostdevSubsysPCI {
237
    virPCIDeviceAddress addr; /* host address */
238 239 240
    int backend; /* enum virDomainHostdevSubsysPCIBackendType */
};

241
struct _virDomainHostdevSubsysSCSIHost {
242 243 244
    char *adapter;
    unsigned bus;
    unsigned target;
245
    unsigned long long unit;
246 247
};

248
struct _virDomainHostdevSubsysSCSIiSCSI {
249
    virStorageSourcePtr src;
250 251
};

252
struct _virDomainHostdevSubsysSCSI {
253
    int protocol; /* enum virDomainHostdevSCSIProtocolType */
254
    int sgio; /* enum virDomainDeviceSGIO */
255
    int rawio; /* enum virTristateBool */
256 257
    union {
        virDomainHostdevSubsysSCSIHost host;
258
        virDomainHostdevSubsysSCSIiSCSI iscsi;
259
    } u;
260 261
};

262 263
struct _virDomainHostdevSubsysMediatedDev {
    int model;                          /* enum virMediatedDeviceModelType */
264
    int display; /* virTristateSwitch */
265
    char uuidstr[VIR_UUID_STRING_BUFLEN];   /* mediated device's uuid string */
266
    int ramfb; /* virTristateSwitch */
267 268
};

269 270 271 272 273 274 275
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;

276
VIR_ENUM_DECL(virDomainHostdevSubsysSCSIHostProtocol);
277

278 279 280 281 282 283 284 285 286 287 288
typedef enum {
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_VHOST_MODEL_TYPE_DEFAULT,
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_VHOST_MODEL_TYPE_VIRTIO,
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_VHOST_MODEL_TYPE_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_VHOST_MODEL_TYPE_VIRTIO_NON_TRANSITIONAL,

    VIR_DOMAIN_HOSTDEV_SUBSYS_SCSI_VHOST_MODEL_TYPE_LAST,
} virDomainHostdevSubsysSCSIVHostModelType;

VIR_ENUM_DECL(virDomainHostdevSubsysSCSIVHostModel);

289 290 291
struct _virDomainHostdevSubsysSCSIVHost {
    int protocol; /* enum virDomainHostdevSubsysSCSIHostProtocolType */
    char *wwpn;
292
    int model; /* enum virDomainHostdevSubsysSCSIVHostModelType */
293 294
};

295
struct _virDomainHostdevSubsys {
296
    int type; /* enum virDomainHostdevSubsysType */
297
    union {
298
        virDomainHostdevSubsysUSB usb;
299
        virDomainHostdevSubsysPCI pci;
300
        virDomainHostdevSubsysSCSI scsi;
301
        virDomainHostdevSubsysSCSIVHost scsi_host;
302
        virDomainHostdevSubsysMediatedDev mdev;
303 304 305
    } u;
};

306

307
typedef enum {
308 309
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_STORAGE,
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_MISC,
310
    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_NET,
311 312

    VIR_DOMAIN_HOSTDEV_CAPS_TYPE_LAST
313
} virDomainHostdevCapsType;
314 315 316 317 318 319 320 321 322 323

struct _virDomainHostdevCaps {
    int type; /* enum virDOmainHostdevCapsType */
    union {
        struct {
            char *block;
        } storage;
        struct {
            char *chardev;
        } misc;
324
        struct {
325 326
            char *ifname;
            virNetDevIPInfo ip;
327
        } net;
328 329 330 331
    } u;
};


332 333
/* basic device for direct passthrough */
struct _virDomainHostdevDef {
334 335 336 337 338 339 340
    /* If 'parentnet' is non-NULL it means this host dev was
     * not originally present in the XML. It was copied from
     * a network interface for convenience when handling
     * hostdevs internally. This hostdev should never be
     * visible to the user except as part of the interface
     */
    virDomainNetDefPtr parentnet;
341

342
    int mode; /* enum virDomainHostdevMode */
343
    int startupPolicy; /* enum virDomainStartupPolicy */
344
    bool managed;
345
    bool missing;
O
Osier Yang 已提交
346
    bool readonly;
347
    bool shareable;
348
    union {
349
        virDomainHostdevSubsys subsys;
350
        virDomainHostdevCaps caps;
351 352
    } source;
    virDomainHostdevOrigStates origstates;
353
    virDomainDeviceInfoPtr info; /* Guest address */
354 355
};

356

E
Eric Blake 已提交
357 358
/* Types of disk frontend (guest view).  For backends (host view), see
 * virStorageType in util/virstoragefile.h */
359
typedef enum {
360 361 362
    VIR_DOMAIN_DISK_DEVICE_DISK,
    VIR_DOMAIN_DISK_DEVICE_CDROM,
    VIR_DOMAIN_DISK_DEVICE_FLOPPY,
363
    VIR_DOMAIN_DISK_DEVICE_LUN,
364 365

    VIR_DOMAIN_DISK_DEVICE_LAST
366
} virDomainDiskDevice;
367

368
typedef enum {
369 370 371 372 373
    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,
374
    VIR_DOMAIN_DISK_BUS_USB,
375
    VIR_DOMAIN_DISK_BUS_UML,
376
    VIR_DOMAIN_DISK_BUS_SATA,
377
    VIR_DOMAIN_DISK_BUS_SD,
378 379

    VIR_DOMAIN_DISK_BUS_LAST
380
} virDomainDiskBus;
381

382
typedef enum {
383 384 385 386
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,
387
    VIR_DOMAIN_DISK_CACHE_DIRECTSYNC,
388
    VIR_DOMAIN_DISK_CACHE_UNSAFE,
389 390

    VIR_DOMAIN_DISK_CACHE_LAST
391
} virDomainDiskCache;
392

393
typedef enum {
394 395
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
396
    VIR_DOMAIN_DISK_ERROR_POLICY_REPORT,
397
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
398
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
399 400

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
401
} virDomainDiskErrorPolicy;
402

M
MORITA Kazutaka 已提交
403

404
typedef enum {
405
    VIR_DOMAIN_DISK_TRAY_CLOSED = 0,
406 407 408
    VIR_DOMAIN_DISK_TRAY_OPEN,

    VIR_DOMAIN_DISK_TRAY_LAST
409
} virDomainDiskTray;
410

411
typedef enum {
J
J.B. Joret 已提交
412 413 414 415 416 417
    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
418
} virDomainDiskGeometryTrans;
J
J.B. Joret 已提交
419

420
typedef enum {
421
    VIR_DOMAIN_DISK_IO_DEFAULT = 0,
M
Matthias Dahl 已提交
422 423
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,
H
Han Han 已提交
424
    VIR_DOMAIN_DISK_IO_URING,
M
Matthias Dahl 已提交
425 426

    VIR_DOMAIN_DISK_IO_LAST
427
} virDomainDiskIo;
M
Matthias Dahl 已提交
428

429
typedef enum {
430 431 432 433 434 435
    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
436
} virDomainStartupPolicy;
437

438

439
typedef enum {
440 441 442
    VIR_DOMAIN_DEVICE_SGIO_DEFAULT = 0,
    VIR_DOMAIN_DEVICE_SGIO_FILTERED,
    VIR_DOMAIN_DEVICE_SGIO_UNFILTERED,
O
Osier Yang 已提交
443

444
    VIR_DOMAIN_DEVICE_SGIO_LAST
445
} virDomainDeviceSGIO;
O
Osier Yang 已提交
446

447
typedef enum {
O
Osier Yang 已提交
448
    VIR_DOMAIN_DISK_DISCARD_DEFAULT = 0,
O
Osier Yang 已提交
449 450
    VIR_DOMAIN_DISK_DISCARD_UNMAP,
    VIR_DOMAIN_DISK_DISCARD_IGNORE,
O
Osier Yang 已提交
451 452

    VIR_DOMAIN_DISK_DISCARD_LAST
453
} virDomainDiskDiscard;
O
Osier Yang 已提交
454

455 456 457 458 459 460 461 462 463
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;

464 465 466 467 468 469 470 471 472
typedef enum {
    VIR_DOMAIN_DISK_MODEL_DEFAULT = 0,
    VIR_DOMAIN_DISK_MODEL_VIRTIO,
    VIR_DOMAIN_DISK_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_DISK_MODEL_VIRTIO_NON_TRANSITIONAL,

    VIR_DOMAIN_DISK_MODEL_LAST
} virDomainDiskModel;

L
Lei Li 已提交
473 474 475 476 477 478 479
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;
480 481 482 483 484 485 486
    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;
487
    char *group_name;
488 489 490 491 492 493
    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;
494 495
    /* Don't forget to update virDomainBlockIoTuneInfoCopy and
     * virDomainBlockIoTuneInfoEqual. */
L
Lei Li 已提交
496 497
};

498

499 500 501 502 503 504 505 506 507
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;

508 509 510 511
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 */
M
Marc-André Lureau 已提交
512
    VIR_DOMAIN_MEMORY_SOURCE_MEMFD,     /* Memory source is set as memfd */
513 514 515 516 517 518 519 520 521 522 523 524

    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;

525

526 527
/* Stores the virtual disk configuration */
struct _virDomainDiskDef {
528
    virStorageSourcePtr src; /* non-NULL.  XXX Allow NULL for empty cdrom? */
529

530 531
    virObjectPtr privateData;

532 533 534 535
    int device; /* enum virDomainDiskDevice */
    int bus; /* enum virDomainDiskBus */
    char *dst;
    int tray_status; /* enum virDomainDiskTray */
J
Ján Tomko 已提交
536
    int removable; /* enum virTristateSwitch */
L
Lei Li 已提交
537

538
    virStorageSourcePtr mirror;
539
    int mirrorState; /* enum virDomainDiskMirrorState */
E
Eric Blake 已提交
540
    int mirrorJob; /* virDomainBlockJobType */
541

J
J.B. Joret 已提交
542 543 544 545
    struct {
        unsigned int cylinders;
        unsigned int heads;
        unsigned int sectors;
546
        int trans; /* enum virDomainDiskGeometryTrans */
J
J.B. Joret 已提交
547 548
    } geometry;

549 550 551
    struct {
        unsigned int logical_block_size;
        unsigned int physical_block_size;
V
Viktor Mihajlovski 已提交
552
    } blockio;
553

L
Lei Li 已提交
554 555
    virDomainBlockIoTuneInfo blkdeviotune;

556 557
    char *driverName;

558
    char *serial;
O
Osier Yang 已提交
559
    char *wwn;
560 561
    char *vendor;
    char *product;
562
    int cachemode; /* enum virDomainDiskCache */
563 564
    int error_policy;  /* enum virDomainDiskErrorPolicy */
    int rerror_policy; /* enum virDomainDiskErrorPolicy */
565
    int iomode; /* enum virDomainDiskIo */
J
Ján Tomko 已提交
566 567 568
    int ioeventfd; /* enum virTristateSwitch */
    int event_idx; /* enum virTristateSwitch */
    int copy_on_read; /* enum virTristateSwitch */
569
    int snapshot; /* virDomainSnapshotLocation, snapshot_conf.h */
570
    int startupPolicy; /* enum virDomainStartupPolicy */
571
    bool transient;
572
    virDomainDeviceInfo info;
573
    int rawio; /* enum virTristateBool */
574
    int sgio; /* enum virDomainDeviceSGIO */
O
Osier Yang 已提交
575
    int discard; /* enum virDomainDiskDiscard */
576
    unsigned int iothread; /* unused = 0, > 0 specific thread # */
577
    int detect_zeroes; /* enum virDomainDiskDetectZeroes */
578
    char *domain_name; /* backend domain name */
L
Lin Ma 已提交
579
    unsigned int queues;
580
    int model; /* enum virDomainDiskModel */
J
Ján Tomko 已提交
581
    virDomainVirtioOptionsPtr virtio;
582 583 584
};


585
typedef enum {
586 587 588 589
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
590
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
591
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
592
    VIR_DOMAIN_CONTROLLER_TYPE_USB,
J
Ján Tomko 已提交
593
    VIR_DOMAIN_CONTROLLER_TYPE_PCI,
594
    VIR_DOMAIN_CONTROLLER_TYPE_XENBUS,
595 596

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
597
} virDomainControllerType;
598

599

600
typedef enum {
601
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_DEFAULT = -1,
J
Ján Tomko 已提交
602
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_ROOT,
L
Laine Stump 已提交
603
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT,
J
Ján Tomko 已提交
604
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_BRIDGE,
605
    VIR_DOMAIN_CONTROLLER_MODEL_DMI_TO_PCI_BRIDGE,
606
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_TO_PCI_BRIDGE,
607
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_ROOT_PORT,
608
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_UPSTREAM_PORT,
609
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_SWITCH_DOWNSTREAM_PORT,
610
    VIR_DOMAIN_CONTROLLER_MODEL_PCI_EXPANDER_BUS,
611
    VIR_DOMAIN_CONTROLLER_MODEL_PCIE_EXPANDER_BUS,
J
Ján Tomko 已提交
612 613

    VIR_DOMAIN_CONTROLLER_MODEL_PCI_LAST
614
} virDomainControllerModelPCI;
J
Ján Tomko 已提交
615

616
typedef enum {
617
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_NONE = 0,
618 619
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCI_BRIDGE,
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_I82801B11_BRIDGE,
620
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_IOH3420,
621
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_X3130_UPSTREAM,
622
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_XIO3130_DOWNSTREAM,
623
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB,
624
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PXB_PCIE,
625
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCIE_ROOT_PORT,
626
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_SPAPR_PCI_HOST_BRIDGE,
627
    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_PCIE_PCI_BRIDGE,
628 629 630 631

    VIR_DOMAIN_CONTROLLER_PCI_MODEL_NAME_LAST
} virDomainControllerPCIModelName;

632
typedef enum {
633
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_DEFAULT = -1,
634 635 636 637 638
    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,
639
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_IBMVSCSI,
640
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_SCSI,
641
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LSISAS1078,
642 643
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_VIRTIO_NON_TRANSITIONAL,
644

645
    VIR_DOMAIN_CONTROLLER_MODEL_SCSI_LAST
646
} virDomainControllerModelSCSI;
647

648
typedef enum {
649
    VIR_DOMAIN_CONTROLLER_MODEL_USB_DEFAULT = -1,
M
Marc-André Lureau 已提交
650 651 652 653 654 655 656 657 658
    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 已提交
659
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NEC_XHCI,
660 661
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QUSB1,
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QUSB2,
662
    VIR_DOMAIN_CONTROLLER_MODEL_USB_QEMU_XHCI,
663
    VIR_DOMAIN_CONTROLLER_MODEL_USB_NONE,
M
Marc-André Lureau 已提交
664 665

    VIR_DOMAIN_CONTROLLER_MODEL_USB_LAST
666
} virDomainControllerModelUSB;
M
Marc-André Lureau 已提交
667

668
typedef enum {
669
    VIR_DOMAIN_CONTROLLER_MODEL_IDE_DEFAULT = -1,
670 671 672 673 674 675 676
    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;

677 678 679 680 681 682 683 684 685
typedef enum {
    VIR_DOMAIN_CONTROLLER_MODEL_VIRTIO_SERIAL_DEFAULT = -1,
    VIR_DOMAIN_CONTROLLER_MODEL_VIRTIO_SERIAL_VIRTIO,
    VIR_DOMAIN_CONTROLLER_MODEL_VIRTIO_SERIAL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_CONTROLLER_MODEL_VIRTIO_SERIAL_VIRTIO_NON_TRANSITIONAL,

    VIR_DOMAIN_CONTROLLER_MODEL_VIRTIO_SERIAL_LAST
} virDomainControllerModelVirtioSerial;

686
#define IS_USB2_CONTROLLER(ctrl) \
687 688 689 690 691 692
    (((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))

693 694 695 696 697
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

698
struct _virDomainPCIControllerOpts {
699 700
    bool pcihole64;
    unsigned long pcihole64size;
701 702 703 704 705 706 707

    /* 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 */
708 709 710 711 712 713 714 715

    /* 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 */
716 717 718 719
    /* chassis & port used by
     * pcie-root-port/pcie-switch-downstream-port, -1 = unspecified */
    int chassis;
    int port;
720
    int busNr; /* used by pci-expander-bus, -1 == unspecified */
721
    int targetIndex; /* used by spapr-pci-host-bridge, -1 == unspecified */
722 723 724 725
    /* numaNode is a *subelement* of target (to match existing
     * item in memory target config) -1 == unspecified
     */
    int numaNode;
726
    virTristateSwitch hotplug; /* 'off' to prevent hotplug/unplug, default 'on' */
727
};
728

729 730 731 732
struct _virDomainUSBControllerOpts {
    int ports;   /* -1 == undef */
};

733 734
struct _virDomainXenbusControllerOpts {
    int maxGrantFrames;   /* -1 == undef */
735
    int maxEventChannels; /* -1 == undef */
736 737
};

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


G
Giuseppe Scrivano 已提交
759
/* Types of disk backends */
760
typedef enum {
761 762 763 764 765 766
    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 */
767
    VIR_DOMAIN_FS_TYPE_VOLUME, /* Mounts storage pool volume to a guest */
768 769

    VIR_DOMAIN_FS_TYPE_LAST
770
} virDomainFSType;
771

772
/* Filesystem driver type */
773
typedef enum {
774 775 776
    VIR_DOMAIN_FS_DRIVER_TYPE_DEFAULT = 0,
    VIR_DOMAIN_FS_DRIVER_TYPE_PATH,
    VIR_DOMAIN_FS_DRIVER_TYPE_HANDLE,
777
    VIR_DOMAIN_FS_DRIVER_TYPE_LOOP,
778
    VIR_DOMAIN_FS_DRIVER_TYPE_NBD,
D
Dmitry Guryanov 已提交
779
    VIR_DOMAIN_FS_DRIVER_TYPE_PLOOP,
780
    VIR_DOMAIN_FS_DRIVER_TYPE_VIRTIOFS,
781 782

    VIR_DOMAIN_FS_DRIVER_TYPE_LAST
783
} virDomainFSDriverType;
784

785
/* Filesystem mount access mode  */
786
typedef enum {
787 788 789 790 791
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
792
} virDomainFSAccessMode;
793

794
/* Filesystem Write policy */
795
typedef enum {
796 797 798 799
    VIR_DOMAIN_FS_WRPOLICY_DEFAULT = 0,
    VIR_DOMAIN_FS_WRPOLICY_IMMEDIATE,

    VIR_DOMAIN_FS_WRPOLICY_LAST
800
} virDomainFSWrpolicy;
801

802 803 804 805 806 807 808 809 810 811 812 813
/* How to handle exports containing multiple devices. */
typedef enum {
    VIR_DOMAIN_FS_MULTIDEVS_DEFAULT = 0, /* Use QEMU's default setting */
    VIR_DOMAIN_FS_MULTIDEVS_REMAP, /* Remap inodes from host to guest */
    VIR_DOMAIN_FS_MULTIDEVS_FORBID, /* Prohibit more than one device */
    VIR_DOMAIN_FS_MULTIDEVS_WARN, /* Just log a warning if multiple devices */

    VIR_DOMAIN_FS_MULTIDEVS_LAST
} virDomainFSMultidevs;

VIR_ENUM_DECL(virDomainFSMultidevs);

814 815 816 817 818 819 820 821 822
typedef enum {
    VIR_DOMAIN_FS_MODEL_DEFAULT = 0,
    VIR_DOMAIN_FS_MODEL_VIRTIO,
    VIR_DOMAIN_FS_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_FS_MODEL_VIRTIO_NON_TRANSITIONAL,

    VIR_DOMAIN_FS_MODEL_LAST
} virDomainFSModel;

823 824 825 826 827 828 829 830
typedef enum {
    VIR_DOMAIN_FS_CACHE_MODE_DEFAULT = 0,
    VIR_DOMAIN_FS_CACHE_MODE_NONE,
    VIR_DOMAIN_FS_CACHE_MODE_ALWAYS,

    VIR_DOMAIN_FS_CACHE_MODE_LAST
} virDomainFSCacheMode;

831 832
struct _virDomainFSDef {
    int type;
833 834
    int fsdriver; /* enum virDomainFSDriverType */
    int accessmode; /* enum virDomainFSAccessMode */
835
    int wrpolicy; /* enum virDomainFSWrpolicy */
836
    int format; /* virStorageFileFormat */
837
    int model; /* virDomainFSModel */
838
    int multidevs; /* virDomainFSMultidevs */
839
    unsigned long long usage; /* in bytes */
840
    virStorageSourcePtr src;
841
    char *dst;
842
    bool readonly;
843
    virDomainDeviceInfo info;
844 845
    unsigned long long space_hard_limit; /* in bytes */
    unsigned long long space_soft_limit; /* in bytes */
846
    bool symlinksResolved;
847 848 849 850 851 852
    char *binary;
    unsigned long long queue_size;
    virTristateSwitch xattr;
    virDomainFSCacheMode cache;
    virTristateSwitch posix_lock;
    virTristateSwitch flock;
853
    virDomainVirtioOptionsPtr virtio;
854
    virObjectPtr privateData;
855 856 857
};


858
/* network config types */
859
typedef enum {
860 861
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
M
Michele Paolino 已提交
862
    VIR_DOMAIN_NET_TYPE_VHOSTUSER,
863 864 865 866 867
    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 已提交
868
    VIR_DOMAIN_NET_TYPE_INTERNAL,
869
    VIR_DOMAIN_NET_TYPE_DIRECT,
870
    VIR_DOMAIN_NET_TYPE_HOSTDEV,
871
    VIR_DOMAIN_NET_TYPE_UDP,
872

873
    VIR_DOMAIN_NET_TYPE_LAST
874
} virDomainNetType;
875

876 877 878 879
/* network model types */
typedef enum {
    VIR_DOMAIN_NET_MODEL_UNKNOWN,
    VIR_DOMAIN_NET_MODEL_NETFRONT,
C
Cole Robinson 已提交
880 881 882
    VIR_DOMAIN_NET_MODEL_RTL8139,
    VIR_DOMAIN_NET_MODEL_VIRTIO,
    VIR_DOMAIN_NET_MODEL_E1000,
883 884 885 886 887 888 889
    VIR_DOMAIN_NET_MODEL_E1000E,
    VIR_DOMAIN_NET_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_NET_MODEL_VIRTIO_NON_TRANSITIONAL,
    VIR_DOMAIN_NET_MODEL_USB_NET,
    VIR_DOMAIN_NET_MODEL_SPAPR_VLAN,
    VIR_DOMAIN_NET_MODEL_LAN9118,
    VIR_DOMAIN_NET_MODEL_SMC91C111,
C
Cole Robinson 已提交
890 891 892 893
    VIR_DOMAIN_NET_MODEL_VLANCE,
    VIR_DOMAIN_NET_MODEL_VMXNET,
    VIR_DOMAIN_NET_MODEL_VMXNET2,
    VIR_DOMAIN_NET_MODEL_VMXNET3,
C
Cole Robinson 已提交
894 895 896 897 898
    VIR_DOMAIN_NET_MODEL_AM79C970A,
    VIR_DOMAIN_NET_MODEL_AM79C973,
    VIR_DOMAIN_NET_MODEL_82540EM,
    VIR_DOMAIN_NET_MODEL_82545EM,
    VIR_DOMAIN_NET_MODEL_82543GC,
899 900 901 902

    VIR_DOMAIN_NET_MODEL_LAST
} virDomainNetModelType;

903
/* the backend driver used for virtio interfaces */
904
typedef enum {
905 906 907 908
    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 */

909
    VIR_DOMAIN_NET_BACKEND_TYPE_LAST
910
} virDomainNetBackendType;
911

912
/* the TX algorithm used for virtio interfaces */
913
typedef enum {
914 915 916 917
    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,

918
    VIR_DOMAIN_NET_VIRTIO_TX_MODE_LAST
919
} virDomainNetVirtioTxModeType;
920

921 922 923 924 925 926 927 928 929
/* the type of teaming device */
typedef enum {
    VIR_DOMAIN_NET_TEAMING_TYPE_NONE,
    VIR_DOMAIN_NET_TEAMING_TYPE_PERSISTENT,
    VIR_DOMAIN_NET_TEAMING_TYPE_TRANSIENT,

    VIR_DOMAIN_NET_TEAMING_TYPE_LAST
} virDomainNetTeamingType;

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

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

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

1076 1077 1078 1079 1080 1081 1082 1083
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;

1084
VIR_ENUM_DECL(virDomainChrDeviceState);
1085

1086
typedef enum {
1087
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
1088 1089
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
1090
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
1091

1092
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST
1093
} virDomainChrDeviceType;
1094

1095
typedef enum {
1096 1097
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_ISA,
G
Guannan Ren 已提交
1098
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_USB,
M
Michal Privoznik 已提交
1099
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_PCI,
1100
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SPAPR_VIO,
1101
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SYSTEM,
1102
    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_SCLP,
G
Guannan Ren 已提交
1103 1104

    VIR_DOMAIN_CHR_SERIAL_TARGET_TYPE_LAST
1105
} virDomainChrSerialTargetType;
G
Guannan Ren 已提交
1106

1107
typedef enum {
1108 1109
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_NONE = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD,
1110
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,
J
Joao Martins 已提交
1111
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_XEN,
1112

1113
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST
1114
} virDomainChrChannelTargetType;
1115

1116
typedef enum {
1117 1118
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_NONE  = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL,
1119 1120
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
1121
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
1122 1123
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LXC,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_OPENVZ,
1124 1125
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLP,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SCLPLM,
1126

1127
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST
1128
} virDomainChrConsoleTargetType;
1129

1130 1131 1132 1133 1134
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,
1135
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SPAPR_VTY,
1136
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_PL011,
1137 1138
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPCONSOLE,
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_SCLPLMCONSOLE,
1139
    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_16550A,
1140 1141 1142 1143 1144 1145

    VIR_DOMAIN_CHR_SERIAL_TARGET_MODEL_LAST
} virDomainChrSerialTargetModel;

VIR_ENUM_DECL(virDomainChrSerialTargetModel);

1146
typedef enum {
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
    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,
1157
    VIR_DOMAIN_CHR_TYPE_SPICEVMC,
1158
    VIR_DOMAIN_CHR_TYPE_SPICEPORT,
1159
    VIR_DOMAIN_CHR_TYPE_NMDM,
1160

1161
    VIR_DOMAIN_CHR_TYPE_LAST
1162
} virDomainChrType;
1163

1164
typedef enum {
1165
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW = 0,
1166
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
1167 1168
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
1169

1170
    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST
1171
} virDomainChrTcpProtocol;
1172

1173
typedef enum {
E
Eric Blake 已提交
1174 1175
    VIR_DOMAIN_CHR_SPICEVMC_VDAGENT,
    VIR_DOMAIN_CHR_SPICEVMC_SMARTCARD,
1176
    VIR_DOMAIN_CHR_SPICEVMC_USBREDIR,
E
Eric Blake 已提交
1177

1178
    VIR_DOMAIN_CHR_SPICEVMC_LAST
1179
} virDomainChrSpicevmcName;
E
Eric Blake 已提交
1180

1181 1182 1183 1184 1185 1186 1187

struct _virDomainChrSourceReconnectDef {
    virTristateBool enabled;
    unsigned int timeout;
};


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

    size_t nseclabels;
    virSecurityDeviceLabelDefPtr *seclabels;
1234 1235 1236 1237
};

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

1240 1241 1242
    int targetType; /* enum virDomainChrConsoleTargetType ||
                       enum virDomainChrChannelTargetType ||
                       enum virDomainChrSerialTargetType according to deviceType */
1243
    int targetModel; /* enum virDomainChrSerialTargetModel */
1244

1245 1246 1247 1248 1249 1250
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

1251 1252
    virDomainChrDeviceState state;

1253
    virDomainChrSourceDefPtr source;
1254 1255

    virDomainDeviceInfo info;
1256 1257
};

1258
typedef enum {
E
Eric Blake 已提交
1259 1260 1261 1262
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

1263
    VIR_DOMAIN_SMARTCARD_TYPE_LAST
1264
} virDomainSmartcardType;
E
Eric Blake 已提交
1265

1266 1267
#define VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES 3
#define VIR_DOMAIN_SMARTCARD_DEFAULT_DATABASE "/etc/pki/nssdb"
E
Eric Blake 已提交
1268 1269 1270 1271 1272 1273 1274 1275 1276

struct _virDomainSmartcardDef {
    int type; /* virDomainSmartcardType */
    union {
        /* no extra data for 'host' */
        struct {
            char *file[VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES];
            char *database;
        } cert; /* 'host-certificates' */
1277
        virDomainChrSourceDefPtr passthru; /* 'passthrough' */
E
Eric Blake 已提交
1278 1279 1280 1281 1282
    } data;

    virDomainDeviceInfo info;
};

M
Marc-André Lureau 已提交
1283 1284 1285 1286 1287
struct _virDomainHubDef {
    int type;
    virDomainDeviceInfo info;
};

1288
typedef enum {
1289
    VIR_DOMAIN_TPM_MODEL_DEFAULT,
1290
    VIR_DOMAIN_TPM_MODEL_TIS,
1291
    VIR_DOMAIN_TPM_MODEL_CRB,
1292
    VIR_DOMAIN_TPM_MODEL_SPAPR,
1293 1294

    VIR_DOMAIN_TPM_MODEL_LAST
1295
} virDomainTPMModel;
1296

1297
typedef enum {
1298
    VIR_DOMAIN_TPM_TYPE_PASSTHROUGH,
1299
    VIR_DOMAIN_TPM_TYPE_EMULATOR,
1300 1301

    VIR_DOMAIN_TPM_TYPE_LAST
1302
} virDomainTPMBackendType;
1303

1304 1305 1306 1307 1308 1309 1310 1311
typedef enum {
    VIR_DOMAIN_TPM_VERSION_DEFAULT,
    VIR_DOMAIN_TPM_VERSION_1_2,
    VIR_DOMAIN_TPM_VERSION_2_0,

    VIR_DOMAIN_TPM_VERSION_LAST
} virDomainTPMVersion;

1312
#define VIR_DOMAIN_TPM_DEFAULT_DEVICE "/dev/tpm0"
1313 1314

struct _virDomainTPMDef {
1315
    int type; /* virDomainTPMBackendType */
1316
    virDomainDeviceInfo info;
1317 1318
    int model; /* virDomainTPMModel */
    int version; /* virDomainTPMVersion */
1319 1320 1321 1322
    union {
        struct {
            virDomainChrSourceDef source;
        } passthrough;
1323 1324 1325 1326
        struct {
            virDomainChrSourceDef source;
            char *storagepath;
            char *logfile;
1327 1328
            unsigned char secretuuid[VIR_UUID_BUFLEN];
            bool hassecretuuid;
1329
        } emulator;
1330 1331 1332
    } data;
};

1333
typedef enum {
1334 1335
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,
L
Li Zhang 已提交
1336
    VIR_DOMAIN_INPUT_TYPE_KBD,
1337
    VIR_DOMAIN_INPUT_TYPE_PASSTHROUGH,
1338

1339
    VIR_DOMAIN_INPUT_TYPE_LAST
1340
} virDomainInputType;
1341

1342
typedef enum {
1343 1344 1345
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,
1346
    VIR_DOMAIN_INPUT_BUS_PARALLELS, /* pseudo device for VNC in containers */
1347
    VIR_DOMAIN_INPUT_BUS_VIRTIO,
1348 1349

    VIR_DOMAIN_INPUT_BUS_LAST
1350
} virDomainInputBus;
1351

1352 1353 1354 1355 1356 1357 1358 1359 1360
typedef enum {
    VIR_DOMAIN_INPUT_MODEL_DEFAULT = 0,
    VIR_DOMAIN_INPUT_MODEL_VIRTIO,
    VIR_DOMAIN_INPUT_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_INPUT_MODEL_VIRTIO_NON_TRANSITIONAL,

    VIR_DOMAIN_INPUT_MODEL_LAST
} virDomainInputModel;

1361 1362 1363
struct _virDomainInputDef {
    int type;
    int bus;
1364
    int model; /* virDomainInputModel */
1365 1366 1367
    struct {
        char *evdev;
    } source;
1368
    virDomainDeviceInfo info;
1369
    virDomainVirtioOptionsPtr virtio;
1370 1371
};

1372
typedef enum {
1373 1374
    VIR_DOMAIN_SOUND_CODEC_TYPE_DUPLEX,
    VIR_DOMAIN_SOUND_CODEC_TYPE_MICRO,
F
Filip Alac 已提交
1375
    VIR_DOMAIN_SOUND_CODEC_TYPE_OUTPUT,
1376 1377

    VIR_DOMAIN_SOUND_CODEC_TYPE_LAST
1378
} virDomainSoundCodecType;
1379

1380
typedef enum {
1381 1382 1383
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
1384
    VIR_DOMAIN_SOUND_MODEL_AC97,
1385
    VIR_DOMAIN_SOUND_MODEL_ICH6,
1386
    VIR_DOMAIN_SOUND_MODEL_ICH9,
1387
    VIR_DOMAIN_SOUND_MODEL_USB,
1388 1389

    VIR_DOMAIN_SOUND_MODEL_LAST
1390
} virDomainSoundModel;
1391

1392 1393 1394 1395 1396
struct _virDomainSoundCodecDef {
    int type;
    int cad;
};

1397 1398
struct _virDomainSoundDef {
    int model;
1399
    virDomainDeviceInfo info;
1400

1401
    size_t ncodecs;
1402
    virDomainSoundCodecDefPtr *codecs;
1403 1404
};

1405
typedef enum {
R
Richard Jones 已提交
1406 1407
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,
1408
    VIR_DOMAIN_WATCHDOG_MODEL_DIAG288,
R
Richard Jones 已提交
1409 1410

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
1411
} virDomainWatchdogModel;
R
Richard Jones 已提交
1412

1413
typedef enum {
R
Richard Jones 已提交
1414 1415 1416 1417
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
1418
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
1419
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,
1420
    VIR_DOMAIN_WATCHDOG_ACTION_INJECTNMI,
R
Richard Jones 已提交
1421 1422

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
1423
} virDomainWatchdogAction;
R
Richard Jones 已提交
1424 1425 1426 1427

struct _virDomainWatchdogDef {
    int model;
    int action;
1428
    virDomainDeviceInfo info;
R
Richard Jones 已提交
1429 1430
};

1431

1432 1433
/* the backend driver used for virtio interfaces */
typedef enum {
1434
    VIR_DOMAIN_VIDEO_BACKEND_TYPE_DEFAULT = 0,
1435 1436 1437 1438 1439 1440 1441
    VIR_DOMAIN_VIDEO_BACKEND_TYPE_QEMU,
    VIR_DOMAIN_VIDEO_BACKEND_TYPE_VHOSTUSER,

    VIR_DOMAIN_VIDEO_BACKEND_TYPE_LAST
} virDomainVideoBackendType;


1442
typedef enum {
1443
    VIR_DOMAIN_VIDEO_TYPE_DEFAULT,
1444 1445 1446 1447 1448
    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,
1449
    VIR_DOMAIN_VIDEO_TYPE_QXL,
1450
    VIR_DOMAIN_VIDEO_TYPE_PARALLELS, /* pseudo device for VNC in containers */
M
Marc-André Lureau 已提交
1451
    VIR_DOMAIN_VIDEO_TYPE_VIRTIO,
F
Fabian Freyer 已提交
1452
    VIR_DOMAIN_VIDEO_TYPE_GOP,
1453
    VIR_DOMAIN_VIDEO_TYPE_NONE,
1454
    VIR_DOMAIN_VIDEO_TYPE_BOCHS,
1455
    VIR_DOMAIN_VIDEO_TYPE_RAMFB,
1456 1457

    VIR_DOMAIN_VIDEO_TYPE_LAST
1458
} virDomainVideoType;
1459 1460


1461 1462 1463 1464 1465 1466 1467 1468
typedef enum {
    VIR_DOMAIN_VIDEO_VGACONF_IO = 0,
    VIR_DOMAIN_VIDEO_VGACONF_ON,
    VIR_DOMAIN_VIDEO_VGACONF_OFF,

    VIR_DOMAIN_VIDEO_VGACONF_LAST
} virDomainVideoVGAConf;

1469
VIR_ENUM_DECL(virDomainVideoVGAConf);
1470

1471
struct _virDomainVideoAccelDef {
1472 1473
    int accel2d; /* enum virTristateBool */
    int accel3d; /* enum virTristateBool */
1474
    char *rendernode;
1475 1476
};

1477 1478 1479 1480
struct _virDomainVideoResolutionDef {
    unsigned int x;
    unsigned int y;
};
1481

1482 1483
struct _virDomainVideoDriverDef {
   virDomainVideoVGAConf vgaconf;
1484
    char *vhost_user_binary;
1485 1486
};

1487
struct _virDomainVideoDef {
1488 1489
    virObjectPtr privateData;

1490
    int type;   /* enum virDomainVideoType */
1491 1492
    unsigned int ram;  /* kibibytes (multiples of 1024) */
    unsigned int vram; /* kibibytes (multiples of 1024) */
1493
    unsigned int vram64; /* kibibytes (multiples of 1024) */
1494
    unsigned int vgamem; /* kibibytes (multiples of 1024) */
1495
    unsigned int heads;
1496
    bool primary;
1497
    virDomainVideoAccelDefPtr accel;
1498
    virDomainVideoResolutionDefPtr res;
1499
    virDomainVideoDriverDefPtr driver;
1500
    virDomainDeviceInfo info;
J
Ján Tomko 已提交
1501
    virDomainVirtioOptionsPtr virtio;
1502
    virDomainVideoBackendType backend;
1503 1504
};

1505
/* graphics console modes */
1506
typedef enum {
1507 1508
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
1509 1510
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
1511
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
1512
    VIR_DOMAIN_GRAPHICS_TYPE_EGL_HEADLESS,
1513

1514
    VIR_DOMAIN_GRAPHICS_TYPE_LAST
1515
} virDomainGraphicsType;
1516

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

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

1535 1536
struct _virDomainGraphicsAuthDef {
    char *passwd;
1537
    bool expires; /* Whether there is an expiry time set */
1538
    time_t validTo;  /* seconds since epoch */
1539
    int connected; /* action if connected */
1540 1541
};

1542
typedef enum {
1543 1544 1545 1546 1547 1548
    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 已提交
1549
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_SMARTCARD,
1550
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_USBREDIR,
1551 1552

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
1553
} virDomainGraphicsSpiceChannelName;
1554

1555
typedef enum {
1556 1557 1558 1559 1560
    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
1561
} virDomainGraphicsSpiceChannelMode;
1562

1563
typedef enum {
1564 1565 1566 1567 1568 1569 1570 1571 1572
    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
1573
} virDomainGraphicsSpiceImageCompression;
1574

1575
typedef enum {
1576 1577 1578 1579 1580 1581
    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
1582
} virDomainGraphicsSpiceJpegCompression;
1583

1584
typedef enum {
1585 1586 1587 1588 1589 1590
    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
1591
} virDomainGraphicsSpiceZlibCompression;
1592

1593
typedef enum {
P
Peng Zhou 已提交
1594 1595 1596 1597 1598
    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
1599
} virDomainGraphicsSpiceMouseMode;
P
Peng Zhou 已提交
1600

1601
typedef enum {
1602 1603 1604 1605 1606 1607
    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
1608
} virDomainGraphicsSpiceStreamingMode;
1609

1610
typedef enum {
1611 1612 1613
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NONE = 0,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_ADDRESS,
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_NETWORK,
1614
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_SOCKET,
1615

1616
    VIR_DOMAIN_GRAPHICS_LISTEN_TYPE_LAST
1617
} virDomainGraphicsListenType;
1618

1619
typedef enum {
M
Marc-André Lureau 已提交
1620 1621
    VIR_DOMAIN_HUB_TYPE_USB,

1622
    VIR_DOMAIN_HUB_TYPE_LAST
1623
} virDomainHubType;
M
Marc-André Lureau 已提交
1624

1625
struct _virDomainGraphicsListenDef {
1626
    virDomainGraphicsListenType type;
1627 1628
    char *address;
    char *network;
1629
    char *socket;
1630
    bool fromConfig;    /* true if the @address is config file originated */
1631
    bool autoGenerated;
1632 1633
};

1634
struct _virDomainGraphicsDef {
1635 1636
    virObjectPtr privateData;

M
Michal Privoznik 已提交
1637 1638 1639 1640 1641
    /* 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.
     */
1642
    virDomainGraphicsType type;
1643 1644 1645
    union {
        struct {
            int port;
1646
            bool portReserved;
M
Martin Kletzander 已提交
1647
            int websocket;
1648
            bool websocketGenerated;
1649
            bool autoport;
1650
            char *keymap;
1651
            virDomainGraphicsAuthDef auth;
1652
            int sharePolicy;
1653 1654 1655 1656
        } vnc;
        struct {
            char *display;
            char *xauth;
1657
            bool fullscreen;
1658
            virTristateBool gl;
1659
        } sdl;
1660 1661
        struct {
            int port;
1662 1663 1664
            bool autoport;
            bool replaceUser;
            bool multiUser;
1665 1666 1667
        } rdp;
        struct {
            char *display;
1668
            bool fullscreen;
1669
        } desktop;
1670 1671 1672
        struct {
            int port;
            int tlsPort;
1673 1674
            bool portReserved;
            bool tlsPortReserved;
1675
            virDomainGraphicsSpiceMouseMode mousemode;
1676
            char *keymap;
1677
            virDomainGraphicsAuthDef auth;
1678
            bool autoport;
1679
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
1680
            virDomainGraphicsSpiceChannelMode defaultMode;
1681 1682 1683 1684
            int image;
            int jpeg;
            int zlib;
            int playback;
1685
            int streaming;
1686 1687 1688
            virTristateBool copypaste;
            virTristateBool filetransfer;
            virTristateBool gl;
1689
            char *rendernode;
1690
        } spice;
1691 1692 1693
        struct {
            char *rendernode;
        } egl_headless;
1694
    } data;
1695 1696 1697 1698 1699
    /* 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;
1700 1701
};

1702
typedef enum {
1703 1704 1705
    VIR_DOMAIN_REDIRDEV_BUS_USB,

    VIR_DOMAIN_REDIRDEV_BUS_LAST
1706
} virDomainRedirdevBus;
1707 1708 1709 1710

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

1711
    virDomainChrSourceDefPtr source;
1712 1713 1714

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

1716
struct _virDomainRedirFilterUSBDevDef {
1717 1718 1719 1720
    int usbClass;
    int vendor;
    int product;
    int version;
1721
    bool allow;
1722 1723 1724 1725
};

struct _virDomainRedirFilterDef {
    size_t nusbdevs;
1726
    virDomainRedirFilterUSBDevDefPtr *usbdevs;
1727 1728
};

1729
typedef enum {
1730 1731
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
1732
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
1733 1734
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO_NON_TRANSITIONAL,
1735 1736

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
1737
} virDomainMemballoonModel;
1738 1739 1740 1741

struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
1742
    int period; /* seconds between collections */
1743
    int autodeflate; /* enum virTristateSwitch */
1744
    virDomainVirtioOptionsPtr virtio;
1745 1746
};

L
Li Zhang 已提交
1747 1748 1749
struct _virDomainNVRAMDef {
    virDomainDeviceInfo info;
};
1750

1751 1752
typedef enum {
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM,
1753 1754
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_PLAIN,
    VIR_DOMAIN_SHMEM_MODEL_IVSHMEM_DOORBELL,
1755 1756 1757 1758

    VIR_DOMAIN_SHMEM_MODEL_LAST
} virDomainShmemModel;

1759 1760 1761
struct _virDomainShmemDef {
    char *name;
    unsigned long long size;
1762
    int model; /* enum virDomainShmemModel */
1763 1764
    struct {
        bool enabled;
1765
        virDomainChrSourceDef chr;
1766 1767 1768 1769 1770 1771 1772 1773 1774
    } server;
    struct {
        bool enabled;
        unsigned vectors;
        virTristateSwitch ioeventfd;
    } msi;
    virDomainDeviceInfo info;
};

1775
typedef enum {
1776
    VIR_DOMAIN_SMBIOS_NONE = 0,
1777 1778 1779 1780 1781
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
1782
} virDomainSmbiosMode;
1783

1784

1785
#define VIR_DOMAIN_MAX_BOOT_DEVS 4
1786

1787
typedef enum {
1788 1789 1790 1791 1792
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

1793
    VIR_DOMAIN_BOOT_LAST
1794
} virDomainBootOrder;
1795

1796
typedef enum {
1797 1798 1799
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
1800
    VIR_DOMAIN_FEATURE_HAP,
1801
    VIR_DOMAIN_FEATURE_VIRIDIAN,
1802
    VIR_DOMAIN_FEATURE_PRIVNET,
1803
    VIR_DOMAIN_FEATURE_HYPERV,
1804
    VIR_DOMAIN_FEATURE_KVM,
1805
    VIR_DOMAIN_FEATURE_PVSPINLOCK,
1806
    VIR_DOMAIN_FEATURE_CAPABILITIES,
1807
    VIR_DOMAIN_FEATURE_PMU,
1808
    VIR_DOMAIN_FEATURE_VMPORT,
M
Michal Privoznik 已提交
1809
    VIR_DOMAIN_FEATURE_GIC,
M
Michal Privoznik 已提交
1810
    VIR_DOMAIN_FEATURE_SMM,
1811
    VIR_DOMAIN_FEATURE_IOAPIC,
1812
    VIR_DOMAIN_FEATURE_HPT,
M
Marc-André Lureau 已提交
1813
    VIR_DOMAIN_FEATURE_VMCOREINFO,
1814
    VIR_DOMAIN_FEATURE_HTM,
1815
    VIR_DOMAIN_FEATURE_NESTED_HV,
1816
    VIR_DOMAIN_FEATURE_MSRS,
1817
    VIR_DOMAIN_FEATURE_CCF_ASSIST,
1818
    VIR_DOMAIN_FEATURE_XEN,
1819
    VIR_DOMAIN_FEATURE_CFPC,
1820
    VIR_DOMAIN_FEATURE_SBBC,
1821 1822

    VIR_DOMAIN_FEATURE_LAST
1823
} virDomainFeature;
1824

1825
#define VIR_DOMAIN_HYPERV_VENDOR_ID_MAX 12
1826

1827
typedef enum {
1828
    VIR_DOMAIN_HYPERV_RELAXED = 0,
1829 1830
    VIR_DOMAIN_HYPERV_VAPIC,
    VIR_DOMAIN_HYPERV_SPINLOCKS,
1831 1832 1833 1834 1835 1836
    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,
1837
    VIR_DOMAIN_HYPERV_FREQUENCIES,
1838
    VIR_DOMAIN_HYPERV_REENLIGHTENMENT,
1839
    VIR_DOMAIN_HYPERV_TLBFLUSH,
1840
    VIR_DOMAIN_HYPERV_IPI,
1841
    VIR_DOMAIN_HYPERV_EVMCS,
1842 1843

    VIR_DOMAIN_HYPERV_LAST
1844
} virDomainHyperv;
1845

1846 1847
typedef enum {
    VIR_DOMAIN_KVM_HIDDEN = 0,
1848
    VIR_DOMAIN_KVM_DEDICATED,
1849 1850 1851 1852

    VIR_DOMAIN_KVM_LAST
} virDomainKVM;

1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865
typedef enum {
    VIR_DOMAIN_MSRS_UNKNOWN = 0,

    VIR_DOMAIN_MSRS_LAST
} virDomainMsrs;

typedef enum {
    VIR_DOMAIN_MSRS_UNKNOWN_IGNORE = 0,
    VIR_DOMAIN_MSRS_UNKNOWN_FAULT,

    VIR_DOMAIN_MSRS_UNKNOWN_LAST
} virDomainMsrsUnknown;

1866 1867
typedef enum {
    VIR_DOMAIN_XEN_E820_HOST = 0,
1868
    VIR_DOMAIN_XEN_PASSTHROUGH,
1869 1870 1871 1872

    VIR_DOMAIN_XEN_LAST
} virDomainXen;

1873 1874 1875 1876 1877 1878 1879 1880
typedef enum {
    VIR_DOMAIN_XEN_PASSTHROUGH_MODE_DEFAULT = 0,
    VIR_DOMAIN_XEN_PASSTHROUGH_MODE_SYNC_PT,
    VIR_DOMAIN_XEN_PASSTHROUGH_MODE_SHARE_PT,

    VIR_DOMAIN_XEN_PASSTHROUGH_MODE_LAST
} virDomainXenPassthroughMode;

1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
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 {
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929
    VIR_DOMAIN_PROCES_CAPS_FEATURE_AUDIT_CONTROL = 0,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_AUDIT_WRITE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_BLOCK_SUSPEND,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_CHOWN,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_DAC_OVERRIDE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_DAC_READ_SEARCH,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_FOWNER,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_FSETID,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_IPC_LOCK,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_IPC_OWNER,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_KILL,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_LEASE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_LINUX_IMMUTABLE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_MAC_ADMIN,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_MAC_OVERRIDE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_MKNOD,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_NET_ADMIN,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_NET_BIND_SERVICE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_NET_BROADCAST,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_NET_RAW,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SETGID,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SETFCAP,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SETPCAP,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SETUID,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_ADMIN,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_BOOT,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_CHROOT,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_MODULE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_NICE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_PACCT,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_PTRACE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_RAWIO,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_RESOURCE,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_TIME,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYS_TTY_CONFIG,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_SYSLOG,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_WAKE_ALARM,
    VIR_DOMAIN_PROCES_CAPS_FEATURE_LAST
} virDomainProcessCapsFeature;
1930

1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
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;

1941
VIR_ENUM_DECL(virDomainLockFailure);
1942

M
Michal Privoznik 已提交
1943
struct _virDomainBIOSDef {
J
Ján Tomko 已提交
1944
    int useserial; /* enum virTristateBool */
1945 1946 1947
    /* reboot-timeout parameters */
    bool rt_set;
    int rt_delay;
M
Michal Privoznik 已提交
1948 1949
};

1950
typedef enum {
1951 1952
    VIR_DOMAIN_LOADER_TYPE_NONE = 0,
    VIR_DOMAIN_LOADER_TYPE_ROM,
1953 1954 1955 1956 1957
    VIR_DOMAIN_LOADER_TYPE_PFLASH,

    VIR_DOMAIN_LOADER_TYPE_LAST
} virDomainLoader;

1958
VIR_ENUM_DECL(virDomainLoader);
1959 1960 1961 1962 1963

struct _virDomainLoaderDef {
    char *path;
    int readonly;   /* enum virTristateBool */
    virDomainLoader type;
1964
    int secure;     /* enum virTristateBool */
1965
    char *nvram;    /* path to non-volatile RAM */
1966
    char *templt;   /* user override of path to master nvram */
1967 1968 1969 1970
};

void virDomainLoaderDefFree(virDomainLoaderDefPtr loader);

1971
typedef enum {
1972 1973
    VIR_DOMAIN_IOAPIC_NONE = 0,
    VIR_DOMAIN_IOAPIC_QEMU,
1974 1975 1976 1977 1978 1979 1980
    VIR_DOMAIN_IOAPIC_KVM,

    VIR_DOMAIN_IOAPIC_LAST
} virDomainIOAPIC;

VIR_ENUM_DECL(virDomainIOAPIC);

1981
typedef enum {
1982 1983
    VIR_DOMAIN_HPT_RESIZING_NONE = 0,
    VIR_DOMAIN_HPT_RESIZING_ENABLED,
1984 1985 1986 1987 1988 1989 1990 1991
    VIR_DOMAIN_HPT_RESIZING_DISABLED,
    VIR_DOMAIN_HPT_RESIZING_REQUIRED,

    VIR_DOMAIN_HPT_RESIZING_LAST
} virDomainHPTResizing;

VIR_ENUM_DECL(virDomainHPTResizing);

1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
typedef enum {
    VIR_DOMAIN_CFPC_NONE = 0,
    VIR_DOMAIN_CFPC_BROKEN,
    VIR_DOMAIN_CFPC_WORKAROUND,
    VIR_DOMAIN_CFPC_FIXED,

    VIR_DOMAIN_CFPC_LAST
} virDomainCFPC;

VIR_ENUM_DECL(virDomainCFPC);

2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
typedef enum {
    VIR_DOMAIN_SBBC_NONE = 0,
    VIR_DOMAIN_SBBC_BROKEN,
    VIR_DOMAIN_SBBC_WORKAROUND,
    VIR_DOMAIN_SBBC_FIXED,

    VIR_DOMAIN_SBBC_LAST
} virDomainSBBC;

VIR_ENUM_DECL(virDomainSBBC);

2014
/* Operating system configuration data & machine / arch */
2015 2016 2017 2018 2019
struct _virDomainOSEnv {
    char *name;
    char *value;
};

2020 2021
typedef enum {
    VIR_DOMAIN_OS_DEF_FIRMWARE_NONE = 0,
2022 2023
    VIR_DOMAIN_OS_DEF_FIRMWARE_BIOS = VIR_DOMAIN_LOADER_TYPE_ROM,
    VIR_DOMAIN_OS_DEF_FIRMWARE_EFI = VIR_DOMAIN_LOADER_TYPE_PFLASH,
2024 2025 2026 2027

    VIR_DOMAIN_OS_DEF_FIRMWARE_LAST
} virDomainOsDefFirmware;

2028 2029
G_STATIC_ASSERT((int)VIR_DOMAIN_OS_DEF_FIRMWARE_LAST == (int)VIR_DOMAIN_LOADER_TYPE_LAST);

2030 2031
VIR_ENUM_DECL(virDomainOsDefFirmware);

2032
struct _virDomainOSDef {
2033
    int type;
2034
    virDomainOsDefFirmware firmware;
2035
    virArch arch;
2036
    char *machine;
2037
    size_t nBootDevs;
2038
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
J
Ján Tomko 已提交
2039
    int bootmenu; /* enum virTristateBool */
2040 2041
    unsigned int bm_timeout;
    bool bm_timeout_set;
2042
    char *init;
2043
    char **initargv;
2044
    virDomainOSEnvPtr *initenv;
2045
    char *initdir;
2046 2047
    char *inituser;
    char *initgroup;
2048 2049 2050
    char *kernel;
    char *initrd;
    char *cmdline;
2051
    char *dtb;
2052
    char *root;
J
Ján Tomko 已提交
2053
    char *slic_table;
2054
    virDomainLoaderDefPtr loader;
2055 2056
    char *bootloader;
    char *bootloaderArgs;
2057
    int smbios_mode;
2058

M
Michal Privoznik 已提交
2059
    virDomainBIOSDef bios;
2060 2061
};

2062
typedef enum {
2063 2064 2065 2066 2067
    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 已提交
2068
    VIR_DOMAIN_TIMER_NAME_KVMCLOCK,
2069
    VIR_DOMAIN_TIMER_NAME_HYPERVCLOCK,
2070
    VIR_DOMAIN_TIMER_NAME_ARMVTIMER,
2071

2072
    VIR_DOMAIN_TIMER_NAME_LAST
2073
} virDomainTimerNameType;
2074

2075
typedef enum {
2076 2077 2078
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
2079

2080
    VIR_DOMAIN_TIMER_TRACK_LAST
2081
} virDomainTimerTrackType;
2082

2083
typedef enum {
2084 2085 2086 2087 2088
    VIR_DOMAIN_TIMER_TICKPOLICY_DELAY = 0,
    VIR_DOMAIN_TIMER_TICKPOLICY_CATCHUP,
    VIR_DOMAIN_TIMER_TICKPOLICY_MERGE,
    VIR_DOMAIN_TIMER_TICKPOLICY_DISCARD,

2089
    VIR_DOMAIN_TIMER_TICKPOLICY_LAST
2090
} virDomainTimerTickpolicyType;
2091

2092
typedef enum {
2093 2094 2095 2096
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
2097
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
2098

2099
    VIR_DOMAIN_TIMER_MODE_LAST
2100
} virDomainTimerModeType;
2101

2102
typedef enum {
2103
    VIR_DOMAIN_CPU_PLACEMENT_MODE_STATIC = 0,
O
Osier Yang 已提交
2104 2105
    VIR_DOMAIN_CPU_PLACEMENT_MODE_AUTO,

2106
    VIR_DOMAIN_CPU_PLACEMENT_MODE_LAST
2107
} virDomainCpuPlacementMode;
O
Osier Yang 已提交
2108

2109
struct _virDomainThreadSchedParam {
2110
    virProcessSchedPolicy policy;
2111 2112 2113
    int priority;
};

2114 2115 2116 2117 2118 2119
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

2120 2121 2122 2123 2124
struct _virDomainTimerDef {
    int name;
    int present;    /* unspecified = -1, no = 0, yes = 1 */
    int tickpolicy; /* none|catchup|merge|discard */

2125 2126 2127
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
L
Leonid Bloch 已提交
2128
    int track;  /* boot|guest|wall */
2129 2130 2131 2132 2133 2134

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

2135
typedef enum {
2136 2137
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
2138
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
2139
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
2140

2141
    VIR_DOMAIN_CLOCK_OFFSET_LAST
2142
} virDomainClockOffsetType;
2143

2144
typedef enum {
2145 2146 2147
    VIR_DOMAIN_CLOCK_BASIS_UTC = 0,
    VIR_DOMAIN_CLOCK_BASIS_LOCALTIME = 1,

2148
    VIR_DOMAIN_CLOCK_BASIS_LAST
2149
} virDomainClockBasis;
2150

2151 2152
struct _virDomainClockDef {
    int offset;
2153

2154
    union {
2155 2156 2157
        /* Bug-compatibility-mode for Xen utc|localtime */
        int utc_reset;
        /* Adjustment in seconds, relative to UTC or LOCALTIME, when
2158
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
2159 2160 2161
        struct {
            long long adjustment;
            int basis;
2162 2163 2164 2165 2166 2167 2168

            /* 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;
2169
        } variable;
2170 2171 2172 2173 2174

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

2176
    size_t ntimers;
2177
    virDomainTimerDefPtr *timers;
2178 2179
};

2180

2181
struct _virBlkioDevice {
2182 2183
    char *path;
    unsigned int weight;
2184 2185 2186 2187
    unsigned int riops;
    unsigned int wiops;
    unsigned long long rbps;
    unsigned long long wbps;
2188 2189
};

2190
typedef enum {
2191
    VIR_DOMAIN_RNG_MODEL_VIRTIO,
2192 2193
    VIR_DOMAIN_RNG_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_RNG_MODEL_VIRTIO_NON_TRANSITIONAL,
2194 2195

    VIR_DOMAIN_RNG_MODEL_LAST
2196
} virDomainRNGModel;
2197

2198
typedef enum {
2199 2200
    VIR_DOMAIN_RNG_BACKEND_RANDOM,
    VIR_DOMAIN_RNG_BACKEND_EGD,
H
Han Han 已提交
2201
    VIR_DOMAIN_RNG_BACKEND_BUILTIN,
2202 2203

    VIR_DOMAIN_RNG_BACKEND_LAST
2204
} virDomainRNGBackend;
2205 2206 2207 2208

struct _virDomainRNGDef {
    int model;
    int backend;
2209 2210
    unsigned int rate; /* bytes per period */
    unsigned int period; /* milliseconds */
2211 2212 2213 2214 2215 2216 2217 2218

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

    virDomainDeviceInfo info;
2219
    virDomainVirtioOptionsPtr virtio;
2220 2221
};

2222 2223 2224
typedef enum {
    VIR_DOMAIN_MEMORY_MODEL_NONE,
    VIR_DOMAIN_MEMORY_MODEL_DIMM, /* dimm hotpluggable memory device */
M
Michal Privoznik 已提交
2225
    VIR_DOMAIN_MEMORY_MODEL_NVDIMM, /* nvdimm memory device */
2226 2227 2228 2229 2230

    VIR_DOMAIN_MEMORY_MODEL_LAST
} virDomainMemoryModel;

struct _virDomainMemoryDef {
2231
    virDomainMemoryAccess access;
2232
    virTristateBool discard;
2233

2234 2235 2236
    /* source */
    virBitmapPtr sourceNodes;
    unsigned long long pagesize; /* kibibytes */
M
Michal Privoznik 已提交
2237
    char *nvdimmPath;
2238
    unsigned long long alignsize; /* kibibytes; valid only for NVDIMM */
2239
    bool nvdimmPmem; /* valid only for NVDIMM */
2240 2241 2242

    /* target */
    int model; /* virDomainMemoryModel */
2243
    int targetNode;
2244
    unsigned long long size; /* kibibytes */
2245
    unsigned long long labelsize; /* kibibytes; valid only for NVDIMM */
2246
    bool readonly; /* valid only for NVDIMM */
2247

2248 2249 2250
    /* required for QEMU NVDIMM ppc64 support */
    unsigned char uuid[VIR_UUID_BUFLEN];

2251 2252 2253 2254 2255
    virDomainDeviceInfo info;
};

void virDomainMemoryDefFree(virDomainMemoryDefPtr def);

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
struct _virDomainIdMapEntry {
    unsigned int start;
    unsigned int target;
    unsigned int count;
};

struct _virDomainIdMapDef {
    size_t nuidmap;
    virDomainIdMapEntryPtr uidmap;

    size_t ngidmap;
    virDomainIdMapEntryPtr gidmap;
};


2271 2272 2273 2274 2275
typedef enum {
    VIR_DOMAIN_PANIC_MODEL_DEFAULT,
    VIR_DOMAIN_PANIC_MODEL_ISA,
    VIR_DOMAIN_PANIC_MODEL_PSERIES,
    VIR_DOMAIN_PANIC_MODEL_HYPERV,
2276
    VIR_DOMAIN_PANIC_MODEL_S390,
2277 2278 2279 2280

    VIR_DOMAIN_PANIC_MODEL_LAST
} virDomainPanicModel;

H
Hu Tao 已提交
2281
struct _virDomainPanicDef {
2282
    int model; /* virDomainPanicModel */
H
Hu Tao 已提交
2283 2284 2285 2286
    virDomainDeviceInfo info;
};


2287
void virBlkioDeviceArrayClear(virBlkioDevicePtr deviceWeights,
2288
                              int ndevices);
2289

2290 2291 2292
struct _virDomainResourceDef {
    char *partition;
};
2293

2294
struct _virDomainHugePage {
2295 2296 2297 2298
    virBitmapPtr nodemask;      /* guest's NUMA node mask */
    unsigned long long size;    /* hugepage size in KiB */
};

2299
#define VIR_DOMAIN_CPUMASK_LEN 1024
2300

2301 2302 2303
struct _virDomainIOThreadIDDef {
    bool autofill;
    unsigned int iothread_id;
2304
    int thread_id;
2305
    virBitmapPtr cpumask;
2306 2307

    virDomainThreadSchedParam sched;
2308 2309 2310 2311
};

void virDomainIOThreadIDDefFree(virDomainIOThreadIDDefPtr def);

2312

2313
struct _virDomainCputune {
2314
    unsigned long long shares;
2315 2316 2317
    bool sharesSpecified;
    unsigned long long period;
    long long quota;
2318
    unsigned long long global_period;
2319
    long long global_quota;
2320 2321
    unsigned long long emulator_period;
    long long emulator_quota;
2322 2323
    unsigned long long iothread_period;
    long long iothread_quota;
2324
    virBitmapPtr emulatorpin;
2325
    virDomainThreadSchedParamPtr emulatorsched;
2326 2327
};

2328

2329 2330 2331 2332 2333 2334
struct _virDomainResctrlMonDef {
    virBitmapPtr vcpus;
    virResctrlMonitorType tag;
    virResctrlMonitorPtr instance;
};

B
Bing Niu 已提交
2335
struct _virDomainResctrlDef {
2336 2337
    virBitmapPtr vcpus;
    virResctrlAllocPtr alloc;
2338 2339 2340

    virDomainResctrlMonDefPtr *monitors;
    size_t nmonitors;
2341 2342 2343
};


2344
struct _virDomainVcpuDef {
2345
    bool online;
2346 2347 2348
    virTristateBool hotpluggable;
    unsigned int order;

2349
    virBitmapPtr cpumask;
2350 2351

    virDomainThreadSchedParam sched;
2352 2353

    virObjectPtr privateData;
2354 2355
};

2356 2357 2358 2359 2360 2361 2362 2363
struct _virDomainBlkiotune {
    unsigned int weight;

    size_t ndevices;
    virBlkioDevicePtr devices;
};

struct _virDomainMemtune {
2364 2365 2366
    /* total memory size including memory modules in kibibytes, this field
     * should be accessed only via accessors */
    unsigned long long total_memory;
2367 2368
    unsigned long long cur_balloon; /* in kibibytes, capped at ulong thanks
                                       to virDomainGetInfo */
2369 2370 2371 2372

    virDomainHugePagePtr hugepages;
    size_t nhugepages;

2373 2374 2375 2376
    /* 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 */

2377 2378 2379
    bool nosharepages;
    bool locked;
    int dump_core; /* enum virTristateSwitch */
2380 2381 2382 2383
    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 */
2384 2385 2386 2387

    int source; /* enum virDomainMemorySource */
    int access; /* enum virDomainMemoryAccess */
    int allocation; /* enum virDomainMemoryAllocation */
2388 2389

    virTristateBool discard;
2390 2391 2392 2393 2394 2395 2396 2397
};

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

Q
Qiaowei Ren 已提交
2398 2399 2400 2401 2402
struct _virDomainPerfDef {
    /* These options are of type enum virTristateBool */
    int events[VIR_PERF_EVENT_LAST];
};

2403 2404 2405 2406 2407
struct _virDomainKeyWrapDef {
    int aes; /* enum virTristateSwitch */
    int dea; /* enum virTristateSwitch */
};

2408 2409 2410 2411 2412 2413 2414 2415
typedef enum {
    VIR_DOMAIN_LAUNCH_SECURITY_NONE,
    VIR_DOMAIN_LAUNCH_SECURITY_SEV,

    VIR_DOMAIN_LAUNCH_SECURITY_LAST,
} virDomainLaunchSecurity;


2416
struct _virDomainSEVDef {
2417 2418 2419 2420 2421 2422 2423 2424 2425
    int sectype; /* enum virDomainLaunchSecurity */
    char *dh_cert;
    char *session;
    unsigned int policy;
    unsigned int cbitpos;
    unsigned int reduced_phys_bits;
};


J
Ján Tomko 已提交
2426 2427
typedef enum {
    VIR_DOMAIN_IOMMU_MODEL_INTEL,
2428
    VIR_DOMAIN_IOMMU_MODEL_SMMUV3,
J
Ján Tomko 已提交
2429 2430 2431 2432 2433 2434

    VIR_DOMAIN_IOMMU_MODEL_LAST
} virDomainIOMMUModel;

struct _virDomainIOMMUDef {
    virDomainIOMMUModel model;
2435
    virTristateSwitch intremap;
2436
    virTristateSwitch caching_mode;
2437
    virTristateSwitch eim;
J
Ján Tomko 已提交
2438
    virTristateSwitch iotlb;
J
Ján Tomko 已提交
2439
};
2440

J
Ján Tomko 已提交
2441 2442 2443
typedef enum {
    VIR_DOMAIN_VSOCK_MODEL_DEFAULT,
    VIR_DOMAIN_VSOCK_MODEL_VIRTIO,
2444 2445
    VIR_DOMAIN_VSOCK_MODEL_VIRTIO_TRANSITIONAL,
    VIR_DOMAIN_VSOCK_MODEL_VIRTIO_NON_TRANSITIONAL,
J
Ján Tomko 已提交
2446 2447 2448 2449

    VIR_DOMAIN_VSOCK_MODEL_LAST
} virDomainVsockModel;

J
Ján Tomko 已提交
2450
struct _virDomainVsockDef {
2451
    virObjectPtr privateData;
J
Ján Tomko 已提交
2452 2453 2454 2455 2456 2457

    virDomainVsockModel model;
    unsigned int guest_cid;
    virTristateBool auto_cid;

    virDomainDeviceInfo info;
J
Ján Tomko 已提交
2458 2459
};

2460 2461 2462
struct _virDomainVirtioOptions {
    virTristateSwitch iommu;
    virTristateSwitch ats;
2463
    virTristateSwitch packed;
2464 2465
};

2466 2467 2468 2469 2470 2471
/*
 * Guest VM main configuration
 *
 * NB: if adding to this struct, virDomainDefCheckABIStability
 * may well need an update
 */
2472
struct _virDomainDef {
2473
    int virtType; /* enum virDomainVirtType */
2474 2475
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
2476 2477 2478 2479 2480

    unsigned char genid[VIR_UUID_BUFLEN];
    bool genidRequested;
    bool genidGenerated;

2481
    char *name;
2482
    char *title;
2483
    char *description;
2484

2485 2486
    virDomainBlkiotune blkio;
    virDomainMemtune mem;
2487

2488
    virDomainVcpuDefPtr *vcpus;
2489
    size_t maxvcpus;
2490 2491
    /* set if the vcpu definition was specified individually */
    bool individualvcpus;
O
Osier Yang 已提交
2492
    int placement_mode;
H
Hu Tao 已提交
2493
    virBitmapPtr cpumask;
2494

2495 2496
    size_t niothreadids;
    virDomainIOThreadIDDefPtr *iothreadids;
2497

2498
    virDomainCputune cputune;
2499

B
Bing Niu 已提交
2500 2501
    virDomainResctrlDefPtr *resctrls;
    size_t nresctrls;
2502

2503
    virDomainNumaPtr numa;
2504
    virDomainResourceDefPtr resource;
2505
    virDomainIdMapDef idmap;
2506

2507 2508 2509 2510 2511
    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

2512 2513
    int onLockFailure; /* enum virDomainLockFailureAction */

2514
    virDomainPowerManagement pm;
2515

2516
    virDomainPerfDef perf;
Q
Qiaowei Ren 已提交
2517

2518 2519
    virDomainOSDef os;
    char *emulator;
2520 2521 2522
    /* 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. */
2523
    int features[VIR_DOMAIN_FEATURE_LAST];
2524
    int caps_features[VIR_DOMAIN_PROCES_CAPS_FEATURE_LAST];
2525
    int hyperv_features[VIR_DOMAIN_HYPERV_LAST];
2526
    int kvm_features[VIR_DOMAIN_KVM_LAST];
2527
    int msrs_features[VIR_DOMAIN_MSRS_LAST];
2528
    int xen_features[VIR_DOMAIN_XEN_LAST];
2529
    int xen_passthrough_mode;
2530
    unsigned int hyperv_spinlocks;
2531
    int hyperv_stimer_direct;
2532
    virGICVersion gic_version;
2533
    virDomainHPTResizing hpt_resizing;
2534
    unsigned long long hpt_maxpagesize; /* Stored in KiB */
2535
    char *hyperv_vendor_id;
2536
    int apic_eoi;
2537

2538 2539 2540
    bool tseg_specified;
    unsigned long long tseg_size;

2541
    virDomainClockDef clock;
2542

2543
    size_t ngraphics;
2544
    virDomainGraphicsDefPtr *graphics;
2545

2546
    size_t ndisks;
2547 2548
    virDomainDiskDefPtr *disks;

2549
    size_t ncontrollers;
2550 2551
    virDomainControllerDefPtr *controllers;

2552
    size_t nfss;
2553 2554
    virDomainFSDefPtr *fss;

2555
    size_t nnets;
2556 2557
    virDomainNetDefPtr *nets;

2558
    size_t ninputs;
2559 2560
    virDomainInputDefPtr *inputs;

2561
    size_t nsounds;
2562 2563
    virDomainSoundDefPtr *sounds;

2564
    size_t nvideos;
2565 2566
    virDomainVideoDefPtr *videos;

2567
    size_t nhostdevs;
2568 2569
    virDomainHostdevDefPtr *hostdevs;

2570
    size_t nredirdevs;
2571 2572
    virDomainRedirdevDefPtr *redirdevs;

2573
    size_t nsmartcards;
E
Eric Blake 已提交
2574 2575
    virDomainSmartcardDefPtr *smartcards;

2576
    size_t nserials;
2577 2578
    virDomainChrDefPtr *serials;

2579
    size_t nparallels;
2580 2581
    virDomainChrDefPtr *parallels;

2582
    size_t nchannels;
2583 2584
    virDomainChrDefPtr *channels;

2585
    size_t nconsoles;
2586 2587
    virDomainChrDefPtr *consoles;

2588
    size_t nleases;
2589 2590
    virDomainLeaseDefPtr *leases;

2591
    size_t nhubs;
M
Marc-André Lureau 已提交
2592 2593
    virDomainHubDefPtr *hubs;

2594 2595 2596
    size_t nseclabels;
    virSecurityLabelDefPtr *seclabels;

2597 2598 2599
    size_t nrngs;
    virDomainRNGDefPtr *rngs;

2600 2601 2602
    size_t nshmems;
    virDomainShmemDefPtr *shmems;

2603 2604 2605
    size_t nmems;
    virDomainMemoryDefPtr *mems;

D
Dmitry Andreev 已提交
2606 2607 2608
    size_t npanics;
    virDomainPanicDefPtr *panics;

2609
    /* Only 1 */
R
Richard Jones 已提交
2610
    virDomainWatchdogDefPtr watchdog;
2611
    virDomainMemballoonDefPtr memballoon;
L
Li Zhang 已提交
2612
    virDomainNVRAMDefPtr nvram;
2613
    virDomainTPMDefPtr tpm;
2614
    virCPUDefPtr cpu;
2615
    virSysinfoDefPtr sysinfo;
2616
    virDomainRedirFilterDefPtr redirfilter;
J
Ján Tomko 已提交
2617
    virDomainIOMMUDefPtr iommu;
J
Ján Tomko 已提交
2618
    virDomainVsockDefPtr vsock;
2619 2620

    void *namespaceData;
2621
    virXMLNamespace ns;
2622

2623 2624
    virDomainKeyWrapDefPtr keywrap;

2625
    /* SEV-specific domain */
2626
    virDomainSEVDefPtr sev;
2627

2628 2629
    /* Application-specific custom metadata */
    xmlNodePtr metadata;
2630 2631 2632 2633 2634 2635

    /* 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 */
2636 2637
};

2638

2639
unsigned long long virDomainDefGetMemoryInitial(const virDomainDef *def);
2640
void virDomainDefSetMemoryTotal(virDomainDefPtr def, unsigned long long size);
2641
unsigned long long virDomainDefGetMemoryTotal(const virDomainDef *def);
2642
bool virDomainDefHasMemoryHotplug(const virDomainDef *def);
2643

2644 2645 2646 2647 2648 2649 2650
typedef enum {
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_AES,
    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_DEA,

    VIR_DOMAIN_KEY_WRAP_CIPHER_NAME_LAST
} virDomainKeyWrapCipherName;

2651
typedef enum {
2652 2653 2654 2655 2656
    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 */
2657
    VIR_DOMAIN_TAINT_EXTERNAL_LAUNCH,  /* Externally launched guest domain */
2658
    VIR_DOMAIN_TAINT_HOST_CPU,         /* Host CPU passthrough in use */
2659
    VIR_DOMAIN_TAINT_HOOK,             /* Domain (possibly) changed via hook script */
2660
    VIR_DOMAIN_TAINT_CDROM_PASSTHROUGH,/* CDROM passthrough */
Y
Yuri Chornoivan 已提交
2661
    VIR_DOMAIN_TAINT_CUSTOM_DTB,       /* Custom device tree blob was specified */
2662
    VIR_DOMAIN_TAINT_CUSTOM_GA_COMMAND, /* Custom guest agent command */
2663
    VIR_DOMAIN_TAINT_CUSTOM_HYPERVISOR_FEATURE, /* custom hypervisor feature control */
2664 2665

    VIR_DOMAIN_TAINT_LAST
2666
} virDomainTaintFlags;
2667

2668
/* Guest VM runtime state */
J
Jiri Denemark 已提交
2669 2670 2671 2672 2673 2674
typedef struct _virDomainStateReason virDomainStateReason;
struct _virDomainStateReason {
    int state;
    int reason;
};

2675
struct _virDomainObj {
2676
    virObjectLockable parent;
2677
    virCond cond;
2678

2679
    pid_t pid;
J
Jiri Denemark 已提交
2680
    virDomainStateReason state;
2681 2682 2683

    unsigned int autostart : 1;
    unsigned int persistent : 1;
2684
    unsigned int updated : 1;
2685
    unsigned int removing : 1;
2686 2687 2688

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

2690
    virDomainSnapshotObjListPtr snapshots;
C
Chris Lalancette 已提交
2691

2692 2693
    bool hasManagedSave;

2694 2695
    virDomainCheckpointObjListPtr checkpoints;

2696 2697
    void *privateData;
    void (*privateDataFreeFunc)(void *);
2698 2699

    int taint;
2700 2701 2702

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

2705 2706 2707
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainObj, virObjectUnref);


2708 2709
typedef bool (*virDomainObjListACLFilter)(virConnectPtr conn,
                                          virDomainDefPtr def);
2710

2711

2712 2713
/* NB: Any new flag to this list be considered to be set in
 * virt-aa-helper code if the flag prevents parsing. */
2714 2715
typedef enum {
    VIR_DOMAIN_DEF_FEATURE_WIDE_SCSI = (1 << 0),
2716
    VIR_DOMAIN_DEF_FEATURE_MEMORY_HOTPLUG = (1 << 1),
2717
    VIR_DOMAIN_DEF_FEATURE_OFFLINE_VCPUPIN = (1 << 2),
2718
    VIR_DOMAIN_DEF_FEATURE_NAME_SLASH = (1 << 3),
2719
    VIR_DOMAIN_DEF_FEATURE_INDIVIDUAL_VCPUS = (1 << 4),
2720
    VIR_DOMAIN_DEF_FEATURE_USER_ALIAS = (1 << 5),
2721
    VIR_DOMAIN_DEF_FEATURE_NO_BOOT_ORDER = (1 << 6),
2722
    VIR_DOMAIN_DEF_FEATURE_FW_AUTOSELECT = (1 << 7),
2723
    VIR_DOMAIN_DEF_FEATURE_NET_MODEL_STRING = (1 << 8),
2724 2725 2726
} virDomainDefFeatures;


2727 2728 2729 2730 2731 2732 2733
/* 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,
                                                  void *opaque);

2734
/* Called once after everything else has been parsed, for adjusting
2735 2736 2737
 * overall domain defaults.
 * @parseOpaque is opaque data passed by virDomainDefParse* caller,
 * @opaque is opaque data set by driver (usually pointer to driver
2738 2739 2740 2741
 * 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. */
2742
typedef int (*virDomainDefPostParseCallback)(virDomainDefPtr def,
2743
                                             unsigned int parseFlags,
2744 2745
                                             void *opaque,
                                             void *parseOpaque);
2746
/* Called once per device, for adjusting per-device settings while
2747 2748 2749 2750
 * 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). */
2751
typedef int (*virDomainDeviceDefPostParseCallback)(virDomainDeviceDefPtr dev,
2752
                                                   const virDomainDef *def,
2753
                                                   unsigned int parseFlags,
2754 2755
                                                   void *opaque,
                                                   void *parseOpaque);
2756
/* Drive callback for assigning device addresses, called at the end
2757 2758 2759 2760
 * 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). */
2761 2762
typedef int (*virDomainDefAssignAddressesCallback)(virDomainDef *def,
                                                   unsigned int parseFlags,
2763 2764
                                                   void *opaque,
                                                   void *parseOpaque);
2765

2766 2767 2768 2769 2770 2771
typedef int (*virDomainDefPostParseDataAlloc)(const virDomainDef *def,
                                              unsigned int parseFlags,
                                              void *opaque,
                                              void **parseOpaque);
typedef void (*virDomainDefPostParseDataFree)(void *parseOpaque);

2772 2773 2774 2775 2776
/* 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,
                                            void *opaque);
2777

2778 2779 2780 2781 2782 2783
/* 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);

2784
struct _virDomainDefParserConfig {
2785
    /* driver domain definition callbacks */
2786
    virDomainDefPostParseBasicCallback domainPostParseBasicCallback;
2787
    virDomainDefPostParseDataAlloc domainPostParseDataAlloc;
2788 2789
    virDomainDefPostParseCallback domainPostParseCallback;
    virDomainDeviceDefPostParseCallback devicesPostParseCallback;
2790
    virDomainDefAssignAddressesCallback assignAddressesCallback;
2791
    virDomainDefPostParseDataFree domainPostParseDataFree;
2792

2793 2794
    /* validation callbacks */
    virDomainDefValidateCallback domainValidateCallback;
2795
    virDomainDeviceDefValidateCallback deviceValidateCallback;
2796

2797
    /* private data for the callbacks */
2798 2799
    void *priv;
    virFreeCallback privFree;
2800 2801

    /* data */
2802
    unsigned int features; /* virDomainDefFeatures */
2803
    unsigned char macPrefix[VIR_MAC_PREFIX_BUFLEN];
2804
    virArch defArch;
2805
    const char *netPrefix;
2806
    const char *defSecModel;
2807 2808
};

2809
typedef void *(*virDomainXMLPrivateDataAllocFunc)(void *);
2810 2811 2812 2813 2814 2815 2816 2817
typedef void (*virDomainXMLPrivateDataFreeFunc)(void *);
typedef virObjectPtr (*virDomainXMLPrivateDataNewFunc)(void);
typedef int (*virDomainXMLPrivateDataFormatFunc)(virBufferPtr,
                                                 virDomainObjPtr);
typedef int (*virDomainXMLPrivateDataParseFunc)(xmlXPathContextPtr,
                                                virDomainObjPtr,
                                                virDomainDefParserConfigPtr);

2818 2819
typedef void *(*virDomainXMLPrivateDataGetParseOpaqueFunc)(virDomainObjPtr vm);

2820 2821 2822 2823 2824
typedef int (*virDomainXMLPrivateDataDiskParseFunc)(xmlXPathContextPtr ctxt,
                                                    virDomainDiskDefPtr disk);
typedef int (*virDomainXMLPrivateDataDiskFormatFunc)(virDomainDiskDefPtr disk,
                                                     virBufferPtr buf);

2825 2826 2827 2828 2829 2830
typedef int (*virDomainXMLPrivateDataStorageSourceParseFunc)(xmlXPathContextPtr ctxt,
                                                             virStorageSourcePtr src);
typedef int (*virDomainXMLPrivateDataStorageSourceFormatFunc)(virStorageSourcePtr src,
                                                              virBufferPtr buf);


2831 2832 2833
struct _virDomainXMLPrivateDataCallbacks {
    virDomainXMLPrivateDataAllocFunc  alloc;
    virDomainXMLPrivateDataFreeFunc   free;
2834 2835
    /* note that private data for devices are not copied when using
     * virDomainDefCopy and similar functions */
2836
    virDomainXMLPrivateDataNewFunc    diskNew;
2837 2838
    virDomainXMLPrivateDataDiskParseFunc diskParse;
    virDomainXMLPrivateDataDiskFormatFunc diskFormat;
2839
    virDomainXMLPrivateDataNewFunc    vcpuNew;
2840
    virDomainXMLPrivateDataNewFunc    chrSourceNew;
2841
    virDomainXMLPrivateDataNewFunc    vsockNew;
2842
    virDomainXMLPrivateDataNewFunc    graphicsNew;
2843
    virDomainXMLPrivateDataNewFunc    networkNew;
2844
    virDomainXMLPrivateDataNewFunc    videoNew;
2845
    virDomainXMLPrivateDataNewFunc    fsNew;
2846 2847
    virDomainXMLPrivateDataFormatFunc format;
    virDomainXMLPrivateDataParseFunc  parse;
2848 2849 2850
    /* following function shall return a pointer which will be used as the
     * 'parseOpaque' argument for virDomainDefPostParse */
    virDomainXMLPrivateDataGetParseOpaqueFunc getParseOpaque;
2851 2852
    virDomainXMLPrivateDataStorageSourceParseFunc storageParse;
    virDomainXMLPrivateDataStorageSourceFormatFunc storageFormat;
2853 2854
};

2855 2856 2857 2858 2859 2860 2861
typedef bool (*virDomainABIStabilityDomain)(const virDomainDef *src,
                                            const virDomainDef *dst);

struct _virDomainABIStability {
    virDomainABIStabilityDomain domain;
};

2862 2863
virDomainXMLOptionPtr virDomainXMLOptionNew(virDomainDefParserConfigPtr config,
                                            virDomainXMLPrivateDataCallbacksPtr priv,
2864
                                            virXMLNamespacePtr xmlns,
2865 2866 2867 2868 2869
                                            virDomainABIStabilityPtr abi,
                                            virSaveCookieCallbacksPtr saveCookie);

virSaveCookieCallbacksPtr
virDomainXMLOptionGetSaveCookie(virDomainXMLOptionPtr xmlopt);
2870

2871 2872 2873 2874 2875 2876 2877
typedef int (*virDomainMomentPostParseCallback)(virDomainMomentDefPtr def);

void virDomainXMLOptionSetMomentPostParse(virDomainXMLOptionPtr xmlopt,
                                          virDomainMomentPostParseCallback cb);
int virDomainXMLOptionRunMomentPostParse(virDomainXMLOptionPtr xmlopt,
                                         virDomainMomentDefPtr def);

2878 2879
void virDomainNetGenerateMAC(virDomainXMLOptionPtr xmlopt, virMacAddrPtr mac);

2880
virXMLNamespacePtr
2881
virDomainXMLOptionGetNamespace(virDomainXMLOptionPtr xmlopt)
2882 2883
    ATTRIBUTE_NONNULL(1);

2884 2885 2886 2887
bool
virDomainSCSIDriveAddressIsUsed(const virDomainDef *def,
                                const virDomainDeviceDriveAddress *addr);

2888 2889 2890 2891
int virDomainDefPostParse(virDomainDefPtr def,
                          unsigned int parseFlags,
                          virDomainXMLOptionPtr xmlopt,
                          void *parseOpaque);
2892
bool virDomainDefHasUSB(const virDomainDef *def);
2893

2894 2895 2896 2897
int virDomainDeviceValidateAliasForHotplug(virDomainObjPtr vm,
                                           virDomainDeviceDefPtr dev,
                                           unsigned int flags);

2898 2899
bool virDomainDeviceAliasIsUserAlias(const char *aliasStr);

2900
int virDomainDefValidate(virDomainDefPtr def,
2901 2902 2903
                         unsigned int parseFlags,
                         virDomainXMLOptionPtr xmlopt);

2904 2905 2906
int
virDomainActualNetDefValidate(const virDomainNetDef *net);

2907
static inline bool
D
Daniel P. Berrange 已提交
2908
virDomainObjIsActive(virDomainObjPtr dom)
2909 2910 2911 2912
{
    return dom->def->id != -1;
}

2913 2914
int virDomainObjCheckActive(virDomainObjPtr dom);

2915 2916 2917 2918 2919 2920 2921 2922 2923
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)
2924
    G_GNUC_WARN_UNUSED_RESULT;
2925
void virDomainDefVcpuOrderClear(virDomainDefPtr def);
P
Peter Krempa 已提交
2926 2927
int  virDomainDefGetVcpusTopology(const virDomainDef *def,
                                  unsigned int *maxvcpus);
2928

2929
virDomainObjPtr virDomainObjNew(virDomainXMLOptionPtr caps)
2930
    ATTRIBUTE_NONNULL(1);
2931

M
Michal Privoznik 已提交
2932 2933
void virDomainObjEndAPI(virDomainObjPtr *vm);

2934
bool virDomainObjTaint(virDomainObjPtr obj,
2935
                       virDomainTaintFlags taint);
2936

2937 2938 2939 2940
void virDomainObjBroadcast(virDomainObjPtr vm);
int virDomainObjWait(virDomainObjPtr vm);
int virDomainObjWaitUntil(virDomainObjPtr vm,
                          unsigned long long whenms);
2941

H
Hu Tao 已提交
2942
void virDomainPanicDefFree(virDomainPanicDefPtr panic);
2943
void virDomainResourceDefFree(virDomainResourceDefPtr resource);
2944
void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
J
Ján Tomko 已提交
2945
const char *virDomainInputDefGetPath(virDomainInputDefPtr input);
2946
void virDomainInputDefFree(virDomainInputDefPtr def);
2947
virDomainDiskDefPtr virDomainDiskDefNew(virDomainXMLOptionPtr xmlopt);
2948
void virDomainDiskDefFree(virDomainDiskDefPtr def);
2949
void virDomainLeaseDefFree(virDomainLeaseDefPtr def);
2950 2951
int virDomainDiskGetType(virDomainDiskDefPtr def);
void virDomainDiskSetType(virDomainDiskDefPtr def, int type);
2952
const char *virDomainDiskGetSource(virDomainDiskDef const *def);
2953
int virDomainDiskSetSource(virDomainDiskDefPtr def, const char *src)
2954
    G_GNUC_WARN_UNUSED_RESULT;
2955
void virDomainDiskEmptySource(virDomainDiskDefPtr def);
2956
const char *virDomainDiskGetDriver(const virDomainDiskDef *def);
2957
int virDomainDiskSetDriver(virDomainDiskDefPtr def, const char *name)
2958
    G_GNUC_WARN_UNUSED_RESULT;
2959 2960
int virDomainDiskGetFormat(virDomainDiskDefPtr def);
void virDomainDiskSetFormat(virDomainDiskDefPtr def, int format);
2961 2962
virDomainControllerDefPtr
virDomainDeviceFindSCSIController(const virDomainDef *def,
2963 2964 2965 2966
                                  const virDomainDeviceDriveAddress *addr);
virDomainDiskDefPtr virDomainDiskFindByBusAndDst(virDomainDefPtr def,
                                                 int bus,
                                                 char *dst);
2967 2968

virDomainControllerDefPtr virDomainControllerDefNew(virDomainControllerType type);
2969
void virDomainControllerDefFree(virDomainControllerDefPtr def);
2970
bool virDomainControllerIsPSeriesPHB(const virDomainControllerDef *cont);
2971

2972
virDomainFSDefPtr virDomainFSDefNew(virDomainXMLOptionPtr xmlopt);
2973
void virDomainFSDefFree(virDomainFSDefPtr def);
2974
void virDomainActualNetDefFree(virDomainActualNetDefPtr def);
J
Ján Tomko 已提交
2975 2976
virDomainVsockDefPtr virDomainVsockDefNew(virDomainXMLOptionPtr xmlopt);
void virDomainVsockDefFree(virDomainVsockDefPtr vsock);
2977
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainVsockDef, virDomainVsockDefFree);
2978
void virDomainNetDefClear(virDomainNetDefPtr def);
2979
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
2980
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
2981
void virDomainChrDefFree(virDomainChrDefPtr def);
2982 2983
int virDomainChrSourceDefCopy(virDomainChrSourceDefPtr dest,
                              virDomainChrSourceDefPtr src);
2984
void virDomainSoundCodecDefFree(virDomainSoundCodecDefPtr def);
J
Jidong Xia 已提交
2985 2986
ssize_t virDomainSoundDefFind(const virDomainDef *def,
                              const virDomainSoundDef *sound);
2987
void virDomainSoundDefFree(virDomainSoundDefPtr def);
J
Jidong Xia 已提交
2988
virDomainSoundDefPtr virDomainSoundDefRemove(virDomainDefPtr def, size_t idx);
2989
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
L
Li Zhang 已提交
2990
void virDomainNVRAMDefFree(virDomainNVRAMDefPtr def);
R
Richard Jones 已提交
2991
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
2992
virDomainVideoDefPtr virDomainVideoDefNew(virDomainXMLOptionPtr xmlopt);
2993
void virDomainVideoDefFree(virDomainVideoDefPtr def);
2994
void virDomainVideoDefClear(virDomainVideoDefPtr def);
J
John Ferlan 已提交
2995
virDomainHostdevDefPtr virDomainHostdevDefNew(void);
2996
void virDomainHostdevDefClear(virDomainHostdevDefPtr def);
2997
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
M
Marc-André Lureau 已提交
2998
void virDomainHubDefFree(virDomainHubDefPtr def);
2999
void virDomainRedirdevDefFree(virDomainRedirdevDefPtr def);
3000
void virDomainRedirFilterDefFree(virDomainRedirFilterDefPtr def);
3001
void virDomainShmemDefFree(virDomainShmemDefPtr def);
3002
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
3003
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainDeviceDef, virDomainDeviceDefFree);
3004
virDomainDeviceDefPtr virDomainDeviceDefCopy(virDomainDeviceDefPtr src,
3005
                                             const virDomainDef *def,
3006 3007
                                             virDomainXMLOptionPtr xmlopt,
                                             void *parseOpaque);
3008
virDomainDeviceInfoPtr virDomainDeviceGetInfo(virDomainDeviceDefPtr device);
C
Cole Robinson 已提交
3009 3010
void virDomainDeviceSetData(virDomainDeviceDefPtr device,
                            void *devicedata);
3011
void virDomainTPMDefFree(virDomainTPMDefPtr def);
3012

3013
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
3014 3015
                                           virDomainDeviceDefPtr dev,
                                           virDomainDeviceInfoPtr info,
3016 3017 3018 3019 3020 3021
                                           void *opaque);

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

3022 3023
bool virDomainDefHasDeviceAddress(virDomainDefPtr def,
                                  virDomainDeviceInfoPtr info)
3024
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3025

3026
void virDomainDefFree(virDomainDefPtr vm);
3027
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainDef, virDomainDefFree);
3028

3029 3030 3031
virDomainChrSourceDefPtr
virDomainChrSourceDefNew(virDomainXMLOptionPtr xmlopt);

3032
virDomainChrDefPtr virDomainChrDefNew(virDomainXMLOptionPtr xmlopt);
M
Michal Novotny 已提交
3033

3034 3035
virDomainGraphicsDefPtr
virDomainGraphicsDefNew(virDomainXMLOptionPtr xmlopt);
3036 3037 3038 3039

virDomainNetDefPtr
virDomainNetDefNew(virDomainXMLOptionPtr xmlopt);

3040
virDomainDefPtr virDomainDefNew(void);
3041

3042
void virDomainObjAssignDef(virDomainObjPtr domain,
3043
                           virDomainDefPtr def,
3044 3045
                           bool live,
                           virDomainDefPtr *oldDef);
3046
int virDomainObjSetDefTransient(virDomainXMLOptionPtr xmlopt,
3047 3048
                                virDomainObjPtr domain,
                                void *parseOpaque);
3049
void virDomainObjRemoveTransientDef(virDomainObjPtr domain);
3050
virDomainDefPtr
3051
virDomainObjGetPersistentDef(virDomainXMLOptionPtr xmlopt,
3052 3053
                             virDomainObjPtr domain,
                             void *parseOpaque);
3054 3055 3056 3057 3058 3059 3060 3061

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

int virDomainObjGetDefs(virDomainObjPtr vm,
                        unsigned int flags,
                        virDomainDefPtr *liveDef,
                        virDomainDefPtr *persDef);
3062 3063 3064
virDomainDefPtr virDomainObjGetOneDefState(virDomainObjPtr vm,
                                           unsigned int flags,
                                           bool *state);
3065
virDomainDefPtr virDomainObjGetOneDef(virDomainObjPtr vm, unsigned int flags);
3066

3067 3068
virDomainDefPtr virDomainDefCopy(virDomainDefPtr src,
                                 virDomainXMLOptionPtr xmlopt,
3069
                                 void *parseOpaque,
3070 3071
                                 bool migratable);
virDomainDefPtr virDomainObjCopyPersistentDef(virDomainObjPtr dom,
3072 3073
                                              virDomainXMLOptionPtr xmlopt,
                                              void *parseOpaque);
3074

3075 3076 3077
typedef enum {
    /* parse internal domain status information */
    VIR_DOMAIN_DEF_PARSE_STATUS          = 1 << 0,
3078 3079 3080 3081
    /* 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. */
3082 3083 3084 3085 3086
    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,
3087
    /* internal flag passed to device info sub-parser to allow using <rom> */
3088
    VIR_DOMAIN_DEF_PARSE_ALLOW_ROM       = 1 << 4,
3089
    /* internal flag passed to device info sub-parser to allow specifying boot order */
3090 3091
    VIR_DOMAIN_DEF_PARSE_ALLOW_BOOT      = 1 << 5,
    /* parse only source half of <disk> */
3092
    VIR_DOMAIN_DEF_PARSE_DISK_SOURCE     = 1 << 6,
3093
    /* perform RNG schema validation on the passed XML document */
3094
    VIR_DOMAIN_DEF_PARSE_VALIDATE_SCHEMA = 1 << 7,
3095
    /* allow updates in post parse callback that would break ABI otherwise */
3096
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE = 1 << 8,
3097
    /* skip definition validation checks meant to be executed on define time only */
3098
    VIR_DOMAIN_DEF_PARSE_SKIP_VALIDATE = 1 << 9,
3099
    /* skip parsing of security labels */
3100
    VIR_DOMAIN_DEF_PARSE_SKIP_SECLABEL        = 1 << 10,
3101 3102 3103
    /* 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. */
3104
    VIR_DOMAIN_DEF_PARSE_ABI_UPDATE_MIGRATION = 1 << 11,
3105 3106 3107 3108
    /* 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 */
3109
    VIR_DOMAIN_DEF_PARSE_ALLOW_POST_PARSE_FAIL = 1 << 12,
3110 3111 3112 3113 3114
} virDomainDefParseFlags;

typedef enum {
    VIR_DOMAIN_DEF_FORMAT_SECURE          = 1 << 0,
    VIR_DOMAIN_DEF_FORMAT_INACTIVE        = 1 << 1,
3115
    VIR_DOMAIN_DEF_FORMAT_MIGRATABLE      = 1 << 2,
3116
    /* format internal domain status information */
3117
    VIR_DOMAIN_DEF_FORMAT_STATUS          = 1 << 3,
3118
    /* format <actual> element */
3119
    VIR_DOMAIN_DEF_FORMAT_ACTUAL_NET      = 1 << 4,
3120
    /* format original states of host PCI device */
3121 3122 3123 3124
    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,
3125 3126
} virDomainDefFormatFlags;

3127 3128 3129 3130 3131 3132 3133 3134 3135
/* 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;

3136
virDomainDeviceDefPtr virDomainDeviceDefParse(const char *xmlStr,
3137
                                              const virDomainDef *def,
3138
                                              virDomainXMLOptionPtr xmlopt,
3139
                                              void *parseOpaque,
L
Laine Stump 已提交
3140
                                              unsigned int flags);
3141 3142 3143
virDomainDiskDefPtr virDomainDiskDefParse(const char *xmlStr,
                                          virDomainXMLOptionPtr xmlopt,
                                          unsigned int flags);
3144
virDomainDefPtr virDomainDefParseString(const char *xmlStr,
3145
                                        virDomainXMLOptionPtr xmlopt,
3146
                                        void *parseOpaque,
L
Laine Stump 已提交
3147
                                        unsigned int flags);
3148
virDomainDefPtr virDomainDefParseFile(const char *filename,
3149
                                      virDomainXMLOptionPtr xmlopt,
3150
                                      void *parseOpaque,
L
Laine Stump 已提交
3151
                                      unsigned int flags);
3152
virDomainDefPtr virDomainDefParseNode(xmlDocPtr doc,
3153
                                      xmlNodePtr root,
3154
                                      virDomainXMLOptionPtr xmlopt,
3155
                                      void *parseOpaque,
L
Laine Stump 已提交
3156
                                      unsigned int flags);
3157 3158 3159 3160
virDomainObjPtr virDomainObjParseNode(xmlDocPtr xml,
                                      xmlNodePtr root,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
3161 3162 3163
virDomainObjPtr virDomainObjParseFile(const char *filename,
                                      virDomainXMLOptionPtr xmlopt,
                                      unsigned int flags);
3164

3165
bool virDomainDefCheckABIStability(virDomainDefPtr src,
3166 3167
                                   virDomainDefPtr dst,
                                   virDomainXMLOptionPtr xmlopt);
3168

3169 3170
bool virDomainDefCheckABIStabilityFlags(virDomainDefPtr src,
                                        virDomainDefPtr dst,
3171
                                        virDomainXMLOptionPtr xmlopt,
3172 3173
                                        unsigned int flags);

3174 3175
int virDomainDefAddImplicitDevices(virDomainDefPtr def,
                                   virDomainXMLOptionPtr xmlopt);
3176

3177
virDomainIOThreadIDDefPtr virDomainIOThreadIDFind(const virDomainDef *def,
3178 3179 3180 3181 3182
                                                  unsigned int iothread_id);
virDomainIOThreadIDDefPtr virDomainIOThreadIDAdd(virDomainDefPtr def,
                                                 unsigned int iothread_id);
void virDomainIOThreadIDDel(virDomainDefPtr def, unsigned int iothread_id);

3183 3184 3185 3186 3187 3188
/* When extending this list, remember that libvirt 1.2.12-5.0.0 had a
 * bug that silently ignored unknown flags.  A new flag to add
 * information is okay as long as clients still work when an older
 * server omits the requested output, but a new flag to suppress
 * information could result in a security hole when older libvirt
 * supplies the sensitive information in spite of the flag. */
3189
#define VIR_DOMAIN_XML_COMMON_FLAGS \
3190 3191
    (VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE | \
     VIR_DOMAIN_XML_MIGRATABLE)
3192 3193
unsigned int virDomainDefFormatConvertXMLFlags(unsigned int flags);

3194
char *virDomainDefFormat(virDomainDefPtr def,
3195 3196
                         virDomainXMLOptionPtr xmlopt,
                         unsigned int flags)
J
John Ferlan 已提交
3197
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3198 3199 3200
char *virDomainObjFormat(virDomainObjPtr obj,
                         virDomainXMLOptionPtr xmlopt,
                         unsigned int flags)
J
John Ferlan 已提交
3201
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3202
int virDomainDefFormatInternal(virDomainDefPtr def,
3203
                               virDomainXMLOptionPtr xmlopt,
3204
                               virBufferPtr buf,
3205 3206
                               unsigned int flags)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
J
John Ferlan 已提交
3207
    ATTRIBUTE_NONNULL(3);
3208
int virDomainDefFormatInternalSetRootName(virDomainDefPtr def,
3209
                                          virDomainXMLOptionPtr xmlopt,
3210
                                          virBufferPtr buf,
3211 3212 3213
                                          const char *rootname,
                                          unsigned int flags)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
J
John Ferlan 已提交
3214
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
3215

3216 3217
int virDomainDiskSourceFormat(virBufferPtr buf,
                              virStorageSourcePtr src,
3218
                              const char *element,
3219
                              int policy,
3220
                              bool attrIndex,
3221
                              unsigned int flags,
3222
                              bool formatsecrets,
3223
                              virDomainXMLOptionPtr xmlopt);
3224

3225 3226 3227 3228 3229 3230
int
virDomainDiskBackingStoreFormat(virBufferPtr buf,
                                virStorageSourcePtr src,
                                virDomainXMLOptionPtr xmlopt,
                                unsigned int flags);

3231 3232
int virDomainNetDefFormat(virBufferPtr buf,
                          virDomainNetDefPtr def,
3233
                          virDomainXMLOptionPtr xmlopt,
3234 3235
                          unsigned int flags);

3236 3237 3238 3239 3240 3241
typedef enum {
    VIR_DOMAIN_DEVICE_ACTION_ATTACH,
    VIR_DOMAIN_DEVICE_ACTION_DETACH,
    VIR_DOMAIN_DEVICE_ACTION_UPDATE,
} virDomainDeviceAction;

3242
int virDomainDefCompatibleDevice(virDomainDefPtr def,
3243
                                 virDomainDeviceDefPtr dev,
3244
                                 virDomainDeviceDefPtr oldDev,
3245 3246
                                 virDomainDeviceAction action,
                                 bool live);
3247

3248 3249
void virDomainRNGDefFree(virDomainRNGDefPtr def);

3250
int virDomainDiskIndexByAddress(virDomainDefPtr def,
3251
                                virPCIDeviceAddressPtr pci_controller,
3252 3253
                                unsigned int bus, unsigned int target,
                                unsigned int unit);
3254
virDomainDiskDefPtr virDomainDiskByAddress(virDomainDefPtr def,
3255
                                           virPCIDeviceAddressPtr pci_controller,
3256 3257 3258
                                           unsigned int bus,
                                           unsigned int target,
                                           unsigned int unit);
3259 3260
int virDomainDiskIndexByName(virDomainDefPtr def, const char *name,
                             bool allow_ambiguous);
3261 3262 3263
virDomainDiskDefPtr virDomainDiskByName(virDomainDefPtr def,
                                        const char *name,
                                        bool allow_ambiguous);
3264 3265 3266 3267
virDomainDiskDefPtr
virDomainDiskByTarget(virDomainDefPtr def,
                      const char *dst);

3268
int virDomainDiskInsert(virDomainDefPtr def,
3269
                        virDomainDiskDefPtr disk)
3270
    G_GNUC_WARN_UNUSED_RESULT;
3271 3272
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
3273 3274
int virDomainStorageNetworkParseHost(xmlNodePtr hostnode,
                                     virStorageNetHostDefPtr host);
3275
int virDomainDiskDefAssignAddress(virDomainXMLOptionPtr xmlopt,
3276 3277
                                  virDomainDiskDefPtr def,
                                  const virDomainDef *vmdef);
3278

3279 3280 3281 3282
virDomainDiskDefPtr
virDomainDiskRemove(virDomainDefPtr def, size_t i);
virDomainDiskDefPtr
virDomainDiskRemoveByName(virDomainDefPtr def, const char *name);
3283

3284 3285
int virDomainNetFindIdx(virDomainDefPtr def, virDomainNetDefPtr net);
virDomainNetDefPtr virDomainNetFind(virDomainDefPtr def, const char *device);
3286
virDomainNetDefPtr virDomainNetFindByName(virDomainDefPtr def, const char *ifname);
3287
bool virDomainHasNet(virDomainDefPtr def, virDomainNetDefPtr net);
3288
int virDomainNetInsert(virDomainDefPtr def, virDomainNetDefPtr net);
3289
int virDomainNetUpdate(virDomainDefPtr def, size_t netidx, virDomainNetDefPtr newnet);
3290 3291
int virDomainNetDHCPInterfaces(virDomainDefPtr def, virDomainInterfacePtr **ifaces);
int virDomainNetARPInterfaces(virDomainDefPtr def, virDomainInterfacePtr **ifaces);
3292
virDomainNetDefPtr virDomainNetRemove(virDomainDefPtr def, size_t i);
3293
void virDomainNetRemoveHostdev(virDomainDefPtr def, virDomainNetDefPtr net);
3294

L
Laine Stump 已提交
3295
int virDomainHostdevInsert(virDomainDefPtr def, virDomainHostdevDefPtr hostdev);
3296 3297
virDomainHostdevDefPtr
virDomainHostdevRemove(virDomainDefPtr def, size_t i);
L
Laine Stump 已提交
3298 3299 3300
int virDomainHostdevFind(virDomainDefPtr def, virDomainHostdevDefPtr match,
                         virDomainHostdevDefPtr *found);

3301 3302
virDomainGraphicsListenDefPtr
virDomainGraphicsGetListen(virDomainGraphicsDefPtr def, size_t i);
3303 3304
int virDomainGraphicsListenAppendAddress(virDomainGraphicsDefPtr def,
                                         const char *address)
3305
            ATTRIBUTE_NONNULL(1);
3306 3307 3308
int virDomainGraphicsListenAppendSocket(virDomainGraphicsDefPtr def,
                                        const char *socket)
            ATTRIBUTE_NONNULL(1);
3309

3310
virDomainNetType virDomainNetGetActualType(const virDomainNetDef *iface);
3311 3312 3313 3314
const char *virDomainNetGetActualBridgeName(const virDomainNetDef *iface);
int virDomainNetGetActualBridgeMACTableManager(const virDomainNetDef *iface);
const char *virDomainNetGetActualDirectDev(const virDomainNetDef *iface);
int virDomainNetGetActualDirectMode(const virDomainNetDef *iface);
3315
virDomainHostdevDefPtr virDomainNetGetActualHostdev(virDomainNetDefPtr iface);
3316
const virNetDevVPortProfile *
3317
virDomainNetGetActualVirtPortProfile(const virDomainNetDef *iface);
3318 3319
const virNetDevBandwidth *
virDomainNetGetActualBandwidth(const virDomainNetDef *iface);
3320
const virNetDevVlan *virDomainNetGetActualVlan(const virDomainNetDef *iface);
3321
bool virDomainNetGetActualTrustGuestRxFilters(const virDomainNetDef *iface);
3322 3323
virTristateBool
virDomainNetGetActualPortOptionsIsolated(const virDomainNetDef *iface);
3324 3325 3326
const char *virDomainNetGetModelString(const virDomainNetDef *net);
int virDomainNetSetModelString(virDomainNetDefPtr et,
                               const char *model);
3327
bool virDomainNetIsVirtioModel(const virDomainNetDef *net);
3328
int virDomainNetAppendIPAddress(virDomainNetDefPtr def,
3329 3330 3331
                                const char *address,
                                int family,
                                unsigned int prefix);
3332

3333
int virDomainControllerInsert(virDomainDefPtr def,
3334
                              virDomainControllerDefPtr controller)
3335
    G_GNUC_WARN_UNUSED_RESULT;
3336 3337
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);
3338
int virDomainControllerFind(const virDomainDef *def, int type, int idx);
3339
int virDomainControllerFindByType(virDomainDefPtr def, int type);
3340
int virDomainControllerFindByPCIAddress(virDomainDefPtr def,
3341
                                        virPCIDeviceAddressPtr addr);
3342
int virDomainControllerFindUnusedIndex(virDomainDef const *def, int type);
3343
virDomainControllerDefPtr virDomainControllerRemove(virDomainDefPtr def, size_t i);
3344
const char *virDomainControllerAliasFind(const virDomainDef *def,
3345 3346
                                         int type, int idx)
    ATTRIBUTE_NONNULL(1);
3347 3348 3349 3350 3351

int virDomainLeaseIndex(virDomainDefPtr def,
                        virDomainLeaseDefPtr lease);
int virDomainLeaseInsert(virDomainDefPtr def,
                         virDomainLeaseDefPtr lease);
3352
int virDomainLeaseInsertPreAlloc(virDomainDefPtr def)
3353
    G_GNUC_WARN_UNUSED_RESULT;
3354 3355
void virDomainLeaseInsertPreAlloced(virDomainDefPtr def,
                                    virDomainLeaseDefPtr lease);
3356 3357 3358 3359 3360
virDomainLeaseDefPtr
virDomainLeaseRemoveAt(virDomainDefPtr def, size_t i);
virDomainLeaseDefPtr
virDomainLeaseRemove(virDomainDefPtr def,
                     virDomainLeaseDefPtr lease);
3361

3362
void
3363
virDomainChrGetDomainPtrs(const virDomainDef *vmdef,
3364
                          virDomainChrDeviceType type,
3365 3366 3367
                          const virDomainChrDef ***arrPtr,
                          size_t *cntPtr)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
3368 3369 3370
virDomainChrDefPtr
virDomainChrFind(virDomainDefPtr def,
                 virDomainChrDefPtr target);
3371 3372 3373
bool
virDomainChrEquals(virDomainChrDefPtr src,
                   virDomainChrDefPtr tgt);
3374
int
3375 3376 3377 3378 3379
virDomainChrPreAlloc(virDomainDefPtr vmdef,
                     virDomainChrDefPtr chr);
void
virDomainChrInsertPreAlloced(virDomainDefPtr vmdef,
                             virDomainChrDefPtr chr);
3380 3381 3382 3383
virDomainChrDefPtr
virDomainChrRemove(virDomainDefPtr vmdef,
                   virDomainChrDefPtr chr);

3384 3385 3386
ssize_t virDomainRNGFind(virDomainDefPtr def, virDomainRNGDefPtr rng);
virDomainRNGDefPtr virDomainRNGRemove(virDomainDefPtr def, size_t idx);

3387 3388 3389 3390
ssize_t virDomainRedirdevDefFind(virDomainDefPtr def,
                                 virDomainRedirdevDefPtr redirdev);
virDomainRedirdevDefPtr virDomainRedirdevDefRemove(virDomainDefPtr def, size_t idx);

3391 3392 3393 3394 3395
int virDomainDefSave(virDomainDefPtr def,
                     virDomainXMLOptionPtr xmlopt,
                     const char *configDir)
    G_GNUC_WARN_UNUSED_RESULT
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
J
John Ferlan 已提交
3396
    ATTRIBUTE_NONNULL(3);
3397 3398 3399 3400 3401 3402

int virDomainObjSave(virDomainObjPtr obj,
                     virDomainXMLOptionPtr xmlopt,
                     const char *statusDir)
    G_GNUC_WARN_UNUSED_RESULT
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
J
John Ferlan 已提交
3403
    ATTRIBUTE_NONNULL(3);
3404

3405 3406 3407 3408
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

3409
int virDomainDeleteConfig(const char *configDir,
3410
                          const char *autostartDir,
3411 3412
                          virDomainObjPtr dom);

3413
char *virDomainConfigFile(const char *dir,
3414 3415
                          const char *name);

3416 3417 3418 3419
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

3420
virDomainFSDefPtr virDomainGetFilesystemForTarget(virDomainDefPtr def,
3421
                                                  const char *target);
3422
int virDomainFSInsert(virDomainDefPtr def, virDomainFSDefPtr fs);
3423
int virDomainFSIndexByName(virDomainDefPtr def, const char *name);
3424 3425
virDomainFSDefPtr virDomainFSRemove(virDomainDefPtr def, size_t i);

3426 3427
unsigned int virDomainVideoDefaultRAM(const virDomainDef *def,
                                      const virDomainVideoType type);
3428

E
Eric Blake 已提交
3429 3430 3431 3432 3433 3434 3435 3436 3437
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

3438 3439 3440 3441 3442 3443 3444 3445 3446
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

3447 3448 3449 3450 3451 3452 3453
typedef int (*virDomainUSBDeviceDefIterator)(virDomainDeviceInfoPtr info,
                                             void *opaque);
int virDomainUSBDeviceDefForeach(virDomainDefPtr def,
                                 virDomainUSBDeviceDefIterator iter,
                                 void *opaque,
                                 bool skipHubs);

J
Jiri Denemark 已提交
3454 3455 3456 3457 3458 3459 3460
void
virDomainObjSetState(virDomainObjPtr obj, virDomainState state, int reason)
        ATTRIBUTE_NONNULL(1);
virDomainState
virDomainObjGetState(virDomainObjPtr obj, int *reason)
        ATTRIBUTE_NONNULL(1);

3461 3462 3463
virSecurityLabelDefPtr
virDomainDefGetSecurityLabelDef(virDomainDefPtr def, const char *model);

3464
virSecurityDeviceLabelDefPtr
3465 3466
virDomainChrSourceDefGetSecurityLabelDef(virDomainChrSourceDefPtr def,
                                         const char *model);
3467

3468 3469
typedef const char* (*virEventActionToStringFunc)(int type);
typedef int (*virEventActionFromStringFunc)(const char *type);
3470

3471
int virDomainMemoryInsert(virDomainDefPtr def, virDomainMemoryDefPtr mem)
3472
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3473 3474 3475
virDomainMemoryDefPtr virDomainMemoryRemove(virDomainDefPtr def, int idx)
    ATTRIBUTE_NONNULL(1);
int virDomainMemoryFindByDef(virDomainDefPtr def, virDomainMemoryDefPtr mem)
3476
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3477 3478
int virDomainMemoryFindInactiveByDef(virDomainDefPtr def,
                                     virDomainMemoryDefPtr mem)
3479
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3480

3481
int virDomainShmemDefInsert(virDomainDefPtr def, virDomainShmemDefPtr shmem)
3482
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3483
bool virDomainShmemDefEquals(virDomainShmemDefPtr src, virDomainShmemDefPtr dst)
3484
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3485
ssize_t virDomainShmemDefFind(virDomainDefPtr def, virDomainShmemDefPtr shmem)
3486
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3487 3488
virDomainShmemDefPtr virDomainShmemDefRemove(virDomainDefPtr def, size_t idx)
    ATTRIBUTE_NONNULL(1);
3489 3490
ssize_t virDomainInputDefFind(const virDomainDef *def,
                              const virDomainInputDef *input)
3491
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3492 3493
bool virDomainVsockDefEquals(const virDomainVsockDef *a,
                             const virDomainVsockDef *b)
3494
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3495

3496 3497 3498 3499 3500
VIR_ENUM_DECL(virDomainTaint);
VIR_ENUM_DECL(virDomainVirt);
VIR_ENUM_DECL(virDomainBoot);
VIR_ENUM_DECL(virDomainFeature);
VIR_ENUM_DECL(virDomainCapabilitiesPolicy);
3501
VIR_ENUM_DECL(virDomainProcessCapsFeature);
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514
VIR_ENUM_DECL(virDomainLifecycle);
VIR_ENUM_DECL(virDomainLifecycleAction);
VIR_ENUM_DECL(virDomainDevice);
VIR_ENUM_DECL(virDomainDiskDevice);
VIR_ENUM_DECL(virDomainDiskGeometryTrans);
VIR_ENUM_DECL(virDomainDiskBus);
VIR_ENUM_DECL(virDomainDiskCache);
VIR_ENUM_DECL(virDomainDiskErrorPolicy);
VIR_ENUM_DECL(virDomainDiskIo);
VIR_ENUM_DECL(virDomainDeviceSGIO);
VIR_ENUM_DECL(virDomainDiskTray);
VIR_ENUM_DECL(virDomainDiskDiscard);
VIR_ENUM_DECL(virDomainDiskDetectZeroes);
3515
VIR_ENUM_DECL(virDomainDiskModel);
3516 3517 3518 3519 3520 3521 3522
VIR_ENUM_DECL(virDomainDiskMirrorState);
VIR_ENUM_DECL(virDomainController);
VIR_ENUM_DECL(virDomainControllerModelPCI);
VIR_ENUM_DECL(virDomainControllerPCIModelName);
VIR_ENUM_DECL(virDomainControllerModelSCSI);
VIR_ENUM_DECL(virDomainControllerModelUSB);
VIR_ENUM_DECL(virDomainControllerModelIDE);
3523
VIR_ENUM_DECL(virDomainControllerModelVirtioSerial);
3524 3525 3526 3527
VIR_ENUM_DECL(virDomainFS);
VIR_ENUM_DECL(virDomainFSDriver);
VIR_ENUM_DECL(virDomainFSAccessMode);
VIR_ENUM_DECL(virDomainFSWrpolicy);
3528
VIR_ENUM_DECL(virDomainFSModel);
3529
VIR_ENUM_DECL(virDomainFSCacheMode);
3530 3531 3532
VIR_ENUM_DECL(virDomainNet);
VIR_ENUM_DECL(virDomainNetBackend);
VIR_ENUM_DECL(virDomainNetVirtioTxMode);
3533
VIR_ENUM_DECL(virDomainNetTeaming);
3534
VIR_ENUM_DECL(virDomainNetInterfaceLinkState);
3535
VIR_ENUM_DECL(virDomainNetModel);
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552
VIR_ENUM_DECL(virDomainChrDevice);
VIR_ENUM_DECL(virDomainChrChannelTarget);
VIR_ENUM_DECL(virDomainChrConsoleTarget);
VIR_ENUM_DECL(virDomainChrSerialTarget);
VIR_ENUM_DECL(virDomainSmartcard);
VIR_ENUM_DECL(virDomainChr);
VIR_ENUM_DECL(virDomainChrTcpProtocol);
VIR_ENUM_DECL(virDomainChrSpicevmc);
VIR_ENUM_DECL(virDomainSoundCodec);
VIR_ENUM_DECL(virDomainSoundModel);
VIR_ENUM_DECL(virDomainKeyWrapCipherName);
VIR_ENUM_DECL(virDomainMemballoonModel);
VIR_ENUM_DECL(virDomainSmbiosMode);
VIR_ENUM_DECL(virDomainWatchdogModel);
VIR_ENUM_DECL(virDomainWatchdogAction);
VIR_ENUM_DECL(virDomainPanicModel);
VIR_ENUM_DECL(virDomainVideo);
3553
VIR_ENUM_DECL(virDomainVideoBackend);
3554 3555 3556 3557 3558 3559 3560
VIR_ENUM_DECL(virDomainHostdevMode);
VIR_ENUM_DECL(virDomainHostdevSubsys);
VIR_ENUM_DECL(virDomainHostdevCaps);
VIR_ENUM_DECL(virDomainHub);
VIR_ENUM_DECL(virDomainRedirdevBus);
VIR_ENUM_DECL(virDomainInput);
VIR_ENUM_DECL(virDomainInputBus);
3561
VIR_ENUM_DECL(virDomainInputModel);
3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574
VIR_ENUM_DECL(virDomainGraphics);
VIR_ENUM_DECL(virDomainGraphicsListen);
VIR_ENUM_DECL(virDomainGraphicsAuthConnected);
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName);
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode);
VIR_ENUM_DECL(virDomainGraphicsSpiceImageCompression);
VIR_ENUM_DECL(virDomainGraphicsSpiceJpegCompression);
VIR_ENUM_DECL(virDomainGraphicsSpiceZlibCompression);
VIR_ENUM_DECL(virDomainGraphicsSpiceStreamingMode);
VIR_ENUM_DECL(virDomainGraphicsSpiceMouseMode);
VIR_ENUM_DECL(virDomainGraphicsVNCSharePolicy);
VIR_ENUM_DECL(virDomainHyperv);
VIR_ENUM_DECL(virDomainKVM);
3575
VIR_ENUM_DECL(virDomainXen);
3576
VIR_ENUM_DECL(virDomainXenPassthroughMode);
3577
VIR_ENUM_DECL(virDomainMsrsUnknown);
3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590
VIR_ENUM_DECL(virDomainRNGModel);
VIR_ENUM_DECL(virDomainRNGBackend);
VIR_ENUM_DECL(virDomainTPMModel);
VIR_ENUM_DECL(virDomainTPMBackend);
VIR_ENUM_DECL(virDomainTPMVersion);
VIR_ENUM_DECL(virDomainMemoryModel);
VIR_ENUM_DECL(virDomainMemoryBackingModel);
VIR_ENUM_DECL(virDomainMemorySource);
VIR_ENUM_DECL(virDomainMemoryAllocation);
VIR_ENUM_DECL(virDomainIOMMUModel);
VIR_ENUM_DECL(virDomainVsockModel);
VIR_ENUM_DECL(virDomainShmemModel);
VIR_ENUM_DECL(virDomainLaunchSecurity);
3591
/* from libvirt.h */
3592 3593 3594 3595 3596 3597 3598 3599 3600
VIR_ENUM_DECL(virDomainState);
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);
VIR_ENUM_DECL(virDomainPMSuspendedReason);
J
Jiri Denemark 已提交
3601 3602 3603 3604

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

3605 3606 3607
VIR_ENUM_DECL(virDomainSeclabel);
VIR_ENUM_DECL(virDomainClockOffset);
VIR_ENUM_DECL(virDomainClockBasis);
3608

3609 3610 3611 3612 3613
VIR_ENUM_DECL(virDomainTimerName);
VIR_ENUM_DECL(virDomainTimerTrack);
VIR_ENUM_DECL(virDomainTimerTickpolicy);
VIR_ENUM_DECL(virDomainTimerMode);
VIR_ENUM_DECL(virDomainCpuPlacementMode);
3614

3615
VIR_ENUM_DECL(virDomainStartupPolicy);
3616

3617 3618
virDomainControllerDefPtr
virDomainDefAddController(virDomainDefPtr def, int type, int idx, int model);
3619 3620
int
virDomainDefAddUSBController(virDomainDefPtr def, int idx, int model);
3621 3622 3623 3624 3625
int
virDomainDefMaybeAddController(virDomainDefPtr def,
                               int type,
                               int idx,
                               int model);
3626 3627 3628 3629
int
virDomainDefMaybeAddInput(virDomainDefPtr def,
                          int type,
                          int bus);
3630

3631 3632
char *virDomainDefGetDefaultEmulator(virDomainDefPtr def, virCapsPtr caps);

3633 3634
int virDomainDefFindDevice(virDomainDefPtr def,
                           const char *devAlias,
3635 3636
                           virDomainDeviceDefPtr dev,
                           bool reportError);
3637

3638 3639
const char *virDomainChrSourceDefGetPath(virDomainChrSourceDefPtr chr);

3640 3641
void virDomainChrSourceDefClear(virDomainChrSourceDefPtr def);

3642 3643 3644 3645 3646
char *virDomainObjGetMetadata(virDomainObjPtr vm,
                              int type,
                              const char *uri,
                              unsigned int flags);

3647 3648 3649 3650 3651 3652
int virDomainObjSetMetadata(virDomainObjPtr vm,
                            int type,
                            const char *metadata,
                            const char *key,
                            const char *uri,
                            virDomainXMLOptionPtr xmlopt,
3653
                            const char *stateDir,
3654 3655 3656
                            const char *configDir,
                            unsigned int flags);

3657 3658 3659 3660 3661 3662 3663 3664
int
virDomainParseMemory(const char *xpath,
                     const char *units_xpath,
                     xmlXPathContextPtr ctxt,
                     unsigned long long *mem,
                     bool required,
                     bool capped);

3665 3666 3667
bool virDomainDefNeedsPlacementAdvice(virDomainDefPtr def)
    ATTRIBUTE_NONNULL(1);

3668 3669
int virDomainDiskDefCheckDuplicateInfo(const virDomainDiskDef *a,
                                       const virDomainDiskDef *b)
3670
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3671

3672 3673 3674 3675
virStorageSourcePtr
virDomainStorageSourceParseBase(const char *type,
                                const char *format,
                                const char *index)
3676
    G_GNUC_WARN_UNUSED_RESULT;
3677

3678 3679 3680
int virDomainStorageSourceParse(xmlNodePtr node,
                                xmlXPathContextPtr ctxt,
                                virStorageSourcePtr src,
3681 3682
                                unsigned int flags,
                                virDomainXMLOptionPtr xmlopt)
3683 3684
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3);

3685 3686 3687 3688 3689
int
virDomainDiskBackingStoreParse(xmlXPathContextPtr ctxt,
                               virStorageSourcePtr src,
                               unsigned int flags,
                               virDomainXMLOptionPtr xmlopt)
3690
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
3691

3692 3693 3694 3695 3696 3697
int virDomainDefGetVcpuPinInfoHelper(virDomainDefPtr def,
                                     int maplen,
                                     int ncpumaps,
                                     unsigned char *cpumaps,
                                     int hostcpus,
                                     virBitmapPtr autoCpuset)
3698
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(4) G_GNUC_WARN_UNUSED_RESULT;
3699

3700 3701
bool virDomainDefHasMemballoon(const virDomainDef *def) ATTRIBUTE_NONNULL(1);

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

3704 3705 3706 3707 3708
int
virDomainGetBlkioParametersAssignFromDef(virDomainDefPtr def,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         int maxparams);
3709

3710 3711 3712
int virDomainDiskSetBlockIOTune(virDomainDiskDefPtr disk,
                                virDomainBlockIoTuneInfo *info);

3713 3714
bool
virDomainNetTypeSharesHostView(const virDomainNetDef *net);
3715

3716 3717 3718 3719
bool
virDomainDefLifecycleActionAllowed(virDomainLifecycle type,
                                   virDomainLifecycleAction action);

3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731
virNetworkPortDefPtr
virDomainNetDefToNetworkPort(virDomainDefPtr dom,
                             virDomainNetDefPtr iface);

int
virDomainNetDefActualFromNetworkPort(virDomainNetDefPtr iface,
                                     virNetworkPortDefPtr port);

virNetworkPortDefPtr
virDomainNetDefActualToNetworkPort(virDomainDefPtr dom,
                                   virDomainNetDefPtr iface);

3732
int
3733 3734
virDomainNetAllocateActualDevice(virConnectPtr conn,
                                 virDomainDefPtr dom,
3735 3736 3737 3738
                                 virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

void
3739 3740
virDomainNetNotifyActualDevice(virConnectPtr conn,
                               virDomainDefPtr dom,
3741 3742 3743 3744
                               virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

int
3745 3746
virDomainNetReleaseActualDevice(virConnectPtr conn,
                                virDomainDefPtr dom,
3747 3748 3749
                                virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);

3750 3751 3752 3753
int
virDomainNetBandwidthUpdate(virDomainNetDefPtr iface,
                            virNetDevBandwidthPtr newBandwidth)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
3754

3755 3756 3757 3758
int
virDomainNetResolveActualType(virDomainNetDefPtr iface)
    ATTRIBUTE_NONNULL(1);

3759

3760
int virDomainDiskTranslateSourcePool(virDomainDiskDefPtr def);
3761

3762 3763 3764
int
virDomainDiskGetDetectZeroesMode(virDomainDiskDiscard discard,
                                 virDomainDiskDetectZeroes detect_zeroes);
3765

3766 3767 3768
bool
virDomainDefHasManagedPR(const virDomainDef *def);

3769 3770 3771
bool
virDomainDefHasNVMeDisk(const virDomainDef *def);

3772 3773 3774
bool
virDomainDefHasVFIOHostdev(const virDomainDef *def);

3775 3776 3777
bool
virDomainDefHasMdevHostdev(const virDomainDef *def);

3778 3779 3780 3781 3782 3783
bool
virDomainDefHasOldStyleUEFI(const virDomainDef *def);

bool
virDomainDefHasOldStyleROUEFI(const virDomainDef *def);

3784 3785 3786
bool
virDomainGraphicsDefHasOpenGL(const virDomainDef *def);

3787 3788 3789 3790 3791 3792 3793 3794
bool
virDomainGraphicsSupportsRenderNode(const virDomainGraphicsDef *graphics);

const char *
virDomainGraphicsGetRenderNode(const virDomainGraphicsDef *graphics);

bool
virDomainGraphicsNeedsAutoRenderNode(const virDomainGraphicsDef *graphics);
3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806

bool
virDomainBlockIoTuneInfoHasBasic(const virDomainBlockIoTuneInfo *iotune);

bool
virDomainBlockIoTuneInfoHasMax(const virDomainBlockIoTuneInfo *iotune);

bool
virDomainBlockIoTuneInfoHasMaxLength(const virDomainBlockIoTuneInfo *iotune);

bool
virDomainBlockIoTuneInfoHasAny(const virDomainBlockIoTuneInfo *iotune);
3807 3808 3809 3810

void
virDomainBlockIoTuneInfoCopy(const virDomainBlockIoTuneInfo *src,
                             virDomainBlockIoTuneInfoPtr dst);
3811 3812 3813 3814

bool
virDomainBlockIoTuneInfoEqual(const virDomainBlockIoTuneInfo *a,
                              const virDomainBlockIoTuneInfo *b);
J
Ján Tomko 已提交
3815 3816 3817 3818 3819 3820 3821 3822 3823 3824

bool
virHostdevIsSCSIDevice(const virDomainHostdevDef *hostdev)
    ATTRIBUTE_NONNULL(1);
bool
virHostdevIsMdevDevice(const virDomainHostdevDef *hostdev)
    ATTRIBUTE_NONNULL(1);
bool
virHostdevIsVFIODevice(const virDomainHostdevDef *hostdev)
    ATTRIBUTE_NONNULL(1);