sys/netinet/tcp_var.h

   1 /*
   2  * Copyright (c) 2003, 2004 Jeffrey M. Hsu.  All rights reserved.
   3  * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to The DragonFly Project
   6  * by Jeffrey M. Hsu.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of The DragonFly Project nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific, prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Copyright (c) 1982, 1986, 1993, 1994, 1995
  36  *      The Regents of the University of California.  All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      @(#)tcp_var.h   8.4 (Berkeley) 5/24/95
  67  * $FreeBSD: src/sys/netinet/tcp_var.h,v 1.56.2.13 2003/02/03 02:34:07 hsu Exp $
  68  */
  69
  70 #ifndef _NETINET_TCP_VAR_H_
  71 #define _NETINET_TCP_VAR_H_
  72
  73 #ifndef _NETINET_IN_PCB_H_
  74 #include <netinet/in_pcb.h>             /* needed for in_conninfo, inp_gen_t */
  75 #endif
  76 #ifndef _NETINET_TCP_H_
  77 #include <netinet/tcp.h>
  78 #endif
  79
  80 /*
  81  * Kernel variables for tcp.
  82  */
  83 extern int tcp_do_rfc1323;
  84 extern int tcp_low_rtobase;
  85 extern int tcp_do_sack;
  86 extern int tcp_do_smartsack;
  87 extern int tcp_do_rescuesack;
  88 extern int tcp_aggressive_rescuesack;
  89 extern int tcp_do_rfc6675;
  90 extern int tcp_rfc6675_rxt;
  91 extern int tcp_aggregate_acks;
  92 extern int tcp_eifel_rtoinc;
  93
  94 /* TCP segment queue entry */
  95 struct tseg_qent {
  96         TAILQ_ENTRY(tseg_qent) tqe_q;
  97         int     tqe_len;                /* TCP segment data length */
  98         struct  tcphdr *tqe_th;         /* a pointer to tcp header */
  99         struct  mbuf    *tqe_m;         /* mbuf contains packet */
 100 };
 101 TAILQ_HEAD(tsegqe_head, tseg_qent);
 102 extern int      tcp_reass_maxseg;
 103 extern int      tcp_reass_qsize;
 104 #ifdef MALLOC_DECLARE
 105 MALLOC_DECLARE(M_TSEGQ);
 106 #endif
 107
 108 struct tcptemp {
 109         u_char  tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
 110         struct  tcphdr tt_t;
 111 };
 112
 113 #define tcp6cb          tcpcb  /* for KAME src sync over BSD*'s */
 114
 115 struct raw_sackblock {                          /* covers [start, end) */
 116         tcp_seq rblk_start;
 117         tcp_seq rblk_end;
 118 };
 119
 120 /* maximum number of SACK blocks that will fit in the TCP option space */
 121 #define MAX_SACK_REPORT_BLOCKS  4
 122
 123 TAILQ_HEAD(sackblock_list, sackblock);
 124
 125 struct scoreboard {
 126         int nblocks;
 127         struct sackblock_list sackblocks;
 128         tcp_seq lostseq;                        /* passed SACK lost test */
 129         struct sackblock *lastfound;            /* search hint */
 130         struct sackblock *freecache;            /* one slot free block cache */
 131 };
 132
 133 struct netmsg_tcp_timer;
 134 struct netmsg_base;
 135
 136 /*
 137  * Tcp control block, one per tcp; fields:
 138  * Organized for 16 byte cacheline efficiency.
 139  */
 140 struct tcpcb {
 141         struct  tsegqe_head t_segq;
 142         int     t_dupacks;              /* consecutive dup acks recd */
 143         int     t_rxtthresh;            /* # dup acks to start fast rxt */
 144         int     tt_cpu;                 /* sanity check the cpu */
 145
 146         struct  tcp_callout *tt_rexmt;  /* retransmit timer */
 147         struct  tcp_callout *tt_persist;/* retransmit persistence */
 148         struct  tcp_callout *tt_keep;   /* keepalive */
 149         struct  tcp_callout *tt_2msl;   /* 2*msl TIME_WAIT timer */
 150         struct  tcp_callout *tt_delack; /* delayed ACK timer */
 151         struct  netmsg_tcp_timer *tt_msg; /* timer message */
 152
 153         struct  netmsg_base *tt_sndmore;/* send more segments (fairsend) */
 154
 155         struct  inpcb *t_inpcb;         /* back pointer to internet pcb */
 156         int     t_state;                /* state of this connection */
 157         u_int   t_flags;
 158 #define TF_ACKNOW       0x00000001      /* ack peer immediately */
 159 #define TF_DELACK       0x00000002      /* ack, but try to delay it */
 160 #define TF_NODELAY      0x00000004      /* don't delay packets to coalesce */
 161 #define TF_NOOPT        0x00000008      /* don't use tcp options */
 162 #define TF_SENTFIN      0x00000010      /* have sent FIN */
 163 #define TF_REQ_SCALE    0x00000020      /* have/will request window scaling */
 164 #define TF_RCVD_SCALE   0x00000040      /* other side has requested scaling */
 165 #define TF_REQ_TSTMP    0x00000080      /* have/will request timestamps */
 166 #define TF_RCVD_TSTMP   0x00000100      /* a timestamp was received in SYN */
 167 #define TF_SACK_PERMITTED 0x00000200    /* other side said I could SACK */
 168 #define TF_NEEDSYN      0x00000400      /* send SYN (implicit state) */
 169 #define TF_NEEDFIN      0x00000800      /* send FIN (implicit state) */
 170 #define TF_NOPUSH       0x00001000      /* don't push */
 171 #define TF_LISTEN       0x00002000      /* listen(2) has been called */
 172 #define TF_SIGNATURE    0x00004000      /* require MD5 digests (RFC2385) */
 173 #define TF_NCR          0x00008000      /* Non-Congestion Robustness RFC4653 */
 174 #define TF_MORETOCOME   0x00010000      /* More data to be appended to sock */
 175 #define TF_SAWFIN       0x00020000      /* FIN has been seen */
 176 #define TF_LASTIDLE     0x00040000      /* connection was previously idle */
 177 #define TF_RXWIN0SENT   0x00080000      /* sent a receiver win 0 in response */
 178 #define TF_FASTRECOVERY 0x00100000      /* in Fast Recovery */
 179 #define TF_QUEDFIN      0x00200000      /* FIN has been received */
 180 #define TF_XMITNOW      0x00400000      /* Temporarily override Nagle */
 181 #define TF_UNUSED008    0x00800000
 182 #define TF_UNUSED009    0x01000000
 183 #define TF_FORCE        0x02000000      /* Set if forcing out a byte */
 184 #define TF_ONOUTPUTQ    0x04000000      /* on t_outputq list */
 185 #define TF_FAIRSEND     0x08000000      /* fairsend is requested */
 186 #define TF_UNUSED003    0x10000000
 187 #define TF_UNUSED004    0x20000000
 188 #define TF_KEEPALIVE    0x40000000      /* temporary keepalive */
 189 #define TF_RXRESIZED    0x80000000      /* rcvbuf was resized */
 190         tcp_seq snd_up;                 /* send urgent pointer */
 191         u_long  snd_last;               /* time last data were sent */
 192
 193         tcp_seq snd_una;                /* send unacknowledged */
 194         tcp_seq snd_recover;            /* for use with Fast Recovery */
 195         tcp_seq snd_max;                /* highest sequence number sent;
 196                                          * used to recognize retransmits */
 197         tcp_seq snd_nxt;                /* send next */
 198
 199         tcp_seq snd_wl1;                /* window update seg seq number */
 200         tcp_seq snd_wl2;                /* window update seg ack number */
 201         tcp_seq iss;                    /* initial send sequence number */
 202         tcp_seq irs;                    /* initial receive sequence number */
 203
 204         tcp_seq rcv_nxt;                /* receive next */
 205         tcp_seq rcv_adv;                /* advertised window */
 206         u_long  rcv_wnd;                /* receive window */
 207         tcp_seq rcv_up;                 /* receive urgent pointer */
 208
 209         u_long  snd_wnd;                /* send window */
 210         u_long  snd_cwnd;               /* congestion-controlled window */
 211         u_long  snd_wacked;             /* bytes acked in one send window */
 212         u_long  snd_ssthresh;           /* snd_cwnd size threshold for
 213                                          * for slow start exponential to
 214                                          * linear switch */
 215
 216         int     t_rxtcur;               /* current retransmit value (ticks) */
 217         u_int   t_maxseg;               /* maximum segment size */
 218         int     t_srtt;                 /* smoothed round-trip time */
 219         int     t_rttvar;               /* variance in round-trip time */
 220
 221         u_int   t_maxopd;               /* mss plus options */
 222
 223         u_long  t_rcvtime;              /* reception inactivity time */
 224         u_long  t_starttime;            /* time connection was established */
 225         int     t_rtttime;              /* round trip time */
 226         tcp_seq t_rtseq;                /* sequence number being timed */
 227
 228         int     t_rxtshift;             /* log(2) of rexmt exp. backoff */
 229         u_int   t_rttmin;               /* minimum rtt allowed */
 230         u_int   t_rttbest;              /* best rtt we've seen */
 231         u_long  t_rttupdated;           /* number of times rtt sampled */
 232         u_long  max_sndwnd;             /* largest window peer has offered */
 233
 234         int     t_softerror;            /* possible error not yet reported */
 235 /* out-of-band data */
 236         char    t_oobflags;             /* have some */
 237         char    t_iobc;                 /* input character */
 238 #define TCPOOB_HAVEDATA 0x01
 239 #define TCPOOB_HADDATA  0x02
 240
 241 /* RFC 1323 variables */
 242         u_char  snd_scale;              /* window scaling for send window */
 243         u_char  rcv_scale;              /* window scaling for recv window */
 244         u_char  request_r_scale;        /* pending window scaling */
 245         u_long  ts_recent;              /* timestamp echo data */
 246
 247         u_long  ts_recent_age;          /* when last updated */
 248         tcp_seq last_ack_sent;
 249
 250 /* experimental */
 251         u_int   rxt_flags;
 252 #define TRXT_F_REBASERTO        0x0001  /* Recalculate RTO based on new RTT */
 253 #define TRXT_F_WASFRECOVERY     0x0002  /* was in Fast Recovery */
 254 #define TRXT_F_FIRSTACCACK      0x0004  /* Look for 1st acceptable ACK. */
 255 #define TRXT_F_FASTREXMT        0x0008  /* Did Fast Retransmit. */
 256 #define TRXT_F_EARLYREXMT       0x0010  /* Did Early (Fast) Retransmit. */
 257         int     t_srtt_prev;            /* adjusted SRTT prior to retransmit */
 258         int     t_rttvar_prev;          /* RTTVAR prior to retransmit */
 259         int     t_rxtcur_prev;          /* rexmt timeout prior to retransmit */
 260         tcp_seq snd_max_prev;           /* SND_MAX prior to retransmit */
 261         u_long  snd_cwnd_prev;          /* cwnd prior to retransmit */
 262         u_long  snd_wacked_prev;        /* prior bytes acked in send window */
 263         u_long  snd_ssthresh_prev;      /* ssthresh prior to retransmit */
 264         tcp_seq snd_recover_prev;       /* snd_recover prior to retransmit */
 265         u_long  t_badrxtwin;            /* window for retransmit recovery */
 266         u_long  t_rexmtTS;              /* timestamp of last retransmit */
 267         u_char  snd_limited;            /* segments limited transmitted */
 268
 269         u_int   sack_flags;
 270 #define TSACK_F_SACKRESCUED     0x0001  /* sent rescue SACK recovery data */
 271 #define TSACK_F_DUPSEG          0x0002  /* last seg a duplicate */
 272 #define TSACK_F_ENCLOSESEG      0x0004  /* enclosing SACK block */
 273 #define TSACK_F_SACKLEFT        0x0008  /* send SACK blocks from left side */
 274         tcp_seq rexmt_high;             /* highest seq # retransmitted + 1 */
 275         tcp_seq rexmt_rescue;           /* rescue SACKED sequence number */
 276         tcp_seq snd_max_rexmt;          /* snd_max when rexmting snd_una */
 277         struct scoreboard scb;          /* sack scoreboard */
 278         struct raw_sackblock reportblk; /* incoming segment or D-SACK block */
 279         struct raw_sackblock encloseblk;
 280         int     nsackhistory;
 281         struct raw_sackblock sackhistory[MAX_SACK_REPORT_BLOCKS]; /* reported */
 282
 283         TAILQ_ENTRY(tcpcb) t_outputq;   /* tcp_output needed list */
 284
 285         /* bandwith limitation */
 286         u_long  snd_bandwidth;          /* calculated bandwidth or 0 */
 287         u_long  snd_bwnd;               /* bandwidth-controlled window */
 288         int     t_bw_rtttime;           /* used for bandwidth calculation */
 289         tcp_seq t_bw_rtseq;             /* used for bandwidth calculation */
 290
 291 /* anti DoS counters */
 292         u_long  rcv_second;             /* start of interval second */
 293         u_long  rcv_pps;                /* received packets per second */
 294         u_long  rcv_byps;               /* received bytes per second */
 295
 296         u_int32_t       rfbuf_ts;       /* recv buffer autoscaling timestamp */
 297         int     rfbuf_cnt;              /* recv buffer autoscaling byte count */
 298
 299         int     t_keepinit;             /* time to establish connection */
 300
 301         int     t_keepidle;             /* time before keepalive probes begin */
 302         int     t_keepintvl;            /* time between keepalive probes */
 303         int     t_keepcnt;              /* maximum number of keepalive probes */
 304         int     t_maxidle;              /* time to drop after starting probes */
 305
 306         int     t_rxtsyn;               /* time spent in SYN or SYN|ACK rexmt */
 307 };
 308
 309 #define IN_FASTRECOVERY(tp)     (tp->t_flags & TF_FASTRECOVERY)
 310 #define ENTER_FASTRECOVERY(tp)  tp->t_flags |= TF_FASTRECOVERY
 311 #define EXIT_FASTRECOVERY(tp)   tp->t_flags &= ~TF_FASTRECOVERY
 312
 313 #ifdef TCP_SIGNATURE
 314 /*
 315  * Defines which are needed by the xform_tcp module and tcp_[in|out]put
 316  * for SADB verification and lookup.
 317  */
 318 #define TCP_SIGLEN      16      /* length of computed digest in bytes */
 319 #define TCP_KEYLEN_MIN  1       /* minimum length of TCP-MD5 key */
 320 #define TCP_KEYLEN_MAX  80      /* maximum length of TCP-MD5 key */
 321 /*
 322  * Only a single SA per host may be specified at this time. An SPI is
 323  * needed in order for the KEY_ALLOCSA() lookup to work.
 324  */
 325 #define TCP_SIG_SPI     0x1000
 326 #endif /* TCP_SIGNATURE */
 327
 328 /*
 329  * TCP statistics.
 330  */
 331 struct tcp_stats {
 332         u_long  tcps_connattempt;       /* connections initiated */
 333         u_long  tcps_accepts;           /* connections accepted */
 334         u_long  tcps_connects;          /* connections established */
 335         u_long  tcps_drops;             /* connections dropped */
 336         u_long  tcps_conndrops;         /* embryonic connections dropped */
 337         u_long  tcps_minmssdrops;       /* average minmss too low drops */
 338         u_long  tcps_closed;            /* conn. closed (includes drops) */
 339         u_long  tcps_segstimed;         /* segs where we tried to get rtt */
 340         u_long  tcps_rttupdated;        /* times we succeeded */
 341         u_long  tcps_delack;            /* delayed acks sent */
 342         u_long  tcps_timeoutdrop;       /* conn. dropped in rxmt timeout */
 343         u_long  tcps_rexmttimeo;        /* retransmit timeouts */
 344         u_long  tcps_persisttimeo;      /* persist timeouts */
 345         u_long  tcps_keeptimeo;         /* keepalive timeouts */
 346         u_long  tcps_keepprobe;         /* keepalive probes sent */
 347         u_long  tcps_keepdrops;         /* connections dropped in keepalive */
 348
 349         u_long  tcps_sndtotal;          /* total packets sent */
 350         u_long  tcps_sndpack;           /* data packets sent */
 351         u_long  tcps_sndbyte;           /* data bytes sent */
 352         u_long  tcps_sndrexmitpack;     /* data packets retransmitted */
 353         u_long  tcps_sndrexmitbyte;     /* data bytes retransmitted */
 354         u_long  tcps_sndsackrtopack;    /* packets sent by SACK after RTO */
 355         u_long  tcps_sndsackrtobyte;    /* bytes sent by SACK after RTO */
 356         u_long  tcps_sndfastrexmit;     /* Fast Retransmissions */
 357         u_long  tcps_sndearlyrexmit;    /* early Fast Retransmissions */
 358         u_long  tcps_sndlimited;        /* Limited Transmit packets */
 359         u_long  tcps_sndrtobad;         /* spurious RTO retransmissions */
 360         u_long  tcps_sndfastrexmitbad;  /* spurious Fast Retransmissions */
 361         u_long  tcps_sndearlyrexmitbad; /* spurious early Fast Retransmissions,
 362                                            a subset of tcps_sndfastrexmitbad */
 363         u_long  tcps_eifeldetected;     /* Eifel-detected spurious rexmits */
 364         u_long  tcps_rttcantdetect;     /* Eifel but not 1/2 RTT-detectable */
 365         u_long  tcps_rttdetected;       /* RTT-detected spurious RTO rexmits */
 366         u_long  tcps_sndacks;           /* ack-only packets sent */
 367         u_long  tcps_sndprobe;          /* window probes sent */
 368         u_long  tcps_sndurg;            /* packets sent with URG only */
 369         u_long  tcps_sndwinup;          /* window update-only packets sent */
 370         u_long  tcps_sndctrl;           /* control (SYN|FIN|RST) packets sent */
 371         u_long  tcps_sndsackpack;       /* packets sent by SACK recovery alg */
 372         u_long  tcps_sndsackbyte;       /* bytes sent by SACK recovery */
 373         u_long  tcps_snduna3;           /* re-retransmit snd_una on 3 new seg */
 374         u_long  tcps_snduna1;           /* re-retransmit snd_una on 1 new seg */
 375         u_long  tcps_sndsackopt;        /* SACK options sent */
 376         u_long  tcps_snddsackopt;       /* D-SACK options sent */
 377         u_long  tcps_sndidle;           /* sending idle detected */
 378         u_long  tcps_sackrescue;        /* SACK rescue data packets sent */
 379         u_long  tcps_sackrescue_try;    /* SACK rescues attempted */
 380         u_long  tcps_eifelresponse;     /* Eifel responses */
 381
 382         u_long  tcps_rcvtotal;          /* total packets received */
 383         u_long  tcps_rcvpack;           /* packets received in sequence */
 384         u_long  tcps_rcvbyte;           /* bytes received in sequence */
 385         u_long  tcps_rcvbadsum;         /* packets received with ccksum errs */
 386         u_long  tcps_rcvbadoff;         /* packets received with bad offset */
 387         u_long  tcps_rcvmemdrop;        /* packets dropped for lack of memory */
 388         u_long  tcps_rcvshort;          /* packets received too short */
 389         u_long  tcps_rcvduppack;        /* duplicate-only packets received */
 390         u_long  tcps_rcvdupbyte;        /* duplicate-only bytes received */
 391         u_long  tcps_rcvpartduppack;    /* packets with some duplicate data */
 392         u_long  tcps_rcvpartdupbyte;    /* dup. bytes in part-dup. packets */
 393         u_long  tcps_rcvoopack;         /* out-of-order packets received */
 394         u_long  tcps_rcvoobyte;         /* out-of-order bytes received */
 395         u_long  tcps_rcvpackafterwin;   /* packets with data after window */
 396         u_long  tcps_rcvbyteafterwin;   /* bytes rcvd after window */
 397         u_long  tcps_rcvafterclose;     /* packets rcvd after "close" */
 398         u_long  tcps_rcvwinprobe;       /* rcvd window probe packets */
 399         u_long  tcps_rcvdupack;         /* rcvd duplicate acks */
 400         u_long  tcps_rcvacktoomuch;     /* rcvd acks for unsent data */
 401         u_long  tcps_rcvackpack;        /* rcvd ack packets */
 402         u_long  tcps_rcvackbyte;        /* bytes acked by rcvd acks */
 403         u_long  tcps_rcvwinupd;         /* rcvd window update packets */
 404         u_long  tcps_pawsdrop;          /* segments dropped due to PAWS */
 405         u_long  tcps_pawsaccept;        /* segments accepted, PAWS tolerance */
 406         u_long  tcps_predack;           /* times hdr predict ok for acks */
 407         u_long  tcps_preddat;           /* times hdr predict ok for data pkts */
 408         u_long  tcps_pcbcachemiss;
 409         u_long  tcps_cachedrtt;         /* times cached RTT in route updated */
 410         u_long  tcps_cachedrttvar;      /* times cached rttvar updated */
 411         u_long  tcps_cachedssthresh;    /* times cached ssthresh updated */
 412         u_long  tcps_usedrtt;           /* times RTT initialized from route */
 413         u_long  tcps_usedrttvar;        /* times RTTVAR initialized from rt */
 414         u_long  tcps_usedssthresh;      /* times ssthresh initialized from rt*/
 415         u_long  tcps_persistdrop;       /* timeout in persist state */
 416         u_long  tcps_badsyn;            /* bogus SYN, e.g. premature ACK */
 417         u_long  tcps_mturesent;         /* resends due to MTU discovery */
 418         u_long  tcps_listendrop;        /* listen queue overflows */
 419         u_long  tcps_rcvbadsackopt;     /* rcvd illegal SACK options */
 420         u_long  tcps_sackrenege;        /* times other side reneged */
 421
 422         u_long  tcps_sacksbupdate;      /* times SACK scoreboard updated */
 423         u_long  tcps_sacksboverflow;    /* times SACK scoreboard overflowed */
 424         u_long  tcps_sacksbreused;      /* times SACK sb-block reused */
 425         u_long  tcps_sacksbfailed;      /* times SACK sb update failed */
 426         u_long  tcps_sacksbfast;        /* times SACK sb-block uses cache */
 427
 428         u_long  tcps_sc_added;          /* entry added to syncache */
 429         u_long  tcps_sc_retransmitted;  /* syncache entry was retransmitted */
 430         u_long  tcps_sc_dupsyn;         /* duplicate SYN packet */
 431         u_long  tcps_sc_dropped;        /* could not reply to packet */
 432         u_long  tcps_sc_completed;      /* successful extraction of entry */
 433         u_long  tcps_sc_bucketoverflow; /* syncache per-bucket limit hit */
 434         u_long  tcps_sc_cacheoverflow;  /* syncache cache limit hit */
 435         u_long  tcps_sc_reset;          /* RST removed entry from syncache */
 436         u_long  tcps_sc_stale;          /* timed out or listen socket gone */
 437         u_long  tcps_sc_aborted;        /* syncache entry aborted */
 438         u_long  tcps_sc_badack;         /* removed due to bad ACK */
 439         u_long  tcps_sc_unreach;        /* ICMP unreachable received */
 440         u_long  tcps_sc_zonefail;       /* zalloc() failed */
 441         u_long  tcps_sc_sendcookie;     /* SYN cookie sent */
 442         u_long  tcps_sc_recvcookie;     /* SYN cookie received */
 443 };
 444
 445 #ifdef _KERNEL
 446
 447 #define tcpstat tcpstats_percpu[mycpuid]
 448
 449 struct sockopt;
 450
 451 extern struct tcp_stats         tcpstats_percpu[MAXCPU];
 452
 453 static const int tcprexmtthresh = 3;
 454 #endif
 455
 456 /*
 457  * Structure to hold TCP options that are only used during segment
 458  * processing (in tcp_input), but not held in the tcpcb.
 459  * It's basically used to reduce the number of parameters
 460  * to tcp_dooptions.
 461  */
 462 struct tcpopt {
 463         u_int           to_flags;       /* which options are present */
 464 #define TOF_TS                  0x0001  /* timestamp */
 465 #define TOF_MSS                 0x0010
 466 #define TOF_SCALE               0x0020
 467 #define TOF_SACK_PERMITTED      0x0040
 468 #define TOF_SACK                0x0080
 469 #define TOF_SIGNATURE           0x0100  /* signature option present */
 470 #define TOF_SIGLEN              0x0200  /* signature length valid (RFC2385) */
 471 #define TOF_DSACK               0x0400  /* D-SACK */
 472 #define TOF_SACK_REDUNDANT      0x0800  /* all SACK blocks are known */
 473         u_int32_t       to_tsval;
 474         u_int32_t       to_tsecr;
 475         u_int16_t       to_mss;
 476         u_int8_t        to_requested_s_scale;
 477         u_int8_t        to_nsackblocks;
 478         struct raw_sackblock *to_sackblocks;
 479 };
 480
 481 struct syncache {
 482         inp_gen_t       sc_inp_gencnt;          /* pointer check */
 483         struct          tcpcb *sc_tp;           /* tcb for listening socket */
 484         struct          mbuf *sc_ipopts;        /* source route */
 485         struct          in_conninfo sc_inc;     /* addresses */
 486 #define sc_route        sc_inc.inc_route
 487 #define sc_route6       sc_inc.inc6_route
 488         u_int32_t       sc_tsrecent;
 489         tcp_seq         sc_irs;                 /* seq from peer */
 490         tcp_seq         sc_iss;                 /* our ISS */
 491         u_long          sc_rxttime;             /* retransmit time */
 492         u_int16_t       sc_rxtslot;             /* retransmit counter */
 493         u_int16_t       sc_peer_mss;            /* peer's MSS */
 494         u_int16_t       sc_wnd;                 /* advertised window */
 495         u_int8_t        sc_requested_s_scale:4,
 496                         sc_request_r_scale:4;
 497         u_int8_t        sc_flags;
 498 #define SCF_NOOPT               0x01            /* no TCP options */
 499 #define SCF_WINSCALE            0x02            /* negotiated window scaling */
 500 #define SCF_TIMESTAMP           0x04            /* negotiated timestamps */
 501 #define SCF_UNUSED              0x08            /* unused */
 502 #define SCF_UNREACH             0x10            /* icmp unreachable received */
 503 #define SCF_SACK_PERMITTED      0x20            /* saw SACK permitted option */
 504 #define SCF_SIGNATURE           0x40            /* send MD5 digests */
 505 #define SCF_MARKER              0x80            /* not a real entry */
 506         int             sc_rxtused;             /* time spent in SYN|ACK rxt */
 507         u_long          sc_sndwnd;              /* send window */
 508         TAILQ_ENTRY(syncache) sc_hash;
 509         TAILQ_ENTRY(syncache) sc_timerq;
 510 };
 511
 512 struct syncache_head {
 513         TAILQ_HEAD(, syncache)  sch_bucket;
 514         u_int           sch_length;
 515 };
 516
 517 #define intotcpcb(ip)   ((struct tcpcb *)(ip)->inp_ppcb)
 518 #define sototcpcb(so)   (intotcpcb(sotoinpcb(so)))
 519
 520 /*
 521  * The smoothed round-trip time and estimated variance
 522  * are stored as fixed point numbers scaled by the values below.
 523  * For convenience, these scales are also used in smoothing the average
 524  * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
 525  * With these scales, srtt has 3 bits to the right of the binary point,
 526  * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
 527  * binary point, and is smoothed with an ALPHA of 0.75.
 528  */
 529 #define TCP_RTT_SCALE           32      /* multiplier for srtt; 3 bits frac. */
 530 #define TCP_RTT_SHIFT           5       /* shift for srtt; 3 bits frac. */
 531 #define TCP_RTTVAR_SCALE        16      /* multiplier for rttvar; 2 bits */
 532 #define TCP_RTTVAR_SHIFT        4       /* shift for rttvar; 2 bits */
 533 #define TCP_DELTA_SHIFT         2       /* see tcp_input.c */
 534
 535 /*
 536  * The initial retransmission should happen at rtt + 4 * rttvar.
 537  * Because of the way we do the smoothing, srtt and rttvar
 538  * will each average +1/2 tick of bias.  When we compute
 539  * the retransmit timer, we want 1/2 tick of rounding and
 540  * 1 extra tick because of +-1/2 tick uncertainty in the
 541  * firing of the timer.  The bias will give us exactly the
 542  * 1.5 tick we need.  But, because the bias is
 543  * statistical, we have to test that we don't drop below
 544  * the minimum feasible timer (which is 2 ticks).
 545  * This version of the macro adapted from a paper by Lawrence
 546  * Brakmo and Larry Peterson which outlines a problem caused
 547  * by insufficient precision in the original implementation,
 548  * which results in inappropriately large RTO values for very
 549  * fast networks.
 550  */
 551 #define TCP_REXMTVAL(tp) \
 552         max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
 553           + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
 554
 555 /*
 556  * TCB structure exported to user-land via sysctl(3).
 557  * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
 558  * included.  Not all of our clients do.
 559  */
 560 #if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
 561 struct  xtcpcb {
 562         size_t  xt_len;
 563         struct  inpcb   xt_inp;
 564         struct  tcpcb   xt_tp;
 565         struct  xsocket xt_socket;
 566         u_quad_t        xt_alignment_hack;
 567 };
 568 #endif
 569
 570 /*
 571  * Names for TCP sysctl objects
 572  */
 573 #define TCPCTL_DO_RFC1323       1       /* use RFC-1323 extensions */
 574 /* 2 was TCPCTL_DO_RFC1644 */
 575 #define TCPCTL_MSSDFLT          3       /* MSS default */
 576 #define TCPCTL_STATS            4       /* statistics (read-only) */
 577 #define TCPCTL_RTTDFLT          5       /* default RTT estimate */
 578 #define TCPCTL_KEEPIDLE         6       /* keepalive idle timer */
 579 #define TCPCTL_KEEPINTVL        7       /* interval to send keepalives */
 580 #define TCPCTL_SENDSPACE        8       /* send buffer space */
 581 #define TCPCTL_RECVSPACE        9       /* receive buffer space */
 582 #define TCPCTL_KEEPINIT         10      /* timeout for establishing syn */
 583 #define TCPCTL_PCBLIST          11      /* list of all outstanding PCBs */
 584 #define TCPCTL_DELACKTIME       12      /* time before sending delayed ACK */
 585 #define TCPCTL_V6MSSDFLT        13      /* MSS default for IPv6 */
 586 #define TCPCTL_MAXID            14
 587
 588 #define TCPCTL_NAMES { \
 589         { 0, 0 }, \
 590         { "rfc1323", CTLTYPE_INT }, \
 591           { "reserved", CTLTYPE_INT},   /* was rfc1644 */       \
 592         { "mssdflt", CTLTYPE_INT }, \
 593         { "stats", CTLTYPE_STRUCT }, \
 594         { "rttdflt", CTLTYPE_INT }, \
 595         { "keepidle", CTLTYPE_INT }, \
 596         { "keepintvl", CTLTYPE_INT }, \
 597         { "sendspace", CTLTYPE_INT }, \
 598         { "recvspace", CTLTYPE_INT }, \
 599         { "keepinit", CTLTYPE_INT }, \
 600         { "pcblist", CTLTYPE_STRUCT }, \
 601         { "delacktime", CTLTYPE_INT }, \
 602         { "v6mssdflt", CTLTYPE_INT }, \
 603 }
 604
 605 #ifdef _KERNEL
 606 #ifdef SYSCTL_DECL
 607 SYSCTL_DECL(_net_inet_tcp);
 608 #endif
 609
 610 #define TCP_DO_SACK(tp)         ((tp)->t_flags & TF_SACK_PERMITTED)
 611 #define TCP_DO_NCR(tp)          (((tp)->t_flags & TF_NCR) && TCP_DO_SACK((tp)))
 612 #define TCP_SACK_BLKEND(len, thflags) \
 613         ((len) + (((thflags) & TH_FIN) != 0))
 614
 615 TAILQ_HEAD(tcpcbackqhead,tcpcb);
 616
 617 extern  struct inpcbinfo tcbinfo[];
 618 extern  struct tcpcbackqhead tcpcbackq[];
 619
 620 extern  int tcp_mssdflt;        /* XXX */
 621 extern  int tcp_minmss;
 622 extern  int tcp_delack_enabled;
 623 extern  int path_mtu_discovery;
 624
 625 struct ip;
 626 union netmsg;
 627
 628 int      tcp_addrcpu(in_addr_t faddr, in_port_t fport,
 629             in_addr_t laddr, in_port_t lport);
 630 struct lwkt_port *
 631         tcp_addrport(in_addr_t faddr, in_port_t fport,
 632             in_addr_t laddr, in_port_t lport);
 633 struct lwkt_port *tcp_addrport0(void);
 634 void     tcp_canceltimers (struct tcpcb *);
 635 struct tcpcb *
 636          tcp_close (struct tcpcb *);
 637 void     tcp_ctlinput(union netmsg *);
 638 void     tcp_ctloutput(union netmsg *);
 639 struct tcpcb *
 640          tcp_drop (struct tcpcb *, int);
 641 void     tcp_drain (void);
 642 void     tcp_init (void);
 643 void     tcp_thread_init (void);
 644 int      tcp_input (struct mbuf **, int *, int);
 645 void     tcp_mss (struct tcpcb *, int);
 646 int      tcp_mssopt (struct tcpcb *);
 647 void     tcp_drop_syn_sent (struct inpcb *, int);
 648 void     tcp_mtudisc (struct inpcb *, int);
 649 struct tcpcb *
 650          tcp_newtcpcb (struct inpcb *);
 651 int      tcp_output(struct tcpcb *);
 652 int      tcp_output_fair(struct tcpcb *);
 653 void     tcp_output_init(struct tcpcb *);
 654 void     tcp_output_cancel(struct tcpcb *);
 655 boolean_t
 656          tcp_output_pending(struct tcpcb *);
 657 void     tcp_quench (struct inpcb *, int);
 658 void     tcp_respond (struct tcpcb *, void *,
 659             struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
 660 struct rtentry *
 661          tcp_rtlookup (struct in_conninfo *);
 662 int      tcp_sack_bytes_below(const struct scoreboard *scb, tcp_seq seq);
 663 void     tcp_sack_destroy(struct scoreboard *scb);
 664 void     tcp_sack_discard(struct tcpcb *tp);
 665 void     tcp_sack_report_cleanup(struct tcpcb *tp);
 666 boolean_t
 667          tcp_sack_report_needed(const struct tcpcb *tp);
 668 int      tcp_sack_ndsack_blocks(const struct raw_sackblock *blocks,
 669             const int numblocks, tcp_seq snd_una);
 670 void     tcp_sack_fill_report(struct tcpcb *tp, u_char *opt, u_int *plen);
 671 boolean_t
 672          tcp_sack_has_sacked(const struct scoreboard *scb, u_int amount);
 673 void     tcp_sack_tcpcb_init(struct tcpcb *tp);
 674 uint32_t tcp_sack_compute_pipe(const struct tcpcb *tp);
 675 boolean_t
 676          tcp_sack_nextseg(struct tcpcb *tp, tcp_seq *nextrexmt, uint32_t *len,
 677                           boolean_t *rescue);
 678 boolean_t
 679          tcp_sack_islost(const struct scoreboard *scb, tcp_seq seq);
 680 void     tcp_sack_update_lostseq(struct scoreboard *scb, tcp_seq snd_una,
 681             u_int maxseg, int rxtthresh);
 682 #ifdef later
 683 void     tcp_sack_revert_scoreboard(struct scoreboard *scb, tcp_seq snd_una,
 684                                     u_int maxseg);
 685 void     tcp_sack_save_scoreboard(struct scoreboard *scb);
 686 #endif
 687 void     tcp_sack_skip_sacked(struct scoreboard *scb, tcp_seq *prexmt);
 688 uint32_t tcp_sack_first_unsacked_len(const struct tcpcb *tp);
 689 void     tcp_sack_update_scoreboard(struct tcpcb *tp, struct tcpopt *to);
 690 void     tcp_save_congestion_state(struct tcpcb *tp);
 691 void     tcp_revert_congestion_state(struct tcpcb *tp);
 692 void     tcp_setpersist (struct tcpcb *);
 693 struct tcptemp *tcp_maketemplate (struct tcpcb *);
 694 void     tcp_freetemplate (struct tcptemp *);
 695 void     tcp_fillheaders (struct tcpcb *, void *, void *, boolean_t);
 696 struct lwkt_port *
 697          tcp_soport(struct socket *, struct sockaddr *, struct mbuf **);
 698 struct lwkt_port *
 699          tcp_ctlport(int, struct sockaddr *, void *);
 700 struct tcpcb *
 701          tcp_timers (struct tcpcb *, int);
 702 void     tcp_trace (short, short, struct tcpcb *, void *, struct tcphdr *,
 703                         int);
 704 void     tcp_xmit_bandwidth_limit(struct tcpcb *tp, tcp_seq ack_seq);
 705 u_long   tcp_initial_window(struct tcpcb *tp);
 706 void     tcp_timer_keep_activity(struct tcpcb *tp, int thflags);
 707 boolean_t
 708          tcp_tso_pullup(struct mbuf **mp, int hoff, struct ip **ip, int *iphlen,
 709                 struct tcphdr **th, int *thoff);
 710 void     syncache_init(void);
 711 void     syncache_unreach(struct in_conninfo *, struct tcphdr *);
 712 int      syncache_expand(struct in_conninfo *, struct tcphdr *,
 713              struct socket **, struct mbuf *);
 714 int      syncache_add(struct in_conninfo *, struct tcpopt *,
 715              struct tcphdr *, struct socket *, struct mbuf *);
 716 void     syncache_chkrst(struct in_conninfo *, struct tcphdr *);
 717 void     syncache_badack(struct in_conninfo *);
 718 void     syncache_destroy(struct tcpcb *tp);
 719
 720 #ifdef TCP_SIGNATURE
 721 int tcpsignature_apply(void *fstate, void *data, unsigned int len);
 722 int tcpsignature_compute(struct mbuf *m, int len, int tcpoptlen,
 723                 u_char *buf, u_int direction);
 724 #endif /* TCP_SIGNATURE */
 725
 726 extern  struct pr_usrreqs tcp_usrreqs;
 727 extern  u_long tcp_sendspace;
 728 extern  u_long tcp_recvspace;
 729 tcp_seq tcp_new_isn (struct tcpcb *);
 730
 731 #endif /* _KERNEL */
 732
 733 #endif /* _NETINET_TCP_VAR_H_ */