2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
6 * Definitions for the AF_INET socket handler.
8 * Version: @(#)sock.h 1.0.4 05/13/93
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Corey Minyard <wf-rch!minyard@relay.EU.net>
13 * Florian La Roche <flla@stud.uni-sb.de>
16 * Alan Cox : Volatiles in skbuff pointers. See
17 * skbuff comments. May be overdone,
18 * better to prove they can be removed
20 * Alan Cox : Added a zapped field for tcp to note
21 * a socket is reset and must stay shut up
22 * Alan Cox : New fields for options
23 * Pauline Middelink : identd support
24 * Alan Cox : Eliminate low level recv/recvfrom
25 * David S. Miller : New socket lookup architecture.
26 * Steve Whitehouse: Default routines for sock_ops
27 * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made
28 * protinfo be just a void pointer, as the
29 * protocol specific parts were moved to
30 * respective headers and ipv4/v6, etc now
31 * use private slabcaches for its socks
32 * Pedro Hortas : New flags field for socket options
35 * This program is free software; you can redistribute it and/or
36 * modify it under the terms of the GNU General Public License
37 * as published by the Free Software Foundation; either version
38 * 2 of the License, or (at your option) any later version.
43 #include <linux/hardirq.h>
44 #include <linux/kernel.h>
45 #include <linux/list.h>
46 #include <linux/list_nulls.h>
47 #include <linux/timer.h>
48 #include <linux/cache.h>
49 #include <linux/lockdep.h>
50 #include <linux/netdevice.h>
51 #include <linux/skbuff.h> /* struct sk_buff */
53 #include <linux/security.h>
54 #include <linux/slab.h>
55 #include <linux/uaccess.h>
56 #include <linux/memcontrol.h>
57 #include <linux/res_counter.h>
58 #include <linux/static_key.h>
60 #include <linux/filter.h>
61 #include <linux/rculist_nulls.h>
62 #include <linux/poll.h>
64 #include <linux/atomic.h>
66 #include <net/checksum.h>
71 int mem_cgroup_sockets_init(struct cgroup
*cgrp
, struct cgroup_subsys
*ss
);
72 void mem_cgroup_sockets_destroy(struct cgroup
*cgrp
);
75 int mem_cgroup_sockets_init(struct cgroup
*cgrp
, struct cgroup_subsys
*ss
)
80 void mem_cgroup_sockets_destroy(struct cgroup
*cgrp
)
85 * This structure really needs to be cleaned up.
86 * Most of it is for TCP, and not used by any of
87 * the other protocols.
90 /* Define this to get the SOCK_DBG debugging facility. */
91 #define SOCK_DEBUGGING
93 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
94 printk(KERN_DEBUG msg); } while (0)
96 /* Validate arguments and do nothing */
97 static inline __printf(2, 3)
98 void SOCK_DEBUG(struct sock
*sk
, const char *msg
, ...)
103 /* This is the per-socket lock. The spinlock provides a synchronization
104 * between user contexts and software interrupt processing, whereas the
105 * mini-semaphore synchronizes multiple users amongst themselves.
110 wait_queue_head_t wq
;
112 * We express the mutex-alike socket_lock semantics
113 * to the lock validator by explicitly managing
114 * the slock as a lock variant (in addition to
117 #ifdef CONFIG_DEBUG_LOCK_ALLOC
118 struct lockdep_map dep_map
;
127 * struct sock_common - minimal network layer representation of sockets
128 * @skc_daddr: Foreign IPv4 addr
129 * @skc_rcv_saddr: Bound local IPv4 addr
130 * @skc_hash: hash value used with various protocol lookup tables
131 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
132 * @skc_family: network address family
133 * @skc_state: Connection state
134 * @skc_reuse: %SO_REUSEADDR setting
135 * @skc_bound_dev_if: bound device index if != 0
136 * @skc_bind_node: bind hash linkage for various protocol lookup tables
137 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
138 * @skc_prot: protocol handlers inside a network family
139 * @skc_net: reference to the network namespace of this socket
140 * @skc_node: main hash linkage for various protocol lookup tables
141 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
142 * @skc_tx_queue_mapping: tx queue number for this connection
143 * @skc_refcnt: reference count
145 * This is the minimal network layer representation of sockets, the header
146 * for struct sock and struct inet_timewait_sock.
149 /* skc_daddr and skc_rcv_saddr must be grouped :
150 * cf INET_MATCH() and INET_TW_MATCH()
153 __be32 skc_rcv_saddr
;
156 unsigned int skc_hash
;
157 __u16 skc_u16hashes
[2];
159 unsigned short skc_family
;
160 volatile unsigned char skc_state
;
161 unsigned char skc_reuse
;
162 int skc_bound_dev_if
;
164 struct hlist_node skc_bind_node
;
165 struct hlist_nulls_node skc_portaddr_node
;
167 struct proto
*skc_prot
;
172 * fields between dontcopy_begin/dontcopy_end
173 * are not copied in sock_copy()
176 int skc_dontcopy_begin
[0];
179 struct hlist_node skc_node
;
180 struct hlist_nulls_node skc_nulls_node
;
182 int skc_tx_queue_mapping
;
185 int skc_dontcopy_end
[0];
191 * struct sock - network layer representation of sockets
192 * @__sk_common: shared layout with inet_timewait_sock
193 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
194 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
195 * @sk_lock: synchronizer
196 * @sk_rcvbuf: size of receive buffer in bytes
197 * @sk_wq: sock wait queue and async head
198 * @sk_dst_cache: destination cache
199 * @sk_dst_lock: destination cache lock
200 * @sk_policy: flow policy
201 * @sk_receive_queue: incoming packets
202 * @sk_wmem_alloc: transmit queue bytes committed
203 * @sk_write_queue: Packet sending queue
204 * @sk_async_wait_queue: DMA copied packets
205 * @sk_omem_alloc: "o" is "option" or "other"
206 * @sk_wmem_queued: persistent queue size
207 * @sk_forward_alloc: space allocated forward
208 * @sk_allocation: allocation mode
209 * @sk_sndbuf: size of send buffer in bytes
210 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
211 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
212 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
213 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
214 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
215 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
216 * @sk_gso_max_size: Maximum GSO segment size to build
217 * @sk_lingertime: %SO_LINGER l_linger setting
218 * @sk_backlog: always used with the per-socket spinlock held
219 * @sk_callback_lock: used with the callbacks in the end of this struct
220 * @sk_error_queue: rarely used
221 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
222 * IPV6_ADDRFORM for instance)
223 * @sk_err: last error
224 * @sk_err_soft: errors that don't cause failure but are the cause of a
225 * persistent failure not just 'timed out'
226 * @sk_drops: raw/udp drops counter
227 * @sk_ack_backlog: current listen backlog
228 * @sk_max_ack_backlog: listen backlog set in listen()
229 * @sk_priority: %SO_PRIORITY setting
230 * @sk_cgrp_prioidx: socket group's priority map index
231 * @sk_type: socket type (%SOCK_STREAM, etc)
232 * @sk_protocol: which protocol this socket belongs in this network family
233 * @sk_peer_pid: &struct pid for this socket's peer
234 * @sk_peer_cred: %SO_PEERCRED setting
235 * @sk_rcvlowat: %SO_RCVLOWAT setting
236 * @sk_rcvtimeo: %SO_RCVTIMEO setting
237 * @sk_sndtimeo: %SO_SNDTIMEO setting
238 * @sk_rxhash: flow hash received from netif layer
239 * @sk_filter: socket filtering instructions
240 * @sk_protinfo: private area, net family specific, when not using slab
241 * @sk_timer: sock cleanup timer
242 * @sk_stamp: time stamp of last packet received
243 * @sk_socket: Identd and reporting IO signals
244 * @sk_user_data: RPC layer private data
245 * @sk_sndmsg_page: cached page for sendmsg
246 * @sk_sndmsg_off: cached offset for sendmsg
247 * @sk_send_head: front of stuff to transmit
248 * @sk_security: used by security modules
249 * @sk_mark: generic packet mark
250 * @sk_classid: this socket's cgroup classid
251 * @sk_cgrp: this socket's cgroup-specific proto data
252 * @sk_write_pending: a write to stream socket waits to start
253 * @sk_state_change: callback to indicate change in the state of the sock
254 * @sk_data_ready: callback to indicate there is data to be processed
255 * @sk_write_space: callback to indicate there is bf sending space available
256 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
257 * @sk_backlog_rcv: callback to process the backlog
258 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
262 * Now struct inet_timewait_sock also uses sock_common, so please just
263 * don't add nothing before this first member (__sk_common) --acme
265 struct sock_common __sk_common
;
266 #define sk_node __sk_common.skc_node
267 #define sk_nulls_node __sk_common.skc_nulls_node
268 #define sk_refcnt __sk_common.skc_refcnt
269 #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
271 #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
272 #define sk_dontcopy_end __sk_common.skc_dontcopy_end
273 #define sk_hash __sk_common.skc_hash
274 #define sk_family __sk_common.skc_family
275 #define sk_state __sk_common.skc_state
276 #define sk_reuse __sk_common.skc_reuse
277 #define sk_bound_dev_if __sk_common.skc_bound_dev_if
278 #define sk_bind_node __sk_common.skc_bind_node
279 #define sk_prot __sk_common.skc_prot
280 #define sk_net __sk_common.skc_net
281 socket_lock_t sk_lock
;
282 struct sk_buff_head sk_receive_queue
;
284 * The backlog queue is special, it is always used with
285 * the per-socket spinlock held and requires low latency
286 * access. Therefore we special case it's implementation.
287 * Note : rmem_alloc is in this structure to fill a hole
288 * on 64bit arches, not because its logically part of
294 struct sk_buff
*head
;
295 struct sk_buff
*tail
;
297 #define sk_rmem_alloc sk_backlog.rmem_alloc
298 int sk_forward_alloc
;
305 struct sk_filter __rcu
*sk_filter
;
306 struct socket_wq __rcu
*sk_wq
;
308 #ifdef CONFIG_NET_DMA
309 struct sk_buff_head sk_async_wait_queue
;
313 struct xfrm_policy
*sk_policy
[2];
315 unsigned long sk_flags
;
316 struct dst_entry
*sk_dst_cache
;
317 spinlock_t sk_dst_lock
;
318 atomic_t sk_wmem_alloc
;
319 atomic_t sk_omem_alloc
;
321 struct sk_buff_head sk_write_queue
;
322 kmemcheck_bitfield_begin(flags
);
323 unsigned int sk_shutdown
: 2,
328 kmemcheck_bitfield_end(flags
);
331 netdev_features_t sk_route_caps
;
332 netdev_features_t sk_route_nocaps
;
334 unsigned int sk_gso_max_size
;
336 unsigned long sk_lingertime
;
337 struct sk_buff_head sk_error_queue
;
338 struct proto
*sk_prot_creator
;
339 rwlock_t sk_callback_lock
;
342 unsigned short sk_ack_backlog
;
343 unsigned short sk_max_ack_backlog
;
345 #ifdef CONFIG_CGROUPS
346 __u32 sk_cgrp_prioidx
;
348 struct pid
*sk_peer_pid
;
349 const struct cred
*sk_peer_cred
;
353 struct timer_list sk_timer
;
355 struct socket
*sk_socket
;
357 struct page
*sk_sndmsg_page
;
358 struct sk_buff
*sk_send_head
;
361 int sk_write_pending
;
362 #ifdef CONFIG_SECURITY
367 struct cg_proto
*sk_cgrp
;
368 void (*sk_state_change
)(struct sock
*sk
);
369 void (*sk_data_ready
)(struct sock
*sk
, int bytes
);
370 void (*sk_write_space
)(struct sock
*sk
);
371 void (*sk_error_report
)(struct sock
*sk
);
372 int (*sk_backlog_rcv
)(struct sock
*sk
,
373 struct sk_buff
*skb
);
374 void (*sk_destruct
)(struct sock
*sk
);
377 static inline int sk_peek_offset(struct sock
*sk
, int flags
)
379 if ((flags
& MSG_PEEK
) && (sk
->sk_peek_off
>= 0))
380 return sk
->sk_peek_off
;
385 static inline void sk_peek_offset_bwd(struct sock
*sk
, int val
)
387 if (sk
->sk_peek_off
>= 0) {
388 if (sk
->sk_peek_off
>= val
)
389 sk
->sk_peek_off
-= val
;
395 static inline void sk_peek_offset_fwd(struct sock
*sk
, int val
)
397 if (sk
->sk_peek_off
>= 0)
398 sk
->sk_peek_off
+= val
;
402 * Hashed lists helper routines
404 static inline struct sock
*sk_entry(const struct hlist_node
*node
)
406 return hlist_entry(node
, struct sock
, sk_node
);
409 static inline struct sock
*__sk_head(const struct hlist_head
*head
)
411 return hlist_entry(head
->first
, struct sock
, sk_node
);
414 static inline struct sock
*sk_head(const struct hlist_head
*head
)
416 return hlist_empty(head
) ? NULL
: __sk_head(head
);
419 static inline struct sock
*__sk_nulls_head(const struct hlist_nulls_head
*head
)
421 return hlist_nulls_entry(head
->first
, struct sock
, sk_nulls_node
);
424 static inline struct sock
*sk_nulls_head(const struct hlist_nulls_head
*head
)
426 return hlist_nulls_empty(head
) ? NULL
: __sk_nulls_head(head
);
429 static inline struct sock
*sk_next(const struct sock
*sk
)
431 return sk
->sk_node
.next
?
432 hlist_entry(sk
->sk_node
.next
, struct sock
, sk_node
) : NULL
;
435 static inline struct sock
*sk_nulls_next(const struct sock
*sk
)
437 return (!is_a_nulls(sk
->sk_nulls_node
.next
)) ?
438 hlist_nulls_entry(sk
->sk_nulls_node
.next
,
439 struct sock
, sk_nulls_node
) :
443 static inline int sk_unhashed(const struct sock
*sk
)
445 return hlist_unhashed(&sk
->sk_node
);
448 static inline int sk_hashed(const struct sock
*sk
)
450 return !sk_unhashed(sk
);
453 static __inline__
void sk_node_init(struct hlist_node
*node
)
458 static __inline__
void sk_nulls_node_init(struct hlist_nulls_node
*node
)
463 static __inline__
void __sk_del_node(struct sock
*sk
)
465 __hlist_del(&sk
->sk_node
);
468 /* NB: equivalent to hlist_del_init_rcu */
469 static __inline__
int __sk_del_node_init(struct sock
*sk
)
473 sk_node_init(&sk
->sk_node
);
479 /* Grab socket reference count. This operation is valid only
480 when sk is ALREADY grabbed f.e. it is found in hash table
481 or a list and the lookup is made under lock preventing hash table
485 static inline void sock_hold(struct sock
*sk
)
487 atomic_inc(&sk
->sk_refcnt
);
490 /* Ungrab socket in the context, which assumes that socket refcnt
491 cannot hit zero, f.e. it is true in context of any socketcall.
493 static inline void __sock_put(struct sock
*sk
)
495 atomic_dec(&sk
->sk_refcnt
);
498 static __inline__
int sk_del_node_init(struct sock
*sk
)
500 int rc
= __sk_del_node_init(sk
);
503 /* paranoid for a while -acme */
504 WARN_ON(atomic_read(&sk
->sk_refcnt
) == 1);
509 #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
511 static __inline__
int __sk_nulls_del_node_init_rcu(struct sock
*sk
)
514 hlist_nulls_del_init_rcu(&sk
->sk_nulls_node
);
520 static __inline__
int sk_nulls_del_node_init_rcu(struct sock
*sk
)
522 int rc
= __sk_nulls_del_node_init_rcu(sk
);
525 /* paranoid for a while -acme */
526 WARN_ON(atomic_read(&sk
->sk_refcnt
) == 1);
532 static __inline__
void __sk_add_node(struct sock
*sk
, struct hlist_head
*list
)
534 hlist_add_head(&sk
->sk_node
, list
);
537 static __inline__
void sk_add_node(struct sock
*sk
, struct hlist_head
*list
)
540 __sk_add_node(sk
, list
);
543 static __inline__
void sk_add_node_rcu(struct sock
*sk
, struct hlist_head
*list
)
546 hlist_add_head_rcu(&sk
->sk_node
, list
);
549 static __inline__
void __sk_nulls_add_node_rcu(struct sock
*sk
, struct hlist_nulls_head
*list
)
551 hlist_nulls_add_head_rcu(&sk
->sk_nulls_node
, list
);
554 static __inline__
void sk_nulls_add_node_rcu(struct sock
*sk
, struct hlist_nulls_head
*list
)
557 __sk_nulls_add_node_rcu(sk
, list
);
560 static __inline__
void __sk_del_bind_node(struct sock
*sk
)
562 __hlist_del(&sk
->sk_bind_node
);
565 static __inline__
void sk_add_bind_node(struct sock
*sk
,
566 struct hlist_head
*list
)
568 hlist_add_head(&sk
->sk_bind_node
, list
);
571 #define sk_for_each(__sk, node, list) \
572 hlist_for_each_entry(__sk, node, list, sk_node)
573 #define sk_for_each_rcu(__sk, node, list) \
574 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
575 #define sk_nulls_for_each(__sk, node, list) \
576 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
577 #define sk_nulls_for_each_rcu(__sk, node, list) \
578 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
579 #define sk_for_each_from(__sk, node) \
580 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
581 hlist_for_each_entry_from(__sk, node, sk_node)
582 #define sk_nulls_for_each_from(__sk, node) \
583 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
584 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
585 #define sk_for_each_safe(__sk, node, tmp, list) \
586 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
587 #define sk_for_each_bound(__sk, node, list) \
588 hlist_for_each_entry(__sk, node, list, sk_bind_node)
601 SOCK_USE_WRITE_QUEUE
, /* whether to call sk->sk_write_space in sock_wfree */
602 SOCK_DBG
, /* %SO_DEBUG setting */
603 SOCK_RCVTSTAMP
, /* %SO_TIMESTAMP setting */
604 SOCK_RCVTSTAMPNS
, /* %SO_TIMESTAMPNS setting */
605 SOCK_LOCALROUTE
, /* route locally only, %SO_DONTROUTE setting */
606 SOCK_QUEUE_SHRUNK
, /* write queue has been shrunk recently */
607 SOCK_TIMESTAMPING_TX_HARDWARE
, /* %SOF_TIMESTAMPING_TX_HARDWARE */
608 SOCK_TIMESTAMPING_TX_SOFTWARE
, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
609 SOCK_TIMESTAMPING_RX_HARDWARE
, /* %SOF_TIMESTAMPING_RX_HARDWARE */
610 SOCK_TIMESTAMPING_RX_SOFTWARE
, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
611 SOCK_TIMESTAMPING_SOFTWARE
, /* %SOF_TIMESTAMPING_SOFTWARE */
612 SOCK_TIMESTAMPING_RAW_HARDWARE
, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
613 SOCK_TIMESTAMPING_SYS_HARDWARE
, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
614 SOCK_FASYNC
, /* fasync() active */
616 SOCK_ZEROCOPY
, /* buffers from userspace */
617 SOCK_WIFI_STATUS
, /* push wifi status to userspace */
618 SOCK_NOFCS
, /* Tell NIC not to do the Ethernet FCS.
619 * Will use last 4 bytes of packet sent from
620 * user-space instead.
624 static inline void sock_copy_flags(struct sock
*nsk
, struct sock
*osk
)
626 nsk
->sk_flags
= osk
->sk_flags
;
629 static inline void sock_set_flag(struct sock
*sk
, enum sock_flags flag
)
631 __set_bit(flag
, &sk
->sk_flags
);
634 static inline void sock_reset_flag(struct sock
*sk
, enum sock_flags flag
)
636 __clear_bit(flag
, &sk
->sk_flags
);
639 static inline int sock_flag(struct sock
*sk
, enum sock_flags flag
)
641 return test_bit(flag
, &sk
->sk_flags
);
644 static inline void sk_acceptq_removed(struct sock
*sk
)
646 sk
->sk_ack_backlog
--;
649 static inline void sk_acceptq_added(struct sock
*sk
)
651 sk
->sk_ack_backlog
++;
654 static inline int sk_acceptq_is_full(struct sock
*sk
)
656 return sk
->sk_ack_backlog
> sk
->sk_max_ack_backlog
;
660 * Compute minimal free write space needed to queue new packets.
662 static inline int sk_stream_min_wspace(struct sock
*sk
)
664 return sk
->sk_wmem_queued
>> 1;
667 static inline int sk_stream_wspace(struct sock
*sk
)
669 return sk
->sk_sndbuf
- sk
->sk_wmem_queued
;
672 extern void sk_stream_write_space(struct sock
*sk
);
674 static inline int sk_stream_memory_free(struct sock
*sk
)
676 return sk
->sk_wmem_queued
< sk
->sk_sndbuf
;
679 /* OOB backlog add */
680 static inline void __sk_add_backlog(struct sock
*sk
, struct sk_buff
*skb
)
682 /* dont let skb dst not refcounted, we are going to leave rcu lock */
685 if (!sk
->sk_backlog
.tail
)
686 sk
->sk_backlog
.head
= skb
;
688 sk
->sk_backlog
.tail
->next
= skb
;
690 sk
->sk_backlog
.tail
= skb
;
695 * Take into account size of receive queue and backlog queue
696 * Do not take into account this skb truesize,
697 * to allow even a single big packet to come.
699 static inline bool sk_rcvqueues_full(const struct sock
*sk
, const struct sk_buff
*skb
)
701 unsigned int qsize
= sk
->sk_backlog
.len
+ atomic_read(&sk
->sk_rmem_alloc
);
703 return qsize
> sk
->sk_rcvbuf
;
706 /* The per-socket spinlock must be held here. */
707 static inline __must_check
int sk_add_backlog(struct sock
*sk
, struct sk_buff
*skb
)
709 if (sk_rcvqueues_full(sk
, skb
))
712 __sk_add_backlog(sk
, skb
);
713 sk
->sk_backlog
.len
+= skb
->truesize
;
717 static inline int sk_backlog_rcv(struct sock
*sk
, struct sk_buff
*skb
)
719 return sk
->sk_backlog_rcv(sk
, skb
);
722 static inline void sock_rps_record_flow(const struct sock
*sk
)
725 struct rps_sock_flow_table
*sock_flow_table
;
728 sock_flow_table
= rcu_dereference(rps_sock_flow_table
);
729 rps_record_sock_flow(sock_flow_table
, sk
->sk_rxhash
);
734 static inline void sock_rps_reset_flow(const struct sock
*sk
)
737 struct rps_sock_flow_table
*sock_flow_table
;
740 sock_flow_table
= rcu_dereference(rps_sock_flow_table
);
741 rps_reset_sock_flow(sock_flow_table
, sk
->sk_rxhash
);
746 static inline void sock_rps_save_rxhash(struct sock
*sk
,
747 const struct sk_buff
*skb
)
750 if (unlikely(sk
->sk_rxhash
!= skb
->rxhash
)) {
751 sock_rps_reset_flow(sk
);
752 sk
->sk_rxhash
= skb
->rxhash
;
757 static inline void sock_rps_reset_rxhash(struct sock
*sk
)
760 sock_rps_reset_flow(sk
);
765 #define sk_wait_event(__sk, __timeo, __condition) \
767 release_sock(__sk); \
768 __rc = __condition; \
770 *(__timeo) = schedule_timeout(*(__timeo)); \
773 __rc = __condition; \
777 extern int sk_stream_wait_connect(struct sock
*sk
, long *timeo_p
);
778 extern int sk_stream_wait_memory(struct sock
*sk
, long *timeo_p
);
779 extern void sk_stream_wait_close(struct sock
*sk
, long timeo_p
);
780 extern int sk_stream_error(struct sock
*sk
, int flags
, int err
);
781 extern void sk_stream_kill_queues(struct sock
*sk
);
783 extern int sk_wait_data(struct sock
*sk
, long *timeo
);
785 struct request_sock_ops
;
786 struct timewait_sock_ops
;
787 struct inet_hashinfo
;
791 /* Networking protocol blocks we attach to sockets.
792 * socket layer -> transport layer interface
793 * transport -> network interface is defined by struct inet_proto
796 void (*close
)(struct sock
*sk
,
798 int (*connect
)(struct sock
*sk
,
799 struct sockaddr
*uaddr
,
801 int (*disconnect
)(struct sock
*sk
, int flags
);
803 struct sock
* (*accept
) (struct sock
*sk
, int flags
, int *err
);
805 int (*ioctl
)(struct sock
*sk
, int cmd
,
807 int (*init
)(struct sock
*sk
);
808 void (*destroy
)(struct sock
*sk
);
809 void (*shutdown
)(struct sock
*sk
, int how
);
810 int (*setsockopt
)(struct sock
*sk
, int level
,
811 int optname
, char __user
*optval
,
812 unsigned int optlen
);
813 int (*getsockopt
)(struct sock
*sk
, int level
,
814 int optname
, char __user
*optval
,
817 int (*compat_setsockopt
)(struct sock
*sk
,
819 int optname
, char __user
*optval
,
820 unsigned int optlen
);
821 int (*compat_getsockopt
)(struct sock
*sk
,
823 int optname
, char __user
*optval
,
825 int (*compat_ioctl
)(struct sock
*sk
,
826 unsigned int cmd
, unsigned long arg
);
828 int (*sendmsg
)(struct kiocb
*iocb
, struct sock
*sk
,
829 struct msghdr
*msg
, size_t len
);
830 int (*recvmsg
)(struct kiocb
*iocb
, struct sock
*sk
,
832 size_t len
, int noblock
, int flags
,
834 int (*sendpage
)(struct sock
*sk
, struct page
*page
,
835 int offset
, size_t size
, int flags
);
836 int (*bind
)(struct sock
*sk
,
837 struct sockaddr
*uaddr
, int addr_len
);
839 int (*backlog_rcv
) (struct sock
*sk
,
840 struct sk_buff
*skb
);
842 /* Keeping track of sk's, looking them up, and port selection methods. */
843 void (*hash
)(struct sock
*sk
);
844 void (*unhash
)(struct sock
*sk
);
845 void (*rehash
)(struct sock
*sk
);
846 int (*get_port
)(struct sock
*sk
, unsigned short snum
);
847 void (*clear_sk
)(struct sock
*sk
, int size
);
849 /* Keeping track of sockets in use */
850 #ifdef CONFIG_PROC_FS
851 unsigned int inuse_idx
;
854 /* Memory pressure */
855 void (*enter_memory_pressure
)(struct sock
*sk
);
856 atomic_long_t
*memory_allocated
; /* Current allocated memory. */
857 struct percpu_counter
*sockets_allocated
; /* Current number of sockets. */
859 * Pressure flag: try to collapse.
860 * Technical note: it is used by multiple contexts non atomically.
861 * All the __sk_mem_schedule() is of this nature: accounting
862 * is strict, actions are advisory and have some latency.
864 int *memory_pressure
;
871 struct kmem_cache
*slab
;
872 unsigned int obj_size
;
875 struct percpu_counter
*orphan_count
;
877 struct request_sock_ops
*rsk_prot
;
878 struct timewait_sock_ops
*twsk_prot
;
881 struct inet_hashinfo
*hashinfo
;
882 struct udp_table
*udp_table
;
883 struct raw_hashinfo
*raw_hash
;
886 struct module
*owner
;
890 struct list_head node
;
891 #ifdef SOCK_REFCNT_DEBUG
894 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
896 * cgroup specific init/deinit functions. Called once for all
897 * protocols that implement it, from cgroups populate function.
898 * This function has to setup any files the protocol want to
899 * appear in the kmem cgroup filesystem.
901 int (*init_cgroup
)(struct cgroup
*cgrp
,
902 struct cgroup_subsys
*ss
);
903 void (*destroy_cgroup
)(struct cgroup
*cgrp
);
904 struct cg_proto
*(*proto_cgroup
)(struct mem_cgroup
*memcg
);
909 void (*enter_memory_pressure
)(struct sock
*sk
);
910 struct res_counter
*memory_allocated
; /* Current allocated memory. */
911 struct percpu_counter
*sockets_allocated
; /* Current number of sockets. */
912 int *memory_pressure
;
915 * memcg field is used to find which memcg we belong directly
916 * Each memcg struct can hold more than one cg_proto, so container_of
919 * The elegant solution would be having an inverse function to
920 * proto_cgroup in struct proto, but that means polluting the structure
921 * for everybody, instead of just for memcg users.
923 struct mem_cgroup
*memcg
;
926 extern int proto_register(struct proto
*prot
, int alloc_slab
);
927 extern void proto_unregister(struct proto
*prot
);
929 #ifdef SOCK_REFCNT_DEBUG
930 static inline void sk_refcnt_debug_inc(struct sock
*sk
)
932 atomic_inc(&sk
->sk_prot
->socks
);
935 static inline void sk_refcnt_debug_dec(struct sock
*sk
)
937 atomic_dec(&sk
->sk_prot
->socks
);
938 printk(KERN_DEBUG
"%s socket %p released, %d are still alive\n",
939 sk
->sk_prot
->name
, sk
, atomic_read(&sk
->sk_prot
->socks
));
942 inline void sk_refcnt_debug_release(const struct sock
*sk
)
944 if (atomic_read(&sk
->sk_refcnt
) != 1)
945 printk(KERN_DEBUG
"Destruction of the %s socket %p delayed, refcnt=%d\n",
946 sk
->sk_prot
->name
, sk
, atomic_read(&sk
->sk_refcnt
));
948 #else /* SOCK_REFCNT_DEBUG */
949 #define sk_refcnt_debug_inc(sk) do { } while (0)
950 #define sk_refcnt_debug_dec(sk) do { } while (0)
951 #define sk_refcnt_debug_release(sk) do { } while (0)
952 #endif /* SOCK_REFCNT_DEBUG */
954 #if defined(CONFIG_CGROUP_MEM_RES_CTLR_KMEM) && defined(CONFIG_NET)
955 extern struct static_key memcg_socket_limit_enabled
;
956 static inline struct cg_proto
*parent_cg_proto(struct proto
*proto
,
957 struct cg_proto
*cg_proto
)
959 return proto
->proto_cgroup(parent_mem_cgroup(cg_proto
->memcg
));
961 #define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
963 #define mem_cgroup_sockets_enabled 0
964 static inline struct cg_proto
*parent_cg_proto(struct proto
*proto
,
965 struct cg_proto
*cg_proto
)
972 static inline bool sk_has_memory_pressure(const struct sock
*sk
)
974 return sk
->sk_prot
->memory_pressure
!= NULL
;
977 static inline bool sk_under_memory_pressure(const struct sock
*sk
)
979 if (!sk
->sk_prot
->memory_pressure
)
982 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
)
983 return !!*sk
->sk_cgrp
->memory_pressure
;
985 return !!*sk
->sk_prot
->memory_pressure
;
988 static inline void sk_leave_memory_pressure(struct sock
*sk
)
990 int *memory_pressure
= sk
->sk_prot
->memory_pressure
;
992 if (!memory_pressure
)
995 if (*memory_pressure
)
996 *memory_pressure
= 0;
998 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
) {
999 struct cg_proto
*cg_proto
= sk
->sk_cgrp
;
1000 struct proto
*prot
= sk
->sk_prot
;
1002 for (; cg_proto
; cg_proto
= parent_cg_proto(prot
, cg_proto
))
1003 if (*cg_proto
->memory_pressure
)
1004 *cg_proto
->memory_pressure
= 0;
1009 static inline void sk_enter_memory_pressure(struct sock
*sk
)
1011 if (!sk
->sk_prot
->enter_memory_pressure
)
1014 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
) {
1015 struct cg_proto
*cg_proto
= sk
->sk_cgrp
;
1016 struct proto
*prot
= sk
->sk_prot
;
1018 for (; cg_proto
; cg_proto
= parent_cg_proto(prot
, cg_proto
))
1019 cg_proto
->enter_memory_pressure(sk
);
1022 sk
->sk_prot
->enter_memory_pressure(sk
);
1025 static inline long sk_prot_mem_limits(const struct sock
*sk
, int index
)
1027 long *prot
= sk
->sk_prot
->sysctl_mem
;
1028 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
)
1029 prot
= sk
->sk_cgrp
->sysctl_mem
;
1033 static inline void memcg_memory_allocated_add(struct cg_proto
*prot
,
1037 struct res_counter
*fail
;
1040 ret
= res_counter_charge_nofail(prot
->memory_allocated
,
1041 amt
<< PAGE_SHIFT
, &fail
);
1043 *parent_status
= OVER_LIMIT
;
1046 static inline void memcg_memory_allocated_sub(struct cg_proto
*prot
,
1049 res_counter_uncharge(prot
->memory_allocated
, amt
<< PAGE_SHIFT
);
1052 static inline u64
memcg_memory_allocated_read(struct cg_proto
*prot
)
1055 ret
= res_counter_read_u64(prot
->memory_allocated
, RES_USAGE
);
1056 return ret
>> PAGE_SHIFT
;
1060 sk_memory_allocated(const struct sock
*sk
)
1062 struct proto
*prot
= sk
->sk_prot
;
1063 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
)
1064 return memcg_memory_allocated_read(sk
->sk_cgrp
);
1066 return atomic_long_read(prot
->memory_allocated
);
1070 sk_memory_allocated_add(struct sock
*sk
, int amt
, int *parent_status
)
1072 struct proto
*prot
= sk
->sk_prot
;
1074 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
) {
1075 memcg_memory_allocated_add(sk
->sk_cgrp
, amt
, parent_status
);
1076 /* update the root cgroup regardless */
1077 atomic_long_add_return(amt
, prot
->memory_allocated
);
1078 return memcg_memory_allocated_read(sk
->sk_cgrp
);
1081 return atomic_long_add_return(amt
, prot
->memory_allocated
);
1085 sk_memory_allocated_sub(struct sock
*sk
, int amt
)
1087 struct proto
*prot
= sk
->sk_prot
;
1089 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
)
1090 memcg_memory_allocated_sub(sk
->sk_cgrp
, amt
);
1092 atomic_long_sub(amt
, prot
->memory_allocated
);
1095 static inline void sk_sockets_allocated_dec(struct sock
*sk
)
1097 struct proto
*prot
= sk
->sk_prot
;
1099 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
) {
1100 struct cg_proto
*cg_proto
= sk
->sk_cgrp
;
1102 for (; cg_proto
; cg_proto
= parent_cg_proto(prot
, cg_proto
))
1103 percpu_counter_dec(cg_proto
->sockets_allocated
);
1106 percpu_counter_dec(prot
->sockets_allocated
);
1109 static inline void sk_sockets_allocated_inc(struct sock
*sk
)
1111 struct proto
*prot
= sk
->sk_prot
;
1113 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
) {
1114 struct cg_proto
*cg_proto
= sk
->sk_cgrp
;
1116 for (; cg_proto
; cg_proto
= parent_cg_proto(prot
, cg_proto
))
1117 percpu_counter_inc(cg_proto
->sockets_allocated
);
1120 percpu_counter_inc(prot
->sockets_allocated
);
1124 sk_sockets_allocated_read_positive(struct sock
*sk
)
1126 struct proto
*prot
= sk
->sk_prot
;
1128 if (mem_cgroup_sockets_enabled
&& sk
->sk_cgrp
)
1129 return percpu_counter_sum_positive(sk
->sk_cgrp
->sockets_allocated
);
1131 return percpu_counter_sum_positive(prot
->sockets_allocated
);
1135 proto_sockets_allocated_sum_positive(struct proto
*prot
)
1137 return percpu_counter_sum_positive(prot
->sockets_allocated
);
1141 proto_memory_allocated(struct proto
*prot
)
1143 return atomic_long_read(prot
->memory_allocated
);
1147 proto_memory_pressure(struct proto
*prot
)
1149 if (!prot
->memory_pressure
)
1151 return !!*prot
->memory_pressure
;
1155 #ifdef CONFIG_PROC_FS
1156 /* Called with local bh disabled */
1157 extern void sock_prot_inuse_add(struct net
*net
, struct proto
*prot
, int inc
);
1158 extern int sock_prot_inuse_get(struct net
*net
, struct proto
*proto
);
1160 static void inline sock_prot_inuse_add(struct net
*net
, struct proto
*prot
,
1167 /* With per-bucket locks this operation is not-atomic, so that
1168 * this version is not worse.
1170 static inline void __sk_prot_rehash(struct sock
*sk
)
1172 sk
->sk_prot
->unhash(sk
);
1173 sk
->sk_prot
->hash(sk
);
1176 void sk_prot_clear_portaddr_nulls(struct sock
*sk
, int size
);
1178 /* About 10 seconds */
1179 #define SOCK_DESTROY_TIME (10*HZ)
1181 /* Sockets 0-1023 can't be bound to unless you are superuser */
1182 #define PROT_SOCK 1024
1184 #define SHUTDOWN_MASK 3
1185 #define RCV_SHUTDOWN 1
1186 #define SEND_SHUTDOWN 2
1188 #define SOCK_SNDBUF_LOCK 1
1189 #define SOCK_RCVBUF_LOCK 2
1190 #define SOCK_BINDADDR_LOCK 4
1191 #define SOCK_BINDPORT_LOCK 8
1193 /* sock_iocb: used to kick off async processing of socket ios */
1195 struct list_head list
;
1199 struct socket
*sock
;
1201 struct scm_cookie
*scm
;
1202 struct msghdr
*msg
, async_msg
;
1203 struct kiocb
*kiocb
;
1206 static inline struct sock_iocb
*kiocb_to_siocb(struct kiocb
*iocb
)
1208 return (struct sock_iocb
*)iocb
->private;
1211 static inline struct kiocb
*siocb_to_kiocb(struct sock_iocb
*si
)
1216 struct socket_alloc
{
1217 struct socket socket
;
1218 struct inode vfs_inode
;
1221 static inline struct socket
*SOCKET_I(struct inode
*inode
)
1223 return &container_of(inode
, struct socket_alloc
, vfs_inode
)->socket
;
1226 static inline struct inode
*SOCK_INODE(struct socket
*socket
)
1228 return &container_of(socket
, struct socket_alloc
, socket
)->vfs_inode
;
1232 * Functions for memory accounting
1234 extern int __sk_mem_schedule(struct sock
*sk
, int size
, int kind
);
1235 extern void __sk_mem_reclaim(struct sock
*sk
);
1237 #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1238 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1239 #define SK_MEM_SEND 0
1240 #define SK_MEM_RECV 1
1242 static inline int sk_mem_pages(int amt
)
1244 return (amt
+ SK_MEM_QUANTUM
- 1) >> SK_MEM_QUANTUM_SHIFT
;
1247 static inline int sk_has_account(struct sock
*sk
)
1249 /* return true if protocol supports memory accounting */
1250 return !!sk
->sk_prot
->memory_allocated
;
1253 static inline int sk_wmem_schedule(struct sock
*sk
, int size
)
1255 if (!sk_has_account(sk
))
1257 return size
<= sk
->sk_forward_alloc
||
1258 __sk_mem_schedule(sk
, size
, SK_MEM_SEND
);
1261 static inline int sk_rmem_schedule(struct sock
*sk
, int size
)
1263 if (!sk_has_account(sk
))
1265 return size
<= sk
->sk_forward_alloc
||
1266 __sk_mem_schedule(sk
, size
, SK_MEM_RECV
);
1269 static inline void sk_mem_reclaim(struct sock
*sk
)
1271 if (!sk_has_account(sk
))
1273 if (sk
->sk_forward_alloc
>= SK_MEM_QUANTUM
)
1274 __sk_mem_reclaim(sk
);
1277 static inline void sk_mem_reclaim_partial(struct sock
*sk
)
1279 if (!sk_has_account(sk
))
1281 if (sk
->sk_forward_alloc
> SK_MEM_QUANTUM
)
1282 __sk_mem_reclaim(sk
);
1285 static inline void sk_mem_charge(struct sock
*sk
, int size
)
1287 if (!sk_has_account(sk
))
1289 sk
->sk_forward_alloc
-= size
;
1292 static inline void sk_mem_uncharge(struct sock
*sk
, int size
)
1294 if (!sk_has_account(sk
))
1296 sk
->sk_forward_alloc
+= size
;
1299 static inline void sk_wmem_free_skb(struct sock
*sk
, struct sk_buff
*skb
)
1301 sock_set_flag(sk
, SOCK_QUEUE_SHRUNK
);
1302 sk
->sk_wmem_queued
-= skb
->truesize
;
1303 sk_mem_uncharge(sk
, skb
->truesize
);
1307 /* Used by processes to "lock" a socket state, so that
1308 * interrupts and bottom half handlers won't change it
1309 * from under us. It essentially blocks any incoming
1310 * packets, so that we won't get any new data or any
1311 * packets that change the state of the socket.
1313 * While locked, BH processing will add new packets to
1314 * the backlog queue. This queue is processed by the
1315 * owner of the socket lock right before it is released.
1317 * Since ~2.3.5 it is also exclusive sleep lock serializing
1318 * accesses from user process context.
1320 #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
1323 * Macro so as to not evaluate some arguments when
1324 * lockdep is not enabled.
1326 * Mark both the sk_lock and the sk_lock.slock as a
1327 * per-address-family lock class.
1329 #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1331 sk->sk_lock.owned = 0; \
1332 init_waitqueue_head(&sk->sk_lock.wq); \
1333 spin_lock_init(&(sk)->sk_lock.slock); \
1334 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1335 sizeof((sk)->sk_lock)); \
1336 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1338 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1341 extern void lock_sock_nested(struct sock
*sk
, int subclass
);
1343 static inline void lock_sock(struct sock
*sk
)
1345 lock_sock_nested(sk
, 0);
1348 extern void release_sock(struct sock
*sk
);
1350 /* BH context may only use the following locking interface. */
1351 #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
1352 #define bh_lock_sock_nested(__sk) \
1353 spin_lock_nested(&((__sk)->sk_lock.slock), \
1354 SINGLE_DEPTH_NESTING)
1355 #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1357 extern bool lock_sock_fast(struct sock
*sk
);
1359 * unlock_sock_fast - complement of lock_sock_fast
1363 * fast unlock socket for user context.
1364 * If slow mode is on, we call regular release_sock()
1366 static inline void unlock_sock_fast(struct sock
*sk
, bool slow
)
1371 spin_unlock_bh(&sk
->sk_lock
.slock
);
1375 extern struct sock
*sk_alloc(struct net
*net
, int family
,
1377 struct proto
*prot
);
1378 extern void sk_free(struct sock
*sk
);
1379 extern void sk_release_kernel(struct sock
*sk
);
1380 extern struct sock
*sk_clone_lock(const struct sock
*sk
,
1381 const gfp_t priority
);
1383 extern struct sk_buff
*sock_wmalloc(struct sock
*sk
,
1384 unsigned long size
, int force
,
1386 extern struct sk_buff
*sock_rmalloc(struct sock
*sk
,
1387 unsigned long size
, int force
,
1389 extern void sock_wfree(struct sk_buff
*skb
);
1390 extern void sock_rfree(struct sk_buff
*skb
);
1392 extern int sock_setsockopt(struct socket
*sock
, int level
,
1393 int op
, char __user
*optval
,
1394 unsigned int optlen
);
1396 extern int sock_getsockopt(struct socket
*sock
, int level
,
1397 int op
, char __user
*optval
,
1398 int __user
*optlen
);
1399 extern struct sk_buff
*sock_alloc_send_skb(struct sock
*sk
,
1403 extern struct sk_buff
*sock_alloc_send_pskb(struct sock
*sk
,
1404 unsigned long header_len
,
1405 unsigned long data_len
,
1408 extern void *sock_kmalloc(struct sock
*sk
, int size
,
1410 extern void sock_kfree_s(struct sock
*sk
, void *mem
, int size
);
1411 extern void sk_send_sigurg(struct sock
*sk
);
1413 #ifdef CONFIG_CGROUPS
1414 extern void sock_update_classid(struct sock
*sk
);
1416 static inline void sock_update_classid(struct sock
*sk
)
1422 * Functions to fill in entries in struct proto_ops when a protocol
1423 * does not implement a particular function.
1425 extern int sock_no_bind(struct socket
*,
1426 struct sockaddr
*, int);
1427 extern int sock_no_connect(struct socket
*,
1428 struct sockaddr
*, int, int);
1429 extern int sock_no_socketpair(struct socket
*,
1431 extern int sock_no_accept(struct socket
*,
1432 struct socket
*, int);
1433 extern int sock_no_getname(struct socket
*,
1434 struct sockaddr
*, int *, int);
1435 extern unsigned int sock_no_poll(struct file
*, struct socket
*,
1436 struct poll_table_struct
*);
1437 extern int sock_no_ioctl(struct socket
*, unsigned int,
1439 extern int sock_no_listen(struct socket
*, int);
1440 extern int sock_no_shutdown(struct socket
*, int);
1441 extern int sock_no_getsockopt(struct socket
*, int , int,
1442 char __user
*, int __user
*);
1443 extern int sock_no_setsockopt(struct socket
*, int, int,
1444 char __user
*, unsigned int);
1445 extern int sock_no_sendmsg(struct kiocb
*, struct socket
*,
1446 struct msghdr
*, size_t);
1447 extern int sock_no_recvmsg(struct kiocb
*, struct socket
*,
1448 struct msghdr
*, size_t, int);
1449 extern int sock_no_mmap(struct file
*file
,
1450 struct socket
*sock
,
1451 struct vm_area_struct
*vma
);
1452 extern ssize_t
sock_no_sendpage(struct socket
*sock
,
1454 int offset
, size_t size
,
1458 * Functions to fill in entries in struct proto_ops when a protocol
1459 * uses the inet style.
1461 extern int sock_common_getsockopt(struct socket
*sock
, int level
, int optname
,
1462 char __user
*optval
, int __user
*optlen
);
1463 extern int sock_common_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
1464 struct msghdr
*msg
, size_t size
, int flags
);
1465 extern int sock_common_setsockopt(struct socket
*sock
, int level
, int optname
,
1466 char __user
*optval
, unsigned int optlen
);
1467 extern int compat_sock_common_getsockopt(struct socket
*sock
, int level
,
1468 int optname
, char __user
*optval
, int __user
*optlen
);
1469 extern int compat_sock_common_setsockopt(struct socket
*sock
, int level
,
1470 int optname
, char __user
*optval
, unsigned int optlen
);
1472 extern void sk_common_release(struct sock
*sk
);
1475 * Default socket callbacks and setup code
1478 /* Initialise core socket variables */
1479 extern void sock_init_data(struct socket
*sock
, struct sock
*sk
);
1481 extern void sk_filter_release_rcu(struct rcu_head
*rcu
);
1484 * sk_filter_release - release a socket filter
1485 * @fp: filter to remove
1487 * Remove a filter from a socket and release its resources.
1490 static inline void sk_filter_release(struct sk_filter
*fp
)
1492 if (atomic_dec_and_test(&fp
->refcnt
))
1493 call_rcu(&fp
->rcu
, sk_filter_release_rcu
);
1496 static inline void sk_filter_uncharge(struct sock
*sk
, struct sk_filter
*fp
)
1498 unsigned int size
= sk_filter_len(fp
);
1500 atomic_sub(size
, &sk
->sk_omem_alloc
);
1501 sk_filter_release(fp
);
1504 static inline void sk_filter_charge(struct sock
*sk
, struct sk_filter
*fp
)
1506 atomic_inc(&fp
->refcnt
);
1507 atomic_add(sk_filter_len(fp
), &sk
->sk_omem_alloc
);
1511 * Socket reference counting postulates.
1513 * * Each user of socket SHOULD hold a reference count.
1514 * * Each access point to socket (an hash table bucket, reference from a list,
1515 * running timer, skb in flight MUST hold a reference count.
1516 * * When reference count hits 0, it means it will never increase back.
1517 * * When reference count hits 0, it means that no references from
1518 * outside exist to this socket and current process on current CPU
1519 * is last user and may/should destroy this socket.
1520 * * sk_free is called from any context: process, BH, IRQ. When
1521 * it is called, socket has no references from outside -> sk_free
1522 * may release descendant resources allocated by the socket, but
1523 * to the time when it is called, socket is NOT referenced by any
1524 * hash tables, lists etc.
1525 * * Packets, delivered from outside (from network or from another process)
1526 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1527 * when they sit in queue. Otherwise, packets will leak to hole, when
1528 * socket is looked up by one cpu and unhasing is made by another CPU.
1529 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1530 * (leak to backlog). Packet socket does all the processing inside
1531 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1532 * use separate SMP lock, so that they are prone too.
1535 /* Ungrab socket and destroy it, if it was the last reference. */
1536 static inline void sock_put(struct sock
*sk
)
1538 if (atomic_dec_and_test(&sk
->sk_refcnt
))
1542 extern int sk_receive_skb(struct sock
*sk
, struct sk_buff
*skb
,
1545 static inline void sk_tx_queue_set(struct sock
*sk
, int tx_queue
)
1547 sk
->sk_tx_queue_mapping
= tx_queue
;
1550 static inline void sk_tx_queue_clear(struct sock
*sk
)
1552 sk
->sk_tx_queue_mapping
= -1;
1555 static inline int sk_tx_queue_get(const struct sock
*sk
)
1557 return sk
? sk
->sk_tx_queue_mapping
: -1;
1560 static inline void sk_set_socket(struct sock
*sk
, struct socket
*sock
)
1562 sk_tx_queue_clear(sk
);
1563 sk
->sk_socket
= sock
;
1566 static inline wait_queue_head_t
*sk_sleep(struct sock
*sk
)
1568 BUILD_BUG_ON(offsetof(struct socket_wq
, wait
) != 0);
1569 return &rcu_dereference_raw(sk
->sk_wq
)->wait
;
1571 /* Detach socket from process context.
1572 * Announce socket dead, detach it from wait queue and inode.
1573 * Note that parent inode held reference count on this struct sock,
1574 * we do not release it in this function, because protocol
1575 * probably wants some additional cleanups or even continuing
1576 * to work with this socket (TCP).
1578 static inline void sock_orphan(struct sock
*sk
)
1580 write_lock_bh(&sk
->sk_callback_lock
);
1581 sock_set_flag(sk
, SOCK_DEAD
);
1582 sk_set_socket(sk
, NULL
);
1584 write_unlock_bh(&sk
->sk_callback_lock
);
1587 static inline void sock_graft(struct sock
*sk
, struct socket
*parent
)
1589 write_lock_bh(&sk
->sk_callback_lock
);
1590 sk
->sk_wq
= parent
->wq
;
1592 sk_set_socket(sk
, parent
);
1593 security_sock_graft(sk
, parent
);
1594 write_unlock_bh(&sk
->sk_callback_lock
);
1597 extern int sock_i_uid(struct sock
*sk
);
1598 extern unsigned long sock_i_ino(struct sock
*sk
);
1600 static inline struct dst_entry
*
1601 __sk_dst_get(struct sock
*sk
)
1603 return rcu_dereference_check(sk
->sk_dst_cache
, sock_owned_by_user(sk
) ||
1604 lockdep_is_held(&sk
->sk_lock
.slock
));
1607 static inline struct dst_entry
*
1608 sk_dst_get(struct sock
*sk
)
1610 struct dst_entry
*dst
;
1613 dst
= rcu_dereference(sk
->sk_dst_cache
);
1620 extern void sk_reset_txq(struct sock
*sk
);
1622 static inline void dst_negative_advice(struct sock
*sk
)
1624 struct dst_entry
*ndst
, *dst
= __sk_dst_get(sk
);
1626 if (dst
&& dst
->ops
->negative_advice
) {
1627 ndst
= dst
->ops
->negative_advice(dst
);
1630 rcu_assign_pointer(sk
->sk_dst_cache
, ndst
);
1637 __sk_dst_set(struct sock
*sk
, struct dst_entry
*dst
)
1639 struct dst_entry
*old_dst
;
1641 sk_tx_queue_clear(sk
);
1643 * This can be called while sk is owned by the caller only,
1644 * with no state that can be checked in a rcu_dereference_check() cond
1646 old_dst
= rcu_dereference_raw(sk
->sk_dst_cache
);
1647 rcu_assign_pointer(sk
->sk_dst_cache
, dst
);
1648 dst_release(old_dst
);
1652 sk_dst_set(struct sock
*sk
, struct dst_entry
*dst
)
1654 spin_lock(&sk
->sk_dst_lock
);
1655 __sk_dst_set(sk
, dst
);
1656 spin_unlock(&sk
->sk_dst_lock
);
1660 __sk_dst_reset(struct sock
*sk
)
1662 __sk_dst_set(sk
, NULL
);
1666 sk_dst_reset(struct sock
*sk
)
1668 spin_lock(&sk
->sk_dst_lock
);
1670 spin_unlock(&sk
->sk_dst_lock
);
1673 extern struct dst_entry
*__sk_dst_check(struct sock
*sk
, u32 cookie
);
1675 extern struct dst_entry
*sk_dst_check(struct sock
*sk
, u32 cookie
);
1677 static inline int sk_can_gso(const struct sock
*sk
)
1679 return net_gso_ok(sk
->sk_route_caps
, sk
->sk_gso_type
);
1682 extern void sk_setup_caps(struct sock
*sk
, struct dst_entry
*dst
);
1684 static inline void sk_nocaps_add(struct sock
*sk
, netdev_features_t flags
)
1686 sk
->sk_route_nocaps
|= flags
;
1687 sk
->sk_route_caps
&= ~flags
;
1690 static inline int skb_do_copy_data_nocache(struct sock
*sk
, struct sk_buff
*skb
,
1691 char __user
*from
, char *to
,
1692 int copy
, int offset
)
1694 if (skb
->ip_summed
== CHECKSUM_NONE
) {
1696 __wsum csum
= csum_and_copy_from_user(from
, to
, copy
, 0, &err
);
1699 skb
->csum
= csum_block_add(skb
->csum
, csum
, offset
);
1700 } else if (sk
->sk_route_caps
& NETIF_F_NOCACHE_COPY
) {
1701 if (!access_ok(VERIFY_READ
, from
, copy
) ||
1702 __copy_from_user_nocache(to
, from
, copy
))
1704 } else if (copy_from_user(to
, from
, copy
))
1710 static inline int skb_add_data_nocache(struct sock
*sk
, struct sk_buff
*skb
,
1711 char __user
*from
, int copy
)
1713 int err
, offset
= skb
->len
;
1715 err
= skb_do_copy_data_nocache(sk
, skb
, from
, skb_put(skb
, copy
),
1718 __skb_trim(skb
, offset
);
1723 static inline int skb_copy_to_page_nocache(struct sock
*sk
, char __user
*from
,
1724 struct sk_buff
*skb
,
1730 err
= skb_do_copy_data_nocache(sk
, skb
, from
, page_address(page
) + off
,
1736 skb
->data_len
+= copy
;
1737 skb
->truesize
+= copy
;
1738 sk
->sk_wmem_queued
+= copy
;
1739 sk_mem_charge(sk
, copy
);
1743 static inline int skb_copy_to_page(struct sock
*sk
, char __user
*from
,
1744 struct sk_buff
*skb
, struct page
*page
,
1747 if (skb
->ip_summed
== CHECKSUM_NONE
) {
1749 __wsum csum
= csum_and_copy_from_user(from
,
1750 page_address(page
) + off
,
1754 skb
->csum
= csum_block_add(skb
->csum
, csum
, skb
->len
);
1755 } else if (copy_from_user(page_address(page
) + off
, from
, copy
))
1759 skb
->data_len
+= copy
;
1760 skb
->truesize
+= copy
;
1761 sk
->sk_wmem_queued
+= copy
;
1762 sk_mem_charge(sk
, copy
);
1767 * sk_wmem_alloc_get - returns write allocations
1770 * Returns sk_wmem_alloc minus initial offset of one
1772 static inline int sk_wmem_alloc_get(const struct sock
*sk
)
1774 return atomic_read(&sk
->sk_wmem_alloc
) - 1;
1778 * sk_rmem_alloc_get - returns read allocations
1781 * Returns sk_rmem_alloc
1783 static inline int sk_rmem_alloc_get(const struct sock
*sk
)
1785 return atomic_read(&sk
->sk_rmem_alloc
);
1789 * sk_has_allocations - check if allocations are outstanding
1792 * Returns true if socket has write or read allocations
1794 static inline int sk_has_allocations(const struct sock
*sk
)
1796 return sk_wmem_alloc_get(sk
) || sk_rmem_alloc_get(sk
);
1800 * wq_has_sleeper - check if there are any waiting processes
1801 * @wq: struct socket_wq
1803 * Returns true if socket_wq has waiting processes
1805 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
1806 * barrier call. They were added due to the race found within the tcp code.
1808 * Consider following tcp code paths:
1812 * sys_select receive packet
1814 * __add_wait_queue update tp->rcv_nxt
1816 * tp->rcv_nxt check sock_def_readable
1818 * schedule rcu_read_lock();
1819 * wq = rcu_dereference(sk->sk_wq);
1820 * if (wq && waitqueue_active(&wq->wait))
1821 * wake_up_interruptible(&wq->wait)
1825 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1826 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1827 * could then endup calling schedule and sleep forever if there are no more
1828 * data on the socket.
1831 static inline bool wq_has_sleeper(struct socket_wq
*wq
)
1835 * We need to be sure we are in sync with the
1836 * add_wait_queue modifications to the wait queue.
1838 * This memory barrier is paired in the sock_poll_wait.
1841 return wq
&& waitqueue_active(&wq
->wait
);
1845 * sock_poll_wait - place memory barrier behind the poll_wait call.
1847 * @wait_address: socket wait queue
1850 * See the comments in the wq_has_sleeper function.
1852 static inline void sock_poll_wait(struct file
*filp
,
1853 wait_queue_head_t
*wait_address
, poll_table
*p
)
1855 if (p
&& wait_address
) {
1856 poll_wait(filp
, wait_address
, p
);
1858 * We need to be sure we are in sync with the
1859 * socket flags modification.
1861 * This memory barrier is paired in the wq_has_sleeper.
1868 * Queue a received datagram if it will fit. Stream and sequenced
1869 * protocols can't normally use this as they need to fit buffers in
1870 * and play with them.
1872 * Inlined as it's very short and called for pretty much every
1873 * packet ever received.
1876 static inline void skb_set_owner_w(struct sk_buff
*skb
, struct sock
*sk
)
1880 skb
->destructor
= sock_wfree
;
1882 * We used to take a refcount on sk, but following operation
1883 * is enough to guarantee sk_free() wont free this sock until
1884 * all in-flight packets are completed
1886 atomic_add(skb
->truesize
, &sk
->sk_wmem_alloc
);
1889 static inline void skb_set_owner_r(struct sk_buff
*skb
, struct sock
*sk
)
1893 skb
->destructor
= sock_rfree
;
1894 atomic_add(skb
->truesize
, &sk
->sk_rmem_alloc
);
1895 sk_mem_charge(sk
, skb
->truesize
);
1898 extern void sk_reset_timer(struct sock
*sk
, struct timer_list
* timer
,
1899 unsigned long expires
);
1901 extern void sk_stop_timer(struct sock
*sk
, struct timer_list
* timer
);
1903 extern int sock_queue_rcv_skb(struct sock
*sk
, struct sk_buff
*skb
);
1905 extern int sock_queue_err_skb(struct sock
*sk
, struct sk_buff
*skb
);
1908 * Recover an error report and clear atomically
1911 static inline int sock_error(struct sock
*sk
)
1914 if (likely(!sk
->sk_err
))
1916 err
= xchg(&sk
->sk_err
, 0);
1920 static inline unsigned long sock_wspace(struct sock
*sk
)
1924 if (!(sk
->sk_shutdown
& SEND_SHUTDOWN
)) {
1925 amt
= sk
->sk_sndbuf
- atomic_read(&sk
->sk_wmem_alloc
);
1932 static inline void sk_wake_async(struct sock
*sk
, int how
, int band
)
1934 if (sock_flag(sk
, SOCK_FASYNC
))
1935 sock_wake_async(sk
->sk_socket
, how
, band
);
1938 #define SOCK_MIN_SNDBUF 2048
1940 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1941 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1943 #define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
1945 static inline void sk_stream_moderate_sndbuf(struct sock
*sk
)
1947 if (!(sk
->sk_userlocks
& SOCK_SNDBUF_LOCK
)) {
1948 sk
->sk_sndbuf
= min(sk
->sk_sndbuf
, sk
->sk_wmem_queued
>> 1);
1949 sk
->sk_sndbuf
= max(sk
->sk_sndbuf
, SOCK_MIN_SNDBUF
);
1953 struct sk_buff
*sk_stream_alloc_skb(struct sock
*sk
, int size
, gfp_t gfp
);
1955 static inline struct page
*sk_stream_alloc_page(struct sock
*sk
)
1957 struct page
*page
= NULL
;
1959 page
= alloc_pages(sk
->sk_allocation
, 0);
1961 sk_enter_memory_pressure(sk
);
1962 sk_stream_moderate_sndbuf(sk
);
1968 * Default write policy as shown to user space via poll/select/SIGIO
1970 static inline int sock_writeable(const struct sock
*sk
)
1972 return atomic_read(&sk
->sk_wmem_alloc
) < (sk
->sk_sndbuf
>> 1);
1975 static inline gfp_t
gfp_any(void)
1977 return in_softirq() ? GFP_ATOMIC
: GFP_KERNEL
;
1980 static inline long sock_rcvtimeo(const struct sock
*sk
, int noblock
)
1982 return noblock
? 0 : sk
->sk_rcvtimeo
;
1985 static inline long sock_sndtimeo(const struct sock
*sk
, int noblock
)
1987 return noblock
? 0 : sk
->sk_sndtimeo
;
1990 static inline int sock_rcvlowat(const struct sock
*sk
, int waitall
, int len
)
1992 return (waitall
? len
: min_t(int, sk
->sk_rcvlowat
, len
)) ? : 1;
1995 /* Alas, with timeout socket operations are not restartable.
1996 * Compare this to poll().
1998 static inline int sock_intr_errno(long timeo
)
2000 return timeo
== MAX_SCHEDULE_TIMEOUT
? -ERESTARTSYS
: -EINTR
;
2003 extern void __sock_recv_timestamp(struct msghdr
*msg
, struct sock
*sk
,
2004 struct sk_buff
*skb
);
2005 extern void __sock_recv_wifi_status(struct msghdr
*msg
, struct sock
*sk
,
2006 struct sk_buff
*skb
);
2008 static __inline__
void
2009 sock_recv_timestamp(struct msghdr
*msg
, struct sock
*sk
, struct sk_buff
*skb
)
2011 ktime_t kt
= skb
->tstamp
;
2012 struct skb_shared_hwtstamps
*hwtstamps
= skb_hwtstamps(skb
);
2015 * generate control messages if
2016 * - receive time stamping in software requested (SOCK_RCVTSTAMP
2017 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
2018 * - software time stamp available and wanted
2019 * (SOCK_TIMESTAMPING_SOFTWARE)
2020 * - hardware time stamps available and wanted
2021 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
2022 * SOCK_TIMESTAMPING_RAW_HARDWARE)
2024 if (sock_flag(sk
, SOCK_RCVTSTAMP
) ||
2025 sock_flag(sk
, SOCK_TIMESTAMPING_RX_SOFTWARE
) ||
2026 (kt
.tv64
&& sock_flag(sk
, SOCK_TIMESTAMPING_SOFTWARE
)) ||
2027 (hwtstamps
->hwtstamp
.tv64
&&
2028 sock_flag(sk
, SOCK_TIMESTAMPING_RAW_HARDWARE
)) ||
2029 (hwtstamps
->syststamp
.tv64
&&
2030 sock_flag(sk
, SOCK_TIMESTAMPING_SYS_HARDWARE
)))
2031 __sock_recv_timestamp(msg
, sk
, skb
);
2035 if (sock_flag(sk
, SOCK_WIFI_STATUS
) && skb
->wifi_acked_valid
)
2036 __sock_recv_wifi_status(msg
, sk
, skb
);
2039 extern void __sock_recv_ts_and_drops(struct msghdr
*msg
, struct sock
*sk
,
2040 struct sk_buff
*skb
);
2042 static inline void sock_recv_ts_and_drops(struct msghdr
*msg
, struct sock
*sk
,
2043 struct sk_buff
*skb
)
2045 #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2046 (1UL << SOCK_RCVTSTAMP) | \
2047 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
2048 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
2049 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
2050 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2052 if (sk
->sk_flags
& FLAGS_TS_OR_DROPS
)
2053 __sock_recv_ts_and_drops(msg
, sk
, skb
);
2055 sk
->sk_stamp
= skb
->tstamp
;
2059 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2060 * @sk: socket sending this packet
2061 * @tx_flags: filled with instructions for time stamping
2063 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
2064 * parameters are invalid.
2066 extern int sock_tx_timestamp(struct sock
*sk
, __u8
*tx_flags
);
2069 * sk_eat_skb - Release a skb if it is no longer needed
2070 * @sk: socket to eat this skb from
2071 * @skb: socket buffer to eat
2072 * @copied_early: flag indicating whether DMA operations copied this data early
2074 * This routine must be called with interrupts disabled or with the socket
2075 * locked so that the sk_buff queue operation is ok.
2077 #ifdef CONFIG_NET_DMA
2078 static inline void sk_eat_skb(struct sock
*sk
, struct sk_buff
*skb
, int copied_early
)
2080 __skb_unlink(skb
, &sk
->sk_receive_queue
);
2084 __skb_queue_tail(&sk
->sk_async_wait_queue
, skb
);
2087 static inline void sk_eat_skb(struct sock
*sk
, struct sk_buff
*skb
, int copied_early
)
2089 __skb_unlink(skb
, &sk
->sk_receive_queue
);
2095 struct net
*sock_net(const struct sock
*sk
)
2097 return read_pnet(&sk
->sk_net
);
2101 void sock_net_set(struct sock
*sk
, struct net
*net
)
2103 write_pnet(&sk
->sk_net
, net
);
2107 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
2108 * They should not hold a reference to a namespace in order to allow
2110 * Sockets after sk_change_net should be released using sk_release_kernel
2112 static inline void sk_change_net(struct sock
*sk
, struct net
*net
)
2114 put_net(sock_net(sk
));
2115 sock_net_set(sk
, hold_net(net
));
2118 static inline struct sock
*skb_steal_sock(struct sk_buff
*skb
)
2120 if (unlikely(skb
->sk
)) {
2121 struct sock
*sk
= skb
->sk
;
2123 skb
->destructor
= NULL
;
2130 extern void sock_enable_timestamp(struct sock
*sk
, int flag
);
2131 extern int sock_get_timestamp(struct sock
*, struct timeval __user
*);
2132 extern int sock_get_timestampns(struct sock
*, struct timespec __user
*);
2135 * Enable debug/info messages
2137 extern int net_msg_warn
;
2138 #define NETDEBUG(fmt, args...) \
2139 do { if (net_msg_warn) printk(fmt,##args); } while (0)
2141 #define LIMIT_NETDEBUG(fmt, args...) \
2142 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
2144 extern __u32 sysctl_wmem_max
;
2145 extern __u32 sysctl_rmem_max
;
2147 extern void sk_init(void);
2149 extern int sysctl_optmem_max
;
2151 extern __u32 sysctl_wmem_default
;
2152 extern __u32 sysctl_rmem_default
;
2154 #endif /* _SOCK_H */