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 <net/xdp_sock_drv.h>
28 #include "xsk_queue.h"
32 #define TX_BATCH_SIZE 16
34 static DEFINE_PER_CPU(struct list_head
, xskmap_flush_list
);
36 bool xsk_is_setup_for_bpf_map(struct xdp_sock
*xs
)
38 return READ_ONCE(xs
->rx
) && READ_ONCE(xs
->umem
) &&
39 (xs
->pool
->fq
|| READ_ONCE(xs
->fq_tmp
));
42 void xsk_set_rx_need_wakeup(struct xsk_buff_pool
*pool
)
44 if (pool
->cached_need_wakeup
& XDP_WAKEUP_RX
)
47 pool
->fq
->ring
->flags
|= XDP_RING_NEED_WAKEUP
;
48 pool
->cached_need_wakeup
|= XDP_WAKEUP_RX
;
50 EXPORT_SYMBOL(xsk_set_rx_need_wakeup
);
52 void xsk_set_tx_need_wakeup(struct xsk_buff_pool
*pool
)
54 struct xdp_umem
*umem
= pool
->umem
;
57 if (pool
->cached_need_wakeup
& XDP_WAKEUP_TX
)
61 list_for_each_entry_rcu(xs
, &umem
->xsk_tx_list
, list
) {
62 xs
->tx
->ring
->flags
|= XDP_RING_NEED_WAKEUP
;
66 pool
->cached_need_wakeup
|= XDP_WAKEUP_TX
;
68 EXPORT_SYMBOL(xsk_set_tx_need_wakeup
);
70 void xsk_clear_rx_need_wakeup(struct xsk_buff_pool
*pool
)
72 if (!(pool
->cached_need_wakeup
& XDP_WAKEUP_RX
))
75 pool
->fq
->ring
->flags
&= ~XDP_RING_NEED_WAKEUP
;
76 pool
->cached_need_wakeup
&= ~XDP_WAKEUP_RX
;
78 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup
);
80 void xsk_clear_tx_need_wakeup(struct xsk_buff_pool
*pool
)
82 struct xdp_umem
*umem
= pool
->umem
;
85 if (!(pool
->cached_need_wakeup
& XDP_WAKEUP_TX
))
89 list_for_each_entry_rcu(xs
, &umem
->xsk_tx_list
, list
) {
90 xs
->tx
->ring
->flags
&= ~XDP_RING_NEED_WAKEUP
;
94 pool
->cached_need_wakeup
&= ~XDP_WAKEUP_TX
;
96 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup
);
98 bool xsk_uses_need_wakeup(struct xsk_buff_pool
*pool
)
100 return pool
->uses_need_wakeup
;
102 EXPORT_SYMBOL(xsk_uses_need_wakeup
);
104 struct xsk_buff_pool
*xsk_get_pool_from_qid(struct net_device
*dev
,
107 if (queue_id
< dev
->real_num_rx_queues
)
108 return dev
->_rx
[queue_id
].pool
;
109 if (queue_id
< dev
->real_num_tx_queues
)
110 return dev
->_tx
[queue_id
].pool
;
114 EXPORT_SYMBOL(xsk_get_pool_from_qid
);
116 void xsk_clear_pool_at_qid(struct net_device
*dev
, u16 queue_id
)
118 if (queue_id
< dev
->real_num_rx_queues
)
119 dev
->_rx
[queue_id
].pool
= NULL
;
120 if (queue_id
< dev
->real_num_tx_queues
)
121 dev
->_tx
[queue_id
].pool
= NULL
;
124 /* The buffer pool is stored both in the _rx struct and the _tx struct as we do
125 * not know if the device has more tx queues than rx, or the opposite.
126 * This might also change during run time.
128 int xsk_reg_pool_at_qid(struct net_device
*dev
, struct xsk_buff_pool
*pool
,
131 if (queue_id
>= max_t(unsigned int,
132 dev
->real_num_rx_queues
,
133 dev
->real_num_tx_queues
))
136 if (queue_id
< dev
->real_num_rx_queues
)
137 dev
->_rx
[queue_id
].pool
= pool
;
138 if (queue_id
< dev
->real_num_tx_queues
)
139 dev
->_tx
[queue_id
].pool
= pool
;
144 void xp_release(struct xdp_buff_xsk
*xskb
)
146 xskb
->pool
->free_heads
[xskb
->pool
->free_heads_cnt
++] = xskb
;
149 static u64
xp_get_handle(struct xdp_buff_xsk
*xskb
)
151 u64 offset
= xskb
->xdp
.data
- xskb
->xdp
.data_hard_start
;
153 offset
+= xskb
->pool
->headroom
;
154 if (!xskb
->pool
->unaligned
)
155 return xskb
->orig_addr
+ offset
;
156 return xskb
->orig_addr
+ (offset
<< XSK_UNALIGNED_BUF_OFFSET_SHIFT
);
159 static int __xsk_rcv_zc(struct xdp_sock
*xs
, struct xdp_buff
*xdp
, u32 len
)
161 struct xdp_buff_xsk
*xskb
= container_of(xdp
, struct xdp_buff_xsk
, xdp
);
165 addr
= xp_get_handle(xskb
);
166 err
= xskq_prod_reserve_desc(xs
->rx
, addr
, len
);
176 static void xsk_copy_xdp(struct xdp_buff
*to
, struct xdp_buff
*from
, u32 len
)
178 void *from_buf
, *to_buf
;
181 if (unlikely(xdp_data_meta_unsupported(from
))) {
182 from_buf
= from
->data
;
186 from_buf
= from
->data_meta
;
187 metalen
= from
->data
- from
->data_meta
;
188 to_buf
= to
->data
- metalen
;
191 memcpy(to_buf
, from_buf
, len
+ metalen
);
194 static int __xsk_rcv(struct xdp_sock
*xs
, struct xdp_buff
*xdp
, u32 len
,
197 struct xdp_buff
*xsk_xdp
;
200 if (len
> xsk_pool_get_rx_frame_size(xs
->pool
)) {
205 xsk_xdp
= xsk_buff_alloc(xs
->pool
);
211 xsk_copy_xdp(xsk_xdp
, xdp
, len
);
212 err
= __xsk_rcv_zc(xs
, xsk_xdp
, len
);
214 xsk_buff_free(xsk_xdp
);
218 xdp_return_buff(xdp
);
222 static bool xsk_is_bound(struct xdp_sock
*xs
)
224 if (READ_ONCE(xs
->state
) == XSK_BOUND
) {
225 /* Matches smp_wmb() in bind(). */
232 static int xsk_rcv(struct xdp_sock
*xs
, struct xdp_buff
*xdp
,
237 if (!xsk_is_bound(xs
))
240 if (xs
->dev
!= xdp
->rxq
->dev
|| xs
->queue_id
!= xdp
->rxq
->queue_index
)
243 len
= xdp
->data_end
- xdp
->data
;
245 return xdp
->rxq
->mem
.type
== MEM_TYPE_XSK_BUFF_POOL
?
246 __xsk_rcv_zc(xs
, xdp
, len
) :
247 __xsk_rcv(xs
, xdp
, len
, explicit_free
);
250 static void xsk_flush(struct xdp_sock
*xs
)
252 xskq_prod_submit(xs
->rx
);
253 __xskq_cons_release(xs
->pool
->fq
);
254 sock_def_readable(&xs
->sk
);
257 int xsk_generic_rcv(struct xdp_sock
*xs
, struct xdp_buff
*xdp
)
261 spin_lock_bh(&xs
->rx_lock
);
262 err
= xsk_rcv(xs
, xdp
, false);
264 spin_unlock_bh(&xs
->rx_lock
);
268 int __xsk_map_redirect(struct xdp_sock
*xs
, struct xdp_buff
*xdp
)
270 struct list_head
*flush_list
= this_cpu_ptr(&xskmap_flush_list
);
273 err
= xsk_rcv(xs
, xdp
, true);
277 if (!xs
->flush_node
.prev
)
278 list_add(&xs
->flush_node
, flush_list
);
283 void __xsk_map_flush(void)
285 struct list_head
*flush_list
= this_cpu_ptr(&xskmap_flush_list
);
286 struct xdp_sock
*xs
, *tmp
;
288 list_for_each_entry_safe(xs
, tmp
, flush_list
, flush_node
) {
290 __list_del_clearprev(&xs
->flush_node
);
294 void xsk_tx_completed(struct xsk_buff_pool
*pool
, u32 nb_entries
)
296 xskq_prod_submit_n(pool
->cq
, nb_entries
);
298 EXPORT_SYMBOL(xsk_tx_completed
);
300 void xsk_tx_release(struct xsk_buff_pool
*pool
)
305 list_for_each_entry_rcu(xs
, &pool
->umem
->xsk_tx_list
, list
) {
306 __xskq_cons_release(xs
->tx
);
307 xs
->sk
.sk_write_space(&xs
->sk
);
311 EXPORT_SYMBOL(xsk_tx_release
);
313 bool xsk_tx_peek_desc(struct xsk_buff_pool
*pool
, struct xdp_desc
*desc
)
315 struct xdp_umem
*umem
= pool
->umem
;
319 list_for_each_entry_rcu(xs
, &umem
->xsk_tx_list
, list
) {
320 if (!xskq_cons_peek_desc(xs
->tx
, desc
, pool
)) {
321 xs
->tx
->queue_empty_descs
++;
325 /* This is the backpressure mechanism for the Tx path.
326 * Reserve space in the completion queue and only proceed
327 * if there is space in it. This avoids having to implement
328 * any buffering in the Tx path.
330 if (xskq_prod_reserve_addr(pool
->cq
, desc
->addr
))
333 xskq_cons_release(xs
->tx
);
342 EXPORT_SYMBOL(xsk_tx_peek_desc
);
344 static int xsk_wakeup(struct xdp_sock
*xs
, u8 flags
)
346 struct net_device
*dev
= xs
->dev
;
350 err
= dev
->netdev_ops
->ndo_xsk_wakeup(dev
, xs
->queue_id
, flags
);
356 static int xsk_zc_xmit(struct xdp_sock
*xs
)
358 return xsk_wakeup(xs
, XDP_WAKEUP_TX
);
361 static void xsk_destruct_skb(struct sk_buff
*skb
)
363 u64 addr
= (u64
)(long)skb_shinfo(skb
)->destructor_arg
;
364 struct xdp_sock
*xs
= xdp_sk(skb
->sk
);
367 spin_lock_irqsave(&xs
->tx_completion_lock
, flags
);
368 xskq_prod_submit_addr(xs
->pool
->cq
, addr
);
369 spin_unlock_irqrestore(&xs
->tx_completion_lock
, flags
);
374 static int xsk_generic_xmit(struct sock
*sk
)
376 struct xdp_sock
*xs
= xdp_sk(sk
);
377 u32 max_batch
= TX_BATCH_SIZE
;
378 bool sent_frame
= false;
379 struct xdp_desc desc
;
383 mutex_lock(&xs
->mutex
);
385 if (xs
->queue_id
>= xs
->dev
->real_num_tx_queues
)
388 while (xskq_cons_peek_desc(xs
->tx
, &desc
, xs
->pool
)) {
393 if (max_batch
-- == 0) {
399 skb
= sock_alloc_send_skb(sk
, len
, 1, &err
);
405 buffer
= xsk_buff_raw_get_data(xs
->pool
, addr
);
406 err
= skb_store_bits(skb
, 0, buffer
, len
);
407 /* This is the backpressure mechanism for the Tx path.
408 * Reserve space in the completion queue and only proceed
409 * if there is space in it. This avoids having to implement
410 * any buffering in the Tx path.
412 if (unlikely(err
) || xskq_prod_reserve(xs
->pool
->cq
)) {
418 skb
->priority
= sk
->sk_priority
;
419 skb
->mark
= sk
->sk_mark
;
420 skb_shinfo(skb
)->destructor_arg
= (void *)(long)desc
.addr
;
421 skb
->destructor
= xsk_destruct_skb
;
423 err
= dev_direct_xmit(skb
, xs
->queue_id
);
424 xskq_cons_release(xs
->tx
);
425 /* Ignore NET_XMIT_CN as packet might have been sent */
426 if (err
== NET_XMIT_DROP
|| err
== NETDEV_TX_BUSY
) {
427 /* SKB completed but not sent */
435 xs
->tx
->queue_empty_descs
++;
439 sk
->sk_write_space(sk
);
441 mutex_unlock(&xs
->mutex
);
445 static int __xsk_sendmsg(struct sock
*sk
)
447 struct xdp_sock
*xs
= xdp_sk(sk
);
449 if (unlikely(!(xs
->dev
->flags
& IFF_UP
)))
451 if (unlikely(!xs
->tx
))
454 return xs
->zc
? xsk_zc_xmit(xs
) : xsk_generic_xmit(sk
);
457 static int xsk_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t total_len
)
459 bool need_wait
= !(m
->msg_flags
& MSG_DONTWAIT
);
460 struct sock
*sk
= sock
->sk
;
461 struct xdp_sock
*xs
= xdp_sk(sk
);
463 if (unlikely(!xsk_is_bound(xs
)))
465 if (unlikely(need_wait
))
468 return __xsk_sendmsg(sk
);
471 static __poll_t
xsk_poll(struct file
*file
, struct socket
*sock
,
472 struct poll_table_struct
*wait
)
474 __poll_t mask
= datagram_poll(file
, sock
, wait
);
475 struct sock
*sk
= sock
->sk
;
476 struct xdp_sock
*xs
= xdp_sk(sk
);
477 struct xsk_buff_pool
*pool
;
479 if (unlikely(!xsk_is_bound(xs
)))
484 if (pool
->cached_need_wakeup
) {
486 xsk_wakeup(xs
, pool
->cached_need_wakeup
);
488 /* Poll needs to drive Tx also in copy mode */
492 if (xs
->rx
&& !xskq_prod_is_empty(xs
->rx
))
493 mask
|= EPOLLIN
| EPOLLRDNORM
;
494 if (xs
->tx
&& !xskq_cons_is_full(xs
->tx
))
495 mask
|= EPOLLOUT
| EPOLLWRNORM
;
500 static int xsk_init_queue(u32 entries
, struct xsk_queue
**queue
,
505 if (entries
== 0 || *queue
|| !is_power_of_2(entries
))
508 q
= xskq_create(entries
, umem_queue
);
512 /* Make sure queue is ready before it can be seen by others */
514 WRITE_ONCE(*queue
, q
);
518 static void xsk_unbind_dev(struct xdp_sock
*xs
)
520 struct net_device
*dev
= xs
->dev
;
522 if (xs
->state
!= XSK_BOUND
)
524 WRITE_ONCE(xs
->state
, XSK_UNBOUND
);
526 /* Wait for driver to stop using the xdp socket. */
527 xdp_del_sk_umem(xs
->umem
, xs
);
533 static struct xsk_map
*xsk_get_map_list_entry(struct xdp_sock
*xs
,
534 struct xdp_sock
***map_entry
)
536 struct xsk_map
*map
= NULL
;
537 struct xsk_map_node
*node
;
541 spin_lock_bh(&xs
->map_list_lock
);
542 node
= list_first_entry_or_null(&xs
->map_list
, struct xsk_map_node
,
545 WARN_ON(xsk_map_inc(node
->map
));
547 *map_entry
= node
->map_entry
;
549 spin_unlock_bh(&xs
->map_list_lock
);
553 static void xsk_delete_from_maps(struct xdp_sock
*xs
)
555 /* This function removes the current XDP socket from all the
556 * maps it resides in. We need to take extra care here, due to
557 * the two locks involved. Each map has a lock synchronizing
558 * updates to the entries, and each socket has a lock that
559 * synchronizes access to the list of maps (map_list). For
560 * deadlock avoidance the locks need to be taken in the order
561 * "map lock"->"socket map list lock". We start off by
562 * accessing the socket map list, and take a reference to the
563 * map to guarantee existence between the
564 * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
565 * calls. Then we ask the map to remove the socket, which
566 * tries to remove the socket from the map. Note that there
567 * might be updates to the map between
568 * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
570 struct xdp_sock
**map_entry
= NULL
;
573 while ((map
= xsk_get_map_list_entry(xs
, &map_entry
))) {
574 xsk_map_try_sock_delete(map
, xs
, map_entry
);
579 static int xsk_release(struct socket
*sock
)
581 struct sock
*sk
= sock
->sk
;
582 struct xdp_sock
*xs
= xdp_sk(sk
);
590 mutex_lock(&net
->xdp
.lock
);
591 sk_del_node_init_rcu(sk
);
592 mutex_unlock(&net
->xdp
.lock
);
595 sock_prot_inuse_add(net
, sk
->sk_prot
, -1);
598 xsk_delete_from_maps(xs
);
599 mutex_lock(&xs
->mutex
);
601 mutex_unlock(&xs
->mutex
);
603 xskq_destroy(xs
->rx
);
604 xskq_destroy(xs
->tx
);
605 xskq_destroy(xs
->fq_tmp
);
606 xskq_destroy(xs
->cq_tmp
);
611 sk_refcnt_debug_release(sk
);
617 static struct socket
*xsk_lookup_xsk_from_fd(int fd
)
622 sock
= sockfd_lookup(fd
, &err
);
624 return ERR_PTR(-ENOTSOCK
);
626 if (sock
->sk
->sk_family
!= PF_XDP
) {
628 return ERR_PTR(-ENOPROTOOPT
);
634 static bool xsk_validate_queues(struct xdp_sock
*xs
)
636 return xs
->fq_tmp
&& xs
->cq_tmp
;
639 static int xsk_bind(struct socket
*sock
, struct sockaddr
*addr
, int addr_len
)
641 struct sockaddr_xdp
*sxdp
= (struct sockaddr_xdp
*)addr
;
642 struct sock
*sk
= sock
->sk
;
643 struct xdp_sock
*xs
= xdp_sk(sk
);
644 struct net_device
*dev
;
648 if (addr_len
< sizeof(struct sockaddr_xdp
))
650 if (sxdp
->sxdp_family
!= AF_XDP
)
653 flags
= sxdp
->sxdp_flags
;
654 if (flags
& ~(XDP_SHARED_UMEM
| XDP_COPY
| XDP_ZEROCOPY
|
655 XDP_USE_NEED_WAKEUP
))
659 mutex_lock(&xs
->mutex
);
660 if (xs
->state
!= XSK_READY
) {
665 dev
= dev_get_by_index(sock_net(sk
), sxdp
->sxdp_ifindex
);
671 if (!xs
->rx
&& !xs
->tx
) {
676 qid
= sxdp
->sxdp_queue_id
;
678 if (flags
& XDP_SHARED_UMEM
) {
679 struct xdp_sock
*umem_xs
;
682 if ((flags
& XDP_COPY
) || (flags
& XDP_ZEROCOPY
) ||
683 (flags
& XDP_USE_NEED_WAKEUP
)) {
684 /* Cannot specify flags for shared sockets. */
690 /* We have already our own. */
695 if (xs
->fq_tmp
|| xs
->cq_tmp
) {
696 /* Do not allow setting your own fq or cq. */
701 sock
= xsk_lookup_xsk_from_fd(sxdp
->sxdp_shared_umem_fd
);
707 umem_xs
= xdp_sk(sock
->sk
);
708 if (!xsk_is_bound(umem_xs
)) {
713 if (umem_xs
->dev
!= dev
|| umem_xs
->queue_id
!= qid
) {
719 /* Share the buffer pool with the other socket. */
720 xp_get_pool(umem_xs
->pool
);
721 xs
->pool
= umem_xs
->pool
;
722 xdp_get_umem(umem_xs
->umem
);
723 WRITE_ONCE(xs
->umem
, umem_xs
->umem
);
725 } else if (!xs
->umem
|| !xsk_validate_queues(xs
)) {
729 /* This xsk has its own umem. */
730 xs
->pool
= xp_create_and_assign_umem(xs
, xs
->umem
);
736 err
= xp_assign_dev(xs
->pool
, dev
, qid
, flags
);
738 xp_destroy(xs
->pool
);
745 xs
->zc
= xs
->umem
->zc
;
747 xdp_add_sk_umem(xs
->umem
, xs
);
753 /* Matches smp_rmb() in bind() for shared umem
754 * sockets, and xsk_is_bound().
757 WRITE_ONCE(xs
->state
, XSK_BOUND
);
760 mutex_unlock(&xs
->mutex
);
765 struct xdp_umem_reg_v1
{
766 __u64 addr
; /* Start of packet data area */
767 __u64 len
; /* Length of packet data area */
772 static int xsk_setsockopt(struct socket
*sock
, int level
, int optname
,
773 sockptr_t optval
, unsigned int optlen
)
775 struct sock
*sk
= sock
->sk
;
776 struct xdp_sock
*xs
= xdp_sk(sk
);
779 if (level
!= SOL_XDP
)
786 struct xsk_queue
**q
;
789 if (optlen
< sizeof(entries
))
791 if (copy_from_sockptr(&entries
, optval
, sizeof(entries
)))
794 mutex_lock(&xs
->mutex
);
795 if (xs
->state
!= XSK_READY
) {
796 mutex_unlock(&xs
->mutex
);
799 q
= (optname
== XDP_TX_RING
) ? &xs
->tx
: &xs
->rx
;
800 err
= xsk_init_queue(entries
, q
, false);
801 if (!err
&& optname
== XDP_TX_RING
)
802 /* Tx needs to be explicitly woken up the first time */
803 xs
->tx
->ring
->flags
|= XDP_RING_NEED_WAKEUP
;
804 mutex_unlock(&xs
->mutex
);
809 size_t mr_size
= sizeof(struct xdp_umem_reg
);
810 struct xdp_umem_reg mr
= {};
811 struct xdp_umem
*umem
;
813 if (optlen
< sizeof(struct xdp_umem_reg_v1
))
815 else if (optlen
< sizeof(mr
))
816 mr_size
= sizeof(struct xdp_umem_reg_v1
);
818 if (copy_from_sockptr(&mr
, optval
, mr_size
))
821 mutex_lock(&xs
->mutex
);
822 if (xs
->state
!= XSK_READY
|| xs
->umem
) {
823 mutex_unlock(&xs
->mutex
);
827 umem
= xdp_umem_create(&mr
);
829 mutex_unlock(&xs
->mutex
);
830 return PTR_ERR(umem
);
833 /* Make sure umem is ready before it can be seen by others */
835 WRITE_ONCE(xs
->umem
, umem
);
836 mutex_unlock(&xs
->mutex
);
839 case XDP_UMEM_FILL_RING
:
840 case XDP_UMEM_COMPLETION_RING
:
842 struct xsk_queue
**q
;
845 if (copy_from_sockptr(&entries
, optval
, sizeof(entries
)))
848 mutex_lock(&xs
->mutex
);
849 if (xs
->state
!= XSK_READY
) {
850 mutex_unlock(&xs
->mutex
);
854 mutex_unlock(&xs
->mutex
);
858 q
= (optname
== XDP_UMEM_FILL_RING
) ? &xs
->fq_tmp
:
860 err
= xsk_init_queue(entries
, q
, true);
861 mutex_unlock(&xs
->mutex
);
871 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1
*ring
)
873 ring
->producer
= offsetof(struct xdp_rxtx_ring
, ptrs
.producer
);
874 ring
->consumer
= offsetof(struct xdp_rxtx_ring
, ptrs
.consumer
);
875 ring
->desc
= offsetof(struct xdp_rxtx_ring
, desc
);
878 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1
*ring
)
880 ring
->producer
= offsetof(struct xdp_umem_ring
, ptrs
.producer
);
881 ring
->consumer
= offsetof(struct xdp_umem_ring
, ptrs
.consumer
);
882 ring
->desc
= offsetof(struct xdp_umem_ring
, desc
);
885 struct xdp_statistics_v1
{
887 __u64 rx_invalid_descs
;
888 __u64 tx_invalid_descs
;
891 static int xsk_getsockopt(struct socket
*sock
, int level
, int optname
,
892 char __user
*optval
, int __user
*optlen
)
894 struct sock
*sk
= sock
->sk
;
895 struct xdp_sock
*xs
= xdp_sk(sk
);
898 if (level
!= SOL_XDP
)
901 if (get_user(len
, optlen
))
909 struct xdp_statistics stats
= {};
910 bool extra_stats
= true;
913 if (len
< sizeof(struct xdp_statistics_v1
)) {
915 } else if (len
< sizeof(stats
)) {
917 stats_size
= sizeof(struct xdp_statistics_v1
);
919 stats_size
= sizeof(stats
);
922 mutex_lock(&xs
->mutex
);
923 stats
.rx_dropped
= xs
->rx_dropped
;
925 stats
.rx_ring_full
= xs
->rx_queue_full
;
926 stats
.rx_fill_ring_empty_descs
=
927 xs
->pool
? xskq_nb_queue_empty_descs(xs
->pool
->fq
) : 0;
928 stats
.tx_ring_empty_descs
= xskq_nb_queue_empty_descs(xs
->tx
);
930 stats
.rx_dropped
+= xs
->rx_queue_full
;
932 stats
.rx_invalid_descs
= xskq_nb_invalid_descs(xs
->rx
);
933 stats
.tx_invalid_descs
= xskq_nb_invalid_descs(xs
->tx
);
934 mutex_unlock(&xs
->mutex
);
936 if (copy_to_user(optval
, &stats
, stats_size
))
938 if (put_user(stats_size
, optlen
))
943 case XDP_MMAP_OFFSETS
:
945 struct xdp_mmap_offsets off
;
946 struct xdp_mmap_offsets_v1 off_v1
;
947 bool flags_supported
= true;
950 if (len
< sizeof(off_v1
))
952 else if (len
< sizeof(off
))
953 flags_supported
= false;
955 if (flags_supported
) {
956 /* xdp_ring_offset is identical to xdp_ring_offset_v1
957 * except for the flags field added to the end.
959 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1
*)
961 xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1
*)
963 xsk_enter_umem_offsets((struct xdp_ring_offset_v1
*)
965 xsk_enter_umem_offsets((struct xdp_ring_offset_v1
*)
967 off
.rx
.flags
= offsetof(struct xdp_rxtx_ring
,
969 off
.tx
.flags
= offsetof(struct xdp_rxtx_ring
,
971 off
.fr
.flags
= offsetof(struct xdp_umem_ring
,
973 off
.cr
.flags
= offsetof(struct xdp_umem_ring
,
979 xsk_enter_rxtx_offsets(&off_v1
.rx
);
980 xsk_enter_rxtx_offsets(&off_v1
.tx
);
981 xsk_enter_umem_offsets(&off_v1
.fr
);
982 xsk_enter_umem_offsets(&off_v1
.cr
);
984 len
= sizeof(off_v1
);
988 if (copy_to_user(optval
, to_copy
, len
))
990 if (put_user(len
, optlen
))
997 struct xdp_options opts
= {};
999 if (len
< sizeof(opts
))
1002 mutex_lock(&xs
->mutex
);
1004 opts
.flags
|= XDP_OPTIONS_ZEROCOPY
;
1005 mutex_unlock(&xs
->mutex
);
1008 if (copy_to_user(optval
, &opts
, len
))
1010 if (put_user(len
, optlen
))
1022 static int xsk_mmap(struct file
*file
, struct socket
*sock
,
1023 struct vm_area_struct
*vma
)
1025 loff_t offset
= (loff_t
)vma
->vm_pgoff
<< PAGE_SHIFT
;
1026 unsigned long size
= vma
->vm_end
- vma
->vm_start
;
1027 struct xdp_sock
*xs
= xdp_sk(sock
->sk
);
1028 struct xsk_queue
*q
= NULL
;
1032 if (READ_ONCE(xs
->state
) != XSK_READY
)
1035 if (offset
== XDP_PGOFF_RX_RING
) {
1036 q
= READ_ONCE(xs
->rx
);
1037 } else if (offset
== XDP_PGOFF_TX_RING
) {
1038 q
= READ_ONCE(xs
->tx
);
1040 /* Matches the smp_wmb() in XDP_UMEM_REG */
1042 if (offset
== XDP_UMEM_PGOFF_FILL_RING
)
1043 q
= READ_ONCE(xs
->fq_tmp
);
1044 else if (offset
== XDP_UMEM_PGOFF_COMPLETION_RING
)
1045 q
= READ_ONCE(xs
->cq_tmp
);
1051 /* Matches the smp_wmb() in xsk_init_queue */
1053 qpg
= virt_to_head_page(q
->ring
);
1054 if (size
> page_size(qpg
))
1057 pfn
= virt_to_phys(q
->ring
) >> PAGE_SHIFT
;
1058 return remap_pfn_range(vma
, vma
->vm_start
, pfn
,
1059 size
, vma
->vm_page_prot
);
1062 static int xsk_notifier(struct notifier_block
*this,
1063 unsigned long msg
, void *ptr
)
1065 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
1066 struct net
*net
= dev_net(dev
);
1070 case NETDEV_UNREGISTER
:
1071 mutex_lock(&net
->xdp
.lock
);
1072 sk_for_each(sk
, &net
->xdp
.list
) {
1073 struct xdp_sock
*xs
= xdp_sk(sk
);
1075 mutex_lock(&xs
->mutex
);
1076 if (xs
->dev
== dev
) {
1077 sk
->sk_err
= ENETDOWN
;
1078 if (!sock_flag(sk
, SOCK_DEAD
))
1079 sk
->sk_error_report(sk
);
1083 /* Clear device references. */
1084 xp_clear_dev(xs
->pool
);
1086 mutex_unlock(&xs
->mutex
);
1088 mutex_unlock(&net
->xdp
.lock
);
1094 static struct proto xsk_proto
= {
1096 .owner
= THIS_MODULE
,
1097 .obj_size
= sizeof(struct xdp_sock
),
1100 static const struct proto_ops xsk_proto_ops
= {
1102 .owner
= THIS_MODULE
,
1103 .release
= xsk_release
,
1105 .connect
= sock_no_connect
,
1106 .socketpair
= sock_no_socketpair
,
1107 .accept
= sock_no_accept
,
1108 .getname
= sock_no_getname
,
1110 .ioctl
= sock_no_ioctl
,
1111 .listen
= sock_no_listen
,
1112 .shutdown
= sock_no_shutdown
,
1113 .setsockopt
= xsk_setsockopt
,
1114 .getsockopt
= xsk_getsockopt
,
1115 .sendmsg
= xsk_sendmsg
,
1116 .recvmsg
= sock_no_recvmsg
,
1118 .sendpage
= sock_no_sendpage
,
1121 static void xsk_destruct(struct sock
*sk
)
1123 struct xdp_sock
*xs
= xdp_sk(sk
);
1125 if (!sock_flag(sk
, SOCK_DEAD
))
1128 xp_put_pool(xs
->pool
);
1130 sk_refcnt_debug_dec(sk
);
1133 static int xsk_create(struct net
*net
, struct socket
*sock
, int protocol
,
1136 struct xdp_sock
*xs
;
1139 if (!ns_capable(net
->user_ns
, CAP_NET_RAW
))
1141 if (sock
->type
!= SOCK_RAW
)
1142 return -ESOCKTNOSUPPORT
;
1145 return -EPROTONOSUPPORT
;
1147 sock
->state
= SS_UNCONNECTED
;
1149 sk
= sk_alloc(net
, PF_XDP
, GFP_KERNEL
, &xsk_proto
, kern
);
1153 sock
->ops
= &xsk_proto_ops
;
1155 sock_init_data(sock
, sk
);
1157 sk
->sk_family
= PF_XDP
;
1159 sk
->sk_destruct
= xsk_destruct
;
1160 sk_refcnt_debug_inc(sk
);
1162 sock_set_flag(sk
, SOCK_RCU_FREE
);
1165 xs
->state
= XSK_READY
;
1166 mutex_init(&xs
->mutex
);
1167 spin_lock_init(&xs
->rx_lock
);
1168 spin_lock_init(&xs
->tx_completion_lock
);
1170 INIT_LIST_HEAD(&xs
->map_list
);
1171 spin_lock_init(&xs
->map_list_lock
);
1173 mutex_lock(&net
->xdp
.lock
);
1174 sk_add_node_rcu(sk
, &net
->xdp
.list
);
1175 mutex_unlock(&net
->xdp
.lock
);
1178 sock_prot_inuse_add(net
, &xsk_proto
, 1);
1184 static const struct net_proto_family xsk_family_ops
= {
1186 .create
= xsk_create
,
1187 .owner
= THIS_MODULE
,
1190 static struct notifier_block xsk_netdev_notifier
= {
1191 .notifier_call
= xsk_notifier
,
1194 static int __net_init
xsk_net_init(struct net
*net
)
1196 mutex_init(&net
->xdp
.lock
);
1197 INIT_HLIST_HEAD(&net
->xdp
.list
);
1201 static void __net_exit
xsk_net_exit(struct net
*net
)
1203 WARN_ON_ONCE(!hlist_empty(&net
->xdp
.list
));
1206 static struct pernet_operations xsk_net_ops
= {
1207 .init
= xsk_net_init
,
1208 .exit
= xsk_net_exit
,
1211 static int __init
xsk_init(void)
1215 err
= proto_register(&xsk_proto
, 0 /* no slab */);
1219 err
= sock_register(&xsk_family_ops
);
1223 err
= register_pernet_subsys(&xsk_net_ops
);
1227 err
= register_netdevice_notifier(&xsk_netdev_notifier
);
1231 for_each_possible_cpu(cpu
)
1232 INIT_LIST_HEAD(&per_cpu(xskmap_flush_list
, cpu
));
1236 unregister_pernet_subsys(&xsk_net_ops
);
1238 sock_unregister(PF_XDP
);
1240 proto_unregister(&xsk_proto
);
1245 fs_initcall(xsk_init
);