malloc/malloc.h

   1 /* Prototypes and definition for malloc implementation.
   2    Copyright (C) 1996-2013 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, see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _MALLOC_H
  20 #define _MALLOC_H 1
  21
  22 #include <features.h>
  23 #include <stddef.h>
  24 #include <stdio.h>
  25 # define __malloc_ptr_t  void *
  26
  27 /* Used by GNU libc internals. */
  28 #define __malloc_size_t size_t
  29 #define __malloc_ptrdiff_t ptrdiff_t
  30
  31 #ifdef _LIBC
  32 # define __MALLOC_HOOK_VOLATILE
  33 # define __MALLOC_DEPRECATED
  34 #else
  35 # define __MALLOC_HOOK_VOLATILE volatile
  36 # define __MALLOC_DEPRECATED __attribute_deprecated__
  37 #endif
  38
  39
  40 __BEGIN_DECLS
  41
  42 /* Allocate SIZE bytes of memory.  */
  43 extern void *malloc (size_t __size) __THROW __attribute_malloc__ __wur;
  44
  45 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
  46 extern void *calloc (size_t __nmemb, size_t __size)
  47      __THROW __attribute_malloc__ __wur;
  48
  49 /* Re-allocate the previously allocated block in __ptr, making the new
  50    block SIZE bytes long.  */
  51 /* __attribute_malloc__ is not used, because if realloc returns
  52    the same pointer that was passed to it, aliasing needs to be allowed
  53    between objects pointed by the old and new pointers.  */
  54 extern void *realloc (void *__ptr, size_t __size)
  55      __THROW __attribute_warn_unused_result__;
  56
  57 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
  58 extern void free (void *__ptr) __THROW;
  59
  60 /* Free a block allocated by `calloc'. */
  61 extern void cfree (void *__ptr) __THROW;
  62
  63 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
  64 extern void *memalign (size_t __alignment, size_t __size)
  65      __THROW __attribute_malloc__ __wur;
  66
  67 /* Allocate SIZE bytes on a page boundary.  */
  68 extern void *valloc (size_t __size) __THROW __attribute_malloc__ __wur;
  69
  70 /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up
  71    __size to nearest pagesize. */
  72 extern void * pvalloc (size_t __size) __THROW __attribute_malloc__ __wur;
  73
  74 /* Underlying allocation function; successive calls should return
  75    contiguous pieces of memory.  */
  76 extern void *(*__morecore) (ptrdiff_t __size);
  77
  78 /* Default value of `__morecore'.  */
  79 extern void *__default_morecore (ptrdiff_t __size)
  80      __THROW __attribute_malloc__;
  81
  82 /* SVID2/XPG mallinfo structure */
  83
  84 struct mallinfo
  85 {
  86   int arena;    /* non-mmapped space allocated from system */
  87   int ordblks;  /* number of free chunks */
  88   int smblks;   /* number of fastbin blocks */
  89   int hblks;    /* number of mmapped regions */
  90   int hblkhd;   /* space in mmapped regions */
  91   int usmblks;  /* maximum total allocated space */
  92   int fsmblks;  /* space available in freed fastbin blocks */
  93   int uordblks; /* total allocated space */
  94   int fordblks; /* total free space */
  95   int keepcost; /* top-most, releasable (via malloc_trim) space */
  96 };
  97
  98 /* Returns a copy of the updated current mallinfo. */
  99 extern struct mallinfo mallinfo (void) __THROW;
 100
 101 /* SVID2/XPG mallopt options */
 102 #ifndef M_MXFAST
 103 # define M_MXFAST  1    /* maximum request size for "fastbins" */
 104 #endif
 105 #ifndef M_NLBLKS
 106 # define M_NLBLKS  2    /* UNUSED in this malloc */
 107 #endif
 108 #ifndef M_GRAIN
 109 # define M_GRAIN   3    /* UNUSED in this malloc */
 110 #endif
 111 #ifndef M_KEEP
 112 # define M_KEEP    4    /* UNUSED in this malloc */
 113 #endif
 114
 115 /* mallopt options that actually do something */
 116 #define M_TRIM_THRESHOLD    -1
 117 #define M_TOP_PAD           -2
 118 #define M_MMAP_THRESHOLD    -3
 119 #define M_MMAP_MAX          -4
 120 #define M_CHECK_ACTION      -5
 121 #define M_PERTURB           -6
 122 #define M_ARENA_TEST        -7
 123 #define M_ARENA_MAX         -8
 124
 125 /* General SVID/XPG interface to tunable parameters. */
 126 extern int mallopt (int __param, int __val) __THROW;
 127
 128 /* Release all but __pad bytes of freed top-most memory back to the
 129    system. Return 1 if successful, else 0. */
 130 extern int malloc_trim (size_t __pad) __THROW;
 131
 132 /* Report the number of usable allocated bytes associated with allocated
 133    chunk __ptr. */
 134 extern size_t malloc_usable_size (void *__ptr) __THROW;
 135
 136 /* Prints brief summary statistics on stderr. */
 137 extern void malloc_stats (void) __THROW;
 138
 139 /* Output information about state of allocator to stream FP.  */
 140 extern int malloc_info (int __options, FILE *__fp) __THROW;
 141
 142 /* Record the state of all malloc variables in an opaque data structure. */
 143 extern void *malloc_get_state (void) __THROW;
 144
 145 /* Restore the state of all malloc variables from data obtained with
 146    malloc_get_state(). */
 147 extern int malloc_set_state (void *__ptr) __THROW;
 148
 149 /* Called once when malloc is initialized; redefining this variable in
 150    the application provides the preferred way to set up the hook
 151    pointers. */
 152 extern void (*__MALLOC_HOOK_VOLATILE __malloc_initialize_hook) (void)
 153      __MALLOC_DEPRECATED;
 154 /* Hooks for debugging and user-defined versions. */
 155 extern void (*__MALLOC_HOOK_VOLATILE __free_hook) (void *__ptr,
 156                                                    const __malloc_ptr_t)
 157      __MALLOC_DEPRECATED;
 158 extern void *(*__MALLOC_HOOK_VOLATILE __malloc_hook) (size_t __size,
 159                                                       const __malloc_ptr_t)
 160      __MALLOC_DEPRECATED;
 161 extern void *(*__MALLOC_HOOK_VOLATILE __realloc_hook) (void *__ptr,
 162                                                        size_t __size,
 163                                                        const __malloc_ptr_t)
 164      __MALLOC_DEPRECATED;
 165 extern void *(*__MALLOC_HOOK_VOLATILE __memalign_hook) (size_t __alignment,
 166                                                         size_t __size,
 167                                                         const __malloc_ptr_t)
 168      __MALLOC_DEPRECATED;
 169 extern void (*__MALLOC_HOOK_VOLATILE __after_morecore_hook) (void);
 170
 171 /* Activate a standard set of debugging hooks. */
 172 extern void __malloc_check_init (void) __THROW __MALLOC_DEPRECATED;
 173
 174
 175 __END_DECLS
 176
 177 #endif /* malloc.h */