1c398230bSWarner Losh /*- 251369649SPedro F. Giffuni * SPDX-License-Identifier: BSD-3-Clause 351369649SPedro F. Giffuni * 4df8bae1dSRodney W. Grimes * Copyright (c) 1982, 1986, 1993 5df8bae1dSRodney W. Grimes * The Regents of the University of California. All rights reserved. 6df8bae1dSRodney W. Grimes * 7df8bae1dSRodney W. Grimes * Redistribution and use in source and binary forms, with or without 8df8bae1dSRodney W. Grimes * modification, are permitted provided that the following conditions 9df8bae1dSRodney W. Grimes * are met: 10df8bae1dSRodney W. Grimes * 1. Redistributions of source code must retain the above copyright 11df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer. 12df8bae1dSRodney W. Grimes * 2. Redistributions in binary form must reproduce the above copyright 13df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer in the 14df8bae1dSRodney W. Grimes * documentation and/or other materials provided with the distribution. 15fbbd9655SWarner Losh * 3. Neither the name of the University nor the names of its contributors 16df8bae1dSRodney W. Grimes * may be used to endorse or promote products derived from this software 17df8bae1dSRodney W. Grimes * without specific prior written permission. 18df8bae1dSRodney W. Grimes * 19df8bae1dSRodney W. Grimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20df8bae1dSRodney W. Grimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21df8bae1dSRodney W. Grimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22df8bae1dSRodney W. Grimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23df8bae1dSRodney W. Grimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24df8bae1dSRodney W. Grimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25df8bae1dSRodney W. Grimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26df8bae1dSRodney W. Grimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27df8bae1dSRodney W. Grimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28df8bae1dSRodney W. Grimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29df8bae1dSRodney W. Grimes * SUCH DAMAGE. 30df8bae1dSRodney W. Grimes * 31df8bae1dSRodney W. Grimes * @(#)tcp.h 8.1 (Berkeley) 6/10/93 32c3aac50fSPeter Wemm * $FreeBSD$ 33df8bae1dSRodney W. Grimes */ 34df8bae1dSRodney W. Grimes 35707f139eSPaul Richards #ifndef _NETINET_TCP_H_ 36707f139eSPaul Richards #define _NETINET_TCP_H_ 37707f139eSPaul Richards 38c0ec31f9SMike Barcroft #include <sys/cdefs.h> 39cf05e311SEd Schouten #include <sys/types.h> 40c0ec31f9SMike Barcroft 410cd4a903SMike Barcroft #if __BSD_VISIBLE 420cd4a903SMike Barcroft 4307a4df4fSBruce Evans typedef u_int32_t tcp_seq; 44eb6ad696SGarrett Wollman 45fb59c426SYoshinobu Inoue #define tcp6_seq tcp_seq /* for KAME src sync over BSD*'s */ 46fb59c426SYoshinobu Inoue #define tcp6hdr tcphdr /* for KAME src sync over BSD*'s */ 47fb59c426SYoshinobu Inoue 48df8bae1dSRodney W. Grimes /* 49df8bae1dSRodney W. Grimes * TCP header. 50df8bae1dSRodney W. Grimes * Per RFC 793, September, 1981. 51df8bae1dSRodney W. Grimes */ 52df8bae1dSRodney W. Grimes struct tcphdr { 53df8bae1dSRodney W. Grimes u_short th_sport; /* source port */ 54df8bae1dSRodney W. Grimes u_short th_dport; /* destination port */ 55df8bae1dSRodney W. Grimes tcp_seq th_seq; /* sequence number */ 56df8bae1dSRodney W. Grimes tcp_seq th_ack; /* acknowledgement number */ 57df8bae1dSRodney W. Grimes #if BYTE_ORDER == LITTLE_ENDIAN 5893e28d6eSRichard Scheffenegger u_char th_x2:4, /* upper 4 (reserved) flags */ 59df8bae1dSRodney W. Grimes th_off:4; /* data offset */ 60df8bae1dSRodney W. Grimes #endif 61df8bae1dSRodney W. Grimes #if BYTE_ORDER == BIG_ENDIAN 62dc5fd259SLuigi Rizzo u_char th_off:4, /* data offset */ 6393e28d6eSRichard Scheffenegger th_x2:4; /* upper 4 (reserved) flags */ 64df8bae1dSRodney W. Grimes #endif 65df8bae1dSRodney W. Grimes u_char th_flags; 66df8bae1dSRodney W. Grimes #define TH_FIN 0x01 67df8bae1dSRodney W. Grimes #define TH_SYN 0x02 68df8bae1dSRodney W. Grimes #define TH_RST 0x04 69df8bae1dSRodney W. Grimes #define TH_PUSH 0x08 70df8bae1dSRodney W. Grimes #define TH_ACK 0x10 71df8bae1dSRodney W. Grimes #define TH_URG 0x20 7265450f2fSRobert Watson #define TH_ECE 0x40 7365450f2fSRobert Watson #define TH_CWR 0x80 74493c98c6SMichael Tuexen #define TH_AE 0x100 /* maps into th_x2 */ 75da3482e0SAndre Oppermann #define TH_FLAGS (TH_FIN|TH_SYN|TH_RST|TH_PUSH|TH_ACK|TH_URG|TH_ECE|TH_CWR) 76493c98c6SMichael Tuexen #define PRINT_TH_FLAGS "\20\1FIN\2SYN\3RST\4PUSH\5ACK\6URG\7ECE\10CWR\11AE" 772f96f1f4SGarrett Wollman 78df8bae1dSRodney W. Grimes u_short th_win; /* window */ 79df8bae1dSRodney W. Grimes u_short th_sum; /* checksum */ 80df8bae1dSRodney W. Grimes u_short th_urp; /* urgent pointer */ 81df8bae1dSRodney W. Grimes }; 82df8bae1dSRodney W. Grimes 83e3995661SRichard Scheffenegger #define PADTCPOLEN(len) ((((len) / 4) + !!((len) % 4)) * 4) 84e3995661SRichard Scheffenegger 85df8bae1dSRodney W. Grimes #define TCPOPT_EOL 0 8602a1a643SAndre Oppermann #define TCPOLEN_EOL 1 87c343c524SAndre Oppermann #define TCPOPT_PAD 0 /* padding after EOL */ 88c343c524SAndre Oppermann #define TCPOLEN_PAD 1 89df8bae1dSRodney W. Grimes #define TCPOPT_NOP 1 9002a1a643SAndre Oppermann #define TCPOLEN_NOP 1 91df8bae1dSRodney W. Grimes #define TCPOPT_MAXSEG 2 92df8bae1dSRodney W. Grimes #define TCPOLEN_MAXSEG 4 93df8bae1dSRodney W. Grimes #define TCPOPT_WINDOW 3 94df8bae1dSRodney W. Grimes #define TCPOLEN_WINDOW 3 9502a1a643SAndre Oppermann #define TCPOPT_SACK_PERMITTED 4 96df8bae1dSRodney W. Grimes #define TCPOLEN_SACK_PERMITTED 2 9702a1a643SAndre Oppermann #define TCPOPT_SACK 5 9802a1a643SAndre Oppermann #define TCPOLEN_SACKHDR 2 996d90faf3SPaul Saab #define TCPOLEN_SACK 8 /* 2*sizeof(tcp_seq) */ 100df8bae1dSRodney W. Grimes #define TCPOPT_TIMESTAMP 8 101df8bae1dSRodney W. Grimes #define TCPOLEN_TIMESTAMP 10 102df8bae1dSRodney W. Grimes #define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */ 1031cfd4b53SBruce M Simpson #define TCPOPT_SIGNATURE 19 /* Keyed MD5: RFC 2385 */ 1041cfd4b53SBruce M Simpson #define TCPOLEN_SIGNATURE 18 105281a0fd4SPatrick Kelsey #define TCPOPT_FAST_OPEN 34 106281a0fd4SPatrick Kelsey #define TCPOLEN_FAST_OPEN_EMPTY 2 107eb6ad696SGarrett Wollman 1088e1864edSKristof Provost #define MAX_TCPOPTLEN 40 /* Absolute maximum TCP options len */ 1098e1864edSKristof Provost 1106d90faf3SPaul Saab /* Miscellaneous constants */ 111b24de0e6SPaul Saab #define MAX_SACK_BLKS 6 /* Max # SACK blocks stored at receiver side */ 11264b5fbaaSPaul Saab #define TCP_MAX_SACK 4 /* MAX # SACKs sent in any segment */ 1136d90faf3SPaul Saab 114df8bae1dSRodney W. Grimes /* 115c183b9c6SAndre Oppermann * The default maximum segment size (MSS) to be used for new TCP connections 116c183b9c6SAndre Oppermann * when path MTU discovery is not enabled. 117c183b9c6SAndre Oppermann * 118c183b9c6SAndre Oppermann * RFC879 derives the default MSS from the largest datagram size hosts are 119c183b9c6SAndre Oppermann * minimally required to handle directly or through IP reassembly minus the 120c183b9c6SAndre Oppermann * size of the IP and TCP header. With IPv6 the minimum MTU is specified 121c183b9c6SAndre Oppermann * in RFC2460. 122c183b9c6SAndre Oppermann * 123c183b9c6SAndre Oppermann * For IPv4 the MSS is 576 - sizeof(struct tcpiphdr) 124c183b9c6SAndre Oppermann * For IPv6 the MSS is IPV6_MMTU - sizeof(struct ip6_hdr) - sizeof(struct tcphdr) 125c183b9c6SAndre Oppermann * 126c183b9c6SAndre Oppermann * We use explicit numerical definition here to avoid header pollution. 127df8bae1dSRodney W. Grimes */ 128c183b9c6SAndre Oppermann #define TCP_MSS 536 129c183b9c6SAndre Oppermann #define TCP6_MSS 1220 130df8bae1dSRodney W. Grimes 13176429de4SYoshinobu Inoue /* 1322c9879e8SAndre Oppermann * Limit the lowest MSS we accept for path MTU discovery and the TCP SYN MSS 1332c9879e8SAndre Oppermann * option. Allowing low values of MSS can consume significant resources and 1342c9879e8SAndre Oppermann * be used to mount a resource exhaustion attack. 135c183b9c6SAndre Oppermann * Connections requesting lower MSS values will be rounded up to this value 1362c9879e8SAndre Oppermann * and the IP_DF flag will be cleared to allow fragmentation along the path. 137c183b9c6SAndre Oppermann * 138c183b9c6SAndre Oppermann * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments. Setting 139c183b9c6SAndre Oppermann * it to "0" disables the minmss check. 140c183b9c6SAndre Oppermann * 1412c9879e8SAndre Oppermann * The default value is fine for TCP across the Internet's smallest official 1422c9879e8SAndre Oppermann * link MTU (256 bytes for AX.25 packet radio). However, a connection is very 1432c9879e8SAndre Oppermann * unlikely to come across such low MTU interfaces these days (anno domini 2003). 14476429de4SYoshinobu Inoue */ 145c183b9c6SAndre Oppermann #define TCP_MINMSS 216 14676429de4SYoshinobu Inoue 147df8bae1dSRodney W. Grimes #define TCP_MAXWIN 65535 /* largest value for (unscaled) window */ 148eb6ad696SGarrett Wollman #define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */ 149df8bae1dSRodney W. Grimes 150df8bae1dSRodney W. Grimes #define TCP_MAX_WINSHIFT 14 /* maximum window shift */ 151df8bae1dSRodney W. Grimes 15246f58482SJonathan Lemon #define TCP_MAXBURST 4 /* maximum segments in a burst */ 15346f58482SJonathan Lemon 154eb6ad696SGarrett Wollman #define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */ 155eb6ad696SGarrett Wollman #define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr)) 156eb6ad696SGarrett Wollman /* max space left for options */ 157c560df6fSPatrick Kelsey 158c560df6fSPatrick Kelsey #define TCP_FASTOPEN_MIN_COOKIE_LEN 4 /* Per RFC7413 */ 159c560df6fSPatrick Kelsey #define TCP_FASTOPEN_MAX_COOKIE_LEN 16 /* Per RFC7413 */ 160c560df6fSPatrick Kelsey #define TCP_FASTOPEN_PSK_LEN 16 /* Same as TCP_FASTOPEN_KEY_LEN */ 1610cd4a903SMike Barcroft #endif /* __BSD_VISIBLE */ 162eb6ad696SGarrett Wollman 163df8bae1dSRodney W. Grimes /* 1641d77fa5aSJohn Baldwin * User-settable options (used with setsockopt). These are discrete 1651d77fa5aSJohn Baldwin * values and are not masked together. Some values appear to be 1661d77fa5aSJohn Baldwin * bitmasks for historical reasons. 167df8bae1dSRodney W. Grimes */ 1681d77fa5aSJohn Baldwin #define TCP_NODELAY 1 /* don't delay send to coalesce packets */ 1690cd4a903SMike Barcroft #if __BSD_VISIBLE 1701d77fa5aSJohn Baldwin #define TCP_MAXSEG 2 /* set maximum segment size */ 1711d77fa5aSJohn Baldwin #define TCP_NOPUSH 4 /* don't push last block of write */ 1721d77fa5aSJohn Baldwin #define TCP_NOOPT 8 /* don't use TCP options */ 1731d77fa5aSJohn Baldwin #define TCP_MD5SIG 16 /* use MD5 digests (RFC2385) */ 1741d77fa5aSJohn Baldwin #define TCP_INFO 32 /* retrieve tcp_info structure */ 175adc56f5aSEdward Tomasz Napierala #define TCP_STATS 33 /* retrieve stats blob structure */ 1762529f56eSJonathan T. Looney #define TCP_LOG 34 /* configure event logging for connection */ 1772529f56eSJonathan T. Looney #define TCP_LOGBUF 35 /* retrieve event log for connection */ 1782529f56eSJonathan T. Looney #define TCP_LOGID 36 /* configure log ID to correlate connections */ 1792529f56eSJonathan T. Looney #define TCP_LOGDUMP 37 /* dump connection log events to device */ 1802529f56eSJonathan T. Looney #define TCP_LOGDUMPID 38 /* dump events from connections with same ID to 1812529f56eSJonathan T. Looney device */ 182b2e60773SJohn Baldwin #define TCP_TXTLS_ENABLE 39 /* TLS framing and encryption for transmit */ 183b2e60773SJohn Baldwin #define TCP_TXTLS_MODE 40 /* Transmit TLS mode */ 184f1f93475SJohn Baldwin #define TCP_RXTLS_ENABLE 41 /* TLS framing and encryption for receive */ 185f1f93475SJohn Baldwin #define TCP_RXTLS_MODE 42 /* Receive TLS mode */ 1865d8fd932SRandall Stewart #define TCP_IWND_NB 43 /* Override initial window (units: bytes) */ 1875d8fd932SRandall Stewart #define TCP_IWND_NSEG 44 /* Override initial window (units: MSS segs) */ 1885d8fd932SRandall Stewart #define TCP_LOGID_CNT 46 /* get number of connections with the same ID */ 1895d8fd932SRandall Stewart #define TCP_LOG_TAG 47 /* configure tag for grouping logs */ 1905d8fd932SRandall Stewart #define TCP_USER_LOG 48 /* userspace log event */ 1911d77fa5aSJohn Baldwin #define TCP_CONGESTION 64 /* get/set congestion control algorithm */ 192d519cedbSGleb Smirnoff #define TCP_CCALGOOPT 65 /* get/set cc algorithm specific options */ 1935d8fd932SRandall Stewart #define TCP_MAXUNACKTIME 68 /* maximum time without making progress (sec) */ 1945d8fd932SRandall Stewart #define TCP_MAXPEAKRATE 69 /* maximum peak rate allowed (kbps) */ 1955d8fd932SRandall Stewart #define TCP_IDLE_REDUCE 70 /* Reduce cwnd on idle input */ 1969e644c23SMichael Tuexen #define TCP_REMOTE_UDP_ENCAPS_PORT 71 /* Enable TCP over UDP tunneling via the specified port */ 19789e560f4SRandall Stewart #define TCP_DELACK 72 /* socket option for delayed ack */ 198e570d231SRandall Stewart #define TCP_FIN_IS_RST 73 /* A fin from the peer is treated has a RST */ 199e570d231SRandall Stewart #define TCP_LOG_LIMIT 74 /* Limit to number of records in tcp-log */ 200e570d231SRandall Stewart #define TCP_SHARED_CWND_ALLOWED 75 /* Use of a shared cwnd is allowed */ 2015d8fd932SRandall Stewart #define TCP_PROC_ACCOUNTING 76 /* Do accounting on tcp cpu usage and counts */ 2025d8fd932SRandall Stewart #define TCP_USE_CMP_ACKS 77 /* The transport can handle the Compressed mbuf acks */ 2035d8fd932SRandall Stewart #define TCP_PERF_INFO 78 /* retrieve accounting counters */ 2040471a8c7SRichard Scheffenegger #define TCP_LRD 79 /* toggle Lost Retransmission Detection for A/B testing */ 2051d77fa5aSJohn Baldwin #define TCP_KEEPINIT 128 /* N, time to establish connection */ 2061d77fa5aSJohn Baldwin #define TCP_KEEPIDLE 256 /* L,N,X start keeplives after this period */ 2071d77fa5aSJohn Baldwin #define TCP_KEEPINTVL 512 /* L,N interval between keepalives */ 2081d77fa5aSJohn Baldwin #define TCP_KEEPCNT 1024 /* L,N number of keepalives before close */ 209281a0fd4SPatrick Kelsey #define TCP_FASTOPEN 1025 /* enable TFO / was created via TFO */ 21086a996e6SHiren Panchasara #define TCP_PCAP_OUT 2048 /* number of output packets to keep */ 21186a996e6SHiren Panchasara #define TCP_PCAP_IN 4096 /* number of input packets to keep */ 21255bceb1eSRandall Stewart #define TCP_FUNCTION_BLK 8192 /* Set the tcp function pointers to the specified stack */ 213e2833083SPeter Lei #define TCP_FUNCTION_ALIAS 8193 /* Get the current tcp function pointer name alias */ 21489e560f4SRandall Stewart /* Options for Rack and BBR */ 215a034518aSAndrew Gallatin #define TCP_REUSPORT_LB_NUMA 1026 /* set listen socket numa domain */ 216e570d231SRandall Stewart #define TCP_RACK_MBUF_QUEUE 1050 /* Do we allow mbuf queuing if supported */ 21789e560f4SRandall Stewart #define TCP_RACK_PROP 1051 /* RACK proportional rate reduction (bool) */ 21889e560f4SRandall Stewart #define TCP_RACK_TLP_REDUCE 1052 /* RACK TLP cwnd reduction (bool) */ 2195d8fd932SRandall Stewart #define TCP_RACK_PACE_REDUCE 1053 /* RACK Pacingv reduction factor (divisor) */ 220e570d231SRandall Stewart #define TCP_RACK_PACE_MAX_SEG 1054 /* Max TSO size we will send */ 22189e560f4SRandall Stewart #define TCP_RACK_PACE_ALWAYS 1055 /* Use the always pace method */ 22289e560f4SRandall Stewart #define TCP_RACK_PROP_RATE 1056 /* The proportional reduction rate */ 22389e560f4SRandall Stewart #define TCP_RACK_PRR_SENDALOT 1057 /* Allow PRR to send more than one seg */ 22489e560f4SRandall Stewart #define TCP_RACK_MIN_TO 1058 /* Minimum time between rack t-o's in ms */ 22589e560f4SRandall Stewart #define TCP_RACK_EARLY_RECOV 1059 /* Should recovery happen early (bool) */ 22689e560f4SRandall Stewart #define TCP_RACK_EARLY_SEG 1060 /* If early recovery max segments */ 22789e560f4SRandall Stewart #define TCP_RACK_REORD_THRESH 1061 /* RACK reorder threshold (shift amount) */ 22889e560f4SRandall Stewart #define TCP_RACK_REORD_FADE 1062 /* Does reordering fade after ms time */ 22989e560f4SRandall Stewart #define TCP_RACK_TLP_THRESH 1063 /* RACK TLP theshold i.e. srtt+(srtt/N) */ 23089e560f4SRandall Stewart #define TCP_RACK_PKT_DELAY 1064 /* RACK added ms i.e. rack-rtt + reord + N */ 23189e560f4SRandall Stewart #define TCP_RACK_TLP_INC_VAR 1065 /* Does TLP include rtt variance in t-o */ 23289e560f4SRandall Stewart #define TCP_BBR_IWINTSO 1067 /* Initial TSO window for BBRs first sends */ 2333b0b41e6SRandall Stewart #define TCP_BBR_RECFORCE 1068 /* Enter recovery force out a segment disregard pacer no longer valid */ 23489e560f4SRandall Stewart #define TCP_BBR_STARTUP_PG 1069 /* Startup pacing gain */ 23589e560f4SRandall Stewart #define TCP_BBR_DRAIN_PG 1070 /* Drain pacing gain */ 23689e560f4SRandall Stewart #define TCP_BBR_RWND_IS_APP 1071 /* Rwnd limited is considered app limited */ 23789e560f4SRandall Stewart #define TCP_BBR_PROBE_RTT_INT 1072 /* How long in useconds between probe-rtt */ 23889e560f4SRandall Stewart #define TCP_BBR_ONE_RETRAN 1073 /* Is only one segment allowed out during retran */ 23989e560f4SRandall Stewart #define TCP_BBR_STARTUP_LOSS_EXIT 1074 /* Do we exit a loss during startup if not 20% incr */ 24089e560f4SRandall Stewart #define TCP_BBR_USE_LOWGAIN 1075 /* lower the gain in PROBE_BW enable */ 2413b0b41e6SRandall Stewart #define TCP_BBR_LOWGAIN_THRESH 1076 /* Unused after 2.3 morphs to TSLIMITS >= 2.3 */ 2423b0b41e6SRandall Stewart #define TCP_BBR_TSLIMITS 1076 /* Do we use experimental Timestamp limiting for our algo */ 2433b0b41e6SRandall Stewart #define TCP_BBR_LOWGAIN_HALF 1077 /* Unused after 2.3 */ 2443b0b41e6SRandall Stewart #define TCP_BBR_PACE_OH 1077 /* Reused in 4.2 for pacing overhead setting */ 2453b0b41e6SRandall Stewart #define TCP_BBR_LOWGAIN_FD 1078 /* Unused after 2.3 */ 2463b0b41e6SRandall Stewart #define TCP_BBR_HOLD_TARGET 1078 /* For 4.3 on */ 24789e560f4SRandall Stewart #define TCP_BBR_USEDEL_RATE 1079 /* Enable use of delivery rate for loss recovery */ 24889e560f4SRandall Stewart #define TCP_BBR_MIN_RTO 1080 /* Min RTO in milliseconds */ 24989e560f4SRandall Stewart #define TCP_BBR_MAX_RTO 1081 /* Max RTO in milliseconds */ 25089e560f4SRandall Stewart #define TCP_BBR_REC_OVER_HPTS 1082 /* Recovery override htps settings 0/1/3 */ 2513b0b41e6SRandall Stewart #define TCP_BBR_UNLIMITED 1083 /* Not used before 2.3 and morphs to algorithm >= 2.3 */ 2523b0b41e6SRandall Stewart #define TCP_BBR_ALGORITHM 1083 /* What measurement algo does BBR use netflix=0, google=1 */ 25389e560f4SRandall Stewart #define TCP_BBR_DRAIN_INC_EXTRA 1084 /* Does the 3/4 drain target include the extra gain */ 25489e560f4SRandall Stewart #define TCP_BBR_STARTUP_EXIT_EPOCH 1085 /* what epoch gets us out of startup */ 25589e560f4SRandall Stewart #define TCP_BBR_PACE_PER_SEC 1086 25689e560f4SRandall Stewart #define TCP_BBR_PACE_DEL_TAR 1087 25789e560f4SRandall Stewart #define TCP_BBR_PACE_SEG_MAX 1088 25889e560f4SRandall Stewart #define TCP_BBR_PACE_SEG_MIN 1089 25989e560f4SRandall Stewart #define TCP_BBR_PACE_CROSS 1090 26089e560f4SRandall Stewart #define TCP_RACK_IDLE_REDUCE_HIGH 1092 /* Reduce the highest cwnd seen to IW on idle */ 26189e560f4SRandall Stewart #define TCP_RACK_MIN_PACE 1093 /* Do we enforce rack min pace time */ 26289e560f4SRandall Stewart #define TCP_RACK_MIN_PACE_SEG 1094 /* If so what is the seg threshould */ 263e570d231SRandall Stewart #define TCP_RACK_GP_INCREASE 1094 /* After 4.1 its the GP increase in older rack */ 26489e560f4SRandall Stewart #define TCP_RACK_TLP_USE 1095 26589e560f4SRandall Stewart #define TCP_BBR_ACK_COMP_ALG 1096 /* Not used */ 2663b0b41e6SRandall Stewart #define TCP_BBR_TMR_PACE_OH 1096 /* Recycled in 4.2 */ 26789e560f4SRandall Stewart #define TCP_BBR_EXTRA_GAIN 1097 26835c7bb34SRandall Stewart #define TCP_RACK_DO_DETECTION 1097 /* Recycle of extra gain for rack, attack detection */ 26989e560f4SRandall Stewart #define TCP_BBR_RACK_RTT_USE 1098 /* what RTT should we use 0, 1, or 2? */ 27089e560f4SRandall Stewart #define TCP_BBR_RETRAN_WTSO 1099 27189e560f4SRandall Stewart #define TCP_DATA_AFTER_CLOSE 1100 27289e560f4SRandall Stewart #define TCP_BBR_PROBE_RTT_GAIN 1101 27389e560f4SRandall Stewart #define TCP_BBR_PROBE_RTT_LEN 1102 2743b0b41e6SRandall Stewart #define TCP_BBR_SEND_IWND_IN_TSO 1103 /* Do we burst out whole iwin size chunks at start? */ 275e570d231SRandall Stewart #define TCP_BBR_USE_RACK_RR 1104 /* Do we use the rack rapid recovery for pacing rxt's */ 276e570d231SRandall Stewart #define TCP_BBR_USE_RACK_CHEAT TCP_BBR_USE_RACK_RR /* Compat. */ 2773b0b41e6SRandall Stewart #define TCP_BBR_HDWR_PACE 1105 /* Enable/disable hardware pacing */ 2783b0b41e6SRandall Stewart #define TCP_BBR_UTTER_MAX_TSO 1106 /* Do we enforce an utter max TSO size */ 2793b0b41e6SRandall Stewart #define TCP_BBR_EXTRA_STATE 1107 /* Special exit-persist catch up */ 2803b0b41e6SRandall Stewart #define TCP_BBR_FLOOR_MIN_TSO 1108 /* The min tso size */ 2813b0b41e6SRandall Stewart #define TCP_BBR_MIN_TOPACEOUT 1109 /* Do we suspend pacing until */ 2823b0b41e6SRandall Stewart #define TCP_BBR_TSTMP_RAISES 1110 /* Can a timestamp measurement raise the b/w */ 2833b0b41e6SRandall Stewart #define TCP_BBR_POLICER_DETECT 1111 /* Turn on/off google mode policer detection */ 284e570d231SRandall Stewart #define TCP_BBR_RACK_INIT_RATE 1112 /* Set an initial pacing rate for when we have no b/w in kbits per sec */ 285e570d231SRandall Stewart #define TCP_RACK_RR_CONF 1113 /* Rack rapid recovery configuration control*/ 286e570d231SRandall Stewart #define TCP_RACK_CHEAT_NOT_CONF_RATE TCP_RACK_RR_CONF 287e570d231SRandall Stewart #define TCP_RACK_GP_INCREASE_CA 1114 /* GP increase for Congestion Avoidance */ 288e570d231SRandall Stewart #define TCP_RACK_GP_INCREASE_SS 1115 /* GP increase for Slow Start */ 289e570d231SRandall Stewart #define TCP_RACK_GP_INCREASE_REC 1116 /* GP increase for Recovery */ 290e570d231SRandall Stewart #define TCP_RACK_FORCE_MSEG 1117 /* Override to use the user set max-seg value */ 291e570d231SRandall Stewart #define TCP_RACK_PACE_RATE_CA 1118 /* Pacing rate for Congestion Avoidance */ 292e570d231SRandall Stewart #define TCP_RACK_PACE_RATE_SS 1119 /* Pacing rate for Slow Start */ 293e570d231SRandall Stewart #define TCP_RACK_PACE_RATE_REC 1120 /* Pacing rate for Recovery */ 294e570d231SRandall Stewart #define TCP_NO_PRR 1122 /* If pacing, don't use prr */ 295e570d231SRandall Stewart #define TCP_RACK_NONRXT_CFG_RATE 1123 /* In recovery does a non-rxt use the cfg rate */ 296e570d231SRandall Stewart #define TCP_SHARED_CWND_ENABLE 1124 /* Use a shared cwnd if allowed */ 297e570d231SRandall Stewart #define TCP_TIMELY_DYN_ADJ 1125 /* Do we attempt dynamic multipler adjustment with timely. */ 298e570d231SRandall Stewart #define TCP_RACK_NO_PUSH_AT_MAX 1126 /* For timely do not push if we are over max rtt */ 299e570d231SRandall Stewart #define TCP_RACK_PACE_TO_FILL 1127 /* If we are not in recovery, always pace to fill the cwnd in 1 RTT */ 300e570d231SRandall Stewart #define TCP_SHARED_CWND_TIME_LIMIT 1128 /* we should limit to low time values the scwnd life */ 301e570d231SRandall Stewart #define TCP_RACK_PROFILE 1129 /* Select a profile that sets multiple options */ 3025d8fd932SRandall Stewart #define TCP_HDWR_RATE_CAP 1130 /* Allow hardware rates to cap pacing rate */ 3035d8fd932SRandall Stewart #define TCP_PACING_RATE_CAP 1131 /* Highest rate allowed in pacing in bytes per second (uint64_t) */ 3045d8fd932SRandall Stewart #define TCP_HDWR_UP_ONLY 1132 /* Allow the pacing rate to climb but not descend (with the exception of fill-cw */ 3055d8fd932SRandall Stewart #define TCP_RACK_ABC_VAL 1133 /* Set a local ABC value different then the system default */ 3065d8fd932SRandall Stewart #define TCP_REC_ABC_VAL 1134 /* Do we use the ABC value for recovery or the override one from sysctl */ 3075d8fd932SRandall Stewart #define TCP_RACK_MEASURE_CNT 1135 /* How many measurements are required in GP pacing */ 3085d8fd932SRandall Stewart #define TCP_DEFER_OPTIONS 1136 /* Defer options until the proper number of measurements occur, does not defer TCP_RACK_MEASURE_CNT */ 3095d8fd932SRandall Stewart #define TCP_FAST_RSM_HACK 1137 /* Do we do the broken thing where we don't twiddle the TLP bits properly in fast_rsm_output? */ 3105d8fd932SRandall Stewart #define TCP_RACK_PACING_BETA 1138 /* Changing the beta for pacing */ 3115d8fd932SRandall Stewart #define TCP_RACK_PACING_BETA_ECN 1139 /* Changing the beta for ecn with pacing */ 3124f3addd9SRandall Stewart #define TCP_RACK_TIMER_SLOP 1140 /* Set or get the timer slop used */ 3135baf32c9SRandall Stewart #define TCP_RACK_DSACK_OPT 1141 /* How do we setup rack timer DSACK options bit 1/2 */ 3144e4c84f8SRandall Stewart #define TCP_RACK_ENABLE_HYSTART 1142 /* Do we allow hystart in the CC modules */ 3150d25fab4SJohn Baldwin /* Start of reserved space for third-party user-settable options. */ 3160d25fab4SJohn Baldwin #define TCP_VENDOR SO_VENDOR 3170d25fab4SJohn Baldwin 318ee939bbfSKip Macy #define TCP_CA_NAME_MAX 16 /* max congestion control name length */ 319b8af5dfaSRobert Watson 320b8af5dfaSRobert Watson #define TCPI_OPT_TIMESTAMPS 0x01 321b8af5dfaSRobert Watson #define TCPI_OPT_SACK 0x02 322b8af5dfaSRobert Watson #define TCPI_OPT_WSCALE 0x04 323b8af5dfaSRobert Watson #define TCPI_OPT_ECN 0x08 324535fbad6SKip Macy #define TCPI_OPT_TOE 0x10 3255d8fd932SRandall Stewart #define TCPI_OPT_TFO 0x20 326b8af5dfaSRobert Watson 3272529f56eSJonathan T. Looney /* Maximum length of log ID. */ 3282529f56eSJonathan T. Looney #define TCP_LOG_ID_LEN 64 3292529f56eSJonathan T. Looney 330b8af5dfaSRobert Watson /* 331b8af5dfaSRobert Watson * The TCP_INFO socket option comes from the Linux 2.6 TCP API, and permits 332b8af5dfaSRobert Watson * the caller to query certain information about the state of a TCP 333b8af5dfaSRobert Watson * connection. We provide an overlapping set of fields with the Linux 334b8af5dfaSRobert Watson * implementation, but since this is a fixed size structure, room has been 335b8af5dfaSRobert Watson * left for growth. In order to maximize potential future compatibility with 336b8af5dfaSRobert Watson * the Linux API, the same variable names and order have been adopted, and 337b8af5dfaSRobert Watson * padding left to make room for omitted fields in case they are added later. 338b8af5dfaSRobert Watson * 339b8af5dfaSRobert Watson * XXX: This is currently an unstable ABI/API, in that it is expected to 340b8af5dfaSRobert Watson * change. 341b8af5dfaSRobert Watson */ 342b8af5dfaSRobert Watson struct tcp_info { 343b8af5dfaSRobert Watson u_int8_t tcpi_state; /* TCP FSM state. */ 344b8af5dfaSRobert Watson u_int8_t __tcpi_ca_state; 345b8af5dfaSRobert Watson u_int8_t __tcpi_retransmits; 346b8af5dfaSRobert Watson u_int8_t __tcpi_probes; 347b8af5dfaSRobert Watson u_int8_t __tcpi_backoff; 348b8af5dfaSRobert Watson u_int8_t tcpi_options; /* Options enabled on conn. */ 349b8af5dfaSRobert Watson u_int8_t tcpi_snd_wscale:4, /* RFC1323 send shift value. */ 350b8af5dfaSRobert Watson tcpi_rcv_wscale:4; /* RFC1323 recv shift value. */ 351b8af5dfaSRobert Watson 35243d94734SJohn Baldwin u_int32_t tcpi_rto; /* Retransmission timeout (usec). */ 353b8af5dfaSRobert Watson u_int32_t __tcpi_ato; 35443d94734SJohn Baldwin u_int32_t tcpi_snd_mss; /* Max segment size for send. */ 35543d94734SJohn Baldwin u_int32_t tcpi_rcv_mss; /* Max segment size for receive. */ 356b8af5dfaSRobert Watson 357b8af5dfaSRobert Watson u_int32_t __tcpi_unacked; 358b8af5dfaSRobert Watson u_int32_t __tcpi_sacked; 359b8af5dfaSRobert Watson u_int32_t __tcpi_lost; 360b8af5dfaSRobert Watson u_int32_t __tcpi_retrans; 361b8af5dfaSRobert Watson u_int32_t __tcpi_fackets; 362b8af5dfaSRobert Watson 363b8af5dfaSRobert Watson /* Times; measurements in usecs. */ 364b8af5dfaSRobert Watson u_int32_t __tcpi_last_data_sent; 365b8af5dfaSRobert Watson u_int32_t __tcpi_last_ack_sent; /* Also unimpl. on Linux? */ 36643d94734SJohn Baldwin u_int32_t tcpi_last_data_recv; /* Time since last recv data. */ 367b8af5dfaSRobert Watson u_int32_t __tcpi_last_ack_recv; 368b8af5dfaSRobert Watson 369b8af5dfaSRobert Watson /* Metrics; variable units. */ 370b8af5dfaSRobert Watson u_int32_t __tcpi_pmtu; 371b8af5dfaSRobert Watson u_int32_t __tcpi_rcv_ssthresh; 3721baaf834SBruce M Simpson u_int32_t tcpi_rtt; /* Smoothed RTT in usecs. */ 3731baaf834SBruce M Simpson u_int32_t tcpi_rttvar; /* RTT variance in usecs. */ 374b8af5dfaSRobert Watson u_int32_t tcpi_snd_ssthresh; /* Slow start threshold. */ 375b8af5dfaSRobert Watson u_int32_t tcpi_snd_cwnd; /* Send congestion window. */ 376b8af5dfaSRobert Watson u_int32_t __tcpi_advmss; 377b8af5dfaSRobert Watson u_int32_t __tcpi_reordering; 378b8af5dfaSRobert Watson 379b8af5dfaSRobert Watson u_int32_t __tcpi_rcv_rtt; 380c8443a1dSRobert Watson u_int32_t tcpi_rcv_space; /* Advertised recv window. */ 381b8af5dfaSRobert Watson 382b8af5dfaSRobert Watson /* FreeBSD extensions to tcp_info. */ 383b8af5dfaSRobert Watson u_int32_t tcpi_snd_wnd; /* Advertised send window. */ 3841c18314dSAndre Oppermann u_int32_t tcpi_snd_bwnd; /* No longer used. */ 385535fbad6SKip Macy u_int32_t tcpi_snd_nxt; /* Next egress seqno */ 386535fbad6SKip Macy u_int32_t tcpi_rcv_nxt; /* Next ingress seqno */ 387535fbad6SKip Macy u_int32_t tcpi_toe_tid; /* HWTID for TOE endpoints */ 388f5d34df5SGeorge V. Neville-Neil u_int32_t tcpi_snd_rexmitpack; /* Retransmitted packets */ 389f5d34df5SGeorge V. Neville-Neil u_int32_t tcpi_rcv_ooopack; /* Out-of-order packets */ 390f5d34df5SGeorge V. Neville-Neil u_int32_t tcpi_snd_zerowin; /* Zero-sized windows sent */ 391b8af5dfaSRobert Watson 392*3708c3d3SRichard Scheffenegger /* Accurate ECN counters. */ 393*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_received_ce; /* # of CE marks received */ 394*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_delivered_e1_bytes; 395*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_delivered_e0_bytes; 396*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_delivered_ce_bytes; 397*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_received_e1_bytes; 398*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_received_e0_bytes; 399*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_received_ce_bytes; 400*3708c3d3SRichard Scheffenegger 401b8af5dfaSRobert Watson /* Padding to grow without breaking ABI. */ 402*3708c3d3SRichard Scheffenegger u_int32_t __tcpi_pad[19]; /* Padding. */ 403b8af5dfaSRobert Watson }; 404c560df6fSPatrick Kelsey 405c560df6fSPatrick Kelsey /* 406c560df6fSPatrick Kelsey * If this structure is provided when setting the TCP_FASTOPEN socket 407c560df6fSPatrick Kelsey * option, and the enable member is non-zero, a subsequent connect will use 408c560df6fSPatrick Kelsey * pre-shared key (PSK) mode using the provided key. 409c560df6fSPatrick Kelsey */ 410c560df6fSPatrick Kelsey struct tcp_fastopen { 411c560df6fSPatrick Kelsey int enable; 412c560df6fSPatrick Kelsey uint8_t psk[TCP_FASTOPEN_PSK_LEN]; 413c560df6fSPatrick Kelsey }; 414707f139eSPaul Richards #endif 41555bceb1eSRandall Stewart #define TCP_FUNCTION_NAME_LEN_MAX 32 41655bceb1eSRandall Stewart 41755bceb1eSRandall Stewart struct tcp_function_set { 41855bceb1eSRandall Stewart char function_set_name[TCP_FUNCTION_NAME_LEN_MAX]; 41955bceb1eSRandall Stewart uint32_t pcbcnt; 42055bceb1eSRandall Stewart }; 4210cd4a903SMike Barcroft 422b2e60773SJohn Baldwin /* TLS modes for TCP_TXTLS_MODE */ 423b2e60773SJohn Baldwin #define TCP_TLS_MODE_NONE 0 424b2e60773SJohn Baldwin #define TCP_TLS_MODE_SW 1 425b2e60773SJohn Baldwin #define TCP_TLS_MODE_IFNET 2 4269e14430dSJohn Baldwin #define TCP_TLS_MODE_TOE 3 427b2e60773SJohn Baldwin 428b2e60773SJohn Baldwin /* 429b2e60773SJohn Baldwin * TCP Control message types 430b2e60773SJohn Baldwin */ 431b2e60773SJohn Baldwin #define TLS_SET_RECORD_TYPE 1 432f1f93475SJohn Baldwin #define TLS_GET_RECORD 2 433b2e60773SJohn Baldwin 434adc56f5aSEdward Tomasz Napierala /* 435adc56f5aSEdward Tomasz Napierala * TCP specific variables of interest for tp->t_stats stats(9) accounting. 436adc56f5aSEdward Tomasz Napierala */ 437adc56f5aSEdward Tomasz Napierala #define VOI_TCP_TXPB 0 /* Transmit payload bytes */ 438adc56f5aSEdward Tomasz Napierala #define VOI_TCP_RETXPB 1 /* Retransmit payload bytes */ 439adc56f5aSEdward Tomasz Napierala #define VOI_TCP_FRWIN 2 /* Foreign receive window */ 440adc56f5aSEdward Tomasz Napierala #define VOI_TCP_LCWIN 3 /* Local congesiton window */ 441adc56f5aSEdward Tomasz Napierala #define VOI_TCP_RTT 4 /* Round trip time */ 442adc56f5aSEdward Tomasz Napierala #define VOI_TCP_CSIG 5 /* Congestion signal */ 443adc56f5aSEdward Tomasz Napierala #define VOI_TCP_GPUT 6 /* Goodput */ 444adc56f5aSEdward Tomasz Napierala #define VOI_TCP_CALCFRWINDIFF 7 /* Congestion avoidance LCWIN - FRWIN */ 445adc56f5aSEdward Tomasz Napierala #define VOI_TCP_GPUT_ND 8 /* Goodput normalised delta */ 446adc56f5aSEdward Tomasz Napierala #define VOI_TCP_ACKLEN 9 /* Average ACKed bytes per ACK */ 447adc56f5aSEdward Tomasz Napierala 448a034518aSAndrew Gallatin #define TCP_REUSPORT_LB_NUMA_NODOM (-2) /* remove numa binding */ 449a034518aSAndrew Gallatin #define TCP_REUSPORT_LB_NUMA_CURDOM (-1) /* bind to current domain */ 450a034518aSAndrew Gallatin 4510cd4a903SMike Barcroft #endif /* !_NETINET_TCP_H_ */ 452