package uring

  1. Overview
  2. Docs
OCaml bindings for Linux io_uring

Install

Dune Dependency

github.com Readme Changelog (ISC AND MIT) License Edit opam file Versions (8)

Authors

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

Maintainers

  1. A
    anil@recoil.org

Sources

uring-0.3.tbz
sha256=47c225fce95ad34dd38c35f30724f7d8111afd4370d301985abc720747c6d746
sha512=af093ea00aa57d02a32f27708a3a6ebc9e3b6d509ecbe0c88b0ba85ec57a23131c51c5009b40a3ef4a63568ad9d2793bff73e7cf7ba149b9ea5ce12b41d2aafa

Description

Bindings to the Linux io_uring kernel IO interfaces. See https://github.com/ocaml-multicore/eio for a higher-level API using this.

Published: 02 Mar 2022

README

ocaml-uring -- bindings to Linux io_uring

These are OCaml bindings for the Linux io_uring stack (an alternative to using syscalls such as select or epoll).

The Eio library provides a higher-level effects-based API that uses this library to implement its Linux backend, but ocaml-uring may be useful with single-core non-effects versions of OCaml too.

To use the library directly:

  1. Call Uring.create to initialise a ring.

  2. Add IO requests to the ring using functions such as Uring.readv.

  3. Call Uring.submit to notify the kernel of the new requests.

  4. Call Uring.wait to wait until an operation is complete.

The tests directory contains some examples.

License

This library is released under the ISC license (see LICENSE.md), but note that the repository also vendors liburing - see vendor/liburing/README.

Dependencies (6)

  1. optint >= "0.1.0"
  2. fmt >= "0.8.10"
  3. dune-configurator
  4. ocaml >= "4.12.0"
  5. cstruct >= "6.0.1"
  6. dune >= "2.7"

Dev Dependencies (8)

  1. odoc with-doc
  2. alcotest >= "1.4.0" & with-test
  3. cmdliner with-test & >= "1.1.0"
  4. logs with-test & >= "0.5.0"
  5. bechamel >= "0.1.0" & with-test
  6. bechamel-notty >= "0.1.0" & with-test
  7. notty >= "0.2.2" & with-test
  8. lwt with-test & >= "5.0.0"

Used by (1)

  1. eio_linux >= "0.2" & < "0.5"

Conflicts

None