Synopsis
int MPI_File_preallocate(MPI_File fh, MPI_Offset size)
Input Parameters
- fh
-
file handle (handle)
- size
-
size to preallocate file (integer)
Description
MPI_File_preallocate ensures that storage space is allocated for the first size bytes of the file associated with fh.
This is a collective operation over the group associated with the file, and all processes must pass identical values for size. Regions of the file that have previously been written are unaffected, and for newly allocated regions the effect is the same as writing undefined data. If size is larger than the current file size, the file size increases to size; if size is less than or equal to the current file size, the file size is unchanged. The treatment of file pointers, nonblocking accesses, and file consistency is the same as with MPI_FILE_SET_SIZE. All nonblocking requests and split collective operations on fh must be completed before calling this routine. It is erroneous to call this routine if MPI_MODE_SEQUENTIAL was specified when the file was opened. In some implementations, file preallocation may be time-consuming.
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.
Notes for Fortran
All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
Errors
All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with 'MPI_Comm_set_errhandler' (for communicators),
'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for
RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but
its use is deprecated. The predefined error handler
'MPI_ERRORS_RETURN' may be used to cause error values to be returned.
Note that MPI does not guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.