Commit 8409abd5 authored by Phil Sutter's avatar Phil Sutter Committed by Stephen Hemminger

man: tc-police.8: Emphasize on the two rate control mechanisms

As Jamal pointed out, there are two different approaches to bandwidth
measurement. Try to make this clear by separating them in synopsis and
also documenting the way to fine-tune avrate.
Signed-off-by: default avatarPhil Sutter <phil@nwl.cc>
Signed-off-by: default avatarStephen Hemminger <stephen@networkplumber.org>
parent 26df2953
...@@ -12,13 +12,21 @@ police - policing action ...@@ -12,13 +12,21 @@ police - policing action
.IR BYTES [\fB/ BYTES "] ] [" .IR BYTES [\fB/ BYTES "] ] ["
.BI peakrate " RATE" .BI peakrate " RATE"
] [ ] [
.BI avrate " RATE"
] [
.BI overhead " BYTES" .BI overhead " BYTES"
] [ ] [
.BI linklayer " TYPE" .BI linklayer " TYPE"
] [ ] [
.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT\fR]" .IR CONTROL " ]"
.ti -8
.BR tc " ... " filter " ... [ " estimator
.IR "SAMPLE AVERAGE " ]
.BR "action police avrate"
.IR RATE " [ " CONTROL " ]"
.ti -8
.IR CONTROL " :="
.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT"
.ti -8 .ti -8
.IR EXCEEDACT " := { " .IR EXCEEDACT " := { "
...@@ -27,7 +35,14 @@ police - policing action ...@@ -27,7 +35,14 @@ police - policing action
The The
.B police .B police
action allows to limit bandwidth of traffic matched by the filter it is action allows to limit bandwidth of traffic matched by the filter it is
attached to. attached to. Basically there are two different algorithms available to measure
the packet rate: The first one uses an internal dual token bucket and is
configured using the
.BR rate ", " burst ", " mtu ", " peakrate ", " overhead " and " linklayer
parameters. The second one uses an in-kernel sampling mechanism. It can be
fine-tuned using the
.B estimator
filter parameter.
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI rate " RATE" .BI rate " RATE"
...@@ -73,6 +88,12 @@ cell sizes, for ...@@ -73,6 +88,12 @@ cell sizes, for
.B ethernet .B ethernet
no action is taken. no action is taken.
.TP .TP
.BI estimator " SAMPLE AVERAGE"
Fine-tune the in-kernel packet rate estimator.
.IR SAMPLE " and " AVERAGE
are time values and control the frequency in which samples are taken and over
what timespan an average is built.
.TP
.BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT\fR]" .BI conform-exceed " EXCEEDACT\fR[\fB/\fIEXCEEDACT\fR]"
Define how to handle packets which exceed (and, if the second Define how to handle packets which exceed (and, if the second
.I EXCEEDACT .I EXCEEDACT
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment