]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/tcp.h
net: mscc: Add SPDX identifier
[mirror_ubuntu-jammy-kernel.git] / include / net / tcp.h
CommitLineData
1da177e4
LT
1/*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the TCP module.
7 *
8 * Version: @(#)tcp.h 1.0.5 05/23/93
9 *
02c30a84 10 * Authors: Ross Biro
1da177e4
LT
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 */
18#ifndef _TCP_H
19#define _TCP_H
20
1da177e4
LT
21#define FASTRETRANS_DEBUG 1
22
1da177e4
LT
23#include <linux/list.h>
24#include <linux/tcp.h>
187f1882 25#include <linux/bug.h>
1da177e4
LT
26#include <linux/slab.h>
27#include <linux/cache.h>
28#include <linux/percpu.h>
fb286bb2 29#include <linux/skbuff.h>
c6aefafb 30#include <linux/cryptohash.h>
435cf559 31#include <linux/kref.h>
740b0f18 32#include <linux/ktime.h>
3f421baa
ACM
33
34#include <net/inet_connection_sock.h>
295ff7ed 35#include <net/inet_timewait_sock.h>
77d8bf9c 36#include <net/inet_hashtables.h>
1da177e4 37#include <net/checksum.h>
2e6599cb 38#include <net/request_sock.h>
1da177e4
LT
39#include <net/sock.h>
40#include <net/snmp.h>
41#include <net/ip.h>
c752f073 42#include <net/tcp_states.h>
bdf1ee5d 43#include <net/inet_ecn.h>
0c266898 44#include <net/dst.h>
c752f073 45
1da177e4 46#include <linux/seq_file.h>
180d8cd9 47#include <linux/memcontrol.h>
40304b2a
LB
48#include <linux/bpf-cgroup.h>
49
6e04e021 50extern struct inet_hashinfo tcp_hashinfo;
1da177e4 51
dd24c001 52extern struct percpu_counter tcp_orphan_count;
5c9f3023 53void tcp_time_wait(struct sock *sk, int state, int timeo);
1da177e4 54
1da177e4 55#define MAX_TCP_HEADER (128 + MAX_HEADER)
33ad798c 56#define MAX_TCP_OPTION_SPACE 40
1da177e4 57
105970f6 58/*
1da177e4 59 * Never offer a window over 32767 without using window scaling. Some
105970f6 60 * poor stacks do signed 16bit maths!
1da177e4
LT
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
5d424d5a 67/* The least MTU to use for probing */
dcd8fb85 68#define TCP_BASE_MSS 1024
5d424d5a 69
05cbc0db
FD
70/* probing interval, default to 10 minutes as per RFC4821 */
71#define TCP_PROBE_INTERVAL 600
72
6b58e0a5
FD
73/* Specify interval when tcp mtu probing will stop */
74#define TCP_PROBE_THRESHOLD 8
75
1da177e4
LT
76/* After receiving this amount of duplicate ACKs fast retransmit starts. */
77#define TCP_FASTRETRANS_THRESH 3
78
1da177e4
LT
79/* Maximal number of ACKs sent quickly to accelerate slow-start. */
80#define TCP_MAX_QUICKACKS 16U
81
589c49cb
GF
82/* Maximal number of window scale according to RFC1323 */
83#define TCP_MAX_WSCALE 14U
84
1da177e4
LT
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
6c9ff979
AB
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 */
1da177e4 112
6c9ff979
AB
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 */
1da177e4 119
1da177e4
LT
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))
bb4d991a 139#define TCP_TIMEOUT_MIN (2U) /* Min timeout for TCP timers in jiffies */
fd4f2cea 140#define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC6298 2.1 initial RTO value */
9ad7c049
JC
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 */
1da177e4
LT
147
148#define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
149 * for local resources.
150 */
1da177e4
LT
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 */
1da177e4
LT
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 */
1da177e4
LT
173/*
174 * TCP option
175 */
105970f6 176
1da177e4
LT
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 */
cfb6eeb4 184#define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */
7f9b838b 185#define TCPOPT_FASTOPEN 34 /* Fast open (RFC7413) */
2100c8d2
YC
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
60e2a778 191#define TCPOPT_SMC_MAGIC 0xE2D4C3D9
1da177e4
LT
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
cfb6eeb4 201#define TCPOLEN_MD5SIG 18
7f9b838b 202#define TCPOLEN_FASTOPEN_BASE 2
2100c8d2 203#define TCPOLEN_EXP_FASTOPEN_BASE 4
60e2a778 204#define TCPOLEN_EXP_SMC_BASE 6
1da177e4
LT
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
cfb6eeb4 213#define TCPOLEN_MD5SIG_ALIGNED 20
33ad798c 214#define TCPOLEN_MSS_ALIGNED 4
60e2a778 215#define TCPOLEN_EXP_SMC_BASE_ALIGNED 8
1da177e4 216
1da177e4
LT
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 */
caa20d9a 220#define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */
1da177e4 221
36e31b0a
AP
222/* TCP thin-stream limits */
223#define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */
224
21603fc4 225/* TCP initial congestion window as per rfc6928 */
442b9635
DM
226#define TCP_INIT_CWND 10
227
cf60af03
YC
228/* Bit Flags for sysctl_tcp_fastopen */
229#define TFO_CLIENT_ENABLE 1
10467163 230#define TFO_SERVER_ENABLE 2
67da22d2 231#define TFO_CLIENT_NO_COOKIE 4 /* Data in SYN w/o cookie option */
cf60af03 232
10467163
JC
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
cebc5cba 237 * TCP_FASTOPEN socket option.
10467163
JC
238 */
239#define TFO_SERVER_WO_SOCKOPT1 0x400
10467163 240
295ff7ed 241
1da177e4 242/* sysctl variables for tcp */
1da177e4 243extern int sysctl_tcp_max_orphans;
a4fe34bf 244extern long sysctl_tcp_mem[3];
e20223f1 245
a0370b3f 246#define TCP_RACK_LOSS_DETECTION 0x1 /* Use RACK to detect losses */
1f255691 247#define TCP_RACK_STATIC_REO_WND 0x2 /* Use static RACK reo wnd */
20b654df 248#define TCP_RACK_NO_DUPTHRESH 0x4 /* Do not use DUPACK threshold in RACK */
a0370b3f 249
8d987e5c 250extern atomic_long_t tcp_memory_allocated;
1748376b 251extern struct percpu_counter tcp_sockets_allocated;
06044751 252extern unsigned long tcp_memory_pressure;
1da177e4 253
b8da51eb
ED
254/* optimized version of sk_under_memory_pressure() for TCP sockets */
255static inline bool tcp_under_memory_pressure(const struct sock *sk)
256{
baac50bb
JW
257 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
258 mem_cgroup_under_socket_pressure(sk->sk_memcg))
e805605c 259 return true;
b8da51eb
ED
260
261 return tcp_memory_pressure;
262}
1da177e4
LT
263/*
264 * The next routines deal with comparing 32 bit unsigned ints
265 * and worry about wraparound (automatic with unsigned arithmetic).
266 */
267
a2a385d6 268static inline bool before(__u32 seq1, __u32 seq2)
1da177e4 269{
0d630cc0 270 return (__s32)(seq1-seq2) < 0;
1da177e4 271}
9a036b9c 272#define after(seq2, seq1) before(seq1, seq2)
1da177e4
LT
273
274/* is s2<=s1<=s3 ? */
a2a385d6 275static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
1da177e4
LT
276{
277 return seq3 - seq2 >= seq1 - seq2;
278}
279
efcdbf24
AS
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
a6c5ea4c
ED
288void sk_forced_mem_schedule(struct sock *sk, int size);
289
ad1af0fe 290static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
e4fd5da3 291{
ad1af0fe
DM
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 }
ad1af0fe 300 return false;
e4fd5da3 301}
1da177e4 302
5c9f3023 303bool tcp_check_oom(struct sock *sk, int shift);
efcdbf24 304
a0f82f64 305
1da177e4
LT
306extern struct proto tcp_prot;
307
57ef42d5 308#define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field)
13415e46 309#define __TCP_INC_STATS(net, field) __SNMP_INC_STATS((net)->mib.tcp_statistics, field)
57ef42d5 310#define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
aa2ea058 311#define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
1da177e4 312
5c9f3023
JP
313void tcp_tasklet_init(void);
314
315void tcp_v4_err(struct sk_buff *skb, u32);
316
317void tcp_shutdown(struct sock *sk, int how);
318
7487449c 319int tcp_v4_early_demux(struct sk_buff *skb);
5c9f3023
JP
320int tcp_v4_rcv(struct sk_buff *skb);
321
322int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
1b784140 323int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
306b13eb 324int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size);
5c9f3023
JP
325int tcp_sendpage(struct sock *sk, struct page *page, int offset, size_t size,
326 int flags);
306b13eb
TH
327int tcp_sendpage_locked(struct sock *sk, struct page *page, int offset,
328 size_t size, int flags);
e3b5616a
DW
329ssize_t do_tcp_sendpages(struct sock *sk, struct page *page, int offset,
330 size_t size, int flags);
5c9f3023
JP
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);
72ab4a86 336int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb);
5c9f3023 337void tcp_rcv_established(struct sock *sk, struct sk_buff *skb,
e42e24c3 338 const struct tcphdr *th);
5c9f3023 339void tcp_rcv_space_adjust(struct sock *sk);
5c9f3023
JP
340int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
341void tcp_twsk_destructor(struct sock *sk);
342ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
343 struct pipe_inode_info *pipe, size_t len,
344 unsigned int flags);
9c55e01c 345
463c84b9
ACM
346static inline void tcp_dec_quickack_mode(struct sock *sk,
347 const unsigned int pkts)
1da177e4 348{
463c84b9 349 struct inet_connection_sock *icsk = inet_csk(sk);
fc6415bc 350
463c84b9
ACM
351 if (icsk->icsk_ack.quick) {
352 if (pkts >= icsk->icsk_ack.quick) {
353 icsk->icsk_ack.quick = 0;
fc6415bc 354 /* Leaving quickack mode we deflate ATO. */
463c84b9 355 icsk->icsk_ack.ato = TCP_ATO_MIN;
fc6415bc 356 } else
463c84b9 357 icsk->icsk_ack.quick -= pkts;
1da177e4
LT
358 }
359}
360
bdf1ee5d
IJ
361#define TCP_ECN_OK 1
362#define TCP_ECN_QUEUE_CWR 2
363#define TCP_ECN_DEMAND_CWR 4
7a269ffa 364#define TCP_ECN_SEEN 8
bdf1ee5d 365
fd2c3ef7 366enum tcp_tw_status {
1da177e4
LT
367 TCP_TW_SUCCESS = 0,
368 TCP_TW_RST = 1,
369 TCP_TW_ACK = 2,
370 TCP_TW_SYN = 3
371};
372
373
5c9f3023
JP
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,
e0f9759f
ED
378 struct request_sock *req, bool fastopen,
379 bool *lost_race);
5c9f3023
JP
380int tcp_child_process(struct sock *parent, struct sock *child,
381 struct sk_buff *skb);
5ae344c9 382void tcp_enter_loss(struct sock *sk);
57dde7f7 383void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int flag);
5c9f3023
JP
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);
d82bae12 388bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst);
5c9f3023
JP
389void tcp_close(struct sock *sk, long timeout);
390void tcp_init_sock(struct sock *sk);
27204aaa 391void tcp_init_transfer(struct sock *sk, int bpf_op);
ade994f4 392__poll_t tcp_poll(struct file *file, struct socket *sock,
5c9f3023
JP
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,
53d3176b 399 char __user *optval, int __user *optlen);
5c9f3023 400int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
53d3176b 401 char __user *optval, unsigned int optlen);
5c9f3023 402void tcp_set_keepalive(struct sock *sk, int val);
42cb80a2 403void tcp_syn_ack_timeout(const struct request_sock *req);
1b784140
YX
404int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int nonblock,
405 int flags, int *addr_len);
d1361840 406int tcp_set_rcvlowat(struct sock *sk, int val);
03f45c88 407void tcp_data_ready(struct sock *sk);
93ab6cc6
ED
408int tcp_mmap(struct file *file, struct socket *sock,
409 struct vm_area_struct *vma);
eed29f17 410void tcp_parse_options(const struct net *net, const struct sk_buff *skb,
5c9f3023
JP
411 struct tcp_options_received *opt_rx,
412 int estab, struct tcp_fastopen_cookie *foc);
413const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
7d5d5525 414
1da177e4
LT
415/*
416 * TCP v4 functions exported for the inet6 API
417 */
418
5c9f3023 419void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
4fab9071 420void tcp_v4_mtu_reduced(struct sock *sk);
9cf74903 421void tcp_req_err(struct sock *sk, u32 seq, bool abort);
5c9f3023 422int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
c28c6f04 423struct sock *tcp_create_openreq_child(const struct sock *sk,
5c9f3023
JP
424 struct request_sock *req,
425 struct sk_buff *skb);
81164413 426void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
0c27171e 427struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb,
5c9f3023 428 struct request_sock *req,
5e0724d0
ED
429 struct dst_entry *dst,
430 struct request_sock *req_unhash,
431 bool *own_req);
5c9f3023
JP
432int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
433int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len);
434int tcp_connect(struct sock *sk);
b3d05147
ED
435enum tcp_synack_type {
436 TCP_SYNACK_NORMAL,
437 TCP_SYNACK_FASTOPEN,
438 TCP_SYNACK_COOKIE,
439};
5d062de7 440struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst,
5c9f3023 441 struct request_sock *req,
ca6fb065 442 struct tcp_fastopen_cookie *foc,
b3d05147 443 enum tcp_synack_type synack_type);
5c9f3023 444int tcp_disconnect(struct sock *sk, int flags);
1da177e4 445
370816ae 446void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
292e8d8c 447int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
63d02d15 448void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
1da177e4 449
1da177e4 450/* From syncookies.c */
b80c0e78
ED
451struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
452 struct request_sock *req,
84b114b9 453 struct dst_entry *dst, u32 tsoff);
5c9f3023
JP
454int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
455 u32 cookie);
461b74c3 456struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
e05c82d3 457#ifdef CONFIG_SYN_COOKIES
8c27bd75 458
63262315 459/* Syncookies use a monotonic timer which increments every 60 seconds.
8c27bd75
FW
460 * This counter is used both as a hash input and partially encoded into
461 * the cookie value. A cookie is only validated further if the delta
462 * between the current counter value and the encoded one is less than this,
63262315 463 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
8c27bd75
FW
464 * the counter advances immediately after a cookie is generated).
465 */
264ea103
ED
466#define MAX_SYNCOOKIE_AGE 2
467#define TCP_SYNCOOKIE_PERIOD (60 * HZ)
468#define TCP_SYNCOOKIE_VALID (MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)
469
470/* syncookies: remember time of last synqueue overflow
471 * But do not dirty this field too often (once per second is enough)
3f684b4b 472 * It is racy as we do not hold a lock, but race is very minor.
264ea103 473 */
3f684b4b 474static inline void tcp_synq_overflow(const struct sock *sk)
264ea103
ED
475{
476 unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
477 unsigned long now = jiffies;
478
479 if (time_after(now, last_overflow + HZ))
480 tcp_sk(sk)->rx_opt.ts_recent_stamp = now;
481}
482
483/* syncookies: no recent synqueue overflow on this listening socket? */
484static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
485{
486 unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
487
488 return time_after(jiffies, last_overflow + TCP_SYNCOOKIE_VALID);
489}
8c27bd75
FW
490
491static inline u32 tcp_cookie_time(void)
492{
63262315
ED
493 u64 val = get_jiffies_64();
494
264ea103 495 do_div(val, TCP_SYNCOOKIE_PERIOD);
63262315 496 return val;
8c27bd75
FW
497}
498
5c9f3023
JP
499u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
500 u16 *mssp);
3f684b4b 501__u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss);
9a568de4 502u64 cookie_init_timestamp(struct request_sock *req);
f9301034
ED
503bool cookie_timestamp_decode(const struct net *net,
504 struct tcp_options_received *opt);
f1673381 505bool cookie_ecn_ok(const struct tcp_options_received *opt,
f7b3bec6 506 const struct net *net, const struct dst_entry *dst);
4dfc2817 507
c6aefafb 508/* From net/ipv6/syncookies.c */
5c9f3023
JP
509int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th,
510 u32 cookie);
511struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
f1673381 512
5c9f3023
JP
513u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
514 const struct tcphdr *th, u16 *mssp);
3f684b4b 515__u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss);
e05c82d3 516#endif
1da177e4
LT
517/* tcp_output.c */
518
5c9f3023
JP
519void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
520 int nonagle);
10d3be56
ED
521int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
522int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
5c9f3023
JP
523void tcp_retransmit_timer(struct sock *sk);
524void tcp_xmit_retransmit_queue(struct sock *);
525void tcp_simple_retransmit(struct sock *);
57dde7f7 526void tcp_enter_recovery(struct sock *sk, bool ece_ack);
5c9f3023 527int tcp_trim_head(struct sock *, struct sk_buff *, u32);
75c119af
ED
528enum tcp_queue {
529 TCP_FRAG_IN_WRITE_QUEUE,
530 TCP_FRAG_IN_RTX_QUEUE,
531};
532int tcp_fragment(struct sock *sk, enum tcp_queue tcp_queue,
533 struct sk_buff *skb, u32 len,
534 unsigned int mss_now, gfp_t gfp);
5c9f3023
JP
535
536void tcp_send_probe0(struct sock *);
537void tcp_send_partial(struct sock *);
e520af48 538int tcp_write_wakeup(struct sock *, int mib);
5c9f3023
JP
539void tcp_send_fin(struct sock *sk);
540void tcp_send_active_reset(struct sock *sk, gfp_t priority);
541int tcp_send_synack(struct sock *);
5c9f3023
JP
542void tcp_push_one(struct sock *, unsigned int mss_now);
543void tcp_send_ack(struct sock *sk);
544void tcp_send_delayed_ack(struct sock *sk);
545void tcp_send_loss_probe(struct sock *sk);
ed66dfaf 546bool tcp_schedule_loss_probe(struct sock *sk, bool advancing_rto);
cfea5a68
MKL
547void tcp_skb_collapse_tstamp(struct sk_buff *skb,
548 const struct sk_buff *next_skb);
1da177e4 549
a762a980 550/* tcp_input.c */
5c9f3023 551void tcp_rearm_rto(struct sock *sk);
0f1c28ae 552void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req);
5c9f3023 553void tcp_reset(struct sock *sk);
4f41b1c5 554void tcp_skb_mark_lost_uncond_verify(struct tcp_sock *tp, struct sk_buff *skb);
e3e17b77 555void tcp_fin(struct sock *sk);
a762a980 556
1da177e4 557/* tcp_timer.c */
5c9f3023 558void tcp_init_xmit_timers(struct sock *);
463c84b9
ACM
559static inline void tcp_clear_xmit_timers(struct sock *sk)
560{
73a6bab5
ED
561 if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1)
562 sock_put(sk);
563
463c84b9
ACM
564 inet_csk_clear_xmit_timers(sk);
565}
1da177e4 566
5c9f3023
JP
567unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
568unsigned int tcp_current_mss(struct sock *sk);
0c54b85f
IJ
569
570/* Bound MSS / TSO packet size with the half of the window */
571static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
572{
01f83d69
AK
573 int cutoff;
574
575 /* When peer uses tiny windows, there is no use in packetizing
576 * to sub-MSS pieces for the sake of SWS or making sure there
577 * are enough packets in the pipe for fast recovery.
578 *
579 * On the other hand, for extremely large MSS devices, handling
580 * smaller than MSS windows in this way does make sense.
581 */
2631b79f 582 if (tp->max_window > TCP_MSS_DEFAULT)
01f83d69
AK
583 cutoff = (tp->max_window >> 1);
584 else
585 cutoff = tp->max_window;
586
587 if (cutoff && pktsize > cutoff)
588 return max_t(int, cutoff, 68U - tp->tcp_header_len);
0c54b85f
IJ
589 else
590 return pktsize;
591}
1da177e4 592
17b085ea 593/* tcp.c */
0df48c26 594void tcp_get_info(struct sock *, struct tcp_info *);
1da177e4
LT
595
596/* Read 'sendfile()'-style from a TCP socket */
5c9f3023
JP
597int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
598 sk_read_actor_t recv_actor);
1da177e4 599
5c9f3023 600void tcp_initialize_rcv_mss(struct sock *sk);
1da177e4 601
5c9f3023
JP
602int tcp_mtu_to_mss(struct sock *sk, int pmtu);
603int tcp_mss_to_mtu(struct sock *sk, int mss);
604void tcp_mtup_init(struct sock *sk);
605void tcp_init_buffer_space(struct sock *sk);
5d424d5a 606
f1ecd5d9
DL
607static inline void tcp_bound_rto(const struct sock *sk)
608{
609 if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
610 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
611}
612
613static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
614{
740b0f18 615 return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
f1ecd5d9
DL
616}
617
31770e34
FW
618static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
619{
620 tp->pred_flags = htonl((tp->tcp_header_len << 26) |
621 ntohl(TCP_FLAG_ACK) |
622 snd_wnd);
623}
624
625static inline void tcp_fast_path_on(struct tcp_sock *tp)
626{
627 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
628}
629
630static inline void tcp_fast_path_check(struct sock *sk)
631{
632 struct tcp_sock *tp = tcp_sk(sk);
633
634 if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
635 tp->rcv_wnd &&
636 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
637 !tp->urg_data)
638 tcp_fast_path_on(tp);
639}
640
0c266898
SS
641/* Compute the actual rto_min value */
642static inline u32 tcp_rto_min(struct sock *sk)
643{
cf533ea5 644 const struct dst_entry *dst = __sk_dst_get(sk);
0c266898
SS
645 u32 rto_min = TCP_RTO_MIN;
646
647 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
648 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
649 return rto_min;
650}
651
740b0f18
ED
652static inline u32 tcp_rto_min_us(struct sock *sk)
653{
654 return jiffies_to_usecs(tcp_rto_min(sk));
655}
656
81164413
DB
657static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
658{
659 return dst_metric_locked(dst, RTAX_CC_ALGO);
660}
661
f6722583
YC
662/* Minimum RTT in usec. ~0 means not available. */
663static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
664{
64033892 665 return minmax_get(&tp->rtt_min);
f6722583
YC
666}
667
1da177e4
LT
668/* Compute the actual receive window we are currently advertising.
669 * Rcv_nxt can be after the window if our peer push more data
670 * than the offered window.
671 */
40efc6fa 672static inline u32 tcp_receive_window(const struct tcp_sock *tp)
1da177e4
LT
673{
674 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
675
676 if (win < 0)
677 win = 0;
678 return (u32) win;
679}
680
681/* Choose a new window, without checks for shrinking, and without
682 * scaling applied to the result. The caller does these things
683 * if necessary. This is a "raw" window selection.
684 */
5c9f3023 685u32 __tcp_select_window(struct sock *sk);
1da177e4 686
ee995283
PE
687void tcp_send_window_probe(struct sock *sk);
688
ec66eda8
ED
689/* TCP uses 32bit jiffies to save some space.
690 * Note that this is different from tcp_time_stamp, which
691 * historically has been the same until linux-4.13.
692 */
693#define tcp_jiffies32 ((u32)jiffies)
694
9a568de4
ED
695/*
696 * Deliver a 32bit value for TCP timestamp option (RFC 7323)
697 * It is no longer tied to jiffies, but to 1 ms clock.
698 * Note: double check if you want to use tcp_jiffies32 instead of this.
699 */
700#define TCP_TS_HZ 1000
701
702static inline u64 tcp_clock_ns(void)
703{
704 return local_clock();
705}
706
707static inline u64 tcp_clock_us(void)
708{
709 return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
710}
711
712/* This should only be used in contexts where tp->tcp_mstamp is up to date */
713static inline u32 tcp_time_stamp(const struct tcp_sock *tp)
714{
715 return div_u64(tp->tcp_mstamp, USEC_PER_SEC / TCP_TS_HZ);
716}
717
718/* Could use tcp_clock_us() / 1000, but this version uses a single divide */
719static inline u32 tcp_time_stamp_raw(void)
720{
721 return div_u64(tcp_clock_ns(), NSEC_PER_SEC / TCP_TS_HZ);
722}
723
724
725/* Refresh 1us clock of a TCP socket,
726 * ensuring monotically increasing values.
1da177e4 727 */
9a568de4
ED
728static inline void tcp_mstamp_refresh(struct tcp_sock *tp)
729{
730 u64 val = tcp_clock_us();
731
732 if (val > tp->tcp_mstamp)
733 tp->tcp_mstamp = val;
734}
735
736static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
737{
738 return max_t(s64, t1 - t0, 0);
739}
1da177e4 740
7faee5c0
ED
741static inline u32 tcp_skb_timestamp(const struct sk_buff *skb)
742{
9a568de4 743 return div_u64(skb->skb_mstamp, USEC_PER_SEC / TCP_TS_HZ);
7faee5c0
ED
744}
745
746
a3433f35
CG
747#define tcp_flag_byte(th) (((u_int8_t *)th)[13])
748
749#define TCPHDR_FIN 0x01
750#define TCPHDR_SYN 0x02
751#define TCPHDR_RST 0x04
752#define TCPHDR_PSH 0x08
753#define TCPHDR_ACK 0x10
754#define TCPHDR_URG 0x20
755#define TCPHDR_ECE 0x40
756#define TCPHDR_CWR 0x80
757
49213555
DB
758#define TCPHDR_SYN_ECN (TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)
759
caa20d9a 760/* This is what the send packet queuing engine uses to pass
f86586fa
ED
761 * TCP per-packet control information to the transmission code.
762 * We also store the host-order sequence numbers in here too.
763 * This is 44 bytes if IPV6 is enabled.
764 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
1da177e4
LT
765 */
766struct tcp_skb_cb {
1da177e4
LT
767 __u32 seq; /* Starting sequence number */
768 __u32 end_seq; /* SEQ + FIN + SYN + datalen */
cd7d8498
ED
769 union {
770 /* Note : tcp_tw_isn is used in input path only
771 * (isn chosen by tcp_timewait_state_process())
772 *
f69ad292
ED
773 * tcp_gso_segs/size are used in write queue only,
774 * cf tcp_skb_pcount()/tcp_skb_mss()
cd7d8498
ED
775 */
776 __u32 tcp_tw_isn;
f69ad292
ED
777 struct {
778 u16 tcp_gso_segs;
779 u16 tcp_gso_size;
780 };
cd7d8498 781 };
4de075e0 782 __u8 tcp_flags; /* TCP header flags. (tcp[13]) */
f4f9f6e7 783
713bafea 784 __u8 sacked; /* State flags for SACK. */
1da177e4
LT
785#define TCPCB_SACKED_ACKED 0x01 /* SKB ACK'd by a SACK block */
786#define TCPCB_SACKED_RETRANS 0x02 /* SKB retransmitted */
787#define TCPCB_LOST 0x04 /* SKB is lost */
788#define TCPCB_TAGBITS 0x07 /* All tag bits */
9d186cac 789#define TCPCB_REPAIRED 0x10 /* SKB repaired (no skb_mstamp) */
1da177e4 790#define TCPCB_EVER_RETRANS 0x80 /* Ever retransmitted frame */
9d186cac
AV
791#define TCPCB_RETRANS (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
792 TCPCB_REPAIRED)
1da177e4 793
f4f9f6e7 794 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */
6b084928 795 __u8 txstamp_ack:1, /* Record TX timestamp for ack? */
c134ecb8 796 eor:1, /* Is skb MSG_EOR marked? */
98aaa913
MM
797 has_rxtstamp:1, /* SKB has a RX timestamp */
798 unused:5;
1da177e4 799 __u32 ack_seq; /* Sequence number ACK'd */
971f10ec 800 union {
b75803d5 801 struct {
b9f64820 802 /* There is space for up to 24 bytes */
d7722e85
SHY
803 __u32 in_flight:30,/* Bytes in flight at transmit */
804 is_app_limited:1, /* cwnd not fully used? */
805 unused:1;
b9f64820
YC
806 /* pkts S/ACKed so far upon tx of skb, incl retrans: */
807 __u32 delivered;
808 /* start of send pipeline phase */
9a568de4 809 u64 first_tx_mstamp;
b9f64820 810 /* when we reached the "delivered" count */
9a568de4 811 u64 delivered_mstamp;
b75803d5
LB
812 } tx; /* only used for outgoing skbs */
813 union {
814 struct inet_skb_parm h4;
971f10ec 815#if IS_ENABLED(CONFIG_IPV6)
b75803d5 816 struct inet6_skb_parm h6;
971f10ec 817#endif
b75803d5 818 } header; /* For incoming skbs */
34f79502 819 struct {
34f79502 820 __u32 flags;
e5cd3abc 821 struct sock *sk_redir;
8108a775 822 void *data_end;
34f79502 823 } bpf;
b75803d5 824 };
1da177e4
LT
825};
826
827#define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0]))
828
870c3151 829
815afe17 830#if IS_ENABLED(CONFIG_IPV6)
870c3151
ED
831/* This is the variant of inet6_iif() that must be used by TCP,
832 * as TCP moves IP6CB into a different location in skb->cb[]
833 */
834static inline int tcp_v6_iif(const struct sk_buff *skb)
835{
a04a480d 836 bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
74b20582
DA
837
838 return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
870c3151 839}
4297a0ef
DA
840
841/* TCP_SKB_CB reference means this can not be used from early demux */
842static inline int tcp_v6_sdif(const struct sk_buff *skb)
843{
844#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
845 if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags))
846 return TCP_SKB_CB(skb)->header.h6.iif;
847#endif
848 return 0;
849}
815afe17 850#endif
870c3151 851
a04a480d
DA
852static inline bool inet_exact_dif_match(struct net *net, struct sk_buff *skb)
853{
854#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
855 if (!net->ipv4.sysctl_tcp_l3mdev_accept &&
b4d1605a 856 skb && ipv4_l3mdev_skb(IPCB(skb)->flags))
a04a480d
DA
857 return true;
858#endif
859 return false;
860}
861
3fa6f616
DA
862/* TCP_SKB_CB reference means this can not be used from early demux */
863static inline int tcp_v4_sdif(struct sk_buff *skb)
864{
865#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
866 if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
867 return TCP_SKB_CB(skb)->header.h4.iif;
868#endif
869 return 0;
870}
871
1da177e4
LT
872/* Due to TSO, an SKB can be composed of multiple actual
873 * packets. To keep these tracked properly, we use this.
bd14b1b2 874 */
1da177e4 875static inline int tcp_skb_pcount(const struct sk_buff *skb)
bd14b1b2 876{
cd7d8498
ED
877 return TCP_SKB_CB(skb)->tcp_gso_segs;
878}
bd14b1b2 879
cd7d8498
ED
880static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
881{
882 TCP_SKB_CB(skb)->tcp_gso_segs = segs;
bd14b1b2
ED
883}
884
cd7d8498 885static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
1da177e4 886{
cd7d8498 887 TCP_SKB_CB(skb)->tcp_gso_segs += segs;
1da177e4
LT
888}
889
f69ad292 890/* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
1da177e4
LT
891static inline int tcp_skb_mss(const struct sk_buff *skb)
892{
f69ad292 893 return TCP_SKB_CB(skb)->tcp_gso_size;
1da177e4
LT
894}
895
c134ecb8
MKL
896static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
897{
898 return likely(!TCP_SKB_CB(skb)->eor);
899}
900
317a76f9
SH
901/* Events passed to congestion control interface */
902enum tcp_ca_event {
903 CA_EVENT_TX_START, /* first transmit when no packets in flight */
904 CA_EVENT_CWND_RESTART, /* congestion window restart */
905 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */
317a76f9 906 CA_EVENT_LOSS, /* loss timeout */
9890092e
FW
907 CA_EVENT_ECN_NO_CE, /* ECT set, but not CE marked */
908 CA_EVENT_ECN_IS_CE, /* received CE marked IP packet */
909 CA_EVENT_DELAYED_ACK, /* Delayed ack is sent */
910 CA_EVENT_NON_DELAYED_ACK,
7354c8c3
FW
911};
912
9890092e 913/* Information about inbound ACK, passed to cong_ops->in_ack_event() */
7354c8c3 914enum tcp_ca_ack_event_flags {
c1d2b4c3
FW
915 CA_ACK_SLOWPATH = (1 << 0), /* In slow path processing */
916 CA_ACK_WIN_UPDATE = (1 << 1), /* ACK updated window */
917 CA_ACK_ECE = (1 << 2), /* ECE bit is set on ack */
317a76f9
SH
918};
919
920/*
921 * Interface for adding new TCP congestion control handlers
922 */
923#define TCP_CA_NAME_MAX 16
3ff825b2
SH
924#define TCP_CA_MAX 128
925#define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX)
926
c5c6a8ab
DB
927#define TCP_CA_UNSPEC 0
928
30e502a3 929/* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
164891aa 930#define TCP_CONG_NON_RESTRICTED 0x1
30e502a3
DB
931/* Requires ECN/ECT set on all packets */
932#define TCP_CONG_NEEDS_ECN 0x2
164891aa 933
64f40ff5
ED
934union tcp_cc_info;
935
756ee172
LB
936struct ack_sample {
937 u32 pkts_acked;
938 s32 rtt_us;
6f094b9e 939 u32 in_flight;
756ee172
LB
940};
941
b9f64820
YC
942/* A rate sample measures the number of (original/retransmitted) data
943 * packets delivered "delivered" over an interval of time "interval_us".
944 * The tcp_rate.c code fills in the rate sample, and congestion
945 * control modules that define a cong_control function to run at the end
946 * of ACK processing can optionally chose to consult this sample when
947 * setting cwnd and pacing rate.
948 * A sample is invalid if "delivered" or "interval_us" is negative.
949 */
950struct rate_sample {
9a568de4 951 u64 prior_mstamp; /* starting timestamp for interval */
b9f64820
YC
952 u32 prior_delivered; /* tp->delivered at "prior_mstamp" */
953 s32 delivered; /* number of packets delivered over interval */
954 long interval_us; /* time for tp->delivered to incr "delivered" */
955 long rtt_us; /* RTT of last (S)ACKed packet (or -1) */
956 int losses; /* number of packets marked lost upon ACK */
957 u32 acked_sacked; /* number of packets newly (S)ACKed upon ACK */
958 u32 prior_in_flight; /* in flight before this ACK */
d7722e85 959 bool is_app_limited; /* is sample from packet with bubble in pipe? */
b9f64820 960 bool is_retrans; /* is sample from retransmission? */
e4286603 961 bool is_ack_delayed; /* is this (likely) a delayed ACK? */
b9f64820
YC
962};
963
317a76f9
SH
964struct tcp_congestion_ops {
965 struct list_head list;
c5c6a8ab
DB
966 u32 key;
967 u32 flags;
317a76f9
SH
968
969 /* initialize private data (optional) */
6687e988 970 void (*init)(struct sock *sk);
317a76f9 971 /* cleanup private data (optional) */
6687e988 972 void (*release)(struct sock *sk);
317a76f9
SH
973
974 /* return slow start threshold (required) */
6687e988 975 u32 (*ssthresh)(struct sock *sk);
317a76f9 976 /* do new cwnd calculation (required) */
24901551 977 void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
317a76f9 978 /* call before changing ca_state (optional) */
6687e988 979 void (*set_state)(struct sock *sk, u8 new_state);
317a76f9 980 /* call when cwnd event occurs (optional) */
6687e988 981 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
7354c8c3
FW
982 /* call when ack arrives (optional) */
983 void (*in_ack_event)(struct sock *sk, u32 flags);
1e0ce2a1 984 /* new value of cwnd after loss (required) */
6687e988 985 u32 (*undo_cwnd)(struct sock *sk);
317a76f9 986 /* hook for packet ack accounting (optional) */
756ee172 987 void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
dcb8c9b4
ED
988 /* override sysctl_tcp_min_tso_segs */
989 u32 (*min_tso_segs)(struct sock *sk);
77bfc174
YC
990 /* returns the multiplier used in tcp_sndbuf_expand (optional) */
991 u32 (*sndbuf_expand)(struct sock *sk);
c0402760
YC
992 /* call when packets are delivered to update cwnd and pacing rate,
993 * after all the ca_state processing. (optional)
994 */
995 void (*cong_control)(struct sock *sk, const struct rate_sample *rs);
73c1f4a0 996 /* get info for inet_diag (optional) */
64f40ff5
ED
997 size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
998 union tcp_cc_info *info);
317a76f9
SH
999
1000 char name[TCP_CA_NAME_MAX];
1001 struct module *owner;
1002};
1003
5c9f3023
JP
1004int tcp_register_congestion_control(struct tcp_congestion_ops *type);
1005void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
317a76f9 1006
55d8694f 1007void tcp_assign_congestion_control(struct sock *sk);
5c9f3023
JP
1008void tcp_init_congestion_control(struct sock *sk);
1009void tcp_cleanup_congestion_control(struct sock *sk);
6670e152
SH
1010int tcp_set_default_congestion_control(struct net *net, const char *name);
1011void tcp_get_default_congestion_control(struct net *net, char *name);
5c9f3023
JP
1012void tcp_get_available_congestion_control(char *buf, size_t len);
1013void tcp_get_allowed_congestion_control(char *buf, size_t len);
1014int tcp_set_allowed_congestion_control(char *allowed);
ebfa00c5 1015int tcp_set_congestion_control(struct sock *sk, const char *name, bool load, bool reinit);
e73ebb08
NC
1016u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
1017void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
317a76f9 1018
5c9f3023 1019u32 tcp_reno_ssthresh(struct sock *sk);
e9799183 1020u32 tcp_reno_undo_cwnd(struct sock *sk);
24901551 1021void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
a8acfbac 1022extern struct tcp_congestion_ops tcp_reno;
317a76f9 1023
c5c6a8ab 1024struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
6670e152 1025u32 tcp_ca_get_key_by_name(struct net *net, const char *name, bool *ecn_ca);
ea697639 1026#ifdef CONFIG_INET
c5c6a8ab 1027char *tcp_ca_get_name_by_key(u32 key, char *buffer);
ea697639
DB
1028#else
1029static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
1030{
1031 return NULL;
1032}
1033#endif
c5c6a8ab 1034
30e502a3
DB
1035static inline bool tcp_ca_needs_ecn(const struct sock *sk)
1036{
1037 const struct inet_connection_sock *icsk = inet_csk(sk);
1038
1039 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
1040}
1041
6687e988 1042static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
317a76f9 1043{
6687e988
ACM
1044 struct inet_connection_sock *icsk = inet_csk(sk);
1045
1046 if (icsk->icsk_ca_ops->set_state)
1047 icsk->icsk_ca_ops->set_state(sk, ca_state);
1048 icsk->icsk_ca_state = ca_state;
317a76f9
SH
1049}
1050
6687e988 1051static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
317a76f9 1052{
6687e988
ACM
1053 const struct inet_connection_sock *icsk = inet_csk(sk);
1054
1055 if (icsk->icsk_ca_ops->cwnd_event)
1056 icsk->icsk_ca_ops->cwnd_event(sk, event);
317a76f9
SH
1057}
1058
b9f64820
YC
1059/* From tcp_rate.c */
1060void tcp_rate_skb_sent(struct sock *sk, struct sk_buff *skb);
1061void tcp_rate_skb_delivered(struct sock *sk, struct sk_buff *skb,
1062 struct rate_sample *rs);
1063void tcp_rate_gen(struct sock *sk, u32 delivered, u32 lost,
d4761754 1064 bool is_sack_reneg, struct rate_sample *rs);
d7722e85 1065void tcp_rate_check_app_limited(struct sock *sk);
b9f64820 1066
e60402d0
IJ
1067/* These functions determine how the current flow behaves in respect of SACK
1068 * handling. SACK is negotiated with the peer, and therefore it can vary
1069 * between different flows.
1070 *
1071 * tcp_is_sack - SACK enabled
1072 * tcp_is_reno - No SACK
e60402d0
IJ
1073 */
1074static inline int tcp_is_sack(const struct tcp_sock *tp)
1075{
1076 return tp->rx_opt.sack_ok;
1077}
1078
a2a385d6 1079static inline bool tcp_is_reno(const struct tcp_sock *tp)
e60402d0
IJ
1080{
1081 return !tcp_is_sack(tp);
1082}
1083
83ae4088
IJ
1084static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
1085{
1086 return tp->sacked_out + tp->lost_out;
1087}
1088
1da177e4
LT
1089/* This determines how many packets are "in the network" to the best
1090 * of our knowledge. In many cases it is conservative, but where
1091 * detailed information is available from the receiver (via SACK
1092 * blocks etc.) we can make more aggressive calculations.
1093 *
1094 * Use this for decisions involving congestion control, use just
1095 * tp->packets_out to determine if the send queue is empty or not.
1096 *
1097 * Read this equation as:
1098 *
1099 * "Packets sent once on transmission queue" MINUS
1100 * "Packets left network, but not honestly ACKed yet" PLUS
1101 * "Packets fast retransmitted"
1102 */
40efc6fa 1103static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
1da177e4 1104{
83ae4088 1105 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
1da177e4
LT
1106}
1107
0b6a05c1
IJ
1108#define TCP_INFINITE_SSTHRESH 0x7fffffff
1109
071d5080
YC
1110static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
1111{
76174004 1112 return tp->snd_cwnd < tp->snd_ssthresh;
071d5080
YC
1113}
1114
0b6a05c1
IJ
1115static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
1116{
1117 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
1118}
1119
684bad11
YC
1120static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
1121{
1122 return (TCPF_CA_CWR | TCPF_CA_Recovery) &
1123 (1 << inet_csk(sk)->icsk_ca_state);
1124}
1125
1da177e4 1126/* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
684bad11 1127 * The exception is cwnd reduction phase, when cwnd is decreasing towards
1da177e4
LT
1128 * ssthresh.
1129 */
6687e988 1130static inline __u32 tcp_current_ssthresh(const struct sock *sk)
1da177e4 1131{
6687e988 1132 const struct tcp_sock *tp = tcp_sk(sk);
cf533ea5 1133
684bad11 1134 if (tcp_in_cwnd_reduction(sk))
1da177e4
LT
1135 return tp->snd_ssthresh;
1136 else
1137 return max(tp->snd_ssthresh,
1138 ((tp->snd_cwnd >> 1) +
1139 (tp->snd_cwnd >> 2)));
1140}
1141
b9c4595b
IJ
1142/* Use define here intentionally to get WARN_ON location shown at the caller */
1143#define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
1da177e4 1144
5ee2c941 1145void tcp_enter_cwr(struct sock *sk);
5c9f3023 1146__u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
1da177e4 1147
6b5a5c0d
NC
1148/* The maximum number of MSS of available cwnd for which TSO defers
1149 * sending if not using sysctl_tcp_tso_win_divisor.
1150 */
1151static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
1152{
1153 return 3;
1154}
1155
90840def
IJ
1156/* Returns end sequence number of the receiver's advertised window */
1157static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
1158{
1159 return tp->snd_una + tp->snd_wnd;
1160}
e114a710
ED
1161
1162/* We follow the spirit of RFC2861 to validate cwnd but implement a more
1163 * flexible approach. The RFC suggests cwnd should not be raised unless
ca8a2263
NC
1164 * it was fully used previously. And that's exactly what we do in
1165 * congestion avoidance mode. But in slow start we allow cwnd to grow
1166 * as long as the application has used half the cwnd.
e114a710
ED
1167 * Example :
1168 * cwnd is 10 (IW10), but application sends 9 frames.
1169 * We allow cwnd to reach 18 when all frames are ACKed.
1170 * This check is safe because it's as aggressive as slow start which already
1171 * risks 100% overshoot. The advantage is that we discourage application to
1172 * either send more filler packets or data to artificially blow up the cwnd
1173 * usage, and allow application-limited process to probe bw more aggressively.
e114a710 1174 */
24901551 1175static inline bool tcp_is_cwnd_limited(const struct sock *sk)
e114a710
ED
1176{
1177 const struct tcp_sock *tp = tcp_sk(sk);
1178
ca8a2263 1179 /* If in slow start, ensure cwnd grows to twice what was ACKed. */
071d5080 1180 if (tcp_in_slow_start(tp))
ca8a2263
NC
1181 return tp->snd_cwnd < 2 * tp->max_packets_out;
1182
1183 return tp->is_cwnd_limited;
e114a710 1184}
f4805ede 1185
21c8fe99
ED
1186/* Something is really bad, we could not queue an additional packet,
1187 * because qdisc is full or receiver sent a 0 window.
1188 * We do not want to add fuel to the fire, or abort too early,
1189 * so make sure the timer we arm now is at least 200ms in the future,
1190 * regardless of current icsk_rto value (as it could be ~2ms)
1191 */
1192static inline unsigned long tcp_probe0_base(const struct sock *sk)
1da177e4 1193{
21c8fe99
ED
1194 return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
1195}
9e412ba7 1196
21c8fe99
ED
1197/* Variant of inet_csk_rto_backoff() used for zero window probes */
1198static inline unsigned long tcp_probe0_when(const struct sock *sk,
1199 unsigned long max_when)
1200{
1201 u64 when = (u64)tcp_probe0_base(sk) << inet_csk(sk)->icsk_backoff;
1202
1203 return (unsigned long)min_t(u64, when, max_when);
1204}
1205
1206static inline void tcp_check_probe_timer(struct sock *sk)
1207{
1208 if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
3f421baa 1209 inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
21c8fe99 1210 tcp_probe0_base(sk), TCP_RTO_MAX);
1da177e4
LT
1211}
1212
ee7537b6 1213static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1214{
1215 tp->snd_wl1 = seq;
1216}
1217
ee7537b6 1218static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
1da177e4
LT
1219{
1220 tp->snd_wl1 = seq;
1221}
1222
1da177e4
LT
1223/*
1224 * Calculate(/check) TCP checksum
1225 */
ba7808ea
FD
1226static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1227 __be32 daddr, __wsum base)
1da177e4
LT
1228{
1229 return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
1230}
1231
b51655b9 1232static inline __sum16 __tcp_checksum_complete(struct sk_buff *skb)
1da177e4 1233{
fb286bb2 1234 return __skb_checksum_complete(skb);
1da177e4
LT
1235}
1236
a2a385d6 1237static inline bool tcp_checksum_complete(struct sk_buff *skb)
1da177e4 1238{
60476372 1239 return !skb_csum_unnecessary(skb) &&
1da177e4
LT
1240 __tcp_checksum_complete(skb);
1241}
1242
c9c33212 1243bool tcp_add_backlog(struct sock *sk, struct sk_buff *skb);
ac6e7800 1244int tcp_filter(struct sock *sk, struct sk_buff *skb);
1da177e4
LT
1245
1246#undef STATE_TRACE
1247
1248#ifdef STATE_TRACE
1249static const char *statename[]={
1250 "Unused","Established","Syn Sent","Syn Recv",
1251 "Fin Wait 1","Fin Wait 2","Time Wait", "Close",
1252 "Close Wait","Last ACK","Listen","Closing"
1253};
1254#endif
5c9f3023 1255void tcp_set_state(struct sock *sk, int state);
1da177e4 1256
5c9f3023 1257void tcp_done(struct sock *sk);
1da177e4 1258
c1e64e29
LC
1259int tcp_abort(struct sock *sk, int err);
1260
40efc6fa 1261static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1da177e4
LT
1262{
1263 rx_opt->dsack = 0;
1da177e4
LT
1264 rx_opt->num_sacks = 0;
1265}
1266
5c9f3023 1267u32 tcp_default_init_rwnd(u32 mss);
6f021c62
ED
1268void tcp_cwnd_restart(struct sock *sk, s32 delta);
1269
1270static inline void tcp_slow_start_after_idle_check(struct sock *sk)
1271{
1b1fc3fd 1272 const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
6f021c62
ED
1273 struct tcp_sock *tp = tcp_sk(sk);
1274 s32 delta;
1275
b510f0d2 1276 if (!sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle || tp->packets_out ||
1b1fc3fd 1277 ca_ops->cong_control)
6f021c62 1278 return;
d635fbe2 1279 delta = tcp_jiffies32 - tp->lsndtime;
6f021c62
ED
1280 if (delta > inet_csk(sk)->icsk_rto)
1281 tcp_cwnd_restart(sk, delta);
1282}
85f16525 1283
1da177e4 1284/* Determine a window scaling and initial window to offer. */
ceef9ab6
ED
1285void tcp_select_initial_window(const struct sock *sk, int __space,
1286 __u32 mss, __u32 *rcv_wnd,
5c9f3023
JP
1287 __u32 *window_clamp, int wscale_ok,
1288 __u8 *rcv_wscale, __u32 init_rcv_wnd);
1da177e4 1289
94f0893e 1290static inline int tcp_win_from_space(const struct sock *sk, int space)
1da177e4 1291{
94f0893e 1292 int tcp_adv_win_scale = sock_net(sk)->ipv4.sysctl_tcp_adv_win_scale;
c4836742
GF
1293
1294 return tcp_adv_win_scale <= 0 ?
1295 (space>>(-tcp_adv_win_scale)) :
1296 space - (space>>tcp_adv_win_scale);
1da177e4
LT
1297}
1298
105970f6 1299/* Note: caller must be prepared to deal with negative returns */
1da177e4
LT
1300static inline int tcp_space(const struct sock *sk)
1301{
94f0893e 1302 return tcp_win_from_space(sk, sk->sk_rcvbuf -
1da177e4 1303 atomic_read(&sk->sk_rmem_alloc));
105970f6 1304}
1da177e4
LT
1305
1306static inline int tcp_full_space(const struct sock *sk)
1307{
94f0893e 1308 return tcp_win_from_space(sk, sk->sk_rcvbuf);
1da177e4
LT
1309}
1310
843f4a55 1311extern void tcp_openreq_init_rwin(struct request_sock *req,
b1964b5f
ED
1312 const struct sock *sk_listener,
1313 const struct dst_entry *dst);
843f4a55 1314
5c9f3023 1315void tcp_enter_memory_pressure(struct sock *sk);
06044751 1316void tcp_leave_memory_pressure(struct sock *sk);
1da177e4 1317
1da177e4
LT
1318static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1319{
b840d15d
NB
1320 struct net *net = sock_net((struct sock *)tp);
1321
1322 return tp->keepalive_intvl ? : net->ipv4.sysctl_tcp_keepalive_intvl;
1da177e4
LT
1323}
1324
1325static inline int keepalive_time_when(const struct tcp_sock *tp)
1326{
13b287e8
NB
1327 struct net *net = sock_net((struct sock *)tp);
1328
1329 return tp->keepalive_time ? : net->ipv4.sysctl_tcp_keepalive_time;
1da177e4
LT
1330}
1331
df19a626
ED
1332static inline int keepalive_probes(const struct tcp_sock *tp)
1333{
9bd6861b
NB
1334 struct net *net = sock_net((struct sock *)tp);
1335
1336 return tp->keepalive_probes ? : net->ipv4.sysctl_tcp_keepalive_probes;
df19a626
ED
1337}
1338
6c37e5de
FL
1339static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1340{
1341 const struct inet_connection_sock *icsk = &tp->inet_conn;
1342
70eabf0e
ED
1343 return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
1344 tcp_jiffies32 - tp->rcv_tstamp);
6c37e5de
FL
1345}
1346
463c84b9 1347static inline int tcp_fin_time(const struct sock *sk)
1da177e4 1348{
1e579caa 1349 int fin_timeout = tcp_sk(sk)->linger2 ? : sock_net(sk)->ipv4.sysctl_tcp_fin_timeout;
463c84b9 1350 const int rto = inet_csk(sk)->icsk_rto;
1da177e4 1351
463c84b9
ACM
1352 if (fin_timeout < (rto << 2) - (rto >> 1))
1353 fin_timeout = (rto << 2) - (rto >> 1);
1da177e4
LT
1354
1355 return fin_timeout;
1356}
1357
a2a385d6
ED
1358static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1359 int paws_win)
1da177e4 1360{
c887e6d2 1361 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
a2a385d6 1362 return true;
c887e6d2 1363 if (unlikely(get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS))
a2a385d6 1364 return true;
bc2ce894
ED
1365 /*
1366 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1367 * then following tcp messages have valid values. Ignore 0 value,
1368 * or else 'negative' tsval might forbid us to accept their packets.
1369 */
1370 if (!rx_opt->ts_recent)
a2a385d6
ED
1371 return true;
1372 return false;
c887e6d2
IJ
1373}
1374
a2a385d6
ED
1375static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1376 int rst)
c887e6d2
IJ
1377{
1378 if (tcp_paws_check(rx_opt, 0))
a2a385d6 1379 return false;
1da177e4
LT
1380
1381 /* RST segments are not recommended to carry timestamp,
1382 and, if they do, it is recommended to ignore PAWS because
1383 "their cleanup function should take precedence over timestamps."
1384 Certainly, it is mistake. It is necessary to understand the reasons
1385 of this constraint to relax it: if peer reboots, clock may go
1386 out-of-sync and half-open connections will not be reset.
1387 Actually, the problem would be not existing if all
1388 the implementations followed draft about maintaining clock
1389 via reboots. Linux-2.2 DOES NOT!
1390
1391 However, we can relax time bounds for RST segments to MSL.
1392 */
9d729f72 1393 if (rst && get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
a2a385d6
ED
1394 return false;
1395 return true;
1da177e4
LT
1396}
1397
7970ddc8
ED
1398bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
1399 int mib_idx, u32 *last_oow_ack_time);
032ee423 1400
a9c19329 1401static inline void tcp_mib_init(struct net *net)
1da177e4
LT
1402{
1403 /* See RFC 2012 */
6aef70a8
ED
1404 TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
1405 TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1406 TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1407 TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
1da177e4
LT
1408}
1409
5af4ec23 1410/* from STCP */
ef9da47c 1411static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
0800f170 1412{
6a438bbe 1413 tp->lost_skb_hint = NULL;
ef9da47c
IJ
1414}
1415
1416static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1417{
1418 tcp_clear_retrans_hints_partial(tp);
6a438bbe 1419 tp->retransmit_skb_hint = NULL;
b7689205
IJ
1420}
1421
a915da9b
ED
1422union tcp_md5_addr {
1423 struct in_addr a4;
1424#if IS_ENABLED(CONFIG_IPV6)
1425 struct in6_addr a6;
1426#endif
1427};
1428
cfb6eeb4
YH
1429/* - key database */
1430struct tcp_md5sig_key {
a915da9b 1431 struct hlist_node node;
cfb6eeb4 1432 u8 keylen;
a915da9b
ED
1433 u8 family; /* AF_INET or AF_INET6 */
1434 union tcp_md5_addr addr;
6797318e 1435 u8 prefixlen;
a915da9b
ED
1436 u8 key[TCP_MD5SIG_MAXKEYLEN];
1437 struct rcu_head rcu;
cfb6eeb4
YH
1438};
1439
1440/* - sock block */
1441struct tcp_md5sig_info {
a915da9b 1442 struct hlist_head head;
a8afca03 1443 struct rcu_head rcu;
cfb6eeb4
YH
1444};
1445
1446/* - pseudo header */
1447struct tcp4_pseudohdr {
1448 __be32 saddr;
1449 __be32 daddr;
1450 __u8 pad;
1451 __u8 protocol;
1452 __be16 len;
1453};
1454
1455struct tcp6_pseudohdr {
1456 struct in6_addr saddr;
1457 struct in6_addr daddr;
1458 __be32 len;
1459 __be32 protocol; /* including padding */
1460};
1461
1462union tcp_md5sum_block {
1463 struct tcp4_pseudohdr ip4;
dfd56b8b 1464#if IS_ENABLED(CONFIG_IPV6)
cfb6eeb4
YH
1465 struct tcp6_pseudohdr ip6;
1466#endif
1467};
1468
1469/* - pool: digest algorithm, hash description and scratch buffer */
1470struct tcp_md5sig_pool {
cf80e0e4 1471 struct ahash_request *md5_req;
19689e38 1472 void *scratch;
cfb6eeb4
YH
1473};
1474
cfb6eeb4 1475/* - functions */
39f8e58e
ED
1476int tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
1477 const struct sock *sk, const struct sk_buff *skb);
5c9f3023 1478int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
6797318e
ID
1479 int family, u8 prefixlen, const u8 *newkey, u8 newkeylen,
1480 gfp_t gfp);
5c9f3023 1481int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
6797318e 1482 int family, u8 prefixlen);
b83e3deb 1483struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
fd3a154a 1484 const struct sock *addr_sk);
cfb6eeb4 1485
9501f972 1486#ifdef CONFIG_TCP_MD5SIG
b83e3deb 1487struct tcp_md5sig_key *tcp_md5_do_lookup(const struct sock *sk,
5c9f3023
JP
1488 const union tcp_md5_addr *addr,
1489 int family);
a915da9b 1490#define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_key)
9501f972 1491#else
b83e3deb 1492static inline struct tcp_md5sig_key *tcp_md5_do_lookup(const struct sock *sk,
a915da9b
ED
1493 const union tcp_md5_addr *addr,
1494 int family)
1495{
1496 return NULL;
1497}
9501f972
YH
1498#define tcp_twsk_md5_key(twsk) NULL
1499#endif
1500
5c9f3023 1501bool tcp_alloc_md5sig_pool(void);
cfb6eeb4 1502
5c9f3023 1503struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
71cea17e
ED
1504static inline void tcp_put_md5sig_pool(void)
1505{
1506 local_bh_enable();
1507}
35790c04 1508
5c9f3023
JP
1509int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
1510 unsigned int header_len);
1511int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
1512 const struct tcp_md5sig_key *key);
cfb6eeb4 1513
10467163 1514/* From tcp_fastopen.c */
5c9f3023 1515void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
7268586b 1516 struct tcp_fastopen_cookie *cookie);
5c9f3023 1517void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
2646c831
DL
1518 struct tcp_fastopen_cookie *cookie, bool syn_lost,
1519 u16 try_exp);
783237e8
YC
1520struct tcp_fastopen_request {
1521 /* Fast Open cookie. Size 0 means a cookie request */
1522 struct tcp_fastopen_cookie cookie;
1523 struct msghdr *data; /* data in MSG_FASTOPEN */
f5ddcbbb
ED
1524 size_t size;
1525 int copied; /* queued in tcp_connect() */
783237e8 1526};
783237e8 1527void tcp_free_fastopen_req(struct tcp_sock *tp);
1fba70e5 1528void tcp_fastopen_destroy_cipher(struct sock *sk);
43713848 1529void tcp_fastopen_ctx_destroy(struct net *net);
1fba70e5
YC
1530int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk,
1531 void *key, unsigned int len);
61d2bcae 1532void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
7c85af88
ED
1533struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
1534 struct request_sock *req,
71c02379
CP
1535 struct tcp_fastopen_cookie *foc,
1536 const struct dst_entry *dst);
43713848 1537void tcp_fastopen_init_key_once(struct net *net);
065263f4
WW
1538bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
1539 struct tcp_fastopen_cookie *cookie);
19f6d3f3 1540bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
10467163
JC
1541#define TCP_FASTOPEN_KEY_LENGTH 16
1542
1543/* Fastopen key context */
1544struct tcp_fastopen_context {
7ae8639c
ED
1545 struct crypto_cipher *tfm;
1546 __u8 key[TCP_FASTOPEN_KEY_LENGTH];
1547 struct rcu_head rcu;
10467163
JC
1548};
1549
cf1ef3f0 1550extern unsigned int sysctl_tcp_fastopen_blackhole_timeout;
46c2fa39 1551void tcp_fastopen_active_disable(struct sock *sk);
cf1ef3f0
WW
1552bool tcp_fastopen_active_should_disable(struct sock *sk);
1553void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
7268586b 1554void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired);
cf1ef3f0 1555
05b055e8
FY
1556/* Latencies incurred by various limits for a sender. They are
1557 * chronograph-like stats that are mutually exclusive.
1558 */
1559enum tcp_chrono {
1560 TCP_CHRONO_UNSPEC,
1561 TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
1562 TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
1563 TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
1564 __TCP_CHRONO_MAX,
1565};
1566
1567void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type);
1568void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);
1569
e2080072
ED
1570/* This helper is needed, because skb->tcp_tsorted_anchor uses
1571 * the same memory storage than skb->destructor/_skb_refdst
1572 */
1573static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb)
1574{
1575 skb->destructor = NULL;
1576 skb->_skb_refdst = 0UL;
1577}
1578
1579#define tcp_skb_tsorted_save(skb) { \
1580 unsigned long _save = skb->_skb_refdst; \
1581 skb->_skb_refdst = 0UL;
1582
1583#define tcp_skb_tsorted_restore(skb) \
1584 skb->_skb_refdst = _save; \
1585}
1586
ac3f09ba 1587void tcp_write_queue_purge(struct sock *sk);
fe067e8a 1588
75c119af
ED
1589static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk)
1590{
1591 return skb_rb_first(&sk->tcp_rtx_queue);
1592}
1593
cf533ea5 1594static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
fe067e8a 1595{
cd07a8ea 1596 return skb_peek(&sk->sk_write_queue);
fe067e8a
DM
1597}
1598
cf533ea5 1599static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
fe067e8a 1600{
cd07a8ea 1601 return skb_peek_tail(&sk->sk_write_queue);
fe067e8a
DM
1602}
1603
234b6860 1604#define tcp_for_write_queue_from_safe(skb, tmp, sk) \
cd07a8ea 1605 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
234b6860 1606
cf533ea5 1607static inline struct sk_buff *tcp_send_head(const struct sock *sk)
fe067e8a 1608{
75c119af 1609 return skb_peek(&sk->sk_write_queue);
fe067e8a
DM
1610}
1611
cd07a8ea
DM
1612static inline bool tcp_skb_is_last(const struct sock *sk,
1613 const struct sk_buff *skb)
1614{
1615 return skb_queue_is_last(&sk->sk_write_queue, skb);
1616}
1617
75c119af 1618static inline bool tcp_write_queue_empty(const struct sock *sk)
fe067e8a 1619{
75c119af
ED
1620 return skb_queue_empty(&sk->sk_write_queue);
1621}
1622
1623static inline bool tcp_rtx_queue_empty(const struct sock *sk)
1624{
1625 return RB_EMPTY_ROOT(&sk->tcp_rtx_queue);
1626}
1627
1628static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk)
1629{
1630 return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk);
fe067e8a
DM
1631}
1632
1633static inline void tcp_check_send_head(struct sock *sk, struct sk_buff *skb_unlinked)
1634{
75c119af 1635 if (tcp_write_queue_empty(sk))
0f87230d 1636 tcp_chrono_stop(sk, TCP_CHRONO_BUSY);
fe067e8a
DM
1637}
1638
fe067e8a
DM
1639static inline void __tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1640{
1641 __skb_queue_tail(&sk->sk_write_queue, skb);
1642}
1643
1644static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1645{
1646 __tcp_add_write_queue_tail(sk, skb);
1647
1648 /* Queue it, remembering where we must start sending. */
50895b9d 1649 if (sk->sk_write_queue.next == skb)
0f87230d 1650 tcp_chrono_start(sk, TCP_CHRONO_BUSY);
fe067e8a
DM
1651}
1652
43f59c89 1653/* Insert new before skb on the write queue of sk. */
fe067e8a
DM
1654static inline void tcp_insert_write_queue_before(struct sk_buff *new,
1655 struct sk_buff *skb,
1656 struct sock *sk)
1657{
43f59c89 1658 __skb_queue_before(&sk->sk_write_queue, skb, new);
fe067e8a
DM
1659}
1660
1661static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
1662{
4a269818 1663 tcp_skb_tsorted_anchor_cleanup(skb);
fe067e8a
DM
1664 __skb_unlink(skb, &sk->sk_write_queue);
1665}
1666
75c119af
ED
1667void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb);
1668
1669static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk)
fe067e8a 1670{
75c119af
ED
1671 tcp_skb_tsorted_anchor_cleanup(skb);
1672 rb_erase(&skb->rbnode, &sk->tcp_rtx_queue);
1673}
1674
1675static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk)
1676{
1677 list_del(&skb->tcp_tsorted_anchor);
1678 tcp_rtx_queue_unlink(skb, sk);
1679 sk_wmem_free_skb(sk, skb);
fe067e8a
DM
1680}
1681
12d50c46
KK
1682static inline void tcp_push_pending_frames(struct sock *sk)
1683{
1684 if (tcp_send_head(sk)) {
1685 struct tcp_sock *tp = tcp_sk(sk);
1686
1687 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
1688 }
1689}
1690
ecb97192
NC
1691/* Start sequence of the skb just after the highest skb with SACKed
1692 * bit, valid only if sacked_out > 0 or when the caller has ensured
1693 * validity by itself.
a47e5a98
IJ
1694 */
1695static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
1696{
1697 if (!tp->sacked_out)
1698 return tp->snd_una;
6859d494
IJ
1699
1700 if (tp->highest_sack == NULL)
1701 return tp->snd_nxt;
1702
a47e5a98
IJ
1703 return TCP_SKB_CB(tp->highest_sack)->seq;
1704}
1705
6859d494
IJ
1706static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
1707{
50895b9d 1708 tcp_sk(sk)->highest_sack = skb_rb_next(skb);
6859d494
IJ
1709}
1710
1711static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
1712{
1713 return tcp_sk(sk)->highest_sack;
1714}
1715
1716static inline void tcp_highest_sack_reset(struct sock *sk)
1717{
50895b9d 1718 tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk);
6859d494
IJ
1719}
1720
2b7cda9c
ED
1721/* Called when old skb is about to be deleted and replaced by new skb */
1722static inline void tcp_highest_sack_replace(struct sock *sk,
6859d494
IJ
1723 struct sk_buff *old,
1724 struct sk_buff *new)
1725{
2b7cda9c 1726 if (old == tcp_highest_sack(sk))
6859d494
IJ
1727 tcp_sk(sk)->highest_sack = new;
1728}
1729
b1f0a0e9
FW
1730/* This helper checks if socket has IP_TRANSPARENT set */
1731static inline bool inet_sk_transparent(const struct sock *sk)
1732{
1733 switch (sk->sk_state) {
1734 case TCP_TIME_WAIT:
1735 return inet_twsk(sk)->tw_transparent;
1736 case TCP_NEW_SYN_RECV:
1737 return inet_rsk(inet_reqsk(sk))->no_srccheck;
1738 }
1739 return inet_sk(sk)->transparent;
1740}
1741
5aa4b32f
AP
1742/* Determines whether this is a thin stream (which may suffer from
1743 * increased latency). Used to trigger latency-reducing mechanisms.
1744 */
a2a385d6 1745static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
5aa4b32f
AP
1746{
1747 return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
1748}
1749
1da177e4
LT
1750/* /proc */
1751enum tcp_seq_states {
1752 TCP_SEQ_STATE_LISTENING,
1da177e4 1753 TCP_SEQ_STATE_ESTABLISHED,
1da177e4
LT
1754};
1755
73cb88ec
AV
1756int tcp_seq_open(struct inode *inode, struct file *file);
1757
1da177e4 1758struct tcp_seq_afinfo {
73cb88ec
AV
1759 char *name;
1760 sa_family_t family;
1761 const struct file_operations *seq_fops;
1762 struct seq_operations seq_ops;
1da177e4
LT
1763};
1764
1765struct tcp_iter_state {
a4146b1b 1766 struct seq_net_private p;
1da177e4
LT
1767 sa_family_t family;
1768 enum tcp_seq_states state;
1769 struct sock *syn_wait_sk;
a7cb5a49 1770 int bucket, offset, sbucket, num;
a8b690f9 1771 loff_t last_pos;
1da177e4
LT
1772};
1773
5c9f3023
JP
1774int tcp_proc_register(struct net *net, struct tcp_seq_afinfo *afinfo);
1775void tcp_proc_unregister(struct net *net, struct tcp_seq_afinfo *afinfo);
1da177e4 1776
20380731 1777extern struct request_sock_ops tcp_request_sock_ops;
c6aefafb 1778extern struct request_sock_ops tcp6_request_sock_ops;
20380731 1779
5c9f3023 1780void tcp_v4_destroy_sock(struct sock *sk);
20380731 1781
28be6e07 1782struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
5c9f3023
JP
1783 netdev_features_t features);
1784struct sk_buff **tcp_gro_receive(struct sk_buff **head, struct sk_buff *skb);
1785int tcp_gro_complete(struct sk_buff *skb);
28850dc7 1786
5c9f3023 1787void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, __be32 daddr);
f4c50d99 1788
c9bee3b7
ED
1789static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
1790{
4979f2d9
NB
1791 struct net *net = sock_net((struct sock *)tp);
1792 return tp->notsent_lowat ?: net->ipv4.sysctl_tcp_notsent_lowat;
c9bee3b7
ED
1793}
1794
1795static inline bool tcp_stream_memory_free(const struct sock *sk)
1796{
1797 const struct tcp_sock *tp = tcp_sk(sk);
1798 u32 notsent_bytes = tp->write_seq - tp->snd_nxt;
1799
1800 return notsent_bytes < tcp_notsent_lowat(tp);
1801}
1802
20380731 1803#ifdef CONFIG_PROC_FS
5c9f3023
JP
1804int tcp4_proc_init(void);
1805void tcp4_proc_exit(void);
20380731
ACM
1806#endif
1807
ea3bea3a 1808int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
1fb6f159
OP
1809int tcp_conn_request(struct request_sock_ops *rsk_ops,
1810 const struct tcp_request_sock_ops *af_ops,
1811 struct sock *sk, struct sk_buff *skb);
5db92c99 1812
cfb6eeb4
YH
1813/* TCP af-specific functions */
1814struct tcp_sock_af_ops {
1815#ifdef CONFIG_TCP_MD5SIG
b83e3deb 1816 struct tcp_md5sig_key *(*md5_lookup) (const struct sock *sk,
fd3a154a 1817 const struct sock *addr_sk);
39f8e58e
ED
1818 int (*calc_md5_hash)(char *location,
1819 const struct tcp_md5sig_key *md5,
1820 const struct sock *sk,
1821 const struct sk_buff *skb);
1822 int (*md5_parse)(struct sock *sk,
8917a777 1823 int optname,
39f8e58e
ED
1824 char __user *optval,
1825 int optlen);
cfb6eeb4
YH
1826#endif
1827};
1828
1829struct tcp_request_sock_ops {
2aec4a29 1830 u16 mss_clamp;
cfb6eeb4 1831#ifdef CONFIG_TCP_MD5SIG
b83e3deb 1832 struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk,
fd3a154a 1833 const struct sock *addr_sk);
39f8e58e
ED
1834 int (*calc_md5_hash) (char *location,
1835 const struct tcp_md5sig_key *md5,
1836 const struct sock *sk,
1837 const struct sk_buff *skb);
cfb6eeb4 1838#endif
b40cf18e
ED
1839 void (*init_req)(struct request_sock *req,
1840 const struct sock *sk_listener,
16bea70a 1841 struct sk_buff *skb);
fb7b37a7 1842#ifdef CONFIG_SYN_COOKIES
3f684b4b 1843 __u32 (*cookie_init_seq)(const struct sk_buff *skb,
fb7b37a7
OP
1844 __u16 *mss);
1845#endif
f964629e 1846 struct dst_entry *(*route_req)(const struct sock *sk, struct flowi *fl,
4396e461 1847 const struct request_sock *req);
84b114b9 1848 u32 (*init_seq)(const struct sk_buff *skb);
5d2ed052 1849 u32 (*init_ts_off)(const struct net *net, const struct sk_buff *skb);
0f935dbe 1850 int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
d6274bd8 1851 struct flowi *fl, struct request_sock *req,
dc6ef6be 1852 struct tcp_fastopen_cookie *foc,
b3d05147 1853 enum tcp_synack_type synack_type);
cfb6eeb4
YH
1854};
1855
fb7b37a7
OP
1856#ifdef CONFIG_SYN_COOKIES
1857static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
3f684b4b 1858 const struct sock *sk, struct sk_buff *skb,
fb7b37a7
OP
1859 __u16 *mss)
1860{
3f684b4b 1861 tcp_synq_overflow(sk);
02a1d6e7 1862 __NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
3f684b4b 1863 return ops->cookie_init_seq(skb, mss);
fb7b37a7
OP
1864}
1865#else
1866static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
3f684b4b 1867 const struct sock *sk, struct sk_buff *skb,
fb7b37a7
OP
1868 __u16 *mss)
1869{
1870 return 0;
1871}
1872#endif
1873
5c9f3023 1874int tcpv4_offload_init(void);
28850dc7 1875
5c9f3023
JP
1876void tcp_v4_init(void);
1877void tcp_init(void);
20380731 1878
659a8ad5 1879/* tcp_recovery.c */
d716bfdb 1880void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb);
6ac06ecd 1881void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced);
b8fef65a
YC
1882extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb,
1883 u32 reo_wnd);
128eda86 1884extern void tcp_rack_mark_lost(struct sock *sk);
1d0833df 1885extern void tcp_rack_advance(struct tcp_sock *tp, u8 sacked, u32 end_seq,
9a568de4 1886 u64 xmit_time);
57dde7f7 1887extern void tcp_rack_reo_timeout(struct sock *sk);
1f255691 1888extern void tcp_rack_update_reo_wnd(struct sock *sk, struct rate_sample *rs);
659a8ad5 1889
e1a10ef7
NC
1890/* At how many usecs into the future should the RTO fire? */
1891static inline s64 tcp_rto_delta_us(const struct sock *sk)
1892{
75c119af 1893 const struct sk_buff *skb = tcp_rtx_queue_head(sk);
e1a10ef7
NC
1894 u32 rto = inet_csk(sk)->icsk_rto;
1895 u64 rto_time_stamp_us = skb->skb_mstamp + jiffies_to_usecs(rto);
1896
1897 return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp;
1898}
1899
e25f866f
CW
1900/*
1901 * Save and compile IPv4 options, return a pointer to it
1902 */
91ed1e66
PA
1903static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net,
1904 struct sk_buff *skb)
e25f866f
CW
1905{
1906 const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
1907 struct ip_options_rcu *dopt = NULL;
1908
461b74c3 1909 if (opt->optlen) {
e25f866f
CW
1910 int opt_size = sizeof(*dopt) + opt->optlen;
1911
1912 dopt = kmalloc(opt_size, GFP_ATOMIC);
91ed1e66 1913 if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) {
e25f866f
CW
1914 kfree(dopt);
1915 dopt = NULL;
1916 }
1917 }
1918 return dopt;
1919}
1920
98781965
ED
1921/* locally generated TCP pure ACKs have skb->truesize == 2
1922 * (check tcp_send_ack() in net/ipv4/tcp_output.c )
1923 * This is much faster than dissecting the packet to find out.
1924 * (Think of GRE encapsulations, IPv4, IPv6, ...)
1925 */
1926static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
1927{
1928 return skb->truesize == 2;
1929}
1930
1931static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
1932{
1933 skb->truesize = 2;
1934}
1935
473bd239
TH
1936static inline int tcp_inq(struct sock *sk)
1937{
1938 struct tcp_sock *tp = tcp_sk(sk);
1939 int answ;
1940
1941 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
1942 answ = 0;
1943 } else if (sock_flag(sk, SOCK_URGINLINE) ||
1944 !tp->urg_data ||
1945 before(tp->urg_seq, tp->copied_seq) ||
1946 !before(tp->urg_seq, tp->rcv_nxt)) {
1947
1948 answ = tp->rcv_nxt - tp->copied_seq;
1949
1950 /* Subtract 1, if FIN was received */
1951 if (answ && sock_flag(sk, SOCK_DONE))
1952 answ--;
1953 } else {
1954 answ = tp->urg_seq - tp->copied_seq;
1955 }
1956
1957 return answ;
1958}
1959
32035585
TH
1960int tcp_peek_len(struct socket *sock);
1961
a44d6eac
MKL
1962static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
1963{
1964 u16 segs_in;
1965
1966 segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
1967 tp->segs_in += segs_in;
1968 if (skb->len > tcp_hdrlen(skb))
1969 tp->data_segs_in += segs_in;
1970}
1971
9caad864
ED
1972/*
1973 * TCP listen path runs lockless.
1974 * We forced "struct sock" to be const qualified to make sure
1975 * we don't modify one of its field by mistake.
1976 * Here, we increment sk_drops which is an atomic_t, so we can safely
1977 * make sock writable again.
1978 */
1979static inline void tcp_listendrop(const struct sock *sk)
1980{
1981 atomic_inc(&((struct sock *)sk)->sk_drops);
02a1d6e7 1982 __NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
9caad864
ED
1983}
1984
218af599
ED
1985enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);
1986
734942cc
DW
1987/*
1988 * Interface for adding Upper Level Protocols over TCP
1989 */
1990
1991#define TCP_ULP_NAME_MAX 16
1992#define TCP_ULP_MAX 128
1993#define TCP_ULP_BUF_MAX (TCP_ULP_NAME_MAX*TCP_ULP_MAX)
1994
b11a632c
JF
1995enum {
1996 TCP_ULP_TLS,
1aa12bdf 1997 TCP_ULP_BPF,
b11a632c
JF
1998};
1999
734942cc
DW
2000struct tcp_ulp_ops {
2001 struct list_head list;
2002
2003 /* initialize ulp */
2004 int (*init)(struct sock *sk);
2005 /* cleanup ulp */
2006 void (*release)(struct sock *sk);
2007
b11a632c 2008 int uid;
734942cc 2009 char name[TCP_ULP_NAME_MAX];
b11a632c 2010 bool user_visible;
734942cc
DW
2011 struct module *owner;
2012};
2013int tcp_register_ulp(struct tcp_ulp_ops *type);
2014void tcp_unregister_ulp(struct tcp_ulp_ops *type);
2015int tcp_set_ulp(struct sock *sk, const char *name);
1aa12bdf 2016int tcp_set_ulp_id(struct sock *sk, const int ulp);
734942cc
DW
2017void tcp_get_available_ulp(char *buf, size_t len);
2018void tcp_cleanup_ulp(struct sock *sk);
2019
40304b2a
LB
2020/* Call BPF_SOCK_OPS program that returns an int. If the return value
2021 * is < 0, then the BPF op failed (for example if the loaded BPF
2022 * program does not support the chosen operation or there is no BPF
2023 * program loaded).
2024 */
2025#ifdef CONFIG_BPF
de525be2 2026static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
40304b2a
LB
2027{
2028 struct bpf_sock_ops_kern sock_ops;
2029 int ret;
2030
b73042b8 2031 memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp));
f19397a5
LB
2032 if (sk_fullsock(sk)) {
2033 sock_ops.is_fullsock = 1;
40304b2a 2034 sock_owned_by_me(sk);
f19397a5 2035 }
40304b2a 2036
40304b2a
LB
2037 sock_ops.sk = sk;
2038 sock_ops.op = op;
de525be2
LB
2039 if (nargs > 0)
2040 memcpy(sock_ops.args, args, nargs * sizeof(*args));
40304b2a
LB
2041
2042 ret = BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops);
2043 if (ret == 0)
2044 ret = sock_ops.reply;
2045 else
2046 ret = -1;
2047 return ret;
2048}
de525be2
LB
2049
2050static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2051{
2052 u32 args[2] = {arg1, arg2};
2053
2054 return tcp_call_bpf(sk, op, 2, args);
2055}
2056
2057static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2058 u32 arg3)
2059{
2060 u32 args[3] = {arg1, arg2, arg3};
2061
2062 return tcp_call_bpf(sk, op, 3, args);
2063}
2064
40304b2a 2065#else
de525be2 2066static inline int tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args)
40304b2a
LB
2067{
2068 return -EPERM;
2069}
de525be2
LB
2070
2071static inline int tcp_call_bpf_2arg(struct sock *sk, int op, u32 arg1, u32 arg2)
2072{
2073 return -EPERM;
2074}
2075
2076static inline int tcp_call_bpf_3arg(struct sock *sk, int op, u32 arg1, u32 arg2,
2077 u32 arg3)
2078{
2079 return -EPERM;
2080}
2081
40304b2a
LB
2082#endif
2083
8550f328
LB
2084static inline u32 tcp_timeout_init(struct sock *sk)
2085{
2086 int timeout;
2087
de525be2 2088 timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT, 0, NULL);
8550f328
LB
2089
2090 if (timeout <= 0)
2091 timeout = TCP_TIMEOUT_INIT;
2092 return timeout;
2093}
2094
13d3b1eb
LB
2095static inline u32 tcp_rwnd_init_bpf(struct sock *sk)
2096{
2097 int rwnd;
2098
de525be2 2099 rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT, 0, NULL);
13d3b1eb
LB
2100
2101 if (rwnd < 0)
2102 rwnd = 0;
2103 return rwnd;
2104}
91b5b21c
LB
2105
2106static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk)
2107{
de525be2 2108 return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN, 0, NULL) == 1);
91b5b21c 2109}
60e2a778
UB
2110
2111#if IS_ENABLED(CONFIG_SMC)
2112extern struct static_key_false tcp_have_smc;
2113#endif
6dac1523
IL
2114
2115#if IS_ENABLED(CONFIG_TLS_DEVICE)
2116void clean_acked_data_enable(struct inet_connection_sock *icsk,
2117 void (*cad)(struct sock *sk, u32 ack_seq));
2118void clean_acked_data_disable(struct inet_connection_sock *icsk);
2119
2120#endif
2121
1da177e4 2122#endif /* _TCP_H */