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 #ifndef CONFIG_HAVE_LEGACY_PER_CPU_AREA
  38
  39 /* minimum unit size, also is the maximum supported allocation size */
  40 #define PCPU_MIN_UNIT_SIZE              PFN_ALIGN(64 << 10)
  41
  42 /*
  43  * PERCPU_DYNAMIC_RESERVE indicates the amount of free area to piggy
  44  * back on the first chunk for dynamic percpu allocation if arch is
  45  * manually allocating and mapping it for faster access (as a part of
  46  * large page mapping for example).
  47  *
  48  * The following values give between one and two pages of free space
  49  * after typical minimal boot (2-way SMP, single disk and NIC) with
  50  * both defconfig and a distro config on x86_64 and 32.  More
  51  * intelligent way to determine this would be nice.
  52  */
  53 #if BITS_PER_LONG > 32
  54 #define PERCPU_DYNAMIC_RESERVE          (20 << 10)
  55 #else
  56 #define PERCPU_DYNAMIC_RESERVE          (12 << 10)
  57 #endif
  58
  59 extern void *pcpu_base_addr;
  60
  61 typedef void * (*pcpu_fc_alloc_fn_t)(unsigned int cpu, size_t size);
  62 typedef void (*pcpu_fc_free_fn_t)(void *ptr, size_t size);
  63 typedef void (*pcpu_fc_populate_pte_fn_t)(unsigned long addr);
  64 typedef void (*pcpu_fc_map_fn_t)(void *ptr, size_t size, void *addr);
  65
  66 extern size_t __init pcpu_setup_first_chunk(
  67                                 size_t static_size, size_t reserved_size,
  68                                 ssize_t dyn_size, size_t unit_size,
  69                                 void *base_addr);
  70
  71 extern ssize_t __init pcpu_embed_first_chunk(
  72                                 size_t static_size, size_t reserved_size,
  73                                 ssize_t dyn_size);
  74
  75 extern ssize_t __init pcpu_4k_first_chunk(
  76                                 size_t static_size, size_t reserved_size,
  77                                 pcpu_fc_alloc_fn_t alloc_fn,
  78                                 pcpu_fc_free_fn_t free_fn,
  79                                 pcpu_fc_populate_pte_fn_t populate_pte_fn);
  80
  81 #ifdef CONFIG_NEED_MULTIPLE_NODES
  82 extern ssize_t __init pcpu_lpage_first_chunk(
  83                                 size_t static_size, size_t reserved_size,
  84                                 ssize_t dyn_size, size_t lpage_size,
  85                                 pcpu_fc_alloc_fn_t alloc_fn,
  86                                 pcpu_fc_free_fn_t free_fn,
  87                                 pcpu_fc_map_fn_t map_fn);
  88
  89 extern void *pcpu_lpage_remapped(void *kaddr);
  90 #else
  91 static inline ssize_t __init pcpu_lpage_first_chunk(
  92                                 size_t static_size, size_t reserved_size,
  93                                 ssize_t dyn_size, size_t lpage_size,
  94                                 pcpu_fc_alloc_fn_t alloc_fn,
  95                                 pcpu_fc_free_fn_t free_fn,
  96                                 pcpu_fc_map_fn_t map_fn)
  97 {
  98         return -EINVAL;
  99 }
 100
 101 static inline void *pcpu_lpage_remapped(void *kaddr)
 102 {
 103         return NULL;
 104 }
 105 #endif
 106
 107 /*
 108  * Use this to get to a cpu's version of the per-cpu object
 109  * dynamically allocated. Non-atomic access to the current CPU's
 110  * version should probably be combined with get_cpu()/put_cpu().
 111  */
 112 #define per_cpu_ptr(ptr, cpu)   SHIFT_PERCPU_PTR((ptr), per_cpu_offset((cpu)))
 113
 114 extern void *__alloc_reserved_percpu(size_t size, size_t align);
 115
 116 #else /* CONFIG_HAVE_LEGACY_PER_CPU_AREA */
 117
 118 struct percpu_data {
 119         void *ptrs[1];
 120 };
 121
 122 /* pointer disguising messes up the kmemleak objects tracking */
 123 #ifndef CONFIG_DEBUG_KMEMLEAK
 124 #define __percpu_disguise(pdata) (struct percpu_data *)~(unsigned long)(pdata)
 125 #else
 126 #define __percpu_disguise(pdata) (struct percpu_data *)(pdata)
 127 #endif
 128
 129 #define per_cpu_ptr(ptr, cpu)                                           \
 130 ({                                                                      \
 131         struct percpu_data *__p = __percpu_disguise(ptr);               \
 132         (__typeof__(ptr))__p->ptrs[(cpu)];                              \
 133 })
 134
 135 #endif /* CONFIG_HAVE_LEGACY_PER_CPU_AREA */
 136
 137 extern void *__alloc_percpu(size_t size, size_t align);
 138 extern void free_percpu(void *__pdata);
 139
 140 #ifndef CONFIG_HAVE_SETUP_PER_CPU_AREA
 141 extern void __init setup_per_cpu_areas(void);
 142 #endif
 143
 144 #else /* CONFIG_SMP */
 145
 146 #define per_cpu_ptr(ptr, cpu) ({ (void)(cpu); (ptr); })
 147
 148 static inline void *__alloc_percpu(size_t size, size_t align)
 149 {
 150         /*
 151          * Can't easily make larger alignment work with kmalloc.  WARN
 152          * on it.  Larger alignment should only be used for module
 153          * percpu sections on SMP for which this path isn't used.
 154          */
 155         WARN_ON_ONCE(align > SMP_CACHE_BYTES);
 156         return kzalloc(size, GFP_KERNEL);
 157 }
 158
 159 static inline void free_percpu(void *p)
 160 {
 161         kfree(p);
 162 }
 163
 164 static inline void __init setup_per_cpu_areas(void) { }
 165
 166 #endif /* CONFIG_SMP */
 167
 168 #define alloc_percpu(type)      (type *)__alloc_percpu(sizeof(type), \
 169                                                        __alignof__(type))
 170
 171 /*
 172  * Optional methods for optimized non-lvalue per-cpu variable access.
 173  *
 174  * @var can be a percpu variable or a field of it and its size should
 175  * equal char, int or long.  percpu_read() evaluates to a lvalue and
 176  * all others to void.
 177  *
 178  * These operations are guaranteed to be atomic w.r.t. preemption.
 179  * The generic versions use plain get/put_cpu_var().  Archs are
 180  * encouraged to implement single-instruction alternatives which don't
 181  * require preemption protection.
 182  */
 183 #ifndef percpu_read
 184 # define percpu_read(var)                                               \
 185   ({                                                                    \
 186         typeof(per_cpu_var(var)) __tmp_var__;                           \
 187         __tmp_var__ = get_cpu_var(var);                                 \
 188         put_cpu_var(var);                                               \
 189         __tmp_var__;                                                    \
 190   })
 191 #endif
 192
 193 #define __percpu_generic_to_op(var, val, op)                            \
 194 do {                                                                    \
 195         get_cpu_var(var) op val;                                        \
 196         put_cpu_var(var);                                               \
 197 } while (0)
 198
 199 #ifndef percpu_write
 200 # define percpu_write(var, val)         __percpu_generic_to_op(var, (val), =)
 201 #endif
 202
 203 #ifndef percpu_add
 204 # define percpu_add(var, val)           __percpu_generic_to_op(var, (val), +=)
 205 #endif
 206
 207 #ifndef percpu_sub
 208 # define percpu_sub(var, val)           __percpu_generic_to_op(var, (val), -=)
 209 #endif
 210
 211 #ifndef percpu_and
 212 # define percpu_and(var, val)           __percpu_generic_to_op(var, (val), &=)
 213 #endif
 214
 215 #ifndef percpu_or
 216 # define percpu_or(var, val)            __percpu_generic_to_op(var, (val), |=)
 217 #endif
 218
 219 #ifndef percpu_xor
 220 # define percpu_xor(var, val)           __percpu_generic_to_op(var, (val), ^=)
 221 #endif
 222
 223 #endif /* __LINUX_PERCPU_H */