1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (c) 2022 Meta Platforms, Inc. and affiliates. */
4 #include <linux/llist.h>
6 #include <linux/irq_work.h>
7 #include <linux/bpf_mem_alloc.h>
8 #include <linux/memcontrol.h>
11 /* Any context (including NMI) BPF specific memory allocator.
13 * Tracing BPF programs can attach to kprobe and fentry. Hence they
14 * run in unknown context where calling plain kmalloc() might not be safe.
16 * Front-end kmalloc() with per-cpu per-bucket cache of free elements.
17 * Refill this cache asynchronously from irq_work.
20 * 16 32 64 96 128 196 256 512 1024 2048 4096
23 * 16 32 64 96 128 196 256 512 1024 2048 4096
25 * The buckets are prefilled at the start.
26 * BPF programs always run with migration disabled.
27 * It's safe to allocate from cache of the current cpu with irqs disabled.
28 * Free-ing is always done into bucket of the current cpu as well.
29 * irq_work trims extra free elements from buckets with kfree
30 * and refills them with kmalloc, so global kmalloc logic takes care
31 * of freeing objects allocated by one cpu and freed on another.
33 * Every allocated objected is padded with extra 8 bytes that contains
36 #define LLIST_NODE_SZ sizeof(struct llist_node)
38 /* similar to kmalloc, but sizeof == 8 bucket is gone */
39 static u8 size_index[24] __ro_after_init = {
66 static int bpf_mem_cache_idx(size_t size)
68 if (!size || size > 4096)
72 return size_index[(size - 1) / 8] - 1;
74 return fls(size - 1) - 2;
79 struct bpf_mem_cache {
80 /* per-cpu list of free objects of size 'unit_size'.
81 * All accesses are done with interrupts disabled and 'active' counter
82 * protection with __llist_add() and __llist_del_first().
84 struct llist_head free_llist;
87 /* Operations on the free_list from unit_alloc/unit_free/bpf_mem_refill
88 * are sequenced by per-cpu 'active' counter. But unit_free() cannot
89 * fail. When 'active' is busy the unit_free() will add an object to
92 struct llist_head free_llist_extra;
94 struct irq_work refill_work;
95 struct obj_cgroup *objcg;
97 /* count of objects in free_llist */
99 int low_watermark, high_watermark, batch;
103 struct llist_head free_by_rcu;
104 struct llist_head waiting_for_gp;
105 atomic_t call_rcu_in_progress;
108 struct bpf_mem_caches {
109 struct bpf_mem_cache cache[NUM_CACHES];
112 static struct llist_node notrace *__llist_del_first(struct llist_head *head)
114 struct llist_node *entry, *next;
124 static void *__alloc(struct bpf_mem_cache *c, int node)
126 /* Allocate, but don't deplete atomic reserves that typical
127 * GFP_ATOMIC would do. irq_work runs on this cpu and kmalloc
128 * will allocate from the current numa node which is what we
131 gfp_t flags = GFP_NOWAIT | __GFP_NOWARN | __GFP_ACCOUNT;
133 if (c->percpu_size) {
134 void **obj = kmalloc_node(c->percpu_size, flags, node);
135 void *pptr = __alloc_percpu_gfp(c->unit_size, 8, flags);
146 return kmalloc_node(c->unit_size, flags | __GFP_ZERO, node);
149 static struct mem_cgroup *get_memcg(const struct bpf_mem_cache *c)
151 #ifdef CONFIG_MEMCG_KMEM
153 return get_mem_cgroup_from_objcg(c->objcg);
157 return root_mem_cgroup;
163 /* Mostly runs from irq_work except __init phase. */
164 static void alloc_bulk(struct bpf_mem_cache *c, int cnt, int node)
166 struct mem_cgroup *memcg = NULL, *old_memcg;
171 memcg = get_memcg(c);
172 old_memcg = set_active_memcg(memcg);
173 for (i = 0; i < cnt; i++) {
174 obj = __alloc(c, node);
177 if (IS_ENABLED(CONFIG_PREEMPT_RT))
178 /* In RT irq_work runs in per-cpu kthread, so disable
179 * interrupts to avoid preemption and interrupts and
180 * reduce the chance of bpf prog executing on this cpu
181 * when active counter is busy.
183 local_irq_save(flags);
184 /* alloc_bulk runs from irq_work which will not preempt a bpf
185 * program that does unit_alloc/unit_free since IRQs are
186 * disabled there. There is no race to increment 'active'
187 * counter. It protects free_llist from corruption in case NMI
188 * bpf prog preempted this loop.
190 WARN_ON_ONCE(local_inc_return(&c->active) != 1);
191 __llist_add(obj, &c->free_llist);
193 local_dec(&c->active);
194 if (IS_ENABLED(CONFIG_PREEMPT_RT))
195 local_irq_restore(flags);
197 set_active_memcg(old_memcg);
198 mem_cgroup_put(memcg);
201 static void free_one(struct bpf_mem_cache *c, void *obj)
203 if (c->percpu_size) {
204 free_percpu(((void **)obj)[1]);
212 static void __free_rcu(struct rcu_head *head)
214 struct bpf_mem_cache *c = container_of(head, struct bpf_mem_cache, rcu);
215 struct llist_node *llnode = llist_del_all(&c->waiting_for_gp);
216 struct llist_node *pos, *t;
218 llist_for_each_safe(pos, t, llnode)
220 atomic_set(&c->call_rcu_in_progress, 0);
223 static void __free_rcu_tasks_trace(struct rcu_head *head)
225 struct bpf_mem_cache *c = container_of(head, struct bpf_mem_cache, rcu);
227 call_rcu(&c->rcu, __free_rcu);
230 static void enque_to_free(struct bpf_mem_cache *c, void *obj)
232 struct llist_node *llnode = obj;
234 /* bpf_mem_cache is a per-cpu object. Freeing happens in irq_work.
235 * Nothing races to add to free_by_rcu list.
237 __llist_add(llnode, &c->free_by_rcu);
240 static void do_call_rcu(struct bpf_mem_cache *c)
242 struct llist_node *llnode, *t;
244 if (atomic_xchg(&c->call_rcu_in_progress, 1))
247 WARN_ON_ONCE(!llist_empty(&c->waiting_for_gp));
248 llist_for_each_safe(llnode, t, __llist_del_all(&c->free_by_rcu))
249 /* There is no concurrent __llist_add(waiting_for_gp) access.
250 * It doesn't race with llist_del_all either.
251 * But there could be two concurrent llist_del_all(waiting_for_gp):
252 * from __free_rcu() and from drain_mem_cache().
254 __llist_add(llnode, &c->waiting_for_gp);
255 /* Use call_rcu_tasks_trace() to wait for sleepable progs to finish.
256 * Then use call_rcu() to wait for normal progs to finish
257 * and finally do free_one() on each element.
259 call_rcu_tasks_trace(&c->rcu, __free_rcu_tasks_trace);
262 static void free_bulk(struct bpf_mem_cache *c)
264 struct llist_node *llnode, *t;
269 if (IS_ENABLED(CONFIG_PREEMPT_RT))
270 local_irq_save(flags);
271 WARN_ON_ONCE(local_inc_return(&c->active) != 1);
272 llnode = __llist_del_first(&c->free_llist);
277 local_dec(&c->active);
278 if (IS_ENABLED(CONFIG_PREEMPT_RT))
279 local_irq_restore(flags);
281 enque_to_free(c, llnode);
282 } while (cnt > (c->high_watermark + c->low_watermark) / 2);
284 /* and drain free_llist_extra */
285 llist_for_each_safe(llnode, t, llist_del_all(&c->free_llist_extra))
286 enque_to_free(c, llnode);
290 static void bpf_mem_refill(struct irq_work *work)
292 struct bpf_mem_cache *c = container_of(work, struct bpf_mem_cache, refill_work);
295 /* Racy access to free_cnt. It doesn't need to be 100% accurate */
297 if (cnt < c->low_watermark)
298 /* irq_work runs on this cpu and kmalloc will allocate
299 * from the current numa node which is what we want here.
301 alloc_bulk(c, c->batch, NUMA_NO_NODE);
302 else if (cnt > c->high_watermark)
306 static void notrace irq_work_raise(struct bpf_mem_cache *c)
308 irq_work_queue(&c->refill_work);
311 /* For typical bpf map case that uses bpf_mem_cache_alloc and single bucket
312 * the freelist cache will be elem_size * 64 (or less) on each cpu.
314 * For bpf programs that don't have statically known allocation sizes and
315 * assuming (low_mark + high_mark) / 2 as an average number of elements per
316 * bucket and all buckets are used the total amount of memory in freelists
317 * on each cpu will be:
318 * 64*16 + 64*32 + 64*64 + 64*96 + 64*128 + 64*196 + 64*256 + 32*512 + 16*1024 + 8*2048 + 4*4096
319 * == ~ 116 Kbyte using below heuristic.
320 * Initialized, but unused bpf allocator (not bpf map specific one) will
321 * consume ~ 11 Kbyte per cpu.
322 * Typical case will be between 11K and 116K closer to 11K.
323 * bpf progs can and should share bpf_mem_cache when possible.
326 static void prefill_mem_cache(struct bpf_mem_cache *c, int cpu)
328 init_irq_work(&c->refill_work, bpf_mem_refill);
329 if (c->unit_size <= 256) {
330 c->low_watermark = 32;
331 c->high_watermark = 96;
333 /* When page_size == 4k, order-0 cache will have low_mark == 2
334 * and high_mark == 6 with batch alloc of 3 individual pages at
336 * 8k allocs and above low == 1, high == 3, batch == 1.
338 c->low_watermark = max(32 * 256 / c->unit_size, 1);
339 c->high_watermark = max(96 * 256 / c->unit_size, 3);
341 c->batch = max((c->high_watermark - c->low_watermark) / 4 * 3, 1);
343 /* To avoid consuming memory assume that 1st run of bpf
344 * prog won't be doing more than 4 map_update_elem from
345 * irq disabled region
347 alloc_bulk(c, c->unit_size <= 256 ? 4 : 1, cpu_to_node(cpu));
350 /* When size != 0 bpf_mem_cache for each cpu.
351 * This is typical bpf hash map use case when all elements have equal size.
353 * When size == 0 allocate 11 bpf_mem_cache-s for each cpu, then rely on
354 * kmalloc/kfree. Max allocation size is 4096 in this case.
355 * This is bpf_dynptr and bpf_kptr use case.
357 int bpf_mem_alloc_init(struct bpf_mem_alloc *ma, int size, bool percpu)
359 static u16 sizes[NUM_CACHES] = {96, 192, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096};
360 struct bpf_mem_caches *cc, __percpu *pcc;
361 struct bpf_mem_cache *c, __percpu *pc;
362 struct obj_cgroup *objcg = NULL;
363 int cpu, i, unit_size, percpu_size = 0;
366 pc = __alloc_percpu_gfp(sizeof(*pc), 8, GFP_KERNEL);
371 /* room for llist_node and per-cpu pointer */
372 percpu_size = LLIST_NODE_SZ + sizeof(void *);
374 size += LLIST_NODE_SZ; /* room for llist_node */
377 #ifdef CONFIG_MEMCG_KMEM
378 objcg = get_obj_cgroup_from_current();
380 for_each_possible_cpu(cpu) {
381 c = per_cpu_ptr(pc, cpu);
382 c->unit_size = unit_size;
384 c->percpu_size = percpu_size;
385 prefill_mem_cache(c, cpu);
391 /* size == 0 && percpu is an invalid combination */
392 if (WARN_ON_ONCE(percpu))
395 pcc = __alloc_percpu_gfp(sizeof(*cc), 8, GFP_KERNEL);
398 #ifdef CONFIG_MEMCG_KMEM
399 objcg = get_obj_cgroup_from_current();
401 for_each_possible_cpu(cpu) {
402 cc = per_cpu_ptr(pcc, cpu);
403 for (i = 0; i < NUM_CACHES; i++) {
405 c->unit_size = sizes[i];
407 prefill_mem_cache(c, cpu);
414 static void drain_mem_cache(struct bpf_mem_cache *c)
416 struct llist_node *llnode, *t;
418 /* No progs are using this bpf_mem_cache, but htab_map_free() called
419 * bpf_mem_cache_free() for all remaining elements and they can be in
420 * free_by_rcu or in waiting_for_gp lists, so drain those lists now.
422 * Except for waiting_for_gp list, there are no concurrent operations
423 * on these lists, so it is safe to use __llist_del_all().
425 llist_for_each_safe(llnode, t, __llist_del_all(&c->free_by_rcu))
427 llist_for_each_safe(llnode, t, llist_del_all(&c->waiting_for_gp))
429 llist_for_each_safe(llnode, t, __llist_del_all(&c->free_llist))
431 llist_for_each_safe(llnode, t, __llist_del_all(&c->free_llist_extra))
435 static void free_mem_alloc_no_barrier(struct bpf_mem_alloc *ma)
437 free_percpu(ma->cache);
438 free_percpu(ma->caches);
443 static void free_mem_alloc(struct bpf_mem_alloc *ma)
445 /* waiting_for_gp lists was drained, but __free_rcu might
446 * still execute. Wait for it now before we freeing percpu caches.
448 rcu_barrier_tasks_trace();
450 free_mem_alloc_no_barrier(ma);
453 static void free_mem_alloc_deferred(struct work_struct *work)
455 struct bpf_mem_alloc *ma = container_of(work, struct bpf_mem_alloc, work);
461 static void destroy_mem_alloc(struct bpf_mem_alloc *ma, int rcu_in_progress)
463 struct bpf_mem_alloc *copy;
465 if (!rcu_in_progress) {
466 /* Fast path. No callbacks are pending, hence no need to do
469 free_mem_alloc_no_barrier(ma);
473 copy = kmalloc(sizeof(*ma), GFP_KERNEL);
475 /* Slow path with inline barrier-s */
480 /* Defer barriers into worker to let the rest of map memory to be freed */
481 copy->cache = ma->cache;
483 copy->caches = ma->caches;
485 INIT_WORK(©->work, free_mem_alloc_deferred);
486 queue_work(system_unbound_wq, ©->work);
489 void bpf_mem_alloc_destroy(struct bpf_mem_alloc *ma)
491 struct bpf_mem_caches *cc;
492 struct bpf_mem_cache *c;
493 int cpu, i, rcu_in_progress;
497 for_each_possible_cpu(cpu) {
498 c = per_cpu_ptr(ma->cache, cpu);
500 * refill_work may be unfinished for PREEMPT_RT kernel
501 * in which irq work is invoked in a per-CPU RT thread.
502 * It is also possible for kernel with
503 * arch_irq_work_has_interrupt() being false and irq
504 * work is invoked in timer interrupt. So waiting for
505 * the completion of irq work to ease the handling of
508 irq_work_sync(&c->refill_work);
510 rcu_in_progress += atomic_read(&c->call_rcu_in_progress);
512 /* objcg is the same across cpus */
514 obj_cgroup_put(c->objcg);
515 destroy_mem_alloc(ma, rcu_in_progress);
519 for_each_possible_cpu(cpu) {
520 cc = per_cpu_ptr(ma->caches, cpu);
521 for (i = 0; i < NUM_CACHES; i++) {
523 irq_work_sync(&c->refill_work);
525 rcu_in_progress += atomic_read(&c->call_rcu_in_progress);
529 obj_cgroup_put(c->objcg);
530 destroy_mem_alloc(ma, rcu_in_progress);
534 /* notrace is necessary here and in other functions to make sure
535 * bpf programs cannot attach to them and cause llist corruptions.
537 static void notrace *unit_alloc(struct bpf_mem_cache *c)
539 struct llist_node *llnode = NULL;
543 /* Disable irqs to prevent the following race for majority of prog types:
546 * preemption or irq -> prog_B
549 * but prog_B could be a perf_event NMI prog.
550 * Use per-cpu 'active' counter to order free_list access between
551 * unit_alloc/unit_free/bpf_mem_refill.
553 local_irq_save(flags);
554 if (local_inc_return(&c->active) == 1) {
555 llnode = __llist_del_first(&c->free_llist);
559 local_dec(&c->active);
560 local_irq_restore(flags);
564 if (cnt < c->low_watermark)
569 /* Though 'ptr' object could have been allocated on a different cpu
570 * add it to the free_llist of the current cpu.
571 * Let kfree() logic deal with it when it's later called from irq_work.
573 static void notrace unit_free(struct bpf_mem_cache *c, void *ptr)
575 struct llist_node *llnode = ptr - LLIST_NODE_SZ;
579 BUILD_BUG_ON(LLIST_NODE_SZ > 8);
581 local_irq_save(flags);
582 if (local_inc_return(&c->active) == 1) {
583 __llist_add(llnode, &c->free_llist);
586 /* unit_free() cannot fail. Therefore add an object to atomic
587 * llist. free_bulk() will drain it. Though free_llist_extra is
588 * a per-cpu list we have to use atomic llist_add here, since
589 * it also can be interrupted by bpf nmi prog that does another
590 * unit_free() into the same free_llist_extra.
592 llist_add(llnode, &c->free_llist_extra);
594 local_dec(&c->active);
595 local_irq_restore(flags);
597 if (cnt > c->high_watermark)
598 /* free few objects from current cpu into global kmalloc pool */
602 /* Called from BPF program or from sys_bpf syscall.
603 * In both cases migration is disabled.
605 void notrace *bpf_mem_alloc(struct bpf_mem_alloc *ma, size_t size)
611 return ZERO_SIZE_PTR;
613 idx = bpf_mem_cache_idx(size + LLIST_NODE_SZ);
617 ret = unit_alloc(this_cpu_ptr(ma->caches)->cache + idx);
618 return !ret ? NULL : ret + LLIST_NODE_SZ;
621 void notrace bpf_mem_free(struct bpf_mem_alloc *ma, void *ptr)
628 idx = bpf_mem_cache_idx(ksize(ptr - LLIST_NODE_SZ));
632 unit_free(this_cpu_ptr(ma->caches)->cache + idx, ptr);
635 void notrace *bpf_mem_cache_alloc(struct bpf_mem_alloc *ma)
639 ret = unit_alloc(this_cpu_ptr(ma->cache));
640 return !ret ? NULL : ret + LLIST_NODE_SZ;
643 void notrace bpf_mem_cache_free(struct bpf_mem_alloc *ma, void *ptr)
648 unit_free(this_cpu_ptr(ma->cache), ptr);