PGMHandler.cpp@ 61008

Last change on this file since 61008 was 58126, checked in by vboxsync, 9 years ago
VMM: Fixed almost all the Doxygen warnings.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 35.4 KB

Line
1	/* $Id: PGMHandler.cpp 58126 2015-10-08 20:59:48Z vboxsync $ */
2	/** @file
3	* PGM - Page Manager / Monitor, Access Handlers.
4	*/
5
6	/*
7	* Copyright (C) 2006-2015 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
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_PGM
23	#include <VBox/vmm/dbgf.h>
24	#include <VBox/vmm/pgm.h>
25	#include <VBox/vmm/cpum.h>
26	#include <VBox/vmm/iom.h>
27	#include <VBox/sup.h>
28	#include <VBox/vmm/mm.h>
29	#include <VBox/vmm/em.h>
30	#include <VBox/vmm/stam.h>
31	#include <VBox/vmm/csam.h>
32	#ifdef VBOX_WITH_REM
33	# include <VBox/vmm/rem.h>
34	#endif
35	#include <VBox/vmm/dbgf.h>
36	#ifdef VBOX_WITH_REM
37	# include <VBox/vmm/rem.h>
38	#endif
39	#include <VBox/vmm/selm.h>
40	#include <VBox/vmm/ssm.h>
41	#include "PGMInternal.h"
42	#include <VBox/vmm/vm.h>
43	#include "PGMInline.h"
44	#include <VBox/dbg.h>
45
46	#include <VBox/log.h>
47	#include <iprt/assert.h>
48	#include <iprt/alloc.h>
49	#include <iprt/asm.h>
50	#include <iprt/thread.h>
51	#include <iprt/string.h>
52	#include <VBox/param.h>
53	#include <VBox/err.h>
54	#include <VBox/vmm/hm.h>
55
56
57	/*********************************************************************************************************************************
58	* Internal Functions *
59	*********************************************************************************************************************************/
60	static DECLCALLBACK(int) pgmR3HandlerPhysicalOneClear(PAVLROGCPHYSNODECORE pNode, void *pvUser);
61	static DECLCALLBACK(int) pgmR3HandlerPhysicalOneSet(PAVLROGCPHYSNODECORE pNode, void *pvUser);
62	static DECLCALLBACK(int) pgmR3InfoHandlersPhysicalOne(PAVLROGCPHYSNODECORE pNode, void *pvUser);
63	#ifdef VBOX_WITH_RAW_MODE
64	static DECLCALLBACK(int) pgmR3InfoHandlersVirtualOne(PAVLROGCPTRNODECORE pNode, void *pvUser);
65	#endif
66
67
68
69
70	/**
71	* Register a physical page access handler type, extended version.
72	*
73	* @returns VBox status code.
74	* @param pVM The cross context VM structure.
75	* @param enmKind The kind of access handler.
76	* @param pfnHandlerR3 Pointer to the ring-3 handler callback.
77	* @param pfnHandlerR0 Pointer to the ring-0 handler callback.
78	* @param pfnPfHandlerR0 Pointer to the ring-0 \#PF handler callback.
79	* @param pfnHandlerRC Pointer to the raw-mode context handler callback.
80	* @param pfnPfHandlerRC Pointer to the raw-mode context \#PF handler
81	* callback.
82	* @param pszDesc The type description.
83	* @param phType Where to return the type handle (cross context
84	* safe).
85	*/
86	VMMR3_INT_DECL(int) PGMR3HandlerPhysicalTypeRegisterEx(PVM pVM, PGMPHYSHANDLERKIND enmKind,
87	PFNPGMPHYSHANDLER pfnHandlerR3,
88	R0PTRTYPE(PFNPGMPHYSHANDLER) pfnHandlerR0,
89	R0PTRTYPE(PFNPGMRZPHYSPFHANDLER) pfnPfHandlerR0,
90	RCPTRTYPE(PFNPGMPHYSHANDLER) pfnHandlerRC,
91	RCPTRTYPE(PFNPGMRZPHYSPFHANDLER) pfnPfHandlerRC,
92	const char *pszDesc, PPGMPHYSHANDLERTYPE phType)
93	{
94	AssertPtrReturn(pfnHandlerR3, VERR_INVALID_POINTER);
95	AssertReturn(pfnHandlerR0 != NIL_RTR0PTR, VERR_INVALID_POINTER);
96	AssertReturn(pfnPfHandlerR0 != NIL_RTR0PTR, VERR_INVALID_POINTER);
97	AssertReturn(pfnHandlerRC != NIL_RTRCPTR \|\| HMIsEnabled(pVM), VERR_INVALID_POINTER);
98	AssertReturn(pfnPfHandlerRC != NIL_RTRCPTR \|\| HMIsEnabled(pVM), VERR_INVALID_POINTER);
99	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
100	AssertReturn( enmKind == PGMPHYSHANDLERKIND_WRITE
101	\|\| enmKind == PGMPHYSHANDLERKIND_ALL
102	\|\| enmKind == PGMPHYSHANDLERKIND_MMIO,
103	VERR_INVALID_PARAMETER);
104
105	PPGMPHYSHANDLERTYPEINT pType;
106	int rc = MMHyperAlloc(pVM, sizeof(pType), 0, MM_TAG_PGM_HANDLER_TYPES, (void *)&pType);
107	if (RT_SUCCESS(rc))
108	{
109	pType->u32Magic = PGMPHYSHANDLERTYPEINT_MAGIC;
110	pType->cRefs = 1;
111	pType->enmKind = enmKind;
112	pType->uState = enmKind == PGMPHYSHANDLERKIND_WRITE
113	? PGM_PAGE_HNDL_PHYS_STATE_WRITE : PGM_PAGE_HNDL_PHYS_STATE_ALL;
114	pType->pfnHandlerR3 = pfnHandlerR3;
115	pType->pfnHandlerR0 = pfnHandlerR0;
116	pType->pfnPfHandlerR0 = pfnPfHandlerR0;
117	pType->pfnHandlerRC = pfnHandlerRC;
118	pType->pfnPfHandlerRC = pfnPfHandlerRC;
119	pType->pszDesc = pszDesc;
120
121	pgmLock(pVM);
122	RTListOff32Append(&pVM->pgm.s.CTX_SUFF(pTrees)->HeadPhysHandlerTypes, &pType->ListNode);
123	pgmUnlock(pVM);
124
125	*phType = MMHyperHeapPtrToOffset(pVM, pType);
126	LogFlow(("PGMR3HandlerPhysicalTypeRegisterEx: %p/%#x: enmKind=%d pfnHandlerR3=%RHv pfnHandlerR0=%RHv pfnHandlerRC=%RRv pszDesc=%s\n",
127	pType, *phType, enmKind, pfnHandlerR3, pfnPfHandlerR0, pfnPfHandlerRC, pszDesc));
128	return VINF_SUCCESS;
129	}
130	*phType = NIL_PGMPHYSHANDLERTYPE;
131	return rc;
132	}
133
134
135	/**
136	* Register a physical page access handler type.
137	*
138	* @returns VBox status code.
139	* @param pVM The cross context VM structure.
140	* @param enmKind The kind of access handler.
141	* @param pfnHandlerR3 Pointer to the ring-3 handler callback.
142	* @param pszModR0 The name of the ring-0 module, NULL is an alias for
143	* the main ring-0 module.
144	* @param pszHandlerR0 The name of the ring-0 handler, NULL if the ring-3
145	* handler should be called.
146	* @param pszPfHandlerR0 The name of the ring-0 \#PF handler, NULL if the
147	* ring-3 handler should be called.
148	* @param pszModRC The name of the raw-mode context module, NULL is an
149	* alias for the main RC module.
150	* @param pszHandlerRC The name of the raw-mode context handler, NULL if
151	* the ring-3 handler should be called.
152	* @param pszPfHandlerRC The name of the raw-mode context \#PF handler, NULL
153	* if the ring-3 handler should be called.
154	* @param pszDesc The type description.
155	* @param phType Where to return the type handle (cross context
156	* safe).
157	*/
158	VMMR3DECL(int) PGMR3HandlerPhysicalTypeRegister(PVM pVM, PGMPHYSHANDLERKIND enmKind,
159	R3PTRTYPE(PFNPGMPHYSHANDLER) pfnHandlerR3,
160	const char pszModR0, const char pszHandlerR0, const char *pszPfHandlerR0,
161	const char pszModRC, const char pszHandlerRC, const char *pszPfHandlerRC,
162	const char *pszDesc, PPGMPHYSHANDLERTYPE phType)
163	{
164	LogFlow(("PGMR3HandlerPhysicalTypeRegister: enmKind=%d pfnHandlerR3=%RHv pszModR0=%s pszHandlerR0=%s pszPfHandlerR0=%s pszModRC=%s pszHandlerRC=%s pszPfHandlerRC=%s pszDesc=%s\n",
165	enmKind, pfnHandlerR3, pszModR0, pszHandlerR0, pszPfHandlerR0, pszModRC, pszHandlerRC, pszPfHandlerRC, pszDesc));
166
167	/*
168	* Validate input.
169	*/
170	AssertPtrReturn(pfnHandlerR3, VERR_INVALID_POINTER);
171	AssertPtrNullReturn(pszModR0, VERR_INVALID_POINTER);
172	AssertPtrNullReturn(pszHandlerR0, VERR_INVALID_POINTER);
173	AssertPtrNullReturn(pszPfHandlerR0, VERR_INVALID_POINTER);
174	AssertPtrNullReturn(pszModRC, VERR_INVALID_POINTER);
175	AssertPtrNullReturn(pszHandlerRC, VERR_INVALID_POINTER);
176	AssertPtrNullReturn(pszPfHandlerRC, VERR_INVALID_POINTER);
177
178	/*
179	* Resolve the R0 handlers.
180	*/
181	R0PTRTYPE(PFNPGMPHYSHANDLER) pfnHandlerR0 = NIL_RTR0PTR;
182	int rc = PDMR3LdrGetSymbolR0Lazy(pVM, pszHandlerR0 ? pszModR0 : NULL, NULL /pszSearchPath/,
183	pszHandlerR0 ? pszHandlerR0 : "pgmPhysHandlerRedirectToHC", &pfnHandlerR0);
184	if (RT_SUCCESS(rc))
185	{
186	R0PTRTYPE(PFNPGMR0PHYSPFHANDLER) pfnPfHandlerR0 = NIL_RTR0PTR;
187	rc = PDMR3LdrGetSymbolR0Lazy(pVM, pszPfHandlerR0 ? pszModR0 : NULL, NULL /pszSearchPath/,
188	pszPfHandlerR0 ? pszPfHandlerR0 : "pgmPhysPfHandlerRedirectToHC", &pfnPfHandlerR0);
189	if (RT_SUCCESS(rc))
190	{
191	/*
192	* Resolve the GC handler.
193	*/
194	RTRCPTR pfnHandlerRC = NIL_RTRCPTR;
195	RTRCPTR pfnPfHandlerRC = NIL_RTRCPTR;
196	if (!HMIsEnabled(pVM))
197	{
198	rc = PDMR3LdrGetSymbolRCLazy(pVM, pszHandlerRC ? pszModRC : NULL, NULL /pszSearchPath/,
199	pszHandlerRC ? pszHandlerRC : "pgmPhysHandlerRedirectToHC", &pfnHandlerRC);
200	if (RT_SUCCESS(rc))
201	{
202	rc = PDMR3LdrGetSymbolRCLazy(pVM, pszPfHandlerRC ? pszModRC : NULL, NULL /pszSearchPath/,
203	pszPfHandlerRC ? pszPfHandlerRC : "pgmPhysPfHandlerRedirectToHC", &pfnPfHandlerRC);
204	AssertMsgRC(rc, ("Failed to resolve %s.%s, rc=%Rrc.\n", pszPfHandlerRC ? pszModRC : VMMRC_MAIN_MODULE_NAME,
205	pszPfHandlerRC ? pszPfHandlerRC : "pgmPhysPfHandlerRedirectToHC", rc));
206	}
207	else
208	AssertMsgFailed(("Failed to resolve %s.%s, rc=%Rrc.\n", pszHandlerRC ? pszModRC : VMMRC_MAIN_MODULE_NAME,
209	pszHandlerRC ? pszHandlerRC : "pgmPhysHandlerRedirectToHC", rc));
210
211	}
212	if (RT_SUCCESS(rc))
213	return PGMR3HandlerPhysicalTypeRegisterEx(pVM, enmKind, pfnHandlerR3,
214	pfnHandlerR0, pfnPfHandlerR0,
215	pfnHandlerRC, pfnPfHandlerRC,
216	pszDesc, phType);
217	}
218	else
219	AssertMsgFailed(("Failed to resolve %s.%s, rc=%Rrc.\n", pszPfHandlerR0 ? pszModR0 : VMMR0_MAIN_MODULE_NAME,
220	pszPfHandlerR0 ? pszPfHandlerR0 : "pgmPhysHandlerRedirectToHC", rc));
221	}
222	else
223	AssertMsgFailed(("Failed to resolve %s.%s, rc=%Rrc.\n", pszHandlerR0 ? pszModR0 : VMMR0_MAIN_MODULE_NAME,
224	pszHandlerR0 ? pszHandlerR0 : "pgmPhysHandlerRedirectToHC", rc));
225
226	return rc;
227	}
228
229
230	/**
231	* Updates the physical page access handlers.
232	*
233	* @param pVM The cross context VM structure.
234	* @remark Only used when restoring a saved state.
235	*/
236	void pgmR3HandlerPhysicalUpdateAll(PVM pVM)
237	{
238	LogFlow(("pgmHandlerPhysicalUpdateAll:\n"));
239
240	/*
241	* Clear and set.
242	* (the right -> left on the setting pass is just bird speculating on cache hits)
243	*/
244	pgmLock(pVM);
245	RTAvlroGCPhysDoWithAll(&pVM->pgm.s.CTX_SUFF(pTrees)->PhysHandlers, true, pgmR3HandlerPhysicalOneClear, pVM);
246	RTAvlroGCPhysDoWithAll(&pVM->pgm.s.CTX_SUFF(pTrees)->PhysHandlers, false, pgmR3HandlerPhysicalOneSet, pVM);
247	pgmUnlock(pVM);
248	}
249
250
251	/**
252	* Clears all the page level flags for one physical handler range.
253	*
254	* @returns 0
255	* @param pNode Pointer to a PGMPHYSHANDLER.
256	* @param pvUser Pointer to the VM.
257	*/
258	static DECLCALLBACK(int) pgmR3HandlerPhysicalOneClear(PAVLROGCPHYSNODECORE pNode, void *pvUser)
259	{
260	PPGMPHYSHANDLER pCur = (PPGMPHYSHANDLER)pNode;
261	PPGMRAMRANGE pRamHint = NULL;
262	RTGCPHYS GCPhys = pCur->Core.Key;
263	RTUINT cPages = pCur->cPages;
264	PVM pVM = (PVM)pvUser;
265	for (;;)
266	{
267	PPGMPAGE pPage;
268	int rc = pgmPhysGetPageWithHintEx(pVM, GCPhys, &pPage, &pRamHint);
269	if (RT_SUCCESS(rc))
270	PGM_PAGE_SET_HNDL_PHYS_STATE(pPage, PGM_PAGE_HNDL_PHYS_STATE_NONE);
271	else
272	AssertRC(rc);
273
274	if (--cPages == 0)
275	return 0;
276	GCPhys += PAGE_SIZE;
277	}
278	}
279
280
281	/**
282	* Sets all the page level flags for one physical handler range.
283	*
284	* @returns 0
285	* @param pNode Pointer to a PGMPHYSHANDLER.
286	* @param pvUser Pointer to the VM.
287	*/
288	static DECLCALLBACK(int) pgmR3HandlerPhysicalOneSet(PAVLROGCPHYSNODECORE pNode, void *pvUser)
289	{
290	PVM pVM = (PVM)pvUser;
291	PPGMPHYSHANDLER pCur = (PPGMPHYSHANDLER)pNode;
292	PPGMPHYSHANDLERTYPEINT pCurType = PGMPHYSHANDLER_GET_TYPE(pVM, pCur);
293	unsigned uState = pCurType->uState;
294	PPGMRAMRANGE pRamHint = NULL;
295	RTGCPHYS GCPhys = pCur->Core.Key;
296	RTUINT cPages = pCur->cPages;
297	for (;;)
298	{
299	PPGMPAGE pPage;
300	int rc = pgmPhysGetPageWithHintEx(pVM, GCPhys, &pPage, &pRamHint);
301	if (RT_SUCCESS(rc))
302	PGM_PAGE_SET_HNDL_PHYS_STATE(pPage, uState);
303	else
304	AssertRC(rc);
305
306	if (--cPages == 0)
307	return 0;
308	GCPhys += PAGE_SIZE;
309	}
310	}
311
312	#ifdef VBOX_WITH_RAW_MODE
313
314	/**
315	* Register a virtual page access handler type, extended version.
316	*
317	* @returns VBox status code.
318	* @param pVM The cross context VM structure.
319	* @param enmKind The kind of access handler.
320	* @param fRelocUserRC Whether the pvUserRC argument should be
321	* automatically relocated or not.
322	* @param pfnInvalidateR3 Pointer to the ring-3 invalidation handler callback.
323	* Warning! This callback stopped working in VBox v1.2!
324	* @param pfnHandlerR3 Pointer to the ring-3 handler callback.
325	* @param pfnHandlerRC Pointer to the raw-mode context handler callback.
326	* @param pfnPfHandlerRC Pointer to the raw-mode context \#PF handler
327	* callback.
328	* @param pszDesc The type description.
329	* @param phType Where to return the type handle (cross context
330	* safe).
331	* @remarks No virtual handlers when executing using HM (i.e. ring-0).
332	*/
333	VMMR3_INT_DECL(int) PGMR3HandlerVirtualTypeRegisterEx(PVM pVM, PGMVIRTHANDLERKIND enmKind, bool fRelocUserRC,
334	PFNPGMR3VIRTINVALIDATE pfnInvalidateR3,
335	PFNPGMVIRTHANDLER pfnHandlerR3,
336	RCPTRTYPE(FNPGMVIRTHANDLER) pfnHandlerRC,
337	RCPTRTYPE(FNPGMRCVIRTPFHANDLER) pfnPfHandlerRC,
338	const char *pszDesc, PPGMVIRTHANDLERTYPE phType)
339	{
340	AssertReturn(!HMIsEnabled(pVM), VERR_NOT_AVAILABLE); /* Not supported/relevant for VT-x and AMD-V. */
341	AssertReturn( enmKind == PGMVIRTHANDLERKIND_WRITE
342	\|\| enmKind == PGMVIRTHANDLERKIND_ALL
343	\|\| enmKind == PGMVIRTHANDLERKIND_HYPERVISOR,
344	VERR_INVALID_PARAMETER);
345	if (enmKind != PGMVIRTHANDLERKIND_HYPERVISOR)
346	{
347	AssertPtrNullReturn(pfnInvalidateR3, VERR_INVALID_POINTER);
348	AssertPtrReturn(pfnHandlerR3, VERR_INVALID_POINTER);
349	AssertReturn(pfnHandlerRC != NIL_RTRCPTR, VERR_INVALID_POINTER);
350	}
351	else
352	{
353	AssertReturn(pfnInvalidateR3 == NULL, VERR_INVALID_POINTER);
354	AssertReturn(pfnHandlerR3 == NULL, VERR_INVALID_POINTER);
355	AssertReturn(pfnHandlerRC == NIL_RTR0PTR, VERR_INVALID_POINTER);
356	}
357	AssertReturn(pfnPfHandlerRC != NIL_RTRCPTR, VERR_INVALID_POINTER);
358	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
359
360	PPGMVIRTHANDLERTYPEINT pType;
361	int rc = MMHyperAlloc(pVM, sizeof(pType), 0, MM_TAG_PGM_HANDLER_TYPES, (void *)&pType);
362	if (RT_SUCCESS(rc))
363	{
364	pType->u32Magic = PGMVIRTHANDLERTYPEINT_MAGIC;
365	pType->cRefs = 1;
366	pType->enmKind = enmKind;
367	pType->fRelocUserRC = fRelocUserRC;
368	pType->uState = enmKind == PGMVIRTHANDLERKIND_ALL
369	? PGM_PAGE_HNDL_VIRT_STATE_ALL : PGM_PAGE_HNDL_VIRT_STATE_WRITE;
370	pType->pfnInvalidateR3 = pfnInvalidateR3;
371	pType->pfnHandlerR3 = pfnHandlerR3;
372	pType->pfnHandlerRC = pfnHandlerRC;
373	pType->pfnPfHandlerRC = pfnPfHandlerRC;
374	pType->pszDesc = pszDesc;
375
376	pgmLock(pVM);
377	RTListOff32Append(&pVM->pgm.s.CTX_SUFF(pTrees)->HeadVirtHandlerTypes, &pType->ListNode);
378	pgmUnlock(pVM);
379
380	*phType = MMHyperHeapPtrToOffset(pVM, pType);
381	LogFlow(("PGMR3HandlerVirtualTypeRegisterEx: %p/%#x: enmKind=%d pfnInvalidateR3=%RHv pfnHandlerR3=%RHv pfnPfHandlerRC=%RRv pszDesc=%s\n",
382	pType, *phType, enmKind, pfnInvalidateR3, pfnHandlerR3, pfnPfHandlerRC, pszDesc));
383	return VINF_SUCCESS;
384	}
385	*phType = NIL_PGMVIRTHANDLERTYPE;
386	return rc;
387	}
388
389
390	/**
391	* Register a physical page access handler type.
392	*
393	* @returns VBox status code.
394	* @param pVM The cross context VM structure.
395	* @param enmKind The kind of access handler.
396	* @param fRelocUserRC Whether the pvUserRC argument should be
397	* automatically relocated or not.
398	* @param pfnInvalidateR3 Pointer to the ring-3 invalidateion callback
399	* (optional, can be NULL).
400	* @param pfnHandlerR3 Pointer to the ring-3 handler callback.
401	* @param pszHandlerRC The name of the raw-mode context handler callback
402	* (in VMMRC.rc).
403	* @param pszPfHandlerRC The name of the raw-mode context \#PF handler (in
404	* VMMRC.rc).
405	* @param pszDesc The type description.
406	* @param phType Where to return the type handle (cross context
407	* safe).
408	* @remarks No virtual handlers when executing using HM (i.e. ring-0).
409	*/
410	VMMR3_INT_DECL(int) PGMR3HandlerVirtualTypeRegister(PVM pVM, PGMVIRTHANDLERKIND enmKind, bool fRelocUserRC,
411	PFNPGMR3VIRTINVALIDATE pfnInvalidateR3,
412	PFNPGMVIRTHANDLER pfnHandlerR3,
413	const char pszHandlerRC, const char pszPfHandlerRC, const char *pszDesc,
414	PPGMVIRTHANDLERTYPE phType)
415	{
416	LogFlow(("PGMR3HandlerVirtualTypeRegister: enmKind=%d pfnInvalidateR3=%RHv pfnHandlerR3=%RHv pszPfHandlerRC=%s pszDesc=%s\n",
417	enmKind, pfnInvalidateR3, pfnHandlerR3, pszPfHandlerRC, pszDesc));
418
419	/*
420	* Validate input.
421	*/
422	AssertPtrNullReturn(pszHandlerRC, VERR_INVALID_POINTER);
423	AssertPtrReturn(pszPfHandlerRC, VERR_INVALID_POINTER);
424
425	/*
426	* Resolve the GC handler.
427	*/
428	RTRCPTR pfnHandlerRC = NIL_RTRCPTR;
429	int rc = VINF_SUCCESS;
430	if (pszHandlerRC)
431	rc = PDMR3LdrGetSymbolRCLazy(pVM, VMMRC_MAIN_MODULE_NAME, NULL /pszSearchPath/, pszHandlerRC, &pfnHandlerRC);
432	if (RT_SUCCESS(rc))
433	{
434	RTRCPTR pfnPfHandlerRC = NIL_RTRCPTR;
435	rc = PDMR3LdrGetSymbolRCLazy(pVM, VMMRC_MAIN_MODULE_NAME, NULL /pszSearchPath/, pszPfHandlerRC, &pfnPfHandlerRC);
436	if (RT_SUCCESS(rc))
437	return PGMR3HandlerVirtualTypeRegisterEx(pVM, enmKind, fRelocUserRC,
438	pfnInvalidateR3, pfnHandlerR3,
439	pfnHandlerRC, pfnPfHandlerRC,
440	pszDesc, phType);
441
442	AssertMsgFailed(("Failed to resolve %s.%s, rc=%Rrc.\n", VMMRC_MAIN_MODULE_NAME, pszPfHandlerRC, rc));
443	}
444	else
445	AssertMsgFailed(("Failed to resolve %s.%s, rc=%Rrc.\n", VMMRC_MAIN_MODULE_NAME, pszHandlerRC, rc));
446	return rc;
447	}
448
449
450	/**
451	* Register a access handler for a virtual range.
452	*
453	* @returns VBox status code.
454	* @param pVM The cross context VM structure.
455	* @param hType The handler type.
456	* @param GCPtr Start address.
457	* @param GCPtrLast Last address (inclusive).
458	* @param pvUserR3 The ring-3 context user argument.
459	* @param pvUserRC The raw-mode context user argument. Whether this is
460	* automatically relocated or not depends on the type.
461	* @param pszDesc Pointer to description string. This must not be freed.
462	*/
463	VMMR3_INT_DECL(int) PGMR3HandlerVirtualRegister(PVM pVM, PVMCPU pVCpu, PGMVIRTHANDLERTYPE hType, RTGCPTR GCPtr, RTGCPTR GCPtrLast,
464	void pvUserR3, RTRCPTR pvUserRC, const char pszDesc)
465	{
466	AssertReturn(!HMIsEnabled(pVM), VERR_NOT_AVAILABLE); /* Not supported/relevant for VT-x and AMD-V. */
467	PPGMVIRTHANDLERTYPEINT pType = PGMVIRTHANDLERTYPEINT_FROM_HANDLE(pVM, hType);
468	Log(("PGMR3HandlerVirtualRegister: GCPhys=%RGp GCPhysLast=%RGp pvUserR3=%RHv pvUserGC=%RRv hType=%#x (%d, %s) pszDesc=%RHv:%s\n",
469	GCPtr, GCPtrLast, pvUserR3, pvUserRC, hType, pType->enmKind, R3STRING(pType->pszDesc), pszDesc, R3STRING(pszDesc)));
470
471	/*
472	* Validate input.
473	*/
474	AssertReturn(pType->u32Magic == PGMVIRTHANDLERTYPEINT_MAGIC, VERR_INVALID_HANDLE);
475	AssertMsgReturn(GCPtr < GCPtrLast, ("GCPtr >= GCPtrLast (%RGp >= %RGp)\n", GCPtr, GCPtrLast), VERR_INVALID_PARAMETER);
476	switch (pType->enmKind)
477	{
478	case PGMVIRTHANDLERKIND_ALL:
479	/* Simplification for PGMPhysRead and others: Full pages. */
480	AssertReleaseMsgReturn( (GCPtr & PAGE_OFFSET_MASK) == 0
481	&& (GCPtrLast & PAGE_OFFSET_MASK) == PAGE_OFFSET_MASK,
482	("PGMVIRTHANDLERKIND_ALL: GCPtr=%RGv GCPtrLast=%RGv\n", GCPtr, GCPtrLast),
483	VERR_NOT_IMPLEMENTED);
484	break;
485	case PGMVIRTHANDLERKIND_WRITE:
486	case PGMVIRTHANDLERKIND_HYPERVISOR:
487	break;
488	default:
489	AssertMsgFailedReturn(("Invalid enmKind=%d!\n", pType->enmKind), VERR_INVALID_PARAMETER);
490	}
491	AssertMsgReturn( (RTRCUINTPTR)pvUserRC < 0x10000
492	\|\| MMHyperR3ToRC(pVM, MMHyperRCToR3(pVM, pvUserRC)) == pvUserRC,
493	("Not RC pointer! pvUserRC=%RRv\n", pvUserRC),
494	VERR_INVALID_PARAMETER);
495
496	/*
497	* Allocate and initialize a new entry.
498	*/
499	unsigned cPages = (RT_ALIGN(GCPtrLast + 1, PAGE_SIZE) - (GCPtr & PAGE_BASE_GC_MASK)) >> PAGE_SHIFT;
500	PPGMVIRTHANDLER pNew;
501	int rc = MMHyperAlloc(pVM, RT_OFFSETOF(PGMVIRTHANDLER, aPhysToVirt[cPages]), 0, MM_TAG_PGM_HANDLERS, (void )&pNew); / @todo r=bird: incorrect member name PhysToVirt? */
502	if (RT_FAILURE(rc))
503	return rc;
504
505	pNew->Core.Key = GCPtr;
506	pNew->Core.KeyLast = GCPtrLast;
507
508	pNew->hType = hType;
509	pNew->pvUserRC = pvUserRC;
510	pNew->pvUserR3 = pvUserR3;
511	pNew->pszDesc = pszDesc ? pszDesc : pType->pszDesc;
512	pNew->cb = GCPtrLast - GCPtr + 1;
513	pNew->cPages = cPages;
514	/* Will be synced at next guest execution attempt. */
515	while (cPages-- > 0)
516	{
517	pNew->aPhysToVirt[cPages].Core.Key = NIL_RTGCPHYS;
518	pNew->aPhysToVirt[cPages].Core.KeyLast = NIL_RTGCPHYS;
519	pNew->aPhysToVirt[cPages].offVirtHandler = -RT_OFFSETOF(PGMVIRTHANDLER, aPhysToVirt[cPages]);
520	pNew->aPhysToVirt[cPages].offNextAlias = 0;
521	}
522
523	/*
524	* Try to insert it into the tree.
525	*
526	* The current implementation doesn't allow multiple handlers for
527	* the same range this makes everything much simpler and faster.
528	*/
529	AVLROGCPTRTREE *pRoot = pType->enmKind != PGMVIRTHANDLERKIND_HYPERVISOR
530	? &pVM->pgm.s.CTX_SUFF(pTrees)->VirtHandlers
531	: &pVM->pgm.s.CTX_SUFF(pTrees)->HyperVirtHandlers;
532	pgmLock(pVM);
533	if (*pRoot != 0)
534	{
535	PPGMVIRTHANDLER pCur = (PPGMVIRTHANDLER)RTAvlroGCPtrGetBestFit(pRoot, pNew->Core.Key, true);
536	if ( !pCur
537	\|\| GCPtr > pCur->Core.KeyLast
538	\|\| GCPtrLast < pCur->Core.Key)
539	pCur = (PPGMVIRTHANDLER)RTAvlroGCPtrGetBestFit(pRoot, pNew->Core.Key, false);
540	if ( pCur
541	&& GCPtr <= pCur->Core.KeyLast
542	&& GCPtrLast >= pCur->Core.Key)
543	{
544	/*
545	* The LDT sometimes conflicts with the IDT and LDT ranges while being
546	* updated on linux. So, we don't assert simply log it.
547	*/
548	Log(("PGMR3HandlerVirtualRegister: Conflict with existing range %RGv-%RGv (%s), req. %RGv-%RGv (%s)\n",
549	pCur->Core.Key, pCur->Core.KeyLast, pCur->pszDesc, GCPtr, GCPtrLast, pszDesc));
550	MMHyperFree(pVM, pNew);
551	pgmUnlock(pVM);
552	return VERR_PGM_HANDLER_VIRTUAL_CONFLICT;
553	}
554	}
555	if (RTAvlroGCPtrInsert(pRoot, &pNew->Core))
556	{
557	if (pType->enmKind != PGMVIRTHANDLERKIND_HYPERVISOR)
558	{
559	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_UPDATE_PAGE_BIT_VIRTUAL \| PGM_SYNC_CLEAR_PGM_POOL;
560	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
561	}
562	PGMHandlerVirtualTypeRetain(pVM, hType);
563	pgmUnlock(pVM);
564
565	#ifdef VBOX_WITH_STATISTICS
566	rc = STAMR3RegisterF(pVM, &pNew->Stat, STAMTYPE_PROFILE, STAMVISIBILITY_USED, STAMUNIT_TICKS_PER_CALL, pNew->pszDesc,
567	"/PGM/VirtHandler/Calls/%RGv-%RGv", pNew->Core.Key, pNew->Core.KeyLast);
568	AssertRC(rc);
569	#endif
570	return VINF_SUCCESS;
571	}
572
573	pgmUnlock(pVM);
574	AssertFailed();
575	MMHyperFree(pVM, pNew);
576	return VERR_PGM_HANDLER_VIRTUAL_CONFLICT;
577
578	}
579
580
581	/**
582	* Changes the type of a virtual handler.
583	*
584	* The new and old type must have the same access kind.
585	*
586	* @returns VBox status code.
587	* @param pVM The cross context VM structure.
588	* @param GCPtr Start address of the virtual handler.
589	* @param hNewType The new handler type.
590	*/
591	VMMR3_INT_DECL(int) PGMHandlerVirtualChangeType(PVM pVM, RTGCPTR GCPtr, PGMVIRTHANDLERTYPE hNewType)
592	{
593	PPGMVIRTHANDLERTYPEINT pNewType = PGMVIRTHANDLERTYPEINT_FROM_HANDLE(pVM, hNewType);
594	AssertReturn(pNewType->u32Magic == PGMVIRTHANDLERTYPEINT_MAGIC, VERR_INVALID_HANDLE);
595
596	pgmLock(pVM);
597	PPGMVIRTHANDLER pCur = (PPGMVIRTHANDLER)RTAvlroGCPtrGet(&pVM->pgm.s.pTreesR3->VirtHandlers, GCPtr);
598	if (pCur)
599	{
600	PGMVIRTHANDLERTYPE hOldType = pCur->hType;
601	PPGMVIRTHANDLERTYPEINT pOldType = PGMVIRTHANDLERTYPEINT_FROM_HANDLE(pVM, hOldType);
602	if (pOldType != pNewType)
603	{
604	AssertReturnStmt(pNewType->enmKind == pOldType->enmKind, pgmUnlock(pVM), VERR_ACCESS_DENIED);
605	PGMHandlerVirtualTypeRetain(pVM, hNewType);
606	pCur->hType = hNewType;
607	PGMHandlerVirtualTypeRelease(pVM, hOldType);
608	}
609	pgmUnlock(pVM);
610	return VINF_SUCCESS;
611	}
612	pgmUnlock(pVM);
613	AssertMsgFailed(("Range %#x not found!\n", GCPtr));
614	return VERR_INVALID_PARAMETER;
615	}
616
617
618	/**
619	* Deregister an access handler for a virtual range.
620	*
621	* @returns VBox status code.
622	* @param pVM The cross context VM structure.
623	* @param pVCpu The cross context virtual CPU structure of the calling
624	* EMT.
625	* @param GCPtr Start address.
626	* @param fHypervisor Set if PGMVIRTHANDLERKIND_HYPERVISOR, false if not.
627	* @thread EMT(pVCpu)
628	*/
629	VMMR3_INT_DECL(int) PGMHandlerVirtualDeregister(PVM pVM, PVMCPU pVCpu, RTGCPTR GCPtr, bool fHypervisor)
630	{
631	pgmLock(pVM);
632
633	PPGMVIRTHANDLER pCur;
634	if (!fHypervisor)
635	{
636	/*
637	* Normal guest handler.
638	*/
639	pCur = (PPGMVIRTHANDLER)RTAvlroGCPtrRemove(&pVM->pgm.s.CTX_SUFF(pTrees)->VirtHandlers, GCPtr);
640	AssertMsgReturnStmt(pCur, ("GCPtr=%RGv\n", GCPtr), pgmUnlock(pVM), VERR_INVALID_PARAMETER);
641	Assert(PGMVIRTANDLER_GET_TYPE(pVM, pCur)->enmKind != PGMVIRTHANDLERKIND_HYPERVISOR);
642
643	Log(("PGMHandlerVirtualDeregister: Removing Virtual (%d) Range %RGv-%RGv %s\n",
644	PGMVIRTANDLER_GET_TYPE(pVM, pCur)->enmKind, pCur->Core.Key, pCur->Core.KeyLast, pCur->pszDesc));
645
646	/* Reset the flags and remove phys2virt nodes. */
647	for (uint32_t iPage = 0; iPage < pCur->cPages; iPage++)
648	if (pCur->aPhysToVirt[iPage].offNextAlias & PGMPHYS2VIRTHANDLER_IN_TREE)
649	pgmHandlerVirtualClearPage(pVM, pCur, iPage);
650
651	/* Schedule CR3 sync. */
652	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_UPDATE_PAGE_BIT_VIRTUAL \| PGM_SYNC_CLEAR_PGM_POOL;
653	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
654	}
655	else
656	{
657	/*
658	* Hypervisor one (hypervisor relocation or termination only).
659	*/
660	pCur = (PPGMVIRTHANDLER)RTAvlroGCPtrRemove(&pVM->pgm.s.CTX_SUFF(pTrees)->HyperVirtHandlers, GCPtr);
661	AssertMsgReturnStmt(pCur, ("GCPtr=%RGv\n", GCPtr), pgmUnlock(pVM), VERR_INVALID_PARAMETER);
662	Assert(PGMVIRTANDLER_GET_TYPE(pVM, pCur)->enmKind == PGMVIRTHANDLERKIND_HYPERVISOR);
663
664	Log(("PGMHandlerVirtualDeregister: Removing Hyper Virtual Range %RGv-%RGv %s\n",
665	pCur->Core.Key, pCur->Core.KeyLast, pCur->pszDesc));
666	}
667
668	pgmUnlock(pVM);
669
670	/*
671	* Free it.
672	*/
673	#ifdef VBOX_WITH_STATISTICS
674	STAMR3DeregisterF(pVM->pUVM, "/PGM/VirtHandler/Calls/%RGv-%RGv", pCur->Core.Key, pCur->Core.KeyLast);
675	#endif
676	PGMHandlerVirtualTypeRelease(pVM, pCur->hType);
677	MMHyperFree(pVM, pCur);
678
679	return VINF_SUCCESS;
680	}
681
682	#endif /* VBOX_WITH_RAW_MODE */
683
684
685	/**
686	* Arguments for pgmR3InfoHandlersPhysicalOne and pgmR3InfoHandlersVirtualOne.
687	*/
688	typedef struct PGMHANDLERINFOARG
689	{
690	/** The output helpers.*/
691	PCDBGFINFOHLP pHlp;
692	/** Pointer to the cross context VM handle. */
693	PVM pVM;
694	/** Set if statistics should be dumped. */
695	bool fStats;
696	} PGMHANDLERINFOARG, *PPGMHANDLERINFOARG;
697
698
699	/**
700	* Info callback for 'pgmhandlers'.
701	*
702	* @param pVM The cross context VM structure.
703	* @param pHlp The output helpers.
704	* @param pszArgs The arguments. phys or virt.
705	*/
706	DECLCALLBACK(void) pgmR3InfoHandlers(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
707	{
708	/*
709	* Test input.
710	*/
711	PGMHANDLERINFOARG Args = { pHlp, pVM, /* .fStats = */ true };
712	bool fPhysical = !pszArgs \|\| !*pszArgs;
713	bool fVirtual = fPhysical;
714	bool fHyper = fPhysical;
715	if (!fPhysical)
716	{
717	bool fAll = strstr(pszArgs, "all") != NULL;
718	fPhysical = fAll \|\| strstr(pszArgs, "phys") != NULL;
719	fVirtual = fAll \|\| strstr(pszArgs, "virt") != NULL;
720	fHyper = fAll \|\| strstr(pszArgs, "hyper")!= NULL;
721	Args.fStats = strstr(pszArgs, "nost") == NULL;
722	}
723
724	/*
725	* Dump the handlers.
726	*/
727	if (fPhysical)
728	{
729	pHlp->pfnPrintf(pHlp,
730	"Physical handlers: (PhysHandlers=%d (%#x))\n"
731	"%s %s %s %s HandlerGC UserGC Type Description\n",
732	pVM->pgm.s.pTreesR3->PhysHandlers, pVM->pgm.s.pTreesR3->PhysHandlers,
733	- (int)sizeof(RTGCPHYS) * 2, "From",
734	- (int)sizeof(RTGCPHYS) * 2 - 3, "- To (incl)",
735	- (int)sizeof(RTHCPTR) * 2 - 1, "HandlerHC",
736	- (int)sizeof(RTHCPTR) * 2 - 1, "UserHC");
737	RTAvlroGCPhysDoWithAll(&pVM->pgm.s.pTreesR3->PhysHandlers, true, pgmR3InfoHandlersPhysicalOne, &Args);
738	}
739
740	#ifdef VBOX_WITH_RAW_MODE
741	if (fVirtual)
742	{
743	pHlp->pfnPrintf(pHlp,
744	"Virtual handlers:\n"
745	"%s %s %s %s Type Description\n",
746	- (int)sizeof(RTGCPTR) * 2, "From",
747	- (int)sizeof(RTGCPTR) * 2 - 3, "- To (excl)",
748	- (int)sizeof(RTHCPTR) * 2 - 1, "HandlerHC",
749	- (int)sizeof(RTRCPTR) * 2 - 1, "HandlerGC");
750	RTAvlroGCPtrDoWithAll(&pVM->pgm.s.pTreesR3->VirtHandlers, true, pgmR3InfoHandlersVirtualOne, &Args);
751	}
752
753	if (fHyper)
754	{
755	pHlp->pfnPrintf(pHlp,
756	"Hypervisor Virtual handlers:\n"
757	"%s %s %s %s Type Description\n",
758	- (int)sizeof(RTGCPTR) * 2, "From",
759	- (int)sizeof(RTGCPTR) * 2 - 3, "- To (excl)",
760	- (int)sizeof(RTHCPTR) * 2 - 1, "HandlerHC",
761	- (int)sizeof(RTRCPTR) * 2 - 1, "HandlerGC");
762	RTAvlroGCPtrDoWithAll(&pVM->pgm.s.pTreesR3->HyperVirtHandlers, true, pgmR3InfoHandlersVirtualOne, &Args);
763	}
764	#endif
765	}
766
767
768	/**
769	* Displays one physical handler range.
770	*
771	* @returns 0
772	* @param pNode Pointer to a PGMPHYSHANDLER.
773	* @param pvUser Pointer to command helper functions.
774	*/
775	static DECLCALLBACK(int) pgmR3InfoHandlersPhysicalOne(PAVLROGCPHYSNODECORE pNode, void *pvUser)
776	{
777	PPGMPHYSHANDLER pCur = (PPGMPHYSHANDLER)pNode;
778	PPGMHANDLERINFOARG pArgs = (PPGMHANDLERINFOARG)pvUser;
779	PCDBGFINFOHLP pHlp = pArgs->pHlp;
780	PPGMPHYSHANDLERTYPEINT pCurType = PGMPHYSHANDLER_GET_TYPE(pArgs->pVM, pCur);
781	const char *pszType;
782	switch (pCurType->enmKind)
783	{
784	case PGMPHYSHANDLERKIND_MMIO: pszType = "MMIO "; break;
785	case PGMPHYSHANDLERKIND_WRITE: pszType = "Write "; break;
786	case PGMPHYSHANDLERKIND_ALL: pszType = "All "; break;
787	default: pszType = "????"; break;
788	}
789	pHlp->pfnPrintf(pHlp,
790	"%RGp - %RGp %RHv %RHv %RRv %RRv %s %s\n",
791	pCur->Core.Key, pCur->Core.KeyLast, pCurType->pfnHandlerR3, pCur->pvUserR3, pCurType->pfnPfHandlerRC, pCur->pvUserRC,
792	pszType, pCur->pszDesc);
793	#ifdef VBOX_WITH_STATISTICS
794	if (pArgs->fStats)
795	pHlp->pfnPrintf(pHlp, " cPeriods: %9RU64 cTicks: %11RU64 Min: %11RU64 Avg: %11RU64 Max: %11RU64\n",
796	pCur->Stat.cPeriods, pCur->Stat.cTicks, pCur->Stat.cTicksMin,
797	pCur->Stat.cPeriods ? pCur->Stat.cTicks / pCur->Stat.cPeriods : 0, pCur->Stat.cTicksMax);
798	#endif
799	return 0;
800	}
801
802
803	#ifdef VBOX_WITH_RAW_MODE
804	/**
805	* Displays one virtual handler range.
806	*
807	* @returns 0
808	* @param pNode Pointer to a PGMVIRTHANDLER.
809	* @param pvUser Pointer to command helper functions.
810	*/
811	static DECLCALLBACK(int) pgmR3InfoHandlersVirtualOne(PAVLROGCPTRNODECORE pNode, void *pvUser)
812	{
813	PPGMVIRTHANDLER pCur = (PPGMVIRTHANDLER)pNode;
814	PPGMHANDLERINFOARG pArgs = (PPGMHANDLERINFOARG)pvUser;
815	PCDBGFINFOHLP pHlp = pArgs->pHlp;
816	PPGMVIRTHANDLERTYPEINT pCurType = PGMVIRTANDLER_GET_TYPE(pArgs->pVM, pCur);
817	const char *pszType;
818	switch (pCurType->enmKind)
819	{
820	case PGMVIRTHANDLERKIND_WRITE: pszType = "Write "; break;
821	case PGMVIRTHANDLERKIND_ALL: pszType = "All "; break;
822	case PGMVIRTHANDLERKIND_HYPERVISOR: pszType = "WriteHyp "; break;
823	default: pszType = "????"; break;
824	}
825	pHlp->pfnPrintf(pHlp, "%RGv - %RGv %RHv %RRv %s %s\n",
826	pCur->Core.Key, pCur->Core.KeyLast, pCurType->pfnHandlerR3, pCurType->pfnPfHandlerRC, pszType, pCur->pszDesc);
827	# ifdef VBOX_WITH_STATISTICS
828	if (pArgs->fStats)
829	pHlp->pfnPrintf(pHlp, " cPeriods: %9RU64 cTicks: %11RU64 Min: %11RU64 Avg: %11RU64 Max: %11RU64\n",
830	pCur->Stat.cPeriods, pCur->Stat.cTicks, pCur->Stat.cTicksMin,
831	pCur->Stat.cPeriods ? pCur->Stat.cTicks / pCur->Stat.cPeriods : 0, pCur->Stat.cTicksMax);
832	# endif
833	return 0;
834	}
835	#endif /* VBOX_WITH_RAW_MODE */
836

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

source: vbox/trunk/src/VBox/VMM/VMMR3/PGMHandler.cpp@ 61008

Download in other formats: