1 /* 2 * Copyright (c) 2000-2018 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 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. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 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. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* 29 * Copyright (c) 1982, 1986, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 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. 47 * 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 58 * SUCH DAMAGE. 59 * 60 * @(#)tcp.h 8.1 (Berkeley) 6/10/93 61 * $FreeBSD: src/sys/netinet/tcp.h,v 1.13.2.3 2001/03/01 22:08:42 jlemon Exp $ 62 */ 63 64 #ifndef _NETINET_TCP_H_ 65 #define _NETINET_TCP_H_ 66 #include <sys/appleapiopts.h> 67 68 #include <machine/endian.h> 69 #include <machine/types.h> /* __uint32_t */ 70 71 #include <sys/types.h> 72 73 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 74 typedef __uint32_t tcp_seq; 75 typedef __uint32_t tcp_cc; /* connection count per rfc1644 */ 76 77 #define tcp6_seq tcp_seq /* for KAME src sync over BSD*'s */ 78 #define tcp6hdr tcphdr /* for KAME src sync over BSD*'s */ 79 80 /* 81 * TCP header. 82 * Per RFC 793, September, 1981. 83 */ 84 struct tcphdr { 85 unsigned short th_sport; /* source port */ 86 unsigned short th_dport; /* destination port */ 87 tcp_seq th_seq; /* sequence number */ 88 tcp_seq th_ack; /* acknowledgement number */ 89 #if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN 90 unsigned int th_x2:4, /* (unused) */ 91 th_off:4; /* data offset */ 92 #endif 93 #if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN 94 unsigned int th_off:4, /* data offset */ 95 th_x2:4; /* (unused) */ 96 #endif 97 unsigned char th_flags; 98 #define TH_FIN 0x01 99 #define TH_SYN 0x02 100 #define TH_RST 0x04 101 #define TH_PUSH 0x08 102 #define TH_ACK 0x10 103 #define TH_URG 0x20 104 #define TH_ECE 0x40 105 #define TH_CWR 0x80 106 #define TH_FLAGS (TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR) 107 #define TH_ACCEPT (TH_FIN|TH_SYN|TH_RST|TH_ACK) 108 109 unsigned short th_win; /* window */ 110 unsigned short th_sum; /* checksum */ 111 unsigned short th_urp; /* urgent pointer */ 112 }; 113 114 #define TCPOPT_EOL 0 115 #define TCPOPT_NOP 1 116 #define TCPOPT_MAXSEG 2 117 #define TCPOLEN_MAXSEG 4 118 #define TCPOPT_WINDOW 3 119 #define TCPOLEN_WINDOW 3 120 #define TCPOPT_SACK_PERMITTED 4 /* Experimental */ 121 #define TCPOLEN_SACK_PERMITTED 2 122 #define TCPOPT_SACK 5 /* Experimental */ 123 #define TCPOLEN_SACK 8 /* len of sack block */ 124 #define TCPOPT_TIMESTAMP 8 125 #define TCPOLEN_TIMESTAMP 10 126 #define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */ 127 #define TCPOPT_TSTAMP_HDR \ 128 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP) 129 130 #define MAX_TCPOPTLEN 40 /* Absolute maximum TCP options len */ 131 132 #define TCPOPT_CC 11 /* CC options: RFC-1644 */ 133 #define TCPOPT_CCNEW 12 134 #define TCPOPT_CCECHO 13 135 #define TCPOLEN_CC 6 136 #define TCPOLEN_CC_APPA (TCPOLEN_CC+2) 137 #define TCPOPT_CC_HDR(ccopt) \ 138 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|(ccopt)<<8|TCPOLEN_CC) 139 #define TCPOPT_SIGNATURE 19 /* Keyed MD5: RFC 2385 */ 140 #define TCPOLEN_SIGNATURE 18 141 #if MPTCP 142 #define TCPOPT_MULTIPATH 30 143 #endif 144 145 #define TCPOPT_FASTOPEN 34 146 #define TCPOLEN_FASTOPEN_REQ 2 147 148 /* Option definitions */ 149 #define TCPOPT_SACK_PERMIT_HDR \ 150 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK_PERMITTED<<8|TCPOLEN_SACK_PERMITTED) 151 #define TCPOPT_SACK_HDR (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK<<8) 152 /* Miscellaneous constants */ 153 #define MAX_SACK_BLKS 6 /* Max # SACK blocks stored at sender side */ 154 155 /* 156 * A SACK option that specifies n blocks will have a length of (8*n + 2) 157 * bytes, so the 40 bytes available for TCP options can specify a 158 * maximum of 4 blocks. 159 */ 160 161 #define TCP_MAX_SACK 4 /* MAX # SACKs sent in any segment */ 162 163 164 /* 165 * Default maximum segment size for TCP. 166 * With an IP MTU of 576, this is 536, 167 * but 512 is probably more convenient. 168 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)). 169 */ 170 #define TCP_MSS 512 171 172 /* 173 * TCP_MINMSS is defined to be 216 which is fine for the smallest 174 * link MTU (256 bytes, SLIP interface) in the Internet. 175 * However it is very unlikely to come across such low MTU interfaces 176 * these days (anno dato 2004). 177 * Probably it can be set to 512 without ill effects. But we play safe. 178 * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments. 179 * Setting this to "0" disables the minmss check. 180 */ 181 #define TCP_MINMSS 216 182 183 /* 184 * Default maximum segment size for TCP6. 185 * With an IP6 MSS of 1280, this is 1220, 186 * but 1024 is probably more convenient. (xxx kazu in doubt) 187 * This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr)) 188 */ 189 #define TCP6_MSS 1024 190 191 #define TCP_MAXWIN 65535 /* largest value for (unscaled) window */ 192 #define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */ 193 194 #define TCP_MAX_WINSHIFT 14 /* maximum window shift */ 195 196 #define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */ 197 #define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr)) 198 /* max space left for options */ 199 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 200 201 /* 202 * User-settable options (used with setsockopt). 203 */ 204 #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */ 205 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 206 #define TCP_MAXSEG 0x02 /* set maximum segment size */ 207 #define TCP_NOPUSH 0x04 /* don't push last block of write */ 208 #define TCP_NOOPT 0x08 /* don't use TCP options */ 209 #define TCP_KEEPALIVE 0x10 /* idle time used when SO_KEEPALIVE is enabled */ 210 #define TCP_CONNECTIONTIMEOUT 0x20 /* connection timeout */ 211 #define PERSIST_TIMEOUT 0x40 /* time after which a connection in 212 * persist timeout will terminate. 213 * see draft-ananth-tcpm-persist-02.txt 214 */ 215 #define TCP_RXT_CONNDROPTIME 0x80 /* time after which tcp retransmissions will be 216 * stopped and the connection will be dropped 217 */ 218 #define TCP_RXT_FINDROP 0x100 /* when this option is set, drop a connection 219 * after retransmitting the FIN 3 times. It will 220 * prevent holding too many mbufs in socket 221 * buffer queues. 222 */ 223 #define TCP_KEEPINTVL 0x101 /* interval between keepalives */ 224 #define TCP_KEEPCNT 0x102 /* number of keepalives before close */ 225 #define TCP_SENDMOREACKS 0x103 /* always ack every other packet */ 226 #define TCP_ENABLE_ECN 0x104 /* Enable ECN on a connection */ 227 #define TCP_FASTOPEN 0x105 /* Enable/Disable TCP Fastopen on this socket */ 228 #define TCP_CONNECTION_INFO 0x106 /* State of TCP connection */ 229 230 231 232 #define TCP_NOTSENT_LOWAT 0x201 /* Low water mark for TCP unsent data */ 233 234 235 struct tcp_connection_info { 236 u_int8_t tcpi_state; /* connection state */ 237 u_int8_t tcpi_snd_wscale; /* Window scale for send window */ 238 u_int8_t tcpi_rcv_wscale; /* Window scale for receive window */ 239 u_int8_t __pad1; 240 u_int32_t tcpi_options; /* TCP options supported */ 241 #define TCPCI_OPT_TIMESTAMPS 0x00000001 /* Timestamps enabled */ 242 #define TCPCI_OPT_SACK 0x00000002 /* SACK enabled */ 243 #define TCPCI_OPT_WSCALE 0x00000004 /* Window scaling enabled */ 244 #define TCPCI_OPT_ECN 0x00000008 /* ECN enabled */ 245 u_int32_t tcpi_flags; /* flags */ 246 #define TCPCI_FLAG_LOSSRECOVERY 0x00000001 247 #define TCPCI_FLAG_REORDERING_DETECTED 0x00000002 248 u_int32_t tcpi_rto; /* retransmit timeout in ms */ 249 u_int32_t tcpi_maxseg; /* maximum segment size supported */ 250 u_int32_t tcpi_snd_ssthresh; /* slow start threshold in bytes */ 251 u_int32_t tcpi_snd_cwnd; /* send congestion window in bytes */ 252 u_int32_t tcpi_snd_wnd; /* send widnow in bytes */ 253 u_int32_t tcpi_snd_sbbytes; /* bytes in send socket buffer, including in-flight data */ 254 u_int32_t tcpi_rcv_wnd; /* receive window in bytes*/ 255 u_int32_t tcpi_rttcur; /* most recent RTT in ms */ 256 u_int32_t tcpi_srtt; /* average RTT in ms */ 257 u_int32_t tcpi_rttvar; /* RTT variance */ 258 u_int32_t 259 tcpi_tfo_cookie_req:1, /* Cookie requested? */ 260 tcpi_tfo_cookie_rcv:1, /* Cookie received? */ 261 tcpi_tfo_syn_loss:1, /* Fallback to reg. TCP after SYN-loss */ 262 tcpi_tfo_syn_data_sent:1, /* SYN+data has been sent out */ 263 tcpi_tfo_syn_data_acked:1, /* SYN+data has been fully acknowledged */ 264 tcpi_tfo_syn_data_rcv:1, /* Server received SYN+data with a valid cookie */ 265 tcpi_tfo_cookie_req_rcv:1, /* Server received cookie-request */ 266 tcpi_tfo_cookie_sent:1, /* Server announced cookie */ 267 tcpi_tfo_cookie_invalid:1, /* Server received an invalid cookie */ 268 tcpi_tfo_cookie_wrong:1, /* Our sent cookie was wrong */ 269 tcpi_tfo_no_cookie_rcv:1, /* We did not receive a cookie upon our request */ 270 tcpi_tfo_heuristics_disable:1, /* TFO-heuristics disabled it */ 271 tcpi_tfo_send_blackhole:1, /* A sending-blackhole got detected */ 272 tcpi_tfo_recv_blackhole:1, /* A receiver-blackhole got detected */ 273 tcpi_tfo_onebyte_proxy:1, /* A proxy acknowledges all but one byte of the SYN */ 274 __pad2:17; 275 u_int64_t tcpi_txpackets __attribute__((aligned(8))); 276 u_int64_t tcpi_txbytes __attribute__((aligned(8))); 277 u_int64_t tcpi_txretransmitbytes __attribute__((aligned(8))); 278 u_int64_t tcpi_rxpackets __attribute__((aligned(8))); 279 u_int64_t tcpi_rxbytes __attribute__((aligned(8))); 280 u_int64_t tcpi_rxoutoforderbytes __attribute__((aligned(8))); 281 u_int64_t tcpi_txretransmitpackets __attribute__((aligned(8))); 282 }; 283 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 284 285 #endif