VirtualBox

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

Last change on this file since 56291 was 56291, checked in by vboxsync, 10 years ago

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