memobj.h revision fa7c9928985ad8dc74ae6931809083c2af135250
/* $Id$ */
/** @file
* innotek Portable Runtime - Ring-0 Memory Objects.
*/
/*
* Copyright (C) 2006-2007 innotek GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License as published by the Free Software Foundation,
* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
* distribution. VirtualBox OSE is distributed in the hope that it will
* be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef ___internal_memobj_h
#define ___internal_memobj_h
/** @defgroup grp_rt_memobj_int Internals.
* @ingroup grp_rt_memobj
* @internal
* @{
*/
/**
* Ring-0 memory object type.
*/
typedef enum RTR0MEMOBJTYPE
{
/** The traditional invalid value. */
/** @name Primary types (parents)
* @{ */
/** RTR0MemObjAllocPage.
* This memory is page aligned and fixed. */
/** RTR0MemObjAllocLow.
* This memory is page aligned, fixed and is backed by physical memory below 4GB. */
/** RTR0MemObjAllocCont.
* This memory is page aligned, fixed and is backed by contiguous physical memory below 4GB. */
/** RTR0MemObjLockKernel, RTR0MemObjLockUser.
/** RTR0MemObjAllocPhys, RTR0MemObjEnterPhys.
* This memory is physical memory, page aligned, contiguous and doesn't need to have a mapping. */
/** RTR0MemObjAllocPhysNC.
* This memory is physical memory, page aligned and doesn't need to have a mapping. */
/** RTR0MemObjReserveKernel, RTR0MemObjReserveUser.
* This memory is page aligned and has no backing. */
/** @} */
/** @name Secondary types (children)
* @{
*/
/** RTR0MemObjMapUser, RTR0MemObjMapKernel.
* This is a user or kernel context mapping of another ring-0 memory object. */
/** @} */
/** The end of the valid types. Used for sanity checking. */
typedef struct RTR0MEMOBJINTERNAL *PRTR0MEMOBJINTERNAL;
typedef struct RTR0MEMOBJINTERNAL **PPRTR0MEMOBJINTERNAL;
/**
* Ring-0 memory object.
*
* When using the PRTR0MEMOBJINTERNAL and PPRTR0MEMOBJINTERNAL types
* we get pMem and ppMem variable names.
*
* When using the RTR0MEMOBJ and PRTR0MEMOBJ types we get MemObj and
* pMemObj variable names. We never dereference variables of the RTR0MEMOBJ
* type, we always convert it to a PRTR0MEMOBJECTINTERNAL variable first.
*/
typedef struct RTR0MEMOBJINTERNAL
{
/** Magic number (RTR0MEM_MAGIC). */
/** The size of this structure. */
/** The type of allocation. */
/** The size of the memory allocated, pinned down, or mapped. */
/** The memory address.
* What this really is varies with the type.
* For PHYS this might actually be NULL if there isn't any mapping.
*/
void *pv;
/** Object relations. */
union
{
/** This is for tracking child memory handles mapping the
* memory described by the primary handle. */
struct
{
/** Number of mappings. */
/** Number of mappings in the array. */
/** Pointers to child handles mapping this memory. */
} Parent;
/** Pointer to the primary handle. */
struct
{
/** Pointer to the parent. */
} Child;
} uRel;
/** Type specific data for the memory types that requires that. */
union
{
/** RTR0MEMTYPE_PAGE. */
struct
{
unsigned iDummy;
} Page;
/** RTR0MEMTYPE_LOW. */
struct
{
unsigned iDummy;
} Low;
/** RTR0MEMTYPE_CONT. */
struct
{
/** The physical address of the first page. */
} Cont;
/** RTR0MEMTYPE_LOCK_USER. */
struct
{
/** The process that owns the locked memory.
* This is NIL_RTR0PROCESS if it's kernel memory. */
} Lock;
/** RTR0MEMTYPE_PHYS. */
struct
{
/** The base address of the physical memory. */
/** If set this object was created by RTR0MemPhysAlloc, otherwise it was
* created by RTR0MemPhysEnter. */
bool fAllocated;
} Phys;
/** RTR0MEMTYPE_PHYS_NC. */
struct
{
unsigned iDummy;
} PhysNC;
/** RTR0MEMOBJTYPE_RES_VIRT */
struct
{
/** The process that owns the reserved memory.
* This is NIL_RTR0PROCESS if it's kernel memory. */
} ResVirt;
/** RTR0MEMOBJTYPE_MAPPING */
struct
{
/** The process that owns the reserved memory.
* This is NIL_RTR0PROCESS if it's kernel memory. */
} Mapping;
} u;
/**
* Checks if this is mapping or not.
*
* @returns true if it's a mapping, otherwise false.
* @param MemObj The ring-0 memory object handle.
* @see RTR0MemObjIsMapping
*/
{
{
case RTR0MEMOBJTYPE_MAPPING:
return true;
default:
return false;
}
}
/**
* Checks if RTR0MEMOBJ::pv is a ring-3 pointer or not.
*
* @returns true if it's a object with a ring-3 address, otherwise false.
* @param MemObj The ring-0 memory object handle.
*/
{
{
case RTR0MEMOBJTYPE_RES_VIRT:
case RTR0MEMOBJTYPE_LOCK:
case RTR0MEMOBJTYPE_MAPPING:
default:
return false;
}
}
/**
* Frees the memory object (but not the handle).
* Any OS specific handle resources will be freed by this call.
*
* @returns IPRT status code. On failure it is assumed that the object remains valid.
* @param pMem The ring-0 memory object handle to the memory which should be freed.
*/
/**
* Allocates page aligned virtual kernel memory.
*
* The memory is taken from a non paged (= fixed physical memory backing) pool.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param cb Number of bytes to allocate, page aligned.
* @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
*/
/**
* Allocates page aligned virtual kernel memory with physical backing below 4GB.
*
* The physical memory backing the allocation is fixed.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param cb Number of bytes to allocate, page aligned.
* @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
*/
/**
* Allocates page aligned virtual kernel memory with contiguous physical backing below 4GB.
*
* The physical memory backing the allocation is fixed.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param cb Number of bytes to allocate, page aligned.
* @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
*/
/**
* Locks a range of user virtual memory.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param R3Ptr User virtual address, page aligned.
* @param cb Number of bytes to lock, page aligned.
* @param R0Process The process to lock pages in.
*/
int rtR0MemObjNativeLockUser(PPRTR0MEMOBJINTERNAL ppMem, RTR3PTR R3Ptr, size_t cb, RTR0PROCESS R0Process);
/**
* Locks a range of kernel virtual memory.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param pv Kernel virtual address, page aligned.
* @param cb Number of bytes to lock, page aligned.
*/
/**
* Allocates contiguous page aligned physical memory without (necessarily) any kernel mapping.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param cb Number of bytes to allocate, page aligned.
* @param PhysHighest The highest permittable address (inclusive).
* NIL_RTHCPHYS if any address is acceptable.
*/
/**
* Allocates non-contiguous page aligned physical memory without (necessarily) any kernel mapping.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param cb Number of bytes to allocate, page aligned.
* @param PhysHighest The highest permittable address (inclusive).
* NIL_RTHCPHYS if any address is acceptable.
*/
/**
* Creates a page aligned, contiguous, physical memory object.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param Phys The physical address to start at, page aligned.
* @param cb The size of the object in bytes, page aligned.
*/
/**
* Reserves kernel virtual address space.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param pvFixed Requested address. (void *)-1 means any address. This matches uAlignment if specified.
* @param cb The number of bytes to reserve, page aligned.
* @param uAlignment The alignment of the reserved memory; PAGE_SIZE, _2M or _4M.
*/
int rtR0MemObjNativeReserveKernel(PPRTR0MEMOBJINTERNAL ppMem, void *pvFixed, size_t cb, size_t uAlignment);
/**
* Reserves user virtual address space in the current process.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle.
* @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This matches uAlignment if specified.
* @param cb The number of bytes to reserve, page aligned.
* @param uAlignment The alignment of the reserved memory; PAGE_SIZE, _2M or _4M.
* @param R0Process The process to reserve the memory in.
*/
int rtR0MemObjNativeReserveUser(PPRTR0MEMOBJINTERNAL ppMem, RTR3PTR R3PtrFixed, size_t cb, size_t uAlignment, RTR0PROCESS R0Process);
/**
* Maps a memory object into user virtual address space in the current process.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle of the mapping object.
* @param pMemToMap The object to be map.
* @param pvFixed Requested address. (void *)-1 means any address. This matches uAlignment if specified.
* @param uAlignment The alignment of the reserved memory; PAGE_SIZE, _2M or _4M.
* @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
*/
int rtR0MemObjNativeMapKernel(PPRTR0MEMOBJINTERNAL ppMem, PRTR0MEMOBJINTERNAL pMemToMap, void *pvFixed, size_t uAlignment, unsigned fProt);
/**
* Maps a memory object into user virtual address space in the current process.
*
* @returns IPRT status code.
* @param ppMem Where to store the ring-0 memory object handle of the mapping object.
* @param pMemToMap The object to be map.
* @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This matches uAlignment if specified.
* @param uAlignment The alignment of the reserved memory; PAGE_SIZE, _2M or _4M.
* @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
* @param R0Process The process to map the memory into.
*/
int rtR0MemObjNativeMapUser(PPRTR0MEMOBJINTERNAL ppMem, PRTR0MEMOBJINTERNAL pMemToMap, RTR3PTR R3PtrFixed, size_t uAlignment, unsigned fProt, RTR0PROCESS R0Process);
/**
* Get the physical address of an page in the memory object.
*
* @returns The physical address.
* @returns NIL_RTHCPHYS if the object doesn't contain fixed physical pages.
* @returns NIL_RTHCPHYS if the iPage is out of range.
* @returns NIL_RTHCPHYS if the object handle isn't valid.
* @param pMem The ring-0 memory object handle.
* @param iPage The page number within the object (valid).
*/
/** @} */
#endif