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.16 2003/11/30 20:13:53 dillon 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_NOWAIT        0x0001  /* do not block */
  63 #define M_WAITOK        0x0002  /* wait for resources */
  64 #define M_ZERO          0x0100  /* bzero() the allocation */
  65 #define M_USE_RESERVE   0x0200  /* can alloc out of reserve memory */
  66 #define M_NULLOK        0x0400  /* ok to return NULL in M_WAITOK case */
  67 #define M_PASSIVE_ZERO  0x0800  /* (internal to the slab code only) */
  68
  69 #define M_MAGIC         877983977       /* time when first defined :-) */
  70
  71 /*
  72  * The malloc tracking structure.  Note that per-cpu entries must be
  73  * aggregated for accurate statistics, they do not actually break the
  74  * stats down by cpu (e.g. the cpu freeing memory will subtract from
  75  * its slot, not the originating cpu's slot).
  76  *
  77  * SMP_MAXCPU is used so modules which use malloc remain compatible
  78  * between UP and SMP.
  79  */
  80 struct malloc_type {
  81         struct malloc_type *ks_next;    /* next in list */
  82         long    ks_memuse[SMP_MAXCPU];  /* total memory held in bytes */
  83         long    ks_loosememuse;         /* (inaccurate) aggregate memuse */
  84         long    ks_limit;       /* most that are allowed to exist */
  85         long    ks_size;        /* sizes of this thing that are allocated */
  86         long    ks_inuse[SMP_MAXCPU]; /* # of allocs currently in use */
  87         __int64_t ks_calls;     /* total packets of this type ever allocated */
  88         long    ks_maxused;     /* maximum number ever used */
  89         __uint32_t ks_magic;    /* if it's not magic, don't touch it */
  90         const char *ks_shortdesc;       /* short description */
  91         __uint16_t ks_limblocks; /* number of times blocked for hitting limit */
  92         __uint16_t ks_mapblocks; /* number of times blocked for kernel map */
  93         long    ks_reserved[4]; /* future use (module compatibility) */
  94 };
  95
  96 typedef struct malloc_type      *malloc_type_t;
  97
  98 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  99
 100 #define MALLOC_DEFINE(type, shortdesc, longdesc)        \
 101         struct malloc_type type[1] = {                  \
 102             { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
 103         };                                                                  \
 104         SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_ANY, malloc_init, type); \
 105         SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
 106
 107 #else
 108
 109 #define MALLOC_DEFINE(type, shortdesc, longdesc)        \
 110         struct malloc_type type[1] = {                  \
 111             { NULL, { 0 }, 0, 0, 0, { 0 }, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
 112         };
 113
 114 #endif
 115
 116 #define MALLOC_DECLARE(type) \
 117         extern struct malloc_type type[1]
 118
 119 #ifdef _KERNEL
 120
 121 MALLOC_DECLARE(M_CACHE);
 122 MALLOC_DECLARE(M_DEVBUF);
 123 MALLOC_DECLARE(M_TEMP);
 124
 125 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
 126 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
 127
 128 #endif /* _KERNEL */
 129
 130 /*
 131  * Array of descriptors that describe the contents of each page
 132  */
 133 struct kmemusage {
 134         short ku_cpu;           /* cpu index */
 135         union {
 136                 __int16_t freecnt;/* for small allocations, free pieces in page */
 137                 __int16_t pagecnt;/* for large allocations, pages alloced */
 138         } ku_un;
 139 };
 140 #define ku_freecnt ku_un.freecnt
 141 #define ku_pagecnt ku_un.pagecnt
 142
 143 #ifdef _KERNEL
 144
 145 #define MINALLOCSIZE    sizeof(void *)
 146
 147 /*
 148  * Turn virtual addresses into kmem map indices
 149  */
 150 #define btokup(addr)    (&kmemusage[((caddr_t)(addr) - (caddr_t)VM_MIN_KERNEL_ADDRESS) >> PAGE_SHIFT])
 151
 152 /*
 153  * Deprecated macro versions of not-quite-malloc() and free().
 154  */
 155 #define MALLOC(space, cast, size, type, flags) \
 156         (space) = (cast)malloc((u_long)(size), (type), (flags))
 157 #define FREE(addr, type) free((addr), (type))
 158
 159 /*
 160  * XXX this should be declared in <sys/uio.h>, but that tends to fail
 161  * because <sys/uio.h> is included in a header before the source file
 162  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
 163  */
 164 MALLOC_DECLARE(M_IOV);
 165
 166 /* XXX struct malloc_type is unused for contig*(). */
 167 void    contigfree (void *addr, unsigned long size,
 168                         struct malloc_type *type);
 169 void    *contigmalloc (unsigned long size, struct malloc_type *type,
 170                            int flags, vm_paddr_t low, vm_paddr_t high,
 171                            unsigned long alignment, unsigned long boundary);
 172 void    free (void *addr, struct malloc_type *type);
 173 void    *malloc (unsigned long size, struct malloc_type *type, int flags);
 174 void    malloc_init (void *);
 175 void    malloc_uninit (void *);
 176 void    *realloc (void *addr, unsigned long size,
 177                       struct malloc_type *type, int flags);
 178 void    *reallocf (void *addr, unsigned long size,
 179                       struct malloc_type *type, int flags);
 180
 181 #endif /* _KERNEL */
 182
 183 #endif /* !_SYS_MALLOC_H_ */