VBoxGuestLib.h@ 68436

Last change on this file since 68436 was 68436, checked in by vboxsync, 8 years ago
VBoxGuestLib/R3: Added VbglR3VrdpGetChangeRequest; build everything on windows; use size_t for vbglR3GRAlloc.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 38.6 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	* Initializes HGCM in the R0 guest library. Must be called before any HGCM
291	* connections are made. Is called by VbglInitClient().
292	*
293	* @return VBox status code.
294	*/
295	DECLVBGL(int) VbglR0HGCMInit(void);
296
297	/**
298	* Terminates HGCM in the R0 guest library. Is called by VbglTerminate().
299	*
300	* @return VBox status code.
301	*/
302	DECLVBGL(int) VbglR0HGCMTerminate(void);
303
304	/**
305	* Connect to a service.
306	*
307	* @param pHandle Pointer to variable that will hold a handle to be used
308	* further in VbglHGCMCall and VbglHGCMClose.
309	* @param pData Connection information structure.
310	*
311	* @return VBox status code.
312	*/
313	DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE pHandle, VBoxGuestHGCMConnectInfo pData);
314
315	/**
316	* Connect to a service.
317	*
318	* @param handle Handle of the connection.
319	* @param pData Disconnect request information structure.
320	*
321	* @return VBox status code.
322	*/
323	DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
324
325	/**
326	* Call to a service.
327	*
328	* @param handle Handle of the connection.
329	* @param pData Call request information structure, including function parameters.
330	* @param cbData Length in bytes of data.
331	*
332	* @return VBox status code.
333	*/
334	DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
335
336	/**
337	* Call to a service with user-mode data received by the calling driver from the User-Mode process.
338	* The call must be done in the context of a calling process.
339	*
340	* @param handle Handle of the connection.
341	* @param pData Call request information structure, including function parameters.
342	* @param cbData Length in bytes of data.
343	*
344	* @return VBox status code.
345	*/
346	DECLVBGL(int) VbglHGCMCallUserData (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
347
348	/**
349	* Call to a service with timeout.
350	*
351	* @param handle Handle of the connection.
352	* @param pData Call request information structure, including function parameters.
353	* @param cbData Length in bytes of data.
354	* @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
355	*
356	* @return VBox status code.
357	*/
358	DECLVBGL(int) VbglHGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
359	/** @} */
360
361	/** @name Undocumented helpers for talking to the Chromium OpenGL Host Service
362	* @{ */
363	typedef VBGLHGCMHANDLE VBGLCRCTLHANDLE;
364	DECLVBGL(int) VbglR0CrCtlCreate(VBGLCRCTLHANDLE *phCtl);
365	DECLVBGL(int) VbglR0CrCtlDestroy(VBGLCRCTLHANDLE hCtl);
366	DECLVBGL(int) VbglR0CrCtlConConnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID *pidClient);
367	DECLVBGL(int) VbglR0CrCtlConDisconnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID idClient);
368	DECLVBGL(int) VbglR0CrCtlConCall(VBGLCRCTLHANDLE hCtl, struct VBoxGuestHGCMCallInfo *pCallInfo, int cbCallInfo);
369	DECLVBGL(int) VbglR0CrCtlConCallUserData(VBGLCRCTLHANDLE hCtl, struct VBoxGuestHGCMCallInfo *pCallInfo, int cbCallInfo);
370	/** @} */
371
372	# endif /* !VBGL_VBOXGUEST */
373
374	# endif /* VBOX_WITH_HGCM */
375
376
377	/**
378	* Initialize the heap.
379	*
380	* @returns VBox status code.
381	*/
382	DECLVBGL(int) VbglPhysHeapInit (void);
383
384	/**
385	* Shutdown the heap.
386	*/
387	DECLVBGL(void) VbglPhysHeapTerminate (void);
388
389	/**
390	* Allocate a memory block.
391	*
392	* @returns Virtual address of the allocated memory block.
393	* @param cbSize Size of block to be allocated.
394	*/
395	DECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
396
397	/**
398	* Get physical address of memory block pointed by the virtual address.
399	*
400	* @note WARNING!
401	* The function does not acquire the Heap mutex!
402	* When calling the function make sure that the pointer is a valid one and
403	* is not being deallocated. This function can NOT be used for verifying
404	* if the given pointer is a valid one allocated from the heap.
405	*
406	* @param pv Virtual address of memory block.
407	* @returns Physical address of the memory block.
408	*/
409	DECLVBGL(uint32_t) VbglPhysHeapGetPhysAddr(void *pv);
410
411	/**
412	* Free a memory block.
413	*
414	* @param pv Virtual address of memory block.
415	*/
416	DECLVBGL(void) VbglPhysHeapFree(void *pv);
417
418	DECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
419	DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
420
421	# ifndef VBOX_GUEST
422	/** @name Mouse
423	* @{ */
424	DECLVBGL(int) VbglSetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
425	DECLVBGL(int) VbglGetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
426	DECLVBGL(int) VbglSetMouseStatus(uint32_t fFeatures);
427	/** @} */
428	# endif /* VBOX_GUEST */
429
430	#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
431
432	/** @} */
433
434
435	/** @defgroup grp_vboxguest_lib_r3 Ring-3 interface.
436	* @{
437	*/
438	#ifdef IN_RING3
439
440	/** @def VBGLR3DECL
441	* Ring 3 VBGL declaration.
442	* @param type The return type of the function declaration.
443	*/
444	# define VBGLR3DECL(type) DECLHIDDEN(type) VBOXCALL
445
446	/** @name General-purpose functions
447	* @{ */
448	VBGLR3DECL(int) VbglR3Init(void);
449	VBGLR3DECL(int) VbglR3InitUser(void);
450	VBGLR3DECL(void) VbglR3Term(void);
451	# ifdef ___iprt_time_h
452	VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
453	# endif
454	VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
455	VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
456	VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
457	VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose, bool fRespawn, unsigned *pcRespawn);
458	VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
459	VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
460	VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
461	VBGLR3DECL(int) VbglR3AcquireGuestCaps(uint32_t fOr, uint32_t fNot, bool fConfig);
462	VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
463
464	VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
465	uint32_t fFlags);
466	VBGLR3DECL(int) VbglR3GetAdditionsVersion(char ppszVer, char ppszVerEx, char **ppszRev);
467	VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
468	VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
469
470	/** @} */
471
472	/** @name Shared clipboard
473	* @{ */
474	VBGLR3DECL(int) VbglR3ClipboardConnect(HGCMCLIENTID *pidClient);
475	VBGLR3DECL(int) VbglR3ClipboardDisconnect(HGCMCLIENTID idClient);
476	VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(HGCMCLIENTID idClient, uint32_t pMsg, uint32_t pfFormats);
477	VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void pv, uint32_t cb, uint32_t pcb);
478	VBGLR3DECL(int) VbglR3ClipboardReportFormats(HGCMCLIENTID idClient, uint32_t fFormats);
479	VBGLR3DECL(int) VbglR3ClipboardWriteData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb);
480	/** @} */
481
482	/** @name Seamless mode
483	* @{ */
484	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
485	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
486	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
487	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
488
489	/** @} */
490
491	/** @name Mouse
492	* @{ */
493	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
494	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
495	/** @} */
496
497	/** @name Video
498	* @{ */
499	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
500	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
501	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
502	const void *pvImg, size_t cbImg);
503	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
504	/** @} */
505
506	/** @name Display
507	* @{ */
508	/** The folder for the video mode hint unix domain socket on Unix-like guests.
509	* @note This can be safely changed as all users are rebuilt in lock-step. */
510	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
511	/** The path to the video mode hint unix domain socket on Unix-like guests. */
512	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
513
514	/** The folder for saving video mode hints to between sessions. */
515	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
516	/** The path to the file for saving video mode hints to between sessions. */
517	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
518
519	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
520	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
521	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
522	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
523	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
524	unsigned x, unsigned y, bool fEnabled);
525	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
526	unsigned px, unsigned py, bool *pfEnabled);
527	/** @} */
528
529	/** @name VRDP
530	* @{ */
531	VBGLR3DECL(int) VbglR3VrdpGetChangeRequest(bool pfActive, uint32_t puExperienceLevel);
532	/** @} */
533
534	/** @name VM Statistics
535	* @{ */
536	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
537	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
538	/** @} */
539
540	/** @name Memory ballooning
541	* @{ */
542	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
543	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
544	/** @} */
545
546	/** @name Core Dump
547	* @{ */
548	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
549
550	/** @} */
551
552	# ifdef VBOX_WITH_GUEST_PROPS
553	/** @name Guest properties
554	* @{ */
555	/** @todo Docs. */
556	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
557	/** @todo Docs. */
558	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
559	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
560	VBGLR3DECL(int) VbglR3GuestPropDisconnect(HGCMCLIENTID idClient);
561	VBGLR3DECL(int) VbglR3GuestPropWrite(HGCMCLIENTID idClient, const char pszName, const char pszValue, const char *pszFlags);
562	VBGLR3DECL(int) VbglR3GuestPropWriteValue(HGCMCLIENTID idClient, const char pszName, const char pszValue);
563	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(HGCMCLIENTID idClient, const char *pszName,
564	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
565	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(HGCMCLIENTID idClient, const char *pszName,
566	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
567	VBGLR3DECL(int) VbglR3GuestPropRead(HGCMCLIENTID idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
568	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
569	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
570	uint32_t *pcchValueActual);
571	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(HGCMCLIENTID idClient, const char pszName, char *ppszValue);
572	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
573	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(HGCMCLIENTID idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
574	uint32_t *pcbBufActual);
575	VBGLR3DECL(int) VbglR3GuestPropEnum(HGCMCLIENTID idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
576	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
577	uint64_t pu64Timestamp, char const *ppszFlags);
578	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
579	uint64_t pu64Timestamp, char const *ppszFlags);
580	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
581	VBGLR3DECL(int) VbglR3GuestPropDelete(HGCMCLIENTID idClient, const char *pszName);
582	VBGLR3DECL(int) VbglR3GuestPropDelSet(HGCMCLIENTID idClient, char const * const *papszPatterns, uint32_t cPatterns);
583	VBGLR3DECL(int) VbglR3GuestPropWait(HGCMCLIENTID idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
584	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
585	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
586	/** @} */
587
588	/** @name Guest user handling / reporting.
589	* @{ */
590	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
591	uint8_t *pbDetails, uint32_t cbDetails);
592	/** @} */
593
594	/** @name Host version handling
595	* @{ */
596	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(HGCMCLIENTID idClient, bool pfUpdate, char *ppszHostVersion,
597	char **ppszGuestVersion);
598	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(HGCMCLIENTID idClient, char **ppszVer);
599	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(HGCMCLIENTID idClient, const char *pszVer);
600	/** @} */
601	# endif /* VBOX_WITH_GUEST_PROPS defined */
602
603	# ifdef VBOX_WITH_SHARED_FOLDERS
604	/** @name Shared folders
605	* @{ */
606	/**
607	* Structure containing mapping information for a shared folder.
608	*/
609	typedef struct VBGLR3SHAREDFOLDERMAPPING
610	{
611	/** Mapping status. */
612	uint32_t u32Status;
613	/** Root handle. */
614	uint32_t u32Root;
615	} VBGLR3SHAREDFOLDERMAPPING;
616	/** Pointer to a shared folder mapping information structure. */
617	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
618	/** Pointer to a const shared folder mapping information structure. */
619	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
620
621	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
622	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient);
623	VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName);
624	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
625	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
626	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
627	VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient,uint32_t u32Root, char **ppszName);
628	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char **ppszPrefix);
629	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char **ppszDir);
630	/** @} */
631	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
632
633	# ifdef VBOX_WITH_GUEST_CONTROL
634	/** @name Guest control
635	* @{ */
636
637	/**
638	* Structure containing the context required for
639	* either retrieving or sending a HGCM guest control
640	* commands from or to the host.
641	*
642	* Note: Do not change parameter order without also
643	* adapting all structure initializers.
644	*/
645	typedef struct VBGLR3GUESTCTRLCMDCTX
646	{
647	/** @todo This struct could be handy if we want to implement
648	* a second communication channel, e.g. via TCP/IP.
649	* Use a union for the HGCM stuff then. */
650
651	/** IN: HGCM client ID to use for
652	* communication. */
653	uint32_t uClientID;
654	/** IN/OUT: Context ID to retrieve
655	* or to use. */
656	uint32_t uContextID;
657	/** IN: Protocol version to use. */
658	uint32_t uProtocol;
659	/** OUT: Number of parameters retrieved. */
660	uint32_t uNumParms;
661	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
662
663	/* General message handling on the guest. */
664	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
665	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t uClientId);
666	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
667	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterUnset(uint32_t uClientId);
668	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
669	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
670	void *pvPayload, uint32_t cbPayload);
671	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t uClientId);
672	VBGLR3DECL(int) VbglR3GuestCtrlMsgWaitFor(uint32_t uClientId, uint32_t puMsg, uint32_t puNumParms);
673	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
674	/* Guest session handling. */
675	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
676	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, uint32_t uResult);
677	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puProtocol, char pszUser, uint32_t cbUser,
678	char pszPassword, uint32_t cbPassword, char pszDomain, uint32_t cbDomain,
679	uint32_t pfFlags, uint32_t pidSession);
680	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t pidSession);
681	/* Guest path handling. */
682	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
683	uint32_t cbDest, uint32_t *pfFlags);
684	/* Guest process execution. */
685	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszCmd, uint32_t cbCmd, uint32_t pfFlags,
686	char pszArgs, uint32_t cbArgs, uint32_t puNumArgs, char pszEnv, uint32_t pcbEnv,
687	uint32_t puNumEnvVars, char pszUser, uint32_t cbUser, char *pszPassword,
688	uint32_t cbPassword, uint32_t puTimeoutMS, uint32_t puPriority,
689	uint64_t puAffinity, uint32_t cbAffinity, uint32_t pcAffinity);
690	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
691	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
692	uint32_t cbData, uint32_t *pcbSize);
693	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
694	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
695	uint32_t *puTimeoutMS);
696	/* Guest native directory handling. */
697	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
698	/* Guest native file handling. */
699	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
700	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
701	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
702	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
703	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
704	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
705	uint32_t puToRead, uint64_t poffRead);
706	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
707	void pvData, uint32_t cbData, uint32_t pcbActual);
708	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
709	uint32_t pcbActual, uint64_t poffWrite);
710	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
711	uint32_t puSeekMethod, uint64_t poffSeek);
712	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
713	/* Guest -> Host. */
714	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
715	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
716	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
717	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
718	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uWritten);
719	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
720	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
721	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
722	void *pvData, uint32_t cbData);
723	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
724	void *pvData, uint32_t cbData);
725	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
726	uint32_t fFlags, uint32_t cbWritten);
727
728	/** @} */
729	# endif /* VBOX_WITH_GUEST_CONTROL defined */
730
731	/** @name Auto-logon handling
732	* @{ */
733	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
734	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
735	/** @} */
736
737	/** @name User credentials handling
738	* @{ */
739	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
740	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
741	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
742	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
743	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
744	uint32_t cPasses);
745	/** @} */
746
747	/** @name CPU hotplug monitor
748	* @{ */
749	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
750	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
751	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
752	/** @} */
753
754	/** @name Page sharing
755	* @{ */
756	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
757	unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
758	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
759	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
760	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
761	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
762	/** @} */
763
764	# ifdef VBOX_WITH_DRAG_AND_DROP
765	/** @name Drag and Drop
766	* @{ */
767	/**
768	* Structure containing the context required for
769	* either retrieving or sending a HGCM guest drag'n drop
770	* commands from or to the host.
771	*
772	* Note: Do not change parameter order without also
773	* adapting all structure initializers.
774	*/
775	typedef struct VBGLR3GUESTDNDCMDCTX
776	{
777	/** @todo This struct could be handy if we want to implement
778	* a second communication channel, e.g. via TCP/IP.
779	* Use a union for the HGCM stuff then. */
780
781	/** HGCM client ID to use for communication. */
782	uint32_t uClientID;
783	/** The VM's current session ID. */
784	uint64_t uSessionID;
785	/** Protocol version to use. */
786	uint32_t uProtocol;
787	/** Number of parameters retrieved for the current command. */
788	uint32_t uNumParms;
789	/** Max chunk size (in bytes) for data transfers. */
790	uint32_t cbMaxChunkSize;
791	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
792
793	typedef struct VBGLR3DNDHGCMEVENT
794	{
795	uint32_t uType; /** The event type this struct contains. */
796	uint32_t uScreenId; /** Screen ID this request belongs to. */
797	char pszFormats; /* Format list (\r\n separated). */
798	uint32_t cbFormats; /** Size (in bytes) of pszFormats (\0 included). */
799	union
800	{
801	struct
802	{
803	uint32_t uXpos; /** X position of guest screen. */
804	uint32_t uYpos; /** Y position of guest screen. */
805	uint32_t uDefAction; /** Proposed DnD action. */
806	uint32_t uAllActions; /** Allowed DnD actions. */
807	} a; /** Values used in init, move and drop event type. */
808	struct
809	{
810	void pvData; /* Data request. */
811	uint32_t cbData; /** Size (in bytes) of pvData. */
812	} b; /** Values used in drop data event type. */
813	} u;
814	} VBGLR3DNDHGCMEVENT;
815	typedef VBGLR3DNDHGCMEVENT *PVBGLR3DNDHGCMEVENT;
816	typedef const PVBGLR3DNDHGCMEVENT CPVBGLR3DNDHGCMEVENT;
817	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
818	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
819
820	VBGLR3DECL(int) VbglR3DnDRecvNextMsg(PVBGLR3GUESTDNDCMDCTX pCtx, CPVBGLR3DNDHGCMEVENT pEvent);
821
822	VBGLR3DECL(int) VbglR3DnDHGSendAckOp(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uAction);
823	VBGLR3DECL(int) VbglR3DnDHGSendReqData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pcszFormat);
824	VBGLR3DECL(int) VbglR3DnDHGSendProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
825	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
826	VBGLR3DECL(int) VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uDefAction, uint32_t uAllActions, const char* pcszFormats, uint32_t cbFormats);
827	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
828	VBGLR3DECL(int) VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
829	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
830	/** @} */
831	# endif /* VBOX_WITH_DRAG_AND_DROP */
832
833	/* Generic Host Channel Service. */
834	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pu32HGCMClientId);
835	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t u32HGCMClientId);
836	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
837	const char *pszName, uint32_t u32Flags);
838	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
839	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
840	void *pvData, uint32_t cbData);
841	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
842	void *pvData, uint32_t cbData,
843	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
844	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
845	uint32_t u32Code, void *pvParm, uint32_t cbParm,
846	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
847	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
848	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
849	uint32_t *pu32SizeReturned);
850	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
851	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
852	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
853	uint32_t *pu32SizeDataReturned);
854
855	/** @name Mode hint storage
856	* @{ */
857	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
858	unsigned cy, unsigned cBPP, unsigned *x,
859	unsigned y, unsigned fEnabled);
860	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
861	unsigned cy, unsigned cBPP, unsigned x,
862	unsigned y, unsigned fEnabled);
863	/** @} */
864
865	/** @name Generic HGCM
866	* @{ */
867	VBGLR3DECL(int) VbglR3HGCMConnect(const char pszServiceName, HGCMCLIENTID pidClient);
868	VBGLR3DECL(int) VbglR3HGCMDisconnect(HGCMCLIENTID idClient);
869	/** @} */
870
871	#endif /* IN_RING3 */
872	/** @} */
873
874	RT_C_DECLS_END
875
876	/** @} */
877
878	#endif
879

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

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

Download in other formats: