memobj.h revision a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fc
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * innotek Portable Runtime - Memory Objects (Ring-0).
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Copyright (C) 2006-2007 innotek GmbH
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * available from http://www.virtualbox.org. This file is free software;
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * you can redistribute it and/or modify it under the terms of the GNU
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * General Public License (GPL) as published by the Free Software
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3f1f30f349c6d9ef74ba8d16ff0c5b0ac47def6cvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * The contents of this file may alternatively be used under the terms
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * of the Common Development and Distribution License Version 1.0
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * VirtualBox OSE distribution, in which case the provisions of the
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * CDDL are applicable instead of those of the GPL.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * You may elect to license modified versions of this file under the
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * terms and conditions of either the GPL or the CDDL or both.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync/** @defgroup grp_rt_memobj RTMemObj - Memory Object Manipulation (Ring-0)
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @ingroup grp_rt
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Checks if this is mapping or not.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns true if it's a mapping, otherwise false.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(bool) RTR0MemObjIsMapping(RTR0MEMOBJ MemObj);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Gets the address of a ring-0 memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns The address of the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(void *) RTR0MemObjAddress(RTR0MEMOBJ MemObj);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Gets the ring-3 address of a ring-0 memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * This only applies to ring-0 memory object with ring-3 mappings of some kind, i.e.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * locked user memory, reserved user address space and user mappings. This API should
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * not be used on any other objects.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns The address of the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NIL_RTR3PTR if the handle is invalid or if it's not an object with a ring-3 mapping.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Strict builds will assert in both cases.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(RTR3PTR) RTR0MemObjAddressR3(RTR0MEMOBJ MemObj);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Gets the size of a ring-0 memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns The address of the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Get the physical address of an page in the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns The physical address.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NIL_RTHCPHYS if the object doesn't contain fixed physical pages.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NIL_RTHCPHYS if the iPage is out of range.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns NIL_RTHCPHYS if the object handle isn't valid.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param iPage The page number within the object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(RTHCPHYS) RTR0MemObjGetPagePhysAddr(RTR0MEMOBJ MemObj, size_t iPage);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Frees a ring-0 memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @retval VERR_INVALID_HANDLE if
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObj The ring-0 memory object to be freed. NULL is accepted.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fFreeMappings Whether or not to free mappings of the object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjFree(RTR0MEMOBJ MemObj, bool fFreeMappings);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Allocates page aligned virtual kernel memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * The memory is taken from a non paged (= fixed physical memory backing) pool.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to allocate. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjAllocPage(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Allocates page aligned virtual kernel memory with physical backing below 4GB.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * The physical memory backing the allocation is fixed.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to allocate. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjAllocLow(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Allocates page aligned virtual kernel memory with contiguous physical backing below 4GB.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * The physical memory backing the allocation is fixed.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to allocate. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjAllocCont(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Locks a range of user virtual memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R3Ptr User virtual address. This is rounded down to a page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to lock. This is rounded up to nearest page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R0Process The process to lock pages in. NIL_R0PROCESS is an alias for the current one.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @remark RTR0MemGetAddressR3() and RTR0MemGetAddress() will return the rounded down address.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjLockUser(PRTR0MEMOBJ pMemObj, RTR3PTR R3Ptr, size_t cb, RTR0PROCESS R0Process);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Locks a range of kernel virtual memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pv Kernel virtual address. This is rounded down to a page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to lock. This is rounded up to nearest page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @remark RTR0MemGetAddress() will return the rounded down address.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjLockKernel(PRTR0MEMOBJ pMemObj, void *pv, size_t cb);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Allocates contiguous page aligned physical memory without (necessarily) any kernel mapping.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to allocate. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param PhysHighest The highest permittable address (inclusive).
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Pass NIL_RTHCPHYS if any address is acceptable.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjAllocPhys(PRTR0MEMOBJ pMemObj, size_t cb, RTHCPHYS PhysHighest);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Allocates non-contiguous page aligned physical memory without (necessarily) any kernel mapping.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * This API is for allocating huge amounts of pages and will return
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * VERR_NOT_SUPPORTED if this cannot be implemented in a satisfactory
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @retval VERR_NOT_SUPPORTED if it's not possible to allocated unmapped
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * physical memory on this platform. The caller should expect
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * this error and have a fallback strategy for it.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb Number of bytes to allocate. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param PhysHighest The highest permittable address (inclusive).
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Pass NIL_RTHCPHYS if any address is acceptable.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjAllocPhysNC(PRTR0MEMOBJ pMemObj, size_t cb, RTHCPHYS PhysHighest);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Creates a page aligned, contiguous, physical memory object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * No physical memory is allocated, we trust you do know what you're doing.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param Phys The physical address to start at. This is rounded down to the
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * nearest page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb The size of the object in bytes. This is rounded up to nearest page boundrary.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjEnterPhys(PRTR0MEMOBJ pMemObj, RTHCPHYS Phys, size_t cb);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Reserves kernel virtual address space.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * If this function fails with VERR_NOT_SUPPORTED, the idea is that you
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * can use RTR0MemObjEnterPhys() + RTR0MemObjMapKernel() as a fallback if
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * you have a safe physical address range to make use of...
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb The number of bytes to reserve. This is rounded up to nearest page.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param uAlignment The alignment of the reserved memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjReserveKernel(PRTR0MEMOBJ pMemObj, void *pvFixed, size_t cb, size_t uAlignment);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Reserves user virtual address space in the current process.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param cb The number of bytes to reserve. This is rounded up to nearest PAGE_SIZE.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param uAlignment The alignment of the reserved memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R0Process The process to reserve the memory in. NIL_R0PROCESS is an alias for the current one.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjReserveUser(PRTR0MEMOBJ pMemObj, RTR3PTR R3PtrFixed, size_t cb, size_t uAlignment, RTR0PROCESS R0Process);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Maps a memory object into kernel virtual address space.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObjToMap The object to be map.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param uAlignment The alignment of the reserved memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjMapKernel(PRTR0MEMOBJ pMemObj, RTR0MEMOBJ MemObjToMap, void *pvFixed, size_t uAlignment, unsigned fProt);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Maps a memory object into user virtual address space in the current process.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @returns IPRT status code.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param MemObjToMap The object to be map.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param uAlignment The alignment of the reserved memory.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync * @param R0Process The process to map the memory into. NIL_R0PROCESS is an alias for the current one.
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsyncRTR0DECL(int) RTR0MemObjMapUser(PRTR0MEMOBJ pMemObj, RTR0MEMOBJ MemObjToMap, RTR3PTR R3PtrFixed, size_t uAlignment, unsigned fProt, RTR0PROCESS R0Process);
9de2fa82343af2df7df171b18afbe32b6f37ed84vboxsync#endif /* IN_RING0 */