VMMDevInterface.cpp@ 67414

Last change on this file since 67414 was 65088, checked in by vboxsync, 8 years ago
Main: doxygen fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 30.6 KB

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

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

source: vbox/trunk/src/VBox/Main/src-client/VMMDevInterface.cpp@ 67414

Download in other formats: