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
  31 #include <net/inet_connection_sock.h>
  32 #include <net/inet_timewait_sock.h>
  33 #include <net/inet_hashtables.h>
  34 #include <net/checksum.h>
  35 #include <net/request_sock.h>
  36 #include <net/sock.h>
  37 #include <net/snmp.h>
  38 #include <net/ip.h>
  39 #include <net/tcp_states.h>
  40
  41 #include <linux/seq_file.h>
  42
  43 extern struct inet_hashinfo tcp_hashinfo;
  44
  45 extern atomic_t tcp_orphan_count;
  46 extern void tcp_time_wait(struct sock *sk, int state, int timeo);
  47
  48 #define MAX_TCP_HEADER  (128 + MAX_HEADER)
  49
  50 /*
  51  * Never offer a window over 32767 without using window scaling. Some
  52  * poor stacks do signed 16bit maths!
  53  */
  54 #define MAX_TCP_WINDOW          32767U
  55
  56 /* Minimal accepted MSS. It is (60+60+8) - (20+20). */
  57 #define TCP_MIN_MSS             88U
  58
  59 /* Minimal RCV_MSS. */
  60 #define TCP_MIN_RCVMSS          536U
  61
  62 /* The least MTU to use for probing */
  63 #define TCP_BASE_MSS            512
  64
  65 /* After receiving this amount of duplicate ACKs fast retransmit starts. */
  66 #define TCP_FASTRETRANS_THRESH 3
  67
  68 /* Maximal reordering. */
  69 #define TCP_MAX_REORDERING      127
  70
  71 /* Maximal number of ACKs sent quickly to accelerate slow-start. */
  72 #define TCP_MAX_QUICKACKS       16U
  73
  74 /* urg_data states */
  75 #define TCP_URG_VALID   0x0100
  76 #define TCP_URG_NOTYET  0x0200
  77 #define TCP_URG_READ    0x0400
  78
  79 #define TCP_RETR1       3       /*
  80                                  * This is how many retries it does before it
  81                                  * tries to figure out if the gateway is
  82                                  * down. Minimal RFC value is 3; it corresponds
  83                                  * to ~3sec-8min depending on RTO.
  84                                  */
  85
  86 #define TCP_RETR2       15      /*
  87                                  * This should take at least
  88                                  * 90 minutes to time out.
  89                                  * RFC1122 says that the limit is 100 sec.
  90                                  * 15 is ~13-30min depending on RTO.
  91                                  */
  92
  93 #define TCP_SYN_RETRIES  5      /* number of times to retry active opening a
  94                                  * connection: ~180sec is RFC minimum   */
  95
  96 #define TCP_SYNACK_RETRIES 5    /* number of times to retry passive opening a
  97                                  * connection: ~180sec is RFC minimum   */
  98
  99
 100 #define TCP_ORPHAN_RETRIES 7    /* number of times to retry on an orphaned
 101                                  * socket. 7 is ~50sec-16min.
 102                                  */
 103
 104
 105 #define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
 106                                   * state, about 60 seconds     */
 107 #define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
 108                                  /* BSD style FIN_WAIT2 deadlock breaker.
 109                                   * It used to be 3min, new value is 60sec,
 110                                   * to combine FIN-WAIT-2 timeout with
 111                                   * TIME-WAIT timer.
 112                                   */
 113
 114 #define TCP_DELACK_MAX  ((unsigned)(HZ/5))      /* maximal time to delay before sending an ACK */
 115 #if HZ >= 100
 116 #define TCP_DELACK_MIN  ((unsigned)(HZ/25))     /* minimal time to delay before sending an ACK */
 117 #define TCP_ATO_MIN     ((unsigned)(HZ/25))
 118 #else
 119 #define TCP_DELACK_MIN  4U
 120 #define TCP_ATO_MIN     4U
 121 #endif
 122 #define TCP_RTO_MAX     ((unsigned)(120*HZ))
 123 #define TCP_RTO_MIN     ((unsigned)(HZ/5))
 124 #define TCP_TIMEOUT_INIT ((unsigned)(3*HZ))     /* RFC 1122 initial RTO value   */
 125
 126 #define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
 127                                                          * for local resources.
 128                                                          */
 129
 130 #define TCP_KEEPALIVE_TIME      (120*60*HZ)     /* two hours */
 131 #define TCP_KEEPALIVE_PROBES    9               /* Max of 9 keepalive probes    */
 132 #define TCP_KEEPALIVE_INTVL     (75*HZ)
 133
 134 #define MAX_TCP_KEEPIDLE        32767
 135 #define MAX_TCP_KEEPINTVL       32767
 136 #define MAX_TCP_KEEPCNT         127
 137 #define MAX_TCP_SYNCNT          127
 138
 139 #define TCP_SYNQ_INTERVAL       (HZ/5)  /* Period of SYNACK timer */
 140 #define TCP_SYNQ_HSIZE          512     /* Size of SYNACK hash table */
 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
 165 /*
 166  *     TCP option lengths
 167  */
 168
 169 #define TCPOLEN_MSS            4
 170 #define TCPOLEN_WINDOW         3
 171 #define TCPOLEN_SACK_PERM      2
 172 #define TCPOLEN_TIMESTAMP      10
 173
 174 /* But this is what stacks really send out. */
 175 #define TCPOLEN_TSTAMP_ALIGNED          12
 176 #define TCPOLEN_WSCALE_ALIGNED          4
 177 #define TCPOLEN_SACKPERM_ALIGNED        4
 178 #define TCPOLEN_SACK_BASE               2
 179 #define TCPOLEN_SACK_BASE_ALIGNED       4
 180 #define TCPOLEN_SACK_PERBLOCK           8
 181
 182 /* Flags in tp->nonagle */
 183 #define TCP_NAGLE_OFF           1       /* Nagle's algo is disabled */
 184 #define TCP_NAGLE_CORK          2       /* Socket is corked         */
 185 #define TCP_NAGLE_PUSH          4       /* Cork is overridden for already queued data */
 186
 187 extern struct inet_timewait_death_row tcp_death_row;
 188
 189 /* sysctl variables for tcp */
 190 extern int sysctl_tcp_timestamps;
 191 extern int sysctl_tcp_window_scaling;
 192 extern int sysctl_tcp_sack;
 193 extern int sysctl_tcp_fin_timeout;
 194 extern int sysctl_tcp_keepalive_time;
 195 extern int sysctl_tcp_keepalive_probes;
 196 extern int sysctl_tcp_keepalive_intvl;
 197 extern int sysctl_tcp_syn_retries;
 198 extern int sysctl_tcp_synack_retries;
 199 extern int sysctl_tcp_retries1;
 200 extern int sysctl_tcp_retries2;
 201 extern int sysctl_tcp_orphan_retries;
 202 extern int sysctl_tcp_syncookies;
 203 extern int sysctl_tcp_retrans_collapse;
 204 extern int sysctl_tcp_stdurg;
 205 extern int sysctl_tcp_rfc1337;
 206 extern int sysctl_tcp_abort_on_overflow;
 207 extern int sysctl_tcp_max_orphans;
 208 extern int sysctl_tcp_fack;
 209 extern int sysctl_tcp_reordering;
 210 extern int sysctl_tcp_ecn;
 211 extern int sysctl_tcp_dsack;
 212 extern int sysctl_tcp_mem[3];
 213 extern int sysctl_tcp_wmem[3];
 214 extern int sysctl_tcp_rmem[3];
 215 extern int sysctl_tcp_app_win;
 216 extern int sysctl_tcp_adv_win_scale;
 217 extern int sysctl_tcp_tw_reuse;
 218 extern int sysctl_tcp_frto;
 219 extern int sysctl_tcp_low_latency;
 220 extern int sysctl_tcp_nometrics_save;
 221 extern int sysctl_tcp_moderate_rcvbuf;
 222 extern int sysctl_tcp_tso_win_divisor;
 223 extern int sysctl_tcp_abc;
 224 extern int sysctl_tcp_mtu_probing;
 225 extern int sysctl_tcp_base_mss;
 226 extern int sysctl_tcp_workaround_signed_windows;
 227
 228 extern atomic_t tcp_memory_allocated;
 229 extern atomic_t tcp_sockets_allocated;
 230 extern int tcp_memory_pressure;
 231
 232 /*
 233  * The next routines deal with comparing 32 bit unsigned ints
 234  * and worry about wraparound (automatic with unsigned arithmetic).
 235  */
 236
 237 static inline int before(__u32 seq1, __u32 seq2)
 238 {
 239         return (__s32)(seq1-seq2) < 0;
 240 }
 241
 242 static inline int after(__u32 seq1, __u32 seq2)
 243 {
 244         return (__s32)(seq2-seq1) < 0;
 245 }
 246
 247
 248 /* is s2<=s1<=s3 ? */
 249 static inline int between(__u32 seq1, __u32 seq2, __u32 seq3)
 250 {
 251         return seq3 - seq2 >= seq1 - seq2;
 252 }
 253
 254
 255 extern struct proto tcp_prot;
 256
 257 DECLARE_SNMP_STAT(struct tcp_mib, tcp_statistics);
 258 #define TCP_INC_STATS(field)            SNMP_INC_STATS(tcp_statistics, field)
 259 #define TCP_INC_STATS_BH(field)         SNMP_INC_STATS_BH(tcp_statistics, field)
 260 #define TCP_INC_STATS_USER(field)       SNMP_INC_STATS_USER(tcp_statistics, field)
 261 #define TCP_DEC_STATS(field)            SNMP_DEC_STATS(tcp_statistics, field)
 262 #define TCP_ADD_STATS_BH(field, val)    SNMP_ADD_STATS_BH(tcp_statistics, field, val)
 263 #define TCP_ADD_STATS_USER(field, val)  SNMP_ADD_STATS_USER(tcp_statistics, field, val)
 264
 265 extern void                     tcp_v4_err(struct sk_buff *skb, u32);
 266
 267 extern void                     tcp_shutdown (struct sock *sk, int how);
 268
 269 extern int                      tcp_v4_rcv(struct sk_buff *skb);
 270
 271 extern int                      tcp_v4_remember_stamp(struct sock *sk);
 272
 273 extern int                      tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
 274
 275 extern int                      tcp_sendmsg(struct kiocb *iocb, struct sock *sk,
 276                                             struct msghdr *msg, size_t size);
 277 extern ssize_t                  tcp_sendpage(struct socket *sock, struct page *page, int offset, size_t size, int flags);
 278
 279 extern int                      tcp_ioctl(struct sock *sk,
 280                                           int cmd,
 281                                           unsigned long arg);
 282
 283 extern int                      tcp_rcv_state_process(struct sock *sk,
 284                                                       struct sk_buff *skb,
 285                                                       struct tcphdr *th,
 286                                                       unsigned len);
 287
 288 extern int                      tcp_rcv_established(struct sock *sk,
 289                                                     struct sk_buff *skb,
 290                                                     struct tcphdr *th,
 291                                                     unsigned len);
 292
 293 extern void                     tcp_rcv_space_adjust(struct sock *sk);
 294
 295 extern int                      tcp_twsk_unique(struct sock *sk,
 296                                                 struct sock *sktw, void *twp);
 297
 298 static inline void tcp_dec_quickack_mode(struct sock *sk,
 299                                          const unsigned int pkts)
 300 {
 301         struct inet_connection_sock *icsk = inet_csk(sk);
 302
 303         if (icsk->icsk_ack.quick) {
 304                 if (pkts >= icsk->icsk_ack.quick) {
 305                         icsk->icsk_ack.quick = 0;
 306                         /* Leaving quickack mode we deflate ATO. */
 307                         icsk->icsk_ack.ato   = TCP_ATO_MIN;
 308                 } else
 309                         icsk->icsk_ack.quick -= pkts;
 310         }
 311 }
 312
 313 extern void tcp_enter_quickack_mode(struct sock *sk);
 314
 315 static inline void tcp_clear_options(struct tcp_options_received *rx_opt)
 316 {
 317         rx_opt->tstamp_ok = rx_opt->sack_ok = rx_opt->wscale_ok = rx_opt->snd_wscale = 0;
 318 }
 319
 320 enum tcp_tw_status
 321 {
 322         TCP_TW_SUCCESS = 0,
 323         TCP_TW_RST = 1,
 324         TCP_TW_ACK = 2,
 325         TCP_TW_SYN = 3
 326 };
 327
 328
 329 extern enum tcp_tw_status       tcp_timewait_state_process(struct inet_timewait_sock *tw,
 330                                                            struct sk_buff *skb,
 331                                                            const struct tcphdr *th);
 332
 333 extern struct sock *            tcp_check_req(struct sock *sk,struct sk_buff *skb,
 334                                               struct request_sock *req,
 335                                               struct request_sock **prev);
 336 extern int                      tcp_child_process(struct sock *parent,
 337                                                   struct sock *child,
 338                                                   struct sk_buff *skb);
 339 extern void                     tcp_enter_frto(struct sock *sk);
 340 extern void                     tcp_enter_loss(struct sock *sk, int how);
 341 extern void                     tcp_clear_retrans(struct tcp_sock *tp);
 342 extern void                     tcp_update_metrics(struct sock *sk);
 343
 344 extern void                     tcp_close(struct sock *sk,
 345                                           long timeout);
 346 extern unsigned int             tcp_poll(struct file * file, struct socket *sock, struct poll_table_struct *wait);
 347
 348 extern int                      tcp_getsockopt(struct sock *sk, int level,
 349                                                int optname,
 350                                                char __user *optval,
 351                                                int __user *optlen);
 352 extern int                      tcp_setsockopt(struct sock *sk, int level,
 353                                                int optname, char __user *optval,
 354                                                int optlen);
 355 extern int                      compat_tcp_getsockopt(struct sock *sk,
 356                                         int level, int optname,
 357                                         char __user *optval, int __user *optlen);
 358 extern int                      compat_tcp_setsockopt(struct sock *sk,
 359                                         int level, int optname,
 360                                         char __user *optval, int optlen);
 361 extern void                     tcp_set_keepalive(struct sock *sk, int val);
 362 extern int                      tcp_recvmsg(struct kiocb *iocb, struct sock *sk,
 363                                             struct msghdr *msg,
 364                                             size_t len, int nonblock,
 365                                             int flags, int *addr_len);
 366
 367 extern void                     tcp_parse_options(struct sk_buff *skb,
 368                                                   struct tcp_options_received *opt_rx,
 369                                                   int estab);
 370
 371 /*
 372  *      TCP v4 functions exported for the inet6 API
 373  */
 374
 375 extern void                     tcp_v4_send_check(struct sock *sk, int len,
 376                                                   struct sk_buff *skb);
 377
 378 extern int                      tcp_v4_conn_request(struct sock *sk,
 379                                                     struct sk_buff *skb);
 380
 381 extern struct sock *            tcp_create_openreq_child(struct sock *sk,
 382                                                          struct request_sock *req,
 383                                                          struct sk_buff *skb);
 384
 385 extern struct sock *            tcp_v4_syn_recv_sock(struct sock *sk,
 386                                                      struct sk_buff *skb,
 387                                                      struct request_sock *req,
 388                                                         struct dst_entry *dst);
 389
 390 extern int                      tcp_v4_do_rcv(struct sock *sk,
 391                                               struct sk_buff *skb);
 392
 393 extern int                      tcp_v4_connect(struct sock *sk,
 394                                                struct sockaddr *uaddr,
 395                                                int addr_len);
 396
 397 extern int                      tcp_connect(struct sock *sk);
 398
 399 extern struct sk_buff *         tcp_make_synack(struct sock *sk,
 400                                                 struct dst_entry *dst,
 401                                                 struct request_sock *req);
 402
 403 extern int                      tcp_disconnect(struct sock *sk, int flags);
 404
 405 extern void                     tcp_unhash(struct sock *sk);
 406
 407 /* From syncookies.c */
 408 extern struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb,
 409                                     struct ip_options *opt);
 410 extern __u32 cookie_v4_init_sequence(struct sock *sk, struct sk_buff *skb,
 411                                      __u16 *mss);
 412
 413 /* tcp_output.c */
 414
 415 extern void __tcp_push_pending_frames(struct sock *sk, struct tcp_sock *tp,
 416                                       unsigned int cur_mss, int nonagle);
 417 extern int tcp_may_send_now(struct sock *sk, struct tcp_sock *tp);
 418 extern int tcp_retransmit_skb(struct sock *, struct sk_buff *);
 419 extern void tcp_xmit_retransmit_queue(struct sock *);
 420 extern void tcp_simple_retransmit(struct sock *);
 421 extern int tcp_trim_head(struct sock *, struct sk_buff *, u32);
 422 extern int tcp_fragment(struct sock *, struct sk_buff *, u32, unsigned int);
 423
 424 extern void tcp_send_probe0(struct sock *);
 425 extern void tcp_send_partial(struct sock *);
 426 extern int  tcp_write_wakeup(struct sock *);
 427 extern void tcp_send_fin(struct sock *sk);
 428 extern void tcp_send_active_reset(struct sock *sk, gfp_t priority);
 429 extern int  tcp_send_synack(struct sock *);
 430 extern void tcp_push_one(struct sock *, unsigned int mss_now);
 431 extern void tcp_send_ack(struct sock *sk);
 432 extern void tcp_send_delayed_ack(struct sock *sk);
 433
 434 /* tcp_input.c */
 435 extern void tcp_cwnd_application_limited(struct sock *sk);
 436
 437 /* tcp_timer.c */
 438 extern void tcp_init_xmit_timers(struct sock *);
 439 static inline void tcp_clear_xmit_timers(struct sock *sk)
 440 {
 441         inet_csk_clear_xmit_timers(sk);
 442 }
 443
 444 extern unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
 445 extern unsigned int tcp_current_mss(struct sock *sk, int large);
 446
 447 /* tcp.c */
 448 extern void tcp_get_info(struct sock *, struct tcp_info *);
 449
 450 /* Read 'sendfile()'-style from a TCP socket */
 451 typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
 452                                 unsigned int, size_t);
 453 extern int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
 454                          sk_read_actor_t recv_actor);
 455
 456 extern void tcp_initialize_rcv_mss(struct sock *sk);
 457
 458 extern int tcp_mtu_to_mss(struct sock *sk, int pmtu);
 459 extern int tcp_mss_to_mtu(struct sock *sk, int mss);
 460 extern void tcp_mtup_init(struct sock *sk);
 461
 462 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
 463 {
 464         tp->pred_flags = htonl((tp->tcp_header_len << 26) |
 465                                ntohl(TCP_FLAG_ACK) |
 466                                snd_wnd);
 467 }
 468
 469 static inline void tcp_fast_path_on(struct tcp_sock *tp)
 470 {
 471         __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
 472 }
 473
 474 static inline void tcp_fast_path_check(struct sock *sk, struct tcp_sock *tp)
 475 {
 476         if (skb_queue_empty(&tp->out_of_order_queue) &&
 477             tp->rcv_wnd &&
 478             atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
 479             !tp->urg_data)
 480                 tcp_fast_path_on(tp);
 481 }
 482
 483 /* Compute the actual receive window we are currently advertising.
 484  * Rcv_nxt can be after the window if our peer push more data
 485  * than the offered window.
 486  */
 487 static inline u32 tcp_receive_window(const struct tcp_sock *tp)
 488 {
 489         s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
 490
 491         if (win < 0)
 492                 win = 0;
 493         return (u32) win;
 494 }
 495
 496 /* Choose a new window, without checks for shrinking, and without
 497  * scaling applied to the result.  The caller does these things
 498  * if necessary.  This is a "raw" window selection.
 499  */
 500 extern u32      __tcp_select_window(struct sock *sk);
 501
 502 /* TCP timestamps are only 32-bits, this causes a slight
 503  * complication on 64-bit systems since we store a snapshot
 504  * of jiffies in the buffer control blocks below.  We decided
 505  * to use only the low 32-bits of jiffies and hide the ugly
 506  * casts with the following macro.
 507  */
 508 #define tcp_time_stamp          ((__u32)(jiffies))
 509
 510 /* This is what the send packet queuing engine uses to pass
 511  * TCP per-packet control information to the transmission
 512  * code.  We also store the host-order sequence numbers in
 513  * here too.  This is 36 bytes on 32-bit architectures,
 514  * 40 bytes on 64-bit machines, if this grows please adjust
 515  * skbuff.h:skbuff->cb[xxx] size appropriately.
 516  */
 517 struct tcp_skb_cb {
 518         union {
 519                 struct inet_skb_parm    h4;
 520 #if defined(CONFIG_IPV6) || defined (CONFIG_IPV6_MODULE)
 521                 struct inet6_skb_parm   h6;
 522 #endif
 523         } header;       /* For incoming frames          */
 524         __u32           seq;            /* Starting sequence number     */
 525         __u32           end_seq;        /* SEQ + FIN + SYN + datalen    */
 526         __u32           when;           /* used to compute rtt's        */
 527         __u8            flags;          /* TCP header flags.            */
 528
 529         /* NOTE: These must match up to the flags byte in a
 530          *       real TCP header.
 531          */
 532 #define TCPCB_FLAG_FIN          0x01
 533 #define TCPCB_FLAG_SYN          0x02
 534 #define TCPCB_FLAG_RST          0x04
 535 #define TCPCB_FLAG_PSH          0x08
 536 #define TCPCB_FLAG_ACK          0x10
 537 #define TCPCB_FLAG_URG          0x20
 538 #define TCPCB_FLAG_ECE          0x40
 539 #define TCPCB_FLAG_CWR          0x80
 540
 541         __u8            sacked;         /* State flags for SACK/FACK.   */
 542 #define TCPCB_SACKED_ACKED      0x01    /* SKB ACK'd by a SACK block    */
 543 #define TCPCB_SACKED_RETRANS    0x02    /* SKB retransmitted            */
 544 #define TCPCB_LOST              0x04    /* SKB is lost                  */
 545 #define TCPCB_TAGBITS           0x07    /* All tag bits                 */
 546
 547 #define TCPCB_EVER_RETRANS      0x80    /* Ever retransmitted frame     */
 548 #define TCPCB_RETRANS           (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS)
 549
 550 #define TCPCB_URG               0x20    /* Urgent pointer advanced here */
 551
 552 #define TCPCB_AT_TAIL           (TCPCB_URG)
 553
 554         __u16           urg_ptr;        /* Valid w/URG flags is set.    */
 555         __u32           ack_seq;        /* Sequence number ACK'd        */
 556 };
 557
 558 #define TCP_SKB_CB(__skb)       ((struct tcp_skb_cb *)&((__skb)->cb[0]))
 559
 560 #include <net/tcp_ecn.h>
 561
 562 /* Due to TSO, an SKB can be composed of multiple actual
 563  * packets.  To keep these tracked properly, we use this.
 564  */
 565 static inline int tcp_skb_pcount(const struct sk_buff *skb)
 566 {
 567         return skb_shinfo(skb)->tso_segs;
 568 }
 569
 570 /* This is valid iff tcp_skb_pcount() > 1. */
 571 static inline int tcp_skb_mss(const struct sk_buff *skb)
 572 {
 573         return skb_shinfo(skb)->tso_size;
 574 }
 575
 576 static inline void tcp_dec_pcount_approx(__u32 *count,
 577                                          const struct sk_buff *skb)
 578 {
 579         if (*count) {
 580                 *count -= tcp_skb_pcount(skb);
 581                 if ((int)*count < 0)
 582                         *count = 0;
 583         }
 584 }
 585
 586 static inline void tcp_packets_out_inc(struct sock *sk,
 587                                        struct tcp_sock *tp,
 588                                        const struct sk_buff *skb)
 589 {
 590         int orig = tp->packets_out;
 591
 592         tp->packets_out += tcp_skb_pcount(skb);
 593         if (!orig)
 594                 inet_csk_reset_xmit_timer(sk, ICSK_TIME_RETRANS,
 595                                           inet_csk(sk)->icsk_rto, TCP_RTO_MAX);
 596 }
 597
 598 static inline void tcp_packets_out_dec(struct tcp_sock *tp,
 599                                        const struct sk_buff *skb)
 600 {
 601         tp->packets_out -= tcp_skb_pcount(skb);
 602 }
 603
 604 /* Events passed to congestion control interface */
 605 enum tcp_ca_event {
 606         CA_EVENT_TX_START,      /* first transmit when no packets in flight */
 607         CA_EVENT_CWND_RESTART,  /* congestion window restart */
 608         CA_EVENT_COMPLETE_CWR,  /* end of congestion recovery */
 609         CA_EVENT_FRTO,          /* fast recovery timeout */
 610         CA_EVENT_LOSS,          /* loss timeout */
 611         CA_EVENT_FAST_ACK,      /* in sequence ack */
 612         CA_EVENT_SLOW_ACK,      /* other ack */
 613 };
 614
 615 /*
 616  * Interface for adding new TCP congestion control handlers
 617  */
 618 #define TCP_CA_NAME_MAX 16
 619 struct tcp_congestion_ops {
 620         struct list_head        list;
 621
 622         /* initialize private data (optional) */
 623         void (*init)(struct sock *sk);
 624         /* cleanup private data  (optional) */
 625         void (*release)(struct sock *sk);
 626
 627         /* return slow start threshold (required) */
 628         u32 (*ssthresh)(struct sock *sk);
 629         /* lower bound for congestion window (optional) */
 630         u32 (*min_cwnd)(struct sock *sk);
 631         /* do new cwnd calculation (required) */
 632         void (*cong_avoid)(struct sock *sk, u32 ack,
 633                            u32 rtt, u32 in_flight, int good_ack);
 634         /* round trip time sample per acked packet (optional) */
 635         void (*rtt_sample)(struct sock *sk, u32 usrtt);
 636         /* call before changing ca_state (optional) */
 637         void (*set_state)(struct sock *sk, u8 new_state);
 638         /* call when cwnd event occurs (optional) */
 639         void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
 640         /* new value of cwnd after loss (optional) */
 641         u32  (*undo_cwnd)(struct sock *sk);
 642         /* hook for packet ack accounting (optional) */
 643         void (*pkts_acked)(struct sock *sk, u32 num_acked);
 644         /* get info for inet_diag (optional) */
 645         void (*get_info)(struct sock *sk, u32 ext, struct sk_buff *skb);
 646
 647         char            name[TCP_CA_NAME_MAX];
 648         struct module   *owner;
 649 };
 650
 651 extern int tcp_register_congestion_control(struct tcp_congestion_ops *type);
 652 extern void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
 653
 654 extern void tcp_init_congestion_control(struct sock *sk);
 655 extern void tcp_cleanup_congestion_control(struct sock *sk);
 656 extern int tcp_set_default_congestion_control(const char *name);
 657 extern void tcp_get_default_congestion_control(char *name);
 658 extern int tcp_set_congestion_control(struct sock *sk, const char *name);
 659 extern void tcp_slow_start(struct tcp_sock *tp);
 660
 661 extern struct tcp_congestion_ops tcp_init_congestion_ops;
 662 extern u32 tcp_reno_ssthresh(struct sock *sk);
 663 extern void tcp_reno_cong_avoid(struct sock *sk, u32 ack,
 664                                 u32 rtt, u32 in_flight, int flag);
 665 extern u32 tcp_reno_min_cwnd(struct sock *sk);
 666 extern struct tcp_congestion_ops tcp_reno;
 667
 668 static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
 669 {
 670         struct inet_connection_sock *icsk = inet_csk(sk);
 671
 672         if (icsk->icsk_ca_ops->set_state)
 673                 icsk->icsk_ca_ops->set_state(sk, ca_state);
 674         icsk->icsk_ca_state = ca_state;
 675 }
 676
 677 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
 678 {
 679         const struct inet_connection_sock *icsk = inet_csk(sk);
 680
 681         if (icsk->icsk_ca_ops->cwnd_event)
 682                 icsk->icsk_ca_ops->cwnd_event(sk, event);
 683 }
 684
 685 /* This determines how many packets are "in the network" to the best
 686  * of our knowledge.  In many cases it is conservative, but where
 687  * detailed information is available from the receiver (via SACK
 688  * blocks etc.) we can make more aggressive calculations.
 689  *
 690  * Use this for decisions involving congestion control, use just
 691  * tp->packets_out to determine if the send queue is empty or not.
 692  *
 693  * Read this equation as:
 694  *
 695  *      "Packets sent once on transmission queue" MINUS
 696  *      "Packets left network, but not honestly ACKed yet" PLUS
 697  *      "Packets fast retransmitted"
 698  */
 699 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
 700 {
 701         return (tp->packets_out - tp->left_out + tp->retrans_out);
 702 }
 703
 704 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
 705  * The exception is rate halving phase, when cwnd is decreasing towards
 706  * ssthresh.
 707  */
 708 static inline __u32 tcp_current_ssthresh(const struct sock *sk)
 709 {
 710         const struct tcp_sock *tp = tcp_sk(sk);
 711         if ((1 << inet_csk(sk)->icsk_ca_state) & (TCPF_CA_CWR | TCPF_CA_Recovery))
 712                 return tp->snd_ssthresh;
 713         else
 714                 return max(tp->snd_ssthresh,
 715                            ((tp->snd_cwnd >> 1) +
 716                             (tp->snd_cwnd >> 2)));
 717 }
 718
 719 static inline void tcp_sync_left_out(struct tcp_sock *tp)
 720 {
 721         if (tp->rx_opt.sack_ok &&
 722             (tp->sacked_out >= tp->packets_out - tp->lost_out))
 723                 tp->sacked_out = tp->packets_out - tp->lost_out;
 724         tp->left_out = tp->sacked_out + tp->lost_out;
 725 }
 726
 727 extern void tcp_enter_cwr(struct sock *sk);
 728 extern __u32 tcp_init_cwnd(struct tcp_sock *tp, struct dst_entry *dst);
 729
 730 /* Slow start with delack produces 3 packets of burst, so that
 731  * it is safe "de facto".
 732  */
 733 static __inline__ __u32 tcp_max_burst(const struct tcp_sock *tp)
 734 {
 735         return 3;
 736 }
 737
 738 /* RFC2861 Check whether we are limited by application or congestion window
 739  * This is the inverse of cwnd check in tcp_tso_should_defer
 740  */
 741 static inline int tcp_is_cwnd_limited(const struct sock *sk, u32 in_flight)
 742 {
 743         const struct tcp_sock *tp = tcp_sk(sk);
 744         u32 left;
 745
 746         if (in_flight >= tp->snd_cwnd)
 747                 return 1;
 748
 749         if (!(sk->sk_route_caps & NETIF_F_TSO))
 750                 return 0;
 751
 752         left = tp->snd_cwnd - in_flight;
 753         if (sysctl_tcp_tso_win_divisor)
 754                 return left * sysctl_tcp_tso_win_divisor < tp->snd_cwnd;
 755         else
 756                 return left <= tcp_max_burst(tp);
 757 }
 758
 759 static inline void tcp_minshall_update(struct tcp_sock *tp, int mss,
 760                                        const struct sk_buff *skb)
 761 {
 762         if (skb->len < mss)
 763                 tp->snd_sml = TCP_SKB_CB(skb)->end_seq;
 764 }
 765
 766 static inline void tcp_check_probe_timer(struct sock *sk, struct tcp_sock *tp)
 767 {
 768         const struct inet_connection_sock *icsk = inet_csk(sk);
 769         if (!tp->packets_out && !icsk->icsk_pending)
 770                 inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
 771                                           icsk->icsk_rto, TCP_RTO_MAX);
 772 }
 773
 774 static inline void tcp_push_pending_frames(struct sock *sk,
 775                                            struct tcp_sock *tp)
 776 {
 777         __tcp_push_pending_frames(sk, tp, tcp_current_mss(sk, 1), tp->nonagle);
 778 }
 779
 780 static inline void tcp_init_wl(struct tcp_sock *tp, u32 ack, u32 seq)
 781 {
 782         tp->snd_wl1 = seq;
 783 }
 784
 785 static inline void tcp_update_wl(struct tcp_sock *tp, u32 ack, u32 seq)
 786 {
 787         tp->snd_wl1 = seq;
 788 }
 789
 790 /*
 791  * Calculate(/check) TCP checksum
 792  */
 793 static inline u16 tcp_v4_check(struct tcphdr *th, int len,
 794                                unsigned long saddr, unsigned long daddr,
 795                                unsigned long base)
 796 {
 797         return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
 798 }
 799
 800 static inline int __tcp_checksum_complete(struct sk_buff *skb)
 801 {
 802         return __skb_checksum_complete(skb);
 803 }
 804
 805 static inline int tcp_checksum_complete(struct sk_buff *skb)
 806 {
 807         return skb->ip_summed != CHECKSUM_UNNECESSARY &&
 808                 __tcp_checksum_complete(skb);
 809 }
 810
 811 /* Prequeue for VJ style copy to user, combined with checksumming. */
 812
 813 static inline void tcp_prequeue_init(struct tcp_sock *tp)
 814 {
 815         tp->ucopy.task = NULL;
 816         tp->ucopy.len = 0;
 817         tp->ucopy.memory = 0;
 818         skb_queue_head_init(&tp->ucopy.prequeue);
 819 }
 820
 821 /* Packet is added to VJ-style prequeue for processing in process
 822  * context, if a reader task is waiting. Apparently, this exciting
 823  * idea (VJ's mail "Re: query about TCP header on tcp-ip" of 07 Sep 93)
 824  * failed somewhere. Latency? Burstiness? Well, at least now we will
 825  * see, why it failed. 8)8)                               --ANK
 826  *
 827  * NOTE: is this not too big to inline?
 828  */
 829 static inline int tcp_prequeue(struct sock *sk, struct sk_buff *skb)
 830 {
 831         struct tcp_sock *tp = tcp_sk(sk);
 832
 833         if (!sysctl_tcp_low_latency && tp->ucopy.task) {
 834                 __skb_queue_tail(&tp->ucopy.prequeue, skb);
 835                 tp->ucopy.memory += skb->truesize;
 836                 if (tp->ucopy.memory > sk->sk_rcvbuf) {
 837                         struct sk_buff *skb1;
 838
 839                         BUG_ON(sock_owned_by_user(sk));
 840
 841                         while ((skb1 = __skb_dequeue(&tp->ucopy.prequeue)) != NULL) {
 842                                 sk->sk_backlog_rcv(sk, skb1);
 843                                 NET_INC_STATS_BH(LINUX_MIB_TCPPREQUEUEDROPPED);
 844                         }
 845
 846                         tp->ucopy.memory = 0;
 847                 } else if (skb_queue_len(&tp->ucopy.prequeue) == 1) {
 848                         wake_up_interruptible(sk->sk_sleep);
 849                         if (!inet_csk_ack_scheduled(sk))
 850                                 inet_csk_reset_xmit_timer(sk, ICSK_TIME_DACK,
 851                                                           (3 * TCP_RTO_MIN) / 4,
 852                                                           TCP_RTO_MAX);
 853                 }
 854                 return 1;
 855         }
 856         return 0;
 857 }
 858
 859
 860 #undef STATE_TRACE
 861
 862 #ifdef STATE_TRACE
 863 static const char *statename[]={
 864         "Unused","Established","Syn Sent","Syn Recv",
 865         "Fin Wait 1","Fin Wait 2","Time Wait", "Close",
 866         "Close Wait","Last ACK","Listen","Closing"
 867 };
 868 #endif
 869
 870 static inline void tcp_set_state(struct sock *sk, int state)
 871 {
 872         int oldstate = sk->sk_state;
 873
 874         switch (state) {
 875         case TCP_ESTABLISHED:
 876                 if (oldstate != TCP_ESTABLISHED)
 877                         TCP_INC_STATS(TCP_MIB_CURRESTAB);
 878                 break;
 879
 880         case TCP_CLOSE:
 881                 if (oldstate == TCP_CLOSE_WAIT || oldstate == TCP_ESTABLISHED)
 882                         TCP_INC_STATS(TCP_MIB_ESTABRESETS);
 883
 884                 sk->sk_prot->unhash(sk);
 885                 if (inet_csk(sk)->icsk_bind_hash &&
 886                     !(sk->sk_userlocks & SOCK_BINDPORT_LOCK))
 887                         inet_put_port(&tcp_hashinfo, sk);
 888                 /* fall through */
 889         default:
 890                 if (oldstate==TCP_ESTABLISHED)
 891                         TCP_DEC_STATS(TCP_MIB_CURRESTAB);
 892         }
 893
 894         /* Change state AFTER socket is unhashed to avoid closed
 895          * socket sitting in hash tables.
 896          */
 897         sk->sk_state = state;
 898
 899 #ifdef STATE_TRACE
 900         SOCK_DEBUG(sk, "TCP sk=%p, State %s -> %s\n",sk, statename[oldstate],statename[state]);
 901 #endif
 902 }
 903
 904 static inline void tcp_done(struct sock *sk)
 905 {
 906         tcp_set_state(sk, TCP_CLOSE);
 907         tcp_clear_xmit_timers(sk);
 908
 909         sk->sk_shutdown = SHUTDOWN_MASK;
 910
 911         if (!sock_flag(sk, SOCK_DEAD))
 912                 sk->sk_state_change(sk);
 913         else
 914                 inet_csk_destroy_sock(sk);
 915 }
 916
 917 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
 918 {
 919         rx_opt->dsack = 0;
 920         rx_opt->eff_sacks = 0;
 921         rx_opt->num_sacks = 0;
 922 }
 923
 924 /* Determine a window scaling and initial window to offer. */
 925 extern void tcp_select_initial_window(int __space, __u32 mss,
 926                                       __u32 *rcv_wnd, __u32 *window_clamp,
 927                                       int wscale_ok, __u8 *rcv_wscale);
 928
 929 static inline int tcp_win_from_space(int space)
 930 {
 931         return sysctl_tcp_adv_win_scale<=0 ?
 932                 (space>>(-sysctl_tcp_adv_win_scale)) :
 933                 space - (space>>sysctl_tcp_adv_win_scale);
 934 }
 935
 936 /* Note: caller must be prepared to deal with negative returns */
 937 static inline int tcp_space(const struct sock *sk)
 938 {
 939         return tcp_win_from_space(sk->sk_rcvbuf -
 940                                   atomic_read(&sk->sk_rmem_alloc));
 941 }
 942
 943 static inline int tcp_full_space(const struct sock *sk)
 944 {
 945         return tcp_win_from_space(sk->sk_rcvbuf);
 946 }
 947
 948 static inline void tcp_openreq_init(struct request_sock *req,
 949                                     struct tcp_options_received *rx_opt,
 950                                     struct sk_buff *skb)
 951 {
 952         struct inet_request_sock *ireq = inet_rsk(req);
 953
 954         req->rcv_wnd = 0;               /* So that tcp_send_synack() knows! */
 955         tcp_rsk(req)->rcv_isn = TCP_SKB_CB(skb)->seq;
 956         req->mss = rx_opt->mss_clamp;
 957         req->ts_recent = rx_opt->saw_tstamp ? rx_opt->rcv_tsval : 0;
 958         ireq->tstamp_ok = rx_opt->tstamp_ok;
 959         ireq->sack_ok = rx_opt->sack_ok;
 960         ireq->snd_wscale = rx_opt->snd_wscale;
 961         ireq->wscale_ok = rx_opt->wscale_ok;
 962         ireq->acked = 0;
 963         ireq->ecn_ok = 0;
 964         ireq->rmt_port = skb->h.th->source;
 965 }
 966
 967 extern void tcp_enter_memory_pressure(void);
 968
 969 static inline int keepalive_intvl_when(const struct tcp_sock *tp)
 970 {
 971         return tp->keepalive_intvl ? : sysctl_tcp_keepalive_intvl;
 972 }
 973
 974 static inline int keepalive_time_when(const struct tcp_sock *tp)
 975 {
 976         return tp->keepalive_time ? : sysctl_tcp_keepalive_time;
 977 }
 978
 979 static inline int tcp_fin_time(const struct sock *sk)
 980 {
 981         int fin_timeout = tcp_sk(sk)->linger2 ? : sysctl_tcp_fin_timeout;
 982         const int rto = inet_csk(sk)->icsk_rto;
 983
 984         if (fin_timeout < (rto << 2) - (rto >> 1))
 985                 fin_timeout = (rto << 2) - (rto >> 1);
 986
 987         return fin_timeout;
 988 }
 989
 990 static inline int tcp_paws_check(const struct tcp_options_received *rx_opt, int rst)
 991 {
 992         if ((s32)(rx_opt->rcv_tsval - rx_opt->ts_recent) >= 0)
 993                 return 0;
 994         if (xtime.tv_sec >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS)
 995                 return 0;
 996
 997         /* RST segments are not recommended to carry timestamp,
 998            and, if they do, it is recommended to ignore PAWS because
 999            "their cleanup function should take precedence over timestamps."
1000            Certainly, it is mistake. It is necessary to understand the reasons
1001            of this constraint to relax it: if peer reboots, clock may go
1002            out-of-sync and half-open connections will not be reset.
1003            Actually, the problem would be not existing if all
1004            the implementations followed draft about maintaining clock
1005            via reboots. Linux-2.2 DOES NOT!
1006
1007            However, we can relax time bounds for RST segments to MSL.
1008          */
1009         if (rst && xtime.tv_sec >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
1010                 return 0;
1011         return 1;
1012 }
1013
1014 #define TCP_CHECK_TIMER(sk) do { } while (0)
1015
1016 static inline int tcp_use_frto(const struct sock *sk)
1017 {
1018         const struct tcp_sock *tp = tcp_sk(sk);
1019
1020         /* F-RTO must be activated in sysctl and there must be some
1021          * unsent new data, and the advertised window should allow
1022          * sending it.
1023          */
1024         return (sysctl_tcp_frto && sk->sk_send_head &&
1025                 !after(TCP_SKB_CB(sk->sk_send_head)->end_seq,
1026                        tp->snd_una + tp->snd_wnd));
1027 }
1028
1029 static inline void tcp_mib_init(void)
1030 {
1031         /* See RFC 2012 */
1032         TCP_ADD_STATS_USER(TCP_MIB_RTOALGORITHM, 1);
1033         TCP_ADD_STATS_USER(TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1034         TCP_ADD_STATS_USER(TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1035         TCP_ADD_STATS_USER(TCP_MIB_MAXCONN, -1);
1036 }
1037
1038 /*from STCP */
1039 static inline void clear_all_retrans_hints(struct tcp_sock *tp){
1040         tp->lost_skb_hint = NULL;
1041         tp->scoreboard_skb_hint = NULL;
1042         tp->retransmit_skb_hint = NULL;
1043         tp->forward_skb_hint = NULL;
1044         tp->fastpath_skb_hint = NULL;
1045 }
1046
1047 /* /proc */
1048 enum tcp_seq_states {
1049         TCP_SEQ_STATE_LISTENING,
1050         TCP_SEQ_STATE_OPENREQ,
1051         TCP_SEQ_STATE_ESTABLISHED,
1052         TCP_SEQ_STATE_TIME_WAIT,
1053 };
1054
1055 struct tcp_seq_afinfo {
1056         struct module           *owner;
1057         char                    *name;
1058         sa_family_t             family;
1059         int                     (*seq_show) (struct seq_file *m, void *v);
1060         struct file_operations  *seq_fops;
1061 };
1062
1063 struct tcp_iter_state {
1064         sa_family_t             family;
1065         enum tcp_seq_states     state;
1066         struct sock             *syn_wait_sk;
1067         int                     bucket, sbucket, num, uid;
1068         struct seq_operations   seq_ops;
1069 };
1070
1071 extern int tcp_proc_register(struct tcp_seq_afinfo *afinfo);
1072 extern void tcp_proc_unregister(struct tcp_seq_afinfo *afinfo);
1073
1074 extern struct request_sock_ops tcp_request_sock_ops;
1075
1076 extern int tcp_v4_destroy_sock(struct sock *sk);
1077
1078 #ifdef CONFIG_PROC_FS
1079 extern int  tcp4_proc_init(void);
1080 extern void tcp4_proc_exit(void);
1081 #endif
1082
1083 extern void tcp_v4_init(struct net_proto_family *ops);
1084 extern void tcp_init(void);
1085
1086 #endif  /* _TCP_H */