|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
<HTML>
|
|
Packit |
0848f5 |
<HEAD>
|
|
Packit |
0848f5 |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit |
0848f5 |
<TITLE>MPI_T_pvar_stop</TITLE>
|
|
Packit |
0848f5 |
</HEAD>
|
|
Packit |
0848f5 |
<BODY BGCOLOR="FFFFFF">
|
|
Packit |
0848f5 |
MPI_T_pvar_stop
|
|
Packit |
0848f5 |
Stop a performance variable
|
|
Packit |
0848f5 |
Synopsis
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
int MPI_T_pvar_stop(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Input Parameters
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
session identifier of performance experiment session (handle)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
handle handle of a performance variable (handle)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Notes
|
|
Packit |
0848f5 |
This functions stops the performance variable with the handle identified by the parameter
|
|
Packit |
0848f5 |
handle in the session identified by the parameter session.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
If the constant MPI_T_PVAR_ALL_HANDLES is passed in handle, the MPI implementation
|
|
Packit |
0848f5 |
attempts to stop all variables within the session identified by the parameter session for
|
|
Packit |
0848f5 |
which handles have been allocated. In this case, the routine returns MPI_SUCCESS if all
|
|
Packit |
0848f5 |
variables are stopped successfully, otherwise MPI_T_ERR_PVAR_NO_STARTSTOP is returned.
|
|
Packit |
0848f5 |
Continuous variables and variables that are already stopped are ignored when
|
|
Packit |
0848f5 |
MPI_T_PVAR_ALL_HANDLES is specified.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Thread and Interrupt Safety
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
This routine is thread-safe. This means that this routine may be
|
|
Packit |
0848f5 |
safely used by multiple threads without the need for any user-provided
|
|
Packit |
0848f5 |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit |
0848f5 |
this is due to the use of memory allocation routines such as <tt>malloc
|
|
Packit |
0848f5 |
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Errors
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit |
0848f5 |
C routines as the value of the function and Fortran routines in the last
|
|
Packit |
0848f5 |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit |
0848f5 |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit |
0848f5 |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit |
0848f5 |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit |
0848f5 |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit |
0848f5 |
its use is deprecated. The predefined error handler
|
|
Packit |
0848f5 |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit |
0848f5 |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit |
0848f5 |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit |
0848f5 |
possible.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_SUCCESS
- No error; MPI routine completed successfully.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_T_ERR_NOT_INITIALIZED
- The MPI tool information interface is not initialized.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_T_ERR_INVALID_SESSION
- Session argument is not valid.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_T_ERR_INVALID_HANDLE
- The handle is invalid.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_T_ERR_PVAR_NO_STARTSTOP
- The performance variable can not be started or stopped.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
</BODY></HTML>
|