KINFO_GETVMOBJECT(3)

hii bestie 💖 welcome to the KINFO_GETVMOBJECT(3) page — yep, the Library Functions Manual one. we're talking system-wide memory info, and it's lowkey iconic. no cap. 🫶

🌸 NAME 🌸

kinfo_getvmobject — the function for getting system-wide memory information, bestie. it's giving "show me the memory objects" energy. ✨

📚 LIBRARY 📚

System Utilities Library (libutil, -lutil). yes, that's the one. 🎀

✨ SYNOPSIS ✨

include these headers, then call it like this:

#include <sys/types.h>
#include <sys/user.h>
#include <libutil.h>

struct kinfo_vmobject *
kinfo_getvmobject(int *cntp);

🦋 DESCRIPTION 🦋

okay so this function is how you obtain information about the objects that are using memory in the system. literally its whole job. 💅

The cntp argument is the little counter receipt — it lets the caller know how many records are returned. 🧾

It's a wrapper around the vm.objects sysctl(3) MIB. the kernel returns a packed structure, but this function expands the data into a fixed record format. so you get the fixed record vibe instead of the packed chaos. 🔥

💀 RETURN VALUES 💀

On success, kinfo_getvmobject() returns a pointer to an array of struct kinfo_vmobject structures as defined by <sys/user.h>. 💖

That array is allocated by an internal call to malloc(3), and you — yes, the caller — must free it with a call to free(3). do not forget, bestie — it's your job to free it. 😭

On failure, kinfo_getvmobject() returns NULL. 💀

🌈 SEE ALSO 🌈

go read these too, bestie:

• free(3)
• kinfo_getvmmap(3)
• malloc(3)

👑 HISTORY 👑

kinfo_getvmobject() first appeared in FreeBSD 10.2. periodt. 💅

---

and that's the page, bestie 🎀 source/version: Debian, dated May 20, 2020. slay. ✨