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