DrvTAPWin.cpp revision 0abd77741a608f6c41c8dfcd4781b8b84adf1044
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * VBox network devices:
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Linux/Win32 TUN network transport driver
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * available from http://www.virtualbox.org. This file is free software;
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * you can redistribute it and/or modify it under the terms of the GNU
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * General Public License (GPL) as published by the Free Software
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * additional information or have any questions.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync/*******************************************************************************
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync* Header Files *
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync*******************************************************************************/
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync/*******************************************************************************
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync* Structures and Typedefs *
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync*******************************************************************************/
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Block driver instance data.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsynctypedef struct
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The network interface. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The network interface. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Pointer to the driver instance. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** TAP device file handle. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The thread handle. NIL_RTTHREAD if no thread. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** The event semaphore the thread is waiting on. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Number of sent packets. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Number of sent bytes. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Number of received packets. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Number of received bytes. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Profiling packet transmit runs. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync /** Profiling packet receive runs. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync#endif /* VBOX_WITH_STATISTICS */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync/** Converts a pointer to TUN::INetworkConnector to a PRDVTUN. */
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync#define PDMINETWORKCONNECTOR_2_DRVTAP(pInterface) ( (PDRVTAP)((uintptr_t)pInterface - RT_OFFSETOF(DRVTAP, INetworkConnector)) )
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * Send data to the network.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @returns VBox status code.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param pvBuf Data to send.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @param cb Number of bytes to send.
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync * @thread EMT
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsyncstatic DECLCALLBACK(int) drvTAPW32Send(PPDMINETWORKCONNECTOR pInterface, const void *pvBuf, size_t cb)
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync PDRVTAP pData = PDMINETWORKCONNECTOR_2_DRVTAP(pInterface);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync "%.*Vhxd\n", pData->pDrvIns->iInstance, pvBuf, cb, cb, pvBuf));
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync Log(("drvTAPW32Send %d bytes at %08x - delta %x\n", cb, pData->dwLastReadTime, pData->dwLastReadTime - pData->dwLastWriteTime));
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync if (WriteFile(pData->hFile, pvBuf, cb, &cbBytesWritten, &overlapped) == FALSE)
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync rc = WaitForSingleObject(overlapped.hEvent, INFINITE);
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync AssertMsg(rc == WAIT_OBJECT_0, ("WaitForSingleObject failed with %x\n", rc));
6fea4abcc6ee0f2797ac01ef79c374d506aedc02vboxsync AssertMsgFailed(("WriteFile failed with %d\n", GetLastError()));
static DECLCALLBACK(void) drvTAPW32SetPromiscuousMode(PPDMINETWORKCONNECTOR pInterface, bool fPromiscuous)
static DECLCALLBACK(void) drvTAPW32NotifyLinkChanged(PPDMINETWORKCONNECTOR pInterface, PDMNETWORKLINKSTATE enmLinkState)
return VINF_SUCCESS;
AssertMsg(rc == WAIT_OBJECT_0 || rc == WAIT_OBJECT_0+1, ("WaitForSingleObject failed with %x\n", rc));
#ifdef DEBUG
return VINF_SUCCESS;
return VINF_SUCCESS;
static DECLCALLBACK(void *) drvTAPW32QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
switch (enmInterface)
case PDMINTERFACE_BASE:
return NULL;
pData->pPort = (PPDMINETWORKPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_NETWORK_PORT);
RTStrPrintfEx(NULL, NULL, szFullDriverName, sizeof(szFullDriverName), "\\\\.\\Global\\%s.tap", szDriverGUID);
AssertMsgFailed(("Configuration error: TAP device name %s is not valid! (rc=%d)\n", szFullDriverName, rc));
return VERR_PDM_HIF_SHARING_VIOLATION;
BOOL ret = DeviceIoControl(pData->hFile, TAP_IOCTL_GET_VERSION, &pData->tapVersion, sizeof (pData->tapVersion),
ret = DeviceIoControl(pData->hFile, TAP_IOCTL_SET_MEDIA_STATUS, &mediastatus, sizeof(mediastatus), NULL, 0, &length, NULL);
if (pszHostDriver)
rc = PDMDrvHlpPDMThreadCreate(pDrvIns, &pData->pThread, pData, drvTAPW32AsyncIoThread, drvTAPW32AsyncIoWakeup, 128 * _1K, RTTHREADTYPE_IO, "TAP");
#ifdef VBOX_WITH_STATISTICS
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatPktSent, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of sent packets.", "/Drivers/TAP%d/Packets/Sent", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatPktSentBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of sent bytes.", "/Drivers/TAP%d/Bytes/Sent", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatPktRecv, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of received packets.", "/Drivers/TAP%d/Packets/Received", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatPktRecvBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of received bytes.", "/Drivers/TAP%d/Bytes/Received", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatTransmit, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling packet transmit runs.", "/Drivers/TAP%d/Transmit", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatReceive, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling packet receive runs.", "/Drivers/TAP%d/Receive", pDrvIns->iInstance);
PDMDrvHlpSTAMRegisterF(pDrvIns, &pData->StatRecvOverflows,STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_OCCURENCE, "Profiling packet receive overflows.", "/Drivers/TAP%d/RecvOverflows", pDrvIns->iInstance);
return rc;
sizeof(DRVTAP),
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,