DrvNetShaper.cpp revision 1e1273b11e17928ec3c3a8fff45121aa7a169413
/* $Id$ */
/** @file
* NetShaperFilter - Network shaper filter driver.
*/
/*
* Copyright (C) 2011-2013 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP LOG_GROUP_NET_SHAPER
#include <iprt/critsect.h>
#include "VBoxDD.h"
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/**
* Block driver instance data.
*
* @implements PDMINETWORKUP
* @implements PDMINETWORKDOWN
* @implements PDMINETWORKCONFIG
*/
typedef struct DRVNETSHAPER
{
/** Pointer to the driver instance. */
/** The network interface. */
/** The connector that's attached to us. */
/** Pointer to the driver instance. */
/** The network interface. */
/** The connector that's attached to us. */
/** Ring-3 base interface for the ring-0 context. */
/** Ring-3 base interface for the raw-mode context. */
/** For when we're the leaf driver. */
/** The network interface. */
/** The network config interface.
* @todo this is a main interface and shouldn't be here... */
/** The port we're attached to. */
/** The config port interface we're attached to. */
/** The filter that represents us at bandwidth group. */
/** The name of bandwidth group we are attached to. */
char * pszBwGroup;
/** TX: Total number of bytes to allocate. */
/** TX: Number of bytes delayed. */
/** TX: Number of bytes allowed to pass. */
/** TX: Total number of packets being sent. */
/** TX: Number of packets delayed. */
/** TX: Number of packets allowed to pass. */
/** TX: Number of calls to pfnXmitPending. */
/**
* @interface_method_impl{PDMINETWORKUP,pfnBeginXmit}
*/
{
{
rc = VERR_TRY_AGAIN;
return rc;
}
}
/**
* @interface_method_impl{PDMINETWORKUP,pfnAllocBuf}
*/
{
return VERR_NET_DOWN;
//LogFlow(("drvNetShaperUp_AllocBuf: cb=%d\n", cbMin));
{
return VERR_TRY_AGAIN;
}
#endif
//LogFlow(("drvNetShaperUp_AllocBuf: got cb=%d\n", cbMin));
}
/**
* @interface_method_impl{PDMINETWORKUP,pfnFreeBuf}
*/
{
return VERR_NET_DOWN;
}
/**
* @interface_method_impl{PDMINETWORKUP,pfnSendBuf}
*/
PDMBOTHCBDECL(int) drvNetShaperUp_SendBuf(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread)
{
return VERR_NET_DOWN;
return pThis->CTX_SUFF(pIBelowNet)->pfnSendBuf(pThis->CTX_SUFF(pIBelowNet), pSgBuf, fOnWorkerThread);
}
/**
* @interface_method_impl{PDMINETWORKUP,pfnEndXmit}
*/
{
//LogFlow(("drvNetShaperUp_EndXmit:\n"));
else
}
/**
* @interface_method_impl{PDMINETWORKUP,pfnSetPromiscuousMode}
*/
{
}
#ifdef IN_RING3
/**
* @interface_method_impl{PDMINETWORKUP,pfnNotifyLinkChanged}
*/
static DECLCALLBACK(void) drvR3NetShaperUp_NotifyLinkChanged(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState)
{
if (pThis->pIBelowNetR3)
}
/**
* @interface_method_impl{PDMINETWORKDOWN,pfnWaitReceiveAvail}
*/
static DECLCALLBACK(int) drvR3NetShaperDown_WaitReceiveAvail(PPDMINETWORKDOWN pInterface, RTMSINTERVAL cMillies)
{
}
/**
* @interface_method_impl{PDMINETWORKDOWN,pfnReceive}
*/
static DECLCALLBACK(int) drvR3NetShaperDown_Receive(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb)
{
}
/**
* @interface_method_impl{PDMINETWORKDOWN,pfnReceiveGso}
*/
static DECLCALLBACK(int) drvR3NetShaperDown_ReceiveGso(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb, PCPDMNETWORKGSO pGso)
{
return VERR_NOT_SUPPORTED;
}
/**
* @interface_method_impl{PDMINETWORKDOWN,pfnXmitPending}
*/
{
}
/**
* Gets the current Media Access Control (MAC) address.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pMac Where to store the MAC address.
* @thread EMT
*/
{
}
/**
* Gets the new link state.
*
* @returns The current link state.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread EMT
*/
static DECLCALLBACK(PDMNETWORKLINKSTATE) drvR3NetShaperDownCfg_GetLinkState(PPDMINETWORKCONFIG pInterface)
{
}
/**
* Sets the new link state.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param enmState The new link state
* @thread EMT
*/
static DECLCALLBACK(int) drvR3NetShaperDownCfg_SetLinkState(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState)
{
}
/**
* @interface_method_impl{PDMIBASER0,pfnQueryInterface}
*/
static DECLCALLBACK(RTR0PTR) drvR3NetShaperIBaseR0_QueryInterface(PPDMIBASER0 pInterface, const char *pszIID)
{
return NIL_RTR0PTR;
}
/**
* @interface_method_impl{PDMIBASERC,pfnQueryInterface}
*/
static DECLCALLBACK(RTRCPTR) drvR3NetShaperIBaseRC_QueryInterface(PPDMIBASERC pInterface, const char *pszIID)
{
return NIL_RTRCPTR;
}
/**
* @interface_method_impl{PDMIBASE,pfnQueryInterface}
*/
static DECLCALLBACK(void *) drvR3NetShaperIBase_QueryInterface(PPDMIBASE pInterface, const char *pszIID)
{
return NULL;
}
/**
* @interface_method_impl{PDMDRVREG,pfnDetach}
*/
{
}
/**
* @interface_method_impl{PDMDRVREG,pfnAttach}
*/
{
/*
* Query the network connector interface.
*/
if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
{
rc = VINF_SUCCESS;
}
else if (RT_SUCCESS(rc))
{
if (pThis->pIBelowNetR3)
{
pThis->pIBelowNetR0 = pBaseR0 ? pBaseR0->pfnQueryInterface(pBaseR0, PDMINETWORKUP_IID) : NIL_RTR0PTR;
rc = VINF_SUCCESS;
}
else
{
AssertMsgFailed(("Configuration error: the driver below didn't export the network connector interface!\n"));
}
}
else
return VINF_SUCCESS;
}
/**
* @interface_method_impl{PDMDRVREG,pfnDestruct}
*/
{
}
/**
* @interface_method_impl{Construct a NAT network transport driver instance,
* PDMDRVREG,pfnDestruct}
*/
static DECLCALLBACK(int) drvR3NetShaperConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
{
LogFlow(("drvNetShaperConstruct:\n"));
/*
* Init the static parts.
*/
/* IBase */
/* INetworkUp */
/* Resolve the ring-0 context interface addresses. */
sizeof(pThis->INetworkUpR0),
"drvNetShaperUp_", PDMINETWORKUP_SYM_LIST);
/* INetworkDown */
/* INetworkConfig */
/*
* Create the locks.
*/
/*
* Validate the config.
*/
/*
* Find the bandwidth group we have to attach to.
*/
{
N_("DrvNetShaper: Configuration error: Querying \"BwGroup\" as string failed"));
return rc;
}
else
rc = VINF_SUCCESS;
if (RT_FAILURE(rc))
{
N_("DrvNetShaper: Configuration error: Failed to attach to bandwidth group"));
return rc;
}
/*
* Query the network port interface.
*/
if (!pThis->pIAboveNet)
{
AssertMsgFailed(("Configuration error: the above device/driver didn't export the network port interface!\n"));
return VERR_PDM_MISSING_INTERFACE_ABOVE;
}
/*
* Query the network config interface.
*/
if (!pThis->pIAboveConfig)
{
AssertMsgFailed(("Configuration error: the above device/driver didn't export the network config interface!\n"));
return VERR_PDM_MISSING_INTERFACE_ABOVE;
}
/*
* Query the network connector interface.
*/
if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
{
}
else if (RT_SUCCESS(rc))
{
if (!pThis->pIBelowNetR3)
{
AssertMsgFailed(("Configuration error: the driver below didn't export the network connector interface!\n"));
return VERR_PDM_MISSING_INTERFACE_BELOW;
}
pThis->pIBelowNetR0 = pBaseR0 ? pBaseR0->pfnQueryInterface(pBaseR0, PDMINETWORKUP_IID) : NIL_RTR0PTR;
}
else
{
return rc;
}
/*
* Register statistics.
*/
PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->StatXmitBytesRequested, "Bytes/Tx/Requested", STAMUNIT_BYTES, "Number of requested TX bytes.");
PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->StatXmitBytesDenied, "Bytes/Tx/Denied", STAMUNIT_BYTES, "Number of denied TX bytes.");
PDMDrvHlpSTAMRegCounterEx(pDrvIns, &pThis->StatXmitBytesGranted, "Bytes/Tx/Granted", STAMUNIT_BYTES, "Number of granted TX bytes.");
PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitPktsRequested, "Packets/Tx/Requested", "Number of requested TX packets.");
PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitPktsDenied, "Packets/Tx/Denied", "Number of denied TX packets.");
PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitPktsGranted, "Packets/Tx/Granted", "Number of granted TX packets.");
PDMDrvHlpSTAMRegCounter(pDrvIns, &pThis->StatXmitPendingCalled, "Tx/WakeUp", "Number of wakeup TX calls.");
return VINF_SUCCESS;
}
/**
* Network sniffer filter driver registration record.
*/
const PDMDRVREG g_DrvNetShaper =
{
/* u32Version */
/* szName */
"NetShaper",
/* szRCMod */
"",
/* szR0Mod */
"VBoxDDR0.r0",
/* pszDescription */
"Network Shaper Filter Driver",
/* fFlags */
/* fClass. */
/* cMaxInstances */
/* cbInstance */
sizeof(DRVNETSHAPER),
/* pfnConstruct */
/* pfnDestruct */
/* pfnRelocate */
NULL,
/* pfnIOCtl */
NULL,
/* pfnPowerOn */
NULL,
/* pfnReset */
NULL,
/* pfnSuspend */
NULL,
/* pfnResume */
NULL,
/* pfnAttach */
/* pfnDetach */
/* pfnPowerOff */
NULL,
/* pfnSoftReset */
NULL,
/* u32EndVersion */
};
#endif /* IN_RING3 */