blob: e6920ae0765cc54570059d0a1aa43dba4e74c511 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070011 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14#ifndef _TCP_H
15#define _TCP_H
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#define FASTRETRANS_DEBUG 1
18
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/list.h>
20#include <linux/tcp.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050021#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/cache.h>
24#include <linux/percpu.h>
Herbert Xufb286bb2005-11-10 13:01:24 -080025#include <linux/skbuff.h>
William Allen Simpson435cf552009-12-02 18:17:05 +000026#include <linux/kref.h>
Eric Dumazet740b0f12014-02-26 14:02:48 -080027#include <linux/ktime.h>
Eric Dumazet05e22e82020-06-19 12:12:34 -070028#include <linux/indirect_call_wrapper.h>
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -070029
30#include <net/inet_connection_sock.h>
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070031#include <net/inet_timewait_sock.h>
Arnaldo Carvalho de Melo77d8bf92005-08-09 20:00:51 -070032#include <net/inet_hashtables.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <net/checksum.h>
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -070034#include <net/request_sock.h>
Martin KaFai Lau40a12272018-08-08 01:01:21 -070035#include <net/sock_reuseport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <net/sock.h>
37#include <net/snmp.h>
38#include <net/ip.h>
Arnaldo Carvalho de Meloc752f072005-08-09 20:08:28 -070039#include <net/tcp_states.h>
Ilpo Järvinenbdf1ee52007-05-27 02:04:16 -070040#include <net/inet_ecn.h>
Satoru SATOH0c266892009-05-04 11:11:01 -070041#include <net/dst.h>
Mat Martineau85712482020-01-09 07:59:20 -080042#include <net/mptcp.h>
Arnaldo Carvalho de Meloc752f072005-08-09 20:08:28 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/seq_file.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000045#include <linux/memcontrol.h>
Lawrence Brakmo40304b22017-06-30 20:02:40 -070046#include <linux/bpf-cgroup.h>
Ard Biesheuvel438ac882019-06-19 23:46:28 +020047#include <linux/siphash.h>
Lawrence Brakmo40304b22017-06-30 20:02:40 -070048
Arnaldo Carvalho de Melo6e04e022005-08-09 20:07:35 -070049extern struct inet_hashinfo tcp_hashinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Eric Dumazetdd24c002008-11-25 21:17:14 -080051extern struct percpu_counter tcp_orphan_count;
Joe Perches5c9f3022013-09-23 11:33:32 -070052void tcp_time_wait(struct sock *sk, int state, int timeo);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Eric Dumazet9bacd252020-04-17 07:10:23 -070054#define MAX_TCP_HEADER L1_CACHE_ALIGN(128 + MAX_HEADER)
Adam Langley33ad7982008-07-19 00:04:31 -070055#define MAX_TCP_OPTION_SPACE 40
Eric Dumazet3b4929f2019-05-17 17:17:22 -070056#define TCP_MIN_SND_MSS 48
57#define TCP_MIN_GSO_SIZE (TCP_MIN_SND_MSS - MAX_TCP_OPTION_SPACE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Kenjiro Nakayama105970f2014-10-20 18:15:50 +090059/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * Never offer a window over 32767 without using window scaling. Some
Kenjiro Nakayama105970f2014-10-20 18:15:50 +090061 * poor stacks do signed 16bit maths!
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 */
63#define MAX_TCP_WINDOW 32767U
64
65/* Minimal accepted MSS. It is (60+60+8) - (20+20). */
66#define TCP_MIN_MSS 88U
67
Josh Hunt1555e6f2019-08-07 19:52:30 -040068/* The initial MTU to use for probing */
Fan Dudcd8fb82015-03-06 11:18:22 +080069#define TCP_BASE_MSS 1024
John Heffner5d424d52006-03-20 17:53:41 -080070
Fan Du05cbc0d2015-03-06 11:18:24 +080071/* probing interval, default to 10 minutes as per RFC4821 */
72#define TCP_PROBE_INTERVAL 600
73
Fan Du6b58e0a2015-03-06 11:18:23 +080074/* Specify interval when tcp mtu probing will stop */
75#define TCP_PROBE_THRESHOLD 8
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* After receiving this amount of duplicate ACKs fast retransmit starts. */
78#define TCP_FASTRETRANS_THRESH 3
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080/* Maximal number of ACKs sent quickly to accelerate slow-start. */
81#define TCP_MAX_QUICKACKS 16U
82
Gao Feng589c49c2017-04-04 21:09:48 +080083/* Maximal number of window scale according to RFC1323 */
84#define TCP_MAX_WSCALE 14U
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/* urg_data states */
87#define TCP_URG_VALID 0x0100
88#define TCP_URG_NOTYET 0x0200
89#define TCP_URG_READ 0x0400
90
91#define TCP_RETR1 3 /*
92 * This is how many retries it does before it
93 * tries to figure out if the gateway is
94 * down. Minimal RFC value is 3; it corresponds
95 * to ~3sec-8min depending on RTO.
96 */
97
98#define TCP_RETR2 15 /*
99 * This should take at least
100 * 90 minutes to time out.
101 * RFC1122 says that the limit is 100 sec.
102 * 15 is ~13-30min depending on RTO.
103 */
104
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000105#define TCP_SYN_RETRIES 6 /* This is how many retries are done
106 * when active opening a connection.
107 * RFC1122 says the minimum retry MUST
108 * be at least 180secs. Nevertheless
109 * this value is corresponding to
110 * 63secs of retransmission with the
111 * current initial RTO.
112 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Alex Bergmann6c9ff972012-08-31 02:48:31 +0000114#define TCP_SYNACK_RETRIES 5 /* This is how may retries are done
115 * when passive opening a connection.
116 * This is corresponding to 31secs of
117 * retransmission with the current
118 * initial RTO.
119 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
122 * state, about 60 seconds */
123#define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
124 /* BSD style FIN_WAIT2 deadlock breaker.
125 * It used to be 3min, new value is 60sec,
126 * to combine FIN-WAIT-2 timeout with
127 * TIME-WAIT timer.
128 */
Cambda Zhuf0628c52020-04-24 16:06:16 +0800129#define TCP_FIN_TIMEOUT_MAX (120 * HZ) /* max TCP_LINGER2 value (two minutes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131#define TCP_DELACK_MAX ((unsigned)(HZ/5)) /* maximal time to delay before sending an ACK */
132#if HZ >= 100
133#define TCP_DELACK_MIN ((unsigned)(HZ/25)) /* minimal time to delay before sending an ACK */
134#define TCP_ATO_MIN ((unsigned)(HZ/25))
135#else
136#define TCP_DELACK_MIN 4U
137#define TCP_ATO_MIN 4U
138#endif
139#define TCP_RTO_MAX ((unsigned)(120*HZ))
140#define TCP_RTO_MIN ((unsigned)(HZ/5))
Yuchung Chengbb4d9912017-07-19 15:41:26 -0700141#define TCP_TIMEOUT_MIN (2U) /* Min timeout for TCP timers in jiffies */
Eric Dumazetfd4f2ce2012-04-12 19:48:40 +0000142#define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC6298 2.1 initial RTO value */
Jerry Chu9ad7c042011-06-08 11:08:38 +0000143#define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now
144 * used as a fallback RTO for the
145 * initial data transmission if no
146 * valid RTT sample has been acquired,
147 * most likely due to retrans in 3WHS.
148 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150#define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
151 * for local resources.
152 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#define TCP_KEEPALIVE_TIME (120*60*HZ) /* two hours */
154#define TCP_KEEPALIVE_PROBES 9 /* Max of 9 keepalive probes */
155#define TCP_KEEPALIVE_INTVL (75*HZ)
156
157#define MAX_TCP_KEEPIDLE 32767
158#define MAX_TCP_KEEPINTVL 32767
159#define MAX_TCP_KEEPCNT 127
160#define MAX_TCP_SYNCNT 127
161
162#define TCP_SYNQ_INTERVAL (HZ/5) /* Period of SYNACK timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164#define TCP_PAWS_24DAYS (60 * 60 * 24 * 24)
165#define TCP_PAWS_MSL 60 /* Per-host timestamps are invalidated
166 * after this time. It should be equal
167 * (or greater than) TCP_TIMEWAIT_LEN
168 * to provide reliability equal to one
169 * provided by timewait state.
170 */
171#define TCP_PAWS_WINDOW 1 /* Replay window for per-host
172 * timestamps. It must be less than
173 * minimal timewait lifetime.
174 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/*
176 * TCP option
177 */
Kenjiro Nakayama105970f2014-10-20 18:15:50 +0900178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179#define TCPOPT_NOP 1 /* Padding */
180#define TCPOPT_EOL 0 /* End of options */
181#define TCPOPT_MSS 2 /* Segment size negotiating */
182#define TCPOPT_WINDOW 3 /* Window scaling */
183#define TCPOPT_SACK_PERM 4 /* SACK Permitted */
184#define TCPOPT_SACK 5 /* SACK Block */
185#define TCPOPT_TIMESTAMP 8 /* Better RTT estimations/PAWS */
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -0800186#define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */
Mat Martineauc74a39c2020-01-09 07:59:17 -0800187#define TCPOPT_MPTCP 30 /* Multipath TCP (RFC6824) */
Daniel Lee7f9b8382015-04-06 14:37:26 -0700188#define TCPOPT_FASTOPEN 34 /* Fast open (RFC7413) */
Yuchung Cheng2100c8d2012-07-19 06:43:05 +0000189#define TCPOPT_EXP 254 /* Experimental */
190/* Magic number to be after the option value for sharing TCP
191 * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
192 */
193#define TCPOPT_FASTOPEN_MAGIC 0xF989
Ursula Braun60e2a772017-10-25 11:01:45 +0200194#define TCPOPT_SMC_MAGIC 0xE2D4C3D9
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196/*
197 * TCP option lengths
198 */
199
200#define TCPOLEN_MSS 4
201#define TCPOLEN_WINDOW 3
202#define TCPOLEN_SACK_PERM 2
203#define TCPOLEN_TIMESTAMP 10
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -0800204#define TCPOLEN_MD5SIG 18
Daniel Lee7f9b8382015-04-06 14:37:26 -0700205#define TCPOLEN_FASTOPEN_BASE 2
Yuchung Cheng2100c8d2012-07-19 06:43:05 +0000206#define TCPOLEN_EXP_FASTOPEN_BASE 4
Ursula Braun60e2a772017-10-25 11:01:45 +0200207#define TCPOLEN_EXP_SMC_BASE 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209/* But this is what stacks really send out. */
210#define TCPOLEN_TSTAMP_ALIGNED 12
211#define TCPOLEN_WSCALE_ALIGNED 4
212#define TCPOLEN_SACKPERM_ALIGNED 4
213#define TCPOLEN_SACK_BASE 2
214#define TCPOLEN_SACK_BASE_ALIGNED 4
215#define TCPOLEN_SACK_PERBLOCK 8
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -0800216#define TCPOLEN_MD5SIG_ALIGNED 20
Adam Langley33ad7982008-07-19 00:04:31 -0700217#define TCPOLEN_MSS_ALIGNED 4
Ursula Braun60e2a772017-10-25 11:01:45 +0200218#define TCPOLEN_EXP_SMC_BASE_ALIGNED 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220/* Flags in tp->nonagle */
221#define TCP_NAGLE_OFF 1 /* Nagle's algo is disabled */
222#define TCP_NAGLE_CORK 2 /* Socket is corked */
Stephen Hemmingercaa20d9a2005-11-10 17:13:47 -0800223#define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Andreas Petlund36e31b0a2010-02-18 02:47:01 +0000225/* TCP thin-stream limits */
226#define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */
227
Jörg Thalheim21603fc2016-01-27 22:54:06 +0100228/* TCP initial congestion window as per rfc6928 */
David S. Miller442b9632011-02-02 17:05:11 -0800229#define TCP_INIT_CWND 10
230
Yuchung Chengcf60af02012-07-19 06:43:09 +0000231/* Bit Flags for sysctl_tcp_fastopen */
232#define TFO_CLIENT_ENABLE 1
Jerry Chu10467162012-08-31 12:29:11 +0000233#define TFO_SERVER_ENABLE 2
Yuchung Cheng67da22d2012-07-19 06:43:11 +0000234#define TFO_CLIENT_NO_COOKIE 4 /* Data in SYN w/o cookie option */
Yuchung Chengcf60af02012-07-19 06:43:09 +0000235
Jerry Chu10467162012-08-31 12:29:11 +0000236/* Accept SYN data w/o any cookie option */
237#define TFO_SERVER_COOKIE_NOT_REQD 0x200
238
239/* Force enable TFO on all listeners, i.e., not requiring the
Yuchung Chengcebc5cb2016-08-22 17:17:54 -0700240 * TCP_FASTOPEN socket option.
Jerry Chu10467162012-08-31 12:29:11 +0000241 */
242#define TFO_SERVER_WO_SOCKOPT1 0x400
Jerry Chu10467162012-08-31 12:29:11 +0000243
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -0700244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245/* sysctl variables for tcp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246extern int sysctl_tcp_max_orphans;
Eric W. Biedermana4fe34b2013-10-19 16:25:36 -0700247extern long sysctl_tcp_mem[3];
Eric Dumazete20223f2017-10-26 21:54:57 -0700248
Yuchung Chenga0370b32017-01-12 22:11:36 -0800249#define TCP_RACK_LOSS_DETECTION 0x1 /* Use RACK to detect losses */
Priyaranjan Jha1f255692017-11-03 16:38:48 -0700250#define TCP_RACK_STATIC_REO_WND 0x2 /* Use static RACK reo wnd */
Yuchung Cheng20b654d2018-05-16 16:40:10 -0700251#define TCP_RACK_NO_DUPTHRESH 0x4 /* Do not use DUPACK threshold in RACK */
Yuchung Chenga0370b32017-01-12 22:11:36 -0800252
Eric Dumazet8d987e52010-11-09 23:24:26 +0000253extern atomic_long_t tcp_memory_allocated;
Eric Dumazet17483762008-11-25 21:16:35 -0800254extern struct percpu_counter tcp_sockets_allocated;
Eric Dumazet06044752017-06-07 13:29:12 -0700255extern unsigned long tcp_memory_pressure;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Eric Dumazetb8da51e2015-05-15 12:39:27 -0700257/* optimized version of sk_under_memory_pressure() for TCP sockets */
258static inline bool tcp_under_memory_pressure(const struct sock *sk)
259{
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800260 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
261 mem_cgroup_under_socket_pressure(sk->sk_memcg))
Johannes Weinere8056052016-01-14 15:21:14 -0800262 return true;
Eric Dumazetb8da51e2015-05-15 12:39:27 -0700263
Eric Dumazet1f142c12019-10-09 15:10:15 -0700264 return READ_ONCE(tcp_memory_pressure);
Eric Dumazetb8da51e2015-05-15 12:39:27 -0700265}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 * The next routines deal with comparing 32 bit unsigned ints
268 * and worry about wraparound (automatic with unsigned arithmetic).
269 */
270
Eric Dumazeta2a385d2012-05-16 23:15:34 +0000271static inline bool before(__u32 seq1, __u32 seq2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
Gerrit Renker0d630cc2007-01-04 12:25:16 -0800273 return (__s32)(seq1-seq2) < 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
Gerrit Renker9a036b9c2006-12-20 10:25:55 -0800275#define after(seq2, seq1) before(seq1, seq2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/* is s2<=s1<=s3 ? */
Eric Dumazeta2a385d2012-05-16 23:15:34 +0000278static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279{
280 return seq3 - seq2 >= seq1 - seq2;
281}
282
Arun Sharmaefcdbf22012-01-30 14:16:06 -0800283static inline bool tcp_out_of_memory(struct sock *sk)
284{
285 if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
286 sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
287 return true;
288 return false;
289}
290
Eric Dumazeta6c5ea42015-05-15 12:39:26 -0700291void sk_forced_mem_schedule(struct sock *sk, int size);
292
David S. Millerad1af0f2010-08-25 02:27:49 -0700293static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
Pavel Emelianove4fd5da2007-05-29 13:19:18 -0700294{
David S. Millerad1af0f2010-08-25 02:27:49 -0700295 struct percpu_counter *ocp = sk->sk_prot->orphan_count;
296 int orphans = percpu_counter_read_positive(ocp);
297
298 if (orphans << shift > sysctl_tcp_max_orphans) {
299 orphans = percpu_counter_sum_positive(ocp);
300 if (orphans << shift > sysctl_tcp_max_orphans)
301 return true;
302 }
David S. Millerad1af0f2010-08-25 02:27:49 -0700303 return false;
Pavel Emelianove4fd5da2007-05-29 13:19:18 -0700304}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
Joe Perches5c9f3022013-09-23 11:33:32 -0700306bool tcp_check_oom(struct sock *sk, int shift);
Arun Sharmaefcdbf22012-01-30 14:16:06 -0800307
Florian Westphala0f82f62009-04-19 09:43:48 +0000308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309extern struct proto tcp_prot;
310
Pavel Emelyanov57ef42d2008-07-18 04:02:08 -0700311#define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field)
Eric Dumazet13415e42016-04-27 16:44:43 -0700312#define __TCP_INC_STATS(net, field) __SNMP_INC_STATS((net)->mib.tcp_statistics, field)
Pavel Emelyanov57ef42d2008-07-18 04:02:08 -0700313#define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
Tom Herbertaa2ea052010-04-22 07:00:24 +0000314#define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Joe Perches5c9f3022013-09-23 11:33:32 -0700316void tcp_tasklet_init(void);
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000317
Stefano Brivio32bbd872018-11-08 12:19:21 +0100318int tcp_v4_err(struct sk_buff *skb, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Joe Perches5c9f3022013-09-23 11:33:32 -0700320void tcp_shutdown(struct sock *sk, int how);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Paolo Abeni74874492017-09-28 15:51:36 +0200322int tcp_v4_early_demux(struct sk_buff *skb);
Joe Perches5c9f3022013-09-23 11:33:32 -0700323int tcp_v4_rcv(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Joe Perches5c9f3022013-09-23 11:33:32 -0700325int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
Ying Xue1b784142015-03-02 15:37:48 +0800326int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
Tom Herbert306b13e2017-07-28 16:22:41 -0700327int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size);
Joe Perches5c9f3022013-09-23 11:33:32 -0700328int tcp_sendpage(struct sock *sk, struct page *page, int offset, size_t size,
329 int flags);
Tom Herbert306b13e2017-07-28 16:22:41 -0700330int tcp_sendpage_locked(struct sock *sk, struct page *page, int offset,
331 size_t size, int flags);
Dave Watsone3b56162017-06-14 11:37:26 -0700332ssize_t do_tcp_sendpages(struct sock *sk, struct page *page, int offset,
333 size_t size, int flags);
Mat Martineau35b2c322020-01-09 07:59:21 -0800334int tcp_send_mss(struct sock *sk, int *size_goal, int flags);
335void tcp_push(struct sock *sk, int flags, int mss_now, int nonagle,
336 int size_goal);
Joe Perches5c9f3022013-09-23 11:33:32 -0700337void tcp_release_cb(struct sock *sk);
338void tcp_wfree(struct sk_buff *skb);
339void tcp_write_timer_handler(struct sock *sk);
340void tcp_delack_timer_handler(struct sock *sk);
341int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg);
Eric Dumazet72ab4a82015-09-29 07:42:41 -0700342int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb);
Yafang Shao3d97d882018-05-29 23:27:31 +0800343void tcp_rcv_established(struct sock *sk, struct sk_buff *skb);
Joe Perches5c9f3022013-09-23 11:33:32 -0700344void tcp_rcv_space_adjust(struct sock *sk);
Joe Perches5c9f3022013-09-23 11:33:32 -0700345int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
346void tcp_twsk_destructor(struct sock *sk);
347ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
348 struct pipe_inode_info *pipe, size_t len,
349 unsigned int flags);
Jens Axboe9c55e012007-11-06 23:30:13 -0800350
Yuchung Chenga0496ef22018-07-18 13:56:36 -0700351void tcp_enter_quickack_mode(struct sock *sk, unsigned int max_quickacks);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700352static inline void tcp_dec_quickack_mode(struct sock *sk,
353 const unsigned int pkts)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700355 struct inet_connection_sock *icsk = inet_csk(sk);
David S. Millerfc6415bc2005-07-05 15:17:45 -0700356
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700357 if (icsk->icsk_ack.quick) {
358 if (pkts >= icsk->icsk_ack.quick) {
359 icsk->icsk_ack.quick = 0;
David S. Millerfc6415bc2005-07-05 15:17:45 -0700360 /* Leaving quickack mode we deflate ATO. */
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700361 icsk->icsk_ack.ato = TCP_ATO_MIN;
David S. Millerfc6415bc2005-07-05 15:17:45 -0700362 } else
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700363 icsk->icsk_ack.quick -= pkts;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 }
365}
366
Ilpo Järvinenbdf1ee52007-05-27 02:04:16 -0700367#define TCP_ECN_OK 1
368#define TCP_ECN_QUEUE_CWR 2
369#define TCP_ECN_DEMAND_CWR 4
Eric Dumazet7a269ff2011-09-22 20:02:19 +0000370#define TCP_ECN_SEEN 8
Ilpo Järvinenbdf1ee52007-05-27 02:04:16 -0700371
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000372enum tcp_tw_status {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 TCP_TW_SUCCESS = 0,
374 TCP_TW_RST = 1,
375 TCP_TW_ACK = 2,
376 TCP_TW_SYN = 3
377};
378
379
Joe Perches5c9f3022013-09-23 11:33:32 -0700380enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
381 struct sk_buff *skb,
382 const struct tcphdr *th);
383struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
Eric Dumazete0f97592018-02-13 06:14:12 -0800384 struct request_sock *req, bool fastopen,
385 bool *lost_race);
Joe Perches5c9f3022013-09-23 11:33:32 -0700386int tcp_child_process(struct sock *parent, struct sock *child,
387 struct sk_buff *skb);
Neal Cardwell5ae344c2014-08-04 19:12:29 -0400388void tcp_enter_loss(struct sock *sk);
Yuchung Cheng57dde7f2017-01-12 22:11:33 -0800389void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int flag);
Joe Perches5c9f3022013-09-23 11:33:32 -0700390void tcp_clear_retrans(struct tcp_sock *tp);
391void tcp_update_metrics(struct sock *sk);
392void tcp_init_metrics(struct sock *sk);
393void tcp_metrics_init(void);
Soheil Hassas Yeganehd82bae12017-03-15 16:30:45 -0400394bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst);
Joe Perches5c9f3022013-09-23 11:33:32 -0700395void tcp_close(struct sock *sk, long timeout);
396void tcp_init_sock(struct sock *sk);
Wei Wang27204aa2017-10-04 10:03:44 -0700397void tcp_init_transfer(struct sock *sk, int bpf_op);
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700398__poll_t tcp_poll(struct file *file, struct socket *sock,
399 struct poll_table_struct *wait);
Joe Perches5c9f3022013-09-23 11:33:32 -0700400int tcp_getsockopt(struct sock *sk, int level, int optname,
401 char __user *optval, int __user *optlen);
402int tcp_setsockopt(struct sock *sk, int level, int optname,
403 char __user *optval, unsigned int optlen);
404int compat_tcp_getsockopt(struct sock *sk, int level, int optname,
Changli Gao53d31762010-07-10 20:41:06 +0000405 char __user *optval, int __user *optlen);
Joe Perches5c9f3022013-09-23 11:33:32 -0700406int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
Changli Gao53d31762010-07-10 20:41:06 +0000407 char __user *optval, unsigned int optlen);
Joe Perches5c9f3022013-09-23 11:33:32 -0700408void tcp_set_keepalive(struct sock *sk, int val);
Eric Dumazet42cb80a2015-03-22 10:22:19 -0700409void tcp_syn_ack_timeout(const struct request_sock *req);
Ying Xue1b784142015-03-02 15:37:48 +0800410int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int nonblock,
411 int flags, int *addr_len);
Eric Dumazetd1361842018-04-16 10:33:35 -0700412int tcp_set_rcvlowat(struct sock *sk, int val);
Eric Dumazet03f45c82018-04-16 10:33:37 -0700413void tcp_data_ready(struct sock *sk);
Yafang Shao340a6f32019-01-17 18:03:14 +0800414#ifdef CONFIG_MMU
Eric Dumazet93ab6cc2018-04-16 10:33:38 -0700415int tcp_mmap(struct file *file, struct socket *sock,
416 struct vm_area_struct *vma);
Yafang Shao340a6f32019-01-17 18:03:14 +0800417#endif
Eric Dumazeteed29f12017-06-07 10:34:36 -0700418void tcp_parse_options(const struct net *net, const struct sk_buff *skb,
Joe Perches5c9f3022013-09-23 11:33:32 -0700419 struct tcp_options_received *opt_rx,
420 int estab, struct tcp_fastopen_cookie *foc);
421const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
YOSHIFUJI Hideaki7d5d5522008-04-17 12:29:53 +0900422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423/*
Petar Penkov9349d602019-07-29 09:59:14 -0700424 * BPF SKB-less helpers
425 */
426u16 tcp_v4_get_syncookie(struct sock *sk, struct iphdr *iph,
427 struct tcphdr *th, u32 *cookie);
428u16 tcp_v6_get_syncookie(struct sock *sk, struct ipv6hdr *iph,
429 struct tcphdr *th, u32 *cookie);
430u16 tcp_get_syncookie_mss(struct request_sock_ops *rsk_ops,
431 const struct tcp_request_sock_ops *af_ops,
432 struct sock *sk, struct tcphdr *th);
433/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 * TCP v4 functions exported for the inet6 API
435 */
436
Joe Perches5c9f3022013-09-23 11:33:32 -0700437void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
Neal Cardwell4fab9072014-08-14 12:40:05 -0400438void tcp_v4_mtu_reduced(struct sock *sk);
Eric Dumazet9cf74902016-02-02 19:31:12 -0800439void tcp_req_err(struct sock *sk, u32 seq, bool abort);
Eric Dumazetd2924562020-05-27 17:34:58 -0700440void tcp_ld_RTO_revert(struct sock *sk, u32 seq);
Joe Perches5c9f3022013-09-23 11:33:32 -0700441int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
Eric Dumazetc28c6f02015-09-29 07:42:47 -0700442struct sock *tcp_create_openreq_child(const struct sock *sk,
Joe Perches5c9f3022013-09-23 11:33:32 -0700443 struct request_sock *req,
444 struct sk_buff *skb);
Daniel Borkmann81164412015-01-05 23:57:48 +0100445void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
Eric Dumazet0c271712015-09-29 07:42:48 -0700446struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb,
Joe Perches5c9f3022013-09-23 11:33:32 -0700447 struct request_sock *req,
Eric Dumazet5e0724d2015-10-22 08:20:46 -0700448 struct dst_entry *dst,
449 struct request_sock *req_unhash,
450 bool *own_req);
Joe Perches5c9f3022013-09-23 11:33:32 -0700451int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
452int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len);
453int tcp_connect(struct sock *sk);
Eric Dumazetb3d05142016-04-13 22:05:39 -0700454enum tcp_synack_type {
455 TCP_SYNACK_NORMAL,
456 TCP_SYNACK_FASTOPEN,
457 TCP_SYNACK_COOKIE,
458};
Eric Dumazet5d062de2015-09-25 07:39:19 -0700459struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst,
Joe Perches5c9f3022013-09-23 11:33:32 -0700460 struct request_sock *req,
Eric Dumazetca6fb062015-10-02 11:43:35 -0700461 struct tcp_fastopen_cookie *foc,
Eric Dumazetb3d05142016-04-13 22:05:39 -0700462 enum tcp_synack_type synack_type);
Joe Perches5c9f3022013-09-23 11:33:32 -0700463int tcp_disconnect(struct sock *sk, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Pavel Emelyanov370816a2012-04-19 03:40:01 +0000465void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
Pavel Emelyanov292e8d82012-05-10 01:49:41 +0000466int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
Eric Dumazet63d02d12012-08-09 14:11:00 +0000467void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469/* From syncookies.c */
Eric Dumazetb80c0e72015-06-04 18:30:43 -0700470struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
471 struct request_sock *req,
Eric Dumazet84b114b2017-05-05 06:56:54 -0700472 struct dst_entry *dst, u32 tsoff);
Joe Perches5c9f3022013-09-23 11:33:32 -0700473int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
474 u32 cookie);
Cong Wang461b74c2014-10-15 14:33:22 -0700475struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
Eric Dumazete05c82d2011-09-18 21:02:55 -0400476#ifdef CONFIG_SYN_COOKIES
Florian Westphal8c27bd72013-09-20 22:32:55 +0200477
Eric Dumazet63262312014-03-19 21:02:21 -0700478/* Syncookies use a monotonic timer which increments every 60 seconds.
Florian Westphal8c27bd72013-09-20 22:32:55 +0200479 * This counter is used both as a hash input and partially encoded into
480 * the cookie value. A cookie is only validated further if the delta
481 * between the current counter value and the encoded one is less than this,
Eric Dumazet63262312014-03-19 21:02:21 -0700482 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
Florian Westphal8c27bd72013-09-20 22:32:55 +0200483 * the counter advances immediately after a cookie is generated).
484 */
Eric Dumazet264ea102015-05-14 14:26:56 -0700485#define MAX_SYNCOOKIE_AGE 2
486#define TCP_SYNCOOKIE_PERIOD (60 * HZ)
487#define TCP_SYNCOOKIE_VALID (MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)
488
489/* syncookies: remember time of last synqueue overflow
490 * But do not dirty this field too often (once per second is enough)
Eric Dumazet3f684b42015-09-29 07:42:49 -0700491 * It is racy as we do not hold a lock, but race is very minor.
Eric Dumazet264ea102015-05-14 14:26:56 -0700492 */
Eric Dumazet3f684b42015-09-29 07:42:49 -0700493static inline void tcp_synq_overflow(const struct sock *sk)
Eric Dumazet264ea102015-05-14 14:26:56 -0700494{
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700495 unsigned int last_overflow;
Arnd Bergmanncca9bab2018-07-11 12:16:12 +0200496 unsigned int now = jiffies;
Eric Dumazet264ea102015-05-14 14:26:56 -0700497
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700498 if (sk->sk_reuseport) {
499 struct sock_reuseport *reuse;
500
501 reuse = rcu_dereference(sk->sk_reuseport_cb);
502 if (likely(reuse)) {
503 last_overflow = READ_ONCE(reuse->synq_overflow_ts);
Guillaume Nault04d26e72019-12-06 12:38:36 +0100504 if (!time_between32(now, last_overflow,
505 last_overflow + HZ))
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700506 WRITE_ONCE(reuse->synq_overflow_ts, now);
507 return;
508 }
509 }
510
Guillaume Nault721c8da2019-12-06 12:38:49 +0100511 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
Guillaume Nault04d26e72019-12-06 12:38:36 +0100512 if (!time_between32(now, last_overflow, last_overflow + HZ))
Guillaume Nault721c8da2019-12-06 12:38:49 +0100513 WRITE_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp, now);
Eric Dumazet264ea102015-05-14 14:26:56 -0700514}
515
516/* syncookies: no recent synqueue overflow on this listening socket? */
517static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
518{
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700519 unsigned int last_overflow;
Arnd Bergmanncca9bab2018-07-11 12:16:12 +0200520 unsigned int now = jiffies;
Eric Dumazet264ea102015-05-14 14:26:56 -0700521
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700522 if (sk->sk_reuseport) {
523 struct sock_reuseport *reuse;
524
525 reuse = rcu_dereference(sk->sk_reuseport_cb);
526 if (likely(reuse)) {
527 last_overflow = READ_ONCE(reuse->synq_overflow_ts);
Guillaume Naultcb44a082019-12-06 12:38:43 +0100528 return !time_between32(now, last_overflow - HZ,
529 last_overflow +
530 TCP_SYNCOOKIE_VALID);
Martin KaFai Lau40a12272018-08-08 01:01:21 -0700531 }
532 }
533
Guillaume Nault721c8da2019-12-06 12:38:49 +0100534 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
Guillaume Naultcb44a082019-12-06 12:38:43 +0100535
536 /* If last_overflow <= jiffies <= last_overflow + TCP_SYNCOOKIE_VALID,
537 * then we're under synflood. However, we have to use
538 * 'last_overflow - HZ' as lower bound. That's because a concurrent
539 * tcp_synq_overflow() could update .ts_recent_stamp after we read
540 * jiffies but before we store .ts_recent_stamp into last_overflow,
541 * which could lead to rejecting a valid syncookie.
542 */
543 return !time_between32(now, last_overflow - HZ,
544 last_overflow + TCP_SYNCOOKIE_VALID);
Eric Dumazet264ea102015-05-14 14:26:56 -0700545}
Florian Westphal8c27bd72013-09-20 22:32:55 +0200546
547static inline u32 tcp_cookie_time(void)
548{
Eric Dumazet63262312014-03-19 21:02:21 -0700549 u64 val = get_jiffies_64();
550
Eric Dumazet264ea102015-05-14 14:26:56 -0700551 do_div(val, TCP_SYNCOOKIE_PERIOD);
Eric Dumazet63262312014-03-19 21:02:21 -0700552 return val;
Florian Westphal8c27bd72013-09-20 22:32:55 +0200553}
554
Joe Perches5c9f3022013-09-23 11:33:32 -0700555u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
556 u16 *mssp);
Eric Dumazet3f684b42015-09-29 07:42:49 -0700557__u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss);
Eric Dumazet200ecef2019-11-07 11:51:18 -0800558u64 cookie_init_timestamp(struct request_sock *req, u64 now);
Eric Dumazetf9301032017-06-07 10:34:37 -0700559bool cookie_timestamp_decode(const struct net *net,
560 struct tcp_options_received *opt);
Florian Westphalf1673382014-11-03 17:35:02 +0100561bool cookie_ecn_ok(const struct tcp_options_received *opt,
Florian Westphalf7b3bec2014-11-03 17:35:03 +0100562 const struct net *net, const struct dst_entry *dst);
Florian Westphal4dfc2812008-04-10 03:12:40 -0700563
Glenn Griffinc6aefaf2008-02-07 21:49:26 -0800564/* From net/ipv6/syncookies.c */
Joe Perches5c9f3022013-09-23 11:33:32 -0700565int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th,
566 u32 cookie);
567struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
Florian Westphalf1673382014-11-03 17:35:02 +0100568
Joe Perches5c9f3022013-09-23 11:33:32 -0700569u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
570 const struct tcphdr *th, u16 *mssp);
Eric Dumazet3f684b42015-09-29 07:42:49 -0700571__u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss);
Eric Dumazete05c82d2011-09-18 21:02:55 -0400572#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573/* tcp_output.c */
574
Joe Perches5c9f3022013-09-23 11:33:32 -0700575void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
576 int nonagle);
Eric Dumazet10d3be52016-04-21 10:55:23 -0700577int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
578int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
Joe Perches5c9f3022013-09-23 11:33:32 -0700579void tcp_retransmit_timer(struct sock *sk);
580void tcp_xmit_retransmit_queue(struct sock *);
581void tcp_simple_retransmit(struct sock *);
Yuchung Cheng57dde7f2017-01-12 22:11:33 -0800582void tcp_enter_recovery(struct sock *sk, bool ece_ack);
Joe Perches5c9f3022013-09-23 11:33:32 -0700583int tcp_trim_head(struct sock *, struct sk_buff *, u32);
Eric Dumazet75c119a2017-10-05 22:21:27 -0700584enum tcp_queue {
585 TCP_FRAG_IN_WRITE_QUEUE,
586 TCP_FRAG_IN_RTX_QUEUE,
587};
588int tcp_fragment(struct sock *sk, enum tcp_queue tcp_queue,
589 struct sk_buff *skb, u32 len,
590 unsigned int mss_now, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Joe Perches5c9f3022013-09-23 11:33:32 -0700592void tcp_send_probe0(struct sock *);
593void tcp_send_partial(struct sock *);
Eric Dumazete520af42015-05-06 14:26:25 -0700594int tcp_write_wakeup(struct sock *, int mib);
Joe Perches5c9f3022013-09-23 11:33:32 -0700595void tcp_send_fin(struct sock *sk);
596void tcp_send_active_reset(struct sock *sk, gfp_t priority);
597int tcp_send_synack(struct sock *);
Joe Perches5c9f3022013-09-23 11:33:32 -0700598void tcp_push_one(struct sock *, unsigned int mss_now);
Yuchung Cheng27cde442018-07-18 13:56:35 -0700599void __tcp_send_ack(struct sock *sk, u32 rcv_nxt);
Joe Perches5c9f3022013-09-23 11:33:32 -0700600void tcp_send_ack(struct sock *sk);
601void tcp_send_delayed_ack(struct sock *sk);
602void tcp_send_loss_probe(struct sock *sk);
Neal Cardwelled66dfa2017-11-17 21:06:14 -0500603bool tcp_schedule_loss_probe(struct sock *sk, bool advancing_rto);
Martin KaFai Laucfea5a62016-04-19 22:39:29 -0700604void tcp_skb_collapse_tstamp(struct sk_buff *skb,
605 const struct sk_buff *next_skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
David S. Millera762a982005-07-05 15:18:51 -0700607/* tcp_input.c */
Joe Perches5c9f3022013-09-23 11:33:32 -0700608void tcp_rearm_rto(struct sock *sk);
Yuchung Cheng0f1c28a2015-09-18 11:36:14 -0700609void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req);
Joe Perches5c9f3022013-09-23 11:33:32 -0700610void tcp_reset(struct sock *sk);
Yuchung Cheng4f41b1c2015-10-16 21:57:47 -0700611void tcp_skb_mark_lost_uncond_verify(struct tcp_sock *tp, struct sk_buff *skb);
Eric Dumazete3e17b72016-02-06 11:16:28 -0800612void tcp_fin(struct sock *sk);
David S. Millera762a982005-07-05 15:18:51 -0700613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614/* tcp_timer.c */
Joe Perches5c9f3022013-09-23 11:33:32 -0700615void tcp_init_xmit_timers(struct sock *);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700616static inline void tcp_clear_xmit_timers(struct sock *sk)
617{
Eric Dumazet73a6bab2018-05-10 14:59:43 -0700618 if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1)
Eric Dumazetcf0dd202018-05-17 14:47:24 -0700619 __sock_put(sk);
Eric Dumazet73a6bab2018-05-10 14:59:43 -0700620
Eric Dumazet5d9f4262018-05-17 14:47:26 -0700621 if (hrtimer_try_to_cancel(&tcp_sk(sk)->compressed_ack_timer) == 1)
622 __sock_put(sk);
623
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700624 inet_csk_clear_xmit_timers(sk);
625}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Joe Perches5c9f3022013-09-23 11:33:32 -0700627unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
628unsigned int tcp_current_mss(struct sock *sk);
Ilpo Järvinen0c54b852009-03-14 14:23:05 +0000629
630/* Bound MSS / TSO packet size with the half of the window */
631static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
632{
Alexey Kuznetsov01f83d62010-09-15 10:27:52 -0700633 int cutoff;
634
635 /* When peer uses tiny windows, there is no use in packetizing
636 * to sub-MSS pieces for the sake of SWS or making sure there
637 * are enough packets in the pipe for fast recovery.
638 *
639 * On the other hand, for extremely large MSS devices, handling
640 * smaller than MSS windows in this way does make sense.
641 */
Seymour, Shane M2631b792016-06-28 23:06:48 +0000642 if (tp->max_window > TCP_MSS_DEFAULT)
Alexey Kuznetsov01f83d62010-09-15 10:27:52 -0700643 cutoff = (tp->max_window >> 1);
644 else
645 cutoff = tp->max_window;
646
647 if (cutoff && pktsize > cutoff)
648 return max_t(int, cutoff, 68U - tp->tcp_header_len);
Ilpo Järvinen0c54b852009-03-14 14:23:05 +0000649 else
650 return pktsize;
651}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Arnaldo Carvalho de Melo17b085e2005-08-12 12:59:17 -0300653/* tcp.c */
Eric Dumazet0df48c22015-04-28 15:28:17 -0700654void tcp_get_info(struct sock *, struct tcp_info *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
656/* Read 'sendfile()'-style from a TCP socket */
Joe Perches5c9f3022013-09-23 11:33:32 -0700657int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
658 sk_read_actor_t recv_actor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Joe Perches5c9f3022013-09-23 11:33:32 -0700660void tcp_initialize_rcv_mss(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Joe Perches5c9f3022013-09-23 11:33:32 -0700662int tcp_mtu_to_mss(struct sock *sk, int pmtu);
663int tcp_mss_to_mtu(struct sock *sk, int mss);
664void tcp_mtup_init(struct sock *sk);
John Heffner5d424d52006-03-20 17:53:41 -0800665
Damian Lukowskif1ecd5d2009-08-26 00:16:31 +0000666static inline void tcp_bound_rto(const struct sock *sk)
667{
668 if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
669 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
670}
671
672static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
673{
Eric Dumazet740b0f12014-02-26 14:02:48 -0800674 return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
Damian Lukowskif1ecd5d2009-08-26 00:16:31 +0000675}
676
Florian Westphal31770e32017-08-30 19:24:58 +0200677static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
678{
679 tp->pred_flags = htonl((tp->tcp_header_len << 26) |
680 ntohl(TCP_FLAG_ACK) |
681 snd_wnd);
682}
683
684static inline void tcp_fast_path_on(struct tcp_sock *tp)
685{
686 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
687}
688
689static inline void tcp_fast_path_check(struct sock *sk)
690{
691 struct tcp_sock *tp = tcp_sk(sk);
692
693 if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
694 tp->rcv_wnd &&
695 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
696 !tp->urg_data)
697 tcp_fast_path_on(tp);
698}
699
Satoru SATOH0c266892009-05-04 11:11:01 -0700700/* Compute the actual rto_min value */
701static inline u32 tcp_rto_min(struct sock *sk)
702{
Eric Dumazetcf533ea2011-10-21 05:22:42 -0400703 const struct dst_entry *dst = __sk_dst_get(sk);
Satoru SATOH0c266892009-05-04 11:11:01 -0700704 u32 rto_min = TCP_RTO_MIN;
705
706 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
707 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
708 return rto_min;
709}
710
Eric Dumazet740b0f12014-02-26 14:02:48 -0800711static inline u32 tcp_rto_min_us(struct sock *sk)
712{
713 return jiffies_to_usecs(tcp_rto_min(sk));
714}
715
Daniel Borkmann81164412015-01-05 23:57:48 +0100716static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
717{
718 return dst_metric_locked(dst, RTAX_CC_ALGO);
719}
720
Yuchung Chengf6722582015-10-16 21:57:42 -0700721/* Minimum RTT in usec. ~0 means not available. */
722static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
723{
Neal Cardwell64033892016-09-19 23:39:10 -0400724 return minmax_get(&tp->rtt_min);
Yuchung Chengf6722582015-10-16 21:57:42 -0700725}
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/* Compute the actual receive window we are currently advertising.
728 * Rcv_nxt can be after the window if our peer push more data
729 * than the offered window.
730 */
Stephen Hemminger40efc6f2006-01-03 16:03:49 -0800731static inline u32 tcp_receive_window(const struct tcp_sock *tp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
733 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
734
735 if (win < 0)
736 win = 0;
737 return (u32) win;
738}
739
740/* Choose a new window, without checks for shrinking, and without
741 * scaling applied to the result. The caller does these things
742 * if necessary. This is a "raw" window selection.
743 */
Joe Perches5c9f3022013-09-23 11:33:32 -0700744u32 __tcp_select_window(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Pavel Emelyanovee995282012-04-19 03:40:39 +0000746void tcp_send_window_probe(struct sock *sk);
747
Eric Dumazetec66eda2017-05-16 14:00:01 -0700748/* TCP uses 32bit jiffies to save some space.
749 * Note that this is different from tcp_time_stamp, which
750 * historically has been the same until linux-4.13.
751 */
752#define tcp_jiffies32 ((u32)jiffies)
753
Eric Dumazet9a568de2017-05-16 14:00:14 -0700754/*
755 * Deliver a 32bit value for TCP timestamp option (RFC 7323)
756 * It is no longer tied to jiffies, but to 1 ms clock.
757 * Note: double check if you want to use tcp_jiffies32 instead of this.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 */
Eric Dumazet9a568de2017-05-16 14:00:14 -0700759#define TCP_TS_HZ 1000
760
761static inline u64 tcp_clock_ns(void)
762{
Eric Dumazetfb420d52018-09-28 10:28:44 -0700763 return ktime_get_ns();
Eric Dumazet9a568de2017-05-16 14:00:14 -0700764}
765
766static inline u64 tcp_clock_us(void)
767{
768 return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
769}
770
771/* This should only be used in contexts where tp->tcp_mstamp is up to date */
772static inline u32 tcp_time_stamp(const struct tcp_sock *tp)
773{
774 return div_u64(tp->tcp_mstamp, USEC_PER_SEC / TCP_TS_HZ);
775}
776
Eric Dumazet200ecef2019-11-07 11:51:18 -0800777/* Convert a nsec timestamp into TCP TSval timestamp (ms based currently) */
778static inline u32 tcp_ns_to_ts(u64 ns)
779{
780 return div_u64(ns, NSEC_PER_SEC / TCP_TS_HZ);
781}
782
Eric Dumazet9a568de2017-05-16 14:00:14 -0700783/* Could use tcp_clock_us() / 1000, but this version uses a single divide */
784static inline u32 tcp_time_stamp_raw(void)
785{
Eric Dumazet200ecef2019-11-07 11:51:18 -0800786 return tcp_ns_to_ts(tcp_clock_ns());
Eric Dumazet9a568de2017-05-16 14:00:14 -0700787}
788
Eric Dumazet9799ccb2018-09-21 08:51:49 -0700789void tcp_mstamp_refresh(struct tcp_sock *tp);
Eric Dumazet9a568de2017-05-16 14:00:14 -0700790
791static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
792{
793 return max_t(s64, t1 - t0, 0);
794}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Eric Dumazet7faee5c2014-09-05 15:33:33 -0700796static inline u32 tcp_skb_timestamp(const struct sk_buff *skb)
797{
Eric Dumazet200ecef2019-11-07 11:51:18 -0800798 return tcp_ns_to_ts(skb->skb_mstamp_ns);
Eric Dumazet7faee5c2014-09-05 15:33:33 -0700799}
800
Eric Dumazet2fd66ff2018-09-21 08:51:47 -0700801/* provide the departure time in us unit */
802static inline u64 tcp_skb_timestamp_us(const struct sk_buff *skb)
803{
Eric Dumazetd3edd062018-09-21 08:51:50 -0700804 return div_u64(skb->skb_mstamp_ns, NSEC_PER_USEC);
Eric Dumazet2fd66ff2018-09-21 08:51:47 -0700805}
806
Eric Dumazet7faee5c2014-09-05 15:33:33 -0700807
Changli Gaoa3433f32010-06-12 14:01:43 +0000808#define tcp_flag_byte(th) (((u_int8_t *)th)[13])
809
810#define TCPHDR_FIN 0x01
811#define TCPHDR_SYN 0x02
812#define TCPHDR_RST 0x04
813#define TCPHDR_PSH 0x08
814#define TCPHDR_ACK 0x10
815#define TCPHDR_URG 0x20
816#define TCPHDR_ECE 0x40
817#define TCPHDR_CWR 0x80
818
Daniel Borkmann49213552015-05-19 21:04:22 +0200819#define TCPHDR_SYN_ECN (TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)
820
Stephen Hemmingercaa20d9a2005-11-10 17:13:47 -0800821/* This is what the send packet queuing engine uses to pass
Eric Dumazetf86586f2010-07-15 21:41:00 -0700822 * TCP per-packet control information to the transmission code.
823 * We also store the host-order sequence numbers in here too.
824 * This is 44 bytes if IPV6 is enabled.
825 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
827struct tcp_skb_cb {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 __u32 seq; /* Starting sequence number */
829 __u32 end_seq; /* SEQ + FIN + SYN + datalen */
Eric Dumazetcd7d8492014-09-24 04:11:22 -0700830 union {
831 /* Note : tcp_tw_isn is used in input path only
832 * (isn chosen by tcp_timewait_state_process())
833 *
Eric Dumazetf69ad292015-06-11 09:15:18 -0700834 * tcp_gso_segs/size are used in write queue only,
835 * cf tcp_skb_pcount()/tcp_skb_mss()
Eric Dumazetcd7d8492014-09-24 04:11:22 -0700836 */
837 __u32 tcp_tw_isn;
Eric Dumazetf69ad292015-06-11 09:15:18 -0700838 struct {
839 u16 tcp_gso_segs;
840 u16 tcp_gso_size;
841 };
Eric Dumazetcd7d8492014-09-24 04:11:22 -0700842 };
Eric Dumazet4de075e2011-09-27 13:25:05 -0400843 __u8 tcp_flags; /* TCP header flags. (tcp[13]) */
Neal Cardwellf4f9f6e2012-04-16 07:08:06 +0000844
Yuchung Cheng713bafe2017-11-08 13:01:26 -0800845 __u8 sacked; /* State flags for SACK. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846#define TCPCB_SACKED_ACKED 0x01 /* SKB ACK'd by a SACK block */
847#define TCPCB_SACKED_RETRANS 0x02 /* SKB retransmitted */
848#define TCPCB_LOST 0x04 /* SKB is lost */
849#define TCPCB_TAGBITS 0x07 /* All tag bits */
Eric Dumazetd3edd062018-09-21 08:51:50 -0700850#define TCPCB_REPAIRED 0x10 /* SKB repaired (no skb_mstamp_ns) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851#define TCPCB_EVER_RETRANS 0x80 /* Ever retransmitted frame */
Andrey Vagin9d186ca2014-08-13 16:03:10 +0400852#define TCPCB_RETRANS (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
853 TCPCB_REPAIRED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Neal Cardwellf4f9f6e2012-04-16 07:08:06 +0000855 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */
Soheil Hassas Yeganeh6b084922016-04-02 23:08:08 -0400856 __u8 txstamp_ack:1, /* Record TX timestamp for ack? */
Martin KaFai Lauc134ecb2016-04-25 14:44:48 -0700857 eor:1, /* Is skb MSG_EOR marked? */
Mike Maloney98aaa912017-08-22 17:08:48 -0400858 has_rxtstamp:1, /* SKB has a RX timestamp */
859 unused:5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 __u32 ack_seq; /* Sequence number ACK'd */
Eric Dumazet971f10e2014-09-27 09:50:57 -0700861 union {
Lawrence Brakmob75803d2016-05-06 20:35:35 -0700862 struct {
Yuchung Chengb9f64822016-09-19 23:39:14 -0400863 /* There is space for up to 24 bytes */
Soheil Hassas Yeganehd7722e82016-09-19 23:39:15 -0400864 __u32 in_flight:30,/* Bytes in flight at transmit */
865 is_app_limited:1, /* cwnd not fully used? */
866 unused:1;
Yuchung Chengb9f64822016-09-19 23:39:14 -0400867 /* pkts S/ACKed so far upon tx of skb, incl retrans: */
868 __u32 delivered;
869 /* start of send pipeline phase */
Eric Dumazet9a568de2017-05-16 14:00:14 -0700870 u64 first_tx_mstamp;
Yuchung Chengb9f64822016-09-19 23:39:14 -0400871 /* when we reached the "delivered" count */
Eric Dumazet9a568de2017-05-16 14:00:14 -0700872 u64 delivered_mstamp;
Lawrence Brakmob75803d2016-05-06 20:35:35 -0700873 } tx; /* only used for outgoing skbs */
874 union {
875 struct inet_skb_parm h4;
Eric Dumazet971f10e2014-09-27 09:50:57 -0700876#if IS_ENABLED(CONFIG_IPV6)
Lawrence Brakmob75803d2016-05-06 20:35:35 -0700877 struct inet6_skb_parm h6;
Eric Dumazet971f10e2014-09-27 09:50:57 -0700878#endif
Lawrence Brakmob75803d2016-05-06 20:35:35 -0700879 } header; /* For incoming skbs */
John Fastabend34f795022017-10-18 07:10:36 -0700880 struct {
John Fastabend34f795022017-10-18 07:10:36 -0700881 __u32 flags;
John Fastabende5cd3ab2018-05-14 10:00:16 -0700882 struct sock *sk_redir;
John Fastabend8108a772017-10-27 09:45:34 -0700883 void *data_end;
John Fastabend34f795022017-10-18 07:10:36 -0700884 } bpf;
Lawrence Brakmob75803d2016-05-06 20:35:35 -0700885 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886};
887
888#define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0]))
889
John Fastabend0ea488f2018-07-05 08:50:15 -0700890static inline void bpf_compute_data_end_sk_skb(struct sk_buff *skb)
891{
892 TCP_SKB_CB(skb)->bpf.data_end = skb->data + skb_headlen(skb);
893}
Eric Dumazet870c3152014-10-17 09:17:20 -0700894
Daniel Borkmann604326b2018-10-13 02:45:58 +0200895static inline bool tcp_skb_bpf_ingress(const struct sk_buff *skb)
896{
897 return TCP_SKB_CB(skb)->bpf.flags & BPF_F_INGRESS;
898}
899
900static inline struct sock *tcp_skb_bpf_redirect_fetch(struct sk_buff *skb)
901{
902 return TCP_SKB_CB(skb)->bpf.sk_redir;
903}
904
905static inline void tcp_skb_bpf_redirect_clear(struct sk_buff *skb)
906{
907 TCP_SKB_CB(skb)->bpf.sk_redir = NULL;
908}
909
Eric Dumazet815afe12014-10-18 08:34:37 -0700910#if IS_ENABLED(CONFIG_IPV6)
Eric Dumazet870c3152014-10-17 09:17:20 -0700911/* This is the variant of inet6_iif() that must be used by TCP,
912 * as TCP moves IP6CB into a different location in skb->cb[]
913 */
914static inline int tcp_v6_iif(const struct sk_buff *skb)
915{
David Ahern24b711e2018-07-19 12:41:18 -0700916 return TCP_SKB_CB(skb)->header.h6.iif;
917}
918
919static inline int tcp_v6_iif_l3_slave(const struct sk_buff *skb)
920{
David Aherna04a4802016-10-16 20:02:52 -0700921 bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
David Ahern74b20582016-05-10 11:19:50 -0700922
923 return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
Eric Dumazet870c3152014-10-17 09:17:20 -0700924}
David Ahern4297a0e2017-08-07 08:44:21 -0700925
926/* TCP_SKB_CB reference means this can not be used from early demux */
927static inline int tcp_v6_sdif(const struct sk_buff *skb)
928{
929#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
930 if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags))
931 return TCP_SKB_CB(skb)->header.h6.iif;
932#endif
933 return 0;
934}
Eric Dumazetdd2e0b82020-06-19 12:12:35 -0700935
Eric Dumazetb03d2142020-06-23 15:31:12 -0700936extern const struct inet_connection_sock_af_ops ipv6_specific;
937
Eric Dumazetdd2e0b82020-06-19 12:12:35 -0700938INDIRECT_CALLABLE_DECLARE(void tcp_v6_send_check(struct sock *sk, struct sk_buff *skb));
Eric Dumazet243600e2020-06-23 15:31:11 -0700939INDIRECT_CALLABLE_DECLARE(int tcp_v6_rcv(struct sk_buff *skb));
940INDIRECT_CALLABLE_DECLARE(void tcp_v6_early_demux(struct sk_buff *skb));
Eric Dumazetdd2e0b82020-06-19 12:12:35 -0700941
Eric Dumazet815afe12014-10-18 08:34:37 -0700942#endif
Eric Dumazet870c3152014-10-17 09:17:20 -0700943
David Aherna04a4802016-10-16 20:02:52 -0700944static inline bool inet_exact_dif_match(struct net *net, struct sk_buff *skb)
945{
946#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
947 if (!net->ipv4.sysctl_tcp_l3mdev_accept &&
David Ahernb4d16052017-12-03 09:33:00 -0800948 skb && ipv4_l3mdev_skb(IPCB(skb)->flags))
David Aherna04a4802016-10-16 20:02:52 -0700949 return true;
950#endif
951 return false;
952}
953
David Ahern3fa6f612017-08-07 08:44:17 -0700954/* TCP_SKB_CB reference means this can not be used from early demux */
955static inline int tcp_v4_sdif(struct sk_buff *skb)
956{
957#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
958 if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
959 return TCP_SKB_CB(skb)->header.h4.iif;
960#endif
961 return 0;
962}
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/* Due to TSO, an SKB can be composed of multiple actual
965 * packets. To keep these tracked properly, we use this.
966 */
967static inline int tcp_skb_pcount(const struct sk_buff *skb)
968{
Eric Dumazetcd7d8492014-09-24 04:11:22 -0700969 return TCP_SKB_CB(skb)->tcp_gso_segs;
970}
971
972static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
973{
974 TCP_SKB_CB(skb)->tcp_gso_segs = segs;
975}
976
977static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
978{
979 TCP_SKB_CB(skb)->tcp_gso_segs += segs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980}
981
Eric Dumazetf69ad292015-06-11 09:15:18 -0700982/* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983static inline int tcp_skb_mss(const struct sk_buff *skb)
984{
Eric Dumazetf69ad292015-06-11 09:15:18 -0700985 return TCP_SKB_CB(skb)->tcp_gso_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986}
987
Martin KaFai Lauc134ecb2016-04-25 14:44:48 -0700988static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
989{
990 return likely(!TCP_SKB_CB(skb)->eor);
991}
992
Mat Martineau85712482020-01-09 07:59:20 -0800993static inline bool tcp_skb_can_collapse(const struct sk_buff *to,
994 const struct sk_buff *from)
995{
996 return likely(tcp_skb_can_collapse_to(to) &&
997 mptcp_skb_can_collapse(to, from));
998}
999
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001000/* Events passed to congestion control interface */
1001enum tcp_ca_event {
1002 CA_EVENT_TX_START, /* first transmit when no packets in flight */
1003 CA_EVENT_CWND_RESTART, /* congestion window restart */
1004 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001005 CA_EVENT_LOSS, /* loss timeout */
Florian Westphal98900922014-09-26 22:37:35 +02001006 CA_EVENT_ECN_NO_CE, /* ECT set, but not CE marked */
1007 CA_EVENT_ECN_IS_CE, /* received CE marked IP packet */
Florian Westphal7354c8c2014-09-26 22:37:34 +02001008};
1009
Florian Westphal98900922014-09-26 22:37:35 +02001010/* Information about inbound ACK, passed to cong_ops->in_ack_event() */
Florian Westphal7354c8c2014-09-26 22:37:34 +02001011enum tcp_ca_ack_event_flags {
Florian Westphalc1d2b4c2017-08-30 19:24:57 +02001012 CA_ACK_SLOWPATH = (1 << 0), /* In slow path processing */
1013 CA_ACK_WIN_UPDATE = (1 << 1), /* ACK updated window */
1014 CA_ACK_ECE = (1 << 2), /* ECE bit is set on ack */
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001015};
1016
1017/*
1018 * Interface for adding new TCP congestion control handlers
1019 */
1020#define TCP_CA_NAME_MAX 16
Stephen Hemminger3ff825b2006-11-09 16:32:06 -08001021#define TCP_CA_MAX 128
1022#define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX)
1023
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +01001024#define TCP_CA_UNSPEC 0
1025
Daniel Borkmann30e502a2014-09-26 22:37:33 +02001026/* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
Stephen Hemminger164891a2007-04-23 22:26:16 -07001027#define TCP_CONG_NON_RESTRICTED 0x1
Daniel Borkmann30e502a2014-09-26 22:37:33 +02001028/* Requires ECN/ECT set on all packets */
1029#define TCP_CONG_NEEDS_ECN 0x2
Martin KaFai Lau0baf26b2020-01-08 16:35:08 -08001030#define TCP_CONG_MASK (TCP_CONG_NON_RESTRICTED | TCP_CONG_NEEDS_ECN)
Stephen Hemminger164891a2007-04-23 22:26:16 -07001031
Eric Dumazet64f40ff2015-04-28 16:23:48 -07001032union tcp_cc_info;
1033
Lawrence Brakmo756ee172016-05-11 10:02:13 -07001034struct ack_sample {
1035 u32 pkts_acked;
1036 s32 rtt_us;
Lawrence Brakmo6f094b92016-06-08 21:16:44 -07001037 u32 in_flight;
Lawrence Brakmo756ee172016-05-11 10:02:13 -07001038};
1039
Yuchung Chengb9f64822016-09-19 23:39:14 -04001040/* A rate sample measures the number of (original/retransmitted) data
1041 * packets delivered "delivered" over an interval of time "interval_us".
1042 * The tcp_rate.c code fills in the rate sample, and congestion
1043 * control modules that define a cong_control function to run at the end
1044 * of ACK processing can optionally chose to consult this sample when
1045 * setting cwnd and pacing rate.
1046 * A sample is invalid if "delivered" or "interval_us" is negative.
1047 */
1048struct rate_sample {
Eric Dumazet9a568de2017-05-16 14:00:14 -07001049 u64 prior_mstamp; /* starting timestamp for interval */
Yuchung Chengb9f64822016-09-19 23:39:14 -04001050 u32 prior_delivered; /* tp->delivered at "prior_mstamp" */
1051 s32 delivered; /* number of packets delivered over interval */
1052 long interval_us; /* time for tp->delivered to incr "delivered" */
Deepti Raghavan4929c942018-07-09 17:53:39 +00001053 u32 snd_interval_us; /* snd interval for delivered packets */
1054 u32 rcv_interval_us; /* rcv interval for delivered packets */
Yuchung Chengb9f64822016-09-19 23:39:14 -04001055 long rtt_us; /* RTT of last (S)ACKed packet (or -1) */
1056 int losses; /* number of packets marked lost upon ACK */
1057 u32 acked_sacked; /* number of packets newly (S)ACKed upon ACK */
1058 u32 prior_in_flight; /* in flight before this ACK */
Soheil Hassas Yeganehd7722e82016-09-19 23:39:15 -04001059 bool is_app_limited; /* is sample from packet with bubble in pipe? */
Yuchung Chengb9f64822016-09-19 23:39:14 -04001060 bool is_retrans; /* is sample from retransmission? */
Yuchung Chenge4286602018-01-17 12:11:01 -08001061 bool is_ack_delayed; /* is this (likely) a delayed ACK? */
Yuchung Chengb9f64822016-09-19 23:39:14 -04001062};
1063
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001064struct tcp_congestion_ops {
1065 struct list_head list;
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +01001066 u32 key;
1067 u32 flags;
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001068
1069 /* initialize private data (optional) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001070 void (*init)(struct sock *sk);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001071 /* cleanup private data (optional) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001072 void (*release)(struct sock *sk);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001073
1074 /* return slow start threshold (required) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001075 u32 (*ssthresh)(struct sock *sk);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001076 /* do new cwnd calculation (required) */
Eric Dumazet24901552014-05-02 21:18:05 -07001077 void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001078 /* call before changing ca_state (optional) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001079 void (*set_state)(struct sock *sk, u8 new_state);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001080 /* call when cwnd event occurs (optional) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001081 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
Florian Westphal7354c8c2014-09-26 22:37:34 +02001082 /* call when ack arrives (optional) */
1083 void (*in_ack_event)(struct sock *sk, u32 flags);
Anmol Sarma1e0ce2a2017-06-03 17:40:54 +05301084 /* new value of cwnd after loss (required) */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001085 u32 (*undo_cwnd)(struct sock *sk);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001086 /* hook for packet ack accounting (optional) */
Lawrence Brakmo756ee172016-05-11 10:02:13 -07001087 void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
Eric Dumazetdcb8c9b2018-02-28 14:40:46 -08001088 /* override sysctl_tcp_min_tso_segs */
1089 u32 (*min_tso_segs)(struct sock *sk);
Yuchung Cheng77bfc172016-09-19 23:39:20 -04001090 /* returns the multiplier used in tcp_sndbuf_expand (optional) */
1091 u32 (*sndbuf_expand)(struct sock *sk);
Yuchung Chengc0402762016-09-19 23:39:21 -04001092 /* call when packets are delivered to update cwnd and pacing rate,
1093 * after all the ca_state processing. (optional)
1094 */
1095 void (*cong_control)(struct sock *sk, const struct rate_sample *rs);
Arnaldo Carvalho de Melo73c1f4a2005-08-12 12:51:49 -03001096 /* get info for inet_diag (optional) */
Eric Dumazet64f40ff2015-04-28 16:23:48 -07001097 size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
1098 union tcp_cc_info *info);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001099
1100 char name[TCP_CA_NAME_MAX];
1101 struct module *owner;
1102};
1103
Joe Perches5c9f3022013-09-23 11:33:32 -07001104int tcp_register_congestion_control(struct tcp_congestion_ops *type);
1105void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001106
Florian Westphal55d86942014-09-26 22:37:32 +02001107void tcp_assign_congestion_control(struct sock *sk);
Joe Perches5c9f3022013-09-23 11:33:32 -07001108void tcp_init_congestion_control(struct sock *sk);
1109void tcp_cleanup_congestion_control(struct sock *sk);
Stephen Hemminger6670e152017-11-14 08:25:49 -08001110int tcp_set_default_congestion_control(struct net *net, const char *name);
1111void tcp_get_default_congestion_control(struct net *net, char *name);
Joe Perches5c9f3022013-09-23 11:33:32 -07001112void tcp_get_available_congestion_control(char *buf, size_t len);
1113void tcp_get_allowed_congestion_control(char *buf, size_t len);
1114int tcp_set_allowed_congestion_control(char *allowed);
Eric Dumazet8d650cd2019-07-18 19:28:14 -07001115int tcp_set_congestion_control(struct sock *sk, const char *name, bool load,
1116 bool reinit, bool cap_net_admin);
Neal Cardwelle73ebb02015-01-28 20:01:35 -05001117u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
1118void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001119
Joe Perches5c9f3022013-09-23 11:33:32 -07001120u32 tcp_reno_ssthresh(struct sock *sk);
Florian Westphale9799182016-11-21 14:18:38 +01001121u32 tcp_reno_undo_cwnd(struct sock *sk);
Eric Dumazet24901552014-05-02 21:18:05 -07001122void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
David S. Millera8acfba2005-06-23 23:45:02 -07001123extern struct tcp_congestion_ops tcp_reno;
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001124
Martin KaFai Lau0baf26b2020-01-08 16:35:08 -08001125struct tcp_congestion_ops *tcp_ca_find(const char *name);
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +01001126struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
Stephen Hemminger6670e152017-11-14 08:25:49 -08001127u32 tcp_ca_get_key_by_name(struct net *net, const char *name, bool *ecn_ca);
Daniel Borkmannea697632015-01-05 23:57:47 +01001128#ifdef CONFIG_INET
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +01001129char *tcp_ca_get_name_by_key(u32 key, char *buffer);
Daniel Borkmannea697632015-01-05 23:57:47 +01001130#else
1131static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
1132{
1133 return NULL;
1134}
1135#endif
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +01001136
Daniel Borkmann30e502a2014-09-26 22:37:33 +02001137static inline bool tcp_ca_needs_ecn(const struct sock *sk)
1138{
1139 const struct inet_connection_sock *icsk = inet_csk(sk);
1140
1141 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
1142}
1143
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001144static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001145{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001146 struct inet_connection_sock *icsk = inet_csk(sk);
1147
1148 if (icsk->icsk_ca_ops->set_state)
1149 icsk->icsk_ca_ops->set_state(sk, ca_state);
1150 icsk->icsk_ca_state = ca_state;
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001151}
1152
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001153static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001154{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001155 const struct inet_connection_sock *icsk = inet_csk(sk);
1156
1157 if (icsk->icsk_ca_ops->cwnd_event)
1158 icsk->icsk_ca_ops->cwnd_event(sk, event);
Stephen Hemminger317a76f2005-06-23 12:19:55 -07001159}
1160
Yuchung Chengb9f64822016-09-19 23:39:14 -04001161/* From tcp_rate.c */
1162void tcp_rate_skb_sent(struct sock *sk, struct sk_buff *skb);
1163void tcp_rate_skb_delivered(struct sock *sk, struct sk_buff *skb,
1164 struct rate_sample *rs);
1165void tcp_rate_gen(struct sock *sk, u32 delivered, u32 lost,
Yousuk Seungd4761752017-12-07 13:41:34 -08001166 bool is_sack_reneg, struct rate_sample *rs);
Soheil Hassas Yeganehd7722e82016-09-19 23:39:15 -04001167void tcp_rate_check_app_limited(struct sock *sk);
Yuchung Chengb9f64822016-09-19 23:39:14 -04001168
Ilpo Järvinene60402d2007-08-09 15:14:46 +03001169/* These functions determine how the current flow behaves in respect of SACK
1170 * handling. SACK is negotiated with the peer, and therefore it can vary
1171 * between different flows.
1172 *
1173 * tcp_is_sack - SACK enabled
1174 * tcp_is_reno - No SACK
Ilpo Järvinene60402d2007-08-09 15:14:46 +03001175 */
1176static inline int tcp_is_sack(const struct tcp_sock *tp)
1177{
Eric Dumazetebeef4b2018-11-27 14:42:00 -08001178 return likely(tp->rx_opt.sack_ok);
Ilpo Järvinene60402d2007-08-09 15:14:46 +03001179}
1180
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001181static inline bool tcp_is_reno(const struct tcp_sock *tp)
Ilpo Järvinene60402d2007-08-09 15:14:46 +03001182{
1183 return !tcp_is_sack(tp);
1184}
1185
Ilpo Järvinen83ae4082007-08-09 14:37:30 +03001186static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
1187{
1188 return tp->sacked_out + tp->lost_out;
1189}
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191/* This determines how many packets are "in the network" to the best
1192 * of our knowledge. In many cases it is conservative, but where
1193 * detailed information is available from the receiver (via SACK
1194 * blocks etc.) we can make more aggressive calculations.
1195 *
1196 * Use this for decisions involving congestion control, use just
1197 * tp->packets_out to determine if the send queue is empty or not.
1198 *
1199 * Read this equation as:
1200 *
1201 * "Packets sent once on transmission queue" MINUS
1202 * "Packets left network, but not honestly ACKed yet" PLUS
1203 * "Packets fast retransmitted"
1204 */
Stephen Hemminger40efc6f2006-01-03 16:03:49 -08001205static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206{
Ilpo Järvinen83ae4082007-08-09 14:37:30 +03001207 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208}
1209
Ilpo Järvinen0b6a05c2009-09-15 01:30:10 -07001210#define TCP_INFINITE_SSTHRESH 0x7fffffff
1211
Yuchung Cheng071d5082015-07-09 13:16:29 -07001212static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
1213{
Yuchung Cheng76174002015-07-09 13:16:30 -07001214 return tp->snd_cwnd < tp->snd_ssthresh;
Yuchung Cheng071d5082015-07-09 13:16:29 -07001215}
1216
Ilpo Järvinen0b6a05c2009-09-15 01:30:10 -07001217static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
1218{
1219 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
1220}
1221
Yuchung Cheng684bad12012-09-02 17:38:04 +00001222static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
1223{
1224 return (TCPF_CA_CWR | TCPF_CA_Recovery) &
1225 (1 << inet_csk(sk)->icsk_ca_state);
1226}
1227
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228/* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
Yuchung Cheng684bad12012-09-02 17:38:04 +00001229 * The exception is cwnd reduction phase, when cwnd is decreasing towards
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 * ssthresh.
1231 */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001232static inline __u32 tcp_current_ssthresh(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -03001234 const struct tcp_sock *tp = tcp_sk(sk);
Eric Dumazetcf533ea2011-10-21 05:22:42 -04001235
Yuchung Cheng684bad12012-09-02 17:38:04 +00001236 if (tcp_in_cwnd_reduction(sk))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 return tp->snd_ssthresh;
1238 else
1239 return max(tp->snd_ssthresh,
1240 ((tp->snd_cwnd >> 1) +
1241 (tp->snd_cwnd >> 2)));
1242}
1243
Ilpo Järvinenb9c45952007-07-27 16:36:17 +03001244/* Use define here intentionally to get WARN_ON location shown at the caller */
1245#define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246
Christoph Paasch5ee2c942014-07-14 16:58:32 +02001247void tcp_enter_cwr(struct sock *sk);
Joe Perches5c9f3022013-09-23 11:33:32 -07001248__u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Neal Cardwell6b5a5c02011-11-21 17:15:14 +00001250/* The maximum number of MSS of available cwnd for which TSO defers
1251 * sending if not using sysctl_tcp_tso_win_divisor.
1252 */
1253static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1254{
1255 return 3;
1256}
1257
Ilpo Järvinen90840defa2007-12-31 04:48:41 -08001258/* Returns end sequence number of the receiver's advertised window */
1259static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1260{
1261 return tp->snd_una + tp->snd_wnd;
1262}
Eric Dumazete114a712014-04-30 11:58:13 -07001263
1264/* We follow the spirit of RFC2861 to validate cwnd but implement a more
1265 * flexible approach. The RFC suggests cwnd should not be raised unless
Neal Cardwellca8a2262014-05-22 10:41:08 -04001266 * it was fully used previously. And that's exactly what we do in
1267 * congestion avoidance mode. But in slow start we allow cwnd to grow
1268 * as long as the application has used half the cwnd.
Eric Dumazete114a712014-04-30 11:58:13 -07001269 * Example :
1270 * cwnd is 10 (IW10), but application sends 9 frames.
1271 * We allow cwnd to reach 18 when all frames are ACKed.
1272 * This check is safe because it's as aggressive as slow start which already
1273 * risks 100% overshoot. The advantage is that we discourage application to
1274 * either send more filler packets or data to artificially blow up the cwnd
1275 * usage, and allow application-limited process to probe bw more aggressively.
Eric Dumazete114a712014-04-30 11:58:13 -07001276 */
Eric Dumazet24901552014-05-02 21:18:05 -07001277static inline bool tcp_is_cwnd_limited(const struct sock *sk)
Eric Dumazete114a712014-04-30 11:58:13 -07001278{
1279 const struct tcp_sock *tp = tcp_sk(sk);
1280
Neal Cardwellca8a2262014-05-22 10:41:08 -04001281 /* If in slow start, ensure cwnd grows to twice what was ACKed. */
Yuchung Cheng071d5082015-07-09 13:16:29 -07001282 if (tcp_in_slow_start(tp))
Neal Cardwellca8a2262014-05-22 10:41:08 -04001283 return tp->snd_cwnd < 2 * tp->max_packets_out;
1284
1285 return tp->is_cwnd_limited;
Eric Dumazete114a712014-04-30 11:58:13 -07001286}
Stephen Hemmingerf4805ed2005-11-10 16:53:30 -08001287
Eric Dumazetcadefe52018-06-20 16:07:35 -04001288/* BBR congestion control needs pacing.
1289 * Same remark for SO_MAX_PACING_RATE.
1290 * sch_fq packet scheduler is efficiently handling pacing,
1291 * but is not always installed/used.
1292 * Return true if TCP stack should pace packets itself.
1293 */
1294static inline bool tcp_needs_internal_pacing(const struct sock *sk)
1295{
1296 return smp_load_acquire(&sk->sk_pacing_status) == SK_PACING_NEEDED;
1297}
1298
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001299/* Estimates in how many jiffies next packet for this flow can be sent.
1300 * Scheduling a retransmit timer too early would be silly.
Eric Dumazet3f80e082018-10-23 11:54:16 -07001301 */
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001302static inline unsigned long tcp_pacing_delay(const struct sock *sk)
Eric Dumazet3f80e082018-10-23 11:54:16 -07001303{
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001304 s64 delay = tcp_sk(sk)->tcp_wstamp_ns - tcp_sk(sk)->tcp_clock_cache;
Eric Dumazet3f80e082018-10-23 11:54:16 -07001305
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001306 return delay > 0 ? nsecs_to_jiffies(delay) : 0;
Eric Dumazet3f80e082018-10-23 11:54:16 -07001307}
1308
1309static inline void tcp_reset_xmit_timer(struct sock *sk,
1310 const int what,
1311 unsigned long when,
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001312 const unsigned long max_when)
Eric Dumazet3f80e082018-10-23 11:54:16 -07001313{
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001314 inet_csk_reset_xmit_timer(sk, what, when + tcp_pacing_delay(sk),
Eric Dumazet3f80e082018-10-23 11:54:16 -07001315 max_when);
1316}
1317
Eric Dumazet21c8fe92015-05-06 14:26:24 -07001318/* Something is really bad, we could not queue an additional packet,
Eric Dumazet3f80e082018-10-23 11:54:16 -07001319 * because qdisc is full or receiver sent a 0 window, or we are paced.
Eric Dumazet21c8fe92015-05-06 14:26:24 -07001320 * We do not want to add fuel to the fire, or abort too early,
1321 * so make sure the timer we arm now is at least 200ms in the future,
1322 * regardless of current icsk_rto value (as it could be ~2ms)
1323 */
1324static inline unsigned long tcp_probe0_base(const struct sock *sk)
1325{
1326 return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1327}
1328
1329/* Variant of inet_csk_rto_backoff() used for zero window probes */
1330static inline unsigned long tcp_probe0_when(const struct sock *sk,
1331 unsigned long max_when)
1332{
1333 u64 when = (u64)tcp_probe0_base(sk) << inet_csk(sk)->icsk_backoff;
1334
1335 return (unsigned long)min_t(u64, when, max_when);
1336}
1337
Ilpo Järvinen9e412ba2007-04-20 22:18:02 -07001338static inline void tcp_check_probe_timer(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
Eric Dumazet21c8fe92015-05-06 14:26:24 -07001340 if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
Eric Dumazet3f80e082018-10-23 11:54:16 -07001341 tcp_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
Eric Dumazet8dc242a2020-05-04 11:27:49 -07001342 tcp_probe0_base(sk), TCP_RTO_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343}
1344
Hantzis Fotisee7537b2009-03-02 22:42:02 -08001345static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346{
1347 tp->snd_wl1 = seq;
1348}
1349
Hantzis Fotisee7537b2009-03-02 22:42:02 -08001350static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351{
1352 tp->snd_wl1 = seq;
1353}
1354
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355/*
1356 * Calculate(/check) TCP checksum
1357 */
Frederik Deweerdtba7808e2007-02-04 20:15:27 -08001358static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1359 __be32 daddr, __wsum base)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
Daniel T. Lee0b13c9b2019-04-21 00:50:42 +09001361 return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_TCP, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001364static inline bool tcp_checksum_complete(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365{
Herbert Xu60476372007-04-09 11:59:39 -07001366 return !skb_csum_unnecessary(skb) &&
Cong Wang6ab6dfa2018-11-12 16:17:00 -08001367 __skb_checksum_complete(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368}
1369
Eric Dumazetc9c33212016-08-27 07:37:54 -07001370bool tcp_add_backlog(struct sock *sk, struct sk_buff *skb);
Eric Dumazetac6e7802016-11-10 13:12:35 -08001371int tcp_filter(struct sock *sk, struct sk_buff *skb);
Joe Perches5c9f3022013-09-23 11:33:32 -07001372void tcp_set_state(struct sock *sk, int state);
Joe Perches5c9f3022013-09-23 11:33:32 -07001373void tcp_done(struct sock *sk);
Lorenzo Colittic1e64e22015-12-16 12:30:05 +09001374int tcp_abort(struct sock *sk, int err);
1375
Stephen Hemminger40efc6f2006-01-03 16:03:49 -08001376static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377{
1378 rx_opt->dsack = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 rx_opt->num_sacks = 0;
1380}
1381
Eric Dumazet6f021c62015-08-21 12:30:00 -07001382void tcp_cwnd_restart(struct sock *sk, s32 delta);
1383
1384static inline void tcp_slow_start_after_idle_check(struct sock *sk)
1385{
Wei Wang1b1fc3f2017-05-05 12:53:23 -07001386 const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
Eric Dumazet6f021c62015-08-21 12:30:00 -07001387 struct tcp_sock *tp = tcp_sk(sk);
1388 s32 delta;
1389
Eric Dumazetb510f0d2017-10-26 21:54:59 -07001390 if (!sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle || tp->packets_out ||
Wei Wang1b1fc3f2017-05-05 12:53:23 -07001391 ca_ops->cong_control)
Eric Dumazet6f021c62015-08-21 12:30:00 -07001392 return;
Eric Dumazetd635fbe2017-05-16 14:00:03 -07001393 delta = tcp_jiffies32 - tp->lsndtime;
Eric Dumazet6f021c62015-08-21 12:30:00 -07001394 if (delta > inet_csk(sk)->icsk_rto)
1395 tcp_cwnd_restart(sk, delta);
1396}
Yuchung Cheng85f16522013-06-11 15:35:32 -07001397
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398/* Determine a window scaling and initial window to offer. */
Eric Dumazetceef9ab2017-10-27 07:47:24 -07001399void tcp_select_initial_window(const struct sock *sk, int __space,
1400 __u32 mss, __u32 *rcv_wnd,
Joe Perches5c9f3022013-09-23 11:33:32 -07001401 __u32 *window_clamp, int wscale_ok,
1402 __u8 *rcv_wscale, __u32 init_rcv_wnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Eric Dumazet94f08932017-10-26 21:55:09 -07001404static inline int tcp_win_from_space(const struct sock *sk, int space)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405{
Eric Dumazet94f08932017-10-26 21:55:09 -07001406 int tcp_adv_win_scale = sock_net(sk)->ipv4.sysctl_tcp_adv_win_scale;
Gao Fengc4836742017-03-24 07:05:12 +08001407
1408 return tcp_adv_win_scale <= 0 ?
1409 (space>>(-tcp_adv_win_scale)) :
1410 space - (space>>tcp_adv_win_scale);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
1412
Kenjiro Nakayama105970f2014-10-20 18:15:50 +09001413/* Note: caller must be prepared to deal with negative returns */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414static inline int tcp_space(const struct sock *sk)
1415{
Eric Dumazetebb3b782019-10-10 20:17:44 -07001416 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) -
Eric Dumazet70c26552019-10-09 15:41:03 -07001417 READ_ONCE(sk->sk_backlog.len) -
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 atomic_read(&sk->sk_rmem_alloc));
Kenjiro Nakayama105970f2014-10-20 18:15:50 +09001419}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
1421static inline int tcp_full_space(const struct sock *sk)
1422{
Eric Dumazetebb3b782019-10-10 20:17:44 -07001423 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424}
1425
Eric Dumazet24adbc12020-05-12 06:54:30 -07001426/* We provision sk_rcvbuf around 200% of sk_rcvlowat.
1427 * If 87.5 % (7/8) of the space has been consumed, we want to override
1428 * SO_RCVLOWAT constraint, since we are receiving skbs with too small
1429 * len/truesize ratio.
1430 */
1431static inline bool tcp_rmem_pressure(const struct sock *sk)
1432{
1433 int rcvbuf = READ_ONCE(sk->sk_rcvbuf);
1434 int threshold = rcvbuf - (rcvbuf >> 3);
1435
1436 return atomic_read(&sk->sk_rmem_alloc) > threshold;
1437}
1438
Yuchung Cheng843f4a52014-05-11 20:22:11 -07001439extern void tcp_openreq_init_rwin(struct request_sock *req,
Eric Dumazetb1964b52015-09-25 07:39:09 -07001440 const struct sock *sk_listener,
1441 const struct dst_entry *dst);
Yuchung Cheng843f4a52014-05-11 20:22:11 -07001442
Joe Perches5c9f3022013-09-23 11:33:32 -07001443void tcp_enter_memory_pressure(struct sock *sk);
Eric Dumazet06044752017-06-07 13:29:12 -07001444void tcp_leave_memory_pressure(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1447{
Nikolay Borisovb840d152016-01-07 16:38:45 +02001448 struct net *net = sock_net((struct sock *)tp);
1449
1450 return tp->keepalive_intvl ? : net->ipv4.sysctl_tcp_keepalive_intvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
1452
1453static inline int keepalive_time_when(const struct tcp_sock *tp)
1454{
Nikolay Borisov13b287e2016-01-07 16:38:43 +02001455 struct net *net = sock_net((struct sock *)tp);
1456
1457 return tp->keepalive_time ? : net->ipv4.sysctl_tcp_keepalive_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458}
1459
Eric Dumazetdf19a622009-08-28 23:48:54 -07001460static inline int keepalive_probes(const struct tcp_sock *tp)
1461{
Nikolay Borisov9bd68612016-01-07 16:38:44 +02001462 struct net *net = sock_net((struct sock *)tp);
1463
1464 return tp->keepalive_probes ? : net->ipv4.sysctl_tcp_keepalive_probes;
Eric Dumazetdf19a622009-08-28 23:48:54 -07001465}
1466
Flavio Leitner6c37e5d2010-04-26 18:33:27 +00001467static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1468{
1469 const struct inet_connection_sock *icsk = &tp->inet_conn;
1470
Eric Dumazet70eabf02017-05-16 14:00:07 -07001471 return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
1472 tcp_jiffies32 - tp->rcv_tstamp);
Flavio Leitner6c37e5d2010-04-26 18:33:27 +00001473}
1474
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -07001475static inline int tcp_fin_time(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476{
Nikolay Borisov1e579ca2016-02-03 09:46:56 +02001477 int fin_timeout = tcp_sk(sk)->linger2 ? : sock_net(sk)->ipv4.sysctl_tcp_fin_timeout;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -07001478 const int rto = inet_csk(sk)->icsk_rto;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -07001480 if (fin_timeout < (rto << 2) - (rto >> 1))
1481 fin_timeout = (rto << 2) - (rto >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
1483 return fin_timeout;
1484}
1485
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001486static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1487 int paws_win)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488{
Ilpo Järvinenc887e6d2009-03-14 14:23:03 +00001489 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001490 return true;
Arnd Bergmanncca9bab2018-07-11 12:16:12 +02001491 if (unlikely(!time_before32(ktime_get_seconds(),
1492 rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS)))
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001493 return true;
Eric Dumazetbc2ce892010-12-16 14:08:34 -08001494 /*
1495 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1496 * then following tcp messages have valid values. Ignore 0 value,
1497 * or else 'negative' tsval might forbid us to accept their packets.
1498 */
1499 if (!rx_opt->ts_recent)
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001500 return true;
1501 return false;
Ilpo Järvinenc887e6d2009-03-14 14:23:03 +00001502}
1503
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001504static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1505 int rst)
Ilpo Järvinenc887e6d2009-03-14 14:23:03 +00001506{
1507 if (tcp_paws_check(rx_opt, 0))
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001508 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
1510 /* RST segments are not recommended to carry timestamp,
1511 and, if they do, it is recommended to ignore PAWS because
1512 "their cleanup function should take precedence over timestamps."
1513 Certainly, it is mistake. It is necessary to understand the reasons
1514 of this constraint to relax it: if peer reboots, clock may go
1515 out-of-sync and half-open connections will not be reset.
1516 Actually, the problem would be not existing if all
1517 the implementations followed draft about maintaining clock
1518 via reboots. Linux-2.2 DOES NOT!
1519
1520 However, we can relax time bounds for RST segments to MSL.
1521 */
Arnd Bergmanncca9bab2018-07-11 12:16:12 +02001522 if (rst && !time_before32(ktime_get_seconds(),
1523 rx_opt->ts_recent_stamp + TCP_PAWS_MSL))
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001524 return false;
1525 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526}
1527
Eric Dumazet7970ddc2015-03-16 21:06:20 -07001528bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
1529 int mib_idx, u32 *last_oow_ack_time);
Neal Cardwell032ee422015-02-06 16:04:38 -05001530
Pavel Emelyanova9c193292008-07-16 20:21:42 -07001531static inline void tcp_mib_init(struct net *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532{
1533 /* See RFC 2012 */
Eric Dumazet6aef70a2016-04-27 16:44:27 -07001534 TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
1535 TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1536 TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1537 TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538}
1539
Ilpo Järvinen5af4ec22007-09-20 11:30:48 -07001540/* from STCP */
Ilpo Järvinenef9da472008-09-20 21:25:15 -07001541static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
David S. Miller0800f172007-09-20 11:40:37 -07001542{
Stephen Hemminger6a438bb2005-11-10 17:14:59 -08001543 tp->lost_skb_hint = NULL;
Ilpo Järvinenef9da472008-09-20 21:25:15 -07001544}
1545
1546static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1547{
1548 tcp_clear_retrans_hints_partial(tp);
Stephen Hemminger6a438bb2005-11-10 17:14:59 -08001549 tp->retransmit_skb_hint = NULL;
Ilpo Järvinenb7689202007-09-20 11:37:19 -07001550}
1551
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001552union tcp_md5_addr {
1553 struct in_addr a4;
1554#if IS_ENABLED(CONFIG_IPV6)
1555 struct in6_addr a6;
1556#endif
1557};
1558
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001559/* - key database */
1560struct tcp_md5sig_key {
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001561 struct hlist_node node;
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001562 u8 keylen;
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001563 u8 family; /* AF_INET or AF_INET6 */
Ivan Delalande67973182017-06-15 18:07:06 -07001564 u8 prefixlen;
David Aherndea53bb2019-12-30 14:14:28 -08001565 union tcp_md5_addr addr;
1566 int l3index; /* set if key added with L3 scope */
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001567 u8 key[TCP_MD5SIG_MAXKEYLEN];
1568 struct rcu_head rcu;
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001569};
1570
1571/* - sock block */
1572struct tcp_md5sig_info {
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001573 struct hlist_head head;
Eric Dumazeta8afca02012-01-31 18:45:40 +00001574 struct rcu_head rcu;
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001575};
1576
1577/* - pseudo header */
1578struct tcp4_pseudohdr {
1579 __be32 saddr;
1580 __be32 daddr;
1581 __u8 pad;
1582 __u8 protocol;
1583 __be16 len;
1584};
1585
1586struct tcp6_pseudohdr {
1587 struct in6_addr saddr;
1588 struct in6_addr daddr;
1589 __be32 len;
1590 __be32 protocol; /* including padding */
1591};
1592
1593union tcp_md5sum_block {
1594 struct tcp4_pseudohdr ip4;
Eric Dumazetdfd56b82011-12-10 09:48:31 +00001595#if IS_ENABLED(CONFIG_IPV6)
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001596 struct tcp6_pseudohdr ip6;
1597#endif
1598};
1599
1600/* - pool: digest algorithm, hash description and scratch buffer */
1601struct tcp_md5sig_pool {
Herbert Xucf80e0e2016-01-24 21:20:23 +08001602 struct ahash_request *md5_req;
Eric Dumazet19689e32016-06-27 18:51:53 +02001603 void *scratch;
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001604};
1605
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001606/* - functions */
Eric Dumazet39f8e582015-03-24 15:58:55 -07001607int tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
1608 const struct sock *sk, const struct sk_buff *skb);
Joe Perches5c9f3022013-09-23 11:33:32 -07001609int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
David Aherndea53bb2019-12-30 14:14:28 -08001610 int family, u8 prefixlen, int l3index,
1611 const u8 *newkey, u8 newkeylen, gfp_t gfp);
Joe Perches5c9f3022013-09-23 11:33:32 -07001612int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
David Aherndea53bb2019-12-30 14:14:28 -08001613 int family, u8 prefixlen, int l3index);
Eric Dumazetb83e3de2015-09-25 07:39:15 -07001614struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
Eric Dumazetfd3a1542015-03-24 15:58:56 -07001615 const struct sock *addr_sk);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001616
YOSHIFUJI Hideaki9501f972008-04-18 12:45:16 +09001617#ifdef CONFIG_TCP_MD5SIG
Eric Dumazet6015c712018-11-27 15:03:21 -08001618#include <linux/jump_label.h>
Eric Dumazet921f9a02019-02-26 09:49:11 -08001619extern struct static_key_false tcp_md5_needed;
David Aherndea53bb2019-12-30 14:14:28 -08001620struct tcp_md5sig_key *__tcp_md5_do_lookup(const struct sock *sk, int l3index,
Eric Dumazet6015c712018-11-27 15:03:21 -08001621 const union tcp_md5_addr *addr,
1622 int family);
1623static inline struct tcp_md5sig_key *
David Aherndea53bb2019-12-30 14:14:28 -08001624tcp_md5_do_lookup(const struct sock *sk, int l3index,
1625 const union tcp_md5_addr *addr, int family)
Eric Dumazet6015c712018-11-27 15:03:21 -08001626{
Eric Dumazet921f9a02019-02-26 09:49:11 -08001627 if (!static_branch_unlikely(&tcp_md5_needed))
Eric Dumazet6015c712018-11-27 15:03:21 -08001628 return NULL;
David Aherndea53bb2019-12-30 14:14:28 -08001629 return __tcp_md5_do_lookup(sk, l3index, addr, family);
Eric Dumazet6015c712018-11-27 15:03:21 -08001630}
1631
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001632#define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_key)
YOSHIFUJI Hideaki9501f972008-04-18 12:45:16 +09001633#else
David Aherndea53bb2019-12-30 14:14:28 -08001634static inline struct tcp_md5sig_key *
1635tcp_md5_do_lookup(const struct sock *sk, int l3index,
1636 const union tcp_md5_addr *addr, int family)
Eric Dumazeta915da9b2012-01-31 05:18:33 +00001637{
1638 return NULL;
1639}
YOSHIFUJI Hideaki9501f972008-04-18 12:45:16 +09001640#define tcp_twsk_md5_key(twsk) NULL
1641#endif
1642
Joe Perches5c9f3022013-09-23 11:33:32 -07001643bool tcp_alloc_md5sig_pool(void);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001644
Joe Perches5c9f3022013-09-23 11:33:32 -07001645struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
Eric Dumazet71cea172013-05-20 06:52:26 +00001646static inline void tcp_put_md5sig_pool(void)
1647{
1648 local_bh_enable();
1649}
Eric Dumazet35790c02010-05-16 00:34:04 -07001650
Joe Perches5c9f3022013-09-23 11:33:32 -07001651int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
1652 unsigned int header_len);
1653int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
1654 const struct tcp_md5sig_key *key);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001655
Jerry Chu10467162012-08-31 12:29:11 +00001656/* From tcp_fastopen.c */
Joe Perches5c9f3022013-09-23 11:33:32 -07001657void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
Yuchung Cheng72685862017-12-12 13:10:40 -08001658 struct tcp_fastopen_cookie *cookie);
Joe Perches5c9f3022013-09-23 11:33:32 -07001659void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
Daniel Lee2646c832015-04-06 14:37:27 -07001660 struct tcp_fastopen_cookie *cookie, bool syn_lost,
1661 u16 try_exp);
Yuchung Cheng783237e2012-07-19 06:43:07 +00001662struct tcp_fastopen_request {
1663 /* Fast Open cookie. Size 0 means a cookie request */
1664 struct tcp_fastopen_cookie cookie;
1665 struct msghdr *data; /* data in MSG_FASTOPEN */
Eric Dumazetf5ddcbb2014-02-20 10:09:18 -08001666 size_t size;
1667 int copied; /* queued in tcp_connect() */
Willem de Bruijnf859a442019-01-25 11:17:23 -05001668 struct ubuf_info *uarg;
Yuchung Cheng783237e2012-07-19 06:43:07 +00001669};
Yuchung Cheng783237e2012-07-19 06:43:07 +00001670void tcp_free_fastopen_req(struct tcp_sock *tp);
Yuchung Cheng1fba70e2017-10-18 11:22:51 -07001671void tcp_fastopen_destroy_cipher(struct sock *sk);
Haishuang Yan43713842017-09-27 11:35:42 +08001672void tcp_fastopen_ctx_destroy(struct net *net);
Yuchung Cheng1fba70e2017-10-18 11:22:51 -07001673int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk,
Ard Biesheuvel438ac882019-06-19 23:46:28 +02001674 void *primary_key, void *backup_key);
Eric Dumazet61d2bca2016-02-01 21:03:07 -08001675void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
Eric Dumazet7c85af82015-09-24 17:16:05 -07001676struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
1677 struct request_sock *req,
Christoph Paasch71c02372017-10-23 13:22:23 -07001678 struct tcp_fastopen_cookie *foc,
1679 const struct dst_entry *dst);
Haishuang Yan43713842017-09-27 11:35:42 +08001680void tcp_fastopen_init_key_once(struct net *net);
Wei Wang065263f2017-01-23 10:59:20 -08001681bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
1682 struct tcp_fastopen_cookie *cookie);
Wei Wang19f6d3f2017-01-23 10:59:22 -08001683bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
Ard Biesheuvel438ac882019-06-19 23:46:28 +02001684#define TCP_FASTOPEN_KEY_LENGTH sizeof(siphash_key_t)
Jason Baron9092a762019-05-29 12:33:57 -04001685#define TCP_FASTOPEN_KEY_MAX 2
1686#define TCP_FASTOPEN_KEY_BUF_LENGTH \
1687 (TCP_FASTOPEN_KEY_LENGTH * TCP_FASTOPEN_KEY_MAX)
Jerry Chu10467162012-08-31 12:29:11 +00001688
1689/* Fastopen key context */
1690struct tcp_fastopen_context {
Ard Biesheuvel438ac882019-06-19 23:46:28 +02001691 siphash_key_t key[TCP_FASTOPEN_KEY_MAX];
Ard Biesheuvelc681eda2019-06-17 10:09:33 +02001692 int num;
1693 struct rcu_head rcu;
Jerry Chu10467162012-08-31 12:29:11 +00001694};
1695
Wei Wangcf1ef3f2017-04-20 14:45:46 -07001696extern unsigned int sysctl_tcp_fastopen_blackhole_timeout;
Wei Wang46c2fa32017-04-20 14:45:47 -07001697void tcp_fastopen_active_disable(struct sock *sk);
Wei Wangcf1ef3f2017-04-20 14:45:46 -07001698bool tcp_fastopen_active_should_disable(struct sock *sk);
1699void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
Yuchung Cheng72685862017-12-12 13:10:40 -08001700void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired);
Wei Wangcf1ef3f2017-04-20 14:45:46 -07001701
Jason Baron9092a762019-05-29 12:33:57 -04001702/* Caller needs to wrap with rcu_read_(un)lock() */
1703static inline
1704struct tcp_fastopen_context *tcp_fastopen_get_ctx(const struct sock *sk)
1705{
1706 struct tcp_fastopen_context *ctx;
1707
1708 ctx = rcu_dereference(inet_csk(sk)->icsk_accept_queue.fastopenq.ctx);
1709 if (!ctx)
1710 ctx = rcu_dereference(sock_net(sk)->ipv4.tcp_fastopen_ctx);
1711 return ctx;
1712}
1713
1714static inline
1715bool tcp_fastopen_cookie_match(const struct tcp_fastopen_cookie *foc,
1716 const struct tcp_fastopen_cookie *orig)
1717{
1718 if (orig->len == TCP_FASTOPEN_COOKIE_SIZE &&
1719 orig->len == foc->len &&
1720 !memcmp(orig->val, foc->val, foc->len))
1721 return true;
1722 return false;
1723}
1724
1725static inline
1726int tcp_fastopen_context_len(const struct tcp_fastopen_context *ctx)
1727{
Ard Biesheuvelc681eda2019-06-17 10:09:33 +02001728 return ctx->num;
Jason Baron9092a762019-05-29 12:33:57 -04001729}
1730
Francis Yan05b055e2016-11-27 23:07:13 -08001731/* Latencies incurred by various limits for a sender. They are
1732 * chronograph-like stats that are mutually exclusive.
1733 */
1734enum tcp_chrono {
1735 TCP_CHRONO_UNSPEC,
1736 TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
1737 TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
1738 TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
1739 __TCP_CHRONO_MAX,
1740};
1741
1742void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type);
1743void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);
1744
Eric Dumazete2080072017-10-04 12:59:58 -07001745/* This helper is needed, because skb->tcp_tsorted_anchor uses
1746 * the same memory storage than skb->destructor/_skb_refdst
1747 */
1748static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb)
1749{
1750 skb->destructor = NULL;
1751 skb->_skb_refdst = 0UL;
1752}
1753
1754#define tcp_skb_tsorted_save(skb) { \
1755 unsigned long _save = skb->_skb_refdst; \
1756 skb->_skb_refdst = 0UL;
1757
1758#define tcp_skb_tsorted_restore(skb) \
1759 skb->_skb_refdst = _save; \
1760}
1761
Eric Dumazetac3f09b2017-10-05 22:21:22 -07001762void tcp_write_queue_purge(struct sock *sk);
David S. Millerfe067e82007-03-07 12:12:44 -08001763
Eric Dumazet75c119a2017-10-05 22:21:27 -07001764static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk)
1765{
1766 return skb_rb_first(&sk->tcp_rtx_queue);
1767}
1768
Eric Dumazetb6171582019-07-19 11:52:33 -07001769static inline struct sk_buff *tcp_rtx_queue_tail(const struct sock *sk)
1770{
1771 return skb_rb_last(&sk->tcp_rtx_queue);
1772}
1773
Eric Dumazetcf533ea2011-10-21 05:22:42 -04001774static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
David S. Millerfe067e82007-03-07 12:12:44 -08001775{
David S. Millercd07a8e2008-09-23 00:50:13 -07001776 return skb_peek(&sk->sk_write_queue);
David S. Millerfe067e82007-03-07 12:12:44 -08001777}
1778
Eric Dumazetcf533ea2011-10-21 05:22:42 -04001779static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
David S. Millerfe067e82007-03-07 12:12:44 -08001780{
David S. Millercd07a8e2008-09-23 00:50:13 -07001781 return skb_peek_tail(&sk->sk_write_queue);
David S. Millerfe067e82007-03-07 12:12:44 -08001782}
1783
Ilpo Järvinen234b6862007-12-02 00:48:02 +02001784#define tcp_for_write_queue_from_safe(skb, tmp, sk) \
David S. Millercd07a8e2008-09-23 00:50:13 -07001785 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
Ilpo Järvinen234b6862007-12-02 00:48:02 +02001786
Eric Dumazetcf533ea2011-10-21 05:22:42 -04001787static inline struct sk_buff *tcp_send_head(const struct sock *sk)
David S. Millerfe067e82007-03-07 12:12:44 -08001788{
Eric Dumazet75c119a2017-10-05 22:21:27 -07001789 return skb_peek(&sk->sk_write_queue);
David S. Millerfe067e82007-03-07 12:12:44 -08001790}
1791
David S. Millercd07a8e2008-09-23 00:50:13 -07001792static inline bool tcp_skb_is_last(const struct sock *sk,
1793 const struct sk_buff *skb)
1794{
1795 return skb_queue_is_last(&sk->sk_write_queue, skb);
1796}
1797
Eric Dumazetee2aabd2019-12-12 12:55:30 -08001798/**
1799 * tcp_write_queue_empty - test if any payload (or FIN) is available in write queue
1800 * @sk: socket
1801 *
1802 * Since the write queue can have a temporary empty skb in it,
1803 * we must not use "return skb_queue_empty(&sk->sk_write_queue)"
1804 */
Eric Dumazet75c119a2017-10-05 22:21:27 -07001805static inline bool tcp_write_queue_empty(const struct sock *sk)
David S. Millerfe067e82007-03-07 12:12:44 -08001806{
Eric Dumazetee2aabd2019-12-12 12:55:30 -08001807 const struct tcp_sock *tp = tcp_sk(sk);
1808
1809 return tp->write_seq == tp->snd_nxt;
Eric Dumazet75c119a2017-10-05 22:21:27 -07001810}
1811
1812static inline bool tcp_rtx_queue_empty(const struct sock *sk)
1813{
1814 return RB_EMPTY_ROOT(&sk->tcp_rtx_queue);
1815}
1816
1817static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk)
1818{
1819 return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk);
David S. Millerfe067e82007-03-07 12:12:44 -08001820}
1821
David S. Millerfe067e82007-03-07 12:12:44 -08001822static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1823{
Eric Dumazeta43e0522019-02-26 09:49:10 -08001824 __skb_queue_tail(&sk->sk_write_queue, skb);
David S. Millerfe067e82007-03-07 12:12:44 -08001825
1826 /* Queue it, remembering where we must start sending. */
Eric Dumazet50895b92017-11-14 21:02:19 -08001827 if (sk->sk_write_queue.next == skb)
Francis Yan0f872302016-11-27 23:07:14 -08001828 tcp_chrono_start(sk, TCP_CHRONO_BUSY);
David S. Millerfe067e82007-03-07 12:12:44 -08001829}
1830
David S. Miller43f59c82008-09-21 21:28:51 -07001831/* Insert new before skb on the write queue of sk. */
David S. Millerfe067e82007-03-07 12:12:44 -08001832static inline void tcp_insert_write_queue_before(struct sk_buff *new,
1833 struct sk_buff *skb,
1834 struct sock *sk)
1835{
David S. Miller43f59c82008-09-21 21:28:51 -07001836 __skb_queue_before(&sk->sk_write_queue, skb, new);
David S. Millerfe067e82007-03-07 12:12:44 -08001837}
1838
1839static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
1840{
Eric Dumazet4a269812017-10-11 13:27:29 -07001841 tcp_skb_tsorted_anchor_cleanup(skb);
David S. Millerfe067e82007-03-07 12:12:44 -08001842 __skb_unlink(skb, &sk->sk_write_queue);
1843}
1844
Eric Dumazet75c119a2017-10-05 22:21:27 -07001845void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb);
1846
1847static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk)
David S. Millerfe067e82007-03-07 12:12:44 -08001848{
Eric Dumazet75c119a2017-10-05 22:21:27 -07001849 tcp_skb_tsorted_anchor_cleanup(skb);
1850 rb_erase(&skb->rbnode, &sk->tcp_rtx_queue);
1851}
1852
1853static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk)
1854{
1855 list_del(&skb->tcp_tsorted_anchor);
1856 tcp_rtx_queue_unlink(skb, sk);
1857 sk_wmem_free_skb(sk, skb);
David S. Millerfe067e82007-03-07 12:12:44 -08001858}
1859
Krishna Kumar12d50c42009-12-08 22:26:13 +00001860static inline void tcp_push_pending_frames(struct sock *sk)
1861{
1862 if (tcp_send_head(sk)) {
1863 struct tcp_sock *tp = tcp_sk(sk);
1864
1865 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
1866 }
1867}
1868
Neal Cardwellecb97192012-02-27 17:52:52 -05001869/* Start sequence of the skb just after the highest skb with SACKed
1870 * bit, valid only if sacked_out > 0 or when the caller has ensured
1871 * validity by itself.
Ilpo Järvinena47e5a92007-11-15 19:41:46 -08001872 */
1873static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
1874{
1875 if (!tp->sacked_out)
1876 return tp->snd_una;
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001877
1878 if (tp->highest_sack == NULL)
1879 return tp->snd_nxt;
1880
Ilpo Järvinena47e5a92007-11-15 19:41:46 -08001881 return TCP_SKB_CB(tp->highest_sack)->seq;
1882}
1883
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001884static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
1885{
Eric Dumazet50895b92017-11-14 21:02:19 -08001886 tcp_sk(sk)->highest_sack = skb_rb_next(skb);
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001887}
1888
1889static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
1890{
1891 return tcp_sk(sk)->highest_sack;
1892}
1893
1894static inline void tcp_highest_sack_reset(struct sock *sk)
1895{
Eric Dumazet50895b92017-11-14 21:02:19 -08001896 tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk);
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001897}
1898
Eric Dumazet2b7cda92017-10-30 23:08:20 -07001899/* Called when old skb is about to be deleted and replaced by new skb */
1900static inline void tcp_highest_sack_replace(struct sock *sk,
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001901 struct sk_buff *old,
1902 struct sk_buff *new)
1903{
Eric Dumazet2b7cda92017-10-30 23:08:20 -07001904 if (old == tcp_highest_sack(sk))
Ilpo Järvinen6859d492007-12-02 00:48:06 +02001905 tcp_sk(sk)->highest_sack = new;
1906}
1907
Florian Westphalb1f0a0e2015-12-21 21:29:24 +01001908/* This helper checks if socket has IP_TRANSPARENT set */
1909static inline bool inet_sk_transparent(const struct sock *sk)
1910{
1911 switch (sk->sk_state) {
1912 case TCP_TIME_WAIT:
1913 return inet_twsk(sk)->tw_transparent;
1914 case TCP_NEW_SYN_RECV:
1915 return inet_rsk(inet_reqsk(sk))->no_srccheck;
1916 }
1917 return inet_sk(sk)->transparent;
1918}
1919
Andreas Petlund5aa4b322010-02-18 02:45:45 +00001920/* Determines whether this is a thin stream (which may suffer from
1921 * increased latency). Used to trigger latency-reducing mechanisms.
1922 */
Eric Dumazeta2a385d2012-05-16 23:15:34 +00001923static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
Andreas Petlund5aa4b322010-02-18 02:45:45 +00001924{
1925 return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
1926}
1927
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928/* /proc */
1929enum tcp_seq_states {
1930 TCP_SEQ_STATE_LISTENING,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 TCP_SEQ_STATE_ESTABLISHED,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932};
1933
Christoph Hellwig37d849b2018-04-11 09:31:28 +02001934void *tcp_seq_start(struct seq_file *seq, loff_t *pos);
1935void *tcp_seq_next(struct seq_file *seq, void *v, loff_t *pos);
1936void tcp_seq_stop(struct seq_file *seq, void *v);
Arjan van de Ven73cb88e2011-10-30 06:46:30 +00001937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938struct tcp_seq_afinfo {
Arjan van de Ven73cb88e2011-10-30 06:46:30 +00001939 sa_family_t family;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940};
1941
1942struct tcp_iter_state {
Denis V. Luneva4146b12008-04-13 22:11:14 -07001943 struct seq_net_private p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 enum tcp_seq_states state;
1945 struct sock *syn_wait_sk;
Eric W. Biedermana7cb5a42012-05-24 01:10:10 -06001946 int bucket, offset, sbucket, num;
Tom Herberta8b690f2010-06-07 00:43:42 -07001947 loff_t last_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948};
1949
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001950extern struct request_sock_ops tcp_request_sock_ops;
Glenn Griffinc6aefaf2008-02-07 21:49:26 -08001951extern struct request_sock_ops tcp6_request_sock_ops;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001952
Joe Perches5c9f3022013-09-23 11:33:32 -07001953void tcp_v4_destroy_sock(struct sock *sk);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001954
Eric Dumazet28be6e02013-10-18 10:36:17 -07001955struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
Joe Perches5c9f3022013-09-23 11:33:32 -07001956 netdev_features_t features);
David Millerd4546c22018-06-24 14:13:49 +09001957struct sk_buff *tcp_gro_receive(struct list_head *head, struct sk_buff *skb);
Joe Perches5c9f3022013-09-23 11:33:32 -07001958int tcp_gro_complete(struct sk_buff *skb);
Daniel Borkmann28850dc2013-06-07 05:11:46 +00001959
Joe Perches5c9f3022013-09-23 11:33:32 -07001960void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, __be32 daddr);
Herbert Xuf4c50d92006-06-22 03:02:40 -07001961
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001962static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
1963{
Nikolay Borisov4979f2d2016-02-03 09:46:57 +02001964 struct net *net = sock_net((struct sock *)tp);
1965 return tp->notsent_lowat ?: net->ipv4.sysctl_tcp_notsent_lowat;
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001966}
1967
Eric Dumazeta74f0fa2018-12-04 07:58:17 -08001968/* @wake is one when sk_stream_write_space() calls us.
1969 * This sends EPOLLOUT only if notsent_bytes is half the limit.
1970 * This mimics the strategy used in sock_def_write_space().
1971 */
1972static inline bool tcp_stream_memory_free(const struct sock *sk, int wake)
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001973{
1974 const struct tcp_sock *tp = tcp_sk(sk);
Eric Dumazete0d694d2019-10-10 20:17:42 -07001975 u32 notsent_bytes = READ_ONCE(tp->write_seq) -
1976 READ_ONCE(tp->snd_nxt);
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001977
Eric Dumazeta74f0fa2018-12-04 07:58:17 -08001978 return (notsent_bytes << wake) < tcp_notsent_lowat(tp);
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001979}
1980
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001981#ifdef CONFIG_PROC_FS
Joe Perches5c9f3022013-09-23 11:33:32 -07001982int tcp4_proc_init(void);
1983void tcp4_proc_exit(void);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001984#endif
1985
Eric Dumazetea3bea32015-09-25 07:39:23 -07001986int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
Octavian Purdila1fb6f152014-06-25 17:10:02 +03001987int tcp_conn_request(struct request_sock_ops *rsk_ops,
1988 const struct tcp_request_sock_ops *af_ops,
1989 struct sock *sk, struct sk_buff *skb);
Octavian Purdila5db92c92014-06-25 17:09:59 +03001990
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08001991/* TCP af-specific functions */
1992struct tcp_sock_af_ops {
1993#ifdef CONFIG_TCP_MD5SIG
Eric Dumazetb83e3de2015-09-25 07:39:15 -07001994 struct tcp_md5sig_key *(*md5_lookup) (const struct sock *sk,
Eric Dumazetfd3a1542015-03-24 15:58:56 -07001995 const struct sock *addr_sk);
Eric Dumazet39f8e582015-03-24 15:58:55 -07001996 int (*calc_md5_hash)(char *location,
1997 const struct tcp_md5sig_key *md5,
1998 const struct sock *sk,
1999 const struct sk_buff *skb);
2000 int (*md5_parse)(struct sock *sk,
Ivan Delalande8917a772017-06-15 18:07:07 -07002001 int optname,
Eric Dumazet39f8e582015-03-24 15:58:55 -07002002 char __user *optval,
2003 int optlen);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08002004#endif
2005};
2006
2007struct tcp_request_sock_ops {
Octavian Purdila2aec4a22014-06-25 17:10:00 +03002008 u16 mss_clamp;
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08002009#ifdef CONFIG_TCP_MD5SIG
Eric Dumazetb83e3de2015-09-25 07:39:15 -07002010 struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk,
Eric Dumazetfd3a1542015-03-24 15:58:56 -07002011 const struct sock *addr_sk);
Eric Dumazet39f8e582015-03-24 15:58:55 -07002012 int (*calc_md5_hash) (char *location,
2013 const struct tcp_md5sig_key *md5,
2014 const struct sock *sk,
2015 const struct sk_buff *skb);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08002016#endif
Eric Dumazetb40cf182015-09-25 07:39:08 -07002017 void (*init_req)(struct request_sock *req,
2018 const struct sock *sk_listener,
Octavian Purdila16bea702014-06-25 17:09:53 +03002019 struct sk_buff *skb);
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002020#ifdef CONFIG_SYN_COOKIES
Eric Dumazet3f684b42015-09-29 07:42:49 -07002021 __u32 (*cookie_init_seq)(const struct sk_buff *skb,
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002022 __u16 *mss);
2023#endif
Eric Dumazetf9646292015-09-29 07:42:50 -07002024 struct dst_entry *(*route_req)(const struct sock *sk, struct flowi *fl,
Soheil Hassas Yeganeh4396e462017-03-15 16:30:46 -04002025 const struct request_sock *req);
Eric Dumazet84b114b2017-05-05 06:56:54 -07002026 u32 (*init_seq)(const struct sk_buff *skb);
Eric Dumazet5d2ed052017-06-07 10:34:39 -07002027 u32 (*init_ts_off)(const struct net *net, const struct sk_buff *skb);
Eric Dumazet0f935db2015-09-25 07:39:21 -07002028 int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
Octavian Purdilad6274bd2014-06-25 17:09:58 +03002029 struct flowi *fl, struct request_sock *req,
Eric Dumazetdc6ef6b2015-10-16 13:00:01 -07002030 struct tcp_fastopen_cookie *foc,
Eric Dumazetb3d05142016-04-13 22:05:39 -07002031 enum tcp_synack_type synack_type);
YOSHIFUJI Hideakicfb6eeb2006-11-14 19:07:45 -08002032};
2033
Mat Martineau35b2c322020-01-09 07:59:21 -08002034extern const struct tcp_request_sock_ops tcp_request_sock_ipv4_ops;
2035#if IS_ENABLED(CONFIG_IPV6)
2036extern const struct tcp_request_sock_ops tcp_request_sock_ipv6_ops;
2037#endif
2038
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002039#ifdef CONFIG_SYN_COOKIES
2040static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
Eric Dumazet3f684b42015-09-29 07:42:49 -07002041 const struct sock *sk, struct sk_buff *skb,
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002042 __u16 *mss)
2043{
Eric Dumazet3f684b42015-09-29 07:42:49 -07002044 tcp_synq_overflow(sk);
Eric Dumazet02a1d6e2016-04-27 16:44:39 -07002045 __NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
Eric Dumazet3f684b42015-09-29 07:42:49 -07002046 return ops->cookie_init_seq(skb, mss);
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002047}
2048#else
2049static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
Eric Dumazet3f684b42015-09-29 07:42:49 -07002050 const struct sock *sk, struct sk_buff *skb,
Octavian Purdilafb7b37a2014-06-25 17:09:54 +03002051 __u16 *mss)
2052{
2053 return 0;
2054}
2055#endif
2056
Joe Perches5c9f3022013-09-23 11:33:32 -07002057int tcpv4_offload_init(void);
Daniel Borkmann28850dc2013-06-07 05:11:46 +00002058
Joe Perches5c9f3022013-09-23 11:33:32 -07002059void tcp_v4_init(void);
2060void tcp_init(void);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002061
Yuchung Cheng659a8ad2015-10-16 21:57:46 -07002062/* tcp_recovery.c */
Yuchung Chengd716bfd2018-05-16 16:40:13 -07002063void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb);
Yuchung Cheng6ac06ec2018-05-16 16:40:12 -07002064void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced);
Yuchung Chengb8fef652018-05-16 16:40:16 -07002065extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb,
2066 u32 reo_wnd);
Eric Dumazet128eda82017-04-25 10:15:34 -07002067extern void tcp_rack_mark_lost(struct sock *sk);
Yuchung Cheng1d0833d2017-01-12 22:11:34 -08002068extern void tcp_rack_advance(struct tcp_sock *tp, u8 sacked, u32 end_seq,
Eric Dumazet9a568de2017-05-16 14:00:14 -07002069 u64 xmit_time);
Yuchung Cheng57dde7f2017-01-12 22:11:33 -08002070extern void tcp_rack_reo_timeout(struct sock *sk);
Priyaranjan Jha1f255692017-11-03 16:38:48 -07002071extern void tcp_rack_update_reo_wnd(struct sock *sk, struct rate_sample *rs);
Yuchung Cheng659a8ad2015-10-16 21:57:46 -07002072
Neal Cardwelle1a10ef2017-08-03 09:19:52 -04002073/* At how many usecs into the future should the RTO fire? */
2074static inline s64 tcp_rto_delta_us(const struct sock *sk)
2075{
Eric Dumazet75c119a2017-10-05 22:21:27 -07002076 const struct sk_buff *skb = tcp_rtx_queue_head(sk);
Neal Cardwelle1a10ef2017-08-03 09:19:52 -04002077 u32 rto = inet_csk(sk)->icsk_rto;
Eric Dumazet2fd66ff2018-09-21 08:51:47 -07002078 u64 rto_time_stamp_us = tcp_skb_timestamp_us(skb) + jiffies_to_usecs(rto);
Neal Cardwelle1a10ef2017-08-03 09:19:52 -04002079
2080 return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp;
2081}
2082
Cong Wange25f8662014-10-15 14:33:21 -07002083/*
2084 * Save and compile IPv4 options, return a pointer to it
2085 */
Paolo Abeni91ed1e62017-08-03 18:07:06 +02002086static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net,
2087 struct sk_buff *skb)
Cong Wange25f8662014-10-15 14:33:21 -07002088{
2089 const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
2090 struct ip_options_rcu *dopt = NULL;
2091
Cong Wang461b74c2014-10-15 14:33:22 -07002092 if (opt->optlen) {
Cong Wange25f8662014-10-15 14:33:21 -07002093 int opt_size = sizeof(*dopt) + opt->optlen;
2094
2095 dopt = kmalloc(opt_size, GFP_ATOMIC);
Paolo Abeni91ed1e62017-08-03 18:07:06 +02002096 if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) {
Cong Wange25f8662014-10-15 14:33:21 -07002097 kfree(dopt);
2098 dopt = NULL;
2099 }
2100 }
2101 return dopt;
2102}
2103
Eric Dumazet98781962015-02-03 18:31:53 -08002104/* locally generated TCP pure ACKs have skb->truesize == 2
2105 * (check tcp_send_ack() in net/ipv4/tcp_output.c )
2106 * This is much faster than dissecting the packet to find out.
2107 * (Think of GRE encapsulations, IPv4, IPv6, ...)
2108 */
2109static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
2110{
2111 return skb->truesize == 2;
2112}
2113
2114static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
2115{
2116 skb->truesize = 2;
2117}
2118
Tom Herbert473bd232016-03-07 14:11:05 -08002119static inline int tcp_inq(struct sock *sk)
2120{
2121 struct tcp_sock *tp = tcp_sk(sk);
2122 int answ;
2123
2124 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
2125 answ = 0;
2126 } else if (sock_flag(sk, SOCK_URGINLINE) ||
2127 !tp->urg_data ||
2128 before(tp->urg_seq, tp->copied_seq) ||
2129 !before(tp->urg_seq, tp->rcv_nxt)) {
2130
2131 answ = tp->rcv_nxt - tp->copied_seq;
2132
2133 /* Subtract 1, if FIN was received */
2134 if (answ && sock_flag(sk, SOCK_DONE))
2135 answ--;
2136 } else {
2137 answ = tp->urg_seq - tp->copied_seq;
2138 }
2139
2140 return answ;
2141}
2142
Tom Herbert32035582016-08-28 14:43:18 -07002143int tcp_peek_len(struct socket *sock);
2144
Martin KaFai Laua44d6ea2016-03-14 10:52:15 -07002145static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
2146{
2147 u16 segs_in;
2148
2149 segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2150 tp->segs_in += segs_in;
2151 if (skb->len > tcp_hdrlen(skb))
2152 tp->data_segs_in += segs_in;
2153}
2154
Eric Dumazet9caad862016-04-01 08:52:20 -07002155/*
2156 * TCP listen path runs lockless.
2157 * We forced "struct sock" to be const qualified to make sure
2158 * we don't modify one of its field by mistake.
2159 * Here, we increment sk_drops which is an atomic_t, so we can safely
2160 * make sock writable again.
2161 */
2162static inline void tcp_listendrop(const struct sock *sk)
2163{
2164 atomic_inc(&((struct sock *)sk)->sk_drops);
Eric Dumazet02a1d6e2016-04-27 16:44:39 -07002165 __NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
Eric Dumazet9caad862016-04-01 08:52:20 -07002166}
2167
Eric Dumazet218af592017-05-16 04:24:36 -07002168enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);
2169
Dave Watson734942c2017-06-14 11:37:14 -07002170/*
2171 * Interface for adding Upper Level Protocols over TCP
2172 */
2173
2174#define TCP_ULP_NAME_MAX 16
2175#define TCP_ULP_MAX 128
2176#define TCP_ULP_BUF_MAX (TCP_ULP_NAME_MAX*TCP_ULP_MAX)
2177
2178struct tcp_ulp_ops {
2179 struct list_head list;
2180
2181 /* initialize ulp */
2182 int (*init)(struct sock *sk);
John Fastabend95fa1452019-07-19 10:29:22 -07002183 /* update ulp */
John Fastabend33bfe202020-01-11 06:12:01 +00002184 void (*update)(struct sock *sk, struct proto *p,
2185 void (*write_space)(struct sock *sk));
Dave Watson734942c2017-06-14 11:37:14 -07002186 /* cleanup ulp */
2187 void (*release)(struct sock *sk);
Davide Caratti61723b32019-08-30 12:25:48 +02002188 /* diagnostic */
2189 int (*get_info)(const struct sock *sk, struct sk_buff *skb);
2190 size_t (*get_info_size)(const struct sock *sk);
Mat Martineau13230592020-01-09 07:59:18 -08002191 /* clone ulp */
2192 void (*clone)(const struct request_sock *req, struct sock *newsk,
2193 const gfp_t priority);
Dave Watson734942c2017-06-14 11:37:14 -07002194
2195 char name[TCP_ULP_NAME_MAX];
2196 struct module *owner;
2197};
2198int tcp_register_ulp(struct tcp_ulp_ops *type);
2199void tcp_unregister_ulp(struct tcp_ulp_ops *type);
2200int tcp_set_ulp(struct sock *sk, const char *name);
2201void tcp_get_available_ulp(char *buf, size_t len);
2202void tcp_cleanup_ulp(struct sock *sk);
John Fastabend33bfe202020-01-11 06:12:01 +00002203void tcp_update_ulp(struct sock *sk, struct proto *p,
2204 void (*write_space)(struct sock *sk));
Dave Watson734942c2017-06-14 11:37:14 -07002205
Daniel Borkmann037b0b82018-08-16 21:49:06 +02002206#define MODULE_ALIAS_TCP_ULP(name) \
2207 __MODULE_INFO(alias, alias_userspace, name); \
2208 __MODULE_INFO(alias, alias_tcp_ulp, "tcp-ulp-" name)
2209
Daniel Borkmann604326b2018-10-13 02:45:58 +02002210struct sk_msg;
2211struct sk_psock;
2212
Lorenz Bauerf7476322020-03-09 11:12:36 +00002213#ifdef CONFIG_BPF_STREAM_PARSER
2214struct proto *tcp_bpf_get_proto(struct sock *sk, struct sk_psock *psock);
2215void tcp_bpf_clone(const struct sock *sk, struct sock *newsk);
2216#else
2217static inline void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
2218{
2219}
2220#endif /* CONFIG_BPF_STREAM_PARSER */
2221
Lorenz Bauer5da00402020-03-09 11:12:35 +00002222#ifdef CONFIG_NET_SOCK_MSG
Daniel Borkmann604326b2018-10-13 02:45:58 +02002223int tcp_bpf_sendmsg_redir(struct sock *sk, struct sk_msg *msg, u32 bytes,
2224 int flags);
Daniel Borkmann604326b2018-10-13 02:45:58 +02002225int __tcp_bpf_recvmsg(struct sock *sk, struct sk_psock *psock,
John Fastabend02c558b2018-10-16 11:08:04 -07002226 struct msghdr *msg, int len, int flags);
Lorenz Bauer5da00402020-03-09 11:12:35 +00002227#endif /* CONFIG_NET_SOCK_MSG */
Daniel Borkmann604326b2018-10-13 02:45:58 +02002228
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002229/* Call BPF_SOCK_OPS program that returns an int. If the return value
2230 * is < 0, then the BPF op failed (for example if the loaded BPF
2231 * program does not support the chosen operation or there is no BPF
2232 * program loaded).
2233 */
2234#ifdef CONFIG_BPF
Lawrence Brakmode525be2018-01-25 16:14:09 -08002235static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002236{
2237 struct bpf_sock_ops_kern sock_ops;
2238 int ret;
2239
Lawrence Brakmob73042b2018-01-25 16:14:08 -08002240 memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp));
Lawrence Brakmof19397a2017-12-01 10:15:04 -08002241 if (sk_fullsock(sk)) {
2242 sock_ops.is_fullsock = 1;
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002243 sock_owned_by_me(sk);
Lawrence Brakmof19397a2017-12-01 10:15:04 -08002244 }
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002245
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002246 sock_ops.sk = sk;
2247 sock_ops.op = op;
Lawrence Brakmode525be2018-01-25 16:14:09 -08002248 if (nargs > 0)
2249 memcpy(sock_ops.args, args, nargs * sizeof(*args));
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002250
2251 ret = BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops);
2252 if (ret == 0)
2253 ret = sock_ops.reply;
2254 else
2255 ret = -1;
2256 return ret;
2257}
Lawrence Brakmode525be2018-01-25 16:14:09 -08002258
2259static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2260{
2261 u32 args[2] = {arg1, arg2};
2262
2263 return tcp_call_bpf(sk, op, 2, args);
2264}
2265
2266static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2267 u32 arg3)
2268{
2269 u32 args[3] = {arg1, arg2, arg3};
2270
2271 return tcp_call_bpf(sk, op, 3, args);
2272}
2273
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002274#else
Lawrence Brakmode525be2018-01-25 16:14:09 -08002275static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002276{
2277 return -EPERM;
2278}
Lawrence Brakmode525be2018-01-25 16:14:09 -08002279
2280static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2281{
2282 return -EPERM;
2283}
2284
2285static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2286 u32 arg3)
2287{
2288 return -EPERM;
2289}
2290
Lawrence Brakmo40304b22017-06-30 20:02:40 -07002291#endif
2292
Lawrence Brakmo8550f322017-06-30 20:02:42 -07002293static inline u32 tcp_timeout_init(struct sock *sk)
2294{
2295 int timeout;
2296
Lawrence Brakmode525be2018-01-25 16:14:09 -08002297 timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT, 0, NULL);
Lawrence Brakmo8550f322017-06-30 20:02:42 -07002298
2299 if (timeout <= 0)
2300 timeout = TCP_TIMEOUT_INIT;
2301 return timeout;
2302}
2303
Lawrence Brakmo13d3b1e2017-06-30 20:02:44 -07002304static inline u32 tcp_rwnd_init_bpf(struct sock *sk)
2305{
2306 int rwnd;
2307
Lawrence Brakmode525be2018-01-25 16:14:09 -08002308 rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT, 0, NULL);
Lawrence Brakmo13d3b1e2017-06-30 20:02:44 -07002309
2310 if (rwnd < 0)
2311 rwnd = 0;
2312 return rwnd;
2313}
Lawrence Brakmo91b5b212017-06-30 20:02:49 -07002314
2315static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk)
2316{
Lawrence Brakmode525be2018-01-25 16:14:09 -08002317 return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN, 0, NULL) == 1);
Lawrence Brakmo91b5b212017-06-30 20:02:49 -07002318}
Ursula Braun60e2a772017-10-25 11:01:45 +02002319
Stanislav Fomichev23729ff2019-07-02 09:13:56 -07002320static inline void tcp_bpf_rtt(struct sock *sk)
2321{
Arnd Bergmannbef8e262019-07-08 14:57:21 +02002322 if (BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), BPF_SOCK_OPS_RTT_CB_FLAG))
Stanislav Fomichev23729ff2019-07-02 09:13:56 -07002323 tcp_call_bpf(sk, BPF_SOCK_OPS_RTT_CB, 0, NULL);
2324}
2325
Ursula Braun60e2a772017-10-25 11:01:45 +02002326#if IS_ENABLED(CONFIG_SMC)
2327extern struct static_key_false tcp_have_smc;
2328#endif
Ilya Lesokhin6dac1522018-04-30 10:16:10 +03002329
2330#if IS_ENABLED(CONFIG_TLS_DEVICE)
2331void clean_acked_data_enable(struct inet_connection_sock *icsk,
2332 void (*cad)(struct sock *sk, u32 ack_seq));
2333void clean_acked_data_disable(struct inet_connection_sock *icsk);
Jakub Kicinski494bc1d2019-05-08 16:46:14 -07002334void clean_acked_data_flush(void);
Ilya Lesokhin6dac1522018-04-30 10:16:10 +03002335#endif
2336
Eric Dumazeta842fe12019-06-12 11:57:25 -07002337DECLARE_STATIC_KEY_FALSE(tcp_tx_delay_enabled);
2338static inline void tcp_add_tx_delay(struct sk_buff *skb,
2339 const struct tcp_sock *tp)
2340{
2341 if (static_branch_unlikely(&tcp_tx_delay_enabled))
2342 skb->skb_mstamp_ns += (u64)tp->tcp_tx_delay * NSEC_PER_USEC;
2343}
2344
Eric Dumazetd6fb3962019-06-13 21:22:35 -07002345/* Compute Earliest Departure Time for some control packets
2346 * like ACK or RST for TIME_WAIT or non ESTABLISHED sockets.
2347 */
2348static inline u64 tcp_transmit_time(const struct sock *sk)
Eric Dumazeta842fe12019-06-12 11:57:25 -07002349{
2350 if (static_branch_unlikely(&tcp_tx_delay_enabled)) {
2351 u32 delay = (sk->sk_state == TCP_TIME_WAIT) ?
2352 tcp_twsk(sk)->tw_tx_delay : tcp_sk(sk)->tcp_tx_delay;
2353
Eric Dumazetd6fb3962019-06-13 21:22:35 -07002354 return tcp_clock_ns() + (u64)delay * NSEC_PER_USEC;
Eric Dumazeta842fe12019-06-12 11:57:25 -07002355 }
Eric Dumazetd6fb3962019-06-13 21:22:35 -07002356 return 0;
Eric Dumazeta842fe12019-06-12 11:57:25 -07002357}
2358
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359#endif /* _TCP_H */