VBoxNetAdpInternal.h revision c58f1213e628a545081c70e26c6b67a841cff880
/* $Id$ */
/** @file
* VBoxNetAdp - Network Filter Driver (Host), Internal Header.
*/
/*
* Copyright (C) 2008-2012 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 ___VBoxNetAdpInternal_h___
#define ___VBoxNetAdpInternal_h___
#include <iprt/semaphore.h>
/** Pointer to the globals. */
typedef struct VBOXNETADPGLOBALS *PVBOXNETADPGLOBALS;
#define VBOXNETADP_MAX_INSTANCES 128
#define VBOXNETADP_MAX_UNITS 128
#define VBOXNETADP_NAME "vboxnet"
#define VBOXNETADP_MAX_NAME_LEN 32
#define VBOXNETADP_MTU 1500
#if defined(RT_OS_DARWIN)
# define VBOXNETADP_MAX_FAMILIES 4
# define VBOXNETADP_DETACH_TIMEOUT 500
#endif
#define VBOXNETADP_CTL_DEV_NAME "vboxnetctl"
typedef struct VBoxNetAdpReq
{
char szName[VBOXNETADP_MAX_NAME_LEN];
typedef VBOXNETADPREQ *PVBOXNETADPREQ;
/**
* Void entries mark vacant slots in adapter array. Valid entries are busy slots.
* As soon as slot is being modified its state changes to transitional.
* An entry in transitional state must only be accessed by the thread that
* put it to this state.
*/
/**
* To avoid races on adapter fields we stick to the following rules:
* - rewrite: Int net port calls are serialized
* - No modifications are allowed on busy adapters (deactivate first)
* Refuse to destroy adapter until it gets to available state
* - No transfers (thus getting busy) on inactive adapters
* - Init sequence: void->available->connected->active
1) Create
2) Connect
3) Activate
* - Destruction sequence: active->connected->available->void
1) Deactivate
2) Disconnect
3) Destroy
*/
enum VBoxNetAdpState
{
kVBoxNetAdpState_U32Hack = 0xFFFFFFFF
};
typedef enum VBoxNetAdpState VBOXNETADPSTATE;
struct VBoxNetAdapter
{
/** Denotes availability of this slot in adapter array. */
/** Corresponds to the digit at the end of device name. */
int iUnit;
union
{
#ifdef VBOXNETADP_OS_SPECFIC
struct
{
# if defined(RT_OS_DARWIN)
/** @name Darwin instance data.
* @{ */
/** Event to signal detachment of interface. */
/** Pointer to Darwin interface structure. */
/** MAC address. */
/** Protocol families attached to this adapter. */
/** Packet sniffer mode. */
/** @} */
# elif defined(RT_OS_LINUX)
/** @name Darwin instance data.
* @{ */
/** Pointer to Linux network device structure. */
struct net_device *pNetDev;
/** @} */
# elif defined(RT_OS_FREEBSD)
/** @name FreeBSD instance data.
* @{ */
/** @} */
# else
# endif
} s;
#endif
/** Union alignment to a pointer. */
void *pvAlign;
/** Padding. */
} u;
/** The interface name. */
char szName[VBOXNETADP_MAX_NAME_LEN];
};
typedef struct VBoxNetAdapter VBOXNETADP;
typedef VBOXNETADP *PVBOXNETADP;
/* Paranoia checks for alignment and padding. */
DECLHIDDEN(int) vboxNetAdpInit(void);
DECLHIDDEN(void) vboxNetAdpShutdown(void);
/**
* This is called to perform OS-specific structure initializations.
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks Owns no locks.
*/
/**
* Counter part to vboxNetAdpOsCreate().
*
* @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 pMac The MAC address to use for this instance.
*
* @remarks Owns no locks.
*/
#endif