malloc.h revision 43301
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 * $Id: malloc.h,v 1.40 1999/01/21 09:23:21 dillon Exp $ 35 */ 36 37#ifndef _SYS_MALLOC_H_ 38#define _SYS_MALLOC_H_ 39 40#define splmem splhigh 41 42#define KMEMSTATS 43 44/* 45 * flags to malloc. 46 */ 47 48#define M_WAITOK 0x0000 49#define M_NOWAIT 0x0001 /* do not block */ 50#define M_USE_RESERVE 0x0002 /* can alloc out of reserve memory */ 51#define M_ASLEEP 0x0004 /* async sleep on failure */ 52 53#define M_MAGIC 877983977 /* time when first defined :-) */ 54 55struct malloc_type { 56 struct malloc_type *ks_next; /* next in list */ 57 long ks_memuse; /* total memory held in bytes */ 58 long ks_limit; /* most that are allowed to exist */ 59 long ks_size; /* sizes of this thing that are allocated */ 60 long ks_inuse; /* # of packets of this type currently in use */ 61 long ks_calls; /* total packets of this type ever allocated */ 62 long ks_maxused; /* maximum number ever used */ 63 u_long ks_magic; /* if it's not magic, don't touch it */ 64 const char *ks_shortdesc; /* short description */ 65 u_short ks_limblocks; /* number of times blocked for hitting limit */ 66 u_short ks_mapblocks; /* number of times blocked for kernel map */ 67}; 68 69#ifdef KERNEL 70 71void malloc_init __P((void *)); 72void malloc_uninit __P((void *)); 73 74#define MALLOC_DEFINE(type, shortdesc, longdesc) \ 75 struct malloc_type type[1] = { \ 76 { NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \ 77 }; \ 78 SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \ 79 SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type) 80 81#define MALLOC_DECLARE(type) \ 82 extern struct malloc_type type[1] 83 84#ifdef MALLOC_INSTANTIATE 85#define MALLOC_MAKE_TYPE(type, shortdesc, longdesc) \ 86 MALLOC_DEFINE(type, shortdesc, longdesc) 87#else 88#define MALLOC_MAKE_TYPE(type, shortdesc, longdesc) \ 89 MALLOC_DECLARE(type) 90#endif 91 92MALLOC_MAKE_TYPE(M_CACHE, "namecache", "Dynamically allocated cache entries"); 93MALLOC_MAKE_TYPE(M_DEVBUF, "devbuf", "device driver memory"); 94MALLOC_MAKE_TYPE(M_TEMP, "temp", "misc temporary data buffers"); 95#endif /* KERNEL */ 96 97/* 98 * Array of descriptors that describe the contents of each page 99 */ 100struct kmemusage { 101 short ku_indx; /* bucket index */ 102 union { 103 u_short freecnt;/* for small allocations, free pieces in page */ 104 u_short pagecnt;/* for large allocations, pages alloced */ 105 } ku_un; 106}; 107#define ku_freecnt ku_un.freecnt 108#define ku_pagecnt ku_un.pagecnt 109 110/* 111 * Set of buckets for each size of memory block that is retained 112 */ 113struct kmembuckets { 114 caddr_t kb_next; /* list of free blocks */ 115 caddr_t kb_last; /* last free block */ 116 long kb_total; /* total number of blocks allocated */ 117 long kb_elmpercl; /* # of elements in this sized allocation */ 118 long kb_totalfree; /* # of free elements in this bucket */ 119 long kb_calls; /* total calls to allocate this size */ 120 long kb_highwat; /* high water mark */ 121 long kb_couldfree; /* over high water mark and could free */ 122}; 123 124#ifdef KERNEL 125 126#define MINALLOCSIZE (1 << MINBUCKET) 127#define BUCKETINDX(size) \ 128 ((size) <= (MINALLOCSIZE * 128) \ 129 ? (size) <= (MINALLOCSIZE * 8) \ 130 ? (size) <= (MINALLOCSIZE * 2) \ 131 ? (size) <= (MINALLOCSIZE * 1) \ 132 ? (MINBUCKET + 0) \ 133 : (MINBUCKET + 1) \ 134 : (size) <= (MINALLOCSIZE * 4) \ 135 ? (MINBUCKET + 2) \ 136 : (MINBUCKET + 3) \ 137 : (size) <= (MINALLOCSIZE* 32) \ 138 ? (size) <= (MINALLOCSIZE * 16) \ 139 ? (MINBUCKET + 4) \ 140 : (MINBUCKET + 5) \ 141 : (size) <= (MINALLOCSIZE * 64) \ 142 ? (MINBUCKET + 6) \ 143 : (MINBUCKET + 7) \ 144 : (size) <= (MINALLOCSIZE * 2048) \ 145 ? (size) <= (MINALLOCSIZE * 512) \ 146 ? (size) <= (MINALLOCSIZE * 256) \ 147 ? (MINBUCKET + 8) \ 148 : (MINBUCKET + 9) \ 149 : (size) <= (MINALLOCSIZE * 1024) \ 150 ? (MINBUCKET + 10) \ 151 : (MINBUCKET + 11) \ 152 : (size) <= (MINALLOCSIZE * 8192) \ 153 ? (size) <= (MINALLOCSIZE * 4096) \ 154 ? (MINBUCKET + 12) \ 155 : (MINBUCKET + 13) \ 156 : (size) <= (MINALLOCSIZE * 16384) \ 157 ? (MINBUCKET + 14) \ 158 : (MINBUCKET + 15)) 159 160/* 161 * Turn virtual addresses into kmem map indices 162 */ 163#define kmemxtob(alloc) (kmembase + (alloc) * PAGE_SIZE) 164#define btokmemx(addr) (((caddr_t)(addr) - kmembase) / PAGE_SIZE) 165#define btokup(addr) (&kmemusage[((caddr_t)(addr) - kmembase) >> PAGE_SHIFT]) 166 167/* 168 * Macro versions for the usual cases of malloc/free 169 */ 170#if defined(KMEMSTATS) || defined(DIAGNOSTIC) 171#define MALLOC(space, cast, size, type, flags) \ 172 (space) = (cast)malloc((u_long)(size), type, flags) 173#define FREE(addr, type) free((addr), type) 174 175#else /* do not collect statistics */ 176#define MALLOC(space, cast, size, type, flags) do { \ 177 register struct kmembuckets *kbp = &bucket[BUCKETINDX(size)]; \ 178 long s = splmem(); \ 179 if (kbp->kb_next == NULL) { \ 180 (space) = (cast)malloc((u_long)(size), type, flags); \ 181 } else { \ 182 (space) = (cast)kbp->kb_next; \ 183 kbp->kb_next = *(caddr_t *)(space); \ 184 } \ 185 splx(s); \ 186} while (0) 187 188#define FREE(addr, type) do { \ 189 register struct kmembuckets *kbp; \ 190 register struct kmemusage *kup = btokup(addr); \ 191 long s = splmem(); \ 192 if (1 << kup->ku_indx > MAXALLOCSAVE) { \ 193 free((addr), type); \ 194 } else { \ 195 kbp = &bucket[kup->ku_indx]; \ 196 if (kbp->kb_next == NULL) \ 197 kbp->kb_next = (caddr_t)(addr); \ 198 else \ 199 *(caddr_t *)(kbp->kb_last) = (caddr_t)(addr); \ 200 *(caddr_t *)(addr) = NULL; \ 201 kbp->kb_last = (caddr_t)(addr); \ 202 } \ 203 splx(s); \ 204} while (0) 205 206extern struct kmemusage *kmemusage; 207extern char *kmembase; 208extern struct kmembuckets bucket[]; 209#endif /* do not collect statistics */ 210 211/* 212 * XXX this should be declared in <sys/uio.h>, but that tends to fail 213 * because <sys/uio.h> is included in a header before the source file 214 * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined. 215 */ 216MALLOC_DECLARE(M_IOV); 217 218void *contigmalloc __P((unsigned long size, struct malloc_type *type, 219 int flags, 220 unsigned long low, unsigned long high, 221 unsigned long alignment, unsigned long boundary)); 222void free __P((void *addr, struct malloc_type *type)); 223void *malloc __P((unsigned long size, struct malloc_type *type, int flags)); 224#endif /* KERNEL */ 225 226#endif /* !_SYS_MALLOC_H_ */ 227