1 /*- 2 * Copyright (c) 1987, 1993 3 * The Regents of the University of California. 4 * Copyright (c) 2005, 2009 Robert N. M. Watson 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 4. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)malloc.h 8.5 (Berkeley) 5/3/95 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_MALLOC_H_ 36 #define _SYS_MALLOC_H_ 37 38 #include <sys/param.h> 39 #include <sys/queue.h> 40 #include <sys/_lock.h> 41 #include <sys/_mutex.h> 42 43 #define MINALLOCSIZE UMA_SMALLEST_UNIT 44 45 /* 46 * flags to malloc. 47 */ 48 #define M_NOWAIT 0x0001 /* do not block */ 49 #define M_WAITOK 0x0002 /* ok to block */ 50 #define M_ZERO 0x0100 /* bzero the allocation */ 51 #define M_NOVM 0x0200 /* don't ask VM for pages */ 52 #define M_USE_RESERVE 0x0400 /* can alloc out of reserve memory */ 53 #define M_NODUMP 0x0800 /* don't dump pages in this allocation */ 54 #define M_FIRSTFIT 0x1000 /* Only for vmem, fast fit. */ 55 #define M_BESTFIT 0x2000 /* Only for vmem, low fragmentation. */ 56 57 #define M_MAGIC 877983977 /* time when first defined :-) */ 58 59 /* 60 * Two malloc type structures are present: malloc_type, which is used by a 61 * type owner to declare the type, and malloc_type_internal, which holds 62 * malloc-owned statistics and other ABI-sensitive fields, such as the set of 63 * malloc statistics indexed by the compile-time MAXCPU constant. 64 * Applications should avoid introducing dependence on the allocator private 65 * data layout and size. 66 * 67 * The malloc_type ks_next field is protected by malloc_mtx. Other fields in 68 * malloc_type are static after initialization so unsynchronized. 69 * 70 * Statistics in malloc_type_stats are written only when holding a critical 71 * section and running on the CPU associated with the index into the stat 72 * array, but read lock-free resulting in possible (minor) races, which the 73 * monitoring app should take into account. 74 */ 75 struct malloc_type_stats { 76 uint64_t mts_memalloced; /* Bytes allocated on CPU. */ 77 uint64_t mts_memfreed; /* Bytes freed on CPU. */ 78 uint64_t mts_numallocs; /* Number of allocates on CPU. */ 79 uint64_t mts_numfrees; /* number of frees on CPU. */ 80 uint64_t mts_size; /* Bitmask of sizes allocated on CPU. */ 81 uint64_t _mts_reserved1; /* Reserved field. */ 82 uint64_t _mts_reserved2; /* Reserved field. */ 83 uint64_t _mts_reserved3; /* Reserved field. */ 84 }; 85 86 /* 87 * Index definitions for the mti_probes[] array. 88 */ 89 #define DTMALLOC_PROBE_MALLOC 0 90 #define DTMALLOC_PROBE_FREE 1 91 #define DTMALLOC_PROBE_MAX 2 92 93 struct malloc_type_internal { 94 uint32_t mti_probes[DTMALLOC_PROBE_MAX]; 95 /* DTrace probe ID array. */ 96 u_char mti_zone; 97 struct malloc_type_stats mti_stats[MAXCPU]; 98 }; 99 100 /* 101 * Public data structure describing a malloc type. Private data is hung off 102 * of ks_handle to avoid encoding internal malloc(9) data structures in 103 * modules, which will statically allocate struct malloc_type. 104 */ 105 struct malloc_type { 106 struct malloc_type *ks_next; /* Next in global chain. */ 107 u_long ks_magic; /* Detect programmer error. */ 108 const char *ks_shortdesc; /* Printable type name. */ 109 void *ks_handle; /* Priv. data, was lo_class. */ 110 }; 111 112 /* 113 * Statistics structure headers for user space. The kern.malloc sysctl 114 * exposes a structure stream consisting of a stream header, then a series of 115 * malloc type headers and statistics structures (quantity maxcpus). For 116 * convenience, the kernel will provide the current value of maxcpus at the 117 * head of the stream. 118 */ 119 #define MALLOC_TYPE_STREAM_VERSION 0x00000001 120 struct malloc_type_stream_header { 121 uint32_t mtsh_version; /* Stream format version. */ 122 uint32_t mtsh_maxcpus; /* Value of MAXCPU for stream. */ 123 uint32_t mtsh_count; /* Number of records. */ 124 uint32_t _mtsh_pad; /* Pad/reserved field. */ 125 }; 126 127 #define MALLOC_MAX_NAME 32 128 struct malloc_type_header { 129 char mth_name[MALLOC_MAX_NAME]; 130 }; 131 132 #ifdef _KERNEL 133 #define MALLOC_DEFINE(type, shortdesc, longdesc) \ 134 struct malloc_type type[1] = { \ 135 { NULL, M_MAGIC, shortdesc, NULL } \ 136 }; \ 137 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_THIRD, malloc_init, \ 138 type); \ 139 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, \ 140 malloc_uninit, type) 141 142 #define MALLOC_DECLARE(type) \ 143 extern struct malloc_type type[1] 144 145 MALLOC_DECLARE(M_CACHE); 146 MALLOC_DECLARE(M_DEVBUF); 147 MALLOC_DECLARE(M_TEMP); 148 149 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */ 150 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */ 151 152 /* 153 * Deprecated macro versions of not-quite-malloc() and free(). 154 */ 155 #define MALLOC(space, cast, size, type, flags) \ 156 ((space) = (cast)malloc((u_long)(size), (type), (flags))) 157 #define FREE(addr, type) free((addr), (type)) 158 159 /* 160 * XXX this should be declared in <sys/uio.h>, but that tends to fail 161 * because <sys/uio.h> is included in a header before the source file 162 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined. 163 */ 164 MALLOC_DECLARE(M_IOV); 165 166 extern struct mtx malloc_mtx; 167 168 /* 169 * Function type used when iterating over the list of malloc types. 170 */ 171 typedef void malloc_type_list_func_t(struct malloc_type *, void *); 172 173 void contigfree(void *addr, unsigned long size, struct malloc_type *type); 174 void *contigmalloc(unsigned long size, struct malloc_type *type, int flags, 175 vm_paddr_t low, vm_paddr_t high, unsigned long alignment, 176 vm_paddr_t boundary) __malloc_like __result_use_check 177 __alloc_size(1) __alloc_align(6); 178 void free(void *addr, struct malloc_type *type); 179 void *malloc(unsigned long size, struct malloc_type *type, int flags) 180 __malloc_like __result_use_check __alloc_size(1); 181 void malloc_init(void *); 182 int malloc_last_fail(void); 183 void malloc_type_allocated(struct malloc_type *type, unsigned long size); 184 void malloc_type_freed(struct malloc_type *type, unsigned long size); 185 void malloc_type_list(malloc_type_list_func_t *, void *); 186 void malloc_uninit(void *); 187 void *realloc(void *addr, unsigned long size, struct malloc_type *type, 188 int flags) __result_use_check __alloc_size(2); 189 void *reallocf(void *addr, unsigned long size, struct malloc_type *type, 190 int flags) __alloc_size(2); 191 192 struct malloc_type *malloc_desc2type(const char *desc); 193 #endif /* _KERNEL */ 194 195 #endif /* !_SYS_MALLOC_H_ */ 196