[linux.git] / mm / slab.h

#ifndef MM_SLAB_H
#define MM_SLAB_H
/*
 * Internal slab definitions
 */

#ifdef CONFIG_SLOB
/*
 * Common fields provided in kmem_cache by all slab allocators
 * This struct is either used directly by the allocator (SLOB)
 * or the allocator must include definitions for all fields
 * provided in kmem_cache_common in their definition of kmem_cache.
 *
 * Once we can do anonymous structs (C11 standard) we could put a
 * anonymous struct definition in these allocators so that the
 * separate allocations in the kmem_cache structure of SLAB and
 * SLUB is no longer needed.
 */
struct kmem_cache {
	unsigned int object_size;/* The original size of the object */
	unsigned int size;	/* The aligned/padded/added on size  */
	unsigned int align;	/* Alignment as calculated */
	unsigned long flags;	/* Active flags on the slab */
	const char *name;	/* Slab name for sysfs */
	int refcount;		/* Use counter */
	void (*ctor)(void *);	/* Called on object slot creation */
	struct list_head list;	/* List of all slab caches on the system */
};

#endif /* CONFIG_SLOB */

#ifdef CONFIG_SLAB
#include <linux/slab_def.h>
#endif

#ifdef CONFIG_SLUB
#include <linux/slub_def.h>
#endif

#include <linux/memcontrol.h>
#include <linux/fault-inject.h>
#include <linux/kmemcheck.h>
#include <linux/kasan.h>
#include <linux/kmemleak.h>
#include <linux/random.h>

/*
 * State of the slab allocator.
 *
 * This is used to describe the states of the allocator during bootup.
 * Allocators use this to gradually bootstrap themselves. Most allocators
 * have the problem that the structures used for managing slab caches are
 * allocated from slab caches themselves.
 */
enum slab_state {
	DOWN,			/* No slab functionality yet */
	PARTIAL,		/* SLUB: kmem_cache_node available */
	PARTIAL_NODE,		/* SLAB: kmalloc size for node struct available */
	UP,			/* Slab caches usable but not all extras yet */
	FULL			/* Everything is working */
};

extern enum slab_state slab_state;

/* The slab cache mutex protects the management structures during changes */
extern struct mutex slab_mutex;

/* The list of all slab caches on the system */
extern struct list_head slab_caches;

/* The slab cache that manages slab cache information */
extern struct kmem_cache *kmem_cache;

/* A table of kmalloc cache names and sizes */
extern const struct kmalloc_info_struct {
	const char *name;
	unsigned long size;
} kmalloc_info[];

unsigned long calculate_alignment(unsigned long flags,
		unsigned long align, unsigned long size);

#ifndef CONFIG_SLOB
/* Kmalloc array related functions */
void setup_kmalloc_cache_index_table(void);
void create_kmalloc_caches(unsigned long);

/* Find the kmalloc slab corresponding for a certain size */
struct kmem_cache *kmalloc_slab(size_t, gfp_t);
#endif


/* Functions provided by the slab allocators */
extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags);

extern struct kmem_cache *create_kmalloc_cache(const char *name, size_t size,
			unsigned long flags);
extern void create_boot_cache(struct kmem_cache *, const char *name,
			size_t size, unsigned long flags);

int slab_unmergeable(struct kmem_cache *s);
struct kmem_cache *find_mergeable(size_t size, size_t align,
		unsigned long flags, const char *name, void (*ctor)(void *));
#ifndef CONFIG_SLOB
struct kmem_cache *
__kmem_cache_alias(const char *name, size_t size, size_t align,
		   unsigned long flags, void (*ctor)(void *));

unsigned long kmem_cache_flags(unsigned long object_size,
	unsigned long flags, const char *name,
	void (*ctor)(void *));
#else
static inline struct kmem_cache *
__kmem_cache_alias(const char *name, size_t size, size_t align,
		   unsigned long flags, void (*ctor)(void *))
{ return NULL; }

static inline unsigned long kmem_cache_flags(unsigned long object_size,
	unsigned long flags, const char *name,
	void (*ctor)(void *))
{
	return flags;
}
#endif


/* Legal flag mask for kmem_cache_create(), for various configurations */
#define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \
			 SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS )

#if defined(CONFIG_DEBUG_SLAB)
#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
#elif defined(CONFIG_SLUB_DEBUG)
#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
			  SLAB_TRACE | SLAB_CONSISTENCY_CHECKS)
#else
#define SLAB_DEBUG_FLAGS (0)
#endif

#if defined(CONFIG_SLAB)
#define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
			  SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | \
			  SLAB_NOTRACK | SLAB_ACCOUNT)
#elif defined(CONFIG_SLUB)
#define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
			  SLAB_TEMPORARY | SLAB_NOTRACK | SLAB_ACCOUNT)
#else
#define SLAB_CACHE_FLAGS (0)
#endif

/* Common flags available with current configuration */
#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)

/* Common flags permitted for kmem_cache_create */
#define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS | \
			      SLAB_RED_ZONE | \
			      SLAB_POISON | \
			      SLAB_STORE_USER | \
			      SLAB_TRACE | \
			      SLAB_CONSISTENCY_CHECKS | \
			      SLAB_MEM_SPREAD | \
			      SLAB_NOLEAKTRACE | \
			      SLAB_RECLAIM_ACCOUNT | \
			      SLAB_TEMPORARY | \
			      SLAB_NOTRACK | \
			      SLAB_ACCOUNT)

int __kmem_cache_shutdown(struct kmem_cache *);
void __kmem_cache_release(struct kmem_cache *);
int __kmem_cache_shrink(struct kmem_cache *);
void __kmemcg_cache_deactivate(struct kmem_cache *s);
void slab_kmem_cache_release(struct kmem_cache *);

struct seq_file;
struct file;

struct slabinfo {
	unsigned long active_objs;
	unsigned long num_objs;
	unsigned long active_slabs;
	unsigned long num_slabs;
	unsigned long shared_avail;
	unsigned int limit;
	unsigned int batchcount;
	unsigned int shared;
	unsigned int objects_per_slab;
	unsigned int cache_order;
};

void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
ssize_t slabinfo_write(struct file *file, const char __user *buffer,
		       size_t count, loff_t *ppos);

/*
 * Generic implementation of bulk operations
 * These are useful for situations in which the allocator cannot
 * perform optimizations. In that case segments of the object listed
 * may be allocated or freed using these operations.
 */
void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
int __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);

#if defined(CONFIG_MEMCG) && !defined(CONFIG_SLOB)

/* List of all root caches. */
extern struct list_head		slab_root_caches;
#define root_caches_node	memcg_params.__root_caches_node

/*
 * Iterate over all memcg caches of the given root cache. The caller must hold
 * slab_mutex.
 */
#define for_each_memcg_cache(iter, root) \
	list_for_each_entry(iter, &(root)->memcg_params.children, \
			    memcg_params.children_node)

static inline bool is_root_cache(struct kmem_cache *s)
{
	return !s->memcg_params.root_cache;
}

static inline bool slab_equal_or_root(struct kmem_cache *s,
				      struct kmem_cache *p)
{
	return p == s || p == s->memcg_params.root_cache;
}

/*
 * We use suffixes to the name in memcg because we can't have caches
 * created in the system with the same name. But when we print them
 * locally, better refer to them with the base name
 */
static inline const char *cache_name(struct kmem_cache *s)
{
	if (!is_root_cache(s))
		s = s->memcg_params.root_cache;
	return s->name;
}

/*
 * Note, we protect with RCU only the memcg_caches array, not per-memcg caches.
 * That said the caller must assure the memcg's cache won't go away by either
 * taking a css reference to the owner cgroup, or holding the slab_mutex.
 */
static inline struct kmem_cache *
cache_from_memcg_idx(struct kmem_cache *s, int idx)
{
	struct kmem_cache *cachep;
	struct memcg_cache_array *arr;

	rcu_read_lock();
	arr = rcu_dereference(s->memcg_params.memcg_caches);

	/*
	 * Make sure we will access the up-to-date value. The code updating
	 * memcg_caches issues a write barrier to match this (see
	 * memcg_create_kmem_cache()).
	 */
	cachep = lockless_dereference(arr->entries[idx]);
	rcu_read_unlock();

	return cachep;
}

static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
{
	if (is_root_cache(s))
		return s;
	return s->memcg_params.root_cache;
}

static __always_inline int memcg_charge_slab(struct page *page,
					     gfp_t gfp, int order,
					     struct kmem_cache *s)
{
	int ret;

	if (!memcg_kmem_enabled())
		return 0;
	if (is_root_cache(s))
		return 0;

	ret = memcg_kmem_charge_memcg(page, gfp, order, s->memcg_params.memcg);
	if (ret)
		return ret;

	memcg_kmem_update_page_stat(page,
			(s->flags & SLAB_RECLAIM_ACCOUNT) ?
			MEMCG_SLAB_RECLAIMABLE : MEMCG_SLAB_UNRECLAIMABLE,
			1 << order);
	return 0;
}

static __always_inline void memcg_uncharge_slab(struct page *page, int order,
						struct kmem_cache *s)
{
	if (!memcg_kmem_enabled())
		return;

	memcg_kmem_update_page_stat(page,
			(s->flags & SLAB_RECLAIM_ACCOUNT) ?
			MEMCG_SLAB_RECLAIMABLE : MEMCG_SLAB_UNRECLAIMABLE,
			-(1 << order));
	memcg_kmem_uncharge(page, order);
}

extern void slab_init_memcg_params(struct kmem_cache *);
extern void memcg_link_cache(struct kmem_cache *s);

#else /* CONFIG_MEMCG && !CONFIG_SLOB */

/* If !memcg, all caches are root. */
#define slab_root_caches	slab_caches
#define root_caches_node	list

#define for_each_memcg_cache(iter, root) \
	for ((void)(iter), (void)(root); 0; )

static inline bool is_root_cache(struct kmem_cache *s)
{
	return true;
}

static inline bool slab_equal_or_root(struct kmem_cache *s,
				      struct kmem_cache *p)
{
	return true;
}

static inline const char *cache_name(struct kmem_cache *s)
{
	return s->name;
}

static inline struct kmem_cache *
cache_from_memcg_idx(struct kmem_cache *s, int idx)
{
	return NULL;
}

static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
{
	return s;
}

static inline int memcg_charge_slab(struct page *page, gfp_t gfp, int order,
				    struct kmem_cache *s)
{
	return 0;
}

static inline void memcg_uncharge_slab(struct page *page, int order,
				       struct kmem_cache *s)
{
}

static inline void slab_init_memcg_params(struct kmem_cache *s)
{
}

static inline void memcg_link_cache(struct kmem_cache *s)
{
}

#endif /* CONFIG_MEMCG && !CONFIG_SLOB */

static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
{
	struct kmem_cache *cachep;
	struct page *page;

	/*
	 * When kmemcg is not being used, both assignments should return the
	 * same value. but we don't want to pay the assignment price in that
	 * case. If it is not compiled in, the compiler should be smart enough
	 * to not do even the assignment. In that case, slab_equal_or_root
	 * will also be a constant.
	 */
	if (!memcg_kmem_enabled() &&
	    !unlikely(s->flags & SLAB_CONSISTENCY_CHECKS))
		return s;

	page = virt_to_head_page(x);
	cachep = page->slab_cache;
	if (slab_equal_or_root(cachep, s))
		return cachep;

	pr_err("%s: Wrong slab cache. %s but object is from %s\n",
	       __func__, s->name, cachep->name);
	WARN_ON_ONCE(1);
	return s;
}

static inline size_t slab_ksize(const struct kmem_cache *s)
{
#ifndef CONFIG_SLUB
	return s->object_size;

#else /* CONFIG_SLUB */
# ifdef CONFIG_SLUB_DEBUG
	/*
	 * Debugging requires use of the padding between object
	 * and whatever may come after it.
	 */
	if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
		return s->object_size;
# endif
	if (s->flags & SLAB_KASAN)
		return s->object_size;
	/*
	 * If we have the need to store the freelist pointer
	 * back there or track user information then we can
	 * only use the space before that information.
	 */
	if (s->flags & (SLAB_DESTROY_BY_RCU | SLAB_STORE_USER))
		return s->inuse;
	/*
	 * Else we can use all the padding etc for the allocation
	 */
	return s->size;
#endif
}

static inline struct kmem_cache *slab_pre_alloc_hook(struct kmem_cache *s,
						     gfp_t flags)
{
	flags &= gfp_allowed_mask;
	lockdep_trace_alloc(flags);
	might_sleep_if(gfpflags_allow_blocking(flags));

	if (should_failslab(s, flags))
		return NULL;

	if (memcg_kmem_enabled() &&
	    ((flags & __GFP_ACCOUNT) || (s->flags & SLAB_ACCOUNT)))
		return memcg_kmem_get_cache(s);

	return s;
}

static inline void slab_post_alloc_hook(struct kmem_cache *s, gfp_t flags,
					size_t size, void **p)
{
	size_t i;

	flags &= gfp_allowed_mask;
	for (i = 0; i < size; i++) {
		void *object = p[i];

		kmemcheck_slab_alloc(s, flags, object, slab_ksize(s));
		kmemleak_alloc_recursive(object, s->object_size, 1,
					 s->flags, flags);
		kasan_slab_alloc(s, object, flags);
	}

	if (memcg_kmem_enabled())
		memcg_kmem_put_cache(s);
}

#ifndef CONFIG_SLOB
/*
 * The slab lists for all objects.
 */
struct kmem_cache_node {
	spinlock_t list_lock;

#ifdef CONFIG_SLAB
	struct list_head slabs_partial;	/* partial list first, better asm code */
	struct list_head slabs_full;
	struct list_head slabs_free;
	unsigned long total_slabs;	/* length of all slab lists */
	unsigned long free_slabs;	/* length of free slab list only */
	unsigned long free_objects;
	unsigned int free_limit;
	unsigned int colour_next;	/* Per-node cache coloring */
	struct array_cache *shared;	/* shared per node */
	struct alien_cache **alien;	/* on other nodes */
	unsigned long next_reap;	/* updated without locking */
	int free_touched;		/* updated without locking */
#endif

#ifdef CONFIG_SLUB
	unsigned long nr_partial;
	struct list_head partial;
#ifdef CONFIG_SLUB_DEBUG
	atomic_long_t nr_slabs;
	atomic_long_t total_objects;
	struct list_head full;
#endif
#endif

};

static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
{
	return s->node[node];
}

/*
 * Iterator over all nodes. The body will be executed for each node that has
 * a kmem_cache_node structure allocated (which is true for all online nodes)
 */
#define for_each_kmem_cache_node(__s, __node, __n) \
	for (__node = 0; __node < nr_node_ids; __node++) \
		 if ((__n = get_node(__s, __node)))

#endif

void *slab_start(struct seq_file *m, loff_t *pos);
void *slab_next(struct seq_file *m, void *p, loff_t *pos);
void slab_stop(struct seq_file *m, void *p);
void *memcg_slab_start(struct seq_file *m, loff_t *pos);
void *memcg_slab_next(struct seq_file *m, void *p, loff_t *pos);
void memcg_slab_stop(struct seq_file *m, void *p);
int memcg_slab_show(struct seq_file *m, void *p);

void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);

#ifdef CONFIG_SLAB_FREELIST_RANDOM
int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
			gfp_t gfp);
void cache_random_seq_destroy(struct kmem_cache *cachep);
#else
static inline int cache_random_seq_create(struct kmem_cache *cachep,
					unsigned int count, gfp_t gfp)
{
	return 0;
}
static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
#endif /* CONFIG_SLAB_FREELIST_RANDOM */

#endif /* MM_SLAB_H */
Commit	Line	Data
97d06609 CL	1	#ifndef MM_SLAB_H
	2	#define MM_SLAB_H
	3	/*
	4	* Internal slab definitions
	5	*/
	6
07f361b2 JK	7	#ifdef CONFIG_SLOB
	8	/*
	9	* Common fields provided in kmem_cache by all slab allocators
	10	* This struct is either used directly by the allocator (SLOB)
	11	* or the allocator must include definitions for all fields
	12	* provided in kmem_cache_common in their definition of kmem_cache.
	13	*
	14	* Once we can do anonymous structs (C11 standard) we could put a
	15	* anonymous struct definition in these allocators so that the
	16	* separate allocations in the kmem_cache structure of SLAB and
	17	* SLUB is no longer needed.
	18	*/
	19	struct kmem_cache {
	20	unsigned int object_size;/* The original size of the object */
	21	unsigned int size; /* The aligned/padded/added on size */
	22	unsigned int align; /* Alignment as calculated */
	23	unsigned long flags; /* Active flags on the slab */
	24	const char name; / Slab name for sysfs */
	25	int refcount; /* Use counter */
	26	void (ctor)(void ); /* Called on object slot creation */
	27	struct list_head list; /* List of all slab caches on the system */
	28	};
	29
	30	#endif /* CONFIG_SLOB */
	31
	32	#ifdef CONFIG_SLAB
	33	#include <linux/slab_def.h>
	34	#endif
	35
	36	#ifdef CONFIG_SLUB
	37	#include <linux/slub_def.h>
	38	#endif
	39
	40	#include <linux/memcontrol.h>
11c7aec2 JDB	41	#include <linux/fault-inject.h>
	42	#include <linux/kmemcheck.h>
	43	#include <linux/kasan.h>
	44	#include <linux/kmemleak.h>
7c00fce9	45	#include <linux/random.h>
07f361b2	46
97d06609 CL	47	/*
	48	* State of the slab allocator.
	49	*
	50	* This is used to describe the states of the allocator during bootup.
	51	* Allocators use this to gradually bootstrap themselves. Most allocators
	52	* have the problem that the structures used for managing slab caches are
	53	* allocated from slab caches themselves.
	54	*/
	55	enum slab_state {
	56	DOWN, /* No slab functionality yet */
	57	PARTIAL, /* SLUB: kmem_cache_node available */
ce8eb6c4	58	PARTIAL_NODE, /* SLAB: kmalloc size for node struct available */
97d06609 CL	59	UP, /* Slab caches usable but not all extras yet */
	60	FULL /* Everything is working */
	61	};
	62
	63	extern enum slab_state slab_state;
	64
18004c5d CL	65	/* The slab cache mutex protects the management structures during changes */
18004c5d CL	66	extern struct mutex slab_mutex;
9b030cb8 CL	67
9b030cb8 CL	68	/* The list of all slab caches on the system */
18004c5d CL	69	extern struct list_head slab_caches;
18004c5d CL	70
9b030cb8 CL	71	/* The slab cache that manages slab cache information */
	72	extern struct kmem_cache *kmem_cache;
	73
af3b5f87 VB	74	/* A table of kmalloc cache names and sizes */
	75	extern const struct kmalloc_info_struct {
	76	const char *name;
	77	unsigned long size;
	78	} kmalloc_info[];
	79
45906855 CL	80	unsigned long calculate_alignment(unsigned long flags,
	81	unsigned long align, unsigned long size);
	82
f97d5f63 CL	83	#ifndef CONFIG_SLOB
f97d5f63 CL	84	/* Kmalloc array related functions */
34cc6990	85	void setup_kmalloc_cache_index_table(void);
f97d5f63	86	void create_kmalloc_caches(unsigned long);
2c59dd65 CL	87
	88	/* Find the kmalloc slab corresponding for a certain size */
	89	struct kmem_cache *kmalloc_slab(size_t, gfp_t);
f97d5f63 CL	90	#endif
	91
	92
9b030cb8	93	/* Functions provided by the slab allocators */
8a13a4cc	94	extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags);
97d06609	95
45530c44 CL	96	extern struct kmem_cache create_kmalloc_cache(const char name, size_t size,
	97	unsigned long flags);
	98	extern void create_boot_cache(struct kmem_cache , const char name,
	99	size_t size, unsigned long flags);
	100
423c929c JK	101	int slab_unmergeable(struct kmem_cache *s);
	102	struct kmem_cache *find_mergeable(size_t size, size_t align,
	103	unsigned long flags, const char name, void (ctor)(void *));
12220dea	104	#ifndef CONFIG_SLOB
2633d7a0	105	struct kmem_cache *
a44cb944 VD	106	__kmem_cache_alias(const char *name, size_t size, size_t align,
a44cb944 VD	107	unsigned long flags, void (ctor)(void ));
423c929c JK	108
	109	unsigned long kmem_cache_flags(unsigned long object_size,
	110	unsigned long flags, const char *name,
	111	void (ctor)(void ));
cbb79694	112	#else
2633d7a0	113	static inline struct kmem_cache *
a44cb944 VD	114	__kmem_cache_alias(const char *name, size_t size, size_t align,
a44cb944 VD	115	unsigned long flags, void (ctor)(void ))
cbb79694	116	{ return NULL; }
423c929c JK	117
	118	static inline unsigned long kmem_cache_flags(unsigned long object_size,
	119	unsigned long flags, const char *name,
	120	void (ctor)(void ))
	121	{
	122	return flags;
	123	}
cbb79694 CL	124	#endif
	125
	126
d8843922 GC	127	/* Legal flag mask for kmem_cache_create(), for various configurations */
	128	#define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN \| SLAB_CACHE_DMA \| SLAB_PANIC \| \
	129	SLAB_DESTROY_BY_RCU \| SLAB_DEBUG_OBJECTS )
	130
	131	#if defined(CONFIG_DEBUG_SLAB)
	132	#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE \| SLAB_POISON \| SLAB_STORE_USER)
	133	#elif defined(CONFIG_SLUB_DEBUG)
	134	#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE \| SLAB_POISON \| SLAB_STORE_USER \| \
becfda68	135	SLAB_TRACE \| SLAB_CONSISTENCY_CHECKS)
d8843922 GC	136	#else
	137	#define SLAB_DEBUG_FLAGS (0)
	138	#endif
	139
	140	#if defined(CONFIG_SLAB)
	141	#define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD \| SLAB_NOLEAKTRACE \| \
230e9fc2 VD	142	SLAB_RECLAIM_ACCOUNT \| SLAB_TEMPORARY \| \
230e9fc2 VD	143	SLAB_NOTRACK \| SLAB_ACCOUNT)
d8843922 GC	144	#elif defined(CONFIG_SLUB)
d8843922 GC	145	#define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE \| SLAB_RECLAIM_ACCOUNT \| \
230e9fc2	146	SLAB_TEMPORARY \| SLAB_NOTRACK \| SLAB_ACCOUNT)
d8843922 GC	147	#else
	148	#define SLAB_CACHE_FLAGS (0)
	149	#endif
	150
e70954fd	151	/* Common flags available with current configuration */
d8843922 GC	152	#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS \| SLAB_DEBUG_FLAGS \| SLAB_CACHE_FLAGS)
d8843922 GC	153
e70954fd TG	154	/* Common flags permitted for kmem_cache_create */
	155	#define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS \| \
	156	SLAB_RED_ZONE \| \
	157	SLAB_POISON \| \
	158	SLAB_STORE_USER \| \
	159	SLAB_TRACE \| \
	160	SLAB_CONSISTENCY_CHECKS \| \
	161	SLAB_MEM_SPREAD \| \
	162	SLAB_NOLEAKTRACE \| \
	163	SLAB_RECLAIM_ACCOUNT \| \
	164	SLAB_TEMPORARY \| \
	165	SLAB_NOTRACK \| \
	166	SLAB_ACCOUNT)
	167
945cf2b6	168	int __kmem_cache_shutdown(struct kmem_cache *);
52b4b950	169	void __kmem_cache_release(struct kmem_cache *);
c9fc5864 TH	170	int __kmem_cache_shrink(struct kmem_cache *);
c9fc5864 TH	171	void __kmemcg_cache_deactivate(struct kmem_cache *s);
41a21285	172	void slab_kmem_cache_release(struct kmem_cache *);
945cf2b6	173
b7454ad3 GC	174	struct seq_file;
b7454ad3 GC	175	struct file;
b7454ad3	176
0d7561c6 GC	177	struct slabinfo {
	178	unsigned long active_objs;
	179	unsigned long num_objs;
	180	unsigned long active_slabs;
	181	unsigned long num_slabs;
	182	unsigned long shared_avail;
	183	unsigned int limit;
	184	unsigned int batchcount;
	185	unsigned int shared;
	186	unsigned int objects_per_slab;
	187	unsigned int cache_order;
	188	};
	189
	190	void get_slabinfo(struct kmem_cache s, struct slabinfo sinfo);
	191	void slabinfo_show_stats(struct seq_file m, struct kmem_cache s);
b7454ad3 GC	192	ssize_t slabinfo_write(struct file file, const char __user buffer,
b7454ad3 GC	193	size_t count, loff_t *ppos);
ba6c496e	194
484748f0 CL	195	/*
	196	* Generic implementation of bulk operations
	197	* These are useful for situations in which the allocator cannot
9f706d68	198	* perform optimizations. In that case segments of the object listed
484748f0 CL	199	* may be allocated or freed using these operations.
	200	*/
	201	void __kmem_cache_free_bulk(struct kmem_cache , size_t, void *);
865762a8	202	int __kmem_cache_alloc_bulk(struct kmem_cache , gfp_t, size_t, void *);
484748f0	203
127424c8	204	#if defined(CONFIG_MEMCG) && !defined(CONFIG_SLOB)
510ded33 TH	205
	206	/* List of all root caches. */
	207	extern struct list_head slab_root_caches;
	208	#define root_caches_node memcg_params.__root_caches_node
	209
426589f5 VD	210	/*
	211	* Iterate over all memcg caches of the given root cache. The caller must hold
	212	* slab_mutex.
	213	*/
	214	#define for_each_memcg_cache(iter, root) \
9eeadc8b TH	215	list_for_each_entry(iter, &(root)->memcg_params.children, \
9eeadc8b TH	216	memcg_params.children_node)
426589f5	217
ba6c496e GC	218	static inline bool is_root_cache(struct kmem_cache *s)
ba6c496e GC	219	{
9eeadc8b	220	return !s->memcg_params.root_cache;
ba6c496e	221	}
2633d7a0	222
b9ce5ef4	223	static inline bool slab_equal_or_root(struct kmem_cache *s,
f7ce3190	224	struct kmem_cache *p)
b9ce5ef4	225	{
f7ce3190	226	return p == s \|\| p == s->memcg_params.root_cache;
b9ce5ef4	227	}
749c5415 GC	228
	229	/*
	230	* We use suffixes to the name in memcg because we can't have caches
	231	* created in the system with the same name. But when we print them
	232	* locally, better refer to them with the base name
	233	*/
	234	static inline const char cache_name(struct kmem_cache s)
	235	{
	236	if (!is_root_cache(s))
f7ce3190	237	s = s->memcg_params.root_cache;
749c5415 GC	238	return s->name;
	239	}
	240
f8570263 VD	241	/*
f8570263 VD	242	* Note, we protect with RCU only the memcg_caches array, not per-memcg caches.
f7ce3190 VD	243	* That said the caller must assure the memcg's cache won't go away by either
f7ce3190 VD	244	* taking a css reference to the owner cgroup, or holding the slab_mutex.
f8570263	245	*/
2ade4de8 QH	246	static inline struct kmem_cache *
2ade4de8 QH	247	cache_from_memcg_idx(struct kmem_cache *s, int idx)
749c5415	248	{
959c8963	249	struct kmem_cache *cachep;
f7ce3190	250	struct memcg_cache_array *arr;
f8570263 VD	251
f8570263 VD	252	rcu_read_lock();
f7ce3190	253	arr = rcu_dereference(s->memcg_params.memcg_caches);
959c8963 VD	254
	255	/*
	256	* Make sure we will access the up-to-date value. The code updating
	257	* memcg_caches issues a write barrier to match this (see
f7ce3190	258	* memcg_create_kmem_cache()).
959c8963	259	*/
f7ce3190	260	cachep = lockless_dereference(arr->entries[idx]);
8df0c2dc PK	261	rcu_read_unlock();
8df0c2dc PK	262
959c8963	263	return cachep;
749c5415	264	}
943a451a GC	265
	266	static inline struct kmem_cache memcg_root_cache(struct kmem_cache s)
	267	{
	268	if (is_root_cache(s))
	269	return s;
f7ce3190	270	return s->memcg_params.root_cache;
943a451a	271	}
5dfb4175	272
f3ccb2c4 VD	273	static __always_inline int memcg_charge_slab(struct page *page,
	274	gfp_t gfp, int order,
	275	struct kmem_cache *s)
5dfb4175	276	{
27ee57c9 VD	277	int ret;
27ee57c9 VD	278
5dfb4175 VD	279	if (!memcg_kmem_enabled())
	280	return 0;
	281	if (is_root_cache(s))
	282	return 0;
27ee57c9	283
45264778	284	ret = memcg_kmem_charge_memcg(page, gfp, order, s->memcg_params.memcg);
27ee57c9 VD	285	if (ret)
	286	return ret;
	287
	288	memcg_kmem_update_page_stat(page,
	289	(s->flags & SLAB_RECLAIM_ACCOUNT) ?
	290	MEMCG_SLAB_RECLAIMABLE : MEMCG_SLAB_UNRECLAIMABLE,
	291	1 << order);
	292	return 0;
	293	}
	294
	295	static __always_inline void memcg_uncharge_slab(struct page *page, int order,
	296	struct kmem_cache *s)
	297	{
45264778 VD	298	if (!memcg_kmem_enabled())
	299	return;
	300
27ee57c9 VD	301	memcg_kmem_update_page_stat(page,
	302	(s->flags & SLAB_RECLAIM_ACCOUNT) ?
	303	MEMCG_SLAB_RECLAIMABLE : MEMCG_SLAB_UNRECLAIMABLE,
	304	-(1 << order));
	305	memcg_kmem_uncharge(page, order);
5dfb4175	306	}
f7ce3190 VD	307
f7ce3190 VD	308	extern void slab_init_memcg_params(struct kmem_cache *);
510ded33	309	extern void memcg_link_cache(struct kmem_cache *s);
f7ce3190	310
127424c8	311	#else /* CONFIG_MEMCG && !CONFIG_SLOB */
f7ce3190	312
510ded33 TH	313	/* If !memcg, all caches are root. */
	314	#define slab_root_caches slab_caches
	315	#define root_caches_node list
	316
426589f5 VD	317	#define for_each_memcg_cache(iter, root) \
426589f5 VD	318	for ((void)(iter), (void)(root); 0; )
426589f5	319
ba6c496e GC	320	static inline bool is_root_cache(struct kmem_cache *s)
	321	{
	322	return true;
	323	}
	324
b9ce5ef4 GC	325	static inline bool slab_equal_or_root(struct kmem_cache *s,
	326	struct kmem_cache *p)
	327	{
	328	return true;
	329	}
749c5415 GC	330
	331	static inline const char cache_name(struct kmem_cache s)
	332	{
	333	return s->name;
	334	}
	335
2ade4de8 QH	336	static inline struct kmem_cache *
2ade4de8 QH	337	cache_from_memcg_idx(struct kmem_cache *s, int idx)
749c5415 GC	338	{
	339	return NULL;
	340	}
943a451a GC	341
	342	static inline struct kmem_cache memcg_root_cache(struct kmem_cache s)
	343	{
	344	return s;
	345	}
5dfb4175	346
f3ccb2c4 VD	347	static inline int memcg_charge_slab(struct page *page, gfp_t gfp, int order,
f3ccb2c4 VD	348	struct kmem_cache *s)
5dfb4175 VD	349	{
	350	return 0;
	351	}
	352
27ee57c9 VD	353	static inline void memcg_uncharge_slab(struct page *page, int order,
	354	struct kmem_cache *s)
	355	{
	356	}
	357
f7ce3190 VD	358	static inline void slab_init_memcg_params(struct kmem_cache *s)
	359	{
	360	}
510ded33 TH	361
	362	static inline void memcg_link_cache(struct kmem_cache *s)
	363	{
	364	}
	365
127424c8	366	#endif /* CONFIG_MEMCG && !CONFIG_SLOB */
b9ce5ef4 GC	367
	368	static inline struct kmem_cache cache_from_obj(struct kmem_cache s, void *x)
	369	{
	370	struct kmem_cache *cachep;
	371	struct page *page;
	372
	373	/*
	374	* When kmemcg is not being used, both assignments should return the
	375	* same value. but we don't want to pay the assignment price in that
	376	* case. If it is not compiled in, the compiler should be smart enough
	377	* to not do even the assignment. In that case, slab_equal_or_root
	378	* will also be a constant.
	379	*/
becfda68 LA	380	if (!memcg_kmem_enabled() &&
becfda68 LA	381	!unlikely(s->flags & SLAB_CONSISTENCY_CHECKS))
b9ce5ef4 GC	382	return s;
	383
	384	page = virt_to_head_page(x);
	385	cachep = page->slab_cache;
	386	if (slab_equal_or_root(cachep, s))
	387	return cachep;
	388
	389	pr_err("%s: Wrong slab cache. %s but object is from %s\n",
2d16e0fd	390	__func__, s->name, cachep->name);
b9ce5ef4 GC	391	WARN_ON_ONCE(1);
	392	return s;
	393	}
ca34956b	394
11c7aec2 JDB	395	static inline size_t slab_ksize(const struct kmem_cache *s)
	396	{
	397	#ifndef CONFIG_SLUB
	398	return s->object_size;
	399
	400	#else /* CONFIG_SLUB */
	401	# ifdef CONFIG_SLUB_DEBUG
	402	/*
	403	* Debugging requires use of the padding between object
	404	* and whatever may come after it.
	405	*/
	406	if (s->flags & (SLAB_RED_ZONE \| SLAB_POISON))
	407	return s->object_size;
	408	# endif
80a9201a AP	409	if (s->flags & SLAB_KASAN)
80a9201a AP	410	return s->object_size;
11c7aec2 JDB	411	/*
	412	* If we have the need to store the freelist pointer
	413	* back there or track user information then we can
	414	* only use the space before that information.
	415	*/
	416	if (s->flags & (SLAB_DESTROY_BY_RCU \| SLAB_STORE_USER))
	417	return s->inuse;
	418	/*
	419	* Else we can use all the padding etc for the allocation
	420	*/
	421	return s->size;
	422	#endif
	423	}
	424
	425	static inline struct kmem_cache slab_pre_alloc_hook(struct kmem_cache s,
	426	gfp_t flags)
	427	{
	428	flags &= gfp_allowed_mask;
	429	lockdep_trace_alloc(flags);
	430	might_sleep_if(gfpflags_allow_blocking(flags));
	431
fab9963a	432	if (should_failslab(s, flags))
11c7aec2 JDB	433	return NULL;
11c7aec2 JDB	434
45264778 VD	435	if (memcg_kmem_enabled() &&
	436	((flags & __GFP_ACCOUNT) \|\| (s->flags & SLAB_ACCOUNT)))
	437	return memcg_kmem_get_cache(s);
	438
	439	return s;
11c7aec2 JDB	440	}
	441
	442	static inline void slab_post_alloc_hook(struct kmem_cache *s, gfp_t flags,
	443	size_t size, void **p)
	444	{
	445	size_t i;
	446
	447	flags &= gfp_allowed_mask;
	448	for (i = 0; i < size; i++) {
	449	void *object = p[i];
	450
	451	kmemcheck_slab_alloc(s, flags, object, slab_ksize(s));
	452	kmemleak_alloc_recursive(object, s->object_size, 1,
	453	s->flags, flags);
505f5dcb	454	kasan_slab_alloc(s, object, flags);
11c7aec2	455	}
45264778 VD	456
	457	if (memcg_kmem_enabled())
	458	memcg_kmem_put_cache(s);
11c7aec2 JDB	459	}
11c7aec2 JDB	460
44c5356f	461	#ifndef CONFIG_SLOB
ca34956b CL	462	/*
	463	* The slab lists for all objects.
	464	*/
	465	struct kmem_cache_node {
	466	spinlock_t list_lock;
	467
	468	#ifdef CONFIG_SLAB
	469	struct list_head slabs_partial; /* partial list first, better asm code */
	470	struct list_head slabs_full;
	471	struct list_head slabs_free;
bf00bd34 DR	472	unsigned long total_slabs; /* length of all slab lists */
bf00bd34 DR	473	unsigned long free_slabs; /* length of free slab list only */
ca34956b CL	474	unsigned long free_objects;
	475	unsigned int free_limit;
	476	unsigned int colour_next; /* Per-node cache coloring */
	477	struct array_cache shared; / shared per node */
c8522a3a	478	struct alien_cache *alien; / on other nodes */
ca34956b CL	479	unsigned long next_reap; /* updated without locking */
	480	int free_touched; /* updated without locking */
	481	#endif
	482
	483	#ifdef CONFIG_SLUB
	484	unsigned long nr_partial;
	485	struct list_head partial;
	486	#ifdef CONFIG_SLUB_DEBUG
	487	atomic_long_t nr_slabs;
	488	atomic_long_t total_objects;
	489	struct list_head full;
	490	#endif
	491	#endif
	492
	493	};
e25839f6	494
44c5356f CL	495	static inline struct kmem_cache_node get_node(struct kmem_cache s, int node)
	496	{
	497	return s->node[node];
	498	}
	499
	500	/*
	501	* Iterator over all nodes. The body will be executed for each node that has
	502	* a kmem_cache_node structure allocated (which is true for all online nodes)
	503	*/
	504	#define for_each_kmem_cache_node(__s, __node, __n) \
9163582c MP	505	for (__node = 0; __node < nr_node_ids; __node++) \
9163582c MP	506	if ((__n = get_node(__s, __node)))
44c5356f CL	507
	508	#endif
	509
1df3b26f	510	void slab_start(struct seq_file m, loff_t *pos);
276a2439 WL	511	void slab_next(struct seq_file m, void p, loff_t pos);
276a2439 WL	512	void slab_stop(struct seq_file m, void p);
bc2791f8 TH	513	void memcg_slab_start(struct seq_file m, loff_t *pos);
	514	void memcg_slab_next(struct seq_file m, void p, loff_t pos);
	515	void memcg_slab_stop(struct seq_file m, void p);
b047501c	516	int memcg_slab_show(struct seq_file m, void p);
5240ab40	517
55834c59 AP	518	void ___cache_free(struct kmem_cache cache, void x, unsigned long addr);
55834c59 AP	519
7c00fce9 TG	520	#ifdef CONFIG_SLAB_FREELIST_RANDOM
	521	int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
	522	gfp_t gfp);
	523	void cache_random_seq_destroy(struct kmem_cache *cachep);
	524	#else
	525	static inline int cache_random_seq_create(struct kmem_cache *cachep,
	526	unsigned int count, gfp_t gfp)
	527	{
	528	return 0;
	529	}
	530	static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
	531	#endif /* CONFIG_SLAB_FREELIST_RANDOM */
	532
5240ab40	533	#endif /* MM_SLAB_H */