MPI_CLOSE_PORT(3)

πŸ’… MPI_CLOSE_PORT β€” the Open MPI glow-up πŸŽ€

Okay bestie, so this is a page from the Open MPI manual set, section 3, and today's main character is MPI_Close_port. Let's get into it. ✨


🌸 NAME 🌸

MPI_Close_port β€” releases the specified network address. That's it. That's the whole vibe check. πŸ”₯


πŸ¦‹ SYNTAX πŸ¦‹

πŸ’œ C Syntax

#include <mpi.h>

int MPI_Close_port(const char *port_name)

πŸ’œ Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_CLOSE_PORT(PORT_NAME, IERROR)
    CHARACTER*(*)   PORT_NAME
    INTEGER     IERROR

πŸ’œ Fortran 2008 Syntax

USE mpi_f08

MPI_Close_port(port_name, ierror)
    CHARACTER(LEN=*), INTENT(IN) :: port_name
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

Like, yes, the Fortran 2008 version is lowercase-and-tidy. It's giving lowercase elegance. We stan. 🫢


πŸ“ INPUT PARAMETER πŸ“

  • port_name β€” a port (string). That's the string sitting right there being a port, bestie, it's not that deep πŸ’…

πŸŽ€ OUTPUT PARAMETER πŸŽ€

  • ierror β€” Fortran only: error status (integer). C girlies, you get it as the return value instead, scroll down πŸ‘‘

🌈 DESCRIPTION 🌈

So what does it actually do? MPI_Close_port releases the network address represented by port_name. Boom. Clean. Iconic. Freeing that address like it's deleting an ex from your contacts. ✨


πŸ’€ ERRORS πŸ’€

Ngl, this part is long, but it's important, so grab a snack. πŸ“

Almost all MPI routines return an error value. C routines hand it back as the return result of the function, and Fortran routines stick it in the last argument. Simple enough, right? πŸ’…

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. And 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. And 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. Fr fr, that's the whole chain.

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

  • MPI_ERRORS_ARE_FATAL β€” causes the program to abort all connected MPI processes. Absolutely not a chill girl moment πŸ’€
  • 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, it 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, it aborts only the local process.
  • MPI_ERRORS_RETURN β€” returns an error code to the application. The polite one 🫢

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. Like, lowkey the program might just end. Do not assume it's coming back. 😭

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. ✨


2003-2026, The Open MPI Community. Respect the elders, they built the toolchain πŸ’–


And that's the page, bestie! This snacc was brought to you by the MPI_CLOSE_PORT(3) manual page, Open MPI edition, dated Sep 11, 2026 β€” go forth and close those ports. πŸ¦‹βœ¨πŸŽ€

πŸ“¦ where this page comes from