PMIX_ABORT(3)

✨ PMIX_ABORT(3) ✨

okay bestie, gather round, we're doing a little thing called aborting processes and it's giving very main character. this is the PMIx_Abort page from the OpenPMIx manual, section 3, and by the end of this you're gonna be so good at it, i swear. πŸŽ€

PMIx_Abort β€” say it with me: abort the specified processes. dramatic? yes. necessary? sometimes!! πŸ’…


🌸 SYNOPSIS 🌸

#include <pmix.h>

pmix_status_t PMIx_Abort(int status, const char msg[],
                         pmix_proc_t procs[], size_t nprocs);

there's literally nothing else to it, that's the whole handshake 🫢


πŸ¦‹ ARGUMENTS πŸ¦‹

  • status β€” the status value you want to be handed back. and no cap, a value of zero is permitted by PMIx, but some resource managers might not return it. so like... allowed, but not universally observed, iykyk 😭
  • msg β€” a string message that gets displayed. it's your little note to the world.
  • procs β€” an array of pmix_proc_t structures that defines which processes are getting aborted. passing NULL for the proc array means all processes in the caller's namespace get aborted. and a wildcard value for the rank inside any structure means all processes in that namespace get aborted. so many options, so much power πŸ‘‘
  • nprocs β€” how many pmix_proc_t structures are chillin' in that procs array.

πŸ’œ DESCRIPTION πŸ’œ

so the vibe is: you request that the array of procs you provided gets aborted, it returns the status you gave it, and it prints the message you gave it. and again β€” NULL for the procs array means all processes in the caller's namespace are to be aborted. okurrr.

now here's the part where PMIx is like "bestie this is not up to me." the response to this request is somewhat dependent on the specific resource manager and its configuration β€” for example, some resource managers will not abort the application if the provided status is zero unless they're specifically configured to do so. so that whole thing lies outside the control of PMIx itself. πŸ™ˆ

but ! the client will inform the RM of the request that the application be aborted, regardless of the value of the provided status. so at least you did your part, queen.

passing a NULL msg parameter? totally allowed, go off.

⚠️ also β€” note that race conditions caused by multiple processes calling PMIx_Abort are left to the server implementation to resolve with regard to which status is returned and what messages (if any) are printed. so if everybody yells at once, that's the server's problem to sort out, not yours. πŸ’€

⭐ RETURN VALUE ⭐

Returns PMIX_SUCCESS on success. πŸŽ‰

On error, a negative value corresponding to a PMIx errno is returned.


🌈 ERRORS 🌈

PMIx errno values are defined in pmix_common.h. that's the file, that's where they live, go look 🧚


πŸ‘‘ SEE ALSO πŸ‘‘


2014-2026, OpenPMIx Community


and that's the whole page bestie!! πŸ’– copyright belongs to the OpenPMIx Community, chilling across 2014-2026, and this lil masterpiece dropped on Aug 04, 2026. slay, ate, no crumbs. now go abort some processes responsibly βœ¨πŸ«ΆπŸ’…

πŸ“¦ where this page comes from