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