VBoxNetFltInternal.h@ 37164

Last change on this file since 37164 was 36956, checked in by vboxsync, 14 years ago
Solaris/VBoxNetFltBow: cleanup, link notification support (disabled).
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 16.8 KB

Line
1	/* $Id: VBoxNetFltInternal.h 36956 2011-05-04 12:54:03Z vboxsync $ */
2	/** @file
3	* VBoxNetFlt - Network Filter Driver (Host), Internal Header.
4	*/
5
6	/*
7	* Copyright (C) 2008 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#ifndef ___VBoxNetFltInternal_h___
19	#define ___VBoxNetFltInternal_h___
20
21	#include <VBox/sup.h>
22	#include <VBox/intnet.h>
23	#include <iprt/semaphore.h>
24	#include <iprt/assert.h>
25
26
27	RT_C_DECLS_BEGIN
28
29	/** Pointer to the globals. */
30	typedef struct VBOXNETFLTGLOBALS *PVBOXNETFLTGLOBALS;
31
32
33	/**
34	* The state of a filter driver instance.
35	*
36	* The state machine differs a bit between the platforms because of
37	* the way we hook into the stack. On some hosts we can dynamically
38	* attach when required (on CreateInstance) and on others we will
39	* have to connect when the network stack is bound up. These modes
40	* are called static and dynamic config and governed at compile time
41	* by the VBOXNETFLT_STATIC_CONFIG define.
42	*
43	* See sec_netflt_msc for more details on locking and synchronization.
44	*/
45	typedef enum VBOXNETFTLINSSTATE
46	{
47	/** The usual invalid state. */
48	kVBoxNetFltInsState_Invalid = 0,
49	/** Initialization.
50	* We've reserved the interface name but need to attach to the actual
51	* network interface outside the lock to avoid deadlocks.
52	* In the dynamic case this happens during a Create(Instance) call.
53	* In the static case it happens during driver initialization. */
54	kVBoxNetFltInsState_Initializing,
55	#ifdef VBOXNETFLT_STATIC_CONFIG
56	/** Unconnected, not hooked up to a switch (static only).
57	* The filter driver instance has been instantiated and hooked up,
58	* waiting to be connected to an internal network. */
59	kVBoxNetFltInsState_Unconnected,
60	#endif
61	/** Connected to an internal network. */
62	kVBoxNetFltInsState_Connected,
63	/** Disconnecting from the internal network and possibly the host network interface.
64	* Partly for reasons of deadlock avoidance again. */
65	kVBoxNetFltInsState_Disconnecting,
66	/** The instance has been disconnected from both the host and the internal network. */
67	kVBoxNetFltInsState_Destroyed,
68
69	/** The habitual 32-bit enum hack. */
70	kVBoxNetFltInsState_32BitHack = 0x7fffffff
71	} VBOXNETFTLINSSTATE;
72
73
74	/**
75	* The per-instance data of the VBox filter driver.
76	*
77	* This is data associated with a network interface / NIC / wossname which
78	* the filter driver has been or may be attached to. When possible it is
79	* attached dynamically, but this may not be possible on all OSes so we have
80	* to be flexible about things.
81	*
82	* A network interface / NIC / wossname can only have one filter driver
83	* instance attached to it. So, attempts at connecting an internal network
84	* to an interface that's already in use (connected to another internal network)
85	* will result in a VERR_SHARING_VIOLATION.
86	*
87	* Only one internal network can connect to a filter driver instance.
88	*/
89	typedef struct VBOXNETFLTINS
90	{
91	/** Pointer to the next interface in the list. (VBOXNETFLTGLOBAL::pInstanceHead) */
92	struct VBOXNETFLTINS *pNext;
93	/** Our RJ-45 port.
94	* This is what the internal network plugs into. */
95	INTNETTRUNKIFPORT MyPort;
96	/** The RJ-45 port on the INTNET "switch".
97	* This is what we're connected to. */
98	PINTNETTRUNKSWPORT pSwitchPort;
99	/** Pointer to the globals. */
100	PVBOXNETFLTGLOBALS pGlobals;
101
102	/** The spinlock protecting the state variables and host interface handle. */
103	RTSPINLOCK hSpinlock;
104	/** The current interface state. */
105	VBOXNETFTLINSSTATE volatile enmState;
106	/** The trunk state. */
107	INTNETTRUNKIFSTATE volatile enmTrunkState;
108	bool volatile fActive;
109	/** Disconnected from the host network interface. */
110	bool volatile fDisconnectedFromHost;
111	/** Rediscovery is pending.
112	* cBusy will never reach zero during rediscovery, so which
113	* takes care of serializing rediscovery and disconnecting. */
114	bool volatile fRediscoveryPending;
115	/** Whether we should not attempt to set promiscuous mode at all. */
116	bool fDisablePromiscuous;
117	#if (ARCH_BITS == 32) && defined(__GNUC__)
118	#if 0
119	uint32_t u32Padding; /*< Alignment padding, will assert in ASMAtomicUoWriteU64 otherwise. /
120	#endif
121	#endif
122	/** The timestamp of the last rediscovery. */
123	uint64_t volatile NanoTSLastRediscovery;
124	/** Reference count. */
125	uint32_t volatile cRefs;
126	/** The busy count.
127	* This counts the number of current callers and pending packet. */
128	uint32_t volatile cBusy;
129	/** The event that is signaled when we go idle and that pfnWaitForIdle blocks on. */
130	RTSEMEVENT hEventIdle;
131
132	/** @todo move MacAddr out of this structure! */
133	union
134	{
135	#ifdef VBOXNETFLT_OS_SPECFIC
136	struct
137	{
138	# if defined(RT_OS_DARWIN)
139	/** @name Darwin instance data.
140	* @{ */
141	/** Pointer to the darwin network interface we're attached to.
142	* This is treated as highly volatile and should only be read and retained
143	* while owning hSpinlock. Releasing references to this should not be done
144	* while owning it though as we might end up destroying it in some paths. */
145	ifnet_t volatile pIfNet;
146	/** The interface filter handle.
147	* Same access rules as with pIfNet. */
148	interface_filter_t volatile pIfFilter;
149	/** Whether we've need to set promiscuous mode when the interface comes up. */
150	bool volatile fNeedSetPromiscuous;
151	/** Whether we've successfully put the interface into to promiscuous mode.
152	* This is for dealing with the ENETDOWN case. */
153	bool volatile fSetPromiscuous;
154	/** The MAC address of the interface. */
155	RTMAC MacAddr;
156	/** @} */
157	# elif defined(RT_OS_LINUX)
158	/** @name Linux instance data
159	* @{ */
160	/** Pointer to the device. */
161	struct net_device * volatile pDev;
162	/** Whether we've successfully put the interface into to promiscuous mode.
163	* This is for dealing with the ENETDOWN case. */
164	bool volatile fPromiscuousSet;
165	/** Whether device exists and physically attached. */
166	bool volatile fRegistered;
167	/** The MAC address of the interface. */
168	RTMAC MacAddr;
169	struct notifier_block Notifier;
170	struct packet_type PacketType;
171	# ifndef VBOXNETFLT_LINUX_NO_XMIT_QUEUE
172	struct sk_buff_head XmitQueue;
173	struct work_struct XmitTask;
174	# endif
175	/** @} */
176	# elif defined(RT_OS_SOLARIS)
177	/** @name Solaris instance data.
178	* @{ */
179	# ifdef VBOX_WITH_NETFLT_CROSSBOW
180	/** Whether the underlying interface is a VNIC or not. */
181	bool fIsVNIC;
182	/** Whether the underlying interface is a VNIC template or not. */
183	bool fIsVNICTemplate;
184	/** Handle to list of created VNICs. */
185	list_t hVNICs;
186	/** Instance number while creating VNICs. */
187	uint64_t uInstance;
188	/** The MAC address of the host interface. */
189	RTMAC MacAddr;
190	/** Handle of this interface (lower MAC). */
191	mac_handle_t hInterface;
192	/** Handle to link state notifier. */
193	mac_notify_handle_t hNotify;
194	# else
195	/** Pointer to the bound IPv4 stream. */
196	struct vboxnetflt_stream_t * volatile pIp4Stream;
197	/** Pointer to the bound IPv6 stream. */
198	struct vboxnetflt_stream_t * volatile pIp6Stream;
199	/** Pointer to the bound ARP stream. */
200	struct vboxnetflt_stream_t * volatile pArpStream;
201	/** Pointer to the unbound promiscuous stream. */
202	struct vboxnetflt_promisc_stream_t * volatile pPromiscStream;
203	/** Whether we are attaching to IPv6 stream dynamically now. */
204	bool volatile fAttaching;
205	/** Whether this is a VLAN interface or not. */
206	bool volatile fVLAN;
207	/** Layered device handle to the interface. */
208	ldi_handle_t hIface;
209	/** The MAC address of the interface. */
210	RTMAC MacAddr;
211	/** Mutex protection used for loopback. */
212	kmutex_t hMtx;
213	/** Mutex protection used for dynamic IPv6 attaches. */
214	RTSEMFASTMUTEX hPollMtx;
215	# endif
216	/** @} */
217	# elif defined(RT_OS_FREEBSD)
218	/** @name FreeBSD instance data.
219	* @{ */
220	/** Interface handle */
221	struct ifnet *ifp;
222	/** Netgraph node handle */
223	node_p node;
224	/** Input hook */
225	hook_p input;
226	/** Output hook */
227	hook_p output;
228	/** Original interface flags */
229	unsigned int flags;
230	/** Input queue */
231	struct ifqueue inq;
232	/** Output queue */
233	struct ifqueue outq;
234	/** Input task */
235	struct task tskin;
236	/** Output task */
237	struct task tskout;
238	/** The MAC address of the interface. */
239	RTMAC MacAddr;
240	/** @} */
241	# elif defined(RT_OS_WINDOWS)
242	/** @name Windows instance data.
243	* @{ */
244	/** Filter driver device context. */
245	VBOXNETFLTWIN WinIf;
246
247	volatile uint32_t cModeNetFltRefs;
248	volatile uint32_t cModePassThruRefs;
249	#ifndef VBOXNETFLT_NO_PACKET_QUEUE
250	/** Packet worker thread info */
251	PACKET_QUEUE_WORKER PacketQueueWorker;
252	#endif
253	/** The MAC address of the interface. Caching MAC for performance reasons. */
254	RTMAC MacAddr;
255	/** mutex used to synchronize WinIf init/deinit */
256	RTSEMMUTEX hWinIfMutex;
257	/** @} */
258	# else
259	# error "PORTME"
260	# endif
261	} s;
262	#endif
263	/** Padding. */
264	#if defined(RT_OS_WINDOWS)
265	# if defined(VBOX_NETFLT_ONDEMAND_BIND)
266	uint8_t abPadding[192];
267	# elif defined(VBOXNETADP)
268	uint8_t abPadding[256];
269	# else
270	uint8_t abPadding[1024];
271	# endif
272	#elif defined(RT_OS_LINUX)
273	uint8_t abPadding[320];
274	#elif defined(RT_OS_FREEBSD)
275	uint8_t abPadding[320];
276	#else
277	uint8_t abPadding[128];
278	#endif
279	} u;
280
281	/** The interface name. */
282	char szName[1];
283	} VBOXNETFLTINS;
284	/** Pointer to the instance data of a host network filter driver. */
285	typedef struct VBOXNETFLTINS *PVBOXNETFLTINS;
286
287	AssertCompileMemberAlignment(VBOXNETFLTINS, NanoTSLastRediscovery, 8);
288	#ifdef VBOXNETFLT_OS_SPECFIC
289	AssertCompile(RT_SIZEOFMEMB(VBOXNETFLTINS, u.s) <= RT_SIZEOFMEMB(VBOXNETFLTINS, u.abPadding));
290	#endif
291
292
293	/**
294	* The global data of the VBox filter driver.
295	*
296	* This contains the bit required for communicating with support driver, VBoxDrv
297	* (start out as SupDrv).
298	*/
299	typedef struct VBOXNETFLTGLOBALS
300	{
301	/** Mutex protecting the list of instances and state changes. */
302	RTSEMFASTMUTEX hFastMtx;
303	/** Pointer to a list of instance data. */
304	PVBOXNETFLTINS pInstanceHead;
305
306	/** The INTNET trunk network interface factory. */
307	INTNETTRUNKFACTORY TrunkFactory;
308	/** The SUPDRV component factory registration. */
309	SUPDRVFACTORY SupDrvFactory;
310	/** The number of current factory references. */
311	int32_t volatile cFactoryRefs;
312	/** Whether the IDC connection is open or not.
313	* This is only for cleaning up correctly after the separate IDC init on Windows. */
314	bool fIDCOpen;
315	/** The SUPDRV IDC handle (opaque struct). */
316	SUPDRVIDCHANDLE SupDrvIDC;
317	} VBOXNETFLTGLOBALS;
318
319
320	DECLHIDDEN(int) vboxNetFltInitGlobalsAndIdc(PVBOXNETFLTGLOBALS pGlobals);
321	DECLHIDDEN(int) vboxNetFltInitGlobals(PVBOXNETFLTGLOBALS pGlobals);
322	DECLHIDDEN(int) vboxNetFltInitIdc(PVBOXNETFLTGLOBALS pGlobals);
323	DECLHIDDEN(int) vboxNetFltTryDeleteIdcAndGlobals(PVBOXNETFLTGLOBALS pGlobals);
324	DECLHIDDEN(void) vboxNetFltDeleteGlobals(PVBOXNETFLTGLOBALS pGlobals);
325	DECLHIDDEN(int) vboxNetFltTryDeleteIdc(PVBOXNETFLTGLOBALS pGlobals);
326
327	DECLHIDDEN(bool) vboxNetFltCanUnload(PVBOXNETFLTGLOBALS pGlobals);
328	DECLHIDDEN(PVBOXNETFLTINS) vboxNetFltFindInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName);
329
330	DECLHIDDEN(void) vboxNetFltRetain(PVBOXNETFLTINS pThis, bool fBusy);
331	DECLHIDDEN(bool) vboxNetFltTryRetainBusyActive(PVBOXNETFLTINS pThis);
332	DECLHIDDEN(bool) vboxNetFltTryRetainBusyNotDisconnected(PVBOXNETFLTINS pThis);
333	DECLHIDDEN(void) vboxNetFltRelease(PVBOXNETFLTINS pThis, bool fBusy);
334
335	#ifdef VBOXNETFLT_STATIC_CONFIG
336	DECLHIDDEN(int) vboxNetFltSearchCreateInstance(PVBOXNETFLTGLOBALS pGlobals, const char pszName, PVBOXNETFLTINS ppInstance, void * pContext);
337	#endif
338
339
340
341	/** @name The OS specific interface.
342	* @{ */
343	/**
344	* Try rediscover the host interface.
345	*
346	* This is called periodically from the transmit path if we're marked as
347	* disconnected from the host. There is no chance of a race here.
348	*
349	* @returns true if the interface was successfully rediscovered and reattach,
350	* otherwise false.
351	* @param pThis The new instance.
352	*/
353	DECLHIDDEN(bool) vboxNetFltOsMaybeRediscovered(PVBOXNETFLTINS pThis);
354
355	/**
356	* Transmits a frame.
357	*
358	* @return IPRT status code.
359	* @param pThis The new instance.
360	* @param pvIfData Pointer to the host-private interface data.
361	* @param pSG The (scatter/)gather list.
362	* @param fDst The destination mask. At least one bit will be set.
363	*
364	* @remarks Owns the out-bound trunk port semaphore.
365	*/
366	DECLHIDDEN(int) vboxNetFltPortOsXmit(PVBOXNETFLTINS pThis, void *pvIfData, PINTNETSG pSG, uint32_t fDst);
367
368	/**
369	* This is called when activating or suspending the instance.
370	*
371	* Use this method to enable and disable promiscuous mode on
372	* the interface to prevent unnecessary interrupt load.
373	*
374	* It is only called when the state changes.
375	*
376	* @param pThis The instance.
377	*
378	* @remarks Owns the lock for the out-bound trunk port.
379	*/
380	DECLHIDDEN(void) vboxNetFltPortOsSetActive(PVBOXNETFLTINS pThis, bool fActive);
381
382	/**
383	* This is called when a network interface has obtained a new MAC address.
384	*
385	* @param pThis The instance.
386	* @param pvIfData Pointer to the private interface data.
387	* @param pMac Pointer to the new MAC address.
388	*/
389	DECLHIDDEN(void) vboxNetFltPortOsNotifyMacAddress(PVBOXNETFLTINS pThis, void *pvIfData, PCRTMAC pMac);
390
391	/**
392	* This is called when an interface is connected to the network.
393	*
394	* @return IPRT status code.
395	* @param pThis The instance.
396	* @param pvIf Pointer to the interface.
397	* @param ppvIfData Where to store the private interface data.
398	*/
399	DECLHIDDEN(int) vboxNetFltPortOsConnectInterface(PVBOXNETFLTINS pThis, void pvIf, void *ppvIfData);
400
401	/**
402	* This is called when a VM host disconnects from the network.
403	*
404	* @param pThis The instance.
405	* @param pvIfData Pointer to the private interface data.
406	*/
407	DECLHIDDEN(int) vboxNetFltPortOsDisconnectInterface(PVBOXNETFLTINS pThis, void *pvIfData);
408
409	/**
410	* This is called to when disconnecting from a network.
411	*
412	* @return IPRT status code.
413	* @param pThis The new instance.
414	*
415	* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
416	*/
417	DECLHIDDEN(int) vboxNetFltOsDisconnectIt(PVBOXNETFLTINS pThis);
418
419	/**
420	* This is called to when connecting to a network.
421	*
422	* @return IPRT status code.
423	* @param pThis The new instance.
424	*
425	* @remarks Owns the semaphores for the global list, the network lock and the out-bound trunk port.
426	*/
427	DECLHIDDEN(int) vboxNetFltOsConnectIt(PVBOXNETFLTINS pThis);
428
429	/**
430	* Counter part to vboxNetFltOsInitInstance().
431	*
432	* @return IPRT status code.
433	* @param pThis The new instance.
434	*
435	* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
436	*/
437	DECLHIDDEN(void) vboxNetFltOsDeleteInstance(PVBOXNETFLTINS pThis);
438
439	/**
440	* This is called to attach to the actual host interface
441	* after linking the instance into the list.
442	*
443	* The MAC address as well promiscuousness and GSO capabilities should be
444	* reported by this function.
445	*
446	* @return IPRT status code.
447	* @param pThis The new instance.
448	* @param pvContext The user supplied context in the static config only.
449	* NULL in the dynamic config.
450	*
451	* @remarks Owns no locks.
452	*/
453	DECLHIDDEN(int) vboxNetFltOsInitInstance(PVBOXNETFLTINS pThis, void *pvContext);
454
455	/**
456	* This is called to perform structure initializations.
457	*
458	* @return IPRT status code.
459	* @param pThis The new instance.
460	*
461	* @remarks Owns no locks.
462	*/
463	DECLHIDDEN(int) vboxNetFltOsPreInitInstance(PVBOXNETFLTINS pThis);
464	/** @} */
465
466
467	RT_C_DECLS_END
468
469	#endif
470

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h@ 37164

Download in other formats: