DrvNAT.cpp@ 28187

Last change on this file since 28187 was 28147, checked in by vboxsync, 15 years ago
NAT: Fixed missing setting of time_fasttimo in ip_icmp.c. Removed slirp_arm_fast_timer and slirp_arm_slow_timer.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.3 KB

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

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

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

Download in other formats: