Synopsis
int MPI_Session_get_nth_pset(MPI_Session session, MPI_Info info, int n,
int *pset_len, char *pset_name)
Input Parameters
- session
-
session (handle)
- info
-
info object (handle)
- n
-
index of the desired process set name (integer)
Input/Output Parameters
- pset_len
-
length of the pset\_name argument (integer)
Output Parameters
- pset_name
-
name of the nth process set (string)
Description
MPI_Session_get_nth_pset returns the name of the n`th process set in the supplied `pset_name buffer. If pset_len is less than the required buffer size, the returned string is truncated; if pset_len is 0, pset_name is not changed. On return, pset_len is set to the required buffer size including the null terminator in C, where a null-terminated string is returned when pset_len input is greater than 0. After a successful call, subsequent queries for the same process set name and session handle must return identical information.
If two MPI processes obtain the same process set name, the intersection of the two process sets is either the empty set or identical to the union. Process set names have a maximum length of MPI_MAX_PSET_NAME_LEN characters; users may call this function with pset_len set to 0 to obtain the required buffer size before allocating memory.
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_INFO - Invalid Info
-
MPI_ERR_SESSION - Invalid session handle
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.