1
1
openmpi/opal/util/malloc.h
Jeff Squyres 3a9179a0d7 Initial population of the opal tree
This commit was SVN r6267.
2005-07-02 13:43:20 +00:00

155 строки
4.6 KiB
C

/*
* Copyright (c) 2004-2005 The Trustees of Indiana University.
* All rights reserved.
* Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
* All rights reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/** @file */
#ifndef OMPI_MALLOC_H
#define OMPI_MALLOC_H
#include <stdlib.h>
/*
* THIS FILE CANNOT INCLUDE ANY OTHER OMPI HEADER FILES!!!
*
* It is included via <ompi_config_bottom.h>. Hence, it should not
* include ANY other files, nor should it include "ompi_config.h".
*
*/
/*
* Set OMPI_MALLOC_DEBUG_LEVEL to
* 0 for no checking
* 1 for basic error checking
* 2 for more error checking
*/
#ifndef OMPI_MALLOC_DEBUG_LEVEL
#define OMPI_MALLOC_DEBUG_LEVEL 2
#endif
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
/**
* Initialize malloc debug output.
*
* This function is invoked to setup a dedicated output stream for
* malloc debug functions. It does \em not (currently) do anything
* other than that (i.e., no internal accounting for tracking
* malloc/free statements, etc.).
*
* It is invoked as part of ompi_init(). Although this function is
* not \em necessary for OMPI_MALLOC() and OMPI_FREE(), it is strong
* recommended because no output messages -- regardless of the
* malloc debug level set by ompi_malloc_debug() -- will be displayed
* unless this function is invoked first.
*/
void ompi_malloc_init(void);
/**
* Shut down malloc debug output.
*
* This function is invoked as part of ompi_finalize() to shut down the
* output stream for malloc debug messages.
*/
void ompi_malloc_finalize(void);
/**
* \internal
*
* Back-end error-checking malloc function for OMPI (you should use
* the normal malloc() instead of this function).
*
* @param size The number of bytes to allocate
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OMPI_DECLSPEC void *ompi_malloc(size_t size, const char *file, int line);
/**
* \internal
*
* Back-end error-checking calloc function for OMPI (you should use
* the normal calloc() instead of this function).
*
* @param nmembers Number of elements to malloc
* @param size Size of each elements
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OMPI_DECLSPEC void *ompi_calloc(size_t nmembers, size_t size, const char *file, int line);
/**
* \internal
*
* Back-end error-checking realloc function for OMPI (you should use
* the normal realloc() instead of this function).
*
* @param ptr Pointer to reallocate
* @param size The number of bytes to allocate
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified to
* configure (or by default if you're building in a SVN checkout).
*/
OMPI_DECLSPEC void *ompi_realloc(void *ptr, size_t size, const char *file, int line);
/**
* \internal
*
* Back-end error-checking free function for OMPI (you should use
* free() instead of this function).
*
* @param addr Address on the heap to free()
* @param file Typically the __FILE__ macro
* @param line Typically the __LINE__ macro
*
* This function is only used when --enable-mem-debug was specified
* to configure (or by default if you're building in a SVN
* checkout).
*/
OMPI_DECLSPEC void ompi_free(void *addr, const char *file, int line);
OMPI_DECLSPEC extern int ompi_malloc_debug_level;
OMPI_DECLSPEC extern int ompi_malloc_output;
static inline void ompi_malloc_debug(int level);
/**
* Used to set the debug level for malloc debug.
*
* @param level The level of debugging (0 = none, 1 = some, 2 = more)
*
* This value defaults to the OMPI_MALLOC_DEBUG_LEVEL.
*/
static inline void ompi_malloc_debug(int level)
{
ompi_malloc_debug_level = level;
}
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif /* OMPI_MALLOC_H */