Open MPI logo

MPI_File_sync(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_File_sync  -  Makes semantics consistent for data-access operations
       (collective).

SYNTAX

       C Syntax
           #include <mpi.h>
           int MPI_File_sync(MPI_File fh)

       Fortran Syntax
           INCLUDE 'mpif.h'
           MPI_FILE_SYNC(FH, IERROR)
                  INTEGER    FH, IERROR

C++ Syntax

       #include <mpi.h>
       void MPI::File::Sync()

INPUT PARAMETER

       fh        File handle (handle).

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       Calling MPI_File_sync with fh causes all previous writes to fh  by  the
       calling  process to be written to permanent storage. If other processes
       have made updates to permanent storage, then all  such  updates  become
       visible to subsequent reads of fh by the calling process.

       MPI_File_sync  is  a  collective operation. The user is responsible for
       ensuring that all nonblocking requests on fh have been completed before
       calling  MPI_File_sync.  Otherwise,  the call to MPI_File_sync is erro-
       neous.

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++ func-
       tions 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.

       Before the error value is returned, the current MPI  error  handler  is
       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.

« Return to documentation listing