include/malloc.h

   1 /* Prototypes and definition for malloc implementation.
   2    Copyright (C) 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _MALLOC_H
  21 #define _MALLOC_H 1
  22
  23 #include <features.h>
  24
  25 /*
  26   `ptmalloc', a malloc implementation for multiple threads without
  27   lock contention, by Wolfram Gloger <wmglo@dent.med.uni-muenchen.de>.
  28   See the files `ptmalloc.c' or `COPYRIGHT' for copying conditions.
  29
  30   VERSION 2.6.4-pt Wed Dec  4 00:35:54 MET 1996
  31
  32   This work is mainly derived from malloc-2.6.4 by Doug Lea
  33   <dl@cs.oswego.edu>, which is available from:
  34
  35                  ftp://g.oswego.edu/pub/misc/malloc.c
  36
  37   This trimmed-down header file only provides function prototypes and
  38   the exported data structures.  For more detailed function
  39   descriptions and compile-time options, see the source file
  40   `ptmalloc.c'.
  41 */
  42
  43 #if defined(__STDC__) || defined (__cplusplus)
  44 # include <stddef.h>
  45 # define __malloc_ptr_t  void *
  46 #else
  47 # undef  size_t
  48 # define size_t          unsigned int
  49 # undef  ptrdiff_t
  50 # define ptrdiff_t       int
  51 # define __malloc_ptr_t  char *
  52 #endif
  53
  54 #ifdef _LIBC
  55 /* Used by GNU libc internals. */
  56 # define __malloc_size_t size_t
  57 # define __malloc_ptrdiff_t ptrdiff_t
  58 #elif !defined __attribute_malloc__
  59 # define __attribute_malloc__
  60 #endif
  61
  62 #ifdef __GNUC__
  63
  64 /* GCC can always grok prototypes.  For C++ programs we add throw()
  65    to help it optimize the function calls.  But this works only with
  66    gcc 2.8.x and egcs.  */
  67 # if defined __cplusplus && (__GNUC__ >= 3 || __GNUC_MINOR__ >= 8)
  68 #  define __THROW       throw ()
  69 # else
  70 #  define __THROW
  71 # endif
  72 # define __MALLOC_P(args)       args __THROW
  73 /* This macro will be used for functions which might take C++ callback
  74    functions.  */
  75 # define __MALLOC_PMT(args)     args
  76
  77 #else   /* Not GCC.  */
  78
  79 # define __THROW
  80
  81 # if (defined __STDC__ && __STDC__) || defined __cplusplus
  82
  83 #  define __MALLOC_P(args)      args
  84 #  define __MALLOC_PMT(args)    args
  85
  86 # else  /* Not ANSI C or C++.  */
  87
  88 #  define __MALLOC_P(args)      ()      /* No prototypes.  */
  89 #  define __MALLOC_PMT(args)    ()
  90
  91 # endif /* ANSI C or C++.  */
  92
  93 #endif  /* GCC.  */
  94
  95 #ifndef NULL
  96 # ifdef __cplusplus
  97 #  define NULL  0
  98 # else
  99 #  define NULL  ((__malloc_ptr_t) 0)
 100 # endif
 101 #endif
 102
 103 #ifdef __cplusplus
 104 extern "C" {
 105 #endif
 106
 107 /* Allocate SIZE bytes of memory.  */
 108 extern __malloc_ptr_t malloc __MALLOC_P ((size_t __size)) __attribute_malloc__;
 109
 110 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
 111 extern __malloc_ptr_t calloc __MALLOC_P ((size_t __nmemb, size_t __size))
 112        __attribute_malloc__;
 113
 114 /* Re-allocate the previously allocated block in __ptr, making the new
 115    block SIZE bytes long.  */
 116 extern __malloc_ptr_t realloc __MALLOC_P ((__malloc_ptr_t __ptr,
 117                                            size_t __size))
 118        __attribute_malloc__;
 119
 120 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
 121 extern void free __MALLOC_P ((__malloc_ptr_t __ptr));
 122
 123 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
 124 extern __malloc_ptr_t memalign __MALLOC_P ((size_t __alignment, size_t __size));
 125
 126 /* Allocate SIZE bytes on a page boundary.  */
 127 extern __malloc_ptr_t valloc __MALLOC_P ((size_t __size)) __attribute_malloc__;
 128
 129 #ifdef __MALLOC_STANDARD__
 130
 131 /* SVID2/XPG mallinfo structure */
 132 struct mallinfo {
 133   int arena;    /* total space allocated from system */
 134   int ordblks;  /* number of non-inuse chunks */
 135   int smblks;   /* unused -- always zero */
 136   int hblks;    /* number of mmapped regions */
 137   int hblkhd;   /* total space in mmapped regions */
 138   int usmblks;  /* unused -- always zero */
 139   int fsmblks;  /* unused -- always zero */
 140   int uordblks; /* total allocated space */
 141   int fordblks; /* total non-inuse space */
 142   int keepcost; /* top-most, releasable (via malloc_trim) space */
 143 };
 144
 145 /* Returns a copy of the updated current mallinfo. */
 146 extern struct mallinfo mallinfo __MALLOC_P ((void));
 147
 148 /* Release all but __pad bytes of freed top-most memory back to the
 149    system. Return 1 if successful, else 0. */
 150 extern int malloc_trim(size_t pad);
 151
 152 #include <stdio.h>
 153 /* Prints brief summary statistics to the specified file.
 154  * Writes to stderr if file is NULL. */
 155 extern void malloc_stats(FILE *file);
 156
 157 /* SVID2/XPG mallopt options */
 158 #ifndef M_MXFAST
 159 # define M_MXFAST  1    /* UNUSED in this malloc */
 160 #endif
 161 #ifndef M_NLBLKS
 162 # define M_NLBLKS  2    /* UNUSED in this malloc */
 163 #endif
 164 #ifndef M_GRAIN
 165 # define M_GRAIN   3    /* UNUSED in this malloc */
 166 #endif
 167 #ifndef M_KEEP
 168 # define M_KEEP    4    /* UNUSED in this malloc */
 169 #endif
 170
 171 /* mallopt options that actually do something */
 172 #define M_TRIM_THRESHOLD    -1
 173 #define M_TOP_PAD           -2
 174 #define M_MMAP_THRESHOLD    -3
 175 #define M_MMAP_MAX          -4
 176 #define M_CHECK_ACTION      -5
 177 #define M_PERTURB           -6
 178
 179 /* General SVID/XPG interface to tunable parameters. */
 180 extern int mallopt __MALLOC_P ((int __param, int __val));
 181
 182 #endif /* __MALLOC_STANDARD__ */
 183
 184
 185 #ifdef __cplusplus
 186 } /* end of extern "C" */
 187 #endif
 188
 189 #endif /* malloc.h */