1 // SPDX-License-Identifier: GPL-2.0
3 #include <net/xsk_buff_pool.h>
4 #include <net/xdp_sock.h>
5 #include <net/xdp_sock_drv.h>
11 void xp_add_xsk(struct xsk_buff_pool *pool, struct xdp_sock *xs)
18 spin_lock_irqsave(&pool->xsk_tx_list_lock, flags);
19 list_add_rcu(&xs->tx_list, &pool->xsk_tx_list);
20 spin_unlock_irqrestore(&pool->xsk_tx_list_lock, flags);
23 void xp_del_xsk(struct xsk_buff_pool *pool, struct xdp_sock *xs)
30 spin_lock_irqsave(&pool->xsk_tx_list_lock, flags);
31 list_del_rcu(&xs->tx_list);
32 spin_unlock_irqrestore(&pool->xsk_tx_list_lock, flags);
35 void xp_destroy(struct xsk_buff_pool *pool)
40 kvfree(pool->tx_descs);
45 int xp_alloc_tx_descs(struct xsk_buff_pool *pool, struct xdp_sock *xs)
47 pool->tx_descs = kvcalloc(xs->tx->nentries, sizeof(*pool->tx_descs),
55 struct xsk_buff_pool *xp_create_and_assign_umem(struct xdp_sock *xs,
56 struct xdp_umem *umem)
58 bool unaligned = umem->flags & XDP_UMEM_UNALIGNED_CHUNK_FLAG;
59 struct xsk_buff_pool *pool;
60 struct xdp_buff_xsk *xskb;
63 entries = unaligned ? umem->chunks : 0;
64 pool = kvzalloc(struct_size(pool, free_heads, entries), GFP_KERNEL);
68 pool->heads = kvcalloc(umem->chunks, sizeof(*pool->heads), GFP_KERNEL);
73 if (xp_alloc_tx_descs(pool, xs))
76 pool->chunk_mask = ~((u64)umem->chunk_size - 1);
77 pool->addrs_cnt = umem->size;
78 pool->heads_cnt = umem->chunks;
79 pool->free_heads_cnt = umem->chunks;
80 pool->headroom = umem->headroom;
81 pool->chunk_size = umem->chunk_size;
82 pool->chunk_shift = ffs(umem->chunk_size) - 1;
83 pool->unaligned = unaligned;
84 pool->frame_len = umem->chunk_size - umem->headroom -
87 pool->addrs = umem->addrs;
88 INIT_LIST_HEAD(&pool->free_list);
89 INIT_LIST_HEAD(&pool->xsk_tx_list);
90 spin_lock_init(&pool->xsk_tx_list_lock);
91 spin_lock_init(&pool->cq_lock);
92 refcount_set(&pool->users, 1);
94 pool->fq = xs->fq_tmp;
95 pool->cq = xs->cq_tmp;
97 for (i = 0; i < pool->free_heads_cnt; i++) {
98 xskb = &pool->heads[i];
100 xskb->xdp.frame_sz = umem->chunk_size - umem->headroom;
101 INIT_LIST_HEAD(&xskb->free_list_node);
103 pool->free_heads[i] = xskb;
105 xp_init_xskb_addr(xskb, pool, i * pool->chunk_size);
115 void xp_set_rxq_info(struct xsk_buff_pool *pool, struct xdp_rxq_info *rxq)
119 for (i = 0; i < pool->heads_cnt; i++)
120 pool->heads[i].xdp.rxq = rxq;
122 EXPORT_SYMBOL(xp_set_rxq_info);
124 static void xp_disable_drv_zc(struct xsk_buff_pool *pool)
126 struct netdev_bpf bpf;
131 if (pool->umem->zc) {
132 bpf.command = XDP_SETUP_XSK_POOL;
134 bpf.xsk.queue_id = pool->queue_id;
136 err = pool->netdev->netdev_ops->ndo_bpf(pool->netdev, &bpf);
139 WARN(1, "Failed to disable zero-copy!\n");
143 #define NETDEV_XDP_ACT_ZC (NETDEV_XDP_ACT_BASIC | \
144 NETDEV_XDP_ACT_REDIRECT | \
145 NETDEV_XDP_ACT_XSK_ZEROCOPY)
147 int xp_assign_dev(struct xsk_buff_pool *pool,
148 struct net_device *netdev, u16 queue_id, u16 flags)
150 bool force_zc, force_copy;
151 struct netdev_bpf bpf;
156 force_zc = flags & XDP_ZEROCOPY;
157 force_copy = flags & XDP_COPY;
159 if (force_zc && force_copy)
162 if (xsk_get_pool_from_qid(netdev, queue_id))
165 pool->netdev = netdev;
166 pool->queue_id = queue_id;
167 err = xsk_reg_pool_at_qid(netdev, pool, queue_id);
171 if (flags & XDP_USE_NEED_WAKEUP)
172 pool->uses_need_wakeup = true;
173 /* Tx needs to be explicitly woken up the first time. Also
174 * for supporting drivers that do not implement this
175 * feature. They will always have to call sendto() or poll().
177 pool->cached_need_wakeup = XDP_WAKEUP_TX;
182 /* For copy-mode, we are done. */
185 if ((netdev->xdp_features & NETDEV_XDP_ACT_ZC) != NETDEV_XDP_ACT_ZC) {
190 bpf.command = XDP_SETUP_XSK_POOL;
192 bpf.xsk.queue_id = queue_id;
194 err = netdev->netdev_ops->ndo_bpf(netdev, &bpf);
198 if (!pool->dma_pages) {
199 WARN(1, "Driver did not DMA map zero-copy buffers");
203 pool->umem->zc = true;
207 xp_disable_drv_zc(pool);
210 err = 0; /* fallback to copy mode */
212 xsk_clear_pool_at_qid(netdev, queue_id);
218 int xp_assign_dev_shared(struct xsk_buff_pool *pool, struct xdp_sock *umem_xs,
219 struct net_device *dev, u16 queue_id)
222 struct xdp_umem *umem = umem_xs->umem;
224 /* One fill and completion ring required for each queue id. */
225 if (!pool->fq || !pool->cq)
228 flags = umem->zc ? XDP_ZEROCOPY : XDP_COPY;
229 if (umem_xs->pool->uses_need_wakeup)
230 flags |= XDP_USE_NEED_WAKEUP;
232 return xp_assign_dev(pool, dev, queue_id, flags);
235 void xp_clear_dev(struct xsk_buff_pool *pool)
240 xp_disable_drv_zc(pool);
241 xsk_clear_pool_at_qid(pool->netdev, pool->queue_id);
242 dev_put(pool->netdev);
246 static void xp_release_deferred(struct work_struct *work)
248 struct xsk_buff_pool *pool = container_of(work, struct xsk_buff_pool,
256 xskq_destroy(pool->fq);
261 xskq_destroy(pool->cq);
265 xdp_put_umem(pool->umem, false);
269 void xp_get_pool(struct xsk_buff_pool *pool)
271 refcount_inc(&pool->users);
274 bool xp_put_pool(struct xsk_buff_pool *pool)
279 if (refcount_dec_and_test(&pool->users)) {
280 INIT_WORK(&pool->work, xp_release_deferred);
281 schedule_work(&pool->work);
288 static struct xsk_dma_map *xp_find_dma_map(struct xsk_buff_pool *pool)
290 struct xsk_dma_map *dma_map;
292 list_for_each_entry(dma_map, &pool->umem->xsk_dma_list, list) {
293 if (dma_map->netdev == pool->netdev)
300 static struct xsk_dma_map *xp_create_dma_map(struct device *dev, struct net_device *netdev,
301 u32 nr_pages, struct xdp_umem *umem)
303 struct xsk_dma_map *dma_map;
305 dma_map = kzalloc(sizeof(*dma_map), GFP_KERNEL);
309 dma_map->dma_pages = kvcalloc(nr_pages, sizeof(*dma_map->dma_pages), GFP_KERNEL);
310 if (!dma_map->dma_pages) {
315 dma_map->netdev = netdev;
317 dma_map->dma_need_sync = false;
318 dma_map->dma_pages_cnt = nr_pages;
319 refcount_set(&dma_map->users, 1);
320 list_add(&dma_map->list, &umem->xsk_dma_list);
324 static void xp_destroy_dma_map(struct xsk_dma_map *dma_map)
326 list_del(&dma_map->list);
327 kvfree(dma_map->dma_pages);
331 static void __xp_dma_unmap(struct xsk_dma_map *dma_map, unsigned long attrs)
336 for (i = 0; i < dma_map->dma_pages_cnt; i++) {
337 dma = &dma_map->dma_pages[i];
339 *dma &= ~XSK_NEXT_PG_CONTIG_MASK;
340 dma_unmap_page_attrs(dma_map->dev, *dma, PAGE_SIZE,
341 DMA_BIDIRECTIONAL, attrs);
346 xp_destroy_dma_map(dma_map);
349 void xp_dma_unmap(struct xsk_buff_pool *pool, unsigned long attrs)
351 struct xsk_dma_map *dma_map;
353 if (pool->dma_pages_cnt == 0)
356 dma_map = xp_find_dma_map(pool);
358 WARN(1, "Could not find dma_map for device");
362 if (!refcount_dec_and_test(&dma_map->users))
365 __xp_dma_unmap(dma_map, attrs);
366 kvfree(pool->dma_pages);
367 pool->dma_pages_cnt = 0;
370 EXPORT_SYMBOL(xp_dma_unmap);
372 static void xp_check_dma_contiguity(struct xsk_dma_map *dma_map)
376 for (i = 0; i < dma_map->dma_pages_cnt - 1; i++) {
377 if (dma_map->dma_pages[i] + PAGE_SIZE == dma_map->dma_pages[i + 1])
378 dma_map->dma_pages[i] |= XSK_NEXT_PG_CONTIG_MASK;
380 dma_map->dma_pages[i] &= ~XSK_NEXT_PG_CONTIG_MASK;
384 static int xp_init_dma_info(struct xsk_buff_pool *pool, struct xsk_dma_map *dma_map)
386 if (!pool->unaligned) {
389 for (i = 0; i < pool->heads_cnt; i++) {
390 struct xdp_buff_xsk *xskb = &pool->heads[i];
392 xp_init_xskb_dma(xskb, pool, dma_map->dma_pages, xskb->orig_addr);
396 pool->dma_pages = kvcalloc(dma_map->dma_pages_cnt, sizeof(*pool->dma_pages), GFP_KERNEL);
397 if (!pool->dma_pages)
400 pool->dev = dma_map->dev;
401 pool->dma_pages_cnt = dma_map->dma_pages_cnt;
402 pool->dma_need_sync = dma_map->dma_need_sync;
403 memcpy(pool->dma_pages, dma_map->dma_pages,
404 pool->dma_pages_cnt * sizeof(*pool->dma_pages));
409 int xp_dma_map(struct xsk_buff_pool *pool, struct device *dev,
410 unsigned long attrs, struct page **pages, u32 nr_pages)
412 struct xsk_dma_map *dma_map;
417 dma_map = xp_find_dma_map(pool);
419 err = xp_init_dma_info(pool, dma_map);
423 refcount_inc(&dma_map->users);
427 dma_map = xp_create_dma_map(dev, pool->netdev, nr_pages, pool->umem);
431 for (i = 0; i < dma_map->dma_pages_cnt; i++) {
432 dma = dma_map_page_attrs(dev, pages[i], 0, PAGE_SIZE,
433 DMA_BIDIRECTIONAL, attrs);
434 if (dma_mapping_error(dev, dma)) {
435 __xp_dma_unmap(dma_map, attrs);
438 if (dma_need_sync(dev, dma))
439 dma_map->dma_need_sync = true;
440 dma_map->dma_pages[i] = dma;
444 xp_check_dma_contiguity(dma_map);
446 err = xp_init_dma_info(pool, dma_map);
448 __xp_dma_unmap(dma_map, attrs);
454 EXPORT_SYMBOL(xp_dma_map);
456 static bool xp_addr_crosses_non_contig_pg(struct xsk_buff_pool *pool,
459 return xp_desc_crosses_non_contig_pg(pool, addr, pool->chunk_size);
462 static bool xp_check_unaligned(struct xsk_buff_pool *pool, u64 *addr)
464 *addr = xp_unaligned_extract_addr(*addr);
465 if (*addr >= pool->addrs_cnt ||
466 *addr + pool->chunk_size > pool->addrs_cnt ||
467 xp_addr_crosses_non_contig_pg(pool, *addr))
472 static bool xp_check_aligned(struct xsk_buff_pool *pool, u64 *addr)
474 *addr = xp_aligned_extract_addr(pool, *addr);
475 return *addr < pool->addrs_cnt;
478 static struct xdp_buff_xsk *__xp_alloc(struct xsk_buff_pool *pool)
480 struct xdp_buff_xsk *xskb;
484 if (pool->free_heads_cnt == 0)
488 if (!xskq_cons_peek_addr_unchecked(pool->fq, &addr)) {
489 pool->fq->queue_empty_descs++;
493 ok = pool->unaligned ? xp_check_unaligned(pool, &addr) :
494 xp_check_aligned(pool, &addr);
496 pool->fq->invalid_descs++;
497 xskq_cons_release(pool->fq);
503 if (pool->unaligned) {
504 xskb = pool->free_heads[--pool->free_heads_cnt];
505 xp_init_xskb_addr(xskb, pool, addr);
506 if (pool->dma_pages_cnt)
507 xp_init_xskb_dma(xskb, pool, pool->dma_pages, addr);
509 xskb = &pool->heads[xp_aligned_extract_idx(pool, addr)];
512 xskq_cons_release(pool->fq);
516 struct xdp_buff *xp_alloc(struct xsk_buff_pool *pool)
518 struct xdp_buff_xsk *xskb;
520 if (!pool->free_list_cnt) {
521 xskb = __xp_alloc(pool);
525 pool->free_list_cnt--;
526 xskb = list_first_entry(&pool->free_list, struct xdp_buff_xsk,
528 list_del_init(&xskb->free_list_node);
531 xskb->xdp.data = xskb->xdp.data_hard_start + XDP_PACKET_HEADROOM;
532 xskb->xdp.data_meta = xskb->xdp.data;
534 if (pool->dma_need_sync) {
535 dma_sync_single_range_for_device(pool->dev, xskb->dma, 0,
541 EXPORT_SYMBOL(xp_alloc);
543 static u32 xp_alloc_new_from_fq(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
545 u32 i, cached_cons, nb_entries;
547 if (max > pool->free_heads_cnt)
548 max = pool->free_heads_cnt;
549 max = xskq_cons_nb_entries(pool->fq, max);
551 cached_cons = pool->fq->cached_cons;
555 struct xdp_buff_xsk *xskb;
559 __xskq_cons_read_addr_unchecked(pool->fq, cached_cons++, &addr);
561 ok = pool->unaligned ? xp_check_unaligned(pool, &addr) :
562 xp_check_aligned(pool, &addr);
564 pool->fq->invalid_descs++;
569 if (pool->unaligned) {
570 xskb = pool->free_heads[--pool->free_heads_cnt];
571 xp_init_xskb_addr(xskb, pool, addr);
572 if (pool->dma_pages_cnt)
573 xp_init_xskb_dma(xskb, pool, pool->dma_pages, addr);
575 xskb = &pool->heads[xp_aligned_extract_idx(pool, addr)];
582 xskq_cons_release_n(pool->fq, max);
586 static u32 xp_alloc_reused(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 nb_entries)
588 struct xdp_buff_xsk *xskb;
591 nb_entries = min_t(u32, nb_entries, pool->free_list_cnt);
595 xskb = list_first_entry(&pool->free_list, struct xdp_buff_xsk, free_list_node);
596 list_del_init(&xskb->free_list_node);
601 pool->free_list_cnt -= nb_entries;
606 u32 xp_alloc_batch(struct xsk_buff_pool *pool, struct xdp_buff **xdp, u32 max)
608 u32 nb_entries1 = 0, nb_entries2;
610 if (unlikely(pool->dma_need_sync)) {
611 struct xdp_buff *buff;
614 buff = xp_alloc(pool);
620 if (unlikely(pool->free_list_cnt)) {
621 nb_entries1 = xp_alloc_reused(pool, xdp, max);
622 if (nb_entries1 == max)
629 nb_entries2 = xp_alloc_new_from_fq(pool, xdp, max);
631 pool->fq->queue_empty_descs++;
633 return nb_entries1 + nb_entries2;
635 EXPORT_SYMBOL(xp_alloc_batch);
637 bool xp_can_alloc(struct xsk_buff_pool *pool, u32 count)
639 if (pool->free_list_cnt >= count)
641 return xskq_cons_has_entries(pool->fq, count - pool->free_list_cnt);
643 EXPORT_SYMBOL(xp_can_alloc);
645 void xp_free(struct xdp_buff_xsk *xskb)
647 if (!list_empty(&xskb->free_list_node))
650 xskb->pool->free_list_cnt++;
651 list_add(&xskb->free_list_node, &xskb->pool->free_list);
653 EXPORT_SYMBOL(xp_free);
655 void *xp_raw_get_data(struct xsk_buff_pool *pool, u64 addr)
657 addr = pool->unaligned ? xp_unaligned_add_offset_to_addr(addr) : addr;
658 return pool->addrs + addr;
660 EXPORT_SYMBOL(xp_raw_get_data);
662 dma_addr_t xp_raw_get_dma(struct xsk_buff_pool *pool, u64 addr)
664 addr = pool->unaligned ? xp_unaligned_add_offset_to_addr(addr) : addr;
665 return (pool->dma_pages[addr >> PAGE_SHIFT] &
666 ~XSK_NEXT_PG_CONTIG_MASK) +
669 EXPORT_SYMBOL(xp_raw_get_dma);
671 void xp_dma_sync_for_cpu_slow(struct xdp_buff_xsk *xskb)
673 dma_sync_single_range_for_cpu(xskb->pool->dev, xskb->dma, 0,
674 xskb->pool->frame_len, DMA_BIDIRECTIONAL);
676 EXPORT_SYMBOL(xp_dma_sync_for_cpu_slow);
678 void xp_dma_sync_for_device_slow(struct xsk_buff_pool *pool, dma_addr_t dma,
681 dma_sync_single_range_for_device(pool->dev, dma, 0,
682 size, DMA_BIDIRECTIONAL);
684 EXPORT_SYMBOL(xp_dma_sync_for_device_slow);