intnet.h@ 27840

Last change on this file since 27840 was 27840, checked in by vboxsync, 15 years ago
DrvIntNet,++: Implemented the missing buffer methods, added padding frame.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 39.2 KB

Line
1	/** @file
2	* INTNET - Internal Networking. (DEV,++)
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*
25	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___VBox_intnet_h
31	#define ___VBox_intnet_h
32
33	#include <VBox/types.h>
34	#include <VBox/stam.h>
35	#include <VBox/sup.h>
36	#include <iprt/assert.h>
37	#include <iprt/asm.h>
38
39	RT_C_DECLS_BEGIN
40
41
42	/** Pointer to an internal network ring-0 instance. */
43	typedef struct INTNET *PINTNET;
44
45	/**
46	* Generic two-sided ring buffer.
47	*
48	* The deal is that there is exactly one writer and one reader.
49	* When offRead equals offWrite the buffer is empty. In the other
50	* extreme the writer will not use the last free byte in the buffer.
51	*/
52	typedef struct INTNETRINGBUF
53	{
54	/** The offset from this structure to the start of the buffer. */
55	uint32_t offStart;
56	/** The offset from this structure to the end of the buffer. (exclusive). */
57	uint32_t offEnd;
58	/** The current read offset. */
59	uint32_t volatile offReadX;
60	/** Alignment. */
61	uint32_t u32Align0;
62
63	/** The committed write offset. */
64	uint32_t volatile offWriteCom;
65	/** Writer internal current write offset.
66	* This is ahead of offWriteCom when buffer space is handed to a third party for
67	* data gathering. offWriteCom will be assigned this value by the writer then
68	* the frame is ready. */
69	uint32_t volatile offWriteInt;
70	/** The number of bytes written (not counting overflows). */
71	STAMCOUNTER cbStatWritten;
72	/** The number of frames written (not counting overflows). */
73	STAMCOUNTER cStatFrames;
74	/** The number of overflows. */
75	STAMCOUNTER cOverflows;
76	} INTNETRINGBUF;
77	AssertCompileSize(INTNETRINGBUF, 48);
78	/** Pointer to a ring buffer. */
79	typedef INTNETRINGBUF *PINTNETRINGBUF;
80
81	/** The alignment of a ring buffer. */
82	#define INTNETRINGBUF_ALIGNMENT sizeof(INTNETHDR)
83
84	/**
85	* Asserts the sanity of the specified INTNETRINGBUF structure.
86	*/
87	#define INTNETRINGBUF_ASSERT_SANITY(pRingBuf) \
88	do \
89	{ \
90	AssertPtr(pRingBuf); \
91	{ \
92	uint32_t const offWriteCom = (pRingBuf)->offWriteCom; \
93	uint32_t const offRead = (pRingBuf)->offReadX; \
94	uint32_t const offWriteInt = (pRingBuf)->offWriteInt; \
95	\
96	AssertMsg(offWriteCom == RT_ALIGN_32(offWriteCom, INTNETHDR_ALIGNMENT), ("%#x\n", offWriteCom)); \
97	AssertMsg(offWriteCom >= (pRingBuf)->offStart, ("%#x %#x\n", offWriteCom, (pRingBuf)->offStart)); \
98	AssertMsg(offWriteCom < (pRingBuf)->offEnd, ("%#x %#x\n", offWriteCom, (pRingBuf)->offEnd)); \
99	\
100	AssertMsg(offRead == RT_ALIGN_32(offRead, INTNETHDR_ALIGNMENT), ("%#x\n", offRead)); \
101	AssertMsg(offRead >= (pRingBuf)->offStart, ("%#x %#x\n", offRead, (pRingBuf)->offStart)); \
102	AssertMsg(offRead < (pRingBuf)->offEnd, ("%#x %#x\n", offRead, (pRingBuf)->offEnd)); \
103	\
104	AssertMsg(offWriteInt == RT_ALIGN_32(offWriteInt, INTNETHDR_ALIGNMENT), ("%#x\n", offWriteInt)); \
105	AssertMsg(offWriteInt >= (pRingBuf)->offStart, ("%#x %#x\n", offWriteInt, (pRingBuf)->offStart)); \
106	AssertMsg(offWriteInt < (pRingBuf)->offEnd, ("%#x %#x\n", offWriteInt, (pRingBuf)->offEnd)); \
107	AssertMsg( offRead <= offWriteCom \
108	? offWriteCom <= offWriteInt \|\| offWriteInt < offRead \
109	: offWriteCom <= offWriteInt, \
110	("W=%#x W'=%#x R=%#x\n", offWriteCom, offWriteInt, offRead)); \
111	} \
112	} while (0)
113
114
115
116	/**
117	* A interface buffer.
118	*/
119	typedef struct INTNETBUF
120	{
121	/** Magic number (INTNETBUF_MAGIC). */
122	uint32_t u32Magic;
123	/** The size of the entire buffer. */
124	uint32_t cbBuf;
125	/** The size of the send area. */
126	uint32_t cbSend;
127	/** The size of the receive area. */
128	uint32_t cbRecv;
129	/** The receive buffer. */
130	INTNETRINGBUF Recv;
131	/** The send buffer. */
132	INTNETRINGBUF Send;
133	/** Number of times yields help solve an overflow. */
134	STAMCOUNTER cStatYieldsOk;
135	/** Number of times yields didn't help solve an overflow. */
136	STAMCOUNTER cStatYieldsNok;
137	/** Number of lost packets due to overflows. */
138	STAMCOUNTER cStatLost;
139	/** Number of bad frames (both rings). */
140	STAMCOUNTER cStatBadFrames;
141	/** Reserved for future use. */
142	STAMCOUNTER aStatReserved[2];
143	} INTNETBUF;
144	AssertCompileSize(INTNETBUF, 160);
145	AssertCompileMemberOffset(INTNETBUF, Recv, 16);
146	AssertCompileMemberOffset(INTNETBUF, Send, 64);
147
148	/** Pointer to an interface buffer. */
149	typedef INTNETBUF *PINTNETBUF;
150	/** Pointer to a const interface buffer. */
151	typedef INTNETBUF const *PCINTNETBUF;
152
153	/** Magic number for INTNETBUF::u32Magic (Sir William Gerald Golding). */
154	#define INTNETBUF_MAGIC UINT32_C(0x19110919)
155
156	/**
157	* Asserts the sanity of the specified INTNETBUF structure.
158	*/
159	#define INTNETBUF_ASSERT_SANITY(pBuf) \
160	do \
161	{ \
162	AssertPtr(pBuf); \
163	Assert((pBuf)->u32Magic == INTNETBUF_MAGIC); \
164	{ \
165	uint32_t const offRecvStart = (pBuf)->Recv.offStart + RT_OFFSETOF(INTNETBUF, Recv); \
166	uint32_t const offRecvEnd = (pBuf)->Recv.offStart + RT_OFFSETOF(INTNETBUF, Recv); \
167	uint32_t const offSendStart = (pBuf)->Send.offStart + RT_OFFSETOF(INTNETBUF, Send); \
168	uint32_t const offSendEnd = (pBuf)->Send.offStart + RT_OFFSETOF(INTNETBUF, Send); \
169	\
170	Assert(offRecvEnd > offRecvStart); \
171	Assert(offRecvEnd - offRecvStart == (pBuf)->cbRecv); \
172	Assert(offRecvStart == sizeof(INTNETBUF)); \
173	\
174	Assert(offSendEnd > offSendStart); \
175	Assert(offSendEnd - offSendStart == (pBuf)->cbSend); \
176	Assert(pffSendEnd <= (pBuf)->cbBuf); \
177	\
178	Assert(offSendStart == offRecvEnd); \
179	} \
180	} while (0)
181
182
183	/** Internal networking interface handle. */
184	typedef uint32_t INTNETIFHANDLE;
185	/** Pointer to an internal networking interface handle. */
186	typedef INTNETIFHANDLE *PINTNETIFHANDLE;
187
188	/** Or mask to obscure the handle index. */
189	#define INTNET_HANDLE_MAGIC 0x88880000
190	/** Mask to extract the handle index. */
191	#define INTNET_HANDLE_INDEX_MASK 0xffff
192	/** The maximum number of handles (exclusive) */
193	#define INTNET_HANDLE_MAX 0xffff
194	/** Invalid handle. */
195	#define INTNET_HANDLE_INVALID (0)
196
197
198	/**
199	* The packet header.
200	*
201	* The header is intentionally 8 bytes long. It will always
202	* start at an 8 byte aligned address. Assuming that the buffer
203	* size is a multiple of 8 bytes, that means that we can guarantee
204	* that the entire header is contiguous in both virtual and physical
205	* memory.
206	*/
207	typedef struct INTNETHDR
208	{
209	/** Header type. This is currently serving as a magic, it
210	* can be extended later to encode special command packets and stuff. */
211	uint16_t u16Type;
212	/** The size of the frame. */
213	uint16_t cbFrame;
214	/** The offset from the start of this header to where the actual frame starts.
215	* This is used to keep the frame it self continguous in virtual memory and
216	* thereby both simplify access as well as the descriptor. */
217	int32_t offFrame;
218	} INTNETHDR;
219	AssertCompileSize(INTNETHDR, 8);
220	AssertCompileSizeAlignment(INTNETBUF, sizeof(INTNETHDR));
221	/** Pointer to a packet header.*/
222	typedef INTNETHDR *PINTNETHDR;
223	/** Pointer to a const packet header.*/
224	typedef INTNETHDR const *PCINTNETHDR;
225
226	/** The alignment of a packet header. */
227	#define INTNETHDR_ALIGNMENT sizeof(INTNETHDR)
228	AssertCompile(sizeof(INTNETHDR) == INTNETHDR_ALIGNMENT);
229	AssertCompile(INTNETHDR_ALIGNMENT <= INTNETRINGBUF_ALIGNMENT);
230
231	/** INTNETHDR::u16Type value for normal frames. */
232	#define INTNETHDR_TYPE_FRAME 0x2442
233	/** INTNETHDR::u16Type value for padding frames. */
234	#define INTNETHDR_TYPE_PADDING 0x3553
235
236	/**
237	* Asserts the sanity of the specified INTNETHDR.
238	*/
239	#define INTNETHDR_ASSERT_SANITY(pHdr, pRingBuf) \
240	do \
241	{ \
242	AssertPtr(pHdr); \
243	Assert(RT_ALIGN_PT(pHdr, INTNETHDR_ALIGNMENT, INTNETHDR *) == pHdr); \
244	Assert((pHdr)->u16Type == INTNETHDR_TYPE_FRAME \|\| (pHdr)->u16Type == INTNETHDR_TYPE_PADDING); \
245	{ \
246	uintptr_t const offHdr = (uintptr_t)pHdr - (uintptr_t)pRingBuf; \
247	uintptr_t const offFrame = offHdr + (pHdr)->offFrame; \
248	\
249	Assert(offHdr >= (pRingBuf)->offStart); \
250	Assert(offHdr < (pRingBuf)->offEnd); \
251	\
252	/* could do more thorough work here... later, perhaps. */ \
253	Assert(offFrame >= (pRingBuf)->offStart); \
254	Assert(offFrame < (pRingBuf)->offEnd); \
255	} \
256	} while (0)
257
258
259	/**
260	* Scatter / Gather segment (internal networking).
261	*/
262	typedef struct INTNETSEG
263	{
264	/** The physical address. NIL_RTHCPHYS is not set. */
265	RTHCPHYS Phys;
266	/** Pointer to the segment data. */
267	void *pv;
268	/** The segment size. */
269	uint32_t cb;
270	} INTNETSEG;
271	/** Pointer to a internal networking packet segment. */
272	typedef INTNETSEG *PINTNETSEG;
273	/** Pointer to a internal networking packet segment. */
274	typedef INTNETSEG const *PCINTNETSEG;
275
276
277	/**
278	* Scatter / Gather list (internal networking).
279	*
280	* This is used when communicating with the trunk port.
281	*/
282	typedef struct INTNETSG
283	{
284	/** Owner data, don't touch! */
285	void *pvOwnerData;
286	/** User data. */
287	void *pvUserData;
288	/** User data 2 in case anyone needs it. */
289	void *pvUserData2;
290	/** The total length of the scatter gather list. */
291	uint32_t cbTotal;
292	/** The number of users (references).
293	* This is used by the SGRelease code to decide when it can be freed. */
294	uint16_t volatile cUsers;
295	/** Flags, see INTNETSG_FLAGS_* */
296	uint16_t volatile fFlags;
297	/** The number of segments allocated. */
298	uint16_t cSegsAlloc;
299	/** The number of segments actually used. */
300	uint16_t cSegsUsed;
301	/** Variable sized list of segments. */
302	INTNETSEG aSegs[1];
303	} INTNETSG;
304	/** Pointer to a scatter / gather list. */
305	typedef INTNETSG *PINTNETSG;
306	/** Pointer to a const scatter / gather list. */
307	typedef INTNETSG const *PCINTNETSG;
308
309	/** @name INTNETSG::fFlags definitions.
310	* @{ */
311	/** Set if the SG is free. */
312	#define INTNETSG_FLAGS_FREE RT_BIT_32(1)
313	/** Set if the SG is a temporary one that will become invalid upon return.
314	* Try to finish using it before returning, and if that's not possible copy
315	* to other buffers.
316	* When not set, the callee should always free the SG.
317	* Attempts to free it made by the callee will be quietly ignored. */
318	#define INTNETSG_FLAGS_TEMP RT_BIT_32(2)
319	/** ARP packet, IPv4 + MAC.
320	* @internal */
321	#define INTNETSG_FLAGS_ARP_IPV4 RT_BIT_32(3)
322	/** Copied to the temporary buffer.
323	* @internal */
324	#define INTNETSG_FLAGS_PKT_CP_IN_TMP RT_BIT_32(4)
325	/** @} */
326
327
328	/** @name Direction (packet source or destination)
329	* @{ */
330	/** To/From the wire. */
331	#define INTNETTRUNKDIR_WIRE RT_BIT_32(0)
332	/** To/From the host. */
333	#define INTNETTRUNKDIR_HOST RT_BIT_32(1)
334	/** Mask of valid bits. */
335	#define INTNETTRUNKDIR_VALID_MASK UINT32_C(3)
336	/** @} */
337
338
339	/** Pointer to the switch side of a trunk port. */
340	typedef struct INTNETTRUNKSWPORT *PINTNETTRUNKSWPORT;
341	/**
342	* This is the port on the internal network 'switch', i.e.
343	* what the driver is connected to.
344	*
345	* This is only used for the in-kernel trunk connections.
346	*/
347	typedef struct INTNETTRUNKSWPORT
348	{
349	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
350	uint32_t u32Version;
351
352	/**
353	* Selects whether outgoing SGs should have their physical address set.
354	*
355	* By enabling physical addresses in the scatter / gather segments it should
356	* be possible to save some unnecessary address translation and memory locking
357	* in the network stack. (Internal networking knows the physical address for
358	* all the INTNETBUF data and that it's locked memory.) There is a negative
359	* side effects though, frames that crosses page boundraries will require
360	* multiple scather / gather segments.
361	*
362	* @returns The old setting.
363	*
364	* @param pSwitchPort Pointer to this structure.
365	* @param fEnable Whether to enable or disable it.
366	*
367	* @remarks Will grab the network semaphore.
368	*/
369	DECLR0CALLBACKMEMBER(bool, pfnSetSGPhys,(PINTNETTRUNKSWPORT pSwitchPort, bool fEnable));
370
371	/**
372	* Incoming frame.
373	*
374	* The frame may be modified when the trunk port on the switch is set to share
375	* the mac address of the host when hitting the wire. Currently rames containing
376	* ARP packets are subject to this, later other protocols like NDP/ICMPv6 may
377	* need editing as well when operating in this mode.
378	*
379	* @returns true if we've handled it and it should be dropped.
380	* false if it should hit the wire.
381	*
382	* @param pSwitchPort Pointer to this structure.
383	* @param pSG The (scatter /) gather structure for the frame.
384	* This will only be use during the call, so a temporary one can
385	* be used. The Phys member will not be used.
386	* @param fSrc Where this frame comes from. Only one bit should be set!
387	*
388	* @remarks Will grab the network semaphore.
389	*
390	* @remarks NAT and TAP will use this interface.
391	*
392	* @todo Do any of the host require notification before frame modifications? If so,
393	* we'll add a callback to INTNETTRUNKIFPORT for this (pfnSGModifying) and
394	* a SG flag.
395	*/
396	DECLR0CALLBACKMEMBER(bool, pfnRecv,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG, uint32_t fSrc));
397
398	/**
399	* Retain a SG.
400	*
401	* @param pSwitchPort Pointer to this structure.
402	* @param pSG Pointer to the (scatter /) gather structure.
403	*
404	* @remarks Will not grab any locks.
405	*/
406	DECLR0CALLBACKMEMBER(void, pfnSGRetain,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
407
408	/**
409	* Release a SG.
410	*
411	* This is called by the pfnXmit code when done with a SG. This may safe
412	* be done in an asynchronous manner.
413	*
414	* @param pSwitchPort Pointer to this structure.
415	* @param pSG Pointer to the (scatter /) gather structure.
416	*
417	* @remarks Will grab the network semaphore.
418	*/
419	DECLR0CALLBACKMEMBER(void, pfnSGRelease,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
420
421	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
422	uint32_t u32VersionEnd;
423	} INTNETTRUNKSWPORT;
424
425	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
426	#define INTNETTRUNKSWPORT_VERSION UINT32_C(0xA2CDf001)
427
428
429	/** Pointer to the interface side of a trunk port. */
430	typedef struct INTNETTRUNKIFPORT *PINTNETTRUNKIFPORT;
431	/**
432	* This is the port on the trunk interface, i.e. the driver
433	* side which the internal network is connected to.
434	*
435	* This is only used for the in-kernel trunk connections.
436	*
437	* @remarks The internal network side is responsible for serializing all calls
438	* to this interface. This is (assumed) to be implemented using a lock
439	* that is only ever taken before a call to this interface. The lock
440	* is referred to as the out-bound trunk port lock.
441	*/
442	typedef struct INTNETTRUNKIFPORT
443	{
444	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
445	uint32_t u32Version;
446
447	/**
448	* Retain the object.
449	*
450	* It will normally be called while owning the internal network semaphore.
451	*
452	* @param pIfPort Pointer to this structure.
453	*
454	* @remarks The caller may own any locks or none at all, we don't care.
455	*/
456	DECLR0CALLBACKMEMBER(void, pfnRetain,(PINTNETTRUNKIFPORT pIfPort));
457
458	/**
459	* Releases the object.
460	*
461	* This must be called for every pfnRetain call.
462	*
463	*
464	* @param pIfPort Pointer to this structure.
465	*
466	* @remarks Only the out-bound trunk port lock, unless the caller is certain the
467	* call is not going to cause destruction (wont happen).
468	*/
469	DECLR0CALLBACKMEMBER(void, pfnRelease,(PINTNETTRUNKIFPORT pIfPort));
470
471	/**
472	* Disconnect from the switch and release the object.
473	*
474	* The is the counter action of the
475	* INTNETTRUNKNETFLTFACTORY::pfnCreateAndConnect method.
476	*
477	* @param pIfPort Pointer to this structure.
478	*
479	* @remarks Called holding the out-bound trunk port lock.
480	*/
481	DECLR0CALLBACKMEMBER(void, pfnDisconnectAndRelease,(PINTNETTRUNKIFPORT pIfPort));
482
483	/**
484	* Changes the active state of the interface.
485	*
486	* The interface is created in the suspended (non-active) state and then activated
487	* when the VM/network is started. It may be suspended and re-activated later
488	* for various reasons. It will finally be suspended again before disconnecting
489	* the interface from the internal network, however, this might be done immediately
490	* before disconnecting and may leave an incoming frame waiting on the internal network
491	* semaphore. So, after the final suspend a pfnWaitForIdle is always called to make sure
492	* the interface is idle before pfnDisconnectAndRelease is called.
493	*
494	* A typical operation to performed by this method is to enable/disable promiscuous
495	* mode on the host network interface. (This is the reason we cannot call this when
496	* owning any semaphores.)
497	*
498	* @returns The previous state.
499	*
500	* @param pIfPort Pointer to this structure.
501	* @param fActive True if the new state is 'active', false if the new state is 'suspended'.
502	*
503	* @remarks Called holding the out-bound trunk port lock.
504	*/
505	DECLR0CALLBACKMEMBER(bool, pfnSetActive,(PINTNETTRUNKIFPORT pIfPort, bool fActive));
506
507	/**
508	* Waits for the interface to become idle.
509	*
510	* This method must be called before disconnecting and releasing the
511	* object in order to prevent racing incoming/outgoing packets and
512	* device enabling/disabling.
513	*
514	* @returns IPRT status code (see RTSemEventWait).
515	* @param pIfPort Pointer to this structure.
516	* @param cMillies The number of milliseconds to wait. 0 means
517	* no waiting at all. Use RT_INDEFINITE_WAIT for
518	* an indefinite wait.
519	*
520	* @remarks Called holding the out-bound trunk port lock.
521	*/
522	DECLR0CALLBACKMEMBER(int, pfnWaitForIdle,(PINTNETTRUNKIFPORT pIfPort, uint32_t cMillies));
523
524	/**
525	* Gets the MAC address of the host network interface that we're attached to.
526	*
527	* @param pIfPort Pointer to this structure.
528	* @param pMac Where to store the host MAC address.
529	*
530	* @remarks Called while owning the network and the out-bound trunk port semaphores.
531	*/
532	DECLR0CALLBACKMEMBER(void, pfnGetMacAddress,(PINTNETTRUNKIFPORT pIfPort, PRTMAC pMac));
533
534	/**
535	* Tests if the mac address belongs to any of the host NICs
536	* and should take the host route.
537	*
538	* @returns true / false.
539	*
540	* @param pIfPort Pointer to this structure.
541	* @param pMac Pointer to the mac address.
542	*
543	* @remarks Called while owning the network and the out-bound trunk port semaphores.
544	*
545	* @remarks TAP and NAT will compare with their own MAC address and let all their
546	* traffic take the host direction.
547	*
548	* @remarks This didn't quiet work out the way it should... perhaps obsolete this
549	* with pfnGetHostMac?
550	*/
551	DECLR0CALLBACKMEMBER(bool, pfnIsHostMac,(PINTNETTRUNKIFPORT pIfPort, PCRTMAC pMac));
552
553	/**
554	* Tests whether the host is operating the interface is promiscuous mode.
555	*
556	* The default behavior of the internal networking 'switch' is to 'autodetect'
557	* promiscuous mode on the trunk port, which is when this method is used.
558	* For security reasons this default may of course be overridden so that the
559	* host cannot sniff at what's going on.
560	*
561	* Note that this differs from operating the trunk port on the switch in
562	* 'promiscuous' mode, because that relates to the bits going to the wire.
563	*
564	* @returns true / false.
565	*
566	* @param pIfPort Pointer to this structure.
567	*
568	* @remarks Called while owning the network and the out-bound trunk port semaphores.
569	*/
570	DECLR0CALLBACKMEMBER(bool, pfnIsPromiscuous,(PINTNETTRUNKIFPORT pIfPort));
571
572	/**
573	* Transmit a frame.
574	*
575	* @return VBox status code. Error generally means we'll drop the packet.
576	* @param pIfPort Pointer to this structure.
577	* @param pSG Pointer to the (scatter /) gather structure for the frame.
578	* This may or may not be a temporary buffer. If it's temporary
579	* the transmit operation(s) then it's required to make a copy
580	* of the frame unless it can be transmitted synchronously.
581	* @param fDst The destination mask. At least one bit will be set.
582	*
583	* @remarks Called holding the out-bound trunk port lock.
584	*
585	* @remarks TAP and NAT will use this interface for all their traffic, see pfnIsHostMac.
586	*
587	* @todo
588	*/
589	DECLR0CALLBACKMEMBER(int, pfnXmit,(PINTNETTRUNKIFPORT pIfPort, PINTNETSG pSG, uint32_t fDst));
590
591	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
592	uint32_t u32VersionEnd;
593	} INTNETTRUNKIFPORT;
594
595	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
596	#define INTNETTRUNKIFPORT_VERSION UINT32_C(0xA2CDe001)
597
598
599	/**
600	* The component factory interface for create a network
601	* interface filter (like VBoxNetFlt).
602	*/
603	typedef struct INTNETTRUNKFACTORY
604	{
605	/**
606	* Release this factory.
607	*
608	* SUPR0ComponentQueryFactory (SUPDRVFACTORY::pfnQueryFactoryInterface to be precise)
609	* will retain a reference to the factory and the caller has to call this method to
610	* release it once the pfnCreateAndConnect call(s) has been done.
611	*
612	* @param pIfFactory Pointer to this structure.
613	*/
614	DECLR0CALLBACKMEMBER(void, pfnRelease,(struct INTNETTRUNKFACTORY *pIfFactory));
615
616	/**
617	* Create an instance for the specfied host interface and connects it
618	* to the internal network trunk port.
619	*
620	* The initial interface active state is false (suspended).
621	*
622	*
623	* @returns VBox status code.
624	* @retval VINF_SUCCESS and *ppIfPort set on success.
625	* @retval VERR_INTNET_FLT_IF_NOT_FOUND if the interface was not found.
626	* @retval VERR_INTNET_FLT_IF_BUSY if the interface is already connected.
627	* @retval VERR_INTNET_FLT_IF_FAILED if it failed for some other reason.
628	*
629	* @param pIfFactory Pointer to this structure.
630	* @param pszName The interface name (OS specific).
631	* @param pSwitchPort Pointer to the port interface on the switch that
632	* this interface is being connected to.
633	* @param fFlags Creation flags, see below.
634	* @param ppIfPort Where to store the pointer to the interface port
635	* on success.
636	*
637	* @remarks Called while owning the network and the out-bound trunk semaphores.
638	*/
639	DECLR0CALLBACKMEMBER(int, pfnCreateAndConnect,(struct INTNETTRUNKFACTORY pIfFactory, const char pszName,
640	PINTNETTRUNKSWPORT pSwitchPort, uint32_t fFlags,
641	PINTNETTRUNKIFPORT *ppIfPort));
642	} INTNETTRUNKFACTORY;
643	/** Pointer to the trunk factory. */
644	typedef INTNETTRUNKFACTORY *PINTNETTRUNKFACTORY;
645
646	/** The UUID for the (current) trunk factory. (case sensitive) */
647	#define INTNETTRUNKFACTORY_UUID_STR "449a2799-7564-464d-b4b2-7a877418fd0c"
648
649	/** @name INTNETTRUNKFACTORY::pfnCreateAndConnect flags.
650	* @{ */
651	/** Don't put the filtered interface in promiscuous mode.
652	* This is used for wireless interface since these can misbehave if
653	* we try to put them in promiscuous mode. (Wireless interfaces are
654	* normally bridged on level 3 instead of level 2.) */
655	#define INTNETTRUNKFACTORY_FLAG_NO_PROMISC RT_BIT_32(0)
656	/** @} */
657
658
659	/**
660	* The trunk connection type.
661	*
662	* Used by INTNETR0Open and assoicated interfaces.
663	*/
664	typedef enum INTNETTRUNKTYPE
665	{
666	/** Invalid trunk type. */
667	kIntNetTrunkType_Invalid = 0,
668	/** No trunk connection. */
669	kIntNetTrunkType_None,
670	/** We don't care which kind of trunk connection if the network exists,
671	* if it doesn't exist create it without a connection. */
672	kIntNetTrunkType_WhateverNone,
673	/** VirtualBox host network interface filter driver.
674	* The trunk name is the name of the host network interface. */
675	kIntNetTrunkType_NetFlt,
676	/** VirtualBox adapter host driver. */
677	kIntNetTrunkType_NetAdp,
678	/** Nat service (ring-0). */
679	kIntNetTrunkType_SrvNat,
680	/** The end of valid types. */
681	kIntNetTrunkType_End,
682	/** The usual 32-bit hack. */
683	kIntNetTrunkType_32bitHack = 0x7fffffff
684	} INTNETTRUNKTYPE;
685
686	/** @name INTNETR0Open flags.
687	* @{ */
688	/** Share the MAC address with the host when sending something to the wire via the trunk.
689	* This is typically used when the trunk is a NetFlt for a wireless interface. */
690	#define INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE RT_BIT_32(0)
691	/** Whether new participants should be subjected to access check or not. */
692	#define INTNET_OPEN_FLAGS_PUBLIC RT_BIT_32(1)
693	/** Ignore any requests for promiscuous mode. */
694	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC RT_BIT_32(2)
695	/** Ignore any requests for promiscuous mode, quietly applied/ignored on open. */
696	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC RT_BIT_32(3)
697	/** Ignore any requests for promiscuous mode on the trunk wire connection. */
698	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC_TRUNK_WIRE RT_BIT_32(4)
699	/** Ignore any requests for promiscuous mode on the trunk wire connection, quietly applied/ignored on open. */
700	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC_TRUNK_WIRE RT_BIT_32(5)
701	/** Ignore any requests for promiscuous mode on the trunk host connection. */
702	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC_TRUNK_HOST RT_BIT_32(6)
703	/** Ignore any requests for promiscuous mode on the trunk host connection, quietly applied/ignored on open. */
704	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC_TRUNK_HOST RT_BIT_32(7)
705	/** The mask of flags which causes flag incompatibilities. */
706	#define INTNET_OPEN_FLAGS_COMPATIBILITY_XOR_MASK (RT_BIT_32(0) \| RT_BIT_32(1) \| RT_BIT_32(2) \| RT_BIT_32(4) \| RT_BIT_32(6))
707	/** The mask of flags is always ORed in, even on open. (the quiet stuff) */
708	#define INTNET_OPEN_FLAGS_SECURITY_OR_MASK (RT_BIT_32(3) \| RT_BIT_32(5) \| RT_BIT_32(7))
709	/** The mask of valid flags. */
710	#define INTNET_OPEN_FLAGS_MASK UINT32_C(0x000000ff)
711	/** @} */
712
713	/** The maximum length of a network name. */
714	#define INTNET_MAX_NETWORK_NAME 128
715
716	/** The maximum length of a trunk name. */
717	#define INTNET_MAX_TRUNK_NAME 64
718
719
720	/**
721	* Request buffer for INTNETR0OpenReq / VMMR0_DO_INTNET_OPEN.
722	* @see INTNETR0Open.
723	*/
724	typedef struct INTNETOPENREQ
725	{
726	/** The request header. */
727	SUPVMMR0REQHDR Hdr;
728	/** Alternative to passing the taking the session from the VM handle.
729	* Either use this member or use the VM handle, don't do both. */
730	PSUPDRVSESSION pSession;
731	/** The network name. (input) */
732	char szNetwork[INTNET_MAX_NETWORK_NAME];
733	/** What to connect to the trunk port. (input)
734	* This is specific to the trunk type below. */
735	char szTrunk[INTNET_MAX_TRUNK_NAME];
736	/** The type of trunk link (NAT, Filter, TAP, etc). (input) */
737	INTNETTRUNKTYPE enmTrunkType;
738	/** Flags, see INTNET_OPEN_FLAGS_. (input) /
739	uint32_t fFlags;
740	/** The size of the send buffer. (input) */
741	uint32_t cbSend;
742	/** The size of the receive buffer. (input) */
743	uint32_t cbRecv;
744	/** The handle to the network interface. (output) */
745	INTNETIFHANDLE hIf;
746	} INTNETOPENREQ;
747	/** Pointer to an INTNETR0OpenReq / VMMR0_DO_INTNET_OPEN request buffer. */
748	typedef INTNETOPENREQ *PINTNETOPENREQ;
749
750	INTNETR0DECL(int) INTNETR0OpenReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETOPENREQ pReq);
751
752
753	/**
754	* Request buffer for INTNETR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE.
755	* @see INTNETR0IfClose.
756	*/
757	typedef struct INTNETIFCLOSEREQ
758	{
759	/** The request header. */
760	SUPVMMR0REQHDR Hdr;
761	/** Alternative to passing the taking the session from the VM handle.
762	* Either use this member or use the VM handle, don't do both. */
763	PSUPDRVSESSION pSession;
764	/** The handle to the network interface. */
765	INTNETIFHANDLE hIf;
766	} INTNETIFCLOSEREQ;
767	/** Pointer to an INTNETR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE request buffer. */
768	typedef INTNETIFCLOSEREQ *PINTNETIFCLOSEREQ;
769
770	INTNETR0DECL(int) INTNETR0IfCloseReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFCLOSEREQ pReq);
771
772
773	/**
774	* Request buffer for INTNETR0IfGetRing3BufferReq / VMMR0_DO_INTNET_IF_GET_RING3_BUFFER.
775	* @see INTNETR0IfGetRing3Buffer.
776	*/
777	typedef struct INTNETIFGETRING3BUFFERREQ
778	{
779	/** The request header. */
780	SUPVMMR0REQHDR Hdr;
781	/** Alternative to passing the taking the session from the VM handle.
782	* Either use this member or use the VM handle, don't do both. */
783	PSUPDRVSESSION pSession;
784	/** Handle to the interface. */
785	INTNETIFHANDLE hIf;
786	/** The pointer to the ring3 buffer. (output) */
787	R3PTRTYPE(PINTNETBUF) pRing3Buf;
788	} INTNETIFGETRING3BUFFERREQ;
789	/** Pointer to an INTNETR0IfGetRing3BufferReq / VMMR0_DO_INTNET_IF_GET_RING3_BUFFER request buffer. */
790	typedef INTNETIFGETRING3BUFFERREQ *PINTNETIFGETRING3BUFFERREQ;
791
792	INTNETR0DECL(int) INTNETR0IfGetRing3BufferReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFGETRING3BUFFERREQ pReq);
793
794
795	/**
796	* Request buffer for INTNETR0IfSetPromiscuousModeReq / VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE.
797	* @see INTNETR0IfSetPromiscuousMode.
798	*/
799	typedef struct INTNETIFSETPROMISCUOUSMODEREQ
800	{
801	/** The request header. */
802	SUPVMMR0REQHDR Hdr;
803	/** Alternative to passing the taking the session from the VM handle.
804	* Either use this member or use the VM handle, don't do both. */
805	PSUPDRVSESSION pSession;
806	/** Handle to the interface. */
807	INTNETIFHANDLE hIf;
808	/** The new promiscuous mode. */
809	bool fPromiscuous;
810	} INTNETIFSETPROMISCUOUSMODEREQ;
811	/** Pointer to an INTNETR0IfSetPromiscuousModeReq / VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE request buffer. */
812	typedef INTNETIFSETPROMISCUOUSMODEREQ *PINTNETIFSETPROMISCUOUSMODEREQ;
813
814	INTNETR0DECL(int) INTNETR0IfSetPromiscuousModeReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETPROMISCUOUSMODEREQ pReq);
815
816
817	/**
818	* Request buffer for INTNETR0IfSetMacAddressReq / VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS.
819	* @see INTNETR0IfSetMacAddress.
820	*/
821	typedef struct INTNETIFSETMACADDRESSREQ
822	{
823	/** The request header. */
824	SUPVMMR0REQHDR Hdr;
825	/** Alternative to passing the taking the session from the VM handle.
826	* Either use this member or use the VM handle, don't do both. */
827	PSUPDRVSESSION pSession;
828	/** Handle to the interface. */
829	INTNETIFHANDLE hIf;
830	/** The new MAC address. */
831	RTMAC Mac;
832	} INTNETIFSETMACADDRESSREQ;
833	/** Pointer to an INTNETR0IfSetMacAddressReq / VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS request buffer. */
834	typedef INTNETIFSETMACADDRESSREQ *PINTNETIFSETMACADDRESSREQ;
835
836	INTNETR0DECL(int) INTNETR0IfSetMacAddressReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETMACADDRESSREQ pReq);
837
838
839	/**
840	* Request buffer for INTNETR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE.
841	* @see INTNETR0IfSetActive.
842	*/
843	typedef struct INTNETIFSETACTIVEREQ
844	{
845	/** The request header. */
846	SUPVMMR0REQHDR Hdr;
847	/** Alternative to passing the taking the session from the VM handle.
848	* Either use this member or use the VM handle, don't do both. */
849	PSUPDRVSESSION pSession;
850	/** Handle to the interface. */
851	INTNETIFHANDLE hIf;
852	/** The new state. */
853	bool fActive;
854	} INTNETIFSETACTIVEREQ;
855	/** Pointer to an INTNETR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE request buffer. */
856	typedef INTNETIFSETACTIVEREQ *PINTNETIFSETACTIVEREQ;
857
858	INTNETR0DECL(int) INTNETR0IfSetActiveReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETACTIVEREQ pReq);
859
860
861	/**
862	* Request buffer for INTNETR0IfSendReq / VMMR0_DO_INTNET_IF_SEND.
863	* @see INTNETR0IfSend.
864	*/
865	typedef struct INTNETIFSENDREQ
866	{
867	/** The request header. */
868	SUPVMMR0REQHDR Hdr;
869	/** Alternative to passing the taking the session from the VM handle.
870	* Either use this member or use the VM handle, don't do both. */
871	PSUPDRVSESSION pSession;
872	/** Handle to the interface. */
873	INTNETIFHANDLE hIf;
874	} INTNETIFSENDREQ;
875	/** Pointer to an INTNETR0IfSend() argument package. */
876	typedef INTNETIFSENDREQ *PINTNETIFSENDREQ;
877
878	INTNETR0DECL(int) INTNETR0IfSendReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSENDREQ pReq);
879
880
881	/**
882	* Request buffer for INTNETR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT.
883	* @see INTNETR0IfWait.
884	*/
885	typedef struct INTNETIFWAITREQ
886	{
887	/** The request header. */
888	SUPVMMR0REQHDR Hdr;
889	/** Alternative to passing the taking the session from the VM handle.
890	* Either use this member or use the VM handle, don't do both. */
891	PSUPDRVSESSION pSession;
892	/** Handle to the interface. */
893	INTNETIFHANDLE hIf;
894	/** The number of milliseconds to wait. */
895	uint32_t cMillies;
896	} INTNETIFWAITREQ;
897	/** Pointer to an INTNETR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT request buffer. */
898	typedef INTNETIFWAITREQ *PINTNETIFWAITREQ;
899
900	INTNETR0DECL(int) INTNETR0IfWaitReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFWAITREQ pReq);
901
902
903	#if defined(IN_RING0) \|\| defined(IN_INTNET_TESTCASE)
904	/** @name
905	* @{
906	*/
907
908	/**
909	* Create an instance of the Ring-0 internal networking service.
910	*
911	* @returns VBox status code.
912	* @param ppIntNet Where to store the instance pointer.
913	*/
914	INTNETR0DECL(int) INTNETR0Create(PINTNET *ppIntNet);
915
916	/**
917	* Destroys an instance of the Ring-0 internal networking service.
918	*
919	* @param pIntNet Pointer to the instance data.
920	*/
921	INTNETR0DECL(void) INTNETR0Destroy(PINTNET pIntNet);
922
923	/**
924	* Opens a network interface and connects it to the specified network.
925	*
926	* @returns VBox status code.
927	* @param pIntNet The internal network instance.
928	* @param pSession The session handle.
929	* @param pszNetwork The network name.
930	* @param enmTrunkType The trunk type.
931	* @param pszTrunk The trunk name. Its meaning is specfic to the type.
932	* @param fFlags Flags, see INTNET_OPEN_FLAGS_*.
933	* @param fRestrictAccess Whether new participants should be subjected to access check or not.
934	* @param cbSend The send buffer size.
935	* @param cbRecv The receive buffer size.
936	* @param phIf Where to store the handle to the network interface.
937	*/
938	INTNETR0DECL(int) INTNETR0Open(PINTNET pIntNet, PSUPDRVSESSION pSession, const char *pszNetwork,
939	INTNETTRUNKTYPE enmTrunkType, const char *pszTrunk, uint32_t fFlags,
940	unsigned cbSend, unsigned cbRecv, PINTNETIFHANDLE phIf);
941
942	/**
943	* Close an interface.
944	*
945	* @returns VBox status code.
946	* @param pIntNet The instance handle.
947	* @param hIf The interface handle.
948	* @param pSession The caller's session.
949	*/
950	INTNETR0DECL(int) INTNETR0IfClose(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
951
952	/**
953	* Gets the ring-0 address of the current buffer.
954	*
955	* @returns VBox status code.
956	* @param pIntNet The instance data.
957	* @param hIf The interface handle.
958	* @param pSession The caller's session.
959	* @param ppRing0Buf Where to store the address of the ring-3 mapping.
960	*/
961	INTNETR0DECL(int) INTNETR0IfGetRing0Buffer(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, PINTNETBUF *ppRing0Buf);
962
963	/**
964	* Maps the default buffer into ring 3.
965	*
966	* @returns VBox status code.
967	* @param pIntNet The instance data.
968	* @param hIf The interface handle.
969	* @param pSession The caller's session.
970	* @param ppRing3Buf Where to store the address of the ring-3 mapping.
971	*/
972	INTNETR0DECL(int) INTNETR0IfGetRing3Buffer(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, R3PTRTYPE(PINTNETBUF) *ppRing3Buf);
973
974	/**
975	* Sets the promiscuous mode property of an interface.
976	*
977	* @returns VBox status code.
978	* @param pIntNet The instance handle.
979	* @param hIf The interface handle.
980	* @param pSession The caller's session.
981	* @param fPromiscuous Set if the interface should be in promiscuous mode, clear if not.
982	*/
983	INTNETR0DECL(int) INTNETR0IfSetPromiscuousMode( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fPromiscuous);
984	INTNETR0DECL(int) INTNETR0IfSetMacAddress( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, PCRTMAC pMac);
985	INTNETR0DECL(int) INTNETR0IfSetActive( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fActive);
986
987	/**
988	* Sends one or more frames.
989	*
990	* The function will first the frame which is passed as the optional
991	* arguments pvFrame and cbFrame. These are optional since it also
992	* possible to chain together one or more frames in the send buffer
993	* which the function will process after considering it's arguments.
994	*
995	* @returns VBox status code.
996	* @param pIntNet The instance data.
997	* @param hIf The interface handle.
998	* @param pSession The caller's session.
999	* @param pvFrame Pointer to the frame. Optional, please don't use.
1000	* @param cbFrame Size of the frame. Optional, please don't use.
1001	*/
1002	INTNETR0DECL(int) INTNETR0IfSend(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, const void *pvFrame, unsigned cbFrame);
1003
1004	/**
1005	* Wait for the interface to get signaled.
1006	* The interface will be signaled when is put into the receive buffer.
1007	*
1008	* @returns VBox status code.
1009	* @param pIntNet The instance handle.
1010	* @param hIf The interface handle.
1011	* @param pSession The caller's session.
1012	* @param cMillies Number of milliseconds to wait. RT_INDEFINITE_WAIT should be
1013	* used if indefinite wait is desired.
1014	*/
1015	INTNETR0DECL(int) INTNETR0IfWait(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, uint32_t cMillies);
1016
1017	/** @} */
1018	#endif /* IN_RING0 */
1019
1020	RT_C_DECLS_END
1021
1022	#endif

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

source: vbox/trunk/include/VBox/intnet.h@ 27840

Download in other formats: