MPI_Pcontrol(3)

NAME
MPI_Pcontrol - Hook for profilers

SYNOPSIS
#include <mpi.h>
int MPI_Pcontrol(const int level, ...);

#include <pmpi.h>
int PMPI_MPI_Pcontrol(const int level, ...);

#include <mpi.h>
void MPI::Pcontrol(const int level, ...);

INCLUDE 'mpif.h'
MPI_Pcontrol(level, ierr)
INTEGER level, ierr

INPUT PARAMETER
level
    - profiling level (integer)

DESCRIPTION
The MPI_Pcontrol() function is designed to be used as a convenient hook for user code to control a profiler. The profiler should override this function. The interpretation of level and any other parameters is left up to the profiling library code. PMPI_Pcontrol() is the profiling version of this function. In this implementation of MPI, nearly all FORTRAN and C++ functions are wrappers around their C equivalents. This means that a profiler just needs to override the C bindings in order to hook all languages. The C bindings are exported as weak functions to facilitate this.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception.

SEE ALSO
MPI_Init(3), MPI_Finalize(3)