uringmachine 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c6af55ee77291dcf17471dde7dd9d68b731fd9a8dea4d1dccdcc09b325b9163
-  data.tar.gz: 516624d1a86287bbd0978d5aaf0cca540063ca7f6aa4cf2bab8cb9f23214d32d
+  metadata.gz: 299bd9cc7810b3d67352cf1c35e1bad8228d26dc1495d2e03e8283299347836a
+  data.tar.gz: 1241fd5922a26d0223a6d345984e7548bb4486160a5f7f70cb25f4356cde4736
 SHA512:
-  metadata.gz: e9d845525499342080228b44afb5cabb84af6bb0cb14081cc5e4e2eb627ab638312c0df818f5d109ab99d6e34a299bb21da23711f131f4a9641d688cee5cf35e
-  data.tar.gz: d67d15b398bac118b85219be3669a1479eba68e5d93ceb2e3f598238ae2fbefd7cf83dcffa132fe12ed0b0385d675c15e7f89a05150290da6fbc4d8bc40a1431
+  metadata.gz: 0075bd142ba474e475eb53fca3eb8e88bbb5fdba8214d7832b34582f3089e2720e99e069f49d7244b2c2cd9f5536ca5113589b9a5658d3f3679e3d6352043e1d
+  data.tar.gz: fe68ab2c66601a0aa5786e86b86173b5c6b94a1f58d0a7151546c4c596b1d625912ebd32670c8230ab301886f3a6a0a35edff1cd7a472f5253cb181e0156a1f7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.32.0 2026-04-03
+
+- Rename `UM::Connection` to `UM::IO`
+
 # 0.31.0 2026-03-31
 
 - Rework `Stream` into `Connection` class:

data/README.md

@@ -37,7 +37,7 @@ implementation that allows integration with the entire Ruby ecosystem.
 - Excellent performance characteristics for concurrent I/O-bound applications.
 - `Fiber::Scheduler` implementation to automatically integrate with the Ruby
   ecosystem in a transparent fashion.
-- [Connection](#connections) class with automatic buffer management for reading.
+- [IO](#io-api) class with automatic buffer management for reading.
 - Optimized I/O for encrypted SSL connections.
 
 ## Design
@@ -286,70 +286,69 @@ fiber = Fiber.schedule do
 end
 ```
 
-## Connections
+## IO API
 
-`UringMachine::Connection` is a class designed for efficiently read from and
-write to a socket or other file descriptor. Connections are ideal for
-implementing the read side of protocols, and provide an API that is useful for
-both line-based protocols and binary (frame-based) protocols.
+`UringMachine::IO` is a class designed for efficiently read from and write to a
+socket or other file descriptor. The IO class is ideal for implementing
+line-based and binary (frame-based) protocols.
 
-A connection is associated with a UringMachine instance and a target file
-descriptor (or SSL socket, see also [connection modes](#connection-modes)
-below). Behind the scenes, connections take advantage of io_uring's registered
-buffers feature, and more recently, the introduction of [incremental buffer
+An IO is associated with a UringMachine instance and a target file descriptor
+(or SSL socket, see also [IO modes](#io-modes) below). Behind the scenes, the IO
+class takes advantage of io_uring's provided buffers feature, and more recently,
+the introduction of [incremental buffer
 consumption](https://github.com/axboe/liburing/wiki/What's-new-with-io_uring-in-6.11-and-6.12#incremental-provided-buffer-consumption).
 
-When connections are used, UringMachine automatically manages the buffers it
+When IO instances are used, UringMachine automatically manages the buffers it
 provides to the kernel, maximizing buffer reuse and minimizing allocations.
 UringMachine also responds to stress conditions (increased incoming traffic) by
 automatically provisioning additional buffers.
 
-To create a connection for a given fd, use `UM#connection`:
+To create an IO for a given fd, use `UM#io`:
 
 ```ruby
-conn = machine.connection(fd)
+io = machine.io(fd)
 
-# you can also provide a block that will be passed the connection instance:
-machine.connection(fd) { |c| do_something_with(c) }
+# you can provide a block that will be passed the IO instance:
+machine.io(fd) { |io| do_something_with(io) }
 
-# you can also instantiate a connection directly:
-conn = UM::Connection.new(machine, fd)
+# you can also instantiate an IO directly:
+io = UM::IO.new(machine, fd)
 ```
 
-The following API is used to interact with the connection:
+The following API is used to interact with an IO:
 
 ```ruby
 # Read until a newline character is encountered:
-line = conn.read_line(0)
+line = io.read_line(0)
 
 # Read line with a maximum length of 13 bytes:
-line = conn.read_line(13)
+line = io.read_line(13)
 
 # Read all data:
-buf = conn.read(0)
+buf = io.read(0)
 
 # Read exactly 13 bytes:
-buf = conn.read(13)
+buf = io.read(13)
 
 # Read up to 13 bytes:
-buf = conn.read(-13)
+buf = io.read(-13)
 
 # Read continuously until EOF
-conn.read_each { |data| ... }
+io.read_each { |data| ... }
 
 # Skip 3 bytes:
-conn.skip(3)
+io.skip(3)
 
 # Write
-conn.write('foo', 'bar', 'baz')
+io.write('foo', 'bar', 'baz')
 ```
 
 Here's an example of a how a basic HTTP request parser might be implemented
-using a connection:
+using a `UM::IO`:
 
 ```ruby
-def parse_http_request_headers(conn)
-  request_line = conn.read_line(0)
+def parse_http_request_headers(io)
+  request_line = io.read_line(0)
   m = request_line.match(REQUEST_LINE_RE)
   return nil if !m
 
@@ -360,7 +359,7 @@ def parse_http_request_headers(conn)
   }
 
   while true
-    line = conn.read_line(0)
+    line = io.read_line(0)
     break if !line || line.empty?
 
     m = line.match(HEADER_RE)
@@ -370,26 +369,26 @@ def parse_http_request_headers(conn)
 end
 ```
 
-### Connection modes
+### IO modes
 
-Connection modes allow connections to be transport agnostic. Currently
-connections support three modes:
+IO modes allow IOs to be transport agnostic. The following modes are currently
+supported:
 
 - `:fd` - use the buffer pool, read data using multishot read
   (this is the default mode).
 - `:socket` - use the buffer pool, read data using multishot recv.
 - `:ssl` - read from an `SSLSocket` object.
 
-The mode is specified as an additional argument to `Connection.new`:
+The mode is specified as an additional argument to `IO.new`:
 
 ```ruby
 # using recv/send:
-conn = machine.connection(fd, :socket)
+io = machine.io(fd, :socket)
 
 # SSL I/O:
-conn = machine.connection(ssl, :ssl)
+io = machine.io(ssl, :ssl)
 # or simply:
-conn = machine.connection(ssl)
+io = machine.io(ssl)
 ```
 
 ## Performance

data/TODO.md

@@ -1,63 +1,28 @@
-## immediate
-
-- Add tests for support for Set in `machine#await`
-- Add tests for support for Set, Array in `machine#join`
-- Add `UM#read_file` for reading entire file
-- Add `UM#write_file` for writing entire file
-- Rename stream methods: `:fd`, `:socket`, `:ssl`
-
-## Improving streams
-
-One wart of the stream API is that it's only for reading, so if we want to
-implement a protocol where we read and write to a target fd, we also need to
-keep the fd around or call `stream.target` every time we want to write to it,
-*and* we don't have a transport-agnostic write op.
+- Rename Connection to IO
 
-What if instead of `Stream` we had something called `Link`, which serves for
-both reading and writing:
-
-```ruby
-conn = machine.connection(fd)
-while l = conn.read_line
-  conn.write(l, '\n')
-end
-# or:
-buf = conn.read(42)
-```
+  ```ruby
+  io = machine.io(fd)
+  l = io.read_line(4)
+  io.write('foo')
+  ```
 
-RESP:
+- Add `IO#fd`/`IO#target` method
 
-```ruby
-conn.resp_write(['foo', 'bar'])
-reply = conn.resp_read
-```
+- Add `UM#inspect` (show size, modes)
+- Add `UM::IO#inspect` (show target, mode, pending bytes)
 
-HTTP:
+## Reimplement multishot read/recv using buffer pool
 
-```ruby
-r = conn.http_read_request
-conn.http_write_response({ ':status' => 200 }, 'foo')
+- remove `#setup_buffer_ring` method
+- use buffer pool, just like UM::Connection
 
-# or:
-conn.http_write_request({ ':method' => 'GET', ':path' => '/foo' }, nil)
-```
+## immediate
 
-Plan of action:
-
-- Rename methods:
-  - [v] rename `#read_line` to `#read_line`
-  - [v] rename `#read` to `#read`
-  - [v] rename `#read_to_delim` to `#read_to_delim`
-  - [v] rename `#each` to `#read_each`
-  - [v] rename `#resp_decode` to `#resp_read`
-- Rename modes:
-  - [v] :fd to :fd
-  - [v] :socket to :socket
-  - [v] auto detect SSL
-- Rename `Stream` to `Connection`
-- Add methods:
-  - `#write(*bufs)`
-  - `#resp_write(obj)`
+- Add tests for support for Set in `machine#await`
+- Add tests for support for Set, Array in `machine#join`
+- Add `UM#read_file` for reading entire file
+- Add `UM#write_file` for writing entire file
+- Rename stream methods: `:fd`, `:socket`, `:ssl`
 
 ## Balancing I/O with the runqueue
 
@@ -124,11 +89,9 @@ Plan of action:
 
 ## ops still not implemented
 
-- splice / - tee
 - sendto
 - recvfrom
 - poll_multishot
-- fsync
 - mkdir / mkdirat
 - link / linkat / unlink / unlinkat / symlink
 - rename / renameat

data/benchmark/bm_io_pipe.rb

@@ -2,8 +2,8 @@
 
 require_relative './common'
 
-GROUPS = 48
-ITERATIONS = 10000
+GROUPS = ENV['C']&.to_i || 48
+ITERATIONS = ENV['I']&.to_i || 10000
 
 SIZE = 1024
 DATA = '*' * SIZE

data/benchmark/common.rb

@@ -62,35 +62,35 @@ class UMBenchmark
     # baseline_um:  [:baseline_um,  "UM no concurrency"],
     # thread_pool:  [:thread_pool,  "ThreadPool"],
 
-    threads:        [:threads,      "Threads"],
+    # threads:        [:threads,      "Threads"],
 
-    async_uring:    [:scheduler,    "Async uring"],
-    async_uring_x2: [:scheduler_x,  "Async uring x2"],
+    # async_uring:    [:scheduler,    "Async uring"],
+    # async_uring_x2: [:scheduler_x,  "Async uring x2"],
 
     # async_epoll:    [:scheduler,    "Async epoll"],
     # async_epoll_x2: [:scheduler_x,  "Async epoll x2"],
 
-    um_fs:          [:scheduler,    "UM FS"],
-    um_fs_x2:       [:scheduler_x,  "UM FS x2"],
+    # um_fs:          [:scheduler,    "UM FS"],
+    # um_fs_x2:       [:scheduler_x,  "UM FS x2"],
 
-    um:             [:um,           "UM"],
-    um_sidecar:     [:um,           "UM sidecar"],
+    # um:             [:um,           "UM"],
+    # um_sidecar:     [:um,           "UM sidecar"],
     # um_sqpoll:      [:um,           "UM sqpoll"],
     um_x2:          [:um_x,         "UM x2"],
-    um_x4:          [:um_x,         "UM x4"],
-    um_x8:          [:um_x,         "UM x8"],
+    # um_x4:          [:um_x,         "UM x4"],
+    # um_x8:          [:um_x,         "UM x8"],
   }
 
   def run_benchmarks(b)
     STDOUT.sync = true
     @@benchmarks.each do |sym, (doer, name)|
       if respond_to?(:"do_#{doer}")
-        STDOUT << "Running #{name}... "
-        ts = nil
+        # STDOUT << "Running #{name}... "
+        # ts = nil
         b.report(name) {
-          ts = measure_time { send(:"run_#{sym}") }
+          # ts = measure_time { send(:"run_#{sym}") }
+          send(:"run_#{sym}")
         }
-        p ts
         cleanup
       end
     end
@@ -197,7 +197,7 @@ class UMBenchmark
   end
 
   def run_um
-    machine = UM.new
+    machine = UM.new(size: 16384)
     fibers = []
     fds = []
     do_um(machine, fibers, fds)
@@ -226,7 +226,7 @@ class UMBenchmark
   def run_um_x2
     threads  = 2.times.map do
       Thread.new do
-        machine = UM.new
+        machine = UM.new(size: 16384)
         fibers = []
         fds = []
         do_um_x(2, machine, fibers, fds)
@@ -240,7 +240,7 @@ class UMBenchmark
   def run_um_x4
     threads  = 4.times.map do
       Thread.new do
-        machine = UM.new
+        machine = UM.new(size: 16384)
         fibers = []
         fds = []
         do_um_x(4, machine, fibers, fds)

data/benchmark/gets.rb

@@ -34,16 +34,16 @@ def um_read
   end
 end
 
-@fd_connection = @machine.open('/dev/random', UM::O_RDONLY)
-@conn = UM::Connection.new(@machine, @fd_connection)
-def um_connection_read_line
-  @conn.read_line(0)
+@fd_io = @machine.open('/dev/random', UM::O_RDONLY)
+@io = UM::IO.new(@machine, @fd_io)
+def um_io_read_line
+  @io².read_line(0)
 end
 
 Benchmark.ips do |x|
-  x.report('IO#gets')         { io_gets }
-  x.report('UM#read+buf')     { um_read }
-  x.report('UM::Connection')  { um_connection_read_line }
+  x.report('IO#gets')     { io_gets }
+  x.report('UM#read+buf') { um_read }
+  x.report('UM::IO')      { um_io_read_line }
 
   x.compare!(order: :baseline)
 end

data/benchmark/gets_concurrent.rb

@@ -83,40 +83,40 @@ ensure
   stop_server
 end
 
-@total_connection = 0
-def um_connection_do
+@total_io = 0
+def um_io_do
   # fd = @machine.open('/dev/random', UM::O_RDONLY)
   fd = @machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
   @machine.connect(fd, '127.0.0.1', 1234)
-  conn = UM::Connection.new(@machine, fd)
-  N.times { @total_connection += conn.read_line(0)&.bytesize || 0 }
+  io = UM::IO.new(@machine, fd)
+  N.times { @total_io += io.read_line(0)&.bytesize || 0 }
 rescue => e
   p e
   p e.backtrace
 ensure
-  conn.clear
+  io.clear
   @machine.close(fd)
 end
 
-def um_connection
+def um_io
   start_server
   ff = C.times.map {
     @machine.snooze
-    @machine.spin { um_connection_do }
+    @machine.spin { um_io_do }
   }
   @machine.await(ff)
-  pp total: @total_connection
+  pp total: @total_io
 ensure
   stop_server
 end
 
 p(C:, N:)
-um_connection
+um_io
 pp @machine.metrics
 exit
 
 Benchmark.bm do
-  it.report('Thread/IO#gets')    { io_gets }
-  it.report('Fiber/UM#read+buf') { um_read }
-  it.report('Fiber/UM::Stream')  { um_connection }
+  it.report('Thread/IO#gets')     { io_gets }
+  it.report('Fiber/UM#read+buf')  { um_read }
+  it.report('Fiber/UM::IO')       { um_io }
 end

data/benchmark/http_parse.rb

@@ -129,15 +129,15 @@ ensure
   ($machine.close(wfd) rescue nil) if wfd
 end
 
-def connection_parse_headers(fd)
-  conn = UM::Connection.new($machine, fd)
+def io_parse_headers(fd)
+  io = UM::IO.new($machine, fd)
 
   buf = String.new(capacity: 65536)
-  headers = connection_get_request_line(conn, buf)
+  headers = io_get_request_line(io, buf)
   return nil if !headers
 
   while true
-    line = conn.read_line(0)
+    line = io.read_line(0)
     break if line.empty?
 
     m = line.match(RE_HEADER_LINE)
@@ -149,8 +149,8 @@ def connection_parse_headers(fd)
   headers
 end
 
-def connection_get_request_line(conn, buf)
-  line = conn.read_line(0)
+def io_get_request_line(io, buf)
+  line = io.read_line(0)
 
   m = line.match(RE_REQUEST_LINE)
   return nil if !m
@@ -162,12 +162,12 @@ def connection_get_request_line(conn, buf)
   }
 end
 
-def parse_http_connection
+def parse_http_io
   rfd, wfd = UM.pipe
   queue = UM::Queue.new
 
   $machine.spin do
-    headers = connection_parse_headers(rfd)
+    headers = io_parse_headers(rfd)
     $machine.push(queue, headers)
   rescue Exception => e
     p e
@@ -188,7 +188,7 @@ def compare_allocs
   p(
     alloc_http_parser:  alloc_count { x.times { parse_http_parser } },
     alloc_stringio:     alloc_count { x.times { parse_http_stringio } },
-    alloc_connection:   alloc_count { x.times { parse_http_connection } }
+    alloc_io:           alloc_count { x.times { parse_http_io } }
   )
 ensure
   GC.enable
@@ -213,8 +213,8 @@ def benchmark
     x.config(:time => 5, :warmup => 3)
 
     x.report("http_parser") { parse_http_parser }
-    x.report("stringio")    { parse_http_stringio }
-    x.report("connection")  { parse_http_connection }
+    x.report("StringIO")    { parse_http_stringio }
+    x.report("UM::IO")      { parse_http_io }
 
     x.compare!
   end

data/benchmark/http_server_accept_queue.rb

@@ -12,8 +12,8 @@ require 'uringmachine'
 RE_REQUEST_LINE = /^([a-z]+)\s+([^\s]+)\s+(http\/[0-9\.]{1,3})/i
 RE_HEADER_LINE = /^([a-z0-9\-]+)\:\s+(.+)/i
 
-def connection_get_request_line(conn, buf)
-  line = conn.read_line(0)
+def io_get_request_line(io, buf)
+  line = io.read_line(0)
   m = line&.match(RE_REQUEST_LINE)
   return nil if !m
 
@@ -26,12 +26,12 @@ end
 
 class InvalidHeadersError < StandardError; end
 
-def get_headers(conn, buf)
-  headers = connection_get_request_line(conn, buf)
+def get_headers(io, buf)
+  headers = io_get_request_line(io, buf)
   return nil if !headers
 
   while true
-    line = conn.read_line(0)
+    line = io.read_line(0)
     break if line.empty?
 
     m = line.match(RE_HEADER_LINE)
@@ -51,11 +51,11 @@ def send_response(machine, fd)
 end
 
 def handle_connection(machine, fd)
-  conn = UM::Connection.new(machine, fd)
+  io = UM::IO.new(machine, fd)
   buf = String.new(capacity: 65536)
 
   while true
-    headers = get_headers(conn, buf)
+    headers = get_headers(io, buf)
     break if !headers
 
     send_response(machine, fd)

data/benchmark/http_server_multi_accept.rb

@@ -12,8 +12,8 @@ require 'uringmachine'
 RE_REQUEST_LINE = /^([a-z]+)\s+([^\s]+)\s+(http\/[0-9\.]{1,3})/i
 RE_HEADER_LINE = /^([a-z0-9\-]+)\:\s+(.+)/i
 
-def connection_get_request_line(conn, buf)
-  line = conn.read_line(0)
+def io_get_request_line(io, buf)
+  line = io.read_line(0)
   m = line&.match(RE_REQUEST_LINE)
   return nil if !m
 
@@ -26,12 +26,12 @@ end
 
 class InvalidHeadersError < StandardError; end
 
-def get_headers(conn, buf)
-  headers = connection_get_request_line(conn, buf)
+def get_headers(io, buf)
+  headers = io_get_request_line(io, buf)
   return nil if !headers
 
   while true
-    line = conn.read_line(0)
+    line = io.read_line(0)
     break if line.empty?
 
     m = line.match(RE_HEADER_LINE)
@@ -51,11 +51,11 @@ def send_response(machine, fd)
 end
 
 def handle_connection(machine, fd)
-  conn = UM::Connection.new(machine, fd)
+  io = UM::IO.new(machine, fd)
   buf = String.new(capacity: 65536)
 
   while true
-    headers = get_headers(conn, buf)
+    headers = get_headers(io, buf)
     break if !headers
 
     send_response(machine, fd)

data/benchmark/http_server_multi_ractor.rb

@@ -12,8 +12,8 @@ require 'uringmachine'
 RE_REQUEST_LINE = /^([a-z]+)\s+([^\s]+)\s+(http\/[0-9\.]{1,3})/i
 RE_HEADER_LINE = /^([a-z0-9\-]+)\:\s+(.+)/i
 
-def connection_get_request_line(conn, buf)
-  line = conn.read_line(0)
+def io_get_request_line(io, buf)
+  line = io.read_line(0)
   m = line&.match(RE_REQUEST_LINE)
   return nil if !m
 
@@ -26,12 +26,12 @@ end
 
 class InvalidHeadersError < StandardError; end
 
-def get_headers(conn, buf)
-  headers = connection_get_request_line(conn, buf)
+def get_headers(io, buf)
+  headers = io_get_request_line(io, buf)
   return nil if !headers
 
   while true
-    line = conn.read_line(0)
+    line = io.read_line(0)
     break if line.empty?
 
     m = line.match(RE_HEADER_LINE)
@@ -53,11 +53,11 @@ end
 
 def handle_connection(machine, fd)
   machine.setsockopt(fd, UM::IPPROTO_TCP, UM::TCP_NODELAY, true)
-  conn = UM::Connection.new(machine, fd)
+  io = UM::IO.new(machine, fd)
   buf = String.new(capacity: 65536)
 
   while true
-    headers = get_headers(conn, buf)
+    headers = get_headers(io, buf)
     break if !headers
 
     send_response(machine, fd)

data/benchmark/http_server_single_thread.rb

@@ -12,8 +12,8 @@ require 'uringmachine'
 RE_REQUEST_LINE = /^([a-z]+)\s+([^\s]+)\s+(http\/[0-9\.]{1,3})/i
 RE_HEADER_LINE = /^([a-z0-9\-]+)\:\s+(.+)/i
 
-def connection_get_request_line(conn, buf)
-  line = conn.read_line(0)
+def io_get_request_line(io, buf)
+  line = io.read_line(0)
   m = line&.match(RE_REQUEST_LINE)
   return nil if !m
 
@@ -26,12 +26,12 @@ end
 
 class InvalidHeadersError < StandardError; end
 
-def get_headers(conn, buf)
-  headers = connection_get_request_line(conn, buf)
+def get_headers(io, buf)
+  headers = io_get_request_line(io, buf)
   return nil if !headers
 
   while true
-    line = conn.read_line(0)
+    line =  io.read_line(0)
     break if line.empty?
 
     m = line.match(RE_HEADER_LINE)
@@ -52,11 +52,11 @@ end
 
 def handle_connection(machine, fd)
   machine.setsockopt(fd, UM::IPPROTO_TCP, UM::TCP_NODELAY, true)
-  conn = UM::Connection.new(machine, fd)
+  io = UM::IO.new(machine, fd)
   buf = String.new(capacity: 65536)
 
   while true
-    headers = get_headers(conn, buf)
+    headers = get_headers(io, buf)
     break if !headers
 
     send_response(machine, fd)
@@ -77,4 +77,4 @@ machine.bind(fd, '127.0.0.1', PORT)
 machine.listen(fd, 128)
 
 puts "Listening on localhost:#{PORT}"
-machine.accept_each(fd) { |conn| machine.spin { handle_connection(machine, conn) } }
+machine.accept_each(fd) { | io| machine.spin { handle_connection(machine,  io) } }