VirtualBox

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

Last change on this file since 63687 was 63660, checked in by vboxsync, 8 years ago

MM: Added MMR3PhysGet4GBRamHoleSize, MMPhysGetRamSizeAbove4GB, and MMPhysGetRamSizeBelow4GB.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/** @file
2 * MM - The Memory Manager.
3 */
4
5/*
6 * Copyright (C) 2006-2016 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_vmm_mm_h
27#define ___VBox_vmm_mm_h
28
29#include <VBox/types.h>
30#include <iprt/x86.h>
31#include <VBox/sup.h>
32#include <iprt/stdarg.h>
33
34
35RT_C_DECLS_BEGIN
36
37/** @defgroup grp_mm The Memory Manager API
38 * @ingroup grp_vmm
39 * @{
40 */
41
42/**
43 * Memory Allocation Tags.
44 * For use with MMHyperAlloc(), MMR3HeapAlloc(), MMR3HeapAllocEx(),
45 * MMR3HeapAllocZ() and MMR3HeapAllocZEx().
46 *
47 * @remark Don't forget to update the dump command in MMHeap.cpp!
48 */
49typedef enum MMTAG
50{
51 MM_TAG_INVALID = 0,
52
53 MM_TAG_CFGM,
54 MM_TAG_CFGM_BYTES,
55 MM_TAG_CFGM_STRING,
56 MM_TAG_CFGM_USER,
57
58 MM_TAG_CSAM,
59 MM_TAG_CSAM_PATCH,
60
61 MM_TAG_CPUM_CTX,
62 MM_TAG_CPUM_CPUID,
63 MM_TAG_CPUM_MSRS,
64
65 MM_TAG_DBGF,
66 MM_TAG_DBGF_AS,
67 MM_TAG_DBGF_CORE_WRITE,
68 MM_TAG_DBGF_INFO,
69 MM_TAG_DBGF_LINE,
70 MM_TAG_DBGF_LINE_DUP,
71 MM_TAG_DBGF_MODULE,
72 MM_TAG_DBGF_OS,
73 MM_TAG_DBGF_REG,
74 MM_TAG_DBGF_STACK,
75 MM_TAG_DBGF_SYMBOL,
76 MM_TAG_DBGF_SYMBOL_DUP,
77 MM_TAG_DBGF_TYPE,
78
79 MM_TAG_EM,
80
81 MM_TAG_IOM,
82 MM_TAG_IOM_STATS,
83
84 MM_TAG_MM,
85 MM_TAG_MM_LOOKUP_GUEST,
86 MM_TAG_MM_LOOKUP_PHYS,
87 MM_TAG_MM_LOOKUP_VIRT,
88 MM_TAG_MM_PAGE,
89
90 MM_TAG_PARAV,
91
92 MM_TAG_PATM,
93 MM_TAG_PATM_PATCH,
94
95 MM_TAG_PDM,
96 MM_TAG_PDM_ASYNC_COMPLETION,
97 MM_TAG_PDM_DEVICE,
98 MM_TAG_PDM_DEVICE_DESC,
99 MM_TAG_PDM_DEVICE_USER,
100 MM_TAG_PDM_DRIVER,
101 MM_TAG_PDM_DRIVER_DESC,
102 MM_TAG_PDM_DRIVER_USER,
103 MM_TAG_PDM_USB,
104 MM_TAG_PDM_USB_DESC,
105 MM_TAG_PDM_USB_USER,
106 MM_TAG_PDM_LUN,
107#ifdef VBOX_WITH_NETSHAPER
108 MM_TAG_PDM_NET_SHAPER,
109#endif /* VBOX_WITH_NETSHAPER */
110 MM_TAG_PDM_QUEUE,
111 MM_TAG_PDM_THREAD,
112
113 MM_TAG_PGM,
114 MM_TAG_PGM_CHUNK_MAPPING,
115 MM_TAG_PGM_HANDLERS,
116 MM_TAG_PGM_HANDLER_TYPES,
117 MM_TAG_PGM_MAPPINGS,
118 MM_TAG_PGM_PHYS,
119 MM_TAG_PGM_POOL,
120
121 MM_TAG_REM,
122
123 MM_TAG_SELM,
124
125 MM_TAG_SSM,
126
127 MM_TAG_STAM,
128
129 MM_TAG_TM,
130
131 MM_TAG_TRPM,
132
133 MM_TAG_VM,
134 MM_TAG_VM_REQ,
135
136 MM_TAG_VMM,
137
138 MM_TAG_HM,
139
140 MM_TAG_32BIT_HACK = 0x7fffffff
141} MMTAG;
142
143
144
145
146/** @defgroup grp_mm_hyper Hypervisor Memory Management
147 * @{ */
148
149VMMDECL(RTR3PTR) MMHyperR0ToR3(PVM pVM, RTR0PTR R0Ptr);
150VMMDECL(RTRCPTR) MMHyperR0ToRC(PVM pVM, RTR0PTR R0Ptr);
151#ifndef IN_RING0
152VMMDECL(void *) MMHyperR0ToCC(PVM pVM, RTR0PTR R0Ptr);
153#endif
154VMMDECL(RTR0PTR) MMHyperR3ToR0(PVM pVM, RTR3PTR R3Ptr);
155VMMDECL(RTRCPTR) MMHyperR3ToRC(PVM pVM, RTR3PTR R3Ptr);
156VMMDECL(RTR3PTR) MMHyperRCToR3(PVM pVM, RTRCPTR RCPtr);
157VMMDECL(RTR0PTR) MMHyperRCToR0(PVM pVM, RTRCPTR RCPtr);
158
159#ifndef IN_RING3
160VMMDECL(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr);
161#else
162DECLINLINE(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr)
163{
164 NOREF(pVM);
165 return R3Ptr;
166}
167#endif
168
169
170#ifndef IN_RC
171VMMDECL(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr);
172#else
173DECLINLINE(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr)
174{
175 NOREF(pVM);
176 return (void *)RCPtr;
177}
178#endif
179
180#ifndef IN_RING3
181VMMDECL(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv);
182#else
183DECLINLINE(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv)
184{
185 NOREF(pVM);
186 return pv;
187}
188#endif
189
190#ifndef IN_RING0
191VMMDECL(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv);
192#else
193DECLINLINE(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv)
194{
195 NOREF(pVM);
196 return pv;
197}
198#endif
199
200#ifndef IN_RC
201VMMDECL(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv);
202#else
203DECLINLINE(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv)
204{
205 NOREF(pVM);
206 return (RTRCPTR)pv;
207}
208#endif
209
210
211VMMDECL(int) MMHyperAlloc(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
212VMMDECL(int) MMHyperDupMem(PVM pVM, const void *pvSrc, size_t cb, unsigned uAlignment, MMTAG enmTag, void **ppv);
213VMMDECL(int) MMHyperFree(PVM pVM, void *pv);
214VMMDECL(void) MMHyperHeapCheck(PVM pVM);
215VMMDECL(int) MMR3LockCall(PVM pVM);
216#ifdef DEBUG
217VMMDECL(void) MMHyperHeapDump(PVM pVM);
218#endif
219VMMDECL(size_t) MMHyperHeapGetFreeSize(PVM pVM);
220VMMDECL(size_t) MMHyperHeapGetSize(PVM pVM);
221VMMDECL(void *) MMHyperHeapOffsetToPtr(PVM pVM, uint32_t offHeap);
222VMMDECL(uint32_t) MMHyperHeapPtrToOffset(PVM pVM, void *pv);
223VMMDECL(RTGCPTR) MMHyperGetArea(PVM pVM, size_t *pcb);
224VMMDECL(bool) MMHyperIsInsideArea(PVM pVM, RTGCPTR GCPtr);
225
226
227VMMDECL(RTHCPHYS) MMPage2Phys(PVM pVM, void *pvPage);
228VMMDECL(void *) MMPagePhys2Page(PVM pVM, RTHCPHYS HCPhysPage);
229VMMDECL(int) MMPagePhys2PageEx(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
230VMMDECL(int) MMPagePhys2PageTry(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
231
232
233/** @def MMHYPER_RC_ASSERT_RCPTR
234 * Asserts that an address is either NULL or inside the hypervisor memory area.
235 * This assertion only works while IN_RC, it's a NOP everywhere else.
236 * @thread The Emulation Thread.
237 */
238#ifdef IN_RC
239# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) Assert(MMHyperIsInsideArea((pVM), (RTRCUINTPTR)(RCPtr)) || !(RCPtr))
240#else
241# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) do { } while (0)
242#endif
243
244/** @} */
245
246
247#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
248/** @defgroup grp_mm_r3 The MM Host Context Ring-3 API
249 * @{
250 */
251
252VMMR3DECL(int) MMR3InitUVM(PUVM pUVM);
253VMMR3DECL(int) MMR3Init(PVM pVM);
254VMMR3DECL(int) MMR3InitPaging(PVM pVM);
255VMMR3DECL(int) MMR3HyperInitFinalize(PVM pVM);
256VMMR3DECL(int) MMR3Term(PVM pVM);
257VMMR3DECL(void) MMR3TermUVM(PUVM pUVM);
258VMMR3_INT_DECL(bool) MMR3IsInitialized(PVM pVM);
259VMMR3DECL(int) MMR3ReserveHandyPages(PVM pVM, uint32_t cHandyPages);
260VMMR3DECL(int) MMR3IncreaseBaseReservation(PVM pVM, uint64_t cAddBasePages);
261VMMR3DECL(int) MMR3AdjustFixedReservation(PVM pVM, int32_t cDeltaFixedPages, const char *pszDesc);
262VMMR3DECL(int) MMR3UpdateShadowReservation(PVM pVM, uint32_t cShadowPages);
263
264VMMR3DECL(int) MMR3HCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys, void **ppv);
265
266/** @defgroup grp_mm_r3_hyper Hypervisor Memory Manager (HC R3 Portion)
267 * @{ */
268VMMR3DECL(int) MMR3HyperAllocOnceNoRel(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
269VMMR3DECL(int) MMR3HyperAllocOnceNoRelEx(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, uint32_t fFlags, void **ppv);
270VMMR3DECL(int) MMR3HyperRealloc(PVM pVM, void *pv, size_t cb, unsigned uAlignmentNew, MMTAG enmTagNew, size_t cbNew, void **ppv);
271/** @name MMR3HyperAllocOnceNoRelEx flags
272 * @{ */
273/** Must have kernel mapping.
274 * If not specified, the R0 pointer may point to the user process mapping. */
275#define MMHYPER_AONR_FLAGS_KERNEL_MAPPING RT_BIT(0)
276/** @} */
277VMMR3DECL(int) MMR3HyperSetGuard(PVM pVM, void *pvStart, size_t cb, bool fSet);
278VMMR3DECL(int) MMR3HyperMapHCPhys(PVM pVM, void *pvR3, RTR0PTR pvR0, RTHCPHYS HCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
279VMMR3DECL(int) MMR3HyperMapGCPhys(PVM pVM, RTGCPHYS GCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
280VMMR3DECL(int) MMR3HyperMapMMIO2(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS off, RTGCPHYS cb, const char *pszDesc, PRTRCPTR pRCPtr);
281VMMR3DECL(int) MMR3HyperMapPages(PVM pVM, void *pvR3, RTR0PTR pvR0, size_t cPages, PCSUPPAGE paPages, const char *pszDesc, PRTGCPTR pGCPtr);
282VMMR3DECL(int) MMR3HyperReserve(PVM pVM, unsigned cb, const char *pszDesc, PRTGCPTR pGCPtr);
283VMMR3DECL(RTHCPHYS) MMR3HyperHCVirt2HCPhys(PVM pVM, void *pvHC);
284VMMR3DECL(int) MMR3HyperHCVirt2HCPhysEx(PVM pVM, void *pvHC, PRTHCPHYS pHCPhys);
285VMMR3DECL(void *) MMR3HyperHCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys);
286VMMR3DECL(int) MMR3HyperHCPhys2HCVirtEx(PVM pVM, RTHCPHYS HCPhys, void **ppv);
287VMMR3_INT_DECL(int) MMR3HyperQueryInfoFromHCPhys(PVM pVM, RTHCPHYS HCPhys, char *pszWhat, size_t cbWhat, uint32_t *pcbAlloc);
288VMMR3DECL(int) MMR3HyperReadGCVirt(PVM pVM, void *pvDst, RTGCPTR GCPtr, size_t cb);
289/** @} */
290
291
292/** @defgroup grp_mm_phys Guest Physical Memory Manager
293 * @todo retire this group, elimintating or moving MMR3PhysGetRamSize to PGMPhys.
294 * @{ */
295VMMR3DECL(uint64_t) MMR3PhysGetRamSize(PVM pVM);
296VMMR3DECL(uint32_t) MMR3PhysGetRamSizeBelow4GB(PVM pVM);
297VMMR3DECL(uint64_t) MMR3PhysGetRamSizeAbove4GB(PVM pVM);
298VMMR3DECL(uint32_t) MMR3PhysGet4GBRamHoleSize(PVM pVM);
299/** @} */
300
301
302/** @defgroup grp_mm_page Physical Page Pool
303 * @{ */
304VMMR3DECL(void *) MMR3PageAlloc(PVM pVM);
305VMMR3DECL(RTHCPHYS) MMR3PageAllocPhys(PVM pVM);
306VMMR3DECL(void) MMR3PageFree(PVM pVM, void *pvPage);
307VMMR3DECL(void *) MMR3PageAllocLow(PVM pVM);
308VMMR3DECL(void) MMR3PageFreeLow(PVM pVM, void *pvPage);
309VMMR3DECL(void) MMR3PageFreeByPhys(PVM pVM, RTHCPHYS HCPhysPage);
310VMMR3DECL(void *) MMR3PageDummyHCPtr(PVM pVM);
311VMMR3DECL(RTHCPHYS) MMR3PageDummyHCPhys(PVM pVM);
312/** @} */
313
314
315/** @defgroup grp_mm_heap Heap Manager
316 * @{ */
317VMMR3DECL(void *) MMR3HeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize);
318VMMR3DECL(void *) MMR3HeapAllocU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
319VMMR3DECL(int) MMR3HeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
320VMMR3DECL(int) MMR3HeapAllocExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
321VMMR3DECL(void *) MMR3HeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize);
322VMMR3DECL(void *) MMR3HeapAllocZU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
323VMMR3DECL(int) MMR3HeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
324VMMR3DECL(int) MMR3HeapAllocZExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
325VMMR3DECL(void *) MMR3HeapRealloc(void *pv, size_t cbNewSize);
326VMMR3DECL(char *) MMR3HeapStrDup(PVM pVM, MMTAG enmTag, const char *psz);
327VMMR3DECL(char *) MMR3HeapStrDupU(PUVM pUVM, MMTAG enmTag, const char *psz);
328VMMR3DECL(char *) MMR3HeapAPrintf(PVM pVM, MMTAG enmTag, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
329VMMR3DECL(char *) MMR3HeapAPrintfU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
330VMMR3DECL(char *) MMR3HeapAPrintfV(PVM pVM, MMTAG enmTag, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
331VMMR3DECL(char *) MMR3HeapAPrintfVU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
332VMMR3DECL(void) MMR3HeapFree(void *pv);
333/** @} */
334
335/** @defgroup grp_mm_ukheap User-kernel Heap Manager.
336 *
337 * The memory is safely accessible from kernel context as well as user land.
338 *
339 * @{ */
340VMMR3DECL(void *) MMR3UkHeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
341VMMR3DECL(int) MMR3UkHeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
342VMMR3DECL(void *) MMR3UkHeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
343VMMR3DECL(int) MMR3UkHeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
344VMMR3DECL(void) MMR3UkHeapFree(PVM pVM, void *pv, MMTAG enmTag);
345/** @} */
346
347/** @} */
348#endif /* IN_RING3 || DOXYGEN_RUNNING */
349
350
351
352#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
353/** @defgroup grp_mm_rc The MM Raw-mode Context API
354 * @{
355 */
356
357VMMRCDECL(void) MMGCRamRegisterTrapHandler(PVM pVM);
358VMMRCDECL(void) MMGCRamDeregisterTrapHandler(PVM pVM);
359VMMRCDECL(int) MMGCRamReadNoTrapHandler(void *pDst, void *pSrc, size_t cb);
360/**
361 * @deprecated Don't use this as it doesn't check the page state.
362 */
363VMMRCDECL(int) MMGCRamWriteNoTrapHandler(void *pDst, void *pSrc, size_t cb);
364VMMRCDECL(int) MMGCRamRead(PVM pVM, void *pDst, void *pSrc, size_t cb);
365VMMRCDECL(int) MMGCRamWrite(PVM pVM, void *pDst, void *pSrc, size_t cb);
366
367/** @} */
368#endif /* IN_RC || DOXYGEN_RUNNING */
369
370/** @} */
371RT_C_DECLS_END
372
373
374#endif
375
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