The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/malloc.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 760f385067df1ce2599c218c1ee76775


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.