VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR3/MM.cpp@ 58591

Last change on this file since 58591 was 58170, checked in by vboxsync, 9 years ago

doxygen: fixes.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 29.3 KB
Line 
1/* $Id: MM.cpp 58170 2015-10-12 09:27:14Z vboxsync $ */
2/** @file
3 * MM - Memory Manager.
4 */
5
6/*
7 * Copyright (C) 2006-2015 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/** @page pg_mm MM - The Memory Manager
20 *
21 * The memory manager is in charge of the following memory:
22 * - Hypervisor Memory Area (HMA) - Address space management.
23 * - Hypervisor Heap - A memory heap that lives in all contexts.
24 * - Tagged ring-3 heap.
25 * - Page pools - Primarily used by PGM for shadow page tables.
26 * - Locked process memory - Guest RAM and other. (reduce/obsolete this)
27 * - Physical guest memory (RAM & ROM) - Moving to PGM. (obsolete this)
28 *
29 * The global memory manager (GMM) is the global counter part / partner of MM.
30 * MM will provide therefore ring-3 callable interfaces for some of the GMM APIs
31 * related to resource tracking (PGM is the user).
32 *
33 * @see grp_mm
34 *
35 *
36 * @section sec_mm_hma Hypervisor Memory Area
37 *
38 * The HMA is used when executing in raw-mode. We borrow, with the help of
39 * PGMMap, some unused space (one or more page directory entries to be precise)
40 * in the guest's virtual memory context. PGM will monitor the guest's virtual
41 * address space for changes and relocate the HMA when required.
42 *
43 * To give some idea what's in the HMA, study the 'info hma' output:
44 * @verbatim
45VBoxDbg> info hma
46Hypervisor Memory Area (HMA) Layout: Base 00000000a0000000, 0x00800000 bytes
4700000000a05cc000-00000000a05cd000 DYNAMIC fence
4800000000a05c4000-00000000a05cc000 DYNAMIC Dynamic mapping
4900000000a05c3000-00000000a05c4000 DYNAMIC fence
5000000000a05b8000-00000000a05c3000 DYNAMIC Paging
5100000000a05b6000-00000000a05b8000 MMIO2 0000000000000000 PCNetShMem
5200000000a0536000-00000000a05b6000 MMIO2 0000000000000000 VGA VRam
5300000000a0523000-00000000a0536000 00002aaab3d0c000 LOCKED autofree alloc once (PDM_DEVICE)
5400000000a0522000-00000000a0523000 DYNAMIC fence
5500000000a051e000-00000000a0522000 00002aaab36f5000 LOCKED autofree VBoxDD2RC.rc
5600000000a051d000-00000000a051e000 DYNAMIC fence
5700000000a04eb000-00000000a051d000 00002aaab36c3000 LOCKED autofree VBoxDDRC.rc
5800000000a04ea000-00000000a04eb000 DYNAMIC fence
5900000000a04e9000-00000000a04ea000 00002aaab36c2000 LOCKED autofree ram range (High ROM Region)
6000000000a04e8000-00000000a04e9000 DYNAMIC fence
6100000000a040e000-00000000a04e8000 00002aaab2e6d000 LOCKED autofree VMMRC.rc
6200000000a0208000-00000000a040e000 00002aaab2c67000 LOCKED autofree alloc once (PATM)
6300000000a01f7000-00000000a0208000 00002aaaab92d000 LOCKED autofree alloc once (SELM)
6400000000a01e7000-00000000a01f7000 00002aaaab5e8000 LOCKED autofree alloc once (SELM)
6500000000a01e6000-00000000a01e7000 DYNAMIC fence
6600000000a01e5000-00000000a01e6000 00002aaaab5e7000 HCPHYS 00000000c363c000 Core Code
6700000000a01e4000-00000000a01e5000 DYNAMIC fence
6800000000a01e3000-00000000a01e4000 00002aaaaab26000 HCPHYS 00000000619cf000 GIP
6900000000a01a2000-00000000a01e3000 00002aaaabf32000 LOCKED autofree alloc once (PGM_PHYS)
7000000000a016b000-00000000a01a2000 00002aaab233f000 LOCKED autofree alloc once (PGM_POOL)
7100000000a016a000-00000000a016b000 DYNAMIC fence
7200000000a0165000-00000000a016a000 DYNAMIC CR3 mapping
7300000000a0164000-00000000a0165000 DYNAMIC fence
7400000000a0024000-00000000a0164000 00002aaab215f000 LOCKED autofree Heap
7500000000a0023000-00000000a0024000 DYNAMIC fence
7600000000a0001000-00000000a0023000 00002aaab1d24000 LOCKED pages VM
7700000000a0000000-00000000a0001000 DYNAMIC fence
78 @endverbatim
79 *
80 *
81 * @section sec_mm_hyperheap Hypervisor Heap
82 *
83 * The heap is accessible from ring-3, ring-0 and the raw-mode context. That
84 * said, it's not necessarily mapped into ring-0 on if that's possible since we
85 * don't wish to waste kernel address space without a good reason.
86 *
87 * Allocations within the heap are always in the same relative position in all
88 * contexts, so, it's possible to use offset based linking. In fact, the heap is
89 * internally using offset based linked lists tracking heap blocks. We use
90 * offset linked AVL trees and lists in a lot of places where share structures
91 * between RC, R3 and R0, so this is a strict requirement of the heap. However
92 * this means that we cannot easily extend the heap since the extension won't
93 * necessarily be in the continuation of the current heap memory in all (or any)
94 * context.
95 *
96 * All allocations are tagged. Per tag allocation statistics will be maintaining
97 * and exposed thru STAM when VBOX_WITH_STATISTICS is defined.
98 *
99 *
100 * @section sec_mm_r3heap Tagged Ring-3 Heap
101 *
102 * The ring-3 heap is a wrapper around the RTMem API adding allocation
103 * statistics and automatic cleanup on VM destruction.
104 *
105 * Per tag allocation statistics will be maintaining and exposed thru STAM when
106 * VBOX_WITH_STATISTICS is defined.
107 *
108 *
109 * @section sec_mm_page Page Pool
110 *
111 * The MM manages a page pool from which other components can allocate locked,
112 * page aligned and page sized memory objects. The pool provides facilities to
113 * convert back and forth between (host) physical and virtual addresses (within
114 * the pool of course). Several specialized interfaces are provided for the most
115 * common allocations and conversions to save the caller from bothersome casting
116 * and extra parameter passing.
117 *
118 *
119 * @section sec_mm_locked Locked Process Memory
120 *
121 * MM manages the locked process memory. This is used for a bunch of things
122 * (count the LOCKED entries in the 'info hma' output found in @ref sec_mm_hma),
123 * but the main consumer of memory is currently for guest RAM. There is an
124 * ongoing rewrite that will move all the guest RAM allocation to PGM and
125 * GMM.
126 *
127 * The locking of memory is something doing in cooperation with the VirtualBox
128 * support driver, SUPDrv (aka. VBoxDrv), thru the support library API,
129 * SUPR3 (aka. SUPLib).
130 *
131 *
132 * @section sec_mm_phys Physical Guest Memory
133 *
134 * MM is currently managing the physical memory for the guest. It relies heavily
135 * on PGM for this. There is an ongoing rewrite that will move this to PGM. (The
136 * rewrite is driven by the need for more flexible guest ram allocation, but
137 * also motivated by the fact that MMPhys is just adding stupid bureaucracy and
138 * that MMR3PhysReserve is a totally weird artifact that must go away.)
139 *
140 */
141
142
143/*********************************************************************************************************************************
144* Header Files *
145*********************************************************************************************************************************/
146#define LOG_GROUP LOG_GROUP_MM
147#include <VBox/vmm/mm.h>
148#include <VBox/vmm/pgm.h>
149#include <VBox/vmm/cfgm.h>
150#include <VBox/vmm/ssm.h>
151#include <VBox/vmm/gmm.h>
152#include "MMInternal.h"
153#include <VBox/vmm/vm.h>
154#include <VBox/vmm/uvm.h>
155#include <VBox/err.h>
156#include <VBox/param.h>
157
158#include <VBox/log.h>
159#include <iprt/alloc.h>
160#include <iprt/assert.h>
161#include <iprt/string.h>
162
163
164/*********************************************************************************************************************************
165* Defined Constants And Macros *
166*********************************************************************************************************************************/
167/** The current saved state version of MM. */
168#define MM_SAVED_STATE_VERSION 2
169
170
171/*********************************************************************************************************************************
172* Internal Functions *
173*********************************************************************************************************************************/
174static DECLCALLBACK(int) mmR3Save(PVM pVM, PSSMHANDLE pSSM);
175static DECLCALLBACK(int) mmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
176
177
178
179
180/**
181 * Initializes the MM members of the UVM.
182 *
183 * This is currently only the ring-3 heap.
184 *
185 * @returns VBox status code.
186 * @param pUVM Pointer to the user mode VM structure.
187 */
188VMMR3DECL(int) MMR3InitUVM(PUVM pUVM)
189{
190 /*
191 * Assert sizes and order.
192 */
193 AssertCompile(sizeof(pUVM->mm.s) <= sizeof(pUVM->mm.padding));
194 AssertRelease(sizeof(pUVM->mm.s) <= sizeof(pUVM->mm.padding));
195 Assert(!pUVM->mm.s.pHeap);
196
197 /*
198 * Init the heap.
199 */
200 int rc = mmR3HeapCreateU(pUVM, &pUVM->mm.s.pHeap);
201 if (RT_SUCCESS(rc))
202 {
203 rc = mmR3UkHeapCreateU(pUVM, &pUVM->mm.s.pUkHeap);
204 if (RT_SUCCESS(rc))
205 return VINF_SUCCESS;
206 mmR3HeapDestroy(pUVM->mm.s.pHeap);
207 pUVM->mm.s.pHeap = NULL;
208 }
209 return rc;
210}
211
212
213/**
214 * Initializes the MM.
215 *
216 * MM is managing the virtual address space (among other things) and
217 * setup the hypervisor memory area mapping in the VM structure and
218 * the hypervisor alloc-only-heap. Assuming the current init order
219 * and components the hypervisor memory area looks like this:
220 * -# VM Structure.
221 * -# Hypervisor alloc only heap (also call Hypervisor memory region).
222 * -# Core code.
223 *
224 * MM determines the virtual address of the hypervisor memory area by
225 * checking for location at previous run. If that property isn't available
226 * it will choose a default starting location, currently 0xa0000000.
227 *
228 * @returns VBox status code.
229 * @param pVM The cross context VM structure.
230 */
231VMMR3DECL(int) MMR3Init(PVM pVM)
232{
233 LogFlow(("MMR3Init\n"));
234
235 /*
236 * Assert alignment, sizes and order.
237 */
238 AssertRelease(!(RT_OFFSETOF(VM, mm.s) & 31));
239 AssertRelease(sizeof(pVM->mm.s) <= sizeof(pVM->mm.padding));
240 AssertMsg(pVM->mm.s.offVM == 0, ("Already initialized!\n"));
241
242 /*
243 * Init the structure.
244 */
245 pVM->mm.s.offVM = RT_OFFSETOF(VM, mm);
246 pVM->mm.s.offLookupHyper = NIL_OFFSET;
247
248 /*
249 * Init the page pool.
250 */
251 int rc = mmR3PagePoolInit(pVM);
252 if (RT_SUCCESS(rc))
253 {
254 /*
255 * Init the hypervisor related stuff.
256 */
257 rc = mmR3HyperInit(pVM);
258 if (RT_SUCCESS(rc))
259 {
260 /*
261 * Register the saved state data unit.
262 */
263 rc = SSMR3RegisterInternal(pVM, "mm", 1, MM_SAVED_STATE_VERSION, sizeof(uint32_t) * 2,
264 NULL, NULL, NULL,
265 NULL, mmR3Save, NULL,
266 NULL, mmR3Load, NULL);
267 if (RT_SUCCESS(rc))
268 {
269 /*
270 * Statistics.
271 */
272 STAM_REG(pVM, &pVM->mm.s.cBasePages, STAMTYPE_U64, "/MM/Reserved/cBasePages", STAMUNIT_PAGES, "Reserved number of base pages, ROM and Shadow ROM included.");
273 STAM_REG(pVM, &pVM->mm.s.cHandyPages, STAMTYPE_U32, "/MM/Reserved/cHandyPages", STAMUNIT_PAGES, "Reserved number of handy pages.");
274 STAM_REG(pVM, &pVM->mm.s.cShadowPages, STAMTYPE_U32, "/MM/Reserved/cShadowPages", STAMUNIT_PAGES, "Reserved number of shadow paging pages.");
275 STAM_REG(pVM, &pVM->mm.s.cFixedPages, STAMTYPE_U32, "/MM/Reserved/cFixedPages", STAMUNIT_PAGES, "Reserved number of fixed pages (MMIO2).");
276 STAM_REG(pVM, &pVM->mm.s.cbRamBase, STAMTYPE_U64, "/MM/cbRamBase", STAMUNIT_BYTES, "Size of the base RAM.");
277
278 return rc;
279 }
280
281 /* .... failure .... */
282 }
283 }
284 MMR3Term(pVM);
285 return rc;
286}
287
288
289/**
290 * Initializes the MM parts which depends on PGM being initialized.
291 *
292 * @returns VBox status code.
293 * @param pVM The cross context VM structure.
294 * @remark No cleanup necessary since MMR3Term() will be called on failure.
295 */
296VMMR3DECL(int) MMR3InitPaging(PVM pVM)
297{
298 LogFlow(("MMR3InitPaging:\n"));
299
300 /*
301 * Query the CFGM values.
302 */
303 int rc;
304 PCFGMNODE pMMCfg = CFGMR3GetChild(CFGMR3GetRoot(pVM), "MM");
305 if (!pMMCfg)
306 {
307 rc = CFGMR3InsertNode(CFGMR3GetRoot(pVM), "MM", &pMMCfg);
308 AssertRCReturn(rc, rc);
309 }
310
311 /** @cfgm{/RamSize, uint64_t, 0, 16TB, 0}
312 * Specifies the size of the base RAM that is to be set up during
313 * VM initialization.
314 */
315 uint64_t cbRam;
316 rc = CFGMR3QueryU64(CFGMR3GetRoot(pVM), "RamSize", &cbRam);
317 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
318 cbRam = 0;
319 else
320 AssertMsgRCReturn(rc, ("Configuration error: Failed to query integer \"RamSize\", rc=%Rrc.\n", rc), rc);
321 AssertLogRelMsg(!(cbRam & ~X86_PTE_PAE_PG_MASK), ("%RGp X86_PTE_PAE_PG_MASK=%RX64\n", cbRam, X86_PTE_PAE_PG_MASK));
322 AssertLogRelMsgReturn(cbRam <= GMM_GCPHYS_LAST, ("cbRam=%RGp GMM_GCPHYS_LAST=%RX64\n", cbRam, GMM_GCPHYS_LAST), VERR_OUT_OF_RANGE);
323 cbRam &= X86_PTE_PAE_PG_MASK;
324 pVM->mm.s.cbRamBase = cbRam;
325
326 /** @cfgm{/RamHoleSize, uint32_t, 0, 4032MB, 512MB}
327 * Specifies the size of the memory hole. The memory hole is used
328 * to avoid mapping RAM to the range normally used for PCI memory regions.
329 * Must be aligned on a 4MB boundary. */
330 uint32_t cbRamHole;
331 rc = CFGMR3QueryU32Def(CFGMR3GetRoot(pVM), "RamHoleSize", &cbRamHole, MM_RAM_HOLE_SIZE_DEFAULT);
332 AssertLogRelMsgRCReturn(rc, ("Configuration error: Failed to query integer \"RamHoleSize\", rc=%Rrc.\n", rc), rc);
333 AssertLogRelMsgReturn(cbRamHole <= 4032U * _1M,
334 ("Configuration error: \"RamHoleSize\"=%#RX32 is too large.\n", cbRamHole), VERR_OUT_OF_RANGE);
335 AssertLogRelMsgReturn(cbRamHole > 16 * _1M,
336 ("Configuration error: \"RamHoleSize\"=%#RX32 is too large.\n", cbRamHole), VERR_OUT_OF_RANGE);
337 AssertLogRelMsgReturn(!(cbRamHole & (_4M - 1)),
338 ("Configuration error: \"RamHoleSize\"=%#RX32 is misaligned.\n", cbRamHole), VERR_OUT_OF_RANGE);
339 uint64_t const offRamHole = _4G - cbRamHole;
340 if (cbRam < offRamHole)
341 Log(("MM: %RU64 bytes of RAM\n", cbRam));
342 else
343 Log(("MM: %RU64 bytes of RAM with a hole at %RU64 up to 4GB.\n", cbRam, offRamHole));
344
345 /** @cfgm{/MM/Policy, string, no overcommitment}
346 * Specifies the policy to use when reserving memory for this VM. The recognized
347 * value is 'no overcommitment' (default). See GMMPOLICY.
348 */
349 GMMOCPOLICY enmOcPolicy;
350 char sz[64];
351 rc = CFGMR3QueryString(CFGMR3GetRoot(pVM), "Policy", sz, sizeof(sz));
352 if (RT_SUCCESS(rc))
353 {
354 if ( !RTStrICmp(sz, "no_oc")
355 || !RTStrICmp(sz, "no overcommitment"))
356 enmOcPolicy = GMMOCPOLICY_NO_OC;
357 else
358 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, "Unknown \"MM/Policy\" value \"%s\"", sz);
359 }
360 else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
361 enmOcPolicy = GMMOCPOLICY_NO_OC;
362 else
363 AssertMsgFailedReturn(("Configuration error: Failed to query string \"MM/Policy\", rc=%Rrc.\n", rc), rc);
364
365 /** @cfgm{/MM/Priority, string, normal}
366 * Specifies the memory priority of this VM. The priority comes into play when the
367 * system is overcommitted and the VMs needs to be milked for memory. The recognized
368 * values are 'low', 'normal' (default) and 'high'. See GMMPRIORITY.
369 */
370 GMMPRIORITY enmPriority;
371 rc = CFGMR3QueryString(CFGMR3GetRoot(pVM), "Priority", sz, sizeof(sz));
372 if (RT_SUCCESS(rc))
373 {
374 if (!RTStrICmp(sz, "low"))
375 enmPriority = GMMPRIORITY_LOW;
376 else if (!RTStrICmp(sz, "normal"))
377 enmPriority = GMMPRIORITY_NORMAL;
378 else if (!RTStrICmp(sz, "high"))
379 enmPriority = GMMPRIORITY_HIGH;
380 else
381 return VMSetError(pVM, VERR_INVALID_PARAMETER, RT_SRC_POS, "Unknown \"MM/Priority\" value \"%s\"", sz);
382 }
383 else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
384 enmPriority = GMMPRIORITY_NORMAL;
385 else
386 AssertMsgFailedReturn(("Configuration error: Failed to query string \"MM/Priority\", rc=%Rrc.\n", rc), rc);
387
388 /*
389 * Make the initial memory reservation with GMM.
390 */
391 uint64_t cBasePages = (cbRam >> PAGE_SHIFT) + pVM->mm.s.cBasePages;
392 rc = GMMR3InitialReservation(pVM,
393 RT_MAX(cBasePages + pVM->mm.s.cHandyPages, 1),
394 RT_MAX(pVM->mm.s.cShadowPages, 1),
395 RT_MAX(pVM->mm.s.cFixedPages, 1),
396 enmOcPolicy,
397 enmPriority);
398 if (RT_FAILURE(rc))
399 {
400 if (rc == VERR_GMM_MEMORY_RESERVATION_DECLINED)
401 return VMSetError(pVM, rc, RT_SRC_POS,
402 N_("Insufficient free memory to start the VM (cbRam=%#RX64 enmOcPolicy=%d enmPriority=%d)"),
403 cbRam, enmOcPolicy, enmPriority);
404 return VMSetError(pVM, rc, RT_SRC_POS, "GMMR3InitialReservation(,%#RX64,0,0,%d,%d)",
405 cbRam >> PAGE_SHIFT, enmOcPolicy, enmPriority);
406 }
407
408 /*
409 * If RamSize is 0 we're done now.
410 */
411 if (cbRam < PAGE_SIZE)
412 {
413 Log(("MM: No RAM configured\n"));
414 return VINF_SUCCESS;
415 }
416
417 /*
418 * Setup the base ram (PGM).
419 */
420 if (cbRam > offRamHole)
421 {
422 rc = PGMR3PhysRegisterRam(pVM, 0, offRamHole, "Base RAM");
423 if (RT_SUCCESS(rc))
424 rc = PGMR3PhysRegisterRam(pVM, _4G, cbRam - offRamHole, "Above 4GB Base RAM");
425 }
426 else
427 rc = PGMR3PhysRegisterRam(pVM, 0, RT_MIN(cbRam, offRamHole), "Base RAM");
428
429 /*
430 * Enabled mmR3UpdateReservation here since we don't want the
431 * PGMR3PhysRegisterRam calls above mess things up.
432 */
433 pVM->mm.s.fDoneMMR3InitPaging = true;
434 AssertMsg(pVM->mm.s.cBasePages == cBasePages || RT_FAILURE(rc), ("%RX64 != %RX64\n", pVM->mm.s.cBasePages, cBasePages));
435
436 LogFlow(("MMR3InitPaging: returns %Rrc\n", rc));
437 return rc;
438}
439
440
441/**
442 * Terminates the MM.
443 *
444 * Termination means cleaning up and freeing all resources,
445 * the VM it self is at this point powered off or suspended.
446 *
447 * @returns VBox status code.
448 * @param pVM The cross context VM structure.
449 */
450VMMR3DECL(int) MMR3Term(PVM pVM)
451{
452 /*
453 * Destroy the page pool. (first as it used the hyper heap)
454 */
455 mmR3PagePoolTerm(pVM);
456
457 /* Clean up the hypervisor heap. */
458 mmR3HyperTerm(pVM);
459
460 /*
461 * Zero stuff to detect after termination use of the MM interface
462 */
463 pVM->mm.s.offLookupHyper = NIL_OFFSET;
464 pVM->mm.s.pHyperHeapR3 = NULL; /* freed above. */
465 pVM->mm.s.pHyperHeapR0 = NIL_RTR0PTR; /* freed above. */
466 pVM->mm.s.pHyperHeapRC = NIL_RTRCPTR; /* freed above. */
467 pVM->mm.s.offVM = 0; /* init assertion on this */
468
469 /*
470 * Destroy the User-kernel heap here since the support driver session
471 * may have been terminated by the time we get to MMR3TermUVM.
472 */
473 mmR3UkHeapDestroy(pVM->pUVM->mm.s.pUkHeap);
474 pVM->pUVM->mm.s.pUkHeap = NULL;
475
476 return VINF_SUCCESS;
477}
478
479
480/**
481 * Terminates the UVM part of MM.
482 *
483 * Termination means cleaning up and freeing all resources,
484 * the VM it self is at this point powered off or suspended.
485 *
486 * @returns VBox status code.
487 * @param pUVM Pointer to the user mode VM structure.
488 */
489VMMR3DECL(void) MMR3TermUVM(PUVM pUVM)
490{
491 /*
492 * Destroy the heaps.
493 */
494 if (pUVM->mm.s.pUkHeap)
495 {
496 mmR3UkHeapDestroy(pUVM->mm.s.pUkHeap);
497 pUVM->mm.s.pUkHeap = NULL;
498 }
499 mmR3HeapDestroy(pUVM->mm.s.pHeap);
500 pUVM->mm.s.pHeap = NULL;
501}
502
503
504/**
505 * Checks if the both VM and UVM parts of MM have been initialized.
506 *
507 * @returns true if initialized, false if not.
508 * @param pVM The cross context VM structure.
509 */
510VMMR3_INT_DECL(bool) MMR3IsInitialized(PVM pVM)
511{
512 return pVM->mm.s.pHyperHeapR3 != NULL;
513}
514
515
516/**
517 * Execute state save operation.
518 *
519 * @returns VBox status code.
520 * @param pVM The cross context VM structure.
521 * @param pSSM SSM operation handle.
522 */
523static DECLCALLBACK(int) mmR3Save(PVM pVM, PSSMHANDLE pSSM)
524{
525 LogFlow(("mmR3Save:\n"));
526
527 /* (PGM saves the physical memory.) */
528 SSMR3PutU64(pSSM, pVM->mm.s.cBasePages);
529 return SSMR3PutU64(pSSM, pVM->mm.s.cbRamBase);
530}
531
532
533/**
534 * Execute state load operation.
535 *
536 * @returns VBox status code.
537 * @param pVM The cross context VM structure.
538 * @param pSSM SSM operation handle.
539 * @param uVersion Data layout version.
540 * @param uPass The data pass.
541 */
542static DECLCALLBACK(int) mmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
543{
544 LogFlow(("mmR3Load:\n"));
545 Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
546
547 /*
548 * Validate version.
549 */
550 if ( SSM_VERSION_MAJOR_CHANGED(uVersion, MM_SAVED_STATE_VERSION)
551 || !uVersion)
552 {
553 AssertMsgFailed(("mmR3Load: Invalid version uVersion=%d!\n", uVersion));
554 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
555 }
556
557 /*
558 * Check the cBasePages and cbRamBase values.
559 */
560 int rc;
561 RTUINT cb1;
562
563 /* cBasePages (ignored) */
564 uint64_t cPages;
565 if (uVersion >= 2)
566 rc = SSMR3GetU64(pSSM, &cPages);
567 else
568 {
569 rc = SSMR3GetUInt(pSSM, &cb1);
570 cPages = cb1 >> PAGE_SHIFT;
571 }
572 if (RT_FAILURE(rc))
573 return rc;
574
575 /* cbRamBase */
576 uint64_t cb;
577 if (uVersion != 1)
578 rc = SSMR3GetU64(pSSM, &cb);
579 else
580 {
581 rc = SSMR3GetUInt(pSSM, &cb1);
582 cb = cb1;
583 }
584 if (RT_FAILURE(rc))
585 return rc;
586 AssertLogRelMsgReturn(cb == pVM->mm.s.cbRamBase,
587 ("Memory configuration has changed. cbRamBase=%#RX64 save=%#RX64\n", pVM->mm.s.cbRamBase, cb),
588 VERR_SSM_LOAD_MEMORY_SIZE_MISMATCH);
589
590 /* (PGM restores the physical memory.) */
591 return rc;
592}
593
594
595/**
596 * Updates GMM with memory reservation changes.
597 *
598 * Called when MM::cbRamRegistered, MM::cShadowPages or MM::cFixedPages changes.
599 *
600 * @returns VBox status code - see GMMR0UpdateReservation.
601 * @param pVM The cross context VM structure.
602 */
603int mmR3UpdateReservation(PVM pVM)
604{
605 VM_ASSERT_EMT(pVM);
606 if (pVM->mm.s.fDoneMMR3InitPaging)
607 return GMMR3UpdateReservation(pVM,
608 RT_MAX(pVM->mm.s.cBasePages + pVM->mm.s.cHandyPages, 1),
609 RT_MAX(pVM->mm.s.cShadowPages, 1),
610 RT_MAX(pVM->mm.s.cFixedPages, 1));
611 return VINF_SUCCESS;
612}
613
614
615/**
616 * Interface for PGM to increase the reservation of RAM and ROM pages.
617 *
618 * This can be called before MMR3InitPaging.
619 *
620 * @returns VBox status code. Will set VM error on failure.
621 * @param pVM The cross context VM structure.
622 * @param cAddBasePages The number of pages to add.
623 */
624VMMR3DECL(int) MMR3IncreaseBaseReservation(PVM pVM, uint64_t cAddBasePages)
625{
626 uint64_t cOld = pVM->mm.s.cBasePages;
627 pVM->mm.s.cBasePages += cAddBasePages;
628 LogFlow(("MMR3IncreaseBaseReservation: +%RU64 (%RU64 -> %RU64\n", cAddBasePages, cOld, pVM->mm.s.cBasePages));
629 int rc = mmR3UpdateReservation(pVM);
630 if (RT_FAILURE(rc))
631 {
632 VMSetError(pVM, rc, RT_SRC_POS, N_("Failed to reserved physical memory for the RAM (%#RX64 -> %#RX64 + %#RX32)"),
633 cOld, pVM->mm.s.cBasePages, pVM->mm.s.cHandyPages);
634 pVM->mm.s.cBasePages = cOld;
635 }
636 return rc;
637}
638
639
640/**
641 * Interface for PGM to make reservations for handy pages in addition to the
642 * base memory.
643 *
644 * This can be called before MMR3InitPaging.
645 *
646 * @returns VBox status code. Will set VM error on failure.
647 * @param pVM The cross context VM structure.
648 * @param cHandyPages The number of handy pages.
649 */
650VMMR3DECL(int) MMR3ReserveHandyPages(PVM pVM, uint32_t cHandyPages)
651{
652 AssertReturn(!pVM->mm.s.cHandyPages, VERR_WRONG_ORDER);
653
654 pVM->mm.s.cHandyPages = cHandyPages;
655 LogFlow(("MMR3ReserveHandyPages: %RU32 (base %RU64)\n", pVM->mm.s.cHandyPages, pVM->mm.s.cBasePages));
656 int rc = mmR3UpdateReservation(pVM);
657 if (RT_FAILURE(rc))
658 {
659 VMSetError(pVM, rc, RT_SRC_POS, N_("Failed to reserved physical memory for the RAM (%#RX64 + %#RX32)"),
660 pVM->mm.s.cBasePages, pVM->mm.s.cHandyPages);
661 pVM->mm.s.cHandyPages = 0;
662 }
663 return rc;
664}
665
666
667/**
668 * Interface for PGM to adjust the reservation of fixed pages.
669 *
670 * This can be called before MMR3InitPaging.
671 *
672 * @returns VBox status code. Will set VM error on failure.
673 * @param pVM The cross context VM structure.
674 * @param cDeltaFixedPages The number of pages to add (positive) or subtract (negative).
675 * @param pszDesc Some description associated with the reservation.
676 */
677VMMR3DECL(int) MMR3AdjustFixedReservation(PVM pVM, int32_t cDeltaFixedPages, const char *pszDesc)
678{
679 const uint32_t cOld = pVM->mm.s.cFixedPages;
680 pVM->mm.s.cFixedPages += cDeltaFixedPages;
681 LogFlow(("MMR3AdjustFixedReservation: %d (%u -> %u)\n", cDeltaFixedPages, cOld, pVM->mm.s.cFixedPages));
682 int rc = mmR3UpdateReservation(pVM);
683 if (RT_FAILURE(rc))
684 {
685 VMSetError(pVM, rc, RT_SRC_POS, N_("Failed to reserve physical memory (%#x -> %#x; %s)"),
686 cOld, pVM->mm.s.cFixedPages, pszDesc);
687 pVM->mm.s.cFixedPages = cOld;
688 }
689 return rc;
690}
691
692
693/**
694 * Interface for PGM to update the reservation of shadow pages.
695 *
696 * This can be called before MMR3InitPaging.
697 *
698 * @returns VBox status code. Will set VM error on failure.
699 * @param pVM The cross context VM structure.
700 * @param cShadowPages The new page count.
701 */
702VMMR3DECL(int) MMR3UpdateShadowReservation(PVM pVM, uint32_t cShadowPages)
703{
704 const uint32_t cOld = pVM->mm.s.cShadowPages;
705 pVM->mm.s.cShadowPages = cShadowPages;
706 LogFlow(("MMR3UpdateShadowReservation: %u -> %u\n", cOld, pVM->mm.s.cShadowPages));
707 int rc = mmR3UpdateReservation(pVM);
708 if (RT_FAILURE(rc))
709 {
710 VMSetError(pVM, rc, RT_SRC_POS, N_("Failed to reserve physical memory for shadow page tables (%#x -> %#x)"), cOld, pVM->mm.s.cShadowPages);
711 pVM->mm.s.cShadowPages = cOld;
712 }
713 return rc;
714}
715
716
717/**
718 * Convert HC Physical address to HC Virtual address.
719 *
720 * @returns VBox status code.
721 * @param pVM The cross context VM structure.
722 * @param HCPhys The host context virtual address.
723 * @param ppv Where to store the resulting address.
724 * @thread The Emulation Thread.
725 *
726 * @remarks Avoid whenever possible.
727 * Intended for the debugger facility only.
728 * @todo Rename to indicate the special usage.
729 */
730VMMR3DECL(int) MMR3HCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys, void **ppv)
731{
732 /*
733 * Try page tables.
734 */
735 int rc = MMPagePhys2PageTry(pVM, HCPhys, ppv);
736 if (RT_SUCCESS(rc))
737 return rc;
738
739 /*
740 * Iterate thru the lookup records for HMA.
741 */
742 uint32_t off = HCPhys & PAGE_OFFSET_MASK;
743 HCPhys &= X86_PTE_PAE_PG_MASK;
744 PMMLOOKUPHYPER pCur = (PMMLOOKUPHYPER)((uint8_t *)pVM->mm.s.CTX_SUFF(pHyperHeap) + pVM->mm.s.offLookupHyper);
745 for (;;)
746 {
747 switch (pCur->enmType)
748 {
749 case MMLOOKUPHYPERTYPE_LOCKED:
750 {
751 PCRTHCPHYS paHCPhysPages = pCur->u.Locked.paHCPhysPages;
752 size_t iPage = pCur->cb >> PAGE_SHIFT;
753 while (iPage-- > 0)
754 if (paHCPhysPages[iPage] == HCPhys)
755 {
756 *ppv = (char *)pCur->u.Locked.pvR3 + (iPage << PAGE_SHIFT) + off;
757 return VINF_SUCCESS;
758 }
759 break;
760 }
761
762 case MMLOOKUPHYPERTYPE_HCPHYS:
763 if (pCur->u.HCPhys.HCPhys - HCPhys < pCur->cb)
764 {
765 *ppv = (uint8_t *)pCur->u.HCPhys.pvR3 + pCur->u.HCPhys.HCPhys - HCPhys + off;
766 return VINF_SUCCESS;
767 }
768 break;
769
770 case MMLOOKUPHYPERTYPE_GCPHYS: /* (for now we'll not allow these kind of conversions) */
771 case MMLOOKUPHYPERTYPE_MMIO2:
772 case MMLOOKUPHYPERTYPE_DYNAMIC:
773 break;
774
775 default:
776 AssertMsgFailed(("enmType=%d\n", pCur->enmType));
777 break;
778 }
779
780 /* next */
781 if (pCur->offNext == (int32_t)NIL_OFFSET)
782 break;
783 pCur = (PMMLOOKUPHYPER)((uint8_t *)pCur + pCur->offNext);
784 }
785 /* give up */
786 return VERR_INVALID_POINTER;
787}
788
789
790
791/**
792 * Get the size of the base RAM.
793 * This usually means the size of the first contiguous block of physical memory.
794 *
795 * @returns The guest base RAM size.
796 * @param pVM The cross context VM structure.
797 * @thread Any.
798 *
799 * @deprecated
800 */
801VMMR3DECL(uint64_t) MMR3PhysGetRamSize(PVM pVM)
802{
803 return pVM->mm.s.cbRamBase;
804}
805
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette