VirtualBox

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

Last change on this file since 54107 was 54107, checked in by vboxsync, 10 years ago

NAT: Try to fix alignment of counters on 32-bit broken in r98104.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 61.0 KB
Line 
1/* $Id: DrvNAT.cpp 54107 2015-02-08 01:29:52Z vboxsync $ */
2/** @file
3 * DrvNAT - NAT network transport driver.
4 */
5
6/*
7 * Copyright (C) 2006-2012 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_NAT
23#define __STDC_LIMIT_MACROS
24#define __STDC_CONSTANT_MACROS
25#include "slirp/libslirp.h"
26extern "C" {
27#include "slirp/slirp_dns.h"
28}
29#include "slirp/ctl.h"
30
31#include <VBox/vmm/dbgf.h>
32#include <VBox/vmm/pdmdrv.h>
33#include <VBox/vmm/pdmnetifs.h>
34#include <VBox/vmm/pdmnetinline.h>
35
36#include <iprt/assert.h>
37#include <iprt/critsect.h>
38#include <iprt/cidr.h>
39#include <iprt/file.h>
40#include <iprt/mem.h>
41#include <iprt/pipe.h>
42#include <iprt/string.h>
43#include <iprt/stream.h>
44#include <iprt/uuid.h>
45
46#include "VBoxDD.h"
47
48#ifndef RT_OS_WINDOWS
49# include <unistd.h>
50# include <fcntl.h>
51# include <poll.h>
52# include <errno.h>
53#endif
54#ifdef RT_OS_FREEBSD
55# include <netinet/in.h>
56#endif
57#include <iprt/semaphore.h>
58#include <iprt/req.h>
59#ifdef RT_OS_DARWIN
60# include <SystemConfiguration/SystemConfiguration.h>
61# include <CoreFoundation/CoreFoundation.h>
62#endif
63
64#define COUNTERS_INIT
65#include "counters.h"
66
67
68/*******************************************************************************
69* Defined Constants And Macros *
70*******************************************************************************/
71
72#define DRVNAT_MAXFRAMESIZE (16 * 1024)
73
74/**
75 * @todo: This is a bad hack to prevent freezing the guest during high network
76 * activity. Windows host only. This needs to be fixed properly.
77 */
78#define VBOX_NAT_DELAY_HACK
79
80#define GET_EXTRADATA(pthis, node, name, rc, type, type_name, var) \
81do { \
82 (rc) = CFGMR3Query ## type((node), name, &(var)); \
83 if (RT_FAILURE((rc)) && (rc) != VERR_CFGM_VALUE_NOT_FOUND) \
84 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \"" name "\" " #type_name " failed"), \
85 (pthis)->pDrvIns->iInstance); \
86} while (0)
87
88#define GET_ED_STRICT(pthis, node, name, rc, type, type_name, var) \
89do { \
90 (rc) = CFGMR3Query ## type((node), name, &(var)); \
91 if (RT_FAILURE((rc))) \
92 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \"" name "\" " #type_name " failed"), \
93 (pthis)->pDrvIns->iInstance); \
94} while (0)
95
96#define GET_EXTRADATA_N(pthis, node, name, rc, type, type_name, var, var_size) \
97do { \
98 (rc) = CFGMR3Query ## type((node), name, &(var), var_size); \
99 if (RT_FAILURE((rc)) && (rc) != VERR_CFGM_VALUE_NOT_FOUND) \
100 return PDMDrvHlpVMSetError((pthis)->pDrvIns, (rc), RT_SRC_POS, N_("NAT#%d: configuration query for \"" name "\" " #type_name " failed"), \
101 (pthis)->pDrvIns->iInstance); \
102} while (0)
103
104#define GET_BOOL(rc, pthis, node, name, var) \
105 GET_EXTRADATA(pthis, node, name, (rc), Bool, bolean, (var))
106#define GET_STRING(rc, pthis, node, name, var, var_size) \
107 GET_EXTRADATA_N(pthis, node, name, (rc), String, string, (var), (var_size))
108#define GET_STRING_ALLOC(rc, pthis, node, name, var) \
109 GET_EXTRADATA(pthis, node, name, (rc), StringAlloc, string, (var))
110#define GET_S32(rc, pthis, node, name, var) \
111 GET_EXTRADATA(pthis, node, name, (rc), S32, int, (var))
112#define GET_S32_STRICT(rc, pthis, node, name, var) \
113 GET_ED_STRICT(pthis, node, name, (rc), S32, int, (var))
114
115
116
117#define DO_GET_IP(rc, node, instance, status, x) \
118do { \
119 char sz##x[32]; \
120 GET_STRING((rc), (node), (instance), #x, sz ## x[0], sizeof(sz ## x)); \
121 if (rc != VERR_CFGM_VALUE_NOT_FOUND) \
122 (status) = inet_aton(sz ## x, &x); \
123} while (0)
124
125#define GETIP_DEF(rc, node, instance, x, def) \
126do \
127{ \
128 int status = 0; \
129 DO_GET_IP((rc), (node), (instance), status, x); \
130 if (status == 0 || rc == VERR_CFGM_VALUE_NOT_FOUND) \
131 x.s_addr = def; \
132} while (0)
133
134/*******************************************************************************
135* Structures and Typedefs *
136*******************************************************************************/
137/**
138 * NAT network transport driver instance data.
139 *
140 * @implements PDMINETWORKUP
141 */
142typedef struct DRVNAT
143{
144 /** The network interface. */
145 PDMINETWORKUP INetworkUp;
146 /** The network NAT Engine configureation. */
147 PDMINETWORKNATCONFIG INetworkNATCfg;
148 /** The port we're attached to. */
149 PPDMINETWORKDOWN pIAboveNet;
150 /** The network config of the port we're attached to. */
151 PPDMINETWORKCONFIG pIAboveConfig;
152 /** Pointer to the driver instance. */
153 PPDMDRVINS pDrvIns;
154 /** Link state */
155 PDMNETWORKLINKSTATE enmLinkState;
156 /** NAT state for this instance. */
157 PNATState pNATState;
158 /** TFTP directory prefix. */
159 char *pszTFTPPrefix;
160 /** Boot file name to provide in the DHCP server response. */
161 char *pszBootFile;
162 /** tftp server name to provide in the DHCP server response. */
163 char *pszNextServer;
164 /** Polling thread. */
165 PPDMTHREAD pSlirpThread;
166 /** Queue for NAT-thread-external events. */
167 RTREQQUEUE hSlirpReqQueue;
168 /** The guest IP for port-forwarding. */
169 uint32_t GuestIP;
170 /** Link state set when the VM is suspended. */
171 PDMNETWORKLINKSTATE enmLinkStateWant;
172
173#ifndef RT_OS_WINDOWS
174 /** The write end of the control pipe. */
175 RTPIPE hPipeWrite;
176 /** The read end of the control pipe. */
177 RTPIPE hPipeRead;
178# if HC_ARCH_BITS == 32
179 uint32_t u32Padding;
180# endif
181#else
182 /** for external notification */
183 HANDLE hWakeupEvent;
184#endif
185
186#define DRV_PROFILE_COUNTER(name, dsc) STAMPROFILE Stat ## name
187#define DRV_COUNTING_COUNTER(name, dsc) STAMCOUNTER Stat ## name
188#include "counters.h"
189 /** thread delivering packets for receiving by the guest */
190 PPDMTHREAD pRecvThread;
191 /** thread delivering urg packets for receiving by the guest */
192 PPDMTHREAD pUrgRecvThread;
193 /** event to wakeup the guest receive thread */
194 RTSEMEVENT EventRecv;
195 /** event to wakeup the guest urgent receive thread */
196 RTSEMEVENT EventUrgRecv;
197 /** Receive Req queue (deliver packets to the guest) */
198 RTREQQUEUE hRecvReqQueue;
199 /** Receive Urgent Req queue (deliver packets to the guest). */
200 RTREQQUEUE hUrgRecvReqQueue;
201
202 /** makes access to device func RecvAvail and Recv atomical. */
203 RTCRITSECT DevAccessLock;
204 /** Number of in-flight urgent packets. */
205 volatile uint32_t cUrgPkts;
206 /** Number of in-flight regular packets. */
207 volatile uint32_t cPkts;
208
209 /** Transmit lock taken by BeginXmit and released by EndXmit. */
210 RTCRITSECT XmitLock;
211
212#ifdef RT_OS_DARWIN
213 /* Handle of the DNS watcher runloop source. */
214 CFRunLoopSourceRef hRunLoopSrcDnsWatcher;
215#endif
216} DRVNAT;
217AssertCompileMemberAlignment(DRVNAT, StatNATRecvWakeups, 8);
218/** Pointer to the NAT driver instance data. */
219typedef DRVNAT *PDRVNAT;
220
221
222/*******************************************************************************
223* Internal Functions *
224*******************************************************************************/
225static void drvNATNotifyNATThread(PDRVNAT pThis, const char *pszWho);
226DECLINLINE(void) drvNATUpdateDNS(PDRVNAT pThis, bool fFlapLink);
227static DECLCALLBACK(int) drvNATReinitializeHostNameResolving(PDRVNAT pThis);
228
229
230static DECLCALLBACK(int) drvNATRecv(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
231{
232 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
233
234 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
235 return VINF_SUCCESS;
236
237 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
238 {
239 RTReqQueueProcess(pThis->hRecvReqQueue, 0);
240 if (ASMAtomicReadU32(&pThis->cPkts) == 0)
241 RTSemEventWait(pThis->EventRecv, RT_INDEFINITE_WAIT);
242 }
243 return VINF_SUCCESS;
244}
245
246
247static DECLCALLBACK(int) drvNATRecvWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
248{
249 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
250 int rc;
251 rc = RTSemEventSignal(pThis->EventRecv);
252
253 STAM_COUNTER_INC(&pThis->StatNATRecvWakeups);
254 return VINF_SUCCESS;
255}
256
257static DECLCALLBACK(int) drvNATUrgRecv(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
258{
259 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
260
261 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
262 return VINF_SUCCESS;
263
264 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
265 {
266 RTReqQueueProcess(pThis->hUrgRecvReqQueue, 0);
267 if (ASMAtomicReadU32(&pThis->cUrgPkts) == 0)
268 {
269 int rc = RTSemEventWait(pThis->EventUrgRecv, RT_INDEFINITE_WAIT);
270 AssertRC(rc);
271 }
272 }
273 return VINF_SUCCESS;
274}
275
276static DECLCALLBACK(int) drvNATUrgRecvWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
277{
278 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
279 int rc = RTSemEventSignal(pThis->EventUrgRecv);
280 AssertRC(rc);
281
282 return VINF_SUCCESS;
283}
284
285static DECLCALLBACK(void) drvNATUrgRecvWorker(PDRVNAT pThis, uint8_t *pu8Buf, int cb, struct mbuf *m)
286{
287 int rc = RTCritSectEnter(&pThis->DevAccessLock);
288 AssertRC(rc);
289 rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
290 if (RT_SUCCESS(rc))
291 {
292 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pu8Buf, cb);
293 AssertRC(rc);
294 }
295 else if ( rc != VERR_TIMEOUT
296 && rc != VERR_INTERRUPTED)
297 {
298 AssertRC(rc);
299 }
300
301 rc = RTCritSectLeave(&pThis->DevAccessLock);
302 AssertRC(rc);
303
304 slirp_ext_m_free(pThis->pNATState, m, pu8Buf);
305 if (ASMAtomicDecU32(&pThis->cUrgPkts) == 0)
306 {
307 drvNATRecvWakeup(pThis->pDrvIns, pThis->pRecvThread);
308 drvNATNotifyNATThread(pThis, "drvNATUrgRecvWorker");
309 }
310}
311
312
313static DECLCALLBACK(void) drvNATRecvWorker(PDRVNAT pThis, uint8_t *pu8Buf, int cb, struct mbuf *m)
314{
315 int rc;
316 STAM_PROFILE_START(&pThis->StatNATRecv, a);
317
318
319 while (ASMAtomicReadU32(&pThis->cUrgPkts) != 0)
320 {
321 rc = RTSemEventWait(pThis->EventRecv, RT_INDEFINITE_WAIT);
322 if ( RT_FAILURE(rc)
323 && ( rc == VERR_TIMEOUT
324 || rc == VERR_INTERRUPTED))
325 goto done_unlocked;
326 }
327
328 rc = RTCritSectEnter(&pThis->DevAccessLock);
329 AssertRC(rc);
330
331 STAM_PROFILE_START(&pThis->StatNATRecvWait, b);
332 rc = pThis->pIAboveNet->pfnWaitReceiveAvail(pThis->pIAboveNet, RT_INDEFINITE_WAIT);
333 STAM_PROFILE_STOP(&pThis->StatNATRecvWait, b);
334
335 if (RT_SUCCESS(rc))
336 {
337 rc = pThis->pIAboveNet->pfnReceive(pThis->pIAboveNet, pu8Buf, cb);
338 AssertRC(rc);
339 }
340 else if ( rc != VERR_TIMEOUT
341 && rc != VERR_INTERRUPTED)
342 {
343 AssertRC(rc);
344 }
345
346 rc = RTCritSectLeave(&pThis->DevAccessLock);
347 AssertRC(rc);
348
349done_unlocked:
350 slirp_ext_m_free(pThis->pNATState, m, pu8Buf);
351 ASMAtomicDecU32(&pThis->cPkts);
352
353 drvNATNotifyNATThread(pThis, "drvNATRecvWorker");
354
355 STAM_PROFILE_STOP(&pThis->StatNATRecv, a);
356}
357
358/**
359 * Frees a S/G buffer allocated by drvNATNetworkUp_AllocBuf.
360 *
361 * @param pThis Pointer to the NAT instance.
362 * @param pSgBuf The S/G buffer to free.
363 */
364static void drvNATFreeSgBuf(PDRVNAT pThis, PPDMSCATTERGATHER pSgBuf)
365{
366 Assert((pSgBuf->fFlags & PDMSCATTERGATHER_FLAGS_MAGIC_MASK) == PDMSCATTERGATHER_FLAGS_MAGIC);
367 pSgBuf->fFlags = 0;
368 if (pSgBuf->pvAllocator)
369 {
370 Assert(!pSgBuf->pvUser);
371 slirp_ext_m_free(pThis->pNATState, (struct mbuf *)pSgBuf->pvAllocator, NULL);
372 pSgBuf->pvAllocator = NULL;
373 }
374 else if (pSgBuf->pvUser)
375 {
376 RTMemFree(pSgBuf->aSegs[0].pvSeg);
377 pSgBuf->aSegs[0].pvSeg = NULL;
378 RTMemFree(pSgBuf->pvUser);
379 pSgBuf->pvUser = NULL;
380 }
381 RTMemFree(pSgBuf);
382}
383
384/**
385 * Worker function for drvNATSend().
386 *
387 * @param pThis Pointer to the NAT instance.
388 * @param pSgBuf The scatter/gather buffer.
389 * @thread NAT
390 */
391static void drvNATSendWorker(PDRVNAT pThis, PPDMSCATTERGATHER pSgBuf)
392{
393 Assert(pThis->enmLinkState == PDMNETWORKLINKSTATE_UP);
394 if (pThis->enmLinkState == PDMNETWORKLINKSTATE_UP)
395 {
396 struct mbuf *m = (struct mbuf *)pSgBuf->pvAllocator;
397 if (m)
398 {
399 /*
400 * A normal frame.
401 */
402 pSgBuf->pvAllocator = NULL;
403 slirp_input(pThis->pNATState, m, pSgBuf->cbUsed);
404 }
405 else
406 {
407 /*
408 * GSO frame, need to segment it.
409 */
410 /** @todo Make the NAT engine grok large frames? Could be more efficient... */
411#if 0 /* this is for testing PDMNetGsoCarveSegmentQD. */
412 uint8_t abHdrScratch[256];
413#endif
414 uint8_t const *pbFrame = (uint8_t const *)pSgBuf->aSegs[0].pvSeg;
415 PCPDMNETWORKGSO pGso = (PCPDMNETWORKGSO)pSgBuf->pvUser;
416 uint32_t const cSegs = PDMNetGsoCalcSegmentCount(pGso, pSgBuf->cbUsed); Assert(cSegs > 1);
417 for (size_t iSeg = 0; iSeg < cSegs; iSeg++)
418 {
419 size_t cbSeg;
420 void *pvSeg;
421 m = slirp_ext_m_get(pThis->pNATState, pGso->cbHdrsTotal + pGso->cbMaxSeg, &pvSeg, &cbSeg);
422 if (!m)
423 break;
424
425#if 1
426 uint32_t cbPayload, cbHdrs;
427 uint32_t offPayload = PDMNetGsoCarveSegment(pGso, pbFrame, pSgBuf->cbUsed,
428 iSeg, cSegs, (uint8_t *)pvSeg, &cbHdrs, &cbPayload);
429 memcpy((uint8_t *)pvSeg + cbHdrs, pbFrame + offPayload, cbPayload);
430
431 slirp_input(pThis->pNATState, m, cbPayload + cbHdrs);
432#else
433 uint32_t cbSegFrame;
434 void *pvSegFrame = PDMNetGsoCarveSegmentQD(pGso, (uint8_t *)pbFrame, pSgBuf->cbUsed, abHdrScratch,
435 iSeg, cSegs, &cbSegFrame);
436 memcpy((uint8_t *)pvSeg, pvSegFrame, cbSegFrame);
437
438 slirp_input(pThis->pNATState, m, cbSegFrame);
439#endif
440 }
441 }
442 }
443 drvNATFreeSgBuf(pThis, pSgBuf);
444
445 /** @todo Implement the VERR_TRY_AGAIN drvNATNetworkUp_AllocBuf semantics. */
446}
447
448/**
449 * @interface_method_impl{PDMINETWORKUP,pfnBeginXmit}
450 */
451static DECLCALLBACK(int) drvNATNetworkUp_BeginXmit(PPDMINETWORKUP pInterface, bool fOnWorkerThread)
452{
453 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
454 int rc = RTCritSectTryEnter(&pThis->XmitLock);
455 if (RT_FAILURE(rc))
456 {
457 /** @todo Kick the worker thread when we have one... */
458 rc = VERR_TRY_AGAIN;
459 }
460 return rc;
461}
462
463/**
464 * @interface_method_impl{PDMINETWORKUP,pfnAllocBuf}
465 */
466static DECLCALLBACK(int) drvNATNetworkUp_AllocBuf(PPDMINETWORKUP pInterface, size_t cbMin,
467 PCPDMNETWORKGSO pGso, PPPDMSCATTERGATHER ppSgBuf)
468{
469 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
470 Assert(RTCritSectIsOwner(&pThis->XmitLock));
471
472 /*
473 * Drop the incoming frame if the NAT thread isn't running.
474 */
475 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
476 {
477 Log(("drvNATNetowrkUp_AllocBuf: returns VERR_NET_NO_NETWORK\n"));
478 return VERR_NET_NO_NETWORK;
479 }
480
481 /*
482 * Allocate a scatter/gather buffer and an mbuf.
483 */
484 PPDMSCATTERGATHER pSgBuf = (PPDMSCATTERGATHER)RTMemAlloc(sizeof(*pSgBuf));
485 if (!pSgBuf)
486 return VERR_NO_MEMORY;
487 if (!pGso)
488 {
489 /*
490 * Drop the frame if it is too big.
491 */
492 if (cbMin >= DRVNAT_MAXFRAMESIZE)
493 {
494 Log(("drvNATNetowrkUp_AllocBuf: drops over-sized frame (%u bytes), returns VERR_INVALID_PARAMETER\n",
495 cbMin));
496 return VERR_INVALID_PARAMETER;
497 }
498
499 pSgBuf->pvUser = NULL;
500 pSgBuf->pvAllocator = slirp_ext_m_get(pThis->pNATState, cbMin,
501 &pSgBuf->aSegs[0].pvSeg, &pSgBuf->aSegs[0].cbSeg);
502 if (!pSgBuf->pvAllocator)
503 {
504 RTMemFree(pSgBuf);
505 return VERR_TRY_AGAIN;
506 }
507 }
508 else
509 {
510 /*
511 * Drop the frame if its segment is too big.
512 */
513 if (pGso->cbHdrsTotal + pGso->cbMaxSeg >= DRVNAT_MAXFRAMESIZE)
514 {
515 Log(("drvNATNetowrkUp_AllocBuf: drops over-sized frame (%u bytes), returns VERR_INVALID_PARAMETER\n",
516 pGso->cbHdrsTotal + pGso->cbMaxSeg));
517 return VERR_INVALID_PARAMETER;
518 }
519
520 pSgBuf->pvUser = RTMemDup(pGso, sizeof(*pGso));
521 pSgBuf->pvAllocator = NULL;
522 pSgBuf->aSegs[0].cbSeg = RT_ALIGN_Z(cbMin, 16);
523 pSgBuf->aSegs[0].pvSeg = RTMemAlloc(pSgBuf->aSegs[0].cbSeg);
524 if (!pSgBuf->pvUser || !pSgBuf->aSegs[0].pvSeg)
525 {
526 RTMemFree(pSgBuf->aSegs[0].pvSeg);
527 RTMemFree(pSgBuf->pvUser);
528 RTMemFree(pSgBuf);
529 return VERR_TRY_AGAIN;
530 }
531 }
532
533 /*
534 * Initialize the S/G buffer and return.
535 */
536 pSgBuf->fFlags = PDMSCATTERGATHER_FLAGS_MAGIC | PDMSCATTERGATHER_FLAGS_OWNER_1;
537 pSgBuf->cbUsed = 0;
538 pSgBuf->cbAvailable = pSgBuf->aSegs[0].cbSeg;
539 pSgBuf->cSegs = 1;
540
541#if 0 /* poison */
542 memset(pSgBuf->aSegs[0].pvSeg, 'F', pSgBuf->aSegs[0].cbSeg);
543#endif
544 *ppSgBuf = pSgBuf;
545 return VINF_SUCCESS;
546}
547
548/**
549 * @interface_method_impl{PDMINETWORKUP,pfnFreeBuf}
550 */
551static DECLCALLBACK(int) drvNATNetworkUp_FreeBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf)
552{
553 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
554 Assert(RTCritSectIsOwner(&pThis->XmitLock));
555 drvNATFreeSgBuf(pThis, pSgBuf);
556 return VINF_SUCCESS;
557}
558
559/**
560 * @interface_method_impl{PDMINETWORKUP,pfnSendBuf}
561 */
562static DECLCALLBACK(int) drvNATNetworkUp_SendBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread)
563{
564 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
565 Assert((pSgBuf->fFlags & PDMSCATTERGATHER_FLAGS_OWNER_MASK) == PDMSCATTERGATHER_FLAGS_OWNER_1);
566 Assert(RTCritSectIsOwner(&pThis->XmitLock));
567
568 int rc;
569 if (pThis->pSlirpThread->enmState == PDMTHREADSTATE_RUNNING)
570 {
571 /* Set an FTM checkpoint as this operation changes the state permanently. */
572 PDMDrvHlpFTSetCheckpoint(pThis->pDrvIns, FTMCHECKPOINTTYPE_NETWORK);
573
574
575 RTREQQUEUE hQueue = pThis->hSlirpReqQueue;
576
577 rc = RTReqQueueCallEx(hQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
578 (PFNRT)drvNATSendWorker, 2, pThis, pSgBuf);
579 if (RT_SUCCESS(rc))
580 {
581 drvNATNotifyNATThread(pThis, "drvNATNetworkUp_SendBuf");
582 return VINF_SUCCESS;
583 }
584
585 rc = VERR_NET_NO_BUFFER_SPACE;
586 }
587 else
588 rc = VERR_NET_DOWN;
589 drvNATFreeSgBuf(pThis, pSgBuf);
590 return rc;
591}
592
593/**
594 * @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
595 */
596static DECLCALLBACK(void) drvNATNetworkUp_EndXmit(PPDMINETWORKUP pInterface)
597{
598 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
599 RTCritSectLeave(&pThis->XmitLock);
600}
601
602/**
603 * Get the NAT thread out of poll/WSAWaitForMultipleEvents
604 */
605static void drvNATNotifyNATThread(PDRVNAT pThis, const char *pszWho)
606{
607 int rc;
608#ifndef RT_OS_WINDOWS
609 /* kick poll() */
610 size_t cbIgnored;
611 rc = RTPipeWrite(pThis->hPipeWrite, "", 1, &cbIgnored);
612#else
613 /* kick WSAWaitForMultipleEvents */
614 rc = WSASetEvent(pThis->hWakeupEvent);
615#endif
616 AssertRC(rc);
617}
618
619/**
620 * @interface_method_impl{PDMINETWORKUP,pfnSetPromiscuousMode}
621 */
622static DECLCALLBACK(void) drvNATNetworkUp_SetPromiscuousMode(PPDMINETWORKUP pInterface, bool fPromiscuous)
623{
624 LogFlow(("drvNATNetworkUp_SetPromiscuousMode: fPromiscuous=%d\n", fPromiscuous));
625 /* nothing to do */
626}
627
628/**
629 * Worker function for drvNATNetworkUp_NotifyLinkChanged().
630 * @thread "NAT" thread.
631 */
632static void drvNATNotifyLinkChangedWorker(PDRVNAT pThis, PDMNETWORKLINKSTATE enmLinkState)
633{
634 pThis->enmLinkState = pThis->enmLinkStateWant = enmLinkState;
635 switch (enmLinkState)
636 {
637 case PDMNETWORKLINKSTATE_UP:
638 LogRel(("NAT: link up\n"));
639 slirp_link_up(pThis->pNATState);
640 break;
641
642 case PDMNETWORKLINKSTATE_DOWN:
643 case PDMNETWORKLINKSTATE_DOWN_RESUME:
644 LogRel(("NAT: link down\n"));
645 slirp_link_down(pThis->pNATState);
646 break;
647
648 default:
649 AssertMsgFailed(("drvNATNetworkUp_NotifyLinkChanged: unexpected link state %d\n", enmLinkState));
650 }
651}
652
653/**
654 * Notification on link status changes.
655 *
656 * @param pInterface Pointer to the interface structure containing the called function pointer.
657 * @param enmLinkState The new link state.
658 * @thread EMT
659 */
660static DECLCALLBACK(void) drvNATNetworkUp_NotifyLinkChanged(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState)
661{
662 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkUp);
663
664 LogFlow(("drvNATNetworkUp_NotifyLinkChanged: enmLinkState=%d\n", enmLinkState));
665
666 /* Don't queue new requests when the NAT thread is about to stop.
667 * But the VM could also be paused. So memorize the desired state. */
668 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
669 {
670 pThis->enmLinkStateWant = enmLinkState;
671 return;
672 }
673
674 PRTREQ pReq;
675 int rc = RTReqQueueCallEx(pThis->hSlirpReqQueue, &pReq, 0 /*cMillies*/, RTREQFLAGS_VOID,
676 (PFNRT)drvNATNotifyLinkChangedWorker, 2, pThis, enmLinkState);
677 if (RT_LIKELY(rc == VERR_TIMEOUT))
678 {
679 drvNATNotifyNATThread(pThis, "drvNATNetworkUp_NotifyLinkChanged");
680 rc = RTReqWait(pReq, RT_INDEFINITE_WAIT);
681 AssertRC(rc);
682 }
683 else
684 AssertRC(rc);
685 RTReqRelease(pReq);
686}
687
688static void drvNATNotifyApplyPortForwardCommand(PDRVNAT pThis, bool fRemove,
689 bool fUdp, const char *pHostIp,
690 uint16_t u16HostPort, const char *pGuestIp, uint16_t u16GuestPort)
691{
692 RTMAC Mac;
693 RT_ZERO(Mac); /* can't get MAC here */
694 if (pThis->pIAboveConfig)
695 pThis->pIAboveConfig->pfnGetMac(pThis->pIAboveConfig, &Mac);
696
697 struct in_addr guestIp, hostIp;
698
699 if ( pHostIp == NULL
700 || inet_aton(pHostIp, &hostIp) == 0)
701 hostIp.s_addr = INADDR_ANY;
702
703 if ( pGuestIp == NULL
704 || inet_aton(pGuestIp, &guestIp) == 0)
705 guestIp.s_addr = pThis->GuestIP;
706
707 if (fRemove)
708 slirp_remove_redirect(pThis->pNATState, fUdp, hostIp, u16HostPort, guestIp, u16GuestPort);
709 else
710 slirp_add_redirect(pThis->pNATState, fUdp, hostIp, u16HostPort, guestIp, u16GuestPort, Mac.au8);
711}
712
713DECLCALLBACK(int) drvNATNetworkNatConfig_RedirectRuleCommand(PPDMINETWORKNATCONFIG pInterface, bool fRemove,
714 bool fUdp, const char *pHostIp,
715 uint16_t u16HostPort, const char *pGuestIp, uint16_t u16GuestPort)
716{
717 LogFlowFunc(("fRemove=%d, fUdp=%d, pHostIp=%s, u16HostPort=%u, pGuestIp=%s, u16GuestPort=%u\n",
718 RT_BOOL(fRemove), RT_BOOL(fUdp), pHostIp, u16HostPort, pGuestIp,
719 u16GuestPort));
720 PDRVNAT pThis = RT_FROM_MEMBER(pInterface, DRVNAT, INetworkNATCfg);
721 PRTREQ pReq;
722 int rc = RTReqQueueCallEx(pThis->hSlirpReqQueue, &pReq, 0 /*cMillies*/, RTREQFLAGS_VOID,
723 (PFNRT)drvNATNotifyApplyPortForwardCommand, 7, pThis, fRemove,
724 fUdp, pHostIp, u16HostPort, pGuestIp, u16GuestPort);
725 if (RT_LIKELY(rc == VERR_TIMEOUT))
726 {
727 drvNATNotifyNATThread(pThis, "drvNATNetworkNatConfig_RedirectRuleCommand");
728 rc = RTReqWait(pReq, RT_INDEFINITE_WAIT);
729 AssertRC(rc);
730 }
731 else
732 AssertRC(rc);
733
734 RTReqRelease(pReq);
735 port_forwarding_done:
736 return rc;
737}
738
739/**
740 * NAT thread handling the slirp stuff.
741 *
742 * The slirp implementation is single-threaded so we execute this enginre in a
743 * dedicated thread. We take care that this thread does not become the
744 * bottleneck: If the guest wants to send, a request is enqueued into the
745 * hSlirpReqQueue and handled asynchronously by this thread. If this thread
746 * wants to deliver packets to the guest, it enqueues a request into
747 * hRecvReqQueue which is later handled by the Recv thread.
748 */
749static DECLCALLBACK(int) drvNATAsyncIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
750{
751 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
752 int nFDs = -1;
753#ifdef RT_OS_WINDOWS
754 HANDLE *phEvents = slirp_get_events(pThis->pNATState);
755 unsigned int cBreak = 0;
756#else /* RT_OS_WINDOWS */
757 unsigned int cPollNegRet = 0;
758#endif /* !RT_OS_WINDOWS */
759
760 LogFlow(("drvNATAsyncIoThread: pThis=%p\n", pThis));
761
762 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
763 return VINF_SUCCESS;
764
765 if (pThis->enmLinkStateWant != pThis->enmLinkState)
766 drvNATNotifyLinkChangedWorker(pThis, pThis->enmLinkStateWant);
767
768 /*
769 * Polling loop.
770 */
771 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
772 {
773 /*
774 * To prevent concurrent execution of sending/receiving threads
775 */
776#ifndef RT_OS_WINDOWS
777 nFDs = slirp_get_nsock(pThis->pNATState);
778 /* allocation for all sockets + Management pipe */
779 struct pollfd *polls = (struct pollfd *)RTMemAlloc((1 + nFDs) * sizeof(struct pollfd) + sizeof(uint32_t));
780 if (polls == NULL)
781 return VERR_NO_MEMORY;
782
783 /* don't pass the management pipe */
784 slirp_select_fill(pThis->pNATState, &nFDs, &polls[1]);
785
786 polls[0].fd = RTPipeToNative(pThis->hPipeRead);
787 /* POLLRDBAND usually doesn't used on Linux but seems used on Solaris */
788 polls[0].events = POLLRDNORM | POLLPRI | POLLRDBAND;
789 polls[0].revents = 0;
790
791 int cChangedFDs = poll(polls, nFDs + 1, slirp_get_timeout_ms(pThis->pNATState));
792 if (cChangedFDs < 0)
793 {
794 if (errno == EINTR)
795 {
796 Log2(("NAT: signal was caught while sleep on poll\n"));
797 /* No error, just process all outstanding requests but don't wait */
798 cChangedFDs = 0;
799 }
800 else if (cPollNegRet++ > 128)
801 {
802 LogRel(("NAT:Poll returns (%s) suppressed %d\n", strerror(errno), cPollNegRet));
803 cPollNegRet = 0;
804 }
805 }
806
807 if (cChangedFDs >= 0)
808 {
809 slirp_select_poll(pThis->pNATState, &polls[1], nFDs);
810 if (polls[0].revents & (POLLRDNORM|POLLPRI|POLLRDBAND))
811 {
812 /* drain the pipe
813 *
814 * Note! drvNATSend decoupled so we don't know how many times
815 * device's thread sends before we've entered multiplex,
816 * so to avoid false alarm drain pipe here to the very end
817 *
818 * @todo: Probably we should counter drvNATSend to count how
819 * deep pipe has been filed before drain.
820 *
821 */
822 /** @todo XXX: Make it reading exactly we need to drain the
823 * pipe.*/
824 char ch;
825 size_t cbRead;
826 RTPipeRead(pThis->hPipeRead, &ch, 1, &cbRead);
827 }
828 }
829 /* process _all_ outstanding requests but don't wait */
830 RTReqQueueProcess(pThis->hSlirpReqQueue, 0);
831 RTMemFree(polls);
832
833#else /* RT_OS_WINDOWS */
834 nFDs = -1;
835 slirp_select_fill(pThis->pNATState, &nFDs);
836 DWORD dwEvent = WSAWaitForMultipleEvents(nFDs, phEvents, FALSE,
837 slirp_get_timeout_ms(pThis->pNATState),
838 /* :fAlertable */ TRUE);
839 if ( (dwEvent < WSA_WAIT_EVENT_0 || dwEvent > WSA_WAIT_EVENT_0 + nFDs - 1)
840 && dwEvent != WSA_WAIT_TIMEOUT && dwEvent != WSA_WAIT_IO_COMPLETION)
841 {
842 int error = WSAGetLastError();
843 LogRel(("NAT: WSAWaitForMultipleEvents returned %d (error %d)\n", dwEvent, error));
844 RTAssertPanic();
845 }
846
847 if (dwEvent == WSA_WAIT_TIMEOUT)
848 {
849 /* only check for slow/fast timers */
850 slirp_select_poll(pThis->pNATState, /* fTimeout=*/true);
851 continue;
852 }
853 /* poll the sockets in any case */
854 Log2(("%s: poll\n", __FUNCTION__));
855 slirp_select_poll(pThis->pNATState, /* fTimeout=*/false);
856 /* process _all_ outstanding requests but don't wait */
857 RTReqQueueProcess(pThis->hSlirpReqQueue, 0);
858# ifdef VBOX_NAT_DELAY_HACK
859 if (cBreak++ > 128)
860 {
861 cBreak = 0;
862 RTThreadSleep(2);
863 }
864# endif
865#endif /* RT_OS_WINDOWS */
866 }
867
868 return VINF_SUCCESS;
869}
870
871
872/**
873 * Unblock the send thread so it can respond to a state change.
874 *
875 * @returns VBox status code.
876 * @param pDevIns The pcnet device instance.
877 * @param pThread The send thread.
878 */
879static DECLCALLBACK(int) drvNATAsyncIoWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
880{
881 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
882
883 drvNATNotifyNATThread(pThis, "drvNATAsyncIoWakeup");
884 return VINF_SUCCESS;
885}
886
887/**
888 * Function called by slirp to check if it's possible to feed incoming data to the network port.
889 * @returns 1 if possible.
890 * @returns 0 if not possible.
891 */
892int slirp_can_output(void *pvUser)
893{
894 return 1;
895}
896
897void slirp_push_recv_thread(void *pvUser)
898{
899 PDRVNAT pThis = (PDRVNAT)pvUser;
900 Assert(pThis);
901 drvNATUrgRecvWakeup(pThis->pDrvIns, pThis->pUrgRecvThread);
902}
903
904void slirp_urg_output(void *pvUser, struct mbuf *m, const uint8_t *pu8Buf, int cb)
905{
906 PDRVNAT pThis = (PDRVNAT)pvUser;
907 Assert(pThis);
908
909 PRTREQ pReq = NULL;
910
911 /* don't queue new requests when the NAT thread is about to stop */
912 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
913 return;
914
915 ASMAtomicIncU32(&pThis->cUrgPkts);
916 int rc = RTReqQueueCallEx(pThis->hUrgRecvReqQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
917 (PFNRT)drvNATUrgRecvWorker, 4, pThis, pu8Buf, cb, m);
918 AssertRC(rc);
919 drvNATUrgRecvWakeup(pThis->pDrvIns, pThis->pUrgRecvThread);
920}
921
922/**
923 * Function called by slirp to wake up device after VERR_TRY_AGAIN
924 */
925void slirp_output_pending(void *pvUser)
926{
927 PDRVNAT pThis = (PDRVNAT)pvUser;
928 Assert(pThis);
929 LogFlowFuncEnter();
930 pThis->pIAboveNet->pfnXmitPending(pThis->pIAboveNet);
931 LogFlowFuncLeave();
932}
933
934/**
935 * Function called by slirp to feed incoming data to the NIC.
936 */
937void slirp_output(void *pvUser, struct mbuf *m, const uint8_t *pu8Buf, int cb)
938{
939 PDRVNAT pThis = (PDRVNAT)pvUser;
940 Assert(pThis);
941
942 LogFlow(("slirp_output BEGIN %p %d\n", pu8Buf, cb));
943 Log6(("slirp_output: pu8Buf=%p cb=%#x (pThis=%p)\n%.*Rhxd\n", pu8Buf, cb, pThis, cb, pu8Buf));
944
945 PRTREQ pReq = NULL;
946
947 /* don't queue new requests when the NAT thread is about to stop */
948 if (pThis->pSlirpThread->enmState != PDMTHREADSTATE_RUNNING)
949 return;
950
951 ASMAtomicIncU32(&pThis->cPkts);
952 int rc = RTReqQueueCallEx(pThis->hRecvReqQueue, NULL /*ppReq*/, 0 /*cMillies*/, RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
953 (PFNRT)drvNATRecvWorker, 4, pThis, pu8Buf, cb, m);
954 AssertRC(rc);
955 drvNATRecvWakeup(pThis->pDrvIns, pThis->pRecvThread);
956 STAM_COUNTER_INC(&pThis->StatQueuePktSent);
957 LogFlowFuncLeave();
958}
959
960
961#ifdef RT_OS_DARWIN
962/**
963 * Callback for the SystemConfiguration framework to notify us whenever the DNS
964 * server changes.
965 *
966 * @returns nothing.
967 * @param hDynStor The DynamicStore handle.
968 * @param hChangedKey Array of changed keys we watch for.
969 * @param pvUser Opaque user data (NAT driver instance).
970 */
971static DECLCALLBACK(void) drvNatDnsChanged(SCDynamicStoreRef hDynStor, CFArrayRef hChangedKeys, void *pvUser)
972{
973 PDRVNAT pThis = (PDRVNAT)pvUser;
974
975 Log2(("NAT: System configuration has changed\n"));
976
977 /* Check if any of parameters we are interested in were actually changed. If the size
978 * of hChangedKeys is 0, it means that SCDynamicStore has been restarted. */
979 if (hChangedKeys && CFArrayGetCount(hChangedKeys) > 0)
980 {
981 /* Look to the updated parameters in particular. */
982 CFStringRef pDNSKey = CFSTR("State:/Network/Global/DNS");
983
984 if (CFArrayContainsValue(hChangedKeys, CFRangeMake(0, CFArrayGetCount(hChangedKeys)), pDNSKey))
985 {
986 LogRel(("NAT: DNS servers changed, triggering reconnect\n"));
987#if 0
988 CFDictionaryRef hDnsDict = (CFDictionaryRef)SCDynamicStoreCopyValue(hDynStor, pDNSKey);
989 if (hDnsDict)
990 {
991 CFArrayRef hArrAddresses = (CFArrayRef)CFDictionaryGetValue(hDnsDict, kSCPropNetDNSServerAddresses);
992 if (hArrAddresses && CFArrayGetCount(hArrAddresses) > 0)
993 {
994 /* Dump DNS servers list. */
995 for (int i = 0; i < CFArrayGetCount(hArrAddresses); i++)
996 {
997 CFStringRef pDNSAddrStr = (CFStringRef)CFArrayGetValueAtIndex(hArrAddresses, i);
998 const char *pszDNSAddr = pDNSAddrStr ? CFStringGetCStringPtr(pDNSAddrStr, CFStringGetSystemEncoding()) : NULL;
999 LogRel(("NAT: New DNS server#%d: %s\n", i, pszDNSAddr ? pszDNSAddr : "None"));
1000 }
1001 }
1002 else
1003 LogRel(("NAT: DNS server list is empty (1)\n"));
1004
1005 CFRelease(hDnsDict);
1006 }
1007 else
1008 LogRel(("NAT: DNS server list is empty (2)\n"));
1009#endif
1010 drvNATUpdateDNS(pThis, /* fFlapLink */ true);
1011 }
1012 else
1013 Log2(("NAT: No DNS changes detected\n"));
1014 }
1015 else
1016 Log2(("NAT: SCDynamicStore has been restarted\n"));
1017}
1018#endif
1019
1020/**
1021 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
1022 */
1023static DECLCALLBACK(void *) drvNATQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1024{
1025 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
1026 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1027
1028 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
1029 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKUP, &pThis->INetworkUp);
1030 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKNATCONFIG, &pThis->INetworkNATCfg);
1031 return NULL;
1032}
1033
1034
1035/**
1036 * Get the MAC address into the slirp stack.
1037 *
1038 * Called by drvNATLoadDone and drvNATPowerOn.
1039 */
1040static void drvNATSetMac(PDRVNAT pThis)
1041{
1042 if (pThis->pIAboveConfig)
1043 {
1044 RTMAC Mac;
1045 pThis->pIAboveConfig->pfnGetMac(pThis->pIAboveConfig, &Mac);
1046 /* Re-activate the port forwarding. If */
1047 slirp_set_ethaddr_and_activate_port_forwarding(pThis->pNATState, Mac.au8, pThis->GuestIP);
1048 }
1049}
1050
1051
1052/**
1053 * After loading we have to pass the MAC address of the ethernet device to the slirp stack.
1054 * Otherwise the guest is not reachable until it performs a DHCP request or an ARP request
1055 * (usually done during guest boot).
1056 */
1057static DECLCALLBACK(int) drvNATLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSMHandle)
1058{
1059 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1060 drvNATSetMac(pThis);
1061 return VINF_SUCCESS;
1062}
1063
1064
1065/**
1066 * Some guests might not use DHCP to retrieve an IP but use a static IP.
1067 */
1068static DECLCALLBACK(void) drvNATPowerOn(PPDMDRVINS pDrvIns)
1069{
1070 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1071 drvNATSetMac(pThis);
1072}
1073
1074
1075/**
1076 * @interface_method_impl{PDMDEVREG,pfnResume}
1077 */
1078static DECLCALLBACK(void) drvNATResume(PPDMDRVINS pDrvIns)
1079{
1080 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1081 VMRESUMEREASON enmReason = PDMDrvHlpVMGetResumeReason(pDrvIns);
1082
1083 switch (enmReason)
1084 {
1085 case VMRESUMEREASON_HOST_RESUME:
1086 bool fFlapLink;
1087#if RT_OS_DARWIN
1088 /* let drvNatDnsChanged event handler do it if necessary */
1089 fFlapLink = false;
1090#else
1091 /* XXX: when in doubt, use brute force */
1092 fFlapLink = true;
1093#endif
1094 drvNATUpdateDNS(pThis, fFlapLink);
1095 return;
1096 default: /* Ignore every other resume reason. */
1097 /* do nothing */
1098 return;
1099 }
1100}
1101
1102
1103static DECLCALLBACK(int) drvNATReinitializeHostNameResolving(PDRVNAT pThis)
1104{
1105 slirpReleaseDnsSettings(pThis->pNATState);
1106 slirpInitializeDnsSettings(pThis->pNATState);
1107 return VINF_SUCCESS;
1108}
1109
1110/**
1111 * This function at this stage could be called from two places, but both from non-NAT thread,
1112 * - drvNATResume (EMT?)
1113 * - drvNatDnsChanged (darwin, GUI or main) "listener"
1114 * When Main's interface IHost will support host network configuration change event on every host,
1115 * we won't call it from drvNATResume, but from listener of Main event in the similar way it done
1116 * for port-forwarding, and it wan't be on GUI/main thread, but on EMT thread only.
1117 *
1118 * Thread here is important, because we need to change DNS server list and domain name (+ perhaps,
1119 * search string) at runtime (VBOX_NAT_ENFORCE_INTERNAL_DNS_UPDATE), we can do it safely on NAT thread,
1120 * so with changing other variables (place where we handle update) the main mechanism of update
1121 * _won't_ be changed, the only thing will change is drop of fFlapLink parameter.
1122 */
1123DECLINLINE(void) drvNATUpdateDNS(PDRVNAT pThis, bool fFlapLink)
1124{
1125 int strategy = slirp_host_network_configuration_change_strategy_selector(pThis->pNATState);
1126 switch (strategy)
1127 {
1128
1129 case VBOX_NAT_DNS_DNSPROXY:
1130 {
1131 /**
1132 * XXX: Here or in _strategy_selector we should deal with network change
1133 * in "network change" scenario domain name change we have to update guest lease
1134 * forcibly.
1135 * Note at that built-in dhcp also updates DNS information on NAT thread.
1136 */
1137 /**
1138 * It's unsafe to to do it directly on non-NAT thread
1139 * so we schedule the worker and kick the NAT thread.
1140 */
1141 RTREQQUEUE hQueue = pThis->hSlirpReqQueue;
1142
1143 int rc = RTReqQueueCallEx(hQueue, NULL /*ppReq*/, 0 /*cMillies*/,
1144 RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
1145 (PFNRT)drvNATReinitializeHostNameResolving, 1, pThis);
1146 if (RT_SUCCESS(rc))
1147 drvNATNotifyNATThread(pThis, "drvNATUpdateDNS");
1148
1149 return;
1150 }
1151
1152 case VBOX_NAT_DNS_EXTERNAL:
1153 /*
1154 * Host resumed from a suspend and the network might have changed.
1155 * Disconnect the guest from the network temporarily to let it pick up the changes.
1156 */
1157
1158 if (fFlapLink)
1159 pThis->pIAboveConfig->pfnSetLinkState(pThis->pIAboveConfig,
1160 PDMNETWORKLINKSTATE_DOWN_RESUME);
1161 return;
1162
1163 case VBOX_NAT_DNS_HOSTRESOLVER:
1164 default:
1165 return;
1166 }
1167}
1168
1169
1170/**
1171 * Info handler.
1172 */
1173static DECLCALLBACK(void) drvNATInfo(PPDMDRVINS pDrvIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1174{
1175 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1176 slirp_info(pThis->pNATState, pHlp, pszArgs);
1177}
1178
1179#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
1180static int drvNATConstructDNSMappings(unsigned iInstance, PDRVNAT pThis, PCFGMNODE pMappingsCfg)
1181{
1182 int rc = VINF_SUCCESS;
1183 LogFlowFunc(("ENTER: iInstance:%d\n", iInstance));
1184 for (PCFGMNODE pNode = CFGMR3GetFirstChild(pMappingsCfg); pNode; pNode = CFGMR3GetNextChild(pNode))
1185 {
1186 if (!CFGMR3AreValuesValid(pNode, "HostName\0HostNamePattern\0HostIP\0"))
1187 return PDMDRV_SET_ERROR(pThis->pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
1188 N_("Unknown configuration in dns mapping"));
1189 char szHostNameOrPattern[255];
1190 bool fMatch = false; /* false used for equal matching, and true if wildcard pattern is used. */
1191 RT_ZERO(szHostNameOrPattern);
1192 GET_STRING(rc, pThis, pNode, "HostName", szHostNameOrPattern[0], sizeof(szHostNameOrPattern));
1193 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1194 {
1195 GET_STRING(rc, pThis, pNode, "HostNamePattern", szHostNameOrPattern[0], sizeof(szHostNameOrPattern));
1196 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1197 {
1198 char szNodeName[225];
1199 RT_ZERO(szNodeName);
1200 CFGMR3GetName(pNode, szNodeName, sizeof(szNodeName));
1201 LogRel(("NAT: Neither 'HostName' nor 'HostNamePattern' is specified for mapping %s\n", szNodeName));
1202 continue;
1203 }
1204 fMatch = true;
1205 }
1206 struct in_addr HostIP;
1207 GETIP_DEF(rc, pThis, pNode, HostIP, INADDR_ANY);
1208 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1209 {
1210 LogRel(("NAT: DNS mapping %s is ignored (address not pointed)\n", szHostNameOrPattern));
1211 continue;
1212 }
1213 slirp_add_host_resolver_mapping(pThis->pNATState, fMatch ? NULL : szHostNameOrPattern, fMatch ? szHostNameOrPattern : NULL, HostIP.s_addr);
1214 }
1215 LogFlowFunc(("LEAVE: %Rrc\n", rc));
1216 return rc;
1217}
1218#endif /* !VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER */
1219
1220
1221/**
1222 * Sets up the redirectors.
1223 *
1224 * @returns VBox status code.
1225 * @param pCfg The configuration handle.
1226 */
1227static int drvNATConstructRedir(unsigned iInstance, PDRVNAT pThis, PCFGMNODE pCfg, PRTNETADDRIPV4 pNetwork)
1228{
1229 RTMAC Mac;
1230 RT_ZERO(Mac); /* can't get MAC here */
1231
1232 /*
1233 * Enumerate redirections.
1234 */
1235 for (PCFGMNODE pNode = CFGMR3GetFirstChild(pCfg); pNode; pNode = CFGMR3GetNextChild(pNode))
1236 {
1237#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
1238 char szNodeName[32];
1239 CFGMR3GetName(pNode, szNodeName, 32);
1240 if ( !RTStrICmp(szNodeName, "HostResolverMappings")
1241 || !RTStrICmp(szNodeName, "AttachedDriver"))
1242 continue;
1243#endif
1244 /*
1245 * Validate the port forwarding config.
1246 */
1247 if (!CFGMR3AreValuesValid(pNode, "Protocol\0UDP\0HostPort\0GuestPort\0GuestIP\0BindIP\0"))
1248 return PDMDRV_SET_ERROR(pThis->pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
1249 N_("Unknown configuration in port forwarding"));
1250
1251 /* protocol type */
1252 bool fUDP;
1253 char szProtocol[32];
1254 int rc;
1255 GET_STRING(rc, pThis, pNode, "Protocol", szProtocol[0], sizeof(szProtocol));
1256 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1257 {
1258 fUDP = false;
1259 GET_BOOL(rc, pThis, pNode, "UDP", fUDP);
1260 }
1261 else if (RT_SUCCESS(rc))
1262 {
1263 if (!RTStrICmp(szProtocol, "TCP"))
1264 fUDP = false;
1265 else if (!RTStrICmp(szProtocol, "UDP"))
1266 fUDP = true;
1267 else
1268 return PDMDrvHlpVMSetError(pThis->pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS,
1269 N_("NAT#%d: Invalid configuration value for \"Protocol\": \"%s\""),
1270 iInstance, szProtocol);
1271 }
1272 else
1273 return PDMDrvHlpVMSetError(pThis->pDrvIns, rc, RT_SRC_POS,
1274 N_("NAT#%d: configuration query for \"Protocol\" failed"),
1275 iInstance);
1276 /* host port */
1277 int32_t iHostPort;
1278 GET_S32_STRICT(rc, pThis, pNode, "HostPort", iHostPort);
1279
1280 /* guest port */
1281 int32_t iGuestPort;
1282 GET_S32_STRICT(rc, pThis, pNode, "GuestPort", iGuestPort);
1283
1284 /* guest address */
1285 struct in_addr GuestIP;
1286 GETIP_DEF(rc, pThis, pNode, GuestIP, RT_H2N_U32(pNetwork->u | CTL_GUEST));
1287
1288 /* Store the guest IP for re-establishing the port-forwarding rules. Note that GuestIP
1289 * is not documented. Without */
1290 if (pThis->GuestIP == INADDR_ANY)
1291 pThis->GuestIP = GuestIP.s_addr;
1292
1293 /*
1294 * Call slirp about it.
1295 */
1296 struct in_addr BindIP;
1297 GETIP_DEF(rc, pThis, pNode, BindIP, INADDR_ANY);
1298 if (slirp_add_redirect(pThis->pNATState, fUDP, BindIP, iHostPort, GuestIP, iGuestPort, Mac.au8) < 0)
1299 return PDMDrvHlpVMSetError(pThis->pDrvIns, VERR_NAT_REDIR_SETUP, RT_SRC_POS,
1300 N_("NAT#%d: configuration error: failed to set up "
1301 "redirection of %d to %d. Probably a conflict with "
1302 "existing services or other rules"), iInstance, iHostPort,
1303 iGuestPort);
1304 } /* for each redir rule */
1305
1306 return VINF_SUCCESS;
1307}
1308
1309
1310/**
1311 * Destruct a driver instance.
1312 *
1313 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
1314 * resources can be freed correctly.
1315 *
1316 * @param pDrvIns The driver instance data.
1317 */
1318static DECLCALLBACK(void) drvNATDestruct(PPDMDRVINS pDrvIns)
1319{
1320 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1321 LogFlow(("drvNATDestruct:\n"));
1322 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1323
1324 if (pThis->pNATState)
1325 {
1326 slirp_term(pThis->pNATState);
1327 slirp_deregister_statistics(pThis->pNATState, pDrvIns);
1328#ifdef VBOX_WITH_STATISTICS
1329# define DRV_PROFILE_COUNTER(name, dsc) DEREGISTER_COUNTER(name, pThis)
1330# define DRV_COUNTING_COUNTER(name, dsc) DEREGISTER_COUNTER(name, pThis)
1331# include "counters.h"
1332#endif
1333 pThis->pNATState = NULL;
1334 }
1335
1336 RTReqQueueDestroy(pThis->hSlirpReqQueue);
1337 pThis->hSlirpReqQueue = NIL_RTREQQUEUE;
1338
1339 RTReqQueueDestroy(pThis->hUrgRecvReqQueue);
1340 pThis->hUrgRecvReqQueue = NIL_RTREQQUEUE;
1341
1342 RTSemEventDestroy(pThis->EventRecv);
1343 pThis->EventRecv = NIL_RTSEMEVENT;
1344
1345 RTSemEventDestroy(pThis->EventUrgRecv);
1346 pThis->EventUrgRecv = NIL_RTSEMEVENT;
1347
1348 if (RTCritSectIsInitialized(&pThis->DevAccessLock))
1349 RTCritSectDelete(&pThis->DevAccessLock);
1350
1351 if (RTCritSectIsInitialized(&pThis->XmitLock))
1352 RTCritSectDelete(&pThis->XmitLock);
1353
1354#ifdef RT_OS_DARWIN
1355 /* Cleanup the DNS watcher. */
1356 CFRunLoopRef hRunLoopMain = CFRunLoopGetMain();
1357 CFRetain(hRunLoopMain);
1358 CFRunLoopRemoveSource(hRunLoopMain, pThis->hRunLoopSrcDnsWatcher, kCFRunLoopCommonModes);
1359 CFRelease(hRunLoopMain);
1360 CFRelease(pThis->hRunLoopSrcDnsWatcher);
1361 pThis->hRunLoopSrcDnsWatcher = NULL;
1362#endif
1363}
1364
1365
1366/**
1367 * Construct a NAT network transport driver instance.
1368 *
1369 * @copydoc FNPDMDRVCONSTRUCT
1370 */
1371static DECLCALLBACK(int) drvNATConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1372{
1373 PDRVNAT pThis = PDMINS_2_DATA(pDrvIns, PDRVNAT);
1374 LogFlow(("drvNATConstruct:\n"));
1375 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1376
1377 /*
1378 * Init the static parts.
1379 */
1380 pThis->pDrvIns = pDrvIns;
1381 pThis->pNATState = NULL;
1382 pThis->pszTFTPPrefix = NULL;
1383 pThis->pszBootFile = NULL;
1384 pThis->pszNextServer = NULL;
1385 pThis->hSlirpReqQueue = NIL_RTREQQUEUE;
1386 pThis->hUrgRecvReqQueue = NIL_RTREQQUEUE;
1387 pThis->EventRecv = NIL_RTSEMEVENT;
1388 pThis->EventUrgRecv = NIL_RTSEMEVENT;
1389#ifdef RT_OS_DARWIN
1390 pThis->hRunLoopSrcDnsWatcher = NULL;
1391#endif
1392
1393 /* IBase */
1394 pDrvIns->IBase.pfnQueryInterface = drvNATQueryInterface;
1395
1396 /* INetwork */
1397 pThis->INetworkUp.pfnBeginXmit = drvNATNetworkUp_BeginXmit;
1398 pThis->INetworkUp.pfnAllocBuf = drvNATNetworkUp_AllocBuf;
1399 pThis->INetworkUp.pfnFreeBuf = drvNATNetworkUp_FreeBuf;
1400 pThis->INetworkUp.pfnSendBuf = drvNATNetworkUp_SendBuf;
1401 pThis->INetworkUp.pfnEndXmit = drvNATNetworkUp_EndXmit;
1402 pThis->INetworkUp.pfnSetPromiscuousMode = drvNATNetworkUp_SetPromiscuousMode;
1403 pThis->INetworkUp.pfnNotifyLinkChanged = drvNATNetworkUp_NotifyLinkChanged;
1404
1405 /* NAT engine configuration */
1406 pThis->INetworkNATCfg.pfnRedirectRuleCommand = drvNATNetworkNatConfig_RedirectRuleCommand;
1407 pThis->INetworkNATCfg.pfnNotifyDnsChanged = NULL;
1408
1409 /*
1410 * Validate the config.
1411 */
1412 if (!CFGMR3AreValuesValid(pCfg,
1413 "PassDomain\0TFTPPrefix\0BootFile\0Network"
1414 "\0NextServer\0DNSProxy\0BindIP\0UseHostResolver\0"
1415 "SlirpMTU\0AliasMode\0"
1416 "SockRcv\0SockSnd\0TcpRcv\0TcpSnd\0"
1417 "ICMPCacheLimit\0"
1418 "SoMaxConnection\0"
1419#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
1420 "HostResolverMappings\0"
1421#endif
1422 ))
1423 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES,
1424 N_("Unknown NAT configuration option, only supports PassDomain,"
1425 " TFTPPrefix, BootFile and Network"));
1426
1427 /*
1428 * Get the configuration settings.
1429 */
1430 int rc;
1431 bool fPassDomain = true;
1432 GET_BOOL(rc, pThis, pCfg, "PassDomain", fPassDomain);
1433
1434 GET_STRING_ALLOC(rc, pThis, pCfg, "TFTPPrefix", pThis->pszTFTPPrefix);
1435 GET_STRING_ALLOC(rc, pThis, pCfg, "BootFile", pThis->pszBootFile);
1436 GET_STRING_ALLOC(rc, pThis, pCfg, "NextServer", pThis->pszNextServer);
1437
1438 int fDNSProxy = 0;
1439 GET_S32(rc, pThis, pCfg, "DNSProxy", fDNSProxy);
1440 int fUseHostResolver = 0;
1441 GET_S32(rc, pThis, pCfg, "UseHostResolver", fUseHostResolver);
1442 int MTU = 1500;
1443 GET_S32(rc, pThis, pCfg, "SlirpMTU", MTU);
1444 int i32AliasMode = 0;
1445 int i32MainAliasMode = 0;
1446 GET_S32(rc, pThis, pCfg, "AliasMode", i32MainAliasMode);
1447 int iIcmpCacheLimit = 100;
1448 GET_S32(rc, pThis, pCfg, "ICMPCacheLimit", iIcmpCacheLimit);
1449
1450 i32AliasMode |= (i32MainAliasMode & 0x1 ? 0x1 : 0);
1451 i32AliasMode |= (i32MainAliasMode & 0x2 ? 0x40 : 0);
1452 i32AliasMode |= (i32MainAliasMode & 0x4 ? 0x4 : 0);
1453 int i32SoMaxConn = 10;
1454 GET_S32(rc, pThis, pCfg, "SoMaxConnection", i32SoMaxConn);
1455 /*
1456 * Query the network port interface.
1457 */
1458 pThis->pIAboveNet = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKDOWN);
1459 if (!pThis->pIAboveNet)
1460 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
1461 N_("Configuration error: the above device/driver didn't "
1462 "export the network port interface"));
1463 pThis->pIAboveConfig = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMINETWORKCONFIG);
1464 if (!pThis->pIAboveConfig)
1465 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
1466 N_("Configuration error: the above device/driver didn't "
1467 "export the network config interface"));
1468
1469 /* Generate a network address for this network card. */
1470 char szNetwork[32]; /* xxx.xxx.xxx.xxx/yy */
1471 GET_STRING(rc, pThis, pCfg, "Network", szNetwork[0], sizeof(szNetwork));
1472 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1473 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("NAT%d: Configuration error: "
1474 "missing network"),
1475 pDrvIns->iInstance, szNetwork);
1476
1477 RTNETADDRIPV4 Network, Netmask;
1478
1479 rc = RTCidrStrToIPv4(szNetwork, &Network, &Netmask);
1480 if (RT_FAILURE(rc))
1481 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: Configuration error: "
1482 "network '%s' describes not a valid IPv4 network"),
1483 pDrvIns->iInstance, szNetwork);
1484
1485 /*
1486 * Initialize slirp.
1487 */
1488 rc = slirp_init(&pThis->pNATState, RT_H2N_U32(Network.u), Netmask.u,
1489 fPassDomain, !!fUseHostResolver, i32AliasMode,
1490 iIcmpCacheLimit, pThis);
1491 if (RT_SUCCESS(rc))
1492 {
1493 slirp_set_dhcp_TFTP_prefix(pThis->pNATState, pThis->pszTFTPPrefix);
1494 slirp_set_dhcp_TFTP_bootfile(pThis->pNATState, pThis->pszBootFile);
1495 slirp_set_dhcp_next_server(pThis->pNATState, pThis->pszNextServer);
1496 slirp_set_dhcp_dns_proxy(pThis->pNATState, !!fDNSProxy);
1497 slirp_set_mtu(pThis->pNATState, MTU);
1498 slirp_set_somaxconn(pThis->pNATState, i32SoMaxConn);
1499 char *pszBindIP = NULL;
1500 GET_STRING_ALLOC(rc, pThis, pCfg, "BindIP", pszBindIP);
1501 rc = slirp_set_binding_address(pThis->pNATState, pszBindIP);
1502 if (rc != 0 && pszBindIP && *pszBindIP)
1503 LogRel(("NAT: value of BindIP has been ignored\n"));
1504
1505 if(pszBindIP != NULL)
1506 MMR3HeapFree(pszBindIP);
1507#define SLIRP_SET_TUNING_VALUE(name, setter) \
1508 do \
1509 { \
1510 int len = 0; \
1511 rc = CFGMR3QueryS32(pCfg, name, &len); \
1512 if (RT_SUCCESS(rc)) \
1513 setter(pThis->pNATState, len); \
1514 } while(0)
1515
1516 SLIRP_SET_TUNING_VALUE("SockRcv", slirp_set_rcvbuf);
1517 SLIRP_SET_TUNING_VALUE("SockSnd", slirp_set_sndbuf);
1518 SLIRP_SET_TUNING_VALUE("TcpRcv", slirp_set_tcp_rcvspace);
1519 SLIRP_SET_TUNING_VALUE("TcpSnd", slirp_set_tcp_sndspace);
1520
1521 slirp_register_statistics(pThis->pNATState, pDrvIns);
1522#ifdef VBOX_WITH_STATISTICS
1523# define DRV_PROFILE_COUNTER(name, dsc) REGISTER_COUNTER(name, pThis, STAMTYPE_PROFILE, STAMUNIT_TICKS_PER_CALL, dsc)
1524# define DRV_COUNTING_COUNTER(name, dsc) REGISTER_COUNTER(name, pThis, STAMTYPE_COUNTER, STAMUNIT_COUNT, dsc)
1525# include "counters.h"
1526#endif
1527
1528#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
1529 PCFGMNODE pMappingsCfg = CFGMR3GetChild(pCfg, "HostResolverMappings");
1530
1531 if (pMappingsCfg)
1532 {
1533 rc = drvNATConstructDNSMappings(pDrvIns->iInstance, pThis, pMappingsCfg);
1534 AssertRC(rc);
1535 }
1536#endif
1537 rc = drvNATConstructRedir(pDrvIns->iInstance, pThis, pCfg, &Network);
1538 if (RT_SUCCESS(rc))
1539 {
1540 /*
1541 * Register a load done notification to get the MAC address into the slirp
1542 * engine after we loaded a guest state.
1543 */
1544 rc = PDMDrvHlpSSMRegisterLoadDone(pDrvIns, drvNATLoadDone);
1545 AssertLogRelRCReturn(rc, rc);
1546
1547 rc = RTReqQueueCreate(&pThis->hSlirpReqQueue);
1548 AssertLogRelRCReturn(rc, rc);
1549
1550 rc = RTReqQueueCreate(&pThis->hRecvReqQueue);
1551 AssertLogRelRCReturn(rc, rc);
1552
1553 rc = RTReqQueueCreate(&pThis->hUrgRecvReqQueue);
1554 AssertLogRelRCReturn(rc, rc);
1555
1556 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pRecvThread, pThis, drvNATRecv,
1557 drvNATRecvWakeup, 128 * _1K, RTTHREADTYPE_IO, "NATRX");
1558 AssertRCReturn(rc, rc);
1559
1560 rc = RTSemEventCreate(&pThis->EventRecv);
1561 AssertRCReturn(rc, rc);
1562
1563 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pUrgRecvThread, pThis, drvNATUrgRecv,
1564 drvNATUrgRecvWakeup, 128 * _1K, RTTHREADTYPE_IO, "NATURGRX");
1565 AssertRCReturn(rc, rc);
1566
1567 rc = RTSemEventCreate(&pThis->EventRecv);
1568 AssertRCReturn(rc, rc);
1569
1570 rc = RTSemEventCreate(&pThis->EventUrgRecv);
1571 AssertRCReturn(rc, rc);
1572
1573 rc = RTCritSectInit(&pThis->DevAccessLock);
1574 AssertRCReturn(rc, rc);
1575
1576 rc = RTCritSectInit(&pThis->XmitLock);
1577 AssertRCReturn(rc, rc);
1578
1579 char szTmp[128];
1580 RTStrPrintf(szTmp, sizeof(szTmp), "nat%d", pDrvIns->iInstance);
1581 PDMDrvHlpDBGFInfoRegister(pDrvIns, szTmp, "NAT info.", drvNATInfo);
1582
1583#ifndef RT_OS_WINDOWS
1584 /*
1585 * Create the control pipe.
1586 */
1587 rc = RTPipeCreate(&pThis->hPipeRead, &pThis->hPipeWrite, 0 /*fFlags*/);
1588 AssertRCReturn(rc, rc);
1589#else
1590 pThis->hWakeupEvent = CreateEvent(NULL, FALSE, FALSE, NULL); /* auto-reset event */
1591 slirp_register_external_event(pThis->pNATState, pThis->hWakeupEvent,
1592 VBOX_WAKEUP_EVENT_INDEX);
1593#endif
1594
1595 rc = PDMDrvHlpThreadCreate(pDrvIns, &pThis->pSlirpThread, pThis, drvNATAsyncIoThread,
1596 drvNATAsyncIoWakeup, 128 * _1K, RTTHREADTYPE_IO, "NAT");
1597 AssertRCReturn(rc, rc);
1598
1599 pThis->enmLinkState = pThis->enmLinkStateWant = PDMNETWORKLINKSTATE_UP;
1600
1601#ifdef RT_OS_DARWIN
1602 /* Set up a watcher which notifies us everytime the DNS server changes. */
1603 int rc2 = VINF_SUCCESS;
1604 SCDynamicStoreContext SCDynStorCtx;
1605
1606 SCDynStorCtx.version = 0;
1607 SCDynStorCtx.info = pThis;
1608 SCDynStorCtx.retain = NULL;
1609 SCDynStorCtx.release = NULL;
1610 SCDynStorCtx.copyDescription = NULL;
1611
1612 SCDynamicStoreRef hDynStor = SCDynamicStoreCreate(NULL, CFSTR("org.virtualbox.drvnat"), drvNatDnsChanged, &SCDynStorCtx);
1613 if (hDynStor)
1614 {
1615 CFRunLoopSourceRef hRunLoopSrc = SCDynamicStoreCreateRunLoopSource(NULL, hDynStor, 0);
1616 if (hRunLoopSrc)
1617 {
1618 CFStringRef aWatchKeys[] =
1619 {
1620 CFSTR("State:/Network/Global/DNS")
1621 };
1622 CFArrayRef hArray = CFArrayCreate(NULL, (const void **)aWatchKeys, 1, &kCFTypeArrayCallBacks);
1623
1624 if (hArray)
1625 {
1626 if (SCDynamicStoreSetNotificationKeys(hDynStor, hArray, NULL))
1627 {
1628 CFRunLoopRef hRunLoopMain = CFRunLoopGetMain();
1629 CFRetain(hRunLoopMain);
1630 CFRunLoopAddSource(hRunLoopMain, hRunLoopSrc, kCFRunLoopCommonModes);
1631 CFRelease(hRunLoopMain);
1632 pThis->hRunLoopSrcDnsWatcher = hRunLoopSrc;
1633 }
1634 else
1635 rc2 = VERR_NO_MEMORY;
1636
1637 CFRelease(hArray);
1638 }
1639 else
1640 rc2 = VERR_NO_MEMORY;
1641
1642 if (RT_FAILURE(rc2)) /* Keep the runloop source referenced for destruction. */
1643 CFRelease(hRunLoopSrc);
1644 }
1645 CFRelease(hDynStor);
1646 }
1647 else
1648 rc2 = VERR_NO_MEMORY;
1649
1650 if (RT_FAILURE(rc2))
1651 LogRel(("NAT#%d: Failed to install DNS change notifier. The guest might loose DNS access when switching networks on the host\n",
1652 pDrvIns->iInstance));
1653#endif
1654
1655 /* might return VINF_NAT_DNS */
1656 return rc;
1657 }
1658
1659 /* failure path */
1660 slirp_term(pThis->pNATState);
1661 pThis->pNATState = NULL;
1662 }
1663 else
1664 {
1665 PDMDRV_SET_ERROR(pDrvIns, rc, N_("Unknown error during NAT networking setup: "));
1666 AssertMsgFailed(("Add error message for rc=%d (%Rrc)\n", rc, rc));
1667 }
1668
1669 return rc;
1670}
1671
1672
1673/**
1674 * NAT network transport driver registration record.
1675 */
1676const PDMDRVREG g_DrvNAT =
1677{
1678 /* u32Version */
1679 PDM_DRVREG_VERSION,
1680 /* szName */
1681 "NAT",
1682 /* szRCMod */
1683 "",
1684 /* szR0Mod */
1685 "",
1686 /* pszDescription */
1687 "NAT Network Transport Driver",
1688 /* fFlags */
1689 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1690 /* fClass. */
1691 PDM_DRVREG_CLASS_NETWORK,
1692 /* cMaxInstances */
1693 ~0U,
1694 /* cbInstance */
1695 sizeof(DRVNAT),
1696 /* pfnConstruct */
1697 drvNATConstruct,
1698 /* pfnDestruct */
1699 drvNATDestruct,
1700 /* pfnRelocate */
1701 NULL,
1702 /* pfnIOCtl */
1703 NULL,
1704 /* pfnPowerOn */
1705 drvNATPowerOn,
1706 /* pfnReset */
1707 NULL,
1708 /* pfnSuspend */
1709 NULL,
1710 /* pfnResume */
1711 drvNATResume,
1712 /* pfnAttach */
1713 NULL,
1714 /* pfnDetach */
1715 NULL,
1716 /* pfnPowerOff */
1717 NULL,
1718 /* pfnSoftReset */
1719 NULL,
1720 /* u32EndVersion */
1721 PDM_DRVREG_VERSION
1722};
1723
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