xref: /freebsd/sys/netinet/tcp_var.h (revision 2b833162)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1993, 1994, 1995
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)tcp_var.h	8.4 (Berkeley) 5/24/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _NETINET_TCP_VAR_H_
36 #define _NETINET_TCP_VAR_H_
37 
38 #include <netinet/tcp.h>
39 #include <netinet/tcp_fsm.h>
40 
41 #ifdef _KERNEL
42 #include "opt_kern_tls.h"
43 #include <net/vnet.h>
44 #include <sys/mbuf.h>
45 #include <sys/ktls.h>
46 #endif
47 
48 #define TCP_END_BYTE_INFO 8	/* Bytes that makeup the "end information array" */
49 /* Types of ending byte info */
50 #define TCP_EI_EMPTY_SLOT	0
51 #define TCP_EI_STATUS_CLIENT_FIN	0x1
52 #define TCP_EI_STATUS_CLIENT_RST	0x2
53 #define TCP_EI_STATUS_SERVER_FIN	0x3
54 #define TCP_EI_STATUS_SERVER_RST	0x4
55 #define TCP_EI_STATUS_RETRAN		0x5
56 #define TCP_EI_STATUS_PROGRESS		0x6
57 #define TCP_EI_STATUS_PERSIST_MAX	0x7
58 #define TCP_EI_STATUS_KEEP_MAX		0x8
59 #define TCP_EI_STATUS_DATA_A_CLOSE	0x9
60 #define TCP_EI_STATUS_RST_IN_FRONT	0xa
61 #define TCP_EI_STATUS_2MSL		0xb
62 #define TCP_EI_STATUS_MAX_VALUE		0xb
63 
64 #define TCP_HTTP_REQ_LOG_NEW		0x01
65 #define TCP_HTTP_REQ_LOG_COMPLETE	0x02
66 #define TCP_HTTP_REQ_LOG_FREED		0x03
67 #define TCP_HTTP_REQ_LOG_ALLOCFAIL	0x04
68 #define TCP_HTTP_REQ_LOG_MOREYET	0x05
69 #define TCP_HTTP_REQ_LOG_FORCEFREE	0x06
70 #define TCP_HTTP_REQ_LOG_STALE		0x07
71 #define TCP_HTTP_REQ_LOG_SEARCH		0x08
72 
73 /************************************************/
74 /* Status bits we track to assure no duplicates,
75  * the bits here are not used by the code but
76  * for human representation. To check a bit we
77  * take and shift over by 1 minus the value (1-8).
78  */
79 /************************************************/
80 #define TCP_EI_BITS_CLIENT_FIN	0x001
81 #define TCP_EI_BITS_CLIENT_RST	0x002
82 #define TCP_EI_BITS_SERVER_FIN	0x004
83 #define TCP_EI_BITS_SERVER_RST	0x008
84 #define TCP_EI_BITS_RETRAN	0x010
85 #define TCP_EI_BITS_PROGRESS	0x020
86 #define TCP_EI_BITS_PRESIST_MAX	0x040
87 #define TCP_EI_BITS_KEEP_MAX	0x080
88 #define TCP_EI_BITS_DATA_A_CLO  0x100
89 #define TCP_EI_BITS_RST_IN_FR	0x200	/* a front state reset */
90 #define TCP_EI_BITS_2MS_TIMER	0x400	/* 2 MSL timer expired */
91 
92 #if defined(_KERNEL) || defined(_WANT_TCPCB)
93 #include <netinet/cc/cc.h>
94 
95 /* TCP segment queue entry */
96 struct tseg_qent {
97 	TAILQ_ENTRY(tseg_qent) tqe_q;
98 	struct	mbuf   *tqe_m;		/* mbuf contains packet */
99 	struct  mbuf   *tqe_last;	/* last mbuf in chain */
100 	tcp_seq tqe_start;		/* TCP Sequence number start */
101 	int	tqe_len;		/* TCP segment data length */
102 	uint32_t tqe_flags;		/* The flags from tcp_get_flags() */
103 	uint32_t tqe_mbuf_cnt;		/* Count of mbuf overhead */
104 };
105 TAILQ_HEAD(tsegqe_head, tseg_qent);
106 
107 struct sackblk {
108 	tcp_seq start;		/* start seq no. of sack block */
109 	tcp_seq end;		/* end seq no. */
110 };
111 
112 struct sackhole {
113 	tcp_seq start;		/* start seq no. of hole */
114 	tcp_seq end;		/* end seq no. */
115 	tcp_seq rxmit;		/* next seq. no in hole to be retransmitted */
116 	TAILQ_ENTRY(sackhole) scblink;	/* scoreboard linkage */
117 };
118 
119 struct sackhint {
120 	struct sackhole	*nexthole;
121 	int32_t		sack_bytes_rexmit;
122 	tcp_seq		last_sack_ack;	/* Most recent/largest sacked ack */
123 
124 	int32_t		delivered_data; /* Newly acked data from last SACK */
125 
126 	int32_t		sacked_bytes;	/* Total sacked bytes reported by the
127 					 * receiver via sack option
128 					 */
129 	uint32_t	recover_fs;	/* Flight Size at the start of Loss recovery */
130 	uint32_t	prr_delivered;	/* Total bytes delivered using PRR */
131 	uint32_t	prr_out;	/* Bytes sent during IN_RECOVERY */
132 };
133 
134 #define SEGQ_EMPTY(tp) TAILQ_EMPTY(&(tp)->t_segq)
135 
136 STAILQ_HEAD(tcp_log_stailq, tcp_log_mem);
137 
138 #define TCP_HTTP_TRACK_FLG_EMPTY 0x00	/* Available */
139 #define TCP_HTTP_TRACK_FLG_USED  0x01	/* In use */
140 #define TCP_HTTP_TRACK_FLG_OPEN  0x02	/* End is not valid (open range request) */
141 #define TCP_HTTP_TRACK_FLG_SEQV  0x04	/* We had a sendfile that touched it  */
142 #define TCP_HTTP_TRACK_FLG_COMP  0x08	/* Sendfile as placed the last bits (range req only) */
143 #define TCP_HTTP_TRACK_FLG_FSND	 0x10	/* First send has been done into the seq space */
144 #define MAX_TCP_HTTP_REQ 5		/* Max we will have at once */
145 
146 #ifdef TCP_REQUEST_TRK
147 struct http_sendfile_track {
148 	uint64_t timestamp;	/* User sent timestamp */
149 	uint64_t start;		/* Start of sendfile offset */
150 	uint64_t end;		/* End if not open-range req */
151 	uint64_t localtime;	/* Time we actually got the req */
152 	uint64_t deadline;	/* If in CU mode, deadline to delivery */
153 	uint64_t first_send;	/* Time of first send in the range */
154 	uint64_t cspr;		/* Client suggested pace rate */
155 	uint64_t sent_at_fs;	/* What was t_sndbytes as we begun sending */
156 	uint64_t rxt_at_fs;	/* What was t_snd_rxt_bytes as we begun sending */
157 	tcp_seq start_seq;	/* First TCP Seq assigned */
158 	tcp_seq end_seq;	/* If range req last seq */
159 	uint32_t flags;		/* Type of request open etc */
160 	uint32_t sbcc_at_s;	/* When we allocate what is the sb_cc */
161 	uint32_t hint_maxseg;	/* Client hinted maxseg */
162 	uint32_t hybrid_flags;	/* Hybrid flags on this request */
163 };
164 
165 #endif
166 
167 /*
168  * Change Query responses for a stack switch we create a structure
169  * that allows query response from the new stack to the old, if
170  * supported.
171  *
172  * There are three queries currently defined.
173  *  - sendmap
174  *  - timers
175  *  - rack_times
176  *
177  * For the sendmap query the caller fills in the
178  * req and the req_param as the first seq (usually
179  * snd_una). When the response comes back indicating
180  * that there was data (return value 1), then the caller
181  * can build a sendmap entry based on the range and the
182  * times. The next query would then be done at the
183  * newly created sendmap_end. Repeated until sendmap_end == snd_max.
184  *
185  * Flags in sendmap_flags are defined below as well.
186  *
187  * For timers the standard PACE_TMR_XXXX flags are returned indicating
188  * a pacing timer (possibly) and one other timer. If pacing timer then
189  * the expiration timeout time in microseconds is in timer_pacing_to.
190  * And the value used with whatever timer (if a flag is set) is in
191  * timer_rxt. If no timers are running a 0 is returned and of
192  * course no flags are set in timer_hpts_flags.
193  *
194  * The rack_times are a misc collection of information that
195  * the old stack might possibly fill in. Of course its possible
196  * that an old stack may not have a piece of information. If so
197  * then setting that value to zero is advised. Setting any
198  * timestamp passed should only place a zero in it when it
199  * is unfilled. This may mean that a time is off by a micro-second
200  * but this is ok in the grand scheme of things.
201  *
202  * When switching stacks it is desireable to get as much information
203  * from the old stack to the new stack as possible. Though not always
204  * will the stack be compatible in the types of information. The
205  * init() function needs to take care when it begins changing
206  * things such as inp_flags2 and the timer units to position these
207  * changes at a point where it is unlikely they will fail after
208  * making such changes. A stack optionally can have an "undo"
209  * function
210  *
211  * To transfer information to the old stack from the new in
212  * respect to LRO and the inp_flags2, the new stack should set
213  * the inp_flags2 to what it supports. The old stack in its
214  * fini() function should call the tcp_handle_orphaned_packets()
215  * to clean up any packets. Note that a new stack should attempt
216  */
217 
218 /* Query types */
219 #define TCP_QUERY_SENDMAP	1
220 #define TCP_QUERY_TIMERS_UP	2
221 #define TCP_QUERY_RACK_TIMES	3
222 
223 /* Flags returned in sendmap_flags */
224 #define SNDMAP_ACKED		0x000001/* The remote endpoint acked this */
225 #define SNDMAP_OVERMAX		0x000008/* We have more retran's then we can fit */
226 #define SNDMAP_SACK_PASSED	0x000010/* A sack was done above this block */
227 #define SNDMAP_HAS_FIN		0x000040/* segment is sent with fin */
228 #define SNDMAP_TLP		0x000080/* segment sent as tail-loss-probe */
229 #define SNDMAP_HAS_SYN		0x000800/* SYN is on this guy */
230 #define SNDMAP_HAD_PUSH		0x008000/* Push was sent on original send */
231 #define SNDMAP_MASK  (SNDMAP_ACKED|SNDMAP_OVERMAX|SNDMAP_SACK_PASSED|SNDMAP_HAS_FIN\
232 		      |SNDMAP_TLP|SNDMAP_HAS_SYN|SNDMAP_HAD_PUSH)
233 #define SNDMAP_NRTX 3
234 
235 struct tcp_query_resp {
236 	int req;
237 	uint32_t req_param;
238 	union {
239 		struct {
240 			tcp_seq sendmap_start;
241 			tcp_seq sendmap_end;
242 			int sendmap_send_cnt;
243 			uint64_t sendmap_time[SNDMAP_NRTX];
244 			uint64_t sendmap_ack_arrival;
245 			int sendmap_flags;
246 			uint32_t sendmap_r_rtr_bytes;
247 			/* If FAS is available if not 0 */
248 			uint32_t sendmap_fas;
249 			uint8_t sendmap_dupacks;
250 		};
251 		struct {
252 			uint32_t timer_hpts_flags;
253 			uint32_t timer_pacing_to;
254 			uint32_t timer_timer_exp;
255 		};
256 		struct {
257 			/* Timestamps and rtt's */
258 			uint32_t rack_reorder_ts;	/* Last uscts that reordering was seen */
259 			uint32_t rack_num_dsacks;	/* Num of dsacks seen */
260 			uint32_t rack_rxt_last_time; 	/* Last time a RXT/TLP or rack tmr  went off */
261 			uint32_t rack_min_rtt;		/* never 0 smallest rtt seen */
262 			uint32_t rack_rtt;		/* Last rtt used by rack */
263 			uint32_t rack_tmit_time;	/* The time the rtt seg was tmited */
264 			uint32_t rack_time_went_idle;	/* If in persist the time we went idle */
265 			/* Prr data  */
266 			uint32_t rack_sacked;
267 			uint32_t rack_holes_rxt;
268 			uint32_t rack_prr_delivered;
269 			uint32_t rack_prr_recovery_fs;
270 			uint32_t rack_prr_out;
271 			uint32_t rack_prr_sndcnt;
272 			/* TLP data */
273 			uint16_t rack_tlp_cnt_out;	/* How many tlp's have been sent */
274 			/* Various bits */
275 			uint8_t  rack_tlp_out;		/* Is a TLP outstanding */
276 			uint8_t  rack_srtt_measured;	/* The previous stack has measured srtt */
277 			uint8_t  rack_in_persist;	/* Is the old stack in persists? */
278 			uint8_t	 rack_wanted_output;	/* Did the prevous stack have a want output set */
279 		};
280 	};
281 };
282 
283 #define TCP_TMR_GRANULARITY_TICKS	1	/* TCP timers are in ticks (msec if hz=1000)  */
284 #define TCP_TMR_GRANULARITY_USEC	2	/* TCP timers are in microseconds */
285 
286 typedef enum {
287 	TT_REXMT = 0,
288 	TT_PERSIST,
289 	TT_KEEP,
290 	TT_2MSL,
291 	TT_DELACK,
292 	TT_N,
293 } tt_which;
294 
295 typedef enum {
296 	TT_PROCESSING = 0,
297 	TT_PROCESSED,
298 	TT_STARTING,
299 	TT_STOPPING,
300 } tt_what;
301 
302 /*
303  * Tcp control block, one per tcp connection.
304  */
305 struct tcpcb {
306 	struct inpcb t_inpcb;		/* embedded protocol independent cb */
307 #define	t_start_zero	t_fb
308 #define	t_zero_size	(sizeof(struct tcpcb) - \
309 			    offsetof(struct tcpcb, t_start_zero))
310 	struct tcp_function_block *t_fb;/* TCP function call block */
311 	void	*t_fb_ptr;		/* Pointer to t_fb specific data */
312 
313 	struct callout t_callout;
314 	sbintime_t t_timers[TT_N];
315 	sbintime_t t_precisions[TT_N];
316 
317 	uint32_t t_maxseg:24,		/* maximum segment size */
318 		_t_logstate:8;		/* State of "black box" logging */
319 	uint32_t t_port:16,		/* Tunneling (over udp) port */
320 		t_state:4,		/* state of this connection */
321 		t_idle_reduce : 1,
322 		t_delayed_ack: 7,	/* Delayed ack variable */
323 		t_fin_is_rst: 1,	/* Are fin's treated as resets */
324 		t_log_state_set: 1,
325 		bits_spare : 2;
326 	u_int	t_flags;
327 	tcp_seq	snd_una;		/* sent but unacknowledged */
328 	tcp_seq	snd_max;		/* highest sequence number sent;
329 					 * used to recognize retransmits
330 					 */
331 	tcp_seq snd_nxt;		/* send next */
332 	tcp_seq snd_up;			/* send urgent pointer */
333 	uint32_t snd_wnd;		/* send window */
334 	uint32_t snd_cwnd;		/* congestion-controlled window */
335 	uint32_t ts_offset;		/* our timestamp offset */
336 	uint32_t rfbuf_ts;		/* recv buffer autoscaling timestamp */
337 	int	rcv_numsacks;		/* # distinct sack blks present */
338 	u_int	t_tsomax;		/* TSO total burst length limit */
339 	u_int	t_tsomaxsegcount;	/* TSO maximum segment count */
340 	u_int	t_tsomaxsegsize;	/* TSO maximum segment size in bytes */
341 	tcp_seq	rcv_nxt;		/* receive next */
342 	tcp_seq	rcv_adv;		/* advertised window */
343 	uint32_t rcv_wnd;		/* receive window */
344 	u_int	t_flags2;		/* More tcpcb flags storage */
345 	int	t_srtt;			/* smoothed round-trip time */
346 	int	t_rttvar;		/* variance in round-trip time */
347 	uint32_t ts_recent;		/* timestamp echo data */
348 	u_char	snd_scale;		/* window scaling for send window */
349 	u_char	rcv_scale;		/* window scaling for recv window */
350 	u_char	snd_limited;		/* segments limited transmitted */
351 	u_char	request_r_scale;	/* pending window scaling */
352 	tcp_seq	last_ack_sent;
353 	u_int	t_rcvtime;		/* inactivity time */
354 	tcp_seq	rcv_up;			/* receive urgent pointer */
355 	int	t_segqlen;		/* segment reassembly queue length */
356 	uint32_t t_segqmbuflen;		/* total reassembly queue byte length */
357 	struct	tsegqe_head t_segq;	/* segment reassembly queue */
358 	struct mbuf *t_in_pkt;
359 	struct mbuf *t_tail_pkt;
360 	uint32_t snd_ssthresh;		/* snd_cwnd size threshold for
361 					 * for slow start exponential to
362 					 * linear switch
363 					 */
364 	tcp_seq	snd_wl1;		/* window update seg seq number */
365 	tcp_seq	snd_wl2;		/* window update seg ack number */
366 
367 	tcp_seq	irs;			/* initial receive sequence number */
368 	tcp_seq	iss;			/* initial send sequence number */
369 	u_int	t_acktime;		/* RACK and BBR incoming new data was acked */
370 	u_int	t_sndtime;		/* time last data was sent */
371 	u_int	ts_recent_age;		/* when last updated */
372 	tcp_seq	snd_recover;		/* for use in NewReno Fast Recovery */
373 	char	t_oobflags;		/* have some */
374 	char	t_iobc;			/* input character */
375 	uint8_t t_nic_ktls_xmit:1,	/* active nic ktls xmit sessions */
376 		t_nic_ktls_xmit_dis:1,	/* disabled nic xmit ktls? */
377 		t_nic_ktls_spare:6;	/* spare nic ktls */
378 	int	t_rxtcur;		/* current retransmit value (ticks) */
379 
380 	int	t_rxtshift;		/* log(2) of rexmt exp. backoff */
381 	u_int	t_rtttime;		/* RTT measurement start time */
382 
383 	tcp_seq	t_rtseq;		/* sequence number being timed */
384 	u_int	t_starttime;		/* time connection was established */
385 	u_int	t_fbyte_in;		/* ticks time first byte queued in */
386 	u_int	t_fbyte_out;		/* ticks time first byte queued out */
387 
388 	u_int	t_pmtud_saved_maxseg;	/* pre-blackhole MSS */
389 	int	t_blackhole_enter;	/* when to enter blackhole detection */
390 	int	t_blackhole_exit;	/* when to exit blackhole detection */
391 	u_int	t_rttmin;		/* minimum rtt allowed */
392 
393 	int	t_softerror;		/* possible error not yet reported */
394 	uint32_t max_sndwnd;		/* largest window peer has offered */
395 	uint32_t snd_cwnd_prev;		/* cwnd prior to retransmit */
396 	uint32_t snd_ssthresh_prev;	/* ssthresh prior to retransmit */
397 	tcp_seq	snd_recover_prev;	/* snd_recover prior to retransmit */
398 	int	t_sndzerowin;		/* zero-window updates sent */
399 	int	snd_numholes;		/* number of holes seen by sender */
400 	u_int	t_badrxtwin;		/* window for retransmit recovery */
401 	TAILQ_HEAD(sackhole_head, sackhole) snd_holes;
402 					/* SACK scoreboard (sorted) */
403 	tcp_seq	snd_fack;		/* last seq number(+1) sack'd by rcv'r*/
404 	struct sackblk sackblks[MAX_SACK_BLKS]; /* seq nos. of sack blocks */
405 	struct sackhint	sackhint;	/* SACK scoreboard hint */
406 	int	t_rttlow;		/* smallest observerved RTT */
407 	int	rfbuf_cnt;		/* recv buffer autoscaling byte count */
408 	struct toedev	*tod;		/* toedev handling this connection */
409 	int	t_sndrexmitpack;	/* retransmit packets sent */
410 	int	t_rcvoopack;		/* out-of-order packets received */
411 	void	*t_toe;			/* TOE pcb pointer */
412 	struct cc_algo	*t_cc;		/* congestion control algorithm */
413 	struct cc_var	t_ccv;		/* congestion control specific vars */
414 	int	t_bytes_acked;		/* # bytes acked during current RTT */
415 	u_int	t_maxunacktime;
416 	u_int	t_keepinit;		/* time to establish connection */
417 	u_int	t_keepidle;		/* time before keepalive probes begin */
418 	u_int	t_keepintvl;		/* interval between keepalives */
419 	u_int	t_keepcnt;		/* number of keepalives before close */
420 	int	t_dupacks;		/* consecutive dup acks recd */
421 	int	t_lognum;		/* Number of log entries */
422 	int	t_loglimit;		/* Maximum number of log entries */
423 	uint32_t t_rcep;		/* Number of received CE marked pkts */
424 	uint32_t t_scep;		/* Synced number of delivered CE pkts */
425 	int64_t	t_pacing_rate;		/* bytes / sec, -1 => unlimited */
426 	struct tcp_log_stailq t_logs;	/* Log buffer */
427 	struct tcp_log_id_node *t_lin;
428 	struct tcp_log_id_bucket *t_lib;
429 	const char *t_output_caller;	/* Function that called tcp_output */
430 	struct statsblob *t_stats;	/* Per-connection stats */
431 	/* Should these be a pointer to the arrays or an array? */
432 #ifdef TCP_ACCOUNTING
433 	uint64_t tcp_cnt_counters[TCP_NUM_CNT_COUNTERS];
434 	uint64_t tcp_proc_time[TCP_NUM_CNT_COUNTERS];
435 #endif
436 #ifdef TCP_REQUEST_TRK
437 	uint32_t tcp_hybrid_start;	/* Num of times we started hybrid pacing */
438 	uint32_t tcp_hybrid_stop;	/* Num of times we stopped hybrid pacing */
439 	uint32_t tcp_hybrid_error;	/* Num of times we failed to start hybrid pacing */
440 #endif
441 	uint32_t t_logsn;		/* Log "serial number" */
442 	uint32_t gput_ts;		/* Time goodput measurement started */
443 	tcp_seq gput_seq;		/* Outbound measurement seq */
444 	tcp_seq gput_ack;		/* Inbound measurement ack */
445 	int32_t t_stats_gput_prev;	/* XXXLAS: Prev gput measurement */
446 	uint32_t t_maxpeakrate;		/* max peak rate set by user, bytes/s */
447 	uint32_t t_sndtlppack;		/* tail loss probe packets sent */
448 	uint64_t t_sndtlpbyte;		/* total tail loss probe bytes sent */
449 	uint64_t t_sndbytes;		/* total bytes sent */
450 	uint64_t t_snd_rxt_bytes;	/* total bytes retransmitted */
451 	uint32_t t_dsack_bytes;		/* dsack bytes received */
452 	uint32_t t_dsack_tlp_bytes;	/* dsack bytes received for TLPs sent */
453 	uint32_t t_dsack_pack;		/* dsack packets we have eceived */
454 	uint8_t t_tmr_granularity;	/* Granularity of all timers srtt etc */
455 	uint8_t t_rttupdated;		/* number of times rtt sampled */
456 	/* TCP Fast Open */
457 	uint8_t t_tfo_client_cookie_len; /* TFO client cookie length */
458 	uint32_t t_end_info_status;	/* Status flag of end info */
459 	unsigned int *t_tfo_pending;	/* TFO server pending counter */
460 	union {
461 		uint8_t client[TCP_FASTOPEN_MAX_COOKIE_LEN];
462 		uint64_t server;
463 	} t_tfo_cookie;			/* TCP Fast Open cookie to send */
464 	union {
465 		uint8_t t_end_info_bytes[TCP_END_BYTE_INFO];
466 		uint64_t t_end_info;
467 	};
468 #ifdef TCPPCAP
469 	struct mbufq t_inpkts;		/* List of saved input packets. */
470 	struct mbufq t_outpkts;		/* List of saved output packets. */
471 #endif
472 #ifdef TCP_HHOOK
473 	struct osd	t_osd;		/* storage for Khelp module data */
474 #endif
475 	uint8_t _t_logpoint;	/* Used when a BB log points is enabled */
476 #ifdef TCP_REQUEST_TRK
477 	/* Response tracking addons. */
478 	uint8_t t_http_req;	/* Request count */
479 	uint8_t t_http_open;	/* Number of open range requests */
480 	uint8_t t_http_closed;	/* Number of closed range requests */
481 	struct http_sendfile_track t_http_info[MAX_TCP_HTTP_REQ];
482 #endif
483 };
484 #endif	/* _KERNEL || _WANT_TCPCB */
485 
486 #ifdef _KERNEL
487 struct tcptemp {
488 	u_char	tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
489 	struct	tcphdr tt_t;
490 };
491 
492 /* Enable TCP/UDP tunneling port */
493 #define TCP_TUNNELING_PORT_MIN		0
494 #define TCP_TUNNELING_PORT_MAX		65535
495 #define TCP_TUNNELING_PORT_DEFAULT	0
496 
497 /* Enable TCP/UDP tunneling port */
498 #define TCP_TUNNELING_OVERHEAD_MIN	sizeof(struct udphdr)
499 #define TCP_TUNNELING_OVERHEAD_MAX	1024
500 #define TCP_TUNNELING_OVERHEAD_DEFAULT	TCP_TUNNELING_OVERHEAD_MIN
501 
502 /* Minimum map entries limit value, if set */
503 #define TCP_MIN_MAP_ENTRIES_LIMIT	128
504 
505 /*
506  * TODO: We yet need to brave plowing in
507  * to tcp_input() and the pru_usrreq() block.
508  * Right now these go to the old standards which
509  * are somewhat ok, but in the long term may
510  * need to be changed. If we do tackle tcp_input()
511  * then we need to get rid of the tcp_do_segment()
512  * function below.
513  */
514 /* Flags for tcp functions */
515 #define	TCP_FUNC_BEING_REMOVED	0x01   	/* Can no longer be referenced */
516 #define	TCP_FUNC_OUTPUT_CANDROP	0x02   	/* tfb_tcp_output may ask tcp_drop */
517 
518 /**
519  * If defining the optional tcp_timers, in the
520  * tfb_tcp_timer_stop call you must use the
521  * callout_async_drain() function with the
522  * tcp_timer_discard callback. You should check
523  * the return of callout_async_drain() and if 0
524  * increment tt_draincnt. Since the timer sub-system
525  * does not know your callbacks you must provide a
526  * stop_all function that loops through and calls
527  * tcp_timer_stop() with each of your defined timers.
528  *
529  * Adding a tfb_tcp_handoff_ok function allows the socket
530  * option to change stacks to query you even if the
531  * connection is in a later stage. You return 0 to
532  * say you can take over and run your stack, you return
533  * non-zero (an error number) to say no you can't.
534  * If the function is undefined you can only change
535  * in the early states (before connect or listen).
536  *
537  * tfb_tcp_fb_init is used to allow the new stack to
538  * setup its control block. Among the things it must
539  * do is:
540  * a) Make sure that the inp_flags2 is setup correctly
541  *    for LRO. There are two flags that the previous
542  *    stack may have set INP_MBUF_ACKCMP and
543  *    INP_SUPPORTS_MBUFQ. If the new stack does not
544  *    support these it *should* clear the flags.
545  * b) Make sure that the timers are in the proper
546  *    granularity that the stack wants. The stack
547  *    should check the t_tmr_granularity field. Currently
548  *    there are two values that it may hold
549  *    TCP_TMR_GRANULARITY_TICKS and TCP_TMR_GRANULARITY_USEC.
550  *    Use the functions tcp_timer_convert(tp, granularity);
551  *    to move the timers to the correct format for your stack.
552  *
553  * The new stack may also optionally query the tfb_chg_query
554  * function if the old stack has one. The new stack may ask
555  * for one of three entries and can also state to the old
556  * stack its support for the INP_MBUF_ACKCMP and
557  * INP_SUPPORTS_MBUFQ. This is important since if there are
558  * queued ack's without that statement the old stack will
559  * be forced to discard the queued acks. The requests that
560  * can be made for information by the new stacks are:
561  *
562  * Note also that the tfb_tcp_fb_init() when called can
563  * determine if a query is needed by looking at the
564  * value passed in the ptr. The ptr is designed to be
565  * set in with any allocated memory, but the address
566  * of the condtion (ptr == &tp->t_fb_ptr) will be
567  * true if this is not a stack switch but the initial
568  * setup of a tcb (which means no query would be needed).
569  * If, however, the value is not t_fb_ptr, then the caller
570  * is in the middle of a stack switch and is the new stack.
571  * A query would be appropriate (if the new stack support
572  * the query mechanism).
573  *
574  * TCP_QUERY_SENDMAP - Query of outstanding data.
575  * TCP_QUERY_TIMERS_UP	- Query about running timers.
576  * TCP_SUPPORTED_LRO - Declaration in req_param of
577  *                     the inp_flags2 supported by
578  *                     the new stack.
579  * TCP_QUERY_RACK_TIMES	- Enquire about various timestamps
580  *                        and states the old stack may be in.
581  *
582  * tfb_tcp_fb_fini is changed to add a flag to tell
583  * the old stack if the tcb is being destroyed or
584  * not. A one in the flag means the TCB is being
585  * destroyed, a zero indicates its transitioning to
586  * another stack (via socket option). The
587  * tfb_tcp_fb_fini() function itself should not change timers
588  * or inp_flags2 (the tfb_tcp_fb_init() must do that). However
589  * if the old stack supports the LRO mbuf queuing, and the new
590  * stack does not communicate via chg messages that it too does,
591  * it must assume it does not and free any queued mbufs.
592  *
593  */
594 struct tcp_function_block {
595 	char tfb_tcp_block_name[TCP_FUNCTION_NAME_LEN_MAX];
596 	int	(*tfb_tcp_output)(struct tcpcb *);
597 	void	(*tfb_tcp_do_segment)(struct tcpcb *, struct mbuf *,
598 		    struct tcphdr *, int, int, uint8_t);
599 	int      (*tfb_do_segment_nounlock)(struct tcpcb *, struct mbuf *,
600 		    struct tcphdr *, int, int, uint8_t, int, struct timeval *);
601 	int     (*tfb_do_queued_segments)(struct tcpcb *, int);
602 	int     (*tfb_tcp_ctloutput)(struct tcpcb *, struct sockopt *);
603 	/* Optional memory allocation/free routine */
604 	int	(*tfb_tcp_fb_init)(struct tcpcb *, void **);
605 	void	(*tfb_tcp_fb_fini)(struct tcpcb *, int);
606 	/* Optional timers, must define all if you define one */
607 	int	(*tfb_tcp_timer_stop_all)(struct tcpcb *);
608 	void	(*tfb_tcp_rexmit_tmr)(struct tcpcb *);
609 	int	(*tfb_tcp_handoff_ok)(struct tcpcb *);
610 	void	(*tfb_tcp_mtu_chg)(struct tcpcb *tp);
611 	int	(*tfb_pru_options)(struct tcpcb *, int);
612 	void	(*tfb_hwtls_change)(struct tcpcb *, int);
613 	int	(*tfb_chg_query)(struct tcpcb *, struct tcp_query_resp *);
614 	void	(*tfb_switch_failed)(struct tcpcb *);
615 	bool	(*tfb_early_wake_check)(struct tcpcb *);
616 	int     (*tfb_compute_pipe)(struct tcpcb *tp);
617 	volatile uint32_t tfb_refcnt;
618 	uint32_t  tfb_flags;
619 	uint8_t	tfb_id;
620 };
621 
622 struct tcp_function {
623 	TAILQ_ENTRY(tcp_function)	tf_next;
624 	char				tf_name[TCP_FUNCTION_NAME_LEN_MAX];
625 	struct tcp_function_block	*tf_fb;
626 };
627 
628 TAILQ_HEAD(tcp_funchead, tcp_function);
629 
630 struct tcpcb * tcp_drop(struct tcpcb *, int);
631 
632 #ifdef _NETINET_IN_PCB_H_
633 #define	intotcpcb(inp)	__containerof((inp), struct tcpcb, t_inpcb)
634 #define	sototcpcb(so)	intotcpcb(sotoinpcb(so))
635 #define	tptoinpcb(tp)	(&(tp)->t_inpcb)
636 #define	tptosocket(tp)	(tp)->t_inpcb.inp_socket
637 
638 /*
639  * tcp_output()
640  * Handles tcp_drop request from advanced stacks and reports that inpcb is
641  * gone with negative return code.
642  * Drop in replacement for the default stack.
643  */
644 static inline int
645 tcp_output(struct tcpcb *tp)
646 {
647 	struct inpcb *inp = tptoinpcb(tp);
648 	int rv;
649 
650 	INP_WLOCK_ASSERT(inp);
651 
652 	rv = tp->t_fb->tfb_tcp_output(tp);
653 	if (rv < 0) {
654 		KASSERT(tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
655 		    ("TCP stack %s requested tcp_drop(%p)",
656 		    tp->t_fb->tfb_tcp_block_name, tp));
657 		tp = tcp_drop(tp, -rv);
658 		if (tp)
659 			INP_WUNLOCK(inp);
660 	}
661 
662 	return (rv);
663 }
664 
665 static inline void
666 tcp_lro_features_off(struct inpcb *inp)
667 {
668 	inp->inp_flags2 &= ~(INP_SUPPORTS_MBUFQ|
669 	    INP_MBUF_QUEUE_READY|
670 	    INP_DONT_SACK_QUEUE|
671 	    INP_MBUF_ACKCMP|
672 	    INP_MBUF_L_ACKS);
673 }
674 
675 /*
676  * tcp_output_unlock()
677  * Always returns unlocked, handles drop request from advanced stacks.
678  * Always returns positive error code.
679  */
680 static inline int
681 tcp_output_unlock(struct tcpcb *tp)
682 {
683 	struct inpcb *inp = tptoinpcb(tp);
684 	int rv;
685 
686 	INP_WLOCK_ASSERT(inp);
687 
688 	rv = tp->t_fb->tfb_tcp_output(tp);
689 	if (rv < 0) {
690 		KASSERT(tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
691 		    ("TCP stack %s requested tcp_drop(%p)",
692 		    tp->t_fb->tfb_tcp_block_name, tp));
693 		rv = -rv;
694 		tp = tcp_drop(tp, rv);
695 		if (tp)
696 			INP_WUNLOCK(inp);
697 	} else
698 		INP_WUNLOCK(inp);
699 
700 	return (rv);
701 }
702 
703 /*
704  * tcp_output_nodrop()
705  * Always returns locked.  It is caller's responsibility to run tcp_drop()!
706  * Useful in syscall implementations, when we want to perform some logging
707  * and/or tracing with tcpcb before calling tcp_drop().  To be used with
708  * tcp_unlock_or_drop() later.
709  *
710  * XXXGL: maybe don't allow stacks to return a drop request at certain
711  * TCP states? Why would it do in connect(2)? In recv(2)?
712  */
713 static inline int
714 tcp_output_nodrop(struct tcpcb *tp)
715 {
716 	int rv;
717 
718 	INP_WLOCK_ASSERT(tptoinpcb(tp));
719 
720 	rv = tp->t_fb->tfb_tcp_output(tp);
721 	KASSERT(rv >= 0 || tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
722 	    ("TCP stack %s requested tcp_drop(%p)",
723 	    tp->t_fb->tfb_tcp_block_name, tp));
724 	return (rv);
725 }
726 
727 /*
728  * tcp_unlock_or_drop()
729  * Handle return code from tfb_tcp_output() after we have logged/traced,
730  * to be used with tcp_output_nodrop().
731  */
732 static inline int
733 tcp_unlock_or_drop(struct tcpcb *tp, int tcp_output_retval)
734 {
735 	struct inpcb *inp = tptoinpcb(tp);
736 
737 	INP_WLOCK_ASSERT(inp);
738 
739         if (tcp_output_retval < 0) {
740                 tcp_output_retval = -tcp_output_retval;
741                 if (tcp_drop(tp, tcp_output_retval) != NULL)
742                         INP_WUNLOCK(inp);
743         } else
744 		INP_WUNLOCK(inp);
745 
746 	return (tcp_output_retval);
747 }
748 #endif	/* _NETINET_IN_PCB_H_ */
749 
750 static int inline
751 tcp_packets_this_ack(struct tcpcb *tp, tcp_seq ack)
752 {
753 	return ((ack - tp->snd_una) / tp->t_maxseg +
754 		((((ack - tp->snd_una) % tp->t_maxseg) != 0) ? 1 : 0));
755 }
756 #endif	/* _KERNEL */
757 
758 /*
759  * Flags and utility macros for the t_flags field.
760  */
761 #define	TF_ACKNOW	0x00000001	/* ack peer immediately */
762 #define	TF_DELACK	0x00000002	/* ack, but try to delay it */
763 #define	TF_NODELAY	0x00000004	/* don't delay packets to coalesce */
764 #define	TF_NOOPT	0x00000008	/* don't use tcp options */
765 #define	TF_SENTFIN	0x00000010	/* have sent FIN */
766 #define	TF_REQ_SCALE	0x00000020	/* have/will request window scaling */
767 #define	TF_RCVD_SCALE	0x00000040	/* other side has requested scaling */
768 #define	TF_REQ_TSTMP	0x00000080	/* have/will request timestamps */
769 #define	TF_RCVD_TSTMP	0x00000100	/* a timestamp was received in SYN */
770 #define	TF_SACK_PERMIT	0x00000200	/* other side said I could SACK */
771 #define	TF_NEEDSYN	0x00000400	/* send SYN (implicit state) */
772 #define	TF_NEEDFIN	0x00000800	/* send FIN (implicit state) */
773 #define	TF_NOPUSH	0x00001000	/* don't push */
774 #define	TF_PREVVALID	0x00002000	/* saved values for bad rxmit valid
775 					 * Note: accessing and restoring from
776 					 * these may only be done in the 1st
777 					 * RTO recovery round (t_rxtshift == 1)
778 					 */
779 #define	TF_WAKESOR	0x00004000	/* wake up receive socket */
780 #define	TF_GPUTINPROG	0x00008000	/* Goodput measurement in progress */
781 #define	TF_MORETOCOME	0x00010000	/* More data to be appended to sock */
782 #define	TF_SONOTCONN	0x00020000	/* needs soisconnected() on ESTAB */
783 #define	TF_LASTIDLE	0x00040000	/* connection was previously idle */
784 #define	TF_RXWIN0SENT	0x00080000	/* sent a receiver win 0 in response */
785 #define	TF_FASTRECOVERY	0x00100000	/* in NewReno Fast Recovery */
786 #define	TF_WASFRECOVERY	0x00200000	/* was in NewReno Fast Recovery */
787 #define	TF_SIGNATURE	0x00400000	/* require MD5 digests (RFC2385) */
788 #define	TF_FORCEDATA	0x00800000	/* force out a byte */
789 #define	TF_TSO		0x01000000	/* TSO enabled on this connection */
790 #define	TF_TOE		0x02000000	/* this connection is offloaded */
791 #define	TF_CLOSED	0x04000000	/* close(2) called on socket */
792 #define	TF_UNUSED1	0x08000000	/* unused */
793 #define	TF_LRD		0x10000000	/* Lost Retransmission Detection */
794 #define	TF_CONGRECOVERY	0x20000000	/* congestion recovery mode */
795 #define	TF_WASCRECOVERY	0x40000000	/* was in congestion recovery */
796 #define	TF_FASTOPEN	0x80000000	/* TCP Fast Open indication */
797 
798 #define	IN_FASTRECOVERY(t_flags)	(t_flags & TF_FASTRECOVERY)
799 #define	ENTER_FASTRECOVERY(t_flags)	t_flags |= TF_FASTRECOVERY
800 #define	EXIT_FASTRECOVERY(t_flags)	t_flags &= ~TF_FASTRECOVERY
801 
802 #define	IN_CONGRECOVERY(t_flags)	(t_flags & TF_CONGRECOVERY)
803 #define	ENTER_CONGRECOVERY(t_flags)	t_flags |= TF_CONGRECOVERY
804 #define	EXIT_CONGRECOVERY(t_flags)	t_flags &= ~TF_CONGRECOVERY
805 
806 #define	IN_RECOVERY(t_flags) (t_flags & (TF_CONGRECOVERY | TF_FASTRECOVERY))
807 #define	ENTER_RECOVERY(t_flags) t_flags |= (TF_CONGRECOVERY | TF_FASTRECOVERY)
808 #define	EXIT_RECOVERY(t_flags) t_flags &= ~(TF_CONGRECOVERY | TF_FASTRECOVERY)
809 
810 #if defined(_KERNEL) && !defined(TCP_RFC7413)
811 #define	IS_FASTOPEN(t_flags)		(false)
812 #else
813 #define	IS_FASTOPEN(t_flags)		(t_flags & TF_FASTOPEN)
814 #endif
815 
816 #define	BYTES_THIS_ACK(tp, th)	(th->th_ack - tp->snd_una)
817 
818 /*
819  * Flags for the t_oobflags field.
820  */
821 #define	TCPOOB_HAVEDATA	0x01
822 #define	TCPOOB_HADDATA	0x02
823 
824 /*
825  * Flags for the extended TCP flags field, t_flags2
826  */
827 #define	TF2_PLPMTU_BLACKHOLE	0x00000001 /* Possible PLPMTUD Black Hole. */
828 #define	TF2_PLPMTU_PMTUD	0x00000002 /* Allowed to attempt PLPMTUD. */
829 #define	TF2_PLPMTU_MAXSEGSNT	0x00000004 /* Last seg sent was full seg. */
830 #define	TF2_LOG_AUTO		0x00000008 /* Session is auto-logging. */
831 #define	TF2_DROP_AF_DATA	0x00000010 /* Drop after all data ack'd */
832 #define	TF2_ECN_PERMIT		0x00000020 /* connection ECN-ready */
833 #define	TF2_ECN_SND_CWR		0x00000040 /* ECN CWR in queue */
834 #define	TF2_ECN_SND_ECE		0x00000080 /* ECN ECE in queue */
835 #define	TF2_ACE_PERMIT		0x00000100 /* Accurate ECN mode */
836 #define	TF2_FBYTES_COMPLETE	0x00000400 /* We have first bytes in and out */
837 #define	TF2_ECN_USE_ECT1	0x00000800 /* Use ECT(1) marking on session */
838 #define TF2_TCP_ACCOUNTING	0x00010000 /* Do TCP accounting */
839 
840 /*
841  * Structure to hold TCP options that are only used during segment
842  * processing (in tcp_input), but not held in the tcpcb.
843  * It's basically used to reduce the number of parameters
844  * to tcp_dooptions and tcp_addoptions.
845  * The binary order of the to_flags is relevant for packing of the
846  * options in tcp_addoptions.
847  */
848 struct tcpopt {
849 	u_int32_t	to_flags;	/* which options are present */
850 #define	TOF_MSS		0x0001		/* maximum segment size */
851 #define	TOF_SCALE	0x0002		/* window scaling */
852 #define	TOF_SACKPERM	0x0004		/* SACK permitted */
853 #define	TOF_TS		0x0010		/* timestamp */
854 #define	TOF_SIGNATURE	0x0040		/* TCP-MD5 signature option (RFC2385) */
855 #define	TOF_SACK	0x0080		/* Peer sent SACK option */
856 #define	TOF_FASTOPEN	0x0100		/* TCP Fast Open (TFO) cookie */
857 #define	TOF_MAXOPT	0x0200
858 	u_int32_t	to_tsval;	/* new timestamp */
859 	u_int32_t	to_tsecr;	/* reflected timestamp */
860 	u_char		*to_sacks;	/* pointer to the first SACK blocks */
861 	u_char		*to_signature;	/* pointer to the TCP-MD5 signature */
862 	u_int8_t	*to_tfo_cookie; /* pointer to the TFO cookie */
863 	u_int16_t	to_mss;		/* maximum segment size */
864 	u_int8_t	to_wscale;	/* window scaling */
865 	u_int8_t	to_nsacks;	/* number of SACK blocks */
866 	u_int8_t	to_tfo_len;	/* TFO cookie length */
867 	u_int32_t	to_spare;	/* UTO */
868 };
869 
870 /*
871  * Flags for tcp_dooptions.
872  */
873 #define	TO_SYN		0x01		/* parse SYN-only options */
874 
875 struct hc_metrics_lite {	/* must stay in sync with hc_metrics */
876 	uint32_t	rmx_mtu;	/* MTU for this path */
877 	uint32_t	rmx_ssthresh;	/* outbound gateway buffer limit */
878 	uint32_t	rmx_rtt;	/* estimated round trip time */
879 	uint32_t	rmx_rttvar;	/* estimated rtt variance */
880 	uint32_t	rmx_cwnd;	/* congestion window */
881 	uint32_t	rmx_sendpipe;   /* outbound delay-bandwidth product */
882 	uint32_t	rmx_recvpipe;   /* inbound delay-bandwidth product */
883 };
884 
885 /*
886  * Used by tcp_maxmtu() to communicate interface specific features
887  * and limits at the time of connection setup.
888  */
889 struct tcp_ifcap {
890 	int	ifcap;
891 	u_int	tsomax;
892 	u_int	tsomaxsegcount;
893 	u_int	tsomaxsegsize;
894 };
895 
896 #ifndef _NETINET_IN_PCB_H_
897 struct in_conninfo;
898 #endif /* _NETINET_IN_PCB_H_ */
899 
900 /*
901  * The smoothed round-trip time and estimated variance
902  * are stored as fixed point numbers scaled by the values below.
903  * For convenience, these scales are also used in smoothing the average
904  * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
905  * With these scales, srtt has 3 bits to the right of the binary point,
906  * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
907  * binary point, and is smoothed with an ALPHA of 0.75.
908  */
909 #define	TCP_RTT_SCALE		32	/* multiplier for srtt; 3 bits frac. */
910 #define	TCP_RTT_SHIFT		5	/* shift for srtt; 3 bits frac. */
911 #define	TCP_RTTVAR_SCALE	16	/* multiplier for rttvar; 2 bits */
912 #define	TCP_RTTVAR_SHIFT	4	/* shift for rttvar; 2 bits */
913 #define	TCP_DELTA_SHIFT		2	/* see tcp_input.c */
914 
915 /*
916  * The initial retransmission should happen at rtt + 4 * rttvar.
917  * Because of the way we do the smoothing, srtt and rttvar
918  * will each average +1/2 tick of bias.  When we compute
919  * the retransmit timer, we want 1/2 tick of rounding and
920  * 1 extra tick because of +-1/2 tick uncertainty in the
921  * firing of the timer.  The bias will give us exactly the
922  * 1.5 tick we need.  But, because the bias is
923  * statistical, we have to test that we don't drop below
924  * the minimum feasible timer (which is 2 ticks).
925  * This version of the macro adapted from a paper by Lawrence
926  * Brakmo and Larry Peterson which outlines a problem caused
927  * by insufficient precision in the original implementation,
928  * which results in inappropriately large RTO values for very
929  * fast networks.
930  */
931 #define	TCP_REXMTVAL(tp) \
932 	max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
933 	  + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
934 
935 /*
936  * TCP statistics.
937  * Many of these should be kept per connection,
938  * but that's inconvenient at the moment.
939  */
940 struct	tcpstat {
941 	uint64_t tcps_connattempt;	/* connections initiated */
942 	uint64_t tcps_accepts;		/* connections accepted */
943 	uint64_t tcps_connects;		/* connections established */
944 	uint64_t tcps_drops;		/* connections dropped */
945 	uint64_t tcps_conndrops;	/* embryonic connections dropped */
946 	uint64_t tcps_minmssdrops;	/* average minmss too low drops */
947 	uint64_t tcps_closed;		/* conn. closed (includes drops) */
948 	uint64_t tcps_segstimed;	/* segs where we tried to get rtt */
949 	uint64_t tcps_rttupdated;	/* times we succeeded */
950 	uint64_t tcps_delack;		/* delayed acks sent */
951 	uint64_t tcps_timeoutdrop;	/* conn. dropped in rxmt timeout */
952 	uint64_t tcps_rexmttimeo;	/* retransmit timeouts */
953 	uint64_t tcps_persisttimeo;	/* persist timeouts */
954 	uint64_t tcps_keeptimeo;	/* keepalive timeouts */
955 	uint64_t tcps_keepprobe;	/* keepalive probes sent */
956 	uint64_t tcps_keepdrops;	/* connections dropped in keepalive */
957 	uint64_t tcps_progdrops;	/* drops due to no progress */
958 
959 	uint64_t tcps_sndtotal;		/* total packets sent */
960 	uint64_t tcps_sndpack;		/* data packets sent */
961 	uint64_t tcps_sndbyte;		/* data bytes sent */
962 	uint64_t tcps_sndrexmitpack;	/* data packets retransmitted */
963 	uint64_t tcps_sndrexmitbyte;	/* data bytes retransmitted */
964 	uint64_t tcps_sndrexmitbad;	/* unnecessary packet retransmissions */
965 	uint64_t tcps_sndacks;		/* ack-only packets sent */
966 	uint64_t tcps_sndprobe;		/* window probes sent */
967 	uint64_t tcps_sndurg;		/* packets sent with URG only */
968 	uint64_t tcps_sndwinup;		/* window update-only packets sent */
969 	uint64_t tcps_sndctrl;		/* control (SYN|FIN|RST) packets sent */
970 
971 	uint64_t tcps_rcvtotal;		/* total packets received */
972 	uint64_t tcps_rcvpack;		/* packets received in sequence */
973 	uint64_t tcps_rcvbyte;		/* bytes received in sequence */
974 	uint64_t tcps_rcvbadsum;	/* packets received with ccksum errs */
975 	uint64_t tcps_rcvbadoff;	/* packets received with bad offset */
976 	uint64_t tcps_rcvreassfull;	/* packets dropped for no reass space */
977 	uint64_t tcps_rcvshort;		/* packets received too short */
978 	uint64_t tcps_rcvduppack;	/* duplicate-only packets received */
979 	uint64_t tcps_rcvdupbyte;	/* duplicate-only bytes received */
980 	uint64_t tcps_rcvpartduppack;	/* packets with some duplicate data */
981 	uint64_t tcps_rcvpartdupbyte;	/* dup. bytes in part-dup. packets */
982 	uint64_t tcps_rcvoopack;	/* out-of-order packets received */
983 	uint64_t tcps_rcvoobyte;	/* out-of-order bytes received */
984 	uint64_t tcps_rcvpackafterwin;	/* packets with data after window */
985 	uint64_t tcps_rcvbyteafterwin;	/* bytes rcvd after window */
986 	uint64_t tcps_rcvafterclose;	/* packets rcvd after "close" */
987 	uint64_t tcps_rcvwinprobe;	/* rcvd window probe packets */
988 	uint64_t tcps_rcvdupack;	/* rcvd duplicate acks */
989 	uint64_t tcps_rcvacktoomuch;	/* rcvd acks for unsent data */
990 	uint64_t tcps_rcvackpack;	/* rcvd ack packets */
991 	uint64_t tcps_rcvackbyte;	/* bytes acked by rcvd acks */
992 	uint64_t tcps_rcvwinupd;	/* rcvd window update packets */
993 	uint64_t tcps_pawsdrop;		/* segments dropped due to PAWS */
994 	uint64_t tcps_predack;		/* times hdr predict ok for acks */
995 	uint64_t tcps_preddat;		/* times hdr predict ok for data pkts */
996 	uint64_t tcps_pcbcachemiss;
997 	uint64_t tcps_cachedrtt;	/* times cached RTT in route updated */
998 	uint64_t tcps_cachedrttvar;	/* times cached rttvar updated */
999 	uint64_t tcps_cachedssthresh;	/* times cached ssthresh updated */
1000 	uint64_t tcps_usedrtt;		/* times RTT initialized from route */
1001 	uint64_t tcps_usedrttvar;	/* times RTTVAR initialized from rt */
1002 	uint64_t tcps_usedssthresh;	/* times ssthresh initialized from rt*/
1003 	uint64_t tcps_persistdrop;	/* timeout in persist state */
1004 	uint64_t tcps_badsyn;		/* bogus SYN, e.g. premature ACK */
1005 	uint64_t tcps_mturesent;	/* resends due to MTU discovery */
1006 	uint64_t tcps_listendrop;	/* listen queue overflows */
1007 	uint64_t tcps_badrst;		/* ignored RSTs in the window */
1008 
1009 	uint64_t tcps_sc_added;		/* entry added to syncache */
1010 	uint64_t tcps_sc_retransmitted;	/* syncache entry was retransmitted */
1011 	uint64_t tcps_sc_dupsyn;	/* duplicate SYN packet */
1012 	uint64_t tcps_sc_dropped;	/* could not reply to packet */
1013 	uint64_t tcps_sc_completed;	/* successful extraction of entry */
1014 	uint64_t tcps_sc_bucketoverflow;/* syncache per-bucket limit hit */
1015 	uint64_t tcps_sc_cacheoverflow;	/* syncache cache limit hit */
1016 	uint64_t tcps_sc_reset;		/* RST removed entry from syncache */
1017 	uint64_t tcps_sc_stale;		/* timed out or listen socket gone */
1018 	uint64_t tcps_sc_aborted;	/* syncache entry aborted */
1019 	uint64_t tcps_sc_badack;	/* removed due to bad ACK */
1020 	uint64_t tcps_sc_unreach;	/* ICMP unreachable received */
1021 	uint64_t tcps_sc_zonefail;	/* zalloc() failed */
1022 	uint64_t tcps_sc_sendcookie;	/* SYN cookie sent */
1023 	uint64_t tcps_sc_recvcookie;	/* SYN cookie received */
1024 
1025 	uint64_t tcps_hc_added;		/* entry added to hostcache */
1026 	uint64_t tcps_hc_bucketoverflow;/* hostcache per bucket limit hit */
1027 
1028 	uint64_t tcps_finwait2_drops;    /* Drop FIN_WAIT_2 connection after time limit */
1029 
1030 	/* SACK related stats */
1031 	uint64_t tcps_sack_recovery_episode; /* SACK recovery episodes */
1032 	uint64_t tcps_sack_rexmits;	    /* SACK rexmit segments   */
1033 	uint64_t tcps_sack_rexmit_bytes;    /* SACK rexmit bytes      */
1034 	uint64_t tcps_sack_rcv_blocks;	    /* SACK blocks (options) received */
1035 	uint64_t tcps_sack_send_blocks;	    /* SACK blocks (options) sent     */
1036 	uint64_t tcps_sack_lostrexmt;	    /* SACK lost retransmission recovered */
1037 	uint64_t tcps_sack_sboverflow;	    /* times scoreboard overflowed */
1038 
1039 	/* ECN related stats */
1040 	uint64_t tcps_ecn_rcvce;		/* ECN Congestion Experienced */
1041 	uint64_t tcps_ecn_rcvect0;		/* ECN Capable Transport */
1042 	uint64_t tcps_ecn_rcvect1;		/* ECN Capable Transport */
1043 	uint64_t tcps_ecn_shs;		/* ECN successful handshakes */
1044 	uint64_t tcps_ecn_rcwnd;	/* # times ECN reduced the cwnd */
1045 
1046 	/* TCP_SIGNATURE related stats */
1047 	uint64_t tcps_sig_rcvgoodsig;	/* Total matching signature received */
1048 	uint64_t tcps_sig_rcvbadsig;	/* Total bad signature received */
1049 	uint64_t tcps_sig_err_buildsig;	/* Failed to make signature */
1050 	uint64_t tcps_sig_err_sigopt;	/* No signature expected by socket */
1051 	uint64_t tcps_sig_err_nosigopt;	/* No signature provided by segment */
1052 
1053 	/* Path MTU Discovery Black Hole Detection related stats */
1054 	uint64_t tcps_pmtud_blackhole_activated;	 /* Black Hole Count */
1055 	uint64_t tcps_pmtud_blackhole_activated_min_mss; /* BH at min MSS Count */
1056 	uint64_t tcps_pmtud_blackhole_failed;		 /* Black Hole Failure Count */
1057 
1058 	uint64_t tcps_tunneled_pkts;	/* Packets encap's in UDP received */
1059 	uint64_t tcps_tunneled_errs;	/* Packets that had errors that were UDP encaped */
1060 
1061 	/* Dsack related stats */
1062 	uint64_t tcps_dsack_count;	/* Number of ACKs arriving with DSACKs */
1063 	uint64_t tcps_dsack_bytes;	/* Number of bytes DSACK'ed no TLP */
1064 	uint64_t tcps_dsack_tlp_bytes;	/* Number of bytes DSACK'ed due to TLPs */
1065 
1066 	/* TCPS_TIME_WAIT usage stats */
1067 	uint64_t tcps_tw_recycles;	/* Times time-wait was recycled. */
1068 	uint64_t tcps_tw_resets;	/* Times time-wait sent a reset. */
1069 	uint64_t tcps_tw_responds;	/* Times time-wait sent a valid ack. */
1070 
1071 	/* Accurate ECN Handshake stats */
1072 	uint64_t tcps_ace_nect;		/* ACE SYN packet with Non-ECT */
1073 	uint64_t tcps_ace_ect1;		/* ACE SYN packet with ECT1 */
1074 	uint64_t tcps_ace_ect0;		/* ACE SYN packet with ECT0 */
1075 	uint64_t tcps_ace_ce;		/* ACE SYN packet with CE */
1076 
1077 	/* ECN related stats */
1078 	uint64_t tcps_ecn_sndect0;		/* ECN Capable Transport */
1079 	uint64_t tcps_ecn_sndect1;		/* ECN Capable Transport */
1080 
1081 	/*
1082 	 * BBR and Rack implement TLP's these values count TLP bytes in
1083 	 * two catagories, bytes that were retransmitted and bytes that
1084 	 * were newly transmited. Both types can serve as TLP's but they
1085 	 * are accounted differently.
1086 	 */
1087 	uint64_t tcps_tlpresends;	/* number of tlp resends */
1088 	uint64_t tcps_tlpresend_bytes;	/* number of bytes resent by tlp */
1089 
1090 
1091 	uint64_t _pad[4];		/* 4 TBD placeholder for STABLE */
1092 };
1093 
1094 #define	tcps_rcvmemdrop	tcps_rcvreassfull	/* compat */
1095 
1096 #ifdef _KERNEL
1097 #define	TI_UNLOCKED	1
1098 #define	TI_RLOCKED	2
1099 #include <sys/counter.h>
1100 
1101 VNET_PCPUSTAT_DECLARE(struct tcpstat, tcpstat);	/* tcp statistics */
1102 /*
1103  * In-kernel consumers can use these accessor macros directly to update
1104  * stats.
1105  */
1106 #define	TCPSTAT_ADD(name, val)	\
1107     VNET_PCPUSTAT_ADD(struct tcpstat, tcpstat, name, (val))
1108 #define	TCPSTAT_INC(name)	TCPSTAT_ADD(name, 1)
1109 
1110 /*
1111  * Kernel module consumers must use this accessor macro.
1112  */
1113 void	kmod_tcpstat_add(int statnum, int val);
1114 #define	KMOD_TCPSTAT_ADD(name, val)					\
1115     kmod_tcpstat_add(offsetof(struct tcpstat, name) / sizeof(uint64_t), val)
1116 #define	KMOD_TCPSTAT_INC(name)	KMOD_TCPSTAT_ADD(name, 1)
1117 
1118 /*
1119  * Running TCP connection count by state.
1120  */
1121 VNET_DECLARE(counter_u64_t, tcps_states[TCP_NSTATES]);
1122 #define	V_tcps_states	VNET(tcps_states)
1123 #define	TCPSTATES_INC(state)	counter_u64_add(V_tcps_states[state], 1)
1124 #define	TCPSTATES_DEC(state)	counter_u64_add(V_tcps_states[state], -1)
1125 
1126 /*
1127  * TCP specific helper hook point identifiers.
1128  */
1129 #define	HHOOK_TCP_EST_IN		0
1130 #define	HHOOK_TCP_EST_OUT		1
1131 #define	HHOOK_TCP_LAST			HHOOK_TCP_EST_OUT
1132 
1133 struct tcp_hhook_data {
1134 	struct tcpcb	*tp;
1135 	struct tcphdr	*th;
1136 	struct tcpopt	*to;
1137 	uint32_t	len;
1138 	int		tso;
1139 	tcp_seq		curack;
1140 };
1141 #ifdef TCP_HHOOK
1142 void hhook_run_tcp_est_out(struct tcpcb *tp,
1143 	struct tcphdr *th, struct tcpopt *to,
1144 	uint32_t len, int tso);
1145 #endif
1146 #endif
1147 
1148 /*
1149  * TCB structure exported to user-land via sysctl(3).
1150  *
1151  * Fields prefixed with "xt_" are unique to the export structure, and fields
1152  * with "t_" or other prefixes match corresponding fields of 'struct tcpcb'.
1153  *
1154  * Legend:
1155  * (s) - used by userland utilities in src
1156  * (p) - used by utilities in ports
1157  * (3) - is known to be used by third party software not in ports
1158  * (n) - no known usage
1159  *
1160  * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
1161  * included.  Not all of our clients do.
1162  */
1163 #if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
1164 struct xtcpcb {
1165 	ksize_t	xt_len;		/* length of this structure */
1166 	struct xinpcb	xt_inp;
1167 	char		xt_stack[TCP_FUNCTION_NAME_LEN_MAX];	/* (s) */
1168 	char		xt_logid[TCP_LOG_ID_LEN];	/* (s) */
1169 	char		xt_cc[TCP_CA_NAME_MAX];	/* (s) */
1170 	int64_t		spare64[6];
1171 	int32_t		t_state;		/* (s,p) */
1172 	uint32_t	t_flags;		/* (s,p) */
1173 	int32_t		t_sndzerowin;		/* (s) */
1174 	int32_t		t_sndrexmitpack;	/* (s) */
1175 	int32_t		t_rcvoopack;		/* (s) */
1176 	int32_t		t_rcvtime;		/* (s) */
1177 	int32_t		tt_rexmt;		/* (s) */
1178 	int32_t		tt_persist;		/* (s) */
1179 	int32_t		tt_keep;		/* (s) */
1180 	int32_t		tt_2msl;		/* (s) */
1181 	int32_t		tt_delack;		/* (s) */
1182 	int32_t		t_logstate;		/* (3) */
1183 	uint32_t	t_snd_cwnd;		/* (s) */
1184 	uint32_t	t_snd_ssthresh;		/* (s) */
1185 	uint32_t	t_maxseg;		/* (s) */
1186 	uint32_t	t_rcv_wnd;		/* (s) */
1187 	uint32_t	t_snd_wnd;		/* (s) */
1188 	uint32_t	xt_ecn;			/* (s) */
1189 	uint32_t	t_dsack_bytes;		/* (n) */
1190 	uint32_t	t_dsack_tlp_bytes;	/* (n) */
1191 	uint32_t	t_dsack_pack;		/* (n) */
1192 	uint16_t	xt_encaps_port;		/* (s) */
1193 	int16_t		spare16;
1194 	int32_t		spare32[22];
1195 } __aligned(8);
1196 
1197 #ifdef _KERNEL
1198 void	tcp_inptoxtp(const struct inpcb *, struct xtcpcb *);
1199 #endif
1200 #endif
1201 
1202 /*
1203  * TCP function information (name-to-id mapping, aliases, and refcnt)
1204  * exported to user-land via sysctl(3).
1205  */
1206 struct tcp_function_info {
1207 	uint32_t	tfi_refcnt;
1208 	uint8_t		tfi_id;
1209 	char		tfi_name[TCP_FUNCTION_NAME_LEN_MAX];
1210 	char		tfi_alias[TCP_FUNCTION_NAME_LEN_MAX];
1211 };
1212 
1213 /*
1214  * Identifiers for TCP sysctl nodes
1215  */
1216 #define	TCPCTL_DO_RFC1323	1	/* use RFC-1323 extensions */
1217 #define	TCPCTL_MSSDFLT		3	/* MSS default */
1218 #define TCPCTL_STATS		4	/* statistics */
1219 #define	TCPCTL_RTTDFLT		5	/* default RTT estimate */
1220 #define	TCPCTL_KEEPIDLE		6	/* keepalive idle timer */
1221 #define	TCPCTL_KEEPINTVL	7	/* interval to send keepalives */
1222 #define	TCPCTL_SENDSPACE	8	/* send buffer space */
1223 #define	TCPCTL_RECVSPACE	9	/* receive buffer space */
1224 #define	TCPCTL_KEEPINIT		10	/* timeout for establishing syn */
1225 #define	TCPCTL_PCBLIST		11	/* list of all outstanding PCBs */
1226 #define	TCPCTL_DELACKTIME	12	/* time before sending delayed ACK */
1227 #define	TCPCTL_V6MSSDFLT	13	/* MSS default for IPv6 */
1228 #define	TCPCTL_SACK		14	/* Selective Acknowledgement,rfc 2018 */
1229 #define	TCPCTL_DROP		15	/* drop tcp connection */
1230 #define	TCPCTL_STATES		16	/* connection counts by TCP state */
1231 
1232 #ifdef _KERNEL
1233 #ifdef SYSCTL_DECL
1234 SYSCTL_DECL(_net_inet_tcp);
1235 SYSCTL_DECL(_net_inet_tcp_sack);
1236 MALLOC_DECLARE(M_TCPLOG);
1237 #endif
1238 
1239 VNET_DECLARE(int, tcp_log_in_vain);
1240 #define	V_tcp_log_in_vain		VNET(tcp_log_in_vain)
1241 
1242 /*
1243  * Global TCP tunables shared between different stacks.
1244  * Please keep the list sorted.
1245  */
1246 VNET_DECLARE(int, drop_synfin);
1247 VNET_DECLARE(int, path_mtu_discovery);
1248 VNET_DECLARE(int, tcp_abc_l_var);
1249 VNET_DECLARE(int, tcp_autorcvbuf_max);
1250 VNET_DECLARE(int, tcp_autosndbuf_inc);
1251 VNET_DECLARE(int, tcp_autosndbuf_max);
1252 VNET_DECLARE(int, tcp_delack_enabled);
1253 VNET_DECLARE(int, tcp_do_autorcvbuf);
1254 VNET_DECLARE(int, tcp_do_autosndbuf);
1255 VNET_DECLARE(int, tcp_do_ecn);
1256 VNET_DECLARE(int, tcp_do_lrd);
1257 VNET_DECLARE(int, tcp_do_prr);
1258 VNET_DECLARE(int, tcp_do_prr_conservative);
1259 VNET_DECLARE(int, tcp_do_newcwv);
1260 VNET_DECLARE(int, tcp_do_rfc1323);
1261 VNET_DECLARE(int, tcp_tolerate_missing_ts);
1262 VNET_DECLARE(int, tcp_do_rfc3042);
1263 VNET_DECLARE(int, tcp_do_rfc3390);
1264 VNET_DECLARE(int, tcp_do_rfc3465);
1265 VNET_DECLARE(int, tcp_do_newsack);
1266 VNET_DECLARE(int, tcp_do_sack);
1267 VNET_DECLARE(int, tcp_do_tso);
1268 VNET_DECLARE(int, tcp_ecn_maxretries);
1269 VNET_DECLARE(int, tcp_initcwnd_segments);
1270 VNET_DECLARE(int, tcp_insecure_rst);
1271 VNET_DECLARE(int, tcp_insecure_syn);
1272 VNET_DECLARE(uint32_t, tcp_map_entries_limit);
1273 VNET_DECLARE(uint32_t, tcp_map_split_limit);
1274 VNET_DECLARE(int, tcp_minmss);
1275 VNET_DECLARE(int, tcp_mssdflt);
1276 #ifdef STATS
1277 VNET_DECLARE(int, tcp_perconn_stats_dflt_tpl);
1278 VNET_DECLARE(int, tcp_perconn_stats_enable);
1279 #endif /* STATS */
1280 VNET_DECLARE(int, tcp_recvspace);
1281 VNET_DECLARE(int, tcp_sack_globalholes);
1282 VNET_DECLARE(int, tcp_sack_globalmaxholes);
1283 VNET_DECLARE(int, tcp_sack_maxholes);
1284 VNET_DECLARE(int, tcp_sc_rst_sock_fail);
1285 VNET_DECLARE(int, tcp_sendspace);
1286 VNET_DECLARE(int, tcp_udp_tunneling_overhead);
1287 VNET_DECLARE(int, tcp_udp_tunneling_port);
1288 VNET_DECLARE(struct inpcbinfo, tcbinfo);
1289 
1290 #define	V_tcp_do_lrd			VNET(tcp_do_lrd)
1291 #define	V_tcp_do_prr			VNET(tcp_do_prr)
1292 #define	V_tcp_do_prr_conservative	VNET(tcp_do_prr_conservative)
1293 #define	V_tcp_do_newcwv			VNET(tcp_do_newcwv)
1294 #define	V_drop_synfin			VNET(drop_synfin)
1295 #define	V_path_mtu_discovery		VNET(path_mtu_discovery)
1296 #define	V_tcbinfo			VNET(tcbinfo)
1297 #define	V_tcp_abc_l_var			VNET(tcp_abc_l_var)
1298 #define	V_tcp_autorcvbuf_max		VNET(tcp_autorcvbuf_max)
1299 #define	V_tcp_autosndbuf_inc		VNET(tcp_autosndbuf_inc)
1300 #define	V_tcp_autosndbuf_max		VNET(tcp_autosndbuf_max)
1301 #define	V_tcp_delack_enabled		VNET(tcp_delack_enabled)
1302 #define	V_tcp_do_autorcvbuf		VNET(tcp_do_autorcvbuf)
1303 #define	V_tcp_do_autosndbuf		VNET(tcp_do_autosndbuf)
1304 #define	V_tcp_do_ecn			VNET(tcp_do_ecn)
1305 #define	V_tcp_do_rfc1323		VNET(tcp_do_rfc1323)
1306 #define	V_tcp_tolerate_missing_ts	VNET(tcp_tolerate_missing_ts)
1307 #define V_tcp_ts_offset_per_conn	VNET(tcp_ts_offset_per_conn)
1308 #define	V_tcp_do_rfc3042		VNET(tcp_do_rfc3042)
1309 #define	V_tcp_do_rfc3390		VNET(tcp_do_rfc3390)
1310 #define	V_tcp_do_rfc3465		VNET(tcp_do_rfc3465)
1311 #define	V_tcp_do_newsack		VNET(tcp_do_newsack)
1312 #define	V_tcp_do_sack			VNET(tcp_do_sack)
1313 #define	V_tcp_do_tso			VNET(tcp_do_tso)
1314 #define	V_tcp_ecn_maxretries		VNET(tcp_ecn_maxretries)
1315 #define	V_tcp_initcwnd_segments		VNET(tcp_initcwnd_segments)
1316 #define	V_tcp_insecure_rst		VNET(tcp_insecure_rst)
1317 #define	V_tcp_insecure_syn		VNET(tcp_insecure_syn)
1318 #define	V_tcp_map_entries_limit		VNET(tcp_map_entries_limit)
1319 #define	V_tcp_map_split_limit		VNET(tcp_map_split_limit)
1320 #define	V_tcp_minmss			VNET(tcp_minmss)
1321 #define	V_tcp_mssdflt			VNET(tcp_mssdflt)
1322 #ifdef STATS
1323 #define	V_tcp_perconn_stats_dflt_tpl	VNET(tcp_perconn_stats_dflt_tpl)
1324 #define	V_tcp_perconn_stats_enable	VNET(tcp_perconn_stats_enable)
1325 #endif /* STATS */
1326 #define	V_tcp_recvspace			VNET(tcp_recvspace)
1327 #define	V_tcp_sack_globalholes		VNET(tcp_sack_globalholes)
1328 #define	V_tcp_sack_globalmaxholes	VNET(tcp_sack_globalmaxholes)
1329 #define	V_tcp_sack_maxholes		VNET(tcp_sack_maxholes)
1330 #define	V_tcp_sc_rst_sock_fail		VNET(tcp_sc_rst_sock_fail)
1331 #define	V_tcp_sendspace			VNET(tcp_sendspace)
1332 #define	V_tcp_udp_tunneling_overhead	VNET(tcp_udp_tunneling_overhead)
1333 #define	V_tcp_udp_tunneling_port	VNET(tcp_udp_tunneling_port)
1334 
1335 #ifdef TCP_HHOOK
1336 VNET_DECLARE(struct hhook_head *, tcp_hhh[HHOOK_TCP_LAST + 1]);
1337 #define	V_tcp_hhh		VNET(tcp_hhh)
1338 #endif
1339 
1340 int	 tcp_addoptions(struct tcpopt *, u_char *);
1341 struct tcpcb *
1342 	 tcp_close(struct tcpcb *);
1343 void	 tcp_discardcb(struct tcpcb *);
1344 void	 tcp_twstart(struct tcpcb *);
1345 int	 tcp_ctloutput(struct socket *, struct sockopt *);
1346 void	 tcp_fini(void *);
1347 char	*tcp_log_addrs(struct in_conninfo *, struct tcphdr *, const void *,
1348 	    const void *);
1349 char	*tcp_log_vain(struct in_conninfo *, struct tcphdr *, const void *,
1350 	    const void *);
1351 int	 tcp_reass(struct tcpcb *, struct tcphdr *, tcp_seq *, int *,
1352 	    struct mbuf *);
1353 void	 tcp_reass_global_init(void);
1354 void	 tcp_reass_flush(struct tcpcb *);
1355 void	 tcp_dooptions(struct tcpopt *, u_char *, int, int);
1356 void	tcp_dropwithreset(struct mbuf *, struct tcphdr *,
1357 		     struct tcpcb *, int, int);
1358 void	tcp_pulloutofband(struct socket *,
1359 		     struct tcphdr *, struct mbuf *, int);
1360 void	tcp_xmit_timer(struct tcpcb *, int);
1361 void	tcp_newreno_partial_ack(struct tcpcb *, struct tcphdr *);
1362 void	cc_ack_received(struct tcpcb *tp, struct tcphdr *th,
1363 			    uint16_t nsegs, uint16_t type);
1364 void 	cc_conn_init(struct tcpcb *tp);
1365 void 	cc_post_recovery(struct tcpcb *tp, struct tcphdr *th);
1366 void    cc_ecnpkt_handler(struct tcpcb *tp, struct tcphdr *th, uint8_t iptos);
1367 void	cc_ecnpkt_handler_flags(struct tcpcb *tp, uint16_t flags, uint8_t iptos);
1368 void	cc_cong_signal(struct tcpcb *tp, struct tcphdr *th, uint32_t type);
1369 #ifdef TCP_HHOOK
1370 void	hhook_run_tcp_est_in(struct tcpcb *tp,
1371 			    struct tcphdr *th, struct tcpopt *to);
1372 #endif
1373 
1374 int	 tcp_input(struct mbuf **, int *, int);
1375 int	 tcp_autorcvbuf(struct mbuf *, struct tcphdr *, struct socket *,
1376 	    struct tcpcb *, int);
1377 int	 tcp_input_with_port(struct mbuf **, int *, int, uint16_t);
1378 void	tcp_do_segment(struct tcpcb *, struct mbuf *, struct tcphdr *, int,
1379     int, uint8_t);
1380 
1381 int register_tcp_functions(struct tcp_function_block *blk, int wait);
1382 int register_tcp_functions_as_names(struct tcp_function_block *blk,
1383     int wait, const char *names[], int *num_names);
1384 int register_tcp_functions_as_name(struct tcp_function_block *blk,
1385     const char *name, int wait);
1386 int deregister_tcp_functions(struct tcp_function_block *blk, bool quiesce,
1387     bool force);
1388 struct tcp_function_block *find_and_ref_tcp_functions(struct tcp_function_set *fs);
1389 int find_tcp_function_alias(struct tcp_function_block *blk, struct tcp_function_set *fs);
1390 void tcp_switch_back_to_default(struct tcpcb *tp);
1391 struct tcp_function_block *
1392 find_and_ref_tcp_fb(struct tcp_function_block *fs);
1393 int tcp_default_ctloutput(struct tcpcb *tp, struct sockopt *sopt);
1394 int tcp_ctloutput_set(struct inpcb *inp, struct sockopt *sopt);
1395 void tcp_log_socket_option(struct tcpcb *tp, uint32_t option_num,
1396     uint32_t option_val, int err);
1397 
1398 
1399 extern counter_u64_t tcp_inp_lro_direct_queue;
1400 extern counter_u64_t tcp_inp_lro_wokeup_queue;
1401 extern counter_u64_t tcp_inp_lro_compressed;
1402 extern counter_u64_t tcp_inp_lro_locks_taken;
1403 extern counter_u64_t tcp_extra_mbuf;
1404 extern counter_u64_t tcp_would_have_but;
1405 extern counter_u64_t tcp_comp_total;
1406 extern counter_u64_t tcp_uncomp_total;
1407 extern counter_u64_t tcp_bad_csums;
1408 
1409 #ifdef TCP_SAD_DETECTION
1410 /* Various SACK attack thresholds */
1411 extern int32_t tcp_force_detection;
1412 extern int32_t tcp_sad_limit;
1413 extern int32_t tcp_sack_to_ack_thresh;
1414 extern int32_t tcp_sack_to_move_thresh;
1415 extern int32_t tcp_restoral_thresh;
1416 extern int32_t tcp_sad_decay_val;
1417 extern int32_t tcp_sad_pacing_interval;
1418 extern int32_t tcp_sad_low_pps;
1419 extern int32_t tcp_map_minimum;
1420 extern int32_t tcp_attack_on_turns_on_logging;
1421 #endif
1422 extern uint32_t tcp_ack_war_time_window;
1423 extern uint32_t tcp_ack_war_cnt;
1424 
1425 uint32_t tcp_maxmtu(struct in_conninfo *, struct tcp_ifcap *);
1426 uint32_t tcp_maxmtu6(struct in_conninfo *, struct tcp_ifcap *);
1427 void	 tcp6_use_min_mtu(struct tcpcb *);
1428 u_int	 tcp_maxseg(const struct tcpcb *);
1429 u_int	 tcp_fixed_maxseg(const struct tcpcb *);
1430 void	 tcp_mss_update(struct tcpcb *, int, int, struct hc_metrics_lite *,
1431 	    struct tcp_ifcap *);
1432 void	 tcp_mss(struct tcpcb *, int);
1433 int	 tcp_mssopt(struct in_conninfo *);
1434 struct tcpcb *
1435 	 tcp_newtcpcb(struct inpcb *);
1436 int	 tcp_default_output(struct tcpcb *);
1437 void	 tcp_state_change(struct tcpcb *, int);
1438 void	 tcp_respond(struct tcpcb *, void *,
1439 	    struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, uint16_t);
1440 bool	 tcp_twcheck(struct inpcb *, struct tcpopt *, struct tcphdr *,
1441 	    struct mbuf *, int);
1442 void	 tcp_setpersist(struct tcpcb *);
1443 void	 tcp_record_dsack(struct tcpcb *tp, tcp_seq start, tcp_seq end, int tlp);
1444 struct tcptemp *
1445 	 tcpip_maketemplate(struct inpcb *);
1446 void	 tcpip_fillheaders(struct inpcb *, uint16_t, void *, void *);
1447 void	 tcp_timer_activate(struct tcpcb *, tt_which, u_int);
1448 bool	 tcp_timer_active(struct tcpcb *, tt_which);
1449 void	 tcp_timer_stop(struct tcpcb *);
1450 int	 inp_to_cpuid(struct inpcb *inp);
1451 /*
1452  * All tcp_hc_* functions are IPv4 and IPv6 (via in_conninfo)
1453  */
1454 void	 tcp_hc_init(void);
1455 #ifdef VIMAGE
1456 void	 tcp_hc_destroy(void);
1457 #endif
1458 void	 tcp_hc_get(struct in_conninfo *, struct hc_metrics_lite *);
1459 uint32_t tcp_hc_getmtu(struct in_conninfo *);
1460 void	 tcp_hc_updatemtu(struct in_conninfo *, uint32_t);
1461 void	 tcp_hc_update(struct in_conninfo *, struct hc_metrics_lite *);
1462 void 	 cc_after_idle(struct tcpcb *tp);
1463 
1464 extern	struct protosw tcp_protosw;		/* shared for TOE */
1465 extern	struct protosw tcp6_protosw;		/* shared for TOE */
1466 
1467 uint32_t tcp_new_ts_offset(struct in_conninfo *);
1468 tcp_seq	 tcp_new_isn(struct in_conninfo *);
1469 
1470 int	 tcp_sack_doack(struct tcpcb *, struct tcpopt *, tcp_seq);
1471 int	 tcp_dsack_block_exists(struct tcpcb *);
1472 void	 tcp_update_dsack_list(struct tcpcb *, tcp_seq, tcp_seq);
1473 void	 tcp_update_sack_list(struct tcpcb *tp, tcp_seq rcv_laststart, tcp_seq rcv_lastend);
1474 void	 tcp_clean_dsack_blocks(struct tcpcb *tp);
1475 void	 tcp_clean_sackreport(struct tcpcb *tp);
1476 void	 tcp_sack_adjust(struct tcpcb *tp);
1477 struct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt);
1478 void	 tcp_do_prr_ack(struct tcpcb *, struct tcphdr *, struct tcpopt *);
1479 void	 tcp_lost_retransmission(struct tcpcb *, struct tcphdr *);
1480 void	 tcp_sack_partialack(struct tcpcb *, struct tcphdr *);
1481 void	 tcp_free_sackholes(struct tcpcb *tp);
1482 void	 tcp_sack_lost_retransmission(struct tcpcb *, struct tcphdr *);
1483 int	 tcp_newreno(struct tcpcb *, struct tcphdr *);
1484 int	 tcp_compute_pipe(struct tcpcb *);
1485 uint32_t tcp_compute_initwnd(uint32_t);
1486 void	 tcp_sndbuf_autoscale(struct tcpcb *, struct socket *, uint32_t);
1487 int	 tcp_stats_sample_rollthedice(struct tcpcb *tp, void *seed_bytes,
1488     size_t seed_len);
1489 int tcp_can_enable_pacing(void);
1490 void tcp_decrement_paced_conn(void);
1491 void tcp_change_time_units(struct tcpcb *, int);
1492 void tcp_handle_orphaned_packets(struct tcpcb *);
1493 
1494 struct mbuf *
1495 	 tcp_m_copym(struct mbuf *m, int32_t off0, int32_t *plen,
1496 	   int32_t seglimit, int32_t segsize, struct sockbuf *sb, bool hw_tls);
1497 
1498 int	tcp_stats_init(void);
1499 void tcp_log_end_status(struct tcpcb *tp, uint8_t status);
1500 #ifdef TCP_REQUEST_TRK
1501 void tcp_http_free_a_slot(struct tcpcb *tp, struct http_sendfile_track *ent);
1502 struct http_sendfile_track *
1503 tcp_http_find_a_req_that_is_completed_by(struct tcpcb *tp, tcp_seq th_ack, int *ip);
1504 int tcp_http_check_for_comp(struct tcpcb *tp, tcp_seq ack_point);
1505 int
1506 tcp_http_is_entry_comp(struct tcpcb *tp, struct http_sendfile_track *ent, tcp_seq ack_point);
1507 struct http_sendfile_track *
1508 tcp_http_find_req_for_seq(struct tcpcb *tp, tcp_seq seq);
1509 void
1510 tcp_http_log_req_info(struct tcpcb *tp,
1511     struct http_sendfile_track *http, uint16_t slot,
1512     uint8_t val, uint64_t offset, uint64_t nbytes);
1513 
1514 uint32_t
1515 tcp_estimate_tls_overhead(struct socket *so, uint64_t tls_usr_bytes);
1516 void
1517 tcp_http_alloc_req(struct tcpcb *tp, union tcp_log_userdata *user,
1518     uint64_t ts);
1519 
1520 struct http_sendfile_track *
1521 tcp_http_alloc_req_full(struct tcpcb *tp, struct http_req *req, uint64_t ts, int rec_dups);
1522 
1523 
1524 #endif
1525 #ifdef TCP_ACCOUNTING
1526 int tcp_do_ack_accounting(struct tcpcb *tp, struct tcphdr *th, struct tcpopt *to, uint32_t tiwin, int mss);
1527 #endif
1528 
1529 
1530 static inline void
1531 tcp_fields_to_host(struct tcphdr *th)
1532 {
1533 
1534 	th->th_seq = ntohl(th->th_seq);
1535 	th->th_ack = ntohl(th->th_ack);
1536 	th->th_win = ntohs(th->th_win);
1537 	th->th_urp = ntohs(th->th_urp);
1538 }
1539 
1540 static inline void
1541 tcp_fields_to_net(struct tcphdr *th)
1542 {
1543 
1544 	th->th_seq = htonl(th->th_seq);
1545 	th->th_ack = htonl(th->th_ack);
1546 	th->th_win = htons(th->th_win);
1547 	th->th_urp = htons(th->th_urp);
1548 }
1549 
1550 static inline uint16_t
1551 tcp_get_flags(const struct tcphdr *th)
1552 {
1553         return (((uint16_t)th->th_x2 << 8) | th->th_flags);
1554 }
1555 
1556 static inline void
1557 tcp_set_flags(struct tcphdr *th, uint16_t flags)
1558 {
1559         th->th_x2    = (flags >> 8) & 0x0f;
1560         th->th_flags = flags & 0xff;
1561 }
1562 
1563 static inline void
1564 tcp_account_for_send(struct tcpcb *tp, uint32_t len, uint8_t is_rxt,
1565     uint8_t is_tlp, bool hw_tls)
1566 {
1567 	if (is_tlp) {
1568 		tp->t_sndtlppack++;
1569 		tp->t_sndtlpbyte += len;
1570 	}
1571 	/* To get total bytes sent you must add t_snd_rxt_bytes to t_sndbytes */
1572 	if (is_rxt)
1573 		tp->t_snd_rxt_bytes += len;
1574 	else
1575 		tp->t_sndbytes += len;
1576 
1577 #ifdef KERN_TLS
1578 	if (hw_tls && is_rxt && len != 0) {
1579 		uint64_t rexmit_percent = (1000ULL * tp->t_snd_rxt_bytes) / (10ULL * (tp->t_snd_rxt_bytes + tp->t_sndbytes));
1580 		if (rexmit_percent > ktls_ifnet_max_rexmit_pct)
1581 			ktls_disable_ifnet(tp);
1582 	}
1583 #endif
1584 
1585 }
1586 #endif /* _KERNEL */
1587 
1588 #endif /* _NETINET_TCP_VAR_H_ */
1589