ddbc69449138399856a7a5a28a3deb268e71f357
[kopensolaris-gnu/glibc.git] / malloc / malloc.h
1 /* Prototypes and definition for malloc implementation.
2    Copyright (C) 1996 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 #if defined (__STDC__) || defined (__cplusplus) || defined (__GNUC__)
59 #define __MALLOC_P(args)        args
60 #else
61 #define __MALLOC_P(args)        ()
62 #endif
63
64 #ifndef NULL
65 #ifdef __cplusplus
66 #define NULL    0
67 #else
68 #define NULL    ((__malloc_ptr_t) 0)
69 #endif
70 #endif
71
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 /* Nonzero if the malloc is already initialized.  */
77 extern int __malloc_initialized;
78
79 /* Initialize global configuration.  Not needed with GNU libc. */
80 #ifndef __GLIBC__
81 extern void ptmalloc_init __MALLOC_P ((void));
82 #endif
83
84 /* Allocate SIZE bytes of memory.  */
85 extern __malloc_ptr_t malloc __MALLOC_P ((size_t __size));
86
87 /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
88 extern __malloc_ptr_t calloc __MALLOC_P ((size_t __nmemb, size_t __size));
89
90 /* Re-allocate the previously allocated block in __ptr, making the new
91    block SIZE bytes long.  */
92 extern __malloc_ptr_t realloc __MALLOC_P ((__malloc_ptr_t __ptr, size_t __size));
93
94 /* Free a block allocated by `malloc', `realloc' or `calloc'.  */
95 extern void free __MALLOC_P ((__malloc_ptr_t __ptr));
96
97 /* Free a block allocated by `calloc'. */
98 extern void cfree __MALLOC_P ((__malloc_ptr_t __ptr));
99
100 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
101 extern __malloc_ptr_t memalign __MALLOC_P ((size_t __alignment, size_t __size));
102
103 /* Allocate SIZE bytes on a page boundary.  */
104 extern __malloc_ptr_t valloc __MALLOC_P ((size_t __size));
105
106 /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up
107    __size to nearest pagesize. */
108 extern __malloc_ptr_t  pvalloc __MALLOC_P ((size_t __size));
109
110 /* Underlying allocation function; successive calls should return
111    contiguous pieces of memory.  */
112 extern __malloc_ptr_t (*__morecore) __MALLOC_P ((ptrdiff_t __size));
113
114 /* Default value of `__morecore'.  */
115 extern __malloc_ptr_t __default_morecore __MALLOC_P ((ptrdiff_t __size));
116
117 /* SVID2/XPG mallinfo structure */
118 struct mallinfo {
119   int arena;    /* total space allocated from system */
120   int ordblks;  /* number of non-inuse chunks */
121   int smblks;   /* unused -- always zero */
122   int hblks;    /* number of mmapped regions */
123   int hblkhd;   /* total space in mmapped regions */
124   int usmblks;  /* unused -- always zero */
125   int fsmblks;  /* unused -- always zero */
126   int uordblks; /* total allocated space */
127   int fordblks; /* total non-inuse space */
128   int keepcost; /* top-most, releasable (via malloc_trim) space */
129 };
130
131 /* Returns a copy of the updated current mallinfo. */
132 extern struct mallinfo mallinfo __MALLOC_P ((void));
133
134 /* SVID2/XPG mallopt options */
135 #ifndef M_MXFAST
136 #define M_MXFAST  1    /* UNUSED in this malloc */
137 #endif
138 #ifndef M_NLBLKS
139 #define M_NLBLKS  2    /* UNUSED in this malloc */
140 #endif
141 #ifndef M_GRAIN
142 #define M_GRAIN   3    /* UNUSED in this malloc */
143 #endif
144 #ifndef M_KEEP
145 #define M_KEEP    4    /* UNUSED in this malloc */
146 #endif
147
148 /* mallopt options that actually do something */
149 #define M_TRIM_THRESHOLD    -1
150 #define M_TOP_PAD           -2
151 #define M_MMAP_THRESHOLD    -3
152 #define M_MMAP_MAX          -4
153 #define M_CHECK_ACTION      -5
154
155 /* General SVID/XPG interface to tunable parameters. */
156 extern int mallopt __MALLOC_P ((int __param, int __val));
157
158 /* Release all but __pad bytes of freed top-most memory back to the
159    system. Return 1 if successful, else 0. */
160 extern int malloc_trim __MALLOC_P ((size_t __pad));
161
162 /* Report the number of usable allocated bytes associated with allocated
163    chunk __ptr. */
164 extern size_t malloc_usable_size __MALLOC_P ((__malloc_ptr_t __ptr));
165
166 /* Prints brief summary statistics on stderr. */
167 extern void malloc_stats __MALLOC_P ((void));
168
169 #if defined(__GLIBC__) || defined(MALLOC_HOOKS)
170
171 /* Hooks for debugging versions. */
172 extern void (*__malloc_initialize_hook) __MALLOC_P ((void));
173 extern void (*__free_hook) __MALLOC_P ((__malloc_ptr_t __ptr));
174 extern __malloc_ptr_t (*__malloc_hook) __MALLOC_P ((size_t __size));
175 extern __malloc_ptr_t (*__realloc_hook) __MALLOC_P ((__malloc_ptr_t __ptr,
176                                                      size_t __size));
177 extern __malloc_ptr_t (*__memalign_hook) __MALLOC_P ((size_t __size,
178                                                       size_t __alignment));
179
180 /* Activate a standard set of debugging hooks. */
181 extern void malloc_check_init __MALLOC_P ((void));
182
183 #endif
184
185 #ifdef __cplusplus
186 }; /* end of extern "C" */
187 #endif
188
189 #endif /* !defined(_MALLOC_H) */