VBoxGuestInternal.h revision 7e6ef85020ea6eff872aab83648dd66a511eee10
/* $Id$ */
/** @file
* VBoxGuest - Guest Additions Driver.
*/
/*
* Copyright (C) 2010 Oracle Corporation
*
* 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.
*/
#ifndef ___VBoxGuestInternal_h
#define ___VBoxGuestInternal_h
#include <iprt/semaphore.h>
#include <iprt/spinlock.h>
#include <VBox/VBoxGuest.h>
#include <VBox/VBoxGuestLib.h>
/** @def VBOXGUEST_USE_WAKE_UP_LIST
* Defer wake-up of waiting thread when defined. */
# define VBOXGUEST_USE_DEFERRED_WAKE_UP
#endif
/** Pointer to the VBoxGuest per session data. */
typedef struct VBOXGUESTSESSION *PVBOXGUESTSESSION;
/** 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 list node. */
/** The events we are waiting on. */
/** The events we received. */
uint32_t volatile fResEvents;
/** Set by VBoxGuestWaitDoWakeUps before leaving the spinlock to call
* RTSemEventMultiSignal. */
bool volatile fPendingWakeUp;
/** Set by the requestor thread if it got the spinlock before the
* signaller. Deals with the race in VBoxGuestWaitDoWakeUps. */
bool volatile fFreeMe;
#endif
/** The event semaphore. */
/** The session that's waiting. */
#ifdef VBOX_WITH_HGCM
/** The HGCM request we're waiting for to complete. */
VMMDevHGCMRequestHeader volatile *pHGCMReq;
#endif
/**
* VBox guest memory balloon.
*/
typedef struct VBOXGUESTMEMBALLOON
{
/** Mutex protecting the members below from concurrent access.. */
/** The current number of chunks in the balloon. */
/** The maximum number of chunks in the balloon (typically the amount of guest
* memory / chunksize). */
/** This is true if we are using RTR0MemObjAllocPhysNC() / RTR0MemObjGetPagePhysAddr()
* and false otherwise. */
bool fUseKernelAPI;
/** The current owner of the balloon.
* This is automatically assigned to the first session using the ballooning
* API and first released when the session closes. */
/** The pointer to the array of memory objects holding the chunks of the
* balloon. This array is cMaxChunks in size when present. */
/** Pointer to a memory balloon. */
typedef VBOXGUESTMEMBALLOON *PVBOXGUESTMEMBALLOON;
/**
* 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;
/** Events we won't permit anyone to filter out. */
/** The memory object reserving space for the guest mappings. */
/** Spinlock protecting the signaling and resetting of the wait-for-event
* semaphores as well as the event acking in the ISR. */
/** Preallocated VMMDevEvents for the IRQ handler. */
/** The physical address of pIrqAckEvents. */
/** 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 wait-for-event entries that needs waking up. */
#endif
/** List of wait-for-event entries that has been woken up. */
/** List of free wait-for-event entries. */
/** Mask of pending events. */
uint32_t volatile f32PendingEvents;
/** Current VMMDEV_EVENT_MOUSE_POSITION_CHANGED sequence number.
* Used to implement polling. */
uint32_t volatile u32MousePosChangedSeq;
/** Spinlock various items in the VBOXGUESTSESSION. */
#endif
/** Memory balloon information for RTR0MemObjAllocPhysNC(). */
/** For each mouse status feature the number of sessions which have
* enabled it. A feature is enabled globally if at least one session has
* requested it. */
/** @todo can we programmatically determine the size of the array and
* still get the following alignment right? */
/** The mouse feature status matching the counts above. These are updated
* together inside the session spinlock. */
uint32_t volatile fMouseStatus;
/** Align the next bit on a 64-byte boundary and make sure it starts at the same
* offset in both 64-bit and 32-bit builds.
*
* @remarks The alignments of the members that are larger than 48 bytes should be
* 64-byte for cache line reasons. structs containing small amounts of
* data could be lumped together at the end with a < 64 byte padding
* following it (to grow into and align the struct size).
*/
/** Windows part. */
union
{
#ifdef ___VBoxGuest_win_h
#endif
} win;
/** Pointer to the VBoxGuest driver data. */
typedef VBOXGUESTDEVEXT *PVBOXGUESTDEVEXT;
/**
* 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
/** The last consumed VMMDEV_EVENT_MOUSE_POSITION_CHANGED sequence number.
* Used to implement polling. */
uint32_t volatile u32MousePosChangedSeq;
/** Mouse features supported. A feature enabled in any guest session will
* be enabled for the host. */
uint32_t volatile fMouseStatus;
int VBoxGuestInitDevExt(PVBOXGUESTDEVEXT pDevExt, uint16_t IOPortBase, void *pvMMIOBase, uint32_t cbMMIO, VBOXOSTYPE enmOSType, uint32_t fEvents);
#endif
int VBoxGuestCommonIOCtlFast(unsigned iFunction, PVBOXGUESTDEVEXT pDevExt, PVBOXGUESTSESSION pSession);
#if defined(RT_OS_SOLARIS) \
|| defined(RT_OS_FREEBSD) \
|| defined(RT_OS_LINUX)
DECLVBGL(int) VBoxGuestNativeServiceCall(void *pvOpaque, unsigned int iCmd, void *pvData, size_t cbSize, size_t *pcbReturn);
#endif
/**
* ISR callback for notifying threads polling for mouse events.
*
* This is called at the end of the ISR, after leaving the event spinlock, if
* VMMDEV_EVENT_MOUSE_POSITION_CHANGED was raised by the host.
*
* @param pDevExt The device extension.
*/
#endif