driver.h 55.0 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 <libxml/uri.h>
12

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


35 36 37 38 39 40 41 42 43 44 45 46 47 48
/* 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 已提交
49

50
/* Internal feature-detection macro.  Don't call drv->supports_feature
51 52
 * directly if you don't have to, because it may be NULL, use this macro
 * instead.
53
 *
54 55 56
 * 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.
57 58
 *
 * Returns:
59
 *   != 0  Feature is supported.
60 61
 *   0     Feature is not supported.
 */
62 63 64
# define VIR_DRV_SUPPORTS_FEATURE(drv,conn,feature)                         \
    ((drv)->supports_feature ?                                              \
        (drv)->supports_feature((conn), (feature)) > 0 : 0)
65

66
typedef virDrvOpenStatus
67
        (*virDrvOpen)			(virConnectPtr conn,
68
                             virConnectAuthPtr auth,
69
                             unsigned int flags);
70
typedef int
71
        (*virDrvClose)			(virConnectPtr conn);
72
typedef int
D
Daniel P. Berrange 已提交
73
    (*virDrvDrvSupportsFeature) (virConnectPtr conn, int feature);
74
typedef const char *
75
        (*virDrvGetType)		(virConnectPtr conn);
76
typedef int
77 78
        (*virDrvGetVersion)		(virConnectPtr conn,
                                         unsigned long *hvVer);
79 80 81
typedef int
        (*virDrvGetLibVersion)      (virConnectPtr conn,
                                     unsigned long *libVer);
82 83 84 85
typedef char *
    (*virDrvGetHostname)    (virConnectPtr conn);
typedef char *
    (*virDrvGetURI)         (virConnectPtr conn);
E
Eric Blake 已提交
86 87 88
typedef char *
    (*virDrvGetSysinfo)     (virConnectPtr conn,
                             unsigned int flags);
89
typedef int
90 91
        (*virDrvGetMaxVcpus)		(virConnectPtr conn,
                                         const char *type);
92
typedef int
93 94
        (*virDrvNodeGetInfo)		(virConnectPtr conn,
                                         virNodeInfoPtr info);
95
typedef char *
96
        (*virDrvGetCapabilities) (virConnectPtr conn);
97
typedef int
98 99 100
        (*virDrvListDomains)		(virConnectPtr conn,
                                         int *ids,
                                         int maxids);
101
typedef int
102
        (*virDrvNumOfDomains)		(virConnectPtr conn);
103
typedef virDomainPtr
104
        (*virDrvDomainCreateXML)	(virConnectPtr conn,
105 106
                                         const char *xmlDesc,
                                         unsigned int flags);
107
typedef virDomainPtr
108 109
        (*virDrvDomainLookupByID)	(virConnectPtr conn,
                                         int id);
110
typedef virDomainPtr
111 112
        (*virDrvDomainLookupByUUID)	(virConnectPtr conn,
                                         const unsigned char *uuid);
113
typedef virDomainPtr
114 115
        (*virDrvDomainLookupByName)	(virConnectPtr conn,
                                         const char *name);
116
typedef int
117
        (*virDrvDomainSuspend)		(virDomainPtr domain);
118
typedef int
119
        (*virDrvDomainResume)		(virDomainPtr domain);
120
typedef int
121
        (*virDrvDomainShutdown)		(virDomainPtr domain);
122
typedef int
123 124
        (*virDrvDomainReboot)		(virDomainPtr domain,
                                         unsigned int flags);
125
typedef int
126
        (*virDrvDomainDestroy)		(virDomainPtr domain);
127 128 129
typedef int
        (*virDrvDomainDestroyFlags) (virDomainPtr domain,
                                         unsigned int flags);
130
typedef char *
131
        (*virDrvDomainGetOSType)	(virDomainPtr domain);
132
typedef unsigned long
133
        (*virDrvDomainGetMaxMemory)	(virDomainPtr domain);
134
typedef int
135 136
        (*virDrvDomainSetMaxMemory)	(virDomainPtr domain,
                                         unsigned long memory);
137
typedef int
138 139
        (*virDrvDomainSetMemory)	(virDomainPtr domain,
                                         unsigned long memory);
140 141 142 143
typedef int
        (*virDrvDomainSetMemoryFlags)	(virDomainPtr domain,
                                         unsigned long memory,
                                         unsigned int flags);
144 145 146
typedef int
        (*virDrvDomainSetMemoryParameters)
                                        (virDomainPtr domain,
147
                                         virTypedParameterPtr params,
148 149 150 151 152
                                         int nparams,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetMemoryParameters)
                                        (virDomainPtr domain,
153
                                         virTypedParameterPtr params,
154 155
                                         int *nparams,
                                         unsigned int flags);
156 157 158
typedef int
        (*virDrvDomainSetBlkioParameters)
                                        (virDomainPtr domain,
159
                                         virTypedParameterPtr params,
160 161 162 163 164
                                         int nparams,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetBlkioParameters)
                                        (virDomainPtr domain,
165
                                         virTypedParameterPtr params,
166 167
                                         int *nparams,
                                         unsigned int flags);
168
typedef int
169 170
        (*virDrvDomainGetInfo)		(virDomainPtr domain,
                                         virDomainInfoPtr info);
171 172 173 174 175
typedef int
        (*virDrvDomainGetState)         (virDomainPtr domain,
                                         int *state,
                                         int *reason,
                                         unsigned int flags);
176 177 178 179
typedef int
        (*virDrvDomainGetControlInfo)   (virDomainPtr domain,
                                         virDomainControlInfoPtr info,
                                         unsigned int flags);
180
typedef int
181 182
        (*virDrvDomainSave)		(virDomainPtr domain,
                                         const char *to);
183 184 185 186 187
typedef int
        (*virDrvDomainSaveFlags)	(virDomainPtr domain,
                                         const char *to,
                                         const char *dxml,
                                         unsigned int flags);
188
typedef int
189 190
        (*virDrvDomainRestore)		(virConnectPtr conn,
                                         const char *from);
191 192 193 194 195
typedef int
        (*virDrvDomainRestoreFlags)	(virConnectPtr conn,
                                         const char *from,
                                         const char *dxml,
                                         unsigned int flags);
196 197 198 199 200 201 202 203 204
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 已提交
205
typedef int
206 207
        (*virDrvDomainCoreDump)		(virDomainPtr domain,
                                         const char *to,
208
                                         unsigned int flags);
209 210 211 212 213
typedef char *
        (*virDrvDomainScreenshot)   (virDomainPtr domain,
                                         virStreamPtr stream,
                                         unsigned int screen,
                                         unsigned int flags);
214
typedef char *
215
        (*virDrvDomainGetXMLDesc)		(virDomainPtr dom,
216
                                                 unsigned int flags);
217 218 219 220 221 222 223 224 225 226
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);
227
typedef int
228 229 230
        (*virDrvListDefinedDomains)	(virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
231
typedef int
232
        (*virDrvNumOfDefinedDomains)	(virConnectPtr conn);
233
typedef int
234
        (*virDrvDomainCreate)		(virDomainPtr dom);
235 236 237
typedef int
        (*virDrvDomainCreateWithFlags)	(virDomainPtr dom,
                                         unsigned int flags);
238
typedef virDomainPtr
239 240
        (*virDrvDomainDefineXML)	(virConnectPtr conn,
                                         const char *xml);
241
typedef int
242
        (*virDrvDomainUndefine)		(virDomainPtr dom);
O
Osier Yang 已提交
243 244 245
typedef int
        (*virDrvDomainUndefineFlags)	(virDomainPtr dom,
                                         unsigned int flags);
246
typedef int
247 248
        (*virDrvDomainSetVcpus)		(virDomainPtr domain,
                                         unsigned int nvcpus);
E
Eric Blake 已提交
249 250 251 252 253 254 255
typedef int
        (*virDrvDomainSetVcpusFlags)	(virDomainPtr domain,
                                         unsigned int nvcpus,
                                         unsigned int flags);
typedef int
        (*virDrvDomainGetVcpusFlags)	(virDomainPtr domain,
                                         unsigned int flags);
256
typedef int
257 258 259 260
        (*virDrvDomainPinVcpu)		(virDomainPtr domain,
                                         unsigned int vcpu,
                                         unsigned char *cpumap,
                                         int maplen);
261 262 263 264 265 266
typedef int
        (*virDrvDomainPinVcpuFlags)     (virDomainPtr domain,
                                         unsigned int vcpu,
                                         unsigned char *cpumap,
                                         int maplen,
                                         unsigned int flags);
267
typedef int
E
Eric Blake 已提交
268
        (*virDrvDomainGetVcpuPinInfo)   (virDomainPtr domain,
269 270 271 272 273
                                         int ncpumaps,
                                         unsigned char *cpumaps,
                                         int maplen,
                                         unsigned int flags);

274
typedef int
275 276 277 278 279
        (*virDrvDomainGetVcpus)		(virDomainPtr domain,
                                         virVcpuInfoPtr info,
                                         int maxinfo,
                                         unsigned char *cpumaps,
                                         int maplen);
280
typedef int
281
        (*virDrvDomainGetMaxVcpus)	(virDomainPtr domain);
282 283 284 285 286 287 288

typedef int
        (*virDrvDomainGetSecurityLabel)	(virDomainPtr domain,
                                         virSecurityLabelPtr seclabel);
typedef int
        (*virDrvNodeGetSecurityModel)	(virConnectPtr conn,
                                         virSecurityModelPtr secmodel);
289
typedef int
290 291
        (*virDrvDomainAttachDevice)	(virDomainPtr domain,
                                         const char *xml);
J
Jim Fehlig 已提交
292 293 294 295
typedef int
        (*virDrvDomainAttachDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
296
typedef int
297 298
        (*virDrvDomainDetachDevice)	(virDomainPtr domain,
                                         const char *xml);
J
Jim Fehlig 已提交
299 300 301 302
typedef int
        (*virDrvDomainDetachDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
303 304 305 306
typedef int
        (*virDrvDomainUpdateDeviceFlags) (virDomainPtr domain,
                                          const char *xml,
                                          unsigned int flags);
307
typedef int
308 309
        (*virDrvDomainGetAutostart)	(virDomainPtr domain,
                                         int *autostart);
310
typedef int
311 312
        (*virDrvDomainSetAutostart)	(virDomainPtr domain,
                                         int autostart);
313

314
typedef char *
315 316
        (*virDrvDomainGetSchedulerType)	(virDomainPtr domain,
                                         int *nparams);
317

318
typedef int
319 320
        (*virDrvDomainGetSchedulerParameters)
                                        (virDomainPtr domain,
321
                                         virTypedParameterPtr params,
322
                                         int *nparams);
323

324 325 326 327 328 329 330
typedef int
        (*virDrvDomainGetSchedulerParametersFlags)
                                        (virDomainPtr domain,
                                         virTypedParameterPtr params,
                                         int *nparams,
                                         unsigned int flags);

331
typedef int
332 333
        (*virDrvDomainSetSchedulerParameters)
                                        (virDomainPtr domain,
334
                                         virTypedParameterPtr params,
335
                                         int nparams);
336

337 338 339
typedef int
        (*virDrvDomainSetSchedulerParametersFlags)
                                        (virDomainPtr domain,
340
                                         virTypedParameterPtr params,
341 342 343
                                         int nparams,
                                         unsigned int flags);

344 345 346 347 348 349 350 351 352 353 354
typedef int
    (*virDrvDomainBlockStats)
                    (virDomainPtr domain,
                     const char *path,
                     struct _virDomainBlockStats *stats);
typedef int
    (*virDrvDomainInterfaceStats)
                    (virDomainPtr domain,
                     const char *path,
                     struct _virDomainInterfaceStats *stats);

355 356 357 358
typedef int
    (*virDrvDomainMemoryStats)
                    (virDomainPtr domain,
                     struct _virDomainMemoryStat *stats,
359 360
                     unsigned int nr_stats,
                     unsigned int flags);
361

R
Richard W.M. Jones 已提交
362 363 364 365 366
typedef int
    (*virDrvDomainBlockPeek)
                    (virDomainPtr domain,
                     const char *path,
                     unsigned long long offset, size_t size,
367 368
                     void *buffer,
                     unsigned int flags);
R
Richard W.M. Jones 已提交
369

R
Richard W.M. Jones 已提交
370 371 372 373 374 375
typedef int
    (*virDrvDomainMemoryPeek)
                    (virDomainPtr domain,
                     unsigned long long start, size_t size,
                     void *buffer,
                     unsigned int flags);
376 377 378 379 380 381
typedef int
    (*virDrvDomainGetBlockInfo)
                    (virDomainPtr domain,
                     const char *path,
                     virDomainBlockInfoPtr info,
                     unsigned int flags);
R
Richard W.M. Jones 已提交
382

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
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);

413 414 415
typedef struct _virDriver virDriver;
typedef virDriver *virDriverPtr;

416 417 418 419
typedef int
    (*virDrvNodeGetCPUStats)
                    (virConnectPtr conn,
                     int cpuNum,
420
                     virNodeCPUStatsPtr params,
421 422 423
                     int *nparams,
                     unsigned int flags);

424 425 426 427
typedef int
    (*virDrvNodeGetMemoryStats)
                    (virConnectPtr conn,
                     int cellNum,
428
                     virNodeMemoryStatsPtr params,
429 430 431
                     int *nparams,
                     unsigned int flags);

432 433 434 435 436 437 438
typedef int
    (*virDrvNodeGetCellsFreeMemory)
                    (virConnectPtr conn,
                     unsigned long long *freeMems,
                     int startCell,
                     int maxCells);

439 440
typedef unsigned long long
    (*virDrvNodeGetFreeMemory)
441
                    (virConnectPtr conn);
442

443 444 445
typedef int
    (*virDrvDomainEventRegister)
                    (virConnectPtr conn,
446
                     virConnectDomainEventCallback cb,
447 448
                     void *opaque,
                     virFreeCallback freecb);
449 450 451 452

typedef int
    (*virDrvDomainEventDeregister)
                    (virConnectPtr conn,
453
                     virConnectDomainEventCallback cb);
454

D
Daniel Veillard 已提交
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
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);

477 478 479 480 481 482 483 484 485 486
typedef int
    (*virDrvNodeDeviceDettach)
                    (virNodeDevicePtr dev);
typedef int
    (*virDrvNodeDeviceReAttach)
                    (virNodeDevicePtr dev);
typedef int
    (*virDrvNodeDeviceReset)
                    (virNodeDevicePtr dev);

C
Chris Lalancette 已提交
487 488
typedef int
    (*virDrvDomainMigratePrepareTunnel)
489
                    (virConnectPtr dconn,
C
Chris Lalancette 已提交
490 491 492 493 494 495
                     virStreamPtr st,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource,
                     const char *dom_xml);

496 497 498 499 500 501 502 503
typedef int
    (*virDrvConnectIsEncrypted)(virConnectPtr conn);
typedef int
    (*virDrvConnectIsSecure)(virConnectPtr conn);
typedef int
    (*virDrvDomainIsActive)(virDomainPtr dom);
typedef int
    (*virDrvDomainIsPersistent)(virDomainPtr dom);
O
Osier Yang 已提交
504 505
typedef int
    (*virDrvDomainIsUpdated)(virDomainPtr dom);
506

J
Jiri Denemark 已提交
507
typedef int
508
    (*virDrvCompareCPU)(virConnectPtr conn,
J
Jiri Denemark 已提交
509 510
                        const char *cpu,
                        unsigned int flags);
511
typedef char *
512
    (*virDrvBaselineCPU)(virConnectPtr conn,
513 514 515
                         const char **xmlCPUs,
                         unsigned int ncpus,
                         unsigned int flags);
J
Jiri Denemark 已提交
516

517 518 519 520
typedef int
    (*virDrvDomainGetJobInfo)(virDomainPtr domain,
                              virDomainJobInfoPtr info);

521 522 523
typedef int
    (*virDrvDomainAbortJob)(virDomainPtr domain);

524 525 526 527
typedef int
    (*virDrvDomainMigrateSetMaxDowntime)(virDomainPtr domain,
                                         unsigned long long downtime,
                                         unsigned int flags);
528 529 530 531
typedef int
    (*virDrvDomainMigrateSetMaxSpeed)(virDomainPtr domain,
                                      unsigned long bandwidth,
                                      unsigned int flags);
532

533 534 535 536 537 538 539 540 541 542 543 544
typedef int
    (*virDrvDomainEventRegisterAny)(virConnectPtr conn,
                                    virDomainPtr dom,
                                    int eventID,
                                    virConnectDomainEventGenericCallback cb,
                                    void *opaque,
                                    virFreeCallback freecb);

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

545 546 547 548 549 550 551 552 553
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 已提交
554 555 556 557 558 559
typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotCreateXML)(virDomainPtr domain,
                                     const char *xmlDesc,
                                     unsigned int flags);

typedef char *
560 561
    (*virDrvDomainSnapshotGetXMLDesc)(virDomainSnapshotPtr snapshot,
                                      unsigned int flags);
C
Chris Lalancette 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

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

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

typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotLookupByName)(virDomainPtr domain,
                                        const char *name,
                                        unsigned int flags);

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

typedef virDomainSnapshotPtr
    (*virDrvDomainSnapshotCurrent)(virDomainPtr domain,
                                   unsigned int flags);

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

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

C
Chris Lalancette 已提交
591
typedef int
592
    (*virDrvDomainQemuMonitorCommand)(virDomainPtr domain, const char *cmd,
C
Chris Lalancette 已提交
593 594
                                      char **result, unsigned int flags);

595 596 597 598 599
typedef virDomainPtr
    (*virDrvDomainQemuAttach)(virConnectPtr conn,
                              unsigned int pid,
                              unsigned int flags);

600 601 602 603 604
typedef int
    (*virDrvDomainOpenConsole)(virDomainPtr dom,
                               const char *devname,
                               virStreamPtr st,
                               unsigned int flags);
C
Chris Lalancette 已提交
605

606 607 608
typedef int
    (*virDrvDomainInjectNMI)(virDomainPtr dom, unsigned int flags);

609 610 611 612
typedef int
    (*virDrvDomainSendKey)(virDomainPtr dom, unsigned int codeset,
                           unsigned int holdtime,
                           unsigned int *keycodes,
613
                           int nkeycodes,
614 615
                           unsigned int flags);

616 617 618
typedef char *
    (*virDrvDomainMigrateBegin3)
                    (virDomainPtr domain,
619
                     const char *xmlin,
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
                     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,
657
                     const char *xmlin,
658 659 660 661
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
662
                     const char *dconnuri,
663 664 665 666 667
                     const char *uri,
                     unsigned long flags,
                     const char *dname,
                     unsigned long resource);

668
typedef virDomainPtr
669 670 671 672 673 674 675
    (*virDrvDomainMigrateFinish3)
                    (virConnectPtr dconn,
                     const char *dname,
                     const char *cookiein,
                     int cookieinlen,
                     char **cookieout,
                     int *cookieoutlen,
676
                     const char *dconnuri,
677 678
                     const char *uri,
                     unsigned long flags,
679
                     int cancelled);
680 681 682 683 684 685 686 687

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

689 690 691 692 693
/**
 * _virDriver:
 *
 * Structure associated to a virtualization driver, defining the various
 * entry points for it.
694 695 696 697 698 699
 *
 * All drivers must support the following fields/methods:
 *  - no
 *  - name
 *  - open
 *  - close
700 701
 */
struct _virDriver {
702
    int        no;	/* the number virDrvNo */
703 704 705
    const char * name;	/* the name of the driver */
    virDrvOpen			open;
    virDrvClose			close;
D
Daniel P. Berrange 已提交
706
    virDrvDrvSupportsFeature   supports_feature;
707 708
    virDrvGetType			type;
    virDrvGetVersion		version;
709
    virDrvGetLibVersion		libvirtVersion;
710
    virDrvGetHostname       getHostname;
E
Eric Blake 已提交
711
    virDrvGetSysinfo            getSysinfo;
712 713 714 715 716
    virDrvGetMaxVcpus		getMaxVcpus;
    virDrvNodeGetInfo		nodeGetInfo;
    virDrvGetCapabilities		getCapabilities;
    virDrvListDomains		listDomains;
    virDrvNumOfDomains		numOfDomains;
717
    virDrvDomainCreateXML		domainCreateXML;
718 719 720 721 722 723 724 725
    virDrvDomainLookupByID		domainLookupByID;
    virDrvDomainLookupByUUID	domainLookupByUUID;
    virDrvDomainLookupByName	domainLookupByName;
    virDrvDomainSuspend		domainSuspend;
    virDrvDomainResume		domainResume;
    virDrvDomainShutdown		domainShutdown;
    virDrvDomainReboot		domainReboot;
    virDrvDomainDestroy		domainDestroy;
726
    virDrvDomainDestroyFlags    domainDestroyFlags;
727 728 729 730
    virDrvDomainGetOSType		domainGetOSType;
    virDrvDomainGetMaxMemory	domainGetMaxMemory;
    virDrvDomainSetMaxMemory	domainSetMaxMemory;
    virDrvDomainSetMemory		domainSetMemory;
731
    virDrvDomainSetMemoryFlags  domainSetMemoryFlags;
732 733 734 735
    virDrvDomainSetMemoryParameters domainSetMemoryParameters;
    virDrvDomainGetMemoryParameters domainGetMemoryParameters;
    virDrvDomainSetBlkioParameters domainSetBlkioParameters;
    virDrvDomainGetBlkioParameters domainGetBlkioParameters;
736
    virDrvDomainGetInfo		domainGetInfo;
737
    virDrvDomainGetState	domainGetState;
738
    virDrvDomainGetControlInfo  domainGetControlInfo;
739
    virDrvDomainSave		domainSave;
740
    virDrvDomainSaveFlags	domainSaveFlags;
741
    virDrvDomainRestore		domainRestore;
742
    virDrvDomainRestoreFlags	domainRestoreFlags;
743 744
    virDrvDomainSaveImageGetXMLDesc domainSaveImageGetXMLDesc;
    virDrvDomainSaveImageDefineXML domainSaveImageDefineXML;
745 746
    virDrvDomainCoreDump        domainCoreDump;
    virDrvDomainScreenshot      domainScreenshot;
747
    virDrvDomainSetVcpus		domainSetVcpus;
E
Eric Blake 已提交
748 749
    virDrvDomainSetVcpusFlags		domainSetVcpusFlags;
    virDrvDomainGetVcpusFlags		domainGetVcpusFlags;
750
    virDrvDomainPinVcpu		domainPinVcpu;
751
    virDrvDomainPinVcpuFlags    domainPinVcpuFlags;
E
Eric Blake 已提交
752
    virDrvDomainGetVcpuPinInfo  domainGetVcpuPinInfo;
753 754
    virDrvDomainGetVcpus		domainGetVcpus;
    virDrvDomainGetMaxVcpus		domainGetMaxVcpus;
755 756
    virDrvDomainGetSecurityLabel     domainGetSecurityLabel;
    virDrvNodeGetSecurityModel  nodeGetSecurityModel;
757
    virDrvDomainGetXMLDesc		domainGetXMLDesc;
758 759
    virDrvConnectDomainXMLFromNative domainXMLFromNative;
    virDrvConnectDomainXMLToNative domainXMLToNative;
760 761 762
    virDrvListDefinedDomains	listDefinedDomains;
    virDrvNumOfDefinedDomains	numOfDefinedDomains;
    virDrvDomainCreate		domainCreate;
763
    virDrvDomainCreateWithFlags	domainCreateWithFlags;
764 765
    virDrvDomainDefineXML           domainDefineXML;
    virDrvDomainUndefine            domainUndefine;
O
Osier Yang 已提交
766
    virDrvDomainUndefineFlags       domainUndefineFlags;
767
    virDrvDomainAttachDevice	domainAttachDevice;
J
Jim Fehlig 已提交
768
    virDrvDomainAttachDeviceFlags	domainAttachDeviceFlags;
769
    virDrvDomainDetachDevice	domainDetachDevice;
J
Jim Fehlig 已提交
770
    virDrvDomainDetachDeviceFlags	domainDetachDeviceFlags;
771
    virDrvDomainUpdateDeviceFlags	domainUpdateDeviceFlags;
772 773 774 775
    virDrvDomainGetAutostart	domainGetAutostart;
    virDrvDomainSetAutostart	domainSetAutostart;
    virDrvDomainGetSchedulerType	domainGetSchedulerType;
    virDrvDomainGetSchedulerParameters domainGetSchedulerParameters;
776
    virDrvDomainGetSchedulerParametersFlags domainGetSchedulerParametersFlags;
777
    virDrvDomainSetSchedulerParameters domainSetSchedulerParameters;
778
    virDrvDomainSetSchedulerParametersFlags domainSetSchedulerParametersFlags;
779 780 781
    virDrvDomainMigratePrepare	domainMigratePrepare;
    virDrvDomainMigratePerform	domainMigratePerform;
    virDrvDomainMigrateFinish	domainMigrateFinish;
782 783
    virDrvDomainBlockStats      domainBlockStats;
    virDrvDomainInterfaceStats  domainInterfaceStats;
784
    virDrvDomainMemoryStats     domainMemoryStats;
R
Richard W.M. Jones 已提交
785
    virDrvDomainBlockPeek	domainBlockPeek;
R
Richard W.M. Jones 已提交
786
    virDrvDomainMemoryPeek      domainMemoryPeek;
787
    virDrvDomainGetBlockInfo    domainGetBlockInfo;
788
    virDrvNodeGetCPUStats       nodeGetCPUStats;
789
    virDrvNodeGetMemoryStats	nodeGetMemoryStats;
790
    virDrvNodeGetCellsFreeMemory	nodeGetCellsFreeMemory;
791
    virDrvNodeGetFreeMemory		nodeGetFreeMemory;
792 793
    virDrvDomainEventRegister         domainEventRegister;
    virDrvDomainEventDeregister       domainEventDeregister;
D
Daniel Veillard 已提交
794 795
    virDrvDomainMigratePrepare2	domainMigratePrepare2;
    virDrvDomainMigrateFinish2	domainMigrateFinish2;
796 797 798
    virDrvNodeDeviceDettach     nodeDeviceDettach;
    virDrvNodeDeviceReAttach    nodeDeviceReAttach;
    virDrvNodeDeviceReset       nodeDeviceReset;
C
Chris Lalancette 已提交
799
    virDrvDomainMigratePrepareTunnel domainMigratePrepareTunnel;
800 801 802 803
    virDrvConnectIsEncrypted   isEncrypted;
    virDrvConnectIsSecure      isSecure;
    virDrvDomainIsActive       domainIsActive;
    virDrvDomainIsPersistent   domainIsPersistent;
O
Osier Yang 已提交
804
    virDrvDomainIsUpdated      domainIsUpdated;
805 806
    virDrvCompareCPU            cpuCompare;
    virDrvBaselineCPU           cpuBaseline;
807
    virDrvDomainGetJobInfo     domainGetJobInfo;
808
    virDrvDomainAbortJob     domainAbortJob;
809
    virDrvDomainMigrateSetMaxDowntime  domainMigrateSetMaxDowntime;
810
    virDrvDomainMigrateSetMaxSpeed  domainMigrateSetMaxSpeed;
811 812
    virDrvDomainEventRegisterAny domainEventRegisterAny;
    virDrvDomainEventDeregisterAny domainEventDeregisterAny;
813 814 815
    virDrvDomainManagedSave domainManagedSave;
    virDrvDomainHasManagedSaveImage domainHasManagedSaveImage;
    virDrvDomainManagedSaveRemove domainManagedSaveRemove;
C
Chris Lalancette 已提交
816
    virDrvDomainSnapshotCreateXML domainSnapshotCreateXML;
817
    virDrvDomainSnapshotGetXMLDesc domainSnapshotGetXMLDesc;
C
Chris Lalancette 已提交
818 819 820 821 822 823 824
    virDrvDomainSnapshotNum domainSnapshotNum;
    virDrvDomainSnapshotListNames domainSnapshotListNames;
    virDrvDomainSnapshotLookupByName domainSnapshotLookupByName;
    virDrvDomainHasCurrentSnapshot domainHasCurrentSnapshot;
    virDrvDomainSnapshotCurrent domainSnapshotCurrent;
    virDrvDomainRevertToSnapshot domainRevertToSnapshot;
    virDrvDomainSnapshotDelete domainSnapshotDelete;
825
    virDrvDomainQemuMonitorCommand qemuDomainMonitorCommand;
826
    virDrvDomainQemuAttach qemuDomainAttach;
827
    virDrvDomainOpenConsole domainOpenConsole;
828
    virDrvDomainInjectNMI domainInjectNMI;
829 830 831 832 833 834
    virDrvDomainMigrateBegin3	domainMigrateBegin3;
    virDrvDomainMigratePrepare3	domainMigratePrepare3;
    virDrvDomainMigratePrepareTunnel3	domainMigratePrepareTunnel3;
    virDrvDomainMigratePerform3	domainMigratePerform3;
    virDrvDomainMigrateFinish3	domainMigrateFinish3;
    virDrvDomainMigrateConfirm3	domainMigrateConfirm3;
835
    virDrvDomainSendKey domainSendKey;
836 837
};

838
typedef int
839
        (*virDrvNumOfNetworks)		(virConnectPtr conn);
840
typedef int
841 842 843
        (*virDrvListNetworks)		(virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
844
typedef int
845
        (*virDrvNumOfDefinedNetworks)	(virConnectPtr conn);
846
typedef int
847 848 849
        (*virDrvListDefinedNetworks)	(virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
850
typedef virNetworkPtr
851 852
        (*virDrvNetworkLookupByUUID)	(virConnectPtr conn,
                                         const unsigned char *uuid);
853
typedef virNetworkPtr
854 855
        (*virDrvNetworkLookupByName)	(virConnectPtr conn,
                                         const char *name);
856
typedef virNetworkPtr
857 858
        (*virDrvNetworkCreateXML)	(virConnectPtr conn,
                                         const char *xmlDesc);
859
typedef virNetworkPtr
860 861
        (*virDrvNetworkDefineXML)	(virConnectPtr conn,
                                         const char *xml);
862
typedef int
863
        (*virDrvNetworkUndefine)	(virNetworkPtr network);
864
typedef int
865
        (*virDrvNetworkCreate)		(virNetworkPtr network);
866
typedef int
867
        (*virDrvNetworkDestroy)		(virNetworkPtr network);
868
typedef char *
869
        (*virDrvNetworkGetXMLDesc)		(virNetworkPtr network,
870
                                         unsigned int flags);
871
typedef char *
872
        (*virDrvNetworkGetBridgeName)	(virNetworkPtr network);
873
typedef int
874 875
        (*virDrvNetworkGetAutostart)	(virNetworkPtr network,
                                         int *autostart);
876
typedef int
877 878
        (*virDrvNetworkSetAutostart)	(virNetworkPtr network,
                                         int autostart);
879

880 881 882 883 884 885
typedef int
        (*virDrvNetworkIsActive)(virNetworkPtr net);
typedef int
        (*virDrvNetworkIsPersistent)(virNetworkPtr net);


886 887 888 889 890 891 892 893 894

typedef struct _virNetworkDriver virNetworkDriver;
typedef virNetworkDriver *virNetworkDriverPtr;

/**
 * _virNetworkDriver:
 *
 * Structure associated to a network virtualization driver, defining the various
 * entry points for it.
895 896 897 898
 *
 * All drivers must support the following fields/methods:
 *  - open
 *  - close
899 900
 */
struct _virNetworkDriver {
901 902 903 904 905 906 907 908 909 910 911 912 913 914
        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;
915
        virDrvNetworkGetXMLDesc		networkGetXMLDesc;
916 917 918
        virDrvNetworkGetBridgeName	networkGetBridgeName;
        virDrvNetworkGetAutostart	networkGetAutostart;
        virDrvNetworkSetAutostart	networkSetAutostart;
919 920
        virDrvNetworkIsActive           networkIsActive;
        virDrvNetworkIsPersistent       networkIsPersistent;
921 922
};

D
Daniel Veillard 已提交
923 924 925 926 927 928 929
/*-------*/
typedef int
        (*virDrvNumOfInterfaces)        (virConnectPtr conn);
typedef int
        (*virDrvListInterfaces)         (virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
930 931 932 933 934 935
typedef int
        (*virDrvNumOfDefinedInterfaces) (virConnectPtr conn);
typedef int
        (*virDrvListDefinedInterfaces)  (virConnectPtr conn,
                                         char **const names,
                                         int maxnames);
D
Daniel Veillard 已提交
936 937 938 939 940 941 942 943
typedef virInterfacePtr
        (*virDrvInterfaceLookupByName)  (virConnectPtr conn,
                                         const char *name);
typedef virInterfacePtr
        (*virDrvInterfaceLookupByMACString)   (virConnectPtr conn,
                                               const char *mac);

typedef char *
944
        (*virDrvInterfaceGetXMLDesc)    (virInterfacePtr iface,
D
Daniel Veillard 已提交
945 946 947 948 949 950 951
                                         unsigned int flags);

typedef virInterfacePtr
        (*virDrvInterfaceDefineXML)     (virConnectPtr conn,
                                         const char *xmlDesc,
                                         unsigned int flags);
typedef int
952
        (*virDrvInterfaceUndefine)      (virInterfacePtr iface);
D
Daniel Veillard 已提交
953
typedef int
954
        (*virDrvInterfaceCreate)        (virInterfacePtr iface,
D
Daniel Veillard 已提交
955 956
                                         unsigned int flags);
typedef int
957
        (*virDrvInterfaceDestroy)       (virInterfacePtr iface,
D
Daniel Veillard 已提交
958 959
                                         unsigned int flags);

960 961 962
typedef int
        (*virDrvInterfaceIsActive)(virInterfacePtr iface);

963 964 965 966 967 968 969 970 971
typedef int
        (*virDrvInterfaceChangeBegin)   (virConnectPtr conn,
                                         unsigned int flags);
typedef int
        (*virDrvInterfaceChangeCommit)  (virConnectPtr conn,
                                         unsigned int flags);
typedef int
        (*virDrvInterfaceChangeRollback)(virConnectPtr conn,
                                         unsigned int flags);
972

D
Daniel Veillard 已提交
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
typedef struct _virInterfaceDriver virInterfaceDriver;
typedef virInterfaceDriver *virInterfaceDriverPtr;

/**
 * _virInterfaceDriver:
 *
 * Structure associated to a network virtualization driver, defining the various
 * 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;
992 993
    virDrvNumOfDefinedInterfaces     numOfDefinedInterfaces;
    virDrvListDefinedInterfaces      listDefinedInterfaces;
D
Daniel Veillard 已提交
994 995 996 997 998 999 1000
    virDrvInterfaceLookupByName      interfaceLookupByName;
    virDrvInterfaceLookupByMACString interfaceLookupByMACString;
    virDrvInterfaceGetXMLDesc        interfaceGetXMLDesc;
    virDrvInterfaceDefineXML         interfaceDefineXML;
    virDrvInterfaceUndefine          interfaceUndefine;
    virDrvInterfaceCreate            interfaceCreate;
    virDrvInterfaceDestroy           interfaceDestroy;
1001
    virDrvInterfaceIsActive          interfaceIsActive;
1002 1003 1004
    virDrvInterfaceChangeBegin       interfaceChangeBegin;
    virDrvInterfaceChangeCommit      interfaceChangeCommit;
    virDrvInterfaceChangeRollback    interfaceChangeRollback;
D
Daniel Veillard 已提交
1005 1006
};

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

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);
1020 1021 1022 1023 1024
typedef char *
    (*virDrvConnectFindStoragePoolSources)   (virConnectPtr conn,
                                              const char *type,
                                              const char *srcSpec,
                                              unsigned int flags);
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
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);

1096 1097 1098 1099
typedef int
    (*virDrvStorageVolWipe)                  (virStorageVolPtr vol,
                                              unsigned int flags);

1100 1101 1102 1103 1104 1105 1106 1107 1108
typedef int
    (*virDrvStorageVolGetInfo)               (virStorageVolPtr vol,
                                              virStorageVolInfoPtr info);
typedef char *
    (*virDrvStorageVolGetXMLDesc)            (virStorageVolPtr pool,
                                              unsigned int flags);
typedef char *
    (*virDrvStorageVolGetPath)               (virStorageVolPtr vol);

1109 1110 1111 1112 1113
typedef virStorageVolPtr
    (*virDrvStorageVolCreateXMLFrom)         (virStoragePoolPtr pool,
                                              const char *xmldesc,
                                              virStorageVolPtr clone,
                                              unsigned int flags);
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
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);
1126

1127 1128 1129 1130 1131 1132
typedef int
        (*virDrvStoragePoolIsActive)(virStoragePoolPtr pool);
typedef int
        (*virDrvStoragePoolIsPersistent)(virStoragePoolPtr pool);


1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155

typedef struct _virStorageDriver virStorageDriver;
typedef virStorageDriver *virStorageDriverPtr;

/**
 * _virStorageDriver:
 *
 * Structure associated to a network virtualization driver, defining the various
 * 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;
1156
    virDrvConnectFindStoragePoolSources findPoolSources;
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
    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;
1179
    virDrvStorageVolCreateXMLFrom volCreateXMLFrom;
1180 1181
    virDrvStorageVolDownload volDownload;
    virDrvStorageVolUpload volUpload;
1182
    virDrvStorageVolDelete volDelete;
1183
    virDrvStorageVolWipe volWipe;
1184 1185 1186
    virDrvStorageVolGetInfo volGetInfo;
    virDrvStorageVolGetXMLDesc volGetXMLDesc;
    virDrvStorageVolGetPath volGetPath;
1187 1188
    virDrvStoragePoolIsActive   poolIsActive;
    virDrvStoragePoolIsPersistent   poolIsPersistent;
1189 1190
};

1191
# ifdef WITH_LIBVIRTD
1192
typedef int (*virDrvStateInitialize) (int privileged);
1193 1194 1195 1196 1197 1198 1199 1200
typedef int (*virDrvStateCleanup) (void);
typedef int (*virDrvStateReload) (void);
typedef int (*virDrvStateActive) (void);

typedef struct _virStateDriver virStateDriver;
typedef virStateDriver *virStateDriverPtr;

struct _virStateDriver {
1201
    const char *name;
1202 1203 1204 1205 1206
    virDrvStateInitialize  initialize;
    virDrvStateCleanup     cleanup;
    virDrvStateReload      reload;
    virDrvStateActive      active;
};
1207
# endif
1208

1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225

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

1226 1227
typedef char * (*virDevMonDeviceGetXMLDesc)(virNodeDevicePtr dev,
                                            unsigned int flags);
1228 1229 1230 1231 1232 1233 1234 1235 1236

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

typedef int (*virDevMonDeviceNumOfCaps)(virNodeDevicePtr dev);

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

1237 1238 1239 1240 1241
typedef virNodeDevicePtr (*virDrvNodeDeviceCreateXML)(virConnectPtr conn,
                                                      const char *xmlDesc,
                                                      unsigned int flags);
typedef int (*virDrvNodeDeviceDestroy)(virNodeDevicePtr dev);

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
/**
 * _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;
1256
    virDevMonDeviceGetXMLDesc deviceGetXMLDesc;
1257 1258 1259
    virDevMonDeviceGetParent deviceGetParent;
    virDevMonDeviceNumOfCaps deviceNumOfCaps;
    virDevMonDeviceListCaps deviceListCaps;
1260 1261
    virDrvNodeDeviceCreateXML deviceCreateXML;
    virDrvNodeDeviceDestroy deviceDestroy;
1262 1263
};

1264 1265
enum {
    /* This getValue call is inside libvirt, override the "private" flag.
E
Eric Blake 已提交
1266
       This flag cannot be set by outside callers. */
1267
    VIR_SECRET_GET_VALUE_INTERNAL_CALL = 1 << 0,
1268 1269
};

1270
typedef virSecretPtr
1271 1272
    (*virDrvSecretLookupByUUID)        (virConnectPtr conn,
                                        const unsigned char *uuid);
1273 1274 1275 1276
typedef virSecretPtr
    (*virDrvSecretLookupByUsage)       (virConnectPtr conn,
                                        int usageType,
                                        const char *usageID);
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
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,
1292 1293
                                              unsigned int flags,
                                              unsigned int internalFlags);
1294 1295 1296
typedef int
    (*virDrvSecretUndefine)                  (virSecretPtr secret);
typedef int
1297
    (*virDrvNumOfSecrets)              (virConnectPtr conn);
1298
typedef int
1299
    (*virDrvListSecrets)               (virConnectPtr conn,
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
                                              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;

1321 1322
    virDrvNumOfSecrets numOfSecrets;
    virDrvListSecrets listSecrets;
1323
    virDrvSecretLookupByUUID lookupByUUID;
1324
    virDrvSecretLookupByUsage lookupByUsage;
1325 1326 1327 1328 1329 1330 1331
    virDrvSecretDefineXML defineXML;
    virDrvSecretGetXMLDesc getXMLDesc;
    virDrvSecretSetValue setValue;
    virDrvSecretGetValue getValue;
    virDrvSecretUndefine undefine;
};

1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366

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 已提交
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
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 已提交
1381
                                               const char *xmlDesc);
S
Stefan Berger 已提交
1382
typedef int
1383
    (*virDrvNWFilterUndefine)                 (virNWFilterPtr nwfilter);
S
Stefan Berger 已提交
1384 1385

typedef char *
1386
    (*virDrvNWFilterGetXMLDesc)              (virNWFilterPtr nwfilter,
1387
                                              unsigned int flags);
S
Stefan Berger 已提交
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417


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;
};


1418 1419 1420 1421 1422 1423
/*
 * Registration
 * TODO: also need ways to (des)activate a given driver
 *       lookup based on the URI given in a virConnectOpen(ReadOnly)
 */
int virRegisterDriver(virDriverPtr);
1424
int virRegisterNetworkDriver(virNetworkDriverPtr);
D
Daniel Veillard 已提交
1425
int virRegisterInterfaceDriver(virInterfaceDriverPtr);
1426
int virRegisterStorageDriver(virStorageDriverPtr);
1427
int virRegisterDeviceMonitor(virDeviceMonitorPtr);
1428
int virRegisterSecretDriver(virSecretDriverPtr);
S
Stefan Berger 已提交
1429
int virRegisterNWFilterDriver(virNWFilterDriverPtr);
1430
# ifdef WITH_LIBVIRTD
1431
int virRegisterStateDriver(virStateDriverPtr);
1432
# endif
1433
void *virDriverLoadModule(const char *name);
1434 1435

#endif /* __VIR_DRIVER_H__ */