summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorToke Høiland-Jørgensen <toke@toke.dk>2018-03-08 23:31:36 +0100
committerDavid Ahern <dsahern@gmail.com>2018-03-13 18:05:35 -0700
commitd7d044ff537c9a1cbad778ae3a3d331430af1756 (patch)
tree0cc058b464571aae064e699deb006650b3ab4c84
parentfb4e6abfca2c48380210d48c1e7f3685f8bb58fd (diff)
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>
-rw-r--r--man/man8/tc-codel.810
-rw-r--r--man/man8/tc-fq_codel.818
-rw-r--r--tc/q_fq_codel.c1
3 files changed, 27 insertions, 2 deletions
diff --git a/man/man8/tc-codel.8 b/man/man8/tc-codel.8
index a0e50a4e..e538e940 100644
--- a/man/man8/tc-codel.8
+++ b/man/man8/tc-codel.8
@@ -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
diff --git a/man/man8/tc-fq_codel.8 b/man/man8/tc-fq_codel.8
index a80389a1..7ee6c269 100644
--- a/man/man8/tc-fq_codel.8
+++ b/man/man8/tc-fq_codel.8
@@ -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
diff --git a/tc/q_fq_codel.c b/tc/q_fq_codel.c
index 9e3736fe..1b2931ef 100644
--- a/tc/q_fq_codel.c
+++ b/tc/q_fq_codel.c
@@ -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");