PMCLEANMAPDIR(3)

💖 PMCLEANMAPDIR 💖

okay bestie, welcome to __pmCleanMapDir(3) — a little library-functions-manual moment from the Performance Co-Pilot universe. yes it's a section 3 page. yes it's niche. no we are not skipping anything. let's get into it 🫶

---

✨ NAME ✨

__pmCleanMapDir — literally just here to remove old files from a map directory. that's the whole job. icon behavior 💅

---

🌸 C SYNOPSIS 🌸

#include "pmapi.h"
#include "libpcp.h"

int __pmCleanMapDir(const char *dirname, const char *special);

and when you link it:

cc ... -lpcp

she's compiled and she's ready 🎀

---

🚨 CAVEAT 🚨

bestie, read this part. this documentation is intended for internal Performance Co-Pilot (PCP) developer use.

these interfaces are not part of the PCP APIs that are guaranteed to remain fixed across releases. so they may not work, or may provide different semantics at some point in the future. no cap. it's giving "use at your own risk" energy 😭

---

🦋 DESCRIPTION 🦋

so pmlogger(1) and pmie(1) keep directories full of map files, right? and those map files give you a mapping from a pmlogger(1) or pmie(1) process id (PID) over to the important parameters of those processes. very organized of them. very main character.

__pmCleanMapDir goes through and removes ``dead'' files in those directories. specifically, the directory entries in dirname should follow these rules — and if they don't, __pmCleanMapDir will just remove them. bye 👋

• the name should be numeric, else it should be equal special (if special is not NULL)
• for a numeric directory entry it should be a regular file and the name should be the PID of a running process
• for a match on special the directory entry should be a symbolic link and the last component of the link should be the ASCII encoding of the PID of a running process

and before any of these checks are even done, __pmCleanMapDir checks that dirname is indeed a directory, and that the user id and group id of the caller match the user id and group id of dirname. vibe check first, always 💜

---

⭐ RETURN VALUES ⭐

if a serious error occurs, __pmCleanMapDir returns a negative value — and that value is suitable for reporting with pmErrStr(3). so you know exactly what to do with it.

otherwise? the return value is the number of entries that have been removed. so satisfying. counting your little wins 🔥

---

🎀 DIAGNOSTICS 🎀

verbose diagnostics describing the actions of __pmCleanMapDir will be reported on standard error if the debug option misc is set, e.g. via -D misc from the command line. so if you wanna see her whole thought process, you know the flag ✨

---

🌈 SEE ALSO 🌈

pmdbg(1), PMAPI(3) and pmErrStr(3).

---

and that's the whole page, bestie 💖

Performance Co-Pilot · PCP · PMCLEANMAPDIR(3) — mwah, go clean those map directories responsibly 🧚💅