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