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. 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.
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
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 $
37 #ifndef _SYS_MALLOC_H_
38 #define _SYS_MALLOC_H_
41 #include <sys/types.h>
43 #ifndef _MACHINE_TYPES_H_
44 #include <machine/types.h> /* vm_paddr_t and __* types */
47 #ifndef _MACHINE_PARAM_H_
48 #include <machine/param.h> /* for SMP_MAXCPU */
51 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
58 #define M_RNOWAIT 0x0001 /* do not block */
59 #define M_WAITOK 0x0002 /* wait for resources / alloc from cache */
60 #define M_ZERO 0x0100 /* bzero() the allocation */
61 #define M_USE_RESERVE 0x0200 /* can eat into free list reserve */
62 #define M_NULLOK 0x0400 /* ok to return NULL */
63 #define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */
64 #define M_USE_INTERRUPT_RESERVE \
65 0x1000 /* can exhaust free list entirely */
68 * M_NOWAIT has to be a set of flags for equivalence to prior use.
70 * M_SYSALLOC should be used for any critical infrastructure allocations
71 * made by the kernel proper.
73 * M_INTNOWAIT should be used for any critical infrastructure allocations
74 * made by interrupts. Such allocations can still fail but will not fail
75 * as often as M_NOWAIT.
77 * NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations
78 * almost always succeed. In DragonFly, however, there is a good chance
79 * that an allocation will fail. M_NOWAIT should only be used when
80 * allocations can fail without any serious detriment to the system.
82 * Note that allocations made from (preempted) interrupts will attempt to
83 * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with
84 * objects). This is automatic.
87 #define M_INTNOWAIT (M_RNOWAIT | M_NULLOK | \
88 M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
89 #define M_SYSNOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
90 #define M_INTWAIT (M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE)
91 #define M_SYSWAIT (M_WAITOK | M_USE_RESERVE)
93 #define M_NOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE)
94 #define M_SYSALLOC M_SYSWAIT
96 #define M_MAGIC 877983977 /* time when first defined :-) */
99 * The malloc tracking structure. Note that per-cpu entries must be
100 * aggregated for accurate statistics, they do not actually break the
101 * stats down by cpu (e.g. the cpu freeing memory will subtract from
102 * its slot, not the originating cpu's slot).
104 * SMP_MAXCPU is used so modules which use malloc remain compatible
105 * between UP and SMP.
108 struct malloc_type *ks_next; /* next in list */
109 size_t ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */
110 size_t ks_loosememuse; /* (inaccurate) aggregate memuse */
111 size_t ks_limit; /* most that are allowed to exist */
112 long ks_size; /* sizes of this thing that are allocated */
113 size_t ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
114 __int64_t ks_calls; /* total packets of this type ever allocated */
115 long ks_maxused; /* maximum number ever used */
116 __uint32_t ks_magic; /* if it's not magic, don't touch it */
117 const char *ks_shortdesc; /* short description */
118 __uint16_t ks_limblocks; /* number of times blocked for hitting limit */
119 __uint16_t ks_mapblocks; /* number of times blocked for kernel map */
120 long ks_reserved[4]; /* future use (module compatibility) */
123 typedef struct malloc_type *malloc_type_t;
125 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
127 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
128 struct malloc_type type[1] = { \
129 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \
131 SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_init, type); \
132 SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, malloc_uninit, type)
136 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
137 struct malloc_type type[1] = { \
138 { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
143 #define MALLOC_DECLARE(type) \
144 extern struct malloc_type type[1]
148 MALLOC_DECLARE(M_CACHE);
149 MALLOC_DECLARE(M_DEVBUF);
150 MALLOC_DECLARE(M_TEMP);
152 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
153 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
159 #define MINALLOCSIZE sizeof(void *)
162 * XXX this should be declared in <sys/uio.h>, but that tends to fail
163 * because <sys/uio.h> is included in a header before the source file
164 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
166 MALLOC_DECLARE(M_IOV);
168 /* XXX struct malloc_type is unused for contig*(). */
169 size_t kmem_lim_size(void);
170 void contigfree (void *addr, unsigned long size,
171 struct malloc_type *type);
172 void *contigmalloc (unsigned long size, struct malloc_type *type,
173 int flags, vm_paddr_t low, vm_paddr_t high,
174 unsigned long alignment, unsigned long boundary);
175 void malloc_init (void *);
176 void malloc_uninit (void *);
177 void kmalloc_raise_limit(struct malloc_type *type, size_t bytes);
178 void kmalloc_create(struct malloc_type **typep, const char *descr);
179 void kmalloc_destroy(struct malloc_type **typep);
182 void *kmalloc_debug (unsigned long size, struct malloc_type *type, int flags,
183 const char *file, int line);
184 void *krealloc_debug (void *addr, unsigned long size,
185 struct malloc_type *type, int flags,
186 const char *file, int line);
187 char *kstrdup_debug (const char *, struct malloc_type *,
188 const char *file, int line);
189 #define kmalloc(size, type, flags) \
190 kmalloc_debug(size, type, flags, __FILE__, __LINE__)
191 #define krealloc(addr, size, type, flags) \
192 krealloc_debug(addr, size, type, flags, __FILE__, __LINE__)
193 #define kstrdup(str, type) \
194 kstrdup_debug(str, type, __FILE__, __LINE__)
196 void *kmalloc (unsigned long size, struct malloc_type *type, int flags);
197 void *krealloc (void *addr, unsigned long size,
198 struct malloc_type *type, int flags);
199 char *kstrdup (const char *, struct malloc_type *);
200 #define kmalloc_debug(size, type, flags, file, line) \
201 kmalloc(size, type, flags)
202 #define krealloc_debug(addr, size, type, flags, file, line) \
203 krealloc(addr, size, type, flags)
204 #define kstrdup_debug(str, type, file, line) \
207 void kfree (void *addr, struct malloc_type *type);
208 long kmalloc_limit (struct malloc_type *type);
212 #endif /* !_SYS_MALLOC_H_ */