public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] rtnetlink.7: Document metrics attributes (RTAX_*).
@ 2025-09-19 10:53 Guillaume Nault
  2025-10-02 14:43 ` Guillaume Nault
                   ` (2 more replies)
  0 siblings, 3 replies; 9+ messages in thread
From: Guillaume Nault @ 2025-09-19 10:53 UTC (permalink / raw)
  To: Alejandro Colomar; +Cc: linux-man

Add a brief explanation of the RTAX attributes that can be used in
RTA_METRICS.

Signed-off-by: Guillaume Nault <gnault@redhat.com>
---
 man/man7/rtnetlink.7 | 49 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/man/man7/rtnetlink.7 b/man/man7/rtnetlink.7
index cb9f5155f..a04edce79 100644
--- a/man/man7/rtnetlink.7
+++ b/man/man7/rtnetlink.7
@@ -342,7 +342,11 @@ RTA_OIF:int:Output interface index
 RTA_GATEWAY:protocol address:The gateway of the route
 RTA_PRIORITY:int:Priority of route
 RTA_PREFSRC:protocol address:Preferred source address
-RTA_METRICS:int:Route metric
+RTA_METRICS::T{
+Route metrics
+.br
+(see below).
+T}
 RTA_MULTIPATH::T{
 Multipath nexthop data
 .br
@@ -384,6 +388,49 @@ routes (in seconds)
 T}
 .TE
 .IP
+.B RTA_METRICS
+contains an array of
+.I struct rtattr
+with their corresponding attributes:
+.IP
+.in +4n
+.TS
+tab(:);
+c s s
+lb l l.
+Attributes
+rta_type:Value type:Description
+_
+RTAX_UNSPEC:-:unspecified
+RTAX_LOCK:__u32:Bit field indicating which RTAX_* attributes are locked
+RTAX_MTU:__u32:Maximum Transmission Unit for this route
+RTAX_WINDOW:__u32:Maximum size of the receive window for this route
+RTAX_RTT:__u32:Estimated round-trip time for this route
+RTAX_RTTVAR:__u32:Estimated round-trip time variation for this route
+RTAX_SSTHRESH:__u32:Slow start threshold to use for this route
+RTAX_CWND:__u32:Maximum size of the congestion window for this route
+RTAX_ADVMSS:__u32:Maximum Segment Size to advertise for this route
+RTAX_REORDERING:__u32:Initial reordering level of packets for this route
+RTAX_HOPLIMIT:__u32:Hop limit (TTL) to use for this route
+RTAX_INITCWND:__u32:Initial congestion window to use for this route
+RTAX_FEATURES:__u32:Features to enable for this route specifically
+RTAX_RTO_MIN:__u32:Minimum Retransmission TimeOut to use for this route
+RTAX_INITRWND:__u32:Initial size of the receive window for this route
+RTAX_QUICKACK:__u32:Use quick ack for this route
+RTAX_CC_ALGO:asciiz string:Congestion Control algorithm to use for this route
+RTAX_FASTOPEN_NO_COOKIE:__u32:Allow TCP Fast Open without cookie
+.TE
+.IP
+Metrics that are locked with
+.B RTAX_LOCK
+take precedence over the values normally used by the kernel
+(computed or assigned by a sysctl or setsockopt(2)).
+Therefore, some metrics, like
+.BR RTAX_RTO_MIN ,
+have no effect unless their bit is set in
+.BR RTAX_LOCK .
+.in
+.IP
 .B RTA_MULTIPATH
 contains several packed instances of
 .I struct rtnexthop
-- 
2.47.3


^ permalink raw reply related	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2025-10-12 21:28 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-19 10:53 [PATCH] rtnetlink.7: Document metrics attributes (RTAX_*) Guillaume Nault
2025-10-02 14:43 ` Guillaume Nault
2025-10-02 14:59   ` Alejandro Colomar
2025-10-02 15:06     ` Guillaume Nault
2025-10-02 21:33 ` Alejandro Colomar
2025-10-08 14:41   ` Guillaume Nault
2025-10-08 16:05     ` Alejandro Colomar
2025-10-08 18:51       ` Guillaume Nault
2025-10-12 21:28 ` Alejandro Colomar

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox