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