xref: /freebsd/sys/netinet/tcp_var.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
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 	int		ispare;		/* explicit pad for 64bit alignment */
76 	uint64_t	_pad[2];	/* 1 sacked_bytes, 1 TBD */
77 };
78 
79 struct tcptemp {
80 	u_char	tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
81 	struct	tcphdr tt_t;
82 };
83 
84 #define tcp6cb		tcpcb  /* for KAME src sync over BSD*'s */
85 
86 /* Neighbor Discovery, Neighbor Unreachability Detection Upper layer hint. */
87 #ifdef INET6
88 #define ND6_HINT(tp)						\
89 do {								\
90 	if ((tp) && (tp)->t_inpcb &&				\
91 	    ((tp)->t_inpcb->inp_vflag & INP_IPV6) != 0)		\
92 		nd6_nud_hint(NULL, NULL, 0);			\
93 } while (0)
94 #else
95 #define ND6_HINT(tp)
96 #endif
97 
98 /*
99  * Tcp control block, one per tcp; fields:
100  * Organized for 16 byte cacheline efficiency.
101  */
102 struct tcpcb {
103 	struct	tsegqe_head t_segq;	/* segment reassembly queue */
104 	void	*t_pspare[2];		/* new reassembly queue */
105 	int	t_segqlen;		/* segment reassembly queue length */
106 	int	t_dupacks;		/* consecutive dup acks recd */
107 
108 	struct tcp_timer *t_timers;	/* All the TCP timers in one struct */
109 
110 	struct	inpcb *t_inpcb;		/* back pointer to internet pcb */
111 	int	t_state;		/* state of this connection */
112 	u_int	t_flags;
113 
114 	struct	vnet *t_vnet;		/* back pointer to parent vnet */
115 
116 	tcp_seq	snd_una;		/* send unacknowledged */
117 	tcp_seq	snd_max;		/* highest sequence number sent;
118 					 * used to recognize retransmits
119 					 */
120 	tcp_seq	snd_nxt;		/* send next */
121 	tcp_seq	snd_up;			/* send urgent pointer */
122 
123 	tcp_seq	snd_wl1;		/* window update seg seq number */
124 	tcp_seq	snd_wl2;		/* window update seg ack number */
125 	tcp_seq	iss;			/* initial send sequence number */
126 	tcp_seq	irs;			/* initial receive sequence number */
127 
128 	tcp_seq	rcv_nxt;		/* receive next */
129 	tcp_seq	rcv_adv;		/* advertised window */
130 	u_long	rcv_wnd;		/* receive window */
131 	tcp_seq	rcv_up;			/* receive urgent pointer */
132 
133 	u_long	snd_wnd;		/* send window */
134 	u_long	snd_cwnd;		/* congestion-controlled window */
135 	u_long	snd_spare1;		/* unused */
136 	u_long	snd_ssthresh;		/* snd_cwnd size threshold for
137 					 * for slow start exponential to
138 					 * linear switch
139 					 */
140 	u_long	snd_spare2;		/* unused */
141 	tcp_seq	snd_recover;		/* for use in NewReno Fast Recovery */
142 
143 	u_int	t_maxopd;		/* mss plus options */
144 
145 	u_int	t_rcvtime;		/* inactivity time */
146 	u_int	t_starttime;		/* time connection was established */
147 	u_int	t_rtttime;		/* RTT measurement start time */
148 	tcp_seq	t_rtseq;		/* sequence number being timed */
149 
150 	u_int	t_bw_spare1;		/* unused */
151 	tcp_seq	t_bw_spare2;		/* unused */
152 
153 	int	t_rxtcur;		/* current retransmit value (ticks) */
154 	u_int	t_maxseg;		/* maximum segment size */
155 	int	t_srtt;			/* smoothed round-trip time */
156 	int	t_rttvar;		/* variance in round-trip time */
157 
158 	int	t_rxtshift;		/* log(2) of rexmt exp. backoff */
159 	u_int	t_rttmin;		/* minimum rtt allowed */
160 	u_int	t_rttbest;		/* best rtt we've seen */
161 	u_long	t_rttupdated;		/* number of times rtt sampled */
162 	u_long	max_sndwnd;		/* largest window peer has offered */
163 
164 	int	t_softerror;		/* possible error not yet reported */
165 /* out-of-band data */
166 	char	t_oobflags;		/* have some */
167 	char	t_iobc;			/* input character */
168 /* RFC 1323 variables */
169 	u_char	snd_scale;		/* window scaling for send window */
170 	u_char	rcv_scale;		/* window scaling for recv window */
171 	u_char	request_r_scale;	/* pending window scaling */
172 	u_int32_t  ts_recent;		/* timestamp echo data */
173 	u_int	ts_recent_age;		/* when last updated */
174 	u_int32_t  ts_offset;		/* our timestamp offset */
175 
176 	tcp_seq	last_ack_sent;
177 /* experimental */
178 	u_long	snd_cwnd_prev;		/* cwnd prior to retransmit */
179 	u_long	snd_ssthresh_prev;	/* ssthresh prior to retransmit */
180 	tcp_seq	snd_recover_prev;	/* snd_recover prior to retransmit */
181 	int	t_sndzerowin;		/* zero-window updates sent */
182 	u_int	t_badrxtwin;		/* window for retransmit recovery */
183 	u_char	snd_limited;		/* segments limited transmitted */
184 /* SACK related state */
185 	int	snd_numholes;		/* number of holes seen by sender */
186 	TAILQ_HEAD(sackhole_head, sackhole) snd_holes;
187 					/* SACK scoreboard (sorted) */
188 	tcp_seq	snd_fack;		/* last seq number(+1) sack'd by rcv'r*/
189 	int	rcv_numsacks;		/* # distinct sack blks present */
190 	struct sackblk sackblks[MAX_SACK_BLKS]; /* seq nos. of sack blocks */
191 	tcp_seq sack_newdata;		/* New data xmitted in this recovery
192 					   episode starts at this seq number */
193 	struct sackhint	sackhint;	/* SACK scoreboard hint */
194 	int	t_rttlow;		/* smallest observerved RTT */
195 	u_int32_t	rfbuf_ts;	/* recv buffer autoscaling timestamp */
196 	int	rfbuf_cnt;		/* recv buffer autoscaling byte count */
197 	struct toe_usrreqs *t_tu;	/* offload operations vector */
198 	int	t_sndrexmitpack;	/* retransmit packets sent */
199 	int	t_rcvoopack;		/* out-of-order packets received */
200 	void	*t_toe;			/* TOE pcb pointer */
201 	int	t_bytes_acked;		/* # bytes acked during current RTT */
202 	struct cc_algo	*cc_algo;	/* congestion control algorithm */
203 	struct cc_var	*ccv;		/* congestion control specific vars */
204 	struct osd	*osd;		/* storage for Khelp module data */
205 
206 	uint32_t t_ispare[12];		/* 4 keep timers, 5 UTO, 3 TBD */
207 	void	*t_pspare2[4];		/* 4 TBD */
208 	uint64_t _pad[6];		/* 6 TBD (1-2 CC/RTT?) */
209 };
210 
211 /*
212  * Flags and utility macros for the t_flags field.
213  */
214 #define	TF_ACKNOW	0x000001	/* ack peer immediately */
215 #define	TF_DELACK	0x000002	/* ack, but try to delay it */
216 #define	TF_NODELAY	0x000004	/* don't delay packets to coalesce */
217 #define	TF_NOOPT	0x000008	/* don't use tcp options */
218 #define	TF_SENTFIN	0x000010	/* have sent FIN */
219 #define	TF_REQ_SCALE	0x000020	/* have/will request window scaling */
220 #define	TF_RCVD_SCALE	0x000040	/* other side has requested scaling */
221 #define	TF_REQ_TSTMP	0x000080	/* have/will request timestamps */
222 #define	TF_RCVD_TSTMP	0x000100	/* a timestamp was received in SYN */
223 #define	TF_SACK_PERMIT	0x000200	/* other side said I could SACK */
224 #define	TF_NEEDSYN	0x000400	/* send SYN (implicit state) */
225 #define	TF_NEEDFIN	0x000800	/* send FIN (implicit state) */
226 #define	TF_NOPUSH	0x001000	/* don't push */
227 #define	TF_PREVVALID	0x002000	/* saved values for bad rxmit valid */
228 #define	TF_MORETOCOME	0x010000	/* More data to be appended to sock */
229 #define	TF_LQ_OVERFLOW	0x020000	/* listen queue overflow */
230 #define	TF_LASTIDLE	0x040000	/* connection was previously idle */
231 #define	TF_RXWIN0SENT	0x080000	/* sent a receiver win 0 in response */
232 #define	TF_FASTRECOVERY	0x100000	/* in NewReno Fast Recovery */
233 #define	TF_WASFRECOVERY	0x200000	/* was in NewReno Fast Recovery */
234 #define	TF_SIGNATURE	0x400000	/* require MD5 digests (RFC2385) */
235 #define	TF_FORCEDATA	0x800000	/* force out a byte */
236 #define	TF_TSO		0x1000000	/* TSO enabled on this connection */
237 #define	TF_TOE		0x2000000	/* this connection is offloaded */
238 #define	TF_ECN_PERMIT	0x4000000	/* connection ECN-ready */
239 #define	TF_ECN_SND_CWR	0x8000000	/* ECN CWR in queue */
240 #define	TF_ECN_SND_ECE	0x10000000	/* ECN ECE in queue */
241 #define	TF_CONGRECOVERY	0x20000000	/* congestion recovery mode */
242 #define	TF_WASCRECOVERY	0x40000000	/* was in congestion recovery */
243 
244 #define	IN_FASTRECOVERY(t_flags)	(t_flags & TF_FASTRECOVERY)
245 #define	ENTER_FASTRECOVERY(t_flags)	t_flags |= TF_FASTRECOVERY
246 #define	EXIT_FASTRECOVERY(t_flags)	t_flags &= ~TF_FASTRECOVERY
247 
248 #define	IN_CONGRECOVERY(t_flags)	(t_flags & TF_CONGRECOVERY)
249 #define	ENTER_CONGRECOVERY(t_flags)	t_flags |= TF_CONGRECOVERY
250 #define	EXIT_CONGRECOVERY(t_flags)	t_flags &= ~TF_CONGRECOVERY
251 
252 #define	IN_RECOVERY(t_flags) (t_flags & (TF_CONGRECOVERY | TF_FASTRECOVERY))
253 #define	ENTER_RECOVERY(t_flags) t_flags |= (TF_CONGRECOVERY | TF_FASTRECOVERY)
254 #define	EXIT_RECOVERY(t_flags) t_flags &= ~(TF_CONGRECOVERY | TF_FASTRECOVERY)
255 
256 #define	BYTES_THIS_ACK(tp, th)	(th->th_ack - tp->snd_una)
257 
258 /*
259  * Flags for the t_oobflags field.
260  */
261 #define	TCPOOB_HAVEDATA	0x01
262 #define	TCPOOB_HADDATA	0x02
263 
264 #ifdef TCP_SIGNATURE
265 /*
266  * Defines which are needed by the xform_tcp module and tcp_[in|out]put
267  * for SADB verification and lookup.
268  */
269 #define	TCP_SIGLEN	16	/* length of computed digest in bytes */
270 #define	TCP_KEYLEN_MIN	1	/* minimum length of TCP-MD5 key */
271 #define	TCP_KEYLEN_MAX	80	/* maximum length of TCP-MD5 key */
272 /*
273  * Only a single SA per host may be specified at this time. An SPI is
274  * needed in order for the KEY_ALLOCSA() lookup to work.
275  */
276 #define	TCP_SIG_SPI	0x1000
277 #endif /* TCP_SIGNATURE */
278 
279 /*
280  * Structure to hold TCP options that are only used during segment
281  * processing (in tcp_input), but not held in the tcpcb.
282  * It's basically used to reduce the number of parameters
283  * to tcp_dooptions and tcp_addoptions.
284  * The binary order of the to_flags is relevant for packing of the
285  * options in tcp_addoptions.
286  */
287 struct tcpopt {
288 	u_int64_t	to_flags;	/* which options are present */
289 #define	TOF_MSS		0x0001		/* maximum segment size */
290 #define	TOF_SCALE	0x0002		/* window scaling */
291 #define	TOF_SACKPERM	0x0004		/* SACK permitted */
292 #define	TOF_TS		0x0010		/* timestamp */
293 #define	TOF_SIGNATURE	0x0040		/* TCP-MD5 signature option (RFC2385) */
294 #define	TOF_SACK	0x0080		/* Peer sent SACK option */
295 #define	TOF_MAXOPT	0x0100
296 	u_int32_t	to_tsval;	/* new timestamp */
297 	u_int32_t	to_tsecr;	/* reflected timestamp */
298 	u_char		*to_sacks;	/* pointer to the first SACK blocks */
299 	u_char		*to_signature;	/* pointer to the TCP-MD5 signature */
300 	u_int16_t	to_mss;		/* maximum segment size */
301 	u_int8_t	to_wscale;	/* window scaling */
302 	u_int8_t	to_nsacks;	/* number of SACK blocks */
303 	u_int32_t	to_spare;	/* UTO */
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[12];		/* 6 UTO, 6 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 xtcp_timer {
539 	int tt_rexmt;	/* retransmit timer */
540 	int tt_persist;	/* retransmit persistence */
541 	int tt_keep;	/* keepalive */
542 	int tt_2msl;	/* 2*msl TIME_WAIT timer */
543 	int tt_delack;	/* delayed ACK timer */
544 	int t_rcvtime;	/* Time since last packet received */
545 };
546 struct	xtcpcb {
547 	size_t	xt_len;
548 	struct	inpcb	xt_inp;
549 	struct	tcpcb	xt_tp;
550 	struct	xsocket	xt_socket;
551 	struct	xtcp_timer xt_timer;
552 	u_quad_t	xt_alignment_hack;
553 };
554 #endif
555 
556 /*
557  * Names for TCP sysctl objects
558  */
559 #define	TCPCTL_DO_RFC1323	1	/* use RFC-1323 extensions */
560 #define	TCPCTL_MSSDFLT		3	/* MSS default */
561 #define TCPCTL_STATS		4	/* statistics (read-only) */
562 #define	TCPCTL_RTTDFLT		5	/* default RTT estimate */
563 #define	TCPCTL_KEEPIDLE		6	/* keepalive idle timer */
564 #define	TCPCTL_KEEPINTVL	7	/* interval to send keepalives */
565 #define	TCPCTL_SENDSPACE	8	/* send buffer space */
566 #define	TCPCTL_RECVSPACE	9	/* receive buffer space */
567 #define	TCPCTL_KEEPINIT		10	/* timeout for establishing syn */
568 #define	TCPCTL_PCBLIST		11	/* list of all outstanding PCBs */
569 #define	TCPCTL_DELACKTIME	12	/* time before sending delayed ACK */
570 #define	TCPCTL_V6MSSDFLT	13	/* MSS default for IPv6 */
571 #define	TCPCTL_SACK		14	/* Selective Acknowledgement,rfc 2018 */
572 #define	TCPCTL_DROP		15	/* drop tcp connection */
573 #define	TCPCTL_MAXID		16
574 #define TCPCTL_FINWAIT2_TIMEOUT        17
575 
576 #define TCPCTL_NAMES { \
577 	{ 0, 0 }, \
578 	{ "rfc1323", CTLTYPE_INT }, \
579 	{ "mssdflt", CTLTYPE_INT }, \
580 	{ "stats", CTLTYPE_STRUCT }, \
581 	{ "rttdflt", CTLTYPE_INT }, \
582 	{ "keepidle", CTLTYPE_INT }, \
583 	{ "keepintvl", CTLTYPE_INT }, \
584 	{ "sendspace", CTLTYPE_INT }, \
585 	{ "recvspace", CTLTYPE_INT }, \
586 	{ "keepinit", CTLTYPE_INT }, \
587 	{ "pcblist", CTLTYPE_STRUCT }, \
588 	{ "delacktime", CTLTYPE_INT }, \
589 	{ "v6mssdflt", CTLTYPE_INT }, \
590 	{ "maxid", CTLTYPE_INT }, \
591 }
592 
593 
594 #ifdef _KERNEL
595 #ifdef SYSCTL_DECL
596 SYSCTL_DECL(_net_inet_tcp);
597 SYSCTL_DECL(_net_inet_tcp_sack);
598 MALLOC_DECLARE(M_TCPLOG);
599 #endif
600 
601 VNET_DECLARE(struct inpcbhead, tcb);		/* queue of active tcpcb's */
602 VNET_DECLARE(struct inpcbinfo, tcbinfo);
603 VNET_DECLARE(struct tcpstat, tcpstat);		/* tcp statistics */
604 extern	int tcp_log_in_vain;
605 VNET_DECLARE(int, tcp_mssdflt);	/* XXX */
606 VNET_DECLARE(int, tcp_minmss);
607 VNET_DECLARE(int, tcp_delack_enabled);
608 VNET_DECLARE(int, tcp_do_rfc3390);
609 VNET_DECLARE(int, tcp_sendspace);
610 VNET_DECLARE(int, tcp_recvspace);
611 VNET_DECLARE(int, path_mtu_discovery);
612 VNET_DECLARE(int, tcp_do_rfc3465);
613 VNET_DECLARE(int, tcp_abc_l_var);
614 #define	V_tcb			VNET(tcb)
615 #define	V_tcbinfo		VNET(tcbinfo)
616 #define	V_tcpstat		VNET(tcpstat)
617 #define	V_tcp_mssdflt		VNET(tcp_mssdflt)
618 #define	V_tcp_minmss		VNET(tcp_minmss)
619 #define	V_tcp_delack_enabled	VNET(tcp_delack_enabled)
620 #define	V_tcp_do_rfc3390	VNET(tcp_do_rfc3390)
621 #define	V_tcp_sendspace		VNET(tcp_sendspace)
622 #define	V_tcp_recvspace		VNET(tcp_recvspace)
623 #define	V_path_mtu_discovery	VNET(path_mtu_discovery)
624 #define	V_tcp_do_rfc3465	VNET(tcp_do_rfc3465)
625 #define	V_tcp_abc_l_var		VNET(tcp_abc_l_var)
626 
627 VNET_DECLARE(int, tcp_do_sack);			/* SACK enabled/disabled */
628 VNET_DECLARE(int, tcp_sc_rst_sock_fail);	/* RST on sock alloc failure */
629 #define	V_tcp_do_sack		VNET(tcp_do_sack)
630 #define	V_tcp_sc_rst_sock_fail	VNET(tcp_sc_rst_sock_fail)
631 
632 VNET_DECLARE(int, tcp_do_ecn);			/* TCP ECN enabled/disabled */
633 VNET_DECLARE(int, tcp_ecn_maxretries);
634 #define	V_tcp_do_ecn		VNET(tcp_do_ecn)
635 #define	V_tcp_ecn_maxretries	VNET(tcp_ecn_maxretries)
636 
637 VNET_DECLARE(struct hhook_head *, tcp_hhh[HHOOK_TCP_LAST + 1]);
638 #define	V_tcp_hhh		VNET(tcp_hhh)
639 
640 int	 tcp_addoptions(struct tcpopt *, u_char *);
641 int	 tcp_ccalgounload(struct cc_algo *unload_algo);
642 struct tcpcb *
643 	 tcp_close(struct tcpcb *);
644 void	 tcp_discardcb(struct tcpcb *);
645 void	 tcp_twstart(struct tcpcb *);
646 #if 0
647 int	 tcp_twrecycleable(struct tcptw *tw);
648 #endif
649 void	 tcp_twclose(struct tcptw *_tw, int _reuse);
650 void	 tcp_ctlinput(int, struct sockaddr *, void *);
651 int	 tcp_ctloutput(struct socket *, struct sockopt *);
652 struct tcpcb *
653 	 tcp_drop(struct tcpcb *, int);
654 void	 tcp_drain(void);
655 void	 tcp_init(void);
656 #ifdef VIMAGE
657 void	 tcp_destroy(void);
658 #endif
659 void	 tcp_fini(void *);
660 char	*tcp_log_addrs(struct in_conninfo *, struct tcphdr *, void *,
661 	    const void *);
662 char	*tcp_log_vain(struct in_conninfo *, struct tcphdr *, void *,
663 	    const void *);
664 int	 tcp_reass(struct tcpcb *, struct tcphdr *, int *, struct mbuf *);
665 void	 tcp_reass_init(void);
666 void	 tcp_reass_flush(struct tcpcb *);
667 #ifdef VIMAGE
668 void	 tcp_reass_destroy(void);
669 #endif
670 void	 tcp_input(struct mbuf *, int);
671 u_long	 tcp_maxmtu(struct in_conninfo *, int *);
672 u_long	 tcp_maxmtu6(struct in_conninfo *, int *);
673 void	 tcp_mss_update(struct tcpcb *, int, struct hc_metrics_lite *, int *);
674 void	 tcp_mss(struct tcpcb *, int);
675 int	 tcp_mssopt(struct in_conninfo *);
676 struct inpcb *
677 	 tcp_drop_syn_sent(struct inpcb *, int);
678 struct inpcb *
679 	 tcp_mtudisc(struct inpcb *, int);
680 struct tcpcb *
681 	 tcp_newtcpcb(struct inpcb *);
682 int	 tcp_output(struct tcpcb *);
683 void	 tcp_respond(struct tcpcb *, void *,
684 	    struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
685 void	 tcp_tw_init(void);
686 #ifdef VIMAGE
687 void	 tcp_tw_destroy(void);
688 #endif
689 void	 tcp_tw_zone_change(void);
690 int	 tcp_twcheck(struct inpcb *, struct tcpopt *, struct tcphdr *,
691 	    struct mbuf *, int);
692 int	 tcp_twrespond(struct tcptw *, int);
693 void	 tcp_setpersist(struct tcpcb *);
694 #ifdef TCP_SIGNATURE
695 int	 tcp_signature_compute(struct mbuf *, int, int, int, u_char *, u_int);
696 int	 tcp_signature_verify(struct mbuf *, int, int, int, struct tcpopt *,
697 	    struct tcphdr *, u_int);
698 #endif
699 void	 tcp_slowtimo(void);
700 struct tcptemp *
701 	 tcpip_maketemplate(struct inpcb *);
702 void	 tcpip_fillheaders(struct inpcb *, void *, void *);
703 void	 tcp_timer_activate(struct tcpcb *, int, u_int);
704 int	 tcp_timer_active(struct tcpcb *, int);
705 void	 tcp_trace(short, short, struct tcpcb *, void *, struct tcphdr *, int);
706 /*
707  * All tcp_hc_* functions are IPv4 and IPv6 (via in_conninfo)
708  */
709 void	 tcp_hc_init(void);
710 #ifdef VIMAGE
711 void	 tcp_hc_destroy(void);
712 #endif
713 void	 tcp_hc_get(struct in_conninfo *, struct hc_metrics_lite *);
714 u_long	 tcp_hc_getmtu(struct in_conninfo *);
715 void	 tcp_hc_updatemtu(struct in_conninfo *, u_long);
716 void	 tcp_hc_update(struct in_conninfo *, struct hc_metrics_lite *);
717 
718 extern	struct pr_usrreqs tcp_usrreqs;
719 tcp_seq tcp_new_isn(struct tcpcb *);
720 
721 void	 tcp_sack_doack(struct tcpcb *, struct tcpopt *, tcp_seq);
722 void	 tcp_update_sack_list(struct tcpcb *tp, tcp_seq rcv_laststart, tcp_seq rcv_lastend);
723 void	 tcp_clean_sackreport(struct tcpcb *tp);
724 void	 tcp_sack_adjust(struct tcpcb *tp);
725 struct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt);
726 void	 tcp_sack_partialack(struct tcpcb *, struct tcphdr *);
727 void	 tcp_free_sackholes(struct tcpcb *tp);
728 int	 tcp_newreno(struct tcpcb *, struct tcphdr *);
729 u_long	 tcp_seq_subtract(u_long, u_long );
730 
731 void	cc_cong_signal(struct tcpcb *tp, struct tcphdr *th, uint32_t type);
732 
733 #endif /* _KERNEL */
734 
735 #endif /* _NETINET_TCP_VAR_H_ */
736