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