Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
519ddd9
man: Insert missing error classes & Fix incorrect error codes.
kawashima-fj Oct 15, 2015
4bbe86b
man: Fix a typo of an argument.
kawashima-fj Oct 15, 2015
80a0b30
man: Correct wrong argument order.
kawashima-fj Oct 15, 2015
ffce873
man: MPI_Get_version now returns 3.1 instead of 2.1.
kawashima-fj Oct 15, 2015
9b96209
man: Fix incorrect C++ binding descriptions.
kawashima-fj Oct 15, 2015
1261b11
man: Fix incorrect nroff markups.
kawashima-fj Oct 15, 2015
5a3b8b3
man: Remove outdated description. MPI-2.2 is ratified.
kawashima-fj Oct 15, 2015
953c95e
man: Update description of MPI_IN_PLACE of MPI_Exscan.
kawashima-fj Oct 16, 2015
9942d5a
man: MPI_IBARRIER has two output parameters.
kawashima-fj Oct 16, 2015
bffc7b6
man: Add man of `MPI_Message_{c2f,f2c}` and `MPI_Op_commutative`.
kawashima-fj Oct 19, 2015
2226cdb
man: Correct the routine name of `MPI_FILE_IWRITE_SHARED`.
kawashima-fj Oct 19, 2015
3253a30
man: Remove unnecessary spaces in front of parameters.
kawashima-fj Oct 19, 2015
34c3b5d
man: Correct the kind of `ADDRESS` parameter of `MPI_GET_ADDRESS`.
kawashima-fj Oct 19, 2015
dcd1410
man: Remove unnecessary spaces in Fortran syntax.
kawashima-fj Oct 19, 2015
d3a29e3
man: Change 'MPI ADDRESS KIND' to 'MPI_ADDRESS_KIND'.
kawashima-fj Oct 19, 2015
7fef70c
man: Add `MPI_DIST_GRAPH` in `MPI_TOPO_TEST` manpage.
kawashima-fj Oct 19, 2015
d9c93c9
man: Add `const` that is removed accidentally in 2226cdb.
kawashima-fj Oct 19, 2015
373a94a
man: Revert my MPI_File_iwrite_shared manpage change.
kawashima-fj Oct 20, 2015
7ab464f
Revert "man: Remove unnecessary spaces in front of parameters."
kawashima-fj Oct 20, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 122 additions & 78 deletions ompi/mpi/man/man3/MPI.3in
Original file line number Diff line number Diff line change
Expand Up @@ -66,85 +66,129 @@ For more information on Open MPI error codes, see \fImpi.h\fP in the \fIinclude\
Standard error return classes for Open MPI:
.sp
.nf
MPI_SUCCESS 0 Successful return code.
MPI_ERR_BUFFER 1 Invalid buffer pointer.
MPI_ERR_COUNT 2 Invalid count argument.
MPI_ERR_TYPE 3 Invalid datatype argument.
MPI_ERR_TAG 4 Invalid tag argument.
MPI_ERR_COMM 5 Invalid communicator.

MPI_ERR_RANK 6 Invalid rank.
MPI_ERR_REQUEST 7 Invalid MPI_Request handle.
MPI_ERR_ROOT 7 Invalid root.
MPI_ERR_GROUP 8 Null group passed to function.
MPI_ERR_OP 9 Invalid operation.
MPI_ERR_TOPOLOGY 10 Invalid topology.

MPI_ERR_DIMS 11 Illegal dimension argument.
MPI_ERR_ARG 12 Invalid argument.
MPI_ERR_UNKNOWN 13 Unknown error.
MPI_ERR_TRUNCATE 14 Message truncated on receive.
MPI_ERR_OTHER 15 Other error; use Error_string.

MPI_ERR_INTERN 16 Internal error code.
MPI_ERR_IN_STATUS 17 Look in status for error value.
MPI_ERR_PENDING 18 Pending request.
MPI_ERR_ACCESS 19 Permission denied.
MPI_ERR_AMODE 20 Unsupported amode passed to open.

MPI_ERR_ASSERT 21 Invalid assert.
MPI_ERR_BAD_FILE 22 Invalid file name (for example,
path name too long).
MPI_ERR_BASE 23 Invalid base.
MPI_ERR_CONVERSION 24 An error occurred in a user-supplied
data-conversion function.
MPI_ERR_DISP 25 Invalid displacement.

MPI_ERR_DUP_DATAREP 26 Conversion functions could not
be registered because a data
representation identifier that was
already defined was passed to
MPI_REGISTER_DATAREP.
MPI_ERR_FILE_EXISTS 27 File exists.
MPI_ERR_FILE_IN_USE 28 File operation could not be
completed, as the file is currently
open by some process.
MPI_ERR_FILE 29
MPI_ERR_INFO_KEY 30 Illegal info key.

MPI_ERR_INFO_NOKEY 31 No such key.
MPI_ERR_INFO_VALUE 32 Illegal info value.
MPI_ERR_INFO 33 Invalid info object.
MPI_ERR_IO 34 I/O error.
MPI_ERR_KEYVAL 35 Illegal key value.

MPI_ERR_LOCKTYPE 36 Invalid locktype.
MPI_ERR_NAME 37 Name not found.
MPI_ERR_NO_MEM 38 Memory exhausted.
MPI_ERR_NOT_SAME 39
MPI_ERR_NO_SPACE 40 Not enough space.

MPI_ERR_NO_SUCH_FILE 41 File (or directory) does not exist.
MPI_ERR_PORT 42 Invalid port.
MPI_ERR_QUOTA 43 Quota exceeded.
MPI_ERR_READ_ONLY 44 Read-only file system.
MPI_ERR_RMA_CONFLICT 45 Conflicting accesses to window.

MPI_ERR_RMA_SYNC 46 Erroneous RMA synchronization.
MPI_ERR_SERVICE 47 Invalid publish/unpublish.
MPI_ERR_SIZE 48 Invalid size.
MPI_ERR_SPAWN 49 Error spawning.
MPI_ERR_UNSUPPORTED_DATAREP
50 Unsupported datarep passed to
MPI_File_set_view.
MPI_SUCCESS 0 Successful return code.
MPI_ERR_BUFFER 1 Invalid buffer pointer.
MPI_ERR_COUNT 2 Invalid count argument.
MPI_ERR_TYPE 3 Invalid datatype argument.
MPI_ERR_TAG 4 Invalid tag argument.
MPI_ERR_COMM 5 Invalid communicator.

MPI_ERR_RANK 6 Invalid rank.
MPI_ERR_REQUEST 7 Invalid MPI_Request handle.
MPI_ERR_ROOT 8 Invalid root.
MPI_ERR_GROUP 9 Null group passed to function.
MPI_ERR_OP 10 Invalid operation.

MPI_ERR_TOPOLOGY 11 Invalid topology.
MPI_ERR_DIMS 12 Illegal dimension argument.
MPI_ERR_ARG 13 Invalid argument.
MPI_ERR_UNKNOWN 14 Unknown error.
MPI_ERR_TRUNCATE 15 Message truncated on receive.

MPI_ERR_OTHER 16 Other error; use Error_string.
MPI_ERR_INTERN 17 Internal error code.
MPI_ERR_IN_STATUS 18 Look in status for error value.
MPI_ERR_PENDING 19 Pending request.
MPI_ERR_ACCESS 20 Permission denied.

MPI_ERR_AMODE 21 Unsupported amode passed to open.
MPI_ERR_ASSERT 22 Invalid assert.
MPI_ERR_BAD_FILE 23 Invalid file name (for example,
path name too long).
MPI_ERR_BASE 24 Invalid base.
MPI_ERR_CONVERSION 25 An error occurred in a user-supplied
data-conversion function.

MPI_ERR_DISP 26 Invalid displacement.
MPI_ERR_DUP_DATAREP 27 Conversion functions could not
be registered because a data
representation identifier that was
already defined was passed to
MPI_REGISTER_DATAREP.
MPI_ERR_FILE_EXISTS 28 File exists.
MPI_ERR_FILE_IN_USE 29 File operation could not be
completed, as the file is currently
open by some process.
MPI_ERR_FILE 30 Invalid file handle.

MPI_ERR_INFO_KEY 31 Illegal info key.
MPI_ERR_INFO_NOKEY 32 No such key.
MPI_ERR_INFO_VALUE 33 Illegal info value.
MPI_ERR_INFO 34 Invalid info object.
MPI_ERR_IO 35 I/O error.

MPI_ERR_KEYVAL 36 Illegal key value.
MPI_ERR_LOCKTYPE 37 Invalid locktype.
MPI_ERR_NAME 38 Name not found.
MPI_ERR_NO_MEM 39 Memory exhausted.
MPI_ERR_NOT_SAME 40 Collective argument not identical
on all processes, or collective
routines called in a different order
by different processes.

MPI_ERR_NO_SPACE 41 Not enough space.
MPI_ERR_NO_SUCH_FILE 42 File (or directory) does not exist.
MPI_ERR_PORT 43 Invalid port.
MPI_ERR_QUOTA 44 Quota exceeded.
MPI_ERR_READ_ONLY 45 Read-only file system.

MPI_ERR_RMA_CONFLICT 46 Conflicting accesses to window.
MPI_ERR_RMA_SYNC 47 Erroneous RMA synchronization.
MPI_ERR_SERVICE 48 Invalid publish/unpublish.
MPI_ERR_SIZE 49 Invalid size.
MPI_ERR_SPAWN 50 Error spawning.

MPI_ERR_UNSUPPORTED_DATAREP
51 Unsupported datarep passed to
MPI_File_set_view.
MPI_ERR_UNSUPPORTED_OPERATION
51 Unsupported operation, such as
seeking on a file that supports
only sequential access.
MPI_ERR_WIN 52 Invalid window.
MPI_ERR_LASTCODE 53 Last error code.

MPI_ERR_SYSRESOURCE -2 Out of resources
52 Unsupported operation, such as
seeking on a file that supports
only sequential access.
MPI_ERR_WIN 53 Invalid window.
MPI_T_ERR_MEMORY 54 Out of memory.
MPI_T_ERR_NOT_INITIALIZED 55 Interface not initialized.

MPI_T_ERR_CANNOT_INIT 56 Interface not in the state to be
initialized.
MPI_T_ERR_INVALID_INDEX 57 The enumeration index is invalid.
MPI_T_ERR_INVALID_ITEM 58 The item index queried is out of
range.
MPI_T_ERR_INVALID_HANDLE 59 The handle is invalid.
MPI_T_ERR_OUT_OF_HANDLES 60 No more handles available.

MPI_T_ERR_OUT_OF_SESSIONS 61 No more sessions available.
MPI_T_ERR_INVALID_SESSION 62 Session argument is not a valid
session.
MPI_T_ERR_CVAR_SET_NOT_NOW
63 Variable cannot be set at this
moment.
MPI_T_ERR_CVAR_SET_NEVER 64 Variable cannot be set until end of
execution.
MPI_T_ERR_PVAR_NO_STARTSTOP
65 Variable cannot be started or stopped.

MPI_T_ERR_PVAR_NO_WRITE 66 Variable cannot be written or reset.
MPI_T_ERR_PVAR_NO_ATOMIC 67 Variable cannot be read and written
atomically.
MPI_ERR_RMA_RANGE 68 Target memory is not part of the
window (in the case of a window
created with MPI_WIN_CREATE_DYNAMIC,
target memory is not attached).
MPI_ERR_RMA_ATTACH 69 Memory cannot be attached (e.g.,
because of resource exhaustion).
MPI_ERR_RMA_FLAVOR 70 Passed window has the wrong flavor
for the called function.

MPI_ERR_RMA_SHARED 71 Memory cannot be shared (e.g., some
process in the group of the specified
communicator cannot expose shared
memory).
MPI_T_ERR_INVALID 72 Invalid use of the interface or bad
parameter values(s).
MPI_T_ERR_INVALID_NAME 73 The variable or category name is
invalid.

MPI_ERR_LASTCODE 93 Last error code.
.fi

2 changes: 1 addition & 1 deletion ompi/mpi/man/man3/MPI_Alltoallv.3in
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ MPI_ALLTOALLV(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPE,
INTEGER \fICOMM, IERROR\fP

MPI_IALLTOALLV(\fISENDBUF, SENDCOUNTS, SDISPLS, SENDTYPE,
RECVBUF, RECVCOUNTS, RDISPLS, RECVTYPE, REQUEST, COMM, IERROR\fP)
RECVBUF, RECVCOUNTS, RDISPLS, RECVTYPE, COMM, REQUEST, IERROR\fP)

<type> \fISENDBUF(*), RECVBUF(*)\fP
INTEGER \fISENDCOUNTS(*), SDISPLS(*), SENDTYPE\fP
Expand Down
6 changes: 3 additions & 3 deletions ompi/mpi/man/man3/MPI_Barrier.3in
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ MPI_Ibarrier(\fIcomm\fP, \fIrequest\fP, \fIierror\fP)
.fi
.SH C++ Syntax
.nf
import mpi.*;
void MPI.COMM_WORLD.Barrier()
#include <mpi.h>
void MPI::Comm::Barrier() const = 0

.fi
.SH INPUT PARAMETER
Expand All @@ -53,7 +53,7 @@ void MPI.COMM_WORLD.Barrier()
comm
Communicator (handle).

.SH OUTPUT PARAMETER
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
request
Expand Down
4 changes: 2 additions & 2 deletions ompi/mpi/man/man3/MPI_Bsend_init.3in
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ MPI_Bsend_init(\fIbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIdest\fP, \fItag\fP, \f
.fi
.SH C++ Syntax
.nf
import mpi.*;
Prequest MPI.COMM_WORLD.Bsend_init(const void* \fIbuf\fP, int \fIcount\fP, const
#include <mpi.h>
Prequest Comm::Bsend_init(const void* \fIbuf\fP, int \fIcount\fP, const
Datatype& \fIdatatype\fP, int \fIdest\fP, int \fItag\fP) const

.fi
Expand Down
5 changes: 4 additions & 1 deletion ompi/mpi/man/man3/MPI_Comm_f2c.3in
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.\" $COPYRIGHT$
.TH MPI_Comm_f2c 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Comm_f2c, MPI_Comm_c2f, MPI_File_f2c, MPI_File_c2f, MPI_Info_f2c, MPI_Info_c2f, MPI_Op_f2c, MPI_Op_c2f, MPI_Request_f2c, MPI_Request_c2f, MPI_Type_f2c, MPI_Type_c2f, MPI_Win_f2c, MPI_Win_c2f \fP \- Translates a C handle into a Fortran handle, or vice versa.
\fBMPI_Comm_f2c, MPI_Comm_c2f, MPI_File_f2c, MPI_File_c2f, MPI_Info_f2c, MPI_Info_c2f, MPI_Message_f2c, MPI_Message_c2f, MPI_Op_f2c, MPI_Op_c2f, MPI_Request_f2c, MPI_Request_c2f, MPI_Type_f2c, MPI_Type_c2f, MPI_Win_f2c, MPI_Win_c2f \fP \- Translates a C handle into a Fortran handle, or vice versa.

.SH SYNTAX
.ft R
Expand All @@ -23,6 +23,9 @@ MPI_Fint MPI_Group_c2f(MPI Group \fIgroup\fP)
MPI_Info MPI_Info_f2c(MPI_Fint \fIinfo\fP)
MPI_Fint MPI_Info_c2f(MPI_Info \fIinfo\fP)

MPI_Message MPI_Message_f2c(MPI_Fint \fImessage\fP)
MPI_Fint MPI_Message_c2f(MPI_Message \fImessage\fP)

MPI_Op MPI_Op_f2c(MPI_Fint \fIop\fP)
MPI_Fint MPI_Op_c2f(MPI_Op \fIop\fP)

Expand Down
2 changes: 1 addition & 1 deletion ompi/mpi/man/man3/MPI_Compare_and_swap.3in
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Compare_and_swap(const void *\fIorigin_addr\fP, const void *\fIcompar_addr\fP,
int MPI_Compare_and_swap(const void *\fIorigin_addr\fP, const void *\fIcompare_addr\fP,
void *\fIresult_addr\fP, MPI_Datatype \fIdatatype\fP, int \fItarget_rank\fP,
MPI_Aint \fItarget_disp\fP, MPI_Win \fIwin\fP)

Expand Down
8 changes: 7 additions & 1 deletion ompi/mpi/man/man3/MPI_Exscan.3in
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,13 @@ as \fIrecvbuf\fP is not significant for process 0. The value of
\fIrecvbuf\fP on process 1 is always the value in \fIsendbuf\fP on
process 0.
.sp
No MPI_IN_PLACE operation is supported.
.SH USE OF IN-PLACE OPTION
The `in place' option for intracommunicators is specified by passing MPI_IN_PLACE in the \fIsendbuf\fP argument. In this case, the input data is taken from the receive buffer, and replaced by the output data.
.sp
Note that MPI_IN_PLACE is a special kind of value; it has the same restrictions on its use as MPI_BOTTOM.
.sp
Because the in-place option converts the receive buffer into a send-and-receive buffer, a Fortran binding that includes INTENT must mark these as INOUT, not OUT.
.sp

.SH NOTES
.ft R
Expand Down
3 changes: 2 additions & 1 deletion ompi/mpi/man/man3/MPI_Get_address.3in
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GET_ADDRESS(\fILOCATION, ADDRESS, IERROR\fP)
<type> \fILOCATION\fP(*)
INTEGER \fIADDRESS, IERROR\fP
INTEGER(KIND=MPI_ADDRESS_KIND) \fIADDRESS\fP
INTEGER \fIIERROR\fP

.fi
.SH Fortran 2008 Syntax
Expand Down
2 changes: 1 addition & 1 deletion ompi/mpi/man/man3/MPI_Get_version.3in
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Fortran only: Error status (integer).

.SH DESCRIPTION
.ft R
Since Open MPI is MPI 2.1 compliant, this function will return a version value of 2 and a subversion value of 1 for this release.
Since Open MPI is MPI 3.1 compliant, this function will return a version value of 3 and a subversion value of 1 for this release.

.SH NOTE
.ft R
Expand Down
2 changes: 1 addition & 1 deletion ompi/mpi/man/man3/MPI_Grequest_start.3in
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ MPI_GREQUEST_START(\fIQUERY_FN, FREE_FN, CANCEL_FN, EXTRA_STATE,
REQUEST, IERROR\fP)
INTEGER \fIREQUEST, IERROR\fP
EXTERNAL \fIQUERY_FN, FREE_FN, CANCEL_FN\fP
INTEGER (KIND=MPI_ADDRESS_KIND) \fIEXTRA_STATE\fP
INTEGER(KIND=MPI_ADDRESS_KIND) \fIEXTRA_STATE\fP

.fi
.SH Fortran 2008 Syntax
Expand Down
1 change: 1 addition & 0 deletions ompi/mpi/man/man3/MPI_Message_c2f.3in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.so man3/MPI_Comm_f2c.3
1 change: 1 addition & 0 deletions ompi/mpi/man/man3/MPI_Message_f2c.3in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.so man3/MPI_Comm_f2c.3
68 changes: 68 additions & 0 deletions ompi/mpi/man/man3/MPI_Op_commutative.3in
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.\" -*- nroff -*-
.\" Copyright 2015 FUJITSU LIMITED. All rights reserved.
.\" $COPYRIGHT$
.TH MPI_Op_commutative 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Op_commutative\fP \- Query of commutativity of reduction operation.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Op_commutative(MPI_Op \fIop\fP, int *\fIcommute\fP)

.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_OP_COMMUTATIVE(\fIOP, COMMUTE, IERROR\fP)
LOGICAL \fICOMMUTE\fP
INTEGER \fIOP, IERROR\fP

.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Op_commutative(\fIop\fP, \fIcommute\fP, \fIierror\fP)
TYPE(MPI_Op), INTENT(IN) :: \fIop\fP
INTEGER, INTENT(OUT) :: \fIcommute\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP

.fi
.SH C++ Syntax
.nf
#include <mpi.h>
bool Op::Is_commutative()

.fi
.SH INPUT PARAMETER
.TP 1i
op
Operation (handle).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
commute
True if op is commutative, false otherwise (logical).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).

.SH DESCRIPTION
.ft R
Reduction operations can be queried for their commutativity.

.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
.sp
MPI_Op_create

Loading