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