VirtualBox

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

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

doxygen fixes.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.7 KB
Line 
1/** @file
2 * MM - The Memory Manager.
3 */
4
5/*
6 * Copyright (C) 2006-2012 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_MAPPINGS,
115 MM_TAG_PGM_PHYS,
116 MM_TAG_PGM_POOL,
117
118 MM_TAG_REM,
119
120 MM_TAG_SELM,
121
122 MM_TAG_SSM,
123
124 MM_TAG_STAM,
125
126 MM_TAG_TM,
127
128 MM_TAG_TRPM,
129
130 MM_TAG_VM,
131 MM_TAG_VM_REQ,
132
133 MM_TAG_VMM,
134
135 MM_TAG_HM,
136
137 MM_TAG_32BIT_HACK = 0x7fffffff
138} MMTAG;
139
140
141
142
143/** @defgroup grp_mm_hyper Hypervisor Memory Management
144 * @{ */
145
146VMMDECL(RTR3PTR) MMHyperR0ToR3(PVM pVM, RTR0PTR R0Ptr);
147VMMDECL(RTRCPTR) MMHyperR0ToRC(PVM pVM, RTR0PTR R0Ptr);
148#ifndef IN_RING0
149VMMDECL(void *) MMHyperR0ToCC(PVM pVM, RTR0PTR R0Ptr);
150#endif
151VMMDECL(RTR0PTR) MMHyperR3ToR0(PVM pVM, RTR3PTR R3Ptr);
152VMMDECL(RTRCPTR) MMHyperR3ToRC(PVM pVM, RTR3PTR R3Ptr);
153VMMDECL(RTR3PTR) MMHyperRCToR3(PVM pVM, RTRCPTR RCPtr);
154VMMDECL(RTR0PTR) MMHyperRCToR0(PVM pVM, RTRCPTR RCPtr);
155
156#ifndef IN_RING3
157VMMDECL(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr);
158#else
159DECLINLINE(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr)
160{
161 NOREF(pVM);
162 return R3Ptr;
163}
164#endif
165
166
167#ifndef IN_RC
168VMMDECL(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr);
169#else
170DECLINLINE(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr)
171{
172 NOREF(pVM);
173 return (void *)RCPtr;
174}
175#endif
176
177#ifndef IN_RING3
178VMMDECL(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv);
179#else
180DECLINLINE(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv)
181{
182 NOREF(pVM);
183 return pv;
184}
185#endif
186
187#ifndef IN_RING0
188VMMDECL(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv);
189#else
190DECLINLINE(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv)
191{
192 NOREF(pVM);
193 return pv;
194}
195#endif
196
197#ifndef IN_RC
198VMMDECL(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv);
199#else
200DECLINLINE(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv)
201{
202 NOREF(pVM);
203 return (RTRCPTR)pv;
204}
205#endif
206
207
208VMMDECL(int) MMHyperAlloc(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
209VMMDECL(int) MMHyperDupMem(PVM pVM, const void *pvSrc, size_t cb, unsigned uAlignment, MMTAG enmTag, void **ppv);
210VMMDECL(int) MMHyperFree(PVM pVM, void *pv);
211VMMDECL(void) MMHyperHeapCheck(PVM pVM);
212VMMDECL(int) MMR3LockCall(PVM pVM);
213#ifdef DEBUG
214VMMDECL(void) MMHyperHeapDump(PVM pVM);
215#endif
216VMMDECL(size_t) MMHyperHeapGetFreeSize(PVM pVM);
217VMMDECL(size_t) MMHyperHeapGetSize(PVM pVM);
218VMMDECL(RTGCPTR) MMHyperGetArea(PVM pVM, size_t *pcb);
219VMMDECL(bool) MMHyperIsInsideArea(PVM pVM, RTGCPTR GCPtr);
220
221
222VMMDECL(RTHCPHYS) MMPage2Phys(PVM pVM, void *pvPage);
223VMMDECL(void *) MMPagePhys2Page(PVM pVM, RTHCPHYS HCPhysPage);
224VMMDECL(int) MMPagePhys2PageEx(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
225VMMDECL(int) MMPagePhys2PageTry(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
226
227
228/** @def MMHYPER_RC_ASSERT_RCPTR
229 * Asserts that an address is either NULL or inside the hypervisor memory area.
230 * This assertion only works while IN_RC, it's a NOP everywhere else.
231 * @thread The Emulation Thread.
232 */
233#ifdef IN_RC
234# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) Assert(MMHyperIsInsideArea((pVM), (RTRCUINTPTR)(RCPtr)) || !(RCPtr))
235#else
236# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) do { } while (0)
237#endif
238
239/** @} */
240
241
242#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
243/** @defgroup grp_mm_r3 The MM Host Context Ring-3 API
244 * @{
245 */
246
247VMMR3DECL(int) MMR3InitUVM(PUVM pUVM);
248VMMR3DECL(int) MMR3Init(PVM pVM);
249VMMR3DECL(int) MMR3InitPaging(PVM pVM);
250VMMR3DECL(int) MMR3HyperInitFinalize(PVM pVM);
251VMMR3DECL(int) MMR3Term(PVM pVM);
252VMMR3DECL(void) MMR3TermUVM(PUVM pUVM);
253VMMR3DECL(int) MMR3ReserveHandyPages(PVM pVM, uint32_t cHandyPages);
254VMMR3DECL(int) MMR3IncreaseBaseReservation(PVM pVM, uint64_t cAddBasePages);
255VMMR3DECL(int) MMR3AdjustFixedReservation(PVM pVM, int32_t cDeltaFixedPages, const char *pszDesc);
256VMMR3DECL(int) MMR3UpdateShadowReservation(PVM pVM, uint32_t cShadowPages);
257
258VMMR3DECL(int) MMR3HCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys, void **ppv);
259
260/** @defgroup grp_mm_r3_hyper Hypervisor Memory Manager (HC R3 Portion)
261 * @{ */
262VMMR3DECL(int) MMR3HyperAllocOnceNoRel(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
263VMMR3DECL(int) MMR3HyperAllocOnceNoRelEx(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, uint32_t fFlags, void **ppv);
264VMMR3DECL(int) MMR3HyperRealloc(PVM pVM, void *pv, size_t cb, unsigned uAlignmentNew, MMTAG enmTagNew, size_t cbNew, void **ppv);
265/** @name MMR3HyperAllocOnceNoRelEx flags
266 * @{ */
267/** Must have kernel mapping.
268 * If not specified, the R0 pointer may point to the user process mapping. */
269#define MMHYPER_AONR_FLAGS_KERNEL_MAPPING RT_BIT(0)
270/** @} */
271VMMR3DECL(int) MMR3HyperSetGuard(PVM pVM, void *pvStart, size_t cb, bool fSet);
272VMMR3DECL(int) MMR3HyperMapHCPhys(PVM pVM, void *pvR3, RTR0PTR pvR0, RTHCPHYS HCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
273VMMR3DECL(int) MMR3HyperMapGCPhys(PVM pVM, RTGCPHYS GCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
274VMMR3DECL(int) MMR3HyperMapMMIO2(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS off, RTGCPHYS cb, const char *pszDesc, PRTRCPTR pRCPtr);
275VMMR3DECL(int) MMR3HyperMapPages(PVM pVM, void *pvR3, RTR0PTR pvR0, size_t cPages, PCSUPPAGE paPages, const char *pszDesc, PRTGCPTR pGCPtr);
276VMMR3DECL(int) MMR3HyperReserve(PVM pVM, unsigned cb, const char *pszDesc, PRTGCPTR pGCPtr);
277VMMR3DECL(RTHCPHYS) MMR3HyperHCVirt2HCPhys(PVM pVM, void *pvHC);
278VMMR3DECL(int) MMR3HyperHCVirt2HCPhysEx(PVM pVM, void *pvHC, PRTHCPHYS pHCPhys);
279VMMR3DECL(void *) MMR3HyperHCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys);
280VMMR3DECL(int) MMR3HyperHCPhys2HCVirtEx(PVM pVM, RTHCPHYS HCPhys, void **ppv);
281VMMR3_INT_DECL(int) MMR3HyperQueryInfoFromHCPhys(PVM pVM, RTHCPHYS HCPhys, char *pszWhat, size_t cbWhat, uint32_t *pcbAlloc);
282VMMR3DECL(int) MMR3HyperReadGCVirt(PVM pVM, void *pvDst, RTGCPTR GCPtr, size_t cb);
283/** @} */
284
285
286/** @defgroup grp_mm_phys Guest Physical Memory Manager
287 * @todo retire this group, elimintating or moving MMR3PhysGetRamSize to PGMPhys.
288 * @{ */
289VMMR3DECL(uint64_t) MMR3PhysGetRamSize(PVM pVM);
290/** @} */
291
292
293/** @defgroup grp_mm_page Physical Page Pool
294 * @{ */
295VMMR3DECL(void *) MMR3PageAlloc(PVM pVM);
296VMMR3DECL(RTHCPHYS) MMR3PageAllocPhys(PVM pVM);
297VMMR3DECL(void) MMR3PageFree(PVM pVM, void *pvPage);
298VMMR3DECL(void *) MMR3PageAllocLow(PVM pVM);
299VMMR3DECL(void) MMR3PageFreeLow(PVM pVM, void *pvPage);
300VMMR3DECL(void) MMR3PageFreeByPhys(PVM pVM, RTHCPHYS HCPhysPage);
301VMMR3DECL(void *) MMR3PageDummyHCPtr(PVM pVM);
302VMMR3DECL(RTHCPHYS) MMR3PageDummyHCPhys(PVM pVM);
303/** @} */
304
305
306/** @defgroup grp_mm_heap Heap Manager
307 * @{ */
308VMMR3DECL(void *) MMR3HeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize);
309VMMR3DECL(void *) MMR3HeapAllocU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
310VMMR3DECL(int) MMR3HeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
311VMMR3DECL(int) MMR3HeapAllocExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
312VMMR3DECL(void *) MMR3HeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize);
313VMMR3DECL(void *) MMR3HeapAllocZU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
314VMMR3DECL(int) MMR3HeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
315VMMR3DECL(int) MMR3HeapAllocZExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
316VMMR3DECL(void *) MMR3HeapRealloc(void *pv, size_t cbNewSize);
317VMMR3DECL(char *) MMR3HeapStrDup(PVM pVM, MMTAG enmTag, const char *psz);
318VMMR3DECL(char *) MMR3HeapStrDupU(PUVM pUVM, MMTAG enmTag, const char *psz);
319VMMR3DECL(char *) MMR3HeapAPrintf(PVM pVM, MMTAG enmTag, const char *pszFormat, ...);
320VMMR3DECL(char *) MMR3HeapAPrintfU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, ...);
321VMMR3DECL(char *) MMR3HeapAPrintfV(PVM pVM, MMTAG enmTag, const char *pszFormat, va_list va);
322VMMR3DECL(char *) MMR3HeapAPrintfVU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, va_list va);
323VMMR3DECL(void) MMR3HeapFree(void *pv);
324/** @} */
325
326/** @defgroup grp_mm_ukheap User-kernel Heap Manager.
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 || DOXYGEN_RUNNING */
340
341
342
343#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
344/** @defgroup grp_mm_rc The MM Raw-mode Context API
345 * @{
346 */
347
348VMMRCDECL(void) MMGCRamRegisterTrapHandler(PVM pVM);
349VMMRCDECL(void) MMGCRamDeregisterTrapHandler(PVM pVM);
350VMMRCDECL(int) MMGCRamReadNoTrapHandler(void *pDst, void *pSrc, size_t cb);
351/**
352 * @deprecated Don't use this as it doesn't check the page state.
353 */
354VMMRCDECL(int) MMGCRamWriteNoTrapHandler(void *pDst, void *pSrc, size_t cb);
355VMMRCDECL(int) MMGCRamRead(PVM pVM, void *pDst, void *pSrc, size_t cb);
356VMMRCDECL(int) MMGCRamWrite(PVM pVM, void *pDst, void *pSrc, size_t cb);
357
358/** @} */
359#endif /* IN_RC || DOXYGEN_RUNNING */
360
361/** @} */
362RT_C_DECLS_END
363
364
365#endif
366
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