VirtualBox

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

Last change on this file since 82193 was 81768, checked in by vboxsync, 5 years ago

Shared Clipboard: Update.

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