20c772e733
MPI-4 is finally cleaning up its language: an MPI "exception" does not actually exist. The only thing that exists is an MPI "error" (and associated handlers). This commit replaces all relevant uses of the word "exception" with "error". Note that this is still applicable in versions of the MPI standard less than MPI-4.0 (indeed, nearly all the cases fixed in this commit are just changes to comments, anyway). One exception to this is the Java bindings, where there's an MPIException class. In hindsight, it probably should have been named MPIError, but changing it now would break anyone who is using the Java bindings. Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
90 строки
2.8 KiB
Plaintext
90 строки
2.8 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
|
.\" Copyright 2009-2010 Cisco Systems, Inc. All rights reserved.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_File_create_errhandler 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_File_create_errhandler \fP \- Creates an MPI-style error handler that can be attached to a file.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_File_create_errhandler(MPI_File_errhandler_function \fI*function\fP,
|
|
MPI_Errhandler \fI*errhandler\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_FILE_CREATE_ERRHANDLER(\fIFUNCTION, ERRHANDLER, IERROR\fP)
|
|
EXTERNAL \fIFUNCTION\fP
|
|
INTEGER \fIERRHANDLER, IERROR\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_File_create_errhandler(\fIfile_errhandler_fn\fP, \fIerrhandler\fP, \fIierror\fP)
|
|
PROCEDURE(MPI_File_errhandler_function) :: \fIfile_errhandler_fn\fP
|
|
TYPE(MPI_Errhandler), INTENT(OUT) :: \fIerrhandler\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH DEPRECATED TYPE NAME NOTE
|
|
.ft R
|
|
MPI-2.2 deprecated the MPI_File_errhandler_fn and
|
|
MPI::file::Errhandler_fn types in favor of
|
|
MPI_File_errhandler_function and MPI::File::Errhandler_function,
|
|
respectively. Open MPI supports both names (indeed, the _fn names are
|
|
typedefs to the _function names).
|
|
|
|
.SH INPUT PARAMETER
|
|
.ft R
|
|
.TP 1i
|
|
function
|
|
User-defined error handling procedure (function).
|
|
|
|
.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
|
|
Registers the user routine \fIfunction\fP 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 \fIfunction\fP should be a C function of type MPI_File_errhandler_function, which is defined as
|
|
.sp
|
|
.nf
|
|
typedef void (MPI_File_errhandler_function)(MPI_File *, int *,
|
|
\&...);
|
|
.fi
|
|
.sp
|
|
The first argument to \fIfunction\fP is the file in use. The second is the error code
|
|
to be returned by the MPI routine that raised the error.
|
|
.sp
|
|
In the Fortran language, the user routine should be of the form:
|
|
.sp
|
|
.nf
|
|
SUBROUTINE FILE_ERRHANDLER_FUNCTION(FILE, ERROR_CODE, ...)
|
|
INTEGER FILE, ERROR_CODE
|
|
.fi
|
|
|
|
.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.
|
|
.sp
|
|
Before the error value is returned, the current MPI error handler is
|
|
called. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.
|
|
|
|
|