Synopsis

int MPI_Gather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
               void *recvbuf, int recvcount, MPI_Datatype recvtype, int root,
               MPI_Comm comm)
int MPI_Gather_c(const void *sendbuf, MPI_Count sendcount,
                 MPI_Datatype sendtype, void *recvbuf, MPI_Count recvcount,
                 MPI_Datatype recvtype, int root, MPI_Comm comm)

Input Parameters

sendbuf

starting address of send buffer (choice)

sendcount

number of elements in send buffer (non-negative integer)

sendtype

data type of send buffer elements (handle)

recvcount

number of elements for any single receive (non-negative integer)

recvtype

data type of recv buffer elements (handle)

root

rank of receiving process (integer)

comm

communicator (handle)

Output Parameters

recvbuf

address of receive buffer (choice)

Description

MPI_Gather is a collective operation where each process sends the contents of its send buffer to the root, which receives the messages and stores them in rank order.

If comm is an intra-communicator, all processes including the root send data, and the root receives from all group members. If comm is an inter-communicator, all processes in the inter-communicator participate, with one group defining the root; processes in the other group pass the rank of the root, the root passes MPI_ROOT, and other processes in the root’s group pass MPI_PROC_NULL. The type signature of sendcount and sendtype on each process must equal the type signature of recvcount and recvtype at the root. The receive buffer is ignored for all nonroot processes. On the root, specifying counts and types that cause any location to be written more than once is erroneous. The MPI_IN_PLACE option for intra-communicators is specified by passing MPI_IN_PLACE as sendbuf at the root, in which case sendcount and sendtype are ignored and the root’s contribution is assumed to be in the correct place in the receive buffer. In multithreaded implementations, users must ensure the same communicator is not used concurrently by two different collective communication initialization calls at the same process.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_BUFFER - Invalid buffer pointer. Usually a null buffer where one is not valid.

  • MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').

  • MPI_ERR_COUNT - Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.

  • MPI_ERR_TYPE - Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see 'MPI_Type_commit') is used in a communication call.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.