1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * INET An implementation of the TCP/IP protocol suite for the LINUX 4 * operating system. INET is implemented using the BSD Socket 5 * interface as the means of communication with the user level. 6 * 7 * Definitions for the TCP module. 8 * 9 * Version: @(#)tcp.h 1.0.5 05/23/93 10 * 11 * Authors: Ross Biro 12 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG> 13 */ 14 #ifndef _TCP_H 15 #define _TCP_H 16 17 #define FASTRETRANS_DEBUG 1 18 19 #include <linux/list.h> 20 #include <linux/tcp.h> 21 #include <linux/bug.h> 22 #include <linux/slab.h> 23 #include <linux/cache.h> 24 #include <linux/percpu.h> 25 #include <linux/skbuff.h> 26 #include <linux/kref.h> 27 #include <linux/ktime.h> 28 #include <linux/indirect_call_wrapper.h> 29 #include <linux/bits.h> 30 31 #include <net/inet_connection_sock.h> 32 #include <net/inet_timewait_sock.h> 33 #include <net/inet_hashtables.h> 34 #include <net/checksum.h> 35 #include <net/request_sock.h> 36 #include <net/sock_reuseport.h> 37 #include <net/sock.h> 38 #include <net/snmp.h> 39 #include <net/ip.h> 40 #include <net/tcp_states.h> 41 #include <net/tcp_ao.h> 42 #include <net/inet_ecn.h> 43 #include <net/dst.h> 44 #include <net/mptcp.h> 45 #include <net/xfrm.h> 46 #include <net/secure_seq.h> 47 48 #include <linux/seq_file.h> 49 #include <linux/memcontrol.h> 50 #include <linux/bpf-cgroup.h> 51 #include <linux/siphash.h> 52 53 extern struct inet_hashinfo tcp_hashinfo; 54 55 DECLARE_PER_CPU(unsigned int, tcp_orphan_count); 56 int tcp_orphan_count_sum(void); 57 58 static inline void tcp_orphan_count_inc(void) 59 { 60 this_cpu_inc(tcp_orphan_count); 61 } 62 63 static inline void tcp_orphan_count_dec(void) 64 { 65 this_cpu_dec(tcp_orphan_count); 66 } 67 68 void tcp_time_wait(struct sock *sk, int state, int timeo); 69 70 #define MAX_TCP_HEADER L1_CACHE_ALIGN(128 + MAX_HEADER) 71 #define MAX_TCP_OPTION_SPACE 40 72 #define TCP_MIN_SND_MSS 48 73 #define TCP_MIN_GSO_SIZE (TCP_MIN_SND_MSS - MAX_TCP_OPTION_SPACE) 74 75 /* 76 * Never offer a window over 32767 without using window scaling. Some 77 * poor stacks do signed 16bit maths! 78 */ 79 #define MAX_TCP_WINDOW 32767U 80 81 /* Minimal accepted MSS. It is (60+60+8) - (20+20). */ 82 #define TCP_MIN_MSS 88U 83 84 /* The initial MTU to use for probing */ 85 #define TCP_BASE_MSS 1024 86 87 /* probing interval, default to 10 minutes as per RFC4821 */ 88 #define TCP_PROBE_INTERVAL 600 89 90 /* Specify interval when tcp mtu probing will stop */ 91 #define TCP_PROBE_THRESHOLD 8 92 93 /* After receiving this amount of duplicate ACKs fast retransmit starts. */ 94 #define TCP_FASTRETRANS_THRESH 3 95 96 /* Maximal number of ACKs sent quickly to accelerate slow-start. */ 97 #define TCP_MAX_QUICKACKS 16U 98 99 /* Maximal number of window scale according to RFC1323 */ 100 #define TCP_MAX_WSCALE 14U 101 102 /* Default sending frequency of accurate ECN option per RTT */ 103 #define TCP_ACCECN_OPTION_BEACON 3 104 105 /* urg_data states */ 106 #define TCP_URG_VALID 0x0100 107 #define TCP_URG_NOTYET 0x0200 108 #define TCP_URG_READ 0x0400 109 110 #define TCP_RETR1 3 /* 111 * This is how many retries it does before it 112 * tries to figure out if the gateway is 113 * down. Minimal RFC value is 3; it corresponds 114 * to ~3sec-8min depending on RTO. 115 */ 116 117 #define TCP_RETR2 15 /* 118 * This should take at least 119 * 90 minutes to time out. 120 * RFC1122 says that the limit is 100 sec. 121 * 15 is ~13-30min depending on RTO. 122 */ 123 124 #define TCP_SYN_RETRIES 6 /* This is how many retries are done 125 * when active opening a connection. 126 * RFC1122 says the minimum retry MUST 127 * be at least 180secs. Nevertheless 128 * this value is corresponding to 129 * 63secs of retransmission with the 130 * current initial RTO. 131 */ 132 133 #define TCP_SYNACK_RETRIES 5 /* This is how may retries are done 134 * when passive opening a connection. 135 * This is corresponding to 31secs of 136 * retransmission with the current 137 * initial RTO. 138 */ 139 140 #define TCP_TIMEWAIT_LEN (60*HZ) /* how long to wait to destroy TIME-WAIT 141 * state, about 60 seconds */ 142 #define TCP_FIN_TIMEOUT TCP_TIMEWAIT_LEN 143 /* BSD style FIN_WAIT2 deadlock breaker. 144 * It used to be 3min, new value is 60sec, 145 * to combine FIN-WAIT-2 timeout with 146 * TIME-WAIT timer. 147 */ 148 #define TCP_FIN_TIMEOUT_MAX (120 * HZ) /* max TCP_LINGER2 value (two minutes) */ 149 150 #define TCP_DELACK_MAX ((unsigned)(HZ/5)) /* maximal time to delay before sending an ACK */ 151 static_assert((1 << ATO_BITS) > TCP_DELACK_MAX); 152 153 #if HZ >= 100 154 #define TCP_DELACK_MIN ((unsigned)(HZ/25)) /* minimal time to delay before sending an ACK */ 155 #define TCP_ATO_MIN ((unsigned)(HZ/25)) 156 #else 157 #define TCP_DELACK_MIN 4U 158 #define TCP_ATO_MIN 4U 159 #endif 160 #define TCP_RTO_MAX_SEC 120 161 #define TCP_RTO_MAX ((unsigned)(TCP_RTO_MAX_SEC * HZ)) 162 #define TCP_RTO_MIN ((unsigned)(HZ / 5)) 163 #define TCP_TIMEOUT_MIN (2U) /* Min timeout for TCP timers in jiffies */ 164 165 #define TCP_TIMEOUT_MIN_US (2*USEC_PER_MSEC) /* Min TCP timeout in microsecs */ 166 167 #define TCP_TIMEOUT_INIT ((unsigned)(1*HZ)) /* RFC6298 2.1 initial RTO value */ 168 #define TCP_TIMEOUT_FALLBACK ((unsigned)(3*HZ)) /* RFC 1122 initial RTO value, now 169 * used as a fallback RTO for the 170 * initial data transmission if no 171 * valid RTT sample has been acquired, 172 * most likely due to retrans in 3WHS. 173 */ 174 175 #define TCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ/2U)) /* Maximal interval between probes 176 * for local resources. 177 */ 178 #define TCP_KEEPALIVE_TIME (120*60*HZ) /* two hours */ 179 #define TCP_KEEPALIVE_PROBES 9 /* Max of 9 keepalive probes */ 180 #define TCP_KEEPALIVE_INTVL (75*HZ) 181 182 #define MAX_TCP_KEEPIDLE 32767 183 #define MAX_TCP_KEEPINTVL 32767 184 #define MAX_TCP_KEEPCNT 127 185 #define MAX_TCP_SYNCNT 127 186 187 /* Ensure that TCP PAWS checks are relaxed after ~2147 seconds 188 * to avoid overflows. This assumes a clock smaller than 1 Mhz. 189 * Default clock is 1 Khz, tcp_usec_ts uses 1 Mhz. 190 */ 191 #define TCP_PAWS_WRAP (INT_MAX / USEC_PER_SEC) 192 193 #define TCP_PAWS_MSL 60 /* Per-host timestamps are invalidated 194 * after this time. It should be equal 195 * (or greater than) TCP_TIMEWAIT_LEN 196 * to provide reliability equal to one 197 * provided by timewait state. 198 */ 199 #define TCP_PAWS_WINDOW 1 /* Replay window for per-host 200 * timestamps. It must be less than 201 * minimal timewait lifetime. 202 */ 203 /* 204 * TCP option 205 */ 206 207 #define TCPOPT_NOP 1 /* Padding */ 208 #define TCPOPT_EOL 0 /* End of options */ 209 #define TCPOPT_MSS 2 /* Segment size negotiating */ 210 #define TCPOPT_WINDOW 3 /* Window scaling */ 211 #define TCPOPT_SACK_PERM 4 /* SACK Permitted */ 212 #define TCPOPT_SACK 5 /* SACK Block */ 213 #define TCPOPT_TIMESTAMP 8 /* Better RTT estimations/PAWS */ 214 #define TCPOPT_MD5SIG 19 /* MD5 Signature (RFC2385) */ 215 #define TCPOPT_AO 29 /* Authentication Option (RFC5925) */ 216 #define TCPOPT_MPTCP 30 /* Multipath TCP (RFC6824) */ 217 #define TCPOPT_FASTOPEN 34 /* Fast open (RFC7413) */ 218 #define TCPOPT_ACCECN0 172 /* 0xAC: Accurate ECN Order 0 */ 219 #define TCPOPT_ACCECN1 174 /* 0xAE: Accurate ECN Order 1 */ 220 #define TCPOPT_EXP 254 /* Experimental */ 221 /* Magic number to be after the option value for sharing TCP 222 * experimental options. See draft-ietf-tcpm-experimental-options-00.txt 223 */ 224 #define TCPOPT_FASTOPEN_MAGIC 0xF989 225 #define TCPOPT_SMC_MAGIC 0xE2D4C3D9 226 227 /* 228 * TCP option lengths 229 */ 230 231 #define TCPOLEN_MSS 4 232 #define TCPOLEN_WINDOW 3 233 #define TCPOLEN_SACK_PERM 2 234 #define TCPOLEN_TIMESTAMP 10 235 #define TCPOLEN_MD5SIG 18 236 #define TCPOLEN_FASTOPEN_BASE 2 237 #define TCPOLEN_ACCECN_BASE 2 238 #define TCPOLEN_EXP_FASTOPEN_BASE 4 239 #define TCPOLEN_EXP_SMC_BASE 6 240 241 /* But this is what stacks really send out. */ 242 #define TCPOLEN_TSTAMP_ALIGNED 12 243 #define TCPOLEN_WSCALE_ALIGNED 4 244 #define TCPOLEN_SACKPERM_ALIGNED 4 245 #define TCPOLEN_SACK_BASE 2 246 #define TCPOLEN_SACK_BASE_ALIGNED 4 247 #define TCPOLEN_SACK_PERBLOCK 8 248 #define TCPOLEN_MD5SIG_ALIGNED 20 249 #define TCPOLEN_MSS_ALIGNED 4 250 #define TCPOLEN_EXP_SMC_BASE_ALIGNED 8 251 #define TCPOLEN_ACCECN_PERFIELD 3 252 253 /* Maximum number of byte counters in AccECN option + size */ 254 #define TCP_ACCECN_NUMFIELDS 3 255 #define TCP_ACCECN_MAXSIZE (TCPOLEN_ACCECN_BASE + \ 256 TCPOLEN_ACCECN_PERFIELD * \ 257 TCP_ACCECN_NUMFIELDS) 258 #define TCP_ACCECN_SAFETY_SHIFT 1 /* SAFETY_FACTOR in accecn draft */ 259 260 /* Flags in tp->nonagle */ 261 #define TCP_NAGLE_OFF 1 /* Nagle's algo is disabled */ 262 #define TCP_NAGLE_CORK 2 /* Socket is corked */ 263 #define TCP_NAGLE_PUSH 4 /* Cork is overridden for already queued data */ 264 265 /* TCP thin-stream limits */ 266 #define TCP_THIN_LINEAR_RETRIES 6 /* After 6 linear retries, do exp. backoff */ 267 268 /* TCP initial congestion window as per rfc6928 */ 269 #define TCP_INIT_CWND 10 270 271 /* Bit Flags for sysctl_tcp_fastopen */ 272 #define TFO_CLIENT_ENABLE 1 273 #define TFO_SERVER_ENABLE 2 274 #define TFO_CLIENT_NO_COOKIE 4 /* Data in SYN w/o cookie option */ 275 276 /* Accept SYN data w/o any cookie option */ 277 #define TFO_SERVER_COOKIE_NOT_REQD 0x200 278 279 /* Force enable TFO on all listeners, i.e., not requiring the 280 * TCP_FASTOPEN socket option. 281 */ 282 #define TFO_SERVER_WO_SOCKOPT1 0x400 283 284 285 /* sysctl variables for tcp */ 286 extern int sysctl_tcp_max_orphans; 287 extern long sysctl_tcp_mem[3]; 288 289 #define TCP_RACK_LOSS_DETECTION 0x1 /* Use RACK to detect losses */ 290 #define TCP_RACK_STATIC_REO_WND 0x2 /* Use static RACK reo wnd */ 291 #define TCP_RACK_NO_DUPTHRESH 0x4 /* Do not use DUPACK threshold in RACK */ 292 293 DECLARE_PER_CPU(int, tcp_memory_per_cpu_fw_alloc); 294 295 extern struct percpu_counter tcp_sockets_allocated; 296 extern unsigned long tcp_memory_pressure; 297 298 /* optimized version of sk_under_memory_pressure() for TCP sockets */ 299 static inline bool tcp_under_memory_pressure(const struct sock *sk) 300 { 301 if (mem_cgroup_sk_enabled(sk) && 302 mem_cgroup_sk_under_memory_pressure(sk)) 303 return true; 304 305 if (sk->sk_bypass_prot_mem) 306 return false; 307 308 return READ_ONCE(tcp_memory_pressure); 309 } 310 /* 311 * The next routines deal with comparing 32 bit unsigned ints 312 * and worry about wraparound (automatic with unsigned arithmetic). 313 */ 314 315 static inline bool before(__u32 seq1, __u32 seq2) 316 { 317 return (__s32)(seq1-seq2) < 0; 318 } 319 #define after(seq2, seq1) before(seq1, seq2) 320 321 /* is s2<=s1<=s3 ? */ 322 static inline bool between(__u32 seq1, __u32 seq2, __u32 seq3) 323 { 324 return seq3 - seq2 >= seq1 - seq2; 325 } 326 327 static inline void tcp_wmem_free_skb(struct sock *sk, struct sk_buff *skb) 328 { 329 sk_wmem_queued_add(sk, -skb->truesize); 330 if (!skb_zcopy_pure(skb)) 331 sk_mem_uncharge(sk, skb->truesize); 332 else 333 sk_mem_uncharge(sk, SKB_TRUESIZE(skb_end_offset(skb))); 334 __kfree_skb(skb); 335 } 336 337 void sk_forced_mem_schedule(struct sock *sk, int size); 338 339 bool tcp_check_oom(const struct sock *sk, int shift); 340 341 342 extern struct proto tcp_prot; 343 344 #define TCP_INC_STATS(net, field) SNMP_INC_STATS((net)->mib.tcp_statistics, field) 345 #define __TCP_INC_STATS(net, field) __SNMP_INC_STATS((net)->mib.tcp_statistics, field) 346 #define TCP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->mib.tcp_statistics, field) 347 #define TCP_ADD_STATS(net, field, val) SNMP_ADD_STATS((net)->mib.tcp_statistics, field, val) 348 349 /* 350 * TCP splice context 351 */ 352 struct tcp_splice_state { 353 struct pipe_inode_info *pipe; 354 size_t len; 355 unsigned int flags; 356 }; 357 358 void tcp_tsq_work_init(void); 359 360 int tcp_v4_err(struct sk_buff *skb, u32); 361 362 void tcp_shutdown(struct sock *sk, int how); 363 364 int tcp_v4_rcv(struct sk_buff *skb); 365 366 void tcp_remove_empty_skb(struct sock *sk); 367 int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size); 368 int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size); 369 int tcp_sendmsg_fastopen(struct sock *sk, struct msghdr *msg, int *copied, 370 size_t size, struct ubuf_info *uarg); 371 void tcp_splice_eof(struct socket *sock); 372 int tcp_send_mss(struct sock *sk, int *size_goal, int flags); 373 int tcp_wmem_schedule(struct sock *sk, int copy); 374 void tcp_push(struct sock *sk, int flags, int mss_now, int nonagle, 375 int size_goal); 376 377 void tcp_release_cb(struct sock *sk); 378 379 static inline bool tcp_release_cb_cond(struct sock *sk) 380 { 381 #ifdef CONFIG_INET 382 if (likely(sk->sk_prot->release_cb == tcp_release_cb)) { 383 if (unlikely(smp_load_acquire(&sk->sk_tsq_flags) & TCP_DEFERRED_ALL)) 384 tcp_release_cb(sk); 385 return true; 386 } 387 #endif 388 return false; 389 } 390 391 void tcp_write_timer_handler(struct sock *sk); 392 void tcp_delack_timer_handler(struct sock *sk); 393 int tcp_ioctl(struct sock *sk, int cmd, int *karg); 394 enum skb_drop_reason tcp_rcv_state_process(struct sock *sk, struct sk_buff *skb); 395 void tcp_rcv_established(struct sock *sk, struct sk_buff *skb); 396 void tcp_rcvbuf_grow(struct sock *sk, u32 newval); 397 void tcp_rcv_space_adjust(struct sock *sk); 398 int tcp_twsk_unique(struct sock *sk, struct sock *sktw, void *twp); 399 void tcp_twsk_destructor(struct sock *sk); 400 void tcp_twsk_purge(struct list_head *net_exit_list); 401 int tcp_splice_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, 402 unsigned int offset, size_t len); 403 ssize_t tcp_splice_read(struct socket *sk, loff_t *ppos, 404 struct pipe_inode_info *pipe, size_t len, 405 unsigned int flags); 406 struct sk_buff *tcp_stream_alloc_skb(struct sock *sk, gfp_t gfp, 407 bool force_schedule); 408 409 static inline void tcp_dec_quickack_mode(struct sock *sk) 410 { 411 struct inet_connection_sock *icsk = inet_csk(sk); 412 413 if (icsk->icsk_ack.quick) { 414 /* How many ACKs S/ACKing new data have we sent? */ 415 const unsigned int pkts = inet_csk_ack_scheduled(sk) ? 1 : 0; 416 417 if (pkts >= icsk->icsk_ack.quick) { 418 icsk->icsk_ack.quick = 0; 419 /* Leaving quickack mode we deflate ATO. */ 420 icsk->icsk_ack.ato = TCP_ATO_MIN; 421 } else 422 icsk->icsk_ack.quick -= pkts; 423 } 424 } 425 426 #define TCP_ECN_MODE_RFC3168 BIT(0) 427 #define TCP_ECN_QUEUE_CWR BIT(1) 428 #define TCP_ECN_DEMAND_CWR BIT(2) 429 #define TCP_ECN_SEEN BIT(3) 430 #define TCP_ECN_MODE_ACCECN BIT(4) 431 432 #define TCP_ECN_DISABLED 0 433 #define TCP_ECN_MODE_PENDING (TCP_ECN_MODE_RFC3168 | TCP_ECN_MODE_ACCECN) 434 #define TCP_ECN_MODE_ANY (TCP_ECN_MODE_RFC3168 | TCP_ECN_MODE_ACCECN) 435 436 static inline bool tcp_ecn_mode_any(const struct tcp_sock *tp) 437 { 438 return tp->ecn_flags & TCP_ECN_MODE_ANY; 439 } 440 441 static inline bool tcp_ecn_mode_rfc3168(const struct tcp_sock *tp) 442 { 443 return (tp->ecn_flags & TCP_ECN_MODE_ANY) == TCP_ECN_MODE_RFC3168; 444 } 445 446 static inline bool tcp_ecn_mode_accecn(const struct tcp_sock *tp) 447 { 448 return (tp->ecn_flags & TCP_ECN_MODE_ANY) == TCP_ECN_MODE_ACCECN; 449 } 450 451 static inline bool tcp_ecn_disabled(const struct tcp_sock *tp) 452 { 453 return !tcp_ecn_mode_any(tp); 454 } 455 456 static inline bool tcp_ecn_mode_pending(const struct tcp_sock *tp) 457 { 458 return (tp->ecn_flags & TCP_ECN_MODE_PENDING) == TCP_ECN_MODE_PENDING; 459 } 460 461 static inline void tcp_ecn_mode_set(struct tcp_sock *tp, u8 mode) 462 { 463 tp->ecn_flags &= ~TCP_ECN_MODE_ANY; 464 tp->ecn_flags |= mode; 465 } 466 467 enum tcp_tw_status { 468 TCP_TW_SUCCESS = 0, 469 TCP_TW_RST = 1, 470 TCP_TW_ACK = 2, 471 TCP_TW_SYN = 3, 472 TCP_TW_ACK_OOW = 4 473 }; 474 475 476 enum tcp_tw_status tcp_timewait_state_process(struct inet_timewait_sock *tw, 477 struct sk_buff *skb, 478 const struct tcphdr *th, 479 u32 *tw_isn, 480 enum skb_drop_reason *drop_reason); 481 struct sock *tcp_check_req(struct sock *sk, struct sk_buff *skb, 482 struct request_sock *req, bool fastopen, 483 bool *lost_race, enum skb_drop_reason *drop_reason); 484 enum skb_drop_reason tcp_child_process(struct sock *parent, struct sock *child, 485 struct sk_buff *skb); 486 void tcp_enter_loss(struct sock *sk); 487 void tcp_cwnd_reduction(struct sock *sk, int newly_acked_sacked, int newly_lost, int flag); 488 void tcp_clear_retrans(struct tcp_sock *tp); 489 void tcp_update_pacing_rate(struct sock *sk); 490 void tcp_set_rto(struct sock *sk); 491 void tcp_update_metrics(struct sock *sk); 492 void tcp_init_metrics(struct sock *sk); 493 void tcp_metrics_init(void); 494 bool tcp_peer_is_proven(struct request_sock *req, struct dst_entry *dst); 495 void __tcp_close(struct sock *sk, long timeout); 496 void tcp_close(struct sock *sk, long timeout); 497 void tcp_init_sock(struct sock *sk); 498 void tcp_init_transfer(struct sock *sk, int bpf_op, struct sk_buff *skb); 499 __poll_t tcp_poll(struct file *file, struct socket *sock, 500 struct poll_table_struct *wait); 501 int do_tcp_getsockopt(struct sock *sk, int level, 502 int optname, sockptr_t optval, sockptr_t optlen); 503 int tcp_getsockopt(struct sock *sk, int level, int optname, 504 char __user *optval, int __user *optlen); 505 bool tcp_bpf_bypass_getsockopt(int level, int optname); 506 int do_tcp_setsockopt(struct sock *sk, int level, int optname, 507 sockptr_t optval, unsigned int optlen); 508 int tcp_setsockopt(struct sock *sk, int level, int optname, sockptr_t optval, 509 unsigned int optlen); 510 void tcp_reset_keepalive_timer(struct sock *sk, unsigned long timeout); 511 void tcp_set_keepalive(struct sock *sk, int val); 512 void tcp_syn_ack_timeout(const struct request_sock *req); 513 int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, 514 int flags); 515 int __tcp_set_rcvlowat(struct sock *sk, int val, bool wakeup); 516 int tcp_set_rcvlowat(struct sock *sk, int val); 517 void tcp_set_rcvbuf(struct sock *sk, int val); 518 int tcp_set_window_clamp(struct sock *sk, int val); 519 520 static inline void 521 tcp_update_recv_tstamps(struct sk_buff *skb, 522 struct scm_timestamping_internal *tss) 523 { 524 tss->ts[0] = skb->tstamp; 525 tss->ts[2] = skb_hwtstamps(skb)->hwtstamp; 526 } 527 528 void tcp_recv_timestamp(struct msghdr *msg, const struct sock *sk, 529 struct scm_timestamping_internal *tss); 530 void tcp_data_ready(struct sock *sk); 531 #ifdef CONFIG_MMU 532 int tcp_mmap(struct file *file, struct socket *sock, 533 struct vm_area_struct *vma); 534 #endif 535 void tcp_parse_options(const struct net *net, const struct sk_buff *skb, 536 struct tcp_options_received *opt_rx, 537 int estab, struct tcp_fastopen_cookie *foc); 538 539 /* 540 * BPF SKB-less helpers 541 */ 542 u16 tcp_v4_get_syncookie(struct sock *sk, struct iphdr *iph, 543 struct tcphdr *th, u32 *cookie); 544 u16 tcp_v6_get_syncookie(struct sock *sk, struct ipv6hdr *iph, 545 struct tcphdr *th, u32 *cookie); 546 u16 tcp_parse_mss_option(const struct tcphdr *th, u16 user_mss); 547 u16 tcp_get_syncookie_mss(struct request_sock_ops *rsk_ops, 548 const struct tcp_request_sock_ops *af_ops, 549 struct sock *sk, struct tcphdr *th); 550 /* 551 * TCP v4 functions exported for the inet6 API 552 */ 553 554 void tcp_v4_mtu_reduced(struct sock *sk); 555 void tcp_req_err(struct sock *sk, u32 seq, bool abort); 556 void tcp_ld_RTO_revert(struct sock *sk, u32 seq); 557 int tcp_v4_conn_request(struct sock *sk, struct sk_buff *skb); 558 struct sock *tcp_create_openreq_child(const struct sock *sk, 559 struct request_sock *req, 560 struct sk_buff *skb); 561 void tcp_ca_openreq_child(struct sock *sk, const struct dst_entry *dst); 562 struct sock *tcp_v4_syn_recv_sock(const struct sock *sk, struct sk_buff *skb, 563 struct request_sock *req, 564 struct dst_entry *dst, 565 struct request_sock *req_unhash, 566 bool *own_req, 567 void (*opt_child_init)(struct sock *newsk, 568 const struct sock *sk)); 569 int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb); 570 int tcp_v4_connect(struct sock *sk, struct sockaddr_unsized *uaddr, int addr_len); 571 int tcp_connect(struct sock *sk); 572 enum tcp_synack_type { 573 TCP_SYNACK_NORMAL, 574 TCP_SYNACK_FASTOPEN, 575 TCP_SYNACK_COOKIE, 576 TCP_SYNACK_RETRANS, 577 }; 578 struct sk_buff *tcp_make_synack(const struct sock *sk, struct dst_entry *dst, 579 struct request_sock *req, 580 struct tcp_fastopen_cookie *foc, 581 enum tcp_synack_type synack_type, 582 struct sk_buff *syn_skb); 583 int tcp_disconnect(struct sock *sk, int flags); 584 585 void tcp_finish_connect(struct sock *sk, struct sk_buff *skb); 586 int tcp_send_rcvq(struct sock *sk, struct msghdr *msg, size_t size); 587 void inet_sk_rx_dst_set(struct sock *sk, const struct sk_buff *skb); 588 589 /* From syncookies.c */ 590 struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb, 591 struct request_sock *req, 592 struct dst_entry *dst); 593 int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th); 594 struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb); 595 struct request_sock *cookie_tcp_reqsk_alloc(const struct request_sock_ops *ops, 596 struct sock *sk, struct sk_buff *skb, 597 struct tcp_options_received *tcp_opt, 598 int mss, u32 tsoff); 599 600 #if IS_ENABLED(CONFIG_BPF) 601 struct bpf_tcp_req_attrs { 602 u32 rcv_tsval; 603 u32 rcv_tsecr; 604 u16 mss; 605 u8 rcv_wscale; 606 u8 snd_wscale; 607 u8 ecn_ok; 608 u8 wscale_ok; 609 u8 sack_ok; 610 u8 tstamp_ok; 611 u8 usec_ts_ok; 612 u8 reserved[3]; 613 }; 614 #endif 615 616 #ifdef CONFIG_SYN_COOKIES 617 618 /* Syncookies use a monotonic timer which increments every 60 seconds. 619 * This counter is used both as a hash input and partially encoded into 620 * the cookie value. A cookie is only validated further if the delta 621 * between the current counter value and the encoded one is less than this, 622 * i.e. a sent cookie is valid only at most for 2*60 seconds (or less if 623 * the counter advances immediately after a cookie is generated). 624 */ 625 #define MAX_SYNCOOKIE_AGE 2 626 #define TCP_SYNCOOKIE_PERIOD (60 * HZ) 627 #define TCP_SYNCOOKIE_VALID (MAX_SYNCOOKIE_AGE * TCP_SYNCOOKIE_PERIOD) 628 629 /* syncookies: remember time of last synqueue overflow 630 * But do not dirty this field too often (once per second is enough) 631 * It is racy as we do not hold a lock, but race is very minor. 632 */ 633 static inline void tcp_synq_overflow(const struct sock *sk) 634 { 635 unsigned int last_overflow; 636 unsigned int now = jiffies; 637 638 if (sk->sk_reuseport) { 639 struct sock_reuseport *reuse; 640 641 reuse = rcu_dereference(sk->sk_reuseport_cb); 642 if (likely(reuse)) { 643 last_overflow = READ_ONCE(reuse->synq_overflow_ts); 644 if (!time_between32(now, last_overflow, 645 last_overflow + HZ)) 646 WRITE_ONCE(reuse->synq_overflow_ts, now); 647 return; 648 } 649 } 650 651 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp); 652 if (!time_between32(now, last_overflow, last_overflow + HZ)) 653 WRITE_ONCE(tcp_sk_rw(sk)->rx_opt.ts_recent_stamp, now); 654 } 655 656 /* syncookies: no recent synqueue overflow on this listening socket? */ 657 static inline bool tcp_synq_no_recent_overflow(const struct sock *sk) 658 { 659 unsigned int last_overflow; 660 unsigned int now = jiffies; 661 662 if (sk->sk_reuseport) { 663 struct sock_reuseport *reuse; 664 665 reuse = rcu_dereference(sk->sk_reuseport_cb); 666 if (likely(reuse)) { 667 last_overflow = READ_ONCE(reuse->synq_overflow_ts); 668 return !time_between32(now, last_overflow - HZ, 669 last_overflow + 670 TCP_SYNCOOKIE_VALID); 671 } 672 } 673 674 last_overflow = READ_ONCE(tcp_sk(sk)->rx_opt.ts_recent_stamp); 675 676 /* If last_overflow <= jiffies <= last_overflow + TCP_SYNCOOKIE_VALID, 677 * then we're under synflood. However, we have to use 678 * 'last_overflow - HZ' as lower bound. That's because a concurrent 679 * tcp_synq_overflow() could update .ts_recent_stamp after we read 680 * jiffies but before we store .ts_recent_stamp into last_overflow, 681 * which could lead to rejecting a valid syncookie. 682 */ 683 return !time_between32(now, last_overflow - HZ, 684 last_overflow + TCP_SYNCOOKIE_VALID); 685 } 686 687 static inline u32 tcp_cookie_time(void) 688 { 689 u64 val = get_jiffies_64(); 690 691 do_div(val, TCP_SYNCOOKIE_PERIOD); 692 return val; 693 } 694 695 /* Convert one nsec 64bit timestamp to ts (ms or usec resolution) */ 696 static inline u64 tcp_ns_to_ts(bool usec_ts, u64 val) 697 { 698 if (usec_ts) 699 return div_u64(val, NSEC_PER_USEC); 700 701 return div_u64(val, NSEC_PER_MSEC); 702 } 703 704 u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th, 705 u16 *mssp); 706 __u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mss); 707 u64 cookie_init_timestamp(struct request_sock *req, u64 now); 708 bool cookie_timestamp_decode(const struct net *net, 709 struct tcp_options_received *opt); 710 711 static inline bool cookie_ecn_ok(const struct net *net, const struct dst_entry *dst) 712 { 713 return READ_ONCE(net->ipv4.sysctl_tcp_ecn) || 714 dst_feature(dst, RTAX_FEATURE_ECN); 715 } 716 717 #if IS_ENABLED(CONFIG_BPF) 718 static inline bool cookie_bpf_ok(struct sk_buff *skb) 719 { 720 return skb->sk; 721 } 722 723 struct request_sock *cookie_bpf_check(struct sock *sk, struct sk_buff *skb); 724 #else 725 static inline bool cookie_bpf_ok(struct sk_buff *skb) 726 { 727 return false; 728 } 729 730 static inline struct request_sock *cookie_bpf_check(struct net *net, struct sock *sk, 731 struct sk_buff *skb) 732 { 733 return NULL; 734 } 735 #endif 736 737 /* From net/ipv6/syncookies.c */ 738 int __cookie_v6_check(const struct ipv6hdr *iph, const struct tcphdr *th); 739 struct sock *cookie_v6_check(struct sock *sk, struct sk_buff *skb); 740 741 u32 __cookie_v6_init_sequence(const struct ipv6hdr *iph, 742 const struct tcphdr *th, u16 *mssp); 743 __u32 cookie_v6_init_sequence(const struct sk_buff *skb, __u16 *mss); 744 #endif 745 /* tcp_output.c */ 746 747 void tcp_skb_entail(struct sock *sk, struct sk_buff *skb); 748 void tcp_mark_push(struct tcp_sock *tp, struct sk_buff *skb); 749 void __tcp_push_pending_frames(struct sock *sk, unsigned int cur_mss, 750 int nonagle); 751 int __tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs); 752 int tcp_retransmit_skb(struct sock *sk, struct sk_buff *skb, int segs); 753 void tcp_retransmit_timer(struct sock *sk); 754 void tcp_xmit_retransmit_queue(struct sock *); 755 void tcp_simple_retransmit(struct sock *); 756 void tcp_enter_recovery(struct sock *sk, bool ece_ack); 757 int tcp_trim_head(struct sock *, struct sk_buff *, u32); 758 enum tcp_queue { 759 TCP_FRAG_IN_WRITE_QUEUE, 760 TCP_FRAG_IN_RTX_QUEUE, 761 }; 762 int tcp_fragment(struct sock *sk, enum tcp_queue tcp_queue, 763 struct sk_buff *skb, u32 len, 764 unsigned int mss_now, gfp_t gfp); 765 766 void tcp_send_probe0(struct sock *); 767 int tcp_write_wakeup(struct sock *, int mib); 768 void tcp_send_fin(struct sock *sk); 769 void tcp_send_active_reset(struct sock *sk, enum sk_rst_reason reason); 770 int tcp_send_synack(struct sock *); 771 void tcp_push_one(struct sock *, unsigned int mss_now); 772 void __tcp_send_ack(struct sock *sk, u32 rcv_nxt, u16 flags); 773 void tcp_send_ack(struct sock *sk); 774 void tcp_send_delayed_ack(struct sock *sk); 775 void tcp_send_loss_probe(struct sock *sk); 776 bool tcp_schedule_loss_probe(struct sock *sk, bool advancing_rto); 777 void tcp_skb_collapse_tstamp(struct sk_buff *skb, 778 const struct sk_buff *next_skb); 779 780 /* tcp_input.c */ 781 void tcp_rearm_rto(struct sock *sk); 782 void tcp_synack_rtt_meas(struct sock *sk, struct request_sock *req); 783 void tcp_done_with_error(struct sock *sk, int err); 784 void tcp_reset(struct sock *sk, struct sk_buff *skb); 785 void tcp_fin(struct sock *sk); 786 void __tcp_check_space(struct sock *sk); 787 788 /* Mirror of SOCK_NOSPACE in tcp_sock, maintained by sk_set_nospace() 789 * and sk_clear_nospace(). 790 * 791 * MPTCP subflows share the parent socket, and thus its SOCK_NOSPACE bit. 792 * Keep their mirror always set (see subflow_ulp_init()) so that they 793 * always reach __tcp_check_space() and behave as before. 794 */ 795 static inline void tcp_set_nospace(struct sock *sk) 796 { 797 if (sk_is_tcp(sk)) { 798 /* pairs with smp_mb__before_atomic() in tcp_clear_nospace() */ 799 smp_mb__after_atomic(); 800 /* pairs with smp_mb() in tcp_check_space() */ 801 smp_store_mb(tcp_sk(sk)->tcp_nospace, 1); 802 } 803 } 804 805 static inline void tcp_clear_nospace(struct sock *sk) 806 { 807 if (sk_is_tcp(sk) && !sk_is_mptcp(sk)) { 808 WRITE_ONCE(tcp_sk(sk)->tcp_nospace, 0); 809 /* pairs with smp_mb__after_atomic() in tcp_set_nospace() */ 810 smp_mb__before_atomic(); 811 } 812 } 813 814 static inline void tcp_check_space(struct sock *sk) 815 { 816 /* pairs with tcp_poll() */ 817 smp_mb(); 818 819 if (unlikely(READ_ONCE(tcp_sk(sk)->tcp_nospace))) 820 __tcp_check_space(sk); 821 } 822 823 void tcp_sack_compress_send_ack(struct sock *sk); 824 825 static inline void tcp_cleanup_skb(struct sk_buff *skb) 826 { 827 skb_dst_drop(skb); 828 secpath_reset(skb); 829 } 830 831 static inline void tcp_add_receive_queue(struct sock *sk, struct sk_buff *skb) 832 { 833 DEBUG_NET_WARN_ON_ONCE(skb_dst(skb)); 834 DEBUG_NET_WARN_ON_ONCE(secpath_exists(skb)); 835 __skb_queue_tail(&sk->sk_receive_queue, skb); 836 } 837 838 /* tcp_timer.c */ 839 void tcp_init_xmit_timers(struct sock *); 840 static inline void tcp_clear_xmit_timers(struct sock *sk) 841 { 842 if (hrtimer_try_to_cancel(&tcp_sk(sk)->pacing_timer) == 1) 843 __sock_put(sk); 844 845 if (hrtimer_try_to_cancel(&tcp_sk(sk)->compressed_ack_timer) == 1) 846 __sock_put(sk); 847 848 inet_csk_clear_xmit_timers(sk); 849 } 850 851 unsigned int tcp_sync_mss(struct sock *sk, u32 pmtu); 852 unsigned int tcp_current_mss(struct sock *sk); 853 u32 tcp_clamp_probe0_to_user_timeout(const struct sock *sk, u32 when); 854 855 u32 tcp_tso_autosize(const struct sock *sk, unsigned int mss_now, 856 int min_tso_segs); 857 858 /* Bound MSS / TSO packet size with the half of the window */ 859 static inline int tcp_bound_to_half_wnd(struct tcp_sock *tp, int pktsize) 860 { 861 int cutoff; 862 863 /* When peer uses tiny windows, there is no use in packetizing 864 * to sub-MSS pieces for the sake of SWS or making sure there 865 * are enough packets in the pipe for fast recovery. 866 * 867 * On the other hand, for extremely large MSS devices, handling 868 * smaller than MSS windows in this way does make sense. 869 */ 870 if (tp->max_window > TCP_MSS_DEFAULT) 871 cutoff = (tp->max_window >> 1); 872 else 873 cutoff = tp->max_window; 874 875 if (cutoff && pktsize > cutoff) 876 return max_t(int, cutoff, 68U - tp->tcp_header_len); 877 else 878 return pktsize; 879 } 880 881 /* tcp.c */ 882 void tcp_get_info(struct sock *, struct tcp_info *); 883 void tcp_rate_check_app_limited(struct sock *sk); 884 885 /* Read 'sendfile()'-style from a TCP socket */ 886 int tcp_read_sock(struct sock *sk, read_descriptor_t *desc, 887 sk_read_actor_t recv_actor); 888 int tcp_read_sock_noack(struct sock *sk, read_descriptor_t *desc, 889 sk_read_actor_t recv_actor, bool noack, 890 u32 *copied_seq); 891 int tcp_read_skb(struct sock *sk, skb_read_actor_t recv_actor); 892 struct sk_buff *tcp_recv_skb(struct sock *sk, u32 seq, u32 *off); 893 void tcp_read_done(struct sock *sk, size_t len); 894 895 void tcp_initialize_rcv_mss(struct sock *sk); 896 897 int tcp_mtu_to_mss(struct sock *sk, int pmtu); 898 int tcp_mss_to_mtu(struct sock *sk, int mss); 899 void tcp_mtup_init(struct sock *sk); 900 901 static inline unsigned int tcp_rto_max(const struct sock *sk) 902 { 903 return READ_ONCE(inet_csk(sk)->icsk_rto_max); 904 } 905 906 static inline void tcp_bound_rto(struct sock *sk) 907 { 908 inet_csk(sk)->icsk_rto = min(inet_csk(sk)->icsk_rto, tcp_rto_max(sk)); 909 } 910 911 static inline u32 __tcp_set_rto(const struct tcp_sock *tp) 912 { 913 return usecs_to_jiffies((tp->srtt_us >> 3) + tp->rttvar_us); 914 } 915 916 static inline unsigned long tcp_reqsk_timeout(struct request_sock *req) 917 { 918 u64 timeout = (u64)req->timeout << req->num_timeout; 919 920 return (unsigned long)min_t(u64, timeout, 921 tcp_rto_max(req->rsk_listener)); 922 } 923 924 u32 tcp_delack_max(const struct sock *sk); 925 926 /* Compute the actual rto_min value */ 927 static inline u32 tcp_rto_min(const struct sock *sk) 928 { 929 const struct dst_entry *dst = __sk_dst_get(sk); 930 u32 rto_min = READ_ONCE(inet_csk(sk)->icsk_rto_min); 931 932 if (dst && dst_metric_locked(dst, RTAX_RTO_MIN)) 933 rto_min = dst_metric_rtt(dst, RTAX_RTO_MIN); 934 return rto_min; 935 } 936 937 static inline u32 tcp_rto_min_us(const struct sock *sk) 938 { 939 return jiffies_to_usecs(tcp_rto_min(sk)); 940 } 941 942 static inline bool tcp_ca_dst_locked(const struct dst_entry *dst) 943 { 944 return dst_metric_locked(dst, RTAX_CC_ALGO); 945 } 946 947 /* Minimum RTT in usec. ~0 means not available. */ 948 static inline u32 tcp_min_rtt(const struct tcp_sock *tp) 949 { 950 return minmax_get(&tp->rtt_min); 951 } 952 953 /* Compute the actual receive window we are currently advertising. 954 * Rcv_nxt can be after the window if our peer push more data 955 * than the offered window. 956 */ 957 static inline u32 tcp_receive_window(const struct tcp_sock *tp) 958 { 959 s32 win = tp->rcv_wup + tp->rcv_wnd - tp->rcv_nxt; 960 961 if (win < 0) 962 win = 0; 963 return (u32) win; 964 } 965 966 /* Compute the maximum receive window we ever advertised. 967 * Rcv_nxt can be after the window if our peer push more data 968 * than the offered window. 969 */ 970 static inline u32 tcp_max_receive_window(const struct tcp_sock *tp) 971 { 972 s32 win = tp->rcv_mwnd_seq - tp->rcv_nxt; 973 974 if (win < 0) 975 win = 0; 976 return (u32) win; 977 } 978 979 /* Check if we need to update the maximum receive window sequence number */ 980 static inline void tcp_update_max_rcv_wnd_seq(struct tcp_sock *tp) 981 { 982 u32 wre = tp->rcv_wup + tp->rcv_wnd; 983 984 if (after(wre, tp->rcv_mwnd_seq)) 985 tp->rcv_mwnd_seq = wre; 986 } 987 988 /* Choose a new window, without checks for shrinking, and without 989 * scaling applied to the result. The caller does these things 990 * if necessary. This is a "raw" window selection. 991 */ 992 u32 __tcp_select_window(struct sock *sk); 993 994 void tcp_send_window_probe(struct sock *sk); 995 996 /* TCP uses 32bit jiffies to save some space. 997 * Note that this is different from tcp_time_stamp, which 998 * historically has been the same until linux-4.13. 999 */ 1000 #define tcp_jiffies32 ((u32)jiffies) 1001 1002 /* 1003 * Deliver a 32bit value for TCP timestamp option (RFC 7323) 1004 * It is no longer tied to jiffies, but to 1 ms clock. 1005 * Note: double check if you want to use tcp_jiffies32 instead of this. 1006 */ 1007 #define TCP_TS_HZ 1000 1008 1009 static inline u64 tcp_clock_ns(void) 1010 { 1011 return ktime_get_ns(); 1012 } 1013 1014 static inline u64 tcp_clock_us(void) 1015 { 1016 return div_u64(tcp_clock_ns(), NSEC_PER_USEC); 1017 } 1018 1019 static inline u64 tcp_clock_ms(void) 1020 { 1021 return div_u64(tcp_clock_ns(), NSEC_PER_MSEC); 1022 } 1023 1024 /* TCP Timestamp included in TS option (RFC 1323) can either use ms 1025 * or usec resolution. Each socket carries a flag to select one or other 1026 * resolution, as the route attribute could change anytime. 1027 * Each flow must stick to initial resolution. 1028 */ 1029 static inline u32 tcp_clock_ts(bool usec_ts) 1030 { 1031 return usec_ts ? tcp_clock_us() : tcp_clock_ms(); 1032 } 1033 1034 static inline u32 tcp_time_stamp_ms(const struct tcp_sock *tp) 1035 { 1036 return div_u64(tp->tcp_mstamp, USEC_PER_MSEC); 1037 } 1038 1039 static inline u32 tcp_time_stamp_ts(const struct tcp_sock *tp) 1040 { 1041 if (tp->tcp_usec_ts) 1042 return tp->tcp_mstamp; 1043 return tcp_time_stamp_ms(tp); 1044 } 1045 1046 /* Refresh clocks of a TCP socket, 1047 * ensuring monotically increasing values. 1048 */ 1049 static inline void tcp_mstamp_refresh_inline(struct tcp_sock *tp) 1050 { 1051 u64 val = tcp_clock_ns(); 1052 1053 tp->tcp_clock_cache = val; 1054 tp->tcp_mstamp = div_u64(val, NSEC_PER_USEC); 1055 } 1056 void tcp_mstamp_refresh(struct tcp_sock *tp); 1057 1058 static inline u32 tcp_stamp_us_delta(u64 t1, u64 t0) 1059 { 1060 return max_t(s64, t1 - t0, 0); 1061 } 1062 1063 /* provide the departure time in us unit */ 1064 static inline u64 tcp_skb_timestamp_us(const struct sk_buff *skb) 1065 { 1066 return div_u64(skb->skb_mstamp_ns, NSEC_PER_USEC); 1067 } 1068 1069 /* Provide skb TSval in usec or ms unit */ 1070 static inline u32 tcp_skb_timestamp_ts(bool usec_ts, const struct sk_buff *skb) 1071 { 1072 if (usec_ts) 1073 return tcp_skb_timestamp_us(skb); 1074 1075 return div_u64(skb->skb_mstamp_ns, NSEC_PER_MSEC); 1076 } 1077 1078 static inline u32 tcp_tw_tsval(const struct tcp_timewait_sock *tcptw) 1079 { 1080 return tcp_clock_ts(tcptw->tw_sk.tw_usec_ts) + tcptw->tw_ts_offset; 1081 } 1082 1083 static inline u32 tcp_rsk_tsval(const struct tcp_request_sock *treq) 1084 { 1085 return tcp_clock_ts(treq->req_usec_ts) + treq->ts_off; 1086 } 1087 1088 #define tcp_flag_byte(th) (((u_int8_t *)th)[13]) 1089 1090 #define TCPHDR_FIN BIT(0) 1091 #define TCPHDR_SYN BIT(1) 1092 #define TCPHDR_RST BIT(2) 1093 #define TCPHDR_PSH BIT(3) 1094 #define TCPHDR_ACK BIT(4) 1095 #define TCPHDR_URG BIT(5) 1096 #define TCPHDR_ECE BIT(6) 1097 #define TCPHDR_CWR BIT(7) 1098 #define TCPHDR_AE BIT(8) 1099 #define TCPHDR_FLAGS_MASK (TCPHDR_FIN | TCPHDR_SYN | TCPHDR_RST | \ 1100 TCPHDR_PSH | TCPHDR_ACK | TCPHDR_URG | \ 1101 TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE) 1102 #define tcp_flags_ntohs(th) (ntohs(*(__be16 *)&tcp_flag_word(th)) & \ 1103 TCPHDR_FLAGS_MASK) 1104 1105 #define TCPHDR_ACE (TCPHDR_ECE | TCPHDR_CWR | TCPHDR_AE) 1106 #define TCPHDR_SYN_ECN (TCPHDR_SYN | TCPHDR_ECE | TCPHDR_CWR) 1107 #define TCPHDR_SYNACK_ACCECN (TCPHDR_SYN | TCPHDR_ACK | TCPHDR_CWR) 1108 1109 #define TCP_ACCECN_CEP_ACE_MASK 0x7 1110 #define TCP_ACCECN_ACE_MAX_DELTA 6 1111 1112 /* To avoid/detect middlebox interference, not all counters start at 0. 1113 * See draft-ietf-tcpm-accurate-ecn for the latest values. 1114 */ 1115 #define TCP_ACCECN_CEP_INIT_OFFSET 5 1116 #define TCP_ACCECN_E1B_INIT_OFFSET 1 1117 #define TCP_ACCECN_E0B_INIT_OFFSET 1 1118 #define TCP_ACCECN_CEB_INIT_OFFSET 0 1119 1120 /* State flags for sacked in struct tcp_skb_cb */ 1121 enum tcp_skb_cb_sacked_flags { 1122 TCPCB_SACKED_ACKED = (1 << 0), /* SKB ACK'd by a SACK block */ 1123 TCPCB_SACKED_RETRANS = (1 << 1), /* SKB retransmitted */ 1124 TCPCB_LOST = (1 << 2), /* SKB is lost */ 1125 TCPCB_TAGBITS = (TCPCB_SACKED_ACKED | TCPCB_SACKED_RETRANS | 1126 TCPCB_LOST), /* All tag bits */ 1127 TCPCB_REPAIRED = (1 << 4), /* SKB repaired (no skb_mstamp_ns) */ 1128 TCPCB_EVER_RETRANS = (1 << 7), /* Ever retransmitted frame */ 1129 TCPCB_RETRANS = (TCPCB_SACKED_RETRANS | TCPCB_EVER_RETRANS | 1130 TCPCB_REPAIRED), 1131 }; 1132 1133 /* This is what the send packet queuing engine uses to pass 1134 * TCP per-packet control information to the transmission code. 1135 * We also store the host-order sequence numbers in here too. 1136 * This is 44 bytes if IPV6 is enabled. 1137 * If this grows please adjust skbuff.h:skbuff->cb[xxx] size appropriately. 1138 */ 1139 struct tcp_skb_cb { 1140 __u32 seq; /* Starting sequence number */ 1141 __u32 end_seq; /* SEQ + FIN + SYN + datalen */ 1142 union { 1143 /* Notes : 1144 * tcp_tw_isn is used in input path only 1145 * (isn chosen by tcp_timewait_state_process()) 1146 * tcp_gso_segs/size are used in write queue only, 1147 * cf tcp_skb_pcount()/tcp_skb_mss() 1148 */ 1149 u32 tcp_tw_isn; 1150 struct { 1151 u16 tcp_gso_segs; 1152 u16 tcp_gso_size; 1153 }; 1154 }; 1155 __u16 tcp_flags; /* TCP header flags (tcp[12-13])*/ 1156 1157 __u8 sacked; /* State flags for SACK. */ 1158 __u8 ip_dsfield; /* IPv4 tos or IPv6 dsfield */ 1159 #define TSTAMP_ACK_SK 0x1 1160 #define TSTAMP_ACK_BPF 0x2 1161 __u8 txstamp_ack:2, /* Record TX timestamp for ack? */ 1162 eor:1, /* Is skb MSG_EOR marked? */ 1163 has_rxtstamp:1, /* SKB has a RX timestamp */ 1164 unused:4; 1165 __u32 ack_seq; /* Sequence number ACK'd */ 1166 union { 1167 struct { 1168 #define TCPCB_DELIVERED_CE_MASK ((1U<<20) - 1) 1169 /* There is space for up to 24 bytes */ 1170 __u32 is_app_limited:1, /* cwnd not fully used? */ 1171 delivered_ce:20, 1172 unused:11; 1173 /* pkts S/ACKed so far upon tx of skb, incl retrans: */ 1174 __u32 delivered; 1175 /* start of send pipeline phase */ 1176 u64 first_tx_mstamp; 1177 /* when we reached the "delivered" count */ 1178 u64 delivered_mstamp; 1179 } tx; /* only used for outgoing skbs */ 1180 union { 1181 struct inet_skb_parm h4; 1182 #if IS_ENABLED(CONFIG_IPV6) 1183 struct inet6_skb_parm h6; 1184 #endif 1185 } header; /* For incoming skbs */ 1186 }; 1187 }; 1188 1189 #define TCP_SKB_CB(__skb) ((struct tcp_skb_cb *)&((__skb)->cb[0])) 1190 1191 extern const struct inet_connection_sock_af_ops ipv4_specific; 1192 1193 #if IS_ENABLED(CONFIG_IPV6) 1194 /* This is the variant of inet6_iif() that must be used by TCP, 1195 * as TCP moves IP6CB into a different location in skb->cb[] 1196 */ 1197 static inline int tcp_v6_iif(const struct sk_buff *skb) 1198 { 1199 return TCP_SKB_CB(skb)->header.h6.iif; 1200 } 1201 1202 static inline int tcp_v6_iif_l3_slave(const struct sk_buff *skb) 1203 { 1204 bool l3_slave = ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags); 1205 1206 return l3_slave ? skb->skb_iif : TCP_SKB_CB(skb)->header.h6.iif; 1207 } 1208 1209 /* TCP_SKB_CB reference means this can not be used from early demux */ 1210 static inline int tcp_v6_sdif(const struct sk_buff *skb) 1211 { 1212 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV) 1213 if (skb && ipv6_l3mdev_skb(TCP_SKB_CB(skb)->header.h6.flags)) 1214 return TCP_SKB_CB(skb)->header.h6.iif; 1215 #endif 1216 return 0; 1217 } 1218 1219 extern const struct inet_connection_sock_af_ops ipv6_specific; 1220 1221 INDIRECT_CALLABLE_DECLARE(int tcp_v6_rcv(struct sk_buff *skb)); 1222 1223 #endif 1224 1225 /* TCP_SKB_CB reference means this can not be used from early demux */ 1226 static inline int tcp_v4_sdif(struct sk_buff *skb) 1227 { 1228 #if IS_ENABLED(CONFIG_NET_L3_MASTER_DEV) 1229 if (skb && ipv4_l3mdev_skb(TCP_SKB_CB(skb)->header.h4.flags)) 1230 return TCP_SKB_CB(skb)->header.h4.iif; 1231 #endif 1232 return 0; 1233 } 1234 1235 /* Due to TSO, an SKB can be composed of multiple actual 1236 * packets. To keep these tracked properly, we use this. 1237 */ 1238 static inline int tcp_skb_pcount(const struct sk_buff *skb) 1239 { 1240 return TCP_SKB_CB(skb)->tcp_gso_segs; 1241 } 1242 1243 static inline void tcp_skb_pcount_set(struct sk_buff *skb, int segs) 1244 { 1245 TCP_SKB_CB(skb)->tcp_gso_segs = segs; 1246 } 1247 1248 static inline void tcp_skb_pcount_add(struct sk_buff *skb, int segs) 1249 { 1250 TCP_SKB_CB(skb)->tcp_gso_segs += segs; 1251 } 1252 1253 /* This is valid iff skb is in write queue and tcp_skb_pcount() > 1. */ 1254 static inline int tcp_skb_mss(const struct sk_buff *skb) 1255 { 1256 return TCP_SKB_CB(skb)->tcp_gso_size; 1257 } 1258 1259 static inline bool tcp_skb_can_collapse_to(const struct sk_buff *skb) 1260 { 1261 return likely(!TCP_SKB_CB(skb)->eor); 1262 } 1263 1264 static inline bool tcp_skb_can_collapse(const struct sk_buff *to, 1265 const struct sk_buff *from) 1266 { 1267 return likely(tcp_skb_can_collapse_to(to) && 1268 mptcp_skb_can_collapse(to, from) && 1269 !skb_cmp_decrypted(to, from) && 1270 skb_pure_zcopy_same(to, from) && 1271 skb_frags_readable(to) == skb_frags_readable(from)); 1272 } 1273 1274 static inline bool tcp_skb_can_collapse_rx(const struct sk_buff *to, 1275 const struct sk_buff *from) 1276 { 1277 return likely(mptcp_skb_can_collapse(to, from) && 1278 !skb_cmp_decrypted(to, from)); 1279 } 1280 1281 /* Events passed to congestion control interface */ 1282 enum tcp_ca_event { 1283 CA_EVENT_TX_START, /* first transmit when no packets in flight */ 1284 CA_EVENT_CWND_RESTART, /* congestion window restart */ 1285 CA_EVENT_COMPLETE_CWR, /* end of congestion recovery */ 1286 CA_EVENT_LOSS, /* loss timeout */ 1287 CA_EVENT_ECN_NO_CE, /* ECT set, but not CE marked */ 1288 CA_EVENT_ECN_IS_CE, /* received CE marked IP packet */ 1289 }; 1290 1291 /* Information about inbound ACK, passed to cong_ops->in_ack_event() */ 1292 enum tcp_ca_ack_event_flags { 1293 CA_ACK_SLOWPATH = (1 << 0), /* In slow path processing */ 1294 CA_ACK_WIN_UPDATE = (1 << 1), /* ACK updated window */ 1295 CA_ACK_ECE = (1 << 2), /* ECE bit is set on ack */ 1296 }; 1297 1298 /* 1299 * Interface for adding new TCP congestion control handlers 1300 */ 1301 #define TCP_CA_NAME_MAX 16 1302 #define TCP_CA_MAX 128 1303 #define TCP_CA_BUF_MAX (TCP_CA_NAME_MAX*TCP_CA_MAX) 1304 1305 #define TCP_CA_UNSPEC 0 1306 1307 /* Algorithm can be set on socket without CAP_NET_ADMIN privileges */ 1308 #define TCP_CONG_NON_RESTRICTED BIT(0) 1309 /* Requires ECN/ECT set on all packets */ 1310 #define TCP_CONG_NEEDS_ECN BIT(1) 1311 /* Require successfully negotiated AccECN capability */ 1312 #define TCP_CONG_NEEDS_ACCECN BIT(2) 1313 /* Use ECT(1) instead of ECT(0) while the CA is uninitialized */ 1314 #define TCP_CONG_ECT_1_NEGOTIATION BIT(3) 1315 /* Cannot fallback to RFC3168 during AccECN negotiation */ 1316 #define TCP_CONG_NO_FALLBACK_RFC3168 BIT(4) 1317 #define TCP_CONG_MASK (TCP_CONG_NON_RESTRICTED | TCP_CONG_NEEDS_ECN | \ 1318 TCP_CONG_NEEDS_ACCECN | TCP_CONG_ECT_1_NEGOTIATION | \ 1319 TCP_CONG_NO_FALLBACK_RFC3168) 1320 1321 union tcp_cc_info; 1322 1323 struct ack_sample { 1324 u32 pkts_acked; 1325 s32 rtt_us; 1326 u32 in_flight; 1327 }; 1328 1329 /* A rate sample measures the number of (original/retransmitted) data 1330 * packets delivered "delivered" over an interval of time "interval_us". 1331 * The tcp_rate.c code fills in the rate sample, and congestion 1332 * control modules that define a cong_control function to run at the end 1333 * of ACK processing can optionally chose to consult this sample when 1334 * setting cwnd and pacing rate. 1335 * A sample is invalid if "delivered" or "interval_us" is negative. 1336 */ 1337 struct rate_sample { 1338 u64 prior_mstamp; /* starting timestamp for interval */ 1339 u32 prior_delivered; /* tp->delivered at "prior_mstamp" */ 1340 u32 prior_delivered_ce;/* tp->delivered_ce at "prior_mstamp" */ 1341 s32 delivered; /* number of packets delivered over interval */ 1342 s32 delivered_ce; /* number of packets delivered w/ CE marks*/ 1343 long interval_us; /* time for tp->delivered to incr "delivered" */ 1344 u32 snd_interval_us; /* snd interval for delivered packets */ 1345 u32 rcv_interval_us; /* rcv interval for delivered packets */ 1346 long rtt_us; /* RTT of last (S)ACKed packet (or -1) */ 1347 int losses; /* number of packets marked lost upon ACK */ 1348 u32 acked_sacked; /* number of packets newly (S)ACKed upon ACK */ 1349 u32 prior_in_flight; /* in flight before this ACK */ 1350 u32 last_end_seq; /* end_seq of most recently ACKed packet */ 1351 bool is_app_limited; /* is sample from packet with bubble in pipe? */ 1352 bool is_retrans; /* is sample from retransmission? */ 1353 bool is_ack_delayed; /* is this (likely) a delayed ACK? */ 1354 }; 1355 1356 struct tcp_congestion_ops { 1357 /* fast path fields are put first to fill one cache line */ 1358 1359 /* A congestion control (CC) must provide one of either: 1360 * 1361 * (a) a cong_avoid function, if the CC wants to use the core TCP 1362 * stack's default functionality to implement a "classic" 1363 * (Reno/CUBIC-style) response to packet loss, RFC3168 ECN, 1364 * idle periods, pacing rate computations, etc. 1365 * 1366 * (b) a cong_control function, if the CC wants custom behavior and 1367 * complete control of all congestion control behaviors. 1368 */ 1369 /* (a) "classic" response: calculate new cwnd. 1370 */ 1371 void (*cong_avoid)(struct sock *sk, u32 ack, u32 acked); 1372 /* (b) "custom" response: call when packets are delivered to update 1373 * cwnd and pacing rate, after all the ca_state processing. 1374 */ 1375 void (*cong_control)(struct sock *sk, u32 ack, int flag, const struct rate_sample *rs); 1376 1377 /* return slow start threshold (required) */ 1378 u32 (*ssthresh)(struct sock *sk); 1379 1380 /* call before changing ca_state (optional) */ 1381 void (*set_state)(struct sock *sk, u8 new_state); 1382 1383 /* call when cwnd event occurs (optional) */ 1384 void (*cwnd_event)(struct sock *sk, enum tcp_ca_event ev); 1385 1386 /* call when CA_EVENT_TX_START cwnd event occurs (optional) */ 1387 void (*cwnd_event_tx_start)(struct sock *sk); 1388 1389 /* call when ack arrives (optional) */ 1390 void (*in_ack_event)(struct sock *sk, u32 flags); 1391 1392 /* hook for packet ack accounting (optional) */ 1393 void (*pkts_acked)(struct sock *sk, const struct ack_sample *sample); 1394 1395 /* Override tcp_tso_autosize() (optional) 1396 * 1397 * If provided, this callback supplies the TSO segment target count 1398 * instead of using tcp_tso_autosize(). The returned value is 1399 * subsequently clamped to [1, sk->sk_gso_max_segs] by the caller. 1400 * 1401 * For the kernel callback path, mss_now originates from 1402 * tcp_current_mss() and should never be zero. 1403 */ 1404 u32 (*tso_segs)(struct sock *sk, u32 mss_now); 1405 1406 /* new value of cwnd after loss (required) */ 1407 u32 (*undo_cwnd)(struct sock *sk); 1408 /* returns the multiplier used in tcp_sndbuf_expand (optional) */ 1409 u32 (*sndbuf_expand)(struct sock *sk); 1410 1411 /* control/slow paths put last */ 1412 /* get info for inet_diag (optional) */ 1413 size_t (*get_info)(struct sock *sk, u32 ext, int *attr, 1414 union tcp_cc_info *info); 1415 1416 char name[TCP_CA_NAME_MAX]; 1417 struct module *owner; 1418 struct list_head list; 1419 u32 key; 1420 u32 flags; 1421 1422 /* initialize private data (optional) */ 1423 void (*init)(struct sock *sk); 1424 /* cleanup private data (optional) */ 1425 void (*release)(struct sock *sk); 1426 } ____cacheline_aligned_in_smp; 1427 1428 int tcp_register_congestion_control(struct tcp_congestion_ops *type); 1429 void tcp_unregister_congestion_control(struct tcp_congestion_ops *type); 1430 int tcp_update_congestion_control(struct tcp_congestion_ops *type, 1431 struct tcp_congestion_ops *old_type); 1432 int tcp_validate_congestion_control(struct tcp_congestion_ops *ca); 1433 1434 void tcp_assign_congestion_control(struct sock *sk); 1435 void tcp_init_congestion_control(struct sock *sk); 1436 void tcp_cleanup_congestion_control(struct sock *sk); 1437 int tcp_set_default_congestion_control(struct net *net, const char *name); 1438 void tcp_get_default_congestion_control(struct net *net, char *name); 1439 void tcp_get_available_congestion_control(char *buf, size_t len); 1440 void tcp_get_allowed_congestion_control(char *buf, size_t len); 1441 int tcp_set_allowed_congestion_control(char *allowed); 1442 int tcp_set_congestion_control(struct sock *sk, const char *name, bool load, 1443 bool cap_net_admin); 1444 u32 tcp_slow_start(struct tcp_sock *tp, u32 acked); 1445 void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked); 1446 1447 u32 tcp_reno_ssthresh(struct sock *sk); 1448 u32 tcp_reno_undo_cwnd(struct sock *sk); 1449 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked); 1450 extern struct tcp_congestion_ops tcp_reno; 1451 1452 struct tcp_congestion_ops *tcp_ca_find(const char *name); 1453 struct tcp_congestion_ops *tcp_ca_find_key(u32 key); 1454 u32 tcp_ca_get_key_by_name(const char *name, bool *ecn_ca); 1455 #ifdef CONFIG_INET 1456 char *tcp_ca_get_name_by_key(u32 key, char *buffer); 1457 #else 1458 static inline char *tcp_ca_get_name_by_key(u32 key, char *buffer) 1459 { 1460 return NULL; 1461 } 1462 #endif 1463 1464 static inline bool tcp_ca_needs_ecn(const struct sock *sk) 1465 { 1466 const struct inet_connection_sock *icsk = inet_csk(sk); 1467 1468 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ECN; 1469 } 1470 1471 static inline bool tcp_ca_needs_accecn(const struct sock *sk) 1472 { 1473 const struct inet_connection_sock *icsk = inet_csk(sk); 1474 1475 return icsk->icsk_ca_ops->flags & TCP_CONG_NEEDS_ACCECN; 1476 } 1477 1478 static inline bool tcp_ca_ect_1_negotiation(const struct sock *sk) 1479 { 1480 const struct inet_connection_sock *icsk = inet_csk(sk); 1481 1482 return icsk->icsk_ca_ops->flags & TCP_CONG_ECT_1_NEGOTIATION; 1483 } 1484 1485 static inline bool tcp_ca_no_fallback_rfc3168(const struct sock *sk) 1486 { 1487 const struct inet_connection_sock *icsk = inet_csk(sk); 1488 1489 return icsk->icsk_ca_ops->flags & TCP_CONG_NO_FALLBACK_RFC3168; 1490 } 1491 1492 static inline void tcp_ca_event(struct sock *sk, const enum tcp_ca_event event) 1493 { 1494 const struct inet_connection_sock *icsk = inet_csk(sk); 1495 1496 if (event == CA_EVENT_TX_START) { 1497 if (icsk->icsk_ca_ops->cwnd_event_tx_start) 1498 icsk->icsk_ca_ops->cwnd_event_tx_start(sk); 1499 return; 1500 } 1501 if (icsk->icsk_ca_ops->cwnd_event) 1502 icsk->icsk_ca_ops->cwnd_event(sk, event); 1503 } 1504 1505 /* From tcp_cong.c */ 1506 void tcp_set_ca_state(struct sock *sk, const u8 ca_state); 1507 1508 1509 static inline bool tcp_skb_sent_after(u64 t1, u64 t2, u32 seq1, u32 seq2) 1510 { 1511 return t1 > t2 || (t1 == t2 && after(seq1, seq2)); 1512 } 1513 1514 /* These functions determine how the current flow behaves in respect of SACK 1515 * handling. SACK is negotiated with the peer, and therefore it can vary 1516 * between different flows. 1517 * 1518 * tcp_is_sack - SACK enabled 1519 * tcp_is_reno - No SACK 1520 */ 1521 static inline int tcp_is_sack(const struct tcp_sock *tp) 1522 { 1523 return likely(tp->rx_opt.sack_ok); 1524 } 1525 1526 static inline bool tcp_is_reno(const struct tcp_sock *tp) 1527 { 1528 return !tcp_is_sack(tp); 1529 } 1530 1531 static inline unsigned int tcp_left_out(const struct tcp_sock *tp) 1532 { 1533 return tp->sacked_out + tp->lost_out; 1534 } 1535 1536 /* This determines how many packets are "in the network" to the best 1537 * of our knowledge. In many cases it is conservative, but where 1538 * detailed information is available from the receiver (via SACK 1539 * blocks etc.) we can make more aggressive calculations. 1540 * 1541 * Use this for decisions involving congestion control, use just 1542 * tp->packets_out to determine if the send queue is empty or not. 1543 * 1544 * Read this equation as: 1545 * 1546 * "Packets sent once on transmission queue" MINUS 1547 * "Packets left network, but not honestly ACKed yet" PLUS 1548 * "Packets fast retransmitted" 1549 */ 1550 static inline unsigned int tcp_packets_in_flight(const struct tcp_sock *tp) 1551 { 1552 return tp->packets_out - tcp_left_out(tp) + tp->retrans_out; 1553 } 1554 1555 #define TCP_INFINITE_SSTHRESH 0x7fffffff 1556 1557 static inline u32 tcp_snd_cwnd(const struct tcp_sock *tp) 1558 { 1559 return tp->snd_cwnd; 1560 } 1561 1562 static inline void tcp_snd_cwnd_set(struct tcp_sock *tp, u32 val) 1563 { 1564 WARN_ON_ONCE((int)val <= 0); 1565 WRITE_ONCE(tp->snd_cwnd, val); 1566 } 1567 1568 static inline bool tcp_in_slow_start(const struct tcp_sock *tp) 1569 { 1570 return tcp_snd_cwnd(tp) < tp->snd_ssthresh; 1571 } 1572 1573 static inline bool tcp_in_initial_slowstart(const struct tcp_sock *tp) 1574 { 1575 return tp->snd_ssthresh >= TCP_INFINITE_SSTHRESH; 1576 } 1577 1578 static inline bool tcp_in_cwnd_reduction(const struct sock *sk) 1579 { 1580 return (TCPF_CA_CWR | TCPF_CA_Recovery) & 1581 (1 << inet_csk(sk)->icsk_ca_state); 1582 } 1583 1584 /* If cwnd > ssthresh, we may raise ssthresh to be half-way to cwnd. 1585 * The exception is cwnd reduction phase, when cwnd is decreasing towards 1586 * ssthresh. 1587 */ 1588 static inline __u32 tcp_current_ssthresh(const struct sock *sk) 1589 { 1590 const struct tcp_sock *tp = tcp_sk(sk); 1591 1592 if (tcp_in_cwnd_reduction(sk)) 1593 return tp->snd_ssthresh; 1594 else 1595 return max(tp->snd_ssthresh, 1596 ((tcp_snd_cwnd(tp) >> 1) + 1597 (tcp_snd_cwnd(tp) >> 2))); 1598 } 1599 1600 /* Use define here intentionally to get WARN_ON location shown at the caller */ 1601 #define tcp_verify_left_out(tp) WARN_ON(tcp_left_out(tp) > tp->packets_out) 1602 1603 void tcp_enter_cwr(struct sock *sk); 1604 __u32 tcp_init_cwnd(const struct tcp_sock *tp, const struct dst_entry *dst); 1605 1606 /* The maximum number of MSS of available cwnd for which TSO defers 1607 * sending if not using sysctl_tcp_tso_win_divisor. 1608 */ 1609 static inline __u32 tcp_max_tso_deferred_mss(const struct tcp_sock *tp) 1610 { 1611 return 3; 1612 } 1613 1614 /* Returns end sequence number of the receiver's advertised window */ 1615 static inline u32 tcp_wnd_end(const struct tcp_sock *tp) 1616 { 1617 return tp->snd_una + tp->snd_wnd; 1618 } 1619 1620 /* We follow the spirit of RFC2861 to validate cwnd but implement a more 1621 * flexible approach. The RFC suggests cwnd should not be raised unless 1622 * it was fully used previously. And that's exactly what we do in 1623 * congestion avoidance mode. But in slow start we allow cwnd to grow 1624 * as long as the application has used half the cwnd. 1625 * Example : 1626 * cwnd is 10 (IW10), but application sends 9 frames. 1627 * We allow cwnd to reach 18 when all frames are ACKed. 1628 * This check is safe because it's as aggressive as slow start which already 1629 * risks 100% overshoot. The advantage is that we discourage application to 1630 * either send more filler packets or data to artificially blow up the cwnd 1631 * usage, and allow application-limited process to probe bw more aggressively. 1632 */ 1633 static inline bool tcp_is_cwnd_limited(const struct sock *sk) 1634 { 1635 const struct tcp_sock *tp = tcp_sk(sk); 1636 1637 if (tp->is_cwnd_limited) 1638 return true; 1639 1640 /* If in slow start, ensure cwnd grows to twice what was ACKed. */ 1641 if (tcp_in_slow_start(tp)) 1642 return tcp_snd_cwnd(tp) < 2 * tp->max_packets_out; 1643 1644 return false; 1645 } 1646 1647 /* BBR congestion control needs pacing. 1648 * Same remark for SO_MAX_PACING_RATE. 1649 * sch_fq packet scheduler is efficiently handling pacing, 1650 * but is not always installed/used. 1651 * Return true if TCP stack should pace packets itself. 1652 */ 1653 static inline bool tcp_needs_internal_pacing(const struct sock *sk) 1654 { 1655 return smp_load_acquire(&sk->sk_pacing_status) == SK_PACING_NEEDED; 1656 } 1657 1658 /* Estimates in how many jiffies next packet for this flow can be sent. 1659 * Scheduling a retransmit timer too early would be silly. 1660 */ 1661 static inline unsigned long tcp_pacing_delay(const struct sock *sk) 1662 { 1663 s64 delay = tcp_sk(sk)->tcp_wstamp_ns - tcp_sk(sk)->tcp_clock_cache; 1664 1665 return delay > 0 ? nsecs_to_jiffies(delay) : 0; 1666 } 1667 1668 static inline void tcp_reset_xmit_timer(struct sock *sk, 1669 const int what, 1670 unsigned long when, 1671 bool pace_delay) 1672 { 1673 if (pace_delay) 1674 when += tcp_pacing_delay(sk); 1675 inet_csk_reset_xmit_timer(sk, what, when, 1676 tcp_rto_max(sk)); 1677 } 1678 1679 /* Something is really bad, we could not queue an additional packet, 1680 * because qdisc is full or receiver sent a 0 window, or we are paced. 1681 * We do not want to add fuel to the fire, or abort too early, 1682 * so make sure the timer we arm now is at least 200ms in the future, 1683 * regardless of current icsk_rto value (as it could be ~2ms) 1684 */ 1685 static inline unsigned long tcp_probe0_base(const struct sock *sk) 1686 { 1687 return max_t(unsigned long, inet_csk(sk)->icsk_rto, TCP_RTO_MIN); 1688 } 1689 1690 /* Variant of inet_csk_rto_backoff() used for zero window probes */ 1691 static inline unsigned long tcp_probe0_when(const struct sock *sk, 1692 unsigned long max_when) 1693 { 1694 u8 backoff = min_t(u8, ilog2(TCP_RTO_MAX / TCP_RTO_MIN) + 1, 1695 inet_csk(sk)->icsk_backoff); 1696 u64 when = (u64)tcp_probe0_base(sk) << backoff; 1697 1698 return (unsigned long)min_t(u64, when, max_when); 1699 } 1700 1701 static inline void tcp_check_probe_timer(struct sock *sk) 1702 { 1703 if (!tcp_sk(sk)->packets_out && !inet_csk(sk)->icsk_pending) 1704 tcp_reset_xmit_timer(sk, ICSK_TIME_PROBE0, 1705 tcp_probe0_base(sk), true); 1706 } 1707 1708 static inline void tcp_init_wl(struct tcp_sock *tp, u32 seq) 1709 { 1710 tp->snd_wl1 = seq; 1711 } 1712 1713 static inline void tcp_update_wl(struct tcp_sock *tp, u32 seq) 1714 { 1715 tp->snd_wl1 = seq; 1716 } 1717 1718 /* 1719 * Calculate(/check) TCP checksum 1720 */ 1721 static inline __sum16 tcp_v4_check(int len, __be32 saddr, 1722 __be32 daddr, __wsum base) 1723 { 1724 return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_TCP, base); 1725 } 1726 1727 static inline bool tcp_checksum_complete(struct sk_buff *skb) 1728 { 1729 return !skb_csum_unnecessary(skb) && 1730 __skb_checksum_complete(skb); 1731 } 1732 1733 enum skb_drop_reason tcp_add_backlog(struct sock *sk, struct sk_buff *skb); 1734 1735 static inline enum skb_drop_reason 1736 tcp_filter(struct sock *sk, struct sk_buff *skb) 1737 { 1738 const struct tcphdr *th = (const struct tcphdr *)skb->data; 1739 1740 return sk_filter_trim_cap(sk, skb, __tcp_hdrlen(th)); 1741 } 1742 1743 void tcp_set_state(struct sock *sk, int state); 1744 void tcp_done(struct sock *sk); 1745 int tcp_abort(struct sock *sk, int err); 1746 1747 static inline void tcp_sack_reset(struct tcp_options_received *rx_opt) 1748 { 1749 rx_opt->dsack = 0; 1750 rx_opt->num_sacks = 0; 1751 } 1752 1753 void tcp_cwnd_restart(struct sock *sk, s32 delta); 1754 1755 static inline void tcp_slow_start_after_idle_check(struct sock *sk) 1756 { 1757 const struct tcp_congestion_ops *ca_ops = inet_csk(sk)->icsk_ca_ops; 1758 struct tcp_sock *tp = tcp_sk(sk); 1759 s32 delta; 1760 1761 if (!READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_slow_start_after_idle) || 1762 tp->packets_out || ca_ops->cong_control) 1763 return; 1764 delta = tcp_jiffies32 - tp->lsndtime; 1765 if (delta > inet_csk(sk)->icsk_rto) 1766 tcp_cwnd_restart(sk, delta); 1767 } 1768 1769 /* Determine a window scaling and initial window to offer. */ 1770 void tcp_select_initial_window(const struct sock *sk, int __space, 1771 __u32 mss, __u32 *rcv_wnd, 1772 __u32 *window_clamp, int wscale_ok, 1773 __u8 *rcv_wscale, __u32 init_rcv_wnd); 1774 1775 static inline int __tcp_win_from_space(u8 scaling_ratio, int space) 1776 { 1777 s64 scaled_space = (s64)space * scaling_ratio; 1778 1779 return scaled_space >> TCP_RMEM_TO_WIN_SCALE; 1780 } 1781 1782 static inline int tcp_win_from_space(const struct sock *sk, int space) 1783 { 1784 return __tcp_win_from_space(tcp_sk(sk)->scaling_ratio, space); 1785 } 1786 1787 /* inverse of __tcp_win_from_space() */ 1788 static inline int __tcp_space_from_win(u8 scaling_ratio, int win) 1789 { 1790 u64 val = (u64)win << TCP_RMEM_TO_WIN_SCALE; 1791 1792 do_div(val, scaling_ratio); 1793 return val; 1794 } 1795 1796 static inline int tcp_space_from_win(const struct sock *sk, int win) 1797 { 1798 return __tcp_space_from_win(tcp_sk(sk)->scaling_ratio, win); 1799 } 1800 1801 /* Assume a 50% default for skb->len/skb->truesize ratio. 1802 * This may be adjusted later in tcp_measure_rcv_mss(). 1803 */ 1804 #define TCP_DEFAULT_SCALING_RATIO (1 << (TCP_RMEM_TO_WIN_SCALE - 1)) 1805 1806 static inline void tcp_scaling_ratio_init(struct sock *sk) 1807 { 1808 tcp_sk(sk)->scaling_ratio = TCP_DEFAULT_SCALING_RATIO; 1809 } 1810 1811 /* Note: caller must be prepared to deal with negative returns */ 1812 static inline int tcp_space(const struct sock *sk) 1813 { 1814 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - 1815 READ_ONCE(sk->sk_backlog.len) - 1816 atomic_read(&sk->sk_rmem_alloc)); 1817 } 1818 1819 static inline int tcp_full_space(const struct sock *sk) 1820 { 1821 return tcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf)); 1822 } 1823 1824 static inline u32 tcp_dst_advmss(const struct dst_entry *dst) 1825 { 1826 return max_t(u32, dst_metric_advmss(dst), TCP_MIN_MSS); 1827 } 1828 1829 static inline void __tcp_adjust_rcv_ssthresh(struct sock *sk, u32 new_ssthresh) 1830 { 1831 int unused_mem = sk_unused_reserved_mem(sk); 1832 struct tcp_sock *tp = tcp_sk(sk); 1833 1834 tp->rcv_ssthresh = min(tp->rcv_ssthresh, new_ssthresh); 1835 if (unused_mem) 1836 tp->rcv_ssthresh = max_t(u32, tp->rcv_ssthresh, 1837 tcp_win_from_space(sk, unused_mem)); 1838 } 1839 1840 static inline void tcp_adjust_rcv_ssthresh(struct sock *sk) 1841 { 1842 __tcp_adjust_rcv_ssthresh(sk, 4U * tcp_sk(sk)->advmss); 1843 } 1844 1845 void tcp_cleanup_rbuf(struct sock *sk, int copied); 1846 void __tcp_cleanup_rbuf(struct sock *sk, int copied); 1847 1848 1849 /* We provision sk_rcvbuf around 200% of sk_rcvlowat. 1850 * If 87.5 % (7/8) of the space has been consumed, we want to override 1851 * SO_RCVLOWAT constraint, since we are receiving skbs with too small 1852 * len/truesize ratio. 1853 */ 1854 static inline bool tcp_rmem_pressure(const struct sock *sk) 1855 { 1856 int rcvbuf, threshold; 1857 1858 if (tcp_under_memory_pressure(sk)) 1859 return true; 1860 1861 rcvbuf = READ_ONCE(sk->sk_rcvbuf); 1862 threshold = rcvbuf - (rcvbuf >> 3); 1863 1864 return atomic_read(&sk->sk_rmem_alloc) > threshold; 1865 } 1866 1867 static inline bool tcp_epollin_ready(const struct sock *sk, int target) 1868 { 1869 const struct tcp_sock *tp = tcp_sk(sk); 1870 int avail = READ_ONCE(tp->rcv_nxt) - READ_ONCE(tp->copied_seq); 1871 1872 if (avail <= 0) 1873 return false; 1874 1875 return (avail >= target) || tcp_rmem_pressure(sk) || 1876 (tcp_receive_window(tp) <= inet_csk(sk)->icsk_ack.rcv_mss); 1877 } 1878 1879 extern void tcp_openreq_init_rwin(struct request_sock *req, 1880 const struct sock *sk_listener, 1881 const struct dst_entry *dst); 1882 1883 void tcp_enter_memory_pressure(struct sock *sk); 1884 void tcp_leave_memory_pressure(struct sock *sk); 1885 1886 static inline int keepalive_intvl_when(const struct tcp_sock *tp) 1887 { 1888 struct net *net = sock_net((struct sock *)tp); 1889 int val; 1890 1891 /* Paired with WRITE_ONCE() in tcp_sock_set_keepintvl() 1892 * and do_tcp_setsockopt(). 1893 */ 1894 val = READ_ONCE(tp->keepalive_intvl); 1895 1896 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_intvl); 1897 } 1898 1899 static inline int keepalive_time_when(const struct tcp_sock *tp) 1900 { 1901 struct net *net = sock_net((struct sock *)tp); 1902 int val; 1903 1904 /* Paired with WRITE_ONCE() in tcp_sock_set_keepidle_locked() */ 1905 val = READ_ONCE(tp->keepalive_time); 1906 1907 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_time); 1908 } 1909 1910 static inline int keepalive_probes(const struct tcp_sock *tp) 1911 { 1912 struct net *net = sock_net((struct sock *)tp); 1913 int val; 1914 1915 /* Paired with WRITE_ONCE() in tcp_sock_set_keepcnt() 1916 * and do_tcp_setsockopt(). 1917 */ 1918 val = READ_ONCE(tp->keepalive_probes); 1919 1920 return val ? : READ_ONCE(net->ipv4.sysctl_tcp_keepalive_probes); 1921 } 1922 1923 static inline u32 keepalive_time_elapsed(const struct tcp_sock *tp) 1924 { 1925 const struct inet_connection_sock *icsk = &tp->inet_conn; 1926 1927 return min_t(u32, tcp_jiffies32 - icsk->icsk_ack.lrcvtime, 1928 tcp_jiffies32 - tp->rcv_tstamp); 1929 } 1930 1931 static inline int tcp_fin_time(const struct sock *sk) 1932 { 1933 int fin_timeout = tcp_sk(sk)->linger2 ? : 1934 READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_fin_timeout); 1935 const int rto = inet_csk(sk)->icsk_rto; 1936 1937 if (fin_timeout < (rto << 2) - (rto >> 1)) 1938 fin_timeout = (rto << 2) - (rto >> 1); 1939 1940 return fin_timeout; 1941 } 1942 1943 static inline bool tcp_paws_check(const struct tcp_options_received *rx_opt, 1944 int paws_win) 1945 { 1946 if ((s32)(rx_opt->ts_recent - rx_opt->rcv_tsval) <= paws_win) 1947 return true; 1948 if (unlikely(!time_before32(ktime_get_seconds(), 1949 rx_opt->ts_recent_stamp + TCP_PAWS_WRAP))) 1950 return true; 1951 /* 1952 * Some OSes send SYN and SYNACK messages with tsval=0 tsecr=0, 1953 * then following tcp messages have valid values. Ignore 0 value, 1954 * or else 'negative' tsval might forbid us to accept their packets. 1955 */ 1956 if (!rx_opt->ts_recent) 1957 return true; 1958 return false; 1959 } 1960 1961 static inline bool tcp_paws_reject(const struct tcp_options_received *rx_opt, 1962 int rst) 1963 { 1964 if (tcp_paws_check(rx_opt, 0)) 1965 return false; 1966 1967 /* RST segments are not recommended to carry timestamp, 1968 and, if they do, it is recommended to ignore PAWS because 1969 "their cleanup function should take precedence over timestamps." 1970 Certainly, it is mistake. It is necessary to understand the reasons 1971 of this constraint to relax it: if peer reboots, clock may go 1972 out-of-sync and half-open connections will not be reset. 1973 Actually, the problem would be not existing if all 1974 the implementations followed draft about maintaining clock 1975 via reboots. Linux-2.2 DOES NOT! 1976 1977 However, we can relax time bounds for RST segments to MSL. 1978 */ 1979 if (rst && !time_before32(ktime_get_seconds(), 1980 rx_opt->ts_recent_stamp + TCP_PAWS_MSL)) 1981 return false; 1982 return true; 1983 } 1984 1985 static inline void __tcp_fast_path_on(struct tcp_sock *tp, u32 snd_wnd) 1986 { 1987 u32 ace; 1988 1989 /* mptcp hooks are only on the slow path */ 1990 if (sk_is_mptcp((struct sock *)tp)) 1991 return; 1992 1993 ace = tcp_ecn_mode_accecn(tp) ? 1994 ((tp->delivered_ce + TCP_ACCECN_CEP_INIT_OFFSET) & 1995 TCP_ACCECN_CEP_ACE_MASK) : 0; 1996 1997 tp->pred_flags = htonl((tp->tcp_header_len << 26) | 1998 (ace << 22) | 1999 ntohl(TCP_FLAG_ACK) | 2000 snd_wnd); 2001 } 2002 2003 static inline void tcp_fast_path_on(struct tcp_sock *tp) 2004 { 2005 __tcp_fast_path_on(tp, tp->snd_wnd >> tp->rx_opt.snd_wscale); 2006 } 2007 2008 static inline void tcp_fast_path_check(struct sock *sk) 2009 { 2010 struct tcp_sock *tp = tcp_sk(sk); 2011 2012 if (RB_EMPTY_ROOT(&tp->out_of_order_queue) && 2013 tp->rcv_wnd && 2014 atomic_read(&sk->sk_rmem_alloc) < sk->sk_rcvbuf && 2015 !tp->urg_data) 2016 tcp_fast_path_on(tp); 2017 } 2018 2019 bool tcp_oow_rate_limited(struct net *net, const struct sk_buff *skb, 2020 int mib_idx, u32 *last_oow_ack_time); 2021 void tcp_reqsk_send_challenge_ack(struct sock *sk, struct sk_buff *skb, 2022 struct request_sock *req); 2023 2024 static inline void tcp_mib_init(struct net *net) 2025 { 2026 /* See RFC 2012 */ 2027 TCP_ADD_STATS(net, TCP_MIB_RTOALGORITHM, 1); 2028 TCP_ADD_STATS(net, TCP_MIB_RTOMIN, TCP_RTO_MIN*1000/HZ); 2029 TCP_ADD_STATS(net, TCP_MIB_RTOMAX, TCP_RTO_MAX*1000/HZ); 2030 TCP_ADD_STATS(net, TCP_MIB_MAXCONN, -1); 2031 } 2032 2033 /* from STCP */ 2034 static inline void tcp_clear_all_retrans_hints(struct tcp_sock *tp) 2035 { 2036 tp->retransmit_skb_hint = NULL; 2037 } 2038 2039 #define tcp_md5_addr tcp_ao_addr 2040 2041 /* - key database */ 2042 struct tcp_md5sig_key { 2043 struct hlist_node node; 2044 u8 keylen; 2045 u8 family; /* AF_INET or AF_INET6 */ 2046 u8 prefixlen; 2047 u8 flags; 2048 union tcp_md5_addr addr; 2049 int l3index; /* set if key added with L3 scope */ 2050 u8 key[TCP_MD5SIG_MAXKEYLEN]; 2051 struct rcu_head rcu; 2052 }; 2053 2054 /* - sock block */ 2055 struct tcp_md5sig_info { 2056 struct hlist_head head; 2057 struct rcu_head rcu; 2058 }; 2059 2060 /* - pseudo header */ 2061 struct tcp4_pseudohdr { 2062 __be32 saddr; 2063 __be32 daddr; 2064 __u8 pad; 2065 __u8 protocol; 2066 __be16 len; 2067 }; 2068 2069 struct tcp6_pseudohdr { 2070 struct in6_addr saddr; 2071 struct in6_addr daddr; 2072 __be32 len; 2073 __be32 protocol; /* including padding */ 2074 }; 2075 2076 void tcp_v4_md5_hash_skb(char *md5_hash, const struct tcp_md5sig_key *key, 2077 const struct sock *sk, const struct sk_buff *skb); 2078 int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr, 2079 int family, u8 prefixlen, int l3index, u8 flags, 2080 const u8 *newkey, u8 newkeylen); 2081 int tcp_md5_key_copy(struct sock *sk, const union tcp_md5_addr *addr, 2082 int family, u8 prefixlen, int l3index, 2083 struct tcp_md5sig_key *key); 2084 2085 int tcp_md5_do_del(struct sock *sk, const union tcp_md5_addr *addr, 2086 int family, u8 prefixlen, int l3index, u8 flags); 2087 void tcp_clear_md5_list(struct sock *sk); 2088 struct tcp_md5sig_key *tcp_v4_md5_lookup(const struct sock *sk, 2089 const struct sock *addr_sk); 2090 2091 #ifdef CONFIG_TCP_MD5SIG 2092 struct tcp_md5sig_key *__tcp_md5_do_lookup(const struct sock *sk, int l3index, 2093 const union tcp_md5_addr *addr, 2094 int family, bool any_l3index); 2095 static inline struct tcp_md5sig_key * 2096 tcp_md5_do_lookup(const struct sock *sk, int l3index, 2097 const union tcp_md5_addr *addr, int family) 2098 { 2099 if (!static_branch_unlikely(&tcp_md5_needed.key)) 2100 return NULL; 2101 return __tcp_md5_do_lookup(sk, l3index, addr, family, false); 2102 } 2103 2104 static inline struct tcp_md5sig_key * 2105 tcp_md5_do_lookup_any_l3index(const struct sock *sk, 2106 const union tcp_md5_addr *addr, int family) 2107 { 2108 if (!static_branch_unlikely(&tcp_md5_needed.key)) 2109 return NULL; 2110 return __tcp_md5_do_lookup(sk, 0, addr, family, true); 2111 } 2112 2113 #define tcp_twsk_md5_key(twsk) ((twsk)->tw_md5_key) 2114 void tcp_md5_destruct_sock(struct sock *sk); 2115 #else 2116 static inline struct tcp_md5sig_key * 2117 tcp_md5_do_lookup(const struct sock *sk, int l3index, 2118 const union tcp_md5_addr *addr, int family) 2119 { 2120 return NULL; 2121 } 2122 2123 static inline struct tcp_md5sig_key * 2124 tcp_md5_do_lookup_any_l3index(const struct sock *sk, 2125 const union tcp_md5_addr *addr, int family) 2126 { 2127 return NULL; 2128 } 2129 2130 #define tcp_twsk_md5_key(twsk) NULL 2131 static inline void tcp_md5_destruct_sock(struct sock *sk) 2132 { 2133 } 2134 #endif 2135 2136 struct md5_ctx; 2137 void tcp_md5_hash_skb_data(struct md5_ctx *ctx, const struct sk_buff *skb, 2138 unsigned int header_len); 2139 void tcp_md5_hash_key(struct md5_ctx *ctx, const struct tcp_md5sig_key *key); 2140 2141 /* From tcp_fastopen.c */ 2142 void tcp_fastopen_cache_get(struct sock *sk, u16 *mss, 2143 struct tcp_fastopen_cookie *cookie); 2144 void tcp_fastopen_cache_set(struct sock *sk, u16 mss, 2145 struct tcp_fastopen_cookie *cookie, bool syn_lost, 2146 u16 try_exp); 2147 struct tcp_fastopen_request { 2148 /* Fast Open cookie. Size 0 means a cookie request */ 2149 struct tcp_fastopen_cookie cookie; 2150 struct msghdr *data; /* data in MSG_FASTOPEN */ 2151 size_t size; 2152 int copied; /* queued in tcp_connect() */ 2153 struct ubuf_info *uarg; 2154 }; 2155 void tcp_free_fastopen_req(struct tcp_sock *tp); 2156 void tcp_fastopen_destroy_cipher(struct sock *sk); 2157 void tcp_fastopen_ctx_destroy(struct net *net); 2158 int tcp_fastopen_reset_cipher(struct net *net, struct sock *sk, 2159 void *primary_key, void *backup_key); 2160 int tcp_fastopen_get_cipher(struct net *net, struct inet_connection_sock *icsk, 2161 u64 *key); 2162 void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb); 2163 struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb, 2164 struct request_sock *req, 2165 struct tcp_fastopen_cookie *foc, 2166 const struct dst_entry *dst); 2167 void tcp_fastopen_init_key_once(struct net *net); 2168 bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss, 2169 struct tcp_fastopen_cookie *cookie); 2170 bool tcp_fastopen_defer_connect(struct sock *sk, int *err); 2171 #define TCP_FASTOPEN_KEY_LENGTH sizeof(siphash_key_t) 2172 #define TCP_FASTOPEN_KEY_MAX 2 2173 #define TCP_FASTOPEN_KEY_BUF_LENGTH \ 2174 (TCP_FASTOPEN_KEY_LENGTH * TCP_FASTOPEN_KEY_MAX) 2175 2176 /* Fastopen key context */ 2177 struct tcp_fastopen_context { 2178 siphash_key_t key[TCP_FASTOPEN_KEY_MAX]; 2179 int num; 2180 struct rcu_head rcu; 2181 }; 2182 2183 void tcp_fastopen_active_disable(struct sock *sk); 2184 bool tcp_fastopen_active_should_disable(struct sock *sk); 2185 void tcp_fastopen_active_disable_ofo_check(struct sock *sk); 2186 void tcp_fastopen_active_detect_blackhole(struct sock *sk, bool expired); 2187 2188 /* Caller needs to wrap with rcu_read_(un)lock() */ 2189 static inline 2190 struct tcp_fastopen_context *tcp_fastopen_get_ctx(const struct sock *sk) 2191 { 2192 struct tcp_fastopen_context *ctx; 2193 2194 ctx = rcu_dereference(inet_csk(sk)->icsk_accept_queue.fastopenq.ctx); 2195 if (!ctx) 2196 ctx = rcu_dereference(sock_net(sk)->ipv4.tcp_fastopen_ctx); 2197 return ctx; 2198 } 2199 2200 static inline 2201 bool tcp_fastopen_cookie_match(const struct tcp_fastopen_cookie *foc, 2202 const struct tcp_fastopen_cookie *orig) 2203 { 2204 if (orig->len == TCP_FASTOPEN_COOKIE_SIZE && 2205 orig->len == foc->len && 2206 !memcmp(orig->val, foc->val, foc->len)) 2207 return true; 2208 return false; 2209 } 2210 2211 static inline 2212 int tcp_fastopen_context_len(const struct tcp_fastopen_context *ctx) 2213 { 2214 return ctx->num; 2215 } 2216 2217 /* Latencies incurred by various limits for a sender. They are 2218 * chronograph-like stats that are mutually exclusive. 2219 */ 2220 enum tcp_chrono { 2221 TCP_CHRONO_UNSPEC, 2222 TCP_CHRONO_BUSY, /* Actively sending data (non-empty write queue) */ 2223 TCP_CHRONO_RWND_LIMITED, /* Stalled by insufficient receive window */ 2224 TCP_CHRONO_SNDBUF_LIMITED, /* Stalled by insufficient send buffer */ 2225 __TCP_CHRONO_MAX, 2226 }; 2227 2228 static inline void tcp_chrono_set(struct tcp_sock *tp, const enum tcp_chrono new) 2229 { 2230 const u32 now = tcp_jiffies32; 2231 enum tcp_chrono old = tp->chrono_type; 2232 2233 /* Following WRITE_ONCE()s pair with READ_ONCE()s in 2234 * tcp_get_info_chrono_stats(). 2235 */ 2236 if (old > TCP_CHRONO_UNSPEC) 2237 WRITE_ONCE(tp->chrono_stat[old - 1], 2238 tp->chrono_stat[old - 1] + now - tp->chrono_start); 2239 WRITE_ONCE(tp->chrono_start, now); 2240 WRITE_ONCE(tp->chrono_type, new); 2241 } 2242 2243 static inline void tcp_chrono_start(struct sock *sk, const enum tcp_chrono type) 2244 { 2245 struct tcp_sock *tp = tcp_sk(sk); 2246 2247 /* If there are multiple conditions worthy of tracking in a 2248 * chronograph then the highest priority enum takes precedence 2249 * over the other conditions. So that if something "more interesting" 2250 * starts happening, stop the previous chrono and start a new one. 2251 */ 2252 if (type > tp->chrono_type) 2253 tcp_chrono_set(tp, type); 2254 } 2255 2256 void tcp_chrono_stop(struct sock *sk, const enum tcp_chrono type); 2257 2258 /* This helper is needed, because skb->tcp_tsorted_anchor uses 2259 * the same memory storage than skb->destructor/_skb_refdst 2260 */ 2261 static inline void tcp_skb_tsorted_anchor_cleanup(struct sk_buff *skb) 2262 { 2263 skb->destructor = NULL; 2264 skb->_skb_refdst = 0UL; 2265 } 2266 2267 #define tcp_skb_tsorted_save(skb) { \ 2268 unsigned long _save = skb->_skb_refdst; \ 2269 skb->_skb_refdst = 0UL; 2270 2271 #define tcp_skb_tsorted_restore(skb) \ 2272 skb->_skb_refdst = _save; \ 2273 } 2274 2275 void tcp_write_queue_purge(struct sock *sk); 2276 2277 static inline struct sk_buff *tcp_rtx_queue_head(const struct sock *sk) 2278 { 2279 return skb_rb_first(&sk->tcp_rtx_queue); 2280 } 2281 2282 static inline struct sk_buff *tcp_rtx_queue_tail(const struct sock *sk) 2283 { 2284 return skb_rb_last(&sk->tcp_rtx_queue); 2285 } 2286 2287 static inline struct sk_buff *tcp_write_queue_tail(const struct sock *sk) 2288 { 2289 return skb_peek_tail(&sk->sk_write_queue); 2290 } 2291 2292 #define tcp_for_write_queue_from_safe(skb, tmp, sk) \ 2293 skb_queue_walk_from_safe(&(sk)->sk_write_queue, skb, tmp) 2294 2295 static inline struct sk_buff *tcp_send_head(const struct sock *sk) 2296 { 2297 return skb_peek(&sk->sk_write_queue); 2298 } 2299 2300 static inline bool tcp_skb_is_last(const struct sock *sk, 2301 const struct sk_buff *skb) 2302 { 2303 return skb_queue_is_last(&sk->sk_write_queue, skb); 2304 } 2305 2306 /** 2307 * tcp_write_queue_empty - test if any payload (or FIN) is available in write queue 2308 * @sk: socket 2309 * 2310 * Since the write queue can have a temporary empty skb in it, 2311 * we must not use "return skb_queue_empty(&sk->sk_write_queue)" 2312 */ 2313 static inline bool tcp_write_queue_empty(const struct sock *sk) 2314 { 2315 const struct tcp_sock *tp = tcp_sk(sk); 2316 2317 return tp->write_seq == tp->snd_nxt; 2318 } 2319 2320 static inline bool tcp_rtx_queue_empty(const struct sock *sk) 2321 { 2322 return RB_EMPTY_ROOT(&sk->tcp_rtx_queue); 2323 } 2324 2325 static inline bool tcp_rtx_and_write_queues_empty(const struct sock *sk) 2326 { 2327 return tcp_rtx_queue_empty(sk) && tcp_write_queue_empty(sk); 2328 } 2329 2330 static inline void tcp_add_write_queue_tail(struct sock *sk, struct sk_buff *skb) 2331 { 2332 __skb_queue_tail(&sk->sk_write_queue, skb); 2333 2334 /* Queue it, remembering where we must start sending. */ 2335 if (sk->sk_write_queue.next == skb) 2336 tcp_chrono_start(sk, TCP_CHRONO_BUSY); 2337 } 2338 2339 /* Insert new before skb on the write queue of sk. */ 2340 static inline void tcp_insert_write_queue_before(struct sk_buff *new, 2341 struct sk_buff *skb, 2342 struct sock *sk) 2343 { 2344 __skb_queue_before(&sk->sk_write_queue, skb, new); 2345 } 2346 2347 static inline void tcp_unlink_write_queue(struct sk_buff *skb, struct sock *sk) 2348 { 2349 tcp_skb_tsorted_anchor_cleanup(skb); 2350 __skb_unlink(skb, &sk->sk_write_queue); 2351 } 2352 2353 void tcp_rbtree_insert(struct rb_root *root, struct sk_buff *skb); 2354 2355 static inline void tcp_rtx_queue_unlink(struct sk_buff *skb, struct sock *sk) 2356 { 2357 tcp_skb_tsorted_anchor_cleanup(skb); 2358 rb_erase(&skb->rbnode, &sk->tcp_rtx_queue); 2359 } 2360 2361 static inline void tcp_rtx_queue_unlink_and_free(struct sk_buff *skb, struct sock *sk) 2362 { 2363 list_del(&skb->tcp_tsorted_anchor); 2364 tcp_rtx_queue_unlink(skb, sk); 2365 tcp_wmem_free_skb(sk, skb); 2366 } 2367 2368 static inline void tcp_write_collapse_fence(struct sock *sk) 2369 { 2370 struct sk_buff *skb = tcp_write_queue_tail(sk) ?: tcp_rtx_queue_tail(sk); 2371 2372 if (skb) 2373 TCP_SKB_CB(skb)->eor = 1; 2374 } 2375 2376 static inline void tcp_push_pending_frames(struct sock *sk) 2377 { 2378 if (tcp_send_head(sk)) { 2379 struct tcp_sock *tp = tcp_sk(sk); 2380 2381 __tcp_push_pending_frames(sk, tcp_current_mss(sk), tp->nonagle); 2382 } 2383 } 2384 2385 /* Start sequence of the skb just after the highest skb with SACKed 2386 * bit, valid only if sacked_out > 0 or when the caller has ensured 2387 * validity by itself. 2388 */ 2389 static inline u32 tcp_highest_sack_seq(struct tcp_sock *tp) 2390 { 2391 if (!tp->sacked_out) 2392 return tp->snd_una; 2393 2394 if (tp->highest_sack == NULL) 2395 return tp->snd_nxt; 2396 2397 return TCP_SKB_CB(tp->highest_sack)->seq; 2398 } 2399 2400 static inline void tcp_advance_highest_sack(struct sock *sk, struct sk_buff *skb) 2401 { 2402 tcp_sk(sk)->highest_sack = skb_rb_next(skb); 2403 } 2404 2405 static inline struct sk_buff *tcp_highest_sack(struct sock *sk) 2406 { 2407 return tcp_sk(sk)->highest_sack; 2408 } 2409 2410 static inline void tcp_highest_sack_reset(struct sock *sk) 2411 { 2412 tcp_sk(sk)->highest_sack = tcp_rtx_queue_head(sk); 2413 } 2414 2415 /* Called when old skb is about to be deleted and replaced by new skb */ 2416 static inline void tcp_highest_sack_replace(struct sock *sk, 2417 struct sk_buff *old, 2418 struct sk_buff *new) 2419 { 2420 if (old == tcp_highest_sack(sk)) 2421 tcp_sk(sk)->highest_sack = new; 2422 } 2423 2424 /* This helper checks if socket has IP_TRANSPARENT set */ 2425 static inline bool inet_sk_transparent(const struct sock *sk) 2426 { 2427 switch (sk->sk_state) { 2428 case TCP_TIME_WAIT: 2429 return inet_twsk(sk)->tw_transparent; 2430 case TCP_NEW_SYN_RECV: 2431 return inet_rsk(inet_reqsk(sk))->no_srccheck; 2432 } 2433 return inet_test_bit(TRANSPARENT, sk); 2434 } 2435 2436 /* Determines whether this is a thin stream (which may suffer from 2437 * increased latency). Used to trigger latency-reducing mechanisms. 2438 */ 2439 static inline bool tcp_stream_is_thin(struct tcp_sock *tp) 2440 { 2441 return tp->packets_out < 4 && !tcp_in_initial_slowstart(tp); 2442 } 2443 2444 /* /proc */ 2445 enum tcp_seq_states { 2446 TCP_SEQ_STATE_LISTENING, 2447 TCP_SEQ_STATE_ESTABLISHED, 2448 }; 2449 2450 void *tcp_seq_start(struct seq_file *seq, loff_t *pos); 2451 void *tcp_seq_next(struct seq_file *seq, void *v, loff_t *pos); 2452 void tcp_seq_stop(struct seq_file *seq, void *v); 2453 2454 struct tcp_seq_afinfo { 2455 sa_family_t family; 2456 }; 2457 2458 struct tcp_iter_state { 2459 struct seq_net_private p; 2460 enum tcp_seq_states state; 2461 struct sock *syn_wait_sk; 2462 int bucket, offset, sbucket, num; 2463 loff_t last_pos; 2464 }; 2465 2466 extern struct request_sock_ops tcp_request_sock_ops; 2467 extern struct request_sock_ops tcp6_request_sock_ops; 2468 2469 void tcp_v4_destroy_sock(struct sock *sk); 2470 2471 struct sk_buff *tcp_gso_segment(struct sk_buff *skb, 2472 netdev_features_t features); 2473 struct sk_buff *tcp_gro_lookup(struct list_head *head, struct tcphdr *th); 2474 struct sk_buff *tcp_gro_receive(struct list_head *head, struct sk_buff *skb, 2475 struct tcphdr *th); 2476 INDIRECT_CALLABLE_DECLARE(int tcp4_gro_complete(struct sk_buff *skb, int thoff)); 2477 INDIRECT_CALLABLE_DECLARE(struct sk_buff *tcp4_gro_receive(struct list_head *head, struct sk_buff *skb)); 2478 #ifdef CONFIG_INET 2479 void tcp_gro_complete(struct sk_buff *skb); 2480 #else 2481 static inline void tcp_gro_complete(struct sk_buff *skb) { } 2482 #endif 2483 2484 static inline void __tcp_v4_send_check(struct sk_buff *skb, __be32 saddr, 2485 __be32 daddr) 2486 { 2487 struct tcphdr *th = tcp_hdr(skb); 2488 2489 th->check = ~tcp_v4_check(skb->len, saddr, daddr, 0); 2490 skb->csum_start = skb_transport_header(skb) - skb->head; 2491 skb->csum_offset = offsetof(struct tcphdr, check); 2492 } 2493 2494 static inline u32 tcp_notsent_lowat(const struct tcp_sock *tp) 2495 { 2496 struct net *net = sock_net((struct sock *)tp); 2497 u32 val; 2498 2499 val = READ_ONCE(tp->notsent_lowat); 2500 2501 return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat); 2502 } 2503 2504 bool tcp_stream_memory_free(const struct sock *sk, int wake); 2505 2506 #ifdef CONFIG_PROC_FS 2507 int tcp4_proc_init(void); 2508 void tcp4_proc_exit(void); 2509 #endif 2510 2511 int tcp_rtx_synack(const struct sock *sk, struct request_sock *req); 2512 int tcp_conn_request(struct request_sock_ops *rsk_ops, 2513 const struct tcp_request_sock_ops *af_ops, 2514 struct sock *sk, struct sk_buff *skb); 2515 2516 /* TCP af-specific functions */ 2517 struct tcp_sock_af_ops { 2518 #ifdef CONFIG_TCP_MD5SIG 2519 struct tcp_md5sig_key *(*md5_lookup) (const struct sock *sk, 2520 const struct sock *addr_sk); 2521 void (*calc_md5_hash)(char *location, 2522 const struct tcp_md5sig_key *md5, 2523 const struct sock *sk, 2524 const struct sk_buff *skb); 2525 int (*md5_parse)(struct sock *sk, 2526 int optname, 2527 sockptr_t optval, 2528 int optlen); 2529 #endif 2530 #ifdef CONFIG_TCP_AO 2531 int (*ao_parse)(struct sock *sk, int optname, sockptr_t optval, int optlen); 2532 struct tcp_ao_key *(*ao_lookup)(const struct sock *sk, 2533 struct sock *addr_sk, 2534 int sndid, int rcvid); 2535 void (*ao_calc_key_sk)(struct tcp_ao_key *mkt, u8 *key, 2536 const struct sock *sk, 2537 __be32 sisn, __be32 disn, bool send); 2538 int (*calc_ao_hash)(char *location, struct tcp_ao_key *ao, 2539 const struct sock *sk, const struct sk_buff *skb, 2540 const u8 *tkey, int hash_offset, u32 sne); 2541 #endif 2542 }; 2543 2544 struct tcp_request_sock_ops { 2545 u16 mss_clamp; 2546 #ifdef CONFIG_TCP_MD5SIG 2547 struct tcp_md5sig_key *(*req_md5_lookup)(const struct sock *sk, 2548 const struct sock *addr_sk); 2549 void (*calc_md5_hash) (char *location, 2550 const struct tcp_md5sig_key *md5, 2551 const struct sock *sk, 2552 const struct sk_buff *skb); 2553 #endif 2554 #ifdef CONFIG_TCP_AO 2555 struct tcp_ao_key *(*ao_lookup)(const struct sock *sk, 2556 struct request_sock *req, 2557 int sndid, int rcvid); 2558 void (*ao_calc_key)(struct tcp_ao_key *mkt, u8 *key, struct request_sock *sk); 2559 int (*ao_synack_hash)(char *ao_hash, struct tcp_ao_key *mkt, 2560 struct request_sock *req, const struct sk_buff *skb, 2561 int hash_offset, u32 sne); 2562 #endif 2563 #ifdef CONFIG_SYN_COOKIES 2564 __u32 (*cookie_init_seq)(const struct sk_buff *skb, 2565 __u16 *mss); 2566 #endif 2567 struct dst_entry *(*route_req)(const struct sock *sk, 2568 struct sk_buff *skb, 2569 struct flowi *fl, 2570 struct request_sock *req, 2571 u32 tw_isn); 2572 union tcp_seq_and_ts_off (*init_seq_and_ts_off)( 2573 const struct net *net, 2574 const struct sk_buff *skb); 2575 int (*send_synack)(const struct sock *sk, struct dst_entry *dst, 2576 struct flowi *fl, struct request_sock *req, 2577 struct tcp_fastopen_cookie *foc, 2578 enum tcp_synack_type synack_type, 2579 struct sk_buff *syn_skb); 2580 }; 2581 2582 extern const struct tcp_request_sock_ops tcp_request_sock_ipv4_ops; 2583 #if IS_ENABLED(CONFIG_IPV6) 2584 extern const struct tcp_request_sock_ops tcp_request_sock_ipv6_ops; 2585 #endif 2586 2587 #ifdef CONFIG_SYN_COOKIES 2588 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops, 2589 struct sk_buff *skb, __u16 *mss) 2590 { 2591 return ops->cookie_init_seq(skb, mss); 2592 } 2593 #else 2594 static inline __u32 cookie_init_sequence(const struct tcp_request_sock_ops *ops, 2595 struct sk_buff *skb, __u16 *mss) 2596 { 2597 return 0; 2598 } 2599 #endif 2600 2601 #ifdef CONFIG_SYN_COOKIES 2602 static inline void cookie_record_sent(const struct sock *sk) 2603 { 2604 tcp_synq_overflow(sk); 2605 __NET_INC_STATS(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT); 2606 } 2607 #else 2608 static inline void cookie_record_sent(const struct sock *sk) 2609 { 2610 } 2611 #endif 2612 2613 struct tcp_key { 2614 union { 2615 struct { 2616 struct tcp_ao_key *ao_key; 2617 char *traffic_key; 2618 u32 sne; 2619 u8 rcv_next; 2620 }; 2621 struct tcp_md5sig_key *md5_key; 2622 }; 2623 enum { 2624 TCP_KEY_NONE = 0, 2625 TCP_KEY_MD5, 2626 TCP_KEY_AO, 2627 } type; 2628 }; 2629 2630 static inline void tcp_get_current_key(const struct sock *sk, 2631 struct tcp_key *out) 2632 { 2633 #if defined(CONFIG_TCP_AO) || defined(CONFIG_TCP_MD5SIG) 2634 const struct tcp_sock *tp = tcp_sk(sk); 2635 #endif 2636 2637 #ifdef CONFIG_TCP_AO 2638 if (static_branch_unlikely(&tcp_ao_needed.key)) { 2639 struct tcp_ao_info *ao; 2640 2641 ao = rcu_dereference_protected(tp->ao_info, 2642 lockdep_sock_is_held(sk)); 2643 if (ao) { 2644 out->ao_key = READ_ONCE(ao->current_key); 2645 out->type = TCP_KEY_AO; 2646 return; 2647 } 2648 } 2649 #endif 2650 #ifdef CONFIG_TCP_MD5SIG 2651 if (static_branch_unlikely(&tcp_md5_needed.key) && 2652 rcu_access_pointer(tp->md5sig_info)) { 2653 out->md5_key = tp->af_specific->md5_lookup(sk, sk); 2654 if (out->md5_key) { 2655 out->type = TCP_KEY_MD5; 2656 return; 2657 } 2658 } 2659 #endif 2660 out->type = TCP_KEY_NONE; 2661 } 2662 2663 static inline bool tcp_key_is_md5(const struct tcp_key *key) 2664 { 2665 if (static_branch_tcp_md5()) 2666 return key->type == TCP_KEY_MD5; 2667 return false; 2668 } 2669 2670 static inline bool tcp_key_is_ao(const struct tcp_key *key) 2671 { 2672 if (static_branch_tcp_ao()) 2673 return key->type == TCP_KEY_AO; 2674 return false; 2675 } 2676 2677 int tcpv4_offload_init(void); 2678 2679 void tcp_v4_init(void); 2680 void tcp_init(void); 2681 2682 /* tcp_recovery.c */ 2683 void tcp_mark_skb_lost(struct sock *sk, struct sk_buff *skb); 2684 void tcp_newreno_mark_lost(struct sock *sk, bool snd_una_advanced); 2685 extern s32 tcp_rack_skb_timeout(struct tcp_sock *tp, struct sk_buff *skb, 2686 u32 reo_wnd); 2687 extern bool tcp_rack_mark_lost(struct sock *sk); 2688 extern void tcp_rack_reo_timeout(struct sock *sk); 2689 2690 /* tcp_plb.c */ 2691 2692 /* 2693 * Scaling factor for fractions in PLB. For example, tcp_plb_update_state 2694 * expects cong_ratio which represents fraction of traffic that experienced 2695 * congestion over a single RTT. In order to avoid floating point operations, 2696 * this fraction should be mapped to (1 << TCP_PLB_SCALE) and passed in. 2697 */ 2698 #define TCP_PLB_SCALE 8 2699 2700 /* State for PLB (Protective Load Balancing) for a single TCP connection. */ 2701 struct tcp_plb_state { 2702 u8 consec_cong_rounds:5, /* consecutive congested rounds */ 2703 unused:3; 2704 u32 pause_until; /* jiffies32 when PLB can resume rerouting */ 2705 }; 2706 2707 static inline void tcp_plb_init(const struct sock *sk, 2708 struct tcp_plb_state *plb) 2709 { 2710 plb->consec_cong_rounds = 0; 2711 plb->pause_until = 0; 2712 } 2713 void tcp_plb_update_state(const struct sock *sk, struct tcp_plb_state *plb, 2714 const int cong_ratio); 2715 void tcp_plb_check_rehash(struct sock *sk, struct tcp_plb_state *plb); 2716 void tcp_plb_update_state_upon_rto(struct sock *sk, struct tcp_plb_state *plb); 2717 2718 static inline void tcp_warn_once(const struct sock *sk, bool cond, const char *str) 2719 { 2720 WARN_ONCE(cond, 2721 "%scwn:%u out:%u sacked:%u lost:%u retrans:%u tlp_high_seq:%u sk_state:%u ca_state:%u advmss:%u mss_cache:%u pmtu:%u\n", 2722 str, 2723 tcp_snd_cwnd(tcp_sk(sk)), 2724 tcp_sk(sk)->packets_out, tcp_sk(sk)->sacked_out, 2725 tcp_sk(sk)->lost_out, tcp_sk(sk)->retrans_out, 2726 tcp_sk(sk)->tlp_high_seq, sk->sk_state, 2727 inet_csk(sk)->icsk_ca_state, 2728 tcp_sk(sk)->advmss, tcp_sk(sk)->mss_cache, 2729 inet_csk(sk)->icsk_pmtu_cookie); 2730 } 2731 2732 /* At how many usecs into the future should the RTO fire? */ 2733 static inline s64 tcp_rto_delta_us(const struct sock *sk) 2734 { 2735 const struct sk_buff *skb = tcp_rtx_queue_head(sk); 2736 u32 rto = inet_csk(sk)->icsk_rto; 2737 2738 if (likely(skb)) { 2739 u64 rto_time_stamp_us = tcp_skb_timestamp_us(skb) + jiffies_to_usecs(rto); 2740 2741 return rto_time_stamp_us - tcp_sk(sk)->tcp_mstamp; 2742 } else { 2743 tcp_warn_once(sk, 1, "rtx queue empty: "); 2744 return jiffies_to_usecs(rto); 2745 } 2746 2747 } 2748 2749 /* 2750 * Save and compile IPv4 options, return a pointer to it 2751 */ 2752 static inline struct ip_options_rcu *tcp_v4_save_options(struct net *net, 2753 struct sk_buff *skb) 2754 { 2755 const struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt; 2756 struct ip_options_rcu *dopt = NULL; 2757 2758 if (opt->optlen) { 2759 int opt_size = sizeof(*dopt) + opt->optlen; 2760 2761 dopt = kmalloc(opt_size, GFP_ATOMIC); 2762 if (dopt && __ip_options_echo(net, &dopt->opt, skb, opt)) { 2763 kfree(dopt); 2764 dopt = NULL; 2765 } 2766 } 2767 return dopt; 2768 } 2769 2770 /* locally generated TCP pure ACKs have skb->truesize == 2 2771 * (check tcp_send_ack() in net/ipv4/tcp_output.c ) 2772 * This is much faster than dissecting the packet to find out. 2773 * (Think of GRE encapsulations, IPv4, IPv6, ...) 2774 */ 2775 static inline bool skb_is_tcp_pure_ack(const struct sk_buff *skb) 2776 { 2777 return skb->truesize == 2; 2778 } 2779 2780 static inline void skb_set_tcp_pure_ack(struct sk_buff *skb) 2781 { 2782 skb->truesize = 2; 2783 } 2784 2785 static inline int tcp_inq(struct sock *sk) 2786 { 2787 struct tcp_sock *tp = tcp_sk(sk); 2788 int answ; 2789 2790 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV)) { 2791 answ = 0; 2792 } else if (sock_flag(sk, SOCK_URGINLINE) || 2793 !tp->urg_data || 2794 before(tp->urg_seq, tp->copied_seq) || 2795 !before(tp->urg_seq, tp->rcv_nxt)) { 2796 2797 answ = tp->rcv_nxt - tp->copied_seq; 2798 2799 /* Subtract 1, if FIN was received */ 2800 if (answ && sock_flag(sk, SOCK_DONE)) 2801 answ--; 2802 } else { 2803 answ = tp->urg_seq - tp->copied_seq; 2804 } 2805 2806 return answ; 2807 } 2808 2809 int tcp_peek_len(struct socket *sock); 2810 2811 static inline void tcp_segs_in(struct tcp_sock *tp, const struct sk_buff *skb) 2812 { 2813 u16 segs_in; 2814 2815 segs_in = max_t(u16, 1, skb_shinfo(skb)->gso_segs); 2816 2817 /* We update these fields while other threads might 2818 * read them from tcp_get_info() 2819 */ 2820 WRITE_ONCE(tp->segs_in, tp->segs_in + segs_in); 2821 if (skb->len > tcp_hdrlen(skb)) 2822 WRITE_ONCE(tp->data_segs_in, tp->data_segs_in + segs_in); 2823 } 2824 2825 /* 2826 * TCP listen path runs lockless. 2827 * We forced "struct sock" to be const qualified to make sure 2828 * we don't modify one of its field by mistake. 2829 * Here, we increment sk_drops which is an atomic_t, so we can safely 2830 * make sock writable again. 2831 */ 2832 static inline void tcp_listendrop(const struct sock *sk) 2833 { 2834 sk_drops_inc((struct sock *)sk); 2835 __NET_INC_STATS(sock_net(sk), LINUX_MIB_LISTENDROPS); 2836 } 2837 2838 enum hrtimer_restart tcp_pace_kick(struct hrtimer *timer); 2839 2840 /* 2841 * Interface for adding Upper Level Protocols over TCP 2842 */ 2843 2844 #define TCP_ULP_NAME_MAX 16 2845 #define TCP_ULP_MAX 128 2846 #define TCP_ULP_BUF_MAX (TCP_ULP_NAME_MAX*TCP_ULP_MAX) 2847 2848 struct tcp_ulp_ops { 2849 struct list_head list; 2850 2851 /* initialize ulp */ 2852 int (*init)(struct sock *sk); 2853 /* update ulp */ 2854 void (*update)(struct sock *sk, struct proto *p, 2855 void (*write_space)(struct sock *sk)); 2856 /* cleanup ulp */ 2857 void (*release)(struct sock *sk); 2858 /* diagnostic */ 2859 int (*get_info)(struct sock *sk, struct sk_buff *skb, bool net_admin); 2860 size_t (*get_info_size)(const struct sock *sk, bool net_admin); 2861 /* clone ulp */ 2862 void (*clone)(const struct request_sock *req, struct sock *newsk, 2863 const gfp_t priority); 2864 2865 char name[TCP_ULP_NAME_MAX]; 2866 struct module *owner; 2867 }; 2868 int tcp_register_ulp(struct tcp_ulp_ops *type); 2869 void tcp_unregister_ulp(struct tcp_ulp_ops *type); 2870 int tcp_set_ulp(struct sock *sk, const char *name); 2871 void tcp_get_available_ulp(char *buf, size_t len); 2872 void tcp_cleanup_ulp(struct sock *sk); 2873 void tcp_update_ulp(struct sock *sk, struct proto *p, 2874 void (*write_space)(struct sock *sk)); 2875 2876 #define MODULE_ALIAS_TCP_ULP(name) \ 2877 MODULE_INFO(alias, name); \ 2878 MODULE_INFO(alias, "tcp-ulp-" name) 2879 2880 #ifdef CONFIG_NET_SOCK_MSG 2881 struct sk_msg; 2882 struct sk_psock; 2883 2884 #ifdef CONFIG_BPF_SYSCALL 2885 int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore); 2886 void tcp_bpf_clone(const struct sock *sk, struct sock *newsk); 2887 #ifdef CONFIG_BPF_STREAM_PARSER 2888 struct strparser; 2889 int tcp_bpf_strp_read_sock(struct strparser *strp, read_descriptor_t *desc, 2890 sk_read_actor_t recv_actor); 2891 #endif /* CONFIG_BPF_STREAM_PARSER */ 2892 #endif /* CONFIG_BPF_SYSCALL */ 2893 2894 #ifdef CONFIG_INET 2895 void tcp_eat_skb(struct sock *sk, struct sk_buff *skb); 2896 #else 2897 static inline void tcp_eat_skb(struct sock *sk, struct sk_buff *skb) 2898 { 2899 } 2900 #endif 2901 2902 int tcp_bpf_sendmsg_redir(struct sock *sk, bool ingress, 2903 struct sk_msg *msg, u32 bytes, int flags); 2904 #endif /* CONFIG_NET_SOCK_MSG */ 2905 2906 #if !defined(CONFIG_BPF_SYSCALL) || !defined(CONFIG_NET_SOCK_MSG) 2907 static inline void tcp_bpf_clone(const struct sock *sk, struct sock *newsk) 2908 { 2909 } 2910 #endif 2911 2912 #ifdef CONFIG_CGROUP_BPF 2913 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops, 2914 struct sk_buff *skb, 2915 unsigned int end_offset) 2916 { 2917 skops->skb = skb; 2918 skops->skb_data_end = skb->data + end_offset; 2919 } 2920 #else 2921 static inline void bpf_skops_init_skb(struct bpf_sock_ops_kern *skops, 2922 struct sk_buff *skb, 2923 unsigned int end_offset) 2924 { 2925 } 2926 #endif 2927 2928 /* Call BPF_SOCK_OPS program that returns an int. If the return value 2929 * is < 0, then the BPF op failed (for example if the loaded BPF 2930 * program does not support the chosen operation or there is no BPF 2931 * program loaded). 2932 */ 2933 #ifdef CONFIG_BPF 2934 static inline int __tcp_call_bpf(struct sock *sk, int op, u32 nargs, u32 *args) 2935 { 2936 struct bpf_sock_ops_kern sock_ops; 2937 int ret; 2938 2939 memset(&sock_ops, 0, offsetof(struct bpf_sock_ops_kern, temp)); 2940 if (sk_fullsock(sk)) { 2941 sock_ops.is_fullsock = 1; 2942 sock_ops.is_locked_tcp_sock = 1; 2943 sock_owned_by_me(sk); 2944 } 2945 2946 sock_ops.sk = sk; 2947 sock_ops.op = op; 2948 if (nargs > 0) 2949 memcpy(sock_ops.args, args, nargs * sizeof(*args)); 2950 2951 ret = __BPF_CGROUP_RUN_PROG_SOCK_OPS(&sock_ops); 2952 if (ret == 0) 2953 ret = sock_ops.reply; 2954 else 2955 ret = -1; 2956 return ret; 2957 } 2958 2959 #define tcp_call_bpf(sk, op) \ 2960 ({ \ 2961 int __ret = 0; \ 2962 if (cgroup_bpf_enabled(CGROUP_SOCK_OPS)) { \ 2963 __ret = __tcp_call_bpf(sk, op, 0, NULL); \ 2964 } \ 2965 __ret; \ 2966 }) 2967 2968 #define tcp_call_bpf_flag(sk, op, ...) \ 2969 do { \ 2970 if (cgroup_bpf_enabled(CGROUP_SOCK_OPS) && \ 2971 BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), op ## _FLAG)) { \ 2972 u32 __args[] = { __VA_ARGS__ }; \ 2973 __tcp_call_bpf(sk, op, ARRAY_SIZE(__args), __args); \ 2974 } \ 2975 } while (0) 2976 2977 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk) 2978 { 2979 tcp_sk(sk)->bpf_sock_ops_cb_flags = 0; 2980 WRITE_ONCE(tcp_sk(sk)->bpf_tcp_ops_flags, 0); 2981 } 2982 2983 #else 2984 static inline int tcp_call_bpf(struct sock *sk, int op) 2985 { 2986 return -EPERM; 2987 } 2988 2989 #define tcp_call_bpf_flag(sk, op, ...) do { } while (0) 2990 2991 static inline void tcp_clear_sock_ops_cb_flags(struct sock *sk) 2992 { 2993 } 2994 2995 #endif 2996 2997 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_CGROUP_BPF) 2998 2999 struct bpf_tcp_ops { 3000 /* Should return the initial SYN (active open) or SYN-ACK (passive open) 3001 * retransmission timeout. Return the timeout in jiffies, or <= 0 for 3002 * the kernel default. 3003 * 3004 * @req: request_sock on the passive (synack) path; NULL otherwise. 3005 */ 3006 int (*timeout_init)(struct sock *sk, struct request_sock *req); 3007 3008 /* Should return the initial advertised receive window, in packets, 3009 * or < 0 for the kernel default. @req as in timeout_init(). 3010 */ 3011 int (*rwnd_init)(struct sock *sk, struct request_sock *req); 3012 3013 /* Called when an active connection becomes established. 3014 * @skb is the SYNACK that completed the 3WHS, or NULL for a 3015 * TCP_REPAIR socket (tcp_finish_connect() with no skb). 3016 */ 3017 void (*active_established)(struct sock *sk, struct sk_buff *skb__nullable); 3018 3019 /* Called when a passive connection becomes established. 3020 * @skb is the ACK that completed the 3WHS. 3021 */ 3022 void (*passive_established)(struct sock *sk, struct sk_buff *skb); 3023 3024 /* Called when the retransmission timer fires. */ 3025 void (*rto)(struct sock *sk); 3026 3027 /* Called on every RTT sample if BPF_TCP_OPS_FLAG_RTT is enabled. 3028 * @mrtt: the measured RTT, in microseconds. 3029 * @srtt: the updated smoothed RTT. 3030 */ 3031 void (*rtt)(struct sock *sk, long mrtt, u32 srtt); 3032 3033 /* Called when the connection changes TCP state. 3034 * @state: the new state (one of the TCP_* states). 3035 */ 3036 void (*set_state)(struct sock *sk, int state); 3037 3038 /* Called when an skb is retransmitted. 3039 * @skb: the retransmitted skb. 3040 * @err: tcp_transmit_skb() return value (0 on success). 3041 */ 3042 void (*retrans)(struct sock *sk, struct sk_buff *skb, int err); 3043 3044 /* Called right before an active connection is initialized. */ 3045 void (*connect)(struct sock *sk); 3046 3047 /* Called on listen(2), right after the socket enters TCP_LISTEN. */ 3048 void (*listen)(struct sock *sk); 3049 3050 /* 3051 * Parse the TCP header options of an incoming skb received on an 3052 * established connection. Use bpf_dynptr_from_skb()/bpf_skb_load_bytes() 3053 * to access the options. 3054 * 3055 * Called if BPF_TCP_OPS_FLAG_PARSE_HDR_OPT_ALL is enabled, or if 3056 * BPF_TCP_OPS_FLAG_PARSE_HDR_OPT_UNKNOWN is enabled and an unknown 3057 * option is received. 3058 */ 3059 void (*parse_hdr)(struct sock *sk, struct sk_buff *skb); 3060 3061 /* 3062 * Reserve space in the outgoing TCP header for options to be written 3063 * later by write_hdr_opt(). Call bpf_reserve_hdr_opt() to reserve bytes. 3064 * 3065 * Called if BPF_TCP_OPS_FLAG_WRITE_HDR_OPT is enabled. 3066 * 3067 * @skb: outgoing packet. NULL when called from tcp_current_mss() 3068 * (MSS sizing). 3069 * @req: request_sock on the synack path; NULL otherwise. 3070 * @syn_skb: incoming SYN on the synack path; NULL otherwise. 3071 * @synack_type: TCP_SYNACK_COOKIE indicates a stateless syncookie. 3072 * @remaining: pointer to the size of space still available; cast it 3073 * using bpf_rdonly_cast() before dereferencing. 3074 */ 3075 void (*hdr_opt_len)(struct sock *sk, struct sk_buff *skb, 3076 struct request_sock *req, struct sk_buff *syn_skb, 3077 enum tcp_synack_type synack_type, 3078 unsigned int *remaining); 3079 3080 /* 3081 * Write header options into the space reserved earlier by hdr_opt_len(). 3082 * Use bpf_store_hdr_opt() to write; it appends within the reserved window 3083 * shared with legacy SOCKOPS. 3084 * 3085 * Called if BPF_TCP_OPS_FLAG_WRITE_HDR_OPT is enabled. 3086 * 3087 * @skb: outgoing packet. 3088 * @req: request_sock on the synack path; NULL otherwise. 3089 * @syn_skb: incoming SYN on the synack path; NULL otherwise. 3090 * @synack_type: TCP_SYNACK_COOKIE indicates a stateless syncookie. 3091 * @opt_off: offset in the outgoing @skb's TCP header where the 3092 * bpf_tcp_ops portion of the reserved window begins, i.e. after 3093 * the kernel and legacy options. 3094 */ 3095 void (*write_hdr_opt)(struct sock *sk, struct sk_buff *skb, 3096 struct request_sock *req, struct sk_buff *syn_skb, 3097 enum tcp_synack_type synack_type, 3098 u32 opt_off); 3099 3100 /* 3101 * Called when an incoming skb is enqueued to sk->sk_receive_queue 3102 * if BPF_TCP_OPS_FLAG_RCVQ is enabled. 3103 */ 3104 void (*enqueue_rcvq)(struct sock *sk, struct sk_buff *skb); 3105 3106 /* 3107 * Called after data is dequeued from sk->sk_receive_queue 3108 * if BPF_TCP_OPS_FLAG_RCVQ is enabled. 3109 */ 3110 void (*dequeue_rcvq)(struct sock *sk); 3111 }; 3112 3113 #define __bpf_tcp_ops_call(op, sk, ...) \ 3114 do { \ 3115 const struct bpf_prog_array_item *item; \ 3116 const struct bpf_tcp_ops *tcp_ops; \ 3117 struct cgroup *cgrp; \ 3118 \ 3119 cgrp = sock_cgroup_ptr(&sk->sk_cgrp_data); \ 3120 rcu_read_lock_dont_migrate(); \ 3121 bpf_cgroup_struct_ops_foreach(tcp_ops, item, cgrp, \ 3122 CGROUP_TCP_SOCK_OPS) { \ 3123 if (tcp_ops->op) \ 3124 tcp_ops->op(sk, ##__VA_ARGS__); \ 3125 } \ 3126 rcu_read_unlock_migrate(); \ 3127 } while (0) 3128 3129 #define bpf_tcp_ops_call(op, sk, ...) \ 3130 do { \ 3131 if (cgroup_bpf_enabled(CGROUP_TCP_SOCK_OPS)) \ 3132 __bpf_tcp_ops_call(op, sk, ##__VA_ARGS__); \ 3133 } while (0) 3134 3135 #define bpf_tcp_ops_call_flag(op, flag, sk, ...) \ 3136 do { \ 3137 if (cgroup_bpf_enabled(CGROUP_TCP_SOCK_OPS) && \ 3138 BPF_TCP_OPS_TEST_FLAG(tcp_sk(sk), flag)) \ 3139 __bpf_tcp_ops_call(op, sk, ##__VA_ARGS__); \ 3140 } while (0) 3141 3142 #define bpf_tcp_ops_call_int(op, init_retval, sk, ...) \ 3143 ({ \ 3144 int __retval = (init_retval); \ 3145 if (cgroup_bpf_enabled(CGROUP_TCP_SOCK_OPS)) { \ 3146 const struct bpf_prog_array_item *item; \ 3147 const struct bpf_tcp_ops *tcp_ops; \ 3148 struct bpf_tramp_run_ctx run_ctx; \ 3149 struct bpf_run_ctx *old_run_ctx; \ 3150 struct sock *__sk = sk_to_full_sk(sk); \ 3151 struct request_sock *req = NULL; \ 3152 struct cgroup *cgrp; \ 3153 \ 3154 if (__sk) { \ 3155 run_ctx.retval = (init_retval); \ 3156 cgrp = sock_cgroup_ptr(&__sk->sk_cgrp_data); \ 3157 if (!sk_fullsock(sk)) \ 3158 req = (struct request_sock *)sk; \ 3159 rcu_read_lock_dont_migrate(); \ 3160 old_run_ctx = bpf_set_run_ctx(&run_ctx.run_ctx);\ 3161 bpf_cgroup_struct_ops_foreach(tcp_ops, item, cgrp, \ 3162 CGROUP_TCP_SOCK_OPS) { \ 3163 if (tcp_ops->op) \ 3164 run_ctx.retval = tcp_ops->op(__sk, req, ##__VA_ARGS__); \ 3165 } \ 3166 bpf_reset_run_ctx(old_run_ctx); \ 3167 rcu_read_unlock_migrate(); \ 3168 __retval = run_ctx.retval; \ 3169 } \ 3170 } \ 3171 __retval; \ 3172 }) 3173 3174 #else 3175 #define __bpf_tcp_ops_call(op, sk, ...) do { } while (0) 3176 #define bpf_tcp_ops_call(op, sk, ...) do { } while (0) 3177 #define bpf_tcp_ops_call_flag(op, flag, sk, ...) do { } while (0) 3178 #define bpf_tcp_ops_call_int(op, init_retval, sk, ...) (init_retval) 3179 #endif 3180 3181 static inline u32 tcp_timeout_init(struct sock *sk) 3182 { 3183 int timeout; 3184 3185 timeout = tcp_call_bpf(sk, BPF_SOCK_OPS_TIMEOUT_INIT); 3186 timeout = bpf_tcp_ops_call_int(timeout_init, timeout, sk); 3187 if (timeout <= 0) 3188 timeout = TCP_TIMEOUT_INIT; 3189 return min_t(int, timeout, TCP_RTO_MAX); 3190 } 3191 3192 static inline u32 tcp_rwnd_init_bpf(struct sock *sk) 3193 { 3194 int rwnd; 3195 3196 rwnd = tcp_call_bpf(sk, BPF_SOCK_OPS_RWND_INIT); 3197 rwnd = bpf_tcp_ops_call_int(rwnd_init, rwnd, sk); 3198 if (rwnd < 0) 3199 rwnd = 0; 3200 return rwnd; 3201 } 3202 3203 static inline bool tcp_bpf_ca_needs_ecn(struct sock *sk) 3204 { 3205 return (tcp_call_bpf(sk, BPF_SOCK_OPS_NEEDS_ECN) == 1); 3206 } 3207 3208 static inline void tcp_bpf_rtt(struct sock *sk, long mrtt, u32 srtt) 3209 { 3210 tcp_call_bpf_flag(sk, BPF_SOCK_OPS_RTT_CB, mrtt, srtt); 3211 bpf_tcp_ops_call_flag(rtt, RTT, sk, mrtt, srtt); 3212 } 3213 3214 #if IS_ENABLED(CONFIG_SMC) 3215 extern struct static_key_false tcp_have_smc; 3216 #endif 3217 3218 #if IS_ENABLED(CONFIG_TLS_DEVICE) 3219 void clean_acked_data_enable(struct tcp_sock *tp, 3220 void (*cad)(struct sock *sk, u32 ack_seq)); 3221 void clean_acked_data_disable(struct tcp_sock *tp); 3222 void clean_acked_data_flush(void); 3223 #endif 3224 3225 DECLARE_STATIC_KEY_FALSE(tcp_tx_delay_enabled); 3226 static inline void tcp_add_tx_delay(struct sk_buff *skb, 3227 const struct tcp_sock *tp) 3228 { 3229 if (static_branch_unlikely(&tcp_tx_delay_enabled)) 3230 skb->skb_mstamp_ns += (u64)tp->tcp_tx_delay * NSEC_PER_USEC; 3231 } 3232 3233 /* Compute Earliest Departure Time for some control packets 3234 * like ACK or RST for TIME_WAIT or non ESTABLISHED sockets. 3235 */ 3236 static inline u64 tcp_transmit_time(const struct sock *sk) 3237 { 3238 if (static_branch_unlikely(&tcp_tx_delay_enabled)) { 3239 u32 delay = (sk->sk_state == TCP_TIME_WAIT) ? 3240 tcp_twsk(sk)->tw_tx_delay : tcp_sk(sk)->tcp_tx_delay; 3241 3242 return tcp_clock_ns() + (u64)delay * NSEC_PER_USEC; 3243 } 3244 return 0; 3245 } 3246 3247 static inline int tcp_parse_auth_options(const struct tcphdr *th, 3248 const u8 **md5_hash, const struct tcp_ao_hdr **aoh) 3249 { 3250 const u8 *md5_tmp, *ao_tmp; 3251 int ret; 3252 3253 ret = tcp_do_parse_auth_options(th, &md5_tmp, &ao_tmp); 3254 if (ret) 3255 return ret; 3256 3257 if (md5_hash) 3258 *md5_hash = md5_tmp; 3259 3260 if (aoh) { 3261 if (!ao_tmp) 3262 *aoh = NULL; 3263 else 3264 *aoh = (struct tcp_ao_hdr *)(ao_tmp - 2); 3265 } 3266 3267 return 0; 3268 } 3269 3270 static inline bool tcp_ao_required(struct sock *sk, const void *saddr, 3271 int family, int l3index, bool stat_inc) 3272 { 3273 #ifdef CONFIG_TCP_AO 3274 struct tcp_ao_info *ao_info; 3275 struct tcp_ao_key *ao_key; 3276 3277 if (!static_branch_unlikely(&tcp_ao_needed.key)) 3278 return false; 3279 3280 ao_info = rcu_dereference_check(tcp_sk(sk)->ao_info, 3281 lockdep_sock_is_held(sk)); 3282 if (!ao_info) 3283 return false; 3284 3285 ao_key = tcp_ao_do_lookup(sk, l3index, saddr, family, -1, -1); 3286 if (ao_info->ao_required || ao_key) { 3287 if (stat_inc) { 3288 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAOREQUIRED); 3289 atomic64_inc(&ao_info->counters.ao_required); 3290 } 3291 return true; 3292 } 3293 #endif 3294 return false; 3295 } 3296 3297 enum skb_drop_reason tcp_inbound_hash(struct sock *sk, 3298 const struct request_sock *req, const struct sk_buff *skb, 3299 const void *saddr, const void *daddr, 3300 int family, int dif, int sdif); 3301 3302 static inline int tcp_recv_should_stop(struct sock *sk) 3303 { 3304 return READ_ONCE(sk->sk_err) || 3305 sk->sk_state == TCP_CLOSE || 3306 (sk->sk_shutdown & RCV_SHUTDOWN) || 3307 signal_pending(current); 3308 } 3309 3310 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off 3311 tcp_v4_init_seq_and_ts_off(const struct net *net, 3312 const struct sk_buff *skb)); 3313 INDIRECT_CALLABLE_DECLARE(union tcp_seq_and_ts_off 3314 tcp_v6_init_seq_and_ts_off(const struct net *net, 3315 const struct sk_buff *skb)); 3316 #endif /* _TCP_H */ 3317