VirtualBox

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

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

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