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"
31 #define TX_BATCH_SIZE 16
33 static struct xdp_sock *xdp_sk(struct sock *sk)
35 return (struct xdp_sock *)sk;
38 bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs)
40 return READ_ONCE(xs->rx) && READ_ONCE(xs->umem) &&
41 READ_ONCE(xs->umem->fq);
44 u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr)
46 return xskq_peek_addr(umem->fq, addr);
48 EXPORT_SYMBOL(xsk_umem_peek_addr);
50 void xsk_umem_discard_addr(struct xdp_umem *umem)
52 xskq_discard_addr(umem->fq);
54 EXPORT_SYMBOL(xsk_umem_discard_addr);
56 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
62 if (!xskq_peek_addr(xs->umem->fq, &addr) ||
63 len > xs->umem->chunk_size_nohr) {
68 addr += xs->umem->headroom;
70 buffer = xdp_umem_get_data(xs->umem, addr);
71 memcpy(buffer, xdp->data, len);
72 err = xskq_produce_batch_desc(xs->rx, addr, len);
74 xskq_discard_addr(xs->umem->fq);
83 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
85 int err = xskq_produce_batch_desc(xs->rx, (u64)xdp->handle, len);
93 int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
97 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
100 len = xdp->data_end - xdp->data;
102 return (xdp->rxq->mem.type == MEM_TYPE_ZERO_COPY) ?
103 __xsk_rcv_zc(xs, xdp, len) : __xsk_rcv(xs, xdp, len);
106 void xsk_flush(struct xdp_sock *xs)
108 xskq_produce_flush_desc(xs->rx);
109 xs->sk.sk_data_ready(&xs->sk);
112 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
114 u32 len = xdp->data_end - xdp->data;
119 if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
122 if (!xskq_peek_addr(xs->umem->fq, &addr) ||
123 len > xs->umem->chunk_size_nohr) {
128 addr += xs->umem->headroom;
130 buffer = xdp_umem_get_data(xs->umem, addr);
131 memcpy(buffer, xdp->data, len);
132 err = xskq_produce_batch_desc(xs->rx, addr, len);
134 xskq_discard_addr(xs->umem->fq);
143 void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries)
145 xskq_produce_flush_addr_n(umem->cq, nb_entries);
147 EXPORT_SYMBOL(xsk_umem_complete_tx);
149 void xsk_umem_consume_tx_done(struct xdp_umem *umem)
154 list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
155 xs->sk.sk_write_space(&xs->sk);
159 EXPORT_SYMBOL(xsk_umem_consume_tx_done);
161 bool xsk_umem_consume_tx(struct xdp_umem *umem, dma_addr_t *dma, u32 *len)
163 struct xdp_desc desc;
167 list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
168 if (!xskq_peek_desc(xs->tx, &desc))
171 if (xskq_produce_addr_lazy(umem->cq, desc.addr))
174 *dma = xdp_umem_get_dma(umem, desc.addr);
177 xskq_discard_desc(xs->tx);
186 EXPORT_SYMBOL(xsk_umem_consume_tx);
188 static int xsk_zc_xmit(struct sock *sk)
190 struct xdp_sock *xs = xdp_sk(sk);
191 struct net_device *dev = xs->dev;
193 return dev->netdev_ops->ndo_xsk_async_xmit(dev, xs->queue_id);
196 static void xsk_destruct_skb(struct sk_buff *skb)
198 u64 addr = (u64)(long)skb_shinfo(skb)->destructor_arg;
199 struct xdp_sock *xs = xdp_sk(skb->sk);
202 spin_lock_irqsave(&xs->tx_completion_lock, flags);
203 WARN_ON_ONCE(xskq_produce_addr(xs->umem->cq, addr));
204 spin_unlock_irqrestore(&xs->tx_completion_lock, flags);
209 static int xsk_generic_xmit(struct sock *sk, struct msghdr *m,
212 u32 max_batch = TX_BATCH_SIZE;
213 struct xdp_sock *xs = xdp_sk(sk);
214 bool sent_frame = false;
215 struct xdp_desc desc;
219 mutex_lock(&xs->mutex);
221 while (xskq_peek_desc(xs->tx, &desc)) {
226 if (max_batch-- == 0) {
231 if (xskq_reserve_addr(xs->umem->cq))
234 if (xs->queue_id >= xs->dev->real_num_tx_queues)
238 skb = sock_alloc_send_skb(sk, len, 1, &err);
239 if (unlikely(!skb)) {
246 buffer = xdp_umem_get_data(xs->umem, addr);
247 err = skb_store_bits(skb, 0, buffer, len);
254 skb->priority = sk->sk_priority;
255 skb->mark = sk->sk_mark;
256 skb_shinfo(skb)->destructor_arg = (void *)(long)addr;
257 skb->destructor = xsk_destruct_skb;
259 err = dev_direct_xmit(skb, xs->queue_id);
260 xskq_discard_desc(xs->tx);
261 /* Ignore NET_XMIT_CN as packet might have been sent */
262 if (err == NET_XMIT_DROP || err == NETDEV_TX_BUSY) {
263 /* SKB completed but not sent */
273 sk->sk_write_space(sk);
275 mutex_unlock(&xs->mutex);
279 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
281 bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
282 struct sock *sk = sock->sk;
283 struct xdp_sock *xs = xdp_sk(sk);
285 if (unlikely(!xs->dev))
287 if (unlikely(!(xs->dev->flags & IFF_UP)))
289 if (unlikely(!xs->tx))
294 return (xs->zc) ? xsk_zc_xmit(sk) : xsk_generic_xmit(sk, m, total_len);
297 static unsigned int xsk_poll(struct file *file, struct socket *sock,
298 struct poll_table_struct *wait)
300 unsigned int mask = datagram_poll(file, sock, wait);
301 struct sock *sk = sock->sk;
302 struct xdp_sock *xs = xdp_sk(sk);
304 if (xs->rx && !xskq_empty_desc(xs->rx))
305 mask |= POLLIN | POLLRDNORM;
306 if (xs->tx && !xskq_full_desc(xs->tx))
307 mask |= POLLOUT | POLLWRNORM;
312 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
317 if (entries == 0 || *queue || !is_power_of_2(entries))
320 q = xskq_create(entries, umem_queue);
324 /* Make sure queue is ready before it can be seen by others */
330 static int xsk_release(struct socket *sock)
332 struct sock *sk = sock->sk;
333 struct xdp_sock *xs = xdp_sk(sk);
342 sock_prot_inuse_add(net, sk->sk_prot, -1);
346 /* Wait for driver to stop using the xdp socket. */
355 sk_refcnt_debug_release(sk);
361 static struct socket *xsk_lookup_xsk_from_fd(int fd)
366 sock = sockfd_lookup(fd, &err);
368 return ERR_PTR(-ENOTSOCK);
370 if (sock->sk->sk_family != PF_XDP) {
372 return ERR_PTR(-ENOPROTOOPT);
378 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
380 struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
381 struct sock *sk = sock->sk;
382 struct xdp_sock *xs = xdp_sk(sk);
383 struct net_device *dev;
387 if (addr_len < sizeof(struct sockaddr_xdp))
389 if (sxdp->sxdp_family != AF_XDP)
392 mutex_lock(&xs->mutex);
398 dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
404 if (!xs->rx && !xs->tx) {
409 qid = sxdp->sxdp_queue_id;
411 if ((xs->rx && qid >= dev->real_num_rx_queues) ||
412 (xs->tx && qid >= dev->real_num_tx_queues)) {
417 flags = sxdp->sxdp_flags;
419 if (flags & XDP_SHARED_UMEM) {
420 struct xdp_sock *umem_xs;
423 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY)) {
424 /* Cannot specify flags for shared sockets. */
430 /* We have already our own. */
435 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
441 umem_xs = xdp_sk(sock->sk);
442 if (!umem_xs->umem) {
443 /* No umem to inherit. */
447 } else if (umem_xs->dev != dev || umem_xs->queue_id != qid) {
453 xdp_get_umem(umem_xs->umem);
454 xs->umem = umem_xs->umem;
456 } else if (!xs->umem || !xdp_umem_validate_queues(xs->umem)) {
460 /* This xsk has its own umem. */
461 xskq_set_umem(xs->umem->fq, &xs->umem->props);
462 xskq_set_umem(xs->umem->cq, &xs->umem->props);
464 err = xdp_umem_assign_dev(xs->umem, dev, qid, flags);
470 xs->zc = xs->umem->zc;
472 xskq_set_umem(xs->rx, &xs->umem->props);
473 xskq_set_umem(xs->tx, &xs->umem->props);
474 xdp_add_sk_umem(xs->umem, xs);
480 mutex_unlock(&xs->mutex);
484 static int xsk_setsockopt(struct socket *sock, int level, int optname,
485 char __user *optval, unsigned int optlen)
487 struct sock *sk = sock->sk;
488 struct xdp_sock *xs = xdp_sk(sk);
491 if (level != SOL_XDP)
498 struct xsk_queue **q;
501 if (optlen < sizeof(entries))
503 if (copy_from_user(&entries, optval, sizeof(entries)))
506 mutex_lock(&xs->mutex);
507 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
508 err = xsk_init_queue(entries, q, false);
509 mutex_unlock(&xs->mutex);
514 struct xdp_umem_reg mr;
515 struct xdp_umem *umem;
517 if (copy_from_user(&mr, optval, sizeof(mr)))
520 mutex_lock(&xs->mutex);
522 mutex_unlock(&xs->mutex);
526 umem = xdp_umem_create(&mr);
528 mutex_unlock(&xs->mutex);
529 return PTR_ERR(umem);
532 /* Make sure umem is ready before it can be seen by others */
535 mutex_unlock(&xs->mutex);
538 case XDP_UMEM_FILL_RING:
539 case XDP_UMEM_COMPLETION_RING:
541 struct xsk_queue **q;
544 if (copy_from_user(&entries, optval, sizeof(entries)))
547 mutex_lock(&xs->mutex);
549 mutex_unlock(&xs->mutex);
553 q = (optname == XDP_UMEM_FILL_RING) ? &xs->umem->fq :
555 err = xsk_init_queue(entries, q, true);
556 mutex_unlock(&xs->mutex);
566 static int xsk_getsockopt(struct socket *sock, int level, int optname,
567 char __user *optval, int __user *optlen)
569 struct sock *sk = sock->sk;
570 struct xdp_sock *xs = xdp_sk(sk);
573 if (level != SOL_XDP)
576 if (get_user(len, optlen))
584 struct xdp_statistics stats;
586 if (len < sizeof(stats))
589 mutex_lock(&xs->mutex);
590 stats.rx_dropped = xs->rx_dropped;
591 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
592 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
593 mutex_unlock(&xs->mutex);
595 if (copy_to_user(optval, &stats, sizeof(stats)))
597 if (put_user(sizeof(stats), optlen))
602 case XDP_MMAP_OFFSETS:
604 struct xdp_mmap_offsets off;
606 if (len < sizeof(off))
609 off.rx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
610 off.rx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
611 off.rx.desc = offsetof(struct xdp_rxtx_ring, desc);
612 off.tx.producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
613 off.tx.consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
614 off.tx.desc = offsetof(struct xdp_rxtx_ring, desc);
616 off.fr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
617 off.fr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
618 off.fr.desc = offsetof(struct xdp_umem_ring, desc);
619 off.cr.producer = offsetof(struct xdp_umem_ring, ptrs.producer);
620 off.cr.consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
621 off.cr.desc = offsetof(struct xdp_umem_ring, desc);
624 if (copy_to_user(optval, &off, len))
626 if (put_user(len, optlen))
638 static int xsk_mmap(struct file *file, struct socket *sock,
639 struct vm_area_struct *vma)
641 loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
642 unsigned long size = vma->vm_end - vma->vm_start;
643 struct xdp_sock *xs = xdp_sk(sock->sk);
644 struct xsk_queue *q = NULL;
645 struct xdp_umem *umem;
649 if (offset == XDP_PGOFF_RX_RING) {
650 q = READ_ONCE(xs->rx);
651 } else if (offset == XDP_PGOFF_TX_RING) {
652 q = READ_ONCE(xs->tx);
654 umem = READ_ONCE(xs->umem);
658 if (offset == XDP_UMEM_PGOFF_FILL_RING)
659 q = READ_ONCE(umem->fq);
660 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
661 q = READ_ONCE(umem->cq);
667 qpg = virt_to_head_page(q->ring);
668 if (size > (PAGE_SIZE << compound_order(qpg)))
671 pfn = virt_to_phys(q->ring) >> PAGE_SHIFT;
672 return remap_pfn_range(vma, vma->vm_start, pfn,
673 size, vma->vm_page_prot);
676 static struct proto xsk_proto = {
678 .owner = THIS_MODULE,
679 .obj_size = sizeof(struct xdp_sock),
682 static const struct proto_ops xsk_proto_ops = {
684 .owner = THIS_MODULE,
685 .release = xsk_release,
687 .connect = sock_no_connect,
688 .socketpair = sock_no_socketpair,
689 .accept = sock_no_accept,
690 .getname = sock_no_getname,
692 .ioctl = sock_no_ioctl,
693 .listen = sock_no_listen,
694 .shutdown = sock_no_shutdown,
695 .setsockopt = xsk_setsockopt,
696 .getsockopt = xsk_getsockopt,
697 .sendmsg = xsk_sendmsg,
698 .recvmsg = sock_no_recvmsg,
700 .sendpage = sock_no_sendpage,
703 static void xsk_destruct(struct sock *sk)
705 struct xdp_sock *xs = xdp_sk(sk);
707 if (!sock_flag(sk, SOCK_DEAD))
710 xskq_destroy(xs->rx);
711 xskq_destroy(xs->tx);
712 xdp_del_sk_umem(xs->umem, xs);
713 xdp_put_umem(xs->umem);
715 sk_refcnt_debug_dec(sk);
718 static int xsk_create(struct net *net, struct socket *sock, int protocol,
724 if (!ns_capable(net->user_ns, CAP_NET_RAW))
726 if (sock->type != SOCK_RAW)
727 return -ESOCKTNOSUPPORT;
730 return -EPROTONOSUPPORT;
732 sock->state = SS_UNCONNECTED;
734 sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
738 sock->ops = &xsk_proto_ops;
740 sock_init_data(sock, sk);
742 sk->sk_family = PF_XDP;
744 sk->sk_destruct = xsk_destruct;
745 sk_refcnt_debug_inc(sk);
748 mutex_init(&xs->mutex);
749 spin_lock_init(&xs->tx_completion_lock);
752 sock_prot_inuse_add(net, &xsk_proto, 1);
758 static const struct net_proto_family xsk_family_ops = {
760 .create = xsk_create,
761 .owner = THIS_MODULE,
764 static int __init xsk_init(void)
768 err = proto_register(&xsk_proto, 0 /* no slab */);
772 err = sock_register(&xsk_family_ops);
779 proto_unregister(&xsk_proto);
784 fs_initcall(xsk_init);