percpu: kill legacy percpu allocator
[safe/jmp/linux-2.6] / include / linux / percpu.h
1 #ifndef __LINUX_PERCPU_H
2 #define __LINUX_PERCPU_H
3
4 #include <linux/preempt.h>
5 #include <linux/slab.h> /* For kmalloc() */
6 #include <linux/smp.h>
7 #include <linux/cpumask.h>
8 #include <linux/pfn.h>
9
10 #include <asm/percpu.h>
11
12 /* enough to cover all DEFINE_PER_CPUs in modules */
13 #ifdef CONFIG_MODULES
14 #define PERCPU_MODULE_RESERVE           (8 << 10)
15 #else
16 #define PERCPU_MODULE_RESERVE           0
17 #endif
18
19 #ifndef PERCPU_ENOUGH_ROOM
20 #define PERCPU_ENOUGH_ROOM                                              \
21         (ALIGN(__per_cpu_end - __per_cpu_start, SMP_CACHE_BYTES) +      \
22          PERCPU_MODULE_RESERVE)
23 #endif
24
25 /*
26  * Must be an lvalue. Since @var must be a simple identifier,
27  * we force a syntax error here if it isn't.
28  */
29 #define get_cpu_var(var) (*({                           \
30         extern int simple_identifier_##var(void);       \
31         preempt_disable();                              \
32         &__get_cpu_var(var); }))
33 #define put_cpu_var(var) preempt_enable()
34
35 #ifdef CONFIG_SMP
36
37 /* minimum unit size, also is the maximum supported allocation size */
38 #define PCPU_MIN_UNIT_SIZE              PFN_ALIGN(64 << 10)
39
40 /*
41  * PERCPU_DYNAMIC_RESERVE indicates the amount of free area to piggy
42  * back on the first chunk for dynamic percpu allocation if arch is
43  * manually allocating and mapping it for faster access (as a part of
44  * large page mapping for example).
45  *
46  * The following values give between one and two pages of free space
47  * after typical minimal boot (2-way SMP, single disk and NIC) with
48  * both defconfig and a distro config on x86_64 and 32.  More
49  * intelligent way to determine this would be nice.
50  */
51 #if BITS_PER_LONG > 32
52 #define PERCPU_DYNAMIC_RESERVE          (20 << 10)
53 #else
54 #define PERCPU_DYNAMIC_RESERVE          (12 << 10)
55 #endif
56
57 extern void *pcpu_base_addr;
58 extern const unsigned long *pcpu_unit_offsets;
59
60 struct pcpu_group_info {
61         int                     nr_units;       /* aligned # of units */
62         unsigned long           base_offset;    /* base address offset */
63         unsigned int            *cpu_map;       /* unit->cpu map, empty
64                                                  * entries contain NR_CPUS */
65 };
66
67 struct pcpu_alloc_info {
68         size_t                  static_size;
69         size_t                  reserved_size;
70         size_t                  dyn_size;
71         size_t                  unit_size;
72         size_t                  atom_size;
73         size_t                  alloc_size;
74         size_t                  __ai_size;      /* internal, don't use */
75         int                     nr_groups;      /* 0 if grouping unnecessary */
76         struct pcpu_group_info  groups[];
77 };
78
79 enum pcpu_fc {
80         PCPU_FC_AUTO,
81         PCPU_FC_EMBED,
82         PCPU_FC_PAGE,
83
84         PCPU_FC_NR,
85 };
86 extern const char *pcpu_fc_names[PCPU_FC_NR];
87
88 extern enum pcpu_fc pcpu_chosen_fc;
89
90 typedef void * (*pcpu_fc_alloc_fn_t)(unsigned int cpu, size_t size,
91                                      size_t align);
92 typedef void (*pcpu_fc_free_fn_t)(void *ptr, size_t size);
93 typedef void (*pcpu_fc_populate_pte_fn_t)(unsigned long addr);
94 typedef int (pcpu_fc_cpu_distance_fn_t)(unsigned int from, unsigned int to);
95
96 extern struct pcpu_alloc_info * __init pcpu_alloc_alloc_info(int nr_groups,
97                                                              int nr_units);
98 extern void __init pcpu_free_alloc_info(struct pcpu_alloc_info *ai);
99
100 extern struct pcpu_alloc_info * __init pcpu_build_alloc_info(
101                                 size_t reserved_size, ssize_t dyn_size,
102                                 size_t atom_size,
103                                 pcpu_fc_cpu_distance_fn_t cpu_distance_fn);
104
105 extern int __init pcpu_setup_first_chunk(const struct pcpu_alloc_info *ai,
106                                          void *base_addr);
107
108 #ifdef CONFIG_NEED_PER_CPU_EMBED_FIRST_CHUNK
109 extern int __init pcpu_embed_first_chunk(size_t reserved_size, ssize_t dyn_size,
110                                 size_t atom_size,
111                                 pcpu_fc_cpu_distance_fn_t cpu_distance_fn,
112                                 pcpu_fc_alloc_fn_t alloc_fn,
113                                 pcpu_fc_free_fn_t free_fn);
114 #endif
115
116 #ifdef CONFIG_NEED_PER_CPU_PAGE_FIRST_CHUNK
117 extern int __init pcpu_page_first_chunk(size_t reserved_size,
118                                 pcpu_fc_alloc_fn_t alloc_fn,
119                                 pcpu_fc_free_fn_t free_fn,
120                                 pcpu_fc_populate_pte_fn_t populate_pte_fn);
121 #endif
122
123 /*
124  * Use this to get to a cpu's version of the per-cpu object
125  * dynamically allocated. Non-atomic access to the current CPU's
126  * version should probably be combined with get_cpu()/put_cpu().
127  */
128 #define per_cpu_ptr(ptr, cpu)   SHIFT_PERCPU_PTR((ptr), per_cpu_offset((cpu)))
129
130 extern void *__alloc_reserved_percpu(size_t size, size_t align);
131 extern void *__alloc_percpu(size_t size, size_t align);
132 extern void free_percpu(void *__pdata);
133
134 #ifndef CONFIG_HAVE_SETUP_PER_CPU_AREA
135 extern void __init setup_per_cpu_areas(void);
136 #endif
137
138 #else /* CONFIG_SMP */
139
140 #define per_cpu_ptr(ptr, cpu) ({ (void)(cpu); (ptr); })
141
142 static inline void *__alloc_percpu(size_t size, size_t align)
143 {
144         /*
145          * Can't easily make larger alignment work with kmalloc.  WARN
146          * on it.  Larger alignment should only be used for module
147          * percpu sections on SMP for which this path isn't used.
148          */
149         WARN_ON_ONCE(align > SMP_CACHE_BYTES);
150         return kzalloc(size, GFP_KERNEL);
151 }
152
153 static inline void free_percpu(void *p)
154 {
155         kfree(p);
156 }
157
158 static inline void __init setup_per_cpu_areas(void) { }
159
160 static inline void *pcpu_lpage_remapped(void *kaddr)
161 {
162         return NULL;
163 }
164
165 #endif /* CONFIG_SMP */
166
167 #define alloc_percpu(type)      (type *)__alloc_percpu(sizeof(type), \
168                                                        __alignof__(type))
169
170 /*
171  * Optional methods for optimized non-lvalue per-cpu variable access.
172  *
173  * @var can be a percpu variable or a field of it and its size should
174  * equal char, int or long.  percpu_read() evaluates to a lvalue and
175  * all others to void.
176  *
177  * These operations are guaranteed to be atomic w.r.t. preemption.
178  * The generic versions use plain get/put_cpu_var().  Archs are
179  * encouraged to implement single-instruction alternatives which don't
180  * require preemption protection.
181  */
182 #ifndef percpu_read
183 # define percpu_read(var)                                               \
184   ({                                                                    \
185         typeof(per_cpu_var(var)) __tmp_var__;                           \
186         __tmp_var__ = get_cpu_var(var);                                 \
187         put_cpu_var(var);                                               \
188         __tmp_var__;                                                    \
189   })
190 #endif
191
192 #define __percpu_generic_to_op(var, val, op)                            \
193 do {                                                                    \
194         get_cpu_var(var) op val;                                        \
195         put_cpu_var(var);                                               \
196 } while (0)
197
198 #ifndef percpu_write
199 # define percpu_write(var, val)         __percpu_generic_to_op(var, (val), =)
200 #endif
201
202 #ifndef percpu_add
203 # define percpu_add(var, val)           __percpu_generic_to_op(var, (val), +=)
204 #endif
205
206 #ifndef percpu_sub
207 # define percpu_sub(var, val)           __percpu_generic_to_op(var, (val), -=)
208 #endif
209
210 #ifndef percpu_and
211 # define percpu_and(var, val)           __percpu_generic_to_op(var, (val), &=)
212 #endif
213
214 #ifndef percpu_or
215 # define percpu_or(var, val)            __percpu_generic_to_op(var, (val), |=)
216 #endif
217
218 #ifndef percpu_xor
219 # define percpu_xor(var, val)           __percpu_generic_to_op(var, (val), ^=)
220 #endif
221
222 #endif /* __LINUX_PERCPU_H */