tcp.h 59.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9
/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the TCP module.
 *
 * Version:	@(#)tcp.h	1.0.5	05/23/93
 *
10
 * Authors:	Ross Biro
L
Linus Torvalds 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */
#ifndef _TCP_H
#define _TCP_H

#define FASTRETRANS_DEBUG 1

#include <linux/list.h>
#include <linux/tcp.h>
25
#include <linux/bug.h>
L
Linus Torvalds 已提交
26 27 28
#include <linux/slab.h>
#include <linux/cache.h>
#include <linux/percpu.h>
29
#include <linux/skbuff.h>
30
#include <linux/cryptohash.h>
31
#include <linux/kref.h>
32
#include <linux/ktime.h>
33 34

#include <net/inet_connection_sock.h>
35
#include <net/inet_timewait_sock.h>
36
#include <net/inet_hashtables.h>
L
Linus Torvalds 已提交
37
#include <net/checksum.h>
38
#include <net/request_sock.h>
L
Linus Torvalds 已提交
39 40 41
#include <net/sock.h>
#include <net/snmp.h>
#include <net/ip.h>
42
#include <net/tcp_states.h>
43
#include <net/inet_ecn.h>
44
#include <net/dst.h>
45

L
Linus Torvalds 已提交
46
#include <linux/seq_file.h>
47
#include <linux/memcontrol.h>
L
Linus Torvalds 已提交
48

49
extern struct inet_hashinfo tcp_hashinfo;
L
Linus Torvalds 已提交
50

51
extern struct percpu_counter tcp_orphan_count;
52
void tcp_time_wait(struct sock *sk, int state, int timeo);
L
Linus Torvalds 已提交
53 54

#define MAX_TCP_HEADER	(128 + MAX_HEADER)
A
Adam Langley 已提交
55
#define MAX_TCP_OPTION_SPACE 40
L
Linus Torvalds 已提交
56

57
/*
L
Linus Torvalds 已提交
58
 * Never offer a window over 32767 without using window scaling. Some
59
 * poor stacks do signed 16bit maths!
L
Linus Torvalds 已提交
60 61 62 63 64 65
 */
#define MAX_TCP_WINDOW		32767U

/* Minimal accepted MSS. It is (60+60+8) - (20+20). */
#define TCP_MIN_MSS		88U

J
John Heffner 已提交
66
/* The least MTU to use for probing */
67
#define TCP_BASE_MSS		1024
J
John Heffner 已提交
68

69 70 71
/* probing interval, default to 10 minutes as per RFC4821 */
#define TCP_PROBE_INTERVAL	600

72 73 74
/* Specify interval when tcp mtu probing will stop */
#define TCP_PROBE_THRESHOLD	8

L
Linus Torvalds 已提交
75 76 77 78 79 80
/* After receiving this amount of duplicate ACKs fast retransmit starts. */
#define TCP_FASTRETRANS_THRESH 3

/* Maximal number of ACKs sent quickly to accelerate slow-start. */
#define TCP_MAX_QUICKACKS	16U

81 82 83
/* Maximal number of window scale according to RFC1323 */
#define TCP_MAX_WSCALE		14U

L
Linus Torvalds 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
/* urg_data states */
#define TCP_URG_VALID	0x0100
#define TCP_URG_NOTYET	0x0200
#define TCP_URG_READ	0x0400

#define TCP_RETR1	3	/*
				 * This is how many retries it does before it
				 * tries to figure out if the gateway is
				 * down. Minimal RFC value is 3; it corresponds
				 * to ~3sec-8min depending on RTO.
				 */

#define TCP_RETR2	15	/*
				 * This should take at least
				 * 90 minutes to time out.
				 * RFC1122 says that the limit is 100 sec.
				 * 15 is ~13-30min depending on RTO.
				 */

103 104 105 106 107 108 109 110
#define TCP_SYN_RETRIES	 6	/* This is how many retries are done
				 * when active opening a connection.
				 * RFC1122 says the minimum retry MUST
				 * be at least 180secs.  Nevertheless
				 * this value is corresponding to
				 * 63secs of retransmission with the
				 * current initial RTO.
				 */
L
Linus Torvalds 已提交
111

112 113 114 115 116 117
#define TCP_SYNACK_RETRIES 5	/* This is how may retries are done
				 * when passive opening a connection.
				 * This is corresponding to 31secs of
				 * retransmission with the current
				 * initial RTO.
				 */
L
Linus Torvalds 已提交
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

#define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT
				  * state, about 60 seconds	*/
#define TCP_FIN_TIMEOUT	TCP_TIMEWAIT_LEN
                                 /* BSD style FIN_WAIT2 deadlock breaker.
				  * It used to be 3min, new value is 60sec,
				  * to combine FIN-WAIT-2 timeout with
				  * TIME-WAIT timer.
				  */

#define TCP_DELACK_MAX	((unsigned)(HZ/5))	/* maximal time to delay before sending an ACK */
#if HZ >= 100
#define TCP_DELACK_MIN	((unsigned)(HZ/25))	/* minimal time to delay before sending an ACK */
#define TCP_ATO_MIN	((unsigned)(HZ/25))
#else
#define TCP_DELACK_MIN	4U
#define TCP_ATO_MIN	4U
#endif
#define TCP_RTO_MAX	((unsigned)(120*HZ))
#define TCP_RTO_MIN	((unsigned)(HZ/5))
138
#define TCP_TIMEOUT_INIT ((unsigned)(1*HZ))	/* RFC6298 2.1 initial RTO value	*/
139 140 141 142 143 144
#define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ))	/* RFC 1122 initial RTO value, now
						 * used as a fallback RTO for the
						 * initial data transmission if no
						 * valid RTT sample has been acquired,
						 * most likely due to retrans in 3WHS.
						 */
L
Linus Torvalds 已提交
145 146 147 148

#define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes
					                 * for local resources.
					                 */
149
#define TCP_REO_TIMEOUT_MIN	(2000) /* Min RACK reordering timeout in usec */
L
Linus Torvalds 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

#define TCP_KEEPALIVE_TIME	(120*60*HZ)	/* two hours */
#define TCP_KEEPALIVE_PROBES	9		/* Max of 9 keepalive probes	*/
#define TCP_KEEPALIVE_INTVL	(75*HZ)

#define MAX_TCP_KEEPIDLE	32767
#define MAX_TCP_KEEPINTVL	32767
#define MAX_TCP_KEEPCNT		127
#define MAX_TCP_SYNCNT		127

#define TCP_SYNQ_INTERVAL	(HZ/5)	/* Period of SYNACK timer */

#define TCP_PAWS_24DAYS	(60 * 60 * 24 * 24)
#define TCP_PAWS_MSL	60		/* Per-host timestamps are invalidated
					 * after this time. It should be equal
					 * (or greater than) TCP_TIMEWAIT_LEN
					 * to provide reliability equal to one
					 * provided by timewait state.
					 */
#define TCP_PAWS_WINDOW	1		/* Replay window for per-host
					 * timestamps. It must be less than
					 * minimal timewait lifetime.
					 */
/*
 *	TCP option
 */
176

L
Linus Torvalds 已提交
177 178 179 180 181 182 183
#define TCPOPT_NOP		1	/* Padding */
#define TCPOPT_EOL		0	/* End of options */
#define TCPOPT_MSS		2	/* Segment size negotiating */
#define TCPOPT_WINDOW		3	/* Window scaling */
#define TCPOPT_SACK_PERM        4       /* SACK Permitted */
#define TCPOPT_SACK             5       /* SACK Block */
#define TCPOPT_TIMESTAMP	8	/* Better RTT estimations/PAWS */
184
#define TCPOPT_MD5SIG		19	/* MD5 Signature (RFC2385) */
185
#define TCPOPT_FASTOPEN		34	/* Fast open (RFC7413) */
Y
Yuchung Cheng 已提交
186 187 188 189 190
#define TCPOPT_EXP		254	/* Experimental */
/* Magic number to be after the option value for sharing TCP
 * experimental options. See draft-ietf-tcpm-experimental-options-00.txt
 */
#define TCPOPT_FASTOPEN_MAGIC	0xF989
L
Linus Torvalds 已提交
191 192 193 194 195 196 197 198 199

/*
 *     TCP option lengths
 */

#define TCPOLEN_MSS            4
#define TCPOLEN_WINDOW         3
#define TCPOLEN_SACK_PERM      2
#define TCPOLEN_TIMESTAMP      10
200
#define TCPOLEN_MD5SIG         18
201
#define TCPOLEN_FASTOPEN_BASE  2
Y
Yuchung Cheng 已提交
202
#define TCPOLEN_EXP_FASTOPEN_BASE  4
L
Linus Torvalds 已提交
203 204 205 206 207 208 209 210

/* But this is what stacks really send out. */
#define TCPOLEN_TSTAMP_ALIGNED		12
#define TCPOLEN_WSCALE_ALIGNED		4
#define TCPOLEN_SACKPERM_ALIGNED	4
#define TCPOLEN_SACK_BASE		2
#define TCPOLEN_SACK_BASE_ALIGNED	4
#define TCPOLEN_SACK_PERBLOCK		8
211
#define TCPOLEN_MD5SIG_ALIGNED		20
A
Adam Langley 已提交
212
#define TCPOLEN_MSS_ALIGNED		4
L
Linus Torvalds 已提交
213 214 215 216

/* Flags in tp->nonagle */
#define TCP_NAGLE_OFF		1	/* Nagle's algo is disabled */
#define TCP_NAGLE_CORK		2	/* Socket is corked	    */
S
Stephen Hemminger 已提交
217
#define TCP_NAGLE_PUSH		4	/* Cork is overridden for already queued data */
L
Linus Torvalds 已提交
218

A
Andreas Petlund 已提交
219 220 221
/* TCP thin-stream limits */
#define TCP_THIN_LINEAR_RETRIES 6       /* After 6 linear retries, do exp. backoff */

222
/* TCP initial congestion window as per rfc6928 */
223 224
#define TCP_INIT_CWND		10

225 226
/* Bit Flags for sysctl_tcp_fastopen */
#define	TFO_CLIENT_ENABLE	1
227
#define	TFO_SERVER_ENABLE	2
228
#define	TFO_CLIENT_NO_COOKIE	4	/* Data in SYN w/o cookie option */
229

230 231 232 233
/* Accept SYN data w/o any cookie option */
#define	TFO_SERVER_COOKIE_NOT_REQD	0x200

/* Force enable TFO on all listeners, i.e., not requiring the
234
 * TCP_FASTOPEN socket option.
235 236 237
 */
#define	TFO_SERVER_WO_SOCKOPT1	0x400

238

L
Linus Torvalds 已提交
239 240 241 242
/* sysctl variables for tcp */
extern int sysctl_tcp_timestamps;
extern int sysctl_tcp_window_scaling;
extern int sysctl_tcp_sack;
Y
Yuchung Cheng 已提交
243
extern int sysctl_tcp_fastopen;
L
Linus Torvalds 已提交
244 245 246 247 248 249 250
extern int sysctl_tcp_retrans_collapse;
extern int sysctl_tcp_stdurg;
extern int sysctl_tcp_rfc1337;
extern int sysctl_tcp_abort_on_overflow;
extern int sysctl_tcp_max_orphans;
extern int sysctl_tcp_fack;
extern int sysctl_tcp_reordering;
251
extern int sysctl_tcp_max_reordering;
L
Linus Torvalds 已提交
252
extern int sysctl_tcp_dsack;
253
extern long sysctl_tcp_mem[3];
L
Linus Torvalds 已提交
254 255 256 257 258 259 260 261 262
extern int sysctl_tcp_wmem[3];
extern int sysctl_tcp_rmem[3];
extern int sysctl_tcp_app_win;
extern int sysctl_tcp_adv_win_scale;
extern int sysctl_tcp_frto;
extern int sysctl_tcp_low_latency;
extern int sysctl_tcp_nometrics_save;
extern int sysctl_tcp_moderate_rcvbuf;
extern int sysctl_tcp_tso_win_divisor;
263
extern int sysctl_tcp_workaround_signed_windows;
264
extern int sysctl_tcp_slow_start_after_idle;
A
Andreas Petlund 已提交
265
extern int sysctl_tcp_thin_linear_timeouts;
A
Andreas Petlund 已提交
266
extern int sysctl_tcp_thin_dupack;
Y
Yuchung Cheng 已提交
267
extern int sysctl_tcp_early_retrans;
268 269 270
extern int sysctl_tcp_recovery;
#define TCP_RACK_LOSS_DETECTION  0x1 /* Use RACK to detect losses */

E
Eric Dumazet 已提交
271
extern int sysctl_tcp_limit_output_bytes;
E
Eric Dumazet 已提交
272
extern int sysctl_tcp_challenge_ack_limit;
E
Eric Dumazet 已提交
273
extern int sysctl_tcp_min_tso_segs;
274
extern int sysctl_tcp_min_rtt_wlen;
E
Eric Dumazet 已提交
275
extern int sysctl_tcp_autocorking;
276
extern int sysctl_tcp_invalid_ratelimit;
277 278
extern int sysctl_tcp_pacing_ss_ratio;
extern int sysctl_tcp_pacing_ca_ratio;
L
Linus Torvalds 已提交
279

E
Eric Dumazet 已提交
280
extern atomic_long_t tcp_memory_allocated;
281
extern struct percpu_counter tcp_sockets_allocated;
L
Linus Torvalds 已提交
282 283
extern int tcp_memory_pressure;

284 285 286
/* optimized version of sk_under_memory_pressure() for TCP sockets */
static inline bool tcp_under_memory_pressure(const struct sock *sk)
{
287 288
	if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
	    mem_cgroup_under_socket_pressure(sk->sk_memcg))
289
		return true;
290 291 292

	return tcp_memory_pressure;
}
L
Linus Torvalds 已提交
293 294 295 296 297
/*
 * The next routines deal with comparing 32 bit unsigned ints
 * and worry about wraparound (automatic with unsigned arithmetic).
 */

E
Eric Dumazet 已提交
298
static inline bool before(__u32 seq1, __u32 seq2)
L
Linus Torvalds 已提交
299
{
300
        return (__s32)(seq1-seq2) < 0;
L
Linus Torvalds 已提交
301
}
302
#define after(seq2, seq1) 	before(seq1, seq2)
L
Linus Torvalds 已提交
303 304

/* is s2<=s1<=s3 ? */
E
Eric Dumazet 已提交
305
static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3)
L
Linus Torvalds 已提交
306 307 308 309
{
	return seq3 - seq2 >= seq1 - seq2;
}

A
Arun Sharma 已提交
310 311 312 313 314 315 316 317
static inline bool tcp_out_of_memory(struct sock *sk)
{
	if (sk->sk_wmem_queued > SOCK_MIN_SNDBUF &&
	    sk_memory_allocated(sk) > sk_prot_mem_limits(sk, 2))
		return true;
	return false;
}

318 319
void sk_forced_mem_schedule(struct sock *sk, int size);

320
static inline bool tcp_too_many_orphans(struct sock *sk, int shift)
321
{
322 323 324 325 326 327 328 329 330
	struct percpu_counter *ocp = sk->sk_prot->orphan_count;
	int orphans = percpu_counter_read_positive(ocp);

	if (orphans << shift > sysctl_tcp_max_orphans) {
		orphans = percpu_counter_sum_positive(ocp);
		if (orphans << shift > sysctl_tcp_max_orphans)
			return true;
	}
	return false;
331
}
L
Linus Torvalds 已提交
332

333
bool tcp_check_oom(struct sock *sk, int shift);
A
Arun Sharma 已提交
334

335

L
Linus Torvalds 已提交
336 337
extern struct proto tcp_prot;

338
#define TCP_INC_STATS(net, field)	SNMP_INC_STATS((net)->mib.tcp_statistics, field)
E
Eric Dumazet 已提交
339
#define __TCP_INC_STATS(net, field)	__SNMP_INC_STATS((net)->mib.tcp_statistics, field)
340
#define TCP_DEC_STATS(net, field)	SNMP_DEC_STATS((net)->mib.tcp_statistics, field)
341
#define TCP_ADD_STATS(net, field, val)	SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val)
L
Linus Torvalds 已提交
342

343 344 345 346 347 348 349 350 351 352
void tcp_tasklet_init(void);

void tcp_v4_err(struct sk_buff *skb, u32);

void tcp_shutdown(struct sock *sk, int how);

void tcp_v4_early_demux(struct sk_buff *skb);
int tcp_v4_rcv(struct sk_buff *skb);

int tcp_v4_tw_remember_stamp(struct inet_timewait_sock *tw);
353
int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
354 355 356 357 358 359 360
int tcp_sendpage(struct sock *sk, struct page *page, int offset, size_t size,
		 int flags);
void tcp_release_cb(struct sock *sk);
void tcp_wfree(struct sk_buff *skb);
void tcp_write_timer_handler(struct sock *sk);
void tcp_delack_timer_handler(struct sock *sk);
int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg);
361
int tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb);
362 363 364 365 366 367 368 369
void tcp_rcv_established(struct sock *sk, struct sk_buff *skb,
			 const struct tcphdr *th, unsigned int len);
void tcp_rcv_space_adjust(struct sock *sk);
int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp);
void tcp_twsk_destructor(struct sock *sk);
ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos,
			struct pipe_inode_info *pipe, size_t len,
			unsigned int flags);
J
Jens Axboe 已提交
370

371 372
static inline void tcp_dec_quickack_mode(struct sock *sk,
					 const unsigned int pkts)
L
Linus Torvalds 已提交
373
{
374
	struct inet_connection_sock *icsk = inet_csk(sk);
375

376 377 378
	if (icsk->icsk_ack.quick) {
		if (pkts >= icsk->icsk_ack.quick) {
			icsk->icsk_ack.quick = 0;
379
			/* Leaving quickack mode we deflate ATO. */
380
			icsk->icsk_ack.ato   = TCP_ATO_MIN;
381
		} else
382
			icsk->icsk_ack.quick -= pkts;
L
Linus Torvalds 已提交
383 384 385
	}
}

386 387 388
#define	TCP_ECN_OK		1
#define	TCP_ECN_QUEUE_CWR	2
#define	TCP_ECN_DEMAND_CWR	4
389
#define	TCP_ECN_SEEN		8
390

E
Eric Dumazet 已提交
391
enum tcp_tw_status {
L
Linus Torvalds 已提交
392 393 394 395 396 397 398
	TCP_TW_SUCCESS = 0,
	TCP_TW_RST = 1,
	TCP_TW_ACK = 2,
	TCP_TW_SYN = 3
};


399 400 401 402
enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw,
					      struct sk_buff *skb,
					      const struct tcphdr *th);
struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb,
403
			   struct request_sock *req, bool fastopen);
404 405
int tcp_child_process(struct sock *parent, struct sock *child,
		      struct sk_buff *skb);
406
void tcp_enter_loss(struct sock *sk);
407
void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int flag);
408 409 410 411
void tcp_clear_retrans(struct tcp_sock *tp);
void tcp_update_metrics(struct sock *sk);
void tcp_init_metrics(struct sock *sk);
void tcp_metrics_init(void);
412
bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst);
413 414 415 416 417 418 419 420 421 422
void tcp_disable_fack(struct tcp_sock *tp);
void tcp_close(struct sock *sk, long timeout);
void tcp_init_sock(struct sock *sk);
unsigned int tcp_poll(struct file *file, struct socket *sock,
		      struct poll_table_struct *wait);
int tcp_getsockopt(struct sock *sk, int level, int optname,
		   char __user *optval, int __user *optlen);
int tcp_setsockopt(struct sock *sk, int level, int optname,
		   char __user *optval, unsigned int optlen);
int compat_tcp_getsockopt(struct sock *sk, int level, int optname,
C
Changli Gao 已提交
423
			  char __user *optval, int __user *optlen);
424
int compat_tcp_setsockopt(struct sock *sk, int level, int optname,
C
Changli Gao 已提交
425
			  char __user *optval, unsigned int optlen);
426
void tcp_set_keepalive(struct sock *sk, int val);
427
void tcp_syn_ack_timeout(const struct request_sock *req);
428 429
int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int nonblock,
		int flags, int *addr_len);
430 431 432 433
void tcp_parse_options(const struct sk_buff *skb,
		       struct tcp_options_received *opt_rx,
		       int estab, struct tcp_fastopen_cookie *foc);
const u8 *tcp_parse_md5sig_option(const struct tcphdr *th);
434

L
Linus Torvalds 已提交
435 436 437 438
/*
 *	TCP v4 functions exported for the inet6 API
 */

439
void tcp_v4_send_check(struct sock *sk, struct sk_buff *skb);
440
void tcp_v4_mtu_reduced(struct sock *sk);
441
void tcp_req_err(struct sock *sk, u32 seq, bool abort);
442
int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
443
struct sock *tcp_create_openreq_child(const struct sock *sk,
444 445
				      struct request_sock *req,
				      struct sk_buff *skb);
446
void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst);
447
struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb,
448
				  struct request_sock *req,
449 450 451
				  struct dst_entry *dst,
				  struct request_sock *req_unhash,
				  bool *own_req);
452 453 454
int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
int tcp_v4_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len);
int tcp_connect(struct sock *sk);
455 456 457 458 459
enum tcp_synack_type {
	TCP_SYNACK_NORMAL,
	TCP_SYNACK_FASTOPEN,
	TCP_SYNACK_COOKIE,
};
460
struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst,
461
				struct request_sock *req,
462
				struct tcp_fastopen_cookie *foc,
463
				enum tcp_synack_type synack_type);
464
int tcp_disconnect(struct sock *sk, int flags);
L
Linus Torvalds 已提交
465

P
Pavel Emelyanov 已提交
466
void tcp_finish_connect(struct sock *sk, struct sk_buff *skb);
467
int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size);
468
void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb);
L
Linus Torvalds 已提交
469 470

/* From syncookies.c */
471 472
struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
				 struct request_sock *req,
473
				 struct dst_entry *dst, u32 tsoff);
474 475
int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
		      u32 cookie);
C
Cong Wang 已提交
476
struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb);
477
#ifdef CONFIG_SYN_COOKIES
478

479
/* Syncookies use a monotonic timer which increments every 60 seconds.
480 481 482
 * This counter is used both as a hash input and partially encoded into
 * the cookie value.  A cookie is only validated further if the delta
 * between the current counter value and the encoded one is less than this,
483
 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if
484 485
 * the counter advances immediately after a cookie is generated).
 */
486 487 488 489 490 491
#define MAX_SYNCOOKIE_AGE	2
#define TCP_SYNCOOKIE_PERIOD	(60 * HZ)
#define TCP_SYNCOOKIE_VALID	(MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD)

/* syncookies: remember time of last synqueue overflow
 * But do not dirty this field too often (once per second is enough)
492
 * It is racy as we do not hold a lock, but race is very minor.
493
 */
494
static inline void tcp_synq_overflow(const struct sock *sk)
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
{
	unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;
	unsigned long now = jiffies;

	if (time_after(now, last_overflow + HZ))
		tcp_sk(sk)->rx_opt.ts_recent_stamp = now;
}

/* syncookies: no recent synqueue overflow on this listening socket? */
static inline bool tcp_synq_no_recent_overflow(const struct sock *sk)
{
	unsigned long last_overflow = tcp_sk(sk)->rx_opt.ts_recent_stamp;

	return time_after(jiffies, last_overflow + TCP_SYNCOOKIE_VALID);
}
510 511 512

static inline u32 tcp_cookie_time(void)
{
513 514
	u64 val = get_jiffies_64();

515
	do_div(val, TCP_SYNCOOKIE_PERIOD);
516
	return val;
517 518
}

519 520
u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
			      u16 *mssp);
521
__u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss);
522
u64 cookie_init_timestamp(struct request_sock *req);
523 524
bool cookie_timestamp_decode(struct tcp_options_received *opt);
bool cookie_ecn_ok(const struct tcp_options_received *opt,
525
		   const struct net *net, const struct dst_entry *dst);
526

527
/* From net/ipv6/syncookies.c */
528 529 530
int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th,
		      u32 cookie);
struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb);
531

532 533
u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph,
			      const struct tcphdr *th, u16 *mssp);
534
__u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss);
535
#endif
L
Linus Torvalds 已提交
536 537
/* tcp_output.c */

538 539
u32 tcp_tso_autosize(const struct sock *sk, unsigned int mss_now,
		     int min_tso_segs);
540 541 542
void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss,
			       int nonagle);
bool tcp_may_send_now(struct sock *sk);
543 544
int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs);
545 546 547
void tcp_retransmit_timer(struct sock *sk);
void tcp_xmit_retransmit_queue(struct sock *);
void tcp_simple_retransmit(struct sock *);
548
void tcp_enter_recovery(struct sock *sk, bool ece_ack);
549
int tcp_trim_head(struct sock *, struct sk_buff *, u32);
550
int tcp_fragment(struct sock *, struct sk_buff *, u32, unsigned int, gfp_t);
551 552 553

void tcp_send_probe0(struct sock *);
void tcp_send_partial(struct sock *);
554
int tcp_write_wakeup(struct sock *, int mib);
555 556 557 558 559 560 561 562
void tcp_send_fin(struct sock *sk);
void tcp_send_active_reset(struct sock *sk, gfp_t priority);
int tcp_send_synack(struct sock *);
void tcp_push_one(struct sock *, unsigned int mss_now);
void tcp_send_ack(struct sock *sk);
void tcp_send_delayed_ack(struct sock *sk);
void tcp_send_loss_probe(struct sock *sk);
bool tcp_schedule_loss_probe(struct sock *sk);
563 564
void tcp_skb_collapse_tstamp(struct sk_buff *skb,
			     const struct sk_buff *next_skb);
L
Linus Torvalds 已提交
565

566
/* tcp_input.c */
567
void tcp_rearm_rto(struct sock *sk);
Y
Yuchung Cheng 已提交
568
void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req);
569
void tcp_reset(struct sock *sk);
Y
Yuchung Cheng 已提交
570
void tcp_skb_mark_lost_uncond_verify(struct tcp_sock *tp, struct sk_buff *skb);
571
void tcp_fin(struct sock *sk);
572

L
Linus Torvalds 已提交
573
/* tcp_timer.c */
574
void tcp_init_xmit_timers(struct sock *);
575 576
static inline void tcp_clear_xmit_timers(struct sock *sk)
{
577
	hrtimer_cancel(&tcp_sk(sk)->pacing_timer);
578 579
	inet_csk_clear_xmit_timers(sk);
}
L
Linus Torvalds 已提交
580

581 582
unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu);
unsigned int tcp_current_mss(struct sock *sk);
I
Ilpo Järvinen 已提交
583 584 585 586

/* Bound MSS / TSO packet size with the half of the window */
static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize)
{
587 588 589 590 591 592 593 594 595
	int cutoff;

	/* When peer uses tiny windows, there is no use in packetizing
	 * to sub-MSS pieces for the sake of SWS or making sure there
	 * are enough packets in the pipe for fast recovery.
	 *
	 * On the other hand, for extremely large MSS devices, handling
	 * smaller than MSS windows in this way does make sense.
	 */
596
	if (tp->max_window > TCP_MSS_DEFAULT)
597 598 599 600 601 602
		cutoff = (tp->max_window >> 1);
	else
		cutoff = tp->max_window;

	if (cutoff && pktsize > cutoff)
		return max_t(int, cutoff, 68U - tp->tcp_header_len);
I
Ilpo Järvinen 已提交
603 604 605
	else
		return pktsize;
}
L
Linus Torvalds 已提交
606

607
/* tcp.c */
608
void tcp_get_info(struct sock *, struct tcp_info *);
L
Linus Torvalds 已提交
609 610

/* Read 'sendfile()'-style from a TCP socket */
611 612
int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
		  sk_read_actor_t recv_actor);
L
Linus Torvalds 已提交
613

614
void tcp_initialize_rcv_mss(struct sock *sk);
L
Linus Torvalds 已提交
615

616 617 618 619
int tcp_mtu_to_mss(struct sock *sk, int pmtu);
int tcp_mss_to_mtu(struct sock *sk, int mss);
void tcp_mtup_init(struct sock *sk);
void tcp_init_buffer_space(struct sock *sk);
J
John Heffner 已提交
620

621 622 623 624 625 626 627 628
static inline void tcp_bound_rto(const struct sock *sk)
{
	if (inet_csk(sk)->icsk_rto > TCP_RTO_MAX)
		inet_csk(sk)->icsk_rto = TCP_RTO_MAX;
}

static inline u32 __tcp_set_rto(const struct tcp_sock *tp)
{
629
	return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us);
630 631
}

S
Stephen Hemminger 已提交
632
static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd)
L
Linus Torvalds 已提交
633 634 635 636 637 638
{
	tp->pred_flags = htonl((tp->tcp_header_len << 26) |
			       ntohl(TCP_FLAG_ACK) |
			       snd_wnd);
}

S
Stephen Hemminger 已提交
639
static inline void tcp_fast_path_on(struct tcp_sock *tp)
L
Linus Torvalds 已提交
640 641 642 643
{
	__tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale);
}

644
static inline void tcp_fast_path_check(struct sock *sk)
L
Linus Torvalds 已提交
645
{
646 647
	struct tcp_sock *tp = tcp_sk(sk);

648
	if (RB_EMPTY_ROOT(&tp->out_of_order_queue) &&
L
Linus Torvalds 已提交
649 650 651 652 653 654
	    tp->rcv_wnd &&
	    atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf &&
	    !tp->urg_data)
		tcp_fast_path_on(tp);
}

655 656 657
/* Compute the actual rto_min value */
static inline u32 tcp_rto_min(struct sock *sk)
{
658
	const struct dst_entry *dst = __sk_dst_get(sk);
659 660 661 662 663 664 665
	u32 rto_min = TCP_RTO_MIN;

	if (dst && dst_metric_locked(dst, RTAX_RTO_MIN))
		rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN);
	return rto_min;
}

666 667 668 669 670
static inline u32 tcp_rto_min_us(struct sock *sk)
{
	return jiffies_to_usecs(tcp_rto_min(sk));
}

671 672 673 674 675
static inline bool tcp_ca_dst_locked(const struct dst_entry *dst)
{
	return dst_metric_locked(dst, RTAX_CC_ALGO);
}

676 677 678
/* Minimum RTT in usec. ~0 means not available. */
static inline u32 tcp_min_rtt(const struct tcp_sock *tp)
{
679
	return minmax_get(&tp->rtt_min);
680 681
}

L
Linus Torvalds 已提交
682 683 684 685
/* Compute the actual receive window we are currently advertising.
 * Rcv_nxt can be after the window if our peer push more data
 * than the offered window.
 */
S
Stephen Hemminger 已提交
686
static inline u32 tcp_receive_window(const struct tcp_sock *tp)
L
Linus Torvalds 已提交
687 688 689 690 691 692 693 694 695 696 697 698
{
	s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt;

	if (win < 0)
		win = 0;
	return (u32) win;
}

/* Choose a new window, without checks for shrinking, and without
 * scaling applied to the result.  The caller does these things
 * if necessary.  This is a "raw" window selection.
 */
699
u32 __tcp_select_window(struct sock *sk);
L
Linus Torvalds 已提交
700

P
Pavel Emelyanov 已提交
701 702
void tcp_send_window_probe(struct sock *sk);

E
Eric Dumazet 已提交
703 704 705 706 707 708
/* TCP uses 32bit jiffies to save some space.
 * Note that this is different from tcp_time_stamp, which
 * historically has been the same until linux-4.13.
 */
#define tcp_jiffies32 ((u32)jiffies)

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
/*
 * Deliver a 32bit value for TCP timestamp option (RFC 7323)
 * It is no longer tied to jiffies, but to 1 ms clock.
 * Note: double check if you want to use tcp_jiffies32 instead of this.
 */
#define TCP_TS_HZ	1000

static inline u64 tcp_clock_ns(void)
{
	return local_clock();
}

static inline u64 tcp_clock_us(void)
{
	return div_u64(tcp_clock_ns(), NSEC_PER_USEC);
}

/* This should only be used in contexts where tp->tcp_mstamp is up to date */
static inline u32 tcp_time_stamp(const struct tcp_sock *tp)
{
	return div_u64(tp->tcp_mstamp, USEC_PER_SEC / TCP_TS_HZ);
}

/* Could use tcp_clock_us() / 1000, but this version uses a single divide */
static inline u32 tcp_time_stamp_raw(void)
{
	return div_u64(tcp_clock_ns(), NSEC_PER_SEC / TCP_TS_HZ);
}


/* Refresh 1us clock of a TCP socket,
 * ensuring monotically increasing values.
L
Linus Torvalds 已提交
741
 */
742 743 744 745 746 747 748 749 750 751 752 753
static inline void tcp_mstamp_refresh(struct tcp_sock *tp)
{
	u64 val = tcp_clock_us();

	if (val > tp->tcp_mstamp)
		tp->tcp_mstamp = val;
}

static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0)
{
	return max_t(s64, t1 - t0, 0);
}
L
Linus Torvalds 已提交
754

E
Eric Dumazet 已提交
755 756
static inline u32 tcp_skb_timestamp(const struct sk_buff *skb)
{
757
	return div_u64(skb->skb_mstamp, USEC_PER_SEC / TCP_TS_HZ);
E
Eric Dumazet 已提交
758 759 760
}


C
Changli Gao 已提交
761 762 763 764 765 766 767 768 769 770 771
#define tcp_flag_byte(th) (((u_int8_t *)th)[13])

#define TCPHDR_FIN 0x01
#define TCPHDR_SYN 0x02
#define TCPHDR_RST 0x04
#define TCPHDR_PSH 0x08
#define TCPHDR_ACK 0x10
#define TCPHDR_URG 0x20
#define TCPHDR_ECE 0x40
#define TCPHDR_CWR 0x80

772 773
#define TCPHDR_SYN_ECN	(TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR)

S
Stephen Hemminger 已提交
774
/* This is what the send packet queuing engine uses to pass
775 776 777 778
 * TCP per-packet control information to the transmission code.
 * We also store the host-order sequence numbers in here too.
 * This is 44 bytes if IPV6 is enabled.
 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately.
L
Linus Torvalds 已提交
779 780 781 782
 */
struct tcp_skb_cb {
	__u32		seq;		/* Starting sequence number	*/
	__u32		end_seq;	/* SEQ + FIN + SYN + datalen	*/
783 784 785 786
	union {
		/* Note : tcp_tw_isn is used in input path only
		 *	  (isn chosen by tcp_timewait_state_process())
		 *
787 788
		 * 	  tcp_gso_segs/size are used in write queue only,
		 *	  cf tcp_skb_pcount()/tcp_skb_mss()
789 790
		 */
		__u32		tcp_tw_isn;
791 792 793 794
		struct {
			u16	tcp_gso_segs;
			u16	tcp_gso_size;
		};
795
	};
E
Eric Dumazet 已提交
796
	__u8		tcp_flags;	/* TCP header flags. (tcp[13])	*/
797

L
Linus Torvalds 已提交
798 799 800 801 802
	__u8		sacked;		/* State flags for SACK/FACK.	*/
#define TCPCB_SACKED_ACKED	0x01	/* SKB ACK'd by a SACK block	*/
#define TCPCB_SACKED_RETRANS	0x02	/* SKB retransmitted		*/
#define TCPCB_LOST		0x04	/* SKB is lost			*/
#define TCPCB_TAGBITS		0x07	/* All tag bits			*/
803
#define TCPCB_REPAIRED		0x10	/* SKB repaired (no skb_mstamp)	*/
L
Linus Torvalds 已提交
804
#define TCPCB_EVER_RETRANS	0x80	/* Ever retransmitted frame	*/
805 806
#define TCPCB_RETRANS		(TCPCB_SACKED_RETRANS|TCPCB_EVER_RETRANS| \
				TCPCB_REPAIRED)
L
Linus Torvalds 已提交
807

808
	__u8		ip_dsfield;	/* IPv4 tos or IPv6 dsfield	*/
809
	__u8		txstamp_ack:1,	/* Record TX timestamp for ack? */
810 811
			eor:1,		/* Is skb MSG_EOR marked? */
			unused:6;
L
Linus Torvalds 已提交
812
	__u32		ack_seq;	/* Sequence number ACK'd	*/
813
	union {
814
		struct {
815
			/* There is space for up to 24 bytes */
816 817 818
			__u32 in_flight:30,/* Bytes in flight at transmit */
			      is_app_limited:1, /* cwnd not fully used? */
			      unused:1;
819 820 821
			/* pkts S/ACKed so far upon tx of skb, incl retrans: */
			__u32 delivered;
			/* start of send pipeline phase */
822
			u64 first_tx_mstamp;
823
			/* when we reached the "delivered" count */
824
			u64 delivered_mstamp;
825 826 827
		} tx;   /* only used for outgoing skbs */
		union {
			struct inet_skb_parm	h4;
828
#if IS_ENABLED(CONFIG_IPV6)
829
			struct inet6_skb_parm	h6;
830
#endif
831 832
		} header;	/* For incoming skbs */
	};
L
Linus Torvalds 已提交
833 834 835 836
};

#define TCP_SKB_CB(__skb)	((struct tcp_skb_cb *)&((__skb)->cb[0]))

E
Eric Dumazet 已提交
837

838
#if IS_ENABLED(CONFIG_IPV6)
E
Eric Dumazet 已提交
839 840 841 842 843
/* This is the variant of inet6_iif() that must be used by TCP,
 * as TCP moves IP6CB into a different location in skb->cb[]
 */
static inline int tcp_v6_iif(const struct sk_buff *skb)
{
844
	bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags);
845 846

	return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif;
E
Eric Dumazet 已提交
847
}
848
#endif
E
Eric Dumazet 已提交
849

850 851 852 853 854
/* TCP_SKB_CB reference means this can not be used from early demux */
static inline bool inet_exact_dif_match(struct net *net, struct sk_buff *skb)
{
#if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV)
	if (!net->ipv4.sysctl_tcp_l3mdev_accept &&
855
	    skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags))
856 857 858 859 860
		return true;
#endif
	return false;
}

L
Linus Torvalds 已提交
861 862
/* Due to TSO, an SKB can be composed of multiple actual
 * packets.  To keep these tracked properly, we use this.
863
 */
L
Linus Torvalds 已提交
864
static inline int tcp_skb_pcount(const struct sk_buff *skb)
865
{
866 867
	return TCP_SKB_CB(skb)->tcp_gso_segs;
}
868

869 870 871
static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs)
{
	TCP_SKB_CB(skb)->tcp_gso_segs = segs;
872 873
}

874
static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs)
L
Linus Torvalds 已提交
875
{
876
	TCP_SKB_CB(skb)->tcp_gso_segs += segs;
L
Linus Torvalds 已提交
877 878
}

879
/* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */
L
Linus Torvalds 已提交
880 881
static inline int tcp_skb_mss(const struct sk_buff *skb)
{
882
	return TCP_SKB_CB(skb)->tcp_gso_size;
L
Linus Torvalds 已提交
883 884
}

885 886 887 888 889
static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb)
{
	return likely(!TCP_SKB_CB(skb)->eor);
}

890 891 892 893 894 895
/* Events passed to congestion control interface */
enum tcp_ca_event {
	CA_EVENT_TX_START,	/* first transmit when no packets in flight */
	CA_EVENT_CWND_RESTART,	/* congestion window restart */
	CA_EVENT_COMPLETE_CWR,	/* end of congestion recovery */
	CA_EVENT_LOSS,		/* loss timeout */
896 897 898 899
	CA_EVENT_ECN_NO_CE,	/* ECT set, but not CE marked */
	CA_EVENT_ECN_IS_CE,	/* received CE marked IP packet */
	CA_EVENT_DELAYED_ACK,	/* Delayed ack is sent */
	CA_EVENT_NON_DELAYED_ACK,
900 901
};

902
/* Information about inbound ACK, passed to cong_ops->in_ack_event() */
903
enum tcp_ca_ack_event_flags {
904 905 906
	CA_ACK_SLOWPATH		= (1 << 0),	/* In slow path processing */
	CA_ACK_WIN_UPDATE	= (1 << 1),	/* ACK updated window */
	CA_ACK_ECE		= (1 << 2),	/* ECE bit is set on ack */
907 908 909 910 911 912
};

/*
 * Interface for adding new TCP congestion control handlers
 */
#define TCP_CA_NAME_MAX	16
913 914 915
#define TCP_CA_MAX	128
#define TCP_CA_BUF_MAX	(TCP_CA_NAME_MAX*TCP_CA_MAX)

916 917
#define TCP_CA_UNSPEC	0

918
/* Algorithm can be set on socket without CAP_NET_ADMIN privileges */
919
#define TCP_CONG_NON_RESTRICTED 0x1
920 921
/* Requires ECN/ECT set on all packets */
#define TCP_CONG_NEEDS_ECN	0x2
922

923 924
union tcp_cc_info;

925 926 927
struct ack_sample {
	u32 pkts_acked;
	s32 rtt_us;
928
	u32 in_flight;
929 930
};

931 932 933 934 935 936 937 938 939
/* A rate sample measures the number of (original/retransmitted) data
 * packets delivered "delivered" over an interval of time "interval_us".
 * The tcp_rate.c code fills in the rate sample, and congestion
 * control modules that define a cong_control function to run at the end
 * of ACK processing can optionally chose to consult this sample when
 * setting cwnd and pacing rate.
 * A sample is invalid if "delivered" or "interval_us" is negative.
 */
struct rate_sample {
940
	u64  prior_mstamp; /* starting timestamp for interval */
941 942 943 944 945 946 947
	u32  prior_delivered;	/* tp->delivered at "prior_mstamp" */
	s32  delivered;		/* number of packets delivered over interval */
	long interval_us;	/* time for tp->delivered to incr "delivered" */
	long rtt_us;		/* RTT of last (S)ACKed packet (or -1) */
	int  losses;		/* number of packets marked lost upon ACK */
	u32  acked_sacked;	/* number of packets newly (S)ACKed upon ACK */
	u32  prior_in_flight;	/* in flight before this ACK */
948
	bool is_app_limited;	/* is sample from packet with bubble in pipe? */
949 950 951
	bool is_retrans;	/* is sample from retransmission? */
};

952 953
struct tcp_congestion_ops {
	struct list_head	list;
954 955
	u32 key;
	u32 flags;
956 957

	/* initialize private data (optional) */
958
	void (*init)(struct sock *sk);
959
	/* cleanup private data  (optional) */
960
	void (*release)(struct sock *sk);
961 962

	/* return slow start threshold (required) */
963
	u32 (*ssthresh)(struct sock *sk);
964
	/* do new cwnd calculation (required) */
965
	void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked);
966
	/* call before changing ca_state (optional) */
967
	void (*set_state)(struct sock *sk, u8 new_state);
968
	/* call when cwnd event occurs (optional) */
969
	void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev);
970 971
	/* call when ack arrives (optional) */
	void (*in_ack_event)(struct sock *sk, u32 flags);
972
	/* new value of cwnd after loss (optional) */
973
	u32  (*undo_cwnd)(struct sock *sk);
974
	/* hook for packet ack accounting (optional) */
975
	void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample);
976 977
	/* suggest number of segments for each skb to transmit (optional) */
	u32 (*tso_segs_goal)(struct sock *sk);
978 979
	/* returns the multiplier used in tcp_sndbuf_expand (optional) */
	u32 (*sndbuf_expand)(struct sock *sk);
980 981 982 983
	/* call when packets are delivered to update cwnd and pacing rate,
	 * after all the ca_state processing. (optional)
	 */
	void (*cong_control)(struct sock *sk, const struct rate_sample *rs);
984
	/* get info for inet_diag (optional) */
985 986
	size_t (*get_info)(struct sock *sk, u32 ext, int *attr,
			   union tcp_cc_info *info);
987 988 989 990 991

	char 		name[TCP_CA_NAME_MAX];
	struct module 	*owner;
};

992 993
int tcp_register_congestion_control(struct tcp_congestion_ops *type);
void tcp_unregister_congestion_control(struct tcp_congestion_ops *type);
994

995
void tcp_assign_congestion_control(struct sock *sk);
996 997 998 999 1000 1001 1002 1003
void tcp_init_congestion_control(struct sock *sk);
void tcp_cleanup_congestion_control(struct sock *sk);
int tcp_set_default_congestion_control(const char *name);
void tcp_get_default_congestion_control(char *name);
void tcp_get_available_congestion_control(char *buf, size_t len);
void tcp_get_allowed_congestion_control(char *buf, size_t len);
int tcp_set_allowed_congestion_control(char *allowed);
int tcp_set_congestion_control(struct sock *sk, const char *name);
N
Neal Cardwell 已提交
1004 1005
u32 tcp_slow_start(struct tcp_sock *tp, u32 acked);
void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked);
1006

1007
u32 tcp_reno_ssthresh(struct sock *sk);
1008
u32 tcp_reno_undo_cwnd(struct sock *sk);
1009
void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked);
1010
extern struct tcp_congestion_ops tcp_reno;
1011

1012
struct tcp_congestion_ops *tcp_ca_find_key(u32 key);
1013
u32 tcp_ca_get_key_by_name(const char *name, bool *ecn_ca);
1014
#ifdef CONFIG_INET
1015
char *tcp_ca_get_name_by_key(u32 key, char *buffer);
1016 1017 1018 1019 1020 1021
#else
static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer)
{
	return NULL;
}
#endif
1022

1023 1024 1025 1026 1027 1028 1029
static inline bool tcp_ca_needs_ecn(const struct sock *sk)
{
	const struct inet_connection_sock *icsk = inet_csk(sk);

	return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN;
}

1030
static inline void tcp_set_ca_state(struct sock *sk, const u8 ca_state)
1031
{
1032 1033 1034 1035 1036
	struct inet_connection_sock *icsk = inet_csk(sk);

	if (icsk->icsk_ca_ops->set_state)
		icsk->icsk_ca_ops->set_state(sk, ca_state);
	icsk->icsk_ca_state = ca_state;
1037 1038
}

1039
static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event)
1040
{
1041 1042 1043 1044
	const struct inet_connection_sock *icsk = inet_csk(sk);

	if (icsk->icsk_ca_ops->cwnd_event)
		icsk->icsk_ca_ops->cwnd_event(sk, event);
1045 1046
}

1047 1048 1049 1050 1051
/* From tcp_rate.c */
void tcp_rate_skb_sent(struct sock *sk, struct sk_buff *skb);
void tcp_rate_skb_delivered(struct sock *sk, struct sk_buff *skb,
			    struct rate_sample *rs);
void tcp_rate_gen(struct sock *sk, u32 delivered, u32 lost,
1052
		  struct rate_sample *rs);
1053
void tcp_rate_check_app_limited(struct sock *sk);
1054

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/* These functions determine how the current flow behaves in respect of SACK
 * handling. SACK is negotiated with the peer, and therefore it can vary
 * between different flows.
 *
 * tcp_is_sack - SACK enabled
 * tcp_is_reno - No SACK
 * tcp_is_fack - FACK enabled, implies SACK enabled
 */
static inline int tcp_is_sack(const struct tcp_sock *tp)
{
	return tp->rx_opt.sack_ok;
}

E
Eric Dumazet 已提交
1068
static inline bool tcp_is_reno(const struct tcp_sock *tp)
1069 1070 1071 1072
{
	return !tcp_is_sack(tp);
}

E
Eric Dumazet 已提交
1073
static inline bool tcp_is_fack(const struct tcp_sock *tp)
1074
{
1075
	return tp->rx_opt.sack_ok & TCP_FACK_ENABLED;
1076 1077 1078 1079
}

static inline void tcp_enable_fack(struct tcp_sock *tp)
{
1080
	tp->rx_opt.sack_ok |= TCP_FACK_ENABLED;
1081 1082
}

1083 1084 1085 1086 1087
static inline unsigned int tcp_left_out(const struct tcp_sock *tp)
{
	return tp->sacked_out + tp->lost_out;
}

L
Linus Torvalds 已提交
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
/* This determines how many packets are "in the network" to the best
 * of our knowledge.  In many cases it is conservative, but where
 * detailed information is available from the receiver (via SACK
 * blocks etc.) we can make more aggressive calculations.
 *
 * Use this for decisions involving congestion control, use just
 * tp->packets_out to determine if the send queue is empty or not.
 *
 * Read this equation as:
 *
 *	"Packets sent once on transmission queue" MINUS
 *	"Packets left network, but not honestly ACKed yet" PLUS
 *	"Packets fast retransmitted"
 */
S
Stephen Hemminger 已提交
1102
static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp)
L
Linus Torvalds 已提交
1103
{
1104
	return tp->packets_out - tcp_left_out(tp) + tp->retrans_out;
L
Linus Torvalds 已提交
1105 1106
}

I
Ilpo Järvinen 已提交
1107 1108
#define TCP_INFINITE_SSTHRESH	0x7fffffff

1109 1110
static inline bool tcp_in_slow_start(const struct tcp_sock *tp)
{
1111
	return tp->snd_cwnd < tp->snd_ssthresh;
1112 1113
}

I
Ilpo Järvinen 已提交
1114 1115 1116 1117 1118
static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp)
{
	return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH;
}

1119 1120 1121 1122 1123 1124
static inline bool tcp_in_cwnd_reduction(const struct sock *sk)
{
	return (TCPF_CA_CWR | TCPF_CA_Recovery) &
	       (1 << inet_csk(sk)->icsk_ca_state);
}

L
Linus Torvalds 已提交
1125
/* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd.
1126
 * The exception is cwnd reduction phase, when cwnd is decreasing towards
L
Linus Torvalds 已提交
1127 1128
 * ssthresh.
 */
1129
static inline __u32 tcp_current_ssthresh(const struct sock *sk)
L
Linus Torvalds 已提交
1130
{
1131
	const struct tcp_sock *tp = tcp_sk(sk);
1132

1133
	if (tcp_in_cwnd_reduction(sk))
L
Linus Torvalds 已提交
1134 1135 1136 1137 1138 1139 1140
		return tp->snd_ssthresh;
	else
		return max(tp->snd_ssthresh,
			   ((tp->snd_cwnd >> 1) +
			    (tp->snd_cwnd >> 2)));
}

1141 1142
/* Use define here intentionally to get WARN_ON location shown at the caller */
#define tcp_verify_left_out(tp)	WARN_ON(tcp_left_out(tp) > tp->packets_out)
L
Linus Torvalds 已提交
1143

1144
void tcp_enter_cwr(struct sock *sk);
1145
__u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst);
L
Linus Torvalds 已提交
1146

1147 1148 1149 1150 1151 1152 1153 1154
/* The maximum number of MSS of available cwnd for which TSO defers
 * sending if not using sysctl_tcp_tso_win_divisor.
 */
static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp)
{
	return 3;
}

1155 1156 1157 1158 1159
/* Returns end sequence number of the receiver's advertised window */
static inline u32 tcp_wnd_end(const struct tcp_sock *tp)
{
	return tp->snd_una + tp->snd_wnd;
}
1160 1161 1162

/* We follow the spirit of RFC2861 to validate cwnd but implement a more
 * flexible approach. The RFC suggests cwnd should not be raised unless
1163 1164 1165
 * it was fully used previously. And that's exactly what we do in
 * congestion avoidance mode. But in slow start we allow cwnd to grow
 * as long as the application has used half the cwnd.
1166 1167 1168 1169 1170 1171 1172 1173
 * Example :
 *    cwnd is 10 (IW10), but application sends 9 frames.
 *    We allow cwnd to reach 18 when all frames are ACKed.
 * This check is safe because it's as aggressive as slow start which already
 * risks 100% overshoot. The advantage is that we discourage application to
 * either send more filler packets or data to artificially blow up the cwnd
 * usage, and allow application-limited process to probe bw more aggressively.
 */
1174
static inline bool tcp_is_cwnd_limited(const struct sock *sk)
1175 1176 1177
{
	const struct tcp_sock *tp = tcp_sk(sk);

1178
	/* If in slow start, ensure cwnd grows to twice what was ACKed. */
1179
	if (tcp_in_slow_start(tp))
1180 1181 1182
		return tp->snd_cwnd < 2 * tp->max_packets_out;

	return tp->is_cwnd_limited;
1183
}
1184

1185 1186 1187 1188 1189 1190 1191
/* Something is really bad, we could not queue an additional packet,
 * because qdisc is full or receiver sent a 0 window.
 * We do not want to add fuel to the fire, or abort too early,
 * so make sure the timer we arm now is at least 200ms in the future,
 * regardless of current icsk_rto value (as it could be ~2ms)
 */
static inline unsigned long tcp_probe0_base(const struct sock *sk)
L
Linus Torvalds 已提交
1192
{
1193 1194
	return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN);
}
1195

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
/* Variant of inet_csk_rto_backoff() used for zero window probes */
static inline unsigned long tcp_probe0_when(const struct sock *sk,
					    unsigned long max_when)
{
	u64 when = (u64)tcp_probe0_base(sk) << inet_csk(sk)->icsk_backoff;

	return (unsigned long)min_t(u64, when, max_when);
}

static inline void tcp_check_probe_timer(struct sock *sk)
{
	if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending)
1208
		inet_csk_reset_xmit_timer(sk, ICSK_TIME_PROBE0,
1209
					  tcp_probe0_base(sk), TCP_RTO_MAX);
L
Linus Torvalds 已提交
1210 1211
}

1212
static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq)
L
Linus Torvalds 已提交
1213 1214 1215 1216
{
	tp->snd_wl1 = seq;
}

1217
static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq)
L
Linus Torvalds 已提交
1218 1219 1220 1221 1222 1223 1224
{
	tp->snd_wl1 = seq;
}

/*
 * Calculate(/check) TCP checksum
 */
1225 1226
static inline __sum16 tcp_v4_check(int len, __be32 saddr,
				   __be32 daddr, __wsum base)
L
Linus Torvalds 已提交
1227 1228 1229 1230
{
	return csum_tcpudp_magic(saddr,daddr,len,IPPROTO_TCP,base);
}

1231
static inline __sum16 __tcp_checksum_complete(struct sk_buff *skb)
L
Linus Torvalds 已提交
1232
{
1233
	return __skb_checksum_complete(skb);
L
Linus Torvalds 已提交
1234 1235
}

E
Eric Dumazet 已提交
1236
static inline bool tcp_checksum_complete(struct sk_buff *skb)
L
Linus Torvalds 已提交
1237
{
1238
	return !skb_csum_unnecessary(skb) &&
L
Linus Torvalds 已提交
1239 1240 1241 1242 1243
		__tcp_checksum_complete(skb);
}

/* Prequeue for VJ style copy to user, combined with checksumming. */

S
Stephen Hemminger 已提交
1244
static inline void tcp_prequeue_init(struct tcp_sock *tp)
L
Linus Torvalds 已提交
1245 1246 1247 1248 1249 1250 1251
{
	tp->ucopy.task = NULL;
	tp->ucopy.len = 0;
	tp->ucopy.memory = 0;
	skb_queue_head_init(&tp->ucopy.prequeue);
}

1252
bool tcp_prequeue(struct sock *sk, struct sk_buff *skb);
E
Eric Dumazet 已提交
1253
bool tcp_add_backlog(struct sock *sk, struct sk_buff *skb);
1254
int tcp_filter(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264

#undef STATE_TRACE

#ifdef STATE_TRACE
static const char *statename[]={
	"Unused","Established","Syn Sent","Syn Recv",
	"Fin Wait 1","Fin Wait 2","Time Wait", "Close",
	"Close Wait","Last ACK","Listen","Closing"
};
#endif
1265
void tcp_set_state(struct sock *sk, int state);
L
Linus Torvalds 已提交
1266

1267
void tcp_done(struct sock *sk);
L
Linus Torvalds 已提交
1268

1269 1270
int tcp_abort(struct sock *sk, int err);

S
Stephen Hemminger 已提交
1271
static inline void tcp_sack_reset(struct tcp_options_received *rx_opt)
L
Linus Torvalds 已提交
1272 1273 1274 1275 1276
{
	rx_opt->dsack = 0;
	rx_opt->num_sacks = 0;
}

1277
u32 tcp_default_init_rwnd(u32 mss);
1278 1279 1280 1281
void tcp_cwnd_restart(struct sock *sk, s32 delta);

static inline void tcp_slow_start_after_idle_check(struct sock *sk)
{
1282
	const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops;
1283 1284 1285
	struct tcp_sock *tp = tcp_sk(sk);
	s32 delta;

1286 1287
	if (!sysctl_tcp_slow_start_after_idle || tp->packets_out ||
	    ca_ops->cong_control)
1288
		return;
1289
	delta = tcp_jiffies32 - tp->lsndtime;
1290 1291 1292
	if (delta > inet_csk(sk)->icsk_rto)
		tcp_cwnd_restart(sk, delta);
}
1293

L
Linus Torvalds 已提交
1294
/* Determine a window scaling and initial window to offer. */
1295 1296 1297
void tcp_select_initial_window(int __space, __u32 mss, __u32 *rcv_wnd,
			       __u32 *window_clamp, int wscale_ok,
			       __u8 *rcv_wscale, __u32 init_rcv_wnd);
L
Linus Torvalds 已提交
1298 1299 1300

static inline int tcp_win_from_space(int space)
{
1301 1302 1303 1304 1305
	int tcp_adv_win_scale = sysctl_tcp_adv_win_scale;

	return tcp_adv_win_scale <= 0 ?
		(space>>(-tcp_adv_win_scale)) :
		space - (space>>tcp_adv_win_scale);
L
Linus Torvalds 已提交
1306 1307
}

1308
/* Note: caller must be prepared to deal with negative returns */
L
Linus Torvalds 已提交
1309 1310 1311 1312
static inline int tcp_space(const struct sock *sk)
{
	return tcp_win_from_space(sk->sk_rcvbuf -
				  atomic_read(&sk->sk_rmem_alloc));
1313
}
L
Linus Torvalds 已提交
1314 1315 1316

static inline int tcp_full_space(const struct sock *sk)
{
1317
	return tcp_win_from_space(sk->sk_rcvbuf);
L
Linus Torvalds 已提交
1318 1319
}

1320
extern void tcp_openreq_init_rwin(struct request_sock *req,
1321 1322
				  const struct sock *sk_listener,
				  const struct dst_entry *dst);
1323

1324
void tcp_enter_memory_pressure(struct sock *sk);
L
Linus Torvalds 已提交
1325 1326 1327

static inline int keepalive_intvl_when(const struct tcp_sock *tp)
{
1328 1329 1330
	struct net *net = sock_net((struct sock *)tp);

	return tp->keepalive_intvl ? : net->ipv4.sysctl_tcp_keepalive_intvl;
L
Linus Torvalds 已提交
1331 1332 1333 1334
}

static inline int keepalive_time_when(const struct tcp_sock *tp)
{
1335 1336 1337
	struct net *net = sock_net((struct sock *)tp);

	return tp->keepalive_time ? : net->ipv4.sysctl_tcp_keepalive_time;
L
Linus Torvalds 已提交
1338 1339
}

E
Eric Dumazet 已提交
1340 1341
static inline int keepalive_probes(const struct tcp_sock *tp)
{
1342 1343 1344
	struct net *net = sock_net((struct sock *)tp);

	return tp->keepalive_probes ? : net->ipv4.sysctl_tcp_keepalive_probes;
E
Eric Dumazet 已提交
1345 1346
}

1347 1348 1349 1350
static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp)
{
	const struct inet_connection_sock *icsk = &tp->inet_conn;

1351 1352
	return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime,
			  tcp_jiffies32 - tp->rcv_tstamp);
1353 1354
}

1355
static inline int tcp_fin_time(const struct sock *sk)
L
Linus Torvalds 已提交
1356
{
1357
	int fin_timeout = tcp_sk(sk)->linger2 ? : sock_net(sk)->ipv4.sysctl_tcp_fin_timeout;
1358
	const int rto = inet_csk(sk)->icsk_rto;
L
Linus Torvalds 已提交
1359

1360 1361
	if (fin_timeout < (rto << 2) - (rto >> 1))
		fin_timeout = (rto << 2) - (rto >> 1);
L
Linus Torvalds 已提交
1362 1363 1364 1365

	return fin_timeout;
}

E
Eric Dumazet 已提交
1366 1367
static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt,
				  int paws_win)
L
Linus Torvalds 已提交
1368
{
I
Ilpo Järvinen 已提交
1369
	if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win)
E
Eric Dumazet 已提交
1370
		return true;
I
Ilpo Järvinen 已提交
1371
	if (unlikely(get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_24DAYS))
E
Eric Dumazet 已提交
1372
		return true;
E
Eric Dumazet 已提交
1373 1374 1375 1376 1377 1378
	/*
	 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0,
	 * then following tcp messages have valid values. Ignore 0 value,
	 * or else 'negative' tsval might forbid us to accept their packets.
	 */
	if (!rx_opt->ts_recent)
E
Eric Dumazet 已提交
1379 1380
		return true;
	return false;
I
Ilpo Järvinen 已提交
1381 1382
}

E
Eric Dumazet 已提交
1383 1384
static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt,
				   int rst)
I
Ilpo Järvinen 已提交
1385 1386
{
	if (tcp_paws_check(rx_opt, 0))
E
Eric Dumazet 已提交
1387
		return false;
L
Linus Torvalds 已提交
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400

	/* RST segments are not recommended to carry timestamp,
	   and, if they do, it is recommended to ignore PAWS because
	   "their cleanup function should take precedence over timestamps."
	   Certainly, it is mistake. It is necessary to understand the reasons
	   of this constraint to relax it: if peer reboots, clock may go
	   out-of-sync and half-open connections will not be reset.
	   Actually, the problem would be not existing if all
	   the implementations followed draft about maintaining clock
	   via reboots. Linux-2.2 DOES NOT!

	   However, we can relax time bounds for RST segments to MSL.
	 */
1401
	if (rst && get_seconds() >= rx_opt->ts_recent_stamp + TCP_PAWS_MSL)
E
Eric Dumazet 已提交
1402 1403
		return false;
	return true;
L
Linus Torvalds 已提交
1404 1405
}

1406 1407
bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb,
			  int mib_idx, u32 *last_oow_ack_time);
1408

P
Pavel Emelyanov 已提交
1409
static inline void tcp_mib_init(struct net *net)
L
Linus Torvalds 已提交
1410 1411
{
	/* See RFC 2012 */
1412 1413 1414 1415
	TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1);
	TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ);
	TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ);
	TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1);
L
Linus Torvalds 已提交
1416 1417
}

1418
/* from STCP */
1419
static inline void tcp_clear_retrans_hints_partial(struct tcp_sock *tp)
D
David S. Miller 已提交
1420
{
1421
	tp->lost_skb_hint = NULL;
1422 1423 1424 1425 1426
}

static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp)
{
	tcp_clear_retrans_hints_partial(tp);
1427
	tp->retransmit_skb_hint = NULL;
1428 1429
}

E
Eric Dumazet 已提交
1430 1431 1432 1433 1434 1435 1436
union tcp_md5_addr {
	struct in_addr  a4;
#if IS_ENABLED(CONFIG_IPV6)
	struct in6_addr	a6;
#endif
};

1437 1438
/* - key database */
struct tcp_md5sig_key {
E
Eric Dumazet 已提交
1439
	struct hlist_node	node;
1440
	u8			keylen;
E
Eric Dumazet 已提交
1441 1442 1443 1444
	u8			family; /* AF_INET or AF_INET6 */
	union tcp_md5_addr	addr;
	u8			key[TCP_MD5SIG_MAXKEYLEN];
	struct rcu_head		rcu;
1445 1446 1447 1448
};

/* - sock block */
struct tcp_md5sig_info {
E
Eric Dumazet 已提交
1449
	struct hlist_head	head;
1450
	struct rcu_head		rcu;
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
};

/* - pseudo header */
struct tcp4_pseudohdr {
	__be32		saddr;
	__be32		daddr;
	__u8		pad;
	__u8		protocol;
	__be16		len;
};

struct tcp6_pseudohdr {
	struct in6_addr	saddr;
	struct in6_addr daddr;
	__be32		len;
	__be32		protocol;	/* including padding */
};

union tcp_md5sum_block {
	struct tcp4_pseudohdr ip4;
E
Eric Dumazet 已提交
1471
#if IS_ENABLED(CONFIG_IPV6)
1472 1473 1474 1475 1476 1477
	struct tcp6_pseudohdr ip6;
#endif
};

/* - pool: digest algorithm, hash description and scratch buffer */
struct tcp_md5sig_pool {
H
Herbert Xu 已提交
1478
	struct ahash_request	*md5_req;
1479
	void			*scratch;
1480 1481 1482
};

/* - functions */
1483 1484
int tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key,
			const struct sock *sk, const struct sk_buff *skb);
1485 1486 1487 1488
int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,
		   int family, const u8 *newkey, u8 newkeylen, gfp_t gfp);
int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr,
		   int family);
1489
struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk,
1490
					 const struct sock *addr_sk);
1491

1492
#ifdef CONFIG_TCP_MD5SIG
1493
struct tcp_md5sig_key *tcp_md5_do_lookup(const struct sock *sk,
1494 1495
					 const union tcp_md5_addr *addr,
					 int family);
E
Eric Dumazet 已提交
1496
#define tcp_twsk_md5_key(twsk)	((twsk)->tw_md5_key)
1497
#else
1498
static inline struct tcp_md5sig_key *tcp_md5_do_lookup(const struct sock *sk,
E
Eric Dumazet 已提交
1499 1500 1501 1502 1503
					 const union tcp_md5_addr *addr,
					 int family)
{
	return NULL;
}
1504 1505 1506
#define tcp_twsk_md5_key(twsk)	NULL
#endif

1507
bool tcp_alloc_md5sig_pool(void);
1508

1509
struct tcp_md5sig_pool *tcp_get_md5sig_pool(void);
1510 1511 1512 1513
static inline void tcp_put_md5sig_pool(void)
{
	local_bh_enable();
}
E
Eric Dumazet 已提交
1514

1515 1516 1517 1518
int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *, const struct sk_buff *,
			  unsigned int header_len);
int tcp_md5_hash_key(struct tcp_md5sig_pool *hp,
		     const struct tcp_md5sig_key *key);
1519

1520
/* From tcp_fastopen.c */
1521 1522 1523 1524
void tcp_fastopen_cache_get(struct sock *sk, u16 *mss,
			    struct tcp_fastopen_cookie *cookie, int *syn_loss,
			    unsigned long *last_syn_loss);
void tcp_fastopen_cache_set(struct sock *sk, u16 mss,
1525 1526
			    struct tcp_fastopen_cookie *cookie, bool syn_lost,
			    u16 try_exp);
1527 1528 1529 1530
struct tcp_fastopen_request {
	/* Fast Open cookie. Size 0 means a cookie request */
	struct tcp_fastopen_cookie	cookie;
	struct msghdr			*data;  /* data in MSG_FASTOPEN */
1531 1532
	size_t				size;
	int				copied;	/* queued in tcp_connect() */
1533 1534 1535
};
void tcp_free_fastopen_req(struct tcp_sock *tp);

1536 1537
extern struct tcp_fastopen_context __rcu *tcp_fastopen_ctx;
int tcp_fastopen_reset_cipher(void *key, unsigned int len);
1538
void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb);
1539 1540 1541 1542
struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
			      struct request_sock *req,
			      struct tcp_fastopen_cookie *foc,
			      struct dst_entry *dst);
1543
void tcp_fastopen_init_key_once(bool publish);
1544 1545
bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
			     struct tcp_fastopen_cookie *cookie);
W
Wei Wang 已提交
1546
bool tcp_fastopen_defer_connect(struct sock *sk, int *err);
1547 1548 1549 1550
#define TCP_FASTOPEN_KEY_LENGTH 16

/* Fastopen key context */
struct tcp_fastopen_context {
1551 1552 1553
	struct crypto_cipher	*tfm;
	__u8			key[TCP_FASTOPEN_KEY_LENGTH];
	struct rcu_head		rcu;
1554 1555
};

1556
extern unsigned int sysctl_tcp_fastopen_blackhole_timeout;
1557
void tcp_fastopen_active_disable(struct sock *sk);
1558 1559 1560 1561
bool tcp_fastopen_active_should_disable(struct sock *sk);
void tcp_fastopen_active_disable_ofo_check(struct sock *sk);
void tcp_fastopen_active_timeout_reset(void);

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
/* Latencies incurred by various limits for a sender. They are
 * chronograph-like stats that are mutually exclusive.
 */
enum tcp_chrono {
	TCP_CHRONO_UNSPEC,
	TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */
	TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */
	TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */
	__TCP_CHRONO_MAX,
};

void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type);
void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type);

1576 1577 1578 1579 1580
/* write queue abstraction */
static inline void tcp_write_queue_purge(struct sock *sk)
{
	struct sk_buff *skb;

1581
	tcp_chrono_stop(sk, TCP_CHRONO_BUSY);
1582
	while ((skb = __skb_dequeue(&sk->sk_write_queue)) != NULL)
1583 1584
		sk_wmem_free_skb(sk, skb);
	sk_mem_reclaim(sk);
1585
	tcp_clear_all_retrans_hints(tcp_sk(sk));
1586 1587
}

1588
static inline struct sk_buff *tcp_write_queue_head(const struct sock *sk)
1589
{
1590
	return skb_peek(&sk->sk_write_queue);
1591 1592
}

1593
static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk)
1594
{
1595
	return skb_peek_tail(&sk->sk_write_queue);
1596 1597
}

1598 1599
static inline struct sk_buff *tcp_write_queue_next(const struct sock *sk,
						   const struct sk_buff *skb)
1600
{
1601
	return skb_queue_next(&sk->sk_write_queue, skb);
1602 1603
}

1604 1605
static inline struct sk_buff *tcp_write_queue_prev(const struct sock *sk,
						   const struct sk_buff *skb)
1606 1607 1608 1609
{
	return skb_queue_prev(&sk->sk_write_queue, skb);
}

1610
#define tcp_for_write_queue(skb, sk)					\
1611
	skb_queue_walk(&(sk)->sk_write_queue, skb)
1612 1613

#define tcp_for_write_queue_from(skb, sk)				\
1614
	skb_queue_walk_from(&(sk)->sk_write_queue, skb)
1615

1616
#define tcp_for_write_queue_from_safe(skb, tmp, sk)			\
1617
	skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp)
1618

1619
static inline struct sk_buff *tcp_send_head(const struct sock *sk)
1620 1621 1622 1623
{
	return sk->sk_send_head;
}

1624 1625 1626 1627 1628 1629
static inline bool tcp_skb_is_last(const struct sock *sk,
				   const struct sk_buff *skb)
{
	return skb_queue_is_last(&sk->sk_write_queue, skb);
}

1630
static inline void tcp_advance_send_head(struct sock *sk, const struct sk_buff *skb)
1631
{
1632
	if (tcp_skb_is_last(sk, skb))
1633
		sk->sk_send_head = NULL;
1634 1635
	else
		sk->sk_send_head = tcp_write_queue_next(sk, skb);
1636 1637 1638 1639
}

static inline void tcp_check_send_head(struct sock *sk, struct sk_buff *skb_unlinked)
{
1640
	if (sk->sk_send_head == skb_unlinked) {
1641
		sk->sk_send_head = NULL;
1642 1643
		tcp_chrono_stop(sk, TCP_CHRONO_BUSY);
	}
1644 1645
	if (tcp_sk(sk)->highest_sack == skb_unlinked)
		tcp_sk(sk)->highest_sack = NULL;
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
}

static inline void tcp_init_send_head(struct sock *sk)
{
	sk->sk_send_head = NULL;
}

static inline void __tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
{
	__skb_queue_tail(&sk->sk_write_queue, skb);
}

static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb)
{
	__tcp_add_write_queue_tail(sk, skb);

	/* Queue it, remembering where we must start sending. */
1663
	if (sk->sk_send_head == NULL) {
1664
		sk->sk_send_head = skb;
1665
		tcp_chrono_start(sk, TCP_CHRONO_BUSY);
1666 1667 1668 1669

		if (tcp_sk(sk)->highest_sack == NULL)
			tcp_sk(sk)->highest_sack = skb;
	}
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
}

static inline void __tcp_add_write_queue_head(struct sock *sk, struct sk_buff *skb)
{
	__skb_queue_head(&sk->sk_write_queue, skb);
}

/* Insert buff after skb on the write queue of sk.  */
static inline void tcp_insert_write_queue_after(struct sk_buff *skb,
						struct sk_buff *buff,
						struct sock *sk)
{
1682
	__skb_queue_after(&sk->sk_write_queue, skb, buff);
1683 1684
}

1685
/* Insert new before skb on the write queue of sk.  */
1686 1687 1688 1689
static inline void tcp_insert_write_queue_before(struct sk_buff *new,
						  struct sk_buff *skb,
						  struct sock *sk)
{
1690
	__skb_queue_before(&sk->sk_write_queue, skb, new);
1691 1692 1693

	if (sk->sk_send_head == skb)
		sk->sk_send_head = new;
1694 1695 1696 1697 1698 1699 1700
}

static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk)
{
	__skb_unlink(skb, &sk->sk_write_queue);
}

E
Eric Dumazet 已提交
1701
static inline bool tcp_write_queue_empty(struct sock *sk)
1702 1703 1704 1705
{
	return skb_queue_empty(&sk->sk_write_queue);
}

1706 1707 1708 1709 1710 1711 1712 1713 1714
static inline void tcp_push_pending_frames(struct sock *sk)
{
	if (tcp_send_head(sk)) {
		struct tcp_sock *tp = tcp_sk(sk);

		__tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle);
	}
}

1715 1716 1717
/* Start sequence of the skb just after the highest skb with SACKed
 * bit, valid only if sacked_out > 0 or when the caller has ensured
 * validity by itself.
1718 1719 1720 1721 1722
 */
static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp)
{
	if (!tp->sacked_out)
		return tp->snd_una;
1723 1724 1725 1726

	if (tp->highest_sack == NULL)
		return tp->snd_nxt;

1727 1728 1729
	return TCP_SKB_CB(tp->highest_sack)->seq;
}

1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb)
{
	tcp_sk(sk)->highest_sack = tcp_skb_is_last(sk, skb) ? NULL :
						tcp_write_queue_next(sk, skb);
}

static inline struct sk_buff *tcp_highest_sack(struct sock *sk)
{
	return tcp_sk(sk)->highest_sack;
}

static inline void tcp_highest_sack_reset(struct sock *sk)
{
	tcp_sk(sk)->highest_sack = tcp_write_queue_head(sk);
}

/* Called when old skb is about to be deleted (to be combined with new skb) */
static inline void tcp_highest_sack_combine(struct sock *sk,
					    struct sk_buff *old,
					    struct sk_buff *new)
{
	if (tcp_sk(sk)->sacked_out && (old == tcp_sk(sk)->highest_sack))
		tcp_sk(sk)->highest_sack = new;
}

1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
/* This helper checks if socket has IP_TRANSPARENT set */
static inline bool inet_sk_transparent(const struct sock *sk)
{
	switch (sk->sk_state) {
	case TCP_TIME_WAIT:
		return inet_twsk(sk)->tw_transparent;
	case TCP_NEW_SYN_RECV:
		return inet_rsk(inet_reqsk(sk))->no_srccheck;
	}
	return inet_sk(sk)->transparent;
}

A
Andreas Petlund 已提交
1767 1768 1769
/* Determines whether this is a thin stream (which may suffer from
 * increased latency). Used to trigger latency-reducing mechanisms.
 */
E
Eric Dumazet 已提交
1770
static inline bool tcp_stream_is_thin(struct tcp_sock *tp)
A
Andreas Petlund 已提交
1771 1772 1773 1774
{
	return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp);
}

L
Linus Torvalds 已提交
1775 1776 1777 1778 1779 1780
/* /proc */
enum tcp_seq_states {
	TCP_SEQ_STATE_LISTENING,
	TCP_SEQ_STATE_ESTABLISHED,
};

1781 1782
int tcp_seq_open(struct inode *inode, struct file *file);

L
Linus Torvalds 已提交
1783
struct tcp_seq_afinfo {
1784 1785 1786 1787
	char				*name;
	sa_family_t			family;
	const struct file_operations	*seq_fops;
	struct seq_operations		seq_ops;
L
Linus Torvalds 已提交
1788 1789 1790
};

struct tcp_iter_state {
1791
	struct seq_net_private	p;
L
Linus Torvalds 已提交
1792 1793 1794
	sa_family_t		family;
	enum tcp_seq_states	state;
	struct sock		*syn_wait_sk;
1795
	int			bucket, offset, sbucket, num;
1796
	loff_t			last_pos;
L
Linus Torvalds 已提交
1797 1798
};

1799 1800
int tcp_proc_register(struct net *net, struct tcp_seq_afinfo *afinfo);
void tcp_proc_unregister(struct net *net, struct tcp_seq_afinfo *afinfo);
L
Linus Torvalds 已提交
1801

1802
extern struct request_sock_ops tcp_request_sock_ops;
1803
extern struct request_sock_ops tcp6_request_sock_ops;
1804

1805
void tcp_v4_destroy_sock(struct sock *sk);
1806

E
Eric Dumazet 已提交
1807
struct sk_buff *tcp_gso_segment(struct sk_buff *skb,
1808 1809 1810
				netdev_features_t features);
struct sk_buff **tcp_gro_receive(struct sk_buff **head, struct sk_buff *skb);
int tcp_gro_complete(struct sk_buff *skb);
1811

1812
void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, __be32 daddr);
H
Herbert Xu 已提交
1813

1814 1815
static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp)
{
1816 1817
	struct net *net = sock_net((struct sock *)tp);
	return tp->notsent_lowat ?: net->ipv4.sysctl_tcp_notsent_lowat;
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
}

static inline bool tcp_stream_memory_free(const struct sock *sk)
{
	const struct tcp_sock *tp = tcp_sk(sk);
	u32 notsent_bytes = tp->write_seq - tp->snd_nxt;

	return notsent_bytes < tcp_notsent_lowat(tp);
}

1828
#ifdef CONFIG_PROC_FS
1829 1830
int tcp4_proc_init(void);
void tcp4_proc_exit(void);
1831 1832
#endif

1833
int tcp_rtx_synack(const struct sock *sk, struct request_sock *req);
O
Octavian Purdila 已提交
1834 1835 1836
int tcp_conn_request(struct request_sock_ops *rsk_ops,
		     const struct tcp_request_sock_ops *af_ops,
		     struct sock *sk, struct sk_buff *skb);
1837

1838 1839 1840
/* TCP af-specific functions */
struct tcp_sock_af_ops {
#ifdef CONFIG_TCP_MD5SIG
1841
	struct tcp_md5sig_key	*(*md5_lookup) (const struct sock *sk,
1842
						const struct sock *addr_sk);
1843 1844 1845 1846 1847 1848 1849
	int		(*calc_md5_hash)(char *location,
					 const struct tcp_md5sig_key *md5,
					 const struct sock *sk,
					 const struct sk_buff *skb);
	int		(*md5_parse)(struct sock *sk,
				     char __user *optval,
				     int optlen);
1850 1851 1852 1853
#endif
};

struct tcp_request_sock_ops {
1854
	u16 mss_clamp;
1855
#ifdef CONFIG_TCP_MD5SIG
1856
	struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk,
1857
						 const struct sock *addr_sk);
1858 1859 1860 1861
	int		(*calc_md5_hash) (char *location,
					  const struct tcp_md5sig_key *md5,
					  const struct sock *sk,
					  const struct sk_buff *skb);
1862
#endif
1863 1864
	void (*init_req)(struct request_sock *req,
			 const struct sock *sk_listener,
1865
			 struct sk_buff *skb);
1866
#ifdef CONFIG_SYN_COOKIES
1867
	__u32 (*cookie_init_seq)(const struct sk_buff *skb,
1868 1869
				 __u16 *mss);
#endif
1870
	struct dst_entry *(*route_req)(const struct sock *sk, struct flowi *fl,
1871
				       const struct request_sock *req);
1872 1873
	u32 (*init_seq)(const struct sk_buff *skb);
	u32 (*init_ts_off)(const struct sk_buff *skb);
1874
	int (*send_synack)(const struct sock *sk, struct dst_entry *dst,
1875
			   struct flowi *fl, struct request_sock *req,
1876
			   struct tcp_fastopen_cookie *foc,
1877
			   enum tcp_synack_type synack_type);
1878 1879
};

1880 1881
#ifdef CONFIG_SYN_COOKIES
static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
1882
					 const struct sock *sk, struct sk_buff *skb,
1883 1884
					 __u16 *mss)
{
1885
	tcp_synq_overflow(sk);
1886
	__NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT);
1887
	return ops->cookie_init_seq(skb, mss);
1888 1889 1890
}
#else
static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops,
1891
					 const struct sock *sk, struct sk_buff *skb,
1892 1893 1894 1895 1896 1897
					 __u16 *mss)
{
	return 0;
}
#endif

1898
int tcpv4_offload_init(void);
1899

1900 1901
void tcp_v4_init(void);
void tcp_init(void);
1902

1903
/* tcp_recovery.c */
1904
extern void tcp_rack_mark_lost(struct sock *sk);
1905
extern void tcp_rack_advance(struct tcp_sock *tp, u8 sacked, u32 end_seq,
1906
			     u64 xmit_time);
1907
extern void tcp_rack_reo_timeout(struct sock *sk);
1908

1909 1910 1911 1912 1913 1914 1915 1916
/*
 * Save and compile IPv4 options, return a pointer to it
 */
static inline struct ip_options_rcu *tcp_v4_save_options(struct sk_buff *skb)
{
	const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
	struct ip_options_rcu *dopt = NULL;

C
Cong Wang 已提交
1917
	if (opt->optlen) {
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
		int opt_size = sizeof(*dopt) + opt->optlen;

		dopt = kmalloc(opt_size, GFP_ATOMIC);
		if (dopt && __ip_options_echo(&dopt->opt, skb, opt)) {
			kfree(dopt);
			dopt = NULL;
		}
	}
	return dopt;
}

E
Eric Dumazet 已提交
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
/* locally generated TCP pure ACKs have skb->truesize == 2
 * (check tcp_send_ack() in net/ipv4/tcp_output.c )
 * This is much faster than dissecting the packet to find out.
 * (Think of GRE encapsulations, IPv4, IPv6, ...)
 */
static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb)
{
	return skb->truesize == 2;
}

static inline void skb_set_tcp_pure_ack(struct sk_buff *skb)
{
	skb->truesize = 2;
}

1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967
static inline int tcp_inq(struct sock *sk)
{
	struct tcp_sock *tp = tcp_sk(sk);
	int answ;

	if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) {
		answ = 0;
	} else if (sock_flag(sk, SOCK_URGINLINE) ||
		   !tp->urg_data ||
		   before(tp->urg_seq, tp->copied_seq) ||
		   !before(tp->urg_seq, tp->rcv_nxt)) {

		answ = tp->rcv_nxt - tp->copied_seq;

		/* Subtract 1, if FIN was received */
		if (answ && sock_flag(sk, SOCK_DONE))
			answ--;
	} else {
		answ = tp->urg_seq - tp->copied_seq;
	}

	return answ;
}

1968 1969
int tcp_peek_len(struct socket *sock);

1970 1971 1972 1973 1974 1975 1976 1977 1978 1979
static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb)
{
	u16 segs_in;

	segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
	tp->segs_in += segs_in;
	if (skb->len > tcp_hdrlen(skb))
		tp->data_segs_in += segs_in;
}

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
/*
 * TCP listen path runs lockless.
 * We forced "struct sock" to be const qualified to make sure
 * we don't modify one of its field by mistake.
 * Here, we increment sk_drops which is an atomic_t, so we can safely
 * make sock writable again.
 */
static inline void tcp_listendrop(const struct sock *sk)
{
	atomic_inc(&((struct sock *)sk)->sk_drops);
1990
	__NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS);
1991 1992
}

1993 1994
enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer);

L
Linus Torvalds 已提交
1995
#endif	/* _TCP_H */