1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2013 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 (c) 2008 Cisco Systems, Inc. All rights reserved.
* Copyright (c) 2009 Oak Ridge National Labs. All rights reserved.
* Copyright (c) 2012-2013 Los Alamos National Security, Inc. All rights reserved.
* Copyright (c) 2012-2013 Inria. All rights reserved.
* Copyright (c) 2014-2015 Research Organization for Information Science
* and Technology (RIST). All rights reserved.
* Copyright (c) 2016-2017 IBM Corporation. All rights reserved.
* Copyright (c) 2018 Triad National Security, LLC. All rights
* reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef MCA_TOPO_BASE_H
#define MCA_TOPO_BASE_H
#include "ompi_config.h"
#include "opal/class/opal_list.h"
#include "ompi/mca/mca.h"
#include "ompi/mca/topo/topo.h"
#include "ompi/proc/proc.h"
#include "ompi/communicator/communicator.h"
#include "ompi/info/info.h"
/*
* All stuff goes in here
*/
BEGIN_C_DECLS
/* Lazily initialize the framework (if it wasn't already) */
OMPI_DECLSPEC int mca_topo_base_lazy_init(void);
/*
* MCA Framework
*/
OMPI_DECLSPEC extern mca_base_framework_t ompi_topo_base_framework;
/* Select a topo module for a particular type of topology */
OMPI_DECLSPEC int
mca_topo_base_comm_select(const ompi_communicator_t* comm,
mca_topo_base_module_t* preferred_module,
mca_topo_base_module_t** selected_module,
uint32_t type);
/* Select a topo module for a particular type of topology */
OMPI_DECLSPEC int
mca_topo_base_group_select (const ompi_group_t *group,
mca_topo_base_module_t *preferred_module,
mca_topo_base_module_t **selected_module,
uint32_t type);
/* Find all components that want to be considered in this job */
OMPI_DECLSPEC int
mca_topo_base_find_available(bool enable_progress_threads,
bool enable_mpi_threads);
/*
* All the glue functions which we will provide to the users by
* default. The component authors need to only write back-end
* functions for cart_create(), graph_create(), graph_map(), and
* cart_map() for their topology components. But they can implement
* these glue functions if they want.
*
* These glue functions
*/
OMPI_DECLSPEC int
mca_topo_base_cart_create(mca_topo_base_module_t *topo_module,
ompi_communicator_t* old_comm,
int ndims,
const int *dims,
const int *periods,
bool reorder,
ompi_communicator_t** comm_topo);
OMPI_DECLSPEC int
mca_topo_base_cart_coords(ompi_communicator_t *comm,
int rank,
int maxdims,
int *coords);
OMPI_DECLSPEC int
mca_topo_base_cartdim_get(ompi_communicator_t *comm,
int *ndims);
OMPI_DECLSPEC int
mca_topo_base_cart_get(ompi_communicator_t *comm,
int maxdims,
int *dims,
int *periods,
int *coords);
OMPI_DECLSPEC int
mca_topo_base_cart_map(ompi_communicator_t * comm,
int ndims,
const int *dims, const int *periods, int *newrank);
OMPI_DECLSPEC int
mca_topo_base_cart_rank(ompi_communicator_t *comm,
const int *coords,
int *rank);
OMPI_DECLSPEC int
mca_topo_base_cart_shift(ompi_communicator_t *comm,
int direction,
int disp,
int *rank_source,
int *rank_dest);
OMPI_DECLSPEC int
mca_topo_base_cart_sub(ompi_communicator_t *comm,
const int *remain_dims,
ompi_communicator_t **new_comm);
OMPI_DECLSPEC int
mca_topo_base_graphdims_get(ompi_communicator_t *comm,
int *nodes,
int *nedges);
OMPI_DECLSPEC int
mca_topo_base_graph_create(mca_topo_base_module_t *topo_module,
ompi_communicator_t* old_comm,
int nnodes,
const int *index,
const int *edges,
bool reorder,
ompi_communicator_t** new_comm);
OMPI_DECLSPEC int
mca_topo_base_graph_get(ompi_communicator_t *comm,
int maxindex,
int maxedges,
int *index,
int *edges);
OMPI_DECLSPEC int
mca_topo_base_graph_map(ompi_communicator_t * comm,
int nnodes,
const int *index, const int *edges, int *newrank);
OMPI_DECLSPEC int
mca_topo_base_graph_neighbors(ompi_communicator_t *comm,
int rank,
int maxneighbors,
int *neighbors);
OMPI_DECLSPEC int
mca_topo_base_graph_neighbors_count(ompi_communicator_t *comm,
int rank,
int *nneighbors);
/**
* Efficiently distribute the information about the distributed graph as
* submitted through the distributed graph interface.
*/
OMPI_DECLSPEC int
mca_topo_base_dist_graph_distribute(mca_topo_base_module_t* module,
ompi_communicator_t *comm,
int n, const int nodes[],
const int degrees[], const int targets[],
const int weights[],
mca_topo_base_comm_dist_graph_2_2_0_t** ptopo);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_create(mca_topo_base_module_t* module,
ompi_communicator_t *old_comm,
int n, const int nodes[],
const int degrees[], const int targets[], const int weights[],
opal_info_t *info, int reorder,
ompi_communicator_t **new_comm);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_create_adjacent(mca_topo_base_module_t* module,
ompi_communicator_t *old_comm,
int indegree, const int sources[],
const int sourceweights[], int outdegree,
const int destinations[], const int destweights[],
opal_info_t *info, int reorder,
ompi_communicator_t **comm_dist_graph);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_neighbors(ompi_communicator_t *comm,
int maxindegree,
int sources[], int sourceweights[],
int maxoutdegree, int destinations[],
int destweights[]);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_neighbors_count(ompi_communicator_t *comm,
int *inneighbors, int *outneighbors, int *weighted);
int mca_topo_base_neighbor_count (ompi_communicator_t *comm, int *indegree, int *outdegree);
END_C_DECLS
#endif /* MCA_BASE_TOPO_H */
|