Library
Module
Module type
Parameter
Class
Class type
Low-level API for using uring directly.
type fd := Eio_unix.Fd.t
val sleep_until : Mtime.t -> unit
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.
val alloc_fixed : unit -> Uring.Region.chunk option
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.
val alloc_fixed_or_wait : unit -> Uring.Region.chunk
Like alloc_fixed
, but if there are no chunks available then it waits until one is.
val free_fixed : Uring.Region.chunk -> unit
val with_chunk : fallback:(unit -> 'a) -> (Uring.Region.chunk -> 'a) -> 'a
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 openat :
sw:Eio.Std.Switch.t ->
?seekable:bool ->
access:[ `R | `W | `RW ] ->
flags:Uring.Open_flags.t ->
perm:Unix.file_perm ->
dir_fd ->
string ->
fd
openat ~sw ~access ~flags ~perm dir path
opens dir/path
.
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 ->
fd
openat2 ~sw ~access ~flags ~perm ~resolve ~dir path
opens dir/path
.
It provides full access to the resolve flags. See Uring.openat2
for details.
val read_upto :
?file_offset:Optint.Int63.t ->
fd ->
Uring.Region.chunk ->
int ->
int
read_upto fd chunk len
reads at most len
bytes from fd
, returning as soon as some data is available.
val read_exactly :
?file_offset:Optint.Int63.t ->
fd ->
Uring.Region.chunk ->
int ->
unit
read_exactly fd chunk len
reads exactly len
bytes from fd
, performing multiple read operations if necessary.
val readv : ?file_offset:Optint.Int63.t -> fd -> Cstruct.t list -> int
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.
val write :
?file_offset:Optint.Int63.t ->
fd ->
Uring.Region.chunk ->
int ->
unit
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.
val writev : ?file_offset:Optint.Int63.t -> fd -> Cstruct.t list -> unit
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.
val writev_single : ?file_offset:Optint.Int63.t -> fd -> Cstruct.t list -> int
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
.
val connect : fd -> Unix.sockaddr -> unit
connect fd addr
attempts to connect socket fd
to addr
.
val await_readable : fd -> unit
await_readable fd
blocks until fd
is readable (or has an error).
val await_writable : fd -> unit
await_writable fd
blocks until fd
is writable (or has an error).
val fstat : fd -> Eio.File.Stat.t
Like Unix.LargeFile.fstat
.
val statx :
mask:Uring.Statx.Mask.t ->
follow:bool ->
dir_fd ->
string ->
Uring.Statx.t ->
unit
statx ~mask ~follow dir path buf
stats dir / path
.
The results are written to buf
. If follow = true
and the item is a symlink, information is reported about the target of the link. Otherwise, information about the symlink itself is returned.
val mkdir : perm:int -> dir_fd -> string -> unit
mkdir ~perm dir path
creates directory dir / path
.
val read_link : dir_fd -> string -> string
read_link dir path
reads the target of symlink dir / path
.
val unlink : rmdir:bool -> dir_fd -> string -> unit
unlink ~rmdir dir path
removes directory entry dir / path
.
If rmdir = true
then the target must be a directory. Otherwise, it must not be a directory.
rename old_dir old_path new_dir new_path
renames old_dir / old_path
as new_dir / new_path
.
val symlink : link_to:string -> dir_fd -> string -> unit
symlink ~link_to dir path
creates a new symlink at dir / path
pointing to link_to
.
val pipe : sw:Eio.Std.Switch.t -> fd * fd
pipe ~sw
returns a pair r, w
with the readable and writeable ends of a new pipe.
val read_dir : fd -> string list
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).
val lseek : fd -> Optint.Int63.t -> [ `Set | `Cur | `End ] -> Optint.Int63.t
Set and/or get the current file position.
Like Unix.lseek
.
val fsync : fd -> unit
Flush file buffers to disk.
Like Unix.fsync
.
val ftruncate : fd -> Optint.Int63.t -> unit
Set the length of a file.
Like Unix.ftruncate
.
val accept : sw:Eio.Std.Switch.t -> fd -> fd * Unix.sockaddr
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.
val shutdown : fd -> Unix.shutdown_command -> unit
Like Unix.shutdown
.
val send_msg :
fd ->
?fds:fd list ->
?dst:Unix.sockaddr ->
Cstruct.t list ->
int
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).
val recv_msg : fd -> Cstruct.t list -> Uring.Sockaddr.t * int
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 list
recv_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).
val getrandom : Cstruct.t -> unit
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.
val getaddrinfo : service:string -> string -> Eio.Net.Sockaddr.t list
getaddrinfo host
returns a list of IP addresses for host
. host
is either a domain name or an ipaddress.
module Process : sig ... end