uringmachine 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc849d9467e24fa296a104e5b1caf71907495a3ed9cc68370bc6eb134a474cbf
-  data.tar.gz: 4fcdf5cd6055321f37375094aa11b56696c894d6a2c47ed9f756fb9a40d79753
+  metadata.gz: d7c0b7cfea4bdb08c954cf8dcef6cc776e4eb73e64fc366a43042f7a62902430
+  data.tar.gz: 83f60da253aa4ab69ef98a96205995b258c0d4a6925385818e34d2cb9fd26a0f
 SHA512:
-  metadata.gz: 3d83d7419000bd434bac101d72c6850274a71dd0324bd1732043cbdb08ef659b683e1010dc31093fe7a77e37368698db56592685bf7fe8a2f76ee4cd70cee52f
-  data.tar.gz: dcb79682bbdc20b99bd312aad22145642c4479009250f01f2e0c83f506026218d973b5c6e8b0aecff4e993acbe3998822bccbdf1de7c77a025b7560b5860ca77
+  metadata.gz: 54d58ae7aedc3f7444cff6d8b4afbf4845ba0ddf6ae5a662b60b04b83c81b7e2af35c1e46a1f3827adb07bf95c4677b4253774bd50c590541177a5a251d7f2b4
+  data.tar.gz: 9a6d69766b3d17c5b1593bd153608f846370c32bd7219796f4fbe677c379724aa1186f70a5cf4cbb797817e4564bdff01ab5a5a3514e803ac8ead5b949899fde

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2025-04-28 Version 0.7
+
+- Add `#shutdown`
+
+# 2025-04-23 Version 0.6.1
+
+- Improve `#snooze` to prevent op completion starvation
+
 # 2025-04-23 Version 0.6
 
 - Add `#periodically` for multishot timeout

data/TODO.md

@@ -14,5 +14,4 @@
 - fadvise
 - madvise
 - getxattr / setxattr
-- shutdown
 - send_bundle / recv_bundle (kernel >= 6.10)

data/ext/um/um.c

@@ -175,8 +175,28 @@ inline VALUE process_runqueue_op(struct um *machine, struct um_op *op) {
 inline VALUE um_fiber_switch(struct um *machine) {
   while (true) {
     struct um_op *op = um_runqueue_shift(machine);
-    if (op)
+    if (op) {
+      // in case of a snooze, we need to prevent a situation where completions
+      // are not processed because the runqueue is never empty. Theoretically,
+      // we can still have a situation where multiple fibers are all doing a
+      // snooze repeatedly, which can prevent completions from being processed.
+
+      // is the op a snooze op and is this the same fiber as the current one?
+      if (unlikely(op->kind == OP_SCHEDULE && op->fiber == rb_fiber_current())) {
+        //  are there any pending ops (i.e. waiting for completion)?
+        if (machine->pending_count > 0) {
+          // if yes, process completions, get runqueue head, put original op
+          // back on runqueue.
+          um_wait_for_and_process_ready_cqes(machine);
+          struct um_op *op2 = um_runqueue_shift(machine);
+          if (likely(op2 && op2 != op)) {
+            um_runqueue_push(machine, op);
+            op = op2; 
+          }
+        }
+      }
       return process_runqueue_op(machine, op);
+    }
 
     um_wait_for_and_process_ready_cqes(machine);
   }
@@ -529,6 +549,22 @@ VALUE um_setsockopt(struct um *machine, int fd, int level, int opt, int value) {
   return raise_if_exception(ret);
 }
 
+VALUE um_shutdown(struct um *machine, int fd, int how) {
+  VALUE ret = Qnil;
+
+  struct um_op op;
+  um_prep_op(machine, &op, OP_SHUTDOWN);
+  struct io_uring_sqe *sqe = um_get_sqe(machine, &op);
+  io_uring_prep_shutdown(sqe, fd, how);
+
+  ret = um_fiber_switch(machine);
+  if (um_check_completion(machine, &op))
+    ret = INT2NUM(op.result.res);
+
+  RB_GC_GUARD(ret);
+  return raise_if_exception(ret);
+}
+
 VALUE um_open(struct um *machine, VALUE pathname, int flags, int mode) {
   struct um_op op;
   um_prep_op(machine, &op, OP_BIND);

data/ext/um/um.h

@@ -37,6 +37,7 @@ enum op_kind {
   OP_LISTEN,
   OP_GETSOCKOPT,
   OP_SETSOCKOPT,
+  OP_SHUTDOWN,
 
   OP_FUTEX_WAIT,
   OP_FUTEX_WAKE,
@@ -220,6 +221,7 @@ VALUE um_bind(struct um *machine, int fd, struct sockaddr *addr, socklen_t addrl
 VALUE um_listen(struct um *machine, int fd, int backlog);
 VALUE um_getsockopt(struct um *machine, int fd, int level, int opt);
 VALUE um_setsockopt(struct um *machine, int fd, int level, int opt, int value);
+VALUE um_shutdown(struct um *machine, int fd, int how);
 
 void um_async_op_set(VALUE self, struct um *machine, struct um_op *op);
 VALUE um_async_op_await(struct um_async_op *async_op);

data/ext/um/um_class.c

@@ -150,6 +150,12 @@ VALUE UM_socket(VALUE self, VALUE domain, VALUE type, VALUE protocol, VALUE flag
   return um_socket(machine, NUM2INT(domain), NUM2INT(type), NUM2INT(protocol), NUM2UINT(flags));
 }
 
+VALUE UM_shutdown(VALUE self, VALUE fd, VALUE how) {
+  struct um *machine = um_get_machine(self);
+  return um_shutdown(machine, NUM2INT(fd), NUM2INT(how));
+
+}
+
 VALUE UM_connect(VALUE self, VALUE fd, VALUE host, VALUE port) {
   struct um *machine = um_get_machine(self);
 
@@ -350,6 +356,7 @@ void Init_UM(void) {
   rb_define_method(cUM, "send", UM_send, 4);
   rb_define_method(cUM, "setsockopt", UM_setsockopt, 4);
   rb_define_method(cUM, "socket", UM_socket, 4);
+  rb_define_method(cUM, "shutdown", UM_shutdown, 2);
 
   rb_define_method(cUM, "prep_timeout", UM_prep_timeout, 1);
 

data/lib/uringmachine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UringMachine
-  VERSION = '0.6'
+  VERSION = '0.7'
 end

data/test/run.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob("#{__dir__}/test_*.rb").each do |path|
+  require(path)
+end

data/test/test_um.rb

@@ -514,7 +514,7 @@ class WriteTest < UMBaseTest
   end
 end
 
-class Closetest < UMBaseTest
+class CloseTest < UMBaseTest
   def test_close
     r, w = IO.pipe
     machine.write(w.fileno, 'foo')
@@ -529,6 +529,54 @@ class Closetest < UMBaseTest
   end
 end
 
+class ShutdownTest < UMBaseTest
+  def make_socket_pair
+    port = 10000 + rand(30000)
+    server_fd = @machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
+    @machine.setsockopt(server_fd, UM::SOL_SOCKET, UM::SO_REUSEADDR, true)
+    @machine.bind(server_fd, '127.0.0.1', port)
+    @machine.listen(server_fd, UM::SOMAXCONN)
+
+    client_conn_fd = @machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
+    @machine.connect(client_conn_fd, '127.0.0.1', port)
+
+    server_conn_fd = @machine.accept(server_fd)
+
+    @machine.close(server_fd)
+    [client_conn_fd, server_conn_fd]
+  end
+
+  def test_shutdown
+    c_fd, s_fd = make_socket_pair
+    res = @machine.send(c_fd, 'abc', 3, 0)
+    assert_equal 3, res
+
+    buf = +''
+    res = @machine.recv(s_fd, buf, 256, 0)
+    assert_equal 3, res
+    assert_equal 'abc', buf
+
+    res = @machine.shutdown(c_fd, UM::SHUT_WR)
+    assert_equal 0, res
+
+    assert_raises(Errno::EPIPE) { @machine.send(c_fd, 'abc', 3, 0) }
+
+    res = @machine.shutdown(s_fd, UM::SHUT_RD)
+    assert_equal 0, res
+
+    res = @machine.recv(s_fd, buf, 256, 0)
+    assert_equal 0, res
+
+    res = @machine.shutdown(c_fd, UM::SHUT_RDWR)
+    assert_equal 0, res
+
+    assert_raises(Errno::EINVAL) { @machine.shutdown(c_fd, -9999) }
+  ensure
+    @machine.close(c_fd)
+    @machine.close(s_fd)
+  end
+end
+
 class AcceptTest < UMBaseTest
   def setup
     super
@@ -917,32 +965,28 @@ class QueueTest < UMBaseTest
     q = UM::Queue.new
     buf = []
 
-    f1 = Fiber.new do
+    machine.spin do
       buf << [1, machine.pop(q)]
-      machine.yield
     end
 
-    machine.schedule(f1, nil)
-
-    f2 = Fiber.new do
+    machine.spin do
       buf << [2, machine.pop(q)]
-      machine.yield
     end
 
-    machine.schedule(f2, nil)
-
     machine.snooze
     assert_equal [], buf
+    assert_equal 2, machine.pending_count
 
     machine.push(q, :foo)
     assert_equal 1, q.count
-    machine.sleep(0.02)
+    machine.snooze
+    assert_equal 1, machine.pending_count
     assert_equal [[1, :foo]], buf
 
     machine.push(q, :bar)
     assert_equal 1, q.count
 
-    machine.sleep(0.02)
+    machine.snooze
     assert_equal [[1, :foo], [2, :bar]], buf
     assert_equal 0, q.count
   end
@@ -969,7 +1013,7 @@ class QueueTest < UMBaseTest
     end
     machine.schedule(f2, nil)
 
-    3.times { machine.snooze }
+    machine.snooze
 
     assert_equal [[1, :bar], [2, :foo]], buf.sort
     assert_equal 0, q.count
@@ -996,12 +1040,12 @@ class QueueTest < UMBaseTest
     end
     machine.schedule(f2, nil)
 
-    machine.sleep 0.01
+    machine.snooze
 
     assert_equal [[1, :foo]], buf
     machine.push(q, :bar)
 
-    machine.sleep 0.01
+    machine.snooze
     assert_equal [[1, :foo], [2, :bar]], buf
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: uringmachine
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Sharon Rosner
 bindir: bin
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -136,6 +136,7 @@ files:
 - lib/uringmachine/version.rb
 - supressions/ruby.supp
 - test/helper.rb
+- test/run.rb
 - test/test_actor.rb
 - test/test_async_op.rb
 - test/test_ssl.rb