[mirror_spl.git] / include / sys / kmem.h

/*
 *  This file is part of the SPL: Solaris Porting Layer.
 *
 *  Copyright (c) 2008 Lawrence Livermore National Security, LLC.
 *  Produced at Lawrence Livermore National Laboratory
 *  Written by:
 *          Brian Behlendorf <behlendorf1@llnl.gov>,
 *          Herb Wartens <wartens2@llnl.gov>,
 *          Jim Garlick <garlick@llnl.gov>
 *  UCRL-CODE-235197
 *
 *  This is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 */

#ifndef _SPL_KMEM_H
#define	_SPL_KMEM_H

#ifdef	__cplusplus
extern "C" {
#endif

#undef DEBUG_KMEM_UNIMPLEMENTED
#undef DEBUG_KMEM_TRACKING /* Per-allocation memory tracking */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/mm.h>
#include <linux/spinlock.h>
#include <linux/rwsem.h>
#include <linux/hash.h>
#include <linux/ctype.h>
#include <asm/atomic_compat.h>
#include <sys/types.h>
#include <sys/debug.h>

/*
 * Memory allocation interfaces
 */
#define KM_SLEEP                        (GFP_KERNEL | __GFP_NOFAIL)
#define KM_NOSLEEP                      GFP_ATOMIC
#undef  KM_PANIC                        /* No linux analog */
#define KM_PUSHPAGE                     (KM_SLEEP | __GFP_HIGH)
#define KM_VMFLAGS                      GFP_LEVEL_MASK
#define KM_FLAGS                        __GFP_BITS_MASK

/*
 * Used internally, the kernel does not need to support this flag
 */
#ifndef __GFP_ZERO
# define __GFP_ZERO                     0x8000
#endif

#ifdef DEBUG_KMEM

extern atomic64_t kmem_alloc_used;
extern unsigned long long kmem_alloc_max;
extern atomic64_t vmem_alloc_used;
extern unsigned long long vmem_alloc_max;

# define kmem_alloc(size, flags)             __kmem_alloc((size), (flags), 0, 0)
# define kmem_zalloc(size, flags)            __kmem_alloc((size), ((flags) |  \
                                                 __GFP_ZERO), 0, 0)

/* The node alloc functions are only used by the SPL code itself */
# ifdef HAVE_KMALLOC_NODE
#  define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 1, \
                                                 node)
# else
#  define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 0, 0)
# endif

# define vmem_zalloc(size, flags)            vmem_alloc((size), ((flags) |    \
                                                 __GFP_ZERO))

# ifdef DEBUG_KMEM_TRACKING

extern void *kmem_alloc_track(size_t size, int flags, const char *func,
    int line, int node_alloc, int node);
extern void kmem_free_track(void *ptr, size_t size);
extern void *vmem_alloc_track(size_t size, int flags, const char *func,
    int line);
extern void vmem_free_track(void *ptr, size_t size);

#  define __kmem_alloc(size, flags, na, node) kmem_alloc_track((size),        \
                                                  (flags), __FUNCTION__,      \
                                                  __LINE__, (na), (node))
#  define kmem_free(ptr, size)                kmem_free_track((ptr), (size))
#  define vmem_alloc(size, flags)             vmem_alloc_track((size),        \
                                                  (flags),__FUNCTION__,       \
                                                  __LINE__)
#  define vmem_free(ptr, size)                vmem_free_track((ptr), (size))

# else /* DEBUG_KMEM_TRACKING */

extern void *kmem_alloc_debug(size_t size, int flags, const char *func,
    int line, int node_alloc, int node);
extern void kmem_free_debug(void *ptr, size_t size);
extern void *vmem_alloc_debug(size_t size, int flags, const char *func,
    int line);
extern void vmem_free_debug(void *ptr, size_t size);

#  define __kmem_alloc(size, flags, na, node) kmem_alloc_debug((size),        \
                                                  (flags), __FUNCTION__,      \
                                                  __LINE__, (na), (node))
#  define kmem_free(ptr, size)                kmem_free_debug((ptr), (size))
#  define vmem_alloc(size, flags)             vmem_alloc_debug((size),        \
                                                  (flags), __FUNCTION__,      \
                                                  __LINE__)
#  define vmem_free(ptr, size)                vmem_free_debug((ptr), (size))

# endif /* DEBUG_KMEM_TRACKING */

#else /* DEBUG_KMEM */

# define kmem_alloc(size, flags)        kmalloc((size), (flags))
# define kmem_zalloc(size, flags)       kzalloc((size), (flags))
# define kmem_free(ptr, size)           (kfree(ptr), (void)(size))

# ifdef HAVE_KMALLOC_NODE
#  define kmem_alloc_node(size, flags, node)                                  \
          kmalloc_node((size), (flags), (node))
# else
#  define kmem_alloc_node(size, flags, node)                                  \
          kmalloc((size), (flags))
# endif

# define vmem_alloc(size, flags)        __vmalloc((size), ((flags) |          \
                                            __GFP_HIGHMEM), PAGE_KERNEL)
# define vmem_zalloc(size, flags)                                             \
({                                                                            \
        void *_ptr_ = __vmalloc((size),((flags)|__GFP_HIGHMEM),PAGE_KERNEL);  \
        if (_ptr_)                                                            \
                memset(_ptr_, 0, (size));                                     \
        _ptr_;                                                                \
})
# define vmem_free(ptr, size)           (vfree(ptr), (void)(size))

#endif /* DEBUG_KMEM */

#ifdef DEBUG_KMEM_UNIMPLEMENTED
static __inline__ void *
kmem_alloc_tryhard(size_t size, size_t *alloc_size, int kmflags)
{
#error "kmem_alloc_tryhard() not implemented"
}
#endif /* DEBUG_KMEM_UNIMPLEMENTED */

/*
 * Slab allocation interfaces
 */
enum {
	KMC_BIT_NOTOUCH		= 0,	/* Don't update ages */
	KMC_BIT_NODEBUG		= 1,	/* Default behavior */
	KMC_BIT_NOMAGAZINE	= 2,	/* XXX: Unsupported */
	KMC_BIT_NOHASH		= 3,	/* XXX: Unsupported */
	KMC_BIT_QCACHE		= 4,	/* XXX: Unsupported */
	KMC_BIT_KMEM		= 5,	/* Use kmem cache */
	KMC_BIT_VMEM		= 6,	/* Use vmem cache */
	KMC_BIT_OFFSLAB		= 7,	/* Objects not on slab */
	KMC_BIT_REAPING		= 16,	/* Reaping in progress */
	KMC_BIT_DESTROY		= 17,	/* Destroy in progress */
};

#define KMC_NOTOUCH		(1 << KMC_BIT_NOTOUCH)
#define KMC_NODEBUG		(1 << KMC_BIT_NODEBUG)
#define KMC_NOMAGAZINE		(1 << KMC_BIT_NOMAGAZINE)
#define KMC_NOHASH		(1 << KMC_BIT_NOHASH)
#define KMC_QCACHE		(1 << KMC_BIT_QCACHE)
#define KMC_KMEM		(1 << KMC_BIT_KMEM)
#define KMC_VMEM		(1 << KMC_BIT_VMEM)
#define KMC_OFFSLAB		(1 << KMC_BIT_OFFSLAB)
#define KMC_REAPING		(1 << KMC_BIT_REAPING)
#define KMC_DESTROY		(1 << KMC_BIT_DESTROY)

#define KMC_REAP_CHUNK			INT_MAX
#define KMC_DEFAULT_SEEKS		1

#ifdef DEBUG_KMEM_UNIMPLEMENTED
static __inline__ void kmem_init(void) {
#error "kmem_init() not implemented"
}

static __inline__ void kmem_thread_init(void) {
#error "kmem_thread_init() not implemented"
}

static __inline__ void kmem_mp_init(void) {
#error "kmem_mp_init() not implemented"
}

static __inline__ void kmem_reap_idspace(void) {
#error "kmem_reap_idspace() not implemented"
}

static __inline__ size_t kmem_avail(void) {
#error "kmem_avail() not implemented"
}

static __inline__ size_t kmem_maxavail(void) {
#error "kmem_maxavail() not implemented"
}

static __inline__ uint64_t kmem_cache_stat(spl_kmem_cache_t *cache) {
#error "kmem_cache_stat() not implemented"
}
#endif /* DEBUG_KMEM_UNIMPLEMENTED */

/* XXX - Used by arc.c to adjust its memory footprint. We may want
 *       to use this hook in the future to adjust behavior based on
 *       debug levels.  For now it's safe to always return 0.
 */
static __inline__ int
kmem_debugging(void)
{
        return 0;
}

extern int kmem_set_warning(int flag);

extern struct list_head spl_kmem_cache_list;
extern struct rw_semaphore spl_kmem_cache_sem;

#define SKM_MAGIC			0x2e2e2e2e
#define SKO_MAGIC			0x20202020
#define SKS_MAGIC			0x22222222
#define SKC_MAGIC			0x2c2c2c2c

#define SPL_KMEM_CACHE_DELAY		5	/* Minimum slab release age */
#define SPL_KMEM_CACHE_OBJ_PER_SLAB	32	/* Target objects per slab */
#define SPL_KMEM_CACHE_OBJ_PER_SLAB_MIN	8	/* Minimum objects per slab */
#define SPL_KMEM_CACHE_ALIGN		8	/* Default object alignment */

typedef int (*spl_kmem_ctor_t)(void *, void *, int);
typedef void (*spl_kmem_dtor_t)(void *, void *);
typedef void (*spl_kmem_reclaim_t)(void *);

typedef struct spl_kmem_magazine {
        uint32_t		skm_magic;	/* Sanity magic */
	uint32_t		skm_avail;	/* Available objects */
	uint32_t		skm_size;	/* Magazine size */
	uint32_t		skm_refill;	/* Batch refill size */
	unsigned long		skm_age;	/* Last cache access */
	void			*skm_objs[0];	/* Object pointers */
} spl_kmem_magazine_t;

typedef struct spl_kmem_obj {
        uint32_t		sko_magic;	/* Sanity magic */
	void			*sko_addr;	/* Buffer address */
	struct spl_kmem_slab	*sko_slab;	/* Owned by slab */
	struct list_head	sko_list;	/* Free object list linkage */
} spl_kmem_obj_t;

typedef struct spl_kmem_slab {
        uint32_t		sks_magic;	/* Sanity magic */
	uint32_t		sks_objs;	/* Objects per slab */
	struct spl_kmem_cache	*sks_cache;	/* Owned by cache */
	struct list_head	sks_list;	/* Slab list linkage */
	struct list_head	sks_free_list;	/* Free object list */
	unsigned long		sks_age;	/* Last modify jiffie */
	uint32_t		sks_ref;	/* Ref count used objects */
} spl_kmem_slab_t;

typedef struct spl_kmem_cache {
	uint32_t		skc_magic;	/* Sanity magic */
	uint32_t		skc_name_size;	/* Name length */
	char			*skc_name;	/* Name string */
	spl_kmem_magazine_t	*skc_mag[NR_CPUS]; /* Per-CPU warm cache */
	uint32_t		skc_mag_size;	/* Magazine size */
	uint32_t		skc_mag_refill;	/* Magazine refill count */
	spl_kmem_ctor_t		skc_ctor;	/* Constructor */
	spl_kmem_dtor_t		skc_dtor;	/* Destructor */
	spl_kmem_reclaim_t	skc_reclaim;	/* Reclaimator */
	void			*skc_private;	/* Private data */
	void			*skc_vmp;	/* Unused */
	unsigned long		skc_flags;	/* Flags */
	uint32_t		skc_obj_size;	/* Object size */
	uint32_t		skc_obj_align;	/* Object alignment */
	uint32_t		skc_slab_objs;	/* Objects per slab */
	uint32_t		skc_slab_size;	/* Slab size */
	uint32_t		skc_delay;	/* Slab reclaim interval */
	atomic_t		skc_ref;	/* Ref count callers */
	struct delayed_work	skc_work;	/* Slab reclaim work */
        struct work_struct work;
        struct timer_list timer;
	struct list_head	skc_list;	/* List of caches linkage */
	struct list_head	skc_complete_list;/* Completely alloc'ed */
	struct list_head	skc_partial_list; /* Partially alloc'ed */
	spinlock_t		skc_lock;	/* Cache lock */
	uint64_t		skc_slab_fail;	/* Slab alloc failures */
	uint64_t		skc_slab_create;/* Slab creates */
	uint64_t		skc_slab_destroy;/* Slab destroys */
	uint64_t		skc_slab_total;	/* Slab total current */
	uint64_t		skc_slab_alloc;	/* Slab alloc current */
	uint64_t		skc_slab_max;	/* Slab max historic  */
	uint64_t		skc_obj_total;	/* Obj total current */
	uint64_t		skc_obj_alloc;	/* Obj alloc current */
	uint64_t		skc_obj_max;	/* Obj max historic */
} spl_kmem_cache_t;
#define kmem_cache_t		spl_kmem_cache_t

extern spl_kmem_cache_t *
spl_kmem_cache_create(char *name, size_t size, size_t align,
        spl_kmem_ctor_t ctor, spl_kmem_dtor_t dtor, spl_kmem_reclaim_t reclaim,
        void *priv, void *vmp, int flags);

extern void spl_kmem_cache_destroy(spl_kmem_cache_t *skc);
extern void *spl_kmem_cache_alloc(spl_kmem_cache_t *skc, int flags);
extern void spl_kmem_cache_free(spl_kmem_cache_t *skc, void *obj);
extern void spl_kmem_cache_reap_now(spl_kmem_cache_t *skc);
extern void spl_kmem_reap(void);

int spl_kmem_init(void);
void spl_kmem_fini(void);

#define kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags) \
        spl_kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags)
#define kmem_cache_destroy(skc)		spl_kmem_cache_destroy(skc)
#define kmem_cache_alloc(skc, flags)	spl_kmem_cache_alloc(skc, flags)
#define kmem_cache_free(skc, obj)	spl_kmem_cache_free(skc, obj)
#define kmem_cache_reap_now(skc)	spl_kmem_cache_reap_now(skc)
#define kmem_reap()			spl_kmem_reap()
#define kmem_virt(ptr)			(((ptr) >= (void *)VMALLOC_START) && \
					 ((ptr) <  (void *)VMALLOC_END))

#ifdef	__cplusplus
}
#endif

#endif	/* _SPL_KMEM_H */
Commit	Line	Data
715f6251	1	/*
	2	* This file is part of the SPL: Solaris Porting Layer.
	3	*
	4	* Copyright (c) 2008 Lawrence Livermore National Security, LLC.
	5	* Produced at Lawrence Livermore National Laboratory
	6	* Written by:
	7	* Brian Behlendorf <behlendorf1@llnl.gov>,
	8	* Herb Wartens <wartens2@llnl.gov>,
	9	* Jim Garlick <garlick@llnl.gov>
	10	* UCRL-CODE-235197
	11	*
	12	* This is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This is distributed in the hope that it will be useful, but WITHOUT
	18	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	19	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	20	* for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License along
	23	* with this program; if not, write to the Free Software Foundation, Inc.,
	24	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	25	*/
	26
09b414e8	27	#ifndef _SPL_KMEM_H
09b414e8	28	#define _SPL_KMEM_H
f1ca4da6	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
f1ca4da6	34	#undef DEBUG_KMEM_UNIMPLEMENTED
ff449ac4	35	#undef DEBUG_KMEM_TRACKING /* Per-allocation memory tracking */
f1ca4da6	36
f1b59d26	37	#include <linux/module.h>
f1ca4da6	38	#include <linux/slab.h>
79b31f36	39	#include <linux/vmalloc.h>
f1ca4da6	40	#include <linux/mm.h>
f1ca4da6	41	#include <linux/spinlock.h>
d6a26c6a	42	#include <linux/rwsem.h>
	43	#include <linux/hash.h>
	44	#include <linux/ctype.h>
550f1705	45	#include <asm/atomic_compat.h>
57d86234	46	#include <sys/types.h>
937879f1	47	#include <sys/debug.h>
550f1705	48
f1ca4da6	49	/*
	50	* Memory allocation interfaces
	51	*/
c22e7a42	52	#define KM_SLEEP (GFP_KERNEL \| __GFP_NOFAIL)
f1ca4da6	53	#define KM_NOSLEEP GFP_ATOMIC
f1ca4da6	54	#undef KM_PANIC /* No linux analog */
a0f6da3d	55	#define KM_PUSHPAGE (KM_SLEEP \| __GFP_HIGH)
f1ca4da6	56	#define KM_VMFLAGS GFP_LEVEL_MASK
	57	#define KM_FLAGS __GFP_BITS_MASK
	58
3d061e9d	59	/*
	60	* Used internally, the kernel does not need to support this flag
	61	*/
	62	#ifndef __GFP_ZERO
a0f6da3d	63	# define __GFP_ZERO 0x8000
3d061e9d	64	#endif
3d061e9d	65
f1ca4da6	66	#ifdef DEBUG_KMEM
a0f6da3d	67
c19c06f3	68	extern atomic64_t kmem_alloc_used;
a0f6da3d	69	extern unsigned long long kmem_alloc_max;
c19c06f3	70	extern atomic64_t vmem_alloc_used;
a0f6da3d	71	extern unsigned long long vmem_alloc_max;
	72
	73	# define kmem_alloc(size, flags) __kmem_alloc((size), (flags), 0, 0)
	74	# define kmem_zalloc(size, flags) __kmem_alloc((size), ((flags) \| \
	75	__GFP_ZERO), 0, 0)
	76
	77	/* The node alloc functions are only used by the SPL code itself */
	78	# ifdef HAVE_KMALLOC_NODE
	79	# define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 1, \
	80	node)
	81	# else
	82	# define kmem_alloc_node(size, flags, node) __kmem_alloc((size), (flags), 0, 0)
	83	# endif
	84
	85	# define vmem_zalloc(size, flags) vmem_alloc((size), ((flags) \| \
	86	__GFP_ZERO))
	87
	88	# ifdef DEBUG_KMEM_TRACKING
	89
	90	extern void kmem_alloc_track(size_t size, int flags, const char func,
	91	int line, int node_alloc, int node);
	92	extern void kmem_free_track(void *ptr, size_t size);
	93	extern void vmem_alloc_track(size_t size, int flags, const char func,
	94	int line);
	95	extern void vmem_free_track(void *ptr, size_t size);
	96
	97	# define __kmem_alloc(size, flags, na, node) kmem_alloc_track((size), \
	98	(flags), __FUNCTION__, \
	99	__LINE__, (na), (node))
	100	# define kmem_free(ptr, size) kmem_free_track((ptr), (size))
	101	# define vmem_alloc(size, flags) vmem_alloc_track((size), \
	102	(flags),__FUNCTION__, \
	103	__LINE__)
	104	# define vmem_free(ptr, size) vmem_free_track((ptr), (size))
	105
	106	# else /* DEBUG_KMEM_TRACKING */
	107
	108	extern void kmem_alloc_debug(size_t size, int flags, const char func,
	109	int line, int node_alloc, int node);
	110	extern void kmem_free_debug(void *ptr, size_t size);
	111	extern void vmem_alloc_debug(size_t size, int flags, const char func,
	112	int line);
	113	extern void vmem_free_debug(void *ptr, size_t size);
	114
	115	# define __kmem_alloc(size, flags, na, node) kmem_alloc_debug((size), \
	116	(flags), __FUNCTION__, \
	117	__LINE__, (na), (node))
	118	# define kmem_free(ptr, size) kmem_free_debug((ptr), (size))
	119	# define vmem_alloc(size, flags) vmem_alloc_debug((size), \
	120	(flags), __FUNCTION__, \
	121	__LINE__)
	122	# define vmem_free(ptr, size) vmem_free_debug((ptr), (size))
	123
	124	# endif /* DEBUG_KMEM_TRACKING */
ff449ac4	125
c6dc93d6	126	#else /* DEBUG_KMEM */
f1ca4da6	127
a0f6da3d	128	# define kmem_alloc(size, flags) kmalloc((size), (flags))
	129	# define kmem_zalloc(size, flags) kzalloc((size), (flags))
	130	# define kmem_free(ptr, size) (kfree(ptr), (void)(size))
	131
	132	# ifdef HAVE_KMALLOC_NODE
	133	# define kmem_alloc_node(size, flags, node) \
	134	kmalloc_node((size), (flags), (node))
	135	# else
	136	# define kmem_alloc_node(size, flags, node) \
	137	kmalloc((size), (flags))
	138	# endif
	139
	140	# define vmem_alloc(size, flags) __vmalloc((size), ((flags) \| \
	141	__GFP_HIGHMEM), PAGE_KERNEL)
	142	# define vmem_zalloc(size, flags) \
79b31f36	143	({ \
c6dc93d6	144	void *_ptr_ = __vmalloc((size),((flags)\|__GFP_HIGHMEM),PAGE_KERNEL); \
	145	if (_ptr_) \
	146	memset(_ptr_, 0, (size)); \
	147	_ptr_; \
79b31f36	148	})
a0f6da3d	149	# define vmem_free(ptr, size) (vfree(ptr), (void)(size))
79b31f36	150
f1ca4da6	151	#endif /* DEBUG_KMEM */
f1ca4da6	152
f1ca4da6	153	#ifdef DEBUG_KMEM_UNIMPLEMENTED
	154	static __inline__ void *
	155	kmem_alloc_tryhard(size_t size, size_t *alloc_size, int kmflags)
	156	{
	157	#error "kmem_alloc_tryhard() not implemented"
	158	}
	159	#endif /* DEBUG_KMEM_UNIMPLEMENTED */
	160
	161	/*
	162	* Slab allocation interfaces
	163	*/
ea3e6ca9 BB	164	enum {
	165	KMC_BIT_NOTOUCH = 0, /* Don't update ages */
	166	KMC_BIT_NODEBUG = 1, /* Default behavior */
	167	KMC_BIT_NOMAGAZINE = 2, /* XXX: Unsupported */
	168	KMC_BIT_NOHASH = 3, /* XXX: Unsupported */
	169	KMC_BIT_QCACHE = 4, /* XXX: Unsupported */
	170	KMC_BIT_KMEM = 5, /* Use kmem cache */
	171	KMC_BIT_VMEM = 6, /* Use vmem cache */
	172	KMC_BIT_OFFSLAB = 7, /* Objects not on slab */
	173	KMC_BIT_REAPING = 16, /* Reaping in progress */
	174	KMC_BIT_DESTROY = 17, /* Destroy in progress */
	175	};
	176
	177	#define KMC_NOTOUCH (1 << KMC_BIT_NOTOUCH)
	178	#define KMC_NODEBUG (1 << KMC_BIT_NODEBUG)
	179	#define KMC_NOMAGAZINE (1 << KMC_BIT_NOMAGAZINE)
	180	#define KMC_NOHASH (1 << KMC_BIT_NOHASH)
	181	#define KMC_QCACHE (1 << KMC_BIT_QCACHE)
	182	#define KMC_KMEM (1 << KMC_BIT_KMEM)
	183	#define KMC_VMEM (1 << KMC_BIT_VMEM)
	184	#define KMC_OFFSLAB (1 << KMC_BIT_OFFSLAB)
	185	#define KMC_REAPING (1 << KMC_BIT_REAPING)
	186	#define KMC_DESTROY (1 << KMC_BIT_DESTROY)
	187
	188	#define KMC_REAP_CHUNK INT_MAX
	189	#define KMC_DEFAULT_SEEKS 1
f1ca4da6	190
f1ca4da6	191	#ifdef DEBUG_KMEM_UNIMPLEMENTED
	192	static __inline__ void kmem_init(void) {
	193	#error "kmem_init() not implemented"
	194	}
	195
	196	static __inline__ void kmem_thread_init(void) {
	197	#error "kmem_thread_init() not implemented"
	198	}
	199
	200	static __inline__ void kmem_mp_init(void) {
	201	#error "kmem_mp_init() not implemented"
	202	}
	203
	204	static __inline__ void kmem_reap_idspace(void) {
	205	#error "kmem_reap_idspace() not implemented"
	206	}
	207
	208	static __inline__ size_t kmem_avail(void) {
	209	#error "kmem_avail() not implemented"
	210	}
	211
	212	static __inline__ size_t kmem_maxavail(void) {
	213	#error "kmem_maxavail() not implemented"
	214	}
	215
2fb9b26a	216	static __inline__ uint64_t kmem_cache_stat(spl_kmem_cache_t *cache) {
f1ca4da6	217	#error "kmem_cache_stat() not implemented"
	218	}
	219	#endif /* DEBUG_KMEM_UNIMPLEMENTED */
	220
	221	/* XXX - Used by arc.c to adjust its memory footprint. We may want
	222	* to use this hook in the future to adjust behavior based on
	223	* debug levels. For now it's safe to always return 0.
	224	*/
	225	static __inline__ int
	226	kmem_debugging(void)
	227	{
	228	return 0;
	229	}
	230
c19c06f3	231	extern int kmem_set_warning(int flag);
c19c06f3	232
ff449ac4	233	extern struct list_head spl_kmem_cache_list;
ff449ac4	234	extern struct rw_semaphore spl_kmem_cache_sem;
2fb9b26a	235
4afaaefa	236	#define SKM_MAGIC 0x2e2e2e2e
2fb9b26a	237	#define SKO_MAGIC 0x20202020
	238	#define SKS_MAGIC 0x22222222
	239	#define SKC_MAGIC 0x2c2c2c2c
	240
ea3e6ca9 BB	241	#define SPL_KMEM_CACHE_DELAY 5 /* Minimum slab release age */
	242	#define SPL_KMEM_CACHE_OBJ_PER_SLAB 32 /* Target objects per slab */
	243	#define SPL_KMEM_CACHE_OBJ_PER_SLAB_MIN 8 /* Minimum objects per slab */
	244	#define SPL_KMEM_CACHE_ALIGN 8 /* Default object alignment */
2fb9b26a	245
	246	typedef int (spl_kmem_ctor_t)(void , void *, int);
	247	typedef void (spl_kmem_dtor_t)(void , void *);
	248	typedef void (spl_kmem_reclaim_t)(void );
	249
4afaaefa	250	typedef struct spl_kmem_magazine {
	251	uint32_t skm_magic; /* Sanity magic */
	252	uint32_t skm_avail; /* Available objects */
	253	uint32_t skm_size; /* Magazine size */
	254	uint32_t skm_refill; /* Batch refill size */
	255	unsigned long skm_age; /* Last cache access */
	256	void skm_objs[0]; / Object pointers */
	257	} spl_kmem_magazine_t;
	258
2fb9b26a	259	typedef struct spl_kmem_obj {
2fb9b26a	260	uint32_t sko_magic; /* Sanity magic */
2fb9b26a	261	void sko_addr; / Buffer address */
	262	struct spl_kmem_slab sko_slab; / Owned by slab */
	263	struct list_head sko_list; /* Free object list linkage */
2fb9b26a	264	} spl_kmem_obj_t;
	265
	266	typedef struct spl_kmem_slab {
	267	uint32_t sks_magic; /* Sanity magic */
	268	uint32_t sks_objs; /* Objects per slab */
	269	struct spl_kmem_cache sks_cache; / Owned by cache */
	270	struct list_head sks_list; /* Slab list linkage */
	271	struct list_head sks_free_list; /* Free object list */
	272	unsigned long sks_age; /* Last modify jiffie */
4afaaefa	273	uint32_t sks_ref; /* Ref count used objects */
2fb9b26a	274	} spl_kmem_slab_t;
	275
	276	typedef struct spl_kmem_cache {
ea3e6ca9 BB	277	uint32_t skc_magic; /* Sanity magic */
	278	uint32_t skc_name_size; /* Name length */
	279	char skc_name; / Name string */
4afaaefa	280	spl_kmem_magazine_t skc_mag[NR_CPUS]; / Per-CPU warm cache */
	281	uint32_t skc_mag_size; /* Magazine size */
	282	uint32_t skc_mag_refill; /* Magazine refill count */
ea3e6ca9 BB	283	spl_kmem_ctor_t skc_ctor; /* Constructor */
	284	spl_kmem_dtor_t skc_dtor; /* Destructor */
	285	spl_kmem_reclaim_t skc_reclaim; /* Reclaimator */
	286	void skc_private; / Private data */
	287	void skc_vmp; / Unused */
31a033ec	288	unsigned long skc_flags; /* Flags */
2fb9b26a	289	uint32_t skc_obj_size; /* Object size */
48e0606a	290	uint32_t skc_obj_align; /* Object alignment */
a1502d76	291	uint32_t skc_slab_objs; /* Objects per slab */
ea3e6ca9 BB	292	uint32_t skc_slab_size; /* Slab size */
	293	uint32_t skc_delay; /* Slab reclaim interval */
	294	atomic_t skc_ref; /* Ref count callers */
	295	struct delayed_work skc_work; /* Slab reclaim work */
	296	struct work_struct work;
	297	struct timer_list timer;
	298	struct list_head skc_list; /* List of caches linkage */
2fb9b26a	299	struct list_head skc_complete_list;/* Completely alloc'ed */
2fb9b26a	300	struct list_head skc_partial_list; /* Partially alloc'ed */
d46630e0	301	spinlock_t skc_lock; /* Cache lock */
2fb9b26a	302	uint64_t skc_slab_fail; /* Slab alloc failures */
	303	uint64_t skc_slab_create;/* Slab creates */
	304	uint64_t skc_slab_destroy;/* Slab destroys */
d46630e0	305	uint64_t skc_slab_total; /* Slab total current */
ea3e6ca9	306	uint64_t skc_slab_alloc; /* Slab alloc current */
d46630e0	307	uint64_t skc_slab_max; /* Slab max historic */
	308	uint64_t skc_obj_total; /* Obj total current */
	309	uint64_t skc_obj_alloc; /* Obj alloc current */
	310	uint64_t skc_obj_max; /* Obj max historic */
2fb9b26a	311	} spl_kmem_cache_t;
7afde631	312	#define kmem_cache_t spl_kmem_cache_t
2fb9b26a	313
	314	extern spl_kmem_cache_t *
	315	spl_kmem_cache_create(char *name, size_t size, size_t align,
	316	spl_kmem_ctor_t ctor, spl_kmem_dtor_t dtor, spl_kmem_reclaim_t reclaim,
f1ca4da6	317	void priv, void vmp, int flags);
f1ca4da6	318
2fb9b26a	319	extern void spl_kmem_cache_destroy(spl_kmem_cache_t *skc);
	320	extern void spl_kmem_cache_alloc(spl_kmem_cache_t skc, int flags);
	321	extern void spl_kmem_cache_free(spl_kmem_cache_t skc, void obj);
	322	extern void spl_kmem_cache_reap_now(spl_kmem_cache_t *skc);
	323	extern void spl_kmem_reap(void);
f1ca4da6	324
2fb9b26a	325	int spl_kmem_init(void);
2fb9b26a	326	void spl_kmem_fini(void);
5d86345d	327
f1ca4da6	328	#define kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags) \
2fb9b26a	329	spl_kmem_cache_create(name,size,align,ctor,dtor,rclm,priv,vmp,flags)
	330	#define kmem_cache_destroy(skc) spl_kmem_cache_destroy(skc)
	331	#define kmem_cache_alloc(skc, flags) spl_kmem_cache_alloc(skc, flags)
	332	#define kmem_cache_free(skc, obj) spl_kmem_cache_free(skc, obj)
	333	#define kmem_cache_reap_now(skc) spl_kmem_cache_reap_now(skc)
	334	#define kmem_reap() spl_kmem_reap()
a1502d76	335	#define kmem_virt(ptr) (((ptr) >= (void *)VMALLOC_START) && \
a1502d76	336	((ptr) < (void *)VMALLOC_END))
f1ca4da6	337
	338	#ifdef __cplusplus
	339	}
	340	#endif
	341
09b414e8	342	#endif /* _SPL_KMEM_H */