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