]>
Commit | Line | Data |
---|---|---|
1c79356b | 1 | /* |
39236c6e | 2 | * Copyright (c) 2000-2012 Apple Inc. All rights reserved. |
5d5c5d0d | 3 | * |
2d21ac55 | 4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
39236c6e | 5 | * |
2d21ac55 A |
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. | |
39236c6e | 14 | * |
2d21ac55 A |
15 | * Please obtain a copy of the License at |
16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. | |
39236c6e | 17 | * |
2d21ac55 A |
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 | |
8f6c56a5 A |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
2d21ac55 A |
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. | |
39236c6e | 25 | * |
2d21ac55 | 26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ |
1c79356b A |
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 | |
9bccf70c | 61 | * $FreeBSD: src/sys/netinet/tcp.h,v 1.13.2.3 2001/03/01 22:08:42 jlemon Exp $ |
1c79356b A |
62 | */ |
63 | ||
64 | #ifndef _NETINET_TCP_H_ | |
65 | #define _NETINET_TCP_H_ | |
9bccf70c | 66 | #include <sys/appleapiopts.h> |
91447636 A |
67 | #include <sys/_types.h> |
68 | #include <machine/endian.h> | |
1c79356b | 69 | |
2d21ac55 | 70 | #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) |
91447636 A |
71 | typedef __uint32_t tcp_seq; |
72 | typedef __uint32_t tcp_cc; /* connection count per rfc1644 */ | |
1c79356b A |
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 | */ | |
81 | struct tcphdr { | |
91447636 A |
82 | unsigned short th_sport; /* source port */ |
83 | unsigned short th_dport; /* destination port */ | |
1c79356b A |
84 | tcp_seq th_seq; /* sequence number */ |
85 | tcp_seq th_ack; /* acknowledgement number */ | |
91447636 A |
86 | #if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN |
87 | unsigned int th_x2:4, /* (unused) */ | |
88 | th_off:4; /* data offset */ | |
1c79356b | 89 | #endif |
91447636 A |
90 | #if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN |
91 | unsigned int th_off:4, /* data offset */ | |
92 | th_x2:4; /* (unused) */ | |
1c79356b | 93 | #endif |
91447636 | 94 | unsigned char th_flags; |
1c79356b A |
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 | |
9bccf70c A |
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) | |
1c79356b | 104 | |
91447636 A |
105 | unsigned short th_win; /* window */ |
106 | unsigned short th_sum; /* checksum */ | |
107 | unsigned short th_urp; /* urgent pointer */ | |
1c79356b A |
108 | }; |
109 | ||
110 | #define TCPOPT_EOL 0 | |
111 | #define TCPOPT_NOP 1 | |
112 | #define TCPOPT_MAXSEG 2 | |
8ad349bb | 113 | #define TCPOLEN_MAXSEG 4 |
1c79356b | 114 | #define TCPOPT_WINDOW 3 |
8ad349bb | 115 | #define TCPOLEN_WINDOW 3 |
1c79356b | 116 | #define TCPOPT_SACK_PERMITTED 4 /* Experimental */ |
2d21ac55 | 117 | #define TCPOLEN_SACK_PERMITTED 2 |
1c79356b | 118 | #define TCPOPT_SACK 5 /* Experimental */ |
8ad349bb | 119 | #define TCPOLEN_SACK 8 /* len of sack block */ |
1c79356b | 120 | #define TCPOPT_TIMESTAMP 8 |
8ad349bb A |
121 | #define TCPOLEN_TIMESTAMP 10 |
122 | #define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */ | |
123 | #define TCPOPT_TSTAMP_HDR \ | |
1c79356b A |
124 | (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP) |
125 | ||
8ad349bb A |
126 | #define MAX_TCPOPTLEN 40 /* Absolute maximum TCP options len */ |
127 | ||
1c79356b A |
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) | |
8ad349bb A |
135 | #define TCPOPT_SIGNATURE 19 /* Keyed MD5: RFC 2385 */ |
136 | #define TCPOLEN_SIGNATURE 18 | |
39236c6e A |
137 | #if MPTCP |
138 | #define TCPOPT_MULTIPATH 30 | |
139 | #endif | |
8ad349bb A |
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 | #define TCP_MAX_SACK 3 /* MAX # SACKs sent in any segment */ | |
148 | ||
1c79356b A |
149 | |
150 | /* | |
151 | * Default maximum segment size for TCP. | |
4a249263 | 152 | * With an IP MTU of 576, this is 536, |
1c79356b A |
153 | * but 512 is probably more convenient. |
154 | * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)). | |
155 | */ | |
156 | #define TCP_MSS 512 | |
157 | ||
e5568f75 A |
158 | /* |
159 | * TCP_MINMSS is defined to be 216 which is fine for the smallest | |
160 | * link MTU (256 bytes, SLIP interface) in the Internet. | |
161 | * However it is very unlikely to come across such low MTU interfaces | |
162 | * these days (anno dato 2004). | |
163 | * Probably it can be set to 512 without ill effects. But we play safe. | |
164 | * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments. | |
165 | * Setting this to "0" disables the minmss check. | |
166 | */ | |
167 | #define TCP_MINMSS 216 | |
168 | ||
1c79356b A |
169 | /* |
170 | * Default maximum segment size for TCP6. | |
171 | * With an IP6 MSS of 1280, this is 1220, | |
172 | * but 1024 is probably more convenient. (xxx kazu in doubt) | |
173 | * This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr)) | |
174 | */ | |
175 | #define TCP6_MSS 1024 | |
176 | ||
177 | #define TCP_MAXWIN 65535 /* largest value for (unscaled) window */ | |
178 | #define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */ | |
179 | ||
180 | #define TCP_MAX_WINSHIFT 14 /* maximum window shift */ | |
181 | ||
182 | #define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */ | |
183 | #define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr)) | |
184 | /* max space left for options */ | |
2d21ac55 | 185 | #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ |
1c79356b A |
186 | |
187 | /* | |
188 | * User-settable options (used with setsockopt). | |
189 | */ | |
b0d623f7 | 190 | #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */ |
2d21ac55 | 191 | #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) |
b0d623f7 A |
192 | #define TCP_MAXSEG 0x02 /* set maximum segment size */ |
193 | #define TCP_NOPUSH 0x04 /* don't push last block of write */ | |
194 | #define TCP_NOOPT 0x08 /* don't use TCP options */ | |
195 | #define TCP_KEEPALIVE 0x10 /* idle time used when SO_KEEPALIVE is enabled */ | |
196 | #define TCP_CONNECTIONTIMEOUT 0x20 /* connection timeout */ | |
6d2010ae A |
197 | #define PERSIST_TIMEOUT 0x40 /* time after which a connection in |
198 | * persist timeout will terminate. | |
199 | * see draft-ananth-tcpm-persist-02.txt | |
200 | */ | |
201 | #define TCP_RXT_CONNDROPTIME 0x80 /* time after which tcp retransmissions will be | |
202 | * stopped and the connection will be dropped | |
203 | */ | |
39236c6e | 204 | #define TCP_RXT_FINDROP 0x100 /* when this option is set, drop a connection |
6d2010ae A |
205 | * after retransmitting the FIN 3 times. It will |
206 | * prevent holding too many mbufs in socket | |
207 | * buffer queues. | |
208 | */ | |
39236c6e A |
209 | #define TCP_KEEPINTVL 0x101 /* interval between keepalives */ |
210 | #define TCP_KEEPCNT 0x102 /* number of keepalives before close */ | |
211 | #define TCP_SENDMOREACKS 0x103 /* always ack every other packet */ | |
6d2010ae | 212 | #ifdef PRIVATE |
316670eb A |
213 | #define TCP_INFO 0x200 /* retrieve tcp_info structure */ |
214 | #define TCP_NOTSENT_LOWAT 0x201 /* Low water mark for TCP unsent data */ | |
215 | #define TCP_MEASURE_SND_BW 0x202 /* Measure sender's bandwidth for this connection */ | |
216 | #define TCP_MEASURE_BW_BURST 0x203 /* Burst size to use for bandwidth measurement */ | |
217 | #define TCP_PEER_PID 0x204 /* Lookup pid of the process we're connected to */ | |
39236c6e A |
218 | #define TCP_ADAPTIVE_READ_TIMEOUT 0x205 /* Read timeout used as a multiple of RTT */ |
219 | /* | |
220 | * Enable message delivery on a socket, this feature is currently unsupported and | |
221 | * is subjected to change in future. | |
222 | */ | |
223 | #define TCP_ENABLE_MSGS 0x206 | |
224 | #define TCP_ADAPTIVE_WRITE_TIMEOUT 0x207 /* Write timeout used as a multiple of RTT */ | |
225 | ||
6d2010ae | 226 | /* |
316670eb | 227 | * The TCP_INFO socket option is a private API and is subject to change |
6d2010ae A |
228 | */ |
229 | #pragma pack(4) | |
230 | ||
231 | #define TCPI_OPT_TIMESTAMPS 0x01 | |
232 | #define TCPI_OPT_SACK 0x02 | |
233 | #define TCPI_OPT_WSCALE 0x04 | |
234 | #define TCPI_OPT_ECN 0x08 | |
235 | ||
316670eb A |
236 | #define TCPI_FLAG_LOSSRECOVERY 0x01 /* Currently in loss recovery */ |
237 | ||
39236c6e A |
238 | /* |
239 | * Add new fields to this structure at the end only. This will preserve | |
240 | * binary compatibility. | |
241 | */ | |
6d2010ae A |
242 | struct tcp_info { |
243 | u_int8_t tcpi_state; /* TCP FSM state. */ | |
244 | u_int8_t tcpi_options; /* Options enabled on conn. */ | |
245 | u_int8_t tcpi_snd_wscale; /* RFC1323 send shift value. */ | |
246 | u_int8_t tcpi_rcv_wscale; /* RFC1323 recv shift value. */ | |
247 | ||
316670eb A |
248 | u_int32_t tcpi_flags; /* extra flags (TCPI_FLAG_xxx) */ |
249 | ||
250 | u_int32_t tcpi_rto; /* Retransmission timeout in milliseconds */ | |
6d2010ae A |
251 | u_int32_t tcpi_snd_mss; /* Max segment size for send. */ |
252 | u_int32_t tcpi_rcv_mss; /* Max segment size for receive. */ | |
253 | ||
316670eb A |
254 | u_int32_t tcpi_rttcur; /* Most recent value of RTT */ |
255 | u_int32_t tcpi_srtt; /* Smoothed RTT */ | |
256 | u_int32_t tcpi_rttvar; /* RTT variance */ | |
39236c6e | 257 | u_int32_t tcpi_rttbest; /* Best RTT we've seen */ |
316670eb | 258 | |
6d2010ae A |
259 | u_int32_t tcpi_snd_ssthresh; /* Slow start threshold. */ |
260 | u_int32_t tcpi_snd_cwnd; /* Send congestion window. */ | |
261 | ||
262 | u_int32_t tcpi_rcv_space; /* Advertised recv window. */ | |
263 | ||
264 | u_int32_t tcpi_snd_wnd; /* Advertised send window. */ | |
6d2010ae A |
265 | u_int32_t tcpi_snd_nxt; /* Next egress seqno */ |
266 | u_int32_t tcpi_rcv_nxt; /* Next ingress seqno */ | |
267 | ||
268 | int32_t tcpi_last_outif; /* if_index of interface used to send last */ | |
316670eb A |
269 | u_int32_t tcpi_snd_sbbytes; /* bytes in snd buffer including data inflight */ |
270 | ||
39236c6e | 271 | u_int64_t tcpi_txpackets __attribute__((aligned(8))); /* total packets sent */ |
316670eb A |
272 | u_int64_t tcpi_txbytes __attribute__((aligned(8))); |
273 | /* total bytes sent */ | |
274 | u_int64_t tcpi_txretransmitbytes __attribute__((aligned(8))); | |
275 | /* total bytes retransmitted */ | |
276 | u_int64_t tcpi_txunacked __attribute__((aligned(8))); | |
277 | /* current number of bytes not acknowledged */ | |
39236c6e | 278 | u_int64_t tcpi_rxpackets __attribute__((aligned(8))); /* total packets received */ |
316670eb A |
279 | u_int64_t tcpi_rxbytes __attribute__((aligned(8))); |
280 | /* total bytes received */ | |
281 | u_int64_t tcpi_rxduplicatebytes __attribute__((aligned(8))); | |
282 | /* total duplicate bytes received */ | |
39236c6e A |
283 | u_int64_t tcpi_rxoutoforderbytes __attribute__((aligned(8))); |
284 | /* total out of order bytes received */ | |
285 | u_int64_t tcpi_snd_bw __attribute__((aligned(8))); /* measured send bandwidth in bits/sec */ | |
286 | u_int8_t tcpi_synrexmits; /* Number of syn retransmits before connect */ | |
287 | u_int8_t tcpi_unused1; | |
288 | u_int16_t tcpi_unused2; | |
289 | u_int64_t tcpi_cell_rxpackets __attribute((aligned(8))); /* packets received over cellular */ | |
290 | u_int64_t tcpi_cell_rxbytes __attribute((aligned(8))); /* bytes received over cellular */ | |
291 | u_int64_t tcpi_cell_txpackets __attribute((aligned(8))); /* packets transmitted over cellular */ | |
292 | u_int64_t tcpi_cell_txbytes __attribute((aligned(8))); /* bytes transmitted over cellular */ | |
293 | u_int64_t tcpi_wifi_rxpackets __attribute((aligned(8))); /* packets received over Wi-Fi */ | |
294 | u_int64_t tcpi_wifi_rxbytes __attribute((aligned(8))); /* bytes received over Wi-Fi */ | |
295 | u_int64_t tcpi_wifi_txpackets __attribute((aligned(8))); /* packets transmitted over Wi-Fi */ | |
296 | u_int64_t tcpi_wifi_txbytes __attribute((aligned(8))); /* bytes transmitted over Wi-Fi */ | |
316670eb A |
297 | }; |
298 | ||
299 | struct tcp_measure_bw_burst { | |
300 | u_int32_t min_burst_size; /* Minimum number of packets to use */ | |
301 | u_int32_t max_burst_size; /* Maximum number of packets to use */ | |
6d2010ae A |
302 | }; |
303 | ||
304 | /* | |
305 | * Note that IPv6 link local addresses should have the appropriate scope ID | |
306 | */ | |
307 | ||
308 | struct info_tuple { | |
309 | u_int8_t itpl_proto; | |
310 | union { | |
311 | struct sockaddr _itpl_sa; | |
312 | struct sockaddr_in _itpl_sin; | |
313 | struct sockaddr_in6 _itpl_sin6; | |
314 | } itpl_localaddr; | |
315 | union { | |
316 | struct sockaddr _itpl_sa; | |
317 | struct sockaddr_in _itpl_sin; | |
318 | struct sockaddr_in6 _itpl_sin6; | |
319 | } itpl_remoteaddr; | |
320 | }; | |
321 | ||
322 | #define itpl_local_sa itpl_localaddr._itpl_sa | |
323 | #define itpl_local_sin itpl_localaddr._itpl_sin | |
324 | #define itpl_local_sin6 itpl_localaddr._itpl_sin6 | |
325 | #define itpl_remote_sa itpl_remoteaddr._itpl_sa | |
326 | #define itpl_remote_sin itpl_remoteaddr._itpl_sin | |
327 | #define itpl_remote_sin6 itpl_remoteaddr._itpl_sin6 | |
328 | ||
39236c6e A |
329 | /* |
330 | * TCP connection info auxiliary data (CIAUX_TCP) | |
331 | * | |
332 | * Do not add new fields to this structure, just add them to tcp_info | |
333 | * structure towards the end. This will preserve binary compatibility. | |
334 | */ | |
335 | typedef struct conninfo_tcp { | |
336 | pid_t tcpci_peer_pid; /* loopback peer PID if > 0 */ | |
337 | struct tcp_info tcpci_tcp_info; /* TCP info */ | |
338 | } conninfo_tcp_t; | |
339 | ||
6d2010ae A |
340 | #pragma pack() |
341 | ||
342 | #endif /* PRIVATE */ | |
2d21ac55 | 343 | #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ |
1c79356b A |
344 | |
345 | #endif |