xref: /linux/include/net/tcp.h (revision 0e59523b440c90ed1899476f32ad4e949282f43e)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * INET		An implementation of the TCP/IP protocol suite for the LINUX
4  *		operating system.  INET is implemented using the  BSD Socket
5  *		interface as the means of communication with the user level.
6  *
7  *		Definitions for the TCP module.
8  *
9  * Version:	@(#)tcp.h	1.0.5	05/23/93
10  *
11  * Authors:	Ross Biro
12  *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13  */
14 #ifndef _TCP_H
15 #define _TCP_H
16 
17 #define FASTRETRANS_DEBUG 1
18 
19 #include <linux/list.h>
20 #include <linux/tcp.h>
21 #include <linux/bug.h>
22 #include <linux/slab.h>
23 #include <linux/cache.h>
24 #include <linux/percpu.h>
25 #include <linux/skbuff.h>
26 #include <linux/kref.h>
27 #include <linux/ktime.h>
28 #include <linux/indirect_call_wrapper.h>
29 #include <linux/bits.h>
30 
31 #include <net/inet_connection_sock.h>
32 #include <net/inet_timewait_sock.h>
33 #include <net/inet_hashtables.h>
34 #include <net/checksum.h>
35 #include <net/request_sock.h>
36 #include <net/sock_reuseport.h>
37 #include <net/sock.h>
38 #include <net/snmp.h>
39 #include <net/ip.h>
40 #include <net/tcp_states.h>
41 #include <net/tcp_ao.h>
42 #include <net/inet_ecn.h>
43 #include <net/dst.h>
44 #include <net/mptcp.h>
45 #include <net/xfrm.h>
46 #include <net/secure_seq.h>
47 
48 #include <linux/seq_file.h>
49 #include <linux/memcontrol.h>
50 #include <linux/bpf-cgroup.h>
51 #include <linux/siphash.h>
52 
53 extern struct inet_hashinfo tcp_hashinfo;
54 
55 DECLARE_PER_CPU(unsigned int, tcp_orphan_count);
56 int tcp_orphan_count_sum(void);
57 
58 static inline void tcp_orphan_count_inc(void)
59 {
60 	this_cpu_inc(tcp_orphan_count);
61 }
62 
63 static inline void tcp_orphan_count_dec(void)
64 {
65 	this_cpu_dec(tcp_orphan_count);
66 }
67 
68 void tcp_time_wait(struct sock *sk, int state, int timeo);
69 
70 #define MAX_TCP_HEADER	L1_CACHE_ALIGN(128 + MAX_HEADER)
71 #define MAX_TCP_OPTION_SPACE 40
72 #define TCP_MIN_SND_MSS		48
73 #define TCP_MIN_GSO_SIZE	(TCP_MIN_SND_MSS - MAX_TCP_OPTION_SPACE)
74 
75 /*
76  * Never offer a window over 32767 without using window scaling. Some
77  * poor stacks do signed 16bit maths!
78  */
79 #define MAX_TCP_WINDOW		32767U
80 
81 /* Minimal accepted MSS. It is (60+60+8) - (20+20). */
82 #define TCP_MIN_MSS		88U
83 
84 /* The initial MTU to use for probing */
85 #define TCP_BASE_MSS		1024
86 
87 /* probing interval, default to 10 minutes as per RFC4821 */
88 #define TCP_PROBE_INTERVAL	600
89 
90 /* Specify interval when tcp mtu probing will stop */
91 #define TCP_PROBE_THRESHOLD	8
92 
93 /* After receiving this amount of duplicate ACKs fast retransmit starts. */
94 #define TCP_FASTRETRANS_THRESH 3
95 
96 /* Maximal number of ACKs sent quickly to accelerate slow-start. */
97 #define TCP_MAX_QUICKACKS	16U
98 
99 /* Maximal number of window scale according to RFC1323 */
100 #define TCP_MAX_WSCALE		14U
101 
102 /* Default sending frequency of accurate ECN option per RTT */
103 #define TCP_ACCECN_OPTION_BEACON	3
104 
105 /* urg_data states */
106 #define TCP_URG_VALID	0x0100
107 #define TCP_URG_NOTYET	0x0200
108 #define TCP_URG_READ	0x0400
109 
110 #define TCP_RETR1	3	/*
111 				 * This is how many retries it does before it
112 				 * tries to figure out if the gateway is
113 				 * down. Minimal RFC value is 3; it corresponds
114 				 * to ~3sec-8min depending on RTO.
115 				 */
116 
117 #define TCP_RETR2	15	/*
118 				 * This should take at least
119 				 * 90 minutes to time out.
120 				 * RFC1122 says that the limit is 100 sec.
121 				 * 15 is ~13-30min depending on RTO.
122 				 */
123 
124 #define TCP_SYN_RETRIES	 6	/* This is how many retries are done
125 				 * when active opening a connection.
126 				 * RFC1122 says the minimum retry MUST
127 				 * be at least 180secs.  Nevertheless
128 				 * this value is corresponding to
129 				 * 63secs of retransmission with the
130 				 * current initial RTO.
131 				 */
132 
133 #define TCP_SYNACK_RETRIES 5	/* This is how may retries are done
134 				 * when passive opening a connection.
135 				 * This is corresponding to 31secs of
136 				 * retransmission with the current
137 				 * initial RTO.
138 				 */
139 
140 #define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
141 				  * state, about 60 seconds	*/
142 #define TCP_FIN_TIMEOUT	TCP_TIMEWAIT_LEN
143                                  /* BSD style FIN_WAIT2 deadlock breaker.
144 				  * It used to be 3min, new value is 60sec,
145 				  * to combine FIN-WAIT-2 timeout with
146 				  * TIME-WAIT timer.
147 				  */
148 #define TCP_FIN_TIMEOUT_MAX (120 * HZ) /* max TCP_LINGER2 value (two minutes) */
149 
150 #define TCP_DELACK_MAX	((unsigned)(HZ/5))	/* maximal time to delay before sending an ACK */
151 static_assert((1 << ATO_BITS) > TCP_DELACK_MAX);
152 
153 #if HZ >= 100
154 #define TCP_DELACK_MIN	((unsigned)(HZ/25))	/* minimal time to delay before sending an ACK */
155 #define TCP_ATO_MIN	((unsigned)(HZ/25))
156 #else
157 #define TCP_DELACK_MIN	4U
158 #define TCP_ATO_MIN	4U
159 #endif
160 #define TCP_RTO_MAX_SEC 120
161 #define TCP_RTO_MAX	((unsigned)(TCP_RTO_MAX_SEC * HZ))
162 #define TCP_RTO_MIN	((unsigned)(HZ / 5))
163 #define TCP_TIMEOUT_MIN	(2U) /* Min timeout for TCP timers in jiffies */
164 
165 #define TCP_TIMEOUT_MIN_US (2*USEC_PER_MSEC) /* Min TCP timeout in microsecs */
166 
167 #define TCP_TIMEOUT_INIT ((unsigned)(1*HZ))	/* RFC6298 2.1 initial RTO value	*/
168 #define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ))	/* RFC 1122 initial RTO value, now
169 						 * used as a fallback RTO for the
170 						 * initial data transmission if no
171 						 * valid RTT sample has been acquired,
172 						 * most likely due to retrans in 3WHS.
173 						 */
174 
175 #define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
176 					                 * for local resources.
177 					                 */
178 #define TCP_KEEPALIVE_TIME	(120*60*HZ)	/* two hours */
179 #define TCP_KEEPALIVE_PROBES	9		/* Max of 9 keepalive probes	*/
180 #define TCP_KEEPALIVE_INTVL	(75*HZ)
181 
182 #define MAX_TCP_KEEPIDLE	32767
183 #define MAX_TCP_KEEPINTVL	32767
184 #define MAX_TCP_KEEPCNT		127
185 #define MAX_TCP_SYNCNT		127
186 
187 /* Ensure that TCP PAWS checks are relaxed after ~2147 seconds
188  * to avoid overflows. This assumes a clock smaller than 1 Mhz.
189  * Default clock is 1 Khz, tcp_usec_ts uses 1 Mhz.
190  */
191 #define TCP_PAWS_WRAP (INT_MAX / USEC_PER_SEC)
192 
193 #define TCP_PAWS_MSL	60		/* Per-host timestamps are invalidated
194 					 * after this time. It should be equal
195 					 * (or greater than) TCP_TIMEWAIT_LEN
196 					 * to provide reliability equal to one
197 					 * provided by timewait state.
198 					 */
199 #define TCP_PAWS_WINDOW	1		/* Replay window for per-host
200 					 * timestamps. It must be less than
201 					 * minimal timewait lifetime.
202 					 */
203 /*
204  *	TCP option
205  */
206 
207 #define TCPOPT_NOP		1	/* Padding */
208 #define TCPOPT_EOL		0	/* End of options */
209 #define TCPOPT_MSS		2	/* Segment size negotiating */
210 #define TCPOPT_WINDOW		3	/* Window scaling */
211 #define TCPOPT_SACK_PERM        4       /* SACK Permitted */
212 #define TCPOPT_SACK             5       /* SACK Block */
213 #define TCPOPT_TIMESTAMP	8	/* Better RTT estimations/PAWS */
214 #define TCPOPT_MD5SIG		19	/* MD5 Signature (RFC2385) */
215 #define TCPOPT_AO		29	/* Authentication Option (RFC5925) */
216 #define TCPOPT_MPTCP		30	/* Multipath TCP (RFC6824) */
217 #define TCPOPT_FASTOPEN		34	/* Fast open (RFC7413) */
218 #define TCPOPT_ACCECN0		172	/* 0xAC: Accurate ECN Order 0 */
219 #define TCPOPT_ACCECN1		174	/* 0xAE: Accurate ECN Order 1 */
220 #define TCPOPT_EXP		254	/* Experimental */
221 /* Magic number to be after the option value for sharing TCP
222  * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
223  */
224 #define TCPOPT_FASTOPEN_MAGIC	0xF989
225 #define TCPOPT_SMC_MAGIC	0xE2D4C3D9
226 
227 /*
228  *     TCP option lengths
229  */
230 
231 #define TCPOLEN_MSS            4
232 #define TCPOLEN_WINDOW         3
233 #define TCPOLEN_SACK_PERM      2
234 #define TCPOLEN_TIMESTAMP      10
235 #define TCPOLEN_MD5SIG         18
236 #define TCPOLEN_FASTOPEN_BASE  2
237 #define TCPOLEN_ACCECN_BASE    2
238 #define TCPOLEN_EXP_FASTOPEN_BASE  4
239 #define TCPOLEN_EXP_SMC_BASE   6
240 
241 /* But this is what stacks really send out. */
242 #define TCPOLEN_TSTAMP_ALIGNED		12
243 #define TCPOLEN_WSCALE_ALIGNED		4
244 #define TCPOLEN_SACKPERM_ALIGNED	4
245 #define TCPOLEN_SACK_BASE		2
246 #define TCPOLEN_SACK_BASE_ALIGNED	4
247 #define TCPOLEN_SACK_PERBLOCK		8
248 #define TCPOLEN_MD5SIG_ALIGNED		20
249 #define TCPOLEN_MSS_ALIGNED		4
250 #define TCPOLEN_EXP_SMC_BASE_ALIGNED	8
251 #define TCPOLEN_ACCECN_PERFIELD		3
252 
253 /* Maximum number of byte counters in AccECN option + size */
254 #define TCP_ACCECN_NUMFIELDS		3
255 #define TCP_ACCECN_MAXSIZE		(TCPOLEN_ACCECN_BASE + \
256 					 TCPOLEN_ACCECN_PERFIELD * \
257 					 TCP_ACCECN_NUMFIELDS)
258 #define TCP_ACCECN_SAFETY_SHIFT		1 /* SAFETY_FACTOR in accecn draft */
259 
260 /* Flags in tp->nonagle */
261 #define TCP_NAGLE_OFF		1	/* Nagle's algo is disabled */
262 #define TCP_NAGLE_CORK		2	/* Socket is corked	    */
263 #define TCP_NAGLE_PUSH		4	/* Cork is overridden for already queued data */
264 
265 /* TCP thin-stream limits */
266 #define TCP_THIN_LINEAR_RETRIES 6       /* After 6 linear retries, do exp. backoff */
267 
268 /* TCP initial congestion window as per rfc6928 */
269 #define TCP_INIT_CWND		10
270 
271 /* Bit Flags for sysctl_tcp_fastopen */
272 #define	TFO_CLIENT_ENABLE	1
273 #define	TFO_SERVER_ENABLE	2
274 #define	TFO_CLIENT_NO_COOKIE	4	/* Data in SYN w/o cookie option */
275 
276 /* Accept SYN data w/o any cookie option */
277 #define	TFO_SERVER_COOKIE_NOT_REQD	0x200
278 
279 /* Force enable TFO on all listeners, i.e., not requiring the
280  * TCP_FASTOPEN socket option.
281  */
282 #define	TFO_SERVER_WO_SOCKOPT1	0x400
283 
284 
285 /* sysctl variables for tcp */
286 extern int sysctl_tcp_max_orphans;
287 extern long sysctl_tcp_mem[3];
288 
289 #define TCP_RACK_LOSS_DETECTION  0x1 /* Use RACK to detect losses */
290 #define TCP_RACK_STATIC_REO_WND  0x2 /* Use static RACK reo wnd */
291 #define TCP_RACK_NO_DUPTHRESH    0x4 /* Do not use DUPACK threshold in RACK */
292 
293 DECLARE_PER_CPU(int, tcp_memory_per_cpu_fw_alloc);
294 
295 extern struct percpu_counter tcp_sockets_allocated;
296 extern unsigned long tcp_memory_pressure;
297 
298 /* optimized version of sk_under_memory_pressure() for TCP sockets */
299 static inline bool tcp_under_memory_pressure(const struct sock *sk)
300 {
301 	if (mem_cgroup_sk_enabled(sk) &&
302 	    mem_cgroup_sk_under_memory_pressure(sk))
303 		return true;
304 
305 	if (sk->sk_bypass_prot_mem)
306 		return false;
307 
308 	return READ_ONCE(tcp_memory_pressure);
309 }
310 /*
311  * The next routines deal with comparing 32 bit unsigned ints
312  * and worry about wraparound (automatic with unsigned arithmetic).
313  */
314 
315 static inline bool before(__u32 seq1, __u32 seq2)
316 {
317         return (__s32)(seq1-seq2) < 0;
318 }
319 #define after(seq2, seq1) 	before(seq1, seq2)
320 
321 /* is s2<=s1<=s3 ? */
322 static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
323 {
324 	return seq3 - seq2 >= seq1 - seq2;
325 }
326 
327 static inline void tcp_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
328 {
329 	sk_wmem_queued_add(sk, -skb->truesize);
330 	if (!skb_zcopy_pure(skb))
331 		sk_mem_uncharge(sk, skb->truesize);
332 	else
333 		sk_mem_uncharge(sk, SKB_TRUESIZE(skb_end_offset(skb)));
334 	__kfree_skb(skb);
335 }
336 
337 void sk_forced_mem_schedule(struct sock *sk, int size);
338 
339 bool tcp_check_oom(const struct sock *sk, int shift);
340 
341 
342 extern struct proto tcp_prot;
343 
344 #define TCP_INC_STATS(net, field)	SNMP_INC_STATS((net)->mib.tcp_statistics, field)
345 #define __TCP_INC_STATS(net, field)	__SNMP_INC_STATS((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(net, field, val)	SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
348 
349 /*
350  * TCP splice context
351  */
352 struct tcp_splice_state {
353 	struct pipe_inode_info *pipe;
354 	size_t len;
355 	unsigned int flags;
356 };
357 
358 void tcp_tsq_work_init(void);
359 
360 int tcp_v4_err(struct sk_buff *skb, u32);
361 
362 void tcp_shutdown(struct sock *sk, int how);
363 
364 int tcp_v4_rcv(struct sk_buff *skb);
365 
366 void tcp_remove_empty_skb(struct sock *sk);
367 int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
368 int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size);
369 int tcp_sendmsg_fastopen(struct sock *sk, struct msghdr *msg, int *copied,
370 			 size_t size, struct ubuf_info *uarg);
371 void tcp_splice_eof(struct socket *sock);
372 int tcp_send_mss(struct sock *sk, int *size_goal, int flags);
373 int tcp_wmem_schedule(struct sock *sk, int copy);
374 void tcp_push(struct sock *sk, int flags, int mss_now, int nonagle,
375 	      int size_goal);
376 
377 void tcp_release_cb(struct sock *sk);
378 
379 static inline bool tcp_release_cb_cond(struct sock *sk)
380 {
381 #ifdef CONFIG_INET
382 	if (likely(sk->sk_prot->release_cb == tcp_release_cb)) {
383 		if (unlikely(smp_load_acquire(&sk->sk_tsq_flags) & TCP_DEFERRED_ALL))
384 			tcp_release_cb(sk);
385 		return true;
386 	}
387 #endif
388 	return false;
389 }
390 
391 void tcp_write_timer_handler(struct sock *sk);
392 void tcp_delack_timer_handler(struct sock *sk);
393 int tcp_ioctl(struct sock *sk, int cmd, int *karg);
394 enum skb_drop_reason tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb);
395 void tcp_rcv_established(struct sock *sk, struct sk_buff *skb);
396 void tcp_rcvbuf_grow(struct sock *sk, u32 newval);
397 void tcp_rcv_space_adjust(struct sock *sk);
398 int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
399 void tcp_twsk_destructor(struct sock *sk);
400 void tcp_twsk_purge(struct list_head *net_exit_list);
401 int tcp_splice_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb,
402 			 unsigned int offset, size_t len);
403 ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
404 			struct pipe_inode_info *pipe, size_t len,
405 			unsigned int flags);
406 struct sk_buff *tcp_stream_alloc_skb(struct sock *sk, gfp_t gfp,
407 				     bool force_schedule);
408 
409 static inline void tcp_dec_quickack_mode(struct sock *sk)
410 {
411 	struct inet_connection_sock *icsk = inet_csk(sk);
412 
413 	if (icsk->icsk_ack.quick) {
414 		/* How many ACKs S/ACKing new data have we sent? */
415 		const unsigned int pkts = inet_csk_ack_scheduled(sk) ? 1 : 0;
416 
417 		if (pkts >= icsk->icsk_ack.quick) {
418 			icsk->icsk_ack.quick = 0;
419 			/* Leaving quickack mode we deflate ATO. */
420 			icsk->icsk_ack.ato   = TCP_ATO_MIN;
421 		} else
422 			icsk->icsk_ack.quick -= pkts;
423 	}
424 }
425 
426 #define	TCP_ECN_MODE_RFC3168	BIT(0)
427 #define	TCP_ECN_QUEUE_CWR	BIT(1)
428 #define	TCP_ECN_DEMAND_CWR	BIT(2)
429 #define	TCP_ECN_SEEN		BIT(3)
430 #define	TCP_ECN_MODE_ACCECN	BIT(4)
431 
432 #define	TCP_ECN_DISABLED	0
433 #define	TCP_ECN_MODE_PENDING	(TCP_ECN_MODE_RFC3168 | TCP_ECN_MODE_ACCECN)
434 #define	TCP_ECN_MODE_ANY	(TCP_ECN_MODE_RFC3168 | TCP_ECN_MODE_ACCECN)
435 
436 static inline bool tcp_ecn_mode_any(const struct tcp_sock *tp)
437 {
438 	return tp->ecn_flags & TCP_ECN_MODE_ANY;
439 }
440 
441 static inline bool tcp_ecn_mode_rfc3168(const struct tcp_sock *tp)
442 {
443 	return (tp->ecn_flags & TCP_ECN_MODE_ANY) == TCP_ECN_MODE_RFC3168;
444 }
445 
446 static inline bool tcp_ecn_mode_accecn(const struct tcp_sock *tp)
447 {
448 	return (tp->ecn_flags & TCP_ECN_MODE_ANY) == TCP_ECN_MODE_ACCECN;
449 }
450 
451 static inline bool tcp_ecn_disabled(const struct tcp_sock *tp)
452 {
453 	return !tcp_ecn_mode_any(tp);
454 }
455 
456 static inline bool tcp_ecn_mode_pending(const struct tcp_sock *tp)
457 {
458 	return (tp->ecn_flags & TCP_ECN_MODE_PENDING) == TCP_ECN_MODE_PENDING;
459 }
460 
461 static inline void tcp_ecn_mode_set(struct tcp_sock *tp, u8 mode)
462 {
463 	tp->ecn_flags &= ~TCP_ECN_MODE_ANY;
464 	tp->ecn_flags |= mode;
465 }
466 
467 enum tcp_tw_status {
468 	TCP_TW_SUCCESS = 0,
469 	TCP_TW_RST = 1,
470 	TCP_TW_ACK = 2,
471 	TCP_TW_SYN = 3,
472 	TCP_TW_ACK_OOW = 4
473 };
474 
475 
476 enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
477 					      struct sk_buff *skb,
478 					      const struct tcphdr *th,
479 					      u32 *tw_isn,
480 					      enum skb_drop_reason *drop_reason);
481 struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
482 			   struct request_sock *req, bool fastopen,
483 			   bool *lost_race, enum skb_drop_reason *drop_reason);
484 enum skb_drop_reason tcp_child_process(struct sock *parent, struct sock *child,
485 				       struct sk_buff *skb);
486 void tcp_enter_loss(struct sock *sk);
487 void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int newly_lost, int flag);
488 void tcp_clear_retrans(struct tcp_sock *tp);
489 void tcp_update_pacing_rate(struct sock *sk);
490 void tcp_set_rto(struct sock *sk);
491 void tcp_update_metrics(struct sock *sk);
492 void tcp_init_metrics(struct sock *sk);
493 void tcp_metrics_init(void);
494 bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst);
495 void __tcp_close(struct sock *sk, long timeout);
496 void tcp_close(struct sock *sk, long timeout);
497 void tcp_init_sock(struct sock *sk);
498 void tcp_init_transfer(struct sock *sk, int bpf_op, struct sk_buff *skb);
499 __poll_t tcp_poll(struct file *file, struct socket *sock,
500 		      struct poll_table_struct *wait);
501 int do_tcp_getsockopt(struct sock *sk, int level,
502 		      int optname, sockptr_t optval, sockptr_t optlen);
503 int tcp_getsockopt(struct sock *sk, int level, int optname,
504 		   char __user *optval, int __user *optlen);
505 bool tcp_bpf_bypass_getsockopt(int level, int optname);
506 int do_tcp_setsockopt(struct sock *sk, int level, int optname,
507 		      sockptr_t optval, unsigned int optlen);
508 int tcp_setsockopt(struct sock *sk, int level, int optname, sockptr_t optval,
509 		   unsigned int optlen);
510 void tcp_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
511 void tcp_set_keepalive(struct sock *sk, int val);
512 void tcp_syn_ack_timeout(const struct request_sock *req);
513 int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
514 		int flags);
515 int tcp_set_rcvlowat(struct sock *sk, int val);
516 void tcp_set_rcvbuf(struct sock *sk, int val);
517 int tcp_set_window_clamp(struct sock *sk, int val);
518 
519 static inline void
520 tcp_update_recv_tstamps(struct sk_buff *skb,
521 			struct scm_timestamping_internal *tss)
522 {
523 	tss->ts[0] = skb->tstamp;
524 	tss->ts[2] = skb_hwtstamps(skb)->hwtstamp;
525 }
526 
527 void tcp_recv_timestamp(struct msghdr *msg, const struct sock *sk,
528 			struct scm_timestamping_internal *tss);
529 void tcp_data_ready(struct sock *sk);
530 #ifdef CONFIG_MMU
531 int tcp_mmap(struct file *file, struct socket *sock,
532 	     struct vm_area_struct *vma);
533 #endif
534 void tcp_parse_options(const struct net *net, const struct sk_buff *skb,
535 		       struct tcp_options_received *opt_rx,
536 		       int estab, struct tcp_fastopen_cookie *foc);
537 
538 /*
539  *	BPF SKB-less helpers
540  */
541 u16 tcp_v4_get_syncookie(struct sock *sk, struct iphdr *iph,
542 			 struct tcphdr *th, u32 *cookie);
543 u16 tcp_v6_get_syncookie(struct sock *sk, struct ipv6hdr *iph,
544 			 struct tcphdr *th, u32 *cookie);
545 u16 tcp_parse_mss_option(const struct tcphdr *th, u16 user_mss);
546 u16 tcp_get_syncookie_mss(struct request_sock_ops *rsk_ops,
547 			  const struct tcp_request_sock_ops *af_ops,
548 			  struct sock *sk, struct tcphdr *th);
549 /*
550  *	TCP v4 functions exported for the inet6 API
551  */
552 
553 void tcp_v4_mtu_reduced(struct sock *sk);
554 void tcp_req_err(struct sock *sk, u32 seq, bool abort);
555 void tcp_ld_RTO_revert(struct sock *sk, u32 seq);
556 int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
557 struct sock *tcp_create_openreq_child(const struct sock *sk,
558 				      struct request_sock *req,
559 				      struct sk_buff *skb);
560 void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
561 struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb,
562 				  struct request_sock *req,
563 				  struct dst_entry *dst,
564 				  struct request_sock *req_unhash,
565 				  bool *own_req,
566 				  void (*opt_child_init)(struct sock *newsk,
567 							 const struct sock *sk));
568 int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
569 int tcp_v4_connect(struct sock *sk, struct sockaddr_unsized *uaddr, int addr_len);
570 int tcp_connect(struct sock *sk);
571 enum tcp_synack_type {
572 	TCP_SYNACK_NORMAL,
573 	TCP_SYNACK_FASTOPEN,
574 	TCP_SYNACK_COOKIE,
575 	TCP_SYNACK_RETRANS,
576 };
577 struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst,
578 				struct request_sock *req,
579 				struct tcp_fastopen_cookie *foc,
580 				enum tcp_synack_type synack_type,
581 				struct sk_buff *syn_skb);
582 int tcp_disconnect(struct sock *sk, int flags);
583 
584 void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
585 int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
586 void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
587 
588 /* From syncookies.c */
589 struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
590 				 struct request_sock *req,
591 				 struct dst_entry *dst);
592 int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th);
593 struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
594 struct request_sock *cookie_tcp_reqsk_alloc(const struct request_sock_ops *ops,
595 					    struct sock *sk, struct sk_buff *skb,
596 					    struct tcp_options_received *tcp_opt,
597 					    int mss, u32 tsoff);
598 
599 #if IS_ENABLED(CONFIG_BPF)
600 struct bpf_tcp_req_attrs {
601 	u32 rcv_tsval;
602 	u32 rcv_tsecr;
603 	u16 mss;
604 	u8 rcv_wscale;
605 	u8 snd_wscale;
606 	u8 ecn_ok;
607 	u8 wscale_ok;
608 	u8 sack_ok;
609 	u8 tstamp_ok;
610 	u8 usec_ts_ok;
611 	u8 reserved[3];
612 };
613 #endif
614 
615 #ifdef CONFIG_SYN_COOKIES
616 
617 /* Syncookies use a monotonic timer which increments every 60 seconds.
618  * This counter is used both as a hash input and partially encoded into
619  * the cookie value.  A cookie is only validated further if the delta
620  * between the current counter value and the encoded one is less than this,
621  * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
622  * the counter advances immediately after a cookie is generated).
623  */
624 #define MAX_SYNCOOKIE_AGE	2
625 #define TCP_SYNCOOKIE_PERIOD	(60 * HZ)
626 #define TCP_SYNCOOKIE_VALID	(MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)
627 
628 /* syncookies: remember time of last synqueue overflow
629  * But do not dirty this field too often (once per second is enough)
630  * It is racy as we do not hold a lock, but race is very minor.
631  */
632 static inline void tcp_synq_overflow(const struct sock *sk)
633 {
634 	unsigned int last_overflow;
635 	unsigned int now = jiffies;
636 
637 	if (sk->sk_reuseport) {
638 		struct sock_reuseport *reuse;
639 
640 		reuse = rcu_dereference(sk->sk_reuseport_cb);
641 		if (likely(reuse)) {
642 			last_overflow = READ_ONCE(reuse->synq_overflow_ts);
643 			if (!time_between32(now, last_overflow,
644 					    last_overflow + HZ))
645 				WRITE_ONCE(reuse->synq_overflow_ts, now);
646 			return;
647 		}
648 	}
649 
650 	last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
651 	if (!time_between32(now, last_overflow, last_overflow + HZ))
652 		WRITE_ONCE(tcp_sk_rw(sk)->rx_opt.ts_recent_stamp, now);
653 }
654 
655 /* syncookies: no recent synqueue overflow on this listening socket? */
656 static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
657 {
658 	unsigned int last_overflow;
659 	unsigned int now = jiffies;
660 
661 	if (sk->sk_reuseport) {
662 		struct sock_reuseport *reuse;
663 
664 		reuse = rcu_dereference(sk->sk_reuseport_cb);
665 		if (likely(reuse)) {
666 			last_overflow = READ_ONCE(reuse->synq_overflow_ts);
667 			return !time_between32(now, last_overflow - HZ,
668 					       last_overflow +
669 					       TCP_SYNCOOKIE_VALID);
670 		}
671 	}
672 
673 	last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp);
674 
675 	/* If last_overflow <= jiffies <= last_overflow + TCP_SYNCOOKIE_VALID,
676 	 * then we're under synflood. However, we have to use
677 	 * 'last_overflow - HZ' as lower bound. That's because a concurrent
678 	 * tcp_synq_overflow() could update .ts_recent_stamp after we read
679 	 * jiffies but before we store .ts_recent_stamp into last_overflow,
680 	 * which could lead to rejecting a valid syncookie.
681 	 */
682 	return !time_between32(now, last_overflow - HZ,
683 			       last_overflow + TCP_SYNCOOKIE_VALID);
684 }
685 
686 static inline u32 tcp_cookie_time(void)
687 {
688 	u64 val = get_jiffies_64();
689 
690 	do_div(val, TCP_SYNCOOKIE_PERIOD);
691 	return val;
692 }
693 
694 /* Convert one nsec 64bit timestamp to ts (ms or usec resolution) */
695 static inline u64 tcp_ns_to_ts(bool usec_ts, u64 val)
696 {
697 	if (usec_ts)
698 		return div_u64(val, NSEC_PER_USEC);
699 
700 	return div_u64(val, NSEC_PER_MSEC);
701 }
702 
703 u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
704 			      u16 *mssp);
705 __u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss);
706 u64 cookie_init_timestamp(struct request_sock *req, u64 now);
707 bool cookie_timestamp_decode(const struct net *net,
708 			     struct tcp_options_received *opt);
709 
710 static inline bool cookie_ecn_ok(const struct net *net, const struct dst_entry *dst)
711 {
712 	return READ_ONCE(net->ipv4.sysctl_tcp_ecn) ||
713 		dst_feature(dst, RTAX_FEATURE_ECN);
714 }
715 
716 #if IS_ENABLED(CONFIG_BPF)
717 static inline bool cookie_bpf_ok(struct sk_buff *skb)
718 {
719 	return skb->sk;
720 }
721 
722 struct request_sock *cookie_bpf_check(struct sock *sk, struct sk_buff *skb);
723 #else
724 static inline bool cookie_bpf_ok(struct sk_buff *skb)
725 {
726 	return false;
727 }
728 
729 static inline struct request_sock *cookie_bpf_check(struct net *net, struct sock *sk,
730 						    struct sk_buff *skb)
731 {
732 	return NULL;
733 }
734 #endif
735 
736 /* From net/ipv6/syncookies.c */
737 int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th);
738 struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
739 
740 u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
741 			      const struct tcphdr *th, u16 *mssp);
742 __u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss);
743 #endif
744 /* tcp_output.c */
745 
746 void tcp_skb_entail(struct sock *sk, struct sk_buff *skb);
747 void tcp_mark_push(struct tcp_sock *tp, struct sk_buff *skb);
748 void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
749 			       int nonagle);
750 int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
751 int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
752 void tcp_retransmit_timer(struct sock *sk);
753 void tcp_xmit_retransmit_queue(struct sock *);
754 void tcp_simple_retransmit(struct sock *);
755 void tcp_enter_recovery(struct sock *sk, bool ece_ack);
756 int tcp_trim_head(struct sock *, struct sk_buff *, u32);
757 enum tcp_queue {
758 	TCP_FRAG_IN_WRITE_QUEUE,
759 	TCP_FRAG_IN_RTX_QUEUE,
760 };
761 int tcp_fragment(struct sock *sk, enum tcp_queue tcp_queue,
762 		 struct sk_buff *skb, u32 len,
763 		 unsigned int mss_now, gfp_t gfp);
764 
765 void tcp_send_probe0(struct sock *);
766 int tcp_write_wakeup(struct sock *, int mib);
767 void tcp_send_fin(struct sock *sk);
768 void tcp_send_active_reset(struct sock *sk, enum sk_rst_reason reason);
769 int tcp_send_synack(struct sock *);
770 void tcp_push_one(struct sock *, unsigned int mss_now);
771 void __tcp_send_ack(struct sock *sk, u32 rcv_nxt, u16 flags);
772 void tcp_send_ack(struct sock *sk);
773 void tcp_send_delayed_ack(struct sock *sk);
774 void tcp_send_loss_probe(struct sock *sk);
775 bool tcp_schedule_loss_probe(struct sock *sk, bool advancing_rto);
776 void tcp_skb_collapse_tstamp(struct sk_buff *skb,
777 			     const struct sk_buff *next_skb);
778 
779 /* tcp_input.c */
780 void tcp_rearm_rto(struct sock *sk);
781 void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req);
782 void tcp_done_with_error(struct sock *sk, int err);
783 void tcp_reset(struct sock *sk, struct sk_buff *skb);
784 void tcp_fin(struct sock *sk);
785 void __tcp_check_space(struct sock *sk);
786 
787 /* Mirror of SOCK_NOSPACE in tcp_sock, maintained by sk_set_nospace()
788  * and sk_clear_nospace().
789  *
790  * MPTCP subflows share the parent socket, and thus its SOCK_NOSPACE bit.
791  * Keep their mirror always set (see subflow_ulp_init()) so that they
792  * always reach __tcp_check_space() and behave as before.
793  */
794 static inline void tcp_set_nospace(struct sock *sk)
795 {
796 	if (sk_is_tcp(sk)) {
797 		/* pairs with smp_mb__before_atomic() in tcp_clear_nospace() */
798 		smp_mb__after_atomic();
799 		/* pairs with smp_mb() in tcp_check_space() */
800 		smp_store_mb(tcp_sk(sk)->tcp_nospace, 1);
801 	}
802 }
803 
804 static inline void tcp_clear_nospace(struct sock *sk)
805 {
806 	if (sk_is_tcp(sk) && !sk_is_mptcp(sk)) {
807 		WRITE_ONCE(tcp_sk(sk)->tcp_nospace, 0);
808 		/* pairs with smp_mb__after_atomic() in tcp_set_nospace() */
809 		smp_mb__before_atomic();
810 	}
811 }
812 
813 static inline void tcp_check_space(struct sock *sk)
814 {
815 	/* pairs with tcp_poll() */
816 	smp_mb();
817 
818 	if (unlikely(READ_ONCE(tcp_sk(sk)->tcp_nospace)))
819 		__tcp_check_space(sk);
820 }
821 
822 void tcp_sack_compress_send_ack(struct sock *sk);
823 
824 static inline void tcp_cleanup_skb(struct sk_buff *skb)
825 {
826 	skb_dst_drop(skb);
827 	secpath_reset(skb);
828 }
829 
830 static inline void tcp_add_receive_queue(struct sock *sk, struct sk_buff *skb)
831 {
832 	DEBUG_NET_WARN_ON_ONCE(skb_dst(skb));
833 	DEBUG_NET_WARN_ON_ONCE(secpath_exists(skb));
834 	__skb_queue_tail(&sk->sk_receive_queue, skb);
835 }
836 
837 /* tcp_timer.c */
838 void tcp_init_xmit_timers(struct sock *);
839 static inline void tcp_clear_xmit_timers(struct sock *sk)
840 {
841 	if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1)
842 		__sock_put(sk);
843 
844 	if (hrtimer_try_to_cancel(&tcp_sk(sk)->compressed_ack_timer) == 1)
845 		__sock_put(sk);
846 
847 	inet_csk_clear_xmit_timers(sk);
848 }
849 
850 unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
851 unsigned int tcp_current_mss(struct sock *sk);
852 u32 tcp_clamp_probe0_to_user_timeout(const struct sock *sk, u32 when);
853 
854 u32 tcp_tso_autosize(const struct sock *sk, unsigned int mss_now,
855 		     int min_tso_segs);
856 
857 /* Bound MSS / TSO packet size with the half of the window */
858 static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
859 {
860 	int cutoff;
861 
862 	/* When peer uses tiny windows, there is no use in packetizing
863 	 * to sub-MSS pieces for the sake of SWS or making sure there
864 	 * are enough packets in the pipe for fast recovery.
865 	 *
866 	 * On the other hand, for extremely large MSS devices, handling
867 	 * smaller than MSS windows in this way does make sense.
868 	 */
869 	if (tp->max_window > TCP_MSS_DEFAULT)
870 		cutoff = (tp->max_window >> 1);
871 	else
872 		cutoff = tp->max_window;
873 
874 	if (cutoff && pktsize > cutoff)
875 		return max_t(int, cutoff, 68U - tp->tcp_header_len);
876 	else
877 		return pktsize;
878 }
879 
880 /* tcp.c */
881 void tcp_get_info(struct sock *, struct tcp_info *);
882 void tcp_rate_check_app_limited(struct sock *sk);
883 
884 /* Read 'sendfile()'-style from a TCP socket */
885 int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
886 		  sk_read_actor_t recv_actor);
887 int tcp_read_sock_noack(struct sock *sk, read_descriptor_t *desc,
888 			sk_read_actor_t recv_actor, bool noack,
889 			u32 *copied_seq);
890 int tcp_read_skb(struct sock *sk, skb_read_actor_t recv_actor);
891 struct sk_buff *tcp_recv_skb(struct sock *sk, u32 seq, u32 *off);
892 void tcp_read_done(struct sock *sk, size_t len);
893 
894 void tcp_initialize_rcv_mss(struct sock *sk);
895 
896 int tcp_mtu_to_mss(struct sock *sk, int pmtu);
897 int tcp_mss_to_mtu(struct sock *sk, int mss);
898 void tcp_mtup_init(struct sock *sk);
899 
900 static inline unsigned int tcp_rto_max(const struct sock *sk)
901 {
902 	return READ_ONCE(inet_csk(sk)->icsk_rto_max);
903 }
904 
905 static inline void tcp_bound_rto(struct sock *sk)
906 {
907 	inet_csk(sk)->icsk_rto = min(inet_csk(sk)->icsk_rto, tcp_rto_max(sk));
908 }
909 
910 static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
911 {
912 	return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
913 }
914 
915 static inline unsigned long tcp_reqsk_timeout(struct request_sock *req)
916 {
917 	u64 timeout = (u64)req->timeout << req->num_timeout;
918 
919 	return (unsigned long)min_t(u64, timeout,
920 				    tcp_rto_max(req->rsk_listener));
921 }
922 
923 u32 tcp_delack_max(const struct sock *sk);
924 
925 /* Compute the actual rto_min value */
926 static inline u32 tcp_rto_min(const struct sock *sk)
927 {
928 	const struct dst_entry *dst = __sk_dst_get(sk);
929 	u32 rto_min = READ_ONCE(inet_csk(sk)->icsk_rto_min);
930 
931 	if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
932 		rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
933 	return rto_min;
934 }
935 
936 static inline u32 tcp_rto_min_us(const struct sock *sk)
937 {
938 	return jiffies_to_usecs(tcp_rto_min(sk));
939 }
940 
941 static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
942 {
943 	return dst_metric_locked(dst, RTAX_CC_ALGO);
944 }
945 
946 /* Minimum RTT in usec. ~0 means not available. */
947 static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
948 {
949 	return minmax_get(&tp->rtt_min);
950 }
951 
952 /* Compute the actual receive window we are currently advertising.
953  * Rcv_nxt can be after the window if our peer push more data
954  * than the offered window.
955  */
956 static inline u32 tcp_receive_window(const struct tcp_sock *tp)
957 {
958 	s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
959 
960 	if (win < 0)
961 		win = 0;
962 	return (u32) win;
963 }
964 
965 /* Compute the maximum receive window we ever advertised.
966  * Rcv_nxt can be after the window if our peer push more data
967  * than the offered window.
968  */
969 static inline u32 tcp_max_receive_window(const struct tcp_sock *tp)
970 {
971 	s32 win = tp->rcv_mwnd_seq - tp->rcv_nxt;
972 
973 	if (win < 0)
974 		win = 0;
975 	return (u32) win;
976 }
977 
978 /* Check if we need to update the maximum receive window sequence number */
979 static inline void tcp_update_max_rcv_wnd_seq(struct tcp_sock *tp)
980 {
981 	u32 wre = tp->rcv_wup + tp->rcv_wnd;
982 
983 	if (after(wre, tp->rcv_mwnd_seq))
984 		tp->rcv_mwnd_seq = wre;
985 }
986 
987 /* Choose a new window, without checks for shrinking, and without
988  * scaling applied to the result.  The caller does these things
989  * if necessary.  This is a "raw" window selection.
990  */
991 u32 __tcp_select_window(struct sock *sk);
992 
993 void tcp_send_window_probe(struct sock *sk);
994 
995 /* TCP uses 32bit jiffies to save some space.
996  * Note that this is different from tcp_time_stamp, which
997  * historically has been the same until linux-4.13.
998  */
999 #define tcp_jiffies32 ((u32)jiffies)
1000 
1001 /*
1002  * Deliver a 32bit value for TCP timestamp option (RFC 7323)
1003  * It is no longer tied to jiffies, but to 1 ms clock.
1004  * Note: double check if you want to use tcp_jiffies32 instead of this.
1005  */
1006 #define TCP_TS_HZ	1000
1007 
1008 static inline u64 tcp_clock_ns(void)
1009 {
1010 	return ktime_get_ns();
1011 }
1012 
1013 static inline u64 tcp_clock_us(void)
1014 {
1015 	return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
1016 }
1017 
1018 static inline u64 tcp_clock_ms(void)
1019 {
1020 	return div_u64(tcp_clock_ns(), NSEC_PER_MSEC);
1021 }
1022 
1023 /* TCP Timestamp included in TS option (RFC 1323) can either use ms
1024  * or usec resolution. Each socket carries a flag to select one or other
1025  * resolution, as the route attribute could change anytime.
1026  * Each flow must stick to initial resolution.
1027  */
1028 static inline u32 tcp_clock_ts(bool usec_ts)
1029 {
1030 	return usec_ts ? tcp_clock_us() : tcp_clock_ms();
1031 }
1032 
1033 static inline u32 tcp_time_stamp_ms(const struct tcp_sock *tp)
1034 {
1035 	return div_u64(tp->tcp_mstamp, USEC_PER_MSEC);
1036 }
1037 
1038 static inline u32 tcp_time_stamp_ts(const struct tcp_sock *tp)
1039 {
1040 	if (tp->tcp_usec_ts)
1041 		return tp->tcp_mstamp;
1042 	return tcp_time_stamp_ms(tp);
1043 }
1044 
1045 /* Refresh clocks of a TCP socket,
1046  * ensuring monotically increasing values.
1047  */
1048 static inline void tcp_mstamp_refresh_inline(struct tcp_sock *tp)
1049 {
1050 	u64 val = tcp_clock_ns();
1051 
1052 	tp->tcp_clock_cache = val;
1053 	tp->tcp_mstamp = div_u64(val, NSEC_PER_USEC);
1054 }
1055 void tcp_mstamp_refresh(struct tcp_sock *tp);
1056 
1057 static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
1058 {
1059 	return max_t(s64, t1 - t0, 0);
1060 }
1061 
1062 /* provide the departure time in us unit */
1063 static inline u64 tcp_skb_timestamp_us(const struct sk_buff *skb)
1064 {
1065 	return div_u64(skb->skb_mstamp_ns, NSEC_PER_USEC);
1066 }
1067 
1068 /* Provide skb TSval in usec or ms unit */
1069 static inline u32 tcp_skb_timestamp_ts(bool usec_ts, const struct sk_buff *skb)
1070 {
1071 	if (usec_ts)
1072 		return tcp_skb_timestamp_us(skb);
1073 
1074 	return div_u64(skb->skb_mstamp_ns, NSEC_PER_MSEC);
1075 }
1076 
1077 static inline u32 tcp_tw_tsval(const struct tcp_timewait_sock *tcptw)
1078 {
1079 	return tcp_clock_ts(tcptw->tw_sk.tw_usec_ts) + tcptw->tw_ts_offset;
1080 }
1081 
1082 static inline u32 tcp_rsk_tsval(const struct tcp_request_sock *treq)
1083 {
1084 	return tcp_clock_ts(treq->req_usec_ts) + treq->ts_off;
1085 }
1086 
1087 #define tcp_flag_byte(th) (((u_int8_t *)th)[13])
1088 
1089 #define TCPHDR_FIN	BIT(0)
1090 #define TCPHDR_SYN	BIT(1)
1091 #define TCPHDR_RST	BIT(2)
1092 #define TCPHDR_PSH	BIT(3)
1093 #define TCPHDR_ACK	BIT(4)
1094 #define TCPHDR_URG	BIT(5)
1095 #define TCPHDR_ECE	BIT(6)
1096 #define TCPHDR_CWR	BIT(7)
1097 #define TCPHDR_AE	BIT(8)
1098 #define TCPHDR_FLAGS_MASK (TCPHDR_FIN | TCPHDR_SYN | TCPHDR_RST | \
1099 			   TCPHDR_PSH | TCPHDR_ACK | TCPHDR_URG | \
1100 			   TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE)
1101 #define tcp_flags_ntohs(th) (ntohs(*(__be16 *)&tcp_flag_word(th)) & \
1102 			    TCPHDR_FLAGS_MASK)
1103 
1104 #define TCPHDR_ACE (TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE)
1105 #define TCPHDR_SYN_ECN	(TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)
1106 #define TCPHDR_SYNACK_ACCECN (TCPHDR_SYN | TCPHDR_ACK | TCPHDR_CWR)
1107 
1108 #define TCP_ACCECN_CEP_ACE_MASK 0x7
1109 #define TCP_ACCECN_ACE_MAX_DELTA 6
1110 
1111 /* To avoid/detect middlebox interference, not all counters start at 0.
1112  * See draft-ietf-tcpm-accurate-ecn for the latest values.
1113  */
1114 #define TCP_ACCECN_CEP_INIT_OFFSET 5
1115 #define TCP_ACCECN_E1B_INIT_OFFSET 1
1116 #define TCP_ACCECN_E0B_INIT_OFFSET 1
1117 #define TCP_ACCECN_CEB_INIT_OFFSET 0
1118 
1119 /* State flags for sacked in struct tcp_skb_cb */
1120 enum tcp_skb_cb_sacked_flags {
1121 	TCPCB_SACKED_ACKED	= (1 << 0),	/* SKB ACK'd by a SACK block	*/
1122 	TCPCB_SACKED_RETRANS	= (1 << 1),	/* SKB retransmitted		*/
1123 	TCPCB_LOST		= (1 << 2),	/* SKB is lost			*/
1124 	TCPCB_TAGBITS		= (TCPCB_SACKED_ACKED | TCPCB_SACKED_RETRANS |
1125 				   TCPCB_LOST),	/* All tag bits			*/
1126 	TCPCB_REPAIRED		= (1 << 4),	/* SKB repaired (no skb_mstamp_ns)	*/
1127 	TCPCB_EVER_RETRANS	= (1 << 7),	/* Ever retransmitted frame	*/
1128 	TCPCB_RETRANS		= (TCPCB_SACKED_RETRANS | TCPCB_EVER_RETRANS |
1129 				   TCPCB_REPAIRED),
1130 };
1131 
1132 /* This is what the send packet queuing engine uses to pass
1133  * TCP per-packet control information to the transmission code.
1134  * We also store the host-order sequence numbers in here too.
1135  * This is 44 bytes if IPV6 is enabled.
1136  * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
1137  */
1138 struct tcp_skb_cb {
1139 	__u32		seq;		/* Starting sequence number	*/
1140 	__u32		end_seq;	/* SEQ + FIN + SYN + datalen	*/
1141 	union {
1142 		/* Notes :
1143 		 *	tcp_tw_isn is used in input path only
1144 		 *	(isn chosen by tcp_timewait_state_process())
1145 		 * 	  tcp_gso_segs/size are used in write queue only,
1146 		 *	  cf tcp_skb_pcount()/tcp_skb_mss()
1147 		 */
1148 		u32		tcp_tw_isn;
1149 		struct {
1150 			u16	tcp_gso_segs;
1151 			u16	tcp_gso_size;
1152 		};
1153 	};
1154 	__u16		tcp_flags;	/* TCP header flags (tcp[12-13])*/
1155 
1156 	__u8		sacked;		/* State flags for SACK.	*/
1157 	__u8		ip_dsfield;	/* IPv4 tos or IPv6 dsfield	*/
1158 #define TSTAMP_ACK_SK	0x1
1159 #define TSTAMP_ACK_BPF	0x2
1160 	__u8		txstamp_ack:2,	/* Record TX timestamp for ack? */
1161 			eor:1,		/* Is skb MSG_EOR marked? */
1162 			has_rxtstamp:1,	/* SKB has a RX timestamp	*/
1163 			unused:4;
1164 	__u32		ack_seq;	/* Sequence number ACK'd	*/
1165 	union {
1166 		struct {
1167 #define TCPCB_DELIVERED_CE_MASK ((1U<<20) - 1)
1168 			/* There is space for up to 24 bytes */
1169 			__u32 is_app_limited:1, /* cwnd not fully used? */
1170 			      delivered_ce:20,
1171 			      unused:11;
1172 			/* pkts S/ACKed so far upon tx of skb, incl retrans: */
1173 			__u32 delivered;
1174 			/* start of send pipeline phase */
1175 			u64 first_tx_mstamp;
1176 			/* when we reached the "delivered" count */
1177 			u64 delivered_mstamp;
1178 		} tx;   /* only used for outgoing skbs */
1179 		union {
1180 			struct inet_skb_parm	h4;
1181 #if IS_ENABLED(CONFIG_IPV6)
1182 			struct inet6_skb_parm	h6;
1183 #endif
1184 		} header;	/* For incoming skbs */
1185 	};
1186 };
1187 
1188 #define TCP_SKB_CB(__skb)	((struct tcp_skb_cb *)&((__skb)->cb[0]))
1189 
1190 extern const struct inet_connection_sock_af_ops ipv4_specific;
1191 
1192 #if IS_ENABLED(CONFIG_IPV6)
1193 /* This is the variant of inet6_iif() that must be used by TCP,
1194  * as TCP moves IP6CB into a different location in skb->cb[]
1195  */
1196 static inline int tcp_v6_iif(const struct sk_buff *skb)
1197 {
1198 	return TCP_SKB_CB(skb)->header.h6.iif;
1199 }
1200 
1201 static inline int tcp_v6_iif_l3_slave(const struct sk_buff *skb)
1202 {
1203 	bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
1204 
1205 	return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
1206 }
1207 
1208 /* TCP_SKB_CB reference means this can not be used from early demux */
1209 static inline int tcp_v6_sdif(const struct sk_buff *skb)
1210 {
1211 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
1212 	if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags))
1213 		return TCP_SKB_CB(skb)->header.h6.iif;
1214 #endif
1215 	return 0;
1216 }
1217 
1218 extern const struct inet_connection_sock_af_ops ipv6_specific;
1219 
1220 INDIRECT_CALLABLE_DECLARE(int tcp_v6_rcv(struct sk_buff *skb));
1221 
1222 #endif
1223 
1224 /* TCP_SKB_CB reference means this can not be used from early demux */
1225 static inline int tcp_v4_sdif(struct sk_buff *skb)
1226 {
1227 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
1228 	if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
1229 		return TCP_SKB_CB(skb)->header.h4.iif;
1230 #endif
1231 	return 0;
1232 }
1233 
1234 /* Due to TSO, an SKB can be composed of multiple actual
1235  * packets.  To keep these tracked properly, we use this.
1236  */
1237 static inline int tcp_skb_pcount(const struct sk_buff *skb)
1238 {
1239 	return TCP_SKB_CB(skb)->tcp_gso_segs;
1240 }
1241 
1242 static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
1243 {
1244 	TCP_SKB_CB(skb)->tcp_gso_segs = segs;
1245 }
1246 
1247 static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
1248 {
1249 	TCP_SKB_CB(skb)->tcp_gso_segs += segs;
1250 }
1251 
1252 /* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
1253 static inline int tcp_skb_mss(const struct sk_buff *skb)
1254 {
1255 	return TCP_SKB_CB(skb)->tcp_gso_size;
1256 }
1257 
1258 static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
1259 {
1260 	return likely(!TCP_SKB_CB(skb)->eor);
1261 }
1262 
1263 static inline bool tcp_skb_can_collapse(const struct sk_buff *to,
1264 					const struct sk_buff *from)
1265 {
1266 	return likely(tcp_skb_can_collapse_to(to) &&
1267 		      mptcp_skb_can_collapse(to, from) &&
1268 		      !skb_cmp_decrypted(to, from) &&
1269 		      skb_pure_zcopy_same(to, from) &&
1270 		      skb_frags_readable(to) == skb_frags_readable(from));
1271 }
1272 
1273 static inline bool tcp_skb_can_collapse_rx(const struct sk_buff *to,
1274 					   const struct sk_buff *from)
1275 {
1276 	return likely(mptcp_skb_can_collapse(to, from) &&
1277 		      !skb_cmp_decrypted(to, from));
1278 }
1279 
1280 /* Events passed to congestion control interface */
1281 enum tcp_ca_event {
1282 	CA_EVENT_TX_START,	/* first transmit when no packets in flight */
1283 	CA_EVENT_CWND_RESTART,	/* congestion window restart */
1284 	CA_EVENT_COMPLETE_CWR,	/* end of congestion recovery */
1285 	CA_EVENT_LOSS,		/* loss timeout */
1286 	CA_EVENT_ECN_NO_CE,	/* ECT set, but not CE marked */
1287 	CA_EVENT_ECN_IS_CE,	/* received CE marked IP packet */
1288 };
1289 
1290 /* Information about inbound ACK, passed to cong_ops->in_ack_event() */
1291 enum tcp_ca_ack_event_flags {
1292 	CA_ACK_SLOWPATH		= (1 << 0),	/* In slow path processing */
1293 	CA_ACK_WIN_UPDATE	= (1 << 1),	/* ACK updated window */
1294 	CA_ACK_ECE		= (1 << 2),	/* ECE bit is set on ack */
1295 };
1296 
1297 /*
1298  * Interface for adding new TCP congestion control handlers
1299  */
1300 #define TCP_CA_NAME_MAX	16
1301 #define TCP_CA_MAX	128
1302 #define TCP_CA_BUF_MAX	(TCP_CA_NAME_MAX*TCP_CA_MAX)
1303 
1304 #define TCP_CA_UNSPEC	0
1305 
1306 /* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
1307 #define TCP_CONG_NON_RESTRICTED		BIT(0)
1308 /* Requires ECN/ECT set on all packets */
1309 #define TCP_CONG_NEEDS_ECN		BIT(1)
1310 /* Require successfully negotiated AccECN capability */
1311 #define TCP_CONG_NEEDS_ACCECN		BIT(2)
1312 /* Use ECT(1) instead of ECT(0) while the CA is uninitialized */
1313 #define TCP_CONG_ECT_1_NEGOTIATION	BIT(3)
1314 /* Cannot fallback to RFC3168 during AccECN negotiation */
1315 #define TCP_CONG_NO_FALLBACK_RFC3168	BIT(4)
1316 #define TCP_CONG_MASK  (TCP_CONG_NON_RESTRICTED | TCP_CONG_NEEDS_ECN | \
1317 			TCP_CONG_NEEDS_ACCECN | TCP_CONG_ECT_1_NEGOTIATION | \
1318 			TCP_CONG_NO_FALLBACK_RFC3168)
1319 
1320 union tcp_cc_info;
1321 
1322 struct ack_sample {
1323 	u32 pkts_acked;
1324 	s32 rtt_us;
1325 	u32 in_flight;
1326 };
1327 
1328 /* A rate sample measures the number of (original/retransmitted) data
1329  * packets delivered "delivered" over an interval of time "interval_us".
1330  * The tcp_rate.c code fills in the rate sample, and congestion
1331  * control modules that define a cong_control function to run at the end
1332  * of ACK processing can optionally chose to consult this sample when
1333  * setting cwnd and pacing rate.
1334  * A sample is invalid if "delivered" or "interval_us" is negative.
1335  */
1336 struct rate_sample {
1337 	u64  prior_mstamp; /* starting timestamp for interval */
1338 	u32  prior_delivered;	/* tp->delivered at "prior_mstamp" */
1339 	u32  prior_delivered_ce;/* tp->delivered_ce at "prior_mstamp" */
1340 	s32  delivered;		/* number of packets delivered over interval */
1341 	s32  delivered_ce;	/* number of packets delivered w/ CE marks*/
1342 	long interval_us;	/* time for tp->delivered to incr "delivered" */
1343 	u32 snd_interval_us;	/* snd interval for delivered packets */
1344 	u32 rcv_interval_us;	/* rcv interval for delivered packets */
1345 	long rtt_us;		/* RTT of last (S)ACKed packet (or -1) */
1346 	int  losses;		/* number of packets marked lost upon ACK */
1347 	u32  acked_sacked;	/* number of packets newly (S)ACKed upon ACK */
1348 	u32  prior_in_flight;	/* in flight before this ACK */
1349 	u32  last_end_seq;	/* end_seq of most recently ACKed packet */
1350 	bool is_app_limited;	/* is sample from packet with bubble in pipe? */
1351 	bool is_retrans;	/* is sample from retransmission? */
1352 	bool is_ack_delayed;	/* is this (likely) a delayed ACK? */
1353 };
1354 
1355 struct tcp_congestion_ops {
1356 /* fast path fields are put first to fill one cache line */
1357 
1358 	/* A congestion control (CC) must provide one of either:
1359 	 *
1360 	 * (a) a cong_avoid function, if the CC wants to use the core TCP
1361 	 *     stack's default functionality to implement a "classic"
1362 	 *     (Reno/CUBIC-style) response to packet loss, RFC3168 ECN,
1363 	 *     idle periods, pacing rate computations, etc.
1364 	 *
1365 	 * (b) a cong_control function, if the CC wants custom behavior and
1366 	 *      complete control of all congestion control behaviors.
1367 	 */
1368 	/* (a) "classic" response: calculate new cwnd.
1369 	 */
1370 	void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
1371 	/* (b) "custom" response: call when packets are delivered to update
1372 	 * cwnd and pacing rate, after all the ca_state processing.
1373 	 */
1374 	void (*cong_control)(struct sock *sk, u32 ack, int flag, const struct rate_sample *rs);
1375 
1376 	/* return slow start threshold (required) */
1377 	u32 (*ssthresh)(struct sock *sk);
1378 
1379 	/* call before changing ca_state (optional) */
1380 	void (*set_state)(struct sock *sk, u8 new_state);
1381 
1382 	/* call when cwnd event occurs (optional) */
1383 	void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
1384 
1385 	/* call when CA_EVENT_TX_START cwnd event occurs (optional) */
1386 	void (*cwnd_event_tx_start)(struct sock *sk);
1387 
1388 	/* call when ack arrives (optional) */
1389 	void (*in_ack_event)(struct sock *sk, u32 flags);
1390 
1391 	/* hook for packet ack accounting (optional) */
1392 	void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
1393 
1394 	/* Override tcp_tso_autosize() (optional)
1395 	 *
1396 	 * If provided, this callback supplies the TSO segment target count
1397 	 * instead of using tcp_tso_autosize(). The returned value is
1398 	 * subsequently clamped to [1, sk->sk_gso_max_segs] by the caller.
1399 	 *
1400 	 * For the kernel callback path, mss_now originates from
1401 	 * tcp_current_mss() and should never be zero.
1402 	 */
1403 	u32 (*tso_segs)(struct sock *sk, u32 mss_now);
1404 
1405 	/* new value of cwnd after loss (required) */
1406 	u32  (*undo_cwnd)(struct sock *sk);
1407 	/* returns the multiplier used in tcp_sndbuf_expand (optional) */
1408 	u32 (*sndbuf_expand)(struct sock *sk);
1409 
1410 /* control/slow paths put last */
1411 	/* get info for inet_diag (optional) */
1412 	size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
1413 			   union tcp_cc_info *info);
1414 
1415 	char 			name[TCP_CA_NAME_MAX];
1416 	struct module		*owner;
1417 	struct list_head	list;
1418 	u32			key;
1419 	u32			flags;
1420 
1421 	/* initialize private data (optional) */
1422 	void (*init)(struct sock *sk);
1423 	/* cleanup private data  (optional) */
1424 	void (*release)(struct sock *sk);
1425 } ____cacheline_aligned_in_smp;
1426 
1427 int tcp_register_congestion_control(struct tcp_congestion_ops *type);
1428 void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
1429 int tcp_update_congestion_control(struct tcp_congestion_ops *type,
1430 				  struct tcp_congestion_ops *old_type);
1431 int tcp_validate_congestion_control(struct tcp_congestion_ops *ca);
1432 
1433 void tcp_assign_congestion_control(struct sock *sk);
1434 void tcp_init_congestion_control(struct sock *sk);
1435 void tcp_cleanup_congestion_control(struct sock *sk);
1436 int tcp_set_default_congestion_control(struct net *net, const char *name);
1437 void tcp_get_default_congestion_control(struct net *net, char *name);
1438 void tcp_get_available_congestion_control(char *buf, size_t len);
1439 void tcp_get_allowed_congestion_control(char *buf, size_t len);
1440 int tcp_set_allowed_congestion_control(char *allowed);
1441 int tcp_set_congestion_control(struct sock *sk, const char *name, bool load,
1442 			       bool cap_net_admin);
1443 u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
1444 void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
1445 
1446 u32 tcp_reno_ssthresh(struct sock *sk);
1447 u32 tcp_reno_undo_cwnd(struct sock *sk);
1448 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
1449 extern struct tcp_congestion_ops tcp_reno;
1450 
1451 struct tcp_congestion_ops *tcp_ca_find(const char *name);
1452 struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
1453 u32 tcp_ca_get_key_by_name(const char *name, bool *ecn_ca);
1454 #ifdef CONFIG_INET
1455 char *tcp_ca_get_name_by_key(u32 key, char *buffer);
1456 #else
1457 static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
1458 {
1459 	return NULL;
1460 }
1461 #endif
1462 
1463 static inline bool tcp_ca_needs_ecn(const struct sock *sk)
1464 {
1465 	const struct inet_connection_sock *icsk = inet_csk(sk);
1466 
1467 	return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
1468 }
1469 
1470 static inline bool tcp_ca_needs_accecn(const struct sock *sk)
1471 {
1472 	const struct inet_connection_sock *icsk = inet_csk(sk);
1473 
1474 	return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ACCECN;
1475 }
1476 
1477 static inline bool tcp_ca_ect_1_negotiation(const struct sock *sk)
1478 {
1479 	const struct inet_connection_sock *icsk = inet_csk(sk);
1480 
1481 	return icsk->icsk_ca_ops->flags & TCP_CONG_ECT_1_NEGOTIATION;
1482 }
1483 
1484 static inline bool tcp_ca_no_fallback_rfc3168(const struct sock *sk)
1485 {
1486 	const struct inet_connection_sock *icsk = inet_csk(sk);
1487 
1488 	return icsk->icsk_ca_ops->flags & TCP_CONG_NO_FALLBACK_RFC3168;
1489 }
1490 
1491 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
1492 {
1493 	const struct inet_connection_sock *icsk = inet_csk(sk);
1494 
1495 	if (event == CA_EVENT_TX_START) {
1496 		if (icsk->icsk_ca_ops->cwnd_event_tx_start)
1497 			icsk->icsk_ca_ops->cwnd_event_tx_start(sk);
1498 		return;
1499 	}
1500 	if (icsk->icsk_ca_ops->cwnd_event)
1501 		icsk->icsk_ca_ops->cwnd_event(sk, event);
1502 }
1503 
1504 /* From tcp_cong.c */
1505 void tcp_set_ca_state(struct sock *sk, const u8 ca_state);
1506 
1507 
1508 static inline bool tcp_skb_sent_after(u64 t1, u64 t2, u32 seq1, u32 seq2)
1509 {
1510 	return t1 > t2 || (t1 == t2 && after(seq1, seq2));
1511 }
1512 
1513 /* These functions determine how the current flow behaves in respect of SACK
1514  * handling. SACK is negotiated with the peer, and therefore it can vary
1515  * between different flows.
1516  *
1517  * tcp_is_sack - SACK enabled
1518  * tcp_is_reno - No SACK
1519  */
1520 static inline int tcp_is_sack(const struct tcp_sock *tp)
1521 {
1522 	return likely(tp->rx_opt.sack_ok);
1523 }
1524 
1525 static inline bool tcp_is_reno(const struct tcp_sock *tp)
1526 {
1527 	return !tcp_is_sack(tp);
1528 }
1529 
1530 static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
1531 {
1532 	return tp->sacked_out + tp->lost_out;
1533 }
1534 
1535 /* This determines how many packets are "in the network" to the best
1536  * of our knowledge.  In many cases it is conservative, but where
1537  * detailed information is available from the receiver (via SACK
1538  * blocks etc.) we can make more aggressive calculations.
1539  *
1540  * Use this for decisions involving congestion control, use just
1541  * tp->packets_out to determine if the send queue is empty or not.
1542  *
1543  * Read this equation as:
1544  *
1545  *	"Packets sent once on transmission queue" MINUS
1546  *	"Packets left network, but not honestly ACKed yet" PLUS
1547  *	"Packets fast retransmitted"
1548  */
1549 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
1550 {
1551 	return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
1552 }
1553 
1554 #define TCP_INFINITE_SSTHRESH	0x7fffffff
1555 
1556 static inline u32 tcp_snd_cwnd(const struct tcp_sock *tp)
1557 {
1558 	return tp->snd_cwnd;
1559 }
1560 
1561 static inline void tcp_snd_cwnd_set(struct tcp_sock *tp, u32 val)
1562 {
1563 	WARN_ON_ONCE((int)val <= 0);
1564 	WRITE_ONCE(tp->snd_cwnd, val);
1565 }
1566 
1567 static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
1568 {
1569 	return tcp_snd_cwnd(tp) < tp->snd_ssthresh;
1570 }
1571 
1572 static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
1573 {
1574 	return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
1575 }
1576 
1577 static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
1578 {
1579 	return (TCPF_CA_CWR | TCPF_CA_Recovery) &
1580 	       (1 << inet_csk(sk)->icsk_ca_state);
1581 }
1582 
1583 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
1584  * The exception is cwnd reduction phase, when cwnd is decreasing towards
1585  * ssthresh.
1586  */
1587 static inline __u32 tcp_current_ssthresh(const struct sock *sk)
1588 {
1589 	const struct tcp_sock *tp = tcp_sk(sk);
1590 
1591 	if (tcp_in_cwnd_reduction(sk))
1592 		return tp->snd_ssthresh;
1593 	else
1594 		return max(tp->snd_ssthresh,
1595 			   ((tcp_snd_cwnd(tp) >> 1) +
1596 			    (tcp_snd_cwnd(tp) >> 2)));
1597 }
1598 
1599 /* Use define here intentionally to get WARN_ON location shown at the caller */
1600 #define tcp_verify_left_out(tp)	WARN_ON(tcp_left_out(tp) > tp->packets_out)
1601 
1602 void tcp_enter_cwr(struct sock *sk);
1603 __u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
1604 
1605 /* The maximum number of MSS of available cwnd for which TSO defers
1606  * sending if not using sysctl_tcp_tso_win_divisor.
1607  */
1608 static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1609 {
1610 	return 3;
1611 }
1612 
1613 /* Returns end sequence number of the receiver's advertised window */
1614 static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1615 {
1616 	return tp->snd_una + tp->snd_wnd;
1617 }
1618 
1619 /* We follow the spirit of RFC2861 to validate cwnd but implement a more
1620  * flexible approach. The RFC suggests cwnd should not be raised unless
1621  * it was fully used previously. And that's exactly what we do in
1622  * congestion avoidance mode. But in slow start we allow cwnd to grow
1623  * as long as the application has used half the cwnd.
1624  * Example :
1625  *    cwnd is 10 (IW10), but application sends 9 frames.
1626  *    We allow cwnd to reach 18 when all frames are ACKed.
1627  * This check is safe because it's as aggressive as slow start which already
1628  * risks 100% overshoot. The advantage is that we discourage application to
1629  * either send more filler packets or data to artificially blow up the cwnd
1630  * usage, and allow application-limited process to probe bw more aggressively.
1631  */
1632 static inline bool tcp_is_cwnd_limited(const struct sock *sk)
1633 {
1634 	const struct tcp_sock *tp = tcp_sk(sk);
1635 
1636 	if (tp->is_cwnd_limited)
1637 		return true;
1638 
1639 	/* If in slow start, ensure cwnd grows to twice what was ACKed. */
1640 	if (tcp_in_slow_start(tp))
1641 		return tcp_snd_cwnd(tp) < 2 * tp->max_packets_out;
1642 
1643 	return false;
1644 }
1645 
1646 /* BBR congestion control needs pacing.
1647  * Same remark for SO_MAX_PACING_RATE.
1648  * sch_fq packet scheduler is efficiently handling pacing,
1649  * but is not always installed/used.
1650  * Return true if TCP stack should pace packets itself.
1651  */
1652 static inline bool tcp_needs_internal_pacing(const struct sock *sk)
1653 {
1654 	return smp_load_acquire(&sk->sk_pacing_status) == SK_PACING_NEEDED;
1655 }
1656 
1657 /* Estimates in how many jiffies next packet for this flow can be sent.
1658  * Scheduling a retransmit timer too early would be silly.
1659  */
1660 static inline unsigned long tcp_pacing_delay(const struct sock *sk)
1661 {
1662 	s64 delay = tcp_sk(sk)->tcp_wstamp_ns - tcp_sk(sk)->tcp_clock_cache;
1663 
1664 	return delay > 0 ? nsecs_to_jiffies(delay) : 0;
1665 }
1666 
1667 static inline void tcp_reset_xmit_timer(struct sock *sk,
1668 					const int what,
1669 					unsigned long when,
1670 					bool pace_delay)
1671 {
1672 	if (pace_delay)
1673 		when += tcp_pacing_delay(sk);
1674 	inet_csk_reset_xmit_timer(sk, what, when,
1675 				  tcp_rto_max(sk));
1676 }
1677 
1678 /* Something is really bad, we could not queue an additional packet,
1679  * because qdisc is full or receiver sent a 0 window, or we are paced.
1680  * We do not want to add fuel to the fire, or abort too early,
1681  * so make sure the timer we arm now is at least 200ms in the future,
1682  * regardless of current icsk_rto value (as it could be ~2ms)
1683  */
1684 static inline unsigned long tcp_probe0_base(const struct sock *sk)
1685 {
1686 	return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1687 }
1688 
1689 /* Variant of inet_csk_rto_backoff() used for zero window probes */
1690 static inline unsigned long tcp_probe0_when(const struct sock *sk,
1691 					    unsigned long max_when)
1692 {
1693 	u8 backoff = min_t(u8, ilog2(TCP_RTO_MAX / TCP_RTO_MIN) + 1,
1694 			   inet_csk(sk)->icsk_backoff);
1695 	u64 when = (u64)tcp_probe0_base(sk) << backoff;
1696 
1697 	return (unsigned long)min_t(u64, when, max_when);
1698 }
1699 
1700 static inline void tcp_check_probe_timer(struct sock *sk)
1701 {
1702 	if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
1703 		tcp_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
1704 				     tcp_probe0_base(sk), true);
1705 }
1706 
1707 static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
1708 {
1709 	tp->snd_wl1 = seq;
1710 }
1711 
1712 static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
1713 {
1714 	tp->snd_wl1 = seq;
1715 }
1716 
1717 /*
1718  * Calculate(/check) TCP checksum
1719  */
1720 static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1721 				   __be32 daddr, __wsum base)
1722 {
1723 	return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_TCP, base);
1724 }
1725 
1726 static inline bool tcp_checksum_complete(struct sk_buff *skb)
1727 {
1728 	return !skb_csum_unnecessary(skb) &&
1729 		__skb_checksum_complete(skb);
1730 }
1731 
1732 enum skb_drop_reason tcp_add_backlog(struct sock *sk, struct sk_buff *skb);
1733 
1734 static inline enum skb_drop_reason
1735 tcp_filter(struct sock *sk, struct sk_buff *skb)
1736 {
1737 	const struct tcphdr *th = (const struct tcphdr *)skb->data;
1738 
1739 	return sk_filter_trim_cap(sk, skb, __tcp_hdrlen(th));
1740 }
1741 
1742 void tcp_set_state(struct sock *sk, int state);
1743 void tcp_done(struct sock *sk);
1744 int tcp_abort(struct sock *sk, int err);
1745 
1746 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1747 {
1748 	rx_opt->dsack = 0;
1749 	rx_opt->num_sacks = 0;
1750 }
1751 
1752 void tcp_cwnd_restart(struct sock *sk, s32 delta);
1753 
1754 static inline void tcp_slow_start_after_idle_check(struct sock *sk)
1755 {
1756 	const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
1757 	struct tcp_sock *tp = tcp_sk(sk);
1758 	s32 delta;
1759 
1760 	if (!READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle) ||
1761 	    tp->packets_out || ca_ops->cong_control)
1762 		return;
1763 	delta = tcp_jiffies32 - tp->lsndtime;
1764 	if (delta > inet_csk(sk)->icsk_rto)
1765 		tcp_cwnd_restart(sk, delta);
1766 }
1767 
1768 /* Determine a window scaling and initial window to offer. */
1769 void tcp_select_initial_window(const struct sock *sk, int __space,
1770 			       __u32 mss, __u32 *rcv_wnd,
1771 			       __u32 *window_clamp, int wscale_ok,
1772 			       __u8 *rcv_wscale, __u32 init_rcv_wnd);
1773 
1774 static inline int __tcp_win_from_space(u8 scaling_ratio, int space)
1775 {
1776 	s64 scaled_space = (s64)space * scaling_ratio;
1777 
1778 	return scaled_space >> TCP_RMEM_TO_WIN_SCALE;
1779 }
1780 
1781 static inline int tcp_win_from_space(const struct sock *sk, int space)
1782 {
1783 	return __tcp_win_from_space(tcp_sk(sk)->scaling_ratio, space);
1784 }
1785 
1786 /* inverse of __tcp_win_from_space() */
1787 static inline int __tcp_space_from_win(u8 scaling_ratio, int win)
1788 {
1789 	u64 val = (u64)win << TCP_RMEM_TO_WIN_SCALE;
1790 
1791 	do_div(val, scaling_ratio);
1792 	return val;
1793 }
1794 
1795 static inline int tcp_space_from_win(const struct sock *sk, int win)
1796 {
1797 	return __tcp_space_from_win(tcp_sk(sk)->scaling_ratio, win);
1798 }
1799 
1800 /* Assume a 50% default for skb->len/skb->truesize ratio.
1801  * This may be adjusted later in tcp_measure_rcv_mss().
1802  */
1803 #define TCP_DEFAULT_SCALING_RATIO (1 << (TCP_RMEM_TO_WIN_SCALE - 1))
1804 
1805 static inline void tcp_scaling_ratio_init(struct sock *sk)
1806 {
1807 	tcp_sk(sk)->scaling_ratio = TCP_DEFAULT_SCALING_RATIO;
1808 }
1809 
1810 /* Note: caller must be prepared to deal with negative returns */
1811 static inline int tcp_space(const struct sock *sk)
1812 {
1813 	return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) -
1814 				  READ_ONCE(sk->sk_backlog.len) -
1815 				  atomic_read(&sk->sk_rmem_alloc));
1816 }
1817 
1818 static inline int tcp_full_space(const struct sock *sk)
1819 {
1820 	return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf));
1821 }
1822 
1823 static inline u32 tcp_dst_advmss(const struct dst_entry *dst)
1824 {
1825 	return max_t(u32, dst_metric_advmss(dst), TCP_MIN_MSS);
1826 }
1827 
1828 static inline void __tcp_adjust_rcv_ssthresh(struct sock *sk, u32 new_ssthresh)
1829 {
1830 	int unused_mem = sk_unused_reserved_mem(sk);
1831 	struct tcp_sock *tp = tcp_sk(sk);
1832 
1833 	tp->rcv_ssthresh = min(tp->rcv_ssthresh, new_ssthresh);
1834 	if (unused_mem)
1835 		tp->rcv_ssthresh = max_t(u32, tp->rcv_ssthresh,
1836 					 tcp_win_from_space(sk, unused_mem));
1837 }
1838 
1839 static inline void tcp_adjust_rcv_ssthresh(struct sock *sk)
1840 {
1841 	__tcp_adjust_rcv_ssthresh(sk, 4U * tcp_sk(sk)->advmss);
1842 }
1843 
1844 void tcp_cleanup_rbuf(struct sock *sk, int copied);
1845 void __tcp_cleanup_rbuf(struct sock *sk, int copied);
1846 
1847 
1848 /* We provision sk_rcvbuf around 200% of sk_rcvlowat.
1849  * If 87.5 % (7/8) of the space has been consumed, we want to override
1850  * SO_RCVLOWAT constraint, since we are receiving skbs with too small
1851  * len/truesize ratio.
1852  */
1853 static inline bool tcp_rmem_pressure(const struct sock *sk)
1854 {
1855 	int rcvbuf, threshold;
1856 
1857 	if (tcp_under_memory_pressure(sk))
1858 		return true;
1859 
1860 	rcvbuf = READ_ONCE(sk->sk_rcvbuf);
1861 	threshold = rcvbuf - (rcvbuf >> 3);
1862 
1863 	return atomic_read(&sk->sk_rmem_alloc) > threshold;
1864 }
1865 
1866 static inline bool tcp_epollin_ready(const struct sock *sk, int target)
1867 {
1868 	const struct tcp_sock *tp = tcp_sk(sk);
1869 	int avail = READ_ONCE(tp->rcv_nxt) - READ_ONCE(tp->copied_seq);
1870 
1871 	if (avail <= 0)
1872 		return false;
1873 
1874 	return (avail >= target) || tcp_rmem_pressure(sk) ||
1875 	       (tcp_receive_window(tp) <= inet_csk(sk)->icsk_ack.rcv_mss);
1876 }
1877 
1878 extern void tcp_openreq_init_rwin(struct request_sock *req,
1879 				  const struct sock *sk_listener,
1880 				  const struct dst_entry *dst);
1881 
1882 void tcp_enter_memory_pressure(struct sock *sk);
1883 void tcp_leave_memory_pressure(struct sock *sk);
1884 
1885 static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1886 {
1887 	struct net *net = sock_net((struct sock *)tp);
1888 	int val;
1889 
1890 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepintvl()
1891 	 * and do_tcp_setsockopt().
1892 	 */
1893 	val = READ_ONCE(tp->keepalive_intvl);
1894 
1895 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_intvl);
1896 }
1897 
1898 static inline int keepalive_time_when(const struct tcp_sock *tp)
1899 {
1900 	struct net *net = sock_net((struct sock *)tp);
1901 	int val;
1902 
1903 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepidle_locked() */
1904 	val = READ_ONCE(tp->keepalive_time);
1905 
1906 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_time);
1907 }
1908 
1909 static inline int keepalive_probes(const struct tcp_sock *tp)
1910 {
1911 	struct net *net = sock_net((struct sock *)tp);
1912 	int val;
1913 
1914 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepcnt()
1915 	 * and do_tcp_setsockopt().
1916 	 */
1917 	val = READ_ONCE(tp->keepalive_probes);
1918 
1919 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_probes);
1920 }
1921 
1922 static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1923 {
1924 	const struct inet_connection_sock *icsk = &tp->inet_conn;
1925 
1926 	return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
1927 			  tcp_jiffies32 - tp->rcv_tstamp);
1928 }
1929 
1930 static inline int tcp_fin_time(const struct sock *sk)
1931 {
1932 	int fin_timeout = tcp_sk(sk)->linger2 ? :
1933 		READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_fin_timeout);
1934 	const int rto = inet_csk(sk)->icsk_rto;
1935 
1936 	if (fin_timeout < (rto << 2) - (rto >> 1))
1937 		fin_timeout = (rto << 2) - (rto >> 1);
1938 
1939 	return fin_timeout;
1940 }
1941 
1942 static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1943 				  int paws_win)
1944 {
1945 	if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
1946 		return true;
1947 	if (unlikely(!time_before32(ktime_get_seconds(),
1948 				    rx_opt->ts_recent_stamp + TCP_PAWS_WRAP)))
1949 		return true;
1950 	/*
1951 	 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1952 	 * then following tcp messages have valid values. Ignore 0 value,
1953 	 * or else 'negative' tsval might forbid us to accept their packets.
1954 	 */
1955 	if (!rx_opt->ts_recent)
1956 		return true;
1957 	return false;
1958 }
1959 
1960 static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1961 				   int rst)
1962 {
1963 	if (tcp_paws_check(rx_opt, 0))
1964 		return false;
1965 
1966 	/* RST segments are not recommended to carry timestamp,
1967 	   and, if they do, it is recommended to ignore PAWS because
1968 	   "their cleanup function should take precedence over timestamps."
1969 	   Certainly, it is mistake. It is necessary to understand the reasons
1970 	   of this constraint to relax it: if peer reboots, clock may go
1971 	   out-of-sync and half-open connections will not be reset.
1972 	   Actually, the problem would be not existing if all
1973 	   the implementations followed draft about maintaining clock
1974 	   via reboots. Linux-2.2 DOES NOT!
1975 
1976 	   However, we can relax time bounds for RST segments to MSL.
1977 	 */
1978 	if (rst && !time_before32(ktime_get_seconds(),
1979 				  rx_opt->ts_recent_stamp + TCP_PAWS_MSL))
1980 		return false;
1981 	return true;
1982 }
1983 
1984 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
1985 {
1986 	u32 ace;
1987 
1988 	/* mptcp hooks are only on the slow path */
1989 	if (sk_is_mptcp((struct sock *)tp))
1990 		return;
1991 
1992 	ace = tcp_ecn_mode_accecn(tp) ?
1993 	      ((tp->delivered_ce + TCP_ACCECN_CEP_INIT_OFFSET) &
1994 	       TCP_ACCECN_CEP_ACE_MASK) : 0;
1995 
1996 	tp->pred_flags = htonl((tp->tcp_header_len << 26) |
1997 			       (ace << 22) |
1998 			       ntohl(TCP_FLAG_ACK) |
1999 			       snd_wnd);
2000 }
2001 
2002 static inline void tcp_fast_path_on(struct tcp_sock *tp)
2003 {
2004 	__tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
2005 }
2006 
2007 static inline void tcp_fast_path_check(struct sock *sk)
2008 {
2009 	struct tcp_sock *tp = tcp_sk(sk);
2010 
2011 	if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
2012 	    tp->rcv_wnd &&
2013 	    atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
2014 	    !tp->urg_data)
2015 		tcp_fast_path_on(tp);
2016 }
2017 
2018 bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
2019 			  int mib_idx, u32 *last_oow_ack_time);
2020 void tcp_reqsk_send_challenge_ack(struct sock *sk, struct sk_buff *skb,
2021 				  struct request_sock *req);
2022 
2023 static inline void tcp_mib_init(struct net *net)
2024 {
2025 	/* See RFC 2012 */
2026 	TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
2027 	TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
2028 	TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
2029 	TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
2030 }
2031 
2032 /* from STCP */
2033 static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
2034 {
2035 	tp->retransmit_skb_hint = NULL;
2036 }
2037 
2038 #define tcp_md5_addr tcp_ao_addr
2039 
2040 /* - key database */
2041 struct tcp_md5sig_key {
2042 	struct hlist_node	node;
2043 	u8			keylen;
2044 	u8			family; /* AF_INET or AF_INET6 */
2045 	u8			prefixlen;
2046 	u8			flags;
2047 	union tcp_md5_addr	addr;
2048 	int			l3index; /* set if key added with L3 scope */
2049 	u8			key[TCP_MD5SIG_MAXKEYLEN];
2050 	struct rcu_head		rcu;
2051 };
2052 
2053 /* - sock block */
2054 struct tcp_md5sig_info {
2055 	struct hlist_head	head;
2056 	struct rcu_head		rcu;
2057 };
2058 
2059 /* - pseudo header */
2060 struct tcp4_pseudohdr {
2061 	__be32		saddr;
2062 	__be32		daddr;
2063 	__u8		pad;
2064 	__u8		protocol;
2065 	__be16		len;
2066 };
2067 
2068 struct tcp6_pseudohdr {
2069 	struct in6_addr	saddr;
2070 	struct in6_addr daddr;
2071 	__be32		len;
2072 	__be32		protocol;	/* including padding */
2073 };
2074 
2075 void tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
2076 			 const struct sock *sk, const struct sk_buff *skb);
2077 int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
2078 		   int family, u8 prefixlen, int l3index, u8 flags,
2079 		   const u8 *newkey, u8 newkeylen);
2080 int tcp_md5_key_copy(struct sock *sk, const union tcp_md5_addr *addr,
2081 		     int family, u8 prefixlen, int l3index,
2082 		     struct tcp_md5sig_key *key);
2083 
2084 int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
2085 		   int family, u8 prefixlen, int l3index, u8 flags);
2086 void tcp_clear_md5_list(struct sock *sk);
2087 struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
2088 					 const struct sock *addr_sk);
2089 
2090 #ifdef CONFIG_TCP_MD5SIG
2091 struct tcp_md5sig_key *__tcp_md5_do_lookup(const struct sock *sk, int l3index,
2092 					   const union tcp_md5_addr *addr,
2093 					   int family, bool any_l3index);
2094 static inline struct tcp_md5sig_key *
2095 tcp_md5_do_lookup(const struct sock *sk, int l3index,
2096 		  const union tcp_md5_addr *addr, int family)
2097 {
2098 	if (!static_branch_unlikely(&tcp_md5_needed.key))
2099 		return NULL;
2100 	return __tcp_md5_do_lookup(sk, l3index, addr, family, false);
2101 }
2102 
2103 static inline struct tcp_md5sig_key *
2104 tcp_md5_do_lookup_any_l3index(const struct sock *sk,
2105 			      const union tcp_md5_addr *addr, int family)
2106 {
2107 	if (!static_branch_unlikely(&tcp_md5_needed.key))
2108 		return NULL;
2109 	return __tcp_md5_do_lookup(sk, 0, addr, family, true);
2110 }
2111 
2112 #define tcp_twsk_md5_key(twsk)	((twsk)->tw_md5_key)
2113 void tcp_md5_destruct_sock(struct sock *sk);
2114 #else
2115 static inline struct tcp_md5sig_key *
2116 tcp_md5_do_lookup(const struct sock *sk, int l3index,
2117 		  const union tcp_md5_addr *addr, int family)
2118 {
2119 	return NULL;
2120 }
2121 
2122 static inline struct tcp_md5sig_key *
2123 tcp_md5_do_lookup_any_l3index(const struct sock *sk,
2124 			      const union tcp_md5_addr *addr, int family)
2125 {
2126 	return NULL;
2127 }
2128 
2129 #define tcp_twsk_md5_key(twsk)	NULL
2130 static inline void tcp_md5_destruct_sock(struct sock *sk)
2131 {
2132 }
2133 #endif
2134 
2135 struct md5_ctx;
2136 void tcp_md5_hash_skb_data(struct md5_ctx *ctx, const struct sk_buff *skb,
2137 			   unsigned int header_len);
2138 void tcp_md5_hash_key(struct md5_ctx *ctx, const struct tcp_md5sig_key *key);
2139 
2140 /* From tcp_fastopen.c */
2141 void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
2142 			    struct tcp_fastopen_cookie *cookie);
2143 void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
2144 			    struct tcp_fastopen_cookie *cookie, bool syn_lost,
2145 			    u16 try_exp);
2146 struct tcp_fastopen_request {
2147 	/* Fast Open cookie. Size 0 means a cookie request */
2148 	struct tcp_fastopen_cookie	cookie;
2149 	struct msghdr			*data;  /* data in MSG_FASTOPEN */
2150 	size_t				size;
2151 	int				copied;	/* queued in tcp_connect() */
2152 	struct ubuf_info		*uarg;
2153 };
2154 void tcp_free_fastopen_req(struct tcp_sock *tp);
2155 void tcp_fastopen_destroy_cipher(struct sock *sk);
2156 void tcp_fastopen_ctx_destroy(struct net *net);
2157 int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk,
2158 			      void *primary_key, void *backup_key);
2159 int tcp_fastopen_get_cipher(struct net *net, struct inet_connection_sock *icsk,
2160 			    u64 *key);
2161 void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
2162 struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
2163 			      struct request_sock *req,
2164 			      struct tcp_fastopen_cookie *foc,
2165 			      const struct dst_entry *dst);
2166 void tcp_fastopen_init_key_once(struct net *net);
2167 bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
2168 			     struct tcp_fastopen_cookie *cookie);
2169 bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
2170 #define TCP_FASTOPEN_KEY_LENGTH sizeof(siphash_key_t)
2171 #define TCP_FASTOPEN_KEY_MAX 2
2172 #define TCP_FASTOPEN_KEY_BUF_LENGTH \
2173 	(TCP_FASTOPEN_KEY_LENGTH * TCP_FASTOPEN_KEY_MAX)
2174 
2175 /* Fastopen key context */
2176 struct tcp_fastopen_context {
2177 	siphash_key_t	key[TCP_FASTOPEN_KEY_MAX];
2178 	int		num;
2179 	struct rcu_head	rcu;
2180 };
2181 
2182 void tcp_fastopen_active_disable(struct sock *sk);
2183 bool tcp_fastopen_active_should_disable(struct sock *sk);
2184 void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
2185 void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired);
2186 
2187 /* Caller needs to wrap with rcu_read_(un)lock() */
2188 static inline
2189 struct tcp_fastopen_context *tcp_fastopen_get_ctx(const struct sock *sk)
2190 {
2191 	struct tcp_fastopen_context *ctx;
2192 
2193 	ctx = rcu_dereference(inet_csk(sk)->icsk_accept_queue.fastopenq.ctx);
2194 	if (!ctx)
2195 		ctx = rcu_dereference(sock_net(sk)->ipv4.tcp_fastopen_ctx);
2196 	return ctx;
2197 }
2198 
2199 static inline
2200 bool tcp_fastopen_cookie_match(const struct tcp_fastopen_cookie *foc,
2201 			       const struct tcp_fastopen_cookie *orig)
2202 {
2203 	if (orig->len == TCP_FASTOPEN_COOKIE_SIZE &&
2204 	    orig->len == foc->len &&
2205 	    !memcmp(orig->val, foc->val, foc->len))
2206 		return true;
2207 	return false;
2208 }
2209 
2210 static inline
2211 int tcp_fastopen_context_len(const struct tcp_fastopen_context *ctx)
2212 {
2213 	return ctx->num;
2214 }
2215 
2216 /* Latencies incurred by various limits for a sender. They are
2217  * chronograph-like stats that are mutually exclusive.
2218  */
2219 enum tcp_chrono {
2220 	TCP_CHRONO_UNSPEC,
2221 	TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
2222 	TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
2223 	TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
2224 	__TCP_CHRONO_MAX,
2225 };
2226 
2227 static inline void tcp_chrono_set(struct tcp_sock *tp, const enum tcp_chrono new)
2228 {
2229 	const u32 now = tcp_jiffies32;
2230 	enum tcp_chrono old = tp->chrono_type;
2231 
2232 	/* Following WRITE_ONCE()s pair with READ_ONCE()s in
2233 	 * tcp_get_info_chrono_stats().
2234 	 */
2235 	if (old > TCP_CHRONO_UNSPEC)
2236 		WRITE_ONCE(tp->chrono_stat[old - 1],
2237 			   tp->chrono_stat[old - 1] + now - tp->chrono_start);
2238 	WRITE_ONCE(tp->chrono_start, now);
2239 	WRITE_ONCE(tp->chrono_type, new);
2240 }
2241 
2242 static inline void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type)
2243 {
2244 	struct tcp_sock *tp = tcp_sk(sk);
2245 
2246 	/* If there are multiple conditions worthy of tracking in a
2247 	 * chronograph then the highest priority enum takes precedence
2248 	 * over the other conditions. So that if something "more interesting"
2249 	 * starts happening, stop the previous chrono and start a new one.
2250 	 */
2251 	if (type > tp->chrono_type)
2252 		tcp_chrono_set(tp, type);
2253 }
2254 
2255 void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);
2256 
2257 /* This helper is needed, because skb->tcp_tsorted_anchor uses
2258  * the same memory storage than skb->destructor/_skb_refdst
2259  */
2260 static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb)
2261 {
2262 	skb->destructor = NULL;
2263 	skb->_skb_refdst = 0UL;
2264 }
2265 
2266 #define tcp_skb_tsorted_save(skb) {		\
2267 	unsigned long _save = skb->_skb_refdst;	\
2268 	skb->_skb_refdst = 0UL;
2269 
2270 #define tcp_skb_tsorted_restore(skb)		\
2271 	skb->_skb_refdst = _save;		\
2272 }
2273 
2274 void tcp_write_queue_purge(struct sock *sk);
2275 
2276 static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk)
2277 {
2278 	return skb_rb_first(&sk->tcp_rtx_queue);
2279 }
2280 
2281 static inline struct sk_buff *tcp_rtx_queue_tail(const struct sock *sk)
2282 {
2283 	return skb_rb_last(&sk->tcp_rtx_queue);
2284 }
2285 
2286 static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
2287 {
2288 	return skb_peek_tail(&sk->sk_write_queue);
2289 }
2290 
2291 #define tcp_for_write_queue_from_safe(skb, tmp, sk)			\
2292 	skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
2293 
2294 static inline struct sk_buff *tcp_send_head(const struct sock *sk)
2295 {
2296 	return skb_peek(&sk->sk_write_queue);
2297 }
2298 
2299 static inline bool tcp_skb_is_last(const struct sock *sk,
2300 				   const struct sk_buff *skb)
2301 {
2302 	return skb_queue_is_last(&sk->sk_write_queue, skb);
2303 }
2304 
2305 /**
2306  * tcp_write_queue_empty - test if any payload (or FIN) is available in write queue
2307  * @sk: socket
2308  *
2309  * Since the write queue can have a temporary empty skb in it,
2310  * we must not use "return skb_queue_empty(&sk->sk_write_queue)"
2311  */
2312 static inline bool tcp_write_queue_empty(const struct sock *sk)
2313 {
2314 	const struct tcp_sock *tp = tcp_sk(sk);
2315 
2316 	return tp->write_seq == tp->snd_nxt;
2317 }
2318 
2319 static inline bool tcp_rtx_queue_empty(const struct sock *sk)
2320 {
2321 	return RB_EMPTY_ROOT(&sk->tcp_rtx_queue);
2322 }
2323 
2324 static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk)
2325 {
2326 	return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk);
2327 }
2328 
2329 static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
2330 {
2331 	__skb_queue_tail(&sk->sk_write_queue, skb);
2332 
2333 	/* Queue it, remembering where we must start sending. */
2334 	if (sk->sk_write_queue.next == skb)
2335 		tcp_chrono_start(sk, TCP_CHRONO_BUSY);
2336 }
2337 
2338 /* Insert new before skb on the write queue of sk.  */
2339 static inline void tcp_insert_write_queue_before(struct sk_buff *new,
2340 						  struct sk_buff *skb,
2341 						  struct sock *sk)
2342 {
2343 	__skb_queue_before(&sk->sk_write_queue, skb, new);
2344 }
2345 
2346 static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
2347 {
2348 	tcp_skb_tsorted_anchor_cleanup(skb);
2349 	__skb_unlink(skb, &sk->sk_write_queue);
2350 }
2351 
2352 void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb);
2353 
2354 static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk)
2355 {
2356 	tcp_skb_tsorted_anchor_cleanup(skb);
2357 	rb_erase(&skb->rbnode, &sk->tcp_rtx_queue);
2358 }
2359 
2360 static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk)
2361 {
2362 	list_del(&skb->tcp_tsorted_anchor);
2363 	tcp_rtx_queue_unlink(skb, sk);
2364 	tcp_wmem_free_skb(sk, skb);
2365 }
2366 
2367 static inline void tcp_write_collapse_fence(struct sock *sk)
2368 {
2369 	struct sk_buff *skb = tcp_write_queue_tail(sk) ?: tcp_rtx_queue_tail(sk);
2370 
2371 	if (skb)
2372 		TCP_SKB_CB(skb)->eor = 1;
2373 }
2374 
2375 static inline void tcp_push_pending_frames(struct sock *sk)
2376 {
2377 	if (tcp_send_head(sk)) {
2378 		struct tcp_sock *tp = tcp_sk(sk);
2379 
2380 		__tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
2381 	}
2382 }
2383 
2384 /* Start sequence of the skb just after the highest skb with SACKed
2385  * bit, valid only if sacked_out > 0 or when the caller has ensured
2386  * validity by itself.
2387  */
2388 static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
2389 {
2390 	if (!tp->sacked_out)
2391 		return tp->snd_una;
2392 
2393 	if (tp->highest_sack == NULL)
2394 		return tp->snd_nxt;
2395 
2396 	return TCP_SKB_CB(tp->highest_sack)->seq;
2397 }
2398 
2399 static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
2400 {
2401 	tcp_sk(sk)->highest_sack = skb_rb_next(skb);
2402 }
2403 
2404 static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
2405 {
2406 	return tcp_sk(sk)->highest_sack;
2407 }
2408 
2409 static inline void tcp_highest_sack_reset(struct sock *sk)
2410 {
2411 	tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk);
2412 }
2413 
2414 /* Called when old skb is about to be deleted and replaced by new skb */
2415 static inline void tcp_highest_sack_replace(struct sock *sk,
2416 					    struct sk_buff *old,
2417 					    struct sk_buff *new)
2418 {
2419 	if (old == tcp_highest_sack(sk))
2420 		tcp_sk(sk)->highest_sack = new;
2421 }
2422 
2423 /* This helper checks if socket has IP_TRANSPARENT set */
2424 static inline bool inet_sk_transparent(const struct sock *sk)
2425 {
2426 	switch (sk->sk_state) {
2427 	case TCP_TIME_WAIT:
2428 		return inet_twsk(sk)->tw_transparent;
2429 	case TCP_NEW_SYN_RECV:
2430 		return inet_rsk(inet_reqsk(sk))->no_srccheck;
2431 	}
2432 	return inet_test_bit(TRANSPARENT, sk);
2433 }
2434 
2435 /* Determines whether this is a thin stream (which may suffer from
2436  * increased latency). Used to trigger latency-reducing mechanisms.
2437  */
2438 static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
2439 {
2440 	return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
2441 }
2442 
2443 /* /proc */
2444 enum tcp_seq_states {
2445 	TCP_SEQ_STATE_LISTENING,
2446 	TCP_SEQ_STATE_ESTABLISHED,
2447 };
2448 
2449 void *tcp_seq_start(struct seq_file *seq, loff_t *pos);
2450 void *tcp_seq_next(struct seq_file *seq, void *v, loff_t *pos);
2451 void tcp_seq_stop(struct seq_file *seq, void *v);
2452 
2453 struct tcp_seq_afinfo {
2454 	sa_family_t			family;
2455 };
2456 
2457 struct tcp_iter_state {
2458 	struct seq_net_private	p;
2459 	enum tcp_seq_states	state;
2460 	struct sock		*syn_wait_sk;
2461 	int			bucket, offset, sbucket, num;
2462 	loff_t			last_pos;
2463 };
2464 
2465 extern struct request_sock_ops tcp_request_sock_ops;
2466 extern struct request_sock_ops tcp6_request_sock_ops;
2467 
2468 void tcp_v4_destroy_sock(struct sock *sk);
2469 
2470 struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
2471 				netdev_features_t features);
2472 struct sk_buff *tcp_gro_lookup(struct list_head *head, struct tcphdr *th);
2473 struct sk_buff *tcp_gro_receive(struct list_head *head, struct sk_buff *skb,
2474 				struct tcphdr *th);
2475 INDIRECT_CALLABLE_DECLARE(int tcp4_gro_complete(struct sk_buff *skb, int thoff));
2476 INDIRECT_CALLABLE_DECLARE(struct sk_buff *tcp4_gro_receive(struct list_head *head, struct sk_buff *skb));
2477 #ifdef CONFIG_INET
2478 void tcp_gro_complete(struct sk_buff *skb);
2479 #else
2480 static inline void tcp_gro_complete(struct sk_buff *skb) { }
2481 #endif
2482 
2483 static inline void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr,
2484 				       __be32 daddr)
2485 {
2486 	struct tcphdr *th = tcp_hdr(skb);
2487 
2488 	th->check = ~tcp_v4_check(skb->len, saddr, daddr, 0);
2489 	skb->csum_start = skb_transport_header(skb) - skb->head;
2490 	skb->csum_offset = offsetof(struct tcphdr, check);
2491 }
2492 
2493 static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
2494 {
2495 	struct net *net = sock_net((struct sock *)tp);
2496 	u32 val;
2497 
2498 	val = READ_ONCE(tp->notsent_lowat);
2499 
2500 	return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
2501 }
2502 
2503 bool tcp_stream_memory_free(const struct sock *sk, int wake);
2504 
2505 #ifdef CONFIG_PROC_FS
2506 int tcp4_proc_init(void);
2507 void tcp4_proc_exit(void);
2508 #endif
2509 
2510 int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
2511 int tcp_conn_request(struct request_sock_ops *rsk_ops,
2512 		     const struct tcp_request_sock_ops *af_ops,
2513 		     struct sock *sk, struct sk_buff *skb);
2514 
2515 /* TCP af-specific functions */
2516 struct tcp_sock_af_ops {
2517 #ifdef CONFIG_TCP_MD5SIG
2518 	struct tcp_md5sig_key	*(*md5_lookup) (const struct sock *sk,
2519 						const struct sock *addr_sk);
2520 	void		(*calc_md5_hash)(char *location,
2521 					 const struct tcp_md5sig_key *md5,
2522 					 const struct sock *sk,
2523 					 const struct sk_buff *skb);
2524 	int		(*md5_parse)(struct sock *sk,
2525 				     int optname,
2526 				     sockptr_t optval,
2527 				     int optlen);
2528 #endif
2529 #ifdef CONFIG_TCP_AO
2530 	int (*ao_parse)(struct sock *sk, int optname, sockptr_t optval, int optlen);
2531 	struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2532 					struct sock *addr_sk,
2533 					int sndid, int rcvid);
2534 	void (*ao_calc_key_sk)(struct tcp_ao_key *mkt, u8 *key,
2535 			       const struct sock *sk,
2536 			       __be32 sisn, __be32 disn, bool send);
2537 	int (*calc_ao_hash)(char *location, struct tcp_ao_key *ao,
2538 			    const struct sock *sk, const struct sk_buff *skb,
2539 			    const u8 *tkey, int hash_offset, u32 sne);
2540 #endif
2541 };
2542 
2543 struct tcp_request_sock_ops {
2544 	u16 mss_clamp;
2545 #ifdef CONFIG_TCP_MD5SIG
2546 	struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk,
2547 						 const struct sock *addr_sk);
2548 	void		(*calc_md5_hash) (char *location,
2549 					  const struct tcp_md5sig_key *md5,
2550 					  const struct sock *sk,
2551 					  const struct sk_buff *skb);
2552 #endif
2553 #ifdef CONFIG_TCP_AO
2554 	struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2555 					struct request_sock *req,
2556 					int sndid, int rcvid);
2557 	void (*ao_calc_key)(struct tcp_ao_key *mkt, u8 *key, struct request_sock *sk);
2558 	int (*ao_synack_hash)(char *ao_hash, struct tcp_ao_key *mkt,
2559 			      struct request_sock *req, const struct sk_buff *skb,
2560 			      int hash_offset, u32 sne);
2561 #endif
2562 #ifdef CONFIG_SYN_COOKIES
2563 	__u32 (*cookie_init_seq)(const struct sk_buff *skb,
2564 				 __u16 *mss);
2565 #endif
2566 	struct dst_entry *(*route_req)(const struct sock *sk,
2567 				       struct sk_buff *skb,
2568 				       struct flowi *fl,
2569 				       struct request_sock *req,
2570 				       u32 tw_isn);
2571 	union tcp_seq_and_ts_off (*init_seq_and_ts_off)(
2572 					const struct net *net,
2573 					const struct sk_buff *skb);
2574 	int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
2575 			   struct flowi *fl, struct request_sock *req,
2576 			   struct tcp_fastopen_cookie *foc,
2577 			   enum tcp_synack_type synack_type,
2578 			   struct sk_buff *syn_skb);
2579 };
2580 
2581 extern const struct tcp_request_sock_ops tcp_request_sock_ipv4_ops;
2582 #if IS_ENABLED(CONFIG_IPV6)
2583 extern const struct tcp_request_sock_ops tcp_request_sock_ipv6_ops;
2584 #endif
2585 
2586 #ifdef CONFIG_SYN_COOKIES
2587 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
2588 					 struct sk_buff *skb, __u16 *mss)
2589 {
2590 	return ops->cookie_init_seq(skb, mss);
2591 }
2592 #else
2593 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
2594 					 struct sk_buff *skb, __u16 *mss)
2595 {
2596 	return 0;
2597 }
2598 #endif
2599 
2600 #ifdef CONFIG_SYN_COOKIES
2601 static inline void cookie_record_sent(const struct sock *sk)
2602 {
2603 	tcp_synq_overflow(sk);
2604 	__NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
2605 }
2606 #else
2607 static inline void cookie_record_sent(const struct sock *sk)
2608 {
2609 }
2610 #endif
2611 
2612 struct tcp_key {
2613 	union {
2614 		struct {
2615 			struct tcp_ao_key *ao_key;
2616 			char *traffic_key;
2617 			u32 sne;
2618 			u8 rcv_next;
2619 		};
2620 		struct tcp_md5sig_key *md5_key;
2621 	};
2622 	enum {
2623 		TCP_KEY_NONE = 0,
2624 		TCP_KEY_MD5,
2625 		TCP_KEY_AO,
2626 	} type;
2627 };
2628 
2629 static inline void tcp_get_current_key(const struct sock *sk,
2630 				       struct tcp_key *out)
2631 {
2632 #if defined(CONFIG_TCP_AO) || defined(CONFIG_TCP_MD5SIG)
2633 	const struct tcp_sock *tp = tcp_sk(sk);
2634 #endif
2635 
2636 #ifdef CONFIG_TCP_AO
2637 	if (static_branch_unlikely(&tcp_ao_needed.key)) {
2638 		struct tcp_ao_info *ao;
2639 
2640 		ao = rcu_dereference_protected(tp->ao_info,
2641 					       lockdep_sock_is_held(sk));
2642 		if (ao) {
2643 			out->ao_key = READ_ONCE(ao->current_key);
2644 			out->type = TCP_KEY_AO;
2645 			return;
2646 		}
2647 	}
2648 #endif
2649 #ifdef CONFIG_TCP_MD5SIG
2650 	if (static_branch_unlikely(&tcp_md5_needed.key) &&
2651 	    rcu_access_pointer(tp->md5sig_info)) {
2652 		out->md5_key = tp->af_specific->md5_lookup(sk, sk);
2653 		if (out->md5_key) {
2654 			out->type = TCP_KEY_MD5;
2655 			return;
2656 		}
2657 	}
2658 #endif
2659 	out->type = TCP_KEY_NONE;
2660 }
2661 
2662 static inline bool tcp_key_is_md5(const struct tcp_key *key)
2663 {
2664 	if (static_branch_tcp_md5())
2665 		return key->type == TCP_KEY_MD5;
2666 	return false;
2667 }
2668 
2669 static inline bool tcp_key_is_ao(const struct tcp_key *key)
2670 {
2671 	if (static_branch_tcp_ao())
2672 		return key->type == TCP_KEY_AO;
2673 	return false;
2674 }
2675 
2676 int tcpv4_offload_init(void);
2677 
2678 void tcp_v4_init(void);
2679 void tcp_init(void);
2680 
2681 /* tcp_recovery.c */
2682 void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb);
2683 void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced);
2684 extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb,
2685 				u32 reo_wnd);
2686 extern bool tcp_rack_mark_lost(struct sock *sk);
2687 extern void tcp_rack_reo_timeout(struct sock *sk);
2688 
2689 /* tcp_plb.c */
2690 
2691 /*
2692  * Scaling factor for fractions in PLB. For example, tcp_plb_update_state
2693  * expects cong_ratio which represents fraction of traffic that experienced
2694  * congestion over a single RTT. In order to avoid floating point operations,
2695  * this fraction should be mapped to (1 << TCP_PLB_SCALE) and passed in.
2696  */
2697 #define TCP_PLB_SCALE 8
2698 
2699 /* State for PLB (Protective Load Balancing) for a single TCP connection. */
2700 struct tcp_plb_state {
2701 	u8	consec_cong_rounds:5, /* consecutive congested rounds */
2702 		unused:3;
2703 	u32	pause_until; /* jiffies32 when PLB can resume rerouting */
2704 };
2705 
2706 static inline void tcp_plb_init(const struct sock *sk,
2707 				struct tcp_plb_state *plb)
2708 {
2709 	plb->consec_cong_rounds = 0;
2710 	plb->pause_until = 0;
2711 }
2712 void tcp_plb_update_state(const struct sock *sk, struct tcp_plb_state *plb,
2713 			  const int cong_ratio);
2714 void tcp_plb_check_rehash(struct sock *sk, struct tcp_plb_state *plb);
2715 void tcp_plb_update_state_upon_rto(struct sock *sk, struct tcp_plb_state *plb);
2716 
2717 static inline void tcp_warn_once(const struct sock *sk, bool cond, const char *str)
2718 {
2719 	WARN_ONCE(cond,
2720 		  "%scwn:%u out:%u sacked:%u lost:%u retrans:%u tlp_high_seq:%u sk_state:%u ca_state:%u advmss:%u mss_cache:%u pmtu:%u\n",
2721 		  str,
2722 		  tcp_snd_cwnd(tcp_sk(sk)),
2723 		  tcp_sk(sk)->packets_out, tcp_sk(sk)->sacked_out,
2724 		  tcp_sk(sk)->lost_out, tcp_sk(sk)->retrans_out,
2725 		  tcp_sk(sk)->tlp_high_seq, sk->sk_state,
2726 		  inet_csk(sk)->icsk_ca_state,
2727 		  tcp_sk(sk)->advmss, tcp_sk(sk)->mss_cache,
2728 		  inet_csk(sk)->icsk_pmtu_cookie);
2729 }
2730 
2731 /* At how many usecs into the future should the RTO fire? */
2732 static inline s64 tcp_rto_delta_us(const struct sock *sk)
2733 {
2734 	const struct sk_buff *skb = tcp_rtx_queue_head(sk);
2735 	u32 rto = inet_csk(sk)->icsk_rto;
2736 
2737 	if (likely(skb)) {
2738 		u64 rto_time_stamp_us = tcp_skb_timestamp_us(skb) + jiffies_to_usecs(rto);
2739 
2740 		return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp;
2741 	} else {
2742 		tcp_warn_once(sk, 1, "rtx queue empty: ");
2743 		return jiffies_to_usecs(rto);
2744 	}
2745 
2746 }
2747 
2748 /*
2749  * Save and compile IPv4 options, return a pointer to it
2750  */
2751 static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net,
2752 							 struct sk_buff *skb)
2753 {
2754 	const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
2755 	struct ip_options_rcu *dopt = NULL;
2756 
2757 	if (opt->optlen) {
2758 		int opt_size = sizeof(*dopt) + opt->optlen;
2759 
2760 		dopt = kmalloc(opt_size, GFP_ATOMIC);
2761 		if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) {
2762 			kfree(dopt);
2763 			dopt = NULL;
2764 		}
2765 	}
2766 	return dopt;
2767 }
2768 
2769 /* locally generated TCP pure ACKs have skb->truesize == 2
2770  * (check tcp_send_ack() in net/ipv4/tcp_output.c )
2771  * This is much faster than dissecting the packet to find out.
2772  * (Think of GRE encapsulations, IPv4, IPv6, ...)
2773  */
2774 static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
2775 {
2776 	return skb->truesize == 2;
2777 }
2778 
2779 static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
2780 {
2781 	skb->truesize = 2;
2782 }
2783 
2784 static inline int tcp_inq(struct sock *sk)
2785 {
2786 	struct tcp_sock *tp = tcp_sk(sk);
2787 	int answ;
2788 
2789 	if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
2790 		answ = 0;
2791 	} else if (sock_flag(sk, SOCK_URGINLINE) ||
2792 		   !tp->urg_data ||
2793 		   before(tp->urg_seq, tp->copied_seq) ||
2794 		   !before(tp->urg_seq, tp->rcv_nxt)) {
2795 
2796 		answ = tp->rcv_nxt - tp->copied_seq;
2797 
2798 		/* Subtract 1, if FIN was received */
2799 		if (answ && sock_flag(sk, SOCK_DONE))
2800 			answ--;
2801 	} else {
2802 		answ = tp->urg_seq - tp->copied_seq;
2803 	}
2804 
2805 	return answ;
2806 }
2807 
2808 int tcp_peek_len(struct socket *sock);
2809 
2810 static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
2811 {
2812 	u16 segs_in;
2813 
2814 	segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2815 
2816 	/* We update these fields while other threads might
2817 	 * read them from tcp_get_info()
2818 	 */
2819 	WRITE_ONCE(tp->segs_in, tp->segs_in + segs_in);
2820 	if (skb->len > tcp_hdrlen(skb))
2821 		WRITE_ONCE(tp->data_segs_in, tp->data_segs_in + segs_in);
2822 }
2823 
2824 /*
2825  * TCP listen path runs lockless.
2826  * We forced "struct sock" to be const qualified to make sure
2827  * we don't modify one of its field by mistake.
2828  * Here, we increment sk_drops which is an atomic_t, so we can safely
2829  * make sock writable again.
2830  */
2831 static inline void tcp_listendrop(const struct sock *sk)
2832 {
2833 	sk_drops_inc((struct sock *)sk);
2834 	__NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
2835 }
2836 
2837 enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);
2838 
2839 /*
2840  * Interface for adding Upper Level Protocols over TCP
2841  */
2842 
2843 #define TCP_ULP_NAME_MAX	16
2844 #define TCP_ULP_MAX		128
2845 #define TCP_ULP_BUF_MAX		(TCP_ULP_NAME_MAX*TCP_ULP_MAX)
2846 
2847 struct tcp_ulp_ops {
2848 	struct list_head	list;
2849 
2850 	/* initialize ulp */
2851 	int (*init)(struct sock *sk);
2852 	/* update ulp */
2853 	void (*update)(struct sock *sk, struct proto *p,
2854 		       void (*write_space)(struct sock *sk));
2855 	/* cleanup ulp */
2856 	void (*release)(struct sock *sk);
2857 	/* diagnostic */
2858 	int (*get_info)(struct sock *sk, struct sk_buff *skb, bool net_admin);
2859 	size_t (*get_info_size)(const struct sock *sk, bool net_admin);
2860 	/* clone ulp */
2861 	void (*clone)(const struct request_sock *req, struct sock *newsk,
2862 		      const gfp_t priority);
2863 
2864 	char		name[TCP_ULP_NAME_MAX];
2865 	struct module	*owner;
2866 };
2867 int tcp_register_ulp(struct tcp_ulp_ops *type);
2868 void tcp_unregister_ulp(struct tcp_ulp_ops *type);
2869 int tcp_set_ulp(struct sock *sk, const char *name);
2870 void tcp_get_available_ulp(char *buf, size_t len);
2871 void tcp_cleanup_ulp(struct sock *sk);
2872 void tcp_update_ulp(struct sock *sk, struct proto *p,
2873 		    void (*write_space)(struct sock *sk));
2874 
2875 #define MODULE_ALIAS_TCP_ULP(name)				\
2876 	MODULE_INFO(alias, name);		\
2877 	MODULE_INFO(alias, "tcp-ulp-" name)
2878 
2879 #ifdef CONFIG_NET_SOCK_MSG
2880 struct sk_msg;
2881 struct sk_psock;
2882 
2883 #ifdef CONFIG_BPF_SYSCALL
2884 int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore);
2885 void tcp_bpf_clone(const struct sock *sk, struct sock *newsk);
2886 #ifdef CONFIG_BPF_STREAM_PARSER
2887 struct strparser;
2888 int tcp_bpf_strp_read_sock(struct strparser *strp, read_descriptor_t *desc,
2889 			   sk_read_actor_t recv_actor);
2890 #endif /* CONFIG_BPF_STREAM_PARSER */
2891 #endif /* CONFIG_BPF_SYSCALL */
2892 
2893 #ifdef CONFIG_INET
2894 void tcp_eat_skb(struct sock *sk, struct sk_buff *skb);
2895 #else
2896 static inline void tcp_eat_skb(struct sock *sk, struct sk_buff *skb)
2897 {
2898 }
2899 #endif
2900 
2901 int tcp_bpf_sendmsg_redir(struct sock *sk, bool ingress,
2902 			  struct sk_msg *msg, u32 bytes, int flags);
2903 #endif /* CONFIG_NET_SOCK_MSG */
2904 
2905 #if !defined(CONFIG_BPF_SYSCALL) || !defined(CONFIG_NET_SOCK_MSG)
2906 static inline void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
2907 {
2908 }
2909 #endif
2910 
2911 #ifdef CONFIG_CGROUP_BPF
2912 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2913 				      struct sk_buff *skb,
2914 				      unsigned int end_offset)
2915 {
2916 	skops->skb = skb;
2917 	skops->skb_data_end = skb->data + end_offset;
2918 }
2919 #else
2920 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2921 				      struct sk_buff *skb,
2922 				      unsigned int end_offset)
2923 {
2924 }
2925 #endif
2926 
2927 /* Call BPF_SOCK_OPS program that returns an int. If the return value
2928  * is < 0, then the BPF op failed (for example if the loaded BPF
2929  * program does not support the chosen operation or there is no BPF
2930  * program loaded).
2931  */
2932 #ifdef CONFIG_BPF
2933 static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
2934 {
2935 	struct bpf_sock_ops_kern sock_ops;
2936 	int ret;
2937 
2938 	memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp));
2939 	if (sk_fullsock(sk)) {
2940 		sock_ops.is_fullsock = 1;
2941 		sock_ops.is_locked_tcp_sock = 1;
2942 		sock_owned_by_me(sk);
2943 	}
2944 
2945 	sock_ops.sk = sk;
2946 	sock_ops.op = op;
2947 	if (nargs > 0)
2948 		memcpy(sock_ops.args, args, nargs * sizeof(*args));
2949 
2950 	ret = BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops);
2951 	if (ret == 0)
2952 		ret = sock_ops.reply;
2953 	else
2954 		ret = -1;
2955 	return ret;
2956 }
2957 
2958 static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2959 {
2960 	u32 args[2] = {arg1, arg2};
2961 
2962 	return tcp_call_bpf(sk, op, 2, args);
2963 }
2964 
2965 static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2966 				    u32 arg3)
2967 {
2968 	u32 args[3] = {arg1, arg2, arg3};
2969 
2970 	return tcp_call_bpf(sk, op, 3, args);
2971 }
2972 
2973 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk)
2974 {
2975 	tcp_sk(sk)->bpf_sock_ops_cb_flags = 0;
2976 }
2977 
2978 #else
2979 static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
2980 {
2981 	return -EPERM;
2982 }
2983 
2984 static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2985 {
2986 	return -EPERM;
2987 }
2988 
2989 static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2990 				    u32 arg3)
2991 {
2992 	return -EPERM;
2993 }
2994 
2995 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk)
2996 {
2997 }
2998 
2999 #endif
3000 
3001 static inline u32 tcp_timeout_init(struct sock *sk)
3002 {
3003 	int timeout;
3004 
3005 	timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT, 0, NULL);
3006 
3007 	if (timeout <= 0)
3008 		timeout = TCP_TIMEOUT_INIT;
3009 	return min_t(int, timeout, TCP_RTO_MAX);
3010 }
3011 
3012 static inline u32 tcp_rwnd_init_bpf(struct sock *sk)
3013 {
3014 	int rwnd;
3015 
3016 	rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT, 0, NULL);
3017 
3018 	if (rwnd < 0)
3019 		rwnd = 0;
3020 	return rwnd;
3021 }
3022 
3023 static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk)
3024 {
3025 	return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN, 0, NULL) == 1);
3026 }
3027 
3028 static inline void tcp_bpf_rtt(struct sock *sk, long mrtt, u32 srtt)
3029 {
3030 	if (BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), BPF_SOCK_OPS_RTT_CB_FLAG))
3031 		tcp_call_bpf_2arg(sk, BPF_SOCK_OPS_RTT_CB, mrtt, srtt);
3032 }
3033 
3034 #if IS_ENABLED(CONFIG_SMC)
3035 extern struct static_key_false tcp_have_smc;
3036 #endif
3037 
3038 #if IS_ENABLED(CONFIG_TLS_DEVICE)
3039 void clean_acked_data_enable(struct tcp_sock *tp,
3040 			     void (*cad)(struct sock *sk, u32 ack_seq));
3041 void clean_acked_data_disable(struct tcp_sock *tp);
3042 void clean_acked_data_flush(void);
3043 #endif
3044 
3045 DECLARE_STATIC_KEY_FALSE(tcp_tx_delay_enabled);
3046 static inline void tcp_add_tx_delay(struct sk_buff *skb,
3047 				    const struct tcp_sock *tp)
3048 {
3049 	if (static_branch_unlikely(&tcp_tx_delay_enabled))
3050 		skb->skb_mstamp_ns += (u64)tp->tcp_tx_delay * NSEC_PER_USEC;
3051 }
3052 
3053 /* Compute Earliest Departure Time for some control packets
3054  * like ACK or RST for TIME_WAIT or non ESTABLISHED sockets.
3055  */
3056 static inline u64 tcp_transmit_time(const struct sock *sk)
3057 {
3058 	if (static_branch_unlikely(&tcp_tx_delay_enabled)) {
3059 		u32 delay = (sk->sk_state == TCP_TIME_WAIT) ?
3060 			tcp_twsk(sk)->tw_tx_delay : tcp_sk(sk)->tcp_tx_delay;
3061 
3062 		return tcp_clock_ns() + (u64)delay * NSEC_PER_USEC;
3063 	}
3064 	return 0;
3065 }
3066 
3067 static inline int tcp_parse_auth_options(const struct tcphdr *th,
3068 		const u8 **md5_hash, const struct tcp_ao_hdr **aoh)
3069 {
3070 	const u8 *md5_tmp, *ao_tmp;
3071 	int ret;
3072 
3073 	ret = tcp_do_parse_auth_options(th, &md5_tmp, &ao_tmp);
3074 	if (ret)
3075 		return ret;
3076 
3077 	if (md5_hash)
3078 		*md5_hash = md5_tmp;
3079 
3080 	if (aoh) {
3081 		if (!ao_tmp)
3082 			*aoh = NULL;
3083 		else
3084 			*aoh = (struct tcp_ao_hdr *)(ao_tmp - 2);
3085 	}
3086 
3087 	return 0;
3088 }
3089 
3090 static inline bool tcp_ao_required(struct sock *sk, const void *saddr,
3091 				   int family, int l3index, bool stat_inc)
3092 {
3093 #ifdef CONFIG_TCP_AO
3094 	struct tcp_ao_info *ao_info;
3095 	struct tcp_ao_key *ao_key;
3096 
3097 	if (!static_branch_unlikely(&tcp_ao_needed.key))
3098 		return false;
3099 
3100 	ao_info = rcu_dereference_check(tcp_sk(sk)->ao_info,
3101 					lockdep_sock_is_held(sk));
3102 	if (!ao_info)
3103 		return false;
3104 
3105 	ao_key = tcp_ao_do_lookup(sk, l3index, saddr, family, -1, -1);
3106 	if (ao_info->ao_required || ao_key) {
3107 		if (stat_inc) {
3108 			NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAOREQUIRED);
3109 			atomic64_inc(&ao_info->counters.ao_required);
3110 		}
3111 		return true;
3112 	}
3113 #endif
3114 	return false;
3115 }
3116 
3117 enum skb_drop_reason tcp_inbound_hash(struct sock *sk,
3118 		const struct request_sock *req, const struct sk_buff *skb,
3119 		const void *saddr, const void *daddr,
3120 		int family, int dif, int sdif);
3121 
3122 static inline int tcp_recv_should_stop(struct sock *sk)
3123 {
3124 	return READ_ONCE(sk->sk_err) ||
3125 	       sk->sk_state == TCP_CLOSE ||
3126 	       (sk->sk_shutdown & RCV_SHUTDOWN) ||
3127 	       signal_pending(current);
3128 }
3129 
3130 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off
3131 			  tcp_v4_init_seq_and_ts_off(const struct net *net,
3132 						     const struct sk_buff *skb));
3133 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off
3134 			  tcp_v6_init_seq_and_ts_off(const struct net *net,
3135 						     const struct sk_buff *skb));
3136 #endif	/* _TCP_H */
3137