VBoxNetFltInternal.h@ 24358

Last change on this file since 24358 was 24123, checked in by vboxsync, 15 years ago
VBoxNetFlt/FreeBSD: Fix locking problems. Contributed by Fredrik Lindberg
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 16.1 KB

Line
1	/* $Id: VBoxNetFltInternal.h 24123 2009-10-28 02:46:59Z vboxsync $ */
2	/** @file
3	* VBoxNetFlt - Network Filter Driver (Host), Internal Header.
4	*/
5
6	/*
7	* Copyright (C) 2008 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22	#ifndef ___VBoxNetFltInternal_h___
23	#define ___VBoxNetFltInternal_h___
24
25	#include <VBox/sup.h>
26	#include <VBox/intnet.h>
27	#include <iprt/semaphore.h>
28	#include <iprt/assert.h>
29
30
31	RT_C_DECLS_BEGIN
32
33	/** Pointer to the globals. */
34	typedef struct VBOXNETFLTGLOBALS *PVBOXNETFLTGLOBALS;
35
36
37	/**
38	* The state of a filter driver instance.
39	*
40	* The state machine differs a bit between the platforms because of
41	* the way we hook into the stack. On some hosts we can dynamically
42	* attach when required (on CreateInstance) and on others we will
43	* have to connect when the network stack is bound up. These modes
44	* are called static and dynamic config and governed at compile time
45	* by the VBOXNETFLT_STATIC_CONFIG define.
46	*
47	* See sec_netflt_msc for more details on locking and synchronization.
48	*/
49	typedef enum VBOXNETFTLINSSTATE
50	{
51	/** The usual invalid state. */
52	kVBoxNetFltInsState_Invalid = 0,
53	/** Initialization.
54	* We've reserved the interface name but need to attach to the actual
55	* network interface outside the lock to avoid deadlocks.
56	* In the dynamic case this happens during a Create(Instance) call.
57	* In the static case it happens during driver initialization. */
58	kVBoxNetFltInsState_Initializing,
59	#ifdef VBOXNETFLT_STATIC_CONFIG
60	/** Unconnected, not hooked up to a switch (static only).
61	* The filter driver instance has been instantiated and hooked up,
62	* waiting to be connected to an internal network. */
63	kVBoxNetFltInsState_Unconnected,
64	#endif
65	/** Connected to an internal network. */
66	kVBoxNetFltInsState_Connected,
67	/** Disconnecting from the internal network and possibly the host network interface.
68	* Partly for reasons of deadlock avoidance again. */
69	kVBoxNetFltInsState_Disconnecting,
70	/** The instance has been disconnected from both the host and the internal network. */
71	kVBoxNetFltInsState_Destroyed,
72
73	/** The habitual 32-bit enum hack. */
74	kVBoxNetFltInsState_32BitHack = 0x7fffffff
75	} VBOXNETFTLINSSTATE;
76
77
78	/**
79	* The per-instance data of the VBox filter driver.
80	*
81	* This is data associated with a network interface / NIC / wossname which
82	* the filter driver has been or may be attached to. When possible it is
83	* attached dynamically, but this may not be possible on all OSes so we have
84	* to be flexible about things.
85	*
86	* A network interface / NIC / wossname can only have one filter driver
87	* instance attached to it. So, attempts at connecting an internal network
88	* to an interface that's already in use (connected to another internal network)
89	* will result in a VERR_SHARING_VIOLATION.
90	*
91	* Only one internal network can connect to a filter driver instance.
92	*/
93	typedef struct VBOXNETFLTINS
94	{
95	/** Pointer to the next interface in the list. (VBOXNETFLTGLOBAL::pInstanceHead) */
96	struct VBOXNETFLTINS *pNext;
97	/** Our RJ-45 port.
98	* This is what the internal network plugs into. */
99	INTNETTRUNKIFPORT MyPort;
100	/** The RJ-45 port on the INTNET "switch".
101	* This is what we're connected to. */
102	PINTNETTRUNKSWPORT pSwitchPort;
103	/** Pointer to the globals. */
104	PVBOXNETFLTGLOBALS pGlobals;
105
106	/** The spinlock protecting the state variables and host interface handle. */
107	RTSPINLOCK hSpinlock;
108	/** The current interface state. */
109	VBOXNETFTLINSSTATE volatile enmState;
110	/** Active / Suspended indicator. */
111	bool volatile fActive;
112	/** Disconnected from the host network interface. */
113	bool volatile fDisconnectedFromHost;
114	/** Rediscovery is pending.
115	* cBusy will never reach zero during rediscovery, so which
116	* takes care of serializing rediscovery and disconnecting. */
117	bool volatile fRediscoveryPending;
118	/** Whether we should not attempt to set promiscuous mode at all. */
119	bool fDisablePromiscuous;
120	#if (ARCH_BITS == 32) && defined(__GNUC__)
121	uint32_t u32Padding; /*< Alignment padding, will assert in ASMAtomicUoWriteU64 otherwise. /
122	#endif
123	/** The timestamp of the last rediscovery. */
124	uint64_t volatile NanoTSLastRediscovery;
125	/** Reference count. */
126	uint32_t volatile cRefs;
127	/** The busy count.
128	* This counts the number of current callers and pending packet. */
129	uint32_t volatile cBusy;
130	/** The event that is signaled when we go idle and that pfnWaitForIdle blocks on. */
131	RTSEMEVENT hEventIdle;
132
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 Mac;
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 Mac;
169	struct notifier_block Notifier;
170	struct packet_type PacketType;
171	struct sk_buff_head XmitQueue;
172	struct work_struct XmitTask;
173	/** @} */
174	# elif defined(RT_OS_SOLARIS)
175	/** @name Solaris instance data.
176	* @{ */
177	/** Pointer to the bound IPv4 stream. */
178	void volatile *pvIp4Stream;
179	/** Pointer to the bound IPv6 stream. */
180	void volatile *pvIp6Stream;
181	/** Pointer to the bound ARP stream. */
182	void volatile *pvArpStream;
183	/** Pointer to the unbound promiscuous stream. */
184	void volatile *pvPromiscStream;
185	/** Whether we are attaching to IPv6 stream dynamically now. */
186	bool volatile fAttaching;
187	/** Layered device handle to the interface. */
188	ldi_handle_t hIface;
189	/** The MAC address of the interface. */
190	RTMAC Mac;
191	/** Mutex protection used for loopback. */
192	RTSEMFASTMUTEX hFastMtx;
193	/** Mutex protection used for dynamic IPv6 attaches. */
194	RTSEMFASTMUTEX hPollMtx;
195	/** @} */
196	# elif defined(RT_OS_FREEBSD)
197	/** @name FreeBSD instance data.
198	* @{ */
199	/** Interface handle */
200	struct ifnet *ifp;
201	/** Netgraph node handle */
202	node_p node;
203	/** Input hook */
204	hook_p input;
205	/** Output hook */
206	hook_p output;
207	/** Original interface flags */
208	unsigned int flags;
209	/** Input queue */
210	struct ifqueue inq;
211	/** Output queue */
212	struct ifqueue outq;
213	/** Input task */
214	struct task tskin;
215	/** Output task */
216	struct task tskout;
217	/** The MAC address of the interface. */
218	RTMAC Mac;
219	/** @} */
220	# elif defined(RT_OS_WINDOWS)
221	/** @name Windows instance data.
222	* @{ */
223	/** Filter driver device context. */
224	ADAPT IfAdaptor;
225
226	volatile uint32_t cModeNetFltRefs;
227	volatile uint32_t cModePassThruRefs;
228
229	/** Packet worker thread info */
230	PACKET_QUEUE_WORKER PacketQueueWorker;
231	/** The MAC address of the interface. Caching MAC for performance reasons. */
232	RTMAC Mac;
233	/** mutex used to synchronize ADAPT init/deinit */
234	RTSEMMUTEX hAdaptMutex;
235	/** @} */
236	# else
237	# error "PORTME"
238	# endif
239	} s;
240	#endif
241	/** Padding. */
242	#if defined(RT_OS_WINDOWS)
243	# if defined(VBOX_NETFLT_ONDEMAND_BIND)
244	uint8_t abPadding[192];
245	# elif defined(VBOXNETADP)
246	uint8_t abPadding[256];
247	# else
248	uint8_t abPadding[1024];
249	# endif
250	#elif defined(RT_OS_LINUX)
251	uint8_t abPadding[320];
252	#elif defined(RT_OS_FREEBSD)
253	uint8_t abPadding[320];
254	#else
255	uint8_t abPadding[128];
256	#endif
257	} u;
258
259	/** The interface name. */
260	char szName[1];
261	} VBOXNETFLTINS;
262	/** Pointer to the instance data of a host network filter driver. */
263	typedef struct VBOXNETFLTINS *PVBOXNETFLTINS;
264
265	AssertCompileMemberAlignment(VBOXNETFLTINS, NanoTSLastRediscovery, 8);
266	#ifdef VBOXNETFLT_OS_SPECFIC
267	AssertCompile(RT_SIZEOFMEMB(VBOXNETFLTINS, u.s) <= RT_SIZEOFMEMB(VBOXNETFLTINS, u.abPadding));
268	#endif
269
270
271	/**
272	* The global data of the VBox filter driver.
273	*
274	* This contains the bit required for communicating with support driver, VBoxDrv
275	* (start out as SupDrv).
276	*/
277	typedef struct VBOXNETFLTGLOBALS
278	{
279	/** Mutex protecting the list of instances and state changes. */
280	RTSEMFASTMUTEX hFastMtx;
281	/** Pointer to a list of instance data. */
282	PVBOXNETFLTINS pInstanceHead;
283
284	/** The INTNET trunk network interface factory. */
285	INTNETTRUNKFACTORY TrunkFactory;
286	/** The SUPDRV component factory registration. */
287	SUPDRVFACTORY SupDrvFactory;
288	/** The number of current factory references. */
289	int32_t volatile cFactoryRefs;
290	/** Whether the IDC connection is open or not.
291	* This is only for cleaning up correctly after the separate IDC init on Windows. */
292	bool fIDCOpen;
293	/** The SUPDRV IDC handle (opaque struct). */
294	SUPDRVIDCHANDLE SupDrvIDC;
295	} VBOXNETFLTGLOBALS;
296
297
298	DECLHIDDEN(int) vboxNetFltInitGlobalsAndIdc(PVBOXNETFLTGLOBALS pGlobals);
299	DECLHIDDEN(int) vboxNetFltInitGlobals(PVBOXNETFLTGLOBALS pGlobals);
300	DECLHIDDEN(int) vboxNetFltInitIdc(PVBOXNETFLTGLOBALS pGlobals);
301	DECLHIDDEN(int) vboxNetFltTryDeleteIdcAndGlobals(PVBOXNETFLTGLOBALS pGlobals);
302	DECLHIDDEN(void) vboxNetFltDeleteGlobals(PVBOXNETFLTGLOBALS pGlobals);
303	DECLHIDDEN(int) vboxNetFltTryDeleteIdc(PVBOXNETFLTGLOBALS pGlobals);
304
305	DECLHIDDEN(bool) vboxNetFltCanUnload(PVBOXNETFLTGLOBALS pGlobals);
306	DECLHIDDEN(PVBOXNETFLTINS) vboxNetFltFindInstance(PVBOXNETFLTGLOBALS pGlobals, const char *pszName);
307
308	DECLHIDDEN(void) vboxNetFltRetain(PVBOXNETFLTINS pThis, bool fBusy);
309	DECLHIDDEN(void) vboxNetFltRelease(PVBOXNETFLTINS pThis, bool fBusy);
310
311	#ifdef VBOXNETFLT_STATIC_CONFIG
312	DECLHIDDEN(int) vboxNetFltSearchCreateInstance(PVBOXNETFLTGLOBALS pGlobals, const char pszName, PVBOXNETFLTINS ppInstance, void * pContext);
313	#endif
314
315
316
317	/** @name The OS specific interface.
318	* @{ */
319	/**
320	* Try rediscover the host interface.
321	*
322	* This is called periodically from the transmit path if we're marked as
323	* disconnected from the host. There is no chance of a race here.
324	*
325	* @returns true if the interface was successfully rediscovered and reattach,
326	* otherwise false.
327	* @param pThis The new instance.
328	*/
329	DECLHIDDEN(bool) vboxNetFltOsMaybeRediscovered(PVBOXNETFLTINS pThis);
330
331	/**
332	* Transmits a frame.
333	*
334	* @return IPRT status code.
335	* @param pThis The new instance.
336	* @param pSG The (scatter/)gather list.
337	* @param fDst The destination mask. At least one bit will be set.
338	*
339	* @remarks Owns the out-bound trunk port semaphore.
340	*/
341	DECLHIDDEN(int) vboxNetFltPortOsXmit(PVBOXNETFLTINS pThis, PINTNETSG pSG, uint32_t fDst);
342
343	/**
344	* Checks if the interface is in promiscuous mode from the host perspective.
345	*
346	* If it is, then the internal networking switch will send frames
347	* heading for the wire to the host as well.
348	*
349	* @see INTNETTRUNKIFPORT::pfnIsPromiscuous for more details.
350	*
351	* @returns true / false accordingly.
352	* @param pThis The instance.
353	*
354	* @remarks Owns the network lock and the out-bound trunk port semaphores.
355	*/
356	DECLHIDDEN(bool) vboxNetFltPortOsIsPromiscuous(PVBOXNETFLTINS pThis);
357
358	/**
359	* Get the MAC address of the interface we're attached to.
360	*
361	* Used by the internal networking switch for implementing the
362	* shared-MAC-on-the-wire mode.
363	*
364	* @param pThis The instance.
365	* @param pMac Where to store the MAC address.
366	* If you don't know, set all the bits except the first (the multicast one).
367	*
368	* @remarks Owns the network lock and the out-bound trunk port semaphores.
369	*/
370	DECLHIDDEN(void) vboxNetFltPortOsGetMacAddress(PVBOXNETFLTINS pThis, PRTMAC pMac);
371
372	/**
373	* Checks if the specified MAC address is for any of the host interfaces.
374	*
375	* Used by the internal networking switch to decide the destination(s)
376	* of a frame.
377	*
378	* @returns true / false accordingly.
379	* @param pThis The instance.
380	* @param pMac The MAC address.
381	*
382	* @remarks Owns the network lock and the out-bound trunk port semaphores.
383	*/
384	DECLHIDDEN(bool) vboxNetFltPortOsIsHostMac(PVBOXNETFLTINS pThis, PCRTMAC pMac);
385
386	/**
387	* This is called when activating or suspending the instance.
388	*
389	* Use this method to enable and disable promiscuous mode on
390	* the interface to prevent unnecessary interrupt load.
391	*
392	* It is only called when the state changes.
393	*
394	* @param pThis The instance.
395	*
396	* @remarks Owns the lock for the out-bound trunk port.
397	*/
398	DECLHIDDEN(void) vboxNetFltPortOsSetActive(PVBOXNETFLTINS pThis, bool fActive);
399
400	/**
401	* This is called to when disconnecting from a network.
402	*
403	* @return IPRT status code.
404	* @param pThis The new instance.
405	*
406	* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
407	*/
408	DECLHIDDEN(int) vboxNetFltOsDisconnectIt(PVBOXNETFLTINS pThis);
409
410	/**
411	* This is called to when connecting to a network.
412	*
413	* @return IPRT status code.
414	* @param pThis The new instance.
415	*
416	* @remarks Owns the semaphores for the global list, the network lock and the out-bound trunk port.
417	*/
418	DECLHIDDEN(int) vboxNetFltOsConnectIt(PVBOXNETFLTINS pThis);
419
420	/**
421	* Counter part to vboxNetFltOsInitInstance().
422	*
423	* @return IPRT status code.
424	* @param pThis The new instance.
425	*
426	* @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
427	*/
428	DECLHIDDEN(void) vboxNetFltOsDeleteInstance(PVBOXNETFLTINS pThis);
429
430	/**
431	* This is called to attach to the actual host interface
432	* after linking the instance into the list.
433	*
434	* @return IPRT status code.
435	* @param pThis The new instance.
436	* @param pvContext The user supplied context in the static config only.
437	* NULL in the dynamic config.
438	*
439	* @remarks Owns no locks.
440	*/
441	DECLHIDDEN(int) vboxNetFltOsInitInstance(PVBOXNETFLTINS pThis, void *pvContext);
442
443	/**
444	* This is called to perform structure initializations.
445	*
446	* @return IPRT status code.
447	* @param pThis The new instance.
448	*
449	* @remarks Owns no locks.
450	*/
451	DECLHIDDEN(int) vboxNetFltOsPreInitInstance(PVBOXNETFLTINS pThis);
452	/** @} */
453
454
455	RT_C_DECLS_END
456
457	#endif
458

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

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

Download in other formats: