[linux.git] / mm / slab.h

/* SPDX-License-Identifier: GPL-2.0 */
#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>
#include <linux/sched/mm.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_TYPESAFE_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 = READ_ONCE(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)
{
	if (!memcg_kmem_enabled())
		return 0;
	if (is_root_cache(s))
		return 0;
	return memcg_kmem_charge_memcg(page, gfp, order, s->memcg_params.memcg);
}

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

extern void slab_init_memcg_params(struct kmem_cache *);
extern void memcg_link_cache(struct kmem_cache *s);
extern void slab_deactivate_memcg_cache_rcu_sched(struct kmem_cache *s,
				void (*deact_fn)(struct kmem_cache *));

#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_TYPESAFE_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;

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