MPIX_Stop_progress_thread(3)

πŸ“¦
version 5.0.1 Β· 4 versions
, in nixos 26.05, ubuntu stonking

✨ MPIX_Stop_progress_thread πŸ’…

okay bestie, today's episode of "my fav MPI man page" is MPIX_Stop_progress_thread(3) from the MPI manual, and ngl it's a good one πŸŽ€

πŸ’– NAME πŸ’–

MPIX_Stop_progress_thread β€” literally just: stop the progress thread that polls progress on the given stream πŸ›‘

✨ SYNOPSIS ✨

int MPIX_Stop_progress_thread(MPIX_Stream stream)

🌸 INPUT PARAMETERS 🌸

  • stream β€” stream object (handle) πŸ¦‹

πŸ”₯ THREAD AND INTERRUPT SAFETY πŸ”₯

This routine is thread-safe, periodt. Which means it may be safely used by multiple threads without the need for any user-provided thread locks. Slay. ❇️

b u t β€” it 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. So like… thread-safe? yes. interrupt-safe? absolutely not, bestie. πŸ’€

πŸŽ€ NOTES FOR FORTRAN πŸŽ€

Basically, 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 they're invoked with the call statement. 🫢

Also! All MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type INTEGER in Fortran. Yes literally all of them. 🧚

⭐ ERRORS ⭐

So, 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 that value is returned, the current MPI error handler is called. πŸ‘‘

By default, this error handler aborts the MPI job. Like, the whole thing. Gone. 😭

The error handler may be changed with:

  • MPI_Comm_set_errhandler (for communicators)
  • MPI_File_set_errhandler (for files)
  • MPI_Win_set_errhandler (for RMA windows)

The MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated β€” so pls don't, iykyk.

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. main character energy fr fr. 🌈

The error codes you might catch:

  • 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. πŸ”

okay that's the whole vibe check, you're basically an expert now πŸ’…βœ¨

mwah πŸ’‹ β€” written under the MPI manual, this page dated 4/10/2026, filed as MPIX_Stop_progress_thread(3). obsessed with her, honestly. πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from