.TH MPI_Grequest_start 3 "11/12/2019" " " "MPI"
.SH NAME
MPI_Grequest_start \-  Create and return a user-defined request 
.SH SYNOPSIS
.nf
int MPI_Grequest_start(MPI_Grequest_query_function * query_fn,
MPI_Grequest_free_function * free_fn,
MPI_Grequest_cancel_function * cancel_fn,
void *extra_state, MPI_Request * request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B query_fn 
- callback function invoked when request status is queried (function)
.PD 1
.PD 0
.TP
.B free_fn 
- callback function invoked when request is freed (function)
.PD 1
.PD 0
.TP
.B cancel_fn 
- callback function invoked when request is cancelled (function)
.PD 1
.PD 0
.TP
.B extra_state 
- Extra state passed to the above functions.
.PD 1

.SH OUTPUT PARAMETERS
.PD 0
.TP
.B request 
- Generalized request (handle)
.PD 1

.SH NOTES ON THE CALLBACK FUNCTIONS
The return values from the callback functions must be a valid MPI error code
or class.  This value may either be the return value from any MPI routine
(with one exception noted below) or any of the MPI error classes.
For portable programs, 
.I MPI_ERR_OTHER
may be used; to provide more
specific information, create a new MPI error class or code with
.I MPI_Add_error_class
or 
.I MPI_Add_error_code
and return that value.

The MPI standard is not clear on the return values from the callback routines.
However, there are notes in the standard that imply that these are MPI error
codes.  For example, pages 169 line 46 through page 170, line 1 require that
the 
.I free_fn
return an MPI error code that may be used in the MPI completion
functions when they return 
.I MPI_ERR_IN_STATUS
\&.


The one special case is the error value returned by 
.I MPI_Comm_dup
when
the attribute callback routine returns a failure.  The MPI standard is not
clear on what values may be used to indicate an error return.  Further,
the Intel MPI test suite made use of non-zero values to indicate failure,
and expected these values to be returned by the 
.I MPI_Comm_dup
when the
attribute routines encountered an error.  Such error values may not be valid
MPI error codes or classes.  Because of this, it is the user's responsibility
to either use valid MPI error codes in return from the attribute callbacks,
if those error codes are to be returned by a generalized request callback,
or to detect and convert those error codes to valid MPI error codes (recall
that MPI error classes are valid error codes).

.SH 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 
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.

.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for 
.I MPI_WTIME
and 
.I MPI_WTICK
) have
an additional argument 
.I ierr
at the end of the argument list.  
.I 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
.I call
statement.

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

.SH ERRORS

All MPI routines (except 
.I MPI_Wtime
and 
.I 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 
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and 
.I MPI_Win_set_errhandler
(for
RMA windows).  The MPI-1 routine 
.I MPI_Errhandler_set
may be used but
its use is deprecated.  The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does 
.B not
guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.

.PD 0
.TP
.B MPI_SUCCESS 
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG 
- Invalid argument.  Some argument is invalid and is not
identified by a specific error class (e.g., 
.I MPI_ERR_RANK
).
.PD 1