polyphony 0.59.1 → 0.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aba9d551e940893d6d3303d93d514b520b7b649a1db99b101bdbbcdec762501
-  data.tar.gz: 601d33709dc92bb0c029d9dba5d555441a2b5a6721b807185a36d65cb5ef8170
+  metadata.gz: 515e9a5686bb0eedb02ad626e491b3e8acb350a765a468029e0b5357673f443c
+  data.tar.gz: 94fd7eaedd37c01f1ebc33ba78ffb00d3e8fc42f4a0266bf63ba8eedb83d008c
 SHA512:
-  metadata.gz: 2a7e355b5f8857093082d75759942f5d3a63ab40cf3a0f46045829e2c223ae92dbcc370ceb2dd3f26bd04e0bb036eb03ab40ef65a011cd172dd6c122698541fa
-  data.tar.gz: e8708853190d44c82f3088ba0baecf19f03110a11c2cf229f0015c800b23da01e1eb0d94af20cb2af7fd8dd7bdafde9bf218f484c57cda358c0da187dfeb4b6e
+  metadata.gz: a546bcf43f556dc7d6bbc3c04b9448141a539e91d2d893441a161eecf9246ff516a54cf94cae476ef9358470e5475c98577c807fd1cef1f712f342337d3c8cc8
+  data.tar.gz: e0bb07cc0028c3205f3c2d87a59699e35e3d4d0e797eff63258892475548086125ed40e63152c56253a1c596b680eacc7080bf08f7d152576c34dc57df0206ab

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.60 2021-07-15
+
+
+- Fix linux version detection (for kernel version > 5.9)
+- Fix op ctx leak in io_uring backend (when polling for I/O readiness)
+- Add support for appending to buffer in `Backend#read`, `Backend#recv` methods
+- Improve anti-event starvation mechanism
+- Redesign fiber monitoring mechanism
+- Implement `Fiber#attach`
+- Add optional maxlen argument to `IO#read_loop`, `Socket#recv_loop` (#60)
+- Implement `Fiber#detach` (#52)
+
 ## 0.59.1 2021-06-28
 
 - Accept fiber tag in `Polyphony::Timer.new`

data/Gemfile.lock

@@ -1,27 +1,25 @@
 PATH
   remote: .
   specs:
-    polyphony (0.59.1)
+    polyphony (0.59.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    ast (2.4.0)
+    ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    docile (1.3.2)
-    hiredis (0.6.3)
-    http_parser.rb (0.6.0)
+    docile (1.4.0)
     httparty (0.17.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (2.3.0)
+    json (2.5.1)
     localhost (1.1.8)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2021.0704)
     minitest (5.14.4)
     minitest-reporters (1.4.2)
       ansi
@@ -30,22 +28,18 @@ GEM
       ruby-progressbar
     msgpack (1.4.2)
     multi_xml (0.6.0)
-    mysql2 (0.5.3)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    pg (1.1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     rake-compiler (1.1.1)
       rake
-    redis (4.1.0)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -55,37 +49,29 @@ GEM
       rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    sequel (5.34.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  hiredis (= 0.6.3)
-  http_parser.rb (~> 0.6.0)
   httparty (= 0.17.1)
   localhost (~> 1.1.4)
   minitest (= 5.14.4)
   minitest-reporters (= 1.4.2)
   msgpack (= 1.4.2)
-  mysql2 (= 0.5.3)
-  pg (= 1.1.4)
   polyphony!
   pry (= 0.13.1)
-  rack (>= 2.0.8, < 2.3.0)
   rake-compiler (= 1.1.1)
-  redis (= 4.1.0)
   rubocop (= 0.85.1)
-  sequel (= 5.34.0)
   simplecov (= 0.17.1)
 
 BUNDLED WITH

data/examples/core/message_based_supervision.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+class Supervisor
+  def initialize(*fibers)
+    @fiber = spin { do_supervise }
+    @fiber.message_on_child_termination = true
+    fibers.each { |f| add(f) }
+  end
+
+  def await
+    @fiber.await
+  end
+
+  def spin(tag = nil, &block)
+    @fiber.spin(tag, &block)
+  end
+
+  def add(fiber)
+    fiber.attach(@fiber)
+  end
+
+  def do_supervise
+    loop do
+      msg = receive
+      # puts "Supervisor received #{msg.inspect}"
+      f, r = msg
+      puts "Fiber #{f.tag} terminated with #{r.inspect}, restarting..."
+      f.restart
+    end
+  end
+end
+
+def supervise(*fibers)
+  supervisor = Supervisor.new(*fibers)
+  supervisor.await
+end
+
+def start_worker(id)
+  spin_loop(:"worker#{id}") do
+    duration = rand(0.5..1.0)
+    puts "Worker #{id} sleeping for #{duration} seconds"
+    sleep duration
+    raise 'foo' if rand > 0.7
+    break if rand > 0.6
+  end  
+end
+
+supervise(start_worker(1), start_worker(2))

data/ext/polyphony/backend_common.c

@@ -25,6 +25,11 @@ inline void backend_base_mark(struct Backend_base *base) {
   runqueue_mark(&base->runqueue);
 }
 
+inline void conditional_nonblocking_poll(VALUE backend, struct Backend_base *base, VALUE current, VALUE next) {
+  if (runqueue_should_poll_nonblocking(&base->runqueue) || next == current) 
+    Backend_poll(backend, Qnil);
+}
+
 VALUE backend_base_switch_fiber(VALUE backend, struct Backend_base *base) {
   VALUE current_fiber = rb_fiber_current();
   runqueue_entry next;
@@ -32,26 +37,22 @@ VALUE backend_base_switch_fiber(VALUE backend, struct Backend_base *base) {
   unsigned int backend_was_polled = 0;
   unsigned int idle_tasks_run_count = 0;
 
-  if (SHOULD_TRACE(base) && (rb_ivar_get(current_fiber, ID_ivar_running) != Qfalse))
-    TRACE(base, 2, SYM_fiber_switchpoint, current_fiber);
+  COND_TRACE(base, 2, SYM_fiber_switchpoint, current_fiber);
 
   while (1) {
     next = runqueue_shift(&base->runqueue);
     if (next.fiber != Qnil) {
       // Polling for I/O op completion is normally done when the run queue is
       // empty, but if the runqueue never empties, we'll never get to process
-      // any event completions. In order to prevent this, an anti-starve
+      // any event completions. In order to prevent this, an anti-starvation
       // mechanism is employed, under the following conditions:
       // - a blocking poll was not yet performed
       // - there are pending blocking operations
-      // - the runqueue has signalled that a non-blocking poll should be
-      //   performed
-      //   - the run queue length high watermark has reached its threshold (currently 128)
-      //   - the run queue switch counter has reached its threshold (currently 64) 
-      if (!backend_was_polled && pending_ops_count && runqueue_should_poll_nonblocking(&base->runqueue)) {
-        // this prevents event starvation in case the run queue never empties
-        Backend_poll(backend, Qnil);
-      }
+      // - the runqueue shift count has reached a fixed threshold (currently 64), or
+      // - the next fiber is the same as the current fiber (a single fiber is snoozing)
+      if (!backend_was_polled && pending_ops_count)
+        conditional_nonblocking_poll(backend, base, current_fiber, next.fiber);
+
       break;
     }
     
@@ -82,7 +83,8 @@ void backend_base_schedule_fiber(VALUE thread, VALUE backend, struct Backend_bas
   if (rb_fiber_alive_p(fiber) != Qtrue) return;
   already_runnable = rb_ivar_get(fiber, ID_ivar_runnable) != Qnil;
 
-  COND_TRACE(base, 3, SYM_fiber_schedule, fiber, value);
+  COND_TRACE(base, 4, SYM_fiber_schedule, fiber, value, prioritize ? Qtrue : Qfalse);
+
   (prioritize ? runqueue_unshift : runqueue_push)(&base->runqueue, fiber, value, already_runnable);
   if (!already_runnable) {
     rb_ivar_set(fiber, ID_ivar_runnable, Qtrue);
@@ -171,7 +173,7 @@ inline VALUE io_enc_str(VALUE str, rb_io_t *fptr) {
 //////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////
 
-VALUE backend_await(struct Backend_base *backend) {
+inline VALUE backend_await(struct Backend_base *backend) {
   VALUE ret;
   backend->pending_count++;
   ret = Thread_switch_fiber(rb_thread_current());
@@ -180,9 +182,10 @@ VALUE backend_await(struct Backend_base *backend) {
   return ret;
 }
 
-VALUE backend_snooze() {
+inline VALUE backend_snooze() {
+  VALUE ret;
   Fiber_make_runnable(rb_fiber_current(), Qnil);
-  VALUE ret = Thread_switch_fiber(rb_thread_current());
+  ret = Thread_switch_fiber(rb_thread_current());
   return ret;
 }
 

data/ext/polyphony/backend_common.h

@@ -7,7 +7,6 @@
 
 struct backend_stats {
   int scheduled_fibers;
-  int waiting_fibers;
   int pending_ops;
 };
 

data/ext/polyphony/backend_io_uring.c

@@ -197,6 +197,15 @@ inline VALUE Backend_poll(VALUE self, VALUE blocking) {
   }
 
   COND_TRACE(&backend->base, 2, SYM_fiber_event_poll_enter, rb_fiber_current());
+  // if (SHOULD_TRACE(&backend->base))
+  //   printf(
+  //     "io_uring_poll(blocking_mode: %d, pending: %d, taken: %d, available: %d, runqueue: %d\n",
+  //     is_blocking,
+  //     backend->base.pending_count,
+  //     backend->store.taken_count,
+  //     backend->store.available_count,
+  //     backend->base.runqueue.entries.count
+  //   );
   if (is_blocking) io_uring_backend_poll(backend);
   io_uring_backend_handle_ready_cqes(backend);
   COND_TRACE(&backend->base, 2, SYM_fiber_event_poll_leave, rb_fiber_current());
@@ -231,7 +240,6 @@ inline struct backend_stats Backend_stats(VALUE self) {
 
   return (struct backend_stats){
     .scheduled_fibers = runqueue_len(&backend->base.runqueue),
-    .waiting_fibers = 0,
     .pending_ops = backend->base.pending_count
   };
 }
@@ -302,17 +310,25 @@ VALUE io_uring_backend_wait_fd(Backend_t *backend, int fd, int write) {
   io_uring_prep_poll_add(sqe, fd, write ? POLLOUT : POLLIN);
 
   io_uring_backend_defer_submit_and_await(backend, sqe, ctx, &resumed_value);
+  context_store_release(&backend->store, ctx);
+
   RB_GC_GUARD(resumed_value);
   return resumed_value;
 }
 
-VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof) {
+VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof, VALUE pos) {
   Backend_t *backend;
   rb_io_t *fptr;
   long dynamic_len = length == Qnil;
   long buffer_size = dynamic_len ? 4096 : NUM2INT(length);
-  int shrinkable = io_setstrbuf(&str, buffer_size);
-  char *buf = RSTRING_PTR(str);
+  long buf_pos = NUM2INT(pos);
+  if (str != Qnil) {
+    int current_len = RSTRING_LEN(str);
+    if (buf_pos < 0 || buf_pos > current_len) buf_pos = current_len;
+  }
+  else buf_pos = 0;
+  int shrinkable = io_setstrbuf(&str, buf_pos + buffer_size);
+  char *buf = RSTRING_PTR(str) + buf_pos;
   long total = 0;
   int read_to_eof = RTEST(to_eof);
   VALUE underlying_io = rb_ivar_get(io, ID_ivar_io);
@@ -349,9 +365,9 @@ VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof)
         if (!dynamic_len) break;
 
         // resize buffer
-        rb_str_resize(str, total);
+        rb_str_resize(str, buf_pos + total);
         rb_str_modify_expand(str, buffer_size);
-        buf = RSTRING_PTR(str) + total;
+        buf = RSTRING_PTR(str) + buf_pos + total;
         shrinkable = 0;
         buffer_size += buffer_size;
       }
@@ -359,7 +375,7 @@ VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof)
     }
   }
 
-  io_set_read_length(str, total, shrinkable);
+  io_set_read_length(str, buf_pos + total, shrinkable);
   io_enc_str(str, fptr);
 
   if (!total) return Qnil;
@@ -367,12 +383,12 @@ VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof)
   return str;
 }
 
-VALUE Backend_read_loop(VALUE self, VALUE io) {
+VALUE Backend_read_loop(VALUE self, VALUE io, VALUE maxlen) {
   Backend_t *backend;
   rb_io_t *fptr;
   VALUE str;
   long total;
-  long len = 8192;
+  long len = NUM2INT(maxlen);
   int shrinkable;
   char *buf;
   VALUE underlying_io = rb_ivar_get(io, ID_ivar_io);
@@ -580,13 +596,19 @@ VALUE Backend_write_m(int argc, VALUE *argv, VALUE self) {
     Backend_writev(self, argv[0], argc - 1, argv + 1);
 }
 
-VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length) {
+VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length, VALUE pos) {
   Backend_t *backend;
   rb_io_t *fptr;
   long dynamic_len = length == Qnil;
   long len = dynamic_len ? 4096 : NUM2INT(length);
-  int shrinkable = io_setstrbuf(&str, len);
-  char *buf = RSTRING_PTR(str);
+  long buf_pos = NUM2INT(pos);
+  if (str != Qnil) {
+    int current_len = RSTRING_LEN(str);
+    if (buf_pos < 0 || buf_pos > current_len) buf_pos = current_len;
+  }
+  else buf_pos = 0;
+  int shrinkable = io_setstrbuf(&str, buf_pos + len);
+  char *buf = RSTRING_PTR(str) + buf_pos;
   long total = 0;
   VALUE underlying_io = rb_ivar_get(io, ID_ivar_io);
 
@@ -618,7 +640,7 @@ VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length) {
     }
   }
 
-  io_set_read_length(str, total, shrinkable);
+  io_set_read_length(str, buf_pos + total, shrinkable);
   io_enc_str(str, fptr);
 
   if (!total) return Qnil;
@@ -626,12 +648,12 @@ VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length) {
   return str;
 }
 
-VALUE Backend_recv_loop(VALUE self, VALUE io) {
+VALUE Backend_recv_loop(VALUE self, VALUE io, VALUE maxlen) {
   Backend_t *backend;
   rb_io_t *fptr;
   VALUE str;
   long total;
-  long len = 8192;
+  long len = NUM2INT(maxlen);
   int shrinkable;
   char *buf;
   VALUE underlying_io = rb_ivar_get(io, ID_ivar_io);
@@ -1421,11 +1443,11 @@ void Init_Backend() {
   rb_define_method(cBackend, "accept_loop", Backend_accept_loop, 2);
   rb_define_method(cBackend, "connect", Backend_connect, 3);
   rb_define_method(cBackend, "feed_loop", Backend_feed_loop, 3);
-  rb_define_method(cBackend, "read", Backend_read, 4);
-  rb_define_method(cBackend, "read_loop", Backend_read_loop, 1);
-  rb_define_method(cBackend, "recv", Backend_recv, 3);
+  rb_define_method(cBackend, "read", Backend_read, 5);
+  rb_define_method(cBackend, "read_loop", Backend_read_loop, 2);
+  rb_define_method(cBackend, "recv", Backend_recv, 4);
   rb_define_method(cBackend, "recv_feed_loop", Backend_recv_feed_loop, 3);
-  rb_define_method(cBackend, "recv_loop", Backend_recv_loop, 1);
+  rb_define_method(cBackend, "recv_loop", Backend_recv_loop, 2);
   rb_define_method(cBackend, "send", Backend_send, 3);
   rb_define_method(cBackend, "sendv", Backend_sendv, 3);
   rb_define_method(cBackend, "sleep", Backend_sleep, 1);

data/ext/polyphony/backend_io_uring_context.c

@@ -25,6 +25,8 @@ void context_store_initialize(op_context_store_t *store) {
   store->last_id = 0;
   store->available = NULL;
   store->taken = NULL;
+  store->available_count = 0;
+  store->taken_count = 0;
 }
 
 inline op_context_t *context_store_acquire(op_context_store_t *store, enum op_type type) {
@@ -32,12 +34,12 @@ inline op_context_t *context_store_acquire(op_context_store_t *store, enum op_ty
   if (ctx) {
     if (ctx->next) ctx->next->prev = NULL;
     store->available = ctx->next;
+    store->available_count--;
   }
   else {
     ctx = malloc(sizeof(op_context_t));
   }
   ctx->id = (++store->last_id);
-  // printf("acquire %p %d (%s)\n", ctx, ctx->id, op_type_to_str(type));
   ctx->prev = NULL;
   ctx->next = store->taken;
   if (store->taken) store->taken->prev = ctx;
@@ -49,6 +51,10 @@ inline op_context_t *context_store_acquire(op_context_store_t *store, enum op_ty
   ctx->ref_count = 2;
   ctx->result = 0;
 
+  store->taken_count++;
+
+  // printf("acquire %p %d (%s, ref_count: %d) taken: %d\n", ctx, ctx->id, op_type_to_str(type), ctx->ref_count, store->taken_count);
+
   return ctx;
 }
 
@@ -61,6 +67,9 @@ inline int context_store_release(op_context_store_t *store, op_context_t *ctx) {
   ctx->ref_count--;
   if (ctx->ref_count) return 0;
 
+  store->taken_count--;
+  store->available_count++;
+
   if (ctx->next) ctx->next->prev = ctx->prev;
   if (ctx->prev) ctx->prev->next = ctx->next;
   if (store->taken == ctx) store->taken = ctx->next;