foundations of per-cgroup memory pressure controlling.
[linux-2.6/libata-dev.git] / include / net / tcp.h
blob913473b4eda7046560d30d0ec2144508b616e8bb
1 /*
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 module.
8 * Version: @(#)tcp.h 1.0.5 05/23/93
10 * Authors: Ross Biro
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
18 #ifndef _TCP_H
19 #define _TCP_H
21 #define FASTRETRANS_DEBUG 1
23 #include <linux/list.h>
24 #include <linux/tcp.h>
25 #include <linux/slab.h>
26 #include <linux/cache.h>
27 #include <linux/percpu.h>
28 #include <linux/skbuff.h>
29 #include <linux/dmaengine.h>
30 #include <linux/crypto.h>
31 #include <linux/cryptohash.h>
32 #include <linux/kref.h>
34 #include <net/inet_connection_sock.h>
35 #include <net/inet_timewait_sock.h>
36 #include <net/inet_hashtables.h>
37 #include <net/checksum.h>
38 #include <net/request_sock.h>
39 #include <net/sock.h>
40 #include <net/snmp.h>
41 #include <net/ip.h>
42 #include <net/tcp_states.h>
43 #include <net/inet_ecn.h>
44 #include <net/dst.h>
46 #include <linux/seq_file.h>
47 #include <linux/memcontrol.h>
49 extern struct inet_hashinfo tcp_hashinfo;
51 extern struct percpu_counter tcp_orphan_count;
52 extern void tcp_time_wait(struct sock *sk, int state, int timeo);
54 #define MAX_TCP_HEADER (128 + MAX_HEADER)
55 #define MAX_TCP_OPTION_SPACE 40
57 /*
58 * Never offer a window over 32767 without using window scaling. Some
59 * poor stacks do signed 16bit maths!
61 #define MAX_TCP_WINDOW 32767U
63 /* Offer an initial receive window of 10 mss. */
64 #define TCP_DEFAULT_INIT_RCVWND 10
66 /* Minimal accepted MSS. It is (60+60+8) - (20+20). */
67 #define TCP_MIN_MSS 88U
69 /* The least MTU to use for probing */
70 #define TCP_BASE_MSS 512
72 /* After receiving this amount of duplicate ACKs fast retransmit starts. */
73 #define TCP_FASTRETRANS_THRESH 3
75 /* Maximal reordering. */
76 #define TCP_MAX_REORDERING 127
78 /* Maximal number of ACKs sent quickly to accelerate slow-start. */
79 #define TCP_MAX_QUICKACKS 16U
81 /* urg_data states */
82 #define TCP_URG_VALID 0x0100
83 #define TCP_URG_NOTYET 0x0200
84 #define TCP_URG_READ 0x0400
86 #define TCP_RETR1 3 /*
87 * This is how many retries it does before it
88 * tries to figure out if the gateway is
89 * down. Minimal RFC value is 3; it corresponds
90 * to ~3sec-8min depending on RTO.
93 #define TCP_RETR2 15 /*
94 * This should take at least
95 * 90 minutes to time out.
96 * RFC1122 says that the limit is 100 sec.
97 * 15 is ~13-30min depending on RTO.
100 #define TCP_SYN_RETRIES 5 /* number of times to retry active opening a
101 * connection: ~180sec is RFC minimum */
103 #define TCP_SYNACK_RETRIES 5 /* number of times to retry passive opening a
104 * connection: ~180sec is RFC minimum */
106 #define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
107 * state, about 60 seconds */
108 #define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN
109 /* BSD style FIN_WAIT2 deadlock breaker.
110 * It used to be 3min, new value is 60sec,
111 * to combine FIN-WAIT-2 timeout with
112 * TIME-WAIT timer.
115 #define TCP_DELACK_MAX ((unsigned)(HZ/5)) /* maximal time to delay before sending an ACK */
116 #if HZ >= 100
117 #define TCP_DELACK_MIN ((unsigned)(HZ/25)) /* minimal time to delay before sending an ACK */
118 #define TCP_ATO_MIN ((unsigned)(HZ/25))
119 #else
120 #define TCP_DELACK_MIN 4U
121 #define TCP_ATO_MIN 4U
122 #endif
123 #define TCP_RTO_MAX ((unsigned)(120*HZ))
124 #define TCP_RTO_MIN ((unsigned)(HZ/5))
125 #define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC2988bis initial RTO value */
126 #define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now
127 * used as a fallback RTO for the
128 * initial data transmission if no
129 * valid RTT sample has been acquired,
130 * most likely due to retrans in 3WHS.
133 #define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
134 * for local resources.
137 #define TCP_KEEPALIVE_TIME (120*60*HZ) /* two hours */
138 #define TCP_KEEPALIVE_PROBES 9 /* Max of 9 keepalive probes */
139 #define TCP_KEEPALIVE_INTVL (75*HZ)
141 #define MAX_TCP_KEEPIDLE 32767
142 #define MAX_TCP_KEEPINTVL 32767
143 #define MAX_TCP_KEEPCNT 127
144 #define MAX_TCP_SYNCNT 127
146 #define TCP_SYNQ_INTERVAL (HZ/5) /* Period of SYNACK timer */
148 #define TCP_PAWS_24DAYS (60 * 60 * 24 * 24)
149 #define TCP_PAWS_MSL 60 /* Per-host timestamps are invalidated
150 * after this time. It should be equal
151 * (or greater than) TCP_TIMEWAIT_LEN
152 * to provide reliability equal to one
153 * provided by timewait state.
155 #define TCP_PAWS_WINDOW 1 /* Replay window for per-host
156 * timestamps. It must be less than
157 * minimal timewait lifetime.
160 * TCP option
163 #define TCPOPT_NOP 1 /* Padding */
164 #define TCPOPT_EOL 0 /* End of options */
165 #define TCPOPT_MSS 2 /* Segment size negotiating */
166 #define TCPOPT_WINDOW 3 /* Window scaling */
167 #define TCPOPT_SACK_PERM 4 /* SACK Permitted */
168 #define TCPOPT_SACK 5 /* SACK Block */
169 #define TCPOPT_TIMESTAMP 8 /* Better RTT estimations/PAWS */
170 #define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */
171 #define TCPOPT_COOKIE 253 /* Cookie extension (experimental) */
174 * TCP option lengths
177 #define TCPOLEN_MSS 4
178 #define TCPOLEN_WINDOW 3
179 #define TCPOLEN_SACK_PERM 2
180 #define TCPOLEN_TIMESTAMP 10
181 #define TCPOLEN_MD5SIG 18
182 #define TCPOLEN_COOKIE_BASE 2 /* Cookie-less header extension */
183 #define TCPOLEN_COOKIE_PAIR 3 /* Cookie pair header extension */
184 #define TCPOLEN_COOKIE_MIN (TCPOLEN_COOKIE_BASE+TCP_COOKIE_MIN)
185 #define TCPOLEN_COOKIE_MAX (TCPOLEN_COOKIE_BASE+TCP_COOKIE_MAX)
187 /* But this is what stacks really send out. */
188 #define TCPOLEN_TSTAMP_ALIGNED 12
189 #define TCPOLEN_WSCALE_ALIGNED 4
190 #define TCPOLEN_SACKPERM_ALIGNED 4
191 #define TCPOLEN_SACK_BASE 2
192 #define TCPOLEN_SACK_BASE_ALIGNED 4
193 #define TCPOLEN_SACK_PERBLOCK 8
194 #define TCPOLEN_MD5SIG_ALIGNED 20
195 #define TCPOLEN_MSS_ALIGNED 4
197 /* Flags in tp->nonagle */
198 #define TCP_NAGLE_OFF 1 /* Nagle's algo is disabled */
199 #define TCP_NAGLE_CORK 2 /* Socket is corked */
200 #define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */
202 /* TCP thin-stream limits */
203 #define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */
205 /* TCP initial congestion window as per draft-hkchu-tcpm-initcwnd-01 */
206 #define TCP_INIT_CWND 10
208 extern struct inet_timewait_death_row tcp_death_row;
210 /* sysctl variables for tcp */
211 extern int sysctl_tcp_timestamps;
212 extern int sysctl_tcp_window_scaling;
213 extern int sysctl_tcp_sack;
214 extern int sysctl_tcp_fin_timeout;
215 extern int sysctl_tcp_keepalive_time;
216 extern int sysctl_tcp_keepalive_probes;
217 extern int sysctl_tcp_keepalive_intvl;
218 extern int sysctl_tcp_syn_retries;
219 extern int sysctl_tcp_synack_retries;
220 extern int sysctl_tcp_retries1;
221 extern int sysctl_tcp_retries2;
222 extern int sysctl_tcp_orphan_retries;
223 extern int sysctl_tcp_syncookies;
224 extern int sysctl_tcp_retrans_collapse;
225 extern int sysctl_tcp_stdurg;
226 extern int sysctl_tcp_rfc1337;
227 extern int sysctl_tcp_abort_on_overflow;
228 extern int sysctl_tcp_max_orphans;
229 extern int sysctl_tcp_fack;
230 extern int sysctl_tcp_reordering;
231 extern int sysctl_tcp_ecn;
232 extern int sysctl_tcp_dsack;
233 extern long sysctl_tcp_mem[3];
234 extern int sysctl_tcp_wmem[3];
235 extern int sysctl_tcp_rmem[3];
236 extern int sysctl_tcp_app_win;
237 extern int sysctl_tcp_adv_win_scale;
238 extern int sysctl_tcp_tw_reuse;
239 extern int sysctl_tcp_frto;
240 extern int sysctl_tcp_frto_response;
241 extern int sysctl_tcp_low_latency;
242 extern int sysctl_tcp_dma_copybreak;
243 extern int sysctl_tcp_nometrics_save;
244 extern int sysctl_tcp_moderate_rcvbuf;
245 extern int sysctl_tcp_tso_win_divisor;
246 extern int sysctl_tcp_abc;
247 extern int sysctl_tcp_mtu_probing;
248 extern int sysctl_tcp_base_mss;
249 extern int sysctl_tcp_workaround_signed_windows;
250 extern int sysctl_tcp_slow_start_after_idle;
251 extern int sysctl_tcp_max_ssthresh;
252 extern int sysctl_tcp_cookie_size;
253 extern int sysctl_tcp_thin_linear_timeouts;
254 extern int sysctl_tcp_thin_dupack;
256 extern atomic_long_t tcp_memory_allocated;
257 extern struct percpu_counter tcp_sockets_allocated;
258 extern int tcp_memory_pressure;
261 * The next routines deal with comparing 32 bit unsigned ints
262 * and worry about wraparound (automatic with unsigned arithmetic).
265 static inline int before(__u32 seq1, __u32 seq2)
267 return (__s32)(seq1-seq2) < 0;
269 #define after(seq2, seq1) before(seq1, seq2)
271 /* is s2<=s1<=s3 ? */
272 static inline int between(__u32 seq1, __u32 seq2, __u32 seq3)
274 return seq3 - seq2 >= seq1 - seq2;
277 static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
279 struct percpu_counter *ocp = sk->sk_prot->orphan_count;
280 int orphans = percpu_counter_read_positive(ocp);
282 if (orphans << shift > sysctl_tcp_max_orphans) {
283 orphans = percpu_counter_sum_positive(ocp);
284 if (orphans << shift > sysctl_tcp_max_orphans)
285 return true;
288 if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
289 sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
290 return true;
291 return false;
294 /* syncookies: remember time of last synqueue overflow */
295 static inline void tcp_synq_overflow(struct sock *sk)
297 tcp_sk(sk)->rx_opt.ts_recent_stamp = jiffies;
300 /* syncookies: no recent synqueue overflow on this listening socket? */
301 static inline int tcp_synq_no_recent_overflow(const struct sock *sk)
303 unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
304 return time_after(jiffies, last_overflow + TCP_TIMEOUT_FALLBACK);
307 extern struct proto tcp_prot;
309 #define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field)
310 #define TCP_INC_STATS_BH(net, field) SNMP_INC_STATS_BH((net)->mib.tcp_statistics, field)
311 #define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
312 #define TCP_ADD_STATS_USER(net, field, val) SNMP_ADD_STATS_USER((net)->mib.tcp_statistics, field, val)
313 #define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
315 extern void tcp_v4_err(struct sk_buff *skb, u32);
317 extern void tcp_shutdown (struct sock *sk, int how);
319 extern int tcp_v4_rcv(struct sk_buff *skb);
321 extern struct inet_peer *tcp_v4_get_peer(struct sock *sk, bool *release_it);
322 extern void *tcp_v4_tw_get_peer(struct sock *sk);
323 extern int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
324 extern int tcp_sendmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
325 size_t size);
326 extern int tcp_sendpage(struct sock *sk, struct page *page, int offset,
327 size_t size, int flags);
328 extern int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg);
329 extern int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
330 const struct tcphdr *th, unsigned int len);
331 extern int tcp_rcv_established(struct sock *sk, struct sk_buff *skb,
332 const struct tcphdr *th, unsigned int len);
333 extern void tcp_rcv_space_adjust(struct sock *sk);
334 extern void tcp_cleanup_rbuf(struct sock *sk, int copied);
335 extern int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
336 extern void tcp_twsk_destructor(struct sock *sk);
337 extern ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
338 struct pipe_inode_info *pipe, size_t len,
339 unsigned int flags);
341 static inline void tcp_dec_quickack_mode(struct sock *sk,
342 const unsigned int pkts)
344 struct inet_connection_sock *icsk = inet_csk(sk);
346 if (icsk->icsk_ack.quick) {
347 if (pkts >= icsk->icsk_ack.quick) {
348 icsk->icsk_ack.quick = 0;
349 /* Leaving quickack mode we deflate ATO. */
350 icsk->icsk_ack.ato = TCP_ATO_MIN;
351 } else
352 icsk->icsk_ack.quick -= pkts;
356 #define TCP_ECN_OK 1
357 #define TCP_ECN_QUEUE_CWR 2
358 #define TCP_ECN_DEMAND_CWR 4
359 #define TCP_ECN_SEEN 8
361 static __inline__ void
362 TCP_ECN_create_request(struct request_sock *req, struct tcphdr *th)
364 if (sysctl_tcp_ecn && th->ece && th->cwr)
365 inet_rsk(req)->ecn_ok = 1;
368 enum tcp_tw_status {
369 TCP_TW_SUCCESS = 0,
370 TCP_TW_RST = 1,
371 TCP_TW_ACK = 2,
372 TCP_TW_SYN = 3
376 extern enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
377 struct sk_buff *skb,
378 const struct tcphdr *th);
379 extern struct sock * tcp_check_req(struct sock *sk,struct sk_buff *skb,
380 struct request_sock *req,
381 struct request_sock **prev);
382 extern int tcp_child_process(struct sock *parent, struct sock *child,
383 struct sk_buff *skb);
384 extern int tcp_use_frto(struct sock *sk);
385 extern void tcp_enter_frto(struct sock *sk);
386 extern void tcp_enter_loss(struct sock *sk, int how);
387 extern void tcp_clear_retrans(struct tcp_sock *tp);
388 extern void tcp_update_metrics(struct sock *sk);
389 extern void tcp_close(struct sock *sk, long timeout);
390 extern unsigned int tcp_poll(struct file * file, struct socket *sock,
391 struct poll_table_struct *wait);
392 extern int tcp_getsockopt(struct sock *sk, int level, int optname,
393 char __user *optval, int __user *optlen);
394 extern int tcp_setsockopt(struct sock *sk, int level, int optname,
395 char __user *optval, unsigned int optlen);
396 extern int compat_tcp_getsockopt(struct sock *sk, int level, int optname,
397 char __user *optval, int __user *optlen);
398 extern int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
399 char __user *optval, unsigned int optlen);
400 extern void tcp_set_keepalive(struct sock *sk, int val);
401 extern void tcp_syn_ack_timeout(struct sock *sk, struct request_sock *req);
402 extern int tcp_recvmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
403 size_t len, int nonblock, int flags, int *addr_len);
404 extern void tcp_parse_options(const struct sk_buff *skb,
405 struct tcp_options_received *opt_rx, const u8 **hvpp,
406 int estab);
407 extern const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
410 * TCP v4 functions exported for the inet6 API
413 extern void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
414 extern int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
415 extern struct sock * tcp_create_openreq_child(struct sock *sk,
416 struct request_sock *req,
417 struct sk_buff *skb);
418 extern struct sock * tcp_v4_syn_recv_sock(struct sock *sk, struct sk_buff *skb,
419 struct request_sock *req,
420 struct dst_entry *dst);
421 extern int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
422 extern int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
423 int addr_len);
424 extern int tcp_connect(struct sock *sk);
425 extern struct sk_buff * tcp_make_synack(struct sock *sk, struct dst_entry *dst,
426 struct request_sock *req,
427 struct request_values *rvp);
428 extern int tcp_disconnect(struct sock *sk, int flags);
431 /* From syncookies.c */
432 extern __u32 syncookie_secret[2][16-4+SHA_DIGEST_WORDS];
433 extern struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb,
434 struct ip_options *opt);
435 #ifdef CONFIG_SYN_COOKIES
436 extern __u32 cookie_v4_init_sequence(struct sock *sk, struct sk_buff *skb,
437 __u16 *mss);
438 #else
439 static inline __u32 cookie_v4_init_sequence(struct sock *sk,
440 struct sk_buff *skb,
441 __u16 *mss)
443 return 0;
445 #endif
447 extern __u32 cookie_init_timestamp(struct request_sock *req);
448 extern bool cookie_check_timestamp(struct tcp_options_received *opt, bool *);
450 /* From net/ipv6/syncookies.c */
451 extern struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
452 #ifdef CONFIG_SYN_COOKIES
453 extern __u32 cookie_v6_init_sequence(struct sock *sk, const struct sk_buff *skb,
454 __u16 *mss);
455 #else
456 static inline __u32 cookie_v6_init_sequence(struct sock *sk,
457 struct sk_buff *skb,
458 __u16 *mss)
460 return 0;
462 #endif
463 /* tcp_output.c */
465 extern void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
466 int nonagle);
467 extern int tcp_may_send_now(struct sock *sk);
468 extern int tcp_retransmit_skb(struct sock *, struct sk_buff *);
469 extern void tcp_retransmit_timer(struct sock *sk);
470 extern void tcp_xmit_retransmit_queue(struct sock *);
471 extern void tcp_simple_retransmit(struct sock *);
472 extern int tcp_trim_head(struct sock *, struct sk_buff *, u32);
473 extern int tcp_fragment(struct sock *, struct sk_buff *, u32, unsigned int);
475 extern void tcp_send_probe0(struct sock *);
476 extern void tcp_send_partial(struct sock *);
477 extern int tcp_write_wakeup(struct sock *);
478 extern void tcp_send_fin(struct sock *sk);
479 extern void tcp_send_active_reset(struct sock *sk, gfp_t priority);
480 extern int tcp_send_synack(struct sock *);
481 extern int tcp_syn_flood_action(struct sock *sk,
482 const struct sk_buff *skb,
483 const char *proto);
484 extern void tcp_push_one(struct sock *, unsigned int mss_now);
485 extern void tcp_send_ack(struct sock *sk);
486 extern void tcp_send_delayed_ack(struct sock *sk);
488 /* tcp_input.c */
489 extern void tcp_cwnd_application_limited(struct sock *sk);
491 /* tcp_timer.c */
492 extern void tcp_init_xmit_timers(struct sock *);
493 static inline void tcp_clear_xmit_timers(struct sock *sk)
495 inet_csk_clear_xmit_timers(sk);
498 extern unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
499 extern unsigned int tcp_current_mss(struct sock *sk);
501 /* Bound MSS / TSO packet size with the half of the window */
502 static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
504 int cutoff;
506 /* When peer uses tiny windows, there is no use in packetizing
507 * to sub-MSS pieces for the sake of SWS or making sure there
508 * are enough packets in the pipe for fast recovery.
510 * On the other hand, for extremely large MSS devices, handling
511 * smaller than MSS windows in this way does make sense.
513 if (tp->max_window >= 512)
514 cutoff = (tp->max_window >> 1);
515 else
516 cutoff = tp->max_window;
518 if (cutoff && pktsize > cutoff)
519 return max_t(int, cutoff, 68U - tp->tcp_header_len);
520 else
521 return pktsize;
524 /* tcp.c */
525 extern void tcp_get_info(const struct sock *, struct tcp_info *);
527 /* Read 'sendfile()'-style from a TCP socket */
528 typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
529 unsigned int, size_t);
530 extern int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
531 sk_read_actor_t recv_actor);
533 extern void tcp_initialize_rcv_mss(struct sock *sk);
535 extern int tcp_mtu_to_mss(const struct sock *sk, int pmtu);
536 extern int tcp_mss_to_mtu(const struct sock *sk, int mss);
537 extern void tcp_mtup_init(struct sock *sk);
538 extern void tcp_valid_rtt_meas(struct sock *sk, u32 seq_rtt);
540 static inline void tcp_bound_rto(const struct sock *sk)
542 if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
543 inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
546 static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
548 return (tp->srtt >> 3) + tp->rttvar;
551 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
553 tp->pred_flags = htonl((tp->tcp_header_len << 26) |
554 ntohl(TCP_FLAG_ACK) |
555 snd_wnd);
558 static inline void tcp_fast_path_on(struct tcp_sock *tp)
560 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
563 static inline void tcp_fast_path_check(struct sock *sk)
565 struct tcp_sock *tp = tcp_sk(sk);
567 if (skb_queue_empty(&tp->out_of_order_queue) &&
568 tp->rcv_wnd &&
569 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
570 !tp->urg_data)
571 tcp_fast_path_on(tp);
574 /* Compute the actual rto_min value */
575 static inline u32 tcp_rto_min(struct sock *sk)
577 const struct dst_entry *dst = __sk_dst_get(sk);
578 u32 rto_min = TCP_RTO_MIN;
580 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
581 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
582 return rto_min;
585 /* Compute the actual receive window we are currently advertising.
586 * Rcv_nxt can be after the window if our peer push more data
587 * than the offered window.
589 static inline u32 tcp_receive_window(const struct tcp_sock *tp)
591 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;
593 if (win < 0)
594 win = 0;
595 return (u32) win;
598 /* Choose a new window, without checks for shrinking, and without
599 * scaling applied to the result. The caller does these things
600 * if necessary. This is a "raw" window selection.
602 extern u32 __tcp_select_window(struct sock *sk);
604 /* TCP timestamps are only 32-bits, this causes a slight
605 * complication on 64-bit systems since we store a snapshot
606 * of jiffies in the buffer control blocks below. We decided
607 * to use only the low 32-bits of jiffies and hide the ugly
608 * casts with the following macro.
610 #define tcp_time_stamp ((__u32)(jiffies))
612 #define tcp_flag_byte(th) (((u_int8_t *)th)[13])
614 #define TCPHDR_FIN 0x01
615 #define TCPHDR_SYN 0x02
616 #define TCPHDR_RST 0x04
617 #define TCPHDR_PSH 0x08
618 #define TCPHDR_ACK 0x10
619 #define TCPHDR_URG 0x20
620 #define TCPHDR_ECE 0x40
621 #define TCPHDR_CWR 0x80
623 /* This is what the send packet queuing engine uses to pass
624 * TCP per-packet control information to the transmission code.
625 * We also store the host-order sequence numbers in here too.
626 * This is 44 bytes if IPV6 is enabled.
627 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
629 struct tcp_skb_cb {
630 union {
631 struct inet_skb_parm h4;
632 #if IS_ENABLED(CONFIG_IPV6)
633 struct inet6_skb_parm h6;
634 #endif
635 } header; /* For incoming frames */
636 __u32 seq; /* Starting sequence number */
637 __u32 end_seq; /* SEQ + FIN + SYN + datalen */
638 __u32 when; /* used to compute rtt's */
639 __u8 tcp_flags; /* TCP header flags. (tcp[13]) */
640 __u8 sacked; /* State flags for SACK/FACK. */
641 #define TCPCB_SACKED_ACKED 0x01 /* SKB ACK'd by a SACK block */
642 #define TCPCB_SACKED_RETRANS 0x02 /* SKB retransmitted */
643 #define TCPCB_LOST 0x04 /* SKB is lost */
644 #define TCPCB_TAGBITS 0x07 /* All tag bits */
645 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */
646 /* 1 byte hole */
647 #define TCPCB_EVER_RETRANS 0x80 /* Ever retransmitted frame */
648 #define TCPCB_RETRANS (TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS)
650 __u32 ack_seq; /* Sequence number ACK'd */
653 #define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0]))
655 /* Due to TSO, an SKB can be composed of multiple actual
656 * packets. To keep these tracked properly, we use this.
658 static inline int tcp_skb_pcount(const struct sk_buff *skb)
660 return skb_shinfo(skb)->gso_segs;
663 /* This is valid iff tcp_skb_pcount() > 1. */
664 static inline int tcp_skb_mss(const struct sk_buff *skb)
666 return skb_shinfo(skb)->gso_size;
669 /* Events passed to congestion control interface */
670 enum tcp_ca_event {
671 CA_EVENT_TX_START, /* first transmit when no packets in flight */
672 CA_EVENT_CWND_RESTART, /* congestion window restart */
673 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */
674 CA_EVENT_FRTO, /* fast recovery timeout */
675 CA_EVENT_LOSS, /* loss timeout */
676 CA_EVENT_FAST_ACK, /* in sequence ack */
677 CA_EVENT_SLOW_ACK, /* other ack */
681 * Interface for adding new TCP congestion control handlers
683 #define TCP_CA_NAME_MAX 16
684 #define TCP_CA_MAX 128
685 #define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX)
687 #define TCP_CONG_NON_RESTRICTED 0x1
688 #define TCP_CONG_RTT_STAMP 0x2
690 struct tcp_congestion_ops {
691 struct list_head list;
692 unsigned long flags;
694 /* initialize private data (optional) */
695 void (*init)(struct sock *sk);
696 /* cleanup private data (optional) */
697 void (*release)(struct sock *sk);
699 /* return slow start threshold (required) */
700 u32 (*ssthresh)(struct sock *sk);
701 /* lower bound for congestion window (optional) */
702 u32 (*min_cwnd)(const struct sock *sk);
703 /* do new cwnd calculation (required) */
704 void (*cong_avoid)(struct sock *sk, u32 ack, u32 in_flight);
705 /* call before changing ca_state (optional) */
706 void (*set_state)(struct sock *sk, u8 new_state);
707 /* call when cwnd event occurs (optional) */
708 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
709 /* new value of cwnd after loss (optional) */
710 u32 (*undo_cwnd)(struct sock *sk);
711 /* hook for packet ack accounting (optional) */
712 void (*pkts_acked)(struct sock *sk, u32 num_acked, s32 rtt_us);
713 /* get info for inet_diag (optional) */
714 void (*get_info)(struct sock *sk, u32 ext, struct sk_buff *skb);
716 char name[TCP_CA_NAME_MAX];
717 struct module *owner;
720 extern int tcp_register_congestion_control(struct tcp_congestion_ops *type);
721 extern void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
723 extern void tcp_init_congestion_control(struct sock *sk);
724 extern void tcp_cleanup_congestion_control(struct sock *sk);
725 extern int tcp_set_default_congestion_control(const char *name);
726 extern void tcp_get_default_congestion_control(char *name);
727 extern void tcp_get_available_congestion_control(char *buf, size_t len);
728 extern void tcp_get_allowed_congestion_control(char *buf, size_t len);
729 extern int tcp_set_allowed_congestion_control(char *allowed);
730 extern int tcp_set_congestion_control(struct sock *sk, const char *name);
731 extern void tcp_slow_start(struct tcp_sock *tp);
732 extern void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w);
734 extern struct tcp_congestion_ops tcp_init_congestion_ops;
735 extern u32 tcp_reno_ssthresh(struct sock *sk);
736 extern void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 in_flight);
737 extern u32 tcp_reno_min_cwnd(const struct sock *sk);
738 extern struct tcp_congestion_ops tcp_reno;
740 static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
742 struct inet_connection_sock *icsk = inet_csk(sk);
744 if (icsk->icsk_ca_ops->set_state)
745 icsk->icsk_ca_ops->set_state(sk, ca_state);
746 icsk->icsk_ca_state = ca_state;
749 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
751 const struct inet_connection_sock *icsk = inet_csk(sk);
753 if (icsk->icsk_ca_ops->cwnd_event)
754 icsk->icsk_ca_ops->cwnd_event(sk, event);
757 /* These functions determine how the current flow behaves in respect of SACK
758 * handling. SACK is negotiated with the peer, and therefore it can vary
759 * between different flows.
761 * tcp_is_sack - SACK enabled
762 * tcp_is_reno - No SACK
763 * tcp_is_fack - FACK enabled, implies SACK enabled
765 static inline int tcp_is_sack(const struct tcp_sock *tp)
767 return tp->rx_opt.sack_ok;
770 static inline int tcp_is_reno(const struct tcp_sock *tp)
772 return !tcp_is_sack(tp);
775 static inline int tcp_is_fack(const struct tcp_sock *tp)
777 return tp->rx_opt.sack_ok & 2;
780 static inline void tcp_enable_fack(struct tcp_sock *tp)
782 tp->rx_opt.sack_ok |= 2;
785 static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
787 return tp->sacked_out + tp->lost_out;
790 /* This determines how many packets are "in the network" to the best
791 * of our knowledge. In many cases it is conservative, but where
792 * detailed information is available from the receiver (via SACK
793 * blocks etc.) we can make more aggressive calculations.
795 * Use this for decisions involving congestion control, use just
796 * tp->packets_out to determine if the send queue is empty or not.
798 * Read this equation as:
800 * "Packets sent once on transmission queue" MINUS
801 * "Packets left network, but not honestly ACKed yet" PLUS
802 * "Packets fast retransmitted"
804 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
806 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
809 #define TCP_INFINITE_SSTHRESH 0x7fffffff
811 static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
813 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
816 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
817 * The exception is rate halving phase, when cwnd is decreasing towards
818 * ssthresh.
820 static inline __u32 tcp_current_ssthresh(const struct sock *sk)
822 const struct tcp_sock *tp = tcp_sk(sk);
824 if ((1 << inet_csk(sk)->icsk_ca_state) & (TCPF_CA_CWR | TCPF_CA_Recovery))
825 return tp->snd_ssthresh;
826 else
827 return max(tp->snd_ssthresh,
828 ((tp->snd_cwnd >> 1) +
829 (tp->snd_cwnd >> 2)));
832 /* Use define here intentionally to get WARN_ON location shown at the caller */
833 #define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out)
835 extern void tcp_enter_cwr(struct sock *sk, const int set_ssthresh);
836 extern __u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
838 /* The maximum number of MSS of available cwnd for which TSO defers
839 * sending if not using sysctl_tcp_tso_win_divisor.
841 static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
843 return 3;
846 /* Slow start with delack produces 3 packets of burst, so that
847 * it is safe "de facto". This will be the default - same as
848 * the default reordering threshold - but if reordering increases,
849 * we must be able to allow cwnd to burst at least this much in order
850 * to not pull it back when holes are filled.
852 static __inline__ __u32 tcp_max_burst(const struct tcp_sock *tp)
854 return tp->reordering;
857 /* Returns end sequence number of the receiver's advertised window */
858 static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
860 return tp->snd_una + tp->snd_wnd;
862 extern int tcp_is_cwnd_limited(const struct sock *sk, u32 in_flight);
864 static inline void tcp_minshall_update(struct tcp_sock *tp, unsigned int mss,
865 const struct sk_buff *skb)
867 if (skb->len < mss)
868 tp->snd_sml = TCP_SKB_CB(skb)->end_seq;
871 static inline void tcp_check_probe_timer(struct sock *sk)
873 const struct tcp_sock *tp = tcp_sk(sk);
874 const struct inet_connection_sock *icsk = inet_csk(sk);
876 if (!tp->packets_out && !icsk->icsk_pending)
877 inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
878 icsk->icsk_rto, TCP_RTO_MAX);
881 static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
883 tp->snd_wl1 = seq;
886 static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
888 tp->snd_wl1 = seq;
892 * Calculate(/check) TCP checksum
894 static inline __sum16 tcp_v4_check(int len, __be32 saddr,
895 __be32 daddr, __wsum base)
897 return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
900 static inline __sum16 __tcp_checksum_complete(struct sk_buff *skb)
902 return __skb_checksum_complete(skb);
905 static inline int tcp_checksum_complete(struct sk_buff *skb)
907 return !skb_csum_unnecessary(skb) &&
908 __tcp_checksum_complete(skb);
911 /* Prequeue for VJ style copy to user, combined with checksumming. */
913 static inline void tcp_prequeue_init(struct tcp_sock *tp)
915 tp->ucopy.task = NULL;
916 tp->ucopy.len = 0;
917 tp->ucopy.memory = 0;
918 skb_queue_head_init(&tp->ucopy.prequeue);
919 #ifdef CONFIG_NET_DMA
920 tp->ucopy.dma_chan = NULL;
921 tp->ucopy.wakeup = 0;
922 tp->ucopy.pinned_list = NULL;
923 tp->ucopy.dma_cookie = 0;
924 #endif
927 /* Packet is added to VJ-style prequeue for processing in process
928 * context, if a reader task is waiting. Apparently, this exciting
929 * idea (VJ's mail "Re: query about TCP header on tcp-ip" of 07 Sep 93)
930 * failed somewhere. Latency? Burstiness? Well, at least now we will
931 * see, why it failed. 8)8) --ANK
933 * NOTE: is this not too big to inline?
935 static inline int tcp_prequeue(struct sock *sk, struct sk_buff *skb)
937 struct tcp_sock *tp = tcp_sk(sk);
939 if (sysctl_tcp_low_latency || !tp->ucopy.task)
940 return 0;
942 __skb_queue_tail(&tp->ucopy.prequeue, skb);
943 tp->ucopy.memory += skb->truesize;
944 if (tp->ucopy.memory > sk->sk_rcvbuf) {
945 struct sk_buff *skb1;
947 BUG_ON(sock_owned_by_user(sk));
949 while ((skb1 = __skb_dequeue(&tp->ucopy.prequeue)) != NULL) {
950 sk_backlog_rcv(sk, skb1);
951 NET_INC_STATS_BH(sock_net(sk),
952 LINUX_MIB_TCPPREQUEUEDROPPED);
955 tp->ucopy.memory = 0;
956 } else if (skb_queue_len(&tp->ucopy.prequeue) == 1) {
957 wake_up_interruptible_sync_poll(sk_sleep(sk),
958 POLLIN | POLLRDNORM | POLLRDBAND);
959 if (!inet_csk_ack_scheduled(sk))
960 inet_csk_reset_xmit_timer(sk, ICSK_TIME_DACK,
961 (3 * tcp_rto_min(sk)) / 4,
962 TCP_RTO_MAX);
964 return 1;
968 #undef STATE_TRACE
970 #ifdef STATE_TRACE
971 static const char *statename[]={
972 "Unused","Established","Syn Sent","Syn Recv",
973 "Fin Wait 1","Fin Wait 2","Time Wait", "Close",
974 "Close Wait","Last ACK","Listen","Closing"
976 #endif
977 extern void tcp_set_state(struct sock *sk, int state);
979 extern void tcp_done(struct sock *sk);
981 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
983 rx_opt->dsack = 0;
984 rx_opt->num_sacks = 0;
987 /* Determine a window scaling and initial window to offer. */
988 extern void tcp_select_initial_window(int __space, __u32 mss,
989 __u32 *rcv_wnd, __u32 *window_clamp,
990 int wscale_ok, __u8 *rcv_wscale,
991 __u32 init_rcv_wnd);
993 static inline int tcp_win_from_space(int space)
995 return sysctl_tcp_adv_win_scale<=0 ?
996 (space>>(-sysctl_tcp_adv_win_scale)) :
997 space - (space>>sysctl_tcp_adv_win_scale);
1000 /* Note: caller must be prepared to deal with negative returns */
1001 static inline int tcp_space(const struct sock *sk)
1003 return tcp_win_from_space(sk->sk_rcvbuf -
1004 atomic_read(&sk->sk_rmem_alloc));
1007 static inline int tcp_full_space(const struct sock *sk)
1009 return tcp_win_from_space(sk->sk_rcvbuf);
1012 static inline void tcp_openreq_init(struct request_sock *req,
1013 struct tcp_options_received *rx_opt,
1014 struct sk_buff *skb)
1016 struct inet_request_sock *ireq = inet_rsk(req);
1018 req->rcv_wnd = 0; /* So that tcp_send_synack() knows! */
1019 req->cookie_ts = 0;
1020 tcp_rsk(req)->rcv_isn = TCP_SKB_CB(skb)->seq;
1021 req->mss = rx_opt->mss_clamp;
1022 req->ts_recent = rx_opt->saw_tstamp ? rx_opt->rcv_tsval : 0;
1023 ireq->tstamp_ok = rx_opt->tstamp_ok;
1024 ireq->sack_ok = rx_opt->sack_ok;
1025 ireq->snd_wscale = rx_opt->snd_wscale;
1026 ireq->wscale_ok = rx_opt->wscale_ok;
1027 ireq->acked = 0;
1028 ireq->ecn_ok = 0;
1029 ireq->rmt_port = tcp_hdr(skb)->source;
1030 ireq->loc_port = tcp_hdr(skb)->dest;
1033 extern void tcp_enter_memory_pressure(struct sock *sk);
1035 static inline int keepalive_intvl_when(const struct tcp_sock *tp)
1037 return tp->keepalive_intvl ? : sysctl_tcp_keepalive_intvl;
1040 static inline int keepalive_time_when(const struct tcp_sock *tp)
1042 return tp->keepalive_time ? : sysctl_tcp_keepalive_time;
1045 static inline int keepalive_probes(const struct tcp_sock *tp)
1047 return tp->keepalive_probes ? : sysctl_tcp_keepalive_probes;
1050 static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
1052 const struct inet_connection_sock *icsk = &tp->inet_conn;
1054 return min_t(u32, tcp_time_stamp - icsk->icsk_ack.lrcvtime,
1055 tcp_time_stamp - tp->rcv_tstamp);
1058 static inline int tcp_fin_time(const struct sock *sk)
1060 int fin_timeout = tcp_sk(sk)->linger2 ? : sysctl_tcp_fin_timeout;
1061 const int rto = inet_csk(sk)->icsk_rto;
1063 if (fin_timeout < (rto << 2) - (rto >> 1))
1064 fin_timeout = (rto << 2) - (rto >> 1);
1066 return fin_timeout;
1069 static inline int tcp_paws_check(const struct tcp_options_received *rx_opt,
1070 int paws_win)
1072 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
1073 return 1;
1074 if (unlikely(get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS))
1075 return 1;
1077 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
1078 * then following tcp messages have valid values. Ignore 0 value,
1079 * or else 'negative' tsval might forbid us to accept their packets.
1081 if (!rx_opt->ts_recent)
1082 return 1;
1083 return 0;
1086 static inline int tcp_paws_reject(const struct tcp_options_received *rx_opt,
1087 int rst)
1089 if (tcp_paws_check(rx_opt, 0))
1090 return 0;
1092 /* RST segments are not recommended to carry timestamp,
1093 and, if they do, it is recommended to ignore PAWS because
1094 "their cleanup function should take precedence over timestamps."
1095 Certainly, it is mistake. It is necessary to understand the reasons
1096 of this constraint to relax it: if peer reboots, clock may go
1097 out-of-sync and half-open connections will not be reset.
1098 Actually, the problem would be not existing if all
1099 the implementations followed draft about maintaining clock
1100 via reboots. Linux-2.2 DOES NOT!
1102 However, we can relax time bounds for RST segments to MSL.
1104 if (rst && get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
1105 return 0;
1106 return 1;
1109 static inline void tcp_mib_init(struct net *net)
1111 /* See RFC 2012 */
1112 TCP_ADD_STATS_USER(net, TCP_MIB_RTOALGORITHM, 1);
1113 TCP_ADD_STATS_USER(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
1114 TCP_ADD_STATS_USER(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
1115 TCP_ADD_STATS_USER(net, TCP_MIB_MAXCONN, -1);
1118 /* from STCP */
1119 static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
1121 tp->lost_skb_hint = NULL;
1122 tp->scoreboard_skb_hint = NULL;
1125 static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
1127 tcp_clear_retrans_hints_partial(tp);
1128 tp->retransmit_skb_hint = NULL;
1131 /* MD5 Signature */
1132 struct crypto_hash;
1134 /* - key database */
1135 struct tcp_md5sig_key {
1136 u8 *key;
1137 u8 keylen;
1140 struct tcp4_md5sig_key {
1141 struct tcp_md5sig_key base;
1142 __be32 addr;
1145 struct tcp6_md5sig_key {
1146 struct tcp_md5sig_key base;
1147 #if 0
1148 u32 scope_id; /* XXX */
1149 #endif
1150 struct in6_addr addr;
1153 /* - sock block */
1154 struct tcp_md5sig_info {
1155 struct tcp4_md5sig_key *keys4;
1156 #if IS_ENABLED(CONFIG_IPV6)
1157 struct tcp6_md5sig_key *keys6;
1158 u32 entries6;
1159 u32 alloced6;
1160 #endif
1161 u32 entries4;
1162 u32 alloced4;
1165 /* - pseudo header */
1166 struct tcp4_pseudohdr {
1167 __be32 saddr;
1168 __be32 daddr;
1169 __u8 pad;
1170 __u8 protocol;
1171 __be16 len;
1174 struct tcp6_pseudohdr {
1175 struct in6_addr saddr;
1176 struct in6_addr daddr;
1177 __be32 len;
1178 __be32 protocol; /* including padding */
1181 union tcp_md5sum_block {
1182 struct tcp4_pseudohdr ip4;
1183 #if IS_ENABLED(CONFIG_IPV6)
1184 struct tcp6_pseudohdr ip6;
1185 #endif
1188 /* - pool: digest algorithm, hash description and scratch buffer */
1189 struct tcp_md5sig_pool {
1190 struct hash_desc md5_desc;
1191 union tcp_md5sum_block md5_blk;
1194 /* - functions */
1195 extern int tcp_v4_md5_hash_skb(char *md5_hash, struct tcp_md5sig_key *key,
1196 const struct sock *sk,
1197 const struct request_sock *req,
1198 const struct sk_buff *skb);
1199 extern struct tcp_md5sig_key * tcp_v4_md5_lookup(struct sock *sk,
1200 struct sock *addr_sk);
1201 extern int tcp_v4_md5_do_add(struct sock *sk, __be32 addr, u8 *newkey,
1202 u8 newkeylen);
1203 extern int tcp_v4_md5_do_del(struct sock *sk, __be32 addr);
1205 #ifdef CONFIG_TCP_MD5SIG
1206 #define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_keylen ? \
1207 &(struct tcp_md5sig_key) { \
1208 .key = (twsk)->tw_md5_key, \
1209 .keylen = (twsk)->tw_md5_keylen, \
1210 } : NULL)
1211 #else
1212 #define tcp_twsk_md5_key(twsk) NULL
1213 #endif
1215 extern struct tcp_md5sig_pool __percpu *tcp_alloc_md5sig_pool(struct sock *);
1216 extern void tcp_free_md5sig_pool(void);
1218 extern struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
1219 extern void tcp_put_md5sig_pool(void);
1221 extern int tcp_md5_hash_header(struct tcp_md5sig_pool *, const struct tcphdr *);
1222 extern int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
1223 unsigned header_len);
1224 extern int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
1225 const struct tcp_md5sig_key *key);
1227 /* write queue abstraction */
1228 static inline void tcp_write_queue_purge(struct sock *sk)
1230 struct sk_buff *skb;
1232 while ((skb = __skb_dequeue(&sk->sk_write_queue)) != NULL)
1233 sk_wmem_free_skb(sk, skb);
1234 sk_mem_reclaim(sk);
1235 tcp_clear_all_retrans_hints(tcp_sk(sk));
1238 static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
1240 return skb_peek(&sk->sk_write_queue);
1243 static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
1245 return skb_peek_tail(&sk->sk_write_queue);
1248 static inline struct sk_buff *tcp_write_queue_next(const struct sock *sk,
1249 const struct sk_buff *skb)
1251 return skb_queue_next(&sk->sk_write_queue, skb);
1254 static inline struct sk_buff *tcp_write_queue_prev(const struct sock *sk,
1255 const struct sk_buff *skb)
1257 return skb_queue_prev(&sk->sk_write_queue, skb);
1260 #define tcp_for_write_queue(skb, sk) \
1261 skb_queue_walk(&(sk)->sk_write_queue, skb)
1263 #define tcp_for_write_queue_from(skb, sk) \
1264 skb_queue_walk_from(&(sk)->sk_write_queue, skb)
1266 #define tcp_for_write_queue_from_safe(skb, tmp, sk) \
1267 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
1269 static inline struct sk_buff *tcp_send_head(const struct sock *sk)
1271 return sk->sk_send_head;
1274 static inline bool tcp_skb_is_last(const struct sock *sk,
1275 const struct sk_buff *skb)
1277 return skb_queue_is_last(&sk->sk_write_queue, skb);
1280 static inline void tcp_advance_send_head(struct sock *sk, const struct sk_buff *skb)
1282 if (tcp_skb_is_last(sk, skb))
1283 sk->sk_send_head = NULL;
1284 else
1285 sk->sk_send_head = tcp_write_queue_next(sk, skb);
1288 static inline void tcp_check_send_head(struct sock *sk, struct sk_buff *skb_unlinked)
1290 if (sk->sk_send_head == skb_unlinked)
1291 sk->sk_send_head = NULL;
1294 static inline void tcp_init_send_head(struct sock *sk)
1296 sk->sk_send_head = NULL;
1299 static inline void __tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1301 __skb_queue_tail(&sk->sk_write_queue, skb);
1304 static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
1306 __tcp_add_write_queue_tail(sk, skb);
1308 /* Queue it, remembering where we must start sending. */
1309 if (sk->sk_send_head == NULL) {
1310 sk->sk_send_head = skb;
1312 if (tcp_sk(sk)->highest_sack == NULL)
1313 tcp_sk(sk)->highest_sack = skb;
1317 static inline void __tcp_add_write_queue_head(struct sock *sk, struct sk_buff *skb)
1319 __skb_queue_head(&sk->sk_write_queue, skb);
1322 /* Insert buff after skb on the write queue of sk. */
1323 static inline void tcp_insert_write_queue_after(struct sk_buff *skb,
1324 struct sk_buff *buff,
1325 struct sock *sk)
1327 __skb_queue_after(&sk->sk_write_queue, skb, buff);
1330 /* Insert new before skb on the write queue of sk. */
1331 static inline void tcp_insert_write_queue_before(struct sk_buff *new,
1332 struct sk_buff *skb,
1333 struct sock *sk)
1335 __skb_queue_before(&sk->sk_write_queue, skb, new);
1337 if (sk->sk_send_head == skb)
1338 sk->sk_send_head = new;
1341 static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
1343 __skb_unlink(skb, &sk->sk_write_queue);
1346 static inline int tcp_write_queue_empty(struct sock *sk)
1348 return skb_queue_empty(&sk->sk_write_queue);
1351 static inline void tcp_push_pending_frames(struct sock *sk)
1353 if (tcp_send_head(sk)) {
1354 struct tcp_sock *tp = tcp_sk(sk);
1356 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
1360 /* Start sequence of the highest skb with SACKed bit, valid only if
1361 * sacked > 0 or when the caller has ensured validity by itself.
1363 static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
1365 if (!tp->sacked_out)
1366 return tp->snd_una;
1368 if (tp->highest_sack == NULL)
1369 return tp->snd_nxt;
1371 return TCP_SKB_CB(tp->highest_sack)->seq;
1374 static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
1376 tcp_sk(sk)->highest_sack = tcp_skb_is_last(sk, skb) ? NULL :
1377 tcp_write_queue_next(sk, skb);
1380 static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
1382 return tcp_sk(sk)->highest_sack;
1385 static inline void tcp_highest_sack_reset(struct sock *sk)
1387 tcp_sk(sk)->highest_sack = tcp_write_queue_head(sk);
1390 /* Called when old skb is about to be deleted (to be combined with new skb) */
1391 static inline void tcp_highest_sack_combine(struct sock *sk,
1392 struct sk_buff *old,
1393 struct sk_buff *new)
1395 if (tcp_sk(sk)->sacked_out && (old == tcp_sk(sk)->highest_sack))
1396 tcp_sk(sk)->highest_sack = new;
1399 /* Determines whether this is a thin stream (which may suffer from
1400 * increased latency). Used to trigger latency-reducing mechanisms.
1402 static inline unsigned int tcp_stream_is_thin(struct tcp_sock *tp)
1404 return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
1407 /* /proc */
1408 enum tcp_seq_states {
1409 TCP_SEQ_STATE_LISTENING,
1410 TCP_SEQ_STATE_OPENREQ,
1411 TCP_SEQ_STATE_ESTABLISHED,
1412 TCP_SEQ_STATE_TIME_WAIT,
1415 int tcp_seq_open(struct inode *inode, struct file *file);
1417 struct tcp_seq_afinfo {
1418 char *name;
1419 sa_family_t family;
1420 const struct file_operations *seq_fops;
1421 struct seq_operations seq_ops;
1424 struct tcp_iter_state {
1425 struct seq_net_private p;
1426 sa_family_t family;
1427 enum tcp_seq_states state;
1428 struct sock *syn_wait_sk;
1429 int bucket, offset, sbucket, num, uid;
1430 loff_t last_pos;
1433 extern int tcp_proc_register(struct net *net, struct tcp_seq_afinfo *afinfo);
1434 extern void tcp_proc_unregister(struct net *net, struct tcp_seq_afinfo *afinfo);
1436 extern struct request_sock_ops tcp_request_sock_ops;
1437 extern struct request_sock_ops tcp6_request_sock_ops;
1439 extern void tcp_v4_destroy_sock(struct sock *sk);
1441 extern int tcp_v4_gso_send_check(struct sk_buff *skb);
1442 extern struct sk_buff *tcp_tso_segment(struct sk_buff *skb,
1443 netdev_features_t features);
1444 extern struct sk_buff **tcp_gro_receive(struct sk_buff **head,
1445 struct sk_buff *skb);
1446 extern struct sk_buff **tcp4_gro_receive(struct sk_buff **head,
1447 struct sk_buff *skb);
1448 extern int tcp_gro_complete(struct sk_buff *skb);
1449 extern int tcp4_gro_complete(struct sk_buff *skb);
1451 #ifdef CONFIG_PROC_FS
1452 extern int tcp4_proc_init(void);
1453 extern void tcp4_proc_exit(void);
1454 #endif
1456 /* TCP af-specific functions */
1457 struct tcp_sock_af_ops {
1458 #ifdef CONFIG_TCP_MD5SIG
1459 struct tcp_md5sig_key *(*md5_lookup) (struct sock *sk,
1460 struct sock *addr_sk);
1461 int (*calc_md5_hash) (char *location,
1462 struct tcp_md5sig_key *md5,
1463 const struct sock *sk,
1464 const struct request_sock *req,
1465 const struct sk_buff *skb);
1466 int (*md5_add) (struct sock *sk,
1467 struct sock *addr_sk,
1468 u8 *newkey,
1469 u8 len);
1470 int (*md5_parse) (struct sock *sk,
1471 char __user *optval,
1472 int optlen);
1473 #endif
1476 struct tcp_request_sock_ops {
1477 #ifdef CONFIG_TCP_MD5SIG
1478 struct tcp_md5sig_key *(*md5_lookup) (struct sock *sk,
1479 struct request_sock *req);
1480 int (*calc_md5_hash) (char *location,
1481 struct tcp_md5sig_key *md5,
1482 const struct sock *sk,
1483 const struct request_sock *req,
1484 const struct sk_buff *skb);
1485 #endif
1488 /* Using SHA1 for now, define some constants.
1490 #define COOKIE_DIGEST_WORDS (SHA_DIGEST_WORDS)
1491 #define COOKIE_MESSAGE_WORDS (SHA_MESSAGE_BYTES / 4)
1492 #define COOKIE_WORKSPACE_WORDS (COOKIE_DIGEST_WORDS + COOKIE_MESSAGE_WORDS)
1494 extern int tcp_cookie_generator(u32 *bakery);
1497 * struct tcp_cookie_values - each socket needs extra space for the
1498 * cookies, together with (optional) space for any SYN data.
1500 * A tcp_sock contains a pointer to the current value, and this is
1501 * cloned to the tcp_timewait_sock.
1503 * @cookie_pair: variable data from the option exchange.
1505 * @cookie_desired: user specified tcpct_cookie_desired. Zero
1506 * indicates default (sysctl_tcp_cookie_size).
1507 * After cookie sent, remembers size of cookie.
1508 * Range 0, TCP_COOKIE_MIN to TCP_COOKIE_MAX.
1510 * @s_data_desired: user specified tcpct_s_data_desired. When the
1511 * constant payload is specified (@s_data_constant),
1512 * holds its length instead.
1513 * Range 0 to TCP_MSS_DESIRED.
1515 * @s_data_payload: constant data that is to be included in the
1516 * payload of SYN or SYNACK segments when the
1517 * cookie option is present.
1519 struct tcp_cookie_values {
1520 struct kref kref;
1521 u8 cookie_pair[TCP_COOKIE_PAIR_SIZE];
1522 u8 cookie_pair_size;
1523 u8 cookie_desired;
1524 u16 s_data_desired:11,
1525 s_data_constant:1,
1526 s_data_in:1,
1527 s_data_out:1,
1528 s_data_unused:2;
1529 u8 s_data_payload[0];
1532 static inline void tcp_cookie_values_release(struct kref *kref)
1534 kfree(container_of(kref, struct tcp_cookie_values, kref));
1537 /* The length of constant payload data. Note that s_data_desired is
1538 * overloaded, depending on s_data_constant: either the length of constant
1539 * data (returned here) or the limit on variable data.
1541 static inline int tcp_s_data_size(const struct tcp_sock *tp)
1543 return (tp->cookie_values != NULL && tp->cookie_values->s_data_constant)
1544 ? tp->cookie_values->s_data_desired
1545 : 0;
1549 * struct tcp_extend_values - tcp_ipv?.c to tcp_output.c workspace.
1551 * As tcp_request_sock has already been extended in other places, the
1552 * only remaining method is to pass stack values along as function
1553 * parameters. These parameters are not needed after sending SYNACK.
1555 * @cookie_bakery: cryptographic secret and message workspace.
1557 * @cookie_plus: bytes in authenticator/cookie option, copied from
1558 * struct tcp_options_received (above).
1560 struct tcp_extend_values {
1561 struct request_values rv;
1562 u32 cookie_bakery[COOKIE_WORKSPACE_WORDS];
1563 u8 cookie_plus:6,
1564 cookie_out_never:1,
1565 cookie_in_always:1;
1568 static inline struct tcp_extend_values *tcp_xv(struct request_values *rvp)
1570 return (struct tcp_extend_values *)rvp;
1573 extern void tcp_v4_init(void);
1574 extern void tcp_init(void);
1576 #endif /* _TCP_H */