9cd2c6f48b
implement specific function, thereby removing bogus requirement on valgrind/valgrind.h dough... - Call specific function runindebugger() before doing expensive checks on each component of struct. - Get rid of void* warnings.. This commit was SVN r17438.
298 строки
8.0 KiB
C
298 строки
8.0 KiB
C
/*
|
|
* Copyright (c) 2004-2006 High Performance Computing Center Stuttgart,
|
|
* University of Stuttgart. All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*
|
|
*/
|
|
|
|
#ifndef OPAL_MEMCHECKER_BASE_H
|
|
#define OPAL_MEMCHECKER_BASE_H
|
|
|
|
#include "opal_config.h"
|
|
|
|
#include "opal/mca/memchecker/memchecker.h"
|
|
|
|
/*
|
|
* Global functions for MCA overall memchecker open and close
|
|
*/
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Initialize the memchecker MCA framework
|
|
*
|
|
* @retval OPAL_SUCCESS Upon success
|
|
* @retval OPAL_ERROR Upon failure
|
|
*
|
|
* This must be the first function invoked in the memchecker MCA
|
|
* framework. It initializes the memchecker MCA framework, finds
|
|
* and opens memchecker components, etc.
|
|
*
|
|
* This function is invoked during opal_init() and during the
|
|
* initialization of the special case of the laminfo command.
|
|
*
|
|
* This function fills in the internal global variable
|
|
* opal_memchecker_base_components_opened, which is a list of all
|
|
* memchecker components that were successfully opened. This
|
|
* variable should \em only be used by other memchecker base
|
|
* functions -- it is not considered a public interface member --
|
|
* and is only mentioned here for completeness.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_open(void);
|
|
|
|
/**
|
|
* Select one available component.
|
|
*
|
|
* @return OPAL_SUCCESS Upon success.
|
|
*
|
|
* This function invokes the selection process for memchecker
|
|
* components
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_select(void);
|
|
|
|
/**
|
|
* Shut down the memchecker MCA framework.
|
|
*
|
|
* @retval OPAL_SUCCESS Always
|
|
*
|
|
* This function shuts down everything in the memchecker MCA
|
|
* framework, and is called during opal_finalize() and the
|
|
* special case of the laminfo command.
|
|
*
|
|
* It must be the last function invoked on the memchecker MCA framework.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_close(void);
|
|
|
|
/**
|
|
* List of all opened components; created when the memchecker
|
|
* framework is initialized and destroyed, when we reduce the list
|
|
* to all available memchecker components (actually one).
|
|
*/
|
|
OPAL_DECLSPEC extern opal_list_t opal_memchecker_base_components_opened;
|
|
|
|
/**
|
|
* Indication of whether one component was successfully selected
|
|
*/
|
|
OPAL_DECLSPEC extern bool opal_memchecker_base_selected;
|
|
|
|
/**
|
|
* Global component struct for the selected component
|
|
*/
|
|
OPAL_DECLSPEC extern const opal_memchecker_base_component_1_0_0_t
|
|
*opal_memchecker_base_component;
|
|
|
|
/**
|
|
* Global module struct for the selected module
|
|
*/
|
|
OPAL_DECLSPEC extern const opal_memchecker_base_module_1_0_0_t
|
|
*opal_memchecker_base_module;
|
|
|
|
/**
|
|
* Debugging output stream
|
|
*/
|
|
extern int opal_memchecker_base_output;
|
|
|
|
/**
|
|
* Check if we are running under the memory debugger.
|
|
*
|
|
* @retval 0 if not running under memory debugger
|
|
* !=0 if running under memory debugger
|
|
*
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_runindebugger(void);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_runindebugger()
|
|
#endif
|
|
|
|
|
|
/**
|
|
* Check if a memory region is valid to address
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, whether
|
|
* every Byte of this memory region is addressible
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_isaddressible(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_isaddressible(p, len)
|
|
#endif
|
|
|
|
|
|
/**
|
|
* Check if a memory region is defined
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, whether
|
|
* every Byte of this memory region is correctly initialized.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_isdefined(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_isdefined(p, len)
|
|
#endif
|
|
|
|
/**
|
|
* Set a memory region to not accessible
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to set
|
|
* every Byte of this memory region to not accessible.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_mem_noaccess(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_mem_noaccess(p, len)
|
|
#endif
|
|
|
|
/**
|
|
* Set a memory region to undefined
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to set
|
|
* every Byte of this memory region to not contain initialized data.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_mem_undefined(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_mem_undefined(p, len)
|
|
#endif
|
|
|
|
/**
|
|
* Set a memory region to defined
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to set
|
|
* every Byte of this memory region to contain valid, initialized data.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_mem_defined(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_mem_defined(p, len)
|
|
#endif
|
|
|
|
/**
|
|
* Set a memory region to defined only if the region is addressible
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to set
|
|
* every Byte of this memory region to contain valid, initialized data,
|
|
* but only, if the memory region is addressible.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_mem_defined_if_addressible(void * p, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_mem_defined_if_addressible(p, len)
|
|
#endif
|
|
|
|
/**
|
|
* Create a named memory region
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param len Length of the memory region
|
|
* @param description Name of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to name
|
|
* this memory region.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_create_block(void * p, size_t len, char * description);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_create_block(p, len, description)
|
|
#endif
|
|
|
|
/**
|
|
* Discard a named memory region
|
|
*
|
|
* @param p Pointer to the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to discard
|
|
* the name information of the memory region.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_discard_block(void * p);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_discard_block(p)
|
|
#endif
|
|
|
|
/**
|
|
* Perform leak check on lost allocated memory.
|
|
*
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to output
|
|
* information regarding lost allocated memory.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_leakcheck(void);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_leakcheck
|
|
#endif
|
|
|
|
/**
|
|
* Get vbits of the memory
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param vbits Pointer to the vbit table
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to get
|
|
* every vbit of this memory region.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_get_vbits(void * p, char * vbits, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_get_vbits(p, vbits, len)
|
|
#endif
|
|
|
|
/**
|
|
* Set vbits of the memory
|
|
*
|
|
* @param p Pointer to the memory region
|
|
* @param vbits Pointer to the vbit table
|
|
* @param len Length of the memory region
|
|
*
|
|
* @retval OPAL_SUCCESS upon success.
|
|
*
|
|
* This function calls the selected memchecker, to get
|
|
* every vbit of this memory region.
|
|
*/
|
|
OPAL_DECLSPEC int opal_memchecker_base_set_vbits(void * p, char * vbits, size_t len);
|
|
#if OMPI_WANT_MEMCHECKER == 0
|
|
#define opal_memchecker_base_set_vbits(p, vbits, len)
|
|
#endif
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* OPAL_MEMCHECKER_BASE_H */
|