Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef __LINUX_PERCPU_H |
3 | #define __LINUX_PERCPU_H | |
7ff6f082 | 4 | |
309381fe | 5 | #include <linux/mmdebug.h> |
0a3021f4 | 6 | #include <linux/preempt.h> |
1da177e4 | 7 | #include <linux/smp.h> |
7ff6f082 | 8 | #include <linux/cpumask.h> |
04b74b27 | 9 | #include <linux/printk.h> |
6a242909 | 10 | #include <linux/pfn.h> |
de380b55 | 11 | #include <linux/init.h> |
7ff6f082 | 12 | |
1da177e4 LT |
13 | #include <asm/percpu.h> |
14 | ||
6a242909 | 15 | /* enough to cover all DEFINE_PER_CPUs in modules */ |
b00742d3 | 16 | #ifdef CONFIG_MODULES |
6a242909 | 17 | #define PERCPU_MODULE_RESERVE (8 << 10) |
b00742d3 | 18 | #else |
6a242909 | 19 | #define PERCPU_MODULE_RESERVE 0 |
1da177e4 LT |
20 | #endif |
21 | ||
8d408b4b | 22 | /* minimum unit size, also is the maximum supported allocation size */ |
6abad5ac | 23 | #define PCPU_MIN_UNIT_SIZE PFN_ALIGN(32 << 10) |
8d408b4b | 24 | |
d2f3c384 DZF |
25 | /* minimum allocation size and shift in bytes */ |
26 | #define PCPU_MIN_ALLOC_SHIFT 2 | |
27 | #define PCPU_MIN_ALLOC_SIZE (1 << PCPU_MIN_ALLOC_SHIFT) | |
28 | ||
b185cd0d DZF |
29 | /* number of bits per page, used to trigger a scan if blocks are > PAGE_SIZE */ |
30 | #define PCPU_BITS_PER_PAGE (PAGE_SIZE >> PCPU_MIN_ALLOC_SHIFT) | |
31 | ||
ca460b3c DZF |
32 | /* |
33 | * This determines the size of each metadata block. There are several subtle | |
34 | * constraints around this constant. The reserved region must be a multiple of | |
35 | * PCPU_BITMAP_BLOCK_SIZE. Additionally, PCPU_BITMAP_BLOCK_SIZE must be a | |
36 | * multiple of PAGE_SIZE or PAGE_SIZE must be a multiple of | |
37 | * PCPU_BITMAP_BLOCK_SIZE to align with the populated page map. The unit_size | |
38 | * also has to be a multiple of PCPU_BITMAP_BLOCK_SIZE to ensure full blocks. | |
39 | */ | |
40 | #define PCPU_BITMAP_BLOCK_SIZE PAGE_SIZE | |
41 | #define PCPU_BITMAP_BLOCK_BITS (PCPU_BITMAP_BLOCK_SIZE >> \ | |
42 | PCPU_MIN_ALLOC_SHIFT) | |
43 | ||
099a19d9 TH |
44 | /* |
45 | * Percpu allocator can serve percpu allocations before slab is | |
46 | * initialized which allows slab to depend on the percpu allocator. | |
47 | * The following two parameters decide how much resource to | |
48 | * preallocate for this. Keep PERCPU_DYNAMIC_RESERVE equal to or | |
49 | * larger than PERCPU_DYNAMIC_EARLY_SIZE. | |
50 | */ | |
51 | #define PERCPU_DYNAMIC_EARLY_SLOTS 128 | |
52 | #define PERCPU_DYNAMIC_EARLY_SIZE (12 << 10) | |
53 | ||
8d408b4b TH |
54 | /* |
55 | * PERCPU_DYNAMIC_RESERVE indicates the amount of free area to piggy | |
6b19b0c2 TH |
56 | * back on the first chunk for dynamic percpu allocation if arch is |
57 | * manually allocating and mapping it for faster access (as a part of | |
58 | * large page mapping for example). | |
8d408b4b | 59 | * |
6b19b0c2 TH |
60 | * The following values give between one and two pages of free space |
61 | * after typical minimal boot (2-way SMP, single disk and NIC) with | |
62 | * both defconfig and a distro config on x86_64 and 32. More | |
63 | * intelligent way to determine this would be nice. | |
8d408b4b | 64 | */ |
6b19b0c2 | 65 | #if BITS_PER_LONG > 32 |
1a4d7607 | 66 | #define PERCPU_DYNAMIC_RESERVE (28 << 10) |
6b19b0c2 | 67 | #else |
1a4d7607 | 68 | #define PERCPU_DYNAMIC_RESERVE (20 << 10) |
6b19b0c2 | 69 | #endif |
8d408b4b | 70 | |
fbf59bc9 | 71 | extern void *pcpu_base_addr; |
fb435d52 | 72 | extern const unsigned long *pcpu_unit_offsets; |
1da177e4 | 73 | |
fd1e8a1f TH |
74 | struct pcpu_group_info { |
75 | int nr_units; /* aligned # of units */ | |
76 | unsigned long base_offset; /* base address offset */ | |
77 | unsigned int *cpu_map; /* unit->cpu map, empty | |
78 | * entries contain NR_CPUS */ | |
79 | }; | |
80 | ||
81 | struct pcpu_alloc_info { | |
82 | size_t static_size; | |
83 | size_t reserved_size; | |
84 | size_t dyn_size; | |
85 | size_t unit_size; | |
86 | size_t atom_size; | |
87 | size_t alloc_size; | |
88 | size_t __ai_size; /* internal, don't use */ | |
89 | int nr_groups; /* 0 if grouping unnecessary */ | |
90 | struct pcpu_group_info groups[]; | |
91 | }; | |
92 | ||
f58dc01b TH |
93 | enum pcpu_fc { |
94 | PCPU_FC_AUTO, | |
95 | PCPU_FC_EMBED, | |
96 | PCPU_FC_PAGE, | |
f58dc01b TH |
97 | |
98 | PCPU_FC_NR, | |
99 | }; | |
17f3609c | 100 | extern const char * const pcpu_fc_names[PCPU_FC_NR]; |
f58dc01b TH |
101 | |
102 | extern enum pcpu_fc pcpu_chosen_fc; | |
103 | ||
3cbc8565 TH |
104 | typedef void * (*pcpu_fc_alloc_fn_t)(unsigned int cpu, size_t size, |
105 | size_t align); | |
d4b95f80 TH |
106 | typedef void (*pcpu_fc_free_fn_t)(void *ptr, size_t size); |
107 | typedef void (*pcpu_fc_populate_pte_fn_t)(unsigned long addr); | |
a530b795 | 108 | typedef int (pcpu_fc_cpu_distance_fn_t)(unsigned int from, unsigned int to); |
fbf59bc9 | 109 | |
fd1e8a1f TH |
110 | extern struct pcpu_alloc_info * __init pcpu_alloc_alloc_info(int nr_groups, |
111 | int nr_units); | |
112 | extern void __init pcpu_free_alloc_info(struct pcpu_alloc_info *ai); | |
113 | ||
fb435d52 TH |
114 | extern int __init pcpu_setup_first_chunk(const struct pcpu_alloc_info *ai, |
115 | void *base_addr); | |
8d408b4b | 116 | |
08fc4580 | 117 | #ifdef CONFIG_NEED_PER_CPU_EMBED_FIRST_CHUNK |
4ba6ce25 | 118 | extern int __init pcpu_embed_first_chunk(size_t reserved_size, size_t dyn_size, |
c8826dd5 TH |
119 | size_t atom_size, |
120 | pcpu_fc_cpu_distance_fn_t cpu_distance_fn, | |
121 | pcpu_fc_alloc_fn_t alloc_fn, | |
122 | pcpu_fc_free_fn_t free_fn); | |
08fc4580 | 123 | #endif |
66c3a757 | 124 | |
08fc4580 | 125 | #ifdef CONFIG_NEED_PER_CPU_PAGE_FIRST_CHUNK |
fb435d52 | 126 | extern int __init pcpu_page_first_chunk(size_t reserved_size, |
d4b95f80 TH |
127 | pcpu_fc_alloc_fn_t alloc_fn, |
128 | pcpu_fc_free_fn_t free_fn, | |
129 | pcpu_fc_populate_pte_fn_t populate_pte_fn); | |
08fc4580 | 130 | #endif |
d4b95f80 | 131 | |
e0fdb0e0 | 132 | extern void __percpu *__alloc_reserved_percpu(size_t size, size_t align); |
383776fa | 133 | extern bool __is_kernel_percpu_address(unsigned long addr, unsigned long *can_addr); |
10fad5e4 | 134 | extern bool is_kernel_percpu_address(unsigned long addr); |
1da177e4 | 135 | |
bbddff05 | 136 | #if !defined(CONFIG_SMP) || !defined(CONFIG_HAVE_SETUP_PER_CPU_AREA) |
e74e3962 TH |
137 | extern void __init setup_per_cpu_areas(void); |
138 | #endif | |
139 | ||
5835d96e | 140 | extern void __percpu *__alloc_percpu_gfp(size_t size, size_t align, gfp_t gfp); |
de380b55 TH |
141 | extern void __percpu *__alloc_percpu(size_t size, size_t align); |
142 | extern void free_percpu(void __percpu *__pdata); | |
143 | extern phys_addr_t per_cpu_ptr_to_phys(void *addr); | |
144 | ||
5835d96e TH |
145 | #define alloc_percpu_gfp(type, gfp) \ |
146 | (typeof(type) __percpu *)__alloc_percpu_gfp(sizeof(type), \ | |
147 | __alignof__(type), gfp) | |
148 | #define alloc_percpu(type) \ | |
149 | (typeof(type) __percpu *)__alloc_percpu(sizeof(type), \ | |
150 | __alignof__(type)) | |
1da177e4 | 151 | |
7e8a6304 DZF |
152 | extern unsigned long pcpu_nr_pages(void); |
153 | ||
1da177e4 | 154 | #endif /* __LINUX_PERCPU_H */ |