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/crypto.h>
  31 #include <linux/cryptohash.h>
  32 #include <linux/kref.h>
  33 #include <linux/ktime.h>
  34
  35 #include <net/inet_connection_sock.h>
  36 #include <net/inet_timewait_sock.h>
  37 #include <net/inet_hashtables.h>
  38 #include <net/checksum.h>
  39 #include <net/request_sock.h>
  40 #include <net/sock.h>
  41 #include <net/snmp.h>
  42 #include <net/ip.h>
  43 #include <net/tcp_states.h>
  44 #include <net/inet_ecn.h>
  45 #include <net/dst.h>
  46
  47 #include <linux/seq_file.h>
  48 #include <linux/memcontrol.h>
  49
  50 extern struct inet_hashinfo tcp_hashinfo;
  51
  52 extern struct percpu_counter tcp_orphan_count;
  53 void tcp_time_wait(struct sock *sk, int state, int timeo);
  54
  55 #define MAX_TCP_HEADER  (128 + MAX_HEADER)
  56 #define MAX_TCP_OPTION_SPACE 40
  57
  58 /*
  59  * Never offer a window over 32767 without using window scaling. Some
  60  * poor stacks do signed 16bit maths!
  61  */
  62 #define MAX_TCP_WINDOW          32767U
  63
  64 /* Minimal accepted MSS. It is (60+60+8) - (20+20). */
  65 #define TCP_MIN_MSS             88U
  66
  67 /* The least MTU to use for probing */
  68 #define TCP_BASE_MSS            512
  69
  70 /* After receiving this amount of duplicate ACKs fast retransmit starts. */
  71 #define TCP_FASTRETRANS_THRESH 3
  72
  73 /* Maximal reordering. */
  74 #define TCP_MAX_REORDERING      127
  75
  76 /* Maximal number of ACKs sent quickly to accelerate slow-start. */
  77 #define TCP_MAX_QUICKACKS       16U
  78
  79 /* urg_data states */
  80 #define TCP_URG_VALID   0x0100
  81 #define TCP_URG_NOTYET  0x0200
  82 #define TCP_URG_READ    0x0400
  83
  84 #define TCP_RETR1       3       /*
  85                                  * This is how many retries it does before it
  86                                  * tries to figure out if the gateway is
  87                                  * down. Minimal RFC value is 3; it corresponds
  88                                  * to ~3sec-8min depending on RTO.
  89                                  */
  90
  91 #define TCP_RETR2       15      /*
  92                                  * This should take at least
  93                                  * 90 minutes to time out.
  94                                  * RFC1122 says that the limit is 100 sec.
  95                                  * 15 is ~13-30min depending on RTO.
  96                                  */
  97
  98 #define TCP_SYN_RETRIES  6      /* This is how many retries are done
  99                                  * when active opening a connection.
 100                                  * RFC1122 says the minimum retry MUST
 101                                  * be at least 180secs.  Nevertheless
 102                                  * this value is corresponding to
 103                                  * 63secs of retransmission with the
 104                                  * current initial RTO.
 105                                  */
 106
 107 #define TCP_SYNACK_RETRIES 5    /* This is how may retries are done
 108                                  * when passive opening a connection.
 109                                  * This is corresponding to 31secs of
 110                                  * retransmission with the current
 111                                  * initial RTO.
 112                                  */
 113
 114 #define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
 115                                   * state, about 60 seconds     */
 116 #define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
 117                                  /* BSD style FIN_WAIT2 deadlock breaker.
 118                                   * It used to be 3min, new value is 60sec,
 119                                   * to combine FIN-WAIT-2 timeout with
 120                                   * TIME-WAIT timer.
 121                                   */
 122
 123 #define TCP_DELACK_MAX  ((unsigned)(HZ/5))      /* maximal time to delay before sending an ACK */
 124 #if HZ >= 100
 125 #define TCP_DELACK_MIN  ((unsigned)(HZ/25))     /* minimal time to delay before sending an ACK */
 126 #define TCP_ATO_MIN     ((unsigned)(HZ/25))
 127 #else
 128 #define TCP_DELACK_MIN  4U
 129 #define TCP_ATO_MIN     4U
 130 #endif
 131 #define TCP_RTO_MAX     ((unsigned)(120*HZ))
 132 #define TCP_RTO_MIN     ((unsigned)(HZ/5))
 133 #define TCP_TIMEOUT_INIT ((unsigned)(1*HZ))     /* RFC6298 2.1 initial RTO value        */
 134 #define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now
 135                                                  * used as a fallback RTO for the
 136                                                  * initial data transmission if no
 137                                                  * valid RTT sample has been acquired,
 138                                                  * most likely due to retrans in 3WHS.
 139                                                  */
 140
 141 #define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
 142                                                          * for local resources.
 143                                                          */
 144
 145 #define TCP_KEEPALIVE_TIME      (120*60*HZ)     /* two hours */
 146 #define TCP_KEEPALIVE_PROBES    9               /* Max of 9 keepalive probes    */
 147 #define TCP_KEEPALIVE_INTVL     (75*HZ)
 148
 149 #define MAX_TCP_KEEPIDLE        32767
 150 #define MAX_TCP_KEEPINTVL       32767
 151 #define MAX_TCP_KEEPCNT         127
 152 #define MAX_TCP_SYNCNT          127
 153
 154 #define TCP_SYNQ_INTERVAL       (HZ/5)  /* Period of SYNACK timer */
 155
 156 #define TCP_PAWS_24DAYS (60 * 60 * 24 * 24)
 157 #define TCP_PAWS_MSL    60              /* Per-host timestamps are invalidated
 158                                          * after this time. It should be equal
 159                                          * (or greater than) TCP_TIMEWAIT_LEN
 160                                          * to provide reliability equal to one
 161                                          * provided by timewait state.
 162                                          */
 163 #define TCP_PAWS_WINDOW 1               /* Replay window for per-host
 164                                          * timestamps. It must be less than
 165                                          * minimal timewait lifetime.
 166                                          */
 167 /*
 168  *      TCP option
 169  */
 170
 171 #define TCPOPT_NOP              1       /* Padding */
 172 #define TCPOPT_EOL              0       /* End of options */
 173 #define TCPOPT_MSS              2       /* Segment size negotiating */
 174 #define TCPOPT_WINDOW           3       /* Window scaling */
 175 #define TCPOPT_SACK_PERM        4       /* SACK Permitted */
 176 #define TCPOPT_SACK             5       /* SACK Block */
 177 #define TCPOPT_TIMESTAMP        8       /* Better RTT estimations/PAWS */
 178 #define TCPOPT_MD5SIG           19      /* MD5 Signature (RFC2385) */
 179 #define TCPOPT_EXP              254     /* Experimental */
 180 /* Magic number to be after the option value for sharing TCP
 181  * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
 182  */
 183 #define TCPOPT_FASTOPEN_MAGIC   0xF989
 184
 185 /*
 186  *     TCP option lengths
 187  */
 188
 189 #define TCPOLEN_MSS            4
 190 #define TCPOLEN_WINDOW         3
 191 #define TCPOLEN_SACK_PERM      2
 192 #define TCPOLEN_TIMESTAMP      10
 193 #define TCPOLEN_MD5SIG         18
 194 #define TCPOLEN_EXP_FASTOPEN_BASE  4
 195
 196 /* But this is what stacks really send out. */
 197 #define TCPOLEN_TSTAMP_ALIGNED          12
 198 #define TCPOLEN_WSCALE_ALIGNED          4
 199 #define TCPOLEN_SACKPERM_ALIGNED        4
 200 #define TCPOLEN_SACK_BASE               2
 201 #define TCPOLEN_SACK_BASE_ALIGNED       4
 202 #define TCPOLEN_SACK_PERBLOCK           8
 203 #define TCPOLEN_MD5SIG_ALIGNED          20
 204 #define TCPOLEN_MSS_ALIGNED             4
 205
 206 /* Flags in tp->nonagle */
 207 #define TCP_NAGLE_OFF           1       /* Nagle's algo is disabled */
 208 #define TCP_NAGLE_CORK          2       /* Socket is corked         */
 209 #define TCP_NAGLE_PUSH          4       /* Cork is overridden for already queued data */
 210
 211 /* TCP thin-stream limits */
 212 #define TCP_THIN_LINEAR_RETRIES 6       /* After 6 linear retries, do exp. backoff */
 213
 214 /* TCP initial congestion window as per draft-hkchu-tcpm-initcwnd-01 */
 215 #define TCP_INIT_CWND           10
 216
 217 /* Bit Flags for sysctl_tcp_fastopen */
 218 #define TFO_CLIENT_ENABLE       1
 219 #define TFO_SERVER_ENABLE       2
 220 #define TFO_CLIENT_NO_COOKIE    4       /* Data in SYN w/o cookie option */
 221
 222 /* Accept SYN data w/o any cookie option */
 223 #define TFO_SERVER_COOKIE_NOT_REQD      0x200
 224
 225 /* Force enable TFO on all listeners, i.e., not requiring the
 226  * TCP_FASTOPEN socket option. SOCKOPT1/2 determine how to set max_qlen.
 227  */
 228 #define TFO_SERVER_WO_SOCKOPT1  0x400
 229 #define TFO_SERVER_WO_SOCKOPT2  0x800
 230
 231 extern struct inet_timewait_death_row tcp_death_row;
 232
 233 /* sysctl variables for tcp */
 234 extern int sysctl_tcp_timestamps;
 235 extern int sysctl_tcp_window_scaling;
 236 extern int sysctl_tcp_sack;
 237 extern int sysctl_tcp_fin_timeout;
 238 extern int sysctl_tcp_keepalive_time;
 239 extern int sysctl_tcp_keepalive_probes;
 240 extern int sysctl_tcp_keepalive_intvl;
 241 extern int sysctl_tcp_syn_retries;
 242 extern int sysctl_tcp_synack_retries;
 243 extern int sysctl_tcp_retries1;
 244 extern int sysctl_tcp_retries2;
 245 extern int sysctl_tcp_orphan_retries;
 246 extern int sysctl_tcp_syncookies;
 247 extern int sysctl_tcp_fastopen;
 248 extern int sysctl_tcp_retrans_collapse;
 249 extern int sysctl_tcp_stdurg;
 250 extern int sysctl_tcp_rfc1337;
 251 extern int sysctl_tcp_abort_on_overflow;
 252 extern int sysctl_tcp_max_orphans;
 253 extern int sysctl_tcp_fack;
 254 extern int sysctl_tcp_reordering;
 255 extern int sysctl_tcp_dsack;
 256 extern long sysctl_tcp_mem[3];
 257 extern int sysctl_tcp_wmem[3];
 258 extern int sysctl_tcp_rmem[3];
 259 extern int sysctl_tcp_app_win;
 260 extern int sysctl_tcp_adv_win_scale;
 261 extern int sysctl_tcp_tw_reuse;
 262 extern int sysctl_tcp_frto;
 263 extern int sysctl_tcp_low_latency;
 264 extern int sysctl_tcp_nometrics_save;
 265 extern int sysctl_tcp_moderate_rcvbuf;
 266 extern int sysctl_tcp_tso_win_divisor;
 267 extern int sysctl_tcp_mtu_probing;
 268 extern int sysctl_tcp_base_mss;
 269 extern int sysctl_tcp_workaround_signed_windows;
 270 extern int sysctl_tcp_slow_start_after_idle;
 271 extern int sysctl_tcp_thin_linear_timeouts;
 272 extern int sysctl_tcp_thin_dupack;
 273 extern int sysctl_tcp_early_retrans;
 274 extern int sysctl_tcp_limit_output_bytes;
 275 extern int sysctl_tcp_challenge_ack_limit;
 276 extern unsigned int sysctl_tcp_notsent_lowat;
 277 extern int sysctl_tcp_min_tso_segs;
 278 extern int sysctl_tcp_autocorking;
 279
 280 extern atomic_long_t tcp_memory_allocated;
 281 extern struct percpu_counter tcp_sockets_allocated;
 282 extern int tcp_memory_pressure;
 283
 284 /*
 285  * The next routines deal with comparing 32 bit unsigned ints
 286  * and worry about wraparound (automatic with unsigned arithmetic).
 287  */
 288
 289 static inline bool before(__u32 seq1, __u32 seq2)
 290 {
 291         return (__s32)(seq1-seq2) < 0;
 292 }
 293 #define after(seq2, seq1)       before(seq1, seq2)
 294
 295 /* is s2<=s1<=s3 ? */
 296 static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
 297 {
 298         return seq3 - seq2 >= seq1 - seq2;
 299 }
 300
 301 static inline bool tcp_out_of_memory(struct sock *sk)
 302 {
 303         if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
 304             sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
 305                 return true;
 306         return false;
 307 }
 308
 309 static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
 310 {
 311         struct percpu_counter *ocp = sk->sk_prot->orphan_count;
 312         int orphans = percpu_counter_read_positive(ocp);
 313
 314         if (orphans << shift > sysctl_tcp_max_orphans) {
 315                 orphans = percpu_counter_sum_positive(ocp);
 316                 if (orphans << shift > sysctl_tcp_max_orphans)
 317                         return true;
 318         }
 319         return false;
 320 }
 321
 322 bool tcp_check_oom(struct sock *sk, int shift);
 323
 324 /* syncookies: remember time of last synqueue overflow */
 325 static inline void tcp_synq_overflow(struct sock *sk)
 326 {
 327         tcp_sk(sk)->rx_opt.ts_recent_stamp = jiffies;
 328 }
 329
 330 /* syncookies: no recent synqueue overflow on this listening socket? */
 331 static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
 332 {
 333         unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
 334         return time_after(jiffies, last_overflow + TCP_TIMEOUT_FALLBACK);
 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_BH(net, field)    SNMP_INC_STATS_BH((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_USER(net, field, val) SNMP_ADD_STATS_USER((net)->mib.tcp_statistics, field, val)
 343 #define TCP_ADD_STATS(net, field, val)  SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
 344
 345 void tcp_tasklet_init(void);
 346
 347 void tcp_v4_err(struct sk_buff *skb, u32);
 348
 349 void tcp_shutdown(struct sock *sk, int how);
 350
 351 void tcp_v4_early_demux(struct sk_buff *skb);
 352 int tcp_v4_rcv(struct sk_buff *skb);
 353
 354 int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
 355 int tcp_sendmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
 356                 size_t size);
 357 int tcp_sendpage(struct sock *sk, struct page *page, int offset, size_t size,
 358                  int flags);
 359 void tcp_release_cb(struct sock *sk);
 360 void tcp_wfree(struct sk_buff *skb);
 361 void tcp_write_timer_handler(struct sock *sk);
 362 void tcp_delack_timer_handler(struct sock *sk);
 363 int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 364 int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
 365                           const struct tcphdr *th, unsigned int len);
 366 void tcp_rcv_established(struct sock *sk, struct sk_buff *skb,
 367                          const struct tcphdr *th, unsigned int len);
 368 void tcp_rcv_space_adjust(struct sock *sk);
 369 int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
 370 void tcp_twsk_destructor(struct sock *sk);
 371 ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
 372                         struct pipe_inode_info *pipe, size_t len,
 373                         unsigned int flags);
 374
 375 static inline void tcp_dec_quickack_mode(struct sock *sk,
 376                                          const unsigned int pkts)
 377 {
 378         struct inet_connection_sock *icsk = inet_csk(sk);
 379
 380         if (icsk->icsk_ack.quick) {
 381                 if (pkts >= icsk->icsk_ack.quick) {
 382                         icsk->icsk_ack.quick = 0;
 383                         /* Leaving quickack mode we deflate ATO. */
 384                         icsk->icsk_ack.ato   = TCP_ATO_MIN;
 385                 } else
 386                         icsk->icsk_ack.quick -= pkts;
 387         }
 388 }
 389
 390 #define TCP_ECN_OK              1
 391 #define TCP_ECN_QUEUE_CWR       2
 392 #define TCP_ECN_DEMAND_CWR      4
 393 #define TCP_ECN_SEEN            8
 394
 395 enum tcp_tw_status {
 396         TCP_TW_SUCCESS = 0,
 397         TCP_TW_RST = 1,
 398         TCP_TW_ACK = 2,
 399         TCP_TW_SYN = 3
 400 };
 401
 402
 403 enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
 404                                               struct sk_buff *skb,
 405                                               const struct tcphdr *th);
 406 struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
 407                            struct request_sock *req, struct request_sock **prev,
 408                            bool fastopen);
 409 int tcp_child_process(struct sock *parent, struct sock *child,
 410                       struct sk_buff *skb);
 411 void tcp_enter_loss(struct sock *sk);
 412 void tcp_clear_retrans(struct tcp_sock *tp);
 413 void tcp_update_metrics(struct sock *sk);
 414 void tcp_init_metrics(struct sock *sk);
 415 void tcp_metrics_init(void);
 416 bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst,
 417                         bool paws_check, bool timestamps);
 418 bool tcp_remember_stamp(struct sock *sk);
 419 bool tcp_tw_remember_stamp(struct inet_timewait_sock *tw);
 420 void tcp_fetch_timewait_stamp(struct sock *sk, struct dst_entry *dst);
 421 void tcp_disable_fack(struct tcp_sock *tp);
 422 void tcp_close(struct sock *sk, long timeout);
 423 void tcp_init_sock(struct sock *sk);
 424 unsigned int tcp_poll(struct file *file, struct socket *sock,
 425                       struct poll_table_struct *wait);
 426 int tcp_getsockopt(struct sock *sk, int level, int optname,
 427                    char __user *optval, int __user *optlen);
 428 int tcp_setsockopt(struct sock *sk, int level, int optname,
 429                    char __user *optval, unsigned int optlen);
 430 int compat_tcp_getsockopt(struct sock *sk, int level, int optname,
 431                           char __user *optval, int __user *optlen);
 432 int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
 433                           char __user *optval, unsigned int optlen);
 434 void tcp_set_keepalive(struct sock *sk, int val);
 435 void tcp_syn_ack_timeout(struct sock *sk, struct request_sock *req);
 436 int tcp_recvmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
 437                 size_t len, int nonblock, int flags, int *addr_len);
 438 void tcp_parse_options(const struct sk_buff *skb,
 439                        struct tcp_options_received *opt_rx,
 440                        int estab, struct tcp_fastopen_cookie *foc);
 441 const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
 442
 443 /*
 444  *      TCP v4 functions exported for the inet6 API
 445  */
 446
 447 void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
 448 void tcp_v4_mtu_reduced(struct sock *sk);
 449 int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
 450 struct sock *tcp_create_openreq_child(struct sock *sk,
 451                                       struct request_sock *req,
 452                                       struct sk_buff *skb);
 453 struct sock *tcp_v4_syn_recv_sock(struct sock *sk, struct sk_buff *skb,
 454                                   struct request_sock *req,
 455                                   struct dst_entry *dst);
 456 int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
 457 int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len);
 458 int tcp_connect(struct sock *sk);
 459 struct sk_buff *tcp_make_synack(struct sock *sk, struct dst_entry *dst,
 460                                 struct request_sock *req,
 461                                 struct tcp_fastopen_cookie *foc);
 462 int tcp_disconnect(struct sock *sk, int flags);
 463
 464 void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
 465 int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
 466 void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
 467
 468 /* From syncookies.c */
 469 int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
 470                       u32 cookie);
 471 struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb,
 472                              struct ip_options *opt);
 473 #ifdef CONFIG_SYN_COOKIES
 474
 475 /* Syncookies use a monotonic timer which increments every 60 seconds.
 476  * This counter is used both as a hash input and partially encoded into
 477  * the cookie value.  A cookie is only validated further if the delta
 478  * between the current counter value and the encoded one is less than this,
 479  * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
 480  * the counter advances immediately after a cookie is generated).
 481  */
 482 #define MAX_SYNCOOKIE_AGE 2
 483
 484 static inline u32 tcp_cookie_time(void)
 485 {
 486         u64 val = get_jiffies_64();
 487
 488         do_div(val, 60 * HZ);
 489         return val;
 490 }
 491
 492 u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
 493                               u16 *mssp);
 494 __u32 cookie_v4_init_sequence(struct sock *sk, const struct sk_buff *skb,
 495                               __u16 *mss);
 496 #endif
 497
 498 __u32 cookie_init_timestamp(struct request_sock *req);
 499 bool cookie_check_timestamp(struct tcp_options_received *opt, struct net *net,
 500                             bool *ecn_ok);
 501
 502 /* From net/ipv6/syncookies.c */
 503 int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th,
 504                       u32 cookie);
 505 struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
 506 #ifdef CONFIG_SYN_COOKIES
 507 u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
 508                               const struct tcphdr *th, u16 *mssp);
 509 __u32 cookie_v6_init_sequence(struct sock *sk, const struct sk_buff *skb,
 510                               __u16 *mss);
 511 #endif
 512 /* tcp_output.c */
 513
 514 void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
 515                                int nonagle);
 516 bool tcp_may_send_now(struct sock *sk);
 517 int __tcp_retransmit_skb(struct sock *, struct sk_buff *);
 518 int tcp_retransmit_skb(struct sock *, struct sk_buff *);
 519 void tcp_retransmit_timer(struct sock *sk);
 520 void tcp_xmit_retransmit_queue(struct sock *);
 521 void tcp_simple_retransmit(struct sock *);
 522 int tcp_trim_head(struct sock *, struct sk_buff *, u32);
 523 int tcp_fragment(struct sock *, struct sk_buff *, u32, unsigned int, gfp_t);
 524
 525 void tcp_send_probe0(struct sock *);
 526 void tcp_send_partial(struct sock *);
 527 int tcp_write_wakeup(struct sock *);
 528 void tcp_send_fin(struct sock *sk);
 529 void tcp_send_active_reset(struct sock *sk, gfp_t priority);
 530 int tcp_send_synack(struct sock *);
 531 bool tcp_syn_flood_action(struct sock *sk, const struct sk_buff *skb,
 532                           const char *proto);
 533 void tcp_push_one(struct sock *, unsigned int mss_now);
 534 void tcp_send_ack(struct sock *sk);
 535 void tcp_send_delayed_ack(struct sock *sk);
 536 void tcp_send_loss_probe(struct sock *sk);
 537 bool tcp_schedule_loss_probe(struct sock *sk);
 538
 539 /* tcp_input.c */
 540 void tcp_resume_early_retransmit(struct sock *sk);
 541 void tcp_rearm_rto(struct sock *sk);
 542 void tcp_reset(struct sock *sk);
 543
 544 /* tcp_timer.c */
 545 void tcp_init_xmit_timers(struct sock *);
 546 static inline void tcp_clear_xmit_timers(struct sock *sk)
 547 {
 548         inet_csk_clear_xmit_timers(sk);
 549 }
 550
 551 unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
 552 unsigned int tcp_current_mss(struct sock *sk);
 553
 554 /* Bound MSS / TSO packet size with the half of the window */
 555 static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
 556 {
 557         int cutoff;
 558
 559         /* When peer uses tiny windows, there is no use in packetizing
 560          * to sub-MSS pieces for the sake of SWS or making sure there
 561          * are enough packets in the pipe for fast recovery.
 562          *
 563          * On the other hand, for extremely large MSS devices, handling
 564          * smaller than MSS windows in this way does make sense.
 565          */
 566         if (tp->max_window >= 512)
 567                 cutoff = (tp->max_window >> 1);
 568         else
 569                 cutoff = tp->max_window;
 570
 571         if (cutoff && pktsize > cutoff)
 572                 return max_t(int, cutoff, 68U - tp->tcp_header_len);
 573         else
 574                 return pktsize;
 575 }
 576
 577 /* tcp.c */
 578 void tcp_get_info(const struct sock *, struct tcp_info *);
 579
 580 /* Read 'sendfile()'-style from a TCP socket */
 581 typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
 582                                 unsigned int, size_t);
 583 int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
 584                   sk_read_actor_t recv_actor);
 585
 586 void tcp_initialize_rcv_mss(struct sock *sk);
 587
 588 int tcp_mtu_to_mss(struct sock *sk, int pmtu);
 589 int tcp_mss_to_mtu(struct sock *sk, int mss);
 590 void tcp_mtup_init(struct sock *sk);
 591 void tcp_init_buffer_space(struct sock *sk);
 592
 593 static inline void tcp_bound_rto(const struct sock *sk)
 594 {
 595         if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
 596                 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
 597 }
 598
 599 static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
 600 {
 601         return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
 602 }
 603
 604 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
 605 {
 606         tp->pred_flags = htonl((tp->tcp_header_len << 26) |
 607                                ntohl(TCP_FLAG_ACK) |
 608                                snd_wnd);
 609 }
 610
 611 static inline void tcp_fast_path_on(struct tcp_sock *tp)
 612 {
 613         __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
 614 }
 615
 616 static inline void tcp_fast_path_check(struct sock *sk)
 617 {
 618         struct tcp_sock *tp = tcp_sk(sk);
 619
 620         if (skb_queue_empty(&tp->out_of_order_queue) &&
 621             tp->rcv_wnd &&
 622             atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
 623             !tp->urg_data)
 624                 tcp_fast_path_on(tp);
 625 }
 626
 627 /* Compute the actual rto_min value */
 628 static inline u32 tcp_rto_min(struct sock *sk)
 629 {
 630         const struct dst_entry *dst = __sk_dst_get(sk);
 631         u32 rto_min = TCP_RTO_MIN;
 632
 633         if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
 634                 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
 635         return rto_min;
 636 }
 637
 638 static inline u32 tcp_rto_min_us(struct sock *sk)
 639 {
 640         return jiffies_to_usecs(tcp_rto_min(sk));
 641 }
 642
 643 /* Compute the actual receive window we are currently advertising.
 644  * Rcv_nxt can be after the window if our peer push more data
 645  * than the offered window.
 646  */
 647 static inline u32 tcp_receive_window(const struct tcp_sock *tp)
 648 {
 649         s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
 650
 651         if (win < 0)
 652                 win = 0;
 653         return (u32) win;
 654 }
 655
 656 /* Choose a new window, without checks for shrinking, and without
 657  * scaling applied to the result.  The caller does these things
 658  * if necessary.  This is a "raw" window selection.
 659  */
 660 u32 __tcp_select_window(struct sock *sk);
 661
 662 void tcp_send_window_probe(struct sock *sk);
 663
 664 /* TCP timestamps are only 32-bits, this causes a slight
 665  * complication on 64-bit systems since we store a snapshot
 666  * of jiffies in the buffer control blocks below.  We decided
 667  * to use only the low 32-bits of jiffies and hide the ugly
 668  * casts with the following macro.
 669  */
 670 #define tcp_time_stamp          ((__u32)(jiffies))
 671
 672 #define tcp_flag_byte(th) (((u_int8_t *)th)[13])
 673
 674 #define TCPHDR_FIN 0x01
 675 #define TCPHDR_SYN 0x02
 676 #define TCPHDR_RST 0x04
 677 #define TCPHDR_PSH 0x08
 678 #define TCPHDR_ACK 0x10
 679 #define TCPHDR_URG 0x20
 680 #define TCPHDR_ECE 0x40
 681 #define TCPHDR_CWR 0x80
 682
 683 /* This is what the send packet queuing engine uses to pass
 684  * TCP per-packet control information to the transmission code.
 685  * We also store the host-order sequence numbers in here too.
 686  * This is 44 bytes if IPV6 is enabled.
 687  * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
 688  */
 689 struct tcp_skb_cb {
 690         union {
 691                 struct inet_skb_parm    h4;
 692 #if IS_ENABLED(CONFIG_IPV6)
 693                 struct inet6_skb_parm   h6;
 694 #endif
 695         } header;       /* For incoming frames          */
 696         __u32           seq;            /* Starting sequence number     */
 697         __u32           end_seq;        /* SEQ + FIN + SYN + datalen    */
 698         __u32           when;           /* used to compute rtt's        */
 699         __u8            tcp_flags;      /* TCP header flags. (tcp[13])  */
 700
 701         __u8            sacked;         /* State flags for SACK/FACK.   */
 702 #define TCPCB_SACKED_ACKED      0x01    /* SKB ACK'd by a SACK block    */
 703 #define TCPCB_SACKED_RETRANS    0x02    /* SKB retransmitted            */
 704 #define TCPCB_LOST              0x04    /* SKB is lost                  */
 705 #define TCPCB_TAGBITS           0x07    /* All tag bits                 */
 706 #define TCPCB_REPAIRED          0x10    /* SKB repaired (no skb_mstamp) */
 707 #define TCPCB_EVER_RETRANS      0x80    /* Ever retransmitted frame     */
 708 #define TCPCB_RETRANS           (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
 709                                 TCPCB_REPAIRED)
 710
 711         __u8            ip_dsfield;     /* IPv4 tos or IPv6 dsfield     */
 712         /* 1 byte hole */
 713         __u32           ack_seq;        /* Sequence number ACK'd        */
 714 };
 715
 716 #define TCP_SKB_CB(__skb)       ((struct tcp_skb_cb *)&((__skb)->cb[0]))
 717
 718 /* RFC3168 : 6.1.1 SYN packets must not have ECT/ECN bits set
 719  *
 720  * If we receive a SYN packet with these bits set, it means a network is
 721  * playing bad games with TOS bits. In order to avoid possible false congestion
 722  * notifications, we disable TCP ECN negociation.
 723  */
 724 static inline void
 725 TCP_ECN_create_request(struct request_sock *req, const struct sk_buff *skb,
 726                 struct net *net)
 727 {
 728         const struct tcphdr *th = tcp_hdr(skb);
 729
 730         if (net->ipv4.sysctl_tcp_ecn && th->ece && th->cwr &&
 731             INET_ECN_is_not_ect(TCP_SKB_CB(skb)->ip_dsfield))
 732                 inet_rsk(req)->ecn_ok = 1;
 733 }
 734
 735 /* Due to TSO, an SKB can be composed of multiple actual
 736  * packets.  To keep these tracked properly, we use this.
 737  */
 738 static inline int tcp_skb_pcount(const struct sk_buff *skb)
 739 {
 740         return skb_shinfo(skb)->gso_segs;
 741 }
 742
 743 /* This is valid iff tcp_skb_pcount() > 1. */
 744 static inline int tcp_skb_mss(const struct sk_buff *skb)
 745 {
 746         return skb_shinfo(skb)->gso_size;
 747 }
 748
 749 /* Events passed to congestion control interface */
 750 enum tcp_ca_event {
 751         CA_EVENT_TX_START,      /* first transmit when no packets in flight */
 752         CA_EVENT_CWND_RESTART,  /* congestion window restart */
 753         CA_EVENT_COMPLETE_CWR,  /* end of congestion recovery */
 754         CA_EVENT_LOSS,          /* loss timeout */
 755         CA_EVENT_FAST_ACK,      /* in sequence ack */
 756         CA_EVENT_SLOW_ACK,      /* other ack */
 757 };
 758
 759 /*
 760  * Interface for adding new TCP congestion control handlers
 761  */
 762 #define TCP_CA_NAME_MAX 16
 763 #define TCP_CA_MAX      128
 764 #define TCP_CA_BUF_MAX  (TCP_CA_NAME_MAX*TCP_CA_MAX)
 765
 766 #define TCP_CONG_NON_RESTRICTED 0x1
 767
 768 struct tcp_congestion_ops {
 769         struct list_head        list;
 770         unsigned long flags;
 771
 772         /* initialize private data (optional) */
 773         void (*init)(struct sock *sk);
 774         /* cleanup private data  (optional) */
 775         void (*release)(struct sock *sk);
 776
 777         /* return slow start threshold (required) */
 778         u32 (*ssthresh)(struct sock *sk);
 779         /* do new cwnd calculation (required) */
 780         void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
 781         /* call before changing ca_state (optional) */
 782         void (*set_state)(struct sock *sk, u8 new_state);
 783         /* call when cwnd event occurs (optional) */
 784         void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
 785         /* new value of cwnd after loss (optional) */
 786         u32  (*undo_cwnd)(struct sock *sk);
 787         /* hook for packet ack accounting (optional) */
 788         void (*pkts_acked)(struct sock *sk, u32 num_acked, s32 rtt_us);
 789         /* get info for inet_diag (optional) */
 790         void (*get_info)(struct sock *sk, u32 ext, struct sk_buff *skb);
 791
 792         char            name[TCP_CA_NAME_MAX];
 793         struct module   *owner;
 794 };
 795
 796 int tcp_register_congestion_control(struct tcp_congestion_ops *type);
 797 void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
 798
 799 void tcp_init_congestion_control(struct sock *sk);
 800 void tcp_cleanup_congestion_control(struct sock *sk);
 801 int tcp_set_default_congestion_control(const char *name);
 802 void tcp_get_default_congestion_control(char *name);
 803 void tcp_get_available_congestion_control(char *buf, size_t len);
 804 void tcp_get_allowed_congestion_control(char *buf, size_t len);
 805 int tcp_set_allowed_congestion_control(char *allowed);
 806 int tcp_set_congestion_control(struct sock *sk, const char *name);
 807 int tcp_slow_start(struct tcp_sock *tp, u32 acked);
 808 void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w);
 809
 810 extern struct tcp_congestion_ops tcp_init_congestion_ops;
 811 u32 tcp_reno_ssthresh(struct sock *sk);
 812 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
 813 extern struct tcp_congestion_ops tcp_reno;
 814
 815 static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
 816 {
 817         struct inet_connection_sock *icsk = inet_csk(sk);
 818
 819         if (icsk->icsk_ca_ops->set_state)
 820                 icsk->icsk_ca_ops->set_state(sk, ca_state);
 821         icsk->icsk_ca_state = ca_state;
 822 }
 823
 824 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
 825 {
 826         const struct inet_connection_sock *icsk = inet_csk(sk);
 827
 828         if (icsk->icsk_ca_ops->cwnd_event)
 829                 icsk->icsk_ca_ops->cwnd_event(sk, event);
 830 }
 831
 832 /* These functions determine how the current flow behaves in respect of SACK
 833  * handling. SACK is negotiated with the peer, and therefore it can vary
 834  * between different flows.
 835  *
 836  * tcp_is_sack - SACK enabled
 837  * tcp_is_reno - No SACK
 838  * tcp_is_fack - FACK enabled, implies SACK enabled
 839  */
 840 static inline int tcp_is_sack(const struct tcp_sock *tp)
 841 {
 842         return tp->rx_opt.sack_ok;
 843 }
 844
 845 static inline bool tcp_is_reno(const struct tcp_sock *tp)
 846 {
 847         return !tcp_is_sack(tp);
 848 }
 849
 850 static inline bool tcp_is_fack(const struct tcp_sock *tp)
 851 {
 852         return tp->rx_opt.sack_ok & TCP_FACK_ENABLED;
 853 }
 854
 855 static inline void tcp_enable_fack(struct tcp_sock *tp)
 856 {
 857         tp->rx_opt.sack_ok |= TCP_FACK_ENABLED;
 858 }
 859
 860 /* TCP early-retransmit (ER) is similar to but more conservative than
 861  * the thin-dupack feature.  Enable ER only if thin-dupack is disabled.
 862  */
 863 static inline void tcp_enable_early_retrans(struct tcp_sock *tp)
 864 {
 865         tp->do_early_retrans = sysctl_tcp_early_retrans &&
 866                 sysctl_tcp_early_retrans < 4 && !sysctl_tcp_thin_dupack &&
 867                 sysctl_tcp_reordering == 3;
 868 }
 869
 870 static inline void tcp_disable_early_retrans(struct tcp_sock *tp)
 871 {
 872         tp->do_early_retrans = 0;
 873 }
 874
 875 static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
 876 {
 877         return tp->sacked_out + tp->lost_out;
 878 }
 879
 880 /* This determines how many packets are "in the network" to the best
 881  * of our knowledge.  In many cases it is conservative, but where
 882  * detailed information is available from the receiver (via SACK
 883  * blocks etc.) we can make more aggressive calculations.
 884  *
 885  * Use this for decisions involving congestion control, use just
 886  * tp->packets_out to determine if the send queue is empty or not.
 887  *
 888  * Read this equation as:
 889  *
 890  *      "Packets sent once on transmission queue" MINUS
 891  *      "Packets left network, but not honestly ACKed yet" PLUS
 892  *      "Packets fast retransmitted"
 893  */
 894 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
 895 {
 896         return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
 897 }
 898
 899 #define TCP_INFINITE_SSTHRESH   0x7fffffff
 900
 901 static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
 902 {
 903         return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
 904 }
 905
 906 static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
 907 {
 908         return (TCPF_CA_CWR | TCPF_CA_Recovery) &
 909                (1 << inet_csk(sk)->icsk_ca_state);
 910 }
 911
 912 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
 913  * The exception is cwnd reduction phase, when cwnd is decreasing towards
 914  * ssthresh.
 915  */
 916 static inline __u32 tcp_current_ssthresh(const struct sock *sk)
 917 {
 918         const struct tcp_sock *tp = tcp_sk(sk);
 919
 920         if (tcp_in_cwnd_reduction(sk))
 921                 return tp->snd_ssthresh;
 922         else
 923                 return max(tp->snd_ssthresh,
 924                            ((tp->snd_cwnd >> 1) +
 925                             (tp->snd_cwnd >> 2)));
 926 }
 927
 928 /* Use define here intentionally to get WARN_ON location shown at the caller */
 929 #define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
 930
 931 void tcp_enter_cwr(struct sock *sk);
 932 __u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
 933
 934 /* The maximum number of MSS of available cwnd for which TSO defers
 935  * sending if not using sysctl_tcp_tso_win_divisor.
 936  */
 937 static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
 938 {
 939         return 3;
 940 }
 941
 942 /* Slow start with delack produces 3 packets of burst, so that
 943  * it is safe "de facto".  This will be the default - same as
 944  * the default reordering threshold - but if reordering increases,
 945  * we must be able to allow cwnd to burst at least this much in order
 946  * to not pull it back when holes are filled.
 947  */
 948 static __inline__ __u32 tcp_max_burst(const struct tcp_sock *tp)
 949 {
 950         return tp->reordering;
 951 }
 952
 953 /* Returns end sequence number of the receiver's advertised window */
 954 static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
 955 {
 956         return tp->snd_una + tp->snd_wnd;
 957 }
 958
 959 /* We follow the spirit of RFC2861 to validate cwnd but implement a more
 960  * flexible approach. The RFC suggests cwnd should not be raised unless
 961  * it was fully used previously. And that's exactly what we do in
 962  * congestion avoidance mode. But in slow start we allow cwnd to grow
 963  * as long as the application has used half the cwnd.
 964  * Example :
 965  *    cwnd is 10 (IW10), but application sends 9 frames.
 966  *    We allow cwnd to reach 18 when all frames are ACKed.
 967  * This check is safe because it's as aggressive as slow start which already
 968  * risks 100% overshoot. The advantage is that we discourage application to
 969  * either send more filler packets or data to artificially blow up the cwnd
 970  * usage, and allow application-limited process to probe bw more aggressively.
 971  */
 972 static inline bool tcp_is_cwnd_limited(const struct sock *sk)
 973 {
 974         const struct tcp_sock *tp = tcp_sk(sk);
 975
 976         /* If in slow start, ensure cwnd grows to twice what was ACKed. */
 977         if (tp->snd_cwnd <= tp->snd_ssthresh)
 978                 return tp->snd_cwnd < 2 * tp->max_packets_out;
 979
 980         return tp->is_cwnd_limited;
 981 }
 982
 983 static inline void tcp_check_probe_timer(struct sock *sk)
 984 {
 985         const struct tcp_sock *tp = tcp_sk(sk);
 986         const struct inet_connection_sock *icsk = inet_csk(sk);
 987
 988         if (!tp->packets_out && !icsk->icsk_pending)
 989                 inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
 990                                           icsk->icsk_rto, TCP_RTO_MAX);
 991 }
 992
 993 static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
 994 {
 995         tp->snd_wl1 = seq;
 996 }
 997
 998 static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
 999 {
1000         tp->snd_wl1 = seq;
1001 }
1002
1003 /*
1004  * Calculate(/check) TCP checksum
1005  */
1006 static inline __sum16 tcp_v4_check(int len, __be32 saddr,
1007                                    __be32 daddr, __wsum base)
1008 {
1009         return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
1010 }
1011
1012 static inline __sum16 __tcp_checksum_complete(struct sk_buff *skb)
1013 {
1014         return __skb_checksum_complete(skb);
1015 }
1016
1017 static inline bool tcp_checksum_complete(struct sk_buff *skb)
1018 {
1019         return !skb_csum_unnecessary(skb) &&
1020                 __tcp_checksum_complete(skb);
1021 }
1022
1023 /* Prequeue for VJ style copy to user, combined with checksumming. */
1024
1025 static inline void tcp_prequeue_init(struct tcp_sock *tp)
1026 {
1027         tp->ucopy.task = NULL;
1028         tp->ucopy.len = 0;
1029         tp->ucopy.memory = 0;
1030         skb_queue_head_init(&tp->ucopy.prequeue);
1031 }
1032
1033 bool tcp_prequeue(struct sock *sk, struct sk_buff *skb);
1034
1035 #undef STATE_TRACE
1036
1037 #ifdef STATE_TRACE
1038 static const char *statename[]={
1039         "Unused","Established","Syn Sent","Syn Recv",
1040         "Fin Wait 1","Fin Wait 2","Time Wait", "Close",
1041         "Close Wait","Last ACK","Listen","Closing"
1042 };
1043 #endif
1044 void tcp_set_state(struct sock *sk, int state);
1045
1046 void tcp_done(struct sock *sk);
1047
1048 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
1049 {
1050         rx_opt->dsack = 0;
1051         rx_opt->num_sacks = 0;
1052 }
1053
1054 u32 tcp_default_init_rwnd(u32 mss);
1055
1056 /* Determine a window scaling and initial window to offer. */
1057 void tcp_select_initial_window(int __space, __u32 mss, __u32 *rcv_wnd,
1058                                __u32 *window_clamp, int wscale_ok,
1059                                __u8 *rcv_wscale, __u32 init_rcv_wnd);
1060
1061 static inline int tcp_win_from_space(int space)
1062 {
1063         return sysctl_tcp_adv_win_scale<=0 ?
1064                 (space>>(-sysctl_tcp_adv_win_scale)) :
1065                 space - (space>>sysctl_tcp_adv_win_scale);
1066 }
1067
1068 /* Note: caller must be prepared to deal with negative returns */
1069 static inline int tcp_space(const struct sock *sk)
1070 {
1071         return tcp_win_from_space(sk->sk_rcvbuf -
1072                                   atomic_read(&sk->sk_rmem_alloc));
1073 }
1074
1075 static inline int tcp_full_space(const struct sock *sk)
1076 {
1077         return tcp_win_from_space(sk->sk_rcvbuf);
1078 }
1079
1080 static inline void tcp_openreq_init(struct request_sock *req,
1081                                     struct tcp_options_received *rx_opt,
1082                                     struct sk_buff *skb, struct sock *sk)
1083 {
1084         struct inet_request_sock *ireq = inet_rsk(req);
1085
1086         req->rcv_wnd = 0;               /* So that tcp_send_synack() knows! */
1087         req->cookie_ts = 0;
1088         tcp_rsk(req)->rcv_isn = TCP_SKB_CB(skb)->seq;
1089         tcp_rsk(req)->rcv_nxt = TCP_SKB_CB(skb)->seq + 1;
1090         tcp_rsk(req)->snt_synack = tcp_time_stamp;
1091         req->mss = rx_opt->mss_clamp;
1092         req->ts_recent = rx_opt->saw_tstamp ? rx_opt->rcv_tsval : 0;
1093         ireq->tstamp_ok = rx_opt->tstamp_ok;
1094         ireq->sack_ok = rx_opt->sack_ok;
1095         ireq->snd_wscale = rx_opt->snd_wscale;
1096         ireq->wscale_ok = rx_opt->wscale_ok;
1097         ireq->acked = 0;
1098         ireq->ecn_ok = 0;
1099         ireq->ir_rmt_port = tcp_hdr(skb)->source;
1100         ireq->ir_num = ntohs(tcp_hdr(skb)->dest);
1101         ireq->ir_mark = inet_request_mark(sk, skb);
1102 }
1103
1104 extern void tcp_openreq_init_rwin(struct request_sock *req,
1105                                   struct sock *sk, struct dst_entry *dst);
1106
1107 void tcp_enter_memory_pressure(struct sock *sk);
1108
1109 static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1110 {
1111         return tp->keepalive_intvl ? : sysctl_tcp_keepalive_intvl;
1112 }
1113
1114 static inline int keepalive_time_when(const struct tcp_sock *tp)
1115 {
1116         return tp->keepalive_time ? : sysctl_tcp_keepalive_time;
1117 }
1118
1119 static inline int keepalive_probes(const struct tcp_sock *tp)
1120 {
1121         return tp->keepalive_probes ? : sysctl_tcp_keepalive_probes;
1122 }
1123
1124 static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1125 {
1126         const struct inet_connection_sock *icsk = &tp->inet_conn;
1127
1128         return min_t(u32, tcp_time_stamp - icsk->icsk_ack.lrcvtime,
1129                           tcp_time_stamp - tp->rcv_tstamp);
1130 }
1131
1132 static inline int tcp_fin_time(const struct sock *sk)
1133 {
1134         int fin_timeout = tcp_sk(sk)->linger2 ? : sysctl_tcp_fin_timeout;
1135         const int rto = inet_csk(sk)->icsk_rto;
1136
1137         if (fin_timeout < (rto << 2) - (rto >> 1))
1138                 fin_timeout = (rto << 2) - (rto >> 1);
1139
1140         return fin_timeout;
1141 }
1142
1143 static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
1144                                   int paws_win)
1145 {
1146         if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
1147                 return true;
1148         if (unlikely(get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS))
1149                 return true;
1150         /*
1151          * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1152          * then following tcp messages have valid values. Ignore 0 value,
1153          * or else 'negative' tsval might forbid us to accept their packets.
1154          */
1155         if (!rx_opt->ts_recent)
1156                 return true;
1157         return false;
1158 }
1159
1160 static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
1161                                    int rst)
1162 {
1163         if (tcp_paws_check(rx_opt, 0))
1164                 return false;
1165
1166         /* RST segments are not recommended to carry timestamp,
1167            and, if they do, it is recommended to ignore PAWS because
1168            "their cleanup function should take precedence over timestamps."
1169            Certainly, it is mistake. It is necessary to understand the reasons
1170            of this constraint to relax it: if peer reboots, clock may go
1171            out-of-sync and half-open connections will not be reset.
1172            Actually, the problem would be not existing if all
1173            the implementations followed draft about maintaining clock
1174            via reboots. Linux-2.2 DOES NOT!
1175
1176            However, we can relax time bounds for RST segments to MSL.
1177          */
1178         if (rst && get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
1179                 return false;
1180         return true;
1181 }
1182
1183 static inline void tcp_mib_init(struct net *net)
1184 {
1185         /* See RFC 2012 */
1186         TCP_ADD_STATS_USER(net, TCP_MIB_RTOALGORITHM, 1);
1187         TCP_ADD_STATS_USER(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1188         TCP_ADD_STATS_USER(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1189         TCP_ADD_STATS_USER(net, TCP_MIB_MAXCONN, -1);
1190 }
1191
1192 /* from STCP */
1193 static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
1194 {
1195         tp->lost_skb_hint = NULL;
1196 }
1197
1198 static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1199 {
1200         tcp_clear_retrans_hints_partial(tp);
1201         tp->retransmit_skb_hint = NULL;
1202 }
1203
1204 /* MD5 Signature */
1205 struct crypto_hash;
1206
1207 union tcp_md5_addr {
1208         struct in_addr  a4;
1209 #if IS_ENABLED(CONFIG_IPV6)
1210         struct in6_addr a6;
1211 #endif
1212 };
1213
1214 /* - key database */
1215 struct tcp_md5sig_key {
1216         struct hlist_node       node;
1217         u8                      keylen;
1218         u8                      family; /* AF_INET or AF_INET6 */
1219         union tcp_md5_addr      addr;
1220         u8                      key[TCP_MD5SIG_MAXKEYLEN];
1221         struct rcu_head         rcu;
1222 };
1223
1224 /* - sock block */
1225 struct tcp_md5sig_info {
1226         struct hlist_head       head;
1227         struct rcu_head         rcu;
1228 };
1229
1230 /* - pseudo header */
1231 struct tcp4_pseudohdr {
1232         __be32          saddr;
1233         __be32          daddr;
1234         __u8            pad;
1235         __u8            protocol;
1236         __be16          len;
1237 };
1238
1239 struct tcp6_pseudohdr {
1240         struct in6_addr saddr;
1241         struct in6_addr daddr;
1242         __be32          len;
1243         __be32          protocol;       /* including padding */
1244 };
1245
1246 union tcp_md5sum_block {
1247         struct tcp4_pseudohdr ip4;
1248 #if IS_ENABLED(CONFIG_IPV6)
1249         struct tcp6_pseudohdr ip6;
1250 #endif
1251 };
1252
1253 /* - pool: digest algorithm, hash description and scratch buffer */
1254 struct tcp_md5sig_pool {
1255         struct hash_desc        md5_desc;
1256         union tcp_md5sum_block  md5_blk;
1257 };
1258
1259 /* - functions */
1260 int tcp_v4_md5_hash_skb(char *md5_hash, struct tcp_md5sig_key *key,
1261                         const struct sock *sk, const struct request_sock *req,
1262                         const struct sk_buff *skb);
1263 int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
1264                    int family, const u8 *newkey, u8 newkeylen, gfp_t gfp);
1265 int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
1266                    int family);
1267 struct tcp_md5sig_key *tcp_v4_md5_lookup(struct sock *sk,
1268                                          struct sock *addr_sk);
1269
1270 #ifdef CONFIG_TCP_MD5SIG
1271 struct tcp_md5sig_key *tcp_md5_do_lookup(struct sock *sk,
1272                                          const union tcp_md5_addr *addr,
1273                                          int family);
1274 #define tcp_twsk_md5_key(twsk)  ((twsk)->tw_md5_key)
1275 #else
1276 static inline struct tcp_md5sig_key *tcp_md5_do_lookup(struct sock *sk,
1277                                          const union tcp_md5_addr *addr,
1278                                          int family)
1279 {
1280         return NULL;
1281 }
1282 #define tcp_twsk_md5_key(twsk)  NULL
1283 #endif
1284
1285 bool tcp_alloc_md5sig_pool(void);
1286
1287 struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
1288 static inline void tcp_put_md5sig_pool(void)
1289 {
1290         local_bh_enable();
1291 }
1292
1293 int tcp_md5_hash_header(struct tcp_md5sig_pool *, const struct tcphdr *);
1294 int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
1295                           unsigned int header_len);
1296 int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
1297                      const struct tcp_md5sig_key *key);
1298
1299 /* From tcp_fastopen.c */
1300 void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
1301                             struct tcp_fastopen_cookie *cookie, int *syn_loss,
1302                             unsigned long *last_syn_loss);
1303 void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
1304                             struct tcp_fastopen_cookie *cookie, bool syn_lost);
1305 struct tcp_fastopen_request {
1306         /* Fast Open cookie. Size 0 means a cookie request */
1307         struct tcp_fastopen_cookie      cookie;
1308         struct msghdr                   *data;  /* data in MSG_FASTOPEN */
1309         size_t                          size;
1310         int                             copied; /* queued in tcp_connect() */
1311 };
1312 void tcp_free_fastopen_req(struct tcp_sock *tp);
1313
1314 extern struct tcp_fastopen_context __rcu *tcp_fastopen_ctx;
1315 int tcp_fastopen_reset_cipher(void *key, unsigned int len);
1316 bool tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
1317                       struct request_sock *req,
1318                       struct tcp_fastopen_cookie *foc,
1319                       struct dst_entry *dst);
1320 void tcp_fastopen_init_key_once(bool publish);
1321 #define TCP_FASTOPEN_KEY_LENGTH 16
1322
1323 /* Fastopen key context */
1324 struct tcp_fastopen_context {
1325         struct crypto_cipher    *tfm;
1326         __u8                    key[TCP_FASTOPEN_KEY_LENGTH];
1327         struct rcu_head         rcu;
1328 };
1329
1330 /* write queue abstraction */
1331 static inline void tcp_write_queue_purge(struct sock *sk)
1332 {
1333         struct sk_buff *skb;
1334
1335         while ((skb = __skb_dequeue(&sk->sk_write_queue)) != NULL)
1336                 sk_wmem_free_skb(sk, skb);
1337         sk_mem_reclaim(sk);
1338         tcp_clear_all_retrans_hints(tcp_sk(sk));
1339 }
1340
1341 static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
1342 {
1343         return skb_peek(&sk->sk_write_queue);
1344 }
1345
1346 static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
1347 {
1348         return skb_peek_tail(&sk->sk_write_queue);
1349 }
1350
1351 static inline struct sk_buff *tcp_write_queue_next(const struct sock *sk,
1352                                                    const struct sk_buff *skb)
1353 {
1354         return skb_queue_next(&sk->sk_write_queue, skb);
1355 }
1356
1357 static inline struct sk_buff *tcp_write_queue_prev(const struct sock *sk,
1358                                                    const struct sk_buff *skb)
1359 {
1360         return skb_queue_prev(&sk->sk_write_queue, skb);
1361 }
1362
1363 #define tcp_for_write_queue(skb, sk)                                    \
1364         skb_queue_walk(&(sk)->sk_write_queue, skb)
1365
1366 #define tcp_for_write_queue_from(skb, sk)                               \
1367         skb_queue_walk_from(&(sk)->sk_write_queue, skb)
1368
1369 #define tcp_for_write_queue_from_safe(skb, tmp, sk)                     \
1370         skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
1371
1372 static inline struct sk_buff *tcp_send_head(const struct sock *sk)
1373 {
1374         return sk->sk_send_head;
1375 }
1376
1377 static inline bool tcp_skb_is_last(const struct sock *sk,
1378                                    const struct sk_buff *skb)
1379 {
1380         return skb_queue_is_last(&sk->sk_write_queue, skb);
1381 }
1382
1383 static inline void tcp_advance_send_head(struct sock *sk, const struct sk_buff *skb)
1384 {
1385         if (tcp_skb_is_last(sk, skb))
1386                 sk->sk_send_head = NULL;
1387         else
1388                 sk->sk_send_head = tcp_write_queue_next(sk, skb);
1389 }
1390
1391 static inline void tcp_check_send_head(struct sock *sk, struct sk_buff *skb_unlinked)
1392 {
1393         if (sk->sk_send_head == skb_unlinked)
1394                 sk->sk_send_head = NULL;
1395 }
1396
1397 static inline void tcp_init_send_head(struct sock *sk)
1398 {
1399         sk->sk_send_head = NULL;
1400 }
1401
1402 static inline void __tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1403 {
1404         __skb_queue_tail(&sk->sk_write_queue, skb);
1405 }
1406
1407 static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1408 {
1409         __tcp_add_write_queue_tail(sk, skb);
1410
1411         /* Queue it, remembering where we must start sending. */
1412         if (sk->sk_send_head == NULL) {
1413                 sk->sk_send_head = skb;
1414
1415                 if (tcp_sk(sk)->highest_sack == NULL)
1416                         tcp_sk(sk)->highest_sack = skb;
1417         }
1418 }
1419
1420 static inline void __tcp_add_write_queue_head(struct sock *sk, struct sk_buff *skb)
1421 {
1422         __skb_queue_head(&sk->sk_write_queue, skb);
1423 }
1424
1425 /* Insert buff after skb on the write queue of sk.  */
1426 static inline void tcp_insert_write_queue_after(struct sk_buff *skb,
1427                                                 struct sk_buff *buff,
1428                                                 struct sock *sk)
1429 {
1430         __skb_queue_after(&sk->sk_write_queue, skb, buff);
1431 }
1432
1433 /* Insert new before skb on the write queue of sk.  */
1434 static inline void tcp_insert_write_queue_before(struct sk_buff *new,
1435                                                   struct sk_buff *skb,
1436                                                   struct sock *sk)
1437 {
1438         __skb_queue_before(&sk->sk_write_queue, skb, new);
1439
1440         if (sk->sk_send_head == skb)
1441                 sk->sk_send_head = new;
1442 }
1443
1444 static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
1445 {
1446         __skb_unlink(skb, &sk->sk_write_queue);
1447 }
1448
1449 static inline bool tcp_write_queue_empty(struct sock *sk)
1450 {
1451         return skb_queue_empty(&sk->sk_write_queue);
1452 }
1453
1454 static inline void tcp_push_pending_frames(struct sock *sk)
1455 {
1456         if (tcp_send_head(sk)) {
1457                 struct tcp_sock *tp = tcp_sk(sk);
1458
1459                 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
1460         }
1461 }
1462
1463 /* Start sequence of the skb just after the highest skb with SACKed
1464  * bit, valid only if sacked_out > 0 or when the caller has ensured
1465  * validity by itself.
1466  */
1467 static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
1468 {
1469         if (!tp->sacked_out)
1470                 return tp->snd_una;
1471
1472         if (tp->highest_sack == NULL)
1473                 return tp->snd_nxt;
1474
1475         return TCP_SKB_CB(tp->highest_sack)->seq;
1476 }
1477
1478 static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
1479 {
1480         tcp_sk(sk)->highest_sack = tcp_skb_is_last(sk, skb) ? NULL :
1481                                                 tcp_write_queue_next(sk, skb);
1482 }
1483
1484 static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
1485 {
1486         return tcp_sk(sk)->highest_sack;
1487 }
1488
1489 static inline void tcp_highest_sack_reset(struct sock *sk)
1490 {
1491         tcp_sk(sk)->highest_sack = tcp_write_queue_head(sk);
1492 }
1493
1494 /* Called when old skb is about to be deleted (to be combined with new skb) */
1495 static inline void tcp_highest_sack_combine(struct sock *sk,
1496                                             struct sk_buff *old,
1497                                             struct sk_buff *new)
1498 {
1499         if (tcp_sk(sk)->sacked_out && (old == tcp_sk(sk)->highest_sack))
1500                 tcp_sk(sk)->highest_sack = new;
1501 }
1502
1503 /* Determines whether this is a thin stream (which may suffer from
1504  * increased latency). Used to trigger latency-reducing mechanisms.
1505  */
1506 static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
1507 {
1508         return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
1509 }
1510
1511 /* /proc */
1512 enum tcp_seq_states {
1513         TCP_SEQ_STATE_LISTENING,
1514         TCP_SEQ_STATE_OPENREQ,
1515         TCP_SEQ_STATE_ESTABLISHED,
1516 };
1517
1518 int tcp_seq_open(struct inode *inode, struct file *file);
1519
1520 struct tcp_seq_afinfo {
1521         char                            *name;
1522         sa_family_t                     family;
1523         const struct file_operations    *seq_fops;
1524         struct seq_operations           seq_ops;
1525 };
1526
1527 struct tcp_iter_state {
1528         struct seq_net_private  p;
1529         sa_family_t             family;
1530         enum tcp_seq_states     state;
1531         struct sock             *syn_wait_sk;
1532         int                     bucket, offset, sbucket, num;
1533         kuid_t                  uid;
1534         loff_t                  last_pos;
1535 };
1536
1537 int tcp_proc_register(struct net *net, struct tcp_seq_afinfo *afinfo);
1538 void tcp_proc_unregister(struct net *net, struct tcp_seq_afinfo *afinfo);
1539
1540 extern struct request_sock_ops tcp_request_sock_ops;
1541 extern struct request_sock_ops tcp6_request_sock_ops;
1542
1543 void tcp_v4_destroy_sock(struct sock *sk);
1544
1545 struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
1546                                 netdev_features_t features);
1547 struct sk_buff **tcp_gro_receive(struct sk_buff **head, struct sk_buff *skb);
1548 int tcp_gro_complete(struct sk_buff *skb);
1549
1550 void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, __be32 daddr);
1551
1552 static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
1553 {
1554         return tp->notsent_lowat ?: sysctl_tcp_notsent_lowat;
1555 }
1556
1557 static inline bool tcp_stream_memory_free(const struct sock *sk)
1558 {
1559         const struct tcp_sock *tp = tcp_sk(sk);
1560         u32 notsent_bytes = tp->write_seq - tp->snd_nxt;
1561
1562         return notsent_bytes < tcp_notsent_lowat(tp);
1563 }
1564
1565 #ifdef CONFIG_PROC_FS
1566 int tcp4_proc_init(void);
1567 void tcp4_proc_exit(void);
1568 #endif
1569
1570 int tcp_rtx_synack(struct sock *sk, struct request_sock *req);
1571 int tcp_conn_request(struct request_sock_ops *rsk_ops,
1572                      const struct tcp_request_sock_ops *af_ops,
1573                      struct sock *sk, struct sk_buff *skb);
1574
1575 /* TCP af-specific functions */
1576 struct tcp_sock_af_ops {
1577 #ifdef CONFIG_TCP_MD5SIG
1578         struct tcp_md5sig_key   *(*md5_lookup) (struct sock *sk,
1579                                                 struct sock *addr_sk);
1580         int                     (*calc_md5_hash) (char *location,
1581                                                   struct tcp_md5sig_key *md5,
1582                                                   const struct sock *sk,
1583                                                   const struct request_sock *req,
1584                                                   const struct sk_buff *skb);
1585         int                     (*md5_parse) (struct sock *sk,
1586                                               char __user *optval,
1587                                               int optlen);
1588 #endif
1589 };
1590
1591 struct tcp_request_sock_ops {
1592         u16 mss_clamp;
1593 #ifdef CONFIG_TCP_MD5SIG
1594         struct tcp_md5sig_key   *(*md5_lookup) (struct sock *sk,
1595                                                 struct request_sock *req);
1596         int                     (*calc_md5_hash) (char *location,
1597                                                   struct tcp_md5sig_key *md5,
1598                                                   const struct sock *sk,
1599                                                   const struct request_sock *req,
1600                                                   const struct sk_buff *skb);
1601 #endif
1602         void (*init_req)(struct request_sock *req, struct sock *sk,
1603                          struct sk_buff *skb);
1604 #ifdef CONFIG_SYN_COOKIES
1605         __u32 (*cookie_init_seq)(struct sock *sk, const struct sk_buff *skb,
1606                                  __u16 *mss);
1607 #endif
1608         struct dst_entry *(*route_req)(struct sock *sk, struct flowi *fl,
1609                                        const struct request_sock *req,
1610                                        bool *strict);
1611         __u32 (*init_seq)(const struct sk_buff *skb);
1612         int (*send_synack)(struct sock *sk, struct dst_entry *dst,
1613                            struct flowi *fl, struct request_sock *req,
1614                            u16 queue_mapping, struct tcp_fastopen_cookie *foc);
1615         void (*queue_hash_add)(struct sock *sk, struct request_sock *req,
1616                                const unsigned long timeout);
1617 };
1618
1619 #ifdef CONFIG_SYN_COOKIES
1620 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
1621                                          struct sock *sk, struct sk_buff *skb,
1622                                          __u16 *mss)
1623 {
1624         return ops->cookie_init_seq(sk, skb, mss);
1625 }
1626 #else
1627 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
1628                                          struct sock *sk, struct sk_buff *skb,
1629                                          __u16 *mss)
1630 {
1631         return 0;
1632 }
1633 #endif
1634
1635 int tcpv4_offload_init(void);
1636
1637 void tcp_v4_init(void);
1638 void tcp_init(void);
1639
1640 #endif  /* _TCP_H */