io_uring_free_buf_ring(3)

🎀 io_uring_free_buf_ring — the liburing manual, but make it cute 🎀

okay bestie, so this is a page from the liburing Manual, and it's literally the ✨cleanup✨ era of your buffer ring's life. no cap.

✨ NAME ✨

io_uring_free_buf_ring — register and free a buffer ring for provided buffers 💅

🌸 SYNOPSIS 🌸

#include <liburing.h>

int io_uring_free_buf_ring(struct io_uring *ring,
                           struct io_uring_buf_ring *br,
                           unsigned int nentries,
                           int bgid);

🦋 DESCRIPTION 🦋

so the way that io_uring_free_buf_ring(3) works is: it unregisters a shared buffer ring you already registered before. and like, the ring must have previously been handed to you by io_uring_setup_buf_ring(3) — if it didn't come from there, bestie, we're not doing this 💀

here's the vibe check on the arguments:

• ring — must point to the ring that this provided buffer ring was registered for. 👑
• br — must point to a buffer ring that io_uring_setup_buf_ring(3) previously returned. no imposter rings allowed 🙈
• nentries — the number of entries you requested in that buffer ring. 🔢
• bgid — the buffer group ID that br was set up with. gotta match, fr fr. 🏷️

and under the covers? this function uses io_uring_unregister_buf_ring(3) to unregister the ring, and it handles the freeing of the ring for you instead of making your application open code it. it's giving ✨main character energy✨ — you just call it, it does the whole little cleanup routine, and you don't have to write the messy bits yourself. obsessed. 🫶

Available since 5.19. ⭐ (yes, that's kernel 5.19, so check your kernel before you get attached)

🌈 RETURN VALUE 🌈

• On success, io_uring_free_buf_ring(3) returns zero — slay. ✨
• On failure, it returns -errno — so it's negative, and the value is the errno. read it, don't ignore it. 😭

💜 SEE ALSO 💜

• io_uring_setup_buf_ring(3) — the one that gave you the ring in the first place 🎀

and that's the whole page, bestie. this was liburing-2.4, dated Mar 07, 2023 — go forth and free your buffer rings responsibly, mwah 💖✨