malloc/malloc.h

   1 /* Prototypes and definition for malloc implementation.
   2    Copyright (C) 1996, 1997, 1999 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 Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    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    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _MALLOC_H
  21 #define _MALLOC_H 1
  22
  23 /*
  24   `ptmalloc', a malloc implementation for multiple threads without
  25   lock contention, by Wolfram Gloger <wmglo@dent.med.uni-muenchen.de>.
  26   See the files `ptmalloc.c' or `COPYRIGHT' for copying conditions.
  27
  28   VERSION 2.6.4-pt Wed Dec  4 00:35:54 MET 1996
  29
  30   This work is mainly derived from malloc-2.6.4 by Doug Lea
  31   <dl@cs.oswego.edu>, which is available from:
  32
  33                  ftp://g.oswego.edu/pub/misc/malloc.c
  34
  35   This trimmed-down header file only provides function prototypes and
  36   the exported data structures.  For more detailed function
  37   descriptions and compile-time options, see the source file
  38   `ptmalloc.c'.
  39 */
  40
  41 #if defined(__STDC__) || defined (__cplusplus)
  42 # include <stddef.h>
  43 # define __malloc_ptr_t  void *
  44 #else
  45 # undef  size_t
  46 # define size_t          unsigned int
  47 # undef  ptrdiff_t
  48 # define ptrdiff_t       int
  49 # define __malloc_ptr_t  char *
  50 #endif
  51
  52 #ifdef _LIBC
  53 /* Used by GNU libc internals. */
  54 # define __malloc_size_t size_t
  55 # define __malloc_ptrdiff_t ptrdiff_t
  56 #endif
  57
  58 #ifdef __GNUC__
  59
  60 /* GCC can always grok prototypes.  For C++ programs we add throw()
  61    to help it optimize the function calls.  But this works only with
  62    gcc 2.8.x and egcs.  */
  63 # if defined __cplusplus && (__GNUC__ >= 3 || __GNUC_MINOR__ >= 8)
  64 #  define __THROW       throw ()
  65 # else
  66 #  define __THROW
  67 # endif
  68 # define __MALLOC_P(args)       args __THROW
  69 /* This macro will be used for functions which might take C++ callback
  70    functions.  */
  71 # define __MALLOC_PMT(args)     args
  72
  73 #else   /* Not GCC.  */
  74
  75 # if (defined __STDC__ && __STDC__) || defined __cplusplus
  76
  77 #  define __MALLOC_P(args)      args
  78 #  define __MALLOC_PMT(args)    args
  79
  80 # else  /* Not ANSI C or C++.  */
  81
  82 #  define __MALLOC_P(args)      ()      /* No prototypes.  */
  83 #  define __MALLOC_PMT(args)    ()
  84
  85 # endif /* ANSI C or C++.  */
  86
  87 #endif  /* GCC.  */
  88
  89 #ifndef NULL
  90 # ifdef __cplusplus
  91 #  define NULL  0
  92 # else
  93 #  define NULL  ((__malloc_ptr_t) 0)
  94 # endif
  95 #endif
  96
  97 #ifdef __cplusplus
  98 extern "C" {
  99 #endif
 100
 101 /* Nonzero if the malloc is already initialized.  */
 102 #ifdef _LIBC
 103 /* In the GNU libc we rename the global variable
 104    `__malloc_initialized' to `__libc_malloc_initialized'.  */
 105 # define __malloc_initialized __libc_malloc_initialized
 106 #endif
 107 extern int __malloc_initialized;
 108
 109 /* Initialize global configuration.  Not needed with GNU libc. */
 110 #ifndef __GLIBC__
 111 extern void ptmalloc_init __MALLOC_P ((void));
 112 #endif
 113
 114 /* Allocate SIZE bytes of memory.  */
 115 extern __malloc_ptr_t malloc __MALLOC_P ((size_t __size));
 116
 117 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
 118 extern __malloc_ptr_t calloc __MALLOC_P ((size_t __nmemb, size_t __size));
 119
 120 /* Re-allocate the previously allocated block in __ptr, making the new
 121    block SIZE bytes long.  */
 122 extern __malloc_ptr_t realloc __MALLOC_P ((__malloc_ptr_t __ptr, size_t __size));
 123
 124 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
 125 extern void free __MALLOC_P ((__malloc_ptr_t __ptr));
 126
 127 /* Free a block allocated by `calloc'. */
 128 extern void cfree __MALLOC_P ((__malloc_ptr_t __ptr));
 129
 130 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
 131 extern __malloc_ptr_t memalign __MALLOC_P ((size_t __alignment, size_t __size));
 132
 133 /* Allocate SIZE bytes on a page boundary.  */
 134 extern __malloc_ptr_t valloc __MALLOC_P ((size_t __size));
 135
 136 /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up
 137    __size to nearest pagesize. */
 138 extern __malloc_ptr_t  pvalloc __MALLOC_P ((size_t __size));
 139
 140 /* Underlying allocation function; successive calls should return
 141    contiguous pieces of memory.  */
 142 extern __malloc_ptr_t (*__morecore) __MALLOC_PMT ((ptrdiff_t __size));
 143
 144 /* Default value of `__morecore'.  */
 145 extern __malloc_ptr_t __default_morecore __MALLOC_P ((ptrdiff_t __size));
 146
 147 /* SVID2/XPG mallinfo structure */
 148 struct mallinfo {
 149   int arena;    /* total space allocated from system */
 150   int ordblks;  /* number of non-inuse chunks */
 151   int smblks;   /* unused -- always zero */
 152   int hblks;    /* number of mmapped regions */
 153   int hblkhd;   /* total space in mmapped regions */
 154   int usmblks;  /* unused -- always zero */
 155   int fsmblks;  /* unused -- always zero */
 156   int uordblks; /* total allocated space */
 157   int fordblks; /* total non-inuse space */
 158   int keepcost; /* top-most, releasable (via malloc_trim) space */
 159 };
 160
 161 /* Returns a copy of the updated current mallinfo. */
 162 extern struct mallinfo mallinfo __MALLOC_P ((void));
 163
 164 /* SVID2/XPG mallopt options */
 165 #ifndef M_MXFAST
 166 # define M_MXFAST  1    /* UNUSED in this malloc */
 167 #endif
 168 #ifndef M_NLBLKS
 169 # define M_NLBLKS  2    /* UNUSED in this malloc */
 170 #endif
 171 #ifndef M_GRAIN
 172 # define M_GRAIN   3    /* UNUSED in this malloc */
 173 #endif
 174 #ifndef M_KEEP
 175 # define M_KEEP    4    /* UNUSED in this malloc */
 176 #endif
 177
 178 /* mallopt options that actually do something */
 179 #define M_TRIM_THRESHOLD    -1
 180 #define M_TOP_PAD           -2
 181 #define M_MMAP_THRESHOLD    -3
 182 #define M_MMAP_MAX          -4
 183 #define M_CHECK_ACTION      -5
 184
 185 /* General SVID/XPG interface to tunable parameters. */
 186 extern int mallopt __MALLOC_P ((int __param, int __val));
 187
 188 /* Release all but __pad bytes of freed top-most memory back to the
 189    system. Return 1 if successful, else 0. */
 190 extern int malloc_trim __MALLOC_P ((size_t __pad));
 191
 192 /* Report the number of usable allocated bytes associated with allocated
 193    chunk __ptr. */
 194 extern size_t malloc_usable_size __MALLOC_P ((__malloc_ptr_t __ptr));
 195
 196 /* Prints brief summary statistics on stderr. */
 197 extern void malloc_stats __MALLOC_P ((void));
 198
 199 /* Record the state of all malloc variables in an opaque data structure. */
 200 extern __malloc_ptr_t malloc_get_state __MALLOC_P ((void));
 201
 202 /* Restore the state of all malloc variables from data obtained with
 203    malloc_get_state(). */
 204 extern int malloc_set_state __MALLOC_P ((__malloc_ptr_t __ptr));
 205
 206 #if defined __GLIBC__ || defined MALLOC_HOOKS
 207 /* Hooks for debugging versions. */
 208 extern void (*__malloc_initialize_hook) __MALLOC_PMT ((void));
 209 extern void (*__free_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr,
 210                                         __const __malloc_ptr_t));
 211 extern __malloc_ptr_t (*__malloc_hook) __MALLOC_PMT ((size_t __size,
 212                                                     __const __malloc_ptr_t));
 213 extern __malloc_ptr_t (*__realloc_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr,
 214                                                      size_t __size,
 215                                                      __const __malloc_ptr_t));
 216 extern __malloc_ptr_t (*__memalign_hook) __MALLOC_PMT ((size_t __size,
 217                                                       size_t __alignment,
 218                                                       __const __malloc_ptr_t));
 219 extern void (*__after_morecore_hook) __MALLOC_PMT ((void));
 220
 221 /* Activate a standard set of debugging hooks. */
 222 extern void __malloc_check_init __MALLOC_P ((void));
 223 #endif
 224
 225 #ifdef __cplusplus
 226 }; /* end of extern "C" */
 227 #endif
 228
 229 #endif /* malloc.h */