domain_conf.h 39.9 KB
Newer Older
1 2 3
/*
 * domain_conf.h: domain XML processing
 *
4
 * Copyright (C) 2006-2011 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * Copyright (C) 2006-2008 Daniel P. Berrange
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Author: Daniel P. Berrange <berrange@redhat.com>
 */

#ifndef __DOMAIN_CONF_H
25
# define __DOMAIN_CONF_H
26

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

31 32 33 34 35 36 37 38
# include "internal.h"
# include "capabilities.h"
# include "storage_encryption_conf.h"
# include "cpu_conf.h"
# include "util.h"
# include "threads.h"
# include "hash.h"
# include "network.h"
39 40
# include "nwfilter_params.h"
# include "nwfilter_conf.h"
41
# include "macvtap.h"
42
# include "sysinfo.h"
43

44 45 46 47 48
/* Private component of virDomainXMLFlags */
typedef enum {
   VIR_DOMAIN_XML_INTERNAL_STATUS = (1<<16), /* dump internal domain status information */
} virDomainXMLInternalFlags;

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
/* Different types of hypervisor */
/* NB: Keep in sync with virDomainVirtTypeToString impl */
enum virDomainVirtType {
    VIR_DOMAIN_VIRT_QEMU,
    VIR_DOMAIN_VIRT_KQEMU,
    VIR_DOMAIN_VIRT_KVM,
    VIR_DOMAIN_VIRT_XEN,
    VIR_DOMAIN_VIRT_LXC,
    VIR_DOMAIN_VIRT_UML,
    VIR_DOMAIN_VIRT_OPENVZ,
    VIR_DOMAIN_VIRT_VSERVER,
    VIR_DOMAIN_VIRT_LDOM,
    VIR_DOMAIN_VIRT_TEST,
    VIR_DOMAIN_VIRT_VMWARE,
    VIR_DOMAIN_VIRT_HYPERV,
64
    VIR_DOMAIN_VIRT_VBOX,
D
Daniel Veillard 已提交
65
    VIR_DOMAIN_VIRT_ONE,
66
    VIR_DOMAIN_VIRT_PHYP,
67 68 69 70

    VIR_DOMAIN_VIRT_LAST,
};

71 72 73
enum virDomainDeviceAddressType {
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_NONE,
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_PCI,
74
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_DRIVE,
75
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
76
    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_CCID,
77 78 79 80 81 82 83 84 85 86 87 88 89

    VIR_DOMAIN_DEVICE_ADDRESS_TYPE_LAST
};

typedef struct _virDomainDevicePCIAddress virDomainDevicePCIAddress;
typedef virDomainDevicePCIAddress *virDomainDevicePCIAddressPtr;
struct _virDomainDevicePCIAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
};

90 91 92 93 94 95 96 97
typedef struct _virDomainDeviceDriveAddress virDomainDeviceDriveAddress;
typedef virDomainDeviceDriveAddress *virDomainDeviceDriveAddressPtr;
struct _virDomainDeviceDriveAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

98 99 100 101 102
typedef struct _virDomainDeviceVirtioSerialAddress virDomainDeviceVirtioSerialAddress;
typedef virDomainDeviceVirtioSerialAddress *virDomainDeviceVirtioSerialAddressPtr;
struct _virDomainDeviceVirtioSerialAddress {
    unsigned int controller;
    unsigned int bus;
103
    unsigned int port;
104 105
};

E
Eric Blake 已提交
106 107 108 109 110 111 112
typedef struct _virDomainDeviceCcidAddress virDomainDeviceCcidAddress;
typedef virDomainDeviceCcidAddress *virDomainDeviceCcidAddressPtr;
struct _virDomainDeviceCcidAddress {
    unsigned int controller;
    unsigned int slot;
};

113 114 115
typedef struct _virDomainDeviceInfo virDomainDeviceInfo;
typedef virDomainDeviceInfo *virDomainDeviceInfoPtr;
struct _virDomainDeviceInfo {
D
Daniel P. Berrange 已提交
116
    char *alias;
117 118 119
    int type;
    union {
        virDomainDevicePCIAddress pci;
120
        virDomainDeviceDriveAddress drive;
121
        virDomainDeviceVirtioSerialAddress vioserial;
E
Eric Blake 已提交
122
        virDomainDeviceCcidAddress ccid;
123 124 125 126
    } addr;
};


127 128 129 130
/* Two types of disk backends */
enum virDomainDiskType {
    VIR_DOMAIN_DISK_TYPE_BLOCK,
    VIR_DOMAIN_DISK_TYPE_FILE,
131
    VIR_DOMAIN_DISK_TYPE_DIR,
M
MORITA Kazutaka 已提交
132
    VIR_DOMAIN_DISK_TYPE_NETWORK,
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151

    VIR_DOMAIN_DISK_TYPE_LAST
};

/* Three types of disk frontend */
enum virDomainDiskDevice {
    VIR_DOMAIN_DISK_DEVICE_DISK,
    VIR_DOMAIN_DISK_DEVICE_CDROM,
    VIR_DOMAIN_DISK_DEVICE_FLOPPY,

    VIR_DOMAIN_DISK_DEVICE_LAST
};

enum virDomainDiskBus {
    VIR_DOMAIN_DISK_BUS_IDE,
    VIR_DOMAIN_DISK_BUS_FDC,
    VIR_DOMAIN_DISK_BUS_SCSI,
    VIR_DOMAIN_DISK_BUS_VIRTIO,
    VIR_DOMAIN_DISK_BUS_XEN,
152
    VIR_DOMAIN_DISK_BUS_USB,
153
    VIR_DOMAIN_DISK_BUS_UML,
154
    VIR_DOMAIN_DISK_BUS_SATA,
155 156 157 158

    VIR_DOMAIN_DISK_BUS_LAST
};

159 160 161 162 163 164 165 166 167
enum  virDomainDiskCache {
    VIR_DOMAIN_DISK_CACHE_DEFAULT,
    VIR_DOMAIN_DISK_CACHE_DISABLE,
    VIR_DOMAIN_DISK_CACHE_WRITETHRU,
    VIR_DOMAIN_DISK_CACHE_WRITEBACK,

    VIR_DOMAIN_DISK_CACHE_LAST
};

168 169 170 171
enum  virDomainDiskErrorPolicy {
    VIR_DOMAIN_DISK_ERROR_POLICY_DEFAULT,
    VIR_DOMAIN_DISK_ERROR_POLICY_STOP,
    VIR_DOMAIN_DISK_ERROR_POLICY_IGNORE,
172
    VIR_DOMAIN_DISK_ERROR_POLICY_ENOSPACE,
173 174 175 176

    VIR_DOMAIN_DISK_ERROR_POLICY_LAST
};

M
MORITA Kazutaka 已提交
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
enum virDomainDiskProtocol {
    VIR_DOMAIN_DISK_PROTOCOL_NBD,
    VIR_DOMAIN_DISK_PROTOCOL_RBD,
    VIR_DOMAIN_DISK_PROTOCOL_SHEEPDOG,

    VIR_DOMAIN_DISK_PROTOCOL_LAST
};

typedef struct _virDomainDiskHostDef virDomainDiskHostDef;
typedef virDomainDiskHostDef *virDomainDiskHostDefPtr;
struct _virDomainDiskHostDef {
    char *name;
    char *port;
};

M
Matthias Dahl 已提交
192 193 194 195 196 197 198 199
enum  virDomainDiskIo {
    VIR_DOMAIN_DISK_IO_DEFAULT,
    VIR_DOMAIN_DISK_IO_NATIVE,
    VIR_DOMAIN_DISK_IO_THREADS,

    VIR_DOMAIN_DISK_IO_LAST
};

200 201 202 203 204 205 206 207 208
/* Stores the virtual disk configuration */
typedef struct _virDomainDiskDef virDomainDiskDef;
typedef virDomainDiskDef *virDomainDiskDefPtr;
struct _virDomainDiskDef {
    int type;
    int device;
    int bus;
    char *src;
    char *dst;
M
MORITA Kazutaka 已提交
209 210 211
    int protocol;
    int nhosts;
    virDomainDiskHostDefPtr hosts;
212 213
    char *driverName;
    char *driverType;
214
    char *serial;
215
    int cachemode;
216
    int error_policy;
217
    int bootIndex;
M
Matthias Dahl 已提交
218
    int iomode;
219 220
    unsigned int readonly : 1;
    unsigned int shared : 1;
221
    virDomainDeviceInfo info;
222
    virStorageEncryptionPtr encryption;
223 224 225
};


226 227 228 229 230
enum virDomainControllerType {
    VIR_DOMAIN_CONTROLLER_TYPE_IDE,
    VIR_DOMAIN_CONTROLLER_TYPE_FDC,
    VIR_DOMAIN_CONTROLLER_TYPE_SCSI,
    VIR_DOMAIN_CONTROLLER_TYPE_SATA,
231
    VIR_DOMAIN_CONTROLLER_TYPE_VIRTIO_SERIAL,
E
Eric Blake 已提交
232
    VIR_DOMAIN_CONTROLLER_TYPE_CCID,
233 234 235 236

    VIR_DOMAIN_CONTROLLER_TYPE_LAST
};

237 238

enum virDomainControllerModel {
239
    VIR_DOMAIN_CONTROLLER_MODEL_AUTO,
240 241 242
    VIR_DOMAIN_CONTROLLER_MODEL_BUSLOGIC,
    VIR_DOMAIN_CONTROLLER_MODEL_LSILOGIC,
    VIR_DOMAIN_CONTROLLER_MODEL_LSISAS1068,
243
    VIR_DOMAIN_CONTROLLER_MODEL_VMPVSCSI,
244 245 246 247

    VIR_DOMAIN_CONTROLLER_MODEL_LAST
};

248 249 250 251 252 253 254
typedef struct _virDomainVirtioSerialOpts virDomainVirtioSerialOpts;
typedef virDomainVirtioSerialOpts *virDomainVirtioSerialOptsPtr;
struct _virDomainVirtioSerialOpts {
    int ports;   /* -1 == undef */
    int vectors; /* -1 == undef */
};

255 256 257 258 259 260
/* Stores the virtual disk controller configuration */
typedef struct _virDomainControllerDef virDomainControllerDef;
typedef virDomainControllerDef *virDomainControllerDefPtr;
struct _virDomainControllerDef {
    int type;
    int idx;
261
    int model; /* -1 == undef */
262 263 264
    union {
        virDomainVirtioSerialOpts vioserial;
    } opts;
265 266 267 268
    virDomainDeviceInfo info;
};


269 270 271 272 273 274 275 276 277 278
/* Two types of disk backends */
enum virDomainFSType {
    VIR_DOMAIN_FS_TYPE_MOUNT,   /* Better named 'bind' */
    VIR_DOMAIN_FS_TYPE_BLOCK,
    VIR_DOMAIN_FS_TYPE_FILE,
    VIR_DOMAIN_FS_TYPE_TEMPLATE,

    VIR_DOMAIN_FS_TYPE_LAST
};

279 280 281 282 283 284 285 286 287
/* Filesystem mount access mode  */
enum virDomainFSAccessMode {
    VIR_DOMAIN_FS_ACCESSMODE_PASSTHROUGH,
    VIR_DOMAIN_FS_ACCESSMODE_MAPPED,
    VIR_DOMAIN_FS_ACCESSMODE_SQUASH,

    VIR_DOMAIN_FS_ACCESSMODE_LAST
};

288 289 290 291
typedef struct _virDomainFSDef virDomainFSDef;
typedef virDomainFSDef *virDomainFSDefPtr;
struct _virDomainFSDef {
    int type;
292
    int accessmode;
293 294 295
    char *src;
    char *dst;
    unsigned int readonly : 1;
296
    virDomainDeviceInfo info;
297 298 299
};


300 301 302 303 304 305 306 307 308
/* 5 different types of networking config */
enum virDomainNetType {
    VIR_DOMAIN_NET_TYPE_USER,
    VIR_DOMAIN_NET_TYPE_ETHERNET,
    VIR_DOMAIN_NET_TYPE_SERVER,
    VIR_DOMAIN_NET_TYPE_CLIENT,
    VIR_DOMAIN_NET_TYPE_MCAST,
    VIR_DOMAIN_NET_TYPE_NETWORK,
    VIR_DOMAIN_NET_TYPE_BRIDGE,
D
Daniel Veillard 已提交
309
    VIR_DOMAIN_NET_TYPE_INTERNAL,
310
    VIR_DOMAIN_NET_TYPE_DIRECT,
311 312 313 314

    VIR_DOMAIN_NET_TYPE_LAST,
};

315 316 317 318 319 320 321 322
/* the backend driver used for virtio interfaces */
enum virDomainNetBackendType {
    VIR_DOMAIN_NET_BACKEND_TYPE_DEFAULT, /* prefer kernel, fall back to user */
    VIR_DOMAIN_NET_BACKEND_TYPE_QEMU,    /* userland */
    VIR_DOMAIN_NET_BACKEND_TYPE_VHOST,   /* kernel */

    VIR_DOMAIN_NET_BACKEND_TYPE_LAST,
};
323

324 325 326 327 328 329 330 331 332 333
/* the mode type for macvtap devices */
enum virDomainNetdevMacvtapType {
    VIR_DOMAIN_NETDEV_MACVTAP_MODE_VEPA,
    VIR_DOMAIN_NETDEV_MACVTAP_MODE_PRIVATE,
    VIR_DOMAIN_NETDEV_MACVTAP_MODE_BRIDGE,

    VIR_DOMAIN_NETDEV_MACVTAP_MODE_LAST,
};


334 335 336 337
/* Stores the virtual network interface configuration */
typedef struct _virDomainNetDef virDomainNetDef;
typedef virDomainNetDef *virDomainNetDefPtr;
struct _virDomainNetDef {
S
Stefan Berger 已提交
338
    enum virDomainNetType type;
339
    unsigned char mac[VIR_MAC_BUFLEN];
340
    char *model;
341
    enum virDomainNetBackendType backend;
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    union {
        struct {
            char *dev;
            char *script;
            char *ipaddr;
        } ethernet;
        struct {
            char *address;
            int port;
        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
        struct {
            char *name;
        } network;
        struct {
            char *brname;
357
            char *script;
358
            char *ipaddr;
359
        } bridge;
D
Daniel Veillard 已提交
360 361 362
        struct {
            char *name;
        } internal;
363 364 365
        struct {
            char *linkdev;
            int mode;
366
            virVirtualPortProfileParams virtPortProfile;
367
        } direct;
368
    } data;
369 370 371 372
    struct {
        bool sndbuf_specified;
        unsigned long sndbuf;
    } tune;
373
    char *ifname;
374
    int bootIndex;
375
    virDomainDeviceInfo info;
376 377
    char *filter;
    virNWFilterHashTablePtr filterparams;
378 379
};

380
enum virDomainChrDeviceType {
381
    VIR_DOMAIN_CHR_DEVICE_TYPE_PARALLEL = 0,
382 383
    VIR_DOMAIN_CHR_DEVICE_TYPE_SERIAL,
    VIR_DOMAIN_CHR_DEVICE_TYPE_CONSOLE,
384
    VIR_DOMAIN_CHR_DEVICE_TYPE_CHANNEL,
385

386 387 388 389 390 391 392 393
    VIR_DOMAIN_CHR_DEVICE_TYPE_LAST,
};

enum virDomainChrChannelTargetType {
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_GUESTFWD = 0,
    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_VIRTIO,

    VIR_DOMAIN_CHR_CHANNEL_TARGET_TYPE_LAST,
394 395
};

396 397 398 399
enum virDomainChrConsoleTargetType {
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_SERIAL = 0,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_XEN,
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_UML,
C
Cole Robinson 已提交
400
    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_VIRTIO,
401 402 403 404

    VIR_DOMAIN_CHR_CONSOLE_TARGET_TYPE_LAST,
};

405
enum virDomainChrType {
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
    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,

    VIR_DOMAIN_CHR_TYPE_LAST,
};

enum virDomainChrTcpProtocol {
    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
423 424
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNETS, /* secure telnet */
    VIR_DOMAIN_CHR_TCP_PROTOCOL_TLS,
425 426 427 428

    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST,
};

429 430 431 432 433
/* The host side information for a character device.  */
typedef struct _virDomainChrSourceDef virDomainChrSourceDef;
typedef virDomainChrSourceDef *virDomainChrSourceDefPtr;
struct _virDomainChrSourceDef {
    int type; /* virDomainChrType */
434 435 436 437 438 439 440
    union {
        struct {
            char *path;
        } file; /* pty, file, pipe, or device */
        struct {
            char *host;
            char *service;
441
            bool listen;
442 443 444 445 446 447 448 449 450 451
            int protocol;
        } tcp;
        struct {
            char *bindHost;
            char *bindService;
            char *connectHost;
            char *connectService;
        } udp;
        struct {
            char *path;
452
            bool listen;
453 454
        } nix;
    } data;
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
};

/* A complete character device, both host and domain views.  */
typedef struct _virDomainChrDef virDomainChrDef;
typedef virDomainChrDef *virDomainChrDefPtr;
struct _virDomainChrDef {
    int deviceType;
    int targetType;
    union {
        int port; /* parallel, serial, console */
        virSocketAddrPtr addr; /* guestfwd */
        char *name; /* virtio */
    } target;

    virDomainChrSourceDef source;
470 471

    virDomainDeviceInfo info;
472 473
};

E
Eric Blake 已提交
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
enum virDomainSmartcardType {
    VIR_DOMAIN_SMARTCARD_TYPE_HOST,
    VIR_DOMAIN_SMARTCARD_TYPE_HOST_CERTIFICATES,
    VIR_DOMAIN_SMARTCARD_TYPE_PASSTHROUGH,

    VIR_DOMAIN_SMARTCARD_TYPE_LAST,
};

# define VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES 3
# define VIR_DOMAIN_SMARTCARD_DEFAULT_DATABASE "/etc/pki/nssdb"

typedef struct _virDomainSmartcardDef virDomainSmartcardDef;
typedef virDomainSmartcardDef *virDomainSmartcardDefPtr;
struct _virDomainSmartcardDef {
    int type; /* virDomainSmartcardType */
    union {
        /* no extra data for 'host' */
        struct {
            char *file[VIR_DOMAIN_SMARTCARD_NUM_CERTIFICATES];
            char *database;
        } cert; /* 'host-certificates' */
        virDomainChrSourceDef passthru; /* 'passthrough' */
    } data;

    virDomainDeviceInfo info;
};

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
enum virDomainInputType {
    VIR_DOMAIN_INPUT_TYPE_MOUSE,
    VIR_DOMAIN_INPUT_TYPE_TABLET,

    VIR_DOMAIN_INPUT_TYPE_LAST,
};

enum virDomainInputBus {
    VIR_DOMAIN_INPUT_BUS_PS2,
    VIR_DOMAIN_INPUT_BUS_USB,
    VIR_DOMAIN_INPUT_BUS_XEN,

    VIR_DOMAIN_INPUT_BUS_LAST
};

typedef struct _virDomainInputDef virDomainInputDef;
typedef virDomainInputDef *virDomainInputDefPtr;
struct _virDomainInputDef {
    int type;
    int bus;
521
    virDomainDeviceInfo info;
522 523 524 525 526 527
};

enum virDomainSoundModel {
    VIR_DOMAIN_SOUND_MODEL_SB16,
    VIR_DOMAIN_SOUND_MODEL_ES1370,
    VIR_DOMAIN_SOUND_MODEL_PCSPK,
D
Daniel P. Berrange 已提交
528
    VIR_DOMAIN_SOUND_MODEL_AC97,
529
    VIR_DOMAIN_SOUND_MODEL_ICH6,
530 531 532 533 534 535 536 537

    VIR_DOMAIN_SOUND_MODEL_LAST
};

typedef struct _virDomainSoundDef virDomainSoundDef;
typedef virDomainSoundDef *virDomainSoundDefPtr;
struct _virDomainSoundDef {
    int model;
538
    virDomainDeviceInfo info;
539 540
};

R
Richard Jones 已提交
541 542 543 544 545 546 547 548 549 550 551 552
enum virDomainWatchdogModel {
    VIR_DOMAIN_WATCHDOG_MODEL_I6300ESB,
    VIR_DOMAIN_WATCHDOG_MODEL_IB700,

    VIR_DOMAIN_WATCHDOG_MODEL_LAST
};

enum virDomainWatchdogAction {
    VIR_DOMAIN_WATCHDOG_ACTION_RESET,
    VIR_DOMAIN_WATCHDOG_ACTION_SHUTDOWN,
    VIR_DOMAIN_WATCHDOG_ACTION_POWEROFF,
    VIR_DOMAIN_WATCHDOG_ACTION_PAUSE,
H
Hu Tao 已提交
553
    VIR_DOMAIN_WATCHDOG_ACTION_DUMP,
R
Richard Jones 已提交
554 555 556 557 558 559 560 561 562 563
    VIR_DOMAIN_WATCHDOG_ACTION_NONE,

    VIR_DOMAIN_WATCHDOG_ACTION_LAST
};

typedef struct _virDomainWatchdogDef virDomainWatchdogDef;
typedef virDomainWatchdogDef *virDomainWatchdogDefPtr;
struct _virDomainWatchdogDef {
    int model;
    int action;
564
    virDomainDeviceInfo info;
R
Richard Jones 已提交
565 566
};

567 568 569 570 571 572 573

enum virDomainVideoType {
    VIR_DOMAIN_VIDEO_TYPE_VGA,
    VIR_DOMAIN_VIDEO_TYPE_CIRRUS,
    VIR_DOMAIN_VIDEO_TYPE_VMVGA,
    VIR_DOMAIN_VIDEO_TYPE_XEN,
    VIR_DOMAIN_VIDEO_TYPE_VBOX,
574
    VIR_DOMAIN_VIDEO_TYPE_QXL,
575 576 577 578 579

    VIR_DOMAIN_VIDEO_TYPE_LAST
};


580 581 582
typedef struct _virDomainVideoAccelDef virDomainVideoAccelDef;
typedef virDomainVideoAccelDef *virDomainVideoAccelDefPtr;
struct _virDomainVideoAccelDef {
583 584
    unsigned int support3d :1;
    unsigned int support2d :1;
585 586 587
};


588 589 590 591 592 593
typedef struct _virDomainVideoDef virDomainVideoDef;
typedef virDomainVideoDef *virDomainVideoDefPtr;
struct _virDomainVideoDef {
    int type;
    unsigned int vram;
    unsigned int heads;
594
    virDomainVideoAccelDefPtr accel;
595
    virDomainDeviceInfo info;
596 597
};

598 599 600 601
/* 3 possible graphics console modes */
enum virDomainGraphicsType {
    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
602 603
    VIR_DOMAIN_GRAPHICS_TYPE_RDP,
    VIR_DOMAIN_GRAPHICS_TYPE_DESKTOP,
604
    VIR_DOMAIN_GRAPHICS_TYPE_SPICE,
605 606 607 608

    VIR_DOMAIN_GRAPHICS_TYPE_LAST,
};

609 610 611 612 613 614 615 616
typedef struct _virDomainGraphicsAuthDef virDomainGraphicsAuthDef;
typedef virDomainGraphicsAuthDef *virDomainGraphicsAuthDefPtr;
struct _virDomainGraphicsAuthDef {
    char *passwd;
    unsigned int expires: 1; /* Whether there is an expiry time set */
    time_t validTo;  /* seconds since epoch */
};

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
enum virDomainGraphicsSpiceChannelName {
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MAIN,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_DISPLAY,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_INPUT,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_CURSOR,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_PLAYBACK,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_RECORD,

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST
};

enum virDomainGraphicsSpiceChannelMode {
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_ANY,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_SECURE,
    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_INSECURE,

    VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_MODE_LAST
};
635

636 637 638 639 640 641 642
typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;
struct _virDomainGraphicsDef {
    int type;
    union {
        struct {
            int port;
643
            unsigned int autoport :1;
644 645
            char *listenAddr;
            char *keymap;
646
            char *socket;
647
            virDomainGraphicsAuthDef auth;
648 649 650 651
        } vnc;
        struct {
            char *display;
            char *xauth;
652
            int fullscreen;
653
        } sdl;
654 655 656
        struct {
            int port;
            char *listenAddr;
657 658 659
            unsigned int autoport :1;
            unsigned int replaceUser :1;
            unsigned int multiUser :1;
660 661 662
        } rdp;
        struct {
            char *display;
663
            unsigned int fullscreen :1;
664
        } desktop;
665 666 667 668 669
        struct {
            int port;
            int tlsPort;
            char *listenAddr;
            char *keymap;
670
            virDomainGraphicsAuthDef auth;
671
            unsigned int autoport :1;
672
            int channels[VIR_DOMAIN_GRAPHICS_SPICE_CHANNEL_LAST];
673
        } spice;
674 675 676
    } data;
};

677 678 679
enum virDomainHostdevMode {
    VIR_DOMAIN_HOSTDEV_MODE_SUBSYS,
    VIR_DOMAIN_HOSTDEV_MODE_CAPABILITIES,
680

681 682 683 684 685 686 687 688 689 690 691 692 693 694
    VIR_DOMAIN_HOSTDEV_MODE_LAST,
};

enum virDomainHostdevSubsysType {
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_USB,
    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_PCI,

    VIR_DOMAIN_HOSTDEV_SUBSYS_TYPE_LAST
};

typedef struct _virDomainHostdevDef virDomainHostdevDef;
typedef virDomainHostdevDef *virDomainHostdevDefPtr;
struct _virDomainHostdevDef {
    int mode; /* enum virDomainHostdevMode */
695
    unsigned int managed : 1;
696 697 698 699 700 701 702 703 704 705 706
    union {
        struct {
            int type; /* enum virDomainHostdevBusType */
            union {
                struct {
                    unsigned bus;
                    unsigned device;

                    unsigned vendor;
                    unsigned product;
                } usb;
707
                virDomainDevicePCIAddress pci; /* host address */
708
            } u;
709 710 711 712 713
        } subsys;
        struct {
            /* TBD: struct capabilities see:
             * https://www.redhat.com/archives/libvir-list/2008-July/msg00429.html
             */
714
            int dummy;
715 716 717
        } caps;
    } source;
    char* target;
718
    int bootIndex;
719
    virDomainDeviceInfo info; /* Guest address */
720
};
721

722 723 724 725

enum {
    VIR_DOMAIN_MEMBALLOON_MODEL_VIRTIO,
    VIR_DOMAIN_MEMBALLOON_MODEL_XEN,
726
    VIR_DOMAIN_MEMBALLOON_MODEL_NONE,
727 728 729 730 731 732 733 734 735 736 737 738

    VIR_DOMAIN_MEMBALLOON_MODEL_LAST
};

typedef struct _virDomainMemballoonDef virDomainMemballoonDef;
typedef virDomainMemballoonDef *virDomainMemballoonDefPtr;
struct _virDomainMemballoonDef {
    int model;
    virDomainDeviceInfo info;
};


739 740 741 742 743 744 745 746 747
enum virDomainSmbiosMode {
    VIR_DOMAIN_SMBIOS_NONE,
    VIR_DOMAIN_SMBIOS_EMULATE,
    VIR_DOMAIN_SMBIOS_HOST,
    VIR_DOMAIN_SMBIOS_SYSINFO,

    VIR_DOMAIN_SMBIOS_LAST
};

748 749 750
/* Flags for the 'type' field in next struct */
enum virDomainDeviceType {
    VIR_DOMAIN_DEVICE_DISK,
751
    VIR_DOMAIN_DEVICE_FS,
752 753 754
    VIR_DOMAIN_DEVICE_NET,
    VIR_DOMAIN_DEVICE_INPUT,
    VIR_DOMAIN_DEVICE_SOUND,
755
    VIR_DOMAIN_DEVICE_VIDEO,
756
    VIR_DOMAIN_DEVICE_HOSTDEV,
R
Richard Jones 已提交
757
    VIR_DOMAIN_DEVICE_WATCHDOG,
758
    VIR_DOMAIN_DEVICE_CONTROLLER,
759
    VIR_DOMAIN_DEVICE_GRAPHICS,
760 761

    VIR_DOMAIN_DEVICE_LAST,
762 763 764 765 766 767 768 769
};

typedef struct _virDomainDeviceDef virDomainDeviceDef;
typedef virDomainDeviceDef *virDomainDeviceDefPtr;
struct _virDomainDeviceDef {
    int type;
    union {
        virDomainDiskDefPtr disk;
770
        virDomainControllerDefPtr controller;
771
        virDomainFSDefPtr fs;
772 773 774
        virDomainNetDefPtr net;
        virDomainInputDefPtr input;
        virDomainSoundDefPtr sound;
775
        virDomainVideoDefPtr video;
776
        virDomainHostdevDefPtr hostdev;
R
Richard Jones 已提交
777
        virDomainWatchdogDefPtr watchdog;
778
        virDomainGraphicsDefPtr graphics;
779 780 781 782
    } data;
};


783
# define VIR_DOMAIN_MAX_BOOT_DEVS 4
784 785 786 787 788 789 790 791 792 793

enum virDomainBootOrder {
    VIR_DOMAIN_BOOT_FLOPPY,
    VIR_DOMAIN_BOOT_CDROM,
    VIR_DOMAIN_BOOT_DISK,
    VIR_DOMAIN_BOOT_NET,

    VIR_DOMAIN_BOOT_LAST,
};

794 795 796 797 798 799
enum virDomainBootMenu {
    VIR_DOMAIN_BOOT_MENU_DEFAULT = 0,
    VIR_DOMAIN_BOOT_MENU_ENABLED,
    VIR_DOMAIN_BOOT_MENU_DISABLED,
};

800 801 802 803
enum virDomainFeature {
    VIR_DOMAIN_FEATURE_ACPI,
    VIR_DOMAIN_FEATURE_APIC,
    VIR_DOMAIN_FEATURE_PAE,
J
Jim Fehlig 已提交
804
    VIR_DOMAIN_FEATURE_HAP,
805 806 807 808 809 810 811 812 813 814 815 816 817

    VIR_DOMAIN_FEATURE_LAST
};

enum virDomainLifecycleAction {
    VIR_DOMAIN_LIFECYCLE_DESTROY,
    VIR_DOMAIN_LIFECYCLE_RESTART,
    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_PRESERVE,

    VIR_DOMAIN_LIFECYCLE_LAST
};

818 819 820 821 822 823 824 825 826 827 828
enum virDomainLifecycleCrashAction {
    VIR_DOMAIN_LIFECYCLE_CRASH_DESTROY,
    VIR_DOMAIN_LIFECYCLE_CRASH_RESTART,
    VIR_DOMAIN_LIFECYCLE_CRASH_RESTART_RENAME,
    VIR_DOMAIN_LIFECYCLE_CRASH_PRESERVE,
    VIR_DOMAIN_LIFECYCLE_CRASH_COREDUMP_DESTROY,
    VIR_DOMAIN_LIFECYCLE_CRASH_COREDUMP_RESTART,

    VIR_DOMAIN_LIFECYCLE_CRASH_LAST
};

829 830 831 832 833 834 835 836 837
/* Operating system configuration data & machine / arch */
typedef struct _virDomainOSDef virDomainOSDef;
typedef virDomainOSDef *virDomainOSDefPtr;
struct _virDomainOSDef {
    char *type;
    char *arch;
    char *machine;
    int nBootDevs;
    int bootDevs[VIR_DOMAIN_BOOT_LAST];
838
    int bootmenu;
839
    char *init;
840 841 842 843 844 845 846
    char *kernel;
    char *initrd;
    char *cmdline;
    char *root;
    char *loader;
    char *bootloader;
    char *bootloaderArgs;
847
    int smbios_mode;
848 849
};

850 851 852 853 854 855 856
enum virDomainSeclabelType {
    VIR_DOMAIN_SECLABEL_DYNAMIC,
    VIR_DOMAIN_SECLABEL_STATIC,

    VIR_DOMAIN_SECLABEL_LAST,
};

857 858 859 860 861 862 863
/* Security configuration for domain */
typedef struct _virSecurityLabelDef virSecurityLabelDef;
typedef virSecurityLabelDef *virSecurityLabelDefPtr;
struct _virSecurityLabelDef {
    char *model;        /* name of security model */
    char *label;        /* security label string */
    char *imagelabel;   /* security image label string */
864
    int type;
865 866
};

867 868 869 870 871 872 873 874 875 876
enum virDomainTimerNameType {
    VIR_DOMAIN_TIMER_NAME_PLATFORM = 0,
    VIR_DOMAIN_TIMER_NAME_PIT,
    VIR_DOMAIN_TIMER_NAME_RTC,
    VIR_DOMAIN_TIMER_NAME_HPET,
    VIR_DOMAIN_TIMER_NAME_TSC,

    VIR_DOMAIN_TIMER_NAME_LAST,
};

877 878 879 880
enum virDomainTimerTrackType {
    VIR_DOMAIN_TIMER_TRACK_BOOT = 0,
    VIR_DOMAIN_TIMER_TRACK_GUEST,
    VIR_DOMAIN_TIMER_TRACK_WALL,
881

882
    VIR_DOMAIN_TIMER_TRACK_LAST,
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
};

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

    VIR_DOMAIN_TIMER_TICKPOLICY_LAST,
};

enum virDomainTimerModeType {
    VIR_DOMAIN_TIMER_MODE_AUTO = 0,
    VIR_DOMAIN_TIMER_MODE_NATIVE,
    VIR_DOMAIN_TIMER_MODE_EMULATE,
    VIR_DOMAIN_TIMER_MODE_PARAVIRT,
899
    VIR_DOMAIN_TIMER_MODE_SMPSAFE,
900 901 902 903

    VIR_DOMAIN_TIMER_MODE_LAST,
};

904 905 906 907 908 909 910 911
typedef struct _virDomainTimerCatchupDef virDomainTimerCatchupDef;
typedef virDomainTimerCatchupDef *virDomainTimerCatchupDefPtr;
struct _virDomainTimerCatchupDef {
    unsigned long threshold;
    unsigned long slew;
    unsigned long limit;
};

912 913 914 915 916 917 918
typedef struct _virDomainTimerDef virDomainTimerDef;
typedef virDomainTimerDef *virDomainTimerDefPtr;
struct _virDomainTimerDef {
    int name;
    int present;    /* unspecified = -1, no = 0, yes = 1 */
    int tickpolicy; /* none|catchup|merge|discard */

919 920 921 922
    virDomainTimerCatchupDef catchup;

    /* track is only valid for name='platform|rtc' */
    int track;  /* host|guest */
923 924 925 926 927 928

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

929 930 931
enum virDomainClockOffsetType {
    VIR_DOMAIN_CLOCK_OFFSET_UTC = 0,
    VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME = 1,
932
    VIR_DOMAIN_CLOCK_OFFSET_VARIABLE = 2,
933
    VIR_DOMAIN_CLOCK_OFFSET_TIMEZONE = 3,
934 935 936 937 938 939 940 941

    VIR_DOMAIN_CLOCK_OFFSET_LAST,
};

typedef struct _virDomainClockDef virDomainClockDef;
typedef virDomainClockDef *virDomainClockDefPtr;
struct _virDomainClockDef {
    int offset;
942

943 944 945 946 947 948 949 950 951
    union {
        /* Adjustment in seconds, relative to UTC, when
         * offset == VIR_DOMAIN_CLOCK_OFFSET_VARIABLE */
        long long adjustment;

        /* Timezone name, when
         * offset == VIR_DOMAIN_CLOCK_OFFSET_LOCALTIME */
        char *timezone;
    } data;
952 953 954

    int ntimers;
    virDomainTimerDefPtr *timers;
955 956
};

957
# define VIR_DOMAIN_CPUMASK_LEN 1024
958

C
Chris Lalancette 已提交
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

/* Snapshot state */
typedef struct _virDomainSnapshotDef virDomainSnapshotDef;
typedef virDomainSnapshotDef *virDomainSnapshotDefPtr;
struct _virDomainSnapshotDef {
    char *name;
    char *description;
    char *parent;
    time_t creationTime;
    int state;

    long active;
};

typedef struct _virDomainSnapshotObj virDomainSnapshotObj;
typedef virDomainSnapshotObj *virDomainSnapshotObjPtr;
struct _virDomainSnapshotObj {
    int refs;

    virDomainSnapshotDefPtr def;
};

typedef struct _virDomainSnapshotObjList virDomainSnapshotObjList;
typedef virDomainSnapshotObjList *virDomainSnapshotObjListPtr;
struct _virDomainSnapshotObjList {
    /* name string -> virDomainSnapshotObj  mapping
     * for O(1), lockless lookup-by-name */
    virHashTable *objs;
};

virDomainSnapshotDefPtr virDomainSnapshotDefParseString(const char *xmlStr,
                                                        int newSnapshot);
void virDomainSnapshotDefFree(virDomainSnapshotDefPtr def);
char *virDomainSnapshotDefFormat(char *domain_uuid,
                                 virDomainSnapshotDefPtr def,
                                 int internal);
virDomainSnapshotObjPtr virDomainSnapshotAssignDef(virDomainSnapshotObjListPtr snapshots,
                                                   const virDomainSnapshotDefPtr def);

int virDomainSnapshotObjListInit(virDomainSnapshotObjListPtr objs);
int virDomainSnapshotObjListGetNames(virDomainSnapshotObjListPtr snapshots,
                                     char **const names, int maxnames);
int virDomainSnapshotObjListNum(virDomainSnapshotObjListPtr snapshots);
virDomainSnapshotObjPtr virDomainSnapshotFindByName(const virDomainSnapshotObjListPtr snapshots,
                                                    const char *name);
void virDomainSnapshotObjListRemove(virDomainSnapshotObjListPtr snapshots,
                                    virDomainSnapshotObjPtr snapshot);
int virDomainSnapshotObjUnref(virDomainSnapshotObjPtr snapshot);
int virDomainSnapshotHasChildren(virDomainSnapshotObjPtr snap,
                                virDomainSnapshotObjListPtr snapshots);

1010 1011 1012 1013 1014 1015 1016 1017
/* Guest VM main configuration */
typedef struct _virDomainDef virDomainDef;
typedef virDomainDef *virDomainDefPtr;
struct _virDomainDef {
    int virtType;
    int id;
    unsigned char uuid[VIR_UUID_BUFLEN];
    char *name;
1018
    char *description;
1019

1020 1021 1022 1023 1024 1025 1026 1027 1028
    struct {
        unsigned long max_balloon;
        unsigned long cur_balloon;
        unsigned long hugepage_backed;
        unsigned long hard_limit;
        unsigned long soft_limit;
        unsigned long min_guarantee;
        unsigned long swap_hard_limit;
    } mem;
E
Eric Blake 已提交
1029 1030
    unsigned short vcpus;
    unsigned short maxvcpus;
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
    int cpumasklen;
    char *cpumask;

    /* These 3 are based on virDomainLifeCycleAction enum flags */
    int onReboot;
    int onPoweroff;
    int onCrash;

    virDomainOSDef os;
    char *emulator;
    int features;

1043
    virDomainClockDef clock;
1044

1045 1046
    int ngraphics;
    virDomainGraphicsDefPtr *graphics;
1047 1048 1049 1050

    int ndisks;
    virDomainDiskDefPtr *disks;

1051 1052 1053
    int ncontrollers;
    virDomainControllerDefPtr *controllers;

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
    int nfss;
    virDomainFSDefPtr *fss;

    int nnets;
    virDomainNetDefPtr *nets;

    int ninputs;
    virDomainInputDefPtr *inputs;

    int nsounds;
    virDomainSoundDefPtr *sounds;

1066 1067 1068
    int nvideos;
    virDomainVideoDefPtr *videos;

1069 1070 1071
    int nhostdevs;
    virDomainHostdevDefPtr *hostdevs;

E
Eric Blake 已提交
1072 1073 1074
    int nsmartcards;
    virDomainSmartcardDefPtr *smartcards;

1075 1076 1077 1078 1079 1080
    int nserials;
    virDomainChrDefPtr *serials;

    int nparallels;
    virDomainChrDefPtr *parallels;

1081 1082 1083
    int nchannels;
    virDomainChrDefPtr *channels;

1084
    /* Only 1 */
1085
    virDomainChrDefPtr console;
1086
    virSecurityLabelDef seclabel;
R
Richard Jones 已提交
1087
    virDomainWatchdogDefPtr watchdog;
1088
    virDomainMemballoonDefPtr memballoon;
1089
    virCPUDefPtr cpu;
1090
    virSysinfoDefPtr sysinfo;
1091 1092 1093

    void *namespaceData;
    virDomainXMLNamespace ns;
1094 1095 1096 1097 1098 1099
};

/* Guest VM runtime state */
typedef struct _virDomainObj virDomainObj;
typedef virDomainObj *virDomainObjPtr;
struct _virDomainObj {
1100
    virMutex lock;
1101
    int refs;
1102

1103 1104 1105 1106 1107
    int pid;
    int state;

    unsigned int autostart : 1;
    unsigned int persistent : 1;
1108
    unsigned int updated : 1;
1109 1110 1111

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

C
Chris Lalancette 已提交
1113 1114 1115
    virDomainSnapshotObjList snapshots;
    virDomainSnapshotObjPtr current_snapshot;

1116 1117
    void *privateData;
    void (*privateDataFreeFunc)(void *);
1118 1119
};

1120 1121 1122
typedef struct _virDomainObjList virDomainObjList;
typedef virDomainObjList *virDomainObjListPtr;
struct _virDomainObjList {
1123 1124 1125
    /* uuid string -> virDomainObj  mapping
     * for O(1), lockless lookup-by-uuid */
    virHashTable *objs;
1126
};
1127 1128

static inline int
D
Daniel P. Berrange 已提交
1129
virDomainObjIsActive(virDomainObjPtr dom)
1130 1131 1132 1133
{
    return dom->def->id != -1;
}

1134

1135 1136
int virDomainObjListInit(virDomainObjListPtr objs);
void virDomainObjListDeinit(virDomainObjListPtr objs);
1137

1138
virDomainObjPtr virDomainFindByID(const virDomainObjListPtr doms,
1139
                                  int id);
1140
virDomainObjPtr virDomainFindByUUID(const virDomainObjListPtr doms,
1141
                                    const unsigned char *uuid);
1142
virDomainObjPtr virDomainFindByName(const virDomainObjListPtr doms,
1143 1144 1145 1146 1147 1148
                                    const char *name);


void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
void virDomainInputDefFree(virDomainInputDefPtr def);
void virDomainDiskDefFree(virDomainDiskDefPtr def);
1149
void virDomainDiskHostDefFree(virDomainDiskHostDefPtr def);
1150
void virDomainControllerDefFree(virDomainControllerDefPtr def);
1151
void virDomainFSDefFree(virDomainFSDefPtr def);
1152
void virDomainNetDefFree(virDomainNetDefPtr def);
E
Eric Blake 已提交
1153
void virDomainSmartcardDefFree(virDomainSmartcardDefPtr def);
1154
void virDomainChrDefFree(virDomainChrDefPtr def);
1155
void virDomainChrSourceDefFree(virDomainChrSourceDefPtr def);
1156
void virDomainSoundDefFree(virDomainSoundDefPtr def);
1157
void virDomainMemballoonDefFree(virDomainMemballoonDefPtr def);
R
Richard Jones 已提交
1158
void virDomainWatchdogDefFree(virDomainWatchdogDefPtr def);
1159
void virDomainVideoDefFree(virDomainVideoDefPtr def);
1160
void virDomainHostdevDefFree(virDomainHostdevDefPtr def);
1161
void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
1162 1163 1164
int virDomainDeviceAddressIsValid(virDomainDeviceInfoPtr info,
                                  int type);
int virDomainDevicePCIAddressIsValid(virDomainDevicePCIAddressPtr addr);
1165
int virDomainDeviceDriveAddressIsValid(virDomainDeviceDriveAddressPtr addr);
1166
int virDomainDeviceVirtioSerialAddressIsValid(virDomainDeviceVirtioSerialAddressPtr addr);
1167 1168
int virDomainDeviceInfoIsSet(virDomainDeviceInfoPtr info);
void virDomainDeviceInfoClear(virDomainDeviceInfoPtr info);
1169
void virDomainDefClearPCIAddresses(virDomainDefPtr def);
D
Daniel P. Berrange 已提交
1170
void virDomainDefClearDeviceAliases(virDomainDefPtr def);
1171

1172 1173 1174 1175 1176 1177 1178 1179
typedef int (*virDomainDeviceInfoCallback)(virDomainDefPtr def,
                                           virDomainDeviceInfoPtr dev,
                                           void *opaque);

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

1180
void virDomainDefFree(virDomainDefPtr vm);
1181 1182 1183
void virDomainObjRef(virDomainObjPtr vm);
/* Returns 1 if the object was freed, 0 if more refs exist */
int virDomainObjUnref(virDomainObjPtr vm);
1184

1185 1186
/* live == true means def describes an active domain (being migrated or
 * restored) as opposed to a new persistent configuration of the domain */
1187
virDomainObjPtr virDomainAssignDef(virCapsPtr caps,
1188
                                   virDomainObjListPtr doms,
1189 1190
                                   const virDomainDefPtr def,
                                   bool live);
1191 1192 1193
void virDomainObjAssignDef(virDomainObjPtr domain,
                           const virDomainDefPtr def,
                           bool live);
1194
int virDomainObjSetDefTransient(virCapsPtr caps,
1195 1196
                                virDomainObjPtr domain,
                                bool live);
1197 1198 1199
virDomainDefPtr
virDomainObjGetPersistentDef(virCapsPtr caps,
                             virDomainObjPtr domain);
1200
void virDomainRemoveInactive(virDomainObjListPtr doms,
1201 1202
                             virDomainObjPtr dom);

1203
virDomainDeviceDefPtr virDomainDeviceDefParse(virCapsPtr caps,
1204
                                              const virDomainDefPtr def,
1205 1206
                                              const char *xmlStr,
                                              int flags);
1207
virDomainDefPtr virDomainDefParseString(virCapsPtr caps,
1208 1209
                                        const char *xmlStr,
                                        int flags);
1210
virDomainDefPtr virDomainDefParseFile(virCapsPtr caps,
1211 1212
                                      const char *filename,
                                      int flags);
1213
virDomainDefPtr virDomainDefParseNode(virCapsPtr caps,
1214
                                      xmlDocPtr doc,
1215 1216
                                      xmlNodePtr root,
                                      int flags);
1217

1218
virDomainObjPtr virDomainObjParseFile(virCapsPtr caps,
1219
                                      const char *filename);
1220
virDomainObjPtr virDomainObjParseNode(virCapsPtr caps,
1221 1222 1223
                                      xmlDocPtr xml,
                                      xmlNodePtr root);

1224
int virDomainDefAddImplicitControllers(virDomainDefPtr def);
1225

1226
char *virDomainDefFormat(virDomainDefPtr def,
1227 1228
                         int flags);

1229
int virDomainCpuSetParse(const char **str,
1230 1231 1232
                         char sep,
                         char *cpuset,
                         int maxcpu);
1233
char *virDomainCpuSetFormat(char *cpuset,
1234 1235
                            int maxcpu);

1236 1237 1238 1239
int virDomainDiskInsert(virDomainDefPtr def,
                        virDomainDiskDefPtr disk);
void virDomainDiskInsertPreAlloced(virDomainDefPtr def,
                                   virDomainDiskDefPtr disk);
1240
int virDomainDiskDefAssignAddress(virCapsPtr caps, virDomainDiskDefPtr def);
1241

1242 1243
void virDomainDiskRemove(virDomainDefPtr def, size_t i);

1244 1245 1246 1247 1248
int virDomainControllerInsert(virDomainDefPtr def,
                              virDomainControllerDefPtr controller);
void virDomainControllerInsertPreAlloced(virDomainDefPtr def,
                                         virDomainControllerDefPtr controller);

1249
int virDomainSaveXML(const char *configDir,
1250 1251 1252
                     virDomainDefPtr def,
                     const char *xml);

1253
int virDomainSaveConfig(const char *configDir,
1254
                        virDomainDefPtr def);
1255
int virDomainSaveStatus(virCapsPtr caps,
1256
                        const char *statusDir,
1257
                        virDomainObjPtr obj) ATTRIBUTE_RETURN_CHECK;
1258

1259 1260 1261 1262
typedef void (*virDomainLoadConfigNotify)(virDomainObjPtr dom,
                                          int newDomain,
                                          void *opaque);

1263
int virDomainLoadAllConfigs(virCapsPtr caps,
1264
                            virDomainObjListPtr doms,
1265
                            const char *configDir,
1266
                            const char *autostartDir,
1267
                            int liveStatus,
1268 1269
                            virDomainLoadConfigNotify notify,
                            void *opaque);
1270

1271
int virDomainDeleteConfig(const char *configDir,
1272
                          const char *autostartDir,
1273 1274
                          virDomainObjPtr dom);

1275
char *virDomainConfigFile(const char *dir,
1276 1277
                          const char *name);

1278 1279 1280 1281
int virDiskNameToBusDeviceIndex(virDomainDiskDefPtr disk,
                                int *busIdx,
                                int *devIdx);

1282
virDomainFSDefPtr virDomainGetRootFilesystem(virDomainDefPtr def);
1283 1284
int virDomainVideoDefaultType(virDomainDefPtr def);
int virDomainVideoDefaultRAM(virDomainDefPtr def, int type);
1285

1286 1287 1288 1289
int virDomainObjIsDuplicate(virDomainObjListPtr doms,
                            virDomainDefPtr def,
                            unsigned int check_active);

D
Daniel P. Berrange 已提交
1290 1291
void virDomainObjLock(virDomainObjPtr obj);
void virDomainObjUnlock(virDomainObjPtr obj);
1292

1293 1294 1295 1296 1297 1298 1299 1300 1301
int virDomainObjListNumOfDomains(virDomainObjListPtr doms, int active);

int virDomainObjListGetActiveIDs(virDomainObjListPtr doms,
                                 int *ids,
                                 int maxids);
int virDomainObjListGetInactiveNames(virDomainObjListPtr doms,
                                     char **const names,
                                     int maxnames);

E
Eric Blake 已提交
1302 1303 1304 1305 1306 1307 1308 1309 1310
typedef int (*virDomainSmartcardDefIterator)(virDomainDefPtr def,
                                             virDomainSmartcardDefPtr dev,
                                             void *opaque);

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

1311 1312 1313 1314 1315 1316 1317 1318 1319
typedef int (*virDomainChrDefIterator)(virDomainDefPtr def,
                                       virDomainChrDefPtr dev,
                                       void *opaque);

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

1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
typedef int (*virDomainDiskDefPathIterator)(virDomainDiskDefPtr disk,
                                            const char *path,
                                            size_t depth,
                                            void *opaque);

int virDomainDiskDefForeachPath(virDomainDiskDefPtr disk,
                                bool allowProbing,
                                bool ignoreOpenFailure,
                                virDomainDiskDefPathIterator iter,
                                void *opaque);

1331 1332 1333
typedef const char* (*virLifecycleToStringFunc)(int type);
typedef int (*virLifecycleFromStringFunc)(const char *type);

1334 1335 1336 1337
VIR_ENUM_DECL(virDomainVirt)
VIR_ENUM_DECL(virDomainBoot)
VIR_ENUM_DECL(virDomainFeature)
VIR_ENUM_DECL(virDomainLifecycle)
1338
VIR_ENUM_DECL(virDomainLifecycleCrash)
1339
VIR_ENUM_DECL(virDomainDevice)
1340 1341
VIR_ENUM_DECL(virDomainDeviceAddress)
VIR_ENUM_DECL(virDomainDeviceAddressMode)
1342 1343 1344
VIR_ENUM_DECL(virDomainDisk)
VIR_ENUM_DECL(virDomainDiskDevice)
VIR_ENUM_DECL(virDomainDiskBus)
1345
VIR_ENUM_DECL(virDomainDiskCache)
1346
VIR_ENUM_DECL(virDomainDiskErrorPolicy)
M
MORITA Kazutaka 已提交
1347
VIR_ENUM_DECL(virDomainDiskProtocol)
M
Matthias Dahl 已提交
1348
VIR_ENUM_DECL(virDomainDiskIo)
1349
VIR_ENUM_DECL(virDomainController)
1350
VIR_ENUM_DECL(virDomainControllerModel)
1351
VIR_ENUM_DECL(virDomainFS)
1352
VIR_ENUM_DECL(virDomainFSAccessMode)
1353
VIR_ENUM_DECL(virDomainNet)
1354
VIR_ENUM_DECL(virDomainNetBackend)
1355
VIR_ENUM_DECL(virDomainChrDevice)
1356
VIR_ENUM_DECL(virDomainChrChannelTarget)
1357
VIR_ENUM_DECL(virDomainChrConsoleTarget)
E
Eric Blake 已提交
1358
VIR_ENUM_DECL(virDomainSmartcard)
1359
VIR_ENUM_DECL(virDomainChr)
1360
VIR_ENUM_DECL(virDomainChrTcpProtocol)
1361
VIR_ENUM_DECL(virDomainSoundModel)
1362
VIR_ENUM_DECL(virDomainMemballoonModel)
1363
VIR_ENUM_DECL(virDomainSysinfo)
1364
VIR_ENUM_DECL(virDomainSmbiosMode)
R
Richard Jones 已提交
1365 1366
VIR_ENUM_DECL(virDomainWatchdogModel)
VIR_ENUM_DECL(virDomainWatchdogAction)
1367
VIR_ENUM_DECL(virDomainVideo)
1368 1369
VIR_ENUM_DECL(virDomainHostdevMode)
VIR_ENUM_DECL(virDomainHostdevSubsys)
1370 1371 1372
VIR_ENUM_DECL(virDomainInput)
VIR_ENUM_DECL(virDomainInputBus)
VIR_ENUM_DECL(virDomainGraphics)
1373 1374
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelName)
VIR_ENUM_DECL(virDomainGraphicsSpiceChannelMode)
1375 1376
/* from libvirt.h */
VIR_ENUM_DECL(virDomainState)
1377
VIR_ENUM_DECL(virDomainSeclabel)
1378
VIR_ENUM_DECL(virDomainClockOffset)
1379

1380 1381
VIR_ENUM_DECL(virDomainNetdevMacvtap)

1382
VIR_ENUM_DECL(virDomainTimerName)
1383
VIR_ENUM_DECL(virDomainTimerTrack)
1384 1385 1386
VIR_ENUM_DECL(virDomainTimerTickpolicy)
VIR_ENUM_DECL(virDomainTimerMode)

1387
#endif /* __DOMAIN_CONF_H */