1 // SPDX-License-Identifier: GPL-2.0
4 * AF_XDP sockets allows a channel between XDP programs and userspace
6 * Copyright(c) 2018 Intel Corporation.
12 #define pr_fmt(fmt) "AF_XDP: %s: " fmt, __func__
14 #include <linux/if_xdp.h>
15 #include <linux/init.h>
16 #include <linux/sched/mm.h>
17 #include <linux/sched/signal.h>
18 #include <linux/sched/task.h>
19 #include <linux/socket.h>
20 #include <linux/file.h>
21 #include <linux/uaccess.h>
22 #include <linux/net.h>
23 #include <linux/netdevice.h>
24 #include <linux/rculist.h>
25 #include <linux/vmalloc.h>
26 #include <net/xdp_sock_drv.h>
27 #include <net/busy_poll.h>
28 #include <net/netdev_rx_queue.h>
31 #include "xsk_queue.h"
35 #define TX_BATCH_SIZE 32
36 #define MAX_PER_SOCKET_BUDGET (TX_BATCH_SIZE)
38 static DEFINE_PER_CPU(struct list_head, xskmap_flush_list);
40 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
42 if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
45 pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
46 pool->cached_need_wakeup |= XDP_WAKEUP_RX;
48 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
50 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
54 if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
58 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
59 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
63 pool->cached_need_wakeup |= XDP_WAKEUP_TX;
65 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
67 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
69 if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
72 pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
73 pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
75 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
77 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
81 if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
85 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
86 xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
90 pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
92 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
94 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
96 return pool->uses_need_wakeup;
98 EXPORT_SYMBOL(xsk_uses_need_wakeup);
100 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
103 if (queue_id < dev->real_num_rx_queues)
104 return dev->_rx[queue_id].pool;
105 if (queue_id < dev->real_num_tx_queues)
106 return dev->_tx[queue_id].pool;
110 EXPORT_SYMBOL(xsk_get_pool_from_qid);
112 void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
114 if (queue_id < dev->num_rx_queues)
115 dev->_rx[queue_id].pool = NULL;
116 if (queue_id < dev->num_tx_queues)
117 dev->_tx[queue_id].pool = NULL;
120 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
121 * not know if the device has more tx queues than rx, or the opposite.
122 * This might also change during run time.
124 int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
127 if (queue_id >= max_t(unsigned int,
128 dev->real_num_rx_queues,
129 dev->real_num_tx_queues))
132 if (queue_id < dev->real_num_rx_queues)
133 dev->_rx[queue_id].pool = pool;
134 if (queue_id < dev->real_num_tx_queues)
135 dev->_tx[queue_id].pool = pool;
140 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff_xsk *xskb, u32 len,
146 addr = xp_get_handle(xskb);
147 err = xskq_prod_reserve_desc(xs->rx, addr, len, flags);
157 static int xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
159 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
160 u32 frags = xdp_buff_has_frags(xdp);
161 struct xdp_buff_xsk *pos, *tmp;
162 struct list_head *xskb_list;
167 contd = XDP_PKT_CONTD;
169 err = __xsk_rcv_zc(xs, xskb, len, contd);
175 xskb_list = &xskb->pool->xskb_list;
176 list_for_each_entry_safe(pos, tmp, xskb_list, xskb_list_node) {
177 if (list_is_singular(xskb_list))
179 len = pos->xdp.data_end - pos->xdp.data;
180 err = __xsk_rcv_zc(xs, pos, len, contd);
183 list_del(&pos->xskb_list_node);
192 static void *xsk_copy_xdp_start(struct xdp_buff *from)
194 if (unlikely(xdp_data_meta_unsupported(from)))
197 return from->data_meta;
200 static u32 xsk_copy_xdp(void *to, void **from, u32 to_len,
201 u32 *from_len, skb_frag_t **frag, u32 rem)
206 u32 copy_len = min_t(u32, *from_len, to_len);
208 memcpy(to, *from, copy_len);
213 if (*from_len == copy_len) {
214 *from = skb_frag_address(*frag);
215 *from_len = skb_frag_size((*frag)++);
218 *from_len -= copy_len;
220 if (to_len == copy_len)
228 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
230 u32 frame_size = xsk_pool_get_rx_frame_size(xs->pool);
231 void *copy_from = xsk_copy_xdp_start(xdp), *copy_to;
232 u32 from_len, meta_len, rem, num_desc;
233 struct xdp_buff_xsk *xskb;
234 struct xdp_buff *xsk_xdp;
237 from_len = xdp->data_end - copy_from;
238 meta_len = xdp->data - copy_from;
239 rem = len + meta_len;
241 if (len <= frame_size && !xdp_buff_has_frags(xdp)) {
244 xsk_xdp = xsk_buff_alloc(xs->pool);
249 memcpy(xsk_xdp->data - meta_len, copy_from, rem);
250 xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
251 err = __xsk_rcv_zc(xs, xskb, len, 0);
253 xsk_buff_free(xsk_xdp);
260 num_desc = (len - 1) / frame_size + 1;
262 if (!xsk_buff_can_alloc(xs->pool, num_desc)) {
266 if (xskq_prod_nb_free(xs->rx, num_desc) < num_desc) {
271 if (xdp_buff_has_frags(xdp)) {
272 struct skb_shared_info *sinfo;
274 sinfo = xdp_get_shared_info_from_buff(xdp);
275 frag = &sinfo->frags[0];
279 u32 to_len = frame_size + meta_len;
282 xsk_xdp = xsk_buff_alloc(xs->pool);
283 copy_to = xsk_xdp->data - meta_len;
285 copied = xsk_copy_xdp(copy_to, ©_from, to_len, &from_len, &frag, rem);
288 xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
289 __xsk_rcv_zc(xs, xskb, copied - meta_len, rem ? XDP_PKT_CONTD : 0);
296 static bool xsk_tx_writeable(struct xdp_sock *xs)
298 if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
304 static bool xsk_is_bound(struct xdp_sock *xs)
306 if (READ_ONCE(xs->state) == XSK_BOUND) {
307 /* Matches smp_wmb() in bind(). */
314 static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
316 if (!xsk_is_bound(xs))
319 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
322 if (len > xsk_pool_get_rx_frame_size(xs->pool) && !xs->sg) {
327 sk_mark_napi_id_once_xdp(&xs->sk, xdp);
331 static void xsk_flush(struct xdp_sock *xs)
333 xskq_prod_submit(xs->rx);
334 __xskq_cons_release(xs->pool->fq);
335 sock_def_readable(&xs->sk);
338 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
340 u32 len = xdp_get_buff_len(xdp);
343 spin_lock_bh(&xs->rx_lock);
344 err = xsk_rcv_check(xs, xdp, len);
346 err = __xsk_rcv(xs, xdp, len);
349 spin_unlock_bh(&xs->rx_lock);
353 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
355 u32 len = xdp_get_buff_len(xdp);
358 err = xsk_rcv_check(xs, xdp, len);
362 if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
363 len = xdp->data_end - xdp->data;
364 return xsk_rcv_zc(xs, xdp, len);
367 err = __xsk_rcv(xs, xdp, len);
369 xdp_return_buff(xdp);
373 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
375 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
378 err = xsk_rcv(xs, xdp);
382 if (!xs->flush_node.prev)
383 list_add(&xs->flush_node, flush_list);
388 void __xsk_map_flush(void)
390 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
391 struct xdp_sock *xs, *tmp;
393 list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
395 __list_del_clearprev(&xs->flush_node);
399 #ifdef CONFIG_DEBUG_NET
400 bool xsk_map_check_flush(void)
402 if (list_empty(this_cpu_ptr(&xskmap_flush_list)))
409 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
411 xskq_prod_submit_n(pool->cq, nb_entries);
413 EXPORT_SYMBOL(xsk_tx_completed);
415 void xsk_tx_release(struct xsk_buff_pool *pool)
420 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
421 __xskq_cons_release(xs->tx);
422 if (xsk_tx_writeable(xs))
423 xs->sk.sk_write_space(&xs->sk);
427 EXPORT_SYMBOL(xsk_tx_release);
429 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
431 bool budget_exhausted = false;
436 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
437 if (xs->tx_budget_spent >= MAX_PER_SOCKET_BUDGET) {
438 budget_exhausted = true;
442 if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
443 if (xskq_has_descs(xs->tx))
444 xskq_cons_release(xs->tx);
448 xs->tx_budget_spent++;
450 /* This is the backpressure mechanism for the Tx path.
451 * Reserve space in the completion queue and only proceed
452 * if there is space in it. This avoids having to implement
453 * any buffering in the Tx path.
455 if (xskq_prod_reserve_addr(pool->cq, desc->addr))
458 xskq_cons_release(xs->tx);
463 if (budget_exhausted) {
464 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
465 xs->tx_budget_spent = 0;
467 budget_exhausted = false;
475 EXPORT_SYMBOL(xsk_tx_peek_desc);
477 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
479 struct xdp_desc *descs = pool->tx_descs;
482 while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
485 xsk_tx_release(pool);
489 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
494 if (!list_is_singular(&pool->xsk_tx_list)) {
495 /* Fallback to the non-batched version */
497 return xsk_tx_peek_release_fallback(pool, nb_pkts);
500 xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
506 nb_pkts = xskq_cons_nb_entries(xs->tx, nb_pkts);
508 /* This is the backpressure mechanism for the Tx path. Try to
509 * reserve space in the completion queue for all packets, but
510 * if there are fewer slots available, just process that many
511 * packets. This avoids having to implement any buffering in
514 nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
518 nb_pkts = xskq_cons_read_desc_batch(xs->tx, pool, nb_pkts);
520 xs->tx->queue_empty_descs++;
524 __xskq_cons_release(xs->tx);
525 xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_pkts);
526 xs->sk.sk_write_space(&xs->sk);
532 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
534 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
536 struct net_device *dev = xs->dev;
538 return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
541 static int xsk_cq_reserve_addr_locked(struct xdp_sock *xs, u64 addr)
546 spin_lock_irqsave(&xs->pool->cq_lock, flags);
547 ret = xskq_prod_reserve_addr(xs->pool->cq, addr);
548 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
553 static void xsk_cq_submit_locked(struct xdp_sock *xs, u32 n)
557 spin_lock_irqsave(&xs->pool->cq_lock, flags);
558 xskq_prod_submit_n(xs->pool->cq, n);
559 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
562 static void xsk_cq_cancel_locked(struct xdp_sock *xs, u32 n)
566 spin_lock_irqsave(&xs->pool->cq_lock, flags);
567 xskq_prod_cancel_n(xs->pool->cq, n);
568 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
571 static u32 xsk_get_num_desc(struct sk_buff *skb)
573 return skb ? (long)skb_shinfo(skb)->destructor_arg : 0;
576 static void xsk_destruct_skb(struct sk_buff *skb)
578 struct xsk_tx_metadata_compl *compl = &skb_shinfo(skb)->xsk_meta;
580 if (compl->tx_timestamp) {
581 /* sw completion timestamp, not a real one */
582 *compl->tx_timestamp = ktime_get_tai_fast_ns();
585 xsk_cq_submit_locked(xdp_sk(skb->sk), xsk_get_num_desc(skb));
589 static void xsk_set_destructor_arg(struct sk_buff *skb)
591 long num = xsk_get_num_desc(xdp_sk(skb->sk)->skb) + 1;
593 skb_shinfo(skb)->destructor_arg = (void *)num;
596 static void xsk_consume_skb(struct sk_buff *skb)
598 struct xdp_sock *xs = xdp_sk(skb->sk);
600 skb->destructor = sock_wfree;
601 xsk_cq_cancel_locked(xs, xsk_get_num_desc(skb));
602 /* Free skb without triggering the perf drop trace */
607 static void xsk_drop_skb(struct sk_buff *skb)
609 xdp_sk(skb->sk)->tx->invalid_descs += xsk_get_num_desc(skb);
610 xsk_consume_skb(skb);
613 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
614 struct xdp_desc *desc)
616 struct xsk_buff_pool *pool = xs->pool;
617 u32 hr, len, ts, offset, copy, copied;
618 struct sk_buff *skb = xs->skb;
625 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
627 skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
631 skb_reserve(skb, hr);
636 ts = pool->unaligned ? len : pool->chunk_size;
638 buffer = xsk_buff_raw_get_data(pool, addr);
639 offset = offset_in_page(buffer);
640 addr = buffer - pool->addrs;
642 for (copied = 0, i = skb_shinfo(skb)->nr_frags; copied < len; i++) {
643 if (unlikely(i >= MAX_SKB_FRAGS))
644 return ERR_PTR(-EOVERFLOW);
646 page = pool->umem->pgs[addr >> PAGE_SHIFT];
649 copy = min_t(u32, PAGE_SIZE - offset, len - copied);
650 skb_fill_page_desc(skb, i, page, offset, copy);
658 skb->data_len += len;
661 refcount_add(ts, &xs->sk.sk_wmem_alloc);
666 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
667 struct xdp_desc *desc)
669 struct xsk_tx_metadata *meta = NULL;
670 struct net_device *dev = xs->dev;
671 struct sk_buff *skb = xs->skb;
672 bool first_frag = false;
675 if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
676 skb = xsk_build_skb_zerocopy(xs, desc);
685 buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
689 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
690 tr = dev->needed_tailroom;
691 skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
695 skb_reserve(skb, hr);
698 err = skb_store_bits(skb, 0, buffer, len);
706 int nr_frags = skb_shinfo(skb)->nr_frags;
710 if (unlikely(nr_frags == (MAX_SKB_FRAGS - 1) && xp_mb_desc(desc))) {
715 page = alloc_page(xs->sk.sk_allocation);
716 if (unlikely(!page)) {
721 vaddr = kmap_local_page(page);
722 memcpy(vaddr, buffer, len);
725 skb_add_rx_frag(skb, nr_frags, page, 0, len, 0);
728 if (first_frag && desc->options & XDP_TX_METADATA) {
729 if (unlikely(xs->pool->tx_metadata_len == 0)) {
734 meta = buffer - xs->pool->tx_metadata_len;
735 if (unlikely(!xsk_buff_valid_tx_metadata(meta))) {
740 if (meta->flags & XDP_TXMD_FLAGS_CHECKSUM) {
741 if (unlikely(meta->request.csum_start +
742 meta->request.csum_offset +
743 sizeof(__sum16) > len)) {
748 skb->csum_start = hr + meta->request.csum_start;
749 skb->csum_offset = meta->request.csum_offset;
750 skb->ip_summed = CHECKSUM_PARTIAL;
752 if (unlikely(xs->pool->tx_sw_csum)) {
753 err = skb_checksum_help(skb);
762 skb->priority = READ_ONCE(xs->sk.sk_priority);
763 skb->mark = READ_ONCE(xs->sk.sk_mark);
764 skb->destructor = xsk_destruct_skb;
765 xsk_tx_metadata_to_compl(meta, &skb_shinfo(skb)->xsk_meta);
766 xsk_set_destructor_arg(skb);
771 if (err == -EOVERFLOW) {
772 /* Drop the packet */
773 xsk_set_destructor_arg(xs->skb);
774 xsk_drop_skb(xs->skb);
775 xskq_cons_release(xs->tx);
777 /* Let application retry */
778 xsk_cq_cancel_locked(xs, 1);
784 static int __xsk_generic_xmit(struct sock *sk)
786 struct xdp_sock *xs = xdp_sk(sk);
787 u32 max_batch = TX_BATCH_SIZE;
788 bool sent_frame = false;
789 struct xdp_desc desc;
793 mutex_lock(&xs->mutex);
795 /* Since we dropped the RCU read lock, the socket state might have changed. */
796 if (unlikely(!xsk_is_bound(xs))) {
801 if (xs->queue_id >= xs->dev->real_num_tx_queues)
804 while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
805 if (max_batch-- == 0) {
810 /* This is the backpressure mechanism for the Tx path.
811 * Reserve space in the completion queue and only proceed
812 * if there is space in it. This avoids having to implement
813 * any buffering in the Tx path.
815 if (xsk_cq_reserve_addr_locked(xs, desc.addr))
818 skb = xsk_build_skb(xs, &desc);
821 if (err != -EOVERFLOW)
827 xskq_cons_release(xs->tx);
829 if (xp_mb_desc(&desc)) {
834 err = __dev_direct_xmit(skb, xs->queue_id);
835 if (err == NETDEV_TX_BUSY) {
836 /* Tell user-space to retry the send */
837 xskq_cons_cancel_n(xs->tx, xsk_get_num_desc(skb));
838 xsk_consume_skb(skb);
843 /* Ignore NET_XMIT_CN as packet might have been sent */
844 if (err == NET_XMIT_DROP) {
845 /* SKB completed but not sent */
855 if (xskq_has_descs(xs->tx)) {
857 xsk_drop_skb(xs->skb);
858 xskq_cons_release(xs->tx);
863 if (xsk_tx_writeable(xs))
864 sk->sk_write_space(sk);
866 mutex_unlock(&xs->mutex);
870 static int xsk_generic_xmit(struct sock *sk)
874 /* Drop the RCU lock since the SKB path might sleep. */
876 ret = __xsk_generic_xmit(sk);
877 /* Reaquire RCU lock before going into common code. */
883 static bool xsk_no_wakeup(struct sock *sk)
885 #ifdef CONFIG_NET_RX_BUSY_POLL
886 /* Prefer busy-polling, skip the wakeup. */
887 return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
888 READ_ONCE(sk->sk_napi_id) >= MIN_NAPI_ID;
894 static int xsk_check_common(struct xdp_sock *xs)
896 if (unlikely(!xsk_is_bound(xs)))
898 if (unlikely(!(xs->dev->flags & IFF_UP)))
904 static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
906 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
907 struct sock *sk = sock->sk;
908 struct xdp_sock *xs = xdp_sk(sk);
909 struct xsk_buff_pool *pool;
912 err = xsk_check_common(xs);
915 if (unlikely(need_wait))
917 if (unlikely(!xs->tx))
920 if (sk_can_busy_loop(sk)) {
922 __sk_mark_napi_id_once(sk, xsk_pool_get_napi_id(xs->pool));
923 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
926 if (xs->zc && xsk_no_wakeup(sk))
930 if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
932 return xsk_wakeup(xs, XDP_WAKEUP_TX);
933 return xsk_generic_xmit(sk);
938 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
943 ret = __xsk_sendmsg(sock, m, total_len);
949 static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
951 bool need_wait = !(flags & MSG_DONTWAIT);
952 struct sock *sk = sock->sk;
953 struct xdp_sock *xs = xdp_sk(sk);
956 err = xsk_check_common(xs);
959 if (unlikely(!xs->rx))
961 if (unlikely(need_wait))
964 if (sk_can_busy_loop(sk))
965 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
967 if (xsk_no_wakeup(sk))
970 if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
971 return xsk_wakeup(xs, XDP_WAKEUP_RX);
975 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
980 ret = __xsk_recvmsg(sock, m, len, flags);
986 static __poll_t xsk_poll(struct file *file, struct socket *sock,
987 struct poll_table_struct *wait)
990 struct sock *sk = sock->sk;
991 struct xdp_sock *xs = xdp_sk(sk);
992 struct xsk_buff_pool *pool;
994 sock_poll_wait(file, sock, wait);
997 if (xsk_check_common(xs))
1002 if (pool->cached_need_wakeup) {
1004 xsk_wakeup(xs, pool->cached_need_wakeup);
1006 /* Poll needs to drive Tx also in copy mode */
1007 xsk_generic_xmit(sk);
1010 if (xs->rx && !xskq_prod_is_empty(xs->rx))
1011 mask |= EPOLLIN | EPOLLRDNORM;
1012 if (xs->tx && xsk_tx_writeable(xs))
1013 mask |= EPOLLOUT | EPOLLWRNORM;
1019 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
1022 struct xsk_queue *q;
1024 if (entries == 0 || *queue || !is_power_of_2(entries))
1027 q = xskq_create(entries, umem_queue);
1031 /* Make sure queue is ready before it can be seen by others */
1033 WRITE_ONCE(*queue, q);
1037 static void xsk_unbind_dev(struct xdp_sock *xs)
1039 struct net_device *dev = xs->dev;
1041 if (xs->state != XSK_BOUND)
1043 WRITE_ONCE(xs->state, XSK_UNBOUND);
1045 /* Wait for driver to stop using the xdp socket. */
1046 xp_del_xsk(xs->pool, xs);
1051 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
1052 struct xdp_sock __rcu ***map_entry)
1054 struct xsk_map *map = NULL;
1055 struct xsk_map_node *node;
1059 spin_lock_bh(&xs->map_list_lock);
1060 node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
1063 bpf_map_inc(&node->map->map);
1065 *map_entry = node->map_entry;
1067 spin_unlock_bh(&xs->map_list_lock);
1071 static void xsk_delete_from_maps(struct xdp_sock *xs)
1073 /* This function removes the current XDP socket from all the
1074 * maps it resides in. We need to take extra care here, due to
1075 * the two locks involved. Each map has a lock synchronizing
1076 * updates to the entries, and each socket has a lock that
1077 * synchronizes access to the list of maps (map_list). For
1078 * deadlock avoidance the locks need to be taken in the order
1079 * "map lock"->"socket map list lock". We start off by
1080 * accessing the socket map list, and take a reference to the
1081 * map to guarantee existence between the
1082 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
1083 * calls. Then we ask the map to remove the socket, which
1084 * tries to remove the socket from the map. Note that there
1085 * might be updates to the map between
1086 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
1088 struct xdp_sock __rcu **map_entry = NULL;
1089 struct xsk_map *map;
1091 while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
1092 xsk_map_try_sock_delete(map, xs, map_entry);
1093 bpf_map_put(&map->map);
1097 static int xsk_release(struct socket *sock)
1099 struct sock *sk = sock->sk;
1100 struct xdp_sock *xs = xdp_sk(sk);
1109 xsk_drop_skb(xs->skb);
1111 mutex_lock(&net->xdp.lock);
1112 sk_del_node_init_rcu(sk);
1113 mutex_unlock(&net->xdp.lock);
1115 sock_prot_inuse_add(net, sk->sk_prot, -1);
1117 xsk_delete_from_maps(xs);
1118 mutex_lock(&xs->mutex);
1120 mutex_unlock(&xs->mutex);
1122 xskq_destroy(xs->rx);
1123 xskq_destroy(xs->tx);
1124 xskq_destroy(xs->fq_tmp);
1125 xskq_destroy(xs->cq_tmp);
1135 static struct socket *xsk_lookup_xsk_from_fd(int fd)
1137 struct socket *sock;
1140 sock = sockfd_lookup(fd, &err);
1142 return ERR_PTR(-ENOTSOCK);
1144 if (sock->sk->sk_family != PF_XDP) {
1146 return ERR_PTR(-ENOPROTOOPT);
1152 static bool xsk_validate_queues(struct xdp_sock *xs)
1154 return xs->fq_tmp && xs->cq_tmp;
1157 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
1159 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
1160 struct sock *sk = sock->sk;
1161 struct xdp_sock *xs = xdp_sk(sk);
1162 struct net_device *dev;
1167 if (addr_len < sizeof(struct sockaddr_xdp))
1169 if (sxdp->sxdp_family != AF_XDP)
1172 flags = sxdp->sxdp_flags;
1173 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
1174 XDP_USE_NEED_WAKEUP | XDP_USE_SG))
1177 bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
1178 if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
1182 mutex_lock(&xs->mutex);
1183 if (xs->state != XSK_READY) {
1188 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
1194 if (!xs->rx && !xs->tx) {
1199 qid = sxdp->sxdp_queue_id;
1201 if (flags & XDP_SHARED_UMEM) {
1202 struct xdp_sock *umem_xs;
1203 struct socket *sock;
1205 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
1206 (flags & XDP_USE_NEED_WAKEUP) || (flags & XDP_USE_SG)) {
1207 /* Cannot specify flags for shared sockets. */
1213 /* We have already our own. */
1218 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
1220 err = PTR_ERR(sock);
1224 umem_xs = xdp_sk(sock->sk);
1225 if (!xsk_is_bound(umem_xs)) {
1231 if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
1232 /* Share the umem with another socket on another qid
1235 xs->pool = xp_create_and_assign_umem(xs,
1243 err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
1246 xp_destroy(xs->pool);
1252 /* Share the buffer pool with the other socket. */
1253 if (xs->fq_tmp || xs->cq_tmp) {
1254 /* Do not allow setting your own fq or cq. */
1260 xp_get_pool(umem_xs->pool);
1261 xs->pool = umem_xs->pool;
1263 /* If underlying shared umem was created without Tx
1264 * ring, allocate Tx descs array that Tx batching API
1267 if (xs->tx && !xs->pool->tx_descs) {
1268 err = xp_alloc_tx_descs(xs->pool, xs);
1270 xp_put_pool(xs->pool);
1278 xdp_get_umem(umem_xs->umem);
1279 WRITE_ONCE(xs->umem, umem_xs->umem);
1281 } else if (!xs->umem || !xsk_validate_queues(xs)) {
1285 /* This xsk has its own umem. */
1286 xs->pool = xp_create_and_assign_umem(xs, xs->umem);
1292 err = xp_assign_dev(xs->pool, dev, qid, flags);
1294 xp_destroy(xs->pool);
1300 /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
1305 xs->zc = xs->umem->zc;
1306 xs->sg = !!(xs->umem->flags & XDP_UMEM_SG_FLAG);
1308 xp_add_xsk(xs->pool, xs);
1314 /* Matches smp_rmb() in bind() for shared umem
1315 * sockets, and xsk_is_bound().
1318 WRITE_ONCE(xs->state, XSK_BOUND);
1321 mutex_unlock(&xs->mutex);
1326 struct xdp_umem_reg_v1 {
1327 __u64 addr; /* Start of packet data area */
1328 __u64 len; /* Length of packet data area */
1333 struct xdp_umem_reg_v2 {
1334 __u64 addr; /* Start of packet data area */
1335 __u64 len; /* Length of packet data area */
1341 static int xsk_setsockopt(struct socket *sock, int level, int optname,
1342 sockptr_t optval, unsigned int optlen)
1344 struct sock *sk = sock->sk;
1345 struct xdp_sock *xs = xdp_sk(sk);
1348 if (level != SOL_XDP)
1349 return -ENOPROTOOPT;
1355 struct xsk_queue **q;
1358 if (optlen < sizeof(entries))
1360 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1363 mutex_lock(&xs->mutex);
1364 if (xs->state != XSK_READY) {
1365 mutex_unlock(&xs->mutex);
1368 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1369 err = xsk_init_queue(entries, q, false);
1370 if (!err && optname == XDP_TX_RING)
1371 /* Tx needs to be explicitly woken up the first time */
1372 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1373 mutex_unlock(&xs->mutex);
1378 size_t mr_size = sizeof(struct xdp_umem_reg);
1379 struct xdp_umem_reg mr = {};
1380 struct xdp_umem *umem;
1382 if (optlen < sizeof(struct xdp_umem_reg_v1))
1384 else if (optlen < sizeof(struct xdp_umem_reg_v2))
1385 mr_size = sizeof(struct xdp_umem_reg_v1);
1386 else if (optlen < sizeof(mr))
1387 mr_size = sizeof(struct xdp_umem_reg_v2);
1389 if (copy_from_sockptr(&mr, optval, mr_size))
1392 mutex_lock(&xs->mutex);
1393 if (xs->state != XSK_READY || xs->umem) {
1394 mutex_unlock(&xs->mutex);
1398 umem = xdp_umem_create(&mr);
1400 mutex_unlock(&xs->mutex);
1401 return PTR_ERR(umem);
1404 /* Make sure umem is ready before it can be seen by others */
1406 WRITE_ONCE(xs->umem, umem);
1407 mutex_unlock(&xs->mutex);
1410 case XDP_UMEM_FILL_RING:
1411 case XDP_UMEM_COMPLETION_RING:
1413 struct xsk_queue **q;
1416 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1419 mutex_lock(&xs->mutex);
1420 if (xs->state != XSK_READY) {
1421 mutex_unlock(&xs->mutex);
1425 q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1427 err = xsk_init_queue(entries, q, true);
1428 mutex_unlock(&xs->mutex);
1435 return -ENOPROTOOPT;
1438 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1440 ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1441 ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1442 ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1445 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1447 ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1448 ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1449 ring->desc = offsetof(struct xdp_umem_ring, desc);
1452 struct xdp_statistics_v1 {
1454 __u64 rx_invalid_descs;
1455 __u64 tx_invalid_descs;
1458 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1459 char __user *optval, int __user *optlen)
1461 struct sock *sk = sock->sk;
1462 struct xdp_sock *xs = xdp_sk(sk);
1465 if (level != SOL_XDP)
1466 return -ENOPROTOOPT;
1468 if (get_user(len, optlen))
1474 case XDP_STATISTICS:
1476 struct xdp_statistics stats = {};
1477 bool extra_stats = true;
1480 if (len < sizeof(struct xdp_statistics_v1)) {
1482 } else if (len < sizeof(stats)) {
1483 extra_stats = false;
1484 stats_size = sizeof(struct xdp_statistics_v1);
1486 stats_size = sizeof(stats);
1489 mutex_lock(&xs->mutex);
1490 stats.rx_dropped = xs->rx_dropped;
1492 stats.rx_ring_full = xs->rx_queue_full;
1493 stats.rx_fill_ring_empty_descs =
1494 xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1495 stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1497 stats.rx_dropped += xs->rx_queue_full;
1499 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1500 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1501 mutex_unlock(&xs->mutex);
1503 if (copy_to_user(optval, &stats, stats_size))
1505 if (put_user(stats_size, optlen))
1510 case XDP_MMAP_OFFSETS:
1512 struct xdp_mmap_offsets off;
1513 struct xdp_mmap_offsets_v1 off_v1;
1514 bool flags_supported = true;
1517 if (len < sizeof(off_v1))
1519 else if (len < sizeof(off))
1520 flags_supported = false;
1522 if (flags_supported) {
1523 /* xdp_ring_offset is identical to xdp_ring_offset_v1
1524 * except for the flags field added to the end.
1526 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1528 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1530 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1532 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1534 off.rx.flags = offsetof(struct xdp_rxtx_ring,
1536 off.tx.flags = offsetof(struct xdp_rxtx_ring,
1538 off.fr.flags = offsetof(struct xdp_umem_ring,
1540 off.cr.flags = offsetof(struct xdp_umem_ring,
1546 xsk_enter_rxtx_offsets(&off_v1.rx);
1547 xsk_enter_rxtx_offsets(&off_v1.tx);
1548 xsk_enter_umem_offsets(&off_v1.fr);
1549 xsk_enter_umem_offsets(&off_v1.cr);
1551 len = sizeof(off_v1);
1555 if (copy_to_user(optval, to_copy, len))
1557 if (put_user(len, optlen))
1564 struct xdp_options opts = {};
1566 if (len < sizeof(opts))
1569 mutex_lock(&xs->mutex);
1571 opts.flags |= XDP_OPTIONS_ZEROCOPY;
1572 mutex_unlock(&xs->mutex);
1575 if (copy_to_user(optval, &opts, len))
1577 if (put_user(len, optlen))
1589 static int xsk_mmap(struct file *file, struct socket *sock,
1590 struct vm_area_struct *vma)
1592 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1593 unsigned long size = vma->vm_end - vma->vm_start;
1594 struct xdp_sock *xs = xdp_sk(sock->sk);
1595 int state = READ_ONCE(xs->state);
1596 struct xsk_queue *q = NULL;
1598 if (state != XSK_READY && state != XSK_BOUND)
1601 if (offset == XDP_PGOFF_RX_RING) {
1602 q = READ_ONCE(xs->rx);
1603 } else if (offset == XDP_PGOFF_TX_RING) {
1604 q = READ_ONCE(xs->tx);
1606 /* Matches the smp_wmb() in XDP_UMEM_REG */
1608 if (offset == XDP_UMEM_PGOFF_FILL_RING)
1609 q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
1610 READ_ONCE(xs->pool->fq);
1611 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1612 q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
1613 READ_ONCE(xs->pool->cq);
1619 /* Matches the smp_wmb() in xsk_init_queue */
1621 if (size > q->ring_vmalloc_size)
1624 return remap_vmalloc_range(vma, q->ring, 0);
1627 static int xsk_notifier(struct notifier_block *this,
1628 unsigned long msg, void *ptr)
1630 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1631 struct net *net = dev_net(dev);
1635 case NETDEV_UNREGISTER:
1636 mutex_lock(&net->xdp.lock);
1637 sk_for_each(sk, &net->xdp.list) {
1638 struct xdp_sock *xs = xdp_sk(sk);
1640 mutex_lock(&xs->mutex);
1641 if (xs->dev == dev) {
1642 sk->sk_err = ENETDOWN;
1643 if (!sock_flag(sk, SOCK_DEAD))
1644 sk_error_report(sk);
1648 /* Clear device references. */
1649 xp_clear_dev(xs->pool);
1651 mutex_unlock(&xs->mutex);
1653 mutex_unlock(&net->xdp.lock);
1659 static struct proto xsk_proto = {
1661 .owner = THIS_MODULE,
1662 .obj_size = sizeof(struct xdp_sock),
1665 static const struct proto_ops xsk_proto_ops = {
1667 .owner = THIS_MODULE,
1668 .release = xsk_release,
1670 .connect = sock_no_connect,
1671 .socketpair = sock_no_socketpair,
1672 .accept = sock_no_accept,
1673 .getname = sock_no_getname,
1675 .ioctl = sock_no_ioctl,
1676 .listen = sock_no_listen,
1677 .shutdown = sock_no_shutdown,
1678 .setsockopt = xsk_setsockopt,
1679 .getsockopt = xsk_getsockopt,
1680 .sendmsg = xsk_sendmsg,
1681 .recvmsg = xsk_recvmsg,
1685 static void xsk_destruct(struct sock *sk)
1687 struct xdp_sock *xs = xdp_sk(sk);
1689 if (!sock_flag(sk, SOCK_DEAD))
1692 if (!xp_put_pool(xs->pool))
1693 xdp_put_umem(xs->umem, !xs->pool);
1696 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1699 struct xdp_sock *xs;
1702 if (!ns_capable(net->user_ns, CAP_NET_RAW))
1704 if (sock->type != SOCK_RAW)
1705 return -ESOCKTNOSUPPORT;
1708 return -EPROTONOSUPPORT;
1710 sock->state = SS_UNCONNECTED;
1712 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1716 sock->ops = &xsk_proto_ops;
1718 sock_init_data(sock, sk);
1720 sk->sk_family = PF_XDP;
1722 sk->sk_destruct = xsk_destruct;
1724 sock_set_flag(sk, SOCK_RCU_FREE);
1727 xs->state = XSK_READY;
1728 mutex_init(&xs->mutex);
1729 spin_lock_init(&xs->rx_lock);
1731 INIT_LIST_HEAD(&xs->map_list);
1732 spin_lock_init(&xs->map_list_lock);
1734 mutex_lock(&net->xdp.lock);
1735 sk_add_node_rcu(sk, &net->xdp.list);
1736 mutex_unlock(&net->xdp.lock);
1738 sock_prot_inuse_add(net, &xsk_proto, 1);
1743 static const struct net_proto_family xsk_family_ops = {
1745 .create = xsk_create,
1746 .owner = THIS_MODULE,
1749 static struct notifier_block xsk_netdev_notifier = {
1750 .notifier_call = xsk_notifier,
1753 static int __net_init xsk_net_init(struct net *net)
1755 mutex_init(&net->xdp.lock);
1756 INIT_HLIST_HEAD(&net->xdp.list);
1760 static void __net_exit xsk_net_exit(struct net *net)
1762 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1765 static struct pernet_operations xsk_net_ops = {
1766 .init = xsk_net_init,
1767 .exit = xsk_net_exit,
1770 static int __init xsk_init(void)
1774 err = proto_register(&xsk_proto, 0 /* no slab */);
1778 err = sock_register(&xsk_family_ops);
1782 err = register_pernet_subsys(&xsk_net_ops);
1786 err = register_netdevice_notifier(&xsk_netdev_notifier);
1790 for_each_possible_cpu(cpu)
1791 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list, cpu));
1795 unregister_pernet_subsys(&xsk_net_ops);
1797 sock_unregister(PF_XDP);
1799 proto_unregister(&xsk_proto);
1804 fs_initcall(xsk_init);