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