From: Fan Yu <fan....@zte.com.cn>
Background
==========
When TCP retransmits a packet due to missing ACKs, the
retransmission may fail for various reasons (e.g., packets
stuck in driver queues, sequence errors, or routing issues).
The original tcp_retransmit_skb tracepoint:
'commit e086101b150a ("tcp: add a tracepoint for tcp retransmission")'
lacks visibility into these failure causes, making production
diagnostics difficult.
Solution
=======
Adds a 'reason' field to the tcp_retransmit_skb tracepoint,
enumerating with explicit failure cases:
TCP_RETRANS_ERR_DEFAULT (retransmit terminate unexpectedly)
TCP_RETRANS_IN_HOST_QUEUE (packet still queued in driver)
TCP_RETRANS_END_SEQ_ERROR (invalid end sequence)
TCP_RETRANS_TRIM_HEAD_NOMEM (trim head no memory)
TCP_RETRANS_UNCLONE_NOMEM (skb unclone keeptruesize no memory)
TCP_RETRANS_FRAG_NOMEM (fragment no memory)
TCP_RETRANS_ROUTE_FAIL (routing failure)
TCP_RETRANS_RCV_ZERO_WINDOW (closed recevier window)
TCP_RETRANS_PSKB_COPY_NOBUFS (no buffer for skb copy)
Functionality
=============
Enables users to know why some tcp retransmission quitted and filter
retransmission failures by reason.
Compatibility description
=========================
This patch extends the tcp_retransmit_skb tracepoint
by adding a new quit_reason field at the end of its
existing structure (within TP_STRUCT__entry). The
compatibility implications are detailed as follows:
1) Structural compatibility for legacy user-space tools
Legacy tools/BPF programs accessing existing fields
(by offset or name) can still work without modification
or recompilation.The new field is appended to the end,
preserving original memory layout.
2) Note: semantic changes
The original tracepoint primarily only focused on
successfully retransmitted packets. With this patch,
the tracepoint now covers all packets that trigger
retransmission attempts, including those that may
terminate early due to specific reasons. For accurate
statistics, users should filter using quit_reason
to distinguish outcomes.
Before patched:
# cat /sys/kernel/debug/tracing/events/tcp/tcp_retransmit_skb/format
field:const void * skbaddr; offset:8; size:8; signed:0;
field:const void * skaddr; offset:16; size:8; signed:0;
field:int state; offset:24; size:4; signed:1;
field:__u16 sport; offset:28; size:2; signed:0;
field:__u16 dport; offset:30; size:2; signed:0;
field:__u16 family; offset:32; size:2; signed:0;
field:__u8 saddr[4]; offset:34; size:4; signed:0;
field:__u8 daddr[4]; offset:38; size:4; signed:0;
field:__u8 saddr_v6[16]; offset:42; size:16;
signed:0;
field:__u8 daddr_v6[16]; offset:58; size:16;
signed:0;
print fmt: "skbaddr=%p skaddr=%p family=%s sport=%hu dport=%hu saddr=%pI4
daddr=%pI4 saddrv6=%pI6c daddrv6=%pI6c state=%s"
After patched:
# cat /sys/kernel/debug/tracing/events/tcp/tcp_retransmit_skb/format
field:const void * skbaddr; offset:8; size:8; signed:0;
field:const void * skaddr; offset:16; size:8; signed:0;
field:int state; offset:24; size:4; signed:1;
field:__u16 sport; offset:28; size:2; signed:0;
field:__u16 dport; offset:30; size:2; signed:0;
field:__u16 family; offset:32; size:2; signed:0;
field:__u8 saddr[4]; offset:34; size:4; signed:0;
field:__u8 daddr[4]; offset:38; size:4; signed:0;
field:__u8 saddr_v6[16]; offset:42; size:16;
signed:0;
field:__u8 daddr_v6[16]; offset:58; size:16;
signed:0;
field:enum tcp_retransmit_quit_reason quit_reason; offset:76;
size:4; signed:0;
print fmt: "skbaddr=%p skaddr=%p family=%s sport=%hu dport=%hu saddr=%pI4
daddr=%pI4 saddrv6=%pI6c daddrv6=%pI6c state=%s quit_reason=%s"
Co-developed-by: xu xin <xu.xi...@zte.com.cn>
Signed-off-by: xu xin <xu.xi...@zte.com.cn>
Signed-off-by: Fan Yu <fan....@zte.com.cn>
---
v1->v2:
1) Rename TCP_RETRANS_QUIT_UNDEFINED to TCP_RETRANS_ERR_DEFAULT,
as error codes due to tcp_transmit_skb() calls within
__tcp_retransmit_skb are not explicitly tracked, it is
necessary to make default failure reason essential
for clarity.
2) Added detailed compatibility consequences section.
include/linux/tcp.h | 13 +++++++++
include/trace/events/tcp.h | 54 +++++++++++++++++++++++++-------------
net/ipv4/tcp_output.c | 52 ++++++++++++++++++++++++++----------
3 files changed, 87 insertions(+), 32 deletions(-)
diff --git a/include/linux/tcp.h b/include/linux/tcp.h
index 29f59d50dc73..7ffd5680c4ac 100644
--- a/include/linux/tcp.h
+++ b/include/linux/tcp.h
@@ -530,6 +530,19 @@ enum tsq_flags {
TCPF_ACK_DEFERRED = BIT(TCP_ACK_DEFERRED),
};
+enum tcp_retransmit_quit_reason {
+ TCP_RETRANS_ERR_DEFAULT,
+ TCP_RETRANS_SUCCESS,
+ TCP_RETRANS_IN_HOST_QUEUE,
+ TCP_RETRANS_END_SEQ_ERROR,
+ TCP_RETRANS_TRIM_HEAD_NOMEM,
+ TCP_RETRANS_UNCLONE_NOMEM,
+ TCP_RETRANS_FRAG_NOMEM,
+ TCP_RETRANS_ROUTE_FAIL,
+ TCP_RETRANS_RCV_ZERO_WINDOW,
+ TCP_RETRANS_PSKB_COPY_NOBUFS,
+};
+
#define tcp_sk(ptr) container_of_const(ptr, struct tcp_sock,
inet_conn.icsk_inet.sk)
/* Variant of tcp_sk() upgrading a const sock to a read/write tcp socket.
diff --git a/include/trace/events/tcp.h b/include/trace/events/tcp.h
index 54e60c6009e3..3e24740d759e 100644
--- a/include/trace/events/tcp.h
+++ b/include/trace/events/tcp.h
@@ -13,17 +13,38 @@
#include <linux/sock_diag.h>
#include <net/rstreason.h>
-/*
- * tcp event with arguments sk and skb
- *
- * Note: this class requires a valid sk pointer; while skb pointer could
- * be NULL.
- */
-DECLARE_EVENT_CLASS(tcp_event_sk_skb,
+#define TCP_RETRANSMIT_QUIT_REASON \
+ ENUM(TCP_RETRANS_ERR_DEFAULT, "retransmit terminate
unexpectedly") \
+ ENUM(TCP_RETRANS_SUCCESS, "retransmit
successfully") \
+ ENUM(TCP_RETRANS_IN_HOST_QUEUE, "packet still queued in
driver") \
+ ENUM(TCP_RETRANS_END_SEQ_ERROR, "invalid end sequence")
\
+ ENUM(TCP_RETRANS_TRIM_HEAD_NOMEM, "trim head no memory")
\
+ ENUM(TCP_RETRANS_UNCLONE_NOMEM, "skb unclone
keeptruesize no memory") \
+ ENUM(TCP_RETRANS_FRAG_NOMEM, "fragment no memory")
\
+ ENUM(TCP_RETRANS_ROUTE_FAIL, "routing failure")
\
+ ENUM(TCP_RETRANS_RCV_ZERO_WINDOW, "closed recevier
window") \
+ ENUMe(TCP_RETRANS_PSKB_COPY_NOBUFS, "no buffer for skb
copy") \
+
+/* Redefine for export. */
+#undef ENUM
+#undef ENUMe
+#define ENUM(a, b) TRACE_DEFINE_ENUM(a);
+#define ENUMe(a, b) TRACE_DEFINE_ENUM(a);
+
+TCP_RETRANSMIT_QUIT_REASON
+
+/* Redefine for symbolic printing. */
+#undef ENUM
+#undef ENUMe
+#define ENUM(a, b) { a, b },
+#define ENUMe(a, b) { a, b }
+
+TRACE_EVENT(tcp_retransmit_skb,
- TP_PROTO(const struct sock *sk, const struct sk_buff *skb),
+ TP_PROTO(const struct sock *sk, const struct sk_buff *skb,
+ enum tcp_retransmit_quit_reason quit_reason),
- TP_ARGS(sk, skb),
+ TP_ARGS(sk, skb, quit_reason),
TP_STRUCT__entry(
__field(const void *, skbaddr)
@@ -36,6 +57,7 @@ DECLARE_EVENT_CLASS(tcp_event_sk_skb,
__array(__u8, daddr, 4)
__array(__u8, saddr_v6, 16)
__array(__u8, daddr_v6, 16)
+ __field(enum tcp_retransmit_quit_reason, quit_reason)
),
TP_fast_assign(
@@ -58,21 +80,17 @@ DECLARE_EVENT_CLASS(tcp_event_sk_skb,
TP_STORE_ADDRS(__entry, inet->inet_saddr, inet->inet_daddr,
sk->sk_v6_rcv_saddr, sk->sk_v6_daddr);
+
+ __entry->quit_reason = quit_reason;
),
- TP_printk("skbaddr=%p skaddr=%p family=%s sport=%hu dport=%hu
saddr=%pI4 daddr=%pI4 saddrv6=%pI6c daddrv6=%pI6c state=%s",
+ TP_printk("skbaddr=%p skaddr=%p family=%s sport=%hu dport=%hu
saddr=%pI4 daddr=%pI4 saddrv6=%pI6c daddrv6=%pI6c state=%s quit_reason=%s",
__entry->skbaddr, __entry->skaddr,
show_family_name(__entry->family),
__entry->sport, __entry->dport, __entry->saddr,
__entry->daddr,
__entry->saddr_v6, __entry->daddr_v6,
- show_tcp_state_name(__entry->state))
-);
-
-DEFINE_EVENT(tcp_event_sk_skb, tcp_retransmit_skb,
-
- TP_PROTO(const struct sock *sk, const struct sk_buff *skb),
-
- TP_ARGS(sk, skb)
+ show_tcp_state_name(__entry->state),
+ __print_symbolic(__entry->quit_reason,
TCP_RETRANSMIT_QUIT_REASON))
);
#undef FN
diff --git a/net/ipv4/tcp_output.c b/net/ipv4/tcp_output.c
index 3ac8d2d17e1f..70b89b9fdf4d 100644
--- a/net/ipv4/tcp_output.c
+++ b/net/ipv4/tcp_output.c
@@ -3326,6 +3326,7 @@ static void tcp_retrans_try_collapse(struct sock *sk,
struct sk_buff *to,
*/
int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs)
{
+ enum tcp_retransmit_quit_reason reason = TCP_RETRANS_ERR_DEFAULT;
struct inet_connection_sock *icsk = inet_csk(sk);
struct tcp_sock *tp = tcp_sk(sk);
unsigned int cur_mss;
@@ -3336,8 +3337,11 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff
*skb, int segs)
if (icsk->icsk_mtup.probe_size)
icsk->icsk_mtup.probe_size = 0;
- if (skb_still_in_host_queue(sk, skb))
- return -EBUSY;
+ if (skb_still_in_host_queue(sk, skb)) {
+ reason = TCP_RETRANS_IN_HOST_QUEUE;
+ err = -EBUSY;
+ goto out;
+ }
start:
if (before(TCP_SKB_CB(skb)->seq, tp->snd_una)) {
@@ -3348,14 +3352,22 @@ int __tcp_retransmit_skb(struct sock *sk, struct
sk_buff *skb, int segs)
}
if (unlikely(before(TCP_SKB_CB(skb)->end_seq, tp->snd_una))) {
WARN_ON_ONCE(1);
- return -EINVAL;
+ reason = TCP_RETRANS_END_SEQ_ERROR;
+ err = -EINVAL;
+ goto out;
+ }
+ if (tcp_trim_head(sk, skb, tp->snd_una - TCP_SKB_CB(skb)->seq))
{
+ reason = TCP_RETRANS_TRIM_HEAD_NOMEM;
+ err = -ENOMEM;
+ goto out;
}
- if (tcp_trim_head(sk, skb, tp->snd_una - TCP_SKB_CB(skb)->seq))
- return -ENOMEM;
}
- if (inet_csk(sk)->icsk_af_ops->rebuild_header(sk))
- return -EHOSTUNREACH; /* Routing failure or similar. */
+ if (inet_csk(sk)->icsk_af_ops->rebuild_header(sk)) {
+ reason = TCP_RETRANS_ROUTE_FAIL;
+ err = -EHOSTUNREACH; /* Routing failure or similar. */
+ goto out;
+ }
cur_mss = tcp_current_mss(sk);
avail_wnd = tcp_wnd_end(tp) - TCP_SKB_CB(skb)->seq;
@@ -3366,8 +3378,11 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff
*skb, int segs)
* our retransmit of one segment serves as a zero window probe.
*/
if (avail_wnd <= 0) {
- if (TCP_SKB_CB(skb)->seq != tp->snd_una)
- return -EAGAIN;
+ if (TCP_SKB_CB(skb)->seq != tp->snd_una) {
+ reason = TCP_RETRANS_RCV_ZERO_WINDOW;
+ err = -EAGAIN;
+ goto out;
+ }
avail_wnd = cur_mss;
}
@@ -3379,11 +3394,17 @@ int __tcp_retransmit_skb(struct sock *sk, struct
sk_buff *skb, int segs)
}
if (skb->len > len) {
if (tcp_fragment(sk, TCP_FRAG_IN_RTX_QUEUE, skb, len,
- cur_mss, GFP_ATOMIC))
- return -ENOMEM; /* We'll try again later. */
+ cur_mss, GFP_ATOMIC)) {
+ reason = TCP_RETRANS_FRAG_NOMEM;
+ err = -ENOMEM; /* We'll try again later. */
+ goto out;
+ }
} else {
- if (skb_unclone_keeptruesize(skb, GFP_ATOMIC))
- return -ENOMEM;
+ if (skb_unclone_keeptruesize(skb, GFP_ATOMIC)) {
+ reason = TCP_RETRANS_UNCLONE_NOMEM;
+ err = -ENOMEM;
+ goto out;
+ }
diff = tcp_skb_pcount(skb);
tcp_set_skb_tso_segs(skb, cur_mss);
@@ -3421,6 +3442,7 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff
*skb, int segs)
nskb->dev = NULL;
err = tcp_transmit_skb(sk, nskb, 0, GFP_ATOMIC);
} else {
+ reason = TCP_RETRANS_PSKB_COPY_NOBUFS;
err = -ENOBUFS;
}
} tcp_skb_tsorted_restore(skb);
@@ -3438,7 +3460,7 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff
*skb, int segs)
TCP_SKB_CB(skb)->seq, segs, err);
if (likely(!err)) {
- trace_tcp_retransmit_skb(sk, skb);
+ reason = TCP_RETRANS_SUCCESS;
} else if (err != -EBUSY) {
NET_ADD_STATS(sock_net(sk), LINUX_MIB_TCPRETRANSFAIL, segs);
}
@@ -3448,6 +3470,8 @@ int __tcp_retransmit_skb(struct sock *sk, struct sk_buff
*skb, int segs)
*/
TCP_SKB_CB(skb)->sacked |= TCPCB_EVER_RETRANS;
+out:
+ trace_tcp_retransmit_skb(sk, skb, reason);
return err;
}
--
2.25.1
