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