VirtualBox

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

Last change on this file since 82781 was 80074, checked in by vboxsync, 5 years ago

VMM,Main,++: Retired the unfinished FTM component.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 74.0 KB
Line 
1/* $Id: DrvIntNet.cpp 80074 2019-07-31 14:18:34Z vboxsync $ */
2/** @file
3 * DrvIntNet - Internal network transport driver.
4 */
5
6/*
7 * Copyright (C) 2006-2019 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 */
65typedef 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 */
82typedef 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;
184AssertCompileMemberAlignment(DRVINTNET, XmitLock, 8);
185AssertCompileMemberAlignment(DRVINTNET, StatSentGso, 8);
186/** Pointer to instance data of the internal networking driver. */
187typedef DRVINTNET *PDRVINTNET;
188
189/**
190 * Config value to flag translation structure.
191 */
192typedef 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. */
200typedef 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 */
212static 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 */
241static 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 */
271DECLINLINE(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 */
292DECLINLINE(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 */
320PDMBOTHCBDECL(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 */
363PDMBOTHCBDECL(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 */
459PDMBOTHCBDECL(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 */
488PDMBOTHCBDECL(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 /*
503 * Commit the frame and push it thru the switch.
504 */
505 PINTNETHDR pHdr = (PINTNETHDR)pSgBuf->pvAllocator;
506 IntNetRingCommitFrameEx(&pThis->CTX_SUFF(pBuf)->Send, pHdr, pSgBuf->cbUsed);
507 int rc = drvIntNetProcessXmit(pThis);
508 STAM_PROFILE_STOP(&pThis->StatTransmit, a);
509
510 /*
511 * Free the descriptor and return.
512 */
513#ifdef IN_RING3
514 RTMemCacheFree(pThis->hSgCache, pSgBuf);
515#else
516 STAM_REL_COUNTER_INC(&pThis->StatSentR0);
517 pSgBuf->fFlags = 0;
518#endif
519 return rc;
520}
521
522
523/**
524 * @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
525 */
526PDMBOTHCBDECL(void) drvIntNetUp_EndXmit(PPDMINETWORKUP pInterface)
527{
528 PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
529 ASMAtomicUoWriteBool(&pThis->fXmitOnXmitThread, false);
530 PDMCritSectLeave(&pThis->XmitLock);
531}
532
533
534/**
535 * @interface_method_impl{PDMINETWORKUP,pfnSetPromiscuousMode}
536 */
537PDMBOTHCBDECL(void) drvIntNetUp_SetPromiscuousMode(PPDMINETWORKUP pInterface, bool fPromiscuous)
538{
539 PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
540
541#ifdef IN_RING3
542 INTNETIFSETPROMISCUOUSMODEREQ Req;
543 Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
544 Req.Hdr.cbReq = sizeof(Req);
545 Req.pSession = NIL_RTR0PTR;
546 Req.hIf = pThis->hIf;
547 Req.fPromiscuous = fPromiscuous;
548 int rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE, &Req, sizeof(Req));
549#else /* IN_RING0 */
550 int rc = IntNetR0IfSetPromiscuousMode(pThis->hIf, pThis->pSupDrvSession, fPromiscuous);
551#endif /* IN_RING0 */
552
553 LogFlow(("drvIntNetUp_SetPromiscuousMode: fPromiscuous=%RTbool\n", fPromiscuous));
554 AssertRC(rc);
555}
556
557#ifdef IN_RING3
558
559/**
560 * @interface_method_impl{PDMINETWORKUP,pfnNotifyLinkChanged}
561 */
562static DECLCALLBACK(void) drvR3IntNetUp_NotifyLinkChanged(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState)
563{
564 PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, CTX_SUFF(INetworkUp));
565 bool fLinkDown;
566 switch (enmLinkState)
567 {
568 case PDMNETWORKLINKSTATE_DOWN:
569 case PDMNETWORKLINKSTATE_DOWN_RESUME:
570 fLinkDown = true;
571 break;
572 default:
573 AssertMsgFailed(("enmLinkState=%d\n", enmLinkState));
574 RT_FALL_THRU();
575 case PDMNETWORKLINKSTATE_UP:
576 fLinkDown = false;
577 break;
578 }
579 LogFlow(("drvR3IntNetUp_NotifyLinkChanged: enmLinkState=%d %d->%d\n", enmLinkState, pThis->fLinkDown, fLinkDown));
580 ASMAtomicXchgSize(&pThis->fLinkDown, fLinkDown);
581}
582
583
584/* -=-=-=-=- Transmit Thread -=-=-=-=- */
585
586/**
587 * Async I/O thread for deferred packet transmission.
588 *
589 * @returns VBox status code. Returning failure will naturally terminate the thread.
590 * @param pDrvIns The internal networking driver instance.
591 * @param pThread The thread.
592 */
593static DECLCALLBACK(int) drvR3IntNetXmitThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
594{
595 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
596
597 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
598 {
599 /*
600 * Transmit any pending packets.
601 */
602 /** @todo Optimize this. We shouldn't call pfnXmitPending unless asked for.
603 * Also there is no need to call drvIntNetProcessXmit if we also
604 * called pfnXmitPending and send one or more frames. */
605 if (ASMAtomicXchgBool(&pThis->fXmitProcessRing, false))
606 {
607 STAM_REL_COUNTER_INC(&pThis->StatXmitProcessRing);
608 PDMCritSectEnter(&pThis->XmitLock, VERR_IGNORED);
609 drvIntNetProcessXmit(pThis);
610 PDMCritSectLeave(&pThis->XmitLock);
611 }
612
613 pThis->pIAboveNet->pfnXmitPending(pThis->pIAboveNet);
614
615 if (ASMAtomicXchgBool(&pThis->fXmitProcessRing, false))
616 {
617 STAM_REL_COUNTER_INC(&pThis->StatXmitProcessRing);
618 PDMCritSectEnter(&pThis->XmitLock, VERR_IGNORED);
619 drvIntNetProcessXmit(pThis);
620 PDMCritSectLeave(&pThis->XmitLock);
621 }
622
623 /*
624 * Block until we've got something to send or is supposed
625 * to leave the running state.
626 */
627 int rc = SUPSemEventWaitNoResume(pThis->pSupDrvSession, pThis->hXmitEvt, RT_INDEFINITE_WAIT);
628 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
629 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
630 break;
631
632 }
633
634 /* The thread is being initialized, suspended or terminated. */
635 return VINF_SUCCESS;
636}
637
638
639/**
640 * @copydoc FNPDMTHREADWAKEUPDRV
641 */
642static DECLCALLBACK(int) drvR3IntNetXmitWakeUp(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
643{
644 RT_NOREF(pThread);
645 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
646 return SUPSemEventSignal(pThis->pSupDrvSession, pThis->hXmitEvt);
647}
648
649
650/* -=-=-=-=- Receive Thread -=-=-=-=- */
651
652/**
653 * Wait for space to become available up the driver/device chain.
654 *
655 * @returns VINF_SUCCESS if space is available.
656 * @returns VERR_STATE_CHANGED if the state changed.
657 * @returns VBox status code on other errors.
658 * @param pThis Pointer to the instance data.
659 */
660static int drvR3IntNetRecvWaitForSpace(PDRVINTNET pThis)
661{
662 LogFlow(("drvR3IntNetRecvWaitForSpace:\n"));
663 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
664 int rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
665 STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
666 LogFlow(("drvR3IntNetRecvWaitForSpace: returns %Rrc\n", rc));
667 return rc;
668}
669
670
671/**
672 * Executes async I/O (RUNNING mode).
673 *
674 * @returns VERR_STATE_CHANGED if the state changed.
675 * @returns Appropriate VBox status code (error) on fatal error.
676 * @param pThis The driver instance data.
677 */
678static int drvR3IntNetRecvRun(PDRVINTNET pThis)
679{
680 PPDMDRVINS pDrvIns = pThis->pDrvInsR3;
681 LogFlow(("drvR3IntNetRecvRun: pThis=%p\n", pThis));
682
683 /*
684 * The running loop - processing received data and waiting for more to arrive.
685 */
686 STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
687 PINTNETBUF pBuf = pThis->CTX_SUFF(pBuf);
688 PINTNETRINGBUF pRingBuf = &pBuf->Recv;
689 for (;;)
690 {
691 /*
692 * Process the receive buffer.
693 */
694 PINTNETHDR pHdr;
695 while ((pHdr = IntNetRingGetNextFrameToRead(pRingBuf)) != NULL)
696 {
697 /*
698 * Check the state and then inspect the packet.
699 */
700 if (pThis->enmRecvState != RECVSTATE_RUNNING)
701 {
702 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
703 LogFlow(("drvR3IntNetRecvRun: returns VERR_STATE_CHANGED (state changed - #0)\n"));
704 return VERR_STATE_CHANGED;
705 }
706
707 Log2(("pHdr=%p offRead=%#x: %.8Rhxs\n", pHdr, pRingBuf->offReadX, pHdr));
708 uint8_t u8Type = pHdr->u8Type;
709 if ( ( u8Type == INTNETHDR_TYPE_FRAME
710 || u8Type == INTNETHDR_TYPE_GSO)
711 && !pThis->fLinkDown)
712 {
713 /*
714 * Check if there is room for the frame and pass it up.
715 */
716 size_t cbFrame = pHdr->cbFrame;
717 int rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, 0);
718 if (rc == VINF_SUCCESS)
719 {
720 if (u8Type == INTNETHDR_TYPE_FRAME)
721 {
722 /*
723 * Normal frame.
724 */
725#ifdef LOG_ENABLED
726 if (LogIsEnabled())
727 {
728 uint64_t u64Now = RTTimeProgramNanoTS();
729 LogFlow(("drvR3IntNetRecvRun: %-4d bytes at %llu ns deltas: r=%llu t=%llu\n",
730 cbFrame, u64Now, u64Now - pThis->u64LastReceiveTS, u64Now - pThis->u64LastTransferTS));
731 pThis->u64LastReceiveTS = u64Now;
732 Log2(("drvR3IntNetRecvRun: cbFrame=%#x\n"
733 "%.*Rhxd\n",
734 cbFrame, cbFrame, IntNetHdrGetFramePtr(pHdr, pBuf)));
735 }
736#endif
737 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, IntNetHdrGetFramePtr(pHdr, pBuf), cbFrame);
738 AssertRC(rc);
739
740 /* skip to the next frame. */
741 IntNetRingSkipFrame(pRingBuf);
742 }
743 else
744 {
745 /*
746 * Generic segment offload frame (INTNETHDR_TYPE_GSO).
747 */
748 STAM_COUNTER_INC(&pThis->StatReceivedGso);
749 PCPDMNETWORKGSO pGso = IntNetHdrGetGsoContext(pHdr, pBuf);
750 if (PDMNetGsoIsValid(pGso, cbFrame, cbFrame - sizeof(PDMNETWORKGSO)))
751 {
752 if (!pThis->pIAboveNet->pfnReceiveGso ||
753 RT_FAILURE(pThis->pIAboveNet->pfnReceiveGso(pThis->pIAboveNet,
754 (uint8_t *)(pGso + 1),
755 pHdr->cbFrame - sizeof(PDMNETWORKGSO),
756 pGso)))
757 {
758 /*
759 *
760 * This is where we do the offloading since this NIC
761 * does not support large receive offload (LRO).
762 */
763 cbFrame -= sizeof(PDMNETWORKGSO);
764
765 uint8_t abHdrScratch[256];
766 uint32_t const cSegs = PDMNetGsoCalcSegmentCount(pGso, cbFrame);
767#ifdef LOG_ENABLED
768 if (LogIsEnabled())
769 {
770 uint64_t u64Now = RTTimeProgramNanoTS();
771 LogFlow(("drvR3IntNetRecvRun: %-4d bytes at %llu ns deltas: r=%llu t=%llu; GSO - %u segs\n",
772 cbFrame, u64Now, u64Now - pThis->u64LastReceiveTS, u64Now - pThis->u64LastTransferTS, cSegs));
773 pThis->u64LastReceiveTS = u64Now;
774 Log2(("drvR3IntNetRecvRun: cbFrame=%#x type=%d cbHdrsTotal=%#x cbHdrsSeg=%#x Hdr1=%#x Hdr2=%#x MMS=%#x\n"
775 "%.*Rhxd\n",
776 cbFrame, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg, pGso->offHdr1, pGso->offHdr2, pGso->cbMaxSeg,
777 cbFrame - sizeof(*pGso), pGso + 1));
778 }
779#endif
780 for (uint32_t iSeg = 0; iSeg < cSegs; iSeg++)
781 {
782 uint32_t cbSegFrame;
783 void *pvSegFrame = PDMNetGsoCarveSegmentQD(pGso, (uint8_t *)(pGso + 1), cbFrame,
784 abHdrScratch, iSeg, cSegs, &cbSegFrame);
785 rc = drvR3IntNetRecvWaitForSpace(pThis);
786 if (RT_FAILURE(rc))
787 {
788 Log(("drvR3IntNetRecvRun: drvR3IntNetRecvWaitForSpace -> %Rrc; iSeg=%u cSegs=%u\n", rc, iSeg, cSegs));
789 break; /* we drop the rest. */
790 }
791 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pvSegFrame, cbSegFrame);
792 AssertRC(rc);
793 }
794 }
795 }
796 else
797 {
798 AssertMsgFailed(("cbFrame=%#x type=%d cbHdrsTotal=%#x cbHdrsSeg=%#x Hdr1=%#x Hdr2=%#x MMS=%#x\n",
799 cbFrame, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg, pGso->offHdr1, pGso->offHdr2, pGso->cbMaxSeg));
800 STAM_REL_COUNTER_INC(&pBuf->cStatBadFrames);
801 }
802
803 IntNetRingSkipFrame(pRingBuf);
804 }
805 }
806 else
807 {
808 /*
809 * Wait for sufficient space to become available and then retry.
810 */
811 rc = drvR3IntNetRecvWaitForSpace(pThis);
812 if (RT_FAILURE(rc))
813 {
814 if (rc == VERR_INTERRUPTED)
815 {
816 /*
817 * NIC is going down, likely because the VM is being reset. Skip the frame.
818 */
819 AssertMsg(IntNetIsValidFrameType(pHdr->u8Type), ("Unknown frame type %RX16! offRead=%#x\n", pHdr->u8Type, pRingBuf->offReadX));
820 IntNetRingSkipFrame(pRingBuf);
821 }
822 else
823 {
824 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
825 LogFlow(("drvR3IntNetRecvRun: returns %Rrc (wait-for-space)\n", rc));
826 return rc;
827 }
828 }
829 }
830 }
831 else
832 {
833 /*
834 * Link down or unknown frame - skip to the next frame.
835 */
836 AssertMsg(IntNetIsValidFrameType(pHdr->u8Type), ("Unknown frame type %RX16! offRead=%#x\n", pHdr->u8Type, pRingBuf->offReadX));
837 IntNetRingSkipFrame(pRingBuf);
838 STAM_REL_COUNTER_INC(&pBuf->cStatBadFrames);
839 }
840 } /* while more received data */
841
842 /*
843 * Wait for data, checking the state before we block.
844 */
845 if (pThis->enmRecvState != RECVSTATE_RUNNING)
846 {
847 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
848 LogFlow(("drvR3IntNetRecvRun: returns VINF_SUCCESS (state changed - #1)\n"));
849 return VERR_STATE_CHANGED;
850 }
851 INTNETIFWAITREQ WaitReq;
852 WaitReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
853 WaitReq.Hdr.cbReq = sizeof(WaitReq);
854 WaitReq.pSession = NIL_RTR0PTR;
855 WaitReq.hIf = pThis->hIf;
856 WaitReq.cMillies = 30000; /* 30s - don't wait forever, timeout now and then. */
857 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
858 int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_WAIT, &WaitReq, sizeof(WaitReq));
859 if ( RT_FAILURE(rc)
860 && rc != VERR_TIMEOUT
861 && rc != VERR_INTERRUPTED)
862 {
863 LogFlow(("drvR3IntNetRecvRun: returns %Rrc\n", rc));
864 return rc;
865 }
866 STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
867 }
868}
869
870
871/**
872 * Asynchronous I/O thread for handling receive.
873 *
874 * @returns VINF_SUCCESS (ignored).
875 * @param hThreadSelf Thread handle.
876 * @param pvUser Pointer to a DRVINTNET structure.
877 */
878static DECLCALLBACK(int) drvR3IntNetRecvThread(RTTHREAD hThreadSelf, void *pvUser)
879{
880 RT_NOREF(hThreadSelf);
881 PDRVINTNET pThis = (PDRVINTNET)pvUser;
882 LogFlow(("drvR3IntNetRecvThread: pThis=%p\n", pThis));
883 STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
884
885 /*
886 * The main loop - acting on state.
887 */
888 for (;;)
889 {
890 RECVSTATE enmRecvState = pThis->enmRecvState;
891 switch (enmRecvState)
892 {
893 case RECVSTATE_SUSPENDED:
894 {
895 int rc = RTSemEventWait(pThis->hRecvEvt, 30000);
896 if ( RT_FAILURE(rc)
897 && rc != VERR_TIMEOUT)
898 {
899 LogFlow(("drvR3IntNetRecvThread: returns %Rrc\n", rc));
900 return rc;
901 }
902 break;
903 }
904
905 case RECVSTATE_RUNNING:
906 {
907 int rc = drvR3IntNetRecvRun(pThis);
908 if ( rc != VERR_STATE_CHANGED
909 && RT_FAILURE(rc))
910 {
911 LogFlow(("drvR3IntNetRecvThread: returns %Rrc\n", rc));
912 return rc;
913 }
914 break;
915 }
916
917 default:
918 AssertMsgFailed(("Invalid state %d\n", enmRecvState));
919 RT_FALL_THRU();
920 case RECVSTATE_TERMINATE:
921 LogFlow(("drvR3IntNetRecvThread: returns VINF_SUCCESS\n"));
922 return VINF_SUCCESS;
923 }
924 }
925}
926
927
928/* -=-=-=-=- PDMIBASERC -=-=-=-=- */
929
930/**
931 * @interface_method_impl{PDMIBASERC,pfnQueryInterface}
932 */
933static DECLCALLBACK(RTRCPTR) drvR3IntNetIBaseRC_QueryInterface(PPDMIBASERC pInterface, const char *pszIID)
934{
935 PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, IBaseRC);
936
937#if 0
938 PDMIBASERC_RETURN_INTERFACE(pThis->pDrvInsR3, pszIID, PDMINETWORKUP, &pThis->INetworkUpRC);
939#else
940 RT_NOREF(pThis, pszIID);
941#endif
942 return NIL_RTRCPTR;
943}
944
945
946/* -=-=-=-=- PDMIBASER0 -=-=-=-=- */
947
948/**
949 * @interface_method_impl{PDMIBASER0,pfnQueryInterface}
950 */
951static DECLCALLBACK(RTR0PTR) drvR3IntNetIBaseR0_QueryInterface(PPDMIBASER0 pInterface, const char *pszIID)
952{
953 PDRVINTNET pThis = RT_FROM_MEMBER(pInterface, DRVINTNET, IBaseR0);
954#ifdef VBOX_WITH_DRVINTNET_IN_R0
955 PDMIBASER0_RETURN_INTERFACE(pThis->pDrvInsR3, pszIID, PDMINETWORKUP, &pThis->INetworkUpR0);
956#endif
957 return NIL_RTR0PTR;
958}
959
960
961/* -=-=-=-=- PDMIBASE -=-=-=-=- */
962
963/**
964 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
965 */
966static DECLCALLBACK(void *) drvR3IntNetIBase_QueryInterface(PPDMIBASE pInterface, const char *pszIID)
967{
968 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
969 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
970
971 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
972 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASER0, &pThis->IBaseR0);
973 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASERC, &pThis->IBaseRC);
974 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKUP, &pThis->INetworkUpR3);
975 return NULL;
976}
977
978
979/* -=-=-=-=- PDMDRVREG -=-=-=-=- */
980
981/**
982 * Power Off notification.
983 *
984 * @param pDrvIns The driver instance.
985 */
986static DECLCALLBACK(void) drvR3IntNetPowerOff(PPDMDRVINS pDrvIns)
987{
988 LogFlow(("drvR3IntNetPowerOff\n"));
989 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
990 if (!pThis->fActivateEarlyDeactivateLate)
991 {
992 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_SUSPENDED);
993 drvR3IntNetSetActive(pThis, false /* fActive */);
994 }
995}
996
997
998/**
999 * drvR3IntNetResume helper.
1000 */
1001static int drvR3IntNetResumeSend(PDRVINTNET pThis, const void *pvBuf, size_t cb)
1002{
1003 /*
1004 * Add the frame to the send buffer and push it onto the network.
1005 */
1006 int rc = IntNetRingWriteFrame(&pThis->pBufR3->Send, pvBuf, (uint32_t)cb);
1007 if ( rc == VERR_BUFFER_OVERFLOW
1008 && pThis->pBufR3->cbSend < cb)
1009 {
1010 INTNETIFSENDREQ SendReq;
1011 SendReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1012 SendReq.Hdr.cbReq = sizeof(SendReq);
1013 SendReq.pSession = NIL_RTR0PTR;
1014 SendReq.hIf = pThis->hIf;
1015 PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SEND, &SendReq, sizeof(SendReq));
1016
1017 rc = IntNetRingWriteFrame(&pThis->pBufR3->Send, pvBuf, (uint32_t)cb);
1018 }
1019
1020 if (RT_SUCCESS(rc))
1021 {
1022 INTNETIFSENDREQ SendReq;
1023 SendReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1024 SendReq.Hdr.cbReq = sizeof(SendReq);
1025 SendReq.pSession = NIL_RTR0PTR;
1026 SendReq.hIf = pThis->hIf;
1027 rc = PDMDrvHlpSUPCallVMMR0Ex(pThis->pDrvInsR3, VMMR0_DO_INTNET_IF_SEND, &SendReq, sizeof(SendReq));
1028 }
1029
1030 AssertRC(rc);
1031 return rc;
1032}
1033
1034
1035/**
1036 * Resume notification.
1037 *
1038 * @param pDrvIns The driver instance.
1039 */
1040static DECLCALLBACK(void) drvR3IntNetResume(PPDMDRVINS pDrvIns)
1041{
1042 LogFlow(("drvR3IntNetPowerResume\n"));
1043 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1044 VMRESUMEREASON enmReason = PDMDrvHlpVMGetResumeReason(pDrvIns);
1045
1046 if (!pThis->fActivateEarlyDeactivateLate)
1047 {
1048 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1049 RTSemEventSignal(pThis->hRecvEvt);
1050 drvR3IntNetUpdateMacAddress(pThis); /* (could be a state restore) */
1051 drvR3IntNetSetActive(pThis, true /* fActive */);
1052 }
1053
1054 switch (enmReason)
1055 {
1056 case VMRESUMEREASON_HOST_RESUME:
1057 {
1058 uint32_t u32TrunkType;
1059 int rc = CFGMR3QueryU32(pDrvIns->pCfg, "TrunkType", &u32TrunkType);
1060 AssertRC(rc);
1061
1062 /*
1063 * Only do the disconnect for bridged networking. Host-only and
1064 * internal networks are not affected by a host resume.
1065 */
1066 if ( RT_SUCCESS(rc)
1067 && u32TrunkType == kIntNetTrunkType_NetFlt)
1068 {
1069 rc = pThis->pIAboveConfigR3->pfnSetLinkState(pThis->pIAboveConfigR3,
1070 PDMNETWORKLINKSTATE_DOWN_RESUME);
1071 AssertRC(rc);
1072 }
1073 break;
1074 }
1075 case VMRESUMEREASON_TELEPORTED:
1076 case VMRESUMEREASON_TELEPORT_FAILED:
1077 {
1078 if ( PDMDrvHlpVMTeleportedAndNotFullyResumedYet(pDrvIns)
1079 && pThis->pIAboveConfigR3)
1080 {
1081 /*
1082 * We've just been teleported and need to drop a hint to the switch
1083 * since we're likely to have changed to a different port. We just
1084 * push out some ethernet frame that doesn't mean anything to anyone.
1085 * For this purpose ethertype 0x801e was chosen since it was registered
1086 * to Sun (dunno what it is/was used for though).
1087 */
1088 union
1089 {
1090 RTNETETHERHDR Hdr;
1091 uint8_t ab[128];
1092 } Frame;
1093 RT_ZERO(Frame);
1094 Frame.Hdr.DstMac.au16[0] = 0xffff;
1095 Frame.Hdr.DstMac.au16[1] = 0xffff;
1096 Frame.Hdr.DstMac.au16[2] = 0xffff;
1097 Frame.Hdr.EtherType = RT_H2BE_U16_C(0x801e);
1098 int rc = pThis->pIAboveConfigR3->pfnGetMac(pThis->pIAboveConfigR3,
1099 &Frame.Hdr.SrcMac);
1100 if (RT_SUCCESS(rc))
1101 rc = drvR3IntNetResumeSend(pThis, &Frame, sizeof(Frame));
1102 if (RT_FAILURE(rc))
1103 LogRel(("IntNet#%u: Sending dummy frame failed: %Rrc\n",
1104 pDrvIns->iInstance, rc));
1105 }
1106 break;
1107 }
1108 default: /* ignore every other resume reason else */
1109 break;
1110 } /* end of switch(enmReason) */
1111}
1112
1113
1114/**
1115 * Suspend notification.
1116 *
1117 * @param pDrvIns The driver instance.
1118 */
1119static DECLCALLBACK(void) drvR3IntNetSuspend(PPDMDRVINS pDrvIns)
1120{
1121 LogFlow(("drvR3IntNetPowerSuspend\n"));
1122 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1123 if (!pThis->fActivateEarlyDeactivateLate)
1124 {
1125 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_SUSPENDED);
1126 drvR3IntNetSetActive(pThis, false /* fActive */);
1127 }
1128}
1129
1130
1131/**
1132 * Power On notification.
1133 *
1134 * @param pDrvIns The driver instance.
1135 */
1136static DECLCALLBACK(void) drvR3IntNetPowerOn(PPDMDRVINS pDrvIns)
1137{
1138 LogFlow(("drvR3IntNetPowerOn\n"));
1139 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1140 if (!pThis->fActivateEarlyDeactivateLate)
1141 {
1142 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1143 RTSemEventSignal(pThis->hRecvEvt);
1144 drvR3IntNetUpdateMacAddress(pThis);
1145 drvR3IntNetSetActive(pThis, true /* fActive */);
1146 }
1147}
1148
1149
1150/**
1151 * @interface_method_impl{PDMDRVREG,pfnRelocate}
1152 */
1153static DECLCALLBACK(void) drvR3IntNetRelocate(PPDMDRVINS pDrvIns, RTGCINTPTR offDelta)
1154{
1155 /* nothing to do here yet */
1156 RT_NOREF(pDrvIns, offDelta);
1157}
1158
1159
1160/**
1161 * Destruct a driver instance.
1162 *
1163 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
1164 * resources can be freed correctly.
1165 *
1166 * @param pDrvIns The driver instance data.
1167 */
1168static DECLCALLBACK(void) drvR3IntNetDestruct(PPDMDRVINS pDrvIns)
1169{
1170 LogFlow(("drvR3IntNetDestruct\n"));
1171 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1172 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1173
1174 /*
1175 * Indicate to the receive thread that it's time to quit.
1176 */
1177 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_TERMINATE);
1178 ASMAtomicXchgSize(&pThis->fLinkDown, true);
1179 RTSEMEVENT hRecvEvt = pThis->hRecvEvt;
1180 pThis->hRecvEvt = NIL_RTSEMEVENT;
1181
1182 if (hRecvEvt != NIL_RTSEMEVENT)
1183 RTSemEventSignal(hRecvEvt);
1184
1185 if (pThis->hIf != INTNET_HANDLE_INVALID)
1186 {
1187 INTNETIFABORTWAITREQ AbortWaitReq;
1188 AbortWaitReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1189 AbortWaitReq.Hdr.cbReq = sizeof(AbortWaitReq);
1190 AbortWaitReq.pSession = NIL_RTR0PTR;
1191 AbortWaitReq.hIf = pThis->hIf;
1192 AbortWaitReq.fNoMoreWaits = true;
1193 int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_ABORT_WAIT, &AbortWaitReq, sizeof(AbortWaitReq));
1194 AssertMsg(RT_SUCCESS(rc) || rc == VERR_SEM_DESTROYED, ("%Rrc\n", rc)); RT_NOREF_PV(rc);
1195 }
1196
1197 /*
1198 * Wait for the threads to terminate.
1199 */
1200 if (pThis->pXmitThread)
1201 {
1202 int rc = PDMR3ThreadDestroy(pThis->pXmitThread, NULL);
1203 AssertRC(rc);
1204 pThis->pXmitThread = NULL;
1205 }
1206
1207 if (pThis->hRecvThread != NIL_RTTHREAD)
1208 {
1209 int rc = RTThreadWait(pThis->hRecvThread, 5000, NULL);
1210 AssertRC(rc);
1211 pThis->hRecvThread = NIL_RTTHREAD;
1212 }
1213
1214 /*
1215 * Deregister statistics in case we're being detached.
1216 */
1217 if (pThis->pBufR3)
1218 {
1219 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cStatFrames);
1220 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cbStatWritten);
1221 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Recv.cOverflows);
1222 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cStatFrames);
1223 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cbStatWritten);
1224 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->Send.cOverflows);
1225 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatYieldsOk);
1226 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatYieldsNok);
1227 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatLost);
1228 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->cStatBadFrames);
1229 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatSend1);
1230 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatSend2);
1231 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatRecv1);
1232 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatRecv2);
1233 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->pBufR3->StatReserved);
1234 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReceivedGso);
1235 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatSentGso);
1236#ifdef VBOX_WITH_STATISTICS
1237 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatReceive);
1238 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatTransmit);
1239#endif
1240 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitWakeupR0);
1241 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitWakeupR3);
1242 PDMDrvHlpSTAMDeregister(pDrvIns, &pThis->StatXmitProcessRing);
1243 }
1244
1245 /*
1246 * Close the interface
1247 */
1248 if (pThis->hIf != INTNET_HANDLE_INVALID)
1249 {
1250 INTNETIFCLOSEREQ CloseReq;
1251 CloseReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1252 CloseReq.Hdr.cbReq = sizeof(CloseReq);
1253 CloseReq.pSession = NIL_RTR0PTR;
1254 CloseReq.hIf = pThis->hIf;
1255 pThis->hIf = INTNET_HANDLE_INVALID;
1256 int rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_CLOSE, &CloseReq, sizeof(CloseReq));
1257 AssertRC(rc);
1258 }
1259
1260
1261 /*
1262 * Destroy the semaphores, S/G cache and xmit lock.
1263 */
1264 if (hRecvEvt != NIL_RTSEMEVENT)
1265 RTSemEventDestroy(hRecvEvt);
1266
1267 if (pThis->hXmitEvt != NIL_SUPSEMEVENT)
1268 {
1269 SUPSemEventClose(pThis->pSupDrvSession, pThis->hXmitEvt);
1270 pThis->hXmitEvt = NIL_SUPSEMEVENT;
1271 }
1272
1273 RTMemCacheDestroy(pThis->hSgCache);
1274 pThis->hSgCache = NIL_RTMEMCACHE;
1275
1276 if (PDMCritSectIsInitialized(&pThis->XmitLock))
1277 PDMR3CritSectDelete(&pThis->XmitLock);
1278}
1279
1280
1281/**
1282 * Queries a policy config value and translates it into open network flag.
1283 *
1284 * @returns VBox status code (error set on failure).
1285 * @param pDrvIns The driver instance.
1286 * @param pszName The value name.
1287 * @param paFlags The open network flag descriptors.
1288 * @param cFlags The number of descriptors.
1289 * @param fFlags The fixed flag.
1290 * @param pfFlags The flags variable to update.
1291 */
1292static int drvIntNetR3CfgGetPolicy(PPDMDRVINS pDrvIns, const char *pszName, PCDRVINTNETFLAG paFlags, size_t cFlags,
1293 uint32_t fFixedFlag, uint32_t *pfFlags)
1294{
1295 char szValue[64];
1296 int rc = CFGMR3QueryString(pDrvIns->pCfg, pszName, szValue, sizeof(szValue));
1297 if (RT_FAILURE(rc))
1298 {
1299 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1300 return VINF_SUCCESS;
1301 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1302 N_("Configuration error: Failed to query value of \"%s\""), pszName);
1303 }
1304
1305 /*
1306 * Check for +fixed first, so it can be stripped off.
1307 */
1308 char *pszSep = strpbrk(szValue, "+,;");
1309 if (pszSep)
1310 {
1311 *pszSep++ = '\0';
1312 const char *pszFixed = RTStrStripL(pszSep);
1313 if (strcmp(pszFixed, "fixed"))
1314 {
1315 *pszSep = '+';
1316 return PDMDrvHlpVMSetError(pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1317 N_("Configuration error: The value of \"%s\" is unknown: \"%s\""), pszName, szValue);
1318 }
1319 *pfFlags |= fFixedFlag;
1320 RTStrStripR(szValue);
1321 }
1322
1323 /*
1324 * Match against the flag values.
1325 */
1326 size_t i = cFlags;
1327 while (i-- > 0)
1328 if (!strcmp(paFlags[i].pszChoice, szValue))
1329 {
1330 *pfFlags |= paFlags[i].fFlag;
1331 return VINF_SUCCESS;
1332 }
1333
1334 if (!strcmp(szValue, "none"))
1335 return VINF_SUCCESS;
1336
1337 if (!strcmp(szValue, "fixed"))
1338 {
1339 *pfFlags |= fFixedFlag;
1340 return VINF_SUCCESS;
1341 }
1342
1343 return PDMDrvHlpVMSetError(pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1344 N_("Configuration error: The value of \"%s\" is unknown: \"%s\""), pszName, szValue);
1345}
1346
1347
1348/**
1349 * Construct a TAP network transport driver instance.
1350 *
1351 * @copydoc FNPDMDRVCONSTRUCT
1352 */
1353static DECLCALLBACK(int) drvR3IntNetConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1354{
1355 RT_NOREF(fFlags);
1356 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1357 PDRVINTNET pThis = PDMINS_2_DATA(pDrvIns, PDRVINTNET);
1358 bool f;
1359
1360 /*
1361 * Init the static parts.
1362 */
1363 pThis->pDrvInsR3 = pDrvIns;
1364#ifdef VBOX_WITH_DRVINTNET_IN_R0
1365 pThis->pDrvInsR0 = PDMDRVINS_2_R0PTR(pDrvIns);
1366#endif
1367 pThis->hIf = INTNET_HANDLE_INVALID;
1368 pThis->hRecvThread = NIL_RTTHREAD;
1369 pThis->hRecvEvt = NIL_RTSEMEVENT;
1370 pThis->pXmitThread = NULL;
1371 pThis->hXmitEvt = NIL_SUPSEMEVENT;
1372 pThis->pSupDrvSession = PDMDrvHlpGetSupDrvSession(pDrvIns);
1373 pThis->hSgCache = NIL_RTMEMCACHE;
1374 pThis->enmRecvState = RECVSTATE_SUSPENDED;
1375 pThis->fActivateEarlyDeactivateLate = false;
1376 /* IBase* */
1377 pDrvIns->IBase.pfnQueryInterface = drvR3IntNetIBase_QueryInterface;
1378 pThis->IBaseR0.pfnQueryInterface = drvR3IntNetIBaseR0_QueryInterface;
1379 pThis->IBaseRC.pfnQueryInterface = drvR3IntNetIBaseRC_QueryInterface;
1380 /* INetworkUp */
1381 pThis->INetworkUpR3.pfnBeginXmit = drvIntNetUp_BeginXmit;
1382 pThis->INetworkUpR3.pfnAllocBuf = drvIntNetUp_AllocBuf;
1383 pThis->INetworkUpR3.pfnFreeBuf = drvIntNetUp_FreeBuf;
1384 pThis->INetworkUpR3.pfnSendBuf = drvIntNetUp_SendBuf;
1385 pThis->INetworkUpR3.pfnEndXmit = drvIntNetUp_EndXmit;
1386 pThis->INetworkUpR3.pfnSetPromiscuousMode = drvIntNetUp_SetPromiscuousMode;
1387 pThis->INetworkUpR3.pfnNotifyLinkChanged = drvR3IntNetUp_NotifyLinkChanged;
1388
1389 /*
1390 * Validate the config.
1391 */
1392 PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns,
1393 "Network"
1394 "|Trunk"
1395 "|TrunkType"
1396 "|ReceiveBufferSize"
1397 "|SendBufferSize"
1398 "|SharedMacOnWire"
1399 "|RestrictAccess"
1400 "|RequireExactPolicyMatch"
1401 "|RequireAsRestrictivePolicy"
1402 "|AccessPolicy"
1403 "|PromiscPolicyClients"
1404 "|PromiscPolicyHost"
1405 "|PromiscPolicyWire"
1406 "|IfPolicyPromisc"
1407 "|TrunkPolicyHost"
1408 "|TrunkPolicyWire"
1409 "|IsService"
1410 "|IgnoreConnectFailure"
1411 "|Workaround1",
1412 "");
1413
1414 /*
1415 * Check that no-one is attached to us.
1416 */
1417 AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
1418 ("Configuration error: Not possible to attach anything to this driver!\n"),
1419 VERR_PDM_DRVINS_NO_ATTACH);
1420
1421 /*
1422 * Query the network port interface.
1423 */
1424 pThis->pIAboveNet = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKDOWN);
1425 if (!pThis->pIAboveNet)
1426 {
1427 AssertMsgFailed(("Configuration error: the above device/driver didn't export the network port interface!\n"));
1428 return VERR_PDM_MISSING_INTERFACE_ABOVE;
1429 }
1430 pThis->pIAboveConfigR3 = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKCONFIG);
1431
1432 /*
1433 * Read the configuration.
1434 */
1435 INTNETOPENREQ OpenReq;
1436 RT_ZERO(OpenReq);
1437 OpenReq.Hdr.cbReq = sizeof(OpenReq);
1438 OpenReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1439 OpenReq.pSession = NIL_RTR0PTR;
1440
1441 /** @cfgm{Network, string}
1442 * The name of the internal network to connect to.
1443 */
1444 int rc = CFGMR3QueryString(pCfg, "Network", OpenReq.szNetwork, sizeof(OpenReq.szNetwork));
1445 if (RT_FAILURE(rc))
1446 return PDMDRV_SET_ERROR(pDrvIns, rc,
1447 N_("Configuration error: Failed to get the \"Network\" value"));
1448 strcpy(pThis->szNetwork, OpenReq.szNetwork);
1449
1450 /** @cfgm{TrunkType, uint32_t, kIntNetTrunkType_None}
1451 * The trunk connection type see INTNETTRUNKTYPE.
1452 */
1453 uint32_t u32TrunkType;
1454 rc = CFGMR3QueryU32(pCfg, "TrunkType", &u32TrunkType);
1455 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1456 u32TrunkType = kIntNetTrunkType_None;
1457 else if (RT_FAILURE(rc))
1458 return PDMDRV_SET_ERROR(pDrvIns, rc,
1459 N_("Configuration error: Failed to get the \"TrunkType\" value"));
1460 OpenReq.enmTrunkType = (INTNETTRUNKTYPE)u32TrunkType;
1461
1462 /** @cfgm{Trunk, string, ""}
1463 * The name of the trunk connection.
1464 */
1465 rc = CFGMR3QueryString(pCfg, "Trunk", OpenReq.szTrunk, sizeof(OpenReq.szTrunk));
1466 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1467 OpenReq.szTrunk[0] = '\0';
1468 else if (RT_FAILURE(rc))
1469 return PDMDRV_SET_ERROR(pDrvIns, rc,
1470 N_("Configuration error: Failed to get the \"Trunk\" value"));
1471
1472 OpenReq.fFlags = 0;
1473
1474 /** @cfgm{SharedMacOnWire, boolean, false}
1475 * Whether to shared the MAC address of the host interface when using the wire. When
1476 * attaching to a wireless NIC this option is usually a requirement.
1477 */
1478 bool fSharedMacOnWire;
1479 rc = CFGMR3QueryBoolDef(pCfg, "SharedMacOnWire", &fSharedMacOnWire, false);
1480 if (RT_FAILURE(rc))
1481 return PDMDRV_SET_ERROR(pDrvIns, rc,
1482 N_("Configuration error: Failed to get the \"SharedMacOnWire\" value"));
1483 if (fSharedMacOnWire)
1484 OpenReq.fFlags |= INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE;
1485
1486 /** @cfgm{RestrictAccess, boolean, true}
1487 * Whether to restrict the access to the network or if it should be public.
1488 * Everyone on the computer can connect to a public network.
1489 * @deprecated Use AccessPolicy instead.
1490 */
1491 rc = CFGMR3QueryBool(pCfg, "RestrictAccess", &f);
1492 if (RT_SUCCESS(rc))
1493 {
1494 if (f)
1495 OpenReq.fFlags |= INTNET_OPEN_FLAGS_ACCESS_RESTRICTED;
1496 else
1497 OpenReq.fFlags |= INTNET_OPEN_FLAGS_ACCESS_PUBLIC;
1498 OpenReq.fFlags |= INTNET_OPEN_FLAGS_ACCESS_FIXED;
1499 }
1500 else if (rc != VERR_CFGM_VALUE_NOT_FOUND)
1501 return PDMDRV_SET_ERROR(pDrvIns, rc,
1502 N_("Configuration error: Failed to get the \"RestrictAccess\" value"));
1503
1504 /** @cfgm{RequireExactPolicyMatch, boolean, false}
1505 * Whether to require that the current security and promiscuous policies of
1506 * the network is exactly as the ones specified in this open network
1507 * request. Use this with RequireAsRestrictivePolicy to prevent
1508 * restrictions from being lifted. If no further policy changes are
1509 * desired, apply the relevant fixed flags. */
1510 rc = CFGMR3QueryBoolDef(pCfg, "RequireExactPolicyMatch", &f, false);
1511 if (RT_FAILURE(rc))
1512 return PDMDRV_SET_ERROR(pDrvIns, rc,
1513 N_("Configuration error: Failed to get the \"RequireExactPolicyMatch\" value"));
1514 if (f)
1515 OpenReq.fFlags |= INTNET_OPEN_FLAGS_REQUIRE_EXACT;
1516
1517 /** @cfgm{RequireAsRestrictivePolicy, boolean, false}
1518 * Whether to require that the security and promiscuous policies of the
1519 * network is at least as restrictive as specified this request specifies
1520 * and prevent them being lifted later on.
1521 */
1522 rc = CFGMR3QueryBoolDef(pCfg, "RequireAsRestrictivePolicy", &f, false);
1523 if (RT_FAILURE(rc))
1524 return PDMDRV_SET_ERROR(pDrvIns, rc,
1525 N_("Configuration error: Failed to get the \"RequireAsRestrictivePolicy\" value"));
1526 if (f)
1527 OpenReq.fFlags |= INTNET_OPEN_FLAGS_REQUIRE_AS_RESTRICTIVE_POLICIES;
1528
1529 /** @cfgm{AccessPolicy, string, "none"}
1530 * The access policy of the network:
1531 * public, public+fixed, restricted, restricted+fixed, none or fixed.
1532 *
1533 * A "public" network is accessible to everyone on the same host, while a
1534 * "restricted" one is only accessible to VMs & services started by the
1535 * same user. The "none" policy, which is the default, means no policy
1536 * change or choice is made and that the current (existing network) or
1537 * default (new) policy should be used. */
1538 static const DRVINTNETFLAG s_aAccessPolicyFlags[] =
1539 {
1540 { "public", INTNET_OPEN_FLAGS_ACCESS_PUBLIC },
1541 { "restricted", INTNET_OPEN_FLAGS_ACCESS_RESTRICTED }
1542 };
1543 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "AccessPolicy", &s_aAccessPolicyFlags[0], RT_ELEMENTS(s_aAccessPolicyFlags),
1544 INTNET_OPEN_FLAGS_ACCESS_FIXED, &OpenReq.fFlags);
1545 AssertRCReturn(rc, rc);
1546
1547 /** @cfgm{PromiscPolicyClients, string, "none"}
1548 * The network wide promiscuous mode policy for client (non-trunk)
1549 * interfaces: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1550 static const DRVINTNETFLAG s_aPromiscPolicyClient[] =
1551 {
1552 { "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_CLIENTS },
1553 { "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_CLIENTS }
1554 };
1555 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyClients", &s_aPromiscPolicyClient[0], RT_ELEMENTS(s_aPromiscPolicyClient),
1556 INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1557 AssertRCReturn(rc, rc);
1558 /** @cfgm{PromiscPolicyHost, string, "none"}
1559 * The promiscuous mode policy for the trunk-host
1560 * connection: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1561 static const DRVINTNETFLAG s_aPromiscPolicyHost[] =
1562 {
1563 { "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_HOST },
1564 { "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_HOST }
1565 };
1566 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyHost", &s_aPromiscPolicyHost[0], RT_ELEMENTS(s_aPromiscPolicyHost),
1567 INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1568 AssertRCReturn(rc, rc);
1569 /** @cfgm{PromiscPolicyWire, string, "none"}
1570 * The promiscuous mode policy for the trunk-host
1571 * connection: allow, allow+fixed, deny, deny+fixed, none or fixed. */
1572 static const DRVINTNETFLAG s_aPromiscPolicyWire[] =
1573 {
1574 { "allow", INTNET_OPEN_FLAGS_PROMISC_ALLOW_TRUNK_WIRE },
1575 { "deny", INTNET_OPEN_FLAGS_PROMISC_DENY_TRUNK_WIRE }
1576 };
1577 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "PromiscPolicyWire", &s_aPromiscPolicyWire[0], RT_ELEMENTS(s_aPromiscPolicyWire),
1578 INTNET_OPEN_FLAGS_PROMISC_FIXED, &OpenReq.fFlags);
1579 AssertRCReturn(rc, rc);
1580
1581
1582 /** @cfgm{IfPolicyPromisc, string, "none"}
1583 * The promiscuous mode policy for this
1584 * interface: deny, deny+fixed, allow-all, allow-all+fixed, allow-network,
1585 * allow-network+fixed, none or fixed. */
1586 static const DRVINTNETFLAG s_aIfPolicyPromisc[] =
1587 {
1588 { "allow-all", INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW | INTNET_OPEN_FLAGS_IF_PROMISC_SEE_TRUNK },
1589 { "allow-network", INTNET_OPEN_FLAGS_IF_PROMISC_ALLOW | INTNET_OPEN_FLAGS_IF_PROMISC_NO_TRUNK },
1590 { "deny", INTNET_OPEN_FLAGS_IF_PROMISC_DENY }
1591 };
1592 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "IfPolicyPromisc", &s_aIfPolicyPromisc[0], RT_ELEMENTS(s_aIfPolicyPromisc),
1593 INTNET_OPEN_FLAGS_IF_FIXED, &OpenReq.fFlags);
1594 AssertRCReturn(rc, rc);
1595
1596
1597 /** @cfgm{TrunkPolicyHost, string, "none"}
1598 * The trunk-host policy: promisc, promisc+fixed, enabled, enabled+fixed,
1599 * disabled, disabled+fixed, none or fixed
1600 *
1601 * This can be used to prevent packages to be routed to the host. */
1602 static const DRVINTNETFLAG s_aTrunkPolicyHost[] =
1603 {
1604 { "promisc", INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED | INTNET_OPEN_FLAGS_TRUNK_HOST_PROMISC_MODE },
1605 { "enabled", INTNET_OPEN_FLAGS_TRUNK_HOST_ENABLED },
1606 { "disabled", INTNET_OPEN_FLAGS_TRUNK_HOST_DISABLED }
1607 };
1608 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "TrunkPolicyHost", &s_aTrunkPolicyHost[0], RT_ELEMENTS(s_aTrunkPolicyHost),
1609 INTNET_OPEN_FLAGS_TRUNK_FIXED, &OpenReq.fFlags);
1610 AssertRCReturn(rc, rc);
1611 /** @cfgm{TrunkPolicyWire, string, "none"}
1612 * The trunk-host policy: promisc, promisc+fixed, enabled, enabled+fixed,
1613 * disabled, disabled+fixed, none or fixed.
1614 *
1615 * This can be used to prevent packages to be routed to the wire. */
1616 static const DRVINTNETFLAG s_aTrunkPolicyWire[] =
1617 {
1618 { "promisc", INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED | INTNET_OPEN_FLAGS_TRUNK_WIRE_PROMISC_MODE },
1619 { "enabled", INTNET_OPEN_FLAGS_TRUNK_WIRE_ENABLED },
1620 { "disabled", INTNET_OPEN_FLAGS_TRUNK_WIRE_DISABLED }
1621 };
1622 rc = drvIntNetR3CfgGetPolicy(pDrvIns, "TrunkPolicyWire", &s_aTrunkPolicyWire[0], RT_ELEMENTS(s_aTrunkPolicyWire),
1623 INTNET_OPEN_FLAGS_TRUNK_FIXED, &OpenReq.fFlags);
1624 AssertRCReturn(rc, rc);
1625
1626
1627 /** @cfgm{ReceiveBufferSize, uint32_t, 318 KB}
1628 * The size of the receive buffer.
1629 */
1630 rc = CFGMR3QueryU32(pCfg, "ReceiveBufferSize", &OpenReq.cbRecv);
1631 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1632 OpenReq.cbRecv = 318 * _1K ;
1633 else if (RT_FAILURE(rc))
1634 return PDMDRV_SET_ERROR(pDrvIns, rc,
1635 N_("Configuration error: Failed to get the \"ReceiveBufferSize\" value"));
1636
1637 /** @cfgm{SendBufferSize, uint32_t, 196 KB}
1638 * The size of the send (transmit) buffer.
1639 * This should be more than twice the size of the larges frame size because
1640 * the ring buffer is very simple and doesn't support splitting up frames
1641 * nor inserting padding. So, if this is too close to the frame size the
1642 * header will fragment the buffer such that the frame won't fit on either
1643 * side of it and the code will get very upset about it all.
1644 */
1645 rc = CFGMR3QueryU32(pCfg, "SendBufferSize", &OpenReq.cbSend);
1646 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1647 OpenReq.cbSend = RT_ALIGN_Z(VBOX_MAX_GSO_SIZE * 3, _1K);
1648 else if (RT_FAILURE(rc))
1649 return PDMDRV_SET_ERROR(pDrvIns, rc,
1650 N_("Configuration error: Failed to get the \"SendBufferSize\" value"));
1651 if (OpenReq.cbSend < 128)
1652 return PDMDRV_SET_ERROR(pDrvIns, rc,
1653 N_("Configuration error: The \"SendBufferSize\" value is too small"));
1654 if (OpenReq.cbSend < VBOX_MAX_GSO_SIZE * 3)
1655 LogRel(("DrvIntNet: Warning! SendBufferSize=%u, Recommended minimum size %u butes.\n", OpenReq.cbSend, VBOX_MAX_GSO_SIZE * 4));
1656
1657 /** @cfgm{IsService, boolean, true}
1658 * This alterns the way the thread is suspended and resumed. When it's being used by
1659 * a service such as LWIP/iSCSI it shouldn't suspend immediately like for a NIC.
1660 */
1661 rc = CFGMR3QueryBool(pCfg, "IsService", &pThis->fActivateEarlyDeactivateLate);
1662 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1663 pThis->fActivateEarlyDeactivateLate = false;
1664 else if (RT_FAILURE(rc))
1665 return PDMDRV_SET_ERROR(pDrvIns, rc,
1666 N_("Configuration error: Failed to get the \"IsService\" value"));
1667
1668
1669 /** @cfgm{IgnoreConnectFailure, boolean, false}
1670 * When set only raise a runtime error if we cannot connect to the internal
1671 * network. */
1672 bool fIgnoreConnectFailure;
1673 rc = CFGMR3QueryBoolDef(pCfg, "IgnoreConnectFailure", &fIgnoreConnectFailure, false);
1674 if (RT_FAILURE(rc))
1675 return PDMDRV_SET_ERROR(pDrvIns, rc,
1676 N_("Configuration error: Failed to get the \"IgnoreConnectFailure\" value"));
1677
1678 /** @cfgm{Workaround1, boolean, depends}
1679 * Enables host specific workarounds, the default is depends on the whether
1680 * we think the host requires it or not.
1681 */
1682 bool fWorkaround1 = false;
1683#ifdef RT_OS_DARWIN
1684 if (OpenReq.fFlags & INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE)
1685 {
1686 char szKrnlVer[256];
1687 RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szKrnlVer, sizeof(szKrnlVer));
1688 if (strcmp(szKrnlVer, "10.7.0") >= 0)
1689 {
1690 LogRel(("IntNet#%u: Enables the workaround (ip_tos=0) for the little endian ip header checksum problem\n"));
1691 fWorkaround1 = true;
1692 }
1693 }
1694#endif
1695 rc = CFGMR3QueryBoolDef(pCfg, "Workaround1", &fWorkaround1, fWorkaround1);
1696 if (RT_FAILURE(rc))
1697 return PDMDRV_SET_ERROR(pDrvIns, rc,
1698 N_("Configuration error: Failed to get the \"Workaround1\" value"));
1699 if (fWorkaround1)
1700 OpenReq.fFlags |= INTNET_OPEN_FLAGS_WORKAROUND_1;
1701
1702 LogRel(("IntNet#%u: szNetwork={%s} enmTrunkType=%d szTrunk={%s} fFlags=%#x cbRecv=%u cbSend=%u fIgnoreConnectFailure=%RTbool\n",
1703 pDrvIns->iInstance, OpenReq.szNetwork, OpenReq.enmTrunkType, OpenReq.szTrunk, OpenReq.fFlags,
1704 OpenReq.cbRecv, OpenReq.cbSend, fIgnoreConnectFailure));
1705
1706#ifdef RT_OS_DARWIN
1707 /* Temporary hack: attach to a network with the name 'if=en0' and you're hitting the wire. */
1708 if ( !OpenReq.szTrunk[0]
1709 && OpenReq.enmTrunkType == kIntNetTrunkType_None
1710 && !strncmp(pThis->szNetwork, RT_STR_TUPLE("if=en"))
1711 && RT_C_IS_DIGIT(pThis->szNetwork[sizeof("if=en") - 1])
1712 && !pThis->szNetwork[sizeof("if=en")])
1713 {
1714 OpenReq.enmTrunkType = kIntNetTrunkType_NetFlt;
1715 strcpy(OpenReq.szTrunk, &pThis->szNetwork[sizeof("if=") - 1]);
1716 }
1717 /* Temporary hack: attach to a network with the name 'wif=en0' and you're on the air. */
1718 if ( !OpenReq.szTrunk[0]
1719 && OpenReq.enmTrunkType == kIntNetTrunkType_None
1720 && !strncmp(pThis->szNetwork, RT_STR_TUPLE("wif=en"))
1721 && RT_C_IS_DIGIT(pThis->szNetwork[sizeof("wif=en") - 1])
1722 && !pThis->szNetwork[sizeof("wif=en")])
1723 {
1724 OpenReq.enmTrunkType = kIntNetTrunkType_NetFlt;
1725 OpenReq.fFlags |= INTNET_OPEN_FLAGS_SHARED_MAC_ON_WIRE;
1726 strcpy(OpenReq.szTrunk, &pThis->szNetwork[sizeof("wif=") - 1]);
1727 }
1728#endif /* DARWIN */
1729
1730 /*
1731 * Create the event semaphore, S/G cache and xmit critsect.
1732 */
1733 rc = RTSemEventCreate(&pThis->hRecvEvt);
1734 if (RT_FAILURE(rc))
1735 return rc;
1736 rc = RTMemCacheCreate(&pThis->hSgCache, sizeof(PDMSCATTERGATHER), 0, UINT32_MAX, NULL, NULL, pThis, 0);
1737 if (RT_FAILURE(rc))
1738 return rc;
1739 rc = PDMDrvHlpCritSectInit(pDrvIns, &pThis->XmitLock, RT_SRC_POS, "IntNetXmit");
1740 if (RT_FAILURE(rc))
1741 return rc;
1742
1743 /*
1744 * Create the interface.
1745 */
1746 OpenReq.hIf = INTNET_HANDLE_INVALID;
1747 rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_OPEN, &OpenReq, sizeof(OpenReq));
1748 if (RT_FAILURE(rc))
1749 {
1750 if (fIgnoreConnectFailure)
1751 {
1752 /*
1753 * During VM restore it is fatal if the network is not available because the
1754 * VM settings are locked and the user has no chance to fix network settings.
1755 * Therefore don't abort but just raise a runtime warning.
1756 */
1757 PDMDrvHlpVMSetRuntimeError(pDrvIns, 0 /*fFlags*/, "HostIfNotConnecting",
1758 N_ ("Cannot connect to the network interface '%s'. The virtual "
1759 "network card will appear to work but the guest will not "
1760 "be able to connect. Please choose a different network in the "
1761 "network settings"), OpenReq.szTrunk);
1762
1763 return VERR_PDM_NO_ATTACHED_DRIVER;
1764 }
1765 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1766 N_("Failed to open/create the internal network '%s'"), pThis->szNetwork);
1767 }
1768
1769 AssertRelease(OpenReq.hIf != INTNET_HANDLE_INVALID);
1770 pThis->hIf = OpenReq.hIf;
1771 Log(("IntNet%d: hIf=%RX32 '%s'\n", pDrvIns->iInstance, pThis->hIf, pThis->szNetwork));
1772
1773 /*
1774 * Get default buffer.
1775 */
1776 INTNETIFGETBUFFERPTRSREQ GetBufferPtrsReq;
1777 GetBufferPtrsReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1778 GetBufferPtrsReq.Hdr.cbReq = sizeof(GetBufferPtrsReq);
1779 GetBufferPtrsReq.pSession = NIL_RTR0PTR;
1780 GetBufferPtrsReq.hIf = pThis->hIf;
1781 GetBufferPtrsReq.pRing3Buf = NULL;
1782 GetBufferPtrsReq.pRing0Buf = NIL_RTR0PTR;
1783 rc = PDMDrvHlpSUPCallVMMR0Ex(pDrvIns, VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS, &GetBufferPtrsReq, sizeof(GetBufferPtrsReq));
1784 if (RT_FAILURE(rc))
1785 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1786 N_("Failed to get ring-3 buffer for the newly created interface to '%s'"), pThis->szNetwork);
1787 AssertRelease(VALID_PTR(GetBufferPtrsReq.pRing3Buf));
1788 pThis->pBufR3 = GetBufferPtrsReq.pRing3Buf;
1789 pThis->pBufR0 = GetBufferPtrsReq.pRing0Buf;
1790
1791 /*
1792 * Register statistics.
1793 */
1794 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->pBufR3->Recv.cbStatWritten, "Bytes/Received", STAMUNIT_BYTES, "Number of received bytes.");
1795 PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->pBufR3->Send.cbStatWritten, "Bytes/Sent", STAMUNIT_BYTES, "Number of sent bytes.");
1796 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Recv.cOverflows, "Overflows/Recv", "Number overflows.");
1797 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Send.cOverflows, "Overflows/Sent", "Number overflows.");
1798 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Recv.cStatFrames, "Packets/Received", "Number of received packets.");
1799 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->Send.cStatFrames, "Packets/Sent", "Number of sent packets.");
1800 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatReceivedGso, "Packets/Received-Gso", "The GSO portion of the received packets.");
1801 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatSentGso, "Packets/Sent-Gso", "The GSO portion of the sent packets.");
1802 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatSentR0, "Packets/Sent-R0", "The ring-0 portion of the sent packets.");
1803
1804 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatLost, "Packets/Lost", "Number of lost packets.");
1805 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatYieldsNok, "YieldOk", "Number of times yielding helped fix an overflow.");
1806 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatYieldsOk, "YieldNok", "Number of times yielding didn't help fix an overflow.");
1807 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->pBufR3->cStatBadFrames, "BadFrames", "Number of bad frames seed by the consumers.");
1808 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatSend1, "Send1", "Profiling IntNetR0IfSend.");
1809 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatSend2, "Send2", "Profiling sending to the trunk.");
1810 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatRecv1, "Recv1", "Reserved for future receive profiling.");
1811 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatRecv2, "Recv2", "Reserved for future receive profiling.");
1812 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->pBufR3->StatReserved, "Reserved", "Reserved for future use.");
1813#ifdef VBOX_WITH_STATISTICS
1814 PDMDrvHlpSTAMRegProfileAdv(pDrvIns, &pThis->StatReceive, "Receive", "Profiling packet receive runs.");
1815 PDMDrvHlpSTAMRegProfile(pDrvIns, &pThis->StatTransmit, "Transmit", "Profiling packet transmit runs.");
1816#endif
1817 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitWakeupR0, "XmitWakeup-R0", "Xmit thread wakeups from ring-0.");
1818 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitWakeupR3, "XmitWakeup-R3", "Xmit thread wakeups from ring-3.");
1819 PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitProcessRing, "XmitProcessRing", "Time xmit thread was told to process the ring.");
1820
1821 /*
1822 * Create the async I/O threads.
1823 * Note! Using a PDM thread here doesn't fit with the IsService=true operation.
1824 */
1825 rc = RTThreadCreate(&pThis->hRecvThread, drvR3IntNetRecvThread, pThis, 0,
1826 RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "INTNET-RECV");
1827 if (RT_FAILURE(rc))
1828 {
1829 AssertRC(rc);
1830 return rc;
1831 }
1832
1833 rc = SUPSemEventCreate(pThis->pSupDrvSession, &pThis->hXmitEvt);
1834 AssertRCReturn(rc, rc);
1835
1836 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pXmitThread, pThis,
1837 drvR3IntNetXmitThread, drvR3IntNetXmitWakeUp, 0, RTTHREADTYPE_IO, "INTNET-XMIT");
1838 AssertRCReturn(rc, rc);
1839
1840#ifdef VBOX_WITH_DRVINTNET_IN_R0
1841 /*
1842 * Resolve the ring-0 context interface addresses.
1843 */
1844 rc = pDrvIns->pHlpR3->pfnLdrGetR0InterfaceSymbols(pDrvIns, &pThis->INetworkUpR0, sizeof(pThis->INetworkUpR0),
1845 "drvIntNetUp_", PDMINETWORKUP_SYM_LIST);
1846 AssertLogRelRCReturn(rc, rc);
1847#endif
1848
1849 /*
1850 * Activate data transmission as early as possible
1851 */
1852 if (pThis->fActivateEarlyDeactivateLate)
1853 {
1854 ASMAtomicXchgSize(&pThis->enmRecvState, RECVSTATE_RUNNING);
1855 RTSemEventSignal(pThis->hRecvEvt);
1856
1857 drvR3IntNetUpdateMacAddress(pThis);
1858 drvR3IntNetSetActive(pThis, true /* fActive */);
1859 }
1860
1861 return rc;
1862}
1863
1864
1865
1866/**
1867 * Internal networking transport driver registration record.
1868 */
1869const PDMDRVREG g_DrvIntNet =
1870{
1871 /* u32Version */
1872 PDM_DRVREG_VERSION,
1873 /* szName */
1874 "IntNet",
1875 /* szRCMod */
1876 "VBoxDDRC.rc",
1877 /* szR0Mod */
1878 "VBoxDDR0.r0",
1879 /* pszDescription */
1880 "Internal Networking Transport Driver",
1881 /* fFlags */
1882#ifdef VBOX_WITH_DRVINTNET_IN_R0
1883 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT | PDM_DRVREG_FLAGS_R0,
1884#else
1885 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1886#endif
1887 /* fClass. */
1888 PDM_DRVREG_CLASS_NETWORK,
1889 /* cMaxInstances */
1890 ~0U,
1891 /* cbInstance */
1892 sizeof(DRVINTNET),
1893 /* pfnConstruct */
1894 drvR3IntNetConstruct,
1895 /* pfnDestruct */
1896 drvR3IntNetDestruct,
1897 /* pfnRelocate */
1898 drvR3IntNetRelocate,
1899 /* pfnIOCtl */
1900 NULL,
1901 /* pfnPowerOn */
1902 drvR3IntNetPowerOn,
1903 /* pfnReset */
1904 NULL,
1905 /* pfnSuspend */
1906 drvR3IntNetSuspend,
1907 /* pfnResume */
1908 drvR3IntNetResume,
1909 /* pfnAttach */
1910 NULL,
1911 /* pfnDetach */
1912 NULL,
1913 /* pfnPowerOff */
1914 drvR3IntNetPowerOff,
1915 /* pfnSoftReset */
1916 NULL,
1917 /* u32EndVersion */
1918 PDM_DRVREG_VERSION
1919};
1920
1921#endif /* IN_RING3 */
1922
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use