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