DrvIntNet.cpp@ 64700

Last change on this file since 64700 was 63478, checked in by vboxsync, 8 years ago
Devices: warnings (clang)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 74.1 KB

Line
1	/* $Id: DrvIntNet.cpp 63478 2016-08-15 14:04:10Z vboxsync $ */
2	/** @file
3	* DrvIntNet - Internal network transport driver.
4	*/
5
6	/*
7	* Copyright (C) 2006-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DRV_INTNET
23	#include <VBox/vmm/pdmdrv.h>
24	#include <VBox/vmm/pdmnetinline.h>
25	#include <VBox/vmm/pdmnetifs.h>
26	#include <VBox/vmm/cfgm.h>
27	#include <VBox/intnet.h>
28	#include <VBox/intnetinline.h>
29	#include <VBox/vmm/vmm.h>
30	#include <VBox/sup.h>
31	#include <VBox/err.h>
32
33	#include <VBox/param.h>
34	#include <VBox/log.h>
35	#include <iprt/asm.h>
36	#include <iprt/assert.h>
37	#include <iprt/ctype.h>
38	#include <iprt/memcache.h>
39	#include <iprt/net.h>
40	#include <iprt/semaphore.h>
41	#include <iprt/string.h>
42	#include <iprt/time.h>
43	#include <iprt/thread.h>
44	#include <iprt/uuid.h>
45	#if defined(RT_OS_DARWIN) && defined(IN_RING3)
46	# include <iprt/system.h>
47	#endif
48
49	#include "VBoxDD.h"
50
51
52	/*********************************************************************************************************************************
53	* Defined Constants And Macros *
54	*********************************************************************************************************************************/
55	/** Enables the ring-0 part. */
56	#define VBOX_WITH_DRVINTNET_IN_R0
57
58
59	/*********************************************************************************************************************************
60	* Structures and Typedefs *
61	*********************************************************************************************************************************/
62	/**
63	* The state of the asynchronous thread.
64	*/
65	typedef enum RECVSTATE
66	{
67	/** The thread is suspended. */
68	RECVSTATE_SUSPENDED = 1,
69	/** The thread is running. */
70	RECVSTATE_RUNNING,
71	/** The thread must (/has) terminate. */
72	RECVSTATE_TERMINATE,
73	/** The usual 32-bit type blowup. */
74	RECVSTATE_32BIT_HACK = 0x7fffffff
75	} RECVSTATE;
76
77	/**
78	* Internal networking driver instance data.
79	*
80	* @implements PDMINETWORKUP
81	*/
82	typedef struct DRVINTNET
83	{
84	/** The network interface. */
85	PDMINETWORKUP INetworkUpR3;
86	/** The network interface. */
87	R3PTRTYPE(PPDMINETWORKDOWN) pIAboveNet;
88	/** The network config interface.
89	* Can (in theory at least) be NULL. */
90	R3PTRTYPE(PPDMINETWORKCONFIG) pIAboveConfigR3;
91	/** Pointer to the driver instance (ring-3). */
92	PPDMDRVINSR3 pDrvInsR3;
93	/** Pointer to the communication buffer (ring-3). */
94	R3PTRTYPE(PINTNETBUF) pBufR3;
95	/** Ring-3 base interface for the ring-0 context. */
96	PDMIBASER0 IBaseR0;
97	/** Ring-3 base interface for the raw-mode context. */
98	PDMIBASERC IBaseRC;
99	RTR3PTR R3PtrAlignment;
100
101	/** The network interface for the ring-0 context. */
102	PDMINETWORKUPR0 INetworkUpR0;
103	/** Pointer to the driver instance (ring-0). */
104	PPDMDRVINSR0 pDrvInsR0;
105	/** Pointer to the communication buffer (ring-0). */
106	R0PTRTYPE(PINTNETBUF) pBufR0;
107
108	/** The network interface for the raw-mode context. */
109	PDMINETWORKUPRC INetworkUpRC;
110	/** Pointer to the driver instance. */
111	PPDMDRVINSRC pDrvInsRC;
112	RTRCPTR RCPtrAlignment;
113
114	/** The transmit lock. */
115	PDMCRITSECT XmitLock;
116	/** Interface handle. */
117	INTNETIFHANDLE hIf;
118	/** The receive thread state. */
119	RECVSTATE volatile enmRecvState;
120	/** The receive thread. */
121	RTTHREAD hRecvThread;
122	/** The event semaphore that the receive thread waits on. */
123	RTSEMEVENT hRecvEvt;
124	/** The transmit thread. */
125	PPDMTHREAD pXmitThread;
126	/** The event semaphore that the transmit thread waits on. */
127	SUPSEMEVENT hXmitEvt;
128	/** The support driver session handle. */
129	PSUPDRVSESSION pSupDrvSession;
130	/** Scatter/gather descriptor cache. */
131	RTMEMCACHE hSgCache;
132	/** Set if the link is down.
133	* When the link is down all incoming packets will be dropped. */
134	bool volatile fLinkDown;
135	/** Set when the xmit thread has been signalled. (atomic) */
136	bool volatile fXmitSignalled;
137	/** Set if the transmit thread the one busy transmitting. */
138	bool volatile fXmitOnXmitThread;
139	/** The xmit thread should process the ring ASAP. */
140	bool fXmitProcessRing;
141	/** Set if data transmission should start immediately and deactivate
142	* as late as possible. */
143	bool fActivateEarlyDeactivateLate;
144	/** Padding. */
145	bool afReserved[HC_ARCH_BITS == 64 ? 3 : 3];
146	/** Scratch space for holding the ring-0 scatter / gather descriptor.
147	* The PDMSCATTERGATHER::fFlags member is used to indicate whether it is in
148	* use or not. Always accessed while owning the XmitLock. */
149	union
150	{
151	PDMSCATTERGATHER Sg;
152	uint8_t padding[8 * sizeof(RTUINTPTR)];
153	} u;
154	/** The network name. */
155	char szNetwork[INTNET_MAX_NETWORK_NAME];
156
157	/** Number of GSO packets sent. */
158	STAMCOUNTER StatSentGso;
159	/** Number of GSO packets received. */
160	STAMCOUNTER StatReceivedGso;
161	/** Number of packets send from ring-0. */
162	STAMCOUNTER StatSentR0;
163	/** The number of times we've had to wake up the xmit thread to continue the
164	* ring-0 job. */
165	STAMCOUNTER StatXmitWakeupR0;
166	/** The number of times we've had to wake up the xmit thread to continue the
167	* ring-3 job. */
168	STAMCOUNTER StatXmitWakeupR3;
169	/** The times the xmit thread has been told to process the ring. */
170	STAMCOUNTER StatXmitProcessRing;
171	#ifdef VBOX_WITH_STATISTICS
172	/** Profiling packet transmit runs. */
173	STAMPROFILE StatTransmit;
174	/** Profiling packet receive runs. */
175	STAMPROFILEADV StatReceive;
176	#endif /* VBOX_WITH_STATISTICS */
177	#ifdef LOG_ENABLED
178	/** The nano ts of the last transfer. */
179	uint64_t u64LastTransferTS;
180	/** The nano ts of the last receive. */
181	uint64_t u64LastReceiveTS;
182	#endif
183	} DRVINTNET;
184	AssertCompileMemberAlignment(DRVINTNET, XmitLock, 8);
185	AssertCompileMemberAlignment(DRVINTNET, StatSentGso, 8);
186	/** Pointer to instance data of the internal networking driver. */
187	typedef DRVINTNET *PDRVINTNET;
188
189	/**
190	* Config value to flag translation structure.
191	*/
192	typedef struct DRVINTNETFLAG
193	{
194	/** The value. */
195	const char *pszChoice;
196	/** The corresponding flag. */
197	uint32_t fFlag;
198	} DRVINTNETFLAG;
199	/** Pointer to a const flag value translation. */
200	typedef DRVINTNETFLAG const *PCDRVINTNETFLAG;
201
202
203	#ifdef IN_RING3
204
205
206	/**
207	* Updates the MAC address on the kernel side.
208	*
209	* @returns VBox status code.
210	* @param pThis The driver instance.
211	*/
212	static int drvR3IntNetUpdateMacAddress(PDRVINTNET pThis)
213	{
214	if (!pThis->pIAboveConfigR3)
215	return VINF_SUCCESS;
216
217	INTNETIFSETMACADDRESSREQ SetMacAddressReq;
218	SetMacAddressReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
219	SetMacAddressReq.Hdr.cbReq = sizeof(SetMacAddressReq);
220	SetMacAddressReq.pSession = NIL_RTR0PTR;
221	SetMacAddressReq.hIf = pThis->hIf;
222	int rc = pThis->pIAboveConfigR3->pfnGetMac(pThis->pIAboveConfigR3, &SetMacAddressReq.Mac);
223	if (RT_SUCCESS(rc))
224	rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS,
225	&SetMacAddressReq, sizeof(SetMacAddressReq));
226
227	Log(("drvR3IntNetUpdateMacAddress: %.*Rhxs rc=%Rrc\n", sizeof(SetMacAddressReq.Mac), &SetMacAddressReq.Mac, rc));
228	return rc;
229	}
230
231
232	/**
233	* Sets the kernel interface active or inactive.
234	*
235	* Worker for poweron, poweroff, suspend and resume.
236	*
237	* @returns VBox status code.
238	* @param pThis The driver instance.
239	* @param fActive The new state.
240	*/
241	static int drvR3IntNetSetActive(PDRVINTNET pThis, bool fActive)
242	{
243	if (!pThis->pIAboveConfigR3)
244	return VINF_SUCCESS;
245
246	INTNETIFSETACTIVEREQ SetActiveReq;
247	SetActiveReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
248	SetActiveReq.Hdr.cbReq = sizeof(SetActiveReq);
249	SetActiveReq.pSession = NIL_RTR0PTR;
250	SetActiveReq.hIf = pThis->hIf;
251	SetActiveReq.fActive = fActive;
252	int rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SET_ACTIVE,
253	&SetActiveReq, sizeof(SetActiveReq));
254
255	Log(("drvR3IntNetSetActive: fActive=%d rc=%Rrc\n", fActive, rc));
256	AssertRC(rc);
257	return rc;
258	}
259
260	#endif /* IN_RING3 */
261
262	/* -=-=-=-=- PDMINETWORKUP -=-=-=-=- */
263
264	#ifndef IN_RING3
265	/**
266	* Helper for signalling the xmit thread.
267	*
268	* @returns VERR_TRY_AGAIN (convenience).
269	* @param pThis The instance data..
270	*/
271	DECLINLINE(int) drvR0IntNetSignalXmit(PDRVINTNET pThis)
272	{
273	/// @todo if (!ASMAtomicXchgBool(&pThis->fXmitSignalled, true)) - needs careful optimizing.
274	{
275	int rc = SUPSemEventSignal(pThis->pSupDrvSession, pThis->hXmitEvt);
276	AssertRC(rc);
277	STAM_REL_COUNTER_INC(&pThis->CTX_SUFF(StatXmitWakeup));
278	}
279	return VERR_TRY_AGAIN;
280	}
281	#endif /* !IN_RING3 */
282
283
284	/**
285	* Helper for processing the ring-0 consumer side of the xmit ring.
286	*
287	* The caller MUST own the xmit lock.
288	*
289	* @returns Status code from IntNetR0IfSend, except for VERR_TRY_AGAIN.
290	* @param pThis The instance data..
291	*/
292	DECLINLINE(int) drvIntNetProcessXmit(PDRVINTNET pThis)
293	{
294	Assert(PDMCritSectIsOwner(&pThis->XmitLock));
295
296	#ifdef IN_RING3
297	INTNETIFSENDREQ SendReq;
298	SendReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
299	SendReq.Hdr.cbReq = sizeof(SendReq);
300	SendReq.pSession = NIL_RTR0PTR;
301	SendReq.hIf = pThis->hIf;
302	int rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SEND, &SendReq, sizeof(SendReq));
303	#else
304	int rc = IntNetR0IfSend(pThis->hIf, pThis->pSupDrvSession);
305	if (rc == VERR_TRY_AGAIN)
306	{
307	ASMAtomicUoWriteBool(&pThis->fXmitProcessRing, true);
308	drvR0IntNetSignalXmit(pThis);
309	rc = VINF_SUCCESS;
310	}
311	#endif
312	return rc;
313	}
314
315
316
317	/**
318	* @interface_method_impl{PDMINETWORKUP,pfnBeginXmit}
319	*/
320	PDMBOTHCBDECL(int) drvIntNetUp_BeginXmit(PPDMINETWORKUP pInterface, bool fOnWorkerThread)
321	{
322	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
323	#ifndef IN_RING3
324	Assert(!fOnWorkerThread);
325	#endif
326
327	int rc = PDMCritSectTryEnter(&pThis->XmitLock);
328	if (RT_SUCCESS(rc))
329	{
330	if (fOnWorkerThread)
331	{
332	ASMAtomicUoWriteBool(&pThis->fXmitOnXmitThread, true);
333	ASMAtomicWriteBool(&pThis->fXmitSignalled, false);
334	}
335	}
336	else if (rc == VERR_SEM_BUSY)
337	{
338	/** @todo Does this actually make sense if the other dude is an EMT and so
339	* forth? I seriously think this is ring-0 only...
340	* We might end up waking up the xmit thread unnecessarily here, even when in
341	* ring-0... This needs some more thought and optimizations when the ring-0 bits
342	* are working. */
343	#ifdef IN_RING3
344	if ( !fOnWorkerThread
345	/*&& !ASMAtomicUoReadBool(&pThis->fXmitOnXmitThread)
346	&& ASMAtomicCmpXchgBool(&pThis->fXmitSignalled, true, false)*/)
347	{
348	rc = SUPSemEventSignal(pThis->pSupDrvSession, pThis->hXmitEvt);
349	AssertRC(rc);
350	}
351	rc = VERR_TRY_AGAIN;
352	#else /* IN_RING0 */
353	rc = drvR0IntNetSignalXmit(pThis);
354	#endif /* IN_RING0 */
355	}
356	return rc;
357	}
358
359
360	/**
361	* @interface_method_impl{PDMINETWORKUP,pfnAllocBuf}
362	*/
363	PDMBOTHCBDECL(int) drvIntNetUp_AllocBuf(PPDMINETWORKUP pInterface, size_t cbMin,
364	PCPDMNETWORKGSO pGso, PPPDMSCATTERGATHER ppSgBuf)
365	{
366	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
367	int rc = VINF_SUCCESS;
368	Assert(cbMin < UINT32_MAX / 2);
369	Assert(PDMCritSectIsOwner(&pThis->XmitLock));
370
371	/*
372	* Allocate a S/G descriptor.
373	* This shouldn't normally fail as the NICs usually won't allocate more
374	* than one buffer at a time and the SG gets freed on sending.
375	*/
376	#ifdef IN_RING3
377	PPDMSCATTERGATHER pSgBuf = (PPDMSCATTERGATHER)RTMemCacheAlloc(pThis->hSgCache);
378	if (!pSgBuf)
379	return VERR_NO_MEMORY;
380	#else
381	PPDMSCATTERGATHER pSgBuf = &pThis->u.Sg;
382	if (RT_UNLIKELY(pSgBuf->fFlags != 0))
383	return drvR0IntNetSignalXmit(pThis);
384	#endif
385
386	/*
387	* Allocate room in the ring buffer.
388	*
389	* In ring-3 we may have to process the xmit ring before there is
390	* sufficient buffer space since we might have stacked up a few frames to the
391	* trunk while in ring-0. (There is not point of doing this in ring-0.)
392	*/
393	PINTNETHDR pHdr = NULL; /* gcc silliness */
394	if (pGso)
395	rc = IntNetRingAllocateGsoFrame(&pThis->CTX_SUFF(pBuf)->Send, (uint32_t)cbMin, pGso,
396	&pHdr, &pSgBuf->aSegs[0].pvSeg);
397	else
398	rc = IntNetRingAllocateFrame(&pThis->CTX_SUFF(pBuf)->Send, (uint32_t)cbMin,
399	&pHdr, &pSgBuf->aSegs[0].pvSeg);
400	#ifdef IN_RING3
401	if ( RT_FAILURE(rc)
402	&& pThis->CTX_SUFF(pBuf)->cbSend >= cbMin * 2 + sizeof(INTNETHDR))
403	{
404	drvIntNetProcessXmit(pThis);
405	if (pGso)
406	rc = IntNetRingAllocateGsoFrame(&pThis->CTX_SUFF(pBuf)->Send, (uint32_t)cbMin, pGso,
407	&pHdr, &pSgBuf->aSegs[0].pvSeg);
408	else
409	rc = IntNetRingAllocateFrame(&pThis->CTX_SUFF(pBuf)->Send, (uint32_t)cbMin,
410	&pHdr, &pSgBuf->aSegs[0].pvSeg);
411	}
412	#endif
413	if (RT_SUCCESS(rc))
414	{
415	/*
416	* Set up the S/G descriptor and return successfully.
417	*/
418	pSgBuf->fFlags = PDMSCATTERGATHER_FLAGS_MAGIC \| PDMSCATTERGATHER_FLAGS_OWNER_1;
419	pSgBuf->cbUsed = 0;
420	pSgBuf->cbAvailable = cbMin;
421	pSgBuf->pvAllocator = pHdr;
422	pSgBuf->pvUser = pGso ? (PPDMNETWORKGSO)pSgBuf->aSegs[0].pvSeg - 1 : NULL;
423	pSgBuf->cSegs = 1;
424	pSgBuf->aSegs[0].cbSeg = cbMin;
425
426	*ppSgBuf = pSgBuf;
427	return VINF_SUCCESS;
428	}
429
430	#ifdef IN_RING3
431	/*
432	* If the above fails, then we're really out of space. There are nobody
433	* competing with us here because of the xmit lock.
434	*/
435	rc = VERR_NO_MEMORY;
436	RTMemCacheFree(pThis->hSgCache, pSgBuf);
437
438	#else /* IN_RING0 */
439	/*
440	* If the request is reasonable, kick the xmit thread and tell it to
441	* process the xmit ring ASAP.
442	*/
443	if (pThis->CTX_SUFF(pBuf)->cbSend >= cbMin * 2 + sizeof(INTNETHDR))
444	{
445	pThis->fXmitProcessRing = true;
446	rc = drvR0IntNetSignalXmit(pThis);
447	}
448	else
449	rc = VERR_NO_MEMORY;
450	pSgBuf->fFlags = 0;
451	#endif /* IN_RING0 */
452	return rc;
453	}
454
455
456	/**
457	* @interface_method_impl{PDMINETWORKUP,pfnFreeBuf}
458	*/
459	PDMBOTHCBDECL(int) drvIntNetUp_FreeBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf)
460	{
461	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
462	PINTNETHDR pHdr = (PINTNETHDR)pSgBuf->pvAllocator;
463	#ifdef IN_RING0
464	Assert(pSgBuf == &pThis->u.Sg);
465	#endif
466	Assert(pSgBuf->fFlags == (PDMSCATTERGATHER_FLAGS_MAGIC \| PDMSCATTERGATHER_FLAGS_OWNER_1));
467	Assert(pSgBuf->cbUsed <= pSgBuf->cbAvailable);
468	Assert( pHdr->u8Type == INTNETHDR_TYPE_FRAME
469	\|\| pHdr->u8Type == INTNETHDR_TYPE_GSO);
470	Assert(PDMCritSectIsOwner(&pThis->XmitLock));
471
472	/** @todo LATER: try unalloc the frame. */
473	pHdr->u8Type = INTNETHDR_TYPE_PADDING;
474	IntNetRingCommitFrame(&pThis->CTX_SUFF(pBuf)->Send, pHdr);
475
476	#ifdef IN_RING3
477	RTMemCacheFree(pThis->hSgCache, pSgBuf);
478	#else
479	pSgBuf->fFlags = 0;
480	#endif
481	return VINF_SUCCESS;
482	}
483
484
485	/**
486	* @interface_method_impl{PDMINETWORKUP,pfnSendBuf}
487	*/
488	PDMBOTHCBDECL(int) drvIntNetUp_SendBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread)
489	{
490	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
491	STAM_PROFILE_START(&pThis->StatTransmit, a);
492	RT_NOREF_PV(fOnWorkerThread);
493
494	AssertPtr(pSgBuf);
495	Assert(pSgBuf->fFlags == (PDMSCATTERGATHER_FLAGS_MAGIC \| PDMSCATTERGATHER_FLAGS_OWNER_1));
496	Assert(pSgBuf->cbUsed <= pSgBuf->cbAvailable);
497	Assert(PDMCritSectIsOwner(&pThis->XmitLock));
498
499	if (pSgBuf->pvUser)
500	STAM_COUNTER_INC(&pThis->StatSentGso);
501
502	/* Set an FTM checkpoint as this operation changes the state permanently. */
503	PDMDrvHlpFTSetCheckpoint(pThis->CTX_SUFF(pDrvIns), FTMCHECKPOINTTYPE_NETWORK);
504
505	/*
506	* Commit the frame and push it thru the switch.
507	*/
508	PINTNETHDR pHdr = (PINTNETHDR)pSgBuf->pvAllocator;
509	IntNetRingCommitFrameEx(&pThis->CTX_SUFF(pBuf)->Send, pHdr, pSgBuf->cbUsed);
510	int rc = drvIntNetProcessXmit(pThis);
511	STAM_PROFILE_STOP(&pThis->StatTransmit, a);
512
513	/*
514	* Free the descriptor and return.
515	*/
516	#ifdef IN_RING3
517	RTMemCacheFree(pThis->hSgCache, pSgBuf);
518	#else
519	STAM_REL_COUNTER_INC(&pThis->StatSentR0);
520	pSgBuf->fFlags = 0;
521	#endif
522	return rc;
523	}
524
525
526	/**
527	* @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
528	*/
529	PDMBOTHCBDECL(void) drvIntNetUp_EndXmit(PPDMINETWORKUP pInterface)
530	{
531	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
532	ASMAtomicUoWriteBool(&pThis->fXmitOnXmitThread, false);
533	PDMCritSectLeave(&pThis->XmitLock);
534	}
535
536
537	/**
538	* @interface_method_impl{PDMINETWORKUP,pfnSetPromiscuousMode}
539	*/
540	PDMBOTHCBDECL(void) drvIntNetUp_SetPromiscuousMode(PPDMINETWORKUP pInterface, bool fPromiscuous)
541	{
542	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
543
544	#ifdef IN_RING3
545	INTNETIFSETPROMISCUOUSMODEREQ Req;
546	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
547	Req.Hdr.cbReq = sizeof(Req);
548	Req.pSession = NIL_RTR0PTR;
549	Req.hIf = pThis->hIf;
550	Req.fPromiscuous = fPromiscuous;
551	int rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE, &Req, sizeof(Req));
552	#else /* IN_RING0 */
553	int rc = IntNetR0IfSetPromiscuousMode(pThis->hIf, pThis->pSupDrvSession, fPromiscuous);
554	#endif /* IN_RING0 */
555
556	LogFlow(("drvIntNetUp_SetPromiscuousMode: fPromiscuous=%RTbool\n", fPromiscuous));
557	AssertRC(rc);
558	}
559
560	#ifdef IN_RING3
561
562	/**
563	* @interface_method_impl{PDMINETWORKUP,pfnNotifyLinkChanged}
564	*/
565	static DECLCALLBACK(void) drvR3IntNetUp_NotifyLinkChanged(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState)
566	{
567	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
568	bool fLinkDown;
569	switch (enmLinkState)
570	{
571	case PDMNETWORKLINKSTATE_DOWN:
572	case PDMNETWORKLINKSTATE_DOWN_RESUME:
573	fLinkDown = true;
574	break;
575	default:
576	AssertMsgFailed(("enmLinkState=%d\n", enmLinkState));
577	case PDMNETWORKLINKSTATE_UP:
578	fLinkDown = false;
579	break;
580	}
581	LogFlow(("drvR3IntNetUp_NotifyLinkChanged: enmLinkState=%d %d->%d\n", enmLinkState, pThis->fLinkDown, fLinkDown));
582	ASMAtomicXchgSize(&pThis->fLinkDown, fLinkDown);
583	}
584
585
586	/* -=-=-=-=- Transmit Thread -=-=-=-=- */
587
588	/**
589	* Async I/O thread for deferred packet transmission.
590	*
591	* @returns VBox status code. Returning failure will naturally terminate the thread.
592	* @param pDrvIns The internal networking driver instance.
593	* @param pThread The thread.
594	*/
595	static DECLCALLBACK(int) drvR3IntNetXmitThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
596	{
597	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
598
599	while (pThread->enmState == PDMTHREADSTATE_RUNNING)
600	{
601	/*
602	* Transmit any pending packets.
603	*/
604	/** @todo Optimize this. We shouldn't call pfnXmitPending unless asked for.
605	* Also there is no need to call drvIntNetProcessXmit if we also
606	* called pfnXmitPending and send one or more frames. */
607	if (ASMAtomicXchgBool(&pThis->fXmitProcessRing, false))
608	{
609	STAM_REL_COUNTER_INC(&pThis->StatXmitProcessRing);
610	PDMCritSectEnter(&pThis->XmitLock, VERR_IGNORED);
611	drvIntNetProcessXmit(pThis);
612	PDMCritSectLeave(&pThis->XmitLock);
613	}
614
615	pThis->pIAboveNet->pfnXmitPending(pThis->pIAboveNet);
616
617	if (ASMAtomicXchgBool(&pThis->fXmitProcessRing, false))
618	{
619	STAM_REL_COUNTER_INC(&pThis->StatXmitProcessRing);
620	PDMCritSectEnter(&pThis->XmitLock, VERR_IGNORED);
621	drvIntNetProcessXmit(pThis);
622	PDMCritSectLeave(&pThis->XmitLock);
623	}
624
625	/*
626	* Block until we've got something to send or is supposed
627	* to leave the running state.
628	*/
629	int rc = SUPSemEventWaitNoResume(pThis->pSupDrvSession, pThis->hXmitEvt, RT_INDEFINITE_WAIT);
630	AssertLogRelMsgReturn(RT_SUCCESS(rc) \|\| rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
631	if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
632	break;
633
634	}
635
636	/* The thread is being initialized, suspended or terminated. */
637	return VINF_SUCCESS;
638	}
639
640
641	/**
642	* @copydoc FNPDMTHREADWAKEUPDRV
643	*/
644	static DECLCALLBACK(int) drvR3IntNetXmitWakeUp(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
645	{
646	RT_NOREF(pThread);
647	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
648	return SUPSemEventSignal(pThis->pSupDrvSession, pThis->hXmitEvt);
649	}
650
651
652	/* -=-=-=-=- Receive Thread -=-=-=-=- */
653
654	/**
655	* Wait for space to become available up the driver/device chain.
656	*
657	* @returns VINF_SUCCESS if space is available.
658	* @returns VERR_STATE_CHANGED if the state changed.
659	* @returns VBox status code on other errors.
660	* @param pThis Pointer to the instance data.
661	*/
662	static int drvR3IntNetRecvWaitForSpace(PDRVINTNET pThis)
663	{
664	LogFlow(("drvR3IntNetRecvWaitForSpace:\n"));
665	STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
666	int rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
667	STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
668	LogFlow(("drvR3IntNetRecvWaitForSpace: returns %Rrc\n", rc));
669	return rc;
670	}
671
672
673	/**
674	* Executes async I/O (RUNNING mode).
675	*
676	* @returns VERR_STATE_CHANGED if the state changed.
677	* @returns Appropriate VBox status code (error) on fatal error.
678	* @param pThis The driver instance data.
679	*/
680	static int drvR3IntNetRecvRun(PDRVINTNET pThis)
681	{
682	PPDMDRVINS pDrvIns = pThis->pDrvInsR3;
683	LogFlow(("drvR3IntNetRecvRun: pThis=%p\n", pThis));
684
685	/*
686	* The running loop - processing received data and waiting for more to arrive.
687	*/
688	STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
689	PINTNETBUF pBuf = pThis->CTX_SUFF(pBuf);
690	PINTNETRINGBUF pRingBuf = &pBuf->Recv;
691	for (;;)
692	{
693	/*
694	* Process the receive buffer.
695	*/
696	PINTNETHDR pHdr;
697	while ((pHdr = IntNetRingGetNextFrameToRead(pRingBuf)) != NULL)
698	{
699	/*
700	* Check the state and then inspect the packet.
701	*/
702	if (pThis->enmRecvState != RECVSTATE_RUNNING)
703	{
704	STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
705	LogFlow(("drvR3IntNetRecvRun: returns VERR_STATE_CHANGED (state changed - #0)\n"));
706	return VERR_STATE_CHANGED;
707	}
708
709	Log2(("pHdr=%p offRead=%#x: %.8Rhxs\n", pHdr, pRingBuf->offReadX, pHdr));
710	uint8_t u8Type = pHdr->u8Type;
711	if ( ( u8Type == INTNETHDR_TYPE_FRAME
712	\|\| u8Type == INTNETHDR_TYPE_GSO)
713	&& !pThis->fLinkDown)
714	{
715	/*
716	* Check if there is room for the frame and pass it up.
717	*/
718	size_t cbFrame = pHdr->cbFrame;
719	int rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, 0);
720	if (rc == VINF_SUCCESS)
721	{
722	if (u8Type == INTNETHDR_TYPE_FRAME)
723	{
724	/*
725	* Normal frame.
726	*/
727	#ifdef LOG_ENABLED
728	if (LogIsEnabled())
729	{
730	uint64_t u64Now = RTTimeProgramNanoTS();
731	LogFlow(("drvR3IntNetRecvRun: %-4d bytes at %llu ns deltas: r=%llu t=%llu\n",
732	cbFrame, u64Now, u64Now - pThis->u64LastReceiveTS, u64Now - pThis->u64LastTransferTS));
733	pThis->u64LastReceiveTS = u64Now;
734	Log2(("drvR3IntNetRecvRun: cbFrame=%#x\n"
735	"%.*Rhxd\n",
736	cbFrame, cbFrame, IntNetHdrGetFramePtr(pHdr, pBuf)));
737	}
738	#endif
739	rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, IntNetHdrGetFramePtr(pHdr, pBuf), cbFrame);
740	AssertRC(rc);
741
742	/* skip to the next frame. */
743	IntNetRingSkipFrame(pRingBuf);
744	}
745	else
746	{
747	/*
748	* Generic segment offload frame (INTNETHDR_TYPE_GSO).
749	*/
750	STAM_COUNTER_INC(&pThis->StatReceivedGso);
751	PCPDMNETWORKGSO pGso = IntNetHdrGetGsoContext(pHdr, pBuf);
752	if (PDMNetGsoIsValid(pGso, cbFrame, cbFrame - sizeof(PDMNETWORKGSO)))
753	{
754	if (!pThis->pIAboveNet->pfnReceiveGso \|\|
755	RT_FAILURE(pThis->pIAboveNet->pfnReceiveGso(pThis->pIAboveNet,
756	(uint8_t *)(pGso + 1),
757	pHdr->cbFrame - sizeof(PDMNETWORKGSO),
758	pGso)))
759	{
760	/*
761	*
762	* This is where we do the offloading since this NIC
763	* does not support large receive offload (LRO).
764	*/
765	cbFrame -= sizeof(PDMNETWORKGSO);
766
767	uint8_t abHdrScratch[256];
768	uint32_t const cSegs = PDMNetGsoCalcSegmentCount(pGso, cbFrame);
769	#ifdef LOG_ENABLED
770	if (LogIsEnabled())
771	{
772	uint64_t u64Now = RTTimeProgramNanoTS();
773	LogFlow(("drvR3IntNetRecvRun: %-4d bytes at %llu ns deltas: r=%llu t=%llu; GSO - %u segs\n",
774	cbFrame, u64Now, u64Now - pThis->u64LastReceiveTS, u64Now - pThis->u64LastTransferTS, cSegs));
775	pThis->u64LastReceiveTS = u64Now;
776	Log2(("drvR3IntNetRecvRun: cbFrame=%#x type=%d cbHdrsTotal=%#x cbHdrsSeg=%#x Hdr1=%#x Hdr2=%#x MMS=%#x\n"
777	"%.*Rhxd\n",
778	cbFrame, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg, pGso->offHdr1, pGso->offHdr2, pGso->cbMaxSeg,
779	cbFrame - sizeof(*pGso), pGso + 1));
780	}
781	#endif
782	for (uint32_t iSeg = 0; iSeg < cSegs; iSeg++)
783	{
784	uint32_t cbSegFrame;
785	void pvSegFrame = PDMNetGsoCarveSegmentQD(pGso, (uint8_t )(pGso + 1), cbFrame,
786	abHdrScratch, iSeg, cSegs, &cbSegFrame);
787	rc = drvR3IntNetRecvWaitForSpace(pThis);
788	if (RT_FAILURE(rc))
789	{
790	Log(("drvR3IntNetRecvRun: drvR3IntNetRecvWaitForSpace -> %Rrc; iSeg=%u cSegs=%u\n", rc, iSeg, cSegs));
791	break; /* we drop the rest. */
792	}
793	rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pvSegFrame, cbSegFrame);
794	AssertRC(rc);
795	}
796	}
797	}
798	else
799	{
800	AssertMsgFailed(("cbFrame=%#x type=%d cbHdrsTotal=%#x cbHdrsSeg=%#x Hdr1=%#x Hdr2=%#x MMS=%#x\n",
801	cbFrame, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg, pGso->offHdr1, pGso->offHdr2, pGso->cbMaxSeg));
802	STAM_REL_COUNTER_INC(&pBuf->cStatBadFrames);
803	}
804
805	IntNetRingSkipFrame(pRingBuf);
806	}
807	}
808	else
809	{
810	/*
811	* Wait for sufficient space to become available and then retry.
812	*/
813	rc = drvR3IntNetRecvWaitForSpace(pThis);
814	if (RT_FAILURE(rc))
815	{
816	if (rc == VERR_INTERRUPTED)
817	{
818	/*
819	* NIC is going down, likely because the VM is being reset. Skip the frame.
820	*/
821	AssertMsg(IntNetIsValidFrameType(pHdr->u8Type), ("Unknown frame type %RX16! offRead=%#x\n", pHdr->u8Type, pRingBuf->offReadX));
822	IntNetRingSkipFrame(pRingBuf);
823	}
824	else
825	{
826	STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
827	LogFlow(("drvR3IntNetRecvRun: returns %Rrc (wait-for-space)\n", rc));
828	return rc;
829	}
830	}
831	}
832	}
833	else
834	{
835	/*
836	* Link down or unknown frame - skip to the next frame.
837	*/
838	AssertMsg(IntNetIsValidFrameType(pHdr->u8Type), ("Unknown frame type %RX16! offRead=%#x\n", pHdr->u8Type, pRingBuf->offReadX));
839	IntNetRingSkipFrame(pRingBuf);
840	STAM_REL_COUNTER_INC(&pBuf->cStatBadFrames);
841	}
842	} /* while more received data */
843
844	/*
845	* Wait for data, checking the state before we block.
846	*/
847	if (pThis->enmRecvState != RECVSTATE_RUNNING)
848	{
849	STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
850	LogFlow(("drvR3IntNetRecvRun: returns VINF_SUCCESS (state changed - #1)\n"));
851	return VERR_STATE_CHANGED;
852	}
853	INTNETIFWAITREQ WaitReq;
854	WaitReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
855	WaitReq.Hdr.cbReq = sizeof(WaitReq);
856	WaitReq.pSession = NIL_RTR0PTR;
857	WaitReq.hIf = pThis->hIf;
858	WaitReq.cMillies = 30000; /* 30s - don't wait forever, timeout now and then. */
859	STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
860	int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_WAIT, &WaitReq, sizeof(WaitReq));
861	if ( RT_FAILURE(rc)
862	&& rc != VERR_TIMEOUT
863	&& rc != VERR_INTERRUPTED)
864	{
865	LogFlow(("drvR3IntNetRecvRun: returns %Rrc\n", rc));
866	return rc;
867	}
868	STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
869	}
870	}
871
872
873	/**
874	* Asynchronous I/O thread for handling receive.
875	*
876	* @returns VINF_SUCCESS (ignored).
877	* @param hThreadSelf Thread handle.
878	* @param pvUser Pointer to a DRVINTNET structure.
879	*/
880	static DECLCALLBACK(int) drvR3IntNetRecvThread(RTTHREAD hThreadSelf, void *pvUser)
881	{
882	RT_NOREF(hThreadSelf);
883	PDRVINTNET pThis = (PDRVINTNET)pvUser;
884	LogFlow(("drvR3IntNetRecvThread: pThis=%p\n", pThis));
885	STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
886
887	/*
888	* The main loop - acting on state.
889	*/
890	for (;;)
891	{
892	RECVSTATE enmRecvState = pThis->enmRecvState;
893	switch (enmRecvState)
894	{
895	case RECVSTATE_SUSPENDED:
896	{
897	int rc = RTSemEventWait(pThis->hRecvEvt, 30000);
898	if ( RT_FAILURE(rc)
899	&& rc != VERR_TIMEOUT)
900	{
901	LogFlow(("drvR3IntNetRecvThread: returns %Rrc\n", rc));
902	return rc;
903	}
904	break;
905	}
906
907	case RECVSTATE_RUNNING:
908	{
909	int rc = drvR3IntNetRecvRun(pThis);
910	if ( rc != VERR_STATE_CHANGED
911	&& RT_FAILURE(rc))
912	{
913	LogFlow(("drvR3IntNetRecvThread: returns %Rrc\n", rc));
914	return rc;
915	}
916	break;
917	}
918
919	default:
920	AssertMsgFailed(("Invalid state %d\n", enmRecvState));
921	case RECVSTATE_TERMINATE:
922	LogFlow(("drvR3IntNetRecvThread: returns VINF_SUCCESS\n"));
923	return VINF_SUCCESS;
924	}
925	}
926	}
927
928
929	/* -=-=-=-=- PDMIBASERC -=-=-=-=- */
930
931	/**
932	* @interface_method_impl{PDMIBASERC,pfnQueryInterface}
933	*/
934	static DECLCALLBACK(RTRCPTR) drvR3IntNetIBaseRC_QueryInterface(PPDMIBASERC pInterface, const char *pszIID)
935	{
936	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, IBaseRC);
937
938	#if 0
939	PDMIBASERC_RETURN_INTERFACE(pThis->pDrvInsR3, pszIID, PDMINETWORKUP, &pThis->INetworkUpRC);
940	#else
941	RT_NOREF(pThis, pszIID);
942	#endif
943	return NIL_RTRCPTR;
944	}
945
946
947	/* -=-=-=-=- PDMIBASER0 -=-=-=-=- */
948
949	/**
950	* @interface_method_impl{PDMIBASER0,pfnQueryInterface}
951	*/
952	static DECLCALLBACK(RTR0PTR) drvR3IntNetIBaseR0_QueryInterface(PPDMIBASER0 pInterface, const char *pszIID)
953	{
954	PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, IBaseR0);
955	#ifdef VBOX_WITH_DRVINTNET_IN_R0
956	PDMIBASER0_RETURN_INTERFACE(pThis->pDrvInsR3, pszIID, PDMINETWORKUP, &pThis->INetworkUpR0);
957	#endif
958	return NIL_RTR0PTR;
959	}
960
961
962	/* -=-=-=-=- PDMIBASE -=-=-=-=- */
963
964	/**
965	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
966	*/
967	static DECLCALLBACK(void ) drvR3IntNetIBase_QueryInterface(PPDMIBASE pInterface, const char pszIID)
968	{
969	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
970	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
971
972	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
973	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASER0, &pThis->IBaseR0);
974	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASERC, &pThis->IBaseRC);
975	PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKUP, &pThis->INetworkUpR3);
976	return NULL;
977	}
978
979
980	/* -=-=-=-=- PDMDRVREG -=-=-=-=- */
981
982	/**
983	* Power Off notification.
984	*
985	* @param pDrvIns The driver instance.
986	*/
987	static DECLCALLBACK(void) drvR3IntNetPowerOff(PPDMDRVINS pDrvIns)
988	{
989	LogFlow(("drvR3IntNetPowerOff\n"));
990	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
991	if (!pThis->fActivateEarlyDeactivateLate)
992	{
993	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_SUSPENDED);
994	drvR3IntNetSetActive(pThis, false /* fActive */);
995	}
996	}
997
998
999	/**
1000	* drvR3IntNetResume helper.
1001	*/
1002	static int drvR3IntNetResumeSend(PDRVINTNET pThis, const void *pvBuf, size_t cb)
1003	{
1004	/*
1005	* Add the frame to the send buffer and push it onto the network.
1006	*/
1007	int rc = IntNetRingWriteFrame(&pThis->pBufR3->Send, pvBuf, (uint32_t)cb);
1008	if ( rc == VERR_BUFFER_OVERFLOW
1009	&& pThis->pBufR3->cbSend < cb)
1010	{
1011	INTNETIFSENDREQ SendReq;
1012	SendReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1013	SendReq.Hdr.cbReq = sizeof(SendReq);
1014	SendReq.pSession = NIL_RTR0PTR;
1015	SendReq.hIf = pThis->hIf;
1016	PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SEND, &SendReq, sizeof(SendReq));
1017
1018	rc = IntNetRingWriteFrame(&pThis->pBufR3->Send, pvBuf, (uint32_t)cb);
1019	}
1020
1021	if (RT_SUCCESS(rc))
1022	{
1023	INTNETIFSENDREQ SendReq;
1024	SendReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1025	SendReq.Hdr.cbReq = sizeof(SendReq);
1026	SendReq.pSession = NIL_RTR0PTR;
1027	SendReq.hIf = pThis->hIf;
1028	rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SEND, &SendReq, sizeof(SendReq));
1029	}
1030
1031	AssertRC(rc);
1032	return rc;
1033	}
1034
1035
1036	/**
1037	* Resume notification.
1038	*
1039	* @param pDrvIns The driver instance.
1040	*/
1041	static DECLCALLBACK(void) drvR3IntNetResume(PPDMDRVINS pDrvIns)
1042	{
1043	LogFlow(("drvR3IntNetPowerResume\n"));
1044	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1045	VMRESUMEREASON enmReason = PDMDrvHlpVMGetResumeReason(pDrvIns);
1046
1047	if (!pThis->fActivateEarlyDeactivateLate)
1048	{
1049	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1050	RTSemEventSignal(pThis->hRecvEvt);
1051	drvR3IntNetUpdateMacAddress(pThis); /* (could be a state restore) */
1052	drvR3IntNetSetActive(pThis, true /* fActive */);
1053	}
1054
1055	switch (enmReason)
1056	{
1057	case VMRESUMEREASON_HOST_RESUME:
1058	{
1059	uint32_t u32TrunkType;
1060	int rc = CFGMR3QueryU32(pDrvIns->pCfg, "TrunkType", &u32TrunkType);
1061	AssertRC(rc);
1062
1063	/*
1064	* Only do the disconnect for bridged networking. Host-only and
1065	* internal networks are not affected by a host resume.
1066	*/
1067	if ( RT_SUCCESS(rc)
1068	&& u32TrunkType == kIntNetTrunkType_NetFlt)
1069	{
1070	rc = pThis->pIAboveConfigR3->pfnSetLinkState(pThis->pIAboveConfigR3,
1071	PDMNETWORKLINKSTATE_DOWN_RESUME);
1072	AssertRC(rc);
1073	}
1074	break;
1075	}
1076	case VMRESUMEREASON_TELEPORTED:
1077	case VMRESUMEREASON_TELEPORT_FAILED:
1078	{
1079	if ( PDMDrvHlpVMTeleportedAndNotFullyResumedYet(pDrvIns)
1080	&& pThis->pIAboveConfigR3)
1081	{
1082	/*
1083	* We've just been teleported and need to drop a hint to the switch
1084	* since we're likely to have changed to a different port. We just
1085	* push out some ethernet frame that doesn't mean anything to anyone.
1086	* For this purpose ethertype 0x801e was chosen since it was registered
1087	* to Sun (dunno what it is/was used for though).
1088	*/
1089	union
1090	{
1091	RTNETETHERHDR Hdr;
1092	uint8_t ab[128];
1093	} Frame;
1094	RT_ZERO(Frame);
1095	Frame.Hdr.DstMac.au16[0] = 0xffff;
1096	Frame.Hdr.DstMac.au16[1] = 0xffff;
1097	Frame.Hdr.DstMac.au16[2] = 0xffff;
1098	Frame.Hdr.EtherType = RT_H2BE_U16_C(0x801e);
1099	int rc = pThis->pIAboveConfigR3->pfnGetMac(pThis->pIAboveConfigR3,
1100	&Frame.Hdr.SrcMac);
1101	if (RT_SUCCESS(rc))
1102	rc = drvR3IntNetResumeSend(pThis, &Frame, sizeof(Frame));
1103	if (RT_FAILURE(rc))
1104	LogRel(("IntNet#%u: Sending dummy frame failed: %Rrc\n",
1105	pDrvIns->iInstance, rc));
1106	}
1107	break;
1108	}
1109	default: /* ignore every other resume reason else */
1110	break;
1111	} /* end of switch(enmReason) */
1112	}
1113
1114
1115	/**
1116	* Suspend notification.
1117	*
1118	* @param pDrvIns The driver instance.
1119	*/
1120	static DECLCALLBACK(void) drvR3IntNetSuspend(PPDMDRVINS pDrvIns)
1121	{
1122	LogFlow(("drvR3IntNetPowerSuspend\n"));
1123	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1124	if (!pThis->fActivateEarlyDeactivateLate)
1125	{
1126	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_SUSPENDED);
1127	drvR3IntNetSetActive(pThis, false /* fActive */);
1128	}
1129	}
1130
1131
1132	/**
1133	* Power On notification.
1134	*
1135	* @param pDrvIns The driver instance.
1136	*/
1137	static DECLCALLBACK(void) drvR3IntNetPowerOn(PPDMDRVINS pDrvIns)
1138	{
1139	LogFlow(("drvR3IntNetPowerOn\n"));
1140	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1141	if (!pThis->fActivateEarlyDeactivateLate)
1142	{
1143	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1144	RTSemEventSignal(pThis->hRecvEvt);
1145	drvR3IntNetUpdateMacAddress(pThis);
1146	drvR3IntNetSetActive(pThis, true /* fActive */);
1147	}
1148	}
1149
1150
1151	/**
1152	* @interface_method_impl{PDMDRVREG,pfnRelocate}
1153	*/
1154	static DECLCALLBACK(void) drvR3IntNetRelocate(PPDMDRVINS pDrvIns, RTGCINTPTR offDelta)
1155	{
1156	/* nothing to do here yet */
1157	RT_NOREF(pDrvIns, offDelta);
1158	}
1159
1160
1161	/**
1162	* Destruct a driver instance.
1163	*
1164	* Most VM resources are freed by the VM. This callback is provided so that any non-VM
1165	* resources can be freed correctly.
1166	*
1167	* @param pDrvIns The driver instance data.
1168	*/
1169	static DECLCALLBACK(void) drvR3IntNetDestruct(PPDMDRVINS pDrvIns)
1170	{
1171	LogFlow(("drvR3IntNetDestruct\n"));
1172	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1173	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1174
1175	/*
1176	* Indicate to the receive thread that it's time to quit.
1177	*/
1178	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_TERMINATE);
1179	ASMAtomicXchgSize(&pThis->fLinkDown, true);
1180	RTSEMEVENT hRecvEvt = pThis->hRecvEvt;
1181	pThis->hRecvEvt = NIL_RTSEMEVENT;
1182
1183	if (hRecvEvt != NIL_RTSEMEVENT)
1184	RTSemEventSignal(hRecvEvt);
1185
1186	if (pThis->hIf != INTNET_HANDLE_INVALID)
1187	{
1188	INTNETIFABORTWAITREQ AbortWaitReq;
1189	AbortWaitReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1190	AbortWaitReq.Hdr.cbReq = sizeof(AbortWaitReq);
1191	AbortWaitReq.pSession = NIL_RTR0PTR;
1192	AbortWaitReq.hIf = pThis->hIf;
1193	AbortWaitReq.fNoMoreWaits = true;
1194	int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_ABORT_WAIT, &AbortWaitReq, sizeof(AbortWaitReq));
1195	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_SEM_DESTROYED, ("%Rrc\n", rc)); RT_NOREF_PV(rc);
1196	}
1197
1198	/*
1199	* Wait for the threads to terminate.
1200	*/
1201	if (pThis->pXmitThread)
1202	{
1203	int rc = PDMR3ThreadDestroy(pThis->pXmitThread, NULL);
1204	AssertRC(rc);
1205	pThis->pXmitThread = NULL;
1206	}
1207
1208	if (pThis->hRecvThread != NIL_RTTHREAD)
1209	{
1210	int rc = RTThreadWait(pThis->hRecvThread, 5000, NULL);
1211	AssertRC(rc);
1212	pThis->hRecvThread = NIL_RTTHREAD;
1213	}
1214
1215	/*
1216	* Deregister statistics in case we're being detached.
1217	*/
1218	if (pThis->pBufR3)
1219	{
1220	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cStatFrames);
1221	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cbStatWritten);
1222	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cOverflows);
1223	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cStatFrames);
1224	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cbStatWritten);
1225	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cOverflows);
1226	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatYieldsOk);
1227	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatYieldsNok);
1228	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatLost);
1229	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatBadFrames);
1230	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatSend1);
1231	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatSend2);
1232	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatRecv1);
1233	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatRecv2);
1234	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatReserved);
1235	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReceivedGso);
1236	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatSentGso);
1237	#ifdef VBOX_WITH_STATISTICS
1238	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReceive);
1239	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatTransmit);
1240	#endif
1241	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitWakeupR0);
1242	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitWakeupR3);
1243	PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitProcessRing);
1244	}
1245
1246	/*
1247	* Close the interface
1248	*/
1249	if (pThis->hIf != INTNET_HANDLE_INVALID)
1250	{
1251	INTNETIFCLOSEREQ CloseReq;
1252	CloseReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1253	CloseReq.Hdr.cbReq = sizeof(CloseReq);
1254	CloseReq.pSession = NIL_RTR0PTR;
1255	CloseReq.hIf = pThis->hIf;
1256	pThis->hIf = INTNET_HANDLE_INVALID;
1257	int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_CLOSE, &CloseReq, sizeof(CloseReq));
1258	AssertRC(rc);
1259	}
1260
1261
1262	/*
1263	* Destroy the semaphores, S/G cache and xmit lock.
1264	*/
1265	if (hRecvEvt != NIL_RTSEMEVENT)
1266	RTSemEventDestroy(hRecvEvt);
1267
1268	if (pThis->hXmitEvt != NIL_SUPSEMEVENT)
1269	{
1270	SUPSemEventClose(pThis->pSupDrvSession, pThis->hXmitEvt);
1271	pThis->hXmitEvt = NIL_SUPSEMEVENT;
1272	}
1273
1274	RTMemCacheDestroy(pThis->hSgCache);
1275	pThis->hSgCache = NIL_RTMEMCACHE;
1276
1277	if (PDMCritSectIsInitialized(&pThis->XmitLock))
1278	PDMR3CritSectDelete(&pThis->XmitLock);
1279	}
1280
1281
1282	/**
1283	* Queries a policy config value and translates it into open network flag.
1284	*
1285	* @returns VBox status code (error set on failure).
1286	* @param pDrvIns The driver instance.
1287	* @param pszName The value name.
1288	* @param paFlags The open network flag descriptors.
1289	* @param cFlags The number of descriptors.
1290	* @param fFlags The fixed flag.
1291	* @param pfFlags The flags variable to update.
1292	*/
1293	static int drvIntNetR3CfgGetPolicy(PPDMDRVINS pDrvIns, const char *pszName, PCDRVINTNETFLAG paFlags, size_t cFlags,
1294	uint32_t fFixedFlag, uint32_t *pfFlags)
1295	{
1296	char szValue[64];
1297	int rc = CFGMR3QueryString(pDrvIns->pCfg, pszName, szValue, sizeof(szValue));
1298	if (RT_FAILURE(rc))
1299	{
1300	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1301	return VINF_SUCCESS;
1302	return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1303	N_("Configuration error: Failed to query value of \"%s\""), pszName);
1304	}
1305
1306	/*
1307	* Check for +fixed first, so it can be stripped off.
1308	*/
1309	char *pszSep = strpbrk(szValue, "+,;");
1310	if (pszSep)
1311	{
1312	*pszSep++ = '\0';
1313	const char *pszFixed = RTStrStripL(pszSep);
1314	if (strcmp(pszFixed, "fixed"))
1315	{
1316	*pszSep = '+';
1317	return PDMDrvHlpVMSetError(pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1318	N_("Configuration error: The value of \"%s\" is unknown: \"%s\""), pszName, szValue);
1319	}
1320	*pfFlags \|= fFixedFlag;
1321	RTStrStripR(szValue);
1322	}
1323
1324	/*
1325	* Match against the flag values.
1326	*/
1327	size_t i = cFlags;
1328	while (i-- > 0)
1329	if (!strcmp(paFlags[i].pszChoice, szValue))
1330	{
1331	*pfFlags \|= paFlags[i].fFlag;
1332	return VINF_SUCCESS;
1333	}
1334
1335	if (!strcmp(szValue, "none"))
1336	return VINF_SUCCESS;
1337
1338	if (!strcmp(szValue, "fixed"))
1339	{
1340	*pfFlags \|= fFixedFlag;
1341	return VINF_SUCCESS;
1342	}
1343
1344	return PDMDrvHlpVMSetError(pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1345	N_("Configuration error: The value of \"%s\" is unknown: \"%s\""), pszName, szValue);
1346	}
1347
1348
1349	/**
1350	* Construct a TAP network transport driver instance.
1351	*
1352	* @copydoc FNPDMDRVCONSTRUCT
1353	*/
1354	static DECLCALLBACK(int) drvR3IntNetConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1355	{
1356	RT_NOREF(fFlags);
1357	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1358	PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1359	bool f;
1360
1361	/*
1362	* Init the static parts.
1363	*/
1364	pThis->pDrvInsR3 = pDrvIns;
1365	#ifdef VBOX_WITH_DRVINTNET_IN_R0
1366	pThis->pDrvInsR0 = PDMDRVINS_2_R0PTR(pDrvIns);
1367	#endif
1368	pThis->hIf = INTNET_HANDLE_INVALID;
1369	pThis->hRecvThread = NIL_RTTHREAD;
1370	pThis->hRecvEvt = NIL_RTSEMEVENT;
1371	pThis->pXmitThread = NULL;
1372	pThis->hXmitEvt = NIL_SUPSEMEVENT;
1373	pThis->pSupDrvSession = PDMDrvHlpGetSupDrvSession(pDrvIns);
1374	pThis->hSgCache = NIL_RTMEMCACHE;
1375	pThis->enmRecvState = RECVSTATE_SUSPENDED;
1376	pThis->fActivateEarlyDeactivateLate = false;
1377	/* IBase* */
1378	pDrvIns->IBase.pfnQueryInterface = drvR3IntNetIBase_QueryInterface;
1379	pThis->IBaseR0.pfnQueryInterface = drvR3IntNetIBaseR0_QueryInterface;
1380	pThis->IBaseRC.pfnQueryInterface = drvR3IntNetIBaseRC_QueryInterface;
1381	/* INetworkUp */
1382	pThis->INetworkUpR3.pfnBeginXmit = drvIntNetUp_BeginXmit;
1383	pThis->INetworkUpR3.pfnAllocBuf = drvIntNetUp_AllocBuf;
1384	pThis->INetworkUpR3.pfnFreeBuf = drvIntNetUp_FreeBuf;
1385	pThis->INetworkUpR3.pfnSendBuf = drvIntNetUp_SendBuf;
1386	pThis->INetworkUpR3.pfnEndXmit = drvIntNetUp_EndXmit;
1387	pThis->INetworkUpR3.pfnSetPromiscuousMode = drvIntNetUp_SetPromiscuousMode;
1388	pThis->INetworkUpR3.pfnNotifyLinkChanged = drvR3IntNetUp_NotifyLinkChanged;
1389
1390	/*
1391	* Validate the config.
1392	*/
1393	PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns,
1394	"Network"
1395	"\|Trunk"
1396	"\|TrunkType"
1397	"\|ReceiveBufferSize"
1398	"\|SendBufferSize"
1399	"\|SharedMacOnWire"
1400	"\|RestrictAccess"
1401	"\|RequireExactPolicyMatch"
1402	"\|RequireAsRestrictivePolicy"
1403	"\|AccessPolicy"
1404	"\|PromiscPolicyClients"
1405	"\|PromiscPolicyHost"
1406	"\|PromiscPolicyWire"
1407	"\|IfPolicyPromisc"
1408	"\|TrunkPolicyHost"
1409	"\|TrunkPolicyWire"
1410	"\|IsService"
1411	"\|IgnoreConnectFailure"
1412	"\|Workaround1",
1413	"");
1414
1415	/*
1416	* Check that no-one is attached to us.
1417	*/
1418	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
1419	("Configuration error: Not possible to attach anything to this driver!\n"),
1420	VERR_PDM_DRVINS_NO_ATTACH);
1421
1422	/*
1423	* Query the network port interface.
1424	*/
1425	pThis->pIAboveNet = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKDOWN);
1426	if (!pThis->pIAboveNet)
1427	{
1428	AssertMsgFailed(("Configuration error: the above device/driver didn't export the network port interface!\n"));
1429	return VERR_PDM_MISSING_INTERFACE_ABOVE;
1430	}
1431	pThis->pIAboveConfigR3 = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKCONFIG);
1432
1433	/*
1434	* Read the configuration.
1435	*/
1436	INTNETOPENREQ OpenReq;
1437	RT_ZERO(OpenReq);
1438	OpenReq.Hdr.cbReq = sizeof(OpenReq);
1439	OpenReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1440	OpenReq.pSession = NIL_RTR0PTR;
1441
1442	/** @cfgm{Network, string}
1443	* The name of the internal network to connect to.
1444	*/
1445	int rc = CFGMR3QueryString(pCfg, "Network", OpenReq.szNetwork, sizeof(OpenReq.szNetwork));
1446	if (RT_FAILURE(rc))
1447	return PDMDRV_SET_ERROR(pDrvIns, rc,
1448	N_("Configuration error: Failed to get the \"Network\" value"));
1449	strcpy(pThis->szNetwork, OpenReq.szNetwork);
1450
1451	/** @cfgm{TrunkType, uint32_t, kIntNetTrunkType_None}
1452	* The trunk connection type see INTNETTRUNKTYPE.
1453	*/
1454	uint32_t u32TrunkType;
1455	rc = CFGMR3QueryU32(pCfg, "TrunkType", &u32TrunkType);
1456	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1457	u32TrunkType = kIntNetTrunkType_None;
1458	else if (RT_FAILURE(rc))
1459	return PDMDRV_SET_ERROR(pDrvIns, rc,
1460	N_("Configuration error: Failed to get the \"TrunkType\" value"));
1461	OpenReq.enmTrunkType = (INTNETTRUNKTYPE)u32TrunkType;
1462
1463	/** @cfgm{Trunk, string, ""}
1464	* The name of the trunk connection.
1465	*/
1466	rc = CFGMR3QueryString(pCfg, "Trunk", OpenReq.szTrunk, sizeof(OpenReq.szTrunk));
1467	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1468	OpenReq.szTrunk[0] = '\0';
1469	else if (RT_FAILURE(rc))
1470	return PDMDRV_SET_ERROR(pDrvIns, rc,
1471	N_("Configuration error: Failed to get the \"Trunk\" value"));
1472
1473	OpenReq.fFlags = 0;
1474
1475	/** @cfgm{SharedMacOnWire, boolean, false}
1476	* Whether to shared the MAC address of the host interface when using the wire. When
1477	* attaching to a wireless NIC this option is usually a requirement.
1478	*/
1479	bool fSharedMacOnWire;
1480	rc = CFGMR3QueryBoolDef(pCfg, "SharedMacOnWire", &fSharedMacOnWire, false);
1481	if (RT_FAILURE(rc))
1482	return PDMDRV_SET_ERROR(pDrvIns, rc,
1483	N_("Configuration error: Failed to get the \"SharedMacOnWire\" value"));
1484	if (fSharedMacOnWire)
1485	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE;
1486
1487	/** @cfgm{RestrictAccess, boolean, true}
1488	* Whether to restrict the access to the network or if it should be public.
1489	* Everyone on the computer can connect to a public network.
1490	* @deprecated Use AccessPolicy instead.
1491	*/
1492	rc = CFGMR3QueryBool(pCfg, "RestrictAccess", &f);
1493	if (RT_SUCCESS(rc))
1494	{
1495	if (f)
1496	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_ACCESS_RESTRICTED;
1497	else
1498	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_ACCESS_PUBLIC;
1499	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_ACCESS_FIXED;
1500	}
1501	else if (rc != VERR_CFGM_VALUE_NOT_FOUND)
1502	return PDMDRV_SET_ERROR(pDrvIns, rc,
1503	N_("Configuration error: Failed to get the \"RestrictAccess\" value"));
1504
1505	/** @cfgm{RequireExactPolicyMatch, boolean, false}
1506	* Whether to require that the current security and promiscuous policies of
1507	* the network is exactly as the ones specified in this open network
1508	* request. Use this with RequireAsRestrictivePolicy to prevent
1509	* restrictions from being lifted. If no further policy changes are
1510	* desired, apply the relevant fixed flags. */
1511	rc = CFGMR3QueryBoolDef(pCfg, "RequireExactPolicyMatch", &f, false);
1512	if (RT_FAILURE(rc))
1513	return PDMDRV_SET_ERROR(pDrvIns, rc,
1514	N_("Configuration error: Failed to get the \"RequireExactPolicyMatch\" value"));
1515	if (f)
1516	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_REQUIRE_EXACT;
1517
1518	/** @cfgm{RequireAsRestrictivePolicy, boolean, false}
1519	* Whether to require that the security and promiscuous policies of the
1520	* network is at least as restrictive as specified this request specifies
1521	* and prevent them being lifted later on.
1522	*/
1523	rc = CFGMR3QueryBoolDef(pCfg, "RequireAsRestrictivePolicy", &f, false);
1524	if (RT_FAILURE(rc))
1525	return PDMDRV_SET_ERROR(pDrvIns, rc,
1526	N_("Configuration error: Failed to get the \"RequireAsRestrictivePolicy\" value"));
1527	if (f)
1528	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_REQUIRE_AS_RESTRICTIVE_POLICIES;
1529
1530	/** @cfgm{AccessPolicy, string, "none"}
1531	* The access policy of the network:
1532	* public, public+fixed, restricted, restricted+fixed, none or fixed.
1533	*
1534	* A "public" network is accessible to everyone on the same host, while a
1535	* "restricted" one is only accessible to VMs & services started by the
1536	* same user. The "none" policy, which is the default, means no policy
1537	* change or choice is made and that the current (existing network) or
1538	* default (new) policy should be used. */
1539	static const DRVINTNETFLAG s_aAccessPolicyFlags[] =
1540	{
1541	{ "public", INTNET_OPEN_FLAGS_ACCESS_PUBLIC },
1542	{ "restricted", INTNET_OPEN_FLAGS_ACCESS_RESTRICTED }
1543	};
1544	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "AccessPolicy", &s_aAccessPolicyFlags[0], RT_ELEMENTS(s_aAccessPolicyFlags),
1545	INTNET_OPEN_FLAGS_ACCESS_FIXED, &OpenReq.fFlags);
1546	AssertRCReturn(rc, rc);
1547
1548	/** @cfgm{PromiscPolicyClients, string, "none"}
1549	* The network wide promiscuous mode policy for client (non-trunk)
1550	* interfaces: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1551	static const DRVINTNETFLAG s_aPromiscPolicyClient[] =
1552	{
1553	{ "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_CLIENTS },
1554	{ "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_CLIENTS }
1555	};
1556	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyClients", &s_aPromiscPolicyClient[0], RT_ELEMENTS(s_aPromiscPolicyClient),
1557	INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1558	AssertRCReturn(rc, rc);
1559	/** @cfgm{PromiscPolicyHost, string, "none"}
1560	* The promiscuous mode policy for the trunk-host
1561	* connection: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1562	static const DRVINTNETFLAG s_aPromiscPolicyHost[] =
1563	{
1564	{ "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_HOST },
1565	{ "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_HOST }
1566	};
1567	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyHost", &s_aPromiscPolicyHost[0], RT_ELEMENTS(s_aPromiscPolicyHost),
1568	INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1569	AssertRCReturn(rc, rc);
1570	/** @cfgm{PromiscPolicyWire, string, "none"}
1571	* The promiscuous mode policy for the trunk-host
1572	* connection: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1573	static const DRVINTNETFLAG s_aPromiscPolicyWire[] =
1574	{
1575	{ "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_WIRE },
1576	{ "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_WIRE }
1577	};
1578	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyWire", &s_aPromiscPolicyWire[0], RT_ELEMENTS(s_aPromiscPolicyWire),
1579	INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1580	AssertRCReturn(rc, rc);
1581
1582
1583	/** @cfgm{IfPolicyPromisc, string, "none"}
1584	* The promiscuous mode policy for this
1585	* interface: deny, deny+fixed, allow-all, allow-all+fixed, allow-network,
1586	* allow-network+fixed, none or fixed. */
1587	static const DRVINTNETFLAG s_aIfPolicyPromisc[] =
1588	{
1589	{ "allow-all", INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW \| INTNET_OPEN_FLAGS_IF_PROMISC_SEE_TRUNK },
1590	{ "allow-network", INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW \| INTNET_OPEN_FLAGS_IF_PROMISC_NO_TRUNK },
1591	{ "deny", INTNET_OPEN_FLAGS_IF_PROMISC_DENY }
1592	};
1593	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "IfPolicyPromisc", &s_aIfPolicyPromisc[0], RT_ELEMENTS(s_aIfPolicyPromisc),
1594	INTNET_OPEN_FLAGS_IF_FIXED, &OpenReq.fFlags);
1595	AssertRCReturn(rc, rc);
1596
1597
1598	/** @cfgm{TrunkPolicyHost, string, "none"}
1599	* The trunk-host policy: promisc, promisc+fixed, enabled, enabled+fixed,
1600	* disabled, disabled+fixed, none or fixed
1601	*
1602	* This can be used to prevent packages to be routed to the host. */
1603	static const DRVINTNETFLAG s_aTrunkPolicyHost[] =
1604	{
1605	{ "promisc", INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED \| INTNET_OPEN_FLAGS_TRUNK_HOST_PROMISC_MODE },
1606	{ "enabled", INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED },
1607	{ "disabled", INTNET_OPEN_FLAGS_TRUNK_HOST_DISABLED }
1608	};
1609	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "TrunkPolicyHost", &s_aTrunkPolicyHost[0], RT_ELEMENTS(s_aTrunkPolicyHost),
1610	INTNET_OPEN_FLAGS_TRUNK_FIXED, &OpenReq.fFlags);
1611	AssertRCReturn(rc, rc);
1612	/** @cfgm{TrunkPolicyWire, string, "none"}
1613	* The trunk-host policy: promisc, promisc+fixed, enabled, enabled+fixed,
1614	* disabled, disabled+fixed, none or fixed.
1615	*
1616	* This can be used to prevent packages to be routed to the wire. */
1617	static const DRVINTNETFLAG s_aTrunkPolicyWire[] =
1618	{
1619	{ "promisc", INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED \| INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE },
1620	{ "enabled", INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED },
1621	{ "disabled", INTNET_OPEN_FLAGS_TRUNK_WIRE_DISABLED }
1622	};
1623	rc = drvIntNetR3CfgGetPolicy(pDrvIns, "TrunkPolicyWire", &s_aTrunkPolicyWire[0], RT_ELEMENTS(s_aTrunkPolicyWire),
1624	INTNET_OPEN_FLAGS_TRUNK_FIXED, &OpenReq.fFlags);
1625	AssertRCReturn(rc, rc);
1626
1627
1628	/** @cfgm{ReceiveBufferSize, uint32_t, 318 KB}
1629	* The size of the receive buffer.
1630	*/
1631	rc = CFGMR3QueryU32(pCfg, "ReceiveBufferSize", &OpenReq.cbRecv);
1632	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1633	OpenReq.cbRecv = 318 * _1K ;
1634	else if (RT_FAILURE(rc))
1635	return PDMDRV_SET_ERROR(pDrvIns, rc,
1636	N_("Configuration error: Failed to get the \"ReceiveBufferSize\" value"));
1637
1638	/** @cfgm{SendBufferSize, uint32_t, 196 KB}
1639	* The size of the send (transmit) buffer.
1640	* This should be more than twice the size of the larges frame size because
1641	* the ring buffer is very simple and doesn't support splitting up frames
1642	* nor inserting padding. So, if this is too close to the frame size the
1643	* header will fragment the buffer such that the frame won't fit on either
1644	* side of it and the code will get very upset about it all.
1645	*/
1646	rc = CFGMR3QueryU32(pCfg, "SendBufferSize", &OpenReq.cbSend);
1647	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1648	OpenReq.cbSend = RT_ALIGN_Z(VBOX_MAX_GSO_SIZE * 3, _1K);
1649	else if (RT_FAILURE(rc))
1650	return PDMDRV_SET_ERROR(pDrvIns, rc,
1651	N_("Configuration error: Failed to get the \"SendBufferSize\" value"));
1652	if (OpenReq.cbSend < 128)
1653	return PDMDRV_SET_ERROR(pDrvIns, rc,
1654	N_("Configuration error: The \"SendBufferSize\" value is too small"));
1655	if (OpenReq.cbSend < VBOX_MAX_GSO_SIZE * 3)
1656	LogRel(("DrvIntNet: Warning! SendBufferSize=%u, Recommended minimum size %u butes.\n", OpenReq.cbSend, VBOX_MAX_GSO_SIZE * 4));
1657
1658	/** @cfgm{IsService, boolean, true}
1659	* This alterns the way the thread is suspended and resumed. When it's being used by
1660	* a service such as LWIP/iSCSI it shouldn't suspend immediately like for a NIC.
1661	*/
1662	rc = CFGMR3QueryBool(pCfg, "IsService", &pThis->fActivateEarlyDeactivateLate);
1663	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1664	pThis->fActivateEarlyDeactivateLate = false;
1665	else if (RT_FAILURE(rc))
1666	return PDMDRV_SET_ERROR(pDrvIns, rc,
1667	N_("Configuration error: Failed to get the \"IsService\" value"));
1668
1669
1670	/** @cfgm{IgnoreConnectFailure, boolean, false}
1671	* When set only raise a runtime error if we cannot connect to the internal
1672	* network. */
1673	bool fIgnoreConnectFailure;
1674	rc = CFGMR3QueryBoolDef(pCfg, "IgnoreConnectFailure", &fIgnoreConnectFailure, false);
1675	if (RT_FAILURE(rc))
1676	return PDMDRV_SET_ERROR(pDrvIns, rc,
1677	N_("Configuration error: Failed to get the \"IgnoreConnectFailure\" value"));
1678
1679	/** @cfgm{Workaround1, boolean, depends}
1680	* Enables host specific workarounds, the default is depends on the whether
1681	* we think the host requires it or not.
1682	*/
1683	bool fWorkaround1 = false;
1684	#ifdef RT_OS_DARWIN
1685	if (OpenReq.fFlags & INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE)
1686	{
1687	char szKrnlVer[256];
1688	RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szKrnlVer, sizeof(szKrnlVer));
1689	if (strcmp(szKrnlVer, "10.7.0") >= 0)
1690	{
1691	LogRel(("IntNet#%u: Enables the workaround (ip_tos=0) for the little endian ip header checksum problem\n"));
1692	fWorkaround1 = true;
1693	}
1694	}
1695	#endif
1696	rc = CFGMR3QueryBoolDef(pCfg, "Workaround1", &fWorkaround1, fWorkaround1);
1697	if (RT_FAILURE(rc))
1698	return PDMDRV_SET_ERROR(pDrvIns, rc,
1699	N_("Configuration error: Failed to get the \"Workaround1\" value"));
1700	if (fWorkaround1)
1701	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_WORKAROUND_1;
1702
1703	LogRel(("IntNet#%u: szNetwork={%s} enmTrunkType=%d szTrunk={%s} fFlags=%#x cbRecv=%u cbSend=%u fIgnoreConnectFailure=%RTbool\n",
1704	pDrvIns->iInstance, OpenReq.szNetwork, OpenReq.enmTrunkType, OpenReq.szTrunk, OpenReq.fFlags,
1705	OpenReq.cbRecv, OpenReq.cbSend, fIgnoreConnectFailure));
1706
1707	#ifdef RT_OS_DARWIN
1708	/* Temporary hack: attach to a network with the name 'if=en0' and you're hitting the wire. */
1709	if ( !OpenReq.szTrunk[0]
1710	&& OpenReq.enmTrunkType == kIntNetTrunkType_None
1711	&& !strncmp(pThis->szNetwork, RT_STR_TUPLE("if=en"))
1712	&& RT_C_IS_DIGIT(pThis->szNetwork[sizeof("if=en") - 1])
1713	&& !pThis->szNetwork[sizeof("if=en")])
1714	{
1715	OpenReq.enmTrunkType = kIntNetTrunkType_NetFlt;
1716	strcpy(OpenReq.szTrunk, &pThis->szNetwork[sizeof("if=") - 1]);
1717	}
1718	/* Temporary hack: attach to a network with the name 'wif=en0' and you're on the air. */
1719	if ( !OpenReq.szTrunk[0]
1720	&& OpenReq.enmTrunkType == kIntNetTrunkType_None
1721	&& !strncmp(pThis->szNetwork, RT_STR_TUPLE("wif=en"))
1722	&& RT_C_IS_DIGIT(pThis->szNetwork[sizeof("wif=en") - 1])
1723	&& !pThis->szNetwork[sizeof("wif=en")])
1724	{
1725	OpenReq.enmTrunkType = kIntNetTrunkType_NetFlt;
1726	OpenReq.fFlags \|= INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE;
1727	strcpy(OpenReq.szTrunk, &pThis->szNetwork[sizeof("wif=") - 1]);
1728	}
1729	#endif /* DARWIN */
1730
1731	/*
1732	* Create the event semaphore, S/G cache and xmit critsect.
1733	*/
1734	rc = RTSemEventCreate(&pThis->hRecvEvt);
1735	if (RT_FAILURE(rc))
1736	return rc;
1737	rc = RTMemCacheCreate(&pThis->hSgCache, sizeof(PDMSCATTERGATHER), 0, UINT32_MAX, NULL, NULL, pThis, 0);
1738	if (RT_FAILURE(rc))
1739	return rc;
1740	rc = PDMDrvHlpCritSectInit(pDrvIns, &pThis->XmitLock, RT_SRC_POS, "IntNetXmit");
1741	if (RT_FAILURE(rc))
1742	return rc;
1743
1744	/*
1745	* Create the interface.
1746	*/
1747	OpenReq.hIf = INTNET_HANDLE_INVALID;
1748	rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_OPEN, &OpenReq, sizeof(OpenReq));
1749	if (RT_FAILURE(rc))
1750	{
1751	if (fIgnoreConnectFailure)
1752	{
1753	/*
1754	* During VM restore it is fatal if the network is not available because the
1755	* VM settings are locked and the user has no chance to fix network settings.
1756	* Therefore don't abort but just raise a runtime warning.
1757	*/
1758	PDMDrvHlpVMSetRuntimeError(pDrvIns, 0 /fFlags/, "HostIfNotConnecting",
1759	N_ ("Cannot connect to the network interface '%s'. The virtual "
1760	"network card will appear to work but the guest will not "
1761	"be able to connect. Please choose a different network in the "
1762	"network settings"), OpenReq.szTrunk);
1763
1764	return VERR_PDM_NO_ATTACHED_DRIVER;
1765	}
1766	return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1767	N_("Failed to open/create the internal network '%s'"), pThis->szNetwork);
1768	}
1769
1770	AssertRelease(OpenReq.hIf != INTNET_HANDLE_INVALID);
1771	pThis->hIf = OpenReq.hIf;
1772	Log(("IntNet%d: hIf=%RX32 '%s'\n", pDrvIns->iInstance, pThis->hIf, pThis->szNetwork));
1773
1774	/*
1775	* Get default buffer.
1776	*/
1777	INTNETIFGETBUFFERPTRSREQ GetBufferPtrsReq;
1778	GetBufferPtrsReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1779	GetBufferPtrsReq.Hdr.cbReq = sizeof(GetBufferPtrsReq);
1780	GetBufferPtrsReq.pSession = NIL_RTR0PTR;
1781	GetBufferPtrsReq.hIf = pThis->hIf;
1782	GetBufferPtrsReq.pRing3Buf = NULL;
1783	GetBufferPtrsReq.pRing0Buf = NIL_RTR0PTR;
1784	rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS, &GetBufferPtrsReq, sizeof(GetBufferPtrsReq));
1785	if (RT_FAILURE(rc))
1786	return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1787	N_("Failed to get ring-3 buffer for the newly created interface to '%s'"), pThis->szNetwork);
1788	AssertRelease(VALID_PTR(GetBufferPtrsReq.pRing3Buf));
1789	pThis->pBufR3 = GetBufferPtrsReq.pRing3Buf;
1790	pThis->pBufR0 = GetBufferPtrsReq.pRing0Buf;
1791
1792	/*
1793	* Register statistics.
1794	*/
1795	PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->pBufR3->Recv.cbStatWritten, "Bytes/Received", STAMUNIT_BYTES, "Number of received bytes.");
1796	PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->pBufR3->Send.cbStatWritten, "Bytes/Sent", STAMUNIT_BYTES, "Number of sent bytes.");
1797	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Recv.cOverflows, "Overflows/Recv", "Number overflows.");
1798	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Send.cOverflows, "Overflows/Sent", "Number overflows.");
1799	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Recv.cStatFrames, "Packets/Received", "Number of received packets.");
1800	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Send.cStatFrames, "Packets/Sent", "Number of sent packets.");
1801	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatReceivedGso, "Packets/Received-Gso", "The GSO portion of the received packets.");
1802	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatSentGso, "Packets/Sent-Gso", "The GSO portion of the sent packets.");
1803	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatSentR0, "Packets/Sent-R0", "The ring-0 portion of the sent packets.");
1804
1805	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatLost, "Packets/Lost", "Number of lost packets.");
1806	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatYieldsNok, "YieldOk", "Number of times yielding helped fix an overflow.");
1807	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatYieldsOk, "YieldNok", "Number of times yielding didn't help fix an overflow.");
1808	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatBadFrames, "BadFrames", "Number of bad frames seed by the consumers.");
1809	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatSend1, "Send1", "Profiling IntNetR0IfSend.");
1810	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatSend2, "Send2", "Profiling sending to the trunk.");
1811	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatRecv1, "Recv1", "Reserved for future receive profiling.");
1812	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatRecv2, "Recv2", "Reserved for future receive profiling.");
1813	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatReserved, "Reserved", "Reserved for future use.");
1814	#ifdef VBOX_WITH_STATISTICS
1815	PDMDrvHlpSTAMRegProfileAdv(pDrvIns, &pThis->StatReceive, "Receive", "Profiling packet receive runs.");
1816	PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->StatTransmit, "Transmit", "Profiling packet transmit runs.");
1817	#endif
1818	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitWakeupR0, "XmitWakeup-R0", "Xmit thread wakeups from ring-0.");
1819	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitWakeupR3, "XmitWakeup-R3", "Xmit thread wakeups from ring-3.");
1820	PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitProcessRing, "XmitProcessRing", "Time xmit thread was told to process the ring.");
1821
1822	/*
1823	* Create the async I/O threads.
1824	* Note! Using a PDM thread here doesn't fit with the IsService=true operation.
1825	*/
1826	rc = RTThreadCreate(&pThis->hRecvThread, drvR3IntNetRecvThread, pThis, 0,
1827	RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "INTNET-RECV");
1828	if (RT_FAILURE(rc))
1829	{
1830	AssertRC(rc);
1831	return rc;
1832	}
1833
1834	rc = SUPSemEventCreate(pThis->pSupDrvSession, &pThis->hXmitEvt);
1835	AssertRCReturn(rc, rc);
1836
1837	rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pXmitThread, pThis,
1838	drvR3IntNetXmitThread, drvR3IntNetXmitWakeUp, 0, RTTHREADTYPE_IO, "INTNET-XMIT");
1839	AssertRCReturn(rc, rc);
1840
1841	#ifdef VBOX_WITH_DRVINTNET_IN_R0
1842	/*
1843	* Resolve the ring-0 context interface addresses.
1844	*/
1845	rc = pDrvIns->pHlpR3->pfnLdrGetR0InterfaceSymbols(pDrvIns, &pThis->INetworkUpR0, sizeof(pThis->INetworkUpR0),
1846	"drvIntNetUp_", PDMINETWORKUP_SYM_LIST);
1847	AssertLogRelRCReturn(rc, rc);
1848	#endif
1849
1850	/*
1851	* Activate data transmission as early as possible
1852	*/
1853	if (pThis->fActivateEarlyDeactivateLate)
1854	{
1855	ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1856	RTSemEventSignal(pThis->hRecvEvt);
1857
1858	drvR3IntNetUpdateMacAddress(pThis);
1859	drvR3IntNetSetActive(pThis, true /* fActive */);
1860	}
1861
1862	return rc;
1863	}
1864
1865
1866
1867	/**
1868	* Internal networking transport driver registration record.
1869	*/
1870	const PDMDRVREG g_DrvIntNet =
1871	{
1872	/* u32Version */
1873	PDM_DRVREG_VERSION,
1874	/* szName */
1875	"IntNet",
1876	/* szRCMod */
1877	"VBoxDDRC.rc",
1878	/* szR0Mod */
1879	"VBoxDDR0.r0",
1880	/* pszDescription */
1881	"Internal Networking Transport Driver",
1882	/* fFlags */
1883	#ifdef VBOX_WITH_DRVINTNET_IN_R0
1884	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT \| PDM_DRVREG_FLAGS_R0,
1885	#else
1886	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1887	#endif
1888	/* fClass. */
1889	PDM_DRVREG_CLASS_NETWORK,
1890	/* cMaxInstances */
1891	~0U,
1892	/* cbInstance */
1893	sizeof(DRVINTNET),
1894	/* pfnConstruct */
1895	drvR3IntNetConstruct,
1896	/* pfnDestruct */
1897	drvR3IntNetDestruct,
1898	/* pfnRelocate */
1899	drvR3IntNetRelocate,
1900	/* pfnIOCtl */
1901	NULL,
1902	/* pfnPowerOn */
1903	drvR3IntNetPowerOn,
1904	/* pfnReset */
1905	NULL,
1906	/* pfnSuspend */
1907	drvR3IntNetSuspend,
1908	/* pfnResume */
1909	drvR3IntNetResume,
1910	/* pfnAttach */
1911	NULL,
1912	/* pfnDetach */
1913	NULL,
1914	/* pfnPowerOff */
1915	drvR3IntNetPowerOff,
1916	/* pfnSoftReset */
1917	NULL,
1918	/* u32EndVersion */
1919	PDM_DRVREG_VERSION
1920	};
1921
1922	#endif /* IN_RING3 */
1923

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

source: vbox/trunk/src/VBox/Devices/Network/DrvIntNet.cpp@ 64700

Download in other formats: