VMMDevInterface.cpp@ 4663

Last change on this file since 4663 was 4606, checked in by vboxsync, 17 years ago
Round up
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 26.6 KB

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

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

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

Download in other formats: