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 /* 44 * flags to malloc. 45 */ 46 #define M_RNOWAIT 0x0001 /* do not block */ 47 #define M_WAITOK 0x0002 /* wait for resources / alloc from cache */ 48 #define M_ZERO 0x0100 /* bzero() the allocation */ 49 #define M_USE_RESERVE 0x0200 /* can eat into free list reserve */ 50 #define M_NULLOK 0x0400 /* ok to return NULL */ 51 #define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */ 52 #define M_USE_INTERRUPT_RESERVE \ 53 0x1000 /* can exhaust free list entirely */ 54 #define M_POWEROF2 0x2000 /* roundup size to the nearest power of 2 */ 55 #define M_CACHEALIGN 0x4000 /* force CPU cache line alignment */ 56 /* GFP_DMA32 0x10000 reserved for drm layer (not handled by kmalloc) */ 57 58 /* 59 * M_NOWAIT has to be a set of flags for equivalence to prior use. 60 * 61 * M_SYSALLOC should be used for any critical infrastructure allocations 62 * made by the kernel proper. 63 * 64 * M_INTNOWAIT should be used for any critical infrastructure allocations 65 * made by interrupts. Such allocations can still fail but will not fail 66 * as often as M_NOWAIT. 67 * 68 * NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations 69 * almost always succeed. In DragonFly, however, there is a good chance 70 * that an allocation will fail. M_NOWAIT should only be used when 71 * allocations can fail without any serious detriment to the system. 72 * 73 * Note that allocations made from (preempted) interrupts will attempt to 74 * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with 75 * objects). This is automatic. 76 */ 77 78 #define M_INTNOWAIT (M_RNOWAIT | M_NULLOK | \ 79 M_USE_RESERVE | M_USE_INTERRUPT_RESERVE) 80 #define M_SYSNOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE) 81 #define M_INTWAIT (M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE) 82 #define M_SYSWAIT (M_WAITOK | M_USE_RESERVE) 83 84 #define M_NOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE) 85 #define M_SYSALLOC M_SYSWAIT 86 87 #define M_MAGIC 877983977 /* time when first defined :-) */ 88 89 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 90 #include <sys/_malloc.h> /* struct malloc_type */ 91 #ifndef NULL 92 #include <sys/_null.h> /* ensure NULL is defined */ 93 #endif 94 #endif 95 96 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 97 #define MALLOC_DEFINE(type, shortdesc, longdesc) \ 98 struct malloc_type type[1] = { \ 99 { NULL, 0, 0, { { 0, 0, 0, 0 } }, M_MAGIC, shortdesc, \ 100 { 0 } } \ 101 }; \ 102 SYSINIT(type##_init, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \ 103 malloc_init, type); \ 104 SYSUNINIT(type##_uninit, SI_BOOT1_KMALLOC, SI_ORDER_ANY, \ 105 malloc_uninit, type) 106 #else 107 #define MALLOC_DEFINE(type, shortdesc, longdesc) \ 108 struct malloc_type type[1] = { \ 109 { NULL, 0, 0, { { 0, 0, 0, 0 } }, M_MAGIC, shortdesc, \ 110 { 0 } } \ 111 } 112 #endif 113 114 #ifdef _KERNEL 115 116 MALLOC_DECLARE(M_CACHE); 117 MALLOC_DECLARE(M_DEVBUF); 118 MALLOC_DECLARE(M_TEMP); 119 120 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */ 121 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */ 122 123 #endif /* _KERNEL */ 124 125 #ifdef _KERNEL 126 127 #define MINALLOCSIZE sizeof(void *) 128 129 /* XXX struct malloc_type is unused for contig*(). */ 130 size_t kmem_lim_size(void); 131 void contigfree(void *addr, unsigned long size, struct malloc_type *type) 132 __nonnull(1); 133 void *contigmalloc(unsigned long size, struct malloc_type *type, int flags, 134 vm_paddr_t low, vm_paddr_t high, unsigned long alignment, 135 unsigned long boundary) __malloclike __heedresult 136 __alloc_size(1) __alloc_align(6); 137 void malloc_init(void *); 138 void malloc_uninit(void *); 139 void kmalloc_raise_limit(struct malloc_type *type, size_t bytes); 140 void kmalloc_set_unlimited(struct malloc_type *type); 141 void kmalloc_create(struct malloc_type **typep, const char *descr); 142 void kmalloc_destroy(struct malloc_type **typep); 143 144 /* 145 * Debug and non-debug kmalloc() prototypes. 146 * 147 * The kmalloc() macro allows M_ZERO to be optimized external to 148 * the kmalloc() function. When combined with the use a builtin 149 * for bzero() this can get rid of a considerable amount of overhead 150 * for M_ZERO based kmalloc() calls. 151 */ 152 #ifdef SLAB_DEBUG 153 void *kmalloc_debug(unsigned long size, struct malloc_type *type, int flags, 154 const char *file, int line) __malloclike __heedresult 155 __alloc_size(1); 156 void *krealloc_debug(void *addr, unsigned long size, 157 struct malloc_type *type, int flags, 158 const char *file, int line) __heedresult __alloc_size(2); 159 char *kstrdup_debug(const char *, struct malloc_type *, 160 const char *file, int line) __malloclike __heedresult; 161 char *kstrndup_debug(const char *, size_t maxlen, struct malloc_type *, 162 const char *file, int line) __malloclike __heedresult; 163 #if 1 164 #define _kmalloc(size, type, flags) ({ \ 165 void *_malloc_item; \ 166 size_t _size = (size); \ 167 \ 168 if (__builtin_constant_p(size) && \ 169 __builtin_constant_p(flags) && \ 170 ((flags) & M_ZERO)) { \ 171 _malloc_item = kmalloc_debug(_size, type, \ 172 (flags) & ~M_ZERO, \ 173 __FILE__, __LINE__); \ 174 if (((flags) & (M_WAITOK|M_NULLOK)) == M_WAITOK || \ 175 __predict_true(_malloc_item != NULL)) { \ 176 __builtin_memset(_malloc_item, 0, _size); \ 177 } \ 178 } else { \ 179 _malloc_item = kmalloc_debug(_size, type, flags, \ 180 __FILE__, __LINE__); \ 181 } \ 182 _malloc_item; \ 183 }) 184 #else 185 #define _kmalloc(size, type, flags) \ 186 kmalloc_debug(_size, type, flags, __FILE__, __LINE__); 187 #endif 188 #define kmalloc(size, type, flags) _kmalloc(size, type, flags) 189 #define krealloc(addr, size, type, flags) \ 190 krealloc_debug(addr, size, type, flags, __FILE__, __LINE__) 191 #define kstrdup(str, type) \ 192 kstrdup_debug(str, type, __FILE__, __LINE__) 193 #define kstrndup(str, maxlen, type) \ 194 kstrndup_debug(str, maxlen, type, __FILE__, __LINE__) 195 196 #else /* !SLAB_DEBUG */ 197 198 void *kmalloc(unsigned long size, struct malloc_type *type, int flags) 199 __malloclike __heedresult __alloc_size(1); 200 static __inline __always_inline void * 201 _kmalloc(size_t _size, struct malloc_type *_type, int _flags) 202 { 203 #if 1 204 if (__builtin_constant_p(_size) && __builtin_constant_p(_flags) && 205 (_flags & M_ZERO)) { 206 void *_malloc_item; 207 _malloc_item = kmalloc(_size, _type, _flags & ~M_ZERO); 208 if ((_flags & (M_WAITOK|M_NULLOK)) == M_WAITOK || 209 __predict_true(_malloc_item != NULL)) { 210 __builtin_memset(_malloc_item, 0, _size); 211 } 212 return _malloc_item; 213 } 214 #endif 215 return (kmalloc(_size, _type, _flags)); 216 } 217 #define kmalloc(size, type, flags) _kmalloc((size), (type), (flags)) 218 void *krealloc(void *addr, unsigned long size, struct malloc_type *type, 219 int flags) __heedresult __alloc_size(2); 220 char *kstrdup(const char *, struct malloc_type *) 221 __malloclike __heedresult; 222 char *kstrndup(const char *, size_t maxlen, struct malloc_type *) 223 __malloclike __heedresult; 224 #define kmalloc_debug(size, type, flags, file, line) \ 225 kmalloc(size, type, flags) 226 #define krealloc_debug(addr, size, type, flags, file, line) \ 227 krealloc(addr, size, type, flags) 228 #define kstrdup_debug(str, type, file, line) \ 229 kstrdup(str, type) 230 #define kstrndup_debug(str, maxlen, type, file, line) \ 231 kstrndup(str, maxlen, type) 232 #endif 233 void kfree(void *addr, struct malloc_type *type) __nonnull(2); 234 long kmalloc_limit(struct malloc_type *type); 235 void slab_cleanup(void); 236 237 #endif /* _KERNEL */ 238 239 #endif /* !_SYS_MALLOC_H_ */ 240