| 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. All advertising materials mentioning features or use of this software |
| 14 | * must display the following acknowledgement: |
| 15 | * This product includes software developed by the University of |
| 16 | * California, Berkeley and its contributors. |
| 17 | * 4. 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: src/sys/sys/malloc.h,v 1.48.2.2 2002/03/16 02:19:16 archie Exp $ |
| 35 | * $DragonFly: src/sys/sys/malloc.h,v 1.21 2005/03/28 18:49:25 joerg Exp $ |
| 36 | */ |
| 37 | |
| 38 | #ifndef _SYS_MALLOC_H_ |
| 39 | #define _SYS_MALLOC_H_ |
| 40 | |
| 41 | #ifndef _MACHINE_PARAM_H_ |
| 42 | #include <machine/param.h> /* for SMP_MAXCPU */ |
| 43 | #endif |
| 44 | |
| 45 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 46 | |
| 47 | #ifndef _MACHINE_VMPARAM_H_ |
| 48 | #include <machine/vmparam.h> /* for VM_MIN_KERNEL_ADDRESS */ |
| 49 | #endif |
| 50 | |
| 51 | #define splmem splhigh |
| 52 | |
| 53 | #ifndef _MACHINE_TYPES_H_ |
| 54 | #include <machine/types.h> /* vm_paddr_t */ |
| 55 | #endif |
| 56 | |
| 57 | #endif /* _KERNEL */ |
| 58 | |
| 59 | /* |
| 60 | * flags to malloc. |
| 61 | */ |
| 62 | #define M_RNOWAIT 0x0001 /* do not block */ |
| 63 | #define M_WAITOK 0x0002 /* wait for resources / alloc from cache */ |
| 64 | #define M_ZERO 0x0100 /* bzero() the allocation */ |
| 65 | #define M_USE_RESERVE 0x0200 /* can eat into free list reserve */ |
| 66 | #define M_NULLOK 0x0400 /* ok to return NULL */ |
| 67 | #define M_PASSIVE_ZERO 0x0800 /* (internal to the slab code only) */ |
| 68 | #define M_USE_INTERRUPT_RESERVE \ |
| 69 | 0x1000 /* can exhaust free list entirely */ |
| 70 | |
| 71 | /* |
| 72 | * M_NOWAIT has to be a set of flags for equivalence to prior use. |
| 73 | * |
| 74 | * M_SYSALLOC should be used for any critical infrastructure allocations |
| 75 | * made by the kernel proper. |
| 76 | * |
| 77 | * M_INTNOWAIT should be used for any critical infrastructure allocations |
| 78 | * made by interrupts. Such allocations can still fail but will not fail |
| 79 | * as often as M_NOWAIT. |
| 80 | * |
| 81 | * NOTE ON DRAGONFLY USE OF M_NOWAIT. In FreeBSD M_NOWAIT allocations |
| 82 | * almost always succeed. In DragonFly, however, there is a good chance |
| 83 | * that an allocation will fail. M_NOWAIT should only be used when |
| 84 | * allocations can fail without any serious detriment to the system. |
| 85 | * |
| 86 | * Note that allocations made from (preempted) interrupts will attempt to |
| 87 | * use pages from the VM PAGE CACHE (PQ_CACHE) (i.e. those associated with |
| 88 | * objects). This is automatic. |
| 89 | */ |
| 90 | |
| 91 | #define M_INTNOWAIT (M_RNOWAIT | M_NULLOK | \ |
| 92 | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE) |
| 93 | #define M_SYSNOWAIT (M_RNOWAIT | M_NULLOK | M_USE_RESERVE) |
| 94 | #define M_INTWAIT (M_WAITOK | M_USE_RESERVE | M_USE_INTERRUPT_RESERVE) |
| 95 | #define M_SYSWAIT (M_WAITOK | M_USE_RESERVE) |
| 96 | |
| 97 | #define M_NOWAIT M_INTNOWAIT |
| 98 | #define M_SYSALLOC M_SYSWAIT |
| 99 | |
| 100 | #define M_MAGIC 877983977 /* time when first defined :-) */ |
| 101 | |
| 102 | /* |
| 103 | * The malloc tracking structure. Note that per-cpu entries must be |
| 104 | * aggregated for accurate statistics, they do not actually break the |
| 105 | * stats down by cpu (e.g. the cpu freeing memory will subtract from |
| 106 | * its slot, not the originating cpu's slot). |
| 107 | * |
| 108 | * SMP_MAXCPU is used so modules which use malloc remain compatible |
| 109 | * between UP and SMP. |
| 110 | */ |
| 111 | struct malloc_type { |
| 112 | struct malloc_type *ks_next; /* next in list */ |
| 113 | long ks_memuse[SMP_MAXCPU]; /* total memory held in bytes */ |
| 114 | long ks_loosememuse; /* (inaccurate) aggregate memuse */ |
| 115 | long ks_limit; /* most that are allowed to exist */ |
| 116 | long ks_size; /* sizes of this thing that are allocated */ |
| 117 | long ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */ |
| 118 | __int64_t ks_calls; /* total packets of this type ever allocated */ |
| 119 | long ks_maxused; /* maximum number ever used */ |
| 120 | __uint32_t ks_magic; /* if it's not magic, don't touch it */ |
| 121 | const char *ks_shortdesc; /* short description */ |
| 122 | __uint16_t ks_limblocks; /* number of times blocked for hitting limit */ |
| 123 | __uint16_t ks_mapblocks; /* number of times blocked for kernel map */ |
| 124 | long ks_reserved[4]; /* future use (module compatibility) */ |
| 125 | }; |
| 126 | |
| 127 | typedef struct malloc_type *malloc_type_t; |
| 128 | |
| 129 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 130 | |
| 131 | #define MALLOC_DEFINE(type, shortdesc, longdesc) \ |
| 132 | struct malloc_type type[1] = { \ |
| 133 | { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0, { 0 } } \ |
| 134 | }; \ |
| 135 | SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \ |
| 136 | SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type) |
| 137 | |
| 138 | #else |
| 139 | |
| 140 | #define MALLOC_DEFINE(type, shortdesc, longdesc) \ |
| 141 | struct malloc_type type[1] = { \ |
| 142 | { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \ |
| 143 | }; |
| 144 | |
| 145 | #endif |
| 146 | |
| 147 | #define MALLOC_DECLARE(type) \ |
| 148 | extern struct malloc_type type[1] |
| 149 | |
| 150 | #ifdef _KERNEL |
| 151 | |
| 152 | MALLOC_DECLARE(M_CACHE); |
| 153 | MALLOC_DECLARE(M_DEVBUF); |
| 154 | MALLOC_DECLARE(M_TEMP); |
| 155 | |
| 156 | MALLOC_DECLARE(M_IP6OPT); /* for INET6 */ |
| 157 | MALLOC_DECLARE(M_IP6NDP); /* for INET6 */ |
| 158 | |
| 159 | #endif /* _KERNEL */ |
| 160 | |
| 161 | /* |
| 162 | * Array of descriptors that describe the contents of each page |
| 163 | */ |
| 164 | struct kmemusage { |
| 165 | short ku_cpu; /* cpu index */ |
| 166 | union { |
| 167 | __int16_t freecnt;/* for small allocations, free pieces in page */ |
| 168 | __int16_t pagecnt;/* for large allocations, pages alloced */ |
| 169 | } ku_un; |
| 170 | }; |
| 171 | #define ku_freecnt ku_un.freecnt |
| 172 | #define ku_pagecnt ku_un.pagecnt |
| 173 | |
| 174 | #ifdef _KERNEL |
| 175 | |
| 176 | #define MINALLOCSIZE sizeof(void *) |
| 177 | |
| 178 | /* |
| 179 | * Turn virtual addresses into kmem map indices |
| 180 | */ |
| 181 | #define btokup(addr) (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT]) |
| 182 | |
| 183 | /* |
| 184 | * Deprecated macro versions of not-quite-malloc() and free(). |
| 185 | */ |
| 186 | #define MALLOC(space, cast, size, type, flags) \ |
| 187 | (space) = (cast)malloc((u_long)(size), (type), (flags)) |
| 188 | #define FREE(addr, type) free((addr), (type)) |
| 189 | |
| 190 | /* |
| 191 | * XXX this should be declared in <sys/uio.h>, but that tends to fail |
| 192 | * because <sys/uio.h> is included in a header before the source file |
| 193 | * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined. |
| 194 | */ |
| 195 | MALLOC_DECLARE(M_IOV); |
| 196 | |
| 197 | /* XXX struct malloc_type is unused for contig*(). */ |
| 198 | void contigfree (void *addr, unsigned long size, |
| 199 | struct malloc_type *type); |
| 200 | void *contigmalloc (unsigned long size, struct malloc_type *type, |
| 201 | int flags, vm_paddr_t low, vm_paddr_t high, |
| 202 | unsigned long alignment, unsigned long boundary); |
| 203 | void free (void *addr, struct malloc_type *type); |
| 204 | void *malloc (unsigned long size, struct malloc_type *type, int flags); |
| 205 | void malloc_init (void *); |
| 206 | void malloc_uninit (void *); |
| 207 | void *realloc (void *addr, unsigned long size, |
| 208 | struct malloc_type *type, int flags); |
| 209 | void *reallocf (void *addr, unsigned long size, |
| 210 | struct malloc_type *type, int flags); |
| 211 | char *strdup (const char *, struct malloc_type *); |
| 212 | |
| 213 | #endif /* _KERNEL */ |
| 214 | |
| 215 | #endif /* !_SYS_MALLOC_H_ */ |