include/net/tcp.h

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