diff mbox series

[iproute2,v2,1/2] tc-cake: document 'ingress'

Message ID 20240812044234.3570-1-tcm4095@gmail.com (mailing list archive)
State Accepted
Commit f7c21530587705b7af69f55da1d522ecd8d71d2e
Delegated to: Stephen Hemminger
Headers show
Series [iproute2,v2,1/2] tc-cake: document 'ingress' | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Lương Việt Hoàng Aug. 12, 2024, 4:41 a.m. UTC
Linux kernel commit 7298de9cd7255a783ba ("sch_cake: Add ingress mode") added
an ingress mode for CAKE, which can be enabled with the 'ingress' parameter.
Document the changes in CAKE's behavior when ingress mode is enabled.

Signed-off-by: Lương Việt Hoàng <tcm4095@gmail.com>
---
 man/man8/tc-cake.8 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Toke Høiland-Jørgensen Aug. 14, 2024, 2:12 p.m. UTC | #1
Lương Việt Hoàng <tcm4095@gmail.com> writes:

> Linux kernel commit 7298de9cd7255a783ba ("sch_cake: Add ingress mode") added
> an ingress mode for CAKE, which can be enabled with the 'ingress' parameter.
> Document the changes in CAKE's behavior when ingress mode is enabled.
>
> Signed-off-by: Lương Việt Hoàng <tcm4095@gmail.com>

Reviewed-by: Toke Høiland-Jørgensen <toke@kernel.org>
patchwork-bot+netdevbpf@kernel.org Aug. 15, 2024, 3:20 p.m. UTC | #2
Hello:

This series was applied to iproute2/iproute2.git (main)
by Stephen Hemminger <stephen@networkplumber.org>:

On Mon, 12 Aug 2024 11:41:37 +0700 you wrote:
> Linux kernel commit 7298de9cd7255a783ba ("sch_cake: Add ingress mode") added
> an ingress mode for CAKE, which can be enabled with the 'ingress' parameter.
> Document the changes in CAKE's behavior when ingress mode is enabled.
> 
> Signed-off-by: Lương Việt Hoàng <tcm4095@gmail.com>
> ---
>  man/man8/tc-cake.8 | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)

Here is the summary with links:
  - [iproute2,v2,1/2] tc-cake: document 'ingress'
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=f7c215305877
  - [iproute2,v2,2/2] tc-cake: reformat
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=72c13bc5d48c

You are awesome, thank you!
diff mbox series

Patch

diff --git a/man/man8/tc-cake.8 b/man/man8/tc-cake.8
index ced9ac78..6d77d7d2 100644
--- a/man/man8/tc-cake.8
+++ b/man/man8/tc-cake.8
@@ -541,6 +541,21 @@  This can be used to set policies in a firewall script that will override CAKE's
 built-in tin selection.
 
 .SH OTHER PARAMETERS
+.B ingress
+.br
+	Indicates that CAKE is running in ingress mode (i.e. running on the downlink
+of a connection). This changes the shaper to also count dropped packets as data
+transferred, as these will have already traversed the link before CAKE can
+choose what to do with them.
+
+	In addition, the AQM will be tuned to always keep at least two packets
+queued per flow. The reason for this is that retransmits are more expensive in
+ingress mode, since dropped packets have to traverse the link again; thus,
+keeping a minimum number of packets queued will improve throughput in cases
+where the number of active flows are so large that they saturate the link even
+at their minimum window size.
+
+.PP
 .B memlimit
 LIMIT
 .br