VirtualBox

source: vbox/trunk/src/VBox/Frontends/VBoxBFE/VMMDevInterface.cpp@ 29607

Last change on this file since 29607 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.2 KB
Line 
1/* $Id: VMMDevInterface.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2/** @file
3 * VBox frontends: Basic Frontend (BFE):
4 * Implementation of VMMDev: driver interface to VMM device
5 */
6
7/*
8 * Copyright (C) 2006-2010 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19#define LOG_GROUP LOG_GROUP_MAIN
20
21#ifdef VBOXBFE_WITHOUT_COM
22# include "COMDefs.h"
23#else
24# include <VBox/com/defs.h>
25#endif
26#include <VBox/pdm.h>
27#include <VBox/VMMDev.h>
28#include <VBox/cfgm.h>
29#include <VBox/err.h>
30#include <iprt/assert.h>
31#include <VBox/log.h>
32#include <iprt/asm.h>
33#include <iprt/uuid.h>
34
35#include "VBoxBFE.h"
36#include "VMMDev.h"
37#include "MouseImpl.h"
38#include "DisplayImpl.h"
39#include "ConsoleImpl.h"
40#ifdef VBOX_WITH_HGCM
41#include "HGCM.h"
42#endif
43
44#ifdef RT_OS_OS2
45# define VBOXSHAREDFOLDERS_DLL "VBoxSFld"
46#else
47# define VBOXSHAREDFOLDERS_DLL "VBoxSharedFolders"
48#endif
49
50#ifdef RT_OS_L4
51#include <l4/util/util.h> /* for l4_sleep */
52#endif
53/**
54 * VMMDev driver instance data.
55 */
56typedef struct DRVMAINVMMDEV
57{
58 /** Pointer to the VMMDev object. */
59 VMMDev *pVMMDev;
60 /** Pointer to the driver instance structure. */
61 PPDMDRVINS pDrvIns;
62 /** Pointer to the VMMDev port interface of the driver/device above us. */
63 PPDMIVMMDEVPORT pUpPort;
64 /** Our VMM device connector interface. */
65 PDMIVMMDEVCONNECTOR Connector;
66
67#ifdef VBOX_WITH_HGCM
68 /** Pointer to the HGCM port interface of the driver/device above us. */
69 PPDMIHGCMPORT pHGCMPort;
70 /** Our HGCM connector interface. */
71 PDMIHGCMCONNECTOR HGCMConnector;
72#endif
73} DRVMAINVMMDEV, *PDRVMAINVMMDEV;
74
75/** Converts PDMIVMMDEVCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
76#define PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, Connector)) )
77
78#ifdef VBOX_WITH_HGCM
79/** Converts PDMIHGCMCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
80#define PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, HGCMConnector)) )
81#endif
82
83VMMDev::VMMDev() : mpDrv(NULL)
84{
85#ifdef VBOX_WITH_HGCM
86 int rc = VINF_SUCCESS;
87 if (fActivateHGCM())
88 rc = HGCMHostInit();
89 AssertRC(rc);
90#endif
91}
92
93VMMDev::~VMMDev()
94{
95#ifdef VBOX_WITH_HGCM
96 if (fActivateHGCM())
97 HGCMHostShutdown ();
98#endif /* VBOX_WITH_HGCM */
99}
100
101
102PPDMIVMMDEVPORT VMMDev::getVMMDevPort()
103{
104 Assert(mpDrv);
105 return mpDrv->pUpPort;
106}
107
108
109/**
110 * Report guest OS version.
111 * Called whenever the Additions issue a guest version report request.
112 *
113 * @param pInterface Pointer to this interface.
114 * @param guestInfo Pointer to guest information structure
115 * @thread The emulation thread.
116 */
117DECLCALLBACK(void) VMMDev::UpdateGuestVersion(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestInfo *guestInfo)
118{
119 return;
120}
121
122/**
123 * Update the guest additions capabilities.
124 * This is called when the guest additions capabilities change. The new capabilities
125 * are given and the connector should update its internal state.
126 *
127 * @param pInterface Pointer to this interface.
128 * @param newCapabilities New capabilities.
129 * @thread The emulation thread.
130 */
131DECLCALLBACK(void) VMMDev::UpdateGuestCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
132{
133 return;
134}
135
136/**
137 * Update the mouse capabilities.
138 * This is called when the mouse capabilities change. The new capabilities
139 * are given and the connector should update its internal state.
140 *
141 * @param pInterface Pointer to this interface.
142 * @param newCapabilities New capabilities.
143 * @thread The emulation thread.
144 */
145DECLCALLBACK(void) VMMDev::UpdateMouseCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
146{
147 /*
148 * Tell the console interface about the event so that it can notify its consumers.
149 */
150
151 if (gMouse)
152 {
153 gMouse->onVMMDevCanAbsChange(!!(newCapabilities & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE));
154 gMouse->onVMMDevNeedsHostChange(!!(newCapabilities & VMMDEV_MOUSE_GUEST_NEEDS_HOST_CURSOR));
155 }
156 if (gConsole)
157 {
158 gConsole->resetCursor();
159 }
160}
161
162
163/**
164 * Update the pointer shape or visibility.
165 *
166 * This is called when the mouse pointer shape changes or pointer is hidden/displaying.
167 * The new shape is passed as a caller allocated buffer that will be freed after returning.
168 *
169 * @param pInterface Pointer to this interface.
170 * @param fVisible Whether the pointer is visible or not.
171 * @param fAlpha Alpha channel information is present.
172 * @param xHot Horizontal coordinate of the pointer hot spot.
173 * @param yHot Vertical coordinate of the pointer hot spot.
174 * @param width Pointer width in pixels.
175 * @param height Pointer height in pixels.
176 * @param pShape The shape buffer. If NULL, then only pointer visibility is being changed.
177 * @thread The emulation thread.
178 */
179DECLCALLBACK(void) VMMDev::UpdatePointerShape(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
180 uint32_t xHot, uint32_t yHot,
181 uint32_t width, uint32_t height,
182 void *pShape)
183{
184 if (gConsole)
185 gConsole->onMousePointerShapeChange(fVisible, fAlpha, xHot,
186 yHot, width, height, pShape);
187}
188
189DECLCALLBACK(int) iface_VideoAccelEnable(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, VBVAMEMORY *pVbvaMemory)
190{
191 LogFlow(("VMMDev::VideoAccelEnable: %d, %p\n", fEnable, pVbvaMemory));
192 if (gDisplay)
193 gDisplay->VideoAccelEnable (fEnable, pVbvaMemory);
194 return VINF_SUCCESS;
195}
196
197DECLCALLBACK(void) iface_VideoAccelFlush(PPDMIVMMDEVCONNECTOR pInterface)
198{
199 if (gDisplay)
200 gDisplay->VideoAccelFlush ();
201}
202
203DECLCALLBACK(int) iface_SetVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect)
204{
205 /* not implemented */
206 return VINF_SUCCESS;
207}
208
209DECLCALLBACK(int) iface_QueryVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect)
210{
211 /* not implemented */
212 return VINF_SUCCESS;
213}
214
215DECLCALLBACK(int) VMMDev::VideoModeSupported(PPDMIVMMDEVCONNECTOR pInterface, uint32_t display, uint32_t width, uint32_t height,
216 uint32_t bpp, bool *fSupported)
217{
218 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
219 (void)pDrv;
220
221 if (!fSupported)
222 return VERR_INVALID_PARAMETER;
223 *fSupported = true;
224 return VINF_SUCCESS;
225}
226
227DECLCALLBACK(int) VMMDev::GetHeightReduction(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *heightReduction)
228{
229 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
230 (void)pDrv;
231
232 if (!heightReduction)
233 return VERR_INVALID_PARAMETER;
234 /* XXX hard-coded */
235 *heightReduction = 18;
236 return VINF_SUCCESS;
237}
238
239#ifdef VBOX_WITH_HGCM
240
241/* HGCM connector interface */
242
243static DECLCALLBACK(int) iface_hgcmConnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID)
244{
245 LogSunlover(("Enter\n"));
246
247 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
248
249 if ( !pServiceLocation
250 || ( pServiceLocation->type != VMMDevHGCMLoc_LocalHost
251 && pServiceLocation->type != VMMDevHGCMLoc_LocalHost_Existing))
252 {
253 return VERR_INVALID_PARAMETER;
254 }
255
256 return HGCMGuestConnect (pDrv->pHGCMPort, pCmd, pServiceLocation->u.host.achName, pu32ClientID);
257}
258
259static DECLCALLBACK(int) iface_hgcmDisconnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID)
260{
261 LogSunlover(("Enter\n"));
262
263 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
264
265 return HGCMGuestDisconnect (pDrv->pHGCMPort, pCmd, u32ClientID);
266}
267
268static DECLCALLBACK(int) iface_hgcmCall (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
269 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
270{
271 LogSunlover(("Enter\n"));
272
273 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
274
275 return HGCMGuestCall (pDrv->pHGCMPort, pCmd, u32ClientID, u32Function, cParms, paParms);
276}
277
278/**
279 * Execute state save operation.
280 *
281 * @returns VBox status code.
282 * @param pDrvIns Driver instance of the driver which registered the data unit.
283 * @param pSSM SSM operation handle.
284 */
285static DECLCALLBACK(int) iface_hgcmSave(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
286{
287 LogSunlover(("Enter\n"));
288 return HGCMHostSaveState (pSSM);
289}
290
291
292/**
293 * Execute state load operation.
294 *
295 * @returns VBox status code.
296 * @param pDrvIns Driver instance of the driver which registered the data unit.
297 * @param pSSM SSM operation handle.
298 * @param uVersion Data layout version.
299 * @param uPass The data pass.
300 */
301static DECLCALLBACK(int) iface_hgcmLoad(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
302{
303 LogFlowFunc(("Enter\n"));
304
305 if (uVersion != HGCM_SSM_VERSION)
306 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
307 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
308
309 return HGCMHostLoadState (pSSM);
310}
311
312int VMMDev::hgcmLoadService (const char *pszServiceLibrary, const char *pszServiceName)
313{
314 return HGCMHostLoad (pszServiceLibrary, pszServiceName);
315}
316
317int VMMDev::hgcmHostCall (const char *pszServiceName, uint32_t u32Function,
318 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
319{
320 return HGCMHostCall (pszServiceName, u32Function, cParms, paParms);
321}
322#endif /* HGCM */
323
324/**
325 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
326 */
327DECLCALLBACK(void *) VMMDev::drvQueryInterface(PPDMIBASE pInterface, const char *pszIID)
328{
329 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
330 PDRVMAINVMMDEV pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
331 if (RTUuidCompare2Strs(pszIID, PDMIBASE_IID) == 0)
332 return &pDrvIns->IBase;
333 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIVMMDEVCONNECTOR, &pDrv->Connector);
334#ifdef VBOX_WITH_HGCM
335 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHGCMCONNECTOR, fActivateHGCM() ? &pDrv->HGCMConnector : NULL);
336#endif
337 return NULL;
338}
339
340
341/**
342 * Destruct a VMMDev driver instance.
343 *
344 * @returns VBox status.
345 * @param pDrvIns The driver instance data.
346 */
347DECLCALLBACK(void) VMMDev::drvDestruct(PPDMDRVINS pDrvIns)
348{
349 /*PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV); - unused variables makes gcc bitch. */
350}
351
352
353/**
354 * Construct a VMMDev driver instance.
355 *
356 * @copydoc FNPDMDRVCONSTRUCT
357 */
358DECLCALLBACK(int) VMMDev::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
359{
360 PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
361 LogFlow(("Keyboard::drvConstruct: iInstance=%d\n", pDrvIns->iInstance));
362
363 /*
364 * Validate configuration.
365 */
366 if (!CFGMR3AreValuesValid(pCfg, "Object\0"))
367 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
368 AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
369 ("Configuration error: Not possible to attach anything to this driver!\n"),
370 VERR_PDM_DRVINS_NO_ATTACH);
371
372 /*
373 * IBase.
374 */
375 pDrvIns->IBase.pfnQueryInterface = VMMDev::drvQueryInterface;
376
377 pData->Connector.pfnUpdateGuestVersion = VMMDev::UpdateGuestVersion;
378 pData->Connector.pfnUpdateGuestCapabilities = VMMDev::UpdateGuestCapabilities;
379 pData->Connector.pfnUpdateMouseCapabilities = VMMDev::UpdateMouseCapabilities;
380 pData->Connector.pfnUpdatePointerShape = VMMDev::UpdatePointerShape;
381 pData->Connector.pfnVideoAccelEnable = iface_VideoAccelEnable;
382 pData->Connector.pfnVideoAccelFlush = iface_VideoAccelFlush;
383 pData->Connector.pfnVideoModeSupported = VMMDev::VideoModeSupported;
384 pData->Connector.pfnGetHeightReduction = VMMDev::GetHeightReduction;
385 pData->Connector.pfnSetVisibleRegion = iface_SetVisibleRegion;
386 pData->Connector.pfnQueryVisibleRegion = iface_QueryVisibleRegion;
387
388#ifdef VBOX_WITH_HGCM
389 if (fActivateHGCM())
390 {
391 pData->HGCMConnector.pfnConnect = iface_hgcmConnect;
392 pData->HGCMConnector.pfnDisconnect = iface_hgcmDisconnect;
393 pData->HGCMConnector.pfnCall = iface_hgcmCall;
394 }
395#endif
396
397 /*
398 * Get the IVMMDevPort interface of the above driver/device.
399 */
400 pData->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIVMMDEVPORT);
401 AssertMsgReturn(pData->pUpPort, ("Configuration error: No VMMDev port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
402
403#ifdef VBOX_WITH_HGCM
404 if (fActivateHGCM())
405 {
406 pData->pHGCMPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIHGCMPORT);
407 AssertMsgReturn(pData->pHGCMPort, ("Configuration error: No HGCM port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
408 }
409#endif
410
411 /*
412 * Get the VMMDev object pointer and update the mpDrv member.
413 */
414 void *pv;
415 int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
416 if (RT_FAILURE(rc))
417 {
418 AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
419 return rc;
420 }
421
422 pData->pVMMDev = (VMMDev*)pv; /** @todo Check this cast! */
423 pData->pVMMDev->mpDrv = pData;
424
425#ifdef VBOX_WITH_HGCM
426 if (fActivateHGCM())
427 {
428 rc = pData->pVMMDev->hgcmLoadService (VBOXSHAREDFOLDERS_DLL, "VBoxSharedFolders");
429 pData->pVMMDev->fSharedFolderActive = RT_SUCCESS(rc);
430 if (RT_SUCCESS(rc))
431 LogRel(("Shared Folders service loaded.\n"));
432 else
433 LogRel(("Failed to load Shared Folders service %Rrc\n", rc));
434
435
436 rc = PDMDrvHlpSSMRegisterEx(pDrvIns, HGCM_SSM_VERSION, 4096 /* bad guess */,
437 NULL, NULL, NULL,
438 NULL, iface_hgcmSave, NULL,
439 NULL, iface_hgcmLoad, NULL);
440 if (RT_FAILURE(rc))
441 return rc;
442
443 }
444#endif /* VBOX_WITH_HGCM */
445
446 return VINF_SUCCESS;
447}
448
449
450/**
451 * VMMDevice driver registration record.
452 */
453const PDMDRVREG VMMDev::DrvReg =
454{
455 /* u32Version */
456 PDM_DRVREG_VERSION,
457 /* szName */
458 "HGCM",
459 /* szRCMod */
460 "",
461 /* szR0Mod */
462 "",
463 /* pszDescription */
464 "Main VMMDev driver (Main as in the API).",
465 /* fFlags */
466 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
467 /* fClass. */
468 PDM_DRVREG_CLASS_VMMDEV,
469 /* cMaxInstances */
470 ~0,
471 /* cbInstance */
472 sizeof(DRVMAINVMMDEV),
473 /* pfnConstruct */
474 VMMDev::drvConstruct,
475 /* pfnDestruct */
476 VMMDev::drvDestruct,
477 /* pfnRelocate */
478 NULL,
479 /* pfnIOCtl */
480 NULL,
481 /* pfnPowerOn */
482 NULL,
483 /* pfnReset */
484 NULL,
485 /* pfnSuspend */
486 NULL,
487 /* pfnResume */
488 NULL,
489 /* pfnAttach */
490 NULL,
491 /* pfnDetach */
492 NULL,
493 /* pfnPowerOff */
494 NULL,
495 /* pfnSoftReset */
496 NULL,
497 /* u32EndVersion */
498 PDM_DRVREG_VERSION
499};
500
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