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