Lockless Inc

NAME

MPI_Recv - Perform a blocking receive into a buffer

SYNOPSIS

#include <mpi.h> int MPI_Recv(void *buf , int count , MPI_Datatype datatype , int source , int tag , MPI_Comm comm , MPI_Status *status );

#include <pmpi.h> int PMPI_Recv(void *buf , int count , MPI_Datatype datatype , int source , int tag , MPI_Comm comm , MPI_Status *status );

#include <mpi.h> void MPI::Comm::Recv(void *buf , int count , const MPI::Datatype &datatype , int source , int tag , MPI::Status &status ) const;

INCLUDE 'mpif.h' MPI_RECV(buf , count , datatype , source , tag , comm , status , ierr ) <type> buf (*) INTEGER count , datatype , source , tag , comm , status (MPI_STATUS_SIZE), ierr

INPUT PARAMETERS

count - count of elements in buffer (integer)

datatype - type of elements in buffer (handle)

source - source rank (integer)

tag - communication tag (integer)

comm - communicator for message (handle)

OUTPUT PARAMETERS

buf - buffer (array)

status - status of the communication (structure)

DESCRIPTION

The MPI_Recv() function is used to receive a message. This function will wait until a matching message is posted by a function similar to MPI_Send(). If a message matches the required source , tag , and communicator, comm , then it will be copied into the buffer buf . If the message is larger than the buffer, it will be truncated and the MPI_ERROR field of status will be set to MPI_ERR_TRUNCATE. The datatype and count determine exactly how the message is interpreted. Note that for performance reasons this MPI library does not check that the sent and received datatypes match.

If tag is MPI_ANY_TAG then any tag will match. Similarly, if source is MPI_ANY_SOURCE then so will a message from any source. The original tag and source are stored in the MPI_TAG and MPI_SOURCE fields of status respectively. One additional field, status->size holds the total size of the message in bytes.

The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Recv() is the profiling version of this function.

If the source is MPI_PROC_NULL then no receive is posted, and MPI_SUCCESS is returned. In this case, status is filled with MPI_ANY_TAG MPI_PROC_NULL MPI_SUCCESS and zero size in bytes.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_COUNT - Invalid element count;

MPI_ERR_BUFFER - Invalid buffer;

MPI_ERR_TAG - Invalid tag;

MPI_ERR_TYPE - Invalid data type;

MPI_ERR_RANK - Invalid destination.

SEE ALSO

MPI_Send (3) MPI_Irecv (3) MPI_Recv_init (3) MPI_Sendrecv (3) MPI_Sendrecv_replace (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.