cregit-Linux how code gets into the kernel

Release 4.14 net/core/datagram.c

Directory: net/core
// SPDX-License-Identifier: GPL-2.0
/*
 *      SUCS NET3:
 *
 *      Generic datagram handling routines. These are generic for all
 *      protocols. Possibly a generic IP version on top of these would
 *      make sense. Not tonight however 8-).
 *      This is used because UDP, RAW, PACKET, DDP, IPX, AX.25 and
 *      NetROM layer all have identical poll code and mostly
 *      identical recvmsg() code. So we share it here. The poll was
 *      shared before but buried in udp.c so I moved it.
 *
 *      Authors:        Alan Cox <alan@lxorguk.ukuu.org.uk>. (datagram_poll() from old
 *                                                   udp.c code)
 *
 *      Fixes:
 *              Alan Cox        :       NULL return from skb_peek_copy()
 *                                      understood
 *              Alan Cox        :       Rewrote skb_read_datagram to avoid the
 *                                      skb_peek_copy stuff.
 *              Alan Cox        :       Added support for SOCK_SEQPACKET.
 *                                      IPX can no longer use the SO_TYPE hack
 *                                      but AX.25 now works right, and SPX is
 *                                      feasible.
 *              Alan Cox        :       Fixed write poll of non IP protocol
 *                                      crash.
 *              Florian  La Roche:      Changed for my new skbuff handling.
 *              Darryl Miles    :       Fixed non-blocking SOCK_SEQPACKET.
 *              Linus Torvalds  :       BSD semantic fixes.
 *              Alan Cox        :       Datagram iovec handling
 *              Darryl Miles    :       Fixed non-blocking SOCK_STREAM.
 *              Alan Cox        :       POSIXisms
 *              Pete Wyckoff    :       Unconnected accept() fix.
 *
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/uaccess.h>
#include <linux/mm.h>
#include <linux/interrupt.h>
#include <linux/errno.h>
#include <linux/sched.h>
#include <linux/inet.h>
#include <linux/netdevice.h>
#include <linux/rtnetlink.h>
#include <linux/poll.h>
#include <linux/highmem.h>
#include <linux/spinlock.h>
#include <linux/slab.h>
#include <linux/pagemap.h>
#include <linux/uio.h>

#include <net/protocol.h>
#include <linux/skbuff.h>

#include <net/checksum.h>
#include <net/sock.h>
#include <net/tcp_states.h>
#include <trace/events/skb.h>
#include <net/busy_poll.h>

/*
 *      Is a socket 'connection oriented' ?
 */

static inline int connection_based(struct sock *sk) { return sk->sk_type == SOCK_SEQPACKET || sk->sk_type == SOCK_STREAM; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)2392.00%266.67%
Arnaldo Carvalho de Melo28.00%133.33%
Total25100.00%3100.00%


static int receiver_wake_function(wait_queue_entry_t *wait, unsigned int mode, int sync, void *key) { unsigned long bits = (unsigned long)key; /* * Avoid a wakeup if event not interesting for us */ if (bits && !(bits & (POLLIN | POLLERR))) return 0; return autoremove_wake_function(wait, mode, sync, key); }

Contributors

PersonTokensPropCommitsCommitProp
Eric Dumazet6198.39%266.67%
Ingo Molnar11.61%133.33%
Total62100.00%3100.00%

/* * Wait for the last received packet to be different from skb */
int __skb_wait_for_more_packets(struct sock *sk, int *err, long *timeo_p, const struct sk_buff *skb) { int error; DEFINE_WAIT_FUNC(wait, receiver_wake_function); prepare_to_wait_exclusive(sk_sleep(sk), &wait, TASK_INTERRUPTIBLE); /* Socket errors? */ error = sock_error(sk); if (error) goto out_err; if (sk->sk_receive_queue.prev != skb) goto out; /* Socket shut down? */ if (sk->sk_shutdown & RCV_SHUTDOWN) goto out_noerr; /* Sequenced packets can come disconnected. * If so we report the problem */ error = -ENOTCONN; if (connection_based(sk) && !(sk->sk_state == TCP_ESTABLISHED || sk->sk_state == TCP_LISTEN)) goto out_err; /* handle signals */ if (signal_pending(current)) goto interrupted; error = 0; *timeo_p = schedule_timeout(*timeo_p); out: finish_wait(sk_sleep(sk), &wait); return error; interrupted: error = sock_intr_errno(*timeo_p); out_err: *err = error; goto out; out_noerr: *err = 0; error = 1; goto out; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)13369.27%1157.89%
Linus Torvalds199.90%15.26%
Arnaldo Carvalho de Melo168.33%210.53%
Benjamin Poirier105.21%15.26%
Eric Dumazet94.69%210.53%
Andrew Morton42.08%15.26%
Rainer Weikusat10.52%15.26%
Total192100.00%19100.00%

EXPORT_SYMBOL(__skb_wait_for_more_packets);
static struct sk_buff *skb_set_peeked(struct sk_buff *skb) { struct sk_buff *nskb; if (skb->peeked) return skb; /* We have to unshare an skb before modifying it. */ if (!skb_shared(skb)) goto done; nskb = skb_clone(skb, GFP_ATOMIC); if (!nskb) return ERR_PTR(-ENOMEM); skb->prev->next = nskb; skb->next->prev = nskb; nskb->prev = skb->prev; nskb->next = skb->next; consume_skb(skb); skb = nskb; done: skb->peeked = 1; return skb; }

Contributors

PersonTokensPropCommitsCommitProp
Herbert Xu112100.00%2100.00%
Total112100.00%2100.00%


struct sk_buff *__skb_try_recv_from_queue(struct sock *sk, struct sk_buff_head *queue, unsigned int flags, void (*destructor)(struct sock *sk, struct sk_buff *skb), int *peeked, int *off, int *err, struct sk_buff **last) { bool peek_at_off = false; struct sk_buff *skb; int _off = 0; if (unlikely(flags & MSG_PEEK && *off >= 0)) { peek_at_off = true; _off = *off; } *last = queue->prev; skb_queue_walk(queue, skb) { if (flags & MSG_PEEK) { if (peek_at_off && _off >= skb->len && (_off || skb->peeked)) { _off -= skb->len; continue; } if (!skb->len) { skb = skb_set_peeked(skb); if (unlikely(IS_ERR(skb))) { *err = PTR_ERR(skb); return NULL; } } *peeked = 1; refcount_inc(&skb->users); } else { __skb_unlink(skb, queue); if (destructor) destructor(sk, skb); } *off = _off; return skb; } return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Paolo Abeni5222.61%29.52%
Linus Torvalds (pre-git)3716.09%523.81%
Matthew Dawson3213.91%14.76%
Herbert Xu2912.61%314.29%
Pavel Emelyanov2611.30%29.52%
Eric Dumazet229.57%314.29%
Benjamin Poirier166.96%29.52%
Rainer Weikusat93.91%14.76%
Andrey Vagin62.61%14.76%
Elena Reshetova10.43%14.76%
Total230100.00%21100.00%

/** * __skb_try_recv_datagram - Receive a datagram skbuff * @sk: socket * @flags: MSG\_ flags * @destructor: invoked under the receive lock on successful dequeue * @peeked: returns non-zero if this packet has been seen before * @off: an offset in bytes to peek skb from. Returns an offset * within an skb where data actually starts * @err: error code returned * @last: set to last peeked message to inform the wait function * what to look for when peeking * * Get a datagram skbuff, understands the peeking, nonblocking wakeups * and possible races. This replaces identical code in packet, raw and * udp, as well as the IPX AX.25 and Appletalk. It also finally fixes * the long standing peek and read race for datagram sockets. If you * alter this routine remember it must be re-entrant. * * This function will lock the socket if a skb is returned, so * the caller needs to unlock the socket in that case (usually by * calling skb_free_datagram). Returns NULL with @err set to * -EAGAIN if no data was available or to some other value if an * error was detected. * * * It does not lock socket since today. This function is * * free of race conditions. This measure should/can improve * * significantly datagram socket latencies at high loads, * * when data copying to user space takes lots of time. * * (BTW I've just killed the last cli() in IP/IPv6/core/netlink/packet * * 8) Great win.) * * --ANK (980729) * * The order of the tests when we find no data waiting are specified * quite explicitly by POSIX 1003.1g, don't change them without having * the standard around please. */
struct sk_buff *__skb_try_recv_datagram(struct sock *sk, unsigned int flags, void (*destructor)(struct sock *sk, struct sk_buff *skb), int *peeked, int *off, int *err, struct sk_buff **last) { struct sk_buff_head *queue = &sk->sk_receive_queue; struct sk_buff *skb; unsigned long cpu_flags; /* * Caller is allowed not to check sk->sk_err before skb_recv_datagram() */ int error = sock_error(sk); if (error) goto no_packet; *peeked = 0; do { /* Again only user level code calls this function, so nothing * interrupt level will suddenly eat the receive_queue. * * Look at current nfs client by the way... * However, this function was correct in any case. 8) */ spin_lock_irqsave(&queue->lock, cpu_flags); skb = __skb_try_recv_from_queue(sk, queue, flags, destructor, peeked, off, &error, last); spin_unlock_irqrestore(&queue->lock, cpu_flags); if (error) goto no_packet; if (skb) return skb; if (!sk_can_busy_loop(sk)) break; sk_busy_loop(sk, flags & MSG_DONTWAIT); } while (!skb_queue_empty(&sk->sk_receive_queue)); error = -EAGAIN; no_packet: *err = error; return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Paolo Abeni11860.20%18.33%
Alexander Duyck168.16%18.33%
Eliezer Tamir147.14%216.67%
Rainer Weikusat126.12%18.33%
Pavel Emelyanov115.61%216.67%
Linus Torvalds (pre-git)105.10%216.67%
Andrey Vagin105.10%18.33%
Herbert Xu31.53%18.33%
Benjamin Poirier21.02%18.33%
Total196100.00%12100.00%

EXPORT_SYMBOL(__skb_try_recv_datagram);
struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned int flags, void (*destructor)(struct sock *sk, struct sk_buff *skb), int *peeked, int *off, int *err) { struct sk_buff *skb, *last; long timeo; timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT); do { skb = __skb_try_recv_datagram(sk, flags, destructor, peeked, off, err, &last); if (skb) return skb; if (*err != -EAGAIN) break; } while (timeo && !__skb_wait_for_more_packets(sk, err, &timeo, last)); return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Rainer Weikusat8566.93%222.22%
Linus Torvalds (pre-git)2015.75%444.44%
Paolo Abeni1914.96%111.11%
Benjamin Poirier21.57%111.11%
Arnaldo Carvalho de Melo10.79%111.11%
Total127100.00%9100.00%

EXPORT_SYMBOL(__skb_recv_datagram);
struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned int flags, int noblock, int *err) { int peeked, off = 0; return __skb_recv_datagram(sk, flags | (noblock ? MSG_DONTWAIT : 0), NULL, &peeked, &off, err); }

Contributors

PersonTokensPropCommitsCommitProp
Herbert Xu4682.14%125.00%
Pavel Emelyanov712.50%125.00%
Paolo Abeni23.57%125.00%
Eric Dumazet11.79%125.00%
Total56100.00%4100.00%

EXPORT_SYMBOL(skb_recv_datagram);
void skb_free_datagram(struct sock *sk, struct sk_buff *skb) { consume_skb(skb); sk_mem_reclaim_partial(sk); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)1976.00%240.00%
Hideo Aoki416.00%120.00%
Eric Dumazet14.00%120.00%
Neil Horman14.00%120.00%
Total25100.00%5100.00%

EXPORT_SYMBOL(skb_free_datagram);
void __skb_free_datagram_locked(struct sock *sk, struct sk_buff *skb, int len) { bool slow; if (!skb_unref(skb)) { sk_peek_offset_bwd(sk, len); return; } slow = lock_sock_fast(sk); sk_peek_offset_bwd(sk, len); skb_orphan(skb); sk_mem_reclaim_partial(sk); unlock_sock_fast(sk, slow); /* skb is now orphaned, can be freed outside of locked section */ __kfree_skb(skb); }

Contributors

PersonTokensPropCommitsCommitProp
Eric Dumazet5572.37%466.67%
samanthakumar2026.32%116.67%
Paolo Abeni11.32%116.67%
Total76100.00%6100.00%

EXPORT_SYMBOL(__skb_free_datagram_locked);
int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue, struct sk_buff *skb, unsigned int flags, void (*destructor)(struct sock *sk, struct sk_buff *skb)) { int err = 0; if (flags & MSG_PEEK) { err = -ENOENT; spin_lock_bh(&sk_queue->lock); if (skb->next) { __skb_unlink(skb, sk_queue); refcount_dec(&skb->users); if (destructor) destructor(sk, skb); err = 0; } spin_unlock_bh(&sk_queue->lock); } atomic_inc(&sk->sk_drops); return err; }

Contributors

PersonTokensPropCommitsCommitProp
Herbert Xu7258.06%225.00%
Eric Dumazet3830.65%337.50%
Paolo Abeni1310.48%225.00%
Elena Reshetova10.81%112.50%
Total124100.00%8100.00%

EXPORT_SYMBOL(__sk_queue_drop_skb); /** * skb_kill_datagram - Free a datagram skbuff forcibly * @sk: socket * @skb: datagram skbuff * @flags: MSG\_ flags * * This function frees a datagram skbuff that was received by * skb_recv_datagram. The flags argument must match the one * used for skb_recv_datagram. * * If the MSG_PEEK flag is set, and the packet is still on the * receive queue of the socket, it will be taken off the queue * before it is freed. * * This function currently only disables BH when acquiring the * sk_receive_queue lock. Therefore it must not be used in a * context where that lock is acquired in an IRQ context. * * It returns 0 if the packet was removed by us. */
int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags) { int err = __sk_queue_drop_skb(sk, &sk->sk_receive_queue, skb, flags, NULL); kfree_skb(skb); sk_mem_reclaim_partial(sk); return err; }

Contributors

PersonTokensPropCommitsCommitProp
Paolo Abeni4078.43%233.33%
John Dykstra59.80%116.67%
Herbert Xu47.84%233.33%
Eric Dumazet23.92%116.67%
Total51100.00%6100.00%

EXPORT_SYMBOL(skb_kill_datagram); /** * skb_copy_datagram_iter - Copy a datagram to an iovec iterator. * @skb: buffer to copy * @offset: offset in the buffer to start copying from * @to: iovec iterator to copy to * @len: amount of data to copy from buffer to iovec */
int skb_copy_datagram_iter(const struct sk_buff *skb, int offset, struct iov_iter *to, int len) { int start = skb_headlen(skb); int i, copy = start - offset, start_off = offset, n; struct sk_buff *frag_iter; trace_skb_copy_datagram_iovec(skb, len); /* Copy header. */ if (copy > 0) { if (copy > len) copy = len; n = copy_to_iter(skb->data + offset, copy, to); offset += n; if (n != copy) goto short_copy; if ((len -= copy) == 0) return 0; } /* Copy paged appendix. Hmm... why does this look so complicated? */ for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) { int end; const skb_frag_t *frag = &skb_shinfo(skb)->frags[i]; WARN_ON(start > offset + len); end = start + skb_frag_size(frag); if ((copy = end - offset) > 0) { if (copy > len) copy = len; n = copy_page_to_iter(skb_frag_page(frag), frag->page_offset + offset - start, copy, to); offset += n; if (n != copy) goto short_copy; if (!(len -= copy)) return 0; } start = end; } skb_walk_frags(skb, frag_iter) { int end; WARN_ON(start > offset + len); end = start + frag_iter->len; if ((copy = end - offset) > 0) { if (copy > len) copy = len; if (skb_copy_datagram_iter(frag_iter, offset - start, to, copy)) goto fault; if ((len -= copy) == 0) return 0; offset += copy; } start = end; } if (!len) return 0; /* This is not really a user copy fault, but rather someone * gave us a bogus length on the skb. We should probably * print a warning here as it may indicate a kernel bug. */ fault: iov_iter_revert(to, offset - start_off); return -EFAULT; short_copy: if (iov_iter_count(to)) goto fault; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Herbert Xu34590.79%150.00%
Al Viro359.21%150.00%
Total380100.00%2100.00%

EXPORT_SYMBOL(skb_copy_datagram_iter); /** * skb_copy_datagram_from_iter - Copy a datagram from an iov_iter. * @skb: buffer to copy * @offset: offset in the buffer to start copying to * @from: the copy source * @len: amount of data to copy to buffer from iovec * * Returns 0 or -EFAULT. */
int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset, struct iov_iter *from, int len) { int start = skb_headlen(skb); int i, copy = start - offset; struct sk_buff *frag_iter; /* Copy header. */ if (copy > 0) { if (copy > len) copy = len; if (copy_from_iter(skb->data + offset, copy, from) != copy) goto fault; if ((len -= copy) == 0) return 0; offset += copy; } /* Copy paged appendix. Hmm... why does this look so complicated? */ for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) { int end; const skb_frag_t *frag = &skb_shinfo(skb)->frags[i]; WARN_ON(start > offset + len); end = start + skb_frag_size(frag); if ((copy = end - offset) > 0) { size_t copied; if (copy > len) copy = len; copied = copy_page_from_iter(skb_frag_page(frag), frag->page_offset + offset - start, copy, from); if (copied != copy) goto fault; if (!(len -= copy)) return 0; offset += copy; } start = end; } skb_walk_frags(skb, frag_iter) { int end; WARN_ON(start > offset + len); end = start + frag_iter->len; if ((copy = end - offset) > 0) { if (copy > len) copy = len; if (skb_copy_datagram_from_iter(frag_iter, offset - start, from, copy)) goto fault; if ((len -= copy) == 0) return 0; offset += copy; } start = end; } if (!len) return 0; fault: return -EFAULT; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro340100.00%1100.00%
Total340100.00%1100.00%

EXPORT_SYMBOL(skb_copy_datagram_from_iter);
int __zerocopy_sg_from_iter(struct sock *sk, struct sk_buff *skb, struct iov_iter *from, size_t length) { int frag = skb_shinfo(skb)->nr_frags; while (length && iov_iter_count(from)) { struct page *pages[MAX_SKB_FRAGS]; size_t start; ssize_t copied; unsigned long truesize; int n = 0; if (frag == MAX_SKB_FRAGS) return -EMSGSIZE; copied = iov_iter_get_pages(from, pages, length, MAX_SKB_FRAGS - frag, &start); if (copied < 0) return -EFAULT; iov_iter_advance(from, copied); length -= copied; truesize = PAGE_ALIGN(copied + start); skb->data_len += copied; skb->len += copied; skb->truesize += truesize; if (sk && sk->sk_type == SOCK_STREAM) { sk->sk_wmem_queued += truesize; sk_mem_charge(sk, truesize); } else { refcount_add(truesize, &skb->sk->sk_wmem_alloc); } while (copied) { int size = min_t(int, copied, PAGE_SIZE - start); skb_fill_page_desc(skb, frag++, pages[n], start, size); start = 0; copied -= size; n++; } } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro18579.06%133.33%
Willem de Bruijn4820.51%133.33%
Elena Reshetova10.43%133.33%
Total234100.00%3100.00%

EXPORT_SYMBOL(__zerocopy_sg_from_iter); /** * zerocopy_sg_from_iter - Build a zerocopy datagram from an iov_iter * @skb: buffer to copy * @from: the source to copy from * * The function will first copy up to headlen, and then pin the userspace * pages and build frags through them. * * Returns 0, -EFAULT or -EMSGSIZE. */
int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *from) { int copy = min_t(int, skb_headlen(skb), iov_iter_count(from)); /* copy up to skb headlen */ if (skb_copy_datagram_from_iter(skb, 0, from, copy)) return -EFAULT; return __zerocopy_sg_from_iter(NULL, skb, from, ~0U); }

Contributors

PersonTokensPropCommitsCommitProp
Willem de Bruijn64100.00%1100.00%
Total64100.00%1100.00%

EXPORT_SYMBOL(zerocopy_sg_from_iter);
static int skb_copy_and_csum_datagram(const struct sk_buff *skb, int offset, struct iov_iter *to, int len, __wsum *csump) { int start = skb_headlen(skb); int i, copy = start - offset, start_off = offset; struct sk_buff *frag_iter; int pos = 0; int n; /* Copy header. */ if (copy > 0) { if (copy > len) copy = len; n = csum_and_copy_to_iter(skb->data + offset, copy, csump, to); offset += n; if (n != copy) goto fault; if ((len -= copy) == 0) return 0; pos = copy; } for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) { int end; const skb_frag_t *frag = &skb_shinfo(skb)->frags[i]; WARN_ON(start > offset + len); end = start + skb_frag_size(frag); if ((copy = end - offset) > 0) { __wsum csum2 = 0; struct page *page = skb_frag_page(frag); u8 *vaddr = kmap(page); if (copy > len) copy = len; n = csum_and_copy_to_iter(vaddr + frag->page_offset + offset - start, copy, &csum2, to); kunmap(page); offset += n; if (n != copy) goto fault; *csump = csum_block_add(*csump, csum2, pos); if (!(len -= copy)) return 0; pos += copy; } start = end; } skb_walk_frags(skb, frag_iter) { int end; WARN_ON(start > offset + len); end = start + frag_iter->len; if ((copy = end - offset) > 0) { __wsum csum2 = 0; if (copy > len) copy = len; if (skb_copy_and_csum_datagram(frag_iter, offset - start, to, copy, &csum2)) goto fault; *csump = csum_block_add(*csump, csum2, pos); if ((len -= copy) == 0) return 0; offset += copy; pos += copy; } start = end; } if (!len) return 0; fault: iov_iter_revert(to, offset - start_off); return -EFAULT; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds30769.14%18.33%
Al Viro5211.71%325.00%
David S. Miller4710.59%216.67%
Eric Dumazet184.05%18.33%
Arnaldo Carvalho de Melo92.03%18.33%
Ilpo Järvinen40.90%18.33%
Ian Campbell30.68%18.33%
James Morris30.68%18.33%
Adrian Bunk10.23%18.33%
Total444100.00%12100.00%


__sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len) { __sum16 sum; sum = csum_fold(skb_checksum(skb, 0, len, skb->csum)); if (likely(!sum)) { if (unlikely(skb->ip_summed == CHECKSUM_COMPLETE) && !skb->csum_complete_sw) netdev_rx_csum_fault(skb->dev); } if (!skb_shared(skb)) skb->csum_valid = !sum; return sum; }

Contributors

PersonTokensPropCommitsCommitProp
Herbert Xu6070.59%337.50%
Tom Herbert2225.88%225.00%
Al Viro22.35%225.00%
Patrick McHardy11.18%112.50%
Total85100.00%8100.00%

EXPORT_SYMBOL(__skb_checksum_complete_head)