VBoxGuestLib.h@ 62476

Last change on this file since 62476 was 62476, checked in by vboxsync, 8 years ago
(C) 2016
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 38.1 KB

Line
1	/** @file
2	* VBoxGuestLib - VirtualBox Guest Additions Library.
3	*/
4
5	/*
6	* Copyright (C) 2006-2016 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/VBoxGuest.h>
34	# include <VBox/VBoxGuest2.h>
35	#endif
36
37
38	/** @defgroup grp_vboxguest_lib VirtualBox Guest Additions Library
39	* @ingroup grp_vboxguest
40	* @{
41	*/
42
43	/** @page pg_guest_lib VirtualBox Guest Library
44	*
45	* This is a library for abstracting the additions driver interface. There are
46	* multiple versions of the library depending on the context. The main
47	* distinction is between kernel and user mode where the interfaces are very
48	* different.
49	*
50	*
51	* @section sec_guest_lib_ring0 Ring-0
52	*
53	* In ring-0 there are two version:
54	* - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
55	* who is responsible for managing the VMMDev virtual hardware.
56	* - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
57	*
58	*
59	* The library source code and the header have a define VBGL_VBOXGUEST, which is
60	* defined for VBoxGuest and undefined for other drivers. Drivers must choose
61	* right library in their makefiles and set VBGL_VBOXGUEST accordingly.
62	*
63	* The libraries consists of:
64	* - common code to be used by both VBoxGuest and other drivers;
65	* - VBoxGuest specific code;
66	* - code for other drivers which communicate with VBoxGuest via an IOCTL.
67	*
68	*
69	* @section sec_guest_lib_ring3 Ring-3
70	*
71	* There are more variants of the library here:
72	* - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
73	* - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
74	* drivers which uses special loader and or symbol resolving strategy.
75	* - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
76	* Dylibs.
77	*
78	*/
79
80	RT_C_DECLS_BEGIN
81
82	/** HGCM client ID.
83	* @todo Promote to VBox/types.h */
84	typedef uint32_t HGCMCLIENTID;
85
86
87	/** @defgroup grp_vboxguest_lib_r0 Ring-0 interface.
88	* @{
89	*/
90	#if defined(IN_RING0) && !defined(IN_RING0_AGNOSTIC)
91	/** @def DECLR0VBGL
92	* Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
93	* @param type Return type. */
94	# ifdef RT_OS_DARWIN /** @todo probably apply to all, but don't want a forest fire on our hands right now. */
95	# define DECLR0VBGL(type) DECLHIDDEN(type) VBOXCALL
96	# else
97	# define DECLR0VBGL(type) type VBOXCALL
98	# endif
99	# define DECLVBGL(type) DECLR0VBGL(type)
100
101
102	# ifdef VBGL_VBOXGUEST
103
104	/**
105	* The library initialization function to be used by the main
106	* VBoxGuest system driver.
107	*
108	* @return VBox status code.
109	*/
110	DECLVBGL(int) VbglInitPrimary(RTIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
111
112	# else
113
114	/**
115	* The library initialization function to be used by all drivers
116	* other than the main VBoxGuest system driver.
117	*
118	* @return VBox status code.
119	*/
120	DECLVBGL(int) VbglInitClient(void);
121
122	# endif
123
124	/**
125	* The library termination function.
126	*/
127	DECLVBGL(void) VbglTerminate (void);
128
129
130	/** @name Generic request functions.
131	* @{
132	*/
133
134	/**
135	* Allocate memory for generic request and initialize the request header.
136	*
137	* @returns VBox status code.
138	* @param ppReq Where to return the pointer to the allocated memory.
139	* @param cbReq Size of memory block required for the request.
140	* @param enmReqType the generic request type.
141	*/
142	DECLVBGL(int) VbglGRAlloc(VMMDevRequestHeader **ppReq, size_t cbReq, VMMDevRequestType enmReqType);
143
144	/**
145	* Perform the generic request.
146	*
147	* @param pReq pointer the request structure.
148	*
149	* @return VBox status code.
150	*/
151	DECLVBGL(int) VbglGRPerform (VMMDevRequestHeader *pReq);
152
153	/**
154	* Free the generic request memory.
155	*
156	* @param pReq pointer the request structure.
157	*
158	* @return VBox status code.
159	*/
160	DECLVBGL(void) VbglGRFree (VMMDevRequestHeader *pReq);
161
162	/**
163	* Verify the generic request header.
164	*
165	* @param pReq pointer the request header structure.
166	* @param cbReq size of the request memory block. It should be equal to the request size
167	* for fixed size requests. It can be greater than the request size for
168	* variable size requests.
169	*
170	* @return VBox status code.
171	*/
172	DECLVBGL(int) VbglGRVerify (const VMMDevRequestHeader *pReq, size_t cbReq);
173	/** @} */
174
175	# ifdef VBOX_WITH_HGCM
176
177	# ifdef VBGL_VBOXGUEST
178
179	/**
180	* Callback function called from HGCM helpers when a wait for request
181	* completion IRQ is required.
182	*
183	* @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
184	* @param pvData VBoxGuest pointer to be passed to callback.
185	* @param u32Data VBoxGuest 32 bit value to be passed to callback.
186	*/
187	typedef DECLCALLBACK(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader pHeader, void pvData, uint32_t u32Data);
188	/** Pointer to a FNVBGLHGCMCALLBACK. */
189	typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
190
191	/**
192	* Perform a connect request. That is locate required service and
193	* obtain a client identifier for future access.
194	*
195	* @note This function can NOT handle cancelled requests!
196	*
197	* @param pConnectInfo The request data.
198	* @param pfnAsyncCallback Required pointer to function that is calledwhen
199	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
200	* implements waiting for an IRQ in this function.
201	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
202	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
203	*
204	* @return VBox status code.
205	*/
206
207	DECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
208	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
209
210
211	/**
212	* Perform a disconnect request. That is tell the host that
213	* the client will not call the service anymore.
214	*
215	* @note This function can NOT handle cancelled requests!
216	*
217	* @param pDisconnectInfo The request data.
218	* @param pfnAsyncCallback Required pointer to function that is called when
219	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
220	* implements waiting for an IRQ in this function.
221	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
222	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
223	* callback.
224	*
225	* @return VBox status code.
226	*/
227
228	DECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
229	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
230
231	/** Call a HGCM service.
232	*
233	* @note This function can deal with cancelled requests.
234	*
235	* @param pCallInfo The request data.
236	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
237	* @param pfnAsyncCallback Required pointer to function that is called when
238	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
239	* implements waiting for an IRQ in this function.
240	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
241	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
242	*
243	* @return VBox status code.
244	*/
245	DECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
246	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
247
248	/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
249	*
250	* @note This function can deal with cancelled requests.
251	*
252	* @param pCallInfo The request data.
253	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
254	* @param pfnAsyncCallback Required pointer to function that is called when
255	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
256	* implements waiting for an IRQ in this function.
257	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
258	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
259	*
260	* @return VBox status code.
261	*/
262	DECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
263	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
264
265	/** @name VbglR0HGCMInternalCall flags
266	* @{ */
267	/** User mode request.
268	* Indicates that only user mode addresses are permitted as parameters. */
269	#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
270	/** Kernel mode request.
271	* Indicates that kernel mode addresses are permitted as parameters. Whether or
272	* not user mode addresses are permitted is, unfortunately, OS specific. The
273	* following OSes allows user mode addresses: Windows, TODO.
274	*/
275	#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
276	/** Mode mask. */
277	#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
278	/** @} */
279
280	# else /* !VBGL_VBOXGUEST */
281
282	struct VBGLHGCMHANDLEDATA;
283	typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
284
285	/** @name HGCM functions
286	* @{
287	*/
288
289	/**
290	* Connect to a service.
291	*
292	* @param pHandle Pointer to variable that will hold a handle to be used
293	* further in VbglHGCMCall and VbglHGCMClose.
294	* @param pData Connection information structure.
295	*
296	* @return VBox status code.
297	*/
298	DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE pHandle, VBoxGuestHGCMConnectInfo pData);
299
300	/**
301	* Connect to a service.
302	*
303	* @param handle Handle of the connection.
304	* @param pData Disconnect request information structure.
305	*
306	* @return VBox status code.
307	*/
308	DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
309
310	/**
311	* Call to a service.
312	*
313	* @param handle Handle of the connection.
314	* @param pData Call request information structure, including function parameters.
315	* @param cbData Length in bytes of data.
316	*
317	* @return VBox status code.
318	*/
319	DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
320
321	/**
322	* Call to a service with user-mode data received by the calling driver from the User-Mode process.
323	* The call must be done in the context of a calling process.
324	*
325	* @param handle Handle of the connection.
326	* @param pData Call request information structure, including function parameters.
327	* @param cbData Length in bytes of data.
328	*
329	* @return VBox status code.
330	*/
331	DECLVBGL(int) VbglHGCMCallUserData (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
332
333	/**
334	* Call to a service with timeout.
335	*
336	* @param handle Handle of the connection.
337	* @param pData Call request information structure, including function parameters.
338	* @param cbData Length in bytes of data.
339	* @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
340	*
341	* @return VBox status code.
342	*/
343	DECLVBGL(int) VbglHGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
344	/** @} */
345
346	/** @name Undocumented helpers for talking to the Chromium OpenGL Host Service
347	* @{ */
348	typedef VBGLHGCMHANDLE VBGLCRCTLHANDLE;
349	DECLVBGL(int) VbglR0CrCtlCreate(VBGLCRCTLHANDLE *phCtl);
350	DECLVBGL(int) VbglR0CrCtlDestroy(VBGLCRCTLHANDLE hCtl);
351	DECLVBGL(int) VbglR0CrCtlConConnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID *pidClient);
352	DECLVBGL(int) VbglR0CrCtlConDisconnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID idClient);
353	DECLVBGL(int) VbglR0CrCtlConCall(VBGLCRCTLHANDLE hCtl, struct VBoxGuestHGCMCallInfo *pCallInfo, int cbCallInfo);
354	DECLVBGL(int) VbglR0CrCtlConCallUserData(VBGLCRCTLHANDLE hCtl, struct VBoxGuestHGCMCallInfo *pCallInfo, int cbCallInfo);
355	/** @} */
356
357	# endif /* !VBGL_VBOXGUEST */
358
359	# endif /* VBOX_WITH_HGCM */
360
361
362	/**
363	* Initialize the heap.
364	*
365	* @returns VBox status code.
366	*/
367	DECLVBGL(int) VbglPhysHeapInit (void);
368
369	/**
370	* Shutdown the heap.
371	*/
372	DECLVBGL(void) VbglPhysHeapTerminate (void);
373
374	/**
375	* Allocate a memory block.
376	*
377	* @returns Virtual address of the allocated memory block.
378	* @param cbSize Size of block to be allocated.
379	*/
380	DECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
381
382	/**
383	* Get physical address of memory block pointed by the virtual address.
384	*
385	* @note WARNING!
386	* The function does not acquire the Heap mutex!
387	* When calling the function make sure that the pointer is a valid one and
388	* is not being deallocated. This function can NOT be used for verifying
389	* if the given pointer is a valid one allocated from the heap.
390	*
391	* @param pv Virtual address of memory block.
392	* @returns Physical address of the memory block.
393	*/
394	DECLVBGL(uint32_t) VbglPhysHeapGetPhysAddr(void *pv);
395
396	/**
397	* Free a memory block.
398	*
399	* @param pv Virtual address of memory block.
400	*/
401	DECLVBGL(void) VbglPhysHeapFree(void *pv);
402
403	DECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
404	DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
405
406	# ifndef VBOX_GUEST
407	/** @name Mouse
408	* @{ */
409	DECLVBGL(int) VbglSetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
410	DECLVBGL(int) VbglGetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
411	DECLVBGL(int) VbglSetMouseStatus(uint32_t fFeatures);
412	/** @} */
413	# endif /* VBOX_GUEST */
414
415	#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
416
417	/** @} */
418
419
420	/** @defgroup grp_vboxguest_lib_r3 Ring-3 interface.
421	* @{
422	*/
423	#ifdef IN_RING3
424
425	/** @def VBGLR3DECL
426	* Ring 3 VBGL declaration.
427	* @param type The return type of the function declaration.
428	*/
429	# define VBGLR3DECL(type) DECLHIDDEN(type) VBOXCALL
430
431	/** @name General-purpose functions
432	* @{ */
433	VBGLR3DECL(int) VbglR3Init(void);
434	VBGLR3DECL(int) VbglR3InitUser(void);
435	VBGLR3DECL(void) VbglR3Term(void);
436	# ifdef ___iprt_time_h
437	VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
438	# endif
439	VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
440	VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
441	VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
442	VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose, bool fRespawn, unsigned *pcRespawn);
443	VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
444	VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
445	VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
446	VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
447
448	VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
449	uint32_t fFlags);
450	VBGLR3DECL(int) VbglR3GetAdditionsVersion(char ppszVer, char ppszVerEx, char **ppszRev);
451	VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
452	VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
453
454	/** @} */
455
456	/** @name Shared clipboard
457	* @{ */
458	VBGLR3DECL(int) VbglR3ClipboardConnect(HGCMCLIENTID *pidClient);
459	VBGLR3DECL(int) VbglR3ClipboardDisconnect(HGCMCLIENTID idClient);
460	VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(HGCMCLIENTID idClient, uint32_t pMsg, uint32_t pfFormats);
461	VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void pv, uint32_t cb, uint32_t pcb);
462	VBGLR3DECL(int) VbglR3ClipboardReportFormats(HGCMCLIENTID idClient, uint32_t fFormats);
463	VBGLR3DECL(int) VbglR3ClipboardWriteData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb);
464	/** @} */
465
466	/** @name Seamless mode
467	* @{ */
468	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
469	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
470	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
471	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
472
473	/** @} */
474
475	/** @name Mouse
476	* @{ */
477	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
478	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
479	/** @} */
480
481	/** @name Video
482	* @{ */
483	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
484	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
485	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
486	const void *pvImg, size_t cbImg);
487	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
488	/** @} */
489
490	/** @name Display
491	* @{ */
492	/** The folder for the video mode hint unix domain socket on Unix-like guests.
493	* @note This can be safely changed as all users are rebuilt in lock-step. */
494	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
495	/** The path to the video mode hint unix domain socket on Unix-like guests. */
496	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
497
498	/** The folder for saving video mode hints to between sessions. */
499	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
500	/** The path to the file for saving video mode hints to between sessions. */
501	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
502
503	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
504	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
505	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
506	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
507	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
508	unsigned x, unsigned y, bool fEnabled);
509	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
510	unsigned px, unsigned py, bool *pfEnabled);
511	/** @} */
512
513	/** @name VM Statistics
514	* @{ */
515	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
516	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
517	/** @} */
518
519	/** @name Memory ballooning
520	* @{ */
521	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
522	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
523	/** @} */
524
525	/** @name Core Dump
526	* @{ */
527	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
528
529	/** @} */
530
531	# ifdef VBOX_WITH_GUEST_PROPS
532	/** @name Guest properties
533	* @{ */
534	/** @todo Docs. */
535	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
536	/** @todo Docs. */
537	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
538	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
539	VBGLR3DECL(int) VbglR3GuestPropDisconnect(HGCMCLIENTID idClient);
540	VBGLR3DECL(int) VbglR3GuestPropWrite(HGCMCLIENTID idClient, const char pszName, const char pszValue, const char *pszFlags);
541	VBGLR3DECL(int) VbglR3GuestPropWriteValue(HGCMCLIENTID idClient, const char pszName, const char pszValue);
542	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(HGCMCLIENTID idClient, const char *pszName,
543	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
544	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(HGCMCLIENTID idClient, const char *pszName,
545	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
546	VBGLR3DECL(int) VbglR3GuestPropRead(HGCMCLIENTID idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
547	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
548	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
549	uint32_t *pcchValueActual);
550	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(HGCMCLIENTID idClient, const char pszName, char *ppszValue);
551	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
552	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(HGCMCLIENTID idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
553	uint32_t *pcbBufActual);
554	VBGLR3DECL(int) VbglR3GuestPropEnum(HGCMCLIENTID idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
555	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
556	uint64_t pu64Timestamp, char const *ppszFlags);
557	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
558	uint64_t pu64Timestamp, char const *ppszFlags);
559	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
560	VBGLR3DECL(int) VbglR3GuestPropDelete(HGCMCLIENTID idClient, const char *pszName);
561	VBGLR3DECL(int) VbglR3GuestPropDelSet(HGCMCLIENTID idClient, char const * const *papszPatterns, uint32_t cPatterns);
562	VBGLR3DECL(int) VbglR3GuestPropWait(HGCMCLIENTID idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
563	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
564	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
565	/** @} */
566
567	/** @name Guest user handling / reporting.
568	* @{ */
569	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
570	uint8_t *pbDetails, uint32_t cbDetails);
571	/** @} */
572
573	/** @name Host version handling
574	* @{ */
575	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(HGCMCLIENTID idClient, bool pfUpdate, char *ppszHostVersion,
576	char **ppszGuestVersion);
577	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(HGCMCLIENTID idClient, char **ppszVer);
578	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(HGCMCLIENTID idClient, const char *pszVer);
579	/** @} */
580	# endif /* VBOX_WITH_GUEST_PROPS defined */
581
582	# ifdef VBOX_WITH_SHARED_FOLDERS
583	/** @name Shared folders
584	* @{ */
585	/**
586	* Structure containing mapping information for a shared folder.
587	*/
588	typedef struct VBGLR3SHAREDFOLDERMAPPING
589	{
590	/** Mapping status. */
591	uint32_t u32Status;
592	/** Root handle. */
593	uint32_t u32Root;
594	} VBGLR3SHAREDFOLDERMAPPING;
595	/** Pointer to a shared folder mapping information structure. */
596	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
597	/** Pointer to a const shared folder mapping information structure. */
598	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
599
600	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
601	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient);
602	VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName);
603	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
604	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
605	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
606	VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient,uint32_t u32Root, char **ppszName);
607	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char **ppszPrefix);
608	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char **ppszDir);
609	/** @} */
610	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
611
612	# ifdef VBOX_WITH_GUEST_CONTROL
613	/** @name Guest control
614	* @{ */
615
616	/**
617	* Structure containing the context required for
618	* either retrieving or sending a HGCM guest control
619	* commands from or to the host.
620	*
621	* Note: Do not change parameter order without also
622	* adapting all structure initializers.
623	*/
624	typedef struct VBGLR3GUESTCTRLCMDCTX
625	{
626	/** @todo This struct could be handy if we want to implement
627	* a second communication channel, e.g. via TCP/IP.
628	* Use a union for the HGCM stuff then. */
629
630	/** IN: HGCM client ID to use for
631	* communication. */
632	uint32_t uClientID;
633	/** IN/OUT: Context ID to retrieve
634	* or to use. */
635	uint32_t uContextID;
636	/** IN: Protocol version to use. */
637	uint32_t uProtocol;
638	/** OUT: Number of parameters retrieved. */
639	uint32_t uNumParms;
640	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
641
642	/* General message handling on the guest. */
643	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
644	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t uClientId);
645	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
646	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterUnset(uint32_t uClientId);
647	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
648	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
649	void *pvPayload, uint32_t cbPayload);
650	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t uClientId);
651	VBGLR3DECL(int) VbglR3GuestCtrlMsgWaitFor(uint32_t uClientId, uint32_t puMsg, uint32_t puNumParms);
652	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
653	/* Guest session handling. */
654	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
655	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, uint32_t uResult);
656	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puProtocol, char pszUser, uint32_t cbUser,
657	char pszPassword, uint32_t cbPassword, char pszDomain, uint32_t cbDomain,
658	uint32_t pfFlags, uint32_t pidSession);
659	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t pidSession);
660	/* Guest path handling. */
661	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
662	uint32_t cbDest, uint32_t *pfFlags);
663	/* Guest process execution. */
664	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszCmd, uint32_t cbCmd, uint32_t pfFlags,
665	char pszArgs, uint32_t cbArgs, uint32_t puNumArgs, char pszEnv, uint32_t pcbEnv,
666	uint32_t puNumEnvVars, char pszUser, uint32_t cbUser, char *pszPassword,
667	uint32_t cbPassword, uint32_t puTimeoutMS, uint32_t puPriority,
668	uint64_t puAffinity, uint32_t cbAffinity, uint32_t pcAffinity);
669	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
670	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
671	uint32_t cbData, uint32_t *pcbSize);
672	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
673	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
674	uint32_t *puTimeoutMS);
675	/* Guest native directory handling. */
676	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
677	/* Guest native file handling. */
678	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
679	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
680	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
681	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
682	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
683	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
684	uint32_t puToRead, uint64_t poffRead);
685	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
686	void pvData, uint32_t cbData, uint32_t pcbActual);
687	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
688	uint32_t pcbActual, uint64_t poffWrite);
689	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
690	uint32_t puSeekMethod, uint64_t poffSeek);
691	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
692	/* Guest -> Host. */
693	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
694	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
695	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
696	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
697	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uWritten);
698	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
699	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
700	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
701	void *pvData, uint32_t cbData);
702	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
703	void *pvData, uint32_t cbData);
704	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
705	uint32_t fFlags, uint32_t cbWritten);
706
707	/** @} */
708	# endif /* VBOX_WITH_GUEST_CONTROL defined */
709
710	/** @name Auto-logon handling
711	* @{ */
712	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
713	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
714	/** @} */
715
716	/** @name User credentials handling
717	* @{ */
718	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
719	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
720	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
721	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
722	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
723	uint32_t cPasses);
724	/** @} */
725
726	/** @name CPU hotplug monitor
727	* @{ */
728	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
729	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
730	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
731	/** @} */
732
733	/** @name Page sharing
734	* @{ */
735	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
736	unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
737	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
738	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
739	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
740	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
741	/** @} */
742
743	# ifdef VBOX_WITH_DRAG_AND_DROP
744	/** @name Drag and Drop
745	* @{ */
746	/**
747	* Structure containing the context required for
748	* either retrieving or sending a HGCM guest drag'n drop
749	* commands from or to the host.
750	*
751	* Note: Do not change parameter order without also
752	* adapting all structure initializers.
753	*/
754	typedef struct VBGLR3GUESTDNDCMDCTX
755	{
756	/** @todo This struct could be handy if we want to implement
757	* a second communication channel, e.g. via TCP/IP.
758	* Use a union for the HGCM stuff then. */
759
760	/** HGCM client ID to use for communication. */
761	uint32_t uClientID;
762	/** The VM's current session ID. */
763	uint64_t uSessionID;
764	/** Protocol version to use. */
765	uint32_t uProtocol;
766	/** Number of parameters retrieved for the current command. */
767	uint32_t uNumParms;
768	/** Max chunk size (in bytes) for data transfers. */
769	uint32_t cbMaxChunkSize;
770	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
771
772	typedef struct VBGLR3DNDHGCMEVENT
773	{
774	uint32_t uType; /** The event type this struct contains. */
775	uint32_t uScreenId; /** Screen ID this request belongs to. */
776	char pszFormats; /* Format list (\r\n separated). */
777	uint32_t cbFormats; /** Size (in bytes) of pszFormats (\0 included). */
778	union
779	{
780	struct
781	{
782	uint32_t uXpos; /** X position of guest screen. */
783	uint32_t uYpos; /** Y position of guest screen. */
784	uint32_t uDefAction; /** Proposed DnD action. */
785	uint32_t uAllActions; /** Allowed DnD actions. */
786	} a; /** Values used in init, move and drop event type. */
787	struct
788	{
789	void pvData; /* Data request. */
790	uint32_t cbData; /** Size (in bytes) of pvData. */
791	} b; /** Values used in drop data event type. */
792	} u;
793	} VBGLR3DNDHGCMEVENT;
794	typedef VBGLR3DNDHGCMEVENT *PVBGLR3DNDHGCMEVENT;
795	typedef const PVBGLR3DNDHGCMEVENT CPVBGLR3DNDHGCMEVENT;
796	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
797	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
798
799	VBGLR3DECL(int) VbglR3DnDRecvNextMsg(PVBGLR3GUESTDNDCMDCTX pCtx, CPVBGLR3DNDHGCMEVENT pEvent);
800
801	VBGLR3DECL(int) VbglR3DnDHGSendAckOp(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uAction);
802	VBGLR3DECL(int) VbglR3DnDHGSendReqData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pcszFormat);
803	VBGLR3DECL(int) VbglR3DnDHGSendProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
804	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
805	VBGLR3DECL(int) VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uDefAction, uint32_t uAllActions, const char* pcszFormats, uint32_t cbFormats);
806	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
807	VBGLR3DECL(int) VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
808	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
809	/** @} */
810	# endif /* VBOX_WITH_DRAG_AND_DROP */
811
812	/* Generic Host Channel Service. */
813	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pu32HGCMClientId);
814	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t u32HGCMClientId);
815	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
816	const char *pszName, uint32_t u32Flags);
817	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
818	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
819	void *pvData, uint32_t cbData);
820	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
821	void *pvData, uint32_t cbData,
822	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
823	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
824	uint32_t u32Code, void *pvParm, uint32_t cbParm,
825	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
826	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
827	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
828	uint32_t *pu32SizeReturned);
829	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
830	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
831	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
832	uint32_t *pu32SizeDataReturned);
833
834	/** @name Mode hint storage
835	* @{ */
836	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
837	unsigned cy, unsigned cBPP, unsigned *x,
838	unsigned y, unsigned fEnabled);
839	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
840	unsigned cy, unsigned cBPP, unsigned x,
841	unsigned y, unsigned fEnabled);
842	/** @} */
843
844	/** @name Generic HGCM
845	* @{ */
846	VBGLR3DECL(int) VbglR3HGCMConnect(const char pszServiceName, HGCMCLIENTID pidClient);
847	VBGLR3DECL(int) VbglR3HGCMDisconnect(HGCMCLIENTID idClient);
848	/** @} */
849
850	#endif /* IN_RING3 */
851	/** @} */
852
853	RT_C_DECLS_END
854
855	/** @} */
856
857	#endif
858

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/VBoxGuestLib.h@ 62476

Download in other formats: