malloc/malloc.h

   1 /* Prototypes and definition for malloc implementation.
   2    Copyright (C) 1996,1997,1999,2000,2002-2004,2005,2007,2009,2011,2012
   3    Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef _MALLOC_H
  22 #define _MALLOC_H 1
  23
  24 #include <features.h>
  25 #include <stddef.h>
  26 #include <stdio.h>
  27 # define __malloc_ptr_t  void *
  28
  29 /* Used by GNU libc internals. */
  30 #define __malloc_size_t size_t
  31 #define __malloc_ptrdiff_t ptrdiff_t
  32
  33 #ifdef __GNUC__
  34
  35 # define __MALLOC_P(args)       args __THROW
  36 /* This macro will be used for functions which might take C++ callback
  37    functions.  */
  38 # define __MALLOC_PMT(args)     args
  39
  40 # ifdef _LIBC
  41 #  define __MALLOC_HOOK_VOLATILE
  42 #  define __MALLOC_DEPRECATED
  43 # else
  44 #  define __MALLOC_HOOK_VOLATILE volatile
  45 #  define __MALLOC_DEPRECATED __attribute_deprecated__
  46 # endif
  47
  48 #else   /* Not GCC.  */
  49
  50 # define __MALLOC_P(args)       args
  51 # define __MALLOC_PMT(args)     args
  52 # define __MALLOC_HOOK_VOLATILE
  53 # define __MALLOC_DEPRECATED __attribute_deprecated__
  54
  55 #endif  /* GCC.  */
  56
  57
  58 __BEGIN_DECLS
  59
  60 /* Allocate SIZE bytes of memory.  */
  61 extern void *malloc (size_t __size) __THROW __attribute_malloc__ __wur;
  62
  63 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
  64 extern void *calloc (size_t __nmemb, size_t __size)
  65      __THROW __attribute_malloc__ __wur;
  66
  67 /* Re-allocate the previously allocated block in __ptr, making the new
  68    block SIZE bytes long.  */
  69 /* __attribute_malloc__ is not used, because if realloc returns
  70    the same pointer that was passed to it, aliasing needs to be allowed
  71    between objects pointed by the old and new pointers.  */
  72 extern void *realloc (void *__ptr, size_t __size)
  73      __THROW __attribute_warn_unused_result__;
  74
  75 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
  76 extern void free (void *__ptr) __THROW;
  77
  78 /* Free a block allocated by `calloc'. */
  79 extern void cfree (void *__ptr) __THROW;
  80
  81 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
  82 extern void *memalign (size_t __alignment, size_t __size)
  83      __THROW __attribute_malloc__ __wur;
  84
  85 /* Allocate SIZE bytes on a page boundary.  */
  86 extern void *valloc (size_t __size) __THROW __attribute_malloc__ __wur;
  87
  88 /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up
  89    __size to nearest pagesize. */
  90 extern void * pvalloc (size_t __size) __THROW __attribute_malloc__ __wur;
  91
  92 /* Underlying allocation function; successive calls should return
  93    contiguous pieces of memory.  */
  94 extern void *(*__morecore) (ptrdiff_t __size);
  95
  96 /* Default value of `__morecore'.  */
  97 extern void *__default_morecore (ptrdiff_t __size)
  98      __THROW __attribute_malloc__;
  99
 100 /* SVID2/XPG mallinfo structure */
 101
 102 struct mallinfo
 103 {
 104   int arena;    /* non-mmapped space allocated from system */
 105   int ordblks;  /* number of free chunks */
 106   int smblks;   /* number of fastbin blocks */
 107   int hblks;    /* number of mmapped regions */
 108   int hblkhd;   /* space in mmapped regions */
 109   int usmblks;  /* maximum total allocated space */
 110   int fsmblks;  /* space available in freed fastbin blocks */
 111   int uordblks; /* total allocated space */
 112   int fordblks; /* total free space */
 113   int keepcost; /* top-most, releasable (via malloc_trim) space */
 114 };
 115
 116 /* Returns a copy of the updated current mallinfo. */
 117 extern struct mallinfo mallinfo (void) __THROW;
 118
 119 /* SVID2/XPG mallopt options */
 120 #ifndef M_MXFAST
 121 # define M_MXFAST  1    /* maximum request size for "fastbins" */
 122 #endif
 123 #ifndef M_NLBLKS
 124 # define M_NLBLKS  2    /* UNUSED in this malloc */
 125 #endif
 126 #ifndef M_GRAIN
 127 # define M_GRAIN   3    /* UNUSED in this malloc */
 128 #endif
 129 #ifndef M_KEEP
 130 # define M_KEEP    4    /* UNUSED in this malloc */
 131 #endif
 132
 133 /* mallopt options that actually do something */
 134 #define M_TRIM_THRESHOLD    -1
 135 #define M_TOP_PAD           -2
 136 #define M_MMAP_THRESHOLD    -3
 137 #define M_MMAP_MAX          -4
 138 #define M_CHECK_ACTION      -5
 139 #define M_PERTURB           -6
 140 #define M_ARENA_TEST        -7
 141 #define M_ARENA_MAX         -8
 142
 143 /* General SVID/XPG interface to tunable parameters. */
 144 extern int mallopt (int __param, int __val) __THROW;
 145
 146 /* Release all but __pad bytes of freed top-most memory back to the
 147    system. Return 1 if successful, else 0. */
 148 extern int malloc_trim (size_t __pad) __THROW;
 149
 150 /* Report the number of usable allocated bytes associated with allocated
 151    chunk __ptr. */
 152 extern size_t malloc_usable_size (void *__ptr) __THROW;
 153
 154 /* Prints brief summary statistics on stderr. */
 155 extern void malloc_stats (void) __THROW;
 156
 157 /* Output information about state of allocator to stream FP.  */
 158 extern int malloc_info (int __options, FILE *__fp) __THROW;
 159
 160 /* Record the state of all malloc variables in an opaque data structure. */
 161 extern void *malloc_get_state (void) __THROW;
 162
 163 /* Restore the state of all malloc variables from data obtained with
 164    malloc_get_state(). */
 165 extern int malloc_set_state (void *__ptr) __THROW;
 166
 167 /* Called once when malloc is initialized; redefining this variable in
 168    the application provides the preferred way to set up the hook
 169    pointers. */
 170 extern void (*__MALLOC_HOOK_VOLATILE __malloc_initialize_hook) (void)
 171      __MALLOC_DEPRECATED;
 172 /* Hooks for debugging and user-defined versions. */
 173 extern void (*__MALLOC_HOOK_VOLATILE __free_hook) (void *__ptr,
 174                                                    const __malloc_ptr_t)
 175      __MALLOC_DEPRECATED;
 176 extern void *(*__MALLOC_HOOK_VOLATILE __malloc_hook) (size_t __size,
 177                                                       const __malloc_ptr_t)
 178      __MALLOC_DEPRECATED;
 179 extern void *(*__MALLOC_HOOK_VOLATILE __realloc_hook) (void *__ptr,
 180                                                        size_t __size,
 181                                                        const __malloc_ptr_t)
 182      __MALLOC_DEPRECATED;
 183 extern void *(*__MALLOC_HOOK_VOLATILE __memalign_hook) (size_t __alignment,
 184                                                         size_t __size,
 185                                                         const __malloc_ptr_t)
 186      __MALLOC_DEPRECATED;
 187 extern void (*__MALLOC_HOOK_VOLATILE __after_morecore_hook) (void);
 188
 189 /* Activate a standard set of debugging hooks. */
 190 extern void __malloc_check_init (void) __THROW __MALLOC_DEPRECATED;
 191
 192
 193 __END_DECLS
 194
 195 #endif /* malloc.h */