VBoxGuestLib.h@ 91729

Last change on this file since 91729 was 87897, checked in by vboxsync, 4 years ago
VBoxGuestLib.h: Note: -> @note (learn to write doxygen comments already)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 61.2 KB

Line
1	/** @file
2	* VBoxGuestLib - VirtualBox Guest Additions Library.
3	*/
4
5	/*
6	* Copyright (C) 2006-2020 Oracle Corporation
7	*
8	* Permission is hereby granted, free of charge, to any person
9	* obtaining a copy of this software and associated documentation
10	* files (the "Software"), to deal in the Software without
11	* restriction, including without limitation the rights to use,
12	* copy, modify, merge, publish, distribute, sublicense, and/or sell
13	* copies of the Software, and to permit persons to whom the
14	* Software is furnished to do so, subject to the following
15	* conditions:
16	*
17	* The above copyright notice and this permission notice shall be
18	* included in all copies or substantial portions of the Software.
19	*
20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
22	* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
24	* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
25	* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27	* OTHER DEALINGS IN THE SOFTWARE.
28	*/
29
30	#ifndef VBOX_INCLUDED_VBoxGuestLib_h
31	#define VBOX_INCLUDED_VBoxGuestLib_h
32	#ifndef RT_WITHOUT_PRAGMA_ONCE
33	# pragma once
34	#endif
35
36	#include <VBox/types.h>
37	#include <VBox/VMMDev.h>
38	#include <VBox/VBoxGuestCoreTypes.h>
39	# ifdef VBOX_WITH_DRAG_AND_DROP
40	# include <VBox/GuestHost/DragAndDrop.h>
41	# include <VBox/GuestHost/DragAndDropDefs.h>
42	# endif
43	# ifdef VBOX_WITH_SHARED_CLIPBOARD
44	# include <VBox/GuestHost/SharedClipboard.h>
45	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
46	# include <VBox/GuestHost/SharedClipboard-transfers.h>
47	# endif
48	# endif /* VBOX_WITH_SHARED_CLIPBOARD */
49
50	/** @defgroup grp_vboxguest_lib VirtualBox Guest Additions Library
51	* @ingroup grp_vboxguest
52	* @{
53	*/
54
55	/** @page pg_guest_lib VirtualBox Guest Library
56	*
57	* This is a library for abstracting the additions driver interface. There are
58	* multiple versions of the library depending on the context. The main
59	* distinction is between kernel and user mode where the interfaces are very
60	* different.
61	*
62	*
63	* @section sec_guest_lib_ring0 Ring-0
64	*
65	* In ring-0 there are two version:
66	* - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
67	* who is responsible for managing the VMMDev virtual hardware.
68	* - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
69	*
70	*
71	* The library source code and the header have a define VBGL_VBOXGUEST, which is
72	* defined for VBoxGuest and undefined for other drivers. Drivers must choose
73	* right library in their makefiles and set VBGL_VBOXGUEST accordingly.
74	*
75	* The libraries consists of:
76	* - common code to be used by both VBoxGuest and other drivers;
77	* - VBoxGuest specific code;
78	* - code for other drivers which communicate with VBoxGuest via an IOCTL.
79	*
80	*
81	* @section sec_guest_lib_ring3 Ring-3
82	*
83	* There are more variants of the library here:
84	* - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
85	* - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
86	* drivers which uses special loader and or symbol resolving strategy.
87	* - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
88	* Dylibs.
89	*
90	*/
91
92	RT_C_DECLS_BEGIN
93
94	/** HGCM client ID.
95	* @todo Promote to VBox/types.h */
96	typedef uint32_t HGCMCLIENTID;
97
98
99	/** @defgroup grp_vboxguest_lib_r0 Ring-0 interface.
100	* @{
101	*/
102	#ifdef IN_RING0
103	/** @def DECLR0VBGL
104	* Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
105	* @param type Return type. */
106	# ifdef RT_OS_DARWIN /** @todo probably apply to all, but don't want a forest fire on our hands right now. */
107	# define DECLR0VBGL(type) DECLHIDDEN(DECL_NOTHROW(type)) VBOXCALL
108	# else
109	# define DECLR0VBGL(type) DECL_NOTHROW(type) VBOXCALL
110	# endif
111	# define DECLVBGL(type) DECLR0VBGL(type)
112
113
114	/**
115	* The library initialization function to be used by the main VBoxGuest driver.
116	*
117	* @return VBox status code.
118	*/
119	DECLR0VBGL(int) VbglR0InitPrimary(RTIOPORT portVMMDev, VMMDevMemory pVMMDevMemory, uint32_t pfFeatures);
120
121	/**
122	* The library termination function to be used by the main VBoxGuest driver.
123	*
124	* @author bird (2017-08-23)
125	*/
126	DECLR0VBGL(void) VbglR0TerminatePrimary(void);
127
128	/**
129	* The library initialization function to be used by all drivers
130	* other than the main VBoxGuest system driver.
131	*
132	* @return VBox status code.
133	*/
134	DECLR0VBGL(int) VbglR0InitClient(void);
135
136	/**
137	* The library termination function.
138	*/
139	DECLR0VBGL(void) VbglR0TerminateClient(void);
140
141	/**
142	* Query the host feature mask.
143	*
144	* @returns VBox status code.
145	* @param pfHostFeatures Where to return the host feature mask,
146	* VMMDEV_HVF_XXX.
147	* @note Client only. May fail we're unable to connect VBoxGuest.
148	*/
149	DECLR0VBGL(int) VbglR0QueryHostFeatures(uint32_t *pfHostFeatures);
150
151
152	/** @name The IDC Client Interface
153	* @{
154	*/
155
156	/**
157	* Inter-Driver Communication Handle.
158	*/
159	typedef union VBGLIDCHANDLE
160	{
161	/** Padding for opaque usage.
162	* Must be greater or equal in size than the private struct. */
163	void *apvPadding[4];
164	#ifdef VBGLIDCHANDLEPRIVATE_DECLARED
165	/** The private view. */
166	struct VBGLIDCHANDLEPRIVATE s;
167	#endif
168	} VBGLIDCHANDLE;
169	/** Pointer to a handle. */
170	typedef VBGLIDCHANDLE *PVBGLIDCHANDLE;
171
172	DECLR0VBGL(int) VbglR0IdcOpen(PVBGLIDCHANDLE pHandle, uint32_t uReqVersion, uint32_t uMinVersion,
173	uint32_t puSessionVersion, uint32_t puDriverVersion, uint32_t *puDriverRevision);
174	struct VBGLREQHDR;
175	DECLR0VBGL(int) VbglR0IdcCallRaw(PVBGLIDCHANDLE pHandle, uintptr_t uReq, struct VBGLREQHDR *pReqHdr, uint32_t cbReq);
176	DECLR0VBGL(int) VbglR0IdcCall(PVBGLIDCHANDLE pHandle, uintptr_t uReq, struct VBGLREQHDR *pReqHdr, uint32_t cbReq);
177	DECLR0VBGL(int) VbglR0IdcClose(PVBGLIDCHANDLE pHandle);
178
179	/** @} */
180
181
182	/** @name Generic request functions.
183	* @{
184	*/
185
186	/**
187	* Allocate memory for generic request and initialize the request header.
188	*
189	* @returns VBox status code.
190	* @param ppReq Where to return the pointer to the allocated memory.
191	* @param cbReq Size of memory block required for the request.
192	* @param enmReqType the generic request type.
193	*/
194	# if defined(VBOX_INCLUDED_VMMDev_h) \|\| defined(DOXYGEN_RUNNING)
195	DECLR0VBGL(int) VbglR0GRAlloc(struct VMMDevRequestHeader **ppReq, size_t cbReq, VMMDevRequestType enmReqType);
196	# else
197	DECLR0VBGL(int) VbglR0GRAlloc(struct VMMDevRequestHeader **ppReq, size_t cbReq, int32_t enmReqType);
198	# endif
199
200	/**
201	* Perform the generic request.
202	*
203	* @param pReq pointer the request structure.
204	*
205	* @return VBox status code.
206	*/
207	DECLR0VBGL(int) VbglR0GRPerform(struct VMMDevRequestHeader *pReq);
208
209	/**
210	* Free the generic request memory.
211	*
212	* @param pReq pointer the request structure.
213	*
214	* @return VBox status code.
215	*/
216	DECLR0VBGL(void) VbglR0GRFree(struct VMMDevRequestHeader *pReq);
217
218	/**
219	* Verify the generic request header.
220	*
221	* @param pReq pointer the request header structure.
222	* @param cbReq size of the request memory block. It should be equal to the request size
223	* for fixed size requests. It can be greater than the request size for
224	* variable size requests.
225	*
226	* @return VBox status code.
227	*/
228	DECLR0VBGL(int) VbglGR0Verify(const struct VMMDevRequestHeader *pReq, size_t cbReq);
229
230	/** @} */
231
232	# ifdef VBOX_WITH_HGCM
233	struct VBGLIOCHGCMCALL;
234	struct VBGLIOCIDCHGCMFASTCALL;
235
236	# ifdef VBGL_VBOXGUEST
237
238	/**
239	* Callback function called from HGCM helpers when a wait for request
240	* completion IRQ is required.
241	*
242	* @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
243	* @param pvData VBoxGuest pointer to be passed to callback.
244	* @param u32Data VBoxGuest 32 bit value to be passed to callback.
245	*/
246	typedef DECLCALLBACKTYPE(int, FNVBGLHGCMCALLBACK,(VMMDevHGCMRequestHeader pHeader, void pvData, uint32_t u32Data));
247	/** Pointer to a FNVBGLHGCMCALLBACK. */
248	typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
249
250	/**
251	* Perform a connect request.
252	*
253	* That is locate required service and obtain a client identifier for future
254	* access.
255	*
256	* @note This function can NOT handle cancelled requests!
257	*
258	* @param pLoc The service to connect to.
259	* @param fRequestor VMMDEV_REQUESTOR_XXX.
260	* @param pidClient Where to return the client ID on success.
261	* @param pfnAsyncCallback Required pointer to function that is calledwhen
262	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
263	* implements waiting for an IRQ in this function.
264	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
265	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
266	*
267	* @return VBox status code.
268	*/
269	DECLR0VBGL(int) VbglR0HGCMInternalConnect(HGCMServiceLocation const pLoc, uint32_t fRequestor, HGCMCLIENTID pidClient,
270	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
271
272
273	/**
274	* Perform a disconnect request.
275	*
276	* That is tell the host that the client will not call the service anymore.
277	*
278	* @note This function can NOT handle cancelled requests!
279	*
280	* @param idClient The client ID to disconnect.
281	* @param fRequestor VMMDEV_REQUESTOR_XXX.
282	* @param pfnAsyncCallback Required pointer to function that is called when
283	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
284	* implements waiting for an IRQ in this function.
285	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
286	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
287	* callback.
288	*
289	* @return VBox status code.
290	*/
291
292	DECLR0VBGL(int) VbglR0HGCMInternalDisconnect(HGCMCLIENTID idClient, uint32_t fRequestor,
293	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
294
295	/** Call a HGCM service.
296	*
297	* @note This function can deal with cancelled requests.
298	*
299	* @param pCallInfo The request data.
300	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
301	* @param fRequestor VMMDEV_REQUESTOR_XXX.
302	* @param pfnAsyncCallback Required pointer to function that is called when
303	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
304	* implements waiting for an IRQ in this function.
305	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
306	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
307	*
308	* @return VBox status code.
309	*/
310	DECLR0VBGL(int) VbglR0HGCMInternalCall(struct VBGLIOCHGCMCALL *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags, uint32_t fRequestor,
311	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
312
313	/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
314	*
315	* @note This function can deal with cancelled requests.
316	*
317	* @param pCallInfo The request data.
318	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
319	* @param fRequestor VMMDEV_REQUESTOR_XXX.
320	* @param pfnAsyncCallback Required pointer to function that is called when
321	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
322	* implements waiting for an IRQ in this function.
323	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
324	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
325	*
326	* @return VBox status code.
327	*/
328	DECLR0VBGL(int) VbglR0HGCMInternalCall32(struct VBGLIOCHGCMCALL *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags, uint32_t fRequestor,
329	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
330
331	/** @name VbglR0HGCMInternalCall flags
332	* @{ */
333	/** User mode request.
334	* Indicates that only user mode addresses are permitted as parameters. */
335	#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
336	/** Kernel mode request.
337	* Indicates that kernel mode addresses are permitted as parameters. Whether or
338	* not user mode addresses are permitted is, unfortunately, OS specific. The
339	* following OSes allows user mode addresses: Windows, TODO.
340	*/
341	#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
342	/** Mode mask. */
343	#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
344	/** @} */
345
346	# else /* !VBGL_VBOXGUEST */
347
348	#ifndef VBGL_VBOXGUEST
349	/** @internal */
350	typedef struct VBGLHGCMHANDLEDATA
351	{
352	uint32_t fAllocated;
353	VBGLIDCHANDLE IdcHandle;
354	} VBGLHGCMHANDLEDATA;
355	#else
356	struct VBGLHGCMHANDLEDATA;
357	#endif
358
359	typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
360
361	/** @name HGCM functions
362	* @{
363	*/
364
365	/**
366	* Initializes HGCM in the R0 guest library. Must be called before any HGCM
367	* connections are made. Is called by VbglInitClient().
368	*
369	* @return VBox status code.
370	*/
371	DECLR0VBGL(int) VbglR0HGCMInit(void);
372
373	/**
374	* Terminates HGCM in the R0 guest library. Is called by VbglTerminate().
375	*
376	* @return VBox status code.
377	*/
378	DECLR0VBGL(int) VbglR0HGCMTerminate(void);
379
380	/**
381	* Connect to a service.
382	*
383	* @param pHandle Pointer to variable that will hold a handle to be used
384	* further in VbglHGCMCall and VbglHGCMClose.
385	* @param pszServiceName The service to connect to.
386	* @param pidClient Where to return the client ID for the connection.
387	*
388	* @return VBox status code.
389	*
390	* @todo consider baking the client Id into the handle.
391	*/
392	DECLR0VBGL(int) VbglR0HGCMConnect(VBGLHGCMHANDLE pHandle, const char pszServiceName, HGCMCLIENTID *pidClient);
393
394	/**
395	* Connect to a service.
396	*
397	* @param handle Handle of the connection.
398	* @param idClient The ID of the client connection.
399	*
400	* @return VBox status code.
401	*
402	* @todo consider baking the client Id into the handle.
403	*/
404	DECLR0VBGL(int) VbglR0HGCMDisconnect(VBGLHGCMHANDLE handle, HGCMCLIENTID idClient);
405
406	/**
407	* Call to a service, returning only the I/O control status code.
408	*
409	* @param handle Handle of the connection.
410	* @param pData Call request information structure, including function parameters.
411	* @param cbData Length in bytes of data.
412	*
413	* @return VBox status code.
414	*/
415	DECLR0VBGL(int) VbglR0HGCMCallRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
416
417	/**
418	* Call to a service, returning the HGCM status code.
419	*
420	* @param handle Handle of the connection.
421	* @param pData Call request information structure, including function parameters.
422	* @param cbData Length in bytes of data.
423	*
424	* @return VBox status code. Either the I/O control status code if that failed,
425	* or the HGCM status code (pData->Hdr.rc).
426	*/
427	DECLR0VBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
428
429	/**
430	* Call to a service with user-mode data received by the calling driver from the User-Mode process.
431	* The call must be done in the context of a calling process.
432	*
433	* @param handle Handle of the connection.
434	* @param pData Call request information structure, including function parameters.
435	* @param cbData Length in bytes of data.
436	*
437	* @return VBox status code.
438	*/
439	DECLR0VBGL(int) VbglR0HGCMCallUserDataRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
440
441	/**
442	* Call to a service, w/o any repacking and buffer locking in VBoxGuest,
443	* returning the only request related status code (not HGCM).
444	*
445	* The driver only submits the request and waits for completion, nothing else.
446	*
447	* @param hHandle The connection handle.
448	* @param pCallReq The call request. Will be passed directly to the host.
449	* @param cbCallReq The size of the whole call request.
450	*
451	* @return VBox status code.
452	*
453	* @remarks The result of the HGCM call is found in
454	* @a pCallReq->HgcmCallReq.header.result on a successful return. The
455	* @a pCallReq->Hdr.rc and @a pCallReq->HgcmCallReq.header.header.rc
456	* fields are the same as the return value and can safely be ignored.
457	*/
458	DECLR0VBGL(int) VbglR0HGCMFastCall(VBGLHGCMHANDLE hHandle, struct VBGLIOCIDCHGCMFASTCALL *pCallReq, uint32_t cbCallReq);
459
460	/** @} */
461
462	/** @name Undocumented helpers for talking to the Chromium OpenGL Host Service
463	* @{ */
464	typedef VBGLHGCMHANDLE VBGLCRCTLHANDLE;
465	DECLR0VBGL(int) VbglR0CrCtlCreate(VBGLCRCTLHANDLE *phCtl);
466	DECLR0VBGL(int) VbglR0CrCtlDestroy(VBGLCRCTLHANDLE hCtl);
467	DECLR0VBGL(int) VbglR0CrCtlConConnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID *pidClient);
468	DECLR0VBGL(int) VbglR0CrCtlConDisconnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID idClient);
469	struct VBGLIOCHGCMCALL;
470	DECLR0VBGL(int) VbglR0CrCtlConCallRaw(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
471	DECLR0VBGL(int) VbglR0CrCtlConCall(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
472	DECLR0VBGL(int) VbglR0CrCtlConCallUserDataRaw(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
473	/** @} */
474
475	# endif /* !VBGL_VBOXGUEST */
476
477	# endif /* VBOX_WITH_HGCM */
478
479
480	/**
481	* Initialize the heap.
482	*
483	* @returns VBox status code.
484	*/
485	DECLR0VBGL(int) VbglR0PhysHeapInit(void);
486
487	/**
488	* Shutdown the heap.
489	*/
490	DECLR0VBGL(void) VbglR0PhysHeapTerminate(void);
491
492	/**
493	* Allocate a memory block.
494	*
495	* @returns Virtual address of the allocated memory block.
496	* @param cbSize Size of block to be allocated.
497	*/
498	DECLR0VBGL(void *) VbglR0PhysHeapAlloc(uint32_t cbSize);
499
500	/**
501	* Get physical address of memory block pointed by the virtual address.
502	*
503	* @note WARNING!
504	* The function does not acquire the Heap mutex!
505	* When calling the function make sure that the pointer is a valid one and
506	* is not being deallocated. This function can NOT be used for verifying
507	* if the given pointer is a valid one allocated from the heap.
508	*
509	* @param pv Virtual address of memory block.
510	* @returns Physical address of the memory block.
511	*/
512	DECLR0VBGL(uint32_t) VbglR0PhysHeapGetPhysAddr(void *pv);
513
514	/**
515	* Free a memory block.
516	*
517	* @param pv Virtual address of memory block.
518	*/
519	DECLR0VBGL(void) VbglR0PhysHeapFree(void *pv);
520
521	DECLR0VBGL(int) VbglR0QueryVMMDevMemory(struct VMMDevMemory **ppVMMDevMemory);
522	DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
523
524	# ifndef VBOX_GUEST
525	/** @name Mouse
526	* @{ */
527	DECLR0VBGL(int) VbglR0SetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
528	DECLR0VBGL(int) VbglR0GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
529	DECLR0VBGL(int) VbglR0SetMouseStatus(uint32_t fFeatures);
530	/** @} */
531	# endif /* VBOX_GUEST */
532
533	#endif /* IN_RING0 */
534
535	/** @} */
536
537
538	/** @defgroup grp_vboxguest_lib_r3 Ring-3 interface.
539	* @{
540	*/
541	#ifdef IN_RING3
542
543	/** @def VBGLR3DECL
544	* Ring 3 VBGL declaration.
545	* @param type The return type of the function declaration.
546	*/
547	# define VBGLR3DECL(type) DECL_HIDDEN_NOTHROW(type) VBOXCALL
548
549	/** @name General-purpose functions
550	* @{ */
551	VBGLR3DECL(int) VbglR3Init(void);
552	VBGLR3DECL(int) VbglR3InitUser(void);
553	VBGLR3DECL(void) VbglR3Term(void);
554	# ifdef IPRT_INCLUDED_time_h
555	VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
556	# endif
557	VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
558	VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
559	VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
560	VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose, bool fRespawn, unsigned *pcRespawn);
561	VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
562	VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
563	VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
564	VBGLR3DECL(int) VbglR3AcquireGuestCaps(uint32_t fOr, uint32_t fNot, bool fConfig);
565	VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
566
567	VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
568	uint32_t fFlags);
569	VBGLR3DECL(int) VbglR3GetAdditionsVersion(char ppszVer, char ppszVerEx, char **ppszRev);
570	VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
571	VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
572
573	/** @} */
574
575	# ifdef VBOX_WITH_SHARED_CLIPBOARD
576	/** @name Shared Clipboard
577	* @{ */
578
579	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
580	/**
581	* Structure for maintaining a VbglR3 Shared Clipboard transfer context.
582	*/
583	typedef struct VBGLR3SHCLTRANSFERCMDCTX
584	{
585	/** Default chunk size (in bytes).
586	* This is set by VbglR3ClipboardConnectEx(). */
587	uint32_t cbChunkSize;
588	/** Max chunk size (in bytes).
589	* This is set by VbglR3ClipboardConnectEx(). */
590	uint32_t cbMaxChunkSize;
591	/** Optional callbacks to invoke. */
592	SHCLTRANSFERCALLBACKTABLE Callbacks;
593	} VBGLR3SHCLTRANSFERCTX;
594	/** Pointer to a Shared Clipboard transfer context. */
595	typedef VBGLR3SHCLTRANSFERCMDCTX *PVBGLR3SHCLTRANSFERCMDCTX;
596	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
597
598	/**
599	* The context required for either retrieving or sending a HGCM shared clipboard
600	* commands from or to the host.
601	*
602	* @todo This struct could be handy if we want to implement a second
603	* communication channel, e.g. via TCP/IP. Use a union for the HGCM stuff then.
604	*/
605	typedef struct VBGLR3SHCLCMDCTX
606	{
607	/** HGCM client ID to use for communication.
608	* This is set by VbglR3ClipboardConnectEx(). */
609	uint32_t idClient;
610	/** This is @c false if both VBOX_SHCL_HF_0_CONTEXT_ID and
611	* VBOX_SHCL_GF_0_CONTEXT_ID are set, otherwise @c true and only the old
612	* protocol (< 6.1) should be used.
613	* This is set by VbglR3ClipboardConnectEx(). */
614	bool fUseLegacyProtocol;
615	/** Host feature flags (VBOX_SHCL_HF_XXX).
616	* This is set by VbglR3ClipboardConnectEx(). */
617	uint64_t fHostFeatures;
618	/** The guest feature flags reported to the host (VBOX_SHCL_GF_XXX).
619	* This is set by VbglR3ClipboardConnectEx(). */
620	uint64_t fGuestFeatures;
621	/** The context ID - input or/and output depending on the operation. */
622	uint64_t idContext;
623	/** OUT: Number of parameters retrieved.
624	* This is set by ??. */
625	uint32_t cParmsRecived;
626	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
627	/** Data related to Shared Clipboard file transfers. */
628	VBGLR3SHCLTRANSFERCMDCTX Transfers;
629	# endif
630	} VBGLR3SHCLCMDCTX;
631	/** Pointer to a shared clipboard context for Vbgl. */
632	typedef VBGLR3SHCLCMDCTX *PVBGLR3SHCLCMDCTX;
633
634	/**
635	* Enumeration specifying a Shared Clipboard event type.
636	* @todo r=bird: Surely, this isn't necessary?!
637	*/
638	typedef enum _VBGLR3CLIPBOARDEVENTTYPE
639	{
640	/** No event needed / defined. */
641	VBGLR3CLIPBOARDEVENTTYPE_NONE = 0,
642	/** Host reports available clipboard formats to the guest. */
643	VBGLR3CLIPBOARDEVENTTYPE_REPORT_FORMATS,
644	/** Host wants to read Shared Clipboard data from the guest. */
645	VBGLR3CLIPBOARDEVENTTYPE_READ_DATA,
646	/** Terminates the Shared Clipboard service. */
647	VBGLR3CLIPBOARDEVENTTYPE_QUIT,
648	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
649	/** Reports a transfer status to the guest. */
650	VBGLR3CLIPBOARDEVENTTYPE_TRANSFER_STATUS,
651	# endif
652	/** Blow the type up to 32-bit. */
653	VBGLR3CLIPBOARDEVENTTYPE_32BIT_HACK = 0x7fffffff
654	} VBGLR3CLIPBOARDEVENTTYPE;
655
656	/**
657	* Structure for keeping a Shared Clipboard VbglR3 event.
658	*/
659	typedef struct _VBGLR3CLIPBOARDEVENT
660	{
661	/** The event type the union contains. */
662	VBGLR3CLIPBOARDEVENTTYPE enmType;
663	/** Command context bound to this event. */
664	VBGLR3SHCLCMDCTX cmdCtx;
665	union
666	{
667	/** Reports available formats from the host. */
668	SHCLFORMATS fReportedFormats;
669	/** Reports that data needs to be read from the guest. */
670	SHCLFORMAT fReadData;
671	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
672	/** Reports a transfer status to the guest. */
673	struct
674	{
675	/** ID of the trnasfer. */
676	SHCLTRANSFERID uID;
677	/** Transfer direction. */
678	SHCLTRANSFERDIR enmDir;
679	/** Additional reproting information. */
680	SHCLTRANSFERREPORT Report;
681	} TransferStatus;
682	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
683	} u;
684	} VBGLR3CLIPBOARDEVENT, *PVBGLR3CLIPBOARDEVENT;
685	typedef const PVBGLR3CLIPBOARDEVENT CPVBGLR3CLIPBOARDEVENT;
686
687	/** @todo r=bird: I'm not sure it is appropriate for the VbglR3 to use types
688	* from VBox/GuestHost/SharedClipboard.h, doesn't seem clean to me. /
689
690	VBGLR3DECL(int) VbglR3ClipboardConnect(HGCMCLIENTID *pidClient);
691	VBGLR3DECL(int) VbglR3ClipboardDisconnect(HGCMCLIENTID idClient);
692	VBGLR3DECL(int) VbglR3ClipboardGetHostMsgOld(HGCMCLIENTID idClient, uint32_t pMsg, uint32_t pfFormats);
693	VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void pv, uint32_t cb, uint32_t pcb);
694	VBGLR3DECL(int) VbglR3ClipboardReadDataEx(PVBGLR3SHCLCMDCTX pCtx, SHCLFORMAT uFormat, void pvData, uint32_t cbData, uint32_t pcbRead);
695	VBGLR3DECL(int) VbglR3ClipboardWriteData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb);
696	VBGLR3DECL(int) VbglR3ClipboardWriteDataEx(PVBGLR3SHCLCMDCTX pCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData);
697	VBGLR3DECL(int) VbglR3ClipboardReportFormats(HGCMCLIENTID idClient, uint32_t fFormats);
698
699	VBGLR3DECL(int) VbglR3ClipboardConnectEx(PVBGLR3SHCLCMDCTX pCtx, uint64_t fGuestFeatures);
700	VBGLR3DECL(int) VbglR3ClipboardDisconnectEx(PVBGLR3SHCLCMDCTX pCtx);
701
702	VBGLR3DECL(int) VbglR3ClipboardReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
703	VBGLR3DECL(int) VbglR3ClipboardQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures);
704	VBGLR3DECL(int) VbglR3ClipboardMsgPeekWait(PVBGLR3SHCLCMDCTX pCtx, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
705	VBGLR3DECL(int) VbglR3ClipboardEventGetNext(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PVBGLR3CLIPBOARDEVENT pEvent);
706	VBGLR3DECL(void) VbglR3ClipboardEventFree(PVBGLR3CLIPBOARDEVENT pEvent);
707
708	VBGLR3DECL(int) VbglR3ClipboardWriteError(HGCMCLIENTID idClient, int rcErr);
709
710	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
711	VBGLR3DECL(void) VbglR3ClipboardTransferSetCallbacks(PSHCLTRANSFERCALLBACKTABLE pCallbacks);
712	VBGLR3DECL(int) VbglR3ClipboardEventGetNextEx(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFERCTX pTransferCtx, PVBGLR3CLIPBOARDEVENT pEvent);
713
714	VBGLR3DECL(int) VbglR3ClipboardTransferStatusReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus);
715
716	VBGLR3DECL(int) VbglR3ClipboardRootListRead(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLIST *ppRootList);
717
718	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReq(PVBGLR3SHCLCMDCTX pCtx, uint32_t *pfRoots);
719	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLIST pRootList);
720	VBGLR3DECL(int) VbglR3ClipboardRootsWrite(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLISTHDR pRoots);
721
722	VBGLR3DECL(int) VbglR3ClipboardListOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);
723	VBGLR3DECL(int) VbglR3ClipboardListOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms);
724	VBGLR3DECL(int) VbglR3ClipboardListOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLLISTHANDLE hList);
725
726	VBGLR3DECL(int) VbglR3ClipboardListCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList);
727	VBGLR3DECL(int) VbglR3ClipboardListCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList);
728
729	VBGLR3DECL(int) VbglR3ClipboardListHdrWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr);
730	VBGLR3DECL(int) VbglR3ClipboardListEntryWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry);
731
732	VBGLR3DECL(int) VbglR3ClipboardObjOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms);
733	VBGLR3DECL(int) VbglR3ClipboardObjOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
734	VBGLR3DECL(int) VbglR3ClipboardObjOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms,
735	PSHCLOBJHANDLE phObj);
736
737	VBGLR3DECL(int) VbglR3ClipboardObjCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj);
738	VBGLR3DECL(int) VbglR3ClipboardObjCloseReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
739	VBGLR3DECL(int) VbglR3ClipboardObjCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj);
740
741	VBGLR3DECL(int) VbglR3ClipboardObjReadRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj, uint32_t pcbToRead,
742	uint32_t *pfFlags);
743	VBGLR3DECL(int) VbglR3ClipboardObjReadSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
744	uint32_t *pcbRead);
745	VBGLR3DECL(int) VbglR3ClipboardObjWriteSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
746	uint32_t *pcbWritten);
747	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
748	/** @} */
749	# endif /* VBOX_WITH_SHARED_CLIPBOARD */
750
751	/** @name Seamless mode
752	* @{ */
753	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
754	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
755	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
756	VBGLR3DECL(int) VbglR3SeamlessSendMonitorPositions(uint32_t cPositions, PRTPOINT pPositions);
757	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
758
759	/** @} */
760
761	/** @name Mouse
762	* @{ */
763	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
764	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
765	/** @} */
766
767	/** @name Video
768	* @{ */
769	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
770	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
771	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
772	const void *pvImg, size_t cbImg);
773	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
774	/** @} */
775
776	/** @name Display
777	* @{ */
778	/** The folder for the video mode hint unix domain socket on Unix-like guests.
779	* @note This can be safely changed as all users are rebuilt in lock-step. */
780	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
781	/** The path to the video mode hint unix domain socket on Unix-like guests. */
782	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
783
784	/** The folder for saving video mode hints to between sessions. */
785	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
786	/** The path to the file for saving video mode hints to between sessions. */
787	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
788
789	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
790	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
791	VBGLR3DECL(int) VbglR3GetDisplayChangeRequestMulti(uint32_t cDisplaysIn, uint32_t *pcDisplaysOut,
792	VMMDevDisplayDef *paDisplays, bool fAck);
793	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
794	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
795	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
796	unsigned x, unsigned y, bool fEnabled);
797	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
798	unsigned px, unsigned py, bool *pfEnabled);
799	/** @} */
800
801	/** @name VRDP
802	* @{ */
803	VBGLR3DECL(int) VbglR3VrdpGetChangeRequest(bool pfActive, uint32_t puExperienceLevel);
804	/** @} */
805
806	/** @name VM Statistics
807	* @{ */
808	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
809	# if defined(VBOX_INCLUDED_VMMDev_h) \|\| defined(DOXYGEN_RUNNING)
810	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
811	# endif
812	/** @} */
813
814	/** @name Memory ballooning
815	* @{ */
816	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
817	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
818	/** @} */
819
820	/** @name Core Dump
821	* @{ */
822	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
823
824	/** @} */
825
826	/** @name DRM client handling
827	* @{ */
828	VBGLR3DECL(bool) VbglR3DrmClientIsNeeded(void);
829	VBGLR3DECL(bool) VbglR3DrmClientIsRunning(void);
830	VBGLR3DECL(int) VbglR3DrmClientStart(void);
831	/** @} */
832
833	# ifdef VBOX_WITH_GUEST_PROPS
834	/** @name Guest properties
835	* @{ */
836	/** @todo Docs. */
837	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
838	/** @todo Docs. */
839	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
840	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
841	VBGLR3DECL(int) VbglR3GuestPropDisconnect(HGCMCLIENTID idClient);
842	VBGLR3DECL(bool) VbglR3GuestPropExist(uint32_t idClient, const char *pszPropName);
843	VBGLR3DECL(int) VbglR3GuestPropWrite(HGCMCLIENTID idClient, const char pszName, const char pszValue, const char *pszFlags);
844	VBGLR3DECL(int) VbglR3GuestPropWriteValue(HGCMCLIENTID idClient, const char pszName, const char pszValue);
845	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(HGCMCLIENTID idClient, const char *pszName,
846	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
847	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(HGCMCLIENTID idClient, const char *pszName,
848	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
849	VBGLR3DECL(int) VbglR3GuestPropRead(HGCMCLIENTID idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
850	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
851	VBGLR3DECL(int) VbglR3GuestPropReadEx(uint32_t u32ClientId,
852	const char pszPropName, char ppszValue, char ppszFlags, uint64_t puTimestamp);
853	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
854	uint32_t *pcchValueActual);
855	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(HGCMCLIENTID idClient, const char pszName, char *ppszValue);
856	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
857	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(HGCMCLIENTID idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
858	uint32_t *pcbBufActual);
859	VBGLR3DECL(int) VbglR3GuestPropEnum(HGCMCLIENTID idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
860	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
861	uint64_t pu64Timestamp, char const *ppszFlags);
862	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
863	uint64_t pu64Timestamp, char const *ppszFlags);
864	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
865	VBGLR3DECL(int) VbglR3GuestPropDelete(HGCMCLIENTID idClient, const char *pszName);
866	VBGLR3DECL(int) VbglR3GuestPropDelSet(HGCMCLIENTID idClient, char const * const *papszPatterns, uint32_t cPatterns);
867	VBGLR3DECL(int) VbglR3GuestPropWait(HGCMCLIENTID idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
868	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
869	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
870	/** @} */
871
872	/** @name Guest user handling / reporting.
873	* @{ */
874	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
875	uint8_t *pbDetails, uint32_t cbDetails);
876	/** @} */
877
878	/** @name Host version handling
879	* @{ */
880	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(HGCMCLIENTID idClient, bool pfUpdate, char *ppszHostVersion,
881	char **ppszGuestVersion);
882	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(HGCMCLIENTID idClient, char **ppszVer);
883	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(HGCMCLIENTID idClient, const char *pszVer);
884	/** @} */
885	# endif /* VBOX_WITH_GUEST_PROPS defined */
886
887	# ifdef VBOX_WITH_SHARED_FOLDERS
888	/** @name Shared folders
889	* @{ */
890	/**
891	* Structure containing mapping information for a shared folder.
892	*/
893	typedef struct VBGLR3SHAREDFOLDERMAPPING
894	{
895	/** Mapping status. */
896	uint32_t u32Status;
897	/** Root handle. */
898	uint32_t u32Root;
899	} VBGLR3SHAREDFOLDERMAPPING;
900	/** Pointer to a shared folder mapping information structure. */
901	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
902	/** Pointer to a const shared folder mapping information structure. */
903	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
904
905	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
906	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient);
907	VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName);
908	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
909	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
910	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
911	VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient,uint32_t u32Root, char ppszName); /< @todo r=bird: GET functions return the value, not a status code!*/
912	VBGLR3DECL(int) VbglR3SharedFolderQueryFolderInfo(HGCMCLIENTID idClient, uint32_t idRoot, uint64_t fQueryFlags,
913	char ppszName, char ppszMountPoint,
914	uint64_t pfFlags, uint32_t puRootIdVersion);
915	VBGLR3DECL(int) VbglR3SharedFolderWaitForMappingsChanges(HGCMCLIENTID idClient, uint32_t uPrevVersion, uint32_t *puCurVersion);
916	VBGLR3DECL(int) VbglR3SharedFolderCancelMappingsChangesWaits(HGCMCLIENTID idClient);
917
918	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char ppszPrefix); /< @todo r=bird: GET functions return the value, not a status code! */
919	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char ppszDir); /< @todo r=bird: GET functions return the value, not a status code! */
920	/** @} */
921	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
922
923	# ifdef VBOX_WITH_GUEST_CONTROL
924	/** @name Guest control
925	* @{ */
926
927	/**
928	* Structure containing the context required for
929	* either retrieving or sending a HGCM guest control
930	* commands from or to the host.
931	*
932	* @note Do not change parameter order without also adapting all structure
933	* initializers.
934	*/
935	typedef struct VBGLR3GUESTCTRLCMDCTX
936	{
937	/** @todo This struct could be handy if we want to implement
938	* a second communication channel, e.g. via TCP/IP.
939	* Use a union for the HGCM stuff then. */
940
941	/** IN: HGCM client ID to use for communication. */
942	uint32_t uClientID;
943	/** IN/OUT: Context ID to retrieve or to use. */
944	uint32_t uContextID;
945	/** IN: Protocol version to use. */
946	uint32_t uProtocol;
947	/** OUT: Number of parameters retrieved. */
948	uint32_t uNumParms;
949	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
950
951	/**
952	* Structure holding information for starting a guest
953	* session.
954	*/
955	typedef struct VBGLR3GUESTCTRLSESSIONSTARTUPINFO
956	{
957	/** The session's protocol version to use. */
958	uint32_t uProtocol;
959	/** The session's ID. */
960	uint32_t uSessionID;
961	/** User name (account) to start the guest session under. */
962	char *pszUser;
963	/** Size (in bytes) of allocated pszUser. */
964	uint32_t cbUser;
965	/** Password of specified user name (account). */
966	char *pszPassword;
967	/** Size (in bytes) of allocated pszPassword. */
968	uint32_t cbPassword;
969	/** Domain of the user account. */
970	char *pszDomain;
971	/** Size (in bytes) of allocated pszDomain. */
972	uint32_t cbDomain;
973	/** Session creation flags.
974	* @sa VBOXSERVICECTRLSESSIONSTARTUPFLAG_* flags. */
975	uint32_t fFlags;
976	} VBGLR3GUESTCTRLSESSIONSTARTUPINFO;
977	/** Pointer to a guest session startup info. */
978	typedef VBGLR3GUESTCTRLSESSIONSTARTUPINFO *PVBGLR3GUESTCTRLSESSIONSTARTUPINFO;
979
980	/**
981	* Structure holding information for starting a guest
982	* process.
983	*/
984	typedef struct VBGLR3GUESTCTRLPROCSTARTUPINFO
985	{
986	/** Full qualified path of process to start (without arguments).
987	* Note: This is not argv[0]! */
988	char *pszCmd;
989	/** Size (in bytes) of allocated pszCmd. */
990	uint32_t cbCmd;
991	/** Process execution flags. @sa */
992	uint32_t fFlags;
993	/** Command line arguments. */
994	char *pszArgs;
995	/** Size (in bytes) of allocated pszArgs. */
996	uint32_t cbArgs;
997	/** Number of arguments specified in pszArgs. */
998	uint32_t cArgs;
999	/** String of environment variables ("FOO=BAR") to pass to the process
1000	* to start. */
1001	char *pszEnv;
1002	/** Size (in bytes) of environment variables block. */
1003	uint32_t cbEnv;
1004	/** Number of environment variables specified in pszEnv. */
1005	uint32_t cEnvVars;
1006	/** User name (account) to start the process under. */
1007	char *pszUser;
1008	/** Size (in bytes) of allocated pszUser. */
1009	uint32_t cbUser;
1010	/** Password of specified user name (account). */
1011	char *pszPassword;
1012	/** Size (in bytes) of allocated pszPassword. */
1013	uint32_t cbPassword;
1014	/** Domain to be used for authenticating the specified user name (account). */
1015	char *pszDomain;
1016	/** Size (in bytes) of allocated pszDomain. */
1017	uint32_t cbDomain;
1018	/** Time limit (in ms) of the process' life time. */
1019	uint32_t uTimeLimitMS;
1020	/** Process priority. */
1021	uint32_t uPriority;
1022	/** Process affinity block. At the moment we support
1023	* up to 4 blocks, that is, 4 * 64 = 256 CPUs total. */
1024	uint64_t uAffinity[4];
1025	/** Number of used process affinity blocks. */
1026	uint32_t cAffinity;
1027	} VBGLR3GUESTCTRLPROCSTARTUPINFO;
1028	/** Pointer to a guest process startup info. */
1029	typedef VBGLR3GUESTCTRLPROCSTARTUPINFO *PVBGLR3GUESTCTRLPROCSTARTUPINFO;
1030
1031	/* General message handling on the guest. */
1032	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
1033	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t idClient);
1034	VBGLR3DECL(bool) VbglR3GuestCtrlSupportsOptimizations(uint32_t idClient);
1035	VBGLR3DECL(int) VbglR3GuestCtrlMakeMeMaster(uint32_t idClient);
1036	VBGLR3DECL(int) VbglR3GuestCtrlReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1037	VBGLR3DECL(int) VbglR3GuestCtrlQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures);
1038	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
1039	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
1040	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
1041	void *pvPayload, uint32_t cbPayload);
1042	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg);
1043	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t uClientId);
1044	VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
1045	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
1046	/* Guest session handling. */
1047	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInit(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1048	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInitEx(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo, size_t cbUser, size_t cbPassword, size_t cbDomain);
1049	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoDestroy(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1050	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoFree(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1051	VBGLR3DECL(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO) VbglR3GuestCtrlSessionStartupInfoDup(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1052	VBGLR3DECL(int) VbglR3GuestCtrlSessionPrepare(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1053	VBGLR3DECL(int) VbglR3GuestCtrlSessionAccept(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1054	VBGLR3DECL(int) VbglR3GuestCtrlSessionCancelPrepared(uint32_t idClient, uint32_t idSession);
1055	VBGLR3DECL(int) VbglR3GuestCtrlSessionHasChanged(uint32_t idClient, uint64_t idNewControlSession);
1056	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
1057	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, int32_t iResult);
1058	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLSESSIONSTARTUPINFO *ppStartupInfo);
1059	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t pidSession);
1060	/* Guest path handling. */
1061	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
1062	uint32_t cbDest, uint32_t *pfFlags);
1063	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx);
1064	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx);
1065	VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction);
1066	/* Guest process execution. */
1067	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInit(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1068	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInitEx(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo, size_t cbCmd, size_t cbUser, size_t cbPassword, size_t cbDomain, size_t cbArgs, size_t cbEnv);
1069	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoDestroy(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1070	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoFree(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1071	VBGLR3DECL(PVBGLR3GUESTCTRLPROCSTARTUPINFO) VbglR3GuestCtrlProcStartupInfoDup(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1072	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLPROCSTARTUPINFO *ppStartupInfo);
1073	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
1074	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
1075	uint32_t cbData, uint32_t *pcbSize);
1076	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
1077	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
1078	uint32_t *puTimeoutMS);
1079	/* Guest native directory handling. */
1080	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
1081	/* Guest native file handling. */
1082	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
1083	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
1084	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
1085	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1086	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
1087	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1088	uint32_t puToRead, uint64_t poffRead);
1089	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1090	void pvData, uint32_t cbData, uint32_t pcbActual);
1091	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
1092	uint32_t pcbActual, uint64_t poffWrite);
1093	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1094	uint32_t puSeekMethod, uint64_t poffSeek);
1095	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1096	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint64_t pcbNew);
1097
1098	/* Guest -> Host. */
1099	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
1100	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1101	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1102	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
1103	VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
1104	void *pvData, uint32_t cbData, int64_t offNew);
1105	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten);
1106	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew);
1107
1108	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1109	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1110	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew);
1111	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
1112	void *pvData, uint32_t cbData);
1113	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
1114	void *pvData, uint32_t cbData);
1115	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
1116	uint32_t fFlags, uint32_t cbWritten);
1117
1118	/** @} */
1119	# endif /* VBOX_WITH_GUEST_CONTROL defined */
1120
1121	/** @name Auto-logon handling
1122	* @{ */
1123	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
1124	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
1125	/** @} */
1126
1127	/** @name User credentials handling
1128	* @{ */
1129	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
1130	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
1131	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
1132	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
1133	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
1134	uint32_t cPasses);
1135	/** @} */
1136
1137	/** @name CPU hotplug monitor
1138	* @{ */
1139	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
1140	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
1141	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
1142	/** @} */
1143
1144	/** @name Page sharing
1145	* @{ */
1146	struct VMMDEVSHAREDREGIONDESC;
1147	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
1148	unsigned cRegions, struct VMMDEVSHAREDREGIONDESC *pRegions);
1149	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
1150	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
1151	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
1152	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
1153	/** @} */
1154
1155	# ifdef VBOX_WITH_DRAG_AND_DROP
1156	/** @name Drag and Drop
1157	* @{ */
1158	/**
1159	* Structure containing the context required for
1160	* either retrieving or sending a HGCM guest drag'n drop
1161	* commands from or to the host.
1162	*
1163	* Note: Do not change parameter order without also
1164	* adapting all structure initializers.
1165	*/
1166	typedef struct VBGLR3GUESTDNDCMDCTX
1167	{
1168	/** @todo This struct could be handy if we want to implement
1169	* a second communication channel, e.g. via TCP/IP.
1170	* Use a union for the HGCM stuff then. */
1171
1172	/** HGCM client ID to use for communication. */
1173	uint32_t uClientID;
1174	/** The VM's current session ID. */
1175	uint64_t uSessionID;
1176	/** Protocol version to use.
1177	* Deprecated; do not used / rely on it anymore. */
1178	uint32_t uProtocolDeprecated;
1179	/** Host feature flags (VBOX_DND_HF_XXX).
1180	* This is set by VbglR3DnDConnect(). */
1181	uint64_t fHostFeatures;
1182	/** The guest feature flags reported to the host (VBOX_DND_GF_XXX).
1183	* This is set by VbglR3DnDConnect(). */
1184	uint64_t fGuestFeatures;
1185	/** Number of parameters retrieved for the current command. */
1186	uint32_t uNumParms;
1187	/** Max chunk size (in bytes) for data transfers. */
1188	uint32_t cbMaxChunkSize;
1189	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
1190
1191	/**
1192	* Enumeration for specifying the DnD meta data type.
1193	*/
1194	typedef enum VBGLR3GUESTDNDMETADATATYPE
1195	{
1196	/** Unknown meta data type; don't use. */
1197	VBGLR3GUESTDNDMETADATATYPE_UNKNOWN = 0,
1198	/** Raw meta data; can be everything. */
1199	VBGLR3GUESTDNDMETADATATYPE_RAW,
1200	/** Meta data is a transfer list, specifying objects. */
1201	VBGLR3GUESTDNDMETADATATYPE_URI_LIST,
1202	/** Blow the type up to 32-bit. */
1203	VBGLR3GUESTDNDMETADATATYPE_32BIT_HACK = 0x7fffffff
1204	} VBGLR3GUESTDNDMETADATATYPE;
1205
1206	/**
1207	* Structure for keeping + handling DnD meta data.
1208	*/
1209	typedef struct VBGLR3GUESTDNDMETADATA
1210	{
1211	/** The meta data type the union contains. */
1212	VBGLR3GUESTDNDMETADATATYPE enmType;
1213	/** Union based on \a enmType. */
1214	union
1215	{
1216	struct
1217	{
1218	/** Pointer to actual meta data. */
1219	void *pvMeta;
1220	/** Size (in bytes) of meta data. */
1221	uint32_t cbMeta;
1222	} Raw;
1223	struct
1224	{
1225	DNDTRANSFERLIST Transfer;
1226	} URI;
1227	} u;
1228	} VBGLR3GUESTDNDMETADATA;
1229
1230	/** Pointer to VBGLR3GUESTDNDMETADATA. */
1231	typedef VBGLR3GUESTDNDMETADATA *PVBGLR3GUESTDNDMETADATA;
1232
1233	/** Const pointer to VBGLR3GUESTDNDMETADATA. */
1234	typedef const PVBGLR3GUESTDNDMETADATA CPVBGLR3GUESTDNDMETADATA;
1235
1236	/**
1237	* Enumeration specifying a DnD event type.
1238	*/
1239	typedef enum VBGLR3DNDEVENTTYPE
1240	{
1241	VBGLR3DNDEVENTTYPE_INVALID = 0,
1242	VBGLR3DNDEVENTTYPE_HG_ERROR = 1,
1243	VBGLR3DNDEVENTTYPE_HG_ENTER = 2,
1244	VBGLR3DNDEVENTTYPE_HG_MOVE = 3,
1245	VBGLR3DNDEVENTTYPE_HG_LEAVE = 4,
1246	VBGLR3DNDEVENTTYPE_HG_DROP = 5,
1247	VBGLR3DNDEVENTTYPE_HG_RECEIVE = 6,
1248	VBGLR3DNDEVENTTYPE_HG_CANCEL = 7,
1249	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1250	VBGLR3DNDEVENTTYPE_GH_ERROR = 100,
1251	VBGLR3DNDEVENTTYPE_GH_REQ_PENDING = 101,
1252	VBGLR3DNDEVENTTYPE_GH_DROP = 102,
1253	# endif
1254	/** Tells the caller that it has to quit operation. */
1255	VBGLR3DNDEVENTTYPE_QUIT = 200,
1256	/** Blow the type up to 32-bit. */
1257	VBGLR3DNDEVENTTYPE_32BIT_HACK = 0x7fffffff
1258	} VBGLR3DNDEVENTTYPE;
1259
1260	typedef struct VBGLR3DNDEVENT
1261	{
1262	/** The event type the union contains. */
1263	VBGLR3DNDEVENTTYPE enmType;
1264	union
1265	{
1266	struct
1267	{
1268	/** Screen ID this request belongs to. */
1269	uint32_t uScreenID;
1270	/** Format list (UTF-8, \r\n separated). */
1271	char *pszFormats;
1272	/** Size (in bytes) of pszFormats (\0 included). */
1273	uint32_t cbFormats;
1274	/** List of allowed DnD actions. */
1275	VBOXDNDACTIONLIST dndLstActionsAllowed;
1276	} HG_Enter;
1277	struct
1278	{
1279	/** Absolute X position of guest screen. */
1280	uint32_t uXpos;
1281	/** Absolute Y position of guest screen. */
1282	uint32_t uYpos;
1283	/** Default DnD action. */
1284	VBOXDNDACTION dndActionDefault;
1285	} HG_Move;
1286	struct
1287	{
1288	/** Absolute X position of guest screen. */
1289	uint32_t uXpos;
1290	/** Absolute Y position of guest screen. */
1291	uint32_t uYpos;
1292	/** Default DnD action. */
1293	VBOXDNDACTION dndActionDefault;
1294	} HG_Drop;
1295	struct
1296	{
1297	/** Meta data for the operation. */
1298	VBGLR3GUESTDNDMETADATA Meta;
1299	} HG_Received;
1300	struct
1301	{
1302	/** IPRT-style error code. */
1303	int rc;
1304	} HG_Error;
1305	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1306	struct
1307	{
1308	/** Screen ID this request belongs to. */
1309	uint32_t uScreenID;
1310	} GH_IsPending;
1311	struct
1312	{
1313	/** Requested format by the host. */
1314	char *pszFormat;
1315	/** Size (in bytes) of pszFormat (\0 included). */
1316	uint32_t cbFormat;
1317	/** Requested DnD action. */
1318	VBOXDNDACTION dndActionRequested;
1319	} GH_Drop;
1320	# endif
1321	} u;
1322	} VBGLR3DNDEVENT;
1323	typedef VBGLR3DNDEVENT *PVBGLR3DNDEVENT;
1324	typedef const PVBGLR3DNDEVENT CPVBGLR3DNDEVENT;
1325
1326	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1327	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1328
1329	VBGLR3DECL(int) VbglR3DnDReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1330
1331	VBGLR3DECL(int) VbglR3DnDEventGetNext(PVBGLR3GUESTDNDCMDCTX pCtx, PVBGLR3DNDEVENT *ppEvent);
1332	VBGLR3DECL(void) VbglR3DnDEventFree(PVBGLR3DNDEVENT pEvent);
1333
1334	VBGLR3DECL(int) VbglR3DnDHGSendAckOp(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndAction);
1335	VBGLR3DECL(int) VbglR3DnDHGSendReqData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pcszFormat);
1336	VBGLR3DECL(int) VbglR3DnDHGSendProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
1337	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1338	VBGLR3DECL(int) VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndActionDefault, VBOXDNDACTIONLIST dndLstActionsAllowed, const char* pcszFormats, uint32_t cbFormats);
1339	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
1340	VBGLR3DECL(int) VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
1341	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
1342	/** @} */
1343	# endif /* VBOX_WITH_DRAG_AND_DROP */
1344
1345	/* Generic Host Channel Service. */
1346	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pidClient);
1347	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t idClient);
1348	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1349	const char *pszName, uint32_t u32Flags);
1350	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1351	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1352	void *pvData, uint32_t cbData);
1353	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1354	void *pvData, uint32_t cbData,
1355	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
1356	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1357	uint32_t u32Code, void *pvParm, uint32_t cbParm,
1358	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
1359	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1360	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
1361	uint32_t *pu32SizeReturned);
1362	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1363	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
1364	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
1365	uint32_t *pu32SizeDataReturned);
1366
1367	/** @name Mode hint storage
1368	* @{ */
1369	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
1370	unsigned cy, unsigned cBPP, unsigned *x,
1371	unsigned y, unsigned fEnabled);
1372	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
1373	unsigned cy, unsigned cBPP, unsigned x,
1374	unsigned y, unsigned fEnabled);
1375	/** @} */
1376
1377	/** @name Generic HGCM
1378	* @{ */
1379	VBGLR3DECL(int) VbglR3HGCMConnect(const char pszServiceName, HGCMCLIENTID pidClient);
1380	VBGLR3DECL(int) VbglR3HGCMDisconnect(HGCMCLIENTID idClient);
1381	struct VBGLIOCHGCMCALL;
1382	VBGLR3DECL(int) VbglR3HGCMCall(struct VBGLIOCHGCMCALL *pInfo, size_t cbInfo);
1383	/** @} */
1384
1385	#endif /* IN_RING3 */
1386	/** @} */
1387
1388	RT_C_DECLS_END
1389
1390	/** @} */
1391
1392	#endif /* !VBOX_INCLUDED_VBoxGuestLib_h */

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

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

Download in other formats: