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