intnet.h@ 27023

Last change on this file since 27023 was 26574, checked in by vboxsync, 15 years ago
Networking: Preparing to make the driver return a send buffer to the device emulation.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 39.1 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
234	/**
235	* Asserts the sanity of the specified INTNETHDR.
236	*/
237	#define INTNETHDR_ASSERT_SANITY(pHdr, pRingBuf) \
238	do \
239	{ \
240	AssertPtr(pHdr); \
241	Assert(RT_ALIGN_PT(pHdr, INTNETHDR_ALIGNMENT, INTNETHDR *) == pHdr); \
242	Assert((pHdr)->u16Type == INTNETHDR_TYPE_FRAME); \
243	{ \
244	uintptr_t const offHdr = (uintptr_t)pHdr - (uintptr_t)pRingBuf; \
245	uintptr_t const offFrame = offHdr + (pHdr)->offFrame; \
246	\
247	Assert(offHdr >= (pRingBuf)->offStart); \
248	Assert(offHdr < (pRingBuf)->offEnd); \
249	\
250	/* could do more thorough work here... later, perhaps. */ \
251	Assert(offFrame >= (pRingBuf)->offStart); \
252	Assert(offFrame < (pRingBuf)->offEnd); \
253	} \
254	} while (0)
255
256
257	/**
258	* Scatter / Gather segment (internal networking).
259	*/
260	typedef struct INTNETSEG
261	{
262	/** The physical address. NIL_RTHCPHYS is not set. */
263	RTHCPHYS Phys;
264	/** Pointer to the segment data. */
265	void *pv;
266	/** The segment size. */
267	uint32_t cb;
268	} INTNETSEG;
269	/** Pointer to a internal networking packet segment. */
270	typedef INTNETSEG *PINTNETSEG;
271	/** Pointer to a internal networking packet segment. */
272	typedef INTNETSEG const *PCINTNETSEG;
273
274
275	/**
276	* Scatter / Gather list (internal networking).
277	*
278	* This is used when communicating with the trunk port.
279	*/
280	typedef struct INTNETSG
281	{
282	/** Owner data, don't touch! */
283	void *pvOwnerData;
284	/** User data. */
285	void *pvUserData;
286	/** User data 2 in case anyone needs it. */
287	void *pvUserData2;
288	/** The total length of the scatter gather list. */
289	uint32_t cbTotal;
290	/** The number of users (references).
291	* This is used by the SGRelease code to decide when it can be freed. */
292	uint16_t volatile cUsers;
293	/** Flags, see INTNETSG_FLAGS_* */
294	uint16_t volatile fFlags;
295	/** The number of segments allocated. */
296	uint16_t cSegsAlloc;
297	/** The number of segments actually used. */
298	uint16_t cSegsUsed;
299	/** Variable sized list of segments. */
300	INTNETSEG aSegs[1];
301	} INTNETSG;
302	/** Pointer to a scatter / gather list. */
303	typedef INTNETSG *PINTNETSG;
304	/** Pointer to a const scatter / gather list. */
305	typedef INTNETSG const *PCINTNETSG;
306
307	/** @name INTNETSG::fFlags definitions.
308	* @{ */
309	/** Set if the SG is free. */
310	#define INTNETSG_FLAGS_FREE RT_BIT_32(1)
311	/** Set if the SG is a temporary one that will become invalid upon return.
312	* Try to finish using it before returning, and if that's not possible copy
313	* to other buffers.
314	* When not set, the callee should always free the SG.
315	* Attempts to free it made by the callee will be quietly ignored. */
316	#define INTNETSG_FLAGS_TEMP RT_BIT_32(2)
317	/** ARP packet, IPv4 + MAC.
318	* @internal */
319	#define INTNETSG_FLAGS_ARP_IPV4 RT_BIT_32(3)
320	/** Copied to the temporary buffer.
321	* @internal */
322	#define INTNETSG_FLAGS_PKT_CP_IN_TMP RT_BIT_32(4)
323	/** @} */
324
325
326	/** @name Direction (packet source or destination)
327	* @{ */
328	/** To/From the wire. */
329	#define INTNETTRUNKDIR_WIRE RT_BIT_32(0)
330	/** To/From the host. */
331	#define INTNETTRUNKDIR_HOST RT_BIT_32(1)
332	/** Mask of valid bits. */
333	#define INTNETTRUNKDIR_VALID_MASK UINT32_C(3)
334	/** @} */
335
336
337	/** Pointer to the switch side of a trunk port. */
338	typedef struct INTNETTRUNKSWPORT *PINTNETTRUNKSWPORT;
339	/**
340	* This is the port on the internal network 'switch', i.e.
341	* what the driver is connected to.
342	*
343	* This is only used for the in-kernel trunk connections.
344	*/
345	typedef struct INTNETTRUNKSWPORT
346	{
347	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
348	uint32_t u32Version;
349
350	/**
351	* Selects whether outgoing SGs should have their physical address set.
352	*
353	* By enabling physical addresses in the scatter / gather segments it should
354	* be possible to save some unnecessary address translation and memory locking
355	* in the network stack. (Internal networking knows the physical address for
356	* all the INTNETBUF data and that it's locked memory.) There is a negative
357	* side effects though, frames that crosses page boundraries will require
358	* multiple scather / gather segments.
359	*
360	* @returns The old setting.
361	*
362	* @param pSwitchPort Pointer to this structure.
363	* @param fEnable Whether to enable or disable it.
364	*
365	* @remarks Will grab the network semaphore.
366	*/
367	DECLR0CALLBACKMEMBER(bool, pfnSetSGPhys,(PINTNETTRUNKSWPORT pSwitchPort, bool fEnable));
368
369	/**
370	* Incoming frame.
371	*
372	* The frame may be modified when the trunk port on the switch is set to share
373	* the mac address of the host when hitting the wire. Currently rames containing
374	* ARP packets are subject to this, later other protocols like NDP/ICMPv6 may
375	* need editing as well when operating in this mode.
376	*
377	* @returns true if we've handled it and it should be dropped.
378	* false if it should hit the wire.
379	*
380	* @param pSwitchPort Pointer to this structure.
381	* @param pSG The (scatter /) gather structure for the frame.
382	* This will only be use during the call, so a temporary one can
383	* be used. The Phys member will not be used.
384	* @param fSrc Where this frame comes from. Only one bit should be set!
385	*
386	* @remarks Will grab the network semaphore.
387	*
388	* @remarks NAT and TAP will use this interface.
389	*
390	* @todo Do any of the host require notification before frame modifications? If so,
391	* we'll add a callback to INTNETTRUNKIFPORT for this (pfnSGModifying) and
392	* a SG flag.
393	*/
394	DECLR0CALLBACKMEMBER(bool, pfnRecv,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG, uint32_t fSrc));
395
396	/**
397	* Retain a SG.
398	*
399	* @param pSwitchPort Pointer to this structure.
400	* @param pSG Pointer to the (scatter /) gather structure.
401	*
402	* @remarks Will not grab any locks.
403	*/
404	DECLR0CALLBACKMEMBER(void, pfnSGRetain,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
405
406	/**
407	* Release a SG.
408	*
409	* This is called by the pfnXmit code when done with a SG. This may safe
410	* be done in an asynchronous manner.
411	*
412	* @param pSwitchPort Pointer to this structure.
413	* @param pSG Pointer to the (scatter /) gather structure.
414	*
415	* @remarks Will grab the network semaphore.
416	*/
417	DECLR0CALLBACKMEMBER(void, pfnSGRelease,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
418
419	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
420	uint32_t u32VersionEnd;
421	} INTNETTRUNKSWPORT;
422
423	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
424	#define INTNETTRUNKSWPORT_VERSION UINT32_C(0xA2CDf001)
425
426
427	/** Pointer to the interface side of a trunk port. */
428	typedef struct INTNETTRUNKIFPORT *PINTNETTRUNKIFPORT;
429	/**
430	* This is the port on the trunk interface, i.e. the driver
431	* side which the internal network is connected to.
432	*
433	* This is only used for the in-kernel trunk connections.
434	*
435	* @remarks The internal network side is responsible for serializing all calls
436	* to this interface. This is (assumed) to be implemented using a lock
437	* that is only ever taken before a call to this interface. The lock
438	* is referred to as the out-bound trunk port lock.
439	*/
440	typedef struct INTNETTRUNKIFPORT
441	{
442	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
443	uint32_t u32Version;
444
445	/**
446	* Retain the object.
447	*
448	* It will normally be called while owning the internal network semaphore.
449	*
450	* @param pIfPort Pointer to this structure.
451	*
452	* @remarks The caller may own any locks or none at all, we don't care.
453	*/
454	DECLR0CALLBACKMEMBER(void, pfnRetain,(PINTNETTRUNKIFPORT pIfPort));
455
456	/**
457	* Releases the object.
458	*
459	* This must be called for every pfnRetain call.
460	*
461	*
462	* @param pIfPort Pointer to this structure.
463	*
464	* @remarks Only the out-bound trunk port lock, unless the caller is certain the
465	* call is not going to cause destruction (wont happen).
466	*/
467	DECLR0CALLBACKMEMBER(void, pfnRelease,(PINTNETTRUNKIFPORT pIfPort));
468
469	/**
470	* Disconnect from the switch and release the object.
471	*
472	* The is the counter action of the
473	* INTNETTRUNKNETFLTFACTORY::pfnCreateAndConnect method.
474	*
475	* @param pIfPort Pointer to this structure.
476	*
477	* @remarks Called holding the out-bound trunk port lock.
478	*/
479	DECLR0CALLBACKMEMBER(void, pfnDisconnectAndRelease,(PINTNETTRUNKIFPORT pIfPort));
480
481	/**
482	* Changes the active state of the interface.
483	*
484	* The interface is created in the suspended (non-active) state and then activated
485	* when the VM/network is started. It may be suspended and re-activated later
486	* for various reasons. It will finally be suspended again before disconnecting
487	* the interface from the internal network, however, this might be done immediately
488	* before disconnecting and may leave an incoming frame waiting on the internal network
489	* semaphore. So, after the final suspend a pfnWaitForIdle is always called to make sure
490	* the interface is idle before pfnDisconnectAndRelease is called.
491	*
492	* A typical operation to performed by this method is to enable/disable promiscuous
493	* mode on the host network interface. (This is the reason we cannot call this when
494	* owning any semaphores.)
495	*
496	* @returns The previous state.
497	*
498	* @param pIfPort Pointer to this structure.
499	* @param fActive True if the new state is 'active', false if the new state is 'suspended'.
500	*
501	* @remarks Called holding the out-bound trunk port lock.
502	*/
503	DECLR0CALLBACKMEMBER(bool, pfnSetActive,(PINTNETTRUNKIFPORT pIfPort, bool fActive));
504
505	/**
506	* Waits for the interface to become idle.
507	*
508	* This method must be called before disconnecting and releasing the
509	* object in order to prevent racing incoming/outgoing packets and
510	* device enabling/disabling.
511	*
512	* @returns IPRT status code (see RTSemEventWait).
513	* @param pIfPort Pointer to this structure.
514	* @param cMillies The number of milliseconds to wait. 0 means
515	* no waiting at all. Use RT_INDEFINITE_WAIT for
516	* an indefinite wait.
517	*
518	* @remarks Called holding the out-bound trunk port lock.
519	*/
520	DECLR0CALLBACKMEMBER(int, pfnWaitForIdle,(PINTNETTRUNKIFPORT pIfPort, uint32_t cMillies));
521
522	/**
523	* Gets the MAC address of the host network interface that we're attached to.
524	*
525	* @param pIfPort Pointer to this structure.
526	* @param pMac Where to store the host MAC address.
527	*
528	* @remarks Called while owning the network and the out-bound trunk port semaphores.
529	*/
530	DECLR0CALLBACKMEMBER(void, pfnGetMacAddress,(PINTNETTRUNKIFPORT pIfPort, PRTMAC pMac));
531
532	/**
533	* Tests if the mac address belongs to any of the host NICs
534	* and should take the host route.
535	*
536	* @returns true / false.
537	*
538	* @param pIfPort Pointer to this structure.
539	* @param pMac Pointer to the mac address.
540	*
541	* @remarks Called while owning the network and the out-bound trunk port semaphores.
542	*
543	* @remarks TAP and NAT will compare with their own MAC address and let all their
544	* traffic take the host direction.
545	*
546	* @remarks This didn't quiet work out the way it should... perhaps obsolete this
547	* with pfnGetHostMac?
548	*/
549	DECLR0CALLBACKMEMBER(bool, pfnIsHostMac,(PINTNETTRUNKIFPORT pIfPort, PCRTMAC pMac));
550
551	/**
552	* Tests whether the host is operating the interface is promiscuous mode.
553	*
554	* The default behavior of the internal networking 'switch' is to 'autodetect'
555	* promiscuous mode on the trunk port, which is when this method is used.
556	* For security reasons this default may of course be overridden so that the
557	* host cannot sniff at what's going on.
558	*
559	* Note that this differs from operating the trunk port on the switch in
560	* 'promiscuous' mode, because that relates to the bits going to the wire.
561	*
562	* @returns true / false.
563	*
564	* @param pIfPort Pointer to this structure.
565	*
566	* @remarks Called while owning the network and the out-bound trunk port semaphores.
567	*/
568	DECLR0CALLBACKMEMBER(bool, pfnIsPromiscuous,(PINTNETTRUNKIFPORT pIfPort));
569
570	/**
571	* Transmit a frame.
572	*
573	* @return VBox status code. Error generally means we'll drop the packet.
574	* @param pIfPort Pointer to this structure.
575	* @param pSG Pointer to the (scatter /) gather structure for the frame.
576	* This may or may not be a temporary buffer. If it's temporary
577	* the transmit operation(s) then it's required to make a copy
578	* of the frame unless it can be transmitted synchronously.
579	* @param fDst The destination mask. At least one bit will be set.
580	*
581	* @remarks Called holding the out-bound trunk port lock.
582	*
583	* @remarks TAP and NAT will use this interface for all their traffic, see pfnIsHostMac.
584	*
585	* @todo
586	*/
587	DECLR0CALLBACKMEMBER(int, pfnXmit,(PINTNETTRUNKIFPORT pIfPort, PINTNETSG pSG, uint32_t fDst));
588
589	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
590	uint32_t u32VersionEnd;
591	} INTNETTRUNKIFPORT;
592
593	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
594	#define INTNETTRUNKIFPORT_VERSION UINT32_C(0xA2CDe001)
595
596
597	/**
598	* The component factory interface for create a network
599	* interface filter (like VBoxNetFlt).
600	*/
601	typedef struct INTNETTRUNKFACTORY
602	{
603	/**
604	* Release this factory.
605	*
606	* SUPR0ComponentQueryFactory (SUPDRVFACTORY::pfnQueryFactoryInterface to be precise)
607	* will retain a reference to the factory and the caller has to call this method to
608	* release it once the pfnCreateAndConnect call(s) has been done.
609	*
610	* @param pIfFactory Pointer to this structure.
611	*/
612	DECLR0CALLBACKMEMBER(void, pfnRelease,(struct INTNETTRUNKFACTORY *pIfFactory));
613
614	/**
615	* Create an instance for the specfied host interface and connects it
616	* to the internal network trunk port.
617	*
618	* The initial interface active state is false (suspended).
619	*
620	*
621	* @returns VBox status code.
622	* @retval VINF_SUCCESS and *ppIfPort set on success.
623	* @retval VERR_INTNET_FLT_IF_NOT_FOUND if the interface was not found.
624	* @retval VERR_INTNET_FLT_IF_BUSY if the interface is already connected.
625	* @retval VERR_INTNET_FLT_IF_FAILED if it failed for some other reason.
626	*
627	* @param pIfFactory Pointer to this structure.
628	* @param pszName The interface name (OS specific).
629	* @param pSwitchPort Pointer to the port interface on the switch that
630	* this interface is being connected to.
631	* @param fFlags Creation flags, see below.
632	* @param ppIfPort Where to store the pointer to the interface port
633	* on success.
634	*
635	* @remarks Called while owning the network and the out-bound trunk semaphores.
636	*/
637	DECLR0CALLBACKMEMBER(int, pfnCreateAndConnect,(struct INTNETTRUNKFACTORY pIfFactory, const char pszName,
638	PINTNETTRUNKSWPORT pSwitchPort, uint32_t fFlags,
639	PINTNETTRUNKIFPORT *ppIfPort));
640	} INTNETTRUNKFACTORY;
641	/** Pointer to the trunk factory. */
642	typedef INTNETTRUNKFACTORY *PINTNETTRUNKFACTORY;
643
644	/** The UUID for the (current) trunk factory. (case sensitive) */
645	#define INTNETTRUNKFACTORY_UUID_STR "449a2799-7564-464d-b4b2-7a877418fd0c"
646
647	/** @name INTNETTRUNKFACTORY::pfnCreateAndConnect flags.
648	* @{ */
649	/** Don't put the filtered interface in promiscuous mode.
650	* This is used for wireless interface since these can misbehave if
651	* we try to put them in promiscuous mode. (Wireless interfaces are
652	* normally bridged on level 3 instead of level 2.) */
653	#define INTNETTRUNKFACTORY_FLAG_NO_PROMISC RT_BIT_32(0)
654	/** @} */
655
656
657	/**
658	* The trunk connection type.
659	*
660	* Used by INTNETR0Open and assoicated interfaces.
661	*/
662	typedef enum INTNETTRUNKTYPE
663	{
664	/** Invalid trunk type. */
665	kIntNetTrunkType_Invalid = 0,
666	/** No trunk connection. */
667	kIntNetTrunkType_None,
668	/** We don't care which kind of trunk connection if the network exists,
669	* if it doesn't exist create it without a connection. */
670	kIntNetTrunkType_WhateverNone,
671	/** VirtualBox host network interface filter driver.
672	* The trunk name is the name of the host network interface. */
673	kIntNetTrunkType_NetFlt,
674	/** VirtualBox adapter host driver. */
675	kIntNetTrunkType_NetAdp,
676	/** Nat service (ring-0). */
677	kIntNetTrunkType_SrvNat,
678	/** The end of valid types. */
679	kIntNetTrunkType_End,
680	/** The usual 32-bit hack. */
681	kIntNetTrunkType_32bitHack = 0x7fffffff
682	} INTNETTRUNKTYPE;
683
684	/** @name INTNETR0Open flags.
685	* @{ */
686	/** Share the MAC address with the host when sending something to the wire via the trunk.
687	* This is typically used when the trunk is a NetFlt for a wireless interface. */
688	#define INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE RT_BIT_32(0)
689	/** Whether new participants should be subjected to access check or not. */
690	#define INTNET_OPEN_FLAGS_PUBLIC RT_BIT_32(1)
691	/** Ignore any requests for promiscuous mode. */
692	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC RT_BIT_32(2)
693	/** Ignore any requests for promiscuous mode, quietly applied/ignored on open. */
694	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC RT_BIT_32(3)
695	/** Ignore any requests for promiscuous mode on the trunk wire connection. */
696	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC_TRUNK_WIRE RT_BIT_32(4)
697	/** Ignore any requests for promiscuous mode on the trunk wire connection, quietly applied/ignored on open. */
698	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC_TRUNK_WIRE RT_BIT_32(5)
699	/** Ignore any requests for promiscuous mode on the trunk host connection. */
700	#define INTNET_OPEN_FLAGS_IGNORE_PROMISC_TRUNK_HOST RT_BIT_32(6)
701	/** Ignore any requests for promiscuous mode on the trunk host connection, quietly applied/ignored on open. */
702	#define INTNET_OPEN_FLAGS_QUIETLY_IGNORE_PROMISC_TRUNK_HOST RT_BIT_32(7)
703	/** The mask of flags which causes flag incompatibilities. */
704	#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))
705	/** The mask of flags is always ORed in, even on open. (the quiet stuff) */
706	#define INTNET_OPEN_FLAGS_SECURITY_OR_MASK (RT_BIT_32(3) \| RT_BIT_32(5) \| RT_BIT_32(7))
707	/** The mask of valid flags. */
708	#define INTNET_OPEN_FLAGS_MASK UINT32_C(0x000000ff)
709	/** @} */
710
711	/** The maximum length of a network name. */
712	#define INTNET_MAX_NETWORK_NAME 128
713
714	/** The maximum length of a trunk name. */
715	#define INTNET_MAX_TRUNK_NAME 64
716
717
718	/**
719	* Request buffer for INTNETR0OpenReq / VMMR0_DO_INTNET_OPEN.
720	* @see INTNETR0Open.
721	*/
722	typedef struct INTNETOPENREQ
723	{
724	/** The request header. */
725	SUPVMMR0REQHDR Hdr;
726	/** Alternative to passing the taking the session from the VM handle.
727	* Either use this member or use the VM handle, don't do both. */
728	PSUPDRVSESSION pSession;
729	/** The network name. (input) */
730	char szNetwork[INTNET_MAX_NETWORK_NAME];
731	/** What to connect to the trunk port. (input)
732	* This is specific to the trunk type below. */
733	char szTrunk[INTNET_MAX_TRUNK_NAME];
734	/** The type of trunk link (NAT, Filter, TAP, etc). (input) */
735	INTNETTRUNKTYPE enmTrunkType;
736	/** Flags, see INTNET_OPEN_FLAGS_. (input) /
737	uint32_t fFlags;
738	/** The size of the send buffer. (input) */
739	uint32_t cbSend;
740	/** The size of the receive buffer. (input) */
741	uint32_t cbRecv;
742	/** The handle to the network interface. (output) */
743	INTNETIFHANDLE hIf;
744	} INTNETOPENREQ;
745	/** Pointer to an INTNETR0OpenReq / VMMR0_DO_INTNET_OPEN request buffer. */
746	typedef INTNETOPENREQ *PINTNETOPENREQ;
747
748	INTNETR0DECL(int) INTNETR0OpenReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETOPENREQ pReq);
749
750
751	/**
752	* Request buffer for INTNETR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE.
753	* @see INTNETR0IfClose.
754	*/
755	typedef struct INTNETIFCLOSEREQ
756	{
757	/** The request header. */
758	SUPVMMR0REQHDR Hdr;
759	/** Alternative to passing the taking the session from the VM handle.
760	* Either use this member or use the VM handle, don't do both. */
761	PSUPDRVSESSION pSession;
762	/** The handle to the network interface. */
763	INTNETIFHANDLE hIf;
764	} INTNETIFCLOSEREQ;
765	/** Pointer to an INTNETR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE request buffer. */
766	typedef INTNETIFCLOSEREQ *PINTNETIFCLOSEREQ;
767
768	INTNETR0DECL(int) INTNETR0IfCloseReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFCLOSEREQ pReq);
769
770
771	/**
772	* Request buffer for INTNETR0IfGetRing3BufferReq / VMMR0_DO_INTNET_IF_GET_RING3_BUFFER.
773	* @see INTNETR0IfGetRing3Buffer.
774	*/
775	typedef struct INTNETIFGETRING3BUFFERREQ
776	{
777	/** The request header. */
778	SUPVMMR0REQHDR Hdr;
779	/** Alternative to passing the taking the session from the VM handle.
780	* Either use this member or use the VM handle, don't do both. */
781	PSUPDRVSESSION pSession;
782	/** Handle to the interface. */
783	INTNETIFHANDLE hIf;
784	/** The pointer to the ring3 buffer. (output) */
785	R3PTRTYPE(PINTNETBUF) pRing3Buf;
786	} INTNETIFGETRING3BUFFERREQ;
787	/** Pointer to an INTNETR0IfGetRing3BufferReq / VMMR0_DO_INTNET_IF_GET_RING3_BUFFER request buffer. */
788	typedef INTNETIFGETRING3BUFFERREQ *PINTNETIFGETRING3BUFFERREQ;
789
790	INTNETR0DECL(int) INTNETR0IfGetRing3BufferReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFGETRING3BUFFERREQ pReq);
791
792
793	/**
794	* Request buffer for INTNETR0IfSetPromiscuousModeReq / VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE.
795	* @see INTNETR0IfSetPromiscuousMode.
796	*/
797	typedef struct INTNETIFSETPROMISCUOUSMODEREQ
798	{
799	/** The request header. */
800	SUPVMMR0REQHDR Hdr;
801	/** Alternative to passing the taking the session from the VM handle.
802	* Either use this member or use the VM handle, don't do both. */
803	PSUPDRVSESSION pSession;
804	/** Handle to the interface. */
805	INTNETIFHANDLE hIf;
806	/** The new promiscuous mode. */
807	bool fPromiscuous;
808	} INTNETIFSETPROMISCUOUSMODEREQ;
809	/** Pointer to an INTNETR0IfSetPromiscuousModeReq / VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE request buffer. */
810	typedef INTNETIFSETPROMISCUOUSMODEREQ *PINTNETIFSETPROMISCUOUSMODEREQ;
811
812	INTNETR0DECL(int) INTNETR0IfSetPromiscuousModeReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETPROMISCUOUSMODEREQ pReq);
813
814
815	/**
816	* Request buffer for INTNETR0IfSetMacAddressReq / VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS.
817	* @see INTNETR0IfSetMacAddress.
818	*/
819	typedef struct INTNETIFSETMACADDRESSREQ
820	{
821	/** The request header. */
822	SUPVMMR0REQHDR Hdr;
823	/** Alternative to passing the taking the session from the VM handle.
824	* Either use this member or use the VM handle, don't do both. */
825	PSUPDRVSESSION pSession;
826	/** Handle to the interface. */
827	INTNETIFHANDLE hIf;
828	/** The new MAC address. */
829	RTMAC Mac;
830	} INTNETIFSETMACADDRESSREQ;
831	/** Pointer to an INTNETR0IfSetMacAddressReq / VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS request buffer. */
832	typedef INTNETIFSETMACADDRESSREQ *PINTNETIFSETMACADDRESSREQ;
833
834	INTNETR0DECL(int) INTNETR0IfSetMacAddressReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETMACADDRESSREQ pReq);
835
836
837	/**
838	* Request buffer for INTNETR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE.
839	* @see INTNETR0IfSetActive.
840	*/
841	typedef struct INTNETIFSETACTIVEREQ
842	{
843	/** The request header. */
844	SUPVMMR0REQHDR Hdr;
845	/** Alternative to passing the taking the session from the VM handle.
846	* Either use this member or use the VM handle, don't do both. */
847	PSUPDRVSESSION pSession;
848	/** Handle to the interface. */
849	INTNETIFHANDLE hIf;
850	/** The new state. */
851	bool fActive;
852	} INTNETIFSETACTIVEREQ;
853	/** Pointer to an INTNETR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE request buffer. */
854	typedef INTNETIFSETACTIVEREQ *PINTNETIFSETACTIVEREQ;
855
856	INTNETR0DECL(int) INTNETR0IfSetActiveReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSETACTIVEREQ pReq);
857
858
859	/**
860	* Request buffer for INTNETR0IfSendReq / VMMR0_DO_INTNET_IF_SEND.
861	* @see INTNETR0IfSend.
862	*/
863	typedef struct INTNETIFSENDREQ
864	{
865	/** The request header. */
866	SUPVMMR0REQHDR Hdr;
867	/** Alternative to passing the taking the session from the VM handle.
868	* Either use this member or use the VM handle, don't do both. */
869	PSUPDRVSESSION pSession;
870	/** Handle to the interface. */
871	INTNETIFHANDLE hIf;
872	} INTNETIFSENDREQ;
873	/** Pointer to an INTNETR0IfSend() argument package. */
874	typedef INTNETIFSENDREQ *PINTNETIFSENDREQ;
875
876	INTNETR0DECL(int) INTNETR0IfSendReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFSENDREQ pReq);
877
878
879	/**
880	* Request buffer for INTNETR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT.
881	* @see INTNETR0IfWait.
882	*/
883	typedef struct INTNETIFWAITREQ
884	{
885	/** The request header. */
886	SUPVMMR0REQHDR Hdr;
887	/** Alternative to passing the taking the session from the VM handle.
888	* Either use this member or use the VM handle, don't do both. */
889	PSUPDRVSESSION pSession;
890	/** Handle to the interface. */
891	INTNETIFHANDLE hIf;
892	/** The number of milliseconds to wait. */
893	uint32_t cMillies;
894	} INTNETIFWAITREQ;
895	/** Pointer to an INTNETR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT request buffer. */
896	typedef INTNETIFWAITREQ *PINTNETIFWAITREQ;
897
898	INTNETR0DECL(int) INTNETR0IfWaitReq(PINTNET pIntNet, PSUPDRVSESSION pSession, PINTNETIFWAITREQ pReq);
899
900
901	#if defined(IN_RING0) \|\| defined(IN_INTNET_TESTCASE)
902	/** @name
903	* @{
904	*/
905
906	/**
907	* Create an instance of the Ring-0 internal networking service.
908	*
909	* @returns VBox status code.
910	* @param ppIntNet Where to store the instance pointer.
911	*/
912	INTNETR0DECL(int) INTNETR0Create(PINTNET *ppIntNet);
913
914	/**
915	* Destroys an instance of the Ring-0 internal networking service.
916	*
917	* @param pIntNet Pointer to the instance data.
918	*/
919	INTNETR0DECL(void) INTNETR0Destroy(PINTNET pIntNet);
920
921	/**
922	* Opens a network interface and connects it to the specified network.
923	*
924	* @returns VBox status code.
925	* @param pIntNet The internal network instance.
926	* @param pSession The session handle.
927	* @param pszNetwork The network name.
928	* @param enmTrunkType The trunk type.
929	* @param pszTrunk The trunk name. Its meaning is specfic to the type.
930	* @param fFlags Flags, see INTNET_OPEN_FLAGS_*.
931	* @param fRestrictAccess Whether new participants should be subjected to access check or not.
932	* @param cbSend The send buffer size.
933	* @param cbRecv The receive buffer size.
934	* @param phIf Where to store the handle to the network interface.
935	*/
936	INTNETR0DECL(int) INTNETR0Open(PINTNET pIntNet, PSUPDRVSESSION pSession, const char *pszNetwork,
937	INTNETTRUNKTYPE enmTrunkType, const char *pszTrunk, uint32_t fFlags,
938	unsigned cbSend, unsigned cbRecv, PINTNETIFHANDLE phIf);
939
940	/**
941	* Close an interface.
942	*
943	* @returns VBox status code.
944	* @param pIntNet The instance handle.
945	* @param hIf The interface handle.
946	* @param pSession The caller's session.
947	*/
948	INTNETR0DECL(int) INTNETR0IfClose(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
949
950	/**
951	* Gets the ring-0 address of the current buffer.
952	*
953	* @returns VBox status code.
954	* @param pIntNet The instance data.
955	* @param hIf The interface handle.
956	* @param pSession The caller's session.
957	* @param ppRing0Buf Where to store the address of the ring-3 mapping.
958	*/
959	INTNETR0DECL(int) INTNETR0IfGetRing0Buffer(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, PINTNETBUF *ppRing0Buf);
960
961	/**
962	* Maps the default buffer into ring 3.
963	*
964	* @returns VBox status code.
965	* @param pIntNet The instance data.
966	* @param hIf The interface handle.
967	* @param pSession The caller's session.
968	* @param ppRing3Buf Where to store the address of the ring-3 mapping.
969	*/
970	INTNETR0DECL(int) INTNETR0IfGetRing3Buffer(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, R3PTRTYPE(PINTNETBUF) *ppRing3Buf);
971
972	/**
973	* Sets the promiscuous mode property of an interface.
974	*
975	* @returns VBox status code.
976	* @param pIntNet The instance handle.
977	* @param hIf The interface handle.
978	* @param pSession The caller's session.
979	* @param fPromiscuous Set if the interface should be in promiscuous mode, clear if not.
980	*/
981	INTNETR0DECL(int) INTNETR0IfSetPromiscuousMode( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fPromiscuous);
982	INTNETR0DECL(int) INTNETR0IfSetMacAddress( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, PCRTMAC pMac);
983	INTNETR0DECL(int) INTNETR0IfSetActive( PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fActive);
984
985	/**
986	* Sends one or more frames.
987	*
988	* The function will first the frame which is passed as the optional
989	* arguments pvFrame and cbFrame. These are optional since it also
990	* possible to chain together one or more frames in the send buffer
991	* which the function will process after considering it's arguments.
992	*
993	* @returns VBox status code.
994	* @param pIntNet The instance data.
995	* @param hIf The interface handle.
996	* @param pSession The caller's session.
997	* @param pvFrame Pointer to the frame. Optional, please don't use.
998	* @param cbFrame Size of the frame. Optional, please don't use.
999	*/
1000	INTNETR0DECL(int) INTNETR0IfSend(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, const void *pvFrame, unsigned cbFrame);
1001
1002	/**
1003	* Wait for the interface to get signaled.
1004	* The interface will be signaled when is put into the receive buffer.
1005	*
1006	* @returns VBox status code.
1007	* @param pIntNet The instance handle.
1008	* @param hIf The interface handle.
1009	* @param pSession The caller's session.
1010	* @param cMillies Number of milliseconds to wait. RT_INDEFINITE_WAIT should be
1011	* used if indefinite wait is desired.
1012	*/
1013	INTNETR0DECL(int) INTNETR0IfWait(PINTNET pIntNet, INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, uint32_t cMillies);
1014
1015	/** @} */
1016	#endif /* IN_RING0 */
1017
1018	RT_C_DECLS_END
1019
1020	#endif

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

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

Download in other formats: