Skip to content
This repository was archived by the owner on Sep 30, 2022. It is now read-only.

Commit 18a4969

Browse files
edgargabrieledgargabriel
committed
add the manpages for the new MPI-3.1 non-blocking collective I/O operations.
1 parent b049180 commit 18a4969

File tree

5 files changed

+407
-0
lines changed

5 files changed

+407
-0
lines changed

‎ompi/mpi/man/man3/MPI_File_iread_all.3in‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
3+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
4+
.\" Copyright (c) 1996 Thinking Machines Corporation
5+
.\" $COPYRIGHT$
6+
.TH MPI_File_iread_all 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
7+
.SH NAME
8+
\fBMPI_File_iread_all\fP \- Reads a file starting at the location specified by the individual file pointer (nonblocking, collective).
9+
10+
.SH SYNTAX
11+
.ft R
12+
.nf
13+
C Syntax
14+
#include <mpi.h>
15+
int MPI_File_iread_all(MPI_File \fIfh\fP, void \fI*buf\fP, int \fIcount\fP,
16+
MPI_Datatype \fIdatatype\fP, MPI_Request \fI*request\fP)
17+
18+
.fi
19+
.SH Fortran Syntax
20+
.nf
21+
INCLUDE 'mpif.h'
22+
MPI_FILE_IREAD_ALL(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fIREQUEST\fP,\fI IERROR\fP)
23+
<type> BUF(*)
24+
INTEGER FH, COUNT, DATATYPE, REQUEST, IERROR
25+
26+
.fi
27+
.SH C++ Syntax
28+
.nf
29+
#include <mpi.h>
30+
MPI::Request MPI::File::Iread(void* \fIbuf\fP, int \fIcount\fP,
31+
const MPI::Datatype& \fIdatatype\fP)
32+
33+
.fi
34+
.SH INPUT/OUTPUT PARAMETER
35+
.ft R
36+
.TP 1i
37+
fh
38+
File handle (handle).
39+
40+
.SH INPUT PARAMETERS
41+
.ft R
42+
.TP 1i
43+
count
44+
Number of elements in the buffer (integer).
45+
.ft R
46+
.TP 1i
47+
datatype
48+
Data type of each buffer element (handle).
49+
50+
.SH OUTPUT PARAMETERS
51+
.ft R
52+
.TP 1i
53+
buf
54+
Initial address of buffer (choice).
55+
.ft R
56+
.TP 1i
57+
request
58+
Request object (handle).
59+
.TP 1i
60+
IERROR
61+
Fortran only: Error status (integer).
62+
63+
.SH DESCRIPTION
64+
.ft R
65+
MPI_File_iread_all is a nonblocking version of MPI_File_read_all. It attempts to read from the file associated with
66+
.I fh
67+
at the current individual file pointer position maintained by the system in which a total number of
68+
.I count
69+
data items having
70+
.I datatype
71+
type are read into the user's buffer
72+
.I buf.
73+
The data is taken out of those parts of the
74+
file specified by the current view. MPI_File_iread_all stores the
75+
number of data-type elements actually read in
76+
.I status.
77+
All other fields of
78+
.I status
79+
are undefined. It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened.
80+
81+
.SH ERRORS
82+
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.
83+
.sp
84+
Before the error value is returned, the current MPI error handler is
85+
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.
86+

‎ompi/mpi/man/man3/MPI_File_iread_at_all.3in‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
3+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
4+
.\" Copyright (c) 1996 Thinking Machines Corporation
5+
.\" $COPYRIGHT$
6+
.TH MPI_File_iread_at_all 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
7+
.SH NAME
8+
\fBMPI_File_iread_at_all\fP \- Reads a file at an explicitly specified offset (nonblocking, collective).
9+
10+
.SH SYNTAX
11+
.ft R
12+
.nf
13+
C Syntax
14+
#include <mpi.h>
15+
int MPI_File_iread_at_all(MPI_File \fIfh\fP, MPI_Offset \fIoffset\fP,
16+
void \fI*buf\fP, int \fIcount\fP, MPI_Datatype \fIdatatype\fP,
17+
MPI_Request \fI*request\fP)
18+
19+
.fi
20+
.SH Fortran Syntax (see FORTRAN 77 NOTES)
21+
.nf
22+
INCLUDE 'mpif.h'
23+
MPI_FILE_IREAD_AT_ALL(\fIFH\fP, \fIOFFSET\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fIREQUEST\fP, \fIIERROR\fP)
24+
<type> \fIBUF\fP(*)
25+
INTEGER \fIFH, COUNT, DATATYPE, REQUEST, IERROR\fP
26+
INTEGER(KIND=MPI_OFFSET_KIND) \fIOFFSET\fP
27+
28+
.fi
29+
.SH C++ Syntax
30+
.nf
31+
#include <mpi.h>
32+
MPI::Request MPI::File::Iread_at(MPI::Offset \fIoffset\fP, void* \fIbuf\fP,
33+
int \fIcount\fP, const MPI::Datatype& \fIdatatype\fP)
34+
35+
.fi
36+
.SH INPUT PARAMETERS
37+
.ft R
38+
.TP 1i
39+
fh
40+
File handle (handle).
41+
.ft R
42+
.TP 1i
43+
offset
44+
File offset (integer).
45+
.ft R
46+
.TP 1i
47+
count
48+
Number of elements in the buffer (integer).
49+
.ft R
50+
.TP 1i
51+
datatype
52+
Data type of each buffer element (handle).
53+
54+
.SH OUTPUT PARAMETERS
55+
.ft R
56+
.TP 1i
57+
buf
58+
Initial address of the buffer (choice).
59+
.ft R
60+
.TP 1i
61+
request
62+
Request object (handle).
63+
.TP 1i
64+
IERROR
65+
Fortran only: Error status (integer).
66+
67+
.SH DESCRIPTION
68+
.ft R
69+
MPI_File_iread_at_all is the nonblocking version of MPI_File_read_at_all.
70+
71+
MPI_File_iread_at_all is a nonblocking routine that attempts to read from the file associated with
72+
.I fh
73+
at the
74+
.I offset
75+
position a total number of
76+
.I count
77+
data items having
78+
.I datatype
79+
type into the user's buffer
80+
.I buf.
81+
The
82+
.I offset
83+
is in etype units relative to the current view. That is, holes are not counted
84+
when locating an offset. The data is taken out of those parts of the
85+
file specified by the current view. MPI_File_iread_at_all stores the
86+
number of
87+
.I datatype
88+
elements actually read in
89+
.I status.
90+
All other fields of
91+
.I status
92+
are undefined.
93+
94+
.SH FORTRAN 77 NOTES
95+
.ft R
96+
The MPI standard prescribes portable Fortran syntax for
97+
the \fIOFFSET\fP argument only for Fortran 90. Sun FORTRAN 77
98+
users may use the non-portable syntax
99+
.sp
100+
.nf
101+
INTEGER*MPI_OFFSET_KIND \fIOFFSET\fP
102+
.fi
103+
.sp
104+
where MPI_OFFSET_KIND is a constant defined in mpif.h
105+
and gives the length of the declared integer in bytes.
106+
107+
.SH ERRORS
108+
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.
109+
.sp
110+
Before the error value is returned, the current MPI error handler is
111+
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.
112+

‎ompi/mpi/man/man3/MPI_File_iwrite_all.3in‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
3+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
4+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
5+
.\" Copyright (c) 1996 Thinking Machines Corporation
6+
.\" $COPYRIGHT$
7+
.TH MPI_File_iwrite_all 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
8+
.SH NAME
9+
\fBMPI_File_iwrite_all\fP \- Writes a file starting at the location specified by the individual file pointer (nonblocking, collective).
10+
11+
.SH SYNTAX
12+
.ft R
13+
.nf
14+
C Syntax
15+
#include <mpi.h>
16+
int MPI_File_iwrite_all(MPI_File \fIfh\fP, const void \fI*buf\fP, int \fIcount\fP,
17+
MPI_Datatype \fIdatatype\fP, MPI_Request \fI*request\fP)
18+
19+
.fi
20+
.SH Fortran Syntax
21+
.nf
22+
INCLUDE 'mpif.h'
23+
MPI_FILE_IWRITE_ALL(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fIREQUEST\fP,\fI IERROR\fP)
24+
<TYPE> BUF(*)
25+
INTEGER FH, COUNT, DATATYPE, REQUEST, IERROR
26+
27+
.fi
28+
.SH C++ Syntax
29+
.nf
30+
#include <mpi.h>
31+
MPI::Request MPI::File::Iwrite(const void* \fIbuf\fP, int \fIcount\fP,
32+
const MPI::Datatype& \fIdatatype\fP)
33+
34+
.fi
35+
.SH INPUT/OUTPUT PARAMETER
36+
.ft R
37+
.TP 1i
38+
fh
39+
File handle (handle).
40+
41+
.SH INPUT PARAMETERS
42+
.ft R
43+
.TP 1i
44+
buf
45+
Initial address of buffer (choice).
46+
.ft R
47+
.TP 1i
48+
count
49+
Number of elements in buffer (integer).
50+
.ft R
51+
.TP 1i
52+
datatype
53+
Data type of each buffer element (handle).
54+
55+
.SH OUTPUT PARAMETER
56+
.ft R
57+
.TP 1i
58+
request
59+
Request object (handle).
60+
.TP 1i
61+
IERROR
62+
Fortran only: Error status (integer).
63+
64+
.SH DESCRIPTION
65+
.ft R
66+
MPI_File_iwrite_all is a nonblocking version of the MPI_File_write_all interface. It attempts to write into the file associated with
67+
.I fh
68+
(at the current individual file pointer position maintained by the system) a total number of
69+
.I count
70+
data items having
71+
.I datatype
72+
type from the user's buffer
73+
.I buf.
74+
The data is written into those parts of the
75+
file specified by the current view. MPI_File_iwrite_all stores the
76+
number of
77+
.I datatype
78+
elements actually written in
79+
.I status.
80+
All other fields of
81+
.I status
82+
are undefined.
83+
.sp
84+
It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was open.
85+
86+
.SH ERRORS
87+
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.
88+
.sp
89+
Before the error value is returned, the current MPI error handler is
90+
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.
91+

0 commit comments

Comments
 (0)