blob: 8bb6e0eaf3c69ef19c5a2fc4810c8a558881ed5d [file] [log] [blame]
Christoph Lameter2e892f42006-12-13 00:34:23 -08001#ifndef _LINUX_SLAB_DEF_H
2#define _LINUX_SLAB_DEF_H
3
4/*
5 * Definitions unique to the original Linux SLAB allocator.
6 *
7 * What we provide here is a way to optimize the frequent kmalloc
8 * calls in the kernel by selecting the appropriate general cache
9 * if kmalloc was called with a size that can be established at
10 * compile time.
11 */
12
13#include <linux/init.h>
14#include <asm/page.h> /* kmalloc_sizes.h needs PAGE_SIZE */
15#include <asm/cache.h> /* kmalloc_sizes.h needs L1_CACHE_BYTES */
16#include <linux/compiler.h>
Li Zefan039ca4e2010-05-26 17:22:17 +080017
David Woodhouse1f0ce8b32010-05-19 12:01:42 +010018/*
Pekka Enberg8eae9852008-05-09 20:32:44 +020019 * struct kmem_cache
20 *
21 * manages a cache.
22 */
23
24struct kmem_cache {
Eric Dumazetb56efcf2011-07-20 19:04:23 +020025/* 1) Cache tunables. Protected by cache_chain_mutex */
Pekka Enberg8eae9852008-05-09 20:32:44 +020026 unsigned int batchcount;
27 unsigned int limit;
28 unsigned int shared;
29
Christoph Lameter3b0efdf2012-06-13 10:24:57 -050030 unsigned int size;
Pekka Enberg8eae9852008-05-09 20:32:44 +020031 u32 reciprocal_buffer_size;
Eric Dumazetb56efcf2011-07-20 19:04:23 +020032/* 2) touched by every alloc & free from the backend */
Pekka Enberg8eae9852008-05-09 20:32:44 +020033
34 unsigned int flags; /* constant flags */
35 unsigned int num; /* # of objs per slab */
36
Eric Dumazetb56efcf2011-07-20 19:04:23 +020037/* 3) cache_grow/shrink */
Pekka Enberg8eae9852008-05-09 20:32:44 +020038 /* order of pgs per slab (2^n) */
39 unsigned int gfporder;
40
41 /* force GFP flags, e.g. GFP_DMA */
Glauber Costaa618e892012-06-14 16:17:21 +040042 gfp_t allocflags;
Pekka Enberg8eae9852008-05-09 20:32:44 +020043
44 size_t colour; /* cache colouring range */
45 unsigned int colour_off; /* colour offset */
46 struct kmem_cache *slabp_cache;
47 unsigned int slab_size;
Pekka Enberg8eae9852008-05-09 20:32:44 +020048
49 /* constructor func */
50 void (*ctor)(void *obj);
51
Eric Dumazetb56efcf2011-07-20 19:04:23 +020052/* 4) cache creation/removal */
Pekka Enberg8eae9852008-05-09 20:32:44 +020053 const char *name;
Christoph Lameter3b0efdf2012-06-13 10:24:57 -050054 struct list_head list;
55 int refcount;
56 int object_size;
57 int align;
Pekka Enberg8eae9852008-05-09 20:32:44 +020058
Eric Dumazetb56efcf2011-07-20 19:04:23 +020059/* 5) statistics */
Pekka Enberg8eae9852008-05-09 20:32:44 +020060#ifdef CONFIG_DEBUG_SLAB
61 unsigned long num_active;
62 unsigned long num_allocations;
63 unsigned long high_mark;
64 unsigned long grown;
65 unsigned long reaped;
66 unsigned long errors;
67 unsigned long max_freeable;
68 unsigned long node_allocs;
69 unsigned long node_frees;
70 unsigned long node_overflow;
71 atomic_t allochit;
72 atomic_t allocmiss;
73 atomic_t freehit;
74 atomic_t freemiss;
75
76 /*
77 * If debugging is enabled, then the allocator can add additional
Christoph Lameter3b0efdf2012-06-13 10:24:57 -050078 * fields and/or padding to every object. size contains the total
Pekka Enberg8eae9852008-05-09 20:32:44 +020079 * object size including these internal fields, the following two
80 * variables contain the offset to the user object and its size.
81 */
82 int obj_offset;
Pekka Enberg8eae9852008-05-09 20:32:44 +020083#endif /* CONFIG_DEBUG_SLAB */
Glauber Costaba6c4962012-12-18 14:22:27 -080084#ifdef CONFIG_MEMCG_KMEM
85 struct memcg_cache_params *memcg_params;
86#endif
Pekka Enberg8eae9852008-05-09 20:32:44 +020087
Eric Dumazetb56efcf2011-07-20 19:04:23 +020088/* 6) per-cpu/per-node data, touched during every alloc/free */
Pekka Enberg8eae9852008-05-09 20:32:44 +020089 /*
Eric Dumazetb56efcf2011-07-20 19:04:23 +020090 * We put array[] at the end of kmem_cache, because we want to size
91 * this array to nr_cpu_ids slots instead of NR_CPUS
Pekka Enberg8eae9852008-05-09 20:32:44 +020092 * (see kmem_cache_init())
Eric Dumazetb56efcf2011-07-20 19:04:23 +020093 * We still use [NR_CPUS] and not [1] or [0] because cache_cache
94 * is statically defined, so we reserve the max number of cpus.
Christoph Lameter3c583462012-11-28 16:23:01 +000095 *
96 * We also need to guarantee that the list is able to accomodate a
97 * pointer for each node since "nodelists" uses the remainder of
98 * available pointers.
Pekka Enberg8eae9852008-05-09 20:32:44 +020099 */
Eric Dumazetb56efcf2011-07-20 19:04:23 +0200100 struct kmem_list3 **nodelists;
Christoph Lameter3c583462012-11-28 16:23:01 +0000101 struct array_cache *array[NR_CPUS + MAX_NUMNODES];
Pekka Enberg8eae9852008-05-09 20:32:44 +0200102 /*
Eric Dumazetb56efcf2011-07-20 19:04:23 +0200103 * Do not add fields after array[]
Pekka Enberg8eae9852008-05-09 20:32:44 +0200104 */
105};
106
Christoph Lameter2e892f42006-12-13 00:34:23 -0800107/* Size description struct for general caches. */
108struct cache_sizes {
109 size_t cs_size;
110 struct kmem_cache *cs_cachep;
Christoph Lameter4b51d662007-02-10 01:43:10 -0800111#ifdef CONFIG_ZONE_DMA
Christoph Lameter2e892f42006-12-13 00:34:23 -0800112 struct kmem_cache *cs_dmacachep;
Christoph Lameter4b51d662007-02-10 01:43:10 -0800113#endif
Christoph Lameter2e892f42006-12-13 00:34:23 -0800114};
115extern struct cache_sizes malloc_sizes[];
116
Paul Mundt6193a2f2007-07-15 23:38:22 -0700117void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
118void *__kmalloc(size_t size, gfp_t flags);
119
Li Zefan0f24f122009-12-11 15:45:30 +0800120#ifdef CONFIG_TRACING
Ezequiel Garcia40521472012-09-08 17:47:56 -0300121extern void *kmem_cache_alloc_trace(struct kmem_cache *, gfp_t, size_t);
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300122#else
123static __always_inline void *
Ezequiel Garcia40521472012-09-08 17:47:56 -0300124kmem_cache_alloc_trace(struct kmem_cache *cachep, gfp_t flags, size_t size)
Christoph Lameter2e892f42006-12-13 00:34:23 -0800125{
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300126 return kmem_cache_alloc(cachep, flags);
127}
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300128#endif
129
130static __always_inline void *kmalloc(size_t size, gfp_t flags)
131{
132 struct kmem_cache *cachep;
133 void *ret;
134
Christoph Lameter2e892f42006-12-13 00:34:23 -0800135 if (__builtin_constant_p(size)) {
136 int i = 0;
Christoph Lameter6cb8f912007-07-17 04:03:22 -0700137
138 if (!size)
139 return ZERO_SIZE_PTR;
140
Christoph Lameter2e892f42006-12-13 00:34:23 -0800141#define CACHE(x) \
142 if (size <= x) \
143 goto found; \
144 else \
145 i++;
Joe Perches1c61fc42008-03-05 13:58:17 -0800146#include <linux/kmalloc_sizes.h>
Christoph Lameter2e892f42006-12-13 00:34:23 -0800147#undef CACHE
Jeff Mahoney1cf3eb22009-01-27 23:48:59 +0200148 return NULL;
Christoph Lameter2e892f42006-12-13 00:34:23 -0800149found:
Christoph Lameter4b51d662007-02-10 01:43:10 -0800150#ifdef CONFIG_ZONE_DMA
151 if (flags & GFP_DMA)
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300152 cachep = malloc_sizes[i].cs_dmacachep;
153 else
Christoph Lameter4b51d662007-02-10 01:43:10 -0800154#endif
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300155 cachep = malloc_sizes[i].cs_cachep;
156
Ezequiel Garcia40521472012-09-08 17:47:56 -0300157 ret = kmem_cache_alloc_trace(cachep, flags, size);
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300158
159 return ret;
Christoph Lameter2e892f42006-12-13 00:34:23 -0800160 }
161 return __kmalloc(size, flags);
162}
163
Christoph Lameter2e892f42006-12-13 00:34:23 -0800164#ifdef CONFIG_NUMA
165extern void *__kmalloc_node(size_t size, gfp_t flags, int node);
Paul Mundt6193a2f2007-07-15 23:38:22 -0700166extern void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
Christoph Lameter2e892f42006-12-13 00:34:23 -0800167
Li Zefan0f24f122009-12-11 15:45:30 +0800168#ifdef CONFIG_TRACING
Ezequiel Garciadffa3f92012-09-26 09:21:33 -0300169extern void *kmem_cache_alloc_node_trace(struct kmem_cache *cachep,
Steven Rostedt85beb582010-11-24 16:23:34 -0500170 gfp_t flags,
Ezequiel Garciadffa3f92012-09-26 09:21:33 -0300171 int nodeid,
172 size_t size);
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300173#else
174static __always_inline void *
Ezequiel Garciadffa3f92012-09-26 09:21:33 -0300175kmem_cache_alloc_node_trace(struct kmem_cache *cachep,
Steven Rostedt85beb582010-11-24 16:23:34 -0500176 gfp_t flags,
Ezequiel Garciadffa3f92012-09-26 09:21:33 -0300177 int nodeid,
178 size_t size)
Christoph Lameter2e892f42006-12-13 00:34:23 -0800179{
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300180 return kmem_cache_alloc_node(cachep, flags, nodeid);
181}
182#endif
183
184static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
185{
186 struct kmem_cache *cachep;
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300187
Christoph Lameter2e892f42006-12-13 00:34:23 -0800188 if (__builtin_constant_p(size)) {
189 int i = 0;
Christoph Lameter6cb8f912007-07-17 04:03:22 -0700190
191 if (!size)
192 return ZERO_SIZE_PTR;
193
Christoph Lameter2e892f42006-12-13 00:34:23 -0800194#define CACHE(x) \
195 if (size <= x) \
196 goto found; \
197 else \
198 i++;
Joe Perches1c61fc42008-03-05 13:58:17 -0800199#include <linux/kmalloc_sizes.h>
Christoph Lameter2e892f42006-12-13 00:34:23 -0800200#undef CACHE
Jeff Mahoney1cf3eb22009-01-27 23:48:59 +0200201 return NULL;
Christoph Lameter2e892f42006-12-13 00:34:23 -0800202found:
Christoph Lameter4b51d662007-02-10 01:43:10 -0800203#ifdef CONFIG_ZONE_DMA
204 if (flags & GFP_DMA)
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300205 cachep = malloc_sizes[i].cs_dmacachep;
206 else
Christoph Lameter4b51d662007-02-10 01:43:10 -0800207#endif
Eduard - Gabriel Munteanu36555752008-08-10 20:14:05 +0300208 cachep = malloc_sizes[i].cs_cachep;
209
Ezequiel Garciadffa3f92012-09-26 09:21:33 -0300210 return kmem_cache_alloc_node_trace(cachep, flags, node, size);
Christoph Lameter2e892f42006-12-13 00:34:23 -0800211 }
212 return __kmalloc_node(size, flags, node);
213}
214
215#endif /* CONFIG_NUMA */
216
Christoph Lameter2e892f42006-12-13 00:34:23 -0800217#endif /* _LINUX_SLAB_DEF_H */