VirtualBox

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

Last change on this file since 5059 was 4071, checked in by vboxsync, 18 years ago

Biggest check-in ever. New source code headers for all (C) innotek files.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.0 KB
Line 
1/** @file
2 *
3 * VBox network devices:
4 * NAT network transport driver
5 */
6
7/*
8 * Copyright (C) 2006-2007 innotek GmbH
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License as published by the Free Software Foundation,
14 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
15 * distribution. VirtualBox OSE is distributed in the hope that it will
16 * be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19
20/*******************************************************************************
21* Header Files *
22*******************************************************************************/
23#define LOG_GROUP LOG_GROUP_DRV_NAT
24#include "Network/slirp/libslirp.h"
25#include <VBox/pdmdrv.h>
26#include <iprt/assert.h>
27#include <iprt/file.h>
28#include <iprt/string.h>
29#include <iprt/critsect.h>
30
31#include "Builtins.h"
32
33
34/*******************************************************************************
35* Structures and Typedefs *
36*******************************************************************************/
37/**
38 * Block driver instance data.
39 */
40typedef struct DRVNAT
41{
42 /** The network interface. */
43 PDMINETWORKCONNECTOR INetworkConnector;
44 /** The port we're attached to. */
45 PPDMINETWORKPORT pPort;
46 /** Pointer to the driver instance. */
47 PPDMDRVINS pDrvIns;
48 /** Slirp critical section. */
49 RTCRITSECT CritSect;
50 /** Link state */
51 PDMNETWORKLINKSTATE enmLinkState;
52 /** NAT state for this instance. */
53 PNATState pNATState;
54} DRVNAT, *PDRVNAT;
55
56/** Converts a pointer to NAT::INetworkConnector to a PRDVNAT. */
57#define PDMINETWORKCONNECTOR_2_DRVNAT(pInterface) ( (PDRVNAT)((uintptr_t)pInterface - RT_OFFSETOF(DRVNAT, INetworkConnector)) )
58
59
60/*******************************************************************************
61* Global Variables *
62*******************************************************************************/
63#if 0
64/** If set the thread should terminate. */
65static bool g_fThreadTerm = false;
66/** The thread id of the select thread (drvNATSelectThread()). */
67static RTTHREAD g_ThreadSelect;
68#endif
69
70
71/**
72 * Send data to the network.
73 *
74 * @returns VBox status code.
75 * @param pInterface Pointer to the interface structure containing the called function pointer.
76 * @param pvBuf Data to send.
77 * @param cb Number of bytes to send.
78 * @thread EMT
79 */
80static DECLCALLBACK(int) drvNATSend(PPDMINETWORKCONNECTOR pInterface, const void *pvBuf, size_t cb)
81{
82 PDRVNAT pData = PDMINETWORKCONNECTOR_2_DRVNAT(pInterface);
83
84 LogFlow(("drvNATSend: pvBuf=%p cb=%#x\n", pvBuf, cb));
85 Log2(("drvNATSend: pvBuf=%p cb=%#x\n"
86 "%.*Vhxd\n",
87 pvBuf, cb, cb, pvBuf));
88
89 int rc = RTCritSectEnter(&pData->CritSect);
90 AssertReleaseRC(rc);
91
92 Assert(pData->enmLinkState == PDMNETWORKLINKSTATE_UP);
93 if (pData->enmLinkState == PDMNETWORKLINKSTATE_UP)
94 slirp_input(pData->pNATState, (uint8_t *)pvBuf, cb);
95 RTCritSectLeave(&pData->CritSect);
96 LogFlow(("drvNATSend: end\n"));
97 return VINF_SUCCESS;
98}
99
100
101/**
102 * Set promiscuous mode.
103 *
104 * This is called when the promiscuous mode is set. This means that there doesn't have
105 * to be a mode change when it's called.
106 *
107 * @param pInterface Pointer to the interface structure containing the called function pointer.
108 * @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not.
109 * @thread EMT
110 */
111static DECLCALLBACK(void) drvNATSetPromiscuousMode(PPDMINETWORKCONNECTOR pInterface, bool fPromiscuous)
112{
113 LogFlow(("drvNATSetPromiscuousMode: fPromiscuous=%d\n", fPromiscuous));
114 /* nothing to do */
115}
116
117
118/**
119 * Notification on link status changes.
120 *
121 * @param pInterface Pointer to the interface structure containing the called function pointer.
122 * @param enmLinkState The new link state.
123 * @thread EMT
124 */
125static DECLCALLBACK(void) drvNATNotifyLinkChanged(PPDMINETWORKCONNECTOR pInterface, PDMNETWORKLINKSTATE enmLinkState)
126{
127 PDRVNAT pData = PDMINETWORKCONNECTOR_2_DRVNAT(pInterface);
128
129 LogFlow(("drvNATNotifyLinkChanged: enmLinkState=%d\n", enmLinkState));
130
131 int rc = RTCritSectEnter(&pData->CritSect);
132 AssertReleaseRC(rc);
133 pData->enmLinkState = enmLinkState;
134
135 switch (enmLinkState)
136 {
137 case PDMNETWORKLINKSTATE_UP:
138 LogRel(("NAT: link up\n"));
139 slirp_link_up(pData->pNATState);
140 break;
141
142 case PDMNETWORKLINKSTATE_DOWN:
143 case PDMNETWORKLINKSTATE_DOWN_RESUME:
144 LogRel(("NAT: link down\n"));
145 slirp_link_down(pData->pNATState);
146 break;
147
148 default:
149 AssertMsgFailed(("drvNATNotifyLinkChanged: unexpected link state %d\n", enmLinkState));
150 }
151 RTCritSectLeave(&pData->CritSect);
152}
153
154
155/**
156 * More receive buffer has become available.
157 *
158 * This is called when the NIC frees up receive buffers.
159 *
160 * @param pInterface Pointer to the interface structure containing the called function pointer.
161 * @thread EMT
162 */
163static DECLCALLBACK(void) drvNATNotifyCanReceive(PPDMINETWORKCONNECTOR pInterface)
164{
165 LogFlow(("drvNATNotifyCanReceive:\n"));
166 /** @todo do something useful here. */
167}
168
169
170/**
171 * Poller callback.
172 */
173static DECLCALLBACK(void) drvNATPoller(PPDMDRVINS pDrvIns)
174{
175 PDRVNAT pData = PDMINS2DATA(pDrvIns, PDRVNAT);
176 fd_set ReadFDs;
177 fd_set WriteFDs;
178 fd_set XcptFDs;
179 int cFDs = -1;
180 FD_ZERO(&ReadFDs);
181 FD_ZERO(&WriteFDs);
182 FD_ZERO(&XcptFDs);
183
184 int rc = RTCritSectEnter(&pData->CritSect);
185 AssertReleaseRC(rc);
186
187 slirp_select_fill(pData->pNATState, &cFDs, &ReadFDs, &WriteFDs, &XcptFDs);
188
189 struct timeval tv = {0, 0}; /* no wait */
190 int cReadFDs = select(cFDs + 1, &ReadFDs, &WriteFDs, &XcptFDs, &tv);
191 if (cReadFDs >= 0)
192 slirp_select_poll(pData->pNATState, &ReadFDs, &WriteFDs, &XcptFDs);
193
194 RTCritSectLeave(&pData->CritSect);
195}
196
197
198/**
199 * Function called by slirp to check if it's possible to feed incoming data to the network port.
200 * @returns 1 if possible.
201 * @returns 0 if not possible.
202 */
203int slirp_can_output(void *pvUser)
204{
205 PDRVNAT pData = (PDRVNAT)pvUser;
206
207 Assert(pData);
208
209 /** Happens during termination */
210 if (!RTCritSectIsOwner(&pData->CritSect))
211 return 0;
212
213 return pData->pPort->pfnCanReceive(pData->pPort);
214}
215
216
217/**
218 * Function called by slirp to feed incoming data to the network port.
219 */
220void slirp_output(void *pvUser, const uint8_t *pu8Buf, int cb)
221{
222 PDRVNAT pData = (PDRVNAT)pvUser;
223
224 LogFlow(("slirp_output BEGIN %x %d\n", pu8Buf, cb));
225 Log2(("slirp_output: pu8Buf=%p cb=%#x (pData=%p)\n"
226 "%.*Vhxd\n",
227 pu8Buf, cb, pData,
228 cb, pu8Buf));
229
230 Assert(pData);
231
232 /** Happens during termination */
233 if (!RTCritSectIsOwner(&pData->CritSect))
234 return;
235
236 int rc = pData->pPort->pfnReceive(pData->pPort, pu8Buf, cb);
237 AssertRC(rc);
238 LogFlow(("slirp_output END %x %d\n", pu8Buf, cb));
239}
240
241/**
242 * Queries an interface to the driver.
243 *
244 * @returns Pointer to interface.
245 * @returns NULL if the interface was not supported by the driver.
246 * @param pInterface Pointer to this interface structure.
247 * @param enmInterface The requested interface identification.
248 * @thread Any thread.
249 */
250static DECLCALLBACK(void *) drvNATQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
251{
252 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
253 PDRVNAT pData = PDMINS2DATA(pDrvIns, PDRVNAT);
254 switch (enmInterface)
255 {
256 case PDMINTERFACE_BASE:
257 return &pDrvIns->IBase;
258 case PDMINTERFACE_NETWORK_CONNECTOR:
259 return &pData->INetworkConnector;
260 default:
261 return NULL;
262 }
263}
264
265
266/**
267 * Destruct a driver instance.
268 *
269 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
270 * resources can be freed correctly.
271 *
272 * @param pDrvIns The driver instance data.
273 */
274static DECLCALLBACK(void) drvNATDestruct(PPDMDRVINS pDrvIns)
275{
276 PDRVNAT pData = PDMINS2DATA(pDrvIns, PDRVNAT);
277
278 LogFlow(("drvNATDestruct:\n"));
279
280 int rc = RTCritSectEnter(&pData->CritSect);
281 AssertReleaseRC(rc);
282 slirp_term(pData->pNATState);
283 pData->pNATState = NULL;
284 RTCritSectLeave(&pData->CritSect);
285
286 RTCritSectDelete(&pData->CritSect);
287}
288
289
290/**
291 * Sets up the redirectors.
292 *
293 * @returns VBox status code.
294 * @param pCfgHandle The drivers configuration handle.
295 */
296static int drvNATConstructRedir(unsigned iInstance, PDRVNAT pData, PCFGMNODE pCfgHandle)
297{
298 /*
299 * Enumerate redirections.
300 */
301 for (PCFGMNODE pNode = CFGMR3GetFirstChild(pCfgHandle); pNode; pNode = CFGMR3GetNextChild(pNode))
302 {
303 /*
304 * Validate the port forwarding config.
305 */
306 if (!CFGMR3AreValuesValid(pNode, "Protocol\0UDP\0HostPort\0GuestPort\0GuestIP\0"))
307 return PDMDRV_SET_ERROR(pData->pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES, N_("Unknown configuration in port forwarding"));
308
309 /* protocol type */
310 bool fUDP;
311 char szProtocol[32];
312 int rc = CFGMR3QueryString(pNode, "Protocol", &szProtocol[0], sizeof(szProtocol));
313 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
314 {
315 rc = CFGMR3QueryBool(pNode, "UDP", &fUDP);
316 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
317 fUDP = false;
318 else if (VBOX_FAILURE(rc))
319 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"UDP\" boolean returned %Vrc"), iInstance, rc);
320 }
321 else if (VBOX_SUCCESS(rc))
322 {
323 if (!RTStrICmp(szProtocol, "TCP"))
324 fUDP = false;
325 else if (!RTStrICmp(szProtocol, "UDP"))
326 fUDP = true;
327 else
328 return PDMDrvHlpVMSetError(pData->pDrvIns, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("NAT#%d: Invalid configuration value for \"Protocol\": \"%s\""), iInstance, szProtocol);
329 }
330 else
331 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"Protocol\" string returned %Vrc"), iInstance, rc);
332
333 /* host port */
334 int32_t iHostPort;
335 rc = CFGMR3QueryS32(pNode, "HostPort", &iHostPort);
336 if (VBOX_FAILURE(rc))
337 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"HostPort\" integer returned %Vrc"), iInstance, rc);
338
339 /* guest port */
340 int32_t iGuestPort;
341 rc = CFGMR3QueryS32(pNode, "GuestPort", &iGuestPort);
342 if (VBOX_FAILURE(rc))
343 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"GuestPort\" integer returned %Vrc"), iInstance, rc);
344
345 /* guest address */
346 char szGuestIP[32];
347 rc = CFGMR3QueryString(pNode, "GuestIP", &szGuestIP[0], sizeof(szGuestIP));
348 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
349 strcpy(szGuestIP, "10.0.2.15");
350 else if (VBOX_FAILURE(rc))
351 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"GuestIP\" string returned %Vrc"), iInstance, rc);
352 struct in_addr GuestIP;
353 if (!inet_aton(szGuestIP, &GuestIP))
354 return PDMDrvHlpVMSetError(pData->pDrvIns, VERR_NAT_REDIR_GUEST_IP, RT_SRC_POS, N_("NAT#%d: configuration error: invalid \"GuestIP\"=\"%s\", inet_aton failed"), iInstance, szGuestIP);
355
356 /*
357 * Call slirp about it.
358 */
359 Log(("drvNATConstruct: Redir %d -> %s:%d\n", iHostPort, szGuestIP, iGuestPort));
360 if (slirp_redir(pData->pNATState, fUDP, iHostPort, GuestIP, iGuestPort) < 0)
361 return PDMDrvHlpVMSetError(pData->pDrvIns, VERR_NAT_REDIR_SETUP, RT_SRC_POS, N_("NAT#%d: configuration error: failed to set up redirection of %d to %s:%d. Probably a conflict with existing services or other rules"), iInstance, iHostPort, szGuestIP, iGuestPort);
362 } /* for each redir rule */
363
364 return VINF_SUCCESS;
365}
366
367
368/**
369 * Construct a NAT network transport driver instance.
370 *
371 * @returns VBox status.
372 * @param pDrvIns The driver instance data.
373 * If the registration structure is needed, pDrvIns->pDrvReg points to it.
374 * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
375 * of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
376 * iInstance it's expected to be used a bit in this function.
377 */
378static DECLCALLBACK(int) drvNATConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
379{
380 PDRVNAT pData = PDMINS2DATA(pDrvIns, PDRVNAT);
381 char szNetAddr[16];
382 LogFlow(("drvNATConstruct:\n"));
383
384 /*
385 * Validate the config.
386 */
387 if (!CFGMR3AreValuesValid(pCfgHandle, "PassDomain\0"))
388 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES, "Unknown NAT configuration option, only supports PassDomain");
389
390 /*
391 * Get the configuration settings.
392 */
393 bool fPassDomain = true;
394 int rc = CFGMR3QueryBool(pCfgHandle, "PassDomain", &fPassDomain);
395 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
396 fPassDomain = true;
397 else if (VBOX_FAILURE(rc))
398 return PDMDrvHlpVMSetError(pData->pDrvIns, rc, RT_SRC_POS, N_("NAT#%d: configuration query for \"PassDomain\" boolean returned %Vrc"), pDrvIns->iInstance, rc);
399
400 /*
401 * Init the static parts.
402 */
403 pData->pDrvIns = pDrvIns;
404 pData->pNATState = NULL;
405 /* IBase */
406 pDrvIns->IBase.pfnQueryInterface = drvNATQueryInterface;
407 /* INetwork */
408 pData->INetworkConnector.pfnSend = drvNATSend;
409 pData->INetworkConnector.pfnSetPromiscuousMode = drvNATSetPromiscuousMode;
410 pData->INetworkConnector.pfnNotifyLinkChanged = drvNATNotifyLinkChanged;
411 pData->INetworkConnector.pfnNotifyCanReceive = drvNATNotifyCanReceive;
412
413 /*
414 * Query the network port interface.
415 */
416 pData->pPort = (PPDMINETWORKPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_NETWORK_PORT);
417 if (!pData->pPort)
418 return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE,
419 N_("Configuration error: the above device/driver didn't export the network port interface!\n"));
420
421 /* Generate a network address for this network card. */
422 RTStrPrintf(szNetAddr, sizeof(szNetAddr), "10.0.%d.0", pDrvIns->iInstance + 2);
423
424 /*
425 * The slirp lock..
426 */
427 rc = RTCritSectInit(&pData->CritSect);
428 if (VBOX_FAILURE(rc))
429 return rc;
430#if 0
431 rc = RTSemEventCreate(&g_EventSem);
432 if (VBOX_SUCCESS(rc))
433 {
434 /*
435 * Start the select thread. (it'll block on the sem)
436 */
437 g_fThreadTerm = false;
438 rc = RTThreadCreate(&g_ThreadSelect, drvNATSelectThread, 0, NULL, "NATSEL");
439 if (VBOX_SUCCESS(rc))
440 {
441#endif
442 /*
443 * Initialize slirp.
444 */
445 rc = slirp_init(&pData->pNATState, &szNetAddr[0], fPassDomain, pData);
446 if (VBOX_SUCCESS(rc))
447 {
448 int rc2 = drvNATConstructRedir(pDrvIns->iInstance, pData, pCfgHandle);
449 if (VBOX_SUCCESS(rc2))
450 {
451 pDrvIns->pDrvHlp->pfnPDMPollerRegister(pDrvIns, drvNATPoller);
452
453 pData->enmLinkState = PDMNETWORKLINKSTATE_UP;
454#if 0
455 RTSemEventSignal(g_EventSem);
456 RTThreadSleep(0);
457#endif
458 /* might return VINF_NAT_DNS */
459 return rc;
460 }
461 /* failure path */
462 slirp_term(pData->pNATState);
463 pData->pNATState = NULL;
464 }
465 else
466 {
467 PDMDRV_SET_ERROR(pDrvIns, rc, N_("Unknown error during NAT networking setup: "));
468 AssertMsgFailed(("Add error message for rc=%d (%Vrc)\n", rc, rc));
469 }
470#if 0
471 g_fThreadTerm = true;
472 RTSemEventSignal(g_EventSem);
473 RTThreadSleep(0);
474 }
475 RTSemEventDestroy(g_EventSem);
476 g_EventSem = NULL;
477 }
478#endif
479 RTCritSectDelete(&pData->CritSect);
480 return rc;
481}
482
483
484
485/**
486 * NAT network transport driver registration record.
487 */
488const PDMDRVREG g_DrvNAT =
489{
490 /* u32Version */
491 PDM_DRVREG_VERSION,
492 /* szDriverName */
493 "NAT",
494 /* pszDescription */
495 "NAT Network Transport Driver",
496 /* fFlags */
497 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
498 /* fClass. */
499 PDM_DRVREG_CLASS_NETWORK,
500 /* cMaxInstances */
501 16,
502 /* cbInstance */
503 sizeof(DRVNAT),
504 /* pfnConstruct */
505 drvNATConstruct,
506 /* pfnDestruct */
507 drvNATDestruct,
508 /* pfnIOCtl */
509 NULL,
510 /* pfnPowerOn */
511 NULL,
512 /* pfnReset */
513 NULL,
514 /* pfnSuspend */
515 NULL,
516 /* pfnResume */
517 NULL,
518 /* pfnDetach */
519 NULL,
520 /* pfnPowerOff */
521 NULL
522};
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