1 // SPDX-License-Identifier: GPL-2.0-or-later
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.
7 * Implementation of the Transmission Control Protocol(TCP).
22 * Alan Cox : Numerous verify_area() calls
23 * Alan Cox : Set the ACK bit on a reset
24 * Alan Cox : Stopped it crashing if it closed while
25 * sk->inuse=1 and was trying to connect
27 * Alan Cox : All icmp error handling was broken
28 * pointers passed where wrong and the
29 * socket was looked up backwards. Nobody
30 * tested any icmp error code obviously.
31 * Alan Cox : tcp_err() now handled properly. It
32 * wakes people on errors. poll
33 * behaves and the icmp error race
34 * has gone by moving it into sock.c
35 * Alan Cox : tcp_send_reset() fixed to work for
36 * everything not just packets for
38 * Alan Cox : tcp option processing.
39 * Alan Cox : Reset tweaked (still not 100%) [Had
41 * Herp Rosmanith : More reset fixes
42 * Alan Cox : No longer acks invalid rst frames.
43 * Acking any kind of RST is right out.
44 * Alan Cox : Sets an ignore me flag on an rst
45 * receive otherwise odd bits of prattle
47 * Alan Cox : Fixed another acking RST frame bug.
48 * Should stop LAN workplace lockups.
49 * Alan Cox : Some tidyups using the new skb list
51 * Alan Cox : sk->keepopen now seems to work
52 * Alan Cox : Pulls options out correctly on accepts
53 * Alan Cox : Fixed assorted sk->rqueue->next errors
54 * Alan Cox : PSH doesn't end a TCP read. Switched a
56 * Alan Cox : Tidied tcp_data to avoid a potential
58 * Alan Cox : Added some better commenting, as the
59 * tcp is hard to follow
60 * Alan Cox : Removed incorrect check for 20 * psh
61 * Michael O'Reilly : ack < copied bug fix.
62 * Johannes Stille : Misc tcp fixes (not all in yet).
63 * Alan Cox : FIN with no memory -> CRASH
64 * Alan Cox : Added socket option proto entries.
65 * Also added awareness of them to accept.
66 * Alan Cox : Added TCP options (SOL_TCP)
67 * Alan Cox : Switched wakeup calls to callbacks,
68 * so the kernel can layer network
70 * Alan Cox : Use ip_tos/ip_ttl settings.
71 * Alan Cox : Handle FIN (more) properly (we hope).
72 * Alan Cox : RST frames sent on unsynchronised
74 * Alan Cox : Put in missing check for SYN bit.
75 * Alan Cox : Added tcp_select_window() aka NET2E
76 * window non shrink trick.
77 * Alan Cox : Added a couple of small NET2E timer
79 * Charles Hedrick : TCP fixes
80 * Toomas Tamm : TCP window fixes
81 * Alan Cox : Small URG fix to rlogin ^C ack fight
82 * Charles Hedrick : Rewrote most of it to actually work
83 * Linus : Rewrote tcp_read() and URG handling
85 * Gerhard Koerting: Fixed some missing timer handling
86 * Matthew Dillon : Reworked TCP machine states as per RFC
87 * Gerhard Koerting: PC/TCP workarounds
88 * Adam Caldwell : Assorted timer/timing errors
89 * Matthew Dillon : Fixed another RST bug
90 * Alan Cox : Move to kernel side addressing changes.
91 * Alan Cox : Beginning work on TCP fastpathing
93 * Arnt Gulbrandsen: Turbocharged tcp_check() routine.
94 * Alan Cox : TCP fast path debugging
95 * Alan Cox : Window clamping
96 * Michael Riepe : Bug in tcp_check()
97 * Matt Dillon : More TCP improvements and RST bug fixes
98 * Matt Dillon : Yet more small nasties remove from the
99 * TCP code (Be very nice to this man if
100 * tcp finally works 100%) 8)
101 * Alan Cox : BSD accept semantics.
102 * Alan Cox : Reset on closedown bug.
103 * Peter De Schrijver : ENOTCONN check missing in tcp_sendto().
104 * Michael Pall : Handle poll() after URG properly in
106 * Michael Pall : Undo the last fix in tcp_read_urg()
107 * (multi URG PUSH broke rlogin).
108 * Michael Pall : Fix the multi URG PUSH problem in
109 * tcp_readable(), poll() after URG
111 * Michael Pall : recv(...,MSG_OOB) never blocks in the
113 * Alan Cox : Changed the semantics of sk->socket to
114 * fix a race and a signal problem with
115 * accept() and async I/O.
116 * Alan Cox : Relaxed the rules on tcp_sendto().
117 * Yury Shevchuk : Really fixed accept() blocking problem.
118 * Craig I. Hagan : Allow for BSD compatible TIME_WAIT for
119 * clients/servers which listen in on
121 * Alan Cox : Cleaned the above up and shrank it to
122 * a sensible code size.
123 * Alan Cox : Self connect lockup fix.
124 * Alan Cox : No connect to multicast.
125 * Ross Biro : Close unaccepted children on master
127 * Alan Cox : Reset tracing code.
128 * Alan Cox : Spurious resets on shutdown.
129 * Alan Cox : Giant 15 minute/60 second timer error
130 * Alan Cox : Small whoops in polling before an
132 * Alan Cox : Kept the state trace facility since
133 * it's handy for debugging.
134 * Alan Cox : More reset handler fixes.
135 * Alan Cox : Started rewriting the code based on
136 * the RFC's for other useful protocol
137 * references see: Comer, KA9Q NOS, and
138 * for a reference on the difference
139 * between specifications and how BSD
140 * works see the 4.4lite source.
141 * A.N.Kuznetsov : Don't time wait on completion of tidy
143 * Linus Torvalds : Fin/Shutdown & copied_seq changes.
144 * Linus Torvalds : Fixed BSD port reuse to work first syn
145 * Alan Cox : Reimplemented timers as per the RFC
146 * and using multiple timers for sanity.
147 * Alan Cox : Small bug fixes, and a lot of new
149 * Alan Cox : Fixed dual reader crash by locking
150 * the buffers (much like datagram.c)
151 * Alan Cox : Fixed stuck sockets in probe. A probe
152 * now gets fed up of retrying without
153 * (even a no space) answer.
154 * Alan Cox : Extracted closing code better
155 * Alan Cox : Fixed the closing state machine to
157 * Alan Cox : More 'per spec' fixes.
158 * Jorge Cwik : Even faster checksumming.
159 * Alan Cox : tcp_data() doesn't ack illegal PSH
160 * only frames. At least one pc tcp stack
162 * Alan Cox : Cache last socket.
163 * Alan Cox : Per route irtt.
164 * Matt Day : poll()->select() match BSD precisely on error
165 * Alan Cox : New buffers
166 * Marc Tamsky : Various sk->prot->retransmits and
167 * sk->retransmits misupdating fixed.
168 * Fixed tcp_write_timeout: stuck close,
169 * and TCP syn retries gets used now.
170 * Mark Yarvis : In tcp_read_wakeup(), don't send an
171 * ack if state is TCP_CLOSED.
172 * Alan Cox : Look up device on a retransmit - routes may
173 * change. Doesn't yet cope with MSS shrink right
175 * Marc Tamsky : Closing in closing fixes.
176 * Mike Shaver : RFC1122 verifications.
177 * Alan Cox : rcv_saddr errors.
178 * Alan Cox : Block double connect().
179 * Alan Cox : Small hooks for enSKIP.
180 * Alexey Kuznetsov: Path MTU discovery.
181 * Alan Cox : Support soft errors.
182 * Alan Cox : Fix MTU discovery pathological case
183 * when the remote claims no mtu!
184 * Marc Tamsky : TCP_CLOSE fix.
185 * Colin (G3TNE) : Send a reset on syn ack replies in
186 * window but wrong (fixes NT lpd problems)
187 * Pedro Roque : Better TCP window handling, delayed ack.
188 * Joerg Reuter : No modification of locked buffers in
189 * tcp_do_retransmit()
190 * Eric Schenk : Changed receiver side silly window
191 * avoidance algorithm to BSD style
192 * algorithm. This doubles throughput
193 * against machines running Solaris,
194 * and seems to result in general
196 * Stefan Magdalinski : adjusted tcp_readable() to fix FIONREAD
197 * Willy Konynenberg : Transparent proxying support.
198 * Mike McLagan : Routing by source
199 * Keith Owens : Do proper merging with partial SKB's in
200 * tcp_do_sendmsg to avoid burstiness.
201 * Eric Schenk : Fix fast close down bug with
202 * shutdown() followed by close().
203 * Andi Kleen : Make poll agree with SIGIO
204 * Salvatore Sanfilippo : Support SO_LINGER with linger == 1 and
205 * lingertime == 0 (RFC 793 ABORT Call)
206 * Hirokazu Takahashi : Use copy_from_user() instead of
207 * csum_and_copy_from_user() if possible.
209 * Description of States:
211 * TCP_SYN_SENT sent a connection request, waiting for ack
213 * TCP_SYN_RECV received a connection request, sent ack,
214 * waiting for final ack in three-way handshake.
216 * TCP_ESTABLISHED connection established
218 * TCP_FIN_WAIT1 our side has shutdown, waiting to complete
219 * transmission of remaining buffered data
221 * TCP_FIN_WAIT2 all buffered data sent, waiting for remote
224 * TCP_CLOSING both sides have shutdown but we still have
225 * data we have to finish sending
227 * TCP_TIME_WAIT timeout to catch resent junk before entering
228 * closed, can only be entered from FIN_WAIT2
229 * or CLOSING. Required because the other end
230 * may not have gotten our last ACK causing it
231 * to retransmit the data packet (which we ignore)
233 * TCP_CLOSE_WAIT remote side has shutdown and is waiting for
234 * us to finish writing our data and to shutdown
235 * (we have to close() to move on to LAST_ACK)
237 * TCP_LAST_ACK out side has shutdown after remote has
238 * shutdown. There may still be data in our
239 * buffer that we have to finish sending
241 * TCP_CLOSE socket is finished
244 #define pr_fmt(fmt) "TCP: " fmt
246 #include <crypto/hash.h>
247 #include <linux/kernel.h>
248 #include <linux/module.h>
249 #include <linux/types.h>
250 #include <linux/fcntl.h>
251 #include <linux/poll.h>
252 #include <linux/inet_diag.h>
253 #include <linux/init.h>
254 #include <linux/fs.h>
255 #include <linux/skbuff.h>
256 #include <linux/scatterlist.h>
257 #include <linux/splice.h>
258 #include <linux/net.h>
259 #include <linux/socket.h>
260 #include <linux/random.h>
261 #include <linux/memblock.h>
262 #include <linux/highmem.h>
263 #include <linux/swap.h>
264 #include <linux/cache.h>
265 #include <linux/err.h>
266 #include <linux/time.h>
267 #include <linux/slab.h>
268 #include <linux/errqueue.h>
269 #include <linux/static_key.h>
270 #include <linux/btf.h>
272 #include <net/icmp.h>
273 #include <net/inet_common.h>
275 #include <net/mptcp.h>
276 #include <net/xfrm.h>
278 #include <net/sock.h>
280 #include <linux/uaccess.h>
281 #include <asm/ioctls.h>
282 #include <net/busy_poll.h>
284 /* Track pending CMSGs. */
290 DEFINE_PER_CPU(unsigned int, tcp_orphan_count);
291 EXPORT_PER_CPU_SYMBOL_GPL(tcp_orphan_count);
293 long sysctl_tcp_mem[3] __read_mostly;
294 EXPORT_SYMBOL(sysctl_tcp_mem);
296 atomic_long_t tcp_memory_allocated; /* Current allocated memory. */
297 EXPORT_SYMBOL(tcp_memory_allocated);
299 #if IS_ENABLED(CONFIG_SMC)
300 DEFINE_STATIC_KEY_FALSE(tcp_have_smc);
301 EXPORT_SYMBOL(tcp_have_smc);
305 * Current number of TCP sockets.
307 struct percpu_counter tcp_sockets_allocated;
308 EXPORT_SYMBOL(tcp_sockets_allocated);
313 struct tcp_splice_state {
314 struct pipe_inode_info *pipe;
320 * Pressure flag: try to collapse.
321 * Technical note: it is used by multiple contexts non atomically.
322 * All the __sk_mem_schedule() is of this nature: accounting
323 * is strict, actions are advisory and have some latency.
325 unsigned long tcp_memory_pressure __read_mostly;
326 EXPORT_SYMBOL_GPL(tcp_memory_pressure);
328 void tcp_enter_memory_pressure(struct sock *sk)
332 if (READ_ONCE(tcp_memory_pressure))
338 if (!cmpxchg(&tcp_memory_pressure, 0, val))
339 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPMEMORYPRESSURES);
341 EXPORT_SYMBOL_GPL(tcp_enter_memory_pressure);
343 void tcp_leave_memory_pressure(struct sock *sk)
347 if (!READ_ONCE(tcp_memory_pressure))
349 val = xchg(&tcp_memory_pressure, 0);
351 NET_ADD_STATS(sock_net(sk), LINUX_MIB_TCPMEMORYPRESSURESCHRONO,
352 jiffies_to_msecs(jiffies - val));
354 EXPORT_SYMBOL_GPL(tcp_leave_memory_pressure);
356 /* Convert seconds to retransmits based on initial and max timeout */
357 static u8 secs_to_retrans(int seconds, int timeout, int rto_max)
362 int period = timeout;
365 while (seconds > period && res < 255) {
368 if (timeout > rto_max)
376 /* Convert retransmits to seconds based on initial and max timeout */
377 static int retrans_to_secs(u8 retrans, int timeout, int rto_max)
385 if (timeout > rto_max)
393 static u64 tcp_compute_delivery_rate(const struct tcp_sock *tp)
395 u32 rate = READ_ONCE(tp->rate_delivered);
396 u32 intv = READ_ONCE(tp->rate_interval_us);
400 rate64 = (u64)rate * tp->mss_cache * USEC_PER_SEC;
401 do_div(rate64, intv);
406 /* Address-family independent initialization for a tcp_sock.
408 * NOTE: A lot of things set to zero explicitly by call to
409 * sk_alloc() so need not be done here.
411 void tcp_init_sock(struct sock *sk)
413 struct inet_connection_sock *icsk = inet_csk(sk);
414 struct tcp_sock *tp = tcp_sk(sk);
416 tp->out_of_order_queue = RB_ROOT;
417 sk->tcp_rtx_queue = RB_ROOT;
418 tcp_init_xmit_timers(sk);
419 INIT_LIST_HEAD(&tp->tsq_node);
420 INIT_LIST_HEAD(&tp->tsorted_sent_queue);
422 icsk->icsk_rto = TCP_TIMEOUT_INIT;
423 icsk->icsk_rto_min = TCP_RTO_MIN;
424 icsk->icsk_delack_max = TCP_DELACK_MAX;
425 tp->mdev_us = jiffies_to_usecs(TCP_TIMEOUT_INIT);
426 minmax_reset(&tp->rtt_min, tcp_jiffies32, ~0U);
428 /* So many TCP implementations out there (incorrectly) count the
429 * initial SYN frame in their delayed-ACK and congestion control
430 * algorithms that we must have the following bandaid to talk
431 * efficiently to them. -DaveM
433 tp->snd_cwnd = TCP_INIT_CWND;
435 /* There's a bubble in the pipe until at least the first ACK. */
436 tp->app_limited = ~0U;
438 /* See draft-stevens-tcpca-spec-01 for discussion of the
439 * initialization of these values.
441 tp->snd_ssthresh = TCP_INFINITE_SSTHRESH;
442 tp->snd_cwnd_clamp = ~0;
443 tp->mss_cache = TCP_MSS_DEFAULT;
445 tp->reordering = sock_net(sk)->ipv4.sysctl_tcp_reordering;
446 tcp_assign_congestion_control(sk);
449 tp->rack.reo_wnd_steps = 1;
451 sk->sk_write_space = sk_stream_write_space;
452 sock_set_flag(sk, SOCK_USE_WRITE_QUEUE);
454 icsk->icsk_sync_mss = tcp_sync_mss;
456 WRITE_ONCE(sk->sk_sndbuf, sock_net(sk)->ipv4.sysctl_tcp_wmem[1]);
457 WRITE_ONCE(sk->sk_rcvbuf, sock_net(sk)->ipv4.sysctl_tcp_rmem[1]);
459 sk_sockets_allocated_inc(sk);
460 sk->sk_route_forced_caps = NETIF_F_GSO;
462 EXPORT_SYMBOL(tcp_init_sock);
464 static void tcp_tx_timestamp(struct sock *sk, u16 tsflags)
466 struct sk_buff *skb = tcp_write_queue_tail(sk);
468 if (tsflags && skb) {
469 struct skb_shared_info *shinfo = skb_shinfo(skb);
470 struct tcp_skb_cb *tcb = TCP_SKB_CB(skb);
472 sock_tx_timestamp(sk, tsflags, &shinfo->tx_flags);
473 if (tsflags & SOF_TIMESTAMPING_TX_ACK)
474 tcb->txstamp_ack = 1;
475 if (tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK)
476 shinfo->tskey = TCP_SKB_CB(skb)->seq + skb->len - 1;
480 static bool tcp_stream_is_readable(struct sock *sk, int target)
482 if (tcp_epollin_ready(sk, target))
484 return sk_is_readable(sk);
488 * Wait for a TCP event.
490 * Note that we don't need to lock the socket, as the upper poll layers
491 * take care of normal races (between the test and the event) and we don't
492 * go look at any of the socket buffers directly.
494 __poll_t tcp_poll(struct file *file, struct socket *sock, poll_table *wait)
497 struct sock *sk = sock->sk;
498 const struct tcp_sock *tp = tcp_sk(sk);
501 sock_poll_wait(file, sock, wait);
503 state = inet_sk_state_load(sk);
504 if (state == TCP_LISTEN)
505 return inet_csk_listen_poll(sk);
507 /* Socket is not locked. We are protected from async events
508 * by poll logic and correct handling of state changes
509 * made by other threads is impossible in any case.
515 * EPOLLHUP is certainly not done right. But poll() doesn't
516 * have a notion of HUP in just one direction, and for a
517 * socket the read side is more interesting.
519 * Some poll() documentation says that EPOLLHUP is incompatible
520 * with the EPOLLOUT/POLLWR flags, so somebody should check this
521 * all. But careful, it tends to be safer to return too many
522 * bits than too few, and you can easily break real applications
523 * if you don't tell them that something has hung up!
527 * Check number 1. EPOLLHUP is _UNMASKABLE_ event (see UNIX98 and
528 * our fs/select.c). It means that after we received EOF,
529 * poll always returns immediately, making impossible poll() on write()
530 * in state CLOSE_WAIT. One solution is evident --- to set EPOLLHUP
531 * if and only if shutdown has been made in both directions.
532 * Actually, it is interesting to look how Solaris and DUX
533 * solve this dilemma. I would prefer, if EPOLLHUP were maskable,
534 * then we could set it on SND_SHUTDOWN. BTW examples given
535 * in Stevens' books assume exactly this behaviour, it explains
536 * why EPOLLHUP is incompatible with EPOLLOUT. --ANK
538 * NOTE. Check for TCP_CLOSE is added. The goal is to prevent
539 * blocking on fresh not-connected or disconnected socket. --ANK
541 if (sk->sk_shutdown == SHUTDOWN_MASK || state == TCP_CLOSE)
543 if (sk->sk_shutdown & RCV_SHUTDOWN)
544 mask |= EPOLLIN | EPOLLRDNORM | EPOLLRDHUP;
546 /* Connected or passive Fast Open socket? */
547 if (state != TCP_SYN_SENT &&
548 (state != TCP_SYN_RECV || rcu_access_pointer(tp->fastopen_rsk))) {
549 int target = sock_rcvlowat(sk, 0, INT_MAX);
551 if (READ_ONCE(tp->urg_seq) == READ_ONCE(tp->copied_seq) &&
552 !sock_flag(sk, SOCK_URGINLINE) &&
556 if (tcp_stream_is_readable(sk, target))
557 mask |= EPOLLIN | EPOLLRDNORM;
559 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
560 if (__sk_stream_is_writeable(sk, 1)) {
561 mask |= EPOLLOUT | EPOLLWRNORM;
562 } else { /* send SIGIO later */
563 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
564 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
566 /* Race breaker. If space is freed after
567 * wspace test but before the flags are set,
568 * IO signal will be lost. Memory barrier
569 * pairs with the input side.
571 smp_mb__after_atomic();
572 if (__sk_stream_is_writeable(sk, 1))
573 mask |= EPOLLOUT | EPOLLWRNORM;
576 mask |= EPOLLOUT | EPOLLWRNORM;
578 if (tp->urg_data & TCP_URG_VALID)
580 } else if (state == TCP_SYN_SENT && inet_sk(sk)->defer_connect) {
581 /* Active TCP fastopen socket with defer_connect
582 * Return EPOLLOUT so application can call write()
583 * in order for kernel to generate SYN+data
585 mask |= EPOLLOUT | EPOLLWRNORM;
587 /* This barrier is coupled with smp_wmb() in tcp_reset() */
589 if (sk->sk_err || !skb_queue_empty_lockless(&sk->sk_error_queue))
594 EXPORT_SYMBOL(tcp_poll);
596 int tcp_ioctl(struct sock *sk, int cmd, unsigned long arg)
598 struct tcp_sock *tp = tcp_sk(sk);
604 if (sk->sk_state == TCP_LISTEN)
607 slow = lock_sock_fast(sk);
609 unlock_sock_fast(sk, slow);
612 answ = tp->urg_data &&
613 READ_ONCE(tp->urg_seq) == READ_ONCE(tp->copied_seq);
616 if (sk->sk_state == TCP_LISTEN)
619 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV))
622 answ = READ_ONCE(tp->write_seq) - tp->snd_una;
625 if (sk->sk_state == TCP_LISTEN)
628 if ((1 << sk->sk_state) & (TCPF_SYN_SENT | TCPF_SYN_RECV))
631 answ = READ_ONCE(tp->write_seq) -
632 READ_ONCE(tp->snd_nxt);
638 return put_user(answ, (int __user *)arg);
640 EXPORT_SYMBOL(tcp_ioctl);
642 void tcp_mark_push(struct tcp_sock *tp, struct sk_buff *skb)
644 TCP_SKB_CB(skb)->tcp_flags |= TCPHDR_PSH;
645 tp->pushed_seq = tp->write_seq;
648 static inline bool forced_push(const struct tcp_sock *tp)
650 return after(tp->write_seq, tp->pushed_seq + (tp->max_window >> 1));
653 void tcp_skb_entail(struct sock *sk, struct sk_buff *skb)
655 struct tcp_sock *tp = tcp_sk(sk);
656 struct tcp_skb_cb *tcb = TCP_SKB_CB(skb);
658 tcb->seq = tcb->end_seq = tp->write_seq;
659 tcb->tcp_flags = TCPHDR_ACK;
660 __skb_header_release(skb);
661 tcp_add_write_queue_tail(sk, skb);
662 sk_wmem_queued_add(sk, skb->truesize);
663 sk_mem_charge(sk, skb->truesize);
664 if (tp->nonagle & TCP_NAGLE_PUSH)
665 tp->nonagle &= ~TCP_NAGLE_PUSH;
667 tcp_slow_start_after_idle_check(sk);
670 static inline void tcp_mark_urg(struct tcp_sock *tp, int flags)
673 tp->snd_up = tp->write_seq;
676 /* If a not yet filled skb is pushed, do not send it if
677 * we have data packets in Qdisc or NIC queues :
678 * Because TX completion will happen shortly, it gives a chance
679 * to coalesce future sendmsg() payload into this skb, without
680 * need for a timer, and with no latency trade off.
681 * As packets containing data payload have a bigger truesize
682 * than pure acks (dataless) packets, the last checks prevent
683 * autocorking if we only have an ACK in Qdisc/NIC queues,
684 * or if TX completion was delayed after we processed ACK packet.
686 static bool tcp_should_autocork(struct sock *sk, struct sk_buff *skb,
689 return skb->len < size_goal &&
690 sock_net(sk)->ipv4.sysctl_tcp_autocorking &&
691 !tcp_rtx_queue_empty(sk) &&
692 refcount_read(&sk->sk_wmem_alloc) > skb->truesize;
695 void tcp_push(struct sock *sk, int flags, int mss_now,
696 int nonagle, int size_goal)
698 struct tcp_sock *tp = tcp_sk(sk);
701 skb = tcp_write_queue_tail(sk);
704 if (!(flags & MSG_MORE) || forced_push(tp))
705 tcp_mark_push(tp, skb);
707 tcp_mark_urg(tp, flags);
709 if (tcp_should_autocork(sk, skb, size_goal)) {
711 /* avoid atomic op if TSQ_THROTTLED bit is already set */
712 if (!test_bit(TSQ_THROTTLED, &sk->sk_tsq_flags)) {
713 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPAUTOCORKING);
714 set_bit(TSQ_THROTTLED, &sk->sk_tsq_flags);
716 /* It is possible TX completion already happened
717 * before we set TSQ_THROTTLED.
719 if (refcount_read(&sk->sk_wmem_alloc) > skb->truesize)
723 if (flags & MSG_MORE)
724 nonagle = TCP_NAGLE_CORK;
726 __tcp_push_pending_frames(sk, mss_now, nonagle);
729 static int tcp_splice_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb,
730 unsigned int offset, size_t len)
732 struct tcp_splice_state *tss = rd_desc->arg.data;
735 ret = skb_splice_bits(skb, skb->sk, offset, tss->pipe,
736 min(rd_desc->count, len), tss->flags);
738 rd_desc->count -= ret;
742 static int __tcp_splice_read(struct sock *sk, struct tcp_splice_state *tss)
744 /* Store TCP splice context information in read_descriptor_t. */
745 read_descriptor_t rd_desc = {
750 return tcp_read_sock(sk, &rd_desc, tcp_splice_data_recv);
754 * tcp_splice_read - splice data from TCP socket to a pipe
755 * @sock: socket to splice from
756 * @ppos: position (not valid)
757 * @pipe: pipe to splice to
758 * @len: number of bytes to splice
759 * @flags: splice modifier flags
762 * Will read pages from given socket and fill them into a pipe.
765 ssize_t tcp_splice_read(struct socket *sock, loff_t *ppos,
766 struct pipe_inode_info *pipe, size_t len,
769 struct sock *sk = sock->sk;
770 struct tcp_splice_state tss = {
779 sock_rps_record_flow(sk);
781 * We can't seek on a socket input
790 timeo = sock_rcvtimeo(sk, sock->file->f_flags & O_NONBLOCK);
792 ret = __tcp_splice_read(sk, &tss);
798 if (sock_flag(sk, SOCK_DONE))
801 ret = sock_error(sk);
804 if (sk->sk_shutdown & RCV_SHUTDOWN)
806 if (sk->sk_state == TCP_CLOSE) {
808 * This occurs when user tries to read
809 * from never connected socket.
818 /* if __tcp_splice_read() got nothing while we have
819 * an skb in receive queue, we do not want to loop.
820 * This might happen with URG data.
822 if (!skb_queue_empty(&sk->sk_receive_queue))
824 sk_wait_data(sk, &timeo, NULL);
825 if (signal_pending(current)) {
826 ret = sock_intr_errno(timeo);
839 if (sk->sk_err || sk->sk_state == TCP_CLOSE ||
840 (sk->sk_shutdown & RCV_SHUTDOWN) ||
841 signal_pending(current))
852 EXPORT_SYMBOL(tcp_splice_read);
854 struct sk_buff *tcp_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
859 if (unlikely(tcp_under_memory_pressure(sk)))
860 sk_mem_reclaim_partial(sk);
862 skb = alloc_skb_fclone(size + MAX_TCP_HEADER, gfp);
866 skb->truesize = SKB_TRUESIZE(skb_end_offset(skb));
867 if (force_schedule) {
868 mem_scheduled = true;
869 sk_forced_mem_schedule(sk, skb->truesize);
871 mem_scheduled = sk_wmem_schedule(sk, skb->truesize);
873 if (likely(mem_scheduled)) {
874 skb_reserve(skb, MAX_TCP_HEADER);
875 skb->ip_summed = CHECKSUM_PARTIAL;
876 INIT_LIST_HEAD(&skb->tcp_tsorted_anchor);
881 sk->sk_prot->enter_memory_pressure(sk);
882 sk_stream_moderate_sndbuf(sk);
887 static unsigned int tcp_xmit_size_goal(struct sock *sk, u32 mss_now,
890 struct tcp_sock *tp = tcp_sk(sk);
891 u32 new_size_goal, size_goal;
896 /* Note : tcp_tso_autosize() will eventually split this later */
897 new_size_goal = sk->sk_gso_max_size - 1 - MAX_TCP_HEADER;
898 new_size_goal = tcp_bound_to_half_wnd(tp, new_size_goal);
900 /* We try hard to avoid divides here */
901 size_goal = tp->gso_segs * mss_now;
902 if (unlikely(new_size_goal < size_goal ||
903 new_size_goal >= size_goal + mss_now)) {
904 tp->gso_segs = min_t(u16, new_size_goal / mss_now,
905 sk->sk_gso_max_segs);
906 size_goal = tp->gso_segs * mss_now;
909 return max(size_goal, mss_now);
912 int tcp_send_mss(struct sock *sk, int *size_goal, int flags)
916 mss_now = tcp_current_mss(sk);
917 *size_goal = tcp_xmit_size_goal(sk, mss_now, !(flags & MSG_OOB));
922 /* In some cases, both sendpage() and sendmsg() could have added
923 * an skb to the write queue, but failed adding payload on it.
924 * We need to remove it to consume less memory, but more
925 * importantly be able to generate EPOLLOUT for Edge Trigger epoll()
928 void tcp_remove_empty_skb(struct sock *sk)
930 struct sk_buff *skb = tcp_write_queue_tail(sk);
932 if (skb && TCP_SKB_CB(skb)->seq == TCP_SKB_CB(skb)->end_seq) {
933 tcp_unlink_write_queue(skb, sk);
934 if (tcp_write_queue_empty(sk))
935 tcp_chrono_stop(sk, TCP_CHRONO_BUSY);
936 tcp_wmem_free_skb(sk, skb);
940 static struct sk_buff *tcp_build_frag(struct sock *sk, int size_goal, int flags,
941 struct page *page, int offset, size_t *size)
943 struct sk_buff *skb = tcp_write_queue_tail(sk);
944 struct tcp_sock *tp = tcp_sk(sk);
948 if (!skb || (copy = size_goal - skb->len) <= 0 ||
949 !tcp_skb_can_collapse_to(skb)) {
951 if (!sk_stream_memory_free(sk))
954 skb = tcp_stream_alloc_skb(sk, 0, sk->sk_allocation,
955 tcp_rtx_and_write_queues_empty(sk));
959 #ifdef CONFIG_TLS_DEVICE
960 skb->decrypted = !!(flags & MSG_SENDPAGE_DECRYPTED);
962 tcp_skb_entail(sk, skb);
969 i = skb_shinfo(skb)->nr_frags;
970 can_coalesce = skb_can_coalesce(skb, i, page, offset);
971 if (!can_coalesce && i >= sysctl_max_skb_frags) {
972 tcp_mark_push(tp, skb);
975 if (!sk_wmem_schedule(sk, copy))
979 skb_frag_size_add(&skb_shinfo(skb)->frags[i - 1], copy);
982 skb_fill_page_desc(skb, i, page, offset, copy);
985 if (!(flags & MSG_NO_SHARED_FRAGS))
986 skb_shinfo(skb)->flags |= SKBFL_SHARED_FRAG;
989 skb->data_len += copy;
990 skb->truesize += copy;
991 sk_wmem_queued_add(sk, copy);
992 sk_mem_charge(sk, copy);
993 WRITE_ONCE(tp->write_seq, tp->write_seq + copy);
994 TCP_SKB_CB(skb)->end_seq += copy;
995 tcp_skb_pcount_set(skb, 0);
1001 ssize_t do_tcp_sendpages(struct sock *sk, struct page *page, int offset,
1002 size_t size, int flags)
1004 struct tcp_sock *tp = tcp_sk(sk);
1005 int mss_now, size_goal;
1008 long timeo = sock_sndtimeo(sk, flags & MSG_DONTWAIT);
1010 if (IS_ENABLED(CONFIG_DEBUG_VM) &&
1011 WARN_ONCE(!sendpage_ok(page),
1012 "page must not be a Slab one and have page_count > 0"))
1015 /* Wait for a connection to finish. One exception is TCP Fast Open
1016 * (passive side) where data is allowed to be sent before a connection
1017 * is fully established.
1019 if (((1 << sk->sk_state) & ~(TCPF_ESTABLISHED | TCPF_CLOSE_WAIT)) &&
1020 !tcp_passive_fastopen(sk)) {
1021 err = sk_stream_wait_connect(sk, &timeo);
1026 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
1028 mss_now = tcp_send_mss(sk, &size_goal, flags);
1032 if (sk->sk_err || (sk->sk_shutdown & SEND_SHUTDOWN))
1036 struct sk_buff *skb;
1039 skb = tcp_build_frag(sk, size_goal, flags, page, offset, ©);
1041 goto wait_for_space;
1044 TCP_SKB_CB(skb)->tcp_flags &= ~TCPHDR_PSH;
1052 if (skb->len < size_goal || (flags & MSG_OOB))
1055 if (forced_push(tp)) {
1056 tcp_mark_push(tp, skb);
1057 __tcp_push_pending_frames(sk, mss_now, TCP_NAGLE_PUSH);
1058 } else if (skb == tcp_send_head(sk))
1059 tcp_push_one(sk, mss_now);
1063 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1064 tcp_push(sk, flags & ~MSG_MORE, mss_now,
1065 TCP_NAGLE_PUSH, size_goal);
1067 err = sk_stream_wait_memory(sk, &timeo);
1071 mss_now = tcp_send_mss(sk, &size_goal, flags);
1076 tcp_tx_timestamp(sk, sk->sk_tsflags);
1077 if (!(flags & MSG_SENDPAGE_NOTLAST))
1078 tcp_push(sk, flags, mss_now, tp->nonagle, size_goal);
1083 tcp_remove_empty_skb(sk);
1087 /* make sure we wake any epoll edge trigger waiter */
1088 if (unlikely(tcp_rtx_and_write_queues_empty(sk) && err == -EAGAIN)) {
1089 sk->sk_write_space(sk);
1090 tcp_chrono_stop(sk, TCP_CHRONO_SNDBUF_LIMITED);
1092 return sk_stream_error(sk, flags, err);
1094 EXPORT_SYMBOL_GPL(do_tcp_sendpages);
1096 int tcp_sendpage_locked(struct sock *sk, struct page *page, int offset,
1097 size_t size, int flags)
1099 if (!(sk->sk_route_caps & NETIF_F_SG))
1100 return sock_no_sendpage_locked(sk, page, offset, size, flags);
1102 tcp_rate_check_app_limited(sk); /* is sending application-limited? */
1104 return do_tcp_sendpages(sk, page, offset, size, flags);
1106 EXPORT_SYMBOL_GPL(tcp_sendpage_locked);
1108 int tcp_sendpage(struct sock *sk, struct page *page, int offset,
1109 size_t size, int flags)
1114 ret = tcp_sendpage_locked(sk, page, offset, size, flags);
1119 EXPORT_SYMBOL(tcp_sendpage);
1121 void tcp_free_fastopen_req(struct tcp_sock *tp)
1123 if (tp->fastopen_req) {
1124 kfree(tp->fastopen_req);
1125 tp->fastopen_req = NULL;
1129 static int tcp_sendmsg_fastopen(struct sock *sk, struct msghdr *msg,
1130 int *copied, size_t size,
1131 struct ubuf_info *uarg)
1133 struct tcp_sock *tp = tcp_sk(sk);
1134 struct inet_sock *inet = inet_sk(sk);
1135 struct sockaddr *uaddr = msg->msg_name;
1138 if (!(sock_net(sk)->ipv4.sysctl_tcp_fastopen & TFO_CLIENT_ENABLE) ||
1139 (uaddr && msg->msg_namelen >= sizeof(uaddr->sa_family) &&
1140 uaddr->sa_family == AF_UNSPEC))
1142 if (tp->fastopen_req)
1143 return -EALREADY; /* Another Fast Open is in progress */
1145 tp->fastopen_req = kzalloc(sizeof(struct tcp_fastopen_request),
1147 if (unlikely(!tp->fastopen_req))
1149 tp->fastopen_req->data = msg;
1150 tp->fastopen_req->size = size;
1151 tp->fastopen_req->uarg = uarg;
1153 if (inet->defer_connect) {
1154 err = tcp_connect(sk);
1155 /* Same failure procedure as in tcp_v4/6_connect */
1157 tcp_set_state(sk, TCP_CLOSE);
1158 inet->inet_dport = 0;
1159 sk->sk_route_caps = 0;
1162 flags = (msg->msg_flags & MSG_DONTWAIT) ? O_NONBLOCK : 0;
1163 err = __inet_stream_connect(sk->sk_socket, uaddr,
1164 msg->msg_namelen, flags, 1);
1165 /* fastopen_req could already be freed in __inet_stream_connect
1166 * if the connection times out or gets rst
1168 if (tp->fastopen_req) {
1169 *copied = tp->fastopen_req->copied;
1170 tcp_free_fastopen_req(tp);
1171 inet->defer_connect = 0;
1176 int tcp_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t size)
1178 struct tcp_sock *tp = tcp_sk(sk);
1179 struct ubuf_info *uarg = NULL;
1180 struct sk_buff *skb;
1181 struct sockcm_cookie sockc;
1182 int flags, err, copied = 0;
1183 int mss_now = 0, size_goal, copied_syn = 0;
1184 int process_backlog = 0;
1188 flags = msg->msg_flags;
1190 if (flags & MSG_ZEROCOPY && size && sock_flag(sk, SOCK_ZEROCOPY)) {
1191 skb = tcp_write_queue_tail(sk);
1192 uarg = msg_zerocopy_realloc(sk, size, skb_zcopy(skb));
1198 zc = sk->sk_route_caps & NETIF_F_SG;
1203 if (unlikely(flags & MSG_FASTOPEN || inet_sk(sk)->defer_connect) &&
1205 err = tcp_sendmsg_fastopen(sk, msg, &copied_syn, size, uarg);
1206 if (err == -EINPROGRESS && copied_syn > 0)
1212 timeo = sock_sndtimeo(sk, flags & MSG_DONTWAIT);
1214 tcp_rate_check_app_limited(sk); /* is sending application-limited? */
1216 /* Wait for a connection to finish. One exception is TCP Fast Open
1217 * (passive side) where data is allowed to be sent before a connection
1218 * is fully established.
1220 if (((1 << sk->sk_state) & ~(TCPF_ESTABLISHED | TCPF_CLOSE_WAIT)) &&
1221 !tcp_passive_fastopen(sk)) {
1222 err = sk_stream_wait_connect(sk, &timeo);
1227 if (unlikely(tp->repair)) {
1228 if (tp->repair_queue == TCP_RECV_QUEUE) {
1229 copied = tcp_send_rcvq(sk, msg, size);
1234 if (tp->repair_queue == TCP_NO_QUEUE)
1237 /* 'common' sending to sendq */
1240 sockcm_init(&sockc, sk);
1241 if (msg->msg_controllen) {
1242 err = sock_cmsg_send(sk, msg, &sockc);
1243 if (unlikely(err)) {
1249 /* This should be in poll */
1250 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
1252 /* Ok commence sending. */
1256 mss_now = tcp_send_mss(sk, &size_goal, flags);
1259 if (sk->sk_err || (sk->sk_shutdown & SEND_SHUTDOWN))
1262 while (msg_data_left(msg)) {
1265 skb = tcp_write_queue_tail(sk);
1267 copy = size_goal - skb->len;
1269 if (copy <= 0 || !tcp_skb_can_collapse_to(skb)) {
1273 if (!sk_stream_memory_free(sk))
1274 goto wait_for_space;
1276 if (unlikely(process_backlog >= 16)) {
1277 process_backlog = 0;
1278 if (sk_flush_backlog(sk))
1281 first_skb = tcp_rtx_and_write_queues_empty(sk);
1282 skb = tcp_stream_alloc_skb(sk, 0, sk->sk_allocation,
1285 goto wait_for_space;
1289 tcp_skb_entail(sk, skb);
1292 /* All packets are restored as if they have
1293 * already been sent. skb_mstamp_ns isn't set to
1294 * avoid wrong rtt estimation.
1297 TCP_SKB_CB(skb)->sacked |= TCPCB_REPAIRED;
1300 /* Try to append data to the end of skb. */
1301 if (copy > msg_data_left(msg))
1302 copy = msg_data_left(msg);
1306 int i = skb_shinfo(skb)->nr_frags;
1307 struct page_frag *pfrag = sk_page_frag(sk);
1309 if (!sk_page_frag_refill(sk, pfrag))
1310 goto wait_for_space;
1312 if (!skb_can_coalesce(skb, i, pfrag->page,
1314 if (i >= sysctl_max_skb_frags) {
1315 tcp_mark_push(tp, skb);
1321 copy = min_t(int, copy, pfrag->size - pfrag->offset);
1323 /* skb changing from pure zc to mixed, must charge zc */
1324 if (unlikely(skb_zcopy_pure(skb))) {
1325 if (!sk_wmem_schedule(sk, skb->data_len))
1326 goto wait_for_space;
1328 sk_mem_charge(sk, skb->data_len);
1329 skb_shinfo(skb)->flags &= ~SKBFL_PURE_ZEROCOPY;
1332 if (!sk_wmem_schedule(sk, copy))
1333 goto wait_for_space;
1335 err = skb_copy_to_page_nocache(sk, &msg->msg_iter, skb,
1342 /* Update the skb. */
1344 skb_frag_size_add(&skb_shinfo(skb)->frags[i - 1], copy);
1346 skb_fill_page_desc(skb, i, pfrag->page,
1347 pfrag->offset, copy);
1348 page_ref_inc(pfrag->page);
1350 pfrag->offset += copy;
1352 /* First append to a fragless skb builds initial
1356 skb_shinfo(skb)->flags |= SKBFL_PURE_ZEROCOPY;
1358 if (!skb_zcopy_pure(skb)) {
1359 if (!sk_wmem_schedule(sk, copy))
1360 goto wait_for_space;
1363 err = skb_zerocopy_iter_stream(sk, skb, msg, copy, uarg);
1364 if (err == -EMSGSIZE || err == -EEXIST) {
1365 tcp_mark_push(tp, skb);
1374 TCP_SKB_CB(skb)->tcp_flags &= ~TCPHDR_PSH;
1376 WRITE_ONCE(tp->write_seq, tp->write_seq + copy);
1377 TCP_SKB_CB(skb)->end_seq += copy;
1378 tcp_skb_pcount_set(skb, 0);
1381 if (!msg_data_left(msg)) {
1382 if (unlikely(flags & MSG_EOR))
1383 TCP_SKB_CB(skb)->eor = 1;
1387 if (skb->len < size_goal || (flags & MSG_OOB) || unlikely(tp->repair))
1390 if (forced_push(tp)) {
1391 tcp_mark_push(tp, skb);
1392 __tcp_push_pending_frames(sk, mss_now, TCP_NAGLE_PUSH);
1393 } else if (skb == tcp_send_head(sk))
1394 tcp_push_one(sk, mss_now);
1398 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1400 tcp_push(sk, flags & ~MSG_MORE, mss_now,
1401 TCP_NAGLE_PUSH, size_goal);
1403 err = sk_stream_wait_memory(sk, &timeo);
1407 mss_now = tcp_send_mss(sk, &size_goal, flags);
1412 tcp_tx_timestamp(sk, sockc.tsflags);
1413 tcp_push(sk, flags, mss_now, tp->nonagle, size_goal);
1416 net_zcopy_put(uarg);
1417 return copied + copied_syn;
1420 tcp_remove_empty_skb(sk);
1422 if (copied + copied_syn)
1425 net_zcopy_put_abort(uarg, true);
1426 err = sk_stream_error(sk, flags, err);
1427 /* make sure we wake any epoll edge trigger waiter */
1428 if (unlikely(tcp_rtx_and_write_queues_empty(sk) && err == -EAGAIN)) {
1429 sk->sk_write_space(sk);
1430 tcp_chrono_stop(sk, TCP_CHRONO_SNDBUF_LIMITED);
1434 EXPORT_SYMBOL_GPL(tcp_sendmsg_locked);
1436 int tcp_sendmsg(struct sock *sk, struct msghdr *msg, size_t size)
1441 ret = tcp_sendmsg_locked(sk, msg, size);
1446 EXPORT_SYMBOL(tcp_sendmsg);
1449 * Handle reading urgent data. BSD has very simple semantics for
1450 * this, no blocking and very strange errors 8)
1453 static int tcp_recv_urg(struct sock *sk, struct msghdr *msg, int len, int flags)
1455 struct tcp_sock *tp = tcp_sk(sk);
1457 /* No URG data to read. */
1458 if (sock_flag(sk, SOCK_URGINLINE) || !tp->urg_data ||
1459 tp->urg_data == TCP_URG_READ)
1460 return -EINVAL; /* Yes this is right ! */
1462 if (sk->sk_state == TCP_CLOSE && !sock_flag(sk, SOCK_DONE))
1465 if (tp->urg_data & TCP_URG_VALID) {
1467 char c = tp->urg_data;
1469 if (!(flags & MSG_PEEK))
1470 tp->urg_data = TCP_URG_READ;
1472 /* Read urgent data. */
1473 msg->msg_flags |= MSG_OOB;
1476 if (!(flags & MSG_TRUNC))
1477 err = memcpy_to_msg(msg, &c, 1);
1480 msg->msg_flags |= MSG_TRUNC;
1482 return err ? -EFAULT : len;
1485 if (sk->sk_state == TCP_CLOSE || (sk->sk_shutdown & RCV_SHUTDOWN))
1488 /* Fixed the recv(..., MSG_OOB) behaviour. BSD docs and
1489 * the available implementations agree in this case:
1490 * this call should never block, independent of the
1491 * blocking state of the socket.
1497 static int tcp_peek_sndq(struct sock *sk, struct msghdr *msg, int len)
1499 struct sk_buff *skb;
1500 int copied = 0, err = 0;
1502 /* XXX -- need to support SO_PEEK_OFF */
1504 skb_rbtree_walk(skb, &sk->tcp_rtx_queue) {
1505 err = skb_copy_datagram_msg(skb, 0, msg, skb->len);
1511 skb_queue_walk(&sk->sk_write_queue, skb) {
1512 err = skb_copy_datagram_msg(skb, 0, msg, skb->len);
1519 return err ?: copied;
1522 /* Clean up the receive buffer for full frames taken by the user,
1523 * then send an ACK if necessary. COPIED is the number of bytes
1524 * tcp_recvmsg has given to the user so far, it speeds up the
1525 * calculation of whether or not we must ACK for the sake of
1528 void tcp_cleanup_rbuf(struct sock *sk, int copied)
1530 struct tcp_sock *tp = tcp_sk(sk);
1531 bool time_to_ack = false;
1533 struct sk_buff *skb = skb_peek(&sk->sk_receive_queue);
1535 WARN(skb && !before(tp->copied_seq, TCP_SKB_CB(skb)->end_seq),
1536 "cleanup rbuf bug: copied %X seq %X rcvnxt %X\n",
1537 tp->copied_seq, TCP_SKB_CB(skb)->end_seq, tp->rcv_nxt);
1539 if (inet_csk_ack_scheduled(sk)) {
1540 const struct inet_connection_sock *icsk = inet_csk(sk);
1542 if (/* Once-per-two-segments ACK was not sent by tcp_input.c */
1543 tp->rcv_nxt - tp->rcv_wup > icsk->icsk_ack.rcv_mss ||
1545 * If this read emptied read buffer, we send ACK, if
1546 * connection is not bidirectional, user drained
1547 * receive buffer and there was a small segment
1551 ((icsk->icsk_ack.pending & ICSK_ACK_PUSHED2) ||
1552 ((icsk->icsk_ack.pending & ICSK_ACK_PUSHED) &&
1553 !inet_csk_in_pingpong_mode(sk))) &&
1554 !atomic_read(&sk->sk_rmem_alloc)))
1558 /* We send an ACK if we can now advertise a non-zero window
1559 * which has been raised "significantly".
1561 * Even if window raised up to infinity, do not send window open ACK
1562 * in states, where we will not receive more. It is useless.
1564 if (copied > 0 && !time_to_ack && !(sk->sk_shutdown & RCV_SHUTDOWN)) {
1565 __u32 rcv_window_now = tcp_receive_window(tp);
1567 /* Optimize, __tcp_select_window() is not cheap. */
1568 if (2*rcv_window_now <= tp->window_clamp) {
1569 __u32 new_window = __tcp_select_window(sk);
1571 /* Send ACK now, if this read freed lots of space
1572 * in our buffer. Certainly, new_window is new window.
1573 * We can advertise it now, if it is not less than current one.
1574 * "Lots" means "at least twice" here.
1576 if (new_window && new_window >= 2 * rcv_window_now)
1584 static struct sk_buff *tcp_recv_skb(struct sock *sk, u32 seq, u32 *off)
1586 struct sk_buff *skb;
1589 while ((skb = skb_peek(&sk->sk_receive_queue)) != NULL) {
1590 offset = seq - TCP_SKB_CB(skb)->seq;
1591 if (unlikely(TCP_SKB_CB(skb)->tcp_flags & TCPHDR_SYN)) {
1592 pr_err_once("%s: found a SYN, please report !\n", __func__);
1595 if (offset < skb->len || (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN)) {
1599 /* This looks weird, but this can happen if TCP collapsing
1600 * splitted a fat GRO packet, while we released socket lock
1601 * in skb_splice_bits()
1603 sk_eat_skb(sk, skb);
1609 * This routine provides an alternative to tcp_recvmsg() for routines
1610 * that would like to handle copying from skbuffs directly in 'sendfile'
1613 * - It is assumed that the socket was locked by the caller.
1614 * - The routine does not block.
1615 * - At present, there is no support for reading OOB data
1616 * or for 'peeking' the socket using this routine
1617 * (although both would be easy to implement).
1619 int tcp_read_sock(struct sock *sk, read_descriptor_t *desc,
1620 sk_read_actor_t recv_actor)
1622 struct sk_buff *skb;
1623 struct tcp_sock *tp = tcp_sk(sk);
1624 u32 seq = tp->copied_seq;
1628 if (sk->sk_state == TCP_LISTEN)
1630 while ((skb = tcp_recv_skb(sk, seq, &offset)) != NULL) {
1631 if (offset < skb->len) {
1635 len = skb->len - offset;
1636 /* Stop reading if we hit a patch of urgent data */
1638 u32 urg_offset = tp->urg_seq - seq;
1639 if (urg_offset < len)
1644 used = recv_actor(desc, skb, offset, len);
1649 } else if (used <= len) {
1654 /* If recv_actor drops the lock (e.g. TCP splice
1655 * receive) the skb pointer might be invalid when
1656 * getting here: tcp_collapse might have deleted it
1657 * while aggregating skbs from the socket queue.
1659 skb = tcp_recv_skb(sk, seq - 1, &offset);
1662 /* TCP coalescing might have appended data to the skb.
1663 * Try to splice more frags
1665 if (offset + 1 != skb->len)
1668 if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN) {
1669 sk_eat_skb(sk, skb);
1673 sk_eat_skb(sk, skb);
1676 WRITE_ONCE(tp->copied_seq, seq);
1678 WRITE_ONCE(tp->copied_seq, seq);
1680 tcp_rcv_space_adjust(sk);
1682 /* Clean up data we have read: This will do ACK frames. */
1684 tcp_recv_skb(sk, seq, &offset);
1685 tcp_cleanup_rbuf(sk, copied);
1689 EXPORT_SYMBOL(tcp_read_sock);
1691 int tcp_peek_len(struct socket *sock)
1693 return tcp_inq(sock->sk);
1695 EXPORT_SYMBOL(tcp_peek_len);
1697 /* Make sure sk_rcvbuf is big enough to satisfy SO_RCVLOWAT hint */
1698 int tcp_set_rcvlowat(struct sock *sk, int val)
1702 if (sk->sk_userlocks & SOCK_RCVBUF_LOCK)
1703 cap = sk->sk_rcvbuf >> 1;
1705 cap = sock_net(sk)->ipv4.sysctl_tcp_rmem[2] >> 1;
1706 val = min(val, cap);
1707 WRITE_ONCE(sk->sk_rcvlowat, val ? : 1);
1709 /* Check if we need to signal EPOLLIN right now */
1712 if (sk->sk_userlocks & SOCK_RCVBUF_LOCK)
1716 if (val > sk->sk_rcvbuf) {
1717 WRITE_ONCE(sk->sk_rcvbuf, val);
1718 tcp_sk(sk)->window_clamp = tcp_win_from_space(sk, val);
1722 EXPORT_SYMBOL(tcp_set_rcvlowat);
1724 void tcp_update_recv_tstamps(struct sk_buff *skb,
1725 struct scm_timestamping_internal *tss)
1728 tss->ts[0] = ktime_to_timespec64(skb->tstamp);
1730 tss->ts[0] = (struct timespec64) {0};
1732 if (skb_hwtstamps(skb)->hwtstamp)
1733 tss->ts[2] = ktime_to_timespec64(skb_hwtstamps(skb)->hwtstamp);
1735 tss->ts[2] = (struct timespec64) {0};
1739 static const struct vm_operations_struct tcp_vm_ops = {
1742 int tcp_mmap(struct file *file, struct socket *sock,
1743 struct vm_area_struct *vma)
1745 if (vma->vm_flags & (VM_WRITE | VM_EXEC))
1747 vma->vm_flags &= ~(VM_MAYWRITE | VM_MAYEXEC);
1749 /* Instruct vm_insert_page() to not mmap_read_lock(mm) */
1750 vma->vm_flags |= VM_MIXEDMAP;
1752 vma->vm_ops = &tcp_vm_ops;
1755 EXPORT_SYMBOL(tcp_mmap);
1757 static skb_frag_t *skb_advance_to_frag(struct sk_buff *skb, u32 offset_skb,
1762 offset_skb -= skb_headlen(skb);
1763 if ((int)offset_skb < 0 || skb_has_frag_list(skb))
1766 frag = skb_shinfo(skb)->frags;
1767 while (offset_skb) {
1768 if (skb_frag_size(frag) > offset_skb) {
1769 *offset_frag = offset_skb;
1772 offset_skb -= skb_frag_size(frag);
1779 static bool can_map_frag(const skb_frag_t *frag)
1781 return skb_frag_size(frag) == PAGE_SIZE && !skb_frag_off(frag);
1784 static int find_next_mappable_frag(const skb_frag_t *frag,
1785 int remaining_in_skb)
1789 if (likely(can_map_frag(frag)))
1792 while (offset < remaining_in_skb && !can_map_frag(frag)) {
1793 offset += skb_frag_size(frag);
1799 static void tcp_zerocopy_set_hint_for_skb(struct sock *sk,
1800 struct tcp_zerocopy_receive *zc,
1801 struct sk_buff *skb, u32 offset)
1803 u32 frag_offset, partial_frag_remainder = 0;
1804 int mappable_offset;
1807 /* worst case: skip to next skb. try to improve on this case below */
1808 zc->recv_skip_hint = skb->len - offset;
1810 /* Find the frag containing this offset (and how far into that frag) */
1811 frag = skb_advance_to_frag(skb, offset, &frag_offset);
1816 struct skb_shared_info *info = skb_shinfo(skb);
1818 /* We read part of the last frag, must recvmsg() rest of skb. */
1819 if (frag == &info->frags[info->nr_frags - 1])
1822 /* Else, we must at least read the remainder in this frag. */
1823 partial_frag_remainder = skb_frag_size(frag) - frag_offset;
1824 zc->recv_skip_hint -= partial_frag_remainder;
1828 /* partial_frag_remainder: If part way through a frag, must read rest.
1829 * mappable_offset: Bytes till next mappable frag, *not* counting bytes
1830 * in partial_frag_remainder.
1832 mappable_offset = find_next_mappable_frag(frag, zc->recv_skip_hint);
1833 zc->recv_skip_hint = mappable_offset + partial_frag_remainder;
1836 static int tcp_recvmsg_locked(struct sock *sk, struct msghdr *msg, size_t len,
1837 int nonblock, int flags,
1838 struct scm_timestamping_internal *tss,
1840 static int receive_fallback_to_copy(struct sock *sk,
1841 struct tcp_zerocopy_receive *zc, int inq,
1842 struct scm_timestamping_internal *tss)
1844 unsigned long copy_address = (unsigned long)zc->copybuf_address;
1845 struct msghdr msg = {};
1850 zc->recv_skip_hint = 0;
1852 if (copy_address != zc->copybuf_address)
1855 err = import_single_range(READ, (void __user *)copy_address,
1856 inq, &iov, &msg.msg_iter);
1860 err = tcp_recvmsg_locked(sk, &msg, inq, /*nonblock=*/1, /*flags=*/0,
1861 tss, &zc->msg_flags);
1865 zc->copybuf_len = err;
1866 if (likely(zc->copybuf_len)) {
1867 struct sk_buff *skb;
1870 skb = tcp_recv_skb(sk, tcp_sk(sk)->copied_seq, &offset);
1872 tcp_zerocopy_set_hint_for_skb(sk, zc, skb, offset);
1877 static int tcp_copy_straggler_data(struct tcp_zerocopy_receive *zc,
1878 struct sk_buff *skb, u32 copylen,
1879 u32 *offset, u32 *seq)
1881 unsigned long copy_address = (unsigned long)zc->copybuf_address;
1882 struct msghdr msg = {};
1886 if (copy_address != zc->copybuf_address)
1889 err = import_single_range(READ, (void __user *)copy_address,
1890 copylen, &iov, &msg.msg_iter);
1893 err = skb_copy_datagram_msg(skb, *offset, &msg, copylen);
1896 zc->recv_skip_hint -= copylen;
1899 return (__s32)copylen;
1902 static int tcp_zc_handle_leftover(struct tcp_zerocopy_receive *zc,
1904 struct sk_buff *skb,
1907 struct scm_timestamping_internal *tss)
1909 u32 offset, copylen = min_t(u32, copybuf_len, zc->recv_skip_hint);
1913 /* skb is null if inq < PAGE_SIZE. */
1915 offset = *seq - TCP_SKB_CB(skb)->seq;
1917 skb = tcp_recv_skb(sk, *seq, &offset);
1918 if (TCP_SKB_CB(skb)->has_rxtstamp) {
1919 tcp_update_recv_tstamps(skb, tss);
1920 zc->msg_flags |= TCP_CMSG_TS;
1924 zc->copybuf_len = tcp_copy_straggler_data(zc, skb, copylen, &offset,
1926 return zc->copybuf_len < 0 ? 0 : copylen;
1929 static int tcp_zerocopy_vm_insert_batch_error(struct vm_area_struct *vma,
1930 struct page **pending_pages,
1931 unsigned long pages_remaining,
1932 unsigned long *address,
1935 struct tcp_zerocopy_receive *zc,
1936 u32 total_bytes_to_map,
1939 /* At least one page did not map. Try zapping if we skipped earlier. */
1940 if (err == -EBUSY &&
1941 zc->flags & TCP_RECEIVE_ZEROCOPY_FLAG_TLB_CLEAN_HINT) {
1944 maybe_zap_len = total_bytes_to_map - /* All bytes to map */
1945 *length + /* Mapped or pending */
1946 (pages_remaining * PAGE_SIZE); /* Failed map. */
1947 zap_page_range(vma, *address, maybe_zap_len);
1952 unsigned long leftover_pages = pages_remaining;
1955 /* We called zap_page_range, try to reinsert. */
1956 err = vm_insert_pages(vma, *address,
1959 bytes_mapped = PAGE_SIZE * (leftover_pages - pages_remaining);
1960 *seq += bytes_mapped;
1961 *address += bytes_mapped;
1964 /* Either we were unable to zap, OR we zapped, retried an
1965 * insert, and still had an issue. Either ways, pages_remaining
1966 * is the number of pages we were unable to map, and we unroll
1967 * some state we speculatively touched before.
1969 const int bytes_not_mapped = PAGE_SIZE * pages_remaining;
1971 *length -= bytes_not_mapped;
1972 zc->recv_skip_hint += bytes_not_mapped;
1977 static int tcp_zerocopy_vm_insert_batch(struct vm_area_struct *vma,
1978 struct page **pages,
1979 unsigned int pages_to_map,
1980 unsigned long *address,
1983 struct tcp_zerocopy_receive *zc,
1984 u32 total_bytes_to_map)
1986 unsigned long pages_remaining = pages_to_map;
1987 unsigned int pages_mapped;
1988 unsigned int bytes_mapped;
1991 err = vm_insert_pages(vma, *address, pages, &pages_remaining);
1992 pages_mapped = pages_to_map - (unsigned int)pages_remaining;
1993 bytes_mapped = PAGE_SIZE * pages_mapped;
1994 /* Even if vm_insert_pages fails, it may have partially succeeded in
1995 * mapping (some but not all of the pages).
1997 *seq += bytes_mapped;
1998 *address += bytes_mapped;
2003 /* Error: maybe zap and retry + rollback state for failed inserts. */
2004 return tcp_zerocopy_vm_insert_batch_error(vma, pages + pages_mapped,
2005 pages_remaining, address, length, seq, zc, total_bytes_to_map,
2009 #define TCP_VALID_ZC_MSG_FLAGS (TCP_CMSG_TS)
2010 static void tcp_zc_finalize_rx_tstamp(struct sock *sk,
2011 struct tcp_zerocopy_receive *zc,
2012 struct scm_timestamping_internal *tss)
2014 unsigned long msg_control_addr;
2015 struct msghdr cmsg_dummy;
2017 msg_control_addr = (unsigned long)zc->msg_control;
2018 cmsg_dummy.msg_control = (void *)msg_control_addr;
2019 cmsg_dummy.msg_controllen =
2020 (__kernel_size_t)zc->msg_controllen;
2021 cmsg_dummy.msg_flags = in_compat_syscall()
2022 ? MSG_CMSG_COMPAT : 0;
2023 cmsg_dummy.msg_control_is_user = true;
2025 if (zc->msg_control == msg_control_addr &&
2026 zc->msg_controllen == cmsg_dummy.msg_controllen) {
2027 tcp_recv_timestamp(&cmsg_dummy, sk, tss);
2028 zc->msg_control = (__u64)
2029 ((uintptr_t)cmsg_dummy.msg_control);
2030 zc->msg_controllen =
2031 (__u64)cmsg_dummy.msg_controllen;
2032 zc->msg_flags = (__u32)cmsg_dummy.msg_flags;
2036 #define TCP_ZEROCOPY_PAGE_BATCH_SIZE 32
2037 static int tcp_zerocopy_receive(struct sock *sk,
2038 struct tcp_zerocopy_receive *zc,
2039 struct scm_timestamping_internal *tss)
2041 u32 length = 0, offset, vma_len, avail_len, copylen = 0;
2042 unsigned long address = (unsigned long)zc->address;
2043 struct page *pages[TCP_ZEROCOPY_PAGE_BATCH_SIZE];
2044 s32 copybuf_len = zc->copybuf_len;
2045 struct tcp_sock *tp = tcp_sk(sk);
2046 const skb_frag_t *frags = NULL;
2047 unsigned int pages_to_map = 0;
2048 struct vm_area_struct *vma;
2049 struct sk_buff *skb = NULL;
2050 u32 seq = tp->copied_seq;
2051 u32 total_bytes_to_map;
2052 int inq = tcp_inq(sk);
2055 zc->copybuf_len = 0;
2058 if (address & (PAGE_SIZE - 1) || address != zc->address)
2061 if (sk->sk_state == TCP_LISTEN)
2064 sock_rps_record_flow(sk);
2066 if (inq && inq <= copybuf_len)
2067 return receive_fallback_to_copy(sk, zc, inq, tss);
2069 if (inq < PAGE_SIZE) {
2071 zc->recv_skip_hint = inq;
2072 if (!inq && sock_flag(sk, SOCK_DONE))
2077 mmap_read_lock(current->mm);
2079 vma = vma_lookup(current->mm, address);
2080 if (!vma || vma->vm_ops != &tcp_vm_ops) {
2081 mmap_read_unlock(current->mm);
2084 vma_len = min_t(unsigned long, zc->length, vma->vm_end - address);
2085 avail_len = min_t(u32, vma_len, inq);
2086 total_bytes_to_map = avail_len & ~(PAGE_SIZE - 1);
2087 if (total_bytes_to_map) {
2088 if (!(zc->flags & TCP_RECEIVE_ZEROCOPY_FLAG_TLB_CLEAN_HINT))
2089 zap_page_range(vma, address, total_bytes_to_map);
2090 zc->length = total_bytes_to_map;
2091 zc->recv_skip_hint = 0;
2093 zc->length = avail_len;
2094 zc->recv_skip_hint = avail_len;
2097 while (length + PAGE_SIZE <= zc->length) {
2098 int mappable_offset;
2101 if (zc->recv_skip_hint < PAGE_SIZE) {
2105 if (zc->recv_skip_hint > 0)
2108 offset = seq - TCP_SKB_CB(skb)->seq;
2110 skb = tcp_recv_skb(sk, seq, &offset);
2113 if (TCP_SKB_CB(skb)->has_rxtstamp) {
2114 tcp_update_recv_tstamps(skb, tss);
2115 zc->msg_flags |= TCP_CMSG_TS;
2117 zc->recv_skip_hint = skb->len - offset;
2118 frags = skb_advance_to_frag(skb, offset, &offset_frag);
2119 if (!frags || offset_frag)
2123 mappable_offset = find_next_mappable_frag(frags,
2124 zc->recv_skip_hint);
2125 if (mappable_offset) {
2126 zc->recv_skip_hint = mappable_offset;
2129 page = skb_frag_page(frags);
2131 pages[pages_to_map++] = page;
2132 length += PAGE_SIZE;
2133 zc->recv_skip_hint -= PAGE_SIZE;
2135 if (pages_to_map == TCP_ZEROCOPY_PAGE_BATCH_SIZE ||
2136 zc->recv_skip_hint < PAGE_SIZE) {
2137 /* Either full batch, or we're about to go to next skb
2138 * (and we cannot unroll failed ops across skbs).
2140 ret = tcp_zerocopy_vm_insert_batch(vma, pages,
2144 total_bytes_to_map);
2151 ret = tcp_zerocopy_vm_insert_batch(vma, pages, pages_to_map,
2152 &address, &length, &seq,
2153 zc, total_bytes_to_map);
2156 mmap_read_unlock(current->mm);
2157 /* Try to copy straggler data. */
2159 copylen = tcp_zc_handle_leftover(zc, sk, skb, &seq, copybuf_len, tss);
2161 if (length + copylen) {
2162 WRITE_ONCE(tp->copied_seq, seq);
2163 tcp_rcv_space_adjust(sk);
2165 /* Clean up data we have read: This will do ACK frames. */
2166 tcp_recv_skb(sk, seq, &offset);
2167 tcp_cleanup_rbuf(sk, length + copylen);
2169 if (length == zc->length)
2170 zc->recv_skip_hint = 0;
2172 if (!zc->recv_skip_hint && sock_flag(sk, SOCK_DONE))
2175 zc->length = length;
2180 /* Similar to __sock_recv_timestamp, but does not require an skb */
2181 void tcp_recv_timestamp(struct msghdr *msg, const struct sock *sk,
2182 struct scm_timestamping_internal *tss)
2184 int new_tstamp = sock_flag(sk, SOCK_TSTAMP_NEW);
2185 bool has_timestamping = false;
2187 if (tss->ts[0].tv_sec || tss->ts[0].tv_nsec) {
2188 if (sock_flag(sk, SOCK_RCVTSTAMP)) {
2189 if (sock_flag(sk, SOCK_RCVTSTAMPNS)) {
2191 struct __kernel_timespec kts = {
2192 .tv_sec = tss->ts[0].tv_sec,
2193 .tv_nsec = tss->ts[0].tv_nsec,
2195 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMPNS_NEW,
2198 struct __kernel_old_timespec ts_old = {
2199 .tv_sec = tss->ts[0].tv_sec,
2200 .tv_nsec = tss->ts[0].tv_nsec,
2202 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMPNS_OLD,
2203 sizeof(ts_old), &ts_old);
2207 struct __kernel_sock_timeval stv = {
2208 .tv_sec = tss->ts[0].tv_sec,
2209 .tv_usec = tss->ts[0].tv_nsec / 1000,
2211 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMP_NEW,
2214 struct __kernel_old_timeval tv = {
2215 .tv_sec = tss->ts[0].tv_sec,
2216 .tv_usec = tss->ts[0].tv_nsec / 1000,
2218 put_cmsg(msg, SOL_SOCKET, SO_TIMESTAMP_OLD,
2224 if (sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE)
2225 has_timestamping = true;
2227 tss->ts[0] = (struct timespec64) {0};
2230 if (tss->ts[2].tv_sec || tss->ts[2].tv_nsec) {
2231 if (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)
2232 has_timestamping = true;
2234 tss->ts[2] = (struct timespec64) {0};
2237 if (has_timestamping) {
2238 tss->ts[1] = (struct timespec64) {0};
2239 if (sock_flag(sk, SOCK_TSTAMP_NEW))
2240 put_cmsg_scm_timestamping64(msg, tss);
2242 put_cmsg_scm_timestamping(msg, tss);
2246 static int tcp_inq_hint(struct sock *sk)
2248 const struct tcp_sock *tp = tcp_sk(sk);
2249 u32 copied_seq = READ_ONCE(tp->copied_seq);
2250 u32 rcv_nxt = READ_ONCE(tp->rcv_nxt);
2253 inq = rcv_nxt - copied_seq;
2254 if (unlikely(inq < 0 || copied_seq != READ_ONCE(tp->copied_seq))) {
2256 inq = tp->rcv_nxt - tp->copied_seq;
2259 /* After receiving a FIN, tell the user-space to continue reading
2260 * by returning a non-zero inq.
2262 if (inq == 0 && sock_flag(sk, SOCK_DONE))
2268 * This routine copies from a sock struct into the user buffer.
2270 * Technical note: in 2.3 we work on _locked_ socket, so that
2271 * tricks with *seq access order and skb->users are not required.
2272 * Probably, code can be easily improved even more.
2275 static int tcp_recvmsg_locked(struct sock *sk, struct msghdr *msg, size_t len,
2276 int nonblock, int flags,
2277 struct scm_timestamping_internal *tss,
2280 struct tcp_sock *tp = tcp_sk(sk);
2286 int target; /* Read at least this many bytes */
2288 struct sk_buff *skb, *last;
2292 if (sk->sk_state == TCP_LISTEN)
2295 if (tp->recvmsg_inq)
2296 *cmsg_flags = TCP_CMSG_INQ;
2297 timeo = sock_rcvtimeo(sk, nonblock);
2299 /* Urgent data needs to be handled specially. */
2300 if (flags & MSG_OOB)
2303 if (unlikely(tp->repair)) {
2305 if (!(flags & MSG_PEEK))
2308 if (tp->repair_queue == TCP_SEND_QUEUE)
2312 if (tp->repair_queue == TCP_NO_QUEUE)
2315 /* 'common' recv queue MSG_PEEK-ing */
2318 seq = &tp->copied_seq;
2319 if (flags & MSG_PEEK) {
2320 peek_seq = tp->copied_seq;
2324 target = sock_rcvlowat(sk, flags & MSG_WAITALL, len);
2329 /* Are we at urgent data? Stop if we have read anything or have SIGURG pending. */
2330 if (tp->urg_data && tp->urg_seq == *seq) {
2333 if (signal_pending(current)) {
2334 copied = timeo ? sock_intr_errno(timeo) : -EAGAIN;
2339 /* Next get a buffer. */
2341 last = skb_peek_tail(&sk->sk_receive_queue);
2342 skb_queue_walk(&sk->sk_receive_queue, skb) {
2344 /* Now that we have two receive queues this
2347 if (WARN(before(*seq, TCP_SKB_CB(skb)->seq),
2348 "TCP recvmsg seq # bug: copied %X, seq %X, rcvnxt %X, fl %X\n",
2349 *seq, TCP_SKB_CB(skb)->seq, tp->rcv_nxt,
2353 offset = *seq - TCP_SKB_CB(skb)->seq;
2354 if (unlikely(TCP_SKB_CB(skb)->tcp_flags & TCPHDR_SYN)) {
2355 pr_err_once("%s: found a SYN, please report !\n", __func__);
2358 if (offset < skb->len)
2360 if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN)
2362 WARN(!(flags & MSG_PEEK),
2363 "TCP recvmsg seq # bug 2: copied %X, seq %X, rcvnxt %X, fl %X\n",
2364 *seq, TCP_SKB_CB(skb)->seq, tp->rcv_nxt, flags);
2367 /* Well, if we have backlog, try to process it now yet. */
2369 if (copied >= target && !READ_ONCE(sk->sk_backlog.tail))
2374 sk->sk_state == TCP_CLOSE ||
2375 (sk->sk_shutdown & RCV_SHUTDOWN) ||
2377 signal_pending(current))
2380 if (sock_flag(sk, SOCK_DONE))
2384 copied = sock_error(sk);
2388 if (sk->sk_shutdown & RCV_SHUTDOWN)
2391 if (sk->sk_state == TCP_CLOSE) {
2392 /* This occurs when user tries to read
2393 * from never connected socket.
2404 if (signal_pending(current)) {
2405 copied = sock_intr_errno(timeo);
2410 tcp_cleanup_rbuf(sk, copied);
2412 if (copied >= target) {
2413 /* Do not sleep, just process backlog. */
2417 sk_wait_data(sk, &timeo, last);
2420 if ((flags & MSG_PEEK) &&
2421 (peek_seq - copied - urg_hole != tp->copied_seq)) {
2422 net_dbg_ratelimited("TCP(%s:%d): Application bug, race in MSG_PEEK\n",
2424 task_pid_nr(current));
2425 peek_seq = tp->copied_seq;
2430 /* Ok so how much can we use? */
2431 used = skb->len - offset;
2435 /* Do we have urgent data here? */
2437 u32 urg_offset = tp->urg_seq - *seq;
2438 if (urg_offset < used) {
2440 if (!sock_flag(sk, SOCK_URGINLINE)) {
2441 WRITE_ONCE(*seq, *seq + 1);
2453 if (!(flags & MSG_TRUNC)) {
2454 err = skb_copy_datagram_msg(skb, offset, msg, used);
2456 /* Exception. Bailout! */
2463 WRITE_ONCE(*seq, *seq + used);
2467 tcp_rcv_space_adjust(sk);
2470 if (tp->urg_data && after(tp->copied_seq, tp->urg_seq)) {
2472 tcp_fast_path_check(sk);
2475 if (TCP_SKB_CB(skb)->has_rxtstamp) {
2476 tcp_update_recv_tstamps(skb, tss);
2477 *cmsg_flags |= TCP_CMSG_TS;
2480 if (used + offset < skb->len)
2483 if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN)
2485 if (!(flags & MSG_PEEK))
2486 sk_eat_skb(sk, skb);
2490 /* Process the FIN. */
2491 WRITE_ONCE(*seq, *seq + 1);
2492 if (!(flags & MSG_PEEK))
2493 sk_eat_skb(sk, skb);
2497 /* According to UNIX98, msg_name/msg_namelen are ignored
2498 * on connected socket. I was just happy when found this 8) --ANK
2501 /* Clean up data we have read: This will do ACK frames. */
2502 tcp_cleanup_rbuf(sk, copied);
2509 err = tcp_recv_urg(sk, msg, len, flags);
2513 err = tcp_peek_sndq(sk, msg, len);
2517 int tcp_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int nonblock,
2518 int flags, int *addr_len)
2520 int cmsg_flags = 0, ret, inq;
2521 struct scm_timestamping_internal tss;
2523 if (unlikely(flags & MSG_ERRQUEUE))
2524 return inet_recv_error(sk, msg, len, addr_len);
2526 if (sk_can_busy_loop(sk) &&
2527 skb_queue_empty_lockless(&sk->sk_receive_queue) &&
2528 sk->sk_state == TCP_ESTABLISHED)
2529 sk_busy_loop(sk, nonblock);
2532 ret = tcp_recvmsg_locked(sk, msg, len, nonblock, flags, &tss,
2536 if (cmsg_flags && ret >= 0) {
2537 if (cmsg_flags & TCP_CMSG_TS)
2538 tcp_recv_timestamp(msg, sk, &tss);
2539 if (cmsg_flags & TCP_CMSG_INQ) {
2540 inq = tcp_inq_hint(sk);
2541 put_cmsg(msg, SOL_TCP, TCP_CM_INQ, sizeof(inq), &inq);
2546 EXPORT_SYMBOL(tcp_recvmsg);
2548 void tcp_set_state(struct sock *sk, int state)
2550 int oldstate = sk->sk_state;
2552 /* We defined a new enum for TCP states that are exported in BPF
2553 * so as not force the internal TCP states to be frozen. The
2554 * following checks will detect if an internal state value ever
2555 * differs from the BPF value. If this ever happens, then we will
2556 * need to remap the internal value to the BPF value before calling
2557 * tcp_call_bpf_2arg.
2559 BUILD_BUG_ON((int)BPF_TCP_ESTABLISHED != (int)TCP_ESTABLISHED);
2560 BUILD_BUG_ON((int)BPF_TCP_SYN_SENT != (int)TCP_SYN_SENT);
2561 BUILD_BUG_ON((int)BPF_TCP_SYN_RECV != (int)TCP_SYN_RECV);
2562 BUILD_BUG_ON((int)BPF_TCP_FIN_WAIT1 != (int)TCP_FIN_WAIT1);
2563 BUILD_BUG_ON((int)BPF_TCP_FIN_WAIT2 != (int)TCP_FIN_WAIT2);
2564 BUILD_BUG_ON((int)BPF_TCP_TIME_WAIT != (int)TCP_TIME_WAIT);
2565 BUILD_BUG_ON((int)BPF_TCP_CLOSE != (int)TCP_CLOSE);
2566 BUILD_BUG_ON((int)BPF_TCP_CLOSE_WAIT != (int)TCP_CLOSE_WAIT);
2567 BUILD_BUG_ON((int)BPF_TCP_LAST_ACK != (int)TCP_LAST_ACK);
2568 BUILD_BUG_ON((int)BPF_TCP_LISTEN != (int)TCP_LISTEN);
2569 BUILD_BUG_ON((int)BPF_TCP_CLOSING != (int)TCP_CLOSING);
2570 BUILD_BUG_ON((int)BPF_TCP_NEW_SYN_RECV != (int)TCP_NEW_SYN_RECV);
2571 BUILD_BUG_ON((int)BPF_TCP_MAX_STATES != (int)TCP_MAX_STATES);
2573 /* bpf uapi header bpf.h defines an anonymous enum with values
2574 * BPF_TCP_* used by bpf programs. Currently gcc built vmlinux
2575 * is able to emit this enum in DWARF due to the above BUILD_BUG_ON.
2576 * But clang built vmlinux does not have this enum in DWARF
2577 * since clang removes the above code before generating IR/debuginfo.
2578 * Let us explicitly emit the type debuginfo to ensure the
2579 * above-mentioned anonymous enum in the vmlinux DWARF and hence BTF
2580 * regardless of which compiler is used.
2582 BTF_TYPE_EMIT_ENUM(BPF_TCP_ESTABLISHED);
2584 if (BPF_SOCK_OPS_TEST_FLAG(tcp_sk(sk), BPF_SOCK_OPS_STATE_CB_FLAG))
2585 tcp_call_bpf_2arg(sk, BPF_SOCK_OPS_STATE_CB, oldstate, state);
2588 case TCP_ESTABLISHED:
2589 if (oldstate != TCP_ESTABLISHED)
2590 TCP_INC_STATS(sock_net(sk), TCP_MIB_CURRESTAB);
2594 if (oldstate == TCP_CLOSE_WAIT || oldstate == TCP_ESTABLISHED)
2595 TCP_INC_STATS(sock_net(sk), TCP_MIB_ESTABRESETS);
2597 sk->sk_prot->unhash(sk);
2598 if (inet_csk(sk)->icsk_bind_hash &&
2599 !(sk->sk_userlocks & SOCK_BINDPORT_LOCK))
2603 if (oldstate == TCP_ESTABLISHED)
2604 TCP_DEC_STATS(sock_net(sk), TCP_MIB_CURRESTAB);
2607 /* Change state AFTER socket is unhashed to avoid closed
2608 * socket sitting in hash tables.
2610 inet_sk_state_store(sk, state);
2612 EXPORT_SYMBOL_GPL(tcp_set_state);
2615 * State processing on a close. This implements the state shift for
2616 * sending our FIN frame. Note that we only send a FIN for some
2617 * states. A shutdown() may have already sent the FIN, or we may be
2621 static const unsigned char new_state[16] = {
2622 /* current state: new state: action: */
2623 [0 /* (Invalid) */] = TCP_CLOSE,
2624 [TCP_ESTABLISHED] = TCP_FIN_WAIT1 | TCP_ACTION_FIN,
2625 [TCP_SYN_SENT] = TCP_CLOSE,
2626 [TCP_SYN_RECV] = TCP_FIN_WAIT1 | TCP_ACTION_FIN,
2627 [TCP_FIN_WAIT1] = TCP_FIN_WAIT1,
2628 [TCP_FIN_WAIT2] = TCP_FIN_WAIT2,
2629 [TCP_TIME_WAIT] = TCP_CLOSE,
2630 [TCP_CLOSE] = TCP_CLOSE,
2631 [TCP_CLOSE_WAIT] = TCP_LAST_ACK | TCP_ACTION_FIN,
2632 [TCP_LAST_ACK] = TCP_LAST_ACK,
2633 [TCP_LISTEN] = TCP_CLOSE,
2634 [TCP_CLOSING] = TCP_CLOSING,
2635 [TCP_NEW_SYN_RECV] = TCP_CLOSE, /* should not happen ! */
2638 static int tcp_close_state(struct sock *sk)
2640 int next = (int)new_state[sk->sk_state];
2641 int ns = next & TCP_STATE_MASK;
2643 tcp_set_state(sk, ns);
2645 return next & TCP_ACTION_FIN;
2649 * Shutdown the sending side of a connection. Much like close except
2650 * that we don't receive shut down or sock_set_flag(sk, SOCK_DEAD).
2653 void tcp_shutdown(struct sock *sk, int how)
2655 /* We need to grab some memory, and put together a FIN,
2656 * and then put it into the queue to be sent.
2659 if (!(how & SEND_SHUTDOWN))
2662 /* If we've already sent a FIN, or it's a closed state, skip this. */
2663 if ((1 << sk->sk_state) &
2664 (TCPF_ESTABLISHED | TCPF_SYN_SENT |
2665 TCPF_SYN_RECV | TCPF_CLOSE_WAIT)) {
2666 /* Clear out any half completed packets. FIN if needed. */
2667 if (tcp_close_state(sk))
2671 EXPORT_SYMBOL(tcp_shutdown);
2673 int tcp_orphan_count_sum(void)
2677 for_each_possible_cpu(i)
2678 total += per_cpu(tcp_orphan_count, i);
2680 return max(total, 0);
2683 static int tcp_orphan_cache;
2684 static struct timer_list tcp_orphan_timer;
2685 #define TCP_ORPHAN_TIMER_PERIOD msecs_to_jiffies(100)
2687 static void tcp_orphan_update(struct timer_list *unused)
2689 WRITE_ONCE(tcp_orphan_cache, tcp_orphan_count_sum());
2690 mod_timer(&tcp_orphan_timer, jiffies + TCP_ORPHAN_TIMER_PERIOD);
2693 static bool tcp_too_many_orphans(int shift)
2695 return READ_ONCE(tcp_orphan_cache) << shift > sysctl_tcp_max_orphans;
2698 bool tcp_check_oom(struct sock *sk, int shift)
2700 bool too_many_orphans, out_of_socket_memory;
2702 too_many_orphans = tcp_too_many_orphans(shift);
2703 out_of_socket_memory = tcp_out_of_memory(sk);
2705 if (too_many_orphans)
2706 net_info_ratelimited("too many orphaned sockets\n");
2707 if (out_of_socket_memory)
2708 net_info_ratelimited("out of memory -- consider tuning tcp_mem\n");
2709 return too_many_orphans || out_of_socket_memory;
2712 void __tcp_close(struct sock *sk, long timeout)
2714 struct sk_buff *skb;
2715 int data_was_unread = 0;
2718 sk->sk_shutdown = SHUTDOWN_MASK;
2720 if (sk->sk_state == TCP_LISTEN) {
2721 tcp_set_state(sk, TCP_CLOSE);
2724 inet_csk_listen_stop(sk);
2726 goto adjudge_to_death;
2729 /* We need to flush the recv. buffs. We do this only on the
2730 * descriptor close, not protocol-sourced closes, because the
2731 * reader process may not have drained the data yet!
2733 while ((skb = __skb_dequeue(&sk->sk_receive_queue)) != NULL) {
2734 u32 len = TCP_SKB_CB(skb)->end_seq - TCP_SKB_CB(skb)->seq;
2736 if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN)
2738 data_was_unread += len;
2744 /* If socket has been already reset (e.g. in tcp_reset()) - kill it. */
2745 if (sk->sk_state == TCP_CLOSE)
2746 goto adjudge_to_death;
2748 /* As outlined in RFC 2525, section 2.17, we send a RST here because
2749 * data was lost. To witness the awful effects of the old behavior of
2750 * always doing a FIN, run an older 2.1.x kernel or 2.0.x, start a bulk
2751 * GET in an FTP client, suspend the process, wait for the client to
2752 * advertise a zero window, then kill -9 the FTP client, wheee...
2753 * Note: timeout is always zero in such a case.
2755 if (unlikely(tcp_sk(sk)->repair)) {
2756 sk->sk_prot->disconnect(sk, 0);
2757 } else if (data_was_unread) {
2758 /* Unread data was tossed, zap the connection. */
2759 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPABORTONCLOSE);
2760 tcp_set_state(sk, TCP_CLOSE);
2761 tcp_send_active_reset(sk, sk->sk_allocation);
2762 } else if (sock_flag(sk, SOCK_LINGER) && !sk->sk_lingertime) {
2763 /* Check zero linger _after_ checking for unread data. */
2764 sk->sk_prot->disconnect(sk, 0);
2765 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPABORTONDATA);
2766 } else if (tcp_close_state(sk)) {
2767 /* We FIN if the application ate all the data before
2768 * zapping the connection.
2771 /* RED-PEN. Formally speaking, we have broken TCP state
2772 * machine. State transitions:
2774 * TCP_ESTABLISHED -> TCP_FIN_WAIT1
2775 * TCP_SYN_RECV -> TCP_FIN_WAIT1 (forget it, it's impossible)
2776 * TCP_CLOSE_WAIT -> TCP_LAST_ACK
2778 * are legal only when FIN has been sent (i.e. in window),
2779 * rather than queued out of window. Purists blame.
2781 * F.e. "RFC state" is ESTABLISHED,
2782 * if Linux state is FIN-WAIT-1, but FIN is still not sent.
2784 * The visible declinations are that sometimes
2785 * we enter time-wait state, when it is not required really
2786 * (harmless), do not send active resets, when they are
2787 * required by specs (TCP_ESTABLISHED, TCP_CLOSE_WAIT, when
2788 * they look as CLOSING or LAST_ACK for Linux)
2789 * Probably, I missed some more holelets.
2791 * XXX (TFO) - To start off we don't support SYN+ACK+FIN
2792 * in a single packet! (May consider it later but will
2793 * probably need API support or TCP_CORK SYN-ACK until
2794 * data is written and socket is closed.)
2799 sk_stream_wait_close(sk, timeout);
2802 state = sk->sk_state;
2808 /* remove backlog if any, without releasing ownership. */
2811 this_cpu_inc(tcp_orphan_count);
2813 /* Have we already been destroyed by a softirq or backlog? */
2814 if (state != TCP_CLOSE && sk->sk_state == TCP_CLOSE)
2817 /* This is a (useful) BSD violating of the RFC. There is a
2818 * problem with TCP as specified in that the other end could
2819 * keep a socket open forever with no application left this end.
2820 * We use a 1 minute timeout (about the same as BSD) then kill
2821 * our end. If they send after that then tough - BUT: long enough
2822 * that we won't make the old 4*rto = almost no time - whoops
2825 * Nope, it was not mistake. It is really desired behaviour
2826 * f.e. on http servers, when such sockets are useless, but
2827 * consume significant resources. Let's do it with special
2828 * linger2 option. --ANK
2831 if (sk->sk_state == TCP_FIN_WAIT2) {
2832 struct tcp_sock *tp = tcp_sk(sk);
2833 if (tp->linger2 < 0) {
2834 tcp_set_state(sk, TCP_CLOSE);
2835 tcp_send_active_reset(sk, GFP_ATOMIC);
2836 __NET_INC_STATS(sock_net(sk),
2837 LINUX_MIB_TCPABORTONLINGER);
2839 const int tmo = tcp_fin_time(sk);
2841 if (tmo > TCP_TIMEWAIT_LEN) {
2842 inet_csk_reset_keepalive_timer(sk,
2843 tmo - TCP_TIMEWAIT_LEN);
2845 tcp_time_wait(sk, TCP_FIN_WAIT2, tmo);
2850 if (sk->sk_state != TCP_CLOSE) {
2852 if (tcp_check_oom(sk, 0)) {
2853 tcp_set_state(sk, TCP_CLOSE);
2854 tcp_send_active_reset(sk, GFP_ATOMIC);
2855 __NET_INC_STATS(sock_net(sk),
2856 LINUX_MIB_TCPABORTONMEMORY);
2857 } else if (!check_net(sock_net(sk))) {
2858 /* Not possible to send reset; just close */
2859 tcp_set_state(sk, TCP_CLOSE);
2863 if (sk->sk_state == TCP_CLOSE) {
2864 struct request_sock *req;
2866 req = rcu_dereference_protected(tcp_sk(sk)->fastopen_rsk,
2867 lockdep_sock_is_held(sk));
2868 /* We could get here with a non-NULL req if the socket is
2869 * aborted (e.g., closed with unread data) before 3WHS
2873 reqsk_fastopen_remove(sk, req, false);
2874 inet_csk_destroy_sock(sk);
2876 /* Otherwise, socket is reprieved until protocol close. */
2883 void tcp_close(struct sock *sk, long timeout)
2886 __tcp_close(sk, timeout);
2890 EXPORT_SYMBOL(tcp_close);
2892 /* These states need RST on ABORT according to RFC793 */
2894 static inline bool tcp_need_reset(int state)
2896 return (1 << state) &
2897 (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT | TCPF_FIN_WAIT1 |
2898 TCPF_FIN_WAIT2 | TCPF_SYN_RECV);
2901 static void tcp_rtx_queue_purge(struct sock *sk)
2903 struct rb_node *p = rb_first(&sk->tcp_rtx_queue);
2905 tcp_sk(sk)->highest_sack = NULL;
2907 struct sk_buff *skb = rb_to_skb(p);
2910 /* Since we are deleting whole queue, no need to
2911 * list_del(&skb->tcp_tsorted_anchor)
2913 tcp_rtx_queue_unlink(skb, sk);
2914 tcp_wmem_free_skb(sk, skb);
2918 void tcp_write_queue_purge(struct sock *sk)
2920 struct sk_buff *skb;
2922 tcp_chrono_stop(sk, TCP_CHRONO_BUSY);
2923 while ((skb = __skb_dequeue(&sk->sk_write_queue)) != NULL) {
2924 tcp_skb_tsorted_anchor_cleanup(skb);
2925 tcp_wmem_free_skb(sk, skb);
2927 tcp_rtx_queue_purge(sk);
2928 INIT_LIST_HEAD(&tcp_sk(sk)->tsorted_sent_queue);
2930 tcp_clear_all_retrans_hints(tcp_sk(sk));
2931 tcp_sk(sk)->packets_out = 0;
2932 inet_csk(sk)->icsk_backoff = 0;
2935 int tcp_disconnect(struct sock *sk, int flags)
2937 struct inet_sock *inet = inet_sk(sk);
2938 struct inet_connection_sock *icsk = inet_csk(sk);
2939 struct tcp_sock *tp = tcp_sk(sk);
2940 int old_state = sk->sk_state;
2943 if (old_state != TCP_CLOSE)
2944 tcp_set_state(sk, TCP_CLOSE);
2946 /* ABORT function of RFC793 */
2947 if (old_state == TCP_LISTEN) {
2948 inet_csk_listen_stop(sk);
2949 } else if (unlikely(tp->repair)) {
2950 sk->sk_err = ECONNABORTED;
2951 } else if (tcp_need_reset(old_state) ||
2952 (tp->snd_nxt != tp->write_seq &&
2953 (1 << old_state) & (TCPF_CLOSING | TCPF_LAST_ACK))) {
2954 /* The last check adjusts for discrepancy of Linux wrt. RFC
2957 tcp_send_active_reset(sk, gfp_any());
2958 sk->sk_err = ECONNRESET;
2959 } else if (old_state == TCP_SYN_SENT)
2960 sk->sk_err = ECONNRESET;
2962 tcp_clear_xmit_timers(sk);
2963 __skb_queue_purge(&sk->sk_receive_queue);
2964 WRITE_ONCE(tp->copied_seq, tp->rcv_nxt);
2966 tcp_write_queue_purge(sk);
2967 tcp_fastopen_active_disable_ofo_check(sk);
2968 skb_rbtree_purge(&tp->out_of_order_queue);
2970 inet->inet_dport = 0;
2972 if (!(sk->sk_userlocks & SOCK_BINDADDR_LOCK))
2973 inet_reset_saddr(sk);
2975 sk->sk_shutdown = 0;
2976 sock_reset_flag(sk, SOCK_DONE);
2978 tp->mdev_us = jiffies_to_usecs(TCP_TIMEOUT_INIT);
2979 tp->rcv_rtt_last_tsecr = 0;
2981 seq = tp->write_seq + tp->max_window + 2;
2984 WRITE_ONCE(tp->write_seq, seq);
2986 icsk->icsk_backoff = 0;
2987 icsk->icsk_probes_out = 0;
2988 icsk->icsk_probes_tstamp = 0;
2989 icsk->icsk_rto = TCP_TIMEOUT_INIT;
2990 icsk->icsk_rto_min = TCP_RTO_MIN;
2991 icsk->icsk_delack_max = TCP_DELACK_MAX;
2992 tp->snd_ssthresh = TCP_INFINITE_SSTHRESH;
2993 tp->snd_cwnd = TCP_INIT_CWND;
2994 tp->snd_cwnd_cnt = 0;
2995 tp->window_clamp = 0;
2997 tp->delivered_ce = 0;
2998 if (icsk->icsk_ca_ops->release)
2999 icsk->icsk_ca_ops->release(sk);
3000 memset(icsk->icsk_ca_priv, 0, sizeof(icsk->icsk_ca_priv));
3001 icsk->icsk_ca_initialized = 0;
3002 tcp_set_ca_state(sk, TCP_CA_Open);
3003 tp->is_sack_reneg = 0;
3004 tcp_clear_retrans(tp);
3005 tp->total_retrans = 0;
3006 inet_csk_delack_init(sk);
3007 /* Initialize rcv_mss to TCP_MIN_MSS to avoid division by 0
3008 * issue in __tcp_select_window()
3010 icsk->icsk_ack.rcv_mss = TCP_MIN_MSS;
3011 memset(&tp->rx_opt, 0, sizeof(tp->rx_opt));
3013 dst_release(sk->sk_rx_dst);
3014 sk->sk_rx_dst = NULL;
3015 tcp_saved_syn_free(tp);
3016 tp->compressed_ack = 0;
3020 tp->bytes_acked = 0;
3021 tp->bytes_received = 0;
3022 tp->bytes_retrans = 0;
3023 tp->data_segs_in = 0;
3024 tp->data_segs_out = 0;
3025 tp->duplicate_sack[0].start_seq = 0;
3026 tp->duplicate_sack[0].end_seq = 0;
3029 tp->retrans_out = 0;
3031 tp->tlp_high_seq = 0;
3032 tp->last_oow_ack_time = 0;
3033 /* There's a bubble in the pipe until at least the first ACK. */
3034 tp->app_limited = ~0U;
3035 tp->rack.mstamp = 0;
3036 tp->rack.advanced = 0;
3037 tp->rack.reo_wnd_steps = 1;
3038 tp->rack.last_delivered = 0;
3039 tp->rack.reo_wnd_persist = 0;
3040 tp->rack.dsack_seen = 0;
3041 tp->syn_data_acked = 0;
3042 tp->rx_opt.saw_tstamp = 0;
3043 tp->rx_opt.dsack = 0;
3044 tp->rx_opt.num_sacks = 0;
3045 tp->rcv_ooopack = 0;
3048 /* Clean up fastopen related fields */
3049 tcp_free_fastopen_req(tp);
3050 inet->defer_connect = 0;
3051 tp->fastopen_client_fail = 0;
3053 WARN_ON(inet->inet_num && !icsk->icsk_bind_hash);
3055 if (sk->sk_frag.page) {
3056 put_page(sk->sk_frag.page);
3057 sk->sk_frag.page = NULL;
3058 sk->sk_frag.offset = 0;
3061 sk_error_report(sk);
3064 EXPORT_SYMBOL(tcp_disconnect);
3066 static inline bool tcp_can_repair_sock(const struct sock *sk)
3068 return ns_capable(sock_net(sk)->user_ns, CAP_NET_ADMIN) &&
3069 (sk->sk_state != TCP_LISTEN);
3072 static int tcp_repair_set_window(struct tcp_sock *tp, sockptr_t optbuf, int len)
3074 struct tcp_repair_window opt;
3079 if (len != sizeof(opt))
3082 if (copy_from_sockptr(&opt, optbuf, sizeof(opt)))
3085 if (opt.max_window < opt.snd_wnd)
3088 if (after(opt.snd_wl1, tp->rcv_nxt + opt.rcv_wnd))
3091 if (after(opt.rcv_wup, tp->rcv_nxt))
3094 tp->snd_wl1 = opt.snd_wl1;
3095 tp->snd_wnd = opt.snd_wnd;
3096 tp->max_window = opt.max_window;
3098 tp->rcv_wnd = opt.rcv_wnd;
3099 tp->rcv_wup = opt.rcv_wup;
3104 static int tcp_repair_options_est(struct sock *sk, sockptr_t optbuf,
3107 struct tcp_sock *tp = tcp_sk(sk);
3108 struct tcp_repair_opt opt;
3111 while (len >= sizeof(opt)) {
3112 if (copy_from_sockptr_offset(&opt, optbuf, offset, sizeof(opt)))
3115 offset += sizeof(opt);
3118 switch (opt.opt_code) {
3120 tp->rx_opt.mss_clamp = opt.opt_val;
3125 u16 snd_wscale = opt.opt_val & 0xFFFF;
3126 u16 rcv_wscale = opt.opt_val >> 16;
3128 if (snd_wscale > TCP_MAX_WSCALE || rcv_wscale > TCP_MAX_WSCALE)
3131 tp->rx_opt.snd_wscale = snd_wscale;
3132 tp->rx_opt.rcv_wscale = rcv_wscale;
3133 tp->rx_opt.wscale_ok = 1;
3136 case TCPOPT_SACK_PERM:
3137 if (opt.opt_val != 0)
3140 tp->rx_opt.sack_ok |= TCP_SACK_SEEN;
3142 case TCPOPT_TIMESTAMP:
3143 if (opt.opt_val != 0)
3146 tp->rx_opt.tstamp_ok = 1;
3154 DEFINE_STATIC_KEY_FALSE(tcp_tx_delay_enabled);
3155 EXPORT_SYMBOL(tcp_tx_delay_enabled);
3157 static void tcp_enable_tx_delay(void)
3159 if (!static_branch_unlikely(&tcp_tx_delay_enabled)) {
3160 static int __tcp_tx_delay_enabled = 0;
3162 if (cmpxchg(&__tcp_tx_delay_enabled, 0, 1) == 0) {
3163 static_branch_enable(&tcp_tx_delay_enabled);
3164 pr_info("TCP_TX_DELAY enabled\n");
3169 /* When set indicates to always queue non-full frames. Later the user clears
3170 * this option and we transmit any pending partial frames in the queue. This is
3171 * meant to be used alongside sendfile() to get properly filled frames when the
3172 * user (for example) must write out headers with a write() call first and then
3173 * use sendfile to send out the data parts.
3175 * TCP_CORK can be set together with TCP_NODELAY and it is stronger than
3178 static void __tcp_sock_set_cork(struct sock *sk, bool on)
3180 struct tcp_sock *tp = tcp_sk(sk);
3183 tp->nonagle |= TCP_NAGLE_CORK;
3185 tp->nonagle &= ~TCP_NAGLE_CORK;
3186 if (tp->nonagle & TCP_NAGLE_OFF)
3187 tp->nonagle |= TCP_NAGLE_PUSH;
3188 tcp_push_pending_frames(sk);
3192 void tcp_sock_set_cork(struct sock *sk, bool on)
3195 __tcp_sock_set_cork(sk, on);
3198 EXPORT_SYMBOL(tcp_sock_set_cork);
3200 /* TCP_NODELAY is weaker than TCP_CORK, so that this option on corked socket is
3201 * remembered, but it is not activated until cork is cleared.
3203 * However, when TCP_NODELAY is set we make an explicit push, which overrides
3204 * even TCP_CORK for currently queued segments.
3206 static void __tcp_sock_set_nodelay(struct sock *sk, bool on)
3209 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF|TCP_NAGLE_PUSH;
3210 tcp_push_pending_frames(sk);
3212 tcp_sk(sk)->nonagle &= ~TCP_NAGLE_OFF;
3216 void tcp_sock_set_nodelay(struct sock *sk)
3219 __tcp_sock_set_nodelay(sk, true);
3222 EXPORT_SYMBOL(tcp_sock_set_nodelay);
3224 static void __tcp_sock_set_quickack(struct sock *sk, int val)
3227 inet_csk_enter_pingpong_mode(sk);
3231 inet_csk_exit_pingpong_mode(sk);
3232 if ((1 << sk->sk_state) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT) &&
3233 inet_csk_ack_scheduled(sk)) {
3234 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_PUSHED;
3235 tcp_cleanup_rbuf(sk, 1);
3237 inet_csk_enter_pingpong_mode(sk);
3241 void tcp_sock_set_quickack(struct sock *sk, int val)
3244 __tcp_sock_set_quickack(sk, val);
3247 EXPORT_SYMBOL(tcp_sock_set_quickack);
3249 int tcp_sock_set_syncnt(struct sock *sk, int val)
3251 if (val < 1 || val > MAX_TCP_SYNCNT)
3255 inet_csk(sk)->icsk_syn_retries = val;
3259 EXPORT_SYMBOL(tcp_sock_set_syncnt);
3261 void tcp_sock_set_user_timeout(struct sock *sk, u32 val)
3264 inet_csk(sk)->icsk_user_timeout = val;
3267 EXPORT_SYMBOL(tcp_sock_set_user_timeout);
3269 int tcp_sock_set_keepidle_locked(struct sock *sk, int val)
3271 struct tcp_sock *tp = tcp_sk(sk);
3273 if (val < 1 || val > MAX_TCP_KEEPIDLE)
3276 tp->keepalive_time = val * HZ;
3277 if (sock_flag(sk, SOCK_KEEPOPEN) &&
3278 !((1 << sk->sk_state) & (TCPF_CLOSE | TCPF_LISTEN))) {
3279 u32 elapsed = keepalive_time_elapsed(tp);
3281 if (tp->keepalive_time > elapsed)
3282 elapsed = tp->keepalive_time - elapsed;
3285 inet_csk_reset_keepalive_timer(sk, elapsed);
3291 int tcp_sock_set_keepidle(struct sock *sk, int val)
3296 err = tcp_sock_set_keepidle_locked(sk, val);
3300 EXPORT_SYMBOL(tcp_sock_set_keepidle);
3302 int tcp_sock_set_keepintvl(struct sock *sk, int val)
3304 if (val < 1 || val > MAX_TCP_KEEPINTVL)
3308 tcp_sk(sk)->keepalive_intvl = val * HZ;
3312 EXPORT_SYMBOL(tcp_sock_set_keepintvl);
3314 int tcp_sock_set_keepcnt(struct sock *sk, int val)
3316 if (val < 1 || val > MAX_TCP_KEEPCNT)
3320 tcp_sk(sk)->keepalive_probes = val;
3324 EXPORT_SYMBOL(tcp_sock_set_keepcnt);
3326 int tcp_set_window_clamp(struct sock *sk, int val)
3328 struct tcp_sock *tp = tcp_sk(sk);
3331 if (sk->sk_state != TCP_CLOSE)
3333 tp->window_clamp = 0;
3335 tp->window_clamp = val < SOCK_MIN_RCVBUF / 2 ?
3336 SOCK_MIN_RCVBUF / 2 : val;
3337 tp->rcv_ssthresh = min(tp->rcv_wnd, tp->window_clamp);
3343 * Socket option code for TCP.
3345 static int do_tcp_setsockopt(struct sock *sk, int level, int optname,
3346 sockptr_t optval, unsigned int optlen)
3348 struct tcp_sock *tp = tcp_sk(sk);
3349 struct inet_connection_sock *icsk = inet_csk(sk);
3350 struct net *net = sock_net(sk);
3354 /* These are data/string values, all the others are ints */
3356 case TCP_CONGESTION: {
3357 char name[TCP_CA_NAME_MAX];
3362 val = strncpy_from_sockptr(name, optval,
3363 min_t(long, TCP_CA_NAME_MAX-1, optlen));
3369 err = tcp_set_congestion_control(sk, name, true,
3370 ns_capable(sock_net(sk)->user_ns,
3376 char name[TCP_ULP_NAME_MAX];
3381 val = strncpy_from_sockptr(name, optval,
3382 min_t(long, TCP_ULP_NAME_MAX - 1,
3389 err = tcp_set_ulp(sk, name);
3393 case TCP_FASTOPEN_KEY: {
3394 __u8 key[TCP_FASTOPEN_KEY_BUF_LENGTH];
3395 __u8 *backup_key = NULL;
3397 /* Allow a backup key as well to facilitate key rotation
3398 * First key is the active one.
3400 if (optlen != TCP_FASTOPEN_KEY_LENGTH &&
3401 optlen != TCP_FASTOPEN_KEY_BUF_LENGTH)
3404 if (copy_from_sockptr(key, optval, optlen))
3407 if (optlen == TCP_FASTOPEN_KEY_BUF_LENGTH)
3408 backup_key = key + TCP_FASTOPEN_KEY_LENGTH;
3410 return tcp_fastopen_reset_cipher(net, sk, key, backup_key);
3417 if (optlen < sizeof(int))
3420 if (copy_from_sockptr(&val, optval, sizeof(val)))
3427 /* Values greater than interface MTU won't take effect. However
3428 * at the point when this call is done we typically don't yet
3429 * know which interface is going to be used
3431 if (val && (val < TCP_MIN_MSS || val > MAX_TCP_WINDOW)) {
3435 tp->rx_opt.user_mss = val;
3439 __tcp_sock_set_nodelay(sk, val);
3442 case TCP_THIN_LINEAR_TIMEOUTS:
3443 if (val < 0 || val > 1)
3449 case TCP_THIN_DUPACK:
3450 if (val < 0 || val > 1)
3455 if (!tcp_can_repair_sock(sk))
3457 else if (val == TCP_REPAIR_ON) {
3459 sk->sk_reuse = SK_FORCE_REUSE;
3460 tp->repair_queue = TCP_NO_QUEUE;
3461 } else if (val == TCP_REPAIR_OFF) {
3463 sk->sk_reuse = SK_NO_REUSE;
3464 tcp_send_window_probe(sk);
3465 } else if (val == TCP_REPAIR_OFF_NO_WP) {
3467 sk->sk_reuse = SK_NO_REUSE;
3473 case TCP_REPAIR_QUEUE:
3476 else if ((unsigned int)val < TCP_QUEUES_NR)
3477 tp->repair_queue = val;
3483 if (sk->sk_state != TCP_CLOSE) {
3485 } else if (tp->repair_queue == TCP_SEND_QUEUE) {
3486 if (!tcp_rtx_queue_empty(sk))
3489 WRITE_ONCE(tp->write_seq, val);
3490 } else if (tp->repair_queue == TCP_RECV_QUEUE) {
3491 if (tp->rcv_nxt != tp->copied_seq) {
3494 WRITE_ONCE(tp->rcv_nxt, val);
3495 WRITE_ONCE(tp->copied_seq, val);
3502 case TCP_REPAIR_OPTIONS:
3505 else if (sk->sk_state == TCP_ESTABLISHED)
3506 err = tcp_repair_options_est(sk, optval, optlen);
3512 __tcp_sock_set_cork(sk, val);
3516 err = tcp_sock_set_keepidle_locked(sk, val);
3519 if (val < 1 || val > MAX_TCP_KEEPINTVL)
3522 tp->keepalive_intvl = val * HZ;
3525 if (val < 1 || val > MAX_TCP_KEEPCNT)
3528 tp->keepalive_probes = val;
3531 if (val < 1 || val > MAX_TCP_SYNCNT)
3534 icsk->icsk_syn_retries = val;
3538 /* 0: disable, 1: enable, 2: start from ether_header */
3539 if (val < 0 || val > 2)
3548 else if (val > TCP_FIN_TIMEOUT_MAX / HZ)
3549 tp->linger2 = TCP_FIN_TIMEOUT_MAX;
3551 tp->linger2 = val * HZ;
3554 case TCP_DEFER_ACCEPT:
3555 /* Translate value in seconds to number of retransmits */
3556 icsk->icsk_accept_queue.rskq_defer_accept =
3557 secs_to_retrans(val, TCP_TIMEOUT_INIT / HZ,
3561 case TCP_WINDOW_CLAMP:
3562 err = tcp_set_window_clamp(sk, val);
3566 __tcp_sock_set_quickack(sk, val);
3569 #ifdef CONFIG_TCP_MD5SIG
3571 case TCP_MD5SIG_EXT:
3572 err = tp->af_specific->md5_parse(sk, optname, optval, optlen);
3575 case TCP_USER_TIMEOUT:
3576 /* Cap the max time in ms TCP will retry or probe the window
3577 * before giving up and aborting (ETIMEDOUT) a connection.
3582 icsk->icsk_user_timeout = val;
3586 if (val >= 0 && ((1 << sk->sk_state) & (TCPF_CLOSE |
3588 tcp_fastopen_init_key_once(net);
3590 fastopen_queue_tune(sk, val);
3595 case TCP_FASTOPEN_CONNECT:
3596 if (val > 1 || val < 0) {
3598 } else if (net->ipv4.sysctl_tcp_fastopen & TFO_CLIENT_ENABLE) {
3599 if (sk->sk_state == TCP_CLOSE)
3600 tp->fastopen_connect = val;
3607 case TCP_FASTOPEN_NO_COOKIE:
3608 if (val > 1 || val < 0)
3610 else if (!((1 << sk->sk_state) & (TCPF_CLOSE | TCPF_LISTEN)))
3613 tp->fastopen_no_cookie = val;
3619 tp->tsoffset = val - tcp_time_stamp_raw();
3621 case TCP_REPAIR_WINDOW:
3622 err = tcp_repair_set_window(tp, optval, optlen);
3624 case TCP_NOTSENT_LOWAT:
3625 tp->notsent_lowat = val;
3626 sk->sk_write_space(sk);
3629 if (val > 1 || val < 0)
3632 tp->recvmsg_inq = val;
3636 tcp_enable_tx_delay();
3637 tp->tcp_tx_delay = val;
3648 int tcp_setsockopt(struct sock *sk, int level, int optname, sockptr_t optval,
3649 unsigned int optlen)
3651 const struct inet_connection_sock *icsk = inet_csk(sk);
3653 if (level != SOL_TCP)
3654 return icsk->icsk_af_ops->setsockopt(sk, level, optname,
3656 return do_tcp_setsockopt(sk, level, optname, optval, optlen);
3658 EXPORT_SYMBOL(tcp_setsockopt);
3660 static void tcp_get_info_chrono_stats(const struct tcp_sock *tp,
3661 struct tcp_info *info)
3663 u64 stats[__TCP_CHRONO_MAX], total = 0;
3666 for (i = TCP_CHRONO_BUSY; i < __TCP_CHRONO_MAX; ++i) {
3667 stats[i] = tp->chrono_stat[i - 1];
3668 if (i == tp->chrono_type)
3669 stats[i] += tcp_jiffies32 - tp->chrono_start;
3670 stats[i] *= USEC_PER_SEC / HZ;
3674 info->tcpi_busy_time = total;
3675 info->tcpi_rwnd_limited = stats[TCP_CHRONO_RWND_LIMITED];
3676 info->tcpi_sndbuf_limited = stats[TCP_CHRONO_SNDBUF_LIMITED];
3679 /* Return information about state of tcp endpoint in API format. */
3680 void tcp_get_info(struct sock *sk, struct tcp_info *info)
3682 const struct tcp_sock *tp = tcp_sk(sk); /* iff sk_type == SOCK_STREAM */
3683 const struct inet_connection_sock *icsk = inet_csk(sk);
3689 memset(info, 0, sizeof(*info));
3690 if (sk->sk_type != SOCK_STREAM)
3693 info->tcpi_state = inet_sk_state_load(sk);
3695 /* Report meaningful fields for all TCP states, including listeners */
3696 rate = READ_ONCE(sk->sk_pacing_rate);
3697 rate64 = (rate != ~0UL) ? rate : ~0ULL;
3698 info->tcpi_pacing_rate = rate64;
3700 rate = READ_ONCE(sk->sk_max_pacing_rate);
3701 rate64 = (rate != ~0UL) ? rate : ~0ULL;
3702 info->tcpi_max_pacing_rate = rate64;
3704 info->tcpi_reordering = tp->reordering;
3705 info->tcpi_snd_cwnd = tp->snd_cwnd;
3707 if (info->tcpi_state == TCP_LISTEN) {
3708 /* listeners aliased fields :
3709 * tcpi_unacked -> Number of children ready for accept()
3710 * tcpi_sacked -> max backlog
3712 info->tcpi_unacked = READ_ONCE(sk->sk_ack_backlog);
3713 info->tcpi_sacked = READ_ONCE(sk->sk_max_ack_backlog);
3717 slow = lock_sock_fast(sk);
3719 info->tcpi_ca_state = icsk->icsk_ca_state;
3720 info->tcpi_retransmits = icsk->icsk_retransmits;
3721 info->tcpi_probes = icsk->icsk_probes_out;
3722 info->tcpi_backoff = icsk->icsk_backoff;
3724 if (tp->rx_opt.tstamp_ok)
3725 info->tcpi_options |= TCPI_OPT_TIMESTAMPS;
3726 if (tcp_is_sack(tp))
3727 info->tcpi_options |= TCPI_OPT_SACK;
3728 if (tp->rx_opt.wscale_ok) {
3729 info->tcpi_options |= TCPI_OPT_WSCALE;
3730 info->tcpi_snd_wscale = tp->rx_opt.snd_wscale;
3731 info->tcpi_rcv_wscale = tp->rx_opt.rcv_wscale;
3734 if (tp->ecn_flags & TCP_ECN_OK)
3735 info->tcpi_options |= TCPI_OPT_ECN;
3736 if (tp->ecn_flags & TCP_ECN_SEEN)
3737 info->tcpi_options |= TCPI_OPT_ECN_SEEN;
3738 if (tp->syn_data_acked)
3739 info->tcpi_options |= TCPI_OPT_SYN_DATA;
3741 info->tcpi_rto = jiffies_to_usecs(icsk->icsk_rto);
3742 info->tcpi_ato = jiffies_to_usecs(icsk->icsk_ack.ato);
3743 info->tcpi_snd_mss = tp->mss_cache;
3744 info->tcpi_rcv_mss = icsk->icsk_ack.rcv_mss;
3746 info->tcpi_unacked = tp->packets_out;
3747 info->tcpi_sacked = tp->sacked_out;
3749 info->tcpi_lost = tp->lost_out;
3750 info->tcpi_retrans = tp->retrans_out;
3752 now = tcp_jiffies32;
3753 info->tcpi_last_data_sent = jiffies_to_msecs(now - tp->lsndtime);
3754 info->tcpi_last_data_recv = jiffies_to_msecs(now - icsk->icsk_ack.lrcvtime);
3755 info->tcpi_last_ack_recv = jiffies_to_msecs(now - tp->rcv_tstamp);
3757 info->tcpi_pmtu = icsk->icsk_pmtu_cookie;
3758 info->tcpi_rcv_ssthresh = tp->rcv_ssthresh;
3759 info->tcpi_rtt = tp->srtt_us >> 3;
3760 info->tcpi_rttvar = tp->mdev_us >> 2;
3761 info->tcpi_snd_ssthresh = tp->snd_ssthresh;
3762 info->tcpi_advmss = tp->advmss;
3764 info->tcpi_rcv_rtt = tp->rcv_rtt_est.rtt_us >> 3;
3765 info->tcpi_rcv_space = tp->rcvq_space.space;
3767 info->tcpi_total_retrans = tp->total_retrans;
3769 info->tcpi_bytes_acked = tp->bytes_acked;
3770 info->tcpi_bytes_received = tp->bytes_received;
3771 info->tcpi_notsent_bytes = max_t(int, 0, tp->write_seq - tp->snd_nxt);
3772 tcp_get_info_chrono_stats(tp, info);
3774 info->tcpi_segs_out = tp->segs_out;
3775 info->tcpi_segs_in = tp->segs_in;
3777 info->tcpi_min_rtt = tcp_min_rtt(tp);
3778 info->tcpi_data_segs_in = tp->data_segs_in;
3779 info->tcpi_data_segs_out = tp->data_segs_out;
3781 info->tcpi_delivery_rate_app_limited = tp->rate_app_limited ? 1 : 0;
3782 rate64 = tcp_compute_delivery_rate(tp);
3784 info->tcpi_delivery_rate = rate64;
3785 info->tcpi_delivered = tp->delivered;
3786 info->tcpi_delivered_ce = tp->delivered_ce;
3787 info->tcpi_bytes_sent = tp->bytes_sent;
3788 info->tcpi_bytes_retrans = tp->bytes_retrans;
3789 info->tcpi_dsack_dups = tp->dsack_dups;
3790 info->tcpi_reord_seen = tp->reord_seen;
3791 info->tcpi_rcv_ooopack = tp->rcv_ooopack;
3792 info->tcpi_snd_wnd = tp->snd_wnd;
3793 info->tcpi_fastopen_client_fail = tp->fastopen_client_fail;
3794 unlock_sock_fast(sk, slow);
3796 EXPORT_SYMBOL_GPL(tcp_get_info);
3798 static size_t tcp_opt_stats_get_size(void)
3801 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_BUSY */
3802 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_RWND_LIMITED */
3803 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_SNDBUF_LIMITED */
3804 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_DATA_SEGS_OUT */
3805 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_TOTAL_RETRANS */
3806 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_PACING_RATE */
3807 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_DELIVERY_RATE */
3808 nla_total_size(sizeof(u32)) + /* TCP_NLA_SND_CWND */
3809 nla_total_size(sizeof(u32)) + /* TCP_NLA_REORDERING */
3810 nla_total_size(sizeof(u32)) + /* TCP_NLA_MIN_RTT */
3811 nla_total_size(sizeof(u8)) + /* TCP_NLA_RECUR_RETRANS */
3812 nla_total_size(sizeof(u8)) + /* TCP_NLA_DELIVERY_RATE_APP_LMT */
3813 nla_total_size(sizeof(u32)) + /* TCP_NLA_SNDQ_SIZE */
3814 nla_total_size(sizeof(u8)) + /* TCP_NLA_CA_STATE */
3815 nla_total_size(sizeof(u32)) + /* TCP_NLA_SND_SSTHRESH */
3816 nla_total_size(sizeof(u32)) + /* TCP_NLA_DELIVERED */
3817 nla_total_size(sizeof(u32)) + /* TCP_NLA_DELIVERED_CE */
3818 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_BYTES_SENT */
3819 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_BYTES_RETRANS */
3820 nla_total_size(sizeof(u32)) + /* TCP_NLA_DSACK_DUPS */
3821 nla_total_size(sizeof(u32)) + /* TCP_NLA_REORD_SEEN */
3822 nla_total_size(sizeof(u32)) + /* TCP_NLA_SRTT */
3823 nla_total_size(sizeof(u16)) + /* TCP_NLA_TIMEOUT_REHASH */
3824 nla_total_size(sizeof(u32)) + /* TCP_NLA_BYTES_NOTSENT */
3825 nla_total_size_64bit(sizeof(u64)) + /* TCP_NLA_EDT */
3826 nla_total_size(sizeof(u8)) + /* TCP_NLA_TTL */
3830 /* Returns TTL or hop limit of an incoming packet from skb. */
3831 static u8 tcp_skb_ttl_or_hop_limit(const struct sk_buff *skb)
3833 if (skb->protocol == htons(ETH_P_IP))
3834 return ip_hdr(skb)->ttl;
3835 else if (skb->protocol == htons(ETH_P_IPV6))
3836 return ipv6_hdr(skb)->hop_limit;
3841 struct sk_buff *tcp_get_timestamping_opt_stats(const struct sock *sk,
3842 const struct sk_buff *orig_skb,
3843 const struct sk_buff *ack_skb)
3845 const struct tcp_sock *tp = tcp_sk(sk);
3846 struct sk_buff *stats;
3847 struct tcp_info info;
3851 stats = alloc_skb(tcp_opt_stats_get_size(), GFP_ATOMIC);
3855 tcp_get_info_chrono_stats(tp, &info);
3856 nla_put_u64_64bit(stats, TCP_NLA_BUSY,
3857 info.tcpi_busy_time, TCP_NLA_PAD);
3858 nla_put_u64_64bit(stats, TCP_NLA_RWND_LIMITED,
3859 info.tcpi_rwnd_limited, TCP_NLA_PAD);
3860 nla_put_u64_64bit(stats, TCP_NLA_SNDBUF_LIMITED,
3861 info.tcpi_sndbuf_limited, TCP_NLA_PAD);
3862 nla_put_u64_64bit(stats, TCP_NLA_DATA_SEGS_OUT,
3863 tp->data_segs_out, TCP_NLA_PAD);
3864 nla_put_u64_64bit(stats, TCP_NLA_TOTAL_RETRANS,
3865 tp->total_retrans, TCP_NLA_PAD);
3867 rate = READ_ONCE(sk->sk_pacing_rate);
3868 rate64 = (rate != ~0UL) ? rate : ~0ULL;
3869 nla_put_u64_64bit(stats, TCP_NLA_PACING_RATE, rate64, TCP_NLA_PAD);
3871 rate64 = tcp_compute_delivery_rate(tp);
3872 nla_put_u64_64bit(stats, TCP_NLA_DELIVERY_RATE, rate64, TCP_NLA_PAD);
3874 nla_put_u32(stats, TCP_NLA_SND_CWND, tp->snd_cwnd);
3875 nla_put_u32(stats, TCP_NLA_REORDERING, tp->reordering);
3876 nla_put_u32(stats, TCP_NLA_MIN_RTT, tcp_min_rtt(tp));
3878 nla_put_u8(stats, TCP_NLA_RECUR_RETRANS, inet_csk(sk)->icsk_retransmits);
3879 nla_put_u8(stats, TCP_NLA_DELIVERY_RATE_APP_LMT, !!tp->rate_app_limited);
3880 nla_put_u32(stats, TCP_NLA_SND_SSTHRESH, tp->snd_ssthresh);
3881 nla_put_u32(stats, TCP_NLA_DELIVERED, tp->delivered);
3882 nla_put_u32(stats, TCP_NLA_DELIVERED_CE, tp->delivered_ce);
3884 nla_put_u32(stats, TCP_NLA_SNDQ_SIZE, tp->write_seq - tp->snd_una);
3885 nla_put_u8(stats, TCP_NLA_CA_STATE, inet_csk(sk)->icsk_ca_state);
3887 nla_put_u64_64bit(stats, TCP_NLA_BYTES_SENT, tp->bytes_sent,
3889 nla_put_u64_64bit(stats, TCP_NLA_BYTES_RETRANS, tp->bytes_retrans,
3891 nla_put_u32(stats, TCP_NLA_DSACK_DUPS, tp->dsack_dups);
3892 nla_put_u32(stats, TCP_NLA_REORD_SEEN, tp->reord_seen);
3893 nla_put_u32(stats, TCP_NLA_SRTT, tp->srtt_us >> 3);
3894 nla_put_u16(stats, TCP_NLA_TIMEOUT_REHASH, tp->timeout_rehash);
3895 nla_put_u32(stats, TCP_NLA_BYTES_NOTSENT,
3896 max_t(int, 0, tp->write_seq - tp->snd_nxt));
3897 nla_put_u64_64bit(stats, TCP_NLA_EDT, orig_skb->skb_mstamp_ns,
3900 nla_put_u8(stats, TCP_NLA_TTL,
3901 tcp_skb_ttl_or_hop_limit(ack_skb));
3906 static int do_tcp_getsockopt(struct sock *sk, int level,
3907 int optname, char __user *optval, int __user *optlen)
3909 struct inet_connection_sock *icsk = inet_csk(sk);
3910 struct tcp_sock *tp = tcp_sk(sk);
3911 struct net *net = sock_net(sk);
3914 if (get_user(len, optlen))
3917 len = min_t(unsigned int, len, sizeof(int));
3924 val = tp->mss_cache;
3925 if (!val && ((1 << sk->sk_state) & (TCPF_CLOSE | TCPF_LISTEN)))
3926 val = tp->rx_opt.user_mss;
3928 val = tp->rx_opt.mss_clamp;
3931 val = !!(tp->nonagle&TCP_NAGLE_OFF);
3934 val = !!(tp->nonagle&TCP_NAGLE_CORK);
3937 val = keepalive_time_when(tp) / HZ;
3940 val = keepalive_intvl_when(tp) / HZ;
3943 val = keepalive_probes(tp);
3946 val = icsk->icsk_syn_retries ? : net->ipv4.sysctl_tcp_syn_retries;
3951 val = (val ? : net->ipv4.sysctl_tcp_fin_timeout) / HZ;
3953 case TCP_DEFER_ACCEPT:
3954 val = retrans_to_secs(icsk->icsk_accept_queue.rskq_defer_accept,
3955 TCP_TIMEOUT_INIT / HZ, TCP_RTO_MAX / HZ);
3957 case TCP_WINDOW_CLAMP:
3958 val = tp->window_clamp;
3961 struct tcp_info info;
3963 if (get_user(len, optlen))
3966 tcp_get_info(sk, &info);
3968 len = min_t(unsigned int, len, sizeof(info));
3969 if (put_user(len, optlen))
3971 if (copy_to_user(optval, &info, len))
3976 const struct tcp_congestion_ops *ca_ops;
3977 union tcp_cc_info info;
3981 if (get_user(len, optlen))
3984 ca_ops = icsk->icsk_ca_ops;
3985 if (ca_ops && ca_ops->get_info)
3986 sz = ca_ops->get_info(sk, ~0U, &attr, &info);
3988 len = min_t(unsigned int, len, sz);
3989 if (put_user(len, optlen))
3991 if (copy_to_user(optval, &info, len))
3996 val = !inet_csk_in_pingpong_mode(sk);
3999 case TCP_CONGESTION:
4000 if (get_user(len, optlen))
4002 len = min_t(unsigned int, len, TCP_CA_NAME_MAX);
4003 if (put_user(len, optlen))
4005 if (copy_to_user(optval, icsk->icsk_ca_ops->name, len))
4010 if (get_user(len, optlen))
4012 len = min_t(unsigned int, len, TCP_ULP_NAME_MAX);
4013 if (!icsk->icsk_ulp_ops) {
4014 if (put_user(0, optlen))
4018 if (put_user(len, optlen))
4020 if (copy_to_user(optval, icsk->icsk_ulp_ops->name, len))
4024 case TCP_FASTOPEN_KEY: {
4025 u64 key[TCP_FASTOPEN_KEY_BUF_LENGTH / sizeof(u64)];
4026 unsigned int key_len;
4028 if (get_user(len, optlen))
4031 key_len = tcp_fastopen_get_cipher(net, icsk, key) *
4032 TCP_FASTOPEN_KEY_LENGTH;
4033 len = min_t(unsigned int, len, key_len);
4034 if (put_user(len, optlen))
4036 if (copy_to_user(optval, key, len))
4040 case TCP_THIN_LINEAR_TIMEOUTS:
4044 case TCP_THIN_DUPACK:
4052 case TCP_REPAIR_QUEUE:
4054 val = tp->repair_queue;
4059 case TCP_REPAIR_WINDOW: {
4060 struct tcp_repair_window opt;
4062 if (get_user(len, optlen))
4065 if (len != sizeof(opt))
4071 opt.snd_wl1 = tp->snd_wl1;
4072 opt.snd_wnd = tp->snd_wnd;
4073 opt.max_window = tp->max_window;
4074 opt.rcv_wnd = tp->rcv_wnd;
4075 opt.rcv_wup = tp->rcv_wup;
4077 if (copy_to_user(optval, &opt, len))
4082 if (tp->repair_queue == TCP_SEND_QUEUE)
4083 val = tp->write_seq;
4084 else if (tp->repair_queue == TCP_RECV_QUEUE)
4090 case TCP_USER_TIMEOUT:
4091 val = icsk->icsk_user_timeout;
4095 val = icsk->icsk_accept_queue.fastopenq.max_qlen;
4098 case TCP_FASTOPEN_CONNECT:
4099 val = tp->fastopen_connect;
4102 case TCP_FASTOPEN_NO_COOKIE:
4103 val = tp->fastopen_no_cookie;
4107 val = tp->tcp_tx_delay;
4111 val = tcp_time_stamp_raw() + tp->tsoffset;
4113 case TCP_NOTSENT_LOWAT:
4114 val = tp->notsent_lowat;
4117 val = tp->recvmsg_inq;
4122 case TCP_SAVED_SYN: {
4123 if (get_user(len, optlen))
4127 if (tp->saved_syn) {
4128 if (len < tcp_saved_syn_len(tp->saved_syn)) {
4129 if (put_user(tcp_saved_syn_len(tp->saved_syn),
4137 len = tcp_saved_syn_len(tp->saved_syn);
4138 if (put_user(len, optlen)) {
4142 if (copy_to_user(optval, tp->saved_syn->data, len)) {
4146 tcp_saved_syn_free(tp);
4151 if (put_user(len, optlen))
4157 case TCP_ZEROCOPY_RECEIVE: {
4158 struct scm_timestamping_internal tss;
4159 struct tcp_zerocopy_receive zc = {};
4162 if (get_user(len, optlen))
4165 len < offsetofend(struct tcp_zerocopy_receive, length))
4167 if (unlikely(len > sizeof(zc))) {
4168 err = check_zeroed_user(optval + sizeof(zc),
4171 return err == 0 ? -EINVAL : err;
4173 if (put_user(len, optlen))
4176 if (copy_from_user(&zc, optval, len))
4180 if (zc.msg_flags & ~(TCP_VALID_ZC_MSG_FLAGS))
4183 err = tcp_zerocopy_receive(sk, &zc, &tss);
4184 err = BPF_CGROUP_RUN_PROG_GETSOCKOPT_KERN(sk, level, optname,
4187 if (len >= offsetofend(struct tcp_zerocopy_receive, msg_flags))
4188 goto zerocopy_rcv_cmsg;
4190 case offsetofend(struct tcp_zerocopy_receive, msg_flags):
4191 goto zerocopy_rcv_cmsg;
4192 case offsetofend(struct tcp_zerocopy_receive, msg_controllen):
4193 case offsetofend(struct tcp_zerocopy_receive, msg_control):
4194 case offsetofend(struct tcp_zerocopy_receive, flags):
4195 case offsetofend(struct tcp_zerocopy_receive, copybuf_len):
4196 case offsetofend(struct tcp_zerocopy_receive, copybuf_address):
4197 case offsetofend(struct tcp_zerocopy_receive, err):
4198 goto zerocopy_rcv_sk_err;
4199 case offsetofend(struct tcp_zerocopy_receive, inq):
4200 goto zerocopy_rcv_inq;
4201 case offsetofend(struct tcp_zerocopy_receive, length):
4203 goto zerocopy_rcv_out;
4206 if (zc.msg_flags & TCP_CMSG_TS)
4207 tcp_zc_finalize_rx_tstamp(sk, &zc, &tss);
4210 zerocopy_rcv_sk_err:
4212 zc.err = sock_error(sk);
4214 zc.inq = tcp_inq_hint(sk);
4216 if (!err && copy_to_user(optval, &zc, len))
4222 return -ENOPROTOOPT;
4225 if (put_user(len, optlen))
4227 if (copy_to_user(optval, &val, len))
4232 bool tcp_bpf_bypass_getsockopt(int level, int optname)
4234 /* TCP do_tcp_getsockopt has optimized getsockopt implementation
4235 * to avoid extra socket lock for TCP_ZEROCOPY_RECEIVE.
4237 if (level == SOL_TCP && optname == TCP_ZEROCOPY_RECEIVE)
4242 EXPORT_SYMBOL(tcp_bpf_bypass_getsockopt);
4244 int tcp_getsockopt(struct sock *sk, int level, int optname, char __user *optval,
4247 struct inet_connection_sock *icsk = inet_csk(sk);
4249 if (level != SOL_TCP)
4250 return icsk->icsk_af_ops->getsockopt(sk, level, optname,
4252 return do_tcp_getsockopt(sk, level, optname, optval, optlen);
4254 EXPORT_SYMBOL(tcp_getsockopt);
4256 #ifdef CONFIG_TCP_MD5SIG
4257 static DEFINE_PER_CPU(struct tcp_md5sig_pool, tcp_md5sig_pool);
4258 static DEFINE_MUTEX(tcp_md5sig_mutex);
4259 static bool tcp_md5sig_pool_populated = false;
4261 static void __tcp_alloc_md5sig_pool(void)
4263 struct crypto_ahash *hash;
4266 hash = crypto_alloc_ahash("md5", 0, CRYPTO_ALG_ASYNC);
4270 for_each_possible_cpu(cpu) {
4271 void *scratch = per_cpu(tcp_md5sig_pool, cpu).scratch;
4272 struct ahash_request *req;
4275 scratch = kmalloc_node(sizeof(union tcp_md5sum_block) +
4276 sizeof(struct tcphdr),
4281 per_cpu(tcp_md5sig_pool, cpu).scratch = scratch;
4283 if (per_cpu(tcp_md5sig_pool, cpu).md5_req)
4286 req = ahash_request_alloc(hash, GFP_KERNEL);
4290 ahash_request_set_callback(req, 0, NULL, NULL);
4292 per_cpu(tcp_md5sig_pool, cpu).md5_req = req;
4294 /* before setting tcp_md5sig_pool_populated, we must commit all writes
4295 * to memory. See smp_rmb() in tcp_get_md5sig_pool()
4298 tcp_md5sig_pool_populated = true;
4301 bool tcp_alloc_md5sig_pool(void)
4303 if (unlikely(!tcp_md5sig_pool_populated)) {
4304 mutex_lock(&tcp_md5sig_mutex);
4306 if (!tcp_md5sig_pool_populated) {
4307 __tcp_alloc_md5sig_pool();
4308 if (tcp_md5sig_pool_populated)
4309 static_branch_inc(&tcp_md5_needed);
4312 mutex_unlock(&tcp_md5sig_mutex);
4314 return tcp_md5sig_pool_populated;
4316 EXPORT_SYMBOL(tcp_alloc_md5sig_pool);
4320 * tcp_get_md5sig_pool - get md5sig_pool for this user
4322 * We use percpu structure, so if we succeed, we exit with preemption
4323 * and BH disabled, to make sure another thread or softirq handling
4324 * wont try to get same context.
4326 struct tcp_md5sig_pool *tcp_get_md5sig_pool(void)
4330 if (tcp_md5sig_pool_populated) {
4331 /* coupled with smp_wmb() in __tcp_alloc_md5sig_pool() */
4333 return this_cpu_ptr(&tcp_md5sig_pool);
4338 EXPORT_SYMBOL(tcp_get_md5sig_pool);
4340 int tcp_md5_hash_skb_data(struct tcp_md5sig_pool *hp,
4341 const struct sk_buff *skb, unsigned int header_len)
4343 struct scatterlist sg;
4344 const struct tcphdr *tp = tcp_hdr(skb);
4345 struct ahash_request *req = hp->md5_req;
4347 const unsigned int head_data_len = skb_headlen(skb) > header_len ?
4348 skb_headlen(skb) - header_len : 0;
4349 const struct skb_shared_info *shi = skb_shinfo(skb);
4350 struct sk_buff *frag_iter;
4352 sg_init_table(&sg, 1);
4354 sg_set_buf(&sg, ((u8 *) tp) + header_len, head_data_len);
4355 ahash_request_set_crypt(req, &sg, NULL, head_data_len);
4356 if (crypto_ahash_update(req))
4359 for (i = 0; i < shi->nr_frags; ++i) {
4360 const skb_frag_t *f = &shi->frags[i];
4361 unsigned int offset = skb_frag_off(f);
4362 struct page *page = skb_frag_page(f) + (offset >> PAGE_SHIFT);
4364 sg_set_page(&sg, page, skb_frag_size(f),
4365 offset_in_page(offset));
4366 ahash_request_set_crypt(req, &sg, NULL, skb_frag_size(f));
4367 if (crypto_ahash_update(req))
4371 skb_walk_frags(skb, frag_iter)
4372 if (tcp_md5_hash_skb_data(hp, frag_iter, 0))
4377 EXPORT_SYMBOL(tcp_md5_hash_skb_data);
4379 int tcp_md5_hash_key(struct tcp_md5sig_pool *hp, const struct tcp_md5sig_key *key)
4381 u8 keylen = READ_ONCE(key->keylen); /* paired with WRITE_ONCE() in tcp_md5_do_add */
4382 struct scatterlist sg;
4384 sg_init_one(&sg, key->key, keylen);
4385 ahash_request_set_crypt(hp->md5_req, &sg, NULL, keylen);
4387 /* We use data_race() because tcp_md5_do_add() might change key->key under us */
4388 return data_race(crypto_ahash_update(hp->md5_req));
4390 EXPORT_SYMBOL(tcp_md5_hash_key);
4394 void tcp_done(struct sock *sk)
4396 struct request_sock *req;
4398 /* We might be called with a new socket, after
4399 * inet_csk_prepare_forced_close() has been called
4400 * so we can not use lockdep_sock_is_held(sk)
4402 req = rcu_dereference_protected(tcp_sk(sk)->fastopen_rsk, 1);
4404 if (sk->sk_state == TCP_SYN_SENT || sk->sk_state == TCP_SYN_RECV)
4405 TCP_INC_STATS(sock_net(sk), TCP_MIB_ATTEMPTFAILS);
4407 tcp_set_state(sk, TCP_CLOSE);
4408 tcp_clear_xmit_timers(sk);
4410 reqsk_fastopen_remove(sk, req, false);
4412 sk->sk_shutdown = SHUTDOWN_MASK;
4414 if (!sock_flag(sk, SOCK_DEAD))
4415 sk->sk_state_change(sk);
4417 inet_csk_destroy_sock(sk);
4419 EXPORT_SYMBOL_GPL(tcp_done);
4421 int tcp_abort(struct sock *sk, int err)
4423 if (!sk_fullsock(sk)) {
4424 if (sk->sk_state == TCP_NEW_SYN_RECV) {
4425 struct request_sock *req = inet_reqsk(sk);
4428 inet_csk_reqsk_queue_drop(req->rsk_listener, req);
4435 /* Don't race with userspace socket closes such as tcp_close. */
4438 if (sk->sk_state == TCP_LISTEN) {
4439 tcp_set_state(sk, TCP_CLOSE);
4440 inet_csk_listen_stop(sk);
4443 /* Don't race with BH socket closes such as inet_csk_listen_stop. */
4447 if (!sock_flag(sk, SOCK_DEAD)) {
4449 /* This barrier is coupled with smp_rmb() in tcp_poll() */
4451 sk_error_report(sk);
4452 if (tcp_need_reset(sk->sk_state))
4453 tcp_send_active_reset(sk, GFP_ATOMIC);
4459 tcp_write_queue_purge(sk);
4463 EXPORT_SYMBOL_GPL(tcp_abort);
4465 extern struct tcp_congestion_ops tcp_reno;
4467 static __initdata unsigned long thash_entries;
4468 static int __init set_thash_entries(char *str)
4475 ret = kstrtoul(str, 0, &thash_entries);
4481 __setup("thash_entries=", set_thash_entries);
4483 static void __init tcp_init_mem(void)
4485 unsigned long limit = nr_free_buffer_pages() / 16;
4487 limit = max(limit, 128UL);
4488 sysctl_tcp_mem[0] = limit / 4 * 3; /* 4.68 % */
4489 sysctl_tcp_mem[1] = limit; /* 6.25 % */
4490 sysctl_tcp_mem[2] = sysctl_tcp_mem[0] * 2; /* 9.37 % */
4493 void __init tcp_init(void)
4495 int max_rshare, max_wshare, cnt;
4496 unsigned long limit;
4499 BUILD_BUG_ON(TCP_MIN_SND_MSS <= MAX_TCP_OPTION_SPACE);
4500 BUILD_BUG_ON(sizeof(struct tcp_skb_cb) >
4501 sizeof_field(struct sk_buff, cb));
4503 percpu_counter_init(&tcp_sockets_allocated, 0, GFP_KERNEL);
4505 timer_setup(&tcp_orphan_timer, tcp_orphan_update, TIMER_DEFERRABLE);
4506 mod_timer(&tcp_orphan_timer, jiffies + TCP_ORPHAN_TIMER_PERIOD);
4508 inet_hashinfo_init(&tcp_hashinfo);
4509 inet_hashinfo2_init(&tcp_hashinfo, "tcp_listen_portaddr_hash",
4510 thash_entries, 21, /* one slot per 2 MB*/
4512 tcp_hashinfo.bind_bucket_cachep =
4513 kmem_cache_create("tcp_bind_bucket",
4514 sizeof(struct inet_bind_bucket), 0,
4515 SLAB_HWCACHE_ALIGN | SLAB_PANIC |
4519 /* Size and allocate the main established and bind bucket
4522 * The methodology is similar to that of the buffer cache.
4524 tcp_hashinfo.ehash =
4525 alloc_large_system_hash("TCP established",
4526 sizeof(struct inet_ehash_bucket),
4528 17, /* one slot per 128 KB of memory */
4531 &tcp_hashinfo.ehash_mask,
4533 thash_entries ? 0 : 512 * 1024);
4534 for (i = 0; i <= tcp_hashinfo.ehash_mask; i++)
4535 INIT_HLIST_NULLS_HEAD(&tcp_hashinfo.ehash[i].chain, i);
4537 if (inet_ehash_locks_alloc(&tcp_hashinfo))
4538 panic("TCP: failed to alloc ehash_locks");
4539 tcp_hashinfo.bhash =
4540 alloc_large_system_hash("TCP bind",
4541 sizeof(struct inet_bind_hashbucket),
4542 tcp_hashinfo.ehash_mask + 1,
4543 17, /* one slot per 128 KB of memory */
4545 &tcp_hashinfo.bhash_size,
4549 tcp_hashinfo.bhash_size = 1U << tcp_hashinfo.bhash_size;
4550 for (i = 0; i < tcp_hashinfo.bhash_size; i++) {
4551 spin_lock_init(&tcp_hashinfo.bhash[i].lock);
4552 INIT_HLIST_HEAD(&tcp_hashinfo.bhash[i].chain);
4556 cnt = tcp_hashinfo.ehash_mask + 1;
4557 sysctl_tcp_max_orphans = cnt / 2;
4560 /* Set per-socket limits to no more than 1/128 the pressure threshold */
4561 limit = nr_free_buffer_pages() << (PAGE_SHIFT - 7);
4562 max_wshare = min(4UL*1024*1024, limit);
4563 max_rshare = min(6UL*1024*1024, limit);
4565 init_net.ipv4.sysctl_tcp_wmem[0] = SK_MEM_QUANTUM;
4566 init_net.ipv4.sysctl_tcp_wmem[1] = 16*1024;
4567 init_net.ipv4.sysctl_tcp_wmem[2] = max(64*1024, max_wshare);
4569 init_net.ipv4.sysctl_tcp_rmem[0] = SK_MEM_QUANTUM;
4570 init_net.ipv4.sysctl_tcp_rmem[1] = 131072;
4571 init_net.ipv4.sysctl_tcp_rmem[2] = max(131072, max_rshare);
4573 pr_info("Hash tables configured (established %u bind %u)\n",
4574 tcp_hashinfo.ehash_mask + 1, tcp_hashinfo.bhash_size);
4578 BUG_ON(tcp_register_congestion_control(&tcp_reno) != 0);