VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/DrvNAT.cpp@ 28320

Last change on this file since 28320 was 28275, checked in by vboxsync, 15 years ago

Devices/Network: Call pfnBeginXmit and pfnEndXmit.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 46.8 KB
Line 
1/* $Id: DrvNAT.cpp 28275 2010-04-13 19:40:10Z vboxsync $ */
2/** @file
3 * DrvNAT - NAT network transport driver.
4 */
5
6/*
7 * Copyright (C) 2006-2010 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22
23/*******************************************************************************
24* Header Files *
25*******************************************************************************/
26#define LOG_GROUP LOG_GROUP_DRV_NAT
27#define __STDC_LIMIT_MACROS
28#define __STDC_CONSTANT_MACROS
29#include "slirp/libslirp.h"
30#include "slirp/ctl.h"
31#include <VBox/pdmdrv.h>
32#include <VBox/pdmnetifs.h>
33#include <VBox/pdmnetinline.h>
34#include <iprt/assert.h>
35#include <iprt/file.h>
36#include <iprt/mem.h>
37#include <iprt/string.h>
38#include <iprt/critsect.h>
39#include <iprt/cidr.h>
40#include <iprt/stream.h>
41#include <iprt/uuid.h>
42
43#include "Builtins.h"
44
45#ifndef RT_OS_WINDOWS
46# include <unistd.h>
47# include <fcntl.h>
48# include <poll.h>
49# include <errno.h>
50#endif
51#ifdef RT_OS_FREEBSD
52# include <netinet/in.h>
53#endif
54#include <iprt/semaphore.h>
55#include <iprt/req.h>
56
57#define COUNTERS_INIT
58#include "counters.h"
59
60
61/*******************************************************************************
62* Defined Constants And Macros *
63*******************************************************************************/
64
65/**
66 * @todo: This is a bad hack to prevent freezing the guest during high network
67 * activity. Windows host only. This needs to be fixed properly.
68 */
69#define VBOX_NAT_DELAY_HACK
70
71#define GET_EXTRADATA(pthis, node, name, rc, type, type_name, var) \
72do { \
73 (rc) = CFGMR3Query ## type((node), name, &(var)); \
74 if (RT_FAILURE((rc)) && (rc) != VERR_CFGM_VALUE_NOT_FOUND) \
75 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \""name"\" " #type_name " failed"), \
76 (pthis)->pDrvIns->iInstance); \
77} while (0)
78
79#define GET_ED_STRICT(pthis, node, name, rc, type, type_name, var) \
80do { \
81 (rc) = CFGMR3Query ## type((node), name, &(var)); \
82 if (RT_FAILURE((rc))) \
83 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \""name"\" " #type_name " failed"), \
84 (pthis)->pDrvIns->iInstance); \
85} while (0)
86
87#define GET_EXTRADATA_N(pthis, node, name, rc, type, type_name, var, var_size) \
88do { \
89 (rc) = CFGMR3Query ## type((node), name, &(var), var_size); \
90 if (RT_FAILURE((rc)) && (rc) != VERR_CFGM_VALUE_NOT_FOUND) \
91 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \""name"\" " #type_name " failed"), \
92 (pthis)->pDrvIns->iInstance); \
93} while (0)
94
95#define GET_BOOL(rc, pthis, node, name, var) \
96 GET_EXTRADATA(pthis, node, name, (rc), Bool, bolean, (var))
97#define GET_STRING(rc, pthis, node, name, var, var_size) \
98 GET_EXTRADATA_N(pthis, node, name, (rc), String, string, (var), (var_size))
99#define GET_STRING_ALLOC(rc, pthis, node, name, var) \
100 GET_EXTRADATA(pthis, node, name, (rc), StringAlloc, string, (var))
101#define GET_S32(rc, pthis, node, name, var) \
102 GET_EXTRADATA(pthis, node, name, (rc), S32, int, (var))
103#define GET_S32_STRICT(rc, pthis, node, name, var) \
104 GET_ED_STRICT(pthis, node, name, (rc), S32, int, (var))
105
106
107
108#define DO_GET_IP(rc, node, instance, status, x) \
109do { \
110 char sz##x[32]; \
111 GET_STRING((rc), (node), (instance), #x, sz ## x[0], sizeof(sz ## x)); \
112 if (rc != VERR_CFGM_VALUE_NOT_FOUND) \
113 (status) = inet_aton(sz ## x, &x); \
114} while (0)
115
116#define GETIP_DEF(rc, node, instance, x, def) \
117do \
118{ \
119 int status = 0; \
120 DO_GET_IP((rc), (node), (instance), status, x); \
121 if (status == 0 || rc == VERR_CFGM_VALUE_NOT_FOUND) \
122 x.s_addr = def; \
123} while (0)
124
125/*******************************************************************************
126* Structures and Typedefs *
127*******************************************************************************/
128/**
129 * NAT network transport driver instance data.
130 *
131 * @implements PDMINETWORKUP
132 */
133typedef struct DRVNAT
134{
135 /** The network interface. */
136 PDMINETWORKUP INetworkUp;
137 /** The port we're attached to. */
138 PPDMINETWORKDOWN pIAboveNet;
139 /** The network config of the port we're attached to. */
140 PPDMINETWORKCONFIG pIAboveConfig;
141 /** Pointer to the driver instance. */
142 PPDMDRVINS pDrvIns;
143 /** Link state */
144 PDMNETWORKLINKSTATE enmLinkState;
145 /** NAT state for this instance. */
146 PNATState pNATState;
147 /** TFTP directory prefix. */
148 char *pszTFTPPrefix;
149 /** Boot file name to provide in the DHCP server response. */
150 char *pszBootFile;
151 /** tftp server name to provide in the DHCP server response. */
152 char *pszNextServer;
153 /** Polling thread. */
154 PPDMTHREAD pSlirpThread;
155 /** Queue for NAT-thread-external events. */
156 PRTREQQUEUE pSlirpReqQueue;
157 /** The guest IP for port-forwarding. */
158 uint32_t GuestIP;
159 uint32_t alignment1;
160
161#ifdef VBOX_WITH_SLIRP_MT
162 PPDMTHREAD pGuestThread;
163#endif
164#ifndef RT_OS_WINDOWS
165 /** The write end of the control pipe. */
166 RTFILE PipeWrite;
167 /** The read end of the control pipe. */
168 RTFILE PipeRead;
169# if HC_ARCH_BITS == 32
170 /** Alignment padding. */
171 uint32_t alignment2;
172# endif
173#else
174 /** for external notification */
175 HANDLE hWakeupEvent;
176#endif
177
178#define DRV_PROFILE_COUNTER(name, dsc) STAMPROFILE Stat ## name
179#define DRV_COUNTING_COUNTER(name, dsc) STAMCOUNTER Stat ## name
180#include "counters.h"
181 /** thread delivering packets for receiving by the guest */
182 PPDMTHREAD pRecvThread;
183 /** thread delivering urg packets for receiving by the guest */
184 PPDMTHREAD pUrgRecvThread;
185 /** event to wakeup the guest receive thread */
186 RTSEMEVENT EventRecv;
187 /** event to wakeup the guest urgent receive thread */
188 RTSEMEVENT EventUrgRecv;
189 /** Receive Req queue (deliver packets to the guest) */
190 PRTREQQUEUE pRecvReqQueue;
191 /** Receive Urgent Req queue (deliver packets to the guest). */
192 PRTREQQUEUE pUrgRecvReqQueue;
193
194 /** makes access to device func RecvAvail and Recv atomical. */
195 RTCRITSECT DevAccessLock;
196 /** Number of in-flight urgent packets. */
197 volatile uint32_t cUrgPkts;
198 /** Number of in-flight regular packets. */
199 volatile uint32_t cPkts;
200
201 /** Transmit lock taken by BeginXmit and released by EndXmit. */
202 RTCRITSECT XmitLock;
203} DRVNAT;
204AssertCompileMemberAlignment(DRVNAT, StatNATRecvWakeups, 8);
205/** Pointer the NAT driver instance data. */
206typedef DRVNAT *PDRVNAT;
207
208/**
209 * NAT queue item.
210 */
211typedef struct DRVNATQUEUITEM
212{
213 /** The core part owned by the queue manager. */
214 PDMQUEUEITEMCORE Core;
215 /** The buffer for output to guest. */
216 const uint8_t *pu8Buf;
217 /* size of buffer */
218 size_t cb;
219 void *mbuf;
220} DRVNATQUEUITEM;
221/** Pointer to a NAT queue item. */
222typedef DRVNATQUEUITEM *PDRVNATQUEUITEM;
223
224
225/*******************************************************************************
226* Internal Functions *
227*******************************************************************************/
228static void drvNATNotifyNATThread(PDRVNAT pThis, const char *pszWho);
229
230
231
232static DECLCALLBACK(int) drvNATRecv(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
233{
234 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
235
236 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
237 return VINF_SUCCESS;
238
239 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
240 {
241 RTReqProcess(pThis->pRecvReqQueue, 0);
242 if (ASMAtomicReadU32(&pThis->cPkts) == 0)
243 RTSemEventWait(pThis->EventRecv, RT_INDEFINITE_WAIT);
244 }
245 return VINF_SUCCESS;
246}
247
248
249static DECLCALLBACK(int) drvNATRecvWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
250{
251 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
252 int rc;
253 rc = RTSemEventSignal(pThis->EventRecv);
254
255 STAM_COUNTER_INC(&pThis->StatNATRecvWakeups);
256 return VINF_SUCCESS;
257}
258
259static DECLCALLBACK(int) drvNATUrgRecv(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
260{
261 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
262
263 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
264 return VINF_SUCCESS;
265
266 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
267 {
268 RTReqProcess(pThis->pUrgRecvReqQueue, 0);
269 if (ASMAtomicReadU32(&pThis->cUrgPkts) == 0)
270 {
271 int rc = RTSemEventWait(pThis->EventUrgRecv, RT_INDEFINITE_WAIT);
272 AssertRC(rc);
273 }
274 }
275 return VINF_SUCCESS;
276}
277
278static DECLCALLBACK(int) drvNATUrgRecvWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
279{
280 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
281 int rc = RTSemEventSignal(pThis->EventUrgRecv);
282 AssertRC(rc);
283
284 return VINF_SUCCESS;
285}
286
287static DECLCALLBACK(void) drvNATUrgRecvWorker(PDRVNAT pThis, uint8_t *pu8Buf, int cb, struct mbuf *m)
288{
289 int rc = RTCritSectEnter(&pThis->DevAccessLock);
290 AssertRC(rc);
291 rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
292 if (RT_SUCCESS(rc))
293 {
294 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pu8Buf, cb);
295 AssertRC(rc);
296 }
297 else if ( RT_FAILURE(rc)
298 && ( rc == VERR_TIMEOUT
299 && rc == VERR_INTERRUPTED))
300 {
301 AssertRC(rc);
302 }
303
304 rc = RTCritSectLeave(&pThis->DevAccessLock);
305 AssertRC(rc);
306
307 slirp_ext_m_free(pThis->pNATState, m);
308#ifdef VBOX_WITH_SLIRP_BSD_MBUF
309 RTMemFree(pu8Buf);
310#endif
311 if (ASMAtomicDecU32(&pThis->cUrgPkts) == 0)
312 {
313 drvNATRecvWakeup(pThis->pDrvIns, pThis->pRecvThread);
314 drvNATNotifyNATThread(pThis, "drvNATUrgRecvWorker");
315 }
316}
317
318
319static DECLCALLBACK(void) drvNATRecvWorker(PDRVNAT pThis, uint8_t *pu8Buf, int cb, struct mbuf *m)
320{
321 int rc;
322 STAM_PROFILE_START(&pThis->StatNATRecv, a);
323
324 STAM_PROFILE_START(&pThis->StatNATRecvWait, b);
325
326 while (ASMAtomicReadU32(&pThis->cUrgPkts) != 0)
327 {
328 rc = RTSemEventWait(pThis->EventRecv, RT_INDEFINITE_WAIT);
329 if ( RT_FAILURE(rc)
330 && ( rc == VERR_TIMEOUT
331 || rc == VERR_INTERRUPTED))
332 goto done_unlocked;
333 }
334
335 rc = RTCritSectEnter(&pThis->DevAccessLock);
336 AssertRC(rc);
337
338 rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
339 if (RT_SUCCESS(rc))
340 {
341 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pu8Buf, cb);
342 AssertRC(rc);
343 }
344 else if ( RT_FAILURE(rc)
345 && rc != VERR_TIMEOUT
346 && rc != VERR_INTERRUPTED)
347 {
348 AssertRC(rc);
349 }
350
351 rc = RTCritSectLeave(&pThis->DevAccessLock);
352 AssertRC(rc);
353
354done_unlocked:
355 slirp_ext_m_free(pThis->pNATState, m);
356#ifdef VBOX_WITH_SLIRP_BSD_MBUF
357 RTMemFree(pu8Buf);
358#endif
359 ASMAtomicDecU32(&pThis->cPkts);
360
361 drvNATNotifyNATThread(pThis, "drvNATRecvWorker");
362
363 STAM_PROFILE_STOP(&pThis->StatNATRecvWait, b);
364 STAM_PROFILE_STOP(&pThis->StatNATRecv, a);
365}
366
367/**
368 * Frees a S/G buffer allocated by drvNATNetworkUp_AllocBuf.
369 *
370 * @param pThis Pointer to the NAT instance.
371 * @param pSgBuf The S/G buffer to free.
372 */
373static void drvNATFreeSgBuf(PDRVNAT pThis, PPDMSCATTERGATHER pSgBuf)
374{
375 Assert((pSgBuf->fFlags & PDMSCATTERGATHER_FLAGS_MAGIC_MASK) == PDMSCATTERGATHER_FLAGS_MAGIC);
376 pSgBuf->fFlags = 0;
377 if (pSgBuf->pvAllocator)
378 {
379 Assert(!pSgBuf->pvUser);
380 slirp_ext_m_free(pThis->pNATState, (struct mbuf *)pSgBuf->pvAllocator);
381 pSgBuf->pvAllocator = NULL;
382 }
383 else if (pSgBuf->pvUser)
384 {
385 RTMemFree(pSgBuf->aSegs[0].pvSeg);
386 pSgBuf->aSegs[0].pvSeg = NULL;
387 RTMemFree(pSgBuf->pvUser);
388 pSgBuf->pvUser = NULL;
389 }
390 RTMemFree(pSgBuf);
391}
392
393/**
394 * Worker function for drvNATSend().
395 *
396 * @param pThis Pointer to the NAT instance.
397 * @param pSgBuf The scatter/gather buffer.
398 * @thread NAT
399 */
400static void drvNATSendWorker(PDRVNAT pThis, PPDMSCATTERGATHER pSgBuf)
401{
402 Assert(pThis->enmLinkState == PDMNETWORKLINKSTATE_UP);
403 if (pThis->enmLinkState == PDMNETWORKLINKSTATE_UP)
404 {
405 struct mbuf *m = (struct mbuf *)pSgBuf->pvAllocator;
406 if (m)
407 {
408 /*
409 * A normal frame.
410 */
411 pSgBuf->pvAllocator = NULL;
412 slirp_input(pThis->pNATState, m, pSgBuf->cbUsed);
413 }
414 else
415 {
416 /*
417 * GSO frame, need to segment it.
418 */
419 /** @todo Make the NAT engine grok large frames? Could be more efficient... */
420#if 0 /* this is for testing PDMNetGsoCarveSegmentQD. */
421 uint8_t abHdrScratch[256];
422#endif
423 uint8_t const *pbFrame = (uint8_t const *)pSgBuf->aSegs[0].pvSeg;
424 PCPDMNETWORKGSO pGso = (PCPDMNETWORKGSO)pSgBuf->pvUser;
425 uint32_t const cSegs = PDMNetGsoCalcSegmentCount(pGso, pSgBuf->cbUsed); Assert(cSegs > 1);
426 for (size_t iSeg = 0; iSeg < cSegs; iSeg++)
427 {
428 size_t cbSeg;
429 void *pvSeg;
430 m = slirp_ext_m_get(pThis->pNATState, pGso->cbHdrs + pGso->cbMaxSeg, &pvSeg, &cbSeg);
431 if (!m)
432 break;
433
434#if 1
435 uint32_t cbPayload;
436 uint32_t offPayload = PDMNetGsoCarveSegment(pGso, pbFrame, pSgBuf->cbUsed,
437 iSeg, cSegs, (uint8_t *)pvSeg, &cbPayload);
438 memcpy((uint8_t *)pvSeg + pGso->cbHdrs, pbFrame + offPayload, cbPayload);
439
440 slirp_input(pThis->pNATState, m, cbPayload + pGso->cbHdrs);
441#else
442 uint32_t cbSegFrame;
443 void *pvSegFrame = PDMNetGsoCarveSegmentQD(pGso, (uint8_t *)pbFrame, pSgBuf->cbUsed, abHdrScratch,
444 iSeg, cSegs, &cbSegFrame);
445 memcpy((uint8_t *)pvSeg, pvSegFrame, cbSegFrame);
446
447 slirp_input(pThis->pNATState, m, cbSegFrame);
448#endif
449 }
450 }
451 }
452 drvNATFreeSgBuf(pThis, pSgBuf);
453
454 /** @todo Implement the VERR_TRY_AGAIN drvNATNetworkUp_AllocBuf sematics. */
455}
456
457/**
458 * @interface_method_impl{PDMINETWORKUP,pfnBeginXmit}
459 */
460static DECLCALLBACK(int) drvNATNetworkUp_BeginXmit(PPDMINETWORKUP pInterface, bool fOnWorkerThread)
461{
462 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
463 int rc = RTCritSectTryEnter(&pThis->XmitLock);
464 if (RT_FAILURE(rc))
465 {
466 /** @todo Kick the worker thread when we have one... */
467 rc = VERR_TRY_AGAIN;
468 }
469 return rc;
470}
471
472/**
473 * @interface_method_impl{PDMINETWORKUP,pfnAllocBuf}
474 */
475static DECLCALLBACK(int) drvNATNetworkUp_AllocBuf(PPDMINETWORKUP pInterface, size_t cbMin,
476 PCPDMNETWORKGSO pGso, PPPDMSCATTERGATHER ppSgBuf)
477{
478 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
479 Assert(RTCritSectIsOwner(&pThis->XmitLock));
480
481 /*
482 * Drop the incoming frame if the NAT thread isn't running.
483 */
484 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
485 {
486 Log(("drvNATNetowrkUp_AllocBuf: returns VERR_NET_NO_NETWORK\n"));
487 return VERR_NET_NO_NETWORK;
488 }
489
490 /*
491 * Allocate a scatter/gather buffer and an mbuf.
492 */
493 PPDMSCATTERGATHER pSgBuf = (PPDMSCATTERGATHER)RTMemAlloc(sizeof(*pSgBuf));
494 if (!pSgBuf)
495 return VERR_NO_MEMORY;
496 if (!pGso)
497 {
498 pSgBuf->pvUser = NULL;
499 pSgBuf->pvAllocator = slirp_ext_m_get(pThis->pNATState, cbMin,
500 &pSgBuf->aSegs[0].pvSeg, &pSgBuf->aSegs[0].cbSeg);
501 if (!pSgBuf->pvAllocator)
502 {
503 RTMemFree(pSgBuf);
504 /** @todo Implement the VERR_TRY_AGAIN semantics. */
505 return VERR_NO_MEMORY;
506 }
507 }
508 else
509 {
510 pSgBuf->pvUser = RTMemDup(pGso, sizeof(*pGso));
511 pSgBuf->pvAllocator = NULL;
512 pSgBuf->aSegs[0].cbSeg = RT_ALIGN_Z(cbMin, 16);
513 pSgBuf->aSegs[0].pvSeg = RTMemAlloc(pSgBuf->aSegs[0].cbSeg);
514 if (!pSgBuf->pvUser || !pSgBuf->aSegs[0].pvSeg)
515 {
516 RTMemFree(pSgBuf->aSegs[0].pvSeg);
517 RTMemFree(pSgBuf->pvUser);
518 RTMemFree(pSgBuf);
519 /** @todo Implement the VERR_TRY_AGAIN semantics. */
520 return VERR_NO_MEMORY;
521 }
522 }
523
524 /*
525 * Initialize the S/G buffer and return.
526 */
527 pSgBuf->fFlags = PDMSCATTERGATHER_FLAGS_MAGIC | PDMSCATTERGATHER_FLAGS_OWNER_1;
528 pSgBuf->cbUsed = 0;
529 pSgBuf->cbAvailable = pSgBuf->aSegs[0].cbSeg;
530 pSgBuf->cSegs = 1;
531
532#if 0 /* poison */
533 memset(pSgBuf->aSegs[0].pvSeg, 'F', pSgBuf->aSegs[0].cbSeg);
534#endif
535 *ppSgBuf = pSgBuf;
536 return VINF_SUCCESS;
537}
538
539/**
540 * @interface_method_impl{PDMINETWORKUP,pfnFreeBuf}
541 */
542static DECLCALLBACK(int) drvNATNetworkUp_FreeBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf)
543{
544 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
545 Assert(RTCritSectIsOwner(&pThis->XmitLock));
546 drvNATFreeSgBuf(pThis, pSgBuf);
547 return VINF_SUCCESS;
548}
549
550/**
551 * @interface_method_impl{PDMINETWORKUP,pfnSendBuf}
552 */
553static DECLCALLBACK(int) drvNATNetworkUp_SendBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread)
554{
555 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
556 Assert((pSgBuf->fFlags & PDMSCATTERGATHER_FLAGS_OWNER_MASK) == PDMSCATTERGATHER_FLAGS_OWNER_1);
557 Assert(RTCritSectIsOwner(&pThis->XmitLock));
558
559 int rc;
560 if (pThis->pSlirpThread->enmState == PDMTHREADSTATE_RUNNING)
561 {
562#ifdef VBOX_WITH_SLIRP_MT
563 PRTREQQUEUE pQueue = (PRTREQQUEUE)slirp_get_queue(pThis->pNATState);
564#else
565 PRTREQQUEUE pQueue = pThis->pSlirpReqQueue;
566#endif
567 rc = RTReqCallEx(pQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
568 (PFNRT)drvNATSendWorker, 2, pThis, pSgBuf);
569 if (RT_SUCCESS(rc))
570 {
571 drvNATNotifyNATThread(pThis, "drvNATNetworkUp_SendBuf");
572 return VINF_SUCCESS;
573 }
574
575 rc = VERR_NET_NO_BUFFER_SPACE;
576 }
577 else
578 rc = VERR_NET_DOWN;
579 drvNATFreeSgBuf(pThis, pSgBuf);
580 return rc;
581}
582
583/**
584 * @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
585 */
586static DECLCALLBACK(void) drvNATNetworkUp_EndXmit(PPDMINETWORKUP pInterface)
587{
588 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
589 RTCritSectLeave(&pThis->XmitLock);
590}
591
592/**
593 * Get the NAT thread out of poll/WSAWaitForMultipleEvents
594 */
595static void drvNATNotifyNATThread(PDRVNAT pThis, const char *pszWho)
596{
597 int rc;
598#ifndef RT_OS_WINDOWS
599 /* kick poll() */
600 rc = RTFileWrite(pThis->PipeWrite, "", 1, NULL);
601#else
602 /* kick WSAWaitForMultipleEvents */
603 rc = WSASetEvent(pThis->hWakeupEvent);
604#endif
605 AssertRC(rc);
606}
607
608/**
609 * @interface_method_impl{PDMINETWORKUP,pfnSetPromiscuousMode}
610 */
611static DECLCALLBACK(void) drvNATNetworkUp_SetPromiscuousMode(PPDMINETWORKUP pInterface, bool fPromiscuous)
612{
613 LogFlow(("drvNATNetworkUp_SetPromiscuousMode: fPromiscuous=%d\n", fPromiscuous));
614 /* nothing to do */
615}
616
617/**
618 * Worker function for drvNATNetworkUp_NotifyLinkChanged().
619 * @thread "NAT" thread.
620 */
621static void drvNATNotifyLinkChangedWorker(PDRVNAT pThis, PDMNETWORKLINKSTATE enmLinkState)
622{
623 pThis->enmLinkState = enmLinkState;
624
625 switch (enmLinkState)
626 {
627 case PDMNETWORKLINKSTATE_UP:
628 LogRel(("NAT: link up\n"));
629 slirp_link_up(pThis->pNATState);
630 break;
631
632 case PDMNETWORKLINKSTATE_DOWN:
633 case PDMNETWORKLINKSTATE_DOWN_RESUME:
634 LogRel(("NAT: link down\n"));
635 slirp_link_down(pThis->pNATState);
636 break;
637
638 default:
639 AssertMsgFailed(("drvNATNetworkUp_NotifyLinkChanged: unexpected link state %d\n", enmLinkState));
640 }
641}
642
643/**
644 * Notification on link status changes.
645 *
646 * @param pInterface Pointer to the interface structure containing the called function pointer.
647 * @param enmLinkState The new link state.
648 * @thread EMT
649 */
650static DECLCALLBACK(void) drvNATNetworkUp_NotifyLinkChanged(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState)
651{
652 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
653
654 LogFlow(("drvNATNetworkUp_NotifyLinkChanged: enmLinkState=%d\n", enmLinkState));
655
656 /* don't queue new requests when the NAT thread is about to stop */
657 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
658 return;
659
660 PRTREQ pReq;
661 int rc = RTReqCallEx(pThis->pSlirpReqQueue, &pReq, 0 /*cMillies*/, RTREQFLAGS_VOID,
662 (PFNRT)drvNATNotifyLinkChangedWorker, 2, pThis, enmLinkState);
663 if (RT_LIKELY(rc == VERR_TIMEOUT))
664 {
665 drvNATNotifyNATThread(pThis, "drvNATNetworkUp_NotifyLinkChanged");
666 rc = RTReqWait(pReq, RT_INDEFINITE_WAIT);
667 AssertRC(rc);
668 }
669 else
670 AssertRC(rc);
671 RTReqFree(pReq);
672}
673
674/**
675 * NAT thread handling the slirp stuff.
676 *
677 * The slirp implementation is single-threaded so we execute this enginre in a
678 * dedicated thread. We take care that this thread does not become the
679 * bottleneck: If the guest wants to send, a request is enqueued into the
680 * pSlirpReqQueue and handled asynchronously by this thread. If this thread
681 * wants to deliver packets to the guest, it enqueues a request into
682 * pRecvReqQueue which is later handled by the Recv thread.
683 */
684static DECLCALLBACK(int) drvNATAsyncIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
685{
686 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
687 int nFDs = -1;
688 int ms;
689#ifdef RT_OS_WINDOWS
690 HANDLE *phEvents = slirp_get_events(pThis->pNATState);
691 unsigned int cBreak = 0;
692#else /* RT_OS_WINDOWS */
693 unsigned int cPollNegRet = 0;
694#endif /* !RT_OS_WINDOWS */
695
696 LogFlow(("drvNATAsyncIoThread: pThis=%p\n", pThis));
697
698 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
699 return VINF_SUCCESS;
700
701 /*
702 * Polling loop.
703 */
704 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
705 {
706 /*
707 * To prevent concurent execution of sending/receving threads
708 */
709#ifndef RT_OS_WINDOWS
710 nFDs = slirp_get_nsock(pThis->pNATState);
711 /* allocation for all sockets + Management pipe */
712 struct pollfd *polls = (struct pollfd *)RTMemAlloc((1 + nFDs) * sizeof(struct pollfd) + sizeof(uint32_t));
713 if (polls == NULL)
714 return VERR_NO_MEMORY;
715
716 /* don't pass the managemant pipe */
717 slirp_select_fill(pThis->pNATState, &nFDs, &polls[1]);
718
719 polls[0].fd = pThis->PipeRead;
720 /* POLLRDBAND usually doesn't used on Linux but seems used on Solaris */
721 polls[0].events = POLLRDNORM|POLLPRI|POLLRDBAND;
722 polls[0].revents = 0;
723
724 int cChangedFDs = poll(polls, nFDs + 1, slirp_get_timeout_ms(pThis->pNATState));
725 if (cChangedFDs < 0)
726 {
727 if (errno == EINTR)
728 {
729 Log2(("NAT: signal was caught while sleep on poll\n"));
730 /* No error, just process all outstanding requests but don't wait */
731 cChangedFDs = 0;
732 }
733 else if (cPollNegRet++ > 128)
734 {
735 LogRel(("NAT:Poll returns (%s) suppressed %d\n", strerror(errno), cPollNegRet));
736 cPollNegRet = 0;
737 }
738 }
739
740 if (cChangedFDs >= 0)
741 {
742 slirp_select_poll(pThis->pNATState, &polls[1], nFDs);
743 if (polls[0].revents & (POLLRDNORM|POLLPRI|POLLRDBAND))
744 {
745 /* drain the pipe */
746 char ch[1];
747 size_t cbRead;
748 int counter = 0;
749 /*
750 * drvNATSend decoupled so we don't know how many times
751 * device's thread sends before we've entered multiplex,
752 * so to avoid false alarm drain pipe here to the very end
753 *
754 * @todo: Probably we should counter drvNATSend to count how
755 * deep pipe has been filed before drain.
756 *
757 * XXX:Make it reading exactly we need to drain the pipe.
758 */
759 /** @todo use RTPipeCreate + RTPipeRead(,biggerbuffer) here, it's
760 * non-blocking. */
761 RTFileRead(pThis->PipeRead, &ch, 1, &cbRead);
762 }
763 }
764 /* process _all_ outstanding requests but don't wait */
765 RTReqProcess(pThis->pSlirpReqQueue, 0);
766 RTMemFree(polls);
767
768#else /* RT_OS_WINDOWS */
769 nFDs = -1;
770 slirp_select_fill(pThis->pNATState, &nFDs);
771 DWORD dwEvent = WSAWaitForMultipleEvents(nFDs, phEvents, FALSE,
772 slirp_get_timeout_ms(pThis->pNATState),
773 FALSE);
774 if ( (dwEvent < WSA_WAIT_EVENT_0 || dwEvent > WSA_WAIT_EVENT_0 + nFDs - 1)
775 && dwEvent != WSA_WAIT_TIMEOUT)
776 {
777 int error = WSAGetLastError();
778 LogRel(("NAT: WSAWaitForMultipleEvents returned %d (error %d)\n", dwEvent, error));
779 RTAssertPanic();
780 }
781
782 if (dwEvent == WSA_WAIT_TIMEOUT)
783 {
784 /* only check for slow/fast timers */
785 slirp_select_poll(pThis->pNATState, /* fTimeout=*/true, /*fIcmp=*/false);
786 continue;
787 }
788 /* poll the sockets in any case */
789 Log2(("%s: poll\n", __FUNCTION__));
790 slirp_select_poll(pThis->pNATState, /* fTimeout=*/false, /* fIcmp=*/(dwEvent == WSA_WAIT_EVENT_0));
791 /* process _all_ outstanding requests but don't wait */
792 RTReqProcess(pThis->pSlirpReqQueue, 0);
793# ifdef VBOX_NAT_DELAY_HACK
794 if (cBreak++ > 128)
795 {
796 cBreak = 0;
797 RTThreadSleep(2);
798 }
799# endif
800#endif /* RT_OS_WINDOWS */
801 }
802
803 return VINF_SUCCESS;
804}
805
806
807/**
808 * Unblock the send thread so it can respond to a state change.
809 *
810 * @returns VBox status code.
811 * @param pDevIns The pcnet device instance.
812 * @param pThread The send thread.
813 */
814static DECLCALLBACK(int) drvNATAsyncIoWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
815{
816 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
817
818 drvNATNotifyNATThread(pThis, "drvNATAsyncIoWakeup");
819 return VINF_SUCCESS;
820}
821
822#ifdef VBOX_WITH_SLIRP_MT
823
824static DECLCALLBACK(int) drvNATAsyncIoGuest(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
825{
826 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
827
828 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
829 return VINF_SUCCESS;
830
831 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
832 slirp_process_queue(pThis->pNATState);
833
834 return VINF_SUCCESS;
835}
836
837
838static DECLCALLBACK(int) drvNATAsyncIoGuestWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
839{
840 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
841
842 return VINF_SUCCESS;
843}
844
845#endif /* VBOX_WITH_SLIRP_MT */
846
847/**
848 * Function called by slirp to check if it's possible to feed incoming data to the network port.
849 * @returns 1 if possible.
850 * @returns 0 if not possible.
851 */
852int slirp_can_output(void *pvUser)
853{
854 return 1;
855}
856
857void slirp_push_recv_thread(void *pvUser)
858{
859 PDRVNAT pThis = (PDRVNAT)pvUser;
860 Assert(pThis);
861 drvNATUrgRecvWakeup(pThis->pDrvIns, pThis->pUrgRecvThread);
862}
863
864void slirp_urg_output(void *pvUser, struct mbuf *m, const uint8_t *pu8Buf, int cb)
865{
866 PDRVNAT pThis = (PDRVNAT)pvUser;
867 Assert(pThis);
868
869 PRTREQ pReq = NULL;
870
871 /* don't queue new requests when the NAT thread is about to stop */
872 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
873 return;
874
875 ASMAtomicIncU32(&pThis->cUrgPkts);
876 int rc = RTReqCallEx(pThis->pUrgRecvReqQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
877 (PFNRT)drvNATUrgRecvWorker, 4, pThis, pu8Buf, cb, m);
878 AssertRC(rc);
879 drvNATUrgRecvWakeup(pThis->pDrvIns, pThis->pUrgRecvThread);
880}
881
882/**
883 * Function called by slirp to feed incoming data to the NIC.
884 */
885void slirp_output(void *pvUser, struct mbuf *m, const uint8_t *pu8Buf, int cb)
886{
887 PDRVNAT pThis = (PDRVNAT)pvUser;
888 Assert(pThis);
889
890 LogFlow(("slirp_output BEGIN %x %d\n", pu8Buf, cb));
891 Log2(("slirp_output: pu8Buf=%p cb=%#x (pThis=%p)\n%.*Rhxd\n", pu8Buf, cb, pThis, cb, pu8Buf));
892
893 PRTREQ pReq = NULL;
894
895 /* don't queue new requests when the NAT thread is about to stop */
896 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
897 return;
898
899 ASMAtomicIncU32(&pThis->cPkts);
900 int rc = RTReqCallEx(pThis->pRecvReqQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
901 (PFNRT)drvNATRecvWorker, 4, pThis, pu8Buf, cb, m);
902 AssertRC(rc);
903 drvNATRecvWakeup(pThis->pDrvIns, pThis->pRecvThread);
904 STAM_COUNTER_INC(&pThis->StatQueuePktSent);
905}
906
907
908/**
909 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
910 */
911static DECLCALLBACK(void *) drvNATQueryInterface(PPDMIBASE pInterface, const char *pszIID)
912{
913 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
914 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
915
916 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
917 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKUP, &pThis->INetworkUp);
918 return NULL;
919}
920
921
922/**
923 * Get the MAC address into the slirp stack.
924 *
925 * Called by drvNATLoadDone and drvNATPowerOn.
926 */
927static void drvNATSetMac(PDRVNAT pThis)
928{
929 if (pThis->pIAboveConfig)
930 {
931 RTMAC Mac;
932 pThis->pIAboveConfig->pfnGetMac(pThis->pIAboveConfig, &Mac);
933 /* Re-activate the port forwarding. If */
934 slirp_set_ethaddr_and_activate_port_forwarding(pThis->pNATState, Mac.au8, pThis->GuestIP);
935 }
936}
937
938
939/**
940 * After loading we have to pass the MAC address of the ethernet device to the slirp stack.
941 * Otherwise the guest is not reachable until it performs a DHCP request or an ARP request
942 * (usually done during guest boot).
943 */
944static DECLCALLBACK(int) drvNATLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSMHandle)
945{
946 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
947 drvNATSetMac(pThis);
948 return VINF_SUCCESS;
949}
950
951
952/**
953 * Some guests might not use DHCP to retrieve an IP but use a static IP.
954 */
955static DECLCALLBACK(void) drvNATPowerOn(PPDMDRVINS pDrvIns)
956{
957 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
958 drvNATSetMac(pThis);
959}
960
961
962/**
963 * Sets up the redirectors.
964 *
965 * @returns VBox status code.
966 * @param pCfg The configuration handle.
967 */
968static int drvNATConstructRedir(unsigned iInstance, PDRVNAT pThis, PCFGMNODE pCfg, RTIPV4ADDR Network)
969{
970 RTMAC Mac;
971 memset(&Mac, 0, sizeof(RTMAC)); /*can't get MAC here */
972 /*
973 * Enumerate redirections.
974 */
975 for (PCFGMNODE pNode = CFGMR3GetFirstChild(pCfg); pNode; pNode = CFGMR3GetNextChild(pNode))
976 {
977 /*
978 * Validate the port forwarding config.
979 */
980 if (!CFGMR3AreValuesValid(pNode, "Protocol\0UDP\0HostPort\0GuestPort\0GuestIP\0BindIP\0"))
981 return PDMDRV_SET_ERROR(pThis->pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES, N_("Unknown configuration in port forwarding"));
982
983 /* protocol type */
984 bool fUDP;
985 char szProtocol[32];
986 int rc;
987 GET_STRING(rc, pThis, pNode, "Protocol", szProtocol[0], sizeof(szProtocol));
988 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
989 {
990 fUDP = false;
991 GET_BOOL(rc, pThis, pNode, "UDP", fUDP);
992 }
993 else if (RT_SUCCESS(rc))
994 {
995 if (!RTStrICmp(szProtocol, "TCP"))
996 fUDP = false;
997 else if (!RTStrICmp(szProtocol, "UDP"))
998 fUDP = true;
999 else
1000 return PDMDrvHlpVMSetError(pThis->pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1001 N_("NAT#%d: Invalid configuration value for \"Protocol\": \"%s\""),
1002 iInstance, szProtocol);
1003 }
1004 /* host port */
1005 int32_t iHostPort;
1006 GET_S32_STRICT(rc, pThis, pNode, "HostPort", iHostPort);
1007
1008 /* guest port */
1009 int32_t iGuestPort;
1010 GET_S32_STRICT(rc, pThis, pNode, "GuestPort", iGuestPort);
1011
1012 /* guest address */
1013 struct in_addr GuestIP;
1014 /* @todo (vvl) use CTL_* */
1015 GETIP_DEF(rc, pThis, pNode, GuestIP, htonl(Network | CTL_GUEST));
1016
1017 /* Store the guest IP for re-establishing the port-forwarding rules. Note that GuestIP
1018 * is not documented. Without */
1019 if (pThis->GuestIP == INADDR_ANY)
1020 pThis->GuestIP = GuestIP.s_addr;
1021
1022 /*
1023 * Call slirp about it.
1024 */
1025 struct in_addr BindIP;
1026 GETIP_DEF(rc, pThis, pNode, BindIP, INADDR_ANY);
1027 if (slirp_redir(pThis->pNATState, fUDP, BindIP, iHostPort, GuestIP, iGuestPort, Mac.au8) < 0)
1028 return PDMDrvHlpVMSetError(pThis->pDrvIns, VERR_NAT_REDIR_SETUP, RT_SRC_POS,
1029 N_("NAT#%d: configuration error: failed to set up "
1030 "redirection of %d to %d. Probably a conflict with "
1031 "existing services or other rules"), iInstance, iHostPort,
1032 iGuestPort);
1033 } /* for each redir rule */
1034
1035 return VINF_SUCCESS;
1036}
1037
1038
1039/**
1040 * Destruct a driver instance.
1041 *
1042 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
1043 * resources can be freed correctly.
1044 *
1045 * @param pDrvIns The driver instance data.
1046 */
1047static DECLCALLBACK(void) drvNATDestruct(PPDMDRVINS pDrvIns)
1048{
1049 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1050 LogFlow(("drvNATDestruct:\n"));
1051 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1052
1053 if (pThis->pNATState)
1054 {
1055 slirp_term(pThis->pNATState);
1056 slirp_deregister_statistics(pThis->pNATState, pDrvIns);
1057#ifdef VBOX_WITH_STATISTICS
1058# define DRV_PROFILE_COUNTER(name, dsc) DEREGISTER_COUNTER(name, pThis)
1059# define DRV_COUNTING_COUNTER(name, dsc) DEREGISTER_COUNTER(name, pThis)
1060# include "counters.h"
1061#endif
1062 pThis->pNATState = NULL;
1063 }
1064
1065 RTReqDestroyQueue(pThis->pSlirpReqQueue);
1066 pThis->pSlirpReqQueue = NULL;
1067
1068 RTReqDestroyQueue(pThis->pUrgRecvReqQueue);
1069 pThis->pUrgRecvReqQueue = NULL;
1070
1071 RTSemEventDestroy(pThis->EventRecv);
1072 pThis->EventRecv = NIL_RTSEMEVENT;
1073
1074 RTSemEventDestroy(pThis->EventUrgRecv);
1075 pThis->EventUrgRecv = NIL_RTSEMEVENT;
1076
1077 if (RTCritSectIsInitialized(&pThis->DevAccessLock))
1078 RTCritSectDelete(&pThis->DevAccessLock);
1079
1080 if (RTCritSectIsInitialized(&pThis->XmitLock))
1081 RTCritSectDelete(&pThis->XmitLock);
1082}
1083
1084
1085/**
1086 * Construct a NAT network transport driver instance.
1087 *
1088 * @copydoc FNPDMDRVCONSTRUCT
1089 */
1090static DECLCALLBACK(int) drvNATConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1091{
1092 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1093 LogFlow(("drvNATConstruct:\n"));
1094 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1095
1096 /*
1097 * Validate the config.
1098 */
1099 if (!CFGMR3AreValuesValid(pCfg,
1100 "PassDomain\0TFTPPrefix\0BootFile\0Network"
1101 "\0NextServer\0DNSProxy\0BindIP\0UseHostResolver\0"
1102 "SlirpMTU\0"
1103 "SockRcv\0SockSnd\0TcpRcv\0TcpSnd\0"))
1104 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
1105 N_("Unknown NAT configuration option, only supports PassDomain,"
1106 " TFTPPrefix, BootFile and Network"));
1107
1108 /*
1109 * Init the static parts.
1110 */
1111 pThis->pDrvIns = pDrvIns;
1112 pThis->pNATState = NULL;
1113 pThis->pszTFTPPrefix = NULL;
1114 pThis->pszBootFile = NULL;
1115 pThis->pszNextServer = NULL;
1116 pThis->pSlirpReqQueue = NULL;
1117 pThis->pUrgRecvReqQueue = NULL;
1118 pThis->EventRecv = NIL_RTSEMEVENT;
1119 pThis->EventUrgRecv = NIL_RTSEMEVENT;
1120
1121 /* IBase */
1122 pDrvIns->IBase.pfnQueryInterface = drvNATQueryInterface;
1123
1124 /* INetwork */
1125 pThis->INetworkUp.pfnBeginXmit = drvNATNetworkUp_BeginXmit;
1126 pThis->INetworkUp.pfnAllocBuf = drvNATNetworkUp_AllocBuf;
1127 pThis->INetworkUp.pfnFreeBuf = drvNATNetworkUp_FreeBuf;
1128 pThis->INetworkUp.pfnSendBuf = drvNATNetworkUp_SendBuf;
1129 pThis->INetworkUp.pfnEndXmit = drvNATNetworkUp_EndXmit;
1130 pThis->INetworkUp.pfnSetPromiscuousMode = drvNATNetworkUp_SetPromiscuousMode;
1131 pThis->INetworkUp.pfnNotifyLinkChanged = drvNATNetworkUp_NotifyLinkChanged;
1132
1133 /*
1134 * Get the configuration settings.
1135 */
1136 int rc;
1137 bool fPassDomain = true;
1138 GET_BOOL(rc, pThis, pCfg, "PassDomain", fPassDomain);
1139
1140 GET_STRING_ALLOC(rc, pThis, pCfg, "TFTPPrefix", pThis->pszTFTPPrefix);
1141 GET_STRING_ALLOC(rc, pThis, pCfg, "BootFile", pThis->pszBootFile);
1142 GET_STRING_ALLOC(rc, pThis, pCfg, "NextServer", pThis->pszNextServer);
1143
1144 int fDNSProxy = 0;
1145 GET_S32(rc, pThis, pCfg, "DNSProxy", fDNSProxy);
1146 int fUseHostResolver = 0;
1147 GET_S32(rc, pThis, pCfg, "UseHostResolver", fUseHostResolver);
1148#ifdef VBOX_WITH_SLIRP_BSD_MBUF
1149 int MTU = 1500;
1150 GET_S32(rc, pThis, pCfg, "SlirpMTU", MTU);
1151#endif
1152
1153 /*
1154 * Query the network port interface.
1155 */
1156 pThis->pIAboveNet = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKDOWN);
1157 if (!pThis->pIAboveNet)
1158 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
1159 N_("Configuration error: the above device/driver didn't "
1160 "export the network port interface"));
1161 pThis->pIAboveConfig = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKCONFIG);
1162 if (!pThis->pIAboveConfig)
1163 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
1164 N_("Configuration error: the above device/driver didn't "
1165 "export the network config interface"));
1166
1167 /* Generate a network address for this network card. */
1168 char szNetwork[32]; /* xxx.xxx.xxx.xxx/yy */
1169 GET_STRING(rc, pThis, pCfg, "Network", szNetwork[0], sizeof(szNetwork));
1170 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1171 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("NAT%d: Configuration error: "
1172 "missing network"),
1173 pDrvIns->iInstance, szNetwork);
1174
1175 RTIPV4ADDR Network;
1176 RTIPV4ADDR Netmask;
1177 rc = RTCidrStrToIPv4(szNetwork, &Network, &Netmask);
1178 if (RT_FAILURE(rc))
1179 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: Configuration error: "
1180 "network '%s' describes not a valid IPv4 network"),
1181 pDrvIns->iInstance, szNetwork);
1182
1183 char szNetAddr[16];
1184 RTStrPrintf(szNetAddr, sizeof(szNetAddr), "%d.%d.%d.%d",
1185 (Network & 0xFF000000) >> 24, (Network & 0xFF0000) >> 16,
1186 (Network & 0xFF00) >> 8, Network & 0xFF);
1187
1188 /*
1189 * Initialize slirp.
1190 */
1191 rc = slirp_init(&pThis->pNATState, &szNetAddr[0], Netmask, fPassDomain, !!fUseHostResolver, pThis);
1192 if (RT_SUCCESS(rc))
1193 {
1194 slirp_set_dhcp_TFTP_prefix(pThis->pNATState, pThis->pszTFTPPrefix);
1195 slirp_set_dhcp_TFTP_bootfile(pThis->pNATState, pThis->pszBootFile);
1196 slirp_set_dhcp_next_server(pThis->pNATState, pThis->pszNextServer);
1197 slirp_set_dhcp_dns_proxy(pThis->pNATState, !!fDNSProxy);
1198#ifdef VBOX_WITH_SLIRP_BSD_MBUF
1199 slirp_set_mtu(pThis->pNATState, MTU);
1200#endif
1201 char *pszBindIP = NULL;
1202 GET_STRING_ALLOC(rc, pThis, pCfg, "BindIP", pszBindIP);
1203 rc = slirp_set_binding_address(pThis->pNATState, pszBindIP);
1204 if (rc != 0)
1205 LogRel(("NAT: value of BindIP has been ignored\n"));
1206
1207 if(pszBindIP != NULL)
1208 MMR3HeapFree(pszBindIP);
1209#define SLIRP_SET_TUNING_VALUE(name, setter) \
1210 do \
1211 { \
1212 int len = 0; \
1213 rc = CFGMR3QueryS32(pCfg, name, &len); \
1214 if (RT_SUCCESS(rc)) \
1215 setter(pThis->pNATState, len); \
1216 } while(0)
1217
1218 SLIRP_SET_TUNING_VALUE("SockRcv", slirp_set_rcvbuf);
1219 SLIRP_SET_TUNING_VALUE("SockSnd", slirp_set_sndbuf);
1220 SLIRP_SET_TUNING_VALUE("TcpRcv", slirp_set_tcp_rcvspace);
1221 SLIRP_SET_TUNING_VALUE("TcpSnd", slirp_set_tcp_sndspace);
1222
1223 slirp_register_statistics(pThis->pNATState, pDrvIns);
1224#ifdef VBOX_WITH_STATISTICS
1225# define DRV_PROFILE_COUNTER(name, dsc) REGISTER_COUNTER(name, pThis, STAMTYPE_PROFILE, STAMUNIT_TICKS_PER_CALL, dsc)
1226# define DRV_COUNTING_COUNTER(name, dsc) REGISTER_COUNTER(name, pThis, STAMTYPE_COUNTER, STAMUNIT_COUNT, dsc)
1227# include "counters.h"
1228#endif
1229
1230 rc = drvNATConstructRedir(pDrvIns->iInstance, pThis, pCfg, Network);
1231 if (RT_SUCCESS(rc))
1232 {
1233 /*
1234 * Register a load done notification to get the MAC address into the slirp
1235 * engine after we loaded a guest state.
1236 */
1237 rc = PDMDrvHlpSSMRegisterLoadDone(pDrvIns, drvNATLoadDone);
1238 AssertRCReturn(rc, rc);
1239
1240 rc = RTReqCreateQueue(&pThis->pSlirpReqQueue);
1241 if (RT_FAILURE(rc))
1242 {
1243 LogRel(("NAT: Can't create request queue\n"));
1244 return rc;
1245 }
1246
1247
1248 rc = RTReqCreateQueue(&pThis->pRecvReqQueue);
1249 if (RT_FAILURE(rc))
1250 {
1251 LogRel(("NAT: Can't create request queue\n"));
1252 return rc;
1253 }
1254
1255 rc = RTReqCreateQueue(&pThis->pUrgRecvReqQueue);
1256 if (RT_FAILURE(rc))
1257 {
1258 LogRel(("NAT: Can't create request queue\n"));
1259 return rc;
1260 }
1261
1262 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pRecvThread, pThis, drvNATRecv,
1263 drvNATRecvWakeup, 128 * _1K, RTTHREADTYPE_IO, "NATRX");
1264 AssertRCReturn(rc, rc);
1265
1266 rc = RTSemEventCreate(&pThis->EventRecv);
1267 AssertRCReturn(rc, rc);
1268
1269 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pUrgRecvThread, pThis, drvNATUrgRecv,
1270 drvNATUrgRecvWakeup, 128 * _1K, RTTHREADTYPE_IO, "NATURGRX");
1271 AssertRCReturn(rc, rc);
1272
1273 rc = RTSemEventCreate(&pThis->EventRecv);
1274 AssertRCReturn(rc, rc);
1275
1276 rc = RTSemEventCreate(&pThis->EventUrgRecv);
1277 AssertRCReturn(rc, rc);
1278
1279 rc = RTCritSectInit(&pThis->DevAccessLock);
1280 AssertRCReturn(rc, rc);
1281
1282 rc = RTCritSectInit(&pThis->XmitLock);
1283 AssertRCReturn(rc, rc);
1284
1285#ifndef RT_OS_WINDOWS
1286 /*
1287 * Create the control pipe.
1288 */
1289 int fds[2];
1290 if (pipe(&fds[0]) != 0) /** @todo RTPipeCreate() or something... */
1291 {
1292 rc = RTErrConvertFromErrno(errno);
1293 AssertRC(rc);
1294 return rc;
1295 }
1296 pThis->PipeRead = fds[0];
1297 pThis->PipeWrite = fds[1];
1298#else
1299 pThis->hWakeupEvent = CreateEvent(NULL, FALSE, FALSE, NULL); /* auto-reset event */
1300 slirp_register_external_event(pThis->pNATState, pThis->hWakeupEvent,
1301 VBOX_WAKEUP_EVENT_INDEX);
1302#endif
1303
1304 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pSlirpThread, pThis, drvNATAsyncIoThread,
1305 drvNATAsyncIoWakeup, 128 * _1K, RTTHREADTYPE_IO, "NAT");
1306 AssertRC(rc);
1307
1308#ifdef VBOX_WITH_SLIRP_MT
1309 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pGuestThread, pThis, drvNATAsyncIoGuest,
1310 drvNATAsyncIoGuestWakeup, 128 * _1K, RTTHREADTYPE_IO, "NATGUEST");
1311 AssertRC(rc);
1312#endif
1313
1314 pThis->enmLinkState = PDMNETWORKLINKSTATE_UP;
1315
1316 /* might return VINF_NAT_DNS */
1317 return rc;
1318 }
1319
1320 /* failure path */
1321 slirp_term(pThis->pNATState);
1322 pThis->pNATState = NULL;
1323 }
1324 else
1325 {
1326 PDMDRV_SET_ERROR(pDrvIns, rc, N_("Unknown error during NAT networking setup: "));
1327 AssertMsgFailed(("Add error message for rc=%d (%Rrc)\n", rc, rc));
1328 }
1329
1330 return rc;
1331}
1332
1333
1334/**
1335 * NAT network transport driver registration record.
1336 */
1337const PDMDRVREG g_DrvNAT =
1338{
1339 /* u32Version */
1340 PDM_DRVREG_VERSION,
1341 /* szName */
1342 "NAT",
1343 /* szRCMod */
1344 "",
1345 /* szR0Mod */
1346 "",
1347 /* pszDescription */
1348 "NAT Network Transport Driver",
1349 /* fFlags */
1350 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1351 /* fClass. */
1352 PDM_DRVREG_CLASS_NETWORK,
1353 /* cMaxInstances */
1354 16,
1355 /* cbInstance */
1356 sizeof(DRVNAT),
1357 /* pfnConstruct */
1358 drvNATConstruct,
1359 /* pfnDestruct */
1360 drvNATDestruct,
1361 /* pfnRelocate */
1362 NULL,
1363 /* pfnIOCtl */
1364 NULL,
1365 /* pfnPowerOn */
1366 drvNATPowerOn,
1367 /* pfnReset */
1368 NULL,
1369 /* pfnSuspend */
1370 NULL,
1371 /* pfnResume */
1372 NULL,
1373 /* pfnAttach */
1374 NULL,
1375 /* pfnDetach */
1376 NULL,
1377 /* pfnPowerOff */
1378 NULL,
1379 /* pfnSoftReset */
1380 NULL,
1381 /* u32EndVersion */
1382 PDM_DRVREG_VERSION
1383};
1384
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette