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