VBoxGuestLib.h@ 99088

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

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

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

Download in other formats: