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