SUPDrvInternal.h revision f45a3488706ab0f2c1e2f699bfdc6bf5df0d1122
/* $Revision$ */
/** @file
* VirtualBox Support Driver - Internal header.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___SUPDrvInternal_h
#define ___SUPDrvInternal_h
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <VBox/cdefs.h>
#include <VBox/types.h>
#include <iprt/assert.h>
#include <iprt/asm.h>
#include <VBox/sup.h>
#include <iprt/memobj.h>
#include <iprt/time.h>
#include <iprt/timer.h>
#include <iprt/string.h>
#include <iprt/err.h>
#if defined(RT_OS_WINDOWS)
__BEGIN_DECLS
# if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
# define _InterlockedExchange _InterlockedExchange_StupidDDKVsCompilerCrap
# define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKVsCompilerCrap
# define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKVsCompilerCrap
# define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKVsCompilerCrap
# define _interlockedbittestandset _interlockedbittestandset_StupidDDKVsCompilerCrap
# define _interlockedbittestandreset _interlockedbittestandreset_StupidDDKVsCompilerCrap
# define _interlockedbittestandset64 _interlockedbittestandset64_StupidDDKVsCompilerCrap
# define _interlockedbittestandreset64 _interlockedbittestandreset64_StupidDDKVsCompilerCrap
# include <ntddk.h>
# undef _InterlockedExchange
# undef _InterlockedExchangeAdd
# undef _InterlockedCompareExchange
# undef _InterlockedAddLargeStatistic
# undef _interlockedbittestandset
# undef _interlockedbittestandreset
# undef _interlockedbittestandset64
# undef _interlockedbittestandreset64
# else
# include <ntddk.h>
# endif
# include <memory.h>
# define memcmp(a,b,c) mymemcmp(a,b,c)
int VBOXCALL mymemcmp(const void *, const void *, size_t);
__END_DECLS
#elif defined(RT_OS_LINUX)
# include <linux/autoconf.h>
# include <linux/version.h>
# if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
# define MODVERSIONS
# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
# include <linux/modversions.h>
# endif
# endif
# if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 0)
# undef ALIGN
# endif
# ifndef KBUILD_STR
# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
# define KBUILD_STR(s) s
# else
# define KBUILD_STR(s) #s
# endif
# endif
# include <linux/string.h>
# include <linux/spinlock.h>
# include <linux/slab.h>
# include <asm/semaphore.h>
# include <linux/timer.h>
# if 0
# include <linux/hrtimer.h>
# define VBOX_HRTIMER
# endif
#elif defined(RT_OS_DARWIN)
# include <libkern/libkern.h>
# include <iprt/string.h>
#elif defined(RT_OS_OS2)
#elif defined(RT_OS_FREEBSD)
# include <sys/libkern.h>
# include <iprt/string.h>
#elif defined(RT_OS_SOLARIS)
# include <sys/cmn_err.h>
# include <iprt/string.h>
#else
# error "unsupported OS."
#endif
#include "SUPDrvIOC.h"
#include "SUPDrvIDC.h"
/*******************************************************************************
* Defined Constants And Macros *
*******************************************************************************/
/*
* Hardcoded cookies.
*/
#define BIRD 0x64726962 /* 'bird' */
#define BIRD_INV 0x62697264 /* 'drib' */
/*
* Win32
*/
#if defined(RT_OS_WINDOWS)
/* debug printf */
# define OSDBGPRINT(a) DbgPrint a
/** Maximum number of bytes we try to lock down in one go.
* This is supposed to have a limit right below 256MB, but this appears
* to actually be much lower. The values here have been determined experimentally.
*/
#ifdef RT_ARCH_X86
# define MAX_LOCK_MEM_SIZE (32*1024*1024) /* 32mb */
#endif
#ifdef RT_ARCH_AMD64
# define MAX_LOCK_MEM_SIZE (24*1024*1024) /* 24mb */
#endif
/*
* Linux
*/
#elif defined(RT_OS_LINUX)
/* check kernel version */
#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0)
# error Unsupported kernel version!
#endif
__BEGIN_DECLS
int linux_dprintf(const char *format, ...);
__END_DECLS
/* debug printf */
# define OSDBGPRINT(a) printk a
/*
* Darwin
*/
#elif defined(RT_OS_DARWIN)
/* debug printf */
# define OSDBGPRINT(a) printf a
/*
* OS/2
*/
#elif defined(RT_OS_OS2)
/* No log API in OS/2 only COM port. */
# define OSDBGPRINT(a) SUPR0Printf a
/*
* FreeBSD
*/
#elif defined(RT_OS_FREEBSD)
/* debug printf */
# define OSDBGPRINT(a) printf a
/*
* Solaris
*/
#elif defined(RT_OS_SOLARIS)
# define OSDBGPRINT(a) SUPR0Printf a
#else
/** @todo other os'es */
# error "OS interface defines is not done for this OS!"
#endif
/* dprintf */
#if (defined(DEBUG) && !defined(NO_LOGGING)) || defined(RT_OS_FREEBSD)
# ifdef LOG_TO_COM
# include <VBox/log.h>
# define dprintf(a) RTLogComPrintf a
# else
# define dprintf(a) OSDBGPRINT(a)
# endif
#else
# define dprintf(a) do {} while (0)
#endif
/* dprintf2 - extended logging. */
#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD)
# define dprintf2 dprintf
#else
# define dprintf2(a) do { } while (0)
#endif
/*
* Error codes.
*/
/** @todo retire the SUPDRV_ERR_* stuff, we ship err.h now. */
/** Invalid parameter. */
#define SUPDRV_ERR_GENERAL_FAILURE (-1)
/** Invalid parameter. */
#define SUPDRV_ERR_INVALID_PARAM (-2)
/** Invalid magic or cookie. */
#define SUPDRV_ERR_INVALID_MAGIC (-3)
/** Invalid loader handle. */
#define SUPDRV_ERR_INVALID_HANDLE (-4)
/** Failed to lock the address range. */
#define SUPDRV_ERR_LOCK_FAILED (-5)
/** Invalid memory pointer. */
#define SUPDRV_ERR_INVALID_POINTER (-6)
/** Failed to patch the IDT. */
#define SUPDRV_ERR_IDT_FAILED (-7)
/** Memory allocation failed. */
#define SUPDRV_ERR_NO_MEMORY (-8)
/** Already loaded. */
#define SUPDRV_ERR_ALREADY_LOADED (-9)
/** Permission denied. */
#define SUPDRV_ERR_PERMISSION_DENIED (-10)
/** Version mismatch. */
#define SUPDRV_ERR_VERSION_MISMATCH (-11)
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/** Pointer to the device extension. */
typedef struct SUPDRVDEVEXT *PSUPDRVDEVEXT;
#ifdef VBOX_WITH_IDT_PATCHING
/**
* An IDT Entry.
*/
typedef struct SUPDRVIDTE
{
/** Low offset word. */
uint32_t u16OffsetLow : 16;
/** Segment Selector. */
uint32_t u16SegSel : 16;
#ifdef RT_ARCH_AMD64
/** Interrupt Stack Table index. */
uint32_t u3IST : 3;
/** Reserved, ignored. */
uint32_t u5Reserved : 5;
#else
/** Reserved. */
uint32_t u5Reserved : 5;
/** IDT Type part one (not used for task gate). */
uint32_t u3Type1 : 3;
#endif
/** IDT Type part two. */
uint32_t u5Type2 : 5;
/** Descriptor Privilege level. */
uint32_t u2DPL : 2;
/** Present flag. */
uint32_t u1Present : 1;
/** High offset word. */
uint32_t u16OffsetHigh : 16;
#ifdef RT_ARCH_AMD64
/** The upper top part of the address. */
uint32_t u32OffsetTop;
/** Reserved dword for qword (aligning the struct), ignored. */
uint32_t u32Reserved;
#endif
} SUPDRVIDTE, *PSUPDRVIDTE;
/** The u5Type2 value for an interrupt gate. */
#define SUPDRV_IDTE_TYPE2_INTERRUPT_GATE 0x0e
/**
* Patch code.
*/
typedef struct SUPDRVPATCH
{
#define SUPDRV_PATCH_CODE_SIZE 0x50
/** Patch code. */
uint8_t auCode[SUPDRV_PATCH_CODE_SIZE];
/** Changed IDT entry (for parnoid UnpatchIdt()). */
SUPDRVIDTE ChangedIdt;
/** Saved IDT entry. */
SUPDRVIDTE SavedIdt;
/** Pointer to the IDT.
* We ASSUME the IDT is not re(al)located after bootup and use this as key
* for the patches rather than processor number. This prevents some
* stupid nesting stuff from happening in case of processors sharing the
* IDT.
* We're fucked if the processors have different physical mapping for
* the(se) page(s), but we'll find that out soon enough in VBOX_STRICT mode.
*/
void *pvIdt;
/** Pointer to the IDT entry. */
SUPDRVIDTE volatile *pIdtEntry;
/** Usage counter. */
uint32_t volatile cUsage;
/** The offset into auCode of the VMMR0Entry fixup. */
uint16_t offVMMR0EntryFixup;
/** The offset into auCode of the stub function. */
uint16_t offStub;
/** Pointer to the next patch. */
struct SUPDRVPATCH * volatile pNext;
} SUPDRVPATCH, *PSUPDRVPATCH;
/**
* Usage record for a patch.
*/
typedef struct SUPDRVPATCHUSAGE
{
/** Next in the chain. */
struct SUPDRVPATCHUSAGE * volatile pNext;
/** The patch this usage applies to. */
PSUPDRVPATCH pPatch;
/** Usage count. */
uint32_t volatile cUsage;
} SUPDRVPATCHUSAGE, *PSUPDRVPATCHUSAGE;
#endif /* VBOX_WITH_IDT_PATCHING */
/**
* Memory reference types.
*/
typedef enum
{
/** Unused entry */
MEMREF_TYPE_UNUSED = 0,
/** Locked memory (r3 mapping only). */
MEMREF_TYPE_LOCKED,
/** Continous memory block (r3 and r0 mapping). */
MEMREF_TYPE_CONT,
/** Low memory block (r3 and r0 mapping). */
MEMREF_TYPE_LOW,
/** Memory block (r3 and r0 mapping). */
MEMREF_TYPE_MEM,
/** Locked memory (r3 mapping only) allocated by the support driver. */
MEMREF_TYPE_LOCKED_SUP,
/** Blow the type up to 32-bit and mark the end. */
MEMREG_TYPE_32BIT_HACK = 0x7fffffff
} SUPDRVMEMREFTYPE, *PSUPDRVMEMREFTYPE;
/**
* Structure used for tracking memory a session
* references in one way or another.
*/
typedef struct SUPDRVMEMREF
{
/** The memory object handle. */
RTR0MEMOBJ MemObj;
/** The ring-3 mapping memory object handle. */
RTR0MEMOBJ MapObjR3;
/** Type of memory. */
SUPDRVMEMREFTYPE eType;
} SUPDRVMEMREF, *PSUPDRVMEMREF;
/**
* Bundle of locked memory ranges.
*/
typedef struct SUPDRVBUNDLE
{
/** Pointer to the next bundle. */
struct SUPDRVBUNDLE * volatile pNext;
/** Referenced memory. */
SUPDRVMEMREF aMem[64];
/** Number of entries used. */
uint32_t volatile cUsed;
} SUPDRVBUNDLE, *PSUPDRVBUNDLE;
/**
* Loaded image.
*/
typedef struct SUPDRVLDRIMAGE
{
/** Next in chain. */
struct SUPDRVLDRIMAGE * volatile pNext;
/** Pointer to the image. */
void *pvImage;
/** Pointer to the optional module initialization callback. */
PFNR0MODULEINIT pfnModuleInit;
/** Pointer to the optional module termination callback. */
PFNR0MODULETERM pfnModuleTerm;
/** Size of the image. */
uint32_t cbImage;
/** The offset of the symbol table. */
uint32_t offSymbols;
/** The number of entries in the symbol table. */
uint32_t cSymbols;
/** The offset of the string table. */
uint32_t offStrTab;
/** Size of the string table. */
uint32_t cbStrTab;
/** The ldr image state. (IOCtl code of last opration.) */
uint32_t uState;
/** Usage count. */
uint32_t volatile cUsage;
/** Image name. */
char szName[32];
} SUPDRVLDRIMAGE, *PSUPDRVLDRIMAGE;
/** Image usage record. */
typedef struct SUPDRVLDRUSAGE
{
/** Next in chain. */
struct SUPDRVLDRUSAGE * volatile pNext;
/** The image. */
PSUPDRVLDRIMAGE pImage;
/** Load count. */
uint32_t volatile cUsage;
} SUPDRVLDRUSAGE, *PSUPDRVLDRUSAGE;
/**
* Registered object.
* This takes care of reference counting and tracking data for access checks.
*/
typedef struct SUPDRVOBJ
{
/** Magic value (SUPDRVOBJ_MAGIC). */
uint32_t u32Magic;
/** The object type. */
SUPDRVOBJTYPE enmType;
/** Pointer to the next in the global list. */
struct SUPDRVOBJ * volatile pNext;
/** Pointer to the object destructor.
* This may be set to NULL if the image containing the destructor get unloaded. */
PFNSUPDRVDESTRUCTOR pfnDestructor;
/** User argument 1. */
void *pvUser1;
/** User argument 2. */
void *pvUser2;
/** The total sum of all per-session usage. */
uint32_t volatile cUsage;
/** The creator user id. */
RTUID CreatorUid;
/** The creator group id. */
RTGID CreatorGid;
/** The creator process id. */
RTPROCESS CreatorProcess;
} SUPDRVOBJ, *PSUPDRVOBJ;
/** Magic number for SUPDRVOBJ::u32Magic. (Dame Agatha Mary Clarissa Christie). */
#define SUPDRVOBJ_MAGIC 0x18900915
/**
* The per-session object usage record.
*/
typedef struct SUPDRVUSAGE
{
/** Pointer to the next in the list. */
struct SUPDRVUSAGE * volatile pNext;
/** Pointer to the object we're recording usage for. */
PSUPDRVOBJ pObj;
/** The usage count. */
uint32_t volatile cUsage;
} SUPDRVUSAGE, *PSUPDRVUSAGE;
/**
* Per session data.
* This is mainly for memory tracking.
*/
typedef struct SUPDRVSESSION
{
/** Pointer to the device extension. */
PSUPDRVDEVEXT pDevExt;
/** Session Cookie. */
uint32_t u32Cookie;
/** Load usage records. (protected by SUPDRVDEVEXT::mtxLdr) */
PSUPDRVLDRUSAGE volatile pLdrUsage;
#ifdef VBOX_WITH_IDT_PATCHING
/** Patch usage records. (protected by SUPDRVDEVEXT::SpinLock) */
PSUPDRVPATCHUSAGE volatile pPatchUsage;
#endif
/** The VM associated with the session. */
PVM pVM;
/** List of generic usage records. (protected by SUPDRVDEVEXT::SpinLock) */
PSUPDRVUSAGE volatile pUsage;
/** Spinlock protecting the bundles and the GIP members. */
RTSPINLOCK Spinlock;
/** The ring-3 mapping of the GIP (readonly). */
RTR0MEMOBJ GipMapObjR3;
/** Set if the session is using the GIP. */
uint32_t fGipReferenced;
/** Bundle of locked memory objects. */
SUPDRVBUNDLE Bundle;
/** The user id of the session. (Set by the OS part.) */
RTUID Uid;
/** The group id of the session. (Set by the OS part.) */
RTGID Gid;
/** The process (id) of the session. (Set by the OS part.) */
RTPROCESS Process;
/** Which process this session is associated with.
* This is NIL_RTR0PROCESS for kernel sessions and valid for user ones. */
RTR0PROCESS R0Process;
#if defined(RT_OS_OS2)
/** The system file number of this session. */
uint16_t sfn;
uint16_t Alignment; /**< Alignment */
#endif
#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_SOLARIS)
/** Pointer to the next session with the same hash. */
PSUPDRVSESSION pNextHash;
#endif
} SUPDRVSESSION;
/**
* Device extension.
*/
typedef struct SUPDRVDEVEXT
{
/** Spinlock to serialize the initialization,
* usage counting and destruction of the IDT entry override and objects. */
RTSPINLOCK Spinlock;
#ifdef VBOX_WITH_IDT_PATCHING
/** List of patches. */
PSUPDRVPATCH volatile pIdtPatches;
/** List of patches Free. */
PSUPDRVPATCH volatile pIdtPatchesFree;
#endif
/** List of registered objects. Protected by the spinlock. */
PSUPDRVOBJ volatile pObjs;
/** List of free object usage records. */
PSUPDRVUSAGE volatile pUsageFree;
/** Global cookie. */
uint32_t u32Cookie;
/** The IDT entry number.
* Only valid if pIdtPatches is set. */
uint8_t volatile u8Idt;
/** Loader mutex.
* This protects pvVMMR0, pvVMMR0Entry, pImages and SUPDRVSESSION::pLdrUsage. */
RTSEMFASTMUTEX mtxLdr;
/** VMM Module 'handle'.
* 0 if the code VMM isn't loaded and Idt are nops. */
void * volatile pvVMMR0;
/** VMMR0EntryInt() pointer. */
DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryInt, (PVM pVM, unsigned uOperation, void *pvArg));
/** VMMR0EntryFast() pointer. */
DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryFast, (PVM pVM, unsigned uOperation));
/** VMMR0EntryEx() pointer. */
DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryEx, (PVM pVM, unsigned uOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg));
/** Linked list of loaded code. */
PSUPDRVLDRIMAGE volatile pLdrImages;
/** GIP mutex.
* Any changes to any of the GIP members requires ownership of this mutex,
* except on driver init and termination. */
RTSEMFASTMUTEX mtxGip;
/** Pointer to the Global Info Page (GIP). */
PSUPGLOBALINFOPAGE pGip;
/** The physical address of the GIP. */
RTHCPHYS HCPhysGip;
/** Number of processes using the GIP.
* (The updates are suspend while cGipUsers is 0.)*/
uint32_t volatile cGipUsers;
/** The ring-0 memory object handle for the GIP page. */
RTR0MEMOBJ GipMemObj;
/** The GIP timer handle. */
PRTTIMER pGipTimer;
/** If non-zero we've successfully called RTTimerRequestSystemGranularity(). */
uint32_t u32SystemTimerGranularityGrant;
/** The CPU id of the GIP master.
* This CPU is responsible for the updating the common GIP data. */
RTCPUID volatile idGipMaster;
} SUPDRVDEVEXT;
__BEGIN_DECLS
/*******************************************************************************
* OS Specific Functions *
*******************************************************************************/
void VBOXCALL supdrvOSObjInitCreator(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession);
bool VBOXCALL supdrvOSObjCanAccess(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession, const char *pszObjName, int *prc);
bool VBOXCALL supdrvOSGetForcedAsyncTscMode(PSUPDRVDEVEXT pDevExt);
/*******************************************************************************
* Shared Functions *
*******************************************************************************/
int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr);
int VBOXCALL supdrvIOCtlFast(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
int VBOXCALL supdrvIDC(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQHDR pReqHdr);
int VBOXCALL supdrvInitDevExt(PSUPDRVDEVEXT pDevExt);
void VBOXCALL supdrvDeleteDevExt(PSUPDRVDEVEXT pDevExt);
int VBOXCALL supdrvCreateSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION *ppSession);
void VBOXCALL supdrvCloseSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
void VBOXCALL supdrvCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
int VBOXCALL supdrvGipInit(PSUPDRVDEVEXT pDevExt, PSUPGLOBALINFOPAGE pGip, RTHCPHYS HCPhys, uint64_t u64NanoTS, unsigned uUpdateHz);
void VBOXCALL supdrvGipTerm(PSUPGLOBALINFOPAGE pGip);
void VBOXCALL supdrvGipUpdate(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS);
void VBOXCALL supdrvGipUpdatePerCpu(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS, unsigned iCpu);
bool VBOXCALL supdrvDetermineAsyncTsc(uint64_t *pu64DiffCores);
__END_DECLS
#endif