tc: Add missing documentation for codel and fq_codel parameters

Add missing documentation of the memory_limit fq_codel parameter and the
ce_threshold codel and fq_codel parameters.

Signed-off-by: Toke Høiland-Jørgensen <toke@toke.dk>
Signed-off-by: David Ahern <dsahern@gmail.com>
This commit is contained in:
Toke Høiland-Jørgensen 2018-03-08 23:31:36 +01:00 committed by David Ahern
parent fb4e6abfca
commit d7d044ff53
3 changed files with 27 additions and 2 deletions

View File

@ -13,7 +13,9 @@ TIME ] [
.B ecn
|
.B noecn
]
] [
.B ce_threshold
TIME ]
.SH DESCRIPTION
CoDel (pronounced "coddle") is an adaptive "no-knobs" active queue management
@ -80,6 +82,12 @@ can be used to turn it off and vice-a-versa. By default,
.B ecn
is turned off.
.SS ce_threshold
sets a threshold above which all packets are marked with ECN Congestion
Experienced. This is useful for DCTCP-style congestion control algorithms that
require marking at very shallow queueing thresholds.
.SH EXAMPLES
# tc qdisc add dev eth0 root codel
# tc -s qdisc show

View File

@ -17,7 +17,11 @@ BYTES ] [
.B ecn
|
.B noecn
]
] [
.B ce_threshold
TIME ] [
.B memory_limit
BYTES ]
.SH DESCRIPTION
FQ_Codel (Fair Queuing Controlled Delay) is queuing discipline that combines Fair
@ -35,6 +39,13 @@ and is the hard limit on the real queue size.
When this limit is reached, incoming packets are dropped. Default is 10240
packets.
.SS memory_limit
sets a limit on the total number of bytes that can be queued in this FQ-CoDel
instance. The lower of the packet limit of the
.B limit
parameter and the memory limit will be enforced. Default is 32 MB.
.SS flows
is the number of flows into which the incoming packets are classified. Due to
the stochastic nature of hashing, multiple flows may end up being hashed into
@ -73,6 +84,11 @@ can be used to turn it off and vice-a-versa. Unlike
.B codel, ecn
is turned on by default.
.SS ce_threshold
sets a threshold above which all packets are marked with ECN Congestion
Experienced. This is useful for DCTCP-style congestion control algorithms that
require marking at very shallow queueing thresholds.
.SH EXAMPLES
#tc qdisc add dev eth0 root fq_codel
.br

View File

@ -50,6 +50,7 @@
static void explain(void)
{
fprintf(stderr, "Usage: ... fq_codel [ limit PACKETS ] [ flows NUMBER ]\n");
fprintf(stderr, " [ memory_limit BYTES ]\n");
fprintf(stderr, " [ target TIME ] [ interval TIME ]\n");
fprintf(stderr, " [ quantum BYTES ] [ [no]ecn ]\n");
fprintf(stderr, " [ ce_threshold TIME ]\n");