xref: /linux/include/net/tcp.h (revision 42a9fb3382fc2573e92f41d203b095d9a372cfc9)
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 static inline void tcp_check_space(struct sock *sk)
787 {
788 	/* pairs with tcp_poll() */
789 	smp_mb();
790 
791 	if (sk->sk_socket && test_bit(SOCK_NOSPACE, &sk->sk_socket->flags))
792 		__tcp_check_space(sk);
793 }
794 void tcp_sack_compress_send_ack(struct sock *sk);
795 
796 static inline void tcp_cleanup_skb(struct sk_buff *skb)
797 {
798 	skb_dst_drop(skb);
799 	secpath_reset(skb);
800 }
801 
802 static inline void tcp_add_receive_queue(struct sock *sk, struct sk_buff *skb)
803 {
804 	DEBUG_NET_WARN_ON_ONCE(skb_dst(skb));
805 	DEBUG_NET_WARN_ON_ONCE(secpath_exists(skb));
806 	__skb_queue_tail(&sk->sk_receive_queue, skb);
807 }
808 
809 /* tcp_timer.c */
810 void tcp_init_xmit_timers(struct sock *);
811 static inline void tcp_clear_xmit_timers(struct sock *sk)
812 {
813 	if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1)
814 		__sock_put(sk);
815 
816 	if (hrtimer_try_to_cancel(&tcp_sk(sk)->compressed_ack_timer) == 1)
817 		__sock_put(sk);
818 
819 	inet_csk_clear_xmit_timers(sk);
820 }
821 
822 unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
823 unsigned int tcp_current_mss(struct sock *sk);
824 u32 tcp_clamp_probe0_to_user_timeout(const struct sock *sk, u32 when);
825 
826 u32 tcp_tso_autosize(const struct sock *sk, unsigned int mss_now,
827 		     int min_tso_segs);
828 
829 /* Bound MSS / TSO packet size with the half of the window */
830 static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
831 {
832 	int cutoff;
833 
834 	/* When peer uses tiny windows, there is no use in packetizing
835 	 * to sub-MSS pieces for the sake of SWS or making sure there
836 	 * are enough packets in the pipe for fast recovery.
837 	 *
838 	 * On the other hand, for extremely large MSS devices, handling
839 	 * smaller than MSS windows in this way does make sense.
840 	 */
841 	if (tp->max_window > TCP_MSS_DEFAULT)
842 		cutoff = (tp->max_window >> 1);
843 	else
844 		cutoff = tp->max_window;
845 
846 	if (cutoff && pktsize > cutoff)
847 		return max_t(int, cutoff, 68U - tp->tcp_header_len);
848 	else
849 		return pktsize;
850 }
851 
852 /* tcp.c */
853 void tcp_get_info(struct sock *, struct tcp_info *);
854 void tcp_rate_check_app_limited(struct sock *sk);
855 
856 /* Read 'sendfile()'-style from a TCP socket */
857 int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
858 		  sk_read_actor_t recv_actor);
859 int tcp_read_sock_noack(struct sock *sk, read_descriptor_t *desc,
860 			sk_read_actor_t recv_actor, bool noack,
861 			u32 *copied_seq);
862 int tcp_read_skb(struct sock *sk, skb_read_actor_t recv_actor);
863 struct sk_buff *tcp_recv_skb(struct sock *sk, u32 seq, u32 *off);
864 void tcp_read_done(struct sock *sk, size_t len);
865 
866 void tcp_initialize_rcv_mss(struct sock *sk);
867 
868 int tcp_mtu_to_mss(struct sock *sk, int pmtu);
869 int tcp_mss_to_mtu(struct sock *sk, int mss);
870 void tcp_mtup_init(struct sock *sk);
871 
872 static inline unsigned int tcp_rto_max(const struct sock *sk)
873 {
874 	return READ_ONCE(inet_csk(sk)->icsk_rto_max);
875 }
876 
877 static inline void tcp_bound_rto(struct sock *sk)
878 {
879 	inet_csk(sk)->icsk_rto = min(inet_csk(sk)->icsk_rto, tcp_rto_max(sk));
880 }
881 
882 static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
883 {
884 	return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
885 }
886 
887 static inline unsigned long tcp_reqsk_timeout(struct request_sock *req)
888 {
889 	u64 timeout = (u64)req->timeout << req->num_timeout;
890 
891 	return (unsigned long)min_t(u64, timeout,
892 				    tcp_rto_max(req->rsk_listener));
893 }
894 
895 u32 tcp_delack_max(const struct sock *sk);
896 
897 /* Compute the actual rto_min value */
898 static inline u32 tcp_rto_min(const struct sock *sk)
899 {
900 	const struct dst_entry *dst = __sk_dst_get(sk);
901 	u32 rto_min = READ_ONCE(inet_csk(sk)->icsk_rto_min);
902 
903 	if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
904 		rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
905 	return rto_min;
906 }
907 
908 static inline u32 tcp_rto_min_us(const struct sock *sk)
909 {
910 	return jiffies_to_usecs(tcp_rto_min(sk));
911 }
912 
913 static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
914 {
915 	return dst_metric_locked(dst, RTAX_CC_ALGO);
916 }
917 
918 /* Minimum RTT in usec. ~0 means not available. */
919 static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
920 {
921 	return minmax_get(&tp->rtt_min);
922 }
923 
924 /* Compute the actual receive window we are currently advertising.
925  * Rcv_nxt can be after the window if our peer push more data
926  * than the offered window.
927  */
928 static inline u32 tcp_receive_window(const struct tcp_sock *tp)
929 {
930 	s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
931 
932 	if (win < 0)
933 		win = 0;
934 	return (u32) win;
935 }
936 
937 /* Compute the maximum receive window we ever advertised.
938  * Rcv_nxt can be after the window if our peer push more data
939  * than the offered window.
940  */
941 static inline u32 tcp_max_receive_window(const struct tcp_sock *tp)
942 {
943 	s32 win = tp->rcv_mwnd_seq - tp->rcv_nxt;
944 
945 	if (win < 0)
946 		win = 0;
947 	return (u32) win;
948 }
949 
950 /* Check if we need to update the maximum receive window sequence number */
951 static inline void tcp_update_max_rcv_wnd_seq(struct tcp_sock *tp)
952 {
953 	u32 wre = tp->rcv_wup + tp->rcv_wnd;
954 
955 	if (after(wre, tp->rcv_mwnd_seq))
956 		tp->rcv_mwnd_seq = wre;
957 }
958 
959 /* Choose a new window, without checks for shrinking, and without
960  * scaling applied to the result.  The caller does these things
961  * if necessary.  This is a "raw" window selection.
962  */
963 u32 __tcp_select_window(struct sock *sk);
964 
965 void tcp_send_window_probe(struct sock *sk);
966 
967 /* TCP uses 32bit jiffies to save some space.
968  * Note that this is different from tcp_time_stamp, which
969  * historically has been the same until linux-4.13.
970  */
971 #define tcp_jiffies32 ((u32)jiffies)
972 
973 /*
974  * Deliver a 32bit value for TCP timestamp option (RFC 7323)
975  * It is no longer tied to jiffies, but to 1 ms clock.
976  * Note: double check if you want to use tcp_jiffies32 instead of this.
977  */
978 #define TCP_TS_HZ	1000
979 
980 static inline u64 tcp_clock_ns(void)
981 {
982 	return ktime_get_ns();
983 }
984 
985 static inline u64 tcp_clock_us(void)
986 {
987 	return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
988 }
989 
990 static inline u64 tcp_clock_ms(void)
991 {
992 	return div_u64(tcp_clock_ns(), NSEC_PER_MSEC);
993 }
994 
995 /* TCP Timestamp included in TS option (RFC 1323) can either use ms
996  * or usec resolution. Each socket carries a flag to select one or other
997  * resolution, as the route attribute could change anytime.
998  * Each flow must stick to initial resolution.
999  */
1000 static inline u32 tcp_clock_ts(bool usec_ts)
1001 {
1002 	return usec_ts ? tcp_clock_us() : tcp_clock_ms();
1003 }
1004 
1005 static inline u32 tcp_time_stamp_ms(const struct tcp_sock *tp)
1006 {
1007 	return div_u64(tp->tcp_mstamp, USEC_PER_MSEC);
1008 }
1009 
1010 static inline u32 tcp_time_stamp_ts(const struct tcp_sock *tp)
1011 {
1012 	if (tp->tcp_usec_ts)
1013 		return tp->tcp_mstamp;
1014 	return tcp_time_stamp_ms(tp);
1015 }
1016 
1017 /* Refresh clocks of a TCP socket,
1018  * ensuring monotically increasing values.
1019  */
1020 static inline void tcp_mstamp_refresh_inline(struct tcp_sock *tp)
1021 {
1022 	u64 val = tcp_clock_ns();
1023 
1024 	tp->tcp_clock_cache = val;
1025 	tp->tcp_mstamp = div_u64(val, NSEC_PER_USEC);
1026 }
1027 void tcp_mstamp_refresh(struct tcp_sock *tp);
1028 
1029 static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
1030 {
1031 	return max_t(s64, t1 - t0, 0);
1032 }
1033 
1034 /* provide the departure time in us unit */
1035 static inline u64 tcp_skb_timestamp_us(const struct sk_buff *skb)
1036 {
1037 	return div_u64(skb->skb_mstamp_ns, NSEC_PER_USEC);
1038 }
1039 
1040 /* Provide skb TSval in usec or ms unit */
1041 static inline u32 tcp_skb_timestamp_ts(bool usec_ts, const struct sk_buff *skb)
1042 {
1043 	if (usec_ts)
1044 		return tcp_skb_timestamp_us(skb);
1045 
1046 	return div_u64(skb->skb_mstamp_ns, NSEC_PER_MSEC);
1047 }
1048 
1049 static inline u32 tcp_tw_tsval(const struct tcp_timewait_sock *tcptw)
1050 {
1051 	return tcp_clock_ts(tcptw->tw_sk.tw_usec_ts) + tcptw->tw_ts_offset;
1052 }
1053 
1054 static inline u32 tcp_rsk_tsval(const struct tcp_request_sock *treq)
1055 {
1056 	return tcp_clock_ts(treq->req_usec_ts) + treq->ts_off;
1057 }
1058 
1059 #define tcp_flag_byte(th) (((u_int8_t *)th)[13])
1060 
1061 #define TCPHDR_FIN	BIT(0)
1062 #define TCPHDR_SYN	BIT(1)
1063 #define TCPHDR_RST	BIT(2)
1064 #define TCPHDR_PSH	BIT(3)
1065 #define TCPHDR_ACK	BIT(4)
1066 #define TCPHDR_URG	BIT(5)
1067 #define TCPHDR_ECE	BIT(6)
1068 #define TCPHDR_CWR	BIT(7)
1069 #define TCPHDR_AE	BIT(8)
1070 #define TCPHDR_FLAGS_MASK (TCPHDR_FIN | TCPHDR_SYN | TCPHDR_RST | \
1071 			   TCPHDR_PSH | TCPHDR_ACK | TCPHDR_URG | \
1072 			   TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE)
1073 #define tcp_flags_ntohs(th) (ntohs(*(__be16 *)&tcp_flag_word(th)) & \
1074 			    TCPHDR_FLAGS_MASK)
1075 
1076 #define TCPHDR_ACE (TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE)
1077 #define TCPHDR_SYN_ECN	(TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)
1078 #define TCPHDR_SYNACK_ACCECN (TCPHDR_SYN | TCPHDR_ACK | TCPHDR_CWR)
1079 
1080 #define TCP_ACCECN_CEP_ACE_MASK 0x7
1081 #define TCP_ACCECN_ACE_MAX_DELTA 6
1082 
1083 /* To avoid/detect middlebox interference, not all counters start at 0.
1084  * See draft-ietf-tcpm-accurate-ecn for the latest values.
1085  */
1086 #define TCP_ACCECN_CEP_INIT_OFFSET 5
1087 #define TCP_ACCECN_E1B_INIT_OFFSET 1
1088 #define TCP_ACCECN_E0B_INIT_OFFSET 1
1089 #define TCP_ACCECN_CEB_INIT_OFFSET 0
1090 
1091 /* State flags for sacked in struct tcp_skb_cb */
1092 enum tcp_skb_cb_sacked_flags {
1093 	TCPCB_SACKED_ACKED	= (1 << 0),	/* SKB ACK'd by a SACK block	*/
1094 	TCPCB_SACKED_RETRANS	= (1 << 1),	/* SKB retransmitted		*/
1095 	TCPCB_LOST		= (1 << 2),	/* SKB is lost			*/
1096 	TCPCB_TAGBITS		= (TCPCB_SACKED_ACKED | TCPCB_SACKED_RETRANS |
1097 				   TCPCB_LOST),	/* All tag bits			*/
1098 	TCPCB_REPAIRED		= (1 << 4),	/* SKB repaired (no skb_mstamp_ns)	*/
1099 	TCPCB_EVER_RETRANS	= (1 << 7),	/* Ever retransmitted frame	*/
1100 	TCPCB_RETRANS		= (TCPCB_SACKED_RETRANS | TCPCB_EVER_RETRANS |
1101 				   TCPCB_REPAIRED),
1102 };
1103 
1104 /* This is what the send packet queuing engine uses to pass
1105  * TCP per-packet control information to the transmission code.
1106  * We also store the host-order sequence numbers in here too.
1107  * This is 44 bytes if IPV6 is enabled.
1108  * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
1109  */
1110 struct tcp_skb_cb {
1111 	__u32		seq;		/* Starting sequence number	*/
1112 	__u32		end_seq;	/* SEQ + FIN + SYN + datalen	*/
1113 	union {
1114 		/* Notes :
1115 		 *	tcp_tw_isn is used in input path only
1116 		 *	(isn chosen by tcp_timewait_state_process())
1117 		 * 	  tcp_gso_segs/size are used in write queue only,
1118 		 *	  cf tcp_skb_pcount()/tcp_skb_mss()
1119 		 */
1120 		u32		tcp_tw_isn;
1121 		struct {
1122 			u16	tcp_gso_segs;
1123 			u16	tcp_gso_size;
1124 		};
1125 	};
1126 	__u16		tcp_flags;	/* TCP header flags (tcp[12-13])*/
1127 
1128 	__u8		sacked;		/* State flags for SACK.	*/
1129 	__u8		ip_dsfield;	/* IPv4 tos or IPv6 dsfield	*/
1130 #define TSTAMP_ACK_SK	0x1
1131 #define TSTAMP_ACK_BPF	0x2
1132 	__u8		txstamp_ack:2,	/* Record TX timestamp for ack? */
1133 			eor:1,		/* Is skb MSG_EOR marked? */
1134 			has_rxtstamp:1,	/* SKB has a RX timestamp	*/
1135 			unused:4;
1136 	__u32		ack_seq;	/* Sequence number ACK'd	*/
1137 	union {
1138 		struct {
1139 #define TCPCB_DELIVERED_CE_MASK ((1U<<20) - 1)
1140 			/* There is space for up to 24 bytes */
1141 			__u32 is_app_limited:1, /* cwnd not fully used? */
1142 			      delivered_ce:20,
1143 			      unused:11;
1144 			/* pkts S/ACKed so far upon tx of skb, incl retrans: */
1145 			__u32 delivered;
1146 			/* start of send pipeline phase */
1147 			u64 first_tx_mstamp;
1148 			/* when we reached the "delivered" count */
1149 			u64 delivered_mstamp;
1150 		} tx;   /* only used for outgoing skbs */
1151 		union {
1152 			struct inet_skb_parm	h4;
1153 #if IS_ENABLED(CONFIG_IPV6)
1154 			struct inet6_skb_parm	h6;
1155 #endif
1156 		} header;	/* For incoming skbs */
1157 	};
1158 };
1159 
1160 #define TCP_SKB_CB(__skb)	((struct tcp_skb_cb *)&((__skb)->cb[0]))
1161 
1162 extern const struct inet_connection_sock_af_ops ipv4_specific;
1163 
1164 #if IS_ENABLED(CONFIG_IPV6)
1165 /* This is the variant of inet6_iif() that must be used by TCP,
1166  * as TCP moves IP6CB into a different location in skb->cb[]
1167  */
1168 static inline int tcp_v6_iif(const struct sk_buff *skb)
1169 {
1170 	return TCP_SKB_CB(skb)->header.h6.iif;
1171 }
1172 
1173 static inline int tcp_v6_iif_l3_slave(const struct sk_buff *skb)
1174 {
1175 	bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
1176 
1177 	return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
1178 }
1179 
1180 /* TCP_SKB_CB reference means this can not be used from early demux */
1181 static inline int tcp_v6_sdif(const struct sk_buff *skb)
1182 {
1183 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
1184 	if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags))
1185 		return TCP_SKB_CB(skb)->header.h6.iif;
1186 #endif
1187 	return 0;
1188 }
1189 
1190 extern const struct inet_connection_sock_af_ops ipv6_specific;
1191 
1192 INDIRECT_CALLABLE_DECLARE(int tcp_v6_rcv(struct sk_buff *skb));
1193 
1194 #endif
1195 
1196 /* TCP_SKB_CB reference means this can not be used from early demux */
1197 static inline int tcp_v4_sdif(struct sk_buff *skb)
1198 {
1199 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
1200 	if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
1201 		return TCP_SKB_CB(skb)->header.h4.iif;
1202 #endif
1203 	return 0;
1204 }
1205 
1206 /* Due to TSO, an SKB can be composed of multiple actual
1207  * packets.  To keep these tracked properly, we use this.
1208  */
1209 static inline int tcp_skb_pcount(const struct sk_buff *skb)
1210 {
1211 	return TCP_SKB_CB(skb)->tcp_gso_segs;
1212 }
1213 
1214 static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
1215 {
1216 	TCP_SKB_CB(skb)->tcp_gso_segs = segs;
1217 }
1218 
1219 static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
1220 {
1221 	TCP_SKB_CB(skb)->tcp_gso_segs += segs;
1222 }
1223 
1224 /* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
1225 static inline int tcp_skb_mss(const struct sk_buff *skb)
1226 {
1227 	return TCP_SKB_CB(skb)->tcp_gso_size;
1228 }
1229 
1230 static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
1231 {
1232 	return likely(!TCP_SKB_CB(skb)->eor);
1233 }
1234 
1235 static inline bool tcp_skb_can_collapse(const struct sk_buff *to,
1236 					const struct sk_buff *from)
1237 {
1238 	return likely(tcp_skb_can_collapse_to(to) &&
1239 		      mptcp_skb_can_collapse(to, from) &&
1240 		      !skb_cmp_decrypted(to, from) &&
1241 		      skb_pure_zcopy_same(to, from) &&
1242 		      skb_frags_readable(to) == skb_frags_readable(from));
1243 }
1244 
1245 static inline bool tcp_skb_can_collapse_rx(const struct sk_buff *to,
1246 					   const struct sk_buff *from)
1247 {
1248 	return likely(mptcp_skb_can_collapse(to, from) &&
1249 		      !skb_cmp_decrypted(to, from));
1250 }
1251 
1252 /* Events passed to congestion control interface */
1253 enum tcp_ca_event {
1254 	CA_EVENT_TX_START,	/* first transmit when no packets in flight */
1255 	CA_EVENT_CWND_RESTART,	/* congestion window restart */
1256 	CA_EVENT_COMPLETE_CWR,	/* end of congestion recovery */
1257 	CA_EVENT_LOSS,		/* loss timeout */
1258 	CA_EVENT_ECN_NO_CE,	/* ECT set, but not CE marked */
1259 	CA_EVENT_ECN_IS_CE,	/* received CE marked IP packet */
1260 };
1261 
1262 /* Information about inbound ACK, passed to cong_ops->in_ack_event() */
1263 enum tcp_ca_ack_event_flags {
1264 	CA_ACK_SLOWPATH		= (1 << 0),	/* In slow path processing */
1265 	CA_ACK_WIN_UPDATE	= (1 << 1),	/* ACK updated window */
1266 	CA_ACK_ECE		= (1 << 2),	/* ECE bit is set on ack */
1267 };
1268 
1269 /*
1270  * Interface for adding new TCP congestion control handlers
1271  */
1272 #define TCP_CA_NAME_MAX	16
1273 #define TCP_CA_MAX	128
1274 #define TCP_CA_BUF_MAX	(TCP_CA_NAME_MAX*TCP_CA_MAX)
1275 
1276 #define TCP_CA_UNSPEC	0
1277 
1278 /* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
1279 #define TCP_CONG_NON_RESTRICTED		BIT(0)
1280 /* Requires ECN/ECT set on all packets */
1281 #define TCP_CONG_NEEDS_ECN		BIT(1)
1282 /* Require successfully negotiated AccECN capability */
1283 #define TCP_CONG_NEEDS_ACCECN		BIT(2)
1284 /* Use ECT(1) instead of ECT(0) while the CA is uninitialized */
1285 #define TCP_CONG_ECT_1_NEGOTIATION	BIT(3)
1286 /* Cannot fallback to RFC3168 during AccECN negotiation */
1287 #define TCP_CONG_NO_FALLBACK_RFC3168	BIT(4)
1288 #define TCP_CONG_MASK  (TCP_CONG_NON_RESTRICTED | TCP_CONG_NEEDS_ECN | \
1289 			TCP_CONG_NEEDS_ACCECN | TCP_CONG_ECT_1_NEGOTIATION | \
1290 			TCP_CONG_NO_FALLBACK_RFC3168)
1291 
1292 union tcp_cc_info;
1293 
1294 struct ack_sample {
1295 	u32 pkts_acked;
1296 	s32 rtt_us;
1297 	u32 in_flight;
1298 };
1299 
1300 /* A rate sample measures the number of (original/retransmitted) data
1301  * packets delivered "delivered" over an interval of time "interval_us".
1302  * The tcp_rate.c code fills in the rate sample, and congestion
1303  * control modules that define a cong_control function to run at the end
1304  * of ACK processing can optionally chose to consult this sample when
1305  * setting cwnd and pacing rate.
1306  * A sample is invalid if "delivered" or "interval_us" is negative.
1307  */
1308 struct rate_sample {
1309 	u64  prior_mstamp; /* starting timestamp for interval */
1310 	u32  prior_delivered;	/* tp->delivered at "prior_mstamp" */
1311 	u32  prior_delivered_ce;/* tp->delivered_ce at "prior_mstamp" */
1312 	s32  delivered;		/* number of packets delivered over interval */
1313 	s32  delivered_ce;	/* number of packets delivered w/ CE marks*/
1314 	long interval_us;	/* time for tp->delivered to incr "delivered" */
1315 	u32 snd_interval_us;	/* snd interval for delivered packets */
1316 	u32 rcv_interval_us;	/* rcv interval for delivered packets */
1317 	long rtt_us;		/* RTT of last (S)ACKed packet (or -1) */
1318 	int  losses;		/* number of packets marked lost upon ACK */
1319 	u32  acked_sacked;	/* number of packets newly (S)ACKed upon ACK */
1320 	u32  prior_in_flight;	/* in flight before this ACK */
1321 	u32  last_end_seq;	/* end_seq of most recently ACKed packet */
1322 	bool is_app_limited;	/* is sample from packet with bubble in pipe? */
1323 	bool is_retrans;	/* is sample from retransmission? */
1324 	bool is_ack_delayed;	/* is this (likely) a delayed ACK? */
1325 };
1326 
1327 struct tcp_congestion_ops {
1328 /* fast path fields are put first to fill one cache line */
1329 
1330 	/* A congestion control (CC) must provide one of either:
1331 	 *
1332 	 * (a) a cong_avoid function, if the CC wants to use the core TCP
1333 	 *     stack's default functionality to implement a "classic"
1334 	 *     (Reno/CUBIC-style) response to packet loss, RFC3168 ECN,
1335 	 *     idle periods, pacing rate computations, etc.
1336 	 *
1337 	 * (b) a cong_control function, if the CC wants custom behavior and
1338 	 *      complete control of all congestion control behaviors.
1339 	 */
1340 	/* (a) "classic" response: calculate new cwnd.
1341 	 */
1342 	void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
1343 	/* (b) "custom" response: call when packets are delivered to update
1344 	 * cwnd and pacing rate, after all the ca_state processing.
1345 	 */
1346 	void (*cong_control)(struct sock *sk, u32 ack, int flag, const struct rate_sample *rs);
1347 
1348 	/* return slow start threshold (required) */
1349 	u32 (*ssthresh)(struct sock *sk);
1350 
1351 	/* call before changing ca_state (optional) */
1352 	void (*set_state)(struct sock *sk, u8 new_state);
1353 
1354 	/* call when cwnd event occurs (optional) */
1355 	void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
1356 
1357 	/* call when CA_EVENT_TX_START cwnd event occurs (optional) */
1358 	void (*cwnd_event_tx_start)(struct sock *sk);
1359 
1360 	/* call when ack arrives (optional) */
1361 	void (*in_ack_event)(struct sock *sk, u32 flags);
1362 
1363 	/* hook for packet ack accounting (optional) */
1364 	void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
1365 
1366 	/* Override tcp_tso_autosize() (optional)
1367 	 *
1368 	 * If provided, this callback supplies the TSO segment target count
1369 	 * instead of using tcp_tso_autosize(). The returned value is
1370 	 * subsequently clamped to [1, sk->sk_gso_max_segs] by the caller.
1371 	 *
1372 	 * For the kernel callback path, mss_now originates from
1373 	 * tcp_current_mss() and should never be zero.
1374 	 */
1375 	u32 (*tso_segs)(struct sock *sk, u32 mss_now);
1376 
1377 	/* new value of cwnd after loss (required) */
1378 	u32  (*undo_cwnd)(struct sock *sk);
1379 	/* returns the multiplier used in tcp_sndbuf_expand (optional) */
1380 	u32 (*sndbuf_expand)(struct sock *sk);
1381 
1382 /* control/slow paths put last */
1383 	/* get info for inet_diag (optional) */
1384 	size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
1385 			   union tcp_cc_info *info);
1386 
1387 	char 			name[TCP_CA_NAME_MAX];
1388 	struct module		*owner;
1389 	struct list_head	list;
1390 	u32			key;
1391 	u32			flags;
1392 
1393 	/* initialize private data (optional) */
1394 	void (*init)(struct sock *sk);
1395 	/* cleanup private data  (optional) */
1396 	void (*release)(struct sock *sk);
1397 } ____cacheline_aligned_in_smp;
1398 
1399 int tcp_register_congestion_control(struct tcp_congestion_ops *type);
1400 void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
1401 int tcp_update_congestion_control(struct tcp_congestion_ops *type,
1402 				  struct tcp_congestion_ops *old_type);
1403 int tcp_validate_congestion_control(struct tcp_congestion_ops *ca);
1404 
1405 void tcp_assign_congestion_control(struct sock *sk);
1406 void tcp_init_congestion_control(struct sock *sk);
1407 void tcp_cleanup_congestion_control(struct sock *sk);
1408 int tcp_set_default_congestion_control(struct net *net, const char *name);
1409 void tcp_get_default_congestion_control(struct net *net, char *name);
1410 void tcp_get_available_congestion_control(char *buf, size_t len);
1411 void tcp_get_allowed_congestion_control(char *buf, size_t len);
1412 int tcp_set_allowed_congestion_control(char *allowed);
1413 int tcp_set_congestion_control(struct sock *sk, const char *name, bool load,
1414 			       bool cap_net_admin);
1415 u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
1416 void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
1417 
1418 u32 tcp_reno_ssthresh(struct sock *sk);
1419 u32 tcp_reno_undo_cwnd(struct sock *sk);
1420 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
1421 extern struct tcp_congestion_ops tcp_reno;
1422 
1423 struct tcp_congestion_ops *tcp_ca_find(const char *name);
1424 struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
1425 u32 tcp_ca_get_key_by_name(const char *name, bool *ecn_ca);
1426 #ifdef CONFIG_INET
1427 char *tcp_ca_get_name_by_key(u32 key, char *buffer);
1428 #else
1429 static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
1430 {
1431 	return NULL;
1432 }
1433 #endif
1434 
1435 static inline bool tcp_ca_needs_ecn(const struct sock *sk)
1436 {
1437 	const struct inet_connection_sock *icsk = inet_csk(sk);
1438 
1439 	return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
1440 }
1441 
1442 static inline bool tcp_ca_needs_accecn(const struct sock *sk)
1443 {
1444 	const struct inet_connection_sock *icsk = inet_csk(sk);
1445 
1446 	return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ACCECN;
1447 }
1448 
1449 static inline bool tcp_ca_ect_1_negotiation(const struct sock *sk)
1450 {
1451 	const struct inet_connection_sock *icsk = inet_csk(sk);
1452 
1453 	return icsk->icsk_ca_ops->flags & TCP_CONG_ECT_1_NEGOTIATION;
1454 }
1455 
1456 static inline bool tcp_ca_no_fallback_rfc3168(const struct sock *sk)
1457 {
1458 	const struct inet_connection_sock *icsk = inet_csk(sk);
1459 
1460 	return icsk->icsk_ca_ops->flags & TCP_CONG_NO_FALLBACK_RFC3168;
1461 }
1462 
1463 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
1464 {
1465 	const struct inet_connection_sock *icsk = inet_csk(sk);
1466 
1467 	if (event == CA_EVENT_TX_START) {
1468 		if (icsk->icsk_ca_ops->cwnd_event_tx_start)
1469 			icsk->icsk_ca_ops->cwnd_event_tx_start(sk);
1470 		return;
1471 	}
1472 	if (icsk->icsk_ca_ops->cwnd_event)
1473 		icsk->icsk_ca_ops->cwnd_event(sk, event);
1474 }
1475 
1476 /* From tcp_cong.c */
1477 void tcp_set_ca_state(struct sock *sk, const u8 ca_state);
1478 
1479 
1480 static inline bool tcp_skb_sent_after(u64 t1, u64 t2, u32 seq1, u32 seq2)
1481 {
1482 	return t1 > t2 || (t1 == t2 && after(seq1, seq2));
1483 }
1484 
1485 /* These functions determine how the current flow behaves in respect of SACK
1486  * handling. SACK is negotiated with the peer, and therefore it can vary
1487  * between different flows.
1488  *
1489  * tcp_is_sack - SACK enabled
1490  * tcp_is_reno - No SACK
1491  */
1492 static inline int tcp_is_sack(const struct tcp_sock *tp)
1493 {
1494 	return likely(tp->rx_opt.sack_ok);
1495 }
1496 
1497 static inline bool tcp_is_reno(const struct tcp_sock *tp)
1498 {
1499 	return !tcp_is_sack(tp);
1500 }
1501 
1502 static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
1503 {
1504 	return tp->sacked_out + tp->lost_out;
1505 }
1506 
1507 /* This determines how many packets are "in the network" to the best
1508  * of our knowledge.  In many cases it is conservative, but where
1509  * detailed information is available from the receiver (via SACK
1510  * blocks etc.) we can make more aggressive calculations.
1511  *
1512  * Use this for decisions involving congestion control, use just
1513  * tp->packets_out to determine if the send queue is empty or not.
1514  *
1515  * Read this equation as:
1516  *
1517  *	"Packets sent once on transmission queue" MINUS
1518  *	"Packets left network, but not honestly ACKed yet" PLUS
1519  *	"Packets fast retransmitted"
1520  */
1521 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
1522 {
1523 	return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
1524 }
1525 
1526 #define TCP_INFINITE_SSTHRESH	0x7fffffff
1527 
1528 static inline u32 tcp_snd_cwnd(const struct tcp_sock *tp)
1529 {
1530 	return tp->snd_cwnd;
1531 }
1532 
1533 static inline void tcp_snd_cwnd_set(struct tcp_sock *tp, u32 val)
1534 {
1535 	WARN_ON_ONCE((int)val <= 0);
1536 	WRITE_ONCE(tp->snd_cwnd, val);
1537 }
1538 
1539 static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
1540 {
1541 	return tcp_snd_cwnd(tp) < tp->snd_ssthresh;
1542 }
1543 
1544 static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
1545 {
1546 	return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
1547 }
1548 
1549 static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
1550 {
1551 	return (TCPF_CA_CWR | TCPF_CA_Recovery) &
1552 	       (1 << inet_csk(sk)->icsk_ca_state);
1553 }
1554 
1555 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
1556  * The exception is cwnd reduction phase, when cwnd is decreasing towards
1557  * ssthresh.
1558  */
1559 static inline __u32 tcp_current_ssthresh(const struct sock *sk)
1560 {
1561 	const struct tcp_sock *tp = tcp_sk(sk);
1562 
1563 	if (tcp_in_cwnd_reduction(sk))
1564 		return tp->snd_ssthresh;
1565 	else
1566 		return max(tp->snd_ssthresh,
1567 			   ((tcp_snd_cwnd(tp) >> 1) +
1568 			    (tcp_snd_cwnd(tp) >> 2)));
1569 }
1570 
1571 /* Use define here intentionally to get WARN_ON location shown at the caller */
1572 #define tcp_verify_left_out(tp)	WARN_ON(tcp_left_out(tp) > tp->packets_out)
1573 
1574 void tcp_enter_cwr(struct sock *sk);
1575 __u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
1576 
1577 /* The maximum number of MSS of available cwnd for which TSO defers
1578  * sending if not using sysctl_tcp_tso_win_divisor.
1579  */
1580 static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1581 {
1582 	return 3;
1583 }
1584 
1585 /* Returns end sequence number of the receiver's advertised window */
1586 static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1587 {
1588 	return tp->snd_una + tp->snd_wnd;
1589 }
1590 
1591 /* We follow the spirit of RFC2861 to validate cwnd but implement a more
1592  * flexible approach. The RFC suggests cwnd should not be raised unless
1593  * it was fully used previously. And that's exactly what we do in
1594  * congestion avoidance mode. But in slow start we allow cwnd to grow
1595  * as long as the application has used half the cwnd.
1596  * Example :
1597  *    cwnd is 10 (IW10), but application sends 9 frames.
1598  *    We allow cwnd to reach 18 when all frames are ACKed.
1599  * This check is safe because it's as aggressive as slow start which already
1600  * risks 100% overshoot. The advantage is that we discourage application to
1601  * either send more filler packets or data to artificially blow up the cwnd
1602  * usage, and allow application-limited process to probe bw more aggressively.
1603  */
1604 static inline bool tcp_is_cwnd_limited(const struct sock *sk)
1605 {
1606 	const struct tcp_sock *tp = tcp_sk(sk);
1607 
1608 	if (tp->is_cwnd_limited)
1609 		return true;
1610 
1611 	/* If in slow start, ensure cwnd grows to twice what was ACKed. */
1612 	if (tcp_in_slow_start(tp))
1613 		return tcp_snd_cwnd(tp) < 2 * tp->max_packets_out;
1614 
1615 	return false;
1616 }
1617 
1618 /* BBR congestion control needs pacing.
1619  * Same remark for SO_MAX_PACING_RATE.
1620  * sch_fq packet scheduler is efficiently handling pacing,
1621  * but is not always installed/used.
1622  * Return true if TCP stack should pace packets itself.
1623  */
1624 static inline bool tcp_needs_internal_pacing(const struct sock *sk)
1625 {
1626 	return smp_load_acquire(&sk->sk_pacing_status) == SK_PACING_NEEDED;
1627 }
1628 
1629 /* Estimates in how many jiffies next packet for this flow can be sent.
1630  * Scheduling a retransmit timer too early would be silly.
1631  */
1632 static inline unsigned long tcp_pacing_delay(const struct sock *sk)
1633 {
1634 	s64 delay = tcp_sk(sk)->tcp_wstamp_ns - tcp_sk(sk)->tcp_clock_cache;
1635 
1636 	return delay > 0 ? nsecs_to_jiffies(delay) : 0;
1637 }
1638 
1639 static inline void tcp_reset_xmit_timer(struct sock *sk,
1640 					const int what,
1641 					unsigned long when,
1642 					bool pace_delay)
1643 {
1644 	if (pace_delay)
1645 		when += tcp_pacing_delay(sk);
1646 	inet_csk_reset_xmit_timer(sk, what, when,
1647 				  tcp_rto_max(sk));
1648 }
1649 
1650 /* Something is really bad, we could not queue an additional packet,
1651  * because qdisc is full or receiver sent a 0 window, or we are paced.
1652  * We do not want to add fuel to the fire, or abort too early,
1653  * so make sure the timer we arm now is at least 200ms in the future,
1654  * regardless of current icsk_rto value (as it could be ~2ms)
1655  */
1656 static inline unsigned long tcp_probe0_base(const struct sock *sk)
1657 {
1658 	return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1659 }
1660 
1661 /* Variant of inet_csk_rto_backoff() used for zero window probes */
1662 static inline unsigned long tcp_probe0_when(const struct sock *sk,
1663 					    unsigned long max_when)
1664 {
1665 	u8 backoff = min_t(u8, ilog2(TCP_RTO_MAX / TCP_RTO_MIN) + 1,
1666 			   inet_csk(sk)->icsk_backoff);
1667 	u64 when = (u64)tcp_probe0_base(sk) << backoff;
1668 
1669 	return (unsigned long)min_t(u64, when, max_when);
1670 }
1671 
1672 static inline void tcp_check_probe_timer(struct sock *sk)
1673 {
1674 	if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
1675 		tcp_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
1676 				     tcp_probe0_base(sk), true);
1677 }
1678 
1679 static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
1680 {
1681 	tp->snd_wl1 = seq;
1682 }
1683 
1684 static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
1685 {
1686 	tp->snd_wl1 = seq;
1687 }
1688 
1689 /*
1690  * Calculate(/check) TCP checksum
1691  */
1692 static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1693 				   __be32 daddr, __wsum base)
1694 {
1695 	return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_TCP, base);
1696 }
1697 
1698 static inline bool tcp_checksum_complete(struct sk_buff *skb)
1699 {
1700 	return !skb_csum_unnecessary(skb) &&
1701 		__skb_checksum_complete(skb);
1702 }
1703 
1704 enum skb_drop_reason tcp_add_backlog(struct sock *sk, struct sk_buff *skb);
1705 
1706 static inline enum skb_drop_reason
1707 tcp_filter(struct sock *sk, struct sk_buff *skb)
1708 {
1709 	const struct tcphdr *th = (const struct tcphdr *)skb->data;
1710 
1711 	return sk_filter_trim_cap(sk, skb, __tcp_hdrlen(th));
1712 }
1713 
1714 void tcp_set_state(struct sock *sk, int state);
1715 void tcp_done(struct sock *sk);
1716 int tcp_abort(struct sock *sk, int err);
1717 
1718 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1719 {
1720 	rx_opt->dsack = 0;
1721 	rx_opt->num_sacks = 0;
1722 }
1723 
1724 void tcp_cwnd_restart(struct sock *sk, s32 delta);
1725 
1726 static inline void tcp_slow_start_after_idle_check(struct sock *sk)
1727 {
1728 	const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
1729 	struct tcp_sock *tp = tcp_sk(sk);
1730 	s32 delta;
1731 
1732 	if (!READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle) ||
1733 	    tp->packets_out || ca_ops->cong_control)
1734 		return;
1735 	delta = tcp_jiffies32 - tp->lsndtime;
1736 	if (delta > inet_csk(sk)->icsk_rto)
1737 		tcp_cwnd_restart(sk, delta);
1738 }
1739 
1740 /* Determine a window scaling and initial window to offer. */
1741 void tcp_select_initial_window(const struct sock *sk, int __space,
1742 			       __u32 mss, __u32 *rcv_wnd,
1743 			       __u32 *window_clamp, int wscale_ok,
1744 			       __u8 *rcv_wscale, __u32 init_rcv_wnd);
1745 
1746 static inline int __tcp_win_from_space(u8 scaling_ratio, int space)
1747 {
1748 	s64 scaled_space = (s64)space * scaling_ratio;
1749 
1750 	return scaled_space >> TCP_RMEM_TO_WIN_SCALE;
1751 }
1752 
1753 static inline int tcp_win_from_space(const struct sock *sk, int space)
1754 {
1755 	return __tcp_win_from_space(tcp_sk(sk)->scaling_ratio, space);
1756 }
1757 
1758 /* inverse of __tcp_win_from_space() */
1759 static inline int __tcp_space_from_win(u8 scaling_ratio, int win)
1760 {
1761 	u64 val = (u64)win << TCP_RMEM_TO_WIN_SCALE;
1762 
1763 	do_div(val, scaling_ratio);
1764 	return val;
1765 }
1766 
1767 static inline int tcp_space_from_win(const struct sock *sk, int win)
1768 {
1769 	return __tcp_space_from_win(tcp_sk(sk)->scaling_ratio, win);
1770 }
1771 
1772 /* Assume a 50% default for skb->len/skb->truesize ratio.
1773  * This may be adjusted later in tcp_measure_rcv_mss().
1774  */
1775 #define TCP_DEFAULT_SCALING_RATIO (1 << (TCP_RMEM_TO_WIN_SCALE - 1))
1776 
1777 static inline void tcp_scaling_ratio_init(struct sock *sk)
1778 {
1779 	tcp_sk(sk)->scaling_ratio = TCP_DEFAULT_SCALING_RATIO;
1780 }
1781 
1782 /* Note: caller must be prepared to deal with negative returns */
1783 static inline int tcp_space(const struct sock *sk)
1784 {
1785 	return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) -
1786 				  READ_ONCE(sk->sk_backlog.len) -
1787 				  atomic_read(&sk->sk_rmem_alloc));
1788 }
1789 
1790 static inline int tcp_full_space(const struct sock *sk)
1791 {
1792 	return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf));
1793 }
1794 
1795 static inline u32 tcp_dst_advmss(const struct dst_entry *dst)
1796 {
1797 	return max_t(u32, dst_metric_advmss(dst), TCP_MIN_MSS);
1798 }
1799 
1800 static inline void __tcp_adjust_rcv_ssthresh(struct sock *sk, u32 new_ssthresh)
1801 {
1802 	int unused_mem = sk_unused_reserved_mem(sk);
1803 	struct tcp_sock *tp = tcp_sk(sk);
1804 
1805 	tp->rcv_ssthresh = min(tp->rcv_ssthresh, new_ssthresh);
1806 	if (unused_mem)
1807 		tp->rcv_ssthresh = max_t(u32, tp->rcv_ssthresh,
1808 					 tcp_win_from_space(sk, unused_mem));
1809 }
1810 
1811 static inline void tcp_adjust_rcv_ssthresh(struct sock *sk)
1812 {
1813 	__tcp_adjust_rcv_ssthresh(sk, 4U * tcp_sk(sk)->advmss);
1814 }
1815 
1816 void tcp_cleanup_rbuf(struct sock *sk, int copied);
1817 void __tcp_cleanup_rbuf(struct sock *sk, int copied);
1818 
1819 
1820 /* We provision sk_rcvbuf around 200% of sk_rcvlowat.
1821  * If 87.5 % (7/8) of the space has been consumed, we want to override
1822  * SO_RCVLOWAT constraint, since we are receiving skbs with too small
1823  * len/truesize ratio.
1824  */
1825 static inline bool tcp_rmem_pressure(const struct sock *sk)
1826 {
1827 	int rcvbuf, threshold;
1828 
1829 	if (tcp_under_memory_pressure(sk))
1830 		return true;
1831 
1832 	rcvbuf = READ_ONCE(sk->sk_rcvbuf);
1833 	threshold = rcvbuf - (rcvbuf >> 3);
1834 
1835 	return atomic_read(&sk->sk_rmem_alloc) > threshold;
1836 }
1837 
1838 static inline bool tcp_epollin_ready(const struct sock *sk, int target)
1839 {
1840 	const struct tcp_sock *tp = tcp_sk(sk);
1841 	int avail = READ_ONCE(tp->rcv_nxt) - READ_ONCE(tp->copied_seq);
1842 
1843 	if (avail <= 0)
1844 		return false;
1845 
1846 	return (avail >= target) || tcp_rmem_pressure(sk) ||
1847 	       (tcp_receive_window(tp) <= inet_csk(sk)->icsk_ack.rcv_mss);
1848 }
1849 
1850 extern void tcp_openreq_init_rwin(struct request_sock *req,
1851 				  const struct sock *sk_listener,
1852 				  const struct dst_entry *dst);
1853 
1854 void tcp_enter_memory_pressure(struct sock *sk);
1855 void tcp_leave_memory_pressure(struct sock *sk);
1856 
1857 static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1858 {
1859 	struct net *net = sock_net((struct sock *)tp);
1860 	int val;
1861 
1862 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepintvl()
1863 	 * and do_tcp_setsockopt().
1864 	 */
1865 	val = READ_ONCE(tp->keepalive_intvl);
1866 
1867 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_intvl);
1868 }
1869 
1870 static inline int keepalive_time_when(const struct tcp_sock *tp)
1871 {
1872 	struct net *net = sock_net((struct sock *)tp);
1873 	int val;
1874 
1875 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepidle_locked() */
1876 	val = READ_ONCE(tp->keepalive_time);
1877 
1878 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_time);
1879 }
1880 
1881 static inline int keepalive_probes(const struct tcp_sock *tp)
1882 {
1883 	struct net *net = sock_net((struct sock *)tp);
1884 	int val;
1885 
1886 	/* Paired with WRITE_ONCE() in tcp_sock_set_keepcnt()
1887 	 * and do_tcp_setsockopt().
1888 	 */
1889 	val = READ_ONCE(tp->keepalive_probes);
1890 
1891 	return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_probes);
1892 }
1893 
1894 static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1895 {
1896 	const struct inet_connection_sock *icsk = &tp->inet_conn;
1897 
1898 	return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
1899 			  tcp_jiffies32 - tp->rcv_tstamp);
1900 }
1901 
1902 static inline int tcp_fin_time(const struct sock *sk)
1903 {
1904 	int fin_timeout = tcp_sk(sk)->linger2 ? :
1905 		READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_fin_timeout);
1906 	const int rto = inet_csk(sk)->icsk_rto;
1907 
1908 	if (fin_timeout < (rto << 2) - (rto >> 1))
1909 		fin_timeout = (rto << 2) - (rto >> 1);
1910 
1911 	return fin_timeout;
1912 }
1913 
1914 static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1915 				  int paws_win)
1916 {
1917 	if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
1918 		return true;
1919 	if (unlikely(!time_before32(ktime_get_seconds(),
1920 				    rx_opt->ts_recent_stamp + TCP_PAWS_WRAP)))
1921 		return true;
1922 	/*
1923 	 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1924 	 * then following tcp messages have valid values. Ignore 0 value,
1925 	 * or else 'negative' tsval might forbid us to accept their packets.
1926 	 */
1927 	if (!rx_opt->ts_recent)
1928 		return true;
1929 	return false;
1930 }
1931 
1932 static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1933 				   int rst)
1934 {
1935 	if (tcp_paws_check(rx_opt, 0))
1936 		return false;
1937 
1938 	/* RST segments are not recommended to carry timestamp,
1939 	   and, if they do, it is recommended to ignore PAWS because
1940 	   "their cleanup function should take precedence over timestamps."
1941 	   Certainly, it is mistake. It is necessary to understand the reasons
1942 	   of this constraint to relax it: if peer reboots, clock may go
1943 	   out-of-sync and half-open connections will not be reset.
1944 	   Actually, the problem would be not existing if all
1945 	   the implementations followed draft about maintaining clock
1946 	   via reboots. Linux-2.2 DOES NOT!
1947 
1948 	   However, we can relax time bounds for RST segments to MSL.
1949 	 */
1950 	if (rst && !time_before32(ktime_get_seconds(),
1951 				  rx_opt->ts_recent_stamp + TCP_PAWS_MSL))
1952 		return false;
1953 	return true;
1954 }
1955 
1956 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
1957 {
1958 	u32 ace;
1959 
1960 	/* mptcp hooks are only on the slow path */
1961 	if (sk_is_mptcp((struct sock *)tp))
1962 		return;
1963 
1964 	ace = tcp_ecn_mode_accecn(tp) ?
1965 	      ((tp->delivered_ce + TCP_ACCECN_CEP_INIT_OFFSET) &
1966 	       TCP_ACCECN_CEP_ACE_MASK) : 0;
1967 
1968 	tp->pred_flags = htonl((tp->tcp_header_len << 26) |
1969 			       (ace << 22) |
1970 			       ntohl(TCP_FLAG_ACK) |
1971 			       snd_wnd);
1972 }
1973 
1974 static inline void tcp_fast_path_on(struct tcp_sock *tp)
1975 {
1976 	__tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
1977 }
1978 
1979 static inline void tcp_fast_path_check(struct sock *sk)
1980 {
1981 	struct tcp_sock *tp = tcp_sk(sk);
1982 
1983 	if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
1984 	    tp->rcv_wnd &&
1985 	    atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
1986 	    !tp->urg_data)
1987 		tcp_fast_path_on(tp);
1988 }
1989 
1990 bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
1991 			  int mib_idx, u32 *last_oow_ack_time);
1992 void tcp_reqsk_send_challenge_ack(struct sock *sk, struct sk_buff *skb,
1993 				  struct request_sock *req);
1994 
1995 static inline void tcp_mib_init(struct net *net)
1996 {
1997 	/* See RFC 2012 */
1998 	TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
1999 	TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
2000 	TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
2001 	TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
2002 }
2003 
2004 /* from STCP */
2005 static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
2006 {
2007 	tp->retransmit_skb_hint = NULL;
2008 }
2009 
2010 #define tcp_md5_addr tcp_ao_addr
2011 
2012 /* - key database */
2013 struct tcp_md5sig_key {
2014 	struct hlist_node	node;
2015 	u8			keylen;
2016 	u8			family; /* AF_INET or AF_INET6 */
2017 	u8			prefixlen;
2018 	u8			flags;
2019 	union tcp_md5_addr	addr;
2020 	int			l3index; /* set if key added with L3 scope */
2021 	u8			key[TCP_MD5SIG_MAXKEYLEN];
2022 	struct rcu_head		rcu;
2023 };
2024 
2025 /* - sock block */
2026 struct tcp_md5sig_info {
2027 	struct hlist_head	head;
2028 	struct rcu_head		rcu;
2029 };
2030 
2031 /* - pseudo header */
2032 struct tcp4_pseudohdr {
2033 	__be32		saddr;
2034 	__be32		daddr;
2035 	__u8		pad;
2036 	__u8		protocol;
2037 	__be16		len;
2038 };
2039 
2040 struct tcp6_pseudohdr {
2041 	struct in6_addr	saddr;
2042 	struct in6_addr daddr;
2043 	__be32		len;
2044 	__be32		protocol;	/* including padding */
2045 };
2046 
2047 void tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
2048 			 const struct sock *sk, const struct sk_buff *skb);
2049 int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
2050 		   int family, u8 prefixlen, int l3index, u8 flags,
2051 		   const u8 *newkey, u8 newkeylen);
2052 int tcp_md5_key_copy(struct sock *sk, const union tcp_md5_addr *addr,
2053 		     int family, u8 prefixlen, int l3index,
2054 		     struct tcp_md5sig_key *key);
2055 
2056 int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
2057 		   int family, u8 prefixlen, int l3index, u8 flags);
2058 void tcp_clear_md5_list(struct sock *sk);
2059 struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
2060 					 const struct sock *addr_sk);
2061 
2062 #ifdef CONFIG_TCP_MD5SIG
2063 struct tcp_md5sig_key *__tcp_md5_do_lookup(const struct sock *sk, int l3index,
2064 					   const union tcp_md5_addr *addr,
2065 					   int family, bool any_l3index);
2066 static inline struct tcp_md5sig_key *
2067 tcp_md5_do_lookup(const struct sock *sk, int l3index,
2068 		  const union tcp_md5_addr *addr, int family)
2069 {
2070 	if (!static_branch_unlikely(&tcp_md5_needed.key))
2071 		return NULL;
2072 	return __tcp_md5_do_lookup(sk, l3index, addr, family, false);
2073 }
2074 
2075 static inline struct tcp_md5sig_key *
2076 tcp_md5_do_lookup_any_l3index(const struct sock *sk,
2077 			      const union tcp_md5_addr *addr, int family)
2078 {
2079 	if (!static_branch_unlikely(&tcp_md5_needed.key))
2080 		return NULL;
2081 	return __tcp_md5_do_lookup(sk, 0, addr, family, true);
2082 }
2083 
2084 #define tcp_twsk_md5_key(twsk)	((twsk)->tw_md5_key)
2085 void tcp_md5_destruct_sock(struct sock *sk);
2086 #else
2087 static inline struct tcp_md5sig_key *
2088 tcp_md5_do_lookup(const struct sock *sk, int l3index,
2089 		  const union tcp_md5_addr *addr, int family)
2090 {
2091 	return NULL;
2092 }
2093 
2094 static inline struct tcp_md5sig_key *
2095 tcp_md5_do_lookup_any_l3index(const struct sock *sk,
2096 			      const union tcp_md5_addr *addr, int family)
2097 {
2098 	return NULL;
2099 }
2100 
2101 #define tcp_twsk_md5_key(twsk)	NULL
2102 static inline void tcp_md5_destruct_sock(struct sock *sk)
2103 {
2104 }
2105 #endif
2106 
2107 struct md5_ctx;
2108 void tcp_md5_hash_skb_data(struct md5_ctx *ctx, const struct sk_buff *skb,
2109 			   unsigned int header_len);
2110 void tcp_md5_hash_key(struct md5_ctx *ctx, const struct tcp_md5sig_key *key);
2111 
2112 /* From tcp_fastopen.c */
2113 void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
2114 			    struct tcp_fastopen_cookie *cookie);
2115 void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
2116 			    struct tcp_fastopen_cookie *cookie, bool syn_lost,
2117 			    u16 try_exp);
2118 struct tcp_fastopen_request {
2119 	/* Fast Open cookie. Size 0 means a cookie request */
2120 	struct tcp_fastopen_cookie	cookie;
2121 	struct msghdr			*data;  /* data in MSG_FASTOPEN */
2122 	size_t				size;
2123 	int				copied;	/* queued in tcp_connect() */
2124 	struct ubuf_info		*uarg;
2125 };
2126 void tcp_free_fastopen_req(struct tcp_sock *tp);
2127 void tcp_fastopen_destroy_cipher(struct sock *sk);
2128 void tcp_fastopen_ctx_destroy(struct net *net);
2129 int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk,
2130 			      void *primary_key, void *backup_key);
2131 int tcp_fastopen_get_cipher(struct net *net, struct inet_connection_sock *icsk,
2132 			    u64 *key);
2133 void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
2134 struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
2135 			      struct request_sock *req,
2136 			      struct tcp_fastopen_cookie *foc,
2137 			      const struct dst_entry *dst);
2138 void tcp_fastopen_init_key_once(struct net *net);
2139 bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
2140 			     struct tcp_fastopen_cookie *cookie);
2141 bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
2142 #define TCP_FASTOPEN_KEY_LENGTH sizeof(siphash_key_t)
2143 #define TCP_FASTOPEN_KEY_MAX 2
2144 #define TCP_FASTOPEN_KEY_BUF_LENGTH \
2145 	(TCP_FASTOPEN_KEY_LENGTH * TCP_FASTOPEN_KEY_MAX)
2146 
2147 /* Fastopen key context */
2148 struct tcp_fastopen_context {
2149 	siphash_key_t	key[TCP_FASTOPEN_KEY_MAX];
2150 	int		num;
2151 	struct rcu_head	rcu;
2152 };
2153 
2154 void tcp_fastopen_active_disable(struct sock *sk);
2155 bool tcp_fastopen_active_should_disable(struct sock *sk);
2156 void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
2157 void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired);
2158 
2159 /* Caller needs to wrap with rcu_read_(un)lock() */
2160 static inline
2161 struct tcp_fastopen_context *tcp_fastopen_get_ctx(const struct sock *sk)
2162 {
2163 	struct tcp_fastopen_context *ctx;
2164 
2165 	ctx = rcu_dereference(inet_csk(sk)->icsk_accept_queue.fastopenq.ctx);
2166 	if (!ctx)
2167 		ctx = rcu_dereference(sock_net(sk)->ipv4.tcp_fastopen_ctx);
2168 	return ctx;
2169 }
2170 
2171 static inline
2172 bool tcp_fastopen_cookie_match(const struct tcp_fastopen_cookie *foc,
2173 			       const struct tcp_fastopen_cookie *orig)
2174 {
2175 	if (orig->len == TCP_FASTOPEN_COOKIE_SIZE &&
2176 	    orig->len == foc->len &&
2177 	    !memcmp(orig->val, foc->val, foc->len))
2178 		return true;
2179 	return false;
2180 }
2181 
2182 static inline
2183 int tcp_fastopen_context_len(const struct tcp_fastopen_context *ctx)
2184 {
2185 	return ctx->num;
2186 }
2187 
2188 /* Latencies incurred by various limits for a sender. They are
2189  * chronograph-like stats that are mutually exclusive.
2190  */
2191 enum tcp_chrono {
2192 	TCP_CHRONO_UNSPEC,
2193 	TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
2194 	TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
2195 	TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
2196 	__TCP_CHRONO_MAX,
2197 };
2198 
2199 static inline void tcp_chrono_set(struct tcp_sock *tp, const enum tcp_chrono new)
2200 {
2201 	const u32 now = tcp_jiffies32;
2202 	enum tcp_chrono old = tp->chrono_type;
2203 
2204 	/* Following WRITE_ONCE()s pair with READ_ONCE()s in
2205 	 * tcp_get_info_chrono_stats().
2206 	 */
2207 	if (old > TCP_CHRONO_UNSPEC)
2208 		WRITE_ONCE(tp->chrono_stat[old - 1],
2209 			   tp->chrono_stat[old - 1] + now - tp->chrono_start);
2210 	WRITE_ONCE(tp->chrono_start, now);
2211 	WRITE_ONCE(tp->chrono_type, new);
2212 }
2213 
2214 static inline void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type)
2215 {
2216 	struct tcp_sock *tp = tcp_sk(sk);
2217 
2218 	/* If there are multiple conditions worthy of tracking in a
2219 	 * chronograph then the highest priority enum takes precedence
2220 	 * over the other conditions. So that if something "more interesting"
2221 	 * starts happening, stop the previous chrono and start a new one.
2222 	 */
2223 	if (type > tp->chrono_type)
2224 		tcp_chrono_set(tp, type);
2225 }
2226 
2227 void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);
2228 
2229 /* This helper is needed, because skb->tcp_tsorted_anchor uses
2230  * the same memory storage than skb->destructor/_skb_refdst
2231  */
2232 static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb)
2233 {
2234 	skb->destructor = NULL;
2235 	skb->_skb_refdst = 0UL;
2236 }
2237 
2238 #define tcp_skb_tsorted_save(skb) {		\
2239 	unsigned long _save = skb->_skb_refdst;	\
2240 	skb->_skb_refdst = 0UL;
2241 
2242 #define tcp_skb_tsorted_restore(skb)		\
2243 	skb->_skb_refdst = _save;		\
2244 }
2245 
2246 void tcp_write_queue_purge(struct sock *sk);
2247 
2248 static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk)
2249 {
2250 	return skb_rb_first(&sk->tcp_rtx_queue);
2251 }
2252 
2253 static inline struct sk_buff *tcp_rtx_queue_tail(const struct sock *sk)
2254 {
2255 	return skb_rb_last(&sk->tcp_rtx_queue);
2256 }
2257 
2258 static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
2259 {
2260 	return skb_peek_tail(&sk->sk_write_queue);
2261 }
2262 
2263 #define tcp_for_write_queue_from_safe(skb, tmp, sk)			\
2264 	skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
2265 
2266 static inline struct sk_buff *tcp_send_head(const struct sock *sk)
2267 {
2268 	return skb_peek(&sk->sk_write_queue);
2269 }
2270 
2271 static inline bool tcp_skb_is_last(const struct sock *sk,
2272 				   const struct sk_buff *skb)
2273 {
2274 	return skb_queue_is_last(&sk->sk_write_queue, skb);
2275 }
2276 
2277 /**
2278  * tcp_write_queue_empty - test if any payload (or FIN) is available in write queue
2279  * @sk: socket
2280  *
2281  * Since the write queue can have a temporary empty skb in it,
2282  * we must not use "return skb_queue_empty(&sk->sk_write_queue)"
2283  */
2284 static inline bool tcp_write_queue_empty(const struct sock *sk)
2285 {
2286 	const struct tcp_sock *tp = tcp_sk(sk);
2287 
2288 	return tp->write_seq == tp->snd_nxt;
2289 }
2290 
2291 static inline bool tcp_rtx_queue_empty(const struct sock *sk)
2292 {
2293 	return RB_EMPTY_ROOT(&sk->tcp_rtx_queue);
2294 }
2295 
2296 static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk)
2297 {
2298 	return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk);
2299 }
2300 
2301 static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
2302 {
2303 	__skb_queue_tail(&sk->sk_write_queue, skb);
2304 
2305 	/* Queue it, remembering where we must start sending. */
2306 	if (sk->sk_write_queue.next == skb)
2307 		tcp_chrono_start(sk, TCP_CHRONO_BUSY);
2308 }
2309 
2310 /* Insert new before skb on the write queue of sk.  */
2311 static inline void tcp_insert_write_queue_before(struct sk_buff *new,
2312 						  struct sk_buff *skb,
2313 						  struct sock *sk)
2314 {
2315 	__skb_queue_before(&sk->sk_write_queue, skb, new);
2316 }
2317 
2318 static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
2319 {
2320 	tcp_skb_tsorted_anchor_cleanup(skb);
2321 	__skb_unlink(skb, &sk->sk_write_queue);
2322 }
2323 
2324 void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb);
2325 
2326 static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk)
2327 {
2328 	tcp_skb_tsorted_anchor_cleanup(skb);
2329 	rb_erase(&skb->rbnode, &sk->tcp_rtx_queue);
2330 }
2331 
2332 static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk)
2333 {
2334 	list_del(&skb->tcp_tsorted_anchor);
2335 	tcp_rtx_queue_unlink(skb, sk);
2336 	tcp_wmem_free_skb(sk, skb);
2337 }
2338 
2339 static inline void tcp_write_collapse_fence(struct sock *sk)
2340 {
2341 	struct sk_buff *skb = tcp_write_queue_tail(sk) ?: tcp_rtx_queue_tail(sk);
2342 
2343 	if (skb)
2344 		TCP_SKB_CB(skb)->eor = 1;
2345 }
2346 
2347 static inline void tcp_push_pending_frames(struct sock *sk)
2348 {
2349 	if (tcp_send_head(sk)) {
2350 		struct tcp_sock *tp = tcp_sk(sk);
2351 
2352 		__tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
2353 	}
2354 }
2355 
2356 /* Start sequence of the skb just after the highest skb with SACKed
2357  * bit, valid only if sacked_out > 0 or when the caller has ensured
2358  * validity by itself.
2359  */
2360 static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
2361 {
2362 	if (!tp->sacked_out)
2363 		return tp->snd_una;
2364 
2365 	if (tp->highest_sack == NULL)
2366 		return tp->snd_nxt;
2367 
2368 	return TCP_SKB_CB(tp->highest_sack)->seq;
2369 }
2370 
2371 static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
2372 {
2373 	tcp_sk(sk)->highest_sack = skb_rb_next(skb);
2374 }
2375 
2376 static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
2377 {
2378 	return tcp_sk(sk)->highest_sack;
2379 }
2380 
2381 static inline void tcp_highest_sack_reset(struct sock *sk)
2382 {
2383 	tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk);
2384 }
2385 
2386 /* Called when old skb is about to be deleted and replaced by new skb */
2387 static inline void tcp_highest_sack_replace(struct sock *sk,
2388 					    struct sk_buff *old,
2389 					    struct sk_buff *new)
2390 {
2391 	if (old == tcp_highest_sack(sk))
2392 		tcp_sk(sk)->highest_sack = new;
2393 }
2394 
2395 /* This helper checks if socket has IP_TRANSPARENT set */
2396 static inline bool inet_sk_transparent(const struct sock *sk)
2397 {
2398 	switch (sk->sk_state) {
2399 	case TCP_TIME_WAIT:
2400 		return inet_twsk(sk)->tw_transparent;
2401 	case TCP_NEW_SYN_RECV:
2402 		return inet_rsk(inet_reqsk(sk))->no_srccheck;
2403 	}
2404 	return inet_test_bit(TRANSPARENT, sk);
2405 }
2406 
2407 /* Determines whether this is a thin stream (which may suffer from
2408  * increased latency). Used to trigger latency-reducing mechanisms.
2409  */
2410 static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
2411 {
2412 	return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
2413 }
2414 
2415 /* /proc */
2416 enum tcp_seq_states {
2417 	TCP_SEQ_STATE_LISTENING,
2418 	TCP_SEQ_STATE_ESTABLISHED,
2419 };
2420 
2421 void *tcp_seq_start(struct seq_file *seq, loff_t *pos);
2422 void *tcp_seq_next(struct seq_file *seq, void *v, loff_t *pos);
2423 void tcp_seq_stop(struct seq_file *seq, void *v);
2424 
2425 struct tcp_seq_afinfo {
2426 	sa_family_t			family;
2427 };
2428 
2429 struct tcp_iter_state {
2430 	struct seq_net_private	p;
2431 	enum tcp_seq_states	state;
2432 	struct sock		*syn_wait_sk;
2433 	int			bucket, offset, sbucket, num;
2434 	loff_t			last_pos;
2435 };
2436 
2437 extern struct request_sock_ops tcp_request_sock_ops;
2438 extern struct request_sock_ops tcp6_request_sock_ops;
2439 
2440 void tcp_v4_destroy_sock(struct sock *sk);
2441 
2442 struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
2443 				netdev_features_t features);
2444 struct sk_buff *tcp_gro_lookup(struct list_head *head, struct tcphdr *th);
2445 struct sk_buff *tcp_gro_receive(struct list_head *head, struct sk_buff *skb,
2446 				struct tcphdr *th);
2447 INDIRECT_CALLABLE_DECLARE(int tcp4_gro_complete(struct sk_buff *skb, int thoff));
2448 INDIRECT_CALLABLE_DECLARE(struct sk_buff *tcp4_gro_receive(struct list_head *head, struct sk_buff *skb));
2449 #ifdef CONFIG_INET
2450 void tcp_gro_complete(struct sk_buff *skb);
2451 #else
2452 static inline void tcp_gro_complete(struct sk_buff *skb) { }
2453 #endif
2454 
2455 static inline void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr,
2456 				       __be32 daddr)
2457 {
2458 	struct tcphdr *th = tcp_hdr(skb);
2459 
2460 	th->check = ~tcp_v4_check(skb->len, saddr, daddr, 0);
2461 	skb->csum_start = skb_transport_header(skb) - skb->head;
2462 	skb->csum_offset = offsetof(struct tcphdr, check);
2463 }
2464 
2465 static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
2466 {
2467 	struct net *net = sock_net((struct sock *)tp);
2468 	u32 val;
2469 
2470 	val = READ_ONCE(tp->notsent_lowat);
2471 
2472 	return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
2473 }
2474 
2475 bool tcp_stream_memory_free(const struct sock *sk, int wake);
2476 
2477 #ifdef CONFIG_PROC_FS
2478 int tcp4_proc_init(void);
2479 void tcp4_proc_exit(void);
2480 #endif
2481 
2482 int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
2483 int tcp_conn_request(struct request_sock_ops *rsk_ops,
2484 		     const struct tcp_request_sock_ops *af_ops,
2485 		     struct sock *sk, struct sk_buff *skb);
2486 
2487 /* TCP af-specific functions */
2488 struct tcp_sock_af_ops {
2489 #ifdef CONFIG_TCP_MD5SIG
2490 	struct tcp_md5sig_key	*(*md5_lookup) (const struct sock *sk,
2491 						const struct sock *addr_sk);
2492 	void		(*calc_md5_hash)(char *location,
2493 					 const struct tcp_md5sig_key *md5,
2494 					 const struct sock *sk,
2495 					 const struct sk_buff *skb);
2496 	int		(*md5_parse)(struct sock *sk,
2497 				     int optname,
2498 				     sockptr_t optval,
2499 				     int optlen);
2500 #endif
2501 #ifdef CONFIG_TCP_AO
2502 	int (*ao_parse)(struct sock *sk, int optname, sockptr_t optval, int optlen);
2503 	struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2504 					struct sock *addr_sk,
2505 					int sndid, int rcvid);
2506 	void (*ao_calc_key_sk)(struct tcp_ao_key *mkt, u8 *key,
2507 			       const struct sock *sk,
2508 			       __be32 sisn, __be32 disn, bool send);
2509 	int (*calc_ao_hash)(char *location, struct tcp_ao_key *ao,
2510 			    const struct sock *sk, const struct sk_buff *skb,
2511 			    const u8 *tkey, int hash_offset, u32 sne);
2512 #endif
2513 };
2514 
2515 struct tcp_request_sock_ops {
2516 	u16 mss_clamp;
2517 #ifdef CONFIG_TCP_MD5SIG
2518 	struct tcp_md5sig_key *(*req_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 #endif
2525 #ifdef CONFIG_TCP_AO
2526 	struct tcp_ao_key *(*ao_lookup)(const struct sock *sk,
2527 					struct request_sock *req,
2528 					int sndid, int rcvid);
2529 	void (*ao_calc_key)(struct tcp_ao_key *mkt, u8 *key, struct request_sock *sk);
2530 	int (*ao_synack_hash)(char *ao_hash, struct tcp_ao_key *mkt,
2531 			      struct request_sock *req, const struct sk_buff *skb,
2532 			      int hash_offset, u32 sne);
2533 #endif
2534 #ifdef CONFIG_SYN_COOKIES
2535 	__u32 (*cookie_init_seq)(const struct sk_buff *skb,
2536 				 __u16 *mss);
2537 #endif
2538 	struct dst_entry *(*route_req)(const struct sock *sk,
2539 				       struct sk_buff *skb,
2540 				       struct flowi *fl,
2541 				       struct request_sock *req,
2542 				       u32 tw_isn);
2543 	union tcp_seq_and_ts_off (*init_seq_and_ts_off)(
2544 					const struct net *net,
2545 					const struct sk_buff *skb);
2546 	int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
2547 			   struct flowi *fl, struct request_sock *req,
2548 			   struct tcp_fastopen_cookie *foc,
2549 			   enum tcp_synack_type synack_type,
2550 			   struct sk_buff *syn_skb);
2551 };
2552 
2553 extern const struct tcp_request_sock_ops tcp_request_sock_ipv4_ops;
2554 #if IS_ENABLED(CONFIG_IPV6)
2555 extern const struct tcp_request_sock_ops tcp_request_sock_ipv6_ops;
2556 #endif
2557 
2558 #ifdef CONFIG_SYN_COOKIES
2559 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
2560 					 struct sk_buff *skb, __u16 *mss)
2561 {
2562 	return ops->cookie_init_seq(skb, mss);
2563 }
2564 #else
2565 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
2566 					 struct sk_buff *skb, __u16 *mss)
2567 {
2568 	return 0;
2569 }
2570 #endif
2571 
2572 #ifdef CONFIG_SYN_COOKIES
2573 static inline void cookie_record_sent(const struct sock *sk)
2574 {
2575 	tcp_synq_overflow(sk);
2576 	__NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
2577 }
2578 #else
2579 static inline void cookie_record_sent(const struct sock *sk)
2580 {
2581 }
2582 #endif
2583 
2584 struct tcp_key {
2585 	union {
2586 		struct {
2587 			struct tcp_ao_key *ao_key;
2588 			char *traffic_key;
2589 			u32 sne;
2590 			u8 rcv_next;
2591 		};
2592 		struct tcp_md5sig_key *md5_key;
2593 	};
2594 	enum {
2595 		TCP_KEY_NONE = 0,
2596 		TCP_KEY_MD5,
2597 		TCP_KEY_AO,
2598 	} type;
2599 };
2600 
2601 static inline void tcp_get_current_key(const struct sock *sk,
2602 				       struct tcp_key *out)
2603 {
2604 #if defined(CONFIG_TCP_AO) || defined(CONFIG_TCP_MD5SIG)
2605 	const struct tcp_sock *tp = tcp_sk(sk);
2606 #endif
2607 
2608 #ifdef CONFIG_TCP_AO
2609 	if (static_branch_unlikely(&tcp_ao_needed.key)) {
2610 		struct tcp_ao_info *ao;
2611 
2612 		ao = rcu_dereference_protected(tp->ao_info,
2613 					       lockdep_sock_is_held(sk));
2614 		if (ao) {
2615 			out->ao_key = READ_ONCE(ao->current_key);
2616 			out->type = TCP_KEY_AO;
2617 			return;
2618 		}
2619 	}
2620 #endif
2621 #ifdef CONFIG_TCP_MD5SIG
2622 	if (static_branch_unlikely(&tcp_md5_needed.key) &&
2623 	    rcu_access_pointer(tp->md5sig_info)) {
2624 		out->md5_key = tp->af_specific->md5_lookup(sk, sk);
2625 		if (out->md5_key) {
2626 			out->type = TCP_KEY_MD5;
2627 			return;
2628 		}
2629 	}
2630 #endif
2631 	out->type = TCP_KEY_NONE;
2632 }
2633 
2634 static inline bool tcp_key_is_md5(const struct tcp_key *key)
2635 {
2636 	if (static_branch_tcp_md5())
2637 		return key->type == TCP_KEY_MD5;
2638 	return false;
2639 }
2640 
2641 static inline bool tcp_key_is_ao(const struct tcp_key *key)
2642 {
2643 	if (static_branch_tcp_ao())
2644 		return key->type == TCP_KEY_AO;
2645 	return false;
2646 }
2647 
2648 int tcpv4_offload_init(void);
2649 
2650 void tcp_v4_init(void);
2651 void tcp_init(void);
2652 
2653 /* tcp_recovery.c */
2654 void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb);
2655 void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced);
2656 extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb,
2657 				u32 reo_wnd);
2658 extern bool tcp_rack_mark_lost(struct sock *sk);
2659 extern void tcp_rack_reo_timeout(struct sock *sk);
2660 
2661 /* tcp_plb.c */
2662 
2663 /*
2664  * Scaling factor for fractions in PLB. For example, tcp_plb_update_state
2665  * expects cong_ratio which represents fraction of traffic that experienced
2666  * congestion over a single RTT. In order to avoid floating point operations,
2667  * this fraction should be mapped to (1 << TCP_PLB_SCALE) and passed in.
2668  */
2669 #define TCP_PLB_SCALE 8
2670 
2671 /* State for PLB (Protective Load Balancing) for a single TCP connection. */
2672 struct tcp_plb_state {
2673 	u8	consec_cong_rounds:5, /* consecutive congested rounds */
2674 		unused:3;
2675 	u32	pause_until; /* jiffies32 when PLB can resume rerouting */
2676 };
2677 
2678 static inline void tcp_plb_init(const struct sock *sk,
2679 				struct tcp_plb_state *plb)
2680 {
2681 	plb->consec_cong_rounds = 0;
2682 	plb->pause_until = 0;
2683 }
2684 void tcp_plb_update_state(const struct sock *sk, struct tcp_plb_state *plb,
2685 			  const int cong_ratio);
2686 void tcp_plb_check_rehash(struct sock *sk, struct tcp_plb_state *plb);
2687 void tcp_plb_update_state_upon_rto(struct sock *sk, struct tcp_plb_state *plb);
2688 
2689 static inline void tcp_warn_once(const struct sock *sk, bool cond, const char *str)
2690 {
2691 	WARN_ONCE(cond,
2692 		  "%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",
2693 		  str,
2694 		  tcp_snd_cwnd(tcp_sk(sk)),
2695 		  tcp_sk(sk)->packets_out, tcp_sk(sk)->sacked_out,
2696 		  tcp_sk(sk)->lost_out, tcp_sk(sk)->retrans_out,
2697 		  tcp_sk(sk)->tlp_high_seq, sk->sk_state,
2698 		  inet_csk(sk)->icsk_ca_state,
2699 		  tcp_sk(sk)->advmss, tcp_sk(sk)->mss_cache,
2700 		  inet_csk(sk)->icsk_pmtu_cookie);
2701 }
2702 
2703 /* At how many usecs into the future should the RTO fire? */
2704 static inline s64 tcp_rto_delta_us(const struct sock *sk)
2705 {
2706 	const struct sk_buff *skb = tcp_rtx_queue_head(sk);
2707 	u32 rto = inet_csk(sk)->icsk_rto;
2708 
2709 	if (likely(skb)) {
2710 		u64 rto_time_stamp_us = tcp_skb_timestamp_us(skb) + jiffies_to_usecs(rto);
2711 
2712 		return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp;
2713 	} else {
2714 		tcp_warn_once(sk, 1, "rtx queue empty: ");
2715 		return jiffies_to_usecs(rto);
2716 	}
2717 
2718 }
2719 
2720 /*
2721  * Save and compile IPv4 options, return a pointer to it
2722  */
2723 static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net,
2724 							 struct sk_buff *skb)
2725 {
2726 	const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
2727 	struct ip_options_rcu *dopt = NULL;
2728 
2729 	if (opt->optlen) {
2730 		int opt_size = sizeof(*dopt) + opt->optlen;
2731 
2732 		dopt = kmalloc(opt_size, GFP_ATOMIC);
2733 		if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) {
2734 			kfree(dopt);
2735 			dopt = NULL;
2736 		}
2737 	}
2738 	return dopt;
2739 }
2740 
2741 /* locally generated TCP pure ACKs have skb->truesize == 2
2742  * (check tcp_send_ack() in net/ipv4/tcp_output.c )
2743  * This is much faster than dissecting the packet to find out.
2744  * (Think of GRE encapsulations, IPv4, IPv6, ...)
2745  */
2746 static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
2747 {
2748 	return skb->truesize == 2;
2749 }
2750 
2751 static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
2752 {
2753 	skb->truesize = 2;
2754 }
2755 
2756 static inline int tcp_inq(struct sock *sk)
2757 {
2758 	struct tcp_sock *tp = tcp_sk(sk);
2759 	int answ;
2760 
2761 	if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
2762 		answ = 0;
2763 	} else if (sock_flag(sk, SOCK_URGINLINE) ||
2764 		   !tp->urg_data ||
2765 		   before(tp->urg_seq, tp->copied_seq) ||
2766 		   !before(tp->urg_seq, tp->rcv_nxt)) {
2767 
2768 		answ = tp->rcv_nxt - tp->copied_seq;
2769 
2770 		/* Subtract 1, if FIN was received */
2771 		if (answ && sock_flag(sk, SOCK_DONE))
2772 			answ--;
2773 	} else {
2774 		answ = tp->urg_seq - tp->copied_seq;
2775 	}
2776 
2777 	return answ;
2778 }
2779 
2780 int tcp_peek_len(struct socket *sock);
2781 
2782 static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
2783 {
2784 	u16 segs_in;
2785 
2786 	segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2787 
2788 	/* We update these fields while other threads might
2789 	 * read them from tcp_get_info()
2790 	 */
2791 	WRITE_ONCE(tp->segs_in, tp->segs_in + segs_in);
2792 	if (skb->len > tcp_hdrlen(skb))
2793 		WRITE_ONCE(tp->data_segs_in, tp->data_segs_in + segs_in);
2794 }
2795 
2796 /*
2797  * TCP listen path runs lockless.
2798  * We forced "struct sock" to be const qualified to make sure
2799  * we don't modify one of its field by mistake.
2800  * Here, we increment sk_drops which is an atomic_t, so we can safely
2801  * make sock writable again.
2802  */
2803 static inline void tcp_listendrop(const struct sock *sk)
2804 {
2805 	sk_drops_inc((struct sock *)sk);
2806 	__NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
2807 }
2808 
2809 enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);
2810 
2811 /*
2812  * Interface for adding Upper Level Protocols over TCP
2813  */
2814 
2815 #define TCP_ULP_NAME_MAX	16
2816 #define TCP_ULP_MAX		128
2817 #define TCP_ULP_BUF_MAX		(TCP_ULP_NAME_MAX*TCP_ULP_MAX)
2818 
2819 struct tcp_ulp_ops {
2820 	struct list_head	list;
2821 
2822 	/* initialize ulp */
2823 	int (*init)(struct sock *sk);
2824 	/* update ulp */
2825 	void (*update)(struct sock *sk, struct proto *p,
2826 		       void (*write_space)(struct sock *sk));
2827 	/* cleanup ulp */
2828 	void (*release)(struct sock *sk);
2829 	/* diagnostic */
2830 	int (*get_info)(struct sock *sk, struct sk_buff *skb, bool net_admin);
2831 	size_t (*get_info_size)(const struct sock *sk, bool net_admin);
2832 	/* clone ulp */
2833 	void (*clone)(const struct request_sock *req, struct sock *newsk,
2834 		      const gfp_t priority);
2835 
2836 	char		name[TCP_ULP_NAME_MAX];
2837 	struct module	*owner;
2838 };
2839 int tcp_register_ulp(struct tcp_ulp_ops *type);
2840 void tcp_unregister_ulp(struct tcp_ulp_ops *type);
2841 int tcp_set_ulp(struct sock *sk, const char *name);
2842 void tcp_get_available_ulp(char *buf, size_t len);
2843 void tcp_cleanup_ulp(struct sock *sk);
2844 void tcp_update_ulp(struct sock *sk, struct proto *p,
2845 		    void (*write_space)(struct sock *sk));
2846 
2847 #define MODULE_ALIAS_TCP_ULP(name)				\
2848 	MODULE_INFO(alias, name);		\
2849 	MODULE_INFO(alias, "tcp-ulp-" name)
2850 
2851 #ifdef CONFIG_NET_SOCK_MSG
2852 struct sk_msg;
2853 struct sk_psock;
2854 
2855 #ifdef CONFIG_BPF_SYSCALL
2856 int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore);
2857 void tcp_bpf_clone(const struct sock *sk, struct sock *newsk);
2858 #ifdef CONFIG_BPF_STREAM_PARSER
2859 struct strparser;
2860 int tcp_bpf_strp_read_sock(struct strparser *strp, read_descriptor_t *desc,
2861 			   sk_read_actor_t recv_actor);
2862 #endif /* CONFIG_BPF_STREAM_PARSER */
2863 #endif /* CONFIG_BPF_SYSCALL */
2864 
2865 #ifdef CONFIG_INET
2866 void tcp_eat_skb(struct sock *sk, struct sk_buff *skb);
2867 #else
2868 static inline void tcp_eat_skb(struct sock *sk, struct sk_buff *skb)
2869 {
2870 }
2871 #endif
2872 
2873 int tcp_bpf_sendmsg_redir(struct sock *sk, bool ingress,
2874 			  struct sk_msg *msg, u32 bytes, int flags);
2875 #endif /* CONFIG_NET_SOCK_MSG */
2876 
2877 #if !defined(CONFIG_BPF_SYSCALL) || !defined(CONFIG_NET_SOCK_MSG)
2878 static inline void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
2879 {
2880 }
2881 #endif
2882 
2883 #ifdef CONFIG_CGROUP_BPF
2884 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2885 				      struct sk_buff *skb,
2886 				      unsigned int end_offset)
2887 {
2888 	skops->skb = skb;
2889 	skops->skb_data_end = skb->data + end_offset;
2890 }
2891 #else
2892 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops,
2893 				      struct sk_buff *skb,
2894 				      unsigned int end_offset)
2895 {
2896 }
2897 #endif
2898 
2899 /* Call BPF_SOCK_OPS program that returns an int. If the return value
2900  * is < 0, then the BPF op failed (for example if the loaded BPF
2901  * program does not support the chosen operation or there is no BPF
2902  * program loaded).
2903  */
2904 #ifdef CONFIG_BPF
2905 static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
2906 {
2907 	struct bpf_sock_ops_kern sock_ops;
2908 	int ret;
2909 
2910 	memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp));
2911 	if (sk_fullsock(sk)) {
2912 		sock_ops.is_fullsock = 1;
2913 		sock_ops.is_locked_tcp_sock = 1;
2914 		sock_owned_by_me(sk);
2915 	}
2916 
2917 	sock_ops.sk = sk;
2918 	sock_ops.op = op;
2919 	if (nargs > 0)
2920 		memcpy(sock_ops.args, args, nargs * sizeof(*args));
2921 
2922 	ret = BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops);
2923 	if (ret == 0)
2924 		ret = sock_ops.reply;
2925 	else
2926 		ret = -1;
2927 	return ret;
2928 }
2929 
2930 static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2931 {
2932 	u32 args[2] = {arg1, arg2};
2933 
2934 	return tcp_call_bpf(sk, op, 2, args);
2935 }
2936 
2937 static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2938 				    u32 arg3)
2939 {
2940 	u32 args[3] = {arg1, arg2, arg3};
2941 
2942 	return tcp_call_bpf(sk, op, 3, args);
2943 }
2944 
2945 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk)
2946 {
2947 	tcp_sk(sk)->bpf_sock_ops_cb_flags = 0;
2948 }
2949 
2950 #else
2951 static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
2952 {
2953 	return -EPERM;
2954 }
2955 
2956 static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2957 {
2958 	return -EPERM;
2959 }
2960 
2961 static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2962 				    u32 arg3)
2963 {
2964 	return -EPERM;
2965 }
2966 
2967 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk)
2968 {
2969 }
2970 
2971 #endif
2972 
2973 static inline u32 tcp_timeout_init(struct sock *sk)
2974 {
2975 	int timeout;
2976 
2977 	timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT, 0, NULL);
2978 
2979 	if (timeout <= 0)
2980 		timeout = TCP_TIMEOUT_INIT;
2981 	return min_t(int, timeout, TCP_RTO_MAX);
2982 }
2983 
2984 static inline u32 tcp_rwnd_init_bpf(struct sock *sk)
2985 {
2986 	int rwnd;
2987 
2988 	rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT, 0, NULL);
2989 
2990 	if (rwnd < 0)
2991 		rwnd = 0;
2992 	return rwnd;
2993 }
2994 
2995 static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk)
2996 {
2997 	return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN, 0, NULL) == 1);
2998 }
2999 
3000 static inline void tcp_bpf_rtt(struct sock *sk, long mrtt, u32 srtt)
3001 {
3002 	if (BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), BPF_SOCK_OPS_RTT_CB_FLAG))
3003 		tcp_call_bpf_2arg(sk, BPF_SOCK_OPS_RTT_CB, mrtt, srtt);
3004 }
3005 
3006 #if IS_ENABLED(CONFIG_SMC)
3007 extern struct static_key_false tcp_have_smc;
3008 #endif
3009 
3010 #if IS_ENABLED(CONFIG_TLS_DEVICE)
3011 void clean_acked_data_enable(struct tcp_sock *tp,
3012 			     void (*cad)(struct sock *sk, u32 ack_seq));
3013 void clean_acked_data_disable(struct tcp_sock *tp);
3014 void clean_acked_data_flush(void);
3015 #endif
3016 
3017 DECLARE_STATIC_KEY_FALSE(tcp_tx_delay_enabled);
3018 static inline void tcp_add_tx_delay(struct sk_buff *skb,
3019 				    const struct tcp_sock *tp)
3020 {
3021 	if (static_branch_unlikely(&tcp_tx_delay_enabled))
3022 		skb->skb_mstamp_ns += (u64)tp->tcp_tx_delay * NSEC_PER_USEC;
3023 }
3024 
3025 /* Compute Earliest Departure Time for some control packets
3026  * like ACK or RST for TIME_WAIT or non ESTABLISHED sockets.
3027  */
3028 static inline u64 tcp_transmit_time(const struct sock *sk)
3029 {
3030 	if (static_branch_unlikely(&tcp_tx_delay_enabled)) {
3031 		u32 delay = (sk->sk_state == TCP_TIME_WAIT) ?
3032 			tcp_twsk(sk)->tw_tx_delay : tcp_sk(sk)->tcp_tx_delay;
3033 
3034 		return tcp_clock_ns() + (u64)delay * NSEC_PER_USEC;
3035 	}
3036 	return 0;
3037 }
3038 
3039 static inline int tcp_parse_auth_options(const struct tcphdr *th,
3040 		const u8 **md5_hash, const struct tcp_ao_hdr **aoh)
3041 {
3042 	const u8 *md5_tmp, *ao_tmp;
3043 	int ret;
3044 
3045 	ret = tcp_do_parse_auth_options(th, &md5_tmp, &ao_tmp);
3046 	if (ret)
3047 		return ret;
3048 
3049 	if (md5_hash)
3050 		*md5_hash = md5_tmp;
3051 
3052 	if (aoh) {
3053 		if (!ao_tmp)
3054 			*aoh = NULL;
3055 		else
3056 			*aoh = (struct tcp_ao_hdr *)(ao_tmp - 2);
3057 	}
3058 
3059 	return 0;
3060 }
3061 
3062 static inline bool tcp_ao_required(struct sock *sk, const void *saddr,
3063 				   int family, int l3index, bool stat_inc)
3064 {
3065 #ifdef CONFIG_TCP_AO
3066 	struct tcp_ao_info *ao_info;
3067 	struct tcp_ao_key *ao_key;
3068 
3069 	if (!static_branch_unlikely(&tcp_ao_needed.key))
3070 		return false;
3071 
3072 	ao_info = rcu_dereference_check(tcp_sk(sk)->ao_info,
3073 					lockdep_sock_is_held(sk));
3074 	if (!ao_info)
3075 		return false;
3076 
3077 	ao_key = tcp_ao_do_lookup(sk, l3index, saddr, family, -1, -1);
3078 	if (ao_info->ao_required || ao_key) {
3079 		if (stat_inc) {
3080 			NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAOREQUIRED);
3081 			atomic64_inc(&ao_info->counters.ao_required);
3082 		}
3083 		return true;
3084 	}
3085 #endif
3086 	return false;
3087 }
3088 
3089 enum skb_drop_reason tcp_inbound_hash(struct sock *sk,
3090 		const struct request_sock *req, const struct sk_buff *skb,
3091 		const void *saddr, const void *daddr,
3092 		int family, int dif, int sdif);
3093 
3094 static inline int tcp_recv_should_stop(struct sock *sk)
3095 {
3096 	return sk->sk_err ||
3097 	       sk->sk_state == TCP_CLOSE ||
3098 	       (sk->sk_shutdown & RCV_SHUTDOWN) ||
3099 	       signal_pending(current);
3100 }
3101 
3102 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off
3103 			  tcp_v4_init_seq_and_ts_off(const struct net *net,
3104 						     const struct sk_buff *skb));
3105 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off
3106 			  tcp_v6_init_seq_and_ts_off(const struct net *net,
3107 						     const struct sk_buff *skb));
3108 #endif	/* _TCP_H */
3109