Rev | Line | |
---|
[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_File_set_atomicity 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_File_set_atomicity\fP \- Sets consistency semantics for data-access operations (collective). |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .nf |
---|
| 10 | C Syntax |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_File_set_atomicity(MPI_File \fIfh\fP, int \fIflag\fP) |
---|
| 13 | |
---|
| 14 | Fortran Syntax |
---|
| 15 | INCLUDE 'mpif.h' |
---|
| 16 | MPI_FILE_SET_ATOMICITY(\fIFH\fP,\fI FLAG\fP,\fI IERROR\fP) |
---|
| 17 | INTEGER FH, FLAG, IERROR |
---|
| 18 | |
---|
| 19 | .SH C++ Syntax |
---|
| 20 | .nf |
---|
| 21 | #include <mpi.h> |
---|
| 22 | void MPI::File::Set_atomicity(bool \fIflag\fP) |
---|
| 23 | |
---|
| 24 | .SH INPUT PARAMETERS |
---|
| 25 | .ft R |
---|
| 26 | .TP 1i |
---|
| 27 | fh |
---|
| 28 | File handle (handle). |
---|
| 29 | .TP 1i |
---|
| 30 | flag |
---|
| 31 | \fBtrue\fP to enable atomic mode, \fBfalse\fP to enable nonatomic mode (boolean). |
---|
| 32 | |
---|
| 33 | .SH OUTPUT PARAMETER |
---|
| 34 | .ft R |
---|
| 35 | .TP 1i |
---|
| 36 | IERROR |
---|
| 37 | Fortran only: Error status (integer). |
---|
| 38 | |
---|
| 39 | .SH DESCRIPTION |
---|
| 40 | .ft R |
---|
| 41 | The consistency semantics for data-access operations using the set of |
---|
| 42 | file handles created by one collective MPI_File_open is set by collectively |
---|
| 43 | calling MPI_File_set_atomicity. All processes in the group must pass identical values for |
---|
| 44 | .I fh |
---|
| 45 | and |
---|
| 46 | .I flag. |
---|
| 47 | If |
---|
| 48 | .I flag |
---|
| 49 | is |
---|
| 50 | .I true, |
---|
| 51 | atomic mode is set; if |
---|
| 52 | .I flag |
---|
| 53 | is |
---|
| 54 | .I false, |
---|
| 55 | nonatomic mode is set. |
---|
| 56 | .sp |
---|
| 57 | The default value on a call to MPI_File_open in Open MPI is \fItrue\fP for jobs running on more than one node, \fIfalse\fP for jobs running on a single SMP. For more information, see the MPI-2 standard. |
---|
| 58 | |
---|
| 59 | .SH ERRORS |
---|
| 60 | 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. |
---|
| 61 | .sp |
---|
| 62 | Before the error value is returned, the current MPI error handler is |
---|
| 63 | 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. |
---|
| 64 | |
---|
Note: See
TracBrowser
for help on using the repository browser.