1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_read_at_all_begin 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_read_at_all_begin\fP \- Reads a file at explicitly specified offsets; beginning part of a split collective routine (nonblocking). |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | C Syntax |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_read_at_all_begin(MPI_File \fIfh\fP, MPI_Offset |
---|
13 | \fIoffset\fP, void \fI*buf\fP, int \fIcount\fP, MPI_Datatype |
---|
14 | \fIdatatype\fP) |
---|
15 | |
---|
16 | Fortran Syntax (see FORTRAN 77 NOTES) |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_FILE_READ_AT_ALL_BEGIN(\fIFH\fP, \fIOFFSET\fP, \fIBUF\fP, |
---|
19 | \fICOUNT\fP, \fIDATATYPE\fP,\fI IERROR\fP) |
---|
20 | <type> \fIBUF\fP(*) |
---|
21 | INTEGER \fIFH, COUNT, DATATYPE, IERROR\fP |
---|
22 | INTEGER(KIND=MPI_OFFSET_KIND) \fIOFFSET\fP |
---|
23 | |
---|
24 | .SH C++ Syntax |
---|
25 | .nf |
---|
26 | #include <mpi.h> |
---|
27 | void MPI::File::Read_at_all_begin(MPI::Offset \fIoffset\fP, void* \fIbuf\fP, |
---|
28 | int \fIcount\fP, const MPI::Datatype& \fIdatatype\fP) |
---|
29 | |
---|
30 | .SH INPUT PARAMETERS |
---|
31 | .ft R |
---|
32 | .TP 1i |
---|
33 | fh |
---|
34 | File handle (handle). |
---|
35 | .ft R |
---|
36 | .TP 1i |
---|
37 | offset |
---|
38 | File offset (integer). |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | count |
---|
42 | Number of elements in buffer (integer). |
---|
43 | .ft R |
---|
44 | .TP 1i |
---|
45 | datatype |
---|
46 | Data type of each buffer element. |
---|
47 | |
---|
48 | .SH OUTPUT PARAMETERS |
---|
49 | .ft R |
---|
50 | .TP 1i |
---|
51 | buf |
---|
52 | Initial address of buffer (choice). |
---|
53 | .TP 1i |
---|
54 | IERROR |
---|
55 | Fortran only: Error status (integer). |
---|
56 | |
---|
57 | .SH DESCRIPTION |
---|
58 | .ft R |
---|
59 | MPI_File_read_at_all_begin is the beginning part of a split collective routine that attempts to read from the file associated with |
---|
60 | .I fh |
---|
61 | (at the |
---|
62 | .I offset |
---|
63 | position) a total number of |
---|
64 | .I count |
---|
65 | data items having |
---|
66 | .I datatype |
---|
67 | type into the user's buffer |
---|
68 | .I buf. |
---|
69 | The |
---|
70 | .I offset |
---|
71 | is in etype units relative to the current view. That is, holes are not counted |
---|
72 | when locating an offset. The data is taken out of those parts of the |
---|
73 | file specified by the current view. |
---|
74 | |
---|
75 | .SH FORTRAN 77 NOTES |
---|
76 | .ft R |
---|
77 | The MPI standard prescribes portable Fortran syntax for |
---|
78 | the \fIOFFSET\fP argument only for Fortran 90. FORTRAN 77 |
---|
79 | users may use the non-portable syntax |
---|
80 | .sp |
---|
81 | .nf |
---|
82 | INTEGER*MPI_OFFSET_KIND \fIOFFSET\fP |
---|
83 | .fi |
---|
84 | .sp |
---|
85 | where MPI_OFFSET_KIND is a constant defined in mpif.h |
---|
86 | and gives the length of the declared integer in bytes. |
---|
87 | |
---|
88 | .SH NOTES |
---|
89 | .ft R |
---|
90 | All the nonblocking collective routines for data access are "split" into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. |
---|
91 | |
---|
92 | .SH ERRORS |
---|
93 | 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. |
---|
94 | .sp |
---|
95 | Before the error value is returned, the current MPI error handler is |
---|
96 | 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. |
---|
97 | |
---|