sys/sys/malloc.h

   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.6 2003/08/25 19:50:33 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_MALLOC_H_
  39 #define _SYS_MALLOC_H_
  40
  41 #ifndef _MACHINE_VMPARAM_H_
  42 #include <machine/vmparam.h>    /* for VM_MIN_KERNEL_ADDRESS */
  43 #endif
  44
  45 #define splmem splhigh
  46
  47 /*
  48  * flags to malloc.
  49  */
  50 #define M_NOWAIT        0x0001  /* do not block */
  51 #define M_WAITOK        0x0002  /* wait for resources */
  52 #define M_ZERO          0x0100  /* bzero() the allocation */
  53 #define M_USE_RESERVE   0x0200  /* can alloc out of reserve memory */
  54
  55 #define M_MAGIC         877983977       /* time when first defined :-) */
  56
  57 struct malloc_type {
  58         struct malloc_type *ks_next;    /* next in list */
  59         long    ks_memuse;      /* total memory held in bytes */
  60         long    ks_limit;       /* most that are allowed to exist */
  61         long    ks_size;        /* sizes of this thing that are allocated */
  62         long    ks_inuse;       /* # of packets of this type currently in use */
  63         int64_t ks_calls;       /* total packets of this type ever allocated */
  64         long    ks_maxused;     /* maximum number ever used */
  65         u_long  ks_magic;       /* if it's not magic, don't touch it */
  66         const char *ks_shortdesc;       /* short description */
  67         u_short ks_limblocks;   /* number of times blocked for hitting limit */
  68         u_short ks_mapblocks;   /* number of times blocked for kernel map */
  69 };
  70
  71 #ifdef _KERNEL
  72 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
  73         struct malloc_type type[1] = { \
  74                 { NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
  75         }; \
  76         SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
  77         SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
  78
  79 #define MALLOC_DECLARE(type) \
  80         extern struct malloc_type type[1]
  81
  82 MALLOC_DECLARE(M_CACHE);
  83 MALLOC_DECLARE(M_DEVBUF);
  84 MALLOC_DECLARE(M_TEMP);
  85
  86 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
  87 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
  88 #endif /* _KERNEL */
  89
  90 /*
  91  * Array of descriptors that describe the contents of each page
  92  */
  93 struct kmemusage {
  94         short ku_indx;          /* bucket index */
  95         union {
  96                 u_short freecnt;/* for small allocations, free pieces in page */
  97                 u_short pagecnt;/* for large allocations, pages alloced */
  98         } ku_un;
  99 };
 100 #define ku_freecnt ku_un.freecnt
 101 #define ku_pagecnt ku_un.pagecnt
 102
 103 /*
 104  * Set of buckets for each size of memory block that is retained
 105  */
 106 struct kmembuckets {
 107         caddr_t kb_next;        /* list of free blocks */
 108         caddr_t kb_last;        /* last free block */
 109         int64_t kb_calls;       /* total calls to allocate this size */
 110         long    kb_total;       /* total number of blocks allocated */
 111         long    kb_elmpercl;    /* # of elements in this sized allocation */
 112         long    kb_totalfree;   /* # of free elements in this bucket */
 113         long    kb_highwat;     /* high water mark */
 114         long    kb_couldfree;   /* over high water mark and could free */
 115 };
 116
 117 #ifdef _KERNEL
 118 #define MINALLOCSIZE    (1 << MINBUCKET)
 119 #define BUCKETINDX(size) \
 120         ((size) <= (MINALLOCSIZE * 128) \
 121                 ? (size) <= (MINALLOCSIZE * 8) \
 122                         ? (size) <= (MINALLOCSIZE * 2) \
 123                                 ? (size) <= (MINALLOCSIZE * 1) \
 124                                         ? (MINBUCKET + 0) \
 125                                         : (MINBUCKET + 1) \
 126                                 : (size) <= (MINALLOCSIZE * 4) \
 127                                         ? (MINBUCKET + 2) \
 128                                         : (MINBUCKET + 3) \
 129                         : (size) <= (MINALLOCSIZE* 32) \
 130                                 ? (size) <= (MINALLOCSIZE * 16) \
 131                                         ? (MINBUCKET + 4) \
 132                                         : (MINBUCKET + 5) \
 133                                 : (size) <= (MINALLOCSIZE * 64) \
 134                                         ? (MINBUCKET + 6) \
 135                                         : (MINBUCKET + 7) \
 136                 : (size) <= (MINALLOCSIZE * 2048) \
 137                         ? (size) <= (MINALLOCSIZE * 512) \
 138                                 ? (size) <= (MINALLOCSIZE * 256) \
 139                                         ? (MINBUCKET + 8) \
 140                                         : (MINBUCKET + 9) \
 141                                 : (size) <= (MINALLOCSIZE * 1024) \
 142                                         ? (MINBUCKET + 10) \
 143                                         : (MINBUCKET + 11) \
 144                         : (size) <= (MINALLOCSIZE * 8192) \
 145                                 ? (size) <= (MINALLOCSIZE * 4096) \
 146                                         ? (MINBUCKET + 12) \
 147                                         : (MINBUCKET + 13) \
 148                                 : (size) <= (MINALLOCSIZE * 16384) \
 149                                         ? (MINBUCKET + 14) \
 150                                         : (MINBUCKET + 15))
 151
 152 /*
 153  * Turn virtual addresses into kmem map indices
 154  */
 155 #if defined(NO_KMEM_MAP)
 156 #define btokup(addr)    (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
 157 #else
 158 #define kmemxtob(alloc) (kmembase + (alloc) * PAGE_SIZE)
 159 #define btokmemx(addr)  (((caddr_t)(addr) - kmembase) / PAGE_SIZE)
 160 #define btokup(addr)    (&kmemusage[((caddr_t)(addr) - kmembase) >> PAGE_SHIFT])
 161 #endif
 162
 163 /*
 164  * Deprecated macro versions of not-quite-malloc() and free().
 165  */
 166 #define MALLOC(space, cast, size, type, flags) \
 167         (space) = (cast)malloc((u_long)(size), (type), (flags))
 168 #define FREE(addr, type) free((addr), (type))
 169
 170 /*
 171  * XXX this should be declared in <sys/uio.h>, but that tends to fail
 172  * because <sys/uio.h> is included in a header before the source file
 173  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
 174  */
 175 MALLOC_DECLARE(M_IOV);
 176
 177 /* XXX struct malloc_type is unused for contig*(). */
 178 void    contigfree (void *addr, unsigned long size,
 179                         struct malloc_type *type);
 180 void    *contigmalloc (unsigned long size, struct malloc_type *type,
 181                            int flags, unsigned long low, unsigned long high,
 182                            unsigned long alignment, unsigned long boundary);
 183 void    free (void *addr, struct malloc_type *type);
 184 void    *malloc (unsigned long size, struct malloc_type *type, int flags);
 185 void    malloc_init (void *);
 186 void    malloc_uninit (void *);
 187 void    *realloc (void *addr, unsigned long size,
 188                       struct malloc_type *type, int flags);
 189 void    *reallocf (void *addr, unsigned long size,
 190                       struct malloc_type *type, int flags);
 191 #endif /* _KERNEL */
 192
 193 #endif /* !_SYS_MALLOC_H_ */