1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_write_ordered_begin 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_write_ordered_begin\fP \- Writes a file at a location specified by a shared file pointer; 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_write_ordered_begin(MPI_File \fIfh\fP, void \fI*buf\fP, |
---|
13 | int \fIcount\fP, MPI_Datatype \fIdatatype\fP) |
---|
14 | |
---|
15 | Fortran Syntax |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_FILE_WRITE_ORDERED_BEGIN(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP,\fI IERROR\fP) |
---|
18 | <type> BUF(*) |
---|
19 | INTEGER FH, COUNT, DATATYPE, IERROR |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::File::Write_ordered_begin(const void* \fIbuf\fP, int \fIcount\fP, |
---|
25 | const MPI::Datatype& \fIdatatype\fP) |
---|
26 | |
---|
27 | .SH INPUT/OUTPUT PARAMETER |
---|
28 | .ft R |
---|
29 | .TP 1i |
---|
30 | fh |
---|
31 | File handle (handle). |
---|
32 | |
---|
33 | .SH INPUT PARAMETERS |
---|
34 | .ft R |
---|
35 | .TP 1i |
---|
36 | buf |
---|
37 | Initial address of buffer (choice). |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | count |
---|
41 | Number of elements in buffer (integer). |
---|
42 | .ft R |
---|
43 | .TP 1i |
---|
44 | datatype |
---|
45 | Data type of each buffer element (handle). |
---|
46 | |
---|
47 | .SH OUTPUT PARAMETER |
---|
48 | .ft R |
---|
49 | .TP 1i |
---|
50 | IERROR |
---|
51 | Fortran only: Error status (integer). |
---|
52 | |
---|
53 | .SH DESCRIPTION |
---|
54 | .ft R |
---|
55 | MPI_File_write_ordered_begin is the beginning part of a split collective, nonblocking routine that must |
---|
56 | be called by all processes in the communicator group associated with |
---|
57 | the file handle |
---|
58 | .I fh. |
---|
59 | Each process may pass different argument values |
---|
60 | for the |
---|
61 | .I datatype |
---|
62 | and |
---|
63 | .I count |
---|
64 | arguments. After all processes of the |
---|
65 | group have issued their respective calls, each process attempts to |
---|
66 | write, into the file associated with |
---|
67 | .I fh, |
---|
68 | a total number of |
---|
69 | .I count |
---|
70 | data items having datatype type contained in the user's buffer |
---|
71 | .I buf. |
---|
72 | For |
---|
73 | each process, the location in the file at which data is written is the |
---|
74 | position at which the shared file pointer would be after all processes |
---|
75 | whose ranks within the group are less than that of this process had |
---|
76 | written their data. |
---|
77 | |
---|
78 | .SH NOTES |
---|
79 | .ft R |
---|
80 | 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. |
---|
81 | |
---|
82 | .SH ERRORS |
---|
83 | 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. |
---|
84 | .sp |
---|
85 | Before the error value is returned, the current MPI error handler is |
---|
86 | 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. |
---|
87 | |
---|