DrvNAT.cpp@ 39731

Last change on this file since 39731 was 39550, checked in by vboxsync, 13 years ago
Request thread pool hancking. Some RTReq refactoring as always...
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 49.6 KB

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

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

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

Download in other formats: