xref: /linux/mm/slab.h (revision d8843922fba49e887874aa1f9e748d620c5092af)
197d06609SChristoph Lameter #ifndef MM_SLAB_H
297d06609SChristoph Lameter #define MM_SLAB_H
397d06609SChristoph Lameter /*
497d06609SChristoph Lameter  * Internal slab definitions
597d06609SChristoph Lameter  */
697d06609SChristoph Lameter 
797d06609SChristoph Lameter /*
897d06609SChristoph Lameter  * State of the slab allocator.
997d06609SChristoph Lameter  *
1097d06609SChristoph Lameter  * This is used to describe the states of the allocator during bootup.
1197d06609SChristoph Lameter  * Allocators use this to gradually bootstrap themselves. Most allocators
1297d06609SChristoph Lameter  * have the problem that the structures used for managing slab caches are
1397d06609SChristoph Lameter  * allocated from slab caches themselves.
1497d06609SChristoph Lameter  */
1597d06609SChristoph Lameter enum slab_state {
1697d06609SChristoph Lameter 	DOWN,			/* No slab functionality yet */
1797d06609SChristoph Lameter 	PARTIAL,		/* SLUB: kmem_cache_node available */
1897d06609SChristoph Lameter 	PARTIAL_ARRAYCACHE,	/* SLAB: kmalloc size for arraycache available */
1997d06609SChristoph Lameter 	PARTIAL_L3,		/* SLAB: kmalloc size for l3 struct available */
2097d06609SChristoph Lameter 	UP,			/* Slab caches usable but not all extras yet */
2197d06609SChristoph Lameter 	FULL			/* Everything is working */
2297d06609SChristoph Lameter };
2397d06609SChristoph Lameter 
2497d06609SChristoph Lameter extern enum slab_state slab_state;
2597d06609SChristoph Lameter 
2618004c5dSChristoph Lameter /* The slab cache mutex protects the management structures during changes */
2718004c5dSChristoph Lameter extern struct mutex slab_mutex;
289b030cb8SChristoph Lameter 
299b030cb8SChristoph Lameter /* The list of all slab caches on the system */
3018004c5dSChristoph Lameter extern struct list_head slab_caches;
3118004c5dSChristoph Lameter 
329b030cb8SChristoph Lameter /* The slab cache that manages slab cache information */
339b030cb8SChristoph Lameter extern struct kmem_cache *kmem_cache;
349b030cb8SChristoph Lameter 
359b030cb8SChristoph Lameter /* Functions provided by the slab allocators */
368a13a4ccSChristoph Lameter extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags);
3797d06609SChristoph Lameter 
38cbb79694SChristoph Lameter #ifdef CONFIG_SLUB
39cbb79694SChristoph Lameter struct kmem_cache *__kmem_cache_alias(const char *name, size_t size,
40cbb79694SChristoph Lameter 	size_t align, unsigned long flags, void (*ctor)(void *));
41cbb79694SChristoph Lameter #else
42cbb79694SChristoph Lameter static inline struct kmem_cache *__kmem_cache_alias(const char *name, size_t size,
43cbb79694SChristoph Lameter 	size_t align, unsigned long flags, void (*ctor)(void *))
44cbb79694SChristoph Lameter { return NULL; }
45cbb79694SChristoph Lameter #endif
46cbb79694SChristoph Lameter 
47cbb79694SChristoph Lameter 
48*d8843922SGlauber Costa /* Legal flag mask for kmem_cache_create(), for various configurations */
49*d8843922SGlauber Costa #define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \
50*d8843922SGlauber Costa 			 SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS )
51*d8843922SGlauber Costa 
52*d8843922SGlauber Costa #if defined(CONFIG_DEBUG_SLAB)
53*d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
54*d8843922SGlauber Costa #elif defined(CONFIG_SLUB_DEBUG)
55*d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
56*d8843922SGlauber Costa 			  SLAB_TRACE | SLAB_DEBUG_FREE)
57*d8843922SGlauber Costa #else
58*d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (0)
59*d8843922SGlauber Costa #endif
60*d8843922SGlauber Costa 
61*d8843922SGlauber Costa #if defined(CONFIG_SLAB)
62*d8843922SGlauber Costa #define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
63*d8843922SGlauber Costa 			  SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | SLAB_NOTRACK)
64*d8843922SGlauber Costa #elif defined(CONFIG_SLUB)
65*d8843922SGlauber Costa #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
66*d8843922SGlauber Costa 			  SLAB_TEMPORARY | SLAB_NOTRACK)
67*d8843922SGlauber Costa #else
68*d8843922SGlauber Costa #define SLAB_CACHE_FLAGS (0)
69*d8843922SGlauber Costa #endif
70*d8843922SGlauber Costa 
71*d8843922SGlauber Costa #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
72*d8843922SGlauber Costa 
73945cf2b6SChristoph Lameter int __kmem_cache_shutdown(struct kmem_cache *);
74945cf2b6SChristoph Lameter 
75b7454ad3SGlauber Costa struct seq_file;
76b7454ad3SGlauber Costa struct file;
77b7454ad3SGlauber Costa 
780d7561c6SGlauber Costa struct slabinfo {
790d7561c6SGlauber Costa 	unsigned long active_objs;
800d7561c6SGlauber Costa 	unsigned long num_objs;
810d7561c6SGlauber Costa 	unsigned long active_slabs;
820d7561c6SGlauber Costa 	unsigned long num_slabs;
830d7561c6SGlauber Costa 	unsigned long shared_avail;
840d7561c6SGlauber Costa 	unsigned int limit;
850d7561c6SGlauber Costa 	unsigned int batchcount;
860d7561c6SGlauber Costa 	unsigned int shared;
870d7561c6SGlauber Costa 	unsigned int objects_per_slab;
880d7561c6SGlauber Costa 	unsigned int cache_order;
890d7561c6SGlauber Costa };
900d7561c6SGlauber Costa 
910d7561c6SGlauber Costa void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
920d7561c6SGlauber Costa void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
93b7454ad3SGlauber Costa ssize_t slabinfo_write(struct file *file, const char __user *buffer,
94b7454ad3SGlauber Costa 		       size_t count, loff_t *ppos);
9597d06609SChristoph Lameter #endif
96