VBoxGuestLib.h@ 100355

最後變更在這個檔案從100355是 100267,由 vboxsync 提交於 20 月前
Additions: Make the R0 physical heap configurable to allow for allocations >= 4GiB if supported by the VBox device (the MMIO request path is available), add support for the MMIO request path required for ARM, bugref:10457
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Author Date Id Revision`
檔案大小: 66.1 KB

行
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, uintptr_t volatile pMmioReq, 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	DECLR0VBGL(void) VbglR0GRFree(struct VMMDevRequestHeader *pReq);
219
220	/**
221	* Verify the generic request header.
222	*
223	* @param pReq pointer the request header structure.
224	* @param cbReq size of the request memory block. It should be equal to the request size
225	* for fixed size requests. It can be greater than the request size for
226	* variable size requests.
227	*
228	* @return VBox status code.
229	*/
230	DECLR0VBGL(int) VbglGR0Verify(const struct VMMDevRequestHeader *pReq, size_t cbReq);
231
232	/** @} */
233
234	# ifdef VBOX_WITH_HGCM
235	struct VBGLIOCHGCMCALL;
236	struct VBGLIOCIDCHGCMFASTCALL;
237
238	# ifdef VBGL_VBOXGUEST
239
240	/**
241	* Callback function called from HGCM helpers when a wait for request
242	* completion IRQ is required.
243	*
244	* @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
245	* @param pvData VBoxGuest pointer to be passed to callback.
246	* @param u32Data VBoxGuest 32 bit value to be passed to callback.
247	*/
248	typedef DECLCALLBACKTYPE(int, FNVBGLHGCMCALLBACK,(VMMDevHGCMRequestHeader pHeader, void pvData, uint32_t u32Data));
249	/** Pointer to a FNVBGLHGCMCALLBACK. */
250	typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
251
252	/**
253	* Perform a connect request.
254	*
255	* That is locate required service and obtain a client identifier for future
256	* access.
257	*
258	* @note This function can NOT handle cancelled requests!
259	*
260	* @param pLoc The service to connect to.
261	* @param fRequestor VMMDEV_REQUESTOR_XXX.
262	* @param pidClient Where to return the client ID on success.
263	* @param pfnAsyncCallback Required pointer to function that is calledwhen
264	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
265	* implements waiting for an IRQ in this function.
266	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
267	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
268	*
269	* @return VBox status code.
270	*/
271	DECLR0VBGL(int) VbglR0HGCMInternalConnect(HGCMServiceLocation const pLoc, uint32_t fRequestor, HGCMCLIENTID pidClient,
272	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
273
274
275	/**
276	* Perform a disconnect request.
277	*
278	* That is tell the host that the client will not call the service anymore.
279	*
280	* @note This function can NOT handle cancelled requests!
281	*
282	* @param idClient The client ID to disconnect.
283	* @param fRequestor VMMDEV_REQUESTOR_XXX.
284	* @param pfnAsyncCallback Required pointer to function that is called when
285	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
286	* implements waiting for an IRQ in this function.
287	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
288	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
289	* callback.
290	*
291	* @return VBox status code.
292	*/
293
294	DECLR0VBGL(int) VbglR0HGCMInternalDisconnect(HGCMCLIENTID idClient, uint32_t fRequestor,
295	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
296
297	/** Call a HGCM service.
298	*
299	* @note This function can deal with cancelled requests.
300	*
301	* @param pCallInfo The request data.
302	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
303	* @param fRequestor VMMDEV_REQUESTOR_XXX.
304	* @param pfnAsyncCallback Required pointer to function that is called when
305	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
306	* implements waiting for an IRQ in this function.
307	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
308	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
309	*
310	* @return VBox status code.
311	*/
312	DECLR0VBGL(int) VbglR0HGCMInternalCall(struct VBGLIOCHGCMCALL *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags, uint32_t fRequestor,
313	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
314
315	/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
316	*
317	* @note This function can deal with cancelled requests.
318	*
319	* @param pCallInfo The request data.
320	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
321	* @param fRequestor VMMDEV_REQUESTOR_XXX.
322	* @param pfnAsyncCallback Required pointer to function that is called when
323	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
324	* implements waiting for an IRQ in this function.
325	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
326	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
327	*
328	* @return VBox status code.
329	*/
330	DECLR0VBGL(int) VbglR0HGCMInternalCall32(struct VBGLIOCHGCMCALL *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags, uint32_t fRequestor,
331	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
332
333	/** @name VbglR0HGCMInternalCall flags
334	* @{ */
335	/** User mode request.
336	* Indicates that only user mode addresses are permitted as parameters. */
337	#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
338	/** Kernel mode request.
339	* Indicates that kernel mode addresses are permitted as parameters. Whether or
340	* not user mode addresses are permitted is, unfortunately, OS specific. The
341	* following OSes allows user mode addresses: Windows, TODO.
342	*/
343	#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
344	/** Mode mask. */
345	#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
346	/** @} */
347
348	# else /* !VBGL_VBOXGUEST */
349
350	#ifndef VBGL_VBOXGUEST
351	/** @internal */
352	typedef struct VBGLHGCMHANDLEDATA
353	{
354	uint32_t fAllocated;
355	VBGLIDCHANDLE IdcHandle;
356	} VBGLHGCMHANDLEDATA;
357	#else
358	struct VBGLHGCMHANDLEDATA;
359	#endif
360
361	typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
362
363	/** @name HGCM functions
364	* @{
365	*/
366
367	/**
368	* Initializes HGCM in the R0 guest library. Must be called before any HGCM
369	* connections are made. Is called by VbglInitClient().
370	*
371	* @return VBox status code.
372	*/
373	DECLR0VBGL(int) VbglR0HGCMInit(void);
374
375	/**
376	* Terminates HGCM in the R0 guest library. Is called by VbglTerminate().
377	*
378	* @return VBox status code.
379	*/
380	DECLR0VBGL(int) VbglR0HGCMTerminate(void);
381
382	/**
383	* Connect to a service.
384	*
385	* @param pHandle Pointer to variable that will hold a handle to be used
386	* further in VbglHGCMCall and VbglHGCMClose.
387	* @param pszServiceName The service to connect to.
388	* @param pidClient Where to return the client ID for the connection.
389	*
390	* @return VBox status code.
391	*
392	* @todo consider baking the client Id into the handle.
393	*/
394	DECLR0VBGL(int) VbglR0HGCMConnect(VBGLHGCMHANDLE pHandle, const char pszServiceName, HGCMCLIENTID *pidClient);
395
396	/**
397	* Connect to a service.
398	*
399	* @param handle Handle of the connection.
400	* @param idClient The ID of the client connection.
401	*
402	* @return VBox status code.
403	*
404	* @todo consider baking the client Id into the handle.
405	*/
406	DECLR0VBGL(int) VbglR0HGCMDisconnect(VBGLHGCMHANDLE handle, HGCMCLIENTID idClient);
407
408	/**
409	* Call to a service, returning only the I/O control status code.
410	*
411	* @param handle Handle of the connection.
412	* @param pData Call request information structure, including function parameters.
413	* @param cbData Length in bytes of data.
414	*
415	* @return VBox status code.
416	*/
417	DECLR0VBGL(int) VbglR0HGCMCallRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
418
419	/**
420	* Call to a service, returning the HGCM status code.
421	*
422	* @param handle Handle of the connection.
423	* @param pData Call request information structure, including function parameters.
424	* @param cbData Length in bytes of data.
425	*
426	* @return VBox status code. Either the I/O control status code if that failed,
427	* or the HGCM status code (pData->Hdr.rc).
428	*/
429	DECLR0VBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
430
431	/**
432	* Call to a service with user-mode data received by the calling driver from the User-Mode process.
433	* The call must be done in the context of a calling process.
434	*
435	* @param handle Handle of the connection.
436	* @param pData Call request information structure, including function parameters.
437	* @param cbData Length in bytes of data.
438	*
439	* @return VBox status code.
440	*/
441	DECLR0VBGL(int) VbglR0HGCMCallUserDataRaw(VBGLHGCMHANDLE handle, struct VBGLIOCHGCMCALL *pData, uint32_t cbData);
442
443	/**
444	* Call to a service, w/o any repacking and buffer locking in VBoxGuest,
445	* returning the only request related status code (not HGCM).
446	*
447	* The driver only submits the request and waits for completion, nothing else.
448	*
449	* @param hHandle The connection handle.
450	* @param pCallReq The call request. Will be passed directly to the host.
451	* @param cbCallReq The size of the whole call request.
452	*
453	* @return VBox status code.
454	*
455	* @remarks The result of the HGCM call is found in
456	* @a pCallReq->HgcmCallReq.header.result on a successful return. The
457	* @a pCallReq->Hdr.rc and @a pCallReq->HgcmCallReq.header.header.rc
458	* fields are the same as the return value and can safely be ignored.
459	*/
460	DECLR0VBGL(int) VbglR0HGCMFastCall(VBGLHGCMHANDLE hHandle, struct VBGLIOCIDCHGCMFASTCALL *pCallReq, uint32_t cbCallReq);
461
462	/** @} */
463
464	/** @name Undocumented helpers for talking to the Chromium OpenGL Host Service
465	* @{ */
466	typedef VBGLHGCMHANDLE VBGLCRCTLHANDLE;
467	DECLR0VBGL(int) VbglR0CrCtlCreate(VBGLCRCTLHANDLE *phCtl);
468	DECLR0VBGL(int) VbglR0CrCtlDestroy(VBGLCRCTLHANDLE hCtl);
469	DECLR0VBGL(int) VbglR0CrCtlConConnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID *pidClient);
470	DECLR0VBGL(int) VbglR0CrCtlConDisconnect(VBGLCRCTLHANDLE hCtl, HGCMCLIENTID idClient);
471	struct VBGLIOCHGCMCALL;
472	DECLR0VBGL(int) VbglR0CrCtlConCallRaw(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
473	DECLR0VBGL(int) VbglR0CrCtlConCall(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
474	DECLR0VBGL(int) VbglR0CrCtlConCallUserDataRaw(VBGLCRCTLHANDLE hCtl, struct VBGLIOCHGCMCALL *pCallInfo, int cbCallInfo);
475	/** @} */
476
477	# endif /* !VBGL_VBOXGUEST */
478
479	# endif /* VBOX_WITH_HGCM */
480
481
482	/**
483	* Initialize the heap.
484	*
485	* @returns VBox status code.
486	* @param fAlloc32BitAddr Flag whether all allocations should be below 4GiB,
487	* so they fit into a 32-bit address.
488	*/
489	DECLR0VBGL(int) VbglR0PhysHeapInit(bool fAlloc32BitAddr);
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(RTCCPHYS) 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	SHCLTRANSFERCALLBACKS 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 transfer. */
693	SHCLTRANSFERID uID;
694	/** Transfer direction. */
695	SHCLTRANSFERDIR enmDir;
696	/** Additional reporting 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) VbglR3ClipboardMsgPeek(PVBGLR3SHCLCMDCTX pCtx, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
722	VBGLR3DECL(int) VbglR3ClipboardMsgPeekWait(PVBGLR3SHCLCMDCTX pCtx, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
723	VBGLR3DECL(int) VbglR3ClipboardEventGetNext(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PVBGLR3CLIPBOARDEVENT pEvent);
724	VBGLR3DECL(void) VbglR3ClipboardEventFree(PVBGLR3CLIPBOARDEVENT pEvent);
725
726	VBGLR3DECL(int) VbglR3ClipboardWriteError(HGCMCLIENTID idClient, int rcErr);
727
728	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
729	VBGLR3DECL(void) VbglR3ClipboardTransferSetCallbacks(PSHCLTRANSFERCALLBACKS pCallbacks);
730	VBGLR3DECL(int) VbglR3ClipboardEventGetNextEx(uint32_t idMsg, uint32_t cParms, PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFERCTX pTransferCtx, PVBGLR3CLIPBOARDEVENT pEvent);
731
732	VBGLR3DECL(int) VbglR3ClipboardTransferStatusReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus);
733
734	VBGLR3DECL(int) VbglR3ClipboardRootListRead(PVBGLR3SHCLCMDCTX pCtx, PSHCLLIST *ppRootList);
735
736	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReq(PVBGLR3SHCLCMDCTX pCtx, uint32_t *pfRoots);
737	VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLLIST pRootList);
738	VBGLR3DECL(int) VbglR3ClipboardRootsWrite(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHDR pRoots);
739
740	VBGLR3DECL(int) VbglR3ClipboardListOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);
741	VBGLR3DECL(int) VbglR3ClipboardListOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms);
742	VBGLR3DECL(int) VbglR3ClipboardListOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLLISTHANDLE hList);
743
744	VBGLR3DECL(int) VbglR3ClipboardListCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList);
745	VBGLR3DECL(int) VbglR3ClipboardListCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList);
746
747	VBGLR3DECL(int) VbglR3ClipboardListHdrWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr);
748	VBGLR3DECL(int) VbglR3ClipboardListEntryWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry);
749
750	VBGLR3DECL(int) VbglR3ClipboardObjOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms);
751	VBGLR3DECL(int) VbglR3ClipboardObjOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
752	VBGLR3DECL(int) VbglR3ClipboardObjOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms,
753	PSHCLOBJHANDLE phObj);
754
755	VBGLR3DECL(int) VbglR3ClipboardObjCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj);
756	VBGLR3DECL(int) VbglR3ClipboardObjCloseReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj);
757	VBGLR3DECL(int) VbglR3ClipboardObjCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj);
758
759	VBGLR3DECL(int) VbglR3ClipboardObjReadRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj, uint32_t pcbToRead,
760	uint32_t *pfFlags);
761	VBGLR3DECL(int) VbglR3ClipboardObjReadSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
762	uint32_t *pcbRead);
763	VBGLR3DECL(int) VbglR3ClipboardObjWriteSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf,
764	uint32_t *pcbWritten);
765	# endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS */
766	/** @} */
767	# endif /* VBOX_WITH_SHARED_CLIPBOARD */
768
769	/** @name Seamless mode
770	* @{ */
771	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
772	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
773	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
774	VBGLR3DECL(int) VbglR3SeamlessSendMonitorPositions(uint32_t cPositions, PRTPOINT pPositions);
775	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
776
777	/** @} */
778
779	/** @name Mouse
780	* @{ */
781	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
782	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
783	/** @} */
784
785	/** @name Video
786	* @{ */
787	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
788	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
789	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
790	const void *pvImg, size_t cbImg);
791	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
792	/** @} */
793
794	/** @name Display
795	* @{ */
796	/** The folder for the video mode hint unix domain socket on Unix-like guests.
797	* @note This can be safely changed as all users are rebuilt in lock-step. */
798	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
799	/** The path to the video mode hint unix domain socket on Unix-like guests. */
800	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
801
802	/** The folder for saving video mode hints to between sessions. */
803	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
804	/** The path to the file for saving video mode hints to between sessions. */
805	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
806
807	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
808	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
809	VBGLR3DECL(int) VbglR3GetDisplayChangeRequestMulti(uint32_t cDisplaysIn, uint32_t *pcDisplaysOut,
810	VMMDevDisplayDef *paDisplays, bool fAck);
811	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
812	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
813	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
814	unsigned x, unsigned y, bool fEnabled);
815	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
816	unsigned px, unsigned py, bool *pfEnabled);
817	/** @} */
818
819	/** @name VRDP
820	* @{ */
821	VBGLR3DECL(int) VbglR3VrdpGetChangeRequest(bool pfActive, uint32_t puExperienceLevel);
822	/** @} */
823
824	/** @name VM Statistics
825	* @{ */
826	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
827	# if defined(VBOX_INCLUDED_VMMDev_h) \|\| defined(DOXYGEN_RUNNING)
828	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
829	# endif
830	/** @} */
831
832	/** @name Memory ballooning
833	* @{ */
834	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
835	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
836	/** @} */
837
838	/** @name Core Dump
839	* @{ */
840	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
841
842	/** @} */
843
844	/** @name DRM client handling
845	* @{ */
846	/** Guest property names pattern which is used by Guest Additions DRM services. */
847	# define VBGLR3DRMPROPPTR "/VirtualBox/GuestAdd/DRM*"
848	/** Guest property that defines if the DRM IPC server access should be restricted to a specific user group. */
849	# define VBGLR3DRMIPCPROPRESTRICT "/VirtualBox/GuestAdd/DRMIpcRestricted"
850
851	VBGLR3DECL(bool) VbglR3DrmClientIsNeeded(void);
852	VBGLR3DECL(bool) VbglR3DrmRestrictedIpcAccessIsNeeded(void);
853	VBGLR3DECL(bool) VbglR3DrmClientIsRunning(void);
854	VBGLR3DECL(int) VbglR3DrmClientStart(void);
855	VBGLR3DECL(int) VbglR3DrmLegacyClientStart(void);
856	VBGLR3DECL(int) VbglR3DrmLegacyX11AgentStart(void);
857	/** @} */
858
859	# ifdef VBOX_WITH_GUEST_PROPS
860	/** @name Guest properties
861	* @{ */
862	/** @todo Docs. */
863	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
864	/** @todo Docs. */
865	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
866	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
867	VBGLR3DECL(int) VbglR3GuestPropDisconnect(HGCMCLIENTID idClient);
868	VBGLR3DECL(bool) VbglR3GuestPropExist(uint32_t idClient, const char *pszPropName);
869	VBGLR3DECL(int) VbglR3GuestPropWrite(HGCMCLIENTID idClient, const char pszName, const char pszValue, const char *pszFlags);
870	VBGLR3DECL(int) VbglR3GuestPropWriteValue(HGCMCLIENTID idClient, const char pszName, const char pszValue);
871	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(HGCMCLIENTID idClient, const char *pszName,
872	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
873	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(HGCMCLIENTID idClient, const char *pszName,
874	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
875	VBGLR3DECL(int) VbglR3GuestPropRead(HGCMCLIENTID idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
876	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
877	VBGLR3DECL(int) VbglR3GuestPropReadEx(uint32_t u32ClientId,
878	const char pszPropName, char ppszValue, char ppszFlags, uint64_t puTimestamp);
879	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
880	uint32_t *pcchValueActual);
881	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(HGCMCLIENTID idClient, const char pszName, char *ppszValue);
882	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
883	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(HGCMCLIENTID idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
884	uint32_t *pcbBufActual);
885	VBGLR3DECL(int) VbglR3GuestPropEnum(HGCMCLIENTID idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
886	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
887	uint64_t pu64Timestamp, char const *ppszFlags);
888	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
889	uint64_t pu64Timestamp, char const *ppszFlags);
890	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
891	VBGLR3DECL(int) VbglR3GuestPropDelete(HGCMCLIENTID idClient, const char *pszName);
892	VBGLR3DECL(int) VbglR3GuestPropDelSet(HGCMCLIENTID idClient, char const * const *papszPatterns, uint32_t cPatterns);
893	VBGLR3DECL(int) VbglR3GuestPropWait(HGCMCLIENTID idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
894	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
895	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual, bool *pfWasDeleted);
896	/** @} */
897
898	/** @name Guest user handling / reporting.
899	* @{ */
900	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
901	uint8_t *pbDetails, uint32_t cbDetails);
902	/** @} */
903
904	/** @name Host version handling
905	* @{ */
906	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(HGCMCLIENTID idClient, bool pfUpdate, char *ppszHostVersion,
907	char **ppszGuestVersion);
908	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(HGCMCLIENTID idClient, char **ppszVer);
909	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(HGCMCLIENTID idClient, const char *pszVer);
910	/** @} */
911	# endif /* VBOX_WITH_GUEST_PROPS defined */
912
913	# ifdef VBOX_WITH_SHARED_FOLDERS
914	/** @name Shared folders
915	* @{ */
916	/**
917	* Structure containing mapping information for a shared folder.
918	*/
919	typedef struct VBGLR3SHAREDFOLDERMAPPING
920	{
921	/** Mapping status. */
922	uint32_t u32Status;
923	/** Root handle. */
924	uint32_t u32Root;
925	} VBGLR3SHAREDFOLDERMAPPING;
926	/** Pointer to a shared folder mapping information structure. */
927	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
928	/** Pointer to a const shared folder mapping information structure. */
929	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
930
931	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
932	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient);
933	VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName);
934	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
935	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
936	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
937	VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient,uint32_t u32Root, char ppszName); /< @todo r=bird: GET functions return the value, not a status code!*/
938	VBGLR3DECL(int) VbglR3SharedFolderQueryFolderInfo(HGCMCLIENTID idClient, uint32_t idRoot, uint64_t fQueryFlags,
939	char ppszName, char ppszMountPoint,
940	uint64_t pfFlags, uint32_t puRootIdVersion);
941	VBGLR3DECL(int) VbglR3SharedFolderWaitForMappingsChanges(HGCMCLIENTID idClient, uint32_t uPrevVersion, uint32_t *puCurVersion);
942	VBGLR3DECL(int) VbglR3SharedFolderCancelMappingsChangesWaits(HGCMCLIENTID idClient);
943
944	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char ppszPrefix); /< @todo r=bird: GET functions return the value, not a status code! */
945	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char ppszDir); /< @todo r=bird: GET functions return the value, not a status code! */
946	/** @} */
947	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
948
949	# ifdef VBOX_WITH_GUEST_CONTROL
950	/** @name Guest control
951	* @{ */
952
953	/**
954	* Structure containing the context required for
955	* either retrieving or sending a HGCM guest control
956	* commands from or to the host.
957	*
958	* @note Do not change parameter order without also adapting all structure
959	* initializers.
960	*/
961	typedef struct VBGLR3GUESTCTRLCMDCTX
962	{
963	/** @todo This struct could be handy if we want to implement
964	* a second communication channel, e.g. via TCP/IP.
965	* Use a union for the HGCM stuff then. */
966
967	/** IN: HGCM client ID to use for communication. */
968	uint32_t uClientID;
969	/** IN/OUT: Context ID to retrieve or to use. */
970	uint32_t uContextID;
971	/** IN: Protocol version to use. */
972	uint32_t uProtocol;
973	/** OUT: Number of parameters retrieved. */
974	uint32_t uNumParms;
975	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
976
977	/**
978	* Structure holding information for starting a guest
979	* session.
980	*/
981	typedef struct VBGLR3GUESTCTRLSESSIONSTARTUPINFO
982	{
983	/** The session's protocol version to use. */
984	uint32_t uProtocol;
985	/** The session's ID. */
986	uint32_t uSessionID;
987	/** User name (account) to start the guest session under. */
988	char *pszUser;
989	/** Size (in bytes) of allocated pszUser. */
990	uint32_t cbUser;
991	/** Password of specified user name (account). */
992	char *pszPassword;
993	/** Size (in bytes) of allocated pszPassword. */
994	uint32_t cbPassword;
995	/** Domain of the user account. */
996	char *pszDomain;
997	/** Size (in bytes) of allocated pszDomain. */
998	uint32_t cbDomain;
999	/** Session creation flags.
1000	* @sa VBOXSERVICECTRLSESSIONSTARTUPFLAG_* flags. */
1001	uint32_t fFlags;
1002	} VBGLR3GUESTCTRLSESSIONSTARTUPINFO;
1003	/** Pointer to a guest session startup info. */
1004	typedef VBGLR3GUESTCTRLSESSIONSTARTUPINFO *PVBGLR3GUESTCTRLSESSIONSTARTUPINFO;
1005
1006	/**
1007	* Structure holding information for starting a guest
1008	* process.
1009	*/
1010	typedef struct VBGLR3GUESTCTRLPROCSTARTUPINFO
1011	{
1012	/** Full qualified path of process to start (without arguments).
1013	* Note: This is not argv[0]! */
1014	char *pszCmd;
1015	/** Size (in bytes) of allocated pszCmd. */
1016	uint32_t cbCmd;
1017	/** Process execution flags. @sa */
1018	uint32_t fFlags;
1019	/** Command line arguments. */
1020	char *pszArgs;
1021	/** Size (in bytes) of allocated pszArgs. */
1022	uint32_t cbArgs;
1023	/** Number of arguments specified in pszArgs. */
1024	uint32_t cArgs;
1025	/** String of environment variables ("FOO=BAR") to pass to the process
1026	* to start. */
1027	char *pszEnv;
1028	/** Size (in bytes) of environment variables block. */
1029	uint32_t cbEnv;
1030	/** Number of environment variables specified in pszEnv. */
1031	uint32_t cEnvVars;
1032	/** Optional working directory. */
1033	char *pszCwd;
1034	/** Size (in bytes) of optional working directory string. */
1035	uint32_t cbCwd;
1036	/** User name (account) to start the process under. */
1037	char *pszUser;
1038	/** Size (in bytes) of allocated pszUser. */
1039	uint32_t cbUser;
1040	/** Password of specified user name (account). */
1041	char *pszPassword;
1042	/** Size (in bytes) of allocated pszPassword. */
1043	uint32_t cbPassword;
1044	/** Domain to be used for authenticating the specified user name (account). */
1045	char *pszDomain;
1046	/** Size (in bytes) of allocated pszDomain. */
1047	uint32_t cbDomain;
1048	/** Time limit (in ms) of the process' life time. */
1049	uint32_t uTimeLimitMS;
1050	/** Process priority. */
1051	uint32_t uPriority;
1052	/** Process affinity block. At the moment we support
1053	* up to 4 blocks, that is, 4 * 64 = 256 CPUs total. */
1054	uint64_t uAffinity[4];
1055	/** Number of used process affinity blocks. */
1056	uint32_t cAffinity;
1057	} VBGLR3GUESTCTRLPROCSTARTUPINFO;
1058	/** Pointer to a guest process startup info. */
1059	typedef VBGLR3GUESTCTRLPROCSTARTUPINFO *PVBGLR3GUESTCTRLPROCSTARTUPINFO;
1060
1061	/* General message handling on the guest. */
1062	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
1063	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t idClient);
1064	VBGLR3DECL(bool) VbglR3GuestCtrlSupportsOptimizations(uint32_t idClient);
1065	VBGLR3DECL(int) VbglR3GuestCtrlMakeMeMaster(uint32_t idClient);
1066	VBGLR3DECL(int) VbglR3GuestCtrlReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1067	VBGLR3DECL(int) VbglR3GuestCtrlQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures);
1068	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
1069	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
1070	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
1071	void *pvPayload, uint32_t cbPayload);
1072	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg);
1073	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t uClientId);
1074	VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t pidMsg, uint32_t pcParameters, uint64_t *pidRestoreCheck);
1075	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
1076	/* Guest session handling. */
1077	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInit(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1078	VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInitEx(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo, size_t cbUser, size_t cbPassword, size_t cbDomain);
1079	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoDestroy(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1080	VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoFree(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1081	VBGLR3DECL(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO) VbglR3GuestCtrlSessionStartupInfoDup(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo);
1082	VBGLR3DECL(int) VbglR3GuestCtrlSessionPrepare(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1083	VBGLR3DECL(int) VbglR3GuestCtrlSessionAccept(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey);
1084	VBGLR3DECL(int) VbglR3GuestCtrlSessionCancelPrepared(uint32_t idClient, uint32_t idSession);
1085	VBGLR3DECL(int) VbglR3GuestCtrlSessionHasChanged(uint32_t idClient, uint64_t idNewControlSession);
1086	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
1087	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, int32_t iResult);
1088	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLSESSIONSTARTUPINFO *ppStartupInfo);
1089	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t pidSession);
1090	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1091	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
1092	/* Guest path handling. */
1093	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
1094	uint32_t cbDest, uint32_t *pfFlags);
1095	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx);
1096	VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx);
1097	# ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1098	/** @name Guest Control file system functions.
1099	* @{
1100	*/
1101	VBGLR3DECL(int) VbglR3GuestCtrlFsGetCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszTemplate, uint32_t cbTemplate, char pszPath, uint32_t cbPath, uint32_t pfFlags, uint32_t pfMode);
1102	VBGLR3DECL(int) VbglR3GuestCtrlFsGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath);
1103	/** @} */
1104
1105	/** @name Guest Control file system object functions.
1106	* @{
1107	*/
1108	VBGLR3DECL(int) VbglR3GuestCtrlFsObjGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, GSTCTLFSOBJATTRADD penmAddAttrib, uint32_t *pfFlags);
1109	/** @} */
1110	# endif
1111
1112	VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction);
1113	/* Guest process execution. */
1114	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInit(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1115	VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInitEx(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo, size_t cbCmd, size_t cbArgs, size_t cbEnv, size_t cbUser, size_t cbPassword, size_t cbDomain);
1116	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoDestroy(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1117	VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoFree(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1118	VBGLR3DECL(PVBGLR3GUESTCTRLPROCSTARTUPINFO) VbglR3GuestCtrlProcStartupInfoDup(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo);
1119	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLPROCSTARTUPINFO *ppStartupInfo);
1120	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
1121	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
1122	uint32_t cbData, uint32_t *pcbSize);
1123	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
1124	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
1125	uint32_t *puTimeoutMS);
1126	/* Guest native directory handling. */
1127	# ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1128	/** @name Guest Control directory functions.
1129	* @{
1130	*/
1131	VBGLR3DECL(int) VbglR3GuestCtrlDirGetCreate(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfMode, uint32_t *pfFlags);
1132	VBGLR3DECL(int) VbglR3GuestCtrlDirGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags, GSTCTLDIRFILTER penmFilter, GSTCTLFSOBJATTRADD penmReadAttrAdd, uint32_t *pfReadFlags);
1133	VBGLR3DECL(int) VbglR3GuestCtrlDirGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1134	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1135	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1136	VBGLR3DECL(int) VbglR3GuestCtrlDirGetList(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t pcEntries, uint32_t *pfFlags);
1137	/** @} */
1138	# endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1139	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
1140	/* Guest native file handling. */
1141	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
1142	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
1143	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
1144	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1145	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
1146	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1147	uint32_t puToRead, uint64_t poffRead);
1148	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1149	void pvData, uint32_t cbData, uint32_t pcbActual);
1150	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
1151	uint32_t pcbActual, uint64_t poffWrite);
1152	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
1153	uint32_t puSeekMethod, uint64_t poffSeek);
1154	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
1155	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint64_t pcbNew);
1156	# ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1157	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszFileName, uint32_t cbFileName);
1158	# endif
1159
1160	/* Guest -> Host. */
1161	# ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1162	/** @name Guest Control directory callbacks.
1163	* @{
1164	*/
1165	VBGLR3DECL(int) VbglR3GuestCtrlDirCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
1166	VBGLR3DECL(int) VbglR3GuestCtrlDirCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1167	VBGLR3DECL(int) VbglR3GuestCtrlDirCbReadEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize, const char pszUser, const char pszGroups);
1168	VBGLR3DECL(int) VbglR3GuestCtrlDirCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize);
1169	VBGLR3DECL(int) VbglR3GuestCtrlDirCbRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1170	VBGLR3DECL(int) VbglR3GuestCtrlDirCbList(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cEntries, void *pvBuf, uint32_t cbBuf);
1171	/** @} */
1172	# endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1173
1174	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
1175	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1176	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
1177	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
1178	VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData, int64_t offNew);
1179	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten);
1180	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew);
1181
1182	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1183	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent);
1184	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew);
1185
1186	# ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1187	/** @name Guest Control file system callbacks.
1188	* @{
1189	*/
1190	VBGLR3DECL(int) VbglR3GuestCtrlFsCbCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, const char *pszPath);
1191	VBGLR3DECL(int) VbglR3GuestCtrlFsCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSINFO pFsInfo, uint32_t cbFsInfo);
1192	/** @} */
1193
1194	/** @name Guest Control file system object callbacks.
1195	* @{
1196	*/
1197	VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfoEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pObjInfo, const char pszUser, const char pszGroups);
1198	VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pObjInfo);
1199	/** @} */
1200	# endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1201
1202	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags, void *pvData, uint32_t cbData);
1203	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags, void *pvData, uint32_t cbData);
1204	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus, uint32_t fFlags, uint32_t cbWritten);
1205	# endif /* VBOX_WITH_GUEST_CONTROL defined */
1206
1207	/** @name Auto-logon handling
1208	* @{ */
1209	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
1210	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
1211	/** @} */
1212
1213	/** @name User credentials handling
1214	* @{ */
1215	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
1216	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
1217	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
1218	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
1219	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
1220	uint32_t cPasses);
1221	/** @} */
1222
1223	/** @name CPU hotplug monitor
1224	* @{ */
1225	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
1226	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
1227	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
1228	/** @} */
1229
1230	/** @name Page sharing
1231	* @{ */
1232	struct VMMDEVSHAREDREGIONDESC;
1233	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
1234	unsigned cRegions, struct VMMDEVSHAREDREGIONDESC *pRegions);
1235	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
1236	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
1237	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
1238	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
1239	/** @} */
1240
1241	# ifdef VBOX_WITH_DRAG_AND_DROP
1242	/** @name Drag and Drop
1243	* @{ */
1244	/**
1245	* Structure containing the context required for
1246	* either retrieving or sending a HGCM guest drag'n drop
1247	* commands from or to the host.
1248	*
1249	* Note: Do not change parameter order without also
1250	* adapting all structure initializers.
1251	*/
1252	typedef struct VBGLR3GUESTDNDCMDCTX
1253	{
1254	/** @todo This struct could be handy if we want to implement
1255	* a second communication channel, e.g. via TCP/IP.
1256	* Use a union for the HGCM stuff then. */
1257
1258	/** HGCM client ID to use for communication. */
1259	uint32_t uClientID;
1260	/** The VM's current session ID. */
1261	uint64_t uSessionID;
1262	/** Protocol version to use.
1263	* Deprecated; do not used / rely on it anymore. */
1264	uint32_t uProtocolDeprecated;
1265	/** Host feature flags (VBOX_DND_HF_XXX).
1266	* This is set by VbglR3DnDConnect(). */
1267	uint64_t fHostFeatures;
1268	/** The guest feature flags reported to the host (VBOX_DND_GF_XXX).
1269	* This is set by VbglR3DnDConnect(). */
1270	uint64_t fGuestFeatures;
1271	/** Number of parameters retrieved for the current command. */
1272	uint32_t uNumParms;
1273	/** Max chunk size (in bytes) for data transfers. */
1274	uint32_t cbMaxChunkSize;
1275	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
1276
1277	/**
1278	* Enumeration for specifying the DnD meta data type.
1279	*/
1280	typedef enum VBGLR3GUESTDNDMETADATATYPE
1281	{
1282	/** Unknown meta data type; don't use. */
1283	VBGLR3GUESTDNDMETADATATYPE_UNKNOWN = 0,
1284	/** Raw meta data; can be everything. */
1285	VBGLR3GUESTDNDMETADATATYPE_RAW,
1286	/** Meta data is a transfer list, specifying objects. */
1287	VBGLR3GUESTDNDMETADATATYPE_URI_LIST,
1288	/** Blow the type up to 32-bit. */
1289	VBGLR3GUESTDNDMETADATATYPE_32BIT_HACK = 0x7fffffff
1290	} VBGLR3GUESTDNDMETADATATYPE;
1291
1292	/**
1293	* Structure for keeping + handling DnD meta data.
1294	*/
1295	typedef struct VBGLR3GUESTDNDMETADATA
1296	{
1297	/** The meta data type the union contains. */
1298	VBGLR3GUESTDNDMETADATATYPE enmType;
1299	/** Union based on \a enmType. */
1300	union
1301	{
1302	struct
1303	{
1304	/** Pointer to actual meta data. */
1305	void *pvMeta;
1306	/** Size (in bytes) of meta data. */
1307	uint32_t cbMeta;
1308	} Raw;
1309	struct
1310	{
1311	DNDTRANSFERLIST Transfer;
1312	} URI;
1313	} u;
1314	} VBGLR3GUESTDNDMETADATA;
1315
1316	/** Pointer to VBGLR3GUESTDNDMETADATA. */
1317	typedef VBGLR3GUESTDNDMETADATA *PVBGLR3GUESTDNDMETADATA;
1318
1319	/** Const pointer to VBGLR3GUESTDNDMETADATA. */
1320	typedef const PVBGLR3GUESTDNDMETADATA CPVBGLR3GUESTDNDMETADATA;
1321
1322	/**
1323	* Enumeration specifying a DnD event type.
1324	*/
1325	typedef enum VBGLR3DNDEVENTTYPE
1326	{
1327	VBGLR3DNDEVENTTYPE_INVALID = 0,
1328	VBGLR3DNDEVENTTYPE_CANCEL,
1329	VBGLR3DNDEVENTTYPE_HG_ERROR,
1330	VBGLR3DNDEVENTTYPE_HG_ENTER,
1331	VBGLR3DNDEVENTTYPE_HG_MOVE,
1332	VBGLR3DNDEVENTTYPE_HG_LEAVE,
1333	VBGLR3DNDEVENTTYPE_HG_DROP,
1334	VBGLR3DNDEVENTTYPE_HG_RECEIVE,
1335	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1336	VBGLR3DNDEVENTTYPE_GH_ERROR,
1337	VBGLR3DNDEVENTTYPE_GH_REQ_PENDING,
1338	VBGLR3DNDEVENTTYPE_GH_DROP,
1339	# endif
1340	/** Tells the caller that it has to quit operation. */
1341	VBGLR3DNDEVENTTYPE_QUIT,
1342	/** Blow the type up to 32-bit. */
1343	VBGLR3DNDEVENTTYPE_32BIT_HACK = 0x7fffffff
1344	} VBGLR3DNDEVENTTYPE;
1345
1346	typedef struct VBGLR3DNDEVENT
1347	{
1348	/** The event type the union contains. */
1349	VBGLR3DNDEVENTTYPE enmType;
1350	union
1351	{
1352	struct
1353	{
1354	/** Screen ID this request belongs to. */
1355	uint32_t uScreenID;
1356	/** Format list (UTF-8, \r\n separated). */
1357	char *pszFormats;
1358	/** Size (in bytes) of pszFormats (\0 included). */
1359	uint32_t cbFormats;
1360	/** List of allowed DnD actions. */
1361	VBOXDNDACTIONLIST dndLstActionsAllowed;
1362	} HG_Enter;
1363	struct
1364	{
1365	/** Absolute X position of guest screen. */
1366	uint32_t uXpos;
1367	/** Absolute Y position of guest screen. */
1368	uint32_t uYpos;
1369	/** Default DnD action. */
1370	VBOXDNDACTION dndActionDefault;
1371	} HG_Move;
1372	struct
1373	{
1374	/** Absolute X position of guest screen. */
1375	uint32_t uXpos;
1376	/** Absolute Y position of guest screen. */
1377	uint32_t uYpos;
1378	/** Default DnD action. */
1379	VBOXDNDACTION dndActionDefault;
1380	} HG_Drop;
1381	struct
1382	{
1383	/** Meta data for the operation. */
1384	VBGLR3GUESTDNDMETADATA Meta;
1385	} HG_Received;
1386	struct
1387	{
1388	/** IPRT-style error code. */
1389	int rc;
1390	} HG_Error;
1391	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1392	struct
1393	{
1394	/** Screen ID this request belongs to. */
1395	uint32_t uScreenID;
1396	} GH_IsPending;
1397	struct
1398	{
1399	/** Requested format by the host. */
1400	char *pszFormat;
1401	/** Size (in bytes) of pszFormat (\0 included). */
1402	uint32_t cbFormat;
1403	/** Requested DnD action. */
1404	VBOXDNDACTION dndActionRequested;
1405	} GH_Drop;
1406	# endif
1407	} u;
1408	} VBGLR3DNDEVENT;
1409	typedef VBGLR3DNDEVENT *PVBGLR3DNDEVENT;
1410	typedef const PVBGLR3DNDEVENT CPVBGLR3DNDEVENT;
1411
1412	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1413	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
1414
1415	VBGLR3DECL(int) VbglR3DnDReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
1416	VBGLR3DECL(int) VbglR3DnDSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
1417
1418	VBGLR3DECL(int) VbglR3DnDEventGetNext(PVBGLR3GUESTDNDCMDCTX pCtx, PVBGLR3DNDEVENT *ppEvent);
1419	VBGLR3DECL(void) VbglR3DnDEventFree(PVBGLR3DNDEVENT pEvent);
1420
1421	VBGLR3DECL(int) VbglR3DnDHGSendAckOp(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndAction);
1422	VBGLR3DECL(int) VbglR3DnDHGSendReqData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pcszFormat);
1423	VBGLR3DECL(int) VbglR3DnDHGSendProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
1424	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
1425	VBGLR3DECL(int) VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndActionDefault, VBOXDNDACTIONLIST dndLstActionsAllowed, const char* pcszFormats, uint32_t cbFormats);
1426	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
1427	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
1428	/** @} */
1429	# endif /* VBOX_WITH_DRAG_AND_DROP */
1430
1431	/* Generic Host Channel Service. */
1432	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pidClient);
1433	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t idClient);
1434	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1435	const char *pszName, uint32_t u32Flags);
1436	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1437	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1438	void *pvData, uint32_t cbData);
1439	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1440	void *pvData, uint32_t cbData,
1441	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
1442	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
1443	uint32_t u32Code, void *pvParm, uint32_t cbParm,
1444	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
1445	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
1446	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
1447	uint32_t *pu32SizeReturned);
1448	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
1449	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
1450	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
1451	uint32_t *pu32SizeDataReturned);
1452
1453	/** @name Mode hint storage
1454	* @{ */
1455	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
1456	unsigned cy, unsigned cBPP, unsigned *x,
1457	unsigned y, unsigned fEnabled);
1458	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
1459	unsigned cy, unsigned cBPP, unsigned x,
1460	unsigned y, unsigned fEnabled);
1461	/** @} */
1462
1463	/** @name Generic HGCM
1464	* @{ */
1465	VBGLR3DECL(int) VbglR3HGCMConnect(const char pszServiceName, HGCMCLIENTID pidClient);
1466	VBGLR3DECL(int) VbglR3HGCMDisconnect(HGCMCLIENTID idClient);
1467	struct VBGLIOCHGCMCALL;
1468	VBGLR3DECL(int) VbglR3HGCMCall(struct VBGLIOCHGCMCALL *pInfo, size_t cbInfo);
1469	/** @} */
1470
1471	#endif /* IN_RING3 */
1472	/** @} */
1473
1474	RT_C_DECLS_END
1475
1476	/** @} */
1477
1478	#endif /* !VBOX_INCLUDED_VBoxGuestLib_h */

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: