1/*
2 * Copyright (c) 1982, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)tcp.h 8.1 (Berkeley) 6/10/93
30 */
31
32#ifndef _NETINET_TCP_H
33#define _NETINET_TCP_H 1
34
35#include <features.h>
36
37/*
38 * User-settable options (used with setsockopt).
39 */
40#define TCP_NODELAY 1 /* Don't delay send to coalesce packets */
41#define TCP_MAXSEG 2 /* Set maximum segment size */
42#define TCP_CORK 3 /* Control sending of partial frames */
43#define TCP_KEEPIDLE 4 /* Start keeplives after this period */
44#define TCP_KEEPINTVL 5 /* Interval between keepalives */
45#define TCP_KEEPCNT 6 /* Number of keepalives before death */
46#define TCP_SYNCNT 7 /* Number of SYN retransmits */
47#define TCP_LINGER2 8 /* Life time of orphaned FIN-WAIT-2 state */
48#define TCP_DEFER_ACCEPT 9 /* Wake up listener only when data arrive */
49#define TCP_WINDOW_CLAMP 10 /* Bound advertised window */
50#define TCP_INFO 11 /* Information about this connection. */
51#define TCP_QUICKACK 12 /* Bock/reenable quick ACKs. */
52#define TCP_CONGESTION 13 /* Congestion control algorithm. */
53#define TCP_MD5SIG 14 /* TCP MD5 Signature (RFC2385) */
54#define TCP_COOKIE_TRANSACTIONS 15 /* TCP Cookie Transactions */
55#define TCP_THIN_LINEAR_TIMEOUTS 16 /* Use linear timeouts for thin streams*/
56#define TCP_THIN_DUPACK 17 /* Fast retrans. after 1 dupack */
57#define TCP_USER_TIMEOUT 18 /* How long for loss retry before timeout */
58#define TCP_REPAIR 19 /* TCP sock is under repair right now */
59#define TCP_REPAIR_QUEUE 20 /* Set TCP queue to repair */
60#define TCP_QUEUE_SEQ 21 /* Set sequence number of repaired queue. */
61#define TCP_REPAIR_OPTIONS 22 /* Repair TCP connection options */
62#define TCP_FASTOPEN 23 /* Enable FastOpen on listeners */
63#define TCP_TIMESTAMP 24 /* TCP time stamp */
64#define TCP_NOTSENT_LOWAT 25 /* Limit number of unsent bytes in
65 write queue. */
66#define TCP_CC_INFO 26 /* Get Congestion Control
67 (optional) info. */
68#define TCP_SAVE_SYN 27 /* Record SYN headers for new
69 connections. */
70#define TCP_SAVED_SYN 28 /* Get SYN headers recorded for
71 connection. */
72#define TCP_REPAIR_WINDOW 29 /* Get/set window parameters. */
73#define TCP_FASTOPEN_CONNECT 30 /* Attempt FastOpen with connect. */
74#define TCP_ULP 31 /* Attach a ULP to a TCP connection. */
75#define TCP_MD5SIG_EXT 32 /* TCP MD5 Signature with extensions. */
76
77#ifdef __USE_MISC
78# include <sys/types.h>
79# include <sys/socket.h>
80# include <stdint.h>
81
82typedef uint32_t tcp_seq;
83/*
84 * TCP header.
85 * Per RFC 793, September, 1981.
86 */
87struct tcphdr
88 {
89 __extension__ union
90 {
91 struct
92 {
93 uint16_t th_sport; /* source port */
94 uint16_t th_dport; /* destination port */
95 tcp_seq th_seq; /* sequence number */
96 tcp_seq th_ack; /* acknowledgement number */
97# if __BYTE_ORDER == __LITTLE_ENDIAN
98 uint8_t th_x2:4; /* (unused) */
99 uint8_t th_off:4; /* data offset */
100# endif
101# if __BYTE_ORDER == __BIG_ENDIAN
102 uint8_t th_off:4; /* data offset */
103 uint8_t th_x2:4; /* (unused) */
104# endif
105 uint8_t th_flags;
106# define TH_FIN 0x01
107# define TH_SYN 0x02
108# define TH_RST 0x04
109# define TH_PUSH 0x08
110# define TH_ACK 0x10
111# define TH_URG 0x20
112 uint16_t th_win; /* window */
113 uint16_t th_sum; /* checksum */
114 uint16_t th_urp; /* urgent pointer */
115 };
116 struct
117 {
118 uint16_t source;
119 uint16_t dest;
120 uint32_t seq;
121 uint32_t ack_seq;
122# if __BYTE_ORDER == __LITTLE_ENDIAN
123 uint16_t res1:4;
124 uint16_t doff:4;
125 uint16_t fin:1;
126 uint16_t syn:1;
127 uint16_t rst:1;
128 uint16_t psh:1;
129 uint16_t ack:1;
130 uint16_t urg:1;
131 uint16_t res2:2;
132# elif __BYTE_ORDER == __BIG_ENDIAN
133 uint16_t doff:4;
134 uint16_t res1:4;
135 uint16_t res2:2;
136 uint16_t urg:1;
137 uint16_t ack:1;
138 uint16_t psh:1;
139 uint16_t rst:1;
140 uint16_t syn:1;
141 uint16_t fin:1;
142# else
143# error "Adjust your <bits/endian.h> defines"
144# endif
145 uint16_t window;
146 uint16_t check;
147 uint16_t urg_ptr;
148 };
149 };
150};
151
152enum
153{
154 TCP_ESTABLISHED = 1,
155 TCP_SYN_SENT,
156 TCP_SYN_RECV,
157 TCP_FIN_WAIT1,
158 TCP_FIN_WAIT2,
159 TCP_TIME_WAIT,
160 TCP_CLOSE,
161 TCP_CLOSE_WAIT,
162 TCP_LAST_ACK,
163 TCP_LISTEN,
164 TCP_CLOSING /* now a valid state */
165};
166
167# define TCPOPT_EOL 0
168# define TCPOPT_NOP 1
169# define TCPOPT_MAXSEG 2
170# define TCPOLEN_MAXSEG 4
171# define TCPOPT_WINDOW 3
172# define TCPOLEN_WINDOW 3
173# define TCPOPT_SACK_PERMITTED 4 /* Experimental */
174# define TCPOLEN_SACK_PERMITTED 2
175# define TCPOPT_SACK 5 /* Experimental */
176# define TCPOPT_TIMESTAMP 8
177# define TCPOLEN_TIMESTAMP 10
178# define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */
179
180# define TCPOPT_TSTAMP_HDR \
181 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)
182
183/*
184 * Default maximum segment size for TCP.
185 * With an IP MSS of 576, this is 536,
186 * but 512 is probably more convenient.
187 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
188 */
189# define TCP_MSS 512
190
191# define TCP_MAXWIN 65535 /* largest value for (unscaled) window */
192
193# define TCP_MAX_WINSHIFT 14 /* maximum window shift */
194
195# define SOL_TCP 6 /* TCP level */
196
197
198# define TCPI_OPT_TIMESTAMPS 1
199# define TCPI_OPT_SACK 2
200# define TCPI_OPT_WSCALE 4
201# define TCPI_OPT_ECN 8 /* ECN was negociated at TCP session init */
202# define TCPI_OPT_ECN_SEEN 16 /* we received at least one packet with ECT */
203# define TCPI_OPT_SYN_DATA 32 /* SYN-ACK acked data in SYN sent or rcvd */
204
205/* Values for tcpi_state. */
206enum tcp_ca_state
207{
208 TCP_CA_Open = 0,
209 TCP_CA_Disorder = 1,
210 TCP_CA_CWR = 2,
211 TCP_CA_Recovery = 3,
212 TCP_CA_Loss = 4
213};
214
215struct tcp_info
216{
217 uint8_t tcpi_state;
218 uint8_t tcpi_ca_state;
219 uint8_t tcpi_retransmits;
220 uint8_t tcpi_probes;
221 uint8_t tcpi_backoff;
222 uint8_t tcpi_options;
223 uint8_t tcpi_snd_wscale : 4, tcpi_rcv_wscale : 4;
224
225 uint32_t tcpi_rto;
226 uint32_t tcpi_ato;
227 uint32_t tcpi_snd_mss;
228 uint32_t tcpi_rcv_mss;
229
230 uint32_t tcpi_unacked;
231 uint32_t tcpi_sacked;
232 uint32_t tcpi_lost;
233 uint32_t tcpi_retrans;
234 uint32_t tcpi_fackets;
235
236 /* Times. */
237 uint32_t tcpi_last_data_sent;
238 uint32_t tcpi_last_ack_sent; /* Not remembered, sorry. */
239 uint32_t tcpi_last_data_recv;
240 uint32_t tcpi_last_ack_recv;
241
242 /* Metrics. */
243 uint32_t tcpi_pmtu;
244 uint32_t tcpi_rcv_ssthresh;
245 uint32_t tcpi_rtt;
246 uint32_t tcpi_rttvar;
247 uint32_t tcpi_snd_ssthresh;
248 uint32_t tcpi_snd_cwnd;
249 uint32_t tcpi_advmss;
250 uint32_t tcpi_reordering;
251
252 uint32_t tcpi_rcv_rtt;
253 uint32_t tcpi_rcv_space;
254
255 uint32_t tcpi_total_retrans;
256};
257
258
259/* For TCP_MD5SIG socket option. */
260#define TCP_MD5SIG_MAXKEYLEN 80
261
262/* tcp_md5sig extension flags for TCP_MD5SIG_EXT. */
263#define TCP_MD5SIG_FLAG_PREFIX 1 /* Address prefix length. */
264
265struct tcp_md5sig
266{
267 struct sockaddr_storage tcpm_addr; /* Address associated. */
268 uint8_t tcpm_flags; /* Extension flags. */
269 uint8_t tcpm_prefixlen; /* Address prefix. */
270 uint16_t tcpm_keylen; /* Key length. */
271 uint32_t __tcpm_pad; /* Zero. */
272 uint8_t tcpm_key[TCP_MD5SIG_MAXKEYLEN]; /* Key (binary). */
273};
274
275/* For socket repair options. */
276struct tcp_repair_opt
277{
278 uint32_t opt_code;
279 uint32_t opt_val;
280};
281
282/* Queue to repair, for TCP_REPAIR_QUEUE. */
283enum
284{
285 TCP_NO_QUEUE,
286 TCP_RECV_QUEUE,
287 TCP_SEND_QUEUE,
288 TCP_QUEUES_NR,
289};
290
291/* For cookie transactions socket options. */
292#define TCP_COOKIE_MIN 8 /* 64-bits */
293#define TCP_COOKIE_MAX 16 /* 128-bits */
294#define TCP_COOKIE_PAIR_SIZE (2*TCP_COOKIE_MAX)
295
296/* Flags for both getsockopt and setsockopt */
297#define TCP_COOKIE_IN_ALWAYS (1 << 0) /* Discard SYN without cookie */
298#define TCP_COOKIE_OUT_NEVER (1 << 1) /* Prohibit outgoing cookies,
299 * supercedes everything. */
300
301/* Flags for getsockopt */
302#define TCP_S_DATA_IN (1 << 2) /* Was data received? */
303#define TCP_S_DATA_OUT (1 << 3) /* Was data sent? */
304
305#define TCP_MSS_DEFAULT 536U /* IPv4 (RFC1122, RFC2581) */
306#define TCP_MSS_DESIRED 1220U /* IPv6 (tunneled), EDNS0 (RFC3226) */
307
308struct tcp_cookie_transactions
309{
310 uint16_t tcpct_flags;
311 uint8_t __tcpct_pad1;
312 uint8_t tcpct_cookie_desired;
313 uint16_t tcpct_s_data_desired;
314 uint16_t tcpct_used;
315 uint8_t tcpct_value[TCP_MSS_DEFAULT];
316};
317
318/* For use with TCP_REPAIR_WINDOW. */
319struct tcp_repair_window
320{
321 uint32_t snd_wl1;
322 uint32_t snd_wnd;
323 uint32_t max_window;
324 uint32_t rcv_wnd;
325 uint32_t rcv_wup;
326};
327
328#endif /* Misc. */
329
330#endif /* netinet/tcp.h */
331