VMMDevInterface.cpp@ 33973

Last change on this file since 33973 was 33758, checked in by vboxsync, 14 years ago
Main, Devices/VMMDev, VBoxBFE: some rewrites of the mouse handling code
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 31.8 KB

Line
1	/* $Id: VMMDevInterface.cpp 33758 2010-11-04 10:30:19Z vboxsync $ */
2	/** @file
3	* VirtualBox Driver Interface to VMM device.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. 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
18	#include "VMMDev.h"
19	#include "ConsoleImpl.h"
20	#include "DisplayImpl.h"
21	#include "GuestImpl.h"
22	#include "MouseImpl.h"
23
24	#include "Logging.h"
25
26	#include <VBox/pdmdrv.h>
27	#include <VBox/VMMDev.h>
28	#include <VBox/shflsvc.h>
29	#include <iprt/asm.h>
30
31	#ifdef VBOX_WITH_HGCM
32	#include "hgcm/HGCM.h"
33	#include "hgcm/HGCMObjects.h"
34	# if defined(RT_OS_DARWIN) && defined(VBOX_WITH_CROGL)
35	# include <VBox/HostServices/VBoxCrOpenGLSvc.h>
36	# endif
37	#endif
38
39	//
40	// defines
41	//
42
43	#ifdef RT_OS_OS2
44	# define VBOXSHAREDFOLDERS_DLL "VBoxSFld"
45	#else
46	# define VBOXSHAREDFOLDERS_DLL "VBoxSharedFolders"
47	#endif
48
49	//
50	// globals
51	//
52
53
54	/**
55	* VMMDev driver instance data.
56	*/
57	typedef struct DRVMAINVMMDEV
58	{
59	/** Pointer to the VMMDev object. */
60	VMMDev *pVMMDev;
61	/** Pointer to the driver instance structure. */
62	PPDMDRVINS pDrvIns;
63	/** Pointer to the VMMDev port interface of the driver/device above us. */
64	PPDMIVMMDEVPORT pUpPort;
65	/** Our VMM device connector interface. */
66	PDMIVMMDEVCONNECTOR Connector;
67
68	#ifdef VBOX_WITH_HGCM
69	/** Pointer to the HGCM port interface of the driver/device above us. */
70	PPDMIHGCMPORT pHGCMPort;
71	/** Our HGCM connector interface. */
72	PDMIHGCMCONNECTOR HGCMConnector;
73	#endif
74	} DRVMAINVMMDEV, *PDRVMAINVMMDEV;
75
76	/** Converts PDMIVMMDEVCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
77	#define PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, Connector)) )
78
79	#ifdef VBOX_WITH_HGCM
80	/** Converts PDMIHGCMCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
81	#define PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, HGCMConnector)) )
82	#endif
83
84	//
85	// constructor / destructor
86	//
87	VMMDev::VMMDev(Console *console)
88	: mpDrv(NULL),
89	mParent(console)
90	{
91	int rc = RTSemEventCreate(&mCredentialsEvent);
92	AssertRC(rc);
93	#ifdef VBOX_WITH_HGCM
94	rc = HGCMHostInit ();
95	AssertRC(rc);
96	m_fHGCMActive = true;
97	#endif /* VBOX_WITH_HGCM */
98	mu32CredentialsFlags = 0;
99	}
100
101	VMMDev::~VMMDev()
102	{
103	#ifdef VBOX_WITH_HGCM
104	if (hgcmIsActive())
105	{
106	ASMAtomicWriteBool(&m_fHGCMActive, false);
107	HGCMHostShutdown();
108	}
109	#endif /* VBOX_WITH_HGCM */
110	RTSemEventDestroy (mCredentialsEvent);
111	if (mpDrv)
112	mpDrv->pVMMDev = NULL;
113	mpDrv = NULL;
114	}
115
116	PPDMIVMMDEVPORT VMMDev::getVMMDevPort()
117	{
118	AssertReturn(mpDrv, NULL);
119	return mpDrv->pUpPort;
120	}
121
122
123
124	//
125	// public methods
126	//
127
128	/**
129	* Wait on event semaphore for guest credential judgement result.
130	*/
131	int VMMDev::WaitCredentialsJudgement(uint32_t u32Timeout, uint32_t *pu32CredentialsFlags)
132	{
133	if (u32Timeout == 0)
134	{
135	u32Timeout = 5000;
136	}
137
138	int rc = RTSemEventWait (mCredentialsEvent, u32Timeout);
139
140	if (RT_SUCCESS(rc))
141	{
142	*pu32CredentialsFlags = mu32CredentialsFlags;
143	}
144
145	return rc;
146	}
147
148	int VMMDev::SetCredentialsJudgementResult(uint32_t u32Flags)
149	{
150	mu32CredentialsFlags = u32Flags;
151
152	int rc = RTSemEventSignal (mCredentialsEvent);
153	AssertRC(rc);
154
155	return rc;
156	}
157
158
159	/**
160	* Reports Guest Additions status.
161	* Called whenever the Additions issue a guest status report request or the VM is reset.
162	*
163	* @param pInterface Pointer to this interface.
164	* @param guestInfo Pointer to guest information structure
165	* @thread The emulation thread.
166	*/
167	DECLCALLBACK(void) vmmdevUpdateGuestStatus(PPDMIVMMDEVCONNECTOR pInterface, const VBoxGuestStatus *guestStatus)
168	{
169	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
170
171	Assert(guestStatus);
172	if (!guestStatus)
173	return;
174
175	Console *pConsole = pDrv->pVMMDev->getParent();
176
177	/* Store that information in IGuest */
178	Guest* guest = pConsole->getGuest();
179	Assert(guest);
180	if (!guest)
181	return;
182
183	guest->setAdditionsStatus(guestStatus->facility, guestStatus->status, guestStatus->flags);
184	pConsole->onAdditionsStateChange();
185	}
186
187
188	/**
189	* Reports Guest Additions API and OS version.
190	* Called whenever the Additions issue a guest version report request or the VM is reset.
191	*
192	* @param pInterface Pointer to this interface.
193	* @param guestInfo Pointer to guest information structure.
194	* @thread The emulation thread.
195	*/
196	DECLCALLBACK(void) vmmdevUpdateGuestInfo(PPDMIVMMDEVCONNECTOR pInterface, const VBoxGuestInfo *guestInfo)
197	{
198	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
199
200	Assert(guestInfo);
201	if (!guestInfo)
202	return;
203
204	Console *pConsole = pDrv->pVMMDev->getParent();
205
206	/* Store that information in IGuest */
207	Guest* guest = pConsole->getGuest();
208	Assert(guest);
209	if (!guest)
210	return;
211
212	if (guestInfo->interfaceVersion != 0)
213	{
214	char version[16];
215	RTStrPrintf(version, sizeof(version), "%d", guestInfo->interfaceVersion);
216	guest->setAdditionsInfo(Bstr(version), guestInfo->osType);
217
218	/*
219	* Tell the console interface about the event
220	* so that it can notify its consumers.
221	*/
222	pConsole->onAdditionsStateChange();
223
224	if (guestInfo->interfaceVersion < VMMDEV_VERSION)
225	pConsole->onAdditionsOutdated();
226	}
227	else
228	{
229	/*
230	* The guest additions was disabled because of a reset
231	* or driver unload.
232	*/
233	guest->setAdditionsInfo(Bstr(), guestInfo->osType); /* Clear interface version + OS type. */
234	guest->setAdditionsInfo2(Bstr(), Bstr(), Bstr()); /* Clear Guest Additions version. */
235	guest->setAdditionsStatus(VBoxGuestStatusFacility_All,
236	VBoxGuestStatusCurrent_Inactive,
237	0); /* Flags; not used. */
238	pConsole->onAdditionsStateChange();
239	}
240	}
241
242	/**
243	* Reports the detailed Guest Additions version.
244	* Called whenever the Additions issue a guest version report request or the VM is reset.
245	*
246	* @param pInterface Pointer to this interface.
247	* @param guestInfo Pointer to Guest Additions information structure.
248	* @thread The emulation thread.
249	*/
250	DECLCALLBACK(void) vmmdevUpdateGuestInfo2(PPDMIVMMDEVCONNECTOR pInterface, const VBoxGuestInfo2 *guestInfo)
251	{
252	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
253
254	Assert(guestInfo);
255	if (!guestInfo)
256	return;
257
258	/* Store that information in IGuest. */
259	Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
260	Assert(guest);
261	if (!guest)
262	return;
263
264	if ( guestInfo->additionsMajor != 0
265	&& guestInfo->additionsRevision != 0)
266	{
267	char version[32];
268	RTStrPrintf(version, sizeof(version), "%d.%d.%dr%ld", guestInfo->additionsMajor,
269	guestInfo->additionsMinor,
270	guestInfo->additionsBuild,
271	guestInfo->additionsRevision);
272	char revision[16];
273	RTStrPrintf(revision, sizeof(revision), "%ld", guestInfo->additionsRevision);
274	guest->setAdditionsInfo2(Bstr(version), Bstr(guestInfo->szName), Bstr(revision));
275
276	/*
277	* No need to tell the console interface about the update;
278	* vmmdevUpdateGuestInfo takes care of that when called as the
279	* last event in the chain.
280	*/
281	}
282	}
283
284	/**
285	* Update the guest additions capabilities.
286	* This is called when the guest additions capabilities change. The new capabilities
287	* are given and the connector should update its internal state.
288	*
289	* @param pInterface Pointer to this interface.
290	* @param newCapabilities New capabilities.
291	* @thread The emulation thread.
292	*/
293	DECLCALLBACK(void) vmmdevUpdateGuestCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
294	{
295	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
296	Console *pConsole = pDrv->pVMMDev->getParent();
297
298	/* store that information in IGuest */
299	Guest* guest = pConsole->getGuest();
300	Assert(guest);
301	if (!guest)
302	return;
303
304	/*
305	* Report our current capabilities (and assume none is active yet).
306	*/
307	guest->setSupportedFeatures(newCapabilities, 0 /* Active capabilities, not used here. */);
308
309	/*
310	* Tell the console interface about the event
311	* so that it can notify its consumers.
312	*/
313	pConsole->onAdditionsStateChange();
314	}
315
316	/**
317	* Update the mouse capabilities.
318	* This is called when the mouse capabilities change. The new capabilities
319	* are given and the connector should update its internal state.
320	*
321	* @param pInterface Pointer to this interface.
322	* @param newCapabilities New capabilities.
323	* @thread The emulation thread.
324	*/
325	DECLCALLBACK(void) vmmdevUpdateMouseCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t fNewCaps)
326	{
327	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
328	Console *pConsole = pDrv->pVMMDev->getParent();
329
330	/*
331	* Tell the console interface about the event
332	* so that it can notify its consumers.
333	*/
334	Mouse *pMouse = pConsole->getMouse();
335	if (pMouse) /** @todo and if not? Can that actually happen? */
336	pMouse->onVMMDevGuestCapsChange(fNewCaps & VMMDEV_MOUSE_GUEST_MASK);
337	}
338
339	/**
340	* Update the pointer shape or visibility.
341	*
342	* This is called when the mouse pointer shape changes or pointer is hidden/displaying.
343	* The new shape is passed as a caller allocated buffer that will be freed after returning.
344	*
345	* @param pInterface Pointer to this interface.
346	* @param fVisible Whether the pointer is visible or not.
347	* @param fAlpha Alpha channel information is present.
348	* @param xHot Horizontal coordinate of the pointer hot spot.
349	* @param yHot Vertical coordinate of the pointer hot spot.
350	* @param width Pointer width in pixels.
351	* @param height Pointer height in pixels.
352	* @param pShape The shape buffer. If NULL, then only pointer visibility is being changed.
353	* @thread The emulation thread.
354	*/
355	DECLCALLBACK(void) vmmdevUpdatePointerShape(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
356	uint32_t xHot, uint32_t yHot,
357	uint32_t width, uint32_t height,
358	void *pShape)
359	{
360	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
361	Console *pConsole = pDrv->pVMMDev->getParent();
362
363	/* tell the console about it */
364	size_t cbShapeSize = 0;
365
366	if (pShape)
367	{
368	cbShapeSize = (width + 7) / 8 * height; /* size of the AND mask */
369	cbShapeSize = ((cbShapeSize + 3) & ~3) + width * 4 * height; /* + gap + size of the XOR mask */
370	}
371	com::SafeArray<BYTE> shapeData(cbShapeSize);
372	if (pShape)
373	::memcpy(shapeData.raw(), pShape, cbShapeSize);
374	pConsole->onMousePointerShapeChange(fVisible, fAlpha, xHot, yHot, width, height, ComSafeArrayAsInParam(shapeData));
375	}
376
377	DECLCALLBACK(int) iface_VideoAccelEnable(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, VBVAMEMORY *pVbvaMemory)
378	{
379	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
380	Console *pConsole = pDrv->pVMMDev->getParent();
381
382	Display *display = pConsole->getDisplay();
383
384	if (display)
385	{
386	LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelEnable: %d, %p\n", fEnable, pVbvaMemory));
387	return display->VideoAccelEnable(fEnable, pVbvaMemory);
388	}
389
390	return VERR_NOT_SUPPORTED;
391	}
392	DECLCALLBACK(void) iface_VideoAccelFlush(PPDMIVMMDEVCONNECTOR pInterface)
393	{
394	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
395	Console *pConsole = pDrv->pVMMDev->getParent();
396
397	Display *display = pConsole->getDisplay();
398
399	if (display)
400	{
401	LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelFlush\n"));
402	display->VideoAccelFlush ();
403	}
404	}
405
406	DECLCALLBACK(int) vmmdevVideoModeSupported(PPDMIVMMDEVCONNECTOR pInterface, uint32_t display, uint32_t width, uint32_t height,
407	uint32_t bpp, bool *fSupported)
408	{
409	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
410	Console *pConsole = pDrv->pVMMDev->getParent();
411
412	if (!fSupported)
413	return VERR_INVALID_PARAMETER;
414	#ifdef DEBUG_sunlover
415	Log(("vmmdevVideoModeSupported: [%d]: %dx%dx%d\n", display, width, height, bpp));
416	#endif
417	IFramebuffer *framebuffer = NULL;
418	LONG xOrigin = 0;
419	LONG yOrigin = 0;
420	HRESULT hrc = pConsole->getDisplay()->GetFramebuffer(display, &framebuffer, &xOrigin, &yOrigin);
421	if (SUCCEEDED(hrc) && framebuffer)
422	{
423	framebuffer->VideoModeSupported(width, height, bpp, (BOOL*)fSupported);
424	framebuffer->Release();
425	}
426	else
427	{
428	#ifdef DEBUG_sunlover
429	Log(("vmmdevVideoModeSupported: hrc %x, framebuffer %p!!!\n", hrc, framebuffer));
430	#endif
431	*fSupported = true;
432	}
433	return VINF_SUCCESS;
434	}
435
436	DECLCALLBACK(int) vmmdevGetHeightReduction(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *heightReduction)
437	{
438	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
439	Console *pConsole = pDrv->pVMMDev->getParent();
440
441	if (!heightReduction)
442	return VERR_INVALID_PARAMETER;
443	IFramebuffer *framebuffer = pConsole->getDisplay()->getFramebuffer();
444	if (framebuffer)
445	framebuffer->COMGETTER(HeightReduction)((ULONG*)heightReduction);
446	else
447	*heightReduction = 0;
448	return VINF_SUCCESS;
449	}
450
451	DECLCALLBACK(int) vmmdevSetCredentialsJudgementResult(PPDMIVMMDEVCONNECTOR pInterface, uint32_t u32Flags)
452	{
453	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
454
455	if (pDrv->pVMMDev)
456	return pDrv->pVMMDev->SetCredentialsJudgementResult (u32Flags);
457
458	return VERR_GENERAL_FAILURE;
459	}
460
461	DECLCALLBACK(int) vmmdevSetVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect)
462	{
463	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
464	Console *pConsole = pDrv->pVMMDev->getParent();
465
466	if (!cRect)
467	return VERR_INVALID_PARAMETER;
468	#ifdef MMSEAMLESS
469	/* Forward to Display, which calls corresponding framebuffers. */
470	pConsole->getDisplay()->handleSetVisibleRegion(cRect, pRect);
471	#else
472	IFramebuffer *framebuffer = pConsole->getDisplay()->getFramebuffer();
473	if (framebuffer)
474	{
475	framebuffer->SetVisibleRegion((BYTE *)pRect, cRect);
476	#if defined(RT_OS_DARWIN) && defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
477	{
478	BOOL is3denabled;
479
480	pConsole->machine()->COMGETTER(Accelerate3DEnabled)(&is3denabled);
481
482	if (is3denabled)
483	{
484	VBOXHGCMSVCPARM parms[2];
485
486	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
487	parms[0].u.pointer.addr = pRect;
488	parms[0].u.pointer.size = 0; /* We don't actually care. */
489	parms[1].type = VBOX_HGCM_SVC_PARM_32BIT;
490	parms[1].u.uint32 = cRect;
491
492	if (pDrv->pVMMDev)
493	return pDrv->pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL", SHCRGL_HOST_FN_SET_VISIBLE_REGION, 2, &parms[0]);
494	}
495	}
496	#endif
497	}
498	#endif
499
500	return VINF_SUCCESS;
501	}
502
503	DECLCALLBACK(int) vmmdevQueryVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect)
504	{
505	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
506	Console *pConsole = pDrv->pVMMDev->getParent();
507
508	#ifdef MMSEAMLESS
509	/* Forward to Display, which calls corresponding framebuffers. */
510	pConsole->getDisplay()->handleQueryVisibleRegion(pcRect, pRect);
511	#else
512	IFramebuffer *framebuffer = pConsole->getDisplay()->getFramebuffer();
513	if (framebuffer)
514	{
515	ULONG cRect = 0;
516	framebuffer->GetVisibleRegion((BYTE *)pRect, cRect, &cRect);
517
518	*pcRect = cRect;
519	}
520	#endif
521
522	return VINF_SUCCESS;
523	}
524
525	/**
526	* Request the statistics interval
527	*
528	* @returns VBox status code.
529	* @param pInterface Pointer to this interface.
530	* @param pulInterval Pointer to interval in seconds
531	* @thread The emulation thread.
532	*/
533	DECLCALLBACK(int) vmmdevQueryStatisticsInterval(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval)
534	{
535	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
536	Console *pConsole = pDrv->pVMMDev->getParent();
537	ULONG val = 0;
538
539	if (!pulInterval)
540	return VERR_INVALID_POINTER;
541
542	/* store that information in IGuest */
543	Guest* guest = pConsole->getGuest();
544	Assert(guest);
545	if (!guest)
546	return VERR_GENERAL_FAILURE;
547
548	guest->COMGETTER(StatisticsUpdateInterval)(&val);
549	*pulInterval = val;
550	return VINF_SUCCESS;
551	}
552
553	/**
554	* Query the current balloon size
555	*
556	* @returns VBox status code.
557	* @param pInterface Pointer to this interface.
558	* @param pcbBalloon Balloon size
559	* @thread The emulation thread.
560	*/
561	DECLCALLBACK(int) vmmdevQueryBalloonSize(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcbBalloon)
562	{
563	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
564	Console *pConsole = pDrv->pVMMDev->getParent();
565	ULONG val = 0;
566
567	if (!pcbBalloon)
568	return VERR_INVALID_POINTER;
569
570	/* store that information in IGuest */
571	Guest* guest = pConsole->getGuest();
572	Assert(guest);
573	if (!guest)
574	return VERR_GENERAL_FAILURE;
575
576	guest->COMGETTER(MemoryBalloonSize)(&val);
577	*pcbBalloon = val;
578	return VINF_SUCCESS;
579	}
580
581	/**
582	* Query the current page fusion setting
583	*
584	* @returns VBox status code.
585	* @param pInterface Pointer to this interface.
586	* @param pfPageFusionEnabled Pointer to boolean
587	* @thread The emulation thread.
588	*/
589	DECLCALLBACK(int) vmmdevIsPageFusionEnabled(PPDMIVMMDEVCONNECTOR pInterface, bool *pfPageFusionEnabled)
590	{
591	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
592	Console *pConsole = pDrv->pVMMDev->getParent();
593	BOOL val = 0;
594
595	if (!pfPageFusionEnabled)
596	return VERR_INVALID_POINTER;
597
598	/* store that information in IGuest */
599	Guest* guest = pConsole->getGuest();
600	Assert(guest);
601	if (!guest)
602	return VERR_GENERAL_FAILURE;
603
604	*pfPageFusionEnabled = !!guest->isPageFusionEnabled();
605	return VINF_SUCCESS;
606	}
607
608	/**
609	* Report new guest statistics
610	*
611	* @returns VBox status code.
612	* @param pInterface Pointer to this interface.
613	* @param pGuestStats Guest statistics
614	* @thread The emulation thread.
615	*/
616	DECLCALLBACK(int) vmmdevReportStatistics(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestStatistics *pGuestStats)
617	{
618	PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
619	Console *pConsole = pDrv->pVMMDev->getParent();
620
621	Assert(pGuestStats);
622	if (!pGuestStats)
623	return VERR_INVALID_POINTER;
624
625	/* store that information in IGuest */
626	Guest* guest = pConsole->getGuest();
627	Assert(guest);
628	if (!guest)
629	return VERR_GENERAL_FAILURE;
630
631	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_IDLE)
632	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUIDLE, pGuestStats->u32CpuLoad_Idle);
633
634	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_KERNEL)
635	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUKERNEL, pGuestStats->u32CpuLoad_Kernel);
636
637	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_USER)
638	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUUSER, pGuestStats->u32CpuLoad_User);
639
640
641	/** @todo r=bird: Convert from 4KB to 1KB units?
642	* CollectorGuestHAL::getGuestMemLoad says it returns KB units to
643	* preCollect(). I might be wrong ofc, this is convoluted code... */
644	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_TOTAL)
645	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMTOTAL, pGuestStats->u32PhysMemTotal);
646
647	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_AVAIL)
648	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMFREE, pGuestStats->u32PhysMemAvail);
649
650	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_BALLOON)
651	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMBALLOON, pGuestStats->u32PhysMemBalloon);
652
653	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_MEM_SYSTEM_CACHE)
654	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMCACHE, pGuestStats->u32MemSystemCache);
655
656	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PAGE_FILE_SIZE)
657	guest->setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_PAGETOTAL, pGuestStats->u32PageFileSize);
658
659	return VINF_SUCCESS;
660	}
661
662	#ifdef VBOX_WITH_HGCM
663
664	/* HGCM connector interface */
665
666	static DECLCALLBACK(int) iface_hgcmConnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID)
667	{
668	LogSunlover(("Enter\n"));
669
670	PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
671
672	if ( !pServiceLocation
673	\|\| ( pServiceLocation->type != VMMDevHGCMLoc_LocalHost
674	&& pServiceLocation->type != VMMDevHGCMLoc_LocalHost_Existing))
675	{
676	return VERR_INVALID_PARAMETER;
677	}
678
679	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
680	return VERR_INVALID_STATE;
681
682	return HGCMGuestConnect(pDrv->pHGCMPort, pCmd, pServiceLocation->u.host.achName, pu32ClientID);
683	}
684
685	static DECLCALLBACK(int) iface_hgcmDisconnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID)
686	{
687	LogSunlover(("Enter\n"));
688
689	PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
690
691	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
692	return VERR_INVALID_STATE;
693
694	return HGCMGuestDisconnect(pDrv->pHGCMPort, pCmd, u32ClientID);
695	}
696
697	static DECLCALLBACK(int) iface_hgcmCall (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
698	uint32_t cParms, PVBOXHGCMSVCPARM paParms)
699	{
700	LogSunlover(("Enter\n"));
701
702	PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
703
704	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
705	return VERR_INVALID_STATE;
706
707	return HGCMGuestCall(pDrv->pHGCMPort, pCmd, u32ClientID, u32Function, cParms, paParms);
708	}
709
710	/**
711	* Execute state save operation.
712	*
713	* @returns VBox status code.
714	* @param pDrvIns Driver instance of the driver which registered the data unit.
715	* @param pSSM SSM operation handle.
716	*/
717	static DECLCALLBACK(int) iface_hgcmSave(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
718	{
719	LogSunlover(("Enter\n"));
720	return HGCMHostSaveState(pSSM);
721	}
722
723
724	/**
725	* Execute state load operation.
726	*
727	* @returns VBox status code.
728	* @param pDrvIns Driver instance of the driver which registered the data unit.
729	* @param pSSM SSM operation handle.
730	* @param uVersion Data layout version.
731	* @param uPass The data pass.
732	*/
733	static DECLCALLBACK(int) iface_hgcmLoad(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
734	{
735	LogFlowFunc(("Enter\n"));
736
737	if (uVersion != HGCM_SSM_VERSION)
738	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
739	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
740
741	return HGCMHostLoadState(pSSM);
742	}
743
744	int VMMDev::hgcmLoadService(const char pszServiceLibrary, const char pszServiceName)
745	{
746	if (!hgcmIsActive())
747	return VERR_INVALID_STATE;
748
749	return HGCMHostLoad(pszServiceLibrary, pszServiceName);
750	}
751
752	int VMMDev::hgcmHostCall(const char *pszServiceName, uint32_t u32Function,
753	uint32_t cParms, PVBOXHGCMSVCPARM paParms)
754	{
755	if (!hgcmIsActive())
756	return VERR_INVALID_STATE;
757	return HGCMHostCall (pszServiceName, u32Function, cParms, paParms);
758	}
759
760	void VMMDev::hgcmShutdown(void)
761	{
762	ASMAtomicWriteBool(&m_fHGCMActive, false);
763	HGCMHostShutdown();
764	}
765
766	# ifdef VBOX_WITH_CRHGSMI
767	int VMMDev::hgcmHostSvcHandleCreate (const char pszServiceName, HGCMCVSHANDLE phSvc)
768	{
769	if (!hgcmIsActive())
770	return VERR_INVALID_STATE;
771	return HGCMHostSvcHandleCreate(pszServiceName, phSvc);
772	}
773
774	int VMMDev::hgcmHostSvcHandleDestroy (HGCMCVSHANDLE hSvc)
775	{
776	if (!hgcmIsActive())
777	return VERR_INVALID_STATE;
778	return HGCMHostSvcHandleDestroy(hSvc);
779	}
780
781	int VMMDev::hgcmHostFastCallAsync (HGCMCVSHANDLE hSvc, uint32_t function, PVBOXHGCMSVCPARM pParm, PHGCMHOSTFASTCALLCB pfnCompletion, void *pvCompletion)
782	{
783	if (!hgcmIsActive())
784	return VERR_INVALID_STATE;
785	return HGCMHostFastCallAsync(hSvc, function, pParm, pfnCompletion, pvCompletion);
786	}
787	# endif
788
789	#endif /* HGCM */
790
791
792	/**
793	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
794	*/
795	DECLCALLBACK(void ) VMMDev::drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
796	{
797	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
798	PDRVMAINVMMDEV pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
799
800	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
801	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIVMMDEVCONNECTOR, &pDrv->Connector);
802	#ifdef VBOX_WITH_HGCM
803	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHGCMCONNECTOR, &pDrv->HGCMConnector);
804	#endif
805	return NULL;
806	}
807
808	/**
809	* Destruct a VMMDev driver instance.
810	*
811	* @returns VBox status.
812	* @param pDrvIns The driver instance data.
813	*/
814	DECLCALLBACK(void) VMMDev::drvDestruct(PPDMDRVINS pDrvIns)
815	{
816	PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
817	LogFlow(("VMMDev::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
818	#ifdef VBOX_WITH_HGCM
819	/* HGCM is shut down on the VMMDev destructor. */
820	#endif /* VBOX_WITH_HGCM */
821	if (pData->pVMMDev)
822	pData->pVMMDev->mpDrv = NULL;
823	}
824
825	/**
826	* Reset notification.
827	*
828	* @returns VBox status.
829	* @param pDrvIns The driver instance data.
830	*/
831	DECLCALLBACK(void) VMMDev::drvReset(PPDMDRVINS pDrvIns)
832	{
833	LogFlow(("VMMDev::drvReset: iInstance=%d\n", pDrvIns->iInstance));
834	#ifdef VBOX_WITH_HGCM
835	HGCMHostReset ();
836	#endif /* VBOX_WITH_HGCM */
837	}
838
839	/**
840	* Construct a VMMDev driver instance.
841	*
842	* @copydoc FNPDMDRVCONSTRUCT
843	*/
844	DECLCALLBACK(int) VMMDev::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle, uint32_t fFlags)
845	{
846	PDRVMAINVMMDEV pData = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
847	LogFlow(("Keyboard::drvConstruct: iInstance=%d\n", pDrvIns->iInstance));
848
849	/*
850	* Validate configuration.
851	*/
852	if (!CFGMR3AreValuesValid(pCfgHandle, "Object\0"))
853	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
854	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
855	("Configuration error: Not possible to attach anything to this driver!\n"),
856	VERR_PDM_DRVINS_NO_ATTACH);
857
858	/*
859	* IBase.
860	*/
861	pDrvIns->IBase.pfnQueryInterface = VMMDev::drvQueryInterface;
862
863	pData->Connector.pfnUpdateGuestStatus = vmmdevUpdateGuestStatus;
864	pData->Connector.pfnUpdateGuestInfo = vmmdevUpdateGuestInfo;
865	pData->Connector.pfnUpdateGuestInfo2 = vmmdevUpdateGuestInfo2;
866	pData->Connector.pfnUpdateGuestCapabilities = vmmdevUpdateGuestCapabilities;
867	pData->Connector.pfnUpdateMouseCapabilities = vmmdevUpdateMouseCapabilities;
868	pData->Connector.pfnUpdatePointerShape = vmmdevUpdatePointerShape;
869	pData->Connector.pfnVideoAccelEnable = iface_VideoAccelEnable;
870	pData->Connector.pfnVideoAccelFlush = iface_VideoAccelFlush;
871	pData->Connector.pfnVideoModeSupported = vmmdevVideoModeSupported;
872	pData->Connector.pfnGetHeightReduction = vmmdevGetHeightReduction;
873	pData->Connector.pfnSetCredentialsJudgementResult = vmmdevSetCredentialsJudgementResult;
874	pData->Connector.pfnSetVisibleRegion = vmmdevSetVisibleRegion;
875	pData->Connector.pfnQueryVisibleRegion = vmmdevQueryVisibleRegion;
876	pData->Connector.pfnReportStatistics = vmmdevReportStatistics;
877	pData->Connector.pfnQueryStatisticsInterval = vmmdevQueryStatisticsInterval;
878	pData->Connector.pfnQueryBalloonSize = vmmdevQueryBalloonSize;
879	pData->Connector.pfnIsPageFusionEnabled = vmmdevIsPageFusionEnabled;
880
881	#ifdef VBOX_WITH_HGCM
882	pData->HGCMConnector.pfnConnect = iface_hgcmConnect;
883	pData->HGCMConnector.pfnDisconnect = iface_hgcmDisconnect;
884	pData->HGCMConnector.pfnCall = iface_hgcmCall;
885	#endif
886
887	/*
888	* Get the IVMMDevPort interface of the above driver/device.
889	*/
890	pData->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIVMMDEVPORT);
891	AssertMsgReturn(pData->pUpPort, ("Configuration error: No VMMDev port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
892
893	#ifdef VBOX_WITH_HGCM
894	pData->pHGCMPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIHGCMPORT);
895	AssertMsgReturn(pData->pHGCMPort, ("Configuration error: No HGCM port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
896	#endif
897
898	/*
899	* Get the Console object pointer and update the mpDrv member.
900	*/
901	void *pv;
902	int rc = CFGMR3QueryPtr(pCfgHandle, "Object", &pv);
903	if (RT_FAILURE(rc))
904	{
905	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
906	return rc;
907	}
908
909	pData->pVMMDev = (VMMDev)pv; /* @todo Check this cast! */
910	pData->pVMMDev->mpDrv = pData;
911
912	#ifdef VBOX_WITH_HGCM
913	rc = pData->pVMMDev->hgcmLoadService(VBOXSHAREDFOLDERS_DLL,
914	"VBoxSharedFolders");
915	pData->pVMMDev->fSharedFolderActive = RT_SUCCESS(rc);
916	if (RT_SUCCESS(rc))
917	{
918	PPDMLED pLed;
919	PPDMILEDPORTS pLedPort;
920
921	LogRel(("Shared Folders service loaded.\n"));
922	pLedPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMILEDPORTS);
923	AssertMsgReturn(pLedPort, ("Configuration error: No LED port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
924	rc = pLedPort->pfnQueryStatusLed(pLedPort, 0, &pLed);
925	if (RT_SUCCESS(rc) && pLed)
926	{
927	VBOXHGCMSVCPARM parm;
928
929	parm.type = VBOX_HGCM_SVC_PARM_PTR;
930	parm.u.pointer.addr = pLed;
931	parm.u.pointer.size = sizeof(*pLed);
932
933	rc = HGCMHostCall("VBoxSharedFolders", SHFL_FN_SET_STATUS_LED, 1, &parm);
934	}
935	else
936	AssertMsgFailed(("pfnQueryStatusLed failed with %Rrc (pLed=%x)\n", rc, pLed));
937	}
938	else
939	LogRel(("Failed to load Shared Folders service %Rrc\n", rc));
940
941	rc = PDMDrvHlpSSMRegisterEx(pDrvIns, HGCM_SSM_VERSION, 4096 /* bad guess */,
942	NULL, NULL, NULL,
943	NULL, iface_hgcmSave, NULL,
944	NULL, iface_hgcmLoad, NULL);
945	if (RT_FAILURE(rc))
946	return rc;
947
948	#endif /* VBOX_WITH_HGCM */
949
950	return VINF_SUCCESS;
951	}
952
953
954	/**
955	* VMMDevice driver registration record.
956	*/
957	const PDMDRVREG VMMDev::DrvReg =
958	{
959	/* u32Version */
960	PDM_DRVREG_VERSION,
961	/* szName */
962	"HGCM",
963	/* szRCMod */
964	"",
965	/* szR0Mod */
966	"",
967	/* pszDescription */
968	"Main VMMDev driver (Main as in the API).",
969	/* fFlags */
970	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
971	/* fClass. */
972	PDM_DRVREG_CLASS_VMMDEV,
973	/* cMaxInstances */
974	~0,
975	/* cbInstance */
976	sizeof(DRVMAINVMMDEV),
977	/* pfnConstruct */
978	VMMDev::drvConstruct,
979	/* pfnDestruct */
980	VMMDev::drvDestruct,
981	/* pfnRelocate */
982	NULL,
983	/* pfnIOCtl */
984	NULL,
985	/* pfnPowerOn */
986	NULL,
987	/* pfnReset */
988	VMMDev::drvReset,
989	/* pfnSuspend */
990	NULL,
991	/* pfnResume */
992	NULL,
993	/* pfnAttach */
994	NULL,
995	/* pfnDetach */
996	NULL,
997	/* pfnPowerOff */
998	NULL,
999	/* pfnSoftReset */
1000	NULL,
1001	/* u32EndVersion */
1002	PDM_DRVREG_VERSION
1003	};
1004	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: