VBoxGuestLib.h@ 98140

Last change on this file since 98140 was 98103, checked in by vboxsync, 23 months ago
Copyright year updates by scm.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 61.7 KB

Line
1	/** @file
2	* VBoxGuestLib - VirtualBox Guest Additions Library.
3	*/
4
5	/*
6	* Copyright (C) 2006-2023 Oracle and/or its affiliates.
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 cb Number of bytes to allocate.
497	*/
498	DECLR0VBGL(void *) VbglR0PhysHeapAlloc(uint32_t cb);
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. Zero is returned if @a pv
511	* isn't valid.
512	*/
513	DECLR0VBGL(uint32_t) VbglR0PhysHeapGetPhysAddr(void *pv);
514
515	# ifdef IN_TESTCASE
516	DECLVBGL(size_t) VbglR0PhysHeapGetFreeSize(void);
517	# endif
518
519	/**
520	* Free a memory block.
521	*
522	* @param pv Virtual address of memory block.
523	*/
524	DECLR0VBGL(void) VbglR0PhysHeapFree(void *pv);
525
526	DECLR0VBGL(int) VbglR0QueryVMMDevMemory(struct VMMDevMemory **ppVMMDevMemory);
527	DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
528
529	# ifndef VBOX_GUEST
530	/** @name Mouse
531	* @{ */
532	DECLR0VBGL(int) VbglR0SetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
533	DECLR0VBGL(int) VbglR0GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
534	DECLR0VBGL(int) VbglR0SetMouseStatus(uint32_t fFeatures);
535	/** @} */
536	# endif /* VBOX_GUEST */
537
538	#endif /* IN_RING0 */
539
540	/** @} */
541
542
543	/** @defgroup grp_vboxguest_lib_r3 Ring-3 interface.
544	* @{
545	*/
546	#ifdef IN_RING3
547
548	/** @def VBGLR3DECL
549	* Ring 3 VBGL declaration.
550	* @param type The return type of the function declaration.
551	*/
552	# define VBGLR3DECL(type) DECL_HIDDEN_NOTHROW(type) VBOXCALL
553
554	/** @name General-purpose functions
555	* @{ */
556	VBGLR3DECL(int) VbglR3Init(void);
557	VBGLR3DECL(int) VbglR3InitUser(void);
558	VBGLR3DECL(void) VbglR3Term(void);
559	# ifdef IPRT_INCLUDED_time_h
560	VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
561	# endif
562	VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
563	VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
564	VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
565	VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose, bool fRespawn, unsigned *pcRespawn);
566	VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
567	VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
568	VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
569	VBGLR3DECL(int) VbglR3AcquireGuestCaps(uint32_t fOr, uint32_t fNot, bool fConfig);
570	VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
571
572	VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
573	uint32_t fFlags);
574	VBGLR3DECL(int) VbglR3GetAdditionsVersion(char ppszVer, char ppszVerEx, char **ppszRev);
575	VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
576	VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
577
578	/** @} */
579
580	# ifdef VBOX_WITH_SHARED_CLIPBOARD
581	/** @name Shared Clipboard
582	* @{ */
583
584	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
585	/**
586	* Structure for maintaining a VbglR3 Shared Clipboard transfer context.
587	*/
588	typedef struct VBGLR3SHCLTRANSFERCMDCTX
589	{
590	/** Default chunk size (in bytes).
591	* This is set by VbglR3ClipboardConnectEx(). */
592	uint32_t cbChunkSize;
593	/** Max chunk size (in bytes).
594	* This is set by VbglR3ClipboardConnectEx(). */
595	uint32_t cbMaxChunkSize;
596	/** Optional callbacks to invoke. */
597	SHCLTRANSFERCALLBACKTABLE Callbacks;
598	} VBGLR3SHCLTRANSFERCTX;
599	/** Pointer to a Shared Clipboard transfer context. */
600	typedef VBGLR3SHCLTRANSFERCMDCTX *PVBGLR3SHCLTRANSFERCMDCTX;
601	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
602
603	/**
604	* The context required for either retrieving or sending a HGCM shared clipboard
605	* commands from or to the host.
606	*
607	* @todo This struct could be handy if we want to implement a second
608	* communication channel, e.g. via TCP/IP. Use a union for the HGCM stuff then.
609	*/
610	typedef struct VBGLR3SHCLCMDCTX
611	{
612	/** HGCM client ID to use for communication.
613	* This is set by VbglR3ClipboardConnectEx(). */
614	uint32_t idClient;
615	/** This is @c false if both VBOX_SHCL_HF_0_CONTEXT_ID and
616	* VBOX_SHCL_GF_0_CONTEXT_ID are set, otherwise @c true and only the old
617	* protocol (< 6.1) should be used.
618	* This is set by VbglR3ClipboardConnectEx(). */
619	bool fUseLegacyProtocol;
620	/** Host feature flags (VBOX_SHCL_HF_XXX).
621	* This is set by VbglR3ClipboardConnectEx(). */
622	uint64_t fHostFeatures;
623	/** The guest feature flags reported to the host (VBOX_SHCL_GF_XXX).
624	* This is set by VbglR3ClipboardConnectEx(). */
625	uint64_t fGuestFeatures;
626	/** The context ID - input or/and output depending on the operation. */
627	uint64_t idContext;
628	/** OUT: Number of parameters retrieved.
629	* This is set by ??. */
630	uint32_t cParmsRecived;
631	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
632	/** Data related to Shared Clipboard file transfers. */
633	VBGLR3SHCLTRANSFERCMDCTX Transfers;
634	# endif
635	} VBGLR3SHCLCMDCTX;
636	/** Pointer to a shared clipboard context for Vbgl. */
637	typedef VBGLR3SHCLCMDCTX *PVBGLR3SHCLCMDCTX;
638
639	/**
640	* Enumeration specifying a Shared Clipboard event type.
641	* @todo r=bird: Surely, this isn't necessary?!
642	*/
643	typedef enum _VBGLR3CLIPBOARDEVENTTYPE
644	{
645	/** No event needed / defined. */
646	VBGLR3CLIPBOARDEVENTTYPE_NONE = 0,
647	/** Host reports available clipboard formats to the guest. */
648	VBGLR3CLIPBOARDEVENTTYPE_REPORT_FORMATS,
649	/** Host wants to read Shared Clipboard data from the guest. */
650	VBGLR3CLIPBOARDEVENTTYPE_READ_DATA,
651	/** Terminates the Shared Clipboard service. */
652	VBGLR3CLIPBOARDEVENTTYPE_QUIT,
653	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
654	/** Reports a transfer status to the guest. */
655	VBGLR3CLIPBOARDEVENTTYPE_TRANSFER_STATUS,
656	# endif
657	/** Blow the type up to 32-bit. */
658	VBGLR3CLIPBOARDEVENTTYPE_32BIT_HACK = 0x7fffffff
659	} VBGLR3CLIPBOARDEVENTTYPE;
660
661	/**
662	* Structure for keeping a Shared Clipboard VbglR3 event.
663	*/
664	typedef struct _VBGLR3CLIPBOARDEVENT
665	{
666	/** The event type the union contains. */
667	VBGLR3CLIPBOARDEVENTTYPE enmType;
668	/** Command context bound to this event. */
669	VBGLR3SHCLCMDCTX cmdCtx;
670	union
671	{
672	/** Reports available formats from the host. */
673	SHCLFORMATS fReportedFormats;
674	/** Reports that data needs to be read from the guest. */
675	SHCLFORMAT fReadData;
676	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
677	/** Reports a transfer status to the guest. */
678	struct
679	{
680	/** ID of the trnasfer. */
681	SHCLTRANSFERID uID;
682	/** Transfer direction. */
683	SHCLTRANSFERDIR enmDir;
684	/** Additional reproting information. */
685	SHCLTRANSFERREPORT Report;
686	} TransferStatus;
687	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
688	} u;
689	} VBGLR3CLIPBOARDEVENT, *PVBGLR3CLIPBOARDEVENT;
690	typedef const PVBGLR3CLIPBOARDEVENT CPVBGLR3CLIPBOARDEVENT;
691
692	/** @todo r=bird: I'm not sure it is appropriate for the VbglR3 to use types
693	* from VBox/GuestHost/SharedClipboard.h, doesn't seem clean to me. /
694
695	VBGLR3DECL(int) VbglR3ClipboardConnect(HGCMCLIENTID *pidClient);
696	VBGLR3DECL(int) VbglR3ClipboardDisconnect(HGCMCLIENTID idClient);
697	VBGLR3DECL(int) VbglR3ClipboardGetHostMsgOld(HGCMCLIENTID idClient, uint32_t pMsg, uint32_t pfFormats);
698	VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void pv, uint32_t cb, uint32_t pcb);
699	VBGLR3DECL(int) VbglR3ClipboardReadDataEx(PVBGLR3SHCLCMDCTX pCtx, SHCLFORMAT uFormat, void pvData, uint32_t cbData, uint32_t pcbRead);
700	VBGLR3DECL(int) VbglR3ClipboardWriteData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb);
701	VBGLR3DECL(int) VbglR3ClipboardWriteDataEx(PVBGLR3SHCLCMDCTX pCtx, SHCLFORMAT fFormat, void *pvData, uint32_t cbData);
702	VBGLR3DECL(int) VbglR3ClipboardReportFormats(HGCMCLIENTID idClient, uint32_t fFormats);
703
704	VBGLR3DECL(int) VbglR3ClipboardConnectEx(PVBGLR3SHCLCMDCTX pCtx, uint64_t fGuestFeatures);
705	VBGLR3DECL(int) VbglR3ClipboardDisconnectEx(PVBGLR3SHCLCMDCTX pCtx);
706
707	VBGLR3DECL(int) VbglR3ClipboardReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
708	VBGLR3DECL(int) VbglR3ClipboardQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures);
709	VBGLR3DECL(int) VbglR3ClipboardMsgPeekWait(PVBGLR3SHCLCMDCTX pCtx, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
710	VBGLR3DECL(int) VbglR3ClipboardEventGetNext(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PVBGLR3CLIPBOARDEVENT pEvent);
711	VBGLR3DECL(void) VbglR3ClipboardEventFree(PVBGLR3CLIPBOARDEVENT pEvent);
712
713	VBGLR3DECL(int) VbglR3ClipboardWriteError(HGCMCLIENTID idClient, int rcErr);
714
715	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
716	VBGLR3DECL(void) VbglR3ClipboardTransferSetCallbacks(PSHCLTRANSFERCALLBACKTABLE pCallbacks);
717	VBGLR3DECL(int) VbglR3ClipboardEventGetNextEx(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFERCTX pTransferCtx, PVBGLR3CLIPBOARDEVENT pEvent);
718
719	VBGLR3DECL(int) VbglR3ClipboardTransferStatusReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus);
720
721	VBGLR3DECL(int) VbglR3ClipboardRootListRead(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLIST *ppRootList);
722
723	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReq(PVBGLR3SHCLCMDCTX pCtx, uint32_t *pfRoots);
724	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLIST pRootList);
725	VBGLR3DECL(int) VbglR3ClipboardRootsWrite(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLISTHDR pRoots);
726
727	VBGLR3DECL(int) VbglR3ClipboardListOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);
728	VBGLR3DECL(int) VbglR3ClipboardListOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms);
729	VBGLR3DECL(int) VbglR3ClipboardListOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLLISTHANDLE hList);
730
731	VBGLR3DECL(int) VbglR3ClipboardListCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList);
732	VBGLR3DECL(int) VbglR3ClipboardListCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList);
733
734	VBGLR3DECL(int) VbglR3ClipboardListHdrWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr);
735	VBGLR3DECL(int) VbglR3ClipboardListEntryWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry);
736
737	VBGLR3DECL(int) VbglR3ClipboardObjOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms);
738	VBGLR3DECL(int) VbglR3ClipboardObjOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
739	VBGLR3DECL(int) VbglR3ClipboardObjOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms,
740	PSHCLOBJHANDLE phObj);
741
742	VBGLR3DECL(int) VbglR3ClipboardObjCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj);
743	VBGLR3DECL(int) VbglR3ClipboardObjCloseReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
744	VBGLR3DECL(int) VbglR3ClipboardObjCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj);
745
746	VBGLR3DECL(int) VbglR3ClipboardObjReadRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj, uint32_t pcbToRead,
747	uint32_t *pfFlags);
748	VBGLR3DECL(int) VbglR3ClipboardObjReadSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
749	uint32_t *pcbRead);
750	VBGLR3DECL(int) VbglR3ClipboardObjWriteSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
751	uint32_t *pcbWritten);
752	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
753	/** @} */
754	# endif /* VBOX_WITH_SHARED_CLIPBOARD */
755
756	/** @name Seamless mode
757	* @{ */
758	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
759	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
760	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
761	VBGLR3DECL(int) VbglR3SeamlessSendMonitorPositions(uint32_t cPositions, PRTPOINT pPositions);
762	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
763
764	/** @} */
765
766	/** @name Mouse
767	* @{ */
768	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
769	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
770	/** @} */
771
772	/** @name Video
773	* @{ */
774	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
775	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
776	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
777	const void *pvImg, size_t cbImg);
778	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
779	/** @} */
780
781	/** @name Display
782	* @{ */
783	/** The folder for the video mode hint unix domain socket on Unix-like guests.
784	* @note This can be safely changed as all users are rebuilt in lock-step. */
785	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
786	/** The path to the video mode hint unix domain socket on Unix-like guests. */
787	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
788
789	/** The folder for saving video mode hints to between sessions. */
790	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
791	/** The path to the file for saving video mode hints to between sessions. */
792	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
793
794	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
795	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
796	VBGLR3DECL(int) VbglR3GetDisplayChangeRequestMulti(uint32_t cDisplaysIn, uint32_t *pcDisplaysOut,
797	VMMDevDisplayDef *paDisplays, bool fAck);
798	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
799	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
800	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
801	unsigned x, unsigned y, bool fEnabled);
802	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
803	unsigned px, unsigned py, bool *pfEnabled);
804	/** @} */
805
806	/** @name VRDP
807	* @{ */
808	VBGLR3DECL(int) VbglR3VrdpGetChangeRequest(bool pfActive, uint32_t puExperienceLevel);
809	/** @} */
810
811	/** @name VM Statistics
812	* @{ */
813	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
814	# if defined(VBOX_INCLUDED_VMMDev_h) \|\| defined(DOXYGEN_RUNNING)
815	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
816	# endif
817	/** @} */
818
819	/** @name Memory ballooning
820	* @{ */
821	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
822	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
823	/** @} */
824
825	/** @name Core Dump
826	* @{ */
827	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
828
829	/** @} */
830
831	/** @name DRM client handling
832	* @{ */
833	/** Guest property names pattern which is used by Guest Additions DRM services. */
834	# define VBGLR3DRMPROPPTR "/VirtualBox/GuestAdd/DRM*"
835	/** Guest property that defines if the DRM IPC server access should be restricted to a specific user group. */
836	# define VBGLR3DRMIPCPROPRESTRICT "/VirtualBox/GuestAdd/DRMIpcRestricted"
837
838	VBGLR3DECL(bool) VbglR3DrmClientIsNeeded(void);
839	VBGLR3DECL(bool) VbglR3DrmRestrictedIpcAccessIsNeeded(void);
840	VBGLR3DECL(bool) VbglR3DrmClientIsRunning(void);
841	VBGLR3DECL(int) VbglR3DrmClientStart(void);
842	VBGLR3DECL(int) VbglR3DrmLegacyClientStart(void);
843	VBGLR3DECL(int) VbglR3DrmLegacyX11AgentStart(void);
844	/** @} */
845
846	# ifdef VBOX_WITH_GUEST_PROPS
847	/** @name Guest properties
848	* @{ */
849	/** @todo Docs. */
850	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
851	/** @todo Docs. */
852	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
853	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
854	VBGLR3DECL(int) VbglR3GuestPropDisconnect(HGCMCLIENTID idClient);
855	VBGLR3DECL(bool) VbglR3GuestPropExist(uint32_t idClient, const char *pszPropName);
856	VBGLR3DECL(int) VbglR3GuestPropWrite(HGCMCLIENTID idClient, const char pszName, const char pszValue, const char *pszFlags);
857	VBGLR3DECL(int) VbglR3GuestPropWriteValue(HGCMCLIENTID idClient, const char pszName, const char pszValue);
858	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(HGCMCLIENTID idClient, const char *pszName,
859	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
860	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(HGCMCLIENTID idClient, const char *pszName,
861	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
862	VBGLR3DECL(int) VbglR3GuestPropRead(HGCMCLIENTID idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
863	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
864	VBGLR3DECL(int) VbglR3GuestPropReadEx(uint32_t u32ClientId,
865	const char pszPropName, char ppszValue, char ppszFlags, uint64_t puTimestamp);
866	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
867	uint32_t *pcchValueActual);
868	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(HGCMCLIENTID idClient, const char pszName, char *ppszValue);
869	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
870	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(HGCMCLIENTID idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
871	uint32_t *pcbBufActual);
872	VBGLR3DECL(int) VbglR3GuestPropEnum(HGCMCLIENTID idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
873	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
874	uint64_t pu64Timestamp, char const *ppszFlags);
875	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
876	uint64_t pu64Timestamp, char const *ppszFlags);
877	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
878	VBGLR3DECL(int) VbglR3GuestPropDelete(HGCMCLIENTID idClient, const char *pszName);
879	VBGLR3DECL(int) VbglR3GuestPropDelSet(HGCMCLIENTID idClient, char const * const *papszPatterns, uint32_t cPatterns);
880	VBGLR3DECL(int) VbglR3GuestPropWait(HGCMCLIENTID idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
881	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
882	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual, bool *pfWasDeleted);
883	/** @} */
884
885	/** @name Guest user handling / reporting.
886	* @{ */
887	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
888	uint8_t *pbDetails, uint32_t cbDetails);
889	/** @} */
890
891	/** @name Host version handling
892	* @{ */
893	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(HGCMCLIENTID idClient, bool pfUpdate, char *ppszHostVersion,
894	char **ppszGuestVersion);
895	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(HGCMCLIENTID idClient, char **ppszVer);
896	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(HGCMCLIENTID idClient, const char *pszVer);
897	/** @} */
898	# endif /* VBOX_WITH_GUEST_PROPS defined */
899
900	# ifdef VBOX_WITH_SHARED_FOLDERS
901	/** @name Shared folders
902	* @{ */
903	/**
904	* Structure containing mapping information for a shared folder.
905	*/
906	typedef struct VBGLR3SHAREDFOLDERMAPPING
907	{
908	/** Mapping status. */
909	uint32_t u32Status;
910	/** Root handle. */
911	uint32_t u32Root;
912	} VBGLR3SHAREDFOLDERMAPPING;
913	/** Pointer to a shared folder mapping information structure. */
914	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
915	/** Pointer to a const shared folder mapping information structure. */
916	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
917
918	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
919	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient);
920	VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName);
921	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
922	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
923	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
924	VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient,uint32_t u32Root, char ppszName); /< @todo r=bird: GET functions return the value, not a status code!*/
925	VBGLR3DECL(int) VbglR3SharedFolderQueryFolderInfo(HGCMCLIENTID idClient, uint32_t idRoot, uint64_t fQueryFlags,
926	char ppszName, char ppszMountPoint,
927	uint64_t pfFlags, uint32_t puRootIdVersion);
928	VBGLR3DECL(int) VbglR3SharedFolderWaitForMappingsChanges(HGCMCLIENTID idClient, uint32_t uPrevVersion, uint32_t *puCurVersion);
929	VBGLR3DECL(int) VbglR3SharedFolderCancelMappingsChangesWaits(HGCMCLIENTID idClient);
930
931	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char ppszPrefix); /< @todo r=bird: GET functions return the value, not a status code! */
932	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char ppszDir); /< @todo r=bird: GET functions return the value, not a status code! */
933	/** @} */
934	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
935
936	# ifdef VBOX_WITH_GUEST_CONTROL
937	/** @name Guest control
938	* @{ */
939
940	/**
941	* Structure containing the context required for
942	* either retrieving or sending a HGCM guest control
943	* commands from or to the host.
944	*
945	* @note Do not change parameter order without also adapting all structure
946	* initializers.
947	*/
948	typedef struct VBGLR3GUESTCTRLCMDCTX
949	{
950	/** @todo This struct could be handy if we want to implement
951	* a second communication channel, e.g. via TCP/IP.
952	* Use a union for the HGCM stuff then. */
953
954	/** IN: HGCM client ID to use for communication. */
955	uint32_t uClientID;
956	/** IN/OUT: Context ID to retrieve or to use. */
957	uint32_t uContextID;
958	/** IN: Protocol version to use. */
959	uint32_t uProtocol;
960	/** OUT: Number of parameters retrieved. */
961	uint32_t uNumParms;
962	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
963
964	/**
965	* Structure holding information for starting a guest
966	* session.
967	*/
968	typedef struct VBGLR3GUESTCTRLSESSIONSTARTUPINFO
969	{
970	/** The session's protocol version to use. */
971	uint32_t uProtocol;
972	/** The session's ID. */
973	uint32_t uSessionID;
974	/** User name (account) to start the guest session under. */
975	char *pszUser;
976	/** Size (in bytes) of allocated pszUser. */
977	uint32_t cbUser;
978	/** Password of specified user name (account). */
979	char *pszPassword;
980	/** Size (in bytes) of allocated pszPassword. */
981	uint32_t cbPassword;
982	/** Domain of the user account. */
983	char *pszDomain;
984	/** Size (in bytes) of allocated pszDomain. */
985	uint32_t cbDomain;
986	/** Session creation flags.
987	* @sa VBOXSERVICECTRLSESSIONSTARTUPFLAG_* flags. */
988	uint32_t fFlags;
989	} VBGLR3GUESTCTRLSESSIONSTARTUPINFO;
990	/** Pointer to a guest session startup info. */
991	typedef VBGLR3GUESTCTRLSESSIONSTARTUPINFO *PVBGLR3GUESTCTRLSESSIONSTARTUPINFO;
992
993	/**
994	* Structure holding information for starting a guest
995	* process.
996	*/
997	typedef struct VBGLR3GUESTCTRLPROCSTARTUPINFO
998	{
999	/** Full qualified path of process to start (without arguments).
1000	* Note: This is not argv[0]! */
1001	char *pszCmd;
1002	/** Size (in bytes) of allocated pszCmd. */
1003	uint32_t cbCmd;
1004	/** Process execution flags. @sa */
1005	uint32_t fFlags;
1006	/** Command line arguments. */
1007	char *pszArgs;
1008	/** Size (in bytes) of allocated pszArgs. */
1009	uint32_t cbArgs;
1010	/** Number of arguments specified in pszArgs. */
1011	uint32_t cArgs;
1012	/** String of environment variables ("FOO=BAR") to pass to the process
1013	* to start. */
1014	char *pszEnv;
1015	/** Size (in bytes) of environment variables block. */
1016	uint32_t cbEnv;
1017	/** Number of environment variables specified in pszEnv. */
1018	uint32_t cEnvVars;
1019	/** User name (account) to start the process under. */
1020	char *pszUser;
1021	/** Size (in bytes) of allocated pszUser. */
1022	uint32_t cbUser;
1023	/** Password of specified user name (account). */
1024	char *pszPassword;
1025	/** Size (in bytes) of allocated pszPassword. */
1026	uint32_t cbPassword;
1027	/** Domain to be used for authenticating the specified user name (account). */
1028	char *pszDomain;
1029	/** Size (in bytes) of allocated pszDomain. */
1030	uint32_t cbDomain;
1031	/** Time limit (in ms) of the process' life time. */
1032	uint32_t uTimeLimitMS;
1033	/** Process priority. */
1034	uint32_t uPriority;
1035	/** Process affinity block. At the moment we support
1036	* up to 4 blocks, that is, 4 * 64 = 256 CPUs total. */
1037	uint64_t uAffinity[4];
1038	/** Number of used process affinity blocks. */
1039	uint32_t cAffinity;
1040	} VBGLR3GUESTCTRLPROCSTARTUPINFO;
1041	/** Pointer to a guest process startup info. */
1042	typedef VBGLR3GUESTCTRLPROCSTARTUPINFO *PVBGLR3GUESTCTRLPROCSTARTUPINFO;
1043
1044	/* General message handling on the guest. */
1045	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
1046	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t idClient);
1047	VBGLR3DECL(bool) VbglR3GuestCtrlSupportsOptimizations(uint32_t idClient);
1048	VBGLR3DECL(int) VbglR3GuestCtrlMakeMeMaster(uint32_t idClient);
1049	VBGLR3DECL(int) VbglR3GuestCtrlReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1050	VBGLR3DECL(int) VbglR3GuestCtrlQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures);
1051	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
1052	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
1053	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
1054	void *pvPayload, uint32_t cbPayload);
1055	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg);
1056	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t uClientId);
1057	VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
1058	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
1059	/* Guest session handling. */
1060	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInit(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1061	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInitEx(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo, size_t cbUser, size_t cbPassword, size_t cbDomain);
1062	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoDestroy(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1063	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoFree(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1064	VBGLR3DECL(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO) VbglR3GuestCtrlSessionStartupInfoDup(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1065	VBGLR3DECL(int) VbglR3GuestCtrlSessionPrepare(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1066	VBGLR3DECL(int) VbglR3GuestCtrlSessionAccept(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1067	VBGLR3DECL(int) VbglR3GuestCtrlSessionCancelPrepared(uint32_t idClient, uint32_t idSession);
1068	VBGLR3DECL(int) VbglR3GuestCtrlSessionHasChanged(uint32_t idClient, uint64_t idNewControlSession);
1069	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
1070	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, int32_t iResult);
1071	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLSESSIONSTARTUPINFO *ppStartupInfo);
1072	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t pidSession);
1073	/* Guest path handling. */
1074	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
1075	uint32_t cbDest, uint32_t *pfFlags);
1076	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx);
1077	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx);
1078	VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction);
1079	/* Guest process execution. */
1080	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInit(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1081	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInitEx(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo, size_t cbCmd, size_t cbUser, size_t cbPassword, size_t cbDomain, size_t cbArgs, size_t cbEnv);
1082	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoDestroy(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1083	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoFree(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1084	VBGLR3DECL(PVBGLR3GUESTCTRLPROCSTARTUPINFO) VbglR3GuestCtrlProcStartupInfoDup(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1085	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLPROCSTARTUPINFO *ppStartupInfo);
1086	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
1087	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
1088	uint32_t cbData, uint32_t *pcbSize);
1089	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
1090	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
1091	uint32_t *puTimeoutMS);
1092	/* Guest native directory handling. */
1093	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
1094	/* Guest native file handling. */
1095	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
1096	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
1097	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
1098	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1099	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
1100	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1101	uint32_t puToRead, uint64_t poffRead);
1102	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1103	void pvData, uint32_t cbData, uint32_t pcbActual);
1104	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
1105	uint32_t pcbActual, uint64_t poffWrite);
1106	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1107	uint32_t puSeekMethod, uint64_t poffSeek);
1108	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1109	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint64_t pcbNew);
1110
1111	/* Guest -> Host. */
1112	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
1113	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1114	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1115	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
1116	VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
1117	void *pvData, uint32_t cbData, int64_t offNew);
1118	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten);
1119	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew);
1120
1121	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1122	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1123	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew);
1124	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
1125	void *pvData, uint32_t cbData);
1126	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
1127	void *pvData, uint32_t cbData);
1128	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
1129	uint32_t fFlags, uint32_t cbWritten);
1130
1131	/** @} */
1132	# endif /* VBOX_WITH_GUEST_CONTROL defined */
1133
1134	/** @name Auto-logon handling
1135	* @{ */
1136	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
1137	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
1138	/** @} */
1139
1140	/** @name User credentials handling
1141	* @{ */
1142	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
1143	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
1144	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
1145	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
1146	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
1147	uint32_t cPasses);
1148	/** @} */
1149
1150	/** @name CPU hotplug monitor
1151	* @{ */
1152	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
1153	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
1154	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
1155	/** @} */
1156
1157	/** @name Page sharing
1158	* @{ */
1159	struct VMMDEVSHAREDREGIONDESC;
1160	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
1161	unsigned cRegions, struct VMMDEVSHAREDREGIONDESC *pRegions);
1162	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
1163	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
1164	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
1165	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
1166	/** @} */
1167
1168	# ifdef VBOX_WITH_DRAG_AND_DROP
1169	/** @name Drag and Drop
1170	* @{ */
1171	/**
1172	* Structure containing the context required for
1173	* either retrieving or sending a HGCM guest drag'n drop
1174	* commands from or to the host.
1175	*
1176	* Note: Do not change parameter order without also
1177	* adapting all structure initializers.
1178	*/
1179	typedef struct VBGLR3GUESTDNDCMDCTX
1180	{
1181	/** @todo This struct could be handy if we want to implement
1182	* a second communication channel, e.g. via TCP/IP.
1183	* Use a union for the HGCM stuff then. */
1184
1185	/** HGCM client ID to use for communication. */
1186	uint32_t uClientID;
1187	/** The VM's current session ID. */
1188	uint64_t uSessionID;
1189	/** Protocol version to use.
1190	* Deprecated; do not used / rely on it anymore. */
1191	uint32_t uProtocolDeprecated;
1192	/** Host feature flags (VBOX_DND_HF_XXX).
1193	* This is set by VbglR3DnDConnect(). */
1194	uint64_t fHostFeatures;
1195	/** The guest feature flags reported to the host (VBOX_DND_GF_XXX).
1196	* This is set by VbglR3DnDConnect(). */
1197	uint64_t fGuestFeatures;
1198	/** Number of parameters retrieved for the current command. */
1199	uint32_t uNumParms;
1200	/** Max chunk size (in bytes) for data transfers. */
1201	uint32_t cbMaxChunkSize;
1202	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
1203
1204	/**
1205	* Enumeration for specifying the DnD meta data type.
1206	*/
1207	typedef enum VBGLR3GUESTDNDMETADATATYPE
1208	{
1209	/** Unknown meta data type; don't use. */
1210	VBGLR3GUESTDNDMETADATATYPE_UNKNOWN = 0,
1211	/** Raw meta data; can be everything. */
1212	VBGLR3GUESTDNDMETADATATYPE_RAW,
1213	/** Meta data is a transfer list, specifying objects. */
1214	VBGLR3GUESTDNDMETADATATYPE_URI_LIST,
1215	/** Blow the type up to 32-bit. */
1216	VBGLR3GUESTDNDMETADATATYPE_32BIT_HACK = 0x7fffffff
1217	} VBGLR3GUESTDNDMETADATATYPE;
1218
1219	/**
1220	* Structure for keeping + handling DnD meta data.
1221	*/
1222	typedef struct VBGLR3GUESTDNDMETADATA
1223	{
1224	/** The meta data type the union contains. */
1225	VBGLR3GUESTDNDMETADATATYPE enmType;
1226	/** Union based on \a enmType. */
1227	union
1228	{
1229	struct
1230	{
1231	/** Pointer to actual meta data. */
1232	void *pvMeta;
1233	/** Size (in bytes) of meta data. */
1234	uint32_t cbMeta;
1235	} Raw;
1236	struct
1237	{
1238	DNDTRANSFERLIST Transfer;
1239	} URI;
1240	} u;
1241	} VBGLR3GUESTDNDMETADATA;
1242
1243	/** Pointer to VBGLR3GUESTDNDMETADATA. */
1244	typedef VBGLR3GUESTDNDMETADATA *PVBGLR3GUESTDNDMETADATA;
1245
1246	/** Const pointer to VBGLR3GUESTDNDMETADATA. */
1247	typedef const PVBGLR3GUESTDNDMETADATA CPVBGLR3GUESTDNDMETADATA;
1248
1249	/**
1250	* Enumeration specifying a DnD event type.
1251	*/
1252	typedef enum VBGLR3DNDEVENTTYPE
1253	{
1254	VBGLR3DNDEVENTTYPE_INVALID = 0,
1255	VBGLR3DNDEVENTTYPE_CANCEL,
1256	VBGLR3DNDEVENTTYPE_HG_ERROR,
1257	VBGLR3DNDEVENTTYPE_HG_ENTER,
1258	VBGLR3DNDEVENTTYPE_HG_MOVE,
1259	VBGLR3DNDEVENTTYPE_HG_LEAVE,
1260	VBGLR3DNDEVENTTYPE_HG_DROP,
1261	VBGLR3DNDEVENTTYPE_HG_RECEIVE,
1262	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1263	VBGLR3DNDEVENTTYPE_GH_ERROR,
1264	VBGLR3DNDEVENTTYPE_GH_REQ_PENDING,
1265	VBGLR3DNDEVENTTYPE_GH_DROP,
1266	# endif
1267	/** Tells the caller that it has to quit operation. */
1268	VBGLR3DNDEVENTTYPE_QUIT,
1269	/** Blow the type up to 32-bit. */
1270	VBGLR3DNDEVENTTYPE_32BIT_HACK = 0x7fffffff
1271	} VBGLR3DNDEVENTTYPE;
1272
1273	typedef struct VBGLR3DNDEVENT
1274	{
1275	/** The event type the union contains. */
1276	VBGLR3DNDEVENTTYPE enmType;
1277	union
1278	{
1279	struct
1280	{
1281	/** Screen ID this request belongs to. */
1282	uint32_t uScreenID;
1283	/** Format list (UTF-8, \r\n separated). */
1284	char *pszFormats;
1285	/** Size (in bytes) of pszFormats (\0 included). */
1286	uint32_t cbFormats;
1287	/** List of allowed DnD actions. */
1288	VBOXDNDACTIONLIST dndLstActionsAllowed;
1289	} HG_Enter;
1290	struct
1291	{
1292	/** Absolute X position of guest screen. */
1293	uint32_t uXpos;
1294	/** Absolute Y position of guest screen. */
1295	uint32_t uYpos;
1296	/** Default DnD action. */
1297	VBOXDNDACTION dndActionDefault;
1298	} HG_Move;
1299	struct
1300	{
1301	/** Absolute X position of guest screen. */
1302	uint32_t uXpos;
1303	/** Absolute Y position of guest screen. */
1304	uint32_t uYpos;
1305	/** Default DnD action. */
1306	VBOXDNDACTION dndActionDefault;
1307	} HG_Drop;
1308	struct
1309	{
1310	/** Meta data for the operation. */
1311	VBGLR3GUESTDNDMETADATA Meta;
1312	} HG_Received;
1313	struct
1314	{
1315	/** IPRT-style error code. */
1316	int rc;
1317	} HG_Error;
1318	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1319	struct
1320	{
1321	/** Screen ID this request belongs to. */
1322	uint32_t uScreenID;
1323	} GH_IsPending;
1324	struct
1325	{
1326	/** Requested format by the host. */
1327	char *pszFormat;
1328	/** Size (in bytes) of pszFormat (\0 included). */
1329	uint32_t cbFormat;
1330	/** Requested DnD action. */
1331	VBOXDNDACTION dndActionRequested;
1332	} GH_Drop;
1333	# endif
1334	} u;
1335	} VBGLR3DNDEVENT;
1336	typedef VBGLR3DNDEVENT *PVBGLR3DNDEVENT;
1337	typedef const PVBGLR3DNDEVENT CPVBGLR3DNDEVENT;
1338
1339	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1340	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1341
1342	VBGLR3DECL(int) VbglR3DnDReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1343	VBGLR3DECL(int) VbglR3DnDSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
1344
1345	VBGLR3DECL(int) VbglR3DnDEventGetNext(PVBGLR3GUESTDNDCMDCTX pCtx, PVBGLR3DNDEVENT *ppEvent);
1346	VBGLR3DECL(void) VbglR3DnDEventFree(PVBGLR3DNDEVENT pEvent);
1347
1348	VBGLR3DECL(int) VbglR3DnDHGSendAckOp(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndAction);
1349	VBGLR3DECL(int) VbglR3DnDHGSendReqData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pcszFormat);
1350	VBGLR3DECL(int) VbglR3DnDHGSendProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
1351	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1352	VBGLR3DECL(int) VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndActionDefault, VBOXDNDACTIONLIST dndLstActionsAllowed, const char* pcszFormats, uint32_t cbFormats);
1353	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
1354	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
1355	/** @} */
1356	# endif /* VBOX_WITH_DRAG_AND_DROP */
1357
1358	/* Generic Host Channel Service. */
1359	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pidClient);
1360	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t idClient);
1361	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1362	const char *pszName, uint32_t u32Flags);
1363	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1364	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1365	void *pvData, uint32_t cbData);
1366	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1367	void *pvData, uint32_t cbData,
1368	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
1369	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1370	uint32_t u32Code, void *pvParm, uint32_t cbParm,
1371	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
1372	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1373	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
1374	uint32_t *pu32SizeReturned);
1375	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1376	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
1377	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
1378	uint32_t *pu32SizeDataReturned);
1379
1380	/** @name Mode hint storage
1381	* @{ */
1382	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
1383	unsigned cy, unsigned cBPP, unsigned *x,
1384	unsigned y, unsigned fEnabled);
1385	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
1386	unsigned cy, unsigned cBPP, unsigned x,
1387	unsigned y, unsigned fEnabled);
1388	/** @} */
1389
1390	/** @name Generic HGCM
1391	* @{ */
1392	VBGLR3DECL(int) VbglR3HGCMConnect(const char pszServiceName, HGCMCLIENTID pidClient);
1393	VBGLR3DECL(int) VbglR3HGCMDisconnect(HGCMCLIENTID idClient);
1394	struct VBGLIOCHGCMCALL;
1395	VBGLR3DECL(int) VbglR3HGCMCall(struct VBGLIOCHGCMCALL *pInfo, size_t cbInfo);
1396	/** @} */
1397
1398	#endif /* IN_RING3 */
1399	/** @} */
1400
1401	RT_C_DECLS_END
1402
1403	/** @} */
1404
1405	#endif /* !VBOX_INCLUDED_VBoxGuestLib_h */

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

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

Download in other formats: