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