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. 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. 16 * 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 27 * SUCH DAMAGE. 28 * 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 $ 31 */ 32 33 #ifndef _SYS_MALLOC_H_ 34 #define _SYS_MALLOC_H_ 35 36 #ifndef _SYS_TYPES_H_ 37 #include <sys/types.h> 38 #endif 39 #ifndef _MACHINE_TYPES_H_ 40 #include <machine/types.h> /* vm_paddr_t and __* types */ 41 #endif 42 43 #ifndef _MACHINE_PARAM_H_ 44 #include <machine/param.h> /* for SMP_MAXCPU */ 45 #endif 46 47 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 48 49 #endif /* _KERNEL */ 50 51 /* 52 * flags to malloc. 53 */ 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 */ 63 64 /* 65 * M_NOWAIT has to be a set of flags for equivalence to prior use. 66 * 67 * M_SYSALLOC should be used for any critical infrastructure allocations 68 * made by the kernel proper. 69 * 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. 73 * 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. 78 * 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. 82 */ 83 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) 89 90 #define M_NOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE) 91 #define M_SYSALLOC M_SYSWAIT 92 93 #define M_MAGIC 877983977 /* time when first defined :-) */ 94 95 /* 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). 100 * 101 * SMP_MAXCPU is used so modules which use malloc remain compatible 102 * between UP and SMP. 103 */ 104 struct malloc_use { 105 size_t memuse; 106 size_t inuse; 107 } __cachealign; 108 109 struct malloc_type { 110 struct malloc_type *ks_next; /* next in list */ 111 size_t ks_loosememuse; /* (inaccurate) aggregate memuse */ 112 size_t ks_limit; /* most that are allowed to exist */ 113 long ks_size; /* sizes of this thing that are allocated */ 114 struct malloc_use ks_use[SMP_MAXCPU]; 115 __int64_t ks_calls; /* total packets of this type ever allocated */ 116 long ks_maxused; /* maximum number ever used */ 117 __uint32_t ks_magic; /* if it's not magic, don't touch it */ 118 const char *ks_shortdesc; /* short description */ 119 __uint16_t ks_limblocks; /* number of times blocked for hitting limit */ 120 __uint16_t ks_mapblocks; /* number of times blocked for kernel map */ 121 long ks_reserved[4]; /* future use (module compatibility) */ 122 }; 123 124 typedef struct malloc_type *malloc_type_t; 125 126 #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, \ 130 0, 0, { 0 } } \ 131 }; \ 132 SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \ 133 malloc_init, type); \ 134 SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \ 135 malloc_uninit, type) 136 #else 137 #define MALLOC_DEFINE(type, shortdesc, longdesc) \ 138 struct malloc_type type[1] = { \ 139 { NULL, 0, 0, 0, { { 0, 0 } }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \ 140 } 141 #endif 142 143 #define MALLOC_DECLARE(type) \ 144 extern struct malloc_type type[1] 145 146 #ifdef _KERNEL 147 148 MALLOC_DECLARE(M_CACHE); 149 MALLOC_DECLARE(M_DEVBUF); 150 MALLOC_DECLARE(M_TEMP); 151 152 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */ 153 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */ 154 155 #endif /* _KERNEL */ 156 157 #ifdef _KERNEL 158 159 #define MINALLOCSIZE sizeof(void *) 160 161 /* 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. 165 */ 166 MALLOC_DECLARE(M_IOV); 167 168 /* XXX struct malloc_type is unused for contig*(). */ 169 size_t kmem_lim_size(void); 170 void contigfree(void *addr, unsigned long size, struct malloc_type *type) 171 __nonnull(1); 172 void *contigmalloc(unsigned long size, struct malloc_type *type, int flags, 173 vm_paddr_t low, vm_paddr_t high, unsigned long alignment, 174 unsigned long boundary) __malloclike __heedresult 175 __alloc_size(1) __alloc_align(6); 176 void malloc_init(void *); 177 void malloc_uninit(void *); 178 void kmalloc_raise_limit(struct malloc_type *type, size_t bytes); 179 void kmalloc_create(struct malloc_type **typep, const char *descr); 180 void kmalloc_destroy(struct malloc_type **typep); 181 182 #ifdef SLAB_DEBUG 183 void *kmalloc_debug(unsigned long size, struct malloc_type *type, int flags, 184 const char *file, int line) __malloclike __heedresult 185 __alloc_size(1); 186 void *krealloc_debug(void *addr, unsigned long size, 187 struct malloc_type *type, int flags, 188 const char *file, int line) __heedresult __alloc_size(2); 189 char *kstrdup_debug(const char *, struct malloc_type *, 190 const char *file, int line) __malloclike __heedresult; 191 char *kstrndup_debug(const char *, size_t maxlen, struct malloc_type *, 192 const char *file, int line) __malloclike __heedresult; 193 #define kmalloc(size, type, flags) \ 194 kmalloc_debug(size, type, flags, __FILE__, __LINE__) 195 #define krealloc(addr, size, type, flags) \ 196 krealloc_debug(addr, size, type, flags, __FILE__, __LINE__) 197 #define kstrdup(str, type) \ 198 kstrdup_debug(str, type, __FILE__, __LINE__) 199 #define kstrndup(str, maxlen, type) \ 200 kstrndup_debug(str, maxlen, type, __FILE__, __LINE__) 201 #else 202 void *kmalloc(unsigned long size, struct malloc_type *type, int flags) 203 __malloclike __heedresult __alloc_size(1); 204 void *krealloc(void *addr, unsigned long size, struct malloc_type *type, 205 int flags) __heedresult __alloc_size(2); 206 char *kstrdup(const char *, struct malloc_type *) 207 __malloclike __heedresult; 208 char *kstrndup(const char *, size_t maxlen, struct malloc_type *) 209 __malloclike __heedresult; 210 #define kmalloc_debug(size, type, flags, file, line) \ 211 kmalloc(size, type, flags) 212 #define krealloc_debug(addr, size, type, flags, file, line) \ 213 krealloc(addr, size, type, flags) 214 #define kstrdup_debug(str, type, file, line) \ 215 kstrdup(str, type) 216 #define kstrndup_debug(str, maxlen, type, file, line) \ 217 kstrndup(str, maxlen, type) 218 #endif 219 void *kmalloc_cachealign(unsigned long size, struct malloc_type *type, 220 int flags) __heedresult; 221 void kfree(void *addr, struct malloc_type *type) 222 __nonnull(1) __nonnull(2); 223 long kmalloc_limit(struct malloc_type *type); 224 void slab_cleanup(void); 225 226 #endif /* _KERNEL */ 227 228 #endif /* !_SYS_MALLOC_H_ */ 229