SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/slab.h

   1 /*
   2  * linux/include/linux/slab.h
   3  * Written by Mark Hemment, 1996.
   4  * (markhe@nextd.demon.co.uk)
   5  */
   6
   7 #ifndef _LINUX_SLAB_H
   8 #define _LINUX_SLAB_H
   9
  10 #if     defined(__KERNEL__)
  11
  12 /* kmem_cache_t exists for legacy reasons and is not used by code in mm */
  13 typedef struct kmem_cache kmem_cache_t;
  14
  15 #include        <linux/gfp.h>
  16 #include        <linux/init.h>
  17 #include        <linux/types.h>
  18 #include        <asm/page.h>            /* kmalloc_sizes.h needs PAGE_SIZE */
  19 #include        <asm/cache.h>           /* kmalloc_sizes.h needs L1_CACHE_BYTES */
  20
  21 /* flags for kmem_cache_alloc() */
  22 #define SLAB_ATOMIC             GFP_ATOMIC
  23 #define SLAB_USER               GFP_USER
  24 #define SLAB_KERNEL             GFP_KERNEL
  25 #define SLAB_DMA                GFP_DMA
  26
  27 /* flags to pass to kmem_cache_create().
  28  * The first 3 are only valid when the allocator as been build
  29  * SLAB_DEBUG_SUPPORT.
  30  */
  31 #define SLAB_DEBUG_FREE         0x00000100UL    /* Peform (expensive) checks on free */
  32 #define SLAB_DEBUG_INITIAL      0x00000200UL    /* Call constructor (as verifier) */
  33 #define SLAB_RED_ZONE           0x00000400UL    /* Red zone objs in a cache */
  34 #define SLAB_POISON             0x00000800UL    /* Poison objects */
  35 #define SLAB_HWCACHE_ALIGN      0x00002000UL    /* align objs on a h/w cache lines */
  36 #define SLAB_CACHE_DMA          0x00004000UL    /* use GFP_DMA memory */
  37 #define SLAB_MUST_HWCACHE_ALIGN 0x00008000UL    /* force alignment */
  38 #define SLAB_STORE_USER         0x00010000UL    /* store the last owner for bug hunting */
  39 #define SLAB_RECLAIM_ACCOUNT    0x00020000UL    /* track pages allocated to indicate
  40                                                    what is reclaimable later*/
  41 #define SLAB_PANIC              0x00040000UL    /* panic if kmem_cache_create() fails */
  42 #define SLAB_DESTROY_BY_RCU     0x00080000UL    /* defer freeing pages to RCU */
  43 #define SLAB_MEM_SPREAD         0x00100000UL    /* Spread some memory over cpuset */
  44
  45 /* flags passed to a constructor func */
  46 #define SLAB_CTOR_CONSTRUCTOR   0x001UL         /* if not set, then deconstructor */
  47 #define SLAB_CTOR_ATOMIC        0x002UL         /* tell constructor it can't sleep */
  48 #define SLAB_CTOR_VERIFY        0x004UL         /* tell constructor it's a verify call */
  49
  50 #ifndef CONFIG_SLOB
  51
  52 /* prototypes */
  53 extern void __init kmem_cache_init(void);
  54
  55 extern struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
  56                         unsigned long,
  57                         void (*)(void *, struct kmem_cache *, unsigned long),
  58                         void (*)(void *, struct kmem_cache *, unsigned long));
  59 extern void kmem_cache_destroy(struct kmem_cache *);
  60 extern int kmem_cache_shrink(struct kmem_cache *);
  61 extern void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
  62 extern void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
  63 extern void kmem_cache_free(struct kmem_cache *, void *);
  64 extern unsigned int kmem_cache_size(struct kmem_cache *);
  65 extern const char *kmem_cache_name(struct kmem_cache *);
  66
  67 /* Size description struct for general caches. */
  68 struct cache_sizes {
  69         size_t                  cs_size;
  70         struct kmem_cache       *cs_cachep;
  71         struct kmem_cache       *cs_dmacachep;
  72 };
  73 extern struct cache_sizes malloc_sizes[];
  74
  75 extern void *__kmalloc(size_t, gfp_t);
  76
  77 /**
  78  * kmalloc - allocate memory
  79  * @size: how many bytes of memory are required.
  80  * @flags: the type of memory to allocate.
  81  *
  82  * kmalloc is the normal method of allocating memory
  83  * in the kernel.
  84  *
  85  * The @flags argument may be one of:
  86  *
  87  * %GFP_USER - Allocate memory on behalf of user.  May sleep.
  88  *
  89  * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
  90  *
  91  * %GFP_ATOMIC - Allocation will not sleep.
  92  *   For example, use this inside interrupt handlers.
  93  *
  94  * %GFP_HIGHUSER - Allocate pages from high memory.
  95  *
  96  * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
  97  *
  98  * %GFP_NOFS - Do not make any fs calls while trying to get memory.
  99  *
 100  * Also it is possible to set different flags by OR'ing
 101  * in one or more of the following additional @flags:
 102  *
 103  * %__GFP_COLD - Request cache-cold pages instead of
 104  *   trying to return cache-warm pages.
 105  *
 106  * %__GFP_DMA - Request memory from the DMA-capable zone.
 107  *
 108  * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
 109  *
 110  * %__GFP_HIGHMEM - Allocated memory may be from highmem.
 111  *
 112  * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
 113  *   (think twice before using).
 114  *
 115  * %__GFP_NORETRY - If memory is not immediately available,
 116  *   then give up at once.
 117  *
 118  * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
 119  *
 120  * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
 121  */
 122 static inline void *kmalloc(size_t size, gfp_t flags)
 123 {
 124         if (__builtin_constant_p(size)) {
 125                 int i = 0;
 126 #define CACHE(x) \
 127                 if (size <= x) \
 128                         goto found; \
 129                 else \
 130                         i++;
 131 #include "kmalloc_sizes.h"
 132 #undef CACHE
 133                 {
 134                         extern void __you_cannot_kmalloc_that_much(void);
 135                         __you_cannot_kmalloc_that_much();
 136                 }
 137 found:
 138                 return kmem_cache_alloc((flags & GFP_DMA) ?
 139                         malloc_sizes[i].cs_dmacachep :
 140                         malloc_sizes[i].cs_cachep, flags);
 141         }
 142         return __kmalloc(size, flags);
 143 }
 144
 145 /*
 146  * kmalloc_track_caller is a special version of kmalloc that records the
 147  * calling function of the routine calling it for slab leak tracking instead
 148  * of just the calling function (confusing, eh?).
 149  * It's useful when the call to kmalloc comes from a widely-used standard
 150  * allocator where we care about the real place the memory allocation
 151  * request comes from.
 152  */
 153 #ifndef CONFIG_DEBUG_SLAB
 154 #define kmalloc_track_caller(size, flags) \
 155         __kmalloc(size, flags)
 156 #else
 157 extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
 158 #define kmalloc_track_caller(size, flags) \
 159         __kmalloc_track_caller(size, flags, __builtin_return_address(0))
 160 #endif
 161
 162 extern void *__kzalloc(size_t, gfp_t);
 163
 164 /**
 165  * kzalloc - allocate memory. The memory is set to zero.
 166  * @size: how many bytes of memory are required.
 167  * @flags: the type of memory to allocate (see kmalloc).
 168  */
 169 static inline void *kzalloc(size_t size, gfp_t flags)
 170 {
 171         if (__builtin_constant_p(size)) {
 172                 int i = 0;
 173 #define CACHE(x) \
 174                 if (size <= x) \
 175                         goto found; \
 176                 else \
 177                         i++;
 178 #include "kmalloc_sizes.h"
 179 #undef CACHE
 180                 {
 181                         extern void __you_cannot_kzalloc_that_much(void);
 182                         __you_cannot_kzalloc_that_much();
 183                 }
 184 found:
 185                 return kmem_cache_zalloc((flags & GFP_DMA) ?
 186                         malloc_sizes[i].cs_dmacachep :
 187                         malloc_sizes[i].cs_cachep, flags);
 188         }
 189         return __kzalloc(size, flags);
 190 }
 191
 192 /**
 193  * kcalloc - allocate memory for an array. The memory is set to zero.
 194  * @n: number of elements.
 195  * @size: element size.
 196  * @flags: the type of memory to allocate.
 197  */
 198 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
 199 {
 200         if (n != 0 && size > ULONG_MAX / n)
 201                 return NULL;
 202         return kzalloc(n * size, flags);
 203 }
 204
 205 extern void kfree(const void *);
 206 extern unsigned int ksize(const void *);
 207 extern int slab_is_available(void);
 208
 209 #ifdef CONFIG_NUMA
 210 extern void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
 211 extern void *__kmalloc_node(size_t size, gfp_t flags, int node);
 212
 213 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
 214 {
 215         if (__builtin_constant_p(size)) {
 216                 int i = 0;
 217 #define CACHE(x) \
 218                 if (size <= x) \
 219                         goto found; \
 220                 else \
 221                         i++;
 222 #include "kmalloc_sizes.h"
 223 #undef CACHE
 224                 {
 225                         extern void __you_cannot_kmalloc_that_much(void);
 226                         __you_cannot_kmalloc_that_much();
 227                 }
 228 found:
 229                 return kmem_cache_alloc_node((flags & GFP_DMA) ?
 230                         malloc_sizes[i].cs_dmacachep :
 231                         malloc_sizes[i].cs_cachep, flags, node);
 232         }
 233         return __kmalloc_node(size, flags, node);
 234 }
 235
 236 /*
 237  * kmalloc_node_track_caller is a special version of kmalloc_node that
 238  * records the calling function of the routine calling it for slab leak
 239  * tracking instead of just the calling function (confusing, eh?).
 240  * It's useful when the call to kmalloc_node comes from a widely-used
 241  * standard allocator where we care about the real place the memory
 242  * allocation request comes from.
 243  */
 244 #ifndef CONFIG_DEBUG_SLAB
 245 #define kmalloc_node_track_caller(size, flags, node) \
 246         __kmalloc_node(size, flags, node)
 247 #else
 248 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *);
 249 #define kmalloc_node_track_caller(size, flags, node) \
 250         __kmalloc_node_track_caller(size, flags, node, \
 251                         __builtin_return_address(0))
 252 #endif
 253 #else /* CONFIG_NUMA */
 254 static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep,
 255                                         gfp_t flags, int node)
 256 {
 257         return kmem_cache_alloc(cachep, flags);
 258 }
 259 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
 260 {
 261         return kmalloc(size, flags);
 262 }
 263
 264 #define kmalloc_node_track_caller(size, flags, node) \
 265         kmalloc_track_caller(size, flags)
 266 #endif
 267
 268 extern int FASTCALL(kmem_cache_reap(int));
 269 extern int FASTCALL(kmem_ptr_validate(struct kmem_cache *cachep, void *ptr));
 270
 271 #else /* CONFIG_SLOB */
 272
 273 /* SLOB allocator routines */
 274
 275 void kmem_cache_init(void);
 276 struct kmem_cache *kmem_cache_create(const char *c, size_t, size_t,
 277         unsigned long,
 278         void (*)(void *, struct kmem_cache *, unsigned long),
 279         void (*)(void *, struct kmem_cache *, unsigned long));
 280 void kmem_cache_destroy(struct kmem_cache *c);
 281 void *kmem_cache_alloc(struct kmem_cache *c, gfp_t flags);
 282 void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
 283 void kmem_cache_free(struct kmem_cache *c, void *b);
 284 const char *kmem_cache_name(struct kmem_cache *);
 285 void *kmalloc(size_t size, gfp_t flags);
 286 void *__kzalloc(size_t size, gfp_t flags);
 287 void kfree(const void *m);
 288 unsigned int ksize(const void *m);
 289 unsigned int kmem_cache_size(struct kmem_cache *c);
 290
 291 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
 292 {
 293         return __kzalloc(n * size, flags);
 294 }
 295
 296 #define kmem_cache_shrink(d) (0)
 297 #define kmem_cache_reap(a)
 298 #define kmem_ptr_validate(a, b) (0)
 299 #define kmem_cache_alloc_node(c, f, n) kmem_cache_alloc(c, f)
 300 #define kmalloc_node(s, f, n) kmalloc(s, f)
 301 #define kzalloc(s, f) __kzalloc(s, f)
 302 #define kmalloc_track_caller kmalloc
 303
 304 #define kmalloc_node_track_caller kmalloc_node
 305
 306 #endif /* CONFIG_SLOB */
 307
 308 #endif  /* __KERNEL__ */
 309
 310 #endif  /* _LINUX_SLAB_H */