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