2 * Copyright (c) 2000-2020 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1982, 1986, 1993, 1994, 1995
30 * The Regents of the University of California. All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60 * @(#)tcp_var.h 8.4 (Berkeley) 5/24/95
61 * $FreeBSD: src/sys/netinet/tcp_var.h,v 1.56.2.8 2001/08/22 00:59:13 silby Exp $
64 #ifndef _NETINET_TCP_VAR_H_
65 #define _NETINET_TCP_VAR_H_
66 #include <sys/types.h>
67 #include <sys/appleapiopts.h>
68 #include <sys/queue.h>
69 #include <netinet/in_pcb.h>
70 #include <netinet/tcp.h>
71 #include <netinet/tcp_timer.h>
73 #include <TargetConditionals.h>
77 #define _TCPCB_PTR(x) u_int32_t
78 #define _TCPCB_LIST_HEAD(name, type) \
83 #define _TCPCB_PTR(x) x
84 #define _TCPCB_LIST_HEAD(name, type) LIST_HEAD(name, type)
89 #define TCP_RETRANSHZ 1000 /* granularity of TCP timestamps, 1ms */
90 /* Minimum time quantum within which the timers are coalesced */
91 #define TCP_TIMER_10MS_QUANTUM (TCP_RETRANSHZ/100) /* every 10ms */
92 #define TCP_TIMER_100MS_QUANTUM (TCP_RETRANSHZ/10) /* every 100ms */
93 #define TCP_TIMER_500MS_QUANTUM (TCP_RETRANSHZ/2) /* every 500ms */
95 #define TCP_RETRANSHZ_TO_USEC 1000
97 #define N_TIME_WAIT_SLOTS 128 /* must be power of 2 */
99 /* Always allow at least 16 packets worth of recv window when adjusting
100 * recv window using inter-packet arrival jitter.
102 #define MIN_IAJ_WIN 16
104 /* A variation in delay of this many milliseconds is tolerable. This limit has to
105 * be low but greater than zero. We also use standard deviation on jitter to adjust
106 * this limit for different link and connection types.
108 #define ALLOWED_IAJ 5
110 /* Ignore the first few packets on a connection until the ACK clock gets going
112 #define IAJ_IGNORE_PKTCNT 40
114 /* Let the accumulated IAJ value increase by this threshold at most. This limit
115 * will control how many ALLOWED_IAJ measurements a receiver will have to see
116 * before opening the receive window
118 #define ACC_IAJ_HIGH_THRESH 100
120 /* When accumulated IAJ reaches this value, the receiver starts to react by
123 #define ACC_IAJ_REACT_LIMIT 200
125 /* If the number of small packets (smaller than IAJ packet size) seen on a
126 * connection is more than this threshold, reset the size and learn it again.
127 * This is needed because the sender might send smaller segments after PMTU
128 * discovery and the receiver has to learn the new size.
130 #define RESET_IAJ_SIZE_THRESH 20
133 * Adaptive timeout is a read/write timeout specified by the application to
134 * get a socket event when the transport layer detects a stall in data
135 * transfer. The value specified is the number of probes that can be sent
136 * to the peer before generating an event. Since it is not specified as
137 * a time value, the timeout will adjust based on the RTT seen on the link.
138 * The timeout will start only when there is an indication that the read/write
139 * operation is not making progress.
141 * If a write operation stalls, the probe will be retransmission of data.
142 * If a read operation stalls, the probe will be a keep-alive packet.
144 * The maximum value of adaptive timeout is set to 10 which will allow
145 * transmission of enough number of probes to the peer.
147 #define TCP_ADAPTIVE_TIMEOUT_MAX 10
149 #define TCP_CONNECTIVITY_PROBES_MAX 5
152 * Kernel variables for tcp.
155 /* TCP segment queue entry */
157 LIST_ENTRY(tseg_qent
) tqe_q
;
158 int tqe_len
; /* TCP segment data length */
159 struct tcphdr
*tqe_th
; /* a pointer to tcp header */
160 struct mbuf
*tqe_m
; /* mbuf contains packet */
162 LIST_HEAD(tsegqe_head
, tseg_qent
);
165 tcp_seq start
; /* start seq no. of sack block */
166 tcp_seq end
; /* end seq no. */
170 tcp_seq start
; /* start seq no. of hole */
171 tcp_seq end
; /* end seq no. */
172 tcp_seq rxmit
; /* next seq. no in hole to be retransmitted */
173 u_int32_t rxmit_start
; /* timestamp of first retransmission */
174 TAILQ_ENTRY(sackhole
) scblink
; /* scoreboard linkage */
178 struct sackhole
*nexthole
;
179 int sack_bytes_rexmit
;
180 int sack_bytes_acked
;
188 #define TCP_RXT_SPURIOUS 0x1 /* received DSACK notification */
189 #define TCP_RXT_DSACK_FOR_TLP 0x2
190 SLIST_ENTRY(tcp_rxt_seg
) rx_link
;
193 struct tcp_notify_ack_marker
{
194 tcp_seq notify_snd_una
; /* Notify when snd_una crosses this seq */
195 tcp_notify_ack_id_t notify_id
;
196 SLIST_ENTRY(tcp_notify_ack_marker
) notify_next
;
200 u_char tt_ipgen
[40]; /* the size must be of max ip header, now IPv6 */
205 tcp_seq bw_start
; /* start of bw measurement */
206 uint32_t bw_ts
; /* timestamp when bw measurement started */
207 uint32_t bw_size
; /* burst size in bytes for this bw measurement */
208 uint32_t bw_minsizepkts
; /* Min burst size as segments */
209 uint32_t bw_maxsizepkts
; /* Max burst size as segments */
210 uint32_t bw_minsize
; /* Min size in bytes */
211 uint32_t bw_maxsize
; /* Max size in bytes */
212 uint32_t bw_sndbw
; /* Measured send bandwidth */
213 uint32_t bw_sndbw_max
; /* Max measured bandwidth */
214 uint32_t bw_rcvbw_max
; /* Max receive bandwidth measured */
217 /* MPTCP Data sequence map entry */
219 uint64_t mpt_dsn
; /* data seq num recvd */
220 uint32_t mpt_sseq
; /* relative subflow # */
221 uint16_t mpt_len
; /* length of mapping */
222 uint16_t mpt_csum
; /* checksum value if on */
223 uint8_t mpt_dfin
; /* It's a DATA_FIN */
225 #define tcp6cb tcpcb /* for KAME src sync over BSD*'s */
229 struct tcp_cubic_state
{
230 u_int32_t tc_last_max
; /* cwnd at last loss */
231 u_int32_t tc_epoch_start
; /* TS of last loss */
232 u_int32_t tc_origin_point
; /* window at the start of an epoch */
233 u_int32_t tc_tcp_win
; /* computed tcp win */
234 u_int32_t tc_tcp_bytes_acked
; /* bytes acked */
235 u_int32_t tc_avg_lastmax
; /* Average of last max */
236 u_int32_t tc_mean_deviation
; /* Mean absolute deviation */
237 float tc_epoch_period
; /* K parameter */
239 #define cub_last_max __u__._cubic_state_.tc_last_max
240 #define cub_epoch_start __u__._cubic_state_.tc_epoch_start
241 #define cub_origin_point __u__._cubic_state_.tc_origin_point
242 #define cub_tcp_win __u__._cubic_state_.tc_tcp_win
243 #define cub_tcp_bytes_acked __u__._cubic_state_.tc_tcp_bytes_acked
244 #define cub_epoch_period __u__._cubic_state_.tc_epoch_period
245 #define cub_avg_lastmax __u__._cubic_state_.tc_avg_lastmax
246 #define cub_mean_dev __u__._cubic_state_.tc_mean_deviation
251 * Tcp control block, one per tcp; fields:
252 * Organized for 16 byte cacheline efficiency.
255 struct tsegqe_head t_segq
;
256 int t_dupacks
; /* consecutive dup acks recd */
257 int t_state
; /* state of this connection */
258 uint32_t t_timer
[TCPT_NTIMERS
]; /* tcp timers */
259 struct tcptimerentry tentry
; /* entry in timer list */
261 struct inpcb
*t_inpcb
; /* back pointer to internet pcb */
263 #define TF_ACKNOW 0x00001 /* ack peer immediately */
264 #define TF_DELACK 0x00002 /* ack, but try to delay it */
265 #define TF_NODELAY 0x00004 /* don't delay packets to coalesce */
266 #define TF_NOOPT 0x00008 /* don't use tcp options */
267 #define TF_SENTFIN 0x00010 /* have sent FIN */
268 #define TF_REQ_SCALE 0x00020 /* have/will request window scaling */
269 #define TF_RCVD_SCALE 0x00040 /* other side has requested scaling */
270 #define TF_REQ_TSTMP 0x00080 /* have/will request timestamps */
271 #define TF_RCVD_TSTMP 0x00100 /* a timestamp was received in SYN */
272 #define TF_SACK_PERMIT 0x00200 /* other side said I could SACK */
273 #define TF_NEEDSYN 0x00400 /* send SYN (implicit state) - unused but needed for backwards compatibility */
274 #define TF_NEEDFIN 0x00800 /* send FIN (implicit state) */
275 #define TF_NOPUSH 0x01000 /* don't push */
276 #define TF_REQ_CC 0x02000 /* have/will request CC */
277 #define TF_RCVD_CC 0x04000 /* a CC was received in SYN */
278 #define TF_SENDCCNEW 0x08000 /* Unused */
279 #define TF_MORETOCOME 0x10000 /* More data to be appended to sock */
280 #define TF_LOCAL 0x20000 /* connection to a host on local link */
281 #define TF_RXWIN0SENT 0x40000 /* sent a receiver win 0 in response */
282 #define TF_SLOWLINK 0x80000 /* route is a on a modem speed link */
283 #define TF_LASTIDLE 0x100000 /* connection was previously idle */
284 #define TF_FASTRECOVERY 0x200000 /* in NewReno Fast Recovery */
285 #define TF_WASFRECOVERY 0x400000 /* was in NewReno Fast Recovery */
286 #define TF_SIGNATURE 0x800000 /* require MD5 digests (RFC2385) */
287 #define TF_MAXSEGSNT 0x1000000 /* last segment sent was a full segment */
288 #define TF_STREAMING_ON 0x2000000 /* Receiver detected streaming */
289 #define TF_PMTUD 0x4000000 /* Perform Path MTU Discovery for this connection */
290 #define TF_CLOSING 0x8000000 /* pending tcp close */
291 #define TF_TSO 0x10000000 /* TCP Segment Offloading is enable on this connection */
292 #define TF_BLACKHOLE 0x20000000 /* Path MTU Discovery Black Hole detection */
293 #define TF_TIMER_ONLIST 0x40000000 /* pcb is on tcp_timer_list */
294 #define TF_STRETCHACK 0x80000000 /* receiver is going to delay acks */
296 tcp_seq snd_una
; /* send unacknowledged */
297 tcp_seq snd_max
; /* highest sequence number sent;
298 * used to recognize retransmits
300 tcp_seq snd_nxt
; /* send next */
301 tcp_seq snd_up
; /* send urgent pointer */
303 tcp_seq snd_wl1
; /* window update seg seq number */
304 tcp_seq snd_wl2
; /* window update seg ack number */
305 tcp_seq iss
; /* initial send sequence number */
306 tcp_seq irs
; /* initial receive sequence number */
308 tcp_seq rcv_nxt
; /* receive next */
309 tcp_seq rcv_adv
; /* advertised window */
310 uint32_t rcv_wnd
; /* receive window */
311 uint32_t t_last_recwin
;
312 tcp_seq rcv_up
; /* receive urgent pointer */
314 uint32_t snd_wnd
; /* send window */
315 uint32_t snd_cwnd
; /* congestion-controlled window */
316 uint32_t snd_ssthresh
; /* snd_cwnd size threshold for
317 * for slow start exponential to
320 tcp_seq snd_recover
; /* for use in NewReno Fast Recovery */
322 uint32_t t_maxopd
; /* mss plus options */
323 uint32_t t_rcvtime
; /* time at which a packet was received */
324 uint32_t t_sndtime
; /* time at which we last sent new data */
325 uint32_t t_starttime
; /* time connection was established */
326 int t_rtttime
; /* tcp clock when rtt calculation was started */
327 tcp_seq t_rtseq
; /* sequence number being timed */
329 uint32_t rfbuf_ts
; /* recv buffer autoscaling timestamp */
330 uint32_t rfbuf_cnt
; /* recv buffer autoscaling byte count */
331 uint32_t rfbuf_space
; /* Current "ideal" estimate of the space */
333 int t_rxtcur
; /* current retransmit value (ticks) */
334 unsigned int t_maxseg
; /* maximum segment size */
335 int t_srtt
; /* smoothed round-trip time */
336 int t_rttvar
; /* variance in round-trip time */
338 uint64_t t_accsleep_ms
; /* accumulated sleep time since last boot */
339 uint16_t t_reassqlen
; /* length of reassembly queue */
340 uint16_t t_rxtshift
; /* log(2) of rexmt exp. backoff */
341 uint32_t t_rttmin
; /* minimum rtt allowed */
342 uint32_t t_rttbest
; /* best rtt we've seen */
343 uint32_t t_rttcur
; /* most recent value of rtt */
344 uint32_t t_rttupdated
; /* number of times rtt sampled */
345 uint32_t t_rxt_conndroptime
; /* retxmt conn gets dropped after this time, when set */
346 uint32_t t_rxtstart
; /* time at which retransmission started */
347 uint32_t max_sndwnd
; /* largest window peer has offered */
349 int t_softerror
; /* possible error not yet reported */
350 /* out-of-band data */
351 char t_oobflags
; /* have some */
352 char t_iobc
; /* input character */
353 #define TCPOOB_HAVEDATA 0x01
354 #define TCPOOB_HADDATA 0x02
355 /* RFC 1323 variables */
356 u_int8_t snd_scale
; /* window scaling for send window */
357 u_int8_t rcv_scale
; /* window scaling for recv window */
358 u_int8_t request_r_scale
; /* pending window scaling */
359 u_int8_t requested_s_scale
;
360 u_int8_t tcp_cc_index
; /* index of congestion control algorithm */
361 u_int8_t t_adaptive_rtimo
; /* Read timeout used as a multiple of RTT */
362 u_int8_t t_adaptive_wtimo
; /* Write timeout used as a multiple of RTT */
363 u_int8_t t_stretchack_delayed
; /* stretch ack delayed */
365 /* State for limiting early retransmits when SACK is not enabled */
366 u_int16_t t_early_rexmt_count
; /* count of early rexmts */
367 u_int32_t t_early_rexmt_win
; /* window for limiting early rexmts */
369 u_int32_t ts_recent
; /* timestamp echo data */
371 u_int32_t ts_recent_age
; /* when last updated */
372 tcp_seq last_ack_sent
;
373 /* RFC 3465 variables */
374 u_int32_t t_bytes_acked
; /* ABC "bytes_acked" parameter */
376 int t_lastchain
; /* amount of packets chained last time around */
377 uint16_t t_unacksegs
; /* received but unacked segments for delaying acks */
380 * Pretty arbitrary value ;-)
381 * Goal is to make sure that some ACKs are being sent more frequently
382 * to allow the other side to ramp-up.
384 #define TCP_FORCED_ACKS_COUNT 16
385 uint16_t t_forced_acks
; /* count of pure ACKs that need to be forced out */
386 uint8_t t_rexmtthresh
; /* duplicate ack threshold for entering fast recovery */
387 uint8_t t_rtimo_probes
; /* number of adaptive rtimo probes sent */
388 uint32_t t_persist_timeout
; /* ZWP persistence limit as set by PERSIST_TIMEOUT */
389 uint32_t t_persist_stop
; /* persistence limit deadline if triggered by ZWP */
390 uint32_t t_notsent_lowat
; /* Low water for not sent data */
392 /* Receiver state for stretch-ack algorithm */
393 u_int32_t rcv_unackwin
; /* to measure win for stretching acks */
394 u_int32_t rcv_by_unackwin
; /* bytes seen during the last ack-stretching win */
395 u_int32_t rcv_by_unackhalfwin
;
396 u_int32_t rcv_nostrack_ts
; /* timestamp when stretch ack was disabled automatically */
397 u_int32_t rcv_nostrack_pkts
; /* pkts received since strech ack was disabled */
398 u_int16_t rcv_waitforss
; /* wait for packets during slow-start */
402 #define TE_SETUPSENT 0x0001 /* Indicate we have sent ECN-SETUP SYN or SYN-ACK */
403 #define TE_SETUPRECEIVED 0x0002 /* Indicate we have received ECN-SETUP SYN or SYN-ACK */
404 #define TE_SENDIPECT 0x0004 /* Indicate we haven't sent or received non-ECN-setup SYN or SYN-ACK */
405 #define TE_SENDCWR 0x0008 /* Indicate that the next non-retransmit should have the TCP CWR flag set */
406 #define TE_SENDECE 0x0010 /* Indicate that the next packet should have the TCP ECE flag set */
407 #define TE_INRECOVERY 0x0020 /* connection entered recovery after receiving ECE */
408 #define TE_RECV_ECN_CE 0x0040 /* Received IPTOS_ECN_CE marking atleast once */
409 #define TE_RECV_ECN_ECE 0x0080 /* Received ECE marking atleast once */
410 #define TE_LOST_SYN 0x0100 /* Lost SYN with ECN setup */
411 #define TE_LOST_SYNACK 0x0200 /* Lost SYN-ACK with ECN setup */
412 #define TE_ECN_MODE_ENABLE 0x0400 /* Option ECN mode set to enable */
413 #define TE_ECN_MODE_DISABLE 0x0800 /* Option ECN mode set to disable */
414 #define TE_ENABLE_ECN 0x1000 /* Enable negotiation of ECN */
415 #define TE_ECN_ON (TE_SETUPSENT | TE_SETUPRECEIVED) /* Indicate ECN was successfully negotiated on a connection) */
416 #define TE_CEHEURI_SET 0x2000 /* We did our CE-probing at the beginning */
417 #define TE_CLIENT_SETUP 0x4000 /* setup from client side */
418 #define TE_RCVD_SYN_RST 0x8000 /* Received RST to the first ECN enabled SYN */
420 u_int32_t t_ecn_recv_ce
; /* Received CE from the network */
421 u_int32_t t_ecn_recv_cwr
; /* Packets received with CWR */
423 /* state for bad retransmit recovery */
424 u_int32_t snd_cwnd_prev
; /* cwnd prior to retransmit */
425 u_int32_t snd_ssthresh_prev
; /* ssthresh prior to retransmit */
426 tcp_seq snd_recover_prev
; /* snd_recover prior to retransmit */
427 int t_srtt_prev
; /* srtt prior to retransmit */
428 int t_rttvar_prev
; /* rttvar prior to retransmit */
429 u_int32_t t_badrexmt_time
; /* bad rexmt detection time */
431 /* Packet reordering metric */
432 u_int32_t t_reorderwin
; /* Reordering late time offset */
434 /* SACK related state */
435 int16_t snd_numholes
; /* number of holes seen by sender */
436 tcp_seq sack_newdata
; /* New data xmitted in this recovery
437 * episode starts at this seq number */
438 TAILQ_HEAD(sackhole_head
, sackhole
) snd_holes
;
439 /* SACK scoreboard (sorted) */
440 tcp_seq snd_fack
; /* last seq number(+1) sack'd by rcv'r*/
441 int rcv_numsacks
; /* # distinct sack blks present */
442 struct sackblk sackblks
[MAX_SACK_BLKS
]; /* seq nos. of sack blocks */
443 struct sackhint sackhint
; /* SACK scoreboard hint */
444 tcp_seq send_highest_sack
; /* Sequence number of fresh data sent after the most recent fast-retransmit */
445 int t_new_dupacks
; /* Dupacks received above send_highest_sack */
447 struct mbuf
*t_pktlist_head
; /* First packet in transmit chain */
448 struct mbuf
*t_pktlist_tail
; /* Last packet in transmit chain */
449 u_int32_t t_pktlist_sentlen
; /* total bytes in transmit chain */
451 u_int32_t t_keepidle
; /* keepalive idle timer (override global if > 0) */
452 u_int32_t t_keepinit
; /* connection timeout, i.e. idle time
453 * in SYN_SENT or SYN_RECV state */
454 u_int32_t t_keepintvl
; /* interval between keepalives */
455 u_int32_t t_keepcnt
; /* number of keepalives before close */
457 u_int32_t tso_max_segment_size
; /* TSO maximum segment unit for NIC */
458 u_int16_t t_pmtud_lastseg_size
; /* size of the last sent segment */
459 u_int32_t t_pmtud_saved_maxopd
; /* MSS saved before performing PMTU-D BlackHole detection */
460 u_int32_t t_pmtud_start_ts
; /* Time of PMTUD blackhole detection */
463 u_int32_t rxduplicatebytes
;
464 u_int32_t rxoutoforderbytes
;
465 u_int32_t txretransmitbytes
;
466 u_int16_t synrxtshift
;
468 u_int16_t unused_pad_to_8
;
470 uint32_t delayed_acks_sent
;
471 uint32_t acks_delayed
;
473 u_int8_t t_notify_ack_count
;
474 u_int8_t t_ecn_recv_ce_pkt
; /* Received packet with CE-bit set (independent from last_ack_sent) */
475 u_int32_t t_cached_maxopd
; /* default for MSS adjustment using link status report */
477 uint32_t bg_ssthresh
; /* Slow start threshold until delay increases */
478 uint32_t t_flagsext
; /* Another field to accommodate more flags */
479 #define TF_RXTFINDROP 0x1 /* Drop conn after retransmitting FIN 3 times */
480 #define TF_RCVUNACK_WAITSS 0x2 /* set when the receiver should not stretch acks */
481 #define TF_BWMEAS_INPROGRESS 0x4 /* Indicate BW meas is happening */
482 #define TF_MEASURESNDBW 0x8 /* Measure send bw on this connection */
483 #define TF_LAST_IS_PSH 0x10 /* Indicates whether the last packet in the rcv socket buffer had the PUSH-flag set */
484 #define TF_SACK_ENABLE 0x20 /* SACK is enabled */
485 #define TF_RECOMPUTE_RTT 0x40 /* recompute RTT after spurious retransmit */
486 #define TF_DETECT_READSTALL 0x80 /* Used to detect a stall during read operation */
487 #define TF_RECV_THROTTLE 0x100 /* Input throttling active */
488 #define TF_NOSTRETCHACK 0x200 /* ack every other packet */
489 #define TF_NOTIMEWAIT 0x800 /* Avoid going into time-wait */
490 #define TF_SENT_TLPROBE 0x1000 /* Sent data in PTO */
491 #define TF_PKTS_REORDERED 0x2000 /* Detected reordering */
492 #define TF_DELAY_RECOVERY 0x4000 /* delay fast recovery */
493 #define TF_FORCE 0x8000 /* force 1 byte out */
494 #define TF_DISABLE_STRETCHACK 0x10000 /* auto-disable stretch ack */
495 #define TF_NOBLACKHOLE_DETECTION 0x20000 /* Disable PMTU blackhole detection */
496 #define TF_RESCUE_RXT 0x80000 /* SACK rescue retransmit */
497 #define TF_CWND_NONVALIDATED 0x100000 /* cwnd non validated */
498 #define TF_IF_PROBING 0x200000 /* Trigger interface probe timeout */
499 #define TF_FASTOPEN 0x400000 /* TCP Fastopen is enabled */
500 #define TF_REASS_INPROG 0x800000 /* Reassembly is in progress */
501 #define TF_FASTOPEN_FORCE_ENABLE 0x1000000 /* Force-enable TCP Fastopen */
502 #define TF_LOGGED_CONN_SUMMARY 0x2000000 /* Connection summary was logged */
505 /* Inter-arrival jitter related state */
506 uint32_t iaj_rcv_ts
; /* tcp clock when the first packet was received */
507 uint16_t iaj_size
; /* Size of packet for iaj measurement */
508 uint8_t iaj_small_pkt
; /* Count of packets smaller than iaj_size */
509 uint8_t t_pipeack_ind
; /* index for next pipeack sample */
510 uint16_t iaj_pktcnt
; /* packet count, to avoid throttling initially */
511 uint16_t acc_iaj
; /* Accumulated iaj */
512 uint32_t avg_iaj
; /* Mean */
513 uint32_t std_dev_iaj
; /* Standard deviation */
514 #endif /* TRAFFIC_MGT */
515 struct bwmeas
*t_bwmeas
; /* State for bandwidth measurement */
516 tcp_seq t_idleat
; /* rcv_nxt at idle time */
517 TAILQ_ENTRY(tcpcb
) t_twentry
; /* link for time wait queue */
518 struct tcp_ccstate
*t_ccstate
; /* congestion control related state */
519 /* Tail loss probe related state */
520 tcp_seq t_tlphighrxt
; /* snd_nxt after PTO */
521 u_int32_t t_tlpstart
; /* timestamp at PTO */
522 /* DSACK data receiver state */
523 tcp_seq t_dsack_lseq
; /* DSACK left sequence */
524 tcp_seq t_dsack_rseq
; /* DSACK right sequence */
525 /* DSACK data sender state */
526 SLIST_HEAD(tcp_rxt_seghead
, tcp_rxt_seg
) t_rxt_segments
;
527 tcp_seq t_dsack_lastuna
; /* snd_una when last recovery episode started */
528 /* state for congestion window validation (draft-ietf-tcpm-newcwv-07) */
529 #define TCP_PIPEACK_SAMPLE_COUNT 3
530 u_int32_t t_pipeack_sample
[TCP_PIPEACK_SAMPLE_COUNT
]; /* pipeack, bytes acked within RTT */
531 tcp_seq t_pipeack_lastuna
; /* una when pipeack measurement started */
533 u_int32_t t_lossflightsize
;
536 u_int32_t t_mpflags
; /* flags for multipath TCP */
538 #define TMPF_PREESTABLISHED 0x00000001 /* conn in pre-established state */
539 #define TMPF_SND_KEYS 0x00000002 /* indicates that keys should be send */
540 #define TMPF_MPTCP_TRUE 0x00000004 /* negotiated MPTCP successfully */
541 #define TMPF_MPTCP_RCVD_KEY 0x00000008 /* state for 3-way handshake */
542 #define TMPF_SND_MPPRIO 0x00000010 /* send priority of subflow */
543 #define TMPF_SND_REM_ADDR 0x00000020 /* initiate address removal */
544 #define TMPF_RCVD_DACK 0x00000040 /* received a data-ack */
545 #define TMPF_JOINED_FLOW 0x00000080 /* Indicates additional flow */
546 #define TMPF_BACKUP_PATH 0x00000100 /* Indicates backup path */
547 #define TMPF_MPTCP_ACKNOW 0x00000200 /* Send Data ACK */
548 #define TMPF_SEND_DSN 0x00000400 /* Send DSN mapping */
549 #define TMPF_SEND_DFIN 0x00000800 /* Send Data FIN */
550 #define TMPF_RECV_DFIN 0x00001000 /* Recv Data FIN */
551 #define TMPF_SENT_JOIN 0x00002000 /* Sent Join */
552 #define TMPF_RECVD_JOIN 0x00004000 /* Received Join */
553 #define TMPF_RESET 0x00008000 /* Send RST */
554 #define TMPF_TCP_FALLBACK 0x00010000 /* Fallback to TCP */
555 #define TMPF_FASTCLOSERCV 0x00020000 /* Received Fastclose option */
556 #define TMPF_EMBED_DSN 0x00040000 /* tp has DSN mapping */
557 #define TMPF_MPTCP_READY 0x00080000 /* Can send DSS options on data */
558 #define TMPF_INFIN_SENT 0x00100000 /* Sent infinite mapping */
559 #define TMPF_SND_MPFAIL 0x00200000 /* Received mapping csum failure */
560 #define TMPF_SND_JACK 0x00400000 /* Send a Join-ACK */
561 #define TMPF_TFO_REQUEST 0x00800000 /* TFO Requested */
563 #define TMPF_MPTCP_SIGNALS (TMPF_SND_MPPRIO | TMPF_SND_REM_ADDR | TMPF_SND_MPFAIL | TMPF_SND_KEYS | TMPF_SND_JACK)
565 tcp_seq t_mpuna
; /* unacknowledged sequence */
566 struct mptcb
*t_mptcb
; /* pointer to MPTCP TCB */
567 struct mptsub
*t_mpsub
; /* pointer to the MPTCP subflow */
568 struct mpt_dsn_map t_rcv_map
; /* Receive mapping list */
569 u_int8_t t_local_aid
; /* Addr Id for authentication */
570 u_int8_t t_rem_aid
; /* Addr ID of another subflow */
571 u_int8_t t_mprxtshift
; /* join retransmission */
574 #define TFO_F_OFFER_COOKIE 0x01 /* We will offer a cookie */
575 #define TFO_F_COOKIE_VALID 0x02 /* The received cookie is valid */
576 #define TFO_F_COOKIE_REQ 0x04 /* Client requested a new cookie */
577 #define TFO_F_COOKIE_SENT 0x08 /* Client did send a cookie in the SYN */
578 #define TFO_F_SYN_LOSS 0x10 /* A SYN-loss triggered a fallback to regular TCP on the client-side */
579 #define TFO_F_NO_SNDPROBING 0x20 /* This network is guaranteed to support TFO in the upstream direction */
580 #define TFO_F_HEURISTIC_DONE 0x40 /* We have already marked this network as bad */
581 u_int8_t t_tfo_flags
;
582 #define TFO_S_SYNDATA_RCV 0x01 /* SYN+data has been received */
583 #define TFO_S_COOKIEREQ_RECV 0x02 /* TFO-cookie request received */
584 #define TFO_S_COOKIE_SENT 0x04 /* TFO-cookie announced in SYN/ACK */
585 #define TFO_S_COOKIE_INVALID 0x08 /* Received TFO-cookie is invalid */
586 #define TFO_S_COOKIE_REQ 0x10 /* TFO-cookie requested within the SYN */
587 #define TFO_S_COOKIE_RCV 0x20 /* TFO-cookie received in SYN/ACK */
588 #define TFO_S_SYN_DATA_SENT 0x40 /* SYN+data sent */
589 #define TFO_S_SYN_DATA_ACKED 0x80 /* SYN+data has been acknowledged in SYN/ACK */
590 #define TFO_S_SYN_LOSS 0x0100 /* SYN+TFO has been lost - fallback to regular TCP */
591 #define TFO_S_COOKIE_WRONG 0x0200 /* Cookie we sent in the SYN was wrong */
592 #define TFO_S_NO_COOKIE_RCV 0x0400 /* We asked for a cookie but didn't get one */
593 #define TFO_S_HEURISTICS_DISABLE 0x0800 /* TFO-heuristics disabled it for this connection */
594 #define TFO_S_SEND_BLACKHOLE 0x1000 /* TFO got blackholed in the send direction */
595 #define TFO_S_RECV_BLACKHOLE 0x2000 /* TFO got blackholed in the recv direction */
596 #define TFO_S_ONE_BYTE_PROXY 0x4000 /* TFO failed because of a proxy acknowledging just one byte */
597 u_int16_t t_tfo_stats
;
599 u_int8_t t_tfo_probes
; /* TFO-probes we did send */
601 * This here is the TFO-probing state-machine. Transitions are as follows:
603 * Current state: PROBE_NONE
604 * Event: SYN+DATA acknowledged
605 * Action: Transition to PROBE_PROBING and set keepalive-timer
607 * Current state: PROBE_PROBING (initial state)
608 * Event: Receive data
609 * Action: Transition to PROBE_NONE and cancel keepalive-timer
610 * Event: Receive ACK that does not indicate a hole
611 * Action: Transition to PROBE_NONE and cancel keepalive-timer
612 * Event: Receive ACK that indicates a hole
613 * Action: Transition to PROBE_WAIT_DATA and set a short timer
614 * to wait for the final segment.
615 * Event: Keepalive-timeout (did not receive any segment)
616 * Action: Signal ETIMEDOUT as with regular keepalive-timers
618 * Current state: PROBE_WAIT_DATA
619 * Event: Receive data
620 * Action: Transition to PROBE_NONE and cancel keepalive-timer
621 * Event: Data-timeout (did not receive the expected data)
622 * Action: Signal ENODATA up to the app and close everything.
624 #define TFO_PROBE_NONE 0 /* Not probing now */
625 #define TFO_PROBE_PROBING 1 /* Sending out TCP-keepalives waiting for reply */
626 #define TFO_PROBE_WAIT_DATA 2 /* Received reply, waiting for data */
627 u_int8_t t_tfo_probe_state
;
629 u_int32_t t_rcvoopack
; /* out-of-order packets received */
630 u_int32_t t_pawsdrop
; /* segments dropped due to PAWS */
631 u_int32_t t_sack_recovery_episode
; /* SACK recovery episodes */
632 u_int32_t t_reordered_pkts
; /* packets reorderd */
633 u_int32_t t_dsack_sent
; /* Sent DSACK notification */
634 u_int32_t t_dsack_recvd
; /* Received a valid DSACK option */
635 SLIST_HEAD(, tcp_notify_ack_marker
) t_notify_ack
; /* state for notifying data acknowledgements */
636 u_int32_t t_recv_throttle_ts
; /* TS for start of recv throttle */
637 u_int32_t t_rxt_minimum_timeout
; /* minimum retransmit timeout in ms */
638 uint32_t t_challengeack_last
; /* last time challenge ACK was sent per sec */
639 uint32_t t_challengeack_count
; /* # of challenge ACKs already sent per sec */
641 u_int32_t t_log_flags
; /* TCP logging flags*/
642 u_int32_t t_connect_time
; /* time when the connection started */
644 uint32_t t_comp_gencnt
; /* Current compression generation-count */
645 uint32_t t_comp_lastinc
; /* Last time the gen-count was changed - should change every TCP_COMP_CHANGE_RATE ms */
646 #define TCP_COMP_CHANGE_RATE 5 /* Intervals at which we change the gencnt. Means that worst-case we send one ACK every TCP_COMP_CHANGE_RATE ms */
648 uint32_t t_ts_offset
; /* Randomized timestamp offset to hide on-the-wire timestamp */
654 #define IN_FASTRECOVERY(tp) (tp->t_flags & TF_FASTRECOVERY)
655 #define SACK_ENABLED(tp) (tp->t_flagsext & TF_SACK_ENABLE)
658 * If the connection is in a throttled state due to advisory feedback from
659 * the interface output queue, reset that state. We do this in favor
660 * of entering recovery because the data transfer during recovery
661 * should be just a trickle and it will help to improve performance.
662 * We also do not want to back off twice in the same RTT.
664 #define ENTER_FASTRECOVERY(_tp_) do { \
665 (_tp_)->t_flags |= TF_FASTRECOVERY; \
666 if (INP_IS_FLOW_CONTROLLED((_tp_)->t_inpcb)) \
667 inp_reset_fc_state((_tp_)->t_inpcb); \
668 if (!SLIST_EMPTY(&tp->t_rxt_segments)) \
669 tcp_rxtseg_clean(tp); \
670 (_tp_)->t_new_dupacks = 0; \
673 #define EXIT_FASTRECOVERY(_tp_) do { \
674 (_tp_)->t_flags &= ~TF_FASTRECOVERY; \
675 (_tp_)->t_dupacks = 0; \
676 (_tp_)->t_new_dupacks = 0; \
677 (_tp_)->t_rexmtthresh = (uint8_t)tcprexmtthresh; \
678 (_tp_)->t_bytes_acked = 0; \
679 (_tp_)->ecn_flags &= ~TE_INRECOVERY; \
680 (_tp_)->t_timer[TCPT_PTO] = 0; \
681 (_tp_)->t_flagsext &= ~TF_RESCUE_RXT; \
682 (_tp_)->t_lossflightsize = 0; \
683 (_tp_)->sackhint.sack_bytes_acked = 0; \
687 * When the number of duplicate acks received is less than
688 * the retransmit threshold, use Limited Transmit algorithm
690 extern int tcprexmtthresh
;
691 #define ALLOW_LIMITED_TRANSMIT(_tp_) \
692 ((_tp_)->t_dupacks > 0 && \
693 (_tp_)->t_dupacks < (_tp_)->t_rexmtthresh && \
694 ((_tp_)->t_flagsext & (TF_PKTS_REORDERED|TF_DELAY_RECOVERY)) \
695 != (TF_PKTS_REORDERED|TF_DELAY_RECOVERY))
698 * This condition is true is timestamp option is supported
701 #define TSTMP_SUPPORTED(_tp_) \
702 (((_tp_)->t_flags & (TF_REQ_TSTMP|TF_RCVD_TSTMP)) == \
703 (TF_REQ_TSTMP|TF_RCVD_TSTMP))
706 * This condition is true if window scale option is supported
709 #define TCP_WINDOW_SCALE_ENABLED(_tp_) \
710 (((_tp_)->t_flags & (TF_RCVD_SCALE|TF_REQ_SCALE)) == \
711 (TF_RCVD_SCALE|TF_REQ_SCALE))
713 /* Is ECN enabled end-to-end */
714 #define TCP_ECN_ENABLED(_tp_) \
715 (((_tp_)->ecn_flags & (TE_ECN_ON)) == (TE_ECN_ON))
718 * Gives number of bytes acked by this ack
720 #define BYTES_ACKED(_th_, _tp_) \
721 ((_th_)->th_ack - (_tp_)->snd_una)
723 /* Returns true if a DSACK option should be sent */
724 #define TCP_SEND_DSACK_OPT(_tp_) \
725 ((_tp_)->t_dsack_lseq > 0 && (_tp_)->t_dsack_rseq > 0)
728 * Returns true if a DSACK sequence is within the max send window that will
729 * be accepted. In order to set a window to validate sequence numbers, the
730 * max send window within which a DSACK option is processed is limited.
732 * We need to choose a maximum window to check if the sequence number is
733 * within the window. One arbitrary choice is 256 * MSS because if the
734 * window is as large as 256 segments it might be big enough to ignore the
735 * DSACK option. Choosing a much larger limit means that the memory for
736 * retransmit segments can be held for a longer time.
738 #define TCP_DSACK_MAX_SEND_WINDOW(_tp_) (MIN((_tp_)->snd_wnd, tcp_autosndbuf_max))
739 #define TCP_DSACK_SEQ_IN_WINDOW(_tp_, _seq_, _una_) \
740 (SEQ_LEQ((_seq_), (_tp_)->snd_max) && \
741 SEQ_GEQ((_seq_), ((_una_) - TCP_DSACK_MAX_SEND_WINDOW(_tp_))))
743 #define TCP_RESET_REXMT_STATE(_tp_) do { \
744 (_tp_)->t_rxtshift = 0; \
745 (_tp_)->t_rxtstart = 0; \
746 mptcp_reset_rexmit_state((_tp_)); \
749 #define TCP_IF_STATE_CHANGED(tp, probe_if_index) \
750 (probe_if_index > 0 && tp->t_inpcb->inp_last_outifp != NULL && \
751 probe_if_index == tp->t_inpcb->inp_last_outifp->if_index)
754 * Structure to hold TCP options that are only used during segment
755 * processing (in tcp_input), but not held in the tcpcb.
756 * It's basically used to reduce the number of parameters
760 u_int32_t to_flags
; /* which options are present */
761 #define TOF_TS 0x0001 /* timestamp */
762 #define TOF_MSS 0x0010
763 #define TOF_SCALE 0x0020
764 #define TOF_SIGNATURE 0x0040 /* signature option present */
765 #define TOF_SIGLEN 0x0080 /* signature length valid (RFC2385) */
766 #define TOF_SACK 0x0100 /* Peer sent SACK option */
767 #define TOF_MPTCP 0x0200 /* MPTCP options to be dropped */
768 #define TOF_TFO 0x0400 /* TFO cookie option present */
769 #define TOF_TFOREQ 0x0800 /* TFO cookie request present */
773 u_int8_t to_requested_s_scale
;
774 u_int8_t to_nsacks
; /* number of SACK blocks */
775 u_char
*to_sacks
; /* pointer to the first SACK blocks */
776 u_char
*to_tfo
; /* pointer to the TFO cookie */
779 #define intotcpcb(ip) ((struct tcpcb *)(ip)->inp_ppcb)
780 #define sototcpcb(so) (intotcpcb(sotoinpcb(so)))
782 /* TFO-specific defines */
783 #define TFO_COOKIE_LEN_MIN 4
784 #define TFO_COOKIE_LEN_DEFAULT 8
785 #define TFO_COOKIE_LEN_MAX 16
788 * The initial retransmission should happen at rtt + 4 * rttvar.
789 * Because of the way we do the smoothing, srtt and rttvar
790 * will each average +1/2 tick of bias. When we compute
791 * the retransmit timer, we want 1/2 tick of rounding and
792 * 1 extra tick because of +-1/2 tick uncertainty in the
793 * firing of the timer. The bias will give us exactly the
794 * 1.5 tick we need. But, because the bias is
795 * statistical, we have to test that we don't drop below
796 * the minimum feasible timer (which is 2 ticks).
797 * This version of the macro adapted from a paper by Lawrence
798 * Brakmo and Larry Peterson which outlines a problem caused
799 * by insufficient precision in the original implementation,
800 * which results in inappropriately large RTO values for very
803 #define TCP_REXMTVAL(tp) \
804 max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT)) \
805 + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
808 * Jaguar compatible TCP control block, for xtcpcb
809 * Does not have the old fields
814 _TCPCB_LIST_HEAD(tsegqe_head
, tseg_qent
);
817 #endif /* KERNEL_PRIVATE */
818 #if defined(KERNEL_PRIVATE)
821 struct tsegqe_head t_segq
;
822 #endif /* KERNEL_PRIVATE */
823 int t_dupacks
; /* consecutive dup acks recd */
824 u_int32_t unused
; /* unused now: was t_template */
826 int t_timer
[TCPT_NTIMERS_EXT
]; /* tcp timers */
828 _TCPCB_PTR(struct inpcb
*) t_inpcb
; /* back pointer to internet pcb */
829 int t_state
; /* state of this connection */
831 #define TF_ACKNOW 0x00001 /* ack peer immediately */
832 #define TF_DELACK 0x00002 /* ack, but try to delay it */
833 #define TF_NODELAY 0x00004 /* don't delay packets to coalesce */
834 #define TF_NOOPT 0x00008 /* don't use tcp options */
835 #define TF_SENTFIN 0x00010 /* have sent FIN */
836 #define TF_REQ_SCALE 0x00020 /* have/will request window scaling */
837 #define TF_RCVD_SCALE 0x00040 /* other side has requested scaling */
838 #define TF_REQ_TSTMP 0x00080 /* have/will request timestamps */
839 #define TF_RCVD_TSTMP 0x00100 /* a timestamp was received in SYN */
840 #define TF_SACK_PERMIT 0x00200 /* other side said I could SACK */
841 #define TF_NEEDSYN 0x00400 /* send SYN (implicit state) - unused but needed for backwards compatibility */
842 #define TF_NEEDFIN 0x00800 /* send FIN (implicit state) */
843 #define TF_NOPUSH 0x01000 /* don't push */
844 #define TF_REQ_CC 0x02000 /* have/will request CC */
845 #define TF_RCVD_CC 0x04000 /* a CC was received in SYN */
846 #define TF_SENDCCNEW 0x08000 /* Not implemented */
847 #define TF_MORETOCOME 0x10000 /* More data to be appended to sock */
848 #define TF_LQ_OVERFLOW 0x20000 /* listen queue overflow */
849 #define TF_RXWIN0SENT 0x40000 /* sent a receiver win 0 in response */
850 #define TF_SLOWLINK 0x80000 /* route is a on a modem speed link */
852 int t_force
; /* 1 if forcing out a byte */
854 tcp_seq snd_una
; /* send unacknowledged */
855 tcp_seq snd_max
; /* highest sequence number sent;
856 * used to recognize retransmits
858 tcp_seq snd_nxt
; /* send next */
859 tcp_seq snd_up
; /* send urgent pointer */
861 tcp_seq snd_wl1
; /* window update seg seq number */
862 tcp_seq snd_wl2
; /* window update seg ack number */
863 tcp_seq iss
; /* initial send sequence number */
864 tcp_seq irs
; /* initial receive sequence number */
866 tcp_seq rcv_nxt
; /* receive next */
867 tcp_seq rcv_adv
; /* advertised window */
868 u_int32_t rcv_wnd
; /* receive window */
869 tcp_seq rcv_up
; /* receive urgent pointer */
871 u_int32_t snd_wnd
; /* send window */
872 u_int32_t snd_cwnd
; /* congestion-controlled window */
873 u_int32_t snd_ssthresh
; /* snd_cwnd size threshold for
874 * for slow start exponential to
877 u_int t_maxopd
; /* mss plus options */
879 u_int32_t t_rcvtime
; /* time at which a packet was received */
880 u_int32_t t_starttime
; /* time connection was established */
881 int t_rtttime
; /* round trip time */
882 tcp_seq t_rtseq
; /* sequence number being timed */
884 int t_rxtcur
; /* current retransmit value (ticks) */
885 u_int t_maxseg
; /* maximum segment size */
886 int t_srtt
; /* smoothed round-trip time */
887 int t_rttvar
; /* variance in round-trip time */
889 int t_rxtshift
; /* log(2) of rexmt exp. backoff */
890 u_int t_rttmin
; /* minimum rtt allowed */
891 u_int32_t t_rttupdated
; /* number of times rtt sampled */
892 u_int32_t max_sndwnd
; /* largest window peer has offered */
894 int t_softerror
; /* possible error not yet reported */
895 /* out-of-band data */
896 char t_oobflags
; /* have some */
897 char t_iobc
; /* input character */
898 #define TCPOOB_HAVEDATA 0x01
899 #define TCPOOB_HADDATA 0x02
900 /* RFC 1323 variables */
901 u_char snd_scale
; /* window scaling for send window */
902 u_char rcv_scale
; /* window scaling for recv window */
903 u_char request_r_scale
; /* pending window scaling */
904 u_char requested_s_scale
;
905 u_int32_t ts_recent
; /* timestamp echo data */
907 u_int32_t ts_recent_age
; /* when last updated */
908 tcp_seq last_ack_sent
;
909 /* RFC 1644 variables */
910 tcp_cc cc_send
; /* send connection count */
911 tcp_cc cc_recv
; /* receive connection count */
912 tcp_seq snd_recover
; /* for use in fast recovery */
914 u_int32_t snd_cwnd_prev
; /* cwnd prior to retransmit */
915 u_int32_t snd_ssthresh_prev
; /* ssthresh prior to retransmit */
916 u_int32_t t_badrxtwin
; /* window for retransmit recovery */
919 #define tcps_ecn_setup tcps_ecn_client_success
920 #define tcps_sent_cwr tcps_ecn_recv_ece
921 #define tcps_sent_ece tcps_ecn_sent_ece
925 * Many of these should be kept per connection,
926 * but that's inconvenient at the moment.
929 u_int32_t tcps_connattempt
; /* connections initiated */
930 u_int32_t tcps_accepts
; /* connections accepted */
931 u_int32_t tcps_connects
; /* connections established */
932 u_int32_t tcps_drops
; /* connections dropped */
933 u_int32_t tcps_conndrops
; /* embryonic connections dropped */
934 u_int32_t tcps_closed
; /* conn. closed (includes drops) */
935 u_int32_t tcps_segstimed
; /* segs where we tried to get rtt */
936 u_int32_t tcps_rttupdated
; /* times we succeeded */
937 u_int32_t tcps_delack
; /* delayed acks sent */
938 u_int32_t tcps_timeoutdrop
; /* conn. dropped in rxmt timeout */
939 u_int32_t tcps_rexmttimeo
; /* retransmit timeouts */
940 u_int32_t tcps_persisttimeo
; /* persist timeouts */
941 u_int32_t tcps_keeptimeo
; /* keepalive timeouts */
942 u_int32_t tcps_keepprobe
; /* keepalive probes sent */
943 u_int32_t tcps_keepdrops
; /* connections dropped in keepalive */
945 u_int32_t tcps_sndtotal
; /* total packets sent */
946 u_int32_t tcps_sndpack
; /* data packets sent */
947 u_int32_t tcps_sndbyte
; /* data bytes sent */
948 u_int32_t tcps_sndrexmitpack
; /* data packets retransmitted */
949 u_int32_t tcps_sndrexmitbyte
; /* data bytes retransmitted */
950 u_int32_t tcps_sndacks
; /* ack-only packets sent */
951 u_int32_t tcps_sndprobe
; /* window probes sent */
952 u_int32_t tcps_sndurg
; /* packets sent with URG only */
953 u_int32_t tcps_sndwinup
; /* window update-only packets sent */
954 u_int32_t tcps_sndctrl
; /* control (SYN|FIN|RST) packets sent */
956 u_int32_t tcps_rcvtotal
; /* total packets received */
957 u_int32_t tcps_rcvpack
; /* packets received in sequence */
958 u_int32_t tcps_rcvbyte
; /* bytes received in sequence */
959 u_int32_t tcps_rcvbadsum
; /* packets received with ccksum errs */
960 u_int32_t tcps_rcvbadoff
; /* packets received with bad offset */
961 u_int32_t tcps_rcvmemdrop
; /* packets dropped for lack of memory */
962 u_int32_t tcps_rcvshort
; /* packets received too short */
963 u_int32_t tcps_rcvduppack
; /* duplicate-only packets received */
964 u_int32_t tcps_rcvdupbyte
; /* duplicate-only bytes received */
965 u_int32_t tcps_rcvpartduppack
; /* packets with some duplicate data */
966 u_int32_t tcps_rcvpartdupbyte
; /* dup. bytes in part-dup. packets */
967 u_int32_t tcps_rcvoopack
; /* out-of-order packets received */
968 u_int32_t tcps_rcvoobyte
; /* out-of-order bytes received */
969 u_int32_t tcps_rcvpackafterwin
; /* packets with data after window */
970 u_int32_t tcps_rcvbyteafterwin
; /* bytes rcvd after window */
971 u_int32_t tcps_rcvafterclose
; /* packets rcvd after "close" */
972 u_int32_t tcps_rcvwinprobe
; /* rcvd window probe packets */
973 u_int32_t tcps_rcvdupack
; /* rcvd duplicate acks */
974 u_int32_t tcps_rcvacktoomuch
; /* rcvd acks for unsent data */
975 u_int32_t tcps_rcvackpack
; /* rcvd ack packets */
976 u_int32_t tcps_rcvackbyte
; /* bytes acked by rcvd acks */
977 u_int32_t tcps_rcvwinupd
; /* rcvd window update packets */
978 u_int32_t tcps_pawsdrop
; /* segments dropped due to PAWS */
979 u_int32_t tcps_predack
; /* times hdr predict ok for acks */
980 u_int32_t tcps_preddat
; /* times hdr predict ok for data pkts */
981 u_int32_t tcps_pcbcachemiss
;
982 u_int32_t tcps_cachedrtt
; /* times cached RTT in route updated */
983 u_int32_t tcps_cachedrttvar
; /* times cached rttvar updated */
984 u_int32_t tcps_cachedssthresh
; /* times cached ssthresh updated */
985 u_int32_t tcps_usedrtt
; /* times RTT initialized from route */
986 u_int32_t tcps_usedrttvar
; /* times RTTVAR initialized from rt */
987 u_int32_t tcps_usedssthresh
; /* times ssthresh initialized from rt*/
988 u_int32_t tcps_persistdrop
; /* timeout in persist state */
989 u_int32_t tcps_badsyn
; /* bogus SYN, e.g. premature ACK */
990 u_int32_t tcps_mturesent
; /* resends due to MTU discovery */
991 u_int32_t tcps_listendrop
; /* listen queue overflows */
992 u_int32_t tcps_synchallenge
; /* challenge ACK due to bad SYN */
993 u_int32_t tcps_rstchallenge
; /* challenge ACK due to bad RST */
995 /* new stats from FreeBSD 5.4 sync up */
996 u_int32_t tcps_minmssdrops
; /* average minmss too low drops */
998 u_int32_t tcps_sndrexmitbad
; /* unnecessary packet retransmissions */
999 u_int32_t tcps_badrst
; /* ignored RSTs in the window */
1001 u_int32_t tcps_sc_added
; /* entry added to syncache */
1002 u_int32_t tcps_sc_retransmitted
; /* syncache entry was retransmitted */
1003 u_int32_t tcps_sc_dupsyn
; /* duplicate SYN packet */
1004 u_int32_t tcps_sc_dropped
; /* could not reply to packet */
1005 u_int32_t tcps_sc_completed
; /* successful extraction of entry */
1006 u_int32_t tcps_sc_bucketoverflow
; /* syncache per-bucket limit hit */
1007 u_int32_t tcps_sc_cacheoverflow
; /* syncache cache limit hit */
1008 u_int32_t tcps_sc_reset
; /* RST removed entry from syncache */
1009 u_int32_t tcps_sc_stale
; /* timed out or listen socket gone */
1010 u_int32_t tcps_sc_aborted
; /* syncache entry aborted */
1011 u_int32_t tcps_sc_badack
; /* removed due to bad ACK */
1012 u_int32_t tcps_sc_unreach
; /* ICMP unreachable received */
1013 u_int32_t tcps_sc_zonefail
; /* zalloc() failed */
1014 u_int32_t tcps_sc_sendcookie
; /* SYN cookie sent */
1015 u_int32_t tcps_sc_recvcookie
; /* SYN cookie received */
1017 u_int32_t tcps_hc_added
; /* entry added to hostcache */
1018 u_int32_t tcps_hc_bucketoverflow
; /* hostcache per bucket limit hit */
1020 /* SACK related stats */
1021 u_int32_t tcps_sack_recovery_episode
; /* SACK recovery episodes */
1022 u_int32_t tcps_sack_rexmits
; /* SACK rexmit segments */
1023 u_int32_t tcps_sack_rexmit_bytes
; /* SACK rexmit bytes */
1024 u_int32_t tcps_sack_rcv_blocks
; /* SACK blocks (options) received */
1025 u_int32_t tcps_sack_send_blocks
; /* SACK blocks (options) sent */
1026 u_int32_t tcps_sack_sboverflow
; /* SACK sendblock overflow */
1028 u_int32_t tcps_bg_rcvtotal
; /* total background packets received */
1029 u_int32_t tcps_rxtfindrop
; /* drop conn after retransmitting FIN */
1030 u_int32_t tcps_fcholdpacket
; /* packets withheld because of flow control */
1032 u_int32_t tcps_limited_txt
; /* Limited transmit used */
1033 u_int32_t tcps_early_rexmt
; /* Early retransmit used */
1034 u_int32_t tcps_sack_ackadv
; /* Cumulative ack advanced along with sack */
1036 /* Checksum related stats */
1037 u_int32_t tcps_rcv_swcsum
; /* tcp swcksum (inbound), packets */
1038 u_int32_t tcps_rcv_swcsum_bytes
; /* tcp swcksum (inbound), bytes */
1039 u_int32_t tcps_rcv6_swcsum
; /* tcp6 swcksum (inbound), packets */
1040 u_int32_t tcps_rcv6_swcsum_bytes
; /* tcp6 swcksum (inbound), bytes */
1041 u_int32_t tcps_snd_swcsum
; /* tcp swcksum (outbound), packets */
1042 u_int32_t tcps_snd_swcsum_bytes
; /* tcp swcksum (outbound), bytes */
1043 u_int32_t tcps_snd6_swcsum
; /* tcp6 swcksum (outbound), packets */
1044 u_int32_t tcps_snd6_swcsum_bytes
; /* tcp6 swcksum (outbound), bytes */
1045 u_int32_t tcps_unused_1
;
1046 u_int32_t tcps_unused_2
;
1047 u_int32_t tcps_unused_3
;
1049 /* MPTCP Related stats */
1050 u_int32_t tcps_invalid_mpcap
; /* Invalid MPTCP capable opts */
1051 u_int32_t tcps_invalid_joins
; /* Invalid MPTCP joins */
1052 u_int32_t tcps_mpcap_fallback
; /* TCP fallback in primary */
1053 u_int32_t tcps_join_fallback
; /* No MPTCP in secondary */
1054 u_int32_t tcps_estab_fallback
; /* DSS option dropped */
1055 u_int32_t tcps_invalid_opt
; /* Catchall error stat */
1056 u_int32_t tcps_mp_outofwin
; /* Packet lies outside the
1057 * shared recv window */
1058 u_int32_t tcps_mp_reducedwin
; /* Reduced subflow window */
1059 u_int32_t tcps_mp_badcsum
; /* Bad DSS csum */
1060 u_int32_t tcps_mp_oodata
; /* Out of order data */
1061 u_int32_t tcps_mp_switches
; /* number of subflow switch */
1062 u_int32_t tcps_mp_rcvtotal
; /* number of rcvd packets */
1063 u_int32_t tcps_mp_rcvbytes
; /* number of bytes received */
1064 u_int32_t tcps_mp_sndpacks
; /* number of data packs sent */
1065 u_int32_t tcps_mp_sndbytes
; /* number of bytes sent */
1066 u_int32_t tcps_join_rxmts
; /* join ack retransmits */
1067 u_int32_t tcps_tailloss_rto
; /* RTO due to tail loss */
1068 u_int32_t tcps_reordered_pkts
; /* packets reorderd */
1069 u_int32_t tcps_recovered_pkts
; /* recovered after loss */
1070 u_int32_t tcps_pto
; /* probe timeout */
1071 u_int32_t tcps_rto_after_pto
; /* RTO after a probe */
1072 u_int32_t tcps_tlp_recovery
; /* TLP induced fast recovery */
1073 u_int32_t tcps_tlp_recoverlastpkt
; /* TLP recoverd last pkt */
1074 u_int32_t tcps_ecn_client_success
; /* client-side connection negotiated ECN */
1075 u_int32_t tcps_ecn_recv_ece
; /* ECE received, sent CWR */
1076 u_int32_t tcps_ecn_sent_ece
; /* Sent ECE notification */
1077 u_int32_t tcps_detect_reordering
; /* Detect pkt reordering */
1078 u_int32_t tcps_delay_recovery
; /* Delay fast recovery */
1079 u_int32_t tcps_avoid_rxmt
; /* Retransmission was avoided */
1080 u_int32_t tcps_unnecessary_rxmt
; /* Retransmission was not needed */
1081 u_int32_t tcps_nostretchack
; /* disabled stretch ack algorithm on a connection */
1082 u_int32_t tcps_rescue_rxmt
; /* SACK rescue retransmit */
1083 u_int32_t tcps_pto_in_recovery
; /* rescue retransmit in fast recovery */
1084 u_int32_t tcps_pmtudbh_reverted
; /* PMTU Blackhole detection, segment size reverted */
1086 /* DSACK related statistics */
1087 u_int32_t tcps_dsack_disable
; /* DSACK disabled due to n/w duplication */
1088 u_int32_t tcps_dsack_ackloss
; /* ignore DSACK due to ack loss */
1089 u_int32_t tcps_dsack_badrexmt
; /* DSACK based bad rexmt recovery */
1090 u_int32_t tcps_dsack_sent
; /* Sent DSACK notification */
1091 u_int32_t tcps_dsack_recvd
; /* Received a valid DSACK option */
1092 u_int32_t tcps_dsack_recvd_old
; /* Received an out of window DSACK option */
1094 /* MPTCP Subflow selection stats */
1095 u_int32_t tcps_mp_sel_symtomsd
; /* By symptomsd */
1096 u_int32_t tcps_mp_sel_rtt
; /* By RTT comparison */
1097 u_int32_t tcps_mp_sel_rto
; /* By RTO comparison */
1098 u_int32_t tcps_mp_sel_peer
; /* By peer's output pattern */
1099 u_int32_t tcps_mp_num_probes
; /* Number of probes sent */
1100 u_int32_t tcps_mp_verdowngrade
; /* MPTCP version downgrade */
1101 u_int32_t tcps_drop_after_sleep
; /* drop after long AP sleep */
1102 u_int32_t tcps_probe_if
; /* probe packets after interface availability */
1103 u_int32_t tcps_probe_if_conflict
; /* Can't send probe packets for interface */
1105 u_int32_t tcps_ecn_client_setup
; /* Attempted ECN setup from client side */
1106 u_int32_t tcps_ecn_server_setup
; /* Attempted ECN setup from server side */
1107 u_int32_t tcps_ecn_server_success
; /* server-side connection negotiated ECN */
1108 u_int32_t tcps_ecn_lost_synack
; /* Lost SYN-ACK with ECN setup */
1109 u_int32_t tcps_ecn_lost_syn
; /* Lost SYN with ECN setup */
1110 u_int32_t tcps_ecn_not_supported
; /* Server did not support ECN setup */
1111 u_int32_t tcps_ecn_recv_ce
; /* Received CE from the network */
1112 u_int32_t tcps_ecn_conn_recv_ce
; /* Number of connections received CE atleast once */
1113 u_int32_t tcps_ecn_conn_recv_ece
; /* Number of connections received ECE atleast once */
1114 u_int32_t tcps_ecn_conn_plnoce
; /* Number of connections that received no CE and sufferred packet loss */
1115 u_int32_t tcps_ecn_conn_pl_ce
; /* Number of connections that received CE and sufferred packet loss */
1116 u_int32_t tcps_ecn_conn_nopl_ce
; /* Number of connections that received CE and sufferred no packet loss */
1117 u_int32_t tcps_ecn_fallback_synloss
; /* Number of times we did fall back due to SYN-Loss */
1118 u_int32_t tcps_ecn_fallback_reorder
; /* Number of times we fallback because we detected the PAWS-issue */
1119 u_int32_t tcps_ecn_fallback_ce
; /* Number of times we fallback because we received too many CEs */
1121 /* TFO-related statistics */
1122 u_int32_t tcps_tfo_syn_data_rcv
; /* Received a SYN+data with valid cookie */
1123 u_int32_t tcps_tfo_cookie_req_rcv
;/* Received a TFO cookie-request */
1124 u_int32_t tcps_tfo_cookie_sent
; /* Offered a TFO-cookie to the client */
1125 u_int32_t tcps_tfo_cookie_invalid
;/* Received an invalid TFO-cookie */
1126 u_int32_t tcps_tfo_cookie_req
; /* Cookie requested with the SYN */
1127 u_int32_t tcps_tfo_cookie_rcv
; /* Cookie received in a SYN/ACK */
1128 u_int32_t tcps_tfo_syn_data_sent
; /* SYN+data+cookie sent */
1129 u_int32_t tcps_tfo_syn_data_acked
;/* SYN+data has been acknowledged */
1130 u_int32_t tcps_tfo_syn_loss
; /* SYN+TFO has been lost and we fallback */
1131 u_int32_t tcps_tfo_blackhole
; /* TFO got blackholed by a middlebox. */
1132 u_int32_t tcps_tfo_cookie_wrong
; /* TFO-cookie we sent was wrong */
1133 u_int32_t tcps_tfo_no_cookie_rcv
; /* We asked for a cookie but didn't get one */
1134 u_int32_t tcps_tfo_heuristics_disable
; /* TFO got disabled due to heuristics */
1135 u_int32_t tcps_tfo_sndblackhole
; /* TFO got blackholed in the sending direction */
1136 u_int32_t tcps_mss_to_default
; /* Change MSS to default using link status report */
1137 u_int32_t tcps_mss_to_medium
; /* Change MSS to medium using link status report */
1138 u_int32_t tcps_mss_to_low
; /* Change MSS to low using link status report */
1139 u_int32_t tcps_ecn_fallback_droprst
; /* ECN fallback caused by connection drop due to RST */
1140 u_int32_t tcps_ecn_fallback_droprxmt
; /* ECN fallback due to drop after multiple retransmits */
1141 u_int32_t tcps_ecn_fallback_synrst
; /* ECN fallback due to rst after syn */
1143 u_int32_t tcps_mptcp_rcvmemdrop
; /* MPTCP packets dropped for lack of memory */
1144 u_int32_t tcps_mptcp_rcvduppack
; /* MPTCP duplicate-only packets received */
1145 u_int32_t tcps_mptcp_rcvpackafterwin
; /* MPTCP packets with data after window */
1147 /* TCP timer statistics */
1148 u_int32_t tcps_timer_drift_le_1_ms
; /* Timer drift less or equal to 1 ms */
1149 u_int32_t tcps_timer_drift_le_10_ms
; /* Timer drift less or equal to 10 ms */
1150 u_int32_t tcps_timer_drift_le_20_ms
; /* Timer drift less or equal to 20 ms */
1151 u_int32_t tcps_timer_drift_le_50_ms
; /* Timer drift less or equal to 50 ms */
1152 u_int32_t tcps_timer_drift_le_100_ms
; /* Timer drift less or equal to 100 ms */
1153 u_int32_t tcps_timer_drift_le_200_ms
; /* Timer drift less or equal to 200 ms */
1154 u_int32_t tcps_timer_drift_le_500_ms
; /* Timer drift less or equal to 500 ms */
1155 u_int32_t tcps_timer_drift_le_1000_ms
; /* Timer drift less or equal to 1000 ms */
1156 u_int32_t tcps_timer_drift_gt_1000_ms
; /* Timer drift greater than 1000 ms */
1158 u_int32_t tcps_mptcp_handover_attempt
; /* Total number of MPTCP-attempts using handover mode */
1159 u_int32_t tcps_mptcp_interactive_attempt
; /* Total number of MPTCP-attempts using interactive mode */
1160 u_int32_t tcps_mptcp_aggregate_attempt
; /* Total number of MPTCP-attempts using aggregate mode */
1161 u_int32_t tcps_mptcp_fp_handover_attempt
; /* Same as previous three but only for first-party apps */
1162 u_int32_t tcps_mptcp_fp_interactive_attempt
;
1163 u_int32_t tcps_mptcp_fp_aggregate_attempt
;
1164 u_int32_t tcps_mptcp_heuristic_fallback
; /* Total number of MPTCP-connections that fell back due to heuristics */
1165 u_int32_t tcps_mptcp_fp_heuristic_fallback
; /* Same as previous but for first-party apps */
1166 u_int32_t tcps_mptcp_handover_success_wifi
; /* Total number of successfull handover-mode connections that *started* on WiFi */
1167 u_int32_t tcps_mptcp_handover_success_cell
; /* Total number of successfull handover-mode connections that *started* on Cell */
1168 u_int32_t tcps_mptcp_interactive_success
; /* Total number of interactive-mode connections that negotiated MPTCP */
1169 u_int32_t tcps_mptcp_aggregate_success
; /* Same as previous but for aggregate */
1170 u_int32_t tcps_mptcp_fp_handover_success_wifi
; /* Same as previous four, but for first-party apps */
1171 u_int32_t tcps_mptcp_fp_handover_success_cell
;
1172 u_int32_t tcps_mptcp_fp_interactive_success
;
1173 u_int32_t tcps_mptcp_fp_aggregate_success
;
1174 u_int32_t tcps_mptcp_handover_cell_from_wifi
; /* Total number of connections that use cell in handover-mode (coming from WiFi) */
1175 u_int32_t tcps_mptcp_handover_wifi_from_cell
; /* Total number of connections that use WiFi in handover-mode (coming from cell) */
1176 u_int32_t tcps_mptcp_interactive_cell_from_wifi
; /* Total number of connections that use cell in interactive mode (coming from WiFi) */
1177 u_int64_t tcps_mptcp_handover_cell_bytes
; /* Total number of bytes sent on cell in handover-mode (on new subflows, ignoring initial one) */
1178 u_int64_t tcps_mptcp_interactive_cell_bytes
; /* Same as previous but for interactive */
1179 u_int64_t tcps_mptcp_aggregate_cell_bytes
;
1180 u_int64_t tcps_mptcp_handover_all_bytes
; /* Total number of bytes sent in handover */
1181 u_int64_t tcps_mptcp_interactive_all_bytes
;
1182 u_int64_t tcps_mptcp_aggregate_all_bytes
;
1183 u_int32_t tcps_mptcp_back_to_wifi
; /* Total number of connections that succeed to move traffic away from cell (when starting on cell) */
1184 u_int32_t tcps_mptcp_wifi_proxy
; /* Total number of new subflows that fell back to regular TCP on cell */
1185 u_int32_t tcps_mptcp_cell_proxy
; /* Total number of new subflows that fell back to regular TCP on WiFi */
1187 /* TCP offload statistics */
1188 u_int32_t tcps_ka_offload_drops
; /* Keep alive drops for timeout reported by firmware */
1190 u_int32_t tcps_mptcp_triggered_cell
; /* Total number of times an MPTCP-connection triggered cell bringup */
1194 struct tcpstat_local
{
1195 u_int64_t badformat
;
1198 u_int64_t badformatipsec
;
1199 u_int64_t noconnnolist
;
1200 u_int64_t noconnlist
;
1201 u_int64_t listbadsyn
;
1202 u_int64_t icmp6unreach
;
1203 u_int64_t deprecate6
;
1204 u_int64_t ooopacket
;
1205 u_int64_t rstinsynrcv
;
1206 u_int64_t dospacket
;
1208 u_int64_t synwindow
;
1214 * TCB structure exported to user-land via sysctl(3).
1215 * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
1216 * included. Not all of our clients do.
1221 #ifdef KERNEL_PRIVATE
1222 struct inpcb_compat xt_inp
;
1224 struct inpcb xt_inp
;
1226 #ifdef KERNEL_PRIVATE
1227 struct otcpcb xt_tp
;
1231 struct xsocket xt_socket
;
1232 u_quad_t xt_alignment_hack
;
1235 #if XNU_TARGET_OS_OSX || KERNEL || !(TARGET_OS_IPHONE && !TARGET_OS_SIMULATOR)
1239 struct xinpcb64 xt_inpcb
;
1242 int t_dupacks
; /* consecutive dup acks recd */
1244 int t_timer
[TCPT_NTIMERS_EXT
]; /* tcp timers */
1246 int t_state
; /* state of this connection */
1249 int t_force
; /* 1 if forcing out a byte */
1251 tcp_seq snd_una
; /* send unacknowledged */
1252 tcp_seq snd_max
; /* highest sequence number sent;
1253 * used to recognize retransmits
1255 tcp_seq snd_nxt
; /* send next */
1256 tcp_seq snd_up
; /* send urgent pointer */
1258 tcp_seq snd_wl1
; /* window update seg seq number */
1259 tcp_seq snd_wl2
; /* window update seg ack number */
1260 tcp_seq iss
; /* initial send sequence number */
1261 tcp_seq irs
; /* initial receive sequence number */
1263 tcp_seq rcv_nxt
; /* receive next */
1264 tcp_seq rcv_adv
; /* advertised window */
1265 u_int32_t rcv_wnd
; /* receive window */
1266 tcp_seq rcv_up
; /* receive urgent pointer */
1268 u_int32_t snd_wnd
; /* send window */
1269 u_int32_t snd_cwnd
; /* congestion-controlled window */
1270 u_int32_t snd_ssthresh
; /* snd_cwnd size threshold for
1271 * for slow start exponential to
1274 u_int t_maxopd
; /* mss plus options */
1276 u_int32_t t_rcvtime
; /* time at which a packet was received */
1277 u_int32_t t_starttime
; /* time connection was established */
1278 int t_rtttime
; /* round trip time */
1279 tcp_seq t_rtseq
; /* sequence number being timed */
1281 int t_rxtcur
; /* current retransmit value (ticks) */
1282 u_int t_maxseg
; /* maximum segment size */
1283 int t_srtt
; /* smoothed round-trip time */
1284 int t_rttvar
; /* variance in round-trip time */
1286 int t_rxtshift
; /* log(2) of rexmt exp. backoff */
1287 u_int t_rttmin
; /* minimum rtt allowed */
1288 u_int32_t t_rttupdated
; /* number of times rtt sampled */
1289 u_int32_t max_sndwnd
; /* largest window peer has offered */
1291 int t_softerror
; /* possible error not yet reported */
1292 /* out-of-band data */
1293 char t_oobflags
; /* have some */
1294 char t_iobc
; /* input character */
1295 /* RFC 1323 variables */
1296 u_char snd_scale
; /* window scaling for send window */
1297 u_char rcv_scale
; /* window scaling for recv window */
1298 u_char request_r_scale
; /* pending window scaling */
1299 u_char requested_s_scale
;
1300 u_int32_t ts_recent
; /* timestamp echo data */
1302 u_int32_t ts_recent_age
; /* when last updated */
1303 tcp_seq last_ack_sent
;
1304 /* RFC 1644 variables */
1305 tcp_cc cc_send
; /* send connection count */
1306 tcp_cc cc_recv
; /* receive connection count */
1307 tcp_seq snd_recover
; /* for use in fast recovery */
1309 u_int32_t snd_cwnd_prev
; /* cwnd prior to retransmit */
1310 u_int32_t snd_ssthresh_prev
; /* ssthresh prior to retransmit */
1311 u_int32_t t_badrxtwin
; /* window for retransmit recovery */
1313 u_quad_t xt_alignment_hack
;
1316 #endif /* XNU_TARGET_OS_OSX || KERNEL || !(TARGET_OS_IPHONE && !TARGET_OS_SIMULATOR) */
1322 u_int32_t xt_kind
; /* XSO_TCPCB */
1325 int t_dupacks
; /* consecutive dup acks recd */
1327 int t_timer
[TCPT_NTIMERS_EXT
]; /* tcp timers */
1329 int t_state
; /* state of this connection */
1332 int t_force
; /* 1 if forcing out a byte */
1334 tcp_seq snd_una
; /* send unacknowledged */
1335 tcp_seq snd_max
; /* highest sequence number sent;
1336 * used to recognize retransmits
1338 tcp_seq snd_nxt
; /* send next */
1339 tcp_seq snd_up
; /* send urgent pointer */
1341 tcp_seq snd_wl1
; /* window update seg seq number */
1342 tcp_seq snd_wl2
; /* window update seg ack number */
1343 tcp_seq iss
; /* initial send sequence number */
1344 tcp_seq irs
; /* initial receive sequence number */
1346 tcp_seq rcv_nxt
; /* receive next */
1347 tcp_seq rcv_adv
; /* advertised window */
1348 u_int32_t rcv_wnd
; /* receive window */
1349 tcp_seq rcv_up
; /* receive urgent pointer */
1351 u_int32_t snd_wnd
; /* send window */
1352 u_int32_t snd_cwnd
; /* congestion-controlled window */
1353 u_int32_t snd_ssthresh
; /* snd_cwnd size threshold for
1354 * for slow start exponential to
1357 u_int t_maxopd
; /* mss plus options */
1359 u_int32_t t_rcvtime
; /* time at which a packet was received */
1360 u_int32_t t_starttime
; /* time connection was established */
1361 int t_rtttime
; /* round trip time */
1362 tcp_seq t_rtseq
; /* sequence number being timed */
1364 int t_rxtcur
; /* current retransmit value (ticks) */
1365 u_int t_maxseg
; /* maximum segment size */
1366 int t_srtt
; /* smoothed round-trip time */
1367 int t_rttvar
; /* variance in round-trip time */
1369 int t_rxtshift
; /* log(2) of rexmt exp. backoff */
1370 u_int t_rttmin
; /* minimum rtt allowed */
1371 u_int32_t t_rttupdated
; /* number of times rtt sampled */
1372 u_int32_t max_sndwnd
; /* largest window peer has offered */
1374 int t_softerror
; /* possible error not yet reported */
1375 /* out-of-band data */
1376 char t_oobflags
; /* have some */
1377 char t_iobc
; /* input character */
1378 /* RFC 1323 variables */
1379 u_char snd_scale
; /* window scaling for send window */
1380 u_char rcv_scale
; /* window scaling for recv window */
1381 u_char request_r_scale
; /* pending window scaling */
1382 u_char requested_s_scale
;
1383 u_int32_t ts_recent
; /* timestamp echo data */
1385 u_int32_t ts_recent_age
; /* when last updated */
1386 tcp_seq last_ack_sent
;
1387 /* RFC 1644 variables */
1388 tcp_cc cc_send
; /* send connection count */
1389 tcp_cc cc_recv
; /* receive connection count */
1390 tcp_seq snd_recover
; /* for use in fast recovery */
1392 u_int32_t snd_cwnd_prev
; /* cwnd prior to retransmit */
1393 u_int32_t snd_ssthresh_prev
; /* ssthresh prior to retransmit */
1397 * The rtt measured is in milliseconds as the timestamp granularity is
1398 * a millisecond. The smoothed round-trip time and estimated variance
1399 * are stored as fixed point numbers scaled by the values below.
1400 * For convenience, these scales are also used in smoothing the average
1401 * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
1402 * With these scales, srtt has 5 bits to the right of the binary point,
1403 * and thus an "ALPHA" of 0.875. rttvar has 4 bits to the right of the
1404 * binary point, and is smoothed with an ALPHA of 0.75.
1406 #define TCP_RTT_SCALE 32 /* multiplier for srtt; 3 bits frac. */
1407 #define TCP_RTT_SHIFT 5 /* shift for srtt; 5 bits frac. */
1408 #define TCP_RTTVAR_SCALE 16 /* multiplier for rttvar; 4 bits */
1409 #define TCP_RTTVAR_SHIFT 4 /* shift for rttvar; 4 bits */
1410 #define TCP_DELTA_SHIFT 2 /* see tcp_input.c */
1414 * TCP structure with information that gives insight into forward progress on an interface,
1415 * exported to user-land via sysctl(3).
1417 struct xtcpprogress_indicators
{
1418 u_int32_t xp_numflows
; /* Total number of flows */
1419 u_int32_t xp_conn_probe_fails
; /* Count of connection failures */
1420 u_int32_t xp_read_probe_fails
; /* Count of read probe failures */
1421 u_int32_t xp_write_probe_fails
; /* Count of write failures */
1422 u_int32_t xp_recentflows
; /* Total of "recent" flows */
1423 u_int32_t xp_recentflows_unacked
; /* Total of "recent" flows with unacknowledged data */
1424 u_int64_t xp_recentflows_rxbytes
; /* Total of "recent" flows received bytes */
1425 u_int64_t xp_recentflows_txbytes
; /* Total of "recent" flows transmitted bytes */
1426 u_int64_t xp_recentflows_rxooo
; /* Total of "recent" flows received out of order bytes */
1427 u_int64_t xp_recentflows_rxdup
; /* Total of "recent" flows received duplicate bytes */
1428 u_int64_t xp_recentflows_retx
; /* Total of "recent" flows retransmitted bytes */
1429 u_int64_t xp_reserved1
; /* Expansion */
1430 u_int64_t xp_reserved2
; /* Expansion */
1431 u_int64_t xp_reserved3
; /* Expansion */
1432 u_int64_t xp_reserved4
; /* Expansion */
1435 struct tcpprogressreq
{
1436 u_int64_t ifindex
; /* Interface index for progress indicators */
1437 u_int64_t recentflow_maxduration
; /* In mach_absolute_time, max duration for flow to be counted as "recent" */
1438 u_int64_t filter_flags
; /* Optional additional filtering, values are interface properties per ntstat.h */
1439 u_int64_t xp_reserved2
; /* Expansion */
1442 #endif /* PRIVATE */
1447 * Names for TCP sysctl objects
1449 #define TCPCTL_DO_RFC1323 1 /* use RFC-1323 extensions */
1450 #define TCPCTL_DO_RFC1644 2 /* use RFC-1644 extensions */
1451 #define TCPCTL_MSSDFLT 3 /* MSS default */
1452 #define TCPCTL_STATS 4 /* statistics (read-only) */
1453 #define TCPCTL_RTTDFLT 5 /* default RTT estimate */
1454 #define TCPCTL_KEEPIDLE 6 /* keepalive idle timer */
1455 #define TCPCTL_KEEPINTVL 7 /* interval to send keepalives */
1456 #define TCPCTL_SENDSPACE 8 /* send buffer space */
1457 #define TCPCTL_RECVSPACE 9 /* receive buffer space */
1458 #define TCPCTL_KEEPINIT 10 /* timeout for establishing syn */
1459 #define TCPCTL_PCBLIST 11 /* list of all outstanding PCBs */
1460 #define TCPCTL_DELACKTIME 12 /* time before sending delayed ACK */
1461 #define TCPCTL_V6MSSDFLT 13 /* MSS default for IPv6 */
1462 #define TCPCTL_MAXID 14
1464 #ifdef BSD_KERNEL_PRIVATE
1465 #include <sys/bitstring.h>
1467 #define TCP_PKTLIST_CLEAR(tp) { \
1468 (tp)->t_pktlist_head = (tp)->t_pktlist_tail = NULL; \
1469 (tp)->t_lastchain = (tp)->t_pktlist_sentlen = 0; \
1472 extern int tcp_TCPTV_MIN
;
1475 SYSCTL_DECL(_net_inet_tcp
);
1476 #endif /* SYSCTL_DECL */
1478 extern struct inpcbhead tcb
; /* head of queue of active tcpcb's */
1479 extern struct inpcbinfo tcbinfo
;
1480 extern struct tcpstat tcpstat
; /* tcp statistics */
1481 extern int tcp_mssdflt
; /* XXX */
1482 extern int tcp_minmss
;
1483 #define TCP_FASTOPEN_SERVER 0x01
1484 #define TCP_FASTOPEN_CLIENT 0x02
1486 extern int tcp_tfo_halfcnt
;
1487 extern int tcp_tfo_backlog
;
1488 extern int tcp_fastopen
;
1489 extern int ss_fltsz_local
;
1490 extern int target_qdelay
;
1491 extern u_int32_t tcp_now
; /* for RFC 1323 timestamps */
1492 extern struct timeval tcp_uptime
;
1493 extern lck_spin_t
*tcp_uptime_lock
;
1494 extern int tcp_delack_enabled
;
1495 extern int maxseg_unacked
;
1496 extern int tcp_use_newreno
;
1497 extern struct zone
*tcp_reass_zone
;
1498 extern struct zone
*tcp_rxt_seg_zone
;
1499 extern int tcp_ecn_outbound
;
1500 extern int tcp_ecn_inbound
;
1501 extern uint32_t tcp_do_autorcvbuf
;
1502 extern uint32_t tcp_autorcvbuf_max
;
1503 extern int tcp_recv_bg
;
1504 extern int tcp_do_ack_compression
;
1505 extern int tcp_randomize_timestamps
;
1507 * Dummy value used for when there is no flow and we want to ensure that compression
1510 #define TCP_ACK_COMPRESSION_DUMMY 1
1512 extern int tcp_do_better_lr
;
1513 extern int tcp_cubic_minor_fixes
;
1514 extern int tcp_cubic_rfc_compliant
;
1515 extern int tcp_flow_control_response
;
1520 struct tcp_respond_args
{
1521 unsigned int ifscope
;
1522 unsigned int nocell
:1,
1524 awdl_unrestricted
:1,
1525 intcoproc_allowed
:1,
1530 void tcp_canceltimers(struct tcpcb
*);
1532 tcp_close(struct tcpcb
*);
1533 void tcp_ctlinput(int, struct sockaddr
*, void *, struct ifnet
*);
1534 int tcp_ctloutput(struct socket
*, struct sockopt
*);
1536 tcp_drop(struct tcpcb
*, int);
1537 void tcp_drain(void);
1538 void tcp_getrt_rtt(struct tcpcb
*tp
, struct rtentry
*rt
);
1539 void tcp_init(struct protosw
*, struct domain
*);
1540 void tcp_input(struct mbuf
*, int);
1541 void tcp_mss(struct tcpcb
*, int, unsigned int);
1542 int tcp_mssopt(struct tcpcb
*);
1543 void tcp_drop_syn_sent(struct inpcb
*, int);
1544 void tcp_mtudisc(struct inpcb
*, int);
1546 tcp_newtcpcb(struct inpcb
*);
1547 int tcp_output(struct tcpcb
*);
1548 void tcp_respond(struct tcpcb
*, void *, struct tcphdr
*, struct mbuf
*,
1549 tcp_seq
, tcp_seq
, uint8_t, struct tcp_respond_args
*);
1551 tcp_rtlookup(struct inpcb
*, unsigned int);
1552 void tcp_setpersist(struct tcpcb
*);
1553 void tcp_gc(struct inpcbinfo
*);
1554 void tcp_itimer(struct inpcbinfo
*ipi
);
1555 void tcp_check_timer_state(struct tcpcb
*tp
);
1556 void tcp_run_timerlist(void *arg1
, void *arg2
);
1557 void tcp_sched_timers(struct tcpcb
*tp
);
1559 struct tcptemp
*tcp_maketemplate(struct tcpcb
*);
1560 void tcp_fillheaders(struct tcpcb
*, void *, void *);
1561 struct tcpcb
*tcp_timers(struct tcpcb
*, int);
1562 void tcp_trace(int, int, struct tcpcb
*, void *, struct tcphdr
*, int);
1564 void tcp_fill_info(struct tcpcb
*, struct tcp_info
*);
1565 void tcp_sack_doack(struct tcpcb
*, struct tcpopt
*, struct tcphdr
*,
1566 u_int32_t
*, uint32_t *);
1567 extern boolean_t
tcp_sack_process_dsack(struct tcpcb
*, struct tcpopt
*,
1569 int tcp_detect_bad_rexmt(struct tcpcb
*, struct tcphdr
*, struct tcpopt
*,
1571 void tcp_update_sack_list(struct tcpcb
*tp
, tcp_seq rcv_laststart
, tcp_seq rcv_lastend
);
1572 void tcp_clean_sackreport(struct tcpcb
*tp
);
1573 void tcp_sack_adjust(struct tcpcb
*tp
);
1574 struct sackhole
*tcp_sack_output(struct tcpcb
*tp
, int *sack_bytes_rexmt
);
1575 void tcp_sack_partialack(struct tcpcb
*, struct tcphdr
*);
1576 void tcp_free_sackholes(struct tcpcb
*tp
);
1577 void tcp_sack_lost_rexmit(struct tcpcb
*tp
);
1578 int32_t tcp_sbspace(struct tcpcb
*tp
);
1579 void tcp_set_tso(struct tcpcb
*tp
, struct ifnet
*ifp
);
1580 void tcp_set_ecn(struct tcpcb
*tp
, struct ifnet
*ifp
);
1581 int tcp_flight_size(struct tcpcb
*tp
);
1582 void tcp_reset_stretch_ack(struct tcpcb
*tp
);
1583 extern void tcp_get_ports_used(u_int32_t
, int, u_int32_t
, bitstr_t
*);
1584 uint32_t tcp_count_opportunistic(unsigned int ifindex
, u_int32_t flags
);
1585 uint32_t tcp_find_anypcb_byaddr(struct ifaddr
*ifa
);
1586 void tcp_set_max_rwinscale(struct tcpcb
*tp
, struct socket
*so
);
1587 struct bwmeas
* tcp_bwmeas_alloc(struct tcpcb
*tp
);
1588 void tcp_bwmeas_free(struct tcpcb
*tp
);
1589 extern int32_t timer_diff(uint32_t t1
, uint32_t toff1
, uint32_t t2
, uint32_t toff2
);
1591 extern void tcp_set_background_cc(struct socket
*);
1592 extern void tcp_set_foreground_cc(struct socket
*);
1593 extern void tcp_set_recv_bg(struct socket
*);
1594 extern void tcp_clear_recv_bg(struct socket
*);
1595 extern boolean_t
tcp_sack_byte_islost(struct tcpcb
*tp
);
1596 #define IS_TCP_RECV_BG(_so) \
1597 ((_so)->so_flags1 & SOF1_TRAFFIC_MGT_TCP_RECVBG)
1600 #define CLEAR_IAJ_STATE(_tp_) (_tp_)->iaj_rcv_ts = 0
1601 void reset_acc_iaj(struct tcpcb
*tp
);
1602 #endif /* TRAFFIC_MGT */
1604 int tcp_lock(struct socket
*, int, void *);
1605 int tcp_unlock(struct socket
*, int, void *);
1606 void calculate_tcp_clock(void);
1608 extern void tcp_keepalive_reset(struct tcpcb
*);
1609 extern uint32_t get_base_rtt(struct tcpcb
*tp
);
1611 #ifdef _KERN_LOCKS_H_
1612 lck_mtx_t
* tcp_getlock(struct socket
*, int);
1614 void * tcp_getlock(struct socket
*, int);
1617 extern struct pr_usrreqs tcp_usrreqs
;
1618 extern u_int32_t tcp_sendspace
;
1619 extern u_int32_t tcp_recvspace
;
1620 tcp_seq
tcp_new_isn(struct tcpcb
*);
1622 extern int tcp_input_checksum(int, struct mbuf
*, struct tcphdr
*, int, int);
1623 extern void tcp_getconninfo(struct socket
*, struct conninfo_tcp
*);
1624 extern void add_to_time_wait(struct tcpcb
*, uint32_t delay
);
1625 extern void tcp_pmtud_revert_segment_size(struct tcpcb
*tp
);
1626 extern void tcp_rxtseg_insert(struct tcpcb
*, tcp_seq
, tcp_seq
);
1627 extern struct tcp_rxt_seg
*tcp_rxtseg_find(struct tcpcb
*, tcp_seq
, tcp_seq
);
1628 extern void tcp_rxtseg_set_spurious(struct tcpcb
*tp
, tcp_seq start
, tcp_seq end
);
1629 extern void tcp_rxtseg_clean(struct tcpcb
*);
1630 extern boolean_t
tcp_rxtseg_detect_bad_rexmt(struct tcpcb
*, tcp_seq
);
1631 extern boolean_t
tcp_rxtseg_dsack_for_tlp(struct tcpcb
*);
1632 extern u_int32_t
tcp_rxtseg_total_size(struct tcpcb
*tp
);
1633 extern void tcp_rexmt_save_state(struct tcpcb
*tp
);
1634 extern void tcp_interface_send_probe(u_int16_t if_index_available
);
1635 extern void tcp_probe_connectivity(struct ifnet
*ifp
, u_int32_t enable
);
1636 extern void tcp_get_connectivity_status(struct tcpcb
*,
1637 struct tcp_conn_status
*);
1639 extern void tcp_clear_keep_alive_offload(struct socket
*so
);
1640 extern void tcp_fill_keepalive_offload_frames(struct ifnet
*,
1641 struct ifnet_keepalive_offload_frame
*, u_int32_t
, size_t, u_int32_t
*);
1642 extern int tcp_notify_kao_timeout(ifnet_t ifp
,
1643 struct ifnet_keepalive_offload_frame
*frame
);
1645 extern boolean_t
tfo_enabled(const struct tcpcb
*tp
);
1646 extern void tcp_disable_tfo(struct tcpcb
*tp
);
1647 extern void tcp_tfo_gen_cookie(struct inpcb
*inp
, u_char
*out
, size_t blk_size
);
1648 #define TCP_FASTOPEN_KEYLEN 16
1649 extern int tcp_freeq(struct tcpcb
*tp
);
1650 extern errno_t
tcp_notify_ack_id_valid(struct tcpcb
*, struct socket
*, u_int32_t
);
1651 extern errno_t
tcp_add_notify_ack_marker(struct tcpcb
*, u_int32_t
);
1652 extern void tcp_notify_ack_free(struct tcpcb
*);
1653 extern void tcp_notify_acknowledgement(struct tcpcb
*, struct socket
*);
1654 extern void tcp_get_notify_ack_count(struct tcpcb
*,
1655 struct tcp_notify_ack_complete
*);
1656 extern void tcp_get_notify_ack_ids(struct tcpcb
*tp
,
1657 struct tcp_notify_ack_complete
*);
1658 extern void tcp_update_mss_locked(struct socket
*, struct ifnet
*);
1660 extern int get_tcp_inp_list(struct inpcb
**, int, inp_gen_t
);
1661 extern bool tcp_notify_ack_active(struct socket
*so
);
1664 extern int mptcp_input_preproc(struct tcpcb
*tp
, struct mbuf
*m
,
1665 struct tcphdr
*th
, int drop_hdrlen
);
1666 extern uint16_t mptcp_output_csum(struct mbuf
*m
, uint64_t dss_val
,
1667 uint32_t sseq
, uint16_t dlen
);
1668 extern int mptcp_adj_mss(struct tcpcb
*, boolean_t
);
1669 extern void mptcp_insert_rmap(struct tcpcb
*tp
, struct mbuf
*m
, struct tcphdr
*th
);
1672 __private_extern__
void tcp_update_stats_per_flow(
1673 struct ifnet_stats_per_flow
*, struct ifnet
*);
1675 #define TCP_ACK_STRATEGY_LEGACY 0
1676 #define TCP_ACK_STRATEGY_MODERN 1
1678 extern int tcp_ack_strategy
;
1680 #define tcp_add_fsw_flow(...)
1681 #define tcp_del_fsw_flow(...)
1683 #endif /* BSD_KERNEL_PRIVATE */
1685 #endif /* _NETINET_TCP_VAR_H_ */