VirtualBox

source: vbox/trunk/include/VBox/vmm/mm.h@ 89363

Last change on this file since 89363 was 87134, checked in by vboxsync, 4 years ago

VMM/DBGFR3FlowTrace: First commit of a new DBGF framework to collect guest state information during execution, allowing visualization of guest execution flow, bugref:8650
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.9 KB
Line 
1/** @file
2 * MM - The Memory Manager.
3 */
4
5/*
6 * Copyright (C) 2006-2020 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef VBOX_INCLUDED_vmm_mm_h
27#define VBOX_INCLUDED_vmm_mm_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <VBox/types.h>
33#include <iprt/x86.h>
34#include <VBox/sup.h>
35#include <iprt/stdarg.h>
36
37
38RT_C_DECLS_BEGIN
39
40/** @defgroup grp_mm The Memory Manager API
41 * @ingroup grp_vmm
42 * @{
43 */
44
45/**
46 * Memory Allocation Tags.
47 * For use with MMHyperAlloc(), MMR3HeapAlloc(), MMR3HeapAllocEx(),
48 * MMR3HeapAllocZ() and MMR3HeapAllocZEx().
49 *
50 * @remark Don't forget to update the dump command in MMHeap.cpp!
51 */
52typedef enum MMTAG
53{
54 MM_TAG_INVALID = 0,
55
56 MM_TAG_CFGM,
57 MM_TAG_CFGM_BYTES,
58 MM_TAG_CFGM_STRING,
59 MM_TAG_CFGM_USER,
60
61 MM_TAG_CSAM,
62 MM_TAG_CSAM_PATCH,
63
64 MM_TAG_CPUM_CTX,
65 MM_TAG_CPUM_CPUID,
66 MM_TAG_CPUM_MSRS,
67
68 MM_TAG_DBGF,
69 MM_TAG_DBGF_AS,
70 MM_TAG_DBGF_CORE_WRITE,
71 MM_TAG_DBGF_INFO,
72 MM_TAG_DBGF_LINE,
73 MM_TAG_DBGF_LINE_DUP,
74 MM_TAG_DBGF_MODULE,
75 MM_TAG_DBGF_OS,
76 MM_TAG_DBGF_REG,
77 MM_TAG_DBGF_STACK,
78 MM_TAG_DBGF_SYMBOL,
79 MM_TAG_DBGF_SYMBOL_DUP,
80 MM_TAG_DBGF_TYPE,
81 MM_TAG_DBGF_TRACER,
82 MM_TAG_DBGF_FLOWTRACE,
83
84 MM_TAG_EM,
85
86 MM_TAG_IEM,
87
88 MM_TAG_IOM,
89 MM_TAG_IOM_STATS,
90
91 MM_TAG_MM,
92 MM_TAG_MM_LOOKUP_GUEST,
93 MM_TAG_MM_LOOKUP_PHYS,
94 MM_TAG_MM_LOOKUP_VIRT,
95 MM_TAG_MM_PAGE,
96
97 MM_TAG_PARAV,
98
99 MM_TAG_PATM,
100 MM_TAG_PATM_PATCH,
101
102 MM_TAG_PDM,
103 MM_TAG_PDM_ASYNC_COMPLETION,
104 MM_TAG_PDM_DEVICE,
105 MM_TAG_PDM_DEVICE_DESC,
106 MM_TAG_PDM_DEVICE_USER,
107 MM_TAG_PDM_DRIVER,
108 MM_TAG_PDM_DRIVER_DESC,
109 MM_TAG_PDM_DRIVER_USER,
110 MM_TAG_PDM_USB,
111 MM_TAG_PDM_USB_DESC,
112 MM_TAG_PDM_USB_USER,
113 MM_TAG_PDM_LUN,
114#ifdef VBOX_WITH_NETSHAPER
115 MM_TAG_PDM_NET_SHAPER,
116#endif /* VBOX_WITH_NETSHAPER */
117 MM_TAG_PDM_QUEUE,
118 MM_TAG_PDM_THREAD,
119
120 MM_TAG_PGM,
121 MM_TAG_PGM_CHUNK_MAPPING,
122 MM_TAG_PGM_HANDLERS,
123 MM_TAG_PGM_HANDLER_TYPES,
124 MM_TAG_PGM_MAPPINGS,
125 MM_TAG_PGM_PHYS,
126 MM_TAG_PGM_POOL,
127
128 MM_TAG_REM,
129
130 MM_TAG_SELM,
131
132 MM_TAG_SSM,
133
134 MM_TAG_STAM,
135
136 MM_TAG_TM,
137
138 MM_TAG_TRPM,
139
140 MM_TAG_VM,
141 MM_TAG_VM_REQ,
142
143 MM_TAG_VMM,
144
145 MM_TAG_HM,
146
147 MM_TAG_32BIT_HACK = 0x7fffffff
148} MMTAG;
149
150
151
152
153/** @defgroup grp_mm_hyper Hypervisor Memory Management
154 * @{ */
155
156VMMDECL(RTR3PTR) MMHyperR0ToR3(PVM pVM, RTR0PTR R0Ptr);
157VMMDECL(RTRCPTR) MMHyperR0ToRC(PVM pVM, RTR0PTR R0Ptr);
158#ifndef IN_RING0
159VMMDECL(void *) MMHyperR0ToCC(PVM pVM, RTR0PTR R0Ptr);
160#endif
161VMMDECL(RTR0PTR) MMHyperR3ToR0(PVM pVM, RTR3PTR R3Ptr);
162VMMDECL(RTRCPTR) MMHyperR3ToRC(PVM pVM, RTR3PTR R3Ptr);
163VMMDECL(RTR3PTR) MMHyperRCToR3(PVM pVM, RTRCPTR RCPtr);
164VMMDECL(RTR0PTR) MMHyperRCToR0(PVM pVM, RTRCPTR RCPtr);
165
166#ifndef IN_RING3
167VMMDECL(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr);
168#else
169DECLINLINE(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr)
170{
171 NOREF(pVM);
172 return R3Ptr;
173}
174#endif
175
176
177VMMDECL(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr);
178
179#ifndef IN_RING3
180VMMDECL(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv);
181#else
182DECLINLINE(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv)
183{
184 NOREF(pVM);
185 return pv;
186}
187#endif
188
189#ifndef IN_RING0
190VMMDECL(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv);
191#else
192DECLINLINE(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv)
193{
194 NOREF(pVM);
195 return pv;
196}
197#endif
198
199VMMDECL(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv);
200
201
202VMMDECL(int) MMHyperAlloc(PVMCC pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
203VMMDECL(int) MMHyperDupMem(PVMCC pVM, const void *pvSrc, size_t cb, unsigned uAlignment, MMTAG enmTag, void **ppv);
204VMMDECL(int) MMHyperFree(PVMCC pVM, void *pv);
205VMMDECL(void) MMHyperHeapCheck(PVMCC pVM);
206VMMDECL(int) MMR3LockCall(PVM pVM);
207#ifdef DEBUG
208VMMDECL(void) MMHyperHeapDump(PVM pVM);
209#endif
210VMMDECL(size_t) MMHyperHeapGetFreeSize(PVM pVM);
211VMMDECL(size_t) MMHyperHeapGetSize(PVM pVM);
212VMMDECL(void *) MMHyperHeapOffsetToPtr(PVM pVM, uint32_t offHeap);
213VMMDECL(uint32_t) MMHyperHeapPtrToOffset(PVM pVM, void *pv);
214VMMDECL(RTGCPTR) MMHyperGetArea(PVM pVM, size_t *pcb);
215VMMDECL(bool) MMHyperIsInsideArea(PVM pVM, RTGCPTR GCPtr);
216
217#if 0
218VMMDECL(RTHCPHYS) MMPage2Phys(PVM pVM, void *pvPage);
219VMMDECL(void *) MMPagePhys2Page(PVM pVM, RTHCPHYS HCPhysPage);
220VMMDECL(int) MMPagePhys2PageEx(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
221VMMDECL(int) MMPagePhys2PageTry(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
222#endif
223
224
225/** @def MMHYPER_RC_ASSERT_RCPTR
226 * Asserts that an address is either NULL or inside the hypervisor memory area.
227 * This assertion only works while IN_RC, it's a NOP everywhere else.
228 * @thread The Emulation Thread.
229 */
230#define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) do { } while (0)
231
232/** @} */
233
234
235#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
236/** @defgroup grp_mm_r3 The MM Host Context Ring-3 API
237 * @{
238 */
239
240VMMR3DECL(int) MMR3InitUVM(PUVM pUVM);
241VMMR3DECL(int) MMR3Init(PVM pVM);
242VMMR3DECL(int) MMR3InitPaging(PVM pVM);
243VMMR3DECL(int) MMR3HyperInitFinalize(PVM pVM);
244VMMR3DECL(int) MMR3Term(PVM pVM);
245VMMR3DECL(void) MMR3TermUVM(PUVM pUVM);
246VMMR3_INT_DECL(bool) MMR3IsInitialized(PVM pVM);
247VMMR3DECL(int) MMR3ReserveHandyPages(PVM pVM, uint32_t cHandyPages);
248VMMR3DECL(int) MMR3IncreaseBaseReservation(PVM pVM, uint64_t cAddBasePages);
249VMMR3DECL(int) MMR3AdjustFixedReservation(PVM pVM, int32_t cDeltaFixedPages, const char *pszDesc);
250VMMR3DECL(int) MMR3UpdateShadowReservation(PVM pVM, uint32_t cShadowPages);
251
252VMMR3DECL(int) MMR3HCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys, void **ppv);
253
254/** @defgroup grp_mm_r3_hyper Hypervisor Memory Manager (HC R3 Portion)
255 * @{ */
256VMMR3DECL(int) MMR3HyperAllocOnceNoRel(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
257VMMR3DECL(int) MMR3HyperAllocOnceNoRelEx(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, uint32_t fFlags, void **ppv);
258VMMR3DECL(int) MMR3HyperRealloc(PVM pVM, void *pv, size_t cb, unsigned uAlignmentNew, MMTAG enmTagNew, size_t cbNew, void **ppv);
259/** @name MMR3HyperAllocOnceNoRelEx flags
260 * @{ */
261/** Must have kernel mapping.
262 * If not specified, the R0 pointer may point to the user process mapping. */
263#define MMHYPER_AONR_FLAGS_KERNEL_MAPPING RT_BIT(0)
264/** @} */
265VMMR3DECL(int) MMR3HyperSetGuard(PVM pVM, void *pvStart, size_t cb, bool fSet);
266#ifndef PGM_WITHOUT_MAPPINGS
267VMMR3DECL(int) MMR3HyperMapHCPhys(PVM pVM, void *pvR3, RTR0PTR pvR0, RTHCPHYS HCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
268VMMR3DECL(int) MMR3HyperMapGCPhys(PVM pVM, RTGCPHYS GCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
269VMMR3DECL(int) MMR3HyperReserve(PVM pVM, unsigned cb, const char *pszDesc, PRTGCPTR pGCPtr);
270#endif
271VMMR3DECL(int) MMR3HyperMapPages(PVM pVM, void *pvR3, RTR0PTR pvR0, size_t cPages, PCSUPPAGE paPages, const char *pszDesc, PRTGCPTR pGCPtr);
272VMMR3DECL(int) MMR3HyperReserveFence(PVM pVM);
273VMMR3DECL(RTHCPHYS) MMR3HyperHCVirt2HCPhys(PVM pVM, void *pvHC);
274VMMR3DECL(int) MMR3HyperHCVirt2HCPhysEx(PVM pVM, void *pvHC, PRTHCPHYS pHCPhys);
275#ifndef PGM_WITHOUT_MAPPINGS
276VMMR3_INT_DECL(int) MMR3HyperQueryInfoFromHCPhys(PVM pVM, RTHCPHYS HCPhys, char *pszWhat, size_t cbWhat, uint32_t *pcbAlloc);
277VMMR3DECL(int) MMR3HyperReadGCVirt(PVM pVM, void *pvDst, RTGCPTR GCPtr, size_t cb);
278#endif
279/** @} */
280
281
282/** @defgroup grp_mm_phys Guest Physical Memory Manager
283 * @todo retire this group, elimintating or moving MMR3PhysGetRamSize to PGMPhys.
284 * @{ */
285VMMR3DECL(uint64_t) MMR3PhysGetRamSize(PVM pVM);
286VMMR3DECL(uint32_t) MMR3PhysGetRamSizeBelow4GB(PVM pVM);
287VMMR3DECL(uint64_t) MMR3PhysGetRamSizeAbove4GB(PVM pVM);
288VMMR3DECL(uint32_t) MMR3PhysGet4GBRamHoleSize(PVM pVM);
289/** @} */
290
291
292/** @defgroup grp_mm_page Physical Page Pool (what's left of it)
293 * @{ */
294VMMR3DECL(void *) MMR3PageDummyHCPtr(PVM pVM);
295VMMR3DECL(RTHCPHYS) MMR3PageDummyHCPhys(PVM pVM);
296/** @} */
297
298
299/** @defgroup grp_mm_heap Heap Manager
300 * @{ */
301VMMR3DECL(void *) MMR3HeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize);
302VMMR3DECL(void *) MMR3HeapAllocU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
303VMMR3DECL(int) MMR3HeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
304VMMR3DECL(int) MMR3HeapAllocExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
305VMMR3DECL(void *) MMR3HeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize);
306VMMR3DECL(void *) MMR3HeapAllocZU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
307VMMR3DECL(int) MMR3HeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
308VMMR3DECL(int) MMR3HeapAllocZExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
309VMMR3DECL(void *) MMR3HeapRealloc(void *pv, size_t cbNewSize);
310VMMR3DECL(char *) MMR3HeapStrDup(PVM pVM, MMTAG enmTag, const char *psz);
311VMMR3DECL(char *) MMR3HeapStrDupU(PUVM pUVM, MMTAG enmTag, const char *psz);
312VMMR3DECL(char *) MMR3HeapAPrintf(PVM pVM, MMTAG enmTag, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
313VMMR3DECL(char *) MMR3HeapAPrintfU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
314VMMR3DECL(char *) MMR3HeapAPrintfV(PVM pVM, MMTAG enmTag, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
315VMMR3DECL(char *) MMR3HeapAPrintfVU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
316VMMR3DECL(void) MMR3HeapFree(void *pv);
317/** @} */
318
319/** @defgroup grp_mm_ukheap User-kernel Heap Manager.
320 *
321 * The memory is safely accessible from kernel context as well as user land.
322 *
323 * @{ */
324VMMR3DECL(void *) MMR3UkHeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
325VMMR3DECL(int) MMR3UkHeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
326VMMR3DECL(void *) MMR3UkHeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
327VMMR3DECL(int) MMR3UkHeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
328VMMR3DECL(void) MMR3UkHeapFree(PVM pVM, void *pv, MMTAG enmTag);
329/** @} */
330
331/** @} */
332#endif /* IN_RING3 || DOXYGEN_RUNNING */
333
334
335/** @} */
336RT_C_DECLS_END
337
338
339#endif /* !VBOX_INCLUDED_vmm_mm_h */
340
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