Page
Library
Module
Module type
Parameter
Class
Class type
Source
Eio_linux.Low_levelSourceLow-level API for using uring directly.
noop () performs a uring noop. This is only useful for benchmarking.
sleep_until time blocks until the current time is time.
The size of the fixed buffer is set when calling run, which attempts to allocate a fixed buffer. However, that may fail due to resource limits.
Allocate a chunk of memory from the fixed buffer.
Warning: The memory is NOT zeroed out.
Passing such memory to Linux can be faster than using normal memory, in certain cases. There is a limited amount of such memory, and this will return None if none is available at present.
Like alloc_fixed, but if there are no chunks available then it waits until one is.
with_chunk ~fallback fn runs fn chunk with a freshly allocated chunk and then frees it.
If no chunks are available, it runs fallback () instead.
val openat2 :
sw:Eio.Std.Switch.t ->
?seekable:bool ->
access:[ `R | `W | `RW ] ->
flags:Uring.Open_flags.t ->
perm:Unix.file_perm ->
resolve:Uring.Resolve.t ->
?dir:fd ->
string ->
fdopenat2 ~sw ~flags ~perm ~resolve ~dir path opens dir/path.
See Uring.openat2 for details.
read_upto fd chunk len reads at most len bytes from fd, returning as soon as some data is available.
read_exactly fd chunk len reads exactly len bytes from fd, performing multiple read operations if necessary.
readv is like read_upto but can read into any cstruct(s), not just chunks of the pre-shared buffer.
If multiple buffers are given, they are filled in order.
write fd buf len writes exactly len bytes from buf to fd.
It blocks until the OS confirms the write is done, and resubmits automatically if the OS doesn't write all of it at once.
writev is like write but can write from any cstruct(s), not just chunks of the pre-shared buffer.
If multiple buffers are given, they are sent in order. It will make multiple OS calls if the OS doesn't write all of it at once.
writev_single is like writev but only performs a single write operation. It returns the number of bytes written, which may be smaller than the requested amount.
splice src ~dst ~len attempts to copy up to len bytes of data from src to dst.
connect fd addr attempts to connect socket fd to addr.
await_readable fd blocks until fd is readable (or has an error).
await_writable fd blocks until fd is writable (or has an error).
Like Unix.LargeFile.fstat.
val statx :
?fd:fd ->
mask:Uring.Statx.Mask.t ->
string ->
Uring.Statx.t ->
Uring.Statx.Flags.t ->
unitstatx t ?fd ~mask path buf flags stats path, which is resolved relative to fd (or the current directory if fd is not given).
The results are written to buf.
read_dir dir reads all directory entries from dir. The entries are not returned in any particular order (not even necessarily the order in which Linux returns them).
Set and/or get the current file position.
Like Unix.lseek.
accept ~sw t blocks until a new connection is received on listening socket t.
It returns the new connection and the address of the connecting peer. The new connection has the close-on-exec flag set automatically. The new connection is attached to sw and will be closed when that finishes, if not already closed manually by then.
send_msg socket bufs is like writev socket bufs, but also allows setting the destination address (for unconnected sockets) and attaching FDs (for Unix-domain sockets).
recv_msg socket bufs is like readv socket bufs but also returns the address of the sender.
val recv_msg_with_fds :
sw:Eio.Std.Switch.t ->
max_fds:int ->
fd ->
Cstruct.t list ->
Uring.Sockaddr.t * int * fd listrecv_msg_with_fds is like recv_msg but also allows receiving up to max_fds file descriptors (sent using SCM_RIGHTS over a Unix domain socket).
getrandom buf fills buf with random bytes.
It uses Linux's getrandom call, which is like reading from /dev/urandom except that it will block (the whole domain) if used at early boot when the random system hasn't been initialised yet.
getaddrinfo host returns a list of IP addresses for host. host is either a domain name or an ipaddress.