[mirror_ubuntu-jammy-kernel.git] / include / linux / slab.h

/*
 * linux/mm/slab.h
 * Written by Mark Hemment, 1996.
 * (markhe@nextd.demon.co.uk)
 */

#ifndef _LINUX_SLAB_H
#define	_LINUX_SLAB_H

#if	defined(__KERNEL__)

typedef struct kmem_cache kmem_cache_t;

#include	<linux/config.h>	/* kmalloc_sizes.h needs CONFIG_ options */
#include	<linux/gfp.h>
#include	<linux/init.h>
#include	<linux/types.h>
#include	<asm/page.h>		/* kmalloc_sizes.h needs PAGE_SIZE */
#include	<asm/cache.h>		/* kmalloc_sizes.h needs L1_CACHE_BYTES */

/* flags for kmem_cache_alloc() */
#define	SLAB_NOFS		GFP_NOFS
#define	SLAB_NOIO		GFP_NOIO
#define	SLAB_ATOMIC		GFP_ATOMIC
#define	SLAB_USER		GFP_USER
#define	SLAB_KERNEL		GFP_KERNEL
#define	SLAB_DMA		GFP_DMA

#define SLAB_LEVEL_MASK		GFP_LEVEL_MASK

#define	SLAB_NO_GROW		__GFP_NO_GROW	/* don't grow a cache */

/* flags to pass to kmem_cache_create().
 * The first 3 are only valid when the allocator as been build
 * SLAB_DEBUG_SUPPORT.
 */
#define	SLAB_DEBUG_FREE		0x00000100UL	/* Peform (expensive) checks on free */
#define	SLAB_DEBUG_INITIAL	0x00000200UL	/* Call constructor (as verifier) */
#define	SLAB_RED_ZONE		0x00000400UL	/* Red zone objs in a cache */
#define	SLAB_POISON		0x00000800UL	/* Poison objects */
#define	SLAB_HWCACHE_ALIGN	0x00002000UL	/* align objs on a h/w cache lines */
#define SLAB_CACHE_DMA		0x00004000UL	/* use GFP_DMA memory */
#define SLAB_MUST_HWCACHE_ALIGN	0x00008000UL	/* force alignment */
#define SLAB_STORE_USER		0x00010000UL	/* store the last owner for bug hunting */
#define SLAB_RECLAIM_ACCOUNT	0x00020000UL	/* track pages allocated to indicate
						   what is reclaimable later*/
#define SLAB_PANIC		0x00040000UL	/* panic if kmem_cache_create() fails */
#define SLAB_DESTROY_BY_RCU	0x00080000UL	/* defer freeing pages to RCU */
#define SLAB_MEM_SPREAD		0x00100000UL	/* Spread some memory over cpuset */

/* flags passed to a constructor func */
#define	SLAB_CTOR_CONSTRUCTOR	0x001UL		/* if not set, then deconstructor */
#define SLAB_CTOR_ATOMIC	0x002UL		/* tell constructor it can't sleep */
#define	SLAB_CTOR_VERIFY	0x004UL		/* tell constructor it's a verify call */

#ifndef CONFIG_SLOB

/* prototypes */
extern void __init kmem_cache_init(void);

extern kmem_cache_t *kmem_cache_create(const char *, size_t, size_t, unsigned long,
				       void (*)(void *, kmem_cache_t *, unsigned long),
				       void (*)(void *, kmem_cache_t *, unsigned long));
extern int kmem_cache_destroy(kmem_cache_t *);
extern int kmem_cache_shrink(kmem_cache_t *);
extern void *kmem_cache_alloc(kmem_cache_t *, gfp_t);
extern void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
extern void kmem_cache_free(kmem_cache_t *, void *);
extern unsigned int kmem_cache_size(kmem_cache_t *);
extern const char *kmem_cache_name(kmem_cache_t *);
extern kmem_cache_t *kmem_find_general_cachep(size_t size, gfp_t gfpflags);

/* Size description struct for general caches. */
struct cache_sizes {
	size_t		 cs_size;
	kmem_cache_t	*cs_cachep;
	kmem_cache_t	*cs_dmacachep;
};
extern struct cache_sizes malloc_sizes[];

extern void *__kmalloc(size_t, gfp_t);
#ifndef CONFIG_DEBUG_SLAB
#define ____kmalloc(size, flags) __kmalloc(size, flags)
#else
extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
#define ____kmalloc(size, flags) \
    __kmalloc_track_caller(size, flags, __builtin_return_address(0))
#endif

static inline void *kmalloc(size_t size, gfp_t flags)
{
	if (__builtin_constant_p(size)) {
		int i = 0;
#define CACHE(x) \
		if (size <= x) \
			goto found; \
		else \
			i++;
#include "kmalloc_sizes.h"
#undef CACHE
		{
			extern void __you_cannot_kmalloc_that_much(void);
			__you_cannot_kmalloc_that_much();
		}
found:
		return kmem_cache_alloc((flags & GFP_DMA) ?
			malloc_sizes[i].cs_dmacachep :
			malloc_sizes[i].cs_cachep, flags);
	}
	return __kmalloc(size, flags);
}

extern void *__kzalloc(size_t, gfp_t);

static inline void *kzalloc(size_t size, gfp_t flags)
{
	if (__builtin_constant_p(size)) {
		int i = 0;
#define CACHE(x) \
		if (size <= x) \
			goto found; \
		else \
			i++;
#include "kmalloc_sizes.h"
#undef CACHE
		{
			extern void __you_cannot_kzalloc_that_much(void);
			__you_cannot_kzalloc_that_much();
		}
found:
		return kmem_cache_zalloc((flags & GFP_DMA) ?
			malloc_sizes[i].cs_dmacachep :
			malloc_sizes[i].cs_cachep, flags);
	}
	return __kzalloc(size, flags);
}

/**
 * kcalloc - allocate memory for an array. The memory is set to zero.
 * @n: number of elements.
 * @size: element size.
 * @flags: the type of memory to allocate.
 */
static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
{
	if (n != 0 && size > ULONG_MAX / n)
		return NULL;
	return kzalloc(n * size, flags);
}

extern void kfree(const void *);
extern unsigned int ksize(const void *);

#ifdef CONFIG_NUMA
extern void *kmem_cache_alloc_node(kmem_cache_t *, gfp_t flags, int node);
extern void *kmalloc_node(size_t size, gfp_t flags, int node);
#else
static inline void *kmem_cache_alloc_node(kmem_cache_t *cachep, gfp_t flags, int node)
{
	return kmem_cache_alloc(cachep, flags);
}
static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
{
	return kmalloc(size, flags);
}
#endif

extern int FASTCALL(kmem_cache_reap(int));
extern int FASTCALL(kmem_ptr_validate(kmem_cache_t *cachep, void *ptr));

#else /* CONFIG_SLOB */

/* SLOB allocator routines */

void kmem_cache_init(void);
struct kmem_cache *kmem_find_general_cachep(size_t, gfp_t gfpflags);
struct kmem_cache *kmem_cache_create(const char *c, size_t, size_t,
	unsigned long,
	void (*)(void *, struct kmem_cache *, unsigned long),
	void (*)(void *, struct kmem_cache *, unsigned long));
int kmem_cache_destroy(struct kmem_cache *c);
void *kmem_cache_alloc(struct kmem_cache *c, gfp_t flags);
void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
void kmem_cache_free(struct kmem_cache *c, void *b);
const char *kmem_cache_name(struct kmem_cache *);
void *kmalloc(size_t size, gfp_t flags);
void *__kzalloc(size_t size, gfp_t flags);
void kfree(const void *m);
unsigned int ksize(const void *m);
unsigned int kmem_cache_size(struct kmem_cache *c);

static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
{
	return __kzalloc(n * size, flags);
}

#define kmem_cache_shrink(d) (0)
#define kmem_cache_reap(a)
#define kmem_ptr_validate(a, b) (0)
#define kmem_cache_alloc_node(c, f, n) kmem_cache_alloc(c, f)
#define kmalloc_node(s, f, n) kmalloc(s, f)
#define kzalloc(s, f) __kzalloc(s, f)
#define ____kmalloc kmalloc

#endif /* CONFIG_SLOB */

/* System wide caches */
extern kmem_cache_t	*vm_area_cachep;
extern kmem_cache_t	*names_cachep;
extern kmem_cache_t	*files_cachep;
extern kmem_cache_t	*filp_cachep;
extern kmem_cache_t	*fs_cachep;
extern kmem_cache_t	*sighand_cachep;
extern kmem_cache_t	*bio_cachep;

extern atomic_t slab_reclaim_pages;

#endif	/* __KERNEL__ */

#endif	/* _LINUX_SLAB_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/mm/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
2109a2d1	12	typedef struct kmem_cache kmem_cache_t;
1da177e4 LT	13
	14	#include <linux/config.h> /* kmalloc_sizes.h needs CONFIG_ options */
	15	#include <linux/gfp.h>
	16	#include <linux/init.h>
	17	#include <linux/types.h>
	18	#include <asm/page.h> /* kmalloc_sizes.h needs PAGE_SIZE */
	19	#include <asm/cache.h> /* kmalloc_sizes.h needs L1_CACHE_BYTES */
	20
	21	/* flags for kmem_cache_alloc() */
	22	#define SLAB_NOFS GFP_NOFS
	23	#define SLAB_NOIO GFP_NOIO
	24	#define SLAB_ATOMIC GFP_ATOMIC
	25	#define SLAB_USER GFP_USER
	26	#define SLAB_KERNEL GFP_KERNEL
	27	#define SLAB_DMA GFP_DMA
	28
	29	#define SLAB_LEVEL_MASK GFP_LEVEL_MASK
	30
	31	#define SLAB_NO_GROW __GFP_NO_GROW /* don't grow a cache */
	32
	33	/* flags to pass to kmem_cache_create().
	34	* The first 3 are only valid when the allocator as been build
	35	* SLAB_DEBUG_SUPPORT.
	36	*/
	37	#define SLAB_DEBUG_FREE 0x00000100UL /* Peform (expensive) checks on free */
	38	#define SLAB_DEBUG_INITIAL 0x00000200UL /* Call constructor (as verifier) */
	39	#define SLAB_RED_ZONE 0x00000400UL /* Red zone objs in a cache */
	40	#define SLAB_POISON 0x00000800UL /* Poison objects */
1da177e4 LT	41	#define SLAB_HWCACHE_ALIGN 0x00002000UL /* align objs on a h/w cache lines */
	42	#define SLAB_CACHE_DMA 0x00004000UL /* use GFP_DMA memory */
	43	#define SLAB_MUST_HWCACHE_ALIGN 0x00008000UL /* force alignment */
	44	#define SLAB_STORE_USER 0x00010000UL /* store the last owner for bug hunting */
	45	#define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* track pages allocated to indicate
	46	what is reclaimable later*/
	47	#define SLAB_PANIC 0x00040000UL /* panic if kmem_cache_create() fails */
	48	#define SLAB_DESTROY_BY_RCU 0x00080000UL /* defer freeing pages to RCU */
101a5001	49	#define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */
1da177e4 LT	50
	51	/* flags passed to a constructor func */
	52	#define SLAB_CTOR_CONSTRUCTOR 0x001UL /* if not set, then deconstructor */
	53	#define SLAB_CTOR_ATOMIC 0x002UL /* tell constructor it can't sleep */
	54	#define SLAB_CTOR_VERIFY 0x004UL /* tell constructor it's a verify call */
	55
10cef602 MM	56	#ifndef CONFIG_SLOB
10cef602 MM	57
1da177e4 LT	58	/* prototypes */
	59	extern void __init kmem_cache_init(void);
	60
	61	extern kmem_cache_t kmem_cache_create(const char , size_t, size_t, unsigned long,
	62	void ()(void , kmem_cache_t *, unsigned long),
	63	void ()(void , kmem_cache_t *, unsigned long));
	64	extern int kmem_cache_destroy(kmem_cache_t *);
	65	extern int kmem_cache_shrink(kmem_cache_t *);
dd0fc66f	66	extern void kmem_cache_alloc(kmem_cache_t , gfp_t);
a8c0f9a4	67	extern void kmem_cache_zalloc(struct kmem_cache , gfp_t);
1da177e4 LT	68	extern void kmem_cache_free(kmem_cache_t , void );
1da177e4 LT	69	extern unsigned int kmem_cache_size(kmem_cache_t *);
1944972d	70	extern const char kmem_cache_name(kmem_cache_t );
dd0fc66f	71	extern kmem_cache_t *kmem_find_general_cachep(size_t size, gfp_t gfpflags);
1da177e4 LT	72
	73	/* Size description struct for general caches. */
	74	struct cache_sizes {
	75	size_t cs_size;
	76	kmem_cache_t *cs_cachep;
	77	kmem_cache_t *cs_dmacachep;
	78	};
	79	extern struct cache_sizes malloc_sizes[];
7fd6b141	80
dd0fc66f	81	extern void *__kmalloc(size_t, gfp_t);
871751e2 AV	82	#ifndef CONFIG_DEBUG_SLAB
871751e2 AV	83	#define ____kmalloc(size, flags) __kmalloc(size, flags)
7fd6b141 PE	84	#else
7fd6b141 PE	85	extern void __kmalloc_track_caller(size_t, gfp_t, void);
871751e2	86	#define ____kmalloc(size, flags) \
7fd6b141 PE	87	__kmalloc_track_caller(size, flags, __builtin_return_address(0))
7fd6b141 PE	88	#endif
1da177e4	89
dd0fc66f	90	static inline void *kmalloc(size_t size, gfp_t flags)
1da177e4 LT	91	{
	92	if (__builtin_constant_p(size)) {
	93	int i = 0;
	94	#define CACHE(x) \
	95	if (size <= x) \
	96	goto found; \
	97	else \
	98	i++;
	99	#include "kmalloc_sizes.h"
	100	#undef CACHE
	101	{
	102	extern void __you_cannot_kmalloc_that_much(void);
	103	__you_cannot_kmalloc_that_much();
	104	}
	105	found:
	106	return kmem_cache_alloc((flags & GFP_DMA) ?
	107	malloc_sizes[i].cs_dmacachep :
	108	malloc_sizes[i].cs_cachep, flags);
	109	}
	110	return __kmalloc(size, flags);
	111	}
	112
40c07ae8 PE	113	extern void *__kzalloc(size_t, gfp_t);
	114
	115	static inline void *kzalloc(size_t size, gfp_t flags)
	116	{
	117	if (__builtin_constant_p(size)) {
	118	int i = 0;
	119	#define CACHE(x) \
	120	if (size <= x) \
	121	goto found; \
	122	else \
	123	i++;
	124	#include "kmalloc_sizes.h"
	125	#undef CACHE
	126	{
	127	extern void __you_cannot_kzalloc_that_much(void);
	128	__you_cannot_kzalloc_that_much();
	129	}
	130	found:
	131	return kmem_cache_zalloc((flags & GFP_DMA) ?
	132	malloc_sizes[i].cs_dmacachep :
	133	malloc_sizes[i].cs_cachep, flags);
	134	}
	135	return __kzalloc(size, flags);
	136	}
dd392710 PE	137
	138	/**
	139	* kcalloc - allocate memory for an array. The memory is set to zero.
	140	* @n: number of elements.
	141	* @size: element size.
	142	* @flags: the type of memory to allocate.
	143	*/
dd0fc66f	144	static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
dd392710	145	{
b50ec7d8	146	if (n != 0 && size > ULONG_MAX / n)
dd392710 PE	147	return NULL;
	148	return kzalloc(n * size, flags);
	149	}
	150
1da177e4 LT	151	extern void kfree(const void *);
	152	extern unsigned int ksize(const void *);
	153
97e2bde4	154	#ifdef CONFIG_NUMA
dd0fc66f AV	155	extern void kmem_cache_alloc_node(kmem_cache_t , gfp_t flags, int node);
dd0fc66f AV	156	extern void *kmalloc_node(size_t size, gfp_t flags, int node);
97e2bde4	157	#else
6daa0e28	158	static inline void kmem_cache_alloc_node(kmem_cache_t cachep, gfp_t flags, int node)
97e2bde4 MS	159	{
	160	return kmem_cache_alloc(cachep, flags);
	161	}
dd0fc66f	162	static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
97e2bde4 MS	163	{
	164	return kmalloc(size, flags);
	165	}
	166	#endif
	167
1da177e4 LT	168	extern int FASTCALL(kmem_cache_reap(int));
	169	extern int FASTCALL(kmem_ptr_validate(kmem_cache_t cachep, void ptr));
	170
10cef602 MM	171	#else /* CONFIG_SLOB */
	172
	173	/* SLOB allocator routines */
	174
	175	void kmem_cache_init(void);
	176	struct kmem_cache *kmem_find_general_cachep(size_t, gfp_t gfpflags);
	177	struct kmem_cache kmem_cache_create(const char c, size_t, size_t,
	178	unsigned long,
	179	void ()(void , struct kmem_cache *, unsigned long),
	180	void ()(void , struct kmem_cache *, unsigned long));
	181	int kmem_cache_destroy(struct kmem_cache *c);
	182	void kmem_cache_alloc(struct kmem_cache c, gfp_t flags);
a8c0f9a4	183	void kmem_cache_zalloc(struct kmem_cache , gfp_t);
10cef602 MM	184	void kmem_cache_free(struct kmem_cache c, void b);
	185	const char kmem_cache_name(struct kmem_cache );
	186	void *kmalloc(size_t size, gfp_t flags);
40c07ae8	187	void *__kzalloc(size_t size, gfp_t flags);
10cef602 MM	188	void kfree(const void *m);
	189	unsigned int ksize(const void *m);
	190	unsigned int kmem_cache_size(struct kmem_cache *c);
	191
	192	static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
	193	{
40c07ae8	194	return __kzalloc(n * size, flags);
10cef602 MM	195	}
	196
	197	#define kmem_cache_shrink(d) (0)
	198	#define kmem_cache_reap(a)
	199	#define kmem_ptr_validate(a, b) (0)
	200	#define kmem_cache_alloc_node(c, f, n) kmem_cache_alloc(c, f)
	201	#define kmalloc_node(s, f, n) kmalloc(s, f)
40c07ae8	202	#define kzalloc(s, f) __kzalloc(s, f)
871751e2	203	#define ____kmalloc kmalloc
10cef602 MM	204
	205	#endif /* CONFIG_SLOB */
	206
1da177e4 LT	207	/* System wide caches */
	208	extern kmem_cache_t *vm_area_cachep;
	209	extern kmem_cache_t *names_cachep;
	210	extern kmem_cache_t *files_cachep;
	211	extern kmem_cache_t *filp_cachep;
	212	extern kmem_cache_t *fs_cachep;
1da177e4 LT	213	extern kmem_cache_t *sighand_cachep;
	214	extern kmem_cache_t *bio_cachep;
	215
	216	extern atomic_t slab_reclaim_pages;
	217
	218	#endif /* __KERNEL__ */
	219
	220	#endif /* _LINUX_SLAB_H */