xref: /dragonfly/sys/sys/malloc.h (revision 1de703da)
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  * $DragonFly: src/sys/sys/malloc.h,v 1.2 2003/06/17 04:28:58 dillon Exp $
36  */
37 
38 #ifndef _SYS_MALLOC_H_
39 #define	_SYS_MALLOC_H_
40 
41 #define splmem splhigh
42 
43 /*
44  * flags to malloc.
45  */
46 #define	M_WAITOK	0x0000
47 #define	M_NOWAIT	0x0001		/* do not block */
48 #define	M_USE_RESERVE	0x0002		/* can alloc out of reserve memory */
49 #define	M_ASLEEP	0x0004		/* async sleep on failure */
50 #define	M_ZERO		0x0008		/* bzero the allocation */
51 
52 #define	M_MAGIC		877983977	/* time when first defined :-) */
53 
54 struct malloc_type {
55 	struct malloc_type *ks_next;	/* next in list */
56 	long 	ks_memuse;	/* total memory held in bytes */
57 	long	ks_limit;	/* most that are allowed to exist */
58 	long	ks_size;	/* sizes of this thing that are allocated */
59 	long	ks_inuse;	/* # of packets of this type currently in use */
60 	int64_t	ks_calls;	/* total packets of this type ever allocated */
61 	long	ks_maxused;	/* maximum number ever used */
62 	u_long	ks_magic;	/* if it's not magic, don't touch it */
63 	const char *ks_shortdesc;	/* short description */
64 	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
65 	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
66 };
67 
68 #ifdef _KERNEL
69 #define	MALLOC_DEFINE(type, shortdesc, longdesc) \
70 	struct malloc_type type[1] = { \
71 		{ NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
72 	}; \
73 	SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
74 	SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
75 
76 #define	MALLOC_DECLARE(type) \
77 	extern struct malloc_type type[1]
78 
79 MALLOC_DECLARE(M_CACHE);
80 MALLOC_DECLARE(M_DEVBUF);
81 MALLOC_DECLARE(M_TEMP);
82 
83 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
84 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
85 #endif /* _KERNEL */
86 
87 /*
88  * Array of descriptors that describe the contents of each page
89  */
90 struct kmemusage {
91 	short ku_indx;		/* bucket index */
92 	union {
93 		u_short freecnt;/* for small allocations, free pieces in page */
94 		u_short pagecnt;/* for large allocations, pages alloced */
95 	} ku_un;
96 };
97 #define ku_freecnt ku_un.freecnt
98 #define ku_pagecnt ku_un.pagecnt
99 
100 /*
101  * Set of buckets for each size of memory block that is retained
102  */
103 struct kmembuckets {
104 	caddr_t kb_next;	/* list of free blocks */
105 	caddr_t kb_last;	/* last free block */
106 	int64_t	kb_calls;	/* total calls to allocate this size */
107 	long	kb_total;	/* total number of blocks allocated */
108 	long	kb_elmpercl;	/* # of elements in this sized allocation */
109 	long	kb_totalfree;	/* # of free elements in this bucket */
110 	long	kb_highwat;	/* high water mark */
111 	long	kb_couldfree;	/* over high water mark and could free */
112 };
113 
114 #ifdef _KERNEL
115 #define	MINALLOCSIZE	(1 << MINBUCKET)
116 #define BUCKETINDX(size) \
117 	((size) <= (MINALLOCSIZE * 128) \
118 		? (size) <= (MINALLOCSIZE * 8) \
119 			? (size) <= (MINALLOCSIZE * 2) \
120 				? (size) <= (MINALLOCSIZE * 1) \
121 					? (MINBUCKET + 0) \
122 					: (MINBUCKET + 1) \
123 				: (size) <= (MINALLOCSIZE * 4) \
124 					? (MINBUCKET + 2) \
125 					: (MINBUCKET + 3) \
126 			: (size) <= (MINALLOCSIZE* 32) \
127 				? (size) <= (MINALLOCSIZE * 16) \
128 					? (MINBUCKET + 4) \
129 					: (MINBUCKET + 5) \
130 				: (size) <= (MINALLOCSIZE * 64) \
131 					? (MINBUCKET + 6) \
132 					: (MINBUCKET + 7) \
133 		: (size) <= (MINALLOCSIZE * 2048) \
134 			? (size) <= (MINALLOCSIZE * 512) \
135 				? (size) <= (MINALLOCSIZE * 256) \
136 					? (MINBUCKET + 8) \
137 					: (MINBUCKET + 9) \
138 				: (size) <= (MINALLOCSIZE * 1024) \
139 					? (MINBUCKET + 10) \
140 					: (MINBUCKET + 11) \
141 			: (size) <= (MINALLOCSIZE * 8192) \
142 				? (size) <= (MINALLOCSIZE * 4096) \
143 					? (MINBUCKET + 12) \
144 					: (MINBUCKET + 13) \
145 				: (size) <= (MINALLOCSIZE * 16384) \
146 					? (MINBUCKET + 14) \
147 					: (MINBUCKET + 15))
148 
149 /*
150  * Turn virtual addresses into kmem map indices
151  */
152 #define kmemxtob(alloc)	(kmembase + (alloc) * PAGE_SIZE)
153 #define btokmemx(addr)	(((caddr_t)(addr) - kmembase) / PAGE_SIZE)
154 #define btokup(addr)	(&kmemusage[((caddr_t)(addr) - kmembase) >> PAGE_SHIFT])
155 
156 /*
157  * Deprecated macro versions of not-quite-malloc() and free().
158  */
159 #define	MALLOC(space, cast, size, type, flags) \
160 	(space) = (cast)malloc((u_long)(size), (type), (flags))
161 #define	FREE(addr, type) free((addr), (type))
162 
163 /*
164  * XXX this should be declared in <sys/uio.h>, but that tends to fail
165  * because <sys/uio.h> is included in a header before the source file
166  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
167  */
168 MALLOC_DECLARE(M_IOV);
169 
170 /* XXX struct malloc_type is unused for contig*(). */
171 void	contigfree __P((void *addr, unsigned long size,
172 			struct malloc_type *type));
173 void	*contigmalloc __P((unsigned long size, struct malloc_type *type,
174 			   int flags, unsigned long low, unsigned long high,
175 			   unsigned long alignment, unsigned long boundary));
176 void	free __P((void *addr, struct malloc_type *type));
177 void	*malloc __P((unsigned long size, struct malloc_type *type, int flags));
178 void	malloc_init __P((void *));
179 void	malloc_uninit __P((void *));
180 void	*realloc __P((void *addr, unsigned long size,
181 		      struct malloc_type *type, int flags));
182 void	*reallocf __P((void *addr, unsigned long size,
183 		      struct malloc_type *type, int flags));
184 #endif /* _KERNEL */
185 
186 #endif /* !_SYS_MALLOC_H_ */
187