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