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 #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 #endif
  59
  60 #ifdef __GNUC__
  61
  62 /* GCC can always grok prototypes.  For C++ programs we add throw()
  63    to help it optimize the function calls.  But this works only with
  64    gcc 2.8.x and egcs.  */
  65 # if defined __cplusplus && (__GNUC__ >= 3 || __GNUC_MINOR__ >= 8)
  66 #  define __THROW       throw ()
  67 # else
  68 #  define __THROW
  69 # endif
  70 # define __MALLOC_P(args)       args __THROW
  71 /* This macro will be used for functions which might take C++ callback
  72    functions.  */
  73 # define __MALLOC_PMT(args)     args
  74
  75 #else   /* Not GCC.  */
  76
  77 # if (defined __STDC__ && __STDC__) || defined __cplusplus
  78
  79 #  define __MALLOC_P(args)      args
  80 #  define __MALLOC_PMT(args)    args
  81
  82 # else  /* Not ANSI C or C++.  */
  83
  84 #  define __MALLOC_P(args)      ()      /* No prototypes.  */
  85 #  define __MALLOC_PMT(args)    ()
  86
  87 # endif /* ANSI C or C++.  */
  88
  89 #endif  /* GCC.  */
  90
  91 #ifndef NULL
  92 # ifdef __cplusplus
  93 #  define NULL  0
  94 # else
  95 #  define NULL  ((__malloc_ptr_t) 0)
  96 # endif
  97 #endif
  98
  99 #ifdef __cplusplus
 100 extern "C" {
 101 #endif
 102
 103 /* Nonzero if the malloc is already initialized.  */
 104 #ifdef _LIBC
 105 /* In the GNU libc we rename the global variable
 106    `__malloc_initialized' to `__libc_malloc_initialized'.  */
 107 # define __malloc_initialized __libc_malloc_initialized
 108 #endif
 109 extern int __malloc_initialized;
 110
 111 /* Initialize global configuration.  Not needed with GNU libc. */
 112 #ifndef __GLIBC__
 113 extern void ptmalloc_init __MALLOC_P ((void));
 114 #endif
 115
 116 /* Allocate SIZE bytes of memory.  */
 117 extern __malloc_ptr_t malloc __MALLOC_P ((size_t __size));
 118
 119 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
 120 extern __malloc_ptr_t calloc __MALLOC_P ((size_t __nmemb, size_t __size));
 121
 122 /* Re-allocate the previously allocated block in __ptr, making the new
 123    block SIZE bytes long.  */
 124 extern __malloc_ptr_t realloc __MALLOC_P ((__malloc_ptr_t __ptr, size_t __size));
 125
 126 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
 127 extern void free __MALLOC_P ((__malloc_ptr_t __ptr));
 128
 129 /* Free a block allocated by `calloc'. */
 130 extern void cfree __MALLOC_P ((__malloc_ptr_t __ptr));
 131
 132 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
 133 extern __malloc_ptr_t memalign __MALLOC_P ((size_t __alignment, size_t __size));
 134
 135 /* Allocate SIZE bytes on a page boundary.  */
 136 extern __malloc_ptr_t valloc __MALLOC_P ((size_t __size));
 137
 138 /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up
 139    __size to nearest pagesize. */
 140 extern __malloc_ptr_t  pvalloc __MALLOC_P ((size_t __size));
 141
 142 /* Underlying allocation function; successive calls should return
 143    contiguous pieces of memory.  */
 144 extern __malloc_ptr_t (*__morecore) __MALLOC_PMT ((ptrdiff_t __size));
 145
 146 /* Default value of `__morecore'.  */
 147 extern __malloc_ptr_t __default_morecore __MALLOC_P ((ptrdiff_t __size));
 148
 149 /* SVID2/XPG mallinfo structure */
 150 struct mallinfo {
 151   int arena;    /* total space allocated from system */
 152   int ordblks;  /* number of non-inuse chunks */
 153   int smblks;   /* unused -- always zero */
 154   int hblks;    /* number of mmapped regions */
 155   int hblkhd;   /* total space in mmapped regions */
 156   int usmblks;  /* unused -- always zero */
 157   int fsmblks;  /* unused -- always zero */
 158   int uordblks; /* total allocated space */
 159   int fordblks; /* total non-inuse space */
 160   int keepcost; /* top-most, releasable (via malloc_trim) space */
 161 };
 162
 163 /* Returns a copy of the updated current mallinfo. */
 164 extern struct mallinfo mallinfo __MALLOC_P ((void));
 165
 166 /* SVID2/XPG mallopt options */
 167 #ifndef M_MXFAST
 168 # define M_MXFAST  1    /* UNUSED in this malloc */
 169 #endif
 170 #ifndef M_NLBLKS
 171 # define M_NLBLKS  2    /* UNUSED in this malloc */
 172 #endif
 173 #ifndef M_GRAIN
 174 # define M_GRAIN   3    /* UNUSED in this malloc */
 175 #endif
 176 #ifndef M_KEEP
 177 # define M_KEEP    4    /* UNUSED in this malloc */
 178 #endif
 179
 180 /* mallopt options that actually do something */
 181 #define M_TRIM_THRESHOLD    -1
 182 #define M_TOP_PAD           -2
 183 #define M_MMAP_THRESHOLD    -3
 184 #define M_MMAP_MAX          -4
 185 #define M_CHECK_ACTION      -5
 186
 187 /* General SVID/XPG interface to tunable parameters. */
 188 extern int mallopt __MALLOC_P ((int __param, int __val));
 189
 190 /* Release all but __pad bytes of freed top-most memory back to the
 191    system. Return 1 if successful, else 0. */
 192 extern int malloc_trim __MALLOC_P ((size_t __pad));
 193
 194 /* Report the number of usable allocated bytes associated with allocated
 195    chunk __ptr. */
 196 extern size_t malloc_usable_size __MALLOC_P ((__malloc_ptr_t __ptr));
 197
 198 /* Prints brief summary statistics on stderr. */
 199 extern void malloc_stats __MALLOC_P ((void));
 200
 201 /* Record the state of all malloc variables in an opaque data structure. */
 202 extern __malloc_ptr_t malloc_get_state __MALLOC_P ((void));
 203
 204 /* Restore the state of all malloc variables from data obtained with
 205    malloc_get_state(). */
 206 extern int malloc_set_state __MALLOC_P ((__malloc_ptr_t __ptr));
 207
 208 #if defined __GLIBC__ || defined MALLOC_HOOKS
 209 /* Hooks for debugging versions. */
 210 extern void (*__malloc_initialize_hook) __MALLOC_PMT ((void));
 211 extern void (*__free_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr,
 212                                         __const __malloc_ptr_t));
 213 extern __malloc_ptr_t (*__malloc_hook) __MALLOC_PMT ((size_t __size,
 214                                                     __const __malloc_ptr_t));
 215 extern __malloc_ptr_t (*__realloc_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr,
 216                                                      size_t __size,
 217                                                      __const __malloc_ptr_t));
 218 extern __malloc_ptr_t (*__memalign_hook) __MALLOC_PMT ((size_t __size,
 219                                                       size_t __alignment,
 220                                                       __const __malloc_ptr_t));
 221 extern void (*__after_morecore_hook) __MALLOC_PMT ((void));
 222
 223 /* Activate a standard set of debugging hooks. */
 224 extern void __malloc_check_init __MALLOC_P ((void));
 225 #endif
 226
 227 #ifdef __cplusplus
 228 }; /* end of extern "C" */
 229 #endif
 230
 231 #endif /* malloc.h */