MPI_FILE_SET_SIZE(3)

💖 MPI_FILE_SET_SIZE(3) 💖

okay bestie, welcome to the Open MPI manual, specifically the one about MPI_FILE_SET_SIZE — she resizes a file and she does it collectively, periodt. ✨

---

🌸 NAME 🌸

MPI_File_set_size — Resizes a file (collective).

---

✨ SYNTAX ✨

🍓 C Syntax

#include <mpi.h>

int MPI_File_set_size(MPI_File fh, MPI_Offset size)

🎀 Fortran Syntax

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

🦋 Fortran 2008 Syntax

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

---

💅 INPUT PARAMETERS 💅

• fh — the file handle, bestie. It's a handle (handle). 🫶
• size — the size you wanna truncate or expand the file to. It's an integer.

---

🌈 OUTPUT PARAMETER 🌈

• ierror — Fortran only: error status, and yes it's an integer. 😌

---

👑 DESCRIPTION 👑

MPI_File_set_size resizes the file that's hanging out with the file handle fh, truncating UNIX files as necessary. And listen — MPI_File_set_size is collective, so every single process in the group has to pass identical values for size. No solo missions, no main character deviations. 👯

When you use MPI_File_set_size on a UNIX file, here's the tea:

• if size is larger than the current file size, the file size literally becomes size. glow up. ✨
• if size is smaller than the current file size, the file gets truncated at the position defined by size — that's from the beginning of the file and measured in bytes. ✂️
• Regions of the file which have been previously written are unaffected. we respect her history. 💜

MPI_File_set_size does not affect the individual file pointers or the shared file pointer. leave them alone, they're doing fine. 🙈

ngl, note that the actual amount of storage space cannot be allocated by MPI_File_set_size. If that's what you want, use MPI_File_preallocate to accomplish this. different girl, different job. 💅

It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened. like, don't. it's giving error. 💀

---

😭 ERRORS 😭

Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.

Open MPI includes three predefined error handlers that can be used:

• MPI_ERRORS_ARE_FATAL — Causes the program to abort all connected MPI processes. dramatic but effective 💀
• MPI_ERRORS_ABORT — An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.
• MPI_ERRORS_RETURN — Returns an error code to the application. she's polite like that 🎀

MPI applications can also implement their own error handlers by calling:

• MPI_Comm_create_errhandler then MPI_Comm_set_errhandler
• MPI_File_create_errhandler then MPI_File_set_errhandler
• MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
• MPI_Win_create_errhandler then MPI_Win_set_errhandler

Note that MPI does not guarantee that an MPI program can continue past an error. fr fr. 😭

See the MPI man page for a full list of MPI error codes.

See the Error Handling section of the MPI-3.1 standard for more information. iykyk 📚✨

---

🫶 Copyright 🫶

2003-2026, The Open MPI Community

---

and that's the whole page bestie!! 💖 written from the Open MPI corner of the universe, dated Sep 10, 2026, by The Open MPI Community (2003-2026 copyright, icons only) — slay, go resize something, collectively. 👑🌈🦋