PGMPhys.cpp@ 69175

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

Line
1	/* $Id: PGMPhys.cpp 69111 2017-10-17 14:26:02Z vboxsync $ */
2	/** @file
3	* PGM - Page Manager and Monitor, Physical Memory Addressing.
4	*/
5
6	/*
7	* Copyright (C) 2006-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
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_PGM_PHYS
23	#include <VBox/vmm/pgm.h>
24	#include <VBox/vmm/iem.h>
25	#include <VBox/vmm/iom.h>
26	#include <VBox/vmm/mm.h>
27	#include <VBox/vmm/stam.h>
28	#ifdef VBOX_WITH_REM
29	# include <VBox/vmm/rem.h>
30	#endif
31	#include <VBox/vmm/pdmdev.h>
32	#include "PGMInternal.h"
33	#include <VBox/vmm/vm.h>
34	#include <VBox/vmm/uvm.h>
35	#include "PGMInline.h"
36	#include <VBox/sup.h>
37	#include <VBox/param.h>
38	#include <VBox/err.h>
39	#include <VBox/log.h>
40	#include <iprt/assert.h>
41	#include <iprt/alloc.h>
42	#include <iprt/asm.h>
43	#ifdef VBOX_STRICT
44	# include <iprt/crc.h>
45	#endif
46	#include <iprt/thread.h>
47	#include <iprt/string.h>
48	#include <iprt/system.h>
49
50
51	/*********************************************************************************************************************************
52	* Defined Constants And Macros *
53	*********************************************************************************************************************************/
54	/** The number of pages to free in one batch. */
55	#define PGMPHYS_FREE_PAGE_BATCH_SIZE 128
56
57
58	/*
59	* PGMR3PhysReadU8-64
60	* PGMR3PhysWriteU8-64
61	*/
62	#define PGMPHYSFN_READNAME PGMR3PhysReadU8
63	#define PGMPHYSFN_WRITENAME PGMR3PhysWriteU8
64	#define PGMPHYS_DATASIZE 1
65	#define PGMPHYS_DATATYPE uint8_t
66	#include "PGMPhysRWTmpl.h"
67
68	#define PGMPHYSFN_READNAME PGMR3PhysReadU16
69	#define PGMPHYSFN_WRITENAME PGMR3PhysWriteU16
70	#define PGMPHYS_DATASIZE 2
71	#define PGMPHYS_DATATYPE uint16_t
72	#include "PGMPhysRWTmpl.h"
73
74	#define PGMPHYSFN_READNAME PGMR3PhysReadU32
75	#define PGMPHYSFN_WRITENAME PGMR3PhysWriteU32
76	#define PGMPHYS_DATASIZE 4
77	#define PGMPHYS_DATATYPE uint32_t
78	#include "PGMPhysRWTmpl.h"
79
80	#define PGMPHYSFN_READNAME PGMR3PhysReadU64
81	#define PGMPHYSFN_WRITENAME PGMR3PhysWriteU64
82	#define PGMPHYS_DATASIZE 8
83	#define PGMPHYS_DATATYPE uint64_t
84	#include "PGMPhysRWTmpl.h"
85
86
87	/**
88	* EMT worker for PGMR3PhysReadExternal.
89	*/
90	static DECLCALLBACK(int) pgmR3PhysReadExternalEMT(PVM pVM, PRTGCPHYS pGCPhys, void *pvBuf, size_t cbRead,
91	PGMACCESSORIGIN enmOrigin)
92	{
93	VBOXSTRICTRC rcStrict = PGMPhysRead(pVM, *pGCPhys, pvBuf, cbRead, enmOrigin);
94	AssertMsg(rcStrict == VINF_SUCCESS, ("%Rrc\n", VBOXSTRICTRC_VAL(rcStrict))); NOREF(rcStrict);
95	return VINF_SUCCESS;
96	}
97
98
99	/**
100	* Read from physical memory, external users.
101	*
102	* @returns VBox status code.
103	* @retval VINF_SUCCESS.
104	*
105	* @param pVM The cross context VM structure.
106	* @param GCPhys Physical address to read from.
107	* @param pvBuf Where to read into.
108	* @param cbRead How many bytes to read.
109	* @param enmOrigin Who is calling.
110	*
111	* @thread Any but EMTs.
112	*/
113	VMMR3DECL(int) PGMR3PhysReadExternal(PVM pVM, RTGCPHYS GCPhys, void *pvBuf, size_t cbRead, PGMACCESSORIGIN enmOrigin)
114	{
115	VM_ASSERT_OTHER_THREAD(pVM);
116
117	AssertMsgReturn(cbRead > 0, ("don't even think about reading zero bytes!\n"), VINF_SUCCESS);
118	LogFlow(("PGMR3PhysReadExternal: %RGp %d\n", GCPhys, cbRead));
119
120	pgmLock(pVM);
121
122	/*
123	* Copy loop on ram ranges.
124	*/
125	PPGMRAMRANGE pRam = pgmPhysGetRangeAtOrAbove(pVM, GCPhys);
126	for (;;)
127	{
128	/* Inside range or not? */
129	if (pRam && GCPhys >= pRam->GCPhys)
130	{
131	/*
132	* Must work our way thru this page by page.
133	*/
134	RTGCPHYS off = GCPhys - pRam->GCPhys;
135	while (off < pRam->cb)
136	{
137	unsigned iPage = off >> PAGE_SHIFT;
138	PPGMPAGE pPage = &pRam->aPages[iPage];
139
140	/*
141	* If the page has an ALL access handler, we'll have to
142	* delegate the job to EMT.
143	*/
144	if ( PGM_PAGE_HAS_ACTIVE_ALL_HANDLERS(pPage)
145	\|\| PGM_PAGE_IS_SPECIAL_ALIAS_MMIO(pPage))
146	{
147	pgmUnlock(pVM);
148
149	return VMR3ReqPriorityCallWait(pVM, VMCPUID_ANY, (PFNRT)pgmR3PhysReadExternalEMT, 5,
150	pVM, &GCPhys, pvBuf, cbRead, enmOrigin);
151	}
152	Assert(!PGM_PAGE_IS_MMIO_OR_SPECIAL_ALIAS(pPage));
153
154	/*
155	* Simple stuff, go ahead.
156	*/
157	size_t cb = PAGE_SIZE - (off & PAGE_OFFSET_MASK);
158	if (cb > cbRead)
159	cb = cbRead;
160	PGMPAGEMAPLOCK PgMpLck;
161	const void *pvSrc;
162	int rc = pgmPhysGCPhys2CCPtrInternalReadOnly(pVM, pPage, pRam->GCPhys + off, &pvSrc, &PgMpLck);
163	if (RT_SUCCESS(rc))
164	{
165	memcpy(pvBuf, pvSrc, cb);
166	pgmPhysReleaseInternalPageMappingLock(pVM, &PgMpLck);
167	}
168	else
169	{
170	AssertLogRelMsgFailed(("pgmPhysGCPhys2CCPtrInternalReadOnly failed on %RGp / %R[pgmpage] -> %Rrc\n",
171	pRam->GCPhys + off, pPage, rc));
172	memset(pvBuf, 0xff, cb);
173	}
174
175	/* next page */
176	if (cb >= cbRead)
177	{
178	pgmUnlock(pVM);
179	return VINF_SUCCESS;
180	}
181	cbRead -= cb;
182	off += cb;
183	GCPhys += cb;
184	pvBuf = (char *)pvBuf + cb;
185	} /* walk pages in ram range. */
186	}
187	else
188	{
189	LogFlow(("PGMPhysRead: Unassigned %RGp size=%u\n", GCPhys, cbRead));
190
191	/*
192	* Unassigned address space.
193	*/
194	size_t cb = pRam ? pRam->GCPhys - GCPhys : ~(size_t)0;
195	if (cb >= cbRead)
196	{
197	memset(pvBuf, 0xff, cbRead);
198	break;
199	}
200	memset(pvBuf, 0xff, cb);
201
202	cbRead -= cb;
203	pvBuf = (char *)pvBuf + cb;
204	GCPhys += cb;
205	}
206
207	/* Advance range if necessary. */
208	while (pRam && GCPhys > pRam->GCPhysLast)
209	pRam = pRam->CTX_SUFF(pNext);
210	} /* Ram range walk */
211
212	pgmUnlock(pVM);
213
214	return VINF_SUCCESS;
215	}
216
217
218	/**
219	* EMT worker for PGMR3PhysWriteExternal.
220	*/
221	static DECLCALLBACK(int) pgmR3PhysWriteExternalEMT(PVM pVM, PRTGCPHYS pGCPhys, const void *pvBuf, size_t cbWrite,
222	PGMACCESSORIGIN enmOrigin)
223	{
224	/** @todo VERR_EM_NO_MEMORY */
225	VBOXSTRICTRC rcStrict = PGMPhysWrite(pVM, *pGCPhys, pvBuf, cbWrite, enmOrigin);
226	AssertMsg(rcStrict == VINF_SUCCESS, ("%Rrc\n", VBOXSTRICTRC_VAL(rcStrict))); NOREF(rcStrict);
227	return VINF_SUCCESS;
228	}
229
230
231	/**
232	* Write to physical memory, external users.
233	*
234	* @returns VBox status code.
235	* @retval VINF_SUCCESS.
236	* @retval VERR_EM_NO_MEMORY.
237	*
238	* @param pVM The cross context VM structure.
239	* @param GCPhys Physical address to write to.
240	* @param pvBuf What to write.
241	* @param cbWrite How many bytes to write.
242	* @param enmOrigin Who is calling.
243	*
244	* @thread Any but EMTs.
245	*/
246	VMMDECL(int) PGMR3PhysWriteExternal(PVM pVM, RTGCPHYS GCPhys, const void *pvBuf, size_t cbWrite, PGMACCESSORIGIN enmOrigin)
247	{
248	VM_ASSERT_OTHER_THREAD(pVM);
249
250	AssertMsg(!pVM->pgm.s.fNoMorePhysWrites,
251	("Calling PGMR3PhysWriteExternal after pgmR3Save()! GCPhys=%RGp cbWrite=%#x enmOrigin=%d\n",
252	GCPhys, cbWrite, enmOrigin));
253	AssertMsgReturn(cbWrite > 0, ("don't even think about writing zero bytes!\n"), VINF_SUCCESS);
254	LogFlow(("PGMR3PhysWriteExternal: %RGp %d\n", GCPhys, cbWrite));
255
256	pgmLock(pVM);
257
258	/*
259	* Copy loop on ram ranges, stop when we hit something difficult.
260	*/
261	PPGMRAMRANGE pRam = pgmPhysGetRangeAtOrAbove(pVM, GCPhys);
262	for (;;)
263	{
264	/* Inside range or not? */
265	if (pRam && GCPhys >= pRam->GCPhys)
266	{
267	/*
268	* Must work our way thru this page by page.
269	*/
270	RTGCPTR off = GCPhys - pRam->GCPhys;
271	while (off < pRam->cb)
272	{
273	RTGCPTR iPage = off >> PAGE_SHIFT;
274	PPGMPAGE pPage = &pRam->aPages[iPage];
275
276	/*
277	* Is the page problematic, we have to do the work on the EMT.
278	*
279	* Allocating writable pages and access handlers are
280	* problematic, write monitored pages are simple and can be
281	* dealt with here.
282	*/
283	if ( PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage)
284	\|\| PGM_PAGE_GET_STATE(pPage) != PGM_PAGE_STATE_ALLOCATED
285	\|\| PGM_PAGE_IS_SPECIAL_ALIAS_MMIO(pPage))
286	{
287	if ( PGM_PAGE_GET_STATE(pPage) == PGM_PAGE_STATE_WRITE_MONITORED
288	&& !PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage))
289	pgmPhysPageMakeWriteMonitoredWritable(pVM, pPage);
290	else
291	{
292	pgmUnlock(pVM);
293
294	return VMR3ReqPriorityCallWait(pVM, VMCPUID_ANY, (PFNRT)pgmR3PhysWriteExternalEMT, 5,
295	pVM, &GCPhys, pvBuf, cbWrite, enmOrigin);
296	}
297	}
298	Assert(!PGM_PAGE_IS_MMIO_OR_SPECIAL_ALIAS(pPage));
299
300	/*
301	* Simple stuff, go ahead.
302	*/
303	size_t cb = PAGE_SIZE - (off & PAGE_OFFSET_MASK);
304	if (cb > cbWrite)
305	cb = cbWrite;
306	PGMPAGEMAPLOCK PgMpLck;
307	void *pvDst;
308	int rc = pgmPhysGCPhys2CCPtrInternal(pVM, pPage, pRam->GCPhys + off, &pvDst, &PgMpLck);
309	if (RT_SUCCESS(rc))
310	{
311	memcpy(pvDst, pvBuf, cb);
312	pgmPhysReleaseInternalPageMappingLock(pVM, &PgMpLck);
313	}
314	else
315	AssertLogRelMsgFailed(("pgmPhysGCPhys2CCPtrInternal failed on %RGp / %R[pgmpage] -> %Rrc\n",
316	pRam->GCPhys + off, pPage, rc));
317
318	/* next page */
319	if (cb >= cbWrite)
320	{
321	pgmUnlock(pVM);
322	return VINF_SUCCESS;
323	}
324
325	cbWrite -= cb;
326	off += cb;
327	GCPhys += cb;
328	pvBuf = (const char *)pvBuf + cb;
329	} /* walk pages in ram range */
330	}
331	else
332	{
333	/*
334	* Unassigned address space, skip it.
335	*/
336	if (!pRam)
337	break;
338	size_t cb = pRam->GCPhys - GCPhys;
339	if (cb >= cbWrite)
340	break;
341	cbWrite -= cb;
342	pvBuf = (const char *)pvBuf + cb;
343	GCPhys += cb;
344	}
345
346	/* Advance range if necessary. */
347	while (pRam && GCPhys > pRam->GCPhysLast)
348	pRam = pRam->CTX_SUFF(pNext);
349	} /* Ram range walk */
350
351	pgmUnlock(pVM);
352	return VINF_SUCCESS;
353	}
354
355
356	/**
357	* VMR3ReqCall worker for PGMR3PhysGCPhys2CCPtrExternal to make pages writable.
358	*
359	* @returns see PGMR3PhysGCPhys2CCPtrExternal
360	* @param pVM The cross context VM structure.
361	* @param pGCPhys Pointer to the guest physical address.
362	* @param ppv Where to store the mapping address.
363	* @param pLock Where to store the lock.
364	*/
365	static DECLCALLBACK(int) pgmR3PhysGCPhys2CCPtrDelegated(PVM pVM, PRTGCPHYS pGCPhys, void **ppv, PPGMPAGEMAPLOCK pLock)
366	{
367	/*
368	* Just hand it to PGMPhysGCPhys2CCPtr and check that it's not a page with
369	* an access handler after it succeeds.
370	*/
371	int rc = pgmLock(pVM);
372	AssertRCReturn(rc, rc);
373
374	rc = PGMPhysGCPhys2CCPtr(pVM, *pGCPhys, ppv, pLock);
375	if (RT_SUCCESS(rc))
376	{
377	PPGMPAGEMAPTLBE pTlbe;
378	int rc2 = pgmPhysPageQueryTlbe(pVM, *pGCPhys, &pTlbe);
379	AssertFatalRC(rc2);
380	PPGMPAGE pPage = pTlbe->pPage;
381	if (PGM_PAGE_IS_MMIO_OR_SPECIAL_ALIAS(pPage))
382	{
383	PGMPhysReleasePageMappingLock(pVM, pLock);
384	rc = VERR_PGM_PHYS_PAGE_RESERVED;
385	}
386	else if ( PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage)
387	#ifdef PGMPOOL_WITH_OPTIMIZED_DIRTY_PT
388	\|\| pgmPoolIsDirtyPage(pVM, *pGCPhys)
389	#endif
390	)
391	{
392	/* We must flush any corresponding pgm pool page here, otherwise we'll
393	* not be informed about writes and keep bogus gst->shw mappings around.
394	*/
395	pgmPoolFlushPageByGCPhys(pVM, *pGCPhys);
396	Assert(!PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage));
397	/** @todo r=bird: return VERR_PGM_PHYS_PAGE_RESERVED here if it still has
398	* active handlers, see the PGMR3PhysGCPhys2CCPtrExternal docs. */
399	}
400	}
401
402	pgmUnlock(pVM);
403	return rc;
404	}
405
406
407	/**
408	* Requests the mapping of a guest page into ring-3, external threads.
409	*
410	* When you're done with the page, call PGMPhysReleasePageMappingLock() ASAP to
411	* release it.
412	*
413	* This API will assume your intention is to write to the page, and will
414	* therefore replace shared and zero pages. If you do not intend to modify the
415	* page, use the PGMR3PhysGCPhys2CCPtrReadOnlyExternal() API.
416	*
417	* @returns VBox status code.
418	* @retval VINF_SUCCESS on success.
419	* @retval VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical
420	* backing or if the page has any active access handlers. The caller
421	* must fall back on using PGMR3PhysWriteExternal.
422	* @retval VERR_PGM_INVALID_GC_PHYSICAL_ADDRESS if it's not a valid physical address.
423	*
424	* @param pVM The cross context VM structure.
425	* @param GCPhys The guest physical address of the page that should be mapped.
426	* @param ppv Where to store the address corresponding to GCPhys.
427	* @param pLock Where to store the lock information that PGMPhysReleasePageMappingLock needs.
428	*
429	* @remark Avoid calling this API from within critical sections (other than the
430	* PGM one) because of the deadlock risk when we have to delegating the
431	* task to an EMT.
432	* @thread Any.
433	*/
434	VMMR3DECL(int) PGMR3PhysGCPhys2CCPtrExternal(PVM pVM, RTGCPHYS GCPhys, void **ppv, PPGMPAGEMAPLOCK pLock)
435	{
436	AssertPtr(ppv);
437	AssertPtr(pLock);
438
439	Assert(VM_IS_EMT(pVM) \|\| !PGMIsLockOwner(pVM));
440
441	int rc = pgmLock(pVM);
442	AssertRCReturn(rc, rc);
443
444	/*
445	* Query the Physical TLB entry for the page (may fail).
446	*/
447	PPGMPAGEMAPTLBE pTlbe;
448	rc = pgmPhysPageQueryTlbe(pVM, GCPhys, &pTlbe);
449	if (RT_SUCCESS(rc))
450	{
451	PPGMPAGE pPage = pTlbe->pPage;
452	if (PGM_PAGE_IS_MMIO_OR_SPECIAL_ALIAS(pPage))
453	rc = VERR_PGM_PHYS_PAGE_RESERVED;
454	else
455	{
456	/*
457	* If the page is shared, the zero page, or being write monitored
458	* it must be converted to an page that's writable if possible.
459	* We can only deal with write monitored pages here, the rest have
460	* to be on an EMT.
461	*/
462	if ( PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage)
463	\|\| PGM_PAGE_GET_STATE(pPage) != PGM_PAGE_STATE_ALLOCATED
464	#ifdef PGMPOOL_WITH_OPTIMIZED_DIRTY_PT
465	\|\| pgmPoolIsDirtyPage(pVM, GCPhys)
466	#endif
467	)
468	{
469	if ( PGM_PAGE_GET_STATE(pPage) == PGM_PAGE_STATE_WRITE_MONITORED
470	&& !PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage)
471	#ifdef PGMPOOL_WITH_OPTIMIZED_DIRTY_PT
472	&& !pgmPoolIsDirtyPage(pVM, GCPhys)
473	#endif
474	)
475	pgmPhysPageMakeWriteMonitoredWritable(pVM, pPage);
476	else
477	{
478	pgmUnlock(pVM);
479
480	return VMR3ReqPriorityCallWait(pVM, VMCPUID_ANY, (PFNRT)pgmR3PhysGCPhys2CCPtrDelegated, 4,
481	pVM, &GCPhys, ppv, pLock);
482	}
483	}
484
485	/*
486	* Now, just perform the locking and calculate the return address.
487	*/
488	PPGMPAGEMAP pMap = pTlbe->pMap;
489	if (pMap)
490	pMap->cRefs++;
491
492	unsigned cLocks = PGM_PAGE_GET_WRITE_LOCKS(pPage);
493	if (RT_LIKELY(cLocks < PGM_PAGE_MAX_LOCKS - 1))
494	{
495	if (cLocks == 0)
496	pVM->pgm.s.cWriteLockedPages++;
497	PGM_PAGE_INC_WRITE_LOCKS(pPage);
498	}
499	else if (cLocks != PGM_PAGE_GET_WRITE_LOCKS(pPage))
500	{
501	PGM_PAGE_INC_WRITE_LOCKS(pPage);
502	AssertMsgFailed(("%RGp / %R[pgmpage] is entering permanent write locked state!\n", GCPhys, pPage));
503	if (pMap)
504	pMap->cRefs++; /* Extra ref to prevent it from going away. */
505	}
506
507	ppv = (void )((uintptr_t)pTlbe->pv \| (uintptr_t)(GCPhys & PAGE_OFFSET_MASK));
508	pLock->uPageAndType = (uintptr_t)pPage \| PGMPAGEMAPLOCK_TYPE_WRITE;
509	pLock->pvMap = pMap;
510	}
511	}
512
513	pgmUnlock(pVM);
514	return rc;
515	}
516
517
518	/**
519	* Requests the mapping of a guest page into ring-3, external threads.
520	*
521	* When you're done with the page, call PGMPhysReleasePageMappingLock() ASAP to
522	* release it.
523	*
524	* @returns VBox status code.
525	* @retval VINF_SUCCESS on success.
526	* @retval VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical
527	* backing or if the page as an active ALL access handler. The caller
528	* must fall back on using PGMPhysRead.
529	* @retval VERR_PGM_INVALID_GC_PHYSICAL_ADDRESS if it's not a valid physical address.
530	*
531	* @param pVM The cross context VM structure.
532	* @param GCPhys The guest physical address of the page that should be mapped.
533	* @param ppv Where to store the address corresponding to GCPhys.
534	* @param pLock Where to store the lock information that PGMPhysReleasePageMappingLock needs.
535	*
536	* @remark Avoid calling this API from within critical sections (other than
537	* the PGM one) because of the deadlock risk.
538	* @thread Any.
539	*/
540	VMMR3DECL(int) PGMR3PhysGCPhys2CCPtrReadOnlyExternal(PVM pVM, RTGCPHYS GCPhys, void const **ppv, PPGMPAGEMAPLOCK pLock)
541	{
542	int rc = pgmLock(pVM);
543	AssertRCReturn(rc, rc);
544
545	/*
546	* Query the Physical TLB entry for the page (may fail).
547	*/
548	PPGMPAGEMAPTLBE pTlbe;
549	rc = pgmPhysPageQueryTlbe(pVM, GCPhys, &pTlbe);
550	if (RT_SUCCESS(rc))
551	{
552	PPGMPAGE pPage = pTlbe->pPage;
553	#if 1
554	/* MMIO pages doesn't have any readable backing. */
555	if (PGM_PAGE_IS_MMIO_OR_SPECIAL_ALIAS(pPage))
556	rc = VERR_PGM_PHYS_PAGE_RESERVED;
557	#else
558	if (PGM_PAGE_HAS_ACTIVE_ALL_HANDLERS(pPage))
559	rc = VERR_PGM_PHYS_PAGE_RESERVED;
560	#endif
561	else
562	{
563	/*
564	* Now, just perform the locking and calculate the return address.
565	*/
566	PPGMPAGEMAP pMap = pTlbe->pMap;
567	if (pMap)
568	pMap->cRefs++;
569
570	unsigned cLocks = PGM_PAGE_GET_READ_LOCKS(pPage);
571	if (RT_LIKELY(cLocks < PGM_PAGE_MAX_LOCKS - 1))
572	{
573	if (cLocks == 0)
574	pVM->pgm.s.cReadLockedPages++;
575	PGM_PAGE_INC_READ_LOCKS(pPage);
576	}
577	else if (cLocks != PGM_PAGE_GET_READ_LOCKS(pPage))
578	{
579	PGM_PAGE_INC_READ_LOCKS(pPage);
580	AssertMsgFailed(("%RGp / %R[pgmpage] is entering permanent readonly locked state!\n", GCPhys, pPage));
581	if (pMap)
582	pMap->cRefs++; /* Extra ref to prevent it from going away. */
583	}
584
585	ppv = (void )((uintptr_t)pTlbe->pv \| (uintptr_t)(GCPhys & PAGE_OFFSET_MASK));
586	pLock->uPageAndType = (uintptr_t)pPage \| PGMPAGEMAPLOCK_TYPE_READ;
587	pLock->pvMap = pMap;
588	}
589	}
590
591	pgmUnlock(pVM);
592	return rc;
593	}
594
595
596	#define MAKE_LEAF(a_pNode) \
597	do { \
598	(a_pNode)->pLeftR3 = NIL_RTR3PTR; \
599	(a_pNode)->pRightR3 = NIL_RTR3PTR; \
600	(a_pNode)->pLeftR0 = NIL_RTR0PTR; \
601	(a_pNode)->pRightR0 = NIL_RTR0PTR; \
602	(a_pNode)->pLeftRC = NIL_RTRCPTR; \
603	(a_pNode)->pRightRC = NIL_RTRCPTR; \
604	} while (0)
605
606	#define INSERT_LEFT(a_pParent, a_pNode) \
607	do { \
608	(a_pParent)->pLeftR3 = (a_pNode); \
609	(a_pParent)->pLeftR0 = (a_pNode)->pSelfR0; \
610	(a_pParent)->pLeftRC = (a_pNode)->pSelfRC; \
611	} while (0)
612	#define INSERT_RIGHT(a_pParent, a_pNode) \
613	do { \
614	(a_pParent)->pRightR3 = (a_pNode); \
615	(a_pParent)->pRightR0 = (a_pNode)->pSelfR0; \
616	(a_pParent)->pRightRC = (a_pNode)->pSelfRC; \
617	} while (0)
618
619
620	/**
621	* Recursive tree builder.
622	*
623	* @param ppRam Pointer to the iterator variable.
624	* @param iDepth The current depth. Inserts a leaf node if 0.
625	*/
626	static PPGMRAMRANGE pgmR3PhysRebuildRamRangeSearchTreesRecursively(PPGMRAMRANGE *ppRam, int iDepth)
627	{
628	PPGMRAMRANGE pRam;
629	if (iDepth <= 0)
630	{
631	/*
632	* Leaf node.
633	*/
634	pRam = *ppRam;
635	if (pRam)
636	{
637	*ppRam = pRam->pNextR3;
638	MAKE_LEAF(pRam);
639	}
640	}
641	else
642	{
643
644	/*
645	* Intermediate node.
646	*/
647	PPGMRAMRANGE pLeft = pgmR3PhysRebuildRamRangeSearchTreesRecursively(ppRam, iDepth - 1);
648
649	pRam = *ppRam;
650	if (!pRam)
651	return pLeft;
652	*ppRam = pRam->pNextR3;
653	MAKE_LEAF(pRam);
654	INSERT_LEFT(pRam, pLeft);
655
656	PPGMRAMRANGE pRight = pgmR3PhysRebuildRamRangeSearchTreesRecursively(ppRam, iDepth - 1);
657	if (pRight)
658	INSERT_RIGHT(pRam, pRight);
659	}
660	return pRam;
661	}
662
663
664	/**
665	* Rebuilds the RAM range search trees.
666	*
667	* @param pVM The cross context VM structure.
668	*/
669	static void pgmR3PhysRebuildRamRangeSearchTrees(PVM pVM)
670	{
671
672	/*
673	* Create the reasonably balanced tree in a sequential fashion.
674	* For simplicity (laziness) we use standard recursion here.
675	*/
676	int iDepth = 0;
677	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
678	PPGMRAMRANGE pRoot = pgmR3PhysRebuildRamRangeSearchTreesRecursively(&pRam, 0);
679	while (pRam)
680	{
681	PPGMRAMRANGE pLeft = pRoot;
682
683	pRoot = pRam;
684	pRam = pRam->pNextR3;
685	MAKE_LEAF(pRoot);
686	INSERT_LEFT(pRoot, pLeft);
687
688	PPGMRAMRANGE pRight = pgmR3PhysRebuildRamRangeSearchTreesRecursively(&pRam, iDepth);
689	if (pRight)
690	INSERT_RIGHT(pRoot, pRight);
691	/** @todo else: rotate the tree. */
692
693	iDepth++;
694	}
695
696	pVM->pgm.s.pRamRangeTreeR3 = pRoot;
697	pVM->pgm.s.pRamRangeTreeR0 = pRoot ? pRoot->pSelfR0 : NIL_RTR0PTR;
698	pVM->pgm.s.pRamRangeTreeRC = pRoot ? pRoot->pSelfRC : NIL_RTRCPTR;
699
700	#ifdef VBOX_STRICT
701	/*
702	* Verify that the above code works.
703	*/
704	unsigned cRanges = 0;
705	for (pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
706	cRanges++;
707	Assert(cRanges > 0);
708
709	unsigned cMaxDepth = ASMBitLastSetU32(cRanges);
710	if ((1U << cMaxDepth) < cRanges)
711	cMaxDepth++;
712
713	for (pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
714	{
715	unsigned cDepth = 0;
716	PPGMRAMRANGE pRam2 = pVM->pgm.s.pRamRangeTreeR3;
717	for (;;)
718	{
719	if (pRam == pRam2)
720	break;
721	Assert(pRam2);
722	if (pRam->GCPhys < pRam2->GCPhys)
723	pRam2 = pRam2->pLeftR3;
724	else
725	pRam2 = pRam2->pRightR3;
726	}
727	AssertMsg(cDepth <= cMaxDepth, ("cDepth=%d cMaxDepth=%d\n", cDepth, cMaxDepth));
728	}
729	#endif /* VBOX_STRICT */
730	}
731
732	#undef MAKE_LEAF
733	#undef INSERT_LEFT
734	#undef INSERT_RIGHT
735
736	/**
737	* Relinks the RAM ranges using the pSelfRC and pSelfR0 pointers.
738	*
739	* Called when anything was relocated.
740	*
741	* @param pVM The cross context VM structure.
742	*/
743	void pgmR3PhysRelinkRamRanges(PVM pVM)
744	{
745	PPGMRAMRANGE pCur;
746
747	#ifdef VBOX_STRICT
748	for (pCur = pVM->pgm.s.pRamRangesXR3; pCur; pCur = pCur->pNextR3)
749	{
750	Assert((pCur->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pCur->pSelfR0 == MMHyperCCToR0(pVM, pCur));
751	Assert((pCur->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pCur->pSelfRC == MMHyperCCToRC(pVM, pCur));
752	Assert((pCur->GCPhys & PAGE_OFFSET_MASK) == 0);
753	Assert((pCur->GCPhysLast & PAGE_OFFSET_MASK) == PAGE_OFFSET_MASK);
754	Assert((pCur->cb & PAGE_OFFSET_MASK) == 0);
755	Assert(pCur->cb == pCur->GCPhysLast - pCur->GCPhys + 1);
756	for (PPGMRAMRANGE pCur2 = pVM->pgm.s.pRamRangesXR3; pCur2; pCur2 = pCur2->pNextR3)
757	Assert( pCur2 == pCur
758	\|\| strcmp(pCur2->pszDesc, pCur->pszDesc)); /** @todo fix MMIO ranges!! */
759	}
760	#endif
761
762	pCur = pVM->pgm.s.pRamRangesXR3;
763	if (pCur)
764	{
765	pVM->pgm.s.pRamRangesXR0 = pCur->pSelfR0;
766	pVM->pgm.s.pRamRangesXRC = pCur->pSelfRC;
767
768	for (; pCur->pNextR3; pCur = pCur->pNextR3)
769	{
770	pCur->pNextR0 = pCur->pNextR3->pSelfR0;
771	pCur->pNextRC = pCur->pNextR3->pSelfRC;
772	}
773
774	Assert(pCur->pNextR0 == NIL_RTR0PTR);
775	Assert(pCur->pNextRC == NIL_RTRCPTR);
776	}
777	else
778	{
779	Assert(pVM->pgm.s.pRamRangesXR0 == NIL_RTR0PTR);
780	Assert(pVM->pgm.s.pRamRangesXRC == NIL_RTRCPTR);
781	}
782	ASMAtomicIncU32(&pVM->pgm.s.idRamRangesGen);
783
784	pgmR3PhysRebuildRamRangeSearchTrees(pVM);
785	}
786
787
788	/**
789	* Links a new RAM range into the list.
790	*
791	* @param pVM The cross context VM structure.
792	* @param pNew Pointer to the new list entry.
793	* @param pPrev Pointer to the previous list entry. If NULL, insert as head.
794	*/
795	static void pgmR3PhysLinkRamRange(PVM pVM, PPGMRAMRANGE pNew, PPGMRAMRANGE pPrev)
796	{
797	AssertMsg(pNew->pszDesc, ("%RGp-%RGp\n", pNew->GCPhys, pNew->GCPhysLast));
798	Assert((pNew->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pNew->pSelfR0 == MMHyperCCToR0(pVM, pNew));
799	Assert((pNew->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pNew->pSelfRC == MMHyperCCToRC(pVM, pNew));
800
801	pgmLock(pVM);
802
803	PPGMRAMRANGE pRam = pPrev ? pPrev->pNextR3 : pVM->pgm.s.pRamRangesXR3;
804	pNew->pNextR3 = pRam;
805	pNew->pNextR0 = pRam ? pRam->pSelfR0 : NIL_RTR0PTR;
806	pNew->pNextRC = pRam ? pRam->pSelfRC : NIL_RTRCPTR;
807
808	if (pPrev)
809	{
810	pPrev->pNextR3 = pNew;
811	pPrev->pNextR0 = pNew->pSelfR0;
812	pPrev->pNextRC = pNew->pSelfRC;
813	}
814	else
815	{
816	pVM->pgm.s.pRamRangesXR3 = pNew;
817	pVM->pgm.s.pRamRangesXR0 = pNew->pSelfR0;
818	pVM->pgm.s.pRamRangesXRC = pNew->pSelfRC;
819	}
820	ASMAtomicIncU32(&pVM->pgm.s.idRamRangesGen);
821
822	pgmR3PhysRebuildRamRangeSearchTrees(pVM);
823	pgmUnlock(pVM);
824	}
825
826
827	/**
828	* Unlink an existing RAM range from the list.
829	*
830	* @param pVM The cross context VM structure.
831	* @param pRam Pointer to the new list entry.
832	* @param pPrev Pointer to the previous list entry. If NULL, insert as head.
833	*/
834	static void pgmR3PhysUnlinkRamRange2(PVM pVM, PPGMRAMRANGE pRam, PPGMRAMRANGE pPrev)
835	{
836	Assert(pPrev ? pPrev->pNextR3 == pRam : pVM->pgm.s.pRamRangesXR3 == pRam);
837	Assert((pRam->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pRam->pSelfR0 == MMHyperCCToR0(pVM, pRam));
838	Assert((pRam->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING) \|\| pRam->pSelfRC == MMHyperCCToRC(pVM, pRam));
839
840	pgmLock(pVM);
841
842	PPGMRAMRANGE pNext = pRam->pNextR3;
843	if (pPrev)
844	{
845	pPrev->pNextR3 = pNext;
846	pPrev->pNextR0 = pNext ? pNext->pSelfR0 : NIL_RTR0PTR;
847	pPrev->pNextRC = pNext ? pNext->pSelfRC : NIL_RTRCPTR;
848	}
849	else
850	{
851	Assert(pVM->pgm.s.pRamRangesXR3 == pRam);
852	pVM->pgm.s.pRamRangesXR3 = pNext;
853	pVM->pgm.s.pRamRangesXR0 = pNext ? pNext->pSelfR0 : NIL_RTR0PTR;
854	pVM->pgm.s.pRamRangesXRC = pNext ? pNext->pSelfRC : NIL_RTRCPTR;
855	}
856	ASMAtomicIncU32(&pVM->pgm.s.idRamRangesGen);
857
858	pgmR3PhysRebuildRamRangeSearchTrees(pVM);
859	pgmUnlock(pVM);
860	}
861
862
863	/**
864	* Unlink an existing RAM range from the list.
865	*
866	* @param pVM The cross context VM structure.
867	* @param pRam Pointer to the new list entry.
868	*/
869	static void pgmR3PhysUnlinkRamRange(PVM pVM, PPGMRAMRANGE pRam)
870	{
871	pgmLock(pVM);
872
873	/* find prev. */
874	PPGMRAMRANGE pPrev = NULL;
875	PPGMRAMRANGE pCur = pVM->pgm.s.pRamRangesXR3;
876	while (pCur != pRam)
877	{
878	pPrev = pCur;
879	pCur = pCur->pNextR3;
880	}
881	AssertFatal(pCur);
882
883	pgmR3PhysUnlinkRamRange2(pVM, pRam, pPrev);
884	pgmUnlock(pVM);
885	}
886
887
888	/**
889	* Frees a range of pages, replacing them with ZERO pages of the specified type.
890	*
891	* @returns VBox status code.
892	* @param pVM The cross context VM structure.
893	* @param pRam The RAM range in which the pages resides.
894	* @param GCPhys The address of the first page.
895	* @param GCPhysLast The address of the last page.
896	* @param uType The page type to replace then with.
897	*/
898	static int pgmR3PhysFreePageRange(PVM pVM, PPGMRAMRANGE pRam, RTGCPHYS GCPhys, RTGCPHYS GCPhysLast, uint8_t uType)
899	{
900	PGM_LOCK_ASSERT_OWNER(pVM);
901	uint32_t cPendingPages = 0;
902	PGMMFREEPAGESREQ pReq;
903	int rc = GMMR3FreePagesPrepare(pVM, &pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
904	AssertLogRelRCReturn(rc, rc);
905
906	/* Iterate the pages. */
907	PPGMPAGE pPageDst = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
908	uint32_t cPagesLeft = ((GCPhysLast - GCPhys) >> PAGE_SHIFT) + 1;
909	while (cPagesLeft-- > 0)
910	{
911	rc = pgmPhysFreePage(pVM, pReq, &cPendingPages, pPageDst, GCPhys);
912	AssertLogRelRCReturn(rc, rc); /* We're done for if this goes wrong. */
913
914	PGM_PAGE_SET_TYPE(pVM, pPageDst, uType);
915
916	GCPhys += PAGE_SIZE;
917	pPageDst++;
918	}
919
920	if (cPendingPages)
921	{
922	rc = GMMR3FreePagesPerform(pVM, pReq, cPendingPages);
923	AssertLogRelRCReturn(rc, rc);
924	}
925	GMMR3FreePagesCleanup(pReq);
926
927	return rc;
928	}
929
930	#if HC_ARCH_BITS == 64 && (defined(RT_OS_WINDOWS) \|\| defined(RT_OS_SOLARIS) \|\| defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD))
931
932	/**
933	* Rendezvous callback used by PGMR3ChangeMemBalloon that changes the memory balloon size
934	*
935	* This is only called on one of the EMTs while the other ones are waiting for
936	* it to complete this function.
937	*
938	* @returns VINF_SUCCESS (VBox strict status code).
939	* @param pVM The cross context VM structure.
940	* @param pVCpu The cross context virtual CPU structure of the calling EMT. Unused.
941	* @param pvUser User parameter
942	*/
943	static DECLCALLBACK(VBOXSTRICTRC) pgmR3PhysChangeMemBalloonRendezvous(PVM pVM, PVMCPU pVCpu, void *pvUser)
944	{
945	uintptr_t paUser = (uintptr_t )pvUser;
946	bool fInflate = !!paUser[0];
947	unsigned cPages = paUser[1];
948	RTGCPHYS paPhysPage = (RTGCPHYS )paUser[2];
949	uint32_t cPendingPages = 0;
950	PGMMFREEPAGESREQ pReq;
951	int rc;
952
953	Log(("pgmR3PhysChangeMemBalloonRendezvous: %s %x pages\n", (fInflate) ? "inflate" : "deflate", cPages));
954	pgmLock(pVM);
955
956	if (fInflate)
957	{
958	/* Flush the PGM pool cache as we might have stale references to pages that we just freed. */
959	pgmR3PoolClearAllRendezvous(pVM, pVCpu, NULL);
960
961	/* Replace pages with ZERO pages. */
962	rc = GMMR3FreePagesPrepare(pVM, &pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
963	if (RT_FAILURE(rc))
964	{
965	pgmUnlock(pVM);
966	AssertLogRelRC(rc);
967	return rc;
968	}
969
970	/* Iterate the pages. */
971	for (unsigned i = 0; i < cPages; i++)
972	{
973	PPGMPAGE pPage = pgmPhysGetPage(pVM, paPhysPage[i]);
974	if ( pPage == NULL
975	\|\| PGM_PAGE_GET_TYPE(pPage) != PGMPAGETYPE_RAM)
976	{
977	Log(("pgmR3PhysChangeMemBalloonRendezvous: invalid physical page %RGp pPage->u3Type=%d\n", paPhysPage[i], pPage ? PGM_PAGE_GET_TYPE(pPage) : 0));
978	break;
979	}
980
981	LogFlow(("balloon page: %RGp\n", paPhysPage[i]));
982
983	/* Flush the shadow PT if this page was previously used as a guest page table. */
984	pgmPoolFlushPageByGCPhys(pVM, paPhysPage[i]);
985
986	rc = pgmPhysFreePage(pVM, pReq, &cPendingPages, pPage, paPhysPage[i]);
987	if (RT_FAILURE(rc))
988	{
989	pgmUnlock(pVM);
990	AssertLogRelRC(rc);
991	return rc;
992	}
993	Assert(PGM_PAGE_IS_ZERO(pPage));
994	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_BALLOONED);
995	}
996
997	if (cPendingPages)
998	{
999	rc = GMMR3FreePagesPerform(pVM, pReq, cPendingPages);
1000	if (RT_FAILURE(rc))
1001	{
1002	pgmUnlock(pVM);
1003	AssertLogRelRC(rc);
1004	return rc;
1005	}
1006	}
1007	GMMR3FreePagesCleanup(pReq);
1008	}
1009	else
1010	{
1011	/* Iterate the pages. */
1012	for (unsigned i = 0; i < cPages; i++)
1013	{
1014	PPGMPAGE pPage = pgmPhysGetPage(pVM, paPhysPage[i]);
1015	AssertBreak(pPage && PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_RAM);
1016
1017	LogFlow(("Free ballooned page: %RGp\n", paPhysPage[i]));
1018
1019	Assert(PGM_PAGE_IS_BALLOONED(pPage));
1020
1021	/* Change back to zero page. */
1022	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ZERO);
1023	}
1024
1025	/* Note that we currently do not map any ballooned pages in our shadow page tables, so no need to flush the pgm pool. */
1026	}
1027
1028	/* Notify GMM about the balloon change. */
1029	rc = GMMR3BalloonedPages(pVM, (fInflate) ? GMMBALLOONACTION_INFLATE : GMMBALLOONACTION_DEFLATE, cPages);
1030	if (RT_SUCCESS(rc))
1031	{
1032	if (!fInflate)
1033	{
1034	Assert(pVM->pgm.s.cBalloonedPages >= cPages);
1035	pVM->pgm.s.cBalloonedPages -= cPages;
1036	}
1037	else
1038	pVM->pgm.s.cBalloonedPages += cPages;
1039	}
1040
1041	pgmUnlock(pVM);
1042
1043	/* Flush the recompiler's TLB as well. */
1044	for (VMCPUID i = 0; i < pVM->cCpus; i++)
1045	CPUMSetChangedFlags(&pVM->aCpus[i], CPUM_CHANGED_GLOBAL_TLB_FLUSH);
1046
1047	AssertLogRelRC(rc);
1048	return rc;
1049	}
1050
1051
1052	/**
1053	* Frees a range of ram pages, replacing them with ZERO pages; helper for PGMR3PhysFreeRamPages
1054	*
1055	* @returns VBox status code.
1056	* @param pVM The cross context VM structure.
1057	* @param fInflate Inflate or deflate memory balloon
1058	* @param cPages Number of pages to free
1059	* @param paPhysPage Array of guest physical addresses
1060	*/
1061	static DECLCALLBACK(void) pgmR3PhysChangeMemBalloonHelper(PVM pVM, bool fInflate, unsigned cPages, RTGCPHYS *paPhysPage)
1062	{
1063	uintptr_t paUser[3];
1064
1065	paUser[0] = fInflate;
1066	paUser[1] = cPages;
1067	paUser[2] = (uintptr_t)paPhysPage;
1068	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, pgmR3PhysChangeMemBalloonRendezvous, (void *)paUser);
1069	AssertRC(rc);
1070
1071	/* Made a copy in PGMR3PhysFreeRamPages; free it here. */
1072	RTMemFree(paPhysPage);
1073	}
1074
1075	#endif /* 64-bit host && (Windows \|\| Solaris \|\| Linux \|\| FreeBSD) */
1076
1077	/**
1078	* Inflate or deflate a memory balloon
1079	*
1080	* @returns VBox status code.
1081	* @param pVM The cross context VM structure.
1082	* @param fInflate Inflate or deflate memory balloon
1083	* @param cPages Number of pages to free
1084	* @param paPhysPage Array of guest physical addresses
1085	*/
1086	VMMR3DECL(int) PGMR3PhysChangeMemBalloon(PVM pVM, bool fInflate, unsigned cPages, RTGCPHYS *paPhysPage)
1087	{
1088	/* This must match GMMR0Init; currently we only support memory ballooning on all 64-bit hosts except Mac OS X */
1089	#if HC_ARCH_BITS == 64 && (defined(RT_OS_WINDOWS) \|\| defined(RT_OS_SOLARIS) \|\| defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD))
1090	int rc;
1091
1092	/* Older additions (ancient non-functioning balloon code) pass wrong physical addresses. */
1093	AssertReturn(!(paPhysPage[0] & 0xfff), VERR_INVALID_PARAMETER);
1094
1095	/* We own the IOM lock here and could cause a deadlock by waiting for another VCPU that is blocking on the IOM lock.
1096	* In the SMP case we post a request packet to postpone the job.
1097	*/
1098	if (pVM->cCpus > 1)
1099	{
1100	unsigned cbPhysPage = cPages * sizeof(paPhysPage[0]);
1101	RTGCPHYS paPhysPageCopy = (RTGCPHYS )RTMemAlloc(cbPhysPage);
1102	AssertReturn(paPhysPageCopy, VERR_NO_MEMORY);
1103
1104	memcpy(paPhysPageCopy, paPhysPage, cbPhysPage);
1105
1106	rc = VMR3ReqCallNoWait(pVM, VMCPUID_ANY_QUEUE, (PFNRT)pgmR3PhysChangeMemBalloonHelper, 4, pVM, fInflate, cPages, paPhysPageCopy);
1107	AssertRC(rc);
1108	}
1109	else
1110	{
1111	uintptr_t paUser[3];
1112
1113	paUser[0] = fInflate;
1114	paUser[1] = cPages;
1115	paUser[2] = (uintptr_t)paPhysPage;
1116	rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, pgmR3PhysChangeMemBalloonRendezvous, (void *)paUser);
1117	AssertRC(rc);
1118	}
1119	return rc;
1120
1121	#else
1122	NOREF(pVM); NOREF(fInflate); NOREF(cPages); NOREF(paPhysPage);
1123	return VERR_NOT_IMPLEMENTED;
1124	#endif
1125	}
1126
1127
1128	/**
1129	* Rendezvous callback used by PGMR3WriteProtectRAM that write protects all
1130	* physical RAM.
1131	*
1132	* This is only called on one of the EMTs while the other ones are waiting for
1133	* it to complete this function.
1134	*
1135	* @returns VINF_SUCCESS (VBox strict status code).
1136	* @param pVM The cross context VM structure.
1137	* @param pVCpu The cross context virtual CPU structure of the calling EMT. Unused.
1138	* @param pvUser User parameter, unused.
1139	*/
1140	static DECLCALLBACK(VBOXSTRICTRC) pgmR3PhysWriteProtectRAMRendezvous(PVM pVM, PVMCPU pVCpu, void *pvUser)
1141	{
1142	int rc = VINF_SUCCESS;
1143	NOREF(pvUser); NOREF(pVCpu);
1144
1145	pgmLock(pVM);
1146	#ifdef PGMPOOL_WITH_OPTIMIZED_DIRTY_PT
1147	pgmPoolResetDirtyPages(pVM);
1148	#endif
1149
1150	/** @todo pointless to write protect the physical page pointed to by RSP. */
1151
1152	for (PPGMRAMRANGE pRam = pVM->pgm.s.CTX_SUFF(pRamRangesX);
1153	pRam;
1154	pRam = pRam->CTX_SUFF(pNext))
1155	{
1156	uint32_t cPages = pRam->cb >> PAGE_SHIFT;
1157	for (uint32_t iPage = 0; iPage < cPages; iPage++)
1158	{
1159	PPGMPAGE pPage = &pRam->aPages[iPage];
1160	PGMPAGETYPE enmPageType = (PGMPAGETYPE)PGM_PAGE_GET_TYPE(pPage);
1161
1162	if ( RT_LIKELY(enmPageType == PGMPAGETYPE_RAM)
1163	\|\| enmPageType == PGMPAGETYPE_MMIO2)
1164	{
1165	/*
1166	* A RAM page.
1167	*/
1168	switch (PGM_PAGE_GET_STATE(pPage))
1169	{
1170	case PGM_PAGE_STATE_ALLOCATED:
1171	/** @todo Optimize this: Don't always re-enable write
1172	* monitoring if the page is known to be very busy. */
1173	if (PGM_PAGE_IS_WRITTEN_TO(pPage))
1174	{
1175	PGM_PAGE_CLEAR_WRITTEN_TO(pVM, pPage);
1176	/* Remember this dirty page for the next (memory) sync. */
1177	PGM_PAGE_SET_FT_DIRTY(pPage);
1178	}
1179
1180	pgmPhysPageWriteMonitor(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT));
1181	break;
1182
1183	case PGM_PAGE_STATE_SHARED:
1184	AssertFailed();
1185	break;
1186
1187	case PGM_PAGE_STATE_WRITE_MONITORED: /* nothing to change. */
1188	default:
1189	break;
1190	}
1191	}
1192	}
1193	}
1194	pgmR3PoolWriteProtectPages(pVM);
1195	PGM_INVL_ALL_VCPU_TLBS(pVM);
1196	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1197	CPUMSetChangedFlags(&pVM->aCpus[idCpu], CPUM_CHANGED_GLOBAL_TLB_FLUSH);
1198
1199	pgmUnlock(pVM);
1200	return rc;
1201	}
1202
1203	/**
1204	* Protect all physical RAM to monitor writes
1205	*
1206	* @returns VBox status code.
1207	* @param pVM The cross context VM structure.
1208	*/
1209	VMMR3DECL(int) PGMR3PhysWriteProtectRAM(PVM pVM)
1210	{
1211	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
1212
1213	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, pgmR3PhysWriteProtectRAMRendezvous, NULL);
1214	AssertRC(rc);
1215	return rc;
1216	}
1217
1218	/**
1219	* Enumerate all dirty FT pages.
1220	*
1221	* @returns VBox status code.
1222	* @param pVM The cross context VM structure.
1223	* @param pfnEnum Enumerate callback handler.
1224	* @param pvUser Enumerate callback handler parameter.
1225	*/
1226	VMMR3DECL(int) PGMR3PhysEnumDirtyFTPages(PVM pVM, PFNPGMENUMDIRTYFTPAGES pfnEnum, void *pvUser)
1227	{
1228	int rc = VINF_SUCCESS;
1229
1230	pgmLock(pVM);
1231	for (PPGMRAMRANGE pRam = pVM->pgm.s.CTX_SUFF(pRamRangesX);
1232	pRam;
1233	pRam = pRam->CTX_SUFF(pNext))
1234	{
1235	uint32_t cPages = pRam->cb >> PAGE_SHIFT;
1236	for (uint32_t iPage = 0; iPage < cPages; iPage++)
1237	{
1238	PPGMPAGE pPage = &pRam->aPages[iPage];
1239	PGMPAGETYPE enmPageType = (PGMPAGETYPE)PGM_PAGE_GET_TYPE(pPage);
1240
1241	if ( RT_LIKELY(enmPageType == PGMPAGETYPE_RAM)
1242	\|\| enmPageType == PGMPAGETYPE_MMIO2)
1243	{
1244	/*
1245	* A RAM page.
1246	*/
1247	switch (PGM_PAGE_GET_STATE(pPage))
1248	{
1249	case PGM_PAGE_STATE_ALLOCATED:
1250	case PGM_PAGE_STATE_WRITE_MONITORED:
1251	if ( !PGM_PAGE_IS_WRITTEN_TO(pPage) /* not very recently updated? */
1252	&& PGM_PAGE_IS_FT_DIRTY(pPage))
1253	{
1254	uint32_t cbPageRange = PAGE_SIZE;
1255	uint32_t iPageClean = iPage + 1;
1256	RTGCPHYS GCPhysPage = pRam->GCPhys + iPage * PAGE_SIZE;
1257	uint8_t *pu8Page = NULL;
1258	PGMPAGEMAPLOCK Lock;
1259
1260	/* Find the next clean page, so we can merge adjacent dirty pages. */
1261	for (; iPageClean < cPages; iPageClean++)
1262	{
1263	PPGMPAGE pPageNext = &pRam->aPages[iPageClean];
1264	if ( RT_UNLIKELY(PGM_PAGE_GET_TYPE(pPageNext) != PGMPAGETYPE_RAM)
1265	\|\| PGM_PAGE_GET_STATE(pPageNext) != PGM_PAGE_STATE_ALLOCATED
1266	\|\| PGM_PAGE_IS_WRITTEN_TO(pPageNext)
1267	\|\| !PGM_PAGE_IS_FT_DIRTY(pPageNext)
1268	/* Crossing a chunk boundary? */
1269	\|\| (GCPhysPage & GMM_PAGEID_IDX_MASK) != ((GCPhysPage + cbPageRange) & GMM_PAGEID_IDX_MASK)
1270	)
1271	break;
1272
1273	cbPageRange += PAGE_SIZE;
1274	}
1275
1276	rc = PGMPhysGCPhys2CCPtrReadOnly(pVM, GCPhysPage, (const void **)&pu8Page, &Lock);
1277	if (RT_SUCCESS(rc))
1278	{
1279	/** @todo this is risky; the range might be changed, but little choice as the sync
1280	* costs a lot of time. */
1281	pgmUnlock(pVM);
1282	pfnEnum(pVM, GCPhysPage, pu8Page, cbPageRange, pvUser);
1283	pgmLock(pVM);
1284	PGMPhysReleasePageMappingLock(pVM, &Lock);
1285	}
1286
1287	for (uint32_t iTmp = iPage; iTmp < iPageClean; iTmp++)
1288	PGM_PAGE_CLEAR_FT_DIRTY(&pRam->aPages[iTmp]);
1289	}
1290	break;
1291	}
1292	}
1293	}
1294	}
1295	pgmUnlock(pVM);
1296	return rc;
1297	}
1298
1299
1300	/**
1301	* Gets the number of ram ranges.
1302	*
1303	* @returns Number of ram ranges. Returns UINT32_MAX if @a pVM is invalid.
1304	* @param pVM The cross context VM structure.
1305	*/
1306	VMMR3DECL(uint32_t) PGMR3PhysGetRamRangeCount(PVM pVM)
1307	{
1308	VM_ASSERT_VALID_EXT_RETURN(pVM, UINT32_MAX);
1309
1310	pgmLock(pVM);
1311	uint32_t cRamRanges = 0;
1312	for (PPGMRAMRANGE pCur = pVM->pgm.s.CTX_SUFF(pRamRangesX); pCur; pCur = pCur->CTX_SUFF(pNext))
1313	cRamRanges++;
1314	pgmUnlock(pVM);
1315	return cRamRanges;
1316	}
1317
1318
1319	/**
1320	* Get information about a range.
1321	*
1322	* @returns VINF_SUCCESS or VERR_OUT_OF_RANGE.
1323	* @param pVM The cross context VM structure.
1324	* @param iRange The ordinal of the range.
1325	* @param pGCPhysStart Where to return the start of the range. Optional.
1326	* @param pGCPhysLast Where to return the address of the last byte in the
1327	* range. Optional.
1328	* @param ppszDesc Where to return the range description. Optional.
1329	* @param pfIsMmio Where to indicate that this is a pure MMIO range.
1330	* Optional.
1331	*/
1332	VMMR3DECL(int) PGMR3PhysGetRange(PVM pVM, uint32_t iRange, PRTGCPHYS pGCPhysStart, PRTGCPHYS pGCPhysLast,
1333	const char *ppszDesc, bool pfIsMmio)
1334	{
1335	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1336
1337	pgmLock(pVM);
1338	uint32_t iCurRange = 0;
1339	for (PPGMRAMRANGE pCur = pVM->pgm.s.CTX_SUFF(pRamRangesX); pCur; pCur = pCur->CTX_SUFF(pNext), iCurRange++)
1340	if (iCurRange == iRange)
1341	{
1342	if (pGCPhysStart)
1343	*pGCPhysStart = pCur->GCPhys;
1344	if (pGCPhysLast)
1345	*pGCPhysLast = pCur->GCPhysLast;
1346	if (ppszDesc)
1347	*ppszDesc = pCur->pszDesc;
1348	if (pfIsMmio)
1349	*pfIsMmio = !!(pCur->fFlags & PGM_RAM_RANGE_FLAGS_AD_HOC_MMIO);
1350
1351	pgmUnlock(pVM);
1352	return VINF_SUCCESS;
1353	}
1354	pgmUnlock(pVM);
1355	return VERR_OUT_OF_RANGE;
1356	}
1357
1358
1359	/**
1360	* Query the amount of free memory inside VMMR0
1361	*
1362	* @returns VBox status code.
1363	* @param pUVM The user mode VM handle.
1364	* @param pcbAllocMem Where to return the amount of memory allocated
1365	* by VMs.
1366	* @param pcbFreeMem Where to return the amount of memory that is
1367	* allocated from the host but not currently used
1368	* by any VMs.
1369	* @param pcbBallonedMem Where to return the sum of memory that is
1370	* currently ballooned by the VMs.
1371	* @param pcbSharedMem Where to return the amount of memory that is
1372	* currently shared.
1373	*/
1374	VMMR3DECL(int) PGMR3QueryGlobalMemoryStats(PUVM pUVM, uint64_t pcbAllocMem, uint64_t pcbFreeMem,
1375	uint64_t pcbBallonedMem, uint64_t pcbSharedMem)
1376	{
1377	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1378	VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
1379
1380	uint64_t cAllocPages = 0;
1381	uint64_t cFreePages = 0;
1382	uint64_t cBalloonPages = 0;
1383	uint64_t cSharedPages = 0;
1384	int rc = GMMR3QueryHypervisorMemoryStats(pUVM->pVM, &cAllocPages, &cFreePages, &cBalloonPages, &cSharedPages);
1385	AssertRCReturn(rc, rc);
1386
1387	if (pcbAllocMem)
1388	pcbAllocMem = cAllocPages _4K;
1389
1390	if (pcbFreeMem)
1391	pcbFreeMem = cFreePages _4K;
1392
1393	if (pcbBallonedMem)
1394	pcbBallonedMem = cBalloonPages _4K;
1395
1396	if (pcbSharedMem)
1397	pcbSharedMem = cSharedPages _4K;
1398
1399	Log(("PGMR3QueryVMMMemoryStats: all=%llx free=%llx ballooned=%llx shared=%llx\n",
1400	cAllocPages, cFreePages, cBalloonPages, cSharedPages));
1401	return VINF_SUCCESS;
1402	}
1403
1404
1405	/**
1406	* Query memory stats for the VM.
1407	*
1408	* @returns VBox status code.
1409	* @param pUVM The user mode VM handle.
1410	* @param pcbTotalMem Where to return total amount memory the VM may
1411	* possibly use.
1412	* @param pcbPrivateMem Where to return the amount of private memory
1413	* currently allocated.
1414	* @param pcbSharedMem Where to return the amount of actually shared
1415	* memory currently used by the VM.
1416	* @param pcbZeroMem Where to return the amount of memory backed by
1417	* zero pages.
1418	*
1419	* @remarks The total mem is normally larger than the sum of the three
1420	* components. There are two reasons for this, first the amount of
1421	* shared memory is what we're sure is shared instead of what could
1422	* possibly be shared with someone. Secondly, because the total may
1423	* include some pure MMIO pages that doesn't go into any of the three
1424	* sub-counts.
1425	*
1426	* @todo Why do we return reused shared pages instead of anything that could
1427	* potentially be shared? Doesn't this mean the first VM gets a much
1428	* lower number of shared pages?
1429	*/
1430	VMMR3DECL(int) PGMR3QueryMemoryStats(PUVM pUVM, uint64_t pcbTotalMem, uint64_t pcbPrivateMem,
1431	uint64_t pcbSharedMem, uint64_t pcbZeroMem)
1432	{
1433	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1434	PVM pVM = pUVM->pVM;
1435	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1436
1437	if (pcbTotalMem)
1438	pcbTotalMem = (uint64_t)pVM->pgm.s.cAllPages PAGE_SIZE;
1439
1440	if (pcbPrivateMem)
1441	pcbPrivateMem = (uint64_t)pVM->pgm.s.cPrivatePages PAGE_SIZE;
1442
1443	if (pcbSharedMem)
1444	pcbSharedMem = (uint64_t)pVM->pgm.s.cReusedSharedPages PAGE_SIZE;
1445
1446	if (pcbZeroMem)
1447	pcbZeroMem = (uint64_t)pVM->pgm.s.cZeroPages PAGE_SIZE;
1448
1449	Log(("PGMR3QueryMemoryStats: all=%x private=%x reused=%x zero=%x\n", pVM->pgm.s.cAllPages, pVM->pgm.s.cPrivatePages, pVM->pgm.s.cReusedSharedPages, pVM->pgm.s.cZeroPages));
1450	return VINF_SUCCESS;
1451	}
1452
1453
1454	/**
1455	* PGMR3PhysRegisterRam worker that initializes and links a RAM range.
1456	*
1457	* @param pVM The cross context VM structure.
1458	* @param pNew The new RAM range.
1459	* @param GCPhys The address of the RAM range.
1460	* @param GCPhysLast The last address of the RAM range.
1461	* @param RCPtrNew The RC address if the range is floating. NIL_RTRCPTR
1462	* if in HMA.
1463	* @param R0PtrNew Ditto for R0.
1464	* @param pszDesc The description.
1465	* @param pPrev The previous RAM range (for linking).
1466	*/
1467	static void pgmR3PhysInitAndLinkRamRange(PVM pVM, PPGMRAMRANGE pNew, RTGCPHYS GCPhys, RTGCPHYS GCPhysLast,
1468	RTRCPTR RCPtrNew, RTR0PTR R0PtrNew, const char *pszDesc, PPGMRAMRANGE pPrev)
1469	{
1470	/*
1471	* Initialize the range.
1472	*/
1473	pNew->pSelfR0 = R0PtrNew != NIL_RTR0PTR ? R0PtrNew : MMHyperCCToR0(pVM, pNew);
1474	pNew->pSelfRC = RCPtrNew != NIL_RTRCPTR ? RCPtrNew : MMHyperCCToRC(pVM, pNew);
1475	pNew->GCPhys = GCPhys;
1476	pNew->GCPhysLast = GCPhysLast;
1477	pNew->cb = GCPhysLast - GCPhys + 1;
1478	pNew->pszDesc = pszDesc;
1479	pNew->fFlags = RCPtrNew != NIL_RTRCPTR ? PGM_RAM_RANGE_FLAGS_FLOATING : 0;
1480	pNew->pvR3 = NULL;
1481	pNew->paLSPages = NULL;
1482
1483	uint32_t const cPages = pNew->cb >> PAGE_SHIFT;
1484	RTGCPHYS iPage = cPages;
1485	while (iPage-- > 0)
1486	PGM_PAGE_INIT_ZERO(&pNew->aPages[iPage], pVM, PGMPAGETYPE_RAM);
1487
1488	/* Update the page count stats. */
1489	pVM->pgm.s.cZeroPages += cPages;
1490	pVM->pgm.s.cAllPages += cPages;
1491
1492	/*
1493	* Link it.
1494	*/
1495	pgmR3PhysLinkRamRange(pVM, pNew, pPrev);
1496	}
1497
1498
1499	/**
1500	* @callback_method_impl{FNPGMRELOCATE, Relocate a floating RAM range.}
1501	* @sa pgmR3PhysMMIO2ExRangeRelocate
1502	*/
1503	static DECLCALLBACK(bool) pgmR3PhysRamRangeRelocate(PVM pVM, RTGCPTR GCPtrOld, RTGCPTR GCPtrNew,
1504	PGMRELOCATECALL enmMode, void *pvUser)
1505	{
1506	PPGMRAMRANGE pRam = (PPGMRAMRANGE)pvUser;
1507	Assert(pRam->fFlags & PGM_RAM_RANGE_FLAGS_FLOATING);
1508	Assert(pRam->pSelfRC == GCPtrOld + PAGE_SIZE); RT_NOREF_PV(GCPtrOld);
1509
1510	switch (enmMode)
1511	{
1512	case PGMRELOCATECALL_SUGGEST:
1513	return true;
1514
1515	case PGMRELOCATECALL_RELOCATE:
1516	{
1517	/*
1518	* Update myself, then relink all the ranges and flush the RC TLB.
1519	*/
1520	pgmLock(pVM);
1521
1522	pRam->pSelfRC = (RTRCPTR)(GCPtrNew + PAGE_SIZE);
1523
1524	pgmR3PhysRelinkRamRanges(pVM);
1525	for (unsigned i = 0; i < PGM_RAMRANGE_TLB_ENTRIES; i++)
1526	pVM->pgm.s.apRamRangesTlbRC[i] = NIL_RTRCPTR;
1527
1528	pgmUnlock(pVM);
1529	return true;
1530	}
1531
1532	default:
1533	AssertFailedReturn(false);
1534	}
1535	}
1536
1537
1538	/**
1539	* PGMR3PhysRegisterRam worker that registers a high chunk.
1540	*
1541	* @returns VBox status code.
1542	* @param pVM The cross context VM structure.
1543	* @param GCPhys The address of the RAM.
1544	* @param cRamPages The number of RAM pages to register.
1545	* @param cbChunk The size of the PGMRAMRANGE guest mapping.
1546	* @param iChunk The chunk number.
1547	* @param pszDesc The RAM range description.
1548	* @param ppPrev Previous RAM range pointer. In/Out.
1549	*/
1550	static int pgmR3PhysRegisterHighRamChunk(PVM pVM, RTGCPHYS GCPhys, uint32_t cRamPages,
1551	uint32_t cbChunk, uint32_t iChunk, const char *pszDesc,
1552	PPGMRAMRANGE *ppPrev)
1553	{
1554	const char *pszDescChunk = iChunk == 0
1555	? pszDesc
1556	: MMR3HeapAPrintf(pVM, MM_TAG_PGM_PHYS, "%s (#%u)", pszDesc, iChunk + 1);
1557	AssertReturn(pszDescChunk, VERR_NO_MEMORY);
1558
1559	/*
1560	* Allocate memory for the new chunk.
1561	*/
1562	size_t const cChunkPages = RT_ALIGN_Z(RT_UOFFSETOF(PGMRAMRANGE, aPages[cRamPages]), PAGE_SIZE) >> PAGE_SHIFT;
1563	PSUPPAGE paChunkPages = (PSUPPAGE)RTMemTmpAllocZ(sizeof(SUPPAGE) * cChunkPages);
1564	AssertReturn(paChunkPages, VERR_NO_TMP_MEMORY);
1565	RTR0PTR R0PtrChunk = NIL_RTR0PTR;
1566	void *pvChunk = NULL;
1567	int rc = SUPR3PageAllocEx(cChunkPages, 0 /fFlags/, &pvChunk,
1568	#if defined(VBOX_WITH_MORE_RING0_MEM_MAPPINGS)
1569	&R0PtrChunk,
1570	#elif defined(VBOX_WITH_2X_4GB_ADDR_SPACE)
1571	HMIsEnabled(pVM) ? &R0PtrChunk : NULL,
1572	#else
1573	NULL,
1574	#endif
1575	paChunkPages);
1576	if (RT_SUCCESS(rc))
1577	{
1578	#if defined(VBOX_WITH_MORE_RING0_MEM_MAPPINGS)
1579	Assert(R0PtrChunk != NIL_RTR0PTR);
1580	#elif defined(VBOX_WITH_2X_4GB_ADDR_SPACE)
1581	if (!HMIsEnabled(pVM))
1582	R0PtrChunk = NIL_RTR0PTR;
1583	#else
1584	R0PtrChunk = (uintptr_t)pvChunk;
1585	#endif
1586	memset(pvChunk, 0, cChunkPages << PAGE_SHIFT);
1587
1588	PPGMRAMRANGE pNew = (PPGMRAMRANGE)pvChunk;
1589
1590	/*
1591	* Create a mapping and map the pages into it.
1592	* We push these in below the HMA.
1593	*/
1594	RTGCPTR GCPtrChunkMap = pVM->pgm.s.GCPtrPrevRamRangeMapping - cbChunk;
1595	rc = PGMR3MapPT(pVM, GCPtrChunkMap, cbChunk, 0 /fFlags/, pgmR3PhysRamRangeRelocate, pNew, pszDescChunk);
1596	if (RT_SUCCESS(rc))
1597	{
1598	pVM->pgm.s.GCPtrPrevRamRangeMapping = GCPtrChunkMap;
1599
1600	RTGCPTR const GCPtrChunk = GCPtrChunkMap + PAGE_SIZE;
1601	RTGCPTR GCPtrPage = GCPtrChunk;
1602	for (uint32_t iPage = 0; iPage < cChunkPages && RT_SUCCESS(rc); iPage++, GCPtrPage += PAGE_SIZE)
1603	rc = PGMMap(pVM, GCPtrPage, paChunkPages[iPage].Phys, PAGE_SIZE, 0);
1604	if (RT_SUCCESS(rc))
1605	{
1606	/*
1607	* Ok, init and link the range.
1608	*/
1609	pgmR3PhysInitAndLinkRamRange(pVM, pNew, GCPhys, GCPhys + ((RTGCPHYS)cRamPages << PAGE_SHIFT) - 1,
1610	(RTRCPTR)GCPtrChunk, R0PtrChunk, pszDescChunk, *ppPrev);
1611	*ppPrev = pNew;
1612	}
1613	}
1614
1615	if (RT_FAILURE(rc))
1616	SUPR3PageFreeEx(pvChunk, cChunkPages);
1617	}
1618
1619	RTMemTmpFree(paChunkPages);
1620	return rc;
1621	}
1622
1623
1624	/**
1625	* Sets up a range RAM.
1626	*
1627	* This will check for conflicting registrations, make a resource
1628	* reservation for the memory (with GMM), and setup the per-page
1629	* tracking structures (PGMPAGE).
1630	*
1631	* @returns VBox status code.
1632	* @param pVM The cross context VM structure.
1633	* @param GCPhys The physical address of the RAM.
1634	* @param cb The size of the RAM.
1635	* @param pszDesc The description - not copied, so, don't free or change it.
1636	*/
1637	VMMR3DECL(int) PGMR3PhysRegisterRam(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, const char *pszDesc)
1638	{
1639	/*
1640	* Validate input.
1641	*/
1642	Log(("PGMR3PhysRegisterRam: GCPhys=%RGp cb=%RGp pszDesc=%s\n", GCPhys, cb, pszDesc));
1643	AssertReturn(RT_ALIGN_T(GCPhys, PAGE_SIZE, RTGCPHYS) == GCPhys, VERR_INVALID_PARAMETER);
1644	AssertReturn(RT_ALIGN_T(cb, PAGE_SIZE, RTGCPHYS) == cb, VERR_INVALID_PARAMETER);
1645	AssertReturn(cb > 0, VERR_INVALID_PARAMETER);
1646	RTGCPHYS GCPhysLast = GCPhys + (cb - 1);
1647	AssertMsgReturn(GCPhysLast > GCPhys, ("The range wraps! GCPhys=%RGp cb=%RGp\n", GCPhys, cb), VERR_INVALID_PARAMETER);
1648	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
1649	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
1650
1651	pgmLock(pVM);
1652
1653	/*
1654	* Find range location and check for conflicts.
1655	* (We don't lock here because the locking by EMT is only required on update.)
1656	*/
1657	PPGMRAMRANGE pPrev = NULL;
1658	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
1659	while (pRam && GCPhysLast >= pRam->GCPhys)
1660	{
1661	if ( GCPhysLast >= pRam->GCPhys
1662	&& GCPhys <= pRam->GCPhysLast)
1663	AssertLogRelMsgFailedReturn(("%RGp-%RGp (%s) conflicts with existing %RGp-%RGp (%s)\n",
1664	GCPhys, GCPhysLast, pszDesc,
1665	pRam->GCPhys, pRam->GCPhysLast, pRam->pszDesc),
1666	VERR_PGM_RAM_CONFLICT);
1667
1668	/* next */
1669	pPrev = pRam;
1670	pRam = pRam->pNextR3;
1671	}
1672
1673	/*
1674	* Register it with GMM (the API bitches).
1675	*/
1676	const RTGCPHYS cPages = cb >> PAGE_SHIFT;
1677	int rc = MMR3IncreaseBaseReservation(pVM, cPages);
1678	if (RT_FAILURE(rc))
1679	{
1680	pgmUnlock(pVM);
1681	return rc;
1682	}
1683
1684	if ( GCPhys >= _4G
1685	&& cPages > 256)
1686	{
1687	/*
1688	* The PGMRAMRANGE structures for the high memory can get very big.
1689	* In order to avoid SUPR3PageAllocEx allocation failures due to the
1690	* allocation size limit there and also to avoid being unable to find
1691	* guest mapping space for them, we split this memory up into 4MB in
1692	* (potential) raw-mode configs and 16MB chunks in forced AMD-V/VT-x
1693	* mode.
1694	*
1695	* The first and last page of each mapping are guard pages and marked
1696	* not-present. So, we've got 4186112 and 16769024 bytes available for
1697	* the PGMRAMRANGE structure.
1698	*
1699	* Note! The sizes used here will influence the saved state.
1700	*/
1701	uint32_t cbChunk;
1702	uint32_t cPagesPerChunk;
1703	if (HMIsEnabled(pVM))
1704	{
1705	cbChunk = 16U*_1M;
1706	cPagesPerChunk = 1048048; /* max ~1048059 */
1707	AssertCompile(sizeof(PGMRAMRANGE) + sizeof(PGMPAGE) * 1048048 < 16U_1M - PAGE_SIZE 2);
1708	}
1709	else
1710	{
1711	cbChunk = 4U*_1M;
1712	cPagesPerChunk = 261616; /* max ~261627 */
1713	AssertCompile(sizeof(PGMRAMRANGE) + sizeof(PGMPAGE) * 261616 < 4U_1M - PAGE_SIZE 2);
1714	}
1715	AssertRelease(RT_UOFFSETOF(PGMRAMRANGE, aPages[cPagesPerChunk]) + PAGE_SIZE * 2 <= cbChunk);
1716
1717	RTGCPHYS cPagesLeft = cPages;
1718	RTGCPHYS GCPhysChunk = GCPhys;
1719	uint32_t iChunk = 0;
1720	while (cPagesLeft > 0)
1721	{
1722	uint32_t cPagesInChunk = cPagesLeft;
1723	if (cPagesInChunk > cPagesPerChunk)
1724	cPagesInChunk = cPagesPerChunk;
1725
1726	rc = pgmR3PhysRegisterHighRamChunk(pVM, GCPhysChunk, cPagesInChunk, cbChunk, iChunk, pszDesc, &pPrev);
1727	AssertRCReturn(rc, rc);
1728
1729	/* advance */
1730	GCPhysChunk += (RTGCPHYS)cPagesInChunk << PAGE_SHIFT;
1731	cPagesLeft -= cPagesInChunk;
1732	iChunk++;
1733	}
1734	}
1735	else
1736	{
1737	/*
1738	* Allocate, initialize and link the new RAM range.
1739	*/
1740	const size_t cbRamRange = RT_OFFSETOF(PGMRAMRANGE, aPages[cPages]);
1741	PPGMRAMRANGE pNew;
1742	rc = MMR3HyperAllocOnceNoRel(pVM, cbRamRange, 0, MM_TAG_PGM_PHYS, (void **)&pNew);
1743	AssertLogRelMsgRCReturn(rc, ("cbRamRange=%zu\n", cbRamRange), rc);
1744
1745	pgmR3PhysInitAndLinkRamRange(pVM, pNew, GCPhys, GCPhysLast, NIL_RTRCPTR, NIL_RTR0PTR, pszDesc, pPrev);
1746	}
1747	pgmPhysInvalidatePageMapTLB(pVM);
1748	pgmUnlock(pVM);
1749
1750	#ifdef VBOX_WITH_REM
1751	/*
1752	* Notify REM.
1753	*/
1754	REMR3NotifyPhysRamRegister(pVM, GCPhys, cb, REM_NOTIFY_PHYS_RAM_FLAGS_RAM);
1755	#endif
1756
1757	return VINF_SUCCESS;
1758	}
1759
1760
1761	/**
1762	* Worker called by PGMR3InitFinalize if we're configured to pre-allocate RAM.
1763	*
1764	* We do this late in the init process so that all the ROM and MMIO ranges have
1765	* been registered already and we don't go wasting memory on them.
1766	*
1767	* @returns VBox status code.
1768	*
1769	* @param pVM The cross context VM structure.
1770	*/
1771	int pgmR3PhysRamPreAllocate(PVM pVM)
1772	{
1773	Assert(pVM->pgm.s.fRamPreAlloc);
1774	Log(("pgmR3PhysRamPreAllocate: enter\n"));
1775
1776	/*
1777	* Walk the RAM ranges and allocate all RAM pages, halt at
1778	* the first allocation error.
1779	*/
1780	uint64_t cPages = 0;
1781	uint64_t NanoTS = RTTimeNanoTS();
1782	pgmLock(pVM);
1783	for (PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
1784	{
1785	PPGMPAGE pPage = &pRam->aPages[0];
1786	RTGCPHYS GCPhys = pRam->GCPhys;
1787	uint32_t cLeft = pRam->cb >> PAGE_SHIFT;
1788	while (cLeft-- > 0)
1789	{
1790	if (PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_RAM)
1791	{
1792	switch (PGM_PAGE_GET_STATE(pPage))
1793	{
1794	case PGM_PAGE_STATE_ZERO:
1795	{
1796	int rc = pgmPhysAllocPage(pVM, pPage, GCPhys);
1797	if (RT_FAILURE(rc))
1798	{
1799	LogRel(("PGM: RAM Pre-allocation failed at %RGp (in %s) with rc=%Rrc\n", GCPhys, pRam->pszDesc, rc));
1800	pgmUnlock(pVM);
1801	return rc;
1802	}
1803	cPages++;
1804	break;
1805	}
1806
1807	case PGM_PAGE_STATE_BALLOONED:
1808	case PGM_PAGE_STATE_ALLOCATED:
1809	case PGM_PAGE_STATE_WRITE_MONITORED:
1810	case PGM_PAGE_STATE_SHARED:
1811	/* nothing to do here. */
1812	break;
1813	}
1814	}
1815
1816	/* next */
1817	pPage++;
1818	GCPhys += PAGE_SIZE;
1819	}
1820	}
1821	pgmUnlock(pVM);
1822	NanoTS = RTTimeNanoTS() - NanoTS;
1823
1824	LogRel(("PGM: Pre-allocated %llu pages in %llu ms\n", cPages, NanoTS / 1000000));
1825	Log(("pgmR3PhysRamPreAllocate: returns VINF_SUCCESS\n"));
1826	return VINF_SUCCESS;
1827	}
1828
1829
1830	/**
1831	* Checks shared page checksums.
1832	*
1833	* @param pVM The cross context VM structure.
1834	*/
1835	void pgmR3PhysAssertSharedPageChecksums(PVM pVM)
1836	{
1837	#ifdef VBOX_STRICT
1838	pgmLock(pVM);
1839
1840	if (pVM->pgm.s.cSharedPages > 0)
1841	{
1842	/*
1843	* Walk the ram ranges.
1844	*/
1845	for (PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
1846	{
1847	uint32_t iPage = pRam->cb >> PAGE_SHIFT;
1848	AssertMsg(((RTGCPHYS)iPage << PAGE_SHIFT) == pRam->cb, ("%RGp %RGp\n", (RTGCPHYS)iPage << PAGE_SHIFT, pRam->cb));
1849
1850	while (iPage-- > 0)
1851	{
1852	PPGMPAGE pPage = &pRam->aPages[iPage];
1853	if (PGM_PAGE_IS_SHARED(pPage))
1854	{
1855	uint32_t u32Checksum = pPage->s.u2Unused0 \| ((uint32_t)pPage->s.u2Unused1 << 8);
1856	if (!u32Checksum)
1857	{
1858	RTGCPHYS GCPhysPage = pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT);
1859	void const *pvPage;
1860	int rc = pgmPhysPageMapReadOnly(pVM, pPage, GCPhysPage, &pvPage);
1861	if (RT_SUCCESS(rc))
1862	{
1863	uint32_t u32Checksum2 = RTCrc32(pvPage, PAGE_SIZE);
1864	# if 0
1865	AssertMsg((u32Checksum2 & UINT32_C(0x00000303)) == u32Checksum, ("GCPhysPage=%RGp\n", GCPhysPage));
1866	# else
1867	if ((u32Checksum2 & UINT32_C(0x00000303)) == u32Checksum)
1868	LogFlow(("shpg %#x @ %RGp %#x [OK]\n", PGM_PAGE_GET_PAGEID(pPage), GCPhysPage, u32Checksum2));
1869	else
1870	AssertMsgFailed(("shpg %#x @ %RGp %#x\n", PGM_PAGE_GET_PAGEID(pPage), GCPhysPage, u32Checksum2));
1871	# endif
1872	}
1873	else
1874	AssertRC(rc);
1875	}
1876	}
1877
1878	} /* for each page */
1879
1880	} /* for each ram range */
1881	}
1882
1883	pgmUnlock(pVM);
1884	#endif /* VBOX_STRICT */
1885	NOREF(pVM);
1886	}
1887
1888
1889	/**
1890	* Resets the physical memory state.
1891	*
1892	* ASSUMES that the caller owns the PGM lock.
1893	*
1894	* @returns VBox status code.
1895	* @param pVM The cross context VM structure.
1896	*/
1897	int pgmR3PhysRamReset(PVM pVM)
1898	{
1899	PGM_LOCK_ASSERT_OWNER(pVM);
1900
1901	/* Reset the memory balloon. */
1902	int rc = GMMR3BalloonedPages(pVM, GMMBALLOONACTION_RESET, 0);
1903	AssertRC(rc);
1904
1905	#ifdef VBOX_WITH_PAGE_SHARING
1906	/* Clear all registered shared modules. */
1907	pgmR3PhysAssertSharedPageChecksums(pVM);
1908	rc = GMMR3ResetSharedModules(pVM);
1909	AssertRC(rc);
1910	#endif
1911	/* Reset counters. */
1912	pVM->pgm.s.cReusedSharedPages = 0;
1913	pVM->pgm.s.cBalloonedPages = 0;
1914
1915	return VINF_SUCCESS;
1916	}
1917
1918
1919	/**
1920	* Resets (zeros) the RAM after all devices and components have been reset.
1921	*
1922	* ASSUMES that the caller owns the PGM lock.
1923	*
1924	* @returns VBox status code.
1925	* @param pVM The cross context VM structure.
1926	*/
1927	int pgmR3PhysRamZeroAll(PVM pVM)
1928	{
1929	PGM_LOCK_ASSERT_OWNER(pVM);
1930
1931	/*
1932	* We batch up pages that should be freed instead of calling GMM for
1933	* each and every one of them.
1934	*/
1935	uint32_t cPendingPages = 0;
1936	PGMMFREEPAGESREQ pReq;
1937	int rc = GMMR3FreePagesPrepare(pVM, &pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
1938	AssertLogRelRCReturn(rc, rc);
1939
1940	/*
1941	* Walk the ram ranges.
1942	*/
1943	for (PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
1944	{
1945	uint32_t iPage = pRam->cb >> PAGE_SHIFT;
1946	AssertMsg(((RTGCPHYS)iPage << PAGE_SHIFT) == pRam->cb, ("%RGp %RGp\n", (RTGCPHYS)iPage << PAGE_SHIFT, pRam->cb));
1947
1948	if ( !pVM->pgm.s.fRamPreAlloc
1949	&& pVM->pgm.s.fZeroRamPagesOnReset)
1950	{
1951	/* Replace all RAM pages by ZERO pages. */
1952	while (iPage-- > 0)
1953	{
1954	PPGMPAGE pPage = &pRam->aPages[iPage];
1955	switch (PGM_PAGE_GET_TYPE(pPage))
1956	{
1957	case PGMPAGETYPE_RAM:
1958	/* Do not replace pages part of a 2 MB continuous range
1959	with zero pages, but zero them instead. */
1960	if ( PGM_PAGE_GET_PDE_TYPE(pPage) == PGM_PAGE_PDE_TYPE_PDE
1961	\|\| PGM_PAGE_GET_PDE_TYPE(pPage) == PGM_PAGE_PDE_TYPE_PDE_DISABLED)
1962	{
1963	void *pvPage;
1964	rc = pgmPhysPageMap(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT), &pvPage);
1965	AssertLogRelRCReturn(rc, rc);
1966	ASMMemZeroPage(pvPage);
1967	}
1968	else if (PGM_PAGE_IS_BALLOONED(pPage))
1969	{
1970	/* Turn into a zero page; the balloon status is lost when the VM reboots. */
1971	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ZERO);
1972	}
1973	else if (!PGM_PAGE_IS_ZERO(pPage))
1974	{
1975	rc = pgmPhysFreePage(pVM, pReq, &cPendingPages, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT));
1976	AssertLogRelRCReturn(rc, rc);
1977	}
1978	break;
1979
1980	case PGMPAGETYPE_MMIO2_ALIAS_MMIO:
1981	case PGMPAGETYPE_SPECIAL_ALIAS_MMIO: /** @todo perhaps leave the special page alone? I don't think VT-x copes with this code. */
1982	pgmHandlerPhysicalResetAliasedPage(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT),
1983	true /fDoAccounting/);
1984	break;
1985
1986	case PGMPAGETYPE_MMIO2:
1987	case PGMPAGETYPE_ROM_SHADOW: /* handled by pgmR3PhysRomReset. */
1988	case PGMPAGETYPE_ROM:
1989	case PGMPAGETYPE_MMIO:
1990	break;
1991	default:
1992	AssertFailed();
1993	}
1994	} /* for each page */
1995	}
1996	else
1997	{
1998	/* Zero the memory. */
1999	while (iPage-- > 0)
2000	{
2001	PPGMPAGE pPage = &pRam->aPages[iPage];
2002	switch (PGM_PAGE_GET_TYPE(pPage))
2003	{
2004	case PGMPAGETYPE_RAM:
2005	switch (PGM_PAGE_GET_STATE(pPage))
2006	{
2007	case PGM_PAGE_STATE_ZERO:
2008	break;
2009
2010	case PGM_PAGE_STATE_BALLOONED:
2011	/* Turn into a zero page; the balloon status is lost when the VM reboots. */
2012	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ZERO);
2013	break;
2014
2015	case PGM_PAGE_STATE_SHARED:
2016	case PGM_PAGE_STATE_WRITE_MONITORED:
2017	rc = pgmPhysPageMakeWritable(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT));
2018	AssertLogRelRCReturn(rc, rc);
2019	RT_FALL_THRU();
2020
2021	case PGM_PAGE_STATE_ALLOCATED:
2022	if (pVM->pgm.s.fZeroRamPagesOnReset)
2023	{
2024	void *pvPage;
2025	rc = pgmPhysPageMap(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT), &pvPage);
2026	AssertLogRelRCReturn(rc, rc);
2027	ASMMemZeroPage(pvPage);
2028	}
2029	break;
2030	}
2031	break;
2032
2033	case PGMPAGETYPE_MMIO2_ALIAS_MMIO:
2034	case PGMPAGETYPE_SPECIAL_ALIAS_MMIO: /** @todo perhaps leave the special page alone? I don't think VT-x copes with this code. */
2035	pgmHandlerPhysicalResetAliasedPage(pVM, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT),
2036	true /fDoAccounting/);
2037	break;
2038
2039	case PGMPAGETYPE_MMIO2:
2040	case PGMPAGETYPE_ROM_SHADOW:
2041	case PGMPAGETYPE_ROM:
2042	case PGMPAGETYPE_MMIO:
2043	break;
2044	default:
2045	AssertFailed();
2046
2047	}
2048	} /* for each page */
2049	}
2050
2051	}
2052
2053	/*
2054	* Finish off any pages pending freeing.
2055	*/
2056	if (cPendingPages)
2057	{
2058	rc = GMMR3FreePagesPerform(pVM, pReq, cPendingPages);
2059	AssertLogRelRCReturn(rc, rc);
2060	}
2061	GMMR3FreePagesCleanup(pReq);
2062	return VINF_SUCCESS;
2063	}
2064
2065
2066	/**
2067	* Frees all RAM during VM termination
2068	*
2069	* ASSUMES that the caller owns the PGM lock.
2070	*
2071	* @returns VBox status code.
2072	* @param pVM The cross context VM structure.
2073	*/
2074	int pgmR3PhysRamTerm(PVM pVM)
2075	{
2076	PGM_LOCK_ASSERT_OWNER(pVM);
2077
2078	/* Reset the memory balloon. */
2079	int rc = GMMR3BalloonedPages(pVM, GMMBALLOONACTION_RESET, 0);
2080	AssertRC(rc);
2081
2082	#ifdef VBOX_WITH_PAGE_SHARING
2083	/*
2084	* Clear all registered shared modules.
2085	*/
2086	pgmR3PhysAssertSharedPageChecksums(pVM);
2087	rc = GMMR3ResetSharedModules(pVM);
2088	AssertRC(rc);
2089
2090	/*
2091	* Flush the handy pages updates to make sure no shared pages are hiding
2092	* in there. (No unlikely if the VM shuts down, apparently.)
2093	*/
2094	rc = VMMR3CallR0(pVM, VMMR0_DO_PGM_FLUSH_HANDY_PAGES, 0, NULL);
2095	#endif
2096
2097	/*
2098	* We batch up pages that should be freed instead of calling GMM for
2099	* each and every one of them.
2100	*/
2101	uint32_t cPendingPages = 0;
2102	PGMMFREEPAGESREQ pReq;
2103	rc = GMMR3FreePagesPrepare(pVM, &pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
2104	AssertLogRelRCReturn(rc, rc);
2105
2106	/*
2107	* Walk the ram ranges.
2108	*/
2109	for (PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3; pRam; pRam = pRam->pNextR3)
2110	{
2111	uint32_t iPage = pRam->cb >> PAGE_SHIFT;
2112	AssertMsg(((RTGCPHYS)iPage << PAGE_SHIFT) == pRam->cb, ("%RGp %RGp\n", (RTGCPHYS)iPage << PAGE_SHIFT, pRam->cb));
2113
2114	while (iPage-- > 0)
2115	{
2116	PPGMPAGE pPage = &pRam->aPages[iPage];
2117	switch (PGM_PAGE_GET_TYPE(pPage))
2118	{
2119	case PGMPAGETYPE_RAM:
2120	/* Free all shared pages. Private pages are automatically freed during GMM VM cleanup. */
2121	/** @todo change this to explicitly free private pages here. */
2122	if (PGM_PAGE_IS_SHARED(pPage))
2123	{
2124	rc = pgmPhysFreePage(pVM, pReq, &cPendingPages, pPage, pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT));
2125	AssertLogRelRCReturn(rc, rc);
2126	}
2127	break;
2128
2129	case PGMPAGETYPE_MMIO2_ALIAS_MMIO:
2130	case PGMPAGETYPE_SPECIAL_ALIAS_MMIO:
2131	case PGMPAGETYPE_MMIO2:
2132	case PGMPAGETYPE_ROM_SHADOW: /* handled by pgmR3PhysRomReset. */
2133	case PGMPAGETYPE_ROM:
2134	case PGMPAGETYPE_MMIO:
2135	break;
2136	default:
2137	AssertFailed();
2138	}
2139	} /* for each page */
2140	}
2141
2142	/*
2143	* Finish off any pages pending freeing.
2144	*/
2145	if (cPendingPages)
2146	{
2147	rc = GMMR3FreePagesPerform(pVM, pReq, cPendingPages);
2148	AssertLogRelRCReturn(rc, rc);
2149	}
2150	GMMR3FreePagesCleanup(pReq);
2151	return VINF_SUCCESS;
2152	}
2153
2154
2155	/**
2156	* This is the interface IOM is using to register an MMIO region.
2157	*
2158	* It will check for conflicts and ensure that a RAM range structure
2159	* is present before calling the PGMR3HandlerPhysicalRegister API to
2160	* register the callbacks.
2161	*
2162	* @returns VBox status code.
2163	*
2164	* @param pVM The cross context VM structure.
2165	* @param GCPhys The start of the MMIO region.
2166	* @param cb The size of the MMIO region.
2167	* @param hType The physical access handler type registration.
2168	* @param pvUserR3 The user argument for R3.
2169	* @param pvUserR0 The user argument for R0.
2170	* @param pvUserRC The user argument for RC.
2171	* @param pszDesc The description of the MMIO region.
2172	*/
2173	VMMR3DECL(int) PGMR3PhysMMIORegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, PGMPHYSHANDLERTYPE hType,
2174	RTR3PTR pvUserR3, RTR0PTR pvUserR0, RTRCPTR pvUserRC, const char *pszDesc)
2175	{
2176	/*
2177	* Assert on some assumption.
2178	*/
2179	VM_ASSERT_EMT(pVM);
2180	AssertReturn(!(cb & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
2181	AssertReturn(!(GCPhys & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
2182	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
2183	AssertReturn(*pszDesc, VERR_INVALID_PARAMETER);
2184	Assert(((PPGMPHYSHANDLERTYPEINT)MMHyperHeapOffsetToPtr(pVM, hType))->enmKind == PGMPHYSHANDLERKIND_MMIO);
2185
2186	int rc = pgmLock(pVM);
2187	AssertRCReturn(rc, rc);
2188
2189	/*
2190	* Make sure there's a RAM range structure for the region.
2191	*/
2192	RTGCPHYS GCPhysLast = GCPhys + (cb - 1);
2193	bool fRamExists = false;
2194	PPGMRAMRANGE pRamPrev = NULL;
2195	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
2196	while (pRam && GCPhysLast >= pRam->GCPhys)
2197	{
2198	if ( GCPhysLast >= pRam->GCPhys
2199	&& GCPhys <= pRam->GCPhysLast)
2200	{
2201	/* Simplification: all within the same range. */
2202	AssertLogRelMsgReturnStmt( GCPhys >= pRam->GCPhys
2203	&& GCPhysLast <= pRam->GCPhysLast,
2204	("%RGp-%RGp (MMIO/%s) falls partly outside %RGp-%RGp (%s)\n",
2205	GCPhys, GCPhysLast, pszDesc,
2206	pRam->GCPhys, pRam->GCPhysLast, pRam->pszDesc),
2207	pgmUnlock(pVM),
2208	VERR_PGM_RAM_CONFLICT);
2209
2210	/* Check that it's all RAM or MMIO pages. */
2211	PCPGMPAGE pPage = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
2212	uint32_t cLeft = cb >> PAGE_SHIFT;
2213	while (cLeft-- > 0)
2214	{
2215	AssertLogRelMsgReturnStmt( PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_RAM
2216	\|\| PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_MMIO,
2217	("%RGp-%RGp (MMIO/%s): %RGp is not a RAM or MMIO page - type=%d desc=%s\n",
2218	GCPhys, GCPhysLast, pszDesc, pRam->GCPhys, PGM_PAGE_GET_TYPE(pPage), pRam->pszDesc),
2219	pgmUnlock(pVM),
2220	VERR_PGM_RAM_CONFLICT);
2221	pPage++;
2222	}
2223
2224	/* Looks good. */
2225	fRamExists = true;
2226	break;
2227	}
2228
2229	/* next */
2230	pRamPrev = pRam;
2231	pRam = pRam->pNextR3;
2232	}
2233	PPGMRAMRANGE pNew;
2234	if (fRamExists)
2235	{
2236	pNew = NULL;
2237
2238	/*
2239	* Make all the pages in the range MMIO/ZERO pages, freeing any
2240	* RAM pages currently mapped here. This might not be 100% correct
2241	* for PCI memory, but we're doing the same thing for MMIO2 pages.
2242	*/
2243	rc = pgmR3PhysFreePageRange(pVM, pRam, GCPhys, GCPhysLast, PGMPAGETYPE_MMIO);
2244	AssertRCReturnStmt(rc, pgmUnlock(pVM), rc);
2245
2246	/* Force a PGM pool flush as guest ram references have been changed. */
2247	/** @todo not entirely SMP safe; assuming for now the guest takes
2248	* care of this internally (not touch mapped mmio while changing the
2249	* mapping). */
2250	PVMCPU pVCpu = VMMGetCpu(pVM);
2251	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_CLEAR_PGM_POOL;
2252	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
2253	}
2254	else
2255	{
2256
2257	/*
2258	* No RAM range, insert an ad hoc one.
2259	*
2260	* Note that we don't have to tell REM about this range because
2261	* PGMHandlerPhysicalRegisterEx will do that for us.
2262	*/
2263	Log(("PGMR3PhysMMIORegister: Adding ad hoc MMIO range for %RGp-%RGp %s\n", GCPhys, GCPhysLast, pszDesc));
2264
2265	const uint32_t cPages = cb >> PAGE_SHIFT;
2266	const size_t cbRamRange = RT_OFFSETOF(PGMRAMRANGE, aPages[cPages]);
2267	rc = MMHyperAlloc(pVM, RT_OFFSETOF(PGMRAMRANGE, aPages[cPages]), 16, MM_TAG_PGM_PHYS, (void **)&pNew);
2268	AssertLogRelMsgRCReturnStmt(rc, ("cbRamRange=%zu\n", cbRamRange), pgmUnlock(pVM), rc);
2269
2270	/* Initialize the range. */
2271	pNew->pSelfR0 = MMHyperCCToR0(pVM, pNew);
2272	pNew->pSelfRC = MMHyperCCToRC(pVM, pNew);
2273	pNew->GCPhys = GCPhys;
2274	pNew->GCPhysLast = GCPhysLast;
2275	pNew->cb = cb;
2276	pNew->pszDesc = pszDesc;
2277	pNew->fFlags = PGM_RAM_RANGE_FLAGS_AD_HOC_MMIO;
2278	pNew->pvR3 = NULL;
2279	pNew->paLSPages = NULL;
2280
2281	uint32_t iPage = cPages;
2282	while (iPage-- > 0)
2283	PGM_PAGE_INIT_ZERO(&pNew->aPages[iPage], pVM, PGMPAGETYPE_MMIO);
2284	Assert(PGM_PAGE_GET_TYPE(&pNew->aPages[0]) == PGMPAGETYPE_MMIO);
2285
2286	/* update the page count stats. */
2287	pVM->pgm.s.cPureMmioPages += cPages;
2288	pVM->pgm.s.cAllPages += cPages;
2289
2290	/* link it */
2291	pgmR3PhysLinkRamRange(pVM, pNew, pRamPrev);
2292	}
2293
2294	/*
2295	* Register the access handler.
2296	*/
2297	rc = PGMHandlerPhysicalRegister(pVM, GCPhys, GCPhysLast, hType, pvUserR3, pvUserR0, pvUserRC, pszDesc);
2298	if ( RT_FAILURE(rc)
2299	&& !fRamExists)
2300	{
2301	pVM->pgm.s.cPureMmioPages -= cb >> PAGE_SHIFT;
2302	pVM->pgm.s.cAllPages -= cb >> PAGE_SHIFT;
2303
2304	/* remove the ad hoc range. */
2305	pgmR3PhysUnlinkRamRange2(pVM, pNew, pRamPrev);
2306	pNew->cb = pNew->GCPhys = pNew->GCPhysLast = NIL_RTGCPHYS;
2307	MMHyperFree(pVM, pRam);
2308	}
2309	pgmPhysInvalidatePageMapTLB(pVM);
2310
2311	pgmUnlock(pVM);
2312	return rc;
2313	}
2314
2315
2316	/**
2317	* This is the interface IOM is using to register an MMIO region.
2318	*
2319	* It will take care of calling PGMHandlerPhysicalDeregister and clean up
2320	* any ad hoc PGMRAMRANGE left behind.
2321	*
2322	* @returns VBox status code.
2323	* @param pVM The cross context VM structure.
2324	* @param GCPhys The start of the MMIO region.
2325	* @param cb The size of the MMIO region.
2326	*/
2327	VMMR3DECL(int) PGMR3PhysMMIODeregister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb)
2328	{
2329	VM_ASSERT_EMT(pVM);
2330
2331	int rc = pgmLock(pVM);
2332	AssertRCReturn(rc, rc);
2333
2334	/*
2335	* First deregister the handler, then check if we should remove the ram range.
2336	*/
2337	rc = PGMHandlerPhysicalDeregister(pVM, GCPhys);
2338	if (RT_SUCCESS(rc))
2339	{
2340	RTGCPHYS GCPhysLast = GCPhys + (cb - 1);
2341	PPGMRAMRANGE pRamPrev = NULL;
2342	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
2343	while (pRam && GCPhysLast >= pRam->GCPhys)
2344	{
2345	/** @todo We're being a bit too careful here. rewrite. */
2346	if ( GCPhysLast == pRam->GCPhysLast
2347	&& GCPhys == pRam->GCPhys)
2348	{
2349	Assert(pRam->cb == cb);
2350
2351	/*
2352	* See if all the pages are dead MMIO pages.
2353	*/
2354	uint32_t const cPages = cb >> PAGE_SHIFT;
2355	bool fAllMMIO = true;
2356	uint32_t iPage = 0;
2357	uint32_t cLeft = cPages;
2358	while (cLeft-- > 0)
2359	{
2360	PPGMPAGE pPage = &pRam->aPages[iPage];
2361	if ( !PGM_PAGE_IS_MMIO_OR_ALIAS(pPage)
2362	/\|\| not-out-of-action later /)
2363	{
2364	fAllMMIO = false;
2365	AssertMsgFailed(("%RGp %R[pgmpage]\n", pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT), pPage));
2366	break;
2367	}
2368	Assert( PGM_PAGE_IS_ZERO(pPage)
2369	\|\| PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_MMIO2_ALIAS_MMIO
2370	\|\| PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_SPECIAL_ALIAS_MMIO);
2371	pPage++;
2372	}
2373	if (fAllMMIO)
2374	{
2375	/*
2376	* Ad-hoc range, unlink and free it.
2377	*/
2378	Log(("PGMR3PhysMMIODeregister: Freeing ad hoc MMIO range for %RGp-%RGp %s\n",
2379	GCPhys, GCPhysLast, pRam->pszDesc));
2380
2381	pVM->pgm.s.cAllPages -= cPages;
2382	pVM->pgm.s.cPureMmioPages -= cPages;
2383
2384	pgmR3PhysUnlinkRamRange2(pVM, pRam, pRamPrev);
2385	pRam->cb = pRam->GCPhys = pRam->GCPhysLast = NIL_RTGCPHYS;
2386	MMHyperFree(pVM, pRam);
2387	break;
2388	}
2389	}
2390
2391	/*
2392	* Range match? It will all be within one range (see PGMAllHandler.cpp).
2393	*/
2394	if ( GCPhysLast >= pRam->GCPhys
2395	&& GCPhys <= pRam->GCPhysLast)
2396	{
2397	Assert(GCPhys >= pRam->GCPhys);
2398	Assert(GCPhysLast <= pRam->GCPhysLast);
2399
2400	/*
2401	* Turn the pages back into RAM pages.
2402	*/
2403	uint32_t iPage = (GCPhys - pRam->GCPhys) >> PAGE_SHIFT;
2404	uint32_t cLeft = cb >> PAGE_SHIFT;
2405	while (cLeft--)
2406	{
2407	PPGMPAGE pPage = &pRam->aPages[iPage];
2408	AssertMsg( (PGM_PAGE_IS_MMIO(pPage) && PGM_PAGE_IS_ZERO(pPage))
2409	\|\| PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_MMIO2_ALIAS_MMIO
2410	\|\| PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_SPECIAL_ALIAS_MMIO,
2411	("%RGp %R[pgmpage]\n", pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT), pPage));
2412	if (PGM_PAGE_IS_MMIO_OR_ALIAS(pPage))
2413	PGM_PAGE_SET_TYPE(pVM, pPage, PGMPAGETYPE_RAM);
2414	}
2415	break;
2416	}
2417
2418	/* next */
2419	pRamPrev = pRam;
2420	pRam = pRam->pNextR3;
2421	}
2422	}
2423
2424	/* Force a PGM pool flush as guest ram references have been changed. */
2425	/** @todo Not entirely SMP safe; assuming for now the guest takes care of
2426	* this internally (not touch mapped mmio while changing the mapping). */
2427	PVMCPU pVCpu = VMMGetCpu(pVM);
2428	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_CLEAR_PGM_POOL;
2429	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
2430
2431	pgmPhysInvalidatePageMapTLB(pVM);
2432	pgmPhysInvalidRamRangeTlbs(pVM);
2433	pgmUnlock(pVM);
2434	return rc;
2435	}
2436
2437
2438	/**
2439	* Locate a MMIO2 range.
2440	*
2441	* @returns Pointer to the MMIO2 range.
2442	* @param pVM The cross context VM structure.
2443	* @param pDevIns The device instance owning the region.
2444	* @param iSubDev The sub-device number.
2445	* @param iRegion The region.
2446	*/
2447	DECLINLINE(PPGMREGMMIORANGE) pgmR3PhysMMIOExFind(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion)
2448	{
2449	/*
2450	* Search the list. There shouldn't be many entries.
2451	*/
2452	/** @todo Optimize this lookup! There may now be many entries and it'll
2453	* become really slow when doing MMR3HyperMapMMIO2 and similar. */
2454	for (PPGMREGMMIORANGE pCur = pVM->pgm.s.pRegMmioRangesR3; pCur; pCur = pCur->pNextR3)
2455	if ( pCur->pDevInsR3 == pDevIns
2456	&& pCur->iRegion == iRegion
2457	&& pCur->iSubDev == iSubDev)
2458	return pCur;
2459	return NULL;
2460	}
2461
2462
2463	/**
2464	* @callback_method_impl{FNPGMRELOCATE, Relocate a floating MMIO/MMIO2 range.}
2465	* @sa pgmR3PhysRamRangeRelocate
2466	*/
2467	static DECLCALLBACK(bool) pgmR3PhysMMIOExRangeRelocate(PVM pVM, RTGCPTR GCPtrOld, RTGCPTR GCPtrNew,
2468	PGMRELOCATECALL enmMode, void *pvUser)
2469	{
2470	PPGMREGMMIORANGE pMmio = (PPGMREGMMIORANGE)pvUser;
2471	Assert(pMmio->RamRange.fFlags & PGM_RAM_RANGE_FLAGS_FLOATING);
2472	Assert(pMmio->RamRange.pSelfRC == GCPtrOld + PAGE_SIZE + RT_UOFFSETOF(PGMREGMMIORANGE, RamRange)); RT_NOREF_PV(GCPtrOld);
2473
2474	switch (enmMode)
2475	{
2476	case PGMRELOCATECALL_SUGGEST:
2477	return true;
2478
2479	case PGMRELOCATECALL_RELOCATE:
2480	{
2481	/*
2482	* Update myself, then relink all the ranges and flush the RC TLB.
2483	*/
2484	pgmLock(pVM);
2485
2486	pMmio->RamRange.pSelfRC = (RTRCPTR)(GCPtrNew + PAGE_SIZE + RT_UOFFSETOF(PGMREGMMIORANGE, RamRange));
2487
2488	pgmR3PhysRelinkRamRanges(pVM);
2489	for (unsigned i = 0; i < PGM_RAMRANGE_TLB_ENTRIES; i++)
2490	pVM->pgm.s.apRamRangesTlbRC[i] = NIL_RTRCPTR;
2491
2492	pgmUnlock(pVM);
2493	return true;
2494	}
2495
2496	default:
2497	AssertFailedReturn(false);
2498	}
2499	}
2500
2501
2502	/**
2503	* Calculates the number of chunks
2504	*
2505	* @returns Number of registration chunk needed.
2506	* @param pVM The cross context VM structure.
2507	* @param cb The size of the MMIO/MMIO2 range.
2508	* @param pcPagesPerChunk Where to return the number of pages tracked by each
2509	* chunk. Optional.
2510	* @param pcbChunk Where to return the guest mapping size for a chunk.
2511	*/
2512	static uint16_t pgmR3PhysMMIOExCalcChunkCount(PVM pVM, RTGCPHYS cb, uint32_t pcPagesPerChunk, uint32_t pcbChunk)
2513	{
2514	/*
2515	* This is the same calculation as PGMR3PhysRegisterRam does, except we'll be
2516	* needing a few bytes extra the PGMREGMMIORANGE structure.
2517	*
2518	* Note! In additions, we've got a 24 bit sub-page range for MMIO2 ranges, leaving
2519	* us with an absolute maximum of 16777215 pages per chunk (close to 64 GB).
2520	*/
2521	uint32_t cbChunk;
2522	uint32_t cPagesPerChunk;
2523	if (HMIsEnabled(pVM))
2524	{
2525	cbChunk = 16U*_1M;
2526	cPagesPerChunk = 1048048; /* max ~1048059 */
2527	AssertCompile(sizeof(PGMREGMMIORANGE) + sizeof(PGMPAGE) * 1048048 < 16U_1M - PAGE_SIZE 2);
2528	}
2529	else
2530	{
2531	cbChunk = 4U*_1M;
2532	cPagesPerChunk = 261616; /* max ~261627 */
2533	AssertCompile(sizeof(PGMREGMMIORANGE) + sizeof(PGMPAGE) * 261616 < 4U_1M - PAGE_SIZE 2);
2534	}
2535	AssertRelease(cPagesPerChunk <= PGM_MMIO2_MAX_PAGE_COUNT); /* See above note. */
2536	AssertRelease(RT_UOFFSETOF(PGMREGMMIORANGE, RamRange.aPages[cPagesPerChunk]) + PAGE_SIZE * 2 <= cbChunk);
2537	if (pcbChunk)
2538	*pcbChunk = cbChunk;
2539	if (pcPagesPerChunk)
2540	*pcPagesPerChunk = cPagesPerChunk;
2541
2542	/* Calc the number of chunks we need. */
2543	RTGCPHYS const cPages = cb >> X86_PAGE_SHIFT;
2544	uint16_t cChunks = (uint16_t)((cPages + cPagesPerChunk - 1) / cPagesPerChunk);
2545	AssertRelease((RTGCPHYS)cChunks * cPagesPerChunk >= cPages);
2546	return cChunks;
2547	}
2548
2549
2550	/**
2551	* Worker for PGMR3PhysMMIOExPreRegister & PGMR3PhysMMIO2Register that allocates
2552	* and the PGMREGMMIORANGE structures and does basic initialization.
2553	*
2554	* Caller must set type specfic members and initialize the PGMPAGE structures.
2555	*
2556	* @returns VBox status code.
2557	* @param pVM The cross context VM structure.
2558	* @param pDevIns The device instance owning the region.
2559	* @param iSubDev The sub-device number (internal PCI config number).
2560	* @param iRegion The region number. If the MMIO2 memory is a PCI
2561	* I/O region this number has to be the number of that
2562	* region. Otherwise it can be any number safe
2563	* UINT8_MAX.
2564	* @param cb The size of the region. Must be page aligned.
2565	* @param pszDesc The description.
2566	* @param ppHeadRet Where to return the pointer to the first
2567	* registration chunk.
2568	*
2569	* @thread EMT
2570	*/
2571	static int pgmR3PhysMMIOExCreate(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS cb,
2572	const char pszDesc, PPGMREGMMIORANGE ppHeadRet)
2573	{
2574	/*
2575	* Figure out how many chunks we need and of which size.
2576	*/
2577	uint32_t cPagesPerChunk;
2578	uint16_t cChunks = pgmR3PhysMMIOExCalcChunkCount(pVM, cb, &cPagesPerChunk, NULL);
2579	AssertReturn(cChunks, VERR_PGM_PHYS_MMIO_EX_IPE);
2580
2581	/*
2582	* Allocate the chunks.
2583	*/
2584	PPGMREGMMIORANGE *ppNext = ppHeadRet;
2585	*ppNext = NULL;
2586
2587	int rc = VINF_SUCCESS;
2588	uint32_t cPagesLeft = cb >> X86_PAGE_SHIFT;
2589	for (uint16_t iChunk = 0; iChunk < cChunks && RT_SUCCESS(rc); iChunk++)
2590	{
2591	/*
2592	* We currently do a single RAM range for the whole thing. This will
2593	* probably have to change once someone needs really large MMIO regions,
2594	* as we will be running into SUPR3PageAllocEx limitations and such.
2595	*/
2596	const uint32_t cPagesTrackedByChunk = RT_MIN(cPagesLeft, cPagesPerChunk);
2597	const size_t cbRange = RT_OFFSETOF(PGMREGMMIORANGE, RamRange.aPages[cPagesTrackedByChunk]);
2598	PPGMREGMMIORANGE pNew = NULL;
2599	if ( cPagesTrackedByChunk > cPagesLeft /*< @todo r=klaus the first part of the condition is guaranteed false due to RT_MIN above /
2600	\|\| cbRange >= _1M)
2601	{
2602	/*
2603	* Allocate memory for the registration structure.
2604	*/
2605	size_t const cChunkPages = RT_ALIGN_Z(cbRange, PAGE_SIZE) >> PAGE_SHIFT;
2606	size_t const cbChunk = (1 + cChunkPages + 1) << PAGE_SHIFT;
2607	AssertLogRelBreakStmt(cbChunk == (uint32_t)cbChunk, rc = VERR_OUT_OF_RANGE);
2608	PSUPPAGE paChunkPages = (PSUPPAGE)RTMemTmpAllocZ(sizeof(SUPPAGE) * cChunkPages);
2609	AssertBreakStmt(paChunkPages, rc = VERR_NO_TMP_MEMORY);
2610	RTR0PTR R0PtrChunk = NIL_RTR0PTR;
2611	void *pvChunk = NULL;
2612	rc = SUPR3PageAllocEx(cChunkPages, 0 /fFlags/, &pvChunk,
2613	#if defined(VBOX_WITH_MORE_RING0_MEM_MAPPINGS)
2614	&R0PtrChunk,
2615	#elif defined(VBOX_WITH_2X_4GB_ADDR_SPACE)
2616	HMIsEnabled(pVM) ? &R0PtrChunk : NULL,
2617	#else
2618	NULL,
2619	#endif
2620	paChunkPages);
2621	AssertLogRelMsgRCBreakStmt(rc, ("rc=%Rrc, cChunkPages=%#zx\n", rc, cChunkPages), RTMemTmpFree(paChunkPages));
2622
2623	#if defined(VBOX_WITH_MORE_RING0_MEM_MAPPINGS)
2624	Assert(R0PtrChunk != NIL_RTR0PTR);
2625	#elif defined(VBOX_WITH_2X_4GB_ADDR_SPACE)
2626	if (!HMIsEnabled(pVM))
2627	R0PtrChunk = NIL_RTR0PTR;
2628	#else
2629	R0PtrChunk = (uintptr_t)pvChunk;
2630	#endif
2631	memset(pvChunk, 0, cChunkPages << PAGE_SHIFT);
2632
2633	pNew = (PPGMREGMMIORANGE)pvChunk;
2634	pNew->RamRange.fFlags = PGM_RAM_RANGE_FLAGS_FLOATING;
2635	pNew->RamRange.pSelfR0 = R0PtrChunk + RT_OFFSETOF(PGMREGMMIORANGE, RamRange);
2636
2637	/*
2638	* If we might end up in raw-mode, make a HMA mapping of the range,
2639	* just like we do for memory above 4GB.
2640	*/
2641	if (HMIsEnabled(pVM))
2642	pNew->RamRange.pSelfRC = NIL_RTRCPTR;
2643	else
2644	{
2645	RTGCPTR GCPtrChunkMap = pVM->pgm.s.GCPtrPrevRamRangeMapping - cbChunk;
2646	RTGCPTR const GCPtrChunk = GCPtrChunkMap + PAGE_SIZE;
2647	rc = PGMR3MapPT(pVM, GCPtrChunkMap, (uint32_t)cbChunk, 0 /fFlags/, pgmR3PhysMMIOExRangeRelocate, pNew, pszDesc);
2648	if (RT_SUCCESS(rc))
2649	{
2650	pVM->pgm.s.GCPtrPrevRamRangeMapping = GCPtrChunkMap;
2651
2652	RTGCPTR GCPtrPage = GCPtrChunk;
2653	for (uint32_t iPage = 0; iPage < cPagesTrackedByChunk && RT_SUCCESS(rc); iPage++, GCPtrPage += PAGE_SIZE)
2654	rc = PGMMap(pVM, GCPtrPage, paChunkPages[iPage].Phys, PAGE_SIZE, 0);
2655	}
2656	if (RT_FAILURE(rc))
2657	{
2658	SUPR3PageFreeEx(pvChunk, cChunkPages);
2659	break;
2660	}
2661	pNew->RamRange.pSelfRC = GCPtrChunk + RT_OFFSETOF(PGMREGMMIORANGE, RamRange);
2662	}
2663	}
2664	/*
2665	* Not so big, do a one time hyper allocation.
2666	*/
2667	else
2668	{
2669	rc = MMR3HyperAllocOnceNoRel(pVM, cbRange, 0, MM_TAG_PGM_PHYS, (void **)&pNew);
2670	AssertLogRelMsgRCBreak(rc, ("cbRange=%zu\n", cbRange));
2671
2672	/*
2673	* Initialize allocation specific items.
2674	*/
2675	//pNew->RamRange.fFlags = 0;
2676	pNew->RamRange.pSelfR0 = MMHyperCCToR0(pVM, &pNew->RamRange);
2677	pNew->RamRange.pSelfRC = MMHyperCCToRC(pVM, &pNew->RamRange);
2678	}
2679
2680	/*
2681	* Initialize the registration structure (caller does specific bits).
2682	*/
2683	pNew->pDevInsR3 = pDevIns;
2684	//pNew->pvR3 = NULL;
2685	//pNew->pNext = NULL;
2686	//pNew->fFlags = 0;
2687	if (iChunk == 0)
2688	pNew->fFlags \|= PGMREGMMIORANGE_F_FIRST_CHUNK;
2689	if (iChunk + 1 == cChunks)
2690	pNew->fFlags \|= PGMREGMMIORANGE_F_LAST_CHUNK;
2691	pNew->iSubDev = iSubDev;
2692	pNew->iRegion = iRegion;
2693	pNew->idSavedState = UINT8_MAX;
2694	pNew->idMmio2 = UINT8_MAX;
2695	//pNew->pPhysHandlerR3 = NULL;
2696	//pNew->paLSPages = NULL;
2697	pNew->RamRange.GCPhys = NIL_RTGCPHYS;
2698	pNew->RamRange.GCPhysLast = NIL_RTGCPHYS;
2699	pNew->RamRange.pszDesc = pszDesc;
2700	pNew->RamRange.cb = pNew->cbReal = (RTGCPHYS)cPagesTrackedByChunk << X86_PAGE_SHIFT;
2701	pNew->RamRange.fFlags \|= PGM_RAM_RANGE_FLAGS_AD_HOC_MMIO_EX;
2702	//pNew->RamRange.pvR3 = NULL;
2703	//pNew->RamRange.paLSPages = NULL;
2704
2705	*ppNext = pNew;
2706	ASMCompilerBarrier();
2707	cPagesLeft -= cPagesTrackedByChunk;
2708	ppNext = &pNew->pNextR3;
2709	}
2710	Assert(cPagesLeft == 0);
2711
2712	if (RT_SUCCESS(rc))
2713	{
2714	Assert((*ppHeadRet)->fFlags & PGMREGMMIORANGE_F_FIRST_CHUNK);
2715	return VINF_SUCCESS;
2716	}
2717
2718	/*
2719	* Free floating ranges.
2720	*/
2721	while (*ppHeadRet)
2722	{
2723	PPGMREGMMIORANGE pFree = *ppHeadRet;
2724	*ppHeadRet = pFree->pNextR3;
2725
2726	if (pFree->RamRange.fFlags & PGM_RAM_RANGE_FLAGS_FLOATING)
2727	{
2728	const size_t cbRange = RT_OFFSETOF(PGMREGMMIORANGE, RamRange.aPages[pFree->RamRange.cb >> X86_PAGE_SHIFT]);
2729	size_t const cChunkPages = RT_ALIGN_Z(cbRange, PAGE_SIZE) >> PAGE_SHIFT;
2730	SUPR3PageFreeEx(pFree, cChunkPages);
2731	}
2732	}
2733
2734	return rc;
2735	}
2736
2737
2738	/**
2739	* Common worker PGMR3PhysMMIOExPreRegister & PGMR3PhysMMIO2Register that links
2740	* a complete registration entry into the lists and lookup tables.
2741	*
2742	* @param pVM The cross context VM structure.
2743	* @param pNew The new MMIO / MMIO2 registration to link.
2744	*/
2745	static void pgmR3PhysMMIOExLink(PVM pVM, PPGMREGMMIORANGE pNew)
2746	{
2747	/*
2748	* Link it into the list (order doesn't matter, so insert it at the head).
2749	*
2750	* Note! The range we're link may consist of multiple chunks, so we have to
2751	* find the last one.
2752	*/
2753	PPGMREGMMIORANGE pLast = pNew;
2754	for (pLast = pNew; ; pLast = pLast->pNextR3)
2755	{
2756	if (pLast->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
2757	break;
2758	Assert(pLast->pNextR3);
2759	Assert(pLast->pNextR3->pDevInsR3 == pNew->pDevInsR3);
2760	Assert(pLast->pNextR3->iSubDev == pNew->iSubDev);
2761	Assert(pLast->pNextR3->iRegion == pNew->iRegion);
2762	Assert((pLast->pNextR3->fFlags & PGMREGMMIORANGE_F_MMIO2) == (pNew->fFlags & PGMREGMMIORANGE_F_MMIO2));
2763	Assert(pLast->pNextR3->idMmio2 == (pLast->fFlags & PGMREGMMIORANGE_F_MMIO2 ? pNew->idMmio2 + 1 : UINT8_MAX));
2764	}
2765
2766	pgmLock(pVM);
2767
2768	/* Link in the chain of ranges at the head of the list. */
2769	pLast->pNextR3 = pVM->pgm.s.pRegMmioRangesR3;
2770	pVM->pgm.s.pRegMmioRangesR3 = pNew;
2771
2772	/* If MMIO, insert the MMIO2 range/page IDs. */
2773	uint8_t idMmio2 = pNew->idMmio2;
2774	if (idMmio2 != UINT8_MAX)
2775	{
2776	for (;;)
2777	{
2778	Assert(pNew->fFlags & PGMREGMMIORANGE_F_MMIO2);
2779	Assert(pVM->pgm.s.apMmio2RangesR3[idMmio2 - 1] == NULL);
2780	Assert(pVM->pgm.s.apMmio2RangesR0[idMmio2 - 1] == NIL_RTR0PTR);
2781	pVM->pgm.s.apMmio2RangesR3[idMmio2 - 1] = pNew;
2782	pVM->pgm.s.apMmio2RangesR0[idMmio2 - 1] = pNew->RamRange.pSelfR0 - RT_OFFSETOF(PGMREGMMIORANGE, RamRange);
2783	if (pNew->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
2784	break;
2785	pNew = pNew->pNextR3;
2786	}
2787	}
2788	else
2789	Assert(!(pNew->fFlags & PGMREGMMIORANGE_F_MMIO2));
2790
2791	pgmPhysInvalidatePageMapTLB(pVM);
2792	pgmUnlock(pVM);
2793	}
2794
2795
2796	/**
2797	* Allocate and pre-register an MMIO region.
2798	*
2799	* This is currently the way to deal with large MMIO regions. It may in the
2800	* future be extended to be the way we deal with all MMIO regions, but that
2801	* means we'll have to do something about the simple list based approach we take
2802	* to tracking the registrations.
2803	*
2804	* @returns VBox status code.
2805	* @retval VINF_SUCCESS on success, *ppv pointing to the R3 mapping of the
2806	* memory.
2807	* @retval VERR_ALREADY_EXISTS if the region already exists.
2808	*
2809	* @param pVM The cross context VM structure.
2810	* @param pDevIns The device instance owning the region.
2811	* @param iSubDev The sub-device number.
2812	* @param iRegion The region number. If the MMIO2 memory is a PCI
2813	* I/O region this number has to be the number of that
2814	* region. Otherwise it can be any number safe
2815	* UINT8_MAX.
2816	* @param cbRegion The size of the region. Must be page aligned.
2817	* @param hType The physical handler callback type.
2818	* @param pvUserR3 User parameter for ring-3 context callbacks.
2819	* @param pvUserR0 User parameter for ring-0 context callbacks.
2820	* @param pvUserRC User parameter for raw-mode context callbacks.
2821	* @param pszDesc The description.
2822	*
2823	* @thread EMT
2824	*
2825	* @sa PGMR3PhysMMIORegister, PGMR3PhysMMIO2Register,
2826	* PGMR3PhysMMIOExMap, PGMR3PhysMMIOExUnmap, PGMR3PhysMMIOExDeregister.
2827	*/
2828	VMMR3DECL(int) PGMR3PhysMMIOExPreRegister(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS cbRegion,
2829	PGMPHYSHANDLERTYPE hType, RTR3PTR pvUserR3, RTR0PTR pvUserR0, RTRCPTR pvUserRC,
2830	const char *pszDesc)
2831	{
2832	/*
2833	* Validate input.
2834	*/
2835	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
2836	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
2837	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
2838	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
2839	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
2840	AssertReturn(*pszDesc, VERR_INVALID_PARAMETER);
2841	AssertReturn(pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion) == NULL, VERR_ALREADY_EXISTS);
2842	AssertReturn(!(cbRegion & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
2843	AssertReturn(cbRegion, VERR_INVALID_PARAMETER);
2844
2845	const uint32_t cPages = cbRegion >> PAGE_SHIFT;
2846	AssertLogRelReturn(((RTGCPHYS)cPages << PAGE_SHIFT) == cbRegion, VERR_INVALID_PARAMETER);
2847	AssertLogRelReturn(cPages <= (MM_MMIO_64_MAX >> X86_PAGE_SHIFT), VERR_OUT_OF_RANGE);
2848
2849	/*
2850	* For the 2nd+ instance, mangle the description string so it's unique.
2851	*/
2852	if (pDevIns->iInstance > 0) /** @todo Move to PDMDevHlp.cpp and use a real string cache. */
2853	{
2854	pszDesc = MMR3HeapAPrintf(pVM, MM_TAG_PGM_PHYS, "%s [%u]", pszDesc, pDevIns->iInstance);
2855	if (!pszDesc)
2856	return VERR_NO_MEMORY;
2857	}
2858
2859	/*
2860	* Register the MMIO callbacks.
2861	*/
2862	PPGMPHYSHANDLER pPhysHandler;
2863	int rc = pgmHandlerPhysicalExCreate(pVM, hType, pvUserR3, pvUserR0, pvUserRC, pszDesc, &pPhysHandler);
2864	if (RT_SUCCESS(rc))
2865	{
2866	/*
2867	* Create the registered MMIO range record for it.
2868	*/
2869	PPGMREGMMIORANGE pNew;
2870	rc = pgmR3PhysMMIOExCreate(pVM, pDevIns, iSubDev, iRegion, cbRegion, pszDesc, &pNew);
2871	if (RT_SUCCESS(rc))
2872	{
2873	Assert(!(pNew->fFlags & PGMREGMMIORANGE_F_MMIO2));
2874
2875	/*
2876	* Intialize the page structures and set up physical handlers (one for each chunk).
2877	*/
2878	for (PPGMREGMMIORANGE pCur = pNew; pCur != NULL && RT_SUCCESS(rc); pCur = pCur->pNextR3)
2879	{
2880	if (pCur == pNew)
2881	pCur->pPhysHandlerR3 = pPhysHandler;
2882	else
2883	rc = pgmHandlerPhysicalExDup(pVM, pPhysHandler, &pCur->pPhysHandlerR3);
2884
2885	uint32_t iPage = pCur->RamRange.cb >> X86_PAGE_SHIFT;
2886	while (iPage-- > 0)
2887	PGM_PAGE_INIT_ZERO(&pCur->RamRange.aPages[iPage], pVM, PGMPAGETYPE_MMIO);
2888	}
2889	if (RT_SUCCESS(rc))
2890	{
2891	/*
2892	* Update the page count stats, link the registration and we're done.
2893	*/
2894	pVM->pgm.s.cAllPages += cPages;
2895	pVM->pgm.s.cPureMmioPages += cPages;
2896
2897	pgmR3PhysMMIOExLink(pVM, pNew);
2898	return VINF_SUCCESS;
2899	}
2900
2901	/*
2902	* Clean up in case we're out of memory for extra access handlers.
2903	*/
2904	while (pNew != NULL)
2905	{
2906	PPGMREGMMIORANGE pFree = pNew;
2907	pNew = pFree->pNextR3;
2908
2909	if (pFree->pPhysHandlerR3)
2910	{
2911	pgmHandlerPhysicalExDestroy(pVM, pFree->pPhysHandlerR3);
2912	pFree->pPhysHandlerR3 = NULL;
2913	}
2914
2915	if (pFree->RamRange.fFlags & PGM_RAM_RANGE_FLAGS_FLOATING)
2916	{
2917	const size_t cbRange = RT_OFFSETOF(PGMREGMMIORANGE, RamRange.aPages[pFree->RamRange.cb >> X86_PAGE_SHIFT]);
2918	size_t const cChunkPages = RT_ALIGN_Z(cbRange, PAGE_SIZE) >> PAGE_SHIFT;
2919	SUPR3PageFreeEx(pFree, cChunkPages);
2920	}
2921	}
2922	}
2923	else
2924	pgmHandlerPhysicalExDestroy(pVM, pPhysHandler);
2925	}
2926	return rc;
2927	}
2928
2929
2930	/**
2931	* Allocate and register an MMIO2 region.
2932	*
2933	* As mentioned elsewhere, MMIO2 is just RAM spelled differently. It's RAM
2934	* associated with a device. It is also non-shared memory with a permanent
2935	* ring-3 mapping and page backing (presently).
2936	*
2937	* A MMIO2 range may overlap with base memory if a lot of RAM is configured for
2938	* the VM, in which case we'll drop the base memory pages. Presently we will
2939	* make no attempt to preserve anything that happens to be present in the base
2940	* memory that is replaced, this is of course incorrect but it's too much
2941	* effort.
2942	*
2943	* @returns VBox status code.
2944	* @retval VINF_SUCCESS on success, *ppv pointing to the R3 mapping of the
2945	* memory.
2946	* @retval VERR_ALREADY_EXISTS if the region already exists.
2947	*
2948	* @param pVM The cross context VM structure.
2949	* @param pDevIns The device instance owning the region.
2950	* @param iSubDev The sub-device number.
2951	* @param iRegion The region number. If the MMIO2 memory is a PCI
2952	* I/O region this number has to be the number of that
2953	* region. Otherwise it can be any number safe
2954	* UINT8_MAX.
2955	* @param cb The size of the region. Must be page aligned.
2956	* @param fFlags Reserved for future use, must be zero.
2957	* @param ppv Where to store the pointer to the ring-3 mapping of
2958	* the memory.
2959	* @param pszDesc The description.
2960	* @thread EMT
2961	*/
2962	VMMR3DECL(int) PGMR3PhysMMIO2Register(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS cb,
2963	uint32_t fFlags, void *ppv, const char pszDesc)
2964	{
2965	/*
2966	* Validate input.
2967	*/
2968	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
2969	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
2970	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
2971	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
2972	AssertPtrReturn(ppv, VERR_INVALID_POINTER);
2973	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
2974	AssertReturn(*pszDesc, VERR_INVALID_PARAMETER);
2975	AssertReturn(pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion) == NULL, VERR_ALREADY_EXISTS);
2976	AssertReturn(!(cb & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
2977	AssertReturn(cb, VERR_INVALID_PARAMETER);
2978	AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
2979
2980	const uint32_t cPages = cb >> PAGE_SHIFT;
2981	AssertLogRelReturn(((RTGCPHYS)cPages << PAGE_SHIFT) == cb, VERR_INVALID_PARAMETER);
2982	AssertLogRelReturn(cPages <= (MM_MMIO_64_MAX >> X86_PAGE_SHIFT), VERR_OUT_OF_RANGE);
2983
2984	/*
2985	* For the 2nd+ instance, mangle the description string so it's unique.
2986	*/
2987	if (pDevIns->iInstance > 0) /** @todo Move to PDMDevHlp.cpp and use a real string cache. */
2988	{
2989	pszDesc = MMR3HeapAPrintf(pVM, MM_TAG_PGM_PHYS, "%s [%u]", pszDesc, pDevIns->iInstance);
2990	if (!pszDesc)
2991	return VERR_NO_MEMORY;
2992	}
2993
2994	/*
2995	* Allocate an MMIO2 range ID (not freed on failure).
2996	*
2997	* The zero ID is not used as it could be confused with NIL_GMM_PAGEID, so
2998	* the IDs goes from 1 thru PGM_MMIO2_MAX_RANGES.
2999	*/
3000	unsigned cChunks = pgmR3PhysMMIOExCalcChunkCount(pVM, cb, NULL, NULL);
3001	pgmLock(pVM);
3002	uint8_t idMmio2 = pVM->pgm.s.cMmio2Regions + 1;
3003	unsigned cNewMmio2Regions = pVM->pgm.s.cMmio2Regions + cChunks;
3004	if (cNewMmio2Regions > PGM_MMIO2_MAX_RANGES)
3005	{
3006	pgmUnlock(pVM);
3007	AssertLogRelFailedReturn(VERR_PGM_TOO_MANY_MMIO2_RANGES);
3008	}
3009	pVM->pgm.s.cMmio2Regions = cNewMmio2Regions;
3010	pgmUnlock(pVM);
3011
3012	/*
3013	* Try reserve and allocate the backing memory first as this is what is
3014	* most likely to fail.
3015	*/
3016	int rc = MMR3AdjustFixedReservation(pVM, cPages, pszDesc);
3017	if (RT_SUCCESS(rc))
3018	{
3019	PSUPPAGE paPages = (PSUPPAGE)RTMemTmpAlloc(cPages * sizeof(SUPPAGE));
3020	if (RT_SUCCESS(rc))
3021	{
3022	void *pvPages;
3023	rc = SUPR3PageAllocEx(cPages, 0 /fFlags/, &pvPages, NULL /pR0Ptr/, paPages);
3024	if (RT_SUCCESS(rc))
3025	{
3026	memset(pvPages, 0, cPages * PAGE_SIZE);
3027
3028	/*
3029	* Create the registered MMIO range record for it.
3030	*/
3031	PPGMREGMMIORANGE pNew;
3032	rc = pgmR3PhysMMIOExCreate(pVM, pDevIns, iSubDev, iRegion, cb, pszDesc, &pNew);
3033	if (RT_SUCCESS(rc))
3034	{
3035	uint32_t iSrcPage = 0;
3036	uint8_t pbCurPages = (uint8_t )pvPages;
3037	for (PPGMREGMMIORANGE pCur = pNew; pCur; pCur = pCur->pNextR3)
3038	{
3039	pCur->pvR3 = pbCurPages;
3040	pCur->RamRange.pvR3 = pbCurPages;
3041	pCur->idMmio2 = idMmio2;
3042	pCur->fFlags \|= PGMREGMMIORANGE_F_MMIO2;
3043
3044	uint32_t iDstPage = pCur->RamRange.cb >> X86_PAGE_SHIFT;
3045	while (iDstPage-- > 0)
3046	{
3047	PGM_PAGE_INIT(&pNew->RamRange.aPages[iDstPage],
3048	paPages[iDstPage + iSrcPage].Phys,
3049	PGM_MMIO2_PAGEID_MAKE(idMmio2, iDstPage),
3050	PGMPAGETYPE_MMIO2, PGM_PAGE_STATE_ALLOCATED);
3051	}
3052
3053	/* advance. */
3054	iSrcPage += pCur->RamRange.cb >> X86_PAGE_SHIFT;
3055	pbCurPages += pCur->RamRange.cb;
3056	idMmio2++;
3057	}
3058
3059	RTMemTmpFree(paPages);
3060
3061	/*
3062	* Update the page count stats, link the registration and we're done.
3063	*/
3064	pVM->pgm.s.cAllPages += cPages;
3065	pVM->pgm.s.cPrivatePages += cPages;
3066
3067	pgmR3PhysMMIOExLink(pVM, pNew);
3068
3069	*ppv = pvPages;
3070	return VINF_SUCCESS;
3071	}
3072
3073	SUPR3PageFreeEx(pvPages, cPages);
3074	}
3075	}
3076	RTMemTmpFree(paPages);
3077	MMR3AdjustFixedReservation(pVM, -(int32_t)cPages, pszDesc);
3078	}
3079	if (pDevIns->iInstance > 0)
3080	MMR3HeapFree((void *)pszDesc);
3081	return rc;
3082	}
3083
3084
3085	/**
3086	* Deregisters and frees an MMIO2 region or a pre-registered MMIO region
3087	*
3088	* Any physical (and virtual) access handlers registered for the region must
3089	* be deregistered before calling this function.
3090	*
3091	* @returns VBox status code.
3092	* @param pVM The cross context VM structure.
3093	* @param pDevIns The device instance owning the region.
3094	* @param iSubDev The sub-device number. Pass UINT32_MAX for wildcard
3095	* matching.
3096	* @param iRegion The region. Pass UINT32_MAX for wildcard matching.
3097	*/
3098	VMMR3DECL(int) PGMR3PhysMMIOExDeregister(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion)
3099	{
3100	/*
3101	* Validate input.
3102	*/
3103	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3104	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3105	AssertReturn(iSubDev <= UINT8_MAX \|\| iSubDev == UINT32_MAX, VERR_INVALID_PARAMETER);
3106	AssertReturn(iRegion <= UINT8_MAX \|\| iRegion == UINT32_MAX, VERR_INVALID_PARAMETER);
3107
3108	/*
3109	* The loop here scanning all registrations will make sure that multi-chunk ranges
3110	* get properly deregistered, though it's original purpose was the wildcard iRegion.
3111	*/
3112	pgmLock(pVM);
3113	int rc = VINF_SUCCESS;
3114	unsigned cFound = 0;
3115	PPGMREGMMIORANGE pPrev = NULL;
3116	PPGMREGMMIORANGE pCur = pVM->pgm.s.pRegMmioRangesR3;
3117	while (pCur)
3118	{
3119	if ( pCur->pDevInsR3 == pDevIns
3120	&& ( iRegion == UINT32_MAX
3121	\|\| pCur->iRegion == iRegion)
3122	&& ( iSubDev == UINT32_MAX
3123	\|\| pCur->iSubDev == iSubDev) )
3124	{
3125	cFound++;
3126
3127	/*
3128	* Unmap it if it's mapped.
3129	*/
3130	if (pCur->fFlags & PGMREGMMIORANGE_F_MAPPED)
3131	{
3132	int rc2 = PGMR3PhysMMIOExUnmap(pVM, pCur->pDevInsR3, pCur->iSubDev, pCur->iRegion, pCur->RamRange.GCPhys);
3133	AssertRC(rc2);
3134	if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
3135	rc = rc2;
3136	}
3137
3138	/*
3139	* Must tell IOM about MMIO (first one only).
3140	*/
3141	if ((pCur->fFlags & (PGMREGMMIORANGE_F_MMIO2 \| PGMREGMMIORANGE_F_FIRST_CHUNK)) == PGMREGMMIORANGE_F_MMIO2)
3142	IOMR3MmioExNotifyDeregistered(pVM, pCur->pPhysHandlerR3->pvUserR3);
3143
3144	/*
3145	* Unlink it
3146	*/
3147	PPGMREGMMIORANGE pNext = pCur->pNextR3;
3148	if (pPrev)
3149	pPrev->pNextR3 = pNext;
3150	else
3151	pVM->pgm.s.pRegMmioRangesR3 = pNext;
3152	pCur->pNextR3 = NULL;
3153
3154	uint8_t idMmio2 = pCur->idMmio2;
3155	if (idMmio2 != UINT8_MAX)
3156	{
3157	Assert(pVM->pgm.s.apMmio2RangesR3[idMmio2 - 1] == pCur);
3158	pVM->pgm.s.apMmio2RangesR3[idMmio2 - 1] = NULL;
3159	pVM->pgm.s.apMmio2RangesR0[idMmio2 - 1] = NIL_RTR0PTR;
3160	}
3161
3162	/*
3163	* Free the memory.
3164	*/
3165	uint32_t const cPages = pCur->cbReal >> PAGE_SHIFT;
3166	if (pCur->fFlags & PGMREGMMIORANGE_F_MMIO2)
3167	{
3168	int rc2 = SUPR3PageFreeEx(pCur->pvR3, cPages);
3169	AssertRC(rc2);
3170	if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
3171	rc = rc2;
3172
3173	rc2 = MMR3AdjustFixedReservation(pVM, -(int32_t)cPages, pCur->RamRange.pszDesc);
3174	AssertRC(rc2);
3175	if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
3176	rc = rc2;
3177	}
3178
3179	/* we're leaking hyper memory here if done at runtime. */
3180	#ifdef VBOX_STRICT
3181	VMSTATE const enmState = VMR3GetState(pVM);
3182	AssertMsg( enmState == VMSTATE_POWERING_OFF
3183	\|\| enmState == VMSTATE_POWERING_OFF_LS
3184	\|\| enmState == VMSTATE_OFF
3185	\|\| enmState == VMSTATE_OFF_LS
3186	\|\| enmState == VMSTATE_DESTROYING
3187	\|\| enmState == VMSTATE_TERMINATED
3188	\|\| enmState == VMSTATE_CREATING
3189	, ("%s\n", VMR3GetStateName(enmState)));
3190	#endif
3191
3192	const bool fIsMmio2 = RT_BOOL(pCur->fFlags & PGMREGMMIORANGE_F_MMIO2);
3193	if (pCur->RamRange.fFlags & PGM_RAM_RANGE_FLAGS_FLOATING)
3194	{
3195	const size_t cbRange = RT_OFFSETOF(PGMREGMMIORANGE, RamRange.aPages[cPages]);
3196	size_t const cChunkPages = RT_ALIGN_Z(cbRange, PAGE_SIZE) >> PAGE_SHIFT;
3197	SUPR3PageFreeEx(pCur, cChunkPages);
3198	}
3199	/*else
3200	{
3201	rc = MMHyperFree(pVM, pCur); - does not work, see the alloc call.
3202	AssertRCReturn(rc, rc);
3203	} */
3204
3205
3206	/* update page count stats */
3207	pVM->pgm.s.cAllPages -= cPages;
3208	if (fIsMmio2)
3209	pVM->pgm.s.cPrivatePages -= cPages;
3210	else
3211	pVM->pgm.s.cPureMmioPages -= cPages;
3212
3213	/* next */
3214	pCur = pNext;
3215	}
3216	else
3217	{
3218	pPrev = pCur;
3219	pCur = pCur->pNextR3;
3220	}
3221	}
3222	pgmPhysInvalidatePageMapTLB(pVM);
3223	pgmUnlock(pVM);
3224	return !cFound && iRegion != UINT32_MAX && iSubDev != UINT32_MAX ? VERR_NOT_FOUND : rc;
3225	}
3226
3227
3228	/**
3229	* Maps a MMIO2 region or a pre-registered MMIO region.
3230	*
3231	* This is done when a guest / the bios / state loading changes the
3232	* PCI config. The replacing of base memory has the same restrictions
3233	* as during registration, of course.
3234	*
3235	* @returns VBox status code.
3236	*
3237	* @param pVM The cross context VM structure.
3238	* @param pDevIns The device instance owning the region.
3239	* @param iSubDev The sub-device number of the registered region.
3240	* @param iRegion The index of the registered region.
3241	* @param GCPhys The guest-physical address to be remapped.
3242	*/
3243	VMMR3DECL(int) PGMR3PhysMMIOExMap(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS GCPhys)
3244	{
3245	/*
3246	* Validate input.
3247	*
3248	* Note! It's safe to walk the MMIO/MMIO2 list since registrations only
3249	* happens during VM construction.
3250	*/
3251	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3252	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3253	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
3254	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
3255	AssertReturn(GCPhys != NIL_RTGCPHYS, VERR_INVALID_PARAMETER);
3256	AssertReturn(GCPhys != 0, VERR_INVALID_PARAMETER);
3257	AssertReturn(!(GCPhys & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3258
3259	PPGMREGMMIORANGE pFirstMmio = pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion);
3260	AssertReturn(pFirstMmio, VERR_NOT_FOUND);
3261	Assert(pFirstMmio->fFlags & PGMREGMMIORANGE_F_FIRST_CHUNK);
3262
3263	PPGMREGMMIORANGE pLastMmio = pFirstMmio;
3264	RTGCPHYS cbRange = 0;
3265	for (;;)
3266	{
3267	AssertReturn(!(pLastMmio->fFlags & PGMREGMMIORANGE_F_MAPPED), VERR_WRONG_ORDER);
3268	Assert(pLastMmio->RamRange.GCPhys == NIL_RTGCPHYS);
3269	Assert(pLastMmio->RamRange.GCPhysLast == NIL_RTGCPHYS);
3270	Assert(pLastMmio->pDevInsR3 == pFirstMmio->pDevInsR3);
3271	Assert(pLastMmio->iSubDev == pFirstMmio->iSubDev);
3272	Assert(pLastMmio->iRegion == pFirstMmio->iRegion);
3273	cbRange += pLastMmio->RamRange.cb;
3274	if (pLastMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3275	break;
3276	pLastMmio = pLastMmio->pNextR3;
3277	}
3278
3279	RTGCPHYS GCPhysLast = GCPhys + cbRange - 1;
3280	AssertLogRelReturn(GCPhysLast > GCPhys, VERR_INVALID_PARAMETER);
3281
3282	/*
3283	* Find our location in the ram range list, checking for restriction
3284	* we don't bother implementing yet (partially overlapping, multiple
3285	* ram ranges).
3286	*/
3287	pgmLock(pVM);
3288
3289	AssertReturnStmt(!(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MAPPED), pgmUnlock(pVM), VERR_WRONG_ORDER);
3290
3291	bool fRamExists = false;
3292	PPGMRAMRANGE pRamPrev = NULL;
3293	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
3294	while (pRam && GCPhysLast >= pRam->GCPhys)
3295	{
3296	if ( GCPhys <= pRam->GCPhysLast
3297	&& GCPhysLast >= pRam->GCPhys)
3298	{
3299	/* Completely within? */
3300	AssertLogRelMsgReturnStmt( GCPhys >= pRam->GCPhys
3301	&& GCPhysLast <= pRam->GCPhysLast,
3302	("%RGp-%RGp (MMIOEx/%s) falls partly outside %RGp-%RGp (%s)\n",
3303	GCPhys, GCPhysLast, pFirstMmio->RamRange.pszDesc,
3304	pRam->GCPhys, pRam->GCPhysLast, pRam->pszDesc),
3305	pgmUnlock(pVM),
3306	VERR_PGM_RAM_CONFLICT);
3307
3308	/* Check that all the pages are RAM pages. */
3309	PPGMPAGE pPage = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
3310	uint32_t cPagesLeft = cbRange >> PAGE_SHIFT;
3311	while (cPagesLeft-- > 0)
3312	{
3313	AssertLogRelMsgReturnStmt(PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_RAM,
3314	("%RGp isn't a RAM page (%d) - mapping %RGp-%RGp (MMIO2/%s).\n",
3315	GCPhys, PGM_PAGE_GET_TYPE(pPage), GCPhys, GCPhysLast, pFirstMmio->RamRange.pszDesc),
3316	pgmUnlock(pVM),
3317	VERR_PGM_RAM_CONFLICT);
3318	pPage++;
3319	}
3320
3321	/* There can only be one MMIO/MMIO2 chunk matching here! */
3322	AssertLogRelMsgReturnStmt(pFirstMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK,
3323	("%RGp-%RGp (MMIOEx/%s, flags %#X) consists of multiple chunks whereas the RAM somehow doesn't!\n",
3324	GCPhys, GCPhysLast, pFirstMmio->RamRange.pszDesc, pFirstMmio->fFlags),
3325	pgmUnlock(pVM),
3326	VERR_PGM_PHYS_MMIO_EX_IPE);
3327
3328	fRamExists = true;
3329	break;
3330	}
3331
3332	/* next */
3333	pRamPrev = pRam;
3334	pRam = pRam->pNextR3;
3335	}
3336	Log(("PGMR3PhysMMIOExMap: %RGp-%RGp fRamExists=%RTbool %s\n", GCPhys, GCPhysLast, fRamExists, pFirstMmio->RamRange.pszDesc));
3337
3338
3339	/*
3340	* Make the changes.
3341	*/
3342	RTGCPHYS GCPhysCur = GCPhys;
3343	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3344	{
3345	pCurMmio->RamRange.GCPhys = GCPhysCur;
3346	pCurMmio->RamRange.GCPhysLast = GCPhysCur + pCurMmio->RamRange.cb - 1;
3347	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3348	{
3349	Assert(pCurMmio->RamRange.GCPhysLast == GCPhysLast);
3350	break;
3351	}
3352	GCPhysCur += pCurMmio->RamRange.cb;
3353	}
3354
3355	if (fRamExists)
3356	{
3357	/*
3358	* Make all the pages in the range MMIO/ZERO pages, freeing any
3359	* RAM pages currently mapped here. This might not be 100% correct
3360	* for PCI memory, but we're doing the same thing for MMIO2 pages.
3361	*
3362	* We replace this MMIO/ZERO pages with real pages in the MMIO2 case.
3363	*/
3364	Assert(pFirstMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK); /* Only one chunk */
3365
3366	int rc = pgmR3PhysFreePageRange(pVM, pRam, GCPhys, GCPhysLast, PGMPAGETYPE_MMIO);
3367	AssertRCReturnStmt(rc, pgmUnlock(pVM), rc);
3368
3369	if (pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2)
3370	{
3371	/* replace the pages, freeing all present RAM pages. */
3372	PPGMPAGE pPageSrc = &pFirstMmio->RamRange.aPages[0];
3373	PPGMPAGE pPageDst = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
3374	uint32_t cPagesLeft = pFirstMmio->RamRange.cb >> PAGE_SHIFT;
3375	while (cPagesLeft-- > 0)
3376	{
3377	Assert(PGM_PAGE_IS_MMIO(pPageDst));
3378
3379	RTHCPHYS const HCPhys = PGM_PAGE_GET_HCPHYS(pPageSrc);
3380	uint32_t const idPage = PGM_PAGE_GET_PAGEID(pPageSrc);
3381	PGM_PAGE_SET_PAGEID(pVM, pPageDst, idPage);
3382	PGM_PAGE_SET_HCPHYS(pVM, pPageDst, HCPhys);
3383	PGM_PAGE_SET_TYPE(pVM, pPageDst, PGMPAGETYPE_MMIO2);
3384	PGM_PAGE_SET_STATE(pVM, pPageDst, PGM_PAGE_STATE_ALLOCATED);
3385	PGM_PAGE_SET_PDE_TYPE(pVM, pPageDst, PGM_PAGE_PDE_TYPE_DONTCARE);
3386	PGM_PAGE_SET_PTE_INDEX(pVM, pPageDst, 0);
3387	PGM_PAGE_SET_TRACKING(pVM, pPageDst, 0);
3388
3389	pVM->pgm.s.cZeroPages--;
3390	GCPhys += PAGE_SIZE;
3391	pPageSrc++;
3392	pPageDst++;
3393	}
3394	}
3395
3396	/* Flush physical page map TLB. */
3397	pgmPhysInvalidatePageMapTLB(pVM);
3398
3399	/* Force a PGM pool flush as guest ram references have been changed. */
3400	/** @todo not entirely SMP safe; assuming for now the guest takes care of
3401	* this internally (not touch mapped mmio while changing the mapping). */
3402	PVMCPU pVCpu = VMMGetCpu(pVM);
3403	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_CLEAR_PGM_POOL;
3404	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
3405	}
3406	else
3407	{
3408	/*
3409	* No RAM range, insert the ones prepared during registration.
3410	*/
3411	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3412	{
3413	/* Clear the tracking data of pages we're going to reactivate. */
3414	PPGMPAGE pPageSrc = &pCurMmio->RamRange.aPages[0];
3415	uint32_t cPagesLeft = pCurMmio->RamRange.cb >> PAGE_SHIFT;
3416	while (cPagesLeft-- > 0)
3417	{
3418	PGM_PAGE_SET_TRACKING(pVM, pPageSrc, 0);
3419	PGM_PAGE_SET_PTE_INDEX(pVM, pPageSrc, 0);
3420	pPageSrc++;
3421	}
3422
3423	/* link in the ram range */
3424	pgmR3PhysLinkRamRange(pVM, &pCurMmio->RamRange, pRamPrev);
3425
3426	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3427	{
3428	Assert(pCurMmio->RamRange.GCPhysLast == GCPhysLast);
3429	break;
3430	}
3431	pRamPrev = &pCurMmio->RamRange;
3432	}
3433	}
3434
3435	/*
3436	* Register the access handler if plain MMIO.
3437	*
3438	* We must register access handlers for each range since the access handler
3439	* code refuses to deal with multiple ranges (and we can).
3440	*/
3441	if (!(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2))
3442	{
3443	int rc = VINF_SUCCESS;
3444	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3445	{
3446	Assert(!(pCurMmio->fFlags & PGMREGMMIORANGE_F_MAPPED));
3447	rc = pgmHandlerPhysicalExRegister(pVM, pCurMmio->pPhysHandlerR3, pCurMmio->RamRange.GCPhys,
3448	pCurMmio->RamRange.GCPhysLast);
3449	if (RT_FAILURE(rc))
3450	break;
3451	pCurMmio->fFlags \|= PGMREGMMIORANGE_F_MAPPED; /* Use this to mark that the handler is registered. */
3452	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3453	{
3454	rc = IOMR3MmioExNotifyMapped(pVM, pFirstMmio->pPhysHandlerR3->pvUserR3, GCPhys);
3455	break;
3456	}
3457	}
3458	if (RT_FAILURE(rc))
3459	{
3460	/* Almost impossible, but try clean up properly and get out of here. */
3461	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3462	{
3463	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_MAPPED)
3464	{
3465	pCurMmio->fFlags &= ~PGMREGMMIORANGE_F_MAPPED;
3466	pgmHandlerPhysicalExDeregister(pVM, pCurMmio->pPhysHandlerR3);
3467	}
3468
3469	if (!fRamExists)
3470	pgmR3PhysUnlinkRamRange(pVM, &pCurMmio->RamRange);
3471	else
3472	{
3473	Assert(pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK); /* Only one chunk */
3474
3475	uint32_t cPagesLeft = pCurMmio->RamRange.cb >> PAGE_SHIFT;
3476	PPGMPAGE pPageDst = &pRam->aPages[(pCurMmio->RamRange.GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
3477	while (cPagesLeft-- > 0)
3478	{
3479	PGM_PAGE_INIT_ZERO(pPageDst, pVM, PGMPAGETYPE_RAM);
3480	pPageDst++;
3481	}
3482	}
3483
3484	pCurMmio->RamRange.GCPhys = NIL_RTGCPHYS;
3485	pCurMmio->RamRange.GCPhysLast = NIL_RTGCPHYS;
3486	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3487	break;
3488	}
3489
3490	pgmUnlock(pVM);
3491	return rc;
3492	}
3493	}
3494
3495	/*
3496	* We're good, set the flags and invalid the mapping TLB.
3497	*/
3498	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3499	{
3500	pCurMmio->fFlags \|= PGMREGMMIORANGE_F_MAPPED;
3501	if (fRamExists)
3502	pCurMmio->fFlags \|= PGMREGMMIORANGE_F_OVERLAPPING;
3503	else
3504	pCurMmio->fFlags &= ~PGMREGMMIORANGE_F_OVERLAPPING;
3505	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3506	break;
3507	}
3508	pgmPhysInvalidatePageMapTLB(pVM);
3509
3510	pgmUnlock(pVM);
3511
3512	#ifdef VBOX_WITH_REM
3513	/*
3514	* Inform REM without holding the PGM lock.
3515	*/
3516	if (!fRamExists && (pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2))
3517	REMR3NotifyPhysRamRegister(pVM, GCPhys, cbRange, REM_NOTIFY_PHYS_RAM_FLAGS_MMIO2);
3518	#endif
3519	return VINF_SUCCESS;
3520	}
3521
3522
3523	/**
3524	* Unmaps a MMIO2 or a pre-registered MMIO region.
3525	*
3526	* This is done when a guest / the bios / state loading changes the
3527	* PCI config. The replacing of base memory has the same restrictions
3528	* as during registration, of course.
3529	*/
3530	VMMR3DECL(int) PGMR3PhysMMIOExUnmap(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS GCPhys)
3531	{
3532	/*
3533	* Validate input
3534	*/
3535	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3536	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3537	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
3538	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
3539	AssertReturn(GCPhys != NIL_RTGCPHYS, VERR_INVALID_PARAMETER);
3540	AssertReturn(GCPhys != 0, VERR_INVALID_PARAMETER);
3541	AssertReturn(!(GCPhys & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3542
3543	PPGMREGMMIORANGE pFirstMmio = pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion);
3544	AssertReturn(pFirstMmio, VERR_NOT_FOUND);
3545	Assert(pFirstMmio->fFlags & PGMREGMMIORANGE_F_FIRST_CHUNK);
3546
3547	PPGMREGMMIORANGE pLastMmio = pFirstMmio;
3548	RTGCPHYS cbRange = 0;
3549	for (;;)
3550	{
3551	AssertReturn(pLastMmio->fFlags & PGMREGMMIORANGE_F_MAPPED, VERR_WRONG_ORDER);
3552	AssertReturn(pLastMmio->RamRange.GCPhys == GCPhys + cbRange, VERR_INVALID_PARAMETER);
3553	Assert(pLastMmio->pDevInsR3 == pFirstMmio->pDevInsR3);
3554	Assert(pLastMmio->iSubDev == pFirstMmio->iSubDev);
3555	Assert(pLastMmio->iRegion == pFirstMmio->iRegion);
3556	cbRange += pLastMmio->RamRange.cb;
3557	if (pLastMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3558	break;
3559	pLastMmio = pLastMmio->pNextR3;
3560	}
3561
3562	Log(("PGMR3PhysMMIOExUnmap: %RGp-%RGp %s\n",
3563	pFirstMmio->RamRange.GCPhys, pLastMmio->RamRange.GCPhysLast, pFirstMmio->RamRange.pszDesc));
3564
3565	int rc = pgmLock(pVM);
3566	AssertRCReturn(rc, rc);
3567	AssertReturnStmt(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MAPPED, pgmUnlock(pVM), VERR_WRONG_ORDER);
3568
3569	/*
3570	* If plain MMIO, we must deregister the handlers first.
3571	*/
3572	if (!(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2))
3573	{
3574	PPGMREGMMIORANGE pCurMmio = pFirstMmio;
3575	rc = pgmHandlerPhysicalExDeregister(pVM, pFirstMmio->pPhysHandlerR3);
3576	AssertRCReturnStmt(rc, pgmUnlock(pVM), rc);
3577	while (!(pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK))
3578	{
3579	pCurMmio = pCurMmio->pNextR3;
3580	rc = pgmHandlerPhysicalExDeregister(pVM, pCurMmio->pPhysHandlerR3);
3581	AssertRCReturnStmt(rc, pgmUnlock(pVM), VERR_PGM_PHYS_MMIO_EX_IPE);
3582	}
3583
3584	IOMR3MmioExNotifyUnmapped(pVM, pFirstMmio->pPhysHandlerR3->pvUserR3, GCPhys);
3585	}
3586
3587	/*
3588	* Unmap it.
3589	*/
3590	#ifdef VBOX_WITH_REM
3591	RTGCPHYS GCPhysRangeREM;
3592	bool fInformREM;
3593	#endif
3594	if (pFirstMmio->fFlags & PGMREGMMIORANGE_F_OVERLAPPING)
3595	{
3596	/*
3597	* We've replaced RAM, replace with zero pages.
3598	*
3599	* Note! This is where we might differ a little from a real system, because
3600	* it's likely to just show the RAM pages as they were before the
3601	* MMIO/MMIO2 region was mapped here.
3602	*/
3603	/* Only one chunk allowed when overlapping! */
3604	Assert(pFirstMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK);
3605
3606	/* Restore the RAM pages we've replaced. */
3607	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
3608	while (pRam->GCPhys > pFirstMmio->RamRange.GCPhysLast)
3609	pRam = pRam->pNextR3;
3610
3611	uint32_t cPagesLeft = pFirstMmio->RamRange.cb >> PAGE_SHIFT;
3612	if (pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2)
3613	pVM->pgm.s.cZeroPages += cPagesLeft;
3614
3615	PPGMPAGE pPageDst = &pRam->aPages[(pFirstMmio->RamRange.GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
3616	while (cPagesLeft-- > 0)
3617	{
3618	PGM_PAGE_INIT_ZERO(pPageDst, pVM, PGMPAGETYPE_RAM);
3619	pPageDst++;
3620	}
3621
3622	/* Flush physical page map TLB. */
3623	pgmPhysInvalidatePageMapTLB(pVM);
3624	#ifdef VBOX_WITH_REM
3625	GCPhysRangeREM = NIL_RTGCPHYS; /* shuts up gcc */
3626	fInformREM = false;
3627	#endif
3628
3629	/* Update range state. */
3630	pFirstMmio->RamRange.GCPhys = NIL_RTGCPHYS;
3631	pFirstMmio->RamRange.GCPhysLast = NIL_RTGCPHYS;
3632	pFirstMmio->fFlags &= ~(PGMREGMMIORANGE_F_OVERLAPPING \| PGMREGMMIORANGE_F_MAPPED);
3633	}
3634	else
3635	{
3636	/*
3637	* Unlink the chunks related to the MMIO/MMIO2 region.
3638	*/
3639	#ifdef VBOX_WITH_REM
3640	GCPhysRangeREM = pFirstMmio->RamRange.GCPhys;
3641	fInformREM = RT_BOOL(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MMIO2);
3642	#endif
3643	for (PPGMREGMMIORANGE pCurMmio = pFirstMmio; ; pCurMmio = pCurMmio->pNextR3)
3644	{
3645	pgmR3PhysUnlinkRamRange(pVM, &pCurMmio->RamRange);
3646	pCurMmio->RamRange.GCPhys = NIL_RTGCPHYS;
3647	pCurMmio->RamRange.GCPhysLast = NIL_RTGCPHYS;
3648	pCurMmio->fFlags &= ~(PGMREGMMIORANGE_F_OVERLAPPING \| PGMREGMMIORANGE_F_MAPPED);
3649	if (pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK)
3650	break;
3651	}
3652	}
3653
3654	/* Force a PGM pool flush as guest ram references have been changed. */
3655	/** @todo not entirely SMP safe; assuming for now the guest takes care
3656	* of this internally (not touch mapped mmio while changing the
3657	* mapping). */
3658	PVMCPU pVCpu = VMMGetCpu(pVM);
3659	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_CLEAR_PGM_POOL;
3660	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
3661
3662	pgmPhysInvalidatePageMapTLB(pVM);
3663	pgmPhysInvalidRamRangeTlbs(pVM);
3664
3665	pgmUnlock(pVM);
3666
3667	#ifdef VBOX_WITH_REM
3668	/*
3669	* Inform REM without holding the PGM lock.
3670	*/
3671	if (fInformREM)
3672	REMR3NotifyPhysRamDeregister(pVM, GCPhysRangeREM, cbRange);
3673	#endif
3674
3675	return VINF_SUCCESS;
3676	}
3677
3678
3679	/**
3680	* Reduces the mapping size of a MMIO2 or pre-registered MMIO region.
3681	*
3682	* This is mainly for dealing with old saved states after changing the default
3683	* size of a mapping region. See PGMDevHlpMMIOExReduce and
3684	* PDMPCIDEV::pfnRegionLoadChangeHookR3.
3685	*
3686	* The region must not currently be mapped when making this call. The VM state
3687	* must be state restore or VM construction.
3688	*
3689	* @returns VBox status code.
3690	* @param pVM The cross context VM structure.
3691	* @param pDevIns The device instance owning the region.
3692	* @param iSubDev The sub-device number of the registered region.
3693	* @param iRegion The index of the registered region.
3694	* @param cbRegion The new mapping size.
3695	*/
3696	VMMR3_INT_DECL(int) PGMR3PhysMMIOExReduce(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion, RTGCPHYS cbRegion)
3697	{
3698	/*
3699	* Validate input
3700	*/
3701	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3702	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3703	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
3704	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
3705	AssertReturn(cbRegion >= X86_PAGE_SIZE, VERR_INVALID_PARAMETER);
3706	AssertReturn(!(cbRegion & X86_PAGE_OFFSET_MASK), VERR_UNSUPPORTED_ALIGNMENT);
3707	VMSTATE enmVmState = VMR3GetState(pVM);
3708	AssertLogRelMsgReturn( enmVmState == VMSTATE_CREATING
3709	\|\| enmVmState == VMSTATE_LOADING,
3710	("enmVmState=%d (%s)\n", enmVmState, VMR3GetStateName(enmVmState)),
3711	VERR_VM_INVALID_VM_STATE);
3712
3713	int rc = pgmLock(pVM);
3714	AssertRCReturn(rc, rc);
3715
3716	PPGMREGMMIORANGE pFirstMmio = pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion);
3717	if (pFirstMmio)
3718	{
3719	Assert(pFirstMmio->fFlags & PGMREGMMIORANGE_F_FIRST_CHUNK);
3720	if (!(pFirstMmio->fFlags & PGMREGMMIORANGE_F_MAPPED))
3721	{
3722	/*
3723	* NOTE! Current implementation does not support multiple ranges.
3724	* Implement when there is a real world need and thus a testcase.
3725	*/
3726	AssertLogRelMsgStmt(pFirstMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK,
3727	("%s: %#x\n", pFirstMmio->RamRange.pszDesc, pFirstMmio->fFlags),
3728	rc = VERR_NOT_SUPPORTED);
3729	if (RT_SUCCESS(rc))
3730	{
3731	/*
3732	* Make the change.
3733	*/
3734	Log(("PGMR3PhysMMIOExReduce: %s changes from %RGp bytes (%RGp) to %RGp bytes.\n",
3735	pFirstMmio->RamRange.pszDesc, pFirstMmio->RamRange.cb, pFirstMmio->cbReal, cbRegion));
3736
3737	AssertLogRelMsgStmt(cbRegion <= pFirstMmio->cbReal,
3738	("%s: cbRegion=%#RGp cbReal=%#RGp\n", pFirstMmio->RamRange.pszDesc, cbRegion, pFirstMmio->cbReal),
3739	rc = VERR_OUT_OF_RANGE);
3740	if (RT_SUCCESS(rc))
3741	{
3742	pFirstMmio->RamRange.cb = cbRegion;
3743	}
3744	}
3745	}
3746	else
3747	rc = VERR_WRONG_ORDER;
3748	}
3749	else
3750	rc = VERR_NOT_FOUND;
3751
3752	pgmUnlock(pVM);
3753	return rc;
3754	}
3755
3756
3757	/**
3758	* Checks if the given address is an MMIO2 or pre-registered MMIO base address
3759	* or not.
3760	*
3761	* @returns true/false accordingly.
3762	* @param pVM The cross context VM structure.
3763	* @param pDevIns The owner of the memory, optional.
3764	* @param GCPhys The address to check.
3765	*/
3766	VMMR3DECL(bool) PGMR3PhysMMIOExIsBase(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhys)
3767	{
3768	/*
3769	* Validate input
3770	*/
3771	VM_ASSERT_EMT_RETURN(pVM, false);
3772	AssertPtrReturn(pDevIns, false);
3773	AssertReturn(GCPhys != NIL_RTGCPHYS, false);
3774	AssertReturn(GCPhys != 0, false);
3775	AssertReturn(!(GCPhys & PAGE_OFFSET_MASK), false);
3776
3777	/*
3778	* Search the list.
3779	*/
3780	pgmLock(pVM);
3781	for (PPGMREGMMIORANGE pCurMmio = pVM->pgm.s.pRegMmioRangesR3; pCurMmio; pCurMmio = pCurMmio->pNextR3)
3782	if (pCurMmio->RamRange.GCPhys == GCPhys)
3783	{
3784	Assert(pCurMmio->fFlags & PGMREGMMIORANGE_F_MAPPED);
3785	bool fRet = RT_BOOL(pCurMmio->fFlags & PGMREGMMIORANGE_F_FIRST_CHUNK);
3786	pgmUnlock(pVM);
3787	return fRet;
3788	}
3789	pgmUnlock(pVM);
3790	return false;
3791	}
3792
3793
3794	/**
3795	* Gets the HC physical address of a page in the MMIO2 region.
3796	*
3797	* This is API is intended for MMHyper and shouldn't be called
3798	* by anyone else...
3799	*
3800	* @returns VBox status code.
3801	* @param pVM The cross context VM structure.
3802	* @param pDevIns The owner of the memory, optional.
3803	* @param iSubDev Sub-device number.
3804	* @param iRegion The region.
3805	* @param off The page expressed an offset into the MMIO2 region.
3806	* @param pHCPhys Where to store the result.
3807	*/
3808	VMMR3_INT_DECL(int) PGMR3PhysMMIO2GetHCPhys(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion,
3809	RTGCPHYS off, PRTHCPHYS pHCPhys)
3810	{
3811	/*
3812	* Validate input
3813	*/
3814	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3815	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3816	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
3817	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
3818
3819	pgmLock(pVM);
3820	PPGMREGMMIORANGE pCurMmio = pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion);
3821	AssertReturn(pCurMmio, VERR_NOT_FOUND);
3822	AssertReturn(pCurMmio->fFlags & (PGMREGMMIORANGE_F_MMIO2 \| PGMREGMMIORANGE_F_FIRST_CHUNK), VERR_WRONG_TYPE);
3823
3824	while ( off >= pCurMmio->RamRange.cb
3825	&& !(pCurMmio->fFlags & PGMREGMMIORANGE_F_LAST_CHUNK))
3826	{
3827	off -= pCurMmio->RamRange.cb;
3828	pCurMmio = pCurMmio->pNextR3;
3829	}
3830	AssertReturn(off < pCurMmio->RamRange.cb, VERR_INVALID_PARAMETER);
3831
3832	PCPGMPAGE pPage = &pCurMmio->RamRange.aPages[off >> PAGE_SHIFT];
3833	*pHCPhys = PGM_PAGE_GET_HCPHYS(pPage);
3834	pgmUnlock(pVM);
3835	return VINF_SUCCESS;
3836	}
3837
3838
3839	/**
3840	* Maps a portion of an MMIO2 region into kernel space (host).
3841	*
3842	* The kernel mapping will become invalid when the MMIO2 memory is deregistered
3843	* or the VM is terminated.
3844	*
3845	* @return VBox status code.
3846	*
3847	* @param pVM The cross context VM structure.
3848	* @param pDevIns The device owning the MMIO2 memory.
3849	* @param iSubDev The sub-device number.
3850	* @param iRegion The region.
3851	* @param off The offset into the region. Must be page aligned.
3852	* @param cb The number of bytes to map. Must be page aligned.
3853	* @param pszDesc Mapping description.
3854	* @param pR0Ptr Where to store the R0 address.
3855	*/
3856	VMMR3_INT_DECL(int) PGMR3PhysMMIO2MapKernel(PVM pVM, PPDMDEVINS pDevIns, uint32_t iSubDev, uint32_t iRegion,
3857	RTGCPHYS off, RTGCPHYS cb, const char *pszDesc, PRTR0PTR pR0Ptr)
3858	{
3859	/*
3860	* Validate input.
3861	*/
3862	VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
3863	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3864	AssertReturn(iSubDev <= UINT8_MAX, VERR_INVALID_PARAMETER);
3865	AssertReturn(iRegion <= UINT8_MAX, VERR_INVALID_PARAMETER);
3866
3867	PPGMREGMMIORANGE pFirstRegMmio = pgmR3PhysMMIOExFind(pVM, pDevIns, iSubDev, iRegion);
3868	AssertReturn(pFirstRegMmio, VERR_NOT_FOUND);
3869	AssertReturn(pFirstRegMmio->fFlags & (PGMREGMMIORANGE_F_MMIO2 \| PGMREGMMIORANGE_F_FIRST_CHUNK), VERR_WRONG_TYPE);
3870	AssertReturn(off < pFirstRegMmio->RamRange.cb, VERR_INVALID_PARAMETER);
3871	AssertReturn(cb <= pFirstRegMmio->RamRange.cb, VERR_INVALID_PARAMETER);
3872	AssertReturn(off + cb <= pFirstRegMmio->RamRange.cb, VERR_INVALID_PARAMETER);
3873	NOREF(pszDesc);
3874
3875	/*
3876	* Pass the request on to the support library/driver.
3877	*/
3878	int rc = SUPR3PageMapKernel(pFirstRegMmio->pvR3, off, cb, 0, pR0Ptr);
3879
3880	return rc;
3881	}
3882
3883
3884	/**
3885	* Worker for PGMR3PhysRomRegister.
3886	*
3887	* This is here to simplify lock management, i.e. the caller does all the
3888	* locking and we can simply return without needing to remember to unlock
3889	* anything first.
3890	*
3891	* @returns VBox status code.
3892	* @param pVM The cross context VM structure.
3893	* @param pDevIns The device instance owning the ROM.
3894	* @param GCPhys First physical address in the range.
3895	* Must be page aligned!
3896	* @param cb The size of the range (in bytes).
3897	* Must be page aligned!
3898	* @param pvBinary Pointer to the binary data backing the ROM image.
3899	* @param cbBinary The size of the binary data pvBinary points to.
3900	* This must be less or equal to @a cb.
3901	* @param fFlags Mask of flags. PGMPHYS_ROM_FLAGS_SHADOWED
3902	* and/or PGMPHYS_ROM_FLAGS_PERMANENT_BINARY.
3903	* @param pszDesc Pointer to description string. This must not be freed.
3904	*/
3905	static int pgmR3PhysRomRegister(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhys, RTGCPHYS cb,
3906	const void pvBinary, uint32_t cbBinary, uint32_t fFlags, const char pszDesc)
3907	{
3908	/*
3909	* Validate input.
3910	*/
3911	AssertPtrReturn(pDevIns, VERR_INVALID_PARAMETER);
3912	AssertReturn(RT_ALIGN_T(GCPhys, PAGE_SIZE, RTGCPHYS) == GCPhys, VERR_INVALID_PARAMETER);
3913	AssertReturn(RT_ALIGN_T(cb, PAGE_SIZE, RTGCPHYS) == cb, VERR_INVALID_PARAMETER);
3914	RTGCPHYS GCPhysLast = GCPhys + (cb - 1);
3915	AssertReturn(GCPhysLast > GCPhys, VERR_INVALID_PARAMETER);
3916	AssertPtrReturn(pvBinary, VERR_INVALID_PARAMETER);
3917	AssertPtrReturn(pszDesc, VERR_INVALID_POINTER);
3918	AssertReturn(!(fFlags & ~(PGMPHYS_ROM_FLAGS_SHADOWED \| PGMPHYS_ROM_FLAGS_PERMANENT_BINARY)), VERR_INVALID_PARAMETER);
3919	VM_ASSERT_STATE_RETURN(pVM, VMSTATE_CREATING, VERR_VM_INVALID_VM_STATE);
3920
3921	const uint32_t cPages = cb >> PAGE_SHIFT;
3922
3923	/*
3924	* Find the ROM location in the ROM list first.
3925	*/
3926	PPGMROMRANGE pRomPrev = NULL;
3927	PPGMROMRANGE pRom = pVM->pgm.s.pRomRangesR3;
3928	while (pRom && GCPhysLast >= pRom->GCPhys)
3929	{
3930	if ( GCPhys <= pRom->GCPhysLast
3931	&& GCPhysLast >= pRom->GCPhys)
3932	AssertLogRelMsgFailedReturn(("%RGp-%RGp (%s) conflicts with existing %RGp-%RGp (%s)\n",
3933	GCPhys, GCPhysLast, pszDesc,
3934	pRom->GCPhys, pRom->GCPhysLast, pRom->pszDesc),
3935	VERR_PGM_RAM_CONFLICT);
3936	/* next */
3937	pRomPrev = pRom;
3938	pRom = pRom->pNextR3;
3939	}
3940
3941	/*
3942	* Find the RAM location and check for conflicts.
3943	*
3944	* Conflict detection is a bit different than for RAM
3945	* registration since a ROM can be located within a RAM
3946	* range. So, what we have to check for is other memory
3947	* types (other than RAM that is) and that we don't span
3948	* more than one RAM range (layz).
3949	*/
3950	bool fRamExists = false;
3951	PPGMRAMRANGE pRamPrev = NULL;
3952	PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
3953	while (pRam && GCPhysLast >= pRam->GCPhys)
3954	{
3955	if ( GCPhys <= pRam->GCPhysLast
3956	&& GCPhysLast >= pRam->GCPhys)
3957	{
3958	/* completely within? */
3959	AssertLogRelMsgReturn( GCPhys >= pRam->GCPhys
3960	&& GCPhysLast <= pRam->GCPhysLast,
3961	("%RGp-%RGp (%s) falls partly outside %RGp-%RGp (%s)\n",
3962	GCPhys, GCPhysLast, pszDesc,
3963	pRam->GCPhys, pRam->GCPhysLast, pRam->pszDesc),
3964	VERR_PGM_RAM_CONFLICT);
3965	fRamExists = true;
3966	break;
3967	}
3968
3969	/* next */
3970	pRamPrev = pRam;
3971	pRam = pRam->pNextR3;
3972	}
3973	if (fRamExists)
3974	{
3975	PPGMPAGE pPage = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
3976	uint32_t cPagesLeft = cPages;
3977	while (cPagesLeft-- > 0)
3978	{
3979	AssertLogRelMsgReturn(PGM_PAGE_GET_TYPE(pPage) == PGMPAGETYPE_RAM,
3980	("%RGp (%R[pgmpage]) isn't a RAM page - registering %RGp-%RGp (%s).\n",
3981	pRam->GCPhys + ((RTGCPHYS)(uintptr_t)(pPage - &pRam->aPages[0]) << PAGE_SHIFT),
3982	pPage, GCPhys, GCPhysLast, pszDesc), VERR_PGM_RAM_CONFLICT);
3983	Assert(PGM_PAGE_IS_ZERO(pPage));
3984	pPage++;
3985	}
3986	}
3987
3988	/*
3989	* Update the base memory reservation if necessary.
3990	*/
3991	uint32_t cExtraBaseCost = fRamExists ? 0 : cPages;
3992	if (fFlags & PGMPHYS_ROM_FLAGS_SHADOWED)
3993	cExtraBaseCost += cPages;
3994	if (cExtraBaseCost)
3995	{
3996	int rc = MMR3IncreaseBaseReservation(pVM, cExtraBaseCost);
3997	if (RT_FAILURE(rc))
3998	return rc;
3999	}
4000
4001	/*
4002	* Allocate memory for the virgin copy of the RAM.
4003	*/
4004	PGMMALLOCATEPAGESREQ pReq;
4005	int rc = GMMR3AllocatePagesPrepare(pVM, &pReq, cPages, GMMACCOUNT_BASE);
4006	AssertRCReturn(rc, rc);
4007
4008	for (uint32_t iPage = 0; iPage < cPages; iPage++)
4009	{
4010	pReq->aPages[iPage].HCPhysGCPhys = GCPhys + (iPage << PAGE_SHIFT);
4011	pReq->aPages[iPage].idPage = NIL_GMM_PAGEID;
4012	pReq->aPages[iPage].idSharedPage = NIL_GMM_PAGEID;
4013	}
4014
4015	rc = GMMR3AllocatePagesPerform(pVM, pReq);
4016	if (RT_FAILURE(rc))
4017	{
4018	GMMR3AllocatePagesCleanup(pReq);
4019	return rc;
4020	}
4021
4022	/*
4023	* Allocate the new ROM range and RAM range (if necessary).
4024	*/
4025	PPGMROMRANGE pRomNew;
4026	rc = MMHyperAlloc(pVM, RT_OFFSETOF(PGMROMRANGE, aPages[cPages]), 0, MM_TAG_PGM_PHYS, (void **)&pRomNew);
4027	if (RT_SUCCESS(rc))
4028	{
4029	PPGMRAMRANGE pRamNew = NULL;
4030	if (!fRamExists)
4031	rc = MMHyperAlloc(pVM, RT_OFFSETOF(PGMRAMRANGE, aPages[cPages]), sizeof(PGMPAGE), MM_TAG_PGM_PHYS, (void **)&pRamNew);
4032	if (RT_SUCCESS(rc))
4033	{
4034	/*
4035	* Initialize and insert the RAM range (if required).
4036	*/
4037	PPGMROMPAGE pRomPage = &pRomNew->aPages[0];
4038	if (!fRamExists)
4039	{
4040	pRamNew->pSelfR0 = MMHyperCCToR0(pVM, pRamNew);
4041	pRamNew->pSelfRC = MMHyperCCToRC(pVM, pRamNew);
4042	pRamNew->GCPhys = GCPhys;
4043	pRamNew->GCPhysLast = GCPhysLast;
4044	pRamNew->cb = cb;
4045	pRamNew->pszDesc = pszDesc;
4046	pRamNew->fFlags = PGM_RAM_RANGE_FLAGS_AD_HOC_ROM;
4047	pRamNew->pvR3 = NULL;
4048	pRamNew->paLSPages = NULL;
4049
4050	PPGMPAGE pPage = &pRamNew->aPages[0];
4051	for (uint32_t iPage = 0; iPage < cPages; iPage++, pPage++, pRomPage++)
4052	{
4053	PGM_PAGE_INIT(pPage,
4054	pReq->aPages[iPage].HCPhysGCPhys,
4055	pReq->aPages[iPage].idPage,
4056	PGMPAGETYPE_ROM,
4057	PGM_PAGE_STATE_ALLOCATED);
4058
4059	pRomPage->Virgin = *pPage;
4060	}
4061
4062	pVM->pgm.s.cAllPages += cPages;
4063	pgmR3PhysLinkRamRange(pVM, pRamNew, pRamPrev);
4064	}
4065	else
4066	{
4067	PPGMPAGE pPage = &pRam->aPages[(GCPhys - pRam->GCPhys) >> PAGE_SHIFT];
4068	for (uint32_t iPage = 0; iPage < cPages; iPage++, pPage++, pRomPage++)
4069	{
4070	PGM_PAGE_SET_TYPE(pVM, pPage, PGMPAGETYPE_ROM);
4071	PGM_PAGE_SET_HCPHYS(pVM, pPage, pReq->aPages[iPage].HCPhysGCPhys);
4072	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ALLOCATED);
4073	PGM_PAGE_SET_PAGEID(pVM, pPage, pReq->aPages[iPage].idPage);
4074	PGM_PAGE_SET_PDE_TYPE(pVM, pPage, PGM_PAGE_PDE_TYPE_DONTCARE);
4075	PGM_PAGE_SET_PTE_INDEX(pVM, pPage, 0);
4076	PGM_PAGE_SET_TRACKING(pVM, pPage, 0);
4077
4078	pRomPage->Virgin = *pPage;
4079	}
4080
4081	pRamNew = pRam;
4082
4083	pVM->pgm.s.cZeroPages -= cPages;
4084	}
4085	pVM->pgm.s.cPrivatePages += cPages;
4086
4087	/* Flush physical page map TLB. */
4088	pgmPhysInvalidatePageMapTLB(pVM);
4089
4090
4091	/*
4092	* !HACK ALERT! REM + (Shadowed) ROM ==> mess.
4093	*
4094	* If it's shadowed we'll register the handler after the ROM notification
4095	* so we get the access handler callbacks that we should. If it isn't
4096	* shadowed we'll do it the other way around to make REM use the built-in
4097	* ROM behavior and not the handler behavior (which is to route all access
4098	* to PGM atm).
4099	*/
4100	if (fFlags & PGMPHYS_ROM_FLAGS_SHADOWED)
4101	{
4102	#ifdef VBOX_WITH_REM
4103	REMR3NotifyPhysRomRegister(pVM, GCPhys, cb, NULL, true /* fShadowed */);
4104	#endif
4105	rc = PGMHandlerPhysicalRegister(pVM, GCPhys, GCPhysLast, pVM->pgm.s.hRomPhysHandlerType,
4106	pRomNew, MMHyperCCToR0(pVM, pRomNew), MMHyperCCToRC(pVM, pRomNew),
4107	pszDesc);
4108	}
4109	else
4110	{
4111	rc = PGMHandlerPhysicalRegister(pVM, GCPhys, GCPhysLast, pVM->pgm.s.hRomPhysHandlerType,
4112	pRomNew, MMHyperCCToR0(pVM, pRomNew), MMHyperCCToRC(pVM, pRomNew),
4113	pszDesc);
4114	#ifdef VBOX_WITH_REM
4115	REMR3NotifyPhysRomRegister(pVM, GCPhys, cb, NULL, false /* fShadowed */);
4116	#endif
4117	}
4118	if (RT_SUCCESS(rc))
4119	{
4120	/*
4121	* Copy the image over to the virgin pages.
4122	* This must be done after linking in the RAM range.
4123	*/
4124	size_t cbBinaryLeft = cbBinary;
4125	PPGMPAGE pRamPage = &pRamNew->aPages[(GCPhys - pRamNew->GCPhys) >> PAGE_SHIFT];
4126	for (uint32_t iPage = 0; iPage < cPages; iPage++, pRamPage++)
4127	{
4128	void *pvDstPage;
4129	rc = pgmPhysPageMap(pVM, pRamPage, GCPhys + (iPage << PAGE_SHIFT), &pvDstPage);
4130	if (RT_FAILURE(rc))
4131	{
4132	VMSetError(pVM, rc, RT_SRC_POS, "Failed to map virgin ROM page at %RGp", GCPhys);
4133	break;
4134	}
4135	if (cbBinaryLeft >= PAGE_SIZE)
4136	{
4137	memcpy(pvDstPage, (uint8_t const *)pvBinary + ((size_t)iPage << PAGE_SHIFT), PAGE_SIZE);
4138	cbBinaryLeft -= PAGE_SIZE;
4139	}
4140	else
4141	{
4142	ASMMemZeroPage(pvDstPage); /* (shouldn't be necessary, but can't hurt either) */
4143	if (cbBinaryLeft > 0)
4144	{
4145	memcpy(pvDstPage, (uint8_t const *)pvBinary + ((size_t)iPage << PAGE_SHIFT), cbBinaryLeft);
4146	cbBinaryLeft = 0;
4147	}
4148	}
4149	}
4150	if (RT_SUCCESS(rc))
4151	{
4152	/*
4153	* Initialize the ROM range.
4154	* Note that the Virgin member of the pages has already been initialized above.
4155	*/
4156	pRomNew->GCPhys = GCPhys;
4157	pRomNew->GCPhysLast = GCPhysLast;
4158	pRomNew->cb = cb;
4159	pRomNew->fFlags = fFlags;
4160	pRomNew->idSavedState = UINT8_MAX;
4161	pRomNew->cbOriginal = cbBinary;
4162	pRomNew->pszDesc = pszDesc;
4163	pRomNew->pvOriginal = fFlags & PGMPHYS_ROM_FLAGS_PERMANENT_BINARY
4164	? pvBinary : RTMemDup(pvBinary, cbBinary);
4165	if (pRomNew->pvOriginal)
4166	{
4167	for (unsigned iPage = 0; iPage < cPages; iPage++)
4168	{
4169	PPGMROMPAGE pPage = &pRomNew->aPages[iPage];
4170	pPage->enmProt = PGMROMPROT_READ_ROM_WRITE_IGNORE;
4171	PGM_PAGE_INIT_ZERO(&pPage->Shadow, pVM, PGMPAGETYPE_ROM_SHADOW);
4172	}
4173
4174	/* update the page count stats for the shadow pages. */
4175	if (fFlags & PGMPHYS_ROM_FLAGS_SHADOWED)
4176	{
4177	pVM->pgm.s.cZeroPages += cPages;
4178	pVM->pgm.s.cAllPages += cPages;
4179	}
4180
4181	/*
4182	* Insert the ROM range, tell REM and return successfully.
4183	*/
4184	pRomNew->pNextR3 = pRom;
4185	pRomNew->pNextR0 = pRom ? MMHyperCCToR0(pVM, pRom) : NIL_RTR0PTR;
4186	pRomNew->pNextRC = pRom ? MMHyperCCToRC(pVM, pRom) : NIL_RTRCPTR;
4187
4188	if (pRomPrev)
4189	{
4190	pRomPrev->pNextR3 = pRomNew;
4191	pRomPrev->pNextR0 = MMHyperCCToR0(pVM, pRomNew);
4192	pRomPrev->pNextRC = MMHyperCCToRC(pVM, pRomNew);
4193	}
4194	else
4195	{
4196	pVM->pgm.s.pRomRangesR3 = pRomNew;
4197	pVM->pgm.s.pRomRangesR0 = MMHyperCCToR0(pVM, pRomNew);
4198	pVM->pgm.s.pRomRangesRC = MMHyperCCToRC(pVM, pRomNew);
4199	}
4200
4201	pgmPhysInvalidatePageMapTLB(pVM);
4202	GMMR3AllocatePagesCleanup(pReq);
4203	return VINF_SUCCESS;
4204	}
4205
4206	/* bail out */
4207	rc = VERR_NO_MEMORY;
4208	}
4209
4210	int rc2 = PGMHandlerPhysicalDeregister(pVM, GCPhys);
4211	AssertRC(rc2);
4212	}
4213
4214	if (!fRamExists)
4215	{
4216	pgmR3PhysUnlinkRamRange2(pVM, pRamNew, pRamPrev);
4217	MMHyperFree(pVM, pRamNew);
4218	}
4219	}
4220	MMHyperFree(pVM, pRomNew);
4221	}
4222
4223	/** @todo Purge the mapping cache or something... */
4224	GMMR3FreeAllocatedPages(pVM, pReq);
4225	GMMR3AllocatePagesCleanup(pReq);
4226	return rc;
4227	}
4228
4229
4230	/**
4231	* Registers a ROM image.
4232	*
4233	* Shadowed ROM images requires double the amount of backing memory, so,
4234	* don't use that unless you have to. Shadowing of ROM images is process
4235	* where we can select where the reads go and where the writes go. On real
4236	* hardware the chipset provides means to configure this. We provide
4237	* PGMR3PhysProtectROM() for this purpose.
4238	*
4239	* A read-only copy of the ROM image will always be kept around while we
4240	* will allocate RAM pages for the changes on demand (unless all memory
4241	* is configured to be preallocated).
4242	*
4243	* @returns VBox status code.
4244	* @param pVM The cross context VM structure.
4245	* @param pDevIns The device instance owning the ROM.
4246	* @param GCPhys First physical address in the range.
4247	* Must be page aligned!
4248	* @param cb The size of the range (in bytes).
4249	* Must be page aligned!
4250	* @param pvBinary Pointer to the binary data backing the ROM image.
4251	* @param cbBinary The size of the binary data pvBinary points to.
4252	* This must be less or equal to @a cb.
4253	* @param fFlags Mask of flags. PGMPHYS_ROM_FLAGS_SHADOWED
4254	* and/or PGMPHYS_ROM_FLAGS_PERMANENT_BINARY.
4255	* @param pszDesc Pointer to description string. This must not be freed.
4256	*
4257	* @remark There is no way to remove the rom, automatically on device cleanup or
4258	* manually from the device yet. This isn't difficult in any way, it's
4259	* just not something we expect to be necessary for a while.
4260	*/
4261	VMMR3DECL(int) PGMR3PhysRomRegister(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhys, RTGCPHYS cb,
4262	const void pvBinary, uint32_t cbBinary, uint32_t fFlags, const char pszDesc)
4263	{
4264	Log(("PGMR3PhysRomRegister: pDevIns=%p GCPhys=%RGp(-%RGp) cb=%RGp pvBinary=%p cbBinary=%#x fFlags=%#x pszDesc=%s\n",
4265	pDevIns, GCPhys, GCPhys + cb, cb, pvBinary, cbBinary, fFlags, pszDesc));
4266	pgmLock(pVM);
4267	int rc = pgmR3PhysRomRegister(pVM, pDevIns, GCPhys, cb, pvBinary, cbBinary, fFlags, pszDesc);
4268	pgmUnlock(pVM);
4269	return rc;
4270	}
4271
4272
4273	/**
4274	* Called by PGMR3MemSetup to reset the shadow, switch to the virgin, and verify
4275	* that the virgin part is untouched.
4276	*
4277	* This is done after the normal memory has been cleared.
4278	*
4279	* ASSUMES that the caller owns the PGM lock.
4280	*
4281	* @param pVM The cross context VM structure.
4282	*/
4283	int pgmR3PhysRomReset(PVM pVM)
4284	{
4285	PGM_LOCK_ASSERT_OWNER(pVM);
4286	for (PPGMROMRANGE pRom = pVM->pgm.s.pRomRangesR3; pRom; pRom = pRom->pNextR3)
4287	{
4288	const uint32_t cPages = pRom->cb >> PAGE_SHIFT;
4289
4290	if (pRom->fFlags & PGMPHYS_ROM_FLAGS_SHADOWED)
4291	{
4292	/*
4293	* Reset the physical handler.
4294	*/
4295	int rc = PGMR3PhysRomProtect(pVM, pRom->GCPhys, pRom->cb, PGMROMPROT_READ_ROM_WRITE_IGNORE);
4296	AssertRCReturn(rc, rc);
4297
4298	/*
4299	* What we do with the shadow pages depends on the memory
4300	* preallocation option. If not enabled, we'll just throw
4301	* out all the dirty pages and replace them by the zero page.
4302	*/
4303	if (!pVM->pgm.s.fRamPreAlloc)
4304	{
4305	/* Free the dirty pages. */
4306	uint32_t cPendingPages = 0;
4307	PGMMFREEPAGESREQ pReq;
4308	rc = GMMR3FreePagesPrepare(pVM, &pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
4309	AssertRCReturn(rc, rc);
4310
4311	for (uint32_t iPage = 0; iPage < cPages; iPage++)
4312	if ( !PGM_PAGE_IS_ZERO(&pRom->aPages[iPage].Shadow)
4313	&& !PGM_PAGE_IS_BALLOONED(&pRom->aPages[iPage].Shadow))
4314	{
4315	Assert(PGM_PAGE_GET_STATE(&pRom->aPages[iPage].Shadow) == PGM_PAGE_STATE_ALLOCATED);
4316	rc = pgmPhysFreePage(pVM, pReq, &cPendingPages, &pRom->aPages[iPage].Shadow,
4317	pRom->GCPhys + (iPage << PAGE_SHIFT));
4318	AssertLogRelRCReturn(rc, rc);
4319	}
4320
4321	if (cPendingPages)
4322	{
4323	rc = GMMR3FreePagesPerform(pVM, pReq, cPendingPages);
4324	AssertLogRelRCReturn(rc, rc);
4325	}
4326	GMMR3FreePagesCleanup(pReq);
4327	}
4328	else
4329	{
4330	/* clear all the shadow pages. */
4331	for (uint32_t iPage = 0; iPage < cPages; iPage++)
4332	{
4333	if (PGM_PAGE_IS_ZERO(&pRom->aPages[iPage].Shadow))
4334	continue;
4335	Assert(!PGM_PAGE_IS_BALLOONED(&pRom->aPages[iPage].Shadow));
4336	void *pvDstPage;
4337	const RTGCPHYS GCPhys = pRom->GCPhys + (iPage << PAGE_SHIFT);
4338	rc = pgmPhysPageMakeWritableAndMap(pVM, &pRom->aPages[iPage].Shadow, GCPhys, &pvDstPage);
4339	if (RT_FAILURE(rc))
4340	break;
4341	ASMMemZeroPage(pvDstPage);
4342	}
4343	AssertRCReturn(rc, rc);
4344	}
4345	}
4346
4347	/*
4348	* Restore the original ROM pages after a saved state load.
4349	* Also, in strict builds check that ROM pages remain unmodified.
4350	*/
4351	#ifndef VBOX_STRICT
4352	if (pVM->pgm.s.fRestoreRomPagesOnReset)
4353	#endif
4354	{
4355	size_t cbSrcLeft = pRom->cbOriginal;
4356	uint8_t const pbSrcPage = (uint8_t const )pRom->pvOriginal;
4357	uint32_t cRestored = 0;
4358	for (uint32_t iPage = 0; iPage < cPages && cbSrcLeft > 0; iPage++, pbSrcPage += PAGE_SIZE)
4359	{
4360	const RTGCPHYS GCPhys = pRom->GCPhys + (iPage << PAGE_SHIFT);
4361	void const *pvDstPage;
4362	int rc = pgmPhysPageMapReadOnly(pVM, &pRom->aPages[iPage].Virgin, GCPhys, &pvDstPage);
4363	if (RT_FAILURE(rc))
4364	break;
4365
4366	if (memcmp(pvDstPage, pbSrcPage, RT_MIN(cbSrcLeft, PAGE_SIZE)))
4367	{
4368	if (pVM->pgm.s.fRestoreRomPagesOnReset)
4369	{
4370	void *pvDstPageW;
4371	rc = pgmPhysPageMap(pVM, &pRom->aPages[iPage].Virgin, GCPhys, &pvDstPageW);
4372	AssertLogRelRCReturn(rc, rc);
4373	memcpy(pvDstPageW, pbSrcPage, RT_MIN(cbSrcLeft, PAGE_SIZE));
4374	cRestored++;
4375	}
4376	else
4377	LogRel(("pgmR3PhysRomReset: %RGp: ROM page changed (%s)\n", GCPhys, pRom->pszDesc));
4378	}
4379	cbSrcLeft -= RT_MIN(cbSrcLeft, PAGE_SIZE);
4380	}
4381	if (cRestored > 0)
4382	LogRel(("PGM: ROM \"%s\": Reloaded %u of %u pages.\n", pRom->pszDesc, cRestored, cPages));
4383	}
4384	}
4385
4386	/* Clear the ROM restore flag now as we only need to do this once after
4387	loading saved state. */
4388	pVM->pgm.s.fRestoreRomPagesOnReset = false;
4389
4390	return VINF_SUCCESS;
4391	}
4392
4393
4394	/**
4395	* Called by PGMR3Term to free resources.
4396	*
4397	* ASSUMES that the caller owns the PGM lock.
4398	*
4399	* @param pVM The cross context VM structure.
4400	*/
4401	void pgmR3PhysRomTerm(PVM pVM)
4402	{
4403	/*
4404	* Free the heap copy of the original bits.
4405	*/
4406	for (PPGMROMRANGE pRom = pVM->pgm.s.pRomRangesR3; pRom; pRom = pRom->pNextR3)
4407	{
4408	if ( pRom->pvOriginal
4409	&& !(pRom->fFlags & PGMPHYS_ROM_FLAGS_PERMANENT_BINARY))
4410	{
4411	RTMemFree((void *)pRom->pvOriginal);
4412	pRom->pvOriginal = NULL;
4413	}
4414	}
4415	}
4416
4417
4418	/**
4419	* Change the shadowing of a range of ROM pages.
4420	*
4421	* This is intended for implementing chipset specific memory registers
4422	* and will not be very strict about the input. It will silently ignore
4423	* any pages that are not the part of a shadowed ROM.
4424	*
4425	* @returns VBox status code.
4426	* @retval VINF_PGM_SYNC_CR3
4427	*
4428	* @param pVM The cross context VM structure.
4429	* @param GCPhys Where to start. Page aligned.
4430	* @param cb How much to change. Page aligned.
4431	* @param enmProt The new ROM protection.
4432	*/
4433	VMMR3DECL(int) PGMR3PhysRomProtect(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, PGMROMPROT enmProt)
4434	{
4435	/*
4436	* Check input
4437	*/
4438	if (!cb)
4439	return VINF_SUCCESS;
4440	AssertReturn(!(GCPhys & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
4441	AssertReturn(!(cb & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
4442	RTGCPHYS GCPhysLast = GCPhys + (cb - 1);
4443	AssertReturn(GCPhysLast > GCPhys, VERR_INVALID_PARAMETER);
4444	AssertReturn(enmProt >= PGMROMPROT_INVALID && enmProt <= PGMROMPROT_END, VERR_INVALID_PARAMETER);
4445
4446	/*
4447	* Process the request.
4448	*/
4449	pgmLock(pVM);
4450	int rc = VINF_SUCCESS;
4451	bool fFlushTLB = false;
4452	for (PPGMROMRANGE pRom = pVM->pgm.s.pRomRangesR3; pRom; pRom = pRom->pNextR3)
4453	{
4454	if ( GCPhys <= pRom->GCPhysLast
4455	&& GCPhysLast >= pRom->GCPhys
4456	&& (pRom->fFlags & PGMPHYS_ROM_FLAGS_SHADOWED))
4457	{
4458	/*
4459	* Iterate the relevant pages and make necessary the changes.
4460	*/
4461	bool fChanges = false;
4462	uint32_t const cPages = pRom->GCPhysLast <= GCPhysLast
4463	? pRom->cb >> PAGE_SHIFT
4464	: (GCPhysLast - pRom->GCPhys + 1) >> PAGE_SHIFT;
4465	for (uint32_t iPage = (GCPhys - pRom->GCPhys) >> PAGE_SHIFT;
4466	iPage < cPages;
4467	iPage++)
4468	{
4469	PPGMROMPAGE pRomPage = &pRom->aPages[iPage];
4470	if (PGMROMPROT_IS_ROM(pRomPage->enmProt) != PGMROMPROT_IS_ROM(enmProt))
4471	{
4472	fChanges = true;
4473
4474	/* flush references to the page. */
4475	PPGMPAGE pRamPage = pgmPhysGetPage(pVM, pRom->GCPhys + (iPage << PAGE_SHIFT));
4476	int rc2 = pgmPoolTrackUpdateGCPhys(pVM, pRom->GCPhys + (iPage << PAGE_SHIFT), pRamPage,
4477	true /fFlushPTEs/, &fFlushTLB);
4478	if (rc2 != VINF_SUCCESS && (rc == VINF_SUCCESS \|\| RT_FAILURE(rc2)))
4479	rc = rc2;
4480
4481	PPGMPAGE pOld = PGMROMPROT_IS_ROM(pRomPage->enmProt) ? &pRomPage->Virgin : &pRomPage->Shadow;
4482	PPGMPAGE pNew = PGMROMPROT_IS_ROM(pRomPage->enmProt) ? &pRomPage->Shadow : &pRomPage->Virgin;
4483
4484	pOld = pRamPage;
4485	pRamPage = pNew;
4486	/** @todo preserve the volatile flags (handlers) when these have been moved out of HCPhys! */
4487	}
4488	pRomPage->enmProt = enmProt;
4489	}
4490
4491	/*
4492	* Reset the access handler if we made changes, no need
4493	* to optimize this.
4494	*/
4495	if (fChanges)
4496	{
4497	int rc2 = PGMHandlerPhysicalReset(pVM, pRom->GCPhys);
4498	if (RT_FAILURE(rc2))
4499	{
4500	pgmUnlock(pVM);
4501	AssertRC(rc);
4502	return rc2;
4503	}
4504	}
4505
4506	/* Advance - cb isn't updated. */
4507	GCPhys = pRom->GCPhys + (cPages << PAGE_SHIFT);
4508	}
4509	}
4510	pgmUnlock(pVM);
4511	if (fFlushTLB)
4512	PGM_INVL_ALL_VCPU_TLBS(pVM);
4513
4514	return rc;
4515	}
4516
4517
4518	/**
4519	* Sets the Address Gate 20 state.
4520	*
4521	* @param pVCpu The cross context virtual CPU structure.
4522	* @param fEnable True if the gate should be enabled.
4523	* False if the gate should be disabled.
4524	*/
4525	VMMDECL(void) PGMR3PhysSetA20(PVMCPU pVCpu, bool fEnable)
4526	{
4527	LogFlow(("PGMR3PhysSetA20 %d (was %d)\n", fEnable, pVCpu->pgm.s.fA20Enabled));
4528	if (pVCpu->pgm.s.fA20Enabled != fEnable)
4529	{
4530	pVCpu->pgm.s.fA20Enabled = fEnable;
4531	pVCpu->pgm.s.GCPhysA20Mask = ~((RTGCPHYS)!fEnable << 20);
4532	#ifdef VBOX_WITH_REM
4533	REMR3A20Set(pVCpu->pVMR3, pVCpu, fEnable);
4534	#endif
4535	#ifdef PGM_WITH_A20
4536	pVCpu->pgm.s.fSyncFlags \|= PGM_SYNC_UPDATE_PAGE_BIT_VIRTUAL;
4537	VMCPU_FF_SET(pVCpu, VMCPU_FF_PGM_SYNC_CR3);
4538	pgmR3RefreshShadowModeAfterA20Change(pVCpu);
4539	HMFlushTLB(pVCpu);
4540	#endif
4541	IEMTlbInvalidateAllPhysical(pVCpu);
4542	STAM_REL_COUNTER_INC(&pVCpu->pgm.s.cA20Changes);
4543	}
4544	}
4545
4546
4547	/**
4548	* Tree enumeration callback for dealing with age rollover.
4549	* It will perform a simple compression of the current age.
4550	*/
4551	static DECLCALLBACK(int) pgmR3PhysChunkAgeingRolloverCallback(PAVLU32NODECORE pNode, void *pvUser)
4552	{
4553	/* Age compression - ASSUMES iNow == 4. */
4554	PPGMCHUNKR3MAP pChunk = (PPGMCHUNKR3MAP)pNode;
4555	if (pChunk->iLastUsed >= UINT32_C(0xffffff00))
4556	pChunk->iLastUsed = 3;
4557	else if (pChunk->iLastUsed >= UINT32_C(0xfffff000))
4558	pChunk->iLastUsed = 2;
4559	else if (pChunk->iLastUsed)
4560	pChunk->iLastUsed = 1;
4561	else /* iLastUsed = 0 */
4562	pChunk->iLastUsed = 4;
4563
4564	NOREF(pvUser);
4565	return 0;
4566	}
4567
4568
4569	/**
4570	* The structure passed in the pvUser argument of pgmR3PhysChunkUnmapCandidateCallback().
4571	*/
4572	typedef struct PGMR3PHYSCHUNKUNMAPCB
4573	{
4574	PVM pVM; /*< Pointer to the VM. /
4575	PPGMCHUNKR3MAP pChunk; /*< The chunk to unmap. /
4576	} PGMR3PHYSCHUNKUNMAPCB, *PPGMR3PHYSCHUNKUNMAPCB;
4577
4578
4579	/**
4580	* Callback used to find the mapping that's been unused for
4581	* the longest time.
4582	*/
4583	static DECLCALLBACK(int) pgmR3PhysChunkUnmapCandidateCallback(PAVLU32NODECORE pNode, void *pvUser)
4584	{
4585	PPGMCHUNKR3MAP pChunk = (PPGMCHUNKR3MAP)pNode;
4586	PPGMR3PHYSCHUNKUNMAPCB pArg = (PPGMR3PHYSCHUNKUNMAPCB)pvUser;
4587
4588	/*
4589	* Check for locks and compare when last used.
4590	*/
4591	if (pChunk->cRefs)
4592	return 0;
4593	if (pChunk->cPermRefs)
4594	return 0;
4595	if ( pArg->pChunk
4596	&& pChunk->iLastUsed >= pArg->pChunk->iLastUsed)
4597	return 0;
4598
4599	/*
4600	* Check that it's not in any of the TLBs.
4601	*/
4602	PVM pVM = pArg->pVM;
4603	if ( pVM->pgm.s.ChunkR3Map.Tlb.aEntries[PGM_CHUNKR3MAPTLB_IDX(pChunk->Core.Key)].idChunk
4604	== pChunk->Core.Key)
4605	{
4606	pChunk = NULL;
4607	return 0;
4608	}
4609	#ifdef VBOX_STRICT
4610	for (unsigned i = 0; i < RT_ELEMENTS(pVM->pgm.s.ChunkR3Map.Tlb.aEntries); i++)
4611	{
4612	Assert(pVM->pgm.s.ChunkR3Map.Tlb.aEntries[i].pChunk != pChunk);
4613	Assert(pVM->pgm.s.ChunkR3Map.Tlb.aEntries[i].idChunk != pChunk->Core.Key);
4614	}
4615	#endif
4616
4617	for (unsigned i = 0; i < RT_ELEMENTS(pVM->pgm.s.PhysTlbHC.aEntries); i++)
4618	if (pVM->pgm.s.PhysTlbHC.aEntries[i].pMap == pChunk)
4619	return 0;
4620
4621	pArg->pChunk = pChunk;
4622	return 0;
4623	}
4624
4625
4626	/**
4627	* Finds a good candidate for unmapping when the ring-3 mapping cache is full.
4628	*
4629	* The candidate will not be part of any TLBs, so no need to flush
4630	* anything afterwards.
4631	*
4632	* @returns Chunk id.
4633	* @param pVM The cross context VM structure.
4634	*/
4635	static int32_t pgmR3PhysChunkFindUnmapCandidate(PVM pVM)
4636	{
4637	PGM_LOCK_ASSERT_OWNER(pVM);
4638
4639	/*
4640	* Enumerate the age tree starting with the left most node.
4641	*/
4642	STAM_PROFILE_START(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkFindCandidate, a);
4643	PGMR3PHYSCHUNKUNMAPCB Args;
4644	Args.pVM = pVM;
4645	Args.pChunk = NULL;
4646	RTAvlU32DoWithAll(&pVM->pgm.s.ChunkR3Map.pTree, true /fFromLeft/, pgmR3PhysChunkUnmapCandidateCallback, &Args);
4647	Assert(Args.pChunk);
4648	if (Args.pChunk)
4649	{
4650	Assert(Args.pChunk->cRefs == 0);
4651	Assert(Args.pChunk->cPermRefs == 0);
4652	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkFindCandidate, a);
4653	return Args.pChunk->Core.Key;
4654	}
4655
4656	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkFindCandidate, a);
4657	return INT32_MAX;
4658	}
4659
4660
4661	/**
4662	* Rendezvous callback used by pgmR3PhysUnmapChunk that unmaps a chunk
4663	*
4664	* This is only called on one of the EMTs while the other ones are waiting for
4665	* it to complete this function.
4666	*
4667	* @returns VINF_SUCCESS (VBox strict status code).
4668	* @param pVM The cross context VM structure.
4669	* @param pVCpu The cross context virtual CPU structure of the calling EMT. Unused.
4670	* @param pvUser User pointer. Unused
4671	*
4672	*/
4673	static DECLCALLBACK(VBOXSTRICTRC) pgmR3PhysUnmapChunkRendezvous(PVM pVM, PVMCPU pVCpu, void *pvUser)
4674	{
4675	int rc = VINF_SUCCESS;
4676	pgmLock(pVM);
4677	NOREF(pVCpu); NOREF(pvUser);
4678
4679	if (pVM->pgm.s.ChunkR3Map.c >= pVM->pgm.s.ChunkR3Map.cMax)
4680	{
4681	/* Flush the pgm pool cache; call the internal rendezvous handler as we're already in a rendezvous handler here. */
4682	/** @todo also not really efficient to unmap a chunk that contains PD
4683	* or PT pages. */
4684	pgmR3PoolClearAllRendezvous(pVM, &pVM->aCpus[0], NULL /* no need to flush the REM TLB as we already did that above */);
4685
4686	/*
4687	* Request the ring-0 part to unmap a chunk to make space in the mapping cache.
4688	*/
4689	GMMMAPUNMAPCHUNKREQ Req;
4690	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
4691	Req.Hdr.cbReq = sizeof(Req);
4692	Req.pvR3 = NULL;
4693	Req.idChunkMap = NIL_GMM_CHUNKID;
4694	Req.idChunkUnmap = pgmR3PhysChunkFindUnmapCandidate(pVM);
4695	if (Req.idChunkUnmap != INT32_MAX)
4696	{
4697	STAM_PROFILE_START(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkUnmap, a);
4698	rc = VMMR3CallR0(pVM, VMMR0_DO_GMM_MAP_UNMAP_CHUNK, 0, &Req.Hdr);
4699	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkUnmap, a);
4700	if (RT_SUCCESS(rc))
4701	{
4702	/*
4703	* Remove the unmapped one.
4704	*/
4705	PPGMCHUNKR3MAP pUnmappedChunk = (PPGMCHUNKR3MAP)RTAvlU32Remove(&pVM->pgm.s.ChunkR3Map.pTree, Req.idChunkUnmap);
4706	AssertRelease(pUnmappedChunk);
4707	AssertRelease(!pUnmappedChunk->cRefs);
4708	AssertRelease(!pUnmappedChunk->cPermRefs);
4709	pUnmappedChunk->pv = NULL;
4710	pUnmappedChunk->Core.Key = UINT32_MAX;
4711	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
4712	MMR3HeapFree(pUnmappedChunk);
4713	#else
4714	MMR3UkHeapFree(pVM, pUnmappedChunk, MM_TAG_PGM_CHUNK_MAPPING);
4715	#endif
4716	pVM->pgm.s.ChunkR3Map.c--;
4717	pVM->pgm.s.cUnmappedChunks++;
4718
4719	/*
4720	* Flush dangling PGM pointers (R3 & R0 ptrs to GC physical addresses).
4721	*/
4722	/** @todo We should not flush chunks which include cr3 mappings. */
4723	for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
4724	{
4725	PPGMCPU pPGM = &pVM->aCpus[idCpu].pgm.s;
4726
4727	pPGM->pGst32BitPdR3 = NULL;
4728	pPGM->pGstPaePdptR3 = NULL;
4729	pPGM->pGstAmd64Pml4R3 = NULL;
4730	#ifndef VBOX_WITH_2X_4GB_ADDR_SPACE
4731	pPGM->pGst32BitPdR0 = NIL_RTR0PTR;
4732	pPGM->pGstPaePdptR0 = NIL_RTR0PTR;
4733	pPGM->pGstAmd64Pml4R0 = NIL_RTR0PTR;
4734	#endif
4735	for (unsigned i = 0; i < RT_ELEMENTS(pPGM->apGstPaePDsR3); i++)
4736	{
4737	pPGM->apGstPaePDsR3[i] = NULL;
4738	#ifndef VBOX_WITH_2X_4GB_ADDR_SPACE
4739	pPGM->apGstPaePDsR0[i] = NIL_RTR0PTR;
4740	#endif
4741	}
4742
4743	/* Flush REM TLBs. */
4744	CPUMSetChangedFlags(&pVM->aCpus[idCpu], CPUM_CHANGED_GLOBAL_TLB_FLUSH);
4745	}
4746	#ifdef VBOX_WITH_REM
4747	/* Flush REM translation blocks. */
4748	REMFlushTBs(pVM);
4749	#endif
4750	}
4751	}
4752	}
4753	pgmUnlock(pVM);
4754	return rc;
4755	}
4756
4757	/**
4758	* Unmap a chunk to free up virtual address space (request packet handler for pgmR3PhysChunkMap)
4759	*
4760	* @returns VBox status code.
4761	* @param pVM The cross context VM structure.
4762	*/
4763	void pgmR3PhysUnmapChunk(PVM pVM)
4764	{
4765	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, pgmR3PhysUnmapChunkRendezvous, NULL);
4766	AssertRC(rc);
4767	}
4768
4769
4770	/**
4771	* Maps the given chunk into the ring-3 mapping cache.
4772	*
4773	* This will call ring-0.
4774	*
4775	* @returns VBox status code.
4776	* @param pVM The cross context VM structure.
4777	* @param idChunk The chunk in question.
4778	* @param ppChunk Where to store the chunk tracking structure.
4779	*
4780	* @remarks Called from within the PGM critical section.
4781	* @remarks Can be called from any thread!
4782	*/
4783	int pgmR3PhysChunkMap(PVM pVM, uint32_t idChunk, PPPGMCHUNKR3MAP ppChunk)
4784	{
4785	int rc;
4786
4787	PGM_LOCK_ASSERT_OWNER(pVM);
4788
4789	/*
4790	* Move the chunk time forward.
4791	*/
4792	pVM->pgm.s.ChunkR3Map.iNow++;
4793	if (pVM->pgm.s.ChunkR3Map.iNow == 0)
4794	{
4795	pVM->pgm.s.ChunkR3Map.iNow = 4;
4796	RTAvlU32DoWithAll(&pVM->pgm.s.ChunkR3Map.pTree, true /fFromLeft/, pgmR3PhysChunkAgeingRolloverCallback, NULL);
4797	}
4798
4799	/*
4800	* Allocate a new tracking structure first.
4801	*/
4802	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
4803	PPGMCHUNKR3MAP pChunk = (PPGMCHUNKR3MAP)MMR3HeapAllocZ(pVM, MM_TAG_PGM_CHUNK_MAPPING, sizeof(*pChunk));
4804	#else
4805	PPGMCHUNKR3MAP pChunk = (PPGMCHUNKR3MAP)MMR3UkHeapAllocZ(pVM, MM_TAG_PGM_CHUNK_MAPPING, sizeof(*pChunk), NULL);
4806	#endif
4807	AssertReturn(pChunk, VERR_NO_MEMORY);
4808	pChunk->Core.Key = idChunk;
4809	pChunk->iLastUsed = pVM->pgm.s.ChunkR3Map.iNow;
4810
4811	/*
4812	* Request the ring-0 part to map the chunk in question.
4813	*/
4814	GMMMAPUNMAPCHUNKREQ Req;
4815	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
4816	Req.Hdr.cbReq = sizeof(Req);
4817	Req.pvR3 = NULL;
4818	Req.idChunkMap = idChunk;
4819	Req.idChunkUnmap = NIL_GMM_CHUNKID;
4820
4821	/* Must be callable from any thread, so can't use VMMR3CallR0. */
4822	STAM_PROFILE_START(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkMap, a);
4823	rc = SUPR3CallVMMR0Ex(pVM->pVMR0, NIL_VMCPUID, VMMR0_DO_GMM_MAP_UNMAP_CHUNK, 0, &Req.Hdr);
4824	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatChunkMap, a);
4825	if (RT_SUCCESS(rc))
4826	{
4827	pChunk->pv = Req.pvR3;
4828
4829	/*
4830	* If we're running out of virtual address space, then we should
4831	* unmap another chunk.
4832	*
4833	* Currently, an unmap operation requires that all other virtual CPUs
4834	* are idling and not by chance making use of the memory we're
4835	* unmapping. So, we create an async unmap operation here.
4836	*
4837	* Now, when creating or restoring a saved state this wont work very
4838	* well since we may want to restore all guest RAM + a little something.
4839	* So, we have to do the unmap synchronously. Fortunately for us
4840	* though, during these operations the other virtual CPUs are inactive
4841	* and it should be safe to do this.
4842	*/
4843	/** @todo Eventually we should lock all memory when used and do
4844	* map+unmap as one kernel call without any rendezvous or
4845	* other precautions. */
4846	if (pVM->pgm.s.ChunkR3Map.c + 1 >= pVM->pgm.s.ChunkR3Map.cMax)
4847	{
4848	switch (VMR3GetState(pVM))
4849	{
4850	case VMSTATE_LOADING:
4851	case VMSTATE_SAVING:
4852	{
4853	PVMCPU pVCpu = VMMGetCpu(pVM);
4854	if ( pVCpu
4855	&& pVM->pgm.s.cDeprecatedPageLocks == 0)
4856	{
4857	pgmR3PhysUnmapChunkRendezvous(pVM, pVCpu, NULL);
4858	break;
4859	}
4860	}
4861	RT_FALL_THRU();
4862	default:
4863	rc = VMR3ReqCallNoWait(pVM, VMCPUID_ANY_QUEUE, (PFNRT)pgmR3PhysUnmapChunk, 1, pVM);
4864	AssertRC(rc);
4865	break;
4866	}
4867	}
4868
4869	/*
4870	* Update the tree. We must do this after any unmapping to make sure
4871	* the chunk we're going to return isn't unmapped by accident.
4872	*/
4873	AssertPtr(Req.pvR3);
4874	bool fRc = RTAvlU32Insert(&pVM->pgm.s.ChunkR3Map.pTree, &pChunk->Core);
4875	AssertRelease(fRc);
4876	pVM->pgm.s.ChunkR3Map.c++;
4877	pVM->pgm.s.cMappedChunks++;
4878	}
4879	else
4880	{
4881	/** @todo this may fail because of /proc/sys/vm/max_map_count, so we
4882	* should probably restrict ourselves on linux. */
4883	AssertRC(rc);
4884	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
4885	MMR3HeapFree(pChunk);
4886	#else
4887	MMR3UkHeapFree(pVM, pChunk, MM_TAG_PGM_CHUNK_MAPPING);
4888	#endif
4889	pChunk = NULL;
4890	}
4891
4892	*ppChunk = pChunk;
4893	return rc;
4894	}
4895
4896
4897	/**
4898	* For VMMCALLRING3_PGM_MAP_CHUNK, considered internal.
4899	*
4900	* @returns see pgmR3PhysChunkMap.
4901	* @param pVM The cross context VM structure.
4902	* @param idChunk The chunk to map.
4903	*/
4904	VMMR3DECL(int) PGMR3PhysChunkMap(PVM pVM, uint32_t idChunk)
4905	{
4906	PPGMCHUNKR3MAP pChunk;
4907	int rc;
4908
4909	pgmLock(pVM);
4910	rc = pgmR3PhysChunkMap(pVM, idChunk, &pChunk);
4911	pgmUnlock(pVM);
4912	return rc;
4913	}
4914
4915
4916	/**
4917	* Invalidates the TLB for the ring-3 mapping cache.
4918	*
4919	* @param pVM The cross context VM structure.
4920	*/
4921	VMMR3DECL(void) PGMR3PhysChunkInvalidateTLB(PVM pVM)
4922	{
4923	pgmLock(pVM);
4924	for (unsigned i = 0; i < RT_ELEMENTS(pVM->pgm.s.ChunkR3Map.Tlb.aEntries); i++)
4925	{
4926	pVM->pgm.s.ChunkR3Map.Tlb.aEntries[i].idChunk = NIL_GMM_CHUNKID;
4927	pVM->pgm.s.ChunkR3Map.Tlb.aEntries[i].pChunk = NULL;
4928	}
4929	/* The page map TLB references chunks, so invalidate that one too. */
4930	pgmPhysInvalidatePageMapTLB(pVM);
4931	pgmUnlock(pVM);
4932	}
4933
4934
4935	/**
4936	* Response to VMMCALLRING3_PGM_ALLOCATE_LARGE_HANDY_PAGE to allocate a large
4937	* (2MB) page for use with a nested paging PDE.
4938	*
4939	* @returns The following VBox status codes.
4940	* @retval VINF_SUCCESS on success.
4941	* @retval VINF_EM_NO_MEMORY if we're out of memory.
4942	*
4943	* @param pVM The cross context VM structure.
4944	* @param GCPhys GC physical start address of the 2 MB range
4945	*/
4946	VMMR3DECL(int) PGMR3PhysAllocateLargeHandyPage(PVM pVM, RTGCPHYS GCPhys)
4947	{
4948	#ifdef PGM_WITH_LARGE_PAGES
4949	uint64_t u64TimeStamp1, u64TimeStamp2;
4950
4951	pgmLock(pVM);
4952
4953	STAM_PROFILE_START(&pVM->pgm.s.CTX_SUFF(pStats)->StatAllocLargePage, a);
4954	u64TimeStamp1 = RTTimeMilliTS();
4955	int rc = VMMR3CallR0(pVM, VMMR0_DO_PGM_ALLOCATE_LARGE_HANDY_PAGE, 0, NULL);
4956	u64TimeStamp2 = RTTimeMilliTS();
4957	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatAllocLargePage, a);
4958	if (RT_SUCCESS(rc))
4959	{
4960	Assert(pVM->pgm.s.cLargeHandyPages == 1);
4961
4962	uint32_t idPage = pVM->pgm.s.aLargeHandyPage[0].idPage;
4963	RTHCPHYS HCPhys = pVM->pgm.s.aLargeHandyPage[0].HCPhysGCPhys;
4964
4965	void *pv;
4966
4967	/* Map the large page into our address space.
4968	*
4969	* Note: assuming that within the 2 MB range:
4970	* - GCPhys + PAGE_SIZE = HCPhys + PAGE_SIZE (whole point of this exercise)
4971	* - user space mapping is continuous as well
4972	* - page id (GCPhys) + 1 = page id (GCPhys + PAGE_SIZE)
4973	*/
4974	rc = pgmPhysPageMapByPageID(pVM, idPage, HCPhys, &pv);
4975	AssertLogRelMsg(RT_SUCCESS(rc), ("idPage=%#x HCPhysGCPhys=%RHp rc=%Rrc\n", idPage, HCPhys, rc));
4976
4977	if (RT_SUCCESS(rc))
4978	{
4979	/*
4980	* Clear the pages.
4981	*/
4982	STAM_PROFILE_START(&pVM->pgm.s.CTX_SUFF(pStats)->StatClearLargePage, b);
4983	for (unsigned i = 0; i < _2M/PAGE_SIZE; i++)
4984	{
4985	ASMMemZeroPage(pv);
4986
4987	PPGMPAGE pPage;
4988	rc = pgmPhysGetPageEx(pVM, GCPhys, &pPage);
4989	AssertRC(rc);
4990
4991	Assert(PGM_PAGE_IS_ZERO(pPage));
4992	STAM_COUNTER_INC(&pVM->pgm.s.CTX_SUFF(pStats)->StatRZPageReplaceZero);
4993	pVM->pgm.s.cZeroPages--;
4994
4995	/*
4996	* Do the PGMPAGE modifications.
4997	*/
4998	pVM->pgm.s.cPrivatePages++;
4999	PGM_PAGE_SET_HCPHYS(pVM, pPage, HCPhys);
5000	PGM_PAGE_SET_PAGEID(pVM, pPage, idPage);
5001	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ALLOCATED);
5002	PGM_PAGE_SET_PDE_TYPE(pVM, pPage, PGM_PAGE_PDE_TYPE_PDE);
5003	PGM_PAGE_SET_PTE_INDEX(pVM, pPage, 0);
5004	PGM_PAGE_SET_TRACKING(pVM, pPage, 0);
5005
5006	/* Somewhat dirty assumption that page ids are increasing. */
5007	idPage++;
5008
5009	HCPhys += PAGE_SIZE;
5010	GCPhys += PAGE_SIZE;
5011
5012	pv = (void *)((uintptr_t)pv + PAGE_SIZE);
5013
5014	Log3(("PGMR3PhysAllocateLargePage: idPage=%#x HCPhys=%RGp\n", idPage, HCPhys));
5015	}
5016	STAM_PROFILE_STOP(&pVM->pgm.s.CTX_SUFF(pStats)->StatClearLargePage, b);
5017
5018	/* Flush all TLBs. */
5019	PGM_INVL_ALL_VCPU_TLBS(pVM);
5020	pgmPhysInvalidatePageMapTLB(pVM);
5021	}
5022	pVM->pgm.s.cLargeHandyPages = 0;
5023	}
5024
5025	if (RT_SUCCESS(rc))
5026	{
5027	static uint32_t cTimeOut = 0;
5028	uint64_t u64TimeStampDelta = u64TimeStamp2 - u64TimeStamp1;
5029
5030	if (u64TimeStampDelta > 100)
5031	{
5032	STAM_COUNTER_INC(&pVM->pgm.s.CTX_SUFF(pStats)->StatLargePageOverflow);
5033	if ( ++cTimeOut > 10
5034	\|\| u64TimeStampDelta > 1000 /* more than one second forces an early retirement from allocating large pages. */)
5035	{
5036	/* If repeated attempts to allocate a large page takes more than 100 ms, then we fall back to normal 4k pages.
5037	* E.g. Vista 64 tries to move memory around, which takes a huge amount of time.
5038	*/
5039	LogRel(("PGMR3PhysAllocateLargePage: allocating large pages takes too long (last attempt %d ms; nr of timeouts %d); DISABLE\n", u64TimeStampDelta, cTimeOut));
5040	PGMSetLargePageUsage(pVM, false);
5041	}
5042	}
5043	else
5044	if (cTimeOut > 0)
5045	cTimeOut--;
5046	}
5047
5048	pgmUnlock(pVM);
5049	return rc;
5050	#else
5051	RT_NOREF(pVM, GCPhys);
5052	return VERR_NOT_IMPLEMENTED;
5053	#endif /* PGM_WITH_LARGE_PAGES */
5054	}
5055
5056
5057	/**
5058	* Response to VM_FF_PGM_NEED_HANDY_PAGES and VMMCALLRING3_PGM_ALLOCATE_HANDY_PAGES.
5059	*
5060	* This function will also work the VM_FF_PGM_NO_MEMORY force action flag, to
5061	* signal and clear the out of memory condition. When contracted, this API is
5062	* used to try clear the condition when the user wants to resume.
5063	*
5064	* @returns The following VBox status codes.
5065	* @retval VINF_SUCCESS on success. FFs cleared.
5066	* @retval VINF_EM_NO_MEMORY if we're out of memory. The FF is not cleared in
5067	* this case and it gets accompanied by VM_FF_PGM_NO_MEMORY.
5068	*
5069	* @param pVM The cross context VM structure.
5070	*
5071	* @remarks The VINF_EM_NO_MEMORY status is for the benefit of the FF processing
5072	* in EM.cpp and shouldn't be propagated outside TRPM, HM, EM and
5073	* pgmPhysEnsureHandyPage. There is one exception to this in the \#PF
5074	* handler.
5075	*/
5076	VMMR3DECL(int) PGMR3PhysAllocateHandyPages(PVM pVM)
5077	{
5078	pgmLock(pVM);
5079
5080	/*
5081	* Allocate more pages, noting down the index of the first new page.
5082	*/
5083	uint32_t iClear = pVM->pgm.s.cHandyPages;
5084	AssertMsgReturn(iClear <= RT_ELEMENTS(pVM->pgm.s.aHandyPages), ("%d", iClear), VERR_PGM_HANDY_PAGE_IPE);
5085	Log(("PGMR3PhysAllocateHandyPages: %d -> %d\n", iClear, RT_ELEMENTS(pVM->pgm.s.aHandyPages)));
5086	int rcAlloc = VINF_SUCCESS;
5087	int rcSeed = VINF_SUCCESS;
5088	int rc = VMMR3CallR0(pVM, VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES, 0, NULL);
5089	while (rc == VERR_GMM_SEED_ME)
5090	{
5091	void *pvChunk;
5092	rcAlloc = rc = SUPR3PageAlloc(GMM_CHUNK_SIZE >> PAGE_SHIFT, &pvChunk);
5093	if (RT_SUCCESS(rc))
5094	{
5095	rcSeed = rc = VMMR3CallR0(pVM, VMMR0_DO_GMM_SEED_CHUNK, (uintptr_t)pvChunk, NULL);
5096	if (RT_FAILURE(rc))
5097	SUPR3PageFree(pvChunk, GMM_CHUNK_SIZE >> PAGE_SHIFT);
5098	}
5099	if (RT_SUCCESS(rc))
5100	rc = VMMR3CallR0(pVM, VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES, 0, NULL);
5101	}
5102
5103	/** @todo we should split this up into an allocate and flush operation. sometimes you want to flush and not allocate more (which will trigger the vm account limit error) */
5104	if ( rc == VERR_GMM_HIT_VM_ACCOUNT_LIMIT
5105	&& pVM->pgm.s.cHandyPages > 0)
5106	{
5107	/* Still handy pages left, so don't panic. */
5108	rc = VINF_SUCCESS;
5109	}
5110
5111	if (RT_SUCCESS(rc))
5112	{
5113	AssertMsg(rc == VINF_SUCCESS, ("%Rrc\n", rc));
5114	Assert(pVM->pgm.s.cHandyPages > 0);
5115	VM_FF_CLEAR(pVM, VM_FF_PGM_NEED_HANDY_PAGES);
5116	VM_FF_CLEAR(pVM, VM_FF_PGM_NO_MEMORY);
5117
5118	#ifdef VBOX_STRICT
5119	uint32_t i;
5120	for (i = iClear; i < pVM->pgm.s.cHandyPages; i++)
5121	if ( pVM->pgm.s.aHandyPages[i].idPage == NIL_GMM_PAGEID
5122	\|\| pVM->pgm.s.aHandyPages[i].idSharedPage != NIL_GMM_PAGEID
5123	\|\| (pVM->pgm.s.aHandyPages[i].HCPhysGCPhys & PAGE_OFFSET_MASK))
5124	break;
5125	if (i != pVM->pgm.s.cHandyPages)
5126	{
5127	RTAssertMsg1Weak(NULL, __LINE__, __FILE__, __FUNCTION__);
5128	RTAssertMsg2Weak("i=%d iClear=%d cHandyPages=%d\n", i, iClear, pVM->pgm.s.cHandyPages);
5129	for (uint32_t j = iClear; j < pVM->pgm.s.cHandyPages; j++)
5130	RTAssertMsg2Add("%03d: idPage=%d HCPhysGCPhys=%RHp idSharedPage=%d%\n", j,
5131	pVM->pgm.s.aHandyPages[j].idPage,
5132	pVM->pgm.s.aHandyPages[j].HCPhysGCPhys,
5133	pVM->pgm.s.aHandyPages[j].idSharedPage,
5134	j == i ? " <---" : "");
5135	RTAssertPanic();
5136	}
5137	#endif
5138	/*
5139	* Clear the pages.
5140	*/
5141	while (iClear < pVM->pgm.s.cHandyPages)
5142	{
5143	PGMMPAGEDESC pPage = &pVM->pgm.s.aHandyPages[iClear];
5144	void *pv;
5145	rc = pgmPhysPageMapByPageID(pVM, pPage->idPage, pPage->HCPhysGCPhys, &pv);
5146	AssertLogRelMsgBreak(RT_SUCCESS(rc),
5147	("%u/%u: idPage=%#x HCPhysGCPhys=%RHp rc=%Rrc\n",
5148	iClear, pVM->pgm.s.cHandyPages, pPage->idPage, pPage->HCPhysGCPhys, rc));
5149	ASMMemZeroPage(pv);
5150	iClear++;
5151	Log3(("PGMR3PhysAllocateHandyPages: idPage=%#x HCPhys=%RGp\n", pPage->idPage, pPage->HCPhysGCPhys));
5152	}
5153	}
5154	else
5155	{
5156	uint64_t cAllocPages, cMaxPages, cBalloonPages;
5157
5158	/*
5159	* We should never get here unless there is a genuine shortage of
5160	* memory (or some internal error). Flag the error so the VM can be
5161	* suspended ASAP and the user informed. If we're totally out of
5162	* handy pages we will return failure.
5163	*/
5164	/* Report the failure. */
5165	LogRel(("PGM: Failed to procure handy pages; rc=%Rrc rcAlloc=%Rrc rcSeed=%Rrc cHandyPages=%#x\n"
5166	" cAllPages=%#x cPrivatePages=%#x cSharedPages=%#x cZeroPages=%#x\n",
5167	rc, rcAlloc, rcSeed,
5168	pVM->pgm.s.cHandyPages,
5169	pVM->pgm.s.cAllPages,
5170	pVM->pgm.s.cPrivatePages,
5171	pVM->pgm.s.cSharedPages,
5172	pVM->pgm.s.cZeroPages));
5173
5174	if (GMMR3QueryMemoryStats(pVM, &cAllocPages, &cMaxPages, &cBalloonPages) == VINF_SUCCESS)
5175	{
5176	LogRel(("GMM: Statistics:\n"
5177	" Allocated pages: %RX64\n"
5178	" Maximum pages: %RX64\n"
5179	" Ballooned pages: %RX64\n", cAllocPages, cMaxPages, cBalloonPages));
5180	}
5181
5182	if ( rc != VERR_NO_MEMORY
5183	&& rc != VERR_NO_PHYS_MEMORY
5184	&& rc != VERR_LOCK_FAILED)
5185	{
5186	for (uint32_t i = 0; i < RT_ELEMENTS(pVM->pgm.s.aHandyPages); i++)
5187	{
5188	LogRel(("PGM: aHandyPages[#%#04x] = {.HCPhysGCPhys=%RHp, .idPage=%#08x, .idSharedPage=%#08x}\n",
5189	i, pVM->pgm.s.aHandyPages[i].HCPhysGCPhys, pVM->pgm.s.aHandyPages[i].idPage,
5190	pVM->pgm.s.aHandyPages[i].idSharedPage));
5191	uint32_t const idPage = pVM->pgm.s.aHandyPages[i].idPage;
5192	if (idPage != NIL_GMM_PAGEID)
5193	{
5194	for (PPGMRAMRANGE pRam = pVM->pgm.s.pRamRangesXR3;
5195	pRam;
5196	pRam = pRam->pNextR3)
5197	{
5198	uint32_t const cPages = pRam->cb >> PAGE_SHIFT;
5199	for (uint32_t iPage = 0; iPage < cPages; iPage++)
5200	if (PGM_PAGE_GET_PAGEID(&pRam->aPages[iPage]) == idPage)
5201	LogRel(("PGM: Used by %RGp %R[pgmpage] (%s)\n",
5202	pRam->GCPhys + ((RTGCPHYS)iPage << PAGE_SHIFT), &pRam->aPages[iPage], pRam->pszDesc));
5203	}
5204	}
5205	}
5206	}
5207
5208	if (rc == VERR_NO_MEMORY)
5209	{
5210	uint64_t cbHostRamAvail = 0;
5211	int rc2 = RTSystemQueryAvailableRam(&cbHostRamAvail);
5212	if (RT_SUCCESS(rc2))
5213	LogRel(("Host RAM: %RU64MB available\n", cbHostRamAvail / _1M));
5214	else
5215	LogRel(("Cannot determine the amount of available host memory\n"));
5216	}
5217
5218	/* Set the FFs and adjust rc. */
5219	VM_FF_SET(pVM, VM_FF_PGM_NEED_HANDY_PAGES);
5220	VM_FF_SET(pVM, VM_FF_PGM_NO_MEMORY);
5221	if ( rc == VERR_NO_MEMORY
5222	\|\| rc == VERR_NO_PHYS_MEMORY
5223	\|\| rc == VERR_LOCK_FAILED)
5224	rc = VINF_EM_NO_MEMORY;
5225	}
5226
5227	pgmUnlock(pVM);
5228	return rc;
5229	}
5230
5231
5232	/**
5233	* Frees the specified RAM page and replaces it with the ZERO page.
5234	*
5235	* This is used by ballooning, remapping MMIO2, RAM reset and state loading.
5236	*
5237	* @param pVM The cross context VM structure.
5238	* @param pReq Pointer to the request.
5239	* @param pcPendingPages Where the number of pages waiting to be freed are
5240	* kept. This will normally be incremented.
5241	* @param pPage Pointer to the page structure.
5242	* @param GCPhys The guest physical address of the page, if applicable.
5243	*
5244	* @remarks The caller must own the PGM lock.
5245	*/
5246	int pgmPhysFreePage(PVM pVM, PGMMFREEPAGESREQ pReq, uint32_t *pcPendingPages, PPGMPAGE pPage, RTGCPHYS GCPhys)
5247	{
5248	/*
5249	* Assert sanity.
5250	*/
5251	PGM_LOCK_ASSERT_OWNER(pVM);
5252	if (RT_UNLIKELY( PGM_PAGE_GET_TYPE(pPage) != PGMPAGETYPE_RAM
5253	&& PGM_PAGE_GET_TYPE(pPage) != PGMPAGETYPE_ROM_SHADOW))
5254	{
5255	AssertMsgFailed(("GCPhys=%RGp pPage=%R[pgmpage]\n", GCPhys, pPage));
5256	return VMSetError(pVM, VERR_PGM_PHYS_NOT_RAM, RT_SRC_POS, "GCPhys=%RGp type=%d", GCPhys, PGM_PAGE_GET_TYPE(pPage));
5257	}
5258
5259	/** @todo What about ballooning of large pages??! */
5260	Assert( PGM_PAGE_GET_PDE_TYPE(pPage) != PGM_PAGE_PDE_TYPE_PDE
5261	&& PGM_PAGE_GET_PDE_TYPE(pPage) != PGM_PAGE_PDE_TYPE_PDE_DISABLED);
5262
5263	if ( PGM_PAGE_IS_ZERO(pPage)
5264	\|\| PGM_PAGE_IS_BALLOONED(pPage))
5265	return VINF_SUCCESS;
5266
5267	const uint32_t idPage = PGM_PAGE_GET_PAGEID(pPage);
5268	Log3(("pgmPhysFreePage: idPage=%#x GCPhys=%RGp pPage=%R[pgmpage]\n", idPage, GCPhys, pPage));
5269	if (RT_UNLIKELY( idPage == NIL_GMM_PAGEID
5270	\|\| idPage > GMM_PAGEID_LAST
5271	\|\| PGM_PAGE_GET_CHUNKID(pPage) == NIL_GMM_CHUNKID))
5272	{
5273	AssertMsgFailed(("GCPhys=%RGp pPage=%R[pgmpage]\n", GCPhys, pPage));
5274	return VMSetError(pVM, VERR_PGM_PHYS_INVALID_PAGE_ID, RT_SRC_POS, "GCPhys=%RGp idPage=%#x", GCPhys, pPage);
5275	}
5276
5277	/* update page count stats. */
5278	if (PGM_PAGE_IS_SHARED(pPage))
5279	pVM->pgm.s.cSharedPages--;
5280	else
5281	pVM->pgm.s.cPrivatePages--;
5282	pVM->pgm.s.cZeroPages++;
5283
5284	/* Deal with write monitored pages. */
5285	if (PGM_PAGE_GET_STATE(pPage) == PGM_PAGE_STATE_WRITE_MONITORED)
5286	{
5287	PGM_PAGE_SET_WRITTEN_TO(pVM, pPage);
5288	pVM->pgm.s.cWrittenToPages++;
5289	}
5290
5291	/*
5292	* pPage = ZERO page.
5293	*/
5294	PGM_PAGE_SET_HCPHYS(pVM, pPage, pVM->pgm.s.HCPhysZeroPg);
5295	PGM_PAGE_SET_STATE(pVM, pPage, PGM_PAGE_STATE_ZERO);
5296	PGM_PAGE_SET_PAGEID(pVM, pPage, NIL_GMM_PAGEID);
5297	PGM_PAGE_SET_PDE_TYPE(pVM, pPage, PGM_PAGE_PDE_TYPE_DONTCARE);
5298	PGM_PAGE_SET_PTE_INDEX(pVM, pPage, 0);
5299	PGM_PAGE_SET_TRACKING(pVM, pPage, 0);
5300
5301	/* Flush physical page map TLB entry. */
5302	pgmPhysInvalidatePageMapTLBEntry(pVM, GCPhys);
5303
5304	/*
5305	* Make sure it's not in the handy page array.
5306	*/
5307	for (uint32_t i = pVM->pgm.s.cHandyPages; i < RT_ELEMENTS(pVM->pgm.s.aHandyPages); i++)
5308	{
5309	if (pVM->pgm.s.aHandyPages[i].idPage == idPage)
5310	{
5311	pVM->pgm.s.aHandyPages[i].idPage = NIL_GMM_PAGEID;
5312	break;
5313	}
5314	if (pVM->pgm.s.aHandyPages[i].idSharedPage == idPage)
5315	{
5316	pVM->pgm.s.aHandyPages[i].idSharedPage = NIL_GMM_PAGEID;
5317	break;
5318	}
5319	}
5320
5321	/*
5322	* Push it onto the page array.
5323	*/
5324	uint32_t iPage = *pcPendingPages;
5325	Assert(iPage < PGMPHYS_FREE_PAGE_BATCH_SIZE);
5326	*pcPendingPages += 1;
5327
5328	pReq->aPages[iPage].idPage = idPage;
5329
5330	if (iPage + 1 < PGMPHYS_FREE_PAGE_BATCH_SIZE)
5331	return VINF_SUCCESS;
5332
5333	/*
5334	* Flush the pages.
5335	*/
5336	int rc = GMMR3FreePagesPerform(pVM, pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE);
5337	if (RT_SUCCESS(rc))
5338	{
5339	GMMR3FreePagesRePrep(pVM, pReq, PGMPHYS_FREE_PAGE_BATCH_SIZE, GMMACCOUNT_BASE);
5340	*pcPendingPages = 0;
5341	}
5342	return rc;
5343	}
5344
5345
5346	/**
5347	* Converts a GC physical address to a HC ring-3 pointer, with some
5348	* additional checks.
5349	*
5350	* @returns VBox status code.
5351	* @retval VINF_SUCCESS on success.
5352	* @retval VINF_PGM_PHYS_TLB_CATCH_WRITE and *ppv set if the page has a write
5353	* access handler of some kind.
5354	* @retval VERR_PGM_PHYS_TLB_CATCH_ALL if the page has a handler catching all
5355	* accesses or is odd in any way.
5356	* @retval VERR_PGM_PHYS_TLB_UNASSIGNED if the page doesn't exist.
5357	*
5358	* @param pVM The cross context VM structure.
5359	* @param GCPhys The GC physical address to convert. Since this is only
5360	* used for filling the REM TLB, the A20 mask must be
5361	* applied before calling this API.
5362	* @param fWritable Whether write access is required.
5363	* @param ppv Where to store the pointer corresponding to GCPhys on
5364	* success.
5365	*/
5366	VMMR3DECL(int) PGMR3PhysTlbGCPhys2Ptr(PVM pVM, RTGCPHYS GCPhys, bool fWritable, void **ppv)
5367	{
5368	pgmLock(pVM);
5369	PGM_A20_ASSERT_MASKED(VMMGetCpu(pVM), GCPhys);
5370
5371	PPGMRAMRANGE pRam;
5372	PPGMPAGE pPage;
5373	int rc = pgmPhysGetPageAndRangeEx(pVM, GCPhys, &pPage, &pRam);
5374	if (RT_SUCCESS(rc))
5375	{
5376	if (PGM_PAGE_IS_BALLOONED(pPage))
5377	rc = VINF_PGM_PHYS_TLB_CATCH_WRITE;
5378	else if (!PGM_PAGE_HAS_ANY_HANDLERS(pPage))
5379	rc = VINF_SUCCESS;
5380	else
5381	{
5382	if (PGM_PAGE_HAS_ACTIVE_ALL_HANDLERS(pPage)) /* catches MMIO */
5383	rc = VERR_PGM_PHYS_TLB_CATCH_ALL;
5384	else if (PGM_PAGE_HAS_ACTIVE_HANDLERS(pPage))
5385	{
5386	/** @todo Handle TLB loads of virtual handlers so ./test.sh can be made to work
5387	* in -norawr0 mode. */
5388	if (fWritable)
5389	rc = VINF_PGM_PHYS_TLB_CATCH_WRITE;
5390	}
5391	else
5392	{
5393	/* Temporarily disabled physical handler(s), since the recompiler
5394	doesn't get notified when it's reset we'll have to pretend it's
5395	operating normally. */
5396	if (pgmHandlerPhysicalIsAll(pVM, GCPhys))
5397	rc = VERR_PGM_PHYS_TLB_CATCH_ALL;
5398	else
5399	rc = VINF_PGM_PHYS_TLB_CATCH_WRITE;
5400	}
5401	}
5402	if (RT_SUCCESS(rc))
5403	{
5404	int rc2;
5405
5406	/* Make sure what we return is writable. */
5407	if (fWritable)
5408	switch (PGM_PAGE_GET_STATE(pPage))
5409	{
5410	case PGM_PAGE_STATE_ALLOCATED:
5411	break;
5412	case PGM_PAGE_STATE_BALLOONED:
5413	AssertFailed();
5414	break;
5415	case PGM_PAGE_STATE_ZERO:
5416	case PGM_PAGE_STATE_SHARED:
5417	if (rc == VINF_PGM_PHYS_TLB_CATCH_WRITE)
5418	break;
5419	RT_FALL_THRU();
5420	case PGM_PAGE_STATE_WRITE_MONITORED:
5421	rc2 = pgmPhysPageMakeWritable(pVM, pPage, GCPhys & ~(RTGCPHYS)PAGE_OFFSET_MASK);
5422	AssertLogRelRCReturn(rc2, rc2);
5423	break;
5424	}
5425
5426	/* Get a ring-3 mapping of the address. */
5427	PPGMPAGER3MAPTLBE pTlbe;
5428	rc2 = pgmPhysPageQueryTlbe(pVM, GCPhys, &pTlbe);
5429	AssertLogRelRCReturn(rc2, rc2);
5430	ppv = (void )((uintptr_t)pTlbe->pv \| (uintptr_t)(GCPhys & PAGE_OFFSET_MASK));
5431	/** @todo mapping/locking hell; this isn't horribly efficient since
5432	* pgmPhysPageLoadIntoTlb will repeat the lookup we've done here. */
5433
5434	Log6(("PGMR3PhysTlbGCPhys2Ptr: GCPhys=%RGp rc=%Rrc pPage=%R[pgmpage] ppv=%p\n", GCPhys, rc, pPage, ppv));
5435	}
5436	else
5437	Log6(("PGMR3PhysTlbGCPhys2Ptr: GCPhys=%RGp rc=%Rrc pPage=%R[pgmpage]\n", GCPhys, rc, pPage));
5438
5439	/* else: handler catching all access, no pointer returned. */
5440	}
5441	else
5442	rc = VERR_PGM_PHYS_TLB_UNASSIGNED;
5443
5444	pgmUnlock(pVM);
5445	return rc;
5446	}
5447

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

source: vbox/trunk/src/VBox/VMM/VMMR3/PGMPhys.cpp@ 69175

Download in other formats: