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>
30 #include "xsk_queue.h"
34 #define TX_BATCH_SIZE 32
36 static DEFINE_PER_CPU(struct list_head, xskmap_flush_list);
38 void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
40 if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
43 pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
44 pool->cached_need_wakeup |= XDP_WAKEUP_RX;
46 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
48 void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
52 if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
56 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
57 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
61 pool->cached_need_wakeup |= XDP_WAKEUP_TX;
63 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
65 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
67 if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
70 pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
71 pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
73 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
75 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
79 if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
83 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
84 xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
88 pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
90 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
92 bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
94 return pool->uses_need_wakeup;
96 EXPORT_SYMBOL(xsk_uses_need_wakeup);
98 struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
101 if (queue_id < dev->real_num_rx_queues)
102 return dev->_rx[queue_id].pool;
103 if (queue_id < dev->real_num_tx_queues)
104 return dev->_tx[queue_id].pool;
108 EXPORT_SYMBOL(xsk_get_pool_from_qid);
110 void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
112 if (queue_id < dev->num_rx_queues)
113 dev->_rx[queue_id].pool = NULL;
114 if (queue_id < dev->num_tx_queues)
115 dev->_tx[queue_id].pool = NULL;
118 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
119 * not know if the device has more tx queues than rx, or the opposite.
120 * This might also change during run time.
122 int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
125 if (queue_id >= max_t(unsigned int,
126 dev->real_num_rx_queues,
127 dev->real_num_tx_queues))
130 if (queue_id < dev->real_num_rx_queues)
131 dev->_rx[queue_id].pool = pool;
132 if (queue_id < dev->real_num_tx_queues)
133 dev->_tx[queue_id].pool = pool;
138 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
140 struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
144 addr = xp_get_handle(xskb);
145 err = xskq_prod_reserve_desc(xs->rx, addr, len);
155 static void xsk_copy_xdp(struct xdp_buff *to, struct xdp_buff *from, u32 len)
157 void *from_buf, *to_buf;
160 if (unlikely(xdp_data_meta_unsupported(from))) {
161 from_buf = from->data;
165 from_buf = from->data_meta;
166 metalen = from->data - from->data_meta;
167 to_buf = to->data - metalen;
170 memcpy(to_buf, from_buf, len + metalen);
173 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
175 struct xdp_buff *xsk_xdp;
179 len = xdp->data_end - xdp->data;
180 if (len > xsk_pool_get_rx_frame_size(xs->pool)) {
185 xsk_xdp = xsk_buff_alloc(xs->pool);
191 xsk_copy_xdp(xsk_xdp, xdp, len);
192 err = __xsk_rcv_zc(xs, xsk_xdp, len);
194 xsk_buff_free(xsk_xdp);
200 static bool xsk_tx_writeable(struct xdp_sock *xs)
202 if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
208 static bool xsk_is_bound(struct xdp_sock *xs)
210 if (READ_ONCE(xs->state) == XSK_BOUND) {
211 /* Matches smp_wmb() in bind(). */
218 static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp)
220 if (!xsk_is_bound(xs))
223 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
226 sk_mark_napi_id_once_xdp(&xs->sk, xdp);
230 static void xsk_flush(struct xdp_sock *xs)
232 xskq_prod_submit(xs->rx);
233 __xskq_cons_release(xs->pool->fq);
234 sock_def_readable(&xs->sk);
237 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
241 spin_lock_bh(&xs->rx_lock);
242 err = xsk_rcv_check(xs, xdp);
244 err = __xsk_rcv(xs, xdp);
247 spin_unlock_bh(&xs->rx_lock);
251 static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
256 err = xsk_rcv_check(xs, xdp);
260 if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
261 len = xdp->data_end - xdp->data;
262 return __xsk_rcv_zc(xs, xdp, len);
265 err = __xsk_rcv(xs, xdp);
267 xdp_return_buff(xdp);
271 int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
273 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
276 err = xsk_rcv(xs, xdp);
280 if (!xs->flush_node.prev)
281 list_add(&xs->flush_node, flush_list);
286 void __xsk_map_flush(void)
288 struct list_head *flush_list = this_cpu_ptr(&xskmap_flush_list);
289 struct xdp_sock *xs, *tmp;
291 list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
293 __list_del_clearprev(&xs->flush_node);
297 void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
299 xskq_prod_submit_n(pool->cq, nb_entries);
301 EXPORT_SYMBOL(xsk_tx_completed);
303 void xsk_tx_release(struct xsk_buff_pool *pool)
308 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
309 __xskq_cons_release(xs->tx);
310 if (xsk_tx_writeable(xs))
311 xs->sk.sk_write_space(&xs->sk);
315 EXPORT_SYMBOL(xsk_tx_release);
317 bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
322 list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
323 if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
324 xs->tx->queue_empty_descs++;
328 /* This is the backpressure mechanism for the Tx path.
329 * Reserve space in the completion queue and only proceed
330 * if there is space in it. This avoids having to implement
331 * any buffering in the Tx path.
333 if (xskq_prod_reserve_addr(pool->cq, desc->addr))
336 xskq_cons_release(xs->tx);
345 EXPORT_SYMBOL(xsk_tx_peek_desc);
347 static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
349 struct xdp_desc *descs = pool->tx_descs;
352 while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
355 xsk_tx_release(pool);
359 u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
364 if (!list_is_singular(&pool->xsk_tx_list)) {
365 /* Fallback to the non-batched version */
367 return xsk_tx_peek_release_fallback(pool, nb_pkts);
370 xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock, tx_list);
376 nb_pkts = xskq_cons_nb_entries(xs->tx, nb_pkts);
378 /* This is the backpressure mechanism for the Tx path. Try to
379 * reserve space in the completion queue for all packets, but
380 * if there are fewer slots available, just process that many
381 * packets. This avoids having to implement any buffering in
384 nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
388 nb_pkts = xskq_cons_read_desc_batch(xs->tx, pool, nb_pkts);
390 xs->tx->queue_empty_descs++;
394 __xskq_cons_release(xs->tx);
395 xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_pkts);
396 xs->sk.sk_write_space(&xs->sk);
402 EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);
404 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
406 struct net_device *dev = xs->dev;
408 return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
411 static void xsk_destruct_skb(struct sk_buff *skb)
413 u64 addr = (u64)(long)skb_shinfo(skb)->destructor_arg;
414 struct xdp_sock *xs = xdp_sk(skb->sk);
417 spin_lock_irqsave(&xs->pool->cq_lock, flags);
418 xskq_prod_submit_addr(xs->pool->cq, addr);
419 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
424 static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
425 struct xdp_desc *desc)
427 struct xsk_buff_pool *pool = xs->pool;
428 u32 hr, len, ts, offset, copy, copied;
435 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));
437 skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
441 skb_reserve(skb, hr);
445 ts = pool->unaligned ? len : pool->chunk_size;
447 buffer = xsk_buff_raw_get_data(pool, addr);
448 offset = offset_in_page(buffer);
449 addr = buffer - pool->addrs;
451 for (copied = 0, i = 0; copied < len; i++) {
452 page = pool->umem->pgs[addr >> PAGE_SHIFT];
455 copy = min_t(u32, PAGE_SIZE - offset, len - copied);
456 skb_fill_page_desc(skb, i, page, offset, copy);
464 skb->data_len += len;
467 refcount_add(ts, &xs->sk.sk_wmem_alloc);
472 static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
473 struct xdp_desc *desc)
475 struct net_device *dev = xs->dev;
478 if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
479 skb = xsk_build_skb_zerocopy(xs, desc);
487 hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
488 tr = dev->needed_tailroom;
491 skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
495 skb_reserve(skb, hr);
498 buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
499 err = skb_store_bits(skb, 0, buffer, len);
507 skb->priority = xs->sk.sk_priority;
508 skb->mark = xs->sk.sk_mark;
509 skb_shinfo(skb)->destructor_arg = (void *)(long)desc->addr;
510 skb->destructor = xsk_destruct_skb;
515 static int __xsk_generic_xmit(struct sock *sk)
517 struct xdp_sock *xs = xdp_sk(sk);
518 u32 max_batch = TX_BATCH_SIZE;
519 bool sent_frame = false;
520 struct xdp_desc desc;
525 mutex_lock(&xs->mutex);
527 /* Since we dropped the RCU read lock, the socket state might have changed. */
528 if (unlikely(!xsk_is_bound(xs))) {
533 if (xs->queue_id >= xs->dev->real_num_tx_queues)
536 while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
537 if (max_batch-- == 0) {
542 /* This is the backpressure mechanism for the Tx path.
543 * Reserve space in the completion queue and only proceed
544 * if there is space in it. This avoids having to implement
545 * any buffering in the Tx path.
547 spin_lock_irqsave(&xs->pool->cq_lock, flags);
548 if (xskq_prod_reserve(xs->pool->cq)) {
549 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
552 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
554 skb = xsk_build_skb(xs, &desc);
557 spin_lock_irqsave(&xs->pool->cq_lock, flags);
558 xskq_prod_cancel(xs->pool->cq);
559 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
563 err = __dev_direct_xmit(skb, xs->queue_id);
564 if (err == NETDEV_TX_BUSY) {
565 /* Tell user-space to retry the send */
566 skb->destructor = sock_wfree;
567 spin_lock_irqsave(&xs->pool->cq_lock, flags);
568 xskq_prod_cancel(xs->pool->cq);
569 spin_unlock_irqrestore(&xs->pool->cq_lock, flags);
570 /* Free skb without triggering the perf drop trace */
576 xskq_cons_release(xs->tx);
577 /* Ignore NET_XMIT_CN as packet might have been sent */
578 if (err == NET_XMIT_DROP) {
579 /* SKB completed but not sent */
587 xs->tx->queue_empty_descs++;
591 if (xsk_tx_writeable(xs))
592 sk->sk_write_space(sk);
594 mutex_unlock(&xs->mutex);
598 static int xsk_generic_xmit(struct sock *sk)
602 /* Drop the RCU lock since the SKB path might sleep. */
604 ret = __xsk_generic_xmit(sk);
605 /* Reaquire RCU lock before going into common code. */
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_check_common(struct xdp_sock *xs)
624 if (unlikely(!xsk_is_bound(xs)))
626 if (unlikely(!(xs->dev->flags & IFF_UP)))
632 static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
634 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
635 struct sock *sk = sock->sk;
636 struct xdp_sock *xs = xdp_sk(sk);
637 struct xsk_buff_pool *pool;
640 err = xsk_check_common(xs);
643 if (unlikely(need_wait))
645 if (unlikely(!xs->tx))
648 if (sk_can_busy_loop(sk)) {
650 __sk_mark_napi_id_once(sk, xsk_pool_get_napi_id(xs->pool));
651 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
654 if (xs->zc && xsk_no_wakeup(sk))
658 if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
660 return xsk_wakeup(xs, XDP_WAKEUP_TX);
661 return xsk_generic_xmit(sk);
666 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
671 ret = __xsk_sendmsg(sock, m, total_len);
677 static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
679 bool need_wait = !(flags & MSG_DONTWAIT);
680 struct sock *sk = sock->sk;
681 struct xdp_sock *xs = xdp_sk(sk);
684 err = xsk_check_common(xs);
687 if (unlikely(!xs->rx))
689 if (unlikely(need_wait))
692 if (sk_can_busy_loop(sk))
693 sk_busy_loop(sk, 1); /* only support non-blocking sockets */
695 if (xsk_no_wakeup(sk))
698 if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
699 return xsk_wakeup(xs, XDP_WAKEUP_RX);
703 static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
708 ret = __xsk_recvmsg(sock, m, len, flags);
714 static __poll_t xsk_poll(struct file *file, struct socket *sock,
715 struct poll_table_struct *wait)
718 struct sock *sk = sock->sk;
719 struct xdp_sock *xs = xdp_sk(sk);
720 struct xsk_buff_pool *pool;
722 sock_poll_wait(file, sock, wait);
725 if (xsk_check_common(xs))
730 if (pool->cached_need_wakeup) {
732 xsk_wakeup(xs, pool->cached_need_wakeup);
734 /* Poll needs to drive Tx also in copy mode */
735 xsk_generic_xmit(sk);
739 if (xs->rx && !xskq_prod_is_empty(xs->rx))
740 mask |= EPOLLIN | EPOLLRDNORM;
741 if (xs->tx && xsk_tx_writeable(xs))
742 mask |= EPOLLOUT | EPOLLWRNORM;
748 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
753 if (entries == 0 || *queue || !is_power_of_2(entries))
756 q = xskq_create(entries, umem_queue);
760 /* Make sure queue is ready before it can be seen by others */
762 WRITE_ONCE(*queue, q);
766 static void xsk_unbind_dev(struct xdp_sock *xs)
768 struct net_device *dev = xs->dev;
770 if (xs->state != XSK_BOUND)
772 WRITE_ONCE(xs->state, XSK_UNBOUND);
774 /* Wait for driver to stop using the xdp socket. */
775 xp_del_xsk(xs->pool, xs);
780 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
781 struct xdp_sock __rcu ***map_entry)
783 struct xsk_map *map = NULL;
784 struct xsk_map_node *node;
788 spin_lock_bh(&xs->map_list_lock);
789 node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
792 bpf_map_inc(&node->map->map);
794 *map_entry = node->map_entry;
796 spin_unlock_bh(&xs->map_list_lock);
800 static void xsk_delete_from_maps(struct xdp_sock *xs)
802 /* This function removes the current XDP socket from all the
803 * maps it resides in. We need to take extra care here, due to
804 * the two locks involved. Each map has a lock synchronizing
805 * updates to the entries, and each socket has a lock that
806 * synchronizes access to the list of maps (map_list). For
807 * deadlock avoidance the locks need to be taken in the order
808 * "map lock"->"socket map list lock". We start off by
809 * accessing the socket map list, and take a reference to the
810 * map to guarantee existence between the
811 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
812 * calls. Then we ask the map to remove the socket, which
813 * tries to remove the socket from the map. Note that there
814 * might be updates to the map between
815 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
817 struct xdp_sock __rcu **map_entry = NULL;
820 while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
821 xsk_map_try_sock_delete(map, xs, map_entry);
822 bpf_map_put(&map->map);
826 static int xsk_release(struct socket *sock)
828 struct sock *sk = sock->sk;
829 struct xdp_sock *xs = xdp_sk(sk);
837 mutex_lock(&net->xdp.lock);
838 sk_del_node_init_rcu(sk);
839 mutex_unlock(&net->xdp.lock);
841 sock_prot_inuse_add(net, sk->sk_prot, -1);
843 xsk_delete_from_maps(xs);
844 mutex_lock(&xs->mutex);
846 mutex_unlock(&xs->mutex);
848 xskq_destroy(xs->rx);
849 xskq_destroy(xs->tx);
850 xskq_destroy(xs->fq_tmp);
851 xskq_destroy(xs->cq_tmp);
861 static struct socket *xsk_lookup_xsk_from_fd(int fd)
866 sock = sockfd_lookup(fd, &err);
868 return ERR_PTR(-ENOTSOCK);
870 if (sock->sk->sk_family != PF_XDP) {
872 return ERR_PTR(-ENOPROTOOPT);
878 static bool xsk_validate_queues(struct xdp_sock *xs)
880 return xs->fq_tmp && xs->cq_tmp;
883 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
885 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
886 struct sock *sk = sock->sk;
887 struct xdp_sock *xs = xdp_sk(sk);
888 struct net_device *dev;
893 if (addr_len < sizeof(struct sockaddr_xdp))
895 if (sxdp->sxdp_family != AF_XDP)
898 flags = sxdp->sxdp_flags;
899 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
900 XDP_USE_NEED_WAKEUP))
903 bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
904 if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
908 mutex_lock(&xs->mutex);
909 if (xs->state != XSK_READY) {
914 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
920 if (!xs->rx && !xs->tx) {
925 qid = sxdp->sxdp_queue_id;
927 if (flags & XDP_SHARED_UMEM) {
928 struct xdp_sock *umem_xs;
931 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
932 (flags & XDP_USE_NEED_WAKEUP)) {
933 /* Cannot specify flags for shared sockets. */
939 /* We have already our own. */
944 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
950 umem_xs = xdp_sk(sock->sk);
951 if (!xsk_is_bound(umem_xs)) {
957 if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
958 /* Share the umem with another socket on another qid
961 xs->pool = xp_create_and_assign_umem(xs,
969 err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
972 xp_destroy(xs->pool);
978 /* Share the buffer pool with the other socket. */
979 if (xs->fq_tmp || xs->cq_tmp) {
980 /* Do not allow setting your own fq or cq. */
986 xp_get_pool(umem_xs->pool);
987 xs->pool = umem_xs->pool;
989 /* If underlying shared umem was created without Tx
990 * ring, allocate Tx descs array that Tx batching API
993 if (xs->tx && !xs->pool->tx_descs) {
994 err = xp_alloc_tx_descs(xs->pool, xs);
996 xp_put_pool(xs->pool);
1003 xdp_get_umem(umem_xs->umem);
1004 WRITE_ONCE(xs->umem, umem_xs->umem);
1006 } else if (!xs->umem || !xsk_validate_queues(xs)) {
1010 /* This xsk has its own umem. */
1011 xs->pool = xp_create_and_assign_umem(xs, xs->umem);
1017 err = xp_assign_dev(xs->pool, dev, qid, flags);
1019 xp_destroy(xs->pool);
1025 /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
1030 xs->zc = xs->umem->zc;
1032 xp_add_xsk(xs->pool, xs);
1038 /* Matches smp_rmb() in bind() for shared umem
1039 * sockets, and xsk_is_bound().
1042 WRITE_ONCE(xs->state, XSK_BOUND);
1045 mutex_unlock(&xs->mutex);
1050 struct xdp_umem_reg_v1 {
1051 __u64 addr; /* Start of packet data area */
1052 __u64 len; /* Length of packet data area */
1057 static int xsk_setsockopt(struct socket *sock, int level, int optname,
1058 sockptr_t optval, unsigned int optlen)
1060 struct sock *sk = sock->sk;
1061 struct xdp_sock *xs = xdp_sk(sk);
1064 if (level != SOL_XDP)
1065 return -ENOPROTOOPT;
1071 struct xsk_queue **q;
1074 if (optlen < sizeof(entries))
1076 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1079 mutex_lock(&xs->mutex);
1080 if (xs->state != XSK_READY) {
1081 mutex_unlock(&xs->mutex);
1084 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
1085 err = xsk_init_queue(entries, q, false);
1086 if (!err && optname == XDP_TX_RING)
1087 /* Tx needs to be explicitly woken up the first time */
1088 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
1089 mutex_unlock(&xs->mutex);
1094 size_t mr_size = sizeof(struct xdp_umem_reg);
1095 struct xdp_umem_reg mr = {};
1096 struct xdp_umem *umem;
1098 if (optlen < sizeof(struct xdp_umem_reg_v1))
1100 else if (optlen < sizeof(mr))
1101 mr_size = sizeof(struct xdp_umem_reg_v1);
1103 if (copy_from_sockptr(&mr, optval, mr_size))
1106 mutex_lock(&xs->mutex);
1107 if (xs->state != XSK_READY || xs->umem) {
1108 mutex_unlock(&xs->mutex);
1112 umem = xdp_umem_create(&mr);
1114 mutex_unlock(&xs->mutex);
1115 return PTR_ERR(umem);
1118 /* Make sure umem is ready before it can be seen by others */
1120 WRITE_ONCE(xs->umem, umem);
1121 mutex_unlock(&xs->mutex);
1124 case XDP_UMEM_FILL_RING:
1125 case XDP_UMEM_COMPLETION_RING:
1127 struct xsk_queue **q;
1130 if (copy_from_sockptr(&entries, optval, sizeof(entries)))
1133 mutex_lock(&xs->mutex);
1134 if (xs->state != XSK_READY) {
1135 mutex_unlock(&xs->mutex);
1139 q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
1141 err = xsk_init_queue(entries, q, true);
1142 mutex_unlock(&xs->mutex);
1149 return -ENOPROTOOPT;
1152 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
1154 ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
1155 ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
1156 ring->desc = offsetof(struct xdp_rxtx_ring, desc);
1159 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
1161 ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
1162 ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
1163 ring->desc = offsetof(struct xdp_umem_ring, desc);
1166 struct xdp_statistics_v1 {
1168 __u64 rx_invalid_descs;
1169 __u64 tx_invalid_descs;
1172 static int xsk_getsockopt(struct socket *sock, int level, int optname,
1173 char __user *optval, int __user *optlen)
1175 struct sock *sk = sock->sk;
1176 struct xdp_sock *xs = xdp_sk(sk);
1179 if (level != SOL_XDP)
1180 return -ENOPROTOOPT;
1182 if (get_user(len, optlen))
1188 case XDP_STATISTICS:
1190 struct xdp_statistics stats = {};
1191 bool extra_stats = true;
1194 if (len < sizeof(struct xdp_statistics_v1)) {
1196 } else if (len < sizeof(stats)) {
1197 extra_stats = false;
1198 stats_size = sizeof(struct xdp_statistics_v1);
1200 stats_size = sizeof(stats);
1203 mutex_lock(&xs->mutex);
1204 stats.rx_dropped = xs->rx_dropped;
1206 stats.rx_ring_full = xs->rx_queue_full;
1207 stats.rx_fill_ring_empty_descs =
1208 xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
1209 stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
1211 stats.rx_dropped += xs->rx_queue_full;
1213 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
1214 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
1215 mutex_unlock(&xs->mutex);
1217 if (copy_to_user(optval, &stats, stats_size))
1219 if (put_user(stats_size, optlen))
1224 case XDP_MMAP_OFFSETS:
1226 struct xdp_mmap_offsets off;
1227 struct xdp_mmap_offsets_v1 off_v1;
1228 bool flags_supported = true;
1231 if (len < sizeof(off_v1))
1233 else if (len < sizeof(off))
1234 flags_supported = false;
1236 if (flags_supported) {
1237 /* xdp_ring_offset is identical to xdp_ring_offset_v1
1238 * except for the flags field added to the end.
1240 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1242 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
1244 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1246 xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
1248 off.rx.flags = offsetof(struct xdp_rxtx_ring,
1250 off.tx.flags = offsetof(struct xdp_rxtx_ring,
1252 off.fr.flags = offsetof(struct xdp_umem_ring,
1254 off.cr.flags = offsetof(struct xdp_umem_ring,
1260 xsk_enter_rxtx_offsets(&off_v1.rx);
1261 xsk_enter_rxtx_offsets(&off_v1.tx);
1262 xsk_enter_umem_offsets(&off_v1.fr);
1263 xsk_enter_umem_offsets(&off_v1.cr);
1265 len = sizeof(off_v1);
1269 if (copy_to_user(optval, to_copy, len))
1271 if (put_user(len, optlen))
1278 struct xdp_options opts = {};
1280 if (len < sizeof(opts))
1283 mutex_lock(&xs->mutex);
1285 opts.flags |= XDP_OPTIONS_ZEROCOPY;
1286 mutex_unlock(&xs->mutex);
1289 if (copy_to_user(optval, &opts, len))
1291 if (put_user(len, optlen))
1303 static int xsk_mmap(struct file *file, struct socket *sock,
1304 struct vm_area_struct *vma)
1306 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
1307 unsigned long size = vma->vm_end - vma->vm_start;
1308 struct xdp_sock *xs = xdp_sk(sock->sk);
1309 int state = READ_ONCE(xs->state);
1310 struct xsk_queue *q = NULL;
1312 if (state != XSK_READY && state != XSK_BOUND)
1315 if (offset == XDP_PGOFF_RX_RING) {
1316 q = READ_ONCE(xs->rx);
1317 } else if (offset == XDP_PGOFF_TX_RING) {
1318 q = READ_ONCE(xs->tx);
1320 /* Matches the smp_wmb() in XDP_UMEM_REG */
1322 if (offset == XDP_UMEM_PGOFF_FILL_RING)
1323 q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
1324 READ_ONCE(xs->pool->fq);
1325 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
1326 q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
1327 READ_ONCE(xs->pool->cq);
1333 /* Matches the smp_wmb() in xsk_init_queue */
1335 if (size > q->ring_vmalloc_size)
1338 return remap_vmalloc_range(vma, q->ring, 0);
1341 static int xsk_notifier(struct notifier_block *this,
1342 unsigned long msg, void *ptr)
1344 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1345 struct net *net = dev_net(dev);
1349 case NETDEV_UNREGISTER:
1350 mutex_lock(&net->xdp.lock);
1351 sk_for_each(sk, &net->xdp.list) {
1352 struct xdp_sock *xs = xdp_sk(sk);
1354 mutex_lock(&xs->mutex);
1355 if (xs->dev == dev) {
1356 sk->sk_err = ENETDOWN;
1357 if (!sock_flag(sk, SOCK_DEAD))
1358 sk_error_report(sk);
1362 /* Clear device references. */
1363 xp_clear_dev(xs->pool);
1365 mutex_unlock(&xs->mutex);
1367 mutex_unlock(&net->xdp.lock);
1373 static struct proto xsk_proto = {
1375 .owner = THIS_MODULE,
1376 .obj_size = sizeof(struct xdp_sock),
1379 static const struct proto_ops xsk_proto_ops = {
1381 .owner = THIS_MODULE,
1382 .release = xsk_release,
1384 .connect = sock_no_connect,
1385 .socketpair = sock_no_socketpair,
1386 .accept = sock_no_accept,
1387 .getname = sock_no_getname,
1389 .ioctl = sock_no_ioctl,
1390 .listen = sock_no_listen,
1391 .shutdown = sock_no_shutdown,
1392 .setsockopt = xsk_setsockopt,
1393 .getsockopt = xsk_getsockopt,
1394 .sendmsg = xsk_sendmsg,
1395 .recvmsg = xsk_recvmsg,
1399 static void xsk_destruct(struct sock *sk)
1401 struct xdp_sock *xs = xdp_sk(sk);
1403 if (!sock_flag(sk, SOCK_DEAD))
1406 if (!xp_put_pool(xs->pool))
1407 xdp_put_umem(xs->umem, !xs->pool);
1410 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1413 struct xdp_sock *xs;
1416 if (!ns_capable(net->user_ns, CAP_NET_RAW))
1418 if (sock->type != SOCK_RAW)
1419 return -ESOCKTNOSUPPORT;
1422 return -EPROTONOSUPPORT;
1424 sock->state = SS_UNCONNECTED;
1426 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1430 sock->ops = &xsk_proto_ops;
1432 sock_init_data(sock, sk);
1434 sk->sk_family = PF_XDP;
1436 sk->sk_destruct = xsk_destruct;
1438 sock_set_flag(sk, SOCK_RCU_FREE);
1441 xs->state = XSK_READY;
1442 mutex_init(&xs->mutex);
1443 spin_lock_init(&xs->rx_lock);
1445 INIT_LIST_HEAD(&xs->map_list);
1446 spin_lock_init(&xs->map_list_lock);
1448 mutex_lock(&net->xdp.lock);
1449 sk_add_node_rcu(sk, &net->xdp.list);
1450 mutex_unlock(&net->xdp.lock);
1452 sock_prot_inuse_add(net, &xsk_proto, 1);
1457 static const struct net_proto_family xsk_family_ops = {
1459 .create = xsk_create,
1460 .owner = THIS_MODULE,
1463 static struct notifier_block xsk_netdev_notifier = {
1464 .notifier_call = xsk_notifier,
1467 static int __net_init xsk_net_init(struct net *net)
1469 mutex_init(&net->xdp.lock);
1470 INIT_HLIST_HEAD(&net->xdp.list);
1474 static void __net_exit xsk_net_exit(struct net *net)
1476 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1479 static struct pernet_operations xsk_net_ops = {
1480 .init = xsk_net_init,
1481 .exit = xsk_net_exit,
1484 static int __init xsk_init(void)
1488 err = proto_register(&xsk_proto, 0 /* no slab */);
1492 err = sock_register(&xsk_family_ops);
1496 err = register_pernet_subsys(&xsk_net_ops);
1500 err = register_netdevice_notifier(&xsk_netdev_notifier);
1504 for_each_possible_cpu(cpu)
1505 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list, cpu));
1509 unregister_pernet_subsys(&xsk_net_ops);
1511 sock_unregister(PF_XDP);
1513 proto_unregister(&xsk_proto);
1518 fs_initcall(xsk_init);