CK_HT_GC(3)

💖 CK_HT_GC — bestie edition 💖

okay so you found the ck_ht_gc page, that's the Concurrency Kit manual (CK_HT_GC(3)) and honestly? it's giving "janitor of the hash table" and I'm obsessed. ✨

🌸 LIBRARY 🌸

Concurrency Kit — link it like libck, -lck 💅

✨ SYNOPSIS ✨

#include <ck_ht.h>

bool
ck_ht_gc(ck_ht_t *ht, unsigned long cycles, unsigned long seed);

yes bestie, one function, three args, bool return. we love a clean signature. 🎀

🦋 DESCRIPTION 🦋

so ck_ht_gc() is the lil glow-up routine for your hash table — it runs a bunch of maintenance tasks on the table that ht points to. what kind of maintenance, you ask? 👀

• defragmentation of probe sequences with respect to tombstones 💀 (yes, tombstones, it's giving haunted house but make it data structures)
• and recalculation of probe sequence bounds — but only in the case that the delete workload hint has been passed. no hint, no bounds recalc. periodt.

now let's talk args because the details matter:

• cycles — tells the function how many hash table entries should be subject to attempted maintenance. and if cycles is 0, then maintenance is performed on the complete hash table. the whole thing. full send. 🔥
• seed — determines the start location of the maintenance process. and if cycles is non-zero, it is recommended that seed is some random value. yes, recommended. random seed, bestie, do it. 🎲

⚠️ heads up, this one's important: if the delete hint has been passed, the function will require an additional 12% of memory (with respect to existing memory usage of the set), until operation completion. twelve percent!! budget for it, queen. 😭

👑 RETURN VALUES 👑

• upon successful completion, ck_ht_gc(3) returns true 🫶
• otherwise it returns false on failure due to memory allocation failure. sad girl hours. 🙈

🌈 ERRORS 🌈

this function will only return false if there are internal memory allocation failures. that's it, that's the whole list. no other drama. 💅

⭐ SEE ALSO ⭐

the whole friend group, go say hi:

• ck_ht_count(3)
• ck_ht_stat(3)
• ck_ht_init(3)
• ck_ht_destroy(3)
• ck_ht_hash(3)
• ck_ht_hash_direct(3)
• ck_ht_set_spmc(3)
• ck_ht_put_spmc(3)
• ck_ht_get_spmc(3)
• ck_ht_grow_spmc(3)
• ck_ht_remove_spmc(3)
• ck_ht_reset_size_spmc(3)
• ck_ht_reset_spmc(3)
• ck_ht_entry_empty(3)
• ck_ht_entry_key_set(3)
• ck_ht_entry_key_set_direct(3)
• ck_ht_entry_key(3)
• ck_ht_entry_key_length(3)
• ck_ht_entry_value(3)
• ck_ht_entry_set(3)
• ck_ht_entry_set_direct(3)
• ck_ht_entry_key_direct(3)
• ck_ht_entry_value_direct(3)
• ck_ht_iterator_init(3)
• ck_ht_next(3)

additional information available at http://concurrencykit.org/ 🌐

and that's the tea, bestie — this page is from the Concurrency Kit (libck), dated December 18, 2013, filed under CK_HT_GC(3). go gc your hash table, you're doing amazing sweetie 💖✨🎀