VirtualBox

source: vbox/trunk/src/VBox/Main/VMMDevInterface.cpp@ 27905

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

Metrics updates
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 25.6 KB
Line 
1/* $Id: VMMDevInterface.cpp 27896 2010-03-31 13:33:57Z vboxsync $ */
2/** @file
3 * VirtualBox Driver Interface to VMM device.
4 */
5
6/*
7 * Copyright (C) 2006-2010 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.215389.xyz. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22#include "VMMDev.h"
23#include "ConsoleImpl.h"
24#include "DisplayImpl.h"
25#include "GuestImpl.h"
26#include "MouseImpl.h"
27
28#include "Logging.h"
29
30#include <VBox/pdmdrv.h>
31#include <VBox/VMMDev.h>
32#include <VBox/shflsvc.h>
33#include <iprt/asm.h>
34
35#ifdef VBOX_WITH_HGCM
36#include "hgcm/HGCM.h"
37#include "hgcm/HGCMObjects.h"
38# if defined(RT_OS_DARWIN) && defined(VBOX_WITH_CROGL)
39# include <VBox/HostServices/VBoxCrOpenGLSvc.h>
40# endif
41#endif
42
43//
44// defines
45//
46
47#ifdef RT_OS_OS2
48# define VBOXSHAREDFOLDERS_DLL "VBoxSFld"
49#else
50# define VBOXSHAREDFOLDERS_DLL "VBoxSharedFolders"
51#endif
52
53//
54// globals
55//
56
57
58/**
59 * VMMDev driver instance data.
60 */
61typedef struct DRVMAINVMMDEV
62{
63 /** Pointer to the VMMDev object. */
64 VMMDev *pVMMDev;
65 /** Pointer to the driver instance structure. */
66 PPDMDRVINS pDrvIns;
67 /** Pointer to the VMMDev port interface of the driver/device above us. */
68 PPDMIVMMDEVPORT pUpPort;
69 /** Our VMM device connector interface. */
70 PDMIVMMDEVCONNECTOR Connector;
71
72#ifdef VBOX_WITH_HGCM
73 /** Pointer to the HGCM port interface of the driver/device above us. */
74 PPDMIHGCMPORT pHGCMPort;
75 /** Our HGCM connector interface. */
76 PDMIHGCMCONNECTOR HGCMConnector;
77#endif
78} DRVMAINVMMDEV, *PDRVMAINVMMDEV;
79
80/** Converts PDMIVMMDEVCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
81#define PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, Connector)) )
82
83#ifdef VBOX_WITH_HGCM
84/** Converts PDMIHGCMCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
85#define PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, HGCMConnector)) )
86#endif
87
88//
89// constructor / destructor
90//
91VMMDev::VMMDev(Console *console)
92 : mpDrv(NULL),
93 mParent(console)
94{
95 int rc = RTSemEventCreate(&mCredentialsEvent);
96 AssertRC(rc);
97#ifdef VBOX_WITH_HGCM
98 rc = HGCMHostInit ();
99 AssertRC(rc);
100 m_fHGCMActive = true;
101#endif /* VBOX_WITH_HGCM */
102 mu32CredentialsFlags = 0;
103}
104
105VMMDev::~VMMDev()
106{
107#ifdef VBOX_WITH_HGCM
108 if (hgcmIsActive())
109 {
110 ASMAtomicWriteBool(&m_fHGCMActive, false);
111 HGCMHostShutdown();
112 }
113#endif /* VBOX_WITH_HGCM */
114 RTSemEventDestroy (mCredentialsEvent);
115 if (mpDrv)
116 mpDrv->pVMMDev = NULL;
117 mpDrv = NULL;
118}
119
120PPDMIVMMDEVPORT VMMDev::getVMMDevPort()
121{
122 Assert(mpDrv);
123 return mpDrv->pUpPort;
124}
125
126
127
128//
129// public methods
130//
131
132/**
133 * Wait on event semaphore for guest credential judgement result.
134 */
135int VMMDev::WaitCredentialsJudgement (uint32_t u32Timeout, uint32_t *pu32CredentialsFlags)
136{
137 if (u32Timeout == 0)
138 {
139 u32Timeout = 5000;
140 }
141
142 int rc = RTSemEventWait (mCredentialsEvent, u32Timeout);
143
144 if (RT_SUCCESS(rc))
145 {
146 *pu32CredentialsFlags = mu32CredentialsFlags;
147 }
148
149 return rc;
150}
151
152int VMMDev::SetCredentialsJudgementResult (uint32_t u32Flags)
153{
154 mu32CredentialsFlags = u32Flags;
155
156 int rc = RTSemEventSignal (mCredentialsEvent);
157 AssertRC(rc);
158
159 return rc;
160}
161
162
163/**
164 * Report guest OS version.
165 * Called whenever the Additions issue a guest version report request or the VM is reset.
166 *
167 * @param pInterface Pointer to this interface.
168 * @param guestInfo Pointer to guest information structure
169 * @thread The emulation thread.
170 */
171DECLCALLBACK(void) vmmdevUpdateGuestVersion(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestInfo *guestInfo)
172{
173 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
174
175 Assert(guestInfo);
176 if (!guestInfo)
177 return;
178
179 /* store that information in IGuest */
180 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
181 Assert(guest);
182 if (!guest)
183 return;
184
185 if (guestInfo->additionsVersion != 0)
186 {
187 char version[20];
188 RTStrPrintf(version, sizeof(version), "%d", guestInfo->additionsVersion);
189 guest->setAdditionsVersion(Bstr(version), guestInfo->osType);
190
191 /*
192 * Tell the console interface about the event
193 * so that it can notify its consumers.
194 */
195 pDrv->pVMMDev->getParent()->onAdditionsStateChange();
196
197 if (guestInfo->additionsVersion < VMMDEV_VERSION)
198 pDrv->pVMMDev->getParent()->onAdditionsOutdated();
199 }
200 else
201 {
202 /*
203 * The guest additions was disabled because of a reset
204 * or driver unload.
205 */
206 guest->setAdditionsVersion (Bstr(), guestInfo->osType);
207 pDrv->pVMMDev->getParent()->onAdditionsStateChange();
208 }
209}
210
211/**
212 * Update the guest additions capabilities.
213 * This is called when the guest additions capabilities change. The new capabilities
214 * are given and the connector should update its internal state.
215 *
216 * @param pInterface Pointer to this interface.
217 * @param newCapabilities New capabilities.
218 * @thread The emulation thread.
219 */
220DECLCALLBACK(void) vmmdevUpdateGuestCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
221{
222 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
223
224 /* store that information in IGuest */
225 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
226 Assert(guest);
227 if (!guest)
228 return;
229
230 guest->setSupportsSeamless(BOOL (newCapabilities & VMMDEV_GUEST_SUPPORTS_SEAMLESS));
231 guest->setSupportsGraphics(BOOL (newCapabilities & VMMDEV_GUEST_SUPPORTS_GRAPHICS));
232
233 /*
234 * Tell the console interface about the event
235 * so that it can notify its consumers.
236 */
237 pDrv->pVMMDev->getParent()->onAdditionsStateChange();
238
239}
240
241/**
242 * Update the mouse capabilities.
243 * This is called when the mouse capabilities change. The new capabilities
244 * are given and the connector should update its internal state.
245 *
246 * @param pInterface Pointer to this interface.
247 * @param newCapabilities New capabilities.
248 * @thread The emulation thread.
249 */
250DECLCALLBACK(void) vmmdevUpdateMouseCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
251{
252 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
253 /*
254 * Tell the console interface about the event
255 * so that it can notify its consumers.
256 */
257 Mouse *pMouse = pDrv->pVMMDev->getParent()->getMouse();
258 if (pMouse) /** @todo and if not? Can that actually happen? */
259 {
260 pMouse->onVMMDevCanAbsChange(!!(newCapabilities & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE));
261 pMouse->onVMMDevNeedsHostChange(!!(newCapabilities & VMMDEV_MOUSE_GUEST_NEEDS_HOST_CURSOR));
262 }
263}
264
265
266/**
267 * Update the pointer shape or visibility.
268 *
269 * This is called when the mouse pointer shape changes or pointer is hidden/displaying.
270 * The new shape is passed as a caller allocated buffer that will be freed after returning.
271 *
272 * @param pInterface Pointer to this interface.
273 * @param fVisible Whether the pointer is visible or not.
274 * @param fAlpha Alpha channel information is present.
275 * @param xHot Horizontal coordinate of the pointer hot spot.
276 * @param yHot Vertical coordinate of the pointer hot spot.
277 * @param width Pointer width in pixels.
278 * @param height Pointer height in pixels.
279 * @param pShape The shape buffer. If NULL, then only pointer visibility is being changed.
280 * @thread The emulation thread.
281 */
282DECLCALLBACK(void) vmmdevUpdatePointerShape(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
283 uint32_t xHot, uint32_t yHot,
284 uint32_t width, uint32_t height,
285 void *pShape)
286{
287 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
288
289 /* tell the console about it */
290 pDrv->pVMMDev->getParent()->onMousePointerShapeChange(fVisible, fAlpha,
291 xHot, yHot, width, height, pShape);
292}
293
294DECLCALLBACK(int) iface_VideoAccelEnable(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, VBVAMEMORY *pVbvaMemory)
295{
296 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
297
298 Display *display = pDrv->pVMMDev->getParent()->getDisplay();
299
300 if (display)
301 {
302 LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelEnable: %d, %p\n", fEnable, pVbvaMemory));
303 return display->VideoAccelEnable (fEnable, pVbvaMemory);
304 }
305
306 return VERR_NOT_SUPPORTED;
307}
308DECLCALLBACK(void) iface_VideoAccelFlush(PPDMIVMMDEVCONNECTOR pInterface)
309{
310 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
311
312 Display *display = pDrv->pVMMDev->getParent()->getDisplay();
313
314 if (display)
315 {
316 LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelFlush\n"));
317 display->VideoAccelFlush ();
318 }
319}
320
321DECLCALLBACK(int) vmmdevVideoModeSupported(PPDMIVMMDEVCONNECTOR pInterface, uint32_t width, uint32_t height,
322 uint32_t bpp, bool *fSupported)
323{
324 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
325
326 if (!fSupported)
327 return VERR_INVALID_PARAMETER;
328 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
329 if (framebuffer)
330 framebuffer->VideoModeSupported(width, height, bpp, (BOOL*)fSupported);
331 else
332 *fSupported = true;
333 return VINF_SUCCESS;
334}
335
336DECLCALLBACK(int) vmmdevGetHeightReduction(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *heightReduction)
337{
338 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
339
340 if (!heightReduction)
341 return VERR_INVALID_PARAMETER;
342 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
343 if (framebuffer)
344 framebuffer->COMGETTER(HeightReduction)((ULONG*)heightReduction);
345 else
346 *heightReduction = 0;
347 return VINF_SUCCESS;
348}
349
350DECLCALLBACK(int) vmmdevSetCredentialsJudgementResult(PPDMIVMMDEVCONNECTOR pInterface, uint32_t u32Flags)
351{
352 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
353
354 int rc = pDrv->pVMMDev->SetCredentialsJudgementResult (u32Flags);
355
356 return rc;
357}
358
359DECLCALLBACK(int) vmmdevSetVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect)
360{
361 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
362
363 if (!cRect)
364 return VERR_INVALID_PARAMETER;
365 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
366 if (framebuffer)
367 {
368 framebuffer->SetVisibleRegion((BYTE *)pRect, cRect);
369#if defined(RT_OS_DARWIN) && defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
370 {
371 BOOL is3denabled;
372
373 pDrv->pVMMDev->getParent()->machine()->COMGETTER(Accelerate3DEnabled)(&is3denabled);
374
375 if (is3denabled)
376 {
377 VBOXHGCMSVCPARM parms[2];
378
379 parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
380 parms[0].u.pointer.addr = pRect;
381 parms[0].u.pointer.size = 0; /* We don't actually care. */
382 parms[1].type = VBOX_HGCM_SVC_PARM_32BIT;
383 parms[1].u.uint32 = cRect;
384
385 int rc = pDrv->pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL", SHCRGL_HOST_FN_SET_VISIBLE_REGION, 2, &parms[0]);
386 return rc;
387 }
388 }
389#endif
390 }
391
392 return VINF_SUCCESS;
393}
394
395DECLCALLBACK(int) vmmdevQueryVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect)
396{
397 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
398
399 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
400 if (framebuffer)
401 {
402 ULONG cRect = 0;
403 framebuffer->GetVisibleRegion((BYTE *)pRect, cRect, &cRect);
404
405 *pcRect = cRect;
406 }
407
408 return VINF_SUCCESS;
409}
410
411/**
412 * Request the statistics interval
413 *
414 * @returns VBox status code.
415 * @param pInterface Pointer to this interface.
416 * @param pulInterval Pointer to interval in seconds
417 * @thread The emulation thread.
418 */
419DECLCALLBACK(int) vmmdevQueryStatisticsInterval(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval)
420{
421 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
422 ULONG val = 0;
423
424 if (!pulInterval)
425 return VERR_INVALID_POINTER;
426
427 /* store that information in IGuest */
428 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
429 Assert(guest);
430 if (!guest)
431 return VERR_INVALID_PARAMETER; /** @todo wrong error */
432
433 guest->COMGETTER(StatisticsUpdateInterval)(&val);
434 *pulInterval = val;
435 return VINF_SUCCESS;
436}
437
438/**
439 * Report new guest statistics
440 *
441 * @returns VBox status code.
442 * @param pInterface Pointer to this interface.
443 * @param pGuestStats Guest statistics
444 * @thread The emulation thread.
445 */
446DECLCALLBACK(int) vmmdevReportStatistics(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestStatistics *pGuestStats)
447{
448 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
449
450 Assert(pGuestStats);
451 if (!pGuestStats)
452 return VERR_INVALID_POINTER;
453
454 /* store that information in IGuest */
455 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
456 Assert(guest);
457 if (!guest)
458 return VERR_INVALID_PARAMETER; /** @todo wrong error */
459
460 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_IDLE)
461 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUIDLE, pGuestStats->u32CpuLoad_Idle);
462
463 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_KERNEL)
464 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUKERNEL, pGuestStats->u32CpuLoad_Kernel);
465
466 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_USER)
467 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUUSER, pGuestStats->u32CpuLoad_User);
468
469
470 /* Note that reported values are in pages; upper layers expect them in megabytes */
471 Assert(pGuestStats->u32PageSize == 4096);
472 if (pGuestStats->u32PageSize != 4096)
473 pGuestStats->u32PageSize = 4096;
474
475 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_TOTAL)
476 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMTOTAL, (pGuestStats->u32PhysMemTotal + (_1M/pGuestStats->u32PageSize)-1) / (_1M/pGuestStats->u32PageSize));
477
478 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_AVAIL)
479 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMFREE, pGuestStats->u32PhysMemAvail / (_1M/pGuestStats->u32PageSize));
480
481 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_BALLOON)
482 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMBALLOON, pGuestStats->u32PhysMemBalloon / (_1M/pGuestStats->u32PageSize));
483
484 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_MEM_SYSTEM_CACHE)
485 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMCACHE, pGuestStats->u32MemSystemCache / (_1M/pGuestStats->u32PageSize));
486
487 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PAGE_FILE_SIZE)
488 guest->SetStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_PAGETOTAL, pGuestStats->u32PageFileSize / (_1M/pGuestStats->u32PageSize));
489
490 return VINF_SUCCESS;
491}
492
493#ifdef VBOX_WITH_HGCM
494
495/* HGCM connector interface */
496
497static DECLCALLBACK(int) iface_hgcmConnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID)
498{
499 LogSunlover(("Enter\n"));
500
501 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
502
503 if ( !pServiceLocation
504 || ( pServiceLocation->type != VMMDevHGCMLoc_LocalHost
505 && pServiceLocation->type != VMMDevHGCMLoc_LocalHost_Existing))
506 {
507 return VERR_INVALID_PARAMETER;
508 }
509
510 if (!pDrv->pVMMDev->hgcmIsActive ())
511 {
512 return VERR_INVALID_STATE;
513 }
514
515 return HGCMGuestConnect (pDrv->pHGCMPort, pCmd, pServiceLocation->u.host.achName, pu32ClientID);
516}
517
518static DECLCALLBACK(int) iface_hgcmDisconnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID)
519{
520 LogSunlover(("Enter\n"));
521
522 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
523
524 if (!pDrv->pVMMDev->hgcmIsActive ())
525 {
526 return VERR_INVALID_STATE;
527 }
528
529 return HGCMGuestDisconnect (pDrv->pHGCMPort, pCmd, u32ClientID);
530}
531
532static DECLCALLBACK(int) iface_hgcmCall (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
533 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
534{
535 LogSunlover(("Enter\n"));
536
537 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
538
539 if (!pDrv->pVMMDev->hgcmIsActive ())
540 {
541 return VERR_INVALID_STATE;
542 }
543
544 return HGCMGuestCall (pDrv->pHGCMPort, pCmd, u32ClientID, u32Function, cParms, paParms);
545}
546
547/**
548 * Execute state save operation.
549 *
550 * @returns VBox status code.
551 * @param pDrvIns Driver instance of the driver which registered the data unit.
552 * @param pSSM SSM operation handle.
553 */
554static DECLCALLBACK(int) iface_hgcmSave(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
555{
556 LogSunlover(("Enter\n"));
557 return HGCMHostSaveState (pSSM);
558}
559
560
561/**
562 * Execute state load operation.
563 *
564 * @returns VBox status code.
565 * @param pDrvIns Driver instance of the driver which registered the data unit.
566 * @param pSSM SSM operation handle.
567 * @param uVersion Data layout version.
568 * @param uPass The data pass.
569 */
570static DECLCALLBACK(int) iface_hgcmLoad(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
571{
572 LogFlowFunc(("Enter\n"));
573
574 if (uVersion != HGCM_SSM_VERSION)
575 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
576 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
577
578 return HGCMHostLoadState (pSSM);
579}
580
581int VMMDev::hgcmLoadService (const char *pszServiceLibrary, const char *pszServiceName)
582{
583 if (!hgcmIsActive ())
584 {
585 return VERR_INVALID_STATE;
586 }
587 return HGCMHostLoad (pszServiceLibrary, pszServiceName);
588}
589
590int VMMDev::hgcmHostCall (const char *pszServiceName, uint32_t u32Function,
591 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
592{
593 if (!hgcmIsActive ())
594 {
595 return VERR_INVALID_STATE;
596 }
597 return HGCMHostCall (pszServiceName, u32Function, cParms, paParms);
598}
599
600void VMMDev::hgcmShutdown (void)
601{
602 ASMAtomicWriteBool(&m_fHGCMActive, false);
603 HGCMHostShutdown ();
604}
605
606#endif /* HGCM */
607
608
609/**
610 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
611 */
612DECLCALLBACK(void *) VMMDev::drvQueryInterface(PPDMIBASE pInterface, const char *pszIID)
613{
614 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
615 PDRVMAINVMMDEV pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
616
617 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
618 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIVMMDEVCONNECTOR, &pDrv->Connector);
619#ifdef VBOX_WITH_HGCM
620 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHGCMCONNECTOR, &pDrv->HGCMConnector);
621#endif
622 return NULL;
623}
624
625/**
626 * Destruct a VMMDev driver instance.
627 *
628 * @returns VBox status.
629 * @param pDrvIns The driver instance data.
630 */
631DECLCALLBACK(void) VMMDev::drvDestruct(PPDMDRVINS pDrvIns)
632{
633 PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
634 LogFlow(("VMMDev::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
635#ifdef VBOX_WITH_HGCM
636 /* HGCM is shut down on the VMMDev destructor. */
637#endif /* VBOX_WITH_HGCM */
638 if (pData->pVMMDev)
639 {
640 pData->pVMMDev->mpDrv = NULL;
641 }
642}
643
644/**
645 * Reset notification.
646 *
647 * @returns VBox status.
648 * @param pDrvIns The driver instance data.
649 */
650DECLCALLBACK(void) VMMDev::drvReset(PPDMDRVINS pDrvIns)
651{
652 LogFlow(("VMMDev::drvReset: iInstance=%d\n", pDrvIns->iInstance));
653#ifdef VBOX_WITH_HGCM
654 HGCMHostReset ();
655#endif /* VBOX_WITH_HGCM */
656}
657
658/**
659 * Construct a VMMDev driver instance.
660 *
661 * @copydoc FNPDMDRVCONSTRUCT
662 */
663DECLCALLBACK(int) VMMDev::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle, uint32_t fFlags)
664{
665 PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
666 LogFlow(("Keyboard::drvConstruct: iInstance=%d\n", pDrvIns->iInstance));
667
668 /*
669 * Validate configuration.
670 */
671 if (!CFGMR3AreValuesValid(pCfgHandle, "Object\0"))
672 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
673 AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
674 ("Configuration error: Not possible to attach anything to this driver!\n"),
675 VERR_PDM_DRVINS_NO_ATTACH);
676
677 /*
678 * IBase.
679 */
680 pDrvIns->IBase.pfnQueryInterface = VMMDev::drvQueryInterface;
681
682 pData->Connector.pfnUpdateGuestVersion = vmmdevUpdateGuestVersion;
683 pData->Connector.pfnUpdateGuestCapabilities = vmmdevUpdateGuestCapabilities;
684 pData->Connector.pfnUpdateMouseCapabilities = vmmdevUpdateMouseCapabilities;
685 pData->Connector.pfnUpdatePointerShape = vmmdevUpdatePointerShape;
686 pData->Connector.pfnVideoAccelEnable = iface_VideoAccelEnable;
687 pData->Connector.pfnVideoAccelFlush = iface_VideoAccelFlush;
688 pData->Connector.pfnVideoModeSupported = vmmdevVideoModeSupported;
689 pData->Connector.pfnGetHeightReduction = vmmdevGetHeightReduction;
690 pData->Connector.pfnSetCredentialsJudgementResult = vmmdevSetCredentialsJudgementResult;
691 pData->Connector.pfnSetVisibleRegion = vmmdevSetVisibleRegion;
692 pData->Connector.pfnQueryVisibleRegion = vmmdevQueryVisibleRegion;
693 pData->Connector.pfnReportStatistics = vmmdevReportStatistics;
694 pData->Connector.pfnQueryStatisticsInterval = vmmdevQueryStatisticsInterval;
695
696#ifdef VBOX_WITH_HGCM
697 pData->HGCMConnector.pfnConnect = iface_hgcmConnect;
698 pData->HGCMConnector.pfnDisconnect = iface_hgcmDisconnect;
699 pData->HGCMConnector.pfnCall = iface_hgcmCall;
700#endif
701
702 /*
703 * Get the IVMMDevPort interface of the above driver/device.
704 */
705 pData->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIVMMDEVPORT);
706 AssertMsgReturn(pData->pUpPort, ("Configuration error: No VMMDev port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
707
708#ifdef VBOX_WITH_HGCM
709 pData->pHGCMPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIHGCMPORT);
710 AssertMsgReturn(pData->pHGCMPort, ("Configuration error: No HGCM port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
711#endif
712
713 /*
714 * Get the Console object pointer and update the mpDrv member.
715 */
716 void *pv;
717 int rc = CFGMR3QueryPtr(pCfgHandle, "Object", &pv);
718 if (RT_FAILURE(rc))
719 {
720 AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
721 return rc;
722 }
723
724 pData->pVMMDev = (VMMDev*)pv; /** @todo Check this cast! */
725 pData->pVMMDev->mpDrv = pData;
726
727#ifdef VBOX_WITH_HGCM
728 rc = pData->pVMMDev->hgcmLoadService (VBOXSHAREDFOLDERS_DLL,
729 "VBoxSharedFolders");
730 pData->pVMMDev->fSharedFolderActive = RT_SUCCESS(rc);
731 if (RT_SUCCESS(rc))
732 {
733 PPDMLED pLed;
734 PPDMILEDPORTS pLedPort;
735
736 LogRel(("Shared Folders service loaded.\n"));
737 pLedPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMILEDPORTS);
738 AssertMsgReturn(pLedPort, ("Configuration error: No LED port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
739 rc = pLedPort->pfnQueryStatusLed(pLedPort, 0, &pLed);
740 if (RT_SUCCESS(rc) && pLed)
741 {
742 VBOXHGCMSVCPARM parm;
743
744 parm.type = VBOX_HGCM_SVC_PARM_PTR;
745 parm.u.pointer.addr = pLed;
746 parm.u.pointer.size = sizeof(*pLed);
747
748 rc = HGCMHostCall("VBoxSharedFolders", SHFL_FN_SET_STATUS_LED, 1, &parm);
749 }
750 else
751 AssertMsgFailed(("pfnQueryStatusLed failed with %Rrc (pLed=%x)\n", rc, pLed));
752 }
753 else
754 LogRel(("Failed to load Shared Folders service %Rrc\n", rc));
755
756 rc = PDMDrvHlpSSMRegisterEx(pDrvIns, HGCM_SSM_VERSION, 4096 /* bad guess */,
757 NULL, NULL, NULL,
758 NULL, iface_hgcmSave, NULL,
759 NULL, iface_hgcmLoad, NULL);
760 if (RT_FAILURE(rc))
761 return rc;
762
763#endif /* VBOX_WITH_HGCM */
764
765 return VINF_SUCCESS;
766}
767
768
769/**
770 * VMMDevice driver registration record.
771 */
772const PDMDRVREG VMMDev::DrvReg =
773{
774 /* u32Version */
775 PDM_DRVREG_VERSION,
776 /* szName */
777 "HGCM",
778 /* szRCMod */
779 "",
780 /* szR0Mod */
781 "",
782 /* pszDescription */
783 "Main VMMDev driver (Main as in the API).",
784 /* fFlags */
785 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
786 /* fClass. */
787 PDM_DRVREG_CLASS_VMMDEV,
788 /* cMaxInstances */
789 ~0,
790 /* cbInstance */
791 sizeof(DRVMAINVMMDEV),
792 /* pfnConstruct */
793 VMMDev::drvConstruct,
794 /* pfnDestruct */
795 VMMDev::drvDestruct,
796 /* pfnRelocate */
797 NULL,
798 /* pfnIOCtl */
799 NULL,
800 /* pfnPowerOn */
801 NULL,
802 /* pfnReset */
803 VMMDev::drvReset,
804 /* pfnSuspend */
805 NULL,
806 /* pfnResume */
807 NULL,
808 /* pfnAttach */
809 NULL,
810 /* pfnDetach */
811 NULL,
812 /* pfnPowerOff */
813 NULL,
814 /* pfnSoftReset */
815 NULL,
816 /* u32EndVersion */
817 PDM_DRVREG_VERSION
818};
819/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette