sys/netinet/tcp_var.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1993, 1994, 1995
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)tcp_var.h   8.4 (Berkeley) 5/24/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _NETINET_TCP_VAR_H_
  34 #define _NETINET_TCP_VAR_H_
  35
  36 #include <netinet/tcp.h>
  37
  38 #ifdef _KERNEL
  39 #include <net/vnet.h>
  40
  41 /*
  42  * Kernel variables for tcp.
  43  */
  44 VNET_DECLARE(int, tcp_do_rfc1323);
  45 #define V_tcp_do_rfc1323        VNET(tcp_do_rfc1323)
  46
  47 #endif /* _KERNEL */
  48
  49 /* TCP segment queue entry */
  50 struct tseg_qent {
  51         LIST_ENTRY(tseg_qent) tqe_q;
  52         int     tqe_len;                /* TCP segment data length */
  53         struct  tcphdr *tqe_th;         /* a pointer to tcp header */
  54         struct  mbuf    *tqe_m;         /* mbuf contains packet */
  55 };
  56 LIST_HEAD(tsegqe_head, tseg_qent);
  57
  58 struct sackblk {
  59         tcp_seq start;          /* start seq no. of sack block */
  60         tcp_seq end;            /* end seq no. */
  61 };
  62
  63 struct sackhole {
  64         tcp_seq start;          /* start seq no. of hole */
  65         tcp_seq end;            /* end seq no. */
  66         tcp_seq rxmit;          /* next seq. no in hole to be retransmitted */
  67         TAILQ_ENTRY(sackhole) scblink;  /* scoreboard linkage */
  68 };
  69
  70 struct sackhint {
  71         struct sackhole *nexthole;
  72         int             sack_bytes_rexmit;
  73         tcp_seq         last_sack_ack;  /* Most recent/largest sacked ack */
  74
  75         uint64_t        _pad[2];        /* 1 sacked_bytes, 1 TBD */
  76 };
  77
  78 struct tcptemp {
  79         u_char  tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
  80         struct  tcphdr tt_t;
  81 };
  82
  83 #define tcp6cb          tcpcb  /* for KAME src sync over BSD*'s */
  84
  85 /* Neighbor Discovery, Neighbor Unreachability Detection Upper layer hint. */
  86 #ifdef INET6
  87 #define ND6_HINT(tp)                                            \
  88 do {                                                            \
  89         if ((tp) && (tp)->t_inpcb &&                            \
  90             ((tp)->t_inpcb->inp_vflag & INP_IPV6) != 0)         \
  91                 nd6_nud_hint(NULL, NULL, 0);                    \
  92 } while (0)
  93 #else
  94 #define ND6_HINT(tp)
  95 #endif
  96
  97 /*
  98  * Tcp control block, one per tcp; fields:
  99  * Organized for 16 byte cacheline efficiency.
 100  */
 101 struct tcpcb {
 102         struct  tsegqe_head t_segq;     /* segment reassembly queue */
 103         void    *t_pspare[2];           /* new reassembly queue */
 104         int     t_segqlen;              /* segment reassembly queue length */
 105         int     t_dupacks;              /* consecutive dup acks recd */
 106
 107         struct tcp_timer *t_timers;     /* All the TCP timers in one struct */
 108
 109         struct  inpcb *t_inpcb;         /* back pointer to internet pcb */
 110         int     t_state;                /* state of this connection */
 111         u_int   t_flags;
 112
 113         struct  vnet *t_vnet;           /* back pointer to parent vnet */
 114
 115         tcp_seq snd_una;                /* send unacknowledged */
 116         tcp_seq snd_max;                /* highest sequence number sent;
 117                                          * used to recognize retransmits
 118                                          */
 119         tcp_seq snd_nxt;                /* send next */
 120         tcp_seq snd_up;                 /* send urgent pointer */
 121
 122         tcp_seq snd_wl1;                /* window update seg seq number */
 123         tcp_seq snd_wl2;                /* window update seg ack number */
 124         tcp_seq iss;                    /* initial send sequence number */
 125         tcp_seq irs;                    /* initial receive sequence number */
 126
 127         tcp_seq rcv_nxt;                /* receive next */
 128         tcp_seq rcv_adv;                /* advertised window */
 129         u_long  rcv_wnd;                /* receive window */
 130         tcp_seq rcv_up;                 /* receive urgent pointer */
 131
 132         u_long  snd_wnd;                /* send window */
 133         u_long  snd_cwnd;               /* congestion-controlled window */
 134         u_long  snd_bwnd;               /* bandwidth-controlled window */
 135         u_long  snd_ssthresh;           /* snd_cwnd size threshold for
 136                                          * for slow start exponential to
 137                                          * linear switch
 138                                          */
 139         u_long  snd_bandwidth;          /* calculated bandwidth or 0 */
 140         tcp_seq snd_recover;            /* for use in NewReno Fast Recovery */
 141
 142         u_int   t_maxopd;               /* mss plus options */
 143
 144         u_int   t_rcvtime;              /* inactivity time */
 145         u_int   t_starttime;            /* time connection was established */
 146         u_int   t_rtttime;              /* RTT measurement start time */
 147         tcp_seq t_rtseq;                /* sequence number being timed */
 148
 149         u_int   t_bw_rtttime;           /* used for bandwidth calculation */
 150         tcp_seq t_bw_rtseq;             /* used for bandwidth calculation */
 151
 152         int     t_rxtcur;               /* current retransmit value (ticks) */
 153         u_int   t_maxseg;               /* maximum segment size */
 154         int     t_srtt;                 /* smoothed round-trip time */
 155         int     t_rttvar;               /* variance in round-trip time */
 156
 157         int     t_rxtshift;             /* log(2) of rexmt exp. backoff */
 158         u_int   t_rttmin;               /* minimum rtt allowed */
 159         u_int   t_rttbest;              /* best rtt we've seen */
 160         u_long  t_rttupdated;           /* number of times rtt sampled */
 161         u_long  max_sndwnd;             /* largest window peer has offered */
 162
 163         int     t_softerror;            /* possible error not yet reported */
 164 /* out-of-band data */
 165         char    t_oobflags;             /* have some */
 166         char    t_iobc;                 /* input character */
 167 /* RFC 1323 variables */
 168         u_char  snd_scale;              /* window scaling for send window */
 169         u_char  rcv_scale;              /* window scaling for recv window */
 170         u_char  request_r_scale;        /* pending window scaling */
 171         u_int32_t  ts_recent;           /* timestamp echo data */
 172         u_int   ts_recent_age;          /* when last updated */
 173         u_int32_t  ts_offset;           /* our timestamp offset */
 174
 175         tcp_seq last_ack_sent;
 176 /* experimental */
 177         u_long  snd_cwnd_prev;          /* cwnd prior to retransmit */
 178         u_long  snd_ssthresh_prev;      /* ssthresh prior to retransmit */
 179         tcp_seq snd_recover_prev;       /* snd_recover prior to retransmit */
 180         u_int   t_badrxtwin;            /* window for retransmit recovery */
 181         u_char  snd_limited;            /* segments limited transmitted */
 182 /* SACK related state */
 183         int     snd_numholes;           /* number of holes seen by sender */
 184         TAILQ_HEAD(sackhole_head, sackhole) snd_holes;
 185                                         /* SACK scoreboard (sorted) */
 186         tcp_seq snd_fack;               /* last seq number(+1) sack'd by rcv'r*/
 187         int     rcv_numsacks;           /* # distinct sack blks present */
 188         struct sackblk sackblks[MAX_SACK_BLKS]; /* seq nos. of sack blocks */
 189         tcp_seq sack_newdata;           /* New data xmitted in this recovery
 190                                            episode starts at this seq number */
 191         struct sackhint sackhint;       /* SACK scoreboard hint */
 192         int     t_rttlow;               /* smallest observerved RTT */
 193         u_int32_t       rfbuf_ts;       /* recv buffer autoscaling timestamp */
 194         int     rfbuf_cnt;              /* recv buffer autoscaling byte count */
 195         struct toe_usrreqs *t_tu;       /* offload operations vector */
 196         void    *t_toe;                 /* TOE pcb pointer */
 197         int     t_bytes_acked;          /* # bytes acked during current RTT */
 198
 199         int     t_sndzerowin;   /* zero-window updates sent */
 200
 201         struct cc_algo  *cc_algo;       /* congestion control algorithm */
 202         struct cc_var   *ccv;           /* congestion control specific vars */
 203         struct osd      *osd;           /* storage for Khelp module data */
 204
 205         void    *t_pspare2[3];          /* 3 TBD */
 206         uint64_t _pad[10];              /* 7 UTO, 3 TBD (1-2 CC/RTT?) */
 207
 208         uint64_t        t_sndrexmitpack;/* retransmit packets sent */
 209         uint64_t        t_rcvoopack;    /* out-of-order packets received */
 210 };
 211
 212 /*
 213  * Flags and utility macros for the t_flags field.
 214  */
 215 #define TF_ACKNOW       0x000001        /* ack peer immediately */
 216 #define TF_DELACK       0x000002        /* ack, but try to delay it */
 217 #define TF_NODELAY      0x000004        /* don't delay packets to coalesce */
 218 #define TF_NOOPT        0x000008        /* don't use tcp options */
 219 #define TF_SENTFIN      0x000010        /* have sent FIN */
 220 #define TF_REQ_SCALE    0x000020        /* have/will request window scaling */
 221 #define TF_RCVD_SCALE   0x000040        /* other side has requested scaling */
 222 #define TF_REQ_TSTMP    0x000080        /* have/will request timestamps */
 223 #define TF_RCVD_TSTMP   0x000100        /* a timestamp was received in SYN */
 224 #define TF_SACK_PERMIT  0x000200        /* other side said I could SACK */
 225 #define TF_NEEDSYN      0x000400        /* send SYN (implicit state) */
 226 #define TF_NEEDFIN      0x000800        /* send FIN (implicit state) */
 227 #define TF_NOPUSH       0x001000        /* don't push */
 228 #define TF_PREVVALID    0x002000        /* saved values for bad rxmit valid */
 229 #define TF_MORETOCOME   0x010000        /* More data to be appended to sock */
 230 #define TF_LQ_OVERFLOW  0x020000        /* listen queue overflow */
 231 #define TF_LASTIDLE     0x040000        /* connection was previously idle */
 232 #define TF_RXWIN0SENT   0x080000        /* sent a receiver win 0 in response */
 233 #define TF_FASTRECOVERY 0x100000        /* in NewReno Fast Recovery */
 234 #define TF_WASFRECOVERY 0x200000        /* was in NewReno Fast Recovery */
 235 #define TF_SIGNATURE    0x400000        /* require MD5 digests (RFC2385) */
 236 #define TF_FORCEDATA    0x800000        /* force out a byte */
 237 #define TF_TSO          0x1000000       /* TSO enabled on this connection */
 238 #define TF_TOE          0x2000000       /* this connection is offloaded */
 239 #define TF_ECN_PERMIT   0x4000000       /* connection ECN-ready */
 240 #define TF_ECN_SND_CWR  0x8000000       /* ECN CWR in queue */
 241 #define TF_ECN_SND_ECE  0x10000000      /* ECN ECE in queue */
 242 #define TF_CONGRECOVERY 0x20000000      /* congestion recovery mode */
 243 #define TF_WASCRECOVERY 0x40000000      /* was in congestion recovery */
 244
 245 #define IN_FASTRECOVERY(t_flags)        (t_flags & TF_FASTRECOVERY)
 246 #define ENTER_FASTRECOVERY(t_flags)     t_flags |= TF_FASTRECOVERY
 247 #define EXIT_FASTRECOVERY(t_flags)      t_flags &= ~TF_FASTRECOVERY
 248
 249 #define IN_CONGRECOVERY(t_flags)        (t_flags & TF_CONGRECOVERY)
 250 #define ENTER_CONGRECOVERY(t_flags)     t_flags |= TF_CONGRECOVERY
 251 #define EXIT_CONGRECOVERY(t_flags)      t_flags &= ~TF_CONGRECOVERY
 252
 253 #define IN_RECOVERY(t_flags) (t_flags & (TF_CONGRECOVERY | TF_FASTRECOVERY))
 254 #define ENTER_RECOVERY(t_flags) t_flags |= (TF_CONGRECOVERY | TF_FASTRECOVERY)
 255 #define EXIT_RECOVERY(t_flags) t_flags &= ~(TF_CONGRECOVERY | TF_FASTRECOVERY)
 256
 257 #define BYTES_THIS_ACK(tp, th)  (th->th_ack - tp->snd_una)
 258
 259 /*
 260  * Flags for the t_oobflags field.
 261  */
 262 #define TCPOOB_HAVEDATA 0x01
 263 #define TCPOOB_HADDATA  0x02
 264
 265 #ifdef TCP_SIGNATURE
 266 /*
 267  * Defines which are needed by the xform_tcp module and tcp_[in|out]put
 268  * for SADB verification and lookup.
 269  */
 270 #define TCP_SIGLEN      16      /* length of computed digest in bytes */
 271 #define TCP_KEYLEN_MIN  1       /* minimum length of TCP-MD5 key */
 272 #define TCP_KEYLEN_MAX  80      /* maximum length of TCP-MD5 key */
 273 /*
 274  * Only a single SA per host may be specified at this time. An SPI is
 275  * needed in order for the KEY_ALLOCSA() lookup to work.
 276  */
 277 #define TCP_SIG_SPI     0x1000
 278 #endif /* TCP_SIGNATURE */
 279
 280 /*
 281  * Structure to hold TCP options that are only used during segment
 282  * processing (in tcp_input), but not held in the tcpcb.
 283  * It's basically used to reduce the number of parameters
 284  * to tcp_dooptions and tcp_addoptions.
 285  * The binary order of the to_flags is relevant for packing of the
 286  * options in tcp_addoptions.
 287  */
 288 struct tcpopt {
 289         u_int64_t       to_flags;       /* which options are present */
 290 #define TOF_MSS         0x0001          /* maximum segment size */
 291 #define TOF_SCALE       0x0002          /* window scaling */
 292 #define TOF_SACKPERM    0x0004          /* SACK permitted */
 293 #define TOF_TS          0x0010          /* timestamp */
 294 #define TOF_SIGNATURE   0x0040          /* TCP-MD5 signature option (RFC2385) */
 295 #define TOF_SACK        0x0080          /* Peer sent SACK option */
 296 #define TOF_MAXOPT      0x0100
 297         u_int32_t       to_tsval;       /* new timestamp */
 298         u_int32_t       to_tsecr;       /* reflected timestamp */
 299         u_char          *to_sacks;      /* pointer to the first SACK blocks */
 300         u_char          *to_signature;  /* pointer to the TCP-MD5 signature */
 301         u_int16_t       to_mss;         /* maximum segment size */
 302         u_int8_t        to_wscale;      /* window scaling */
 303         u_int8_t        to_nsacks;      /* number of SACK blocks */
 304 };
 305
 306 /*
 307  * Flags for tcp_dooptions.
 308  */
 309 #define TO_SYN          0x01            /* parse SYN-only options */
 310
 311 struct hc_metrics_lite {        /* must stay in sync with hc_metrics */
 312         u_long  rmx_mtu;        /* MTU for this path */
 313         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
 314         u_long  rmx_rtt;        /* estimated round trip time */
 315         u_long  rmx_rttvar;     /* estimated rtt variance */
 316         u_long  rmx_bandwidth;  /* estimated bandwidth */
 317         u_long  rmx_cwnd;       /* congestion window */
 318         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
 319         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
 320 };
 321
 322 #ifndef _NETINET_IN_PCB_H_
 323 struct in_conninfo;
 324 #endif /* _NETINET_IN_PCB_H_ */
 325
 326 struct tcptw {
 327         struct inpcb    *tw_inpcb;      /* XXX back pointer to internet pcb */
 328         tcp_seq         snd_nxt;
 329         tcp_seq         rcv_nxt;
 330         tcp_seq         iss;
 331         tcp_seq         irs;
 332         u_short         last_win;       /* cached window value */
 333         u_short         tw_so_options;  /* copy of so_options */
 334         struct ucred    *tw_cred;       /* user credentials */
 335         u_int32_t       t_recent;
 336         u_int32_t       ts_offset;      /* our timestamp offset */
 337         u_int           t_starttime;
 338         int             tw_time;
 339         TAILQ_ENTRY(tcptw) tw_2msl;
 340 };
 341
 342 #define intotcpcb(ip)   ((struct tcpcb *)(ip)->inp_ppcb)
 343 #define intotw(ip)      ((struct tcptw *)(ip)->inp_ppcb)
 344 #define sototcpcb(so)   (intotcpcb(sotoinpcb(so)))
 345
 346 /*
 347  * The smoothed round-trip time and estimated variance
 348  * are stored as fixed point numbers scaled by the values below.
 349  * For convenience, these scales are also used in smoothing the average
 350  * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
 351  * With these scales, srtt has 3 bits to the right of the binary point,
 352  * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
 353  * binary point, and is smoothed with an ALPHA of 0.75.
 354  */
 355 #define TCP_RTT_SCALE           32      /* multiplier for srtt; 3 bits frac. */
 356 #define TCP_RTT_SHIFT           5       /* shift for srtt; 3 bits frac. */
 357 #define TCP_RTTVAR_SCALE        16      /* multiplier for rttvar; 2 bits */
 358 #define TCP_RTTVAR_SHIFT        4       /* shift for rttvar; 2 bits */
 359 #define TCP_DELTA_SHIFT         2       /* see tcp_input.c */
 360
 361 /*
 362  * The initial retransmission should happen at rtt + 4 * rttvar.
 363  * Because of the way we do the smoothing, srtt and rttvar
 364  * will each average +1/2 tick of bias.  When we compute
 365  * the retransmit timer, we want 1/2 tick of rounding and
 366  * 1 extra tick because of +-1/2 tick uncertainty in the
 367  * firing of the timer.  The bias will give us exactly the
 368  * 1.5 tick we need.  But, because the bias is
 369  * statistical, we have to test that we don't drop below
 370  * the minimum feasible timer (which is 2 ticks).
 371  * This version of the macro adapted from a paper by Lawrence
 372  * Brakmo and Larry Peterson which outlines a problem caused
 373  * by insufficient precision in the original implementation,
 374  * which results in inappropriately large RTO values for very
 375  * fast networks.
 376  */
 377 #define TCP_REXMTVAL(tp) \
 378         max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
 379           + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
 380
 381 /*
 382  * TCP statistics.
 383  * Many of these should be kept per connection,
 384  * but that's inconvenient at the moment.
 385  */
 386 struct  tcpstat {
 387         u_long  tcps_connattempt;       /* connections initiated */
 388         u_long  tcps_accepts;           /* connections accepted */
 389         u_long  tcps_connects;          /* connections established */
 390         u_long  tcps_drops;             /* connections dropped */
 391         u_long  tcps_conndrops;         /* embryonic connections dropped */
 392         u_long  tcps_minmssdrops;       /* average minmss too low drops */
 393         u_long  tcps_closed;            /* conn. closed (includes drops) */
 394         u_long  tcps_segstimed;         /* segs where we tried to get rtt */
 395         u_long  tcps_rttupdated;        /* times we succeeded */
 396         u_long  tcps_delack;            /* delayed acks sent */
 397         u_long  tcps_timeoutdrop;       /* conn. dropped in rxmt timeout */
 398         u_long  tcps_rexmttimeo;        /* retransmit timeouts */
 399         u_long  tcps_persisttimeo;      /* persist timeouts */
 400         u_long  tcps_keeptimeo;         /* keepalive timeouts */
 401         u_long  tcps_keepprobe;         /* keepalive probes sent */
 402         u_long  tcps_keepdrops;         /* connections dropped in keepalive */
 403
 404         u_long  tcps_sndtotal;          /* total packets sent */
 405         u_long  tcps_sndpack;           /* data packets sent */
 406         u_long  tcps_sndbyte;           /* data bytes sent */
 407         u_long  tcps_sndrexmitpack;     /* data packets retransmitted */
 408         u_long  tcps_sndrexmitbyte;     /* data bytes retransmitted */
 409         u_long  tcps_sndrexmitbad;      /* unnecessary packet retransmissions */
 410         u_long  tcps_sndacks;           /* ack-only packets sent */
 411         u_long  tcps_sndprobe;          /* window probes sent */
 412         u_long  tcps_sndurg;            /* packets sent with URG only */
 413         u_long  tcps_sndwinup;          /* window update-only packets sent */
 414         u_long  tcps_sndctrl;           /* control (SYN|FIN|RST) packets sent */
 415
 416         u_long  tcps_rcvtotal;          /* total packets received */
 417         u_long  tcps_rcvpack;           /* packets received in sequence */
 418         u_long  tcps_rcvbyte;           /* bytes received in sequence */
 419         u_long  tcps_rcvbadsum;         /* packets received with ccksum errs */
 420         u_long  tcps_rcvbadoff;         /* packets received with bad offset */
 421         u_long  tcps_rcvmemdrop;        /* packets dropped for lack of memory */
 422         u_long  tcps_rcvshort;          /* packets received too short */
 423         u_long  tcps_rcvduppack;        /* duplicate-only packets received */
 424         u_long  tcps_rcvdupbyte;        /* duplicate-only bytes received */
 425         u_long  tcps_rcvpartduppack;    /* packets with some duplicate data */
 426         u_long  tcps_rcvpartdupbyte;    /* dup. bytes in part-dup. packets */
 427         u_long  tcps_rcvoopack;         /* out-of-order packets received */
 428         u_long  tcps_rcvoobyte;         /* out-of-order bytes received */
 429         u_long  tcps_rcvpackafterwin;   /* packets with data after window */
 430         u_long  tcps_rcvbyteafterwin;   /* bytes rcvd after window */
 431         u_long  tcps_rcvafterclose;     /* packets rcvd after "close" */
 432         u_long  tcps_rcvwinprobe;       /* rcvd window probe packets */
 433         u_long  tcps_rcvdupack;         /* rcvd duplicate acks */
 434         u_long  tcps_rcvacktoomuch;     /* rcvd acks for unsent data */
 435         u_long  tcps_rcvackpack;        /* rcvd ack packets */
 436         u_long  tcps_rcvackbyte;        /* bytes acked by rcvd acks */
 437         u_long  tcps_rcvwinupd;         /* rcvd window update packets */
 438         u_long  tcps_pawsdrop;          /* segments dropped due to PAWS */
 439         u_long  tcps_predack;           /* times hdr predict ok for acks */
 440         u_long  tcps_preddat;           /* times hdr predict ok for data pkts */
 441         u_long  tcps_pcbcachemiss;
 442         u_long  tcps_cachedrtt;         /* times cached RTT in route updated */
 443         u_long  tcps_cachedrttvar;      /* times cached rttvar updated */
 444         u_long  tcps_cachedssthresh;    /* times cached ssthresh updated */
 445         u_long  tcps_usedrtt;           /* times RTT initialized from route */
 446         u_long  tcps_usedrttvar;        /* times RTTVAR initialized from rt */
 447         u_long  tcps_usedssthresh;      /* times ssthresh initialized from rt*/
 448         u_long  tcps_persistdrop;       /* timeout in persist state */
 449         u_long  tcps_badsyn;            /* bogus SYN, e.g. premature ACK */
 450         u_long  tcps_mturesent;         /* resends due to MTU discovery */
 451         u_long  tcps_listendrop;        /* listen queue overflows */
 452         u_long  tcps_badrst;            /* ignored RSTs in the window */
 453
 454         u_long  tcps_sc_added;          /* entry added to syncache */
 455         u_long  tcps_sc_retransmitted;  /* syncache entry was retransmitted */
 456         u_long  tcps_sc_dupsyn;         /* duplicate SYN packet */
 457         u_long  tcps_sc_dropped;        /* could not reply to packet */
 458         u_long  tcps_sc_completed;      /* successful extraction of entry */
 459         u_long  tcps_sc_bucketoverflow; /* syncache per-bucket limit hit */
 460         u_long  tcps_sc_cacheoverflow;  /* syncache cache limit hit */
 461         u_long  tcps_sc_reset;          /* RST removed entry from syncache */
 462         u_long  tcps_sc_stale;          /* timed out or listen socket gone */
 463         u_long  tcps_sc_aborted;        /* syncache entry aborted */
 464         u_long  tcps_sc_badack;         /* removed due to bad ACK */
 465         u_long  tcps_sc_unreach;        /* ICMP unreachable received */
 466         u_long  tcps_sc_zonefail;       /* zalloc() failed */
 467         u_long  tcps_sc_sendcookie;     /* SYN cookie sent */
 468         u_long  tcps_sc_recvcookie;     /* SYN cookie received */
 469
 470         u_long  tcps_hc_added;          /* entry added to hostcache */
 471         u_long  tcps_hc_bucketoverflow; /* hostcache per bucket limit hit */
 472
 473         u_long  tcps_finwait2_drops;    /* Drop FIN_WAIT_2 connection after time limit */
 474
 475         /* SACK related stats */
 476         u_long  tcps_sack_recovery_episode; /* SACK recovery episodes */
 477         u_long  tcps_sack_rexmits;          /* SACK rexmit segments   */
 478         u_long  tcps_sack_rexmit_bytes;     /* SACK rexmit bytes      */
 479         u_long  tcps_sack_rcv_blocks;       /* SACK blocks (options) received */
 480         u_long  tcps_sack_send_blocks;      /* SACK blocks (options) sent     */
 481         u_long  tcps_sack_sboverflow;       /* times scoreboard overflowed */
 482
 483         /* ECN related stats */
 484         u_long  tcps_ecn_ce;            /* ECN Congestion Experienced */
 485         u_long  tcps_ecn_ect0;          /* ECN Capable Transport */
 486         u_long  tcps_ecn_ect1;          /* ECN Capable Transport */
 487         u_long  tcps_ecn_shs;           /* ECN successful handshakes */
 488         u_long  tcps_ecn_rcwnd;         /* # times ECN reduced the cwnd */
 489
 490         /* TCP_SIGNATURE related stats */
 491         u_long  tcps_sig_rcvgoodsig;    /* Total matching signature received */
 492         u_long  tcps_sig_rcvbadsig;     /* Total bad signature received */
 493         u_long  tcps_sig_err_buildsig;  /* Mismatching signature received */
 494         u_long  tcps_sig_err_sigopt;    /* No signature expected by socket */
 495         u_long  tcps_sig_err_nosigopt;  /* No signature provided by segment */
 496
 497         u_long  _pad[7];                /* 6 UTO, 1 TBD */
 498 };
 499
 500 #ifdef _KERNEL
 501 /*
 502  * In-kernel consumers can use these accessor macros directly to update
 503  * stats.
 504  */
 505 #define TCPSTAT_ADD(name, val)  V_tcpstat.name += (val)
 506 #define TCPSTAT_INC(name)       TCPSTAT_ADD(name, 1)
 507
 508 /*
 509  * Kernel module consumers must use this accessor macro.
 510  */
 511 void    kmod_tcpstat_inc(int statnum);
 512 #define KMOD_TCPSTAT_INC(name)                                          \
 513         kmod_tcpstat_inc(offsetof(struct tcpstat, name) / sizeof(u_long))
 514
 515 /*
 516  * TCP specific helper hook point identifiers.
 517  */
 518 #define HHOOK_TCP_EST_IN                0
 519 #define HHOOK_TCP_EST_OUT               1
 520 #define HHOOK_TCP_LAST                  HHOOK_TCP_EST_OUT
 521
 522 struct tcp_hhook_data {
 523         struct tcpcb    *tp;
 524         struct tcphdr   *th;
 525         struct tcpopt   *to;
 526         long            len;
 527         int             tso;
 528         tcp_seq         curack;
 529 };
 530 #endif
 531
 532 /*
 533  * TCB structure exported to user-land via sysctl(3).
 534  * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
 535  * included.  Not all of our clients do.
 536  */
 537 #if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
 538 struct  xtcpcb {
 539         size_t  xt_len;
 540         struct  inpcb   xt_inp;
 541         struct  tcpcb   xt_tp;
 542         struct  xsocket xt_socket;
 543         u_quad_t        xt_alignment_hack;
 544 };
 545 #endif
 546
 547 /*
 548  * Names for TCP sysctl objects
 549  */
 550 #define TCPCTL_DO_RFC1323       1       /* use RFC-1323 extensions */
 551 #define TCPCTL_MSSDFLT          3       /* MSS default */
 552 #define TCPCTL_STATS            4       /* statistics (read-only) */
 553 #define TCPCTL_RTTDFLT          5       /* default RTT estimate */
 554 #define TCPCTL_KEEPIDLE         6       /* keepalive idle timer */
 555 #define TCPCTL_KEEPINTVL        7       /* interval to send keepalives */
 556 #define TCPCTL_SENDSPACE        8       /* send buffer space */
 557 #define TCPCTL_RECVSPACE        9       /* receive buffer space */
 558 #define TCPCTL_KEEPINIT         10      /* timeout for establishing syn */
 559 #define TCPCTL_PCBLIST          11      /* list of all outstanding PCBs */
 560 #define TCPCTL_DELACKTIME       12      /* time before sending delayed ACK */
 561 #define TCPCTL_V6MSSDFLT        13      /* MSS default for IPv6 */
 562 #define TCPCTL_SACK             14      /* Selective Acknowledgement,rfc 2018 */
 563 #define TCPCTL_DROP             15      /* drop tcp connection */
 564 #define TCPCTL_MAXID            16
 565 #define TCPCTL_FINWAIT2_TIMEOUT        17
 566
 567 #define TCPCTL_NAMES { \
 568         { 0, 0 }, \
 569         { "rfc1323", CTLTYPE_INT }, \
 570         { "mssdflt", CTLTYPE_INT }, \
 571         { "stats", CTLTYPE_STRUCT }, \
 572         { "rttdflt", CTLTYPE_INT }, \
 573         { "keepidle", CTLTYPE_INT }, \
 574         { "keepintvl", CTLTYPE_INT }, \
 575         { "sendspace", CTLTYPE_INT }, \
 576         { "recvspace", CTLTYPE_INT }, \
 577         { "keepinit", CTLTYPE_INT }, \
 578         { "pcblist", CTLTYPE_STRUCT }, \
 579         { "delacktime", CTLTYPE_INT }, \
 580         { "v6mssdflt", CTLTYPE_INT }, \
 581         { "maxid", CTLTYPE_INT }, \
 582 }
 583
 584
 585 #ifdef _KERNEL
 586 #ifdef SYSCTL_DECL
 587 SYSCTL_DECL(_net_inet_tcp);
 588 SYSCTL_DECL(_net_inet_tcp_sack);
 589 MALLOC_DECLARE(M_TCPLOG);
 590 #endif
 591
 592 VNET_DECLARE(struct inpcbhead, tcb);            /* queue of active tcpcb's */
 593 VNET_DECLARE(struct inpcbinfo, tcbinfo);
 594 VNET_DECLARE(struct tcpstat, tcpstat);          /* tcp statistics */
 595 extern  int tcp_log_in_vain;
 596 VNET_DECLARE(int, tcp_mssdflt); /* XXX */
 597 VNET_DECLARE(int, tcp_minmss);
 598 VNET_DECLARE(int, tcp_delack_enabled);
 599 VNET_DECLARE(int, tcp_do_rfc3390);
 600 VNET_DECLARE(int, path_mtu_discovery);
 601 VNET_DECLARE(int, ss_fltsz);
 602 VNET_DECLARE(int, ss_fltsz_local);
 603 VNET_DECLARE(int, tcp_do_rfc3465);
 604 VNET_DECLARE(int, tcp_abc_l_var);
 605 #define V_tcb                   VNET(tcb)
 606 #define V_tcbinfo               VNET(tcbinfo)
 607 #define V_tcpstat               VNET(tcpstat)
 608 #define V_tcp_mssdflt           VNET(tcp_mssdflt)
 609 #define V_tcp_minmss            VNET(tcp_minmss)
 610 #define V_tcp_delack_enabled    VNET(tcp_delack_enabled)
 611 #define V_tcp_do_rfc3390        VNET(tcp_do_rfc3390)
 612 #define V_path_mtu_discovery    VNET(path_mtu_discovery)
 613 #define V_ss_fltsz              VNET(ss_fltsz)
 614 #define V_ss_fltsz_local        VNET(ss_fltsz_local)
 615 #define V_tcp_do_rfc3465        VNET(tcp_do_rfc3465)
 616 #define V_tcp_abc_l_var         VNET(tcp_abc_l_var)
 617
 618 VNET_DECLARE(int, tcp_do_sack);                 /* SACK enabled/disabled */
 619 VNET_DECLARE(int, tcp_sc_rst_sock_fail);        /* RST on sock alloc failure */
 620 #define V_tcp_do_sack           VNET(tcp_do_sack)
 621 #define V_tcp_sc_rst_sock_fail  VNET(tcp_sc_rst_sock_fail)
 622
 623 VNET_DECLARE(int, tcp_do_ecn);                  /* TCP ECN enabled/disabled */
 624 VNET_DECLARE(int, tcp_ecn_maxretries);
 625 #define V_tcp_do_ecn            VNET(tcp_do_ecn)
 626 #define V_tcp_ecn_maxretries    VNET(tcp_ecn_maxretries)
 627
 628 VNET_DECLARE(struct hhook_head *, tcp_hhh[HHOOK_TCP_LAST + 1]);
 629 #define V_tcp_hhh               VNET(tcp_hhh)
 630
 631 int      tcp_addoptions(struct tcpopt *, u_char *);
 632 int      tcp_ccalgounload(struct cc_algo *unload_algo);
 633 struct tcpcb *
 634          tcp_close(struct tcpcb *);
 635 void     tcp_discardcb(struct tcpcb *);
 636 void     tcp_twstart(struct tcpcb *);
 637 #if 0
 638 int      tcp_twrecycleable(struct tcptw *tw);
 639 #endif
 640 void     tcp_twclose(struct tcptw *_tw, int _reuse);
 641 void     tcp_ctlinput(int, struct sockaddr *, void *);
 642 int      tcp_ctloutput(struct socket *, struct sockopt *);
 643 struct tcpcb *
 644          tcp_drop(struct tcpcb *, int);
 645 void     tcp_drain(void);
 646 void     tcp_init(void);
 647 #ifdef VIMAGE
 648 void     tcp_destroy(void);
 649 #endif
 650 void     tcp_fini(void *);
 651 char    *tcp_log_addrs(struct in_conninfo *, struct tcphdr *, void *,
 652             const void *);
 653 char    *tcp_log_vain(struct in_conninfo *, struct tcphdr *, void *,
 654             const void *);
 655 int      tcp_reass(struct tcpcb *, struct tcphdr *, int *, struct mbuf *);
 656 void     tcp_reass_global_init(void);
 657 void     tcp_reass_flush(struct tcpcb *);
 658 void     tcp_input(struct mbuf *, int);
 659 u_long   tcp_maxmtu(struct in_conninfo *, int *);
 660 u_long   tcp_maxmtu6(struct in_conninfo *, int *);
 661 void     tcp_mss_update(struct tcpcb *, int, int, struct hc_metrics_lite *,
 662             int *);
 663 void     tcp_mss(struct tcpcb *, int);
 664 int      tcp_mssopt(struct in_conninfo *);
 665 struct inpcb *
 666          tcp_drop_syn_sent(struct inpcb *, int);
 667 struct inpcb *
 668          tcp_mtudisc(struct inpcb *, int);
 669 struct tcpcb *
 670          tcp_newtcpcb(struct inpcb *);
 671 int      tcp_output(struct tcpcb *);
 672 void     tcp_respond(struct tcpcb *, void *,
 673             struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
 674 void     tcp_tw_init(void);
 675 #ifdef VIMAGE
 676 void     tcp_tw_destroy(void);
 677 #endif
 678 void     tcp_tw_zone_change(void);
 679 int      tcp_twcheck(struct inpcb *, struct tcpopt *, struct tcphdr *,
 680             struct mbuf *, int);
 681 int      tcp_twrespond(struct tcptw *, int);
 682 void     tcp_setpersist(struct tcpcb *);
 683 #ifdef TCP_SIGNATURE
 684 int      tcp_signature_compute(struct mbuf *, int, int, int, u_char *, u_int);
 685 int      tcp_signature_verify(struct mbuf *, int, int, int, struct tcpopt *,
 686             struct tcphdr *, u_int);
 687 #endif
 688 void     tcp_slowtimo(void);
 689 struct tcptemp *
 690          tcpip_maketemplate(struct inpcb *);
 691 void     tcpip_fillheaders(struct inpcb *, void *, void *);
 692 void     tcp_timer_activate(struct tcpcb *, int, u_int);
 693 int      tcp_timer_active(struct tcpcb *, int);
 694 void     tcp_trace(short, short, struct tcpcb *, void *, struct tcphdr *, int);
 695 void     tcp_xmit_bandwidth_limit(struct tcpcb *tp, tcp_seq ack_seq);
 696 /*
 697  * All tcp_hc_* functions are IPv4 and IPv6 (via in_conninfo)
 698  */
 699 void     tcp_hc_init(void);
 700 #ifdef VIMAGE
 701 void     tcp_hc_destroy(void);
 702 #endif
 703 void     tcp_hc_get(struct in_conninfo *, struct hc_metrics_lite *);
 704 u_long   tcp_hc_getmtu(struct in_conninfo *);
 705 void     tcp_hc_updatemtu(struct in_conninfo *, u_long);
 706 void     tcp_hc_update(struct in_conninfo *, struct hc_metrics_lite *);
 707
 708 extern  struct pr_usrreqs tcp_usrreqs;
 709 extern  u_long tcp_sendspace;
 710 extern  u_long tcp_recvspace;
 711 tcp_seq tcp_new_isn(struct tcpcb *);
 712
 713 void     tcp_sack_doack(struct tcpcb *, struct tcpopt *, tcp_seq);
 714 void     tcp_update_sack_list(struct tcpcb *tp, tcp_seq rcv_laststart, tcp_seq rcv_lastend);
 715 void     tcp_clean_sackreport(struct tcpcb *tp);
 716 void     tcp_sack_adjust(struct tcpcb *tp);
 717 struct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt);
 718 void     tcp_sack_partialack(struct tcpcb *, struct tcphdr *);
 719 void     tcp_free_sackholes(struct tcpcb *tp);
 720 int      tcp_newreno(struct tcpcb *, struct tcphdr *);
 721 u_long   tcp_seq_subtract(u_long, u_long );
 722
 723 void    cc_cong_signal(struct tcpcb *tp, struct tcphdr *th, uint32_t type);
 724
 725 #endif /* _KERNEL */
 726
 727 #endif /* _NETINET_TCP_VAR_H_ */