1/* 2 * Copyright (c) 2000-2014 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#include <sys/_types.h> 68#include <machine/endian.h> 69 70#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 71typedef __uint32_t tcp_seq; 72typedef __uint32_t tcp_cc; /* connection count per rfc1644 */ 73 74#define tcp6_seq tcp_seq /* for KAME src sync over BSD*'s */ 75#define tcp6hdr tcphdr /* for KAME src sync over BSD*'s */ 76 77/* 78 * TCP header. 79 * Per RFC 793, September, 1981. 80 */ 81struct tcphdr { 82 unsigned short th_sport; /* source port */ 83 unsigned short th_dport; /* destination port */ 84 tcp_seq th_seq; /* sequence number */ 85 tcp_seq th_ack; /* acknowledgement number */ 86#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN 87 unsigned int th_x2:4, /* (unused) */ 88 th_off:4; /* data offset */ 89#endif 90#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN 91 unsigned int th_off:4, /* data offset */ 92 th_x2:4; /* (unused) */ 93#endif 94 unsigned char th_flags; 95#define TH_FIN 0x01 96#define TH_SYN 0x02 97#define TH_RST 0x04 98#define TH_PUSH 0x08 99#define TH_ACK 0x10 100#define TH_URG 0x20 101#define TH_ECE 0x40 102#define TH_CWR 0x80 103#define TH_FLAGS (TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR) 104 105 unsigned short th_win; /* window */ 106 unsigned short th_sum; /* checksum */ 107 unsigned short th_urp; /* urgent pointer */ 108}; 109 110#define TCPOPT_EOL 0 111#define TCPOPT_NOP 1 112#define TCPOPT_MAXSEG 2 113#define TCPOLEN_MAXSEG 4 114#define TCPOPT_WINDOW 3 115#define TCPOLEN_WINDOW 3 116#define TCPOPT_SACK_PERMITTED 4 /* Experimental */ 117#define TCPOLEN_SACK_PERMITTED 2 118#define TCPOPT_SACK 5 /* Experimental */ 119#define TCPOLEN_SACK 8 /* len of sack block */ 120#define TCPOPT_TIMESTAMP 8 121#define TCPOLEN_TIMESTAMP 10 122#define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */ 123#define TCPOPT_TSTAMP_HDR \ 124 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP) 125 126#define MAX_TCPOPTLEN 40 /* Absolute maximum TCP options len */ 127 128#define TCPOPT_CC 11 /* CC options: RFC-1644 */ 129#define TCPOPT_CCNEW 12 130#define TCPOPT_CCECHO 13 131#define TCPOLEN_CC 6 132#define TCPOLEN_CC_APPA (TCPOLEN_CC+2) 133#define TCPOPT_CC_HDR(ccopt) \ 134 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|(ccopt)<<8|TCPOLEN_CC) 135#define TCPOPT_SIGNATURE 19 /* Keyed MD5: RFC 2385 */ 136#define TCPOLEN_SIGNATURE 18 137#if MPTCP 138#define TCPOPT_MULTIPATH 30 139#endif 140 141/* Option definitions */ 142#define TCPOPT_SACK_PERMIT_HDR \ 143(TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK_PERMITTED<<8|TCPOLEN_SACK_PERMITTED) 144#define TCPOPT_SACK_HDR (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK<<8) 145/* Miscellaneous constants */ 146#define MAX_SACK_BLKS 6 /* Max # SACK blocks stored at sender side */ 147 148/* 149 * A SACK option that specifies n blocks will have a length of (8*n + 2) 150 * bytes, so the 40 bytes available for TCP options can specify a 151 * maximum of 4 blocks. 152 */ 153 154#define TCP_MAX_SACK 4 /* MAX # SACKs sent in any segment */ 155 156 157/* 158 * Default maximum segment size for TCP. 159 * With an IP MTU of 576, this is 536, 160 * but 512 is probably more convenient. 161 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)). 162 */ 163#define TCP_MSS 512 164 165/* 166 * TCP_MINMSS is defined to be 216 which is fine for the smallest 167 * link MTU (256 bytes, SLIP interface) in the Internet. 168 * However it is very unlikely to come across such low MTU interfaces 169 * these days (anno dato 2004). 170 * Probably it can be set to 512 without ill effects. But we play safe. 171 * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments. 172 * Setting this to "0" disables the minmss check. 173 */ 174#define TCP_MINMSS 216 175 176/* 177 * Default maximum segment size for TCP6. 178 * With an IP6 MSS of 1280, this is 1220, 179 * but 1024 is probably more convenient. (xxx kazu in doubt) 180 * This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr)) 181 */ 182#define TCP6_MSS 1024 183 184#define TCP_MAXWIN 65535 /* largest value for (unscaled) window */ 185#define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */ 186 187#define TCP_MAX_WINSHIFT 14 /* maximum window shift */ 188 189#define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */ 190#define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr)) 191 /* max space left for options */ 192#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 193 194/* 195 * User-settable options (used with setsockopt). 196 */ 197#define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */ 198#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 199#define TCP_MAXSEG 0x02 /* set maximum segment size */ 200#define TCP_NOPUSH 0x04 /* don't push last block of write */ 201#define TCP_NOOPT 0x08 /* don't use TCP options */ 202#define TCP_KEEPALIVE 0x10 /* idle time used when SO_KEEPALIVE is enabled */ 203#define TCP_CONNECTIONTIMEOUT 0x20 /* connection timeout */ 204#define PERSIST_TIMEOUT 0x40 /* time after which a connection in 205 * persist timeout will terminate. 206 * see draft-ananth-tcpm-persist-02.txt 207 */ 208#define TCP_RXT_CONNDROPTIME 0x80 /* time after which tcp retransmissions will be 209 * stopped and the connection will be dropped 210 */ 211#define TCP_RXT_FINDROP 0x100 /* when this option is set, drop a connection 212 * after retransmitting the FIN 3 times. It will 213 * prevent holding too many mbufs in socket 214 * buffer queues. 215 */ 216#define TCP_KEEPINTVL 0x101 /* interval between keepalives */ 217#define TCP_KEEPCNT 0x102 /* number of keepalives before close */ 218#define TCP_SENDMOREACKS 0x103 /* always ack every other packet */ 219#define TCP_ENABLE_ECN 0x104 /* Enable ECN on a connection */ 220 221#ifdef PRIVATE 222#define TCP_INFO 0x200 /* retrieve tcp_info structure */ 223#define TCP_MEASURE_SND_BW 0x202 /* Measure sender's bandwidth for this connection */ 224#endif /* PRIVATE */ 225 226 227#define TCP_NOTSENT_LOWAT 0x201 /* Low water mark for TCP unsent data */ 228 229#ifdef PRIVATE 230#define TCP_MEASURE_BW_BURST 0x203 /* Burst size to use for bandwidth measurement */ 231#define TCP_PEER_PID 0x204 /* Lookup pid of the process we're connected to */ 232#define TCP_ADAPTIVE_READ_TIMEOUT 0x205 /* Read timeout used as a multiple of RTT */ 233/* 234 * Enable message delivery on a socket, this feature is currently unsupported and 235 * is subjected to change in future. 236 */ 237#define TCP_ENABLE_MSGS 0x206 238#define TCP_ADAPTIVE_WRITE_TIMEOUT 0x207 /* Write timeout used as a multiple of RTT */ 239#define TCP_NOTIMEWAIT 0x208 /* Avoid going into time-wait */ 240#define TCP_DISABLE_BLACKHOLE_DETECTION 0x209 /* disable PMTU blackhole detection */ 241 242/* 243 * The TCP_INFO socket option is a private API and is subject to change 244 */ 245#pragma pack(4) 246 247#define TCPI_OPT_TIMESTAMPS 0x01 248#define TCPI_OPT_SACK 0x02 249#define TCPI_OPT_WSCALE 0x04 250#define TCPI_OPT_ECN 0x08 251 252#define TCPI_FLAG_LOSSRECOVERY 0x01 /* Currently in loss recovery */ 253 254/* 255 * Add new fields to this structure at the end only. This will preserve 256 * binary compatibility. 257 */ 258struct tcp_info { 259 u_int8_t tcpi_state; /* TCP FSM state. */ 260 u_int8_t tcpi_options; /* Options enabled on conn. */ 261 u_int8_t tcpi_snd_wscale; /* RFC1323 send shift value. */ 262 u_int8_t tcpi_rcv_wscale; /* RFC1323 recv shift value. */ 263 264 u_int32_t tcpi_flags; /* extra flags (TCPI_FLAG_xxx) */ 265 266 u_int32_t tcpi_rto; /* Retransmission timeout in milliseconds */ 267 u_int32_t tcpi_snd_mss; /* Max segment size for send. */ 268 u_int32_t tcpi_rcv_mss; /* Max segment size for receive. */ 269 270 u_int32_t tcpi_rttcur; /* Most recent value of RTT */ 271 u_int32_t tcpi_srtt; /* Smoothed RTT */ 272 u_int32_t tcpi_rttvar; /* RTT variance */ 273 u_int32_t tcpi_rttbest; /* Best RTT we've seen */ 274 275 u_int32_t tcpi_snd_ssthresh; /* Slow start threshold. */ 276 u_int32_t tcpi_snd_cwnd; /* Send congestion window. */ 277 278 u_int32_t tcpi_rcv_space; /* Advertised recv window. */ 279 280 u_int32_t tcpi_snd_wnd; /* Advertised send window. */ 281 u_int32_t tcpi_snd_nxt; /* Next egress seqno */ 282 u_int32_t tcpi_rcv_nxt; /* Next ingress seqno */ 283 284 int32_t tcpi_last_outif; /* if_index of interface used to send last */ 285 u_int32_t tcpi_snd_sbbytes; /* bytes in snd buffer including data inflight */ 286 287 u_int64_t tcpi_txpackets __attribute__((aligned(8))); /* total packets sent */ 288 u_int64_t tcpi_txbytes __attribute__((aligned(8))); 289 /* total bytes sent */ 290 u_int64_t tcpi_txretransmitbytes __attribute__((aligned(8))); 291 /* total bytes retransmitted */ 292 u_int64_t tcpi_txunacked __attribute__((aligned(8))); 293 /* current number of bytes not acknowledged */ 294 u_int64_t tcpi_rxpackets __attribute__((aligned(8))); /* total packets received */ 295 u_int64_t tcpi_rxbytes __attribute__((aligned(8))); 296 /* total bytes received */ 297 u_int64_t tcpi_rxduplicatebytes __attribute__((aligned(8))); 298 /* total duplicate bytes received */ 299 u_int64_t tcpi_rxoutoforderbytes __attribute__((aligned(8))); 300 /* total out of order bytes received */ 301 u_int64_t tcpi_snd_bw __attribute__((aligned(8))); /* measured send bandwidth in bits/sec */ 302 u_int8_t tcpi_synrexmits; /* Number of syn retransmits before connect */ 303 u_int8_t tcpi_unused1; 304 u_int16_t tcpi_unused2; 305 u_int64_t tcpi_cell_rxpackets __attribute((aligned(8))); /* packets received over cellular */ 306 u_int64_t tcpi_cell_rxbytes __attribute((aligned(8))); /* bytes received over cellular */ 307 u_int64_t tcpi_cell_txpackets __attribute((aligned(8))); /* packets transmitted over cellular */ 308 u_int64_t tcpi_cell_txbytes __attribute((aligned(8))); /* bytes transmitted over cellular */ 309 u_int64_t tcpi_wifi_rxpackets __attribute((aligned(8))); /* packets received over Wi-Fi */ 310 u_int64_t tcpi_wifi_rxbytes __attribute((aligned(8))); /* bytes received over Wi-Fi */ 311 u_int64_t tcpi_wifi_txpackets __attribute((aligned(8))); /* packets transmitted over Wi-Fi */ 312 u_int64_t tcpi_wifi_txbytes __attribute((aligned(8))); /* bytes transmitted over Wi-Fi */ 313 u_int64_t tcpi_wired_rxpackets __attribute((aligned(8))); /* packets received over Wired */ 314 u_int64_t tcpi_wired_rxbytes __attribute((aligned(8))); /* bytes received over Wired */ 315 u_int64_t tcpi_wired_txpackets __attribute((aligned(8))); /* packets transmitted over Wired */ 316 u_int64_t tcpi_wired_txbytes __attribute((aligned(8))); /* bytes transmitted over Wired */ 317}; 318 319struct tcp_measure_bw_burst { 320 u_int32_t min_burst_size; /* Minimum number of packets to use */ 321 u_int32_t max_burst_size; /* Maximum number of packets to use */ 322}; 323 324/* 325 * Note that IPv6 link local addresses should have the appropriate scope ID 326 */ 327 328struct info_tuple { 329 u_int8_t itpl_proto; 330 union { 331 struct sockaddr _itpl_sa; 332 struct sockaddr_in _itpl_sin; 333 struct sockaddr_in6 _itpl_sin6; 334 } itpl_localaddr; 335 union { 336 struct sockaddr _itpl_sa; 337 struct sockaddr_in _itpl_sin; 338 struct sockaddr_in6 _itpl_sin6; 339 } itpl_remoteaddr; 340}; 341 342#define itpl_local_sa itpl_localaddr._itpl_sa 343#define itpl_local_sin itpl_localaddr._itpl_sin 344#define itpl_local_sin6 itpl_localaddr._itpl_sin6 345#define itpl_remote_sa itpl_remoteaddr._itpl_sa 346#define itpl_remote_sin itpl_remoteaddr._itpl_sin 347#define itpl_remote_sin6 itpl_remoteaddr._itpl_sin6 348 349/* 350 * TCP connection info auxiliary data (CIAUX_TCP) 351 * 352 * Do not add new fields to this structure, just add them to tcp_info 353 * structure towards the end. This will preserve binary compatibility. 354 */ 355typedef struct conninfo_tcp { 356 pid_t tcpci_peer_pid; /* loopback peer PID if > 0 */ 357 struct tcp_info tcpci_tcp_info; /* TCP info */ 358} conninfo_tcp_t; 359 360#pragma pack() 361 362#endif /* PRIVATE */ 363#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 364 365#endif 366