|
 |
049c96 |
From 6bfb1788b2986d5d2dde9bc6dd941234c2076ae5 Mon Sep 17 00:00:00 2001
|
|
|
049c96 |
From: Phil Sutter <psutter@redhat.com>
|
|
|
049c96 |
Date: Wed, 30 Mar 2016 16:51:09 +0200
|
|
|
049c96 |
Subject: [PATCH] man: tc-police.8: Emphasize on the two rate control
|
|
|
049c96 |
mechanisms
|
|
|
049c96 |
|
|
|
049c96 |
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1275426
|
|
|
049c96 |
Upstream Status: iproute2.git commit 8409abd59bbc8
|
|
|
049c96 |
|
|
|
049c96 |
commit 8409abd59bbc8a79689be25ab3a385c65d1334bd
|
|
|
049c96 |
Author: Phil Sutter <phil@nwl.cc>
|
|
|
049c96 |
Date: Tue Mar 22 15:48:36 2016 +0100
|
|
|
049c96 |
|
|
|
049c96 |
man: tc-police.8: Emphasize on the two rate control mechanisms
|
|
|
049c96 |
|
|
|
049c96 |
As Jamal pointed out, there are two different approaches to bandwidth
|
|
|
049c96 |
measurement. Try to make this clear by separating them in synopsis and
|
|
|
049c96 |
also documenting the way to fine-tune avrate.
|
|
|
049c96 |
|
|
|
049c96 |
Signed-off-by: Phil Sutter <phil@nwl.cc>
|
|
|
049c96 |
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
|
|
|
049c96 |
---
|
|
|
049c96 |
man/man8/tc-police.8 | 29 +++++++++++++++++++++++++----
|
|
|
049c96 |
1 file changed, 25 insertions(+), 4 deletions(-)
|
|
|
049c96 |
|
|
|
049c96 |
diff --git a/man/man8/tc-police.8 b/man/man8/tc-police.8
|
|
|
049c96 |
index 2b1537e..5c5a632 100644
|
|
|
049c96 |
--- a/man/man8/tc-police.8
|
|
|
049c96 |
+++ b/man/man8/tc-police.8
|
|
|
049c96 |
@@ -12,13 +12,21 @@ police - policing action
|
|
|
049c96 |
.IR BYTES [\fB/ BYTES "] ] ["
|
|
|
049c96 |
.BI peakrate " RATE"
|
|
|
049c96 |
] [
|
|
|
049c96 |
-.BI avrate " RATE"
|
|
|
049c96 |
-] [
|
|
|
049c96 |
.BI overhead " BYTES"
|
|
|
049c96 |
] [
|
|
|
049c96 |
.BI linklayer " TYPE"
|
|
|
049c96 |
] [
|
|
|
049c96 |
-.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT\fR]"
|
|
|
049c96 |
+.IR CONTROL " ]"
|
|
|
049c96 |
+
|
|
|
049c96 |
+.ti -8
|
|
|
049c96 |
+.BR tc " ... " filter " ... [ " estimator
|
|
|
049c96 |
+.IR "SAMPLE AVERAGE " ]
|
|
|
049c96 |
+.BR "action police avrate"
|
|
|
049c96 |
+.IR RATE " [ " CONTROL " ]"
|
|
|
049c96 |
+
|
|
|
049c96 |
+.ti -8
|
|
|
049c96 |
+.IR CONTROL " :="
|
|
|
049c96 |
+.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT"
|
|
|
049c96 |
|
|
|
049c96 |
.ti -8
|
|
|
049c96 |
.IR EXCEEDACT " := { "
|
|
|
049c96 |
@@ -27,7 +35,14 @@ police - policing action
|
|
|
049c96 |
The
|
|
|
049c96 |
.B police
|
|
|
049c96 |
action allows to limit bandwidth of traffic matched by the filter it is
|
|
|
049c96 |
-attached to.
|
|
|
049c96 |
+attached to. Basically there are two different algorithms available to measure
|
|
|
049c96 |
+the packet rate: The first one uses an internal dual token bucket and is
|
|
|
049c96 |
+configured using the
|
|
|
049c96 |
+.BR rate ", " burst ", " mtu ", " peakrate ", " overhead " and " linklayer
|
|
|
049c96 |
+parameters. The second one uses an in-kernel sampling mechanism. It can be
|
|
|
049c96 |
+fine-tuned using the
|
|
|
049c96 |
+.B estimator
|
|
|
049c96 |
+filter parameter.
|
|
|
049c96 |
.SH OPTIONS
|
|
|
049c96 |
.TP
|
|
|
049c96 |
.BI rate " RATE"
|
|
|
049c96 |
@@ -73,6 +88,12 @@ cell sizes, for
|
|
|
049c96 |
.B ethernet
|
|
|
049c96 |
no action is taken.
|
|
|
049c96 |
.TP
|
|
|
049c96 |
+.BI estimator " SAMPLE AVERAGE"
|
|
|
049c96 |
+Fine-tune the in-kernel packet rate estimator.
|
|
|
049c96 |
+.IR SAMPLE " and " AVERAGE
|
|
|
049c96 |
+are time values and control the frequency in which samples are taken and over
|
|
|
049c96 |
+what timespan an average is built.
|
|
|
049c96 |
+.TP
|
|
|
049c96 |
.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT\fR]"
|
|
|
049c96 |
Define how to handle packets which exceed (and, if the second
|
|
|
049c96 |
.I EXCEEDACT
|
|
|
049c96 |
--
|
|
|
049c96 |
1.8.3.1
|
|
|
049c96 |
|