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$
  35  */
  36
  37 #ifndef _SYS_MALLOC_H_
  38 #define _SYS_MALLOC_H_
  39
  40 #include <vm/uma.h>
  41
  42 #define splmem splhigh
  43
  44 #define MINALLOCSIZE    UMA_SMALLEST_UNIT
  45
  46 /*
  47  * flags to malloc.
  48  */
  49 #define M_WAITOK        0x0000
  50 #define M_NOWAIT        0x0001          /* do not block */
  51 #define M_USE_RESERVE   0x0002          /* can alloc out of reserve memory */
  52 #define M_ZERO          0x0004          /* bzero the allocation */
  53
  54 #define M_MAGIC         877983977       /* time when first defined :-) */
  55
  56 struct malloc_type {
  57         struct malloc_type *ks_next;    /* next in list */
  58         long    ks_memuse;      /* total memory held in bytes */
  59         long    ks_limit;       /* most that are allowed to exist */
  60         long    ks_size;        /* sizes of this thing that are allocated */
  61         long    ks_inuse;       /* # of packets of this type currently in use */
  62         int64_t ks_calls;       /* total packets of this type ever allocated */
  63         long    ks_maxused;     /* maximum number ever used */
  64         u_long  ks_magic;       /* if it's not magic, don't touch it */
  65         const char *ks_shortdesc;       /* short description */
  66         u_short ks_limblocks;   /* number of times blocked for hitting limit */
  67         u_short ks_mapblocks;   /* number of times blocked for kernel map */
  68 };
  69
  70 #ifdef _KERNEL
  71 #define MALLOC_DEFINE(type, shortdesc, longdesc) \
  72         struct malloc_type type[1] = { \
  73                 { NULL, 0, 0, 0, 0, 0, 0, M_MAGIC, shortdesc, 0, 0 } \
  74         }; \
  75         SYSINIT(type##_init, SI_SUB_KMEM, SI_ORDER_SECOND, malloc_init, type); \
  76         SYSUNINIT(type##_uninit, SI_SUB_KMEM, SI_ORDER_ANY, malloc_uninit, type)
  77
  78 #define MALLOC_DECLARE(type) \
  79         extern struct malloc_type type[1]
  80
  81 MALLOC_DECLARE(M_CACHE);
  82 MALLOC_DECLARE(M_DEVBUF);
  83 MALLOC_DECLARE(M_TEMP);
  84
  85 MALLOC_DECLARE(M_IP6OPT); /* for INET6 */
  86 MALLOC_DECLARE(M_IP6NDP); /* for INET6 */
  87
  88 /*
  89  * Deprecated macro versions of not-quite-malloc() and free().
  90  */
  91 #define MALLOC(space, cast, size, type, flags) \
  92         (space) = (cast)malloc((u_long)(size), (type), (flags))
  93 #define FREE(addr, type) free((addr), (type))
  94
  95 /*
  96  * XXX this should be declared in <sys/uio.h>, but that tends to fail
  97  * because <sys/uio.h> is included in a header before the source file
  98  * has a chance to include <sys/malloc.h> to get MALLOC_DECLARE() defined.
  99  */
 100 MALLOC_DECLARE(M_IOV);
 101
 102 /* XXX struct malloc_type is unused for contig*(). */
 103 void    contigfree(void *addr, unsigned long size, struct malloc_type *type);
 104 void    *contigmalloc(unsigned long size, struct malloc_type *type, int flags,
 105             unsigned long low, unsigned long high, unsigned long alignment,
 106             unsigned long boundary);
 107 void    free(void *addr, struct malloc_type *type);
 108 void    *malloc(unsigned long size, struct malloc_type *type, int flags);
 109 void    malloc_init(void *);
 110 void    malloc_uninit(void *);
 111 void    *realloc(void *addr, unsigned long size, struct malloc_type *type,
 112             int flags);
 113 void    *reallocf(void *addr, unsigned long size, struct malloc_type *type,
 114             int flags);
 115 #endif /* _KERNEL */
 116
 117 #endif /* !_SYS_MALLOC_H_ */