1 /*- 2 * Copyright (c) 1987, 1993 3 * The Regents of the University of California. 4 * Copyright (c) 2005 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 54 #define M_MAGIC 877983977 /* time when first defined :-) */ 55 56 /* 57 * Two malloc type structures are present: malloc_type, which is used by a 58 * type owner to declare the type, and malloc_type_internal, which holds 59 * malloc-owned statistics and other ABI-sensitive fields, such as the set of 60 * malloc statistics indexed by the compile-time MAXCPU constant. 61 * Applications should avoid introducing dependence on the allocator private 62 * data layout and size. 63 * 64 * The malloc_type ks_next field is protected by malloc_mtx. Other fields in 65 * malloc_type are static after initialization so unsynchronized. 66 * 67 * Statistics in malloc_type_stats are written only when holding a critical 68 * section and running on the CPU associated with the index into the stat 69 * array, but read lock-free resulting in possible (minor) races, which the 70 * monitoring app should take into account. 71 */ 72 struct malloc_type_stats { 73 uint64_t mts_memalloced; /* Bytes allocated on CPU. */ 74 uint64_t mts_memfreed; /* Bytes freed on CPU. */ 75 uint64_t mts_numallocs; /* Number of allocates on CPU. */ 76 uint64_t mts_numfrees; /* number of frees on CPU. */ 77 uint64_t mts_size; /* Bitmask of sizes allocated on CPU. */ 78 uint64_t _mts_reserved1; /* Reserved field. */ 79 uint64_t _mts_reserved2; /* Reserved field. */ 80 uint64_t _mts_reserved3; /* Reserved field. */ 81 }; 82 83 /* 84 * Index definitions for the mti_probes[] array. 85 */ 86 #define DTMALLOC_PROBE_MALLOC 0 87 #define DTMALLOC_PROBE_FREE 1 88 #define DTMALLOC_PROBE_MAX 2 89 90 struct malloc_type_internal { 91 uint32_t mti_probes[DTMALLOC_PROBE_MAX]; 92 /* DTrace probe ID array. */ 93 struct malloc_type_stats mti_stats[MAXCPU]; 94 }; 95 96 /* 97 * ABI-compatible version of the old 'struct malloc_type', only all stats are 98 * now malloc-managed in malloc-owned memory rather than in caller memory, so 99 * as to avoid ABI issues. The ks_next pointer is reused as a pointer to the 100 * internal data handle. 101 */ 102 struct malloc_type { 103 struct malloc_type *ks_next; /* Next in global chain. */ 104 u_long _ks_memuse; /* No longer used. */ 105 u_long _ks_size; /* No longer used. */ 106 u_long _ks_inuse; /* No longer used. */ 107 uint64_t _ks_calls; /* No longer used. */ 108 u_long _ks_maxused; /* No longer used. */ 109 u_long ks_magic; /* Detect programmer error. */ 110 const char *ks_shortdesc; /* Printable type name. */ 111 112 /* 113 * struct malloc_type was terminated with a struct mtx, which is no 114 * longer required. For ABI reasons, continue to flesh out the full 115 * size of the old structure, but reuse the _lo_class field for our 116 * internal data handle. 117 */ 118 void *ks_handle; /* Priv. data, was lo_class. */ 119 const char *_lo_name; 120 const char *_lo_type; 121 u_int _lo_flags; 122 void *_lo_list_next; 123 struct witness *_lo_witness; 124 uintptr_t _mtx_lock; 125 u_int _mtx_recurse; 126 }; 127 128 /* 129 * Statistics structure headers for user space. The kern.malloc sysctl 130 * exposes a structure stream consisting of a stream header, then a series of 131 * malloc type headers and statistics structures (quantity maxcpus). For 132 * convenience, the kernel will provide the current value of maxcpus at the 133 * head of the stream. 134 */ 135 #define MALLOC_TYPE_STREAM_VERSION 0x00000001 136 struct malloc_type_stream_header { 137 uint32_t mtsh_version; /* Stream format version. */ 138 uint32_t mtsh_maxcpus; /* Value of MAXCPU for stream. */ 139 uint32_t mtsh_count; /* Number of records. */ 140 uint32_t _mtsh_pad; /* Pad/reserved field. */ 141 }; 142 143 #define MALLOC_MAX_NAME 32 144 struct malloc_type_header { 145 char mth_name[MALLOC_MAX_NAME]; 146 }; 147 148 #ifdef _KERNEL 149 #define MALLOC_DEFINE(type, shortdesc, longdesc) \ 150 struct malloc_type type[1] = { \ 151 { NULL, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, NULL, NULL, \ 152 NULL, 0, NULL, NULL, 0, 0 } \ 153 }; \ 154 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_SECOND, malloc_init, \ 155 type); \ 156 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, \ 157 malloc_uninit, type) 158 159 #define MALLOC_DECLARE(type) \ 160 extern struct malloc_type type[1] 161 162 MALLOC_DECLARE(M_CACHE); 163 MALLOC_DECLARE(M_DEVBUF); 164 MALLOC_DECLARE(M_TEMP); 165 166 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */ 167 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */ 168 169 /* 170 * Deprecated macro versions of not-quite-malloc() and free(). 171 */ 172 #define MALLOC(space, cast, size, type, flags) \ 173 ((space) = (cast)malloc((u_long)(size), (type), (flags))) 174 #define FREE(addr, type) free((addr), (type)) 175 176 /* 177 * XXX this should be declared in <sys/uio.h>, but that tends to fail 178 * because <sys/uio.h> is included in a header before the source file 179 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined. 180 */ 181 MALLOC_DECLARE(M_IOV); 182 183 extern struct mtx malloc_mtx; 184 185 /* 186 * Function type used when iterating over the list of malloc types. 187 */ 188 typedef void malloc_type_list_func_t(struct malloc_type *, void *); 189 190 void contigfree(void *addr, unsigned long size, struct malloc_type *type); 191 void *contigmalloc(unsigned long size, struct malloc_type *type, int flags, 192 vm_paddr_t low, vm_paddr_t high, unsigned long alignment, 193 unsigned long boundary); 194 void free(void *addr, struct malloc_type *type); 195 void *malloc(unsigned long size, struct malloc_type *type, int flags); 196 void malloc_init(void *); 197 int malloc_last_fail(void); 198 void malloc_type_allocated(struct malloc_type *type, unsigned long size); 199 void malloc_type_freed(struct malloc_type *type, unsigned long size); 200 void malloc_type_list(malloc_type_list_func_t *, void *); 201 void malloc_uninit(void *); 202 void *realloc(void *addr, unsigned long size, struct malloc_type *type, 203 int flags); 204 void *reallocf(void *addr, unsigned long size, struct malloc_type *type, 205 int flags); 206 207 struct malloc_type *malloc_desc2type(const char *desc); 208 #endif /* _KERNEL */ 209 210 #endif /* !_SYS_MALLOC_H_ */ 211