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