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 * Generic socket support routines. Memory allocators, socket lock/release
8 * handler for protocols to use and generic option handler.
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Florian La Roche, <flla@stud.uni-sb.de>
13 * Alan Cox, <A.Cox@swansea.ac.uk>
16 * Alan Cox : Numerous verify_area() problems
17 * Alan Cox : Connecting on a connecting socket
18 * now returns an error for tcp.
19 * Alan Cox : sock->protocol is set correctly.
20 * and is not sometimes left as 0.
21 * Alan Cox : connect handles icmp errors on a
22 * connect properly. Unfortunately there
23 * is a restart syscall nasty there. I
24 * can't match BSD without hacking the C
25 * library. Ideas urgently sought!
26 * Alan Cox : Disallow bind() to addresses that are
27 * not ours - especially broadcast ones!!
28 * Alan Cox : Socket 1024 _IS_ ok for users. (fencepost)
29 * Alan Cox : sock_wfree/sock_rfree don't destroy sockets,
30 * instead they leave that for the DESTROY timer.
31 * Alan Cox : Clean up error flag in accept
32 * Alan Cox : TCP ack handling is buggy, the DESTROY timer
33 * was buggy. Put a remove_sock() in the handler
34 * for memory when we hit 0. Also altered the timer
35 * code. The ACK stuff can wait and needs major
37 * Alan Cox : Fixed TCP ack bug, removed remove sock
38 * and fixed timer/inet_bh race.
39 * Alan Cox : Added zapped flag for TCP
40 * Alan Cox : Move kfree_skb into skbuff.c and tidied up surplus code
41 * Alan Cox : for new sk_buff allocations wmalloc/rmalloc now call alloc_skb
42 * Alan Cox : kfree_s calls now are kfree_skbmem so we can track skb resources
43 * Alan Cox : Supports socket option broadcast now as does udp. Packet and raw need fixing.
44 * Alan Cox : Added RCVBUF,SNDBUF size setting. It suddenly occurred to me how easy it was so...
45 * Rick Sladkey : Relaxed UDP rules for matching packets.
46 * C.E.Hawkins : IFF_PROMISC/SIOCGHWADDR support
47 * Pauline Middelink : identd support
48 * Alan Cox : Fixed connect() taking signals I think.
49 * Alan Cox : SO_LINGER supported
50 * Alan Cox : Error reporting fixes
51 * Anonymous : inet_create tidied up (sk->reuse setting)
52 * Alan Cox : inet sockets don't set sk->type!
53 * Alan Cox : Split socket option code
54 * Alan Cox : Callbacks
55 * Alan Cox : Nagle flag for Charles & Johannes stuff
56 * Alex : Removed restriction on inet fioctl
57 * Alan Cox : Splitting INET from NET core
58 * Alan Cox : Fixed bogus SO_TYPE handling in getsockopt()
59 * Adam Caldwell : Missing return in SO_DONTROUTE/SO_DEBUG code
60 * Alan Cox : Split IP from generic code
61 * Alan Cox : New kfree_skbmem()
62 * Alan Cox : Make SO_DEBUG superuser only.
63 * Alan Cox : Allow anyone to clear SO_DEBUG
65 * Alan Cox : Added optimistic memory grabbing for AF_UNIX throughput.
66 * Alan Cox : Allocator for a socket is settable.
67 * Alan Cox : SO_ERROR includes soft errors.
68 * Alan Cox : Allow NULL arguments on some SO_ opts
69 * Alan Cox : Generic socket allocation to make hooks
70 * easier (suggested by Craig Metz).
71 * Michael Pall : SO_ERROR returns positive errno again
72 * Steve Whitehouse: Added default destructor to free
73 * protocol private data.
74 * Steve Whitehouse: Added various other default routines
75 * common to several socket families.
76 * Chris Evans : Call suser() check last on F_SETOWN
77 * Jay Schulist : Added SO_ATTACH_FILTER and SO_DETACH_FILTER.
78 * Andi Kleen : Add sock_kmalloc()/sock_kfree_s()
79 * Andi Kleen : Fix write_space callback
80 * Chris Evans : Security fixes - signedness again
81 * Arnaldo C. Melo : cleanups, use skb_queue_purge
86 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
88 #include <asm/unaligned.h>
89 #include <linux/capability.h>
90 #include <linux/errno.h>
91 #include <linux/errqueue.h>
92 #include <linux/types.h>
93 #include <linux/socket.h>
95 #include <linux/kernel.h>
96 #include <linux/module.h>
97 #include <linux/proc_fs.h>
98 #include <linux/seq_file.h>
99 #include <linux/sched.h>
100 #include <linux/sched/mm.h>
101 #include <linux/timer.h>
102 #include <linux/string.h>
103 #include <linux/sockios.h>
104 #include <linux/net.h>
105 #include <linux/mm.h>
106 #include <linux/slab.h>
107 #include <linux/interrupt.h>
108 #include <linux/poll.h>
109 #include <linux/tcp.h>
110 #include <linux/init.h>
111 #include <linux/highmem.h>
112 #include <linux/user_namespace.h>
113 #include <linux/static_key.h>
114 #include <linux/memcontrol.h>
115 #include <linux/prefetch.h>
116 #include <linux/compat.h>
117 #include <linux/mroute.h>
118 #include <linux/mroute6.h>
119 #include <linux/icmpv6.h>
121 #include <linux/uaccess.h>
123 #include <linux/netdevice.h>
124 #include <net/protocol.h>
125 #include <linux/skbuff.h>
126 #include <net/net_namespace.h>
127 #include <net/request_sock.h>
128 #include <net/sock.h>
129 #include <linux/net_tstamp.h>
130 #include <net/xfrm.h>
131 #include <linux/ipsec.h>
132 #include <net/cls_cgroup.h>
133 #include <net/netprio_cgroup.h>
134 #include <linux/sock_diag.h>
136 #include <linux/filter.h>
137 #include <net/sock_reuseport.h>
138 #include <net/bpf_sk_storage.h>
140 #include <trace/events/sock.h>
143 #include <net/busy_poll.h>
144 #include <net/phonet/phonet.h>
146 #include <linux/ethtool.h>
150 static DEFINE_MUTEX(proto_list_mutex);
151 static LIST_HEAD(proto_list);
153 static void sock_def_write_space_wfree(struct sock *sk);
154 static void sock_def_write_space(struct sock *sk);
157 * sk_ns_capable - General socket capability test
158 * @sk: Socket to use a capability on or through
159 * @user_ns: The user namespace of the capability to use
160 * @cap: The capability to use
162 * Test to see if the opener of the socket had when the socket was
163 * created and the current process has the capability @cap in the user
164 * namespace @user_ns.
166 bool sk_ns_capable(const struct sock *sk,
167 struct user_namespace *user_ns, int cap)
169 return file_ns_capable(sk->sk_socket->file, user_ns, cap) &&
170 ns_capable(user_ns, cap);
172 EXPORT_SYMBOL(sk_ns_capable);
175 * sk_capable - Socket global capability test
176 * @sk: Socket to use a capability on or through
177 * @cap: The global capability to use
179 * Test to see if the opener of the socket had when the socket was
180 * created and the current process has the capability @cap in all user
183 bool sk_capable(const struct sock *sk, int cap)
185 return sk_ns_capable(sk, &init_user_ns, cap);
187 EXPORT_SYMBOL(sk_capable);
190 * sk_net_capable - Network namespace socket capability test
191 * @sk: Socket to use a capability on or through
192 * @cap: The capability to use
194 * Test to see if the opener of the socket had when the socket was created
195 * and the current process has the capability @cap over the network namespace
196 * the socket is a member of.
198 bool sk_net_capable(const struct sock *sk, int cap)
200 return sk_ns_capable(sk, sock_net(sk)->user_ns, cap);
202 EXPORT_SYMBOL(sk_net_capable);
205 * Each address family might have different locking rules, so we have
206 * one slock key per address family and separate keys for internal and
209 static struct lock_class_key af_family_keys[AF_MAX];
210 static struct lock_class_key af_family_kern_keys[AF_MAX];
211 static struct lock_class_key af_family_slock_keys[AF_MAX];
212 static struct lock_class_key af_family_kern_slock_keys[AF_MAX];
215 * Make lock validator output more readable. (we pre-construct these
216 * strings build-time, so that runtime initialization of socket
220 #define _sock_locks(x) \
221 x "AF_UNSPEC", x "AF_UNIX" , x "AF_INET" , \
222 x "AF_AX25" , x "AF_IPX" , x "AF_APPLETALK", \
223 x "AF_NETROM", x "AF_BRIDGE" , x "AF_ATMPVC" , \
224 x "AF_X25" , x "AF_INET6" , x "AF_ROSE" , \
225 x "AF_DECnet", x "AF_NETBEUI" , x "AF_SECURITY" , \
226 x "AF_KEY" , x "AF_NETLINK" , x "AF_PACKET" , \
227 x "AF_ASH" , x "AF_ECONET" , x "AF_ATMSVC" , \
228 x "AF_RDS" , x "AF_SNA" , x "AF_IRDA" , \
229 x "AF_PPPOX" , x "AF_WANPIPE" , x "AF_LLC" , \
230 x "27" , x "28" , x "AF_CAN" , \
231 x "AF_TIPC" , x "AF_BLUETOOTH", x "IUCV" , \
232 x "AF_RXRPC" , x "AF_ISDN" , x "AF_PHONET" , \
233 x "AF_IEEE802154", x "AF_CAIF" , x "AF_ALG" , \
234 x "AF_NFC" , x "AF_VSOCK" , x "AF_KCM" , \
235 x "AF_QIPCRTR", x "AF_SMC" , x "AF_XDP" , \
239 static const char *const af_family_key_strings[AF_MAX+1] = {
240 _sock_locks("sk_lock-")
242 static const char *const af_family_slock_key_strings[AF_MAX+1] = {
243 _sock_locks("slock-")
245 static const char *const af_family_clock_key_strings[AF_MAX+1] = {
246 _sock_locks("clock-")
249 static const char *const af_family_kern_key_strings[AF_MAX+1] = {
250 _sock_locks("k-sk_lock-")
252 static const char *const af_family_kern_slock_key_strings[AF_MAX+1] = {
253 _sock_locks("k-slock-")
255 static const char *const af_family_kern_clock_key_strings[AF_MAX+1] = {
256 _sock_locks("k-clock-")
258 static const char *const af_family_rlock_key_strings[AF_MAX+1] = {
259 _sock_locks("rlock-")
261 static const char *const af_family_wlock_key_strings[AF_MAX+1] = {
262 _sock_locks("wlock-")
264 static const char *const af_family_elock_key_strings[AF_MAX+1] = {
265 _sock_locks("elock-")
269 * sk_callback_lock and sk queues locking rules are per-address-family,
270 * so split the lock classes by using a per-AF key:
272 static struct lock_class_key af_callback_keys[AF_MAX];
273 static struct lock_class_key af_rlock_keys[AF_MAX];
274 static struct lock_class_key af_wlock_keys[AF_MAX];
275 static struct lock_class_key af_elock_keys[AF_MAX];
276 static struct lock_class_key af_kern_callback_keys[AF_MAX];
278 /* Run time adjustable parameters. */
279 __u32 sysctl_wmem_max __read_mostly = SK_WMEM_MAX;
280 EXPORT_SYMBOL(sysctl_wmem_max);
281 __u32 sysctl_rmem_max __read_mostly = SK_RMEM_MAX;
282 EXPORT_SYMBOL(sysctl_rmem_max);
283 __u32 sysctl_wmem_default __read_mostly = SK_WMEM_MAX;
284 __u32 sysctl_rmem_default __read_mostly = SK_RMEM_MAX;
286 /* Maximal space eaten by iovec or ancillary data plus some space */
287 int sysctl_optmem_max __read_mostly = sizeof(unsigned long)*(2*UIO_MAXIOV+512);
288 EXPORT_SYMBOL(sysctl_optmem_max);
290 int sysctl_tstamp_allow_data __read_mostly = 1;
292 DEFINE_STATIC_KEY_FALSE(memalloc_socks_key);
293 EXPORT_SYMBOL_GPL(memalloc_socks_key);
296 * sk_set_memalloc - sets %SOCK_MEMALLOC
297 * @sk: socket to set it on
299 * Set %SOCK_MEMALLOC on a socket for access to emergency reserves.
300 * It's the responsibility of the admin to adjust min_free_kbytes
301 * to meet the requirements
303 void sk_set_memalloc(struct sock *sk)
305 sock_set_flag(sk, SOCK_MEMALLOC);
306 sk->sk_allocation |= __GFP_MEMALLOC;
307 static_branch_inc(&memalloc_socks_key);
309 EXPORT_SYMBOL_GPL(sk_set_memalloc);
311 void sk_clear_memalloc(struct sock *sk)
313 sock_reset_flag(sk, SOCK_MEMALLOC);
314 sk->sk_allocation &= ~__GFP_MEMALLOC;
315 static_branch_dec(&memalloc_socks_key);
318 * SOCK_MEMALLOC is allowed to ignore rmem limits to ensure forward
319 * progress of swapping. SOCK_MEMALLOC may be cleared while
320 * it has rmem allocations due to the last swapfile being deactivated
321 * but there is a risk that the socket is unusable due to exceeding
322 * the rmem limits. Reclaim the reserves and obey rmem limits again.
326 EXPORT_SYMBOL_GPL(sk_clear_memalloc);
328 int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
331 unsigned int noreclaim_flag;
333 /* these should have been dropped before queueing */
334 BUG_ON(!sock_flag(sk, SOCK_MEMALLOC));
336 noreclaim_flag = memalloc_noreclaim_save();
337 ret = INDIRECT_CALL_INET(sk->sk_backlog_rcv,
341 memalloc_noreclaim_restore(noreclaim_flag);
345 EXPORT_SYMBOL(__sk_backlog_rcv);
347 void sk_error_report(struct sock *sk)
349 sk->sk_error_report(sk);
351 switch (sk->sk_family) {
355 trace_inet_sk_error_report(sk);
361 EXPORT_SYMBOL(sk_error_report);
363 int sock_get_timeout(long timeo, void *optval, bool old_timeval)
365 struct __kernel_sock_timeval tv;
367 if (timeo == MAX_SCHEDULE_TIMEOUT) {
371 tv.tv_sec = timeo / HZ;
372 tv.tv_usec = ((timeo % HZ) * USEC_PER_SEC) / HZ;
375 if (old_timeval && in_compat_syscall() && !COMPAT_USE_64BIT_TIME) {
376 struct old_timeval32 tv32 = { tv.tv_sec, tv.tv_usec };
377 *(struct old_timeval32 *)optval = tv32;
382 struct __kernel_old_timeval old_tv;
383 old_tv.tv_sec = tv.tv_sec;
384 old_tv.tv_usec = tv.tv_usec;
385 *(struct __kernel_old_timeval *)optval = old_tv;
386 return sizeof(old_tv);
389 *(struct __kernel_sock_timeval *)optval = tv;
392 EXPORT_SYMBOL(sock_get_timeout);
394 int sock_copy_user_timeval(struct __kernel_sock_timeval *tv,
395 sockptr_t optval, int optlen, bool old_timeval)
397 if (old_timeval && in_compat_syscall() && !COMPAT_USE_64BIT_TIME) {
398 struct old_timeval32 tv32;
400 if (optlen < sizeof(tv32))
403 if (copy_from_sockptr(&tv32, optval, sizeof(tv32)))
405 tv->tv_sec = tv32.tv_sec;
406 tv->tv_usec = tv32.tv_usec;
407 } else if (old_timeval) {
408 struct __kernel_old_timeval old_tv;
410 if (optlen < sizeof(old_tv))
412 if (copy_from_sockptr(&old_tv, optval, sizeof(old_tv)))
414 tv->tv_sec = old_tv.tv_sec;
415 tv->tv_usec = old_tv.tv_usec;
417 if (optlen < sizeof(*tv))
419 if (copy_from_sockptr(tv, optval, sizeof(*tv)))
425 EXPORT_SYMBOL(sock_copy_user_timeval);
427 static int sock_set_timeout(long *timeo_p, sockptr_t optval, int optlen,
430 struct __kernel_sock_timeval tv;
431 int err = sock_copy_user_timeval(&tv, optval, optlen, old_timeval);
436 if (tv.tv_usec < 0 || tv.tv_usec >= USEC_PER_SEC)
440 static int warned __read_mostly;
443 if (warned < 10 && net_ratelimit()) {
445 pr_info("%s: `%s' (pid %d) tries to set negative timeout\n",
446 __func__, current->comm, task_pid_nr(current));
450 *timeo_p = MAX_SCHEDULE_TIMEOUT;
451 if (tv.tv_sec == 0 && tv.tv_usec == 0)
453 if (tv.tv_sec < (MAX_SCHEDULE_TIMEOUT / HZ - 1))
454 *timeo_p = tv.tv_sec * HZ + DIV_ROUND_UP((unsigned long)tv.tv_usec, USEC_PER_SEC / HZ);
458 static bool sock_needs_netstamp(const struct sock *sk)
460 switch (sk->sk_family) {
469 static void sock_disable_timestamp(struct sock *sk, unsigned long flags)
471 if (sk->sk_flags & flags) {
472 sk->sk_flags &= ~flags;
473 if (sock_needs_netstamp(sk) &&
474 !(sk->sk_flags & SK_FLAGS_TIMESTAMP))
475 net_disable_timestamp();
480 int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
483 struct sk_buff_head *list = &sk->sk_receive_queue;
485 if (atomic_read(&sk->sk_rmem_alloc) >= sk->sk_rcvbuf) {
486 atomic_inc(&sk->sk_drops);
487 trace_sock_rcvqueue_full(sk, skb);
491 if (!sk_rmem_schedule(sk, skb, skb->truesize)) {
492 atomic_inc(&sk->sk_drops);
497 skb_set_owner_r(skb, sk);
499 /* we escape from rcu protected region, make sure we dont leak
504 spin_lock_irqsave(&list->lock, flags);
505 sock_skb_set_dropcount(sk, skb);
506 __skb_queue_tail(list, skb);
507 spin_unlock_irqrestore(&list->lock, flags);
509 if (!sock_flag(sk, SOCK_DEAD))
510 sk->sk_data_ready(sk);
513 EXPORT_SYMBOL(__sock_queue_rcv_skb);
515 int sock_queue_rcv_skb_reason(struct sock *sk, struct sk_buff *skb,
516 enum skb_drop_reason *reason)
518 enum skb_drop_reason drop_reason;
521 err = sk_filter(sk, skb);
523 drop_reason = SKB_DROP_REASON_SOCKET_FILTER;
526 err = __sock_queue_rcv_skb(sk, skb);
529 drop_reason = SKB_DROP_REASON_SOCKET_RCVBUFF;
532 drop_reason = SKB_DROP_REASON_PROTO_MEM;
535 drop_reason = SKB_NOT_DROPPED_YET;
540 *reason = drop_reason;
543 EXPORT_SYMBOL(sock_queue_rcv_skb_reason);
545 int __sk_receive_skb(struct sock *sk, struct sk_buff *skb,
546 const int nested, unsigned int trim_cap, bool refcounted)
548 int rc = NET_RX_SUCCESS;
550 if (sk_filter_trim_cap(sk, skb, trim_cap))
551 goto discard_and_relse;
555 if (sk_rcvqueues_full(sk, sk->sk_rcvbuf)) {
556 atomic_inc(&sk->sk_drops);
557 goto discard_and_relse;
560 bh_lock_sock_nested(sk);
563 if (!sock_owned_by_user(sk)) {
565 * trylock + unlock semantics:
567 mutex_acquire(&sk->sk_lock.dep_map, 0, 1, _RET_IP_);
569 rc = sk_backlog_rcv(sk, skb);
571 mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
572 } else if (sk_add_backlog(sk, skb, READ_ONCE(sk->sk_rcvbuf))) {
574 atomic_inc(&sk->sk_drops);
575 goto discard_and_relse;
587 EXPORT_SYMBOL(__sk_receive_skb);
589 INDIRECT_CALLABLE_DECLARE(struct dst_entry *ip6_dst_check(struct dst_entry *,
591 INDIRECT_CALLABLE_DECLARE(struct dst_entry *ipv4_dst_check(struct dst_entry *,
593 struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie)
595 struct dst_entry *dst = __sk_dst_get(sk);
597 if (dst && dst->obsolete &&
598 INDIRECT_CALL_INET(dst->ops->check, ip6_dst_check, ipv4_dst_check,
599 dst, cookie) == NULL) {
600 sk_tx_queue_clear(sk);
601 sk->sk_dst_pending_confirm = 0;
602 RCU_INIT_POINTER(sk->sk_dst_cache, NULL);
609 EXPORT_SYMBOL(__sk_dst_check);
611 struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie)
613 struct dst_entry *dst = sk_dst_get(sk);
615 if (dst && dst->obsolete &&
616 INDIRECT_CALL_INET(dst->ops->check, ip6_dst_check, ipv4_dst_check,
617 dst, cookie) == NULL) {
625 EXPORT_SYMBOL(sk_dst_check);
627 static int sock_bindtoindex_locked(struct sock *sk, int ifindex)
629 int ret = -ENOPROTOOPT;
630 #ifdef CONFIG_NETDEVICES
631 struct net *net = sock_net(sk);
635 if (sk->sk_bound_dev_if && !ns_capable(net->user_ns, CAP_NET_RAW))
642 /* Paired with all READ_ONCE() done locklessly. */
643 WRITE_ONCE(sk->sk_bound_dev_if, ifindex);
645 if (sk->sk_prot->rehash)
646 sk->sk_prot->rehash(sk);
657 int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk)
663 ret = sock_bindtoindex_locked(sk, ifindex);
669 EXPORT_SYMBOL(sock_bindtoindex);
671 static int sock_setbindtodevice(struct sock *sk, sockptr_t optval, int optlen)
673 int ret = -ENOPROTOOPT;
674 #ifdef CONFIG_NETDEVICES
675 struct net *net = sock_net(sk);
676 char devname[IFNAMSIZ];
683 /* Bind this socket to a particular device like "eth0",
684 * as specified in the passed interface name. If the
685 * name is "" or the option length is zero the socket
688 if (optlen > IFNAMSIZ - 1)
689 optlen = IFNAMSIZ - 1;
690 memset(devname, 0, sizeof(devname));
693 if (copy_from_sockptr(devname, optval, optlen))
697 if (devname[0] != '\0') {
698 struct net_device *dev;
701 dev = dev_get_by_name_rcu(net, devname);
703 index = dev->ifindex;
710 sockopt_lock_sock(sk);
711 ret = sock_bindtoindex_locked(sk, index);
712 sockopt_release_sock(sk);
719 static int sock_getbindtodevice(struct sock *sk, sockptr_t optval,
720 sockptr_t optlen, int len)
722 int ret = -ENOPROTOOPT;
723 #ifdef CONFIG_NETDEVICES
724 int bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
725 struct net *net = sock_net(sk);
726 char devname[IFNAMSIZ];
728 if (bound_dev_if == 0) {
737 ret = netdev_get_name(net, devname, bound_dev_if);
741 len = strlen(devname) + 1;
744 if (copy_to_sockptr(optval, devname, len))
749 if (copy_to_sockptr(optlen, &len, sizeof(int)))
760 bool sk_mc_loop(struct sock *sk)
762 if (dev_recursion_level())
766 switch (sk->sk_family) {
768 return inet_sk(sk)->mc_loop;
769 #if IS_ENABLED(CONFIG_IPV6)
771 return inet6_sk(sk)->mc_loop;
777 EXPORT_SYMBOL(sk_mc_loop);
779 void sock_set_reuseaddr(struct sock *sk)
782 sk->sk_reuse = SK_CAN_REUSE;
785 EXPORT_SYMBOL(sock_set_reuseaddr);
787 void sock_set_reuseport(struct sock *sk)
790 sk->sk_reuseport = true;
793 EXPORT_SYMBOL(sock_set_reuseport);
795 void sock_no_linger(struct sock *sk)
798 sk->sk_lingertime = 0;
799 sock_set_flag(sk, SOCK_LINGER);
802 EXPORT_SYMBOL(sock_no_linger);
804 void sock_set_priority(struct sock *sk, u32 priority)
807 sk->sk_priority = priority;
810 EXPORT_SYMBOL(sock_set_priority);
812 void sock_set_sndtimeo(struct sock *sk, s64 secs)
815 if (secs && secs < MAX_SCHEDULE_TIMEOUT / HZ - 1)
816 sk->sk_sndtimeo = secs * HZ;
818 sk->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
821 EXPORT_SYMBOL(sock_set_sndtimeo);
823 static void __sock_set_timestamps(struct sock *sk, bool val, bool new, bool ns)
826 sock_valbool_flag(sk, SOCK_TSTAMP_NEW, new);
827 sock_valbool_flag(sk, SOCK_RCVTSTAMPNS, ns);
828 sock_set_flag(sk, SOCK_RCVTSTAMP);
829 sock_enable_timestamp(sk, SOCK_TIMESTAMP);
831 sock_reset_flag(sk, SOCK_RCVTSTAMP);
832 sock_reset_flag(sk, SOCK_RCVTSTAMPNS);
836 void sock_enable_timestamps(struct sock *sk)
839 __sock_set_timestamps(sk, true, false, true);
842 EXPORT_SYMBOL(sock_enable_timestamps);
844 void sock_set_timestamp(struct sock *sk, int optname, bool valbool)
847 case SO_TIMESTAMP_OLD:
848 __sock_set_timestamps(sk, valbool, false, false);
850 case SO_TIMESTAMP_NEW:
851 __sock_set_timestamps(sk, valbool, true, false);
853 case SO_TIMESTAMPNS_OLD:
854 __sock_set_timestamps(sk, valbool, false, true);
856 case SO_TIMESTAMPNS_NEW:
857 __sock_set_timestamps(sk, valbool, true, true);
862 static int sock_timestamping_bind_phc(struct sock *sk, int phc_index)
864 struct net *net = sock_net(sk);
865 struct net_device *dev = NULL;
870 if (sk->sk_bound_dev_if)
871 dev = dev_get_by_index(net, sk->sk_bound_dev_if);
874 pr_err("%s: sock not bind to device\n", __func__);
878 num = ethtool_get_phc_vclocks(dev, &vclock_index);
881 for (i = 0; i < num; i++) {
882 if (*(vclock_index + i) == phc_index) {
894 sk->sk_bind_phc = phc_index;
899 int sock_set_timestamping(struct sock *sk, int optname,
900 struct so_timestamping timestamping)
902 int val = timestamping.flags;
905 if (val & ~SOF_TIMESTAMPING_MASK)
908 if (val & SOF_TIMESTAMPING_OPT_ID_TCP &&
909 !(val & SOF_TIMESTAMPING_OPT_ID))
912 if (val & SOF_TIMESTAMPING_OPT_ID &&
913 !(sk->sk_tsflags & SOF_TIMESTAMPING_OPT_ID)) {
915 if ((1 << sk->sk_state) &
916 (TCPF_CLOSE | TCPF_LISTEN))
918 if (val & SOF_TIMESTAMPING_OPT_ID_TCP)
919 atomic_set(&sk->sk_tskey, tcp_sk(sk)->write_seq);
921 atomic_set(&sk->sk_tskey, tcp_sk(sk)->snd_una);
923 atomic_set(&sk->sk_tskey, 0);
927 if (val & SOF_TIMESTAMPING_OPT_STATS &&
928 !(val & SOF_TIMESTAMPING_OPT_TSONLY))
931 if (val & SOF_TIMESTAMPING_BIND_PHC) {
932 ret = sock_timestamping_bind_phc(sk, timestamping.bind_phc);
937 sk->sk_tsflags = val;
938 sock_valbool_flag(sk, SOCK_TSTAMP_NEW, optname == SO_TIMESTAMPING_NEW);
940 if (val & SOF_TIMESTAMPING_RX_SOFTWARE)
941 sock_enable_timestamp(sk,
942 SOCK_TIMESTAMPING_RX_SOFTWARE);
944 sock_disable_timestamp(sk,
945 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE));
949 void sock_set_keepalive(struct sock *sk)
952 if (sk->sk_prot->keepalive)
953 sk->sk_prot->keepalive(sk, true);
954 sock_valbool_flag(sk, SOCK_KEEPOPEN, true);
957 EXPORT_SYMBOL(sock_set_keepalive);
959 static void __sock_set_rcvbuf(struct sock *sk, int val)
961 /* Ensure val * 2 fits into an int, to prevent max_t() from treating it
962 * as a negative value.
964 val = min_t(int, val, INT_MAX / 2);
965 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
967 /* We double it on the way in to account for "struct sk_buff" etc.
968 * overhead. Applications assume that the SO_RCVBUF setting they make
969 * will allow that much actual data to be received on that socket.
971 * Applications are unaware that "struct sk_buff" and other overheads
972 * allocate from the receive buffer during socket buffer allocation.
974 * And after considering the possible alternatives, returning the value
975 * we actually used in getsockopt is the most desirable behavior.
977 WRITE_ONCE(sk->sk_rcvbuf, max_t(int, val * 2, SOCK_MIN_RCVBUF));
980 void sock_set_rcvbuf(struct sock *sk, int val)
983 __sock_set_rcvbuf(sk, val);
986 EXPORT_SYMBOL(sock_set_rcvbuf);
988 static void __sock_set_mark(struct sock *sk, u32 val)
990 if (val != sk->sk_mark) {
996 void sock_set_mark(struct sock *sk, u32 val)
999 __sock_set_mark(sk, val);
1002 EXPORT_SYMBOL(sock_set_mark);
1004 static void sock_release_reserved_memory(struct sock *sk, int bytes)
1006 /* Round down bytes to multiple of pages */
1007 bytes = round_down(bytes, PAGE_SIZE);
1009 WARN_ON(bytes > sk->sk_reserved_mem);
1010 sk->sk_reserved_mem -= bytes;
1014 static int sock_reserve_memory(struct sock *sk, int bytes)
1020 if (!mem_cgroup_sockets_enabled || !sk->sk_memcg || !sk_has_account(sk))
1026 pages = sk_mem_pages(bytes);
1028 /* pre-charge to memcg */
1029 charged = mem_cgroup_charge_skmem(sk->sk_memcg, pages,
1030 GFP_KERNEL | __GFP_RETRY_MAYFAIL);
1034 /* pre-charge to forward_alloc */
1035 sk_memory_allocated_add(sk, pages);
1036 allocated = sk_memory_allocated(sk);
1037 /* If the system goes into memory pressure with this
1038 * precharge, give up and return error.
1040 if (allocated > sk_prot_mem_limits(sk, 1)) {
1041 sk_memory_allocated_sub(sk, pages);
1042 mem_cgroup_uncharge_skmem(sk->sk_memcg, pages);
1045 sk->sk_forward_alloc += pages << PAGE_SHIFT;
1047 sk->sk_reserved_mem += pages << PAGE_SHIFT;
1052 void sockopt_lock_sock(struct sock *sk)
1054 /* When current->bpf_ctx is set, the setsockopt is called from
1055 * a bpf prog. bpf has ensured the sk lock has been
1056 * acquired before calling setsockopt().
1058 if (has_current_bpf_ctx())
1063 EXPORT_SYMBOL(sockopt_lock_sock);
1065 void sockopt_release_sock(struct sock *sk)
1067 if (has_current_bpf_ctx())
1072 EXPORT_SYMBOL(sockopt_release_sock);
1074 bool sockopt_ns_capable(struct user_namespace *ns, int cap)
1076 return has_current_bpf_ctx() || ns_capable(ns, cap);
1078 EXPORT_SYMBOL(sockopt_ns_capable);
1080 bool sockopt_capable(int cap)
1082 return has_current_bpf_ctx() || capable(cap);
1084 EXPORT_SYMBOL(sockopt_capable);
1087 * This is meant for all protocols to use and covers goings on
1088 * at the socket level. Everything here is generic.
1091 int sk_setsockopt(struct sock *sk, int level, int optname,
1092 sockptr_t optval, unsigned int optlen)
1094 struct so_timestamping timestamping;
1095 struct socket *sock = sk->sk_socket;
1096 struct sock_txtime sk_txtime;
1103 * Options without arguments
1106 if (optname == SO_BINDTODEVICE)
1107 return sock_setbindtodevice(sk, optval, optlen);
1109 if (optlen < sizeof(int))
1112 if (copy_from_sockptr(&val, optval, sizeof(val)))
1115 valbool = val ? 1 : 0;
1117 sockopt_lock_sock(sk);
1121 if (val && !sockopt_capable(CAP_NET_ADMIN))
1124 sock_valbool_flag(sk, SOCK_DBG, valbool);
1127 sk->sk_reuse = (valbool ? SK_CAN_REUSE : SK_NO_REUSE);
1130 sk->sk_reuseport = valbool;
1139 sock_valbool_flag(sk, SOCK_LOCALROUTE, valbool);
1143 sock_valbool_flag(sk, SOCK_BROADCAST, valbool);
1146 /* Don't error on this BSD doesn't and if you think
1147 * about it this is right. Otherwise apps have to
1148 * play 'guess the biggest size' games. RCVBUF/SNDBUF
1149 * are treated in BSD as hints
1151 val = min_t(u32, val, READ_ONCE(sysctl_wmem_max));
1153 /* Ensure val * 2 fits into an int, to prevent max_t()
1154 * from treating it as a negative value.
1156 val = min_t(int, val, INT_MAX / 2);
1157 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1158 WRITE_ONCE(sk->sk_sndbuf,
1159 max_t(int, val * 2, SOCK_MIN_SNDBUF));
1160 /* Wake up sending tasks if we upped the value. */
1161 sk->sk_write_space(sk);
1164 case SO_SNDBUFFORCE:
1165 if (!sockopt_capable(CAP_NET_ADMIN)) {
1170 /* No negative values (to prevent underflow, as val will be
1178 /* Don't error on this BSD doesn't and if you think
1179 * about it this is right. Otherwise apps have to
1180 * play 'guess the biggest size' games. RCVBUF/SNDBUF
1181 * are treated in BSD as hints
1183 __sock_set_rcvbuf(sk, min_t(u32, val, READ_ONCE(sysctl_rmem_max)));
1186 case SO_RCVBUFFORCE:
1187 if (!sockopt_capable(CAP_NET_ADMIN)) {
1192 /* No negative values (to prevent underflow, as val will be
1195 __sock_set_rcvbuf(sk, max(val, 0));
1199 if (sk->sk_prot->keepalive)
1200 sk->sk_prot->keepalive(sk, valbool);
1201 sock_valbool_flag(sk, SOCK_KEEPOPEN, valbool);
1205 sock_valbool_flag(sk, SOCK_URGINLINE, valbool);
1209 sk->sk_no_check_tx = valbool;
1213 if ((val >= 0 && val <= 6) ||
1214 sockopt_ns_capable(sock_net(sk)->user_ns, CAP_NET_RAW) ||
1215 sockopt_ns_capable(sock_net(sk)->user_ns, CAP_NET_ADMIN))
1216 sk->sk_priority = val;
1222 if (optlen < sizeof(ling)) {
1223 ret = -EINVAL; /* 1003.1g */
1226 if (copy_from_sockptr(&ling, optval, sizeof(ling))) {
1231 sock_reset_flag(sk, SOCK_LINGER);
1233 #if (BITS_PER_LONG == 32)
1234 if ((unsigned int)ling.l_linger >= MAX_SCHEDULE_TIMEOUT/HZ)
1235 sk->sk_lingertime = MAX_SCHEDULE_TIMEOUT;
1238 sk->sk_lingertime = (unsigned int)ling.l_linger * HZ;
1239 sock_set_flag(sk, SOCK_LINGER);
1248 set_bit(SOCK_PASSCRED, &sock->flags);
1250 clear_bit(SOCK_PASSCRED, &sock->flags);
1255 set_bit(SOCK_PASSPIDFD, &sock->flags);
1257 clear_bit(SOCK_PASSPIDFD, &sock->flags);
1260 case SO_TIMESTAMP_OLD:
1261 case SO_TIMESTAMP_NEW:
1262 case SO_TIMESTAMPNS_OLD:
1263 case SO_TIMESTAMPNS_NEW:
1264 sock_set_timestamp(sk, optname, valbool);
1267 case SO_TIMESTAMPING_NEW:
1268 case SO_TIMESTAMPING_OLD:
1269 if (optlen == sizeof(timestamping)) {
1270 if (copy_from_sockptr(×tamping, optval,
1271 sizeof(timestamping))) {
1276 memset(×tamping, 0, sizeof(timestamping));
1277 timestamping.flags = val;
1279 ret = sock_set_timestamping(sk, optname, timestamping);
1285 if (sock && sock->ops->set_rcvlowat)
1286 ret = sock->ops->set_rcvlowat(sk, val);
1288 WRITE_ONCE(sk->sk_rcvlowat, val ? : 1);
1291 case SO_RCVTIMEO_OLD:
1292 case SO_RCVTIMEO_NEW:
1293 ret = sock_set_timeout(&sk->sk_rcvtimeo, optval,
1294 optlen, optname == SO_RCVTIMEO_OLD);
1297 case SO_SNDTIMEO_OLD:
1298 case SO_SNDTIMEO_NEW:
1299 ret = sock_set_timeout(&sk->sk_sndtimeo, optval,
1300 optlen, optname == SO_SNDTIMEO_OLD);
1303 case SO_ATTACH_FILTER: {
1304 struct sock_fprog fprog;
1306 ret = copy_bpf_fprog_from_user(&fprog, optval, optlen);
1308 ret = sk_attach_filter(&fprog, sk);
1313 if (optlen == sizeof(u32)) {
1317 if (copy_from_sockptr(&ufd, optval, sizeof(ufd)))
1320 ret = sk_attach_bpf(ufd, sk);
1324 case SO_ATTACH_REUSEPORT_CBPF: {
1325 struct sock_fprog fprog;
1327 ret = copy_bpf_fprog_from_user(&fprog, optval, optlen);
1329 ret = sk_reuseport_attach_filter(&fprog, sk);
1332 case SO_ATTACH_REUSEPORT_EBPF:
1334 if (optlen == sizeof(u32)) {
1338 if (copy_from_sockptr(&ufd, optval, sizeof(ufd)))
1341 ret = sk_reuseport_attach_bpf(ufd, sk);
1345 case SO_DETACH_REUSEPORT_BPF:
1346 ret = reuseport_detach_prog(sk);
1349 case SO_DETACH_FILTER:
1350 ret = sk_detach_filter(sk);
1353 case SO_LOCK_FILTER:
1354 if (sock_flag(sk, SOCK_FILTER_LOCKED) && !valbool)
1357 sock_valbool_flag(sk, SOCK_FILTER_LOCKED, valbool);
1362 set_bit(SOCK_PASSSEC, &sock->flags);
1364 clear_bit(SOCK_PASSSEC, &sock->flags);
1367 if (!sockopt_ns_capable(sock_net(sk)->user_ns, CAP_NET_RAW) &&
1368 !sockopt_ns_capable(sock_net(sk)->user_ns, CAP_NET_ADMIN)) {
1373 __sock_set_mark(sk, val);
1376 sock_valbool_flag(sk, SOCK_RCVMARK, valbool);
1380 sock_valbool_flag(sk, SOCK_RXQ_OVFL, valbool);
1383 case SO_WIFI_STATUS:
1384 sock_valbool_flag(sk, SOCK_WIFI_STATUS, valbool);
1388 if (sock->ops->set_peek_off)
1389 ret = sock->ops->set_peek_off(sk, val);
1395 sock_valbool_flag(sk, SOCK_NOFCS, valbool);
1398 case SO_SELECT_ERR_QUEUE:
1399 sock_valbool_flag(sk, SOCK_SELECT_ERR_QUEUE, valbool);
1402 #ifdef CONFIG_NET_RX_BUSY_POLL
1407 WRITE_ONCE(sk->sk_ll_usec, val);
1409 case SO_PREFER_BUSY_POLL:
1410 if (valbool && !sockopt_capable(CAP_NET_ADMIN))
1413 WRITE_ONCE(sk->sk_prefer_busy_poll, valbool);
1415 case SO_BUSY_POLL_BUDGET:
1416 if (val > READ_ONCE(sk->sk_busy_poll_budget) && !sockopt_capable(CAP_NET_ADMIN)) {
1419 if (val < 0 || val > U16_MAX)
1422 WRITE_ONCE(sk->sk_busy_poll_budget, val);
1427 case SO_MAX_PACING_RATE:
1429 unsigned long ulval = (val == ~0U) ? ~0UL : (unsigned int)val;
1431 if (sizeof(ulval) != sizeof(val) &&
1432 optlen >= sizeof(ulval) &&
1433 copy_from_sockptr(&ulval, optval, sizeof(ulval))) {
1438 cmpxchg(&sk->sk_pacing_status,
1441 sk->sk_max_pacing_rate = ulval;
1442 sk->sk_pacing_rate = min(sk->sk_pacing_rate, ulval);
1445 case SO_INCOMING_CPU:
1446 reuseport_update_incoming_cpu(sk, val);
1451 dst_negative_advice(sk);
1455 if (sk->sk_family == PF_INET || sk->sk_family == PF_INET6) {
1456 if (!(sk_is_tcp(sk) ||
1457 (sk->sk_type == SOCK_DGRAM &&
1458 sk->sk_protocol == IPPROTO_UDP)))
1460 } else if (sk->sk_family != PF_RDS) {
1464 if (val < 0 || val > 1)
1467 sock_valbool_flag(sk, SOCK_ZEROCOPY, valbool);
1472 if (optlen != sizeof(struct sock_txtime)) {
1475 } else if (copy_from_sockptr(&sk_txtime, optval,
1476 sizeof(struct sock_txtime))) {
1479 } else if (sk_txtime.flags & ~SOF_TXTIME_FLAGS_MASK) {
1483 /* CLOCK_MONOTONIC is only used by sch_fq, and this packet
1484 * scheduler has enough safe guards.
1486 if (sk_txtime.clockid != CLOCK_MONOTONIC &&
1487 !sockopt_ns_capable(sock_net(sk)->user_ns, CAP_NET_ADMIN)) {
1491 sock_valbool_flag(sk, SOCK_TXTIME, true);
1492 sk->sk_clockid = sk_txtime.clockid;
1493 sk->sk_txtime_deadline_mode =
1494 !!(sk_txtime.flags & SOF_TXTIME_DEADLINE_MODE);
1495 sk->sk_txtime_report_errors =
1496 !!(sk_txtime.flags & SOF_TXTIME_REPORT_ERRORS);
1499 case SO_BINDTOIFINDEX:
1500 ret = sock_bindtoindex_locked(sk, val);
1504 if (val & ~SOCK_BUF_LOCK_MASK) {
1508 sk->sk_userlocks = val | (sk->sk_userlocks &
1509 ~SOCK_BUF_LOCK_MASK);
1512 case SO_RESERVE_MEM:
1521 delta = val - sk->sk_reserved_mem;
1523 sock_release_reserved_memory(sk, -delta);
1525 ret = sock_reserve_memory(sk, delta);
1530 if (val < -1 || val > 1) {
1534 if ((u8)val == SOCK_TXREHASH_DEFAULT)
1535 val = READ_ONCE(sock_net(sk)->core.sysctl_txrehash);
1536 /* Paired with READ_ONCE() in tcp_rtx_synack() */
1537 WRITE_ONCE(sk->sk_txrehash, (u8)val);
1544 sockopt_release_sock(sk);
1548 int sock_setsockopt(struct socket *sock, int level, int optname,
1549 sockptr_t optval, unsigned int optlen)
1551 return sk_setsockopt(sock->sk, level, optname,
1554 EXPORT_SYMBOL(sock_setsockopt);
1556 static const struct cred *sk_get_peer_cred(struct sock *sk)
1558 const struct cred *cred;
1560 spin_lock(&sk->sk_peer_lock);
1561 cred = get_cred(sk->sk_peer_cred);
1562 spin_unlock(&sk->sk_peer_lock);
1567 static void cred_to_ucred(struct pid *pid, const struct cred *cred,
1568 struct ucred *ucred)
1570 ucred->pid = pid_vnr(pid);
1571 ucred->uid = ucred->gid = -1;
1573 struct user_namespace *current_ns = current_user_ns();
1575 ucred->uid = from_kuid_munged(current_ns, cred->euid);
1576 ucred->gid = from_kgid_munged(current_ns, cred->egid);
1580 static int groups_to_user(sockptr_t dst, const struct group_info *src)
1582 struct user_namespace *user_ns = current_user_ns();
1585 for (i = 0; i < src->ngroups; i++) {
1586 gid_t gid = from_kgid_munged(user_ns, src->gid[i]);
1588 if (copy_to_sockptr_offset(dst, i * sizeof(gid), &gid, sizeof(gid)))
1595 int sk_getsockopt(struct sock *sk, int level, int optname,
1596 sockptr_t optval, sockptr_t optlen)
1598 struct socket *sock = sk->sk_socket;
1603 unsigned long ulval;
1605 struct old_timeval32 tm32;
1606 struct __kernel_old_timeval tm;
1607 struct __kernel_sock_timeval stm;
1608 struct sock_txtime txtime;
1609 struct so_timestamping timestamping;
1612 int lv = sizeof(int);
1615 if (copy_from_sockptr(&len, optlen, sizeof(int)))
1620 memset(&v, 0, sizeof(v));
1624 v.val = sock_flag(sk, SOCK_DBG);
1628 v.val = sock_flag(sk, SOCK_LOCALROUTE);
1632 v.val = sock_flag(sk, SOCK_BROADCAST);
1636 v.val = sk->sk_sndbuf;
1640 v.val = sk->sk_rcvbuf;
1644 v.val = sk->sk_reuse;
1648 v.val = sk->sk_reuseport;
1652 v.val = sock_flag(sk, SOCK_KEEPOPEN);
1656 v.val = sk->sk_type;
1660 v.val = sk->sk_protocol;
1664 v.val = sk->sk_family;
1668 v.val = -sock_error(sk);
1670 v.val = xchg(&sk->sk_err_soft, 0);
1674 v.val = sock_flag(sk, SOCK_URGINLINE);
1678 v.val = sk->sk_no_check_tx;
1682 v.val = sk->sk_priority;
1686 lv = sizeof(v.ling);
1687 v.ling.l_onoff = sock_flag(sk, SOCK_LINGER);
1688 v.ling.l_linger = sk->sk_lingertime / HZ;
1694 case SO_TIMESTAMP_OLD:
1695 v.val = sock_flag(sk, SOCK_RCVTSTAMP) &&
1696 !sock_flag(sk, SOCK_TSTAMP_NEW) &&
1697 !sock_flag(sk, SOCK_RCVTSTAMPNS);
1700 case SO_TIMESTAMPNS_OLD:
1701 v.val = sock_flag(sk, SOCK_RCVTSTAMPNS) && !sock_flag(sk, SOCK_TSTAMP_NEW);
1704 case SO_TIMESTAMP_NEW:
1705 v.val = sock_flag(sk, SOCK_RCVTSTAMP) && sock_flag(sk, SOCK_TSTAMP_NEW);
1708 case SO_TIMESTAMPNS_NEW:
1709 v.val = sock_flag(sk, SOCK_RCVTSTAMPNS) && sock_flag(sk, SOCK_TSTAMP_NEW);
1712 case SO_TIMESTAMPING_OLD:
1713 lv = sizeof(v.timestamping);
1714 v.timestamping.flags = sk->sk_tsflags;
1715 v.timestamping.bind_phc = sk->sk_bind_phc;
1718 case SO_RCVTIMEO_OLD:
1719 case SO_RCVTIMEO_NEW:
1720 lv = sock_get_timeout(sk->sk_rcvtimeo, &v, SO_RCVTIMEO_OLD == optname);
1723 case SO_SNDTIMEO_OLD:
1724 case SO_SNDTIMEO_NEW:
1725 lv = sock_get_timeout(sk->sk_sndtimeo, &v, SO_SNDTIMEO_OLD == optname);
1729 v.val = sk->sk_rcvlowat;
1737 v.val = !!test_bit(SOCK_PASSCRED, &sock->flags);
1741 v.val = !!test_bit(SOCK_PASSPIDFD, &sock->flags);
1746 struct ucred peercred;
1747 if (len > sizeof(peercred))
1748 len = sizeof(peercred);
1750 spin_lock(&sk->sk_peer_lock);
1751 cred_to_ucred(sk->sk_peer_pid, sk->sk_peer_cred, &peercred);
1752 spin_unlock(&sk->sk_peer_lock);
1754 if (copy_to_sockptr(optval, &peercred, len))
1761 struct pid *peer_pid;
1762 struct file *pidfd_file = NULL;
1765 if (len > sizeof(pidfd))
1766 len = sizeof(pidfd);
1768 spin_lock(&sk->sk_peer_lock);
1769 peer_pid = get_pid(sk->sk_peer_pid);
1770 spin_unlock(&sk->sk_peer_lock);
1775 pidfd = pidfd_prepare(peer_pid, 0, &pidfd_file);
1780 if (copy_to_sockptr(optval, &pidfd, len) ||
1781 copy_to_sockptr(optlen, &len, sizeof(int))) {
1782 put_unused_fd(pidfd);
1788 fd_install(pidfd, pidfd_file);
1794 const struct cred *cred;
1797 cred = sk_get_peer_cred(sk);
1801 n = cred->group_info->ngroups;
1802 if (len < n * sizeof(gid_t)) {
1803 len = n * sizeof(gid_t);
1805 return copy_to_sockptr(optlen, &len, sizeof(int)) ? -EFAULT : -ERANGE;
1807 len = n * sizeof(gid_t);
1809 ret = groups_to_user(optval, cred->group_info);
1820 lv = sock->ops->getname(sock, (struct sockaddr *)address, 2);
1825 if (copy_to_sockptr(optval, address, len))
1830 /* Dubious BSD thing... Probably nobody even uses it, but
1831 * the UNIX standard wants it for whatever reason... -DaveM
1834 v.val = sk->sk_state == TCP_LISTEN;
1838 v.val = !!test_bit(SOCK_PASSSEC, &sock->flags);
1842 return security_socket_getpeersec_stream(sock,
1843 optval, optlen, len);
1846 v.val = sk->sk_mark;
1850 v.val = sock_flag(sk, SOCK_RCVMARK);
1854 v.val = sock_flag(sk, SOCK_RXQ_OVFL);
1857 case SO_WIFI_STATUS:
1858 v.val = sock_flag(sk, SOCK_WIFI_STATUS);
1862 if (!sock->ops->set_peek_off)
1865 v.val = sk->sk_peek_off;
1868 v.val = sock_flag(sk, SOCK_NOFCS);
1871 case SO_BINDTODEVICE:
1872 return sock_getbindtodevice(sk, optval, optlen, len);
1875 len = sk_get_filter(sk, optval, len);
1881 case SO_LOCK_FILTER:
1882 v.val = sock_flag(sk, SOCK_FILTER_LOCKED);
1885 case SO_BPF_EXTENSIONS:
1886 v.val = bpf_tell_extensions();
1889 case SO_SELECT_ERR_QUEUE:
1890 v.val = sock_flag(sk, SOCK_SELECT_ERR_QUEUE);
1893 #ifdef CONFIG_NET_RX_BUSY_POLL
1895 v.val = sk->sk_ll_usec;
1897 case SO_PREFER_BUSY_POLL:
1898 v.val = READ_ONCE(sk->sk_prefer_busy_poll);
1902 case SO_MAX_PACING_RATE:
1903 if (sizeof(v.ulval) != sizeof(v.val) && len >= sizeof(v.ulval)) {
1904 lv = sizeof(v.ulval);
1905 v.ulval = sk->sk_max_pacing_rate;
1908 v.val = min_t(unsigned long, sk->sk_max_pacing_rate, ~0U);
1912 case SO_INCOMING_CPU:
1913 v.val = READ_ONCE(sk->sk_incoming_cpu);
1918 u32 meminfo[SK_MEMINFO_VARS];
1920 sk_get_meminfo(sk, meminfo);
1922 len = min_t(unsigned int, len, sizeof(meminfo));
1923 if (copy_to_sockptr(optval, &meminfo, len))
1929 #ifdef CONFIG_NET_RX_BUSY_POLL
1930 case SO_INCOMING_NAPI_ID:
1931 v.val = READ_ONCE(sk->sk_napi_id);
1933 /* aggregate non-NAPI IDs down to 0 */
1934 if (v.val < MIN_NAPI_ID)
1944 v.val64 = sock_gen_cookie(sk);
1948 v.val = sock_flag(sk, SOCK_ZEROCOPY);
1952 lv = sizeof(v.txtime);
1953 v.txtime.clockid = sk->sk_clockid;
1954 v.txtime.flags |= sk->sk_txtime_deadline_mode ?
1955 SOF_TXTIME_DEADLINE_MODE : 0;
1956 v.txtime.flags |= sk->sk_txtime_report_errors ?
1957 SOF_TXTIME_REPORT_ERRORS : 0;
1960 case SO_BINDTOIFINDEX:
1961 v.val = READ_ONCE(sk->sk_bound_dev_if);
1964 case SO_NETNS_COOKIE:
1968 v.val64 = sock_net(sk)->net_cookie;
1972 v.val = sk->sk_userlocks & SOCK_BUF_LOCK_MASK;
1975 case SO_RESERVE_MEM:
1976 v.val = sk->sk_reserved_mem;
1980 v.val = sk->sk_txrehash;
1984 /* We implement the SO_SNDLOWAT etc to not be settable
1987 return -ENOPROTOOPT;
1992 if (copy_to_sockptr(optval, &v, len))
1995 if (copy_to_sockptr(optlen, &len, sizeof(int)))
2000 int sock_getsockopt(struct socket *sock, int level, int optname,
2001 char __user *optval, int __user *optlen)
2003 return sk_getsockopt(sock->sk, level, optname,
2004 USER_SOCKPTR(optval),
2005 USER_SOCKPTR(optlen));
2009 * Initialize an sk_lock.
2011 * (We also register the sk_lock with the lock validator.)
2013 static inline void sock_lock_init(struct sock *sk)
2015 if (sk->sk_kern_sock)
2016 sock_lock_init_class_and_name(
2018 af_family_kern_slock_key_strings[sk->sk_family],
2019 af_family_kern_slock_keys + sk->sk_family,
2020 af_family_kern_key_strings[sk->sk_family],
2021 af_family_kern_keys + sk->sk_family);
2023 sock_lock_init_class_and_name(
2025 af_family_slock_key_strings[sk->sk_family],
2026 af_family_slock_keys + sk->sk_family,
2027 af_family_key_strings[sk->sk_family],
2028 af_family_keys + sk->sk_family);
2032 * Copy all fields from osk to nsk but nsk->sk_refcnt must not change yet,
2033 * even temporarly, because of RCU lookups. sk_node should also be left as is.
2034 * We must not copy fields between sk_dontcopy_begin and sk_dontcopy_end
2036 static void sock_copy(struct sock *nsk, const struct sock *osk)
2038 const struct proto *prot = READ_ONCE(osk->sk_prot);
2039 #ifdef CONFIG_SECURITY_NETWORK
2040 void *sptr = nsk->sk_security;
2043 /* If we move sk_tx_queue_mapping out of the private section,
2044 * we must check if sk_tx_queue_clear() is called after
2045 * sock_copy() in sk_clone_lock().
2047 BUILD_BUG_ON(offsetof(struct sock, sk_tx_queue_mapping) <
2048 offsetof(struct sock, sk_dontcopy_begin) ||
2049 offsetof(struct sock, sk_tx_queue_mapping) >=
2050 offsetof(struct sock, sk_dontcopy_end));
2052 memcpy(nsk, osk, offsetof(struct sock, sk_dontcopy_begin));
2054 memcpy(&nsk->sk_dontcopy_end, &osk->sk_dontcopy_end,
2055 prot->obj_size - offsetof(struct sock, sk_dontcopy_end));
2057 #ifdef CONFIG_SECURITY_NETWORK
2058 nsk->sk_security = sptr;
2059 security_sk_clone(osk, nsk);
2063 static struct sock *sk_prot_alloc(struct proto *prot, gfp_t priority,
2067 struct kmem_cache *slab;
2071 sk = kmem_cache_alloc(slab, priority & ~__GFP_ZERO);
2074 if (want_init_on_alloc(priority))
2075 sk_prot_clear_nulls(sk, prot->obj_size);
2077 sk = kmalloc(prot->obj_size, priority);
2080 if (security_sk_alloc(sk, family, priority))
2083 if (!try_module_get(prot->owner))
2090 security_sk_free(sk);
2093 kmem_cache_free(slab, sk);
2099 static void sk_prot_free(struct proto *prot, struct sock *sk)
2101 struct kmem_cache *slab;
2102 struct module *owner;
2104 owner = prot->owner;
2107 cgroup_sk_free(&sk->sk_cgrp_data);
2108 mem_cgroup_sk_free(sk);
2109 security_sk_free(sk);
2111 kmem_cache_free(slab, sk);
2118 * sk_alloc - All socket objects are allocated here
2119 * @net: the applicable net namespace
2120 * @family: protocol family
2121 * @priority: for allocation (%GFP_KERNEL, %GFP_ATOMIC, etc)
2122 * @prot: struct proto associated with this new sock instance
2123 * @kern: is this to be a kernel socket?
2125 struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
2126 struct proto *prot, int kern)
2130 sk = sk_prot_alloc(prot, priority | __GFP_ZERO, family);
2132 sk->sk_family = family;
2134 * See comment in struct sock definition to understand
2135 * why we need sk_prot_creator -acme
2137 sk->sk_prot = sk->sk_prot_creator = prot;
2138 sk->sk_kern_sock = kern;
2140 sk->sk_net_refcnt = kern ? 0 : 1;
2141 if (likely(sk->sk_net_refcnt)) {
2142 get_net_track(net, &sk->ns_tracker, priority);
2143 sock_inuse_add(net, 1);
2145 __netns_tracker_alloc(net, &sk->ns_tracker,
2149 sock_net_set(sk, net);
2150 refcount_set(&sk->sk_wmem_alloc, 1);
2152 mem_cgroup_sk_alloc(sk);
2153 cgroup_sk_alloc(&sk->sk_cgrp_data);
2154 sock_update_classid(&sk->sk_cgrp_data);
2155 sock_update_netprioidx(&sk->sk_cgrp_data);
2156 sk_tx_queue_clear(sk);
2161 EXPORT_SYMBOL(sk_alloc);
2163 /* Sockets having SOCK_RCU_FREE will call this function after one RCU
2164 * grace period. This is the case for UDP sockets and TCP listeners.
2166 static void __sk_destruct(struct rcu_head *head)
2168 struct sock *sk = container_of(head, struct sock, sk_rcu);
2169 struct sk_filter *filter;
2171 if (sk->sk_destruct)
2172 sk->sk_destruct(sk);
2174 filter = rcu_dereference_check(sk->sk_filter,
2175 refcount_read(&sk->sk_wmem_alloc) == 0);
2177 sk_filter_uncharge(sk, filter);
2178 RCU_INIT_POINTER(sk->sk_filter, NULL);
2181 sock_disable_timestamp(sk, SK_FLAGS_TIMESTAMP);
2183 #ifdef CONFIG_BPF_SYSCALL
2184 bpf_sk_storage_free(sk);
2187 if (atomic_read(&sk->sk_omem_alloc))
2188 pr_debug("%s: optmem leakage (%d bytes) detected\n",
2189 __func__, atomic_read(&sk->sk_omem_alloc));
2191 if (sk->sk_frag.page) {
2192 put_page(sk->sk_frag.page);
2193 sk->sk_frag.page = NULL;
2196 /* We do not need to acquire sk->sk_peer_lock, we are the last user. */
2197 put_cred(sk->sk_peer_cred);
2198 put_pid(sk->sk_peer_pid);
2200 if (likely(sk->sk_net_refcnt))
2201 put_net_track(sock_net(sk), &sk->ns_tracker);
2203 __netns_tracker_free(sock_net(sk), &sk->ns_tracker, false);
2205 sk_prot_free(sk->sk_prot_creator, sk);
2208 void sk_destruct(struct sock *sk)
2210 bool use_call_rcu = sock_flag(sk, SOCK_RCU_FREE);
2212 if (rcu_access_pointer(sk->sk_reuseport_cb)) {
2213 reuseport_detach_sock(sk);
2214 use_call_rcu = true;
2218 call_rcu(&sk->sk_rcu, __sk_destruct);
2220 __sk_destruct(&sk->sk_rcu);
2223 static void __sk_free(struct sock *sk)
2225 if (likely(sk->sk_net_refcnt))
2226 sock_inuse_add(sock_net(sk), -1);
2228 if (unlikely(sk->sk_net_refcnt && sock_diag_has_destroy_listeners(sk)))
2229 sock_diag_broadcast_destroy(sk);
2234 void sk_free(struct sock *sk)
2237 * We subtract one from sk_wmem_alloc and can know if
2238 * some packets are still in some tx queue.
2239 * If not null, sock_wfree() will call __sk_free(sk) later
2241 if (refcount_dec_and_test(&sk->sk_wmem_alloc))
2244 EXPORT_SYMBOL(sk_free);
2246 static void sk_init_common(struct sock *sk)
2248 skb_queue_head_init(&sk->sk_receive_queue);
2249 skb_queue_head_init(&sk->sk_write_queue);
2250 skb_queue_head_init(&sk->sk_error_queue);
2252 rwlock_init(&sk->sk_callback_lock);
2253 lockdep_set_class_and_name(&sk->sk_receive_queue.lock,
2254 af_rlock_keys + sk->sk_family,
2255 af_family_rlock_key_strings[sk->sk_family]);
2256 lockdep_set_class_and_name(&sk->sk_write_queue.lock,
2257 af_wlock_keys + sk->sk_family,
2258 af_family_wlock_key_strings[sk->sk_family]);
2259 lockdep_set_class_and_name(&sk->sk_error_queue.lock,
2260 af_elock_keys + sk->sk_family,
2261 af_family_elock_key_strings[sk->sk_family]);
2262 lockdep_set_class_and_name(&sk->sk_callback_lock,
2263 af_callback_keys + sk->sk_family,
2264 af_family_clock_key_strings[sk->sk_family]);
2268 * sk_clone_lock - clone a socket, and lock its clone
2269 * @sk: the socket to clone
2270 * @priority: for allocation (%GFP_KERNEL, %GFP_ATOMIC, etc)
2272 * Caller must unlock socket even in error path (bh_unlock_sock(newsk))
2274 struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority)
2276 struct proto *prot = READ_ONCE(sk->sk_prot);
2277 struct sk_filter *filter;
2278 bool is_charged = true;
2281 newsk = sk_prot_alloc(prot, priority, sk->sk_family);
2285 sock_copy(newsk, sk);
2287 newsk->sk_prot_creator = prot;
2290 if (likely(newsk->sk_net_refcnt)) {
2291 get_net_track(sock_net(newsk), &newsk->ns_tracker, priority);
2292 sock_inuse_add(sock_net(newsk), 1);
2294 /* Kernel sockets are not elevating the struct net refcount.
2295 * Instead, use a tracker to more easily detect if a layer
2296 * is not properly dismantling its kernel sockets at netns
2299 __netns_tracker_alloc(sock_net(newsk), &newsk->ns_tracker,
2302 sk_node_init(&newsk->sk_node);
2303 sock_lock_init(newsk);
2304 bh_lock_sock(newsk);
2305 newsk->sk_backlog.head = newsk->sk_backlog.tail = NULL;
2306 newsk->sk_backlog.len = 0;
2308 atomic_set(&newsk->sk_rmem_alloc, 0);
2310 /* sk_wmem_alloc set to one (see sk_free() and sock_wfree()) */
2311 refcount_set(&newsk->sk_wmem_alloc, 1);
2313 atomic_set(&newsk->sk_omem_alloc, 0);
2314 sk_init_common(newsk);
2316 newsk->sk_dst_cache = NULL;
2317 newsk->sk_dst_pending_confirm = 0;
2318 newsk->sk_wmem_queued = 0;
2319 newsk->sk_forward_alloc = 0;
2320 newsk->sk_reserved_mem = 0;
2321 atomic_set(&newsk->sk_drops, 0);
2322 newsk->sk_send_head = NULL;
2323 newsk->sk_userlocks = sk->sk_userlocks & ~SOCK_BINDPORT_LOCK;
2324 atomic_set(&newsk->sk_zckey, 0);
2326 sock_reset_flag(newsk, SOCK_DONE);
2328 /* sk->sk_memcg will be populated at accept() time */
2329 newsk->sk_memcg = NULL;
2331 cgroup_sk_clone(&newsk->sk_cgrp_data);
2334 filter = rcu_dereference(sk->sk_filter);
2336 /* though it's an empty new sock, the charging may fail
2337 * if sysctl_optmem_max was changed between creation of
2338 * original socket and cloning
2340 is_charged = sk_filter_charge(newsk, filter);
2341 RCU_INIT_POINTER(newsk->sk_filter, filter);
2344 if (unlikely(!is_charged || xfrm_sk_clone_policy(newsk, sk))) {
2345 /* We need to make sure that we don't uncharge the new
2346 * socket if we couldn't charge it in the first place
2347 * as otherwise we uncharge the parent's filter.
2350 RCU_INIT_POINTER(newsk->sk_filter, NULL);
2351 sk_free_unlock_clone(newsk);
2355 RCU_INIT_POINTER(newsk->sk_reuseport_cb, NULL);
2357 if (bpf_sk_storage_clone(sk, newsk)) {
2358 sk_free_unlock_clone(newsk);
2363 /* Clear sk_user_data if parent had the pointer tagged
2364 * as not suitable for copying when cloning.
2366 if (sk_user_data_is_nocopy(newsk))
2367 newsk->sk_user_data = NULL;
2370 newsk->sk_err_soft = 0;
2371 newsk->sk_priority = 0;
2372 newsk->sk_incoming_cpu = raw_smp_processor_id();
2374 /* Before updating sk_refcnt, we must commit prior changes to memory
2375 * (Documentation/RCU/rculist_nulls.rst for details)
2378 refcount_set(&newsk->sk_refcnt, 2);
2380 sk_set_socket(newsk, NULL);
2381 sk_tx_queue_clear(newsk);
2382 RCU_INIT_POINTER(newsk->sk_wq, NULL);
2384 if (newsk->sk_prot->sockets_allocated)
2385 sk_sockets_allocated_inc(newsk);
2387 if (sock_needs_netstamp(sk) && newsk->sk_flags & SK_FLAGS_TIMESTAMP)
2388 net_enable_timestamp();
2392 EXPORT_SYMBOL_GPL(sk_clone_lock);
2394 void sk_free_unlock_clone(struct sock *sk)
2396 /* It is still raw copy of parent, so invalidate
2397 * destructor and make plain sk_free() */
2398 sk->sk_destruct = NULL;
2402 EXPORT_SYMBOL_GPL(sk_free_unlock_clone);
2404 static u32 sk_dst_gso_max_size(struct sock *sk, struct dst_entry *dst)
2406 bool is_ipv6 = false;
2409 #if IS_ENABLED(CONFIG_IPV6)
2410 is_ipv6 = (sk->sk_family == AF_INET6 &&
2411 !ipv6_addr_v4mapped(&sk->sk_v6_rcv_saddr));
2413 /* pairs with the WRITE_ONCE() in netif_set_gso(_ipv4)_max_size() */
2414 max_size = is_ipv6 ? READ_ONCE(dst->dev->gso_max_size) :
2415 READ_ONCE(dst->dev->gso_ipv4_max_size);
2416 if (max_size > GSO_LEGACY_MAX_SIZE && !sk_is_tcp(sk))
2417 max_size = GSO_LEGACY_MAX_SIZE;
2419 return max_size - (MAX_TCP_HEADER + 1);
2422 void sk_setup_caps(struct sock *sk, struct dst_entry *dst)
2426 sk->sk_route_caps = dst->dev->features;
2428 sk->sk_route_caps |= NETIF_F_GSO;
2429 if (sk->sk_route_caps & NETIF_F_GSO)
2430 sk->sk_route_caps |= NETIF_F_GSO_SOFTWARE;
2431 if (unlikely(sk->sk_gso_disabled))
2432 sk->sk_route_caps &= ~NETIF_F_GSO_MASK;
2433 if (sk_can_gso(sk)) {
2434 if (dst->header_len && !xfrm_dst_offload_ok(dst)) {
2435 sk->sk_route_caps &= ~NETIF_F_GSO_MASK;
2437 sk->sk_route_caps |= NETIF_F_SG | NETIF_F_HW_CSUM;
2438 sk->sk_gso_max_size = sk_dst_gso_max_size(sk, dst);
2439 /* pairs with the WRITE_ONCE() in netif_set_gso_max_segs() */
2440 max_segs = max_t(u32, READ_ONCE(dst->dev->gso_max_segs), 1);
2443 sk->sk_gso_max_segs = max_segs;
2444 sk_dst_set(sk, dst);
2446 EXPORT_SYMBOL_GPL(sk_setup_caps);
2449 * Simple resource managers for sockets.
2454 * Write buffer destructor automatically called from kfree_skb.
2456 void sock_wfree(struct sk_buff *skb)
2458 struct sock *sk = skb->sk;
2459 unsigned int len = skb->truesize;
2462 if (!sock_flag(sk, SOCK_USE_WRITE_QUEUE)) {
2463 if (sock_flag(sk, SOCK_RCU_FREE) &&
2464 sk->sk_write_space == sock_def_write_space) {
2466 free = refcount_sub_and_test(len, &sk->sk_wmem_alloc);
2467 sock_def_write_space_wfree(sk);
2475 * Keep a reference on sk_wmem_alloc, this will be released
2476 * after sk_write_space() call
2478 WARN_ON(refcount_sub_and_test(len - 1, &sk->sk_wmem_alloc));
2479 sk->sk_write_space(sk);
2483 * if sk_wmem_alloc reaches 0, we must finish what sk_free()
2484 * could not do because of in-flight packets
2486 if (refcount_sub_and_test(len, &sk->sk_wmem_alloc))
2489 EXPORT_SYMBOL(sock_wfree);
2491 /* This variant of sock_wfree() is used by TCP,
2492 * since it sets SOCK_USE_WRITE_QUEUE.
2494 void __sock_wfree(struct sk_buff *skb)
2496 struct sock *sk = skb->sk;
2498 if (refcount_sub_and_test(skb->truesize, &sk->sk_wmem_alloc))
2502 void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
2507 if (unlikely(!sk_fullsock(sk))) {
2508 skb->destructor = sock_edemux;
2513 skb->destructor = sock_wfree;
2514 skb_set_hash_from_sk(skb, sk);
2516 * We used to take a refcount on sk, but following operation
2517 * is enough to guarantee sk_free() wont free this sock until
2518 * all in-flight packets are completed
2520 refcount_add(skb->truesize, &sk->sk_wmem_alloc);
2522 EXPORT_SYMBOL(skb_set_owner_w);
2524 static bool can_skb_orphan_partial(const struct sk_buff *skb)
2526 #ifdef CONFIG_TLS_DEVICE
2527 /* Drivers depend on in-order delivery for crypto offload,
2528 * partial orphan breaks out-of-order-OK logic.
2533 return (skb->destructor == sock_wfree ||
2534 (IS_ENABLED(CONFIG_INET) && skb->destructor == tcp_wfree));
2537 /* This helper is used by netem, as it can hold packets in its
2538 * delay queue. We want to allow the owner socket to send more
2539 * packets, as if they were already TX completed by a typical driver.
2540 * But we also want to keep skb->sk set because some packet schedulers
2541 * rely on it (sch_fq for example).
2543 void skb_orphan_partial(struct sk_buff *skb)
2545 if (skb_is_tcp_pure_ack(skb))
2548 if (can_skb_orphan_partial(skb) && skb_set_owner_sk_safe(skb, skb->sk))
2553 EXPORT_SYMBOL(skb_orphan_partial);
2556 * Read buffer destructor automatically called from kfree_skb.
2558 void sock_rfree(struct sk_buff *skb)
2560 struct sock *sk = skb->sk;
2561 unsigned int len = skb->truesize;
2563 atomic_sub(len, &sk->sk_rmem_alloc);
2564 sk_mem_uncharge(sk, len);
2566 EXPORT_SYMBOL(sock_rfree);
2569 * Buffer destructor for skbs that are not used directly in read or write
2570 * path, e.g. for error handler skbs. Automatically called from kfree_skb.
2572 void sock_efree(struct sk_buff *skb)
2576 EXPORT_SYMBOL(sock_efree);
2578 /* Buffer destructor for prefetch/receive path where reference count may
2579 * not be held, e.g. for listen sockets.
2582 void sock_pfree(struct sk_buff *skb)
2584 if (sk_is_refcounted(skb->sk))
2585 sock_gen_put(skb->sk);
2587 EXPORT_SYMBOL(sock_pfree);
2588 #endif /* CONFIG_INET */
2590 kuid_t sock_i_uid(struct sock *sk)
2594 read_lock_bh(&sk->sk_callback_lock);
2595 uid = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_uid : GLOBAL_ROOT_UID;
2596 read_unlock_bh(&sk->sk_callback_lock);
2599 EXPORT_SYMBOL(sock_i_uid);
2601 unsigned long __sock_i_ino(struct sock *sk)
2605 read_lock(&sk->sk_callback_lock);
2606 ino = sk->sk_socket ? SOCK_INODE(sk->sk_socket)->i_ino : 0;
2607 read_unlock(&sk->sk_callback_lock);
2610 EXPORT_SYMBOL(__sock_i_ino);
2612 unsigned long sock_i_ino(struct sock *sk)
2617 ino = __sock_i_ino(sk);
2621 EXPORT_SYMBOL(sock_i_ino);
2624 * Allocate a skb from the socket's send buffer.
2626 struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
2630 refcount_read(&sk->sk_wmem_alloc) < READ_ONCE(sk->sk_sndbuf)) {
2631 struct sk_buff *skb = alloc_skb(size, priority);
2634 skb_set_owner_w(skb, sk);
2640 EXPORT_SYMBOL(sock_wmalloc);
2642 static void sock_ofree(struct sk_buff *skb)
2644 struct sock *sk = skb->sk;
2646 atomic_sub(skb->truesize, &sk->sk_omem_alloc);
2649 struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
2652 struct sk_buff *skb;
2654 /* small safe race: SKB_TRUESIZE may differ from final skb->truesize */
2655 if (atomic_read(&sk->sk_omem_alloc) + SKB_TRUESIZE(size) >
2656 READ_ONCE(sysctl_optmem_max))
2659 skb = alloc_skb(size, priority);
2663 atomic_add(skb->truesize, &sk->sk_omem_alloc);
2665 skb->destructor = sock_ofree;
2670 * Allocate a memory block from the socket's option memory buffer.
2672 void *sock_kmalloc(struct sock *sk, int size, gfp_t priority)
2674 int optmem_max = READ_ONCE(sysctl_optmem_max);
2676 if ((unsigned int)size <= optmem_max &&
2677 atomic_read(&sk->sk_omem_alloc) + size < optmem_max) {
2679 /* First do the add, to avoid the race if kmalloc
2682 atomic_add(size, &sk->sk_omem_alloc);
2683 mem = kmalloc(size, priority);
2686 atomic_sub(size, &sk->sk_omem_alloc);
2690 EXPORT_SYMBOL(sock_kmalloc);
2692 /* Free an option memory block. Note, we actually want the inline
2693 * here as this allows gcc to detect the nullify and fold away the
2694 * condition entirely.
2696 static inline void __sock_kfree_s(struct sock *sk, void *mem, int size,
2699 if (WARN_ON_ONCE(!mem))
2702 kfree_sensitive(mem);
2705 atomic_sub(size, &sk->sk_omem_alloc);
2708 void sock_kfree_s(struct sock *sk, void *mem, int size)
2710 __sock_kfree_s(sk, mem, size, false);
2712 EXPORT_SYMBOL(sock_kfree_s);
2714 void sock_kzfree_s(struct sock *sk, void *mem, int size)
2716 __sock_kfree_s(sk, mem, size, true);
2718 EXPORT_SYMBOL(sock_kzfree_s);
2720 /* It is almost wait_for_tcp_memory minus release_sock/lock_sock.
2721 I think, these locks should be removed for datagram sockets.
2723 static long sock_wait_for_wmem(struct sock *sk, long timeo)
2727 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
2731 if (signal_pending(current))
2733 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
2734 prepare_to_wait(sk_sleep(sk), &wait, TASK_INTERRUPTIBLE);
2735 if (refcount_read(&sk->sk_wmem_alloc) < READ_ONCE(sk->sk_sndbuf))
2737 if (sk->sk_shutdown & SEND_SHUTDOWN)
2741 timeo = schedule_timeout(timeo);
2743 finish_wait(sk_sleep(sk), &wait);
2749 * Generic send/receive buffer handlers
2752 struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
2753 unsigned long data_len, int noblock,
2754 int *errcode, int max_page_order)
2756 struct sk_buff *skb;
2760 timeo = sock_sndtimeo(sk, noblock);
2762 err = sock_error(sk);
2767 if (sk->sk_shutdown & SEND_SHUTDOWN)
2770 if (sk_wmem_alloc_get(sk) < READ_ONCE(sk->sk_sndbuf))
2773 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
2774 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
2778 if (signal_pending(current))
2780 timeo = sock_wait_for_wmem(sk, timeo);
2782 skb = alloc_skb_with_frags(header_len, data_len, max_page_order,
2783 errcode, sk->sk_allocation);
2785 skb_set_owner_w(skb, sk);
2789 err = sock_intr_errno(timeo);
2794 EXPORT_SYMBOL(sock_alloc_send_pskb);
2796 int __sock_cmsg_send(struct sock *sk, struct cmsghdr *cmsg,
2797 struct sockcm_cookie *sockc)
2801 switch (cmsg->cmsg_type) {
2803 if (!ns_capable(sock_net(sk)->user_ns, CAP_NET_RAW) &&
2804 !ns_capable(sock_net(sk)->user_ns, CAP_NET_ADMIN))
2806 if (cmsg->cmsg_len != CMSG_LEN(sizeof(u32)))
2808 sockc->mark = *(u32 *)CMSG_DATA(cmsg);
2810 case SO_TIMESTAMPING_OLD:
2811 if (cmsg->cmsg_len != CMSG_LEN(sizeof(u32)))
2814 tsflags = *(u32 *)CMSG_DATA(cmsg);
2815 if (tsflags & ~SOF_TIMESTAMPING_TX_RECORD_MASK)
2818 sockc->tsflags &= ~SOF_TIMESTAMPING_TX_RECORD_MASK;
2819 sockc->tsflags |= tsflags;
2822 if (!sock_flag(sk, SOCK_TXTIME))
2824 if (cmsg->cmsg_len != CMSG_LEN(sizeof(u64)))
2826 sockc->transmit_time = get_unaligned((u64 *)CMSG_DATA(cmsg));
2828 /* SCM_RIGHTS and SCM_CREDENTIALS are semantically in SOL_UNIX. */
2830 case SCM_CREDENTIALS:
2837 EXPORT_SYMBOL(__sock_cmsg_send);
2839 int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
2840 struct sockcm_cookie *sockc)
2842 struct cmsghdr *cmsg;
2845 for_each_cmsghdr(cmsg, msg) {
2846 if (!CMSG_OK(msg, cmsg))
2848 if (cmsg->cmsg_level != SOL_SOCKET)
2850 ret = __sock_cmsg_send(sk, cmsg, sockc);
2856 EXPORT_SYMBOL(sock_cmsg_send);
2858 static void sk_enter_memory_pressure(struct sock *sk)
2860 if (!sk->sk_prot->enter_memory_pressure)
2863 sk->sk_prot->enter_memory_pressure(sk);
2866 static void sk_leave_memory_pressure(struct sock *sk)
2868 if (sk->sk_prot->leave_memory_pressure) {
2869 INDIRECT_CALL_INET_1(sk->sk_prot->leave_memory_pressure,
2870 tcp_leave_memory_pressure, sk);
2872 unsigned long *memory_pressure = sk->sk_prot->memory_pressure;
2874 if (memory_pressure && READ_ONCE(*memory_pressure))
2875 WRITE_ONCE(*memory_pressure, 0);
2879 DEFINE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);
2882 * skb_page_frag_refill - check that a page_frag contains enough room
2883 * @sz: minimum size of the fragment we want to get
2884 * @pfrag: pointer to page_frag
2885 * @gfp: priority for memory allocation
2887 * Note: While this allocator tries to use high order pages, there is
2888 * no guarantee that allocations succeed. Therefore, @sz MUST be
2889 * less or equal than PAGE_SIZE.
2891 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t gfp)
2894 if (page_ref_count(pfrag->page) == 1) {
2898 if (pfrag->offset + sz <= pfrag->size)
2900 put_page(pfrag->page);
2904 if (SKB_FRAG_PAGE_ORDER &&
2905 !static_branch_unlikely(&net_high_order_alloc_disable_key)) {
2906 /* Avoid direct reclaim but allow kswapd to wake */
2907 pfrag->page = alloc_pages((gfp & ~__GFP_DIRECT_RECLAIM) |
2908 __GFP_COMP | __GFP_NOWARN |
2910 SKB_FRAG_PAGE_ORDER);
2911 if (likely(pfrag->page)) {
2912 pfrag->size = PAGE_SIZE << SKB_FRAG_PAGE_ORDER;
2916 pfrag->page = alloc_page(gfp);
2917 if (likely(pfrag->page)) {
2918 pfrag->size = PAGE_SIZE;
2923 EXPORT_SYMBOL(skb_page_frag_refill);
2925 bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag)
2927 if (likely(skb_page_frag_refill(32U, pfrag, sk->sk_allocation)))
2930 sk_enter_memory_pressure(sk);
2931 sk_stream_moderate_sndbuf(sk);
2934 EXPORT_SYMBOL(sk_page_frag_refill);
2936 void __lock_sock(struct sock *sk)
2937 __releases(&sk->sk_lock.slock)
2938 __acquires(&sk->sk_lock.slock)
2943 prepare_to_wait_exclusive(&sk->sk_lock.wq, &wait,
2944 TASK_UNINTERRUPTIBLE);
2945 spin_unlock_bh(&sk->sk_lock.slock);
2947 spin_lock_bh(&sk->sk_lock.slock);
2948 if (!sock_owned_by_user(sk))
2951 finish_wait(&sk->sk_lock.wq, &wait);
2954 void __release_sock(struct sock *sk)
2955 __releases(&sk->sk_lock.slock)
2956 __acquires(&sk->sk_lock.slock)
2958 struct sk_buff *skb, *next;
2960 while ((skb = sk->sk_backlog.head) != NULL) {
2961 sk->sk_backlog.head = sk->sk_backlog.tail = NULL;
2963 spin_unlock_bh(&sk->sk_lock.slock);
2968 DEBUG_NET_WARN_ON_ONCE(skb_dst_is_noref(skb));
2969 skb_mark_not_on_list(skb);
2970 sk_backlog_rcv(sk, skb);
2975 } while (skb != NULL);
2977 spin_lock_bh(&sk->sk_lock.slock);
2981 * Doing the zeroing here guarantee we can not loop forever
2982 * while a wild producer attempts to flood us.
2984 sk->sk_backlog.len = 0;
2987 void __sk_flush_backlog(struct sock *sk)
2989 spin_lock_bh(&sk->sk_lock.slock);
2991 spin_unlock_bh(&sk->sk_lock.slock);
2993 EXPORT_SYMBOL_GPL(__sk_flush_backlog);
2996 * sk_wait_data - wait for data to arrive at sk_receive_queue
2997 * @sk: sock to wait on
2998 * @timeo: for how long
2999 * @skb: last skb seen on sk_receive_queue
3001 * Now socket state including sk->sk_err is changed only under lock,
3002 * hence we may omit checks after joining wait queue.
3003 * We check receive queue before schedule() only as optimization;
3004 * it is very likely that release_sock() added new data.
3006 int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb)
3008 DEFINE_WAIT_FUNC(wait, woken_wake_function);
3011 add_wait_queue(sk_sleep(sk), &wait);
3012 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
3013 rc = sk_wait_event(sk, timeo, skb_peek_tail(&sk->sk_receive_queue) != skb, &wait);
3014 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
3015 remove_wait_queue(sk_sleep(sk), &wait);
3018 EXPORT_SYMBOL(sk_wait_data);
3021 * __sk_mem_raise_allocated - increase memory_allocated
3023 * @size: memory size to allocate
3024 * @amt: pages to allocate
3025 * @kind: allocation type
3027 * Similar to __sk_mem_schedule(), but does not update sk_forward_alloc
3029 int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind)
3031 bool memcg_charge = mem_cgroup_sockets_enabled && sk->sk_memcg;
3032 struct proto *prot = sk->sk_prot;
3033 bool charged = true;
3036 sk_memory_allocated_add(sk, amt);
3037 allocated = sk_memory_allocated(sk);
3039 !(charged = mem_cgroup_charge_skmem(sk->sk_memcg, amt,
3040 gfp_memcg_charge())))
3041 goto suppress_allocation;
3044 if (allocated <= sk_prot_mem_limits(sk, 0)) {
3045 sk_leave_memory_pressure(sk);
3049 /* Under pressure. */
3050 if (allocated > sk_prot_mem_limits(sk, 1))
3051 sk_enter_memory_pressure(sk);
3053 /* Over hard limit. */
3054 if (allocated > sk_prot_mem_limits(sk, 2))
3055 goto suppress_allocation;
3057 /* guarantee minimum buffer size under pressure */
3058 if (kind == SK_MEM_RECV) {
3059 if (atomic_read(&sk->sk_rmem_alloc) < sk_get_rmem0(sk, prot))
3062 } else { /* SK_MEM_SEND */
3063 int wmem0 = sk_get_wmem0(sk, prot);
3065 if (sk->sk_type == SOCK_STREAM) {
3066 if (sk->sk_wmem_queued < wmem0)
3068 } else if (refcount_read(&sk->sk_wmem_alloc) < wmem0) {
3073 if (sk_has_memory_pressure(sk)) {
3076 if (!sk_under_memory_pressure(sk))
3078 alloc = sk_sockets_allocated_read_positive(sk);
3079 if (sk_prot_mem_limits(sk, 2) > alloc *
3080 sk_mem_pages(sk->sk_wmem_queued +
3081 atomic_read(&sk->sk_rmem_alloc) +
3082 sk->sk_forward_alloc))
3086 suppress_allocation:
3088 if (kind == SK_MEM_SEND && sk->sk_type == SOCK_STREAM) {
3089 sk_stream_moderate_sndbuf(sk);
3091 /* Fail only if socket is _under_ its sndbuf.
3092 * In this case we cannot block, so that we have to fail.
3094 if (sk->sk_wmem_queued + size >= sk->sk_sndbuf) {
3095 /* Force charge with __GFP_NOFAIL */
3096 if (memcg_charge && !charged) {
3097 mem_cgroup_charge_skmem(sk->sk_memcg, amt,
3098 gfp_memcg_charge() | __GFP_NOFAIL);
3104 if (kind == SK_MEM_SEND || (kind == SK_MEM_RECV && charged))
3105 trace_sock_exceed_buf_limit(sk, prot, allocated, kind);
3107 sk_memory_allocated_sub(sk, amt);
3109 if (memcg_charge && charged)
3110 mem_cgroup_uncharge_skmem(sk->sk_memcg, amt);
3116 * __sk_mem_schedule - increase sk_forward_alloc and memory_allocated
3118 * @size: memory size to allocate
3119 * @kind: allocation type
3121 * If kind is SK_MEM_SEND, it means wmem allocation. Otherwise it means
3122 * rmem allocation. This function assumes that protocols which have
3123 * memory_pressure use sk_wmem_queued as write buffer accounting.
3125 int __sk_mem_schedule(struct sock *sk, int size, int kind)
3127 int ret, amt = sk_mem_pages(size);
3129 sk->sk_forward_alloc += amt << PAGE_SHIFT;
3130 ret = __sk_mem_raise_allocated(sk, size, amt, kind);
3132 sk->sk_forward_alloc -= amt << PAGE_SHIFT;
3135 EXPORT_SYMBOL(__sk_mem_schedule);
3138 * __sk_mem_reduce_allocated - reclaim memory_allocated
3140 * @amount: number of quanta
3142 * Similar to __sk_mem_reclaim(), but does not update sk_forward_alloc
3144 void __sk_mem_reduce_allocated(struct sock *sk, int amount)
3146 sk_memory_allocated_sub(sk, amount);
3148 if (mem_cgroup_sockets_enabled && sk->sk_memcg)
3149 mem_cgroup_uncharge_skmem(sk->sk_memcg, amount);
3151 if (sk_under_memory_pressure(sk) &&
3152 (sk_memory_allocated(sk) < sk_prot_mem_limits(sk, 0)))
3153 sk_leave_memory_pressure(sk);
3157 * __sk_mem_reclaim - reclaim sk_forward_alloc and memory_allocated
3159 * @amount: number of bytes (rounded down to a PAGE_SIZE multiple)
3161 void __sk_mem_reclaim(struct sock *sk, int amount)
3163 amount >>= PAGE_SHIFT;
3164 sk->sk_forward_alloc -= amount << PAGE_SHIFT;
3165 __sk_mem_reduce_allocated(sk, amount);
3167 EXPORT_SYMBOL(__sk_mem_reclaim);
3169 int sk_set_peek_off(struct sock *sk, int val)
3171 sk->sk_peek_off = val;
3174 EXPORT_SYMBOL_GPL(sk_set_peek_off);
3177 * Set of default routines for initialising struct proto_ops when
3178 * the protocol does not support a particular function. In certain
3179 * cases where it makes no sense for a protocol to have a "do nothing"
3180 * function, some default processing is provided.
3183 int sock_no_bind(struct socket *sock, struct sockaddr *saddr, int len)
3187 EXPORT_SYMBOL(sock_no_bind);
3189 int sock_no_connect(struct socket *sock, struct sockaddr *saddr,
3194 EXPORT_SYMBOL(sock_no_connect);
3196 int sock_no_socketpair(struct socket *sock1, struct socket *sock2)
3200 EXPORT_SYMBOL(sock_no_socketpair);
3202 int sock_no_accept(struct socket *sock, struct socket *newsock, int flags,
3207 EXPORT_SYMBOL(sock_no_accept);
3209 int sock_no_getname(struct socket *sock, struct sockaddr *saddr,
3214 EXPORT_SYMBOL(sock_no_getname);
3216 int sock_no_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
3220 EXPORT_SYMBOL(sock_no_ioctl);
3222 int sock_no_listen(struct socket *sock, int backlog)
3226 EXPORT_SYMBOL(sock_no_listen);
3228 int sock_no_shutdown(struct socket *sock, int how)
3232 EXPORT_SYMBOL(sock_no_shutdown);
3234 int sock_no_sendmsg(struct socket *sock, struct msghdr *m, size_t len)
3238 EXPORT_SYMBOL(sock_no_sendmsg);
3240 int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *m, size_t len)
3244 EXPORT_SYMBOL(sock_no_sendmsg_locked);
3246 int sock_no_recvmsg(struct socket *sock, struct msghdr *m, size_t len,
3251 EXPORT_SYMBOL(sock_no_recvmsg);
3253 int sock_no_mmap(struct file *file, struct socket *sock, struct vm_area_struct *vma)
3255 /* Mirror missing mmap method error code */
3258 EXPORT_SYMBOL(sock_no_mmap);
3261 * When a file is received (via SCM_RIGHTS, etc), we must bump the
3262 * various sock-based usage counts.
3264 void __receive_sock(struct file *file)
3266 struct socket *sock;
3268 sock = sock_from_file(file);
3270 sock_update_netprioidx(&sock->sk->sk_cgrp_data);
3271 sock_update_classid(&sock->sk->sk_cgrp_data);
3276 * Default Socket Callbacks
3279 static void sock_def_wakeup(struct sock *sk)
3281 struct socket_wq *wq;
3284 wq = rcu_dereference(sk->sk_wq);
3285 if (skwq_has_sleeper(wq))
3286 wake_up_interruptible_all(&wq->wait);
3290 static void sock_def_error_report(struct sock *sk)
3292 struct socket_wq *wq;
3295 wq = rcu_dereference(sk->sk_wq);
3296 if (skwq_has_sleeper(wq))
3297 wake_up_interruptible_poll(&wq->wait, EPOLLERR);
3298 sk_wake_async(sk, SOCK_WAKE_IO, POLL_ERR);
3302 void sock_def_readable(struct sock *sk)
3304 struct socket_wq *wq;
3306 trace_sk_data_ready(sk);
3309 wq = rcu_dereference(sk->sk_wq);
3310 if (skwq_has_sleeper(wq))
3311 wake_up_interruptible_sync_poll(&wq->wait, EPOLLIN | EPOLLPRI |
3312 EPOLLRDNORM | EPOLLRDBAND);
3313 sk_wake_async(sk, SOCK_WAKE_WAITD, POLL_IN);
3317 static void sock_def_write_space(struct sock *sk)
3319 struct socket_wq *wq;
3323 /* Do not wake up a writer until he can make "significant"
3326 if (sock_writeable(sk)) {
3327 wq = rcu_dereference(sk->sk_wq);
3328 if (skwq_has_sleeper(wq))
3329 wake_up_interruptible_sync_poll(&wq->wait, EPOLLOUT |
3330 EPOLLWRNORM | EPOLLWRBAND);
3332 /* Should agree with poll, otherwise some programs break */
3333 sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
3339 /* An optimised version of sock_def_write_space(), should only be called
3340 * for SOCK_RCU_FREE sockets under RCU read section and after putting
3343 static void sock_def_write_space_wfree(struct sock *sk)
3345 /* Do not wake up a writer until he can make "significant"
3348 if (sock_writeable(sk)) {
3349 struct socket_wq *wq = rcu_dereference(sk->sk_wq);
3351 /* rely on refcount_sub from sock_wfree() */
3352 smp_mb__after_atomic();
3353 if (wq && waitqueue_active(&wq->wait))
3354 wake_up_interruptible_sync_poll(&wq->wait, EPOLLOUT |
3355 EPOLLWRNORM | EPOLLWRBAND);
3357 /* Should agree with poll, otherwise some programs break */
3358 sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
3362 static void sock_def_destruct(struct sock *sk)
3366 void sk_send_sigurg(struct sock *sk)
3368 if (sk->sk_socket && sk->sk_socket->file)
3369 if (send_sigurg(&sk->sk_socket->file->f_owner))
3370 sk_wake_async(sk, SOCK_WAKE_URG, POLL_PRI);
3372 EXPORT_SYMBOL(sk_send_sigurg);
3374 void sk_reset_timer(struct sock *sk, struct timer_list* timer,
3375 unsigned long expires)
3377 if (!mod_timer(timer, expires))
3380 EXPORT_SYMBOL(sk_reset_timer);
3382 void sk_stop_timer(struct sock *sk, struct timer_list* timer)
3384 if (del_timer(timer))
3387 EXPORT_SYMBOL(sk_stop_timer);
3389 void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer)
3391 if (del_timer_sync(timer))
3394 EXPORT_SYMBOL(sk_stop_timer_sync);
3396 void sock_init_data_uid(struct socket *sock, struct sock *sk, kuid_t uid)
3399 sk->sk_send_head = NULL;
3401 timer_setup(&sk->sk_timer, NULL, 0);
3403 sk->sk_allocation = GFP_KERNEL;
3404 sk->sk_rcvbuf = READ_ONCE(sysctl_rmem_default);
3405 sk->sk_sndbuf = READ_ONCE(sysctl_wmem_default);
3406 sk->sk_state = TCP_CLOSE;
3407 sk->sk_use_task_frag = true;
3408 sk_set_socket(sk, sock);
3410 sock_set_flag(sk, SOCK_ZAPPED);
3413 sk->sk_type = sock->type;
3414 RCU_INIT_POINTER(sk->sk_wq, &sock->wq);
3417 RCU_INIT_POINTER(sk->sk_wq, NULL);
3421 rwlock_init(&sk->sk_callback_lock);
3422 if (sk->sk_kern_sock)
3423 lockdep_set_class_and_name(
3424 &sk->sk_callback_lock,
3425 af_kern_callback_keys + sk->sk_family,
3426 af_family_kern_clock_key_strings[sk->sk_family]);
3428 lockdep_set_class_and_name(
3429 &sk->sk_callback_lock,
3430 af_callback_keys + sk->sk_family,
3431 af_family_clock_key_strings[sk->sk_family]);
3433 sk->sk_state_change = sock_def_wakeup;
3434 sk->sk_data_ready = sock_def_readable;
3435 sk->sk_write_space = sock_def_write_space;
3436 sk->sk_error_report = sock_def_error_report;
3437 sk->sk_destruct = sock_def_destruct;
3439 sk->sk_frag.page = NULL;
3440 sk->sk_frag.offset = 0;
3441 sk->sk_peek_off = -1;
3443 sk->sk_peer_pid = NULL;
3444 sk->sk_peer_cred = NULL;
3445 spin_lock_init(&sk->sk_peer_lock);
3447 sk->sk_write_pending = 0;
3448 sk->sk_rcvlowat = 1;
3449 sk->sk_rcvtimeo = MAX_SCHEDULE_TIMEOUT;
3450 sk->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
3452 sk->sk_stamp = SK_DEFAULT_STAMP;
3453 #if BITS_PER_LONG==32
3454 seqlock_init(&sk->sk_stamp_seq);
3456 atomic_set(&sk->sk_zckey, 0);
3458 #ifdef CONFIG_NET_RX_BUSY_POLL
3460 sk->sk_ll_usec = READ_ONCE(sysctl_net_busy_read);
3463 sk->sk_max_pacing_rate = ~0UL;
3464 sk->sk_pacing_rate = ~0UL;
3465 WRITE_ONCE(sk->sk_pacing_shift, 10);
3466 sk->sk_incoming_cpu = -1;
3468 sk_rx_queue_clear(sk);
3470 * Before updating sk_refcnt, we must commit prior changes to memory
3471 * (Documentation/RCU/rculist_nulls.rst for details)
3474 refcount_set(&sk->sk_refcnt, 1);
3475 atomic_set(&sk->sk_drops, 0);
3477 EXPORT_SYMBOL(sock_init_data_uid);
3479 void sock_init_data(struct socket *sock, struct sock *sk)
3482 SOCK_INODE(sock)->i_uid :
3483 make_kuid(sock_net(sk)->user_ns, 0);
3485 sock_init_data_uid(sock, sk, uid);
3487 EXPORT_SYMBOL(sock_init_data);
3489 void lock_sock_nested(struct sock *sk, int subclass)
3491 /* The sk_lock has mutex_lock() semantics here. */
3492 mutex_acquire(&sk->sk_lock.dep_map, subclass, 0, _RET_IP_);
3495 spin_lock_bh(&sk->sk_lock.slock);
3496 if (sock_owned_by_user_nocheck(sk))
3498 sk->sk_lock.owned = 1;
3499 spin_unlock_bh(&sk->sk_lock.slock);
3501 EXPORT_SYMBOL(lock_sock_nested);
3503 void release_sock(struct sock *sk)
3505 spin_lock_bh(&sk->sk_lock.slock);
3506 if (sk->sk_backlog.tail)
3509 /* Warning : release_cb() might need to release sk ownership,
3510 * ie call sock_release_ownership(sk) before us.
3512 if (sk->sk_prot->release_cb)
3513 sk->sk_prot->release_cb(sk);
3515 sock_release_ownership(sk);
3516 if (waitqueue_active(&sk->sk_lock.wq))
3517 wake_up(&sk->sk_lock.wq);
3518 spin_unlock_bh(&sk->sk_lock.slock);
3520 EXPORT_SYMBOL(release_sock);
3522 bool __lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock)
3525 spin_lock_bh(&sk->sk_lock.slock);
3527 if (!sock_owned_by_user_nocheck(sk)) {
3529 * Fast path return with bottom halves disabled and
3530 * sock::sk_lock.slock held.
3532 * The 'mutex' is not contended and holding
3533 * sock::sk_lock.slock prevents all other lockers to
3534 * proceed so the corresponding unlock_sock_fast() can
3535 * avoid the slow path of release_sock() completely and
3536 * just release slock.
3538 * From a semantical POV this is equivalent to 'acquiring'
3539 * the 'mutex', hence the corresponding lockdep
3540 * mutex_release() has to happen in the fast path of
3541 * unlock_sock_fast().
3547 sk->sk_lock.owned = 1;
3548 __acquire(&sk->sk_lock.slock);
3549 spin_unlock_bh(&sk->sk_lock.slock);
3552 EXPORT_SYMBOL(__lock_sock_fast);
3554 int sock_gettstamp(struct socket *sock, void __user *userstamp,
3555 bool timeval, bool time32)
3557 struct sock *sk = sock->sk;
3558 struct timespec64 ts;
3560 sock_enable_timestamp(sk, SOCK_TIMESTAMP);
3561 ts = ktime_to_timespec64(sock_read_timestamp(sk));
3562 if (ts.tv_sec == -1)
3564 if (ts.tv_sec == 0) {
3565 ktime_t kt = ktime_get_real();
3566 sock_write_timestamp(sk, kt);
3567 ts = ktime_to_timespec64(kt);
3573 #ifdef CONFIG_COMPAT_32BIT_TIME
3575 return put_old_timespec32(&ts, userstamp);
3577 #ifdef CONFIG_SPARC64
3578 /* beware of padding in sparc64 timeval */
3579 if (timeval && !in_compat_syscall()) {
3580 struct __kernel_old_timeval __user tv = {
3581 .tv_sec = ts.tv_sec,
3582 .tv_usec = ts.tv_nsec,
3584 if (copy_to_user(userstamp, &tv, sizeof(tv)))
3589 return put_timespec64(&ts, userstamp);
3591 EXPORT_SYMBOL(sock_gettstamp);
3593 void sock_enable_timestamp(struct sock *sk, enum sock_flags flag)
3595 if (!sock_flag(sk, flag)) {
3596 unsigned long previous_flags = sk->sk_flags;
3598 sock_set_flag(sk, flag);
3600 * we just set one of the two flags which require net
3601 * time stamping, but time stamping might have been on
3602 * already because of the other one
3604 if (sock_needs_netstamp(sk) &&
3605 !(previous_flags & SK_FLAGS_TIMESTAMP))
3606 net_enable_timestamp();
3610 int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len,
3611 int level, int type)
3613 struct sock_exterr_skb *serr;
3614 struct sk_buff *skb;
3618 skb = sock_dequeue_err_skb(sk);
3624 msg->msg_flags |= MSG_TRUNC;
3627 err = skb_copy_datagram_msg(skb, 0, msg, copied);
3631 sock_recv_timestamp(msg, sk, skb);
3633 serr = SKB_EXT_ERR(skb);
3634 put_cmsg(msg, level, type, sizeof(serr->ee), &serr->ee);
3636 msg->msg_flags |= MSG_ERRQUEUE;
3644 EXPORT_SYMBOL(sock_recv_errqueue);
3647 * Get a socket option on an socket.
3649 * FIX: POSIX 1003.1g is very ambiguous here. It states that
3650 * asynchronous errors should be reported by getsockopt. We assume
3651 * this means if you specify SO_ERROR (otherwise whats the point of it).
3653 int sock_common_getsockopt(struct socket *sock, int level, int optname,
3654 char __user *optval, int __user *optlen)
3656 struct sock *sk = sock->sk;
3658 /* IPV6_ADDRFORM can change sk->sk_prot under us. */
3659 return READ_ONCE(sk->sk_prot)->getsockopt(sk, level, optname, optval, optlen);
3661 EXPORT_SYMBOL(sock_common_getsockopt);
3663 int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
3666 struct sock *sk = sock->sk;
3670 err = sk->sk_prot->recvmsg(sk, msg, size, flags, &addr_len);
3672 msg->msg_namelen = addr_len;
3675 EXPORT_SYMBOL(sock_common_recvmsg);
3678 * Set socket options on an inet socket.
3680 int sock_common_setsockopt(struct socket *sock, int level, int optname,
3681 sockptr_t optval, unsigned int optlen)
3683 struct sock *sk = sock->sk;
3685 /* IPV6_ADDRFORM can change sk->sk_prot under us. */
3686 return READ_ONCE(sk->sk_prot)->setsockopt(sk, level, optname, optval, optlen);
3688 EXPORT_SYMBOL(sock_common_setsockopt);
3690 void sk_common_release(struct sock *sk)
3692 if (sk->sk_prot->destroy)
3693 sk->sk_prot->destroy(sk);
3696 * Observation: when sk_common_release is called, processes have
3697 * no access to socket. But net still has.
3698 * Step one, detach it from networking:
3700 * A. Remove from hash tables.
3703 sk->sk_prot->unhash(sk);
3706 * In this point socket cannot receive new packets, but it is possible
3707 * that some packets are in flight because some CPU runs receiver and
3708 * did hash table lookup before we unhashed socket. They will achieve
3709 * receive queue and will be purged by socket destructor.
3711 * Also we still have packets pending on receive queue and probably,
3712 * our own packets waiting in device queues. sock_destroy will drain
3713 * receive queue, but transmitted packets will delay socket destruction
3714 * until the last reference will be released.
3719 xfrm_sk_free_policy(sk);
3723 EXPORT_SYMBOL(sk_common_release);
3725 void sk_get_meminfo(const struct sock *sk, u32 *mem)
3727 memset(mem, 0, sizeof(*mem) * SK_MEMINFO_VARS);
3729 mem[SK_MEMINFO_RMEM_ALLOC] = sk_rmem_alloc_get(sk);
3730 mem[SK_MEMINFO_RCVBUF] = READ_ONCE(sk->sk_rcvbuf);
3731 mem[SK_MEMINFO_WMEM_ALLOC] = sk_wmem_alloc_get(sk);
3732 mem[SK_MEMINFO_SNDBUF] = READ_ONCE(sk->sk_sndbuf);
3733 mem[SK_MEMINFO_FWD_ALLOC] = sk->sk_forward_alloc;
3734 mem[SK_MEMINFO_WMEM_QUEUED] = READ_ONCE(sk->sk_wmem_queued);
3735 mem[SK_MEMINFO_OPTMEM] = atomic_read(&sk->sk_omem_alloc);
3736 mem[SK_MEMINFO_BACKLOG] = READ_ONCE(sk->sk_backlog.len);
3737 mem[SK_MEMINFO_DROPS] = atomic_read(&sk->sk_drops);
3740 #ifdef CONFIG_PROC_FS
3741 static DECLARE_BITMAP(proto_inuse_idx, PROTO_INUSE_NR);
3743 int sock_prot_inuse_get(struct net *net, struct proto *prot)
3745 int cpu, idx = prot->inuse_idx;
3748 for_each_possible_cpu(cpu)
3749 res += per_cpu_ptr(net->core.prot_inuse, cpu)->val[idx];
3751 return res >= 0 ? res : 0;
3753 EXPORT_SYMBOL_GPL(sock_prot_inuse_get);
3755 int sock_inuse_get(struct net *net)
3759 for_each_possible_cpu(cpu)
3760 res += per_cpu_ptr(net->core.prot_inuse, cpu)->all;
3765 EXPORT_SYMBOL_GPL(sock_inuse_get);
3767 static int __net_init sock_inuse_init_net(struct net *net)
3769 net->core.prot_inuse = alloc_percpu(struct prot_inuse);
3770 if (net->core.prot_inuse == NULL)
3775 static void __net_exit sock_inuse_exit_net(struct net *net)
3777 free_percpu(net->core.prot_inuse);
3780 static struct pernet_operations net_inuse_ops = {
3781 .init = sock_inuse_init_net,
3782 .exit = sock_inuse_exit_net,
3785 static __init int net_inuse_init(void)
3787 if (register_pernet_subsys(&net_inuse_ops))
3788 panic("Cannot initialize net inuse counters");
3793 core_initcall(net_inuse_init);
3795 static int assign_proto_idx(struct proto *prot)
3797 prot->inuse_idx = find_first_zero_bit(proto_inuse_idx, PROTO_INUSE_NR);
3799 if (unlikely(prot->inuse_idx == PROTO_INUSE_NR - 1)) {
3800 pr_err("PROTO_INUSE_NR exhausted\n");
3804 set_bit(prot->inuse_idx, proto_inuse_idx);
3808 static void release_proto_idx(struct proto *prot)
3810 if (prot->inuse_idx != PROTO_INUSE_NR - 1)
3811 clear_bit(prot->inuse_idx, proto_inuse_idx);
3814 static inline int assign_proto_idx(struct proto *prot)
3819 static inline void release_proto_idx(struct proto *prot)
3825 static void tw_prot_cleanup(struct timewait_sock_ops *twsk_prot)
3829 kfree(twsk_prot->twsk_slab_name);
3830 twsk_prot->twsk_slab_name = NULL;
3831 kmem_cache_destroy(twsk_prot->twsk_slab);
3832 twsk_prot->twsk_slab = NULL;
3835 static int tw_prot_init(const struct proto *prot)
3837 struct timewait_sock_ops *twsk_prot = prot->twsk_prot;
3842 twsk_prot->twsk_slab_name = kasprintf(GFP_KERNEL, "tw_sock_%s",
3844 if (!twsk_prot->twsk_slab_name)
3847 twsk_prot->twsk_slab =
3848 kmem_cache_create(twsk_prot->twsk_slab_name,
3849 twsk_prot->twsk_obj_size, 0,
3850 SLAB_ACCOUNT | prot->slab_flags,
3852 if (!twsk_prot->twsk_slab) {
3853 pr_crit("%s: Can't create timewait sock SLAB cache!\n",
3861 static void req_prot_cleanup(struct request_sock_ops *rsk_prot)
3865 kfree(rsk_prot->slab_name);
3866 rsk_prot->slab_name = NULL;
3867 kmem_cache_destroy(rsk_prot->slab);
3868 rsk_prot->slab = NULL;
3871 static int req_prot_init(const struct proto *prot)
3873 struct request_sock_ops *rsk_prot = prot->rsk_prot;
3878 rsk_prot->slab_name = kasprintf(GFP_KERNEL, "request_sock_%s",
3880 if (!rsk_prot->slab_name)
3883 rsk_prot->slab = kmem_cache_create(rsk_prot->slab_name,
3884 rsk_prot->obj_size, 0,
3885 SLAB_ACCOUNT | prot->slab_flags,
3888 if (!rsk_prot->slab) {
3889 pr_crit("%s: Can't create request sock SLAB cache!\n",
3896 int proto_register(struct proto *prot, int alloc_slab)
3900 if (prot->memory_allocated && !prot->sysctl_mem) {
3901 pr_err("%s: missing sysctl_mem\n", prot->name);
3904 if (prot->memory_allocated && !prot->per_cpu_fw_alloc) {
3905 pr_err("%s: missing per_cpu_fw_alloc\n", prot->name);
3909 prot->slab = kmem_cache_create_usercopy(prot->name,
3911 SLAB_HWCACHE_ALIGN | SLAB_ACCOUNT |
3913 prot->useroffset, prot->usersize,
3916 if (prot->slab == NULL) {
3917 pr_crit("%s: Can't create sock SLAB cache!\n",
3922 if (req_prot_init(prot))
3923 goto out_free_request_sock_slab;
3925 if (tw_prot_init(prot))
3926 goto out_free_timewait_sock_slab;
3929 mutex_lock(&proto_list_mutex);
3930 ret = assign_proto_idx(prot);
3932 mutex_unlock(&proto_list_mutex);
3933 goto out_free_timewait_sock_slab;
3935 list_add(&prot->node, &proto_list);
3936 mutex_unlock(&proto_list_mutex);
3939 out_free_timewait_sock_slab:
3941 tw_prot_cleanup(prot->twsk_prot);
3942 out_free_request_sock_slab:
3944 req_prot_cleanup(prot->rsk_prot);
3946 kmem_cache_destroy(prot->slab);
3952 EXPORT_SYMBOL(proto_register);
3954 void proto_unregister(struct proto *prot)
3956 mutex_lock(&proto_list_mutex);
3957 release_proto_idx(prot);
3958 list_del(&prot->node);
3959 mutex_unlock(&proto_list_mutex);
3961 kmem_cache_destroy(prot->slab);
3964 req_prot_cleanup(prot->rsk_prot);
3965 tw_prot_cleanup(prot->twsk_prot);
3967 EXPORT_SYMBOL(proto_unregister);
3969 int sock_load_diag_module(int family, int protocol)
3972 if (!sock_is_registered(family))
3975 return request_module("net-pf-%d-proto-%d-type-%d", PF_NETLINK,
3976 NETLINK_SOCK_DIAG, family);
3980 if (family == AF_INET &&
3981 protocol != IPPROTO_RAW &&
3982 protocol < MAX_INET_PROTOS &&
3983 !rcu_access_pointer(inet_protos[protocol]))
3987 return request_module("net-pf-%d-proto-%d-type-%d-%d", PF_NETLINK,
3988 NETLINK_SOCK_DIAG, family, protocol);
3990 EXPORT_SYMBOL(sock_load_diag_module);
3992 #ifdef CONFIG_PROC_FS
3993 static void *proto_seq_start(struct seq_file *seq, loff_t *pos)
3994 __acquires(proto_list_mutex)
3996 mutex_lock(&proto_list_mutex);
3997 return seq_list_start_head(&proto_list, *pos);
4000 static void *proto_seq_next(struct seq_file *seq, void *v, loff_t *pos)
4002 return seq_list_next(v, &proto_list, pos);
4005 static void proto_seq_stop(struct seq_file *seq, void *v)
4006 __releases(proto_list_mutex)
4008 mutex_unlock(&proto_list_mutex);
4011 static char proto_method_implemented(const void *method)
4013 return method == NULL ? 'n' : 'y';
4015 static long sock_prot_memory_allocated(struct proto *proto)
4017 return proto->memory_allocated != NULL ? proto_memory_allocated(proto) : -1L;
4020 static const char *sock_prot_memory_pressure(struct proto *proto)
4022 return proto->memory_pressure != NULL ?
4023 proto_memory_pressure(proto) ? "yes" : "no" : "NI";
4026 static void proto_seq_printf(struct seq_file *seq, struct proto *proto)
4029 seq_printf(seq, "%-9s %4u %6d %6ld %-3s %6u %-3s %-10s "
4030 "%2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c %2c\n",
4033 sock_prot_inuse_get(seq_file_net(seq), proto),
4034 sock_prot_memory_allocated(proto),
4035 sock_prot_memory_pressure(proto),
4037 proto->slab == NULL ? "no" : "yes",
4038 module_name(proto->owner),
4039 proto_method_implemented(proto->close),
4040 proto_method_implemented(proto->connect),
4041 proto_method_implemented(proto->disconnect),
4042 proto_method_implemented(proto->accept),
4043 proto_method_implemented(proto->ioctl),
4044 proto_method_implemented(proto->init),
4045 proto_method_implemented(proto->destroy),
4046 proto_method_implemented(proto->shutdown),
4047 proto_method_implemented(proto->setsockopt),
4048 proto_method_implemented(proto->getsockopt),
4049 proto_method_implemented(proto->sendmsg),
4050 proto_method_implemented(proto->recvmsg),
4051 proto_method_implemented(proto->bind),
4052 proto_method_implemented(proto->backlog_rcv),
4053 proto_method_implemented(proto->hash),
4054 proto_method_implemented(proto->unhash),
4055 proto_method_implemented(proto->get_port),
4056 proto_method_implemented(proto->enter_memory_pressure));
4059 static int proto_seq_show(struct seq_file *seq, void *v)
4061 if (v == &proto_list)
4062 seq_printf(seq, "%-9s %-4s %-8s %-6s %-5s %-7s %-4s %-10s %s",
4071 "cl co di ac io in de sh ss gs se re bi br ha uh gp em\n");
4073 proto_seq_printf(seq, list_entry(v, struct proto, node));
4077 static const struct seq_operations proto_seq_ops = {
4078 .start = proto_seq_start,
4079 .next = proto_seq_next,
4080 .stop = proto_seq_stop,
4081 .show = proto_seq_show,
4084 static __net_init int proto_init_net(struct net *net)
4086 if (!proc_create_net("protocols", 0444, net->proc_net, &proto_seq_ops,
4087 sizeof(struct seq_net_private)))
4093 static __net_exit void proto_exit_net(struct net *net)
4095 remove_proc_entry("protocols", net->proc_net);
4099 static __net_initdata struct pernet_operations proto_net_ops = {
4100 .init = proto_init_net,
4101 .exit = proto_exit_net,
4104 static int __init proto_init(void)
4106 return register_pernet_subsys(&proto_net_ops);
4109 subsys_initcall(proto_init);
4111 #endif /* PROC_FS */
4113 #ifdef CONFIG_NET_RX_BUSY_POLL
4114 bool sk_busy_loop_end(void *p, unsigned long start_time)
4116 struct sock *sk = p;
4118 return !skb_queue_empty_lockless(&sk->sk_receive_queue) ||
4119 sk_busy_loop_timeout(sk, start_time);
4121 EXPORT_SYMBOL(sk_busy_loop_end);
4122 #endif /* CONFIG_NET_RX_BUSY_POLL */
4124 int sock_bind_add(struct sock *sk, struct sockaddr *addr, int addr_len)
4126 if (!sk->sk_prot->bind_add)
4128 return sk->sk_prot->bind_add(sk, addr, addr_len);
4130 EXPORT_SYMBOL(sock_bind_add);
4132 /* Copy 'size' bytes from userspace and return `size` back to userspace */
4133 int sock_ioctl_inout(struct sock *sk, unsigned int cmd,
4134 void __user *arg, void *karg, size_t size)
4138 if (copy_from_user(karg, arg, size))
4141 ret = READ_ONCE(sk->sk_prot)->ioctl(sk, cmd, karg);
4145 if (copy_to_user(arg, karg, size))
4150 EXPORT_SYMBOL(sock_ioctl_inout);
4152 /* This is the most common ioctl prep function, where the result (4 bytes) is
4153 * copied back to userspace if the ioctl() returns successfully. No input is
4154 * copied from userspace as input argument.
4156 static int sock_ioctl_out(struct sock *sk, unsigned int cmd, void __user *arg)
4160 ret = READ_ONCE(sk->sk_prot)->ioctl(sk, cmd, &karg);
4164 return put_user(karg, (int __user *)arg);
4167 /* A wrapper around sock ioctls, which copies the data from userspace
4168 * (depending on the protocol/ioctl), and copies back the result to userspace.
4169 * The main motivation for this function is to pass kernel memory to the
4170 * protocol ioctl callbacks, instead of userspace memory.
4172 int sk_ioctl(struct sock *sk, unsigned int cmd, void __user *arg)
4176 if (sk->sk_type == SOCK_RAW && sk->sk_family == AF_INET)
4177 rc = ipmr_sk_ioctl(sk, cmd, arg);
4178 else if (sk->sk_type == SOCK_RAW && sk->sk_family == AF_INET6)
4179 rc = ip6mr_sk_ioctl(sk, cmd, arg);
4180 else if (sk_is_phonet(sk))
4181 rc = phonet_sk_ioctl(sk, cmd, arg);
4183 /* If ioctl was processed, returns its value */
4187 /* Otherwise call the default handler */
4188 return sock_ioctl_out(sk, cmd, arg);
4190 EXPORT_SYMBOL(sk_ioctl);