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