vbox_uniformed_api.h 29.0 KB
Newer Older
T
Taowei 已提交
1
/*
T
Taowei Luo 已提交
2
 * Copyright (C) 2014, Taowei Luo (uaedante@gmail.com)
T
Taowei 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef VBOX_UNIFORMED_API_H
# define VBOX_UNIFORMED_API_H

# include "internal.h"

/* This file may be used in three place. That is vbox_tmpl.c,
 * vbox_common.c and vbox_driver.c. The vboxUniformedAPI and some
 * types used for vboxUniformedAPI is defined here.
 *
 * The vbox_tmpl.c is the only place where the driver knows the inside
 * architecture of those vbox structs(vboxObj, vboxSession,
30
 * pFuncs, and vboxCallback). The file should be included
T
Taowei 已提交
31 32 33 34 35 36 37 38
 * after the currect vbox_CAPI_v*.h, then we can use the vbox structs
 * in vboxGlobalData. The vbox_tmpl.c should implement functions
 * defined in vboxUniformedAPI.
 *
 * In vbox_driver.c, it is used to define the struct vboxUniformedAPI.
 * The vbox_driver.c collects vboxUniformedAPI for all versions.
 * Then vboxRegister calls the vboxRegisterUniformedAPI to register.
 * Note: In vbox_driver.c, the vbox structs in vboxGlobalData is
39
 * defined by vbox_CAPI_v4_0.h.
T
Taowei 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
 *
 * The vbox_common.c, it is used to generate common codes for all vbox
 * versions. Bacause the same member varible's offset in a vbox struct
 * may change between different vbox versions. The vbox_common.c
 * shouldn't directly use struct's member varibles defined in
 * vbox_CAPI_v*.h. To make things safety, we include the
 * vbox_common.h in vbox_common.c. In this case, we treat structs
 * defined by vbox as a void*. The common codes don't concern about
 * the inside of this structs(actually, we can't, in the common level).
 * With the help of vboxUniformed API, we call VirtualBox's API and
 * implement the vbox driver in a high level.
 *
 * In conclusion:
 *  * In vbox_tmpl.c, this file is included after vbox_CAPI_v*.h
 *  * In vbox_driver.c, this file is included after vbox_glue.h
 *  * In vbox_common.c, this file is included after vbox_common.h
 *
 */

T
Taowei 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
/* Extracted define from vbox_tmpl.c */

# ifdef WIN32
struct _vboxIID_v2_x_WIN32 {
    /* IID is represented by a GUID value. */
    GUID value;
};
# endif /* !WIN32 */

struct _vboxIID_v2_x {
    /* IID is represented by a pointer to a nsID. */
    nsID *value;

    /* backing is used in cases where we need to create or copy an IID.
     * We cannot allocate memory that can be freed by ComUnallocMem.
     * Therefore, we use this stack allocated nsID instead. */
    nsID backing;
};

struct _vboxIID_v3_x {
    /* IID is represented by a UTF-16 encoded UUID in string form. */
    PRUnichar *value;

    /* owner indicates if we own the value and need to free it. */
    bool owner;
};

typedef union {
# ifdef WIN32
    struct _vboxIID_v2_x_WIN32 vboxIID_v2_x_WIN32;
# endif /* !WIN32 */
    struct _vboxIID_v2_x vboxIID_v2_x;
    struct _vboxIID_v3_x vboxIID_v3_x;
} vboxIIDUnion;

typedef union {
    nsresult uResultCode;
    PRInt32 resultCode;
} resultCodeUnion;

T
Taowei 已提交
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
struct _vboxDriver {
    virObjectLockable parent;

    virCapsPtr caps;
    virDomainXMLOptionPtr xmlopt;
    virObjectEventStatePtr domainEventState;

    /* vbox API initialization members */
    PCVBOXXPCOM pFuncs;
    IVirtualBox *vboxObj;
    ISession *vboxSession;
# if VBOX_API_VERSION == 4002020 || VBOX_API_VERSION >= 4003004
    IVirtualBoxClient *vboxClient;
# endif

    unsigned long version;

    /* reference counting of vbox connections */
    int volatile connectionCount;
};

typedef struct _vboxDriver vboxDriver;
typedef struct _vboxDriver *vboxDriverPtr;

T
Taowei 已提交
124 125 126 127 128 129
/* vboxUniformedAPI gives vbox_common.c a uniformed layer to see
 * vbox API.
 */

/* Functions for pFuncs */
typedef struct {
130 131
    int (*Initialize)(vboxDriverPtr driver);
    void (*Uninitialize)(vboxDriverPtr driver);
T
Taowei 已提交
132 133 134 135 136 137 138
    void (*ComUnallocMem)(PCVBOXXPCOM pFuncs, void *pv);
    void (*Utf16Free)(PCVBOXXPCOM pFuncs, PRUnichar *pwszString);
    void (*Utf8Free)(PCVBOXXPCOM pFuncs, char *pszString);
    int (*Utf16ToUtf8)(PCVBOXXPCOM pFuncs, const PRUnichar *pwszString, char **ppszString);
    int (*Utf8ToUtf16)(PCVBOXXPCOM pFuncs, const char *pszString, PRUnichar **ppwszString);
} vboxUniformedPFN;

T
Taowei 已提交
139 140 141
/* Functions for vboxIID */
typedef struct {
    void (*vboxIIDInitialize)(vboxIIDUnion *iidu);
142 143 144 145 146 147 148
    void (*vboxIIDUnalloc)(vboxDriverPtr driver, vboxIIDUnion *iidu);
    void (*vboxIIDToUUID)(vboxDriverPtr driver, vboxIIDUnion *iidu, unsigned char *uuid);
    void (*vboxIIDFromUUID)(vboxDriverPtr driver, vboxIIDUnion *iidu, const unsigned char *uuid);
    bool (*vboxIIDIsEqual)(vboxDriverPtr driver, vboxIIDUnion *iidu1, vboxIIDUnion *iidu2);
    void (*vboxIIDFromArrayItem)(vboxDriverPtr driver, vboxIIDUnion *iidu, vboxArray *array, int idx);
    void (*vboxIIDToUtf8)(vboxDriverPtr driver, vboxIIDUnion *iidu, char **utf8);
    void (*DEBUGIID)(vboxDriverPtr driver, const char *msg, vboxIIDUnion *iidu);
T
Taowei 已提交
149 150
} vboxUniformedIID;

T
Taowei 已提交
151 152 153
/* Functions for vboxArray */
typedef struct {
    nsresult (*vboxArrayGet)(vboxArray *array, void *self, void *getter);
154
    nsresult (*vboxArrayGetWithIIDArg)(vboxArray *array, void *self, void *getter, vboxIIDUnion *iidu);
T
Taowei 已提交
155
    void (*vboxArrayRelease)(vboxArray *array);
T
Taowei Luo 已提交
156
    void (*vboxArrayUnalloc)(vboxArray *array);
T
Taowei 已提交
157 158
    /* Generate function pointers for vboxArrayGet */
    void* (*handleGetMachines)(IVirtualBox *vboxObj);
159
    void* (*handleGetHardDisks)(IVirtualBox *vboxObj);
T
Taowei 已提交
160 161 162
    void* (*handleUSBGetDeviceFilters)(IUSBCommon *USBCommon);
    void* (*handleMachineGetMediumAttachments)(IMachine *machine);
    void* (*handleMachineGetSharedFolders)(IMachine *machine);
163 164 165
    void* (*handleSnapshotGetChildren)(ISnapshot *snapshot);
    void* (*handleMediumGetChildren)(IMedium *medium);
    void* (*handleMediumGetSnapshotIds)(IMedium *medium);
T
Taowei Luo 已提交
166
    void* (*handleMediumGetMachineIds)(IMedium *medium);
T
Taowei 已提交
167
    void* (*handleHostGetNetworkInterfaces)(IHost *host);
T
Taowei 已提交
168 169
} vboxUniformedArray;

T
Taowei 已提交
170 171 172
/* Functions for nsISupports */
typedef struct {
    nsresult (*Release)(nsISupports *nsi);
173
    nsresult (*AddRef)(nsISupports *nsi);
T
Taowei 已提交
174 175
} vboxUniformednsISupports;

T
Taowei 已提交
176 177 178
/* Functions for IVirtualBox */
typedef struct {
    nsresult (*GetVersion)(IVirtualBox *vboxObj, PRUnichar **versionUtf16);
T
Taowei 已提交
179
    nsresult (*GetMachine)(IVirtualBox *vboxObj, vboxIIDUnion *iidu, IMachine **machine);
180
    nsresult (*OpenMachine)(IVirtualBox *vboxObj, PRUnichar *settingsFile, IMachine **machine);
T
Taowei 已提交
181
    nsresult (*GetSystemProperties)(IVirtualBox *vboxObj, ISystemProperties **systemProperties);
T
Taowei 已提交
182
    nsresult (*GetHost)(IVirtualBox *vboxObj, IHost **host);
183
    nsresult (*CreateMachine)(vboxDriverPtr driver, virDomainDefPtr def, IMachine **machine, char *uuidstr);
184
    nsresult (*CreateHardDisk)(IVirtualBox *vboxObj, PRUnichar *format, PRUnichar *location, IMedium **medium);
T
Taowei 已提交
185
    nsresult (*RegisterMachine)(IVirtualBox *vboxObj, IMachine *machine);
186
    nsresult (*FindHardDisk)(IVirtualBox *vboxObj, PRUnichar *location, PRUint32 deviceType,
187
                             PRUint32 accessMode, IMedium **medium);
T
Taowei 已提交
188
    nsresult (*OpenMedium)(IVirtualBox *vboxObj, PRUnichar *location, PRUint32 deviceType, PRUint32 accessMode, IMedium **medium);
189
    nsresult (*GetHardDiskByIID)(IVirtualBox *vboxObj, vboxIIDUnion *iidu, IMedium **medium);
T
Taowei 已提交
190 191
    nsresult (*FindDHCPServerByNetworkName)(IVirtualBox *vboxObj, PRUnichar *name, IDHCPServer **server);
    nsresult (*CreateDHCPServer)(IVirtualBox *vboxObj, PRUnichar *name, IDHCPServer **server);
T
Taowei 已提交
192
    nsresult (*RemoveDHCPServer)(IVirtualBox *vboxObj, IDHCPServer *server);
T
Taowei 已提交
193 194
} vboxUniformedIVirtualBox;

T
Taowei 已提交
195 196
/* Functions for IMachine */
typedef struct {
T
Taowei 已提交
197 198
    nsresult (*AddStorageController)(IMachine *machine, PRUnichar *name,
        PRUint32 connectionType, IStorageController **controller);
T
Taowei 已提交
199 200
    nsresult (*GetStorageControllerByName)(IMachine *machine, PRUnichar *name,
                                           IStorageController **storageController);
T
Taowei 已提交
201 202 203 204 205 206
    nsresult (*AttachDevice)(IMachine *machine, PRUnichar *name,
                             PRInt32 controllerPort, PRInt32 device,
                             PRUint32 type, IMedium *medium);
    nsresult (*CreateSharedFolder)(IMachine *machine, PRUnichar *name,
                                   PRUnichar *hostPath, PRBool writable,
                                   PRBool automount);
T
Taowei 已提交
207
    nsresult (*RemoveSharedFolder)(IMachine *machine, PRUnichar *name);
208
    nsresult (*LaunchVMProcess)(vboxDriverPtr driver, IMachine *machine,
T
Taowei 已提交
209 210 211
                                vboxIIDUnion *iidu,
                                PRUnichar *sessionType, PRUnichar *env,
                                IProgress **progress);
212 213
    nsresult (*Unregister)(IMachine *machine, PRUint32 cleanupMode,
                           PRUint32 *aMediaSize, IMedium ***aMedia);
214
    nsresult (*FindSnapshot)(IMachine *machine, vboxIIDUnion *iidu, ISnapshot **snapshot);
T
Taowei Luo 已提交
215 216
    nsresult (*DetachDevice)(IMachine *machine, PRUnichar *name,
                             PRInt32 controllerPort, PRInt32 device);
T
Taowei 已提交
217 218
    nsresult (*GetAccessible)(IMachine *machine, PRBool *isAccessible);
    nsresult (*GetState)(IMachine *machine, PRUint32 *state);
T
Taowei 已提交
219 220
    nsresult (*GetName)(IMachine *machine, PRUnichar **name);
    nsresult (*GetId)(IMachine *machine, vboxIIDUnion *iidu);
T
Taowei 已提交
221 222 223 224 225 226
    nsresult (*GetBIOSSettings)(IMachine *machine, IBIOSSettings **bios);
    nsresult (*GetAudioAdapter)(IMachine *machine, IAudioAdapter **audioAdapter);
    nsresult (*GetNetworkAdapter)(IMachine *machine, PRUint32 slot, INetworkAdapter **adapter);
    nsresult (*GetChipsetType)(IMachine *machine, PRUint32 *chipsetType);
    nsresult (*GetSerialPort)(IMachine *machine, PRUint32 slot, ISerialPort **port);
    nsresult (*GetParallelPort)(IMachine *machine, PRUint32 slot, IParallelPort **port);
227
    nsresult (*GetVRDEServer)(IMachine *machine, IVRDEServer **VRDEServer);
T
Taowei 已提交
228
    nsresult (*GetUSBCommon)(IMachine *machine, IUSBCommon **USBCommon);
229 230
    nsresult (*GetCurrentSnapshot)(IMachine *machine, ISnapshot **currentSnapshot);
    nsresult (*GetSettingsFilePath)(IMachine *machine, PRUnichar **settingsFilePath);
T
Taowei 已提交
231
    nsresult (*GetCPUCount)(IMachine *machine, PRUint32 *CPUCount);
T
Taowei 已提交
232
    nsresult (*SetCPUCount)(IMachine *machine, PRUint32 CPUCount);
T
Taowei 已提交
233
    nsresult (*GetMemorySize)(IMachine *machine, PRUint32 *memorySize);
T
Taowei 已提交
234
    nsresult (*SetMemorySize)(IMachine *machine, PRUint32 memorySize);
T
Taowei 已提交
235
    nsresult (*GetCPUProperty)(IMachine *machine, PRUint32 property, PRBool *value);
T
Taowei 已提交
236
    nsresult (*SetCPUProperty)(IMachine *machine, PRUint32 property, PRBool value);
T
Taowei 已提交
237
    nsresult (*GetBootOrder)(IMachine *machine, PRUint32 position, PRUint32 *device);
T
Taowei 已提交
238
    nsresult (*SetBootOrder)(IMachine *machine, PRUint32 position, PRUint32 device);
T
Taowei 已提交
239
    nsresult (*GetVRAMSize)(IMachine *machine, PRUint32 *VRAMSize);
T
Taowei 已提交
240
    nsresult (*SetVRAMSize)(IMachine *machine, PRUint32 VRAMSize);
T
Taowei 已提交
241
    nsresult (*GetMonitorCount)(IMachine *machine, PRUint32 *monitorCount);
T
Taowei 已提交
242
    nsresult (*SetMonitorCount)(IMachine *machine, PRUint32 monitorCount);
T
Taowei 已提交
243
    nsresult (*GetAccelerate3DEnabled)(IMachine *machine, PRBool *accelerate3DEnabled);
T
Taowei 已提交
244
    nsresult (*SetAccelerate3DEnabled)(IMachine *machine, PRBool accelerate3DEnabled);
T
Taowei 已提交
245
    nsresult (*GetAccelerate2DVideoEnabled)(IMachine *machine, PRBool *accelerate2DVideoEnabled);
T
Taowei 已提交
246
    nsresult (*SetAccelerate2DVideoEnabled)(IMachine *machine, PRBool accelerate2DVideoEnabled);
T
Taowei 已提交
247
    nsresult (*GetExtraData)(IMachine *machine, PRUnichar *key, PRUnichar **value);
T
Taowei 已提交
248
    nsresult (*SetExtraData)(IMachine *machine, PRUnichar *key, PRUnichar *value);
249
    nsresult (*GetSnapshotCount)(IMachine *machine, PRUint32 *snapshotCount);
T
Taowei 已提交
250
    nsresult (*SaveSettings)(IMachine *machine);
T
Taowei 已提交
251 252
} vboxUniformedIMachine;

T
Taowei 已提交
253 254
/* Functions for ISession */
typedef struct {
255 256
    nsresult (*Open)(vboxDriverPtr driver, vboxIIDUnion *iidu, IMachine *machine);
    nsresult (*OpenExisting)(vboxDriverPtr driver, vboxIIDUnion *iidu, IMachine *machine);
T
Taowei 已提交
257
    nsresult (*GetConsole)(ISession *session, IConsole **console);
T
Taowei 已提交
258
    nsresult (*GetMachine)(ISession *session, IMachine **machine);
T
Taowei 已提交
259 260 261 262 263 264
    nsresult (*Close)(ISession *session);
} vboxUniformedISession;

/* Functions for IConsole */
typedef struct {
    nsresult (*SaveState)(IConsole *console, IProgress **progress);
T
Taowei 已提交
265
    nsresult (*Pause)(IConsole *console);
T
Taowei 已提交
266
    nsresult (*Resume)(IConsole *console);
T
Taowei 已提交
267
    nsresult (*PowerButton)(IConsole *console);
T
Taowei 已提交
268
    nsresult (*PowerDown)(IConsole *console);
T
Taowei 已提交
269
    nsresult (*Reset)(IConsole *console);
270 271
    nsresult (*TakeSnapshot)(IConsole *console, PRUnichar *name,
                             PRUnichar *description, IProgress **progress);
T
Taowei 已提交
272
    nsresult (*DeleteSnapshot)(IConsole *console, vboxIIDUnion *iidu, IProgress **progress);
T
Taowei 已提交
273
    nsresult (*GetDisplay)(IConsole *console, IDisplay **display);
274
    nsresult (*GetKeyboard)(IConsole *console, IKeyboard **keyboard);
T
Taowei 已提交
275 276 277 278 279 280
} vboxUniformedIConsole;

/* Functions for IProgress */
typedef struct {
    nsresult (*WaitForCompletion)(IProgress *progress, PRInt32 timeout);
    nsresult (*GetResultCode)(IProgress *progress, resultCodeUnion *resultCode);
T
Taowei 已提交
281
    nsresult (*GetCompleted)(IProgress *progress, PRBool *completed);
T
Taowei 已提交
282 283
} vboxUniformedIProgress;

T
Taowei 已提交
284 285 286
/* Functions for ISystemProperties */
typedef struct {
    nsresult (*GetMaxGuestCPUCount)(ISystemProperties *systemProperties, PRUint32 *maxCPUCount);
T
Taowei 已提交
287 288 289 290 291 292 293 294 295
    nsresult (*GetMaxBootPosition)(ISystemProperties *systemProperties, PRUint32 *maxBootPosition);
    nsresult (*GetMaxNetworkAdapters)(ISystemProperties *systemProperties, PRUint32 chipset,
                                      PRUint32 *maxNetworkAdapters);
    nsresult (*GetSerialPortCount)(ISystemProperties *systemProperties, PRUint32 *SerialPortCount);
    nsresult (*GetParallelPortCount)(ISystemProperties *systemProperties, PRUint32 *ParallelPortCount);
    nsresult (*GetMaxPortCountForStorageBus)(ISystemProperties *systemProperties, PRUint32 bus,
                                             PRUint32 *maxPortCount);
    nsresult (*GetMaxDevicesPerPortForStorageBus)(ISystemProperties *systemProperties,
                                                  PRUint32 bus, PRUint32 *maxDevicesPerPort);
T
Taowei 已提交
296
    nsresult (*GetMaxGuestRAM)(ISystemProperties *systemProperties, PRUint32 *maxGuestRAM);
T
Taowei 已提交
297 298
} vboxUniformedISystemProperties;

T
Taowei 已提交
299 300
/* Functions for IBIOSSettings */
typedef struct {
T
Taowei 已提交
301
    nsresult (*GetACPIEnabled)(IBIOSSettings *bios, PRBool *ACPIEnabled);
T
Taowei 已提交
302
    nsresult (*SetACPIEnabled)(IBIOSSettings *bios, PRBool ACPIEnabled);
T
Taowei 已提交
303
    nsresult (*GetIOAPICEnabled)(IBIOSSettings *bios, PRBool *IOAPICEnabled);
T
Taowei 已提交
304 305 306 307 308
    nsresult (*SetIOAPICEnabled)(IBIOSSettings *bios, PRBool IOAPICEnabled);
} vboxUniformedIBIOSSettings;

/* Functions for IAudioAdapter */
typedef struct {
T
Taowei 已提交
309
    nsresult (*GetEnabled)(IAudioAdapter *audioAdapter, PRBool *enabled);
T
Taowei 已提交
310
    nsresult (*SetEnabled)(IAudioAdapter *audioAdapter, PRBool enabled);
T
Taowei 已提交
311
    nsresult (*GetAudioController)(IAudioAdapter *audioAdapter, PRUint32 *audioController);
T
Taowei 已提交
312 313 314 315 316
    nsresult (*SetAudioController)(IAudioAdapter *audioAdapter, PRUint32 audioController);
} vboxUniformedIAudioAdapter;

/* Functions for INetworkAdapter */
typedef struct {
T
Taowei 已提交
317 318
    nsresult (*GetAttachmentType)(INetworkAdapter *adapter, PRUint32 *attachmentType);
    nsresult (*GetEnabled)(INetworkAdapter *adapter, PRBool *enabled);
T
Taowei 已提交
319
    nsresult (*SetEnabled)(INetworkAdapter *adapter, PRBool enabled);
T
Taowei 已提交
320
    nsresult (*GetAdapterType)(INetworkAdapter *adapter, PRUint32 *adapterType);
T
Taowei 已提交
321
    nsresult (*SetAdapterType)(INetworkAdapter *adapter, PRUint32 adapterType);
T
Taowei 已提交
322
    nsresult (*GetBridgedInterface)(INetworkAdapter *adapter, PRUnichar **bridgedInterface);
T
Taowei 已提交
323
    nsresult (*SetBridgedInterface)(INetworkAdapter *adapter, PRUnichar *bridgedInterface);
T
Taowei 已提交
324
    nsresult (*GetInternalNetwork)(INetworkAdapter *adapter, PRUnichar **internalNetwork);
T
Taowei 已提交
325
    nsresult (*SetInternalNetwork)(INetworkAdapter *adapter, PRUnichar *internalNetwork);
T
Taowei 已提交
326
    nsresult (*GetHostOnlyInterface)(INetworkAdapter *adapter, PRUnichar **hostOnlyInterface);
T
Taowei 已提交
327
    nsresult (*SetHostOnlyInterface)(INetworkAdapter *adapter, PRUnichar *hostOnlyInterface);
T
Taowei 已提交
328
    nsresult (*GetMACAddress)(INetworkAdapter *adapter, PRUnichar **MACAddress);
T
Taowei 已提交
329 330 331 332 333 334 335 336 337
    nsresult (*SetMACAddress)(INetworkAdapter *adapter, PRUnichar *MACAddress);
    nsresult (*AttachToBridgedInterface)(INetworkAdapter *adapter);
    nsresult (*AttachToInternalNetwork)(INetworkAdapter *adapter);
    nsresult (*AttachToHostOnlyInterface)(INetworkAdapter *adapter);
    nsresult (*AttachToNAT)(INetworkAdapter *adapter);
} vboxUniformedINetworkAdapter;

/* Functions for ISerialPort */
typedef struct {
T
Taowei 已提交
338
    nsresult (*GetEnabled)(ISerialPort *port, PRBool *enabled);
T
Taowei 已提交
339
    nsresult (*SetEnabled)(ISerialPort *port, PRBool enabled);
T
Taowei 已提交
340
    nsresult (*GetPath)(ISerialPort *port, PRUnichar **path);
T
Taowei 已提交
341
    nsresult (*SetPath)(ISerialPort *port, PRUnichar *path);
T
Taowei 已提交
342
    nsresult (*GetIRQ)(ISerialPort *port, PRUint32 *IRQ);
T
Taowei 已提交
343
    nsresult (*SetIRQ)(ISerialPort *port, PRUint32 IRQ);
T
Taowei 已提交
344
    nsresult (*GetIOBase)(ISerialPort *port, PRUint32 *IOBase);
T
Taowei 已提交
345
    nsresult (*SetIOBase)(ISerialPort *port, PRUint32 IOBase);
T
Taowei 已提交
346
    nsresult (*GetHostMode)(ISerialPort *port, PRUint32 *hostMode);
T
Taowei 已提交
347 348 349 350 351
    nsresult (*SetHostMode)(ISerialPort *port, PRUint32 hostMode);
} vboxUniformedISerialPort;

/* Functions for IParallelPort */
typedef struct {
T
Taowei 已提交
352
    nsresult (*GetEnabled)(IParallelPort *port, PRBool *enabled);
T
Taowei 已提交
353
    nsresult (*SetEnabled)(IParallelPort *port, PRBool enabled);
T
Taowei 已提交
354
    nsresult (*GetPath)(IParallelPort *port, PRUnichar **path);
T
Taowei 已提交
355
    nsresult (*SetPath)(IParallelPort *port, PRUnichar *path);
T
Taowei 已提交
356
    nsresult (*GetIRQ)(IParallelPort *port, PRUint32 *IRQ);
T
Taowei 已提交
357
    nsresult (*SetIRQ)(IParallelPort *port, PRUint32 IRQ);
T
Taowei 已提交
358
    nsresult (*GetIOBase)(IParallelPort *port, PRUint32 *IOBase);
T
Taowei 已提交
359 360 361
    nsresult (*SetIOBase)(IParallelPort *port, PRUint32 IOBase);
} vboxUniformedIParallelPort;

362
/* Functions for IVRDEServer */
T
Taowei 已提交
363
typedef struct {
364 365 366
    nsresult (*GetEnabled)(IVRDEServer *VRDEServer, PRBool *enabled);
    nsresult (*SetEnabled)(IVRDEServer *VRDEServer, PRBool enabled);
    nsresult (*GetPorts)(vboxDriverPtr driver, IVRDEServer *VRDEServer,
T
Taowei 已提交
367
                         virDomainGraphicsDefPtr graphics);
368
    nsresult (*SetPorts)(vboxDriverPtr driver, IVRDEServer *VRDEServer,
T
Taowei 已提交
369
                         virDomainGraphicsDefPtr graphics);
370 371 372 373 374
    nsresult (*GetReuseSingleConnection)(IVRDEServer *VRDEServer, PRBool *enabled);
    nsresult (*SetReuseSingleConnection)(IVRDEServer *VRDEServer, PRBool enabled);
    nsresult (*GetAllowMultiConnection)(IVRDEServer *VRDEServer, PRBool *enabled);
    nsresult (*SetAllowMultiConnection)(IVRDEServer *VRDEServer, PRBool enabled);
    nsresult (*GetNetAddress)(vboxDriverPtr driver, IVRDEServer *VRDEServer,
T
Taowei 已提交
375
                              PRUnichar **netAddress);
376
    nsresult (*SetNetAddress)(vboxDriverPtr driver, IVRDEServer *VRDEServer,
T
Taowei 已提交
377
                              PRUnichar *netAddress);
378
} vboxUniformedIVRDEServer;
T
Taowei 已提交
379 380 381 382

/* Common Functions for IUSBController and IUSBDeviceFilters */
typedef struct {
    nsresult (*Enable)(IUSBCommon *USBCommon);
T
Taowei 已提交
383
    nsresult (*GetEnabled)(IUSBCommon *USBCommon, PRBool *enabled);
T
Taowei 已提交
384 385 386 387 388 389 390
    nsresult (*CreateDeviceFilter)(IUSBCommon *USBCommon, PRUnichar *name,
                                   IUSBDeviceFilter **filter);
    nsresult (*InsertDeviceFilter)(IUSBCommon *USBCommon, PRUint32 position,
                                   IUSBDeviceFilter *filter);
} vboxUniformedIUSBCommon;

typedef struct {
T
Taowei 已提交
391
    nsresult (*GetProductId)(IUSBDeviceFilter *USBDeviceFilter, PRUnichar **productId);
T
Taowei 已提交
392
    nsresult (*SetProductId)(IUSBDeviceFilter *USBDeviceFilter, PRUnichar *productId);
T
Taowei 已提交
393
    nsresult (*GetActive)(IUSBDeviceFilter *USBDeviceFilter, PRBool *active);
T
Taowei 已提交
394
    nsresult (*SetActive)(IUSBDeviceFilter *USBDeviceFilter, PRBool active);
T
Taowei 已提交
395
    nsresult (*GetVendorId)(IUSBDeviceFilter *USBDeviceFilter, PRUnichar **vendorId);
T
Taowei 已提交
396 397 398 399 400 401
    nsresult (*SetVendorId)(IUSBDeviceFilter *USBDeviceFilter, PRUnichar *vendorId);
} vboxUniformedIUSBDeviceFilter;

/* Functions for IMedium */
typedef struct {
    nsresult (*GetId)(IMedium *medium, vboxIIDUnion *iidu);
T
Taowei 已提交
402
    nsresult (*GetLocation)(IMedium *medium, PRUnichar **location);
403
    nsresult (*GetState)(IMedium *medium, PRUint32 *state);
404
    nsresult (*GetName)(IMedium *medium, PRUnichar **name);
T
Taowei Luo 已提交
405
    nsresult (*GetSize)(IMedium *medium, PRUint64 *uSize);
T
Taowei 已提交
406
    nsresult (*GetReadOnly)(IMedium *medium, PRBool *readOnly);
407
    nsresult (*GetParent)(IMedium *medium, IMedium **parent);
408 409
    nsresult (*GetChildren)(IMedium *medium, PRUint32 *childrenSize,
                            IMedium ***children);
410 411
    nsresult (*GetFormat)(IMedium *medium, PRUnichar **format);
    nsresult (*DeleteStorage)(IMedium *medium, IProgress **progress);
T
Taowei 已提交
412
    nsresult (*Release)(IMedium *medium);
413
    nsresult (*Close)(IMedium *medium);
T
Taowei 已提交
414
    nsresult (*SetType)(IMedium *medium, PRUint32 type);
415 416 417 418 419 420
    nsresult (*CreateDiffStorage)(IMedium *medium, IMedium *target,
                                  PRUint32 variantSize, PRUint32 *variant,
                                  IProgress **progress);
    nsresult (*CreateBaseStorage)(IMedium *medium, PRUint64 logicalSize,
                                  PRUint32 variant, IProgress **progress);
    nsresult (*GetLogicalSize)(IMedium *medium, PRUint64 *uLogicalSize);
T
Taowei 已提交
421 422
} vboxUniformedIMedium;

T
Taowei 已提交
423 424
/* Functions for IMediumAttachment */
typedef struct {
425
    nsresult (*GetMedium)(IMediumAttachment *mediumAttachment, IMedium **medium);
T
Taowei 已提交
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
    nsresult (*GetController)(IMediumAttachment *mediumAttachment, PRUnichar **controller);
    nsresult (*GetType)(IMediumAttachment *mediumAttachment, PRUint32 *type);
    nsresult (*GetPort)(IMediumAttachment *mediumAttachment, PRInt32 *port);
    nsresult (*GetDevice)(IMediumAttachment *mediumAttachment, PRInt32 *device);
} vboxUniformedIMediumAttachment;


/* Functions for IStorageController */
typedef struct {
    nsresult (*GetBus)(IStorageController *storageController, PRUint32 *bus);
} vboxUniformedIStorageController;

/* Functions for ISharedFolder */
typedef struct {
    nsresult (*GetHostPath)(ISharedFolder *sharedFolder, PRUnichar **hostPath);
    nsresult (*GetName)(ISharedFolder *sharedFolder, PRUnichar **name);
    nsresult (*GetWritable)(ISharedFolder *sharedFolder, PRBool *writable);
} vboxUniformedISharedFolder;

445 446 447 448 449 450 451 452 453 454 455
/* Functions for ISnapshot */
typedef struct {
    nsresult (*GetName)(ISnapshot *snapshot, PRUnichar **name);
    nsresult (*GetId)(ISnapshot *snapshot, vboxIIDUnion *iidu);
    nsresult (*GetMachine)(ISnapshot *snapshot, IMachine **machine);
    nsresult (*GetDescription)(ISnapshot *snapshot, PRUnichar **description);
    nsresult (*GetTimeStamp)(ISnapshot *snapshot, PRInt64 *timeStamp);
    nsresult (*GetParent)(ISnapshot *snapshot, ISnapshot **parent);
    nsresult (*GetOnline)(ISnapshot *snapshot, PRBool *online);
} vboxUniformedISnapshot;

T
Taowei 已提交
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
/* Functions for IDisplay */
typedef struct {
    nsresult (*GetScreenResolution)(IDisplay *display,
                                    PRUint32 screenId,
                                    PRUint32 *width,
                                    PRUint32 *height,
                                    PRUint32 *bitsPerPixel,
                                    PRInt32 *xOrigin,
                                    PRInt32 *yOrigin);
    nsresult (*TakeScreenShotPNGToArray)(IDisplay *display,
                                         PRUint32 screenId,
                                         PRUint32 width,
                                         PRUint32 height,
                                         PRUint32 *screenDataSize,
                                         PRUint8** screenData);
} vboxUniformedIDisplay;

T
Taowei 已提交
473 474 475 476
/* Functions for IHost */
typedef struct {
    nsresult (*FindHostNetworkInterfaceById)(IHost *host, vboxIIDUnion *iidu,
                                             IHostNetworkInterface **networkInterface);
T
Taowei 已提交
477 478
    nsresult (*FindHostNetworkInterfaceByName)(IHost *host, PRUnichar *name,
                                               IHostNetworkInterface **networkInterface);
479
    nsresult (*CreateHostOnlyNetworkInterface)(vboxDriverPtr driver,
T
Taowei 已提交
480 481
                                               IHost *host, char *name,
                                               IHostNetworkInterface **networkInterface);
T
Taowei 已提交
482 483
    nsresult (*RemoveHostOnlyNetworkInterface)(IHost *host, vboxIIDUnion *iidu,
                                               IProgress **progress);
T
Taowei 已提交
484 485
} vboxUniformedIHost;

T
Taowei 已提交
486 487 488 489
/* Functions for IHostNetworkInterface */
typedef struct {
    nsresult (*GetInterfaceType)(IHostNetworkInterface *hni, PRUint32 *interfaceType);
    nsresult (*GetStatus)(IHostNetworkInterface *hni, PRUint32 *status);
T
Taowei 已提交
490
    nsresult (*GetName)(IHostNetworkInterface *hni, PRUnichar **name);
T
Taowei 已提交
491
    nsresult (*GetId)(IHostNetworkInterface *hni, vboxIIDUnion *iidu);
T
Taowei 已提交
492 493 494
    nsresult (*GetHardwareAddress)(IHostNetworkInterface *hni, PRUnichar **hardwareAddress);
    nsresult (*GetIPAddress)(IHostNetworkInterface *hni, PRUnichar **IPAddress);
    nsresult (*GetNetworkMask)(IHostNetworkInterface *hni, PRUnichar **networkMask);
T
Taowei 已提交
495 496 497 498
    nsresult (*EnableStaticIPConfig)(IHostNetworkInterface *hni, PRUnichar *IPAddress,
                                     PRUnichar *networkMask);
    nsresult (*EnableDynamicIPConfig)(IHostNetworkInterface *hni);
    nsresult (*DHCPRediscover)(IHostNetworkInterface *hni);
T
Taowei 已提交
499 500
} vboxUniformedIHNInterface;

T
Taowei 已提交
501 502
/* Functions for IDHCPServer */
typedef struct {
T
Taowei 已提交
503 504 505 506
    nsresult (*GetIPAddress)(IDHCPServer *dhcpServer, PRUnichar **IPAddress);
    nsresult (*GetNetworkMask)(IDHCPServer *dhcpServer, PRUnichar **networkMask);
    nsresult (*GetLowerIP)(IDHCPServer *dhcpServer, PRUnichar **lowerIP);
    nsresult (*GetUpperIP)(IDHCPServer *dhcpServer, PRUnichar **upperIP);
T
Taowei 已提交
507 508 509 510 511 512
    nsresult (*SetEnabled)(IDHCPServer *dhcpServer, PRBool enabled);
    nsresult (*SetConfiguration)(IDHCPServer *dhcpServer, PRUnichar *IPAddress,
                                 PRUnichar *networkMask, PRUnichar *FromIPAddress,
                                 PRUnichar *ToIPAddress);
    nsresult (*Start)(IDHCPServer *dhcpServer, PRUnichar *networkName,
                      PRUnichar *trunkName, PRUnichar *trunkType);
T
Taowei 已提交
513
    nsresult (*Stop)(IDHCPServer *dhcpServer);
T
Taowei 已提交
514 515
} vboxUniformedIDHCPServer;

516 517 518 519 520 521
typedef struct {
    nsresult (*PutScancode)(IKeyboard *keyboard, PRInt32 scancode);
    nsresult (*PutScancodes)(IKeyboard *keyboard, PRUint32 scancodesSize,
                             PRInt32 *scanCodes, PRUint32 *codesStored);
} vboxUniformedIKeyboard;

T
Taowei 已提交
522 523
typedef struct {
    bool (*Online)(PRUint32 state);
524
    bool (*Inactive)(PRUint32 state);
T
Taowei 已提交
525
    bool (*NotStart)(PRUint32 state);
T
Taowei 已提交
526
    bool (*Running)(PRUint32 state);
T
Taowei 已提交
527
    bool (*Paused)(PRUint32 state);
T
Taowei 已提交
528
    bool (*PoweredOff)(PRUint32 state);
T
Taowei 已提交
529 530
} uniformedMachineStateChecker;

T
Taowei 已提交
531 532 533 534 535
typedef struct {
    /* vbox API version */
    uint32_t APIVersion;
    uint32_t XPCOMCVersion;
    /* vbox APIs */
536
    nsresult (*unregisterMachine)(vboxDriverPtr driver, vboxIIDUnion *iidu, IMachine **machine);
T
Taowei 已提交
537
    void (*deleteConfig)(IMachine *machine);
538
    void (*vboxAttachDrivesOld)(virDomainDefPtr def, vboxDriverPtr driver, IMachine *machine);
T
Taowei 已提交
539
    virDomainState (*vboxConvertState)(PRUint32 state);
540
    int (*snapshotRestore)(virDomainPtr dom, IMachine *machine, ISnapshot *snapshot);
T
Taowei 已提交
541
    vboxUniformedPFN UPFN;
T
Taowei 已提交
542
    vboxUniformedIID UIID;
T
Taowei 已提交
543
    vboxUniformedArray UArray;
T
Taowei 已提交
544
    vboxUniformednsISupports nsUISupports;
T
Taowei 已提交
545
    vboxUniformedIVirtualBox UIVirtualBox;
T
Taowei 已提交
546
    vboxUniformedIMachine UIMachine;
T
Taowei 已提交
547 548 549
    vboxUniformedISession UISession;
    vboxUniformedIConsole UIConsole;
    vboxUniformedIProgress UIProgress;
T
Taowei 已提交
550
    vboxUniformedISystemProperties UISystemProperties;
T
Taowei 已提交
551 552 553 554 555
    vboxUniformedIBIOSSettings UIBIOSSettings;
    vboxUniformedIAudioAdapter UIAudioAdapter;
    vboxUniformedINetworkAdapter UINetworkAdapter;
    vboxUniformedISerialPort UISerialPort;
    vboxUniformedIParallelPort UIParallelPort;
556
    vboxUniformedIVRDEServer UIVRDEServer;
T
Taowei 已提交
557 558 559
    vboxUniformedIUSBCommon UIUSBCommon;
    vboxUniformedIUSBDeviceFilter UIUSBDeviceFilter;
    vboxUniformedIMedium UIMedium;
T
Taowei 已提交
560 561 562
    vboxUniformedIMediumAttachment UIMediumAttachment;
    vboxUniformedIStorageController UIStorageController;
    vboxUniformedISharedFolder UISharedFolder;
563
    vboxUniformedISnapshot UISnapshot;
T
Taowei 已提交
564
    vboxUniformedIDisplay UIDisplay;
T
Taowei 已提交
565
    vboxUniformedIHost UIHost;
T
Taowei 已提交
566
    vboxUniformedIHNInterface UIHNInterface;
T
Taowei 已提交
567
    vboxUniformedIDHCPServer UIDHCPServer;
568
    vboxUniformedIKeyboard UIKeyboard;
T
Taowei 已提交
569
    uniformedMachineStateChecker machineStateChecker;
T
Taowei 已提交
570
    /* vbox API features */
T
Taowei 已提交
571
    bool chipsetType;
572
    bool vboxSnapshotRedefine;
T
Taowei 已提交
573 574
} vboxUniformedAPI;

T
Taowei 已提交
575 576
virDomainPtr vboxDomainLookupByUUID(virConnectPtr conn,
                                    const unsigned char *uuid);
T
Taowei 已提交
577 578 579 580 581 582 583 584

/* Version specified functions for installing uniformed API */
void vbox40InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
void vbox41InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
void vbox42InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
void vbox42_20InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
void vbox43InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
void vbox43_4InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
M
Martin Pietsch 已提交
585
void vbox50InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
586
void vbox51InstallUniformedAPI(vboxUniformedAPI *pVBoxAPI);
T
Taowei 已提交
587 588

#endif /* VBOX_UNIFORMED_API_H */