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