VirtualBox

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

Last change on this file since 5401 was 5332, checked in by vboxsync, 17 years ago

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