VMMDevInterface.cpp@ 107513

Last change on this file since 107513 was 107493, checked in by vboxsync, 3 months ago
Main/src-client/VMMDevInterface.cpp: Fixed a warning found by Parfait. jiraref:VBP-1424
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 41.9 KB

Line
1	/* $Id: VMMDevInterface.cpp 107493 2025-01-08 10:46:53Z vboxsync $ */
2	/** @file
3	* VirtualBox Driver Interface to VMM device.
4	*/
5
6	/*
7	* Copyright (C) 2006-2024 Oracle and/or its affiliates.
8	*
9	* This file is part of VirtualBox base platform packages, as
10	* available from https://www.virtualbox.org.
11	*
12	* This program is free software; you can redistribute it and/or
13	* modify it under the terms of the GNU General Public License
14	* as published by the Free Software Foundation, in version 3 of the
15	* License.
16	*
17	* This program is distributed in the hope that it will be useful, but
18	* WITHOUT ANY WARRANTY; without even the implied warranty of
19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	* General Public License for more details.
21	*
22	* You should have received a copy of the GNU General Public License
23	* along with this program; if not, see <https://www.gnu.org/licenses>.
24	*
25	* SPDX-License-Identifier: GPL-3.0-only
26	*/
27
28	#define LOG_GROUP LOG_GROUP_MAIN_VMMDEVINTERFACES
29	#include "LoggingNew.h"
30
31	#include "VMMDev.h"
32	#include "ConsoleImpl.h"
33	#include "DisplayImpl.h"
34	#include "GuestImpl.h"
35	#include "MouseImpl.h"
36
37	#include <VBox/vmm/pdmdrv.h>
38	#include <VBox/VMMDev.h>
39	#include <VBox/shflsvc.h>
40	#include <iprt/asm.h>
41
42	#ifdef VBOX_WITH_HGCM
43	# include "HGCM.h"
44	# include "HGCMObjects.h"
45	#endif
46
47	//
48	// defines
49	//
50
51	#ifdef RT_OS_OS2
52	# define VBOXSHAREDFOLDERS_DLL "VBoxSFld"
53	#else
54	# define VBOXSHAREDFOLDERS_DLL "VBoxSharedFolders"
55	#endif
56
57	//
58	// globals
59	//
60
61
62	/**
63	* VMMDev driver instance data.
64	*/
65	typedef struct DRVMAINVMMDEV
66	{
67	/** Pointer to the VMMDev object. */
68	VMMDev *pVMMDev;
69	/** Pointer to the driver instance structure. */
70	PPDMDRVINS pDrvIns;
71	/** Pointer to the VMMDev port interface of the driver/device above us. */
72	PPDMIVMMDEVPORT pUpPort;
73	/** Our VMM device connector interface. */
74	PDMIVMMDEVCONNECTOR Connector;
75
76	#ifdef VBOX_WITH_HGCM
77	/** Pointer to the HGCM port interface of the driver/device above us. */
78	PPDMIHGCMPORT pHGCMPort;
79	/** Our HGCM connector interface. */
80	PDMIHGCMCONNECTOR HGCMConnector;
81	#endif
82
83	#ifdef VBOX_WITH_GUEST_PROPS
84	HGCMSVCEXTHANDLE hHgcmSvcExtGstProps;
85	#endif
86	#ifdef VBOX_WITH_GUEST_CONTROL
87	HGCMSVCEXTHANDLE hHgcmSvcExtGstCtrl;
88	#endif
89	} DRVMAINVMMDEV, *PDRVMAINVMMDEV;
90
91	//
92	// constructor / destructor
93	//
94	VMMDev::VMMDev(Console *console)
95	: mpDrv(NULL)
96	, fSharedFolderActive(false)
97	, mParent(console)
98	{
99	int vrc = RTSemEventCreate(&mCredentialsEvent);
100	AssertRC(vrc);
101	#ifdef VBOX_WITH_HGCM
102	vrc = HGCMHostInit();
103	AssertRC(vrc);
104	m_fHGCMActive = true;
105	#endif /* VBOX_WITH_HGCM */
106	mu32CredentialsFlags = 0;
107	}
108
109	VMMDev::~VMMDev()
110	{
111	#ifdef VBOX_WITH_HGCM
112	if (ASMAtomicCmpXchgBool(&m_fHGCMActive, false, true))
113	HGCMHostShutdown(true /fUvmIsInvalid/);
114	#endif
115	RTSemEventDestroy(mCredentialsEvent);
116	if (mpDrv)
117	mpDrv->pVMMDev = NULL;
118	mpDrv = NULL;
119	}
120
121	PPDMIVMMDEVPORT VMMDev::getVMMDevPort()
122	{
123	if (!mpDrv)
124	return NULL;
125	return mpDrv->pUpPort;
126	}
127
128
129
130	//
131	// public methods
132	//
133
134	/**
135	* Wait on event semaphore for guest credential judgement result.
136	*/
137	int VMMDev::WaitCredentialsJudgement(uint32_t u32Timeout, uint32_t *pu32CredentialsFlags)
138	{
139	if (u32Timeout == 0)
140	{
141	u32Timeout = 5000;
142	}
143
144	int vrc = RTSemEventWait(mCredentialsEvent, u32Timeout);
145
146	if (RT_SUCCESS(vrc))
147	{
148	*pu32CredentialsFlags = mu32CredentialsFlags;
149	}
150
151	return vrc;
152	}
153
154	int VMMDev::SetCredentialsJudgementResult(uint32_t u32Flags)
155	{
156	mu32CredentialsFlags = u32Flags;
157
158	int vrc = RTSemEventSignal(mCredentialsEvent);
159	AssertRC(vrc);
160
161	return vrc;
162	}
163
164
165	/**
166	* @interface_method_impl{PDMIVMMDEVCONNECTOR,pfnUpdateGuestStatus}
167	*/
168	static DECLCALLBACK(void) vmmdevUpdateGuestStatus(PPDMIVMMDEVCONNECTOR pInterface, uint32_t uFacility, uint16_t uStatus,
169	uint32_t fFlags, PCRTTIMESPEC pTimeSpecTS)
170	{
171	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
172	Console *pConsole = pDrv->pVMMDev->getParent();
173
174	/* Store that information in IGuest */
175	Guest* guest = pConsole->i_getGuest();
176	AssertPtrReturnVoid(guest);
177
178	guest->i_setAdditionsStatus((VBoxGuestFacilityType)uFacility, (VBoxGuestFacilityStatus)uStatus, fFlags, pTimeSpecTS);
179	pConsole->i_onAdditionsStateChange();
180	}
181
182
183	/**
184	* @interface_method_impl{PDMIVMMDEVCONNECTOR,pfnUpdateGuestUserState}
185	*/
186	static DECLCALLBACK(void) vmmdevUpdateGuestUserState(PPDMIVMMDEVCONNECTOR pInterface,
187	const char pszUser, const char pszDomain,
188	uint32_t uState,
189	const uint8_t *pabDetails, uint32_t cbDetails)
190	{
191	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
192	AssertPtr(pDrv);
193	Console *pConsole = pDrv->pVMMDev->getParent();
194	AssertPtr(pConsole);
195
196	/* Store that information in IGuest. */
197	Guest* pGuest = pConsole->i_getGuest();
198	AssertPtrReturnVoid(pGuest);
199
200	pGuest->i_onUserStateChanged(Utf8Str(pszUser), Utf8Str(pszDomain), (VBoxGuestUserState)uState, pabDetails, cbDetails);
201	}
202
203
204	/**
205	* Reports Guest Additions API and OS version.
206	*
207	* Called whenever the Additions issue a guest version report request or the VM
208	* is reset.
209	*
210	* @param pInterface Pointer to this interface.
211	* @param guestInfo Pointer to guest information structure.
212	* @thread The emulation thread.
213	*/
214	static DECLCALLBACK(void) vmmdevUpdateGuestInfo(PPDMIVMMDEVCONNECTOR pInterface, const VBoxGuestInfo *guestInfo)
215	{
216	AssertPtrReturnVoid(guestInfo);
217
218	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
219	Console *pConsole = pDrv->pVMMDev->getParent();
220
221	/* Store that information in IGuest */
222	Guest* guest = pConsole->i_getGuest();
223	AssertPtrReturnVoid(guest);
224
225	if (guestInfo->interfaceVersion != 0)
226	{
227	char version[16];
228	RTStrPrintf(version, sizeof(version), "%d", guestInfo->interfaceVersion);
229	guest->i_setAdditionsInfo(Bstr(version), guestInfo->osType);
230
231	/*
232	* Tell the console interface about the event
233	* so that it can notify its consumers.
234	*/
235	pConsole->i_onAdditionsStateChange();
236
237	if (guestInfo->interfaceVersion < VMMDEV_VERSION)
238	pConsole->i_onAdditionsOutdated();
239	}
240	else
241	{
242	/*
243	* The Guest Additions was disabled because of a reset
244	* or driver unload.
245	*/
246	guest->i_setAdditionsInfo(Bstr(), guestInfo->osType); /* Clear interface version + OS type. */
247	/** @todo Would be better if GuestImpl.cpp did all this in the above method call
248	* while holding down the. */
249	guest->i_setAdditionsInfo2(0, "", 0, 0); /* Clear Guest Additions version. */
250	RTTIMESPEC TimeSpecTS;
251	RTTimeNow(&TimeSpecTS);
252	guest->i_setAdditionsStatus(VBoxGuestFacilityType_All, VBoxGuestFacilityStatus_Inactive, 0 /fFlags/, &TimeSpecTS);
253	pConsole->i_onAdditionsStateChange();
254	}
255	}
256
257	/**
258	* @interface_method_impl{PDMIVMMDEVCONNECTOR,pfnUpdateGuestInfo2}
259	*/
260	static DECLCALLBACK(void) vmmdevUpdateGuestInfo2(PPDMIVMMDEVCONNECTOR pInterface, uint32_t uFullVersion,
261	const char *pszName, uint32_t uRevision, uint32_t fFeatures)
262	{
263	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
264	AssertPtr(pszName);
265	Assert(uFullVersion);
266
267	/* Store that information in IGuest. */
268	Guest *pGuest = pDrv->pVMMDev->getParent()->i_getGuest();
269	AssertPtrReturnVoid(pGuest);
270
271	/* Just pass it on... */
272	pGuest->i_setAdditionsInfo2(uFullVersion, pszName, uRevision, fFeatures);
273
274	/*
275	* No need to tell the console interface about the update;
276	* vmmdevUpdateGuestInfo takes care of that when called as the
277	* last event in the chain.
278	*/
279	}
280
281	/**
282	* Update the Guest Additions capabilities.
283	* This is called when the Guest Additions capabilities change. The new capabilities
284	* are given and the connector should update its internal state.
285	*
286	* @param pInterface Pointer to this interface.
287	* @param newCapabilities New capabilities.
288	* @thread The emulation thread.
289	*/
290	static DECLCALLBACK(void) vmmdevUpdateGuestCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
291	{
292	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
293	AssertPtr(pDrv);
294	Console *pConsole = pDrv->pVMMDev->getParent();
295
296	/* store that information in IGuest */
297	Guest* pGuest = pConsole->i_getGuest();
298	AssertPtrReturnVoid(pGuest);
299
300	/*
301	* Report our current capabilities (and assume none is active yet).
302	*/
303	pGuest->i_setSupportedFeatures(newCapabilities);
304
305	/*
306	* Tell the Display, so that it can update the "supports graphics"
307	* capability if the graphics card has not asserted it.
308	*/
309	Display* pDisplay = pConsole->i_getDisplay();
310	AssertPtrReturnVoid(pDisplay);
311	pDisplay->i_handleUpdateVMMDevSupportsGraphics(RT_BOOL(newCapabilities & VMMDEV_GUEST_SUPPORTS_GRAPHICS));
312
313	/*
314	* Tell the console interface about the event
315	* so that it can notify its consumers.
316	*/
317	pConsole->i_onAdditionsStateChange();
318	}
319
320	/**
321	* Update the mouse capabilities.
322	* This is called when the mouse capabilities change. The new capabilities
323	* are given and the connector should update its internal state.
324	*
325	* @param pInterface Pointer to this interface.
326	* @param fNewCaps New capabilities.
327	* @thread The emulation thread.
328	*/
329	static DECLCALLBACK(void) vmmdevUpdateMouseCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t fNewCaps)
330	{
331	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
332	Console *pConsole = pDrv->pVMMDev->getParent();
333
334	/*
335	* Tell the console interface about the event
336	* so that it can notify its consumers.
337	*/
338	Mouse *pMouse = pConsole->i_getMouse();
339	if (pMouse) /** @todo and if not? Can that actually happen? */
340	pMouse->i_onVMMDevGuestCapsChange(fNewCaps & VMMDEV_MOUSE_GUEST_MASK);
341	}
342
343	/**
344	* Update the pointer shape or visibility.
345	*
346	* This is called when the mouse pointer shape changes or pointer is hidden/displaying.
347	* The new shape is passed as a caller allocated buffer that will be freed after returning.
348	*
349	* @param pInterface Pointer to this interface.
350	* @param fVisible Whether the pointer is visible or not.
351	* @param fAlpha Alpha channel information is present.
352	* @param xHot Horizontal coordinate of the pointer hot spot.
353	* @param yHot Vertical coordinate of the pointer hot spot.
354	* @param width Pointer width in pixels.
355	* @param height Pointer height in pixels.
356	* @param pShape The shape buffer. If NULL, then only pointer visibility is being changed.
357	* @thread The emulation thread.
358	*/
359	static DECLCALLBACK(void) vmmdevUpdatePointerShape(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
360	uint32_t xHot, uint32_t yHot,
361	uint32_t width, uint32_t height,
362	void *pShape)
363	{
364	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
365	Console *pConsole = pDrv->pVMMDev->getParent();
366
367	/* tell the console about it */
368	uint32_t cbShape = 0;
369	if (pShape)
370	{
371	cbShape = (width + 7) / 8 * height; /* size of the AND mask */
372	cbShape = ((cbShape + 3) & ~3) + width * 4 * height; /* + gap + size of the XOR mask */
373	}
374	pConsole->i_onMousePointerShapeChange(fVisible, fAlpha, xHot, yHot, width, height, (uint8_t *)pShape, cbShape);
375	}
376
377	static DECLCALLBACK(int) iface_VideoAccelEnable(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, VBVAMEMORY *pVbvaMemory)
378	{
379	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
380	Console *pConsole = pDrv->pVMMDev->getParent();
381
382	Display *display = pConsole->i_getDisplay();
383
384	if (display)
385	{
386	Log9(("MAIN::VMMDevInterface::iface_VideoAccelEnable: %d, %p\n", fEnable, pVbvaMemory));
387	return display->VideoAccelEnableVMMDev(fEnable, pVbvaMemory);
388	}
389
390	return VERR_NOT_SUPPORTED;
391	}
392
393	static DECLCALLBACK(void) iface_VideoAccelFlush(PPDMIVMMDEVCONNECTOR pInterface)
394	{
395	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
396	Console *pConsole = pDrv->pVMMDev->getParent();
397
398	Display *display = pConsole->i_getDisplay();
399
400	if (display)
401	{
402	Log9(("MAIN::VMMDevInterface::iface_VideoAccelFlush\n"));
403	display->VideoAccelFlushVMMDev();
404	}
405	}
406
407	static DECLCALLBACK(int) vmmdevVideoModeSupported(PPDMIVMMDEVCONNECTOR pInterface, uint32_t display, uint32_t width, uint32_t height,
408	uint32_t bpp, bool *fSupported)
409	{
410	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
411	Console *pConsole = pDrv->pVMMDev->getParent();
412
413	if (!fSupported)
414	return VERR_INVALID_PARAMETER;
415	#ifdef DEBUG_sunlover
416	Log(("vmmdevVideoModeSupported: [%d]: %dx%dx%d\n", display, width, height, bpp));
417	#endif
418	IFramebuffer *framebuffer = NULL;
419	HRESULT hrc = pConsole->i_getDisplay()->QueryFramebuffer(display, &framebuffer);
420	if (SUCCEEDED(hrc) && framebuffer)
421	{
422	framebuffer->VideoModeSupported(width, height, bpp, (BOOL*)fSupported);
423	framebuffer->Release();
424	}
425	else
426	{
427	#ifdef DEBUG_sunlover
428	Log(("vmmdevVideoModeSupported: hrc %x, framebuffer %p!!!\n", hrc, framebuffer));
429	#endif
430	*fSupported = true;
431	}
432	return VINF_SUCCESS;
433	}
434
435	static DECLCALLBACK(int) vmmdevGetHeightReduction(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *heightReduction)
436	{
437	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
438	Console *pConsole = pDrv->pVMMDev->getParent();
439
440	if (!heightReduction)
441	return VERR_INVALID_PARAMETER;
442	IFramebuffer *framebuffer = NULL;
443	HRESULT hrc = pConsole->i_getDisplay()->QueryFramebuffer(0, &framebuffer);
444	if (SUCCEEDED(hrc) && framebuffer)
445	{
446	framebuffer->COMGETTER(HeightReduction)((ULONG*)heightReduction);
447	framebuffer->Release();
448	}
449	else
450	*heightReduction = 0;
451	return VINF_SUCCESS;
452	}
453
454	static DECLCALLBACK(int) vmmdevSetCredentialsJudgementResult(PPDMIVMMDEVCONNECTOR pInterface, uint32_t u32Flags)
455	{
456	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
457
458	if (pDrv->pVMMDev)
459	return pDrv->pVMMDev->SetCredentialsJudgementResult(u32Flags);
460
461	return VERR_GENERAL_FAILURE;
462	}
463
464	static DECLCALLBACK(int) vmmdevSetVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect)
465	{
466	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
467	Console *pConsole = pDrv->pVMMDev->getParent();
468
469	/* Forward to Display, which calls corresponding framebuffers. */
470	pConsole->i_getDisplay()->i_handleSetVisibleRegion(cRect, pRect);
471
472	return VINF_SUCCESS;
473	}
474
475	/**
476	* @interface_method_impl{PDMIVMMDEVCONNECTOR,pfnUpdateMonitorPositions}
477	*/
478	static DECLCALLBACK(int) vmmdevUpdateMonitorPositions(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cPositions, PCRTPOINT paPositions)
479	{
480	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
481	Console *pConsole = pDrv->pVMMDev->getParent();
482
483	pConsole->i_getDisplay()->i_handleUpdateMonitorPositions(cPositions, paPositions);
484
485	return VINF_SUCCESS;
486	}
487
488	static DECLCALLBACK(int) vmmdevQueryVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRects, PRTRECT paRects)
489	{
490	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
491	Console *pConsole = pDrv->pVMMDev->getParent();
492
493	/* Forward to Display, which calls corresponding framebuffers. */
494	pConsole->i_getDisplay()->i_handleQueryVisibleRegion(pcRects, paRects);
495
496	return VINF_SUCCESS;
497	}
498
499	/**
500	* Request the statistics interval
501	*
502	* @returns VBox status code.
503	* @param pInterface Pointer to this interface.
504	* @param pulInterval Pointer to interval in seconds
505	* @thread The emulation thread.
506	*/
507	static DECLCALLBACK(int) vmmdevQueryStatisticsInterval(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval)
508	{
509	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
510	Console *pConsole = pDrv->pVMMDev->getParent();
511	ULONG val = 0;
512
513	if (!pulInterval)
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(StatisticsUpdateInterval)(&val);
521	*pulInterval = val;
522	return VINF_SUCCESS;
523	}
524
525	/**
526	* Query the current balloon size
527	*
528	* @returns VBox status code.
529	* @param pInterface Pointer to this interface.
530	* @param pcbBalloon Balloon size
531	* @thread The emulation thread.
532	*/
533	static DECLCALLBACK(int) vmmdevQueryBalloonSize(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcbBalloon)
534	{
535	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
536	Console *pConsole = pDrv->pVMMDev->getParent();
537	ULONG val = 0;
538
539	if (!pcbBalloon)
540	return VERR_INVALID_POINTER;
541
542	/* store that information in IGuest */
543	Guest* guest = pConsole->i_getGuest();
544	AssertPtrReturn(guest, VERR_GENERAL_FAILURE);
545
546	guest->COMGETTER(MemoryBalloonSize)(&val);
547	*pcbBalloon = val;
548	return VINF_SUCCESS;
549	}
550
551	/**
552	* Query the current page fusion setting
553	*
554	* @returns VBox status code.
555	* @param pInterface Pointer to this interface.
556	* @param pfPageFusionEnabled Pointer to boolean
557	* @thread The emulation thread.
558	*/
559	static DECLCALLBACK(int) vmmdevIsPageFusionEnabled(PPDMIVMMDEVCONNECTOR pInterface, bool *pfPageFusionEnabled)
560	{
561	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
562	Console *pConsole = pDrv->pVMMDev->getParent();
563
564	if (!pfPageFusionEnabled)
565	return VERR_INVALID_POINTER;
566
567	/* store that information in IGuest */
568	Guest* guest = pConsole->i_getGuest();
569	AssertPtrReturn(guest, VERR_GENERAL_FAILURE);
570
571	*pfPageFusionEnabled = !!guest->i_isPageFusionEnabled();
572	return VINF_SUCCESS;
573	}
574
575	/**
576	* Report new guest statistics
577	*
578	* @returns VBox status code.
579	* @param pInterface Pointer to this interface.
580	* @param pGuestStats Guest statistics
581	* @thread The emulation thread.
582	*/
583	static DECLCALLBACK(int) vmmdevReportStatistics(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestStatistics *pGuestStats)
584	{
585	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, Connector);
586	Console *pConsole = pDrv->pVMMDev->getParent();
587
588	AssertPtrReturn(pGuestStats, VERR_INVALID_POINTER);
589
590	/* store that information in IGuest */
591	Guest* guest = pConsole->i_getGuest();
592	AssertPtrReturn(guest, VERR_GENERAL_FAILURE);
593
594	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_IDLE)
595	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUIDLE, pGuestStats->u32CpuLoad_Idle);
596
597	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_KERNEL)
598	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUKERNEL, pGuestStats->u32CpuLoad_Kernel);
599
600	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD_USER)
601	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_CPUUSER, pGuestStats->u32CpuLoad_User);
602
603
604	/** @todo r=bird: Convert from 4KB to 1KB units?
605	* CollectorGuestHAL::i_getGuestMemLoad says it returns KB units to
606	* preCollect(). I might be wrong ofc, this is convoluted code... */
607	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_TOTAL)
608	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMTOTAL, pGuestStats->u32PhysMemTotal);
609
610	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_AVAIL)
611	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMFREE, pGuestStats->u32PhysMemAvail);
612
613	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_BALLOON)
614	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMBALLOON, pGuestStats->u32PhysMemBalloon);
615
616	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_MEM_SYSTEM_CACHE)
617	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_MEMCACHE, pGuestStats->u32MemSystemCache);
618
619	if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PAGE_FILE_SIZE)
620	guest->i_setStatistic(pGuestStats->u32CpuId, GUESTSTATTYPE_PAGETOTAL, pGuestStats->u32PageFileSize);
621
622	return VINF_SUCCESS;
623	}
624
625	#ifdef VBOX_WITH_HGCM
626
627	/* HGCM connector interface */
628
629	static DECLCALLBACK(int) iface_hgcmConnect(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd,
630	PHGCMSERVICELOCATION pServiceLocation,
631	uint32_t *pu32ClientID)
632	{
633	Log9(("Enter\n"));
634
635	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, HGCMConnector);
636
637	if ( !pServiceLocation
638	\|\| ( pServiceLocation->type != VMMDevHGCMLoc_LocalHost
639	&& pServiceLocation->type != VMMDevHGCMLoc_LocalHost_Existing))
640	{
641	return VERR_INVALID_PARAMETER;
642	}
643
644	/* Check if service name is a string terminated by zero*/
645	size_t cchInfo = 0;
646	if (RTStrNLenEx(pServiceLocation->u.host.achName, sizeof(pServiceLocation->u.host.achName), &cchInfo) != VINF_SUCCESS)
647	{
648	return VERR_INVALID_PARAMETER;
649	}
650
651	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
652	return VERR_INVALID_STATE;
653	return HGCMGuestConnect(pDrv->pHGCMPort, pCmd, pServiceLocation->u.host.achName, pu32ClientID);
654	}
655
656	static DECLCALLBACK(int) iface_hgcmDisconnect(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID)
657	{
658	Log9(("Enter\n"));
659
660	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, HGCMConnector);
661
662	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
663	return VERR_INVALID_STATE;
664
665	return HGCMGuestDisconnect(pDrv->pHGCMPort, pCmd, u32ClientID);
666	}
667
668	static DECLCALLBACK(int) iface_hgcmCall(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID,
669	uint32_t u32Function, uint32_t cParms, PVBOXHGCMSVCPARM paParms, uint64_t tsArrival)
670	{
671	Log9(("Enter\n"));
672
673	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, HGCMConnector);
674
675	if (!pDrv->pVMMDev \|\| !pDrv->pVMMDev->hgcmIsActive())
676	return VERR_INVALID_STATE;
677
678	return HGCMGuestCall(pDrv->pHGCMPort, pCmd, u32ClientID, u32Function, cParms, paParms, tsArrival);
679	}
680
681	static DECLCALLBACK(void) iface_hgcmCancelled(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t idClient)
682	{
683	Log9(("Enter\n"));
684
685	PDRVMAINVMMDEV pDrv = RT_FROM_MEMBER(pInterface, DRVMAINVMMDEV, HGCMConnector);
686	if ( pDrv->pVMMDev
687	&& pDrv->pVMMDev->hgcmIsActive())
688	return HGCMGuestCancelled(pDrv->pHGCMPort, pCmd, idClient);
689	}
690
691	/**
692	* Execute state save operation.
693	*
694	* @returns VBox status code.
695	* @param pDrvIns Driver instance of the driver which registered the data unit.
696	* @param pSSM SSM operation handle.
697	*/
698	/static/ DECLCALLBACK(int) VMMDev::hgcmSave(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
699	{
700	PDRVMAINVMMDEV pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
701	Log9(("Enter\n"));
702
703	AssertReturn(pThis->pVMMDev, VERR_INTERNAL_ERROR_2);
704	Console::SafeVMPtrQuiet ptrVM(pThis->pVMMDev->mParent);
705	AssertReturn(ptrVM.isOk(), VERR_INTERNAL_ERROR_3);
706	return HGCMHostSaveState(pSSM, ptrVM.vtable());
707	}
708
709
710	/**
711	* Execute state load 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	* @param uVersion Data layout version.
717	* @param uPass The data pass.
718	*/
719	/static/ DECLCALLBACK(int) VMMDev::hgcmLoad(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
720	{
721	PDRVMAINVMMDEV pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
722	LogFlowFunc(("Enter\n"));
723
724	if ( uVersion != HGCM_SAVED_STATE_VERSION
725	&& uVersion != HGCM_SAVED_STATE_VERSION_V2)
726	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
727	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
728
729	AssertReturn(pThis->pVMMDev, VERR_INTERNAL_ERROR_2);
730	Console::SafeVMPtrQuiet ptrVM(pThis->pVMMDev->mParent);
731	AssertReturn(ptrVM.isOk(), VERR_INTERNAL_ERROR_3);
732	return HGCMHostLoadState(pSSM, ptrVM.vtable(), uVersion);
733	}
734
735	int VMMDev::hgcmLoadService(const char pszServiceLibrary, const char pszServiceName)
736	{
737	if (!hgcmIsActive())
738	return VERR_INVALID_STATE;
739
740	/** @todo Construct all the services in the VMMDev::drvConstruct()!! */
741	Assert( (mpDrv && mpDrv->pHGCMPort)
742	\|\| !strcmp(pszServiceLibrary, "VBoxHostChannel")
743	\|\| !strcmp(pszServiceLibrary, "VBoxSharedClipboard")
744	\|\| !strcmp(pszServiceLibrary, "VBoxDragAndDropSvc")
745	\|\| !strcmp(pszServiceLibrary, "VBoxGuestPropSvc")
746	\|\| !strcmp(pszServiceLibrary, "VBoxSharedCrOpenGL")
747	);
748	Console::SafeVMPtrQuiet ptrVM(mParent);
749	return HGCMHostLoad(pszServiceLibrary, pszServiceName, ptrVM.rawUVM(), ptrVM.vtable(), mpDrv ? mpDrv->pHGCMPort : NULL);
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	/**
761	* Used by Console::i_powerDown to shut down the services before the VM is destroyed.
762	*/
763	void VMMDev::hgcmShutdown(bool fUvmIsInvalid /= false/)
764	{
765	#ifdef VBOX_WITH_GUEST_PROPS
766	if (mpDrv && mpDrv->hHgcmSvcExtGstProps)
767	{
768	HGCMHostUnregisterServiceExtension(mpDrv->hHgcmSvcExtGstProps);
769	mpDrv->hHgcmSvcExtGstProps = NULL;
770	}
771	#endif
772
773	#ifdef VBOX_WITH_GUEST_CONTROL
774	if (mpDrv && mpDrv->hHgcmSvcExtGstCtrl)
775	{
776	HGCMHostUnregisterServiceExtension(mpDrv->hHgcmSvcExtGstCtrl);
777	mpDrv->hHgcmSvcExtGstCtrl = NULL;
778	}
779	#endif
780
781	if (ASMAtomicCmpXchgBool(&m_fHGCMActive, false, true))
782	HGCMHostShutdown(fUvmIsInvalid);
783	}
784
785	#endif /* HGCM */
786
787
788	/**
789	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
790	*/
791	DECLCALLBACK(void ) VMMDev::drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
792	{
793	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
794	PDRVMAINVMMDEV pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
795
796	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
797	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIVMMDEVCONNECTOR, &pDrv->Connector);
798	#ifdef VBOX_WITH_HGCM
799	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIHGCMCONNECTOR, &pDrv->HGCMConnector);
800	#endif
801	return NULL;
802	}
803
804	/**
805	* @interface_method_impl{PDMDRVREG,pfnSuspend}
806	*/
807	/static/ DECLCALLBACK(void) VMMDev::drvSuspend(PPDMDRVINS pDrvIns)
808	{
809	RT_NOREF(pDrvIns);
810	#ifdef VBOX_WITH_HGCM
811	HGCMBroadcastEvent(HGCMNOTIFYEVENT_SUSPEND);
812	#endif
813	}
814
815	/**
816	* @interface_method_impl{PDMDRVREG,pfnResume}
817	*/
818	/static/ DECLCALLBACK(void) VMMDev::drvResume(PPDMDRVINS pDrvIns)
819	{
820	RT_NOREF(pDrvIns);
821	#ifdef VBOX_WITH_HGCM
822	HGCMBroadcastEvent(HGCMNOTIFYEVENT_RESUME);
823	#endif
824	}
825
826	/**
827	* @interface_method_impl{PDMDRVREG,pfnPowerOff}
828	*/
829	/static/ DECLCALLBACK(void) VMMDev::drvPowerOff(PPDMDRVINS pDrvIns)
830	{
831	RT_NOREF(pDrvIns);
832	#ifdef VBOX_WITH_HGCM
833	HGCMBroadcastEvent(HGCMNOTIFYEVENT_POWER_ON);
834	#endif
835	}
836
837	/**
838	* @interface_method_impl{PDMDRVREG,pfnPowerOn}
839	*/
840	/static/ DECLCALLBACK(void) VMMDev::drvPowerOn(PPDMDRVINS pDrvIns)
841	{
842	RT_NOREF(pDrvIns);
843	#ifdef VBOX_WITH_HGCM
844	HGCMBroadcastEvent(HGCMNOTIFYEVENT_POWER_ON);
845	#endif
846	}
847
848	/**
849	* @interface_method_impl{PDMDRVREG,pfnReset}
850	*/
851	DECLCALLBACK(void) VMMDev::drvReset(PPDMDRVINS pDrvIns)
852	{
853	RT_NOREF(pDrvIns);
854	LogFlow(("VMMDev::drvReset: iInstance=%d\n", pDrvIns->iInstance));
855	#ifdef VBOX_WITH_HGCM
856	HGCMHostReset(false /fForShutdown/);
857	#endif
858	}
859
860	/**
861	* @interface_method_impl{PDMDRVREG,pfnDestruct}
862	*/
863	DECLCALLBACK(void) VMMDev::drvDestruct(PPDMDRVINS pDrvIns)
864	{
865	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
866	PDRVMAINVMMDEV pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
867	LogFlow(("VMMDev::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
868
869	#ifdef VBOX_WITH_GUEST_PROPS
870	if (pThis->hHgcmSvcExtGstProps)
871	{
872	HGCMHostUnregisterServiceExtension(pThis->hHgcmSvcExtGstProps);
873	pThis->hHgcmSvcExtGstProps = NULL;
874	}
875	#endif
876
877	#ifdef VBOX_WITH_GUEST_CONTROL
878	if (pThis->hHgcmSvcExtGstCtrl)
879	{
880	HGCMHostUnregisterServiceExtension(pThis->hHgcmSvcExtGstCtrl);
881	pThis->hHgcmSvcExtGstCtrl = NULL;
882	}
883	#endif
884
885	if (pThis->pVMMDev)
886	{
887	#ifdef VBOX_WITH_HGCM
888	/* When VM construction goes wrong, we prefer shutting down HGCM here
889	while pUVM is still valid, rather than in ~VMMDev. */
890	if (ASMAtomicCmpXchgBool(&pThis->pVMMDev->m_fHGCMActive, false, true))
891	HGCMHostShutdown();
892	#endif
893	pThis->pVMMDev->mpDrv = NULL;
894	}
895	}
896
897	#ifdef VBOX_WITH_GUEST_PROPS
898
899	/**
900	* Set an array of guest properties
901	*/
902	void VMMDev::i_guestPropSetMultiple(void names, void values, void timestamps, void flags)
903	{
904	VBOXHGCMSVCPARM parms[4];
905
906	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
907	parms[0].u.pointer.addr = names;
908	parms[0].u.pointer.size = 0; /* We don't actually care. */
909	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
910	parms[1].u.pointer.addr = values;
911	parms[1].u.pointer.size = 0; /* We don't actually care. */
912	parms[2].type = VBOX_HGCM_SVC_PARM_PTR;
913	parms[2].u.pointer.addr = timestamps;
914	parms[2].u.pointer.size = 0; /* We don't actually care. */
915	parms[3].type = VBOX_HGCM_SVC_PARM_PTR;
916	parms[3].u.pointer.addr = flags;
917	parms[3].u.pointer.size = 0; /* We don't actually care. */
918
919	hgcmHostCall("VBoxGuestPropSvc", GUEST_PROP_FN_HOST_SET_PROPS, 4, &parms[0]);
920	}
921
922	/**
923	* Set a single guest property
924	*/
925	void VMMDev::i_guestPropSet(const char pszName, const char pszValue, const char *pszFlags)
926	{
927	VBOXHGCMSVCPARM parms[4];
928
929	AssertPtrReturnVoid(pszName);
930	AssertPtrReturnVoid(pszValue);
931	AssertPtrReturnVoid(pszFlags);
932	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
933	parms[0].u.pointer.addr = (void *)pszName;
934	parms[0].u.pointer.size = (uint32_t)strlen(pszName) + 1;
935	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
936	parms[1].u.pointer.addr = (void *)pszValue;
937	parms[1].u.pointer.size = (uint32_t)strlen(pszValue) + 1;
938	parms[2].type = VBOX_HGCM_SVC_PARM_PTR;
939	parms[2].u.pointer.addr = (void *)pszFlags;
940	parms[2].u.pointer.size = (uint32_t)strlen(pszFlags) + 1;
941	hgcmHostCall("VBoxGuestPropSvc", GUEST_PROP_FN_HOST_SET_PROP, 3, &parms[0]);
942	}
943
944	/**
945	* Set the global flags value by calling the service
946	* @returns the status returned by the call to the service
947	*
948	* @param pTable the service instance handle
949	* @param eFlags the flags to set
950	*/
951	int VMMDev::i_guestPropSetGlobalPropertyFlags(uint32_t fFlags)
952	{
953	VBOXHGCMSVCPARM parm;
954	HGCMSvcSetU32(&parm, fFlags);
955	int vrc = hgcmHostCall("VBoxGuestPropSvc", GUEST_PROP_FN_HOST_SET_GLOBAL_FLAGS, 1, &parm);
956	if (RT_FAILURE(vrc))
957	{
958	char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
959	if (RT_FAILURE(GuestPropWriteFlags(fFlags, szFlags)))
960	Log(("Failed to set the global flags.\n"));
961	else
962	Log(("Failed to set the global flags \"%s\".\n", szFlags));
963	}
964	return vrc;
965	}
966
967
968	/**
969	* Set up the Guest Property service, populate it with properties read from
970	* the machine XML and set a couple of initial properties.
971	*/
972	int VMMDev::i_guestPropLoadAndConfigure()
973	{
974	Assert(mpDrv);
975	ComObjPtr<Console> ptrConsole = this->mParent;
976	AssertReturn(ptrConsole.isNotNull(), VERR_INVALID_POINTER);
977
978	/*
979	* Load the service
980	*/
981	int vrc = hgcmLoadService("VBoxGuestPropSvc", "VBoxGuestPropSvc");
982	if (RT_FAILURE(vrc))
983	{
984	LogRel(("VBoxGuestPropSvc is not available. vrc = %Rrc\n", vrc));
985	return VINF_SUCCESS; /* That is not a fatal failure. */
986	}
987
988	/*
989	* Pull over the properties from the server.
990	*/
991	SafeArray<BSTR> namesOut;
992	SafeArray<BSTR> valuesOut;
993	SafeArray<LONG64> timestampsOut;
994	SafeArray<BSTR> flagsOut;
995	HRESULT hrc = ptrConsole->i_pullGuestProperties(ComSafeArrayAsOutParam(namesOut),
996	ComSafeArrayAsOutParam(valuesOut),
997	ComSafeArrayAsOutParam(timestampsOut),
998	ComSafeArrayAsOutParam(flagsOut));
999	AssertLogRelMsgReturn(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR);
1000	size_t const cProps = namesOut.size();
1001	size_t const cAlloc = cProps + 1;
1002	AssertLogRelReturn(valuesOut.size() == cProps, VERR_INTERNAL_ERROR_2);
1003	AssertLogRelReturn(timestampsOut.size() == cProps, VERR_INTERNAL_ERROR_3);
1004	AssertLogRelReturn(flagsOut.size() == cProps, VERR_INTERNAL_ERROR_4);
1005
1006	char szEmpty[] = "";
1007	char papszNames = (char )RTMemTmpAllocZ(sizeof(char ) cAlloc);
1008	char papszValues = (char )RTMemTmpAllocZ(sizeof(char ) cAlloc);
1009	LONG64 pai64Timestamps = (LONG64 )RTMemTmpAllocZ(sizeof(LONG64) * cAlloc);
1010	char papszFlags = (char )RTMemTmpAllocZ(sizeof(char ) cAlloc);
1011	if (papszNames && papszValues && pai64Timestamps && papszFlags)
1012	{
1013	for (unsigned i = 0; RT_SUCCESS(vrc) && i < cProps; ++i)
1014	{
1015	AssertPtrBreakStmt(namesOut[i], vrc = VERR_INVALID_PARAMETER);
1016	vrc = RTUtf16ToUtf8(namesOut[i], &papszNames[i]);
1017	if (RT_FAILURE(vrc))
1018	break;
1019	if (valuesOut[i])
1020	vrc = RTUtf16ToUtf8(valuesOut[i], &papszValues[i]);
1021	else
1022	papszValues[i] = szEmpty;
1023	if (RT_FAILURE(vrc))
1024	break;
1025	pai64Timestamps[i] = timestampsOut[i];
1026	if (flagsOut[i])
1027	vrc = RTUtf16ToUtf8(flagsOut[i], &papszFlags[i]);
1028	else
1029	papszFlags[i] = szEmpty;
1030	}
1031	if (RT_SUCCESS(vrc))
1032	i_guestPropSetMultiple((void )papszNames, (void )papszValues, (void )pai64Timestamps, (void )papszFlags);
1033	for (unsigned i = 0; i < cProps; ++i)
1034	{
1035	RTStrFree(papszNames[i]);
1036	if (valuesOut[i])
1037	RTStrFree(papszValues[i]);
1038	if (flagsOut[i])
1039	RTStrFree(papszFlags[i]);
1040	}
1041	}
1042	else
1043	vrc = VERR_NO_MEMORY;
1044	RTMemTmpFree(papszNames);
1045	RTMemTmpFree(papszValues);
1046	RTMemTmpFree(pai64Timestamps);
1047	RTMemTmpFree(papszFlags);
1048	AssertRCReturn(vrc, vrc);
1049
1050	/*
1051	* Register the host notification callback
1052	*/
1053	HGCMHostRegisterServiceExtension(&mpDrv->hHgcmSvcExtGstProps, "VBoxGuestPropSvc", Console::i_doGuestPropNotification, ptrConsole.m_p);
1054
1055	# ifdef VBOX_WITH_GUEST_PROPS_RDONLY_GUEST
1056	vrc = i_guestPropSetGlobalPropertyFlags(GUEST_PROP_F_RDONLYGUEST);
1057	AssertRCReturn(vrc, vrc);
1058	# endif
1059
1060	Log(("Set VBoxGuestPropSvc property store\n"));
1061	return VINF_SUCCESS;
1062	}
1063
1064	#endif /* VBOX_WITH_GUEST_PROPS */
1065
1066	/**
1067	* @interface_method_impl{PDMDRVREG,pfnConstruct}
1068	*/
1069	DECLCALLBACK(int) VMMDev::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1070	{
1071	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1072	RT_NOREF(fFlags, pCfg);
1073	PDRVMAINVMMDEV pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINVMMDEV);
1074	LogFlow(("Keyboard::drvConstruct: iInstance=%d\n", pDrvIns->iInstance));
1075
1076	/*
1077	* Validate configuration.
1078	*/
1079	PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "", "");
1080	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
1081	("Configuration error: Not possible to attach anything to this driver!\n"),
1082	VERR_PDM_DRVINS_NO_ATTACH);
1083
1084	/*
1085	* IBase.
1086	*/
1087	pDrvIns->IBase.pfnQueryInterface = VMMDev::drvQueryInterface;
1088
1089	pThis->Connector.pfnUpdateGuestStatus = vmmdevUpdateGuestStatus;
1090	pThis->Connector.pfnUpdateGuestUserState = vmmdevUpdateGuestUserState;
1091	pThis->Connector.pfnUpdateGuestInfo = vmmdevUpdateGuestInfo;
1092	pThis->Connector.pfnUpdateGuestInfo2 = vmmdevUpdateGuestInfo2;
1093	pThis->Connector.pfnUpdateGuestCapabilities = vmmdevUpdateGuestCapabilities;
1094	pThis->Connector.pfnUpdateMouseCapabilities = vmmdevUpdateMouseCapabilities;
1095	pThis->Connector.pfnUpdatePointerShape = vmmdevUpdatePointerShape;
1096	pThis->Connector.pfnVideoAccelEnable = iface_VideoAccelEnable;
1097	pThis->Connector.pfnVideoAccelFlush = iface_VideoAccelFlush;
1098	pThis->Connector.pfnVideoModeSupported = vmmdevVideoModeSupported;
1099	pThis->Connector.pfnGetHeightReduction = vmmdevGetHeightReduction;
1100	pThis->Connector.pfnSetCredentialsJudgementResult = vmmdevSetCredentialsJudgementResult;
1101	pThis->Connector.pfnSetVisibleRegion = vmmdevSetVisibleRegion;
1102	pThis->Connector.pfnUpdateMonitorPositions = vmmdevUpdateMonitorPositions;
1103	pThis->Connector.pfnQueryVisibleRegion = vmmdevQueryVisibleRegion;
1104	pThis->Connector.pfnReportStatistics = vmmdevReportStatistics;
1105	pThis->Connector.pfnQueryStatisticsInterval = vmmdevQueryStatisticsInterval;
1106	pThis->Connector.pfnQueryBalloonSize = vmmdevQueryBalloonSize;
1107	pThis->Connector.pfnIsPageFusionEnabled = vmmdevIsPageFusionEnabled;
1108
1109	#ifdef VBOX_WITH_HGCM
1110	pThis->HGCMConnector.pfnConnect = iface_hgcmConnect;
1111	pThis->HGCMConnector.pfnDisconnect = iface_hgcmDisconnect;
1112	pThis->HGCMConnector.pfnCall = iface_hgcmCall;
1113	pThis->HGCMConnector.pfnCancelled = iface_hgcmCancelled;
1114	#endif
1115
1116	/*
1117	* Get the IVMMDevPort interface of the above driver/device.
1118	*/
1119	pThis->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIVMMDEVPORT);
1120	AssertMsgReturn(pThis->pUpPort, ("Configuration error: No VMMDev port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
1121
1122	#ifdef VBOX_WITH_HGCM
1123	pThis->pHGCMPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIHGCMPORT);
1124	AssertMsgReturn(pThis->pHGCMPort, ("Configuration error: No HGCM port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
1125	#endif
1126
1127	/*
1128	* Get the Console object pointer and update the mpDrv member.
1129	*/
1130	com::Guid uuid(VMMDEV_OID);
1131	pThis->pVMMDev = (VMMDev *)PDMDrvHlpQueryGenericUserObject(pDrvIns, uuid.raw());
1132	if (!pThis->pVMMDev)
1133	{
1134	AssertMsgFailed(("Configuration error: No/bad VMMDev object!\n"));
1135	return VERR_NOT_FOUND;
1136	}
1137	pThis->pVMMDev->mpDrv = pThis;
1138
1139	int vrc = VINF_SUCCESS;
1140	#ifdef VBOX_WITH_HGCM
1141	/*
1142	* Load & configure the shared folders service.
1143	*/
1144	vrc = pThis->pVMMDev->hgcmLoadService(VBOXSHAREDFOLDERS_DLL, "VBoxSharedFolders");
1145	pThis->pVMMDev->fSharedFolderActive = RT_SUCCESS(vrc);
1146	if (RT_SUCCESS(vrc))
1147	{
1148	PPDMLED pLed;
1149	PPDMILEDPORTS pLedPort;
1150
1151	LogRel(("Shared Folders service loaded\n"));
1152	pLedPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMILEDPORTS);
1153	AssertMsgReturn(pLedPort, ("Configuration error: No LED port interface above!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
1154	vrc = pLedPort->pfnQueryStatusLed(pLedPort, 0, &pLed);
1155	if (RT_SUCCESS(vrc) && pLed)
1156	{
1157	VBOXHGCMSVCPARM parm;
1158
1159	parm.type = VBOX_HGCM_SVC_PARM_PTR;
1160	parm.u.pointer.addr = pLed;
1161	parm.u.pointer.size = sizeof(*pLed);
1162
1163	vrc = HGCMHostCall("VBoxSharedFolders", SHFL_FN_SET_STATUS_LED, 1, &parm);
1164	}
1165	else
1166	AssertMsgFailed(("pfnQueryStatusLed failed with %Rrc (pLed=%x)\n", vrc, pLed));
1167	}
1168	else
1169	LogRel(("Failed to load Shared Folders service %Rrc\n", vrc));
1170
1171
1172	/*
1173	* Load and configure the guest control service.
1174	*/
1175	# ifdef VBOX_WITH_GUEST_CONTROL
1176	vrc = pThis->pVMMDev->hgcmLoadService("VBoxGuestControlSvc", "VBoxGuestControlSvc");
1177	if (RT_SUCCESS(vrc))
1178	{
1179	vrc = HGCMHostRegisterServiceExtension(&pThis->hHgcmSvcExtGstCtrl, "VBoxGuestControlSvc",
1180	&Guest::i_notifyCtrlDispatcher,
1181	pThis->pVMMDev->mParent->i_getGuest());
1182	if (RT_SUCCESS(vrc))
1183	LogRel(("Guest Control service loaded\n"));
1184	else
1185	LogRel(("Warning: Cannot register VBoxGuestControlSvc extension! vrc=%Rrc\n", vrc));
1186	}
1187	else
1188	LogRel(("Warning!: Failed to load the Guest Control Service! %Rrc\n", vrc));
1189	# endif /* VBOX_WITH_GUEST_CONTROL */
1190
1191
1192	/*
1193	* Load and configure the guest properties service.
1194	*/
1195	# ifdef VBOX_WITH_GUEST_PROPS
1196	vrc = pThis->pVMMDev->i_guestPropLoadAndConfigure();
1197	AssertLogRelRCReturn(vrc, vrc);
1198	# endif
1199
1200
1201	/*
1202	* The HGCM saved state.
1203	*/
1204	vrc = PDMDrvHlpSSMRegisterEx(pDrvIns, HGCM_SAVED_STATE_VERSION, 4096 /* bad guess */,
1205	NULL, NULL, NULL,
1206	NULL, VMMDev::hgcmSave, NULL,
1207	NULL, VMMDev::hgcmLoad, NULL);
1208	if (RT_FAILURE(vrc))
1209	return vrc;
1210
1211	#endif /* VBOX_WITH_HGCM */
1212
1213	return VINF_SUCCESS;
1214	}
1215
1216
1217	/**
1218	* VMMDevice driver registration record.
1219	*/
1220	const PDMDRVREG VMMDev::DrvReg =
1221	{
1222	/* u32Version */
1223	PDM_DRVREG_VERSION,
1224	/* szName */
1225	"HGCM",
1226	/* szRCMod */
1227	"",
1228	/* szR0Mod */
1229	"",
1230	/* pszDescription */
1231	"Main VMMDev driver (Main as in the API).",
1232	/* fFlags */
1233	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1234	/* fClass. */
1235	PDM_DRVREG_CLASS_VMMDEV,
1236	/* cMaxInstances */
1237	~0U,
1238	/* cbInstance */
1239	sizeof(DRVMAINVMMDEV),
1240	/* pfnConstruct */
1241	VMMDev::drvConstruct,
1242	/* pfnDestruct */
1243	VMMDev::drvDestruct,
1244	/* pfnRelocate */
1245	NULL,
1246	/* pfnIOCtl */
1247	NULL,
1248	/* pfnPowerOn */
1249	VMMDev::drvPowerOn,
1250	/* pfnReset */
1251	VMMDev::drvReset,
1252	/* pfnSuspend */
1253	VMMDev::drvSuspend,
1254	/* pfnResume */
1255	VMMDev::drvResume,
1256	/* pfnAttach */
1257	NULL,
1258	/* pfnDetach */
1259	NULL,
1260	/* pfnPowerOff */
1261	VMMDev::drvPowerOff,
1262	/* pfnSoftReset */
1263	NULL,
1264	/* u32EndVersion */
1265	PDM_DRVREG_VERSION
1266	};
1267	/* 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@ 107513

Download in other formats: