184 строки
7.0 KiB
C
184 строки
7.0 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 **/
|
|
|
|
#ifndef MCA_OMPI_MODULE_EXCHANGE_H
|
|
#define MCA_OMPI_MODULE_EXCHANGE_H
|
|
|
|
#include "ompi_config.h"
|
|
|
|
#ifdef HAVE_SYS_TYPES_H
|
|
#include <sys/types.h>
|
|
#endif
|
|
|
|
#include "opal/mca/mca.h"
|
|
|
|
struct ompi_proc_t;
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
/**
|
|
* Send a module-specific buffer to all other corresponding MCA
|
|
* modules in peer processes.
|
|
*
|
|
* @param source_component A pointer to this module's component
|
|
* structure (i.e., mca_base_component_t)
|
|
* @param buffer A pointer to the beginning of the buffer to send.
|
|
* @param size Number of bytes of each instance in the buffer.
|
|
* @param count Number of instances in the buffer.
|
|
*
|
|
* @retval OMPI_SUCCESS On success
|
|
* @retval OMPI_ERROR On failure
|
|
*
|
|
* This function takes a contiguous buffer of network-ordered data
|
|
* and makes it available to all other MCA processes during the
|
|
* selection process. Modules sent by one source_component can only
|
|
* be received by a corresponding module with the same
|
|
* source_componennt in peer processes.
|
|
*
|
|
* Two components are "corresponding" if:
|
|
*
|
|
* - they share the same major and minor MCA version number
|
|
* - they have the same type name string
|
|
* - they share the same major and minor type version number
|
|
* - they have the same component name string
|
|
* - they share the same major and minor component version number
|
|
*
|
|
* This function is indended to be used during MCA module
|
|
* initialization \em before \em selection (the selection process is
|
|
* defined differently for each component type). Each module will
|
|
* provide a buffer containing meta information and/or parameters
|
|
* that it wants to share with its corresponding modules in peer
|
|
* processes. This information typically contains location /
|
|
* contact information for establishing communication between
|
|
* processes (in a manner that is specific to that module). For
|
|
* example, a TCP-based module could provide its IP address and TCP
|
|
* port where it is waiting on listen(). The peer process receiving
|
|
* this buffer can therefore open a socket to the indicated IP
|
|
* address and TCP port.
|
|
*
|
|
* During the selection process, the MCA framework will effectively
|
|
* perform an "allgather" operation of all modex buffers; every
|
|
* buffer will be available to every peer process (see
|
|
* mca_pml_base_modex_recv()).
|
|
*
|
|
* Note that the buffer should not be modified after invoking this
|
|
* fuction; the MCA framework may asynchronously send it to a
|
|
* process peer at any time.
|
|
*
|
|
* Note again that the buffer contents is transparent to the MCA
|
|
* framework -- it \em must already either be in network order or be
|
|
* in some format that peer processes will be able to read it,
|
|
* regardless of pointer sizes or endian bias.
|
|
*/
|
|
OMPI_DECLSPEC int mca_pml_base_modex_send(mca_base_component_t *source_component,
|
|
const void *buffer, size_t size);
|
|
|
|
/**
|
|
* Receive a module-specific buffer from a corresponding MCA module
|
|
* in a specific peer process.
|
|
*
|
|
* @param dest_component A pointer to this module's component struct
|
|
* (i.e., mca_base_component_t instance).
|
|
* @param source_proc Peer process to receive from.
|
|
* @param buffer A pointer to a (void*) that will be filled with a
|
|
* pointer to the received buffer.
|
|
* @param size Pointer to a size_t that will be filled with the
|
|
* number of bytes of each instance in the buffer.
|
|
* @param count Pointer to an int that will be filled with the
|
|
* number of instances in the buffer.
|
|
*
|
|
* @retval OMPI_SUCCESS If a corresponding module buffer is found and
|
|
* is successfully returned to the caller.
|
|
* @retval OMPI_ERR_OUT_OF_RESOURCE If no corresponding module buffer is found,
|
|
* or if an error occurs wil returning the buffer to the caller.
|
|
*
|
|
* This is the corresponding "get" call to mca_pml_base_modex_send().
|
|
* After selection, modules can call this function to receive the
|
|
* buffer sent by their corresponding module on the process
|
|
* source_proc.
|
|
*
|
|
* If a buffer from a corresponding module is found, buffer will be
|
|
* filled with a pointer to a copy of the buffer that was sent by
|
|
* the peer process. It is the caller's responsibility to free this
|
|
* buffer. size will be filled in with the number of instances in
|
|
* the buffer, and count will be filled in with the number of
|
|
* instances. The total number of bytes in the buffer is (size *
|
|
* count). See the explanation in mca_pml_base_modex_send() for why the
|
|
* number of bytes is split into two parts.
|
|
*/
|
|
OMPI_DECLSPEC int mca_pml_base_modex_recv(mca_base_component_t *dest_component,
|
|
struct ompi_proc_t *source_proc,
|
|
void **buffer, size_t *size);
|
|
|
|
/**
|
|
* Register to receive a callback on change to module specific data.
|
|
*
|
|
* @param dest_component A pointer to this module's component struct
|
|
* (i.e., mca_base_component_t instance).
|
|
* @param source_proc Peer process to receive from.
|
|
* @param buffer A pointer to a (void*) that will be filled with a
|
|
* pointer to the received buffer.
|
|
* @param size Pointer to a size_t that will be filled with the
|
|
* number of bytes of each instance in the buffer.
|
|
* @param count Pointer to an int that will be filled with the
|
|
* number of instances in the buffer.
|
|
*
|
|
* @retval OMPI_SUCCESS If a corresponding module buffer is found and
|
|
* is successfully returned to the caller.
|
|
* @retval OMPI_ERR_OUT_OF_RESOURCE If no corresponding module buffer is found,
|
|
* or if an error occurs wil returning the buffer to the caller.
|
|
*
|
|
*/
|
|
|
|
typedef void (*mca_pml_base_modex_cb_fn_t)(
|
|
mca_base_component_t *component,
|
|
struct ompi_proc_t* proc,
|
|
void* buffer,
|
|
size_t size,
|
|
void* cbdata);
|
|
|
|
OMPI_DECLSPEC int mca_pml_base_modex_recv_nb(
|
|
mca_base_component_t *component,
|
|
struct ompi_proc_t* proc,
|
|
mca_pml_base_modex_cb_fn_t cbfunc,
|
|
void* cbdata);
|
|
|
|
/*
|
|
* Called to subscribe to registry.
|
|
*/
|
|
OMPI_DECLSPEC int mca_pml_base_modex_exchange(void);
|
|
|
|
/**
|
|
*
|
|
*/
|
|
OMPI_DECLSPEC int mca_pml_base_modex_init(void);
|
|
|
|
/**
|
|
*
|
|
*/
|
|
OMPI_DECLSPEC int mca_pml_base_modex_finalize(void);
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* MCA_OMPI_MODULE_EXCHANGE_H */
|