0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * MM - The Memory Manager.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2012 Oracle Corporation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * available from http://www.virtualbox.org. This file is free software;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * you can redistribute it and/or modify it under the terms of the GNU
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * General Public License (GPL) as published by the Free Software
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The contents of this file may alternatively be used under the terms
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * of the Common Development and Distribution License Version 1.0
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution, in which case the provisions of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * CDDL are applicable instead of those of the GPL.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * You may elect to license modified versions of this file under the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * terms and conditions of either the GPL or the CDDL or both.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm The Memory Manager API
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Memory Allocation Tags.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * For use with MMHyperAlloc(), MMR3HeapAlloc(), MMR3HeapAllocEx(),
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * MMR3HeapAllocZ() and MMR3HeapAllocZEx().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @remark Don't forget to update the dump command in MMHeap.cpp!
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#endif /* VBOX_WITH_NETSHAPER */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_hyper Hypervisor Memory Management
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTR3PTR) MMHyperR0ToR3(PVM pVM, RTR0PTR R0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTRCPTR) MMHyperR0ToRC(PVM pVM, RTR0PTR R0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(void *) MMHyperR0ToCC(PVM pVM, RTR0PTR R0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTR0PTR) MMHyperR3ToR0(PVM pVM, RTR3PTR R3Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTRCPTR) MMHyperR3ToRC(PVM pVM, RTR3PTR R3Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTR3PTR) MMHyperRCToR3(PVM pVM, RTRCPTR RCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTR0PTR) MMHyperRCToR0(PVM pVM, RTRCPTR RCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(void *) MMHyperR3ToCC(PVM pVM, RTR3PTR R3Ptr)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(void *) MMHyperRCToCC(PVM pVM, RTRCPTR RCPtr)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync return (void *)RCPtr;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(RTR3PTR) MMHyperCCToR3(PVM pVM, void *pv)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(RTR0PTR) MMHyperCCToR0(PVM pVM, void *pv)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(RTRCPTR) MMHyperCCToRC(PVM pVM, void *pv)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(int) MMHyperAlloc(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
41d680dd6eb0287afc200adc5b0d61b07a32b72dvboxsyncVMMDECL(int) MMHyperDupMem(PVM pVM, const void *pvSrc, size_t cb, unsigned uAlignment, MMTAG enmTag, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTGCPTR) MMHyperGetArea(PVM pVM, size_t *pcb);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(bool) MMHyperIsInsideArea(PVM pVM, RTGCPTR GCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(RTHCPHYS) MMPage2Phys(PVM pVM, void *pvPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(void *) MMPagePhys2Page(PVM pVM, RTHCPHYS HCPhysPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(int) MMPagePhys2PageEx(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMDECL(int) MMPagePhys2PageTry(PVM pVM, RTHCPHYS HCPhysPage, void **ppvPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @def MMHYPER_RC_ASSERT_RCPTR
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Asserts that an address is either NULL or inside the hypervisor memory area.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This assertion only works while IN_RC, it's a NOP everywhere else.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread The Emulation Thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) Assert(MMHyperIsInsideArea((pVM), (RTRCUINTPTR)(RCPtr)) || !(RCPtr))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync# define MMHYPER_RC_ASSERT_RCPTR(pVM, RCPtr) do { } while (0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_r3 The MM Host Context Ring-3 API
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3ReserveHandyPages(PVM pVM, uint32_t cHandyPages);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3IncreaseBaseReservation(PVM pVM, uint64_t cAddBasePages);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3AdjustFixedReservation(PVM pVM, int32_t cDeltaFixedPages, const char *pszDesc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3UpdateShadowReservation(PVM pVM, uint32_t cShadowPages);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_r3_hyper Hypervisor Memory Manager (HC R3 Portion)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperAllocOnceNoRel(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperAllocOnceNoRelEx(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, uint32_t fFlags, void **ppv);
1bc6deb47f3874f8d1d7a7b6e01d7d7c314d808fvboxsyncVMMR3DECL(int) MMR3HyperRealloc(PVM pVM, void *pv, size_t cb, unsigned uAlignmentNew, MMTAG enmTagNew, size_t cbNew, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @name MMR3HyperAllocOnceNoRelEx flags
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Must have kernel mapping.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * If not specified, the R0 pointer may point to the user process mapping. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperSetGuard(PVM pVM, void *pvStart, size_t cb, bool fSet);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperMapHCPhys(PVM pVM, void *pvR3, RTR0PTR pvR0, RTHCPHYS HCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperMapGCPhys(PVM pVM, RTGCPHYS GCPhys, size_t cb, const char *pszDesc, PRTGCPTR pGCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperMapMMIO2(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS off, RTGCPHYS cb, const char *pszDesc, PRTRCPTR pRCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperMapPages(PVM pVM, void *pvR3, RTR0PTR pvR0, size_t cPages, PCSUPPAGE paPages, const char *pszDesc, PRTGCPTR pGCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperReserve(PVM pVM, unsigned cb, const char *pszDesc, PRTGCPTR pGCPtr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(RTHCPHYS) MMR3HyperHCVirt2HCPhys(PVM pVM, void *pvHC);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperHCVirt2HCPhysEx(PVM pVM, void *pvHC, PRTHCPHYS pHCPhys);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HyperHCPhys2HCVirt(PVM pVM, RTHCPHYS HCPhys);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperHCPhys2HCVirtEx(PVM pVM, RTHCPHYS HCPhys, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3_INT_DECL(int) MMR3HyperQueryInfoFromHCPhys(PVM pVM, RTHCPHYS HCPhys, char *pszWhat, size_t cbWhat, uint32_t *pcbAlloc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HyperReadGCVirt(PVM pVM, void *pvDst, RTGCPTR GCPtr, size_t cb);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_phys Guest Physical Memory Manager
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @todo retire this group, elimintating or moving MMR3PhysGetRamSize to PGMPhys.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_page Physical Page Pool
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) MMR3PageFree(PVM pVM, void *pvPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) MMR3PageFreeLow(PVM pVM, void *pvPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) MMR3PageFreeByPhys(PVM pVM, RTHCPHYS HCPhysPage);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_mm_heap Heap Manager
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HeapAllocU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HeapAllocExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HeapAllocZU(PUVM pUVM, MMTAG enmTag, size_t cbSize);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3HeapAllocZExU(PUVM pUVM, MMTAG enmTag, size_t cbSize, void **ppv);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3HeapRealloc(void *pv, size_t cbNewSize);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapStrDup(PVM pVM, MMTAG enmTag, const char *psz);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapStrDupU(PUVM pUVM, MMTAG enmTag, const char *psz);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapAPrintf(PVM pVM, MMTAG enmTag, const char *pszFormat, ...);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapAPrintfU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, ...);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapAPrintfV(PVM pVM, MMTAG enmTag, const char *pszFormat, va_list va);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(char *) MMR3HeapAPrintfVU(PUVM pUVM, MMTAG enmTag, const char *pszFormat, va_list va);
c1d279fc0865b91a40b30eda02ed14f6533fe1a4vboxsync/** @defgroup grp_mm_ukheap User-kernel Heap Manager.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The memory is safely accessible from kernel context as well as user land.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3UkHeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3UkHeapAllocEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void *) MMR3UkHeapAllocZ(PVM pVM, MMTAG enmTag, size_t cbSize, PRTR0PTR pR0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) MMR3UkHeapAllocZEx(PVM pVM, MMTAG enmTag, size_t cbSize, void **ppv, PRTR0PTR pR0Ptr);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) MMR3UkHeapFree(PVM pVM, void *pv, MMTAG enmTag);
c1d279fc0865b91a40b30eda02ed14f6533fe1a4vboxsync#endif /* IN_RING3 || DOXYGEN_RUNNING */
c1d279fc0865b91a40b30eda02ed14f6533fe1a4vboxsync/** @defgroup grp_mm_rc The MM Raw-mode Context API
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(void) MMGCRamRegisterTrapHandler(PVM pVM);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(void) MMGCRamDeregisterTrapHandler(PVM pVM);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(int) MMGCRamReadNoTrapHandler(void *pDst, void *pSrc, size_t cb);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @deprecated Don't use this as it doesn't check the page state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(int) MMGCRamWriteNoTrapHandler(void *pDst, void *pSrc, size_t cb);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(int) MMGCRamRead(PVM pVM, void *pDst, void *pSrc, size_t cb);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMRCDECL(int) MMGCRamWrite(PVM pVM, void *pDst, void *pSrc, size_t cb);
c1d279fc0865b91a40b30eda02ed14f6533fe1a4vboxsync#endif /* IN_RC || DOXYGEN_RUNNING */