mpi_pcontrol(3openmpi) [osx man page]

MPI_Pcontrol(3OpenMPI)													    MPI_Pcontrol(3OpenMPI)

NAME

       MPI_Pcontrol - Controls profiling.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Pcontrol(const int level, ... )

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_PCONTROL(LEVEL)
	    INTEGER   LEVEL, ...

C++ Syntax
       #include <mpi.h>
       void Pcontrol(const int level, ...)

INPUT PARAMETER

       level	 Profiling level.

DESCRIPTION

       MPI  libraries  themselves  make  no use of this routine; they simply return immediately to the user code. However the presence of calls to
       this routine allows a profiling package to be explicitly called by the user.

       Since MPI has no control of the implementation of the profiling code, we are unable to specify precisely the semantics that  will  be  pro-
       vided by calls to MPI_Pcontrol. This vagueness extends to the number of arguments to the function, and their datatypes.

       However	to provide some level of portability of user codes to different profiling libraries, we request the following meanings for certain
       values of level:

	 o    level==0	Profiling is disabled.

	 o    level==1	Profiling is enabled at a normal default level of detail.

	 o    level==2	Profile buffers are flushed. (This may be a no-op in some profilers).

	 o    All other values of level have profile library-defined effects and additional arguments.

       We also request that the default state after MPI_Init has been called is for profiling to be enabled at the normal default level (i.e.,	as
       if  MPI_Pcontrol  had  just  been called with the argument 1). This allows users to link with a profiling library and obtain profile output
       without having to modify their source code at all.

       The provision of MPI_Pcontrol as a no-op in the standard MPI library allows users to modify their source code to obtain more detailed  pro-
       filing information, but still be able to link exactly the same code against the standard MPI library.

NOTES

       This  routine provides a common interface for profiling control. The interpretation of level and any other arguments is left to the profil-
       ing library.

       This function does not return an error value. Consequently, the result of calling it before MPI_Init or after MPI_Finalize is undefined.

Open MPI 1.2							  September 2006					    MPI_Pcontrol(3OpenMPI)

Check Out this Related Man Page

MPI_Add_error_code(3OpenMPI)											      MPI_Add_error_code(3OpenMPI)

NAME

       MPI_Add_error_code - Creates a new error code associated with errorclass

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Add_error_code(int errorclass, int *errorcode)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ADD_ERROR_CODE(ERRORCLASS, ERRORCODE, IERROR)
	    INTEGER  ERRORCLASS, ERRORCODE, IERROR

C++ Syntax
       #include <mpi.h>
       int MPI::Add_error_code(int errorclass, int* errorcode)

INPUT PARAMETER

       errorclass    MPI error class (integer).

OUTPUT PARAMETERS

       errorcode     Error code returned by an MPI routine or an MPI error class (integer).

       IERROR	     Fortran only: Error status (integer).

DESCRIPTION

       Creates a new error code associated with errorclass and returns its value in errorcode.

NOTES

       No function is provided to free error codes, as it is not expected that an application will create them in significant numbers.

       The value returned is always greater than or equal to MPI_ERR_LASTCODE.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; 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.

SEE ALSO

       MPI_Add_error_class
       MPI_Error_class

Open MPI 1.2							  September 2006				      MPI_Add_error_code(3OpenMPI)

Linux and UNIX Man Pages

mpi_pcontrol(3openmpi) [osx man page]

Check Out this Related Man Page