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
65#ifdef __USE_MISC
66# include <sys/types.h>
67# include <sys/socket.h>
68
69# ifdef __FAVOR_BSD
70typedef u_int32_t tcp_seq;
71/*
72 * TCP header.
73 * Per RFC 793, September, 1981.
74 */
75struct tcphdr
76 {
77 u_int16_t th_sport; /* source port */
78 u_int16_t th_dport; /* destination port */
79 tcp_seq th_seq; /* sequence number */
80 tcp_seq th_ack; /* acknowledgement number */
81# if __BYTE_ORDER == __LITTLE_ENDIAN
82 u_int8_t th_x2:4; /* (unused) */
83 u_int8_t th_off:4; /* data offset */
84# endif
85# if __BYTE_ORDER == __BIG_ENDIAN
86 u_int8_t th_off:4; /* data offset */
87 u_int8_t th_x2:4; /* (unused) */
88# endif
89 u_int8_t th_flags;
90# define TH_FIN 0x01
91# define TH_SYN 0x02
92# define TH_RST 0x04
93# define TH_PUSH 0x08
94# define TH_ACK 0x10
95# define TH_URG 0x20
96 u_int16_t th_win; /* window */
97 u_int16_t th_sum; /* checksum */
98 u_int16_t th_urp; /* urgent pointer */
99};
100
101# else /* !__FAVOR_BSD */
102struct tcphdr
103 {
104 u_int16_t source;
105 u_int16_t dest;
106 u_int32_t seq;
107 u_int32_t ack_seq;
108# if __BYTE_ORDER == __LITTLE_ENDIAN
109 u_int16_t res1:4;
110 u_int16_t doff:4;
111 u_int16_t fin:1;
112 u_int16_t syn:1;
113 u_int16_t rst:1;
114 u_int16_t psh:1;
115 u_int16_t ack:1;
116 u_int16_t urg:1;
117 u_int16_t res2:2;
118# elif __BYTE_ORDER == __BIG_ENDIAN
119 u_int16_t doff:4;
120 u_int16_t res1:4;
121 u_int16_t res2:2;
122 u_int16_t urg:1;
123 u_int16_t ack:1;
124 u_int16_t psh:1;
125 u_int16_t rst:1;
126 u_int16_t syn:1;
127 u_int16_t fin:1;
128# else
129# error "Adjust your <bits/endian.h> defines"
130# endif
131 u_int16_t window;
132 u_int16_t check;
133 u_int16_t urg_ptr;
134};
135# endif /* __FAVOR_BSD */
136
137enum
138{
139 TCP_ESTABLISHED = 1,
140 TCP_SYN_SENT,
141 TCP_SYN_RECV,
142 TCP_FIN_WAIT1,
143 TCP_FIN_WAIT2,
144 TCP_TIME_WAIT,
145 TCP_CLOSE,
146 TCP_CLOSE_WAIT,
147 TCP_LAST_ACK,
148 TCP_LISTEN,
149 TCP_CLOSING /* now a valid state */
150};
151
152# define TCPOPT_EOL 0
153# define TCPOPT_NOP 1
154# define TCPOPT_MAXSEG 2
155# define TCPOLEN_MAXSEG 4
156# define TCPOPT_WINDOW 3
157# define TCPOLEN_WINDOW 3
158# define TCPOPT_SACK_PERMITTED 4 /* Experimental */
159# define TCPOLEN_SACK_PERMITTED 2
160# define TCPOPT_SACK 5 /* Experimental */
161# define TCPOPT_TIMESTAMP 8
162# define TCPOLEN_TIMESTAMP 10
163# define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */
164
165# define TCPOPT_TSTAMP_HDR \
166 (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)
167
168/*
169 * Default maximum segment size for TCP.
170 * With an IP MSS of 576, this is 536,
171 * but 512 is probably more convenient.
172 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
173 */
174# define TCP_MSS 512
175
176# define TCP_MAXWIN 65535 /* largest value for (unscaled) window */
177
178# define TCP_MAX_WINSHIFT 14 /* maximum window shift */
179
180# define SOL_TCP 6 /* TCP level */
181
182
183# define TCPI_OPT_TIMESTAMPS 1
184# define TCPI_OPT_SACK 2
185# define TCPI_OPT_WSCALE 4
186# define TCPI_OPT_ECN 8 /* ECN was negociated at TCP session init */
187# define TCPI_OPT_ECN_SEEN 16 /* we received at least one packet with ECT */
188# define TCPI_OPT_SYN_DATA 32 /* SYN-ACK acked data in SYN sent or rcvd */
189
190/* Values for tcpi_state. */
191enum tcp_ca_state
192{
193 TCP_CA_Open = 0,
194 TCP_CA_Disorder = 1,
195 TCP_CA_CWR = 2,
196 TCP_CA_Recovery = 3,
197 TCP_CA_Loss = 4
198};
199
200struct tcp_info
201{
202 u_int8_t tcpi_state;
203 u_int8_t tcpi_ca_state;
204 u_int8_t tcpi_retransmits;
205 u_int8_t tcpi_probes;
206 u_int8_t tcpi_backoff;
207 u_int8_t tcpi_options;
208 u_int8_t tcpi_snd_wscale : 4, tcpi_rcv_wscale : 4;
209
210 u_int32_t tcpi_rto;
211 u_int32_t tcpi_ato;
212 u_int32_t tcpi_snd_mss;
213 u_int32_t tcpi_rcv_mss;
214
215 u_int32_t tcpi_unacked;
216 u_int32_t tcpi_sacked;
217 u_int32_t tcpi_lost;
218 u_int32_t tcpi_retrans;
219 u_int32_t tcpi_fackets;
220
221 /* Times. */
222 u_int32_t tcpi_last_data_sent;
223 u_int32_t tcpi_last_ack_sent; /* Not remembered, sorry. */
224 u_int32_t tcpi_last_data_recv;
225 u_int32_t tcpi_last_ack_recv;
226
227 /* Metrics. */
228 u_int32_t tcpi_pmtu;
229 u_int32_t tcpi_rcv_ssthresh;
230 u_int32_t tcpi_rtt;
231 u_int32_t tcpi_rttvar;
232 u_int32_t tcpi_snd_ssthresh;
233 u_int32_t tcpi_snd_cwnd;
234 u_int32_t tcpi_advmss;
235 u_int32_t tcpi_reordering;
236
237 u_int32_t tcpi_rcv_rtt;
238 u_int32_t tcpi_rcv_space;
239
240 u_int32_t tcpi_total_retrans;
241};
242
243
244/* For TCP_MD5SIG socket option. */
245#define TCP_MD5SIG_MAXKEYLEN 80
246
247struct tcp_md5sig
248{
249 struct sockaddr_storage tcpm_addr; /* Address associated. */
250 u_int16_t __tcpm_pad1; /* Zero. */
251 u_int16_t tcpm_keylen; /* Key length. */
252 u_int32_t __tcpm_pad2; /* Zero. */
253 u_int8_t tcpm_key[TCP_MD5SIG_MAXKEYLEN]; /* Key (binary). */
254};
255
256/* For socket repair options. */
257struct tcp_repair_opt
258{
259 u_int32_t opt_code;
260 u_int32_t opt_val;
261};
262
263/* Queue to repair, for TCP_REPAIR_QUEUE. */
264enum
265{
266 TCP_NO_QUEUE,
267 TCP_RECV_QUEUE,
268 TCP_SEND_QUEUE,
269 TCP_QUEUES_NR,
270};
271
272/* For cookie transactions socket options. */
273#define TCP_COOKIE_MIN 8 /* 64-bits */
274#define TCP_COOKIE_MAX 16 /* 128-bits */
275#define TCP_COOKIE_PAIR_SIZE (2*TCP_COOKIE_MAX)
276
277/* Flags for both getsockopt and setsockopt */
278#define TCP_COOKIE_IN_ALWAYS (1 << 0) /* Discard SYN without cookie */
279#define TCP_COOKIE_OUT_NEVER (1 << 1) /* Prohibit outgoing cookies,
280 * supercedes everything. */
281
282/* Flags for getsockopt */
283#define TCP_S_DATA_IN (1 << 2) /* Was data received? */
284#define TCP_S_DATA_OUT (1 << 3) /* Was data sent? */
285
286#define TCP_MSS_DEFAULT 536U /* IPv4 (RFC1122, RFC2581) */
287#define TCP_MSS_DESIRED 1220U /* IPv6 (tunneled), EDNS0 (RFC3226) */
288
289struct tcp_cookie_transactions
290{
291 u_int16_t tcpct_flags;
292 u_int8_t __tcpct_pad1;
293 u_int8_t tcpct_cookie_desired;
294 u_int16_t tcpct_s_data_desired;
295 u_int16_t tcpct_used;
296 u_int8_t tcpct_value[TCP_MSS_DEFAULT];
297};
298
299#endif /* Misc. */
300
301#endif /* netinet/tcp.h */
302