VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/VBoxNetAdp/VBoxNetAdpInternal.h@ 20366

Last change on this file since 20366 was 20366, checked in by vboxsync, 15 years ago

HostDrivers: BEGIN_DECLS -> RT_BEGIN_DECLS; END_DECLS -> RT_END_DECLS.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.6 KB
Line 
1/* $Id: VBoxNetAdpInternal.h 20366 2009-06-08 00:21:10Z vboxsync $ */
2/** @file
3 * VBoxNetAdp - 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 ___VBoxNetAdpInternal_h___
23#define ___VBoxNetAdpInternal_h___
24
25#include <VBox/sup.h>
26#include <VBox/intnet.h>
27#include <iprt/semaphore.h>
28#include <iprt/assert.h>
29
30
31RT_BEGIN_DECLS
32
33/** Pointer to the globals. */
34typedef struct VBOXNETADPGLOBALS *PVBOXNETADPGLOBALS;
35
36#define VBOXNETADP_MAX_INSTANCES 8
37#define VBOXNETADP_NAME "vboxnet"
38#define VBOXNETADP_MAX_NAME_LEN 32
39#define VBOXNETADP_MTU 1500
40#if defined(RT_OS_DARWIN)
41# define VBOXNETADP_MAX_FAMILIES 4
42# define VBOXNETADP_DETACH_TIMEOUT 500
43#endif
44
45#define VBOXNETADP_CTL_DEV_NAME "vboxnetctl"
46#define VBOXNETADP_CTL_ADD _IOR('v', 1, VBOXNETADPREQ)
47#define VBOXNETADP_CTL_REMOVE _IOW('v', 2, VBOXNETADPREQ)
48
49typedef struct VBoxNetAdpReq
50{
51 char szName[VBOXNETADP_MAX_NAME_LEN];
52} VBOXNETADPREQ;
53typedef VBOXNETADPREQ *PVBOXNETADPREQ;
54
55/**
56 * Void entries mark vacant slots in adapter array. Valid entries are busy slots.
57 * As soon as slot is being modified its state changes to transitional.
58 * An entry in transitional state must only be accessed by the thread that
59 * put it to this state.
60 */
61/**
62 * To avoid races on adapter fields we stick to the following rules:
63 * - rewrite: Int net port calls are serialized
64 * - No modifications are allowed on busy adapters (deactivate first)
65 * Refuse to destroy adapter until it gets to available state
66 * - No transfers (thus getting busy) on inactive adapters
67 * - Init sequence: void->available->connected->active
68 1) Create
69 2) Connect
70 3) Activate
71 * - Destruction sequence: active->connected->available->void
72 1) Deactivate
73 2) Disconnect
74 3) Destroy
75*/
76
77enum VBoxNetAdpState
78{
79 kVBoxNetAdpState_Invalid,
80 kVBoxNetAdpState_Transitional,
81#ifdef VBOXANETADP_DO_NOT_USE_NETFLT
82 kVBoxNetAdpState_Available,
83 kVBoxNetAdpState_Connected,
84#endif /* VBOXANETADP_DO_NOT_USE_NETFLT */
85 kVBoxNetAdpState_Active,
86 kVBoxNetAdpState_U32Hack = 0xFFFFFFFF
87};
88typedef enum VBoxNetAdpState VBOXNETADPSTATE;
89
90struct VBoxNetAdapter
91{
92#ifdef VBOXANETADP_DO_NOT_USE_NETFLT
93 /** The spinlock protecting the state variables and host interface handle. */
94 RTSPINLOCK hSpinlock;
95
96 /* --- Protected with spinlock. --- */
97
98#endif /* !VBOXANETADP_DO_NOT_USE_NETFLT */
99 /** Denotes availability of this slot in adapter array. */
100 VBOXNETADPSTATE enmState;
101#ifdef VBOXANETADP_DO_NOT_USE_NETFLT
102
103 /* --- Unprotected. Atomic access. --- */
104
105 /** Reference count. */
106 uint32_t volatile cRefs;
107 /** The busy count.
108 * This counts the number of current callers and pending packet. */
109 uint32_t volatile cBusy;
110
111 /* --- Unprotected. Do not modify when cBusy > 0. --- */
112
113 /** Our RJ-45 port.
114 * This is what the internal network plugs into. */
115 INTNETTRUNKIFPORT MyPort;
116 /** The RJ-45 port on the INTNET "switch".
117 * This is what we're connected to. */
118 PINTNETTRUNKSWPORT pSwitchPort;
119 /** Pointer to the globals. */
120 PVBOXNETADPGLOBALS pGlobals;
121 /** The event that is signaled when we go idle and that pfnWaitForIdle blocks on. */
122 RTSEMEVENT hEventIdle;
123#endif /* !VBOXANETADP_DO_NOT_USE_NETFLT */
124 /** Corresponds to the digit at the end of device name. */
125 uint32_t uUnit;
126
127 union
128 {
129#ifdef VBOXNETADP_OS_SPECFIC
130 struct
131 {
132# if defined(RT_OS_DARWIN)
133 /** @name Darwin instance data.
134 * @{ */
135 /** Event to signal detachment of interface. */
136 RTSEMEVENT hEvtDetached;
137 /** Pointer to Darwin interface structure. */
138 ifnet_t pIface;
139 /** MAC address. */
140 RTMAC Mac;
141 /** Protocol families attached to this adapter. */
142 protocol_family_t aAttachedFamilies[VBOXNETADP_MAX_FAMILIES];
143 /** @} */
144# elif defined(RT_OS_LINUX)
145 /** @name Darwin instance data.
146 * @{ */
147 /** Pointer to Linux network device structure. */
148 struct net_device *pNetDev;
149 /** @} */
150# else
151# error PORTME
152# endif
153 } s;
154#endif
155 /** Padding. */
156#if defined(RT_OS_WINDOWS)
157# if defined(VBOX_NETFLT_ONDEMAND_BIND)
158 uint8_t abPadding[192];
159# else
160 uint8_t abPadding[1024];
161# endif
162#elif defined(RT_OS_LINUX)
163 uint8_t abPadding[64];
164#else
165 uint8_t abPadding[64];
166#endif
167 } u;
168 /** The interface name. */
169 char szName[VBOXNETADP_MAX_NAME_LEN];
170};
171typedef struct VBoxNetAdapter VBOXNETADP;
172typedef VBOXNETADP *PVBOXNETADP;
173
174DECLHIDDEN(int) vboxNetAdpInit(void);
175DECLHIDDEN(void) vboxNetAdpShutdown(void);
176DECLHIDDEN(int) vboxNetAdpCreate (PVBOXNETADP *ppNew);
177DECLHIDDEN(int) vboxNetAdpDestroy(PVBOXNETADP pThis);
178DECLHIDDEN(PVBOXNETADP) vboxNetAdpFindByName(const char *pszName);
179
180#ifdef VBOXANETADP_DO_NOT_USE_NETFLT
181/**
182 * The global data of the VBox filter driver.
183 *
184 * This contains the bit required for communicating with support driver, VBoxDrv
185 * (start out as SupDrv).
186 */
187typedef struct VBOXNETADPGLOBALS
188{
189 /** Mutex protecting the list of instances and state changes. */
190 RTSEMFASTMUTEX hFastMtx;
191 /** Array of adapter instances. */
192 VBOXNETADP aAdapters[VBOXNETADP_MAX_INSTANCES];
193
194 /** The INTNET trunk network interface factory. */
195 INTNETTRUNKFACTORY TrunkFactory;
196 /** The SUPDRV component factory registration. */
197 SUPDRVFACTORY SupDrvFactory;
198 /** The number of current factory references. */
199 int32_t volatile cFactoryRefs;
200 /** The SUPDRV IDC handle (opaque struct). */
201 SUPDRVIDCHANDLE SupDrvIDC;
202} VBOXNETADPGLOBALS;
203
204
205DECLHIDDEN(void) vboxNetAdpComposeMACAddress(PVBOXNETADP pThis, PRTMAC pMac);
206DECLHIDDEN(void) vboxNetAdpReceive(PVBOXNETADP pThis, PINTNETSG pSG);
207DECLHIDDEN(bool) vboxNetAdpPrepareToReceive(PVBOXNETADP pThis);
208DECLHIDDEN(void) vboxNetAdpCancelReceive(PVBOXNETADP pThis);
209
210DECLHIDDEN(int) vboxNetAdpInitGlobals(PVBOXNETADPGLOBALS pGlobals);
211DECLHIDDEN(int) vboxNetAdpTryDeleteGlobals(PVBOXNETADPGLOBALS pGlobals);
212DECLHIDDEN(bool) vboxNetAdpCanUnload(PVBOXNETADPGLOBALS pGlobals);
213
214DECLHIDDEN(void) vboxNetAdpRetain(PVBOXNETADP pThis);
215DECLHIDDEN(void) vboxNetAdpRelease(PVBOXNETADP pThis);
216DECLHIDDEN(void) vboxNetAdpBusy(PVBOXNETADP pThis);
217DECLHIDDEN(void) vboxNetAdpIdle(PVBOXNETADP pThis);
218
219DECLHIDDEN(int) vboxNetAdpInitGlobalsBase(PVBOXNETADPGLOBALS pGlobals);
220DECLHIDDEN(int) vboxNetAdpInitIdc(PVBOXNETADPGLOBALS pGlobals);
221DECLHIDDEN(void) vboxNetAdpDeleteGlobalsBase(PVBOXNETADPGLOBALS pGlobals);
222DECLHIDDEN(int) vboxNetAdpTryDeleteIdc(PVBOXNETADPGLOBALS pGlobals);
223
224
225
226/** @name The OS specific interface.
227 * @{ */
228/**
229 * Transmits a frame.
230 *
231 * @return IPRT status code.
232 * @param pThis The new instance.
233 * @param pSG The (scatter/)gather list.
234 * @param fDst The destination mask. At least one bit will be set.
235 *
236 * @remarks Owns the out-bound trunk port semaphore.
237 */
238DECLHIDDEN(int) vboxNetAdpPortOsXmit(PVBOXNETADP pThis, PINTNETSG pSG, uint32_t fDst);
239
240/**
241 * Checks if the interface is in promiscuous mode from the host perspective.
242 *
243 * If it is, then the internal networking switch will send frames
244 * heading for the wire to the host as well.
245 *
246 * @see INTNETTRUNKIFPORT::pfnIsPromiscuous for more details.
247 *
248 * @returns true / false accordingly.
249 * @param pThis The instance.
250 *
251 * @remarks Owns the network lock and the out-bound trunk port semaphores.
252 */
253DECLHIDDEN(bool) vboxNetAdpPortOsIsPromiscuous(PVBOXNETADP pThis);
254
255/**
256 * Get the MAC address of the interface we're attached to.
257 *
258 * Used by the internal networking switch for implementing the
259 * shared-MAC-on-the-wire mode.
260 *
261 * @param pThis The instance.
262 * @param pMac Where to store the MAC address.
263 * If you don't know, set all the bits except the first (the multicast one).
264 *
265 * @remarks Owns the network lock and the out-bound trunk port semaphores.
266 */
267DECLHIDDEN(void) vboxNetAdpPortOsGetMacAddress(PVBOXNETADP pThis, PRTMAC pMac);
268
269/**
270 * Checks if the specified MAC address is for any of the host interfaces.
271 *
272 * Used by the internal networking switch to decide the destination(s)
273 * of a frame.
274 *
275 * @returns true / false accordingly.
276 * @param pThis The instance.
277 * @param pMac The MAC address.
278 *
279 * @remarks Owns the network lock and the out-bound trunk port semaphores.
280 */
281DECLHIDDEN(bool) vboxNetAdpPortOsIsHostMac(PVBOXNETADP pThis, PCRTMAC pMac);
282
283/**
284 * This is called to when disconnecting from a network.
285 *
286 * @return IPRT status code.
287 * @param pThis The new instance.
288 *
289 * @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
290 */
291DECLHIDDEN(int) vboxNetAdpOsDisconnectIt(PVBOXNETADP pThis);
292
293/**
294 * This is called to when connecting to a network.
295 *
296 * @return IPRT status code.
297 * @param pThis The new instance.
298 *
299 * @remarks Owns the semaphores for the global list, the network lock and the out-bound trunk port.
300 */
301DECLHIDDEN(int) vboxNetAdpOsConnectIt(PVBOXNETADP pThis);
302
303/** @} */
304#endif /* !VBOXANETADP_DO_NOT_USE_NETFLT */
305
306/**
307 * This is called to perform OS-specific structure initializations.
308 *
309 * @return IPRT status code.
310 * @param pThis The new instance.
311 *
312 * @remarks Owns no locks.
313 */
314DECLHIDDEN(int) vboxNetAdpOsInit(PVBOXNETADP pThis);
315
316/**
317 * Counter part to vboxNetAdpOsCreate().
318 *
319 * @return IPRT status code.
320 * @param pThis The new instance.
321 *
322 * @remarks May own the semaphores for the global list, the network lock and the out-bound trunk port.
323 */
324DECLHIDDEN(void) vboxNetAdpOsDestroy(PVBOXNETADP pThis);
325
326/**
327 * This is called to attach to the actual host interface
328 * after linking the instance into the list.
329 *
330 * @return IPRT status code.
331 * @param pThis The new instance.
332 * @param pMac The MAC address to use for this instance.
333 *
334 * @remarks Owns no locks.
335 */
336DECLHIDDEN(int) vboxNetAdpOsCreate(PVBOXNETADP pThis, PCRTMAC pMac);
337
338
339
340RT_END_DECLS
341
342#endif
343
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette