uringmachine 0.1

data/test/test_um.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'socket'
+
+class SleepTest < UMBaseTest
+  def test_sleep
+    t0 = monotonic_clock
+    res = machine.sleep(0.1)
+    t1 = monotonic_clock
+    assert_in_range 0.09..0.13, t1 - t0
+    assert_equal 0.1, res
+  end
+end
+
+class SchedulingTest < UMBaseTest
+  def test_schedule_and_yield
+    buf = []
+    cur = Fiber.current
+    f = Fiber.new do |x|
+      buf << [21, x]
+      machine.schedule(cur, 21)
+      buf << 22
+      x = machine.yield
+      buf << [23, x]
+    end
+
+    buf << 11
+    machine.schedule(f, 11)
+    buf << 12
+    x = machine.yield
+    buf << [13, x]
+
+    assert_equal [11, 12, [21, 11], 22, [13, 21]], buf
+  end
+
+  class CustomError < Exception
+  end
+
+  def test_schedule_exception
+    buf = []
+    f = Fiber.new do
+      # this should raise
+      machine.yield
+    rescue Exception => e
+      buf << e
+      machine.yield
+    end
+    
+    machine.schedule(f, nil)
+    # start the f fiber
+    machine.snooze
+
+    # f fiber has yielded
+    e = CustomError.new
+    machine.schedule(f, e)
+    machine.snooze
+
+    assert_equal [e], buf
+  end
+
+  def test_interrupt
+    cur = Fiber.current
+    e = CustomError.new
+    f = Fiber.new do
+      machine.interrupt(cur, e)
+      assert_equal 2, machine.pending_count
+      machine.yield
+    end
+    
+    machine.schedule(f, nil)
+    t0 = monotonic_clock
+
+    # the call to schedule means an op is checked out
+    assert_equal 1, machine.pending_count
+    begin
+      machine.sleep(1)
+    rescue Exception => e2
+    end
+    # the sleep op has been cancelled, but we still need to process the
+    # cancellation. Calling snooze should take care of that.
+    assert_equal 1, machine.pending_count
+    machine.snooze
+
+    # CQE should have been received, and the op checked in
+    assert_equal 0, machine.pending_count
+    t1 = monotonic_clock
+
+    assert_equal e2, e
+    assert_in_range 0..0.1, t1 - t0
+  end
+
+  class TOError < RuntimeError; end
+
+  def test_timeout
+    buf = []
+    begin
+      buf << 1
+      machine.timeout(0.01, TOError) do
+        buf << 2
+        machine.sleep(1)
+        buf << 3
+      end
+      buf << 4
+    rescue => e
+      buf << 5
+    end
+
+    # at this point, the sleep cancelled CQE should not yet have been received.
+    # So we still have a pending operation. Snooze should have let the CQE be
+    # received.
+    assert_equal 1, machine.pending_count
+    machine.snooze
+    assert_equal 0, machine.pending_count
+
+    assert_equal [1, 2, 5], buf
+    assert_kind_of TOError, e
+  end
+
+  def test_timeout_with_raising_block
+    e = nil
+    v = begin
+      machine.timeout(0.01, TOError) do
+        raise 'hi'
+      end
+    rescue => e
+    end
+
+    assert_equal 1, machine.pending_count
+    machine.snooze
+    assert_equal 0, machine.pending_count
+
+    assert_kind_of RuntimeError, e
+    assert_equal 'hi', e.message
+  end
+
+  def test_timeout_with_nothing_blocking
+    v = machine.timeout(0.01, TOError) { 42 }
+
+    assert_equal 42, v
+
+    assert_equal 1, machine.pending_count
+    machine.snooze
+    assert_equal 0, machine.pending_count
+  end
+
+  class TO2Error < RuntimeError; end
+  class TO3Error < RuntimeError; end
+
+  def test_timeout_nested
+    e = nil
+    buf = []
+    begin
+      machine.timeout(0.04, TOError) do
+        machine.timeout(0.02, TO2Error) do
+          machine.timeout(0.03, TO3Error) do
+            buf << machine.pending_count
+            machine.sleep(1)
+          end
+        end
+      end
+    rescue => e
+    end
+
+    assert_kind_of TO2Error, e
+    assert_equal [3], buf
+  end
+end

data/uringmachine.gemspec

@@ -0,0 +1,27 @@
+require_relative './lib/uringmachine/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'uringmachine'
+  s.version     = UM_VERSION
+  s.licenses    = ['MIT']
+  s.summary     = 'A lean, mean io_uring machine'
+  s.author      = 'Sharon Rosner'
+  s.email       = 'sharon@noteflakes.com'
+  s.files       = `git ls-files --recurse-submodules`.split.reject { |fn| fn =~ /liburing\/man/ }
+  s.homepage    = 'https://github.com/digital-fabric/uringmachine'
+  s.metadata    = {
+    "source_code_uri" => "https://github.com/digital-fabric/uringmachine",
+    "documentation_uri" => "https://www.rubydoc.info/gems/uringmachine",
+    "changelog_uri" => "https://github.com/digital-fabric/uringmachine/blob/master/CHANGELOG.md"
+  }
+  s.rdoc_options = ["--title", "UringMachine", "--main", "README.md"]
+  s.extra_rdoc_files = ["README.md"]
+  s.extensions = ["ext/um/extconf.rb"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 3.3'
+
+  s.add_development_dependency  'rake-compiler',        '1.2.7'
+  s.add_development_dependency  'minitest',             '5.25.1'
+  s.add_development_dependency  'http_parser.rb',       '0.8.0'
+  s.add_development_dependency  'benchmark-ips',        '2.10.0'
+end

data/vendor/liburing/.github/actions/codespell/stopwords

@@ -0,0 +1,7 @@
+bu
+cancelation
+cancelations
+cant
+pring
+sring
+wont

data/vendor/liburing/.github/pull_request_template.md

@@ -0,0 +1,86 @@
+
+<!-- Explain your changes here... -->
+
+----
+## git request-pull output:
+```
+<!-- START REPLACE ME -->
+
+Generate your PR shortlog and diffstat with these commands:
+   git remote add axboe-tree https://github.com/axboe/liburing
+   git fetch axboe-tree
+   git request-pull axboe-tree/master your_fork_URL your_branch_name
+
+Then replace this with the output of `git request-pull` command.
+
+<!-- END REPLACE ME -->
+```
+----
+<details>
+<summary>Click to show/hide pull request guidelines</summary>
+
+## Pull Request Guidelines
+1. To make everyone easily filter pull request from the email
+notification, use `[GIT PULL]` as a prefix in your PR title.
+```
+[GIT PULL] Your Pull Request Title
+```
+2. Follow the commit message format rules below.
+3. Follow the Linux kernel coding style (see: https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst).
+
+### Commit message format rules:
+1. The first line is title (don't be more than 72 chars if possible).
+2. Then an empty line.
+3. Then a description (may be omitted for truly trivial changes).
+4. Then an empty line again (if it has a description).
+5. Then a `Signed-off-by` tag with your real name and email. For example:
+```
+Signed-off-by: Foo Bar <foo.bar@gmail.com>
+```
+
+The description should be word-wrapped at 72 chars. Some things should
+not be word-wrapped. They may be some kind of quoted text - long
+compiler error messages, oops reports, Link, etc. (things that have a
+certain specific format).
+
+Note that all of this goes in the commit message, not in the pull
+request text. The pull request text should introduce what this pull
+request does, and each commit message should explain the rationale for
+why that particular change was made. The git tree is canonical source
+of truth, not github.
+
+Each patch should do one thing, and one thing only. If you find yourself
+writing an explanation for why a patch is fixing multiple issues, that's
+a good indication that the change should be split into separate patches.
+
+If the commit is a fix for an issue, add a `Fixes` tag with the issue
+URL.
+
+Don't use GitHub anonymous email like this as the commit author:
+```
+123456789+username@users.noreply.github.com
+```
+
+Use a real email address!
+
+### Commit message example:
+```
+src/queue: don't flush SQ ring for new wait interface
+
+If we have IORING_FEAT_EXT_ARG, then timeouts are done through the
+syscall instead of by posting an internal timeout. This was done
+to be both more efficient, but also to enable multi-threaded use
+the wait side. If we touch the SQ state by flushing it, that isn't
+safe without synchronization.
+
+Fixes: https://github.com/axboe/liburing/issues/402
+Signed-off-by: Jens Axboe <axboe@kernel.dk>
+```
+
+</details>
+
+----
+## By submitting this pull request, I acknowledge that:
+1. I have followed the above pull request guidelines.
+2. I have the rights to submit this work under the same license.
+3. I agree to a Developer Certificate of Origin (see https://developercertificate.org for more information).

data/vendor/liburing/.github/workflows/build.yml

@@ -0,0 +1,137 @@
+name: Build test
+
+on:
+  # Trigger the workflow on push or pull requests.
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # x86-64 gcc
+          - arch: x86_64
+            cc_pkg: gcc-x86-64-linux-gnu
+            cxx_pkg: g++-x86-64-linux-gnu
+            cc: x86_64-linux-gnu-gcc
+            cxx: x86_64-linux-gnu-g++
+
+          # x86-64 clang
+          - arch: x86_64
+            cc_pkg: clang
+            cxx_pkg: clang
+            cc: clang
+            cxx: clang++
+            liburing_extra_flags: -Wshorten-64-to-32
+            extra_flags: -Wmissing-prototypes -Wstrict-prototypes -Wunreachable-code-loop-increment -Wunreachable-code -Wmissing-variable-declarations -Wextra-semi-stmt
+
+          # x86 (32-bit) gcc
+          - arch: i686
+            cc_pkg: gcc-i686-linux-gnu
+            cxx_pkg: g++-i686-linux-gnu
+            cc: i686-linux-gnu-gcc
+            cxx: i686-linux-gnu-g++
+
+          # aarch64 gcc
+          - arch: aarch64
+            cc_pkg: gcc-aarch64-linux-gnu
+            cxx_pkg: g++-aarch64-linux-gnu
+            cc: aarch64-linux-gnu-gcc
+            cxx: aarch64-linux-gnu-g++
+
+          # arm (32-bit) gcc
+          - arch: arm
+            cc_pkg: gcc-arm-linux-gnueabi
+            cxx_pkg: g++-arm-linux-gnueabi
+            cc: arm-linux-gnueabi-gcc
+            cxx: arm-linux-gnueabi-g++
+
+          # riscv64
+          - arch: riscv64
+            cc_pkg: gcc-riscv64-linux-gnu
+            cxx_pkg: g++-riscv64-linux-gnu
+            cc: riscv64-linux-gnu-gcc
+            cxx: riscv64-linux-gnu-g++
+
+          # powerpc64
+          - arch: powerpc64
+            cc_pkg: gcc-powerpc64-linux-gnu
+            cxx_pkg: g++-powerpc64-linux-gnu
+            cc: powerpc64-linux-gnu-gcc
+            cxx: powerpc64-linux-gnu-g++
+
+          # powerpc
+          - arch: powerpc
+            cc_pkg: gcc-powerpc-linux-gnu
+            cxx_pkg: g++-powerpc-linux-gnu
+            cc: powerpc-linux-gnu-gcc
+            cxx: powerpc-linux-gnu-g++
+
+          # alpha
+          - arch: alpha
+            cc_pkg: gcc-alpha-linux-gnu
+            cxx_pkg: g++-alpha-linux-gnu
+            cc: alpha-linux-gnu-gcc
+            cxx: alpha-linux-gnu-g++
+
+          # mips64
+          - arch: mips64
+            cc_pkg: gcc-mips64-linux-gnuabi64
+            cxx_pkg: g++-mips64-linux-gnuabi64
+            cc: mips64-linux-gnuabi64-gcc
+            cxx: mips64-linux-gnuabi64-g++
+
+          # mips
+          - arch: mips
+            cc_pkg: gcc-mips-linux-gnu
+            cxx_pkg: g++-mips-linux-gnu
+            cc: mips-linux-gnu-gcc
+            cxx: mips-linux-gnu-g++
+
+          # hppa
+          - arch: hppa
+            cc_pkg: gcc-hppa-linux-gnu
+            cxx_pkg: g++-hppa-linux-gnu
+            cc: hppa-linux-gnu-gcc
+            cxx: hppa-linux-gnu-g++
+
+    env:
+      FLAGS: -g -O3 -Wall -Wextra -Werror -Wno-sign-compare ${{matrix.extra_flags}}
+
+      # Flags for building sources in src/ dir only.
+      LIBURING_CFLAGS: ${{matrix.liburing_extra_flags}}
+
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4
+
+    - name: Install Compilers
+      run: |
+        if [[ "${{matrix.cc_pkg}}" == "clang" ]]; then \
+            wget https://apt.llvm.org/llvm.sh -O /tmp/llvm.sh; \
+            sudo apt-get purge --auto-remove llvm python3-lldb-14 llvm-14 -y; \
+            sudo bash /tmp/llvm.sh 17; \
+            sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-17 400; \
+            sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-17 400; \
+        else \
+            sudo apt-get update -y; \
+            sudo apt-get install -y ${{matrix.cc_pkg}} ${{matrix.cxx_pkg}}; \
+        fi;
+
+    - name: Display compiler versions
+      run: |
+        ${{matrix.cc}} --version;
+        ${{matrix.cxx}} --version;
+
+    - name: Build
+      run: |
+        ./configure --cc=${{matrix.cc}} --cxx=${{matrix.cxx}};
+        make -j$(nproc) V=1 CPPFLAGS="-Werror" CFLAGS="$FLAGS" CXXFLAGS="$FLAGS";
+
+    - name: Test install command
+      run: |
+        sudo make install;

data/vendor/liburing/.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+name: Codespell
+
+on:
+  # Trigger the workflow on push or pull requests.
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4
+
+    - name: Install codespell
+      run: |
+        sudo apt-get update -y
+        sudo apt-get install -y codespell
+
+    - name: Display codespell version
+      run: codespell --version
+
+    - name: Execute codespell
+      run: codespell --ignore-words=.github/actions/codespell/stopwords .

data/vendor/liburing/.github/workflows/shellcheck.yml

@@ -0,0 +1,20 @@
+name: Shellcheck
+
+on:
+  # Trigger the workflow on push or pull requests.
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4
+
+    - name: Display shellcheck version
+      run: shellcheck --version
+
+    - name: Shellcheck execution
+      run: shellcheck test/runtest*.sh

data/vendor/liburing/.gitignore

@@ -0,0 +1,41 @@
+*.rej
+*.orig
+*~
+/*.patch
+
+*.d
+*.o
+*.o[ls]
+
+/src/liburing.a
+/src/liburing.so*
+/src/liburing-ffi.a
+/src/liburing-ffi.so*
+/src/include/liburing/compat.h
+/src/include/liburing/io_uring_version.h
+
+/examples/io_uring-close-test
+/examples/io_uring-cp
+/examples/io_uring-test
+/examples/io_uring-udp
+/examples/link-cp
+/examples/napi-busy-poll-client
+/examples/napi-busy-poll-server
+/examples/ucontext-cp
+/examples/poll-bench
+/examples/proxy
+/examples/send-zerocopy
+/examples/rsrc-update-bench
+
+/test/*.t
+/test/*.dmesg
+/test/output/
+
+config-host.h
+config-host.mak
+config.log
+
+liburing.pc
+liburing-ffi.pc
+
+cscope.out

data/vendor/liburing/CHANGELOG

@@ -0,0 +1,111 @@
+liburing-2.7 release
+
+- Man page updates
+- Sync with kernel 6.10
+	- send/recv bundle support
+	- accept nowait and CQE_F_MORE
+- Add and update test cases
+- Fix io_uring_queue_init_mem() returning a value that was too small,
+  potentially causing memory corruption in userspace by overwriting
+  64 bytes beyond the returned value. Also add test case for that.
+- Add 64-bit length variants of io_uring_prep_{m,f}advise()
+- Add BIND/LISTEN support and helpers / man pages
+- Add io_uring_enable_rings.3 man page
+- Fix bug in io_uring_prep_read_multishot()
+- Fixup bundle test cases
+- Add fixed-hugepage test case
+- Fix io_uring_prep_fixed_fd_install.3 man page
+- Note 'len' == 0 requirement in io_uring_prep_send.3 man page
+- Fix some test cases for skipping on older kernels
+
+liburing-2.6 release
+
+- Add getsockopt and setsockopt socket commands
+- Add test cases to test/hardlink
+- Man page fixes
+- Add futex support, and test cases
+- Add waitid support, and test cases
+- Add read multishot, and test cases
+- Add support for IORING_SETUP_NO_SQARRAY
+- Use IORING_SETUP_NO_SQARRAY as the default
+- Add support for IORING_OP_FIXED_FD_INSTALL
+- Add io_uring_prep_fixed_fd_install() helper
+- Support for napi busy polling
+- Improve/add test cases
+- Man page fixes
+- Add sample 'proxy' example
+
+liburing-2.5 release
+
+- Add support for io_uring_prep_cmd_sock()
+- Add support for application allocated ring memory, for placing rings
+  in huge mem. Available through io_uring_queue_init_mem().
+- Add support for registered ring fds
+- Various documentation updates
+- Various fixes
+
+liburing-2.4 release
+
+- Add io_uring_{major,minor,check}_version() functions.
+- Add IO_URING_{MAJOR,MINOR,CHECK}_VERSION() macros.
+- FFI support (for non-C/C++ languages integration).
+- Add io_uring_prep_msg_ring_cqe_flags() function.
+- Deprecate --nolibc configure option.
+- CONFIG_NOLIBC is always enabled on x86-64, x86, and aarch64.
+- Add support for IORING_REGISTER_USE_REGISTERED_RING and use if available.
+- Add io_uring_close_ring_fd() function.
+- Add io_uring_prep_msg_ring_fd_alloc function.
+- Add io_uring_free_buf_ring() and io_uring_setup_buf_ring() functions.
+- Ensure that io_uring_prep_accept_direct(), io_uring_prep_openat_direct(),
+  io_uring_prep_openat2_direct(), io_uring_prep_msg_ring_fd(), and
+  io_uring_prep_socket_direct() factor in being called with
+  IORING_FILE_INDEX_ALLOC for allocating a direct descriptor.
+- Add io_uring_prep_sendto() function.
+- Add io_uring_prep_cmd_sock() function.
+
+liburing-2.3 release
+
+- Support non-libc build for aarch64.
+- Add io_uring_{enter,enter2,register,setup} syscall functions.
+- Add sync cancel interface, io_uring_register_sync_cancel().
+- Fix return value of io_uring_submit_and_wait_timeout() to match the
+  man page.
+- Improvements to the regression tests
+- Add support and test case for passthrough IO
+- Add recv and recvmsg multishot helpers and support
+- Add documentation and support for IORING_SETUP_DEFER_TASKRUN
+- Fix potential missing kernel entry with IORING_SETUP_IOPOLL
+- Add support and documentation for zero-copy network transmit
+- Various optimizations
+- Many cleanups
+- Many man page additions and updates
+
+liburing-2.2 release
+
+- Support non-libc builds.
+- Optimized syscall handling for x86-64/x86/aarch64.
+- Enable non-lib function calls for fast path functions.
+- Add support for multishot accept.
+- io_uring_register_files() will set RLIMIT_NOFILE if necessary.
+- Add support for registered ring fds, io_uring_register_ring_fd(),
+  reducing the overhead of an io_uring_enter() system call.
+- Add support for the message ring opcode.
+- Add support for newer request cancelation features.
+- Add support for IORING_SETUP_COOP_TASKRUN, which can help reduce the
+  overhead of io_uring in general. Most applications should set this flag,
+  see the io_uring_setup.2 man page for details.
+- Add support for registering a sparse buffer and file set.
+- Add support for a new buffer provide scheme, see
+  io_uring_register_buf_ring.3 for details.
+- Add io_uring_submit_and_wait_timeout() for submitting IO and waiting
+  for completions with a timeout.
+- Add io_uring_prep_{read,write}v2 prep helpers.
+- Add io_uring_prep_close_direct() helper.
+- Add support for SQE128 and CQE32, which are doubly sized SQE and CQE
+  rings. This is needed for some cases of the new IORING_OP_URING_CMD,
+  notably for NVMe passthrough.
+- ~5500 lines of man page additions, including adding ~90 new man pages.
+- Synced with the 5.19 kernel release, supporting all the features of
+  5.19 and earlier.
+- 24 new regression test cases, and ~7000 lines of new tests in general.
+- General optimizations and fixes.

data/vendor/liburing/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+preferred-citation:
+type: software
+authors:
+  - family-names: "Axboe"
+    given-names: "Jens"
+    email: axboe@kernel.dk
+title: "liburing library for io_uring"
+year: 2022
+url: "https://github.com/axboe/liburing"
+licence: MIT