VBoxNetFltInternal.h revision 3c095b4909446dd036ca3251b62f023a6754aed0
/* $Id$ */
/** @file
* VBoxNetFlt - Network Filter Driver (Host), Internal Header.
*/
/*
* Copyright (C) 2008 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 ___VBoxNetFltInternal_h___
#define ___VBoxNetFltInternal_h___
#include <iprt/semaphore.h>
/** Pointer to the globals. */
typedef struct VBOXNETFLTGLOBALS *PVBOXNETFLTGLOBALS;
/**
* The state of a filter driver instance.
*
* The state machine differs a bit between the platforms because of
* the way we hook into the stack. On some hosts we can dynamically
* attach when required (on CreateInstance) and on others we will
* have to connect when the network stack is bound up. These modes
* are called static and dynamic config and governed at compile time
* by the VBOXNETFLT_STATIC_CONFIG define.
*
* See sec_netflt_msc for more details on locking and synchronization.
*/
typedef enum VBOXNETFTLINSSTATE
{
/** The usual invalid state. */
/** Initialization.
* We've reserved the interface name but need to attach to the actual
* network interface outside the lock to avoid deadlocks.
* In the dynamic case this happens during a Create(Instance) call.
* In the static case it happens during driver initialization. */
#ifdef VBOXNETFLT_STATIC_CONFIG
/** Unconnected, not hooked up to a switch (static only).
* The filter driver instance has been instantiated and hooked up,
* waiting to be connected to an internal network. */
#endif
/** Connected to an internal network. */
/** Disconnecting from the internal network and possibly the host network interface.
* Partly for reasons of deadlock avoidance again. */
/** The instance has been disconnected from both the host and the internal network. */
/** The habitual 32-bit enum hack. */
kVBoxNetFltInsState_32BitHack = 0x7fffffff
/**
* The per-instance data of the VBox filter driver.
*
* This is data associated with a network interface / NIC / wossname which
* the filter driver has been or may be attached to. When possible it is
* attached dynamically, but this may not be possible on all OSes so we have
* to be flexible about things.
*
* A network interface / NIC / wossname can only have one filter driver
* instance attached to it. So, attempts at connecting an internal network
* to an interface that's already in use (connected to another internal network)
* will result in a VERR_SHARING_VIOLATION.
*
* Only one internal network can connect to a filter driver instance.
*/
typedef struct VBOXNETFLTINS
{
/** Pointer to the next interface in the list. (VBOXNETFLTGLOBAL::pInstanceHead) */
struct VBOXNETFLTINS *pNext;
/** Our RJ-45 port.
* This is what the internal network plugs into. */
/** The RJ-45 port on the INTNET "switch".
* This is what we're connected to. */
/** Pointer to the globals. */
/** The spinlock protecting the state variables and host interface handle. */
/** The current interface state. */
VBOXNETFTLINSSTATE volatile enmState;
/** Active / Suspended indicator. */
bool volatile fActive;
/** Disconnected from the host network interface. */
bool volatile fDisconnectedFromHost;
/** Rediscovery is pending.
* cBusy will never reach zero during rediscovery, so which
* takes care of serializing rediscovery and disconnecting. */
bool volatile fRediscoveryPending;
/** Whether we should not attempt to set promiscuous mode at all. */
bool fDisablePromiscuous;
#endif
/** The timestamp of the last rediscovery. */
uint64_t volatile NanoTSLastRediscovery;
/** Reference count. */
/** The busy count.
* This counts the number of current callers and pending packet. */
/** The event that is signaled when we go idle and that pfnWaitForIdle blocks on. */
union
{
#ifdef VBOXNETFLT_OS_SPECFIC
struct
{
# if defined(RT_OS_DARWIN)
/** @name Darwin instance data.
* @{ */
/** Pointer to the darwin network interface we're attached to.
* This is treated as highly volatile and should only be read and retained
* while owning hSpinlock. Releasing references to this should not be done
* while owning it though as we might end up destroying it in some paths. */
/** The interface filter handle.
* Same access rules as with pIfNet. */
interface_filter_t volatile pIfFilter;
/** Whether we've need to set promiscuous mode when the interface comes up. */
bool volatile fNeedSetPromiscuous;
/** Whether we've successfully put the interface into to promiscuous mode.
* This is for dealing with the ENETDOWN case. */
bool volatile fSetPromiscuous;
/** The MAC address of the interface. */
/** @} */
# elif defined(RT_OS_LINUX)
/** @name Linux instance data
* @{ */
/** Pointer to the device. */
struct net_device volatile *pDev;
/** Whether we've successfully put the interface into to promiscuous mode.
* This is for dealing with the ENETDOWN case. */
bool volatile fPromiscuousSet;
/** Whether device exists and physically attached. */
bool volatile fRegistered;
/** The MAC address of the interface. */
struct notifier_block Notifier;
struct packet_type PacketType;
struct sk_buff_head XmitQueue;
struct work_struct XmitTask;
/** @} */
# elif defined(RT_OS_SOLARIS)
/** @name Solaris instance data.
* @{ */
/** Pointer to the bound IPv4 stream. */
void volatile *pvIp4Stream;
/** Pointer to the bound IPv6 stream. */
void volatile *pvIp6Stream;
/** Pointer to the bound ARP stream. */
void volatile *pvArpStream;
/** Pointer to the unbound promiscuous stream. */
void volatile *pvPromiscStream;
/** Layered device handle to the interface. */
/** The MAC address of the interface. */
/** Mutex protection used for loopback. */
/** @} */
# elif defined(RT_OS_WINDOWS)
/** @name Windows instance data.
* @{ */
/** Filter driver device context. */
/** Packet worker thread info */
/** The MAC address of the interface. Caching MAC for performance reasons. */
/** @} */
# else
# error "PORTME"
# endif
} s;
#endif
/** Padding. */
#if defined(RT_OS_WINDOWS)
# if defined(VBOX_NETFLT_ONDEMAND_BIND)
# elif defined(VBOXNETADP)
# else
# endif
#elif defined(RT_OS_LINUX)
#else
#endif
} u;
/** The interface name. */
char szName[1];
/** Pointer to the instance data of a host network filter driver. */
typedef struct VBOXNETFLTINS *PVBOXNETFLTINS;
#ifdef VBOXNETFLT_OS_SPECFIC
#endif
/**
* The global data of the VBox filter driver.
*
* This contains the bit required for communicating with support driver, VBoxDrv
* (start out as SupDrv).
*/
typedef struct VBOXNETFLTGLOBALS
{
/** Mutex protecting the list of instances and state changes. */
/** Pointer to a list of instance data. */
/** The INTNET trunk network interface factory. */
/** The SUPDRV component factory registration. */
/** The number of current factory references. */
int32_t volatile cFactoryRefs;
/** Whether the IDC connection is open or not.
* This is only for cleaning up correctly after the separate IDC init on Windows. */
bool fIDCOpen;
/** The SUPDRV IDC handle (opaque struct). */
DECLHIDDEN(PVBOXNETFLTINS) vboxNetFltFindInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName);
#ifdef VBOXNETFLT_STATIC_CONFIG
DECLHIDDEN(int) vboxNetFltSearchCreateInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName, PVBOXNETFLTINS *ppInstance, void * pContext);
#endif
/** @name The OS specific interface.
* @{ */
/**
* Try rediscover the host interface.
*
* This is called periodically from the transmit path if we're marked as
* disconnected from the host. There is no chance of a race here.
*
* @returns true if the interface was successfully rediscovered and reattach,
* otherwise false.
* @param pThis The new instance.
*/
/**
* Transmits a frame.
*
* @return IPRT status code.
* @param pThis The new instance.
* @param pSG The (scatter/)gather list.
* @param fDst The destination mask. At least one bit will be set.
*
* @remarks Owns the out-bound trunk port semaphore.
*/
/**
* Checks if the interface is in promiscuous mode from the host perspective.
*
* If it is, then the internal networking switch will send frames
* heading for the wire to the host as well.
*
* @see INTNETTRUNKIFPORT::pfnIsPromiscuous for more details.
*
* @returns true / false accordingly.
* @param pThis The instance.
*
* @remarks Owns the network lock and the out-bound trunk port semaphores.
*/
/**
* Get the MAC address of the interface we're attached to.
*
* Used by the internal networking switch for implementing the
* shared-MAC-on-the-wire mode.
*
* @param pThis The instance.
* @param pMac Where to store the MAC address.
* If you don't know, set all the bits except the first (the multicast one).
*
* @remarks Owns the network lock and the out-bound trunk port semaphores.
*/
/**
* Checks if the specified MAC address is for any of the host interfaces.
*
* Used by the internal networking switch to decide the destination(s)
* of a frame.
*
* @returns true / false accordingly.
* @param pThis The instance.
* @param pMac The MAC address.
*
* @remarks Owns the network lock and the out-bound trunk port semaphores.
*/
/**
* This is called when activating or suspending the instance.
*
* Use this method to enable and disable promiscuous mode on
* the interface to prevent unnecessary interrupt load.
*
* It is only called when the state changes.
*
* @param pThis The instance.
*
* @remarks Owns the lock for the out-bound trunk port.
*/
/**
* This is called to when disconnecting from a network.
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
*/
/**
* This is called to when connecting to a network.
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks Owns the semaphores for the global list, the network lock and the out-bound trunk port.
*/
/**
* Counter part to vboxNetFltOsInitInstance().
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
*/
/**
* This is called to attach to the actual host interface
* after linking the instance into the list.
*
* @return IPRT status code.
* @param pThis The new instance.
* @param pvContext The user supplied context in the static config only.
* NULL in the dynamic config.
*
* @remarks Owns no locks.
*/
/**
* This is called to perform structure initializations.
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks Owns no locks.
*/
/** @} */
#endif