OpenMPI 0.1.1

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

- File List
- Globals

Data Structures | Macros | Typedefs | Variables
allocator.h File Reference

Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana University Research and Technology Corporation. More...

`#include "ompi_config.h"`
`#include "opal/mca/mca.h"`
`#include "ompi/mca/mpool/mpool.h"`

Go to the source code of this file.

## Data Structures
struct | mca_allocator_base_module_t
| The data structure for each component. More...
struct | mca_allocator_base_component_2_0_0_t
| The data structure provided by each component to the framework which describes the component. More...

## Macros
#define | MCA_ALLOCATOR_BASE_VERSION_2_0_0
| Macro for use in components that are of type allocator. More...

## Typedefs
typedef void *(* | mca_allocator_base_module_alloc_fn_t )(struct mca_allocator_base_module_t *, size_t size, size_t align, mca_mpool_base_registration_t **registration)
| The allocate function typedef for the function to be provided by the component.
typedef void *(* | mca_allocator_base_module_realloc_fn_t )(struct mca_allocator_base_module_t *, void *, size_t, mca_mpool_base_registration_t **registration)
| The realloc function typedef.
typedef void(* | mca_allocator_base_module_free_fn_t )(struct mca_allocator_base_module_t *, void *)
| Free function typedef.
typedef int(* | mca_allocator_base_module_compact_fn_t )(struct mca_allocator_base_module_t *allocator)
| compact/return memory to higher level allocator
typedef int(* | mca_allocator_base_module_finalize_fn_t )(struct mca_allocator_base_module_t *allocator)
| cleanup (free) any resources held by allocator
typedef struct mca_allocator_base_module_t | mca_allocator_base_module_t
| Convenience typedef.
typedef void *(* | mca_allocator_base_component_segment_alloc_fn_t )(struct mca_mpool_base_module_t *module, size_t *size, mca_mpool_base_registration_t **registration)
| A function to get more memory from the system. More...
typedef void(* | mca_allocator_base_component_segment_free_fn_t )(struct mca_mpool_base_module_t *module, void *segment)
| A function to free memory from the control of the allocator framework back to the system. More...
typedef struct mca_allocator_base_module_t *(* | mca_allocator_base_component_init_fn_t )(bool enable_mpi_threads, mca_allocator_base_component_segment_alloc_fn_t segment_alloc, mca_allocator_base_component_segment_free_fn_t segment_free, struct mca_mpool_base_module_t *mpool)
| The function used to initialize the component.
typedef struct mca_allocator_base_component_2_0_0_t | mca_allocator_base_component_t
| Convenience typedef.

## Variables
OMPI_DECLSPEC int | mca_allocator_base_output
| The output integer used for the mca base.

## Detailed Description

Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana University Research and Technology Corporation.

All rights reserved. Copyright (c) 2004-2006 The University of Tennessee and The University of Tennessee Research Foundation. 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$

The public definition of the MCA Allocator framework.

## Macro Definition Documentation

#define MCA_ALLOCATOR_BASE_VERSION_2_0_0

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

Macro for use in components that are of type allocator.

## Typedef Documentation

typedef void*(* mca_allocator_base_component_segment_alloc_fn_t)(struct mca_mpool_base_module_t *module, size_t *size, mca_mpool_base_registration_t **registration)

A function to get more memory from the system.

This function is to be provided by the module to the allocator framework.

typedef void(* mca_allocator_base_component_segment_free_fn_t)(struct mca_mpool_base_module_t *module, void *segment)

A function to free memory from the control of the allocator framework back to the system.

This function is to be provided by the module to the allocator framework.