CK_HS_STAT(3)

💖 CK_HS_STAT(3) 💖

okay so bestie, this is the ck_hs_stat page from the Concurrency Kit — that's libck, you link it with -lck — and it's genuinely one of the cutest little calls in the whole library. it just... tells you stuff. about your hash set. it's giving ✨receipts✨. let's get into it.

✨ NAME ✨

ck_hs_stat — get hash set status 💅

like, the vibe check for your hash set. the numbers. the tea. 🫶

📚 LIBRARY 📚

Concurrency Kit (libck, and you link it with -lck)

🎀 SYNOPSIS 🎀

#include <ck_hs.h>

void
ck_hs_stat(ck_hs_t *hs, struct ck_hs_stat *st);

that's it. that's the whole signature. two pointers, no return, no drama. 🌸

🦋 DESCRIPTION 🦋

so ck_hs_stat(3) goes and stores various hash set statistics into the object that st points at. you hand it your hash set (hs) and a stats struct (st) and it fills that struct all the way up. no cap. 🔥

the ck_hs_stat structure is defined like this, exactly like this, character for character:

struct ck_hs_stat {
        unsigned long tombstones;   /* Current number of tombstones in hash set. */
        unsigned long n_entries;    /* Current number of keys in hash set. */
        unsigned int probe_maximum; /* Longest read-side probe sequence. */
};

let's break down the little trio because they each have main character energy:

• tombstones — an unsigned long, and it's the current number of tombstones in the hash set. yes bestie, tombstones. deleted-but-not-forgotten slots. RIP 🪦
• n_entries — an unsigned long, the current number of keys in the hash set. the actual population. the headcount. 👑
• probe_maximum — an unsigned int, and it's the longest read-side probe sequence. aka the worst-case amount of walking-around somebody had to do to find their stuff. the struggle was real. 😭

🍓 RETURN VALUES 🍓

ck_hs_stat(3) has no return value. it's a void girlie. it does the thing and it doesn't report back, because the whole point is that the answer is in st. periodt. 💅

💀 ERRORS 💀

listen, this is the part where you actually pay attention:

behavior is undefined if hs is uninitialized. like, undefined undefined. don't do it. 🙈

behavior is undefined if this function is called by a non-writer thread. it's a writer-thread-only situation, bestie. do not pull up with a reader thread. ⚠️

🌈 SEE ALSO 🌈

the whole friend group, go read them all:

• ck_hs_init(3)
• ck_hs_move(3)
• ck_hs_destroy(3)
• CK_HS_HASH(3)
• ck_hs_iterator_init(3)
• ck_hs_next(3)
• ck_hs_get(3)
• ck_hs_put(3)
• ck_hs_put_unique(3)
• ck_hs_set(3)
• ck_hs_fas(3)
• ck_hs_remove(3)
• ck_hs_grow(3)
• ck_hs_gc(3)
• ck_hs_rebuild(3)
• ck_hs_count(3)
• ck_hs_reset(3)
• ck_hs_reset_size(3)

more info is available at http://concurrencykit.org/ 🧚

and that's the whole page!! this one's from September 17, 2012 and it's filed under CK_HS_STAT(3) — yeah, 2012, she's an elder but she still ate 💖✨ go get those stats, bestie, iykyk 🎀