intnet.h@ 52394

Last change on this file since 52394 was 52394, checked in by vboxsync, 10 years ago
intnetR0TrunkIfPortDisconnect: Must always release the busy reference to the interface side (netflt) and must not trust pThis->pIfPort to be working as it's cleared before doing the busy waiting in intnetR0TrunkIfDestroy. So, pfnDisconnect has been extended with a pIfPort pointer as well as a function pointer to a busy-release function for pIfPort.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 50.7 KB

Line
1	/** @file
2	* INTNET - Internal Networking. (DEV,++)
3	*/
4
5	/*
6	* Copyright (C) 2006-2011 Oracle Corporation
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
26	#ifndef ___VBox_intnet_h
27	#define ___VBox_intnet_h
28
29	#include <VBox/types.h>
30	#include <VBox/vmm/stam.h>
31	#include <VBox/sup.h>
32	#include <iprt/assert.h>
33	#include <iprt/asm.h>
34
35	RT_C_DECLS_BEGIN
36
37
38	/**
39	* Generic two-sided ring buffer.
40	*
41	* The deal is that there is exactly one writer and one reader.
42	* When offRead equals offWrite the buffer is empty. In the other
43	* extreme the writer will not use the last free byte in the buffer.
44	*/
45	typedef struct INTNETRINGBUF
46	{
47	/** The offset from this structure to the start of the buffer. */
48	uint32_t offStart;
49	/** The offset from this structure to the end of the buffer. (exclusive). */
50	uint32_t offEnd;
51	/** The current read offset. */
52	uint32_t volatile offReadX;
53	/** Alignment. */
54	uint32_t u32Align0;
55
56	/** The committed write offset. */
57	uint32_t volatile offWriteCom;
58	/** Writer internal current write offset.
59	* This is ahead of offWriteCom when buffer space is handed to a third party for
60	* data gathering. offWriteCom will be assigned this value by the writer then
61	* the frame is ready. */
62	uint32_t volatile offWriteInt;
63	/** The number of bytes written (not counting overflows). */
64	STAMCOUNTER cbStatWritten;
65	/** The number of frames written (not counting overflows). */
66	STAMCOUNTER cStatFrames;
67	/** The number of overflows. */
68	STAMCOUNTER cOverflows;
69	} INTNETRINGBUF;
70	AssertCompileSize(INTNETRINGBUF, 48);
71	/** Pointer to a ring buffer. */
72	typedef INTNETRINGBUF *PINTNETRINGBUF;
73
74	/** The alignment of a ring buffer. */
75	#define INTNETRINGBUF_ALIGNMENT sizeof(INTNETHDR)
76
77	/**
78	* Asserts the sanity of the specified INTNETRINGBUF structure.
79	*/
80	#ifdef VBOX_STRICT
81	# define INTNETRINGBUF_ASSERT_SANITY(pRingBuf) \
82	do \
83	{ \
84	AssertPtr(pRingBuf); \
85	{ \
86	uint32_t const offWriteCom = (pRingBuf)->offWriteCom; \
87	uint32_t const offRead = (pRingBuf)->offReadX; \
88	uint32_t const offWriteInt = (pRingBuf)->offWriteInt; \
89	\
90	AssertMsg(offWriteCom == RT_ALIGN_32(offWriteCom, INTNETHDR_ALIGNMENT), ("%#x\n", offWriteCom)); \
91	AssertMsg(offWriteCom >= (pRingBuf)->offStart, ("%#x %#x\n", offWriteCom, (pRingBuf)->offStart)); \
92	AssertMsg(offWriteCom < (pRingBuf)->offEnd, ("%#x %#x\n", offWriteCom, (pRingBuf)->offEnd)); \
93	\
94	AssertMsg(offRead == RT_ALIGN_32(offRead, INTNETHDR_ALIGNMENT), ("%#x\n", offRead)); \
95	AssertMsg(offRead >= (pRingBuf)->offStart, ("%#x %#x\n", offRead, (pRingBuf)->offStart)); \
96	AssertMsg(offRead < (pRingBuf)->offEnd, ("%#x %#x\n", offRead, (pRingBuf)->offEnd)); \
97	\
98	AssertMsg(offWriteInt == RT_ALIGN_32(offWriteInt, INTNETHDR_ALIGNMENT), ("%#x\n", offWriteInt)); \
99	AssertMsg(offWriteInt >= (pRingBuf)->offStart, ("%#x %#x\n", offWriteInt, (pRingBuf)->offStart)); \
100	AssertMsg(offWriteInt < (pRingBuf)->offEnd, ("%#x %#x\n", offWriteInt, (pRingBuf)->offEnd)); \
101	AssertMsg( offRead <= offWriteCom \
102	? offWriteCom <= offWriteInt \|\| offWriteInt < offRead \
103	: offWriteCom <= offWriteInt, \
104	("W=%#x W'=%#x R=%#x\n", offWriteCom, offWriteInt, offRead)); \
105	} \
106	} while (0)
107	#else
108	# define INTNETRINGBUF_ASSERT_SANITY(pRingBuf) do { } while (0)
109	#endif
110
111
112
113	/**
114	* A interface buffer.
115	*/
116	typedef struct INTNETBUF
117	{
118	/** Magic number (INTNETBUF_MAGIC). */
119	uint32_t u32Magic;
120	/** The size of the entire buffer. */
121	uint32_t cbBuf;
122	/** The size of the send area. */
123	uint32_t cbSend;
124	/** The size of the receive area. */
125	uint32_t cbRecv;
126	/** The receive buffer. */
127	INTNETRINGBUF Recv;
128	/** The send buffer. */
129	INTNETRINGBUF Send;
130	/** Number of times yields help solve an overflow. */
131	STAMCOUNTER cStatYieldsOk;
132	/** Number of times yields didn't help solve an overflow. */
133	STAMCOUNTER cStatYieldsNok;
134	/** Number of lost packets due to overflows. */
135	STAMCOUNTER cStatLost;
136	/** Number of bad frames (both rings). */
137	STAMCOUNTER cStatBadFrames;
138	/** Reserved for future use. */
139	STAMCOUNTER aStatReserved[2];
140	/** Reserved for future send profiling. */
141	STAMPROFILE StatSend1;
142	/** Reserved for future send profiling. */
143	STAMPROFILE StatSend2;
144	/** Reserved for future receive profiling. */
145	STAMPROFILE StatRecv1;
146	/** Reserved for future receive profiling. */
147	STAMPROFILE StatRecv2;
148	/** Reserved for future profiling. */
149	STAMPROFILE StatReserved;
150	} INTNETBUF;
151	AssertCompileSize(INTNETBUF, 320);
152	AssertCompileMemberOffset(INTNETBUF, Recv, 16);
153	AssertCompileMemberOffset(INTNETBUF, Send, 64);
154
155	/** Pointer to an interface buffer. */
156	typedef INTNETBUF *PINTNETBUF;
157	/** Pointer to a const interface buffer. */
158	typedef INTNETBUF const *PCINTNETBUF;
159
160	/** Magic number for INTNETBUF::u32Magic (Sir William Gerald Golding). */
161	#define INTNETBUF_MAGIC UINT32_C(0x19110919)
162
163	/**
164	* Asserts the sanity of the specified INTNETBUF structure.
165	*/
166	#define INTNETBUF_ASSERT_SANITY(pBuf) \
167	do \
168	{ \
169	AssertPtr(pBuf); \
170	Assert((pBuf)->u32Magic == INTNETBUF_MAGIC); \
171	{ \
172	uint32_t const offRecvStart = (pBuf)->Recv.offStart + RT_OFFSETOF(INTNETBUF, Recv); \
173	uint32_t const offRecvEnd = (pBuf)->Recv.offStart + RT_OFFSETOF(INTNETBUF, Recv); \
174	uint32_t const offSendStart = (pBuf)->Send.offStart + RT_OFFSETOF(INTNETBUF, Send); \
175	uint32_t const offSendEnd = (pBuf)->Send.offStart + RT_OFFSETOF(INTNETBUF, Send); \
176	\
177	Assert(offRecvEnd > offRecvStart); \
178	Assert(offRecvEnd - offRecvStart == (pBuf)->cbRecv); \
179	Assert(offRecvStart == sizeof(INTNETBUF)); \
180	\
181	Assert(offSendEnd > offSendStart); \
182	Assert(offSendEnd - offSendStart == (pBuf)->cbSend); \
183	Assert(pffSendEnd <= (pBuf)->cbBuf); \
184	\
185	Assert(offSendStart == offRecvEnd); \
186	} \
187	} while (0)
188
189
190	/** Internal networking interface handle. */
191	typedef uint32_t INTNETIFHANDLE;
192	/** Pointer to an internal networking interface handle. */
193	typedef INTNETIFHANDLE *PINTNETIFHANDLE;
194
195	/** Or mask to obscure the handle index. */
196	#define INTNET_HANDLE_MAGIC 0x88880000
197	/** Mask to extract the handle index. */
198	#define INTNET_HANDLE_INDEX_MASK 0xffff
199	/** The maximum number of handles (exclusive) */
200	#define INTNET_HANDLE_MAX 0xffff
201	/** Invalid handle. */
202	#define INTNET_HANDLE_INVALID (0)
203
204
205	/**
206	* The frame header.
207	*
208	* The header is intentionally 8 bytes long. It will always
209	* start at an 8 byte aligned address. Assuming that the buffer
210	* size is a multiple of 8 bytes, that means that we can guarantee
211	* that the entire header is contiguous in both virtual and physical
212	* memory.
213	*/
214	typedef struct INTNETHDR
215	{
216	/** The size of the frame. */
217	uint32_t cbFrame : 24;
218	/** Header type. This is currently serving as a magic, it
219	* can be extended later to encode special command frames and stuff. */
220	uint32_t u8Type : 8;
221	/** The offset from the start of this header to where the actual frame starts.
222	* This is used to keep the frame it self contiguous in virtual memory and
223	* thereby both simplify access as well as the descriptor. */
224	int32_t offFrame;
225	} INTNETHDR;
226	AssertCompileSize(INTNETHDR, 8);
227	AssertCompileSizeAlignment(INTNETBUF, sizeof(INTNETHDR));
228	/** Pointer to a frame header.*/
229	typedef INTNETHDR *PINTNETHDR;
230	/** Pointer to a const frame header.*/
231	typedef INTNETHDR const *PCINTNETHDR;
232
233	/** The alignment of a frame header. */
234	#define INTNETHDR_ALIGNMENT sizeof(INTNETHDR)
235	AssertCompile(sizeof(INTNETHDR) == INTNETHDR_ALIGNMENT);
236	AssertCompile(INTNETHDR_ALIGNMENT <= INTNETRINGBUF_ALIGNMENT);
237
238	/** @name Frame types (INTNETHDR::u8Type).
239	* @{ */
240	/** Normal frames. */
241	#define INTNETHDR_TYPE_FRAME 0x42
242	/** Padding frames. */
243	#define INTNETHDR_TYPE_PADDING 0x53
244	/** Generic segment offload frames.
245	* The frame starts with a PDMNETWORKGSO structure which is followed by the
246	* header template and data. */
247	#define INTNETHDR_TYPE_GSO 0x64
248	AssertCompileSize(PDMNETWORKGSO, 8);
249	/** @} */
250
251	/**
252	* Asserts the sanity of the specified INTNETHDR.
253	*/
254	#ifdef VBOX_STRICT
255	#define INTNETHDR_ASSERT_SANITY(pHdr, pRingBuf) \
256	do \
257	{ \
258	AssertPtr(pHdr); \
259	Assert(RT_ALIGN_PT(pHdr, INTNETHDR_ALIGNMENT, INTNETHDR *) == pHdr); \
260	Assert( (pHdr)->u8Type == INTNETHDR_TYPE_FRAME \
261	\|\| (pHdr)->u8Type == INTNETHDR_TYPE_GSO \
262	\|\| (pHdr)->u8Type == INTNETHDR_TYPE_PADDING); \
263	{ \
264	uintptr_t const offHdr = (uintptr_t)pHdr - (uintptr_t)pRingBuf; \
265	uintptr_t const offFrame = offHdr + (pHdr)->offFrame; \
266	\
267	Assert(offHdr >= (pRingBuf)->offStart); \
268	Assert(offHdr < (pRingBuf)->offEnd); \
269	\
270	/* could do more thorough work here... later, perhaps. */ \
271	Assert(offFrame >= (pRingBuf)->offStart); \
272	Assert(offFrame < (pRingBuf)->offEnd); \
273	} \
274	} while (0)
275	#else
276	# define INTNETHDR_ASSERT_SANITY(pHdr, pRingBuf) do { } while (0)
277	#endif
278
279
280	/**
281	* Scatter / Gather segment (internal networking).
282	*/
283	typedef struct INTNETSEG
284	{
285	/** The physical address. NIL_RTHCPHYS is not set. */
286	RTHCPHYS Phys;
287	/** Pointer to the segment data. */
288	void *pv;
289	/** The segment size. */
290	uint32_t cb;
291	} INTNETSEG;
292	/** Pointer to a internal networking frame segment. */
293	typedef INTNETSEG *PINTNETSEG;
294	/** Pointer to a internal networking frame segment. */
295	typedef INTNETSEG const *PCINTNETSEG;
296
297
298	/**
299	* Scatter / Gather list (internal networking).
300	*
301	* This is used when communicating with the trunk port.
302	*/
303	typedef struct INTNETSG
304	{
305	/** Owner data, don't touch! */
306	void *pvOwnerData;
307	/** User data. */
308	void *pvUserData;
309	/** User data 2 in case anyone needs it. */
310	void *pvUserData2;
311	/** GSO context information, set the type to invalid if not relevant. */
312	PDMNETWORKGSO GsoCtx;
313	/** The total length of the scatter gather list. */
314	uint32_t cbTotal;
315	/** The number of users (references).
316	* This is used by the SGRelease code to decide when it can be freed. */
317	uint16_t volatile cUsers;
318	/** Flags, see INTNETSG_FLAGS_* */
319	uint16_t volatile fFlags;
320	#if ARCH_BITS == 64
321	/** Alignment padding. */
322	uint16_t uPadding;
323	#endif
324	/** The number of segments allocated. */
325	uint16_t cSegsAlloc;
326	/** The number of segments actually used. */
327	uint16_t cSegsUsed;
328	/** Variable sized list of segments. */
329	INTNETSEG aSegs[1];
330	} INTNETSG;
331	AssertCompileSizeAlignment(INTNETSG, 8);
332	/** Pointer to a scatter / gather list. */
333	typedef INTNETSG *PINTNETSG;
334	/** Pointer to a const scatter / gather list. */
335	typedef INTNETSG const *PCINTNETSG;
336
337	/** @name INTNETSG::fFlags definitions.
338	* @{ */
339	/** Set if the SG is free. */
340	#define INTNETSG_FLAGS_FREE RT_BIT_32(1)
341	/** Set if the SG is a temporary one that will become invalid upon return.
342	* Try to finish using it before returning, and if that's not possible copy
343	* to other buffers.
344	* When not set, the callee should always free the SG.
345	* Attempts to free it made by the callee will be quietly ignored. */
346	#define INTNETSG_FLAGS_TEMP RT_BIT_32(2)
347	/** ARP packet, IPv4 + MAC.
348	* @internal */
349	#define INTNETSG_FLAGS_ARP_IPV4 RT_BIT_32(3)
350	/** Copied to the temporary buffer.
351	* @internal */
352	#define INTNETSG_FLAGS_PKT_CP_IN_TMP RT_BIT_32(4)
353	/** @} */
354
355
356	/** @name Direction (frame source or destination)
357	* @{ */
358	/** To/From the wire. */
359	#define INTNETTRUNKDIR_WIRE RT_BIT_32(0)
360	/** To/From the host. */
361	#define INTNETTRUNKDIR_HOST RT_BIT_32(1)
362	/** Mask of valid bits. */
363	#define INTNETTRUNKDIR_VALID_MASK UINT32_C(3)
364	/** @} */
365
366	/**
367	* Switch decisions returned by INTNETTRUNKSWPORT::pfnPreRecv.
368	*/
369	typedef enum INTNETSWDECISION
370	{
371	/** The usual invalid zero value. */
372	INTNETSWDECISION_INVALID = 0,
373	/** Everywhere. */
374	INTNETSWDECISION_BROADCAST,
375	/** Only to the internal network. */
376	INTNETSWDECISION_INTNET,
377	/** Only for the trunk (host/wire). */
378	INTNETSWDECISION_TRUNK,
379	/** Used internally to indicate that the packet cannot be handled in the
380	* current context. */
381	INTNETSWDECISION_BAD_CONTEXT,
382	/** Used internally to indicate that the packet should be dropped. */
383	INTNETSWDECISION_DROP,
384	/** The usual 32-bit type expansion. */
385	INTNETSWDECISION_32BIT_HACK = 0x7fffffff
386	} INTNETSWDECISION;
387
388
389	/** Pointer to the interface side of a trunk port. */
390	typedef struct INTNETTRUNKIFPORT *PINTNETTRUNKIFPORT;
391
392
393	/**
394	* Special variation of INTNETTRUNKIFPORT::pfnRelease for use with
395	* INTNETTRUNKSWPORT::pfnDisconnect.
396	*
397	* @param pIfPort Pointer to the INTNETTRUNKIFPORT instance.
398	*/
399	typedef DECLCALLBACK(void) FNINTNETTRUNKIFPORTRELEASEBUSY(PINTNETTRUNKIFPORT pIfPort);
400	/** Pointer to a FNINTNETTRUNKIFPORTRELEASEBUSY function. */
401	typedef FNINTNETTRUNKIFPORTRELEASEBUSY *PFNINTNETTRUNKIFPORTRELEASEBUSY;
402
403
404	/** Pointer to the switch side of a trunk port. */
405	typedef struct INTNETTRUNKSWPORT *PINTNETTRUNKSWPORT;
406	/**
407	* This is the port on the internal network 'switch', i.e.
408	* what the driver is connected to.
409	*
410	* This is only used for the in-kernel trunk connections.
411	*/
412	typedef struct INTNETTRUNKSWPORT
413	{
414	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
415	uint32_t u32Version;
416
417	/**
418	* Examine the packet and figure out where it is going.
419	*
420	* This method is for making packet switching decisions in contexts where
421	* pfnRecv cannot be called or is no longer applicable. This method can be
422	* called from any context.
423	*
424	* @returns INTNETSWDECISION_BROADCAST, INTNETSWDECISION_INTNET or
425	* INTNETSWDECISION_TRUNK. The source is excluded from broadcast &
426	* trunk, of course.
427	*
428	* @param pSwitchPort Pointer to this structure.
429	* @param pvHdrs Pointer to the packet headers.
430	* @param cbHdrs Size of the packet headers. This must be at least 6
431	* bytes (the destination MAC address), but should if
432	* possible also include any VLAN tag and network
433	* layer header (wireless mac address sharing).
434	* @param fSrc Where this frame comes from. Only one bit should be
435	* set!
436	*
437	* @remarks Will only grab the switch table spinlock (interrupt safe). May
438	* signal an event semaphore iff we're racing network cleanup. The
439	* caller must be busy when calling.
440	*/
441	DECLR0CALLBACKMEMBER(INTNETSWDECISION, pfnPreRecv,(PINTNETTRUNKSWPORT pSwitchPort,
442	void const *pvHdrs, size_t cbHdrs, uint32_t fSrc));
443
444	/**
445	* Incoming frame.
446	*
447	* The frame may be modified when the trunk port on the switch is set to share
448	* the mac address of the host when hitting the wire. Currently frames
449	* containing ARP packets are subject to this, later other protocols like
450	* NDP/ICMPv6 may need editing as well when operating in this mode. The edited
451	* packet should be forwarded to the host/wire when @c false is returned.
452	*
453	* @returns true if we've handled it and it should be dropped.
454	* false if it should hit the wire/host.
455	*
456	* @param pSwitchPort Pointer to this structure.
457	* @param pvIf Pointer to the interface which received this frame
458	* if available. Can be NULL.
459	* @param pSG The (scatter /) gather structure for the frame. This
460	* will only be use during the call, so a temporary one can
461	* be used. The Phys member will not be used.
462	* @param fSrc Where this frame comes from. Exactly one bit shall be
463	* set!
464	*
465	* @remarks Will only grab the switch table spinlock (interrupt safe). Will
466	* signal event semaphores. The caller must be busy when calling.
467	*
468	* @remarks NAT and TAP will use this interface.
469	*
470	* @todo Do any of the host require notification before frame modifications?
471	* If so, we'll add a callback to INTNETTRUNKIFPORT for this
472	* (pfnSGModifying) and a SG flag.
473	*/
474	DECLR0CALLBACKMEMBER(bool, pfnRecv,(PINTNETTRUNKSWPORT pSwitchPort, void *pvIf, PINTNETSG pSG, uint32_t fSrc));
475
476	/**
477	* Retain a SG.
478	*
479	* @param pSwitchPort Pointer to this structure.
480	* @param pSG Pointer to the (scatter /) gather structure.
481	*
482	* @remarks Will not grab any locks. The caller must be busy when calling.
483	*/
484	DECLR0CALLBACKMEMBER(void, pfnSGRetain,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
485
486	/**
487	* Release a SG.
488	*
489	* This is called by the pfnXmit code when done with a SG. This may safe
490	* be done in an asynchronous manner.
491	*
492	* @param pSwitchPort Pointer to this structure.
493	* @param pSG Pointer to the (scatter /) gather structure.
494	*
495	* @remarks May signal an event semaphore later on, currently code won't though.
496	* The caller is busy when making this call.
497	*/
498	DECLR0CALLBACKMEMBER(void, pfnSGRelease,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETSG pSG));
499
500	/**
501	* Selects whether outgoing SGs should have their physical address set.
502	*
503	* By enabling physical addresses in the scatter / gather segments it should
504	* be possible to save some unnecessary address translation and memory locking
505	* in the network stack. (Internal networking knows the physical address for
506	* all the INTNETBUF data and that it's locked memory.) There is a negative
507	* side effects though, frames that crosses page boundaries will require
508	* multiple scather / gather segments.
509	*
510	* @returns The old setting.
511	*
512	* @param pSwitchPort Pointer to this structure.
513	* @param fEnable Whether to enable or disable it.
514	*
515	* @remarks Will not grab any locks. The caller must be busy when calling.
516	*/
517	DECLR0CALLBACKMEMBER(bool, pfnSetSGPhys,(PINTNETTRUNKSWPORT pSwitchPort, bool fEnable));
518
519	/**
520	* Reports the MAC address of the trunk.
521	*
522	* This is supposed to be called when creating, connection or reconnecting the
523	* trunk and when the MAC address is changed by the system admin.
524	*
525	* @param pSwitchPort Pointer to this structure.
526	* @param pMacAddr The MAC address.
527	*
528	* @remarks May take a spinlock or two. The caller must be busy when calling.
529	*/
530	DECLR0CALLBACKMEMBER(void, pfnReportMacAddress,(PINTNETTRUNKSWPORT pSwitchPort, PCRTMAC pMacAddr));
531
532	/**
533	* Reports the promicuousness of the interface.
534	*
535	* This is supposed to be called when creating, connection or reconnecting the
536	* trunk and when the mode is changed by the system admin.
537	*
538	* @param pSwitchPort Pointer to this structure.
539	* @param fPromiscuous True if the host operates the interface in
540	* promiscuous mode, false if not.
541	*
542	* @remarks May take a spinlock or two. The caller must be busy when calling.
543	*/
544	DECLR0CALLBACKMEMBER(void, pfnReportPromiscuousMode,(PINTNETTRUNKSWPORT pSwitchPort, bool fPromiscuous));
545
546	/**
547	* Reports the GSO capabilities of the host, wire or both.
548	*
549	* This is supposed to be used only when creating, connecting or reconnecting
550	* the trunk. It is assumed that the GSO capabilities are kind of static the
551	* rest of the time.
552	*
553	* @param pSwitchPort Pointer to this structure.
554	* @param fGsoCapabilities The GSO capability bit mask. The bits
555	* corresponds to the GSO type with the same value.
556	* @param fDst The destination mask (INTNETTRUNKDIR_XXX).
557	*
558	* @remarks Does not take any locks. The caller must be busy when calling.
559	*/
560	DECLR0CALLBACKMEMBER(void, pfnReportGsoCapabilities,(PINTNETTRUNKSWPORT pSwitchPort, uint32_t fGsoCapabilities, uint32_t fDst));
561
562	/**
563	* Reports the no-preemption-xmit capabilities of the host and wire.
564	*
565	* This is supposed to be used only when creating, connecting or reconnecting
566	* the trunk. It is assumed that the GSO capabilities are kind of static the
567	* rest of the time.
568	*
569	* @param pSwitchPort Pointer to this structure.
570	* @param fNoPreemptDsts The destinations (INTNETTRUNKDIR_XXX) which it
571	* is safe to transmit to with preemption disabled.
572	* @param fDst The destination mask (INTNETTRUNKDIR_XXX).
573	*
574	* @remarks Does not take any locks. The caller must be busy when calling.
575	*/
576	DECLR0CALLBACKMEMBER(void, pfnReportNoPreemptDsts,(PINTNETTRUNKSWPORT pSwitchPort, uint32_t fNoPreemptDsts));
577
578	#ifdef VBOX_WITH_INTNET_DISCONNECT
579	/**
580	* OS triggered trunk disconnect.
581	*
582	* The caller shall must be busy when calling this method to prevent racing the
583	* network destruction code. This method will always consume this busy reference
584	* (released via @a pfnReleaseBusy using @a pIfPort).
585	*
586	* The caller shall guarantee that there are absolutely no chance of concurrent
587	* calls to this method on the same instance.
588	*
589	* @param pSwitchPort Pointer to this structure.
590	* @param pIfPort The interface port structure corresponding to @a
591	* pSwitchPort and which should be used when
592	* calling @a pfnReleaseBusy. This is required as
593	* the method may no longer have access to a valid
594	* @a pIfPort pointer.
595	* @param pfnReleaseBusy Callback for releasing the callers busy
596	* reference to it's side of things.
597	*/
598	DECLR0CALLBACKMEMBER(void, pfnDisconnect,(PINTNETTRUNKSWPORT pSwitchPort, PINTNETTRUNKIFPORT pIfPort,
599	PFNINTNETTRUNKIFPORTRELEASEBUSY pfnReleaseBusy));
600	#endif /* VBOX_WITH_INTNET_DISCONNECT */
601
602	/** Structure version number. (INTNETTRUNKSWPORT_VERSION) */
603	uint32_t u32VersionEnd;
604	} INTNETTRUNKSWPORT;
605
606	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
607	#ifdef VBOX_WITH_INTNET_DISCONNECT
608	# define INTNETTRUNKSWPORT_VERSION UINT32_C(0xA2CDf003)
609	#else
610	# define INTNETTRUNKSWPORT_VERSION UINT32_C(0xA2CDf001)
611	#endif
612
613
614	/**
615	* The trunk interface state used set by INTNETTRUNKIFPORT::pfnSetState.
616	*/
617	typedef enum INTNETTRUNKIFSTATE
618	{
619	/** The invalid zero entry. */
620	INTNETTRUNKIFSTATE_INVALID = 0,
621	/** The trunk is inactive. No calls to INTNETTRUNKSWPORT::pfnRecv or
622	* INTNETTRUNKSWPORT::pfnPreRecv. Calling other methods is OK. */
623	INTNETTRUNKIFSTATE_INACTIVE,
624	/** The trunk is active, no restrictions on methods or anything. */
625	INTNETTRUNKIFSTATE_ACTIVE,
626	/** The trunk is about to be disconnected from the internal network. No
627	* calls to any INTNETRUNKSWPORT methods. */
628	INTNETTRUNKIFSTATE_DISCONNECTING,
629	/** The end of the valid states. */
630	INTNETTRUNKIFSTATE_END,
631	/** The usual 32-bit type blow up hack. */
632	INTNETTRUNKIFSTATE_32BIT_HACK = 0x7fffffff
633	} INTNETTRUNKIFSTATE;
634
635
636	/**
637	* This is the port on the trunk interface, i.e. the driver side which the
638	* internal network is connected to.
639	*
640	* This is only used for the in-kernel trunk connections.
641	*/
642	typedef struct INTNETTRUNKIFPORT
643	{
644	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
645	uint32_t u32Version;
646
647	/**
648	* Retain the object.
649	*
650	* It will normally be called while owning the internal network semaphore.
651	*
652	* @param pIfPort Pointer to this structure.
653	*
654	* @remarks May own the big mutex, no spinlocks.
655	*/
656	DECLR0CALLBACKMEMBER(void, pfnRetain,(PINTNETTRUNKIFPORT pIfPort));
657
658	/**
659	* Releases the object.
660	*
661	* This must be called for every pfnRetain call.
662	*
663	* @param pIfPort Pointer to this structure.
664	*
665	* @remarks May own the big mutex, no spinlocks.
666	*/
667	DECLR0CALLBACKMEMBER(void, pfnRelease,(PINTNETTRUNKIFPORT pIfPort));
668
669	/**
670	* Disconnect from the switch and release the object.
671	*
672	* The is the counter action of the
673	* INTNETTRUNKNETFLTFACTORY::pfnCreateAndConnect method.
674	*
675	* @param pIfPort Pointer to this structure.
676	*
677	* @remarks Owns the big mutex.
678	*/
679	DECLR0CALLBACKMEMBER(void, pfnDisconnectAndRelease,(PINTNETTRUNKIFPORT pIfPort));
680
681	/**
682	* Changes the state of the trunk interface.
683	*
684	* The interface is created in the inactive state (INTNETTRUNKIFSTATE_INACTIVE).
685	* When the first connect VM or service is activated, the internal network
686	* activates the trunk (INTNETTRUNKIFSTATE_ACTIVE). The state may then be set
687	* back and forth between INACTIVE and ACTIVE as VMs are paused, added and
688	* removed.
689	*
690	* Eventually though, the network is destroyed as a result of there being no
691	* more VMs left in it and the state is changed to disconnecting
692	* (INTNETTRUNKIFSTATE_DISCONNECTING) and pfnWaitForIdle is called to make sure
693	* there are no active calls in either direction when pfnDisconnectAndRelease is
694	* called.
695	*
696	* A typical operation to performed by this method is to enable/disable promiscuous
697	* mode on the host network interface when entering/leaving the active state.
698	*
699	* @returns The previous state.
700	*
701	* @param pIfPort Pointer to this structure.
702	* @param enmState The new state.
703	*
704	* @remarks Owns the big mutex. No racing pfnSetState, pfnWaitForIdle,
705	* pfnDisconnectAndRelease or INTNETTRUNKFACTORY::pfnCreateAndConnect
706	* calls.
707	*/
708	DECLR0CALLBACKMEMBER(INTNETTRUNKIFSTATE, pfnSetState,(PINTNETTRUNKIFPORT pIfPort, INTNETTRUNKIFSTATE enmState));
709
710	/**
711	* Notifies when the MAC address of an interface is set or changes.
712	*
713	* @param pIfPort Pointer to this structure.
714	* @param pvIfData Pointer to the trunk's interface data (see
715	* pfnConnectInterface).
716	* @param pMac Pointer to the MAC address of the connecting VM NIC.
717	*
718	* @remarks Only busy references to the trunk and the interface.
719	*/
720	DECLR0CALLBACKMEMBER(void, pfnNotifyMacAddress,(PINTNETTRUNKIFPORT pIfPort, void *pvIfData, PCRTMAC pMac));
721
722	/**
723	* Called when an interface is connected to the network.
724	*
725	* @returns IPRT status code.
726	* @param pIfPort Pointer to this structure.
727	* @param pvIf Opaque pointer to the interface being connected.
728	* For use INTNETTRUNKSWPORT::pfnRecv.
729	* @param ppvIfData Pointer to a pointer variable that the trunk
730	* implementation can use to associate data with the
731	* interface. This pointer will be passed to the
732	* pfnXmit, pfnNotifyMacAddress and
733	* pfnDisconnectInterface methods.
734	*
735	* @remarks Owns the big mutex. No racing pfnDisconnectAndRelease.
736	*/
737	DECLR0CALLBACKMEMBER(int, pfnConnectInterface,(PINTNETTRUNKIFPORT pIfPort, void pvIf, void *ppvIfData));
738
739	/**
740	* Called when an interface is disconnected from the network.
741	*
742	* @param pIfPort Pointer to this structure.
743	* @param pvIfData Pointer to the trunk's interface data (see
744	* pfnConnectInterface).
745	*
746	* @remarks Owns the big mutex. No racing pfnDisconnectAndRelease.
747	*/
748	DECLR0CALLBACKMEMBER(void, pfnDisconnectInterface,(PINTNETTRUNKIFPORT pIfPort, void *pvIfData));
749
750	/**
751	* Waits for the interface to become idle.
752	*
753	* This method must be called before disconnecting and releasing the object in
754	* order to prevent racing incoming/outgoing frames and device
755	* enabling/disabling.
756	*
757	* @returns IPRT status code (see RTSemEventWait).
758	* @param pIfPort Pointer to this structure.
759	* @param cMillies The number of milliseconds to wait. 0 means
760	* no waiting at all. Use RT_INDEFINITE_WAIT for
761	* an indefinite wait.
762	*
763	* @remarks Owns the big mutex. No racing pfnDisconnectAndRelease.
764	*/
765	DECLR0CALLBACKMEMBER(int, pfnWaitForIdle,(PINTNETTRUNKIFPORT pIfPort, uint32_t cMillies));
766
767	/**
768	* Transmit a frame.
769	*
770	* @return VBox status code. Error generally means we'll drop the frame.
771	* @param pIfPort Pointer to this structure.
772	* @param pvIfData Pointer to the trunk's interface data (see
773	* pfnConnectInterface).
774	* @param pSG Pointer to the (scatter /) gather structure for the frame.
775	* This may or may not be a temporary buffer. If it's temporary
776	* the transmit operation(s) then it's required to make a copy
777	* of the frame unless it can be transmitted synchronously.
778	* @param fDst The destination mask. At least one bit will be set.
779	*
780	* @remarks No locks. May be called concurrently on several threads.
781	*/
782	DECLR0CALLBACKMEMBER(int, pfnXmit,(PINTNETTRUNKIFPORT pIfPort, void *pvIfData, PINTNETSG pSG, uint32_t fDst));
783
784	/** Structure version number. (INTNETTRUNKIFPORT_VERSION) */
785	uint32_t u32VersionEnd;
786	} INTNETTRUNKIFPORT;
787
788	/** Version number for the INTNETTRUNKIFPORT::u32Version and INTNETTRUNKIFPORT::u32VersionEnd fields. */
789	#define INTNETTRUNKIFPORT_VERSION UINT32_C(0xA2CDe001)
790
791
792	/**
793	* The component factory interface for create a network
794	* interface filter (like VBoxNetFlt).
795	*/
796	typedef struct INTNETTRUNKFACTORY
797	{
798	/**
799	* Release this factory.
800	*
801	* SUPR0ComponentQueryFactory (SUPDRVFACTORY::pfnQueryFactoryInterface to be precise)
802	* will retain a reference to the factory and the caller has to call this method to
803	* release it once the pfnCreateAndConnect call(s) has been done.
804	*
805	* @param pIfFactory Pointer to this structure.
806	*/
807	DECLR0CALLBACKMEMBER(void, pfnRelease,(struct INTNETTRUNKFACTORY *pIfFactory));
808
809	/**
810	* Create an instance for the specfied host interface and connects it
811	* to the internal network trunk port.
812	*
813	* The initial interface active state is false (suspended).
814	*
815	*
816	* @returns VBox status code.
817	* @retval VINF_SUCCESS and *ppIfPort set on success.
818	* @retval VERR_INTNET_FLT_IF_NOT_FOUND if the interface was not found.
819	* @retval VERR_INTNET_FLT_IF_BUSY if the interface is already connected.
820	* @retval VERR_INTNET_FLT_IF_FAILED if it failed for some other reason.
821	*
822	* @param pIfFactory Pointer to this structure.
823	* @param pszName The interface name (OS specific).
824	* @param pSwitchPort Pointer to the port interface on the switch that
825	* this interface is being connected to.
826	* @param fFlags Creation flags, see below.
827	* @param ppIfPort Where to store the pointer to the interface port
828	* on success.
829	*
830	* @remarks Called while owning the network and the out-bound trunk semaphores.
831	*/
832	DECLR0CALLBACKMEMBER(int, pfnCreateAndConnect,(struct INTNETTRUNKFACTORY pIfFactory, const char pszName,
833	PINTNETTRUNKSWPORT pSwitchPort, uint32_t fFlags,
834	PINTNETTRUNKIFPORT *ppIfPort));
835	} INTNETTRUNKFACTORY;
836	/** Pointer to the trunk factory. */
837	typedef INTNETTRUNKFACTORY *PINTNETTRUNKFACTORY;
838
839	/** The UUID for the (current) trunk factory. (case sensitive) */
840	#define INTNETTRUNKFACTORY_UUID_STR "de504d93-1d1e-4781-8b73-6ea39a0e36a2"
841
842	/** @name INTNETTRUNKFACTORY::pfnCreateAndConnect flags.
843	* @{ */
844	/** Don't put the filtered interface in promiscuous mode.
845	* This is used for wireless interface since these can misbehave if
846	* we try to put them in promiscuous mode. (Wireless interfaces are
847	* normally bridged on level 3 instead of level 2.) */
848	#define INTNETTRUNKFACTORY_FLAG_NO_PROMISC RT_BIT_32(0)
849	/** @} */
850
851
852	/**
853	* The trunk connection type.
854	*
855	* Used by IntNetR0Open and associated interfaces.
856	*/
857	typedef enum INTNETTRUNKTYPE
858	{
859	/** Invalid trunk type. */
860	kIntNetTrunkType_Invalid = 0,
861	/** No trunk connection. */
862	kIntNetTrunkType_None,
863	/** We don't care which kind of trunk connection if the network exists,
864	* if it doesn't exist create it without a connection. */
865	kIntNetTrunkType_WhateverNone,
866	/** VirtualBox host network interface filter driver.
867	* The trunk name is the name of the host network interface. */
868	kIntNetTrunkType_NetFlt,
869	/** VirtualBox adapter host driver. */
870	kIntNetTrunkType_NetAdp,
871	/** Nat service (ring-0). */
872	kIntNetTrunkType_SrvNat,
873	/** The end of valid types. */
874	kIntNetTrunkType_End,
875	/** The usual 32-bit hack. */
876	kIntNetTrunkType_32bitHack = 0x7fffffff
877	} INTNETTRUNKTYPE;
878
879	/** @name IntNetR0Open flags.
880	*
881	* The desired policy options must be specified explicitly, if omitted it is
882	* understood that whatever is current or default is fine with the caller.
883	*
884	* @todo Move the policies out of the flags, use three new parameters.
885	*
886	* @{ */
887	/** Share the MAC address with the host when sending something to the wire via the trunk.
888	* This is typically used when the trunk is a NetFlt for a wireless interface. */
889	#define INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE RT_BIT_32(0)
890	/** Require that the current security and promiscuous policies of the network
891	* is exactly as the ones specified in this open network request.
892	*
893	* Use this with INTNET_OPEN_FLAGS_REQUIRE_AS_RESTRICTIVE_POLICIES to prevent
894	* restrictions from being lifted. If no further policy changes are desired,
895	* apply the relevant _FIXED flags. */
896	#define INTNET_OPEN_FLAGS_REQUIRE_EXACT RT_BIT_32(1)
897	/** Require that the security and promiscuous policies of the network is at
898	* least as restrictive as specified this request specifies and prevent them
899	* being lifted later on. */
900	#define INTNET_OPEN_FLAGS_REQUIRE_AS_RESTRICTIVE_POLICIES RT_BIT_32(2)
901
902	/** Network access policy: Fixed if set, changable if clear. */
903	#define INTNET_OPEN_FLAGS_ACCESS_FIXED RT_BIT_32(3)
904	/** Network access policy: Public network. */
905	#define INTNET_OPEN_FLAGS_ACCESS_PUBLIC RT_BIT_32(4)
906	/** Network access policy: Restricted network. */
907	#define INTNET_OPEN_FLAGS_ACCESS_RESTRICTED RT_BIT_32(5)
908
909	/** Promiscuous mode policy: Is it fixed or changable by new participants? */
910	#define INTNET_OPEN_FLAGS_PROMISC_FIXED RT_BIT_32(6)
911	/** Promiscuous mode policy: Allow the clients to request it. */
912	#define INTNET_OPEN_FLAGS_PROMISC_ALLOW_CLIENTS RT_BIT_32(7)
913	/** Promiscuous mode policy: Deny the clients from requesting it. */
914	#define INTNET_OPEN_FLAGS_PROMISC_DENY_CLIENTS RT_BIT_32(8)
915	/** Promiscuous mode policy: Allow the trunk-host to request it. */
916	#define INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_HOST RT_BIT_32(9)
917	/** Promiscuous mode policy: Deny the trunk-host from requesting it. */
918	#define INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_HOST RT_BIT_32(10)
919	/** Promiscuous mode policy: Allow the trunk-wire to request it. */
920	#define INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_WIRE RT_BIT_32(11)
921	/** Promiscuous mode policy: Deny the trunk-wire from requesting it. */
922	#define INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_WIRE RT_BIT_32(12)
923
924	/** Interface policies: Is it fixed or changable (by admin).
925	* @note Per interface, not network wide. */
926	#define INTNET_OPEN_FLAGS_IF_FIXED RT_BIT_32(13)
927	/** Interface promiscuous mode policy: Allow the interface to request it. */
928	#define INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW RT_BIT_32(14)
929	/** Interface promiscuous mode policy: Deny the interface from requesting it. */
930	#define INTNET_OPEN_FLAGS_IF_PROMISC_DENY RT_BIT_32(15)
931	/** Interface promiscuous mode policy: See unrelated trunk traffic. */
932	#define INTNET_OPEN_FLAGS_IF_PROMISC_SEE_TRUNK RT_BIT_32(16)
933	/** Interface promiscuous mode policy: No unrelated trunk traffic visible. */
934	#define INTNET_OPEN_FLAGS_IF_PROMISC_NO_TRUNK RT_BIT_32(17)
935
936	/** Trunk policy: Fixed if set, changable if clear.
937	* @remarks The DISABLED options are considered more restrictive by
938	* INTNET_OPEN_FLAGS_REQUIRE_AS_RESTRICTIVE_POLICIES. */
939	#define INTNET_OPEN_FLAGS_TRUNK_FIXED RT_BIT_32(18)
940	/** Trunk policy: The host end should be enabled. */
941	#define INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED RT_BIT_32(19)
942	/** Trunk policy: The host end should be disabled. */
943	#define INTNET_OPEN_FLAGS_TRUNK_HOST_DISABLED RT_BIT_32(20)
944	/** Trunk policy: The host should only see packets destined for it. */
945	#define INTNET_OPEN_FLAGS_TRUNK_HOST_CHASTE_MODE RT_BIT_32(21)
946	/** Trunk policy: The host should see all packets. */
947	#define INTNET_OPEN_FLAGS_TRUNK_HOST_PROMISC_MODE RT_BIT_32(22)
948	/** Trunk policy: The wire end should be enabled. */
949	#define INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED RT_BIT_32(23)
950	/** Trunk policy: The wire end should be disabled. */
951	#define INTNET_OPEN_FLAGS_TRUNK_WIRE_DISABLED RT_BIT_32(24)
952	/** Trunk policy: The wire should only see packets destined for it. */
953	#define INTNET_OPEN_FLAGS_TRUNK_WIRE_CHASTE_MODE RT_BIT_32(25)
954	/** Trunk policy: The wire should see all packets. */
955	#define INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE RT_BIT_32(26)
956
957	/** Used to enable host specific workarounds.
958	*
959	* On darwin this will clear ip_tos in DHCP packets when
960	* INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE is also set. */
961	#define INTNET_OPEN_FLAGS_WORKAROUND_1 RT_BIT_32(31)
962
963
964	/** The mask of valid flags. */
965	#define INTNET_OPEN_FLAGS_MASK UINT32_C(0x83ffffff)
966	/** The mask of all flags use to fix (lock) settings. */
967	#define INTNET_OPEN_FLAGS_FIXED_MASK \
968	( INTNET_OPEN_FLAGS_ACCESS_FIXED \
969	\| INTNET_OPEN_FLAGS_PROMISC_FIXED \
970	\| INTNET_OPEN_FLAGS_IF_FIXED \
971	\| INTNET_OPEN_FLAGS_TRUNK_FIXED )
972
973	/** The mask of all policy pairs. */
974	#define INTNET_OPEN_FLAGS_PAIR_MASK \
975	( INTNET_OPEN_FLAGS_ACCESS_PUBLIC \| INTNET_OPEN_FLAGS_ACCESS_RESTRICTED \
976	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_CLIENTS \| INTNET_OPEN_FLAGS_PROMISC_DENY_CLIENTS \
977	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_HOST \| INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_HOST \
978	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_WIRE \| INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_WIRE \
979	\| INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW \| INTNET_OPEN_FLAGS_IF_PROMISC_DENY \
980	\| INTNET_OPEN_FLAGS_IF_PROMISC_SEE_TRUNK \| INTNET_OPEN_FLAGS_IF_PROMISC_NO_TRUNK \
981	\| INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED \| INTNET_OPEN_FLAGS_TRUNK_HOST_DISABLED \
982	\| INTNET_OPEN_FLAGS_TRUNK_HOST_PROMISC_MODE \| INTNET_OPEN_FLAGS_TRUNK_HOST_CHASTE_MODE \
983	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED \| INTNET_OPEN_FLAGS_TRUNK_WIRE_DISABLED \
984	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE \| INTNET_OPEN_FLAGS_TRUNK_WIRE_CHASTE_MODE \
985	)
986	/** The mask of all relaxed policy bits. */
987	#define INTNET_OPEN_FLAGS_RELAXED_MASK \
988	( INTNET_OPEN_FLAGS_ACCESS_PUBLIC \
989	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_CLIENTS \
990	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_HOST \
991	\| INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_WIRE \
992	\| INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW \
993	\| INTNET_OPEN_FLAGS_IF_PROMISC_SEE_TRUNK \
994	\| INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED \
995	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE \
996	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED \
997	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE \
998	)
999	/** The mask of all strict policy bits. */
1000	#define INTNET_OPEN_FLAGS_STRICT_MASK \
1001	( INTNET_OPEN_FLAGS_ACCESS_RESTRICTED \
1002	\| INTNET_OPEN_FLAGS_PROMISC_DENY_CLIENTS \
1003	\| INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_HOST \
1004	\| INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_WIRE \
1005	\| INTNET_OPEN_FLAGS_IF_PROMISC_DENY \
1006	\| INTNET_OPEN_FLAGS_IF_PROMISC_NO_TRUNK \
1007	\| INTNET_OPEN_FLAGS_TRUNK_HOST_DISABLED \
1008	\| INTNET_OPEN_FLAGS_TRUNK_HOST_CHASTE_MODE \
1009	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_DISABLED \
1010	\| INTNET_OPEN_FLAGS_TRUNK_WIRE_CHASTE_MODE \
1011	)
1012	/** @} */
1013
1014	/** The maximum length of a network name. */
1015	#define INTNET_MAX_NETWORK_NAME 128
1016
1017	/** The maximum length of a trunk name. */
1018	#define INTNET_MAX_TRUNK_NAME 64
1019
1020
1021	/**
1022	* Request buffer for IntNetR0OpenReq / VMMR0_DO_INTNET_OPEN.
1023	* @see IntNetR0Open.
1024	*/
1025	typedef struct INTNETOPENREQ
1026	{
1027	/** The request header. */
1028	SUPVMMR0REQHDR Hdr;
1029	/** Alternative to passing the taking the session from the VM handle.
1030	* Either use this member or use the VM handle, don't do both. */
1031	PSUPDRVSESSION pSession;
1032	/** The network name. (input) */
1033	char szNetwork[INTNET_MAX_NETWORK_NAME];
1034	/** What to connect to the trunk port. (input)
1035	* This is specific to the trunk type below. */
1036	char szTrunk[INTNET_MAX_TRUNK_NAME];
1037	/** The type of trunk link (NAT, Filter, TAP, etc). (input) */
1038	INTNETTRUNKTYPE enmTrunkType;
1039	/** Flags, see INTNET_OPEN_FLAGS_. (input) /
1040	uint32_t fFlags;
1041	/** The size of the send buffer. (input) */
1042	uint32_t cbSend;
1043	/** The size of the receive buffer. (input) */
1044	uint32_t cbRecv;
1045	/** The handle to the network interface. (output) */
1046	INTNETIFHANDLE hIf;
1047	} INTNETOPENREQ;
1048	/** Pointer to an IntNetR0OpenReq / VMMR0_DO_INTNET_OPEN request buffer. */
1049	typedef INTNETOPENREQ *PINTNETOPENREQ;
1050
1051	INTNETR0DECL(int) IntNetR0OpenReq(PSUPDRVSESSION pSession, PINTNETOPENREQ pReq);
1052
1053
1054	/**
1055	* Request buffer for IntNetR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE.
1056	* @see IntNetR0IfClose.
1057	*/
1058	typedef struct INTNETIFCLOSEREQ
1059	{
1060	/** The request header. */
1061	SUPVMMR0REQHDR Hdr;
1062	/** Alternative to passing the taking the session from the VM handle.
1063	* Either use this member or use the VM handle, don't do both. */
1064	PSUPDRVSESSION pSession;
1065	/** The handle to the network interface. */
1066	INTNETIFHANDLE hIf;
1067	} INTNETIFCLOSEREQ;
1068	/** Pointer to an IntNetR0IfCloseReq / VMMR0_DO_INTNET_IF_CLOSE request
1069	* buffer. */
1070	typedef INTNETIFCLOSEREQ *PINTNETIFCLOSEREQ;
1071
1072	INTNETR0DECL(int) IntNetR0IfCloseReq(PSUPDRVSESSION pSession, PINTNETIFCLOSEREQ pReq);
1073
1074
1075	/**
1076	* Request buffer for IntNetR0IfGetRing3BufferReq /
1077	* VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS.
1078	* @see IntNetR0IfGetRing3Buffer.
1079	*/
1080	typedef struct INTNETIFGETBUFFERPTRSREQ
1081	{
1082	/** The request header. */
1083	SUPVMMR0REQHDR Hdr;
1084	/** Alternative to passing the taking the session from the VM handle.
1085	* Either use this member or use the VM handle, don't do both. */
1086	PSUPDRVSESSION pSession;
1087	/** Handle to the interface. */
1088	INTNETIFHANDLE hIf;
1089	/** The pointer to the ring-3 buffer. (output) */
1090	R3PTRTYPE(PINTNETBUF) pRing3Buf;
1091	/** The pointer to the ring-0 buffer. (output) */
1092	R0PTRTYPE(PINTNETBUF) pRing0Buf;
1093	} INTNETIFGETBUFFERPTRSREQ;
1094	/** Pointer to an IntNetR0IfGetRing3BufferReq /
1095	* VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS request buffer. */
1096	typedef INTNETIFGETBUFFERPTRSREQ *PINTNETIFGETBUFFERPTRSREQ;
1097
1098	INTNETR0DECL(int) IntNetR0IfGetBufferPtrsReq(PSUPDRVSESSION pSession, PINTNETIFGETBUFFERPTRSREQ pReq);
1099
1100
1101	/**
1102	* Request buffer for IntNetR0IfSetPromiscuousModeReq /
1103	* VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE.
1104	* @see IntNetR0IfSetPromiscuousMode.
1105	*/
1106	typedef struct INTNETIFSETPROMISCUOUSMODEREQ
1107	{
1108	/** The request header. */
1109	SUPVMMR0REQHDR Hdr;
1110	/** Alternative to passing the taking the session from the VM handle.
1111	* Either use this member or use the VM handle, don't do both. */
1112	PSUPDRVSESSION pSession;
1113	/** Handle to the interface. */
1114	INTNETIFHANDLE hIf;
1115	/** The new promiscuous mode. */
1116	bool fPromiscuous;
1117	} INTNETIFSETPROMISCUOUSMODEREQ;
1118	/** Pointer to an IntNetR0IfSetPromiscuousModeReq /
1119	* VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE request buffer. */
1120	typedef INTNETIFSETPROMISCUOUSMODEREQ *PINTNETIFSETPROMISCUOUSMODEREQ;
1121
1122	INTNETR0DECL(int) IntNetR0IfSetPromiscuousModeReq(PSUPDRVSESSION pSession, PINTNETIFSETPROMISCUOUSMODEREQ pReq);
1123
1124
1125	/**
1126	* Request buffer for IntNetR0IfSetMacAddressReq /
1127	* VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS.
1128	* @see IntNetR0IfSetMacAddress.
1129	*/
1130	typedef struct INTNETIFSETMACADDRESSREQ
1131	{
1132	/** The request header. */
1133	SUPVMMR0REQHDR Hdr;
1134	/** Alternative to passing the taking the session from the VM handle.
1135	* Either use this member or use the VM handle, don't do both. */
1136	PSUPDRVSESSION pSession;
1137	/** Handle to the interface. */
1138	INTNETIFHANDLE hIf;
1139	/** The new MAC address. */
1140	RTMAC Mac;
1141	} INTNETIFSETMACADDRESSREQ;
1142	/** Pointer to an IntNetR0IfSetMacAddressReq /
1143	* VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS request buffer. */
1144	typedef INTNETIFSETMACADDRESSREQ *PINTNETIFSETMACADDRESSREQ;
1145
1146	INTNETR0DECL(int) IntNetR0IfSetMacAddressReq(PSUPDRVSESSION pSession, PINTNETIFSETMACADDRESSREQ pReq);
1147
1148
1149	/**
1150	* Request buffer for IntNetR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE.
1151	* @see IntNetR0IfSetActive.
1152	*/
1153	typedef struct INTNETIFSETACTIVEREQ
1154	{
1155	/** The request header. */
1156	SUPVMMR0REQHDR Hdr;
1157	/** Alternative to passing the taking the session from the VM handle.
1158	* Either use this member or use the VM handle, don't do both. */
1159	PSUPDRVSESSION pSession;
1160	/** Handle to the interface. */
1161	INTNETIFHANDLE hIf;
1162	/** The new state. */
1163	bool fActive;
1164	} INTNETIFSETACTIVEREQ;
1165	/** Pointer to an IntNetR0IfSetActiveReq / VMMR0_DO_INTNET_IF_SET_ACTIVE
1166	* request buffer. */
1167	typedef INTNETIFSETACTIVEREQ *PINTNETIFSETACTIVEREQ;
1168
1169	INTNETR0DECL(int) IntNetR0IfSetActiveReq(PSUPDRVSESSION pSession, PINTNETIFSETACTIVEREQ pReq);
1170
1171
1172	/**
1173	* Request buffer for IntNetR0IfSendReq / VMMR0_DO_INTNET_IF_SEND.
1174	* @see IntNetR0IfSend.
1175	*/
1176	typedef struct INTNETIFSENDREQ
1177	{
1178	/** The request header. */
1179	SUPVMMR0REQHDR Hdr;
1180	/** Alternative to passing the taking the session from the VM handle.
1181	* Either use this member or use the VM handle, don't do both. */
1182	PSUPDRVSESSION pSession;
1183	/** Handle to the interface. */
1184	INTNETIFHANDLE hIf;
1185	} INTNETIFSENDREQ;
1186	/** Pointer to an IntNetR0IfSend() argument package. */
1187	typedef INTNETIFSENDREQ *PINTNETIFSENDREQ;
1188
1189	INTNETR0DECL(int) IntNetR0IfSendReq(PSUPDRVSESSION pSession, PINTNETIFSENDREQ pReq);
1190
1191
1192	/**
1193	* Request buffer for IntNetR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT.
1194	* @see IntNetR0IfWait.
1195	*/
1196	typedef struct INTNETIFWAITREQ
1197	{
1198	/** The request header. */
1199	SUPVMMR0REQHDR Hdr;
1200	/** Alternative to passing the taking the session from the VM handle.
1201	* Either use this member or use the VM handle, don't do both. */
1202	PSUPDRVSESSION pSession;
1203	/** Handle to the interface. */
1204	INTNETIFHANDLE hIf;
1205	/** The number of milliseconds to wait. */
1206	uint32_t cMillies;
1207	} INTNETIFWAITREQ;
1208	/** Pointer to an IntNetR0IfWaitReq / VMMR0_DO_INTNET_IF_WAIT request buffer. */
1209	typedef INTNETIFWAITREQ *PINTNETIFWAITREQ;
1210
1211	INTNETR0DECL(int) IntNetR0IfWaitReq(PSUPDRVSESSION pSession, PINTNETIFWAITREQ pReq);
1212
1213
1214	/**
1215	* Request buffer for IntNetR0IfAbortWaitReq / VMMR0_DO_INTNET_IF_ABORT_WAIT.
1216	* @see IntNetR0IfAbortWait.
1217	*/
1218	typedef struct INTNETIFABORTWAITREQ
1219	{
1220	/** The request header. */
1221	SUPVMMR0REQHDR Hdr;
1222	/** Alternative to passing the taking the session from the VM handle.
1223	* Either use this member or use the VM handle, don't do both. */
1224	PSUPDRVSESSION pSession;
1225	/** Handle to the interface. */
1226	INTNETIFHANDLE hIf;
1227	/** Set this to fend off all future IntNetR0Wait calls. */
1228	bool fNoMoreWaits;
1229	} INTNETIFABORTWAITREQ;
1230	/** Pointer to an IntNetR0IfAbortWaitReq / VMMR0_DO_INTNET_IF_ABORT_WAIT
1231	* request buffer. */
1232	typedef INTNETIFABORTWAITREQ *PINTNETIFABORTWAITREQ;
1233
1234	INTNETR0DECL(int) IntNetR0IfAbortWaitReq(PSUPDRVSESSION pSession, PINTNETIFABORTWAITREQ pReq);
1235
1236
1237	#if defined(IN_RING0) \|\| defined(IN_INTNET_TESTCASE)
1238	/** @name
1239	* @{
1240	*/
1241
1242	INTNETR0DECL(int) IntNetR0Init(void);
1243	INTNETR0DECL(void) IntNetR0Term(void);
1244	INTNETR0DECL(int) IntNetR0Open(PSUPDRVSESSION pSession, const char *pszNetwork,
1245	INTNETTRUNKTYPE enmTrunkType, const char *pszTrunk, uint32_t fFlags,
1246	uint32_t cbSend, uint32_t cbRecv, PINTNETIFHANDLE phIf);
1247	INTNETR0DECL(uint32_t) IntNetR0GetNetworkCount(void);
1248
1249	INTNETR0DECL(int) IntNetR0IfClose(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
1250	INTNETR0DECL(int) IntNetR0IfGetBufferPtrs(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession,
1251	R3PTRTYPE(PINTNETBUF) ppRing3Buf, R0PTRTYPE(PINTNETBUF) ppRing0Buf);
1252	INTNETR0DECL(int) IntNetR0IfSetPromiscuousMode(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fPromiscuous);
1253	INTNETR0DECL(int) IntNetR0IfSetMacAddress(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, PCRTMAC pMac);
1254	INTNETR0DECL(int) IntNetR0IfSetActive(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, bool fActive);
1255	INTNETR0DECL(int) IntNetR0IfSend(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
1256	INTNETR0DECL(int) IntNetR0IfWait(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession, uint32_t cMillies);
1257	INTNETR0DECL(int) IntNetR0IfAbortWait(INTNETIFHANDLE hIf, PSUPDRVSESSION pSession);
1258
1259	/** @} */
1260	#endif /* IN_RING0 */
1261
1262	RT_C_DECLS_END
1263
1264	#endif

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

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

Download in other formats: