2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1993, 1994, 1995
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 * @(#)tcp_var.h 8.4 (Berkeley) 5/24/95
35 #ifndef _NETINET_TCP_VAR_H_
36 #define _NETINET_TCP_VAR_H_
38 #include <netinet/tcp.h>
39 #include <netinet/tcp_fsm.h>
42 #include "opt_kern_tls.h"
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
64 /************************************************/
65 /* Status bits we track to assure no duplicates,
66 * the bits here are not used by the code but
67 * for human representation. To check a bit we
68 * take and shift over by 1 minus the value (1-8).
70 /************************************************/
71 #define TCP_EI_BITS_CLIENT_FIN 0x001
72 #define TCP_EI_BITS_CLIENT_RST 0x002
73 #define TCP_EI_BITS_SERVER_FIN 0x004
74 #define TCP_EI_BITS_SERVER_RST 0x008
75 #define TCP_EI_BITS_RETRAN 0x010
76 #define TCP_EI_BITS_PROGRESS 0x020
77 #define TCP_EI_BITS_PRESIST_MAX 0x040
78 #define TCP_EI_BITS_KEEP_MAX 0x080
79 #define TCP_EI_BITS_DATA_A_CLO 0x100
80 #define TCP_EI_BITS_RST_IN_FR 0x200 /* a front state reset */
81 #define TCP_EI_BITS_2MS_TIMER 0x400 /* 2 MSL timer expired */
83 #if defined(_KERNEL) || defined(_WANT_TCPCB)
84 /* TCP segment queue entry */
86 TAILQ_ENTRY(tseg_qent) tqe_q;
87 struct mbuf *tqe_m; /* mbuf contains packet */
88 struct mbuf *tqe_last; /* last mbuf in chain */
89 tcp_seq tqe_start; /* TCP Sequence number start */
90 int tqe_len; /* TCP segment data length */
91 uint32_t tqe_flags; /* The flags from tcp_get_flags() */
92 uint32_t tqe_mbuf_cnt; /* Count of mbuf overhead */
94 TAILQ_HEAD(tsegqe_head, tseg_qent);
97 tcp_seq start; /* start seq no. of sack block */
98 tcp_seq end; /* end seq no. */
102 tcp_seq start; /* start seq no. of hole */
103 tcp_seq end; /* end seq no. */
104 tcp_seq rxmit; /* next seq. no in hole to be retransmitted */
105 TAILQ_ENTRY(sackhole) scblink; /* scoreboard linkage */
109 struct sackhole *nexthole;
110 int32_t sack_bytes_rexmit;
111 tcp_seq last_sack_ack; /* Most recent/largest sacked ack */
113 int32_t delivered_data; /* Newly acked data from last SACK */
115 int32_t sacked_bytes; /* Total sacked bytes reported by the
116 * receiver via sack option
118 uint32_t recover_fs; /* Flight Size at the start of Loss recovery */
119 uint32_t prr_delivered; /* Total bytes delivered using PRR */
120 uint32_t prr_out; /* Bytes sent during IN_RECOVERY */
123 #define SEGQ_EMPTY(tp) TAILQ_EMPTY(&(tp)->t_segq)
125 STAILQ_HEAD(tcp_log_stailq, tcp_log_mem);
128 * Tcp control block, one per tcp; fields:
129 * Organized for 64 byte cacheline efficiency based
130 * on common tcp_input/tcp_output processing.
134 struct inpcb *t_inpcb; /* back pointer to internet pcb */
135 struct tcp_function_block *t_fb;/* TCP function call block */
136 void *t_fb_ptr; /* Pointer to t_fb specific data */
137 uint32_t t_maxseg:24, /* maximum segment size */
138 t_logstate:8; /* State of "black box" logging */
139 uint32_t t_port:16, /* Tunneling (over udp) port */
140 t_state:4, /* state of this connection */
142 t_delayed_ack: 7, /* Delayed ack variable */
143 t_fin_is_rst: 1, /* Are fin's treated as resets */
147 tcp_seq snd_una; /* sent but unacknowledged */
148 tcp_seq snd_max; /* highest sequence number sent;
149 * used to recognize retransmits
151 tcp_seq snd_nxt; /* send next */
152 tcp_seq snd_up; /* send urgent pointer */
153 uint32_t snd_wnd; /* send window */
154 uint32_t snd_cwnd; /* congestion-controlled window */
155 uint32_t t_peakrate_thr; /* pre-calculated peak rate threshold */
157 u_int32_t ts_offset; /* our timestamp offset */
158 u_int32_t rfbuf_ts; /* recv buffer autoscaling timestamp */
159 int rcv_numsacks; /* # distinct sack blks present */
160 u_int t_tsomax; /* TSO total burst length limit in bytes */
161 u_int t_tsomaxsegcount; /* TSO maximum segment count */
162 u_int t_tsomaxsegsize; /* TSO maximum segment size in bytes */
163 tcp_seq rcv_nxt; /* receive next */
164 tcp_seq rcv_adv; /* advertised window */
165 uint32_t rcv_wnd; /* receive window */
166 u_int t_flags2; /* More tcpcb flags storage */
167 int t_srtt; /* smoothed round-trip time */
168 int t_rttvar; /* variance in round-trip time */
169 u_int32_t ts_recent; /* timestamp echo data */
170 u_char snd_scale; /* window scaling for send window */
171 u_char rcv_scale; /* window scaling for recv window */
172 u_char snd_limited; /* segments limited transmitted */
173 u_char request_r_scale; /* pending window scaling */
174 tcp_seq last_ack_sent;
175 u_int t_rcvtime; /* inactivity time */
177 tcp_seq rcv_up; /* receive urgent pointer */
178 int t_segqlen; /* segment reassembly queue length */
179 uint32_t t_segqmbuflen; /* Count of bytes mbufs on all entries */
180 struct tsegqe_head t_segq; /* segment reassembly queue */
181 struct mbuf *t_in_pkt;
182 struct mbuf *t_tail_pkt;
183 struct tcp_timer *t_timers; /* All the TCP timers in one struct */
184 struct vnet *t_vnet; /* back pointer to parent vnet */
185 uint32_t snd_ssthresh; /* snd_cwnd size threshold for
186 * for slow start exponential to
189 tcp_seq snd_wl1; /* window update seg seq number */
191 tcp_seq snd_wl2; /* window update seg ack number */
193 tcp_seq irs; /* initial receive sequence number */
194 tcp_seq iss; /* initial send sequence number */
195 u_int t_acktime; /* RACK and BBR incoming new data was acked */
196 u_int t_sndtime; /* time last data was sent */
197 u_int ts_recent_age; /* when last updated */
198 tcp_seq snd_recover; /* for use in NewReno Fast Recovery */
199 uint16_t cl4_spare; /* Spare to adjust CL 4 */
200 char t_oobflags; /* have some */
201 char t_iobc; /* input character */
202 int t_rxtcur; /* current retransmit value (ticks) */
204 int t_rxtshift; /* log(2) of rexmt exp. backoff */
205 u_int t_rtttime; /* RTT measurement start time */
207 tcp_seq t_rtseq; /* sequence number being timed */
208 u_int t_starttime; /* time connection was established */
209 u_int t_fbyte_in; /* ticks time when first byte queued in */
210 u_int t_fbyte_out; /* ticks time when first byte queued out */
212 u_int t_pmtud_saved_maxseg; /* pre-blackhole MSS */
213 int t_blackhole_enter; /* when to enter blackhole detection */
214 int t_blackhole_exit; /* when to exit blackhole detection */
215 u_int t_rttmin; /* minimum rtt allowed */
217 u_int t_rttbest; /* best rtt we've seen */
219 int t_softerror; /* possible error not yet reported */
220 uint32_t max_sndwnd; /* largest window peer has offered */
222 uint32_t snd_cwnd_prev; /* cwnd prior to retransmit */
223 uint32_t snd_ssthresh_prev; /* ssthresh prior to retransmit */
224 tcp_seq snd_recover_prev; /* snd_recover prior to retransmit */
225 int t_sndzerowin; /* zero-window updates sent */
226 u_long t_rttupdated; /* number of times rtt sampled */
227 int snd_numholes; /* number of holes seen by sender */
228 u_int t_badrxtwin; /* window for retransmit recovery */
229 TAILQ_HEAD(sackhole_head, sackhole) snd_holes;
230 /* SACK scoreboard (sorted) */
231 tcp_seq snd_fack; /* last seq number(+1) sack'd by rcv'r*/
232 struct sackblk sackblks[MAX_SACK_BLKS]; /* seq nos. of sack blocks */
233 struct sackhint sackhint; /* SACK scoreboard hint */
234 int t_rttlow; /* smallest observerved RTT */
235 int rfbuf_cnt; /* recv buffer autoscaling byte count */
236 struct toedev *tod; /* toedev handling this connection */
237 int t_sndrexmitpack; /* retransmit packets sent */
238 int t_rcvoopack; /* out-of-order packets received */
239 void *t_toe; /* TOE pcb pointer */
240 struct cc_algo *cc_algo; /* congestion control algorithm */
241 struct cc_var *ccv; /* congestion control specific vars */
242 struct osd *osd; /* storage for Khelp module data */
243 int t_bytes_acked; /* # bytes acked during current RTT */
244 u_int t_maxunacktime;
245 u_int t_keepinit; /* time to establish connection */
246 u_int t_keepidle; /* time before keepalive probes begin */
247 u_int t_keepintvl; /* interval between keepalives */
248 u_int t_keepcnt; /* number of keepalives before close */
249 int t_dupacks; /* consecutive dup acks recd */
250 int t_lognum; /* Number of log entries */
251 int t_loglimit; /* Maximum number of log entries */
252 uint32_t r_cep; /* Number of received CE marked packets */
253 uint32_t s_cep; /* Synced number of delivered CE packets */
254 int64_t t_pacing_rate; /* bytes / sec, -1 => unlimited */
255 struct tcp_log_stailq t_logs; /* Log buffer */
256 struct tcp_log_id_node *t_lin;
257 struct tcp_log_id_bucket *t_lib;
258 const char *t_output_caller; /* Function that called tcp_output */
259 struct statsblob *t_stats; /* Per-connection stats */
260 uint32_t t_logsn; /* Log "serial number" */
261 uint32_t gput_ts; /* Time goodput measurement started */
262 tcp_seq gput_seq; /* Outbound measurement seq */
263 tcp_seq gput_ack; /* Inbound measurement ack */
264 int32_t t_stats_gput_prev; /* XXXLAS: Prev gput measurement */
265 uint32_t t_maxpeakrate; /* max peak rate set by user, in bytes/s */
266 uint32_t t_sndtlppack; /* tail loss probe packets sent */
267 uint64_t t_sndtlpbyte; /* total tail loss probe bytes sent */
268 uint64_t t_sndbytes; /* total bytes sent */
269 uint64_t t_snd_rxt_bytes; /* total bytes retransmitted */
270 uint32_t t_dsack_bytes; /* Total number of dsack bytes we have received */
271 uint32_t t_dsack_tlp_bytes; /* Total number of dsack bytes we have received for TLPs sent */
272 uint32_t t_dsack_pack; /* Total dsack packets we have recieved */
274 uint8_t t_tfo_client_cookie_len; /* TCP Fast Open client cookie length */
275 uint32_t t_end_info_status; /* Status flag of end info */
276 unsigned int *t_tfo_pending; /* TCP Fast Open server pending counter */
278 uint8_t client[TCP_FASTOPEN_MAX_COOKIE_LEN];
280 } t_tfo_cookie; /* TCP Fast Open cookie to send */
282 uint8_t t_end_info_bytes[TCP_END_BYTE_INFO];
286 struct mbufq t_inpkts; /* List of saved input packets. */
287 struct mbufq t_outpkts; /* List of saved output packets. */
290 #endif /* _KERNEL || _WANT_TCPCB */
294 u_char tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
298 /* Enable TCP/UDP tunneling port */
299 #define TCP_TUNNELING_PORT_MIN 0
300 #define TCP_TUNNELING_PORT_MAX 65535
301 #define TCP_TUNNELING_PORT_DEFAULT 0
303 /* Enable TCP/UDP tunneling port */
304 #define TCP_TUNNELING_OVERHEAD_MIN sizeof(struct udphdr)
305 #define TCP_TUNNELING_OVERHEAD_MAX 1024
306 #define TCP_TUNNELING_OVERHEAD_DEFAULT TCP_TUNNELING_OVERHEAD_MIN
308 /* Minimum map entries limit value, if set */
309 #define TCP_MIN_MAP_ENTRIES_LIMIT 128
312 * TODO: We yet need to brave plowing in
313 * to tcp_input() and the pru_usrreq() block.
314 * Right now these go to the old standards which
315 * are somewhat ok, but in the long term may
316 * need to be changed. If we do tackle tcp_input()
317 * then we need to get rid of the tcp_do_segment()
320 /* Flags for tcp functions */
321 #define TCP_FUNC_BEING_REMOVED 0x01 /* Can no longer be referenced */
322 #define TCP_FUNC_OUTPUT_CANDROP 0x02 /* tfb_tcp_output may ask tcp_drop */
325 * If defining the optional tcp_timers, in the
326 * tfb_tcp_timer_stop call you must use the
327 * callout_async_drain() function with the
328 * tcp_timer_discard callback. You should check
329 * the return of callout_async_drain() and if 0
330 * increment tt_draincnt. Since the timer sub-system
331 * does not know your callbacks you must provide a
332 * stop_all function that loops through and calls
333 * tcp_timer_stop() with each of your defined timers.
334 * Adding a tfb_tcp_handoff_ok function allows the socket
335 * option to change stacks to query you even if the
336 * connection is in a later stage. You return 0 to
337 * say you can take over and run your stack, you return
338 * non-zero (an error number) to say no you can't.
339 * If the function is undefined you can only change
340 * in the early states (before connect or listen).
341 * tfb_tcp_fb_fini is changed to add a flag to tell
342 * the old stack if the tcb is being destroyed or
343 * not. A one in the flag means the TCB is being
344 * destroyed, a zero indicates its transitioning to
345 * another stack (via socket option).
347 struct tcp_function_block {
348 char tfb_tcp_block_name[TCP_FUNCTION_NAME_LEN_MAX];
349 int (*tfb_tcp_output)(struct tcpcb *);
350 int (*tfb_tcp_output_wtime)(struct tcpcb *, const struct timeval *);
351 void (*tfb_tcp_do_segment)(struct mbuf *, struct tcphdr *,
352 struct socket *, struct tcpcb *,
354 int (*tfb_do_queued_segments)(struct socket *, struct tcpcb *, int);
355 int (*tfb_do_segment_nounlock)(struct mbuf *, struct tcphdr *,
356 struct socket *, struct tcpcb *,
358 int, struct timeval *);
359 void (*tfb_tcp_hpts_do_segment)(struct mbuf *, struct tcphdr *,
360 struct socket *, struct tcpcb *,
362 int, struct timeval *);
363 int (*tfb_tcp_ctloutput)(struct inpcb *inp, struct sockopt *sopt);
364 /* Optional memory allocation/free routine */
365 int (*tfb_tcp_fb_init)(struct tcpcb *);
366 void (*tfb_tcp_fb_fini)(struct tcpcb *, int);
367 /* Optional timers, must define all if you define one */
368 int (*tfb_tcp_timer_stop_all)(struct tcpcb *);
369 void (*tfb_tcp_timer_activate)(struct tcpcb *,
371 int (*tfb_tcp_timer_active)(struct tcpcb *, uint32_t);
372 void (*tfb_tcp_timer_stop)(struct tcpcb *, uint32_t);
373 void (*tfb_tcp_rexmit_tmr)(struct tcpcb *);
374 int (*tfb_tcp_handoff_ok)(struct tcpcb *);
375 void (*tfb_tcp_mtu_chg)(struct tcpcb *);
376 int (*tfb_pru_options)(struct tcpcb *, int);
377 void (*tfb_hwtls_change)(struct tcpcb *, int);
378 volatile uint32_t tfb_refcnt;
383 struct tcp_function {
384 TAILQ_ENTRY(tcp_function) tf_next;
385 char tf_name[TCP_FUNCTION_NAME_LEN_MAX];
386 struct tcp_function_block *tf_fb;
389 TAILQ_HEAD(tcp_funchead, tcp_function);
391 struct tcpcb * tcp_drop(struct tcpcb *, int);
393 #ifdef _NETINET_IN_PCB_H_
396 * Handles tcp_drop request from advanced stacks and reports that inpcb is
397 * gone with negative return code.
398 * Drop in replacement for the default stack.
401 tcp_output(struct tcpcb *tp)
405 INP_WLOCK_ASSERT(tp->t_inpcb);
407 rv = tp->t_fb->tfb_tcp_output(tp);
409 KASSERT(tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
410 ("TCP stack %s requested tcp_drop(%p)",
411 tp->t_fb->tfb_tcp_block_name, tp));
412 tp = tcp_drop(tp, -rv);
414 INP_WUNLOCK(tp->t_inpcb);
421 * tcp_output_unlock()
422 * Always returns unlocked, handles drop request from advanced stacks.
423 * Always returns positive error code.
426 tcp_output_unlock(struct tcpcb *tp)
430 INP_WLOCK_ASSERT(tp->t_inpcb);
432 rv = tp->t_fb->tfb_tcp_output(tp);
434 KASSERT(tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
435 ("TCP stack %s requested tcp_drop(%p)",
436 tp->t_fb->tfb_tcp_block_name, tp));
438 tp = tcp_drop(tp, rv);
440 INP_WUNLOCK(tp->t_inpcb);
442 INP_WUNLOCK(tp->t_inpcb);
448 * tcp_output_nodrop()
449 * Always returns locked. It is caller's responsibility to run tcp_drop()!
450 * Useful in syscall implementations, when we want to perform some logging
451 * and/or tracing with tcpcb before calling tcp_drop(). To be used with
452 * tcp_unlock_or_drop() later.
454 * XXXGL: maybe don't allow stacks to return a drop request at certain
455 * TCP states? Why would it do in connect(2)? In recv(2)?
458 tcp_output_nodrop(struct tcpcb *tp)
462 INP_WLOCK_ASSERT(tp->t_inpcb);
464 rv = tp->t_fb->tfb_tcp_output(tp);
465 KASSERT(rv >= 0 || tp->t_fb->tfb_flags & TCP_FUNC_OUTPUT_CANDROP,
466 ("TCP stack %s requested tcp_drop(%p)",
467 tp->t_fb->tfb_tcp_block_name, tp));
472 * tcp_unlock_or_drop()
473 * Handle return code from tfb_tcp_output() after we have logged/traced,
474 * to be used with tcp_output_nodrop().
477 tcp_unlock_or_drop(struct tcpcb *tp, int tcp_output_retval)
480 INP_WLOCK_ASSERT(tp->t_inpcb);
482 if (tcp_output_retval < 0) {
483 tcp_output_retval = -tcp_output_retval;
484 if (tcp_drop(tp, tcp_output_retval) != NULL)
485 INP_WUNLOCK(tp->t_inpcb);
487 INP_WUNLOCK(tp->t_inpcb);
489 return (tcp_output_retval);
491 #endif /* _NETINET_IN_PCB_H_ */
495 * Flags and utility macros for the t_flags field.
497 #define TF_ACKNOW 0x00000001 /* ack peer immediately */
498 #define TF_DELACK 0x00000002 /* ack, but try to delay it */
499 #define TF_NODELAY 0x00000004 /* don't delay packets to coalesce */
500 #define TF_NOOPT 0x00000008 /* don't use tcp options */
501 #define TF_SENTFIN 0x00000010 /* have sent FIN */
502 #define TF_REQ_SCALE 0x00000020 /* have/will request window scaling */
503 #define TF_RCVD_SCALE 0x00000040 /* other side has requested scaling */
504 #define TF_REQ_TSTMP 0x00000080 /* have/will request timestamps */
505 #define TF_RCVD_TSTMP 0x00000100 /* a timestamp was received in SYN */
506 #define TF_SACK_PERMIT 0x00000200 /* other side said I could SACK */
507 #define TF_NEEDSYN 0x00000400 /* send SYN (implicit state) */
508 #define TF_NEEDFIN 0x00000800 /* send FIN (implicit state) */
509 #define TF_NOPUSH 0x00001000 /* don't push */
510 #define TF_PREVVALID 0x00002000 /* saved values for bad rxmit valid
511 * Note: accessing and restoring from
512 * these may only be done in the 1st
513 * RTO recovery round (t_rxtshift == 1)
515 #define TF_WAKESOR 0x00004000 /* wake up receive socket */
516 #define TF_GPUTINPROG 0x00008000 /* Goodput measurement in progress */
517 #define TF_MORETOCOME 0x00010000 /* More data to be appended to sock */
518 #define TF_LQ_OVERFLOW 0x00020000 /* listen queue overflow */
519 #define TF_LASTIDLE 0x00040000 /* connection was previously idle */
520 #define TF_RXWIN0SENT 0x00080000 /* sent a receiver win 0 in response */
521 #define TF_FASTRECOVERY 0x00100000 /* in NewReno Fast Recovery */
522 #define TF_WASFRECOVERY 0x00200000 /* was in NewReno Fast Recovery */
523 #define TF_SIGNATURE 0x00400000 /* require MD5 digests (RFC2385) */
524 #define TF_FORCEDATA 0x00800000 /* force out a byte */
525 #define TF_TSO 0x01000000 /* TSO enabled on this connection */
526 #define TF_TOE 0x02000000 /* this connection is offloaded */
527 #define TF_UNUSED0 0x04000000 /* unused */
528 #define TF_UNUSED1 0x08000000 /* unused */
529 #define TF_LRD 0x10000000 /* Lost Retransmission Detection */
530 #define TF_CONGRECOVERY 0x20000000 /* congestion recovery mode */
531 #define TF_WASCRECOVERY 0x40000000 /* was in congestion recovery */
532 #define TF_FASTOPEN 0x80000000 /* TCP Fast Open indication */
534 #define IN_FASTRECOVERY(t_flags) (t_flags & TF_FASTRECOVERY)
535 #define ENTER_FASTRECOVERY(t_flags) t_flags |= TF_FASTRECOVERY
536 #define EXIT_FASTRECOVERY(t_flags) t_flags &= ~TF_FASTRECOVERY
538 #define IN_CONGRECOVERY(t_flags) (t_flags & TF_CONGRECOVERY)
539 #define ENTER_CONGRECOVERY(t_flags) t_flags |= TF_CONGRECOVERY
540 #define EXIT_CONGRECOVERY(t_flags) t_flags &= ~TF_CONGRECOVERY
542 #define IN_RECOVERY(t_flags) (t_flags & (TF_CONGRECOVERY | TF_FASTRECOVERY))
543 #define ENTER_RECOVERY(t_flags) t_flags |= (TF_CONGRECOVERY | TF_FASTRECOVERY)
544 #define EXIT_RECOVERY(t_flags) t_flags &= ~(TF_CONGRECOVERY | TF_FASTRECOVERY)
546 #if defined(_KERNEL) && !defined(TCP_RFC7413)
547 #define IS_FASTOPEN(t_flags) (false)
549 #define IS_FASTOPEN(t_flags) (t_flags & TF_FASTOPEN)
552 #define BYTES_THIS_ACK(tp, th) (th->th_ack - tp->snd_una)
555 * Flags for the t_oobflags field.
557 #define TCPOOB_HAVEDATA 0x01
558 #define TCPOOB_HADDATA 0x02
561 * Flags for the extended TCP flags field, t_flags2
563 #define TF2_PLPMTU_BLACKHOLE 0x00000001 /* Possible PLPMTUD Black Hole. */
564 #define TF2_PLPMTU_PMTUD 0x00000002 /* Allowed to attempt PLPMTUD. */
565 #define TF2_PLPMTU_MAXSEGSNT 0x00000004 /* Last seg sent was full seg. */
566 #define TF2_LOG_AUTO 0x00000008 /* Session is auto-logging. */
567 #define TF2_DROP_AF_DATA 0x00000010 /* Drop after all data ack'd */
568 #define TF2_ECN_PERMIT 0x00000020 /* connection ECN-ready */
569 #define TF2_ECN_SND_CWR 0x00000040 /* ECN CWR in queue */
570 #define TF2_ECN_SND_ECE 0x00000080 /* ECN ECE in queue */
571 #define TF2_ACE_PERMIT 0x00000100 /* Accurate ECN mode */
572 #define TF2_FBYTES_COMPLETE 0x00000400 /* We have first bytes in and out */
574 * Structure to hold TCP options that are only used during segment
575 * processing (in tcp_input), but not held in the tcpcb.
576 * It's basically used to reduce the number of parameters
577 * to tcp_dooptions and tcp_addoptions.
578 * The binary order of the to_flags is relevant for packing of the
579 * options in tcp_addoptions.
582 u_int32_t to_flags; /* which options are present */
583 #define TOF_MSS 0x0001 /* maximum segment size */
584 #define TOF_SCALE 0x0002 /* window scaling */
585 #define TOF_SACKPERM 0x0004 /* SACK permitted */
586 #define TOF_TS 0x0010 /* timestamp */
587 #define TOF_SIGNATURE 0x0040 /* TCP-MD5 signature option (RFC2385) */
588 #define TOF_SACK 0x0080 /* Peer sent SACK option */
589 #define TOF_FASTOPEN 0x0100 /* TCP Fast Open (TFO) cookie */
590 #define TOF_MAXOPT 0x0200
591 u_int32_t to_tsval; /* new timestamp */
592 u_int32_t to_tsecr; /* reflected timestamp */
593 u_char *to_sacks; /* pointer to the first SACK blocks */
594 u_char *to_signature; /* pointer to the TCP-MD5 signature */
595 u_int8_t *to_tfo_cookie; /* pointer to the TFO cookie */
596 u_int16_t to_mss; /* maximum segment size */
597 u_int8_t to_wscale; /* window scaling */
598 u_int8_t to_nsacks; /* number of SACK blocks */
599 u_int8_t to_tfo_len; /* TFO cookie length */
600 u_int32_t to_spare; /* UTO */
604 * Flags for tcp_dooptions.
606 #define TO_SYN 0x01 /* parse SYN-only options */
608 struct hc_metrics_lite { /* must stay in sync with hc_metrics */
609 uint32_t rmx_mtu; /* MTU for this path */
610 uint32_t rmx_ssthresh; /* outbound gateway buffer limit */
611 uint32_t rmx_rtt; /* estimated round trip time */
612 uint32_t rmx_rttvar; /* estimated rtt variance */
613 uint32_t rmx_cwnd; /* congestion window */
614 uint32_t rmx_sendpipe; /* outbound delay-bandwidth product */
615 uint32_t rmx_recvpipe; /* inbound delay-bandwidth product */
619 * Used by tcp_maxmtu() to communicate interface specific features
620 * and limits at the time of connection setup.
625 u_int tsomaxsegcount;
629 #ifndef _NETINET_IN_PCB_H_
631 #endif /* _NETINET_IN_PCB_H_ */
634 struct inpcb *tw_inpcb; /* XXX back pointer to internet pcb */
635 uint32_t t_port:16, /* UDP port number if TCPoUDP */
639 u_short last_win; /* cached window value */
640 short tw_so_options; /* copy of so_options */
641 struct ucred *tw_cred; /* user credentials */
643 u_int32_t ts_offset; /* our timestamp offset */
645 TAILQ_ENTRY(tcptw) tw_2msl;
646 u_int tw_flags; /* tcpcb t_flags */
649 #define intotcpcb(ip) ((struct tcpcb *)(ip)->inp_ppcb)
650 #define intotw(ip) ((struct tcptw *)(ip)->inp_ppcb)
651 #define sototcpcb(so) (intotcpcb(sotoinpcb(so)))
654 * The smoothed round-trip time and estimated variance
655 * are stored as fixed point numbers scaled by the values below.
656 * For convenience, these scales are also used in smoothing the average
657 * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
658 * With these scales, srtt has 3 bits to the right of the binary point,
659 * and thus an "ALPHA" of 0.875. rttvar has 2 bits to the right of the
660 * binary point, and is smoothed with an ALPHA of 0.75.
662 #define TCP_RTT_SCALE 32 /* multiplier for srtt; 3 bits frac. */
663 #define TCP_RTT_SHIFT 5 /* shift for srtt; 3 bits frac. */
664 #define TCP_RTTVAR_SCALE 16 /* multiplier for rttvar; 2 bits */
665 #define TCP_RTTVAR_SHIFT 4 /* shift for rttvar; 2 bits */
666 #define TCP_DELTA_SHIFT 2 /* see tcp_input.c */
669 * The initial retransmission should happen at rtt + 4 * rttvar.
670 * Because of the way we do the smoothing, srtt and rttvar
671 * will each average +1/2 tick of bias. When we compute
672 * the retransmit timer, we want 1/2 tick of rounding and
673 * 1 extra tick because of +-1/2 tick uncertainty in the
674 * firing of the timer. The bias will give us exactly the
675 * 1.5 tick we need. But, because the bias is
676 * statistical, we have to test that we don't drop below
677 * the minimum feasible timer (which is 2 ticks).
678 * This version of the macro adapted from a paper by Lawrence
679 * Brakmo and Larry Peterson which outlines a problem caused
680 * by insufficient precision in the original implementation,
681 * which results in inappropriately large RTO values for very
684 #define TCP_REXMTVAL(tp) \
685 max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT)) \
686 + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
690 * Many of these should be kept per connection,
691 * but that's inconvenient at the moment.
694 uint64_t tcps_connattempt; /* connections initiated */
695 uint64_t tcps_accepts; /* connections accepted */
696 uint64_t tcps_connects; /* connections established */
697 uint64_t tcps_drops; /* connections dropped */
698 uint64_t tcps_conndrops; /* embryonic connections dropped */
699 uint64_t tcps_minmssdrops; /* average minmss too low drops */
700 uint64_t tcps_closed; /* conn. closed (includes drops) */
701 uint64_t tcps_segstimed; /* segs where we tried to get rtt */
702 uint64_t tcps_rttupdated; /* times we succeeded */
703 uint64_t tcps_delack; /* delayed acks sent */
704 uint64_t tcps_timeoutdrop; /* conn. dropped in rxmt timeout */
705 uint64_t tcps_rexmttimeo; /* retransmit timeouts */
706 uint64_t tcps_persisttimeo; /* persist timeouts */
707 uint64_t tcps_keeptimeo; /* keepalive timeouts */
708 uint64_t tcps_keepprobe; /* keepalive probes sent */
709 uint64_t tcps_keepdrops; /* connections dropped in keepalive */
711 uint64_t tcps_sndtotal; /* total packets sent */
712 uint64_t tcps_sndpack; /* data packets sent */
713 uint64_t tcps_sndbyte; /* data bytes sent */
714 uint64_t tcps_sndrexmitpack; /* data packets retransmitted */
715 uint64_t tcps_sndrexmitbyte; /* data bytes retransmitted */
716 uint64_t tcps_sndrexmitbad; /* unnecessary packet retransmissions */
717 uint64_t tcps_sndacks; /* ack-only packets sent */
718 uint64_t tcps_sndprobe; /* window probes sent */
719 uint64_t tcps_sndurg; /* packets sent with URG only */
720 uint64_t tcps_sndwinup; /* window update-only packets sent */
721 uint64_t tcps_sndctrl; /* control (SYN|FIN|RST) packets sent */
723 uint64_t tcps_rcvtotal; /* total packets received */
724 uint64_t tcps_rcvpack; /* packets received in sequence */
725 uint64_t tcps_rcvbyte; /* bytes received in sequence */
726 uint64_t tcps_rcvbadsum; /* packets received with ccksum errs */
727 uint64_t tcps_rcvbadoff; /* packets received with bad offset */
728 uint64_t tcps_rcvreassfull; /* packets dropped for no reass space */
729 uint64_t tcps_rcvshort; /* packets received too short */
730 uint64_t tcps_rcvduppack; /* duplicate-only packets received */
731 uint64_t tcps_rcvdupbyte; /* duplicate-only bytes received */
732 uint64_t tcps_rcvpartduppack; /* packets with some duplicate data */
733 uint64_t tcps_rcvpartdupbyte; /* dup. bytes in part-dup. packets */
734 uint64_t tcps_rcvoopack; /* out-of-order packets received */
735 uint64_t tcps_rcvoobyte; /* out-of-order bytes received */
736 uint64_t tcps_rcvpackafterwin; /* packets with data after window */
737 uint64_t tcps_rcvbyteafterwin; /* bytes rcvd after window */
738 uint64_t tcps_rcvafterclose; /* packets rcvd after "close" */
739 uint64_t tcps_rcvwinprobe; /* rcvd window probe packets */
740 uint64_t tcps_rcvdupack; /* rcvd duplicate acks */
741 uint64_t tcps_rcvacktoomuch; /* rcvd acks for unsent data */
742 uint64_t tcps_rcvackpack; /* rcvd ack packets */
743 uint64_t tcps_rcvackbyte; /* bytes acked by rcvd acks */
744 uint64_t tcps_rcvwinupd; /* rcvd window update packets */
745 uint64_t tcps_pawsdrop; /* segments dropped due to PAWS */
746 uint64_t tcps_predack; /* times hdr predict ok for acks */
747 uint64_t tcps_preddat; /* times hdr predict ok for data pkts */
748 uint64_t tcps_pcbcachemiss;
749 uint64_t tcps_cachedrtt; /* times cached RTT in route updated */
750 uint64_t tcps_cachedrttvar; /* times cached rttvar updated */
751 uint64_t tcps_cachedssthresh; /* times cached ssthresh updated */
752 uint64_t tcps_usedrtt; /* times RTT initialized from route */
753 uint64_t tcps_usedrttvar; /* times RTTVAR initialized from rt */
754 uint64_t tcps_usedssthresh; /* times ssthresh initialized from rt*/
755 uint64_t tcps_persistdrop; /* timeout in persist state */
756 uint64_t tcps_badsyn; /* bogus SYN, e.g. premature ACK */
757 uint64_t tcps_mturesent; /* resends due to MTU discovery */
758 uint64_t tcps_listendrop; /* listen queue overflows */
759 uint64_t tcps_badrst; /* ignored RSTs in the window */
761 uint64_t tcps_sc_added; /* entry added to syncache */
762 uint64_t tcps_sc_retransmitted; /* syncache entry was retransmitted */
763 uint64_t tcps_sc_dupsyn; /* duplicate SYN packet */
764 uint64_t tcps_sc_dropped; /* could not reply to packet */
765 uint64_t tcps_sc_completed; /* successful extraction of entry */
766 uint64_t tcps_sc_bucketoverflow;/* syncache per-bucket limit hit */
767 uint64_t tcps_sc_cacheoverflow; /* syncache cache limit hit */
768 uint64_t tcps_sc_reset; /* RST removed entry from syncache */
769 uint64_t tcps_sc_stale; /* timed out or listen socket gone */
770 uint64_t tcps_sc_aborted; /* syncache entry aborted */
771 uint64_t tcps_sc_badack; /* removed due to bad ACK */
772 uint64_t tcps_sc_unreach; /* ICMP unreachable received */
773 uint64_t tcps_sc_zonefail; /* zalloc() failed */
774 uint64_t tcps_sc_sendcookie; /* SYN cookie sent */
775 uint64_t tcps_sc_recvcookie; /* SYN cookie received */
777 uint64_t tcps_hc_added; /* entry added to hostcache */
778 uint64_t tcps_hc_bucketoverflow;/* hostcache per bucket limit hit */
780 uint64_t tcps_finwait2_drops; /* Drop FIN_WAIT_2 connection after time limit */
782 /* SACK related stats */
783 uint64_t tcps_sack_recovery_episode; /* SACK recovery episodes */
784 uint64_t tcps_sack_rexmits; /* SACK rexmit segments */
785 uint64_t tcps_sack_rexmit_bytes; /* SACK rexmit bytes */
786 uint64_t tcps_sack_rcv_blocks; /* SACK blocks (options) received */
787 uint64_t tcps_sack_send_blocks; /* SACK blocks (options) sent */
788 uint64_t tcps_sack_lostrexmt; /* SACK lost retransmission recovered */
789 uint64_t tcps_sack_sboverflow; /* times scoreboard overflowed */
791 /* ECN related stats */
792 uint64_t tcps_ecn_ce; /* ECN Congestion Experienced */
793 uint64_t tcps_ecn_ect0; /* ECN Capable Transport */
794 uint64_t tcps_ecn_ect1; /* ECN Capable Transport */
795 uint64_t tcps_ecn_shs; /* ECN successful handshakes */
796 uint64_t tcps_ecn_rcwnd; /* # times ECN reduced the cwnd */
798 /* TCP_SIGNATURE related stats */
799 uint64_t tcps_sig_rcvgoodsig; /* Total matching signature received */
800 uint64_t tcps_sig_rcvbadsig; /* Total bad signature received */
801 uint64_t tcps_sig_err_buildsig; /* Failed to make signature */
802 uint64_t tcps_sig_err_sigopt; /* No signature expected by socket */
803 uint64_t tcps_sig_err_nosigopt; /* No signature provided by segment */
805 /* Path MTU Discovery Black Hole Detection related stats */
806 uint64_t tcps_pmtud_blackhole_activated; /* Black Hole Count */
807 uint64_t tcps_pmtud_blackhole_activated_min_mss; /* BH at min MSS Count */
808 uint64_t tcps_pmtud_blackhole_failed; /* Black Hole Failure Count */
810 uint64_t tcps_tunneled_pkts; /* Packets encap's in UDP received */
811 uint64_t tcps_tunneled_errs; /* Packets that had errors that were UDP encaped */
813 /* Dsack related stats */
814 uint64_t tcps_dsack_count; /* Number of ACKs arriving with DSACKs */
815 uint64_t tcps_dsack_bytes; /* Number of bytes DSACK'ed no TLP */
816 uint64_t tcps_dsack_tlp_bytes; /* Number of bytes DSACK'ed due to TLPs */
818 /* TCPS_TIME_WAIT usage stats */
819 uint64_t tcps_tw_recycles; /* Times time-wait was recycled. */
820 uint64_t tcps_tw_resets; /* Times time-wait sent a reset. */
821 uint64_t tcps_tw_responds; /* Times time-wait sent a valid ack. */
823 /* Accurate ECN Handshake stats */
824 uint64_t tcps_ace_nect; /* ACE SYN packet with Non-ECT */
825 uint64_t tcps_ace_ect1; /* ACE SYN packet with ECT1 */
826 uint64_t tcps_ace_ect0; /* ACE SYN packet with ECT0 */
827 uint64_t tcps_ace_ce; /* ACE SYN packet with CE */
829 uint64_t _pad[6]; /* 6 TBD placeholder for STABLE */
832 #define tcps_rcvmemdrop tcps_rcvreassfull /* compat */
835 #define TI_UNLOCKED 1
837 #include <sys/counter.h>
839 VNET_PCPUSTAT_DECLARE(struct tcpstat, tcpstat); /* tcp statistics */
841 * In-kernel consumers can use these accessor macros directly to update
844 #define TCPSTAT_ADD(name, val) \
845 VNET_PCPUSTAT_ADD(struct tcpstat, tcpstat, name, (val))
846 #define TCPSTAT_INC(name) TCPSTAT_ADD(name, 1)
849 * Kernel module consumers must use this accessor macro.
851 void kmod_tcpstat_add(int statnum, int val);
852 #define KMOD_TCPSTAT_ADD(name, val) \
853 kmod_tcpstat_add(offsetof(struct tcpstat, name) / sizeof(uint64_t), val)
854 #define KMOD_TCPSTAT_INC(name) KMOD_TCPSTAT_ADD(name, 1)
857 * Running TCP connection count by state.
859 VNET_DECLARE(counter_u64_t, tcps_states[TCP_NSTATES]);
860 #define V_tcps_states VNET(tcps_states)
861 #define TCPSTATES_INC(state) counter_u64_add(V_tcps_states[state], 1)
862 #define TCPSTATES_DEC(state) counter_u64_add(V_tcps_states[state], -1)
865 * TCP specific helper hook point identifiers.
867 #define HHOOK_TCP_EST_IN 0
868 #define HHOOK_TCP_EST_OUT 1
869 #define HHOOK_TCP_LAST HHOOK_TCP_EST_OUT
871 struct tcp_hhook_data {
880 void hhook_run_tcp_est_out(struct tcpcb *tp,
881 struct tcphdr *th, struct tcpopt *to,
882 uint32_t len, int tso);
887 * TCB structure exported to user-land via sysctl(3).
889 * Fields prefixed with "xt_" are unique to the export structure, and fields
890 * with "t_" or other prefixes match corresponding fields of 'struct tcpcb'.
893 * (s) - used by userland utilities in src
894 * (p) - used by utilities in ports
895 * (3) - is known to be used by third party software not in ports
896 * (n) - no known usage
898 * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
899 * included. Not all of our clients do.
901 #if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
903 ksize_t xt_len; /* length of this structure */
904 struct xinpcb xt_inp;
905 char xt_stack[TCP_FUNCTION_NAME_LEN_MAX]; /* (s) */
906 char xt_logid[TCP_LOG_ID_LEN]; /* (s) */
907 char xt_cc[TCP_CA_NAME_MAX]; /* (s) */
909 int32_t t_state; /* (s,p) */
910 uint32_t t_flags; /* (s,p) */
911 int32_t t_sndzerowin; /* (s) */
912 int32_t t_sndrexmitpack; /* (s) */
913 int32_t t_rcvoopack; /* (s) */
914 int32_t t_rcvtime; /* (s) */
915 int32_t tt_rexmt; /* (s) */
916 int32_t tt_persist; /* (s) */
917 int32_t tt_keep; /* (s) */
918 int32_t tt_2msl; /* (s) */
919 int32_t tt_delack; /* (s) */
920 int32_t t_logstate; /* (3) */
921 uint32_t t_snd_cwnd; /* (s) */
922 uint32_t t_snd_ssthresh; /* (s) */
923 uint32_t t_maxseg; /* (s) */
924 uint32_t t_rcv_wnd; /* (s) */
925 uint32_t t_snd_wnd; /* (s) */
926 uint32_t xt_ecn; /* (s) */
927 uint32_t t_dsack_bytes; /* (n) */
928 uint32_t t_dsack_tlp_bytes; /* (n) */
929 uint32_t t_dsack_pack; /* (n) */
930 uint16_t xt_encaps_port; /* (s) */
936 void tcp_inptoxtp(const struct inpcb *, struct xtcpcb *);
941 * TCP function information (name-to-id mapping, aliases, and refcnt)
942 * exported to user-land via sysctl(3).
944 struct tcp_function_info {
947 char tfi_name[TCP_FUNCTION_NAME_LEN_MAX];
948 char tfi_alias[TCP_FUNCTION_NAME_LEN_MAX];
952 * Identifiers for TCP sysctl nodes
954 #define TCPCTL_DO_RFC1323 1 /* use RFC-1323 extensions */
955 #define TCPCTL_MSSDFLT 3 /* MSS default */
956 #define TCPCTL_STATS 4 /* statistics */
957 #define TCPCTL_RTTDFLT 5 /* default RTT estimate */
958 #define TCPCTL_KEEPIDLE 6 /* keepalive idle timer */
959 #define TCPCTL_KEEPINTVL 7 /* interval to send keepalives */
960 #define TCPCTL_SENDSPACE 8 /* send buffer space */
961 #define TCPCTL_RECVSPACE 9 /* receive buffer space */
962 #define TCPCTL_KEEPINIT 10 /* timeout for establishing syn */
963 #define TCPCTL_PCBLIST 11 /* list of all outstanding PCBs */
964 #define TCPCTL_DELACKTIME 12 /* time before sending delayed ACK */
965 #define TCPCTL_V6MSSDFLT 13 /* MSS default for IPv6 */
966 #define TCPCTL_SACK 14 /* Selective Acknowledgement,rfc 2018 */
967 #define TCPCTL_DROP 15 /* drop tcp connection */
968 #define TCPCTL_STATES 16 /* connection counts by TCP state */
972 SYSCTL_DECL(_net_inet_tcp);
973 SYSCTL_DECL(_net_inet_tcp_sack);
974 MALLOC_DECLARE(M_TCPLOG);
977 VNET_DECLARE(int, tcp_log_in_vain);
978 #define V_tcp_log_in_vain VNET(tcp_log_in_vain)
981 * Global TCP tunables shared between different stacks.
982 * Please keep the list sorted.
984 VNET_DECLARE(int, drop_synfin);
985 VNET_DECLARE(int, path_mtu_discovery);
986 VNET_DECLARE(int, tcp_abc_l_var);
987 VNET_DECLARE(int, tcp_autorcvbuf_max);
988 VNET_DECLARE(int, tcp_autosndbuf_inc);
989 VNET_DECLARE(int, tcp_autosndbuf_max);
990 VNET_DECLARE(int, tcp_delack_enabled);
991 VNET_DECLARE(int, tcp_do_autorcvbuf);
992 VNET_DECLARE(int, tcp_do_autosndbuf);
993 VNET_DECLARE(int, tcp_do_ecn);
994 VNET_DECLARE(int, tcp_do_lrd);
995 VNET_DECLARE(int, tcp_do_prr);
996 VNET_DECLARE(int, tcp_do_prr_conservative);
997 VNET_DECLARE(int, tcp_do_newcwv);
998 VNET_DECLARE(int, tcp_do_rfc1323);
999 VNET_DECLARE(int, tcp_tolerate_missing_ts);
1000 VNET_DECLARE(int, tcp_do_rfc3042);
1001 VNET_DECLARE(int, tcp_do_rfc3390);
1002 VNET_DECLARE(int, tcp_do_rfc3465);
1003 VNET_DECLARE(int, tcp_do_newsack);
1004 VNET_DECLARE(int, tcp_do_sack);
1005 VNET_DECLARE(int, tcp_do_tso);
1006 VNET_DECLARE(int, tcp_ecn_maxretries);
1007 VNET_DECLARE(int, tcp_initcwnd_segments);
1008 VNET_DECLARE(int, tcp_insecure_rst);
1009 VNET_DECLARE(int, tcp_insecure_syn);
1010 VNET_DECLARE(uint32_t, tcp_map_entries_limit);
1011 VNET_DECLARE(uint32_t, tcp_map_split_limit);
1012 VNET_DECLARE(int, tcp_minmss);
1013 VNET_DECLARE(int, tcp_mssdflt);
1015 VNET_DECLARE(int, tcp_perconn_stats_dflt_tpl);
1016 VNET_DECLARE(int, tcp_perconn_stats_enable);
1018 VNET_DECLARE(int, tcp_recvspace);
1019 VNET_DECLARE(int, tcp_sack_globalholes);
1020 VNET_DECLARE(int, tcp_sack_globalmaxholes);
1021 VNET_DECLARE(int, tcp_sack_maxholes);
1022 VNET_DECLARE(int, tcp_sc_rst_sock_fail);
1023 VNET_DECLARE(int, tcp_sendspace);
1024 VNET_DECLARE(int, tcp_udp_tunneling_overhead);
1025 VNET_DECLARE(int, tcp_udp_tunneling_port);
1026 VNET_DECLARE(struct inpcbinfo, tcbinfo);
1028 #define V_tcp_do_lrd VNET(tcp_do_lrd)
1029 #define V_tcp_do_prr VNET(tcp_do_prr)
1030 #define V_tcp_do_prr_conservative VNET(tcp_do_prr_conservative)
1031 #define V_tcp_do_newcwv VNET(tcp_do_newcwv)
1032 #define V_drop_synfin VNET(drop_synfin)
1033 #define V_path_mtu_discovery VNET(path_mtu_discovery)
1034 #define V_tcbinfo VNET(tcbinfo)
1035 #define V_tcp_abc_l_var VNET(tcp_abc_l_var)
1036 #define V_tcp_autorcvbuf_max VNET(tcp_autorcvbuf_max)
1037 #define V_tcp_autosndbuf_inc VNET(tcp_autosndbuf_inc)
1038 #define V_tcp_autosndbuf_max VNET(tcp_autosndbuf_max)
1039 #define V_tcp_delack_enabled VNET(tcp_delack_enabled)
1040 #define V_tcp_do_autorcvbuf VNET(tcp_do_autorcvbuf)
1041 #define V_tcp_do_autosndbuf VNET(tcp_do_autosndbuf)
1042 #define V_tcp_do_ecn VNET(tcp_do_ecn)
1043 #define V_tcp_do_rfc1323 VNET(tcp_do_rfc1323)
1044 #define V_tcp_tolerate_missing_ts VNET(tcp_tolerate_missing_ts)
1045 #define V_tcp_ts_offset_per_conn VNET(tcp_ts_offset_per_conn)
1046 #define V_tcp_do_rfc3042 VNET(tcp_do_rfc3042)
1047 #define V_tcp_do_rfc3390 VNET(tcp_do_rfc3390)
1048 #define V_tcp_do_rfc3465 VNET(tcp_do_rfc3465)
1049 #define V_tcp_do_newsack VNET(tcp_do_newsack)
1050 #define V_tcp_do_sack VNET(tcp_do_sack)
1051 #define V_tcp_do_tso VNET(tcp_do_tso)
1052 #define V_tcp_ecn_maxretries VNET(tcp_ecn_maxretries)
1053 #define V_tcp_initcwnd_segments VNET(tcp_initcwnd_segments)
1054 #define V_tcp_insecure_rst VNET(tcp_insecure_rst)
1055 #define V_tcp_insecure_syn VNET(tcp_insecure_syn)
1056 #define V_tcp_map_entries_limit VNET(tcp_map_entries_limit)
1057 #define V_tcp_map_split_limit VNET(tcp_map_split_limit)
1058 #define V_tcp_minmss VNET(tcp_minmss)
1059 #define V_tcp_mssdflt VNET(tcp_mssdflt)
1061 #define V_tcp_perconn_stats_dflt_tpl VNET(tcp_perconn_stats_dflt_tpl)
1062 #define V_tcp_perconn_stats_enable VNET(tcp_perconn_stats_enable)
1064 #define V_tcp_recvspace VNET(tcp_recvspace)
1065 #define V_tcp_sack_globalholes VNET(tcp_sack_globalholes)
1066 #define V_tcp_sack_globalmaxholes VNET(tcp_sack_globalmaxholes)
1067 #define V_tcp_sack_maxholes VNET(tcp_sack_maxholes)
1068 #define V_tcp_sc_rst_sock_fail VNET(tcp_sc_rst_sock_fail)
1069 #define V_tcp_sendspace VNET(tcp_sendspace)
1070 #define V_tcp_udp_tunneling_overhead VNET(tcp_udp_tunneling_overhead)
1071 #define V_tcp_udp_tunneling_port VNET(tcp_udp_tunneling_port)
1074 VNET_DECLARE(struct hhook_head *, tcp_hhh[HHOOK_TCP_LAST + 1]);
1075 #define V_tcp_hhh VNET(tcp_hhh)
1078 int tcp_addoptions(struct tcpopt *, u_char *);
1080 tcp_close(struct tcpcb *);
1081 void tcp_discardcb(struct tcpcb *);
1082 bool tcp_freecb(struct tcpcb *);
1083 void tcp_twstart(struct tcpcb *);
1084 void tcp_twclose(struct tcptw *, int);
1085 void tcp_ctlinput(int, struct sockaddr *, void *);
1086 int tcp_ctloutput(struct socket *, struct sockopt *);
1087 void tcp_ctlinput_viaudp(int, struct sockaddr *, void *, void *);
1088 void tcp_drain(void);
1089 void tcp_fini(void *);
1090 char *tcp_log_addrs(struct in_conninfo *, struct tcphdr *, const void *,
1092 char *tcp_log_vain(struct in_conninfo *, struct tcphdr *, const void *,
1094 int tcp_reass(struct tcpcb *, struct tcphdr *, tcp_seq *, int *,
1096 void tcp_reass_global_init(void);
1097 void tcp_reass_flush(struct tcpcb *);
1098 void tcp_dooptions(struct tcpopt *, u_char *, int, int);
1099 void tcp_dropwithreset(struct mbuf *, struct tcphdr *,
1100 struct tcpcb *, int, int);
1101 void tcp_pulloutofband(struct socket *,
1102 struct tcphdr *, struct mbuf *, int);
1103 void tcp_xmit_timer(struct tcpcb *, int);
1104 void tcp_newreno_partial_ack(struct tcpcb *, struct tcphdr *);
1105 void cc_ack_received(struct tcpcb *tp, struct tcphdr *th,
1106 uint16_t nsegs, uint16_t type);
1107 void cc_conn_init(struct tcpcb *tp);
1108 void cc_post_recovery(struct tcpcb *tp, struct tcphdr *th);
1109 void cc_ecnpkt_handler(struct tcpcb *tp, struct tcphdr *th, uint8_t iptos);
1110 void cc_ecnpkt_handler_flags(struct tcpcb *tp, uint16_t flags, uint8_t iptos);
1111 void cc_cong_signal(struct tcpcb *tp, struct tcphdr *th, uint32_t type);
1113 void hhook_run_tcp_est_in(struct tcpcb *tp,
1114 struct tcphdr *th, struct tcpopt *to);
1117 int tcp_input(struct mbuf **, int *, int);
1118 int tcp_autorcvbuf(struct mbuf *, struct tcphdr *, struct socket *,
1119 struct tcpcb *, int);
1120 int tcp_input_with_port(struct mbuf **, int *, int, uint16_t);
1121 void tcp_handle_wakeup(struct tcpcb *, struct socket *);
1122 void tcp_do_segment(struct mbuf *, struct tcphdr *,
1123 struct socket *, struct tcpcb *, int, int, uint8_t);
1125 int register_tcp_functions(struct tcp_function_block *blk, int wait);
1126 int register_tcp_functions_as_names(struct tcp_function_block *blk,
1127 int wait, const char *names[], int *num_names);
1128 int register_tcp_functions_as_name(struct tcp_function_block *blk,
1129 const char *name, int wait);
1130 int deregister_tcp_functions(struct tcp_function_block *blk, bool quiesce,
1132 struct tcp_function_block *find_and_ref_tcp_functions(struct tcp_function_set *fs);
1133 int find_tcp_function_alias(struct tcp_function_block *blk, struct tcp_function_set *fs);
1134 void tcp_switch_back_to_default(struct tcpcb *tp);
1135 struct tcp_function_block *
1136 find_and_ref_tcp_fb(struct tcp_function_block *fs);
1137 int tcp_default_ctloutput(struct inpcb *inp, struct sockopt *sopt);
1138 int tcp_ctloutput_set(struct inpcb *inp, struct sockopt *sopt);
1140 extern counter_u64_t tcp_inp_lro_direct_queue;
1141 extern counter_u64_t tcp_inp_lro_wokeup_queue;
1142 extern counter_u64_t tcp_inp_lro_compressed;
1143 extern counter_u64_t tcp_inp_lro_locks_taken;
1144 extern counter_u64_t tcp_extra_mbuf;
1145 extern counter_u64_t tcp_would_have_but;
1146 extern counter_u64_t tcp_comp_total;
1147 extern counter_u64_t tcp_uncomp_total;
1148 extern counter_u64_t tcp_bad_csums;
1150 #ifdef NETFLIX_EXP_DETECTION
1151 /* Various SACK attack thresholds */
1152 extern int32_t tcp_force_detection;
1153 extern int32_t tcp_sack_to_ack_thresh;
1154 extern int32_t tcp_sack_to_move_thresh;
1155 extern int32_t tcp_restoral_thresh;
1156 extern int32_t tcp_sad_decay_val;
1157 extern int32_t tcp_sad_pacing_interval;
1158 extern int32_t tcp_sad_low_pps;
1159 extern int32_t tcp_map_minimum;
1160 extern int32_t tcp_attack_on_turns_on_logging;
1162 extern uint32_t tcp_ack_war_time_window;
1163 extern uint32_t tcp_ack_war_cnt;
1165 uint32_t tcp_maxmtu(struct in_conninfo *, struct tcp_ifcap *);
1166 uint32_t tcp_maxmtu6(struct in_conninfo *, struct tcp_ifcap *);
1167 void tcp6_use_min_mtu(struct tcpcb *);
1168 u_int tcp_maxseg(const struct tcpcb *);
1169 u_int tcp_fixed_maxseg(const struct tcpcb *);
1170 void tcp_mss_update(struct tcpcb *, int, int, struct hc_metrics_lite *,
1171 struct tcp_ifcap *);
1172 void tcp_mss(struct tcpcb *, int);
1173 int tcp_mssopt(struct in_conninfo *);
1175 tcp_drop_syn_sent(struct inpcb *, int);
1177 tcp_newtcpcb(struct inpcb *);
1178 int tcp_default_output(struct tcpcb *);
1179 void tcp_state_change(struct tcpcb *, int);
1180 void tcp_respond(struct tcpcb *, void *,
1181 struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
1182 void tcp_tw_init(void);
1184 void tcp_tw_destroy(void);
1186 void tcp_tw_zone_change(void);
1187 int tcp_twcheck(struct inpcb *, struct tcpopt *, struct tcphdr *,
1188 struct mbuf *, int);
1189 void tcp_setpersist(struct tcpcb *);
1190 void tcp_slowtimo(void);
1191 void tcp_record_dsack(struct tcpcb *tp, tcp_seq start, tcp_seq end, int tlp);
1193 tcpip_maketemplate(struct inpcb *);
1194 void tcpip_fillheaders(struct inpcb *, uint16_t, void *, void *);
1195 void tcp_timer_activate(struct tcpcb *, uint32_t, u_int);
1196 int tcp_timer_suspend(struct tcpcb *, uint32_t);
1197 void tcp_timers_unsuspend(struct tcpcb *, uint32_t);
1198 int tcp_timer_active(struct tcpcb *, uint32_t);
1199 void tcp_timer_stop(struct tcpcb *, uint32_t);
1200 void tcp_trace(short, short, struct tcpcb *, void *, struct tcphdr *, int);
1201 int inp_to_cpuid(struct inpcb *inp);
1203 * All tcp_hc_* functions are IPv4 and IPv6 (via in_conninfo)
1205 void tcp_hc_init(void);
1207 void tcp_hc_destroy(void);
1209 void tcp_hc_get(struct in_conninfo *, struct hc_metrics_lite *);
1210 uint32_t tcp_hc_getmtu(struct in_conninfo *);
1211 void tcp_hc_updatemtu(struct in_conninfo *, uint32_t);
1212 void tcp_hc_update(struct in_conninfo *, struct hc_metrics_lite *);
1214 extern struct pr_usrreqs tcp_usrreqs;
1216 uint32_t tcp_new_ts_offset(struct in_conninfo *);
1217 tcp_seq tcp_new_isn(struct in_conninfo *);
1219 int tcp_sack_doack(struct tcpcb *, struct tcpopt *, tcp_seq);
1220 int tcp_dsack_block_exists(struct tcpcb *);
1221 void tcp_update_dsack_list(struct tcpcb *, tcp_seq, tcp_seq);
1222 void tcp_update_sack_list(struct tcpcb *tp, tcp_seq rcv_laststart, tcp_seq rcv_lastend);
1223 void tcp_clean_dsack_blocks(struct tcpcb *tp);
1224 void tcp_clean_sackreport(struct tcpcb *tp);
1225 void tcp_sack_adjust(struct tcpcb *tp);
1226 struct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt);
1227 void tcp_do_prr_ack(struct tcpcb *, struct tcphdr *, struct tcpopt *);
1228 void tcp_lost_retransmission(struct tcpcb *, struct tcphdr *);
1229 void tcp_sack_partialack(struct tcpcb *, struct tcphdr *);
1230 void tcp_free_sackholes(struct tcpcb *tp);
1231 void tcp_sack_lost_retransmission(struct tcpcb *, struct tcphdr *);
1232 int tcp_newreno(struct tcpcb *, struct tcphdr *);
1233 int tcp_compute_pipe(struct tcpcb *);
1234 uint32_t tcp_compute_initwnd(uint32_t);
1235 void tcp_sndbuf_autoscale(struct tcpcb *, struct socket *, uint32_t);
1236 int tcp_stats_sample_rollthedice(struct tcpcb *tp, void *seed_bytes,
1238 int tcp_can_enable_pacing(void);
1239 void tcp_decrement_paced_conn(void);
1242 tcp_m_copym(struct mbuf *m, int32_t off0, int32_t *plen,
1243 int32_t seglimit, int32_t segsize, struct sockbuf *sb, bool hw_tls);
1245 int tcp_stats_init(void);
1246 void tcp_log_end_status(struct tcpcb *tp, uint8_t status);
1249 tcp_fields_to_host(struct tcphdr *th)
1252 th->th_seq = ntohl(th->th_seq);
1253 th->th_ack = ntohl(th->th_ack);
1254 th->th_win = ntohs(th->th_win);
1255 th->th_urp = ntohs(th->th_urp);
1259 tcp_fields_to_net(struct tcphdr *th)
1262 th->th_seq = htonl(th->th_seq);
1263 th->th_ack = htonl(th->th_ack);
1264 th->th_win = htons(th->th_win);
1265 th->th_urp = htons(th->th_urp);
1268 static inline uint16_t
1269 tcp_get_flags(const struct tcphdr *th)
1271 return (((uint16_t)th->th_x2 << 8) | th->th_flags);
1275 tcp_set_flags(struct tcphdr *th, uint16_t flags)
1277 th->th_x2 = (flags >> 8) & 0x0f;
1278 th->th_flags = flags & 0xff;
1282 tcp_account_for_send(struct tcpcb *tp, uint32_t len, uint8_t is_rxt,
1283 uint8_t is_tlp, int hw_tls)
1287 tp->t_sndtlpbyte += len;
1289 /* To get total bytes sent you must add t_snd_rxt_bytes to t_sndbytes */
1291 tp->t_snd_rxt_bytes += len;
1293 tp->t_sndbytes += len;
1296 if (hw_tls && is_rxt && len != 0) {
1297 uint64_t rexmit_percent = (1000ULL * tp->t_snd_rxt_bytes) / (10ULL * (tp->t_snd_rxt_bytes + tp->t_sndbytes));
1298 if (rexmit_percent > ktls_ifnet_max_rexmit_pct)
1299 ktls_disable_ifnet(tp);
1304 #endif /* _KERNEL */
1306 #endif /* _NETINET_TCP_VAR_H_ */