VBoxGuestInternal.h revision 7b06d4d64dc8e4ea0ff4a616d9b4128b26b8463e
/* $Id$ */
/** @file
* VBoxGuest - Guest Additions Driver.
*/
/*
* Copyright (C) 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;
* 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.
*
* 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 ___VBoxGuestInternal_h
#define ___VBoxGuestInternal_h
#include <iprt/semaphore.h>
#include <iprt/spinlock.h>
#include <VBox/VBoxGuest.h>
#include <VBox/VBoxGuestLib.h>
/** Pointer to a wait-for-event entry. */
typedef struct VBOXGUESTWAIT *PVBOXGUESTWAIT;
/**
* VBox guest wait for event entry.
*
* Each waiting thread allocates one of these items and adds
* it to the wait list before going to sleep on the event sem.
*/
typedef struct VBOXGUESTWAIT
{
/** The next entry in the list. */
PVBOXGUESTWAIT volatile pNext;
/** The previous entry in the list. */
PVBOXGUESTWAIT volatile pPrev;
/** The event semaphore. */
/** The events we are waiting on. */
/** The events we received. */
uint32_t volatile fResEvents;
#ifdef VBOX_WITH_HGCM
/** The HGCM request we're waiting for to complete. */
VMMDevHGCMRequestHeader volatile *pHGCMReq;
#endif
/**
* VBox guest wait for event list.
*/
typedef struct VBOXGUESTWAITLIST
{
/** The head. */
PVBOXGUESTWAIT volatile pHead;
/** The tail. */
PVBOXGUESTWAIT volatile pTail;
/** Pointer to a wait list. */
typedef VBOXGUESTWAITLIST *PVBOXGUESTWAITLIST;
/**
* VBox guest device (data) extension.
*/
typedef struct VBOXGUESTDEVEXT
{
/** The base of the adapter I/O ports. */
/** Pointer to the mapping of the VMMDev adapter memory. */
VMMDevMemory volatile *pVMMDevMemory;
/** Preallocated VMMDevEvents for the IRQ handler. */
/** Spinlock protecting the signaling and resetting of the wait-for-event semaphores. */
/** Wait-for-event list for threads waiting for multiple events. */
#ifdef VBOX_WITH_HGCM
/** Wait-for-event list for threads waiting on HGCM async completion.
* The entire list is evaluated upon the arrival of an HGCM event, unlike
* the other lists which are only evaluated till the first thread has been woken up. */
#endif
/** List of free wait-for-event entries. */
/** Mask of pending events. */
uint32_t volatile f32PendingEvents;
/** Spinlock various items in the VBOXGUESTSESSION. */
/** The current clipboard client ID, 0 if no client.
* For implementing the VBOXGUEST_IOCTL_CLIPBOARD_CONNECT interface. */
/** Pointer to the VBoxGuest driver data. */
typedef VBOXGUESTDEVEXT *PVBOXGUESTDEVEXT;
/** Pointer to the VBoxGuest per session data. */
typedef struct VBOXGUESTSESSION *PVBOXGUESTSESSION;
/**
* The VBoxGuest per session data.
*
* @remark Not quite sure whether this will be useful or not, but since
* its already there let's keep it for now in case it might come
* in handy later.
*/
typedef struct VBOXGUESTSESSION
{
/** Pointer to the next session with the same hash. */
#endif
#if defined(RT_OS_OS2)
/** The system file number of this session. */
#endif
/** The process (id) of the session.
* This is NIL if it's a kernel session. */
/** Which process this session is associated with.
* This is NIL if it's a kernel session. */
/** Pointer to the device extension. */
#ifdef VBOX_WITH_HGCM
/** Array containing HGCM client IDs associated with this session.
* This will be automatically disconnected when the session is closed. */
#endif
int VBoxGuestInitDevExt(PVBOXGUESTDEVEXT pDevExt, uint16_t IOPortBase, void *pvMMIOBase, uint32_t cbMMIO, VBOXOSTYPE enmOSType);
int VBoxGuestCommonIOCtlFast(unsigned iFunction, PVBOXGUESTDEVEXT pDevExt, PVBOXGUESTSESSION pSession);
#endif