sys/sys/malloc.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1987, 1993
   5  *      The Regents of the University of California.
   6  * Copyright (c) 2005, 2009 Robert N. M. Watson
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. 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.
  20  *
  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
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)malloc.h    8.5 (Berkeley) 5/3/95
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _SYS_MALLOC_H_
  38 #define _SYS_MALLOC_H_
  39
  40 #include <sys/param.h>
  41 #ifdef _KERNEL
  42 #include <sys/systm.h>
  43 #endif
  44 #include <sys/queue.h>
  45 #include <sys/_lock.h>
  46 #include <sys/_mutex.h>
  47 #include <machine/_limits.h>
  48
  49 #define MINALLOCSIZE    UMA_SMALLEST_UNIT
  50
  51 /*
  52  * Flags to memory allocation functions.
  53  */
  54 #define M_NOWAIT        0x0001          /* do not block */
  55 #define M_WAITOK        0x0002          /* ok to block */
  56 #define M_ZERO          0x0100          /* bzero the allocation */
  57 #define M_NOVM          0x0200          /* don't ask VM for pages */
  58 #define M_USE_RESERVE   0x0400          /* can alloc out of reserve memory */
  59 #define M_NODUMP        0x0800          /* don't dump pages in this allocation */
  60 #define M_FIRSTFIT      0x1000          /* Only for vmem, fast fit. */
  61 #define M_BESTFIT       0x2000          /* Only for vmem, low fragmentation. */
  62 #define M_EXEC          0x4000          /* allocate executable space. */
  63
  64 #define M_MAGIC         877983977       /* time when first defined :-) */
  65
  66 #ifdef INVARIANTS
  67 #define M_ZERO_INVARIANTS               M_ZERO
  68 #else
  69 #define M_ZERO_INVARIANTS               0
  70 #endif
  71
  72
  73 /*
  74  * Two malloc type structures are present: malloc_type, which is used by a
  75  * type owner to declare the type, and malloc_type_internal, which holds
  76  * malloc-owned statistics and other ABI-sensitive fields, such as the set of
  77  * malloc statistics indexed by the compile-time MAXCPU constant.
  78  * Applications should avoid introducing dependence on the allocator private
  79  * data layout and size.
  80  *
  81  * The malloc_type ks_next field is protected by malloc_mtx.  Other fields in
  82  * malloc_type are static after initialization so unsynchronized.
  83  *
  84  * Statistics in malloc_type_stats are written only when holding a critical
  85  * section and running on the CPU associated with the index into the stat
  86  * array, but read lock-free resulting in possible (minor) races, which the
  87  * monitoring app should take into account.
  88  */
  89 struct malloc_type_stats {
  90         uint64_t        mts_memalloced; /* Bytes allocated on CPU. */
  91         uint64_t        mts_memfreed;   /* Bytes freed on CPU. */
  92         uint64_t        mts_numallocs;  /* Number of allocates on CPU. */
  93         uint64_t        mts_numfrees;   /* number of frees on CPU. */
  94         uint64_t        mts_size;       /* Bitmask of sizes allocated on CPU. */
  95         uint64_t        _mts_reserved1; /* Reserved field. */
  96         uint64_t        _mts_reserved2; /* Reserved field. */
  97         uint64_t        _mts_reserved3; /* Reserved field. */
  98 };
  99
 100 /*
 101  * Index definitions for the mti_probes[] array.
 102  */
 103 #define DTMALLOC_PROBE_MALLOC           0
 104 #define DTMALLOC_PROBE_FREE             1
 105 #define DTMALLOC_PROBE_MAX              2
 106
 107 struct malloc_type_internal {
 108         uint32_t        mti_probes[DTMALLOC_PROBE_MAX];
 109                                         /* DTrace probe ID array. */
 110         u_char          mti_zone;
 111         struct malloc_type_stats        mti_stats[MAXCPU];
 112 };
 113
 114 /*
 115  * Public data structure describing a malloc type.  Private data is hung off
 116  * of ks_handle to avoid encoding internal malloc(9) data structures in
 117  * modules, which will statically allocate struct malloc_type.
 118  */
 119 struct malloc_type {
 120         struct malloc_type *ks_next;    /* Next in global chain. */
 121         u_long           ks_magic;      /* Detect programmer error. */
 122         const char      *ks_shortdesc;  /* Printable type name. */
 123         void            *ks_handle;     /* Priv. data, was lo_class. */
 124 };
 125
 126 /*
 127  * Statistics structure headers for user space.  The kern.malloc sysctl
 128  * exposes a structure stream consisting of a stream header, then a series of
 129  * malloc type headers and statistics structures (quantity maxcpus).  For
 130  * convenience, the kernel will provide the current value of maxcpus at the
 131  * head of the stream.
 132  */
 133 #define MALLOC_TYPE_STREAM_VERSION      0x00000001
 134 struct malloc_type_stream_header {
 135         uint32_t        mtsh_version;   /* Stream format version. */
 136         uint32_t        mtsh_maxcpus;   /* Value of MAXCPU for stream. */
 137         uint32_t        mtsh_count;     /* Number of records. */
 138         uint32_t        _mtsh_pad;      /* Pad/reserved field. */
 139 };
 140
 141 #define MALLOC_MAX_NAME 32
 142 struct malloc_type_header {
 143         char                            mth_name[MALLOC_MAX_NAME];
 144 };
 145
 146 #ifdef _KERNEL
 147 #define MALLOC_DEFINE(type, shortdesc, longdesc)                        \
 148         struct malloc_type type[1] = {                                  \
 149                 { NULL, M_MAGIC, shortdesc, NULL }                      \
 150         };                                                              \
 151         SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_THIRD, malloc_init,  \
 152             type);                                                      \
 153         SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY,             \
 154             malloc_uninit, type)
 155
 156 #define MALLOC_DECLARE(type) \
 157         extern struct malloc_type type[1]
 158
 159 MALLOC_DECLARE(M_CACHE);
 160 MALLOC_DECLARE(M_DEVBUF);
 161 MALLOC_DECLARE(M_TEMP);
 162
 163 /*
 164  * XXX this should be declared in <sys/uio.h>, but that tends to fail
 165  * because <sys/uio.h> is included in a header before the source file
 166  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
 167  */
 168 MALLOC_DECLARE(M_IOV);
 169
 170 extern struct mtx malloc_mtx;
 171
 172 /*
 173  * Function type used when iterating over the list of malloc types.
 174  */
 175 typedef void malloc_type_list_func_t(struct malloc_type *, void *);
 176
 177 void    contigfree(void *addr, unsigned long size, struct malloc_type *type);
 178 void    *contigmalloc(unsigned long size, struct malloc_type *type, int flags,
 179             vm_paddr_t low, vm_paddr_t high, unsigned long alignment,
 180             vm_paddr_t boundary) __malloc_like __result_use_check
 181             __alloc_size(1) __alloc_align(6);
 182 void    *contigmalloc_domain(unsigned long size, struct malloc_type *type,
 183             int domain, int flags, vm_paddr_t low, vm_paddr_t high,
 184             unsigned long alignment, vm_paddr_t boundary)
 185             __malloc_like __result_use_check __alloc_size(1) __alloc_align(6);
 186 void    free(void *addr, struct malloc_type *type);
 187 void    free_domain(void *addr, struct malloc_type *type);
 188 void    *malloc(size_t size, struct malloc_type *type, int flags) __malloc_like
 189             __result_use_check __alloc_size(1);
 190 /*
 191  * Try to optimize malloc(..., ..., M_ZERO) allocations by doing zeroing in
 192  * place if the size is known at compilation time.
 193  *
 194  * Passing the flag down requires malloc to blindly zero the entire object.
 195  * In practice a lot of the zeroing can be avoided if most of the object
 196  * gets explicitly initialized after the allocation. Letting the compiler
 197  * zero in place gives it the opportunity to take advantage of this state.
 198  *
 199  * Note that the operation is only applicable if both flags and size are
 200  * known at compilation time. If M_ZERO is passed but M_WAITOK is not, the
 201  * allocation can fail and a NULL check is needed. However, if M_WAITOK is
 202  * passed we know the allocation must succeed and the check can be elided.
 203  *
 204  *      _malloc_item = malloc(_size, type, (flags) &~ M_ZERO);
 205  *      if (((flags) & M_WAITOK) != 0 || _malloc_item != NULL)
 206  *              bzero(_malloc_item, _size);
 207  *
 208  * If the flag is set, the compiler knows the left side is always true,
 209  * therefore the entire statement is true and the callsite is:
 210  *
 211  *      _malloc_item = malloc(_size, type, (flags) &~ M_ZERO);
 212  *      bzero(_malloc_item, _size);
 213  *
 214  * If the flag is not set, the compiler knows the left size is always false
 215  * and the NULL check is needed, therefore the callsite is:
 216  *
 217  *      _malloc_item = malloc(_size, type, (flags) &~ M_ZERO);
 218  *      if (_malloc_item != NULL)
 219  *              bzero(_malloc_item, _size);
 220  *
 221  * The implementation is a macro because of what appears to be a clang 6 bug:
 222  * an inline function variant ended up being compiled to a mere malloc call
 223  * regardless of argument. gcc generates expected code (like the above).
 224  */
 225 #ifdef _KERNEL
 226 #define malloc(size, type, flags) ({                                    \
 227         void *_malloc_item;                                             \
 228         size_t _size = (size);                                          \
 229         if (__builtin_constant_p(size) && __builtin_constant_p(flags) &&\
 230             ((flags) & M_ZERO) != 0) {                                  \
 231                 _malloc_item = malloc(_size, type, (flags) &~ M_ZERO);  \
 232                 if (((flags) & M_WAITOK) != 0 ||                        \
 233                     __predict_true(_malloc_item != NULL))               \
 234                         bzero(_malloc_item, _size);                     \
 235         } else {                                                        \
 236                 _malloc_item = malloc(_size, type, flags);              \
 237         }                                                               \
 238         _malloc_item;                                                   \
 239 })
 240 #endif
 241
 242 void    *malloc_domain(size_t size, struct malloc_type *type, int domain,
 243             int flags) __malloc_like __result_use_check __alloc_size(1);
 244 void    *mallocarray(size_t nmemb, size_t size, struct malloc_type *type,
 245             int flags) __malloc_like __result_use_check
 246             __alloc_size2(1, 2);
 247 void    malloc_init(void *);
 248 int     malloc_last_fail(void);
 249 void    malloc_type_allocated(struct malloc_type *type, unsigned long size);
 250 void    malloc_type_freed(struct malloc_type *type, unsigned long size);
 251 void    malloc_type_list(malloc_type_list_func_t *, void *);
 252 void    malloc_uninit(void *);
 253 void    *realloc(void *addr, size_t size, struct malloc_type *type, int flags)
 254             __result_use_check __alloc_size(2);
 255 void    *reallocf(void *addr, size_t size, struct malloc_type *type, int flags)
 256             __result_use_check __alloc_size(2);
 257
 258 struct malloc_type *malloc_desc2type(const char *desc);
 259
 260 /*
 261  * This is sqrt(SIZE_MAX+1), as s1*s2 <= SIZE_MAX
 262  * if both s1 < MUL_NO_OVERFLOW and s2 < MUL_NO_OVERFLOW
 263  */
 264 #define MUL_NO_OVERFLOW         (1UL << (sizeof(size_t) * 8 / 2))
 265 static inline bool
 266 WOULD_OVERFLOW(size_t nmemb, size_t size)
 267 {
 268
 269         return ((nmemb >= MUL_NO_OVERFLOW || size >= MUL_NO_OVERFLOW) &&
 270             nmemb > 0 && __SIZE_T_MAX / nmemb < size);
 271 }
 272 #undef MUL_NO_OVERFLOW
 273 #endif /* _KERNEL */
 274
 275 #endif /* !_SYS_MALLOC_H_ */