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