OpenMPI 0.1.1

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

- File List
- Globals

base.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
3 * University Research and Technology
4 * Corporation. All rights reserved.
5 * Copyright (c) 2004-2006 The University of Tennessee and The University
6 * of Tennessee Research Foundation. All rights
7 * reserved.
8 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
9 * University of Stuttgart. All rights reserved.
10 * Copyright (c) 2004-2005 The Regents of the University of California.
11 * All rights reserved.
12 * $COPYRIGHT$
13 *
14 * Additional copyrights may follow
15 *
16 * $HEADER$
17 */
18 /**
19 * @file
20 */
21 #ifndef MCA_ALLOCATOR_BASE_H
22 #define MCA_ALLOCATOR_BASE_H
23
24 #include "ompi_config.h"
25
26 #include "opal/class/opal_list.h"
27 #include "opal/mca/mca.h"
28 #include "ompi/mca/allocator/allocator.h"
29
30 BEGIN_C_DECLS
31 /**
32 * Structure which describes a selected module.
33 */
34 struct mca_allocator_base_selected_module_t {
35 opal_list_item_t super;
36 /**< Makes this an object of type opal_list_item */
37 mca_allocator_base_component_t *allocator_component;
38 /**< Info about the module */
39 mca_allocator_base_module_t *allocator_module;
40 /**< The function pointers for all the module's functions. */
41 };
42 /**
43 * Convenience typedef.
44 */
45 typedef struct mca_allocator_base_selected_module_t mca_allocator_base_selected_module_t;
46
47 /**
48 * Declaces mca_mpool_base_selected_module_t as a class.
49 */
50 OMPI_DECLSPEC OBJ_CLASS_DECLARATION(mca_allocator_base_selected_module_t);
51
52
53 /*
54 * Global functions for MCA: overall allocator open and close
55 */
56
57 OMPI_DECLSPEC int mca_allocator_base_open(void);
58 OMPI_DECLSPEC int mca_allocator_base_close(void);
59 OMPI_DECLSPEC mca_allocator_base_component_t* mca_allocator_component_lookup(const char* name);
60
61
62 /*
63 * Globals
64 */
65 /**
66 * The list of all the selected components.
67 */
68 OMPI_DECLSPEC extern opal_list_t mca_allocator_base_components;
69
70 END_C_DECLS
71
72 #endif /* MCA_ALLOCATOR_BASE_H */
opal_list.h
The opal_list_t interface is used to provide a generic doubly-linked list container for Open MPI...
mca_allocator_base_selected_module_t::allocator_module
mca_allocator_base_module_t * allocator_module
The function pointers for all the module's functions.
Definition: base.h:39
mca.h
Top-level interface for all MCA components.
opal_list_item_t
Definition: opal_list.h:98
mca_allocator_base_components
OMPI_DECLSPEC opal_list_t mca_allocator_base_components
The list of all the selected components.
Definition: allocator_base_open.c:42
OBJ_CLASS_DECLARATION
ORTE_DECLSPEC OBJ_CLASS_DECLARATION(mca_oob_base_info_t)
declare the association structure as a class
mca_allocator_base_component_2_0_0_t
The data structure provided by each component to the framework which describes the component...
Definition: allocator.h:133
mca_allocator_base_close
OMPI_DECLSPEC int mca_allocator_base_close(void)
Closes all the remaining modules.
Definition: allocator_base_close.c:34
opal_list_t
Definition: opal_list.h:147
mca_allocator_base_selected_module_t::super
opal_list_item_t super
Makes this an object of type opal_list_item.
Definition: base.h:35
mca_allocator_base_selected_module_t
Structure which describes a selected module.
Definition: base.h:34
allocator.h
Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana University Research and Techno...
mca_allocator_base_selected_module_t::allocator_component
mca_allocator_base_component_t * allocator_component
Info about the module.
Definition: base.h:37
mca_allocator_component_lookup
OMPI_DECLSPEC mca_allocator_base_component_t * mca_allocator_component_lookup(const char *name)
Traverses through the list of available components, calling their init functions until it finds the c...
Definition: allocator_base_open.c:67
mca_allocator_base_open
OMPI_DECLSPEC int mca_allocator_base_open(void)
Function for finding and opening either all MCA components, or the one that was specifically requeste...
Definition: allocator_base_open.c:49
mca_allocator_base_module_t
The data structure for each component.
Definition: allocator.h:78