[dragonfly.git] / sys / sys / malloc.h

/*
 * Copyright (c) 1987, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)malloc.h	8.5 (Berkeley) 5/3/95
 * $FreeBSD: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $
 */

#ifndef _SYS_MALLOC_H_
#define	_SYS_MALLOC_H_

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _MACHINE_TYPES_H_
#include <machine/types.h>	/* vm_paddr_t and __* types */
#endif

#ifndef _MACHINE_PARAM_H_
#include <machine/param.h>	/* for SMP_MAXCPU */
#endif

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

#endif	/* _KERNEL */

/*
 * flags to malloc.
 */
#define	M_RNOWAIT     	0x0001	/* do not block */
#define	M_WAITOK     	0x0002	/* wait for resources / alloc from cache */
#define	M_ZERO       	0x0100	/* bzero() the allocation */
#define	M_USE_RESERVE	0x0200	/* can eat into free list reserve */
#define	M_NULLOK	0x0400	/* ok to return NULL */
#define M_PASSIVE_ZERO	0x0800	/* (internal to the slab code only) */
#define M_USE_INTERRUPT_RESERVE \
			0x1000	/* can exhaust free list entirely */
#define M_POWEROF2	0x2000	/* roundup size to the nearest power of 2 */

/*
 * M_NOWAIT has to be a set of flags for equivalence to prior use. 
 *
 * M_SYSALLOC should be used for any critical infrastructure allocations
 * made by the kernel proper.
 *
 * M_INTNOWAIT should be used for any critical infrastructure allocations
 * made by interrupts.  Such allocations can still fail but will not fail
 * as often as M_NOWAIT.
 *
 * NOTE ON DRAGONFLY USE OF M_NOWAIT.  In FreeBSD M_NOWAIT allocations
 * almost always succeed.  In DragonFly, however, there is a good chance
 * that an allocation will fail.  M_NOWAIT should only be used when 
 * allocations can fail without any serious detriment to the system.
 *
 * Note that allocations made from (preempted) interrupts will attempt to
 * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with
 * objects).  This is automatic.
 */

#define	M_INTNOWAIT	(M_RNOWAIT | M_NULLOK | 			\
			 M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
#define	M_SYSNOWAIT	(M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
#define	M_INTWAIT	(M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
#define	M_SYSWAIT	(M_WAITOK | M_USE_RESERVE)

#define	M_NOWAIT	(M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
#define	M_SYSALLOC	M_SYSWAIT

#define	M_MAGIC		877983977	/* time when first defined :-) */

/*
 * The malloc tracking structure.  Note that per-cpu entries must be
 * aggregated for accurate statistics, they do not actually break the
 * stats down by cpu (e.g. the cpu freeing memory will subtract from
 * its slot, not the originating cpu's slot).
 *
 * SMP_MAXCPU is used so modules which use malloc remain compatible
 * between UP and SMP.
 */
struct malloc_type {
	struct malloc_type *ks_next;	/* next in list */
	size_t 	ks_memuse[SMP_MAXCPU];	/* total memory held in bytes */
	size_t	ks_loosememuse;		/* (inaccurate) aggregate memuse */
	size_t	ks_limit;	/* most that are allowed to exist */
	long	ks_size;	/* sizes of this thing that are allocated */
	size_t	ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
	__int64_t ks_calls;	/* total packets of this type ever allocated */
	long	ks_maxused;	/* maximum number ever used */
	__uint32_t ks_magic;	/* if it's not magic, don't touch it */
	const char *ks_shortdesc;	/* short description */
	__uint16_t ks_limblocks; /* number of times blocked for hitting limit */
	__uint16_t ks_mapblocks; /* number of times blocked for kernel map */
	long	ks_reserved[4];	/* future use (module compatibility) */
};

typedef struct malloc_type	*malloc_type_t;

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

#define	MALLOC_DEFINE(type, shortdesc, longdesc)	\
	struct malloc_type type[1] = { 			\
	    { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \
	}; 								    \
	SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_init, type); \
	SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_uninit, type)

#else

#define	MALLOC_DEFINE(type, shortdesc, longdesc)	\
	struct malloc_type type[1] = { 			\
	    { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
	};

#endif

#define	MALLOC_DECLARE(type) \
	extern struct malloc_type type[1]

#ifdef _KERNEL

MALLOC_DECLARE(M_CACHE);
MALLOC_DECLARE(M_DEVBUF);
MALLOC_DECLARE(M_TEMP);

MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
MALLOC_DECLARE(M_IP6NDP); /* for INET6 */

#endif /* _KERNEL */

#ifdef _KERNEL

#define	MINALLOCSIZE	sizeof(void *)

/*
 * XXX this should be declared in <sys/uio.h>, but that tends to fail
 * because <sys/uio.h> is included in a header before the source file
 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
 */
MALLOC_DECLARE(M_IOV);

/* XXX struct malloc_type is unused for contig*(). */
size_t  kmem_lim_size(void);
void	contigfree (void *addr, unsigned long size,
			struct malloc_type *type);
void	*contigmalloc (unsigned long size, struct malloc_type *type,
			   int flags, vm_paddr_t low, vm_paddr_t high,
			   unsigned long alignment, unsigned long boundary);
void	malloc_init (void *);
void	malloc_uninit (void *);
void	kmalloc_raise_limit(struct malloc_type *type, size_t bytes);
void	kmalloc_create(struct malloc_type **typep, const char *descr);
void	kmalloc_destroy(struct malloc_type **typep);

#ifdef SLAB_DEBUG
void	*kmalloc_debug (unsigned long size, struct malloc_type *type, int flags,
			const char *file, int line);
void	*krealloc_debug (void *addr, unsigned long size,
			struct malloc_type *type, int flags,
			const char *file, int line);
char	*kstrdup_debug (const char *, struct malloc_type *,
			const char *file, int line);
#define kmalloc(size, type, flags)		\
	kmalloc_debug(size, type, flags, __FILE__, __LINE__)
#define krealloc(addr, size, type, flags)	\
	krealloc_debug(addr, size, type, flags, __FILE__, __LINE__)
#define kstrdup(str, type)			\
	kstrdup_debug(str, type, __FILE__, __LINE__)
#else
void	*kmalloc (unsigned long size, struct malloc_type *type, int flags);
void	*krealloc (void *addr, unsigned long size,
		      struct malloc_type *type, int flags);
char	*kstrdup (const char *, struct malloc_type *);
#define kmalloc_debug(size, type, flags, file, line)		\
	kmalloc(size, type, flags)
#define krealloc_debug(addr, size, type, flags, file, line)	\
	krealloc(addr, size, type, flags)
#define kstrdup_debug(str, type, file, line)			\
	kstrdup(str, type)
#endif
void	*kmalloc_cachealign (unsigned long size, struct malloc_type *type,
			   int flags);
void	kfree (void *addr, struct malloc_type *type);
long	kmalloc_limit (struct malloc_type *type);

#endif /* _KERNEL */

#endif /* !_SYS_MALLOC_H_ */
Commit	Line	Data
984263bc MD	1	/*
	2	* Copyright (c) 1987, 1993
	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by the University of
	16	* California, Berkeley and its contributors.
	17	* 4. Neither the name of the University nor the names of its contributors
	18	* may be used to endorse or promote products derived from this software
	19	* without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*
	33	* @(#)malloc.h 8.5 (Berkeley) 5/3/95
	34	* $FreeBSD: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $
	35	*/
	36
	37	#ifndef _SYS_MALLOC_H_
	38	#define _SYS_MALLOC_H_
	39
03d6a592 MD	40	#ifndef _SYS_TYPES_H_
	41	#include <sys/types.h>
	42	#endif
	43	#ifndef _MACHINE_TYPES_H_
	44	#include <machine/types.h> /* vm_paddr_t and __* types */
	45	#endif
	46
bba6a44d MD	47	#ifndef _MACHINE_PARAM_H_
	48	#include <machine/param.h> /* for SMP_MAXCPU */
	49	#endif
3bf43adc	50
05220613	51	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
3bf43adc	52
05220613 MD	53	#endif /* _KERNEL */
05220613 MD	54
984263bc MD	55	/*
	56	* flags to malloc.
	57	*/
dc1fd4b3 MD	58	#define M_RNOWAIT 0x0001 /* do not block */
dc1fd4b3 MD	59	#define M_WAITOK 0x0002 /* wait for resources / alloc from cache */
97482992	60	#define M_ZERO 0x0100 /* bzero() the allocation */
dc1fd4b3	61	#define M_USE_RESERVE 0x0200 /* can eat into free list reserve */
8cb2bf45	62	#define M_NULLOK 0x0400 /* ok to return NULL */
ebe4a7b3	63	#define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */
dc1fd4b3 MD	64	#define M_USE_INTERRUPT_RESERVE \
dc1fd4b3 MD	65	0x1000 /* can exhaust free list entirely */
1e57f867	66	#define M_POWEROF2 0x2000 /* roundup size to the nearest power of 2 */
dc1fd4b3 MD	67
	68	/*
	69	* M_NOWAIT has to be a set of flags for equivalence to prior use.
	70	*
dc1fd4b3 MD	71	* M_SYSALLOC should be used for any critical infrastructure allocations
	72	* made by the kernel proper.
	73	*
c397c465 MD	74	* M_INTNOWAIT should be used for any critical infrastructure allocations
	75	* made by interrupts. Such allocations can still fail but will not fail
	76	* as often as M_NOWAIT.
	77	*
	78	* NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations
	79	* almost always succeed. In DragonFly, however, there is a good chance
	80	* that an allocation will fail. M_NOWAIT should only be used when
	81	* allocations can fail without any serious detriment to the system.
dc1fd4b3	82	*
c397c465 MD	83	* Note that allocations made from (preempted) interrupts will attempt to
	84	* use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with
	85	* objects). This is automatic.
dc1fd4b3 MD	86	*/
dc1fd4b3 MD	87
8cb2bf45 JS	88	#define M_INTNOWAIT (M_RNOWAIT \| M_NULLOK \| \
	89	M_USE_RESERVE \| M_USE_INTERRUPT_RESERVE)
	90	#define M_SYSNOWAIT (M_RNOWAIT \| M_NULLOK \| M_USE_RESERVE)
	91	#define M_INTWAIT (M_WAITOK \| M_USE_RESERVE \| M_USE_INTERRUPT_RESERVE)
	92	#define M_SYSWAIT (M_WAITOK \| M_USE_RESERVE)
dc1fd4b3	93
39312e2a	94	#define M_NOWAIT (M_RNOWAIT \| M_NULLOK \| M_USE_RESERVE)
8cb2bf45	95	#define M_SYSALLOC M_SYSWAIT
984263bc MD	96
	97	#define M_MAGIC 877983977 /* time when first defined :-) */
	98
bba6a44d MD	99	/*
	100	* The malloc tracking structure. Note that per-cpu entries must be
	101	* aggregated for accurate statistics, they do not actually break the
	102	* stats down by cpu (e.g. the cpu freeing memory will subtract from
	103	* its slot, not the originating cpu's slot).
	104	*
	105	* SMP_MAXCPU is used so modules which use malloc remain compatible
	106	* between UP and SMP.
	107	*/
984263bc MD	108	struct malloc_type {
984263bc MD	109	struct malloc_type ks_next; / next in list */
7c457ac8 MD	110	size_t ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */
	111	size_t ks_loosememuse; /* (inaccurate) aggregate memuse */
	112	size_t ks_limit; /* most that are allowed to exist */
984263bc	113	long ks_size; /* sizes of this thing that are allocated */
695d40bb	114	size_t ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
05220613	115	__int64_t ks_calls; /* total packets of this type ever allocated */
984263bc	116	long ks_maxused; /* maximum number ever used */
05220613	117	__uint32_t ks_magic; /* if it's not magic, don't touch it */
984263bc	118	const char ks_shortdesc; / short description */
05220613 MD	119	__uint16_t ks_limblocks; /* number of times blocked for hitting limit */
05220613 MD	120	__uint16_t ks_mapblocks; /* number of times blocked for kernel map */
bba6a44d	121	long ks_reserved[4]; /* future use (module compatibility) */
984263bc MD	122	};
984263bc MD	123
c35323b6 MD	124	typedef struct malloc_type *malloc_type_t;
c35323b6 MD	125
05220613	126	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
a108bf71	127
05220613 MD	128	#define MALLOC_DEFINE(type, shortdesc, longdesc) \
05220613 MD	129	struct malloc_type type[1] = { \
58661e79	130	{ NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \
05220613	131	}; \
ba39e2e0 MD	132	SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_init, type); \
ba39e2e0 MD	133	SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_uninit, type)
984263bc	134
05220613 MD	135	#else
	136
	137	#define MALLOC_DEFINE(type, shortdesc, longdesc) \
	138	struct malloc_type type[1] = { \
	139	{ NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
	140	};
	141
	142	#endif
	143
984263bc MD	144	#define MALLOC_DECLARE(type) \
	145	extern struct malloc_type type[1]
	146
05220613 MD	147	#ifdef _KERNEL
05220613 MD	148
984263bc MD	149	MALLOC_DECLARE(M_CACHE);
	150	MALLOC_DECLARE(M_DEVBUF);
	151	MALLOC_DECLARE(M_TEMP);
	152
	153	MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
	154	MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
984263bc	155
05220613	156	#endif /* _KERNEL */
a108bf71	157
a108bf71 MD	158	#ifdef _KERNEL
a108bf71 MD	159
05220613 MD	160	#define MINALLOCSIZE sizeof(void *)
05220613 MD	161
984263bc	162	/*
984263bc MD	163	* XXX this should be declared in <sys/uio.h>, but that tends to fail
	164	* because <sys/uio.h> is included in a header before the source file
	165	* has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
	166	*/
	167	MALLOC_DECLARE(M_IOV);
	168
	169	/* XXX struct malloc_type is unused for contig(). /
b12defdc	170	size_t kmem_lim_size(void);
b153f746 RG	171	void contigfree (void *addr, unsigned long size,
	172	struct malloc_type *type);
	173	void contigmalloc (unsigned long size, struct malloc_type type,
6ef943a3	174	int flags, vm_paddr_t low, vm_paddr_t high,
b153f746	175	unsigned long alignment, unsigned long boundary);
b153f746 RG	176	void malloc_init (void *);
b153f746 RG	177	void malloc_uninit (void *);
40153c65	178	void kmalloc_raise_limit(struct malloc_type *type, size_t bytes);
ebe36cfe MD	179	void kmalloc_create(struct malloc_type *typep, const char descr);
ebe36cfe MD	180	void kmalloc_destroy(struct malloc_type **typep);
8aca2bd4	181
bbb201fd MD	182	#ifdef SLAB_DEBUG
	183	void kmalloc_debug (unsigned long size, struct malloc_type type, int flags,
	184	const char *file, int line);
	185	void krealloc_debug (void addr, unsigned long size,
	186	struct malloc_type *type, int flags,
	187	const char *file, int line);
	188	char kstrdup_debug (const char , struct malloc_type *,
	189	const char *file, int line);
	190	#define kmalloc(size, type, flags) \
	191	kmalloc_debug(size, type, flags, __FILE__, __LINE__)
	192	#define krealloc(addr, size, type, flags) \
	193	krealloc_debug(addr, size, type, flags, __FILE__, __LINE__)
	194	#define kstrdup(str, type) \
	195	kstrdup_debug(str, type, __FILE__, __LINE__)
	196	#else
8aca2bd4 MD	197	void kmalloc (unsigned long size, struct malloc_type type, int flags);
8aca2bd4 MD	198	void krealloc (void addr, unsigned long size,
b153f746	199	struct malloc_type *type, int flags);
59302080	200	char kstrdup (const char , struct malloc_type *);
bbb201fd MD	201	#define kmalloc_debug(size, type, flags, file, line) \
	202	kmalloc(size, type, flags)
	203	#define krealloc_debug(addr, size, type, flags, file, line) \
	204	krealloc(addr, size, type, flags)
	205	#define kstrdup_debug(str, type, file, line) \
	206	kstrdup(str, type)
	207	#endif
55126ffe SZ	208	void kmalloc_cachealign (unsigned long size, struct malloc_type type,
55126ffe SZ	209	int flags);
bbb201fd	210	void kfree (void addr, struct malloc_type type);
45d2b1d8	211	long kmalloc_limit (struct malloc_type *type);
a108bf71	212
984263bc MD	213	#endif /* _KERNEL */
	214
	215	#endif /* !_SYS_MALLOC_H_ */