Synopsis

int MPI_Alltoallv_init(const void *sendbuf, const int sendcounts[],
                       const int sdispls[], MPI_Datatype sendtype,
                       void *recvbuf, const int recvcounts[],
                       const int rdispls[], MPI_Datatype recvtype,
                       MPI_Comm comm, MPI_Info info, MPI_Request *request)
int MPI_Alltoallv_init_c(const void *sendbuf, const MPI_Count sendcounts[],
                         const MPI_Aint sdispls[], MPI_Datatype sendtype,
                         void *recvbuf, const MPI_Count recvcounts[],
                         const MPI_Aint rdispls[], MPI_Datatype recvtype,
                         MPI_Comm comm, MPI_Info info, MPI_Request *request)

Input Parameters

sendbuf

starting address of send buffer (choice)

sendcounts

non-negative integer array (of length group size) specifying the number of elements to send to each rank (non-negative integer)

sdispls

Integer array (of length group size). Entry j specifies the displacement (relative to sendbuf) from which to take the outgoing data destined for process j (integer)

sendtype

data type of send buffer elements (handle)

recvcounts

non-negative integer array (of length group size) specifying the number of elements that can be received from each rank (non-negative integer)

rdispls

integer array (of length group size). Entry i specifies the displacement (relative to recvbuf) at which to place the incoming data from process i (integer)

recvtype

data type of receive buffer elements (handle)

comm

communicator (handle)

info

info argument (handle)

Output Parameters

recvbuf

address of receive buffer (choice)

request

communication request (handle)

Description

MPI_Alltoallv_init creates a persistent collective communication request for the alltoallv operation, an All-To-All collective that performs a complete exchange with variable-sized blocks between all processes.

This initialization call is nonlocal and all processes in the group must call collective routines in the same order. The returned request is initially inactive and may be started zero or more times using MPI_START or MPI_STARTALL; once initialized, persistent collective operations may be started in any order across processes. For inter-communicators, each process in group A sends a message to each process in group B and vice versa. The MPI_IN_PLACE option for intra-communicators is specified by passing MPI_IN_PLACE to sendbuf at all processes, in which case sendcounts, sdispls, and sendtype are ignored. Persistent collective operations cannot be matched with blocking or nonblocking collective operations. Arrays associated with input arguments must not be modified until the persistent request is freed with MPI_REQUEST_FREE, and it is erroneous to use MPI_CANCEL on a persistent collective request. In multithreaded implementations, the same communicator is not to be 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_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').

  • 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_INFO - Invalid Info

  • 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.