io_uring_sqring_wait(3)

✨ io_uring_sqring_wait ✨

okay bestie, we're in the liburing manual and today's main character is io_uring_sqring_wait(3) 💅

🎀 NAME 🎀

io_uring_sqring_wait — the girl who waits for free space in the SQ ring. yes she's patient. yes she's iconic. periodt.

🌸 SYNOPSIS 🌸

#include <liburing.h>

int io_uring_sqring_wait(struct io_uring *ring);

🦋 DESCRIPTION 🦋

so, io_uring_sqring_wait(3) lets whoever's calling it wait for space to free up in the SQ ring that belongs to the ring param 🫶 and like… when does that space free up? when the kernel side thread has consumed one or more entries. that's the whole tea ☕

and if the SQ ring is currently non-full? no action is taken. she's not gonna make you wait for nothing, she's not that kind of girl 🙈

ngl this feature is lowkey exclusive — you can only use it when the ring has been setup with IORING_SETUP_SQPOLL, meaning it's using an offloaded approach to request submissions. no SQPOLL, no sqring_wait. it's giving vip list 🎟️

👑 RETURN VALUE 👑

on success it returns the free space ✨

if the kernel does not support the feature, -EINVAL is returned 😭 (not her fault, the kernel just wasn't ready for her)

🌈 SEE ALSO 🌈

• io_uring_submit(3)
• io_uring_wait_cqe(3)
• io_uring_wait_cqes(3)

and that's the whole page, bestie 💖 this was liburing-2.1, dated January 25, 2022 — slay, bye, go wait on your SQ ring responsibly 🧚⭐