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  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 1987, 1993
    3  *      The Regents of the University of California.
    4  * Copyright (c) 2005, 2009 Robert N. M. Watson
    5  * All rights reserved.
    6  *
    7  * Redistribution and use in source and binary forms, with or without
    8  * modification, are permitted provided that the following conditions
    9  * are met:
   10  * 1. Redistributions of source code must retain the above copyright
   11  *    notice, this list of conditions and the following disclaimer.
   12  * 2. Redistributions in binary form must reproduce the above copyright
   13  *    notice, this list of conditions and the following disclaimer in the
   14  *    documentation and/or other materials provided with the distribution.
   15  * 4. Neither the name of the University nor the names of its contributors
   16  *    may be used to endorse or promote products derived from this software
   17  *    without specific prior written permission.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   29  * SUCH DAMAGE.
   30  *
   31  *      @(#)malloc.h    8.5 (Berkeley) 5/3/95
   32  * $FreeBSD: releng/9.1/sys/sys/malloc.h 232066 2012-02-23 19:20:36Z kmacy $
   33  */
   34 
   35 #ifndef _SYS_MALLOC_H_
   36 #define _SYS_MALLOC_H_
   37 
   38 #include <sys/param.h>
   39 #include <sys/queue.h>
   40 #include <sys/_lock.h>
   41 #include <sys/_mutex.h>
   42 
   43 #define MINALLOCSIZE    UMA_SMALLEST_UNIT
   44 
   45 /*
   46  * flags to malloc.
   47  */
   48 #define M_NOWAIT        0x0001          /* do not block */
   49 #define M_WAITOK        0x0002          /* ok to block */
   50 #define M_ZERO          0x0100          /* bzero the allocation */
   51 #define M_NOVM          0x0200          /* don't ask VM for pages */
   52 #define M_USE_RESERVE   0x0400          /* can alloc out of reserve memory */
   53 #define M_NODUMP        0x0800          /* don't dump pages in this allocation */
   54 
   55 #define M_MAGIC         877983977       /* time when first defined :-) */
   56 
   57 /*
   58  * Two malloc type structures are present: malloc_type, which is used by a
   59  * type owner to declare the type, and malloc_type_internal, which holds
   60  * malloc-owned statistics and other ABI-sensitive fields, such as the set of
   61  * malloc statistics indexed by the compile-time MAXCPU constant.
   62  * Applications should avoid introducing dependence on the allocator private
   63  * data layout and size.
   64  *
   65  * The malloc_type ks_next field is protected by malloc_mtx.  Other fields in
   66  * malloc_type are static after initialization so unsynchronized.
   67  *
   68  * Statistics in malloc_type_stats are written only when holding a critical
   69  * section and running on the CPU associated with the index into the stat
   70  * array, but read lock-free resulting in possible (minor) races, which the
   71  * monitoring app should take into account.
   72  */
   73 struct malloc_type_stats {
   74         uint64_t        mts_memalloced; /* Bytes allocated on CPU. */
   75         uint64_t        mts_memfreed;   /* Bytes freed on CPU. */
   76         uint64_t        mts_numallocs;  /* Number of allocates on CPU. */
   77         uint64_t        mts_numfrees;   /* number of frees on CPU. */
   78         uint64_t        mts_size;       /* Bitmask of sizes allocated on CPU. */
   79         uint64_t        _mts_reserved1; /* Reserved field. */
   80         uint64_t        _mts_reserved2; /* Reserved field. */
   81         uint64_t        _mts_reserved3; /* Reserved field. */
   82 };
   83 
   84 /*
   85  * Index definitions for the mti_probes[] array.
   86  */
   87 #define DTMALLOC_PROBE_MALLOC           0
   88 #define DTMALLOC_PROBE_FREE             1
   89 #define DTMALLOC_PROBE_MAX              2
   90 
   91 struct malloc_type_internal {
   92         uint32_t        mti_probes[DTMALLOC_PROBE_MAX];
   93                                         /* DTrace probe ID array. */
   94         u_char          mti_zone;
   95         struct malloc_type_stats        mti_stats[MAXCPU];
   96 };
   97 
   98 /*
   99  * Public data structure describing a malloc type.  Private data is hung off
  100  * of ks_handle to avoid encoding internal malloc(9) data structures in
  101  * modules, which will statically allocate struct malloc_type.
  102  */
  103 struct malloc_type {
  104         struct malloc_type *ks_next;    /* Next in global chain. */
  105         u_long           ks_magic;      /* Detect programmer error. */
  106         const char      *ks_shortdesc;  /* Printable type name. */
  107         void            *ks_handle;     /* Priv. data, was lo_class. */
  108 };
  109 
  110 /*
  111  * Statistics structure headers for user space.  The kern.malloc sysctl
  112  * exposes a structure stream consisting of a stream header, then a series of
  113  * malloc type headers and statistics structures (quantity maxcpus).  For
  114  * convenience, the kernel will provide the current value of maxcpus at the
  115  * head of the stream.
  116  */
  117 #define MALLOC_TYPE_STREAM_VERSION      0x00000001
  118 struct malloc_type_stream_header {
  119         uint32_t        mtsh_version;   /* Stream format version. */
  120         uint32_t        mtsh_maxcpus;   /* Value of MAXCPU for stream. */
  121         uint32_t        mtsh_count;     /* Number of records. */
  122         uint32_t        _mtsh_pad;      /* Pad/reserved field. */
  123 };
  124 
  125 #define MALLOC_MAX_NAME 32
  126 struct malloc_type_header {
  127         char                            mth_name[MALLOC_MAX_NAME];
  128 };
  129 
  130 #ifdef _KERNEL
  131 #define MALLOC_DEFINE(type, shortdesc, longdesc)                        \
  132         struct malloc_type type[1] = {                                  \
  133                 { NULL, M_MAGIC, shortdesc, NULL }                      \
  134         };                                                              \
  135         SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_SECOND, malloc_init, \
  136             type);                                                      \
  137         SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY,             \
  138             malloc_uninit, type)
  139 
  140 #define MALLOC_DECLARE(type) \
  141         extern struct malloc_type type[1]
  142 
  143 MALLOC_DECLARE(M_CACHE);
  144 MALLOC_DECLARE(M_DEVBUF);
  145 MALLOC_DECLARE(M_TEMP);
  146 
  147 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
  148 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
  149 
  150 /*
  151  * Deprecated macro versions of not-quite-malloc() and free().
  152  */
  153 #define MALLOC(space, cast, size, type, flags) \
  154         ((space) = (cast)malloc((u_long)(size), (type), (flags)))
  155 #define FREE(addr, type) free((addr), (type))
  156 
  157 /*
  158  * XXX this should be declared in <sys/uio.h>, but that tends to fail
  159  * because <sys/uio.h> is included in a header before the source file
  160  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
  161  */
  162 MALLOC_DECLARE(M_IOV);
  163 
  164 extern struct mtx malloc_mtx;
  165 
  166 /*
  167  * Function type used when iterating over the list of malloc types.
  168  */
  169 typedef void malloc_type_list_func_t(struct malloc_type *, void *);
  170 
  171 void    contigfree(void *addr, unsigned long size, struct malloc_type *type);
  172 void    *contigmalloc(unsigned long size, struct malloc_type *type, int flags,
  173             vm_paddr_t low, vm_paddr_t high, unsigned long alignment,
  174             unsigned long boundary) __malloc_like;
  175 void    free(void *addr, struct malloc_type *type);
  176 void    *malloc(unsigned long size, struct malloc_type *type, int flags) __malloc_like;
  177 void    malloc_init(void *);
  178 int     malloc_last_fail(void);
  179 void    malloc_type_allocated(struct malloc_type *type, unsigned long size);
  180 void    malloc_type_freed(struct malloc_type *type, unsigned long size);
  181 void    malloc_type_list(malloc_type_list_func_t *, void *);
  182 void    malloc_uninit(void *);
  183 void    *realloc(void *addr, unsigned long size, struct malloc_type *type,
  184             int flags);
  185 void    *reallocf(void *addr, unsigned long size, struct malloc_type *type,
  186             int flags);
  187 
  188 struct malloc_type *malloc_desc2type(const char *desc);
  189 #endif /* _KERNEL */
  190 
  191 #endif /* !_SYS_MALLOC_H_ */

Cache object: 4d6681fea74abc7e70244886720387be


[ 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.