Blame SOURCES/0005-man-Clarify-idleslope-calculation-for-tc-cbs.patch

d8fb9e
From b8864890b18903936a68cda65ed1401703a2c67f Mon Sep 17 00:00:00 2001
d8fb9e
From: Andrea Claudi <aclaudi@redhat.com>
d8fb9e
Date: Tue, 21 Apr 2020 14:32:49 +0200
d8fb9e
Subject: [PATCH] man: Clarify idleslope calculation for tc-cbs
d8fb9e
d8fb9e
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1557461
d8fb9e
Upstream Status: iproute2.git commit 1915af404fdbf
d8fb9e
d8fb9e
commit 1915af404fdbfbfef915078cec57d7425f500dd2
d8fb9e
Author: Jesus Sanchez-Palencia <jesus.sanchez-palencia@intel.com>
d8fb9e
Date:   Fri Nov 10 14:34:36 2017 -0800
d8fb9e
d8fb9e
    man: Clarify idleslope calculation for tc-cbs
d8fb9e
d8fb9e
    In order to calculate the idleSlope parameter of CBS correctly, users
d8fb9e
    must take into account the entire packet size, including the overhead
d8fb9e
    from all layers.
d8fb9e
d8fb9e
    Add some more details to the man page to clarify that, giving one
d8fb9e
    simple example and pointing users to the correct 802.1Q section for
d8fb9e
    further clarifications if needed.
d8fb9e
d8fb9e
    Signed-off-by: Jesus Sanchez-Palencia <jesus.sanchez-palencia@intel.com>
d8fb9e
---
d8fb9e
 man/man8/tc-cbs.8 | 14 +++++++++++++-
d8fb9e
 1 file changed, 13 insertions(+), 1 deletion(-)
d8fb9e
d8fb9e
diff --git a/man/man8/tc-cbs.8 b/man/man8/tc-cbs.8
d8fb9e
index 97e00c84ded16..32e1e0d4089fb 100644
d8fb9e
--- a/man/man8/tc-cbs.8
d8fb9e
+++ b/man/man8/tc-cbs.8
d8fb9e
@@ -43,7 +43,19 @@ second) when there is at least one packet waiting for transmission.
d8fb9e
 Packets are transmitted when the current value of credits is equal or
d8fb9e
 greater than zero. When there is no packet to be transmitted the
d8fb9e
 amount of credits is set to zero. This is the main tunable of the CBS
d8fb9e
-algorithm.
d8fb9e
+algorithm and represents the bandwidth that will be consumed.
d8fb9e
+Note that when calculating idleslope, the entire packet size must be
d8fb9e
+considered, including headers from all layers (i.e. MAC framing and any
d8fb9e
+overhead from the physical layer), as described by IEEE 802.1Q-2014
d8fb9e
+section 34.4.
d8fb9e
+
d8fb9e
+As an example, for an ethernet frame carrying 284 bytes of payload,
d8fb9e
+and with no VLAN tags, you must add 14 bytes for the Ethernet headers,
d8fb9e
+4 bytes for the Frame check sequence (CRC), and 20 bytes for the L1
d8fb9e
+overhead: 12 bytes of interpacket gap, 7 bytes of preamble and 1 byte
d8fb9e
+of start of frame delimiter. That results in 322 bytes for the total
d8fb9e
+packet size, which is then used for calculating the idleslope.
d8fb9e
+
d8fb9e
 .TP
d8fb9e
 sendslope
d8fb9e
 Sendslope is the rate of credits that is depleted (it should be a
d8fb9e
-- 
d8fb9e
2.25.3
d8fb9e