LC_MEMSYNC(3)

💖 LC_MEMSYNC 💖

okay bestie, welcome to lc_memsync(3) from the Librecast Programmer's Manual — yes that's the manual name, we're keeping it, it's giving official. this one's a libc function, section 3, and it's literally about making two memory areas match each other. slay.

✨ NAME ✨

lc_memsync — synchronize two memory areas 🫶

📚 LIBRARY 📚

Librecast library (liblibrecast, -llibrecast)

🌸 SYNOPSIS 🌸

#include <librecast/sync.h>

int lc_memsync(void *dst, void *src, const size_t n, q_t *q
               lc_stat_t *stats, lc_sync_options_t *opt, int flags);

Compile and link with -llibrecast.

🦋 DESCRIPTION 🦋

so the lc_memsync function synchronizes two non-overlapping memory areas of size n bytes using merkle tree comparison, and it overwrites dst with the bytes from src. no cap. that's the whole vibe. 💅

if q is not NULL, it has to point to a queue q_t structure that was previously initialized with q_init(3). this queue is gonna have jobs enqueued onto it to build the trees. normally you'd use this alongside a threadpool created with q_pool_create(3), where all the threads are calling q_job_seek(3). team effort, bestie. 👑

if q is NULL, then the creation and destruction of a queue and threadpool gets handled automatically. the code just does it for you, no thoughts required, main character energy. ✨

if stats is not NULL, the transfer statistics get returned in this structure. receipts. 🧾

opt is not used, at present, and must be NULL for compatibility with future versions. don't be sneaky and pass something else.

flags is not used, at present, and must be zero for compatibility with future versions. same energy, zero it out. 🙈

🎀 RETURN VALUE 🎀

lc_memsync() returns zero on success. on error, -1 is returned, and errno is set to indicate the error. classic. 😭

💀 ERRORS 💀

• EINVAL — invalid argument. the argument said no. 🚫
• ENOMEM — not enough space / cannot allocate memory (POSIX.1-2001). out of memory, it's giving tragedy. 💔

👀 SEE ALSO 👀

q_init(3), q_free(3), q_pool_create(3)

that's a wrap, bestie 🫶 this page came from the LIBRECAST crew, dated 2023-08-02, and it's filed under LC_MEMSYNC(3) — go sync some memory, you iconic thing. 💖✨