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.h>
28 #include "xsk_queue.h"
32 #define TX_BATCH_SIZE 16
34 bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs)
36 return READ_ONCE(xs->rx) && READ_ONCE(xs->umem) &&
37 READ_ONCE(xs->umem->fq);
40 bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt)
42 return xskq_has_addrs(umem->fq, cnt);
44 EXPORT_SYMBOL(xsk_umem_has_addrs);
46 u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr)
48 return xskq_peek_addr(umem->fq, addr);
50 EXPORT_SYMBOL(xsk_umem_peek_addr);
52 void xsk_umem_discard_addr(struct xdp_umem *umem)
54 xskq_discard_addr(umem->fq);
56 EXPORT_SYMBOL(xsk_umem_discard_addr);
58 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
60 void *to_buf, *from_buf;
65 if (!xskq_peek_addr(xs->umem->fq, &addr) ||
66 len > xs->umem->chunk_size_nohr - XDP_PACKET_HEADROOM) {
71 addr += xs->umem->headroom;
73 if (unlikely(xdp_data_meta_unsupported(xdp))) {
77 from_buf = xdp->data_meta;
78 metalen = xdp->data - xdp->data_meta;
81 to_buf = xdp_umem_get_data(xs->umem, addr);
82 memcpy(to_buf, from_buf, len + metalen);
84 err = xskq_produce_batch_desc(xs->rx, addr, len);
86 xskq_discard_addr(xs->umem->fq);
95 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
97 int err = xskq_produce_batch_desc(xs->rx, (u64)xdp->handle, len);
105 int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
109 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
112 len = xdp->data_end - xdp->data;
114 return (xdp->rxq->mem.type == MEM_TYPE_ZERO_COPY) ?
115 __xsk_rcv_zc(xs, xdp, len) : __xsk_rcv(xs, xdp, len);
118 void xsk_flush(struct xdp_sock *xs)
120 xskq_produce_flush_desc(xs->rx);
121 xs->sk.sk_data_ready(&xs->sk);
124 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
126 u32 metalen = xdp->data - xdp->data_meta;
127 u32 len = xdp->data_end - xdp->data;
132 spin_lock_bh(&xs->rx_lock);
134 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index) {
139 if (!xskq_peek_addr(xs->umem->fq, &addr) ||
140 len > xs->umem->chunk_size_nohr - XDP_PACKET_HEADROOM) {
145 addr += xs->umem->headroom;
147 buffer = xdp_umem_get_data(xs->umem, addr);
148 memcpy(buffer, xdp->data_meta, len + metalen);
150 err = xskq_produce_batch_desc(xs->rx, addr, len);
154 xskq_discard_addr(xs->umem->fq);
155 xskq_produce_flush_desc(xs->rx);
157 spin_unlock_bh(&xs->rx_lock);
159 xs->sk.sk_data_ready(&xs->sk);
165 spin_unlock_bh(&xs->rx_lock);
169 void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries)
171 xskq_produce_flush_addr_n(umem->cq, nb_entries);
173 EXPORT_SYMBOL(xsk_umem_complete_tx);
175 void xsk_umem_consume_tx_done(struct xdp_umem *umem)
180 list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
181 xs->sk.sk_write_space(&xs->sk);
185 EXPORT_SYMBOL(xsk_umem_consume_tx_done);
187 bool xsk_umem_consume_tx(struct xdp_umem *umem, struct xdp_desc *desc)
192 list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
193 if (!xskq_peek_desc(xs->tx, desc))
196 if (xskq_produce_addr_lazy(umem->cq, desc->addr))
199 xskq_discard_desc(xs->tx);
208 EXPORT_SYMBOL(xsk_umem_consume_tx);
210 static int xsk_zc_xmit(struct sock *sk)
212 struct xdp_sock *xs = xdp_sk(sk);
213 struct net_device *dev = xs->dev;
215 return dev->netdev_ops->ndo_xsk_async_xmit(dev, xs->queue_id);
218 static void xsk_destruct_skb(struct sk_buff *skb)
220 u64 addr = (u64)(long)skb_shinfo(skb)->destructor_arg;
221 struct xdp_sock *xs = xdp_sk(skb->sk);
224 spin_lock_irqsave(&xs->tx_completion_lock, flags);
225 WARN_ON_ONCE(xskq_produce_addr(xs->umem->cq, addr));
226 spin_unlock_irqrestore(&xs->tx_completion_lock, flags);
231 static int xsk_generic_xmit(struct sock *sk, struct msghdr *m,
234 u32 max_batch = TX_BATCH_SIZE;
235 struct xdp_sock *xs = xdp_sk(sk);
236 bool sent_frame = false;
237 struct xdp_desc desc;
241 mutex_lock(&xs->mutex);
243 if (xs->queue_id >= xs->dev->real_num_tx_queues)
246 while (xskq_peek_desc(xs->tx, &desc)) {
251 if (max_batch-- == 0) {
257 skb = sock_alloc_send_skb(sk, len, 1, &err);
258 if (unlikely(!skb)) {
265 buffer = xdp_umem_get_data(xs->umem, addr);
266 err = skb_store_bits(skb, 0, buffer, len);
267 if (unlikely(err) || xskq_reserve_addr(xs->umem->cq)) {
273 skb->priority = sk->sk_priority;
274 skb->mark = sk->sk_mark;
275 skb_shinfo(skb)->destructor_arg = (void *)(long)addr;
276 skb->destructor = xsk_destruct_skb;
278 err = dev_direct_xmit(skb, xs->queue_id);
279 xskq_discard_desc(xs->tx);
280 /* Ignore NET_XMIT_CN as packet might have been sent */
281 if (err == NET_XMIT_DROP || err == NETDEV_TX_BUSY) {
282 /* SKB completed but not sent */
292 sk->sk_write_space(sk);
294 mutex_unlock(&xs->mutex);
298 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
300 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
301 struct sock *sk = sock->sk;
302 struct xdp_sock *xs = xdp_sk(sk);
304 if (unlikely(!xs->dev))
306 if (unlikely(!(xs->dev->flags & IFF_UP)))
308 if (unlikely(!xs->tx))
313 return (xs->zc) ? xsk_zc_xmit(sk) : xsk_generic_xmit(sk, m, total_len);
316 static unsigned int xsk_poll(struct file *file, struct socket *sock,
317 struct poll_table_struct *wait)
319 unsigned int mask = datagram_poll(file, sock, wait);
320 struct sock *sk = sock->sk;
321 struct xdp_sock *xs = xdp_sk(sk);
323 if (xs->rx && !xskq_empty_desc(xs->rx))
324 mask |= POLLIN | POLLRDNORM;
325 if (xs->tx && !xskq_full_desc(xs->tx))
326 mask |= POLLOUT | POLLWRNORM;
331 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
336 if (entries == 0 || *queue || !is_power_of_2(entries))
339 q = xskq_create(entries, umem_queue);
343 /* Make sure queue is ready before it can be seen by others */
349 static void xsk_unbind_dev(struct xdp_sock *xs)
351 struct net_device *dev = xs->dev;
353 if (!dev || xs->state != XSK_BOUND)
356 xs->state = XSK_UNBOUND;
358 /* Wait for driver to stop using the xdp socket. */
359 xdp_del_sk_umem(xs->umem, xs);
365 static int xsk_release(struct socket *sock)
367 struct sock *sk = sock->sk;
368 struct xdp_sock *xs = xdp_sk(sk);
376 mutex_lock(&net->xdp.lock);
377 sk_del_node_init_rcu(sk);
378 mutex_unlock(&net->xdp.lock);
381 sock_prot_inuse_add(net, sk->sk_prot, -1);
386 xskq_destroy(xs->rx);
387 xskq_destroy(xs->tx);
392 sk_refcnt_debug_release(sk);
398 static struct socket *xsk_lookup_xsk_from_fd(int fd)
403 sock = sockfd_lookup(fd, &err);
405 return ERR_PTR(-ENOTSOCK);
407 if (sock->sk->sk_family != PF_XDP) {
409 return ERR_PTR(-ENOPROTOOPT);
415 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
417 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
418 struct sock *sk = sock->sk;
419 struct xdp_sock *xs = xdp_sk(sk);
420 struct net_device *dev;
424 if (addr_len < sizeof(struct sockaddr_xdp))
426 if (sxdp->sxdp_family != AF_XDP)
429 flags = sxdp->sxdp_flags;
430 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY))
434 mutex_lock(&xs->mutex);
435 if (xs->state != XSK_READY) {
440 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
446 if (!xs->rx && !xs->tx) {
451 qid = sxdp->sxdp_queue_id;
453 if (flags & XDP_SHARED_UMEM) {
454 struct xdp_sock *umem_xs;
457 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY)) {
458 /* Cannot specify flags for shared sockets. */
464 /* We have already our own. */
469 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
475 umem_xs = xdp_sk(sock->sk);
476 if (!umem_xs->umem) {
477 /* No umem to inherit. */
481 } else if (umem_xs->dev != dev || umem_xs->queue_id != qid) {
487 xdp_get_umem(umem_xs->umem);
488 xs->umem = umem_xs->umem;
490 } else if (!xs->umem || !xdp_umem_validate_queues(xs->umem)) {
494 /* This xsk has its own umem. */
495 xskq_set_umem(xs->umem->fq, xs->umem->size,
496 xs->umem->chunk_mask);
497 xskq_set_umem(xs->umem->cq, xs->umem->size,
498 xs->umem->chunk_mask);
500 err = xdp_umem_assign_dev(xs->umem, dev, qid, flags);
506 xs->zc = xs->umem->zc;
508 xskq_set_umem(xs->rx, xs->umem->size, xs->umem->chunk_mask);
509 xskq_set_umem(xs->tx, xs->umem->size, xs->umem->chunk_mask);
510 xdp_add_sk_umem(xs->umem, xs);
516 xs->state = XSK_BOUND;
518 mutex_unlock(&xs->mutex);
523 static int xsk_setsockopt(struct socket *sock, int level, int optname,
524 char __user *optval, unsigned int optlen)
526 struct sock *sk = sock->sk;
527 struct xdp_sock *xs = xdp_sk(sk);
530 if (level != SOL_XDP)
537 struct xsk_queue **q;
540 if (optlen < sizeof(entries))
542 if (copy_from_user(&entries, optval, sizeof(entries)))
545 mutex_lock(&xs->mutex);
546 if (xs->state != XSK_READY) {
547 mutex_unlock(&xs->mutex);
550 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
551 err = xsk_init_queue(entries, q, false);
552 mutex_unlock(&xs->mutex);
557 struct xdp_umem_reg mr;
558 struct xdp_umem *umem;
560 if (copy_from_user(&mr, optval, sizeof(mr)))
563 mutex_lock(&xs->mutex);
564 if (xs->state != XSK_READY || xs->umem) {
565 mutex_unlock(&xs->mutex);
569 umem = xdp_umem_create(&mr);
571 mutex_unlock(&xs->mutex);
572 return PTR_ERR(umem);
575 /* Make sure umem is ready before it can be seen by others */
578 mutex_unlock(&xs->mutex);
581 case XDP_UMEM_FILL_RING:
582 case XDP_UMEM_COMPLETION_RING:
584 struct xsk_queue **q;
587 if (copy_from_user(&entries, optval, sizeof(entries)))
590 mutex_lock(&xs->mutex);
591 if (xs->state != XSK_READY) {
592 mutex_unlock(&xs->mutex);
596 mutex_unlock(&xs->mutex);
600 q = (optname == XDP_UMEM_FILL_RING) ? &xs->umem->fq :
602 err = xsk_init_queue(entries, q, true);
603 mutex_unlock(&xs->mutex);
613 static int xsk_getsockopt(struct socket *sock, int level, int optname,
614 char __user *optval, int __user *optlen)
616 struct sock *sk = sock->sk;
617 struct xdp_sock *xs = xdp_sk(sk);
620 if (level != SOL_XDP)
623 if (get_user(len, optlen))
631 struct xdp_statistics stats;
633 if (len < sizeof(stats))
636 mutex_lock(&xs->mutex);
637 stats.rx_dropped = xs->rx_dropped;
638 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
639 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
640 mutex_unlock(&xs->mutex);
642 if (copy_to_user(optval, &stats, sizeof(stats)))
644 if (put_user(sizeof(stats), optlen))
649 case XDP_MMAP_OFFSETS:
651 struct xdp_mmap_offsets off;
653 if (len < sizeof(off))
656 off.rx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
657 off.rx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
658 off.rx.desc = offsetof(struct xdp_rxtx_ring, desc);
659 off.tx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
660 off.tx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
661 off.tx.desc = offsetof(struct xdp_rxtx_ring, desc);
663 off.fr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
664 off.fr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
665 off.fr.desc = offsetof(struct xdp_umem_ring, desc);
666 off.cr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
667 off.cr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
668 off.cr.desc = offsetof(struct xdp_umem_ring, desc);
671 if (copy_to_user(optval, &off, len))
673 if (put_user(len, optlen))
680 struct xdp_options opts = {};
682 if (len < sizeof(opts))
685 mutex_lock(&xs->mutex);
687 opts.flags |= XDP_OPTIONS_ZEROCOPY;
688 mutex_unlock(&xs->mutex);
691 if (copy_to_user(optval, &opts, len))
693 if (put_user(len, optlen))
705 static int xsk_mmap(struct file *file, struct socket *sock,
706 struct vm_area_struct *vma)
708 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
709 unsigned long size = vma->vm_end - vma->vm_start;
710 struct xdp_sock *xs = xdp_sk(sock->sk);
711 struct xsk_queue *q = NULL;
712 struct xdp_umem *umem;
716 if (xs->state != XSK_READY)
719 if (offset == XDP_PGOFF_RX_RING) {
720 q = READ_ONCE(xs->rx);
721 } else if (offset == XDP_PGOFF_TX_RING) {
722 q = READ_ONCE(xs->tx);
724 umem = READ_ONCE(xs->umem);
728 /* Matches the smp_wmb() in XDP_UMEM_REG */
730 if (offset == XDP_UMEM_PGOFF_FILL_RING)
731 q = READ_ONCE(umem->fq);
732 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
733 q = READ_ONCE(umem->cq);
739 /* Matches the smp_wmb() in xsk_init_queue */
741 qpg = virt_to_head_page(q->ring);
742 if (size > (PAGE_SIZE << compound_order(qpg)))
745 pfn = virt_to_phys(q->ring) >> PAGE_SHIFT;
746 return remap_pfn_range(vma, vma->vm_start, pfn,
747 size, vma->vm_page_prot);
750 static int xsk_notifier(struct notifier_block *this,
751 unsigned long msg, void *ptr)
753 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
754 struct net *net = dev_net(dev);
758 case NETDEV_UNREGISTER:
759 mutex_lock(&net->xdp.lock);
760 sk_for_each(sk, &net->xdp.list) {
761 struct xdp_sock *xs = xdp_sk(sk);
763 mutex_lock(&xs->mutex);
764 if (xs->dev == dev) {
765 sk->sk_err = ENETDOWN;
766 if (!sock_flag(sk, SOCK_DEAD))
767 sk->sk_error_report(sk);
771 /* Clear device references in umem. */
772 xdp_umem_clear_dev(xs->umem);
774 mutex_unlock(&xs->mutex);
776 mutex_unlock(&net->xdp.lock);
782 static struct proto xsk_proto = {
784 .owner = THIS_MODULE,
785 .obj_size = sizeof(struct xdp_sock),
788 static const struct proto_ops xsk_proto_ops = {
790 .owner = THIS_MODULE,
791 .release = xsk_release,
793 .connect = sock_no_connect,
794 .socketpair = sock_no_socketpair,
795 .accept = sock_no_accept,
796 .getname = sock_no_getname,
798 .ioctl = sock_no_ioctl,
799 .listen = sock_no_listen,
800 .shutdown = sock_no_shutdown,
801 .setsockopt = xsk_setsockopt,
802 .getsockopt = xsk_getsockopt,
803 .sendmsg = xsk_sendmsg,
804 .recvmsg = sock_no_recvmsg,
806 .sendpage = sock_no_sendpage,
809 static void xsk_destruct(struct sock *sk)
811 struct xdp_sock *xs = xdp_sk(sk);
813 if (!sock_flag(sk, SOCK_DEAD))
816 xdp_put_umem(xs->umem);
818 sk_refcnt_debug_dec(sk);
821 static int xsk_create(struct net *net, struct socket *sock, int protocol,
827 if (!ns_capable(net->user_ns, CAP_NET_RAW))
829 if (sock->type != SOCK_RAW)
830 return -ESOCKTNOSUPPORT;
833 return -EPROTONOSUPPORT;
835 sock->state = SS_UNCONNECTED;
837 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
841 sock->ops = &xsk_proto_ops;
843 sock_init_data(sock, sk);
845 sk->sk_family = PF_XDP;
847 sk->sk_destruct = xsk_destruct;
848 sk_refcnt_debug_inc(sk);
850 sock_set_flag(sk, SOCK_RCU_FREE);
853 xs->state = XSK_READY;
854 mutex_init(&xs->mutex);
855 spin_lock_init(&xs->rx_lock);
856 spin_lock_init(&xs->tx_completion_lock);
858 mutex_lock(&net->xdp.lock);
859 sk_add_node_rcu(sk, &net->xdp.list);
860 mutex_unlock(&net->xdp.lock);
863 sock_prot_inuse_add(net, &xsk_proto, 1);
869 static const struct net_proto_family xsk_family_ops = {
871 .create = xsk_create,
872 .owner = THIS_MODULE,
875 static struct notifier_block xsk_netdev_notifier = {
876 .notifier_call = xsk_notifier,
879 static int __net_init xsk_net_init(struct net *net)
881 mutex_init(&net->xdp.lock);
882 INIT_HLIST_HEAD(&net->xdp.list);
886 static void __net_exit xsk_net_exit(struct net *net)
888 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
891 static struct pernet_operations xsk_net_ops = {
892 .init = xsk_net_init,
893 .exit = xsk_net_exit,
896 static int __init xsk_init(void)
900 err = proto_register(&xsk_proto, 0 /* no slab */);
904 err = sock_register(&xsk_family_ops);
908 err = register_pernet_subsys(&xsk_net_ops);
912 err = register_netdevice_notifier(&xsk_netdev_notifier);
919 unregister_pernet_subsys(&xsk_net_ops);
921 sock_unregister(PF_XDP);
923 proto_unregister(&xsk_proto);
928 fs_initcall(xsk_init);