Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
MPI_Comm_spawn(3)		      MPI		     MPI_Comm_spawn(3)

NAME
       MPI_Comm_spawn -	 Spawn up to maxprocs instances	of a single MPI	appli-
       cation

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  (in-
	      teger)
       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)

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 com-
       municators),  MPI_File_set_errhandler  (for files), and MPI_Win_set_er-
       rhandler	(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	 when-
       ever possible.

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.
       MPI_ERR_ARG
	      -	Invalid	argument.  Some	argument is invalid and	is not identi-
	      fied by a	specific error class (e.g., MPI_ERR_RANK ).
       MPI_ERR_COMM
	      -	 Invalid communicator.	A common error is to use a null	commu-
	      nicator 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.

				   2/3/2025		     MPI_Comm_spawn(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Comm_spawn&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help