]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - include/net/tcp.h
tcp: rename sk_forced_wmem_schedule() to sk_forced_mem_schedule()
[thirdparty/kernel/linux.git] / include / net / tcp.h
CommitLineData
1da177e4
LT
1/*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the TCP module.
7 *
8 * Version: @(#)tcp.h 1.0.5 05/23/93
9 *
02c30a84 10 * Authors: Ross Biro
1da177e4
LT
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 */
18#ifndef _TCP_H
19#define _TCP_H
20
1da177e4
LT
21#define FASTRETRANS_DEBUG 1
22
1da177e4
LT
23#include <linux/list.h>
24#include <linux/tcp.h>
187f1882 25#include <linux/bug.h>
1da177e4
LT
26#include <linux/slab.h>
27#include <linux/cache.h>
28#include <linux/percpu.h>
fb286bb2 29#include <linux/skbuff.h>
cfb6eeb4 30#include <linux/crypto.h>
c6aefafb 31#include <linux/cryptohash.h>
435cf559 32#include <linux/kref.h>
740b0f18 33#include <linux/ktime.h>
3f421baa
ACM
34
35#include <net/inet_connection_sock.h>
295ff7ed 36#include <net/inet_timewait_sock.h>
77d8bf9c 37#include <net/inet_hashtables.h>
1da177e4 38#include <net/checksum.h>
2e6599cb 39#include <net/request_sock.h>
1da177e4
LT
40#include <net/sock.h>
41#include <net/snmp.h>
42#include <net/ip.h>
c752f073 43#include <net/tcp_states.h>
bdf1ee5d 44#include <net/inet_ecn.h>
0c266898 45#include <net/dst.h>
c752f073 46
1da177e4 47#include <linux/seq_file.h>
180d8cd9 48#include <linux/memcontrol.h>
1da177e4 49
6e04e021 50extern struct inet_hashinfo tcp_hashinfo;
1da177e4 51
dd24c001 52extern struct percpu_counter tcp_orphan_count;
5c9f3023 53void tcp_time_wait(struct sock *sk, int state, int timeo);
1da177e4 54
1da177e4 55#define MAX_TCP_HEADER (128 + MAX_HEADER)
33ad798c 56#define MAX_TCP_OPTION_SPACE 40
1da177e4 57
105970f6 58/*
1da177e4 59 * Never offer a window over 32767 without using window scaling. Some
105970f6 60 * poor stacks do signed 16bit maths!
1da177e4
LT
61 */
62#define MAX_TCP_WINDOW 32767U
63
64/* Minimal accepted MSS. It is (60+60+8) - (20+20). */
65#define TCP_MIN_MSS 88U
66
5d424d5a 67/* The least MTU to use for probing */
dcd8fb85 68#define TCP_BASE_MSS 1024
5d424d5a 69
05cbc0db
FD
70/* probing interval, default to 10 minutes as per RFC4821 */
71#define TCP_PROBE_INTERVAL 600
72
6b58e0a5
FD
73/* Specify interval when tcp mtu probing will stop */
74#define TCP_PROBE_THRESHOLD 8
75
1da177e4
LT
76/* After receiving this amount of duplicate ACKs fast retransmit starts. */
77#define TCP_FASTRETRANS_THRESH 3
78
1da177e4
LT
79/* Maximal number of ACKs sent quickly to accelerate slow-start. */
80#define TCP_MAX_QUICKACKS 16U
81
82/* urg_data states */
83#define TCP_URG_VALID 0x0100
84#define TCP_URG_NOTYET 0x0200
85#define TCP_URG_READ 0x0400
86
87#define TCP_RETR1 3 /*
88 * This is how many retries it does before it
89 * tries to figure out if the gateway is
90 * down. Minimal RFC value is 3; it corresponds
91 * to ~3sec-8min depending on RTO.
92 */
93
94#define TCP_RETR2 15 /*
95 * This should take at least
96 * 90 minutes to time out.
97 * RFC1122 says that the limit is 100 sec.
98 * 15 is ~13-30min depending on RTO.
99 */
100
6c9ff979
AB
101#define TCP_SYN_RETRIES 6 /* This is how many retries are done
102 * when active opening a connection.
103 * RFC1122 says the minimum retry MUST
104 * be at least 180secs. Nevertheless
105 * this value is corresponding to
106 * 63secs of retransmission with the
107 * current initial RTO.
108 */
1da177e4 109
6c9ff979
AB
110#define TCP_SYNACK_RETRIES 5 /* This is how may retries are done
111 * when passive opening a connection.
112 * This is corresponding to 31secs of
113 * retransmission with the current
114 * initial RTO.
115 */
1da177e4 116
1da177e4
LT
117#define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
118 * state, about 60 seconds */
119#define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
120 /* BSD style FIN_WAIT2 deadlock breaker.
121 * It used to be 3min, new value is 60sec,
122 * to combine FIN-WAIT-2 timeout with
123 * TIME-WAIT timer.
124 */
125
126#define TCP_DELACK_MAX ((unsigned)(HZ/5)) /* maximal time to delay before sending an ACK */
127#if HZ >= 100
128#define TCP_DELACK_MIN ((unsigned)(HZ/25)) /* minimal time to delay before sending an ACK */
129#define TCP_ATO_MIN ((unsigned)(HZ/25))
130#else
131#define TCP_DELACK_MIN 4U
132#define TCP_ATO_MIN 4U
133#endif
134#define TCP_RTO_MAX ((unsigned)(120*HZ))
135#define TCP_RTO_MIN ((unsigned)(HZ/5))
fd4f2cea 136#define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC6298 2.1 initial RTO value */
9ad7c049
JC
137#define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now
138 * used as a fallback RTO for the
139 * initial data transmission if no
140 * valid RTT sample has been acquired,
141 * most likely due to retrans in 3WHS.
142 */
1da177e4
LT
143
144#define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
145 * for local resources.
146 */
147
148#define TCP_KEEPALIVE_TIME (120*60*HZ) /* two hours */
149#define TCP_KEEPALIVE_PROBES 9 /* Max of 9 keepalive probes */
150#define TCP_KEEPALIVE_INTVL (75*HZ)
151
152#define MAX_TCP_KEEPIDLE 32767
153#define MAX_TCP_KEEPINTVL 32767
154#define MAX_TCP_KEEPCNT 127
155#define MAX_TCP_SYNCNT 127
156
157#define TCP_SYNQ_INTERVAL (HZ/5) /* Period of SYNACK timer */
1da177e4
LT
158
159#define TCP_PAWS_24DAYS (60 * 60 * 24 * 24)
160#define TCP_PAWS_MSL 60 /* Per-host timestamps are invalidated
161 * after this time. It should be equal
162 * (or greater than) TCP_TIMEWAIT_LEN
163 * to provide reliability equal to one
164 * provided by timewait state.
165 */
166#define TCP_PAWS_WINDOW 1 /* Replay window for per-host
167 * timestamps. It must be less than
168 * minimal timewait lifetime.
169 */
1da177e4
LT
170/*
171 * TCP option
172 */
105970f6 173
1da177e4
LT
174#define TCPOPT_NOP 1 /* Padding */
175#define TCPOPT_EOL 0 /* End of options */
176#define TCPOPT_MSS 2 /* Segment size negotiating */
177#define TCPOPT_WINDOW 3 /* Window scaling */
178#define TCPOPT_SACK_PERM 4 /* SACK Permitted */
179#define TCPOPT_SACK 5 /* SACK Block */
180#define TCPOPT_TIMESTAMP 8 /* Better RTT estimations/PAWS */
cfb6eeb4 181#define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */
7f9b838b 182#define TCPOPT_FASTOPEN 34 /* Fast open (RFC7413) */
2100c8d2
YC
183#define TCPOPT_EXP 254 /* Experimental */
184/* Magic number to be after the option value for sharing TCP
185 * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
186 */
187#define TCPOPT_FASTOPEN_MAGIC 0xF989
1da177e4
LT
188
189/*
190 * TCP option lengths
191 */
192
193#define TCPOLEN_MSS 4
194#define TCPOLEN_WINDOW 3
195#define TCPOLEN_SACK_PERM 2
196#define TCPOLEN_TIMESTAMP 10
cfb6eeb4 197#define TCPOLEN_MD5SIG 18
7f9b838b 198#define TCPOLEN_FASTOPEN_BASE 2
2100c8d2 199#define TCPOLEN_EXP_FASTOPEN_BASE 4
1da177e4
LT
200
201/* But this is what stacks really send out. */
202#define TCPOLEN_TSTAMP_ALIGNED 12
203#define TCPOLEN_WSCALE_ALIGNED 4
204#define TCPOLEN_SACKPERM_ALIGNED 4
205#define TCPOLEN_SACK_BASE 2
206#define TCPOLEN_SACK_BASE_ALIGNED 4
207#define TCPOLEN_SACK_PERBLOCK 8
cfb6eeb4 208#define TCPOLEN_MD5SIG_ALIGNED 20
33ad798c 209#define TCPOLEN_MSS_ALIGNED 4
1da177e4 210
1da177e4
LT
211/* Flags in tp->nonagle */
212#define TCP_NAGLE_OFF 1 /* Nagle's algo is disabled */
213#define TCP_NAGLE_CORK 2 /* Socket is corked */
caa20d9a 214#define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */
1da177e4 215
36e31b0a
AP
216/* TCP thin-stream limits */
217#define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */
218
7eb38527 219/* TCP initial congestion window as per draft-hkchu-tcpm-initcwnd-01 */
442b9635
DM
220#define TCP_INIT_CWND 10
221
cf60af03
YC
222/* Bit Flags for sysctl_tcp_fastopen */
223#define TFO_CLIENT_ENABLE 1
10467163 224#define TFO_SERVER_ENABLE 2
67da22d2 225#define TFO_CLIENT_NO_COOKIE 4 /* Data in SYN w/o cookie option */
cf60af03 226
10467163
JC
227/* Accept SYN data w/o any cookie option */
228#define TFO_SERVER_COOKIE_NOT_REQD 0x200
229
230/* Force enable TFO on all listeners, i.e., not requiring the
231 * TCP_FASTOPEN socket option. SOCKOPT1/2 determine how to set max_qlen.
232 */
233#define TFO_SERVER_WO_SOCKOPT1 0x400
234#define TFO_SERVER_WO_SOCKOPT2 0x800
10467163 235
295ff7ed
ACM
236extern struct inet_timewait_death_row tcp_death_row;
237
1da177e4 238/* sysctl variables for tcp */
1da177e4
LT
239extern int sysctl_tcp_timestamps;
240extern int sysctl_tcp_window_scaling;
241extern int sysctl_tcp_sack;
242extern int sysctl_tcp_fin_timeout;
1da177e4
LT
243extern int sysctl_tcp_keepalive_time;
244extern int sysctl_tcp_keepalive_probes;
245extern int sysctl_tcp_keepalive_intvl;
246extern int sysctl_tcp_syn_retries;
247extern int sysctl_tcp_synack_retries;
248extern int sysctl_tcp_retries1;
249extern int sysctl_tcp_retries2;
250extern int sysctl_tcp_orphan_retries;
251extern int sysctl_tcp_syncookies;
2100c8d2 252extern int sysctl_tcp_fastopen;
1da177e4
LT
253extern int sysctl_tcp_retrans_collapse;
254extern int sysctl_tcp_stdurg;
255extern int sysctl_tcp_rfc1337;
256extern int sysctl_tcp_abort_on_overflow;
257extern int sysctl_tcp_max_orphans;
1da177e4
LT
258extern int sysctl_tcp_fack;
259extern int sysctl_tcp_reordering;
dca145ff 260extern int sysctl_tcp_max_reordering;
1da177e4 261extern int sysctl_tcp_dsack;
a4fe34bf 262extern long sysctl_tcp_mem[3];
1da177e4
LT
263extern int sysctl_tcp_wmem[3];
264extern int sysctl_tcp_rmem[3];
265extern int sysctl_tcp_app_win;
266extern int sysctl_tcp_adv_win_scale;
267extern int sysctl_tcp_tw_reuse;
268extern int sysctl_tcp_frto;
269extern int sysctl_tcp_low_latency;
1da177e4 270extern int sysctl_tcp_nometrics_save;
1da177e4
LT
271extern int sysctl_tcp_moderate_rcvbuf;
272extern int sysctl_tcp_tso_win_divisor;
15d99e02 273extern int sysctl_tcp_workaround_signed_windows;
35089bb2 274extern int sysctl_tcp_slow_start_after_idle;
36e31b0a 275extern int sysctl_tcp_thin_linear_timeouts;
7e380175 276extern int sysctl_tcp_thin_dupack;
eed530b6 277extern int sysctl_tcp_early_retrans;
46d3ceab 278extern int sysctl_tcp_limit_output_bytes;
282f23c6 279extern int sysctl_tcp_challenge_ack_limit;
c9bee3b7 280extern unsigned int sysctl_tcp_notsent_lowat;
95bd09eb 281extern int sysctl_tcp_min_tso_segs;
f54b3111 282extern int sysctl_tcp_autocorking;
032ee423 283extern int sysctl_tcp_invalid_ratelimit;
1da177e4 284
8d987e5c 285extern atomic_long_t tcp_memory_allocated;
1748376b 286extern struct percpu_counter tcp_sockets_allocated;
1da177e4
LT
287extern int tcp_memory_pressure;
288
1da177e4
LT
289/*
290 * The next routines deal with comparing 32 bit unsigned ints
291 * and worry about wraparound (automatic with unsigned arithmetic).
292 */
293
a2a385d6 294static inline bool before(__u32 seq1, __u32 seq2)
1da177e4 295{
0d630cc0 296 return (__s32)(seq1-seq2) < 0;
1da177e4 297}
9a036b9c 298#define after(seq2, seq1) before(seq1, seq2)
1da177e4
LT
299
300/* is s2<=s1<=s3 ? */
a2a385d6 301static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
1da177e4
LT
302{
303 return seq3 - seq2 >= seq1 - seq2;
304}
305
efcdbf24
AS
306static inline bool tcp_out_of_memory(struct sock *sk)
307{
308 if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
309 sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
310 return true;
311 return false;
312}
313
a6c5ea4c
ED
314void sk_forced_mem_schedule(struct sock *sk, int size);
315
ad1af0fe 316static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
e4fd5da3 317{
ad1af0fe
DM
318 struct percpu_counter *ocp = sk->sk_prot->orphan_count;
319 int orphans = percpu_counter_read_positive(ocp);
320
321 if (orphans << shift > sysctl_tcp_max_orphans) {
322 orphans = percpu_counter_sum_positive(ocp);
323 if (orphans << shift > sysctl_tcp_max_orphans)
324 return true;
325 }
ad1af0fe 326 return false;
e4fd5da3 327}
1da177e4 328
5c9f3023 329bool tcp_check_oom(struct sock *sk, int shift);
efcdbf24 330
a0f82f64 331
1da177e4
LT
332extern struct proto tcp_prot;
333
57ef42d5
PE
334#define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field)
335#define TCP_INC_STATS_BH(net, field) SNMP_INC_STATS_BH((net)->mib.tcp_statistics, field)
336#define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
337#define TCP_ADD_STATS_USER(net, field, val) SNMP_ADD_STATS_USER((net)->mib.tcp_statistics, field, val)
aa2ea058 338#define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
1da177e4 339
5c9f3023
JP
340void tcp_tasklet_init(void);
341
342void tcp_v4_err(struct sk_buff *skb, u32);
343
344void tcp_shutdown(struct sock *sk, int how);
345
346void tcp_v4_early_demux(struct sk_buff *skb);
347int tcp_v4_rcv(struct sk_buff *skb);
348
349int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
1b784140 350int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
5c9f3023
JP
351int tcp_sendpage(struct sock *sk, struct page *page, int offset, size_t size,
352 int flags);
353void tcp_release_cb(struct sock *sk);
354void tcp_wfree(struct sk_buff *skb);
355void tcp_write_timer_handler(struct sock *sk);
356void tcp_delack_timer_handler(struct sock *sk);
357int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg);
358int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
359 const struct tcphdr *th, unsigned int len);
360void tcp_rcv_established(struct sock *sk, struct sk_buff *skb,
361 const struct tcphdr *th, unsigned int len);
362void tcp_rcv_space_adjust(struct sock *sk);
5c9f3023
JP
363int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
364void tcp_twsk_destructor(struct sock *sk);
365ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
366 struct pipe_inode_info *pipe, size_t len,
367 unsigned int flags);
9c55e01c 368
463c84b9
ACM
369static inline void tcp_dec_quickack_mode(struct sock *sk,
370 const unsigned int pkts)
1da177e4 371{
463c84b9 372 struct inet_connection_sock *icsk = inet_csk(sk);
fc6415bc 373
463c84b9
ACM
374 if (icsk->icsk_ack.quick) {
375 if (pkts >= icsk->icsk_ack.quick) {
376 icsk->icsk_ack.quick = 0;
fc6415bc 377 /* Leaving quickack mode we deflate ATO. */
463c84b9 378 icsk->icsk_ack.ato = TCP_ATO_MIN;
fc6415bc 379 } else
463c84b9 380 icsk->icsk_ack.quick -= pkts;
1da177e4
LT
381 }
382}
383
bdf1ee5d
IJ
384#define TCP_ECN_OK 1
385#define TCP_ECN_QUEUE_CWR 2
386#define TCP_ECN_DEMAND_CWR 4
7a269ffa 387#define TCP_ECN_SEEN 8
bdf1ee5d 388
fd2c3ef7 389enum tcp_tw_status {
1da177e4
LT
390 TCP_TW_SUCCESS = 0,
391 TCP_TW_RST = 1,
392 TCP_TW_ACK = 2,
393 TCP_TW_SYN = 3
394};
395
396
5c9f3023
JP
397enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
398 struct sk_buff *skb,
399 const struct tcphdr *th);
400struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
52452c54 401 struct request_sock *req, bool fastopen);
5c9f3023
JP
402int tcp_child_process(struct sock *parent, struct sock *child,
403 struct sk_buff *skb);
5ae344c9 404void tcp_enter_loss(struct sock *sk);
5c9f3023
JP
405void tcp_clear_retrans(struct tcp_sock *tp);
406void tcp_update_metrics(struct sock *sk);
407void tcp_init_metrics(struct sock *sk);
408void tcp_metrics_init(void);
409bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst,
a26552af 410 bool paws_check, bool timestamps);
5c9f3023
JP
411bool tcp_remember_stamp(struct sock *sk);
412bool tcp_tw_remember_stamp(struct inet_timewait_sock *tw);
413void tcp_fetch_timewait_stamp(struct sock *sk, struct dst_entry *dst);
414void tcp_disable_fack(struct tcp_sock *tp);
415void tcp_close(struct sock *sk, long timeout);
416void tcp_init_sock(struct sock *sk);
417unsigned int tcp_poll(struct file *file, struct socket *sock,
418 struct poll_table_struct *wait);
419int tcp_getsockopt(struct sock *sk, int level, int optname,
420 char __user *optval, int __user *optlen);
421int tcp_setsockopt(struct sock *sk, int level, int optname,
422 char __user *optval, unsigned int optlen);
423int compat_tcp_getsockopt(struct sock *sk, int level, int optname,
53d3176b 424 char __user *optval, int __user *optlen);
5c9f3023 425int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
53d3176b 426 char __user *optval, unsigned int optlen);
5c9f3023 427void tcp_set_keepalive(struct sock *sk, int val);
42cb80a2 428void tcp_syn_ack_timeout(const struct request_sock *req);
1b784140
YX
429int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int nonblock,
430 int flags, int *addr_len);
5c9f3023
JP
431void tcp_parse_options(const struct sk_buff *skb,
432 struct tcp_options_received *opt_rx,
433 int estab, struct tcp_fastopen_cookie *foc);
434const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
7d5d5525 435
1da177e4
LT
436/*
437 * TCP v4 functions exported for the inet6 API
438 */
439
5c9f3023 440void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
4fab9071 441void tcp_v4_mtu_reduced(struct sock *sk);
26e37360 442void tcp_req_err(struct sock *sk, u32 seq);
5c9f3023
JP
443int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
444struct sock *tcp_create_openreq_child(struct sock *sk,
445 struct request_sock *req,
446 struct sk_buff *skb);
81164413 447void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
5c9f3023
JP
448struct sock *tcp_v4_syn_recv_sock(struct sock *sk, struct sk_buff *skb,
449 struct request_sock *req,
450 struct dst_entry *dst);
451int 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);
454struct sk_buff *tcp_make_synack(struct sock *sk, struct dst_entry *dst,
455 struct request_sock *req,
456 struct tcp_fastopen_cookie *foc);
457int tcp_disconnect(struct sock *sk, int flags);
1da177e4 458
370816ae 459void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
292e8d8c 460int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
63d02d15 461void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
1da177e4 462
1da177e4 463/* From syncookies.c */
5c9f3023
JP
464int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
465 u32 cookie);
461b74c3 466struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
e05c82d3 467#ifdef CONFIG_SYN_COOKIES
8c27bd75 468
63262315 469/* Syncookies use a monotonic timer which increments every 60 seconds.
8c27bd75
FW
470 * This counter is used both as a hash input and partially encoded into
471 * the cookie value. A cookie is only validated further if the delta
472 * between the current counter value and the encoded one is less than this,
63262315 473 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
8c27bd75
FW
474 * the counter advances immediately after a cookie is generated).
475 */
264ea103
ED
476#define MAX_SYNCOOKIE_AGE 2
477#define TCP_SYNCOOKIE_PERIOD (60 * HZ)
478#define TCP_SYNCOOKIE_VALID (MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)
479
480/* syncookies: remember time of last synqueue overflow
481 * But do not dirty this field too often (once per second is enough)
482 */
483static inline void tcp_synq_overflow(struct sock *sk)
484{
485 unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
486 unsigned long now = jiffies;
487
488 if (time_after(now, last_overflow + HZ))
489 tcp_sk(sk)->rx_opt.ts_recent_stamp = now;
490}
491
492/* syncookies: no recent synqueue overflow on this listening socket? */
493static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
494{
495 unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
496
497 return time_after(jiffies, last_overflow + TCP_SYNCOOKIE_VALID);
498}
8c27bd75
FW
499
500static inline u32 tcp_cookie_time(void)
501{
63262315
ED
502 u64 val = get_jiffies_64();
503
264ea103 504 do_div(val, TCP_SYNCOOKIE_PERIOD);
63262315 505 return val;
8c27bd75
FW
506}
507
5c9f3023
JP
508u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
509 u16 *mssp);
57b47553
OP
510__u32 cookie_v4_init_sequence(struct sock *sk, const struct sk_buff *skb,
511 __u16 *mss);
5c9f3023 512__u32 cookie_init_timestamp(struct request_sock *req);
f1673381
FW
513bool cookie_timestamp_decode(struct tcp_options_received *opt);
514bool cookie_ecn_ok(const struct tcp_options_received *opt,
f7b3bec6 515 const struct net *net, const struct dst_entry *dst);
4dfc2817 516
c6aefafb 517/* From net/ipv6/syncookies.c */
5c9f3023
JP
518int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th,
519 u32 cookie);
520struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
f1673381 521
5c9f3023
JP
522u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
523 const struct tcphdr *th, u16 *mssp);
524__u32 cookie_v6_init_sequence(struct sock *sk, const struct sk_buff *skb,
525 __u16 *mss);
e05c82d3 526#endif
1da177e4
LT
527/* tcp_output.c */
528
5c9f3023
JP
529void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
530 int nonagle);
531bool tcp_may_send_now(struct sock *sk);
532int __tcp_retransmit_skb(struct sock *, struct sk_buff *);
533int tcp_retransmit_skb(struct sock *, struct sk_buff *);
534void tcp_retransmit_timer(struct sock *sk);
535void tcp_xmit_retransmit_queue(struct sock *);
536void tcp_simple_retransmit(struct sock *);
537int tcp_trim_head(struct sock *, struct sk_buff *, u32);
6cc55e09 538int tcp_fragment(struct sock *, struct sk_buff *, u32, unsigned int, gfp_t);
5c9f3023
JP
539
540void tcp_send_probe0(struct sock *);
541void tcp_send_partial(struct sock *);
e520af48 542int tcp_write_wakeup(struct sock *, int mib);
5c9f3023
JP
543void tcp_send_fin(struct sock *sk);
544void tcp_send_active_reset(struct sock *sk, gfp_t priority);
545int tcp_send_synack(struct sock *);
5c9f3023
JP
546void tcp_push_one(struct sock *, unsigned int mss_now);
547void tcp_send_ack(struct sock *sk);
548void tcp_send_delayed_ack(struct sock *sk);
549void tcp_send_loss_probe(struct sock *sk);
550bool tcp_schedule_loss_probe(struct sock *sk);
1da177e4 551
a762a980 552/* tcp_input.c */
5c9f3023
JP
553void tcp_resume_early_retransmit(struct sock *sk);
554void tcp_rearm_rto(struct sock *sk);
555void tcp_reset(struct sock *sk);
a762a980 556
1da177e4 557/* tcp_timer.c */
5c9f3023 558void tcp_init_xmit_timers(struct sock *);
463c84b9
ACM
559static inline void tcp_clear_xmit_timers(struct sock *sk)
560{
561 inet_csk_clear_xmit_timers(sk);
562}
1da177e4 563
5c9f3023
JP
564unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
565unsigned int tcp_current_mss(struct sock *sk);
0c54b85f
IJ
566
567/* Bound MSS / TSO packet size with the half of the window */
568static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
569{
01f83d69
AK
570 int cutoff;
571
572 /* When peer uses tiny windows, there is no use in packetizing
573 * to sub-MSS pieces for the sake of SWS or making sure there
574 * are enough packets in the pipe for fast recovery.
575 *
576 * On the other hand, for extremely large MSS devices, handling
577 * smaller than MSS windows in this way does make sense.
578 */
579 if (tp->max_window >= 512)
580 cutoff = (tp->max_window >> 1);
581 else
582 cutoff = tp->max_window;
583
584 if (cutoff && pktsize > cutoff)
585 return max_t(int, cutoff, 68U - tp->tcp_header_len);
0c54b85f
IJ
586 else
587 return pktsize;
588}
1da177e4 589
17b085ea 590/* tcp.c */
0df48c26 591void tcp_get_info(struct sock *, struct tcp_info *);
1da177e4
LT
592
593/* Read 'sendfile()'-style from a TCP socket */
594typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
595 unsigned int, size_t);
5c9f3023
JP
596int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
597 sk_read_actor_t recv_actor);
1da177e4 598
5c9f3023 599void tcp_initialize_rcv_mss(struct sock *sk);
1da177e4 600
5c9f3023
JP
601int tcp_mtu_to_mss(struct sock *sk, int pmtu);
602int tcp_mss_to_mtu(struct sock *sk, int mss);
603void tcp_mtup_init(struct sock *sk);
604void tcp_init_buffer_space(struct sock *sk);
5d424d5a 605
f1ecd5d9
DL
606static inline void tcp_bound_rto(const struct sock *sk)
607{
608 if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
609 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
610}
611
612static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
613{
740b0f18 614 return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
f1ecd5d9
DL
615}
616
40efc6fa 617static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
1da177e4
LT
618{
619 tp->pred_flags = htonl((tp->tcp_header_len << 26) |
620 ntohl(TCP_FLAG_ACK) |
621 snd_wnd);
622}
623
40efc6fa 624static inline void tcp_fast_path_on(struct tcp_sock *tp)
1da177e4
LT
625{
626 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
627}
628
9e412ba7 629static inline void tcp_fast_path_check(struct sock *sk)
1da177e4 630{
9e412ba7
IJ
631 struct tcp_sock *tp = tcp_sk(sk);
632
b03efcfb 633 if (skb_queue_empty(&tp->out_of_order_queue) &&
1da177e4
LT
634 tp->rcv_wnd &&
635 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
636 !tp->urg_data)
637 tcp_fast_path_on(tp);
638}
639
0c266898
SS
640/* Compute the actual rto_min value */
641static inline u32 tcp_rto_min(struct sock *sk)
642{
cf533ea5 643 const struct dst_entry *dst = __sk_dst_get(sk);
0c266898
SS
644 u32 rto_min = TCP_RTO_MIN;
645
646 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
647 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
648 return rto_min;
649}
650
740b0f18
ED
651static inline u32 tcp_rto_min_us(struct sock *sk)
652{
653 return jiffies_to_usecs(tcp_rto_min(sk));
654}
655
81164413
DB
656static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
657{
658 return dst_metric_locked(dst, RTAX_CC_ALGO);
659}
660
1da177e4
LT
661/* Compute the actual receive window we are currently advertising.
662 * Rcv_nxt can be after the window if our peer push more data
663 * than the offered window.
664 */
40efc6fa 665static inline u32 tcp_receive_window(const struct tcp_sock *tp)
1da177e4
LT
666{
667 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
668
669 if (win < 0)
670 win = 0;
671 return (u32) win;
672}
673
674/* Choose a new window, without checks for shrinking, and without
675 * scaling applied to the result. The caller does these things
676 * if necessary. This is a "raw" window selection.
677 */
5c9f3023 678u32 __tcp_select_window(struct sock *sk);
1da177e4 679
ee995283
PE
680void tcp_send_window_probe(struct sock *sk);
681
1da177e4
LT
682/* TCP timestamps are only 32-bits, this causes a slight
683 * complication on 64-bit systems since we store a snapshot
31f34269
SH
684 * of jiffies in the buffer control blocks below. We decided
685 * to use only the low 32-bits of jiffies and hide the ugly
1da177e4
LT
686 * casts with the following macro.
687 */
688#define tcp_time_stamp ((__u32)(jiffies))
689
7faee5c0
ED
690static inline u32 tcp_skb_timestamp(const struct sk_buff *skb)
691{
692 return skb->skb_mstamp.stamp_jiffies;
693}
694
695
a3433f35
CG
696#define tcp_flag_byte(th) (((u_int8_t *)th)[13])
697
698#define TCPHDR_FIN 0x01
699#define TCPHDR_SYN 0x02
700#define TCPHDR_RST 0x04
701#define TCPHDR_PSH 0x08
702#define TCPHDR_ACK 0x10
703#define TCPHDR_URG 0x20
704#define TCPHDR_ECE 0x40
705#define TCPHDR_CWR 0x80
706
caa20d9a 707/* This is what the send packet queuing engine uses to pass
f86586fa
ED
708 * TCP per-packet control information to the transmission code.
709 * We also store the host-order sequence numbers in here too.
710 * This is 44 bytes if IPV6 is enabled.
711 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
1da177e4
LT
712 */
713struct tcp_skb_cb {
1da177e4
LT
714 __u32 seq; /* Starting sequence number */
715 __u32 end_seq; /* SEQ + FIN + SYN + datalen */
cd7d8498
ED
716 union {
717 /* Note : tcp_tw_isn is used in input path only
718 * (isn chosen by tcp_timewait_state_process())
719 *
720 * tcp_gso_segs is used in write queue only,
721 * cf tcp_skb_pcount()
722 */
723 __u32 tcp_tw_isn;
724 __u32 tcp_gso_segs;
725 };
4de075e0 726 __u8 tcp_flags; /* TCP header flags. (tcp[13]) */
f4f9f6e7 727
1da177e4
LT
728 __u8 sacked; /* State flags for SACK/FACK. */
729#define TCPCB_SACKED_ACKED 0x01 /* SKB ACK'd by a SACK block */
730#define TCPCB_SACKED_RETRANS 0x02 /* SKB retransmitted */
731#define TCPCB_LOST 0x04 /* SKB is lost */
732#define TCPCB_TAGBITS 0x07 /* All tag bits */
9d186cac 733#define TCPCB_REPAIRED 0x10 /* SKB repaired (no skb_mstamp) */
1da177e4 734#define TCPCB_EVER_RETRANS 0x80 /* Ever retransmitted frame */
9d186cac
AV
735#define TCPCB_RETRANS (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
736 TCPCB_REPAIRED)
1da177e4 737
f4f9f6e7
NC
738 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */
739 /* 1 byte hole */
1da177e4 740 __u32 ack_seq; /* Sequence number ACK'd */
971f10ec
ED
741 union {
742 struct inet_skb_parm h4;
743#if IS_ENABLED(CONFIG_IPV6)
744 struct inet6_skb_parm h6;
745#endif
746 } header; /* For incoming frames */
1da177e4
LT
747};
748
749#define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0]))
750
870c3151 751
815afe17 752#if IS_ENABLED(CONFIG_IPV6)
870c3151
ED
753/* This is the variant of inet6_iif() that must be used by TCP,
754 * as TCP moves IP6CB into a different location in skb->cb[]
755 */
756static inline int tcp_v6_iif(const struct sk_buff *skb)
757{
758 return TCP_SKB_CB(skb)->header.h6.iif;
759}
815afe17 760#endif
870c3151 761
1da177e4
LT
762/* Due to TSO, an SKB can be composed of multiple actual
763 * packets. To keep these tracked properly, we use this.
bd14b1b2 764 */
1da177e4 765static inline int tcp_skb_pcount(const struct sk_buff *skb)
bd14b1b2 766{
cd7d8498
ED
767 return TCP_SKB_CB(skb)->tcp_gso_segs;
768}
bd14b1b2 769
cd7d8498
ED
770static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
771{
772 TCP_SKB_CB(skb)->tcp_gso_segs = segs;
bd14b1b2
ED
773}
774
cd7d8498 775static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
1da177e4 776{
cd7d8498 777 TCP_SKB_CB(skb)->tcp_gso_segs += segs;
1da177e4
LT
778}
779
780/* This is valid iff tcp_skb_pcount() > 1. */
781static inline int tcp_skb_mss(const struct sk_buff *skb)
782{
7967168c 783 return skb_shinfo(skb)->gso_size;
1da177e4
LT
784}
785
317a76f9
SH
786/* Events passed to congestion control interface */
787enum tcp_ca_event {
788 CA_EVENT_TX_START, /* first transmit when no packets in flight */
789 CA_EVENT_CWND_RESTART, /* congestion window restart */
790 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */
317a76f9 791 CA_EVENT_LOSS, /* loss timeout */
9890092e
FW
792 CA_EVENT_ECN_NO_CE, /* ECT set, but not CE marked */
793 CA_EVENT_ECN_IS_CE, /* received CE marked IP packet */
794 CA_EVENT_DELAYED_ACK, /* Delayed ack is sent */
795 CA_EVENT_NON_DELAYED_ACK,
7354c8c3
FW
796};
797
9890092e 798/* Information about inbound ACK, passed to cong_ops->in_ack_event() */
7354c8c3 799enum tcp_ca_ack_event_flags {
9890092e
FW
800 CA_ACK_SLOWPATH = (1 << 0), /* In slow path processing */
801 CA_ACK_WIN_UPDATE = (1 << 1), /* ACK updated window */
802 CA_ACK_ECE = (1 << 2), /* ECE bit is set on ack */
317a76f9
SH
803};
804
805/*
806 * Interface for adding new TCP congestion control handlers
807 */
808#define TCP_CA_NAME_MAX 16
3ff825b2
SH
809#define TCP_CA_MAX 128
810#define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX)
811
c5c6a8ab
DB
812#define TCP_CA_UNSPEC 0
813
30e502a3 814/* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
164891aa 815#define TCP_CONG_NON_RESTRICTED 0x1
30e502a3
DB
816/* Requires ECN/ECT set on all packets */
817#define TCP_CONG_NEEDS_ECN 0x2
164891aa 818
64f40ff5
ED
819union tcp_cc_info;
820
317a76f9
SH
821struct tcp_congestion_ops {
822 struct list_head list;
c5c6a8ab
DB
823 u32 key;
824 u32 flags;
317a76f9
SH
825
826 /* initialize private data (optional) */
6687e988 827 void (*init)(struct sock *sk);
317a76f9 828 /* cleanup private data (optional) */
6687e988 829 void (*release)(struct sock *sk);
317a76f9
SH
830
831 /* return slow start threshold (required) */
6687e988 832 u32 (*ssthresh)(struct sock *sk);
317a76f9 833 /* do new cwnd calculation (required) */
24901551 834 void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
317a76f9 835 /* call before changing ca_state (optional) */
6687e988 836 void (*set_state)(struct sock *sk, u8 new_state);
317a76f9 837 /* call when cwnd event occurs (optional) */
6687e988 838 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
7354c8c3
FW
839 /* call when ack arrives (optional) */
840 void (*in_ack_event)(struct sock *sk, u32 flags);
317a76f9 841 /* new value of cwnd after loss (optional) */
6687e988 842 u32 (*undo_cwnd)(struct sock *sk);
317a76f9 843 /* hook for packet ack accounting (optional) */
30cfd0ba 844 void (*pkts_acked)(struct sock *sk, u32 num_acked, s32 rtt_us);
73c1f4a0 845 /* get info for inet_diag (optional) */
64f40ff5
ED
846 size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
847 union tcp_cc_info *info);
317a76f9
SH
848
849 char name[TCP_CA_NAME_MAX];
850 struct module *owner;
851};
852
5c9f3023
JP
853int tcp_register_congestion_control(struct tcp_congestion_ops *type);
854void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
317a76f9 855
55d8694f 856void tcp_assign_congestion_control(struct sock *sk);
5c9f3023
JP
857void tcp_init_congestion_control(struct sock *sk);
858void tcp_cleanup_congestion_control(struct sock *sk);
859int tcp_set_default_congestion_control(const char *name);
860void tcp_get_default_congestion_control(char *name);
861void tcp_get_available_congestion_control(char *buf, size_t len);
862void tcp_get_allowed_congestion_control(char *buf, size_t len);
863int tcp_set_allowed_congestion_control(char *allowed);
864int tcp_set_congestion_control(struct sock *sk, const char *name);
e73ebb08
NC
865u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
866void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
317a76f9 867
5c9f3023 868u32 tcp_reno_ssthresh(struct sock *sk);
24901551 869void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
a8acfbac 870extern struct tcp_congestion_ops tcp_reno;
317a76f9 871
c5c6a8ab
DB
872struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
873u32 tcp_ca_get_key_by_name(const char *name);
ea697639 874#ifdef CONFIG_INET
c5c6a8ab 875char *tcp_ca_get_name_by_key(u32 key, char *buffer);
ea697639
DB
876#else
877static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
878{
879 return NULL;
880}
881#endif
c5c6a8ab 882
30e502a3
DB
883static inline bool tcp_ca_needs_ecn(const struct sock *sk)
884{
885 const struct inet_connection_sock *icsk = inet_csk(sk);
886
887 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
888}
889
6687e988 890static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
317a76f9 891{
6687e988
ACM
892 struct inet_connection_sock *icsk = inet_csk(sk);
893
894 if (icsk->icsk_ca_ops->set_state)
895 icsk->icsk_ca_ops->set_state(sk, ca_state);
896 icsk->icsk_ca_state = ca_state;
317a76f9
SH
897}
898
6687e988 899static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
317a76f9 900{
6687e988
ACM
901 const struct inet_connection_sock *icsk = inet_csk(sk);
902
903 if (icsk->icsk_ca_ops->cwnd_event)
904 icsk->icsk_ca_ops->cwnd_event(sk, event);
317a76f9
SH
905}
906
e60402d0
IJ
907/* These functions determine how the current flow behaves in respect of SACK
908 * handling. SACK is negotiated with the peer, and therefore it can vary
909 * between different flows.
910 *
911 * tcp_is_sack - SACK enabled
912 * tcp_is_reno - No SACK
913 * tcp_is_fack - FACK enabled, implies SACK enabled
914 */
915static inline int tcp_is_sack(const struct tcp_sock *tp)
916{
917 return tp->rx_opt.sack_ok;
918}
919
a2a385d6 920static inline bool tcp_is_reno(const struct tcp_sock *tp)
e60402d0
IJ
921{
922 return !tcp_is_sack(tp);
923}
924
a2a385d6 925static inline bool tcp_is_fack(const struct tcp_sock *tp)
e60402d0 926{
ab56222a 927 return tp->rx_opt.sack_ok & TCP_FACK_ENABLED;
e60402d0
IJ
928}
929
930static inline void tcp_enable_fack(struct tcp_sock *tp)
931{
ab56222a 932 tp->rx_opt.sack_ok |= TCP_FACK_ENABLED;
e60402d0
IJ
933}
934
eed530b6
YC
935/* TCP early-retransmit (ER) is similar to but more conservative than
936 * the thin-dupack feature. Enable ER only if thin-dupack is disabled.
937 */
938static inline void tcp_enable_early_retrans(struct tcp_sock *tp)
939{
940 tp->do_early_retrans = sysctl_tcp_early_retrans &&
6ba8a3b1
ND
941 sysctl_tcp_early_retrans < 4 && !sysctl_tcp_thin_dupack &&
942 sysctl_tcp_reordering == 3;
eed530b6
YC
943}
944
945static inline void tcp_disable_early_retrans(struct tcp_sock *tp)
946{
947 tp->do_early_retrans = 0;
948}
949
83ae4088
IJ
950static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
951{
952 return tp->sacked_out + tp->lost_out;
953}
954
1da177e4
LT
955/* This determines how many packets are "in the network" to the best
956 * of our knowledge. In many cases it is conservative, but where
957 * detailed information is available from the receiver (via SACK
958 * blocks etc.) we can make more aggressive calculations.
959 *
960 * Use this for decisions involving congestion control, use just
961 * tp->packets_out to determine if the send queue is empty or not.
962 *
963 * Read this equation as:
964 *
965 * "Packets sent once on transmission queue" MINUS
966 * "Packets left network, but not honestly ACKed yet" PLUS
967 * "Packets fast retransmitted"
968 */
40efc6fa 969static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
1da177e4 970{
83ae4088 971 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
1da177e4
LT
972}
973
0b6a05c1
IJ
974#define TCP_INFINITE_SSTHRESH 0x7fffffff
975
976static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
977{
978 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
979}
980
684bad11
YC
981static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
982{
983 return (TCPF_CA_CWR | TCPF_CA_Recovery) &
984 (1 << inet_csk(sk)->icsk_ca_state);
985}
986
1da177e4 987/* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
684bad11 988 * The exception is cwnd reduction phase, when cwnd is decreasing towards
1da177e4
LT
989 * ssthresh.
990 */
6687e988 991static inline __u32 tcp_current_ssthresh(const struct sock *sk)
1da177e4 992{
6687e988 993 const struct tcp_sock *tp = tcp_sk(sk);
cf533ea5 994
684bad11 995 if (tcp_in_cwnd_reduction(sk))
1da177e4
LT
996 return tp->snd_ssthresh;
997 else
998 return max(tp->snd_ssthresh,
999 ((tp->snd_cwnd >> 1) +
1000 (tp->snd_cwnd >> 2)));
1001}
1002
b9c4595b
IJ
1003/* Use define here intentionally to get WARN_ON location shown at the caller */
1004#define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
1da177e4 1005
5ee2c941 1006void tcp_enter_cwr(struct sock *sk);
5c9f3023 1007__u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
1da177e4 1008
6b5a5c0d
NC
1009/* The maximum number of MSS of available cwnd for which TSO defers
1010 * sending if not using sysctl_tcp_tso_win_divisor.
1011 */
1012static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1013{
1014 return 3;
1015}
1016
1da177e4 1017/* Slow start with delack produces 3 packets of burst, so that
dd9e0dda
JH
1018 * it is safe "de facto". This will be the default - same as
1019 * the default reordering threshold - but if reordering increases,
1020 * we must be able to allow cwnd to burst at least this much in order
1021 * to not pull it back when holes are filled.
1da177e4
LT
1022 */
1023static __inline__ __u32 tcp_max_burst(const struct tcp_sock *tp)
1024{
dd9e0dda 1025 return tp->reordering;
1da177e4
LT
1026}
1027
90840def
IJ
1028/* Returns end sequence number of the receiver's advertised window */
1029static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1030{
1031 return tp->snd_una + tp->snd_wnd;
1032}
e114a710
ED
1033
1034/* We follow the spirit of RFC2861 to validate cwnd but implement a more
1035 * flexible approach. The RFC suggests cwnd should not be raised unless
ca8a2263
NC
1036 * it was fully used previously. And that's exactly what we do in
1037 * congestion avoidance mode. But in slow start we allow cwnd to grow
1038 * as long as the application has used half the cwnd.
e114a710
ED
1039 * Example :
1040 * cwnd is 10 (IW10), but application sends 9 frames.
1041 * We allow cwnd to reach 18 when all frames are ACKed.
1042 * This check is safe because it's as aggressive as slow start which already
1043 * risks 100% overshoot. The advantage is that we discourage application to
1044 * either send more filler packets or data to artificially blow up the cwnd
1045 * usage, and allow application-limited process to probe bw more aggressively.
e114a710 1046 */
24901551 1047static inline bool tcp_is_cwnd_limited(const struct sock *sk)
e114a710
ED
1048{
1049 const struct tcp_sock *tp = tcp_sk(sk);
1050
ca8a2263
NC
1051 /* If in slow start, ensure cwnd grows to twice what was ACKed. */
1052 if (tp->snd_cwnd <= tp->snd_ssthresh)
1053 return tp->snd_cwnd < 2 * tp->max_packets_out;
1054
1055 return tp->is_cwnd_limited;
e114a710 1056}
f4805ede 1057
21c8fe99
ED
1058/* Something is really bad, we could not queue an additional packet,
1059 * because qdisc is full or receiver sent a 0 window.
1060 * We do not want to add fuel to the fire, or abort too early,
1061 * so make sure the timer we arm now is at least 200ms in the future,
1062 * regardless of current icsk_rto value (as it could be ~2ms)
1063 */
1064static inline unsigned long tcp_probe0_base(const struct sock *sk)
1da177e4 1065{
21c8fe99
ED
1066 return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1067}
9e412ba7 1068
21c8fe99
ED
1069/* Variant of inet_csk_rto_backoff() used for zero window probes */
1070static inline unsigned long tcp_probe0_when(const struct sock *sk,
1071 unsigned long max_when)
1072{
1073 u64 when = (u64)tcp_probe0_base(sk) << inet_csk(sk)->icsk_backoff;
1074
1075 return (unsigned long)min_t(u64, when, max_when);
1076}
1077
1078static inline void tcp_check_probe_timer(struct sock *sk)
1079{
1080 if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
3f421baa 1081 inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
21c8fe99 1082 tcp_probe0_base(sk), TCP_RTO_MAX);
1da177e4
LT
1083}
1084
ee7537b6 1085static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1086{
1087 tp->snd_wl1 = seq;
1088}
1089
ee7537b6 1090static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1091{
1092 tp->snd_wl1 = seq;
1093}
1094
1da177e4
LT
1095/*
1096 * Calculate(/check) TCP checksum
1097 */
ba7808ea
FD
1098static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1099 __be32 daddr, __wsum base)
1da177e4
LT
1100{
1101 return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
1102}
1103
b51655b9 1104static inline __sum16 __tcp_checksum_complete(struct sk_buff *skb)
1da177e4 1105{
fb286bb2 1106 return __skb_checksum_complete(skb);
1da177e4
LT
1107}
1108
a2a385d6 1109static inline bool tcp_checksum_complete(struct sk_buff *skb)
1da177e4 1110{
60476372 1111 return !skb_csum_unnecessary(skb) &&
1da177e4
LT
1112 __tcp_checksum_complete(skb);
1113}
1114
1115/* Prequeue for VJ style copy to user, combined with checksumming. */
1116
40efc6fa 1117static inline void tcp_prequeue_init(struct tcp_sock *tp)
1da177e4
LT
1118{
1119 tp->ucopy.task = NULL;
1120 tp->ucopy.len = 0;
1121 tp->ucopy.memory = 0;
1122 skb_queue_head_init(&tp->ucopy.prequeue);
1123}
1124
5c9f3023 1125bool tcp_prequeue(struct sock *sk, struct sk_buff *skb);
1da177e4
LT
1126
1127#undef STATE_TRACE
1128
1129#ifdef STATE_TRACE
1130static const char *statename[]={
1131 "Unused","Established","Syn Sent","Syn Recv",
1132 "Fin Wait 1","Fin Wait 2","Time Wait", "Close",
1133 "Close Wait","Last ACK","Listen","Closing"
1134};
1135#endif
5c9f3023 1136void tcp_set_state(struct sock *sk, int state);
1da177e4 1137
5c9f3023 1138void tcp_done(struct sock *sk);
1da177e4 1139
40efc6fa 1140static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1da177e4
LT
1141{
1142 rx_opt->dsack = 0;
1da177e4
LT
1143 rx_opt->num_sacks = 0;
1144}
1145
5c9f3023 1146u32 tcp_default_init_rwnd(u32 mss);
85f16525 1147
1da177e4 1148/* Determine a window scaling and initial window to offer. */
5c9f3023
JP
1149void tcp_select_initial_window(int __space, __u32 mss, __u32 *rcv_wnd,
1150 __u32 *window_clamp, int wscale_ok,
1151 __u8 *rcv_wscale, __u32 init_rcv_wnd);
1da177e4
LT
1152
1153static inline int tcp_win_from_space(int space)
1154{
1155 return sysctl_tcp_adv_win_scale<=0 ?
1156 (space>>(-sysctl_tcp_adv_win_scale)) :
1157 space - (space>>sysctl_tcp_adv_win_scale);
1158}
1159
105970f6 1160/* Note: caller must be prepared to deal with negative returns */
1da177e4
LT
1161static inline int tcp_space(const struct sock *sk)
1162{
1163 return tcp_win_from_space(sk->sk_rcvbuf -
1164 atomic_read(&sk->sk_rmem_alloc));
105970f6 1165}
1da177e4
LT
1166
1167static inline int tcp_full_space(const struct sock *sk)
1168{
105970f6 1169 return tcp_win_from_space(sk->sk_rcvbuf);
1da177e4
LT
1170}
1171
843f4a55
YC
1172extern void tcp_openreq_init_rwin(struct request_sock *req,
1173 struct sock *sk, struct dst_entry *dst);
1174
5c9f3023 1175void tcp_enter_memory_pressure(struct sock *sk);
1da177e4 1176
1da177e4
LT
1177static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1178{
1179 return tp->keepalive_intvl ? : sysctl_tcp_keepalive_intvl;
1180}
1181
1182static inline int keepalive_time_when(const struct tcp_sock *tp)
1183{
1184 return tp->keepalive_time ? : sysctl_tcp_keepalive_time;
1185}
1186
df19a626
ED
1187static inline int keepalive_probes(const struct tcp_sock *tp)
1188{
1189 return tp->keepalive_probes ? : sysctl_tcp_keepalive_probes;
1190}
1191
6c37e5de
FL
1192static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1193{
1194 const struct inet_connection_sock *icsk = &tp->inet_conn;
1195
1196 return min_t(u32, tcp_time_stamp - icsk->icsk_ack.lrcvtime,
1197 tcp_time_stamp - tp->rcv_tstamp);
1198}
1199
463c84b9 1200static inline int tcp_fin_time(const struct sock *sk)
1da177e4 1201{
463c84b9
ACM
1202 int fin_timeout = tcp_sk(sk)->linger2 ? : sysctl_tcp_fin_timeout;
1203 const int rto = inet_csk(sk)->icsk_rto;
1da177e4 1204
463c84b9
ACM
1205 if (fin_timeout < (rto << 2) - (rto >> 1))
1206 fin_timeout = (rto << 2) - (rto >> 1);
1da177e4
LT
1207
1208 return fin_timeout;
1209}
1210
a2a385d6
ED
1211static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1212 int paws_win)
1da177e4 1213{
c887e6d2 1214 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
a2a385d6 1215 return true;
c887e6d2 1216 if (unlikely(get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS))
a2a385d6 1217 return true;
bc2ce894
ED
1218 /*
1219 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1220 * then following tcp messages have valid values. Ignore 0 value,
1221 * or else 'negative' tsval might forbid us to accept their packets.
1222 */
1223 if (!rx_opt->ts_recent)
a2a385d6
ED
1224 return true;
1225 return false;
c887e6d2
IJ
1226}
1227
a2a385d6
ED
1228static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1229 int rst)
c887e6d2
IJ
1230{
1231 if (tcp_paws_check(rx_opt, 0))
a2a385d6 1232 return false;
1da177e4
LT
1233
1234 /* RST segments are not recommended to carry timestamp,
1235 and, if they do, it is recommended to ignore PAWS because
1236 "their cleanup function should take precedence over timestamps."
1237 Certainly, it is mistake. It is necessary to understand the reasons
1238 of this constraint to relax it: if peer reboots, clock may go
1239 out-of-sync and half-open connections will not be reset.
1240 Actually, the problem would be not existing if all
1241 the implementations followed draft about maintaining clock
1242 via reboots. Linux-2.2 DOES NOT!
1243
1244 However, we can relax time bounds for RST segments to MSL.
1245 */
9d729f72 1246 if (rst && get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
a2a385d6
ED
1247 return false;
1248 return true;
1da177e4
LT
1249}
1250
7970ddc8
ED
1251bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
1252 int mib_idx, u32 *last_oow_ack_time);
032ee423 1253
a9c19329 1254static inline void tcp_mib_init(struct net *net)
1da177e4
LT
1255{
1256 /* See RFC 2012 */
cf1100a7
PE
1257 TCP_ADD_STATS_USER(net, TCP_MIB_RTOALGORITHM, 1);
1258 TCP_ADD_STATS_USER(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1259 TCP_ADD_STATS_USER(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1260 TCP_ADD_STATS_USER(net, TCP_MIB_MAXCONN, -1);
1da177e4
LT
1261}
1262
5af4ec23 1263/* from STCP */
ef9da47c 1264static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
0800f170 1265{
6a438bbe 1266 tp->lost_skb_hint = NULL;
ef9da47c
IJ
1267}
1268
1269static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1270{
1271 tcp_clear_retrans_hints_partial(tp);
6a438bbe 1272 tp->retransmit_skb_hint = NULL;
b7689205
IJ
1273}
1274
cfb6eeb4
YH
1275/* MD5 Signature */
1276struct crypto_hash;
1277
a915da9b
ED
1278union tcp_md5_addr {
1279 struct in_addr a4;
1280#if IS_ENABLED(CONFIG_IPV6)
1281 struct in6_addr a6;
1282#endif
1283};
1284
cfb6eeb4
YH
1285/* - key database */
1286struct tcp_md5sig_key {
a915da9b 1287 struct hlist_node node;
cfb6eeb4 1288 u8 keylen;
a915da9b
ED
1289 u8 family; /* AF_INET or AF_INET6 */
1290 union tcp_md5_addr addr;
1291 u8 key[TCP_MD5SIG_MAXKEYLEN];
1292 struct rcu_head rcu;
cfb6eeb4
YH
1293};
1294
1295/* - sock block */
1296struct tcp_md5sig_info {
a915da9b 1297 struct hlist_head head;
a8afca03 1298 struct rcu_head rcu;
cfb6eeb4
YH
1299};
1300
1301/* - pseudo header */
1302struct tcp4_pseudohdr {
1303 __be32 saddr;
1304 __be32 daddr;
1305 __u8 pad;
1306 __u8 protocol;
1307 __be16 len;
1308};
1309
1310struct tcp6_pseudohdr {
1311 struct in6_addr saddr;
1312 struct in6_addr daddr;
1313 __be32 len;
1314 __be32 protocol; /* including padding */
1315};
1316
1317union tcp_md5sum_block {
1318 struct tcp4_pseudohdr ip4;
dfd56b8b 1319#if IS_ENABLED(CONFIG_IPV6)
cfb6eeb4
YH
1320 struct tcp6_pseudohdr ip6;
1321#endif
1322};
1323
1324/* - pool: digest algorithm, hash description and scratch buffer */
1325struct tcp_md5sig_pool {
1326 struct hash_desc md5_desc;
1327 union tcp_md5sum_block md5_blk;
1328};
1329
cfb6eeb4 1330/* - functions */
39f8e58e
ED
1331int tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
1332 const struct sock *sk, const struct sk_buff *skb);
5c9f3023
JP
1333int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
1334 int family, const u8 *newkey, u8 newkeylen, gfp_t gfp);
1335int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
1336 int family);
1337struct tcp_md5sig_key *tcp_v4_md5_lookup(struct sock *sk,
fd3a154a 1338 const struct sock *addr_sk);
cfb6eeb4 1339
9501f972 1340#ifdef CONFIG_TCP_MD5SIG
5c9f3023
JP
1341struct tcp_md5sig_key *tcp_md5_do_lookup(struct sock *sk,
1342 const union tcp_md5_addr *addr,
1343 int family);
a915da9b 1344#define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_key)
9501f972 1345#else
a915da9b
ED
1346static inline struct tcp_md5sig_key *tcp_md5_do_lookup(struct sock *sk,
1347 const union tcp_md5_addr *addr,
1348 int family)
1349{
1350 return NULL;
1351}
9501f972
YH
1352#define tcp_twsk_md5_key(twsk) NULL
1353#endif
1354
5c9f3023 1355bool tcp_alloc_md5sig_pool(void);
cfb6eeb4 1356
5c9f3023 1357struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
71cea17e
ED
1358static inline void tcp_put_md5sig_pool(void)
1359{
1360 local_bh_enable();
1361}
35790c04 1362
5c9f3023
JP
1363int tcp_md5_hash_header(struct tcp_md5sig_pool *, const struct tcphdr *);
1364int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
1365 unsigned int header_len);
1366int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
1367 const struct tcp_md5sig_key *key);
cfb6eeb4 1368
10467163 1369/* From tcp_fastopen.c */
5c9f3023
JP
1370void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
1371 struct tcp_fastopen_cookie *cookie, int *syn_loss,
1372 unsigned long *last_syn_loss);
1373void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
2646c831
DL
1374 struct tcp_fastopen_cookie *cookie, bool syn_lost,
1375 u16 try_exp);
783237e8
YC
1376struct tcp_fastopen_request {
1377 /* Fast Open cookie. Size 0 means a cookie request */
1378 struct tcp_fastopen_cookie cookie;
1379 struct msghdr *data; /* data in MSG_FASTOPEN */
f5ddcbbb
ED
1380 size_t size;
1381 int copied; /* queued in tcp_connect() */
783237e8 1382};
783237e8
YC
1383void tcp_free_fastopen_req(struct tcp_sock *tp);
1384
10467163
JC
1385extern struct tcp_fastopen_context __rcu *tcp_fastopen_ctx;
1386int tcp_fastopen_reset_cipher(void *key, unsigned int len);
843f4a55
YC
1387bool tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
1388 struct request_sock *req,
1389 struct tcp_fastopen_cookie *foc,
1390 struct dst_entry *dst);
222e83d2 1391void tcp_fastopen_init_key_once(bool publish);
10467163
JC
1392#define TCP_FASTOPEN_KEY_LENGTH 16
1393
1394/* Fastopen key context */
1395struct tcp_fastopen_context {
7ae8639c
ED
1396 struct crypto_cipher *tfm;
1397 __u8 key[TCP_FASTOPEN_KEY_LENGTH];
1398 struct rcu_head rcu;
10467163
JC
1399};
1400
fe067e8a
DM
1401/* write queue abstraction */
1402static inline void tcp_write_queue_purge(struct sock *sk)
1403{
1404 struct sk_buff *skb;
1405
1406 while ((skb = __skb_dequeue(&sk->sk_write_queue)) != NULL)
3ab224be
HA
1407 sk_wmem_free_skb(sk, skb);
1408 sk_mem_reclaim(sk);
8818a9d8 1409 tcp_clear_all_retrans_hints(tcp_sk(sk));
fe067e8a
DM
1410}
1411
cf533ea5 1412static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
fe067e8a 1413{
cd07a8ea 1414 return skb_peek(&sk->sk_write_queue);
fe067e8a
DM
1415}
1416
cf533ea5 1417static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
fe067e8a 1418{
cd07a8ea 1419 return skb_peek_tail(&sk->sk_write_queue);
fe067e8a
DM
1420}
1421
cf533ea5
ED
1422static inline struct sk_buff *tcp_write_queue_next(const struct sock *sk,
1423 const struct sk_buff *skb)
fe067e8a 1424{
cd07a8ea 1425 return skb_queue_next(&sk->sk_write_queue, skb);
fe067e8a
DM
1426}
1427
cf533ea5
ED
1428static inline struct sk_buff *tcp_write_queue_prev(const struct sock *sk,
1429 const struct sk_buff *skb)
832d11c5
IJ
1430{
1431 return skb_queue_prev(&sk->sk_write_queue, skb);
1432}
1433
fe067e8a 1434#define tcp_for_write_queue(skb, sk) \
cd07a8ea 1435 skb_queue_walk(&(sk)->sk_write_queue, skb)
fe067e8a
DM
1436
1437#define tcp_for_write_queue_from(skb, sk) \
cd07a8ea 1438 skb_queue_walk_from(&(sk)->sk_write_queue, skb)
fe067e8a 1439
234b6860 1440#define tcp_for_write_queue_from_safe(skb, tmp, sk) \
cd07a8ea 1441 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
234b6860 1442
cf533ea5 1443static inline struct sk_buff *tcp_send_head(const struct sock *sk)
fe067e8a
DM
1444{
1445 return sk->sk_send_head;
1446}
1447
cd07a8ea
DM
1448static inline bool tcp_skb_is_last(const struct sock *sk,
1449 const struct sk_buff *skb)
1450{
1451 return skb_queue_is_last(&sk->sk_write_queue, skb);
1452}
1453
cf533ea5 1454static inline void tcp_advance_send_head(struct sock *sk, const struct sk_buff *skb)
fe067e8a 1455{
cd07a8ea 1456 if (tcp_skb_is_last(sk, skb))
fe067e8a 1457 sk->sk_send_head = NULL;
cd07a8ea
DM
1458 else
1459 sk->sk_send_head = tcp_write_queue_next(sk, skb);
fe067e8a
DM
1460}
1461
1462static inline void tcp_check_send_head(struct sock *sk, struct sk_buff *skb_unlinked)
1463{
1464 if (sk->sk_send_head == skb_unlinked)
1465 sk->sk_send_head = NULL;
1466}
1467
1468static inline void tcp_init_send_head(struct sock *sk)
1469{
1470 sk->sk_send_head = NULL;
1471}
1472
1473static inline void __tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1474{
1475 __skb_queue_tail(&sk->sk_write_queue, skb);
1476}
1477
1478static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1479{
1480 __tcp_add_write_queue_tail(sk, skb);
1481
1482 /* Queue it, remembering where we must start sending. */
6859d494 1483 if (sk->sk_send_head == NULL) {
fe067e8a 1484 sk->sk_send_head = skb;
6859d494
IJ
1485
1486 if (tcp_sk(sk)->highest_sack == NULL)
1487 tcp_sk(sk)->highest_sack = skb;
1488 }
fe067e8a
DM
1489}
1490
1491static inline void __tcp_add_write_queue_head(struct sock *sk, struct sk_buff *skb)
1492{
1493 __skb_queue_head(&sk->sk_write_queue, skb);
1494}
1495
1496/* Insert buff after skb on the write queue of sk. */
1497static inline void tcp_insert_write_queue_after(struct sk_buff *skb,
1498 struct sk_buff *buff,
1499 struct sock *sk)
1500{
7de6c033 1501 __skb_queue_after(&sk->sk_write_queue, skb, buff);
fe067e8a
DM
1502}
1503
43f59c89 1504/* Insert new before skb on the write queue of sk. */
fe067e8a
DM
1505static inline void tcp_insert_write_queue_before(struct sk_buff *new,
1506 struct sk_buff *skb,
1507 struct sock *sk)
1508{
43f59c89 1509 __skb_queue_before(&sk->sk_write_queue, skb, new);