foundations of per-cgroup memory pressure controlling.
[linux-2.6/libata-dev.git] / include / net / sock.h
blobed0dbf034539b97a0c2e465b6131d0ac5ece53cc
1 /*
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
10 * Authors: Ross Biro
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>
15 * Fixes:
16 * Alan Cox : Volatiles in skbuff pointers. See
17 * skbuff comments. May be overdone,
18 * better to prove they can be removed
19 * than the reverse.
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.
40 #ifndef _SOCK_H
41 #define _SOCK_H
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 */
52 #include <linux/mm.h>
53 #include <linux/security.h>
54 #include <linux/slab.h>
55 #include <linux/uaccess.h>
56 #include <linux/memcontrol.h>
58 #include <linux/filter.h>
59 #include <linux/rculist_nulls.h>
60 #include <linux/poll.h>
62 #include <linux/atomic.h>
63 #include <net/dst.h>
64 #include <net/checksum.h>
67 * This structure really needs to be cleaned up.
68 * Most of it is for TCP, and not used by any of
69 * the other protocols.
72 /* Define this to get the SOCK_DBG debugging facility. */
73 #define SOCK_DEBUGGING
74 #ifdef SOCK_DEBUGGING
75 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
76 printk(KERN_DEBUG msg); } while (0)
77 #else
78 /* Validate arguments and do nothing */
79 static inline __printf(2, 3)
80 void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
83 #endif
85 /* This is the per-socket lock. The spinlock provides a synchronization
86 * between user contexts and software interrupt processing, whereas the
87 * mini-semaphore synchronizes multiple users amongst themselves.
89 typedef struct {
90 spinlock_t slock;
91 int owned;
92 wait_queue_head_t wq;
94 * We express the mutex-alike socket_lock semantics
95 * to the lock validator by explicitly managing
96 * the slock as a lock variant (in addition to
97 * the slock itself):
99 #ifdef CONFIG_DEBUG_LOCK_ALLOC
100 struct lockdep_map dep_map;
101 #endif
102 } socket_lock_t;
104 struct sock;
105 struct proto;
106 struct net;
109 * struct sock_common - minimal network layer representation of sockets
110 * @skc_daddr: Foreign IPv4 addr
111 * @skc_rcv_saddr: Bound local IPv4 addr
112 * @skc_hash: hash value used with various protocol lookup tables
113 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
114 * @skc_family: network address family
115 * @skc_state: Connection state
116 * @skc_reuse: %SO_REUSEADDR setting
117 * @skc_bound_dev_if: bound device index if != 0
118 * @skc_bind_node: bind hash linkage for various protocol lookup tables
119 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
120 * @skc_prot: protocol handlers inside a network family
121 * @skc_net: reference to the network namespace of this socket
122 * @skc_node: main hash linkage for various protocol lookup tables
123 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
124 * @skc_tx_queue_mapping: tx queue number for this connection
125 * @skc_refcnt: reference count
127 * This is the minimal network layer representation of sockets, the header
128 * for struct sock and struct inet_timewait_sock.
130 struct sock_common {
131 /* skc_daddr and skc_rcv_saddr must be grouped :
132 * cf INET_MATCH() and INET_TW_MATCH()
134 __be32 skc_daddr;
135 __be32 skc_rcv_saddr;
137 union {
138 unsigned int skc_hash;
139 __u16 skc_u16hashes[2];
141 unsigned short skc_family;
142 volatile unsigned char skc_state;
143 unsigned char skc_reuse;
144 int skc_bound_dev_if;
145 union {
146 struct hlist_node skc_bind_node;
147 struct hlist_nulls_node skc_portaddr_node;
149 struct proto *skc_prot;
150 #ifdef CONFIG_NET_NS
151 struct net *skc_net;
152 #endif
154 * fields between dontcopy_begin/dontcopy_end
155 * are not copied in sock_copy()
157 /* private: */
158 int skc_dontcopy_begin[0];
159 /* public: */
160 union {
161 struct hlist_node skc_node;
162 struct hlist_nulls_node skc_nulls_node;
164 int skc_tx_queue_mapping;
165 atomic_t skc_refcnt;
166 /* private: */
167 int skc_dontcopy_end[0];
168 /* public: */
172 * struct sock - network layer representation of sockets
173 * @__sk_common: shared layout with inet_timewait_sock
174 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
175 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
176 * @sk_lock: synchronizer
177 * @sk_rcvbuf: size of receive buffer in bytes
178 * @sk_wq: sock wait queue and async head
179 * @sk_dst_cache: destination cache
180 * @sk_dst_lock: destination cache lock
181 * @sk_policy: flow policy
182 * @sk_receive_queue: incoming packets
183 * @sk_wmem_alloc: transmit queue bytes committed
184 * @sk_write_queue: Packet sending queue
185 * @sk_async_wait_queue: DMA copied packets
186 * @sk_omem_alloc: "o" is "option" or "other"
187 * @sk_wmem_queued: persistent queue size
188 * @sk_forward_alloc: space allocated forward
189 * @sk_allocation: allocation mode
190 * @sk_sndbuf: size of send buffer in bytes
191 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
192 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
193 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
194 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
195 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
196 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
197 * @sk_gso_max_size: Maximum GSO segment size to build
198 * @sk_lingertime: %SO_LINGER l_linger setting
199 * @sk_backlog: always used with the per-socket spinlock held
200 * @sk_callback_lock: used with the callbacks in the end of this struct
201 * @sk_error_queue: rarely used
202 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
203 * IPV6_ADDRFORM for instance)
204 * @sk_err: last error
205 * @sk_err_soft: errors that don't cause failure but are the cause of a
206 * persistent failure not just 'timed out'
207 * @sk_drops: raw/udp drops counter
208 * @sk_ack_backlog: current listen backlog
209 * @sk_max_ack_backlog: listen backlog set in listen()
210 * @sk_priority: %SO_PRIORITY setting
211 * @sk_type: socket type (%SOCK_STREAM, etc)
212 * @sk_protocol: which protocol this socket belongs in this network family
213 * @sk_peer_pid: &struct pid for this socket's peer
214 * @sk_peer_cred: %SO_PEERCRED setting
215 * @sk_rcvlowat: %SO_RCVLOWAT setting
216 * @sk_rcvtimeo: %SO_RCVTIMEO setting
217 * @sk_sndtimeo: %SO_SNDTIMEO setting
218 * @sk_rxhash: flow hash received from netif layer
219 * @sk_filter: socket filtering instructions
220 * @sk_protinfo: private area, net family specific, when not using slab
221 * @sk_timer: sock cleanup timer
222 * @sk_stamp: time stamp of last packet received
223 * @sk_socket: Identd and reporting IO signals
224 * @sk_user_data: RPC layer private data
225 * @sk_sndmsg_page: cached page for sendmsg
226 * @sk_sndmsg_off: cached offset for sendmsg
227 * @sk_send_head: front of stuff to transmit
228 * @sk_security: used by security modules
229 * @sk_mark: generic packet mark
230 * @sk_classid: this socket's cgroup classid
231 * @sk_write_pending: a write to stream socket waits to start
232 * @sk_state_change: callback to indicate change in the state of the sock
233 * @sk_data_ready: callback to indicate there is data to be processed
234 * @sk_write_space: callback to indicate there is bf sending space available
235 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
236 * @sk_backlog_rcv: callback to process the backlog
237 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
239 struct sock {
241 * Now struct inet_timewait_sock also uses sock_common, so please just
242 * don't add nothing before this first member (__sk_common) --acme
244 struct sock_common __sk_common;
245 #define sk_node __sk_common.skc_node
246 #define sk_nulls_node __sk_common.skc_nulls_node
247 #define sk_refcnt __sk_common.skc_refcnt
248 #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
250 #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
251 #define sk_dontcopy_end __sk_common.skc_dontcopy_end
252 #define sk_hash __sk_common.skc_hash
253 #define sk_family __sk_common.skc_family
254 #define sk_state __sk_common.skc_state
255 #define sk_reuse __sk_common.skc_reuse
256 #define sk_bound_dev_if __sk_common.skc_bound_dev_if
257 #define sk_bind_node __sk_common.skc_bind_node
258 #define sk_prot __sk_common.skc_prot
259 #define sk_net __sk_common.skc_net
260 socket_lock_t sk_lock;
261 struct sk_buff_head sk_receive_queue;
263 * The backlog queue is special, it is always used with
264 * the per-socket spinlock held and requires low latency
265 * access. Therefore we special case it's implementation.
266 * Note : rmem_alloc is in this structure to fill a hole
267 * on 64bit arches, not because its logically part of
268 * backlog.
270 struct {
271 atomic_t rmem_alloc;
272 int len;
273 struct sk_buff *head;
274 struct sk_buff *tail;
275 } sk_backlog;
276 #define sk_rmem_alloc sk_backlog.rmem_alloc
277 int sk_forward_alloc;
278 #ifdef CONFIG_RPS
279 __u32 sk_rxhash;
280 #endif
281 atomic_t sk_drops;
282 int sk_rcvbuf;
284 struct sk_filter __rcu *sk_filter;
285 struct socket_wq __rcu *sk_wq;
287 #ifdef CONFIG_NET_DMA
288 struct sk_buff_head sk_async_wait_queue;
289 #endif
291 #ifdef CONFIG_XFRM
292 struct xfrm_policy *sk_policy[2];
293 #endif
294 unsigned long sk_flags;
295 struct dst_entry *sk_dst_cache;
296 spinlock_t sk_dst_lock;
297 atomic_t sk_wmem_alloc;
298 atomic_t sk_omem_alloc;
299 int sk_sndbuf;
300 struct sk_buff_head sk_write_queue;
301 kmemcheck_bitfield_begin(flags);
302 unsigned int sk_shutdown : 2,
303 sk_no_check : 2,
304 sk_userlocks : 4,
305 sk_protocol : 8,
306 sk_type : 16;
307 kmemcheck_bitfield_end(flags);
308 int sk_wmem_queued;
309 gfp_t sk_allocation;
310 netdev_features_t sk_route_caps;
311 netdev_features_t sk_route_nocaps;
312 int sk_gso_type;
313 unsigned int sk_gso_max_size;
314 int sk_rcvlowat;
315 unsigned long sk_lingertime;
316 struct sk_buff_head sk_error_queue;
317 struct proto *sk_prot_creator;
318 rwlock_t sk_callback_lock;
319 int sk_err,
320 sk_err_soft;
321 unsigned short sk_ack_backlog;
322 unsigned short sk_max_ack_backlog;
323 __u32 sk_priority;
324 #ifdef CONFIG_CGROUPS
325 __u32 sk_cgrp_prioidx;
326 #endif
327 struct pid *sk_peer_pid;
328 const struct cred *sk_peer_cred;
329 long sk_rcvtimeo;
330 long sk_sndtimeo;
331 void *sk_protinfo;
332 struct timer_list sk_timer;
333 ktime_t sk_stamp;
334 struct socket *sk_socket;
335 void *sk_user_data;
336 struct page *sk_sndmsg_page;
337 struct sk_buff *sk_send_head;
338 __u32 sk_sndmsg_off;
339 int sk_write_pending;
340 #ifdef CONFIG_SECURITY
341 void *sk_security;
342 #endif
343 __u32 sk_mark;
344 u32 sk_classid;
345 void (*sk_state_change)(struct sock *sk);
346 void (*sk_data_ready)(struct sock *sk, int bytes);
347 void (*sk_write_space)(struct sock *sk);
348 void (*sk_error_report)(struct sock *sk);
349 int (*sk_backlog_rcv)(struct sock *sk,
350 struct sk_buff *skb);
351 void (*sk_destruct)(struct sock *sk);
355 * Hashed lists helper routines
357 static inline struct sock *sk_entry(const struct hlist_node *node)
359 return hlist_entry(node, struct sock, sk_node);
362 static inline struct sock *__sk_head(const struct hlist_head *head)
364 return hlist_entry(head->first, struct sock, sk_node);
367 static inline struct sock *sk_head(const struct hlist_head *head)
369 return hlist_empty(head) ? NULL : __sk_head(head);
372 static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
374 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
377 static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
379 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
382 static inline struct sock *sk_next(const struct sock *sk)
384 return sk->sk_node.next ?
385 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
388 static inline struct sock *sk_nulls_next(const struct sock *sk)
390 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
391 hlist_nulls_entry(sk->sk_nulls_node.next,
392 struct sock, sk_nulls_node) :
393 NULL;
396 static inline int sk_unhashed(const struct sock *sk)
398 return hlist_unhashed(&sk->sk_node);
401 static inline int sk_hashed(const struct sock *sk)
403 return !sk_unhashed(sk);
406 static __inline__ void sk_node_init(struct hlist_node *node)
408 node->pprev = NULL;
411 static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
413 node->pprev = NULL;
416 static __inline__ void __sk_del_node(struct sock *sk)
418 __hlist_del(&sk->sk_node);
421 /* NB: equivalent to hlist_del_init_rcu */
422 static __inline__ int __sk_del_node_init(struct sock *sk)
424 if (sk_hashed(sk)) {
425 __sk_del_node(sk);
426 sk_node_init(&sk->sk_node);
427 return 1;
429 return 0;
432 /* Grab socket reference count. This operation is valid only
433 when sk is ALREADY grabbed f.e. it is found in hash table
434 or a list and the lookup is made under lock preventing hash table
435 modifications.
438 static inline void sock_hold(struct sock *sk)
440 atomic_inc(&sk->sk_refcnt);
443 /* Ungrab socket in the context, which assumes that socket refcnt
444 cannot hit zero, f.e. it is true in context of any socketcall.
446 static inline void __sock_put(struct sock *sk)
448 atomic_dec(&sk->sk_refcnt);
451 static __inline__ int sk_del_node_init(struct sock *sk)
453 int rc = __sk_del_node_init(sk);
455 if (rc) {
456 /* paranoid for a while -acme */
457 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
458 __sock_put(sk);
460 return rc;
462 #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
464 static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
466 if (sk_hashed(sk)) {
467 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
468 return 1;
470 return 0;
473 static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
475 int rc = __sk_nulls_del_node_init_rcu(sk);
477 if (rc) {
478 /* paranoid for a while -acme */
479 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
480 __sock_put(sk);
482 return rc;
485 static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
487 hlist_add_head(&sk->sk_node, list);
490 static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
492 sock_hold(sk);
493 __sk_add_node(sk, list);
496 static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
498 sock_hold(sk);
499 hlist_add_head_rcu(&sk->sk_node, list);
502 static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
504 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
507 static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
509 sock_hold(sk);
510 __sk_nulls_add_node_rcu(sk, list);
513 static __inline__ void __sk_del_bind_node(struct sock *sk)
515 __hlist_del(&sk->sk_bind_node);
518 static __inline__ void sk_add_bind_node(struct sock *sk,
519 struct hlist_head *list)
521 hlist_add_head(&sk->sk_bind_node, list);
524 #define sk_for_each(__sk, node, list) \
525 hlist_for_each_entry(__sk, node, list, sk_node)
526 #define sk_for_each_rcu(__sk, node, list) \
527 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
528 #define sk_nulls_for_each(__sk, node, list) \
529 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
530 #define sk_nulls_for_each_rcu(__sk, node, list) \
531 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
532 #define sk_for_each_from(__sk, node) \
533 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
534 hlist_for_each_entry_from(__sk, node, sk_node)
535 #define sk_nulls_for_each_from(__sk, node) \
536 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
537 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
538 #define sk_for_each_safe(__sk, node, tmp, list) \
539 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
540 #define sk_for_each_bound(__sk, node, list) \
541 hlist_for_each_entry(__sk, node, list, sk_bind_node)
543 /* Sock flags */
544 enum sock_flags {
545 SOCK_DEAD,
546 SOCK_DONE,
547 SOCK_URGINLINE,
548 SOCK_KEEPOPEN,
549 SOCK_LINGER,
550 SOCK_DESTROY,
551 SOCK_BROADCAST,
552 SOCK_TIMESTAMP,
553 SOCK_ZAPPED,
554 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
555 SOCK_DBG, /* %SO_DEBUG setting */
556 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
557 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
558 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
559 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
560 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
561 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
562 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
563 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
564 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
565 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
566 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
567 SOCK_FASYNC, /* fasync() active */
568 SOCK_RXQ_OVFL,
569 SOCK_ZEROCOPY, /* buffers from userspace */
570 SOCK_WIFI_STATUS, /* push wifi status to userspace */
573 static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
575 nsk->sk_flags = osk->sk_flags;
578 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
580 __set_bit(flag, &sk->sk_flags);
583 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
585 __clear_bit(flag, &sk->sk_flags);
588 static inline int sock_flag(struct sock *sk, enum sock_flags flag)
590 return test_bit(flag, &sk->sk_flags);
593 static inline void sk_acceptq_removed(struct sock *sk)
595 sk->sk_ack_backlog--;
598 static inline void sk_acceptq_added(struct sock *sk)
600 sk->sk_ack_backlog++;
603 static inline int sk_acceptq_is_full(struct sock *sk)
605 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
609 * Compute minimal free write space needed to queue new packets.
611 static inline int sk_stream_min_wspace(struct sock *sk)
613 return sk->sk_wmem_queued >> 1;
616 static inline int sk_stream_wspace(struct sock *sk)
618 return sk->sk_sndbuf - sk->sk_wmem_queued;
621 extern void sk_stream_write_space(struct sock *sk);
623 static inline int sk_stream_memory_free(struct sock *sk)
625 return sk->sk_wmem_queued < sk->sk_sndbuf;
628 /* OOB backlog add */
629 static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
631 /* dont let skb dst not refcounted, we are going to leave rcu lock */
632 skb_dst_force(skb);
634 if (!sk->sk_backlog.tail)
635 sk->sk_backlog.head = skb;
636 else
637 sk->sk_backlog.tail->next = skb;
639 sk->sk_backlog.tail = skb;
640 skb->next = NULL;
644 * Take into account size of receive queue and backlog queue
646 static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
648 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
650 return qsize + skb->truesize > sk->sk_rcvbuf;
653 /* The per-socket spinlock must be held here. */
654 static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
656 if (sk_rcvqueues_full(sk, skb))
657 return -ENOBUFS;
659 __sk_add_backlog(sk, skb);
660 sk->sk_backlog.len += skb->truesize;
661 return 0;
664 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
666 return sk->sk_backlog_rcv(sk, skb);
669 static inline void sock_rps_record_flow(const struct sock *sk)
671 #ifdef CONFIG_RPS
672 struct rps_sock_flow_table *sock_flow_table;
674 rcu_read_lock();
675 sock_flow_table = rcu_dereference(rps_sock_flow_table);
676 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
677 rcu_read_unlock();
678 #endif
681 static inline void sock_rps_reset_flow(const struct sock *sk)
683 #ifdef CONFIG_RPS
684 struct rps_sock_flow_table *sock_flow_table;
686 rcu_read_lock();
687 sock_flow_table = rcu_dereference(rps_sock_flow_table);
688 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
689 rcu_read_unlock();
690 #endif
693 static inline void sock_rps_save_rxhash(struct sock *sk,
694 const struct sk_buff *skb)
696 #ifdef CONFIG_RPS
697 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
698 sock_rps_reset_flow(sk);
699 sk->sk_rxhash = skb->rxhash;
701 #endif
704 static inline void sock_rps_reset_rxhash(struct sock *sk)
706 #ifdef CONFIG_RPS
707 sock_rps_reset_flow(sk);
708 sk->sk_rxhash = 0;
709 #endif
712 #define sk_wait_event(__sk, __timeo, __condition) \
713 ({ int __rc; \
714 release_sock(__sk); \
715 __rc = __condition; \
716 if (!__rc) { \
717 *(__timeo) = schedule_timeout(*(__timeo)); \
719 lock_sock(__sk); \
720 __rc = __condition; \
721 __rc; \
724 extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
725 extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
726 extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
727 extern int sk_stream_error(struct sock *sk, int flags, int err);
728 extern void sk_stream_kill_queues(struct sock *sk);
730 extern int sk_wait_data(struct sock *sk, long *timeo);
732 struct request_sock_ops;
733 struct timewait_sock_ops;
734 struct inet_hashinfo;
735 struct raw_hashinfo;
736 struct module;
738 /* Networking protocol blocks we attach to sockets.
739 * socket layer -> transport layer interface
740 * transport -> network interface is defined by struct inet_proto
742 struct proto {
743 void (*close)(struct sock *sk,
744 long timeout);
745 int (*connect)(struct sock *sk,
746 struct sockaddr *uaddr,
747 int addr_len);
748 int (*disconnect)(struct sock *sk, int flags);
750 struct sock * (*accept) (struct sock *sk, int flags, int *err);
752 int (*ioctl)(struct sock *sk, int cmd,
753 unsigned long arg);
754 int (*init)(struct sock *sk);
755 void (*destroy)(struct sock *sk);
756 void (*shutdown)(struct sock *sk, int how);
757 int (*setsockopt)(struct sock *sk, int level,
758 int optname, char __user *optval,
759 unsigned int optlen);
760 int (*getsockopt)(struct sock *sk, int level,
761 int optname, char __user *optval,
762 int __user *option);
763 #ifdef CONFIG_COMPAT
764 int (*compat_setsockopt)(struct sock *sk,
765 int level,
766 int optname, char __user *optval,
767 unsigned int optlen);
768 int (*compat_getsockopt)(struct sock *sk,
769 int level,
770 int optname, char __user *optval,
771 int __user *option);
772 int (*compat_ioctl)(struct sock *sk,
773 unsigned int cmd, unsigned long arg);
774 #endif
775 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
776 struct msghdr *msg, size_t len);
777 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
778 struct msghdr *msg,
779 size_t len, int noblock, int flags,
780 int *addr_len);
781 int (*sendpage)(struct sock *sk, struct page *page,
782 int offset, size_t size, int flags);
783 int (*bind)(struct sock *sk,
784 struct sockaddr *uaddr, int addr_len);
786 int (*backlog_rcv) (struct sock *sk,
787 struct sk_buff *skb);
789 /* Keeping track of sk's, looking them up, and port selection methods. */
790 void (*hash)(struct sock *sk);
791 void (*unhash)(struct sock *sk);
792 void (*rehash)(struct sock *sk);
793 int (*get_port)(struct sock *sk, unsigned short snum);
794 void (*clear_sk)(struct sock *sk, int size);
796 /* Keeping track of sockets in use */
797 #ifdef CONFIG_PROC_FS
798 unsigned int inuse_idx;
799 #endif
801 /* Memory pressure */
802 void (*enter_memory_pressure)(struct sock *sk);
803 atomic_long_t *memory_allocated; /* Current allocated memory. */
804 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
806 * Pressure flag: try to collapse.
807 * Technical note: it is used by multiple contexts non atomically.
808 * All the __sk_mem_schedule() is of this nature: accounting
809 * is strict, actions are advisory and have some latency.
811 int *memory_pressure;
812 long *sysctl_mem;
813 int *sysctl_wmem;
814 int *sysctl_rmem;
815 int max_header;
816 bool no_autobind;
818 struct kmem_cache *slab;
819 unsigned int obj_size;
820 int slab_flags;
822 struct percpu_counter *orphan_count;
824 struct request_sock_ops *rsk_prot;
825 struct timewait_sock_ops *twsk_prot;
827 union {
828 struct inet_hashinfo *hashinfo;
829 struct udp_table *udp_table;
830 struct raw_hashinfo *raw_hash;
831 } h;
833 struct module *owner;
835 char name[32];
837 struct list_head node;
838 #ifdef SOCK_REFCNT_DEBUG
839 atomic_t socks;
840 #endif
843 extern int proto_register(struct proto *prot, int alloc_slab);
844 extern void proto_unregister(struct proto *prot);
846 #ifdef SOCK_REFCNT_DEBUG
847 static inline void sk_refcnt_debug_inc(struct sock *sk)
849 atomic_inc(&sk->sk_prot->socks);
852 static inline void sk_refcnt_debug_dec(struct sock *sk)
854 atomic_dec(&sk->sk_prot->socks);
855 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
856 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
859 static inline void sk_refcnt_debug_release(const struct sock *sk)
861 if (atomic_read(&sk->sk_refcnt) != 1)
862 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
863 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
865 #else /* SOCK_REFCNT_DEBUG */
866 #define sk_refcnt_debug_inc(sk) do { } while (0)
867 #define sk_refcnt_debug_dec(sk) do { } while (0)
868 #define sk_refcnt_debug_release(sk) do { } while (0)
869 #endif /* SOCK_REFCNT_DEBUG */
871 static inline bool sk_has_memory_pressure(const struct sock *sk)
873 return sk->sk_prot->memory_pressure != NULL;
876 static inline bool sk_under_memory_pressure(const struct sock *sk)
878 if (!sk->sk_prot->memory_pressure)
879 return false;
880 return !!*sk->sk_prot->memory_pressure;
883 static inline void sk_leave_memory_pressure(struct sock *sk)
885 int *memory_pressure = sk->sk_prot->memory_pressure;
887 if (memory_pressure && *memory_pressure)
888 *memory_pressure = 0;
891 static inline void sk_enter_memory_pressure(struct sock *sk)
893 if (sk->sk_prot->enter_memory_pressure)
894 sk->sk_prot->enter_memory_pressure(sk);
897 static inline long sk_prot_mem_limits(const struct sock *sk, int index)
899 long *prot = sk->sk_prot->sysctl_mem;
900 return prot[index];
903 static inline long
904 sk_memory_allocated(const struct sock *sk)
906 struct proto *prot = sk->sk_prot;
907 return atomic_long_read(prot->memory_allocated);
910 static inline long
911 sk_memory_allocated_add(struct sock *sk, int amt)
913 struct proto *prot = sk->sk_prot;
914 return atomic_long_add_return(amt, prot->memory_allocated);
917 static inline void
918 sk_memory_allocated_sub(struct sock *sk, int amt)
920 struct proto *prot = sk->sk_prot;
921 atomic_long_sub(amt, prot->memory_allocated);
924 static inline void sk_sockets_allocated_dec(struct sock *sk)
926 struct proto *prot = sk->sk_prot;
927 percpu_counter_dec(prot->sockets_allocated);
930 static inline void sk_sockets_allocated_inc(struct sock *sk)
932 struct proto *prot = sk->sk_prot;
933 percpu_counter_inc(prot->sockets_allocated);
936 static inline int
937 sk_sockets_allocated_read_positive(struct sock *sk)
939 struct proto *prot = sk->sk_prot;
941 return percpu_counter_sum_positive(prot->sockets_allocated);
944 static inline int
945 proto_sockets_allocated_sum_positive(struct proto *prot)
947 return percpu_counter_sum_positive(prot->sockets_allocated);
950 static inline long
951 proto_memory_allocated(struct proto *prot)
953 return atomic_long_read(prot->memory_allocated);
956 static inline bool
957 proto_memory_pressure(struct proto *prot)
959 if (!prot->memory_pressure)
960 return false;
961 return !!*prot->memory_pressure;
965 #ifdef CONFIG_PROC_FS
966 /* Called with local bh disabled */
967 extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
968 extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
969 #else
970 static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
971 int inc)
974 #endif
977 /* With per-bucket locks this operation is not-atomic, so that
978 * this version is not worse.
980 static inline void __sk_prot_rehash(struct sock *sk)
982 sk->sk_prot->unhash(sk);
983 sk->sk_prot->hash(sk);
986 void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
988 /* About 10 seconds */
989 #define SOCK_DESTROY_TIME (10*HZ)
991 /* Sockets 0-1023 can't be bound to unless you are superuser */
992 #define PROT_SOCK 1024
994 #define SHUTDOWN_MASK 3
995 #define RCV_SHUTDOWN 1
996 #define SEND_SHUTDOWN 2
998 #define SOCK_SNDBUF_LOCK 1
999 #define SOCK_RCVBUF_LOCK 2
1000 #define SOCK_BINDADDR_LOCK 4
1001 #define SOCK_BINDPORT_LOCK 8
1003 /* sock_iocb: used to kick off async processing of socket ios */
1004 struct sock_iocb {
1005 struct list_head list;
1007 int flags;
1008 int size;
1009 struct socket *sock;
1010 struct sock *sk;
1011 struct scm_cookie *scm;
1012 struct msghdr *msg, async_msg;
1013 struct kiocb *kiocb;
1016 static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1018 return (struct sock_iocb *)iocb->private;
1021 static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1023 return si->kiocb;
1026 struct socket_alloc {
1027 struct socket socket;
1028 struct inode vfs_inode;
1031 static inline struct socket *SOCKET_I(struct inode *inode)
1033 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1036 static inline struct inode *SOCK_INODE(struct socket *socket)
1038 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1042 * Functions for memory accounting
1044 extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1045 extern void __sk_mem_reclaim(struct sock *sk);
1047 #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1048 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1049 #define SK_MEM_SEND 0
1050 #define SK_MEM_RECV 1
1052 static inline int sk_mem_pages(int amt)
1054 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1057 static inline int sk_has_account(struct sock *sk)
1059 /* return true if protocol supports memory accounting */
1060 return !!sk->sk_prot->memory_allocated;
1063 static inline int sk_wmem_schedule(struct sock *sk, int size)
1065 if (!sk_has_account(sk))
1066 return 1;
1067 return size <= sk->sk_forward_alloc ||
1068 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1071 static inline int sk_rmem_schedule(struct sock *sk, int size)
1073 if (!sk_has_account(sk))
1074 return 1;
1075 return size <= sk->sk_forward_alloc ||
1076 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1079 static inline void sk_mem_reclaim(struct sock *sk)
1081 if (!sk_has_account(sk))
1082 return;
1083 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1084 __sk_mem_reclaim(sk);
1087 static inline void sk_mem_reclaim_partial(struct sock *sk)
1089 if (!sk_has_account(sk))
1090 return;
1091 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1092 __sk_mem_reclaim(sk);
1095 static inline void sk_mem_charge(struct sock *sk, int size)
1097 if (!sk_has_account(sk))
1098 return;
1099 sk->sk_forward_alloc -= size;
1102 static inline void sk_mem_uncharge(struct sock *sk, int size)
1104 if (!sk_has_account(sk))
1105 return;
1106 sk->sk_forward_alloc += size;
1109 static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1111 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1112 sk->sk_wmem_queued -= skb->truesize;
1113 sk_mem_uncharge(sk, skb->truesize);
1114 __kfree_skb(skb);
1117 /* Used by processes to "lock" a socket state, so that
1118 * interrupts and bottom half handlers won't change it
1119 * from under us. It essentially blocks any incoming
1120 * packets, so that we won't get any new data or any
1121 * packets that change the state of the socket.
1123 * While locked, BH processing will add new packets to
1124 * the backlog queue. This queue is processed by the
1125 * owner of the socket lock right before it is released.
1127 * Since ~2.3.5 it is also exclusive sleep lock serializing
1128 * accesses from user process context.
1130 #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
1133 * Macro so as to not evaluate some arguments when
1134 * lockdep is not enabled.
1136 * Mark both the sk_lock and the sk_lock.slock as a
1137 * per-address-family lock class.
1139 #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1140 do { \
1141 sk->sk_lock.owned = 0; \
1142 init_waitqueue_head(&sk->sk_lock.wq); \
1143 spin_lock_init(&(sk)->sk_lock.slock); \
1144 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1145 sizeof((sk)->sk_lock)); \
1146 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1147 (skey), (sname)); \
1148 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1149 } while (0)
1151 extern void lock_sock_nested(struct sock *sk, int subclass);
1153 static inline void lock_sock(struct sock *sk)
1155 lock_sock_nested(sk, 0);
1158 extern void release_sock(struct sock *sk);
1160 /* BH context may only use the following locking interface. */
1161 #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
1162 #define bh_lock_sock_nested(__sk) \
1163 spin_lock_nested(&((__sk)->sk_lock.slock), \
1164 SINGLE_DEPTH_NESTING)
1165 #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1167 extern bool lock_sock_fast(struct sock *sk);
1169 * unlock_sock_fast - complement of lock_sock_fast
1170 * @sk: socket
1171 * @slow: slow mode
1173 * fast unlock socket for user context.
1174 * If slow mode is on, we call regular release_sock()
1176 static inline void unlock_sock_fast(struct sock *sk, bool slow)
1178 if (slow)
1179 release_sock(sk);
1180 else
1181 spin_unlock_bh(&sk->sk_lock.slock);
1185 extern struct sock *sk_alloc(struct net *net, int family,
1186 gfp_t priority,
1187 struct proto *prot);
1188 extern void sk_free(struct sock *sk);
1189 extern void sk_release_kernel(struct sock *sk);
1190 extern struct sock *sk_clone_lock(const struct sock *sk,
1191 const gfp_t priority);
1193 extern struct sk_buff *sock_wmalloc(struct sock *sk,
1194 unsigned long size, int force,
1195 gfp_t priority);
1196 extern struct sk_buff *sock_rmalloc(struct sock *sk,
1197 unsigned long size, int force,
1198 gfp_t priority);
1199 extern void sock_wfree(struct sk_buff *skb);
1200 extern void sock_rfree(struct sk_buff *skb);
1202 extern int sock_setsockopt(struct socket *sock, int level,
1203 int op, char __user *optval,
1204 unsigned int optlen);
1206 extern int sock_getsockopt(struct socket *sock, int level,
1207 int op, char __user *optval,
1208 int __user *optlen);
1209 extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1210 unsigned long size,
1211 int noblock,
1212 int *errcode);
1213 extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1214 unsigned long header_len,
1215 unsigned long data_len,
1216 int noblock,
1217 int *errcode);
1218 extern void *sock_kmalloc(struct sock *sk, int size,
1219 gfp_t priority);
1220 extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1221 extern void sk_send_sigurg(struct sock *sk);
1223 #ifdef CONFIG_CGROUPS
1224 extern void sock_update_classid(struct sock *sk);
1225 #else
1226 static inline void sock_update_classid(struct sock *sk)
1229 #endif
1232 * Functions to fill in entries in struct proto_ops when a protocol
1233 * does not implement a particular function.
1235 extern int sock_no_bind(struct socket *,
1236 struct sockaddr *, int);
1237 extern int sock_no_connect(struct socket *,
1238 struct sockaddr *, int, int);
1239 extern int sock_no_socketpair(struct socket *,
1240 struct socket *);
1241 extern int sock_no_accept(struct socket *,
1242 struct socket *, int);
1243 extern int sock_no_getname(struct socket *,
1244 struct sockaddr *, int *, int);
1245 extern unsigned int sock_no_poll(struct file *, struct socket *,
1246 struct poll_table_struct *);
1247 extern int sock_no_ioctl(struct socket *, unsigned int,
1248 unsigned long);
1249 extern int sock_no_listen(struct socket *, int);
1250 extern int sock_no_shutdown(struct socket *, int);
1251 extern int sock_no_getsockopt(struct socket *, int , int,
1252 char __user *, int __user *);
1253 extern int sock_no_setsockopt(struct socket *, int, int,
1254 char __user *, unsigned int);
1255 extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1256 struct msghdr *, size_t);
1257 extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1258 struct msghdr *, size_t, int);
1259 extern int sock_no_mmap(struct file *file,
1260 struct socket *sock,
1261 struct vm_area_struct *vma);
1262 extern ssize_t sock_no_sendpage(struct socket *sock,
1263 struct page *page,
1264 int offset, size_t size,
1265 int flags);
1268 * Functions to fill in entries in struct proto_ops when a protocol
1269 * uses the inet style.
1271 extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1272 char __user *optval, int __user *optlen);
1273 extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1274 struct msghdr *msg, size_t size, int flags);
1275 extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
1276 char __user *optval, unsigned int optlen);
1277 extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1278 int optname, char __user *optval, int __user *optlen);
1279 extern int compat_sock_common_setsockopt(struct socket *sock, int level,
1280 int optname, char __user *optval, unsigned int optlen);
1282 extern void sk_common_release(struct sock *sk);
1285 * Default socket callbacks and setup code
1288 /* Initialise core socket variables */
1289 extern void sock_init_data(struct socket *sock, struct sock *sk);
1291 extern void sk_filter_release_rcu(struct rcu_head *rcu);
1294 * sk_filter_release - release a socket filter
1295 * @fp: filter to remove
1297 * Remove a filter from a socket and release its resources.
1300 static inline void sk_filter_release(struct sk_filter *fp)
1302 if (atomic_dec_and_test(&fp->refcnt))
1303 call_rcu(&fp->rcu, sk_filter_release_rcu);
1306 static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
1308 unsigned int size = sk_filter_len(fp);
1310 atomic_sub(size, &sk->sk_omem_alloc);
1311 sk_filter_release(fp);
1314 static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1316 atomic_inc(&fp->refcnt);
1317 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1321 * Socket reference counting postulates.
1323 * * Each user of socket SHOULD hold a reference count.
1324 * * Each access point to socket (an hash table bucket, reference from a list,
1325 * running timer, skb in flight MUST hold a reference count.
1326 * * When reference count hits 0, it means it will never increase back.
1327 * * When reference count hits 0, it means that no references from
1328 * outside exist to this socket and current process on current CPU
1329 * is last user and may/should destroy this socket.
1330 * * sk_free is called from any context: process, BH, IRQ. When
1331 * it is called, socket has no references from outside -> sk_free
1332 * may release descendant resources allocated by the socket, but
1333 * to the time when it is called, socket is NOT referenced by any
1334 * hash tables, lists etc.
1335 * * Packets, delivered from outside (from network or from another process)
1336 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1337 * when they sit in queue. Otherwise, packets will leak to hole, when
1338 * socket is looked up by one cpu and unhasing is made by another CPU.
1339 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1340 * (leak to backlog). Packet socket does all the processing inside
1341 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1342 * use separate SMP lock, so that they are prone too.
1345 /* Ungrab socket and destroy it, if it was the last reference. */
1346 static inline void sock_put(struct sock *sk)
1348 if (atomic_dec_and_test(&sk->sk_refcnt))
1349 sk_free(sk);
1352 extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1353 const int nested);
1355 static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1357 sk->sk_tx_queue_mapping = tx_queue;
1360 static inline void sk_tx_queue_clear(struct sock *sk)
1362 sk->sk_tx_queue_mapping = -1;
1365 static inline int sk_tx_queue_get(const struct sock *sk)
1367 return sk ? sk->sk_tx_queue_mapping : -1;
1370 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1372 sk_tx_queue_clear(sk);
1373 sk->sk_socket = sock;
1376 static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1378 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1379 return &rcu_dereference_raw(sk->sk_wq)->wait;
1381 /* Detach socket from process context.
1382 * Announce socket dead, detach it from wait queue and inode.
1383 * Note that parent inode held reference count on this struct sock,
1384 * we do not release it in this function, because protocol
1385 * probably wants some additional cleanups or even continuing
1386 * to work with this socket (TCP).
1388 static inline void sock_orphan(struct sock *sk)
1390 write_lock_bh(&sk->sk_callback_lock);
1391 sock_set_flag(sk, SOCK_DEAD);
1392 sk_set_socket(sk, NULL);
1393 sk->sk_wq = NULL;
1394 write_unlock_bh(&sk->sk_callback_lock);
1397 static inline void sock_graft(struct sock *sk, struct socket *parent)
1399 write_lock_bh(&sk->sk_callback_lock);
1400 sk->sk_wq = parent->wq;
1401 parent->sk = sk;
1402 sk_set_socket(sk, parent);
1403 security_sock_graft(sk, parent);
1404 write_unlock_bh(&sk->sk_callback_lock);
1407 extern int sock_i_uid(struct sock *sk);
1408 extern unsigned long sock_i_ino(struct sock *sk);
1410 static inline struct dst_entry *
1411 __sk_dst_get(struct sock *sk)
1413 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
1414 lockdep_is_held(&sk->sk_lock.slock));
1417 static inline struct dst_entry *
1418 sk_dst_get(struct sock *sk)
1420 struct dst_entry *dst;
1422 rcu_read_lock();
1423 dst = rcu_dereference(sk->sk_dst_cache);
1424 if (dst)
1425 dst_hold(dst);
1426 rcu_read_unlock();
1427 return dst;
1430 extern void sk_reset_txq(struct sock *sk);
1432 static inline void dst_negative_advice(struct sock *sk)
1434 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1436 if (dst && dst->ops->negative_advice) {
1437 ndst = dst->ops->negative_advice(dst);
1439 if (ndst != dst) {
1440 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1441 sk_reset_txq(sk);
1446 static inline void
1447 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
1449 struct dst_entry *old_dst;
1451 sk_tx_queue_clear(sk);
1453 * This can be called while sk is owned by the caller only,
1454 * with no state that can be checked in a rcu_dereference_check() cond
1456 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
1457 rcu_assign_pointer(sk->sk_dst_cache, dst);
1458 dst_release(old_dst);
1461 static inline void
1462 sk_dst_set(struct sock *sk, struct dst_entry *dst)
1464 spin_lock(&sk->sk_dst_lock);
1465 __sk_dst_set(sk, dst);
1466 spin_unlock(&sk->sk_dst_lock);
1469 static inline void
1470 __sk_dst_reset(struct sock *sk)
1472 __sk_dst_set(sk, NULL);
1475 static inline void
1476 sk_dst_reset(struct sock *sk)
1478 spin_lock(&sk->sk_dst_lock);
1479 __sk_dst_reset(sk);
1480 spin_unlock(&sk->sk_dst_lock);
1483 extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1485 extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1487 static inline int sk_can_gso(const struct sock *sk)
1489 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1492 extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1494 static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
1496 sk->sk_route_nocaps |= flags;
1497 sk->sk_route_caps &= ~flags;
1500 static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1501 char __user *from, char *to,
1502 int copy, int offset)
1504 if (skb->ip_summed == CHECKSUM_NONE) {
1505 int err = 0;
1506 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1507 if (err)
1508 return err;
1509 skb->csum = csum_block_add(skb->csum, csum, offset);
1510 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1511 if (!access_ok(VERIFY_READ, from, copy) ||
1512 __copy_from_user_nocache(to, from, copy))
1513 return -EFAULT;
1514 } else if (copy_from_user(to, from, copy))
1515 return -EFAULT;
1517 return 0;
1520 static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1521 char __user *from, int copy)
1523 int err, offset = skb->len;
1525 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1526 copy, offset);
1527 if (err)
1528 __skb_trim(skb, offset);
1530 return err;
1533 static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1534 struct sk_buff *skb,
1535 struct page *page,
1536 int off, int copy)
1538 int err;
1540 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1541 copy, skb->len);
1542 if (err)
1543 return err;
1545 skb->len += copy;
1546 skb->data_len += copy;
1547 skb->truesize += copy;
1548 sk->sk_wmem_queued += copy;
1549 sk_mem_charge(sk, copy);
1550 return 0;
1553 static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1554 struct sk_buff *skb, struct page *page,
1555 int off, int copy)
1557 if (skb->ip_summed == CHECKSUM_NONE) {
1558 int err = 0;
1559 __wsum csum = csum_and_copy_from_user(from,
1560 page_address(page) + off,
1561 copy, 0, &err);
1562 if (err)
1563 return err;
1564 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1565 } else if (copy_from_user(page_address(page) + off, from, copy))
1566 return -EFAULT;
1568 skb->len += copy;
1569 skb->data_len += copy;
1570 skb->truesize += copy;
1571 sk->sk_wmem_queued += copy;
1572 sk_mem_charge(sk, copy);
1573 return 0;
1577 * sk_wmem_alloc_get - returns write allocations
1578 * @sk: socket
1580 * Returns sk_wmem_alloc minus initial offset of one
1582 static inline int sk_wmem_alloc_get(const struct sock *sk)
1584 return atomic_read(&sk->sk_wmem_alloc) - 1;
1588 * sk_rmem_alloc_get - returns read allocations
1589 * @sk: socket
1591 * Returns sk_rmem_alloc
1593 static inline int sk_rmem_alloc_get(const struct sock *sk)
1595 return atomic_read(&sk->sk_rmem_alloc);
1599 * sk_has_allocations - check if allocations are outstanding
1600 * @sk: socket
1602 * Returns true if socket has write or read allocations
1604 static inline int sk_has_allocations(const struct sock *sk)
1606 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1610 * wq_has_sleeper - check if there are any waiting processes
1611 * @wq: struct socket_wq
1613 * Returns true if socket_wq has waiting processes
1615 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
1616 * barrier call. They were added due to the race found within the tcp code.
1618 * Consider following tcp code paths:
1620 * CPU1 CPU2
1622 * sys_select receive packet
1623 * ... ...
1624 * __add_wait_queue update tp->rcv_nxt
1625 * ... ...
1626 * tp->rcv_nxt check sock_def_readable
1627 * ... {
1628 * schedule rcu_read_lock();
1629 * wq = rcu_dereference(sk->sk_wq);
1630 * if (wq && waitqueue_active(&wq->wait))
1631 * wake_up_interruptible(&wq->wait)
1632 * ...
1635 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1636 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1637 * could then endup calling schedule and sleep forever if there are no more
1638 * data on the socket.
1641 static inline bool wq_has_sleeper(struct socket_wq *wq)
1645 * We need to be sure we are in sync with the
1646 * add_wait_queue modifications to the wait queue.
1648 * This memory barrier is paired in the sock_poll_wait.
1650 smp_mb();
1651 return wq && waitqueue_active(&wq->wait);
1655 * sock_poll_wait - place memory barrier behind the poll_wait call.
1656 * @filp: file
1657 * @wait_address: socket wait queue
1658 * @p: poll_table
1660 * See the comments in the wq_has_sleeper function.
1662 static inline void sock_poll_wait(struct file *filp,
1663 wait_queue_head_t *wait_address, poll_table *p)
1665 if (p && wait_address) {
1666 poll_wait(filp, wait_address, p);
1668 * We need to be sure we are in sync with the
1669 * socket flags modification.
1671 * This memory barrier is paired in the wq_has_sleeper.
1673 smp_mb();
1678 * Queue a received datagram if it will fit. Stream and sequenced
1679 * protocols can't normally use this as they need to fit buffers in
1680 * and play with them.
1682 * Inlined as it's very short and called for pretty much every
1683 * packet ever received.
1686 static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1688 skb_orphan(skb);
1689 skb->sk = sk;
1690 skb->destructor = sock_wfree;
1692 * We used to take a refcount on sk, but following operation
1693 * is enough to guarantee sk_free() wont free this sock until
1694 * all in-flight packets are completed
1696 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1699 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1701 skb_orphan(skb);
1702 skb->sk = sk;
1703 skb->destructor = sock_rfree;
1704 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1705 sk_mem_charge(sk, skb->truesize);
1708 extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1709 unsigned long expires);
1711 extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1713 extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
1715 extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
1718 * Recover an error report and clear atomically
1721 static inline int sock_error(struct sock *sk)
1723 int err;
1724 if (likely(!sk->sk_err))
1725 return 0;
1726 err = xchg(&sk->sk_err, 0);
1727 return -err;
1730 static inline unsigned long sock_wspace(struct sock *sk)
1732 int amt = 0;
1734 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1735 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1736 if (amt < 0)
1737 amt = 0;
1739 return amt;
1742 static inline void sk_wake_async(struct sock *sk, int how, int band)
1744 if (sock_flag(sk, SOCK_FASYNC))
1745 sock_wake_async(sk->sk_socket, how, band);
1748 #define SOCK_MIN_SNDBUF 2048
1750 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1751 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1753 #define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
1755 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1757 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
1758 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
1759 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1763 struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
1765 static inline struct page *sk_stream_alloc_page(struct sock *sk)
1767 struct page *page = NULL;
1769 page = alloc_pages(sk->sk_allocation, 0);
1770 if (!page) {
1771 sk_enter_memory_pressure(sk);
1772 sk_stream_moderate_sndbuf(sk);
1774 return page;
1778 * Default write policy as shown to user space via poll/select/SIGIO
1780 static inline int sock_writeable(const struct sock *sk)
1782 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1785 static inline gfp_t gfp_any(void)
1787 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1790 static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1792 return noblock ? 0 : sk->sk_rcvtimeo;
1795 static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1797 return noblock ? 0 : sk->sk_sndtimeo;
1800 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1802 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1805 /* Alas, with timeout socket operations are not restartable.
1806 * Compare this to poll().
1808 static inline int sock_intr_errno(long timeo)
1810 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1813 extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1814 struct sk_buff *skb);
1815 extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
1816 struct sk_buff *skb);
1818 static __inline__ void
1819 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1821 ktime_t kt = skb->tstamp;
1822 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
1825 * generate control messages if
1826 * - receive time stamping in software requested (SOCK_RCVTSTAMP
1827 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
1828 * - software time stamp available and wanted
1829 * (SOCK_TIMESTAMPING_SOFTWARE)
1830 * - hardware time stamps available and wanted
1831 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
1832 * SOCK_TIMESTAMPING_RAW_HARDWARE)
1834 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1835 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
1836 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
1837 (hwtstamps->hwtstamp.tv64 &&
1838 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
1839 (hwtstamps->syststamp.tv64 &&
1840 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
1841 __sock_recv_timestamp(msg, sk, skb);
1842 else
1843 sk->sk_stamp = kt;
1845 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
1846 __sock_recv_wifi_status(msg, sk, skb);
1849 extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
1850 struct sk_buff *skb);
1852 static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
1853 struct sk_buff *skb)
1855 #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
1856 (1UL << SOCK_RCVTSTAMP) | \
1857 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
1858 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
1859 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
1860 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
1862 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
1863 __sock_recv_ts_and_drops(msg, sk, skb);
1864 else
1865 sk->sk_stamp = skb->tstamp;
1869 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
1870 * @sk: socket sending this packet
1871 * @tx_flags: filled with instructions for time stamping
1873 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
1874 * parameters are invalid.
1876 extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
1879 * sk_eat_skb - Release a skb if it is no longer needed
1880 * @sk: socket to eat this skb from
1881 * @skb: socket buffer to eat
1882 * @copied_early: flag indicating whether DMA operations copied this data early
1884 * This routine must be called with interrupts disabled or with the socket
1885 * locked so that the sk_buff queue operation is ok.
1887 #ifdef CONFIG_NET_DMA
1888 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1890 __skb_unlink(skb, &sk->sk_receive_queue);
1891 if (!copied_early)
1892 __kfree_skb(skb);
1893 else
1894 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
1896 #else
1897 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1899 __skb_unlink(skb, &sk->sk_receive_queue);
1900 __kfree_skb(skb);
1902 #endif
1904 static inline
1905 struct net *sock_net(const struct sock *sk)
1907 return read_pnet(&sk->sk_net);
1910 static inline
1911 void sock_net_set(struct sock *sk, struct net *net)
1913 write_pnet(&sk->sk_net, net);
1917 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
1918 * They should not hold a reference to a namespace in order to allow
1919 * to stop it.
1920 * Sockets after sk_change_net should be released using sk_release_kernel
1922 static inline void sk_change_net(struct sock *sk, struct net *net)
1924 put_net(sock_net(sk));
1925 sock_net_set(sk, hold_net(net));
1928 static inline struct sock *skb_steal_sock(struct sk_buff *skb)
1930 if (unlikely(skb->sk)) {
1931 struct sock *sk = skb->sk;
1933 skb->destructor = NULL;
1934 skb->sk = NULL;
1935 return sk;
1937 return NULL;
1940 extern void sock_enable_timestamp(struct sock *sk, int flag);
1941 extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1942 extern int sock_get_timestampns(struct sock *, struct timespec __user *);
1945 * Enable debug/info messages
1947 extern int net_msg_warn;
1948 #define NETDEBUG(fmt, args...) \
1949 do { if (net_msg_warn) printk(fmt,##args); } while (0)
1951 #define LIMIT_NETDEBUG(fmt, args...) \
1952 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
1954 extern __u32 sysctl_wmem_max;
1955 extern __u32 sysctl_rmem_max;
1957 extern void sk_init(void);
1959 extern int sysctl_optmem_max;
1961 extern __u32 sysctl_wmem_default;
1962 extern __u32 sysctl_rmem_default;
1964 #endif /* _SOCK_H */