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