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