uringmachine 0.8 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c901aae24c3fad58a2453333885d10c577448c910c069753188cf8a89b6a1f2e
-  data.tar.gz: '0804b7103ccf9ae6c244ef5a9677987af2944e508b63d98aeee5f19dee0f1f2e'
+  metadata.gz: 24d5dacdb24cc1da4928d753803bd8012502147aaae23c4c7d9e53945550233c
+  data.tar.gz: 783c8359ae60e149944bd7f79ac588c9b85241f5cec66de11eeae60b92e99753
 SHA512:
-  metadata.gz: 3a6934132fad56b013a8754c375b33acd2cefc28577879b7e05bbf0ded8e9b9cd8e50070ec398d67c00c07ebb15468347e96d27d6ba2ccdbfbc19b5a206aff6c
-  data.tar.gz: 9c54ade5eada0ce6238f6138f8be9c5857436668851154ead8a55b8d221d2f4f3d2318616d1fdc733e99562748c17b26eca7e171cf43ddeb34a80320df2e2b43
+  metadata.gz: 84c77a3826b01acd67bfca663d93e8a8e2a093b7415861040087d7bdcac97f34f3ed829c67529e6dd52abdc0ac88ac8395a0a39315f98fb2966f617c9b8f8dcb
+  data.tar.gz: 238b77b0a4d669b3421d8ce26e888dad76d0885b19405017c1ce2c118f5fb0ac022c4ffed7288ae6389dda6f54810e511e77209bcc8f2e8872aee9a4573fa704

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2025-05-05 Version 0.8.2
+
+- Correctly deal with -EAGAIN when waiting for CQEs
+
+# 2025-05-05 Version 0.8.1
+
+- Fix `#snooze` to not block waiting for CQE
+
 # 2025-05-03 Version 0.8
 
 - Add `#join`

data/examples/bm_http_parse.rb

@@ -43,7 +43,7 @@ def parse_http_parser
     headers['protocol'] = parser.http_version
     $machine.schedule(current_fiber, headers)
   end
-  
+
   $machine.write(w.fileno, HTTP_MSG)
   $machine.yield
 ensure
@@ -89,7 +89,7 @@ def parse_headers(fd)
   while true
     line = get_line(fd, sio, buffer)
     break if line.empty?
-    
+
     m = line.match(RE_HEADER_LINE)
     raise "Invalid header" if !m
 
@@ -111,7 +111,7 @@ def parse_http_stringio
     puts e.backtrace.join("\n")
     exit!
   end
-  
+
   $machine.write(w.fileno, HTTP_MSG)
   $machine.yield
 ensure

data/examples/bm_queue.rb

@@ -18,14 +18,14 @@ NUM_CONSUMERS = 10
 def run_threads
   queue = Queue.new
   done = Queue.new
-  
+
   NUM_PRODUCERS.times do
     Thread.new do
       COUNT.times { queue << rand(1000) }
       done << true
     end
   end
-  
+
   total = 0
   NUM_CONSUMERS.times do
     Thread.new do

data/examples/bm_write.rb

@@ -18,7 +18,7 @@ FN = '/tmp/bm_write'
 def run_io_write(num_threads)
   FileUtils.rm(FN) rescue nil
   fio = File.open(FN, 'w')
-  
+
   threads = num_threads.times.map do |i|
     Thread.new do
       ITERATIONS.times { fio.write(BUF) }
@@ -33,13 +33,13 @@ def run_um_write(num_fibers)
   FileUtils.rm(FN) rescue nil
   fio = File.open(FN, 'w')
   fd = fio.fileno
-  
+
   machine = UringMachine.new
   done = UringMachine::Queue.new
   num_fibers.times do
     machine.spin do
       ITERATIONS.times { machine.write(fd, BUF) }
-      machine.push(done, true) 
+      machine.push(done, true)
     end
   end
   num_fibers.times { machine.pop(done) }

data/examples/pg.rb

@@ -22,7 +22,7 @@ class UM::Stream
       @eof = true
       return false
     end
-      
+
     @ofs_tail += ret
     true
   end

data/examples/server_client.rb

@@ -31,7 +31,7 @@ def run_client
     @machine.send(fd, msg, msg.bytesize, 0)
     res = @machine.recv(fd, buf, 8192, 0)
     @counter += 2
-    
+
     break if res == 0
     raise "Got #{res} bytes instead of #{msg.bytesize}" if res != msg.bytesize
   end
@@ -59,6 +59,6 @@ end
 
 t0 = Time.now
 @machine.sleep 3
-t1 = Time.now  
+t1 = Time.now
 elapsed = t1 - t0
 puts "Did #{@counter} ops in #{elapsed} seconds (#{(@counter / elapsed)} ops/s)"

data/examples/snooze.rb

@@ -32,7 +32,7 @@ loop do
   break if (Time.now - t0) > MAX_TIME
   start_fiber while @fiber_count < MAX_FIBERS
 end
-t1 = Time.now  
+t1 = Time.now
 elapsed = t1 - t0
 rate = @counter / elapsed
 puts "Did #{@counter} ops in #{elapsed} seconds (#{rate} ops/s)"

data/examples/stream.rb

@@ -22,7 +22,7 @@ class UM::Stream
       @eof = true
       return false
     end
-      
+
     @ofs_tail += ret
     true
   end

data/ext/um/um.c

@@ -89,7 +89,7 @@ static inline void um_process_cqe(struct um *machine, struct io_uring_cqe *cqe)
   }
 
   if (op->flags & OP_F_ASYNC) return;
-  
+
   um_runqueue_push(machine, op);
 }
 
@@ -127,6 +127,7 @@ done:
 struct wait_for_cqe_ctx {
   struct um *machine;
   struct io_uring_cqe *cqe;
+  int wait_nr;
   int result;
 };
 
@@ -140,20 +141,35 @@ void *um_wait_for_cqe_without_gvl(void *ptr) {
     // NULL.
     //
     // https://github.com/axboe/liburing/issues/1280
-    int res = io_uring_submit_and_wait_timeout(&ctx->machine->ring, &ctx->cqe, 1, NULL, NULL);
+    int res = io_uring_submit_and_wait_timeout(&ctx->machine->ring, &ctx->cqe, ctx->wait_nr, NULL, NULL);
     ctx->result = (res > 0 && !ctx->cqe) ? -EINTR : res;
   }
   else
-    ctx->result = io_uring_wait_cqe(&ctx->machine->ring, &ctx->cqe);
+    ctx->result = io_uring_wait_cqes(&ctx->machine->ring, &ctx->cqe, ctx->wait_nr, NULL, NULL);
   return NULL;
 }
 
-static inline void um_wait_for_and_process_ready_cqes(struct um *machine) {
-  struct wait_for_cqe_ctx ctx = { .machine = machine, .cqe = NULL };
+// Waits for the given minimum number of completion entries. The wait_nr is
+// either 1 - where we wait for at least one CQE to be ready, or 0, where we
+// don't wait, and just process any CQEs that already ready.
+static inline void um_wait_for_and_process_ready_cqes(struct um *machine, int wait_nr) {
+  struct wait_for_cqe_ctx ctx = { .machine = machine, .cqe = NULL, .wait_nr = wait_nr };
   rb_thread_call_without_gvl(um_wait_for_cqe_without_gvl, (void *)&ctx, RUBY_UBF_IO, 0);
 
-  if (unlikely(ctx.result < 0 && ctx.result != -EINTR))
-    rb_syserr_fail(-ctx.result, strerror(-ctx.result));
+  if (unlikely(ctx.result < 0)) {
+    // the internal calls to (maybe submit) and wait for cqes may fail with:
+    // -EINTR (interrupted by signal)
+    // -EAGAIN (apparently can be returned when wait_nr = 0)
+    // both should not raise an exception.
+    switch (ctx.result) {
+      case -EINTR:
+      case -EAGAIN:
+        // do nothing
+        break;
+      default:
+        rb_syserr_fail(-ctx.result, strerror(-ctx.result));
+    }
+  }
 
   if (ctx.cqe) {
     um_process_cqe(machine, ctx.cqe);
@@ -187,18 +203,19 @@ inline VALUE um_fiber_switch(struct um *machine) {
         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);
+          // um_process_ready_cqes(machine);
+          um_wait_for_and_process_ready_cqes(machine, 0);
           struct um_op *op2 = um_runqueue_shift(machine);
           if (likely(op2 && op2 != op)) {
             um_runqueue_push(machine, op);
-            op = op2; 
+            op = op2;
           }
         }
       }
       return process_runqueue_op(machine, op);
     }
 
-    um_wait_for_and_process_ready_cqes(machine);
+    um_wait_for_and_process_ready_cqes(machine, 1);
   }
 }
 
@@ -320,45 +337,18 @@ VALUE um_sleep(struct um *machine, double duration) {
   return raise_if_exception(ret);
 }
 
-// VALUE um_periodically(struct um *machine, double interval) {
-//   struct um_op op;
-//   VALUE ret = Qnil;
-//   um_prep_op(machine, &op, OP_SLEEP_MULTISHOT);
-//   op.ts = um_double_to_timespec(interval);
-//   op.flags |= OP_F_MULTISHOT;
-//   struct io_uring_sqe *sqe = um_get_sqe(machine, &op);
-//   io_uring_prep_timeout(sqe, &op.ts, 0, IORING_TIMEOUT_MULTISHOT);
-
-//   while (true) {
-//     ret = um_fiber_switch(machine);
-
-//     if (!um_op_completed_p(&op)) {
-//       um_cancel_and_wait(machine, &op);
-//       break;
-//     }
-//     else {
-//       if (op.result.res != -ETIME) um_raise_on_error_result(op.result.res);
-//       ret = DBL2NUM(interval);
-//     }
-//   }
-
-//   RB_GC_GUARD(ret);
-//   return raise_if_exception(ret);
-
-// }
-
 inline VALUE um_read(struct um *machine, int fd, VALUE buffer, int maxlen, int buffer_offset) {
   struct um_op op;
   um_prep_op(machine, &op, OP_READ);
   struct io_uring_sqe *sqe = um_get_sqe(machine, &op);
   void *ptr = um_prepare_read_buffer(buffer, maxlen, buffer_offset);
   io_uring_prep_read(sqe, fd, ptr, maxlen, -1);
-  
+
   VALUE ret = um_fiber_switch(machine);
   if (um_check_completion(machine, &op)) {
     um_update_read_buffer(machine, buffer, buffer_offset, op.result.res, op.result.flags);
     ret = INT2NUM(op.result.res);
-    
+
   }
 
   RB_GC_GUARD(buffer);
@@ -652,7 +642,7 @@ VALUE multishot_ensure(VALUE arg) {
 VALUE um_accept_each(struct um *machine, int fd) {
   struct um_op op;
   um_prep_op(machine, &op, OP_ACCEPT_MULTISHOT);
-  
+
   struct op_ctx ctx = { .machine = machine, .op = &op, .fd = fd, .read_buf = NULL };
   return rb_ensure(accept_each_begin, (VALUE)&ctx, multishot_ensure, (VALUE)&ctx);
 }
@@ -803,7 +793,7 @@ VALUE um_periodically(struct um *machine, double interval) {
   struct um_op op;
   um_prep_op(machine, &op, OP_SLEEP_MULTISHOT);
   op.ts = um_double_to_timespec(interval);
-  
+
   struct op_ctx ctx = { .machine = machine, .op = &op, .ts = op.ts, .read_buf = NULL };
   return rb_ensure(periodically_begin, (VALUE)&ctx, multishot_ensure, (VALUE)&ctx);
 }

data/ext/um/um.h

@@ -135,7 +135,7 @@ struct um_queue {
   struct um_queue_entry *head;
   struct um_queue_entry *tail;
   struct um_queue_entry *free_head;
-  
+
   uint32_t num_waiters;
   uint32_t state;
   uint32_t count;

data/ext/um/um_const.c

@@ -159,7 +159,7 @@ void um_define_net_constants(VALUE mod) {
   DEF_CONST_INT(mod, TCP_THIN_LINEAR_TIMEOUTS);
   DEF_CONST_INT(mod, TCP_TIMESTAMP);
   DEF_CONST_INT(mod, TCP_USER_TIMEOUT);
-  
+
   DEF_CONST_INT(mod, UDP_CORK);
 
   DEF_CONST_INT(mod, AI_PASSIVE);
@@ -169,7 +169,7 @@ void um_define_net_constants(VALUE mod) {
   DEF_CONST_INT(mod, AI_ALL);
   DEF_CONST_INT(mod, AI_ADDRCONFIG);
   DEF_CONST_INT(mod, AI_V4MAPPED);
-  
+
   DEF_CONST_INT(mod, NI_MAXHOST);
   DEF_CONST_INT(mod, NI_MAXSERV);
   DEF_CONST_INT(mod, NI_NOFQDN);
@@ -177,7 +177,7 @@ void um_define_net_constants(VALUE mod) {
   DEF_CONST_INT(mod, NI_NAMEREQD);
   DEF_CONST_INT(mod, NI_NUMERICSERV);
   DEF_CONST_INT(mod, NI_DGRAM);
-  
+
   DEF_CONST_INT(mod, SHUT_RD);
   DEF_CONST_INT(mod, SHUT_WR);
   DEF_CONST_INT(mod, SHUT_RDWR);

data/ext/um/um_op.c

@@ -66,7 +66,7 @@ inline void um_op_list_compact(struct um *machine, struct um_op *head) {
   }
 }
 
-inline struct um_op_result *multishot_result_alloc(struct um *machine) {  
+inline struct um_op_result *multishot_result_alloc(struct um *machine) {
   if (machine->result_freelist) {
     struct um_op_result *result = machine->result_freelist;
     machine->result_freelist = result->next;

data/ext/um/um_sync.c

@@ -12,7 +12,7 @@ void um_futex_wait(struct um *machine, uint32_t *futex, uint32_t expect) {
     sqe, (uint32_t *)futex, expect, FUTEX_BITSET_MATCH_ANY,
 		FUTEX2_SIZE_U32, 0
   );
-  
+
   VALUE ret = um_fiber_switch(machine);
   if (!um_op_completed_p(&op))
     um_cancel_and_wait(machine, &op);
@@ -157,7 +157,7 @@ static inline void queue_add_head(struct um_queue *queue, VALUE value) {
   struct um_queue_entry *entry = um_queue_entry_checkout(queue);
 
   entry->next = queue->head;
-  if (queue->head) { 
+  if (queue->head) {
     queue->head->prev = entry;
     queue->head = entry;
   }
@@ -171,7 +171,7 @@ static inline void queue_add_tail(struct um_queue *queue, VALUE value) {
   struct um_queue_entry *entry = um_queue_entry_checkout(queue);
 
   entry->prev = queue->tail;
-  if (queue->tail) { 
+  if (queue->tail) {
     queue->tail->next = entry;
     queue->tail = entry;
   }
@@ -205,7 +205,7 @@ VALUE queue_remove_tail(struct um_queue *queue) {
 static inline VALUE um_queue_add(struct um *machine, struct um_queue *queue, VALUE value, int add_head) {
   if (add_head) queue_add_head(queue, value);
   else          queue_add_tail(queue, value);
-  
+
   queue->count++;
 
   queue->state = QUEUE_READY;
@@ -232,7 +232,7 @@ struct queue_wait_ctx {
 
 VALUE um_queue_remove_begin(VALUE arg) {
   struct queue_wait_ctx *ctx = (struct queue_wait_ctx *)arg;
-  
+
   ctx->queue->num_waiters++;
   while (ctx->queue->state == QUEUE_EMPTY) {
     um_futex_wait(ctx->machine, &ctx->queue->state, QUEUE_EMPTY);

data/lib/uringmachine/actor.rb

@@ -26,7 +26,7 @@ class UringMachine
   class Actor < Fiber
     def run(machine, target, mailbox)
       @machine = machine
-      @target = target      
+      @target = target
       @mailbox = mailbox
       while (msg = machine.shift(mailbox))
         process_message(msg)

data/lib/uringmachine/version.rb

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

data/test/helper.rb

@@ -58,7 +58,7 @@ class UMBaseTest < Minitest::Test
   end
 
   attr_accessor :machine
-  
+
   def setup
     @machine = UM.new
   end

data/test/test_actor.rb

@@ -26,7 +26,7 @@ class ActorTest < UMBaseTest
   def test_basic_actor_functionality
     mailbox = UM::Queue.new
     actor = @machine.spin_actor(Counter)
-    
+
     assert_kind_of Fiber, actor
 
     assert_equal 0, actor.call(mailbox, :get)
@@ -59,7 +59,7 @@ class ActorTest < UMBaseTest
   def test_actor_with_args
     actor = @machine.spin_actor(Counter2, 43)
     mailbox = UM::Queue.new
-    
+
     assert_equal 43, actor.call(mailbox, :get)
   end
 end

data/test/test_async_op.rb

@@ -37,9 +37,9 @@ class AsyncOpTest < UMBaseTest
     assert_equal 1, machine.pending_count
     @op.cancel
     assert_equal false, @op.done?
-    
+
     machine.sleep(0.01)
-  
+
     assert_equal 0, machine.pending_count
     assert_equal true, @op.done?
     assert_equal (-ECANCELED), @op.result
@@ -52,7 +52,7 @@ class AsyncOpTest < UMBaseTest
     end
 
     res = @op.await
-  
+
     assert_equal 0, machine.pending_count
     assert_equal true, @op.done?
     assert_equal (-ECANCELED), res
@@ -63,7 +63,7 @@ class AsyncOpTest < UMBaseTest
 
   def test_async_op_await_with_timeout
     e = nil
-  
+
     begin
       machine.timeout(0.01, TOError) do
         @op.await
@@ -80,7 +80,7 @@ class AsyncOpTest < UMBaseTest
 
   def test_async_op_await_with_timeout2
     e = nil
-  
+
     begin
       machine.timeout(0.1, TOError) do
         @op.await

data/test/test_fiber.rb

@@ -55,7 +55,7 @@ class FiberTerminateTest < UMBaseTest
     assert_nil x
     machine.snooze
     assert_equal 1, x
-    
+
     machine.schedule(f, UM::Terminate.new)
     2.times { machine.snooze }
 
@@ -149,6 +149,7 @@ class ScopeTest < UMBaseTest
     x1 = nil
     x2 = nil
 
+    t0 = monotonic_clock
     machine.scope do
       f1 = machine.spin do
         x1 = 1
@@ -159,13 +160,15 @@ class ScopeTest < UMBaseTest
 
       f2 = machine.spin do
         x2 = 1
-        machine.sleep 0.01
+        machine.sleep 0.03
       ensure
         x2 = 0
       end
     end
+    elapsed = monotonic_clock - t0
+    assert_in_range 0.03..0.05, elapsed
 
     assert_equal 0, x1
     assert_equal 0, x2
   end
-end
+end

data/test/test_um.rb

@@ -11,7 +11,7 @@ class UringMachineTest < Minitest::Test
   end
 end
 
-class FiberTest < UMBaseTest
+class SpinTest < UMBaseTest
   def test_spin
     x = nil
     f = machine.spin do
@@ -27,6 +27,24 @@ class FiberTest < UMBaseTest
   end
 end
 
+class SnoozeTest < UMBaseTest
+  def test_snooze_while_sleeping_fiber
+    f = machine.spin do
+      machine.sleep(0.1)
+    end
+
+    t0 = monotonic_clock
+    machine.snooze
+    t1 = monotonic_clock
+    assert_in_range 0..0.001, t1 - t0
+
+    t0 = monotonic_clock
+    machine.snooze
+    t1 = monotonic_clock
+    assert_in_range 0..0.001, t1 - t0
+  end
+end
+
 class ScheduleTest < UMBaseTest
   def test_schedule_and_yield
     buf = []
@@ -60,7 +78,7 @@ class ScheduleTest < UMBaseTest
       buf << e
       machine.yield
     end
-    
+
     machine.schedule(f, nil)
     # start the f fiber
     machine.snooze
@@ -80,7 +98,7 @@ class ScheduleTest < UMBaseTest
       machine.schedule(main, e)
       machine.yield
     end
-    
+
     machine.schedule(f, nil)
     t0 = monotonic_clock
 
@@ -234,7 +252,7 @@ class PeriodicallyTest < UMBaseTest
     t1 = monotonic_clock
     assert_in_range 0.05..0.09, t1 - t0
     assert_equal 5, count
-    assert_equal 1, cancel 
+    assert_equal 1, cancel
   end
 
   def test_periodically_with_timeout
@@ -258,7 +276,7 @@ class PeriodicallyTest < UMBaseTest
     t1 = monotonic_clock
     assert_in_range 0.05..0.08, t1 - t0
     assert_in_range 4..6, count
-    assert_equal 1, cancel 
+    assert_equal 1, cancel
 
   end
 end
@@ -331,7 +349,7 @@ class ReadTest < UMBaseTest
 
     buffer = +'foo'
     sio = StringIO.new(buffer)
-    
+
     r, w = IO.pipe
     w << 'bar'
 
@@ -366,7 +384,7 @@ class ReadEachTest < UMBaseTest
       w.close
       machine.yield
     end
-    
+
     machine.schedule(f, nil)
 
     machine.read_each(r.fileno, bgid) do |buf|
@@ -464,7 +482,7 @@ class ReadEachTest < UMBaseTest
       sleep 0.1
       w.close
     end
-    
+
     bufs = []
     machine.read_each(r.fileno, bgid) do |b|
       bufs << b
@@ -591,7 +609,7 @@ class AcceptTest < UMBaseTest
 
   def test_accept
     conn = TCPSocket.new('127.0.0.1', @port)
-    
+
     assert_equal 0, machine.pending_count
     fd = machine.accept(@server.fileno)
     assert_equal 0, machine.pending_count
@@ -635,6 +653,32 @@ class AcceptEachTest < UMBaseTest
   ensure
     t&.kill
   end
+
+  def test_accept_each_interrupted
+    conns = []
+    count = 0
+    terminated = nil
+    f = @machine.spin do
+      machine.accept_each(@server.fileno) do |fd|
+        count += 1
+        break if count == 3
+      end
+    rescue UM::Terminate
+      terminated = true
+    end
+
+    s = TCPSocket.new('127.0.0.1', @port)
+    @machine.sleep(0.01)
+
+    assert_equal 1, count
+    refute terminated
+
+    @machine.schedule(f, UM::Terminate.new)
+    @machine.sleep(0.01)
+
+    assert f.done?
+    assert terminated
+  end
 end
 
 class SocketTest < UMBaseTest
@@ -1041,10 +1085,9 @@ class QueueTest < UMBaseTest
     machine.schedule(f2, nil)
 
     machine.snooze
-
     assert_equal [[1, :foo]], buf
-    machine.push(q, :bar)
 
+    machine.push(q, :bar)
     machine.snooze
     assert_equal [[1, :foo], [2, :bar]], buf
   end
@@ -1082,7 +1125,7 @@ class QueueTest < UMBaseTest
 
     t1 = Thread.new {
       m = UM.new
-      3.times { m.push(q, it); m.sleep(0.01) }
+      3.times { m.push(q, it) }
     }
 
     items = []
@@ -1090,7 +1133,7 @@ class QueueTest < UMBaseTest
     t2 = Thread.new {
       m = UM.new
       3.times {
-        i = m.pop(q)
+        i = m.shift(q)
         items << i
         m.sleep(0.01)
       }
@@ -1143,7 +1186,7 @@ class PipeTest < UMBaseTest
     rfd, wfd = UM.pipe
     ret = machine.write(wfd, 'foo')
     assert_equal 3, ret
-    
+
     ret = machine.close(wfd)
     assert_equal wfd, ret
 
@@ -1185,6 +1228,6 @@ class WaitTest < UMBaseTest
   def test_waitpid_bad_pid
     skip if UM.kernel_version < 607
 
-    assert_raises(Errno::ECHILD) { machine.waitpid(1, UM::WEXITED) }    
+    assert_raises(Errno::ECHILD) { machine.waitpid(1, UM::WEXITED) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uringmachine
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: 0.8.2
 platform: ruby
 authors:
 - Sharon Rosner