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