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 while (xskq_peek_desc(xs->tx, &desc)) {
248 if (max_batch-- == 0) {
253 if (xskq_reserve_addr(xs->umem->cq))
256 if (xs->queue_id >= xs->dev->real_num_tx_queues)
260 skb = sock_alloc_send_skb(sk, len, 1, &err);
261 if (unlikely(!skb)) {
268 buffer = xdp_umem_get_data(xs->umem, addr);
269 err = skb_store_bits(skb, 0, buffer, len);
276 skb->priority = sk->sk_priority;
277 skb->mark = sk->sk_mark;
278 skb_shinfo(skb)->destructor_arg = (void *)(long)addr;
279 skb->destructor = xsk_destruct_skb;
281 err = dev_direct_xmit(skb, xs->queue_id);
282 xskq_discard_desc(xs->tx);
283 /* Ignore NET_XMIT_CN as packet might have been sent */
284 if (err == NET_XMIT_DROP || err == NETDEV_TX_BUSY) {
285 /* SKB completed but not sent */
295 sk->sk_write_space(sk);
297 mutex_unlock(&xs->mutex);
301 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
303 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
304 struct sock *sk = sock->sk;
305 struct xdp_sock *xs = xdp_sk(sk);
307 if (unlikely(!xs->dev))
309 if (unlikely(!(xs->dev->flags & IFF_UP)))
311 if (unlikely(!xs->tx))
316 return (xs->zc) ? xsk_zc_xmit(sk) : xsk_generic_xmit(sk, m, total_len);
319 static unsigned int xsk_poll(struct file *file, struct socket *sock,
320 struct poll_table_struct *wait)
322 unsigned int mask = datagram_poll(file, sock, wait);
323 struct sock *sk = sock->sk;
324 struct xdp_sock *xs = xdp_sk(sk);
326 if (xs->rx && !xskq_empty_desc(xs->rx))
327 mask |= POLLIN | POLLRDNORM;
328 if (xs->tx && !xskq_full_desc(xs->tx))
329 mask |= POLLOUT | POLLWRNORM;
334 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
339 if (entries == 0 || *queue || !is_power_of_2(entries))
342 q = xskq_create(entries, umem_queue);
346 /* Make sure queue is ready before it can be seen by others */
352 static void xsk_unbind_dev(struct xdp_sock *xs)
354 struct net_device *dev = xs->dev;
356 if (!dev || xs->state != XSK_BOUND)
359 xs->state = XSK_UNBOUND;
361 /* Wait for driver to stop using the xdp socket. */
362 xdp_del_sk_umem(xs->umem, xs);
368 static int xsk_release(struct socket *sock)
370 struct sock *sk = sock->sk;
371 struct xdp_sock *xs = xdp_sk(sk);
379 mutex_lock(&net->xdp.lock);
380 sk_del_node_init_rcu(sk);
381 mutex_unlock(&net->xdp.lock);
384 sock_prot_inuse_add(net, sk->sk_prot, -1);
389 xskq_destroy(xs->rx);
390 xskq_destroy(xs->tx);
395 sk_refcnt_debug_release(sk);
401 static struct socket *xsk_lookup_xsk_from_fd(int fd)
406 sock = sockfd_lookup(fd, &err);
408 return ERR_PTR(-ENOTSOCK);
410 if (sock->sk->sk_family != PF_XDP) {
412 return ERR_PTR(-ENOPROTOOPT);
418 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
420 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
421 struct sock *sk = sock->sk;
422 struct xdp_sock *xs = xdp_sk(sk);
423 struct net_device *dev;
427 if (addr_len < sizeof(struct sockaddr_xdp))
429 if (sxdp->sxdp_family != AF_XDP)
432 flags = sxdp->sxdp_flags;
433 if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY))
436 mutex_lock(&xs->mutex);
437 if (xs->state != XSK_READY) {
442 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
448 if (!xs->rx && !xs->tx) {
453 qid = sxdp->sxdp_queue_id;
455 if (flags & XDP_SHARED_UMEM) {
456 struct xdp_sock *umem_xs;
459 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY)) {
460 /* Cannot specify flags for shared sockets. */
466 /* We have already our own. */
471 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
477 umem_xs = xdp_sk(sock->sk);
478 if (!umem_xs->umem) {
479 /* No umem to inherit. */
483 } else if (umem_xs->dev != dev || umem_xs->queue_id != qid) {
489 xdp_get_umem(umem_xs->umem);
490 xs->umem = umem_xs->umem;
492 } else if (!xs->umem || !xdp_umem_validate_queues(xs->umem)) {
496 /* This xsk has its own umem. */
497 xskq_set_umem(xs->umem->fq, xs->umem->size,
498 xs->umem->chunk_mask);
499 xskq_set_umem(xs->umem->cq, xs->umem->size,
500 xs->umem->chunk_mask);
502 err = xdp_umem_assign_dev(xs->umem, dev, qid, flags);
508 xs->zc = xs->umem->zc;
510 xskq_set_umem(xs->rx, xs->umem->size, xs->umem->chunk_mask);
511 xskq_set_umem(xs->tx, xs->umem->size, xs->umem->chunk_mask);
512 xdp_add_sk_umem(xs->umem, xs);
518 xs->state = XSK_BOUND;
520 mutex_unlock(&xs->mutex);
524 static int xsk_setsockopt(struct socket *sock, int level, int optname,
525 char __user *optval, unsigned int optlen)
527 struct sock *sk = sock->sk;
528 struct xdp_sock *xs = xdp_sk(sk);
531 if (level != SOL_XDP)
538 struct xsk_queue **q;
541 if (optlen < sizeof(entries))
543 if (copy_from_user(&entries, optval, sizeof(entries)))
546 mutex_lock(&xs->mutex);
547 if (xs->state != XSK_READY) {
548 mutex_unlock(&xs->mutex);
551 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
552 err = xsk_init_queue(entries, q, false);
553 mutex_unlock(&xs->mutex);
558 struct xdp_umem_reg mr;
559 struct xdp_umem *umem;
561 if (copy_from_user(&mr, optval, sizeof(mr)))
564 mutex_lock(&xs->mutex);
565 if (xs->state != XSK_READY || xs->umem) {
566 mutex_unlock(&xs->mutex);
570 umem = xdp_umem_create(&mr);
572 mutex_unlock(&xs->mutex);
573 return PTR_ERR(umem);
576 /* Make sure umem is ready before it can be seen by others */
579 mutex_unlock(&xs->mutex);
582 case XDP_UMEM_FILL_RING:
583 case XDP_UMEM_COMPLETION_RING:
585 struct xsk_queue **q;
588 if (copy_from_user(&entries, optval, sizeof(entries)))
591 mutex_lock(&xs->mutex);
592 if (xs->state != XSK_READY) {
593 mutex_unlock(&xs->mutex);
597 mutex_unlock(&xs->mutex);
601 q = (optname == XDP_UMEM_FILL_RING) ? &xs->umem->fq :
603 err = xsk_init_queue(entries, q, true);
604 mutex_unlock(&xs->mutex);
614 static int xsk_getsockopt(struct socket *sock, int level, int optname,
615 char __user *optval, int __user *optlen)
617 struct sock *sk = sock->sk;
618 struct xdp_sock *xs = xdp_sk(sk);
621 if (level != SOL_XDP)
624 if (get_user(len, optlen))
632 struct xdp_statistics stats;
634 if (len < sizeof(stats))
637 mutex_lock(&xs->mutex);
638 stats.rx_dropped = xs->rx_dropped;
639 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
640 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
641 mutex_unlock(&xs->mutex);
643 if (copy_to_user(optval, &stats, sizeof(stats)))
645 if (put_user(sizeof(stats), optlen))
650 case XDP_MMAP_OFFSETS:
652 struct xdp_mmap_offsets off;
654 if (len < sizeof(off))
657 off.rx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
658 off.rx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
659 off.rx.desc = offsetof(struct xdp_rxtx_ring, desc);
660 off.tx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
661 off.tx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
662 off.tx.desc = offsetof(struct xdp_rxtx_ring, desc);
664 off.fr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
665 off.fr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
666 off.fr.desc = offsetof(struct xdp_umem_ring, desc);
667 off.cr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
668 off.cr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
669 off.cr.desc = offsetof(struct xdp_umem_ring, desc);
672 if (copy_to_user(optval, &off, len))
674 if (put_user(len, optlen))
681 struct xdp_options opts = {};
683 if (len < sizeof(opts))
686 mutex_lock(&xs->mutex);
688 opts.flags |= XDP_OPTIONS_ZEROCOPY;
689 mutex_unlock(&xs->mutex);
692 if (copy_to_user(optval, &opts, len))
694 if (put_user(len, optlen))
706 static int xsk_mmap(struct file *file, struct socket *sock,
707 struct vm_area_struct *vma)
709 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
710 unsigned long size = vma->vm_end - vma->vm_start;
711 struct xdp_sock *xs = xdp_sk(sock->sk);
712 struct xsk_queue *q = NULL;
713 struct xdp_umem *umem;
717 if (xs->state != XSK_READY)
720 if (offset == XDP_PGOFF_RX_RING) {
721 q = READ_ONCE(xs->rx);
722 } else if (offset == XDP_PGOFF_TX_RING) {
723 q = READ_ONCE(xs->tx);
725 umem = READ_ONCE(xs->umem);
729 /* Matches the smp_wmb() in XDP_UMEM_REG */
731 if (offset == XDP_UMEM_PGOFF_FILL_RING)
732 q = READ_ONCE(umem->fq);
733 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
734 q = READ_ONCE(umem->cq);
740 /* Matches the smp_wmb() in xsk_init_queue */
742 qpg = virt_to_head_page(q->ring);
743 if (size > (PAGE_SIZE << compound_order(qpg)))
746 pfn = virt_to_phys(q->ring) >> PAGE_SHIFT;
747 return remap_pfn_range(vma, vma->vm_start, pfn,
748 size, vma->vm_page_prot);
751 static int xsk_notifier(struct notifier_block *this,
752 unsigned long msg, void *ptr)
754 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
755 struct net *net = dev_net(dev);
759 case NETDEV_UNREGISTER:
760 mutex_lock(&net->xdp.lock);
761 sk_for_each(sk, &net->xdp.list) {
762 struct xdp_sock *xs = xdp_sk(sk);
764 mutex_lock(&xs->mutex);
765 if (xs->dev == dev) {
766 sk->sk_err = ENETDOWN;
767 if (!sock_flag(sk, SOCK_DEAD))
768 sk->sk_error_report(sk);
772 /* Clear device references in umem. */
773 xdp_umem_clear_dev(xs->umem);
775 mutex_unlock(&xs->mutex);
777 mutex_unlock(&net->xdp.lock);
783 static struct proto xsk_proto = {
785 .owner = THIS_MODULE,
786 .obj_size = sizeof(struct xdp_sock),
789 static const struct proto_ops xsk_proto_ops = {
791 .owner = THIS_MODULE,
792 .release = xsk_release,
794 .connect = sock_no_connect,
795 .socketpair = sock_no_socketpair,
796 .accept = sock_no_accept,
797 .getname = sock_no_getname,
799 .ioctl = sock_no_ioctl,
800 .listen = sock_no_listen,
801 .shutdown = sock_no_shutdown,
802 .setsockopt = xsk_setsockopt,
803 .getsockopt = xsk_getsockopt,
804 .sendmsg = xsk_sendmsg,
805 .recvmsg = sock_no_recvmsg,
807 .sendpage = sock_no_sendpage,
810 static void xsk_destruct(struct sock *sk)
812 struct xdp_sock *xs = xdp_sk(sk);
814 if (!sock_flag(sk, SOCK_DEAD))
817 xdp_put_umem(xs->umem);
819 sk_refcnt_debug_dec(sk);
822 static int xsk_create(struct net *net, struct socket *sock, int protocol,
828 if (!ns_capable(net->user_ns, CAP_NET_RAW))
830 if (sock->type != SOCK_RAW)
831 return -ESOCKTNOSUPPORT;
834 return -EPROTONOSUPPORT;
836 sock->state = SS_UNCONNECTED;
838 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
842 sock->ops = &xsk_proto_ops;
844 sock_init_data(sock, sk);
846 sk->sk_family = PF_XDP;
848 sk->sk_destruct = xsk_destruct;
849 sk_refcnt_debug_inc(sk);
851 sock_set_flag(sk, SOCK_RCU_FREE);
854 xs->state = XSK_READY;
855 mutex_init(&xs->mutex);
856 spin_lock_init(&xs->rx_lock);
857 spin_lock_init(&xs->tx_completion_lock);
859 mutex_lock(&net->xdp.lock);
860 sk_add_node_rcu(sk, &net->xdp.list);
861 mutex_unlock(&net->xdp.lock);
864 sock_prot_inuse_add(net, &xsk_proto, 1);
870 static const struct net_proto_family xsk_family_ops = {
872 .create = xsk_create,
873 .owner = THIS_MODULE,
876 static struct notifier_block xsk_netdev_notifier = {
877 .notifier_call = xsk_notifier,
880 static int __net_init xsk_net_init(struct net *net)
882 mutex_init(&net->xdp.lock);
883 INIT_HLIST_HEAD(&net->xdp.list);
887 static void __net_exit xsk_net_exit(struct net *net)
889 WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
892 static struct pernet_operations xsk_net_ops = {
893 .init = xsk_net_init,
894 .exit = xsk_net_exit,
897 static int __init xsk_init(void)
901 err = proto_register(&xsk_proto, 0 /* no slab */);
905 err = sock_register(&xsk_family_ops);
909 err = register_pernet_subsys(&xsk_net_ops);
913 err = register_netdevice_notifier(&xsk_netdev_notifier);
920 unregister_pernet_subsys(&xsk_net_ops);
922 sock_unregister(PF_XDP);
924 proto_unregister(&xsk_proto);
929 fs_initcall(xsk_init);