1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (c) 2017 Jesper Dangaard Brouer, Red Hat Inc.
7 #include <linux/filter.h>
8 #include <linux/types.h>
10 #include <linux/netdevice.h>
11 #include <linux/slab.h>
12 #include <linux/idr.h>
13 #include <linux/rhashtable.h>
14 #include <linux/bug.h>
15 #include <net/page_pool.h>
18 #include <net/xdp_priv.h> /* struct xdp_mem_allocator */
19 #include <trace/events/xdp.h>
20 #include <net/xdp_sock_drv.h>
22 #define REG_STATE_NEW 0x0
23 #define REG_STATE_REGISTERED 0x1
24 #define REG_STATE_UNREGISTERED 0x2
25 #define REG_STATE_UNUSED 0x3
27 static DEFINE_IDA(mem_id_pool);
28 static DEFINE_MUTEX(mem_id_lock);
29 #define MEM_ID_MAX 0xFFFE
31 static int mem_id_next = MEM_ID_MIN;
33 static bool mem_id_init; /* false */
34 static struct rhashtable *mem_id_ht;
36 static u32 xdp_mem_id_hashfn(const void *data, u32 len, u32 seed)
41 BUILD_BUG_ON(sizeof_field(struct xdp_mem_allocator, mem.id)
44 /* Use cyclic increasing ID as direct hash key */
48 static int xdp_mem_id_cmp(struct rhashtable_compare_arg *arg,
51 const struct xdp_mem_allocator *xa = ptr;
52 u32 mem_id = *(u32 *)arg->key;
54 return xa->mem.id != mem_id;
57 static const struct rhashtable_params mem_id_rht_params = {
59 .head_offset = offsetof(struct xdp_mem_allocator, node),
60 .key_offset = offsetof(struct xdp_mem_allocator, mem.id),
61 .key_len = sizeof_field(struct xdp_mem_allocator, mem.id),
62 .max_size = MEM_ID_MAX,
64 .automatic_shrinking = true,
65 .hashfn = xdp_mem_id_hashfn,
66 .obj_cmpfn = xdp_mem_id_cmp,
69 static void __xdp_mem_allocator_rcu_free(struct rcu_head *rcu)
71 struct xdp_mem_allocator *xa;
73 xa = container_of(rcu, struct xdp_mem_allocator, rcu);
75 /* Allow this ID to be reused */
76 ida_simple_remove(&mem_id_pool, xa->mem.id);
81 static void mem_xa_remove(struct xdp_mem_allocator *xa)
83 trace_mem_disconnect(xa);
85 if (!rhashtable_remove_fast(mem_id_ht, &xa->node, mem_id_rht_params))
86 call_rcu(&xa->rcu, __xdp_mem_allocator_rcu_free);
89 static void mem_allocator_disconnect(void *allocator)
91 struct xdp_mem_allocator *xa;
92 struct rhashtable_iter iter;
94 mutex_lock(&mem_id_lock);
96 rhashtable_walk_enter(mem_id_ht, &iter);
98 rhashtable_walk_start(&iter);
100 while ((xa = rhashtable_walk_next(&iter)) && !IS_ERR(xa)) {
101 if (xa->allocator == allocator)
105 rhashtable_walk_stop(&iter);
107 } while (xa == ERR_PTR(-EAGAIN));
108 rhashtable_walk_exit(&iter);
110 mutex_unlock(&mem_id_lock);
113 void xdp_unreg_mem_model(struct xdp_mem_info *mem)
115 struct xdp_mem_allocator *xa;
116 int type = mem->type;
119 /* Reset mem info to defaults */
126 if (type == MEM_TYPE_PAGE_POOL) {
128 xa = rhashtable_lookup(mem_id_ht, &id, mem_id_rht_params);
129 page_pool_destroy(xa->page_pool);
133 EXPORT_SYMBOL_GPL(xdp_unreg_mem_model);
135 void xdp_rxq_info_unreg_mem_model(struct xdp_rxq_info *xdp_rxq)
137 if (xdp_rxq->reg_state != REG_STATE_REGISTERED) {
138 WARN(1, "Missing register, driver bug");
142 xdp_unreg_mem_model(&xdp_rxq->mem);
144 EXPORT_SYMBOL_GPL(xdp_rxq_info_unreg_mem_model);
146 void xdp_rxq_info_unreg(struct xdp_rxq_info *xdp_rxq)
148 /* Simplify driver cleanup code paths, allow unreg "unused" */
149 if (xdp_rxq->reg_state == REG_STATE_UNUSED)
152 xdp_rxq_info_unreg_mem_model(xdp_rxq);
154 xdp_rxq->reg_state = REG_STATE_UNREGISTERED;
157 EXPORT_SYMBOL_GPL(xdp_rxq_info_unreg);
159 static void xdp_rxq_info_init(struct xdp_rxq_info *xdp_rxq)
161 memset(xdp_rxq, 0, sizeof(*xdp_rxq));
164 /* Returns 0 on success, negative on failure */
165 int __xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
166 struct net_device *dev, u32 queue_index,
167 unsigned int napi_id, u32 frag_size)
170 WARN(1, "Missing net_device from driver");
174 if (xdp_rxq->reg_state == REG_STATE_UNUSED) {
175 WARN(1, "Driver promised not to register this");
179 if (xdp_rxq->reg_state == REG_STATE_REGISTERED) {
180 WARN(1, "Missing unregister, handled but fix driver");
181 xdp_rxq_info_unreg(xdp_rxq);
184 /* State either UNREGISTERED or NEW */
185 xdp_rxq_info_init(xdp_rxq);
187 xdp_rxq->queue_index = queue_index;
188 xdp_rxq->napi_id = napi_id;
189 xdp_rxq->frag_size = frag_size;
191 xdp_rxq->reg_state = REG_STATE_REGISTERED;
194 EXPORT_SYMBOL_GPL(__xdp_rxq_info_reg);
196 void xdp_rxq_info_unused(struct xdp_rxq_info *xdp_rxq)
198 xdp_rxq->reg_state = REG_STATE_UNUSED;
200 EXPORT_SYMBOL_GPL(xdp_rxq_info_unused);
202 bool xdp_rxq_info_is_reg(struct xdp_rxq_info *xdp_rxq)
204 return (xdp_rxq->reg_state == REG_STATE_REGISTERED);
206 EXPORT_SYMBOL_GPL(xdp_rxq_info_is_reg);
208 static int __mem_id_init_hash_table(void)
210 struct rhashtable *rht;
213 if (unlikely(mem_id_init))
216 rht = kzalloc(sizeof(*rht), GFP_KERNEL);
220 ret = rhashtable_init(rht, &mem_id_rht_params);
226 smp_mb(); /* mutex lock should provide enough pairing */
232 /* Allocate a cyclic ID that maps to allocator pointer.
233 * See: https://www.kernel.org/doc/html/latest/core-api/idr.html
235 * Caller must lock mem_id_lock.
237 static int __mem_id_cyclic_get(gfp_t gfp)
243 id = ida_simple_get(&mem_id_pool, mem_id_next, MEM_ID_MAX, gfp);
246 /* Cyclic allocator, reset next id */
248 mem_id_next = MEM_ID_MIN;
252 return id; /* errno */
254 mem_id_next = id + 1;
259 static bool __is_supported_mem_type(enum xdp_mem_type type)
261 if (type == MEM_TYPE_PAGE_POOL)
262 return is_page_pool_compiled_in();
264 if (type >= MEM_TYPE_MAX)
270 static struct xdp_mem_allocator *__xdp_reg_mem_model(struct xdp_mem_info *mem,
271 enum xdp_mem_type type,
274 struct xdp_mem_allocator *xdp_alloc;
275 gfp_t gfp = GFP_KERNEL;
279 if (!__is_supported_mem_type(type))
280 return ERR_PTR(-EOPNOTSUPP);
285 if (type == MEM_TYPE_PAGE_POOL)
286 return ERR_PTR(-EINVAL); /* Setup time check page_pool req */
290 /* Delay init of rhashtable to save memory if feature isn't used */
292 mutex_lock(&mem_id_lock);
293 ret = __mem_id_init_hash_table();
294 mutex_unlock(&mem_id_lock);
301 xdp_alloc = kzalloc(sizeof(*xdp_alloc), gfp);
303 return ERR_PTR(-ENOMEM);
305 mutex_lock(&mem_id_lock);
306 id = __mem_id_cyclic_get(gfp);
312 xdp_alloc->mem = *mem;
313 xdp_alloc->allocator = allocator;
315 /* Insert allocator into ID lookup table */
316 ptr = rhashtable_insert_slow(mem_id_ht, &id, &xdp_alloc->node);
318 ida_simple_remove(&mem_id_pool, mem->id);
320 errno = PTR_ERR(ptr);
324 if (type == MEM_TYPE_PAGE_POOL)
325 page_pool_use_xdp_mem(allocator, mem_allocator_disconnect, mem);
327 mutex_unlock(&mem_id_lock);
331 mutex_unlock(&mem_id_lock);
333 return ERR_PTR(errno);
336 int xdp_reg_mem_model(struct xdp_mem_info *mem,
337 enum xdp_mem_type type, void *allocator)
339 struct xdp_mem_allocator *xdp_alloc;
341 xdp_alloc = __xdp_reg_mem_model(mem, type, allocator);
342 if (IS_ERR(xdp_alloc))
343 return PTR_ERR(xdp_alloc);
346 EXPORT_SYMBOL_GPL(xdp_reg_mem_model);
348 int xdp_rxq_info_reg_mem_model(struct xdp_rxq_info *xdp_rxq,
349 enum xdp_mem_type type, void *allocator)
351 struct xdp_mem_allocator *xdp_alloc;
353 if (xdp_rxq->reg_state != REG_STATE_REGISTERED) {
354 WARN(1, "Missing register, driver bug");
358 xdp_alloc = __xdp_reg_mem_model(&xdp_rxq->mem, type, allocator);
359 if (IS_ERR(xdp_alloc))
360 return PTR_ERR(xdp_alloc);
362 if (trace_mem_connect_enabled() && xdp_alloc)
363 trace_mem_connect(xdp_alloc, xdp_rxq);
367 EXPORT_SYMBOL_GPL(xdp_rxq_info_reg_mem_model);
369 /* XDP RX runs under NAPI protection, and in different delivery error
370 * scenarios (e.g. queue full), it is possible to return the xdp_frame
371 * while still leveraging this protection. The @napi_direct boolean
372 * is used for those calls sites. Thus, allowing for faster recycling
373 * of xdp_frames/pages in those cases.
375 void __xdp_return(void *data, struct xdp_mem_info *mem, bool napi_direct,
376 struct xdp_buff *xdp)
381 case MEM_TYPE_PAGE_POOL:
382 page = virt_to_head_page(data);
383 if (napi_direct && xdp_return_frame_no_direct())
385 /* No need to check ((page->pp_magic & ~0x3UL) == PP_SIGNATURE)
386 * as mem->type knows this a page_pool page
388 page_pool_put_full_page(page->pp, page, napi_direct);
390 case MEM_TYPE_PAGE_SHARED:
391 page_frag_free(data);
393 case MEM_TYPE_PAGE_ORDER0:
394 page = virt_to_page(data); /* Assumes order0 page*/
397 case MEM_TYPE_XSK_BUFF_POOL:
398 /* NB! Only valid from an xdp_buff! */
402 /* Not possible, checked in xdp_rxq_info_reg_mem_model() */
403 WARN(1, "Incorrect XDP memory type (%d) usage", mem->type);
408 void xdp_return_frame(struct xdp_frame *xdpf)
410 struct skb_shared_info *sinfo;
413 if (likely(!xdp_frame_has_frags(xdpf)))
416 sinfo = xdp_get_shared_info_from_frame(xdpf);
417 for (i = 0; i < sinfo->nr_frags; i++) {
418 struct page *page = skb_frag_page(&sinfo->frags[i]);
420 __xdp_return(page_address(page), &xdpf->mem, false, NULL);
423 __xdp_return(xdpf->data, &xdpf->mem, false, NULL);
425 EXPORT_SYMBOL_GPL(xdp_return_frame);
427 void xdp_return_frame_rx_napi(struct xdp_frame *xdpf)
429 struct skb_shared_info *sinfo;
432 if (likely(!xdp_frame_has_frags(xdpf)))
435 sinfo = xdp_get_shared_info_from_frame(xdpf);
436 for (i = 0; i < sinfo->nr_frags; i++) {
437 struct page *page = skb_frag_page(&sinfo->frags[i]);
439 __xdp_return(page_address(page), &xdpf->mem, true, NULL);
442 __xdp_return(xdpf->data, &xdpf->mem, true, NULL);
444 EXPORT_SYMBOL_GPL(xdp_return_frame_rx_napi);
446 /* XDP bulk APIs introduce a defer/flush mechanism to return
447 * pages belonging to the same xdp_mem_allocator object
448 * (identified via the mem.id field) in bulk to optimize
449 * I-cache and D-cache.
450 * The bulk queue size is set to 16 to be aligned to how
451 * XDP_REDIRECT bulking works. The bulk is flushed when
452 * it is full or when mem.id changes.
453 * xdp_frame_bulk is usually stored/allocated on the function
454 * call-stack to avoid locking penalties.
456 void xdp_flush_frame_bulk(struct xdp_frame_bulk *bq)
458 struct xdp_mem_allocator *xa = bq->xa;
460 if (unlikely(!xa || !bq->count))
463 page_pool_put_page_bulk(xa->page_pool, bq->q, bq->count);
464 /* bq->xa is not cleared to save lookup, if mem.id same in next bulk */
467 EXPORT_SYMBOL_GPL(xdp_flush_frame_bulk);
469 /* Must be called with rcu_read_lock held */
470 void xdp_return_frame_bulk(struct xdp_frame *xdpf,
471 struct xdp_frame_bulk *bq)
473 struct xdp_mem_info *mem = &xdpf->mem;
474 struct xdp_mem_allocator *xa;
476 if (mem->type != MEM_TYPE_PAGE_POOL) {
477 xdp_return_frame(xdpf);
483 xa = rhashtable_lookup(mem_id_ht, &mem->id, mem_id_rht_params);
488 if (bq->count == XDP_BULK_QUEUE_SIZE)
489 xdp_flush_frame_bulk(bq);
491 if (unlikely(mem->id != xa->mem.id)) {
492 xdp_flush_frame_bulk(bq);
493 bq->xa = rhashtable_lookup(mem_id_ht, &mem->id, mem_id_rht_params);
496 if (unlikely(xdp_frame_has_frags(xdpf))) {
497 struct skb_shared_info *sinfo;
500 sinfo = xdp_get_shared_info_from_frame(xdpf);
501 for (i = 0; i < sinfo->nr_frags; i++) {
502 skb_frag_t *frag = &sinfo->frags[i];
504 bq->q[bq->count++] = skb_frag_address(frag);
505 if (bq->count == XDP_BULK_QUEUE_SIZE)
506 xdp_flush_frame_bulk(bq);
509 bq->q[bq->count++] = xdpf->data;
511 EXPORT_SYMBOL_GPL(xdp_return_frame_bulk);
513 void xdp_return_buff(struct xdp_buff *xdp)
515 struct skb_shared_info *sinfo;
518 if (likely(!xdp_buff_has_frags(xdp)))
521 sinfo = xdp_get_shared_info_from_buff(xdp);
522 for (i = 0; i < sinfo->nr_frags; i++) {
523 struct page *page = skb_frag_page(&sinfo->frags[i]);
525 __xdp_return(page_address(page), &xdp->rxq->mem, true, xdp);
528 __xdp_return(xdp->data, &xdp->rxq->mem, true, xdp);
530 EXPORT_SYMBOL_GPL(xdp_return_buff);
532 /* Only called for MEM_TYPE_PAGE_POOL see xdp.h */
533 void __xdp_release_frame(void *data, struct xdp_mem_info *mem)
535 struct xdp_mem_allocator *xa;
539 xa = rhashtable_lookup(mem_id_ht, &mem->id, mem_id_rht_params);
540 page = virt_to_head_page(data);
542 page_pool_release_page(xa->page_pool, page);
545 EXPORT_SYMBOL_GPL(__xdp_release_frame);
547 void xdp_attachment_setup(struct xdp_attachment_info *info,
548 struct netdev_bpf *bpf)
551 bpf_prog_put(info->prog);
552 info->prog = bpf->prog;
553 info->flags = bpf->flags;
555 EXPORT_SYMBOL_GPL(xdp_attachment_setup);
557 struct xdp_frame *xdp_convert_zc_to_xdp_frame(struct xdp_buff *xdp)
559 unsigned int metasize, totsize;
560 void *addr, *data_to_copy;
561 struct xdp_frame *xdpf;
564 /* Clone into a MEM_TYPE_PAGE_ORDER0 xdp_frame. */
565 metasize = xdp_data_meta_unsupported(xdp) ? 0 :
566 xdp->data - xdp->data_meta;
567 totsize = xdp->data_end - xdp->data + metasize;
569 if (sizeof(*xdpf) + totsize > PAGE_SIZE)
572 page = dev_alloc_page();
576 addr = page_to_virt(page);
578 memset(xdpf, 0, sizeof(*xdpf));
580 addr += sizeof(*xdpf);
581 data_to_copy = metasize ? xdp->data_meta : xdp->data;
582 memcpy(addr, data_to_copy, totsize);
584 xdpf->data = addr + metasize;
585 xdpf->len = totsize - metasize;
587 xdpf->metasize = metasize;
588 xdpf->frame_sz = PAGE_SIZE;
589 xdpf->mem.type = MEM_TYPE_PAGE_ORDER0;
594 EXPORT_SYMBOL_GPL(xdp_convert_zc_to_xdp_frame);
596 /* Used by XDP_WARN macro, to avoid inlining WARN() in fast-path */
597 void xdp_warn(const char *msg, const char *func, const int line)
599 WARN(1, "XDP_WARN: %s(line:%d): %s\n", func, line, msg);
601 EXPORT_SYMBOL_GPL(xdp_warn);
603 int xdp_alloc_skb_bulk(void **skbs, int n_skb, gfp_t gfp)
605 n_skb = kmem_cache_alloc_bulk(skbuff_head_cache, gfp,
607 if (unlikely(!n_skb))
612 EXPORT_SYMBOL_GPL(xdp_alloc_skb_bulk);
614 struct sk_buff *__xdp_build_skb_from_frame(struct xdp_frame *xdpf,
616 struct net_device *dev)
618 struct skb_shared_info *sinfo = xdp_get_shared_info_from_frame(xdpf);
619 unsigned int headroom, frame_size;
623 /* xdp frags frame */
624 if (unlikely(xdp_frame_has_frags(xdpf)))
625 nr_frags = sinfo->nr_frags;
627 /* Part of headroom was reserved to xdpf */
628 headroom = sizeof(*xdpf) + xdpf->headroom;
630 /* Memory size backing xdp_frame data already have reserved
631 * room for build_skb to place skb_shared_info in tailroom.
633 frame_size = xdpf->frame_sz;
635 hard_start = xdpf->data - headroom;
636 skb = build_skb_around(skb, hard_start, frame_size);
640 skb_reserve(skb, headroom);
641 __skb_put(skb, xdpf->len);
643 skb_metadata_set(skb, xdpf->metasize);
645 if (unlikely(xdp_frame_has_frags(xdpf)))
646 xdp_update_skb_shared_info(skb, nr_frags,
647 sinfo->xdp_frags_size,
648 nr_frags * xdpf->frame_sz,
649 xdp_frame_is_frag_pfmemalloc(xdpf));
651 /* Essential SKB info: protocol and skb->dev */
652 skb->protocol = eth_type_trans(skb, dev);
654 /* Optional SKB info, currently missing:
655 * - HW checksum info (skb->ip_summed)
656 * - HW RX hash (skb_set_hash)
657 * - RX ring dev queue index (skb_record_rx_queue)
660 /* Until page_pool get SKB return path, release DMA here */
661 xdp_release_frame(xdpf);
663 /* Allow SKB to reuse area used by xdp_frame */
664 xdp_scrub_frame(xdpf);
668 EXPORT_SYMBOL_GPL(__xdp_build_skb_from_frame);
670 struct sk_buff *xdp_build_skb_from_frame(struct xdp_frame *xdpf,
671 struct net_device *dev)
675 skb = kmem_cache_alloc(skbuff_head_cache, GFP_ATOMIC);
679 memset(skb, 0, offsetof(struct sk_buff, tail));
681 return __xdp_build_skb_from_frame(xdpf, skb, dev);
683 EXPORT_SYMBOL_GPL(xdp_build_skb_from_frame);
685 struct xdp_frame *xdpf_clone(struct xdp_frame *xdpf)
687 unsigned int headroom, totalsize;
688 struct xdp_frame *nxdpf;
692 headroom = xdpf->headroom + sizeof(*xdpf);
693 totalsize = headroom + xdpf->len;
695 if (unlikely(totalsize > PAGE_SIZE))
697 page = dev_alloc_page();
700 addr = page_to_virt(page);
702 memcpy(addr, xdpf, totalsize);
705 nxdpf->data = addr + headroom;
706 nxdpf->frame_sz = PAGE_SIZE;
707 nxdpf->mem.type = MEM_TYPE_PAGE_ORDER0;