tcp_var.h revision 215166
1139823Simp/*- 210937Swollman * Copyright (c) 1982, 1986, 1993, 1994, 1995 31541Srgrimes * The Regents of the University of California. All rights reserved. 41541Srgrimes * 51541Srgrimes * Redistribution and use in source and binary forms, with or without 61541Srgrimes * modification, are permitted provided that the following conditions 71541Srgrimes * are met: 81541Srgrimes * 1. Redistributions of source code must retain the above copyright 91541Srgrimes * notice, this list of conditions and the following disclaimer. 101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111541Srgrimes * notice, this list of conditions and the following disclaimer in the 121541Srgrimes * documentation and/or other materials provided with the distribution. 131541Srgrimes * 4. Neither the name of the University nor the names of its contributors 141541Srgrimes * may be used to endorse or promote products derived from this software 151541Srgrimes * without specific prior written permission. 161541Srgrimes * 171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 201541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 271541Srgrimes * SUCH DAMAGE. 281541Srgrimes * 2910937Swollman * @(#)tcp_var.h 8.4 (Berkeley) 5/24/95 3050477Speter * $FreeBSD: head/sys/netinet/tcp_var.h 215166 2010-11-12 06:41:55Z lstewart $ 311541Srgrimes */ 321541Srgrimes 332169Spaul#ifndef _NETINET_TCP_VAR_H_ 342169Spaul#define _NETINET_TCP_VAR_H_ 3586764Sjlemon 3698102Shsu#include <netinet/tcp.h> 3786764Sjlemon 38195699Srwatson#ifdef _KERNEL 39195699Srwatson#include <net/vnet.h> 40191688Szec 411541Srgrimes/* 421541Srgrimes * Kernel variables for tcp. 431541Srgrimes */ 44195699SrwatsonVNET_DECLARE(int, tcp_do_rfc1323); 45207369Sbz#define V_tcp_do_rfc1323 VNET(tcp_do_rfc1323) 46207369Sbz 47195699Srwatson#endif /* _KERNEL */ 48195699Srwatson 4955679Sshin/* TCP segment queue entry */ 5055679Sshinstruct tseg_qent { 5160938Sjake LIST_ENTRY(tseg_qent) tqe_q; 5255679Sshin int tqe_len; /* TCP segment data length */ 5355679Sshin struct tcphdr *tqe_th; /* a pointer to tcp header */ 5455679Sshin struct mbuf *tqe_m; /* mbuf contains packet */ 5555679Sshin}; 5660938SjakeLIST_HEAD(tsegqe_head, tseg_qent); 5755679Sshin 58130989Spsstruct sackblk { 59130989Sps tcp_seq start; /* start seq no. of sack block */ 60131078Sbms tcp_seq end; /* end seq no. */ 61130989Sps}; 62130989Sps 63130989Spsstruct sackhole { 64130989Sps tcp_seq start; /* start seq no. of hole */ 65130989Sps tcp_seq end; /* end seq no. */ 66130989Sps tcp_seq rxmit; /* next seq. no in hole to be retransmitted */ 67145370Sps TAILQ_ENTRY(sackhole) scblink; /* scoreboard linkage */ 68130989Sps}; 69131078Sbms 70146123Spsstruct sackhint { 71146123Sps struct sackhole *nexthole; 72146123Sps int sack_bytes_rexmit; 73195634Slstewart 74195634Slstewart int ispare; /* explicit pad for 64bit alignment */ 75195634Slstewart uint64_t _pad[2]; /* 1 sacked_bytes, 1 TBD */ 76146123Sps}; 77146123Sps 7855679Sshinstruct tcptemp { 7955679Sshin u_char tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */ 8055679Sshin struct tcphdr tt_t; 8155679Sshin}; 8255679Sshin 8355679Sshin#define tcp6cb tcpcb /* for KAME src sync over BSD*'s */ 8455679Sshin 85169541Sandre/* Neighbor Discovery, Neighbor Unreachability Detection Upper layer hint. */ 86169541Sandre#ifdef INET6 87169541Sandre#define ND6_HINT(tp) \ 88169541Sandredo { \ 89169541Sandre if ((tp) && (tp)->t_inpcb && \ 90169541Sandre ((tp)->t_inpcb->inp_vflag & INP_IPV6) != 0) \ 91169541Sandre nd6_nud_hint(NULL, NULL, 0); \ 92169541Sandre} while (0) 93169541Sandre#else 94169541Sandre#define ND6_HINT(tp) 95169541Sandre#endif 96169541Sandre 971541Srgrimes/* 981541Srgrimes * Tcp control block, one per tcp; fields: 9932821Sdg * Organized for 16 byte cacheline efficiency. 1001541Srgrimes */ 1011541Srgrimesstruct tcpcb { 102126193Sandre struct tsegqe_head t_segq; /* segment reassembly queue */ 103195634Slstewart void *t_pspare[2]; /* new reassembly queue */ 104126193Sandre int t_segqlen; /* segment reassembly queue length */ 10532821Sdg int t_dupacks; /* consecutive dup acks recd */ 10632821Sdg 107172309Ssilby struct tcp_timer *t_timers; /* All the TCP timers in one struct */ 10832821Sdg 10932821Sdg struct inpcb *t_inpcb; /* back pointer to internet pcb */ 11011187Swollman int t_state; /* state of this connection */ 11111187Swollman u_int t_flags; 1121541Srgrimes 113191688Szec struct vnet *t_vnet; /* back pointer to parent vnet */ 114191688Szec 1151541Srgrimes tcp_seq snd_una; /* send unacknowledged */ 11632821Sdg tcp_seq snd_max; /* highest sequence number sent; 11732821Sdg * used to recognize retransmits 11832821Sdg */ 1191541Srgrimes tcp_seq snd_nxt; /* send next */ 1201541Srgrimes tcp_seq snd_up; /* send urgent pointer */ 12132821Sdg 1221541Srgrimes tcp_seq snd_wl1; /* window update seg seq number */ 1231541Srgrimes tcp_seq snd_wl2; /* window update seg ack number */ 1241541Srgrimes tcp_seq iss; /* initial send sequence number */ 12532821Sdg tcp_seq irs; /* initial receive sequence number */ 12632821Sdg 12732821Sdg tcp_seq rcv_nxt; /* receive next */ 12832821Sdg tcp_seq rcv_adv; /* advertised window */ 1291541Srgrimes u_long rcv_wnd; /* receive window */ 1301541Srgrimes tcp_seq rcv_up; /* receive urgent pointer */ 13132821Sdg 13232821Sdg u_long snd_wnd; /* send window */ 1331541Srgrimes u_long snd_cwnd; /* congestion-controlled window */ 134212765Sandre u_long snd_spare1; /* unused */ 13513765Smpp u_long snd_ssthresh; /* snd_cwnd size threshold for 1361541Srgrimes * for slow start exponential to 1371541Srgrimes * linear switch 1381541Srgrimes */ 139212765Sandre u_long snd_spare2; /* unused */ 140109175Shsu tcp_seq snd_recover; /* for use in NewReno Fast Recovery */ 14160067Sjlemon 14232821Sdg u_int t_maxopd; /* mss plus options */ 14332821Sdg 144194303Sjhb u_int t_rcvtime; /* inactivity time */ 145194303Sjhb u_int t_starttime; /* time connection was established */ 146194303Sjhb u_int t_rtttime; /* RTT measurement start time */ 1471541Srgrimes tcp_seq t_rtseq; /* sequence number being timed */ 14832821Sdg 149212765Sandre u_int t_bw_spare1; /* unused */ 150212765Sandre tcp_seq t_bw_spare2; /* unused */ 151102017Sdillon 15250673Sjlemon int t_rxtcur; /* current retransmit value (ticks) */ 15332821Sdg u_int t_maxseg; /* maximum segment size */ 15411187Swollman int t_srtt; /* smoothed round-trip time */ 15511187Swollman int t_rttvar; /* variance in round-trip time */ 15632821Sdg 15732821Sdg int t_rxtshift; /* log(2) of rexmt exp. backoff */ 15811187Swollman u_int t_rttmin; /* minimum rtt allowed */ 159102017Sdillon u_int t_rttbest; /* best rtt we've seen */ 16032821Sdg u_long t_rttupdated; /* number of times rtt sampled */ 1611541Srgrimes u_long max_sndwnd; /* largest window peer has offered */ 1621541Srgrimes 16332821Sdg int t_softerror; /* possible error not yet reported */ 1641541Srgrimes/* out-of-band data */ 1651541Srgrimes char t_oobflags; /* have some */ 1661541Srgrimes char t_iobc; /* input character */ 1671541Srgrimes/* RFC 1323 variables */ 1681541Srgrimes u_char snd_scale; /* window scaling for send window */ 1691541Srgrimes u_char rcv_scale; /* window scaling for recv window */ 1701541Srgrimes u_char request_r_scale; /* pending window scaling */ 171162277Sandre u_int32_t ts_recent; /* timestamp echo data */ 172194303Sjhb u_int ts_recent_age; /* when last updated */ 173162277Sandre u_int32_t ts_offset; /* our timestamp offset */ 17432821Sdg 1751541Srgrimes tcp_seq last_ack_sent; 17650673Sjlemon/* experimental */ 17750673Sjlemon u_long snd_cwnd_prev; /* cwnd prior to retransmit */ 17850673Sjlemon u_long snd_ssthresh_prev; /* ssthresh prior to retransmit */ 179117650Shsu tcp_seq snd_recover_prev; /* snd_recover prior to retransmit */ 180194303Sjhb u_int t_badrxtwin; /* window for retransmit recovery */ 181112957Shsu u_char snd_limited; /* segments limited transmitted */ 182131078Sbms/* SACK related state */ 183130989Sps int snd_numholes; /* number of holes seen by sender */ 184146953Sps TAILQ_HEAD(sackhole_head, sackhole) snd_holes; 185146953Sps /* SACK scoreboard (sorted) */ 186146630Sps tcp_seq snd_fack; /* last seq number(+1) sack'd by rcv'r*/ 187130989Sps int rcv_numsacks; /* # distinct sack blks present */ 188130989Sps struct sackblk sackblks[MAX_SACK_BLKS]; /* seq nos. of sack blocks */ 189136151Sps tcp_seq sack_newdata; /* New data xmitted in this recovery 190136151Sps episode starts at this seq number */ 191146123Sps struct sackhint sackhint; /* SACK scoreboard hint */ 192155767Sandre int t_rttlow; /* smallest observerved RTT */ 193166405Sandre u_int32_t rfbuf_ts; /* recv buffer autoscaling timestamp */ 194166405Sandre int rfbuf_cnt; /* recv buffer autoscaling byte count */ 195191688Szec struct toe_usrreqs *t_tu; /* offload operations vector */ 196174560Skmacy void *t_toe; /* TOE pcb pointer */ 197187289Slstewart int t_bytes_acked; /* # bytes acked during current RTT */ 198215166Slstewart struct cc_algo *cc_algo; /* congestion control algorithm */ 199215166Slstewart struct cc_var *ccv; 200195634Slstewart 201195634Slstewart int t_ispare; /* explicit pad for 64bit alignment */ 202215166Slstewart void *t_pspare2[4]; /* 4 TBD */ 203195634Slstewart uint64_t _pad[12]; /* 7 UTO, 5 TBD (1-2 CC/RTT?) */ 2041541Srgrimes}; 2051541Srgrimes 206185855Srwatson/* 207185855Srwatson * Flags and utility macros for the t_flags field. 208185855Srwatson */ 209185855Srwatson#define TF_ACKNOW 0x000001 /* ack peer immediately */ 210185855Srwatson#define TF_DELACK 0x000002 /* ack, but try to delay it */ 211185855Srwatson#define TF_NODELAY 0x000004 /* don't delay packets to coalesce */ 212185855Srwatson#define TF_NOOPT 0x000008 /* don't use tcp options */ 213185855Srwatson#define TF_SENTFIN 0x000010 /* have sent FIN */ 214185855Srwatson#define TF_REQ_SCALE 0x000020 /* have/will request window scaling */ 215185855Srwatson#define TF_RCVD_SCALE 0x000040 /* other side has requested scaling */ 216185855Srwatson#define TF_REQ_TSTMP 0x000080 /* have/will request timestamps */ 217185855Srwatson#define TF_RCVD_TSTMP 0x000100 /* a timestamp was received in SYN */ 218185855Srwatson#define TF_SACK_PERMIT 0x000200 /* other side said I could SACK */ 219185855Srwatson#define TF_NEEDSYN 0x000400 /* send SYN (implicit state) */ 220185855Srwatson#define TF_NEEDFIN 0x000800 /* send FIN (implicit state) */ 221185855Srwatson#define TF_NOPUSH 0x001000 /* don't push */ 222185855Srwatson#define TF_MORETOCOME 0x010000 /* More data to be appended to sock */ 223185855Srwatson#define TF_LQ_OVERFLOW 0x020000 /* listen queue overflow */ 224185855Srwatson#define TF_LASTIDLE 0x040000 /* connection was previously idle */ 225185855Srwatson#define TF_RXWIN0SENT 0x080000 /* sent a receiver win 0 in response */ 226185855Srwatson#define TF_FASTRECOVERY 0x100000 /* in NewReno Fast Recovery */ 227185855Srwatson#define TF_WASFRECOVERY 0x200000 /* was in NewReno Fast Recovery */ 228185855Srwatson#define TF_SIGNATURE 0x400000 /* require MD5 digests (RFC2385) */ 229185855Srwatson#define TF_FORCEDATA 0x800000 /* force out a byte */ 230185855Srwatson#define TF_TSO 0x1000000 /* TSO enabled on this connection */ 231185855Srwatson#define TF_TOE 0x2000000 /* this connection is offloaded */ 232185855Srwatson#define TF_ECN_PERMIT 0x4000000 /* connection ECN-ready */ 233185855Srwatson#define TF_ECN_SND_CWR 0x8000000 /* ECN CWR in queue */ 234185855Srwatson#define TF_ECN_SND_ECE 0x10000000 /* ECN ECE in queue */ 235215166Slstewart#define TF_CONGRECOVERY 0x20000000 /* congestion recovery mode */ 236215166Slstewart#define TF_WASCRECOVERY 0x40000000 /* was in congestion recovery */ 237185855Srwatson 238215166Slstewart#define IN_FASTRECOVERY(t_flags) (t_flags & TF_FASTRECOVERY) 239215166Slstewart#define ENTER_FASTRECOVERY(t_flags) t_flags |= TF_FASTRECOVERY 240215166Slstewart#define EXIT_FASTRECOVERY(t_flags) t_flags &= ~TF_FASTRECOVERY 241117650Shsu 242215166Slstewart#define IN_CONGRECOVERY(t_flags) (t_flags & TF_CONGRECOVERY) 243215166Slstewart#define ENTER_CONGRECOVERY(t_flags) t_flags |= TF_CONGRECOVERY 244215166Slstewart#define EXIT_CONGRECOVERY(t_flags) t_flags &= ~TF_CONGRECOVERY 245215166Slstewart 246215166Slstewart#define IN_RECOVERY(t_flags) (t_flags & (TF_CONGRECOVERY | TF_FASTRECOVERY)) 247215166Slstewart#define ENTER_RECOVERY(t_flags) t_flags |= (TF_CONGRECOVERY | TF_FASTRECOVERY) 248215166Slstewart#define EXIT_RECOVERY(t_flags) t_flags &= ~(TF_CONGRECOVERY | TF_FASTRECOVERY) 249215166Slstewart 250215166Slstewart#define BYTES_THIS_ACK(tp, th) (th->th_ack - tp->snd_una) 251215166Slstewart 252185855Srwatson/* 253185855Srwatson * Flags for the t_oobflags field. 254185855Srwatson */ 255185855Srwatson#define TCPOOB_HAVEDATA 0x01 256185855Srwatson#define TCPOOB_HADDATA 0x02 257185855Srwatson 258125680Sbms#ifdef TCP_SIGNATURE 2596247Swollman/* 260125680Sbms * Defines which are needed by the xform_tcp module and tcp_[in|out]put 261125680Sbms * for SADB verification and lookup. 262125680Sbms */ 263125680Sbms#define TCP_SIGLEN 16 /* length of computed digest in bytes */ 264125680Sbms#define TCP_KEYLEN_MIN 1 /* minimum length of TCP-MD5 key */ 265125680Sbms#define TCP_KEYLEN_MAX 80 /* maximum length of TCP-MD5 key */ 266125680Sbms/* 267125680Sbms * Only a single SA per host may be specified at this time. An SPI is 268125680Sbms * needed in order for the KEY_ALLOCSA() lookup to work. 269125680Sbms */ 270125680Sbms#define TCP_SIG_SPI 0x1000 271125680Sbms#endif /* TCP_SIGNATURE */ 272125680Sbms 273125680Sbms/* 2746247Swollman * Structure to hold TCP options that are only used during segment 2756247Swollman * processing (in tcp_input), but not held in the tcpcb. 2766247Swollman * It's basically used to reduce the number of parameters 277167606Sandre * to tcp_dooptions and tcp_addoptions. 278167606Sandre * The binary order of the to_flags is relevant for packing of the 279167606Sandre * options in tcp_addoptions. 2806247Swollman */ 2816247Swollmanstruct tcpopt { 282195654Slstewart u_int64_t to_flags; /* which options are present */ 283167606Sandre#define TOF_MSS 0x0001 /* maximum segment size */ 284167606Sandre#define TOF_SCALE 0x0002 /* window scaling */ 285178349Sbz#define TOF_SACKPERM 0x0004 /* SACK permitted */ 286167606Sandre#define TOF_TS 0x0010 /* timestamp */ 287178349Sbz#define TOF_SIGNATURE 0x0040 /* TCP-MD5 signature option (RFC2385) */ 288168906Sandre#define TOF_SACK 0x0080 /* Peer sent SACK option */ 289168906Sandre#define TOF_MAXOPT 0x0100 290168906Sandre u_int32_t to_tsval; /* new timestamp */ 291167606Sandre u_int32_t to_tsecr; /* reflected timestamp */ 292195654Slstewart u_char *to_sacks; /* pointer to the first SACK blocks */ 293195654Slstewart u_char *to_signature; /* pointer to the TCP-MD5 signature */ 294167606Sandre u_int16_t to_mss; /* maximum segment size */ 295167606Sandre u_int8_t to_wscale; /* window scaling */ 296147637Sps u_int8_t to_nsacks; /* number of SACK blocks */ 2976247Swollman}; 2986247Swollman 299159949Sandre/* 300159949Sandre * Flags for tcp_dooptions. 301159949Sandre */ 302159949Sandre#define TO_SYN 0x01 /* parse SYN-only options */ 303159949Sandre 304122922Sandrestruct hc_metrics_lite { /* must stay in sync with hc_metrics */ 305122922Sandre u_long rmx_mtu; /* MTU for this path */ 306122922Sandre u_long rmx_ssthresh; /* outbound gateway buffer limit */ 307122922Sandre u_long rmx_rtt; /* estimated round trip time */ 308122922Sandre u_long rmx_rttvar; /* estimated rtt variance */ 309122922Sandre u_long rmx_bandwidth; /* estimated bandwidth */ 310122922Sandre u_long rmx_cwnd; /* congestion window */ 311122922Sandre u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 312122922Sandre u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 313122922Sandre}; 314122922Sandre 315159725Sandre#ifndef _NETINET_IN_PCB_H_ 316159725Sandrestruct in_conninfo; 317159725Sandre#endif /* _NETINET_IN_PCB_H_ */ 318159725Sandre 319111145Sjlemonstruct tcptw { 320111145Sjlemon struct inpcb *tw_inpcb; /* XXX back pointer to internet pcb */ 321111145Sjlemon tcp_seq snd_nxt; 322111145Sjlemon tcp_seq rcv_nxt; 323121850Ssilby tcp_seq iss; 324121884Ssilby tcp_seq irs; 325111145Sjlemon u_short last_win; /* cached window value */ 326111145Sjlemon u_short tw_so_options; /* copy of so_options */ 327111145Sjlemon struct ucred *tw_cred; /* user credentials */ 328194303Sjhb u_int32_t t_recent; 329169477Sandre u_int32_t ts_offset; /* our timestamp offset */ 330194303Sjhb u_int t_starttime; 331112009Sjlemon int tw_time; 332162111Sru TAILQ_ENTRY(tcptw) tw_2msl; 333111145Sjlemon}; 334133874Srwatson 3351541Srgrimes#define intotcpcb(ip) ((struct tcpcb *)(ip)->inp_ppcb) 336111145Sjlemon#define intotw(ip) ((struct tcptw *)(ip)->inp_ppcb) 3371541Srgrimes#define sototcpcb(so) (intotcpcb(sotoinpcb(so))) 3381541Srgrimes 3391541Srgrimes/* 3401541Srgrimes * The smoothed round-trip time and estimated variance 3411541Srgrimes * are stored as fixed point numbers scaled by the values below. 3421541Srgrimes * For convenience, these scales are also used in smoothing the average 3431541Srgrimes * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed). 3441541Srgrimes * With these scales, srtt has 3 bits to the right of the binary point, 3451541Srgrimes * and thus an "ALPHA" of 0.875. rttvar has 2 bits to the right of the 3461541Srgrimes * binary point, and is smoothed with an ALPHA of 0.75. 3471541Srgrimes */ 34814753Swollman#define TCP_RTT_SCALE 32 /* multiplier for srtt; 3 bits frac. */ 34914753Swollman#define TCP_RTT_SHIFT 5 /* shift for srtt; 3 bits frac. */ 35014753Swollman#define TCP_RTTVAR_SCALE 16 /* multiplier for rttvar; 2 bits */ 35114753Swollman#define TCP_RTTVAR_SHIFT 4 /* shift for rttvar; 2 bits */ 35214753Swollman#define TCP_DELTA_SHIFT 2 /* see tcp_input.c */ 3531541Srgrimes 3541541Srgrimes/* 3551541Srgrimes * The initial retransmission should happen at rtt + 4 * rttvar. 3561541Srgrimes * Because of the way we do the smoothing, srtt and rttvar 3571541Srgrimes * will each average +1/2 tick of bias. When we compute 3581541Srgrimes * the retransmit timer, we want 1/2 tick of rounding and 3591541Srgrimes * 1 extra tick because of +-1/2 tick uncertainty in the 3601541Srgrimes * firing of the timer. The bias will give us exactly the 3611541Srgrimes * 1.5 tick we need. But, because the bias is 3621541Srgrimes * statistical, we have to test that we don't drop below 3631541Srgrimes * the minimum feasible timer (which is 2 ticks). 36414753Swollman * This version of the macro adapted from a paper by Lawrence 36514753Swollman * Brakmo and Larry Peterson which outlines a problem caused 36614753Swollman * by insufficient precision in the original implementation, 36714753Swollman * which results in inappropriately large RTO values for very 36814753Swollman * fast networks. 3691541Srgrimes */ 3701541Srgrimes#define TCP_REXMTVAL(tp) \ 37135419Sdg max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT)) \ 37216141Swollman + (tp)->t_rttvar) >> TCP_DELTA_SHIFT) 3731541Srgrimes 3741541Srgrimes/* 3751541Srgrimes * TCP statistics. 3761541Srgrimes * Many of these should be kept per connection, 3771541Srgrimes * but that's inconvenient at the moment. 3781541Srgrimes */ 3791541Srgrimesstruct tcpstat { 3801541Srgrimes u_long tcps_connattempt; /* connections initiated */ 3811541Srgrimes u_long tcps_accepts; /* connections accepted */ 3821541Srgrimes u_long tcps_connects; /* connections established */ 3831541Srgrimes u_long tcps_drops; /* connections dropped */ 3841541Srgrimes u_long tcps_conndrops; /* embryonic connections dropped */ 385124258Sandre u_long tcps_minmssdrops; /* average minmss too low drops */ 3861541Srgrimes u_long tcps_closed; /* conn. closed (includes drops) */ 3871541Srgrimes u_long tcps_segstimed; /* segs where we tried to get rtt */ 3881541Srgrimes u_long tcps_rttupdated; /* times we succeeded */ 3891541Srgrimes u_long tcps_delack; /* delayed acks sent */ 3901541Srgrimes u_long tcps_timeoutdrop; /* conn. dropped in rxmt timeout */ 3911541Srgrimes u_long tcps_rexmttimeo; /* retransmit timeouts */ 3921541Srgrimes u_long tcps_persisttimeo; /* persist timeouts */ 3931541Srgrimes u_long tcps_keeptimeo; /* keepalive timeouts */ 3941541Srgrimes u_long tcps_keepprobe; /* keepalive probes sent */ 3951541Srgrimes u_long tcps_keepdrops; /* connections dropped in keepalive */ 3961541Srgrimes 3971541Srgrimes u_long tcps_sndtotal; /* total packets sent */ 3981541Srgrimes u_long tcps_sndpack; /* data packets sent */ 3991541Srgrimes u_long tcps_sndbyte; /* data bytes sent */ 4001541Srgrimes u_long tcps_sndrexmitpack; /* data packets retransmitted */ 4011541Srgrimes u_long tcps_sndrexmitbyte; /* data bytes retransmitted */ 402100373Sdillon u_long tcps_sndrexmitbad; /* unnecessary packet retransmissions */ 4031541Srgrimes u_long tcps_sndacks; /* ack-only packets sent */ 4041541Srgrimes u_long tcps_sndprobe; /* window probes sent */ 4051541Srgrimes u_long tcps_sndurg; /* packets sent with URG only */ 4061541Srgrimes u_long tcps_sndwinup; /* window update-only packets sent */ 4071541Srgrimes u_long tcps_sndctrl; /* control (SYN|FIN|RST) packets sent */ 4081541Srgrimes 4091541Srgrimes u_long tcps_rcvtotal; /* total packets received */ 4101541Srgrimes u_long tcps_rcvpack; /* packets received in sequence */ 4111541Srgrimes u_long tcps_rcvbyte; /* bytes received in sequence */ 4121541Srgrimes u_long tcps_rcvbadsum; /* packets received with ccksum errs */ 4131541Srgrimes u_long tcps_rcvbadoff; /* packets received with bad offset */ 41452904Sshin u_long tcps_rcvmemdrop; /* packets dropped for lack of memory */ 4151541Srgrimes u_long tcps_rcvshort; /* packets received too short */ 4161541Srgrimes u_long tcps_rcvduppack; /* duplicate-only packets received */ 4171541Srgrimes u_long tcps_rcvdupbyte; /* duplicate-only bytes received */ 4181541Srgrimes u_long tcps_rcvpartduppack; /* packets with some duplicate data */ 4191541Srgrimes u_long tcps_rcvpartdupbyte; /* dup. bytes in part-dup. packets */ 4201541Srgrimes u_long tcps_rcvoopack; /* out-of-order packets received */ 4211541Srgrimes u_long tcps_rcvoobyte; /* out-of-order bytes received */ 4221541Srgrimes u_long tcps_rcvpackafterwin; /* packets with data after window */ 4231541Srgrimes u_long tcps_rcvbyteafterwin; /* bytes rcvd after window */ 4241541Srgrimes u_long tcps_rcvafterclose; /* packets rcvd after "close" */ 4251541Srgrimes u_long tcps_rcvwinprobe; /* rcvd window probe packets */ 4261541Srgrimes u_long tcps_rcvdupack; /* rcvd duplicate acks */ 4271541Srgrimes u_long tcps_rcvacktoomuch; /* rcvd acks for unsent data */ 4281541Srgrimes u_long tcps_rcvackpack; /* rcvd ack packets */ 4291541Srgrimes u_long tcps_rcvackbyte; /* bytes acked by rcvd acks */ 4301541Srgrimes u_long tcps_rcvwinupd; /* rcvd window update packets */ 4311541Srgrimes u_long tcps_pawsdrop; /* segments dropped due to PAWS */ 4321541Srgrimes u_long tcps_predack; /* times hdr predict ok for acks */ 4331541Srgrimes u_long tcps_preddat; /* times hdr predict ok for data pkts */ 4341541Srgrimes u_long tcps_pcbcachemiss; 4359263Swollman u_long tcps_cachedrtt; /* times cached RTT in route updated */ 4369263Swollman u_long tcps_cachedrttvar; /* times cached rttvar updated */ 4379263Swollman u_long tcps_cachedssthresh; /* times cached ssthresh updated */ 4389470Swollman u_long tcps_usedrtt; /* times RTT initialized from route */ 4399470Swollman u_long tcps_usedrttvar; /* times RTTVAR initialized from rt */ 4409470Swollman u_long tcps_usedssthresh; /* times ssthresh initialized from rt*/ 44110937Swollman u_long tcps_persistdrop; /* timeout in persist state */ 44210937Swollman u_long tcps_badsyn; /* bogus SYN, e.g. premature ACK */ 44311415Swollman u_long tcps_mturesent; /* resends due to MTU discovery */ 44414281Sbde u_long tcps_listendrop; /* listen queue overflows */ 445128653Ssilby u_long tcps_badrst; /* ignored RSTs in the window */ 44686764Sjlemon 44786764Sjlemon u_long tcps_sc_added; /* entry added to syncache */ 44886764Sjlemon u_long tcps_sc_retransmitted; /* syncache entry was retransmitted */ 44986764Sjlemon u_long tcps_sc_dupsyn; /* duplicate SYN packet */ 45086764Sjlemon u_long tcps_sc_dropped; /* could not reply to packet */ 45186764Sjlemon u_long tcps_sc_completed; /* successful extraction of entry */ 45286764Sjlemon u_long tcps_sc_bucketoverflow; /* syncache per-bucket limit hit */ 45386764Sjlemon u_long tcps_sc_cacheoverflow; /* syncache cache limit hit */ 45486764Sjlemon u_long tcps_sc_reset; /* RST removed entry from syncache */ 45586764Sjlemon u_long tcps_sc_stale; /* timed out or listen socket gone */ 45686764Sjlemon u_long tcps_sc_aborted; /* syncache entry aborted */ 45786764Sjlemon u_long tcps_sc_badack; /* removed due to bad ACK */ 45886764Sjlemon u_long tcps_sc_unreach; /* ICMP unreachable received */ 45986764Sjlemon u_long tcps_sc_zonefail; /* zalloc() failed */ 46086764Sjlemon u_long tcps_sc_sendcookie; /* SYN cookie sent */ 46186764Sjlemon u_long tcps_sc_recvcookie; /* SYN cookie received */ 462122922Sandre 463122922Sandre u_long tcps_hc_added; /* entry added to hostcache */ 464122922Sandre u_long tcps_hc_bucketoverflow; /* hostcache per bucket limit hit */ 465130989Sps 466167036Smohans u_long tcps_finwait2_drops; /* Drop FIN_WAIT_2 connection after time limit */ 467167036Smohans 468130989Sps /* SACK related stats */ 469130989Sps u_long tcps_sack_recovery_episode; /* SACK recovery episodes */ 470130989Sps u_long tcps_sack_rexmits; /* SACK rexmit segments */ 471133874Srwatson u_long tcps_sack_rexmit_bytes; /* SACK rexmit bytes */ 472130989Sps u_long tcps_sack_rcv_blocks; /* SACK blocks (options) received */ 473130989Sps u_long tcps_sack_send_blocks; /* SACK blocks (options) sent */ 474143339Sps u_long tcps_sack_sboverflow; /* times scoreboard overflowed */ 475181056Srpaulo 476181056Srpaulo /* ECN related stats */ 477181056Srpaulo u_long tcps_ecn_ce; /* ECN Congestion Experienced */ 478181056Srpaulo u_long tcps_ecn_ect0; /* ECN Capable Transport */ 479181056Srpaulo u_long tcps_ecn_ect1; /* ECN Capable Transport */ 480181056Srpaulo u_long tcps_ecn_shs; /* ECN successful handshakes */ 481181056Srpaulo u_long tcps_ecn_rcwnd; /* # times ECN reduced the cwnd */ 482195634Slstewart 483195634Slstewart u_long _pad[12]; /* 6 UTO, 6 TBD */ 4841541Srgrimes}; 4851541Srgrimes 486190978Srwatson#ifdef _KERNEL 487196039Srwatson/* 488196039Srwatson * In-kernel consumers can use these accessor macros directly to update 489196039Srwatson * stats. 490196039Srwatson */ 491190948Srwatson#define TCPSTAT_ADD(name, val) V_tcpstat.name += (val) 492190948Srwatson#define TCPSTAT_INC(name) TCPSTAT_ADD(name, 1) 493196039Srwatson 494196039Srwatson/* 495196039Srwatson * Kernel module consumers must use this accessor macro. 496196039Srwatson */ 497196039Srwatsonvoid kmod_tcpstat_inc(int statnum); 498196039Srwatson#define KMOD_TCPSTAT_INC(name) \ 499196039Srwatson kmod_tcpstat_inc(offsetof(struct tcpstat, name) / sizeof(u_long)) 500190978Srwatson#endif 501190948Srwatson 5026247Swollman/* 50336079Swollman * TCB structure exported to user-land via sysctl(3). 50437183Sjhay * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been 50537183Sjhay * included. Not all of our clients do. 50636079Swollman */ 50737183Sjhay#if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_) 508197244Ssilbystruct xtcp_timer { 509197244Ssilby int tt_rexmt; /* retransmit timer */ 510197244Ssilby int tt_persist; /* retransmit persistence */ 511197244Ssilby int tt_keep; /* keepalive */ 512197244Ssilby int tt_2msl; /* 2*msl TIME_WAIT timer */ 513197244Ssilby int tt_delack; /* delayed ACK timer */ 514197244Ssilby int t_rcvtime; /* Time since last packet received */ 515197244Ssilby}; 51636079Swollmanstruct xtcpcb { 51736079Swollman size_t xt_len; 51836079Swollman struct inpcb xt_inp; 51936079Swollman struct tcpcb xt_tp; 52036079Swollman struct xsocket xt_socket; 521197244Ssilby struct xtcp_timer xt_timer; 52236079Swollman u_quad_t xt_alignment_hack; 52336079Swollman}; 52436079Swollman#endif 52536079Swollman 52636079Swollman/* 5276247Swollman * Names for TCP sysctl objects 5286247Swollman */ 5296247Swollman#define TCPCTL_DO_RFC1323 1 /* use RFC-1323 extensions */ 5306247Swollman#define TCPCTL_MSSDFLT 3 /* MSS default */ 5316472Swollman#define TCPCTL_STATS 4 /* statistics (read-only) */ 5326472Swollman#define TCPCTL_RTTDFLT 5 /* default RTT estimate */ 5336472Swollman#define TCPCTL_KEEPIDLE 6 /* keepalive idle timer */ 5346472Swollman#define TCPCTL_KEEPINTVL 7 /* interval to send keepalives */ 53518281Spst#define TCPCTL_SENDSPACE 8 /* send buffer space */ 53618281Spst#define TCPCTL_RECVSPACE 9 /* receive buffer space */ 53763431Ssheldonh#define TCPCTL_KEEPINIT 10 /* timeout for establishing syn */ 53836079Swollman#define TCPCTL_PCBLIST 11 /* list of all outstanding PCBs */ 53950673Sjlemon#define TCPCTL_DELACKTIME 12 /* time before sending delayed ACK */ 54052904Sshin#define TCPCTL_V6MSSDFLT 13 /* MSS default for IPv6 */ 541130989Sps#define TCPCTL_SACK 14 /* Selective Acknowledgement,rfc 2018 */ 542141381Smaxim#define TCPCTL_DROP 15 /* drop tcp connection */ 543141381Smaxim#define TCPCTL_MAXID 16 544167036Smohans#define TCPCTL_FINWAIT2_TIMEOUT 17 5456247Swollman 5466247Swollman#define TCPCTL_NAMES { \ 5476247Swollman { 0, 0 }, \ 5486348Swollman { "rfc1323", CTLTYPE_INT }, \ 5496247Swollman { "mssdflt", CTLTYPE_INT }, \ 5506472Swollman { "stats", CTLTYPE_STRUCT }, \ 5516472Swollman { "rttdflt", CTLTYPE_INT }, \ 5526472Swollman { "keepidle", CTLTYPE_INT }, \ 5536472Swollman { "keepintvl", CTLTYPE_INT }, \ 5546472Swollman { "sendspace", CTLTYPE_INT }, \ 5556472Swollman { "recvspace", CTLTYPE_INT }, \ 55618281Spst { "keepinit", CTLTYPE_INT }, \ 55736079Swollman { "pcblist", CTLTYPE_STRUCT }, \ 55850673Sjlemon { "delacktime", CTLTYPE_INT }, \ 55952904Sshin { "v6mssdflt", CTLTYPE_INT }, \ 560122922Sandre { "maxid", CTLTYPE_INT }, \ 5616247Swollman} 5626247Swollman 56344078Sdfr 56455205Speter#ifdef _KERNEL 56544078Sdfr#ifdef SYSCTL_DECL 56644078SdfrSYSCTL_DECL(_net_inet_tcp); 567136151SpsSYSCTL_DECL(_net_inet_tcp_sack); 568169683SandreMALLOC_DECLARE(M_TCPLOG); 56944078Sdfr#endif 57044078Sdfr 571195699SrwatsonVNET_DECLARE(struct inpcbhead, tcb); /* queue of active tcpcb's */ 572195699SrwatsonVNET_DECLARE(struct inpcbinfo, tcbinfo); 573195699SrwatsonVNET_DECLARE(struct tcpstat, tcpstat); /* tcp statistics */ 574207369Sbzextern int tcp_log_in_vain; 575195699SrwatsonVNET_DECLARE(int, tcp_mssdflt); /* XXX */ 576195699SrwatsonVNET_DECLARE(int, tcp_minmss); 577195699SrwatsonVNET_DECLARE(int, tcp_delack_enabled); 578211464SandreVNET_DECLARE(int, tcp_do_rfc3390); 579195699SrwatsonVNET_DECLARE(int, path_mtu_discovery); 580195699SrwatsonVNET_DECLARE(int, ss_fltsz); 581195699SrwatsonVNET_DECLARE(int, ss_fltsz_local); 582215166SlstewartVNET_DECLARE(int, tcp_do_rfc3465); 583215166SlstewartVNET_DECLARE(int, tcp_abc_l_var); 584195727Srwatson#define V_tcb VNET(tcb) 585195727Srwatson#define V_tcbinfo VNET(tcbinfo) 586195727Srwatson#define V_tcpstat VNET(tcpstat) 587195727Srwatson#define V_tcp_mssdflt VNET(tcp_mssdflt) 588195727Srwatson#define V_tcp_minmss VNET(tcp_minmss) 589195727Srwatson#define V_tcp_delack_enabled VNET(tcp_delack_enabled) 590211464Sandre#define V_tcp_do_rfc3390 VNET(tcp_do_rfc3390) 591195727Srwatson#define V_path_mtu_discovery VNET(path_mtu_discovery) 592195727Srwatson#define V_ss_fltsz VNET(ss_fltsz) 593195727Srwatson#define V_ss_fltsz_local VNET(ss_fltsz_local) 594215166Slstewart#define V_tcp_do_rfc3465 VNET(tcp_do_rfc3465) 595215166Slstewart#define V_tcp_abc_l_var VNET(tcp_abc_l_var) 596185088Szec 597195699SrwatsonVNET_DECLARE(int, tcp_do_sack); /* SACK enabled/disabled */ 598195699SrwatsonVNET_DECLARE(int, tcp_sc_rst_sock_fail); /* RST on sock alloc failure */ 599207369Sbz#define V_tcp_do_sack VNET(tcp_do_sack) 600207369Sbz#define V_tcp_sc_rst_sock_fail VNET(tcp_sc_rst_sock_fail) 601207369Sbz 602195699SrwatsonVNET_DECLARE(int, tcp_do_ecn); /* TCP ECN enabled/disabled */ 603195699SrwatsonVNET_DECLARE(int, tcp_ecn_maxretries); 604195727Srwatson#define V_tcp_do_ecn VNET(tcp_do_ecn) 605195727Srwatson#define V_tcp_ecn_maxretries VNET(tcp_ecn_maxretries) 606195699Srwatson 607167606Sandreint tcp_addoptions(struct tcpopt *, u_char *); 6081541Srgrimesstruct tcpcb * 60992723Salfred tcp_close(struct tcpcb *); 610157376Srwatsonvoid tcp_discardcb(struct tcpcb *); 611111145Sjlemonvoid tcp_twstart(struct tcpcb *); 612162064Sglebius#if 0 613121850Ssilbyint tcp_twrecycleable(struct tcptw *tw); 614162064Sglebius#endif 615157376Srwatsonvoid tcp_twclose(struct tcptw *_tw, int _reuse); 61692723Salfredvoid tcp_ctlinput(int, struct sockaddr *, void *); 61792723Salfredint tcp_ctloutput(struct socket *, struct sockopt *); 6181541Srgrimesstruct tcpcb * 61992723Salfred tcp_drop(struct tcpcb *, int); 62092723Salfredvoid tcp_drain(void); 62192723Salfredvoid tcp_init(void); 622193731Szec#ifdef VIMAGE 623193731Szecvoid tcp_destroy(void); 624193731Szec#endif 625128452Ssilbyvoid tcp_fini(void *); 626169683Sandrechar *tcp_log_addrs(struct in_conninfo *, struct tcphdr *, void *, 627171229Speter const void *); 628211462Sandrechar *tcp_log_vain(struct in_conninfo *, struct tcphdr *, void *, 629211462Sandre const void *); 630169541Sandreint tcp_reass(struct tcpcb *, struct tcphdr *, int *, struct mbuf *); 631126193Sandrevoid tcp_reass_init(void); 632213158Slstewartvoid tcp_reass_flush(struct tcpcb *); 633204838Sbz#ifdef VIMAGE 634204838Sbzvoid tcp_reass_destroy(void); 635204838Sbz#endif 63692723Salfredvoid tcp_input(struct mbuf *, int); 637162084Sandreu_long tcp_maxmtu(struct in_conninfo *, int *); 638162084Sandreu_long tcp_maxmtu6(struct in_conninfo *, int *); 639184722Sbzvoid tcp_mss_update(struct tcpcb *, int, struct hc_metrics_lite *, int *); 64092723Salfredvoid tcp_mss(struct tcpcb *, int); 641122922Sandreint tcp_mssopt(struct in_conninfo *); 642133874Srwatsonstruct inpcb * 64398211Shsu tcp_drop_syn_sent(struct inpcb *, int); 64498211Shsustruct inpcb * 64598211Shsu tcp_mtudisc(struct inpcb *, int); 6461541Srgrimesstruct tcpcb * 64792723Salfred tcp_newtcpcb(struct inpcb *); 64892723Salfredint tcp_output(struct tcpcb *); 64992723Salfredvoid tcp_respond(struct tcpcb *, void *, 65092723Salfred struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int); 651169541Sandrevoid tcp_tw_init(void); 652193731Szec#ifdef VIMAGE 653193731Szecvoid tcp_tw_destroy(void); 654193731Szec#endif 655169541Sandrevoid tcp_tw_zone_change(void); 656169608Sandreint tcp_twcheck(struct inpcb *, struct tcpopt *, struct tcphdr *, 657169608Sandre struct mbuf *, int); 658126351Srwatsonint tcp_twrespond(struct tcptw *, int); 65992723Salfredvoid tcp_setpersist(struct tcpcb *); 660125783Sbms#ifdef TCP_SIGNATURE 661125783Sbmsint tcp_signature_compute(struct mbuf *, int, int, int, u_char *, u_int); 662125783Sbms#endif 66392723Salfredvoid tcp_slowtimo(void); 66455679Sshinstruct tcptemp * 665111144Sjlemon tcpip_maketemplate(struct inpcb *); 666111144Sjlemonvoid tcpip_fillheaders(struct inpcb *, void *, void *); 667168615Sandrevoid tcp_timer_activate(struct tcpcb *, int, u_int); 668168615Sandreint tcp_timer_active(struct tcpcb *, int); 669169272Srwatsonvoid tcp_trace(short, short, struct tcpcb *, void *, struct tcphdr *, int); 670122922Sandre/* 671122922Sandre * All tcp_hc_* functions are IPv4 and IPv6 (via in_conninfo) 672122922Sandre */ 673122922Sandrevoid tcp_hc_init(void); 674193731Szec#ifdef VIMAGE 675193731Szecvoid tcp_hc_destroy(void); 676193731Szec#endif 677122922Sandrevoid tcp_hc_get(struct in_conninfo *, struct hc_metrics_lite *); 678122922Sandreu_long tcp_hc_getmtu(struct in_conninfo *); 679122922Sandrevoid tcp_hc_updatemtu(struct in_conninfo *, u_long); 680122922Sandrevoid tcp_hc_update(struct in_conninfo *, struct hc_metrics_lite *); 6819470Swollman 68217096Swollmanextern struct pr_usrreqs tcp_usrreqs; 6839470Swollmanextern u_long tcp_sendspace; 6849470Swollmanextern u_long tcp_recvspace; 68592723Salfredtcp_seq tcp_new_isn(struct tcpcb *); 6869470Swollman 687147637Spsvoid tcp_sack_doack(struct tcpcb *, struct tcpopt *, tcp_seq); 688142031Spsvoid tcp_update_sack_list(struct tcpcb *tp, tcp_seq rcv_laststart, tcp_seq rcv_lastend); 689130989Spsvoid tcp_clean_sackreport(struct tcpcb *tp); 690130989Spsvoid tcp_sack_adjust(struct tcpcb *tp); 691136151Spsstruct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt); 692130989Spsvoid tcp_sack_partialack(struct tcpcb *, struct tcphdr *); 693130989Spsvoid tcp_free_sackholes(struct tcpcb *tp); 694130989Spsint tcp_newreno(struct tcpcb *, struct tcphdr *); 695130989Spsu_long tcp_seq_subtract(u_long, u_long ); 696130989Sps 697215166Slstewartvoid cc_cong_signal(struct tcpcb *tp, struct tcphdr *th, uint32_t type); 698215166Slstewart 69955205Speter#endif /* _KERNEL */ 7002169Spaul 7016348Swollman#endif /* _NETINET_TCP_VAR_H_ */ 702