PDMNetShaper.cpp revision 1e1273b11e17928ec3c3a8fff45121aa7a169413
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * PDM Network Shaper - Limit network traffic according to bandwidth group settings.
c97989161fbe75bc14cea477a5443bbf474dd3advboxsync * Copyright (C) 2011-2013 Oracle Corporation
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * available from http://www.virtualbox.org. This file is free software;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * General Public License (GPL) as published by the Free Software
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/*******************************************************************************
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync* Header Files *
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync*******************************************************************************/
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/*******************************************************************************
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync* Structures and Typedefs *
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync*******************************************************************************/
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Network shaper data. One instance per VM.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef struct PDMNETSHAPER
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Pointer to the VM. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Critical section protecting all members below. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Pending TX thread. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Pointer to the first bandwidth group. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Takes the shaper lock (asserts but doesn't return or anything on
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * failure). */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#define LOCK_NETSHAPER(a_pShaper) do { int rcShaper = RTCritSectEnter(&(a_pShaper)->Lock); AssertRC(rcShaper); } while (0)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Takes the shaper lock, returns + asserts on failure. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync do { int rcShaper = RTCritSectEnter(&(a_pShaper)->Lock); AssertRCReturn(rcShaper, rcShaper); } while (0)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Releases the shaper lock (asserts on failure). */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#define UNLOCK_NETSHAPER(a_pShaper) do { int rcShaper = RTCritSectLeave(&(a_pShaper)->Lock); AssertRC(rcShaper); } while (0)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic PPDMNSBWGROUP pdmNsBwGroupFindById(PPDMNETSHAPER pShaper, const char *pszId)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic void pdmNsBwGroupLink(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic void pdmNsBwGroupUnlink(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic void pdmNsBwGroupSetLimit(PPDMNSBWGROUP pBwGroup, uint64_t cbPerSecMax)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync pBwGroup->cbBucket = RT_MAX(PDM_NETSHAPER_MIN_BUCKET_SIZE, cbPerSecMax * PDM_NETSHAPER_MAX_LATENCY / 1000);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync LogFlow(("pdmNsBwGroupSetLimit: New rate limit is %llu bytes per second, adjusted bucket size to %u bytes\n",
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic int pdmNsBwGroupCreate(PPDMNETSHAPER pShaper, const char *pszBwGroup, uint64_t cbPerSecMax)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync LogFlow(("pdmNsBwGroupCreate: pShaper=%#p pszBwGroup=%#p{%s} cbPerSecMax=%llu\n", pShaper, pszBwGroup, pszBwGroup, cbPerSecMax));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync AssertReturn(*pszBwGroup != '\0', VERR_INVALID_PARAMETER);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PPDMNSBWGROUP pBwGroup = pdmNsBwGroupFindById(pShaper, pszBwGroup);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = MMHyperAlloc(pShaper->pVM, sizeof(PDMNSBWGROUP), 64,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = PDMR3CritSectInit(pShaper->pVM, &pBwGroup->Lock, RT_SRC_POS, "BWGRP");
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync pBwGroup->pszNameR3 = MMR3HeapStrDup(pShaper->pVM, MM_TAG_PDM_NET_SHAPER, pszBwGroup);
aaeb2e2f6ed5b164f1dec9a16a7adeb84f64cf31vboxsyncstatic void pdmNsBwGroupTerminate(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLINLINE(void) pdmNsBwGroupRef(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncDECLINLINE(void) pdmNsBwGroupUnref(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic void pdmNsBwGroupXmitPending(PPDMNSBWGROUP pBwGroup)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * We don't need to hold the bandwidth group lock to iterate over the list
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * of filters since the filters are removed while the shaper lock is being
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync Assert(RTCritSectIsOwner(&pBwGroup->pShaperR3->Lock));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync //LOCK_NETSHAPER(pShaper);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Check if the group is disabled. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync bool fChoked = ASMAtomicXchgBool(&pFilter->fChoked, false);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync Log3((LOG_FN_FMT ": pFilter=%#p fChoked=%RTbool\n", __PRETTY_FUNCTION__, pFilter, fChoked));
19b725c530eb49600728765de7ed451cbe290740vboxsync LogFlowFunc(("Calling pfnXmitPending for pFilter=%#p\n", pFilter));
19b725c530eb49600728765de7ed451cbe290740vboxsync pFilter->pIDrvNetR3->pfnXmitPending(pFilter->pIDrvNetR3);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync //UNLOCK_NETSHAPER(pShaper);
19b725c530eb49600728765de7ed451cbe290740vboxsync int rc = PDMCritSectEnter(&pBwGroup->Lock, VERR_SEM_BUSY); AssertRC(rc);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = PDMCritSectLeave(&pBwGroup->Lock); AssertRC(rc);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * We need to make sure we hold the shaper lock since pdmNsBwGroupXmitPending()
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * does not hold the bandwidth group lock while iterating over the list
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * of group's filters.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync Assert(RTCritSectIsOwner(&pBwGroup->pShaperR3->Lock));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int rc = PDMCritSectEnter(&pBwGroup->Lock, VERR_SEM_BUSY); AssertRC(rc);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = PDMCritSectLeave(&pBwGroup->Lock); AssertRC(rc);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Attach network filter driver from bandwidth group.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pVM Handle of VM.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pDrvIns The driver instance.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszBwGroup Name of the bandwidth group to attach to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pFilter Pointer to the filter we attach.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVMMR3_INT_DECL(int) PDMR3NsAttach(PUVM pUVM, PPDMDRVINS pDrvIns, const char *pszBwGroup, PPDMNSFILTER pFilter)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync AssertReturn(pFilter->pBwGroupR3 == NULL, VERR_ALREADY_EXISTS);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync pBwGroupNew = pdmNsBwGroupFindById(pShaper, pszBwGroup);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PPDMNSBWGROUP pBwGroupOld = ASMAtomicXchgPtrT(&pFilter->pBwGroupR3, pBwGroupNew, PPDMNSBWGROUP);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ASMAtomicWritePtr(&pFilter->pBwGroupR0, MMHyperR3ToR0(pUVM->pVM, pBwGroupNew));
19b725c530eb49600728765de7ed451cbe290740vboxsync * Detach network filter driver from bandwidth group.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VBox status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pUVM The user mode VM handle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pDrvIns The driver instance.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pFilter Pointer to the filter we detach.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVMMR3_INT_DECL(int) PDMR3NsDetach(PUVM pUVM, PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Now, return quietly if the filter isn't attached since driver/device
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync destructors are called on constructor failure. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync AssertPtrReturn(pFilter->pBwGroupR3, VERR_INVALID_POINTER);
19b725c530eb49600728765de7ed451cbe290740vboxsync PPDMNSBWGROUP pBwGroup = ASMAtomicXchgPtrT(&pFilter->pBwGroupR3, NULL, PPDMNSBWGROUP);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Adjusts the maximum rate for the bandwidth group.
19b725c530eb49600728765de7ed451cbe290740vboxsync * @returns VBox status code.
19b725c530eb49600728765de7ed451cbe290740vboxsync * @param pUVM The user mode VM handle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszBwGroup Name of the bandwidth group to attach to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbPerSecMax Maximum number of bytes per second to be transmitted.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncVMMR3DECL(int) PDMR3NsBwGroupSetLimit(PUVM pUVM, const char *pszBwGroup, uint64_t cbPerSecMax)
19b725c530eb49600728765de7ed451cbe290740vboxsync UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PPDMNSBWGROUP pBwGroup = pdmNsBwGroupFindById(pShaper, pszBwGroup);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = PDMCritSectEnter(&pBwGroup->Lock, VERR_SEM_BUSY); AssertRC(rc);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Drop extra tokens */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int rc2 = PDMCritSectLeave(&pBwGroup->Lock); AssertRC(rc2);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * I/O thread for pending TX.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VINF_SUCCESS (ignored).
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pVM Pointer to the VM.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pThread The PDM thread data.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic DECLCALLBACK(int) pdmR3NsTxThread(PVM pVM, PPDMTHREAD pThread)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PPDMNETSHAPER pShaper = (PPDMNETSHAPER)pThread->pvUser;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync LogFlow(("pdmR3NsTxThread: pShaper=%p\n", pShaper));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync while (pThread->enmState == PDMTHREADSTATE_RUNNING)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Go over all bandwidth groups/filters calling pfnXmitPending */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @copydoc FNPDMTHREADWAKEUPINT
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncstatic DECLCALLBACK(int) pdmR3NsTxWakeUp(PVM pVM, PPDMTHREAD pThread)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PPDMNETSHAPER pShaper = (PPDMNETSHAPER)pThread->pvUser;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync LogFlow(("pdmR3NsTxWakeUp: pShaper=%p\n", pShaper));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Nothing to do */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Terminate the network shaper.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VBox error code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pVM Pointer to VM.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @remarks This method destroys all bandwidth group objects.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Destroy the bandwidth managers. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Initialize the network shaper.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VBox status code
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pVM Pointer to the VM.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync AssertMsgReturn(!pUVM->pdm.s.pNetShaper, ("Network shaper was already initialized\n"), VERR_WRONG_ORDER);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_NET_SHAPER, sizeof(PDMNETSHAPER), (void **)&pShaper);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PCFGMNODE pCfgNetShaper = CFGMR3GetChild(CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM"), "NetworkShaper");
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Create all bandwidth groups. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PCFGMNODE pCfgBwGrp = CFGMR3GetChild(pCfgNetShaper, "BwGroups");
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync for (PCFGMNODE pCur = CFGMR3GetFirstChild(pCfgBwGrp); pCur; pCur = CFGMR3GetNextChild(pCur))
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = pdmNsBwGroupCreate(pShaper, pszBwGrpId, cbMax);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync rc = PDMR3ThreadCreate(pVM, &pShaper->pTxThread, pShaper, pdmR3NsTxThread, pdmR3NsTxWakeUp,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync LogFlow(("pdmR3NetShaperInit: pVM=%p rc=%Rrc\n", pVM, rc));