Merge tag 'x86-asm-2024-03-11' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
[linux-2.6-block.git] / include / net / tcp.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4
LT
2/*
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
6 *
7 * Definitions for the TCP module.
8 *
9 * Version: @(#)tcp.h 1.0.5 05/23/93
10 *
02c30a84 11 * Authors: Ross Biro
1da177e4 12 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
1da177e4
LT
13 */
14#ifndef _TCP_H
15#define _TCP_H
16
1da177e4
LT
17#define FASTRETRANS_DEBUG 1
18
1da177e4
LT
19#include <linux/list.h>
20#include <linux/tcp.h>
187f1882 21#include <linux/bug.h>
1da177e4
LT
22#include <linux/slab.h>
23#include <linux/cache.h>
24#include <linux/percpu.h>
fb286bb2 25#include <linux/skbuff.h>
435cf559 26#include <linux/kref.h>
740b0f18 27#include <linux/ktime.h>
05e22e83 28#include <linux/indirect_call_wrapper.h>
3f421baa
ACM
29
30#include <net/inet_connection_sock.h>
295ff7ed 31#include <net/inet_timewait_sock.h>
77d8bf9c 32#include <net/inet_hashtables.h>
1da177e4 33#include <net/checksum.h>
2e6599cb 34#include <net/request_sock.h>
40a1227e 35#include <net/sock_reuseport.h>
1da177e4
LT
36#include <net/sock.h>
37#include <net/snmp.h>
38#include <net/ip.h>
c752f073 39#include <net/tcp_states.h>
c845f5f3 40#include <net/tcp_ao.h>
bdf1ee5d 41#include <net/inet_ecn.h>
0c266898 42#include <net/dst.h>
85712484 43#include <net/mptcp.h>
c752f073 44
1da177e4 45#include <linux/seq_file.h>
180d8cd9 46#include <linux/memcontrol.h>
40304b2a 47#include <linux/bpf-cgroup.h>
438ac880 48#include <linux/siphash.h>
40304b2a 49
6e04e021 50extern struct inet_hashinfo tcp_hashinfo;
1da177e4 51
19757ceb
ED
52DECLARE_PER_CPU(unsigned int, tcp_orphan_count);
53int tcp_orphan_count_sum(void);
54
5c9f3023 55void tcp_time_wait(struct sock *sk, int state, int timeo);
1da177e4 56
9bacd256 57#define MAX_TCP_HEADER L1_CACHE_ALIGN(128 + MAX_HEADER)
33ad798c 58#define MAX_TCP_OPTION_SPACE 40
3b4929f6
ED
59#define TCP_MIN_SND_MSS 48
60#define TCP_MIN_GSO_SIZE (TCP_MIN_SND_MSS - MAX_TCP_OPTION_SPACE)
1da177e4 61
105970f6 62/*
1da177e4 63 * Never offer a window over 32767 without using window scaling. Some
105970f6 64 * poor stacks do signed 16bit maths!
1da177e4
LT
65 */
66#define MAX_TCP_WINDOW 32767U
67
68/* Minimal accepted MSS. It is (60+60+8) - (20+20). */
69#define TCP_MIN_MSS 88U
70
1555e6fd 71/* The initial MTU to use for probing */
dcd8fb85 72#define TCP_BASE_MSS 1024
5d424d5a 73
05cbc0db
FD
74/* probing interval, default to 10 minutes as per RFC4821 */
75#define TCP_PROBE_INTERVAL 600
76
6b58e0a5
FD
77/* Specify interval when tcp mtu probing will stop */
78#define TCP_PROBE_THRESHOLD 8
79
1da177e4
LT
80/* After receiving this amount of duplicate ACKs fast retransmit starts. */
81#define TCP_FASTRETRANS_THRESH 3
82
1da177e4
LT
83/* Maximal number of ACKs sent quickly to accelerate slow-start. */
84#define TCP_MAX_QUICKACKS 16U
85
589c49cb
GF
86/* Maximal number of window scale according to RFC1323 */
87#define TCP_MAX_WSCALE 14U
88
1da177e4
LT
89/* urg_data states */
90#define TCP_URG_VALID 0x0100
91#define TCP_URG_NOTYET 0x0200
92#define TCP_URG_READ 0x0400
93
94#define TCP_RETR1 3 /*
95 * This is how many retries it does before it
96 * tries to figure out if the gateway is
97 * down. Minimal RFC value is 3; it corresponds
98 * to ~3sec-8min depending on RTO.
99 */
100
101#define TCP_RETR2 15 /*
102 * This should take at least
103 * 90 minutes to time out.
104 * RFC1122 says that the limit is 100 sec.
105 * 15 is ~13-30min depending on RTO.
106 */
107
6c9ff979
AB
108#define TCP_SYN_RETRIES 6 /* This is how many retries are done
109 * when active opening a connection.
110 * RFC1122 says the minimum retry MUST
111 * be at least 180secs. Nevertheless
112 * this value is corresponding to
113 * 63secs of retransmission with the
114 * current initial RTO.
115 */
1da177e4 116
6c9ff979
AB
117#define TCP_SYNACK_RETRIES 5 /* This is how may retries are done
118 * when passive opening a connection.
119 * This is corresponding to 31secs of
120 * retransmission with the current
121 * initial RTO.
122 */
1da177e4 123
1da177e4
LT
124#define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
125 * state, about 60 seconds */
126#define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
127 /* BSD style FIN_WAIT2 deadlock breaker.
128 * It used to be 3min, new value is 60sec,
129 * to combine FIN-WAIT-2 timeout with
130 * TIME-WAIT timer.
131 */
f0628c52 132#define TCP_FIN_TIMEOUT_MAX (120 * HZ) /* max TCP_LINGER2 value (two minutes) */
1da177e4
LT
133
134#define TCP_DELACK_MAX ((unsigned)(HZ/5)) /* maximal time to delay before sending an ACK */
95b9a87c
DM
135static_assert((1 << ATO_BITS) > TCP_DELACK_MAX);
136
1da177e4
LT
137#if HZ >= 100
138#define TCP_DELACK_MIN ((unsigned)(HZ/25)) /* minimal time to delay before sending an ACK */
139#define TCP_ATO_MIN ((unsigned)(HZ/25))
140#else
141#define TCP_DELACK_MIN 4U
142#define TCP_ATO_MIN 4U
143#endif
144#define TCP_RTO_MAX ((unsigned)(120*HZ))
145#define TCP_RTO_MIN ((unsigned)(HZ/5))
bb4d991a 146#define TCP_TIMEOUT_MIN (2U) /* Min timeout for TCP timers in jiffies */
1c2709cf
NC
147
148#define TCP_TIMEOUT_MIN_US (2*USEC_PER_MSEC) /* Min TCP timeout in microsecs */
149
fd4f2cea 150#define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC6298 2.1 initial RTO value */
9ad7c049
JC
151#define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now
152 * used as a fallback RTO for the
153 * initial data transmission if no
154 * valid RTT sample has been acquired,
155 * most likely due to retrans in 3WHS.
156 */
1da177e4
LT
157
158#define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
159 * for local resources.
160 */
1da177e4
LT
161#define TCP_KEEPALIVE_TIME (120*60*HZ) /* two hours */
162#define TCP_KEEPALIVE_PROBES 9 /* Max of 9 keepalive probes */
163#define TCP_KEEPALIVE_INTVL (75*HZ)
164
165#define MAX_TCP_KEEPIDLE 32767
166#define MAX_TCP_KEEPINTVL 32767
167#define MAX_TCP_KEEPCNT 127
168#define MAX_TCP_SYNCNT 127
169
af772144
ED
170/* Ensure that TCP PAWS checks are relaxed after ~2147 seconds
171 * to avoid overflows. This assumes a clock smaller than 1 Mhz.
172 * Default clock is 1 Khz, tcp_usec_ts uses 1 Mhz.
173 */
174#define TCP_PAWS_WRAP (INT_MAX / USEC_PER_SEC)
175
1da177e4
LT
176#define TCP_PAWS_MSL 60 /* Per-host timestamps are invalidated
177 * after this time. It should be equal
178 * (or greater than) TCP_TIMEWAIT_LEN
179 * to provide reliability equal to one
180 * provided by timewait state.
181 */
182#define TCP_PAWS_WINDOW 1 /* Replay window for per-host
183 * timestamps. It must be less than
184 * minimal timewait lifetime.
185 */
1da177e4
LT
186/*
187 * TCP option
188 */
105970f6 189
1da177e4
LT
190#define TCPOPT_NOP 1 /* Padding */
191#define TCPOPT_EOL 0 /* End of options */
192#define TCPOPT_MSS 2 /* Segment size negotiating */
193#define TCPOPT_WINDOW 3 /* Window scaling */
194#define TCPOPT_SACK_PERM 4 /* SACK Permitted */
195#define TCPOPT_SACK 5 /* SACK Block */
196#define TCPOPT_TIMESTAMP 8 /* Better RTT estimations/PAWS */
cfb6eeb4 197#define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */
1e03d32b 198#define TCPOPT_AO 29 /* Authentication Option (RFC5925) */
c74a39c8 199#define TCPOPT_MPTCP 30 /* Multipath TCP (RFC6824) */
7f9b838b 200#define TCPOPT_FASTOPEN 34 /* Fast open (RFC7413) */
2100c8d2
YC
201#define TCPOPT_EXP 254 /* Experimental */
202/* Magic number to be after the option value for sharing TCP
203 * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
204 */
205#define TCPOPT_FASTOPEN_MAGIC 0xF989
60e2a778 206#define TCPOPT_SMC_MAGIC 0xE2D4C3D9
1da177e4
LT
207
208/*
209 * TCP option lengths
210 */
211
212#define TCPOLEN_MSS 4
213#define TCPOLEN_WINDOW 3
214#define TCPOLEN_SACK_PERM 2
215#define TCPOLEN_TIMESTAMP 10
cfb6eeb4 216#define TCPOLEN_MD5SIG 18
7f9b838b 217#define TCPOLEN_FASTOPEN_BASE 2
2100c8d2 218#define TCPOLEN_EXP_FASTOPEN_BASE 4
60e2a778 219#define TCPOLEN_EXP_SMC_BASE 6
1da177e4
LT
220
221/* But this is what stacks really send out. */
222#define TCPOLEN_TSTAMP_ALIGNED 12
223#define TCPOLEN_WSCALE_ALIGNED 4
224#define TCPOLEN_SACKPERM_ALIGNED 4
225#define TCPOLEN_SACK_BASE 2
226#define TCPOLEN_SACK_BASE_ALIGNED 4
227#define TCPOLEN_SACK_PERBLOCK 8
cfb6eeb4 228#define TCPOLEN_MD5SIG_ALIGNED 20
33ad798c 229#define TCPOLEN_MSS_ALIGNED 4
60e2a778 230#define TCPOLEN_EXP_SMC_BASE_ALIGNED 8
1da177e4 231
1da177e4
LT
232/* Flags in tp->nonagle */
233#define TCP_NAGLE_OFF 1 /* Nagle's algo is disabled */
234#define TCP_NAGLE_CORK 2 /* Socket is corked */
caa20d9a 235#define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */
1da177e4 236
36e31b0a
AP
237/* TCP thin-stream limits */
238#define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */
239
21603fc4 240/* TCP initial congestion window as per rfc6928 */
442b9635
DM
241#define TCP_INIT_CWND 10
242
cf60af03
YC
243/* Bit Flags for sysctl_tcp_fastopen */
244#define TFO_CLIENT_ENABLE 1
10467163 245#define TFO_SERVER_ENABLE 2
67da22d2 246#define TFO_CLIENT_NO_COOKIE 4 /* Data in SYN w/o cookie option */
cf60af03 247
10467163
JC
248/* Accept SYN data w/o any cookie option */
249#define TFO_SERVER_COOKIE_NOT_REQD 0x200
250
251/* Force enable TFO on all listeners, i.e., not requiring the
cebc5cba 252 * TCP_FASTOPEN socket option.
10467163
JC
253 */
254#define TFO_SERVER_WO_SOCKOPT1 0x400
10467163 255
295ff7ed 256
1da177e4 257/* sysctl variables for tcp */
1da177e4 258extern int sysctl_tcp_max_orphans;
a4fe34bf 259extern long sysctl_tcp_mem[3];
e20223f1 260
a0370b3f 261#define TCP_RACK_LOSS_DETECTION 0x1 /* Use RACK to detect losses */
1f255691 262#define TCP_RACK_STATIC_REO_WND 0x2 /* Use static RACK reo wnd */
20b654df 263#define TCP_RACK_NO_DUPTHRESH 0x4 /* Do not use DUPACK threshold in RACK */
a0370b3f 264
8d987e5c 265extern atomic_long_t tcp_memory_allocated;
0defbb0a
ED
266DECLARE_PER_CPU(int, tcp_memory_per_cpu_fw_alloc);
267
1748376b 268extern struct percpu_counter tcp_sockets_allocated;
06044751 269extern unsigned long tcp_memory_pressure;
1da177e4 270
b8da51eb
ED
271/* optimized version of sk_under_memory_pressure() for TCP sockets */
272static inline bool tcp_under_memory_pressure(const struct sock *sk)
273{
baac50bb
JW
274 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
275 mem_cgroup_under_socket_pressure(sk->sk_memcg))
e805605c 276 return true;
b8da51eb 277
1f142c17 278 return READ_ONCE(tcp_memory_pressure);
b8da51eb 279}
1da177e4
LT
280/*
281 * The next routines deal with comparing 32 bit unsigned ints
282 * and worry about wraparound (automatic with unsigned arithmetic).
283 */
284
a2a385d6 285static inline bool before(__u32 seq1, __u32 seq2)
1da177e4 286{
0d630cc0 287 return (__s32)(seq1-seq2) < 0;
1da177e4 288}
9a036b9c 289#define after(seq2, seq1) before(seq1, seq2)
1da177e4
LT
290
291/* is s2<=s1<=s3 ? */
a2a385d6 292static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
1da177e4
LT
293{
294 return seq3 - seq2 >= seq1 - seq2;
295}
296
efcdbf24
AS
297static inline bool tcp_out_of_memory(struct sock *sk)
298{
299 if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
300 sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
301 return true;
302 return false;
303}
304
03271f3a
TA
305static inline void tcp_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
306{
307 sk_wmem_queued_add(sk, -skb->truesize);
9b65b17d
TA
308 if (!skb_zcopy_pure(skb))
309 sk_mem_uncharge(sk, skb->truesize);
310 else
311 sk_mem_uncharge(sk, SKB_TRUESIZE(skb_end_offset(skb)));
03271f3a
TA
312 __kfree_skb(skb);
313}
314
a6c5ea4c
ED
315void sk_forced_mem_schedule(struct sock *sk, int size);
316
5c9f3023 317bool tcp_check_oom(struct sock *sk, int shift);
efcdbf24 318
a0f82f64 319
1da177e4
LT
320extern struct proto tcp_prot;
321
57ef42d5 322#define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field)
13415e46 323#define __TCP_INC_STATS(net, field) __SNMP_INC_STATS((net)->mib.tcp_statistics, field)
57ef42d5 324#define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
aa2ea058 325#define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
1da177e4 326
5c9f3023
JP
327void tcp_tasklet_init(void);
328
32bbd879 329int tcp_v4_err(struct sk_buff *skb, u32);
5c9f3023
JP
330
331void tcp_shutdown(struct sock *sk, int how);
332
7487449c 333int tcp_v4_early_demux(struct sk_buff *skb);
5c9f3023
JP
334int tcp_v4_rcv(struct sk_buff *skb);
335
27728ba8 336void tcp_remove_empty_skb(struct sock *sk);
1b784140 337int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
306b13eb 338int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size);
3242abeb
BH
339int tcp_sendmsg_fastopen(struct sock *sk, struct msghdr *msg, int *copied,
340 size_t size, struct ubuf_info *uarg);
1d7e4538 341void tcp_splice_eof(struct socket *sock);
35b2c321 342int tcp_send_mss(struct sock *sk, int *size_goal, int flags);
fbf93406 343int tcp_wmem_schedule(struct sock *sk, int copy);
35b2c321
MM
344void tcp_push(struct sock *sk, int flags, int mss_now, int nonagle,
345 int size_goal);
5c9f3023
JP
346void tcp_release_cb(struct sock *sk);
347void tcp_wfree(struct sk_buff *skb);
348void tcp_write_timer_handler(struct sock *sk);
349void tcp_delack_timer_handler(struct sock *sk);
e1d001fa 350int tcp_ioctl(struct sock *sk, int cmd, int *karg);
72ab4a86 351int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb);
3d97d88e 352void tcp_rcv_established(struct sock *sk, struct sk_buff *skb);
5c9f3023 353void tcp_rcv_space_adjust(struct sock *sk);
5c9f3023
JP
354int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
355void tcp_twsk_destructor(struct sock *sk);
edc12f03 356void tcp_twsk_purge(struct list_head *net_exit_list, int family);
5c9f3023
JP
357ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
358 struct pipe_inode_info *pipe, size_t len,
359 unsigned int flags);
5882efff 360struct sk_buff *tcp_stream_alloc_skb(struct sock *sk, gfp_t gfp,
f8dd3b8d 361 bool force_schedule);
9c55e01c 362
059217c1 363static inline void tcp_dec_quickack_mode(struct sock *sk)
1da177e4 364{
463c84b9 365 struct inet_connection_sock *icsk = inet_csk(sk);
fc6415bc 366
463c84b9 367 if (icsk->icsk_ack.quick) {
059217c1
NC
368 /* How many ACKs S/ACKing new data have we sent? */
369 const unsigned int pkts = inet_csk_ack_scheduled(sk) ? 1 : 0;
370
463c84b9
ACM
371 if (pkts >= icsk->icsk_ack.quick) {
372 icsk->icsk_ack.quick = 0;
fc6415bc 373 /* Leaving quickack mode we deflate ATO. */
463c84b9 374 icsk->icsk_ack.ato = TCP_ATO_MIN;
fc6415bc 375 } else
463c84b9 376 icsk->icsk_ack.quick -= pkts;
1da177e4
LT
377 }
378}
379
bdf1ee5d
IJ
380#define TCP_ECN_OK 1
381#define TCP_ECN_QUEUE_CWR 2
382#define TCP_ECN_DEMAND_CWR 4
7a269ffa 383#define TCP_ECN_SEEN 8
bdf1ee5d 384
fd2c3ef7 385enum tcp_tw_status {
1da177e4
LT
386 TCP_TW_SUCCESS = 0,
387 TCP_TW_RST = 1,
388 TCP_TW_ACK = 2,
389 TCP_TW_SYN = 3
390};
391
392
5c9f3023
JP
393enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
394 struct sk_buff *skb,
395 const struct tcphdr *th);
396struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
e0f9759f
ED
397 struct request_sock *req, bool fastopen,
398 bool *lost_race);
5c9f3023
JP
399int tcp_child_process(struct sock *parent, struct sock *child,
400 struct sk_buff *skb);
5ae344c9 401void tcp_enter_loss(struct sock *sk);
7e901ee7 402void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int newly_lost, int flag);
5c9f3023
JP
403void tcp_clear_retrans(struct tcp_sock *tp);
404void tcp_update_metrics(struct sock *sk);
405void tcp_init_metrics(struct sock *sk);
406void tcp_metrics_init(void);
d82bae12 407bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst);
77c3c956 408void __tcp_close(struct sock *sk, long timeout);
5c9f3023
JP
409void tcp_close(struct sock *sk, long timeout);
410void tcp_init_sock(struct sock *sk);
72be0fe6 411void tcp_init_transfer(struct sock *sk, int bpf_op, struct sk_buff *skb);
a11e1d43
LT
412__poll_t tcp_poll(struct file *file, struct socket *sock,
413 struct poll_table_struct *wait);
273b7f0f
MKL
414int do_tcp_getsockopt(struct sock *sk, int level,
415 int optname, sockptr_t optval, sockptr_t optlen);
5c9f3023
JP
416int tcp_getsockopt(struct sock *sk, int level, int optname,
417 char __user *optval, int __user *optlen);
9cacf81f 418bool tcp_bpf_bypass_getsockopt(int level, int optname);
0c751f70
MKL
419int do_tcp_setsockopt(struct sock *sk, int level, int optname,
420 sockptr_t optval, unsigned int optlen);
a7b75c5a
CH
421int tcp_setsockopt(struct sock *sk, int level, int optname, sockptr_t optval,
422 unsigned int optlen);
5c9f3023 423void tcp_set_keepalive(struct sock *sk, int val);
42cb80a2 424void tcp_syn_ack_timeout(const struct request_sock *req);
ec095263 425int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
1b784140 426 int flags, int *addr_len);
d1361840 427int tcp_set_rcvlowat(struct sock *sk, int val);
cb811109 428int tcp_set_window_clamp(struct sock *sk, int val);
892bfd3d
FW
429void tcp_update_recv_tstamps(struct sk_buff *skb,
430 struct scm_timestamping_internal *tss);
431void tcp_recv_timestamp(struct msghdr *msg, const struct sock *sk,
432 struct scm_timestamping_internal *tss);
03f45c88 433void tcp_data_ready(struct sock *sk);
340a6f3d 434#ifdef CONFIG_MMU
93ab6cc6
ED
435int tcp_mmap(struct file *file, struct socket *sock,
436 struct vm_area_struct *vma);
340a6f3d 437#endif
eed29f17 438void tcp_parse_options(const struct net *net, const struct sk_buff *skb,
5c9f3023
JP
439 struct tcp_options_received *opt_rx,
440 int estab, struct tcp_fastopen_cookie *foc);
7d5d5525 441
9349d600
PP
442/*
443 * BPF SKB-less helpers
444 */
445u16 tcp_v4_get_syncookie(struct sock *sk, struct iphdr *iph,
446 struct tcphdr *th, u32 *cookie);
447u16 tcp_v6_get_syncookie(struct sock *sk, struct ipv6hdr *iph,
448 struct tcphdr *th, u32 *cookie);
33bf9885 449u16 tcp_parse_mss_option(const struct tcphdr *th, u16 user_mss);
9349d600
PP
450u16 tcp_get_syncookie_mss(struct request_sock_ops *rsk_ops,
451 const struct tcp_request_sock_ops *af_ops,
452 struct sock *sk, struct tcphdr *th);
1da177e4
LT
453/*
454 * TCP v4 functions exported for the inet6 API
455 */
456
5c9f3023 457void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
4fab9071 458void tcp_v4_mtu_reduced(struct sock *sk);
9cf74903 459void tcp_req_err(struct sock *sk, u32 seq, bool abort);
d2924569 460void tcp_ld_RTO_revert(struct sock *sk, u32 seq);
5c9f3023 461int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
c28c6f04 462struct sock *tcp_create_openreq_child(const struct sock *sk,
5c9f3023
JP
463 struct request_sock *req,
464 struct sk_buff *skb);
81164413 465void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
0c27171e 466struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb,
5c9f3023 467 struct request_sock *req,
5e0724d0
ED
468 struct dst_entry *dst,
469 struct request_sock *req_unhash,
470 bool *own_req);
5c9f3023
JP
471int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
472int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len);
473int tcp_connect(struct sock *sk);
b3d05147
ED
474enum tcp_synack_type {
475 TCP_SYNACK_NORMAL,
476 TCP_SYNACK_FASTOPEN,
477 TCP_SYNACK_COOKIE,
478};
5d062de7 479struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst,
5c9f3023 480 struct request_sock *req,
ca6fb065 481 struct tcp_fastopen_cookie *foc,
331fca43
MKL
482 enum tcp_synack_type synack_type,
483 struct sk_buff *syn_skb);
5c9f3023 484int tcp_disconnect(struct sock *sk, int flags);
1da177e4 485
370816ae 486void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
292e8d8c 487int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
63d02d15 488void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
1da177e4 489
1da177e4 490/* From syncookies.c */
b80c0e78
ED
491struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
492 struct request_sock *req,
efce3d1f 493 struct dst_entry *dst);
7577bc82 494int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th);
461b74c3 495struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
6fc8c827 496struct request_sock *cookie_tcp_reqsk_alloc(const struct request_sock_ops *ops,
8e7bab6b
KI
497 struct sock *sk, struct sk_buff *skb,
498 struct tcp_options_received *tcp_opt,
499 int mss, u32 tsoff);
500
e05c82d3 501#ifdef CONFIG_SYN_COOKIES
8c27bd75 502
63262315 503/* Syncookies use a monotonic timer which increments every 60 seconds.
8c27bd75
FW
504 * This counter is used both as a hash input and partially encoded into
505 * the cookie value. A cookie is only validated further if the delta
506 * between the current counter value and the encoded one is less than this,
63262315 507 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
8c27bd75
FW
508 * the counter advances immediately after a cookie is generated).
509 */
264ea103
ED
510#define MAX_SYNCOOKIE_AGE 2
511#define TCP_SYNCOOKIE_PERIOD (60 * HZ)
512#define TCP_SYNCOOKIE_VALID (MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)
513
514/* syncookies: remember time of last synqueue overflow
515 * But do not dirty this field too often (once per second is enough)
3f684b4b 516 * It is racy as we do not hold a lock, but race is very minor.
264ea103 517 */
3f684b4b 518static inline void tcp_synq_overflow(const struct sock *sk)
264ea103 519{
40a1227e 520 unsigned int last_overflow;
cca9bab1 521 unsigned int now = jiffies;
264ea103 522
40a1227e
MKL
523 if (sk->sk_reuseport) {
524 struct sock_reuseport *reuse;
525
526 reuse = rcu_dereference(sk->sk_reuseport_cb);
527 if (likely(reuse)) {
528 last_overflow = READ_ONCE(reuse->synq_overflow_ts);
04d26e7b
GN
529 if (!time_between32(now, last_overflow,
530 last_overflow + HZ))
40a1227e
MKL
531 WRITE_ONCE(reuse->synq_overflow_ts, now);
532 return;
533 }
534 }
535
721c8daf 536 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
04d26e7b 537 if (!time_between32(now, last_overflow, last_overflow + HZ))
e9d9da91 538 WRITE_ONCE(tcp_sk_rw(sk)->rx_opt.ts_recent_stamp, now);
264ea103
ED
539}
540
541/* syncookies: no recent synqueue overflow on this listening socket? */
542static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
543{
40a1227e 544 unsigned int last_overflow;
cca9bab1 545 unsigned int now = jiffies;
264ea103 546
40a1227e
MKL
547 if (sk->sk_reuseport) {
548 struct sock_reuseport *reuse;
549
550 reuse = rcu_dereference(sk->sk_reuseport_cb);
551 if (likely(reuse)) {
552 last_overflow = READ_ONCE(reuse->synq_overflow_ts);
cb44a08f
GN
553 return !time_between32(now, last_overflow - HZ,
554 last_overflow +
555 TCP_SYNCOOKIE_VALID);
40a1227e
MKL
556 }
557 }
558
721c8daf 559 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
cb44a08f
GN
560
561 /* If last_overflow <= jiffies <= last_overflow + TCP_SYNCOOKIE_VALID,
562 * then we're under synflood. However, we have to use
563 * 'last_overflow - HZ' as lower bound. That's because a concurrent
564 * tcp_synq_overflow() could update .ts_recent_stamp after we read
565 * jiffies but before we store .ts_recent_stamp into last_overflow,
566 * which could lead to rejecting a valid syncookie.
567 */
568 return !time_between32(now, last_overflow - HZ,
569 last_overflow + TCP_SYNCOOKIE_VALID);
264ea103 570}
8c27bd75
FW
571
572static inline u32 tcp_cookie_time(void)
573{
63262315
ED
574 u64 val = get_jiffies_64();
575
264ea103 576 do_div(val, TCP_SYNCOOKIE_PERIOD);
63262315 577 return val;
8c27bd75
FW
578}
579
5c9f3023
JP
580u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
581 u16 *mssp);
3f684b4b 582__u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss);
200ecef6 583u64 cookie_init_timestamp(struct request_sock *req, u64 now);
f9301034
ED
584bool cookie_timestamp_decode(const struct net *net,
585 struct tcp_options_received *opt);
8e7bab6b
KI
586
587static inline bool cookie_ecn_ok(const struct net *net, const struct dst_entry *dst)
588{
589 return READ_ONCE(net->ipv4.sysctl_tcp_ecn) ||
590 dst_feature(dst, RTAX_FEATURE_ECN);
591}
4dfc2817 592
c6aefafb 593/* From net/ipv6/syncookies.c */
7577bc82 594int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th);
5c9f3023 595struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
f1673381 596
5c9f3023
JP
597u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
598 const struct tcphdr *th, u16 *mssp);
3f684b4b 599__u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss);
e05c82d3 600#endif
1da177e4
LT
601/* tcp_output.c */
602
04d8825c
PA
603void tcp_skb_entail(struct sock *sk, struct sk_buff *skb);
604void tcp_mark_push(struct tcp_sock *tp, struct sk_buff *skb);
5c9f3023
JP
605void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
606 int nonagle);
10d3be56
ED
607int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
608int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
5c9f3023
JP
609void tcp_retransmit_timer(struct sock *sk);
610void tcp_xmit_retransmit_queue(struct sock *);
611void tcp_simple_retransmit(struct sock *);
57dde7f7 612void tcp_enter_recovery(struct sock *sk, bool ece_ack);
5c9f3023 613int tcp_trim_head(struct sock *, struct sk_buff *, u32);
75c119af
ED
614enum tcp_queue {
615 TCP_FRAG_IN_WRITE_QUEUE,
616 TCP_FRAG_IN_RTX_QUEUE,
617};
618int tcp_fragment(struct sock *sk, enum tcp_queue tcp_queue,
619 struct sk_buff *skb, u32 len,
620 unsigned int mss_now, gfp_t gfp);
5c9f3023
JP
621
622void tcp_send_probe0(struct sock *);
e520af48 623int tcp_write_wakeup(struct sock *, int mib);
5c9f3023
JP
624void tcp_send_fin(struct sock *sk);
625void tcp_send_active_reset(struct sock *sk, gfp_t priority);
626int tcp_send_synack(struct sock *);
5c9f3023 627void tcp_push_one(struct sock *, unsigned int mss_now);
27cde44a 628void __tcp_send_ack(struct sock *sk, u32 rcv_nxt);
5c9f3023
JP
629void tcp_send_ack(struct sock *sk);
630void tcp_send_delayed_ack(struct sock *sk);
631void tcp_send_loss_probe(struct sock *sk);
ed66dfaf 632bool tcp_schedule_loss_probe(struct sock *sk, bool advancing_rto);
cfea5a68
MKL
633void tcp_skb_collapse_tstamp(struct sk_buff *skb,
634 const struct sk_buff *next_skb);
1da177e4 635
a762a980 636/* tcp_input.c */
5c9f3023 637void tcp_rearm_rto(struct sock *sk);
0f1c28ae 638void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req);
049fe386 639void tcp_reset(struct sock *sk, struct sk_buff *skb);
e3e17b77 640void tcp_fin(struct sock *sk);
4bfe744f 641void tcp_check_space(struct sock *sk);
30c6f0bf 642void tcp_sack_compress_send_ack(struct sock *sk);
a762a980 643
1da177e4 644/* tcp_timer.c */
5c9f3023 645void tcp_init_xmit_timers(struct sock *);
463c84b9
ACM
646static inline void tcp_clear_xmit_timers(struct sock *sk)
647{
73a6bab5 648 if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1)
cf0dd203 649 __sock_put(sk);
73a6bab5 650
5d9f4262
ED
651 if (hrtimer_try_to_cancel(&tcp_sk(sk)->compressed_ack_timer) == 1)
652 __sock_put(sk);
653
463c84b9
ACM
654 inet_csk_clear_xmit_timers(sk);
655}
1da177e4 656
5c9f3023
JP
657unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
658unsigned int tcp_current_mss(struct sock *sk);
344db93a 659u32 tcp_clamp_probe0_to_user_timeout(const struct sock *sk, u32 when);
0c54b85f
IJ
660
661/* Bound MSS / TSO packet size with the half of the window */
662static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
663{
01f83d69
AK
664 int cutoff;
665
666 /* When peer uses tiny windows, there is no use in packetizing
667 * to sub-MSS pieces for the sake of SWS or making sure there
668 * are enough packets in the pipe for fast recovery.
669 *
670 * On the other hand, for extremely large MSS devices, handling
671 * smaller than MSS windows in this way does make sense.
672 */
2631b79f 673 if (tp->max_window > TCP_MSS_DEFAULT)
01f83d69
AK
674 cutoff = (tp->max_window >> 1);
675 else
676 cutoff = tp->max_window;
677
678 if (cutoff && pktsize > cutoff)
679 return max_t(int, cutoff, 68U - tp->tcp_header_len);
0c54b85f
IJ
680 else
681 return pktsize;
682}
1da177e4 683
17b085ea 684/* tcp.c */
0df48c26 685void tcp_get_info(struct sock *, struct tcp_info *);
1da177e4
LT
686
687/* Read 'sendfile()'-style from a TCP socket */
5c9f3023
JP
688int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
689 sk_read_actor_t recv_actor);
965b57b4 690int tcp_read_skb(struct sock *sk, skb_read_actor_t recv_actor);
3f92a64e
JK
691struct sk_buff *tcp_recv_skb(struct sock *sk, u32 seq, u32 *off);
692void tcp_read_done(struct sock *sk, size_t len);
1da177e4 693
5c9f3023 694void tcp_initialize_rcv_mss(struct sock *sk);
1da177e4 695
5c9f3023
JP
696int tcp_mtu_to_mss(struct sock *sk, int pmtu);
697int tcp_mss_to_mtu(struct sock *sk, int mss);
698void tcp_mtup_init(struct sock *sk);
5d424d5a 699
f1ecd5d9
DL
700static inline void tcp_bound_rto(const struct sock *sk)
701{
702 if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
703 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
704}
705
706static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
707{
740b0f18 708 return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
f1ecd5d9
DL
709}
710
31770e34
FW
711static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
712{
71158bb1
PA
713 /* mptcp hooks are only on the slow path */
714 if (sk_is_mptcp((struct sock *)tp))
715 return;
716
31770e34
FW
717 tp->pred_flags = htonl((tp->tcp_header_len << 26) |
718 ntohl(TCP_FLAG_ACK) |
719 snd_wnd);
720}
721
722static inline void tcp_fast_path_on(struct tcp_sock *tp)
723{
724 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
725}
726
727static inline void tcp_fast_path_check(struct sock *sk)
728{
729 struct tcp_sock *tp = tcp_sk(sk);
730
731 if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
732 tp->rcv_wnd &&
733 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
734 !tp->urg_data)
735 tcp_fast_path_on(tp);
736}
737
bbf80d71
ED
738u32 tcp_delack_max(const struct sock *sk);
739
0c266898 740/* Compute the actual rto_min value */
f68a181f 741static inline u32 tcp_rto_min(const struct sock *sk)
0c266898 742{
cf533ea5 743 const struct dst_entry *dst = __sk_dst_get(sk);
ca584ba0 744 u32 rto_min = inet_csk(sk)->icsk_rto_min;
0c266898
SS
745
746 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
747 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
748 return rto_min;
749}
750
f68a181f 751static inline u32 tcp_rto_min_us(const struct sock *sk)
740b0f18
ED
752{
753 return jiffies_to_usecs(tcp_rto_min(sk));
754}
755
81164413
DB
756static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
757{
758 return dst_metric_locked(dst, RTAX_CC_ALGO);
759}
760
f6722583
YC
761/* Minimum RTT in usec. ~0 means not available. */
762static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
763{
64033892 764 return minmax_get(&tp->rtt_min);
f6722583
YC
765}
766
1da177e4
LT
767/* Compute the actual receive window we are currently advertising.
768 * Rcv_nxt can be after the window if our peer push more data
769 * than the offered window.
770 */
40efc6fa 771static inline u32 tcp_receive_window(const struct tcp_sock *tp)
1da177e4
LT
772{
773 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
774
775 if (win < 0)
776 win = 0;
777 return (u32) win;
778}
779
780/* Choose a new window, without checks for shrinking, and without
781 * scaling applied to the result. The caller does these things
782 * if necessary. This is a "raw" window selection.
783 */
5c9f3023 784u32 __tcp_select_window(struct sock *sk);
1da177e4 785
ee995283
PE
786void tcp_send_window_probe(struct sock *sk);
787
ec66eda8
ED
788/* TCP uses 32bit jiffies to save some space.
789 * Note that this is different from tcp_time_stamp, which
790 * historically has been the same until linux-4.13.
791 */
792#define tcp_jiffies32 ((u32)jiffies)
793
9a568de4
ED
794/*
795 * Deliver a 32bit value for TCP timestamp option (RFC 7323)
796 * It is no longer tied to jiffies, but to 1 ms clock.
797 * Note: double check if you want to use tcp_jiffies32 instead of this.
798 */
799#define TCP_TS_HZ 1000
800
801static inline u64 tcp_clock_ns(void)
802{
fb420d5d 803 return ktime_get_ns();
9a568de4
ED
804}
805
806static inline u64 tcp_clock_us(void)
807{
808 return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
809}
810
2a7c8d29
ED
811static inline u64 tcp_clock_ms(void)
812{
813 return div_u64(tcp_clock_ns(), NSEC_PER_MSEC);
814}
815
16cf6477
ED
816/* TCP Timestamp included in TS option (RFC 1323) can either use ms
817 * or usec resolution. Each socket carries a flag to select one or other
818 * resolution, as the route attribute could change anytime.
819 * Each flow must stick to initial resolution.
820 */
821static inline u32 tcp_clock_ts(bool usec_ts)
822{
823 return usec_ts ? tcp_clock_us() : tcp_clock_ms();
824}
825
9d0c00f5 826static inline u32 tcp_time_stamp_ms(const struct tcp_sock *tp)
9a568de4 827{
9d0c00f5 828 return div_u64(tp->tcp_mstamp, USEC_PER_MSEC);
9a568de4
ED
829}
830
9d0c00f5 831static inline u32 tcp_time_stamp_ts(const struct tcp_sock *tp)
99d67955 832{
614e8316
ED
833 if (tp->tcp_usec_ts)
834 return tp->tcp_mstamp;
9d0c00f5 835 return tcp_time_stamp_ms(tp);
99d67955
ED
836}
837
9799ccb0 838void tcp_mstamp_refresh(struct tcp_sock *tp);
9a568de4
ED
839
840static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
841{
842 return max_t(s64, t1 - t0, 0);
843}
1da177e4 844
2fd66ffb
ED
845/* provide the departure time in us unit */
846static inline u64 tcp_skb_timestamp_us(const struct sk_buff *skb)
847{
d3edd06e 848 return div_u64(skb->skb_mstamp_ns, NSEC_PER_USEC);
2fd66ffb
ED
849}
850
d1a02ed6
ED
851/* Provide skb TSval in usec or ms unit */
852static inline u32 tcp_skb_timestamp_ts(bool usec_ts, const struct sk_buff *skb)
853{
854 if (usec_ts)
855 return tcp_skb_timestamp_us(skb);
856
857 return div_u64(skb->skb_mstamp_ns, NSEC_PER_MSEC);
858}
859
16cf6477
ED
860static inline u32 tcp_tw_tsval(const struct tcp_timewait_sock *tcptw)
861{
614e8316 862 return tcp_clock_ts(tcptw->tw_sk.tw_usec_ts) + tcptw->tw_ts_offset;
16cf6477
ED
863}
864
865static inline u32 tcp_rsk_tsval(const struct tcp_request_sock *treq)
866{
614e8316 867 return tcp_clock_ts(treq->req_usec_ts) + treq->ts_off;
16cf6477 868}
7faee5c0 869
a3433f35
CG
870#define tcp_flag_byte(th) (((u_int8_t *)th)[13])
871
872#define TCPHDR_FIN 0x01
873#define TCPHDR_SYN 0x02
874#define TCPHDR_RST 0x04
875#define TCPHDR_PSH 0x08
876#define TCPHDR_ACK 0x10
877#define TCPHDR_URG 0x20
878#define TCPHDR_ECE 0x40
879#define TCPHDR_CWR 0x80
880
49213555
DB
881#define TCPHDR_SYN_ECN (TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)
882
caa20d9a 883/* This is what the send packet queuing engine uses to pass
f86586fa
ED
884 * TCP per-packet control information to the transmission code.
885 * We also store the host-order sequence numbers in here too.
886 * This is 44 bytes if IPV6 is enabled.
887 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
1da177e4
LT
888 */
889struct tcp_skb_cb {
1da177e4
LT
890 __u32 seq; /* Starting sequence number */
891 __u32 end_seq; /* SEQ + FIN + SYN + datalen */
cd7d8498
ED
892 union {
893 /* Note : tcp_tw_isn is used in input path only
894 * (isn chosen by tcp_timewait_state_process())
895 *
f69ad292
ED
896 * tcp_gso_segs/size are used in write queue only,
897 * cf tcp_skb_pcount()/tcp_skb_mss()
cd7d8498
ED
898 */
899 __u32 tcp_tw_isn;
f69ad292
ED
900 struct {
901 u16 tcp_gso_segs;
902 u16 tcp_gso_size;
903 };
cd7d8498 904 };
4de075e0 905 __u8 tcp_flags; /* TCP header flags. (tcp[13]) */
f4f9f6e7 906
713bafea 907 __u8 sacked; /* State flags for SACK. */
1da177e4
LT
908#define TCPCB_SACKED_ACKED 0x01 /* SKB ACK'd by a SACK block */
909#define TCPCB_SACKED_RETRANS 0x02 /* SKB retransmitted */
910#define TCPCB_LOST 0x04 /* SKB is lost */
911#define TCPCB_TAGBITS 0x07 /* All tag bits */
d3edd06e 912#define TCPCB_REPAIRED 0x10 /* SKB repaired (no skb_mstamp_ns) */
1da177e4 913#define TCPCB_EVER_RETRANS 0x80 /* Ever retransmitted frame */
9d186cac
AV
914#define TCPCB_RETRANS (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
915 TCPCB_REPAIRED)
1da177e4 916
f4f9f6e7 917 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */
6b084928 918 __u8 txstamp_ack:1, /* Record TX timestamp for ack? */
c134ecb8 919 eor:1, /* Is skb MSG_EOR marked? */
98aaa913
MM
920 has_rxtstamp:1, /* SKB has a RX timestamp */
921 unused:5;
1da177e4 922 __u32 ack_seq; /* Sequence number ACK'd */
971f10ec 923 union {
b75803d5 924 struct {
40bc6063 925#define TCPCB_DELIVERED_CE_MASK ((1U<<20) - 1)
b9f64820 926 /* There is space for up to 24 bytes */
40bc6063
YC
927 __u32 is_app_limited:1, /* cwnd not fully used? */
928 delivered_ce:20,
929 unused:11;
b9f64820
YC
930 /* pkts S/ACKed so far upon tx of skb, incl retrans: */
931 __u32 delivered;
932 /* start of send pipeline phase */
9a568de4 933 u64 first_tx_mstamp;
b9f64820 934 /* when we reached the "delivered" count */
9a568de4 935 u64 delivered_mstamp;
b75803d5
LB
936 } tx; /* only used for outgoing skbs */
937 union {
938 struct inet_skb_parm h4;
971f10ec 939#if IS_ENABLED(CONFIG_IPV6)
b75803d5 940 struct inet6_skb_parm h6;
971f10ec 941#endif
b75803d5
LB
942 } header; /* For incoming skbs */
943 };
1da177e4
LT
944};
945
946#define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0]))
947
9b9e2f25
ED
948extern const struct inet_connection_sock_af_ops ipv4_specific;
949
815afe17 950#if IS_ENABLED(CONFIG_IPV6)
870c3151
ED
951/* This is the variant of inet6_iif() that must be used by TCP,
952 * as TCP moves IP6CB into a different location in skb->cb[]
953 */
954static inline int tcp_v6_iif(const struct sk_buff *skb)
24b711ed
DA
955{
956 return TCP_SKB_CB(skb)->header.h6.iif;
957}
958
959static inline int tcp_v6_iif_l3_slave(const struct sk_buff *skb)
870c3151 960{
a04a480d 961 bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
74b20582
DA
962
963 return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
870c3151 964}
4297a0ef
DA
965
966/* TCP_SKB_CB reference means this can not be used from early demux */
967static inline int tcp_v6_sdif(const struct sk_buff *skb)
968{
969#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
970 if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags))
971 return TCP_SKB_CB(skb)->header.h6.iif;
972#endif
973 return 0;
974}
dd2e0b86 975
b03d2142
ED
976extern const struct inet_connection_sock_af_ops ipv6_specific;
977
dd2e0b86 978INDIRECT_CALLABLE_DECLARE(void tcp_v6_send_check(struct sock *sk, struct sk_buff *skb));
243600ee 979INDIRECT_CALLABLE_DECLARE(int tcp_v6_rcv(struct sk_buff *skb));
11052589 980void tcp_v6_early_demux(struct sk_buff *skb);
dd2e0b86 981
815afe17 982#endif
870c3151 983
3fa6f616
DA
984/* TCP_SKB_CB reference means this can not be used from early demux */
985static inline int tcp_v4_sdif(struct sk_buff *skb)
986{
987#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
988 if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
989 return TCP_SKB_CB(skb)->header.h4.iif;
990#endif
991 return 0;
992}
993
1da177e4
LT
994/* Due to TSO, an SKB can be composed of multiple actual
995 * packets. To keep these tracked properly, we use this.
bd14b1b2 996 */
1da177e4 997static inline int tcp_skb_pcount(const struct sk_buff *skb)
bd14b1b2 998{
cd7d8498
ED
999 return TCP_SKB_CB(skb)->tcp_gso_segs;
1000}
bd14b1b2 1001
cd7d8498
ED
1002static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
1003{
1004 TCP_SKB_CB(skb)->tcp_gso_segs = segs;
bd14b1b2
ED
1005}
1006
cd7d8498 1007static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
1da177e4 1008{
cd7d8498 1009 TCP_SKB_CB(skb)->tcp_gso_segs += segs;
1da177e4
LT
1010}
1011
f69ad292 1012/* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
1da177e4
LT
1013static inline int tcp_skb_mss(const struct sk_buff *skb)
1014{
f69ad292 1015 return TCP_SKB_CB(skb)->tcp_gso_size;
1da177e4
LT
1016}
1017
c134ecb8
MKL
1018static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
1019{
1020 return likely(!TCP_SKB_CB(skb)->eor);
1021}
1022
85712484
MM
1023static inline bool tcp_skb_can_collapse(const struct sk_buff *to,
1024 const struct sk_buff *from)
1025{
1026 return likely(tcp_skb_can_collapse_to(to) &&
9b65b17d
TA
1027 mptcp_skb_can_collapse(to, from) &&
1028 skb_pure_zcopy_same(to, from));
85712484
MM
1029}
1030
317a76f9
SH
1031/* Events passed to congestion control interface */
1032enum tcp_ca_event {
1033 CA_EVENT_TX_START, /* first transmit when no packets in flight */
1034 CA_EVENT_CWND_RESTART, /* congestion window restart */
1035 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */
317a76f9 1036 CA_EVENT_LOSS, /* loss timeout */
9890092e
FW
1037 CA_EVENT_ECN_NO_CE, /* ECT set, but not CE marked */
1038 CA_EVENT_ECN_IS_CE, /* received CE marked IP packet */
7354c8c3
FW
1039};
1040
9890092e 1041/* Information about inbound ACK, passed to cong_ops->in_ack_event() */
7354c8c3 1042enum tcp_ca_ack_event_flags {
c1d2b4c3
FW
1043 CA_ACK_SLOWPATH = (1 << 0), /* In slow path processing */
1044 CA_ACK_WIN_UPDATE = (1 << 1), /* ACK updated window */
1045 CA_ACK_ECE = (1 << 2), /* ECE bit is set on ack */
317a76f9
SH
1046};
1047
1048/*
1049 * Interface for adding new TCP congestion control handlers
1050 */
1051#define TCP_CA_NAME_MAX 16
3ff825b2
SH
1052#define TCP_CA_MAX 128
1053#define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX)
1054
c5c6a8ab
DB
1055#define TCP_CA_UNSPEC 0
1056
30e502a3 1057/* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
164891aa 1058#define TCP_CONG_NON_RESTRICTED 0x1
30e502a3
DB
1059/* Requires ECN/ECT set on all packets */
1060#define TCP_CONG_NEEDS_ECN 0x2
0baf26b0 1061#define TCP_CONG_MASK (TCP_CONG_NON_RESTRICTED | TCP_CONG_NEEDS_ECN)
164891aa 1062
64f40ff5
ED
1063union tcp_cc_info;
1064
756ee172
LB
1065struct ack_sample {
1066 u32 pkts_acked;
1067 s32 rtt_us;
6f094b9e 1068 u32 in_flight;
756ee172
LB
1069};
1070
b9f64820
YC
1071/* A rate sample measures the number of (original/retransmitted) data
1072 * packets delivered "delivered" over an interval of time "interval_us".
1073 * The tcp_rate.c code fills in the rate sample, and congestion
1074 * control modules that define a cong_control function to run at the end
1075 * of ACK processing can optionally chose to consult this sample when
1076 * setting cwnd and pacing rate.
1077 * A sample is invalid if "delivered" or "interval_us" is negative.
1078 */
1079struct rate_sample {
9a568de4 1080 u64 prior_mstamp; /* starting timestamp for interval */
b9f64820 1081 u32 prior_delivered; /* tp->delivered at "prior_mstamp" */
40bc6063 1082 u32 prior_delivered_ce;/* tp->delivered_ce at "prior_mstamp" */
b9f64820 1083 s32 delivered; /* number of packets delivered over interval */
40bc6063 1084 s32 delivered_ce; /* number of packets delivered w/ CE marks*/
b9f64820 1085 long interval_us; /* time for tp->delivered to incr "delivered" */
4929c942
DR
1086 u32 snd_interval_us; /* snd interval for delivered packets */
1087 u32 rcv_interval_us; /* rcv interval for delivered packets */
b9f64820
YC
1088 long rtt_us; /* RTT of last (S)ACKed packet (or -1) */
1089 int losses; /* number of packets marked lost upon ACK */
1090 u32 acked_sacked; /* number of packets newly (S)ACKed upon ACK */
1091 u32 prior_in_flight; /* in flight before this ACK */
b253a068 1092 u32 last_end_seq; /* end_seq of most recently ACKed packet */
d7722e85 1093 bool is_app_limited; /* is sample from packet with bubble in pipe? */
b9f64820 1094 bool is_retrans; /* is sample from retransmission? */
e4286603 1095 bool is_ack_delayed; /* is this (likely) a delayed ACK? */
b9f64820
YC
1096};
1097
317a76f9 1098struct tcp_congestion_ops {
82506665 1099/* fast path fields are put first to fill one cache line */
317a76f9
SH
1100
1101 /* return slow start threshold (required) */
6687e988 1102 u32 (*ssthresh)(struct sock *sk);
82506665 1103
317a76f9 1104 /* do new cwnd calculation (required) */
24901551 1105 void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
82506665 1106
317a76f9 1107 /* call before changing ca_state (optional) */
6687e988 1108 void (*set_state)(struct sock *sk, u8 new_state);
82506665 1109
317a76f9 1110 /* call when cwnd event occurs (optional) */
6687e988 1111 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
82506665 1112
7354c8c3
FW
1113 /* call when ack arrives (optional) */
1114 void (*in_ack_event)(struct sock *sk, u32 flags);
82506665 1115
317a76f9 1116 /* hook for packet ack accounting (optional) */
756ee172 1117 void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
82506665 1118
dcb8c9b4
ED
1119 /* override sysctl_tcp_min_tso_segs */
1120 u32 (*min_tso_segs)(struct sock *sk);
82506665 1121
c0402760
YC
1122 /* call when packets are delivered to update cwnd and pacing rate,
1123 * after all the ca_state processing. (optional)
1124 */
1125 void (*cong_control)(struct sock *sk, const struct rate_sample *rs);
82506665
ED
1126
1127
1128 /* new value of cwnd after loss (required) */
1129 u32 (*undo_cwnd)(struct sock *sk);
1130 /* returns the multiplier used in tcp_sndbuf_expand (optional) */
1131 u32 (*sndbuf_expand)(struct sock *sk);
1132
1133/* control/slow paths put last */
73c1f4a0 1134 /* get info for inet_diag (optional) */
64f40ff5
ED
1135 size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
1136 union tcp_cc_info *info);
317a76f9 1137
82506665
ED
1138 char name[TCP_CA_NAME_MAX];
1139 struct module *owner;
1140 struct list_head list;
1141 u32 key;
1142 u32 flags;
1143
1144 /* initialize private data (optional) */
1145 void (*init)(struct sock *sk);
1146 /* cleanup private data (optional) */
1147 void (*release)(struct sock *sk);
1148} ____cacheline_aligned_in_smp;
317a76f9 1149
5c9f3023
JP
1150int tcp_register_congestion_control(struct tcp_congestion_ops *type);
1151void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
8fb1a76a
KFL
1152int tcp_update_congestion_control(struct tcp_congestion_ops *type,
1153 struct tcp_congestion_ops *old_type);
1154int tcp_validate_congestion_control(struct tcp_congestion_ops *ca);
317a76f9 1155
55d8694f 1156void tcp_assign_congestion_control(struct sock *sk);
5c9f3023
JP
1157void tcp_init_congestion_control(struct sock *sk);
1158void tcp_cleanup_congestion_control(struct sock *sk);
6670e152
SH
1159int tcp_set_default_congestion_control(struct net *net, const char *name);
1160void tcp_get_default_congestion_control(struct net *net, char *name);
5c9f3023
JP
1161void tcp_get_available_congestion_control(char *buf, size_t len);
1162void tcp_get_allowed_congestion_control(char *buf, size_t len);
1163int tcp_set_allowed_congestion_control(char *allowed);
8d650cde 1164int tcp_set_congestion_control(struct sock *sk, const char *name, bool load,
29a94932 1165 bool cap_net_admin);
e73ebb08
NC
1166u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
1167void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
317a76f9 1168
5c9f3023 1169u32 tcp_reno_ssthresh(struct sock *sk);
e9799183 1170u32 tcp_reno_undo_cwnd(struct sock *sk);
24901551 1171void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
a8acfbac 1172extern struct tcp_congestion_ops tcp_reno;
317a76f9 1173
0baf26b0 1174struct tcp_congestion_ops *tcp_ca_find(const char *name);
c5c6a8ab 1175struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
6670e152 1176u32 tcp_ca_get_key_by_name(struct net *net, const char *name, bool *ecn_ca);
ea697639 1177#ifdef CONFIG_INET
c5c6a8ab 1178char *tcp_ca_get_name_by_key(u32 key, char *buffer);
ea697639
DB
1179#else
1180static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
1181{
1182 return NULL;
1183}
1184#endif
c5c6a8ab 1185
30e502a3
DB
1186static inline bool tcp_ca_needs_ecn(const struct sock *sk)
1187{
1188 const struct inet_connection_sock *icsk = inet_csk(sk);
1189
1190 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
1191}
1192
6687e988 1193static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
317a76f9 1194{
6687e988
ACM
1195 const struct inet_connection_sock *icsk = inet_csk(sk);
1196
1197 if (icsk->icsk_ca_ops->cwnd_event)
1198 icsk->icsk_ca_ops->cwnd_event(sk, event);
317a76f9
SH
1199}
1200
15fcdf6a
PG
1201/* From tcp_cong.c */
1202void tcp_set_ca_state(struct sock *sk, const u8 ca_state);
1203
b9f64820
YC
1204/* From tcp_rate.c */
1205void tcp_rate_skb_sent(struct sock *sk, struct sk_buff *skb);
1206void tcp_rate_skb_delivered(struct sock *sk, struct sk_buff *skb,
1207 struct rate_sample *rs);
1208void tcp_rate_gen(struct sock *sk, u32 delivered, u32 lost,
d4761754 1209 bool is_sack_reneg, struct rate_sample *rs);
d7722e85 1210void tcp_rate_check_app_limited(struct sock *sk);
b9f64820 1211
b253a068
PY
1212static inline bool tcp_skb_sent_after(u64 t1, u64 t2, u32 seq1, u32 seq2)
1213{
1214 return t1 > t2 || (t1 == t2 && after(seq1, seq2));
1215}
1216
e60402d0
IJ
1217/* These functions determine how the current flow behaves in respect of SACK
1218 * handling. SACK is negotiated with the peer, and therefore it can vary
1219 * between different flows.
1220 *
1221 * tcp_is_sack - SACK enabled
1222 * tcp_is_reno - No SACK
e60402d0
IJ
1223 */
1224static inline int tcp_is_sack(const struct tcp_sock *tp)
1225{
ebeef4bc 1226 return likely(tp->rx_opt.sack_ok);
e60402d0
IJ
1227}
1228
a2a385d6 1229static inline bool tcp_is_reno(const struct tcp_sock *tp)
e60402d0
IJ
1230{
1231 return !tcp_is_sack(tp);
1232}
1233
83ae4088
IJ
1234static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
1235{
1236 return tp->sacked_out + tp->lost_out;
1237}
1238
1da177e4
LT
1239/* This determines how many packets are "in the network" to the best
1240 * of our knowledge. In many cases it is conservative, but where
1241 * detailed information is available from the receiver (via SACK
1242 * blocks etc.) we can make more aggressive calculations.
1243 *
1244 * Use this for decisions involving congestion control, use just
1245 * tp->packets_out to determine if the send queue is empty or not.
1246 *
1247 * Read this equation as:
1248 *
1249 * "Packets sent once on transmission queue" MINUS
1250 * "Packets left network, but not honestly ACKed yet" PLUS
1251 * "Packets fast retransmitted"
1252 */
40efc6fa 1253static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
1da177e4 1254{
83ae4088 1255 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
1da177e4
LT
1256}
1257
0b6a05c1
IJ
1258#define TCP_INFINITE_SSTHRESH 0x7fffffff
1259
40570375
ED
1260static inline u32 tcp_snd_cwnd(const struct tcp_sock *tp)
1261{
1262 return tp->snd_cwnd;
1263}
1264
1265static inline void tcp_snd_cwnd_set(struct tcp_sock *tp, u32 val)
1266{
1267 WARN_ON_ONCE((int)val <= 0);
1268 tp->snd_cwnd = val;
1269}
1270
071d5080
YC
1271static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
1272{
40570375 1273 return tcp_snd_cwnd(tp) < tp->snd_ssthresh;
071d5080
YC
1274}
1275
0b6a05c1
IJ
1276static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
1277{
1278 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
1279}
1280
684bad11
YC
1281static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
1282{
1283 return (TCPF_CA_CWR | TCPF_CA_Recovery) &
1284 (1 << inet_csk(sk)->icsk_ca_state);
1285}
1286
1da177e4 1287/* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
684bad11 1288 * The exception is cwnd reduction phase, when cwnd is decreasing towards
1da177e4
LT
1289 * ssthresh.
1290 */
6687e988 1291static inline __u32 tcp_current_ssthresh(const struct sock *sk)
1da177e4 1292{
6687e988 1293 const struct tcp_sock *tp = tcp_sk(sk);
cf533ea5 1294
684bad11 1295 if (tcp_in_cwnd_reduction(sk))
1da177e4
LT
1296 return tp->snd_ssthresh;
1297 else
1298 return max(tp->snd_ssthresh,
40570375
ED
1299 ((tcp_snd_cwnd(tp) >> 1) +
1300 (tcp_snd_cwnd(tp) >> 2)));
1da177e4
LT
1301}
1302
b9c4595b
IJ
1303/* Use define here intentionally to get WARN_ON location shown at the caller */
1304#define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
1da177e4 1305
5ee2c941 1306void tcp_enter_cwr(struct sock *sk);
5c9f3023 1307__u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
1da177e4 1308
6b5a5c0d
NC
1309/* The maximum number of MSS of available cwnd for which TSO defers
1310 * sending if not using sysctl_tcp_tso_win_divisor.
1311 */
1312static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1313{
1314 return 3;
1315}
1316
90840def
IJ
1317/* Returns end sequence number of the receiver's advertised window */
1318static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1319{
1320 return tp->snd_una + tp->snd_wnd;
1321}
e114a710
ED
1322
1323/* We follow the spirit of RFC2861 to validate cwnd but implement a more
1324 * flexible approach. The RFC suggests cwnd should not be raised unless
ca8a2263
NC
1325 * it was fully used previously. And that's exactly what we do in
1326 * congestion avoidance mode. But in slow start we allow cwnd to grow
1327 * as long as the application has used half the cwnd.
e114a710
ED
1328 * Example :
1329 * cwnd is 10 (IW10), but application sends 9 frames.
1330 * We allow cwnd to reach 18 when all frames are ACKed.
1331 * This check is safe because it's as aggressive as slow start which already
1332 * risks 100% overshoot. The advantage is that we discourage application to
1333 * either send more filler packets or data to artificially blow up the cwnd
1334 * usage, and allow application-limited process to probe bw more aggressively.
e114a710 1335 */
24901551 1336static inline bool tcp_is_cwnd_limited(const struct sock *sk)
e114a710
ED
1337{
1338 const struct tcp_sock *tp = tcp_sk(sk);
1339
f4ce91ce
NC
1340 if (tp->is_cwnd_limited)
1341 return true;
1342
ca8a2263 1343 /* If in slow start, ensure cwnd grows to twice what was ACKed. */
071d5080 1344 if (tcp_in_slow_start(tp))
40570375 1345 return tcp_snd_cwnd(tp) < 2 * tp->max_packets_out;
ca8a2263 1346
f4ce91ce 1347 return false;
e114a710 1348}
f4805ede 1349
cadefe5f
ED
1350/* BBR congestion control needs pacing.
1351 * Same remark for SO_MAX_PACING_RATE.
1352 * sch_fq packet scheduler is efficiently handling pacing,
1353 * but is not always installed/used.
1354 * Return true if TCP stack should pace packets itself.
1355 */
1356static inline bool tcp_needs_internal_pacing(const struct sock *sk)
1357{
1358 return smp_load_acquire(&sk->sk_pacing_status) == SK_PACING_NEEDED;
1359}
1360
8dc242ad
ED
1361/* Estimates in how many jiffies next packet for this flow can be sent.
1362 * Scheduling a retransmit timer too early would be silly.
3f80e08f 1363 */
8dc242ad 1364static inline unsigned long tcp_pacing_delay(const struct sock *sk)
3f80e08f 1365{
8dc242ad 1366 s64 delay = tcp_sk(sk)->tcp_wstamp_ns - tcp_sk(sk)->tcp_clock_cache;
3f80e08f 1367
8dc242ad 1368 return delay > 0 ? nsecs_to_jiffies(delay) : 0;
3f80e08f
ED
1369}
1370
1371static inline void tcp_reset_xmit_timer(struct sock *sk,
1372 const int what,
1373 unsigned long when,
8dc242ad 1374 const unsigned long max_when)
3f80e08f 1375{
8dc242ad 1376 inet_csk_reset_xmit_timer(sk, what, when + tcp_pacing_delay(sk),
3f80e08f
ED
1377 max_when);
1378}
1379
21c8fe99 1380/* Something is really bad, we could not queue an additional packet,
3f80e08f 1381 * because qdisc is full or receiver sent a 0 window, or we are paced.
21c8fe99
ED
1382 * We do not want to add fuel to the fire, or abort too early,
1383 * so make sure the timer we arm now is at least 200ms in the future,
1384 * regardless of current icsk_rto value (as it could be ~2ms)
1385 */
1386static inline unsigned long tcp_probe0_base(const struct sock *sk)
1da177e4 1387{
21c8fe99
ED
1388 return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1389}
9e412ba7 1390
21c8fe99
ED
1391/* Variant of inet_csk_rto_backoff() used for zero window probes */
1392static inline unsigned long tcp_probe0_when(const struct sock *sk,
1393 unsigned long max_when)
1394{
6d4634d1
CZ
1395 u8 backoff = min_t(u8, ilog2(TCP_RTO_MAX / TCP_RTO_MIN) + 1,
1396 inet_csk(sk)->icsk_backoff);
1397 u64 when = (u64)tcp_probe0_base(sk) << backoff;
21c8fe99
ED
1398
1399 return (unsigned long)min_t(u64, when, max_when);
1400}
1401
1402static inline void tcp_check_probe_timer(struct sock *sk)
1403{
1404 if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
3f80e08f 1405 tcp_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
8dc242ad 1406 tcp_probe0_base(sk), TCP_RTO_MAX);
1da177e4
LT
1407}
1408
ee7537b6 1409static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1410{
1411 tp->snd_wl1 = seq;
1412}
1413
ee7537b6 1414static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1415{
1416 tp->snd_wl1 = seq;
1417}
1418
1da177e4
LT
1419/*
1420 * Calculate(/check) TCP checksum
1421 */
ba7808ea
FD
1422static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1423 __be32 daddr, __wsum base)
1da177e4 1424{
0b13c9bb 1425 return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_TCP, base);
1da177e4
LT
1426}
1427
a2a385d6 1428static inline bool tcp_checksum_complete(struct sk_buff *skb)
1da177e4 1429{
60476372 1430 return !skb_csum_unnecessary(skb) &&
6ab6dfa6 1431 __skb_checksum_complete(skb);
1da177e4
LT
1432}
1433
7a26dc9e
MD
1434bool tcp_add_backlog(struct sock *sk, struct sk_buff *skb,
1435 enum skb_drop_reason *reason);
f35f8219 1436
f35f8219 1437
ac6e7800 1438int tcp_filter(struct sock *sk, struct sk_buff *skb);
5c9f3023 1439void tcp_set_state(struct sock *sk, int state);
5c9f3023 1440void tcp_done(struct sock *sk);
c1e64e29
LC
1441int tcp_abort(struct sock *sk, int err);
1442
40efc6fa 1443static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1da177e4
LT
1444{
1445 rx_opt->dsack = 0;
1da177e4
LT
1446 rx_opt->num_sacks = 0;
1447}
1448
6f021c62
ED
1449void tcp_cwnd_restart(struct sock *sk, s32 delta);
1450
1451static inline void tcp_slow_start_after_idle_check(struct sock *sk)
1452{
1b1fc3fd 1453 const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
6f021c62
ED
1454 struct tcp_sock *tp = tcp_sk(sk);
1455 s32 delta;
1456
4845b571
KI
1457 if (!READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle) ||
1458 tp->packets_out || ca_ops->cong_control)
6f021c62 1459 return;
d635fbe2 1460 delta = tcp_jiffies32 - tp->lsndtime;
6f021c62
ED
1461 if (delta > inet_csk(sk)->icsk_rto)
1462 tcp_cwnd_restart(sk, delta);
1463}
85f16525 1464
1da177e4 1465/* Determine a window scaling and initial window to offer. */
ceef9ab6
ED
1466void tcp_select_initial_window(const struct sock *sk, int __space,
1467 __u32 mss, __u32 *rcv_wnd,
5c9f3023
JP
1468 __u32 *window_clamp, int wscale_ok,
1469 __u8 *rcv_wscale, __u32 init_rcv_wnd);
1da177e4 1470
b8dc6d6c 1471static inline int __tcp_win_from_space(u8 scaling_ratio, int space)
1da177e4 1472{
b8dc6d6c 1473 s64 scaled_space = (s64)space * scaling_ratio;
c4836742 1474
dfa2f048
ED
1475 return scaled_space >> TCP_RMEM_TO_WIN_SCALE;
1476}
1477
b8dc6d6c
PA
1478static inline int tcp_win_from_space(const struct sock *sk, int space)
1479{
1480 return __tcp_win_from_space(tcp_sk(sk)->scaling_ratio, space);
1481}
1482
1483/* inverse of __tcp_win_from_space() */
1484static inline int __tcp_space_from_win(u8 scaling_ratio, int win)
dfa2f048
ED
1485{
1486 u64 val = (u64)win << TCP_RMEM_TO_WIN_SCALE;
1487
b8dc6d6c 1488 do_div(val, scaling_ratio);
dfa2f048
ED
1489 return val;
1490}
1491
b8dc6d6c
PA
1492static inline int tcp_space_from_win(const struct sock *sk, int win)
1493{
1494 return __tcp_space_from_win(tcp_sk(sk)->scaling_ratio, win);
1495}
1496
849ee75a
PA
1497/* Assume a conservative default of 1200 bytes of payload per 4K page.
1498 * This may be adjusted later in tcp_measure_rcv_mss().
1499 */
1500#define TCP_DEFAULT_SCALING_RATIO ((1200 << TCP_RMEM_TO_WIN_SCALE) / \
1501 SKB_TRUESIZE(4096))
1502
dfa2f048
ED
1503static inline void tcp_scaling_ratio_init(struct sock *sk)
1504{
849ee75a 1505 tcp_sk(sk)->scaling_ratio = TCP_DEFAULT_SCALING_RATIO;
1da177e4
LT
1506}
1507
105970f6 1508/* Note: caller must be prepared to deal with negative returns */
1da177e4
LT
1509static inline int tcp_space(const struct sock *sk)
1510{
ebb3b78d 1511 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) -
70c26558 1512 READ_ONCE(sk->sk_backlog.len) -
1da177e4 1513 atomic_read(&sk->sk_rmem_alloc));
105970f6 1514}
1da177e4
LT
1515
1516static inline int tcp_full_space(const struct sock *sk)
1517{
ebb3b78d 1518 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf));
1da177e4
LT
1519}
1520
58d3aade 1521static inline void __tcp_adjust_rcv_ssthresh(struct sock *sk, u32 new_ssthresh)
053f3684
WW
1522{
1523 int unused_mem = sk_unused_reserved_mem(sk);
1524 struct tcp_sock *tp = tcp_sk(sk);
1525
58d3aade 1526 tp->rcv_ssthresh = min(tp->rcv_ssthresh, new_ssthresh);
053f3684
WW
1527 if (unused_mem)
1528 tp->rcv_ssthresh = max_t(u32, tp->rcv_ssthresh,
1529 tcp_win_from_space(sk, unused_mem));
1530}
1531
58d3aade
PA
1532static inline void tcp_adjust_rcv_ssthresh(struct sock *sk)
1533{
1534 __tcp_adjust_rcv_ssthresh(sk, 4U * tcp_sk(sk)->advmss);
1535}
1536
c76c6956 1537void tcp_cleanup_rbuf(struct sock *sk, int copied);
e5c6de5f
JF
1538void __tcp_cleanup_rbuf(struct sock *sk, int copied);
1539
c76c6956 1540
24adbc16
ED
1541/* We provision sk_rcvbuf around 200% of sk_rcvlowat.
1542 * If 87.5 % (7/8) of the space has been consumed, we want to override
1543 * SO_RCVLOWAT constraint, since we are receiving skbs with too small
1544 * len/truesize ratio.
1545 */
1546static inline bool tcp_rmem_pressure(const struct sock *sk)
1547{
f969dc5a
ED
1548 int rcvbuf, threshold;
1549
1550 if (tcp_under_memory_pressure(sk))
1551 return true;
1552
1553 rcvbuf = READ_ONCE(sk->sk_rcvbuf);
1554 threshold = rcvbuf - (rcvbuf >> 3);
24adbc16
ED
1555
1556 return atomic_read(&sk->sk_rmem_alloc) > threshold;
1557}
1558
05dc72ab
ED
1559static inline bool tcp_epollin_ready(const struct sock *sk, int target)
1560{
1561 const struct tcp_sock *tp = tcp_sk(sk);
1562 int avail = READ_ONCE(tp->rcv_nxt) - READ_ONCE(tp->copied_seq);
1563
1564 if (avail <= 0)
1565 return false;
1566
1567 return (avail >= target) || tcp_rmem_pressure(sk) ||
1568 (tcp_receive_window(tp) <= inet_csk(sk)->icsk_ack.rcv_mss);
1569}
1570
843f4a55 1571extern void tcp_openreq_init_rwin(struct request_sock *req,
b1964b5f
ED
1572 const struct sock *sk_listener,
1573 const struct dst_entry *dst);
843f4a55 1574
5c9f3023 1575void tcp_enter_memory_pressure(struct sock *sk);
06044751 1576void tcp_leave_memory_pressure(struct sock *sk);
1da177e4 1577
1da177e4
LT
1578static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1579{
b840d15d 1580 struct net *net = sock_net((struct sock *)tp);
5ecf9d4f 1581 int val;
b840d15d 1582
5ecf9d4f
ED
1583 /* Paired with WRITE_ONCE() in tcp_sock_set_keepintvl()
1584 * and do_tcp_setsockopt().
1585 */
1586 val = READ_ONCE(tp->keepalive_intvl);
b840d15d 1587
5ecf9d4f 1588 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_intvl);
1da177e4
LT
1589}
1590
1591static inline int keepalive_time_when(const struct tcp_sock *tp)
1592{
13b287e8 1593 struct net *net = sock_net((struct sock *)tp);
4164245c 1594 int val;
13b287e8 1595
4164245c
ED
1596 /* Paired with WRITE_ONCE() in tcp_sock_set_keepidle_locked() */
1597 val = READ_ONCE(tp->keepalive_time);
1598
1599 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_time);
1da177e4
LT
1600}
1601
df19a626
ED
1602static inline int keepalive_probes(const struct tcp_sock *tp)
1603{
9bd6861b 1604 struct net *net = sock_net((struct sock *)tp);
6e5e1de6 1605 int val;
9bd6861b 1606
6e5e1de6
ED
1607 /* Paired with WRITE_ONCE() in tcp_sock_set_keepcnt()
1608 * and do_tcp_setsockopt().
1609 */
1610 val = READ_ONCE(tp->keepalive_probes);
9bd6861b 1611
6e5e1de6 1612 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_probes);
df19a626
ED
1613}
1614
6c37e5de
FL
1615static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1616{
1617 const struct inet_connection_sock *icsk = &tp->inet_conn;
1618
70eabf0e
ED
1619 return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
1620 tcp_jiffies32 - tp->rcv_tstamp);
6c37e5de
FL
1621}
1622
463c84b9 1623static inline int tcp_fin_time(const struct sock *sk)
1da177e4 1624{
39e24435
KI
1625 int fin_timeout = tcp_sk(sk)->linger2 ? :
1626 READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_fin_timeout);
463c84b9 1627 const int rto = inet_csk(sk)->icsk_rto;
1da177e4 1628
463c84b9
ACM
1629 if (fin_timeout < (rto << 2) - (rto >> 1))
1630 fin_timeout = (rto << 2) - (rto >> 1);
1da177e4
LT
1631
1632 return fin_timeout;
1633}
1634
a2a385d6
ED
1635static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1636 int paws_win)
1da177e4 1637{
c887e6d2 1638 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
a2a385d6 1639 return true;
cca9bab1 1640 if (unlikely(!time_before32(ktime_get_seconds(),
af772144 1641 rx_opt->ts_recent_stamp + TCP_PAWS_WRAP)))
a2a385d6 1642 return true;
bc2ce894
ED
1643 /*
1644 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1645 * then following tcp messages have valid values. Ignore 0 value,
1646 * or else 'negative' tsval might forbid us to accept their packets.
1647 */
1648 if (!rx_opt->ts_recent)
a2a385d6
ED
1649 return true;
1650 return false;
c887e6d2
IJ
1651}
1652
a2a385d6
ED
1653static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1654 int rst)
c887e6d2
IJ
1655{
1656 if (tcp_paws_check(rx_opt, 0))
a2a385d6 1657 return false;
1da177e4
LT
1658
1659 /* RST segments are not recommended to carry timestamp,
1660 and, if they do, it is recommended to ignore PAWS because
1661 "their cleanup function should take precedence over timestamps."
1662 Certainly, it is mistake. It is necessary to understand the reasons
1663 of this constraint to relax it: if peer reboots, clock may go
1664 out-of-sync and half-open connections will not be reset.
1665 Actually, the problem would be not existing if all
1666 the implementations followed draft about maintaining clock
1667 via reboots. Linux-2.2 DOES NOT!
1668
1669 However, we can relax time bounds for RST segments to MSL.
1670 */
cca9bab1
AB
1671 if (rst && !time_before32(ktime_get_seconds(),
1672 rx_opt->ts_recent_stamp + TCP_PAWS_MSL))
a2a385d6
ED
1673 return false;
1674 return true;
1da177e4
LT
1675}
1676
7970ddc8
ED
1677bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
1678 int mib_idx, u32 *last_oow_ack_time);
032ee423 1679
a9c19329 1680static inline void tcp_mib_init(struct net *net)
1da177e4
LT
1681{
1682 /* See RFC 2012 */
6aef70a8
ED
1683 TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
1684 TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1685 TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1686 TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
1da177e4
LT
1687}
1688
5af4ec23 1689/* from STCP */
ef9da47c 1690static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
0800f170 1691{
6a438bbe 1692 tp->lost_skb_hint = NULL;
ef9da47c
IJ
1693}
1694
1695static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1696{
1697 tcp_clear_retrans_hints_partial(tp);
6a438bbe 1698 tp->retransmit_skb_hint = NULL;
b7689205
IJ
1699}
1700
c845f5f3 1701#define tcp_md5_addr tcp_ao_addr
a915da9b 1702
cfb6eeb4
YH
1703/* - key database */
1704struct tcp_md5sig_key {
a915da9b 1705 struct hlist_node node;
cfb6eeb4 1706 u8 keylen;
a915da9b 1707 u8 family; /* AF_INET or AF_INET6 */
6797318e 1708 u8 prefixlen;
a76c2315 1709 u8 flags;
dea53bb8
DA
1710 union tcp_md5_addr addr;
1711 int l3index; /* set if key added with L3 scope */
a915da9b
ED
1712 u8 key[TCP_MD5SIG_MAXKEYLEN];
1713 struct rcu_head rcu;
cfb6eeb4
YH
1714};
1715
1716/* - sock block */
1717struct tcp_md5sig_info {
a915da9b 1718 struct hlist_head head;
a8afca03 1719 struct rcu_head rcu;
cfb6eeb4
YH
1720};
1721
1722/* - pseudo header */
1723struct tcp4_pseudohdr {
1724 __be32 saddr;
1725 __be32 daddr;
1726 __u8 pad;
1727 __u8 protocol;
1728 __be16 len;
1729};
1730
1731struct tcp6_pseudohdr {
1732 struct in6_addr saddr;
1733 struct in6_addr daddr;
1734 __be32 len;
1735 __be32 protocol; /* including padding */
1736};
1737
1738union tcp_md5sum_block {
1739 struct tcp4_pseudohdr ip4;
dfd56b8b 1740#if IS_ENABLED(CONFIG_IPV6)
cfb6eeb4
YH
1741 struct tcp6_pseudohdr ip6;
1742#endif
1743};
1744
8c73b263
DS
1745/*
1746 * struct tcp_sigpool - per-CPU pool of ahash_requests
1747 * @scratch: per-CPU temporary area, that can be used between
1748 * tcp_sigpool_start() and tcp_sigpool_end() to perform
1749 * crypto request
1750 * @req: pre-allocated ahash request
1751 */
1752struct tcp_sigpool {
1753 void *scratch;
1754 struct ahash_request *req;
cfb6eeb4
YH
1755};
1756
8c73b263
DS
1757int tcp_sigpool_alloc_ahash(const char *alg, size_t scratch_size);
1758void tcp_sigpool_get(unsigned int id);
1759void tcp_sigpool_release(unsigned int id);
1760int tcp_sigpool_hash_skb_data(struct tcp_sigpool *hp,
1761 const struct sk_buff *skb,
1762 unsigned int header_len);
1763
1764/**
1765 * tcp_sigpool_start - disable bh and start using tcp_sigpool_ahash
1766 * @id: tcp_sigpool that was previously allocated by tcp_sigpool_alloc_ahash()
1767 * @c: returned tcp_sigpool for usage (uninitialized on failure)
1768 *
1769 * Returns 0 on success, error otherwise.
1770 */
1771int tcp_sigpool_start(unsigned int id, struct tcp_sigpool *c);
1772/**
1773 * tcp_sigpool_end - enable bh and stop using tcp_sigpool
1774 * @c: tcp_sigpool context that was returned by tcp_sigpool_start()
1775 */
1776void tcp_sigpool_end(struct tcp_sigpool *c);
1777size_t tcp_sigpool_algo(unsigned int id, char *buf, size_t buf_len);
cfb6eeb4 1778/* - functions */
39f8e58e
ED
1779int tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
1780 const struct sock *sk, const struct sk_buff *skb);
5c9f3023 1781int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
a76c2315 1782 int family, u8 prefixlen, int l3index, u8 flags,
459837b5
DS
1783 const u8 *newkey, u8 newkeylen);
1784int tcp_md5_key_copy(struct sock *sk, const union tcp_md5_addr *addr,
1785 int family, u8 prefixlen, int l3index,
1786 struct tcp_md5sig_key *key);
1787
5c9f3023 1788int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
a76c2315 1789 int family, u8 prefixlen, int l3index, u8 flags);
0aadc739 1790void tcp_clear_md5_list(struct sock *sk);
b83e3deb 1791struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
fd3a154a 1792 const struct sock *addr_sk);
cfb6eeb4 1793
9501f972 1794#ifdef CONFIG_TCP_MD5SIG
dea53bb8 1795struct tcp_md5sig_key *__tcp_md5_do_lookup(const struct sock *sk, int l3index,
6015c71e 1796 const union tcp_md5_addr *addr,
0aadc739 1797 int family, bool any_l3index);
6015c71e 1798static inline struct tcp_md5sig_key *
dea53bb8
DA
1799tcp_md5_do_lookup(const struct sock *sk, int l3index,
1800 const union tcp_md5_addr *addr, int family)
6015c71e 1801{
459837b5 1802 if (!static_branch_unlikely(&tcp_md5_needed.key))
6015c71e 1803 return NULL;
0aadc739
DS
1804 return __tcp_md5_do_lookup(sk, l3index, addr, family, false);
1805}
1806
1807static inline struct tcp_md5sig_key *
1808tcp_md5_do_lookup_any_l3index(const struct sock *sk,
1809 const union tcp_md5_addr *addr, int family)
1810{
1811 if (!static_branch_unlikely(&tcp_md5_needed.key))
1812 return NULL;
1813 return __tcp_md5_do_lookup(sk, 0, addr, family, true);
6015c71e 1814}
1330b6ef
JK
1815
1816enum skb_drop_reason
1817tcp_inbound_md5_hash(const struct sock *sk, const struct sk_buff *skb,
1818 const void *saddr, const void *daddr,
0a3a8090 1819 int family, int l3index, const __u8 *hash_location);
7bbb765b 1820
6015c71e 1821
a915da9b 1822#define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_key)
9501f972 1823#else
dea53bb8
DA
1824static inline struct tcp_md5sig_key *
1825tcp_md5_do_lookup(const struct sock *sk, int l3index,
1826 const union tcp_md5_addr *addr, int family)
a915da9b
ED
1827{
1828 return NULL;
1829}
1330b6ef 1830
0aadc739
DS
1831static inline struct tcp_md5sig_key *
1832tcp_md5_do_lookup_any_l3index(const struct sock *sk,
1833 const union tcp_md5_addr *addr, int family)
1834{
1835 return NULL;
1836}
1837
1330b6ef
JK
1838static inline enum skb_drop_reason
1839tcp_inbound_md5_hash(const struct sock *sk, const struct sk_buff *skb,
1840 const void *saddr, const void *daddr,
0a3a8090 1841 int family, int l3index, const __u8 *hash_location)
7bbb765b 1842{
1330b6ef 1843 return SKB_NOT_DROPPED_YET;
7bbb765b 1844}
9501f972
YH
1845#define tcp_twsk_md5_key(twsk) NULL
1846#endif
1847
8c73b263
DS
1848int tcp_md5_alloc_sigpool(void);
1849void tcp_md5_release_sigpool(void);
1850void tcp_md5_add_sigpool(void);
1851extern int tcp_md5_sigpool_id;
35790c04 1852
8c73b263 1853int tcp_md5_hash_key(struct tcp_sigpool *hp,
5c9f3023 1854 const struct tcp_md5sig_key *key);
cfb6eeb4 1855
10467163 1856/* From tcp_fastopen.c */
5c9f3023 1857void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
7268586b 1858 struct tcp_fastopen_cookie *cookie);
5c9f3023 1859void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
2646c831
DL
1860 struct tcp_fastopen_cookie *cookie, bool syn_lost,
1861 u16 try_exp);
783237e8
YC
1862struct tcp_fastopen_request {
1863 /* Fast Open cookie. Size 0 means a cookie request */
1864 struct tcp_fastopen_cookie cookie;
1865 struct msghdr *data; /* data in MSG_FASTOPEN */
f5ddcbbb
ED
1866 size_t size;
1867 int copied; /* queued in tcp_connect() */
f859a448 1868 struct ubuf_info *uarg;
783237e8 1869};
783237e8 1870void tcp_free_fastopen_req(struct tcp_sock *tp);
1fba70e5 1871void tcp_fastopen_destroy_cipher(struct sock *sk);
43713848 1872void tcp_fastopen_ctx_destroy(struct net *net);
1fba70e5 1873int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk,
438ac880 1874 void *primary_key, void *backup_key);
f19008e6
JB
1875int tcp_fastopen_get_cipher(struct net *net, struct inet_connection_sock *icsk,
1876 u64 *key);
61d2bcae 1877void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
7c85af88
ED
1878struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
1879 struct request_sock *req,
71c02379
CP
1880 struct tcp_fastopen_cookie *foc,
1881 const struct dst_entry *dst);
43713848 1882void tcp_fastopen_init_key_once(struct net *net);
065263f4
WW
1883bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
1884 struct tcp_fastopen_cookie *cookie);
19f6d3f3 1885bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
438ac880 1886#define TCP_FASTOPEN_KEY_LENGTH sizeof(siphash_key_t)
9092a76d
JB
1887#define TCP_FASTOPEN_KEY_MAX 2
1888#define TCP_FASTOPEN_KEY_BUF_LENGTH \
1889 (TCP_FASTOPEN_KEY_LENGTH * TCP_FASTOPEN_KEY_MAX)
10467163
JC
1890
1891/* Fastopen key context */
1892struct tcp_fastopen_context {
438ac880 1893 siphash_key_t key[TCP_FASTOPEN_KEY_MAX];
c681edae
AB
1894 int num;
1895 struct rcu_head rcu;
10467163
JC
1896};
1897
46c2fa39 1898void tcp_fastopen_active_disable(struct sock *sk);
cf1ef3f0
WW
1899bool tcp_fastopen_active_should_disable(struct sock *sk);
1900void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
7268586b 1901void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired);
cf1ef3f0 1902
9092a76d
JB
1903/* Caller needs to wrap with rcu_read_(un)lock() */
1904static inline
1905struct tcp_fastopen_context *tcp_fastopen_get_ctx(const struct sock *sk)
1906{
1907 struct tcp_fastopen_context *ctx;
1908
1909 ctx = rcu_dereference(inet_csk(sk)->icsk_accept_queue.fastopenq.ctx);
1910 if (!ctx)
1911 ctx = rcu_dereference(sock_net(sk)->ipv4.tcp_fastopen_ctx);
1912 return ctx;
1913}
1914
1915static inline
1916bool tcp_fastopen_cookie_match(const struct tcp_fastopen_cookie *foc,
1917 const struct tcp_fastopen_cookie *orig)
1918{
1919 if (orig->len == TCP_FASTOPEN_COOKIE_SIZE &&
1920 orig->len == foc->len &&
1921 !memcmp(orig->val, foc->val, foc->len))
1922 return true;
1923 return false;
1924}
1925
1926static inline
1927int tcp_fastopen_context_len(const struct tcp_fastopen_context *ctx)
1928{
c681edae 1929 return ctx->num;
9092a76d
JB
1930}
1931
05b055e8
FY
1932/* Latencies incurred by various limits for a sender. They are
1933 * chronograph-like stats that are mutually exclusive.
1934 */
1935enum tcp_chrono {
1936 TCP_CHRONO_UNSPEC,
1937 TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
1938 TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
1939 TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
1940 __TCP_CHRONO_MAX,
1941};
1942
1943void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type);
1944void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);
1945
e2080072
ED
1946/* This helper is needed, because skb->tcp_tsorted_anchor uses
1947 * the same memory storage than skb->destructor/_skb_refdst
1948 */
1949static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb)
1950{
1951 skb->destructor = NULL;
1952 skb->_skb_refdst = 0UL;
1953}
1954
1955#define tcp_skb_tsorted_save(skb) { \
1956 unsigned long _save = skb->_skb_refdst; \
1957 skb->_skb_refdst = 0UL;
1958
1959#define tcp_skb_tsorted_restore(skb) \
1960 skb->_skb_refdst = _save; \
1961}
1962
ac3f09ba 1963void tcp_write_queue_purge(struct sock *sk);
fe067e8a 1964
75c119af
ED
1965static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk)
1966{
1967 return skb_rb_first(&sk->tcp_rtx_queue);
1968}
1969
b617158d
ED
1970static inline struct sk_buff *tcp_rtx_queue_tail(const struct sock *sk)
1971{
1972 return skb_rb_last(&sk->tcp_rtx_queue);
1973}
1974
cf533ea5 1975static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
fe067e8a 1976{
cd07a8ea 1977 return skb_peek_tail(&sk->sk_write_queue);
fe067e8a
DM
1978}
1979
234b6860 1980#define tcp_for_write_queue_from_safe(skb, tmp, sk) \
cd07a8ea 1981 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
234b6860 1982
cf533ea5 1983static inline struct sk_buff *tcp_send_head(const struct sock *sk)
fe067e8a 1984{
75c119af 1985 return skb_peek(&sk->sk_write_queue);
fe067e8a
DM
1986}
1987
cd07a8ea
DM
1988static inline bool tcp_skb_is_last(const struct sock *sk,
1989 const struct sk_buff *skb)
1990{
1991 return skb_queue_is_last(&sk->sk_write_queue, skb);
1992}
1993
ee2aabd3
ED
1994/**
1995 * tcp_write_queue_empty - test if any payload (or FIN) is available in write queue
1996 * @sk: socket
1997 *
1998 * Since the write queue can have a temporary empty skb in it,
1999 * we must not use "return skb_queue_empty(&sk->sk_write_queue)"
2000 */
75c119af 2001static inline bool tcp_write_queue_empty(const struct sock *sk)
fe067e8a 2002{
ee2aabd3
ED
2003 const struct tcp_sock *tp = tcp_sk(sk);
2004
2005 return tp->write_seq == tp->snd_nxt;
75c119af
ED
2006}
2007
2008static inline bool tcp_rtx_queue_empty(const struct sock *sk)
2009{
2010 return RB_EMPTY_ROOT(&sk->tcp_rtx_queue);
2011}
2012
2013static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk)
2014{
2015 return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk);
fe067e8a
DM
2016}
2017
fe067e8a
DM
2018static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
2019{
a43e052b 2020 __skb_queue_tail(&sk->sk_write_queue, skb);
fe067e8a
DM
2021
2022 /* Queue it, remembering where we must start sending. */
50895b9d 2023 if (sk->sk_write_queue.next == skb)
0f87230d 2024 tcp_chrono_start(sk, TCP_CHRONO_BUSY);
fe067e8a
DM
2025}
2026
43f59c89 2027/* Insert new before skb on the write queue of sk. */
fe067e8a
DM
2028static inline void tcp_insert_write_queue_before(struct sk_buff *new,
2029 struct sk_buff *skb,
2030 struct sock *sk)
2031{
43f59c89 2032 __skb_queue_before(&sk->sk_write_queue, skb, new);
fe067e8a
DM
2033}
2034
2035static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
2036{
4a269818 2037 tcp_skb_tsorted_anchor_cleanup(skb);
fe067e8a
DM
2038 __skb_unlink(skb, &sk->sk_write_queue);
2039}
2040
75c119af
ED
2041void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb);
2042
2043static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk)
fe067e8a 2044{
75c119af
ED
2045 tcp_skb_tsorted_anchor_cleanup(skb);
2046 rb_erase(&skb->rbnode, &sk->tcp_rtx_queue);
2047}
2048
2049static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk)
2050{
2051 list_del(&skb->tcp_tsorted_anchor);
2052 tcp_rtx_queue_unlink(skb, sk);
03271f3a 2053 tcp_wmem_free_skb(sk, skb);
fe067e8a
DM
2054}
2055
12d50c46
KK
2056static inline void tcp_push_pending_frames(struct sock *sk)
2057{
2058 if (tcp_send_head(sk)) {
2059 struct tcp_sock *tp = tcp_sk(sk);
2060
2061 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
2062 }
2063}
2064
ecb97192
NC
2065/* Start sequence of the skb just after the highest skb with SACKed
2066 * bit, valid only if sacked_out > 0 or when the caller has ensured
2067 * validity by itself.
a47e5a98
IJ
2068 */
2069static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
2070{
2071 if (!tp->sacked_out)
2072 return tp->snd_una;
6859d494
IJ
2073
2074 if (tp->highest_sack == NULL)
2075 return tp->snd_nxt;
2076
a47e5a98
IJ
2077 return TCP_SKB_CB(tp->highest_sack)->seq;
2078}
2079
6859d494
IJ
2080static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
2081{
50895b9d 2082 tcp_sk(sk)->highest_sack = skb_rb_next(skb);
6859d494
IJ
2083}
2084
2085static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
2086{
2087 return tcp_sk(sk)->highest_sack;
2088}
2089
2090static inline void tcp_highest_sack_reset(struct sock *sk)
2091{
50895b9d 2092 tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk);
6859d494
IJ
2093}
2094
2b7cda9c
ED
2095/* Called when old skb is about to be deleted and replaced by new skb */
2096static inline void tcp_highest_sack_replace(struct sock *sk,
6859d494
IJ
2097 struct sk_buff *old,
2098 struct sk_buff *new)
2099{
2b7cda9c 2100 if (old == tcp_highest_sack(sk))
6859d494
IJ
2101 tcp_sk(sk)->highest_sack = new;
2102}
2103
b1f0a0e9
FW
2104/* This helper checks if socket has IP_TRANSPARENT set */
2105static inline bool inet_sk_transparent(const struct sock *sk)
2106{
2107 switch (sk->sk_state) {
2108 case TCP_TIME_WAIT:
2109 return inet_twsk(sk)->tw_transparent;
2110 case TCP_NEW_SYN_RECV:
2111 return inet_rsk(inet_reqsk(sk))->no_srccheck;
2112 }
4bd0623f 2113 return inet_test_bit(TRANSPARENT, sk);
b1f0a0e9
FW
2114}
2115
5aa4b32f
AP
2116/* Determines whether this is a thin stream (which may suffer from
2117 * increased latency). Used to trigger latency-reducing mechanisms.
2118 */
a2a385d6 2119static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
5aa4b32f
AP
2120{
2121 return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
2122}
2123
1da177e4
LT
2124/* /proc */
2125enum tcp_seq_states {
2126 TCP_SEQ_STATE_LISTENING,
1da177e4 2127 TCP_SEQ_STATE_ESTABLISHED,
1da177e4
LT
2128};
2129
37d849bb
CH
2130void *tcp_seq_start(struct seq_file *seq, loff_t *pos);
2131void *tcp_seq_next(struct seq_file *seq, void *v, loff_t *pos);
2132void tcp_seq_stop(struct seq_file *seq, void *v);
73cb88ec 2133
1da177e4 2134struct tcp_seq_afinfo {
73cb88ec 2135 sa_family_t family;
1da177e4
LT
2136};
2137
2138struct tcp_iter_state {
a4146b1b 2139 struct seq_net_private p;
1da177e4
LT
2140 enum tcp_seq_states state;
2141 struct sock *syn_wait_sk;
a7cb5a49 2142 int bucket, offset, sbucket, num;
a8b690f9 2143 loff_t last_pos;
1da177e4
LT
2144};
2145
20380731 2146extern struct request_sock_ops tcp_request_sock_ops;
c6aefafb 2147extern struct request_sock_ops tcp6_request_sock_ops;
20380731 2148
5c9f3023 2149void tcp_v4_destroy_sock(struct sock *sk);
20380731 2150
28be6e07 2151struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
5c9f3023 2152 netdev_features_t features);
d4546c25 2153struct sk_buff *tcp_gro_receive(struct list_head *head, struct sk_buff *skb);
5521d95e
ED
2154INDIRECT_CALLABLE_DECLARE(int tcp4_gro_complete(struct sk_buff *skb, int thoff));
2155INDIRECT_CALLABLE_DECLARE(struct sk_buff *tcp4_gro_receive(struct list_head *head, struct sk_buff *skb));
2156INDIRECT_CALLABLE_DECLARE(int tcp6_gro_complete(struct sk_buff *skb, int thoff));
2157INDIRECT_CALLABLE_DECLARE(struct sk_buff *tcp6_gro_receive(struct list_head *head, struct sk_buff *skb));
e411a8e3 2158#ifdef CONFIG_INET
b1f2abcf 2159void tcp_gro_complete(struct sk_buff *skb);
e411a8e3
JK
2160#else
2161static inline void tcp_gro_complete(struct sk_buff *skb) { }
2162#endif
28850dc7 2163
5c9f3023 2164void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, __be32 daddr);
f4c50d99 2165
c9bee3b7
ED
2166static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
2167{
4979f2d9 2168 struct net *net = sock_net((struct sock *)tp);
1aeb87bc
ED
2169 u32 val;
2170
2171 val = READ_ONCE(tp->notsent_lowat);
2172
2173 return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
c9bee3b7
ED
2174}
2175
d3cd4924 2176bool tcp_stream_memory_free(const struct sock *sk, int wake);
c9bee3b7 2177
20380731 2178#ifdef CONFIG_PROC_FS
5c9f3023
JP
2179int tcp4_proc_init(void);
2180void tcp4_proc_exit(void);
20380731
ACM
2181#endif
2182
ea3bea3a 2183int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
1fb6f159
OP
2184int tcp_conn_request(struct request_sock_ops *rsk_ops,
2185 const struct tcp_request_sock_ops *af_ops,
2186 struct sock *sk, struct sk_buff *skb);
5db92c99 2187
cfb6eeb4
YH
2188/* TCP af-specific functions */
2189struct tcp_sock_af_ops {
2190#ifdef CONFIG_TCP_MD5SIG
b83e3deb 2191 struct tcp_md5sig_key *(*md5_lookup) (const struct sock *sk,
fd3a154a 2192 const struct sock *addr_sk);
39f8e58e
ED
2193 int (*calc_md5_hash)(char *location,
2194 const struct tcp_md5sig_key *md5,
2195 const struct sock *sk,
2196 const struct sk_buff *skb);
2197 int (*md5_parse)(struct sock *sk,
8917a777 2198 int optname,
d4c19c49 2199 sockptr_t optval,
39f8e58e 2200 int optlen);
cfb6eeb4 2201#endif
4954f17d
DS
2202#ifdef CONFIG_TCP_AO
2203 int (*ao_parse)(struct sock *sk, int optname, sockptr_t optval, int optlen);
0aadc739
DS
2204 struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2205 struct sock *addr_sk,
2206 int sndid, int rcvid);
7c2ffaf2
DS
2207 int (*ao_calc_key_sk)(struct tcp_ao_key *mkt, u8 *key,
2208 const struct sock *sk,
2209 __be32 sisn, __be32 disn, bool send);
1e03d32b
DS
2210 int (*calc_ao_hash)(char *location, struct tcp_ao_key *ao,
2211 const struct sock *sk, const struct sk_buff *skb,
2212 const u8 *tkey, int hash_offset, u32 sne);
4954f17d 2213#endif
cfb6eeb4
YH
2214};
2215
2216struct tcp_request_sock_ops {
2aec4a29 2217 u16 mss_clamp;
cfb6eeb4 2218#ifdef CONFIG_TCP_MD5SIG
b83e3deb 2219 struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk,
fd3a154a 2220 const struct sock *addr_sk);
39f8e58e
ED
2221 int (*calc_md5_hash) (char *location,
2222 const struct tcp_md5sig_key *md5,
2223 const struct sock *sk,
2224 const struct sk_buff *skb);
cfb6eeb4 2225#endif
06b22ef2
DS
2226#ifdef CONFIG_TCP_AO
2227 struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2228 struct request_sock *req,
2229 int sndid, int rcvid);
2230 int (*ao_calc_key)(struct tcp_ao_key *mkt, u8 *key, struct request_sock *sk);
9427c6aa
DS
2231 int (*ao_synack_hash)(char *ao_hash, struct tcp_ao_key *mkt,
2232 struct request_sock *req, const struct sk_buff *skb,
2233 int hash_offset, u32 sne);
06b22ef2 2234#endif
fb7b37a7 2235#ifdef CONFIG_SYN_COOKIES
3f684b4b 2236 __u32 (*cookie_init_seq)(const struct sk_buff *skb,
fb7b37a7
OP
2237 __u16 *mss);
2238#endif
7ea851d1
FW
2239 struct dst_entry *(*route_req)(const struct sock *sk,
2240 struct sk_buff *skb,
2241 struct flowi *fl,
2242 struct request_sock *req);
84b114b9 2243 u32 (*init_seq)(const struct sk_buff *skb);
5d2ed052 2244 u32 (*init_ts_off)(const struct net *net, const struct sk_buff *skb);
0f935dbe 2245 int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
d6274bd8 2246 struct flowi *fl, struct request_sock *req,
dc6ef6be 2247 struct tcp_fastopen_cookie *foc,
331fca43
MKL
2248 enum tcp_synack_type synack_type,
2249 struct sk_buff *syn_skb);
cfb6eeb4
YH
2250};
2251
35b2c321
MM
2252extern const struct tcp_request_sock_ops tcp_request_sock_ipv4_ops;
2253#if IS_ENABLED(CONFIG_IPV6)
2254extern const struct tcp_request_sock_ops tcp_request_sock_ipv6_ops;
2255#endif
2256
fb7b37a7
OP
2257#ifdef CONFIG_SYN_COOKIES
2258static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
3f684b4b 2259 const struct sock *sk, struct sk_buff *skb,
fb7b37a7
OP
2260 __u16 *mss)
2261{
3f684b4b 2262 tcp_synq_overflow(sk);
02a1d6e7 2263 __NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
3f684b4b 2264 return ops->cookie_init_seq(skb, mss);
fb7b37a7
OP
2265}
2266#else
2267static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
3f684b4b 2268 const struct sock *sk, struct sk_buff *skb,
fb7b37a7
OP
2269 __u16 *mss)
2270{
2271 return 0;
2272}
2273#endif
2274
1e03d32b
DS
2275struct tcp_key {
2276 union {
ba7783ad
DS
2277 struct {
2278 struct tcp_ao_key *ao_key;
2279 char *traffic_key;
2280 u32 sne;
2281 u8 rcv_next;
2282 };
1e03d32b
DS
2283 struct tcp_md5sig_key *md5_key;
2284 };
2285 enum {
2286 TCP_KEY_NONE = 0,
2287 TCP_KEY_MD5,
2288 TCP_KEY_AO,
2289 } type;
2290};
2291
2292static inline void tcp_get_current_key(const struct sock *sk,
2293 struct tcp_key *out)
2294{
2295#if defined(CONFIG_TCP_AO) || defined(CONFIG_TCP_MD5SIG)
2296 const struct tcp_sock *tp = tcp_sk(sk);
2297#endif
1e03d32b 2298
67fa83f7
DS
2299#ifdef CONFIG_TCP_AO
2300 if (static_branch_unlikely(&tcp_ao_needed.key)) {
2301 struct tcp_ao_info *ao;
2302
2303 ao = rcu_dereference_protected(tp->ao_info,
2304 lockdep_sock_is_held(sk));
2305 if (ao) {
2306 out->ao_key = READ_ONCE(ao->current_key);
2307 out->type = TCP_KEY_AO;
2308 return;
2309 }
1e03d32b
DS
2310 }
2311#endif
2312#ifdef CONFIG_TCP_MD5SIG
2313 if (static_branch_unlikely(&tcp_md5_needed.key) &&
2314 rcu_access_pointer(tp->md5sig_info)) {
2315 out->md5_key = tp->af_specific->md5_lookup(sk, sk);
2316 if (out->md5_key) {
2317 out->type = TCP_KEY_MD5;
2318 return;
2319 }
2320 }
2321#endif
2322 out->type = TCP_KEY_NONE;
2323}
2324
2325static inline bool tcp_key_is_md5(const struct tcp_key *key)
2326{
2327#ifdef CONFIG_TCP_MD5SIG
2328 if (static_branch_unlikely(&tcp_md5_needed.key) &&
2329 key->type == TCP_KEY_MD5)
2330 return true;
2331#endif
2332 return false;
2333}
2334
2335static inline bool tcp_key_is_ao(const struct tcp_key *key)
2336{
2337#ifdef CONFIG_TCP_AO
67fa83f7
DS
2338 if (static_branch_unlikely(&tcp_ao_needed.key) &&
2339 key->type == TCP_KEY_AO)
1e03d32b
DS
2340 return true;
2341#endif
2342 return false;
2343}
2344
5c9f3023 2345int tcpv4_offload_init(void);
28850dc7 2346
5c9f3023
JP
2347void tcp_v4_init(void);
2348void tcp_init(void);
20380731 2349
659a8ad5 2350/* tcp_recovery.c */
d716bfdb 2351void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb);
6ac06ecd 2352void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced);
b8fef65a
YC
2353extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb,
2354 u32 reo_wnd);
62d9f1a6 2355extern bool tcp_rack_mark_lost(struct sock *sk);
1d0833df 2356extern void tcp_rack_advance(struct tcp_sock *tp, u8 sacked, u32 end_seq,
9a568de4 2357 u64 xmit_time);
57dde7f7 2358extern void tcp_rack_reo_timeout(struct sock *sk);
1f255691 2359extern void tcp_rack_update_reo_wnd(struct sock *sk, struct rate_sample *rs);
659a8ad5 2360
1a91bb7c
MAQ
2361/* tcp_plb.c */
2362
2363/*
2364 * Scaling factor for fractions in PLB. For example, tcp_plb_update_state
2365 * expects cong_ratio which represents fraction of traffic that experienced
2366 * congestion over a single RTT. In order to avoid floating point operations,
2367 * this fraction should be mapped to (1 << TCP_PLB_SCALE) and passed in.
2368 */
2369#define TCP_PLB_SCALE 8
2370
2371/* State for PLB (Protective Load Balancing) for a single TCP connection. */
2372struct tcp_plb_state {
2373 u8 consec_cong_rounds:5, /* consecutive congested rounds */
2374 unused:3;
2375 u32 pause_until; /* jiffies32 when PLB can resume rerouting */
2376};
2377
2378static inline void tcp_plb_init(const struct sock *sk,
2379 struct tcp_plb_state *plb)
2380{
2381 plb->consec_cong_rounds = 0;
2382 plb->pause_until = 0;
2383}
2384void tcp_plb_update_state(const struct sock *sk, struct tcp_plb_state *plb,
2385 const int cong_ratio);
2386void tcp_plb_check_rehash(struct sock *sk, struct tcp_plb_state *plb);
2387void tcp_plb_update_state_upon_rto(struct sock *sk, struct tcp_plb_state *plb);
2388
e1a10ef7
NC
2389/* At how many usecs into the future should the RTO fire? */
2390static inline s64 tcp_rto_delta_us(const struct sock *sk)
2391{
75c119af 2392 const struct sk_buff *skb = tcp_rtx_queue_head(sk);
e1a10ef7 2393 u32 rto = inet_csk(sk)->icsk_rto;
2fd66ffb 2394 u64 rto_time_stamp_us = tcp_skb_timestamp_us(skb) + jiffies_to_usecs(rto);
e1a10ef7
NC
2395
2396 return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp;
2397}
2398
e25f866f
CW
2399/*
2400 * Save and compile IPv4 options, return a pointer to it
2401 */
91ed1e66
PA
2402static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net,
2403 struct sk_buff *skb)
e25f866f
CW
2404{
2405 const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
2406 struct ip_options_rcu *dopt = NULL;
2407
461b74c3 2408 if (opt->optlen) {
e25f866f
CW
2409 int opt_size = sizeof(*dopt) + opt->optlen;
2410
2411 dopt = kmalloc(opt_size, GFP_ATOMIC);
91ed1e66 2412 if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) {
e25f866f
CW
2413 kfree(dopt);
2414 dopt = NULL;
2415 }
2416 }
2417 return dopt;
2418}
2419
98781965
ED
2420/* locally generated TCP pure ACKs have skb->truesize == 2
2421 * (check tcp_send_ack() in net/ipv4/tcp_output.c )
2422 * This is much faster than dissecting the packet to find out.
2423 * (Think of GRE encapsulations, IPv4, IPv6, ...)
2424 */
2425static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
2426{
2427 return skb->truesize == 2;
2428}
2429
2430static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
2431{
2432 skb->truesize = 2;
2433}
2434
473bd239
TH
2435static inline int tcp_inq(struct sock *sk)
2436{
2437 struct tcp_sock *tp = tcp_sk(sk);
2438 int answ;
2439
2440 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
2441 answ = 0;
2442 } else if (sock_flag(sk, SOCK_URGINLINE) ||
2443 !tp->urg_data ||
2444 before(tp->urg_seq, tp->copied_seq) ||
2445 !before(tp->urg_seq, tp->rcv_nxt)) {
2446
2447 answ = tp->rcv_nxt - tp->copied_seq;
2448
2449 /* Subtract 1, if FIN was received */
2450 if (answ && sock_flag(sk, SOCK_DONE))
2451 answ--;
2452 } else {
2453 answ = tp->urg_seq - tp->copied_seq;
2454 }
2455
2456 return answ;
2457}
2458
32035585
TH
2459int tcp_peek_len(struct socket *sock);
2460
a44d6eac
MKL
2461static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
2462{
2463 u16 segs_in;
2464
2465 segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
0307a0b7
ED
2466
2467 /* We update these fields while other threads might
2468 * read them from tcp_get_info()
2469 */
2470 WRITE_ONCE(tp->segs_in, tp->segs_in + segs_in);
a44d6eac 2471 if (skb->len > tcp_hdrlen(skb))
0307a0b7 2472 WRITE_ONCE(tp->data_segs_in, tp->data_segs_in + segs_in);
a44d6eac
MKL
2473}
2474
9caad864
ED
2475/*
2476 * TCP listen path runs lockless.
2477 * We forced "struct sock" to be const qualified to make sure
2478 * we don't modify one of its field by mistake.
2479 * Here, we increment sk_drops which is an atomic_t, so we can safely
2480 * make sock writable again.
2481 */
2482static inline void tcp_listendrop(const struct sock *sk)
2483{
2484 atomic_inc(&((struct sock *)sk)->sk_drops);
02a1d6e7 2485 __NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
9caad864
ED
2486}
2487
218af599
ED
2488enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);
2489
734942cc
DW
2490/*
2491 * Interface for adding Upper Level Protocols over TCP
2492 */
2493
2494#define TCP_ULP_NAME_MAX 16
2495#define TCP_ULP_MAX 128
2496#define TCP_ULP_BUF_MAX (TCP_ULP_NAME_MAX*TCP_ULP_MAX)
2497
2498struct tcp_ulp_ops {
2499 struct list_head list;
2500
2501 /* initialize ulp */
2502 int (*init)(struct sock *sk);
95fa1454 2503 /* update ulp */
33bfe20d
JF
2504 void (*update)(struct sock *sk, struct proto *p,
2505 void (*write_space)(struct sock *sk));
734942cc
DW
2506 /* cleanup ulp */
2507 void (*release)(struct sock *sk);
61723b39 2508 /* diagnostic */
b8adb69a 2509 int (*get_info)(struct sock *sk, struct sk_buff *skb);
61723b39 2510 size_t (*get_info_size)(const struct sock *sk);
13230593
MM
2511 /* clone ulp */
2512 void (*clone)(const struct request_sock *req, struct sock *newsk,
2513 const gfp_t priority);
734942cc
DW
2514
2515 char name[TCP_ULP_NAME_MAX];
2516 struct module *owner;
2517};
2518int tcp_register_ulp(struct tcp_ulp_ops *type);
2519void tcp_unregister_ulp(struct tcp_ulp_ops *type);
2520int tcp_set_ulp(struct sock *sk, const char *name);
2521void tcp_get_available_ulp(char *buf, size_t len);
2522void tcp_cleanup_ulp(struct sock *sk);
33bfe20d
JF
2523void tcp_update_ulp(struct sock *sk, struct proto *p,
2524 void (*write_space)(struct sock *sk));
734942cc 2525
037b0b86
DB
2526#define MODULE_ALIAS_TCP_ULP(name) \
2527 __MODULE_INFO(alias, alias_userspace, name); \
2528 __MODULE_INFO(alias, alias_tcp_ulp, "tcp-ulp-" name)
2529
88759609 2530#ifdef CONFIG_NET_SOCK_MSG
604326b4
DB
2531struct sk_msg;
2532struct sk_psock;
2533
88759609 2534#ifdef CONFIG_BPF_SYSCALL
51e0158a 2535int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore);
f747632b 2536void tcp_bpf_clone(const struct sock *sk, struct sock *newsk);
88759609 2537#endif /* CONFIG_BPF_SYSCALL */
f747632b 2538
e5c6de5f
JF
2539#ifdef CONFIG_INET
2540void tcp_eat_skb(struct sock *sk, struct sk_buff *skb);
2541#else
2542static inline void tcp_eat_skb(struct sock *sk, struct sk_buff *skb)
2543{
2544}
2545#endif
2546
a351d608
PY
2547int tcp_bpf_sendmsg_redir(struct sock *sk, bool ingress,
2548 struct sk_msg *msg, u32 bytes, int flags);
5da00404 2549#endif /* CONFIG_NET_SOCK_MSG */
604326b4 2550
88759609
CW
2551#if !defined(CONFIG_BPF_SYSCALL) || !defined(CONFIG_NET_SOCK_MSG)
2552static inline void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
2553{
2554}
2555#endif
2556
0813a841 2557#ifdef CONFIG_CGROUP_BPF
0813a841
MKL
2558static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2559 struct sk_buff *skb,
2560 unsigned int end_offset)
2561{
2562 skops->skb = skb;
2563 skops->skb_data_end = skb->data + end_offset;
2564}
2565#else
0813a841
MKL
2566static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2567 struct sk_buff *skb,
2568 unsigned int end_offset)
2569{
2570}
2571#endif
2572
40304b2a
LB
2573/* Call BPF_SOCK_OPS program that returns an int. If the return value
2574 * is < 0, then the BPF op failed (for example if the loaded BPF
2575 * program does not support the chosen operation or there is no BPF
2576 * program loaded).
2577 */
2578#ifdef CONFIG_BPF
de525be2 2579static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
40304b2a
LB
2580{
2581 struct bpf_sock_ops_kern sock_ops;
2582 int ret;
2583
b73042b8 2584 memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp));
f19397a5
LB
2585 if (sk_fullsock(sk)) {
2586 sock_ops.is_fullsock = 1;
40304b2a 2587 sock_owned_by_me(sk);
f19397a5 2588 }
40304b2a 2589
40304b2a
LB
2590 sock_ops.sk = sk;
2591 sock_ops.op = op;
de525be2
LB
2592 if (nargs > 0)
2593 memcpy(sock_ops.args, args, nargs * sizeof(*args));
40304b2a
LB
2594
2595 ret = BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops);
2596 if (ret == 0)
2597 ret = sock_ops.reply;
2598 else
2599 ret = -1;
2600 return ret;
2601}
de525be2
LB
2602
2603static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2604{
2605 u32 args[2] = {arg1, arg2};
2606
2607 return tcp_call_bpf(sk, op, 2, args);
2608}
2609
2610static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2611 u32 arg3)
2612{
2613 u32 args[3] = {arg1, arg2, arg3};
2614
2615 return tcp_call_bpf(sk, op, 3, args);
2616}
2617
40304b2a 2618#else
de525be2 2619static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
40304b2a
LB
2620{
2621 return -EPERM;
2622}
de525be2
LB
2623
2624static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2625{
2626 return -EPERM;
2627}
2628
2629static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2630 u32 arg3)
2631{
2632 return -EPERM;
2633}
2634
40304b2a
LB
2635#endif
2636
8550f328
LB
2637static inline u32 tcp_timeout_init(struct sock *sk)
2638{
2639 int timeout;
2640
de525be2 2641 timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT, 0, NULL);
8550f328
LB
2642
2643 if (timeout <= 0)
2644 timeout = TCP_TIMEOUT_INIT;
5903123f 2645 return min_t(int, timeout, TCP_RTO_MAX);
8550f328
LB
2646}
2647
13d3b1eb
LB
2648static inline u32 tcp_rwnd_init_bpf(struct sock *sk)
2649{
2650 int rwnd;
2651
de525be2 2652 rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT, 0, NULL);
13d3b1eb
LB
2653
2654 if (rwnd < 0)
2655 rwnd = 0;
2656 return rwnd;
2657}
91b5b21c
LB
2658
2659static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk)
2660{
de525be2 2661 return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN, 0, NULL) == 1);
91b5b21c 2662}
60e2a778 2663
23729ff2
SF
2664static inline void tcp_bpf_rtt(struct sock *sk)
2665{
bef8e263 2666 if (BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), BPF_SOCK_OPS_RTT_CB_FLAG))
23729ff2
SF
2667 tcp_call_bpf(sk, BPF_SOCK_OPS_RTT_CB, 0, NULL);
2668}
2669
60e2a778
UB
2670#if IS_ENABLED(CONFIG_SMC)
2671extern struct static_key_false tcp_have_smc;
2672#endif
6dac1523
IL
2673
2674#if IS_ENABLED(CONFIG_TLS_DEVICE)
2675void clean_acked_data_enable(struct inet_connection_sock *icsk,
2676 void (*cad)(struct sock *sk, u32 ack_seq));
2677void clean_acked_data_disable(struct inet_connection_sock *icsk);
494bc1d2 2678void clean_acked_data_flush(void);
6dac1523
IL
2679#endif
2680
a842fe14
ED
2681DECLARE_STATIC_KEY_FALSE(tcp_tx_delay_enabled);
2682static inline void tcp_add_tx_delay(struct sk_buff *skb,
2683 const struct tcp_sock *tp)
2684{
2685 if (static_branch_unlikely(&tcp_tx_delay_enabled))
2686 skb->skb_mstamp_ns += (u64)tp->tcp_tx_delay * NSEC_PER_USEC;
2687}
2688
d6fb396c
ED
2689/* Compute Earliest Departure Time for some control packets
2690 * like ACK or RST for TIME_WAIT or non ESTABLISHED sockets.
2691 */
2692static inline u64 tcp_transmit_time(const struct sock *sk)
a842fe14
ED
2693{
2694 if (static_branch_unlikely(&tcp_tx_delay_enabled)) {
2695 u32 delay = (sk->sk_state == TCP_TIME_WAIT) ?
2696 tcp_twsk(sk)->tw_tx_delay : tcp_sk(sk)->tcp_tx_delay;
2697
d6fb396c 2698 return tcp_clock_ns() + (u64)delay * NSEC_PER_USEC;
a842fe14 2699 }
d6fb396c 2700 return 0;
a842fe14
ED
2701}
2702
f7dca36f
DS
2703static inline int tcp_parse_auth_options(const struct tcphdr *th,
2704 const u8 **md5_hash, const struct tcp_ao_hdr **aoh)
2705{
2706 const u8 *md5_tmp, *ao_tmp;
2707 int ret;
2708
2709 ret = tcp_do_parse_auth_options(th, &md5_tmp, &ao_tmp);
2710 if (ret)
2711 return ret;
2712
2713 if (md5_hash)
2714 *md5_hash = md5_tmp;
2715
2716 if (aoh) {
2717 if (!ao_tmp)
2718 *aoh = NULL;
2719 else
2720 *aoh = (struct tcp_ao_hdr *)(ao_tmp - 2);
2721 }
2722
2723 return 0;
2724}
2725
0aadc739 2726static inline bool tcp_ao_required(struct sock *sk, const void *saddr,
248411b8 2727 int family, int l3index, bool stat_inc)
0aadc739
DS
2728{
2729#ifdef CONFIG_TCP_AO
2730 struct tcp_ao_info *ao_info;
2731 struct tcp_ao_key *ao_key;
2732
67fa83f7
DS
2733 if (!static_branch_unlikely(&tcp_ao_needed.key))
2734 return false;
2735
0aadc739
DS
2736 ao_info = rcu_dereference_check(tcp_sk(sk)->ao_info,
2737 lockdep_sock_is_held(sk));
2738 if (!ao_info)
2739 return false;
2740
248411b8 2741 ao_key = tcp_ao_do_lookup(sk, l3index, saddr, family, -1, -1);
af09a341
DS
2742 if (ao_info->ao_required || ao_key) {
2743 if (stat_inc) {
2744 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAOREQUIRED);
2745 atomic64_inc(&ao_info->counters.ao_required);
2746 }
0aadc739 2747 return true;
af09a341 2748 }
0aadc739
DS
2749#endif
2750 return false;
2751}
2752
0a3a8090
DS
2753/* Called with rcu_read_lock() */
2754static inline enum skb_drop_reason
2755tcp_inbound_hash(struct sock *sk, const struct request_sock *req,
2756 const struct sk_buff *skb,
2757 const void *saddr, const void *daddr,
2758 int family, int dif, int sdif)
2759{
2760 const struct tcphdr *th = tcp_hdr(skb);
2761 const struct tcp_ao_hdr *aoh;
2762 const __u8 *md5_location;
2763 int l3index;
2764
2765 /* Invalid option or two times meet any of auth options */
2717b5ad
DS
2766 if (tcp_parse_auth_options(th, &md5_location, &aoh)) {
2767 tcp_hash_fail("TCP segment has incorrect auth options set",
2768 family, skb, "");
0a3a8090 2769 return SKB_DROP_REASON_TCP_AUTH_HDR;
2717b5ad 2770 }
0a3a8090
DS
2771
2772 if (req) {
af09a341
DS
2773 if (tcp_rsk_used_ao(req) != !!aoh) {
2774 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAOBAD);
2717b5ad
DS
2775 tcp_hash_fail("TCP connection can't start/end using TCP-AO",
2776 family, skb, "%s",
2777 !aoh ? "missing AO" : "AO signed");
0a3a8090 2778 return SKB_DROP_REASON_TCP_AOFAILURE;
af09a341 2779 }
0a3a8090
DS
2780 }
2781
2782 /* sdif set, means packet ingressed via a device
2783 * in an L3 domain and dif is set to the l3mdev
2784 */
2785 l3index = sdif ? dif : 0;
2786
2787 /* Fast path: unsigned segments */
2788 if (likely(!md5_location && !aoh)) {
2789 /* Drop if there's TCP-MD5 or TCP-AO key with any rcvid/sndid
2790 * for the remote peer. On TCP-AO established connection
2791 * the last key is impossible to remove, so there's
2792 * always at least one current_key.
2793 */
248411b8 2794 if (tcp_ao_required(sk, saddr, family, l3index, true)) {
2717b5ad
DS
2795 tcp_hash_fail("AO hash is required, but not found",
2796 family, skb, "L3 index %d", l3index);
0a3a8090 2797 return SKB_DROP_REASON_TCP_AONOTFOUND;
2717b5ad 2798 }
0a3a8090
DS
2799 if (unlikely(tcp_md5_do_lookup(sk, l3index, saddr, family))) {
2800 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPMD5NOTFOUND);
248411b8
DS
2801 tcp_hash_fail("MD5 Hash not found",
2802 family, skb, "L3 index %d", l3index);
0a3a8090
DS
2803 return SKB_DROP_REASON_TCP_MD5NOTFOUND;
2804 }
2805 return SKB_NOT_DROPPED_YET;
2806 }
2807
2808 if (aoh)
248411b8 2809 return tcp_inbound_ao_hash(sk, skb, family, req, l3index, aoh);
0a3a8090
DS
2810
2811 return tcp_inbound_md5_hash(sk, skb, saddr, daddr, family,
2812 l3index, md5_location);
2813}
2814
1da177e4 2815#endif /* _TCP_H */