OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs
memchecker.h File Reference

memchecker (memory checker) framework component interface. More...

`#include "opal_config.h"`
`#include "opal/mca/mca.h"`
`#include "opal/mca/base/base.h"`

Go to the source code of this file.

## Data Structures
struct | opal_memchecker_base_component_2_0_0_t
| Structure for memchecker components. More...
struct | opal_memchecker_base_module_1_0_0_t
| Structure for memchecker modules. More...

## Macros
#define | OPAL_MEMCHECKER_BASE_VERSION_2_0_0
| Macro for use in components that are of type memchecker. More...

## Typedefs
typedef int(* | opal_memchecker_base_module_init_1_0_0_fn_t )(void)
| Module initialization function. More...
typedef int(* | opal_memchecker_base_module_runindebugger_fn_t )(void)
| Module function to query, whether we're under the memory checking program, like valgrind.
typedef int(* | opal_memchecker_base_module_isaddressable_fn_t )(void *p, size_t len)
| Module function to check, whether memory region is addressable.
typedef int(* | opal_memchecker_base_module_isdefined_fn_t )(void *p, size_t len)
| Module function to check, whether memory region is defined.
typedef int(* | opal_memchecker_base_module_mem_noaccess_fn_t )(void *p, size_t len)
| Module function to set memory region to not accessible.
typedef int(* | opal_memchecker_base_module_mem_undefined_fn_t )(void *p, size_t len)
| Module function to set memory region to undefined.
typedef int(* | opal_memchecker_base_module_mem_defined_fn_t )(void *p, size_t len)
| Module function to set memory region to defined.
typedef int(* | opal_memchecker_base_module_mem_defined_if_addressable_fn_t )(void *p, size_t len)
| Module function to set memory region to defined, but only if addressable.
typedef int(* | opal_memchecker_base_module_create_block_fn_t )(void *p, size_t len, char *description)
| Module function name a specific memory region.
typedef int(* | opal_memchecker_base_module_discard_block_fn_t )(void *p)
| Module function to discard a named memory region.
typedef int(* | opal_memchecker_base_module_leakcheck_fn_t )(void)
| Module function to check for any leaks.
typedef int(* | opal_memchecker_base_module_get_vbits_fn_t )(void *p, char *vbits, size_t len)
| Module function to get vbits.
typedef int(* | opal_memchecker_base_module_set_vbits_fn_t )(void *p, char *vbits, size_t len)
| Module function to set vbits.
typedef struct opal_memchecker_base_component_2_0_0_t | opal_memchecker_base_component_2_0_0_t
| Convenience typedef.
typedef struct opal_memchecker_base_component_2_0_0_t | opal_memchecker_base_component_t
typedef struct opal_memchecker_base_module_1_0_0_t | opal_memchecker_base_module_1_0_0_t
| Convenience typedef.
typedef struct opal_memchecker_base_module_1_0_0_t | opal_memchecker_base_module_t

## Detailed Description

memchecker (memory checker) framework component interface.

Intent

This is a very thin framework to abstract memory checking tools, such as valgrind and possibly Sun rtc (memory checking available possibly only under Solaris/Sparc).

Currently, only functionality for hiding and unhiding of memory is added; further functions provided by the memory checker/api checker could be added, however, this comes (at least for valgrind) with considerable overhead. One possible option would be to have error_print_callbacks, that output different error messages, depending on the memory location being hit by certain error.

## Macro Definition Documentation

#define OPAL_MEMCHECKER_BASE_VERSION_2_0_0

Value:
MCA_BASE_VERSION_2_0_0, \
"memchecker", 2, 0, 0

Macro for use in components that are of type memchecker.

## Typedef Documentation

typedef int(* opal_memchecker_base_module_init_1_0_0_fn_t)(void)

Module initialization function.

Should return OPAL_SUCCESS.