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