VBoxGuestLib.h@ 58178

Last change on this file since 58178 was 58178, checked in by vboxsync, 9 years ago
VbglInit -> VbglInitPrimary & VbglInitClient. VBoxGuestLib/Init.cpp cleanups and positive thinking.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.9 KB

Line
1	/** @file
2	* VBoxGuestLib - VirtualBox Guest Additions Library.
3	*/
4
5	/*
6	* Copyright (C) 2006-2015 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_VBoxGuestLib_h
27	#define ___VBox_VBoxGuestLib_h
28
29	#include <VBox/types.h>
30	#include <VBox/VMMDev2.h>
31	#include <VBox/VMMDev.h> /* grumble */
32	#ifdef IN_RING0
33	# include <VBox/VBoxGuest.h>
34	# include <VBox/VBoxGuest2.h>
35	#endif
36
37
38	/** @defgroup grp_vboxguest_lib VirtualBox Guest Additions Library
39	* @ingroup grp_vboxguest
40	* @{
41	*/
42
43	/** @page pg_guest_lib VirtualBox Guest Library
44	*
45	* This is a library for abstracting the additions driver interface. There are
46	* multiple versions of the library depending on the context. The main
47	* distinction is between kernel and user mode where the interfaces are very
48	* different.
49	*
50	*
51	* @section sec_guest_lib_ring0 Ring-0
52	*
53	* In ring-0 there are two version:
54	* - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
55	* who is responsible for managing the VMMDev virtual hardware.
56	* - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
57	*
58	*
59	* The library source code and the header have a define VBGL_VBOXGUEST, which is
60	* defined for VBoxGuest and undefined for other drivers. Drivers must choose
61	* right library in their makefiles and set VBGL_VBOXGUEST accordingly.
62	*
63	* The libraries consists of:
64	* - common code to be used by both VBoxGuest and other drivers;
65	* - VBoxGuest specific code;
66	* - code for other drivers which communicate with VBoxGuest via an IOCTL.
67	*
68	*
69	* @section sec_guest_lib_ring3 Ring-3
70	*
71	* There are more variants of the library here:
72	* - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
73	* - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
74	* drivers which uses special loader and or symbol resolving strategy.
75	* - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
76	* Dylibs.
77	*
78	*/
79
80	RT_C_DECLS_BEGIN
81
82	/** @defgroup grp_vboxguest_lib_r0 Ring-0 interface.
83	* @{
84	*/
85	#if defined(IN_RING0) && !defined(IN_RING0_AGNOSTIC)
86	/** @def DECLR0VBGL
87	* Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
88	* @param type Return type. */
89	# ifdef RT_OS_DARWIN /** @todo probably apply to all, but don't want a forest fire on our hands right now. */
90	# define DECLR0VBGL(type) DECLHIDDEN(type) VBOXCALL
91	# else
92	# define DECLR0VBGL(type) type VBOXCALL
93	# endif
94	# define DECLVBGL(type) DECLR0VBGL(type)
95
96
97	# ifdef VBGL_VBOXGUEST
98
99	/**
100	* The library initialization function to be used by the main
101	* VBoxGuest system driver.
102	*
103	* @return VBox status code.
104	*/
105	DECLVBGL(int) VbglInitPrimary(RTIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
106
107	# else
108
109	/**
110	* The library initialization function to be used by all drivers
111	* other than the main VBoxGuest system driver.
112	*
113	* @return VBox status code.
114	*/
115	DECLVBGL(int) VbglInitClient(void);
116
117	# endif
118
119	/**
120	* The library termination function.
121	*/
122	DECLVBGL(void) VbglTerminate(void);
123
124
125	/** @name Generic request functions.
126	* @{
127	*/
128
129	/**
130	* Allocate memory for generic request and initialize the request header.
131	*
132	* @returns VBox status code.
133	* @param ppReq Where to return the pointer to the allocated memory.
134	* @param cbReq Size of memory block required for the request.
135	* @param enmReqType the generic request type.
136	*/
137	DECLVBGL(int) VbglGRAlloc(VMMDevRequestHeader **ppReq, uint32_t cbReq, VMMDevRequestType enmReqType);
138
139	/**
140	* Perform the generic request.
141	*
142	* @param pReq pointer the request structure.
143	*
144	* @return VBox status code.
145	*/
146	DECLVBGL(int) VbglGRPerform(VMMDevRequestHeader *pReq);
147
148	/**
149	* Free the generic request memory.
150	*
151	* @param pReq pointer the request structure.
152	*
153	* @return VBox status code.
154	*/
155	DECLVBGL(void) VbglGRFree(VMMDevRequestHeader *pReq);
156
157	/**
158	* Verify the generic request header.
159	*
160	* @param pReq pointer the request header structure.
161	* @param cbReq size of the request memory block. It should be equal to the request size
162	* for fixed size requests. It can be greater than the request size for
163	* variable size requests.
164	*
165	* @return VBox status code.
166	*/
167	DECLVBGL(int) VbglGRVerify(const VMMDevRequestHeader *pReq, size_t cbReq);
168	/** @} */
169
170	# ifdef VBOX_WITH_HGCM
171
172	# ifdef VBGL_VBOXGUEST
173
174	/**
175	* Callback function called from HGCM helpers when a wait for request
176	* completion IRQ is required.
177	*
178	* @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
179	* @param pvData VBoxGuest pointer to be passed to callback.
180	* @param u32Data VBoxGuest 32 bit value to be passed to callback.
181	*/
182	typedef DECLCALLBACK(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader pHeader, void pvData, uint32_t u32Data);
183	/** Pointer to a FNVBGLHGCMCALLBACK. */
184	typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
185
186	/**
187	* Perform a connect request. That is locate required service and
188	* obtain a client identifier for future access.
189	*
190	* @note This function can NOT handle cancelled requests!
191	*
192	* @param pConnectInfo The request data.
193	* @param pfnAsyncCallback Required pointer to function that is calledwhen
194	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
195	* implements waiting for an IRQ in this function.
196	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
197	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
198	*
199	* @return VBox status code.
200	*/
201
202	DECLR0VBGL(int) VbglR0HGCMInternalConnect(VBoxGuestHGCMConnectInfo *pConnectInfo,
203	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
204
205
206	/**
207	* Perform a disconnect request. That is tell the host that
208	* the client will not call the service anymore.
209	*
210	* @note This function can NOT handle cancelled requests!
211	*
212	* @param pDisconnectInfo The request data.
213	* @param pfnAsyncCallback Required pointer to function that is called when
214	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
215	* implements waiting for an IRQ in this function.
216	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
217	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
218	* callback.
219	*
220	* @return VBox status code.
221	*/
222
223	DECLR0VBGL(int) VbglR0HGCMInternalDisconnect(VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
224	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
225
226	/** Call a HGCM service.
227	*
228	* @note This function can deal with cancelled requests.
229	*
230	* @param pCallInfo The request data.
231	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
232	* @param pfnAsyncCallback Required pointer to function that is called when
233	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
234	* implements waiting for an IRQ in this function.
235	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
236	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
237	*
238	* @return VBox status code.
239	*/
240	DECLR0VBGL(int) VbglR0HGCMInternalCall(VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
241	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
242
243	/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
244	*
245	* @note This function can deal with cancelled requests.
246	*
247	* @param pCallInfo The request data.
248	* @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
249	* @param pfnAsyncCallback Required pointer to function that is called when
250	* host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
251	* implements waiting for an IRQ in this function.
252	* @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
253	* @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
254	*
255	* @return VBox status code.
256	*/
257	DECLR0VBGL(int) VbglR0HGCMInternalCall32(VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
258	PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
259
260	/** @name VbglR0HGCMInternalCall flags
261	* @{ */
262	/** User mode request.
263	* Indicates that only user mode addresses are permitted as parameters. */
264	#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
265	/** Kernel mode request.
266	* Indicates that kernel mode addresses are permitted as parameters. Whether or
267	* not user mode addresses are permitted is, unfortunately, OS specific. The
268	* following OSes allows user mode addresses: Windows, TODO.
269	*/
270	#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
271	/** Mode mask. */
272	#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
273	/** @} */
274
275	# else /* !VBGL_VBOXGUEST */
276
277	struct VBGLHGCMHANDLEDATA;
278	typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
279
280	/** @name HGCM functions
281	* @{
282	*/
283
284	/**
285	* Connect to a service.
286	*
287	* @param pHandle Pointer to variable that will hold a handle to be used
288	* further in VbglHGCMCall and VbglHGCMClose.
289	* @param pData Connection information structure.
290	*
291	* @return VBox status code.
292	*/
293	DECLVBGL(int) VbglHGCMConnect(VBGLHGCMHANDLE pHandle, VBoxGuestHGCMConnectInfo pData);
294
295	/**
296	* Connect to a service.
297	*
298	* @param handle Handle of the connection.
299	* @param pData Disconnect request information structure.
300	*
301	* @return VBox status code.
302	*/
303	DECLVBGL(int) VbglHGCMDisconnect(VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
304
305	/**
306	* Call to a service.
307	*
308	* @param handle Handle of the connection.
309	* @param pData Call request information structure, including function parameters.
310	* @param cbData Length in bytes of data.
311	*
312	* @return VBox status code.
313	*/
314	DECLVBGL(int) VbglHGCMCall(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
315
316	/**
317	* Call to a service with user-mode data received by the calling driver from the User-Mode process.
318	* The call must be done in the context of a calling process.
319	*
320	* @param handle Handle of the connection.
321	* @param pData Call request information structure, including function parameters.
322	* @param cbData Length in bytes of data.
323	*
324	* @return VBox status code.
325	*/
326	DECLVBGL(int) VbglHGCMCallUserData(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
327
328	/**
329	* Call to a service with timeout.
330	*
331	* @param handle Handle of the connection.
332	* @param pData Call request information structure, including function parameters.
333	* @param cbData Length in bytes of data.
334	* @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
335	*
336	* @return VBox status code.
337	*/
338	DECLVBGL(int) VbglHGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
339	/** @} */
340
341	# endif /* !VBGL_VBOXGUEST */
342
343	# endif /* VBOX_WITH_HGCM */
344
345
346	/**
347	* Initialize the heap.
348	*
349	* @returns VBox status code.
350	*/
351	DECLVBGL(int) VbglPhysHeapInit(void);
352
353	/**
354	* Shutdown the heap.
355	*/
356	DECLVBGL(void) VbglPhysHeapTerminate(void);
357
358	/**
359	* Allocate a memory block.
360	*
361	* @returns Virtual address of the allocated memory block.
362	* @param cbSize Size of block to be allocated.
363	*/
364	DECLVBGL(void *) VbglPhysHeapAlloc(uint32_t cbSize);
365
366	/**
367	* Get physical address of memory block pointed by the virtual address.
368	*
369	* @note WARNING!
370	* The function does not acquire the Heap mutex!
371	* When calling the function make sure that the pointer is a valid one and
372	* is not being deallocated. This function can NOT be used for verifying
373	* if the given pointer is a valid one allocated from the heap.
374	*
375	* @param pv Virtual address of memory block.
376	* @returns Physical address of the memory block.
377	*/
378	DECLVBGL(uint32_t) VbglPhysHeapGetPhysAddr(void *pv);
379
380	/**
381	* Free a memory block.
382	*
383	* @param pv Virtual address of memory block.
384	*/
385	DECLVBGL(void) VbglPhysHeapFree(void *pv);
386
387	DECLVBGL(int) VbglQueryVMMDevMemory(VMMDevMemory **ppVMMDevMemory);
388	DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
389
390	# ifndef VBOX_GUEST
391	/** @name Mouse
392	* @{ */
393	DECLVBGL(int) VbglSetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
394	DECLVBGL(int) VbglGetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
395	DECLVBGL(int) VbglSetMouseStatus(uint32_t fFeatures);
396	/** @} */
397	# endif /* VBOX_GUEST */
398
399	#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
400	/** @} */
401
402
403	/** @defgroup grp_vboxguest_lib_r3 Ring-3 interface.
404	* @{
405	*/
406	#ifdef IN_RING3
407
408	/** @def VBGLR3DECL
409	* Ring 3 VBGL declaration.
410	* @param type The return type of the function declaration.
411	*/
412	# define VBGLR3DECL(type) type VBOXCALL
413
414	/** @name General-purpose functions
415	* @{ */
416	VBGLR3DECL(int) VbglR3Init(void);
417	VBGLR3DECL(int) VbglR3InitUser(void);
418	VBGLR3DECL(void) VbglR3Term(void);
419	# ifdef ___iprt_time_h
420	VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
421	# endif
422	VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
423	VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
424	VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
425	VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose, bool fRespawn, unsigned *pcRespawn);
426	VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
427	VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
428	VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
429	VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
430
431	VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
432	uint32_t fFlags);
433	VBGLR3DECL(int) VbglR3GetAdditionsVersion(char ppszVer, char ppszVerEx, char **ppszRev);
434	VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
435	VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
436
437	/** @} */
438
439	/** @name Shared clipboard
440	* @{ */
441	VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pidClient);
442	VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t idClient);
443	VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t idClient, uint32_t pMsg, uint32_t pfFormats);
444	VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t idClient, uint32_t fFormat, void pv, uint32_t cb, uint32_t pcb);
445	VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t idClient, uint32_t fFormats);
446	VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t idClient, uint32_t fFormat, void *pv, uint32_t cb);
447	/** @} */
448
449	/** @name Seamless mode
450	* @{ */
451	VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
452	VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
453	VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
454	VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
455
456	/** @} */
457
458	/** @name Mouse
459	* @{ */
460	VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t pfFeatures, uint32_t px, uint32_t *py);
461	VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
462	/** @} */
463
464	/** @name Video
465	* @{ */
466	VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
467	VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
468	VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
469	const void *pvImg, size_t cbImg);
470	VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
471	/** @} */
472
473	/** @name Display
474	* @{ */
475	/** The folder for the video mode hint unix domain socket on Unix-like guests.
476	* @note This can be safely changed as all users are rebuilt in lock-step. */
477	#define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
478	/** The path to the video mode hint unix domain socket on Unix-like guests. */
479	#define VBGLR3HOSTDISPSOCKET VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
480
481	/** The folder for saving video mode hints to between sessions. */
482	#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
483	/** The path to the file for saving video mode hints to between sessions. */
484	#define VBGLR3HOSTDISPSAVEDMODE VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
485
486	VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t pcx, uint32_t pcy, uint32_t pcBits, uint32_t piDisplay,
487	uint32_t pdx, uint32_t pdy, bool pfEnabled, bool pfChangeOrigin, bool fAck);
488	VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
489	VBGLR3DECL(int) VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
490	VBGLR3DECL(int) VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
491	unsigned x, unsigned y, bool fEnabled);
492	VBGLR3DECL(int) VbglR3RetrieveVideoMode(unsigned cScreen, unsigned pcx, unsigned pcy, unsigned *pcBits,
493	unsigned px, unsigned py, bool *pfEnabled);
494	/** @} */
495
496	/** @name VM Statistics
497	* @{ */
498	VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
499	VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
500	/** @} */
501
502	/** @name Memory ballooning
503	* @{ */
504	VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t pcChunks, bool pfHandleInR3);
505	VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
506	/** @} */
507
508	/** @name Core Dump
509	* @{ */
510	VBGLR3DECL(int) VbglR3WriteCoreDump(void);
511
512	/** @} */
513
514	# ifdef VBOX_WITH_GUEST_PROPS
515	/** @name Guest properties
516	* @{ */
517	/** @todo Docs. */
518	typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
519	/** @todo Docs. */
520	typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
521	VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pidClient);
522	VBGLR3DECL(int) VbglR3GuestPropDisconnect(uint32_t idClient);
523	VBGLR3DECL(int) VbglR3GuestPropWrite(uint32_t idClient, const char pszName, const char pszValue, const char *pszFlags);
524	VBGLR3DECL(int) VbglR3GuestPropWriteValue(uint32_t idClient, const char pszName, const char pszValue);
525	VBGLR3DECL(int) VbglR3GuestPropWriteValueV(uint32_t idClient, const char *pszName,
526	const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
527	VBGLR3DECL(int) VbglR3GuestPropWriteValueF(uint32_t idClient, const char *pszName,
528	const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
529	VBGLR3DECL(int) VbglR3GuestPropRead(uint32_t idClient, const char pszName, void pvBuf, uint32_t cbBuf, char **ppszValue,
530	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
531	VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char pszName, char pszValue, uint32_t cchValue,
532	uint32_t *pcchValueActual);
533	VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(uint32_t idClient, const char pszName, char *ppszValue);
534	VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
535	VBGLR3DECL(int) VbglR3GuestPropEnumRaw(uint32_t idClient, const char paszPatterns, char pcBuf, uint32_t cbBuf,
536	uint32_t *pcbBufActual);
537	VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
538	PVBGLR3GUESTPROPENUM ppHandle, char const ppszName, char const *ppszValue,
539	uint64_t pu64Timestamp, char const *ppszFlags);
540	VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const ppszName, char const ppszValue,
541	uint64_t pu64Timestamp, char const *ppszFlags);
542	VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
543	VBGLR3DECL(int) VbglR3GuestPropDelete(uint32_t idClient, const char *pszName);
544	VBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t idClient, char const * const *papszPatterns, uint32_t cPatterns);
545	VBGLR3DECL(int) VbglR3GuestPropWait(uint32_t idClient, const char pszPatterns, void pvBuf, uint32_t cbBuf,
546	uint64_t u64Timestamp, uint32_t cMillies, char ppszName, char ppszValue,
547	uint64_t pu64Timestamp, char ppszFlags, uint32_t pcbBufActual);
548	/** @} */
549
550	/** @name Guest user handling / reporting.
551	* @{ */
552	VBGLR3DECL(int) VbglR3GuestUserReportState(const char pszUser, const char pszDomain, VBoxGuestUserState enmState,
553	uint8_t *pbDetails, uint32_t cbDetails);
554	/** @} */
555
556	/** @name Host version handling
557	* @{ */
558	VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(uint32_t idClient, bool pfUpdate, char *ppszHostVersion,
559	char **ppszGuestVersion);
560	VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(uint32_t idClient, char **ppszVer);
561	VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(uint32_t idClient, const char *pszVer);
562	/** @} */
563	# endif /* VBOX_WITH_GUEST_PROPS defined */
564
565	# ifdef VBOX_WITH_SHARED_FOLDERS
566	/** @name Shared folders
567	* @{ */
568	/**
569	* Structure containing mapping information for a shared folder.
570	*/
571	typedef struct VBGLR3SHAREDFOLDERMAPPING
572	{
573	/** Mapping status. */
574	uint32_t u32Status;
575	/** Root handle. */
576	uint32_t u32Root;
577	} VBGLR3SHAREDFOLDERMAPPING;
578	/** Pointer to a shared folder mapping information structure. */
579	typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
580	/** Pointer to a const shared folder mapping information structure. */
581	typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
582
583	VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pidClient);
584	VBGLR3DECL(int) VbglR3SharedFolderDisconnect(uint32_t idClient);
585	VBGLR3DECL(bool) VbglR3SharedFolderExists(uint32_t idClient, const char *pszShareName);
586	VBGLR3DECL(int) VbglR3SharedFolderGetMappings(uint32_t idClient, bool fAutoMountOnly,
587	PVBGLR3SHAREDFOLDERMAPPING ppaMappings, uint32_t pcMappings);
588	VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
589	VBGLR3DECL(int) VbglR3SharedFolderGetName(uint32_t idClient,uint32_t u32Root, char **ppszName);
590	VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char **ppszPrefix);
591	VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char **ppszDir);
592	/** @} */
593	# endif /* VBOX_WITH_SHARED_FOLDERS defined */
594
595	# ifdef VBOX_WITH_GUEST_CONTROL
596	/** @name Guest control
597	* @{ */
598
599	/**
600	* Structure containing the context required for
601	* either retrieving or sending a HGCM guest control
602	* commands from or to the host.
603	*
604	* Note: Do not change parameter order without also
605	* adapting all structure initializers.
606	*/
607	typedef struct VBGLR3GUESTCTRLCMDCTX
608	{
609	/** @todo This struct could be handy if we want to implement
610	* a second communication channel, e.g. via TCP/IP.
611	* Use a union for the HGCM stuff then. */
612
613	/** IN: HGCM client ID to use for
614	* communication. */
615	uint32_t uClientID;
616	/** IN/OUT: Context ID to retrieve
617	* or to use. */
618	uint32_t uContextID;
619	/** IN: Protocol version to use. */
620	uint32_t uProtocol;
621	/** OUT: Number of parameters retrieved. */
622	uint32_t uNumParms;
623	} VBGLR3GUESTCTRLCMDCTX, *PVBGLR3GUESTCTRLCMDCTX;
624
625	/* General message handling on the guest. */
626	VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
627	VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t uClientId);
628	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
629	VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterUnset(uint32_t uClientId);
630	VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
631	VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
632	void *pvPayload, uint32_t cbPayload);
633	VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t uClientId);
634	VBGLR3DECL(int) VbglR3GuestCtrlMsgWaitFor(uint32_t uClientId, uint32_t puMsg, uint32_t puNumParms);
635	VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t idClient);
636	/* Guest session handling. */
637	VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
638	VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, uint32_t uResult);
639	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puProtocol, char pszUser, uint32_t cbUser,
640	char pszPassword, uint32_t cbPassword, char pszDomain, uint32_t cbDomain,
641	uint32_t pfFlags, uint32_t puSessionID);
642	VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t pfFlags, uint32_t puSessionID);
643	/* Guest path handling. */
644	VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszSource, uint32_t cbSource, char pszDest,
645	uint32_t cbDest, uint32_t *pfFlags);
646	/* Guest process execution. */
647	VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszCmd, uint32_t cbCmd, uint32_t pfFlags,
648	char pszArgs, uint32_t cbArgs, uint32_t puNumArgs, char pszEnv, uint32_t pcbEnv,
649	uint32_t puNumEnvVars, char pszUser, uint32_t cbUser, char *pszPassword,
650	uint32_t cbPassword, uint32_t puTimeoutMS, uint32_t puPriority,
651	uint64_t puAffinity, uint32_t cbAffinity, uint32_t pcAffinity);
652	VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
653	VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t pfFlags, void *pvData,
654	uint32_t cbData, uint32_t *pcbSize);
655	VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puHandle, uint32_t *pfFlags);
656	VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puPID, uint32_t puWaitFlags,
657	uint32_t *puTimeoutMS);
658	/* Guest native directory handling. */
659	VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszPath, uint32_t cbPath, uint32_t pfFlags);
660	/* Guest native file handling. */
661	VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char pszFileName, uint32_t cbFileName, char pszOpenMode,
662	uint32_t cbOpenMode, char pszDisposition, uint32_t cbDisposition, char pszSharing,
663	uint32_t cbSharing, uint32_t puCreationMode, uint64_t puOffset);
664	VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
665	VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, uint32_t puToRead);
666	VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
667	uint32_t puToRead, uint64_t poffRead);
668	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
669	void pvData, uint32_t cbData, uint32_t pcbActual);
670	VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t puHandle, void pvData, uint32_t cbData,
671	uint32_t pcbActual, uint64_t poffWrite);
672	VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
673	uint32_t puSeekMethod, uint64_t poffSeek);
674	VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
675	/* Guest -> Host. */
676	VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uFileHandle);
677	VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
678	VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc);
679	VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, void *pvData, uint32_t cbData);
680	VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uWritten);
681	VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
682	VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
683	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
684	void *pvData, uint32_t cbData);
685	VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
686	void *pvData, uint32_t cbData);
687	VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
688	uint32_t fFlags, uint32_t cbWritten);
689
690	/** @} */
691	# endif /* VBOX_WITH_GUEST_CONTROL defined */
692
693	/** @name Auto-logon handling
694	* @{ */
695	VBGLR3DECL(int) VbglR3AutoLogonReportStatus(VBoxGuestFacilityStatus enmStatus);
696	VBGLR3DECL(bool) VbglR3AutoLogonIsRemoteSession(void);
697	/** @} */
698
699	/** @name User credentials handling
700	* @{ */
701	VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
702	VBGLR3DECL(int) VbglR3CredentialsRetrieve(char ppszUser, char ppszPassword, char **ppszDomain);
703	VBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 ppwszUser, PRTUTF16 ppwszPassword, PRTUTF16 *ppwszDomain);
704	VBGLR3DECL(void) VbglR3CredentialsDestroy(char pszUser, char pszPassword, char *pszDomain, uint32_t cPasses);
705	VBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
706	uint32_t cPasses);
707	/** @} */
708
709	/** @name CPU hotplug monitor
710	* @{ */
711	VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
712	VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
713	VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType penmEventType, uint32_t pidCpuCore, uint32_t *pidCpuPackage);
714	/** @} */
715
716	/** @name Page sharing
717	* @{ */
718	VBGLR3DECL(int) VbglR3RegisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule,
719	unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
720	VBGLR3DECL(int) VbglR3UnregisterSharedModule(char pszModuleName, char pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
721	VBGLR3DECL(int) VbglR3CheckSharedModules(void);
722	VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
723	VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool pfShared, uint64_t puPageFlags);
724	/** @} */
725
726	# ifdef VBOX_WITH_DRAG_AND_DROP
727	/** @name Drag and Drop
728	* @{ */
729	/**
730	* Structure containing the context required for
731	* either retrieving or sending a HGCM guest drag'n drop
732	* commands from or to the host.
733	*
734	* Note: Do not change parameter order without also
735	* adapting all structure initializers.
736	*/
737	typedef struct VBGLR3GUESTDNDCMDCTX
738	{
739	/** @todo This struct could be handy if we want to implement
740	* a second communication channel, e.g. via TCP/IP.
741	* Use a union for the HGCM stuff then. */
742
743	/** IN: HGCM client ID to use for communication. */
744	uint32_t uClientID;
745	/** IN: Protocol version to use. */
746	uint32_t uProtocol;
747	/** OUT: Number of parameters retrieved. */
748	uint32_t uNumParms;
749	} VBGLR3GUESTDNDCMDCTX, *PVBGLR3GUESTDNDCMDCTX;
750
751	typedef struct VBGLR3DNDHGCMEVENT
752	{
753	uint32_t uType; /** The event type this struct contains. */
754	uint32_t uScreenId; /** Screen ID this request belongs to. */
755	char pszFormats; /* Format list (\r\n separated). */
756	uint32_t cbFormats; /** Size of pszFormats (\0 included). */
757	union
758	{
759	struct
760	{
761	uint32_t uXpos; /** X position of guest screen. */
762	uint32_t uYpos; /** Y position of guest screen. */
763	uint32_t uDefAction; /** Proposed DnD action. */
764	uint32_t uAllActions; /** Allowed DnD actions. */
765	} a; /** Values used in init, move and drop event type. */
766	struct
767	{
768	void pvData; /* Data request. */
769	size_t cbData; /** Size of pvData. */
770	} b; /** Values used in drop data event type. */
771	} u;
772	} VBGLR3DNDHGCMEVENT;
773	typedef VBGLR3DNDHGCMEVENT *PVBGLR3DNDHGCMEVENT;
774	typedef const PVBGLR3DNDHGCMEVENT CPVBGLR3DNDHGCMEVENT;
775	VBGLR3DECL(int) VbglR3DnDConnect(PVBGLR3GUESTDNDCMDCTX pCtx);
776	VBGLR3DECL(int) VbglR3DnDDisconnect(PVBGLR3GUESTDNDCMDCTX pCtx);
777
778	VBGLR3DECL(int) VbglR3DnDProcessNextMessage(PVBGLR3GUESTDNDCMDCTX pCtx, CPVBGLR3DNDHGCMEVENT pEvent);
779
780	VBGLR3DECL(int) VbglR3DnDHGAcknowledgeOperation(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uAction);
781	VBGLR3DECL(int) VbglR3DnDHGRequestData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pszFormat);
782	VBGLR3DECL(int) VbglR3DnDHGSetProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
783	# ifdef VBOX_WITH_DRAG_AND_DROP_GH
784	VBGLR3DECL(int) VbglR3DnDGHAcknowledgePending(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uDefAction,
785	uint32_t uAllActions, const char *pszFormats);
786	VBGLR3DECL(int) VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char pszFormat, void pvData, uint32_t cbData);
787	VBGLR3DECL(int) VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
788	# endif /* VBOX_WITH_DRAG_AND_DROP_GH */
789	/** @} */
790	# endif /* VBOX_WITH_DRAG_AND_DROP */
791
792	/* Generic Host Channel Service. */
793	VBGLR3DECL(int) VbglR3HostChannelInit(uint32_t *pu32HGCMClientId);
794	VBGLR3DECL(void) VbglR3HostChannelTerm(uint32_t u32HGCMClientId);
795	VBGLR3DECL(int) VbglR3HostChannelAttach(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
796	const char *pszName, uint32_t u32Flags);
797	VBGLR3DECL(void) VbglR3HostChannelDetach(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
798	VBGLR3DECL(int) VbglR3HostChannelSend(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
799	void *pvData, uint32_t cbData);
800	VBGLR3DECL(int) VbglR3HostChannelRecv(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
801	void *pvData, uint32_t cbData,
802	uint32_t pu32SizeReceived, uint32_t pu32SizeRemaining);
803	VBGLR3DECL(int) VbglR3HostChannelControl(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId,
804	uint32_t u32Code, void *pvParm, uint32_t cbParm,
805	void pvData, uint32_t cbData, uint32_t pu32SizeDataReturned);
806	VBGLR3DECL(int) VbglR3HostChannelEventWait(uint32_t *pu32ChannelHandle, uint32_t u32HGCMClientId,
807	uint32_t pu32EventId, void pvParm, uint32_t cbParm,
808	uint32_t *pu32SizeReturned);
809	VBGLR3DECL(int) VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
810	VBGLR3DECL(int) VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
811	void pvParm, uint32_t cbParm, void pvData, uint32_t cbData,
812	uint32_t *pu32SizeDataReturned);
813
814	/** @name Mode hint storage
815	* @{ */
816	VBGLR3DECL(int) VbglR3ReadVideoMode(unsigned cDisplay, unsigned *cx,
817	unsigned cy, unsigned cBPP, unsigned *x,
818	unsigned y, unsigned fEnabled);
819	VBGLR3DECL(int) VbglR3WriteVideoMode(unsigned cDisplay, unsigned cx,
820	unsigned cy, unsigned cBPP, unsigned x,
821	unsigned y, unsigned fEnabled);
822	/** @} */
823
824	#endif /* IN_RING3 */
825	/** @} */
826
827	RT_C_DECLS_END
828
829	/** @} */
830
831	#endif
832

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

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

Download in other formats: