xref: /dragonfly/sys/sys/malloc.h (revision 2d8a3be7)
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.13 2003/11/03 17:11:22 dillon Exp $
36  */
37 
38 #ifndef _SYS_MALLOC_H_
39 #define	_SYS_MALLOC_H_
40 
41 #ifndef _MACHINE_PARAM_H_
42 #include <machine/param.h>	/* for SMP_MAXCPU */
43 #endif
44 
45 #ifdef _KERNEL
46 
47 #ifndef _MACHINE_VMPARAM_H_
48 #include <machine/vmparam.h>	/* for VM_MIN_KERNEL_ADDRESS */
49 #endif
50 
51 #define splmem splhigh
52 
53 #endif
54 
55 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
56 
57 /*
58  * flags to malloc.
59  */
60 #define	M_NOWAIT     	0x0001	/* do not block */
61 #define	M_WAITOK     	0x0002	/* wait for resources */
62 #define	M_ZERO       	0x0100	/* bzero() the allocation */
63 #define	M_USE_RESERVE	0x0200	/* can alloc out of reserve memory */
64 #define	M_NULLOK	0x0400	/* ok to return NULL in M_WAITOK case */
65 #define M_PASSIVE_ZERO	0x0800	/* (internal to the slab code only) */
66 
67 #define	M_MAGIC		877983977	/* time when first defined :-) */
68 
69 /*
70  * The malloc tracking structure.  Note that per-cpu entries must be
71  * aggregated for accurate statistics, they do not actually break the
72  * stats down by cpu (e.g. the cpu freeing memory will subtract from
73  * its slot, not the originating cpu's slot).
74  *
75  * SMP_MAXCPU is used so modules which use malloc remain compatible
76  * between UP and SMP.
77  */
78 struct malloc_type {
79 	struct malloc_type *ks_next;	/* next in list */
80 	long 	ks_memuse[SMP_MAXCPU];	/* total memory held in bytes */
81 	long	ks_loosememuse;		/* (inaccurate) aggregate memuse */
82 	long	ks_limit;	/* most that are allowed to exist */
83 	long	ks_size;	/* sizes of this thing that are allocated */
84 	long	ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
85 	int64_t	ks_calls;	/* total packets of this type ever allocated */
86 	long	ks_maxused;	/* maximum number ever used */
87 	u_long	ks_magic;	/* if it's not magic, don't touch it */
88 	const char *ks_shortdesc;	/* short description */
89 	u_short	ks_limblocks;	/* number of times blocked for hitting limit */
90 	u_short	ks_mapblocks;	/* number of times blocked for kernel map */
91 	long	ks_reserved[4];	/* future use (module compatibility) */
92 };
93 
94 #endif
95 
96 #ifdef _KERNEL
97 #define	MALLOC_DEFINE(type, shortdesc, longdesc) \
98 	struct malloc_type type[1] = { \
99 		{ NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
100 	}; \
101 	SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
102 	SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
103 
104 #define	MALLOC_DECLARE(type) \
105 	extern struct malloc_type type[1]
106 
107 MALLOC_DECLARE(M_CACHE);
108 MALLOC_DECLARE(M_DEVBUF);
109 MALLOC_DECLARE(M_TEMP);
110 
111 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
112 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
113 #endif /* _KERNEL */
114 
115 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
116 
117 /*
118  * Array of descriptors that describe the contents of each page
119  */
120 struct kmemusage {
121 	short ku_cpu;		/* cpu index */
122 	union {
123 		u_short freecnt;/* for small allocations, free pieces in page */
124 		u_short pagecnt;/* for large allocations, pages alloced */
125 	} ku_un;
126 };
127 #define ku_freecnt ku_un.freecnt
128 #define ku_pagecnt ku_un.pagecnt
129 
130 /*
131  * Set of buckets for each size of memory block that is retained
132  */
133 struct kmembuckets {
134 	caddr_t kb_next;	/* list of free blocks */
135 	caddr_t kb_last;	/* last free block */
136 	int64_t	kb_calls;	/* total calls to allocate this size */
137 	long	kb_total;	/* total number of blocks allocated */
138 	long	kb_elmpercl;	/* # of elements in this sized allocation */
139 	long	kb_totalfree;	/* # of free elements in this bucket */
140 	long	kb_highwat;	/* high water mark */
141 	long	kb_couldfree;	/* over high water mark and could free */
142 };
143 
144 #define	MINALLOCSIZE	(1 << MINBUCKET)
145 #define BUCKETINDX(size) \
146 	((size) <= (MINALLOCSIZE * 128) \
147 		? (size) <= (MINALLOCSIZE * 8) \
148 			? (size) <= (MINALLOCSIZE * 2) \
149 				? (size) <= (MINALLOCSIZE * 1) \
150 					? (MINBUCKET + 0) \
151 					: (MINBUCKET + 1) \
152 				: (size) <= (MINALLOCSIZE * 4) \
153 					? (MINBUCKET + 2) \
154 					: (MINBUCKET + 3) \
155 			: (size) <= (MINALLOCSIZE* 32) \
156 				? (size) <= (MINALLOCSIZE * 16) \
157 					? (MINBUCKET + 4) \
158 					: (MINBUCKET + 5) \
159 				: (size) <= (MINALLOCSIZE * 64) \
160 					? (MINBUCKET + 6) \
161 					: (MINBUCKET + 7) \
162 		: (size) <= (MINALLOCSIZE * 2048) \
163 			? (size) <= (MINALLOCSIZE * 512) \
164 				? (size) <= (MINALLOCSIZE * 256) \
165 					? (MINBUCKET + 8) \
166 					: (MINBUCKET + 9) \
167 				: (size) <= (MINALLOCSIZE * 1024) \
168 					? (MINBUCKET + 10) \
169 					: (MINBUCKET + 11) \
170 			: (size) <= (MINALLOCSIZE * 8192) \
171 				? (size) <= (MINALLOCSIZE * 4096) \
172 					? (MINBUCKET + 12) \
173 					: (MINBUCKET + 13) \
174 				: (size) <= (MINALLOCSIZE * 16384) \
175 					? (MINBUCKET + 14) \
176 					: (MINBUCKET + 15))
177 
178 #endif
179 
180 #ifdef _KERNEL
181 
182 /*
183  * Turn virtual addresses into kmem map indices
184  */
185 #define btokup(addr)	(&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
186 
187 /*
188  * Deprecated macro versions of not-quite-malloc() and free().
189  */
190 #define	MALLOC(space, cast, size, type, flags) \
191 	(space) = (cast)malloc((u_long)(size), (type), (flags))
192 #define	FREE(addr, type) free((addr), (type))
193 
194 /*
195  * XXX this should be declared in <sys/uio.h>, but that tends to fail
196  * because <sys/uio.h> is included in a header before the source file
197  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
198  */
199 MALLOC_DECLARE(M_IOV);
200 
201 /* XXX struct malloc_type is unused for contig*(). */
202 void	contigfree (void *addr, unsigned long size,
203 			struct malloc_type *type);
204 void	*contigmalloc (unsigned long size, struct malloc_type *type,
205 			   int flags, vm_paddr_t low, vm_paddr_t high,
206 			   unsigned long alignment, unsigned long boundary);
207 void	free (void *addr, struct malloc_type *type);
208 void	*malloc (unsigned long size, struct malloc_type *type, int flags);
209 void	malloc_init (void *);
210 void	malloc_uninit (void *);
211 void	*realloc (void *addr, unsigned long size,
212 		      struct malloc_type *type, int flags);
213 void	*reallocf (void *addr, unsigned long size,
214 		      struct malloc_type *type, int flags);
215 
216 #endif /* _KERNEL */
217 
218 #endif /* !_SYS_MALLOC_H_ */
219