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