/** @file * * VBox network devices: * Linux/Win32 TUN network transport driver */ /* * Copyright (C) 2006-2007 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ /******************************************************************************* * Header Files * *******************************************************************************/ #define LOG_GROUP LOG_GROUP_DRV_TUN #include #include #include #include #include #include #include #include #include #include #include #include "Builtins.h" /******************************************************************************* * Structures and Typedefs * *******************************************************************************/ /** * Block driver instance data. */ typedef struct { /** The network interface. */ PDMINETWORKCONNECTOR INetworkConnector; /** The network interface. */ PPDMINETWORKPORT pPort; /** Pointer to the driver instance. */ PPDMDRVINS pDrvIns; /** TAP device file handle. */ HANDLE hFile; HANDLE hEventWrite; HANDLE hEventRead; OVERLAPPED overlappedRead; DWORD dwNumberOfBytesRead; uint8_t readBuffer[4096]; TAP_VERSION tapVersion; /** The thread handle. NIL_RTTHREAD if no thread. */ PPDMTHREAD pThread; /** The event semaphore the thread is waiting on. */ HANDLE hHaltAsyncEventSem; #ifdef DEBUG DWORD dwLastReadTime; DWORD dwLastWriteTime; #endif #ifdef VBOX_WITH_STATISTICS /** Number of sent packets. */ STAMCOUNTER StatPktSent; /** Number of sent bytes. */ STAMCOUNTER StatPktSentBytes; /** Number of received packets. */ STAMCOUNTER StatPktRecv; /** Number of received bytes. */ STAMCOUNTER StatPktRecvBytes; /** Profiling packet transmit runs. */ STAMPROFILEADV StatTransmit; /** Profiling packet receive runs. */ STAMPROFILEADV StatReceive; STAMPROFILE StatRecvOverflows; #endif /* VBOX_WITH_STATISTICS */ } DRVTAP, *PDRVTAP; /** Converts a pointer to TUN::INetworkConnector to a PRDVTUN. */ #define PDMINETWORKCONNECTOR_2_DRVTAP(pInterface) ( (PDRVTAP)((uintptr_t)pInterface - RT_OFFSETOF(DRVTAP, INetworkConnector)) ) /** * Send data to the network. * * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Data to send. * @param cb Number of bytes to send. * @thread EMT */ static DECLCALLBACK(int) drvTAPW32Send(PPDMINETWORKCONNECTOR pInterface, const void *pvBuf, size_t cb) { OVERLAPPED overlapped; DWORD cbBytesWritten; int rc; PDRVTAP pThis = PDMINETWORKCONNECTOR_2_DRVTAP(pInterface); Log2(("drvTAPW32Send%d: pvBuf=%p cb=%#x\n" "%.*Vhxd\n", pThis->pDrvIns->iInstance, pvBuf, cb, cb, pvBuf)); #ifdef DEBUG pThis->dwLastReadTime = timeGetTime(); Log(("drvTAPW32Send %d bytes at %08x - delta %x\n", cb, pThis->dwLastReadTime, pThis->dwLastReadTime - pThis->dwLastWriteTime)); #endif STAM_COUNTER_INC(&pThis->StatPktSent); STAM_COUNTER_ADD(&pThis->StatPktSentBytes, cb); STAM_PROFILE_ADV_START(&pThis->StatTransmit, a); memset(&overlapped, 0, sizeof(overlapped)); overlapped.hEvent = pThis->hEventWrite; rc = VINF_SUCCESS; if (WriteFile(pThis->hFile, pvBuf, cb, &cbBytesWritten, &overlapped) == FALSE) { if (GetLastError() == ERROR_IO_PENDING) { Log(("drvTAPW32Send: IO pending!!\n")); rc = WaitForSingleObject(overlapped.hEvent, INFINITE); AssertMsg(rc == WAIT_OBJECT_0, ("WaitForSingleObject failed with %x\n", rc)); rc = VINF_SUCCESS; } else { AssertMsgFailed(("WriteFile failed with %d\n", GetLastError())); rc = RTErrConvertFromWin32(GetLastError()); } } STAM_PROFILE_ADV_STOP(&pThis->StatTransmit, a); AssertRC(rc); return rc; } /** * Set promiscuous mode. * * This is called when the promiscuous mode is set. This means that there doesn't have * to be a mode change when it's called. * * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not. * @thread EMT */ static DECLCALLBACK(void) drvTAPW32SetPromiscuousMode(PPDMINETWORKCONNECTOR pInterface, bool fPromiscuous) { LogFlow(("drvTAPW32SetPromiscuousMode: fPromiscuous=%d\n", fPromiscuous)); /* nothing to do */ } /** * Notification on link status changes. * * @param pInterface Pointer to the interface structure containing the called function pointer. * @param enmLinkState The new link state. * @thread EMT */ static DECLCALLBACK(void) drvTAPW32NotifyLinkChanged(PPDMINETWORKCONNECTOR pInterface, PDMNETWORKLINKSTATE enmLinkState) { LogFlow(("drvNATW32NotifyLinkChanged: enmLinkState=%d\n", enmLinkState)); /** @todo take action on link down and up. Stop the polling and such like. */ } /** * Async I/O thread for an interface. */ static DECLCALLBACK(int) drvTAPW32AsyncIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread) { PDRVTAP pThis = PDMINS_2_DATA(pDrvIns, PDRVTAP); HANDLE haWait[2]; DWORD rc = ERROR_SUCCESS, dwNumberOfBytesTransferred; if (pThread->enmState == PDMTHREADSTATE_INITIALIZING) return VINF_SUCCESS; Assert(pThis); haWait[0] = pThis->hEventRead; haWait[1] = pThis->hHaltAsyncEventSem; while(1) { BOOL bRet; memset(&pThis->overlappedRead, 0, sizeof(pThis->overlappedRead)); pThis->overlappedRead.hEvent = pThis->hEventRead; bRet = ReadFile(pThis->hFile, pThis->readBuffer, sizeof(pThis->readBuffer), &dwNumberOfBytesTransferred, &pThis->overlappedRead); if (bRet == FALSE) { rc = GetLastError(); AssertMsg(rc == ERROR_IO_PENDING || rc == ERROR_MORE_DATA, ("ReadFile failed with rc=%d\n", rc)); if (rc != ERROR_IO_PENDING && rc != ERROR_MORE_DATA) break; rc = WaitForMultipleObjects(2, &haWait[0], FALSE, INFINITE); AssertMsg(rc == WAIT_OBJECT_0 || rc == WAIT_OBJECT_0+1, ("WaitForSingleObject failed with %x\n", rc)); if (rc != WAIT_OBJECT_0) break; /* asked to quit or fatal error. */ rc = GetOverlappedResult(pThis->hFile, &pThis->overlappedRead, &dwNumberOfBytesTransferred, FALSE); Assert(rc == TRUE); /* If GetOverlappedResult() returned with TRUE, the operation was finished successfully */ } /* * Wait for the device to have some room. A return code != VINF_SUCCESS * means that we were woken up during a VM state transition. Drop the * current packet and wait for the next one. */ rc = pThis->pPort->pfnWaitReceiveAvail(pThis->pPort, RT_INDEFINITE_WAIT); if (RT_FAILURE(rc)) continue; STAM_COUNTER_INC(&pThis->StatPktRecv); STAM_COUNTER_ADD(&pThis->StatPktRecvBytes, dwNumberOfBytesTransferred); #ifdef DEBUG pThis->dwLastWriteTime = timeGetTime(); Log(("drvTAPW32AsyncIo %d bytes at %08x - delta %x\n", dwNumberOfBytesTransferred, pThis->dwLastWriteTime, pThis->dwLastWriteTime - pThis->dwLastReadTime)); #endif rc = pThis->pPort->pfnReceive(pThis->pPort, pThis->readBuffer, dwNumberOfBytesTransferred); AssertRC(rc); } SetEvent(pThis->hHaltAsyncEventSem); Log(("drvTAPW32AsyncIo: exit thread!!\n")); return VINF_SUCCESS; } /** * Unblock the send thread so it can respond to a state change. * * @returns VBox status code. * @param pDevIns The pcnet device instance. * @param pThread The send thread. */ static DECLCALLBACK(int) drvTAPW32AsyncIoWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread) { PDRVTAP pThis = PDMINS_2_DATA(pDrvIns, PDRVTAP); /** @todo this isn't a safe method to notify the async thread; it might be using the instance * data after we've been destroyed; could wait for it to terminate, but that's not * without risks either. */ SetEvent(pThis->hHaltAsyncEventSem); /* Yield or else our async thread will never acquire the event semaphore */ RTThreadSleep(16); /* Wait for the async thread to quit; up to half a second */ WaitForSingleObject(pThis->hHaltAsyncEventSem, 500); return VINF_SUCCESS; } /** * Queries an interface to the driver. * * @returns Pointer to interface. * @returns NULL if the interface was not supported by the driver. * @param pInterface Pointer to this interface structure. * @param enmInterface The requested interface identification. * @thread Any thread. */ static DECLCALLBACK(void *) drvTAPW32QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface) { PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface); PDRVTAP pThis = PDMINS_2_DATA(pDrvIns, PDRVTAP); switch (enmInterface) { case PDMINTERFACE_BASE: return &pDrvIns->IBase; case PDMINTERFACE_NETWORK_CONNECTOR: return &pThis->INetworkConnector; default: return NULL; } } /** * Destruct a driver instance. * * Most VM resources are freed by the VM. This callback is provided so that any non-VM * resources can be freed correctly. * * @param pDrvIns The driver instance data. */ static DECLCALLBACK(void) drvTAPW32Destruct(PPDMDRVINS pDrvIns) { PDRVTAP pThis = PDMINS_2_DATA(pDrvIns, PDRVTAP); TAP_MEDIASTATUS mediastatus; DWORD dwLength; LogFlow(("drvTAPW32Destruct\n")); mediastatus.fConnect = FALSE; BOOL ret = DeviceIoControl(pThis->hFile, TAP_IOCTL_SET_MEDIA_STATUS, &mediastatus, sizeof(mediastatus), NULL, 0, &dwLength, NULL); Assert(ret); CloseHandle(pThis->hEventWrite); CancelIo(pThis->hFile); CloseHandle(pThis->hFile); } /** * Construct a TUN network transport driver instance. * * @returns VBox status. * @param pDrvIns The driver instance data. * If the registration structure is needed, pDrvIns->pDrvReg points to it. * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration * of the driver instance. It's also found in pDrvIns->pCfgHandle, but like * iInstance it's expected to be used a bit in this function. */ static DECLCALLBACK(int) drvTAPW32Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle) { PDRVTAP pThis = PDMINS_2_DATA(pDrvIns, PDRVTAP); /* * Init the static parts. */ pThis->pDrvIns = pDrvIns; pThis->hFile = INVALID_HANDLE_VALUE; /* IBase */ pDrvIns->IBase.pfnQueryInterface = drvTAPW32QueryInterface; /* INetwork */ pThis->INetworkConnector.pfnSend = drvTAPW32Send; pThis->INetworkConnector.pfnSetPromiscuousMode = drvTAPW32SetPromiscuousMode; pThis->INetworkConnector.pfnNotifyLinkChanged = drvTAPW32NotifyLinkChanged; /* * Validate the config. */ if (!CFGMR3AreValuesValid(pCfgHandle, "Device\0HostInterfaceName\0GUID\0")) return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES; /* * Check that no-one is attached to us. */ int rc = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, NULL); if (rc != VERR_PDM_NO_ATTACHED_DRIVER) return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRVINS_NO_ATTACH, N_("Configuration error: Cannot attach drivers to the TUN driver")); /* * Query the network port interface. */ pThis->pPort = (PPDMINETWORKPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_NETWORK_PORT); if (!pThis->pPort) return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_ABOVE, N_("Configuration error: the above device/driver didn't export the network port interface")); /* * Read the configuration. */ char *pszHostDriver = NULL; rc = CFGMR3QueryStringAlloc(pCfgHandle, "HostInterfaceName", &pszHostDriver); if (RT_FAILURE(rc)) return PDMDRV_SET_ERROR(pDrvIns, rc, N_("Configuration error: query for \"HostInterfaceName\" failed")); TAP_MEDIASTATUS mediastatus; DWORD length; char szFullDriverName[256]; char szDriverGUID[256] = {0}; rc = CFGMR3QueryBytes(pCfgHandle, "GUID", szDriverGUID, sizeof(szDriverGUID)); if (RT_FAILURE(rc)) return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES, N_("Configuration error: could not query GUID")); RTStrPrintfEx(NULL, NULL, szFullDriverName, sizeof(szFullDriverName), "\\\\.\\Global\\%s.tap", szDriverGUID); pThis->hFile = CreateFile(szFullDriverName, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, 0); if (pThis->hFile == INVALID_HANDLE_VALUE) { rc = GetLastError(); AssertMsgFailed(("Configuration error: TAP device name %s is not valid! (rc=%d)\n", szFullDriverName, rc)); if (rc == ERROR_SHARING_VIOLATION) return VERR_PDM_HIF_SHARING_VIOLATION; return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_HIF_OPEN_FAILED, N_("Failed to open Host Interface Networking device driver")); } BOOL ret = DeviceIoControl(pThis->hFile, TAP_IOCTL_GET_VERSION, &pThis->tapVersion, sizeof (pThis->tapVersion), &pThis->tapVersion, sizeof(pThis->tapVersion), &length, NULL); if (ret == FALSE) { CloseHandle(pThis->hFile); return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_HIF_INVALID_VERSION, N_("Failed to get the Host Interface Networking device driver version"));; } LogRel(("TAP version %d.%d\n", pThis->tapVersion.major, pThis->tapVersion.minor)); /* Must be at least version 8.1 */ if ( pThis->tapVersion.major != 8 || pThis->tapVersion.minor < 1) { CloseHandle(pThis->hFile); return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_HIF_INVALID_VERSION, N_("Invalid Host Interface Networking device driver version"));; } mediastatus.fConnect = TRUE; ret = DeviceIoControl(pThis->hFile, TAP_IOCTL_SET_MEDIA_STATUS, &mediastatus, sizeof(mediastatus), NULL, 0, &length, NULL); if (ret == FALSE) { CloseHandle(pThis->hFile); return VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES; } if (pszHostDriver) MMR3HeapFree(pszHostDriver); pThis->hEventWrite = CreateEvent(NULL, FALSE, FALSE, NULL); pThis->hEventRead = CreateEvent(NULL, FALSE, FALSE, NULL); memset(&pThis->overlappedRead, 0, sizeof(pThis->overlappedRead)); pThis->hHaltAsyncEventSem = CreateEvent(NULL, FALSE, FALSE, NULL); Assert(pThis->hHaltAsyncEventSem != NULL); /* Create asynchronous thread */ rc = PDMDrvHlpPDMThreadCreate(pDrvIns, &pThis->pThread, pThis, drvTAPW32AsyncIoThread, drvTAPW32AsyncIoWakeup, 128 * _1K, RTTHREADTYPE_IO, "TAP"); AssertRCReturn(rc, rc); #ifdef VBOX_WITH_STATISTICS /* * Statistics. */ PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatPktSent, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of sent packets.", "/Drivers/TAP%d/Packets/Sent", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatPktSentBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of sent bytes.", "/Drivers/TAP%d/Bytes/Sent", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatPktRecv, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of received packets.", "/Drivers/TAP%d/Packets/Received", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatPktRecvBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of received bytes.", "/Drivers/TAP%d/Bytes/Received", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatTransmit, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling packet transmit runs.", "/Drivers/TAP%d/Transmit", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReceive, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling packet receive runs.", "/Drivers/TAP%d/Receive", pDrvIns->iInstance); PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatRecvOverflows,STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_OCCURENCE, "Profiling packet receive overflows.", "/Drivers/TAP%d/RecvOverflows", pDrvIns->iInstance); #endif return rc; } /** * Host Interface network transport driver registration record. */ const PDMDRVREG g_DrvHostInterface = { /* u32Version */ PDM_DRVREG_VERSION, /* szDriverName */ "HostInterface", /* pszDescription */ "Host Interface Network Transport Driver", /* fFlags */ PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT, /* fClass. */ PDM_DRVREG_CLASS_NETWORK, /* cMaxInstances */ ~0, /* cbInstance */ sizeof(DRVTAP), /* pfnConstruct */ drvTAPW32Construct, /* pfnDestruct */ drvTAPW32Destruct, /* pfnIOCtl */ NULL, /* pfnPowerOn */ NULL, /* pfnReset */ NULL, /* pfnSuspend */ NULL, /* pfnResume */ NULL, /* pfnDetach */ NULL, /* pfnPowerOff */ NULL };