Upgrade macos
This commit is contained in:
Bassem Girgis
@@ -1,71 +1,188 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Errhandler_create 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Errhandler_create \fP \- Creates an MPI-style error handler -- use of this routine is deprecated.
|
||||
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "MPI_ERRHANDLER_CREATE" "3" "Feb 14, 2025" "" "Open MPI"
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.sp
|
||||
\fI\%MPI_Errhandler_create\fP — Creates an MPI\-style error handler — this routine is deprecated in favor of \fI\%MPI_Comm_create_errhandler\fP\&.
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.SH C Syntax
|
||||
.SS C Syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#include <mpi.h>
|
||||
int MPI_Errhandler_create(MPI_Handler_function *\fIfunction\fP,
|
||||
MPI_Errhandler *\fIerrhandler\fP)
|
||||
|
||||
int MPI_Errhandler_create(MPI_Handler_function *function,
|
||||
MPI_Errhandler *errhandler)
|
||||
.ft P
|
||||
.fi
|
||||
.SH INPUT PARAMETER
|
||||
.ft R
|
||||
.TP 1i
|
||||
function
|
||||
User-defined error handling procedure.
|
||||
|
||||
.SH OUTPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
errhandler
|
||||
MPI error handler (handle).
|
||||
.ft R
|
||||
.TP 1i
|
||||
IERROR
|
||||
Fortran only: Error status (integer).
|
||||
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_create_errhandler instead.
|
||||
.sp
|
||||
This deprecated routine is not available in C++.
|
||||
.sp
|
||||
Registers the user routine function for use as an MPI exception handler. Returns in errhandler a handle to the registered exception handler.
|
||||
.sp
|
||||
In the C language, the user routine should be a C function of type MPI_Handler_function, which is defined as
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Fortran Syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
typedef void (MPI_Handler_function)(MPI_Comm *, int *, \&...);
|
||||
.ft C
|
||||
USE MPI
|
||||
! or the older form: INCLUDE \(aqmpif.h\(aq
|
||||
|
||||
MPI_ERRHANDLER_CREATE(FUNCTION, ERRHANDLER, IERROR)
|
||||
EXTERNAL FUNCTION
|
||||
INTEGER ERRHANDLER, IERROR
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH INPUT PARAMETER
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBfunction\fP: User\-defined error handling procedure.
|
||||
.UNINDENT
|
||||
.SH OUTPUT PARAMETERS
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBerrhandler\fP: MPI error handler (handle).
|
||||
.IP \(bu 2
|
||||
\fBierror\fP: Fortran only: Error status (integer).
|
||||
.UNINDENT
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The first argument is the communicator in use. The second is the error code
|
||||
to be returned by the MPI routine that raised the error. If the routine would have returned MPI_ERR_IN_STATUS, it is the error code returned in the status for the request that caused the error handler to be invoked. The remaining arguments are stdargs arguments whose number and meaning is implementation-dependent. An implementation should clearly document these arguments. Addresses are used so that the handler may be written in Fortran.
|
||||
|
||||
Note that use of this routine is \fIdeprecated\fP as of MPI\-2. Please use
|
||||
\fI\%MPI_Comm_create_errhandler\fP instead.
|
||||
.sp
|
||||
Registers the user routine function for use as an MPI error handler.
|
||||
Returns in errhandler a handle to the registered error handler.
|
||||
.sp
|
||||
In the C language, the user routine should be a C function of type
|
||||
MPI_Handler_function, which is defined as
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
typedef void (MPI_Handler_function)(MPI_Comm *, int *, ...);
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The first argument is the communicator in use. The second is the error
|
||||
code to be returned by the MPI routine that raised the error. If the
|
||||
routine would have returned MPI_ERR_IN_STATUS, it is the error code
|
||||
returned in the status for the request that caused the error handler to
|
||||
be invoked. The remaining arguments are stdargs arguments whose number
|
||||
and meaning is implementation\-dependent. An implementation should
|
||||
clearly document these arguments. Addresses are used so that the handler
|
||||
may be written in Fortran.
|
||||
.SH NOTE
|
||||
.ft R
|
||||
The MPI-1 Standard states that an implementation may make the output value (errhandler) simply the address of the function. However, the action of MPI_Errhandler_ free makes this impossible, since it is required to set the value of the argument to MPI_ERRHANDLER_NULL. In addition, the actual error handler must remain until all communicators that use it are freed.
|
||||
|
||||
.SH 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++ functions 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.
|
||||
.sp
|
||||
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.
|
||||
|
||||
.SH SEE ALSO
|
||||
.br
|
||||
MPI_Comm_create_errhandler
|
||||
.br
|
||||
MPI_Comm_get_errhandler
|
||||
.br
|
||||
MPI_Comm_set_errhandler
|
||||
|
||||
|
||||
|
||||
The \fI\%MPI Standard\fP states that an
|
||||
implementation may make the output
|
||||
value (errhandler) simply the address of the function. However, the
|
||||
action of \fI\%MPI_Errhandler_free\fP makes this impossible, since it is
|
||||
required to set the value of the argument to \fBMPI_ERRHANDLER_NULL\fP\&. In
|
||||
addition, the actual error handler must remain until all communicators
|
||||
that use it are freed.
|
||||
.SH ERRORS
|
||||
.sp
|
||||
Almost all MPI routines return an error value; C routines as the return result
|
||||
of the function and Fortran routines in the last argument.
|
||||
.sp
|
||||
Before the error value is returned, the current MPI error handler associated
|
||||
with the communication object (e.g., communicator, window, file) is called.
|
||||
If no communication object is associated with the MPI call, then the call is
|
||||
considered attached to MPI_COMM_SELF and will call the associated MPI error
|
||||
handler. When MPI_COMM_SELF is not initialized (i.e., before
|
||||
\fI\%MPI_Init\fP/\fI\%MPI_Init_thread\fP, after \fI\%MPI_Finalize\fP, or when using the Sessions
|
||||
Model exclusively) the error raises the initial error handler. The initial
|
||||
error handler can be changed by calling \fI\%MPI_Comm_set_errhandler\fP on
|
||||
MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI
|
||||
argument to mpiexec or info key to \fI\%MPI_Comm_spawn\fP/\fI\%MPI_Comm_spawn_multiple\fP\&.
|
||||
If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
|
||||
error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error
|
||||
handler is called for all other MPI functions.
|
||||
.sp
|
||||
Open MPI includes three predefined error handlers that can be used:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_ARE_FATAL\fP
|
||||
Causes the program to abort all connected MPI processes.
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_ABORT\fP
|
||||
An error handler that can be invoked on a communicator,
|
||||
window, file, or session. When called on a communicator, it
|
||||
acts as if \fI\%MPI_Abort\fP was called on that communicator. If
|
||||
called on a window or file, acts as if \fI\%MPI_Abort\fP was called
|
||||
on a communicator containing the group of processes in the
|
||||
corresponding window or file. If called on a session,
|
||||
aborts only the local process.
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_RETURN\fP
|
||||
Returns an error code to the application.
|
||||
.UNINDENT
|
||||
.sp
|
||||
MPI applications can also implement their own error handlers by calling:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Comm_create_errhandler\fP then \fI\%MPI_Comm_set_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_File_create_errhandler\fP then \fI\%MPI_File_set_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Session_create_errhandler\fP then \fI\%MPI_Session_set_errhandler\fP or at \fI\%MPI_Session_init\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Win_create_errhandler\fP then \fI\%MPI_Win_set_errhandler\fP
|
||||
.UNINDENT
|
||||
.sp
|
||||
Note that MPI does not guarantee that an MPI program can continue past
|
||||
an error.
|
||||
.sp
|
||||
See the \fI\%MPI man page\fP for a full list of \fI\%MPI error codes\fP\&.
|
||||
.sp
|
||||
See the Error Handling section of the MPI\-3.1 standard for
|
||||
more information.
|
||||
.sp
|
||||
\fBSEE ALSO:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Comm_create_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Comm_get_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Comm_set_errhandler\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COPYRIGHT
|
||||
2003-2025, The Open MPI Community
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
|
||||
Reference in New Issue
Block a user