driver.h 63.8 KB
Newer Older
1
/*
2
 * driver.h: description of the set of interfaces provided by a
3 4 5 6
 *           entry point to the virtualization engine
 */

#ifndef __VIR_DRIVER_H__
7
# define __VIR_DRIVER_H__
8

9
# include "config.h"
10

11
# include <unistd.h>
12

13
# include "internal.h"
M
Martin Kletzander 已提交
14
# include "viruri.h"
15 16 17 18
/*
 * List of registered drivers numbers
 */
typedef enum {
19 20 21
    VIR_DRV_XEN_UNIFIED = 1,
    VIR_DRV_TEST = 2,
    VIR_DRV_QEMU = 3,
22
    VIR_DRV_REMOTE = 4,
23
    VIR_DRV_OPENVZ = 5,
24 25
    VIR_DRV_LXC = 6,
    VIR_DRV_UML = 7,
26
    VIR_DRV_VBOX = 8,
D
Daniel Veillard 已提交
27
    VIR_DRV_ONE = 9,
28
    VIR_DRV_ESX = 10,
29
    VIR_DRV_PHYP = 11,
30
    VIR_DRV_XENAPI = 12,
J
Jim Fehlig 已提交
31 32
    VIR_DRV_VMWARE = 13,
    VIR_DRV_LIBXL = 14,
M
Matthias Bolte 已提交
33
    VIR_DRV_HYPERV = 15,
34 35 36
} virDrvNo;


37 38 39 40 41 42 43 44 45 46 47 48 49 50
/* Status codes returned from driver open call. */
typedef enum {
    /* Opened successfully. */
    VIR_DRV_OPEN_SUCCESS = 0,

    /* 'name' is not for us. */
    VIR_DRV_OPEN_DECLINED = -1,

    /* 'name' is for us, but there was some error.  virConnectOpen will
     * return an error rather than continue probing the other drivers.
     */
    VIR_DRV_OPEN_ERROR = -2,
} virDrvOpenStatus;

D
Daniel Veillard 已提交
51

52
/* Internal feature-detection macro.  Don't call drv->supports_feature
53 54
 * directly if you don't have to, because it may be NULL, use this macro
 * instead.
55
 *
56 57 58
 * Note that this treats a possible error returned by drv->supports_feature
 * the same as not supported. If you care about the error, call
 * drv->supports_feature directly.
59 60
 *
 * Returns:
61
 *   != 0  Feature is supported.
62 63
 *   0     Feature is not supported.
 */
64 65 66
# define VIR_DRV_SUPPORTS_FEATURE(drv,conn,feature)                         \
    ((drv)->supports_feature ?                                              \
        (drv)->supports_feature((conn), (feature)) > 0 : 0)
67

68
typedef virDrvOpenStatus
69
        (*virDrvOpen)			(virConnectPtr conn,
70
                             virConnectAuthPtr auth,
71
                             unsigned int flags);
72
typedef int
73
        (*virDrvClose)			(virConnectPtr conn);
74
typedef int
D
Daniel P. Berrange 已提交
75
    (*virDrvDrvSupportsFeature) (virConnectPtr conn, int feature);
76
typedef const char *
77
        (*virDrvGetType)		(virConnectPtr conn);
78
typedef int
79 80
        (*virDrvGetVersion)		(virConnectPtr conn,
                                         unsigned long *hvVer);
81 82 83
typedef int
        (*virDrvGetLibVersion)      (virConnectPtr conn,
                                     unsigned long *libVer);
84 85 86 87
typedef char *
    (*virDrvGetHostname)    (virConnectPtr conn);
typedef char *
    (*virDrvGetURI)         (virConnectPtr conn);
E
Eric Blake 已提交
88 89 90
typedef char *
    (*virDrvGetSysinfo)     (virConnectPtr conn,
                             unsigned int flags);
91
typedef int
92 93
        (*virDrvGetMaxVcpus)		(virConnectPtr conn,
                                         const char *type);
94
typedef int
95 96
        (*virDrvNodeGetInfo)		(virConnectPtr conn,
                                         virNodeInfoPtr info);
97
typedef char *
98
        (*virDrvGetCapabilities) (virConnectPtr conn);
99
typedef int
100 101 102
        (*virDrvListDomains)		(virConnectPtr conn,
                                         int *ids,
                                         int maxids);
103
typedef int
104
        (*virDrvNumOfDomains)		(virConnectPtr conn);
105
typedef virDomainPtr
106
        (*virDrvDomainCreateXML)	(virConnectPtr conn,
107 108
                                         const char *xmlDesc,
                                         unsigned int flags);
109
typedef virDomainPtr
110 111
        (*virDrvDomainLookupByID)	(virConnectPtr conn,
                                         int id);
112
typedef virDomainPtr
113 114
        (*virDrvDomainLookupByUUID)	(virConnectPtr conn,
                                         const unsigned char *uuid);
115
typedef virDomainPtr
116 117
        (*virDrvDomainLookupByName)	(virConnectPtr conn,
                                         const char *name);
118
typedef int
119
        (*virDrvDomainSuspend)		(virDomainPtr domain);
120
typedef int
121
        (*virDrvDomainResume)		(virDomainPtr domain);
122 123 124 125 126
typedef int
        (*virDrvDomainPMSuspendForDuration) (virDomainPtr,
                                             unsigned int target,
                                             unsigned long long duration,
                                             unsigned int flags);
127 128 129
typedef int
        (*virDrvDomainPMWakeup)     (virDomainPtr domain,
                                     unsigned int flags);
130
typedef int
131
        (*virDrvDomainShutdown)		(virDomainPtr domain);
132
typedef int
133 134
        (*virDrvDomainReboot)		(virDomainPtr domain,
                                         unsigned int flags);
X
Xu He Jie 已提交
135 136 137
typedef int
        (*virDrvDomainReset)        (virDomainPtr domain,
                                         unsigned int flags);
138
typedef int
139
        (*virDrvDomainDestroy)		(virDomainPtr domain);
140 141 142
typedef int
        (*virDrvDomainDestroyFlags) (virDomainPtr domain,
                                         unsigned int flags);
143
typedef char *
144
        (*virDrvDomainGetOSType)	(virDomainPtr domain);
145
typedef unsigned long long
146
        (*virDrvDomainGetMaxMemory)	(virDomainPtr domain);
147
typedef int
148 149
        (*virDrvDomainSetMaxMemory)	(virDomainPtr domain,
                                         unsigned long memory);
150
typedef int
151 152
        (*virDrvDomainSetMemory)	(virDomainPtr domain,
                                         unsigned long memory);
153 154 155 156
typedef int
        (*virDrvDomainSetMemoryFlags)	(virDomainPtr domain,
                                         unsigned long memory,
                                         unsigned int flags);
157 158 159
typedef int
        (*virDrvDomainSetMemoryParameters)
                                        (virDomainPtr domain,
160
                                         virTypedParameterPtr params,
161 162 163 164 165
                                         int nparams,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetMemoryParameters)
                                        (virDomainPtr domain,
166
                                         virTypedParameterPtr params,
167 168
                                         int *nparams,
                                         unsigned int flags);
169 170 171 172 173 174 175 176 177 178 179 180 181
typedef int
        (*virDrvDomainSetNumaParameters)
                                        (virDomainPtr domain,
                                         virTypedParameterPtr params,
                                         int nparams,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetNumaParameters)
                                        (virDomainPtr domain,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         unsigned int flags);

182 183 184
typedef int
        (*virDrvDomainSetBlkioParameters)
                                        (virDomainPtr domain,
185
                                         virTypedParameterPtr params,
186 187 188 189 190
                                         int nparams,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetBlkioParameters)
                                        (virDomainPtr domain,
191
                                         virTypedParameterPtr params,
192 193
                                         int *nparams,
                                         unsigned int flags);
194
typedef int
195 196
        (*virDrvDomainGetInfo)		(virDomainPtr domain,
                                         virDomainInfoPtr info);
197 198 199 200 201
typedef int
        (*virDrvDomainGetState)         (virDomainPtr domain,
                                         int *state,
                                         int *reason,
                                         unsigned int flags);
202 203 204 205
typedef int
        (*virDrvDomainGetControlInfo)   (virDomainPtr domain,
                                         virDomainControlInfoPtr info,
                                         unsigned int flags);
206
typedef int
207 208
        (*virDrvDomainSave)		(virDomainPtr domain,
                                         const char *to);
209 210 211 212 213
typedef int
        (*virDrvDomainSaveFlags)	(virDomainPtr domain,
                                         const char *to,
                                         const char *dxml,
                                         unsigned int flags);
214
typedef int
215 216
        (*virDrvDomainRestore)		(virConnectPtr conn,
                                         const char *from);
217 218 219 220 221
typedef int
        (*virDrvDomainRestoreFlags)	(virConnectPtr conn,
                                         const char *from,
                                         const char *dxml,
                                         unsigned int flags);
222 223 224 225 226 227 228 229 230
typedef char *
        (*virDrvDomainSaveImageGetXMLDesc)      (virConnectPtr conn,
                                                 const char *file,
                                                 unsigned int flags);
typedef int
        (*virDrvDomainSaveImageDefineXML)       (virConnectPtr conn,
                                                 const char *file,
                                                 const char *dxml,
                                                 unsigned int flags);
D
Daniel Veillard 已提交
231
typedef int
232 233
        (*virDrvDomainCoreDump)		(virDomainPtr domain,
                                         const char *to,
234
                                         unsigned int flags);
235 236 237 238 239
typedef char *
        (*virDrvDomainScreenshot)   (virDomainPtr domain,
                                         virStreamPtr stream,
                                         unsigned int screen,
                                         unsigned int flags);
240
typedef char *
241
        (*virDrvDomainGetXMLDesc)		(virDomainPtr dom,
242
                                                 unsigned int flags);
243 244 245 246 247 248 249 250 251 252
typedef char *
        (*virDrvConnectDomainXMLFromNative) (virConnectPtr conn,
                                             const char *nativeFormat,
                                             const char *nativeConfig,
                                             unsigned int flags);
typedef char *
        (*virDrvConnectDomainXMLToNative) (virConnectPtr conn,
                                           const char *nativeFormat,
                                           const char *domainXml,
                                           unsigned int flags);
253
typedef int
254 255 256 257 258 259 260
        (*virDrvListDefinedDomains) (virConnectPtr conn,
                                     char **const names,
                                     int maxnames);
typedef int
        (*virDrvListAllDomains) (virConnectPtr conn,
                                 virDomainPtr **domains,
                                 unsigned int flags);
261
typedef int
262
        (*virDrvNumOfDefinedDomains)	(virConnectPtr conn);
263
typedef int
264
        (*virDrvDomainCreate)		(virDomainPtr dom);
265 266 267
typedef int
        (*virDrvDomainCreateWithFlags)	(virDomainPtr dom,
                                         unsigned int flags);
268
typedef virDomainPtr
269 270
        (*virDrvDomainDefineXML)	(virConnectPtr conn,
                                         const char *xml);
271
typedef int
272
        (*virDrvDomainUndefine)		(virDomainPtr dom);
O
Osier Yang 已提交
273 274 275
typedef int
        (*virDrvDomainUndefineFlags)	(virDomainPtr dom,
                                         unsigned int flags);
276
typedef int
277 278
        (*virDrvDomainSetVcpus)		(virDomainPtr domain,
                                         unsigned int nvcpus);
E
Eric Blake 已提交
279 280 281 282 283 284 285
typedef int
        (*virDrvDomainSetVcpusFlags)	(virDomainPtr domain,
                                         unsigned int nvcpus,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetVcpusFlags)	(virDomainPtr domain,
                                         unsigned int flags);
286
typedef int
287 288 289 290
        (*virDrvDomainPinVcpu)		(virDomainPtr domain,
                                         unsigned int vcpu,
                                         unsigned char *cpumap,
                                         int maplen);
291 292 293 294 295 296
typedef int
        (*virDrvDomainPinVcpuFlags)     (virDomainPtr domain,
                                         unsigned int vcpu,
                                         unsigned char *cpumap,
                                         int maplen,
                                         unsigned int flags);
297
typedef int
E
Eric Blake 已提交
298
        (*virDrvDomainGetVcpuPinInfo)   (virDomainPtr domain,
299 300 301 302 303
                                         int ncpumaps,
                                         unsigned char *cpumaps,
                                         int maplen,
                                         unsigned int flags);

304
typedef int
305 306 307 308 309
        (*virDrvDomainGetVcpus)		(virDomainPtr domain,
                                         virVcpuInfoPtr info,
                                         int maxinfo,
                                         unsigned char *cpumaps,
                                         int maplen);
310
typedef int
311
        (*virDrvDomainGetMaxVcpus)	(virDomainPtr domain);
312 313 314 315 316 317 318

typedef int
        (*virDrvDomainGetSecurityLabel)	(virDomainPtr domain,
                                         virSecurityLabelPtr seclabel);
typedef int
        (*virDrvNodeGetSecurityModel)	(virConnectPtr conn,
                                         virSecurityModelPtr secmodel);
319
typedef int
320 321
        (*virDrvDomainAttachDevice)	(virDomainPtr domain,
                                         const char *xml);
J
Jim Fehlig 已提交
322 323 324 325
typedef int
        (*virDrvDomainAttachDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
326
typedef int
327 328
        (*virDrvDomainDetachDevice)	(virDomainPtr domain,
                                         const char *xml);
J
Jim Fehlig 已提交
329 330 331 332
typedef int
        (*virDrvDomainDetachDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
333 334 335 336
typedef int
        (*virDrvDomainUpdateDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
337
typedef int
338 339
        (*virDrvDomainGetAutostart)	(virDomainPtr domain,
                                         int *autostart);
340
typedef int
341 342
        (*virDrvDomainSetAutostart)	(virDomainPtr domain,
                                         int autostart);
343

344
typedef char *
345 346
        (*virDrvDomainGetSchedulerType)	(virDomainPtr domain,
                                         int *nparams);
347

348
typedef int
349 350
        (*virDrvDomainGetSchedulerParameters)
                                        (virDomainPtr domain,
351
                                         virTypedParameterPtr params,
352
                                         int *nparams);
353

354 355 356 357 358 359 360
typedef int
        (*virDrvDomainGetSchedulerParametersFlags)
                                        (virDomainPtr domain,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         unsigned int flags);

361
typedef int
362 363
        (*virDrvDomainSetSchedulerParameters)
                                        (virDomainPtr domain,
364
                                         virTypedParameterPtr params,
365
                                         int nparams);
366

367 368 369
typedef int
        (*virDrvDomainSetSchedulerParametersFlags)
                                        (virDomainPtr domain,
370
                                         virTypedParameterPtr params,
371 372 373
                                         int nparams,
                                         unsigned int flags);

374 375 376 377 378
typedef int
    (*virDrvDomainBlockStats)
                    (virDomainPtr domain,
                     const char *path,
                     struct _virDomainBlockStats *stats);
379 380 381 382 383 384 385
typedef int
    (*virDrvDomainBlockStatsFlags)
                    (virDomainPtr domain,
                     const char *path,
                     virTypedParameterPtr params,
                     int *nparams,
                     unsigned int flags);
386 387 388 389 390
typedef int
    (*virDrvDomainInterfaceStats)
                    (virDomainPtr domain,
                     const char *path,
                     struct _virDomainInterfaceStats *stats);
391 392 393 394 395 396 397 398 399 400
typedef int
    (*virDrvDomainSetInterfaceParameters) (virDomainPtr dom,
                                          const char *device,
                                          virTypedParameterPtr params,
                                          int nparams, unsigned int flags);
typedef int
    (*virDrvDomainGetInterfaceParameters) (virDomainPtr dom,
                                          const char *device,
                                          virTypedParameterPtr params,
                                          int *nparams, unsigned int flags);
401

402 403 404 405
typedef int
    (*virDrvDomainMemoryStats)
                    (virDomainPtr domain,
                     struct _virDomainMemoryStat *stats,
406 407
                     unsigned int nr_stats,
                     unsigned int flags);
408

R
Richard W.M. Jones 已提交
409 410 411 412 413
typedef int
    (*virDrvDomainBlockPeek)
                    (virDomainPtr domain,
                     const char *path,
                     unsigned long long offset, size_t size,
414 415
                     void *buffer,
                     unsigned int flags);
O
Osier Yang 已提交
416 417 418 419 420 421
typedef int
    (*virDrvDomainBlockResize)
                    (virDomainPtr domain,
                     const char *path,
                     unsigned long long size,
                     unsigned int flags);
R
Richard W.M. Jones 已提交
422 423 424 425 426 427
typedef int
    (*virDrvDomainMemoryPeek)
                    (virDomainPtr domain,
                     unsigned long long start, size_t size,
                     void *buffer,
                     unsigned int flags);
428 429 430 431 432 433
typedef int
    (*virDrvDomainGetBlockInfo)
                    (virDomainPtr domain,
                     const char *path,
                     virDomainBlockInfoPtr info,
                     unsigned int flags);
R
Richard W.M. Jones 已提交
434

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
typedef int
    (*virDrvDomainMigratePrepare)
                    (virConnectPtr dconn,
                     char **cookie,
                     int *cookielen,
                     const char *uri_in,
                     char **uri_out,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource);

typedef int
    (*virDrvDomainMigratePerform)
                    (virDomainPtr domain,
                     const char *cookie,
                     int cookielen,
                     const char *uri,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource);

typedef virDomainPtr
    (*virDrvDomainMigrateFinish)
                    (virConnectPtr dconn,
                     const char *dname,
                     const char *cookie,
                     int cookielen,
                     const char *uri,
                     unsigned long flags);

465 466 467
typedef struct _virDriver virDriver;
typedef virDriver *virDriverPtr;

468 469 470 471
typedef int
    (*virDrvNodeGetCPUStats)
                    (virConnectPtr conn,
                     int cpuNum,
472
                     virNodeCPUStatsPtr params,
473 474 475
                     int *nparams,
                     unsigned int flags);

476 477 478 479
typedef int
    (*virDrvNodeGetMemoryStats)
                    (virConnectPtr conn,
                     int cellNum,
480
                     virNodeMemoryStatsPtr params,
481 482 483
                     int *nparams,
                     unsigned int flags);

484 485 486 487 488 489 490
typedef int
    (*virDrvNodeGetCellsFreeMemory)
                    (virConnectPtr conn,
                     unsigned long long *freeMems,
                     int startCell,
                     int maxCells);

491 492
typedef unsigned long long
    (*virDrvNodeGetFreeMemory)
493
                    (virConnectPtr conn);
494

495 496 497
typedef int
    (*virDrvDomainEventRegister)
                    (virConnectPtr conn,
498
                     virConnectDomainEventCallback cb,
499 500
                     void *opaque,
                     virFreeCallback freecb);
501 502 503 504

typedef int
    (*virDrvDomainEventDeregister)
                    (virConnectPtr conn,
505
                     virConnectDomainEventCallback cb);
506

D
Daniel Veillard 已提交
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
typedef int
    (*virDrvDomainMigratePrepare2)
                    (virConnectPtr dconn,
                     char **cookie,
                     int *cookielen,
                     const char *uri_in,
                     char **uri_out,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource,
                     const char *dom_xml);

typedef virDomainPtr
    (*virDrvDomainMigrateFinish2)
                    (virConnectPtr dconn,
                     const char *dname,
                     const char *cookie,
                     int cookielen,
                     const char *uri,
                     unsigned long flags,
                     int retcode);

529 530 531 532 533 534 535 536 537 538
typedef int
    (*virDrvNodeDeviceDettach)
                    (virNodeDevicePtr dev);
typedef int
    (*virDrvNodeDeviceReAttach)
                    (virNodeDevicePtr dev);
typedef int
    (*virDrvNodeDeviceReset)
                    (virNodeDevicePtr dev);

C
Chris Lalancette 已提交
539 540
typedef int
    (*virDrvDomainMigratePrepareTunnel)
541
                    (virConnectPtr dconn,
C
Chris Lalancette 已提交
542 543 544 545 546 547
                     virStreamPtr st,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource,
                     const char *dom_xml);

548 549 550 551
typedef int
    (*virDrvConnectIsEncrypted)(virConnectPtr conn);
typedef int
    (*virDrvConnectIsSecure)(virConnectPtr conn);
J
Jiri Denemark 已提交
552 553
typedef int
    (*virDrvConnectIsAlive)(virConnectPtr conn);
554 555 556 557
typedef int
    (*virDrvDomainIsActive)(virDomainPtr dom);
typedef int
    (*virDrvDomainIsPersistent)(virDomainPtr dom);
O
Osier Yang 已提交
558 559
typedef int
    (*virDrvDomainIsUpdated)(virDomainPtr dom);
560

J
Jiri Denemark 已提交
561
typedef int
562
    (*virDrvCompareCPU)(virConnectPtr conn,
J
Jiri Denemark 已提交
563 564
                        const char *cpu,
                        unsigned int flags);
565
typedef char *
566
    (*virDrvBaselineCPU)(virConnectPtr conn,
567 568 569
                         const char **xmlCPUs,
                         unsigned int ncpus,
                         unsigned int flags);
J
Jiri Denemark 已提交
570

571 572 573 574
typedef int
    (*virDrvDomainGetJobInfo)(virDomainPtr domain,
                              virDomainJobInfoPtr info);

575 576 577
typedef int
    (*virDrvDomainAbortJob)(virDomainPtr domain);

578 579 580 581
typedef int
    (*virDrvDomainMigrateSetMaxDowntime)(virDomainPtr domain,
                                         unsigned long long downtime,
                                         unsigned int flags);
582 583 584 585
typedef int
    (*virDrvDomainMigrateSetMaxSpeed)(virDomainPtr domain,
                                      unsigned long bandwidth,
                                      unsigned int flags);
586

587 588 589 590 591
typedef int
    (*virDrvDomainMigrateGetMaxSpeed)(virDomainPtr domain,
                                      unsigned long *bandwidth,
                                      unsigned int flags);

592 593 594 595 596 597 598 599 600 601 602 603
typedef int
    (*virDrvDomainEventRegisterAny)(virConnectPtr conn,
                                    virDomainPtr dom,
                                    int eventID,
                                    virConnectDomainEventGenericCallback cb,
                                    void *opaque,
                                    virFreeCallback freecb);

typedef int
    (*virDrvDomainEventDeregisterAny)(virConnectPtr conn,
                                      int callbackID);

604 605 606 607 608 609 610 611 612
typedef int
    (*virDrvDomainManagedSave)(virDomainPtr domain, unsigned int flags);

typedef int
    (*virDrvDomainHasManagedSaveImage)(virDomainPtr domain, unsigned int flags);

typedef int
    (*virDrvDomainManagedSaveRemove)(virDomainPtr domain, unsigned int flags);

C
Chris Lalancette 已提交
613 614 615 616 617 618
typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotCreateXML)(virDomainPtr domain,
                                     const char *xmlDesc,
                                     unsigned int flags);

typedef char *
619 620
    (*virDrvDomainSnapshotGetXMLDesc)(virDomainSnapshotPtr snapshot,
                                      unsigned int flags);
C
Chris Lalancette 已提交
621 622 623 624 625 626 627 628 629

typedef int
    (*virDrvDomainSnapshotNum)(virDomainPtr domain, unsigned int flags);

typedef int
    (*virDrvDomainSnapshotListNames)(virDomainPtr domain, char **names,
                                     int nameslen,
                                     unsigned int flags);

630 631 632 633 634 635 636 637 638 639
typedef int
    (*virDrvDomainSnapshotNumChildren)(virDomainSnapshotPtr snapshot,
                                       unsigned int flags);

typedef int
    (*virDrvDomainSnapshotListChildrenNames)(virDomainSnapshotPtr snapshot,
                                             char **names,
                                             int nameslen,
                                             unsigned int flags);

C
Chris Lalancette 已提交
640 641 642 643 644 645 646 647
typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotLookupByName)(virDomainPtr domain,
                                        const char *name,
                                        unsigned int flags);

typedef int
    (*virDrvDomainHasCurrentSnapshot)(virDomainPtr domain, unsigned int flags);

648 649 650 651
typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotGetParent)(virDomainSnapshotPtr snapshot,
                                     unsigned int flags);

C
Chris Lalancette 已提交
652 653 654 655
typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotCurrent)(virDomainPtr domain,
                                   unsigned int flags);

E
Eric Blake 已提交
656 657 658 659 660 661 662 663
typedef int
    (*virDrvDomainSnapshotIsCurrent)(virDomainSnapshotPtr snapshot,
                                     unsigned int flags);

typedef int
    (*virDrvDomainSnapshotHasMetadata)(virDomainSnapshotPtr snapshot,
                                       unsigned int flags);

C
Chris Lalancette 已提交
664 665 666 667 668 669 670 671
typedef int
    (*virDrvDomainRevertToSnapshot)(virDomainSnapshotPtr snapshot,
                                    unsigned int flags);

typedef int
    (*virDrvDomainSnapshotDelete)(virDomainSnapshotPtr snapshot,
                                  unsigned int flags);

C
Chris Lalancette 已提交
672
typedef int
673
    (*virDrvDomainQemuMonitorCommand)(virDomainPtr domain, const char *cmd,
C
Chris Lalancette 已提交
674 675
                                      char **result, unsigned int flags);

676
/* Choice of unsigned int rather than pid_t is intentional.  */
677 678
typedef virDomainPtr
    (*virDrvDomainQemuAttach)(virConnectPtr conn,
679
                              unsigned int pid_value,
680 681
                              unsigned int flags);

682 683
typedef int
    (*virDrvDomainOpenConsole)(virDomainPtr dom,
684
                               const char *dev_name,
685 686
                               virStreamPtr st,
                               unsigned int flags);
687 688 689 690 691
typedef int
    (*virDrvDomainOpenGraphics)(virDomainPtr dom,
                                unsigned int idx,
                                int fd,
                                unsigned int flags);
C
Chris Lalancette 已提交
692

693 694 695
typedef int
    (*virDrvDomainInjectNMI)(virDomainPtr dom, unsigned int flags);

696 697 698 699
typedef int
    (*virDrvDomainSendKey)(virDomainPtr dom, unsigned int codeset,
                           unsigned int holdtime,
                           unsigned int *keycodes,
700
                           int nkeycodes,
701 702
                           unsigned int flags);

703 704 705
typedef char *
    (*virDrvDomainMigrateBegin3)
                    (virDomainPtr domain,
706
                     const char *xmlin,
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
                     char **cookieout,
                     int *cookieoutlen,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource);

typedef int
    (*virDrvDomainMigratePrepare3)
                    (virConnectPtr dconn,
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
                     const char *uri_in,
                     char **uri_out,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource,
                     const char *dom_xml);

typedef int
    (*virDrvDomainMigratePrepareTunnel3)
                    (virConnectPtr dconn,
                     virStreamPtr st,
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource,
                     const char *dom_xml);


typedef int
    (*virDrvDomainMigratePerform3)
                    (virDomainPtr dom,
744
                     const char *xmlin,
745 746 747 748
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
749
                     const char *dconnuri,
750 751 752 753 754
                     const char *uri,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource);

755
typedef virDomainPtr
756 757 758 759 760 761 762
    (*virDrvDomainMigrateFinish3)
                    (virConnectPtr dconn,
                     const char *dname,
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
763
                     const char *dconnuri,
764 765
                     const char *uri,
                     unsigned long flags,
766
                     int cancelled);
767 768 769 770 771 772 773 774

typedef int
    (*virDrvDomainMigrateConfirm3)
                    (virDomainPtr domain,
                     const char *cookiein,
                     int cookieinlen,
                     unsigned long flags,
                     int cancelled);
C
Chris Lalancette 已提交
775

776 777 778 779 780
typedef int
    (*virDrvNodeSuspendForDuration)(virConnectPtr conn, unsigned int target,
                                     unsigned long long duration,
                                     unsigned int flags);

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798

typedef int
    (*virDrvDomainBlockJobAbort)(virDomainPtr dom, const char *path,
                                 unsigned int flags);

typedef int
    (*virDrvDomainGetBlockJobInfo)(virDomainPtr dom, const char *path,
                                   virDomainBlockJobInfoPtr info,
                                   unsigned int flags);

typedef int
    (*virDrvDomainBlockJobSetSpeed)(virDomainPtr dom,
                                    const char *path, unsigned long bandwidth,
                                    unsigned int flags);

typedef int
    (*virDrvDomainBlockPull)(virDomainPtr dom, const char *path,
                             unsigned long bandwidth, unsigned int flags);
799 800 801 802
typedef int
    (*virDrvDomainBlockRebase)(virDomainPtr dom, const char *path,
                               const char *base, unsigned long bandwidth,
                               unsigned int flags);
803

J
Jiri Denemark 已提交
804 805 806 807
typedef int
    (*virDrvSetKeepAlive)(virConnectPtr conn,
                          int interval,
                          unsigned int count);
808

809 810 811 812 813 814 815 816 817 818 819 820
typedef int
    (*virDrvDomainSetBlockIoTune)(virDomainPtr dom,
                                  const char *disk,
                                  virTypedParameterPtr params,
                                  int nparams,
                                  unsigned int flags);
typedef int
    (*virDrvDomainGetBlockIoTune)(virDomainPtr dom,
                                  const char *disk,
                                  virTypedParameterPtr params,
                                  int *nparams,
                                  unsigned int flags);
821 822 823 824
typedef int
    (*virDrvDomainShutdownFlags)(virDomainPtr domain,
                                 unsigned int flags);

825 826 827 828 829 830 831
typedef int
    (*virDrvDomainGetCPUStats)(virDomainPtr domain,
                               virTypedParameterPtr params,
                               unsigned int nparams,
                               int start_cpu,
                               unsigned int ncpus,
                               unsigned int flags);
832

833 834 835 836 837 838
typedef int
    (*virDrvDomainGetDiskErrors)(virDomainPtr dom,
                                 virDomainDiskErrorPtr errors,
                                 unsigned int maxerrors,
                                 unsigned int flags);

839 840 841 842 843 844 845 846 847 848 849 850 851 852
typedef int
    (*virDrvDomainSetMetadata)(virDomainPtr dom,
                               int type,
                               const char *metadata,
                               const char *key,
                               const char *uri,
                               unsigned int flags);

typedef char *
    (*virDrvDomainGetMetadata)(virDomainPtr dom,
                               int type,
                               const char *uri,
                               unsigned int flags);

853 854 855 856 857
/**
 * _virDriver:
 *
 * Structure associated to a virtualization driver, defining the various
 * entry points for it.
858 859 860 861 862 863
 *
 * All drivers must support the following fields/methods:
 *  - no
 *  - name
 *  - open
 *  - close
864 865
 */
struct _virDriver {
866
    int        no;	/* the number virDrvNo */
867 868 869
    const char * name;	/* the name of the driver */
    virDrvOpen			open;
    virDrvClose			close;
D
Daniel P. Berrange 已提交
870
    virDrvDrvSupportsFeature   supports_feature;
871 872
    virDrvGetType			type;
    virDrvGetVersion		version;
873
    virDrvGetLibVersion		libvirtVersion;
874
    virDrvGetHostname       getHostname;
E
Eric Blake 已提交
875
    virDrvGetSysinfo            getSysinfo;
876 877 878 879 880
    virDrvGetMaxVcpus		getMaxVcpus;
    virDrvNodeGetInfo		nodeGetInfo;
    virDrvGetCapabilities		getCapabilities;
    virDrvListDomains		listDomains;
    virDrvNumOfDomains		numOfDomains;
881
    virDrvListAllDomains    listAllDomains;
882
    virDrvDomainCreateXML		domainCreateXML;
883 884 885 886 887
    virDrvDomainLookupByID		domainLookupByID;
    virDrvDomainLookupByUUID	domainLookupByUUID;
    virDrvDomainLookupByName	domainLookupByName;
    virDrvDomainSuspend		domainSuspend;
    virDrvDomainResume		domainResume;
888 889
    virDrvDomainPMSuspendForDuration domainPMSuspendForDuration;
    virDrvDomainPMWakeup    domainPMWakeup;
890
    virDrvDomainShutdown		domainShutdown;
891
    virDrvDomainShutdownFlags   domainShutdownFlags;
892
    virDrvDomainReboot		domainReboot;
X
Xu He Jie 已提交
893
    virDrvDomainReset       domainReset;
894
    virDrvDomainDestroy		domainDestroy;
895
    virDrvDomainDestroyFlags    domainDestroyFlags;
896 897 898 899
    virDrvDomainGetOSType		domainGetOSType;
    virDrvDomainGetMaxMemory	domainGetMaxMemory;
    virDrvDomainSetMaxMemory	domainSetMaxMemory;
    virDrvDomainSetMemory		domainSetMemory;
900
    virDrvDomainSetMemoryFlags  domainSetMemoryFlags;
901 902
    virDrvDomainSetMemoryParameters domainSetMemoryParameters;
    virDrvDomainGetMemoryParameters domainGetMemoryParameters;
903 904
    virDrvDomainSetNumaParameters domainSetNumaParameters;
    virDrvDomainGetNumaParameters domainGetNumaParameters;
905 906
    virDrvDomainSetBlkioParameters domainSetBlkioParameters;
    virDrvDomainGetBlkioParameters domainGetBlkioParameters;
907
    virDrvDomainGetInfo		domainGetInfo;
908
    virDrvDomainGetState	domainGetState;
909
    virDrvDomainGetControlInfo  domainGetControlInfo;
910
    virDrvDomainSave		domainSave;
911
    virDrvDomainSaveFlags	domainSaveFlags;
912
    virDrvDomainRestore		domainRestore;
913
    virDrvDomainRestoreFlags	domainRestoreFlags;
914 915
    virDrvDomainSaveImageGetXMLDesc domainSaveImageGetXMLDesc;
    virDrvDomainSaveImageDefineXML domainSaveImageDefineXML;
916 917
    virDrvDomainCoreDump        domainCoreDump;
    virDrvDomainScreenshot      domainScreenshot;
918
    virDrvDomainSetVcpus		domainSetVcpus;
E
Eric Blake 已提交
919 920
    virDrvDomainSetVcpusFlags		domainSetVcpusFlags;
    virDrvDomainGetVcpusFlags		domainGetVcpusFlags;
921
    virDrvDomainPinVcpu		domainPinVcpu;
922
    virDrvDomainPinVcpuFlags    domainPinVcpuFlags;
E
Eric Blake 已提交
923
    virDrvDomainGetVcpuPinInfo  domainGetVcpuPinInfo;
924 925
    virDrvDomainGetVcpus		domainGetVcpus;
    virDrvDomainGetMaxVcpus		domainGetMaxVcpus;
926 927
    virDrvDomainGetSecurityLabel     domainGetSecurityLabel;
    virDrvNodeGetSecurityModel  nodeGetSecurityModel;
928
    virDrvDomainGetXMLDesc		domainGetXMLDesc;
929 930
    virDrvConnectDomainXMLFromNative domainXMLFromNative;
    virDrvConnectDomainXMLToNative domainXMLToNative;
931 932 933
    virDrvListDefinedDomains	listDefinedDomains;
    virDrvNumOfDefinedDomains	numOfDefinedDomains;
    virDrvDomainCreate		domainCreate;
934
    virDrvDomainCreateWithFlags	domainCreateWithFlags;
935 936
    virDrvDomainDefineXML           domainDefineXML;
    virDrvDomainUndefine            domainUndefine;
O
Osier Yang 已提交
937
    virDrvDomainUndefineFlags       domainUndefineFlags;
938
    virDrvDomainAttachDevice	domainAttachDevice;
J
Jim Fehlig 已提交
939
    virDrvDomainAttachDeviceFlags	domainAttachDeviceFlags;
940
    virDrvDomainDetachDevice	domainDetachDevice;
J
Jim Fehlig 已提交
941
    virDrvDomainDetachDeviceFlags	domainDetachDeviceFlags;
942
    virDrvDomainUpdateDeviceFlags	domainUpdateDeviceFlags;
943 944 945 946
    virDrvDomainGetAutostart	domainGetAutostart;
    virDrvDomainSetAutostart	domainSetAutostart;
    virDrvDomainGetSchedulerType	domainGetSchedulerType;
    virDrvDomainGetSchedulerParameters domainGetSchedulerParameters;
947
    virDrvDomainGetSchedulerParametersFlags domainGetSchedulerParametersFlags;
948
    virDrvDomainSetSchedulerParameters domainSetSchedulerParameters;
949
    virDrvDomainSetSchedulerParametersFlags domainSetSchedulerParametersFlags;
950 951 952
    virDrvDomainMigratePrepare	domainMigratePrepare;
    virDrvDomainMigratePerform	domainMigratePerform;
    virDrvDomainMigrateFinish	domainMigrateFinish;
O
Osier Yang 已提交
953
    virDrvDomainBlockResize     domainBlockResize;
954
    virDrvDomainBlockStats      domainBlockStats;
955
    virDrvDomainBlockStatsFlags domainBlockStatsFlags;
956
    virDrvDomainInterfaceStats  domainInterfaceStats;
957 958
    virDrvDomainSetInterfaceParameters domainSetInterfaceParameters;
    virDrvDomainGetInterfaceParameters domainGetInterfaceParameters;
959
    virDrvDomainMemoryStats     domainMemoryStats;
R
Richard W.M. Jones 已提交
960
    virDrvDomainBlockPeek	domainBlockPeek;
R
Richard W.M. Jones 已提交
961
    virDrvDomainMemoryPeek      domainMemoryPeek;
962
    virDrvDomainGetBlockInfo    domainGetBlockInfo;
963
    virDrvNodeGetCPUStats       nodeGetCPUStats;
964
    virDrvNodeGetMemoryStats	nodeGetMemoryStats;
965
    virDrvNodeGetCellsFreeMemory	nodeGetCellsFreeMemory;
966
    virDrvNodeGetFreeMemory		nodeGetFreeMemory;
967 968
    virDrvDomainEventRegister         domainEventRegister;
    virDrvDomainEventDeregister       domainEventDeregister;
D
Daniel Veillard 已提交
969 970
    virDrvDomainMigratePrepare2	domainMigratePrepare2;
    virDrvDomainMigrateFinish2	domainMigrateFinish2;
971 972 973
    virDrvNodeDeviceDettach     nodeDeviceDettach;
    virDrvNodeDeviceReAttach    nodeDeviceReAttach;
    virDrvNodeDeviceReset       nodeDeviceReset;
C
Chris Lalancette 已提交
974
    virDrvDomainMigratePrepareTunnel domainMigratePrepareTunnel;
975 976 977 978
    virDrvConnectIsEncrypted   isEncrypted;
    virDrvConnectIsSecure      isSecure;
    virDrvDomainIsActive       domainIsActive;
    virDrvDomainIsPersistent   domainIsPersistent;
O
Osier Yang 已提交
979
    virDrvDomainIsUpdated      domainIsUpdated;
980 981
    virDrvCompareCPU            cpuCompare;
    virDrvBaselineCPU           cpuBaseline;
982
    virDrvDomainGetJobInfo     domainGetJobInfo;
983
    virDrvDomainAbortJob     domainAbortJob;
984
    virDrvDomainMigrateSetMaxDowntime  domainMigrateSetMaxDowntime;
985
    virDrvDomainMigrateGetMaxSpeed  domainMigrateGetMaxSpeed;
986
    virDrvDomainMigrateSetMaxSpeed  domainMigrateSetMaxSpeed;
987 988
    virDrvDomainEventRegisterAny domainEventRegisterAny;
    virDrvDomainEventDeregisterAny domainEventDeregisterAny;
989 990 991
    virDrvDomainManagedSave domainManagedSave;
    virDrvDomainHasManagedSaveImage domainHasManagedSaveImage;
    virDrvDomainManagedSaveRemove domainManagedSaveRemove;
C
Chris Lalancette 已提交
992
    virDrvDomainSnapshotCreateXML domainSnapshotCreateXML;
993
    virDrvDomainSnapshotGetXMLDesc domainSnapshotGetXMLDesc;
C
Chris Lalancette 已提交
994 995
    virDrvDomainSnapshotNum domainSnapshotNum;
    virDrvDomainSnapshotListNames domainSnapshotListNames;
996 997
    virDrvDomainSnapshotNumChildren domainSnapshotNumChildren;
    virDrvDomainSnapshotListChildrenNames domainSnapshotListChildrenNames;
C
Chris Lalancette 已提交
998 999
    virDrvDomainSnapshotLookupByName domainSnapshotLookupByName;
    virDrvDomainHasCurrentSnapshot domainHasCurrentSnapshot;
1000
    virDrvDomainSnapshotGetParent domainSnapshotGetParent;
C
Chris Lalancette 已提交
1001
    virDrvDomainSnapshotCurrent domainSnapshotCurrent;
E
Eric Blake 已提交
1002 1003
    virDrvDomainSnapshotIsCurrent domainSnapshotIsCurrent;
    virDrvDomainSnapshotHasMetadata domainSnapshotHasMetadata;
C
Chris Lalancette 已提交
1004 1005
    virDrvDomainRevertToSnapshot domainRevertToSnapshot;
    virDrvDomainSnapshotDelete domainSnapshotDelete;
1006
    virDrvDomainQemuMonitorCommand qemuDomainMonitorCommand;
1007
    virDrvDomainQemuAttach qemuDomainAttach;
1008
    virDrvDomainOpenConsole domainOpenConsole;
1009
    virDrvDomainOpenGraphics domainOpenGraphics;
1010
    virDrvDomainInjectNMI domainInjectNMI;
1011 1012 1013 1014 1015 1016
    virDrvDomainMigrateBegin3	domainMigrateBegin3;
    virDrvDomainMigratePrepare3	domainMigratePrepare3;
    virDrvDomainMigratePrepareTunnel3	domainMigratePrepareTunnel3;
    virDrvDomainMigratePerform3	domainMigratePerform3;
    virDrvDomainMigrateFinish3	domainMigrateFinish3;
    virDrvDomainMigrateConfirm3	domainMigrateConfirm3;
1017
    virDrvDomainSendKey domainSendKey;
1018 1019 1020 1021
    virDrvDomainBlockJobAbort domainBlockJobAbort;
    virDrvDomainGetBlockJobInfo domainGetBlockJobInfo;
    virDrvDomainBlockJobSetSpeed domainBlockJobSetSpeed;
    virDrvDomainBlockPull domainBlockPull;
1022
    virDrvDomainBlockRebase domainBlockRebase;
J
Jiri Denemark 已提交
1023
    virDrvSetKeepAlive setKeepAlive;
J
Jiri Denemark 已提交
1024
    virDrvConnectIsAlive isAlive;
1025
    virDrvNodeSuspendForDuration nodeSuspendForDuration;
1026 1027
    virDrvDomainSetBlockIoTune domainSetBlockIoTune;
    virDrvDomainGetBlockIoTune domainGetBlockIoTune;
1028
    virDrvDomainGetCPUStats domainGetCPUStats;
1029
    virDrvDomainGetDiskErrors domainGetDiskErrors;
1030 1031
    virDrvDomainSetMetadata domainSetMetadata;
    virDrvDomainGetMetadata domainGetMetadata;
1032 1033
};

1034
typedef int
1035
        (*virDrvNumOfNetworks)		(virConnectPtr conn);
1036
typedef int
1037 1038 1039
        (*virDrvListNetworks)		(virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
1040
typedef int
1041
        (*virDrvNumOfDefinedNetworks)	(virConnectPtr conn);
1042
typedef int
1043 1044 1045
        (*virDrvListDefinedNetworks)	(virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
1046
typedef virNetworkPtr
1047 1048
        (*virDrvNetworkLookupByUUID)	(virConnectPtr conn,
                                         const unsigned char *uuid);
1049
typedef virNetworkPtr
1050 1051
        (*virDrvNetworkLookupByName)	(virConnectPtr conn,
                                         const char *name);
1052
typedef virNetworkPtr
1053 1054
        (*virDrvNetworkCreateXML)	(virConnectPtr conn,
                                         const char *xmlDesc);
1055
typedef virNetworkPtr
1056 1057
        (*virDrvNetworkDefineXML)	(virConnectPtr conn,
                                         const char *xml);
1058
typedef int
1059
        (*virDrvNetworkUndefine)	(virNetworkPtr network);
1060
typedef int
1061
        (*virDrvNetworkCreate)		(virNetworkPtr network);
1062
typedef int
1063
        (*virDrvNetworkDestroy)		(virNetworkPtr network);
1064
typedef char *
1065
        (*virDrvNetworkGetXMLDesc)		(virNetworkPtr network,
1066
                                         unsigned int flags);
1067
typedef char *
1068
        (*virDrvNetworkGetBridgeName)	(virNetworkPtr network);
1069
typedef int
1070 1071
        (*virDrvNetworkGetAutostart)	(virNetworkPtr network,
                                         int *autostart);
1072
typedef int
1073 1074
        (*virDrvNetworkSetAutostart)	(virNetworkPtr network,
                                         int autostart);
1075

1076 1077 1078 1079 1080 1081
typedef int
        (*virDrvNetworkIsActive)(virNetworkPtr net);
typedef int
        (*virDrvNetworkIsPersistent)(virNetworkPtr net);


1082 1083 1084 1085 1086 1087 1088 1089 1090

typedef struct _virNetworkDriver virNetworkDriver;
typedef virNetworkDriver *virNetworkDriverPtr;

/**
 * _virNetworkDriver:
 *
 * Structure associated to a network virtualization driver, defining the various
 * entry points for it.
1091 1092 1093 1094
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
1095 1096
 */
struct _virNetworkDriver {
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
        const char * name;	/* the name of the driver */
        virDrvOpen			open;
        virDrvClose			close;
        virDrvNumOfNetworks		numOfNetworks;
        virDrvListNetworks		listNetworks;
        virDrvNumOfDefinedNetworks	numOfDefinedNetworks;
        virDrvListDefinedNetworks	listDefinedNetworks;
        virDrvNetworkLookupByUUID	networkLookupByUUID;
        virDrvNetworkLookupByName	networkLookupByName;
        virDrvNetworkCreateXML		networkCreateXML;
        virDrvNetworkDefineXML		networkDefineXML;
        virDrvNetworkUndefine		networkUndefine;
        virDrvNetworkCreate		networkCreate;
        virDrvNetworkDestroy		networkDestroy;
1111
        virDrvNetworkGetXMLDesc		networkGetXMLDesc;
1112 1113 1114
        virDrvNetworkGetBridgeName	networkGetBridgeName;
        virDrvNetworkGetAutostart	networkGetAutostart;
        virDrvNetworkSetAutostart	networkSetAutostart;
1115 1116
        virDrvNetworkIsActive           networkIsActive;
        virDrvNetworkIsPersistent       networkIsPersistent;
1117 1118
};

D
Daniel Veillard 已提交
1119 1120 1121 1122 1123 1124 1125
/*-------*/
typedef int
        (*virDrvNumOfInterfaces)        (virConnectPtr conn);
typedef int
        (*virDrvListInterfaces)         (virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
1126 1127 1128 1129 1130 1131
typedef int
        (*virDrvNumOfDefinedInterfaces) (virConnectPtr conn);
typedef int
        (*virDrvListDefinedInterfaces)  (virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
D
Daniel Veillard 已提交
1132 1133 1134 1135 1136 1137 1138 1139
typedef virInterfacePtr
        (*virDrvInterfaceLookupByName)  (virConnectPtr conn,
                                         const char *name);
typedef virInterfacePtr
        (*virDrvInterfaceLookupByMACString)   (virConnectPtr conn,
                                               const char *mac);

typedef char *
1140
        (*virDrvInterfaceGetXMLDesc)    (virInterfacePtr iface,
D
Daniel Veillard 已提交
1141 1142 1143 1144 1145 1146 1147
                                         unsigned int flags);

typedef virInterfacePtr
        (*virDrvInterfaceDefineXML)     (virConnectPtr conn,
                                         const char *xmlDesc,
                                         unsigned int flags);
typedef int
1148
        (*virDrvInterfaceUndefine)      (virInterfacePtr iface);
D
Daniel Veillard 已提交
1149
typedef int
1150
        (*virDrvInterfaceCreate)        (virInterfacePtr iface,
D
Daniel Veillard 已提交
1151 1152
                                         unsigned int flags);
typedef int
1153
        (*virDrvInterfaceDestroy)       (virInterfacePtr iface,
D
Daniel Veillard 已提交
1154 1155
                                         unsigned int flags);

1156 1157 1158
typedef int
        (*virDrvInterfaceIsActive)(virInterfacePtr iface);

1159 1160 1161 1162 1163 1164 1165 1166 1167
typedef int
        (*virDrvInterfaceChangeBegin)   (virConnectPtr conn,
                                         unsigned int flags);
typedef int
        (*virDrvInterfaceChangeCommit)  (virConnectPtr conn,
                                         unsigned int flags);
typedef int
        (*virDrvInterfaceChangeRollback)(virConnectPtr conn,
                                         unsigned int flags);
1168

D
Daniel Veillard 已提交
1169 1170 1171 1172 1173 1174
typedef struct _virInterfaceDriver virInterfaceDriver;
typedef virInterfaceDriver *virInterfaceDriverPtr;

/**
 * _virInterfaceDriver:
 *
1175
 * Structure associated to a network interface driver, defining the various
D
Daniel Veillard 已提交
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
 * entry points for it.
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
 */
struct _virInterfaceDriver {
    const char                      *name; /* the name of the driver */
    virDrvOpen                       open;
    virDrvClose                      close;
    virDrvNumOfInterfaces            numOfInterfaces;
    virDrvListInterfaces             listInterfaces;
1188 1189
    virDrvNumOfDefinedInterfaces     numOfDefinedInterfaces;
    virDrvListDefinedInterfaces      listDefinedInterfaces;
D
Daniel Veillard 已提交
1190 1191 1192 1193 1194 1195 1196
    virDrvInterfaceLookupByName      interfaceLookupByName;
    virDrvInterfaceLookupByMACString interfaceLookupByMACString;
    virDrvInterfaceGetXMLDesc        interfaceGetXMLDesc;
    virDrvInterfaceDefineXML         interfaceDefineXML;
    virDrvInterfaceUndefine          interfaceUndefine;
    virDrvInterfaceCreate            interfaceCreate;
    virDrvInterfaceDestroy           interfaceDestroy;
1197
    virDrvInterfaceIsActive          interfaceIsActive;
1198 1199 1200
    virDrvInterfaceChangeBegin       interfaceChangeBegin;
    virDrvInterfaceChangeCommit      interfaceChangeCommit;
    virDrvInterfaceChangeRollback    interfaceChangeRollback;
D
Daniel Veillard 已提交
1201 1202
};

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215

typedef int
    (*virDrvConnectNumOfStoragePools)        (virConnectPtr conn);
typedef int
    (*virDrvConnectListStoragePools)         (virConnectPtr conn,
                                              char **const names,
                                              int maxnames);
typedef int
    (*virDrvConnectNumOfDefinedStoragePools) (virConnectPtr conn);
typedef int
    (*virDrvConnectListDefinedStoragePools)  (virConnectPtr conn,
                                              char **const names,
                                              int maxnames);
1216 1217 1218 1219 1220
typedef char *
    (*virDrvConnectFindStoragePoolSources)   (virConnectPtr conn,
                                              const char *type,
                                              const char *srcSpec,
                                              unsigned int flags);
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
typedef virStoragePoolPtr
    (*virDrvStoragePoolLookupByName)         (virConnectPtr conn,
                                              const char *name);
typedef virStoragePoolPtr
    (*virDrvStoragePoolLookupByUUID)         (virConnectPtr conn,
                                              const unsigned char *uuid);
typedef virStoragePoolPtr
    (*virDrvStoragePoolLookupByVolume)       (virStorageVolPtr vol);
typedef virStoragePoolPtr
    (*virDrvStoragePoolCreateXML)            (virConnectPtr conn,
                                              const char *xmlDesc,
                                              unsigned int flags);
typedef virStoragePoolPtr
    (*virDrvStoragePoolDefineXML)            (virConnectPtr conn,
                                              const char *xmlDesc,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolUndefine)             (virStoragePoolPtr pool);
typedef int
    (*virDrvStoragePoolBuild)                (virStoragePoolPtr pool,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolCreate)               (virStoragePoolPtr pool,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolDestroy)              (virStoragePoolPtr pool);
typedef int
    (*virDrvStoragePoolDelete)               (virStoragePoolPtr pool,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolRefresh)              (virStoragePoolPtr pool,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolGetInfo)              (virStoragePoolPtr vol,
                                              virStoragePoolInfoPtr info);
typedef char *
    (*virDrvStoragePoolGetXMLDesc)           (virStoragePoolPtr pool,
                                              unsigned int flags);
typedef int
    (*virDrvStoragePoolGetAutostart)         (virStoragePoolPtr pool,
                                              int *autostart);
typedef int
    (*virDrvStoragePoolSetAutostart)         (virStoragePoolPtr pool,
                                              int autostart);
typedef int
    (*virDrvStoragePoolNumOfVolumes)         (virStoragePoolPtr pool);
typedef int
    (*virDrvStoragePoolListVolumes)          (virStoragePoolPtr pool,
                                              char **const names,
                                              int maxnames);


typedef virStorageVolPtr
    (*virDrvStorageVolLookupByName)          (virStoragePoolPtr pool,
                                              const char *name);
typedef virStorageVolPtr
    (*virDrvStorageVolLookupByKey)           (virConnectPtr pool,
                                              const char *key);
typedef virStorageVolPtr
    (*virDrvStorageVolLookupByPath)          (virConnectPtr pool,
                                              const char *path);


typedef virStorageVolPtr
    (*virDrvStorageVolCreateXML)             (virStoragePoolPtr pool,
                                              const char *xmldesc,
                                              unsigned int flags);
typedef int
    (*virDrvStorageVolDelete)               (virStorageVolPtr vol,
                                             unsigned int flags);

1292 1293 1294
typedef int
    (*virDrvStorageVolWipe)                  (virStorageVolPtr vol,
                                              unsigned int flags);
1295 1296 1297 1298
typedef int
    (*virDrvStorageVolWipePattern)           (virStorageVolPtr vol,
                                              unsigned int algorithm,
                                              unsigned int flags);
1299

1300 1301 1302 1303 1304 1305 1306 1307 1308
typedef int
    (*virDrvStorageVolGetInfo)               (virStorageVolPtr vol,
                                              virStorageVolInfoPtr info);
typedef char *
    (*virDrvStorageVolGetXMLDesc)            (virStorageVolPtr pool,
                                              unsigned int flags);
typedef char *
    (*virDrvStorageVolGetPath)               (virStorageVolPtr vol);

1309 1310 1311 1312 1313
typedef virStorageVolPtr
    (*virDrvStorageVolCreateXMLFrom)         (virStoragePoolPtr pool,
                                              const char *xmldesc,
                                              virStorageVolPtr clone,
                                              unsigned int flags);
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
typedef int
    (*virDrvStorageVolDownload) (virStorageVolPtr vol,
                                 virStreamPtr stream,
                                 unsigned long long offset,
                                 unsigned long long length,
                                 unsigned int flags);
typedef int
    (*virDrvStorageVolUpload) (virStorageVolPtr vol,
                               virStreamPtr stream,
                               unsigned long long offset,
                               unsigned long long length,
                               unsigned int flags);
1326 1327
typedef int
        (*virDrvStorageVolResize) (virStorageVolPtr vol,
E
Eric Blake 已提交
1328
                                   unsigned long long capacity,
1329
                                   unsigned int flags);
1330

1331 1332 1333 1334 1335 1336
typedef int
        (*virDrvStoragePoolIsActive)(virStoragePoolPtr pool);
typedef int
        (*virDrvStoragePoolIsPersistent)(virStoragePoolPtr pool);


1337 1338 1339 1340 1341 1342 1343

typedef struct _virStorageDriver virStorageDriver;
typedef virStorageDriver *virStorageDriverPtr;

/**
 * _virStorageDriver:
 *
1344
 * Structure associated to a storage driver, defining the various
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
 * entry points for it.
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
 */
struct _virStorageDriver {
    const char * name;    /* the name of the driver */
    virDrvOpen            open;
    virDrvClose           close;

    virDrvConnectNumOfStoragePools numOfPools;
    virDrvConnectListStoragePools listPools;
    virDrvConnectNumOfDefinedStoragePools numOfDefinedPools;
    virDrvConnectListDefinedStoragePools listDefinedPools;
1360
    virDrvConnectFindStoragePoolSources findPoolSources;
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    virDrvStoragePoolLookupByName poolLookupByName;
    virDrvStoragePoolLookupByUUID poolLookupByUUID;
    virDrvStoragePoolLookupByVolume poolLookupByVolume;
    virDrvStoragePoolCreateXML poolCreateXML;
    virDrvStoragePoolDefineXML poolDefineXML;
    virDrvStoragePoolBuild poolBuild;
    virDrvStoragePoolUndefine poolUndefine;
    virDrvStoragePoolCreate poolCreate;
    virDrvStoragePoolDestroy poolDestroy;
    virDrvStoragePoolDelete poolDelete;
    virDrvStoragePoolRefresh poolRefresh;
    virDrvStoragePoolGetInfo poolGetInfo;
    virDrvStoragePoolGetXMLDesc poolGetXMLDesc;
    virDrvStoragePoolGetAutostart poolGetAutostart;
    virDrvStoragePoolSetAutostart poolSetAutostart;
    virDrvStoragePoolNumOfVolumes poolNumOfVolumes;
    virDrvStoragePoolListVolumes poolListVolumes;

    virDrvStorageVolLookupByName volLookupByName;
    virDrvStorageVolLookupByKey volLookupByKey;
    virDrvStorageVolLookupByPath volLookupByPath;
    virDrvStorageVolCreateXML volCreateXML;
1383
    virDrvStorageVolCreateXMLFrom volCreateXMLFrom;
1384 1385
    virDrvStorageVolDownload volDownload;
    virDrvStorageVolUpload volUpload;
1386
    virDrvStorageVolDelete volDelete;
1387
    virDrvStorageVolWipe volWipe;
1388
    virDrvStorageVolWipePattern volWipePattern;
1389 1390 1391
    virDrvStorageVolGetInfo volGetInfo;
    virDrvStorageVolGetXMLDesc volGetXMLDesc;
    virDrvStorageVolGetPath volGetPath;
1392
    virDrvStorageVolResize volResize;
1393 1394
    virDrvStoragePoolIsActive   poolIsActive;
    virDrvStoragePoolIsPersistent   poolIsPersistent;
1395 1396
};

1397
# ifdef WITH_LIBVIRTD
1398
typedef int (*virDrvStateInitialize) (int privileged);
1399 1400 1401 1402 1403 1404 1405 1406
typedef int (*virDrvStateCleanup) (void);
typedef int (*virDrvStateReload) (void);
typedef int (*virDrvStateActive) (void);

typedef struct _virStateDriver virStateDriver;
typedef virStateDriver *virStateDriverPtr;

struct _virStateDriver {
1407
    const char *name;
1408 1409 1410 1411 1412
    virDrvStateInitialize  initialize;
    virDrvStateCleanup     cleanup;
    virDrvStateReload      reload;
    virDrvStateActive      active;
};
1413
# endif
1414

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431

typedef struct _virDeviceMonitor virDeviceMonitor;
typedef virDeviceMonitor *virDeviceMonitorPtr;

typedef int (*virDevMonNumOfDevices)(virConnectPtr conn,
                                     const char *cap,
                                     unsigned int flags);

typedef int (*virDevMonListDevices)(virConnectPtr conn,
                                    const char *cap,
                                    char **const names,
                                    int maxnames,
                                    unsigned int flags);

typedef virNodeDevicePtr (*virDevMonDeviceLookupByName)(virConnectPtr conn,
                                                        const char *name);

1432 1433
typedef char * (*virDevMonDeviceGetXMLDesc)(virNodeDevicePtr dev,
                                            unsigned int flags);
1434 1435 1436 1437 1438 1439 1440 1441 1442

typedef char * (*virDevMonDeviceGetParent)(virNodeDevicePtr dev);

typedef int (*virDevMonDeviceNumOfCaps)(virNodeDevicePtr dev);

typedef int (*virDevMonDeviceListCaps)(virNodeDevicePtr dev,
                                       char **const names,
                                       int maxnames);

1443 1444 1445 1446 1447
typedef virNodeDevicePtr (*virDrvNodeDeviceCreateXML)(virConnectPtr conn,
                                                      const char *xmlDesc,
                                                      unsigned int flags);
typedef int (*virDrvNodeDeviceDestroy)(virNodeDevicePtr dev);

1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
/**
 * _virDeviceMonitor:
 *
 * Structure associated with monitoring the devices
 * on a virtualized node.
 *
 */
struct _virDeviceMonitor {
    const char * name;    /* the name of the driver */
    virDrvOpen open;
    virDrvClose close;
    virDevMonNumOfDevices numOfDevices;
    virDevMonListDevices listDevices;
    virDevMonDeviceLookupByName deviceLookupByName;
1462
    virDevMonDeviceGetXMLDesc deviceGetXMLDesc;
1463 1464 1465
    virDevMonDeviceGetParent deviceGetParent;
    virDevMonDeviceNumOfCaps deviceNumOfCaps;
    virDevMonDeviceListCaps deviceListCaps;
1466 1467
    virDrvNodeDeviceCreateXML deviceCreateXML;
    virDrvNodeDeviceDestroy deviceDestroy;
1468 1469
};

1470 1471
enum {
    /* This getValue call is inside libvirt, override the "private" flag.
E
Eric Blake 已提交
1472
       This flag cannot be set by outside callers. */
1473
    VIR_SECRET_GET_VALUE_INTERNAL_CALL = 1 << 0,
1474 1475
};

1476
typedef virSecretPtr
1477 1478
    (*virDrvSecretLookupByUUID)        (virConnectPtr conn,
                                        const unsigned char *uuid);
1479 1480 1481 1482
typedef virSecretPtr
    (*virDrvSecretLookupByUsage)       (virConnectPtr conn,
                                        int usageType,
                                        const char *usageID);
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
typedef virSecretPtr
    (*virDrvSecretDefineXML)                 (virConnectPtr conn,
                                              const char *xml,
                                              unsigned int flags);
typedef char *
    (*virDrvSecretGetXMLDesc)                (virSecretPtr secret,
                                              unsigned int flags);
typedef int
    (*virDrvSecretSetValue)                  (virSecretPtr secret,
                                              const unsigned char *value,
                                              size_t value_size,
                                              unsigned int flags);
typedef unsigned char *
    (*virDrvSecretGetValue)                  (virSecretPtr secret,
                                              size_t *value_size,
1498 1499
                                              unsigned int flags,
                                              unsigned int internalFlags);
1500 1501 1502
typedef int
    (*virDrvSecretUndefine)                  (virSecretPtr secret);
typedef int
1503
    (*virDrvNumOfSecrets)              (virConnectPtr conn);
1504
typedef int
1505
    (*virDrvListSecrets)               (virConnectPtr conn,
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
                                              char **uuids,
                                              int maxuuids);

typedef struct _virSecretDriver virSecretDriver;
typedef virSecretDriver *virSecretDriverPtr;

/**
 * _virSecretDriver:
 *
 * Structure associated to a driver for storing secrets, defining the various
 * entry points for it.
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
 */
struct _virSecretDriver {
    const char *name;
    virDrvOpen open;
    virDrvClose close;

1527 1528
    virDrvNumOfSecrets numOfSecrets;
    virDrvListSecrets listSecrets;
1529
    virDrvSecretLookupByUUID lookupByUUID;
1530
    virDrvSecretLookupByUsage lookupByUsage;
1531 1532 1533 1534 1535 1536 1537
    virDrvSecretDefineXML defineXML;
    virDrvSecretGetXMLDesc getXMLDesc;
    virDrvSecretSetValue setValue;
    virDrvSecretGetValue getValue;
    virDrvSecretUndefine undefine;
};

1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572

typedef struct _virStreamDriver virStreamDriver;
typedef virStreamDriver *virStreamDriverPtr;

typedef int (*virDrvStreamSend)(virStreamPtr st,
                                const char *data,
                                size_t nbytes);
typedef int (*virDrvStreamRecv)(virStreamPtr st,
                                char *data,
                                size_t nbytes);

typedef int (*virDrvStreamEventAddCallback)(virStreamPtr stream,
                                            int events,
                                            virStreamEventCallback cb,
                                            void *opaque,
                                            virFreeCallback ff);

typedef int (*virDrvStreamEventUpdateCallback)(virStreamPtr stream,
                                               int events);
typedef int (*virDrvStreamEventRemoveCallback)(virStreamPtr stream);
typedef int (*virDrvStreamFinish)(virStreamPtr st);
typedef int (*virDrvStreamAbort)(virStreamPtr st);


struct _virStreamDriver {
    virDrvStreamSend streamSend;
    virDrvStreamRecv streamRecv;
    virDrvStreamEventAddCallback streamAddCallback;
    virDrvStreamEventUpdateCallback streamUpdateCallback;
    virDrvStreamEventRemoveCallback streamRemoveCallback;
    virDrvStreamFinish streamFinish;
    virDrvStreamAbort streamAbort;
};


S
Stefan Berger 已提交
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
typedef int
    (*virDrvConnectNumOfNWFilters)        (virConnectPtr conn);
typedef int
    (*virDrvConnectListNWFilters)         (virConnectPtr conn,
                                           char **const names,
                                           int maxnames);
typedef virNWFilterPtr
    (*virDrvNWFilterLookupByName)             (virConnectPtr conn,
                                               const char *name);
typedef virNWFilterPtr
    (*virDrvNWFilterLookupByUUID)             (virConnectPtr conn,
                                               const unsigned char *uuid);
typedef virNWFilterPtr
    (*virDrvNWFilterDefineXML)                (virConnectPtr conn,
E
Eric Blake 已提交
1587
                                               const char *xmlDesc);
S
Stefan Berger 已提交
1588
typedef int
1589
    (*virDrvNWFilterUndefine)                 (virNWFilterPtr nwfilter);
S
Stefan Berger 已提交
1590 1591

typedef char *
1592
    (*virDrvNWFilterGetXMLDesc)              (virNWFilterPtr nwfilter,
1593
                                              unsigned int flags);
S
Stefan Berger 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623


typedef struct _virNWFilterDriver virNWFilterDriver;
typedef virNWFilterDriver *virNWFilterDriverPtr;

/**
 * _virNWFilterDriver:
 *
 * Structure associated to a network filter driver, defining the various
 * entry points for it.
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
 */
struct _virNWFilterDriver {
    const char * name;    /* the name of the driver */
    virDrvOpen            open;
    virDrvClose           close;

    virDrvConnectNumOfNWFilters numOfNWFilters;
    virDrvConnectListNWFilters listNWFilters;
    virDrvNWFilterLookupByName nwfilterLookupByName;
    virDrvNWFilterLookupByUUID nwfilterLookupByUUID;
    virDrvNWFilterDefineXML defineXML;
    virDrvNWFilterUndefine undefine;
    virDrvNWFilterGetXMLDesc getXMLDesc;
};


1624 1625 1626 1627 1628 1629
/*
 * Registration
 * TODO: also need ways to (des)activate a given driver
 *       lookup based on the URI given in a virConnectOpen(ReadOnly)
 */
int virRegisterDriver(virDriverPtr);
1630
int virRegisterNetworkDriver(virNetworkDriverPtr);
D
Daniel Veillard 已提交
1631
int virRegisterInterfaceDriver(virInterfaceDriverPtr);
1632
int virRegisterStorageDriver(virStorageDriverPtr);
1633
int virRegisterDeviceMonitor(virDeviceMonitorPtr);
1634
int virRegisterSecretDriver(virSecretDriverPtr);
S
Stefan Berger 已提交
1635
int virRegisterNWFilterDriver(virNWFilterDriverPtr);
1636
# ifdef WITH_LIBVIRTD
1637
int virRegisterStateDriver(virStateDriverPtr);
1638
# endif
1639
void virDriverModuleInitialize(const char *defmoddir);
1640
void *virDriverLoadModule(const char *name);
1641 1642

#endif /* __VIR_DRIVER_H__ */