/* Prototypes and definition for malloc implementation. Copyright (C) 1996,97,99,2000,2002,2003,2004 Free Software Foundation, Inc. This file is part of the GNU C Library. The GNU C Library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. The GNU C Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with the GNU C Library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. */ #ifndef _MALLOC_H #define _MALLOC_H 1 /* add the opal config header file for the OPAL_DECLSPEC */ #include "opal_config.h" #ifdef _LIBC #include #endif /* $Id: malloc.h,v 1.7 2004/08/08 12:34:57 wg Exp $ `ptmalloc2', a malloc implementation for multiple threads without lock contention, by Wolfram Gloger . VERSION 2.7.0 This work is mainly derived from malloc-2.7.0 by Doug Lea , which is available from: ftp://gee.cs.oswego.edu/pub/misc/malloc.c This trimmed-down header file only provides function prototypes and the exported data structures. For more detailed function descriptions and compile-time options, see the source file `malloc.c'. */ #if defined(__STDC__) || defined (__cplusplus) # include # define __malloc_ptr_t void * #else # undef size_t # define size_t unsigned int # undef ptrdiff_t # define ptrdiff_t int # define __malloc_ptr_t char * #endif #ifdef _LIBC /* Used by GNU libc internals. */ # define __malloc_size_t size_t # define __malloc_ptrdiff_t ptrdiff_t #elif !defined __attribute_malloc__ # define __attribute_malloc__ #endif #ifdef __GNUC__ /* GCC can always grok prototypes. For C++ programs we add throw() to help it optimize the function calls. But this works only with gcc 2.8.x and egcs. */ # if defined __cplusplus && (__GNUC__ >= 3 || __GNUC_MINOR__ >= 8) # define __THROW throw () # else #ifdef __THROW # undef __THROW #endif # define __THROW # endif # define __MALLOC_P(args) args __THROW /* This macro will be used for functions which might take C++ callback functions. */ # define __MALLOC_PMT(args) args #else /* Not GCC. */ # define __THROW # if (defined __STDC__ && __STDC__) || defined __cplusplus # define __MALLOC_P(args) args # define __MALLOC_PMT(args) args # ifndef __const # define __const const # endif # else /* Not ANSI C or C++. */ # define __MALLOC_P(args) () /* No prototypes. */ # define __MALLOC_PMT(args) () # ifndef __const # define __const # endif # endif /* ANSI C or C++. */ #endif /* GCC. */ #ifndef NULL # ifdef __cplusplus # define NULL 0 # else # define NULL ((__malloc_ptr_t) 0) # endif #endif #ifdef __cplusplus extern "C" { #endif /* Nonzero if the malloc is already initialized. */ #ifdef _LIBC /* In the GNU libc we rename the global variable `__malloc_initialized' to `__libc_malloc_initialized'. */ # define __malloc_initialized __libc_malloc_initialized #endif extern int __malloc_initialized; /* Allocate SIZE bytes of memory. */ OPAL_DECLSPEC extern __malloc_ptr_t malloc __MALLOC_P ((size_t __size)) __attribute_malloc__; /* Allocate NMEMB elements of SIZE bytes each, all initialized to 0. */ OPAL_DECLSPEC extern __malloc_ptr_t calloc __MALLOC_P ((size_t __nmemb, size_t __size)) __attribute_malloc__; /* Re-allocate the previously allocated block in __ptr, making the new block SIZE bytes long. */ OPAL_DECLSPEC extern __malloc_ptr_t realloc __MALLOC_P ((__malloc_ptr_t __ptr, size_t __size)) __attribute_malloc__; /* Free a block allocated by `malloc', `realloc' or `calloc'. */ OPAL_DECLSPEC extern void free __MALLOC_P ((__malloc_ptr_t __ptr)); /* Free a block allocated by `calloc'. */ OPAL_DECLSPEC extern void cfree __MALLOC_P ((__malloc_ptr_t __ptr)); /* Allocate SIZE bytes allocated to ALIGNMENT bytes. */ OPAL_DECLSPEC extern __malloc_ptr_t memalign __MALLOC_P ((size_t __alignment, size_t __size)); /* Allocate SIZE bytes on a page boundary. */ OPAL_DECLSPEC extern __malloc_ptr_t valloc __MALLOC_P ((size_t __size)) __attribute_malloc__; /* Equivalent to valloc(minimum-page-that-holds(n)), that is, round up __size to nearest pagesize. */ OPAL_DECLSPEC extern __malloc_ptr_t pvalloc __MALLOC_P ((size_t __size)) __attribute_malloc__; /* Underlying allocation function; successive calls should return contiguous pieces of memory. */ OPAL_DECLSPEC extern __malloc_ptr_t (*__morecore) __MALLOC_PMT ((ptrdiff_t __size)); /* Default value of `__morecore'. */ OPAL_DECLSPEC extern __malloc_ptr_t __default_morecore __MALLOC_P ((ptrdiff_t __size)) __attribute_malloc__; /* SVID2/XPG mallinfo structure */ struct mallinfo { int arena; /* non-mmapped space allocated from system */ int ordblks; /* number of free chunks */ int smblks; /* number of fastbin blocks */ int hblks; /* number of mmapped regions */ int hblkhd; /* space in mmapped regions */ int usmblks; /* maximum total allocated space */ int fsmblks; /* space available in freed fastbin blocks */ int uordblks; /* total allocated space */ int fordblks; /* total free space */ int keepcost; /* top-most, releasable (via malloc_trim) space */ }; /* Returns a copy of the updated current mallinfo. */ OPAL_DECLSPEC extern struct mallinfo mallinfo __MALLOC_P ((void)); /* SVID2/XPG mallopt options */ #ifndef M_MXFAST # define M_MXFAST 1 /* maximum request size for "fastbins" */ #endif #ifndef M_NLBLKS # define M_NLBLKS 2 /* UNUSED in this malloc */ #endif #ifndef M_GRAIN # define M_GRAIN 3 /* UNUSED in this malloc */ #endif #ifndef M_KEEP # define M_KEEP 4 /* UNUSED in this malloc */ #endif /* mallopt options that actually do something */ #define M_TRIM_THRESHOLD -1 #define M_TOP_PAD -2 #define M_MMAP_THRESHOLD -3 #define M_MMAP_MAX -4 #define M_CHECK_ACTION -5 /* General SVID/XPG interface to tunable parameters. */ OPAL_DECLSPEC extern int mallopt __MALLOC_P ((int __param, int __val)); /* Release all but __pad bytes of freed top-most memory back to the system. Return 1 if successful, else 0. */ OPAL_DECLSPEC extern int malloc_trim __MALLOC_P ((size_t __pad)); /* Report the number of usable allocated bytes associated with allocated chunk __ptr. */ OPAL_DECLSPEC extern size_t malloc_usable_size __MALLOC_P ((__malloc_ptr_t __ptr)); /* Prints brief summary statistics on stderr. */ OPAL_DECLSPEC extern void malloc_stats __MALLOC_P ((void)); /* Record the state of all malloc variables in an opaque data structure. */ OPAL_DECLSPEC extern __malloc_ptr_t malloc_get_state __MALLOC_P ((void)); /* Restore the state of all malloc variables from data obtained with malloc_get_state(). */ OPAL_DECLSPEC extern int malloc_set_state __MALLOC_P ((__malloc_ptr_t __ptr)); /* Called once when malloc is initialized; redefining this variable in the application provides the preferred way to set up the hook pointers. */ OPAL_DECLSPEC extern void (*__malloc_initialize_hook) __MALLOC_PMT ((void)); /* Hooks for debugging and user-defined versions. */ OPAL_DECLSPEC extern void (*__free_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr, __const __malloc_ptr_t)); OPAL_DECLSPEC extern __malloc_ptr_t (*__malloc_hook) __MALLOC_PMT ((size_t __size, __const __malloc_ptr_t)); OPAL_DECLSPEC extern __malloc_ptr_t (*__realloc_hook) __MALLOC_PMT ((__malloc_ptr_t __ptr, size_t __size, __const __malloc_ptr_t)); OPAL_DECLSPEC extern __malloc_ptr_t (*__memalign_hook) __MALLOC_PMT ((size_t __alignment, size_t __size, __const __malloc_ptr_t)); OPAL_DECLSPEC extern void (*__after_morecore_hook) __MALLOC_PMT ((void)); /* Activate a standard set of debugging hooks. */ OPAL_DECLSPEC extern void __malloc_check_init __MALLOC_P ((void)); /* Internal routines, operating on "arenas". */ struct malloc_state; typedef struct malloc_state *mstate; OPAL_DECLSPEC extern mstate _int_new_arena __MALLOC_P ((size_t __ini_size)); OPAL_DECLSPEC extern __malloc_ptr_t _int_malloc __MALLOC_P ((mstate __m, size_t __size)); OPAL_DECLSPEC extern void _int_free __MALLOC_P ((mstate __m, __malloc_ptr_t __ptr)); OPAL_DECLSPEC extern __malloc_ptr_t _int_realloc __MALLOC_P ((mstate __m, __malloc_ptr_t __ptr, size_t __size)); OPAL_DECLSPEC extern __malloc_ptr_t _int_memalign __MALLOC_P ((mstate __m, size_t __alignment, size_t __size)); /* Return arena number __n, or 0 if out of bounds. Arena 0 is the main arena. */ OPAL_DECLSPEC extern mstate _int_get_arena __MALLOC_P ((int __n)); /* Implementation-specific mallinfo. More detailed than mallinfo, and also works for size_t wider than int. */ struct malloc_arena_info { int nfastblocks; /* number of freed "fastchunks" */ int nbinblocks; /* number of available chunks in bins */ size_t fastavail; /* total space in freed "fastchunks" */ size_t binavail; /* total space in binned chunks */ size_t top_size; /* size of top chunk */ size_t system_mem; /* bytes allocated from system in this arena */ size_t max_system_mem; /* max. bytes allocated from system */ /* Statistics for locking. Only kept if THREAD_STATS is defined at compile time. */ long stat_lock_direct, stat_lock_loop, stat_lock_wait; }; struct malloc_global_info { int n_mmaps; /* number of mmap'ed chunks */ int max_n_mmaps; /* max. number of mmap'ed chunks reached */ size_t mmapped_mem; /* total bytes allocated in mmap'ed chunks */ size_t max_mmapped_mem; /* max. bytes allocated in mmap'ed chunks */ size_t max_total_mem; /* only kept for NO_THREADS */ int stat_n_heaps; /* only kept if THREAD_STATS is defined */ }; OPAL_DECLSPEC extern void _int_get_arena_info __MALLOC_P ((mstate __m, struct malloc_arena_info *__ma)); OPAL_DECLSPEC extern void _int_get_global_info __MALLOC_P ((struct malloc_global_info *__m)); OPAL_DECLSPEC extern int posix_memalign (void **memptr, size_t alignment, size_t size); #ifdef __cplusplus } /* end of extern "C" */ #endif #endif /* malloc.h */