1 | /** @file
|
---|
2 | * VBoxGuestLib - VirtualBox Guest Additions Library.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2009 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_VBoxGuestLib_h
|
---|
27 | #define ___VBox_VBoxGuestLib_h
|
---|
28 |
|
---|
29 | #include <VBox/types.h>
|
---|
30 | #include <VBox/VMMDev2.h>
|
---|
31 | #include <VBox/VMMDev.h> /* grumble */
|
---|
32 | #ifdef IN_RING0
|
---|
33 | # include <VBox/VBoxGuest2.h>
|
---|
34 | #endif
|
---|
35 |
|
---|
36 |
|
---|
37 | /** @defgroup grp_guest_lib VirtualBox Guest Additions Library
|
---|
38 | * @{
|
---|
39 | */
|
---|
40 |
|
---|
41 | /** @page pg_guest_lib VirtualBox Guest Library
|
---|
42 | *
|
---|
43 | * This is a library for abstracting the additions driver interface. There are
|
---|
44 | * multiple versions of the library depending on the context. The main
|
---|
45 | * distinction is between kernel and user mode where the interfaces are very
|
---|
46 | * different.
|
---|
47 | *
|
---|
48 | *
|
---|
49 | * @section sec_guest_lib_ring0 Ring-0
|
---|
50 | *
|
---|
51 | * In ring-0 there are two version:
|
---|
52 | * - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
|
---|
53 | * who is responsible for managing the VMMDev virtual hardware.
|
---|
54 | * - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
|
---|
55 | *
|
---|
56 | *
|
---|
57 | * The library source code and the header have a define VBGL_VBOXGUEST, which is
|
---|
58 | * defined for VBoxGuest and undefined for other drivers. Drivers must choose
|
---|
59 | * right library in their makefiles and set VBGL_VBOXGUEST accordingly.
|
---|
60 | *
|
---|
61 | * The libraries consists of:
|
---|
62 | * - common code to be used by both VBoxGuest and other drivers;
|
---|
63 | * - VBoxGuest specific code;
|
---|
64 | * - code for other drivers which communicate with VBoxGuest via an IOCTL.
|
---|
65 | *
|
---|
66 | *
|
---|
67 | * @section sec_guest_lib_ring3 Ring-3
|
---|
68 | *
|
---|
69 | * There are more variants of the library here:
|
---|
70 | * - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
|
---|
71 | * - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
|
---|
72 | * drivers which uses special loader and or symbol resolving strategy.
|
---|
73 | * - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
|
---|
74 | * Dylibs.
|
---|
75 | *
|
---|
76 | */
|
---|
77 |
|
---|
78 | RT_C_DECLS_BEGIN
|
---|
79 |
|
---|
80 |
|
---|
81 | /** @defgroup grp_guest_lib_r0 Ring-0 interface.
|
---|
82 | * @{
|
---|
83 | */
|
---|
84 | #if defined(IN_RING0) && !defined(IN_RING0_AGNOSTIC)
|
---|
85 | /** @def DECLR0VBGL
|
---|
86 | * Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
|
---|
87 | * @param type Return type. */
|
---|
88 | # define DECLR0VBGL(type) type VBOXCALL
|
---|
89 | # define DECLVBGL(type) DECLR0VBGL(type)
|
---|
90 |
|
---|
91 | typedef uint32_t VBGLIOPORT; /**< @todo r=bird: We have RTIOPORT (uint16_t) for this. */
|
---|
92 |
|
---|
93 |
|
---|
94 | # ifdef VBGL_VBOXGUEST
|
---|
95 |
|
---|
96 | /**
|
---|
97 | * The library initialization function to be used by the main
|
---|
98 | * VBoxGuest system driver.
|
---|
99 | *
|
---|
100 | * @return VBox status code.
|
---|
101 | */
|
---|
102 | DECLVBGL(int) VbglInit (VBGLIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
|
---|
103 |
|
---|
104 | # else
|
---|
105 |
|
---|
106 | /**
|
---|
107 | * The library initialization function to be used by all drivers
|
---|
108 | * other than the main VBoxGuest system driver.
|
---|
109 | *
|
---|
110 | * @return VBox status code.
|
---|
111 | */
|
---|
112 | DECLVBGL(int) VbglInit (void);
|
---|
113 |
|
---|
114 | # endif
|
---|
115 |
|
---|
116 | /**
|
---|
117 | * The library termination function.
|
---|
118 | */
|
---|
119 | DECLVBGL(void) VbglTerminate (void);
|
---|
120 |
|
---|
121 |
|
---|
122 | /** @name Generic request functions.
|
---|
123 | * @{
|
---|
124 | */
|
---|
125 |
|
---|
126 | /**
|
---|
127 | * Allocate memory for generic request and initialize the request header.
|
---|
128 | *
|
---|
129 | * @param ppReq pointer to resulting memory address.
|
---|
130 | * @param cbSize size of memory block required for the request.
|
---|
131 | * @param reqType the generic request type.
|
---|
132 | *
|
---|
133 | * @return VBox status code.
|
---|
134 | */
|
---|
135 | DECLVBGL(int) VbglGRAlloc (VMMDevRequestHeader **ppReq, uint32_t cbSize, VMMDevRequestType reqType);
|
---|
136 |
|
---|
137 | /**
|
---|
138 | * Perform the generic request.
|
---|
139 | *
|
---|
140 | * @param pReq pointer the request structure.
|
---|
141 | *
|
---|
142 | * @return VBox status code.
|
---|
143 | */
|
---|
144 | DECLVBGL(int) VbglGRPerform (VMMDevRequestHeader *pReq);
|
---|
145 |
|
---|
146 | /**
|
---|
147 | * Free the generic request memory.
|
---|
148 | *
|
---|
149 | * @param pReq pointer the request structure.
|
---|
150 | *
|
---|
151 | * @return VBox status code.
|
---|
152 | */
|
---|
153 | DECLVBGL(void) VbglGRFree (VMMDevRequestHeader *pReq);
|
---|
154 |
|
---|
155 | /**
|
---|
156 | * Verify the generic request header.
|
---|
157 | *
|
---|
158 | * @param pReq pointer the request header structure.
|
---|
159 | * @param cbReq size of the request memory block. It should be equal to the request size
|
---|
160 | * for fixed size requests. It can be greater than the request size for
|
---|
161 | * variable size requests.
|
---|
162 | *
|
---|
163 | * @return VBox status code.
|
---|
164 | */
|
---|
165 | DECLVBGL(int) VbglGRVerify (const VMMDevRequestHeader *pReq, size_t cbReq);
|
---|
166 | /** @} */
|
---|
167 |
|
---|
168 | # ifdef VBOX_WITH_HGCM
|
---|
169 |
|
---|
170 | # ifdef VBGL_VBOXGUEST
|
---|
171 |
|
---|
172 | /**
|
---|
173 | * Callback function called from HGCM helpers when a wait for request
|
---|
174 | * completion IRQ is required.
|
---|
175 | *
|
---|
176 | * @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
|
---|
177 | * @param pvData VBoxGuest pointer to be passed to callback.
|
---|
178 | * @param u32Data VBoxGuest 32 bit value to be passed to callback.
|
---|
179 | */
|
---|
180 | typedef DECLVBGL(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader *pHeader, void *pvData, uint32_t u32Data);
|
---|
181 | /** Pointer to a FNVBGLHGCMCALLBACK. */
|
---|
182 | typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
|
---|
183 |
|
---|
184 | /**
|
---|
185 | * Perform a connect request. That is locate required service and
|
---|
186 | * obtain a client identifier for future access.
|
---|
187 | *
|
---|
188 | * @note This function can NOT handle cancelled requests!
|
---|
189 | *
|
---|
190 | * @param pConnectInfo The request data.
|
---|
191 | * @param pfnAsyncCallback Required pointer to function that is calledwhen
|
---|
192 | * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
|
---|
193 | * implements waiting for an IRQ in this function.
|
---|
194 | * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
|
---|
195 | * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
|
---|
196 | *
|
---|
197 | * @return VBox status code.
|
---|
198 | */
|
---|
199 |
|
---|
200 | DECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
|
---|
201 | PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
|
---|
202 |
|
---|
203 |
|
---|
204 | /**
|
---|
205 | * Perform a disconnect request. That is tell the host that
|
---|
206 | * the client will not call the service anymore.
|
---|
207 | *
|
---|
208 | * @note This function can NOT handle cancelled requests!
|
---|
209 | *
|
---|
210 | * @param pDisconnectInfo The request data.
|
---|
211 | * @param pfnAsyncCallback Required pointer to function that is called when
|
---|
212 | * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
|
---|
213 | * implements waiting for an IRQ in this function.
|
---|
214 | * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
|
---|
215 | * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
|
---|
216 | * callback.
|
---|
217 | *
|
---|
218 | * @return VBox status code.
|
---|
219 | */
|
---|
220 |
|
---|
221 | DECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
|
---|
222 | PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
|
---|
223 |
|
---|
224 | /** Call a HGCM service.
|
---|
225 | *
|
---|
226 | * @note This function can deal with cancelled requests.
|
---|
227 | *
|
---|
228 | * @param pCallInfo The request data.
|
---|
229 | * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
|
---|
230 | * @param pfnAsyncCallback Required pointer to function that is called when
|
---|
231 | * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
|
---|
232 | * implements waiting for an IRQ in this function.
|
---|
233 | * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
|
---|
234 | * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
|
---|
235 | *
|
---|
236 | * @return VBox status code.
|
---|
237 | */
|
---|
238 | DECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
|
---|
239 | PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
|
---|
240 |
|
---|
241 | /** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
|
---|
242 | *
|
---|
243 | * @note This function can deal with cancelled requests.
|
---|
244 | *
|
---|
245 | * @param pCallInfo The request data.
|
---|
246 | * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
|
---|
247 | * @param pfnAsyncCallback Required pointer to function that is called when
|
---|
248 | * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
|
---|
249 | * implements waiting for an IRQ in this function.
|
---|
250 | * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
|
---|
251 | * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
|
---|
252 | *
|
---|
253 | * @return VBox status code.
|
---|
254 | */
|
---|
255 | DECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
|
---|
256 | PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
|
---|
257 |
|
---|
258 | /** @name VbglR0HGCMInternalCall flags
|
---|
259 | * @{ */
|
---|
260 | /** User mode request.
|
---|
261 | * Indicates that only user mode addresses are permitted as parameters. */
|
---|
262 | #define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
|
---|
263 | /** Kernel mode request.
|
---|
264 | * Indicates that kernel mode addresses are permitted as parameters. Whether or
|
---|
265 | * not user mode addresses are permitted is, unfortunately, OS specific. The
|
---|
266 | * following OSes allows user mode addresses: Windows, TODO.
|
---|
267 | */
|
---|
268 | #define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
|
---|
269 | /** Mode mask. */
|
---|
270 | #define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
|
---|
271 | /** @} */
|
---|
272 |
|
---|
273 | # else /* !VBGL_VBOXGUEST */
|
---|
274 |
|
---|
275 | struct VBGLHGCMHANDLEDATA;
|
---|
276 | typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
|
---|
277 |
|
---|
278 | /** @name HGCM functions
|
---|
279 | * @{
|
---|
280 | */
|
---|
281 |
|
---|
282 | /**
|
---|
283 | * Connect to a service.
|
---|
284 | *
|
---|
285 | * @param pHandle Pointer to variable that will hold a handle to be used
|
---|
286 | * further in VbglHGCMCall and VbglHGCMClose.
|
---|
287 | * @param pData Connection information structure.
|
---|
288 | *
|
---|
289 | * @return VBox status code.
|
---|
290 | */
|
---|
291 | DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
|
---|
292 |
|
---|
293 | /**
|
---|
294 | * Connect to a service.
|
---|
295 | *
|
---|
296 | * @param handle Handle of the connection.
|
---|
297 | * @param pData Disconnect request information structure.
|
---|
298 | *
|
---|
299 | * @return VBox status code.
|
---|
300 | */
|
---|
301 | DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
|
---|
302 |
|
---|
303 | /**
|
---|
304 | * Call to a service.
|
---|
305 | *
|
---|
306 | * @param handle Handle of the connection.
|
---|
307 | * @param pData Call request information structure, including function parameters.
|
---|
308 | * @param cbData Length in bytes of data.
|
---|
309 | *
|
---|
310 | * @return VBox status code.
|
---|
311 | */
|
---|
312 | DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
|
---|
313 |
|
---|
314 | /**
|
---|
315 | * Call to a service with timeout.
|
---|
316 | *
|
---|
317 | * @param handle Handle of the connection.
|
---|
318 | * @param pData Call request information structure, including function parameters.
|
---|
319 | * @param cbData Length in bytes of data.
|
---|
320 | * @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
|
---|
321 | *
|
---|
322 | * @return VBox status code.
|
---|
323 | */
|
---|
324 | DECLVBGL(int) VbglHGCMCallTimed (VBGLHGCMHANDLE handle,
|
---|
325 | VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
|
---|
326 | /** @} */
|
---|
327 |
|
---|
328 | # endif /* !VBGL_VBOXGUEST */
|
---|
329 |
|
---|
330 | # endif /* VBOX_WITH_HGCM */
|
---|
331 |
|
---|
332 |
|
---|
333 | /**
|
---|
334 | * Initialize the heap.
|
---|
335 | *
|
---|
336 | * @return VBox error code.
|
---|
337 | */
|
---|
338 | DECLVBGL(int) VbglPhysHeapInit (void);
|
---|
339 |
|
---|
340 | /**
|
---|
341 | * Shutdown the heap.
|
---|
342 | */
|
---|
343 | DECLVBGL(void) VbglPhysHeapTerminate (void);
|
---|
344 |
|
---|
345 |
|
---|
346 | /**
|
---|
347 | * Allocate a memory block.
|
---|
348 | *
|
---|
349 | * @param cbSize Size of block to be allocated.
|
---|
350 | * @return Virtual address of allocated memory block.
|
---|
351 | */
|
---|
352 | DECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
|
---|
353 |
|
---|
354 | /**
|
---|
355 | * Get physical address of memory block pointed by
|
---|
356 | * the virtual address.
|
---|
357 | *
|
---|
358 | * @note WARNING!
|
---|
359 | * The function does not acquire the Heap mutex!
|
---|
360 | * When calling the function make sure that
|
---|
361 | * the pointer is a valid one and is not being
|
---|
362 | * deallocated.
|
---|
363 | * This function can NOT be used for verifying
|
---|
364 | * if the given pointer is a valid one allocated
|
---|
365 | * from the heap.
|
---|
366 | *
|
---|
367 | *
|
---|
368 | * @param p Virtual address of memory block.
|
---|
369 | * @return Physical memory block.
|
---|
370 | */
|
---|
371 | DECLVBGL(RTCCPHYS) VbglPhysHeapGetPhysAddr (void *p);
|
---|
372 |
|
---|
373 | /**
|
---|
374 | * Free a memory block.
|
---|
375 | *
|
---|
376 | * @param p Virtual address of memory block.
|
---|
377 | */
|
---|
378 | DECLVBGL(void) VbglPhysHeapFree (void *p);
|
---|
379 |
|
---|
380 | DECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
|
---|
381 | DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
|
---|
382 |
|
---|
383 | #endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
|
---|
384 | /** @} */
|
---|
385 |
|
---|
386 |
|
---|
387 | /** @defgroup grp_guest_lib_r3 Ring-3 interface.
|
---|
388 | * @{
|
---|
389 | */
|
---|
390 | #ifdef IN_RING3
|
---|
391 |
|
---|
392 | /** @def VBGLR3DECL
|
---|
393 | * Ring 3 VBGL declaration.
|
---|
394 | * @param type The return type of the function declaration.
|
---|
395 | */
|
---|
396 | # define VBGLR3DECL(type) type VBOXCALL
|
---|
397 |
|
---|
398 | /** @name General-purpose functions
|
---|
399 | * @{ */
|
---|
400 | VBGLR3DECL(int) VbglR3Init(void);
|
---|
401 | VBGLR3DECL(int) VbglR3InitUser(void);
|
---|
402 | VBGLR3DECL(void) VbglR3Term(void);
|
---|
403 | # ifdef ___iprt_time_h
|
---|
404 | VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
|
---|
405 | # endif
|
---|
406 | VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
|
---|
407 | VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
|
---|
408 | VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
|
---|
409 | VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose);
|
---|
410 | VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
|
---|
411 | VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
|
---|
412 | VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
|
---|
413 | VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
|
---|
414 | VBGLR3DECL(int) VbglR3GetAdditionsVersion(char **ppszVer, char **ppszRev);
|
---|
415 | VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
|
---|
416 | /** @} */
|
---|
417 |
|
---|
418 | /** @name Shared clipboard
|
---|
419 | * @{ */
|
---|
420 | VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
|
---|
421 | VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
|
---|
422 | VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
|
---|
423 | VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
|
---|
424 | VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
|
---|
425 | VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
|
---|
426 | /** @} */
|
---|
427 |
|
---|
428 | /** @name Seamless mode
|
---|
429 | * @{ */
|
---|
430 | VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
|
---|
431 | VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
|
---|
432 | VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
|
---|
433 | VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
|
---|
434 |
|
---|
435 | /** @} */
|
---|
436 |
|
---|
437 | /** @name Mouse
|
---|
438 | * @{ */
|
---|
439 | VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
|
---|
440 | VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
|
---|
441 | /** @} */
|
---|
442 |
|
---|
443 | /** @name Video
|
---|
444 | * @{ */
|
---|
445 | VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
|
---|
446 | VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
|
---|
447 | VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg);
|
---|
448 | VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
|
---|
449 | /** @} */
|
---|
450 |
|
---|
451 | /** @name Display
|
---|
452 | * @{ */
|
---|
453 | VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay, bool fAck);
|
---|
454 | VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
|
---|
455 | VBGLR3DECL(int) VbglR3SaveVideoMode(const char *pszName, uint32_t cx, uint32_t cy, uint32_t cBits);
|
---|
456 | VBGLR3DECL(int) VbglR3RetrieveVideoMode(const char *pszName, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits);
|
---|
457 | /** @} */
|
---|
458 |
|
---|
459 | /** @name VM Statistics
|
---|
460 | * @{ */
|
---|
461 | VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
|
---|
462 | VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
|
---|
463 | /** @} */
|
---|
464 |
|
---|
465 | /** @name Memory ballooning
|
---|
466 | * @{ */
|
---|
467 | VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t *pcChunks, bool *pfHandleInR3);
|
---|
468 | VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
|
---|
469 | /** @} */
|
---|
470 |
|
---|
471 | # ifdef VBOX_WITH_GUEST_PROPS
|
---|
472 | /** @name Guest properties
|
---|
473 | * @{ */
|
---|
474 | /** @todo Docs. */
|
---|
475 | typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
|
---|
476 | /** @todo Docs. */
|
---|
477 | typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
|
---|
478 | VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pu32ClientId);
|
---|
479 | VBGLR3DECL(int) VbglR3GuestPropDisconnect(uint32_t u32ClientId);
|
---|
480 | VBGLR3DECL(int) VbglR3GuestPropWrite(uint32_t u32ClientId, const char *pszName, const char *pszValue, const char *pszFlags);
|
---|
481 | VBGLR3DECL(int) VbglR3GuestPropWriteValue(uint32_t u32ClientId, const char *pszName, const char *pszValue);
|
---|
482 | VBGLR3DECL(int) VbglR3GuestPropWriteValueV(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, va_list va);
|
---|
483 | VBGLR3DECL(int) VbglR3GuestPropWriteValueF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...);
|
---|
484 | VBGLR3DECL(int) VbglR3GuestPropRead(uint32_t u32ClientId, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
|
---|
485 | VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue, uint32_t *pcchValueActual);
|
---|
486 | VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(uint32_t u32ClientId, const char *pszName, char **ppszValue);
|
---|
487 | VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
|
---|
488 | VBGLR3DECL(int) VbglR3GuestPropEnumRaw(uint32_t u32ClientId, const char *paszPatterns, char *pcBuf, uint32_t cbBuf, uint32_t *pcbBufActual);
|
---|
489 | VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId, char const * const *ppaszPatterns, uint32_t cPatterns, PVBGLR3GUESTPROPENUM *ppHandle,
|
---|
490 | char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp, char const **ppszFlags);
|
---|
491 | VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp,
|
---|
492 | char const **ppszFlags);
|
---|
493 | VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
|
---|
494 | VBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t u32ClientId, char const * const *papszPatterns, uint32_t cPatterns);
|
---|
495 | VBGLR3DECL(int) VbglR3GuestPropWait(uint32_t u32ClientId, const char *pszPatterns, void *pvBuf, uint32_t cbBuf, uint64_t u64Timestamp, uint32_t cMillies, char ** ppszName, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
|
---|
496 | /** @} */
|
---|
497 |
|
---|
498 | /** @name Host version handling
|
---|
499 | * @{ */
|
---|
500 | VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(uint32_t u32ClientId, bool *pfUpdate, char **ppszHostVersion, char **ppszGuestVersion);
|
---|
501 | VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(uint32_t u32ClientId, char **ppszVer);
|
---|
502 | VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(uint32_t u32ClientId, const char *pszVer);
|
---|
503 | /** @} */
|
---|
504 | # endif /* VBOX_WITH_GUEST_PROPS defined */
|
---|
505 |
|
---|
506 | # ifdef VBOX_WITH_GUEST_CONTROL
|
---|
507 | /** @name Guest control
|
---|
508 | * @{ */
|
---|
509 | VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pu32ClientId);
|
---|
510 | VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t u32ClientId);
|
---|
511 | VBGLR3DECL(int) VbglR3GuestCtrlGetHostMsg(uint32_t u32ClientId, uint32_t *puMsg, uint32_t *puNumParms);
|
---|
512 | VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t u32ClientId);
|
---|
513 | VBGLR3DECL(int) VbglR3GuestCtrlExecGetHostCmd(uint32_t u32ClientId, uint32_t uNumParms,
|
---|
514 | uint32_t *puContext,
|
---|
515 | char *pszCmd, uint32_t cbCmd,
|
---|
516 | uint32_t *puFlags,
|
---|
517 | char *pszArgs, uint32_t cbArgs, uint32_t *puNumArgs,
|
---|
518 | char *pszEnv, uint32_t *pcbEnv, uint32_t *puNumEnvVars,
|
---|
519 | char *pszUser, uint32_t cbUser,
|
---|
520 | char *pszPassword, uint32_t cbPassword,
|
---|
521 | uint32_t *puTimeLimit);
|
---|
522 | VBGLR3DECL(int) VbglR3GuestCtrlExecGetHostCmdOutput(uint32_t u32ClientId, uint32_t uNumParms,
|
---|
523 | uint32_t *puContext, uint32_t *puPID,
|
---|
524 | uint32_t *puHandle, uint32_t *puFlags);
|
---|
525 | VBGLR3DECL(int) VbglR3GuestCtrlExecReportStatus(uint32_t u32ClientId,
|
---|
526 | uint32_t u32Context,
|
---|
527 | uint32_t u32PID,
|
---|
528 | uint32_t u32Status,
|
---|
529 | uint32_t u32Flags,
|
---|
530 | void *pvData,
|
---|
531 | uint32_t cbData);
|
---|
532 | VBGLR3DECL(int) VbglR3GuestCtrlExecSendOut(uint32_t u32ClientId,
|
---|
533 | uint32_t u32Context,
|
---|
534 | uint32_t u32PID,
|
---|
535 | uint32_t u32Handle,
|
---|
536 | uint32_t u32Flags,
|
---|
537 | void *pvData,
|
---|
538 | uint32_t cbData);
|
---|
539 | /** @} */
|
---|
540 | # endif /* VBOX_WITH_GUEST_CONTROL defined */
|
---|
541 |
|
---|
542 | /** @name User credentials handling
|
---|
543 | * @{ */
|
---|
544 | VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
|
---|
545 | VBGLR3DECL(int) VbglR3CredentialsRetrieve(char **ppszUser, char **ppszPassword, char **ppszDomain);
|
---|
546 | VBGLR3DECL(void) VbglR3CredentialsDestroy(char *pszUser, char *pszPassword, char *pszDomain, uint32_t cPasses);
|
---|
547 | /** @} */
|
---|
548 |
|
---|
549 | /** @name CPU hotplug monitor
|
---|
550 | * @{ */
|
---|
551 | VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
|
---|
552 | VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
|
---|
553 | VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType *penmEventType, uint32_t *pidCpuCore, uint32_t *pidCpuPackage);
|
---|
554 | /** @} */
|
---|
555 |
|
---|
556 | /** @name Page sharing
|
---|
557 | * @{ */
|
---|
558 | VBGLR3DECL(int) VbglR3RegisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule, unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
|
---|
559 | VBGLR3DECL(int) VbglR3UnregisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
|
---|
560 | VBGLR3DECL(int) VbglR3CheckSharedModules(void);
|
---|
561 | VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
|
---|
562 | /** @} */
|
---|
563 |
|
---|
564 | #endif /* IN_RING3 */
|
---|
565 | /** @} */
|
---|
566 |
|
---|
567 | RT_C_DECLS_END
|
---|
568 |
|
---|
569 | /** @} */
|
---|
570 |
|
---|
571 | #endif
|
---|
572 |
|
---|