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>
59 #include <net/net_namespace.h>
62 * This structure really needs to be cleaned up.
63 * Most of it is for TCP, and not used by any of
64 * the other protocols.
67 /* Define this to get the SOCK_DBG debugging facility. */
68 #define SOCK_DEBUGGING
70 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
71 printk(KERN_DEBUG msg); } while (0)
73 #define SOCK_DEBUG(sk, msg...) do { } while (0)
76 /* This is the per-socket lock. The spinlock provides a synchronization
77 * between user contexts and software interrupt processing, whereas the
78 * mini-semaphore synchronizes multiple users amongst themselves.
85 * We express the mutex-alike socket_lock semantics
86 * to the lock validator by explicitly managing
87 * the slock as a lock variant (in addition to
90 #ifdef CONFIG_DEBUG_LOCK_ALLOC
91 struct lockdep_map dep_map
;
99 * struct sock_common - minimal network layer representation of sockets
100 * @skc_family: network address family
101 * @skc_state: Connection state
102 * @skc_reuse: %SO_REUSEADDR setting
103 * @skc_bound_dev_if: bound device index if != 0
104 * @skc_node: main hash linkage for various protocol lookup tables
105 * @skc_bind_node: bind hash linkage for various protocol lookup tables
106 * @skc_refcnt: reference count
107 * @skc_hash: hash value used with various protocol lookup tables
108 * @skc_prot: protocol handlers inside a network family
109 * @skc_net: reference to the network namespace of this socket
111 * This is the minimal network layer representation of sockets, the header
112 * for struct sock and struct inet_timewait_sock.
115 unsigned short skc_family
;
116 volatile unsigned char skc_state
;
117 unsigned char skc_reuse
;
118 int skc_bound_dev_if
;
119 struct hlist_node skc_node
;
120 struct hlist_node skc_bind_node
;
122 unsigned int skc_hash
;
123 struct proto
*skc_prot
;
128 * struct sock - network layer representation of sockets
129 * @__sk_common: shared layout with inet_timewait_sock
130 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
131 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
132 * @sk_lock: synchronizer
133 * @sk_rcvbuf: size of receive buffer in bytes
134 * @sk_sleep: sock wait queue
135 * @sk_dst_cache: destination cache
136 * @sk_dst_lock: destination cache lock
137 * @sk_policy: flow policy
138 * @sk_rmem_alloc: receive queue bytes committed
139 * @sk_receive_queue: incoming packets
140 * @sk_wmem_alloc: transmit queue bytes committed
141 * @sk_write_queue: Packet sending queue
142 * @sk_async_wait_queue: DMA copied packets
143 * @sk_omem_alloc: "o" is "option" or "other"
144 * @sk_wmem_queued: persistent queue size
145 * @sk_forward_alloc: space allocated forward
146 * @sk_allocation: allocation mode
147 * @sk_sndbuf: size of send buffer in bytes
148 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE, %SO_OOBINLINE settings
149 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
150 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
151 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
152 * @sk_lingertime: %SO_LINGER l_linger setting
153 * @sk_backlog: always used with the per-socket spinlock held
154 * @sk_callback_lock: used with the callbacks in the end of this struct
155 * @sk_error_queue: rarely used
156 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt, IPV6_ADDRFORM for instance)
157 * @sk_err: last error
158 * @sk_err_soft: errors that don't cause failure but are the cause of a persistent failure not just 'timed out'
159 * @sk_ack_backlog: current listen backlog
160 * @sk_max_ack_backlog: listen backlog set in listen()
161 * @sk_priority: %SO_PRIORITY setting
162 * @sk_type: socket type (%SOCK_STREAM, etc)
163 * @sk_protocol: which protocol this socket belongs in this network family
164 * @sk_peercred: %SO_PEERCRED setting
165 * @sk_rcvlowat: %SO_RCVLOWAT setting
166 * @sk_rcvtimeo: %SO_RCVTIMEO setting
167 * @sk_sndtimeo: %SO_SNDTIMEO setting
168 * @sk_filter: socket filtering instructions
169 * @sk_protinfo: private area, net family specific, when not using slab
170 * @sk_timer: sock cleanup timer
171 * @sk_stamp: time stamp of last packet received
172 * @sk_socket: Identd and reporting IO signals
173 * @sk_user_data: RPC layer private data
174 * @sk_sndmsg_page: cached page for sendmsg
175 * @sk_sndmsg_off: cached offset for sendmsg
176 * @sk_send_head: front of stuff to transmit
177 * @sk_security: used by security modules
178 * @sk_write_pending: a write to stream socket waits to start
179 * @sk_state_change: callback to indicate change in the state of the sock
180 * @sk_data_ready: callback to indicate there is data to be processed
181 * @sk_write_space: callback to indicate there is bf sending space available
182 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
183 * @sk_backlog_rcv: callback to process the backlog
184 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
188 * Now struct inet_timewait_sock also uses sock_common, so please just
189 * don't add nothing before this first member (__sk_common) --acme
191 struct sock_common __sk_common
;
192 #define sk_family __sk_common.skc_family
193 #define sk_state __sk_common.skc_state
194 #define sk_reuse __sk_common.skc_reuse
195 #define sk_bound_dev_if __sk_common.skc_bound_dev_if
196 #define sk_node __sk_common.skc_node
197 #define sk_bind_node __sk_common.skc_bind_node
198 #define sk_refcnt __sk_common.skc_refcnt
199 #define sk_hash __sk_common.skc_hash
200 #define sk_prot __sk_common.skc_prot
201 #define sk_net __sk_common.skc_net
202 unsigned char sk_shutdown
: 2,
205 unsigned char sk_protocol
;
206 unsigned short sk_type
;
208 socket_lock_t sk_lock
;
210 * The backlog queue is special, it is always used with
211 * the per-socket spinlock held and requires low latency
212 * access. Therefore we special case it's implementation.
215 struct sk_buff
*head
;
216 struct sk_buff
*tail
;
218 wait_queue_head_t
*sk_sleep
;
219 struct dst_entry
*sk_dst_cache
;
220 struct xfrm_policy
*sk_policy
[2];
221 rwlock_t sk_dst_lock
;
222 atomic_t sk_rmem_alloc
;
223 atomic_t sk_wmem_alloc
;
224 atomic_t sk_omem_alloc
;
226 struct sk_buff_head sk_receive_queue
;
227 struct sk_buff_head sk_write_queue
;
228 struct sk_buff_head sk_async_wait_queue
;
230 int sk_forward_alloc
;
235 unsigned long sk_flags
;
236 unsigned long sk_lingertime
;
237 struct sk_buff_head sk_error_queue
;
238 struct proto
*sk_prot_creator
;
239 rwlock_t sk_callback_lock
;
242 unsigned short sk_ack_backlog
;
243 unsigned short sk_max_ack_backlog
;
245 struct ucred sk_peercred
;
248 struct sk_filter
*sk_filter
;
250 struct timer_list sk_timer
;
252 struct socket
*sk_socket
;
254 struct page
*sk_sndmsg_page
;
255 struct sk_buff
*sk_send_head
;
257 int sk_write_pending
;
259 void (*sk_state_change
)(struct sock
*sk
);
260 void (*sk_data_ready
)(struct sock
*sk
, int bytes
);
261 void (*sk_write_space
)(struct sock
*sk
);
262 void (*sk_error_report
)(struct sock
*sk
);
263 int (*sk_backlog_rcv
)(struct sock
*sk
,
264 struct sk_buff
*skb
);
265 void (*sk_destruct
)(struct sock
*sk
);
269 * Hashed lists helper routines
271 static inline struct sock
*__sk_head(const struct hlist_head
*head
)
273 return hlist_entry(head
->first
, struct sock
, sk_node
);
276 static inline struct sock
*sk_head(const struct hlist_head
*head
)
278 return hlist_empty(head
) ? NULL
: __sk_head(head
);
281 static inline struct sock
*sk_next(const struct sock
*sk
)
283 return sk
->sk_node
.next
?
284 hlist_entry(sk
->sk_node
.next
, struct sock
, sk_node
) : NULL
;
287 static inline int sk_unhashed(const struct sock
*sk
)
289 return hlist_unhashed(&sk
->sk_node
);
292 static inline int sk_hashed(const struct sock
*sk
)
294 return !sk_unhashed(sk
);
297 static __inline__
void sk_node_init(struct hlist_node
*node
)
302 static __inline__
void __sk_del_node(struct sock
*sk
)
304 __hlist_del(&sk
->sk_node
);
307 static __inline__
int __sk_del_node_init(struct sock
*sk
)
311 sk_node_init(&sk
->sk_node
);
317 /* Grab socket reference count. This operation is valid only
318 when sk is ALREADY grabbed f.e. it is found in hash table
319 or a list and the lookup is made under lock preventing hash table
323 static inline void sock_hold(struct sock
*sk
)
325 atomic_inc(&sk
->sk_refcnt
);
328 /* Ungrab socket in the context, which assumes that socket refcnt
329 cannot hit zero, f.e. it is true in context of any socketcall.
331 static inline void __sock_put(struct sock
*sk
)
333 atomic_dec(&sk
->sk_refcnt
);
336 static __inline__
int sk_del_node_init(struct sock
*sk
)
338 int rc
= __sk_del_node_init(sk
);
341 /* paranoid for a while -acme */
342 WARN_ON(atomic_read(&sk
->sk_refcnt
) == 1);
348 static __inline__
void __sk_add_node(struct sock
*sk
, struct hlist_head
*list
)
350 hlist_add_head(&sk
->sk_node
, list
);
353 static __inline__
void sk_add_node(struct sock
*sk
, struct hlist_head
*list
)
356 __sk_add_node(sk
, list
);
359 static __inline__
void __sk_del_bind_node(struct sock
*sk
)
361 __hlist_del(&sk
->sk_bind_node
);
364 static __inline__
void sk_add_bind_node(struct sock
*sk
,
365 struct hlist_head
*list
)
367 hlist_add_head(&sk
->sk_bind_node
, list
);
370 #define sk_for_each(__sk, node, list) \
371 hlist_for_each_entry(__sk, node, list, sk_node)
372 #define sk_for_each_from(__sk, node) \
373 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
374 hlist_for_each_entry_from(__sk, node, sk_node)
375 #define sk_for_each_continue(__sk, node) \
376 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
377 hlist_for_each_entry_continue(__sk, node, sk_node)
378 #define sk_for_each_safe(__sk, node, tmp, list) \
379 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
380 #define sk_for_each_bound(__sk, node, list) \
381 hlist_for_each_entry(__sk, node, list, sk_bind_node)
394 SOCK_USE_WRITE_QUEUE
, /* whether to call sk->sk_write_space in sock_wfree */
395 SOCK_DBG
, /* %SO_DEBUG setting */
396 SOCK_RCVTSTAMP
, /* %SO_TIMESTAMP setting */
397 SOCK_RCVTSTAMPNS
, /* %SO_TIMESTAMPNS setting */
398 SOCK_LOCALROUTE
, /* route locally only, %SO_DONTROUTE setting */
399 SOCK_QUEUE_SHRUNK
, /* write queue has been shrunk recently */
402 static inline void sock_copy_flags(struct sock
*nsk
, struct sock
*osk
)
404 nsk
->sk_flags
= osk
->sk_flags
;
407 static inline void sock_set_flag(struct sock
*sk
, enum sock_flags flag
)
409 __set_bit(flag
, &sk
->sk_flags
);
412 static inline void sock_reset_flag(struct sock
*sk
, enum sock_flags flag
)
414 __clear_bit(flag
, &sk
->sk_flags
);
417 static inline int sock_flag(struct sock
*sk
, enum sock_flags flag
)
419 return test_bit(flag
, &sk
->sk_flags
);
422 static inline void sk_acceptq_removed(struct sock
*sk
)
424 sk
->sk_ack_backlog
--;
427 static inline void sk_acceptq_added(struct sock
*sk
)
429 sk
->sk_ack_backlog
++;
432 static inline int sk_acceptq_is_full(struct sock
*sk
)
434 return sk
->sk_ack_backlog
> sk
->sk_max_ack_backlog
;
438 * Compute minimal free write space needed to queue new packets.
440 static inline int sk_stream_min_wspace(struct sock
*sk
)
442 return sk
->sk_wmem_queued
/ 2;
445 static inline int sk_stream_wspace(struct sock
*sk
)
447 return sk
->sk_sndbuf
- sk
->sk_wmem_queued
;
450 extern void sk_stream_write_space(struct sock
*sk
);
452 static inline int sk_stream_memory_free(struct sock
*sk
)
454 return sk
->sk_wmem_queued
< sk
->sk_sndbuf
;
457 extern void sk_stream_rfree(struct sk_buff
*skb
);
459 static inline void sk_stream_set_owner_r(struct sk_buff
*skb
, struct sock
*sk
)
462 skb
->destructor
= sk_stream_rfree
;
463 atomic_add(skb
->truesize
, &sk
->sk_rmem_alloc
);
464 sk
->sk_forward_alloc
-= skb
->truesize
;
467 static inline void sk_stream_free_skb(struct sock
*sk
, struct sk_buff
*skb
)
469 skb_truesize_check(skb
);
470 sock_set_flag(sk
, SOCK_QUEUE_SHRUNK
);
471 sk
->sk_wmem_queued
-= skb
->truesize
;
472 sk
->sk_forward_alloc
+= skb
->truesize
;
476 /* The per-socket spinlock must be held here. */
477 static inline void sk_add_backlog(struct sock
*sk
, struct sk_buff
*skb
)
479 if (!sk
->sk_backlog
.tail
) {
480 sk
->sk_backlog
.head
= sk
->sk_backlog
.tail
= skb
;
482 sk
->sk_backlog
.tail
->next
= skb
;
483 sk
->sk_backlog
.tail
= skb
;
488 #define sk_wait_event(__sk, __timeo, __condition) \
490 release_sock(__sk); \
491 __rc = __condition; \
493 *(__timeo) = schedule_timeout(*(__timeo)); \
496 __rc = __condition; \
500 extern int sk_stream_wait_connect(struct sock
*sk
, long *timeo_p
);
501 extern int sk_stream_wait_memory(struct sock
*sk
, long *timeo_p
);
502 extern void sk_stream_wait_close(struct sock
*sk
, long timeo_p
);
503 extern int sk_stream_error(struct sock
*sk
, int flags
, int err
);
504 extern void sk_stream_kill_queues(struct sock
*sk
);
506 extern int sk_wait_data(struct sock
*sk
, long *timeo
);
508 struct request_sock_ops
;
509 struct timewait_sock_ops
;
511 /* Networking protocol blocks we attach to sockets.
512 * socket layer -> transport layer interface
513 * transport -> network interface is defined by struct inet_proto
516 void (*close
)(struct sock
*sk
,
518 int (*connect
)(struct sock
*sk
,
519 struct sockaddr
*uaddr
,
521 int (*disconnect
)(struct sock
*sk
, int flags
);
523 struct sock
* (*accept
) (struct sock
*sk
, int flags
, int *err
);
525 int (*ioctl
)(struct sock
*sk
, int cmd
,
527 int (*init
)(struct sock
*sk
);
528 int (*destroy
)(struct sock
*sk
);
529 void (*shutdown
)(struct sock
*sk
, int how
);
530 int (*setsockopt
)(struct sock
*sk
, int level
,
531 int optname
, char __user
*optval
,
533 int (*getsockopt
)(struct sock
*sk
, int level
,
534 int optname
, char __user
*optval
,
536 int (*compat_setsockopt
)(struct sock
*sk
,
538 int optname
, char __user
*optval
,
540 int (*compat_getsockopt
)(struct sock
*sk
,
542 int optname
, char __user
*optval
,
544 int (*sendmsg
)(struct kiocb
*iocb
, struct sock
*sk
,
545 struct msghdr
*msg
, size_t len
);
546 int (*recvmsg
)(struct kiocb
*iocb
, struct sock
*sk
,
548 size_t len
, int noblock
, int flags
,
550 int (*sendpage
)(struct sock
*sk
, struct page
*page
,
551 int offset
, size_t size
, int flags
);
552 int (*bind
)(struct sock
*sk
,
553 struct sockaddr
*uaddr
, int addr_len
);
555 int (*backlog_rcv
) (struct sock
*sk
,
556 struct sk_buff
*skb
);
558 /* Keeping track of sk's, looking them up, and port selection methods. */
559 void (*hash
)(struct sock
*sk
);
560 void (*unhash
)(struct sock
*sk
);
561 int (*get_port
)(struct sock
*sk
, unsigned short snum
);
564 /* Keeping track of sockets in use */
565 void (*inuse_add
)(struct proto
*prot
, int inc
);
566 int (*inuse_getval
)(const struct proto
*prot
);
571 /* Memory pressure */
572 void (*enter_memory_pressure
)(void);
573 atomic_t
*memory_allocated
; /* Current allocated memory. */
574 atomic_t
*sockets_allocated
; /* Current number of sockets. */
576 * Pressure flag: try to collapse.
577 * Technical note: it is used by multiple contexts non atomically.
578 * All the sk_stream_mem_schedule() is of this nature: accounting
579 * is strict, actions are advisory and have some latency.
581 int *memory_pressure
;
587 struct kmem_cache
*slab
;
588 unsigned int obj_size
;
590 atomic_t
*orphan_count
;
592 struct request_sock_ops
*rsk_prot
;
593 struct timewait_sock_ops
*twsk_prot
;
595 struct module
*owner
;
599 struct list_head node
;
600 #ifdef SOCK_REFCNT_DEBUG
606 * Special macros to let protos use a fast version of inuse{get|add}
607 * using a static percpu variable per proto instead of an allocated one,
608 * saving one dereference.
609 * This might be changed if/when dynamic percpu vars become fast.
612 # define DEFINE_PROTO_INUSE(NAME) \
613 static DEFINE_PER_CPU(int, NAME##_inuse); \
614 static void NAME##_inuse_add(struct proto *prot, int inc) \
616 __get_cpu_var(NAME##_inuse) += inc; \
619 static int NAME##_inuse_getval(const struct proto *prot)\
623 for_each_possible_cpu(cpu) \
624 res += per_cpu(NAME##_inuse, cpu); \
627 # define REF_PROTO_INUSE(NAME) \
628 .inuse_add = NAME##_inuse_add, \
629 .inuse_getval = NAME##_inuse_getval,
631 # define DEFINE_PROTO_INUSE(NAME)
632 # define REF_PROTO_INUSE(NAME)
635 extern int proto_register(struct proto
*prot
, int alloc_slab
);
636 extern void proto_unregister(struct proto
*prot
);
638 #ifdef SOCK_REFCNT_DEBUG
639 static inline void sk_refcnt_debug_inc(struct sock
*sk
)
641 atomic_inc(&sk
->sk_prot
->socks
);
644 static inline void sk_refcnt_debug_dec(struct sock
*sk
)
646 atomic_dec(&sk
->sk_prot
->socks
);
647 printk(KERN_DEBUG
"%s socket %p released, %d are still alive\n",
648 sk
->sk_prot
->name
, sk
, atomic_read(&sk
->sk_prot
->socks
));
651 static inline void sk_refcnt_debug_release(const struct sock
*sk
)
653 if (atomic_read(&sk
->sk_refcnt
) != 1)
654 printk(KERN_DEBUG
"Destruction of the %s socket %p delayed, refcnt=%d\n",
655 sk
->sk_prot
->name
, sk
, atomic_read(&sk
->sk_refcnt
));
657 #else /* SOCK_REFCNT_DEBUG */
658 #define sk_refcnt_debug_inc(sk) do { } while (0)
659 #define sk_refcnt_debug_dec(sk) do { } while (0)
660 #define sk_refcnt_debug_release(sk) do { } while (0)
661 #endif /* SOCK_REFCNT_DEBUG */
663 /* Called with local bh disabled */
664 static __inline__
void sock_prot_inc_use(struct proto
*prot
)
667 prot
->inuse_add(prot
, 1);
673 static __inline__
void sock_prot_dec_use(struct proto
*prot
)
676 prot
->inuse_add(prot
, -1);
682 static __inline__
int sock_prot_inuse(struct proto
*proto
)
685 return proto
->inuse_getval(proto
);
691 /* With per-bucket locks this operation is not-atomic, so that
692 * this version is not worse.
694 static inline void __sk_prot_rehash(struct sock
*sk
)
696 sk
->sk_prot
->unhash(sk
);
697 sk
->sk_prot
->hash(sk
);
700 /* About 10 seconds */
701 #define SOCK_DESTROY_TIME (10*HZ)
703 /* Sockets 0-1023 can't be bound to unless you are superuser */
704 #define PROT_SOCK 1024
706 #define SHUTDOWN_MASK 3
707 #define RCV_SHUTDOWN 1
708 #define SEND_SHUTDOWN 2
710 #define SOCK_SNDBUF_LOCK 1
711 #define SOCK_RCVBUF_LOCK 2
712 #define SOCK_BINDADDR_LOCK 4
713 #define SOCK_BINDPORT_LOCK 8
715 /* sock_iocb: used to kick off async processing of socket ios */
717 struct list_head list
;
723 struct scm_cookie
*scm
;
724 struct msghdr
*msg
, async_msg
;
728 static inline struct sock_iocb
*kiocb_to_siocb(struct kiocb
*iocb
)
730 return (struct sock_iocb
*)iocb
->private;
733 static inline struct kiocb
*siocb_to_kiocb(struct sock_iocb
*si
)
738 struct socket_alloc
{
739 struct socket socket
;
740 struct inode vfs_inode
;
743 static inline struct socket
*SOCKET_I(struct inode
*inode
)
745 return &container_of(inode
, struct socket_alloc
, vfs_inode
)->socket
;
748 static inline struct inode
*SOCK_INODE(struct socket
*socket
)
750 return &container_of(socket
, struct socket_alloc
, socket
)->vfs_inode
;
753 extern void __sk_stream_mem_reclaim(struct sock
*sk
);
754 extern int sk_stream_mem_schedule(struct sock
*sk
, int size
, int kind
);
756 #define SK_STREAM_MEM_QUANTUM ((int)PAGE_SIZE)
758 static inline int sk_stream_pages(int amt
)
760 return DIV_ROUND_UP(amt
, SK_STREAM_MEM_QUANTUM
);
763 static inline void sk_stream_mem_reclaim(struct sock
*sk
)
765 if (sk
->sk_forward_alloc
>= SK_STREAM_MEM_QUANTUM
)
766 __sk_stream_mem_reclaim(sk
);
769 static inline int sk_stream_rmem_schedule(struct sock
*sk
, struct sk_buff
*skb
)
771 return (int)skb
->truesize
<= sk
->sk_forward_alloc
||
772 sk_stream_mem_schedule(sk
, skb
->truesize
, 1);
775 static inline int sk_stream_wmem_schedule(struct sock
*sk
, int size
)
777 return size
<= sk
->sk_forward_alloc
||
778 sk_stream_mem_schedule(sk
, size
, 0);
781 /* Used by processes to "lock" a socket state, so that
782 * interrupts and bottom half handlers won't change it
783 * from under us. It essentially blocks any incoming
784 * packets, so that we won't get any new data or any
785 * packets that change the state of the socket.
787 * While locked, BH processing will add new packets to
788 * the backlog queue. This queue is processed by the
789 * owner of the socket lock right before it is released.
791 * Since ~2.3.5 it is also exclusive sleep lock serializing
792 * accesses from user process context.
794 #define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
797 * Macro so as to not evaluate some arguments when
798 * lockdep is not enabled.
800 * Mark both the sk_lock and the sk_lock.slock as a
801 * per-address-family lock class.
803 #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
805 sk->sk_lock.owned = 0; \
806 init_waitqueue_head(&sk->sk_lock.wq); \
807 spin_lock_init(&(sk)->sk_lock.slock); \
808 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
809 sizeof((sk)->sk_lock)); \
810 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
812 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
815 extern void FASTCALL(lock_sock_nested(struct sock
*sk
, int subclass
));
817 static inline void lock_sock(struct sock
*sk
)
819 lock_sock_nested(sk
, 0);
822 extern void FASTCALL(release_sock(struct sock
*sk
));
824 /* BH context may only use the following locking interface. */
825 #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
826 #define bh_lock_sock_nested(__sk) \
827 spin_lock_nested(&((__sk)->sk_lock.slock), \
828 SINGLE_DEPTH_NESTING)
829 #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
831 extern struct sock
*sk_alloc(struct net
*net
, int family
,
834 extern void sk_free(struct sock
*sk
);
835 extern struct sock
*sk_clone(const struct sock
*sk
,
836 const gfp_t priority
);
838 extern struct sk_buff
*sock_wmalloc(struct sock
*sk
,
839 unsigned long size
, int force
,
841 extern struct sk_buff
*sock_rmalloc(struct sock
*sk
,
842 unsigned long size
, int force
,
844 extern void sock_wfree(struct sk_buff
*skb
);
845 extern void sock_rfree(struct sk_buff
*skb
);
847 extern int sock_setsockopt(struct socket
*sock
, int level
,
848 int op
, char __user
*optval
,
851 extern int sock_getsockopt(struct socket
*sock
, int level
,
852 int op
, char __user
*optval
,
854 extern struct sk_buff
*sock_alloc_send_skb(struct sock
*sk
,
858 extern void *sock_kmalloc(struct sock
*sk
, int size
,
860 extern void sock_kfree_s(struct sock
*sk
, void *mem
, int size
);
861 extern void sk_send_sigurg(struct sock
*sk
);
864 * Functions to fill in entries in struct proto_ops when a protocol
865 * does not implement a particular function.
867 extern int sock_no_bind(struct socket
*,
868 struct sockaddr
*, int);
869 extern int sock_no_connect(struct socket
*,
870 struct sockaddr
*, int, int);
871 extern int sock_no_socketpair(struct socket
*,
873 extern int sock_no_accept(struct socket
*,
874 struct socket
*, int);
875 extern int sock_no_getname(struct socket
*,
876 struct sockaddr
*, int *, int);
877 extern unsigned int sock_no_poll(struct file
*, struct socket
*,
878 struct poll_table_struct
*);
879 extern int sock_no_ioctl(struct socket
*, unsigned int,
881 extern int sock_no_listen(struct socket
*, int);
882 extern int sock_no_shutdown(struct socket
*, int);
883 extern int sock_no_getsockopt(struct socket
*, int , int,
884 char __user
*, int __user
*);
885 extern int sock_no_setsockopt(struct socket
*, int, int,
887 extern int sock_no_sendmsg(struct kiocb
*, struct socket
*,
888 struct msghdr
*, size_t);
889 extern int sock_no_recvmsg(struct kiocb
*, struct socket
*,
890 struct msghdr
*, size_t, int);
891 extern int sock_no_mmap(struct file
*file
,
893 struct vm_area_struct
*vma
);
894 extern ssize_t
sock_no_sendpage(struct socket
*sock
,
896 int offset
, size_t size
,
900 * Functions to fill in entries in struct proto_ops when a protocol
901 * uses the inet style.
903 extern int sock_common_getsockopt(struct socket
*sock
, int level
, int optname
,
904 char __user
*optval
, int __user
*optlen
);
905 extern int sock_common_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
906 struct msghdr
*msg
, size_t size
, int flags
);
907 extern int sock_common_setsockopt(struct socket
*sock
, int level
, int optname
,
908 char __user
*optval
, int optlen
);
909 extern int compat_sock_common_getsockopt(struct socket
*sock
, int level
,
910 int optname
, char __user
*optval
, int __user
*optlen
);
911 extern int compat_sock_common_setsockopt(struct socket
*sock
, int level
,
912 int optname
, char __user
*optval
, int optlen
);
914 extern void sk_common_release(struct sock
*sk
);
917 * Default socket callbacks and setup code
920 /* Initialise core socket variables */
921 extern void sock_init_data(struct socket
*sock
, struct sock
*sk
);
924 * sk_filter - run a packet through a socket filter
925 * @sk: sock associated with &sk_buff
926 * @skb: buffer to filter
927 * @needlock: set to 1 if the sock is not locked by caller.
929 * Run the filter code and then cut skb->data to correct size returned by
930 * sk_run_filter. If pkt_len is 0 we toss packet. If skb->len is smaller
931 * than pkt_len we keep whole skb->data. This is the socket level
932 * wrapper to sk_run_filter. It returns 0 if the packet should
933 * be accepted or -EPERM if the packet should be tossed.
937 static inline int sk_filter(struct sock
*sk
, struct sk_buff
*skb
)
940 struct sk_filter
*filter
;
942 err
= security_sock_rcv_skb(sk
, skb
);
947 filter
= sk
->sk_filter
;
949 unsigned int pkt_len
= sk_run_filter(skb
, filter
->insns
,
951 err
= pkt_len
? pskb_trim(skb
, pkt_len
) : -EPERM
;
953 rcu_read_unlock_bh();
959 * sk_filter_release: Release a socket filter
961 * @fp: filter to remove
963 * Remove a filter from a socket and release its resources.
966 static inline void sk_filter_release(struct sk_filter
*fp
)
968 if (atomic_dec_and_test(&fp
->refcnt
))
972 static inline void sk_filter_uncharge(struct sock
*sk
, struct sk_filter
*fp
)
974 unsigned int size
= sk_filter_len(fp
);
976 atomic_sub(size
, &sk
->sk_omem_alloc
);
977 sk_filter_release(fp
);
980 static inline void sk_filter_charge(struct sock
*sk
, struct sk_filter
*fp
)
982 atomic_inc(&fp
->refcnt
);
983 atomic_add(sk_filter_len(fp
), &sk
->sk_omem_alloc
);
987 * Socket reference counting postulates.
989 * * Each user of socket SHOULD hold a reference count.
990 * * Each access point to socket (an hash table bucket, reference from a list,
991 * running timer, skb in flight MUST hold a reference count.
992 * * When reference count hits 0, it means it will never increase back.
993 * * When reference count hits 0, it means that no references from
994 * outside exist to this socket and current process on current CPU
995 * is last user and may/should destroy this socket.
996 * * sk_free is called from any context: process, BH, IRQ. When
997 * it is called, socket has no references from outside -> sk_free
998 * may release descendant resources allocated by the socket, but
999 * to the time when it is called, socket is NOT referenced by any
1000 * hash tables, lists etc.
1001 * * Packets, delivered from outside (from network or from another process)
1002 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1003 * when they sit in queue. Otherwise, packets will leak to hole, when
1004 * socket is looked up by one cpu and unhasing is made by another CPU.
1005 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1006 * (leak to backlog). Packet socket does all the processing inside
1007 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1008 * use separate SMP lock, so that they are prone too.
1011 /* Ungrab socket and destroy it, if it was the last reference. */
1012 static inline void sock_put(struct sock
*sk
)
1014 if (atomic_dec_and_test(&sk
->sk_refcnt
))
1018 extern int sk_receive_skb(struct sock
*sk
, struct sk_buff
*skb
,
1021 /* Detach socket from process context.
1022 * Announce socket dead, detach it from wait queue and inode.
1023 * Note that parent inode held reference count on this struct sock,
1024 * we do not release it in this function, because protocol
1025 * probably wants some additional cleanups or even continuing
1026 * to work with this socket (TCP).
1028 static inline void sock_orphan(struct sock
*sk
)
1030 write_lock_bh(&sk
->sk_callback_lock
);
1031 sock_set_flag(sk
, SOCK_DEAD
);
1032 sk
->sk_socket
= NULL
;
1033 sk
->sk_sleep
= NULL
;
1034 write_unlock_bh(&sk
->sk_callback_lock
);
1037 static inline void sock_graft(struct sock
*sk
, struct socket
*parent
)
1039 write_lock_bh(&sk
->sk_callback_lock
);
1040 sk
->sk_sleep
= &parent
->wait
;
1042 sk
->sk_socket
= parent
;
1043 security_sock_graft(sk
, parent
);
1044 write_unlock_bh(&sk
->sk_callback_lock
);
1047 extern int sock_i_uid(struct sock
*sk
);
1048 extern unsigned long sock_i_ino(struct sock
*sk
);
1050 static inline struct dst_entry
*
1051 __sk_dst_get(struct sock
*sk
)
1053 return sk
->sk_dst_cache
;
1056 static inline struct dst_entry
*
1057 sk_dst_get(struct sock
*sk
)
1059 struct dst_entry
*dst
;
1061 read_lock(&sk
->sk_dst_lock
);
1062 dst
= sk
->sk_dst_cache
;
1065 read_unlock(&sk
->sk_dst_lock
);
1070 __sk_dst_set(struct sock
*sk
, struct dst_entry
*dst
)
1072 struct dst_entry
*old_dst
;
1074 old_dst
= sk
->sk_dst_cache
;
1075 sk
->sk_dst_cache
= dst
;
1076 dst_release(old_dst
);
1080 sk_dst_set(struct sock
*sk
, struct dst_entry
*dst
)
1082 write_lock(&sk
->sk_dst_lock
);
1083 __sk_dst_set(sk
, dst
);
1084 write_unlock(&sk
->sk_dst_lock
);
1088 __sk_dst_reset(struct sock
*sk
)
1090 struct dst_entry
*old_dst
;
1092 old_dst
= sk
->sk_dst_cache
;
1093 sk
->sk_dst_cache
= NULL
;
1094 dst_release(old_dst
);
1098 sk_dst_reset(struct sock
*sk
)
1100 write_lock(&sk
->sk_dst_lock
);
1102 write_unlock(&sk
->sk_dst_lock
);
1105 extern struct dst_entry
*__sk_dst_check(struct sock
*sk
, u32 cookie
);
1107 extern struct dst_entry
*sk_dst_check(struct sock
*sk
, u32 cookie
);
1109 static inline int sk_can_gso(const struct sock
*sk
)
1111 return net_gso_ok(sk
->sk_route_caps
, sk
->sk_gso_type
);
1114 extern void sk_setup_caps(struct sock
*sk
, struct dst_entry
*dst
);
1116 static inline void sk_charge_skb(struct sock
*sk
, struct sk_buff
*skb
)
1118 sk
->sk_wmem_queued
+= skb
->truesize
;
1119 sk
->sk_forward_alloc
-= skb
->truesize
;
1122 static inline int skb_copy_to_page(struct sock
*sk
, char __user
*from
,
1123 struct sk_buff
*skb
, struct page
*page
,
1126 if (skb
->ip_summed
== CHECKSUM_NONE
) {
1128 __wsum csum
= csum_and_copy_from_user(from
,
1129 page_address(page
) + off
,
1133 skb
->csum
= csum_block_add(skb
->csum
, csum
, skb
->len
);
1134 } else if (copy_from_user(page_address(page
) + off
, from
, copy
))
1138 skb
->data_len
+= copy
;
1139 skb
->truesize
+= copy
;
1140 sk
->sk_wmem_queued
+= copy
;
1141 sk
->sk_forward_alloc
-= copy
;
1146 * Queue a received datagram if it will fit. Stream and sequenced
1147 * protocols can't normally use this as they need to fit buffers in
1148 * and play with them.
1150 * Inlined as it's very short and called for pretty much every
1151 * packet ever received.
1154 static inline void skb_set_owner_w(struct sk_buff
*skb
, struct sock
*sk
)
1158 skb
->destructor
= sock_wfree
;
1159 atomic_add(skb
->truesize
, &sk
->sk_wmem_alloc
);
1162 static inline void skb_set_owner_r(struct sk_buff
*skb
, struct sock
*sk
)
1165 skb
->destructor
= sock_rfree
;
1166 atomic_add(skb
->truesize
, &sk
->sk_rmem_alloc
);
1169 extern void sk_reset_timer(struct sock
*sk
, struct timer_list
* timer
,
1170 unsigned long expires
);
1172 extern void sk_stop_timer(struct sock
*sk
, struct timer_list
* timer
);
1174 extern int sock_queue_rcv_skb(struct sock
*sk
, struct sk_buff
*skb
);
1176 static inline int sock_queue_err_skb(struct sock
*sk
, struct sk_buff
*skb
)
1178 /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces
1179 number of warnings when compiling with -W --ANK
1181 if (atomic_read(&sk
->sk_rmem_alloc
) + skb
->truesize
>=
1182 (unsigned)sk
->sk_rcvbuf
)
1184 skb_set_owner_r(skb
, sk
);
1185 skb_queue_tail(&sk
->sk_error_queue
, skb
);
1186 if (!sock_flag(sk
, SOCK_DEAD
))
1187 sk
->sk_data_ready(sk
, skb
->len
);
1192 * Recover an error report and clear atomically
1195 static inline int sock_error(struct sock
*sk
)
1198 if (likely(!sk
->sk_err
))
1200 err
= xchg(&sk
->sk_err
, 0);
1204 static inline unsigned long sock_wspace(struct sock
*sk
)
1208 if (!(sk
->sk_shutdown
& SEND_SHUTDOWN
)) {
1209 amt
= sk
->sk_sndbuf
- atomic_read(&sk
->sk_wmem_alloc
);
1216 static inline void sk_wake_async(struct sock
*sk
, int how
, int band
)
1218 if (sk
->sk_socket
&& sk
->sk_socket
->fasync_list
)
1219 sock_wake_async(sk
->sk_socket
, how
, band
);
1222 #define SOCK_MIN_SNDBUF 2048
1223 #define SOCK_MIN_RCVBUF 256
1225 static inline void sk_stream_moderate_sndbuf(struct sock
*sk
)
1227 if (!(sk
->sk_userlocks
& SOCK_SNDBUF_LOCK
)) {
1228 sk
->sk_sndbuf
= min(sk
->sk_sndbuf
, sk
->sk_wmem_queued
/ 2);
1229 sk
->sk_sndbuf
= max(sk
->sk_sndbuf
, SOCK_MIN_SNDBUF
);
1233 static inline struct sk_buff
*sk_stream_alloc_pskb(struct sock
*sk
,
1237 struct sk_buff
*skb
;
1239 skb
= alloc_skb_fclone(size
+ sk
->sk_prot
->max_header
, gfp
);
1241 skb
->truesize
+= mem
;
1242 if (sk_stream_wmem_schedule(sk
, skb
->truesize
)) {
1244 * Make sure that we have exactly size bytes
1245 * available to the caller, no more, no less.
1247 skb_reserve(skb
, skb_tailroom(skb
) - size
);
1252 sk
->sk_prot
->enter_memory_pressure();
1253 sk_stream_moderate_sndbuf(sk
);
1258 static inline struct sk_buff
*sk_stream_alloc_skb(struct sock
*sk
,
1262 return sk_stream_alloc_pskb(sk
, size
, 0, gfp
);
1265 static inline struct page
*sk_stream_alloc_page(struct sock
*sk
)
1267 struct page
*page
= NULL
;
1269 page
= alloc_pages(sk
->sk_allocation
, 0);
1271 sk
->sk_prot
->enter_memory_pressure();
1272 sk_stream_moderate_sndbuf(sk
);
1278 * Default write policy as shown to user space via poll/select/SIGIO
1280 static inline int sock_writeable(const struct sock
*sk
)
1282 return atomic_read(&sk
->sk_wmem_alloc
) < (sk
->sk_sndbuf
/ 2);
1285 static inline gfp_t
gfp_any(void)
1287 return in_atomic() ? GFP_ATOMIC
: GFP_KERNEL
;
1290 static inline long sock_rcvtimeo(const struct sock
*sk
, int noblock
)
1292 return noblock
? 0 : sk
->sk_rcvtimeo
;
1295 static inline long sock_sndtimeo(const struct sock
*sk
, int noblock
)
1297 return noblock
? 0 : sk
->sk_sndtimeo
;
1300 static inline int sock_rcvlowat(const struct sock
*sk
, int waitall
, int len
)
1302 return (waitall
? len
: min_t(int, sk
->sk_rcvlowat
, len
)) ? : 1;
1305 /* Alas, with timeout socket operations are not restartable.
1306 * Compare this to poll().
1308 static inline int sock_intr_errno(long timeo
)
1310 return timeo
== MAX_SCHEDULE_TIMEOUT
? -ERESTARTSYS
: -EINTR
;
1313 extern void __sock_recv_timestamp(struct msghdr
*msg
, struct sock
*sk
,
1314 struct sk_buff
*skb
);
1316 static __inline__
void
1317 sock_recv_timestamp(struct msghdr
*msg
, struct sock
*sk
, struct sk_buff
*skb
)
1319 ktime_t kt
= skb
->tstamp
;
1321 if (sock_flag(sk
, SOCK_RCVTSTAMP
))
1322 __sock_recv_timestamp(msg
, sk
, skb
);
1328 * sk_eat_skb - Release a skb if it is no longer needed
1329 * @sk: socket to eat this skb from
1330 * @skb: socket buffer to eat
1331 * @copied_early: flag indicating whether DMA operations copied this data early
1333 * This routine must be called with interrupts disabled or with the socket
1334 * locked so that the sk_buff queue operation is ok.
1336 #ifdef CONFIG_NET_DMA
1337 static inline void sk_eat_skb(struct sock
*sk
, struct sk_buff
*skb
, int copied_early
)
1339 __skb_unlink(skb
, &sk
->sk_receive_queue
);
1343 __skb_queue_tail(&sk
->sk_async_wait_queue
, skb
);
1346 static inline void sk_eat_skb(struct sock
*sk
, struct sk_buff
*skb
, int copied_early
)
1348 __skb_unlink(skb
, &sk
->sk_receive_queue
);
1353 extern void sock_enable_timestamp(struct sock
*sk
);
1354 extern int sock_get_timestamp(struct sock
*, struct timeval __user
*);
1355 extern int sock_get_timestampns(struct sock
*, struct timespec __user
*);
1358 * Enable debug/info messages
1360 extern int net_msg_warn
;
1361 #define NETDEBUG(fmt, args...) \
1362 do { if (net_msg_warn) printk(fmt,##args); } while (0)
1364 #define LIMIT_NETDEBUG(fmt, args...) \
1365 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
1368 * Macros for sleeping on a socket. Use them like this:
1370 * SOCK_SLEEP_PRE(sk)
1373 * SOCK_SLEEP_POST(sk)
1375 * N.B. These are now obsolete and were, afaik, only ever used in DECnet
1376 * and when the last use of them in DECnet has gone, I'm intending to
1380 #define SOCK_SLEEP_PRE(sk) { struct task_struct *tsk = current; \
1381 DECLARE_WAITQUEUE(wait, tsk); \
1382 tsk->state = TASK_INTERRUPTIBLE; \
1383 add_wait_queue((sk)->sk_sleep, &wait); \
1386 #define SOCK_SLEEP_POST(sk) tsk->state = TASK_RUNNING; \
1387 remove_wait_queue((sk)->sk_sleep, &wait); \
1391 static inline void sock_valbool_flag(struct sock
*sk
, int bit
, int valbool
)
1394 sock_set_flag(sk
, bit
);
1396 sock_reset_flag(sk
, bit
);
1399 extern __u32 sysctl_wmem_max
;
1400 extern __u32 sysctl_rmem_max
;
1402 extern void sk_init(void);
1404 #ifdef CONFIG_SYSCTL
1405 extern struct ctl_table core_table
[];
1408 extern int sysctl_optmem_max
;
1410 extern __u32 sysctl_wmem_default
;
1411 extern __u32 sysctl_rmem_default
;
1413 #endif /* _SOCK_H */