PMIX_INIT(3)

💖 PMIx_Init — like, wake up bestie, the PMIx client is booting 💖

okay so picture this: you're a process, you just spawned, you have NO idea who you are or where you belong, and you need the PMIx system to be like "hey girl, here's your whole identity." that's this function. PMIx_Init is literally the Initialize the PMIx Client moment. main character energy from the very first call. 👑

---

✨ SYNOPSIS ✨

#include <pmix.h>

pmix_status_t PMIx_Init(pmix_proc_t *proc);

---

🎀 ARGUMENTS 🎀

• proc — a pointer to a pmix_proc_t object, and this is where your namespace and rank get handed back to you. it's giving "here's your name tag, babe." 🏷️

---

🌸 DESCRIPTION 🌸

So you call PMIx_Init and it initializes the PMIx client for you, returning the process identifier that got assigned to your client's application, all nice and cozy inside the pmix_proc_t struct you passed in. ✨

Now — plot twist — you're allowed to pass NULL for that parameter. like, totally fine. you'd do that if you only wanna initialize the PMIx system and you genuinely do not need the identifier handed back at that exact moment. no name tag, no problem. 💅

When it's called, the PMIx client goes looking for the required connection info of the local PMIx server, and then it establishes the connection. that's the whole vibe. but if that info is not found, or if the server connection fails, then an appropriate error constant gets returned instead. 😭

If everything goes right, the function returns PMIX_SUCCESS and it fills your provided structure with the server-assigned namespace and rank of the process within the application. slay. 🔥

lowkey important: the PMIx client library is reference counted, so multiple calls to PMIx_Init are totally allowed. which means — fun little hack — one way to get the namespace and rank of your process is to just call PMIx_Init with a non-NULL parameter. easy. iconic. periodt. 💖

---

🦋 RETURN VALUE 🦋

• On success: PMIX_SUCCESS. we love to see it. 🥳
• On error: a negative value corresponding to a PMIx errno gets returned. sad girl hours. 😔

---

💀 ERRORS 💀

The PMIx errno values are defined in pmix_common.h. go look 'em up, bestie, they're all in there. 📖

💌 SEE ALSO

• PMIx_Initialized(3)
• PMIx_Abort(3)
• PMIx_Commit(3)
• PMIx_Finalize(3)
• PMIx_Put(3)
• pmiAddInstance(3)
• pmiAddMetric(3)

---

👑 COPYRIGHT 👑

2014-2025, OpenPMIx Community

---

okay that's the whole page, bestie — this was the OpenPMIx manual, PMIx_Init(3), dated May 30, 2025. go forth and initialize responsibly. mwah. 🫶🌈⭐