-
Notifications
You must be signed in to change notification settings - Fork 900
sessions: add missing errhandler funcs #10442
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
.. _mpi_session_call_errhandler: | ||
|
||
MPI_Session_call_errhandler | ||
=========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Session_call_errhandler` - Passes the supplied error code to the error | ||
handler assigned to a session | ||
|
||
Syntax | ||
------ | ||
|
||
C Syntax | ||
^^^^^^^^ | ||
|
||
.. code:: c | ||
|
||
#include <mpi.h> | ||
|
||
int MPI_Session_call_errhandler(MPI_Session session, int errorcode) | ||
|
||
Fortran Syntax | ||
^^^^^^^^^^^^^^ | ||
|
||
.. code:: Fortran | ||
|
||
USE MPI | ||
! or the older form: INCLUDE 'mpif.h' | ||
|
||
MPI_SESSION_CALL_ERRHANDLER(SESSION, ERRORCODE, IERROR) | ||
INTEGER SESSION, ERRORCODE, IERROR | ||
|
||
Fortran 2008 Syntax | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code:: Fortran | ||
|
||
USE mpi_f08 | ||
|
||
MPI_Session_call_errhandler(session, errorcode, ierror) | ||
TYPE(MPI_Session), INTENT(IN) :: session | ||
INTEGER, INTENT(IN) :: errorcode | ||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror | ||
|
||
Input Parameter | ||
--------------- | ||
|
||
- session : session with error handler (handle). | ||
- errorcode : error code (integer). | ||
|
||
Output Parameters | ||
----------------- | ||
|
||
- IERROR : Fortran only: Error status (integer). | ||
|
||
Description | ||
----------- | ||
|
||
This function invokes the error handler assigned to the session | ||
session with the supplied error code errorcode. If the error handler was | ||
successfully called, the process is not aborted, and the error handler | ||
returns, this function returns MPI_SUCCESS. | ||
|
||
Notes | ||
----- | ||
|
||
Users should note that the default error handler is | ||
MPI_ERRORS_ARE_FATAL. Thus, calling this function will abort the | ||
processes in session if the default error handler has not been changed. | ||
|
||
Errors | ||
------ | ||
|
||
Almost all MPI routines return an error value; C routines as the value | ||
of the function and Fortran routines in the last argument. See the MPI | ||
man page for a full list of MPI error codes. | ||
|
||
|
||
.. seealso:: :ref:`MPI_Session_create_errhandler` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
.. _mpi_session_get_errhandler: | ||
|
||
|
||
MPI_Session_get_errhandler | ||
========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Session_get_errhandler` - Retrieves error handler associated with a | ||
session. | ||
|
||
|
||
SYNTAX | ||
------ | ||
|
||
|
||
C Syntax | ||
^^^^^^^^ | ||
|
||
.. code-block:: c | ||
|
||
#include <mpi.h> | ||
|
||
int MPI_Session_get_errhandler(MPI_Session session, | ||
MPI_Errhandler *errhandler) | ||
|
||
|
||
Fortran Syntax | ||
^^^^^^^^^^^^^^ | ||
|
||
.. code-block:: fortran | ||
|
||
USE MPI | ||
! or the older form: INCLUDE 'mpif.h' | ||
MPI_SESSION_GET_ERRHANDLER(SESSION, ERRHANDLER, IERROR) | ||
INTEGER SESSION, ERRHANDLER, IERROR | ||
|
||
|
||
Fortran 2008 Syntax | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code-block:: fortran | ||
|
||
USE mpi_f08 | ||
MPI_Session_get_errhandler(session, errhandler, ierror) | ||
TYPE(MPI_Session), INTENT(IN) :: session | ||
TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler | ||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror | ||
|
||
|
||
INPUT PARAMETER | ||
--------------- | ||
* ``session``: Session (handle). | ||
|
||
OUTPUT PARAMETERS | ||
----------------- | ||
* ``errhandler``: New error handler for session (handle). | ||
* ``IERROR``: Fortran only: Error status (integer). | ||
|
||
DESCRIPTION | ||
----------- | ||
|
||
:ref:`MPI_Session_get_errhandler` retrieves the error handler currently associated | ||
with a session. | ||
|
||
|
||
ERRORS | ||
------ | ||
|
||
Almost all MPI routines return an error value; C routines as the value | ||
of the function and Fortran routines in the last argument. | ||
|
||
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 | ||
:ref:`MPI_Session_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 the MPI man page for a full list of MPI error codes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
.. _mpi_session_set_errhandler: | ||
|
||
|
||
MPI_Session_set_errhandler | ||
========================== | ||
|
||
.. include_body | ||
|
||
:ref:`MPI_Session_set_errhandler` - Attaches a new error handler to a | ||
session. | ||
|
||
|
||
SYNTAX | ||
------ | ||
|
||
|
||
C Syntax | ||
^^^^^^^^ | ||
|
||
.. code-block:: c | ||
|
||
#include <mpi.h> | ||
|
||
int MPI_Session_set_errhandler(MPI_Session session, | ||
MPI_Errhandler errhandler) | ||
|
||
|
||
Fortran Syntax | ||
^^^^^^^^^^^^^^ | ||
|
||
.. code-block:: fortran | ||
|
||
USE MPI | ||
! or the older form: INCLUDE 'mpif.h' | ||
MPI_SESSION_SET_ERRHANDLER(SESSION, ERRHANDLER, IERROR) | ||
INTEGER SESSION, ERRHANDLER, IERROR | ||
|
||
|
||
Fortran 2008 Syntax | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. code-block:: fortran | ||
|
||
USE mpi_f08 | ||
MPI_Session_set_errhandler(session, errhandler, ierror) | ||
TYPE(MPI_Session), INTENT(IN) :: session | ||
TYPE(MPI_Errhandler), INTENT(IN) :: errhandler | ||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror | ||
|
||
|
||
INPUT/OUTPUT PARAMETER | ||
---------------------- | ||
* ``session``: Session (handle). | ||
|
||
OUTPUT PARAMETERS | ||
----------------- | ||
* ``errhandler``: New error handler for session (handle). | ||
* ``IERROR``: Fortran only: Error status (integer). | ||
|
||
DESCRIPTION | ||
----------- | ||
|
||
:ref:`MPI_Session_set_errhandler` attaches a new error handler to a session. | ||
The error handler must be either a predefined error handler or an error | ||
handler created by a call to :ref:`MPI_Session_create_errhandler`. | ||
|
||
|
||
ERRORS | ||
------ | ||
|
||
Almost all MPI routines return an error value; C routines as the value | ||
of the function and Fortran routines in the last argument. | ||
|
||
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 | ||
:ref:`MPI_Session_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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change already came in #10499 - maybe the branch needs to be rebased?