OpenMPI 0.1.1

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

- File List
- Globals

Data Structures | Macros | Typedefs
carto.h File Reference

The carto framework suplies an information of the the host structure and connection between the host components i.e memory nodes,CPUs, Ethernet port and inifiniband ports. More...

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

Go to the source code of this file.

## Data Structures
struct | opal_carto_base_node_t
struct | opal_carto_node_distance_t
| A structure of node distance from some other node. More...
struct | opal_carto_base_component_2_0_0_t
| Structure for carto components. More...
struct | opal_carto_base_module_1_0_0_t
| Structure for carto modules. More...

## Macros
#define | OPAL_CARTO_BASE_VERSION_2_0_0

## Typedefs
typedef opal_graph_t | opal_carto_graph_t
| type for carto graph
typedef struct opal_carto_base_node_t | opal_carto_base_node_t
| A definition of carto node type.
typedef struct opal_carto_node_distance_t | opal_carto_node_distance_t
| A definition of node distance type.
typedef int(* | opal_carto_base_module_init_1_0_0_fn_t )(void)
| Module initialization function. More...
typedef int(* | opal_carto_base_get_host_graph_fn_t )(opal_carto_graph_t **graph, const char *graph_type)
| Get the local host graph. More...
typedef void(* | opal_carto_base_free_graph_fn_t )(opal_carto_graph_t *graph)
| Frre a graph.
typedef int(* | opal_carto_base_get_nodes_distance_fn_t )(opal_carto_graph_t *graph, opal_carto_base_node_t *start, const char *node_type, opal_value_array_t *distance_)
| Get the distance (weight) from a start node to all other nodes. More...
typedef uint32_t(* | opal_carto_base_spf_fn_t )(opal_carto_graph_t *graph, opal_carto_base_node_t *start, opal_carto_base_node_t *end)
| find the distance between two nodes.
typedef opal_carto_base_node_t *(* | opal_carto_base_find_node_fn_t )(opal_carto_graph_t *graph, const char *node_name)
| Find a node in the graph.
typedef int(* | opal_carto_base_module_finalize_fn_t )(void)
| Module finalize function. More...
typedef struct opal_carto_base_component_2_0_0_t | opal_carto_base_component_2_0_0_t
| Convenience typedef.
typedef struct opal_carto_base_component_2_0_0_t | opal_carto_base_component_t
typedef struct opal_carto_base_module_1_0_0_t | opal_carto_base_module_1_0_0_t
| Convenience typedef.
typedef struct opal_carto_base_module_1_0_0_t | opal_carto_base_module_t

## Detailed Description

The carto framework suplies an information of the the host structure and connection between the host components i.e memory nodes,CPUs, Ethernet port and inifiniband ports.

## Macro Definition Documentation

#define OPAL_CARTO_BASE_VERSION_2_0_0

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

## Typedef Documentation

typedef int(* opal_carto_base_get_host_graph_fn_t)(opal_carto_graph_t **graph, const char *graph_type)

Get the local host graph.

you can reduce the graph for only the nodes that interst you using the node type.

typedef int(* opal_carto_base_get_nodes_distance_fn_t)(opal_carto_graph_t *graph, opal_carto_base_node_t *start, const char *node_type, opal_value_array_t *distance_)

Get the distance (weight) from a start node to all other nodes.

you can reduce the list to the list to the node types that intersts you.

typedef int(* opal_carto_base_module_finalize_fn_t)(void)

Module finalize function.

Invoked by the base on the selected module when the carto framework is being shut down.

typedef int(* opal_carto_base_module_init_1_0_0_fn_t)(void)

Module initialization function.

Should return OPAL_SUCCESS.