4 * Generic datagram handling routines. These are generic for all
5 * protocols. Possibly a generic IP version on top of these would
6 * make sense. Not tonight however 8-).
7 * This is used because UDP, RAW, PACKET, DDP, IPX, AX.25 and
8 * NetROM layer all have identical poll code and mostly
9 * identical recvmsg() code. So we share it here. The poll was
10 * shared before but buried in udp.c so I moved it.
12 * Authors: Alan Cox <alan@lxorguk.ukuu.org.uk>. (datagram_poll() from old
16 * Alan Cox : NULL return from skb_peek_copy()
18 * Alan Cox : Rewrote skb_read_datagram to avoid the
19 * skb_peek_copy stuff.
20 * Alan Cox : Added support for SOCK_SEQPACKET.
21 * IPX can no longer use the SO_TYPE hack
22 * but AX.25 now works right, and SPX is
24 * Alan Cox : Fixed write poll of non IP protocol
26 * Florian La Roche: Changed for my new skbuff handling.
27 * Darryl Miles : Fixed non-blocking SOCK_SEQPACKET.
28 * Linus Torvalds : BSD semantic fixes.
29 * Alan Cox : Datagram iovec handling
30 * Darryl Miles : Fixed non-blocking SOCK_STREAM.
31 * Alan Cox : POSIXisms
32 * Pete Wyckoff : Unconnected accept() fix.
36 #include <linux/module.h>
37 #include <linux/types.h>
38 #include <linux/kernel.h>
39 #include <asm/uaccess.h>
40 #include <asm/system.h>
42 #include <linux/interrupt.h>
43 #include <linux/errno.h>
44 #include <linux/sched.h>
45 #include <linux/inet.h>
46 #include <linux/netdevice.h>
47 #include <linux/rtnetlink.h>
48 #include <linux/poll.h>
49 #include <linux/highmem.h>
50 #include <linux/spinlock.h>
52 #include <net/protocol.h>
53 #include <linux/skbuff.h>
55 #include <net/checksum.h>
57 #include <net/tcp_states.h>
60 * Is a socket 'connection oriented' ?
62 static inline int connection_based(struct sock *sk)
64 return sk->sk_type == SOCK_SEQPACKET || sk->sk_type == SOCK_STREAM;
70 static int wait_for_packet(struct sock *sk, int *err, long *timeo_p)
75 prepare_to_wait_exclusive(sk->sk_sleep, &wait, TASK_INTERRUPTIBLE);
78 error = sock_error(sk);
82 if (!skb_queue_empty(&sk->sk_receive_queue))
85 /* Socket shut down? */
86 if (sk->sk_shutdown & RCV_SHUTDOWN)
89 /* Sequenced packets can come disconnected.
90 * If so we report the problem
93 if (connection_based(sk) &&
94 !(sk->sk_state == TCP_ESTABLISHED || sk->sk_state == TCP_LISTEN))
98 if (signal_pending(current))
102 *timeo_p = schedule_timeout(*timeo_p);
104 finish_wait(sk->sk_sleep, &wait);
107 error = sock_intr_errno(*timeo_p);
118 * __skb_recv_datagram - Receive a datagram skbuff
121 * @peeked: returns non-zero if this packet has been seen before
122 * @err: error code returned
124 * Get a datagram skbuff, understands the peeking, nonblocking wakeups
125 * and possible races. This replaces identical code in packet, raw and
126 * udp, as well as the IPX AX.25 and Appletalk. It also finally fixes
127 * the long standing peek and read race for datagram sockets. If you
128 * alter this routine remember it must be re-entrant.
130 * This function will lock the socket if a skb is returned, so the caller
131 * needs to unlock the socket in that case (usually by calling
134 * * It does not lock socket since today. This function is
135 * * free of race conditions. This measure should/can improve
136 * * significantly datagram socket latencies at high loads,
137 * * when data copying to user space takes lots of time.
138 * * (BTW I've just killed the last cli() in IP/IPv6/core/netlink/packet
142 * The order of the tests when we find no data waiting are specified
143 * quite explicitly by POSIX 1003.1g, don't change them without having
144 * the standard around please.
146 struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
147 int *peeked, int *err)
152 * Caller is allowed not to check sk->sk_err before skb_recv_datagram()
154 int error = sock_error(sk);
159 timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
162 /* Again only user level code calls this function, so nothing
163 * interrupt level will suddenly eat the receive_queue.
165 * Look at current nfs client by the way...
166 * However, this function was corrent in any case. 8)
168 unsigned long cpu_flags;
170 spin_lock_irqsave(&sk->sk_receive_queue.lock, cpu_flags);
171 skb = skb_peek(&sk->sk_receive_queue);
173 *peeked = skb->peeked;
174 if (flags & MSG_PEEK) {
176 atomic_inc(&skb->users);
178 __skb_unlink(skb, &sk->sk_receive_queue);
180 spin_unlock_irqrestore(&sk->sk_receive_queue.lock, cpu_flags);
185 /* User doesn't want to wait */
190 } while (!wait_for_packet(sk, err, &timeo));
198 EXPORT_SYMBOL(__skb_recv_datagram);
200 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
201 int noblock, int *err)
205 return __skb_recv_datagram(sk, flags | (noblock ? MSG_DONTWAIT : 0),
209 void skb_free_datagram(struct sock *sk, struct sk_buff *skb)
212 sk_mem_reclaim_partial(sk);
216 * skb_kill_datagram - Free a datagram skbuff forcibly
218 * @skb: datagram skbuff
221 * This function frees a datagram skbuff that was received by
222 * skb_recv_datagram. The flags argument must match the one
223 * used for skb_recv_datagram.
225 * If the MSG_PEEK flag is set, and the packet is still on the
226 * receive queue of the socket, it will be taken off the queue
227 * before it is freed.
229 * This function currently only disables BH when acquiring the
230 * sk_receive_queue lock. Therefore it must not be used in a
231 * context where that lock is acquired in an IRQ context.
233 * It returns 0 if the packet was removed by us.
236 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags)
240 if (flags & MSG_PEEK) {
242 spin_lock_bh(&sk->sk_receive_queue.lock);
243 if (skb == skb_peek(&sk->sk_receive_queue)) {
244 __skb_unlink(skb, &sk->sk_receive_queue);
245 atomic_dec(&skb->users);
248 spin_unlock_bh(&sk->sk_receive_queue.lock);
251 skb_free_datagram(sk, skb);
255 EXPORT_SYMBOL(skb_kill_datagram);
258 * skb_copy_datagram_iovec - Copy a datagram to an iovec.
259 * @skb: buffer to copy
260 * @offset: offset in the buffer to start copying from
261 * @to: io vector to copy to
262 * @len: amount of data to copy from buffer to iovec
264 * Note: the iovec is modified during the copy.
266 int skb_copy_datagram_iovec(const struct sk_buff *skb, int offset,
267 struct iovec *to, int len)
269 int start = skb_headlen(skb);
270 int i, copy = start - offset;
276 if (memcpy_toiovec(to, skb->data + offset, copy))
278 if ((len -= copy) == 0)
283 /* Copy paged appendix. Hmm... why does this look so complicated? */
284 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
287 WARN_ON(start > offset + len);
289 end = start + skb_shinfo(skb)->frags[i].size;
290 if ((copy = end - offset) > 0) {
293 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
294 struct page *page = frag->page;
299 err = memcpy_toiovec(to, vaddr + frag->page_offset +
300 offset - start, copy);
311 if (skb_shinfo(skb)->frag_list) {
312 struct sk_buff *list = skb_shinfo(skb)->frag_list;
314 for (; list; list = list->next) {
317 WARN_ON(start > offset + len);
319 end = start + list->len;
320 if ((copy = end - offset) > 0) {
323 if (skb_copy_datagram_iovec(list,
327 if ((len -= copy) == 0)
342 * skb_copy_datagram_from_iovec - Copy a datagram from an iovec.
343 * @skb: buffer to copy
344 * @offset: offset in the buffer to start copying to
345 * @from: io vector to copy to
346 * @len: amount of data to copy to buffer from iovec
348 * Returns 0 or -EFAULT.
349 * Note: the iovec is modified during the copy.
351 int skb_copy_datagram_from_iovec(struct sk_buff *skb, int offset,
352 struct iovec *from, int len)
354 int start = skb_headlen(skb);
355 int i, copy = start - offset;
361 if (memcpy_fromiovec(skb->data + offset, from, copy))
363 if ((len -= copy) == 0)
368 /* Copy paged appendix. Hmm... why does this look so complicated? */
369 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
372 WARN_ON(start > offset + len);
374 end = start + skb_shinfo(skb)->frags[i].size;
375 if ((copy = end - offset) > 0) {
378 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
379 struct page *page = frag->page;
384 err = memcpy_fromiovec(vaddr + frag->page_offset +
385 offset - start, from, copy);
397 if (skb_shinfo(skb)->frag_list) {
398 struct sk_buff *list = skb_shinfo(skb)->frag_list;
400 for (; list; list = list->next) {
403 WARN_ON(start > offset + len);
405 end = start + list->len;
406 if ((copy = end - offset) > 0) {
409 if (skb_copy_datagram_from_iovec(list,
413 if ((len -= copy) == 0)
426 EXPORT_SYMBOL(skb_copy_datagram_from_iovec);
428 static int skb_copy_and_csum_datagram(const struct sk_buff *skb, int offset,
429 u8 __user *to, int len,
432 int start = skb_headlen(skb);
434 int i, copy = start - offset;
441 *csump = csum_and_copy_to_user(skb->data + offset, to, copy,
445 if ((len -= copy) == 0)
452 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
455 WARN_ON(start > offset + len);
457 end = start + skb_shinfo(skb)->frags[i].size;
458 if ((copy = end - offset) > 0) {
462 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
463 struct page *page = frag->page;
468 csum2 = csum_and_copy_to_user(vaddr +
475 *csump = csum_block_add(*csump, csum2, pos);
485 if (skb_shinfo(skb)->frag_list) {
486 struct sk_buff *list = skb_shinfo(skb)->frag_list;
488 for (; list; list=list->next) {
491 WARN_ON(start > offset + len);
493 end = start + list->len;
494 if ((copy = end - offset) > 0) {
498 if (skb_copy_and_csum_datagram(list,
503 *csump = csum_block_add(*csump, csum2, pos);
504 if ((len -= copy) == 0)
520 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len)
524 sum = csum_fold(skb_checksum(skb, 0, len, skb->csum));
526 if (unlikely(skb->ip_summed == CHECKSUM_COMPLETE))
527 netdev_rx_csum_fault(skb->dev);
528 skb->ip_summed = CHECKSUM_UNNECESSARY;
532 EXPORT_SYMBOL(__skb_checksum_complete_head);
534 __sum16 __skb_checksum_complete(struct sk_buff *skb)
536 return __skb_checksum_complete_head(skb, skb->len);
538 EXPORT_SYMBOL(__skb_checksum_complete);
541 * skb_copy_and_csum_datagram_iovec - Copy and checkum skb to user iovec.
543 * @hlen: hardware length
546 * Caller _must_ check that skb will fit to this iovec.
548 * Returns: 0 - success.
549 * -EINVAL - checksum failure.
550 * -EFAULT - fault during copy. Beware, in this case iovec
553 int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
554 int hlen, struct iovec *iov)
557 int chunk = skb->len - hlen;
562 /* Skip filled elements.
563 * Pretty silly, look at memcpy_toiovec, though 8)
565 while (!iov->iov_len)
568 if (iov->iov_len < chunk) {
569 if (__skb_checksum_complete(skb))
571 if (skb_copy_datagram_iovec(skb, hlen, iov, chunk))
574 csum = csum_partial(skb->data, hlen, skb->csum);
575 if (skb_copy_and_csum_datagram(skb, hlen, iov->iov_base,
580 if (unlikely(skb->ip_summed == CHECKSUM_COMPLETE))
581 netdev_rx_csum_fault(skb->dev);
582 iov->iov_len -= chunk;
583 iov->iov_base += chunk;
593 * datagram_poll - generic datagram poll
598 * Datagram poll: Again totally generic. This also handles
599 * sequenced packet sockets providing the socket receive queue
600 * is only ever holding data ready to receive.
602 * Note: when you _don't_ use this routine for this protocol,
603 * and you use a different write policy from sock_writeable()
604 * then please supply your own write_space callback.
606 unsigned int datagram_poll(struct file *file, struct socket *sock,
609 struct sock *sk = sock->sk;
612 poll_wait(file, sk->sk_sleep, wait);
615 /* exceptional events? */
616 if (sk->sk_err || !skb_queue_empty(&sk->sk_error_queue))
618 if (sk->sk_shutdown & RCV_SHUTDOWN)
620 if (sk->sk_shutdown == SHUTDOWN_MASK)
624 if (!skb_queue_empty(&sk->sk_receive_queue) ||
625 (sk->sk_shutdown & RCV_SHUTDOWN))
626 mask |= POLLIN | POLLRDNORM;
628 /* Connection-based need to check for termination and startup */
629 if (connection_based(sk)) {
630 if (sk->sk_state == TCP_CLOSE)
632 /* connection hasn't started yet? */
633 if (sk->sk_state == TCP_SYN_SENT)
638 if (sock_writeable(sk))
639 mask |= POLLOUT | POLLWRNORM | POLLWRBAND;
641 set_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags);
646 EXPORT_SYMBOL(datagram_poll);
647 EXPORT_SYMBOL(skb_copy_and_csum_datagram_iovec);
648 EXPORT_SYMBOL(skb_copy_datagram_iovec);
649 EXPORT_SYMBOL(skb_free_datagram);
650 EXPORT_SYMBOL(skb_recv_datagram);