Viewing file:  base.h (6.56 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
/*
* 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/base/mca_base_framework.h"
#include "opal/mca/memchecker/memchecker.h"
/*
* Global functions for MCA overall memchecker open and close
*/
BEGIN_C_DECLS
/**
* 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);
/**
* Framework structure for memchecker
*/
OPAL_DECLSPEC extern mca_base_framework_t opal_memchecker_base_framework;
/**
* 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_2_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;
/**
* 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 OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_runindebugger() 0
#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 addressable
*/
OPAL_DECLSPEC int opal_memchecker_base_isaddressable(void * p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_isaddressable(p, len) 0
#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 OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_isdefined(p, len) 0
#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 OPAL_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 OPAL_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 OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_mem_defined(p, len)
#endif
/**
* Set a memory region to defined only if the region is addressable
*
* @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 addressable.
*/
OPAL_DECLSPEC int opal_memchecker_base_mem_defined_if_addressable(void * p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_mem_defined_if_addressable(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 OPAL_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 OPAL_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 OPAL_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 OPAL_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 OPAL_WANT_MEMCHECKER == 0
#define opal_memchecker_base_set_vbits(p, vbits, len)
#endif
END_C_DECLS
#endif /* OPAL_MEMCHECKER_BASE_H */
|