2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
6 * Definitions for the TCP protocol.
8 * Version: @(#)tcp.h 1.0.2 04/28/93
10 * Author: Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version
15 * 2 of the License, or (at your option) any later version.
20 #include <linux/types.h>
21 #include <asm/byteorder.h>
22 #include <linux/socket.h>
29 #if defined(__LITTLE_ENDIAN_BITFIELD)
40 #elif defined(__BIG_ENDIAN_BITFIELD)
52 #error "Adjust your <asm/byteorder.h> defines"
60 * The union cast uses a gcc extension to avoid aliasing problems
61 * (union is compatible to any of its members)
62 * This means this part of the code is -fstrict-aliasing safe now.
69 #define tcp_flag_word(tp) ( ((union tcp_word_hdr *)(tp))->words [3])
72 TCP_FLAG_CWR = __constant_htonl(0x00800000),
73 TCP_FLAG_ECE = __constant_htonl(0x00400000),
74 TCP_FLAG_URG = __constant_htonl(0x00200000),
75 TCP_FLAG_ACK = __constant_htonl(0x00100000),
76 TCP_FLAG_PSH = __constant_htonl(0x00080000),
77 TCP_FLAG_RST = __constant_htonl(0x00040000),
78 TCP_FLAG_SYN = __constant_htonl(0x00020000),
79 TCP_FLAG_FIN = __constant_htonl(0x00010000),
80 TCP_RESERVED_BITS = __constant_htonl(0x0F000000),
81 TCP_DATA_OFFSET = __constant_htonl(0xF0000000)
84 /* TCP socket options */
85 #define TCP_NODELAY 1 /* Turn off Nagle's algorithm. */
86 #define TCP_MAXSEG 2 /* Limit MSS */
87 #define TCP_CORK 3 /* Never send partially complete segments */
88 #define TCP_KEEPIDLE 4 /* Start keeplives after this period */
89 #define TCP_KEEPINTVL 5 /* Interval between keepalives */
90 #define TCP_KEEPCNT 6 /* Number of keepalives before death */
91 #define TCP_SYNCNT 7 /* Number of SYN retransmits */
92 #define TCP_LINGER2 8 /* Life time of orphaned FIN-WAIT-2 state */
93 #define TCP_DEFER_ACCEPT 9 /* Wake up listener only when data arrive */
94 #define TCP_WINDOW_CLAMP 10 /* Bound advertised window */
95 #define TCP_INFO 11 /* Information about this connection. */
96 #define TCP_QUICKACK 12 /* Block/reenable quick acks */
97 #define TCP_CONGESTION 13 /* Congestion control algorithm */
98 #define TCP_MD5SIG 14 /* TCP MD5 Signature (RFC2385) */
100 #define TCPI_OPT_TIMESTAMPS 1
101 #define TCPI_OPT_SACK 2
102 #define TCPI_OPT_WSCALE 4
103 #define TCPI_OPT_ECN 8
108 #define TCPF_CA_Open (1<<TCP_CA_Open)
110 #define TCPF_CA_Disorder (1<<TCP_CA_Disorder)
112 #define TCPF_CA_CWR (1<<TCP_CA_CWR)
114 #define TCPF_CA_Recovery (1<<TCP_CA_Recovery)
116 #define TCPF_CA_Loss (1<<TCP_CA_Loss)
123 __u8 tcpi_retransmits;
127 __u8 tcpi_snd_wscale : 4, tcpi_rcv_wscale : 4;
141 __u32 tcpi_last_data_sent;
142 __u32 tcpi_last_ack_sent; /* Not remembered, sorry. */
143 __u32 tcpi_last_data_recv;
144 __u32 tcpi_last_ack_recv;
148 __u32 tcpi_rcv_ssthresh;
151 __u32 tcpi_snd_ssthresh;
154 __u32 tcpi_reordering;
157 __u32 tcpi_rcv_space;
159 __u32 tcpi_total_retrans;
162 /* for TCP_MD5SIG socket option */
163 #define TCP_MD5SIG_MAXKEYLEN 80
166 struct __kernel_sockaddr_storage tcpm_addr; /* address associated */
167 __u16 __tcpm_pad1; /* zero */
168 __u16 tcpm_keylen; /* key length */
169 __u32 __tcpm_pad2; /* zero */
170 __u8 tcpm_key[TCP_MD5SIG_MAXKEYLEN]; /* key (binary) */
175 #include <linux/skbuff.h>
176 #include <linux/dmaengine.h>
177 #include <net/sock.h>
178 #include <net/inet_connection_sock.h>
179 #include <net/inet_timewait_sock.h>
181 static inline unsigned int tcp_hdrlen(const struct sk_buff *skb)
183 return skb->h.th->doff * 4;
186 static inline unsigned int tcp_optlen(const struct sk_buff *skb)
188 return (skb->h.th->doff - 5) * 4;
191 /* This defines a selective acknowledgement block. */
192 struct tcp_sack_block_wire {
197 struct tcp_sack_block {
202 struct tcp_options_received {
204 long ts_recent_stamp;/* Time we stored ts_recent (for aging) */
205 u32 ts_recent; /* Time stamp to echo next */
206 u32 rcv_tsval; /* Time stamp value */
207 u32 rcv_tsecr; /* Time stamp echo reply */
208 u16 saw_tstamp : 1, /* Saw TIMESTAMP on last packet */
209 tstamp_ok : 1, /* TIMESTAMP seen on SYN packet */
210 dsack : 1, /* D-SACK is scheduled */
211 wscale_ok : 1, /* Wscale seen on SYN packet */
212 sack_ok : 4, /* SACK seen on SYN packet */
213 snd_wscale : 4, /* Window scaling received from sender */
214 rcv_wscale : 4; /* Window scaling to send to receiver */
216 u8 eff_sacks; /* Size of SACK array to send with next packet */
217 u8 num_sacks; /* Number of SACK blocks */
218 u16 user_mss; /* mss requested by user in ioctl */
219 u16 mss_clamp; /* Maximal mss, negotiated at connection setup */
222 struct tcp_request_sock {
223 struct inet_request_sock req;
224 #ifdef CONFIG_TCP_MD5SIG
225 /* Only used by TCP MD5 Signature so far. */
226 struct tcp_request_sock_ops *af_specific;
232 static inline struct tcp_request_sock *tcp_rsk(const struct request_sock *req)
234 return (struct tcp_request_sock *)req;
238 /* inet_connection_sock has to be the first member of tcp_sock */
239 struct inet_connection_sock inet_conn;
240 u16 tcp_header_len; /* Bytes of tcp header to send */
241 u16 xmit_size_goal; /* Goal for segmenting output packets */
244 * Header prediction flags
245 * 0x5?10 << 16 + snd_wnd in net byte order
250 * RFC793 variables by their proper names. This means you can
251 * read the code and the spec side by side (and laugh ...)
252 * See RFC793 and RFC1122. The RFC writes these in capitals.
254 u32 rcv_nxt; /* What we want to receive next */
255 u32 copied_seq; /* Head of yet unread data */
256 u32 rcv_wup; /* rcv_nxt on last window update sent */
257 u32 snd_nxt; /* Next sequence we send */
259 u32 snd_una; /* First byte we want an ack for */
260 u32 snd_sml; /* Last byte of the most recently transmitted small packet */
261 u32 rcv_tstamp; /* timestamp of last received ACK (for keepalives) */
262 u32 lsndtime; /* timestamp of last sent data packet (for restart window) */
264 /* Data for direct copy to user */
266 struct sk_buff_head prequeue;
267 struct task_struct *task;
271 #ifdef CONFIG_NET_DMA
272 /* members for async copy */
273 struct dma_chan *dma_chan;
275 struct dma_pinned_list *pinned_list;
276 dma_cookie_t dma_cookie;
280 u32 snd_wl1; /* Sequence for window update */
281 u32 snd_wnd; /* The window we expect to receive */
282 u32 max_window; /* Maximal window ever seen from peer */
283 u32 mss_cache; /* Cached effective mss, not including SACKS */
285 u32 window_clamp; /* Maximal window to advertise */
286 u32 rcv_ssthresh; /* Current window clamp */
288 u32 frto_highmark; /* snd_nxt when RTO occurred */
289 u8 reordering; /* Packet reordering metric. */
290 u8 frto_counter; /* Number of new acks after RTO */
291 u8 nonagle; /* Disable Nagle algorithm? */
292 u8 keepalive_probes; /* num of allowed keep alive probes */
294 /* RTT measurement */
295 u32 srtt; /* smoothed round trip time << 3 */
296 u32 mdev; /* medium deviation */
297 u32 mdev_max; /* maximal mdev for the last rtt period */
298 u32 rttvar; /* smoothed mdev_max */
299 u32 rtt_seq; /* sequence number to update rttvar */
301 u32 packets_out; /* Packets which are "in flight" */
302 u32 left_out; /* Packets which leaved network */
303 u32 retrans_out; /* Retransmitted packets out */
305 * Options received (usually on last packet, some only on SYN packets).
307 struct tcp_options_received rx_opt;
310 * Slow start and congestion control (see also Nagle, and Karn & Partridge)
312 u32 snd_ssthresh; /* Slow start size threshold */
313 u32 snd_cwnd; /* Sending congestion window */
314 u16 snd_cwnd_cnt; /* Linear increase counter */
315 u32 snd_cwnd_clamp; /* Do not allow snd_cwnd to grow above this */
319 struct sk_buff_head out_of_order_queue; /* Out of order segments go here */
321 u32 rcv_wnd; /* Current receiver window */
322 u32 write_seq; /* Tail(+1) of data held in tcp send buffer */
323 u32 pushed_seq; /* Last pushed seq, required to talk to windows */
326 struct tcp_sack_block duplicate_sack[1]; /* D-SACK block */
327 struct tcp_sack_block selective_acks[4]; /* The SACKS themselves*/
329 struct tcp_sack_block_wire recv_sack_cache[4];
331 /* from STCP, retrans queue hinting */
332 struct sk_buff* lost_skb_hint;
334 struct sk_buff *scoreboard_skb_hint;
335 struct sk_buff *retransmit_skb_hint;
336 struct sk_buff *forward_skb_hint;
337 struct sk_buff *fastpath_skb_hint;
339 int fastpath_cnt_hint;
341 int retransmit_cnt_hint;
342 int forward_cnt_hint;
344 u16 advmss; /* Advertised MSS */
345 u16 prior_ssthresh; /* ssthresh saved at recovery start */
346 u32 lost_out; /* Lost packets */
347 u32 sacked_out; /* SACK'd packets */
348 u32 fackets_out; /* FACK'd packets */
349 u32 high_seq; /* snd_nxt at onset of congestion */
351 u32 retrans_stamp; /* Timestamp of the last retransmit,
352 * also used in SYN-SENT to remember stamp of
354 u32 undo_marker; /* tracking retrans started here. */
355 int undo_retrans; /* number of undoable retransmissions. */
356 u32 urg_seq; /* Seq of received urgent pointer */
357 u16 urg_data; /* Saved octet of OOB data and control flags */
358 u8 urg_mode; /* In urgent mode */
359 u8 ecn_flags; /* ECN status bits. */
360 u32 snd_up; /* Urgent pointer */
362 u32 total_retrans; /* Total retransmits for entire connection */
363 u32 bytes_acked; /* Appropriate Byte Counting - RFC3465 */
365 unsigned int keepalive_time; /* time before keep alive takes place */
366 unsigned int keepalive_intvl; /* time interval between keep alive probes */
369 unsigned long last_synq_overflow;
373 /* Receiver side RTT estimation */
380 /* Receiver queue space */
387 /* TCP-specific MTU probe information. */
393 #ifdef CONFIG_TCP_MD5SIG
394 /* TCP AF-Specific parts; only used by MD5 Signature support so far */
395 struct tcp_sock_af_ops *af_specific;
397 /* TCP MD5 Signagure Option information */
398 struct tcp_md5sig_info *md5sig_info;
402 static inline struct tcp_sock *tcp_sk(const struct sock *sk)
404 return (struct tcp_sock *)sk;
407 struct tcp_timewait_sock {
408 struct inet_timewait_sock tw_sk;
413 long tw_ts_recent_stamp;
414 #ifdef CONFIG_TCP_MD5SIG
416 u8 tw_md5_key[TCP_MD5SIG_MAXKEYLEN];
420 static inline struct tcp_timewait_sock *tcp_twsk(const struct sock *sk)
422 return (struct tcp_timewait_sock *)sk;
427 #endif /* _LINUX_TCP_H */