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