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.
8 * Author(s): Björn Töpel <bjorn.topel@intel.com>
9 * Magnus Karlsson <magnus.karlsson@intel.com>
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
37 static DEFINE_PER_CPU(struct list_head, xskmap_flush_list);
39 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
41 if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
44 pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
45 pool->cached_need_wakeup |= XDP_WAKEUP_RX;
47 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
49 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
53 if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
57 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
58 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
62 pool->cached_need_wakeup |= XDP_WAKEUP_TX;
64 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
66 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
68 if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
71 pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
72 pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
74 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
76 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
80 if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
84 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
85 xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
89 pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
91 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
93 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
95 return pool->uses_need_wakeup;
97 EXPORT_SYMBOL(xsk_uses_need_wakeup);
99 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
102 if (queue_id < dev->real_num_rx_queues)
103 return dev->_rx[queue_id].pool;
104 if (queue_id < dev->real_num_tx_queues)
105 return dev->_tx[queue_id].pool;
109 EXPORT_SYMBOL(xsk_get_pool_from_qid);
111 void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
113 if (queue_id < dev->num_rx_queues)
114 dev->_rx[queue_id].pool = NULL;
115 if (queue_id < dev->num_tx_queues)
116 dev->_tx[queue_id].pool = NULL;
119 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
120 * not know if the device has more tx queues than rx, or the opposite.
121 * This might also change during run time.
123 int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
126 if (queue_id >= max_t(unsigned int,
127 dev->real_num_rx_queues,
128 dev->real_num_tx_queues))
131 if (queue_id < dev->real_num_rx_queues)
132 dev->_rx[queue_id].pool = pool;
133 if (queue_id < dev->real_num_tx_queues)
134 dev->_tx[queue_id].pool = pool;
139 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff_xsk *xskb, u32 len,
145 addr = xp_get_handle(xskb);
146 err = xskq_prod_reserve_desc(xs->rx, addr, len, flags);
156 static int xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
158 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
159 u32 frags = xdp_buff_has_frags(xdp);
160 struct xdp_buff_xsk *pos, *tmp;
161 struct list_head *xskb_list;
166 contd = XDP_PKT_CONTD;
168 err = __xsk_rcv_zc(xs, xskb, len, contd);
174 xskb_list = &xskb->pool->xskb_list;
175 list_for_each_entry_safe(pos, tmp, xskb_list, xskb_list_node) {
176 if (list_is_singular(xskb_list))
178 len = pos->xdp.data_end - pos->xdp.data;
179 err = __xsk_rcv_zc(xs, pos, len, contd);
182 list_del(&pos->xskb_list_node);
191 static void *xsk_copy_xdp_start(struct xdp_buff *from)
193 if (unlikely(xdp_data_meta_unsupported(from)))
196 return from->data_meta;
199 static u32 xsk_copy_xdp(void *to, void **from, u32 to_len,
200 u32 *from_len, skb_frag_t **frag, u32 rem)
205 u32 copy_len = min_t(u32, *from_len, to_len);
207 memcpy(to, *from, copy_len);
212 if (*from_len == copy_len) {
213 *from = skb_frag_address(*frag);
214 *from_len = skb_frag_size((*frag)++);
217 *from_len -= copy_len;
219 if (to_len == copy_len)
227 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
229 u32 frame_size = xsk_pool_get_rx_frame_size(xs->pool);
230 void *copy_from = xsk_copy_xdp_start(xdp), *copy_to;
231 u32 from_len, meta_len, rem, num_desc;
232 struct xdp_buff_xsk *xskb;
233 struct xdp_buff *xsk_xdp;
236 from_len = xdp->data_end - copy_from;
237 meta_len = xdp->data - copy_from;
238 rem = len + meta_len;
240 if (len <= frame_size && !xdp_buff_has_frags(xdp)) {
243 xsk_xdp = xsk_buff_alloc(xs->pool);
248 memcpy(xsk_xdp->data - meta_len, copy_from, rem);
249 xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
250 err = __xsk_rcv_zc(xs, xskb, len, 0);
252 xsk_buff_free(xsk_xdp);
259 num_desc = (len - 1) / frame_size + 1;
261 if (!xsk_buff_can_alloc(xs->pool, num_desc)) {
265 if (xskq_prod_nb_free(xs->rx, num_desc) < num_desc) {
270 if (xdp_buff_has_frags(xdp)) {
271 struct skb_shared_info *sinfo;
273 sinfo = xdp_get_shared_info_from_buff(xdp);
274 frag = &sinfo->frags[0];
278 u32 to_len = frame_size + meta_len;
281 xsk_xdp = xsk_buff_alloc(xs->pool);
282 copy_to = xsk_xdp->data - meta_len;
284 copied = xsk_copy_xdp(copy_to, ©_from, to_len, &from_len, &frag, rem);
287 xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
288 __xsk_rcv_zc(xs, xskb, copied - meta_len, rem ? XDP_PKT_CONTD : 0);
295 static bool xsk_tx_writeable(struct xdp_sock *xs)
297 if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
303 static bool xsk_is_bound(struct xdp_sock *xs)
305 if (READ_ONCE(xs->state) == XSK_BOUND) {
306 /* Matches smp_wmb() in bind(). */
313 static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
315 if (!xsk_is_bound(xs))
318 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
321 if (len > xsk_pool_get_rx_frame_size(xs->pool) && !xs->sg) {
326 sk_mark_napi_id_once_xdp(&xs->sk, xdp);
330 static void xsk_flush(struct xdp_sock *xs)
332 xskq_prod_submit(xs->rx);
333 __xskq_cons_release(xs->pool->fq);
334 sock_def_readable(&xs->sk);
337 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
339 u32 len = xdp_get_buff_len(xdp);
342 spin_lock_bh(&xs->rx_lock);
343 err = xsk_rcv_check(xs, xdp, len);
345 err = __xsk_rcv(xs, xdp, len);
348 spin_unlock_bh(&xs->rx_lock);
352 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
354 u32 len = xdp_get_buff_len(xdp);
357 err = xsk_rcv_check(xs, xdp, len);
361 if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
362 len = xdp->data_end - xdp->data;
363 return xsk_rcv_zc(xs, xdp, len);
366 err = __xsk_rcv(xs, xdp, len);
368 xdp_return_buff(xdp);
372 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
374 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
377 err = xsk_rcv(xs, xdp);
381 if (!xs->flush_node.prev)
382 list_add(&xs->flush_node, flush_list);
387 void __xsk_map_flush(void)
389 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
390 struct xdp_sock *xs, *tmp;
392 list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
394 __list_del_clearprev(&xs->flush_node);
398 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
400 xskq_prod_submit_n(pool->cq, nb_entries);
402 EXPORT_SYMBOL(xsk_tx_completed);
404 void xsk_tx_release(struct xsk_buff_pool *pool)
409 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
410 __xskq_cons_release(xs->tx);
411 if (xsk_tx_writeable(xs))
412 xs->sk.sk_write_space(&xs->sk);
416 EXPORT_SYMBOL(xsk_tx_release);
418 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
423 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
424 if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
425 if (xskq_has_descs(xs->tx))
426 xskq_cons_release(xs->tx);
430 /* This is the backpressure mechanism for the Tx path.
431 * Reserve space in the completion queue and only proceed
432 * if there is space in it. This avoids having to implement
433 * any buffering in the Tx path.
435 if (xskq_prod_reserve_addr(pool->cq, desc->addr))
438 xskq_cons_release(xs->tx);
447 EXPORT_SYMBOL(xsk_tx_peek_desc);
449 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
451 struct xdp_desc *descs = pool->tx_descs;
454 while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
457 xsk_tx_release(pool);
461 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
466 if (!list_is_singular(&pool->xsk_tx_list)) {
467 /* Fallback to the non-batched version */
469 return xsk_tx_peek_release_fallback(pool, nb_pkts);
472 xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
478 nb_pkts = xskq_cons_nb_entries(xs->tx, nb_pkts);
480 /* This is the backpressure mechanism for the Tx path. Try to
481 * reserve space in the completion queue for all packets, but
482 * if there are fewer slots available, just process that many
483 * packets. This avoids having to implement any buffering in
486 nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
490 nb_pkts = xskq_cons_read_desc_batch(xs->tx, pool, nb_pkts);
492 xs->tx->queue_empty_descs++;
496 __xskq_cons_release(xs->tx);
497 xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_pkts);
498 xs->sk.sk_write_space(&xs->sk);
504 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
506 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
508 struct net_device *dev = xs->dev;
510 return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
513 static int xsk_cq_reserve_addr_locked(struct xdp_sock *xs, u64 addr)
518 spin_lock_irqsave(&xs->pool->cq_lock, flags);
519 ret = xskq_prod_reserve_addr(xs->pool->cq, addr);
520 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
525 static void xsk_cq_submit_locked(struct xdp_sock *xs, u32 n)
529 spin_lock_irqsave(&xs->pool->cq_lock, flags);
530 xskq_prod_submit_n(xs->pool->cq, n);
531 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
534 static void xsk_cq_cancel_locked(struct xdp_sock *xs, u32 n)
538 spin_lock_irqsave(&xs->pool->cq_lock, flags);
539 xskq_prod_cancel_n(xs->pool->cq, n);
540 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
543 static u32 xsk_get_num_desc(struct sk_buff *skb)
545 return skb ? (long)skb_shinfo(skb)->destructor_arg : 0;
548 static void xsk_destruct_skb(struct sk_buff *skb)
550 xsk_cq_submit_locked(xdp_sk(skb->sk), xsk_get_num_desc(skb));
554 static void xsk_set_destructor_arg(struct sk_buff *skb)
556 long num = xsk_get_num_desc(xdp_sk(skb->sk)->skb) + 1;
558 skb_shinfo(skb)->destructor_arg = (void *)num;
561 static void xsk_consume_skb(struct sk_buff *skb)
563 struct xdp_sock *xs = xdp_sk(skb->sk);
565 skb->destructor = sock_wfree;
566 xsk_cq_cancel_locked(xs, xsk_get_num_desc(skb));
567 /* Free skb without triggering the perf drop trace */
572 static void xsk_drop_skb(struct sk_buff *skb)
574 xdp_sk(skb->sk)->tx->invalid_descs += xsk_get_num_desc(skb);
575 xsk_consume_skb(skb);
578 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
579 struct xdp_desc *desc)
581 struct xsk_buff_pool *pool = xs->pool;
582 u32 hr, len, ts, offset, copy, copied;
583 struct sk_buff *skb = xs->skb;
590 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
592 skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
596 skb_reserve(skb, hr);
601 ts = pool->unaligned ? len : pool->chunk_size;
603 buffer = xsk_buff_raw_get_data(pool, addr);
604 offset = offset_in_page(buffer);
605 addr = buffer - pool->addrs;
607 for (copied = 0, i = skb_shinfo(skb)->nr_frags; copied < len; i++) {
608 if (unlikely(i >= MAX_SKB_FRAGS))
609 return ERR_PTR(-EOVERFLOW);
611 page = pool->umem->pgs[addr >> PAGE_SHIFT];
614 copy = min_t(u32, PAGE_SIZE - offset, len - copied);
615 skb_fill_page_desc(skb, i, page, offset, copy);
623 skb->data_len += len;
626 refcount_add(ts, &xs->sk.sk_wmem_alloc);
631 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
632 struct xdp_desc *desc)
634 struct net_device *dev = xs->dev;
635 struct sk_buff *skb = xs->skb;
638 if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
639 skb = xsk_build_skb_zerocopy(xs, desc);
648 buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
652 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
653 tr = dev->needed_tailroom;
654 skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
658 skb_reserve(skb, hr);
661 err = skb_store_bits(skb, 0, buffer, len);
667 int nr_frags = skb_shinfo(skb)->nr_frags;
671 if (unlikely(nr_frags == (MAX_SKB_FRAGS - 1) && xp_mb_desc(desc))) {
676 page = alloc_page(xs->sk.sk_allocation);
677 if (unlikely(!page)) {
682 vaddr = kmap_local_page(page);
683 memcpy(vaddr, buffer, len);
686 skb_add_rx_frag(skb, nr_frags, page, 0, len, 0);
691 skb->priority = xs->sk.sk_priority;
692 skb->mark = READ_ONCE(xs->sk.sk_mark);
693 skb->destructor = xsk_destruct_skb;
694 xsk_set_destructor_arg(skb);
699 if (err == -EOVERFLOW) {
700 /* Drop the packet */
701 xsk_set_destructor_arg(xs->skb);
702 xsk_drop_skb(xs->skb);
703 xskq_cons_release(xs->tx);
705 /* Let application retry */
706 xsk_cq_cancel_locked(xs, 1);
712 static int __xsk_generic_xmit(struct sock *sk)
714 struct xdp_sock *xs = xdp_sk(sk);
715 u32 max_batch = TX_BATCH_SIZE;
716 bool sent_frame = false;
717 struct xdp_desc desc;
721 mutex_lock(&xs->mutex);
723 /* Since we dropped the RCU read lock, the socket state might have changed. */
724 if (unlikely(!xsk_is_bound(xs))) {
729 if (xs->queue_id >= xs->dev->real_num_tx_queues)
732 while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
733 if (max_batch-- == 0) {
738 /* This is the backpressure mechanism for the Tx path.
739 * Reserve space in the completion queue and only proceed
740 * if there is space in it. This avoids having to implement
741 * any buffering in the Tx path.
743 if (xsk_cq_reserve_addr_locked(xs, desc.addr))
746 skb = xsk_build_skb(xs, &desc);
749 if (err != -EOVERFLOW)
755 xskq_cons_release(xs->tx);
757 if (xp_mb_desc(&desc)) {
762 err = __dev_direct_xmit(skb, xs->queue_id);
763 if (err == NETDEV_TX_BUSY) {
764 /* Tell user-space to retry the send */
765 xskq_cons_cancel_n(xs->tx, xsk_get_num_desc(skb));
766 xsk_consume_skb(skb);
771 /* Ignore NET_XMIT_CN as packet might have been sent */
772 if (err == NET_XMIT_DROP) {
773 /* SKB completed but not sent */
783 if (xskq_has_descs(xs->tx)) {
785 xsk_drop_skb(xs->skb);
786 xskq_cons_release(xs->tx);
791 if (xsk_tx_writeable(xs))
792 sk->sk_write_space(sk);
794 mutex_unlock(&xs->mutex);
798 static int xsk_generic_xmit(struct sock *sk)
802 /* Drop the RCU lock since the SKB path might sleep. */
804 ret = __xsk_generic_xmit(sk);
805 /* Reaquire RCU lock before going into common code. */
811 static bool xsk_no_wakeup(struct sock *sk)
813 #ifdef CONFIG_NET_RX_BUSY_POLL
814 /* Prefer busy-polling, skip the wakeup. */
815 return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
816 READ_ONCE(sk->sk_napi_id) >= MIN_NAPI_ID;
822 static int xsk_check_common(struct xdp_sock *xs)
824 if (unlikely(!xsk_is_bound(xs)))
826 if (unlikely(!(xs->dev->flags & IFF_UP)))
832 static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
834 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
835 struct sock *sk = sock->sk;
836 struct xdp_sock *xs = xdp_sk(sk);
837 struct xsk_buff_pool *pool;
840 err = xsk_check_common(xs);
843 if (unlikely(need_wait))
845 if (unlikely(!xs->tx))
848 if (sk_can_busy_loop(sk)) {
850 __sk_mark_napi_id_once(sk, xsk_pool_get_napi_id(xs->pool));
851 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
854 if (xs->zc && xsk_no_wakeup(sk))
858 if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
860 return xsk_wakeup(xs, XDP_WAKEUP_TX);
861 return xsk_generic_xmit(sk);
866 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
871 ret = __xsk_sendmsg(sock, m, total_len);
877 static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
879 bool need_wait = !(flags & MSG_DONTWAIT);
880 struct sock *sk = sock->sk;
881 struct xdp_sock *xs = xdp_sk(sk);
884 err = xsk_check_common(xs);
887 if (unlikely(!xs->rx))
889 if (unlikely(need_wait))
892 if (sk_can_busy_loop(sk))
893 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
895 if (xsk_no_wakeup(sk))
898 if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
899 return xsk_wakeup(xs, XDP_WAKEUP_RX);
903 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
908 ret = __xsk_recvmsg(sock, m, len, flags);
914 static __poll_t xsk_poll(struct file *file, struct socket *sock,
915 struct poll_table_struct *wait)
918 struct sock *sk = sock->sk;
919 struct xdp_sock *xs = xdp_sk(sk);
920 struct xsk_buff_pool *pool;
922 sock_poll_wait(file, sock, wait);
925 if (xsk_check_common(xs))
930 if (pool->cached_need_wakeup) {
932 xsk_wakeup(xs, pool->cached_need_wakeup);
934 /* Poll needs to drive Tx also in copy mode */
935 xsk_generic_xmit(sk);
938 if (xs->rx && !xskq_prod_is_empty(xs->rx))
939 mask |= EPOLLIN | EPOLLRDNORM;
940 if (xs->tx && xsk_tx_writeable(xs))
941 mask |= EPOLLOUT | EPOLLWRNORM;
947 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
952 if (entries == 0 || *queue || !is_power_of_2(entries))
955 q = xskq_create(entries, umem_queue);
959 /* Make sure queue is ready before it can be seen by others */
961 WRITE_ONCE(*queue, q);
965 static void xsk_unbind_dev(struct xdp_sock *xs)
967 struct net_device *dev = xs->dev;
969 if (xs->state != XSK_BOUND)
971 WRITE_ONCE(xs->state, XSK_UNBOUND);
973 /* Wait for driver to stop using the xdp socket. */
974 xp_del_xsk(xs->pool, xs);
979 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
980 struct xdp_sock __rcu ***map_entry)
982 struct xsk_map *map = NULL;
983 struct xsk_map_node *node;
987 spin_lock_bh(&xs->map_list_lock);
988 node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
991 bpf_map_inc(&node->map->map);
993 *map_entry = node->map_entry;
995 spin_unlock_bh(&xs->map_list_lock);
999 static void xsk_delete_from_maps(struct xdp_sock *xs)
1001 /* This function removes the current XDP socket from all the
1002 * maps it resides in. We need to take extra care here, due to
1003 * the two locks involved. Each map has a lock synchronizing
1004 * updates to the entries, and each socket has a lock that
1005 * synchronizes access to the list of maps (map_list). For
1006 * deadlock avoidance the locks need to be taken in the order
1007 * "map lock"->"socket map list lock". We start off by
1008 * accessing the socket map list, and take a reference to the
1009 * map to guarantee existence between the
1010 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
1011 * calls. Then we ask the map to remove the socket, which
1012 * tries to remove the socket from the map. Note that there
1013 * might be updates to the map between
1014 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
1016 struct xdp_sock __rcu **map_entry = NULL;
1017 struct xsk_map *map;
1019 while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
1020 xsk_map_try_sock_delete(map, xs, map_entry);
1021 bpf_map_put(&map->map);
1025 static int xsk_release(struct socket *sock)
1027 struct sock *sk = sock->sk;
1028 struct xdp_sock *xs = xdp_sk(sk);
1037 xsk_drop_skb(xs->skb);
1039 mutex_lock(&net->xdp.lock);
1040 sk_del_node_init_rcu(sk);
1041 mutex_unlock(&net->xdp.lock);
1043 sock_prot_inuse_add(net, sk->sk_prot, -1);
1045 xsk_delete_from_maps(xs);
1046 mutex_lock(&xs->mutex);
1048 mutex_unlock(&xs->mutex);
1050 xskq_destroy(xs->rx);
1051 xskq_destroy(xs->tx);
1052 xskq_destroy(xs->fq_tmp);
1053 xskq_destroy(xs->cq_tmp);
1063 static struct socket *xsk_lookup_xsk_from_fd(int fd)
1065 struct socket *sock;
1068 sock = sockfd_lookup(fd, &err);
1070 return ERR_PTR(-ENOTSOCK);
1072 if (sock->sk->sk_family != PF_XDP) {
1074 return ERR_PTR(-ENOPROTOOPT);
1080 static bool xsk_validate_queues(struct xdp_sock *xs)
1082 return xs->fq_tmp && xs->cq_tmp;
1085 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
1087 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
1088 struct sock *sk = sock->sk;
1089 struct xdp_sock *xs = xdp_sk(sk);
1090 struct net_device *dev;
1095 if (addr_len < sizeof(struct sockaddr_xdp))
1097 if (sxdp->sxdp_family != AF_XDP)
1100 flags = sxdp->sxdp_flags;
1101 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
1102 XDP_USE_NEED_WAKEUP | XDP_USE_SG))
1105 bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
1106 if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
1110 mutex_lock(&xs->mutex);
1111 if (xs->state != XSK_READY) {
1116 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
1122 if (!xs->rx && !xs->tx) {
1127 qid = sxdp->sxdp_queue_id;
1129 if (flags & XDP_SHARED_UMEM) {
1130 struct xdp_sock *umem_xs;
1131 struct socket *sock;
1133 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
1134 (flags & XDP_USE_NEED_WAKEUP) || (flags & XDP_USE_SG)) {
1135 /* Cannot specify flags for shared sockets. */
1141 /* We have already our own. */
1146 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
1148 err = PTR_ERR(sock);
1152 umem_xs = xdp_sk(sock->sk);
1153 if (!xsk_is_bound(umem_xs)) {
1159 if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
1160 /* Share the umem with another socket on another qid
1163 xs->pool = xp_create_and_assign_umem(xs,
1171 err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
1174 xp_destroy(xs->pool);
1180 /* Share the buffer pool with the other socket. */
1181 if (xs->fq_tmp || xs->cq_tmp) {
1182 /* Do not allow setting your own fq or cq. */
1188 xp_get_pool(umem_xs->pool);
1189 xs->pool = umem_xs->pool;
1191 /* If underlying shared umem was created without Tx
1192 * ring, allocate Tx descs array that Tx batching API
1195 if (xs->tx && !xs->pool->tx_descs) {
1196 err = xp_alloc_tx_descs(xs->pool, xs);
1198 xp_put_pool(xs->pool);
1206 xdp_get_umem(umem_xs->umem);
1207 WRITE_ONCE(xs->umem, umem_xs->umem);
1209 } else if (!xs->umem || !xsk_validate_queues(xs)) {
1213 /* This xsk has its own umem. */
1214 xs->pool = xp_create_and_assign_umem(xs, xs->umem);
1220 err = xp_assign_dev(xs->pool, dev, qid, flags);
1222 xp_destroy(xs->pool);
1228 /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
1233 xs->zc = xs->umem->zc;
1234 xs->sg = !!(xs->umem->flags & XDP_UMEM_SG_FLAG);
1236 xp_add_xsk(xs->pool, xs);
1242 /* Matches smp_rmb() in bind() for shared umem
1243 * sockets, and xsk_is_bound().
1246 WRITE_ONCE(xs->state, XSK_BOUND);
1249 mutex_unlock(&xs->mutex);
1254 struct xdp_umem_reg_v1 {
1255 __u64 addr; /* Start of packet data area */
1256 __u64 len; /* Length of packet data area */
1261 static int xsk_setsockopt(struct socket *sock, int level, int optname,
1262 sockptr_t optval, unsigned int optlen)
1264 struct sock *sk = sock->sk;
1265 struct xdp_sock *xs = xdp_sk(sk);
1268 if (level != SOL_XDP)
1269 return -ENOPROTOOPT;
1275 struct xsk_queue **q;
1278 if (optlen < sizeof(entries))
1280 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1283 mutex_lock(&xs->mutex);
1284 if (xs->state != XSK_READY) {
1285 mutex_unlock(&xs->mutex);
1288 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1289 err = xsk_init_queue(entries, q, false);
1290 if (!err && optname == XDP_TX_RING)
1291 /* Tx needs to be explicitly woken up the first time */
1292 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1293 mutex_unlock(&xs->mutex);
1298 size_t mr_size = sizeof(struct xdp_umem_reg);
1299 struct xdp_umem_reg mr = {};
1300 struct xdp_umem *umem;
1302 if (optlen < sizeof(struct xdp_umem_reg_v1))
1304 else if (optlen < sizeof(mr))
1305 mr_size = sizeof(struct xdp_umem_reg_v1);
1307 if (copy_from_sockptr(&mr, optval, mr_size))
1310 mutex_lock(&xs->mutex);
1311 if (xs->state != XSK_READY || xs->umem) {
1312 mutex_unlock(&xs->mutex);
1316 umem = xdp_umem_create(&mr);
1318 mutex_unlock(&xs->mutex);
1319 return PTR_ERR(umem);
1322 /* Make sure umem is ready before it can be seen by others */
1324 WRITE_ONCE(xs->umem, umem);
1325 mutex_unlock(&xs->mutex);
1328 case XDP_UMEM_FILL_RING:
1329 case XDP_UMEM_COMPLETION_RING:
1331 struct xsk_queue **q;
1334 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1337 mutex_lock(&xs->mutex);
1338 if (xs->state != XSK_READY) {
1339 mutex_unlock(&xs->mutex);
1343 q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1345 err = xsk_init_queue(entries, q, true);
1346 mutex_unlock(&xs->mutex);
1353 return -ENOPROTOOPT;
1356 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1358 ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1359 ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1360 ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1363 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1365 ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1366 ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1367 ring->desc = offsetof(struct xdp_umem_ring, desc);
1370 struct xdp_statistics_v1 {
1372 __u64 rx_invalid_descs;
1373 __u64 tx_invalid_descs;
1376 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1377 char __user *optval, int __user *optlen)
1379 struct sock *sk = sock->sk;
1380 struct xdp_sock *xs = xdp_sk(sk);
1383 if (level != SOL_XDP)
1384 return -ENOPROTOOPT;
1386 if (get_user(len, optlen))
1392 case XDP_STATISTICS:
1394 struct xdp_statistics stats = {};
1395 bool extra_stats = true;
1398 if (len < sizeof(struct xdp_statistics_v1)) {
1400 } else if (len < sizeof(stats)) {
1401 extra_stats = false;
1402 stats_size = sizeof(struct xdp_statistics_v1);
1404 stats_size = sizeof(stats);
1407 mutex_lock(&xs->mutex);
1408 stats.rx_dropped = xs->rx_dropped;
1410 stats.rx_ring_full = xs->rx_queue_full;
1411 stats.rx_fill_ring_empty_descs =
1412 xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1413 stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1415 stats.rx_dropped += xs->rx_queue_full;
1417 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1418 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1419 mutex_unlock(&xs->mutex);
1421 if (copy_to_user(optval, &stats, stats_size))
1423 if (put_user(stats_size, optlen))
1428 case XDP_MMAP_OFFSETS:
1430 struct xdp_mmap_offsets off;
1431 struct xdp_mmap_offsets_v1 off_v1;
1432 bool flags_supported = true;
1435 if (len < sizeof(off_v1))
1437 else if (len < sizeof(off))
1438 flags_supported = false;
1440 if (flags_supported) {
1441 /* xdp_ring_offset is identical to xdp_ring_offset_v1
1442 * except for the flags field added to the end.
1444 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1446 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1448 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1450 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1452 off.rx.flags = offsetof(struct xdp_rxtx_ring,
1454 off.tx.flags = offsetof(struct xdp_rxtx_ring,
1456 off.fr.flags = offsetof(struct xdp_umem_ring,
1458 off.cr.flags = offsetof(struct xdp_umem_ring,
1464 xsk_enter_rxtx_offsets(&off_v1.rx);
1465 xsk_enter_rxtx_offsets(&off_v1.tx);
1466 xsk_enter_umem_offsets(&off_v1.fr);
1467 xsk_enter_umem_offsets(&off_v1.cr);
1469 len = sizeof(off_v1);
1473 if (copy_to_user(optval, to_copy, len))
1475 if (put_user(len, optlen))
1482 struct xdp_options opts = {};
1484 if (len < sizeof(opts))
1487 mutex_lock(&xs->mutex);
1489 opts.flags |= XDP_OPTIONS_ZEROCOPY;
1490 mutex_unlock(&xs->mutex);
1493 if (copy_to_user(optval, &opts, len))
1495 if (put_user(len, optlen))
1507 static int xsk_mmap(struct file *file, struct socket *sock,
1508 struct vm_area_struct *vma)
1510 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1511 unsigned long size = vma->vm_end - vma->vm_start;
1512 struct xdp_sock *xs = xdp_sk(sock->sk);
1513 int state = READ_ONCE(xs->state);
1514 struct xsk_queue *q = NULL;
1516 if (state != XSK_READY && state != XSK_BOUND)
1519 if (offset == XDP_PGOFF_RX_RING) {
1520 q = READ_ONCE(xs->rx);
1521 } else if (offset == XDP_PGOFF_TX_RING) {
1522 q = READ_ONCE(xs->tx);
1524 /* Matches the smp_wmb() in XDP_UMEM_REG */
1526 if (offset == XDP_UMEM_PGOFF_FILL_RING)
1527 q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
1528 READ_ONCE(xs->pool->fq);
1529 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1530 q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
1531 READ_ONCE(xs->pool->cq);
1537 /* Matches the smp_wmb() in xsk_init_queue */
1539 if (size > q->ring_vmalloc_size)
1542 return remap_vmalloc_range(vma, q->ring, 0);
1545 static int xsk_notifier(struct notifier_block *this,
1546 unsigned long msg, void *ptr)
1548 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1549 struct net *net = dev_net(dev);
1553 case NETDEV_UNREGISTER:
1554 mutex_lock(&net->xdp.lock);
1555 sk_for_each(sk, &net->xdp.list) {
1556 struct xdp_sock *xs = xdp_sk(sk);
1558 mutex_lock(&xs->mutex);
1559 if (xs->dev == dev) {
1560 sk->sk_err = ENETDOWN;
1561 if (!sock_flag(sk, SOCK_DEAD))
1562 sk_error_report(sk);
1566 /* Clear device references. */
1567 xp_clear_dev(xs->pool);
1569 mutex_unlock(&xs->mutex);
1571 mutex_unlock(&net->xdp.lock);
1577 static struct proto xsk_proto = {
1579 .owner = THIS_MODULE,
1580 .obj_size = sizeof(struct xdp_sock),
1583 static const struct proto_ops xsk_proto_ops = {
1585 .owner = THIS_MODULE,
1586 .release = xsk_release,
1588 .connect = sock_no_connect,
1589 .socketpair = sock_no_socketpair,
1590 .accept = sock_no_accept,
1591 .getname = sock_no_getname,
1593 .ioctl = sock_no_ioctl,
1594 .listen = sock_no_listen,
1595 .shutdown = sock_no_shutdown,
1596 .setsockopt = xsk_setsockopt,
1597 .getsockopt = xsk_getsockopt,
1598 .sendmsg = xsk_sendmsg,
1599 .recvmsg = xsk_recvmsg,
1603 static void xsk_destruct(struct sock *sk)
1605 struct xdp_sock *xs = xdp_sk(sk);
1607 if (!sock_flag(sk, SOCK_DEAD))
1610 if (!xp_put_pool(xs->pool))
1611 xdp_put_umem(xs->umem, !xs->pool);
1614 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1617 struct xdp_sock *xs;
1620 if (!ns_capable(net->user_ns, CAP_NET_RAW))
1622 if (sock->type != SOCK_RAW)
1623 return -ESOCKTNOSUPPORT;
1626 return -EPROTONOSUPPORT;
1628 sock->state = SS_UNCONNECTED;
1630 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1634 sock->ops = &xsk_proto_ops;
1636 sock_init_data(sock, sk);
1638 sk->sk_family = PF_XDP;
1640 sk->sk_destruct = xsk_destruct;
1642 sock_set_flag(sk, SOCK_RCU_FREE);
1645 xs->state = XSK_READY;
1646 mutex_init(&xs->mutex);
1647 spin_lock_init(&xs->rx_lock);
1649 INIT_LIST_HEAD(&xs->map_list);
1650 spin_lock_init(&xs->map_list_lock);
1652 mutex_lock(&net->xdp.lock);
1653 sk_add_node_rcu(sk, &net->xdp.list);
1654 mutex_unlock(&net->xdp.lock);
1656 sock_prot_inuse_add(net, &xsk_proto, 1);
1661 static const struct net_proto_family xsk_family_ops = {
1663 .create = xsk_create,
1664 .owner = THIS_MODULE,
1667 static struct notifier_block xsk_netdev_notifier = {
1668 .notifier_call = xsk_notifier,
1671 static int __net_init xsk_net_init(struct net *net)
1673 mutex_init(&net->xdp.lock);
1674 INIT_HLIST_HEAD(&net->xdp.list);
1678 static void __net_exit xsk_net_exit(struct net *net)
1680 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1683 static struct pernet_operations xsk_net_ops = {
1684 .init = xsk_net_init,
1685 .exit = xsk_net_exit,
1688 static int __init xsk_init(void)
1692 err = proto_register(&xsk_proto, 0 /* no slab */);
1696 err = sock_register(&xsk_family_ops);
1700 err = register_pernet_subsys(&xsk_net_ops);
1704 err = register_netdevice_notifier(&xsk_netdev_notifier);
1708 for_each_possible_cpu(cpu)
1709 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list, cpu));
1713 unregister_pernet_subsys(&xsk_net_ops);
1715 sock_unregister(PF_XDP);
1717 proto_unregister(&xsk_proto);
1722 fs_initcall(xsk_init);