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