b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/** @file
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * PDM - Pluggable Device Manager, Network Shaper.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/*
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2011-2013 Oracle Corporation
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync *
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 * The contents of this file may alternatively be used under the terms
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * of the Common Development and Distribution License Version 1.0
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * VirtualBox OSE distribution, in which case the provisions of the
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * CDDL are applicable instead of those of the GPL.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync *
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * You may elect to license modified versions of this file under the
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync * terms and conditions of either the GPL or the CDDL or both.
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#ifndef ___VBox_vmm_pdmnetshaper_h
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#define ___VBox_vmm_pdmnetshaper_h
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#include <VBox/types.h>
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#include <VBox/err.h>
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#include <VBox/vmm/pdmnetifs.h>
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#include <iprt/assert.h>
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#include <iprt/sg.h>
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync/** @defgroup grp_pdm_net_shaper The PDM Network Shaper API
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync * @ingroup grp_pdm
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync * @{
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync#define PDM_NETSHAPER_MIN_BUCKET_SIZE UINT32_C(65536) /**< bytes */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync#define PDM_NETSHAPER_MAX_LATENCY UINT32_C(100) /**< milliseconds */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncRT_C_DECLS_BEGIN
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsynctypedef struct PDMNSFILTER
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync{
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** Pointer to the next group in the list (ring-3). */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync R3PTRTYPE(struct PDMNSFILTER *) pNextR3;
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** Pointer to the bandwidth group (ring-3). */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync R3PTRTYPE(struct PDMNSBWGROUP *) pBwGroupR3;
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** Pointer to the bandwidth group (ring-0). */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync R0PTRTYPE(struct PDMNSBWGROUP *) pBwGroupR0;
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** Set when the filter fails to obtain bandwidth. */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync bool fChoked;
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** Aligment padding. */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync bool afPadding[HC_ARCH_BITS == 32 ? 3 : 7];
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync /** The driver this filter is aggregated into (ring-3). */
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsync R3PTRTYPE(PPDMINETWORKDOWN) pIDrvNetR3;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync} PDMNSFILTER;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/** Pointer to a PDM filter handle. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsynctypedef struct PDMNSFILTER *PPDMNSFILTER;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/** Pointer to a network shaper. */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsynctypedef struct PDMNETSHAPER *PPDMNETSHAPER;
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsyncVMMDECL(bool) PDMNsAllocateBandwidth(PPDMNSFILTER pFilter, size_t cbTransfer);
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsyncVMMR3_INT_DECL(int) PDMR3NsAttach(PUVM pUVM, PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter);
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsyncVMMR3_INT_DECL(int) PDMR3NsDetach(PUVM pUVM, PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter);
cdc4c218c2bf31f90badfd20b1c185946a7e412evboxsyncVMMR3DECL(int) PDMR3NsBwGroupSetLimit(PUVM pUVM, const char *pszBwGroup, uint64_t cbPerSecMax);
0247b3970a16ddb81e15bfd8ff8a4eb9747595ccvboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync/** @} */
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsyncRT_C_DECLS_END
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync#endif
b0af0b78d25ede09c0d23b2be9163cf43c7ca6f8vboxsync