VirtualBox

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

Last change on this file since 35967 was 35907, checked in by vboxsync, 14 years ago

Main/Frontends: Also use facilities for guest features (seamless, graphics), added facility-state-to-name to VBoxManage, some renaming.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 24.9 KB
Line 
1/** @file
2 * VBoxGuestLib - VirtualBox Guest Additions Library.
3 */
4
5/*
6 * Copyright (C) 2006-2010 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/VBoxGuest2.h>
34#endif
35
36
37/** @defgroup grp_guest_lib VirtualBox Guest Additions Library
38 * @{
39 */
40
41/** @page pg_guest_lib VirtualBox Guest Library
42 *
43 * This is a library for abstracting the additions driver interface. There are
44 * multiple versions of the library depending on the context. The main
45 * distinction is between kernel and user mode where the interfaces are very
46 * different.
47 *
48 *
49 * @section sec_guest_lib_ring0 Ring-0
50 *
51 * In ring-0 there are two version:
52 * - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
53 * who is responsible for managing the VMMDev virtual hardware.
54 * - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
55 *
56 *
57 * The library source code and the header have a define VBGL_VBOXGUEST, which is
58 * defined for VBoxGuest and undefined for other drivers. Drivers must choose
59 * right library in their makefiles and set VBGL_VBOXGUEST accordingly.
60 *
61 * The libraries consists of:
62 * - common code to be used by both VBoxGuest and other drivers;
63 * - VBoxGuest specific code;
64 * - code for other drivers which communicate with VBoxGuest via an IOCTL.
65 *
66 *
67 * @section sec_guest_lib_ring3 Ring-3
68 *
69 * There are more variants of the library here:
70 * - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
71 * - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
72 * drivers which uses special loader and or symbol resolving strategy.
73 * - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
74 * Dylibs.
75 *
76 */
77
78RT_C_DECLS_BEGIN
79
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# define DECLR0VBGL(type) type VBOXCALL
89# define DECLVBGL(type) DECLR0VBGL(type)
90
91typedef uint32_t VBGLIOPORT; /**< @todo r=bird: We have RTIOPORT (uint16_t) for this. */
92
93
94# ifdef VBGL_VBOXGUEST
95
96/**
97 * The library initialization function to be used by the main
98 * VBoxGuest system driver.
99 *
100 * @return VBox status code.
101 */
102DECLVBGL(int) VbglInit (VBGLIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
103
104# else
105
106/**
107 * The library initialization function to be used by all drivers
108 * other than the main VBoxGuest system driver.
109 *
110 * @return VBox status code.
111 */
112DECLVBGL(int) VbglInit (void);
113
114# endif
115
116/**
117 * The library termination function.
118 */
119DECLVBGL(void) VbglTerminate (void);
120
121
122/** @name Generic request functions.
123 * @{
124 */
125
126/**
127 * Allocate memory for generic request and initialize the request header.
128 *
129 * @param ppReq pointer to resulting memory address.
130 * @param cbSize size of memory block required for the request.
131 * @param reqType the generic request type.
132 *
133 * @return VBox status code.
134 */
135DECLVBGL(int) VbglGRAlloc (VMMDevRequestHeader **ppReq, uint32_t cbSize, VMMDevRequestType reqType);
136
137/**
138 * Perform the generic request.
139 *
140 * @param pReq pointer the request structure.
141 *
142 * @return VBox status code.
143 */
144DECLVBGL(int) VbglGRPerform (VMMDevRequestHeader *pReq);
145
146/**
147 * Free the generic request memory.
148 *
149 * @param pReq pointer the request structure.
150 *
151 * @return VBox status code.
152 */
153DECLVBGL(void) VbglGRFree (VMMDevRequestHeader *pReq);
154
155/**
156 * Verify the generic request header.
157 *
158 * @param pReq pointer the request header structure.
159 * @param cbReq size of the request memory block. It should be equal to the request size
160 * for fixed size requests. It can be greater than the request size for
161 * variable size requests.
162 *
163 * @return VBox status code.
164 */
165DECLVBGL(int) VbglGRVerify (const VMMDevRequestHeader *pReq, size_t cbReq);
166/** @} */
167
168# ifdef VBOX_WITH_HGCM
169
170# ifdef VBGL_VBOXGUEST
171
172/**
173 * Callback function called from HGCM helpers when a wait for request
174 * completion IRQ is required.
175 *
176 * @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
177 * @param pvData VBoxGuest pointer to be passed to callback.
178 * @param u32Data VBoxGuest 32 bit value to be passed to callback.
179 */
180typedef DECLVBGL(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader *pHeader, void *pvData, uint32_t u32Data);
181/** Pointer to a FNVBGLHGCMCALLBACK. */
182typedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
183
184/**
185 * Perform a connect request. That is locate required service and
186 * obtain a client identifier for future access.
187 *
188 * @note This function can NOT handle cancelled requests!
189 *
190 * @param pConnectInfo The request data.
191 * @param pfnAsyncCallback Required pointer to function that is calledwhen
192 * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
193 * implements waiting for an IRQ in this function.
194 * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
195 * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
196 *
197 * @return VBox status code.
198 */
199
200DECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
201 PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
202
203
204/**
205 * Perform a disconnect request. That is tell the host that
206 * the client will not call the service anymore.
207 *
208 * @note This function can NOT handle cancelled requests!
209 *
210 * @param pDisconnectInfo The request data.
211 * @param pfnAsyncCallback Required pointer to function that is called when
212 * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
213 * implements waiting for an IRQ in this function.
214 * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
215 * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
216 * callback.
217 *
218 * @return VBox status code.
219 */
220
221DECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
222 PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
223
224/** Call a HGCM service.
225 *
226 * @note This function can deal with cancelled requests.
227 *
228 * @param pCallInfo The request data.
229 * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
230 * @param pfnAsyncCallback Required pointer to function that is called when
231 * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
232 * implements waiting for an IRQ in this function.
233 * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
234 * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
235 *
236 * @return VBox status code.
237 */
238DECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
239 PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
240
241/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
242 *
243 * @note This function can deal with cancelled requests.
244 *
245 * @param pCallInfo The request data.
246 * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
247 * @param pfnAsyncCallback Required pointer to function that is called when
248 * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
249 * implements waiting for an IRQ in this function.
250 * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
251 * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
252 *
253 * @return VBox status code.
254 */
255DECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
256 PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
257
258/** @name VbglR0HGCMInternalCall flags
259 * @{ */
260/** User mode request.
261 * Indicates that only user mode addresses are permitted as parameters. */
262#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
263/** Kernel mode request.
264 * Indicates that kernel mode addresses are permitted as parameters. Whether or
265 * not user mode addresses are permitted is, unfortunately, OS specific. The
266 * following OSes allows user mode addresses: Windows, TODO.
267 */
268#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
269/** Mode mask. */
270#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
271/** @} */
272
273# else /* !VBGL_VBOXGUEST */
274
275struct VBGLHGCMHANDLEDATA;
276typedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
277
278/** @name HGCM functions
279 * @{
280 */
281
282/**
283 * Connect to a service.
284 *
285 * @param pHandle Pointer to variable that will hold a handle to be used
286 * further in VbglHGCMCall and VbglHGCMClose.
287 * @param pData Connection information structure.
288 *
289 * @return VBox status code.
290 */
291DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
292
293/**
294 * Connect to a service.
295 *
296 * @param handle Handle of the connection.
297 * @param pData Disconnect request information structure.
298 *
299 * @return VBox status code.
300 */
301DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
302
303/**
304 * Call to a service.
305 *
306 * @param handle Handle of the connection.
307 * @param pData Call request information structure, including function parameters.
308 * @param cbData Length in bytes of data.
309 *
310 * @return VBox status code.
311 */
312DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
313
314/**
315 * Call to a service with timeout.
316 *
317 * @param handle Handle of the connection.
318 * @param pData Call request information structure, including function parameters.
319 * @param cbData Length in bytes of data.
320 * @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
321 *
322 * @return VBox status code.
323 */
324DECLVBGL(int) VbglHGCMCallTimed (VBGLHGCMHANDLE handle,
325 VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
326/** @} */
327
328# endif /* !VBGL_VBOXGUEST */
329
330# endif /* VBOX_WITH_HGCM */
331
332
333/**
334 * Initialize the heap.
335 *
336 * @return VBox error code.
337 */
338DECLVBGL(int) VbglPhysHeapInit (void);
339
340/**
341 * Shutdown the heap.
342 */
343DECLVBGL(void) VbglPhysHeapTerminate (void);
344
345
346/**
347 * Allocate a memory block.
348 *
349 * @param cbSize Size of block to be allocated.
350 * @return Virtual address of allocated memory block.
351 */
352DECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
353
354/**
355 * Get physical address of memory block pointed by
356 * the virtual address.
357 *
358 * @note WARNING!
359 * The function does not acquire the Heap mutex!
360 * When calling the function make sure that
361 * the pointer is a valid one and is not being
362 * deallocated.
363 * This function can NOT be used for verifying
364 * if the given pointer is a valid one allocated
365 * from the heap.
366 *
367 *
368 * @param p Virtual address of memory block.
369 * @return Physical memory block.
370 */
371DECLVBGL(RTCCPHYS) VbglPhysHeapGetPhysAddr (void *p);
372
373/**
374 * Free a memory block.
375 *
376 * @param p Virtual address of memory block.
377 */
378DECLVBGL(void) VbglPhysHeapFree (void *p);
379
380DECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
381DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
382
383#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
384/** @} */
385
386
387/** @defgroup grp_guest_lib_r3 Ring-3 interface.
388 * @{
389 */
390#ifdef IN_RING3
391
392/** @def VBGLR3DECL
393 * Ring 3 VBGL declaration.
394 * @param type The return type of the function declaration.
395 */
396# define VBGLR3DECL(type) type VBOXCALL
397
398/** @name General-purpose functions
399 * @{ */
400VBGLR3DECL(int) VbglR3Init(void);
401VBGLR3DECL(int) VbglR3InitUser(void);
402VBGLR3DECL(void) VbglR3Term(void);
403# ifdef ___iprt_time_h
404VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
405# endif
406VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
407VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cch);
408VBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
409VBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose);
410VBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
411VBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
412VBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
413VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
414
415VBGLR3DECL(int) VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent, uint32_t uFlags);
416VBGLR3DECL(int) VbglR3GetAdditionsVersion(char **ppszVer, char **ppszRev);
417VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath);
418VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession);
419
420/** @} */
421
422/** @name Shared clipboard
423 * @{ */
424VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
425VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
426VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
427VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
428VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
429VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
430/** @} */
431
432/** @name Seamless mode
433 * @{ */
434VBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
435VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
436VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
437VBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode);
438
439/** @} */
440
441/** @name Mouse
442 * @{ */
443VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
444VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
445/** @} */
446
447/** @name Video
448 * @{ */
449VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
450VBGLR3DECL(int) VbglR3VideoAccelFlush(void);
451VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg);
452VBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
453/** @} */
454
455/** @name Display
456 * @{ */
457VBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay, bool fAck);
458VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
459VBGLR3DECL(int) VbglR3SaveVideoMode(const char *pszName, uint32_t cx, uint32_t cy, uint32_t cBits);
460VBGLR3DECL(int) VbglR3RetrieveVideoMode(const char *pszName, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits);
461/** @} */
462
463/** @name VM Statistics
464 * @{ */
465VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval);
466VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq);
467/** @} */
468
469/** @name Memory ballooning
470 * @{ */
471VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t *pcChunks, bool *pfHandleInR3);
472VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate);
473/** @} */
474
475/** @name Core Dump
476 * @{ */
477VBGLR3DECL(int) VbglR3WriteCoreDump(void);
478
479/** @} */
480
481# ifdef VBOX_WITH_GUEST_PROPS
482/** @name Guest properties
483 * @{ */
484/** @todo Docs. */
485typedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
486/** @todo Docs. */
487typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
488VBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pu32ClientId);
489VBGLR3DECL(int) VbglR3GuestPropDisconnect(uint32_t u32ClientId);
490VBGLR3DECL(int) VbglR3GuestPropWrite(uint32_t u32ClientId, const char *pszName, const char *pszValue, const char *pszFlags);
491VBGLR3DECL(int) VbglR3GuestPropWriteValue(uint32_t u32ClientId, const char *pszName, const char *pszValue);
492VBGLR3DECL(int) VbglR3GuestPropWriteValueV(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, va_list va);
493VBGLR3DECL(int) VbglR3GuestPropWriteValueF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...);
494VBGLR3DECL(int) VbglR3GuestPropRead(uint32_t u32ClientId, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
495VBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue, uint32_t *pcchValueActual);
496VBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(uint32_t u32ClientId, const char *pszName, char **ppszValue);
497VBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
498VBGLR3DECL(int) VbglR3GuestPropEnumRaw(uint32_t u32ClientId, const char *paszPatterns, char *pcBuf, uint32_t cbBuf, uint32_t *pcbBufActual);
499VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId, char const * const *ppaszPatterns, uint32_t cPatterns, PVBGLR3GUESTPROPENUM *ppHandle,
500 char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp, char const **ppszFlags);
501VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp,
502 char const **ppszFlags);
503VBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
504VBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t u32ClientId, char const * const *papszPatterns, uint32_t cPatterns);
505VBGLR3DECL(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);
506/** @} */
507
508/** @name Host version handling
509 * @{ */
510VBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(uint32_t u32ClientId, bool *pfUpdate, char **ppszHostVersion, char **ppszGuestVersion);
511VBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(uint32_t u32ClientId, char **ppszVer);
512VBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(uint32_t u32ClientId, const char *pszVer);
513/** @} */
514# endif /* VBOX_WITH_GUEST_PROPS defined */
515
516# ifdef VBOX_WITH_SHARED_FOLDERS
517/** @name Shared folders
518 * @{ */
519/**
520 * Structure containing mapping information for a shared folder.
521 */
522typedef struct VBGLR3SHAREDFOLDERMAPPING
523{
524 /** Mapping status. */
525 uint32_t u32Status;
526 /** Root handle. */
527 uint32_t u32Root;
528} VBGLR3SHAREDFOLDERMAPPING;
529/** Pointer to a shared folder mapping information struct. */
530typedef VBGLR3SHAREDFOLDERMAPPING *PVBGLR3SHAREDFOLDERMAPPING;
531
532VBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pu32ClientId);
533VBGLR3DECL(int) VbglR3SharedFolderDisconnect(uint32_t u32ClientId);
534VBGLR3DECL(bool) VbglR3SharedFolderExists(uint32_t u32ClientId, const char *pszShareName);
535VBGLR3DECL(int) VbglR3SharedFolderGetMappings(uint32_t u32ClientId, bool fAutoMountOnly,
536 PVBGLR3SHAREDFOLDERMAPPING *ppaMappings, uint32_t *pcMappings);
537VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
538VBGLR3DECL(int) VbglR3SharedFolderGetName(uint32_t u32ClientId,uint32_t u32Root, char **ppszName);
539VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char **ppszPrefix);
540VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char **ppszDir);
541/** @} */
542# endif /* VBOX_WITH_SHARED_FOLDERS defined */
543
544# ifdef VBOX_WITH_GUEST_CONTROL
545/** @name Guest control
546 * @{ */
547VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pu32ClientId);
548VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t u32ClientId);
549VBGLR3DECL(int) VbglR3GuestCtrlGetHostMsg(uint32_t u32ClientId, uint32_t *puMsg, uint32_t *puNumParms);
550VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t u32ClientId);
551VBGLR3DECL(int) VbglR3GuestCtrlExecGetHostCmd(uint32_t u32ClientId, uint32_t uNumParms,
552 uint32_t *puContext,
553 char *pszCmd, uint32_t cbCmd,
554 uint32_t *puFlags,
555 char *pszArgs, uint32_t cbArgs, uint32_t *puNumArgs,
556 char *pszEnv, uint32_t *pcbEnv, uint32_t *puNumEnvVars,
557 char *pszUser, uint32_t cbUser,
558 char *pszPassword, uint32_t cbPassword,
559 uint32_t *puTimeLimit);
560VBGLR3DECL(int) VbglR3GuestCtrlExecGetHostCmdInput(uint32_t u32ClientId, uint32_t uNumParms,
561 uint32_t *puContext, uint32_t *puPID,
562 uint32_t *puFlags, void *pvData,
563 uint32_t cbData, uint32_t *pcbSize);
564VBGLR3DECL(int) VbglR3GuestCtrlExecGetHostCmdOutput(uint32_t u32ClientId, uint32_t uNumParms,
565 uint32_t *puContext, uint32_t *puPID,
566 uint32_t *puHandle, uint32_t *puFlags);
567VBGLR3DECL(int) VbglR3GuestCtrlExecReportStatus(uint32_t u32ClientId,
568 uint32_t u32Context,
569 uint32_t u32PID,
570 uint32_t u32Status,
571 uint32_t u32Flags,
572 void *pvData,
573 uint32_t cbData);
574VBGLR3DECL(int) VbglR3GuestCtrlExecSendOut(uint32_t u32ClientId,
575 uint32_t u32Context,
576 uint32_t u32PID,
577 uint32_t u32Handle,
578 uint32_t u32Flags,
579 void *pvData,
580 uint32_t cbData);
581VBGLR3DECL(int) VbglR3GuestCtrlExecReportStatusIn(uint32_t u32ClientId,
582 uint32_t u32Context,
583 uint32_t u32PID,
584 uint32_t u32Status,
585 uint32_t u32Flags,
586 uint32_t cbWritten);
587/** @} */
588# endif /* VBOX_WITH_GUEST_CONTROL defined */
589
590/** @name User credentials handling
591 * @{ */
592VBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void);
593VBGLR3DECL(int) VbglR3CredentialsRetrieve(char **ppszUser, char **ppszPassword, char **ppszDomain);
594VBGLR3DECL(void) VbglR3CredentialsDestroy(char *pszUser, char *pszPassword, char *pszDomain, uint32_t cPasses);
595/** @} */
596
597/** @name CPU hotplug monitor
598 * @{ */
599VBGLR3DECL(int) VbglR3CpuHotPlugInit(void);
600VBGLR3DECL(int) VbglR3CpuHotPlugTerm(void);
601VBGLR3DECL(int) VbglR3CpuHotPlugWaitForEvent(VMMDevCpuEventType *penmEventType, uint32_t *pidCpuCore, uint32_t *pidCpuPackage);
602/** @} */
603
604/** @name Page sharing
605 * @{ */
606VBGLR3DECL(int) VbglR3RegisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule, unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
607VBGLR3DECL(int) VbglR3UnregisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64 GCBaseAddr, uint32_t cbModule);
608VBGLR3DECL(int) VbglR3CheckSharedModules(void);
609VBGLR3DECL(bool) VbglR3PageSharingIsEnabled(void);
610VBGLR3DECL(int) VbglR3PageIsShared(RTGCPTR pPage, bool *pfShared, uint64_t *puPageFlags);
611/** @} */
612
613#endif /* IN_RING3 */
614/** @} */
615
616RT_C_DECLS_END
617
618/** @} */
619
620#endif
621
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