sg_get_host_info(3)

✨ sg_get_host_info(3) — like, the whole manual page, bestie ✨

Okay so this is the sg_get_host_info(3) page from libstatgrab and it's literally about getting the tea on your operating system and the machine it's living on. Pull up a chair 🎀

---

🌸 NAME 🌸

sg_get_host_info, sg_get_host_info_r, sg_free_host_info — get general operating system statistics. That's the whole vibe: OS stats, general ones, no cap.

---

🦋 SYNOPSIS 🦋

#include <statgrab.h>

sg_host_info *sg_get_host_info (size_t *entries);

sg_host_info *sg_get_host_info_r (size_t *entries);

sg_error sg_free_host_info (sg_host_info *data);

Three little functions, three little signatures, all copied exactly because I would never mess with your headers 💅

---

💖 DESCRIPTION 💖

These calls return details on the operating system and the machine it's running on. Like a vibe check for your whole computer ✨

🧚 API Shortcut

So the original had a whole cute table and I'm gonna give it to you as a list because we're in a terminal and tables are giving "spreadsheet from 2004" lowkey:

• sg_get_host_info → returns sg_host_info * → data owner is libstatgrab (thread local). It handles its own business, you don't gotta do a thing 🫶
• sg_get_host_info_r → returns sg_host_info * → data owner is the caller. That's you. You own it. Main character responsibility 😭

The sg_host_info buffer received from sg_get_host_info_r() must be freed using sg_free_host_info() when not needed any more. The caller is responsible for doing it. Fr fr, don't forget or that's a leak bestie 💀

---

👑 RETURN VALUES 👑

The structure returned is of type sg_host_info. Here's the enum and the struct, verbatim, no edits, slay:

typedef enum {
        sg_unknown_configuration = 0,
        sg_physical_host,
        sg_virtual_machine,
        sg_paravirtual_machine,
        sg_hardware_virtualized
} sg_host_state;

typedef struct{
        char *os_name;
        char *os_release;
        char *os_version;
        char *platform;
        char *hostname;
        unsigned bitwidth;
        sg_host_state host_state;
        unsigned ncpus;
        unsigned maxcpus;
        time_t uptime;
        time_t systime;
}sg_host_info;

And now the field-by-field breakdown, because every single one matters 🍓

• os_name — the operating system name. (eg. SunOS or Linux)
• os_release — the operating system release. (eg. 5.8 or 5.9 or Solaris)
• os_version — the version level of the OS.
• platform — the hardware platform (architecture) the OS runs on.
• hostname — the name of the machine.
• uptime — the uptime of the machine in seconds.
• systime — the timestamp when the above stats where collected in seconds since epoch. (Yes, "where" — that's how the original spells it and I'm not gonna gaslight you by fixing it 🙈)

Not me just noticing bitwidth, host_state, ncpus and maxcpus are literally in the struct but the original page doesn't give them their own little description paragraphs. They're there, they're in the struct, that's the facts — I'm not gonna make up behaviour for them 💜

---

🔥 SEE ALSO 🔥

• statgrab(3) — go read that one next, iykyk

---

🌈 WEBSITE 🌈

The official site, as listed: https://libstatgrab.org/ 👑

---

And that's the whole page, bestie — no details left behind, every flag and field accounted for ✨ This was libstatgrab, dated 2019-03-08, and it's the sg_get_host_info(3) manual page signing off. Periodt 💅🎀