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 struct net_device *dev = xdp->rxq->dev;
317 u32 qid = xdp->rxq->queue_index;
319 if (!xsk_is_bound(xs))
322 if (!dev->_rx[qid].pool || xs->umem != dev->_rx[qid].pool->umem)
325 if (len > xsk_pool_get_rx_frame_size(xs->pool) && !xs->sg) {
330 sk_mark_napi_id_once_xdp(&xs->sk, xdp);
334 static void xsk_flush(struct xdp_sock *xs)
336 xskq_prod_submit(xs->rx);
337 __xskq_cons_release(xs->pool->fq);
338 sock_def_readable(&xs->sk);
341 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
343 u32 len = xdp_get_buff_len(xdp);
346 spin_lock_bh(&xs->rx_lock);
347 err = xsk_rcv_check(xs, xdp, len);
349 err = __xsk_rcv(xs, xdp, len);
352 spin_unlock_bh(&xs->rx_lock);
356 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
358 u32 len = xdp_get_buff_len(xdp);
361 err = xsk_rcv_check(xs, xdp, len);
365 if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
366 len = xdp->data_end - xdp->data;
367 return xsk_rcv_zc(xs, xdp, len);
370 err = __xsk_rcv(xs, xdp, len);
372 xdp_return_buff(xdp);
376 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
378 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
381 err = xsk_rcv(xs, xdp);
385 if (!xs->flush_node.prev)
386 list_add(&xs->flush_node, flush_list);
391 void __xsk_map_flush(void)
393 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
394 struct xdp_sock *xs, *tmp;
396 list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
398 __list_del_clearprev(&xs->flush_node);
402 #ifdef CONFIG_DEBUG_NET
403 bool xsk_map_check_flush(void)
405 if (list_empty(this_cpu_ptr(&xskmap_flush_list)))
412 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
414 xskq_prod_submit_n(pool->cq, nb_entries);
416 EXPORT_SYMBOL(xsk_tx_completed);
418 void xsk_tx_release(struct xsk_buff_pool *pool)
423 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
424 __xskq_cons_release(xs->tx);
425 if (xsk_tx_writeable(xs))
426 xs->sk.sk_write_space(&xs->sk);
430 EXPORT_SYMBOL(xsk_tx_release);
432 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
434 bool budget_exhausted = false;
439 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
440 if (xs->tx_budget_spent >= MAX_PER_SOCKET_BUDGET) {
441 budget_exhausted = true;
445 if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
446 if (xskq_has_descs(xs->tx))
447 xskq_cons_release(xs->tx);
451 xs->tx_budget_spent++;
453 /* This is the backpressure mechanism for the Tx path.
454 * Reserve space in the completion queue and only proceed
455 * if there is space in it. This avoids having to implement
456 * any buffering in the Tx path.
458 if (xskq_prod_reserve_addr(pool->cq, desc->addr))
461 xskq_cons_release(xs->tx);
466 if (budget_exhausted) {
467 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
468 xs->tx_budget_spent = 0;
470 budget_exhausted = false;
478 EXPORT_SYMBOL(xsk_tx_peek_desc);
480 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
482 struct xdp_desc *descs = pool->tx_descs;
485 while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
488 xsk_tx_release(pool);
492 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
497 if (!list_is_singular(&pool->xsk_tx_list)) {
498 /* Fallback to the non-batched version */
500 return xsk_tx_peek_release_fallback(pool, nb_pkts);
503 xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
509 nb_pkts = xskq_cons_nb_entries(xs->tx, nb_pkts);
511 /* This is the backpressure mechanism for the Tx path. Try to
512 * reserve space in the completion queue for all packets, but
513 * if there are fewer slots available, just process that many
514 * packets. This avoids having to implement any buffering in
517 nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
521 nb_pkts = xskq_cons_read_desc_batch(xs->tx, pool, nb_pkts);
523 xs->tx->queue_empty_descs++;
527 __xskq_cons_release(xs->tx);
528 xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_pkts);
529 xs->sk.sk_write_space(&xs->sk);
535 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
537 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
539 struct net_device *dev = xs->dev;
541 return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
544 static int xsk_cq_reserve_addr_locked(struct xdp_sock *xs, u64 addr)
549 spin_lock_irqsave(&xs->pool->cq_lock, flags);
550 ret = xskq_prod_reserve_addr(xs->pool->cq, addr);
551 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
556 static void xsk_cq_submit_locked(struct xdp_sock *xs, u32 n)
560 spin_lock_irqsave(&xs->pool->cq_lock, flags);
561 xskq_prod_submit_n(xs->pool->cq, n);
562 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
565 static void xsk_cq_cancel_locked(struct xdp_sock *xs, u32 n)
569 spin_lock_irqsave(&xs->pool->cq_lock, flags);
570 xskq_prod_cancel_n(xs->pool->cq, n);
571 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
574 static u32 xsk_get_num_desc(struct sk_buff *skb)
576 return skb ? (long)skb_shinfo(skb)->destructor_arg : 0;
579 static void xsk_destruct_skb(struct sk_buff *skb)
581 struct xsk_tx_metadata_compl *compl = &skb_shinfo(skb)->xsk_meta;
583 if (compl->tx_timestamp) {
584 /* sw completion timestamp, not a real one */
585 *compl->tx_timestamp = ktime_get_tai_fast_ns();
588 xsk_cq_submit_locked(xdp_sk(skb->sk), xsk_get_num_desc(skb));
592 static void xsk_set_destructor_arg(struct sk_buff *skb)
594 long num = xsk_get_num_desc(xdp_sk(skb->sk)->skb) + 1;
596 skb_shinfo(skb)->destructor_arg = (void *)num;
599 static void xsk_consume_skb(struct sk_buff *skb)
601 struct xdp_sock *xs = xdp_sk(skb->sk);
603 skb->destructor = sock_wfree;
604 xsk_cq_cancel_locked(xs, xsk_get_num_desc(skb));
605 /* Free skb without triggering the perf drop trace */
610 static void xsk_drop_skb(struct sk_buff *skb)
612 xdp_sk(skb->sk)->tx->invalid_descs += xsk_get_num_desc(skb);
613 xsk_consume_skb(skb);
616 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
617 struct xdp_desc *desc)
619 struct xsk_buff_pool *pool = xs->pool;
620 u32 hr, len, ts, offset, copy, copied;
621 struct sk_buff *skb = xs->skb;
628 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
630 skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
634 skb_reserve(skb, hr);
639 ts = pool->unaligned ? len : pool->chunk_size;
641 buffer = xsk_buff_raw_get_data(pool, addr);
642 offset = offset_in_page(buffer);
643 addr = buffer - pool->addrs;
645 for (copied = 0, i = skb_shinfo(skb)->nr_frags; copied < len; i++) {
646 if (unlikely(i >= MAX_SKB_FRAGS))
647 return ERR_PTR(-EOVERFLOW);
649 page = pool->umem->pgs[addr >> PAGE_SHIFT];
652 copy = min_t(u32, PAGE_SIZE - offset, len - copied);
653 skb_fill_page_desc(skb, i, page, offset, copy);
661 skb->data_len += len;
664 refcount_add(ts, &xs->sk.sk_wmem_alloc);
669 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
670 struct xdp_desc *desc)
672 struct xsk_tx_metadata *meta = NULL;
673 struct net_device *dev = xs->dev;
674 struct sk_buff *skb = xs->skb;
675 bool first_frag = false;
678 if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
679 skb = xsk_build_skb_zerocopy(xs, desc);
688 buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
692 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
693 tr = dev->needed_tailroom;
694 skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
698 skb_reserve(skb, hr);
701 err = skb_store_bits(skb, 0, buffer, len);
709 int nr_frags = skb_shinfo(skb)->nr_frags;
713 if (unlikely(nr_frags == (MAX_SKB_FRAGS - 1) && xp_mb_desc(desc))) {
718 page = alloc_page(xs->sk.sk_allocation);
719 if (unlikely(!page)) {
724 vaddr = kmap_local_page(page);
725 memcpy(vaddr, buffer, len);
728 skb_add_rx_frag(skb, nr_frags, page, 0, len, PAGE_SIZE);
729 refcount_add(PAGE_SIZE, &xs->sk.sk_wmem_alloc);
732 if (first_frag && desc->options & XDP_TX_METADATA) {
733 if (unlikely(xs->pool->tx_metadata_len == 0)) {
738 meta = buffer - xs->pool->tx_metadata_len;
739 if (unlikely(!xsk_buff_valid_tx_metadata(meta))) {
744 if (meta->flags & XDP_TXMD_FLAGS_CHECKSUM) {
745 if (unlikely(meta->request.csum_start +
746 meta->request.csum_offset +
747 sizeof(__sum16) > len)) {
752 skb->csum_start = hr + meta->request.csum_start;
753 skb->csum_offset = meta->request.csum_offset;
754 skb->ip_summed = CHECKSUM_PARTIAL;
756 if (unlikely(xs->pool->tx_sw_csum)) {
757 err = skb_checksum_help(skb);
766 skb->priority = READ_ONCE(xs->sk.sk_priority);
767 skb->mark = READ_ONCE(xs->sk.sk_mark);
768 skb->destructor = xsk_destruct_skb;
769 xsk_tx_metadata_to_compl(meta, &skb_shinfo(skb)->xsk_meta);
770 xsk_set_destructor_arg(skb);
775 if (err == -EOVERFLOW) {
776 /* Drop the packet */
777 xsk_set_destructor_arg(xs->skb);
778 xsk_drop_skb(xs->skb);
779 xskq_cons_release(xs->tx);
781 /* Let application retry */
782 xsk_cq_cancel_locked(xs, 1);
788 static int __xsk_generic_xmit(struct sock *sk)
790 struct xdp_sock *xs = xdp_sk(sk);
791 u32 max_batch = TX_BATCH_SIZE;
792 bool sent_frame = false;
793 struct xdp_desc desc;
797 mutex_lock(&xs->mutex);
799 /* Since we dropped the RCU read lock, the socket state might have changed. */
800 if (unlikely(!xsk_is_bound(xs))) {
805 if (xs->queue_id >= xs->dev->real_num_tx_queues)
808 while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
809 if (max_batch-- == 0) {
814 /* This is the backpressure mechanism for the Tx path.
815 * Reserve space in the completion queue and only proceed
816 * if there is space in it. This avoids having to implement
817 * any buffering in the Tx path.
819 if (xsk_cq_reserve_addr_locked(xs, desc.addr))
822 skb = xsk_build_skb(xs, &desc);
825 if (err != -EOVERFLOW)
831 xskq_cons_release(xs->tx);
833 if (xp_mb_desc(&desc)) {
838 err = __dev_direct_xmit(skb, xs->queue_id);
839 if (err == NETDEV_TX_BUSY) {
840 /* Tell user-space to retry the send */
841 xskq_cons_cancel_n(xs->tx, xsk_get_num_desc(skb));
842 xsk_consume_skb(skb);
847 /* Ignore NET_XMIT_CN as packet might have been sent */
848 if (err == NET_XMIT_DROP) {
849 /* SKB completed but not sent */
859 if (xskq_has_descs(xs->tx)) {
861 xsk_drop_skb(xs->skb);
862 xskq_cons_release(xs->tx);
867 if (xsk_tx_writeable(xs))
868 sk->sk_write_space(sk);
870 mutex_unlock(&xs->mutex);
874 static int xsk_generic_xmit(struct sock *sk)
878 /* Drop the RCU lock since the SKB path might sleep. */
880 ret = __xsk_generic_xmit(sk);
881 /* Reaquire RCU lock before going into common code. */
887 static bool xsk_no_wakeup(struct sock *sk)
889 #ifdef CONFIG_NET_RX_BUSY_POLL
890 /* Prefer busy-polling, skip the wakeup. */
891 return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
892 READ_ONCE(sk->sk_napi_id) >= MIN_NAPI_ID;
898 static int xsk_check_common(struct xdp_sock *xs)
900 if (unlikely(!xsk_is_bound(xs)))
902 if (unlikely(!(xs->dev->flags & IFF_UP)))
908 static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
910 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
911 struct sock *sk = sock->sk;
912 struct xdp_sock *xs = xdp_sk(sk);
913 struct xsk_buff_pool *pool;
916 err = xsk_check_common(xs);
919 if (unlikely(need_wait))
921 if (unlikely(!xs->tx))
924 if (sk_can_busy_loop(sk)) {
926 __sk_mark_napi_id_once(sk, xsk_pool_get_napi_id(xs->pool));
927 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
930 if (xs->zc && xsk_no_wakeup(sk))
934 if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
936 return xsk_wakeup(xs, XDP_WAKEUP_TX);
937 return xsk_generic_xmit(sk);
942 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
947 ret = __xsk_sendmsg(sock, m, total_len);
953 static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
955 bool need_wait = !(flags & MSG_DONTWAIT);
956 struct sock *sk = sock->sk;
957 struct xdp_sock *xs = xdp_sk(sk);
960 err = xsk_check_common(xs);
963 if (unlikely(!xs->rx))
965 if (unlikely(need_wait))
968 if (sk_can_busy_loop(sk))
969 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
971 if (xsk_no_wakeup(sk))
974 if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
975 return xsk_wakeup(xs, XDP_WAKEUP_RX);
979 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
984 ret = __xsk_recvmsg(sock, m, len, flags);
990 static __poll_t xsk_poll(struct file *file, struct socket *sock,
991 struct poll_table_struct *wait)
994 struct sock *sk = sock->sk;
995 struct xdp_sock *xs = xdp_sk(sk);
996 struct xsk_buff_pool *pool;
998 sock_poll_wait(file, sock, wait);
1001 if (xsk_check_common(xs))
1006 if (pool->cached_need_wakeup) {
1008 xsk_wakeup(xs, pool->cached_need_wakeup);
1010 /* Poll needs to drive Tx also in copy mode */
1011 xsk_generic_xmit(sk);
1014 if (xs->rx && !xskq_prod_is_empty(xs->rx))
1015 mask |= EPOLLIN | EPOLLRDNORM;
1016 if (xs->tx && xsk_tx_writeable(xs))
1017 mask |= EPOLLOUT | EPOLLWRNORM;
1023 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
1026 struct xsk_queue *q;
1028 if (entries == 0 || *queue || !is_power_of_2(entries))
1031 q = xskq_create(entries, umem_queue);
1035 /* Make sure queue is ready before it can be seen by others */
1037 WRITE_ONCE(*queue, q);
1041 static void xsk_unbind_dev(struct xdp_sock *xs)
1043 struct net_device *dev = xs->dev;
1045 if (xs->state != XSK_BOUND)
1047 WRITE_ONCE(xs->state, XSK_UNBOUND);
1049 /* Wait for driver to stop using the xdp socket. */
1050 xp_del_xsk(xs->pool, xs);
1055 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
1056 struct xdp_sock __rcu ***map_entry)
1058 struct xsk_map *map = NULL;
1059 struct xsk_map_node *node;
1063 spin_lock_bh(&xs->map_list_lock);
1064 node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
1067 bpf_map_inc(&node->map->map);
1069 *map_entry = node->map_entry;
1071 spin_unlock_bh(&xs->map_list_lock);
1075 static void xsk_delete_from_maps(struct xdp_sock *xs)
1077 /* This function removes the current XDP socket from all the
1078 * maps it resides in. We need to take extra care here, due to
1079 * the two locks involved. Each map has a lock synchronizing
1080 * updates to the entries, and each socket has a lock that
1081 * synchronizes access to the list of maps (map_list). For
1082 * deadlock avoidance the locks need to be taken in the order
1083 * "map lock"->"socket map list lock". We start off by
1084 * accessing the socket map list, and take a reference to the
1085 * map to guarantee existence between the
1086 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
1087 * calls. Then we ask the map to remove the socket, which
1088 * tries to remove the socket from the map. Note that there
1089 * might be updates to the map between
1090 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
1092 struct xdp_sock __rcu **map_entry = NULL;
1093 struct xsk_map *map;
1095 while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
1096 xsk_map_try_sock_delete(map, xs, map_entry);
1097 bpf_map_put(&map->map);
1101 static int xsk_release(struct socket *sock)
1103 struct sock *sk = sock->sk;
1104 struct xdp_sock *xs = xdp_sk(sk);
1113 xsk_drop_skb(xs->skb);
1115 mutex_lock(&net->xdp.lock);
1116 sk_del_node_init_rcu(sk);
1117 mutex_unlock(&net->xdp.lock);
1119 sock_prot_inuse_add(net, sk->sk_prot, -1);
1121 xsk_delete_from_maps(xs);
1122 mutex_lock(&xs->mutex);
1124 mutex_unlock(&xs->mutex);
1126 xskq_destroy(xs->rx);
1127 xskq_destroy(xs->tx);
1128 xskq_destroy(xs->fq_tmp);
1129 xskq_destroy(xs->cq_tmp);
1139 static struct socket *xsk_lookup_xsk_from_fd(int fd)
1141 struct socket *sock;
1144 sock = sockfd_lookup(fd, &err);
1146 return ERR_PTR(-ENOTSOCK);
1148 if (sock->sk->sk_family != PF_XDP) {
1150 return ERR_PTR(-ENOPROTOOPT);
1156 static bool xsk_validate_queues(struct xdp_sock *xs)
1158 return xs->fq_tmp && xs->cq_tmp;
1161 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
1163 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
1164 struct sock *sk = sock->sk;
1165 struct xdp_sock *xs = xdp_sk(sk);
1166 struct net_device *dev;
1171 if (addr_len < sizeof(struct sockaddr_xdp))
1173 if (sxdp->sxdp_family != AF_XDP)
1176 flags = sxdp->sxdp_flags;
1177 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
1178 XDP_USE_NEED_WAKEUP | XDP_USE_SG))
1181 bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
1182 if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
1186 mutex_lock(&xs->mutex);
1187 if (xs->state != XSK_READY) {
1192 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
1198 if (!xs->rx && !xs->tx) {
1203 qid = sxdp->sxdp_queue_id;
1205 if (flags & XDP_SHARED_UMEM) {
1206 struct xdp_sock *umem_xs;
1207 struct socket *sock;
1209 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
1210 (flags & XDP_USE_NEED_WAKEUP) || (flags & XDP_USE_SG)) {
1211 /* Cannot specify flags for shared sockets. */
1217 /* We have already our own. */
1222 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
1224 err = PTR_ERR(sock);
1228 umem_xs = xdp_sk(sock->sk);
1229 if (!xsk_is_bound(umem_xs)) {
1235 if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
1236 /* Share the umem with another socket on another qid
1239 xs->pool = xp_create_and_assign_umem(xs,
1247 err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
1250 xp_destroy(xs->pool);
1256 /* Share the buffer pool with the other socket. */
1257 if (xs->fq_tmp || xs->cq_tmp) {
1258 /* Do not allow setting your own fq or cq. */
1264 xp_get_pool(umem_xs->pool);
1265 xs->pool = umem_xs->pool;
1267 /* If underlying shared umem was created without Tx
1268 * ring, allocate Tx descs array that Tx batching API
1271 if (xs->tx && !xs->pool->tx_descs) {
1272 err = xp_alloc_tx_descs(xs->pool, xs);
1274 xp_put_pool(xs->pool);
1282 xdp_get_umem(umem_xs->umem);
1283 WRITE_ONCE(xs->umem, umem_xs->umem);
1285 } else if (!xs->umem || !xsk_validate_queues(xs)) {
1289 /* This xsk has its own umem. */
1290 xs->pool = xp_create_and_assign_umem(xs, xs->umem);
1296 err = xp_assign_dev(xs->pool, dev, qid, flags);
1298 xp_destroy(xs->pool);
1304 /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
1309 xs->zc = xs->umem->zc;
1310 xs->sg = !!(xs->umem->flags & XDP_UMEM_SG_FLAG);
1312 xp_add_xsk(xs->pool, xs);
1318 /* Matches smp_rmb() in bind() for shared umem
1319 * sockets, and xsk_is_bound().
1322 WRITE_ONCE(xs->state, XSK_BOUND);
1325 mutex_unlock(&xs->mutex);
1330 struct xdp_umem_reg_v1 {
1331 __u64 addr; /* Start of packet data area */
1332 __u64 len; /* Length of packet data area */
1337 struct xdp_umem_reg_v2 {
1338 __u64 addr; /* Start of packet data area */
1339 __u64 len; /* Length of packet data area */
1345 static int xsk_setsockopt(struct socket *sock, int level, int optname,
1346 sockptr_t optval, unsigned int optlen)
1348 struct sock *sk = sock->sk;
1349 struct xdp_sock *xs = xdp_sk(sk);
1352 if (level != SOL_XDP)
1353 return -ENOPROTOOPT;
1359 struct xsk_queue **q;
1362 if (optlen < sizeof(entries))
1364 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1367 mutex_lock(&xs->mutex);
1368 if (xs->state != XSK_READY) {
1369 mutex_unlock(&xs->mutex);
1372 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1373 err = xsk_init_queue(entries, q, false);
1374 if (!err && optname == XDP_TX_RING)
1375 /* Tx needs to be explicitly woken up the first time */
1376 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1377 mutex_unlock(&xs->mutex);
1382 size_t mr_size = sizeof(struct xdp_umem_reg);
1383 struct xdp_umem_reg mr = {};
1384 struct xdp_umem *umem;
1386 if (optlen < sizeof(struct xdp_umem_reg_v1))
1388 else if (optlen < sizeof(struct xdp_umem_reg_v2))
1389 mr_size = sizeof(struct xdp_umem_reg_v1);
1390 else if (optlen < sizeof(mr))
1391 mr_size = sizeof(struct xdp_umem_reg_v2);
1393 if (copy_from_sockptr(&mr, optval, mr_size))
1396 mutex_lock(&xs->mutex);
1397 if (xs->state != XSK_READY || xs->umem) {
1398 mutex_unlock(&xs->mutex);
1402 umem = xdp_umem_create(&mr);
1404 mutex_unlock(&xs->mutex);
1405 return PTR_ERR(umem);
1408 /* Make sure umem is ready before it can be seen by others */
1410 WRITE_ONCE(xs->umem, umem);
1411 mutex_unlock(&xs->mutex);
1414 case XDP_UMEM_FILL_RING:
1415 case XDP_UMEM_COMPLETION_RING:
1417 struct xsk_queue **q;
1420 if (optlen < sizeof(entries))
1422 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1425 mutex_lock(&xs->mutex);
1426 if (xs->state != XSK_READY) {
1427 mutex_unlock(&xs->mutex);
1431 q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1433 err = xsk_init_queue(entries, q, true);
1434 mutex_unlock(&xs->mutex);
1441 return -ENOPROTOOPT;
1444 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1446 ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1447 ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1448 ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1451 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1453 ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1454 ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1455 ring->desc = offsetof(struct xdp_umem_ring, desc);
1458 struct xdp_statistics_v1 {
1460 __u64 rx_invalid_descs;
1461 __u64 tx_invalid_descs;
1464 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1465 char __user *optval, int __user *optlen)
1467 struct sock *sk = sock->sk;
1468 struct xdp_sock *xs = xdp_sk(sk);
1471 if (level != SOL_XDP)
1472 return -ENOPROTOOPT;
1474 if (get_user(len, optlen))
1480 case XDP_STATISTICS:
1482 struct xdp_statistics stats = {};
1483 bool extra_stats = true;
1486 if (len < sizeof(struct xdp_statistics_v1)) {
1488 } else if (len < sizeof(stats)) {
1489 extra_stats = false;
1490 stats_size = sizeof(struct xdp_statistics_v1);
1492 stats_size = sizeof(stats);
1495 mutex_lock(&xs->mutex);
1496 stats.rx_dropped = xs->rx_dropped;
1498 stats.rx_ring_full = xs->rx_queue_full;
1499 stats.rx_fill_ring_empty_descs =
1500 xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1501 stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1503 stats.rx_dropped += xs->rx_queue_full;
1505 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1506 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1507 mutex_unlock(&xs->mutex);
1509 if (copy_to_user(optval, &stats, stats_size))
1511 if (put_user(stats_size, optlen))
1516 case XDP_MMAP_OFFSETS:
1518 struct xdp_mmap_offsets off;
1519 struct xdp_mmap_offsets_v1 off_v1;
1520 bool flags_supported = true;
1523 if (len < sizeof(off_v1))
1525 else if (len < sizeof(off))
1526 flags_supported = false;
1528 if (flags_supported) {
1529 /* xdp_ring_offset is identical to xdp_ring_offset_v1
1530 * except for the flags field added to the end.
1532 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1534 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1536 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1538 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1540 off.rx.flags = offsetof(struct xdp_rxtx_ring,
1542 off.tx.flags = offsetof(struct xdp_rxtx_ring,
1544 off.fr.flags = offsetof(struct xdp_umem_ring,
1546 off.cr.flags = offsetof(struct xdp_umem_ring,
1552 xsk_enter_rxtx_offsets(&off_v1.rx);
1553 xsk_enter_rxtx_offsets(&off_v1.tx);
1554 xsk_enter_umem_offsets(&off_v1.fr);
1555 xsk_enter_umem_offsets(&off_v1.cr);
1557 len = sizeof(off_v1);
1561 if (copy_to_user(optval, to_copy, len))
1563 if (put_user(len, optlen))
1570 struct xdp_options opts = {};
1572 if (len < sizeof(opts))
1575 mutex_lock(&xs->mutex);
1577 opts.flags |= XDP_OPTIONS_ZEROCOPY;
1578 mutex_unlock(&xs->mutex);
1581 if (copy_to_user(optval, &opts, len))
1583 if (put_user(len, optlen))
1595 static int xsk_mmap(struct file *file, struct socket *sock,
1596 struct vm_area_struct *vma)
1598 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1599 unsigned long size = vma->vm_end - vma->vm_start;
1600 struct xdp_sock *xs = xdp_sk(sock->sk);
1601 int state = READ_ONCE(xs->state);
1602 struct xsk_queue *q = NULL;
1604 if (state != XSK_READY && state != XSK_BOUND)
1607 if (offset == XDP_PGOFF_RX_RING) {
1608 q = READ_ONCE(xs->rx);
1609 } else if (offset == XDP_PGOFF_TX_RING) {
1610 q = READ_ONCE(xs->tx);
1612 /* Matches the smp_wmb() in XDP_UMEM_REG */
1614 if (offset == XDP_UMEM_PGOFF_FILL_RING)
1615 q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
1616 READ_ONCE(xs->pool->fq);
1617 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1618 q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
1619 READ_ONCE(xs->pool->cq);
1625 /* Matches the smp_wmb() in xsk_init_queue */
1627 if (size > q->ring_vmalloc_size)
1630 return remap_vmalloc_range(vma, q->ring, 0);
1633 static int xsk_notifier(struct notifier_block *this,
1634 unsigned long msg, void *ptr)
1636 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1637 struct net *net = dev_net(dev);
1641 case NETDEV_UNREGISTER:
1642 mutex_lock(&net->xdp.lock);
1643 sk_for_each(sk, &net->xdp.list) {
1644 struct xdp_sock *xs = xdp_sk(sk);
1646 mutex_lock(&xs->mutex);
1647 if (xs->dev == dev) {
1648 sk->sk_err = ENETDOWN;
1649 if (!sock_flag(sk, SOCK_DEAD))
1650 sk_error_report(sk);
1654 /* Clear device references. */
1655 xp_clear_dev(xs->pool);
1657 mutex_unlock(&xs->mutex);
1659 mutex_unlock(&net->xdp.lock);
1665 static struct proto xsk_proto = {
1667 .owner = THIS_MODULE,
1668 .obj_size = sizeof(struct xdp_sock),
1671 static const struct proto_ops xsk_proto_ops = {
1673 .owner = THIS_MODULE,
1674 .release = xsk_release,
1676 .connect = sock_no_connect,
1677 .socketpair = sock_no_socketpair,
1678 .accept = sock_no_accept,
1679 .getname = sock_no_getname,
1681 .ioctl = sock_no_ioctl,
1682 .listen = sock_no_listen,
1683 .shutdown = sock_no_shutdown,
1684 .setsockopt = xsk_setsockopt,
1685 .getsockopt = xsk_getsockopt,
1686 .sendmsg = xsk_sendmsg,
1687 .recvmsg = xsk_recvmsg,
1691 static void xsk_destruct(struct sock *sk)
1693 struct xdp_sock *xs = xdp_sk(sk);
1695 if (!sock_flag(sk, SOCK_DEAD))
1698 if (!xp_put_pool(xs->pool))
1699 xdp_put_umem(xs->umem, !xs->pool);
1702 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1705 struct xdp_sock *xs;
1708 if (!ns_capable(net->user_ns, CAP_NET_RAW))
1710 if (sock->type != SOCK_RAW)
1711 return -ESOCKTNOSUPPORT;
1714 return -EPROTONOSUPPORT;
1716 sock->state = SS_UNCONNECTED;
1718 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1722 sock->ops = &xsk_proto_ops;
1724 sock_init_data(sock, sk);
1726 sk->sk_family = PF_XDP;
1728 sk->sk_destruct = xsk_destruct;
1730 sock_set_flag(sk, SOCK_RCU_FREE);
1733 xs->state = XSK_READY;
1734 mutex_init(&xs->mutex);
1735 spin_lock_init(&xs->rx_lock);
1737 INIT_LIST_HEAD(&xs->map_list);
1738 spin_lock_init(&xs->map_list_lock);
1740 mutex_lock(&net->xdp.lock);
1741 sk_add_node_rcu(sk, &net->xdp.list);
1742 mutex_unlock(&net->xdp.lock);
1744 sock_prot_inuse_add(net, &xsk_proto, 1);
1749 static const struct net_proto_family xsk_family_ops = {
1751 .create = xsk_create,
1752 .owner = THIS_MODULE,
1755 static struct notifier_block xsk_netdev_notifier = {
1756 .notifier_call = xsk_notifier,
1759 static int __net_init xsk_net_init(struct net *net)
1761 mutex_init(&net->xdp.lock);
1762 INIT_HLIST_HEAD(&net->xdp.list);
1766 static void __net_exit xsk_net_exit(struct net *net)
1768 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1771 static struct pernet_operations xsk_net_ops = {
1772 .init = xsk_net_init,
1773 .exit = xsk_net_exit,
1776 static int __init xsk_init(void)
1780 err = proto_register(&xsk_proto, 0 /* no slab */);
1784 err = sock_register(&xsk_family_ops);
1788 err = register_pernet_subsys(&xsk_net_ops);
1792 err = register_netdevice_notifier(&xsk_netdev_notifier);
1796 for_each_possible_cpu(cpu)
1797 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list, cpu));
1801 unregister_pernet_subsys(&xsk_net_ops);
1803 sock_unregister(PF_XDP);
1805 proto_unregister(&xsk_proto);
1810 fs_initcall(xsk_init);