SUPDRV.h revision 7aaf943021d3988cf422065af0f66882f75b9dd4
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/* $Revision$ */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/** @file
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * VirtualBox Support Driver - Internal header.
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * available from http://www.virtualbox.org. This file is free software;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * General Public License (GPL) as published by the Free Software
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * The contents of this file may alternatively be used under the terms
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * of the Common Development and Distribution License Version 1.0
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * VirtualBox OSE distribution, in which case the provisions of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * CDDL are applicable instead of those of the GPL.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * You may elect to license modified versions of this file under the
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync * terms and conditions of either the GPL or the CDDL or both.
7b9f0c34e9ea328981c99e97054bdf8684d9d620vboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * additional information or have any questions.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#ifndef ___SUPDRV_h
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync#define ___SUPDRV_h
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync/*******************************************************************************
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync* Header Files *
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync*******************************************************************************/
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <VBox/cdefs.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <VBox/types.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/assert.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/asm.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <VBox/sup.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/memobj.h>
13f1ce3859ee77d9b9f4d2ca9f93e1633cb133bcvboxsync#include <iprt/time.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/timer.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/string.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/err.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#if defined(RT_OS_WINDOWS)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync __BEGIN_DECLS
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _InterlockedExchange _InterlockedExchange_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _interlockedbittestandset _interlockedbittestandset_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _interlockedbittestandreset _interlockedbittestandreset_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _interlockedbittestandset64 _interlockedbittestandset64_StupidDDKVsCompilerCrap
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define _interlockedbittestandreset64 _interlockedbittestandreset64_StupidDDKVsCompilerCrap
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <ntddk.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _InterlockedExchange
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# undef _InterlockedExchangeAdd
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _InterlockedCompareExchange
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _InterlockedAddLargeStatistic
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _interlockedbittestandset
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _interlockedbittestandreset
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _interlockedbittestandset64
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef _interlockedbittestandreset64
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# else
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# include <ntddk.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# endif
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# include <memory.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define memcmp(a,b,c) mymemcmp(a,b,c)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync int VBOXCALL mymemcmp(const void *, const void *, size_t);
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync __END_DECLS
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_LINUX)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/autoconf.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/version.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define MODVERSIONS
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/modversions.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 0)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# undef ALIGN
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# ifndef KBUILD_STR
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define KBUILD_STR(s) s
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define KBUILD_STR(s) #s
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/string.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/spinlock.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/slab.h>
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# include <asm/semaphore.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/timer.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# if 0
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <linux/hrtimer.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define VBOX_HRTIMER
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_DARWIN)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <libkern/libkern.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <iprt/string.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_OS2)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_FREEBSD)
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# include <sys/libkern.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <iprt/string.h>
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync#elif defined(RT_OS_SOLARIS)
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# include <sys/cmn_err.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# include <iprt/string.h>
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# error "unsupported OS."
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#include "SUPDRVIOC.h"
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*******************************************************************************
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync* Defined Constants And Macros *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync*******************************************************************************/
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Hardcoded cookies.
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#define BIRD 0x64726962 /* 'bird' */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#define BIRD_INV 0x62697264 /* 'drib' */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync * Win32
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#if defined(RT_OS_WINDOWS)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync/* debug printf */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define OSDBGPRINT(a) DbgPrint a
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync/** Maximum number of bytes we try to lock down in one go.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * This is supposed to have a limit right below 256MB, but this appears
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * to actually be much lower. The values here have been determined experimentally.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#ifdef RT_ARCH_X86
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define MAX_LOCK_MEM_SIZE (32*1024*1024) /* 32mb */
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync#endif
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#ifdef RT_ARCH_AMD64
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync# define MAX_LOCK_MEM_SIZE (24*1024*1024) /* 24mb */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#endif
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync/*
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync * Linux
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync#elif defined(RT_OS_LINUX)
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync/* check kernel version */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0)
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync# error Unsupported kernel version!
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync#endif
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync__BEGIN_DECLS
8bc8d66f188d5357155b8340e2d489573be2b607vboxsyncint linux_dprintf(const char *format, ...);
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync__END_DECLS
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* debug printf */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define OSDBGPRINT(a) printk a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/*
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync * Darwin
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_DARWIN)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* debug printf */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define OSDBGPRINT(a) printf a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/*
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync * OS/2
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_OS2)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* No log API in OS/2 only COM port. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define OSDBGPRINT(a) SUPR0Printf a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/*
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync * FreeBSD
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_FREEBSD)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* No log API in OS/2 only COM port. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define OSDBGPRINT(a) printf a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/*
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync * Solaris
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#elif defined(RT_OS_SOLARIS)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define OSDBGPRINT(a) SUPR0Printf a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/** @todo other os'es */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# error "OS interface defines is not done for this OS!"
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* dprintf */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#if (defined(DEBUG) && !defined(NO_LOGGING)) || defined(RT_OS_FREEBSD)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# ifdef LOG_TO_COM
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync# include <VBox/log.h>
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define dprintf(a) RTLogComPrintf a
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define dprintf(a) OSDBGPRINT(a)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define dprintf(a) do {} while (0)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/* dprintf2 - extended logging. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define dprintf2 dprintf
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync# define dprintf2(a) do { } while (0)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#endif
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/*
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync * Error codes.
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync */
0d49a2fbc9857ad8dd29542de7fb37202f1a283fvboxsync/** Invalid parameter. */
0d49a2fbc9857ad8dd29542de7fb37202f1a283fvboxsync#define SUPDRV_ERR_GENERAL_FAILURE (-1)
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync/** Invalid parameter. */
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync#define SUPDRV_ERR_INVALID_PARAM (-2)
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync/** Invalid magic or cookie. */
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync#define SUPDRV_ERR_INVALID_MAGIC (-3)
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync/** Invalid loader handle. */
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync#define SUPDRV_ERR_INVALID_HANDLE (-4)
0d49a2fbc9857ad8dd29542de7fb37202f1a283fvboxsync/** Failed to lock the address range. */
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync#define SUPDRV_ERR_LOCK_FAILED (-5)
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync/** Invalid memory pointer. */
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync#define SUPDRV_ERR_INVALID_POINTER (-6)
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync/** Failed to patch the IDT. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#define SUPDRV_ERR_IDT_FAILED (-7)
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync/** Memory allocation failed. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#define SUPDRV_ERR_NO_MEMORY (-8)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/** Already loaded. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#define SUPDRV_ERR_ALREADY_LOADED (-9)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/** Permission denied. */
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync#define SUPDRV_ERR_PERMISSION_DENIED (-10)
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/** Version mismatch. */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync#define SUPDRV_ERR_VERSION_MISMATCH (-11)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync/*******************************************************************************
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync* Structures and Typedefs *
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync*******************************************************************************/
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync/** Pointer to the device extension. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsynctypedef struct SUPDRVDEVEXT *PSUPDRVDEVEXT;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync#ifdef RT_OS_LINUX
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync# ifdef VBOX_HRTIMER
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsynctypedef struct hrtimer VBOXKTIMER;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync# else
cd5df721f068659172f3bf95de8fedeb465f057dvboxsynctypedef struct timer_list VBOXKTIMER;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync# endif
ded83c04697bf14ebe491890cd19cec3c8d94aa1vboxsynctypedef VBOXKTIMER *PVBOXKTIMER;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync#endif
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync#ifdef VBOX_WITH_IDT_PATCHING
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync/**
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync * An IDT Entry.
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsynctypedef struct SUPDRVIDTE
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync{
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync /** Low offset word. */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync uint32_t u16OffsetLow : 16;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync /** Segment Selector. */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync uint32_t u16SegSel : 16;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync#ifdef RT_ARCH_AMD64
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync /** Interrupt Stack Table index. */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync uint32_t u3IST : 3;
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync /** Reserved, ignored. */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync uint32_t u5Reserved : 5;
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync#else
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync /** Reserved. */
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync uint32_t u5Reserved : 5;
ded83c04697bf14ebe491890cd19cec3c8d94aa1vboxsync /** IDT Type part one (not used for task gate). */
ded83c04697bf14ebe491890cd19cec3c8d94aa1vboxsync uint32_t u3Type1 : 3;
ded83c04697bf14ebe491890cd19cec3c8d94aa1vboxsync#endif
ded83c04697bf14ebe491890cd19cec3c8d94aa1vboxsync /** IDT Type part two. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync uint32_t u5Type2 : 5;
510567648d46488f4166e5f69ffffe3eeeeec4d9vboxsync /** Descriptor Privilege level. */
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync uint32_t u2DPL : 2;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** Present flag. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync uint32_t u1Present : 1;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** High offset word. */
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync uint32_t u16OffsetHigh : 16;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#ifdef RT_ARCH_AMD64
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync /** The upper top part of the address. */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync uint32_t u32OffsetTop;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync /** Reserved dword for qword (aligning the struct), ignored. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync uint32_t u32Reserved;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync#endif
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync} SUPDRVIDTE, *PSUPDRVIDTE;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/** The u5Type2 value for an interrupt gate. */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync#define SUPDRV_IDTE_TYPE2_INTERRUPT_GATE 0x0e
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync/**
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Patch code.
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsynctypedef struct SUPDRVPATCH
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync{
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync#define SUPDRV_PATCH_CODE_SIZE 0x50
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Patch code. */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync uint8_t auCode[SUPDRV_PATCH_CODE_SIZE];
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Changed IDT entry (for parnoid UnpatchIdt()). */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync SUPDRVIDTE ChangedIdt;
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Saved IDT entry. */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync SUPDRVIDTE SavedIdt;
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Pointer to the IDT.
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * We ASSUME the IDT is not re(al)located after bootup and use this as key
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * for the patches rather than processor number. This prevents some
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * stupid nesting stuff from happening in case of processors sharing the
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * IDT.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * We're fucked if the processors have different physical mapping for
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * the(se) page(s), but we'll find that out soon enough in VBOX_STRICT mode.
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync void *pvIdt;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Pointer to the IDT entry. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync SUPDRVIDTE volatile *pIdtEntry;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** Usage counter. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync uint32_t volatile cUsage;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** The offset into auCode of the VMMR0Entry fixup. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync uint16_t offVMMR0EntryFixup;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** The offset into auCode of the stub function. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync uint16_t offStub;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Pointer to the next patch. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync struct SUPDRVPATCH * volatile pNext;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync} SUPDRVPATCH, *PSUPDRVPATCH;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync/**
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync * Usage record for a patch.
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsynctypedef struct SUPDRVPATCHUSAGE
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync{
18e3d4704ed7b57260b0d4e3ea12c224b3f81840vboxsync /** Next in the chain. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync struct SUPDRVPATCHUSAGE * volatile pNext;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** The patch this usage applies to. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync PSUPDRVPATCH pPatch;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** Usage count. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync uint32_t volatile cUsage;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync} SUPDRVPATCHUSAGE, *PSUPDRVPATCHUSAGE;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync#endif /* VBOX_WITH_IDT_PATCHING */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync/**
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync * Memory reference types.
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsynctypedef enum
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync{
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Unused entry */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync MEMREF_TYPE_UNUSED = 0,
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Locked memory (r3 mapping only). */
b8bb9c9f6b8ebfd0a7d6df0c0289f9fe80241750vboxsync MEMREF_TYPE_LOCKED,
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Continous memory block (r3 and r0 mapping). */
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync MEMREF_TYPE_CONT,
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync /** Low memory block (r3 and r0 mapping). */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync MEMREF_TYPE_LOW,
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Memory block (r3 and r0 mapping). */
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync MEMREF_TYPE_MEM,
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Locked memory (r3 mapping only) allocated by the support driver. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync MEMREF_TYPE_LOCKED_SUP,
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** Blow the type up to 32-bit and mark the end. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync MEMREG_TYPE_32BIT_HACK = 0x7fffffff
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync} SUPDRVMEMREFTYPE, *PSUPDRVMEMREFTYPE;
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync/**
5050fc8de0b121eab1b738d7c1007cde4903284dvboxsync * Structure used for tracking memory a session
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync * references in one way or another.
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsynctypedef struct SUPDRVMEMREF
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync{
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync /** The memory object handle. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync RTR0MEMOBJ MemObj;
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync /** The ring-3 mapping memory object handle. */
88cc9bf61296bc5526344415167bb2625ae1dd99vboxsync RTR0MEMOBJ MapObjR3;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync /** Type of memory. */
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync SUPDRVMEMREFTYPE eType;
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync} SUPDRVMEMREF, *PSUPDRVMEMREF;
510567648d46488f4166e5f69ffffe3eeeeec4d9vboxsync
8bc8d66f188d5357155b8340e2d489573be2b607vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/**
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Bundle of locked memory ranges.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync */
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. */
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 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