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