uringmachine 0.7 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c0b7cfea4bdb08c954cf8dcef6cc776e4eb73e64fc366a43042f7a62902430
-  data.tar.gz: 83f60da253aa4ab69ef98a96205995b258c0d4a6925385818e34d2cb9fd26a0f
+  metadata.gz: 7fdbc29b1e4c910d05eef327345a52faafd92566d7bdddaad81396bcf1f4767d
+  data.tar.gz: 4729a2ca7640fd58d0d83cc008db6e3431edfcdf04e396bce9981465a8e4e0a9
 SHA512:
-  metadata.gz: 54d58ae7aedc3f7444cff6d8b4afbf4845ba0ddf6ae5a662b60b04b83c81b7e2af35c1e46a1f3827adb07bf95c4677b4253774bd50c590541177a5a251d7f2b4
-  data.tar.gz: 9a6d69766b3d17c5b1593bd153608f846370c32bd7219796f4fbe677c379724aa1186f70a5cf4cbb797817e4564bdff01ab5a5a3514e803ac8ead5b949899fde
+  metadata.gz: 56c03563909bd5acd8466a0ef255cd2a791c9907e7fa9ab0a88d9be22f4db895cfb85f0ed5fc0883d0e583c216e238e954a74623f6d231f38c51de2f65316af8
+  data.tar.gz: 1471eea52c8edb8bab45e4fa058191c13e1c88a39bd728c1be5f72998058724ab7fb8a699d279fe5ace36fec6dc5eaca5361a4265b909d078cf5549dd3a19af2

data/.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
       matrix:
         # macos-latest uses arm64, macos-13 uses x86
         os: [ubuntu-latest]
-        ruby: ['3.3', '3.4', 'head']
+        ruby: ['3.4', 'head']
 
     name: ${{matrix.os}}, ${{matrix.ruby}}
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2025-05-05 Version 0.8.1
+
+- Fix `#snooze` to not block waiting for CQE
+
+# 2025-05-03 Version 0.8
+
+- Add `#join`
+
 # 2025-04-28 Version 0.7
 
 - Add `#shutdown`

data/TODO.md

@@ -1,3 +1,5 @@
+# ops
+
 - [ ] multishot timeout
   - [v] machine.periodically(interval) { ... }
   - [ ] machine.prep_timeout_multishot(interval)
@@ -15,3 +17,9 @@
 - madvise
 - getxattr / setxattr
 - send_bundle / recv_bundle (kernel >= 6.10)
+
+# actors
+
+When doing a `call`, we need to provide a mailbox for the response. can this be
+automatic?
+

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/extconf.rb

@@ -6,61 +6,6 @@ require 'rbconfig'
 
 dir_config 'um_ext'
 
-def config_ssl
-  # don't use pkg_config('openssl') if '--with-openssl-dir' is used
-  has_openssl_dir = dir_config('openssl').any? ||
-    RbConfig::CONFIG['configure_args']&.include?('openssl')
-
-  found_pkg_config = !has_openssl_dir && pkg_config('openssl')
-
-  found_ssl = if !$mingw && found_pkg_config
-    puts '──── Using OpenSSL pkgconfig (openssl.pc) ────'
-    true
-  elsif have_library('libcrypto', 'BIO_read') && have_library('libssl', 'SSL_CTX_new')
-    true
-  elsif %w'crypto libeay32'.find {|crypto| have_library(crypto, 'BIO_read')} &&
-      %w'ssl ssleay32'.find {|ssl| have_library(ssl, 'SSL_CTX_new')}
-    true
-  else
-    puts '** Puma will be compiled without SSL support'
-    false
-  end
-
-  if found_ssl
-    have_header "openssl/bio.h"
-
-    ssl_h = "openssl/ssl.h".freeze
-
-    puts "\n──── Below are yes for 1.0.2 & later ────"
-    have_func "DTLS_method"                            , ssl_h
-    have_func "SSL_CTX_set_session_cache_mode(NULL, 0)", ssl_h
-
-    puts "\n──── Below are yes for 1.1.0 & later ────"
-    have_func "TLS_server_method"                      , ssl_h
-    have_func "SSL_CTX_set_min_proto_version(NULL, 0)" , ssl_h
-
-    puts "\n──── Below is yes for 1.1.0 and later, but isn't documented until 3.0.0 ────"
-    # https://github.com/openssl/openssl/blob/OpenSSL_1_1_0/include/openssl/ssl.h#L1159
-    have_func "SSL_CTX_set_dh_auto(NULL, 0)"           , ssl_h
-
-    puts "\n──── Below is yes for 1.1.1 & later ────"
-    have_func "SSL_CTX_set_ciphersuites(NULL, \"\")"   , ssl_h
-
-    puts "\n──── Below is yes for 3.0.0 & later ────"
-    have_func "SSL_get1_peer_certificate"              , ssl_h
-
-    puts ''
-
-    # Random.bytes available in Ruby 2.5 and later, Random::DEFAULT deprecated in 3.0
-    if Random.respond_to?(:bytes)
-      $defs.push "-DHAVE_RANDOM_BYTES"
-      puts "checking for Random.bytes... yes"
-    else
-      puts "checking for Random.bytes... no"
-    end
-  end
-end
-
 KERNEL_INFO_RE = /Linux (\d)\.(\d+)(?:\.)?((?:\d+\.?)*)(?:\-)?([\w\-]+)?/
 def get_config
   if RUBY_PLATFORM !~ /linux/
@@ -90,8 +35,6 @@ def get_config
   }
 end
 
-# config_ssl
-
 config = get_config
 puts "Building UringMachine (\n#{config.map { |(k, v)| "  #{k}: #{v}\n"}.join})"
 

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,16 +141,19 @@ 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))
@@ -187,18 +191,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 +325,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 +630,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 +781,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;
@@ -246,6 +246,4 @@ VALUE um_queue_shift(struct um *machine, struct um_queue *queue);
 
 void um_define_net_constants(VALUE mod);
 
-// void Init_micro_ssl(VALUE mod);
-
 #endif // UM_H

data/ext/um/um_class.c

@@ -368,7 +368,5 @@ void Init_UM(void) {
   rb_define_method(cUM, "unshift", UM_queue_unshift, 2);
   #endif
 
-  // Init_micro_ssl(cUM);
-
   um_define_net_constants(cUM);
 }

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

@@ -10,10 +10,23 @@ class UringMachine
     actor
   end
 
+  def spin_thread_actor(mod, *a, **k)
+    machine = UM.new
+    target = Object.new.extend(mod)
+    mailbox = UM::Queue.new
+    actor = Actor.new
+    thread = Thread.new do
+      actor.run(machine, target, mailbox)
+    end
+    target.setup(*a, **k)
+    snooze
+    actor
+  end
+
   class Actor < Fiber
     def run(machine, target, mailbox)
       @machine = machine
-      @target = target      
+      @target = target
       @mailbox = mailbox
       while (msg = machine.shift(mailbox))
         process_message(msg)
@@ -23,30 +36,26 @@ class UringMachine
     end
 
     def cast(sym, *a, **k)
-      self << [:cast, nil, sym, a, k]
+      @machine.push @mailbox, [:cast, nil, sym, a, k]
       self
     end
 
-    def call(sym, *a, **k)
-      self << [:call, Fiber.current, sym, a, k]
-      @machine.yield
+    def call(response_mailbox, sym, *a, **k)
+      @machine.push @mailbox, [:call, response_mailbox, sym, a, k]
+      @machine.shift response_mailbox
     end
 
     private
 
     def process_message(msg)
-      type, fiber, sym, args, kwargs = msg
+      type, response_mailbox, sym, args, kwargs = msg
       case type
       when :cast
         @target.send(sym, *args, **kwargs)
       when :call
         res = @target.send(sym, *args, **kwargs)
-        @machine.schedule(fiber, res)
+        @machine.push(response_mailbox, res)
       end
     end
-
-    def <<(msg)
-      @machine.push(@mailbox, msg)
-    end
   end
 end

data/lib/uringmachine/version.rb

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

data/lib/uringmachine.rb

@@ -12,30 +12,85 @@ class UringMachine
     @@fiber_map
   end
 
+  class Terminate < Exception
+  end
+
   def spin(value = nil, fiber_class = Fiber, &block)
     f = fiber_class.new do |resume_value|
-      block.(resume_value)
+      f.set_result block.(resume_value)
     rescue Exception => e
-      STDERR.puts "Unhandled fiber exception: #{e.inspect}"
-      STDERR.puts e.backtrace.join("\n")
-      exit
+      f.set_result e
     ensure
+      f.mark_as_done
+      # cleanup
       @@fiber_map.delete(f)
-      # yield control
+      self.notify_done_listeners(f)
+      # transfer control to other fibers
       self.yield
-      p :bad_bad_bad
     end
-    schedule(f, value)
+    self.schedule(f, value)
     @@fiber_map[f] = true
     f
   end
 
+  def join(*fibers)
+    results = fibers.inject({}) { |h, f| h[f] = nil; h }
+    queue = nil
+    pending = nil
+    fibers.each do |f|
+      if f.done?
+        results[f] = f.result
+      else
+        (pending ||= []) << f
+        queue ||= UM::Queue.new
+        f.add_done_listener(queue)
+      end
+    end
+    return results.values if !pending
+
+    while !pending.empty?
+      f = self.shift(queue)
+      pending.delete(f)
+      results[f] = f.result
+    end
+    results.values
+  end
+
   def resolve(hostname, type = :A)
     @resolver ||= DNSResolver.new(self)
     @resolver.resolve(hostname, type)
   end
 
-  def ssl_accept(fd, ssl_ctx)
-    SSL::Connection.new(self, fd, ssl_ctx)
+  private
+
+  def notify_done_listeners(fiber)
+    listeners = fiber.done_listeners
+    return if !listeners
+
+    listeners.each { self.push(it, fiber) }
+  end
+
+  module FiberExtensions
+    attr_reader :result, :done, :done_listeners
+
+    def mark_as_done
+      @done = true
+    end
+
+    def set_result(value)
+      @result = value
+    end
+
+    def done?
+      @done
+    end
+
+    def add_done_listener(queue)
+      (@done_listeners ||= []) << queue
+    end
+  end
+
+  class ::Fiber
+    include UringMachine::FiberExtensions
   end
 end

data/test/helper.rb

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