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