CK_HT_GROW_SPMC(3)

💖 ck_ht_grow_spmc(3) — the manual page, but make it make sense 💖

okay bestie, so this is ck_ht_grow_spmc, and it lives in section 3 of the manual (the "library functions" section, iykyk). it's a Concurrency Kit thing, and no cap, it's genuinely useful. let's get into it 🫶

🌸 LIBRARY 🌸

Concurrency Kit — that's libck, and you link it with -lck. periodt. 💅

✨ SYNOPSIS ✨

#include <ck_ht.h>

bool
ck_ht_grow_spmc(ck_ht_t *ht, uint64_t capacity);

like… that's the whole vibe. two arguments, one bool coming back at you. 🎀

🦋 DESCRIPTION 🦋

so here's the tea, bestie: ck_ht_grow_spmc() resizes the hash table so that it can hold at least the number of entries you passed in as capacity — and it does that at a load factor of one. slay.

but wait, there's lore. the default load factor of a ck_ht hash table is 0.5. so if you're out here trying to minimize the likelihood of memory allocations for a hash table that's meant to store n entries, you should pass a capacity of 2n. do the math, trust. 🧮✨

also, the default behavior of ck_ht is to round capacity to the next available power of two if it isn't already a power of two. so don't come for it when your numbers shift — that's just how it do. 😌

and the moment you've all been waiting for: this function is safe to call in the presence of concurrent ck_ht_get_spmc(3) operations. concurrency? handled. main character energy only. 👑

💜 RETURN VALUES 💜

• on a successful completion, ck_ht_grow_spmc() returns true 🎉
• otherwise it returns a false value 😭

that's it. that's the return value situation. fr fr.

💀 ERRORS 💀

⚠️ behavior is undefined if ht is uninitialized. like, don't do that. don't be that girl.

the function will only return false if there are internal memory allocation failures. that's the only reason. no other drama. 🙈

🔥 SEE ALSO 🔥

the whole friend group, in alphabetical-ish order, exactly as the original intended:

• 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_gc(3)
• ck_ht_get_spmc(3)
• ck_ht_remove_spmc(3)
• ck_ht_reset_spmc(3)
• ck_ht_reset_size_spmc(3)
• ck_ht_count(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)

and if you want even more info, the original says it's available at http://concurrencykit.org/ 🌈 — go read up, bestie, knowledge is free and it's giving scholar.

and that's a wrap on the ck_ht_grow_spmc(3) manual page 🎀✨ this version is from March 29, 2012, and it ships with Concurrency Kit — so if you're repping that libck life, you're in the right place. stay growing, stay concurrent, stay iconic. mwah 💅💖