17.2.126. MPI_File_preallocate

MPI_File_preallocate — 在文件开头预分配指定大小的存储空间（集体操作）。

17.2.126.1. 语法

17.2.126.1.1. C语法

#include <mpi.h>

int MPI_File_preallocate(MPI_File fh, MPI_Offset size)

17.2.126.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_PREALLOCATE(FH, SIZE, IERROR)
     INTEGER FH, IERROR
     INTEGER(KIND=MPI_OFFSET_KIND)   SIZE

17.2.126.1.3. Fortran 2008 语法

USE mpi_f08
MPI_File_preallocate(fh, size, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     INTEGER(KIND=MPI_OFFSET_KIND), INTENT(IN) :: size
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.126.2. 输入/输出参数

fh: 文件句柄 (handle)。

17.2.126.3. 输入参数

size: 预分配文件的大小，以字节为单位（整数）。

17.2.126.4. 输出参数

ierror: 仅限Fortran：错误状态（整数）。

17.2.126.5. 描述

MPI_File_preallocate 确保为与fh关联的文件的前size字节分配存储空间。MPI_File_preallocate可能是一个非常耗时的操作。

MPI_File_preallocate 是一个集体操作；组内所有进程必须为size参数传递相同的值。文件中先前已写入的区域不受影响。对于文件新分配的区域，MPI_File_preallocate的效果等同于写入未定义数据。如果size大于当前文件大小，文件大小将增加到size。如果size小于或等于当前文件大小，则文件大小保持不变。

文件指针的处理、待处理的非阻塞访问以及文件一致性与MPI_File_set_size相同。如果在打开文件时指定了MPI_MODE_SEQUENTIAL模式，则调用此例程是错误的。

17.2.126.6. 注意事项

在UNIX文件上使用集合例程MPI_File_set_size时，如果设置的大小小于当前文件大小，文件将在定义的位置被截断。如果设置的大小大于当前文件大小，文件大小将变为设置的大小。当通过MPI_File_set_size以这种方式增加文件大小时，将在文件中创建新区域，这些区域的位移位于旧文件大小与新设置的较大文件大小之间。

Sun MPI I/O 不一定会为这些新区域分配文件空间。您可以通过使用MPI_File_preallocate或对特定字节执行读写操作来预留文件空间。

17.2.126.7. 错误

几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。

在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。

Open MPI 包含三个可使用的预定义错误处理器：

MPI_ERRORS_ARE_FATAL 导致程序中止所有连接的MPI进程。
MPI_ERRORS_ABORT 一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。
MPI_ERRORS_RETURN 向应用程序返回一个错误代码。

MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：

MPI_Comm_create_errhandler 然后 MPI_Comm_set_errhandler
MPI_File_create_errhandler 然后 MPI_File_set_errhandler
MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init
MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。