2 * Copyright (c) 1987, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)malloc.h 8.5 (Berkeley) 5/3/95
30 * $FreeBSD: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $
33 #ifndef _SYS_MALLOC_H_
34 #define _SYS_MALLOC_H_
37 #include <sys/types.h>
39 #ifndef _MACHINE_TYPES_H_
40 #include <machine/types.h> /* vm_paddr_t and __* types */
43 #ifndef _MACHINE_PARAM_H_
44 #include <machine/param.h> /* for SMP_MAXCPU */
47 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
54 #define M_RNOWAIT 0x0001 /* do not block */
55 #define M_WAITOK 0x0002 /* wait for resources / alloc from cache */
56 #define M_ZERO 0x0100 /* bzero() the allocation */
57 #define M_USE_RESERVE 0x0200 /* can eat into free list reserve */
58 #define M_NULLOK 0x0400 /* ok to return NULL */
59 #define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */
60 #define M_USE_INTERRUPT_RESERVE \
61 0x1000 /* can exhaust free list entirely */
62 #define M_POWEROF2 0x2000 /* roundup size to the nearest power of 2 */
65 * M_NOWAIT has to be a set of flags for equivalence to prior use.
67 * M_SYSALLOC should be used for any critical infrastructure allocations
68 * made by the kernel proper.
70 * M_INTNOWAIT should be used for any critical infrastructure allocations
71 * made by interrupts. Such allocations can still fail but will not fail
72 * as often as M_NOWAIT.
74 * NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations
75 * almost always succeed. In DragonFly, however, there is a good chance
76 * that an allocation will fail. M_NOWAIT should only be used when
77 * allocations can fail without any serious detriment to the system.
79 * Note that allocations made from (preempted) interrupts will attempt to
80 * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with
81 * objects). This is automatic.
84 #define M_INTNOWAIT (M_RNOWAIT | M_NULLOK | \
85 M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
86 #define M_SYSNOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
87 #define M_INTWAIT (M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
88 #define M_SYSWAIT (M_WAITOK | M_USE_RESERVE)
90 #define M_NOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
91 #define M_SYSALLOC M_SYSWAIT
93 #define M_MAGIC 877983977 /* time when first defined :-) */
96 * The malloc tracking structure. Note that per-cpu entries must be
97 * aggregated for accurate statistics, they do not actually break the
98 * stats down by cpu (e.g. the cpu freeing memory will subtract from
99 * its slot, not the originating cpu's slot).
101 * SMP_MAXCPU is used so modules which use malloc remain compatible
102 * between UP and SMP.
107 __int64_t calls; /* total packets of this type ever allocated */
110 * This value will be added to ks_loosememuse and resetted,
111 * once it goes above certain threshold (ZoneSize). This
112 * is intended to reduce frequency of ks_loosememuse (global)
119 struct malloc_type *ks_next; /* next in list */
120 size_t ks_loosememuse; /* (inaccurate) aggregate memuse */
121 size_t ks_limit; /* most that are allowed to exist */
122 struct malloc_use ks_use[SMP_MAXCPU];
123 __uint32_t ks_magic; /* if it's not magic, don't touch it */
124 const char *ks_shortdesc; /* short description */
125 long ks_reserved[4]; /* future use (module compatibility) */
128 typedef struct malloc_type *malloc_type_t;
130 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
131 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
132 struct malloc_type type[1] = { \
133 { NULL, 0, 0, { { 0, 0, 0, 0 } }, M_MAGIC, shortdesc, \
136 SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \
137 malloc_init, type); \
138 SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \
141 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
142 struct malloc_type type[1] = { \
143 { NULL, 0, 0, { { 0, 0, 0, 0 } }, M_MAGIC, shortdesc, \
148 #define MALLOC_DECLARE(type) \
149 extern struct malloc_type type[1]
153 MALLOC_DECLARE(M_CACHE);
154 MALLOC_DECLARE(M_DEVBUF);
155 MALLOC_DECLARE(M_TEMP);
157 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
158 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
164 #define MINALLOCSIZE sizeof(void *)
167 * XXX this should be declared in <sys/uio.h>, but that tends to fail
168 * because <sys/uio.h> is included in a header before the source file
169 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
171 MALLOC_DECLARE(M_IOV);
173 /* XXX struct malloc_type is unused for contig*(). */
174 size_t kmem_lim_size(void);
175 void contigfree(void *addr, unsigned long size, struct malloc_type *type)
177 void *contigmalloc(unsigned long size, struct malloc_type *type, int flags,
178 vm_paddr_t low, vm_paddr_t high, unsigned long alignment,
179 unsigned long boundary) __malloclike __heedresult
180 __alloc_size(1) __alloc_align(6);
181 void malloc_init(void *);
182 void malloc_uninit(void *);
183 void kmalloc_raise_limit(struct malloc_type *type, size_t bytes);
184 void kmalloc_set_unlimited(struct malloc_type *type);
185 void kmalloc_create(struct malloc_type **typep, const char *descr);
186 void kmalloc_destroy(struct malloc_type **typep);
189 void *kmalloc_debug(unsigned long size, struct malloc_type *type, int flags,
190 const char *file, int line) __malloclike __heedresult
192 void *krealloc_debug(void *addr, unsigned long size,
193 struct malloc_type *type, int flags,
194 const char *file, int line) __heedresult __alloc_size(2);
195 char *kstrdup_debug(const char *, struct malloc_type *,
196 const char *file, int line) __malloclike __heedresult;
197 char *kstrndup_debug(const char *, size_t maxlen, struct malloc_type *,
198 const char *file, int line) __malloclike __heedresult;
199 #define kmalloc(size, type, flags) \
200 kmalloc_debug(size, type, flags, __FILE__, __LINE__)
201 #define krealloc(addr, size, type, flags) \
202 krealloc_debug(addr, size, type, flags, __FILE__, __LINE__)
203 #define kstrdup(str, type) \
204 kstrdup_debug(str, type, __FILE__, __LINE__)
205 #define kstrndup(str, maxlen, type) \
206 kstrndup_debug(str, maxlen, type, __FILE__, __LINE__)
208 void *kmalloc(unsigned long size, struct malloc_type *type, int flags)
209 __malloclike __heedresult __alloc_size(1);
210 void *krealloc(void *addr, unsigned long size, struct malloc_type *type,
211 int flags) __heedresult __alloc_size(2);
212 char *kstrdup(const char *, struct malloc_type *)
213 __malloclike __heedresult;
214 char *kstrndup(const char *, size_t maxlen, struct malloc_type *)
215 __malloclike __heedresult;
216 #define kmalloc_debug(size, type, flags, file, line) \
217 kmalloc(size, type, flags)
218 #define krealloc_debug(addr, size, type, flags, file, line) \
219 krealloc(addr, size, type, flags)
220 #define kstrdup_debug(str, type, file, line) \
222 #define kstrndup_debug(str, maxlen, type, file, line) \
223 kstrndup(str, maxlen, type)
225 void *kmalloc_cachealign(unsigned long size, struct malloc_type *type,
226 int flags) __heedresult;
227 void kfree(void *addr, struct malloc_type *type)
228 __nonnull(1) __nonnull(2);
229 long kmalloc_limit(struct malloc_type *type);
230 void slab_cleanup(void);
234 #endif /* !_SYS_MALLOC_H_ */