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