VirtualBox

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

Last change on this file since 56553 was 55422, checked in by vboxsync, 10 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette