VBoxNetAdpInternal.h revision e64031e20c39650a7bc902a3e1aba613b9415dee
/* $Id$ */
/** @file
* VBoxNetAdp - Network Filter Driver (Host), Internal Header.
*/
/*
* Copyright (C) 2008 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* 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 <VBox/sup.h>
#include <VBox/intnet.h>
#include <iprt/semaphore.h>
#include <iprt/assert.h>
RT_C_DECLS_BEGIN
/** Pointer to the globals. */
typedef struct VBOXNETADPGLOBALS *PVBOXNETADPGLOBALS;
#define VBOXNETADP_MAX_INSTANCES 8
#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"
#define VBOXNETADP_CTL_ADD _IOR('v', 1, VBOXNETADPREQ)
#define VBOXNETADP_CTL_REMOVE _IOW('v', 2, VBOXNETADPREQ)
typedef struct VBoxNetAdpReq
{
char szName[VBOXNETADP_MAX_NAME_LEN];
} VBOXNETADPREQ;
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_Invalid,
kVBoxNetAdpState_Transitional,
kVBoxNetAdpState_Active,
kVBoxNetAdpState_U32Hack = 0xFFFFFFFF
};
typedef enum VBoxNetAdpState VBOXNETADPSTATE;
struct VBoxNetAdapter
{
/** Denotes availability of this slot in adapter array. */
VBOXNETADPSTATE enmState;
/** Corresponds to the digit at the end of device name. */
uint32_t uUnit;
union
{
#ifdef VBOXNETADP_OS_SPECFIC
struct
{
# if defined(RT_OS_DARWIN)
/** @name Darwin instance data.
* @{ */
/** Event to signal detachment of interface. */
RTSEMEVENT hEvtDetached;
/** Pointer to Darwin interface structure. */
ifnet_t pIface;
/** MAC address. */
RTMAC Mac;
/** Protocol families attached to this adapter. */
protocol_family_t aAttachedFamilies[VBOXNETADP_MAX_FAMILIES];
/** @} */
# 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.
* @{ */
struct ifnet *ifp;
/** @} */
# else
# error PORTME
# endif
} s;
#endif
/** Padding. */
#if defined(RT_OS_WINDOWS)
# if defined(VBOX_NETFLT_ONDEMAND_BIND)
uint8_t abPadding[192];
# else
uint8_t abPadding[1024];
# endif
#elif defined(RT_OS_LINUX)
uint8_t abPadding[64];
#else
uint8_t abPadding[64];
#endif
} u;
/** The interface name. */
char szName[VBOXNETADP_MAX_NAME_LEN];
};
typedef struct VBoxNetAdapter VBOXNETADP;
typedef VBOXNETADP *PVBOXNETADP;
DECLHIDDEN(int) vboxNetAdpInit(void);
DECLHIDDEN(void) vboxNetAdpShutdown(void);
DECLHIDDEN(int) vboxNetAdpCreate (PVBOXNETADP *ppNew);
DECLHIDDEN(int) vboxNetAdpDestroy(PVBOXNETADP pThis);
DECLHIDDEN(PVBOXNETADP) vboxNetAdpFindByName(const char *pszName);
DECLHIDDEN(void) vboxNetAdpComposeMACAddress(PVBOXNETADP pThis, PRTMAC pMac);
/**
* This is called to perform OS-specific structure initializations.
*
* @return IPRT status code.
* @param pThis The new instance.
*
* @remarks Owns no locks.
*/
DECLHIDDEN(int) vboxNetAdpOsInit(PVBOXNETADP pThis);
/**
* 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.
*/
DECLHIDDEN(void) vboxNetAdpOsDestroy(PVBOXNETADP pThis);
/**
* 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.
*/
DECLHIDDEN(int) vboxNetAdpOsCreate(PVBOXNETADP pThis, PCRTMAC pMac);
RT_C_DECLS_END
#endif