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 <net/xdp_sock_drv.h>
26 #include <net/busy_poll.h>
29 #include "xsk_queue.h"
33 #define TX_BATCH_SIZE 32
35 static DEFINE_PER_CPU(struct list_head, xskmap_flush_list);
37 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
39 if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
42 pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
43 pool->cached_need_wakeup |= XDP_WAKEUP_RX;
45 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
47 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
51 if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
55 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
56 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
60 pool->cached_need_wakeup |= XDP_WAKEUP_TX;
62 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
64 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
66 if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
69 pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
70 pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
72 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
74 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
78 if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
82 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
83 xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
87 pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
89 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
91 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
93 return pool->uses_need_wakeup;
95 EXPORT_SYMBOL(xsk_uses_need_wakeup);
97 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
100 if (queue_id < dev->real_num_rx_queues)
101 return dev->_rx[queue_id].pool;
102 if (queue_id < dev->real_num_tx_queues)
103 return dev->_tx[queue_id].pool;
107 EXPORT_SYMBOL(xsk_get_pool_from_qid);
109 void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
111 if (queue_id < dev->num_rx_queues)
112 dev->_rx[queue_id].pool = NULL;
113 if (queue_id < dev->num_tx_queues)
114 dev->_tx[queue_id].pool = NULL;
117 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
118 * not know if the device has more tx queues than rx, or the opposite.
119 * This might also change during run time.
121 int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
124 if (queue_id >= max_t(unsigned int,
125 dev->real_num_rx_queues,
126 dev->real_num_tx_queues))
129 if (queue_id < dev->real_num_rx_queues)
130 dev->_rx[queue_id].pool = pool;
131 if (queue_id < dev->real_num_tx_queues)
132 dev->_tx[queue_id].pool = pool;
137 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
139 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
143 addr = xp_get_handle(xskb);
144 err = xskq_prod_reserve_desc(xs->rx, addr, len);
154 static void xsk_copy_xdp(struct xdp_buff *to, struct xdp_buff *from, u32 len)
156 void *from_buf, *to_buf;
159 if (unlikely(xdp_data_meta_unsupported(from))) {
160 from_buf = from->data;
164 from_buf = from->data_meta;
165 metalen = from->data - from->data_meta;
166 to_buf = to->data - metalen;
169 memcpy(to_buf, from_buf, len + metalen);
172 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
174 struct xdp_buff *xsk_xdp;
178 len = xdp->data_end - xdp->data;
179 if (len > xsk_pool_get_rx_frame_size(xs->pool)) {
184 xsk_xdp = xsk_buff_alloc(xs->pool);
190 xsk_copy_xdp(xsk_xdp, xdp, len);
191 err = __xsk_rcv_zc(xs, xsk_xdp, len);
193 xsk_buff_free(xsk_xdp);
199 static bool xsk_tx_writeable(struct xdp_sock *xs)
201 if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
207 static bool xsk_is_bound(struct xdp_sock *xs)
209 if (READ_ONCE(xs->state) == XSK_BOUND) {
210 /* Matches smp_wmb() in bind(). */
217 static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp)
219 if (!xsk_is_bound(xs))
222 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
225 sk_mark_napi_id_once_xdp(&xs->sk, xdp);
229 static void xsk_flush(struct xdp_sock *xs)
231 xskq_prod_submit(xs->rx);
232 __xskq_cons_release(xs->pool->fq);
233 sock_def_readable(&xs->sk);
236 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
240 spin_lock_bh(&xs->rx_lock);
241 err = xsk_rcv_check(xs, xdp);
243 err = __xsk_rcv(xs, xdp);
246 spin_unlock_bh(&xs->rx_lock);
250 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
255 err = xsk_rcv_check(xs, xdp);
259 if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
260 len = xdp->data_end - xdp->data;
261 return __xsk_rcv_zc(xs, xdp, len);
264 err = __xsk_rcv(xs, xdp);
266 xdp_return_buff(xdp);
270 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
272 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
275 err = xsk_rcv(xs, xdp);
279 if (!xs->flush_node.prev)
280 list_add(&xs->flush_node, flush_list);
285 void __xsk_map_flush(void)
287 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
288 struct xdp_sock *xs, *tmp;
290 list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
292 __list_del_clearprev(&xs->flush_node);
296 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
298 xskq_prod_submit_n(pool->cq, nb_entries);
300 EXPORT_SYMBOL(xsk_tx_completed);
302 void xsk_tx_release(struct xsk_buff_pool *pool)
307 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
308 __xskq_cons_release(xs->tx);
309 if (xsk_tx_writeable(xs))
310 xs->sk.sk_write_space(&xs->sk);
314 EXPORT_SYMBOL(xsk_tx_release);
316 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
321 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
322 if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
323 xs->tx->queue_empty_descs++;
327 /* This is the backpressure mechanism for the Tx path.
328 * Reserve space in the completion queue and only proceed
329 * if there is space in it. This avoids having to implement
330 * any buffering in the Tx path.
332 if (xskq_prod_reserve_addr(pool->cq, desc->addr))
335 xskq_cons_release(xs->tx);
344 EXPORT_SYMBOL(xsk_tx_peek_desc);
346 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, struct xdp_desc *descs,
351 while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
354 xsk_tx_release(pool);
358 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, struct xdp_desc *descs,
365 if (!list_is_singular(&pool->xsk_tx_list)) {
366 /* Fallback to the non-batched version */
368 return xsk_tx_peek_release_fallback(pool, descs, max_entries);
371 xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
377 nb_pkts = xskq_cons_peek_desc_batch(xs->tx, descs, pool, max_entries);
379 xs->tx->queue_empty_descs++;
383 /* This is the backpressure mechanism for the Tx path. Try to
384 * reserve space in the completion queue for all packets, but
385 * if there are fewer slots available, just process that many
386 * packets. This avoids having to implement any buffering in
389 nb_pkts = xskq_prod_reserve_addr_batch(pool->cq, descs, nb_pkts);
393 xskq_cons_release_n(xs->tx, nb_pkts);
394 __xskq_cons_release(xs->tx);
395 xs->sk.sk_write_space(&xs->sk);
401 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
403 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
405 struct net_device *dev = xs->dev;
409 err = dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
415 static int xsk_zc_xmit(struct xdp_sock *xs)
417 return xsk_wakeup(xs, XDP_WAKEUP_TX);
420 static void xsk_destruct_skb(struct sk_buff *skb)
422 u64 addr = (u64)(long)skb_shinfo(skb)->destructor_arg;
423 struct xdp_sock *xs = xdp_sk(skb->sk);
426 spin_lock_irqsave(&xs->pool->cq_lock, flags);
427 xskq_prod_submit_addr(xs->pool->cq, addr);
428 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
433 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
434 struct xdp_desc *desc)
436 struct xsk_buff_pool *pool = xs->pool;
437 u32 hr, len, ts, offset, copy, copied;
444 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
446 skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
450 skb_reserve(skb, hr);
454 ts = pool->unaligned ? len : pool->chunk_size;
456 buffer = xsk_buff_raw_get_data(pool, addr);
457 offset = offset_in_page(buffer);
458 addr = buffer - pool->addrs;
460 for (copied = 0, i = 0; copied < len; i++) {
461 page = pool->umem->pgs[addr >> PAGE_SHIFT];
464 copy = min_t(u32, PAGE_SIZE - offset, len - copied);
465 skb_fill_page_desc(skb, i, page, offset, copy);
473 skb->data_len += len;
476 refcount_add(ts, &xs->sk.sk_wmem_alloc);
481 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
482 struct xdp_desc *desc)
484 struct net_device *dev = xs->dev;
487 if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
488 skb = xsk_build_skb_zerocopy(xs, desc);
496 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
497 tr = dev->needed_tailroom;
500 skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
504 skb_reserve(skb, hr);
507 buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
508 err = skb_store_bits(skb, 0, buffer, len);
516 skb->priority = xs->sk.sk_priority;
517 skb->mark = xs->sk.sk_mark;
518 skb_shinfo(skb)->destructor_arg = (void *)(long)desc->addr;
519 skb->destructor = xsk_destruct_skb;
524 static int xsk_generic_xmit(struct sock *sk)
526 struct xdp_sock *xs = xdp_sk(sk);
527 u32 max_batch = TX_BATCH_SIZE;
528 bool sent_frame = false;
529 struct xdp_desc desc;
534 mutex_lock(&xs->mutex);
536 if (xs->queue_id >= xs->dev->real_num_tx_queues)
539 while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
540 if (max_batch-- == 0) {
545 skb = xsk_build_skb(xs, &desc);
551 /* This is the backpressure mechanism for the Tx path.
552 * Reserve space in the completion queue and only proceed
553 * if there is space in it. This avoids having to implement
554 * any buffering in the Tx path.
556 spin_lock_irqsave(&xs->pool->cq_lock, flags);
557 if (xskq_prod_reserve(xs->pool->cq)) {
558 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
562 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
564 err = __dev_direct_xmit(skb, xs->queue_id);
565 if (err == NETDEV_TX_BUSY) {
566 /* Tell user-space to retry the send */
567 skb->destructor = sock_wfree;
568 spin_lock_irqsave(&xs->pool->cq_lock, flags);
569 xskq_prod_cancel(xs->pool->cq);
570 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
571 /* Free skb without triggering the perf drop trace */
577 xskq_cons_release(xs->tx);
578 /* Ignore NET_XMIT_CN as packet might have been sent */
579 if (err == NET_XMIT_DROP) {
580 /* SKB completed but not sent */
588 xs->tx->queue_empty_descs++;
592 if (xsk_tx_writeable(xs))
593 sk->sk_write_space(sk);
595 mutex_unlock(&xs->mutex);
599 static int __xsk_sendmsg(struct sock *sk)
601 struct xdp_sock *xs = xdp_sk(sk);
603 if (unlikely(!(xs->dev->flags & IFF_UP)))
605 if (unlikely(!xs->tx))
608 return xs->zc ? xsk_zc_xmit(xs) : xsk_generic_xmit(sk);
611 static bool xsk_no_wakeup(struct sock *sk)
613 #ifdef CONFIG_NET_RX_BUSY_POLL
614 /* Prefer busy-polling, skip the wakeup. */
615 return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
616 READ_ONCE(sk->sk_napi_id) >= MIN_NAPI_ID;
622 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
624 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
625 struct sock *sk = sock->sk;
626 struct xdp_sock *xs = xdp_sk(sk);
627 struct xsk_buff_pool *pool;
629 if (unlikely(!xsk_is_bound(xs)))
631 if (unlikely(need_wait))
634 if (sk_can_busy_loop(sk))
635 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
637 if (xsk_no_wakeup(sk))
641 if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
642 return __xsk_sendmsg(sk);
646 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
648 bool need_wait = !(flags & MSG_DONTWAIT);
649 struct sock *sk = sock->sk;
650 struct xdp_sock *xs = xdp_sk(sk);
652 if (unlikely(!xsk_is_bound(xs)))
654 if (unlikely(!(xs->dev->flags & IFF_UP)))
656 if (unlikely(!xs->rx))
658 if (unlikely(need_wait))
661 if (sk_can_busy_loop(sk))
662 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
664 if (xsk_no_wakeup(sk))
667 if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
668 return xsk_wakeup(xs, XDP_WAKEUP_RX);
672 static __poll_t xsk_poll(struct file *file, struct socket *sock,
673 struct poll_table_struct *wait)
676 struct sock *sk = sock->sk;
677 struct xdp_sock *xs = xdp_sk(sk);
678 struct xsk_buff_pool *pool;
680 sock_poll_wait(file, sock, wait);
682 if (unlikely(!xsk_is_bound(xs)))
687 if (pool->cached_need_wakeup) {
689 xsk_wakeup(xs, pool->cached_need_wakeup);
691 /* Poll needs to drive Tx also in copy mode */
695 if (xs->rx && !xskq_prod_is_empty(xs->rx))
696 mask |= EPOLLIN | EPOLLRDNORM;
697 if (xs->tx && xsk_tx_writeable(xs))
698 mask |= EPOLLOUT | EPOLLWRNORM;
703 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
708 if (entries == 0 || *queue || !is_power_of_2(entries))
711 q = xskq_create(entries, umem_queue);
715 /* Make sure queue is ready before it can be seen by others */
717 WRITE_ONCE(*queue, q);
721 static void xsk_unbind_dev(struct xdp_sock *xs)
723 struct net_device *dev = xs->dev;
725 if (xs->state != XSK_BOUND)
727 WRITE_ONCE(xs->state, XSK_UNBOUND);
729 /* Wait for driver to stop using the xdp socket. */
730 xp_del_xsk(xs->pool, xs);
736 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
737 struct xdp_sock __rcu ***map_entry)
739 struct xsk_map *map = NULL;
740 struct xsk_map_node *node;
744 spin_lock_bh(&xs->map_list_lock);
745 node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
748 bpf_map_inc(&node->map->map);
750 *map_entry = node->map_entry;
752 spin_unlock_bh(&xs->map_list_lock);
756 static void xsk_delete_from_maps(struct xdp_sock *xs)
758 /* This function removes the current XDP socket from all the
759 * maps it resides in. We need to take extra care here, due to
760 * the two locks involved. Each map has a lock synchronizing
761 * updates to the entries, and each socket has a lock that
762 * synchronizes access to the list of maps (map_list). For
763 * deadlock avoidance the locks need to be taken in the order
764 * "map lock"->"socket map list lock". We start off by
765 * accessing the socket map list, and take a reference to the
766 * map to guarantee existence between the
767 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
768 * calls. Then we ask the map to remove the socket, which
769 * tries to remove the socket from the map. Note that there
770 * might be updates to the map between
771 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
773 struct xdp_sock __rcu **map_entry = NULL;
776 while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
777 xsk_map_try_sock_delete(map, xs, map_entry);
778 bpf_map_put(&map->map);
782 static int xsk_release(struct socket *sock)
784 struct sock *sk = sock->sk;
785 struct xdp_sock *xs = xdp_sk(sk);
793 mutex_lock(&net->xdp.lock);
794 sk_del_node_init_rcu(sk);
795 mutex_unlock(&net->xdp.lock);
798 sock_prot_inuse_add(net, sk->sk_prot, -1);
801 xsk_delete_from_maps(xs);
802 mutex_lock(&xs->mutex);
804 mutex_unlock(&xs->mutex);
806 xskq_destroy(xs->rx);
807 xskq_destroy(xs->tx);
808 xskq_destroy(xs->fq_tmp);
809 xskq_destroy(xs->cq_tmp);
814 sk_refcnt_debug_release(sk);
820 static struct socket *xsk_lookup_xsk_from_fd(int fd)
825 sock = sockfd_lookup(fd, &err);
827 return ERR_PTR(-ENOTSOCK);
829 if (sock->sk->sk_family != PF_XDP) {
831 return ERR_PTR(-ENOPROTOOPT);
837 static bool xsk_validate_queues(struct xdp_sock *xs)
839 return xs->fq_tmp && xs->cq_tmp;
842 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
844 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
845 struct sock *sk = sock->sk;
846 struct xdp_sock *xs = xdp_sk(sk);
847 struct net_device *dev;
851 if (addr_len < sizeof(struct sockaddr_xdp))
853 if (sxdp->sxdp_family != AF_XDP)
856 flags = sxdp->sxdp_flags;
857 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
858 XDP_USE_NEED_WAKEUP))
862 mutex_lock(&xs->mutex);
863 if (xs->state != XSK_READY) {
868 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
874 if (!xs->rx && !xs->tx) {
879 qid = sxdp->sxdp_queue_id;
881 if (flags & XDP_SHARED_UMEM) {
882 struct xdp_sock *umem_xs;
885 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
886 (flags & XDP_USE_NEED_WAKEUP)) {
887 /* Cannot specify flags for shared sockets. */
893 /* We have already our own. */
898 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
904 umem_xs = xdp_sk(sock->sk);
905 if (!xsk_is_bound(umem_xs)) {
911 if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
912 /* Share the umem with another socket on another qid
915 xs->pool = xp_create_and_assign_umem(xs,
923 err = xp_assign_dev_shared(xs->pool, umem_xs->umem,
926 xp_destroy(xs->pool);
932 /* Share the buffer pool with the other socket. */
933 if (xs->fq_tmp || xs->cq_tmp) {
934 /* Do not allow setting your own fq or cq. */
940 xp_get_pool(umem_xs->pool);
941 xs->pool = umem_xs->pool;
944 xdp_get_umem(umem_xs->umem);
945 WRITE_ONCE(xs->umem, umem_xs->umem);
947 } else if (!xs->umem || !xsk_validate_queues(xs)) {
951 /* This xsk has its own umem. */
952 xs->pool = xp_create_and_assign_umem(xs, xs->umem);
958 err = xp_assign_dev(xs->pool, dev, qid, flags);
960 xp_destroy(xs->pool);
966 /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
971 xs->zc = xs->umem->zc;
973 xp_add_xsk(xs->pool, xs);
979 /* Matches smp_rmb() in bind() for shared umem
980 * sockets, and xsk_is_bound().
983 WRITE_ONCE(xs->state, XSK_BOUND);
986 mutex_unlock(&xs->mutex);
991 struct xdp_umem_reg_v1 {
992 __u64 addr; /* Start of packet data area */
993 __u64 len; /* Length of packet data area */
998 static int xsk_setsockopt(struct socket *sock, int level, int optname,
999 sockptr_t optval, unsigned int optlen)
1001 struct sock *sk = sock->sk;
1002 struct xdp_sock *xs = xdp_sk(sk);
1005 if (level != SOL_XDP)
1006 return -ENOPROTOOPT;
1012 struct xsk_queue **q;
1015 if (optlen < sizeof(entries))
1017 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1020 mutex_lock(&xs->mutex);
1021 if (xs->state != XSK_READY) {
1022 mutex_unlock(&xs->mutex);
1025 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1026 err = xsk_init_queue(entries, q, false);
1027 if (!err && optname == XDP_TX_RING)
1028 /* Tx needs to be explicitly woken up the first time */
1029 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1030 mutex_unlock(&xs->mutex);
1035 size_t mr_size = sizeof(struct xdp_umem_reg);
1036 struct xdp_umem_reg mr = {};
1037 struct xdp_umem *umem;
1039 if (optlen < sizeof(struct xdp_umem_reg_v1))
1041 else if (optlen < sizeof(mr))
1042 mr_size = sizeof(struct xdp_umem_reg_v1);
1044 if (copy_from_sockptr(&mr, optval, mr_size))
1047 mutex_lock(&xs->mutex);
1048 if (xs->state != XSK_READY || xs->umem) {
1049 mutex_unlock(&xs->mutex);
1053 umem = xdp_umem_create(&mr);
1055 mutex_unlock(&xs->mutex);
1056 return PTR_ERR(umem);
1059 /* Make sure umem is ready before it can be seen by others */
1061 WRITE_ONCE(xs->umem, umem);
1062 mutex_unlock(&xs->mutex);
1065 case XDP_UMEM_FILL_RING:
1066 case XDP_UMEM_COMPLETION_RING:
1068 struct xsk_queue **q;
1071 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1074 mutex_lock(&xs->mutex);
1075 if (xs->state != XSK_READY) {
1076 mutex_unlock(&xs->mutex);
1080 q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1082 err = xsk_init_queue(entries, q, true);
1083 mutex_unlock(&xs->mutex);
1090 return -ENOPROTOOPT;
1093 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1095 ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1096 ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1097 ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1100 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1102 ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1103 ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1104 ring->desc = offsetof(struct xdp_umem_ring, desc);
1107 struct xdp_statistics_v1 {
1109 __u64 rx_invalid_descs;
1110 __u64 tx_invalid_descs;
1113 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1114 char __user *optval, int __user *optlen)
1116 struct sock *sk = sock->sk;
1117 struct xdp_sock *xs = xdp_sk(sk);
1120 if (level != SOL_XDP)
1121 return -ENOPROTOOPT;
1123 if (get_user(len, optlen))
1129 case XDP_STATISTICS:
1131 struct xdp_statistics stats = {};
1132 bool extra_stats = true;
1135 if (len < sizeof(struct xdp_statistics_v1)) {
1137 } else if (len < sizeof(stats)) {
1138 extra_stats = false;
1139 stats_size = sizeof(struct xdp_statistics_v1);
1141 stats_size = sizeof(stats);
1144 mutex_lock(&xs->mutex);
1145 stats.rx_dropped = xs->rx_dropped;
1147 stats.rx_ring_full = xs->rx_queue_full;
1148 stats.rx_fill_ring_empty_descs =
1149 xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1150 stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1152 stats.rx_dropped += xs->rx_queue_full;
1154 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1155 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1156 mutex_unlock(&xs->mutex);
1158 if (copy_to_user(optval, &stats, stats_size))
1160 if (put_user(stats_size, optlen))
1165 case XDP_MMAP_OFFSETS:
1167 struct xdp_mmap_offsets off;
1168 struct xdp_mmap_offsets_v1 off_v1;
1169 bool flags_supported = true;
1172 if (len < sizeof(off_v1))
1174 else if (len < sizeof(off))
1175 flags_supported = false;
1177 if (flags_supported) {
1178 /* xdp_ring_offset is identical to xdp_ring_offset_v1
1179 * except for the flags field added to the end.
1181 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1183 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1185 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1187 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1189 off.rx.flags = offsetof(struct xdp_rxtx_ring,
1191 off.tx.flags = offsetof(struct xdp_rxtx_ring,
1193 off.fr.flags = offsetof(struct xdp_umem_ring,
1195 off.cr.flags = offsetof(struct xdp_umem_ring,
1201 xsk_enter_rxtx_offsets(&off_v1.rx);
1202 xsk_enter_rxtx_offsets(&off_v1.tx);
1203 xsk_enter_umem_offsets(&off_v1.fr);
1204 xsk_enter_umem_offsets(&off_v1.cr);
1206 len = sizeof(off_v1);
1210 if (copy_to_user(optval, to_copy, len))
1212 if (put_user(len, optlen))
1219 struct xdp_options opts = {};
1221 if (len < sizeof(opts))
1224 mutex_lock(&xs->mutex);
1226 opts.flags |= XDP_OPTIONS_ZEROCOPY;
1227 mutex_unlock(&xs->mutex);
1230 if (copy_to_user(optval, &opts, len))
1232 if (put_user(len, optlen))
1244 static int xsk_mmap(struct file *file, struct socket *sock,
1245 struct vm_area_struct *vma)
1247 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1248 unsigned long size = vma->vm_end - vma->vm_start;
1249 struct xdp_sock *xs = xdp_sk(sock->sk);
1250 struct xsk_queue *q = NULL;
1254 if (READ_ONCE(xs->state) != XSK_READY)
1257 if (offset == XDP_PGOFF_RX_RING) {
1258 q = READ_ONCE(xs->rx);
1259 } else if (offset == XDP_PGOFF_TX_RING) {
1260 q = READ_ONCE(xs->tx);
1262 /* Matches the smp_wmb() in XDP_UMEM_REG */
1264 if (offset == XDP_UMEM_PGOFF_FILL_RING)
1265 q = READ_ONCE(xs->fq_tmp);
1266 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1267 q = READ_ONCE(xs->cq_tmp);
1273 /* Matches the smp_wmb() in xsk_init_queue */
1275 qpg = virt_to_head_page(q->ring);
1276 if (size > page_size(qpg))
1279 pfn = virt_to_phys(q->ring) >> PAGE_SHIFT;
1280 return remap_pfn_range(vma, vma->vm_start, pfn,
1281 size, vma->vm_page_prot);
1284 static int xsk_notifier(struct notifier_block *this,
1285 unsigned long msg, void *ptr)
1287 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1288 struct net *net = dev_net(dev);
1292 case NETDEV_UNREGISTER:
1293 mutex_lock(&net->xdp.lock);
1294 sk_for_each(sk, &net->xdp.list) {
1295 struct xdp_sock *xs = xdp_sk(sk);
1297 mutex_lock(&xs->mutex);
1298 if (xs->dev == dev) {
1299 sk->sk_err = ENETDOWN;
1300 if (!sock_flag(sk, SOCK_DEAD))
1301 sk_error_report(sk);
1305 /* Clear device references. */
1306 xp_clear_dev(xs->pool);
1308 mutex_unlock(&xs->mutex);
1310 mutex_unlock(&net->xdp.lock);
1316 static struct proto xsk_proto = {
1318 .owner = THIS_MODULE,
1319 .obj_size = sizeof(struct xdp_sock),
1322 static const struct proto_ops xsk_proto_ops = {
1324 .owner = THIS_MODULE,
1325 .release = xsk_release,
1327 .connect = sock_no_connect,
1328 .socketpair = sock_no_socketpair,
1329 .accept = sock_no_accept,
1330 .getname = sock_no_getname,
1332 .ioctl = sock_no_ioctl,
1333 .listen = sock_no_listen,
1334 .shutdown = sock_no_shutdown,
1335 .setsockopt = xsk_setsockopt,
1336 .getsockopt = xsk_getsockopt,
1337 .sendmsg = xsk_sendmsg,
1338 .recvmsg = xsk_recvmsg,
1340 .sendpage = sock_no_sendpage,
1343 static void xsk_destruct(struct sock *sk)
1345 struct xdp_sock *xs = xdp_sk(sk);
1347 if (!sock_flag(sk, SOCK_DEAD))
1350 if (!xp_put_pool(xs->pool))
1351 xdp_put_umem(xs->umem, !xs->pool);
1353 sk_refcnt_debug_dec(sk);
1356 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1359 struct xdp_sock *xs;
1362 if (!ns_capable(net->user_ns, CAP_NET_RAW))
1364 if (sock->type != SOCK_RAW)
1365 return -ESOCKTNOSUPPORT;
1368 return -EPROTONOSUPPORT;
1370 sock->state = SS_UNCONNECTED;
1372 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1376 sock->ops = &xsk_proto_ops;
1378 sock_init_data(sock, sk);
1380 sk->sk_family = PF_XDP;
1382 sk->sk_destruct = xsk_destruct;
1383 sk_refcnt_debug_inc(sk);
1385 sock_set_flag(sk, SOCK_RCU_FREE);
1388 xs->state = XSK_READY;
1389 mutex_init(&xs->mutex);
1390 spin_lock_init(&xs->rx_lock);
1392 INIT_LIST_HEAD(&xs->map_list);
1393 spin_lock_init(&xs->map_list_lock);
1395 mutex_lock(&net->xdp.lock);
1396 sk_add_node_rcu(sk, &net->xdp.list);
1397 mutex_unlock(&net->xdp.lock);
1400 sock_prot_inuse_add(net, &xsk_proto, 1);
1406 static const struct net_proto_family xsk_family_ops = {
1408 .create = xsk_create,
1409 .owner = THIS_MODULE,
1412 static struct notifier_block xsk_netdev_notifier = {
1413 .notifier_call = xsk_notifier,
1416 static int __net_init xsk_net_init(struct net *net)
1418 mutex_init(&net->xdp.lock);
1419 INIT_HLIST_HEAD(&net->xdp.list);
1423 static void __net_exit xsk_net_exit(struct net *net)
1425 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1428 static struct pernet_operations xsk_net_ops = {
1429 .init = xsk_net_init,
1430 .exit = xsk_net_exit,
1433 static int __init xsk_init(void)
1437 err = proto_register(&xsk_proto, 0 /* no slab */);
1441 err = sock_register(&xsk_family_ops);
1445 err = register_pernet_subsys(&xsk_net_ops);
1449 err = register_netdevice_notifier(&xsk_netdev_notifier);
1453 for_each_possible_cpu(cpu)
1454 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list, cpu));
1458 unregister_pernet_subsys(&xsk_net_ops);
1460 sock_unregister(PF_XDP);
1462 proto_unregister(&xsk_proto);
1467 fs_initcall(xsk_init);