GIM.cpp@ 72358

Last change on this file since 72358 was 69111, checked in by vboxsync, 7 years ago
(C) year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 22.8 KB

Line
1	/* $Id: GIM.cpp 69111 2017-10-17 14:26:02Z vboxsync $ */
2	/** @file
3	* GIM - Guest Interface Manager.
4	*/
5
6	/*
7	* Copyright (C) 2014-2017 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	/** @page pg_gim GIM - The Guest Interface Manager
19	*
20	* The Guest Interface Manager abstracts an interface provider through which
21	* guests may interact with the hypervisor.
22	*
23	* @see grp_gim
24	*
25	*
26	* @section sec_gim_provider Providers
27	*
28	* A GIM provider implements a particular hypervisor interface such as Microsoft
29	* Hyper-V, Linux KVM and so on. It hooks into various components in the VMM to
30	* ease the guest in running under a recognized, virtualized environment.
31	*
32	* The GIM provider configured for the VM needs to be recognized by the guest OS
33	* in order to make use of features supported by the interface. Since it
34	* requires co-operation from the guest OS, a GIM provider may also referred to
35	* as a paravirtualization interface.
36	*
37	* One of the goals of having a paravirtualized interface is for enabling guests
38	* to be more accurate and efficient when operating in a virtualized
39	* environment. For instance, a guest OS which interfaces to VirtualBox through
40	* a GIM provider may rely on the provider for supplying the correct TSC
41	* frequency of the host processor. The guest can then avoid caliberating the
42	* TSC itself, resulting in higher accuracy and better performance.
43	*
44	* At most, only one GIM provider can be active for a running VM and cannot be
45	* changed during the lifetime of the VM.
46	*/
47
48
49	/*********************************************************************************************************************************
50	* Header Files *
51	*********************************************************************************************************************************/
52	#define LOG_GROUP LOG_GROUP_GIM
53	#include <VBox/vmm/gim.h>
54	#include <VBox/vmm/hm.h>
55	#include <VBox/vmm/ssm.h>
56	#include <VBox/vmm/pdmdev.h>
57	#include "GIMInternal.h"
58	#include <VBox/vmm/vm.h>
59
60	#include <VBox/log.h>
61
62	#include <iprt/err.h>
63	#include <iprt/semaphore.h>
64	#include <iprt/string.h>
65
66	/* Include all GIM providers. */
67	#include "GIMMinimalInternal.h"
68	#include "GIMHvInternal.h"
69	#include "GIMKvmInternal.h"
70
71
72	/*********************************************************************************************************************************
73	* Internal Functions *
74	*********************************************************************************************************************************/
75	static FNSSMINTSAVEEXEC gimR3Save;
76	static FNSSMINTLOADEXEC gimR3Load;
77
78
79	/**
80	* Initializes the GIM.
81	*
82	* @returns VBox status code.
83	* @param pVM The cross context VM structure.
84	*/
85	VMMR3_INT_DECL(int) GIMR3Init(PVM pVM)
86	{
87	LogFlow(("GIMR3Init\n"));
88
89	/*
90	* Assert alignment and sizes.
91	*/
92	AssertCompile(sizeof(pVM->gim.s) <= sizeof(pVM->gim.padding));
93	AssertCompile(sizeof(pVM->aCpus[0].gim.s) <= sizeof(pVM->aCpus[0].gim.padding));
94
95	/*
96	* Initialize members.
97	*/
98	pVM->gim.s.hSemiReadOnlyMmio2Handler = NIL_PGMPHYSHANDLERTYPE;
99
100	/*
101	* Register the saved state data unit.
102	*/
103	int rc = SSMR3RegisterInternal(pVM, "GIM", 0 /* uInstance */, GIM_SAVED_STATE_VERSION, sizeof(GIM),
104	NULL /* pfnLivePrep /, NULL / pfnLiveExec /, NULL / pfnLiveVote*/,
105	NULL /* pfnSavePrep /, gimR3Save, NULL / pfnSaveDone */,
106	NULL /* pfnLoadPrep /, gimR3Load, NULL / pfnLoadDone */);
107	if (RT_FAILURE(rc))
108	return rc;
109
110	/*
111	* Read configuration.
112	*/
113	PCFGMNODE pCfgNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "GIM/");
114
115	/*
116	* Validate the GIM settings.
117	*/
118	rc = CFGMR3ValidateConfig(pCfgNode, "/GIM/", /* pszNode */
119	"Provider" /* pszValidValues */
120	"\|Version",
121	"HyperV", /* pszValidNodes */
122	"GIM", /* pszWho */
123	0); /* uInstance */
124	if (RT_FAILURE(rc))
125	return rc;
126
127	/** @cfgm{/GIM/Provider, string}
128	* The name of the GIM provider. The default is "none". */
129	char szProvider[64];
130	rc = CFGMR3QueryStringDef(pCfgNode, "Provider", szProvider, sizeof(szProvider), "None");
131	AssertLogRelRCReturn(rc, rc);
132
133	/** @cfgm{/GIM/Version, uint32_t}
134	* The interface version. The default is 0, which means "provide the most
135	* up-to-date implementation". */
136	uint32_t uVersion;
137	rc = CFGMR3QueryU32Def(pCfgNode, "Version", &uVersion, 0 /* default */);
138	AssertLogRelRCReturn(rc, rc);
139
140	/*
141	* Setup the GIM provider for this VM.
142	*/
143	LogRel(("GIM: Using provider '%s' (Implementation version: %u)\n", szProvider, uVersion));
144	if (!RTStrCmp(szProvider, "None"))
145	pVM->gim.s.enmProviderId = GIMPROVIDERID_NONE;
146	else
147	{
148	pVM->gim.s.u32Version = uVersion;
149	/** @todo r=bird: Because u32Version is saved, it should be translated to the
150	* 'most up-to-date implementation' version number when 0. Otherwise,
151	* we'll have abiguities when loading the state of older VMs. */
152	if (!RTStrCmp(szProvider, "Minimal"))
153	{
154	pVM->gim.s.enmProviderId = GIMPROVIDERID_MINIMAL;
155	rc = gimR3MinimalInit(pVM);
156	}
157	else if (!RTStrCmp(szProvider, "HyperV"))
158	{
159	pVM->gim.s.enmProviderId = GIMPROVIDERID_HYPERV;
160	rc = gimR3HvInit(pVM, pCfgNode);
161	}
162	else if (!RTStrCmp(szProvider, "KVM"))
163	{
164	pVM->gim.s.enmProviderId = GIMPROVIDERID_KVM;
165	rc = gimR3KvmInit(pVM);
166	}
167	else
168	rc = VMR3SetError(pVM->pUVM, VERR_GIM_INVALID_PROVIDER, RT_SRC_POS, "Provider '%s' unknown.", szProvider);
169	}
170
171	/*
172	* Statistics.
173	*/
174	STAM_REL_REG_USED(pVM, &pVM->gim.s.StatDbgXmit, STAMTYPE_COUNTER, "/GIM/Debug/Transmit", STAMUNIT_OCCURENCES, "Debug packets sent.");
175	STAM_REL_REG_USED(pVM, &pVM->gim.s.StatDbgXmitBytes, STAMTYPE_COUNTER, "/GIM/Debug/TransmitBytes", STAMUNIT_OCCURENCES, "Debug bytes sent.");
176	STAM_REL_REG_USED(pVM, &pVM->gim.s.StatDbgRecv, STAMTYPE_COUNTER, "/GIM/Debug/Receive", STAMUNIT_OCCURENCES, "Debug packets received.");
177	STAM_REL_REG_USED(pVM, &pVM->gim.s.StatDbgRecvBytes, STAMTYPE_COUNTER, "/GIM/Debug/ReceiveBytes", STAMUNIT_OCCURENCES, "Debug bytes received.");
178
179	STAM_REL_REG_USED(pVM, &pVM->gim.s.StatHypercalls, STAMTYPE_COUNTER, "/GIM/Hypercalls", STAMUNIT_OCCURENCES, "Number of hypercalls initiated.");
180	return rc;
181	}
182
183
184	/**
185	* Initializes the remaining bits of the GIM provider.
186	*
187	* This is called after initializing HM and most other VMM components.
188	*
189	* @returns VBox status code.
190	* @param pVM The cross context VM structure.
191	* @thread EMT(0)
192	*/
193	VMMR3_INT_DECL(int) GIMR3InitCompleted(PVM pVM)
194	{
195	switch (pVM->gim.s.enmProviderId)
196	{
197	case GIMPROVIDERID_MINIMAL:
198	return gimR3MinimalInitCompleted(pVM);
199
200	case GIMPROVIDERID_HYPERV:
201	return gimR3HvInitCompleted(pVM);
202
203	case GIMPROVIDERID_KVM:
204	return gimR3KvmInitCompleted(pVM);
205
206	default:
207	break;
208	}
209
210	if (!TMR3CpuTickIsFixedRateMonotonic(pVM, true /* fWithParavirtEnabled */))
211	LogRel(("GIM: Warning!!! Host TSC is unstable. The guest may behave unpredictably with a paravirtualized clock.\n"));
212
213	return VINF_SUCCESS;
214	}
215
216
217	/**
218	* @callback_method_impl{FNSSMINTSAVEEXEC}
219	*/
220	static DECLCALLBACK(int) gimR3Save(PVM pVM, PSSMHANDLE pSSM)
221	{
222	AssertReturn(pVM, VERR_INVALID_PARAMETER);
223	AssertReturn(pSSM, VERR_SSM_INVALID_STATE);
224
225	int rc = VINF_SUCCESS;
226	#if 0
227	/* Save per-CPU data. */
228	SSMR3PutU32(pSSM, pVM->cCpus);
229	for (VMCPUID i = 0; i < pVM->cCpus; i++)
230	{
231	rc = SSMR3PutXYZ(pSSM, pVM->aCpus[i].gim.s.XYZ);
232	}
233	#endif
234
235	/*
236	* Save per-VM data.
237	*/
238	SSMR3PutU32(pSSM, pVM->gim.s.enmProviderId);
239	SSMR3PutU32(pSSM, pVM->gim.s.u32Version);
240
241	/*
242	* Save provider-specific data.
243	*/
244	switch (pVM->gim.s.enmProviderId)
245	{
246	case GIMPROVIDERID_HYPERV:
247	rc = gimR3HvSave(pVM, pSSM);
248	AssertRCReturn(rc, rc);
249	break;
250
251	case GIMPROVIDERID_KVM:
252	rc = gimR3KvmSave(pVM, pSSM);
253	AssertRCReturn(rc, rc);
254	break;
255
256	default:
257	break;
258	}
259
260	return rc;
261	}
262
263
264	/**
265	* @callback_method_impl{FNSSMINTLOADEXEC}
266	*/
267	static DECLCALLBACK(int) gimR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
268	{
269	if (uPass != SSM_PASS_FINAL)
270	return VINF_SUCCESS;
271	if (uVersion != GIM_SAVED_STATE_VERSION)
272	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
273
274	int rc;
275	#if 0
276	/* Load per-CPU data. */
277	for (VMCPUID i = 0; i < pVM->cCpus; i++)
278	{
279	rc = SSMR3PutXYZ(pSSM, pVM->aCpus[i].gim.s.XYZ);
280	}
281	#endif
282
283	/*
284	* Load per-VM data.
285	*/
286	uint32_t uProviderId;
287	uint32_t uProviderVersion;
288
289	rc = SSMR3GetU32(pSSM, &uProviderId); AssertRCReturn(rc, rc);
290	rc = SSMR3GetU32(pSSM, &uProviderVersion); AssertRCReturn(rc, rc);
291
292	if ((GIMPROVIDERID)uProviderId != pVM->gim.s.enmProviderId)
293	return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Saved GIM provider %u differs from the configured one (%u)."),
294	uProviderId, pVM->gim.s.enmProviderId);
295	#if 0 /** @todo r=bird: Figure out what you mean to do here with the version. */
296	if (uProviderVersion != pVM->gim.s.u32Version)
297	return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Saved GIM provider version %u differs from the configured one (%u)."),
298	uProviderVersion, pVM->gim.s.u32Version);
299	#else
300	pVM->gim.s.u32Version = uProviderVersion;
301	#endif
302
303	/*
304	* Load provider-specific data.
305	*/
306	switch (pVM->gim.s.enmProviderId)
307	{
308	case GIMPROVIDERID_HYPERV:
309	rc = gimR3HvLoad(pVM, pSSM);
310	AssertRCReturn(rc, rc);
311	break;
312
313	case GIMPROVIDERID_KVM:
314	rc = gimR3KvmLoad(pVM, pSSM);
315	AssertRCReturn(rc, rc);
316	break;
317
318	default:
319	break;
320	}
321
322	return VINF_SUCCESS;
323	}
324
325
326	/**
327	* Terminates the GIM.
328	*
329	* Termination means cleaning up and freeing all resources,
330	* the VM itself is, at this point, powered off or suspended.
331	*
332	* @returns VBox status code.
333	* @param pVM The cross context VM structure.
334	*/
335	VMMR3_INT_DECL(int) GIMR3Term(PVM pVM)
336	{
337	switch (pVM->gim.s.enmProviderId)
338	{
339	case GIMPROVIDERID_HYPERV:
340	return gimR3HvTerm(pVM);
341
342	case GIMPROVIDERID_KVM:
343	return gimR3KvmTerm(pVM);
344
345	default:
346	break;
347	}
348	return VINF_SUCCESS;
349	}
350
351
352	/**
353	* Applies relocations to data and code managed by this
354	* component. This function will be called at init and
355	* whenever the VMM need to relocate it self inside the GC.
356	*
357	* @param pVM The cross context VM structure.
358	* @param offDelta Relocation delta relative to old location.
359	*/
360	VMMR3_INT_DECL(void) GIMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
361	{
362	switch (pVM->gim.s.enmProviderId)
363	{
364	case GIMPROVIDERID_HYPERV:
365	gimR3HvRelocate(pVM, offDelta);
366	break;
367
368	default:
369	break;
370	}
371	}
372
373
374	/**
375	* The VM is being reset.
376	*
377	* For the GIM component this means unmapping and unregistering MMIO2 regions
378	* and other provider-specific resets.
379	*
380	* @returns VBox status code.
381	* @param pVM The cross context VM structure.
382	*/
383	VMMR3_INT_DECL(void) GIMR3Reset(PVM pVM)
384	{
385	switch (pVM->gim.s.enmProviderId)
386	{
387	case GIMPROVIDERID_HYPERV:
388	return gimR3HvReset(pVM);
389
390	case GIMPROVIDERID_KVM:
391	return gimR3KvmReset(pVM);
392
393	default:
394	break;
395	}
396	}
397
398
399	/**
400	* Registers the GIM device with VMM.
401	*
402	* @param pVM The cross context VM structure.
403	* @param pDevIns Pointer to the GIM device instance.
404	* @param pDbg Pointer to the GIM device debug structure, can be
405	* NULL.
406	*/
407	VMMR3DECL(void) GIMR3GimDeviceRegister(PVM pVM, PPDMDEVINS pDevIns, PGIMDEBUG pDbg)
408	{
409	pVM->gim.s.pDevInsR3 = pDevIns;
410	pVM->gim.s.pDbgR3 = pDbg;
411	}
412
413
414	/**
415	* Gets debug setup specified by the provider.
416	*
417	* @returns VBox status code.
418	* @param pVM The cross context VM structure.
419	* @param pDbgSetup Where to store the debug setup details.
420	*/
421	VMMR3DECL(int) GIMR3GetDebugSetup(PVM pVM, PGIMDEBUGSETUP pDbgSetup)
422	{
423	AssertReturn(pVM, VERR_INVALID_PARAMETER);
424	AssertReturn(pDbgSetup, VERR_INVALID_PARAMETER);
425
426	switch (pVM->gim.s.enmProviderId)
427	{
428	case GIMPROVIDERID_HYPERV:
429	return gimR3HvGetDebugSetup(pVM, pDbgSetup);
430	default:
431	break;
432	}
433	return VERR_GIM_NO_DEBUG_CONNECTION;
434	}
435
436
437	/**
438	* Read data from a host debug session.
439	*
440	* @returns VBox status code.
441	*
442	* @param pVM The cross context VM structure.
443	* @param pvRead The read buffer.
444	* @param pcbRead The size of the read buffer as well as where to store
445	* the number of bytes read.
446	* @param pfnReadComplete Callback when the buffer has been read and
447	* before signaling reading of the next buffer.
448	* Optional, can be NULL.
449	* @thread EMT.
450	*/
451	VMMR3_INT_DECL(int) gimR3DebugRead(PVM pVM, void pvRead, size_t pcbRead, PFNGIMDEBUGBUFREADCOMPLETED pfnReadComplete)
452	{
453	PGIMDEBUG pDbg = pVM->gim.s.pDbgR3;
454	if (pDbg)
455	{
456	if (ASMAtomicReadBool(&pDbg->fDbgRecvBufRead) == true)
457	{
458	STAM_REL_COUNTER_INC(&pVM->gim.s.StatDbgRecv);
459	STAM_REL_COUNTER_ADD(&pVM->gim.s.StatDbgRecvBytes, pDbg->cbDbgRecvBufRead);
460
461	memcpy(pvRead, pDbg->pvDbgRecvBuf, pDbg->cbDbgRecvBufRead);
462	*pcbRead = pDbg->cbDbgRecvBufRead;
463	if (pfnReadComplete)
464	pfnReadComplete(pVM);
465	RTSemEventMultiSignal(pDbg->hDbgRecvThreadSem);
466	ASMAtomicWriteBool(&pDbg->fDbgRecvBufRead, false);
467	return VINF_SUCCESS;
468	}
469	else
470	*pcbRead = 0;
471	return VERR_NO_DATA;
472	}
473	return VERR_GIM_NO_DEBUG_CONNECTION;
474	}
475
476
477	/**
478	* Write data to a host debug session.
479	*
480	* @returns VBox status code.
481	*
482	* @param pVM The cross context VM structure.
483	* @param pvWrite The write buffer.
484	* @param pcbWrite The size of the write buffer as well as where to store
485	* the number of bytes written.
486	* @thread EMT.
487	*/
488	VMMR3_INT_DECL(int) gimR3DebugWrite(PVM pVM, void pvWrite, size_t pcbWrite)
489	{
490	PGIMDEBUG pDbg = pVM->gim.s.pDbgR3;
491	if (pDbg)
492	{
493	PPDMISTREAM pDbgStream = pDbg->pDbgDrvStream;
494	if (pDbgStream)
495	{
496	size_t cbWrite = *pcbWrite;
497	int rc = pDbgStream->pfnWrite(pDbgStream, pvWrite, pcbWrite);
498	if ( RT_SUCCESS(rc)
499	&& *pcbWrite == cbWrite)
500	{
501	STAM_REL_COUNTER_INC(&pVM->gim.s.StatDbgXmit);
502	STAM_REL_COUNTER_ADD(&pVM->gim.s.StatDbgXmitBytes, *pcbWrite);
503	}
504	return rc;
505	}
506	}
507	return VERR_GIM_NO_DEBUG_CONNECTION;
508	}
509
510
511	/**
512	* Returns the array of MMIO2 regions that are expected to be registered and
513	* later mapped into the guest-physical address space for the GIM provider
514	* configured for the VM.
515	*
516	* @returns Pointer to an array of GIM MMIO2 regions, may return NULL.
517	* @param pVM The cross context VM structure.
518	* @param pcRegions Where to store the number of items in the array.
519	*
520	* @remarks The caller does not own and therefore must -NOT- try to free the
521	* returned pointer.
522	*/
523	VMMR3DECL(PGIMMMIO2REGION) GIMR3GetMmio2Regions(PVM pVM, uint32_t *pcRegions)
524	{
525	Assert(pVM);
526	Assert(pcRegions);
527
528	*pcRegions = 0;
529	switch (pVM->gim.s.enmProviderId)
530	{
531	case GIMPROVIDERID_HYPERV:
532	return gimR3HvGetMmio2Regions(pVM, pcRegions);
533
534	default:
535	break;
536	}
537
538	return NULL;
539	}
540
541	#if 0 /* ??? */
542
543	/**
544	* @callback_method_impl{FNPGMPHYSHANDLER,
545	* Write access handler for mapped MMIO2 pages. Currently ignores writes.}
546	*
547	* @todo In the future we might want to let the GIM provider decide what the
548	* handler should do (like throwing \#GP faults).
549	*/
550	static DECLCALLBACK(VBOXSTRICTRC) gimR3Mmio2WriteHandler(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, void pvPhys, void pvBuf,
551	size_t cbBuf, PGMACCESSTYPE enmAccessType, PGMACCESSORIGIN enmOrigin,
552	void *pvUser)
553	{
554	RT_NOREF6(pVM, pVCpu, GCPhys, pvPhys, pvBuf, cbBuf);
555	RT_NOREF3(enmAccessType, enmOrigin, pvUser);
556
557	/*
558	* Ignore writes to the mapped MMIO2 page.
559	*/
560	Assert(enmAccessType == PGMACCESSTYPE_WRITE);
561	return VINF_SUCCESS; /** @todo Hyper-V says we should \#GP(0) fault for writes to the Hypercall and TSC page. */
562	}
563
564
565	/**
566	* Unmaps a registered MMIO2 region in the guest address space and removes any
567	* access handlers for it.
568	*
569	* @returns VBox status code.
570	* @param pVM The cross context VM structure.
571	* @param pRegion Pointer to the GIM MMIO2 region.
572	*/
573	VMMR3_INT_DECL(int) gimR3Mmio2Unmap(PVM pVM, PGIMMMIO2REGION pRegion)
574	{
575	AssertPtr(pVM);
576	AssertPtr(pRegion);
577
578	PPDMDEVINS pDevIns = pVM->gim.s.pDevInsR3;
579	AssertPtr(pDevIns);
580	if (pRegion->fMapped)
581	{
582	int rc = PGMHandlerPhysicalDeregister(pVM, pRegion->GCPhysPage);
583	AssertRC(rc);
584
585	rc = PDMDevHlpMMIO2Unmap(pDevIns, pRegion->iRegion, pRegion->GCPhysPage);
586	if (RT_SUCCESS(rc))
587	{
588	pRegion->fMapped = false;
589	pRegion->GCPhysPage = NIL_RTGCPHYS;
590	}
591	}
592	return VINF_SUCCESS;
593	}
594
595
596	/**
597	* Maps a registered MMIO2 region in the guest address space.
598	*
599	* The region will be made read-only and writes from the guest will be ignored.
600	*
601	* @returns VBox status code.
602	* @param pVM The cross context VM structure.
603	* @param pRegion Pointer to the GIM MMIO2 region.
604	* @param GCPhysRegion Where in the guest address space to map the region.
605	*/
606	VMMR3_INT_DECL(int) GIMR3Mmio2Map(PVM pVM, PGIMMMIO2REGION pRegion, RTGCPHYS GCPhysRegion)
607	{
608	PPDMDEVINS pDevIns = pVM->gim.s.pDevInsR3;
609	AssertPtr(pDevIns);
610
611	/* The guest-physical address must be page-aligned. */
612	if (GCPhysRegion & PAGE_OFFSET_MASK)
613	{
614	LogFunc(("%s: %#RGp not paging aligned\n", pRegion->szDescription, GCPhysRegion));
615	return VERR_PGM_INVALID_GC_PHYSICAL_ADDRESS;
616	}
617
618	/* Allow only normal pages to be overlaid using our MMIO2 pages (disallow MMIO, ROM, reserved pages). */
619	/** @todo Hyper-V doesn't seem to be very strict about this, may be relax
620	* later if some guest really requires it. */
621	if (!PGMPhysIsGCPhysNormal(pVM, GCPhysRegion))
622	{
623	LogFunc(("%s: %#RGp is not normal memory\n", pRegion->szDescription, GCPhysRegion));
624	return VERR_PGM_INVALID_GC_PHYSICAL_ADDRESS;
625	}
626
627	if (!pRegion->fRegistered)
628	{
629	LogFunc(("%s: Region has not been registered.\n", pRegion->szDescription));
630	return VERR_GIM_IPE_1;
631	}
632
633	/*
634	* Map the MMIO2 region over the specified guest-physical address.
635	*/
636	int rc = PDMDevHlpMMIOExMap(pDevIns, NULL, pRegion->iRegion, GCPhysRegion);
637	if (RT_SUCCESS(rc))
638	{
639	/*
640	* Install access-handlers for the mapped page to prevent (ignore) writes to it
641	* from the guest.
642	*/
643	if (pVM->gim.s.hSemiReadOnlyMmio2Handler == NIL_PGMPHYSHANDLERTYPE)
644	rc = PGMR3HandlerPhysicalTypeRegister(pVM, PGMPHYSHANDLERKIND_WRITE,
645	gimR3Mmio2WriteHandler,
646	NULL /* pszModR0 /, NULL / pszHandlerR0 /, NULL / pszPfHandlerR0 */,
647	NULL /* pszModRC /, NULL / pszHandlerRC /, NULL / pszPfHandlerRC */,
648	"GIM read-only MMIO2 handler",
649	&pVM->gim.s.hSemiReadOnlyMmio2Handler);
650	if (RT_SUCCESS(rc))
651	{
652	rc = PGMHandlerPhysicalRegister(pVM, GCPhysRegion, GCPhysRegion + (pRegion->cbRegion - 1),
653	pVM->gim.s.hSemiReadOnlyMmio2Handler,
654	NULL /* pvUserR3 /, NIL_RTR0PTR / pvUserR0 /, NIL_RTRCPTR / pvUserRC */,
655	pRegion->szDescription);
656	if (RT_SUCCESS(rc))
657	{
658	pRegion->fMapped = true;
659	pRegion->GCPhysPage = GCPhysRegion;
660	return rc;
661	}
662	}
663
664	PDMDevHlpMMIO2Unmap(pDevIns, pRegion->iRegion, GCPhysRegion);
665	}
666
667	return rc;
668	}
669
670
671	/**
672	* Registers the physical handler for the registered and mapped MMIO2 region.
673	*
674	* @returns VBox status code.
675	* @param pVM The cross context VM structure.
676	* @param pRegion Pointer to the GIM MMIO2 region.
677	*/
678	VMMR3_INT_DECL(int) gimR3Mmio2HandlerPhysicalRegister(PVM pVM, PGIMMMIO2REGION pRegion)
679	{
680	AssertPtr(pRegion);
681	AssertReturn(pRegion->fRegistered, VERR_GIM_IPE_2);
682	AssertReturn(pRegion->fMapped, VERR_GIM_IPE_3);
683
684	return PGMR3HandlerPhysicalRegister(pVM,
685	PGMPHYSHANDLERKIND_WRITE,
686	pRegion->GCPhysPage, pRegion->GCPhysPage + (pRegion->cbRegion - 1),
687	gimR3Mmio2WriteHandler, NULL /* pvUserR3 */,
688	NULL /* pszModR0 /, NULL / pszHandlerR0 /, NIL_RTR0PTR / pvUserR0 */,
689	NULL /* pszModRC /, NULL / pszHandlerRC /, NIL_RTRCPTR / pvUserRC */,
690	pRegion->szDescription);
691	}
692
693
694	/**
695	* Deregisters the physical handler for the MMIO2 region.
696	*
697	* @returns VBox status code.
698	* @param pVM The cross context VM structure.
699	* @param pRegion Pointer to the GIM MMIO2 region.
700	*/
701	VMMR3_INT_DECL(int) gimR3Mmio2HandlerPhysicalDeregister(PVM pVM, PGIMMMIO2REGION pRegion)
702	{
703	return PGMHandlerPhysicalDeregister(pVM, pRegion->GCPhysPage);
704	}
705
706	#endif
707

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

source: vbox/trunk/src/VBox/VMM/VMMR3/GIM.cpp@ 72358

Download in other formats: