VirtualBox

source: vbox/trunk/include/VBox/mm.h@ 29286

Last change on this file since 29286 was 28800, checked in by vboxsync, 15 years ago

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