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