intnet.h@ 28104

Last change on this file since 28104 was 28104, checked in by vboxsync, 15 years ago
intnet.h: changed the INTNETTRUNKFACTORY_UUID_STR as INTNETSG was changed in an incompatible way recently.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 39.6 KB

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

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

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

Download in other formats: