include/linux/slab.h

   1 /*
   2  * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
   3  *
   4  * (C) SGI 2006, Christoph Lameter <clameter@sgi.com>
   5  *      Cleaned up and restructured to ease the addition of alternative
   6  *      implementations of SLAB allocators.
   7  */
   8
   9 #ifndef _LINUX_SLAB_H
  10 #define _LINUX_SLAB_H
  11
  12 #ifdef __KERNEL__
  13
  14 #include <linux/gfp.h>
  15 #include <linux/types.h>
  16
  17 typedef struct kmem_cache kmem_cache_t __deprecated;
  18
  19 /*
  20  * Flags to pass to kmem_cache_create().
  21  * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set.
  22  */
  23 #define SLAB_DEBUG_FREE         0x00000100UL    /* DEBUG: Perform (expensive) checks on free */
  24 #define SLAB_DEBUG_INITIAL      0x00000200UL    /* DEBUG: Call constructor (as verifier) */
  25 #define SLAB_RED_ZONE           0x00000400UL    /* DEBUG: Red zone objs in a cache */
  26 #define SLAB_POISON             0x00000800UL    /* DEBUG: Poison objects */
  27 #define SLAB_HWCACHE_ALIGN      0x00002000UL    /* Align objs on cache lines */
  28 #define SLAB_CACHE_DMA          0x00004000UL    /* Use GFP_DMA memory */
  29 #define SLAB_MUST_HWCACHE_ALIGN 0x00008000UL    /* Force alignment even if debuggin is active */
  30 #define SLAB_STORE_USER         0x00010000UL    /* DEBUG: Store the last owner for bug hunting */
  31 #define SLAB_RECLAIM_ACCOUNT    0x00020000UL    /* Objects are reclaimable */
  32 #define SLAB_PANIC              0x00040000UL    /* Panic if kmem_cache_create() fails */
  33 #define SLAB_DESTROY_BY_RCU     0x00080000UL    /* Defer freeing slabs to RCU */
  34 #define SLAB_MEM_SPREAD         0x00100000UL    /* Spread some memory over cpuset */
  35 #define SLAB_TRACE              0x00200000UL    /* Trace allocations and frees */
  36
  37 /* Flags passed to a constructor functions */
  38 #define SLAB_CTOR_CONSTRUCTOR   0x001UL         /* If not set, then deconstructor */
  39 #define SLAB_CTOR_ATOMIC        0x002UL         /* Tell constructor it can't sleep */
  40 #define SLAB_CTOR_VERIFY        0x004UL         /* Tell constructor it's a verify call */
  41
  42 /*
  43  * struct kmem_cache related prototypes
  44  */
  45 void __init kmem_cache_init(void);
  46 int slab_is_available(void);
  47
  48 struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
  49                         unsigned long,
  50                         void (*)(void *, struct kmem_cache *, unsigned long),
  51                         void (*)(void *, struct kmem_cache *, unsigned long));
  52 void kmem_cache_destroy(struct kmem_cache *);
  53 int kmem_cache_shrink(struct kmem_cache *);
  54 void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
  55 void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
  56 void kmem_cache_free(struct kmem_cache *, void *);
  57 unsigned int kmem_cache_size(struct kmem_cache *);
  58 const char *kmem_cache_name(struct kmem_cache *);
  59 int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr);
  60
  61 #ifdef CONFIG_NUMA
  62 extern void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
  63 #else
  64 static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep,
  65                                         gfp_t flags, int node)
  66 {
  67         return kmem_cache_alloc(cachep, flags);
  68 }
  69 #endif
  70
  71 /*
  72  * Common kmalloc functions provided by all allocators
  73  */
  74 void *__kmalloc(size_t, gfp_t);
  75 void *__kzalloc(size_t, gfp_t);
  76 void * __must_check krealloc(const void *, size_t, gfp_t);
  77 void kfree(const void *);
  78 size_t ksize(const void *);
  79
  80 /**
  81  * kcalloc - allocate memory for an array. The memory is set to zero.
  82  * @n: number of elements.
  83  * @size: element size.
  84  * @flags: the type of memory to allocate.
  85  */
  86 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
  87 {
  88         if (n != 0 && size > ULONG_MAX / n)
  89                 return NULL;
  90         return __kzalloc(n * size, flags);
  91 }
  92
  93 /*
  94  * Allocator specific definitions. These are mainly used to establish optimized
  95  * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by selecting
  96  * the appropriate general cache at compile time.
  97  */
  98
  99 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB)
 100 #ifdef CONFIG_SLUB
 101 #include <linux/slub_def.h>
 102 #else
 103 #include <linux/slab_def.h>
 104 #endif /* !CONFIG_SLUB */
 105 #else
 106
 107 /*
 108  * Fallback definitions for an allocator not wanting to provide
 109  * its own optimized kmalloc definitions (like SLOB).
 110  */
 111
 112 /**
 113  * kmalloc - allocate memory
 114  * @size: how many bytes of memory are required.
 115  * @flags: the type of memory to allocate.
 116  *
 117  * kmalloc is the normal method of allocating memory
 118  * in the kernel.
 119  *
 120  * The @flags argument may be one of:
 121  *
 122  * %GFP_USER - Allocate memory on behalf of user.  May sleep.
 123  *
 124  * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
 125  *
 126  * %GFP_ATOMIC - Allocation will not sleep.
 127  *   For example, use this inside interrupt handlers.
 128  *
 129  * %GFP_HIGHUSER - Allocate pages from high memory.
 130  *
 131  * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
 132  *
 133  * %GFP_NOFS - Do not make any fs calls while trying to get memory.
 134  *
 135  * Also it is possible to set different flags by OR'ing
 136  * in one or more of the following additional @flags:
 137  *
 138  * %__GFP_COLD - Request cache-cold pages instead of
 139  *   trying to return cache-warm pages.
 140  *
 141  * %__GFP_DMA - Request memory from the DMA-capable zone.
 142  *
 143  * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
 144  *
 145  * %__GFP_HIGHMEM - Allocated memory may be from highmem.
 146  *
 147  * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
 148  *   (think twice before using).
 149  *
 150  * %__GFP_NORETRY - If memory is not immediately available,
 151  *   then give up at once.
 152  *
 153  * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
 154  *
 155  * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
 156  */
 157 static inline void *kmalloc(size_t size, gfp_t flags)
 158 {
 159         return __kmalloc(size, flags);
 160 }
 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         return __kzalloc(size, flags);
 170 }
 171 #endif
 172
 173 #ifndef CONFIG_NUMA
 174 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
 175 {
 176         return kmalloc(size, flags);
 177 }
 178
 179 static inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
 180 {
 181         return __kmalloc(size, flags);
 182 }
 183 #endif /* !CONFIG_NUMA */
 184
 185 /*
 186  * kmalloc_track_caller is a special version of kmalloc that records the
 187  * calling function of the routine calling it for slab leak tracking instead
 188  * of just the calling function (confusing, eh?).
 189  * It's useful when the call to kmalloc comes from a widely-used standard
 190  * allocator where we care about the real place the memory allocation
 191  * request comes from.
 192  */
 193 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
 194 extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
 195 #define kmalloc_track_caller(size, flags) \
 196         __kmalloc_track_caller(size, flags, __builtin_return_address(0))
 197 #else
 198 #define kmalloc_track_caller(size, flags) \
 199         __kmalloc(size, flags)
 200 #endif /* DEBUG_SLAB */
 201
 202 #ifdef CONFIG_NUMA
 203 /*
 204  * kmalloc_node_track_caller is a special version of kmalloc_node that
 205  * records the calling function of the routine calling it for slab leak
 206  * tracking instead of just the calling function (confusing, eh?).
 207  * It's useful when the call to kmalloc_node comes from a widely-used
 208  * standard allocator where we care about the real place the memory
 209  * allocation request comes from.
 210  */
 211 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
 212 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *);
 213 #define kmalloc_node_track_caller(size, flags, node) \
 214         __kmalloc_node_track_caller(size, flags, node, \
 215                         __builtin_return_address(0))
 216 #else
 217 #define kmalloc_node_track_caller(size, flags, node) \
 218         __kmalloc_node(size, flags, node)
 219 #endif
 220
 221 #else /* CONFIG_NUMA */
 222
 223 #define kmalloc_node_track_caller(size, flags, node) \
 224         kmalloc_track_caller(size, flags)
 225
 226 #endif /* DEBUG_SLAB */
 227
 228 extern const struct seq_operations slabinfo_op;
 229 ssize_t slabinfo_write(struct file *, const char __user *, size_t, loff_t *);
 230
 231 #endif  /* __KERNEL__ */
 232 #endif  /* _LINUX_SLAB_H */
 233