552c9ca5a0
WHAT: Open our low-level communication infrastructure by moving all necessary components (btl/rcache/allocator/mpool) down in OPAL All the components required for inter-process communications are currently deeply integrated in the OMPI layer. Several groups/institutions have express interest in having a more generic communication infrastructure, without all the OMPI layer dependencies. This communication layer should be made available at a different software level, available to all layers in the Open MPI software stack. As an example, our ORTE layer could replace the current OOB and instead use the BTL directly, gaining access to more reactive network interfaces than TCP. Similarly, external software libraries could take advantage of our highly optimized AM (active message) communication layer for their own purpose. UTK with support from Sandia, developped a version of Open MPI where the entire communication infrastucture has been moved down to OPAL (btl/rcache/allocator/mpool). Most of the moved components have been updated to match the new schema, with few exceptions (mainly BTLs where I have no way of compiling/testing them). Thus, the completion of this RFC is tied to being able to completing this move for all BTLs. For this we need help from the rest of the Open MPI community, especially those supporting some of the BTLs. A non-exhaustive list of BTLs that qualify here is: mx, portals4, scif, udapl, ugni, usnic. This commit was SVN r32317.
158 строки
4.4 KiB
C
158 строки
4.4 KiB
C
/**
|
|
* 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$
|
|
*/
|
|
/**
|
|
* @file
|
|
* The public definition of the MCA Allocator framework.
|
|
*/
|
|
#ifndef MCA_ALLOCATOR_H
|
|
#define MCA_ALLOCATOR_H
|
|
|
|
#include "opal_config.h"
|
|
#include "opal/mca/mca.h"
|
|
#include "opal/mca/mpool/mpool.h"
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
/* Here so that we can use mca_allocator_base_module_t in the function typedefs */
|
|
struct mca_allocator_base_module_t;
|
|
|
|
/**
|
|
* The allocate function typedef for the function to be provided by the component.
|
|
*/
|
|
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 realloc function typedef
|
|
*/
|
|
typedef void* (*mca_allocator_base_module_realloc_fn_t)(
|
|
struct mca_allocator_base_module_t*,
|
|
void*, size_t,
|
|
mca_mpool_base_registration_t** registration);
|
|
|
|
/**
|
|
* Free function typedef
|
|
*/
|
|
typedef void(*mca_allocator_base_module_free_fn_t)(
|
|
struct mca_allocator_base_module_t*, void *);
|
|
|
|
|
|
/**
|
|
* compact/return memory to higher level allocator
|
|
*/
|
|
|
|
typedef int (*mca_allocator_base_module_compact_fn_t)(
|
|
struct mca_allocator_base_module_t* allocator
|
|
);
|
|
|
|
|
|
/**
|
|
* cleanup (free) any resources held by allocator
|
|
*/
|
|
|
|
typedef int (*mca_allocator_base_module_finalize_fn_t)(
|
|
struct mca_allocator_base_module_t* allocator
|
|
);
|
|
|
|
/**
|
|
* The data structure for each component.
|
|
*/
|
|
struct mca_allocator_base_module_t {
|
|
mca_allocator_base_module_alloc_fn_t alc_alloc;
|
|
/**< Allocate memory */
|
|
mca_allocator_base_module_realloc_fn_t alc_realloc;
|
|
/**< Reallocate memory */
|
|
mca_allocator_base_module_free_fn_t alc_free;
|
|
/**< Free memory */
|
|
mca_allocator_base_module_compact_fn_t alc_compact;
|
|
/**< Return memory */
|
|
mca_allocator_base_module_finalize_fn_t alc_finalize;
|
|
/**< Finalize and free everything */
|
|
/* memory pool and resources */
|
|
struct mca_mpool_base_module_t* alc_mpool;
|
|
};
|
|
/**
|
|
* Convenience typedef.
|
|
*/
|
|
typedef struct mca_allocator_base_module_t mca_allocator_base_module_t;
|
|
|
|
|
|
/**
|
|
* 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_alloc_fn_t)(
|
|
struct mca_mpool_base_module_t* module,
|
|
size_t* size,
|
|
mca_mpool_base_registration_t** registration);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
typedef void (*mca_allocator_base_component_segment_free_fn_t)(
|
|
struct mca_mpool_base_module_t* module,
|
|
void* segment);
|
|
|
|
|
|
/**
|
|
* The function used to initialize the component.
|
|
*/
|
|
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 data structure provided by each component to the framework which
|
|
* describes the component.
|
|
*/
|
|
struct mca_allocator_base_component_2_0_0_t {
|
|
mca_base_component_t allocator_version;
|
|
/**< The version of the component */
|
|
mca_base_component_data_t allocator_data;
|
|
/**< The component metadata */
|
|
mca_allocator_base_component_init_fn_t allocator_init;
|
|
/**< The component initialization function. */
|
|
};
|
|
|
|
/**
|
|
* Convenience typedef.
|
|
*/
|
|
typedef struct mca_allocator_base_component_2_0_0_t mca_allocator_base_component_t;
|
|
|
|
/**
|
|
* Macro for use in components that are of type allocator
|
|
*/
|
|
#define MCA_ALLOCATOR_BASE_VERSION_2_0_0 \
|
|
MCA_BASE_VERSION_2_0_0, \
|
|
"allocator", 2, 0, 0
|
|
|
|
END_C_DECLS
|
|
|
|
#endif /* MCA_ALLOCATOR_H */
|
|
|