PDMNetShaper.cpp revision b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * PDM Network Shaper - Limit network traffic according to bandwidth
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * group settings.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * Copyright (C) 2006-2012 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 * Bandwidth group instance data
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsynctypedef struct PDMNSBWGROUP
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Pointer to the next group in the list. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Pointer to the shared UVM structure. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Critical section protecting all members below. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Pointer to the first filter attached to this group. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Bandwidth group name. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Maximum number of bytes filters are allowed to transfer. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Number of bytes we are allowed to transfer in one burst. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Number of bytes we were allowed to transfer at the last update. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Timestamp of the last update */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Reference counter - How many filters are associated with this group. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/** Pointer to a bandwidth group. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * Network shaper data. One instance per VM.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsynctypedef struct PDMNETSHAPER
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Pointer to the shared VM structure. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Critical section protecting all members below. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /** Pointer to the first bandwidth group. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/*******************************************************************************
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync* Internal Functions *
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync*******************************************************************************/
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncstatic PPDMNSBWGROUP pdmNsBwGroupFindById(PPDMNETSHAPER pShaper, const char *pcszId)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pShaper->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncstatic void pdmNsBwGroupLink(PPDMNSBWGROUP pBwGroup)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pShaper->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncstatic void pdmNsBwGroupUnlink(PPDMNSBWGROUP pBwGroup)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pShaper->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncstatic int pdmNsBwGroupCreate(PPDMNETSHAPER pShaper, const char *pcszBwGroup, uint32_t cbTransferPerSecMax)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync LogFlowFunc(("pShaper=%#p pcszBwGroup=%#p{%s} cbTransferPerSecMax=%u\n",
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pShaper, pcszBwGroup, pcszBwGroup, cbTransferPerSecMax));
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync AssertPtrReturn(pcszBwGroup, VERR_INVALID_POINTER);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync AssertReturn(*pcszBwGroup != '\0', VERR_INVALID_PARAMETER);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync PPDMNSBWGROUP pBwGroup = pdmNsBwGroupFindById(pShaper, pcszBwGroup);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync rc = MMR3HeapAllocZEx(pShaper->pVM, MM_TAG_PDM_NET_SHAPER,
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroup->cbTransferPerSecMax = cbTransferPerSecMax;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroup->cbBucketSize = RT_MAX(PDM_NETSHAPER_MIN_BUCKET_SIZE,
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync cbTransferPerSecMax * PDM_NETSHAPER_MAX_LATENCY / 1000);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncstatic void pdmNsBwGroupTerminate(PPDMNSBWGROUP pBwGroup)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncDECLINLINE(void) pdmNsBwGroupRef(PPDMNSBWGROUP pBwGroup)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncDECLINLINE(void) pdmNsBwGroupUnref(PPDMNSBWGROUP pBwGroup)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pBwGroup->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pBwGroup->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncVMMR3DECL(int) PDMR3NsAttach(PVM pVM, PPDMDRVINS pDrvIns, const char *pcszBwGroup,
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync AssertReturn(pFilter->pBwGroupR3 == NULL, VERR_ALREADY_EXISTS);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pShaper->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroupNew = pdmNsBwGroupFindById(pShaper, pcszBwGroup);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroupOld = ASMAtomicXchgPtrT(&pFilter->pBwGroupR3, pBwGroupNew, PPDMNSBWGROUP);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc2 = RTCritSectLeave(&pShaper->cs); AssertRC(rc2);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncVMMR3DECL(int) PDMR3NsDetach(PVM pVM, PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync AssertPtrReturn(pFilter->pBwGroupR3, VERR_INVALID_POINTER);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pShaper->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroup = ASMAtomicXchgPtrT(&pFilter->pBwGroupR3, NULL, PPDMNSBWGROUP);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc2 = RTCritSectLeave(&pShaper->cs); AssertRC(rc2);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncbool PDMR3NsAllocateBandwidth(PPDMNSFILTER pFilter, uint32_t cbTransfer)
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync return true;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync PPDMNSBWGROUP pBwGroup = ASMAtomicReadPtrT(&pFilter->pBwGroupR3, PPDMNSBWGROUP);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = RTCritSectEnter(&pBwGroup->cs); AssertRC(rc);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync bool fAllowed = true;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /* Re-fill the bucket first */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync uint32_t uTokensAdded = (tsNow - pBwGroup->tsUpdatedLast)*pBwGroup->cbTransferPerSecMax/(1000*1000*1000);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync uint32_t uTokens = RT_MIN(pBwGroup->cbBucketSize, uTokensAdded + pBwGroup->cbTokensLast);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync LogFlowFunc(("BwGroup=%#p{%s} cbTransfer=%u uTokens=%u uTokensAdded=%u fAllowed=%RTbool\n",
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync pBwGroup, pBwGroup->pszName, cbTransfer, uTokens, uTokensAdded, fAllowed));
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync return true; // @todo: i need to implement TX thread first! return fAllowed;
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
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * @param pVM Pointer to the shared VM structure.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync int rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_NET_SHAPER,
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync PCFGMNODE pCfgNetShaper = CFGMR3GetChild(CFGMR3GetChild(pCfgRoot, "PDM"), "NetworkShaper");
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync /* Create all bandwidth groups. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync PCFGMNODE pCfgBwGrp = CFGMR3GetChild(pCfgNetShaper, "BwGroups");
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync for (PCFGMNODE pCur = CFGMR3GetFirstChild(pCfgBwGrp); pCur; pCur = CFGMR3GetNextChild(pCur))
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync rc = pdmNsBwGroupCreate(pNetShaper, pszBwGrpId, cbMax);
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync ("Network shaper was already initialized\n"));