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/kernel.h>
44 #include <linux/list.h>
45 #include <linux/timer.h>
46 #include <linux/cache.h>
47 #include <linux/module.h>
48 #include <linux/lockdep.h>
49 #include <linux/netdevice.h>
50 #include <linux/skbuff.h> /* struct sk_buff */
52 #include <linux/security.h>
54 #include <linux/filter.h>
56 #include <asm/atomic.h>
58 #include <net/checksum.h>
61 * This structure really needs to be cleaned up.
62 * Most of it is for TCP, and not used by any of
63 * the other protocols.
66 /* Define this to get the SOCK_DBG debugging facility. */
67 #define SOCK_DEBUGGING
69 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
70 printk(KERN_DEBUG msg); } while (0)
72 /* Validate arguments and do nothing */
73 static void inline int __attribute__ ((format (printf, 2, 3)))
74 SOCK_DEBUG(struct sock *sk, const char *msg, ...)
79 /* This is the per-socket lock. The spinlock provides a synchronization
80 * between user contexts and software interrupt processing, whereas the
81 * mini-semaphore synchronizes multiple users amongst themselves.
88 * We express the mutex-alike socket_lock semantics
89 * to the lock validator by explicitly managing
90 * the slock as a lock variant (in addition to
93 #ifdef CONFIG_DEBUG_LOCK_ALLOC
94 struct lockdep_map dep_map;
103 * struct sock_common - minimal network layer representation of sockets
104 * @skc_family: network address family
105 * @skc_state: Connection state
106 * @skc_reuse: %SO_REUSEADDR setting
107 * @skc_bound_dev_if: bound device index if != 0
108 * @skc_node: main hash linkage for various protocol lookup tables
109 * @skc_bind_node: bind hash linkage for various protocol lookup tables
110 * @skc_refcnt: reference count
111 * @skc_hash: hash value used with various protocol lookup tables
112 * @skc_prot: protocol handlers inside a network family
113 * @skc_net: reference to the network namespace of this socket
115 * This is the minimal network layer representation of sockets, the header
116 * for struct sock and struct inet_timewait_sock.
119 unsigned short skc_family;
120 volatile unsigned char skc_state;
121 unsigned char skc_reuse;
122 int skc_bound_dev_if;
123 struct hlist_node skc_node;
124 struct hlist_node skc_bind_node;
126 unsigned int skc_hash;
127 struct proto *skc_prot;
134 * struct sock - network layer representation of sockets
135 * @__sk_common: shared layout with inet_timewait_sock
136 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
137 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
138 * @sk_lock: synchronizer
139 * @sk_rcvbuf: size of receive buffer in bytes
140 * @sk_sleep: sock wait queue
141 * @sk_dst_cache: destination cache
142 * @sk_dst_lock: destination cache lock
143 * @sk_policy: flow policy
144 * @sk_rmem_alloc: receive queue bytes committed
145 * @sk_receive_queue: incoming packets
146 * @sk_wmem_alloc: transmit queue bytes committed
147 * @sk_write_queue: Packet sending queue
148 * @sk_async_wait_queue: DMA copied packets
149 * @sk_omem_alloc: "o" is "option" or "other"
150 * @sk_wmem_queued: persistent queue size
151 * @sk_forward_alloc: space allocated forward
152 * @sk_allocation: allocation mode
153 * @sk_sndbuf: size of send buffer in bytes
154 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
155 * %SO_OOBINLINE settings
156 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
157 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
158 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
159 * @sk_gso_max_size: Maximum GSO segment size to build
160 * @sk_lingertime: %SO_LINGER l_linger setting
161 * @sk_backlog: always used with the per-socket spinlock held
162 * @sk_callback_lock: used with the callbacks in the end of this struct
163 * @sk_error_queue: rarely used
164 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
165 * IPV6_ADDRFORM for instance)
166 * @sk_err: last error
167 * @sk_err_soft: errors that don't cause failure but are the cause of a
168 * persistent failure not just 'timed out'
169 * @sk_drops: raw/udp drops counter
170 * @sk_ack_backlog: current listen backlog
171 * @sk_max_ack_backlog: listen backlog set in listen()
172 * @sk_priority: %SO_PRIORITY setting
173 * @sk_type: socket type (%SOCK_STREAM, etc)
174 * @sk_protocol: which protocol this socket belongs in this network family
175 * @sk_peercred: %SO_PEERCRED setting
176 * @sk_rcvlowat: %SO_RCVLOWAT setting
177 * @sk_rcvtimeo: %SO_RCVTIMEO setting
178 * @sk_sndtimeo: %SO_SNDTIMEO setting
179 * @sk_filter: socket filtering instructions
180 * @sk_protinfo: private area, net family specific, when not using slab
181 * @sk_timer: sock cleanup timer
182 * @sk_stamp: time stamp of last packet received
183 * @sk_socket: Identd and reporting IO signals
184 * @sk_user_data: RPC layer private data
185 * @sk_sndmsg_page: cached page for sendmsg
186 * @sk_sndmsg_off: cached offset for sendmsg
187 * @sk_send_head: front of stuff to transmit
188 * @sk_security: used by security modules
189 * @sk_mark: generic packet mark
190 * @sk_write_pending: a write to stream socket waits to start
191 * @sk_state_change: callback to indicate change in the state of the sock
192 * @sk_data_ready: callback to indicate there is data to be processed
193 * @sk_write_space: callback to indicate there is bf sending space available
194 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
195 * @sk_backlog_rcv: callback to process the backlog
196 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
200 * Now struct inet_timewait_sock also uses sock_common, so please just
201 * don't add nothing before this first member (__sk_common) --acme
203 struct sock_common __sk_common;
204 #define sk_family __sk_common.skc_family
205 #define sk_state __sk_common.skc_state
206 #define sk_reuse __sk_common.skc_reuse
207 #define sk_bound_dev_if __sk_common.skc_bound_dev_if
208 #define sk_node __sk_common.skc_node
209 #define sk_bind_node __sk_common.skc_bind_node
210 #define sk_refcnt __sk_common.skc_refcnt
211 #define sk_hash __sk_common.skc_hash
212 #define sk_prot __sk_common.skc_prot
213 #define sk_net __sk_common.skc_net
214 unsigned char sk_shutdown : 2,
217 unsigned char sk_protocol;
218 unsigned short sk_type;
220 socket_lock_t sk_lock;
222 * The backlog queue is special, it is always used with
223 * the per-socket spinlock held and requires low latency
224 * access. Therefore we special case it's implementation.
227 struct sk_buff *head;
228 struct sk_buff *tail;
230 wait_queue_head_t *sk_sleep;
231 struct dst_entry *sk_dst_cache;
233 struct xfrm_policy *sk_policy[2];
235 rwlock_t sk_dst_lock;
236 atomic_t sk_rmem_alloc;
237 atomic_t sk_wmem_alloc;
238 atomic_t sk_omem_alloc;
240 struct sk_buff_head sk_receive_queue;
241 struct sk_buff_head sk_write_queue;
242 struct sk_buff_head sk_async_wait_queue;
244 int sk_forward_alloc;
248 unsigned int sk_gso_max_size;
250 unsigned long sk_flags;
251 unsigned long sk_lingertime;
252 struct sk_buff_head sk_error_queue;
253 struct proto *sk_prot_creator;
254 rwlock_t sk_callback_lock;
258 unsigned short sk_ack_backlog;
259 unsigned short sk_max_ack_backlog;
261 struct ucred sk_peercred;
264 struct sk_filter *sk_filter;
266 struct timer_list sk_timer;
268 struct socket *sk_socket;
270 struct page *sk_sndmsg_page;
271 struct sk_buff *sk_send_head;
273 int sk_write_pending;
274 #ifdef CONFIG_SECURITY
278 /* XXX 4 bytes hole on 64 bit */
279 void (*sk_state_change)(struct sock *sk);
280 void (*sk_data_ready)(struct sock *sk, int bytes);
281 void (*sk_write_space)(struct sock *sk);
282 void (*sk_error_report)(struct sock *sk);
283 int (*sk_backlog_rcv)(struct sock *sk,
284 struct sk_buff *skb);
285 void (*sk_destruct)(struct sock *sk);
289 * Hashed lists helper routines
291 static inline struct sock *__sk_head(const struct hlist_head *head)
293 return hlist_entry(head->first, struct sock, sk_node);
296 static inline struct sock *sk_head(const struct hlist_head *head)
298 return hlist_empty(head) ? NULL : __sk_head(head);
301 static inline struct sock *sk_next(const struct sock *sk)
303 return sk->sk_node.next ?
304 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
307 static inline int sk_unhashed(const struct sock *sk)
309 return hlist_unhashed(&sk->sk_node);
312 static inline int sk_hashed(const struct sock *sk)
314 return !sk_unhashed(sk);
317 static __inline__ void sk_node_init(struct hlist_node *node)
322 static __inline__ void __sk_del_node(struct sock *sk)
324 __hlist_del(&sk->sk_node);
327 static __inline__ int __sk_del_node_init(struct sock *sk)
331 sk_node_init(&sk->sk_node);
337 /* Grab socket reference count. This operation is valid only
338 when sk is ALREADY grabbed f.e. it is found in hash table
339 or a list and the lookup is made under lock preventing hash table
343 static inline void sock_hold(struct sock *sk)
345 atomic_inc(&sk->sk_refcnt);
348 /* Ungrab socket in the context, which assumes that socket refcnt
349 cannot hit zero, f.e. it is true in context of any socketcall.
351 static inline void __sock_put(struct sock *sk)
353 atomic_dec(&sk->sk_refcnt);
356 static __inline__ int sk_del_node_init(struct sock *sk)
358 int rc = __sk_del_node_init(sk);
361 /* paranoid for a while -acme */
362 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
368 static __inline__ int __sk_del_node_init_rcu(struct sock *sk)
371 hlist_del_init_rcu(&sk->sk_node);
377 static __inline__ int sk_del_node_init_rcu(struct sock *sk)
379 int rc = __sk_del_node_init_rcu(sk);
382 /* paranoid for a while -acme */
383 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
389 static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
391 hlist_add_head(&sk->sk_node, list);
394 static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
397 __sk_add_node(sk, list);
400 static __inline__ void __sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
402 hlist_add_head_rcu(&sk->sk_node, list);
405 static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
408 __sk_add_node_rcu(sk, list);
411 static __inline__ void __sk_del_bind_node(struct sock *sk)
413 __hlist_del(&sk->sk_bind_node);
416 static __inline__ void sk_add_bind_node(struct sock *sk,
417 struct hlist_head *list)
419 hlist_add_head(&sk->sk_bind_node, list);
422 #define sk_for_each(__sk, node, list) \
423 hlist_for_each_entry(__sk, node, list, sk_node)
424 #define sk_for_each_rcu_safenext(__sk, node, list, next) \
425 hlist_for_each_entry_rcu_safenext(__sk, node, list, sk_node, next)
426 #define sk_for_each_from(__sk, node) \
427 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
428 hlist_for_each_entry_from(__sk, node, sk_node)
429 #define sk_for_each_continue(__sk, node) \
430 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
431 hlist_for_each_entry_continue(__sk, node, sk_node)
432 #define sk_for_each_safe(__sk, node, tmp, list) \
433 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
434 #define sk_for_each_bound(__sk, node, list) \
435 hlist_for_each_entry(__sk, node, list, sk_bind_node)
448 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
449 SOCK_DBG, /* %SO_DEBUG setting */
450 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
451 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
452 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
453 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
456 static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
458 nsk->sk_flags = osk->sk_flags;
461 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
463 __set_bit(flag, &sk->sk_flags);
466 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
468 __clear_bit(flag, &sk->sk_flags);
471 static inline int sock_flag(struct sock *sk, enum sock_flags flag)
473 return test_bit(flag, &sk->sk_flags);
476 static inline void sk_acceptq_removed(struct sock *sk)
478 sk->sk_ack_backlog--;
481 static inline void sk_acceptq_added(struct sock *sk)
483 sk->sk_ack_backlog++;
486 static inline int sk_acceptq_is_full(struct sock *sk)
488 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
492 * Compute minimal free write space needed to queue new packets.
494 static inline int sk_stream_min_wspace(struct sock *sk)
496 return sk->sk_wmem_queued >> 1;
499 static inline int sk_stream_wspace(struct sock *sk)
501 return sk->sk_sndbuf - sk->sk_wmem_queued;
504 extern void sk_stream_write_space(struct sock *sk);
506 static inline int sk_stream_memory_free(struct sock *sk)
508 return sk->sk_wmem_queued < sk->sk_sndbuf;
511 /* The per-socket spinlock must be held here. */
512 static inline void sk_add_backlog(struct sock *sk, struct sk_buff *skb)
514 if (!sk->sk_backlog.tail) {
515 sk->sk_backlog.head = sk->sk_backlog.tail = skb;
517 sk->sk_backlog.tail->next = skb;
518 sk->sk_backlog.tail = skb;
523 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
525 return sk->sk_backlog_rcv(sk, skb);
528 #define sk_wait_event(__sk, __timeo, __condition) \
530 release_sock(__sk); \
531 __rc = __condition; \
533 *(__timeo) = schedule_timeout(*(__timeo)); \
536 __rc = __condition; \
540 extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
541 extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
542 extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
543 extern int sk_stream_error(struct sock *sk, int flags, int err);
544 extern void sk_stream_kill_queues(struct sock *sk);
546 extern int sk_wait_data(struct sock *sk, long *timeo);
548 struct request_sock_ops;
549 struct timewait_sock_ops;
550 struct inet_hashinfo;
553 /* Networking protocol blocks we attach to sockets.
554 * socket layer -> transport layer interface
555 * transport -> network interface is defined by struct inet_proto
558 void (*close)(struct sock *sk,
560 int (*connect)(struct sock *sk,
561 struct sockaddr *uaddr,
563 int (*disconnect)(struct sock *sk, int flags);
565 struct sock * (*accept) (struct sock *sk, int flags, int *err);
567 int (*ioctl)(struct sock *sk, int cmd,
569 int (*init)(struct sock *sk);
570 void (*destroy)(struct sock *sk);
571 void (*shutdown)(struct sock *sk, int how);
572 int (*setsockopt)(struct sock *sk, int level,
573 int optname, char __user *optval,
575 int (*getsockopt)(struct sock *sk, int level,
576 int optname, char __user *optval,
579 int (*compat_setsockopt)(struct sock *sk,
581 int optname, char __user *optval,
583 int (*compat_getsockopt)(struct sock *sk,
585 int optname, char __user *optval,
588 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
589 struct msghdr *msg, size_t len);
590 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
592 size_t len, int noblock, int flags,
594 int (*sendpage)(struct sock *sk, struct page *page,
595 int offset, size_t size, int flags);
596 int (*bind)(struct sock *sk,
597 struct sockaddr *uaddr, int addr_len);
599 int (*backlog_rcv) (struct sock *sk,
600 struct sk_buff *skb);
602 /* Keeping track of sk's, looking them up, and port selection methods. */
603 void (*hash)(struct sock *sk);
604 void (*unhash)(struct sock *sk);
605 int (*get_port)(struct sock *sk, unsigned short snum);
607 /* Keeping track of sockets in use */
608 #ifdef CONFIG_PROC_FS
609 unsigned int inuse_idx;
612 /* Memory pressure */
613 void (*enter_memory_pressure)(struct sock *sk);
614 atomic_t *memory_allocated; /* Current allocated memory. */
615 atomic_t *sockets_allocated; /* Current number of sockets. */
617 * Pressure flag: try to collapse.
618 * Technical note: it is used by multiple contexts non atomically.
619 * All the __sk_mem_schedule() is of this nature: accounting
620 * is strict, actions are advisory and have some latency.
622 int *memory_pressure;
628 struct kmem_cache *slab;
629 unsigned int obj_size;
632 atomic_t *orphan_count;
634 struct request_sock_ops *rsk_prot;
635 struct timewait_sock_ops *twsk_prot;
638 struct inet_hashinfo *hashinfo;
639 struct udp_table *udp_table;
640 struct raw_hashinfo *raw_hash;
643 struct module *owner;
647 struct list_head node;
648 #ifdef SOCK_REFCNT_DEBUG
653 extern int proto_register(struct proto *prot, int alloc_slab);
654 extern void proto_unregister(struct proto *prot);
656 #ifdef SOCK_REFCNT_DEBUG
657 static inline void sk_refcnt_debug_inc(struct sock *sk)
659 atomic_inc(&sk->sk_prot->socks);
662 static inline void sk_refcnt_debug_dec(struct sock *sk)
664 atomic_dec(&sk->sk_prot->socks);
665 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
666 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
669 static inline void sk_refcnt_debug_release(const struct sock *sk)
671 if (atomic_read(&sk->sk_refcnt) != 1)
672 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
673 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
675 #else /* SOCK_REFCNT_DEBUG */
676 #define sk_refcnt_debug_inc(sk) do { } while (0)
677 #define sk_refcnt_debug_dec(sk) do { } while (0)
678 #define sk_refcnt_debug_release(sk) do { } while (0)
679 #endif /* SOCK_REFCNT_DEBUG */
682 #ifdef CONFIG_PROC_FS
683 /* Called with local bh disabled */
684 extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
685 extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
687 static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
694 /* With per-bucket locks this operation is not-atomic, so that
695 * this version is not worse.
697 static inline void __sk_prot_rehash(struct sock *sk)
699 sk->sk_prot->unhash(sk);
700 sk->sk_prot->hash(sk);
703 /* About 10 seconds */
704 #define SOCK_DESTROY_TIME (10*HZ)
706 /* Sockets 0-1023 can't be bound to unless you are superuser */
707 #define PROT_SOCK 1024
709 #define SHUTDOWN_MASK 3
710 #define RCV_SHUTDOWN 1
711 #define SEND_SHUTDOWN 2
713 #define SOCK_SNDBUF_LOCK 1
714 #define SOCK_RCVBUF_LOCK 2
715 #define SOCK_BINDADDR_LOCK 4
716 #define SOCK_BINDPORT_LOCK 8
718 /* sock_iocb: used to kick off async processing of socket ios */
720 struct list_head list;
726 struct scm_cookie *scm;
727 struct msghdr *msg, async_msg;
731 static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
733 return (struct sock_iocb *)iocb->private;
736 static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
741 struct socket_alloc {
742 struct socket socket;
743 struct inode vfs_inode;
746 static inline struct socket *SOCKET_I(struct inode *inode)
748 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
751 static inline struct inode *SOCK_INODE(struct socket *socket)
753 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
757 * Functions for memory accounting
759 extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
760 extern void __sk_mem_reclaim(struct sock *sk);
762 #define SK_MEM_QUANTUM ((int)PAGE_SIZE)
763 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
764 #define SK_MEM_SEND 0
765 #define SK_MEM_RECV 1
767 static inline int sk_mem_pages(int amt)
769 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
772 static inline int sk_has_account(struct sock *sk)
774 /* return true if protocol supports memory accounting */
775 return !!sk->sk_prot->memory_allocated;
778 static inline int sk_wmem_schedule(struct sock *sk, int size)
780 if (!sk_has_account(sk))
782 return size <= sk->sk_forward_alloc ||
783 __sk_mem_schedule(sk, size, SK_MEM_SEND);
786 static inline int sk_rmem_schedule(struct sock *sk, int size)
788 if (!sk_has_account(sk))
790 return size <= sk->sk_forward_alloc ||
791 __sk_mem_schedule(sk, size, SK_MEM_RECV);
794 static inline void sk_mem_reclaim(struct sock *sk)
796 if (!sk_has_account(sk))
798 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
799 __sk_mem_reclaim(sk);
802 static inline void sk_mem_reclaim_partial(struct sock *sk)
804 if (!sk_has_account(sk))
806 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
807 __sk_mem_reclaim(sk);
810 static inline void sk_mem_charge(struct sock *sk, int size)
812 if (!sk_has_account(sk))
814 sk->sk_forward_alloc -= size;
817 static inline void sk_mem_uncharge(struct sock *sk, int size)
819 if (!sk_has_account(sk))
821 sk->sk_forward_alloc += size;
824 static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
826 skb_truesize_check(skb);
827 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
828 sk->sk_wmem_queued -= skb->truesize;
829 sk_mem_uncharge(sk, skb->truesize);
833 /* Used by processes to "lock" a socket state, so that
834 * interrupts and bottom half handlers won't change it
835 * from under us. It essentially blocks any incoming
836 * packets, so that we won't get any new data or any
837 * packets that change the state of the socket.
839 * While locked, BH processing will add new packets to
840 * the backlog queue. This queue is processed by the
841 * owner of the socket lock right before it is released.
843 * Since ~2.3.5 it is also exclusive sleep lock serializing
844 * accesses from user process context.
846 #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
849 * Macro so as to not evaluate some arguments when
850 * lockdep is not enabled.
852 * Mark both the sk_lock and the sk_lock.slock as a
853 * per-address-family lock class.
855 #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
857 sk->sk_lock.owned = 0; \
858 init_waitqueue_head(&sk->sk_lock.wq); \
859 spin_lock_init(&(sk)->sk_lock.slock); \
860 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
861 sizeof((sk)->sk_lock)); \
862 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
864 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
867 extern void lock_sock_nested(struct sock *sk, int subclass);
869 static inline void lock_sock(struct sock *sk)
871 lock_sock_nested(sk, 0);
874 extern void release_sock(struct sock *sk);
876 /* BH context may only use the following locking interface. */
877 #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
878 #define bh_lock_sock_nested(__sk) \
879 spin_lock_nested(&((__sk)->sk_lock.slock), \
880 SINGLE_DEPTH_NESTING)
881 #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
883 extern struct sock *sk_alloc(struct net *net, int family,
886 extern void sk_free(struct sock *sk);
887 extern void sk_release_kernel(struct sock *sk);
888 extern struct sock *sk_clone(const struct sock *sk,
889 const gfp_t priority);
891 extern struct sk_buff *sock_wmalloc(struct sock *sk,
892 unsigned long size, int force,
894 extern struct sk_buff *sock_rmalloc(struct sock *sk,
895 unsigned long size, int force,
897 extern void sock_wfree(struct sk_buff *skb);
898 extern void sock_rfree(struct sk_buff *skb);
900 extern int sock_setsockopt(struct socket *sock, int level,
901 int op, char __user *optval,
904 extern int sock_getsockopt(struct socket *sock, int level,
905 int op, char __user *optval,
907 extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
911 extern void *sock_kmalloc(struct sock *sk, int size,
913 extern void sock_kfree_s(struct sock *sk, void *mem, int size);
914 extern void sk_send_sigurg(struct sock *sk);
917 * Functions to fill in entries in struct proto_ops when a protocol
918 * does not implement a particular function.
920 extern int sock_no_bind(struct socket *,
921 struct sockaddr *, int);
922 extern int sock_no_connect(struct socket *,
923 struct sockaddr *, int, int);
924 extern int sock_no_socketpair(struct socket *,
926 extern int sock_no_accept(struct socket *,
927 struct socket *, int);
928 extern int sock_no_getname(struct socket *,
929 struct sockaddr *, int *, int);
930 extern unsigned int sock_no_poll(struct file *, struct socket *,
931 struct poll_table_struct *);
932 extern int sock_no_ioctl(struct socket *, unsigned int,
934 extern int sock_no_listen(struct socket *, int);
935 extern int sock_no_shutdown(struct socket *, int);
936 extern int sock_no_getsockopt(struct socket *, int , int,
937 char __user *, int __user *);
938 extern int sock_no_setsockopt(struct socket *, int, int,
940 extern int sock_no_sendmsg(struct kiocb *, struct socket *,
941 struct msghdr *, size_t);
942 extern int sock_no_recvmsg(struct kiocb *, struct socket *,
943 struct msghdr *, size_t, int);
944 extern int sock_no_mmap(struct file *file,
946 struct vm_area_struct *vma);
947 extern ssize_t sock_no_sendpage(struct socket *sock,
949 int offset, size_t size,
953 * Functions to fill in entries in struct proto_ops when a protocol
954 * uses the inet style.
956 extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
957 char __user *optval, int __user *optlen);
958 extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
959 struct msghdr *msg, size_t size, int flags);
960 extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
961 char __user *optval, int optlen);
962 extern int compat_sock_common_getsockopt(struct socket *sock, int level,
963 int optname, char __user *optval, int __user *optlen);
964 extern int compat_sock_common_setsockopt(struct socket *sock, int level,
965 int optname, char __user *optval, int optlen);
967 extern void sk_common_release(struct sock *sk);
970 * Default socket callbacks and setup code
973 /* Initialise core socket variables */
974 extern void sock_init_data(struct socket *sock, struct sock *sk);
977 * sk_filter_release: Release a socket filter
978 * @fp: filter to remove
980 * Remove a filter from a socket and release its resources.
983 static inline void sk_filter_release(struct sk_filter *fp)
985 if (atomic_dec_and_test(&fp->refcnt))
989 static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
991 unsigned int size = sk_filter_len(fp);
993 atomic_sub(size, &sk->sk_omem_alloc);
994 sk_filter_release(fp);
997 static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
999 atomic_inc(&fp->refcnt);
1000 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1004 * Socket reference counting postulates.
1006 * * Each user of socket SHOULD hold a reference count.
1007 * * Each access point to socket (an hash table bucket, reference from a list,
1008 * running timer, skb in flight MUST hold a reference count.
1009 * * When reference count hits 0, it means it will never increase back.
1010 * * When reference count hits 0, it means that no references from
1011 * outside exist to this socket and current process on current CPU
1012 * is last user and may/should destroy this socket.
1013 * * sk_free is called from any context: process, BH, IRQ. When
1014 * it is called, socket has no references from outside -> sk_free
1015 * may release descendant resources allocated by the socket, but
1016 * to the time when it is called, socket is NOT referenced by any
1017 * hash tables, lists etc.
1018 * * Packets, delivered from outside (from network or from another process)
1019 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1020 * when they sit in queue. Otherwise, packets will leak to hole, when
1021 * socket is looked up by one cpu and unhasing is made by another CPU.
1022 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1023 * (leak to backlog). Packet socket does all the processing inside
1024 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1025 * use separate SMP lock, so that they are prone too.
1028 /* Ungrab socket and destroy it, if it was the last reference. */
1029 static inline void sock_put(struct sock *sk)
1031 if (atomic_dec_and_test(&sk->sk_refcnt))
1035 extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1038 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1040 sk->sk_socket = sock;
1043 /* Detach socket from process context.
1044 * Announce socket dead, detach it from wait queue and inode.
1045 * Note that parent inode held reference count on this struct sock,
1046 * we do not release it in this function, because protocol
1047 * probably wants some additional cleanups or even continuing
1048 * to work with this socket (TCP).
1050 static inline void sock_orphan(struct sock *sk)
1052 write_lock_bh(&sk->sk_callback_lock);
1053 sock_set_flag(sk, SOCK_DEAD);
1054 sk_set_socket(sk, NULL);
1055 sk->sk_sleep = NULL;
1056 write_unlock_bh(&sk->sk_callback_lock);
1059 static inline void sock_graft(struct sock *sk, struct socket *parent)
1061 write_lock_bh(&sk->sk_callback_lock);
1062 sk->sk_sleep = &parent->wait;
1064 sk_set_socket(sk, parent);
1065 security_sock_graft(sk, parent);
1066 write_unlock_bh(&sk->sk_callback_lock);
1069 extern int sock_i_uid(struct sock *sk);
1070 extern unsigned long sock_i_ino(struct sock *sk);
1072 static inline struct dst_entry *
1073 __sk_dst_get(struct sock *sk)
1075 return sk->sk_dst_cache;
1078 static inline struct dst_entry *
1079 sk_dst_get(struct sock *sk)
1081 struct dst_entry *dst;
1083 read_lock(&sk->sk_dst_lock);
1084 dst = sk->sk_dst_cache;
1087 read_unlock(&sk->sk_dst_lock);
1092 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
1094 struct dst_entry *old_dst;
1096 old_dst = sk->sk_dst_cache;
1097 sk->sk_dst_cache = dst;
1098 dst_release(old_dst);
1102 sk_dst_set(struct sock *sk, struct dst_entry *dst)
1104 write_lock(&sk->sk_dst_lock);
1105 __sk_dst_set(sk, dst);
1106 write_unlock(&sk->sk_dst_lock);
1110 __sk_dst_reset(struct sock *sk)
1112 struct dst_entry *old_dst;
1114 old_dst = sk->sk_dst_cache;
1115 sk->sk_dst_cache = NULL;
1116 dst_release(old_dst);
1120 sk_dst_reset(struct sock *sk)
1122 write_lock(&sk->sk_dst_lock);
1124 write_unlock(&sk->sk_dst_lock);
1127 extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1129 extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1131 static inline int sk_can_gso(const struct sock *sk)
1133 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1136 extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1138 static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1139 struct sk_buff *skb, struct page *page,
1142 if (skb->ip_summed == CHECKSUM_NONE) {
1144 __wsum csum = csum_and_copy_from_user(from,
1145 page_address(page) + off,
1149 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1150 } else if (copy_from_user(page_address(page) + off, from, copy))
1154 skb->data_len += copy;
1155 skb->truesize += copy;
1156 sk->sk_wmem_queued += copy;
1157 sk_mem_charge(sk, copy);
1162 * Queue a received datagram if it will fit. Stream and sequenced
1163 * protocols can't normally use this as they need to fit buffers in
1164 * and play with them.
1166 * Inlined as it's very short and called for pretty much every
1167 * packet ever received.
1170 static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1174 skb->destructor = sock_wfree;
1175 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1178 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1181 skb->destructor = sock_rfree;
1182 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1183 sk_mem_charge(sk, skb->truesize);
1186 extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1187 unsigned long expires);
1189 extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1191 extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
1193 static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb)
1195 /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
1196 number of warnings when compiling with -W --ANK
1198 if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >=
1199 (unsigned)sk->sk_rcvbuf)
1201 skb_set_owner_r(skb, sk);
1202 skb_queue_tail(&sk->sk_error_queue, skb);
1203 if (!sock_flag(sk, SOCK_DEAD))
1204 sk->sk_data_ready(sk, skb->len);
1209 * Recover an error report and clear atomically
1212 static inline int sock_error(struct sock *sk)
1215 if (likely(!sk->sk_err))
1217 err = xchg(&sk->sk_err, 0);
1221 static inline unsigned long sock_wspace(struct sock *sk)
1225 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1226 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1233 static inline void sk_wake_async(struct sock *sk, int how, int band)
1235 if (sk->sk_socket && sk->sk_socket->fasync_list)
1236 sock_wake_async(sk->sk_socket, how, band);
1239 #define SOCK_MIN_SNDBUF 2048
1240 #define SOCK_MIN_RCVBUF 256
1242 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1244 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
1245 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
1246 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1250 struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
1252 static inline struct page *sk_stream_alloc_page(struct sock *sk)
1254 struct page *page = NULL;
1256 page = alloc_pages(sk->sk_allocation, 0);
1258 sk->sk_prot->enter_memory_pressure(sk);
1259 sk_stream_moderate_sndbuf(sk);
1265 * Default write policy as shown to user space via poll/select/SIGIO
1267 static inline int sock_writeable(const struct sock *sk)
1269 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1272 static inline gfp_t gfp_any(void)
1274 return in_atomic() ? GFP_ATOMIC : GFP_KERNEL;
1277 static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1279 return noblock ? 0 : sk->sk_rcvtimeo;
1282 static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1284 return noblock ? 0 : sk->sk_sndtimeo;
1287 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1289 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1292 /* Alas, with timeout socket operations are not restartable.
1293 * Compare this to poll().
1295 static inline int sock_intr_errno(long timeo)
1297 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1300 extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1301 struct sk_buff *skb);
1303 static __inline__ void
1304 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1306 ktime_t kt = skb->tstamp;
1308 if (sock_flag(sk, SOCK_RCVTSTAMP))
1309 __sock_recv_timestamp(msg, sk, skb);
1315 * sk_eat_skb - Release a skb if it is no longer needed
1316 * @sk: socket to eat this skb from
1317 * @skb: socket buffer to eat
1318 * @copied_early: flag indicating whether DMA operations copied this data early
1320 * This routine must be called with interrupts disabled or with the socket
1321 * locked so that the sk_buff queue operation is ok.
1323 #ifdef CONFIG_NET_DMA
1324 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1326 __skb_unlink(skb, &sk->sk_receive_queue);
1330 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
1333 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1335 __skb_unlink(skb, &sk->sk_receive_queue);
1341 struct net *sock_net(const struct sock *sk)
1343 #ifdef CONFIG_NET_NS
1351 void sock_net_set(struct sock *sk, struct net *net)
1353 #ifdef CONFIG_NET_NS
1359 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
1360 * They should not hold a referrence to a namespace in order to allow
1362 * Sockets after sk_change_net should be released using sk_release_kernel
1364 static inline void sk_change_net(struct sock *sk, struct net *net)
1366 put_net(sock_net(sk));
1367 sock_net_set(sk, hold_net(net));
1370 static inline struct sock *skb_steal_sock(struct sk_buff *skb)
1372 if (unlikely(skb->sk)) {
1373 struct sock *sk = skb->sk;
1375 skb->destructor = NULL;
1382 extern void sock_enable_timestamp(struct sock *sk);
1383 extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1384 extern int sock_get_timestampns(struct sock *, struct timespec __user *);
1387 * Enable debug/info messages
1389 extern int net_msg_warn;
1390 #define NETDEBUG(fmt, args...) \
1391 do { if (net_msg_warn) printk(fmt,##args); } while (0)
1393 #define LIMIT_NETDEBUG(fmt, args...) \
1394 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
1396 extern __u32 sysctl_wmem_max;
1397 extern __u32 sysctl_rmem_max;
1399 extern void sk_init(void);
1401 extern int sysctl_optmem_max;
1403 extern __u32 sysctl_wmem_default;
1404 extern __u32 sysctl_rmem_default;
1406 #endif /* _SOCK_H */