hare

commit f22a22b30ce414242c462b125ed187131474e4be
parent 29f1637fa6a300c4e17dca352d709ad9ec0274d3
Author: Drew DeVault <sir@cmpwn.com>
Date:   Mon, 17 May 2021 18:59:34 -0400

linux::io_uring: clarify usage of registered buffers

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
M
linux/io_uring/register.ha
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/linux/io_uring/register.ha b/linux/io_uring/register.ha
@@ -4,7 +4,9 @@ use types;
 
 // Registers a set of fixed buffers with an [[io_uring]]. Note that you must
 // call [[unregister_buffers]] before registering a new set of buffers (even if
-// some of them have similar addresses to the old set).
+// some of them have similar addresses to the old set). The buffers must be
+// anonymous, non-file-backed memory (e.g. the kind returned by alloc or
+// rt::mmap).
 export fn register_buffers(ring: *io_uring, iov: []rt::iovec) (void | error) = {
 	assert(len(iov) <= types::UINT_MAX);
 	return match (rt::io_uring_register(ring.fd, regop::REGISTER_BUFFERS,