xref: /linux/include/linux/bpf_mem_alloc.h (revision eb71ab2bf72260054677e348498ba995a057c463)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (c) 2022 Meta Platforms, Inc. and affiliates. */
3 #ifndef _BPF_MEM_ALLOC_H
4 #define _BPF_MEM_ALLOC_H
5 #include <linux/compiler_types.h>
6 #include <linux/workqueue.h>
7 
8 struct bpf_mem_cache;
9 struct bpf_mem_caches;
10 
11 struct bpf_mem_alloc {
12 	struct bpf_mem_caches __percpu *caches;
13 	struct bpf_mem_cache __percpu *cache;
14 	struct obj_cgroup *objcg;
15 	bool percpu;
16 	struct work_struct work;
17 	void (*dtor_ctx_free)(void *ctx);
18 	void *dtor_ctx;
19 };
20 
21 /* 'size != 0' is for bpf_mem_alloc which manages fixed-size objects.
22  * Alloc and free are done with bpf_mem_cache_{alloc,free}().
23  *
24  * 'size = 0' is for bpf_mem_alloc which manages many fixed-size objects.
25  * Alloc and free are done with bpf_mem_{alloc,free}() and the size of
26  * the returned object is given by the size argument of bpf_mem_alloc().
27  * If percpu equals true, error will be returned in order to avoid
28  * large memory consumption and the below bpf_mem_alloc_percpu_unit_init()
29  * should be used to do on-demand per-cpu allocation for each size.
30  */
31 int bpf_mem_alloc_init(struct bpf_mem_alloc *ma, int size, bool percpu);
32 /* Initialize a non-fix-size percpu memory allocator */
33 int bpf_mem_alloc_percpu_init(struct bpf_mem_alloc *ma, struct obj_cgroup *objcg);
34 /* The percpu allocation with a specific unit size. */
35 int bpf_mem_alloc_percpu_unit_init(struct bpf_mem_alloc *ma, int size);
36 void bpf_mem_alloc_destroy(struct bpf_mem_alloc *ma);
37 void bpf_mem_alloc_set_dtor(struct bpf_mem_alloc *ma,
38 			    void (*dtor)(void *obj, void *ctx),
39 			    void (*dtor_ctx_free)(void *ctx),
40 			    void *ctx);
41 
42 /* Check the allocation size for kmalloc equivalent allocator */
43 int bpf_mem_alloc_check_size(bool percpu, size_t size);
44 
45 /* kmalloc/kfree equivalent: */
46 void *bpf_mem_alloc(struct bpf_mem_alloc *ma, size_t size);
47 void bpf_mem_free(struct bpf_mem_alloc *ma, void *ptr);
48 void bpf_mem_free_rcu(struct bpf_mem_alloc *ma, void *ptr);
49 
50 /* kmem_cache_alloc/free equivalent: */
51 void *bpf_mem_cache_alloc(struct bpf_mem_alloc *ma);
52 void bpf_mem_cache_free(struct bpf_mem_alloc *ma, void *ptr);
53 void bpf_mem_cache_free_rcu(struct bpf_mem_alloc *ma, void *ptr);
54 void bpf_mem_cache_raw_free(void *ptr);
55 void *bpf_mem_cache_alloc_flags(struct bpf_mem_alloc *ma, gfp_t flags);
56 
57 #endif /* _BPF_MEM_ALLOC_H */
58