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