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.
21 #include <linux/skbuff.h>
23 #include <net/inet_connection_sock.h>
24 #include <net/inet_timewait_sock.h>
25 #include <uapi/linux/tcp.h>
27 static inline struct tcphdr *tcp_hdr(const struct sk_buff *skb)
29 return (struct tcphdr *)skb_transport_header(skb);
32 static inline unsigned int __tcp_hdrlen(const struct tcphdr *th)
37 static inline unsigned int tcp_hdrlen(const struct sk_buff *skb)
39 return __tcp_hdrlen(tcp_hdr(skb));
42 static inline struct tcphdr *inner_tcp_hdr(const struct sk_buff *skb)
44 return (struct tcphdr *)skb_inner_transport_header(skb);
47 static inline unsigned int inner_tcp_hdrlen(const struct sk_buff *skb)
49 return inner_tcp_hdr(skb)->doff * 4;
52 static inline unsigned int tcp_optlen(const struct sk_buff *skb)
54 return (tcp_hdr(skb)->doff - 5) * 4;
58 #define TCP_FASTOPEN_COOKIE_MIN 4 /* Min Fast Open Cookie size in bytes */
59 #define TCP_FASTOPEN_COOKIE_MAX 16 /* Max Fast Open Cookie size in bytes */
60 #define TCP_FASTOPEN_COOKIE_SIZE 8 /* the size employed by this impl. */
62 /* TCP Fast Open Cookie as stored in memory */
63 struct tcp_fastopen_cookie {
65 u8 val[TCP_FASTOPEN_COOKIE_MAX];
66 #if IS_ENABLED(CONFIG_IPV6)
71 bool exp; /* In RFC6994 experimental option format */
74 /* This defines a selective acknowledgement block. */
75 struct tcp_sack_block_wire {
80 struct tcp_sack_block {
85 /*These are used to set the sack_ok field in struct tcp_options_received */
86 #define TCP_SACK_SEEN (1 << 0) /*1 = peer is SACK capable, */
87 #define TCP_FACK_ENABLED (1 << 1) /*1 = FACK is enabled locally*/
88 #define TCP_DSACK_SEEN (1 << 2) /*1 = DSACK was received from peer*/
90 struct tcp_options_received {
92 long ts_recent_stamp;/* Time we stored ts_recent (for aging) */
93 u32 ts_recent; /* Time stamp to echo next */
94 u32 rcv_tsval; /* Time stamp value */
95 u32 rcv_tsecr; /* Time stamp echo reply */
96 u16 saw_tstamp : 1, /* Saw TIMESTAMP on last packet */
97 tstamp_ok : 1, /* TIMESTAMP seen on SYN packet */
98 dsack : 1, /* D-SACK is scheduled */
99 wscale_ok : 1, /* Wscale seen on SYN packet */
100 sack_ok : 4, /* SACK seen on SYN packet */
101 snd_wscale : 4, /* Window scaling received from sender */
102 rcv_wscale : 4; /* Window scaling to send to receiver */
103 u8 num_sacks; /* Number of SACK blocks */
104 u16 user_mss; /* mss requested by user in ioctl */
105 u16 mss_clamp; /* Maximal mss, negotiated at connection setup */
108 static inline void tcp_clear_options(struct tcp_options_received *rx_opt)
110 rx_opt->tstamp_ok = rx_opt->sack_ok = 0;
111 rx_opt->wscale_ok = rx_opt->snd_wscale = 0;
114 /* This is the max number of SACKS that we'll generate and process. It's safe
115 * to increase this, although since:
116 * size = TCPOLEN_SACK_BASE_ALIGNED (4) + n * TCPOLEN_SACK_PERBLOCK (8)
117 * only four options will fit in a standard TCP header */
118 #define TCP_NUM_SACKS 4
120 struct tcp_request_sock_ops;
122 struct tcp_request_sock {
123 struct inet_request_sock req;
124 const struct tcp_request_sock_ops *af_specific;
125 struct skb_mstamp snt_synack; /* first SYNACK sent time */
130 u32 last_oow_ack_time; /* last SYNACK */
131 u32 rcv_nxt; /* the ack # by SYNACK. For
132 * FastOpen it's the seq#
137 static inline struct tcp_request_sock *tcp_rsk(const struct request_sock *req)
139 return (struct tcp_request_sock *)req;
143 /* inet_connection_sock has to be the first member of tcp_sock */
144 struct inet_connection_sock inet_conn;
145 u16 tcp_header_len; /* Bytes of tcp header to send */
146 u16 gso_segs; /* Max number of segs per GSO packet */
149 * Header prediction flags
150 * 0x5?10 << 16 + snd_wnd in net byte order
155 * RFC793 variables by their proper names. This means you can
156 * read the code and the spec side by side (and laugh ...)
157 * See RFC793 and RFC1122. The RFC writes these in capitals.
159 u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived
160 * sum(delta(rcv_nxt)), or how many bytes
163 u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn
164 * total number of segments in.
166 u32 rcv_nxt; /* What we want to receive next */
167 u32 copied_seq; /* Head of yet unread data */
168 u32 rcv_wup; /* rcv_nxt on last window update sent */
169 u32 snd_nxt; /* Next sequence we send */
170 u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut
171 * The total number of segments sent.
173 u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked
174 * sum(delta(snd_una)), or how many bytes
177 struct u64_stats_sync syncp; /* protects 64bit vars (cf tcp_get_info()) */
179 u32 snd_una; /* First byte we want an ack for */
180 u32 snd_sml; /* Last byte of the most recently transmitted small packet */
181 u32 rcv_tstamp; /* timestamp of last received ACK (for keepalives) */
182 u32 lsndtime; /* timestamp of last sent data packet (for restart window) */
183 u32 last_oow_ack_time; /* timestamp of last out-of-window ACK */
185 u32 tsoffset; /* timestamp offset */
187 struct list_head tsq_node; /* anchor in tsq_tasklet.head list */
188 unsigned long tsq_flags;
190 /* Data for direct copy to user */
192 struct sk_buff_head prequeue;
193 struct task_struct *task;
199 u32 snd_wl1; /* Sequence for window update */
200 u32 snd_wnd; /* The window we expect to receive */
201 u32 max_window; /* Maximal window ever seen from peer */
202 u32 mss_cache; /* Cached effective mss, not including SACKS */
204 u32 window_clamp; /* Maximal window to advertise */
205 u32 rcv_ssthresh; /* Current window clamp */
207 /* Information of the most recently (s)acked skb */
209 struct skb_mstamp mstamp; /* (Re)sent time of the skb */
210 u8 advanced; /* mstamp advanced since last lost marking */
211 u8 reord; /* reordering detected */
213 u16 advmss; /* Advertised MSS */
214 u8 tlp_retrans:1, /* TLP is a retransmission */
216 u8 nonagle : 4,/* Disable Nagle algorithm? */
217 thin_lto : 1,/* Use linear timeouts for thin streams */
218 thin_dupack : 1,/* Fast retransmit on first dupack */
220 frto : 1;/* F-RTO (RFC5682) activated in CA_Loss */
222 u8 do_early_retrans:1,/* Enable RFC5827 early-retransmit */
223 syn_data:1, /* SYN includes data */
224 syn_fastopen:1, /* SYN includes Fast Open option */
225 syn_fastopen_exp:1,/* SYN includes Fast Open exp. option */
226 syn_data_acked:1,/* data in SYN is acked by SYN-ACK */
227 save_syn:1, /* Save headers of SYN packet */
228 is_cwnd_limited:1;/* forward progress limited by snd_cwnd? */
229 u32 tlp_high_seq; /* snd_nxt at the time of TLP */
231 /* RTT measurement */
232 u32 srtt_us; /* smoothed round trip time << 3 in usecs */
233 u32 mdev_us; /* medium deviation */
234 u32 mdev_max_us; /* maximal mdev for the last rtt period */
235 u32 rttvar_us; /* smoothed mdev_max */
236 u32 rtt_seq; /* sequence number to update rttvar */
238 u32 rtt, ts; /* RTT in usec and sampling time in jiffies. */
241 u32 packets_out; /* Packets which are "in flight" */
242 u32 retrans_out; /* Retransmitted packets out */
243 u32 max_packets_out; /* max packets_out in last window */
244 u32 max_packets_seq; /* right edge of max_packets_out flight */
246 u16 urg_data; /* Saved octet of OOB data and control flags */
247 u8 ecn_flags; /* ECN status bits. */
248 u8 keepalive_probes; /* num of allowed keep alive probes */
249 u32 reordering; /* Packet reordering metric. */
250 u32 snd_up; /* Urgent pointer */
253 * Options received (usually on last packet, some only on SYN packets).
255 struct tcp_options_received rx_opt;
258 * Slow start and congestion control (see also Nagle, and Karn & Partridge)
260 u32 snd_ssthresh; /* Slow start size threshold */
261 u32 snd_cwnd; /* Sending congestion window */
262 u32 snd_cwnd_cnt; /* Linear increase counter */
263 u32 snd_cwnd_clamp; /* Do not allow snd_cwnd to grow above this */
266 u32 prior_cwnd; /* Congestion window at start of Recovery. */
267 u32 prr_delivered; /* Number of newly delivered packets to
268 * receiver in Recovery. */
269 u32 prr_out; /* Total number of pkts sent during Recovery. */
271 u32 rcv_wnd; /* Current receiver window */
272 u32 write_seq; /* Tail(+1) of data held in tcp send buffer */
273 u32 notsent_lowat; /* TCP_NOTSENT_LOWAT */
274 u32 pushed_seq; /* Last pushed seq, required to talk to windows */
275 u32 lost_out; /* Lost packets */
276 u32 sacked_out; /* SACK'd packets */
277 u32 fackets_out; /* FACK'd packets */
279 /* from STCP, retrans queue hinting */
280 struct sk_buff* lost_skb_hint;
281 struct sk_buff *retransmit_skb_hint;
283 /* OOO segments go in this rbtree. Socket lock must be held. */
284 struct rb_root out_of_order_queue;
285 struct sk_buff *ooo_last_skb; /* cache rb_last(out_of_order_queue) */
287 /* SACKs data, these 2 need to be together (see tcp_options_write) */
288 struct tcp_sack_block duplicate_sack[1]; /* D-SACK block */
289 struct tcp_sack_block selective_acks[4]; /* The SACKS themselves*/
291 struct tcp_sack_block recv_sack_cache[4];
293 struct sk_buff *highest_sack; /* skb just after the highest
294 * skb with SACKed bit set
295 * (validity guaranteed only if
300 u32 retransmit_high; /* L-bits may be on up to this seqno */
302 u32 prior_ssthresh; /* ssthresh saved at recovery start */
303 u32 high_seq; /* snd_nxt at onset of congestion */
305 u32 retrans_stamp; /* Timestamp of the last retransmit,
306 * also used in SYN-SENT to remember stamp of
308 u32 undo_marker; /* snd_una upon a new recovery episode. */
309 int undo_retrans; /* number of undoable retransmissions. */
310 u32 total_retrans; /* Total retransmits for entire connection */
312 u32 urg_seq; /* Seq of received urgent pointer */
313 unsigned int keepalive_time; /* time before keep alive takes place */
314 unsigned int keepalive_intvl; /* time interval between keep alive probes */
318 /* Receiver side RTT estimation */
325 /* Receiver queue space */
332 /* TCP-specific MTU probe information. */
337 u32 mtu_info; /* We received an ICMP_FRAG_NEEDED / ICMPV6_PKT_TOOBIG
338 * while socket was owned by user.
341 #ifdef CONFIG_TCP_MD5SIG
342 /* TCP AF-Specific parts; only used by MD5 Signature support so far */
343 const struct tcp_sock_af_ops *af_specific;
345 /* TCP MD5 Signature Option information */
346 struct tcp_md5sig_info __rcu *md5sig_info;
349 /* TCP fastopen related information */
350 struct tcp_fastopen_request *fastopen_req;
351 /* fastopen_rsk points to request_sock that resulted in this big
352 * socket. Used to retransmit SYNACKs etc.
354 struct request_sock *fastopen_rsk;
361 TCP_TSQ_DEFERRED, /* tcp_tasklet_func() found socket was owned */
362 TCP_WRITE_TIMER_DEFERRED, /* tcp_write_timer() found socket was owned */
363 TCP_DELACK_TIMER_DEFERRED, /* tcp_delack_timer() found socket was owned */
364 TCP_MTU_REDUCED_DEFERRED, /* tcp_v{4|6}_err() could not call
365 * tcp_v{4|6}_mtu_reduced()
369 static inline struct tcp_sock *tcp_sk(const struct sock *sk)
371 return (struct tcp_sock *)sk;
374 struct tcp_timewait_sock {
375 struct inet_timewait_sock tw_sk;
376 #define tw_rcv_nxt tw_sk.__tw_common.skc_tw_rcv_nxt
377 #define tw_snd_nxt tw_sk.__tw_common.skc_tw_snd_nxt
382 /* The time we sent the last out-of-window ACK: */
383 u32 tw_last_oow_ack_time;
385 long tw_ts_recent_stamp;
386 #ifdef CONFIG_TCP_MD5SIG
387 struct tcp_md5sig_key *tw_md5_key;
391 static inline struct tcp_timewait_sock *tcp_twsk(const struct sock *sk)
393 return (struct tcp_timewait_sock *)sk;
396 static inline bool tcp_passive_fastopen(const struct sock *sk)
398 return (sk->sk_state == TCP_SYN_RECV &&
399 tcp_sk(sk)->fastopen_rsk != NULL);
402 static inline void fastopen_queue_tune(struct sock *sk, int backlog)
404 struct request_sock_queue *queue = &inet_csk(sk)->icsk_accept_queue;
405 int somaxconn = READ_ONCE(sock_net(sk)->core.sysctl_somaxconn);
407 queue->fastopenq.max_qlen = min_t(unsigned int, backlog, somaxconn);
410 static inline void tcp_move_syn(struct tcp_sock *tp,
411 struct request_sock *req)
413 tp->saved_syn = req->saved_syn;
414 req->saved_syn = NULL;
417 static inline void tcp_saved_syn_free(struct tcp_sock *tp)
419 kfree(tp->saved_syn);
420 tp->saved_syn = NULL;
423 int tcp_skb_shift(struct sk_buff *to, struct sk_buff *from, int pcount,
426 #endif /* _LINUX_TCP_H */