566a050c23
- move files out of toplevel include/ and etc/, moving it into the
sub-projects
- rather than including config headers with <project>/include,
have them as <project>
- require all headers to be included with a project prefix, with
the exception of the config headers ({opal,orte,ompi}_config.h
mpi.h, and mpif.h)
This commit was SVN r8985.
253 строки
9.5 KiB
C
253 строки
9.5 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2005 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
|
|
* MCA coll base framework public interface functions.
|
|
*
|
|
* These functions are normally invoked by the back-ends of:
|
|
*
|
|
* - The back-ends of MPI_Init() and MPI_Finalize()
|
|
* - Communuicactor constructors (e.g., MPI_Comm_split()) and
|
|
* destructors (e.g., MPI_Comm_free())
|
|
* - The laminfo command
|
|
*/
|
|
|
|
#ifndef MCA_COLL_BASE_H
|
|
#define MCA_COLL_BASE_H
|
|
|
|
#include "ompi_config.h"
|
|
|
|
#include "mpi.h"
|
|
#include "opal/class/opal_list.h"
|
|
#include "ompi/mca/coll/coll.h"
|
|
|
|
|
|
/*
|
|
* Global functions for MCA overall collective open and close
|
|
*/
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
/**
|
|
* Initialize the coll MCA framework
|
|
*
|
|
* @retval OMPI_SUCCESS Upon success
|
|
* @retval OMPI_ERROR Upon failure
|
|
*
|
|
* This must be the first function invoked in the coll MCA
|
|
* framework. It initializes the coll MCA framework, finds and
|
|
* opens coll components, etc.
|
|
*
|
|
* This function is invoked during ompi_mpi_init() and during the
|
|
* initialization of the special case of the laminfo command.
|
|
*
|
|
* This function fills in the internal global variable
|
|
* mca_coll_base_components_opened, which is a list of all coll components
|
|
* that were successfully opened. This variable should \em only be
|
|
* used by other coll base functions -- it is not considered a
|
|
* public interface member -- and is only mentioned here for
|
|
* completeness.
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_open(void);
|
|
|
|
/**
|
|
* Create list of available coll components.
|
|
*
|
|
* @param allow_multi_user_threads Will be set to true if any of the
|
|
* available components will allow multiple user threads
|
|
* @param have_hidden_threads Will be set to true if any of the
|
|
* available components have hidden threads.
|
|
*
|
|
* @retval OMPI_SUCCESS If one or more coll components are available.
|
|
* @retval OMPI_ERROR If no coll components are found to be available.
|
|
*
|
|
* This function is invoked during ompi_mpi_init() to query all
|
|
* successfully opened coll components and create a list of all
|
|
* available coll components.
|
|
*
|
|
* This function traverses the (internal global variable)
|
|
* mca_coll_base_components_opened list and queries each component to see
|
|
* if it ever might want to run during this MPI process. It creates
|
|
* another internal global variable list named
|
|
* mca_coll_base_components_available, consisting of a list of components
|
|
* that are available for selection when communicators are created.
|
|
* This variable should \em only be used by other coll base
|
|
* functions -- it is not considered a public interface member --
|
|
* and is only mentioned here for completeness.
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_find_available(bool enable_progress_threads,
|
|
bool enable_mpi_threads);
|
|
|
|
/**
|
|
* Select an available component for a new communicator.
|
|
*
|
|
* @param comm Communicator that the component will be selected for.
|
|
* @param preferred The component that is preferred for this
|
|
* communicator (or NULL).
|
|
*
|
|
* @return OMPI_SUCCESS Upon success.
|
|
* @return OMPI_ERROR Upon failure.
|
|
*
|
|
* Note that the types of the parameters have "struct" in them
|
|
* (e.g., ompi_communicator_t" vs. a plain "ompi_communicator_t") to
|
|
* avoid an include file loop. All similar types (e.g., "struct
|
|
* ompi_communicator_t *", "ompi_communicator_t *", and "MPI_Comm")
|
|
* are all typedef'ed to be the same, so the fact that we use struct
|
|
* here in the prototype is ok.
|
|
*
|
|
* This function is invoked when a new communicator is created and a
|
|
* coll component needs to be selected for it. It should be invoked
|
|
* near the end of the communicator creation process such that
|
|
* almost everything else is functional on the communicator (e.g.,
|
|
* point-to-point communication).
|
|
*
|
|
* This function invokes the selection process for coll components,
|
|
* which works as follows:
|
|
*
|
|
* - If the \em preferred argument is NULL, the selection set is
|
|
* defined to be all the components found during
|
|
* mca_coll_base_find_available().
|
|
* - If \em preferred is not NULL, then the selection set is just
|
|
* that component. (However, in this mode, we may make 2 passes
|
|
* through the selection process -- more on this below).
|
|
* - All components in the selection set are queried to see if they
|
|
* want to run with that communicator. All components that want to
|
|
* run are ranked by their priority and the highest priority
|
|
* component is selected. All non-selected components have their
|
|
* "unquery" function invoked to let them know that they were not
|
|
* selected.
|
|
* - The selected component will have its "init" function invoked to
|
|
* let it know that it was selected.
|
|
* - If we fall through this entire process and no component is
|
|
* selected \em and the \em preferred argument is not NULL, then
|
|
* run the entire process again as if the \em preferred argument
|
|
* was NULL (i.e., use the entire available set of components).
|
|
*
|
|
* At the end of this process, we'll either have a single component
|
|
* that is selected and initialized for the communicator, or no
|
|
* component was selected and an error is returned up the stack.
|
|
*
|
|
* Note that new communicators may be created as a result of
|
|
* invoking this function. Specifically: this function is called in
|
|
* the depths of communicator creation, but during the execution of
|
|
* this function, new communicators may be created, and therefore
|
|
* communicator creation functions may be re-entered (albiet with
|
|
* different arguments).
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_comm_select(struct ompi_communicator_t *comm,
|
|
struct mca_base_component_t *preferred);
|
|
|
|
/**
|
|
* Finalize a coll component on a specific communicator.
|
|
*
|
|
* @param comm The communicator that is being destroyed.
|
|
*
|
|
* @retval OMPI_SUCCESS Always.
|
|
*
|
|
* Note that the type of the parameter is only a "struct
|
|
* ompi_communicator_t" (vs. a plain "ompi_communicator_t") to avoid
|
|
* an include file loop. The types "struct ompi_communicator_t *",
|
|
* "ompi_communicator_t *", and "MPI_Comm" are all typedef'ed to be
|
|
* the same, so the fact that we use struct here in the prototype is
|
|
* ok.
|
|
*
|
|
* This function is invoked near the beginning of the destruction of
|
|
* a communicator. It finalizes the coll component associated with the
|
|
* communicator (e.g., allowing the component to clean up and free any
|
|
* resources allocated for that communicator). Note that similar to
|
|
* mca_coll_base_select(), as result of this function, other
|
|
* communicators may also be destroyed.
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_comm_unselect(struct ompi_communicator_t *comm);
|
|
|
|
/**
|
|
* Finalize the coll usage on a communicator.
|
|
*
|
|
* @param comm The communicator that is being destroyed.
|
|
*
|
|
* @retval OMPI_SUCCESS Always.
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_comm_finalize(struct ompi_communicator_t *comm);
|
|
|
|
/**
|
|
* Shut down the coll MCA framework.
|
|
*
|
|
* @retval OMPI_SUCCESS Always
|
|
*
|
|
* This function shuts down everything in the coll MCA framework,
|
|
* and is called during ompi_mpi_finalize() and the special case of
|
|
* the laminfo command.
|
|
*
|
|
* It must be the last function invoked on the coll MCA framework.
|
|
*/
|
|
OMPI_DECLSPEC int mca_coll_base_close(void);
|
|
|
|
|
|
/*
|
|
* Globals
|
|
*/
|
|
|
|
/**
|
|
* Index number from the "coll" MCA parameter, created when the coll
|
|
* framework is initialized and used during scope selection.
|
|
*/
|
|
OMPI_DECLSPEC extern int mca_coll_base_param;
|
|
/**
|
|
* Coll framework debugging stream ID used with opal_output() and
|
|
* opal_output_verbose().
|
|
*/
|
|
OMPI_DECLSPEC extern int mca_coll_base_output;
|
|
|
|
/**
|
|
* Indicator as to whether the list of opened coll components is valid or
|
|
* not.
|
|
*/
|
|
OMPI_DECLSPEC extern bool mca_coll_base_components_opened_valid;
|
|
/**
|
|
* List of all opened components; created when the coll framework is
|
|
* initialized and destroyed when we reduce the list to all available
|
|
* coll components.
|
|
*/
|
|
OMPI_DECLSPEC extern opal_list_t mca_coll_base_components_opened;
|
|
/**
|
|
* Indicator as to whether the list of available coll components is valid
|
|
* or not.
|
|
*/
|
|
OMPI_DECLSPEC extern bool mca_coll_base_components_available_valid;
|
|
/**
|
|
* List of all available components; created by reducing the list of open
|
|
* components to all those who indicate that they may run during this
|
|
* process.
|
|
*/
|
|
OMPI_DECLSPEC extern opal_list_t mca_coll_base_components_available;
|
|
|
|
/**
|
|
* Pointer to the "basic" component so that it can be found easily
|
|
* (since the "basic" component is fairly special -- it's the lowest
|
|
* common denominator between all coll components and may be used
|
|
* interchangably).
|
|
*/
|
|
OMPI_DECLSPEC extern const mca_coll_base_component_1_0_0_t *mca_coll_base_basic_component;
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
#endif /* MCA_BASE_COLL_H */
|