SysHlp.h revision 3d27b794dc7450a9e848b504a701fb139b3f7e66
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* $Revision$ */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/** @file
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VBoxGuestLibR0 - System dependent helpers internal header.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/*
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Copyright (C) 2006-2007 Oracle Corporation
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * available from http://www.virtualbox.org. This file is free software;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * General Public License (GPL) as published by the Free Software
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The contents of this file may alternatively be used under the terms
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * of the Common Development and Distribution License Version 1.0
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * VirtualBox OSE distribution, in which case the provisions of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * CDDL are applicable instead of those of the GPL.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync *
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * You may elect to license modified versions of this file under the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * terms and conditions of either the GPL or the CDDL or both.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync */
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef __VBoxGuestLib_SysHlp_h
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define __VBoxGuestLib_SysHlp_h
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include <iprt/types.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef RT_OS_WINDOWS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef PAGE_SIZE
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef PAGE_SHIFT
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# include <iprt/asm.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _InterlockedExchange _InterlockedExchange_StupidDDKVsCompilerCrap
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKVsCompilerCrap
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKVsCompilerCrap
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKVsCompilerCrap
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# pragma warning(disable : 4163)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncRT_C_DECLS_BEGIN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# include <ntddk.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncRT_C_DECLS_END
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# pragma warning(default : 4163)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef _InterlockedExchange
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef _InterlockedExchangeAdd
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef _InterlockedCompareExchange
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# undef _InterlockedAddLargeStatistic
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# else
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncRT_C_DECLS_BEGIN
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# include <ntddk.h>
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncRT_C_DECLS_END
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync# endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* XP DDK #defines ExFreePool to ExFreePoolWithTag. The latter does not exist on NT4, so...
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The same for ExAllocatePool.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#undef ExAllocatePool
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#undef ExFreePool
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsynctypedef struct _VBGLDRIVER
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifdef RT_OS_WINDOWS
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync PDEVICE_OBJECT pDeviceObject;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync PFILE_OBJECT pFileObject;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#elif defined (RT_OS_OS2)
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync uint32_t u32Session; /**< just for sanity checking. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#else /* PORTME */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync void *pvOpaque;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync} VBGLDRIVER;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncint vbglLockLinear (void **ppvCtx, void *pv, uint32_t u32Size, bool fWriteAccess, uint32_t fFlags);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncvoid vbglUnlockLinear (void *pvCtx, void *pv, uint32_t u32Size);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef VBGL_VBOXGUEST
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Open VBoxGuest driver.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pDriver Pointer to the driver structure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return VBox error code
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncint vbglDriverOpen (VBGLDRIVER *pDriver);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Answers whether the VBoxGuest driver is opened
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pDriver Pointer to the driver structure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return true - if opened, false - otherwise
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncbool vbglDriverIsOpened (VBGLDRIVER *pDriver);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Call VBoxGuest driver.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pDriver Pointer to the driver structure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param u32Function Function code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pvData Pointer to supplied in/out data buffer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param cbData Size of data buffer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return VBox error code
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncint vbglDriverIOCtl (VBGLDRIVER *pDriver, uint32_t u32Function, void *pvData, uint32_t cbData);
/**
* Close VBoxGuest driver.
*
* @param pDriver Pointer to the driver structure.
*
* @return VBox error code
*/
void vbglDriverClose (VBGLDRIVER *pDriver);
#endif
#endif /* !__VBoxGuestLib_SysHlp_h */