MMInternal.h revision 056c7f3bf4322be2711c6e33d04a886da57a7d24
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * MM - Internal header file.
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * available from http://www.virtualbox.org. This file is free software;
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * you can redistribute it and/or modify it under the terms of the GNU
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * General Public License (GPL) as published by the Free Software
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * additional information or have any questions.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** @defgroup grp_mm_int Internals
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * @internal
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * @ingroup grp_mm
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** @name VM Ring-3 Heap Internals
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync/** @def MMR3HEAP_WITH_STATISTICS
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Enable MMR3Heap statistics.
7af218a7441de38fc9e814919db04bae3e917664vboxsync#if !defined(MMR3HEAP_WITH_STATISTICS) && defined(VBOX_WITH_STATISTICS)
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync/** @def MMR3HEAP_SIZE_ALIGNMENT
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync * The allocation size alignment of the MMR3Heap.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * Heap statistics record.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * There is one global and one per allocation tag.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsynctypedef struct MMHEAPSTAT
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Core avl node, key is the tag. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Pointer to the heap the memory belongs to. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of allocation. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of reallocations. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of frees. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Failures. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of bytes allocated (sum). */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of bytes freed. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Number of bytes currently allocated. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Pointer to heap statistics record. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * Additional heap block header for relating allocations to the VM.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsynctypedef struct MMHEAPHDR
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Pointer to the next record. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Pointer to the previous record. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Pointer to the heap statistics record.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * (Where the a PVM can be found.) */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Size of the allocation (including this header). */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Pointer to MM heap header. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** MM Heap structure. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsynctypedef struct MMHEAP
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Lock protecting the heap. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Heap block list head. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Heap block list tail. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Heap per tag statistics tree. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** The VM handle. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** Heap global statistics. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Pointer to MM Heap structure. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync/** @name Hypervisor Heap Internals
4e47bb772df0d04d1ded3e06354de547d52e2d06vboxsync/** @def MMHYPER_HEAP_FREE_DELAY
7af218a7441de38fc9e814919db04bae3e917664vboxsync * If defined, it indicates the number of frees that should be delayed.
7af218a7441de38fc9e814919db04bae3e917664vboxsync/** @def MMHYPER_HEAP_FREE_POISON
7af218a7441de38fc9e814919db04bae3e917664vboxsync * If defined, it indicates that freed memory should be poisoned
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * with the value it has.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync#if defined(VBOX_STRICT) || defined(DOXYGEN_RUNNING)
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** @def MMHYPER_HEAP_STRICT
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Enables a bunch of assertions in the heap code. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync#if defined(VBOX_STRICT) || defined(DOXYGEN_RUNNING)
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync# if 0 || defined(DOXYGEN_RUNNING)
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** @def MMHYPER_HEAP_STRICT_FENCE
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Enables tail fence. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** @def MMHYPER_HEAP_STRICT_FENCE_SIZE
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The fence size in bytes. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** @def MMHYPER_HEAP_STRICT_FENCE_U32
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The fence filler. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync# define MMHYPER_HEAP_STRICT_FENCE_U32 UINT32_C(0xdeadbeef)
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Hypervisor heap statistics record.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * There is one global and one per allocation tag.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsynctypedef struct MMHYPERSTAT
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Core avl node, key is the tag.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * @todo The type is wrong! Get your lazy a$$ over and create that offsetted uint32_t version we need here! */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Aligning the 64-bit fields on a 64-bit line. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Indicator for whether these statistics are registered with STAM or not. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Number of allocation. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Number of frees. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Failures. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Number of bytes allocated (sum). */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Number of bytes freed (sum). */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Number of bytes currently allocated. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** Max number of bytes allocated. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync/** Pointer to hypervisor heap statistics record. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Hypervisor heap chunk.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsynctypedef struct MMHYPERCHUNK
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Previous block in the list of all blocks.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * This is relative to the start of the heap. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Offset to the previous block relative to this one. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** The statistics record this allocation belongs to (self relative). */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Offset to the heap block (self relative). */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** Pointer to a hypervisor heap chunk. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Hypervisor heap chunk.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Main list. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Offset of the next chunk in the list of free nodes. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Offset of the previous chunk in the list of free nodes. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Size of the block. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** Pointer to a free hypervisor heap chunk. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The hypervisor heap.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsynctypedef struct MMHYPERHEAP
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The typical magic (MMHYPERHEAP_MAGIC). */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The heap size. (This structure is not included!) */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The HC ring-3 address of the heap. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The HC ring-3 address of the shared VM strcture. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The HC ring-0 address of the heap. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The HC ring-0 address of the shared VM strcture. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The RC address of the heap. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The RC address of the shared VM strcture. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** The amount of free memory in the heap. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Offset of the first free chunk in the heap.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * The offset is relative to the start of the heap. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Offset of the last free chunk in the heap.
a438caaf732f7839dc66b4f8dad672527845a003vboxsync * The offset is relative to the start of the heap. */
a438caaf732f7839dc66b4f8dad672527845a003vboxsync /** Offset of the first page aligned block in the heap.
4e47bb772df0d04d1ded3e06354de547d52e2d06vboxsync * The offset is equal to cbHeap initially. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** Tree of hypervisor heap statistics. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** Where to insert the next free. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** Array of delayed frees. Circular. Offsets relative to this structure. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** The free caller address. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** The offset of the freed chunk. */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync /** Padding the structure to a 64-bit aligned size. */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync /** The heap physical pages. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync /** Padding the structure to a 64-bit aligned size. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync/** Pointer to the hypervisor heap. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync/** Magic value for MMHYPERHEAP. (C. S. Lewis) */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Hypervisor heap minimum alignment (16 bytes).
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * The aligned size of the the MMHYPERHEAP structure.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync#define MMYPERHEAP_HDR_SIZE RT_ALIGN_Z(sizeof(MMHYPERHEAP), MMHYPER_HEAP_ALIGN_MIN * 4)
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync/** @name Hypervisor heap chunk flags.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * The flags are put in the first bits of the MMHYPERCHUNK::offPrev member.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * These bits aren't used anyway because of the chunk minimal alignment (16 bytes).
a438caaf732f7839dc66b4f8dad672527845a003vboxsync/** The chunk is free. (The code ASSUMES this is 0!) */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** The chunk is in use. */
c0e27f622f9bd6d9e77d2d959aab71d69dabf0d3vboxsync/** The type mask. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** The flag mask */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Checks if the chunk is free. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_ISFREE(pChunk) ( (((pChunk)->offPrev) & MMHYPERCHUNK_FLAGS_TYPE_MASK) == MMHYPERCHUNK_FLAGS_FREE )
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Checks if the chunk is used. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_ISUSED(pChunk) ( (((pChunk)->offPrev) & MMHYPERCHUNK_FLAGS_TYPE_MASK) == MMHYPERCHUNK_FLAGS_USED )
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Toggles FREE/USED flag of a chunk. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_SET_TYPE(pChunk, type) do { (pChunk)->offPrev = ((pChunk)->offPrev & ~MMHYPERCHUNK_FLAGS_TYPE_MASK) | ((type) & MMHYPERCHUNK_FLAGS_TYPE_MASK); } while (0)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Gets the prev offset without the flags. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_GET_OFFPREV(pChunk) ((int32_t)((pChunk)->offPrev & ~MMHYPERCHUNK_FLAGS_MASK))
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Sets the prev offset without changing the flags. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_SET_OFFPREV(pChunk, off) do { (pChunk)->offPrev = (off) | ((pChunk)->offPrev & MMHYPERCHUNK_FLAGS_MASK); } while (0)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Clears one or more flags. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_FLAGS_OP_CLEAR(pChunk, fFlags) do { ((pChunk)->offPrev) &= ~((fFlags) & MMHYPERCHUNK_FLAGS_MASK); } while (0)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Sets one or more flags. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_FLAGS_OP_SET(pChunk, fFlags) do { ((pChunk)->offPrev) |= ((fFlags) & MMHYPERCHUNK_FLAGS_MASK); } while (0)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Checks if one is set. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#define MMHYPERCHUNK_FLAGS_OP_ISSET(pChunk, fFlag) (!!(((pChunk)->offPrev) & ((fFlag) & MMHYPERCHUNK_FLAGS_MASK)))
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** @name Page Pool Internals
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * Page sub pool
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * About the allocation of this structure. To keep the number of heap blocks,
c0e27f622f9bd6d9e77d2d959aab71d69dabf0d3vboxsync * the number of heap calls, and fragmentation low we allocate all the data
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * related to a MMPAGESUBPOOL node in one chunk. That means that after the
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * bitmap (which is of variable size) comes the SUPPAGE records and then
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * follows the lookup tree nodes. (The heap in question is the hyper heap.)
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync /** Pointer to next sub pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to next sub pool in the free chain.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * This is NULL if we're not in the free chain or at the end of it. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to array of lock ranges.
1c822ec4298d5d20b0fb1cc20346c5d4e4e596bfvboxsync * This is allocated together with the MMPAGESUBPOOL and thus needs no freeing.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * It follows immediately after the bitmap.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The reserved field is a pointer to this structure.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to the first page. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Size of the subpool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of free pages. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The allocation bitmap.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * This may extend beyond the end of the defined array size.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /* ... SUPPAGE aRanges[1]; */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync/** Pointer to page sub pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Page pool.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsynctypedef struct MMPAGEPOOL
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** List of subpools. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Head of subpools with free pages. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** AVLPV tree for looking up HC virtual addresses.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The tree contains MMLOOKUPVIRTPP records.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Tree for looking up HC physical addresses.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * The tree contains MMLOOKUPPHYSHC records.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to the VM this pool belongs. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Flag indicating the allocation method.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Set: SUPLowAlloc().
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Clear: SUPPageAlloc() + SUPPageLock(). */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of subpools. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of pages in pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of free pages in pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of alloc calls. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of free calls. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of to phys conversions. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of to virtual conversions. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Number of real errors. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** Pointer to page pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Lookup record for HC virtual memory in the page pool.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** The key is virtual address. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to subpool if lookup record for a pool. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync/** Pointer to virtual memory lookup record. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Lookup record for HC physical memory.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The key is physical address. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Pointer to SUPPAGE record for this physical address. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync/** Pointer to physical memory lookup record. */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Type of memory that's locked.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Hypervisor: Ring-3 memory locked by MM. */
4e47bb772df0d04d1ded3e06354de547d52e2d06vboxsync /** Hypervisor: Ring-3 memory locked by MM that shouldn't be freed up. */
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync /** Hypervisor: Pre-locked ring-3 pages. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Guest: Physical VM memory (RAM & MMIO2). */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync/** Pointer to memory type. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Converts a SUPPAGE pointer to a MMLOCKEDMEM pointer.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * @returns Pointer to the MMLOCKEDMEM record the range is associated with.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * @param pSupPage Pointer to SUPPAGE structure managed by MM.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync#define MM_SUPRANGE_TO_MMLOCKEDMEM(pSupPage) ((PMMLOCKEDMEM)pSupPage->uReserved)
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Locked memory record.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsynctypedef struct MMLOCKEDMEM
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Address (host mapping). */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Size. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Next record. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Record type. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Type specific data. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Data for MM_LOCKED_TYPE_HYPER, MM_LOCKED_TYPE_HYPER_NOFREE and MM_LOCKED_TYPE_HYPER_PAGES. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Data for MM_LOCKED_TYPE_PHYS. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** The GC physical address.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * (Assuming that this is a linear range of GC physical pages.)
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Physical Page Array. (Variable length.)
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * The uReserved field contains pointer to the MMLOCKMEM record.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * Use the macro MM_SUPPAGE_TO_MMLOCKEDMEM() to convert.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * For MM_LOCKED_TYPE_PHYS the low 12 bits of the pvPhys member
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * are bits (MM_RAM_FLAGS_*) and not part of the physical address.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync/** Pointer to locked memory. */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * A registered Rom range.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * This is used to track ROM registrations both for debug reasons
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * and for resetting shadow ROM at reset.
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync * This is allocated of the MMR3Heap and thus only accessibel from ring-3.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsynctypedef struct MMROMRANGE
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Pointer to the next */
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync /** Address of the range. */
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync /** Size of the range. */
8b4a8db7768e94d025f1216ecfcd50d727fa2b7cvboxsync /** Shadow ROM? */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Is the shadow ROM currently wriable? */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The address of the virgin ROM image for shadow ROM. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync const void *pvBinary;
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The address of the guest RAM that's shadowing the ROM. (lazy bird) */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The ROM description. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync const char *pszDesc;
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to a ROM range. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Hypervisor memory mapping type.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Invalid record. This is used for record which are incomplete. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Mapping of locked memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Mapping of contiguous HC physical memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Mapping of contiguous GC physical memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Mapping of MMIO2 memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Dynamic mapping area (MMR3HyperReserve).
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * A conversion will require to check what's in the page table for the pages. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Lookup record for the hypervisor memory area.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Byte offset from the start of this record to the next.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * If the value is NIL_OFFSET the chain is terminated. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Offset into the hypvervisor memory area. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Size of this part. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Locking type. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Type specific data */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Locked memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Host context ring-3 pointer. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Host context ring-0 pointer. Optional. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Pointer to the locked mem record. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Contiguous physical memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Host context ring-3 pointer. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Host context ring-0 pointer. Optional. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** HC physical address corresponding to pvR3/pvR0. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Contiguous guest physical memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The memory address (Guest Context). */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** MMIO2 memory. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The device instance owning the MMIO2 region. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The region number. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The offset into the MMIO2 region. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Description. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to a hypervisor memory lookup record. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Converts a MM pointer into a VM pointer.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @returns Pointer to the VM structure the MM is part of.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @param pMM Pointer to MM instance data.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync#define MM2VM(pMM) ( (PVM)((uint8_t *)pMM - pMM->offVM) )
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * MM Data (part of VM)
daa94352f51be2329ac8660f70396e03a7cb983bvboxsynctypedef struct MM
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Offset to the VM structure.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * See MM2VM(). */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** Set if MMR3InitPaging has been called. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** Set if PGM has been initialized and we can safely call PGMR3Map(). */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** Lookup list for the Hypervisor Memory Area.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * The offset is relative to the start of the heap.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * Use pHyperHeapR3, pHyperHeapR0 or pHypeRHeapRC to calculate the address.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The offset of the next static mapping in the Hypervisor Memory Area. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The size of the HMA.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * Starts at 12MB and will be fixed late in the init process. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** Guest address of the Hypervisor Memory Area.
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * @remarks It's still a bit open whether this should be change to RTRCPTR or
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync * remain a RTGCPTR. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The hypervisor heap (GC Ptr). */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The hypervisor heap (R0 Ptr). */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** Page pool - R0 Ptr. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Page pool pages in low memory R0 Ptr. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync#endif /* !VBOX_WITH_2X_4GB_ADDR_SPACE */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The hypervisor heap (R3 Ptr). */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Page pool - R3 Ptr. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Page pool pages in low memory R3 Ptr. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** List of memory locks. (HC only) */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Pointer to the dummy page.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * The dummy page is a paranoia thingy used for instance for pure MMIO RAM ranges
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * to make sure any bugs will not harm whatever the system stores in the first
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * physical page. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Physical address of the dummy page. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Size of the base RAM in bytes. (The CFGM RamSize value.) */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The number of base RAM pages that PGM has reserved (GMM).
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @remarks Shadow ROMs will be counted twice (RAM+ROM), so it won't be 1:1 with
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * what the guest sees. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The number of shadow pages PGM has reserved (GMM). */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The number of fixed pages we've reserved (GMM). */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The head of the ROM ranges. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to MM Data (part of VM). */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * MM data kept in the UVM.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsynctypedef struct MMUSERPERVM
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Pointer to the MM R3 Heap. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to the MM data kept in the UVM. */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsyncint mmR3LockMem(PVM pVM, void *pv, size_t cb, MMLOCKEDTYPE eType, PMMLOCKEDMEM *ppLockedMem, bool fSilentFailure);
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsyncint mmR3MapLocked(PVM pVM, PMMLOCKEDMEM pLockedMem, RTGCPTR Addr, unsigned iPage, size_t cPages, unsigned fFlags);
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Converts a pool address to a physical address.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * The specified allocation type must match with the address.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @returns Physical address.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @returns NIL_RTHCPHYS if not found or eType is not matching.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @param pPool Pointer to the page pool.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @param pv The address to convert.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @thread The Emulation Thread.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncRTHCPHYS mmPagePoolPtr2Phys(PMMPAGEPOOL pPool, void *pv);
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * Converts a pool physical address to a linear address.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * The specified allocation type must match with the address.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * @returns Physical address.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * @returns NULL if not found or eType is not matching.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * @param pPool Pointer to the page pool.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * @param HCPhys The address to convert.
fa6dbd9c9e9645298cca864aa561382469907905vboxsync * @thread The Emulation Thread.