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