Synopsis

int MPI_Comm_spawn(const char *command, char *argv[], int maxprocs,
                   MPI_Info info, int root, MPI_Comm comm, MPI_Comm *intercomm,
                   int array_of_errcodes[])

Input Parameters

command

name of program to be spawned (string)

argv

arguments to command (array of strings)

maxprocs

maximum number of processes to start (integer)

info

a set of key-value pairs telling the runtime system where and how to start the processes (handle)

root

rank of process in which previous arguments are examined (integer)

comm

intra-communicator containing group of spawning processes (handle)

Output Parameters

intercomm

inter-communicator between original group and the newly spawned group (handle)

array_of_errcodes

one code per process (array of integer)

Description

MPI_Comm_spawn starts MPI processes and establishes communication with them, returning an inter-communicator.

This function is collective over comm and may not return until MPI_INIT has been called in the children. MPI_INIT in the children may not return until all parents have called MPI_Comm_spawn, forming a collective operation over the union of parent and child processes. The spawned children have their own MPI_COMM_WORLD, which is separate from that of the parents. The returned inter-communicator contains parent processes in the local group and child processes in the remote group. If MPI is unable to spawn maxprocs processes, it raises an error of class MPI_ERR_SPAWN. An implementation may allow the info argument with the soft key to spawn a smaller number of processes instead of raising an error; the number of spawned processes is given by the size of the remote group of intercomm. Processes spawned at the same time using MPI_COMM_SPAWN_MULTIPLE are placed in the same MPI_COMM_WORLD. The constant MPI_ERRCODES_IGNORE may be passed in array_of_errcodes if error codes are not needed.

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_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').

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