package uring

  1. Overview
  2. Docs
OCaml bindings for Linux io_uring

Install 

dune-project
 Dependency

github.com Readme Changelog ISC; MIT License Edit opam file Versions (12)

Authors

  1. A
    Anil Madhavapeddy
  2. S
    Sadiq Jaffer
  3. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

uring-2.15.0.tbz
sha256=30ad45e6d4dbbd94f9324c99af3dbcfa78f8f98a3c5717710810c782151d3186
sha512=0f101c1a68f8de1f4d05614d1284beb0755cffa82605c48df6e9b7a336249f614d0eb46f9626063ac96fca5345b248abf4cb193a9d00047bd1edb3c1aa714c7c

doc/uring/Uring/Resolve/index.html

Module Uring.ResolveSource

Flags that can be passed to openat2 to control path resolution.

include FLAGS
Sourcetype t = private int

A set of flags.

Sourceval empty : t
Sourceval of_int : int -> t

of_int i is the flags whose bits are those set in i.

Sourceval to_int : t -> int

to_int t is the integer with the bits of the flags t set.

Sourceval (+) : t -> t -> t

a + b is the union of the sets.

Sourceval mem : t -> t -> bool

mem x flags is true iff x is a subset of flags.

Sourceval (=) : t -> t -> bool

a = b is true iff a and b are the same set of flags.

Sourceval beneath : t

beneath does not permit path resolution to succeed if any component of the resolution is not a descendant of the directory indicated by the dirfd passed to the open call. Absolute symbolic links and absolute pathnames will be rejected.

For maximum compatiblity with future Linux kernels, the no_magiclinks flag should be specified along with this one.

Sourceval in_root : t

in_root treats the dirfd directory as the root directory while resolving the pathname. Absolute symbolic links are interpreted relative to the dirfd. If a prefix component of the pathname equates to the dirfd, then an immediately following .. component likewise equates to the dirfd (just as /.. is traditionally equivalent to /). An absolute pathname is interpreted relative to the dirfd.

For maximum compatiblity with future Linux kernels, the no_magiclinks flag should be specified along with this one.

no_magiclinks disallows all magic-link resolution during path resolution. Magic-links are symbolic link-like objects that are usually found in the /proc filesystem. Unknowingly opening magic links can be risky for some applications, notably those without a controlling terminal or those within a containerised environment that may provide an escape vector.

no_symlinks disallows the resolution of symbolic links during path resolution, and implies the use of no_magiclinks. If the basename component of the pathname is a symlink, and no_symlinks is specified along with Open_flags.path and Open_flags.nofollow, then a fd referencing the symbolic link will be returned.

Note that the no_symlinks flag affects the treatment of symbolic links in all of the components of pathname. This differs from the effect of the Open_flags.nofollow file creation flag, which affects the handling of symbolic links only in the final component of the pathname.

Sourceval no_xdev : t

no_xdev disallows the traversal of mount points during path resolution, including bind mounts The pathname must either be on the same mount as the directory referred to by the dirfd, or on the same mount as the current working directory if dirfd is not specified.

Sourceval cached : t

cached makes the open operation fail unless all path components are already present in the kernel lookup cache. Any revalidation or IO needed to satisfy the lookup will result in a Unix.error.EAGAIN error.