polyphony 0.38 → 0.43

data/ext/polyphony/thread.c

@@ -0,0 +1,206 @@
+#include "polyphony.h"
+
+ID ID_deactivate_all_watchers_post_fork;
+ID ID_empty;
+ID ID_ivar_agent;
+ID ID_ivar_join_wait_queue;
+ID ID_ivar_main_fiber;
+ID ID_ivar_result;
+ID ID_ivar_terminated;
+ID ID_pop;
+ID ID_push;
+ID ID_run_queue;
+ID ID_runnable_next;
+ID ID_stop;
+
+static VALUE Thread_setup_fiber_scheduling(VALUE self) {
+  VALUE queue;
+  
+  rb_ivar_set(self, ID_ivar_main_fiber, rb_fiber_current());
+  queue = rb_ary_new();
+  rb_ivar_set(self, ID_run_queue, queue);
+
+  return self;
+}
+
+int Thread_fiber_ref_count(VALUE self) {
+  VALUE agent = rb_ivar_get(self, ID_ivar_agent);
+  return NUM2INT(LibevAgent_ref_count(agent));
+}
+
+inline void Thread_fiber_reset_ref_count(VALUE self) {
+  VALUE agent = rb_ivar_get(self, ID_ivar_agent);
+  LibevAgent_reset_ref_count(agent);
+}
+
+static VALUE SYM_scheduled_fibers;
+static VALUE SYM_pending_watchers;
+
+static VALUE Thread_fiber_scheduling_stats(VALUE self) {
+  VALUE agent = rb_ivar_get(self,ID_ivar_agent);
+  VALUE stats = rb_hash_new();
+  VALUE queue = rb_ivar_get(self, ID_run_queue);
+  long pending_count;
+
+  long scheduled_count = RARRAY_LEN(queue);
+  rb_hash_aset(stats, SYM_scheduled_fibers, INT2NUM(scheduled_count));
+
+  pending_count = LibevAgent_pending_count(agent);
+  rb_hash_aset(stats, SYM_pending_watchers, INT2NUM(pending_count));
+
+  return stats;
+}
+
+VALUE Thread_schedule_fiber(VALUE self, VALUE fiber, VALUE value) {
+  VALUE queue;
+
+  if (rb_fiber_alive_p(fiber) != Qtrue) return self;
+
+  FIBER_TRACE(3, SYM_fiber_schedule, fiber, value);
+  // if fiber is already scheduled, just set the scheduled value, then return
+  rb_ivar_set(fiber, ID_runnable_value, value);
+  if (rb_ivar_get(fiber, ID_runnable) != Qnil) {
+    return self;
+  }
+
+  queue = rb_ivar_get(self, ID_run_queue);
+  rb_ary_push(queue, fiber);
+  rb_ivar_set(fiber, ID_runnable, Qtrue);
+
+  if (rb_thread_current() != self) {
+    // if the fiber scheduling is done across threads, we need to make sure the
+    // target thread is woken up in case it is in the middle of running its
+    // event selector. Otherwise it's gonna be stuck waiting for an event to
+    // happen, not knowing that it there's already a fiber ready to run in its
+    // run queue.
+    VALUE agent = rb_ivar_get(self,ID_ivar_agent);
+    LibevAgent_break(agent);
+  }
+  return self;
+}
+
+VALUE Thread_schedule_fiber_with_priority(VALUE self, VALUE fiber, VALUE value) {
+  VALUE queue;
+
+  if (rb_fiber_alive_p(fiber) != Qtrue) return self;
+
+  FIBER_TRACE(3, SYM_fiber_schedule, fiber, value);
+  rb_ivar_set(fiber, ID_runnable_value, value);
+
+  queue = rb_ivar_get(self, ID_run_queue);
+
+  // if fiber is already scheduled, remove it from the run queue
+  if (rb_ivar_get(fiber, ID_runnable) != Qnil) {
+    rb_ary_delete(queue, fiber);
+  } else {
+    rb_ivar_set(fiber, ID_runnable, Qtrue);
+  }
+
+  // the fiber is given priority by putting it at the front of the run queue
+  rb_ary_unshift(queue, fiber);
+
+  if (rb_thread_current() != self) {
+    // if the fiber scheduling is done across threads, we need to make sure the
+    // target thread is woken up in case it is in the middle of running its
+    // event loop. Otherwise it's gonna be stuck waiting for an event to
+    // happen, not knowing that it there's already a fiber ready to run in its
+    // run queue.
+    VALUE agent = rb_ivar_get(self, ID_ivar_agent);
+    LibevAgent_break(agent);
+  }
+  return self;
+}
+
+VALUE Thread_switch_fiber(VALUE self) {
+  VALUE current_fiber = rb_fiber_current();
+  VALUE queue = rb_ivar_get(self, ID_run_queue);
+  VALUE next_fiber;
+  VALUE value;
+  VALUE agent = rb_ivar_get(self, ID_ivar_agent);
+  int ref_count;
+
+  if (__tracing_enabled__) {
+    if (rb_ivar_get(current_fiber, ID_ivar_running) != Qfalse) {
+      rb_funcall(rb_cObject, ID_fiber_trace, 2, SYM_fiber_switchpoint, current_fiber);
+    }
+  }
+
+  ref_count = LibevAgent_ref_count(agent);
+  while (1) {
+    next_fiber = rb_ary_shift(queue);
+    if (next_fiber != Qnil) {
+      if (ref_count > 0) {
+        // this mechanism prevents event starvation in case the run queue never
+        // empties
+        LibevAgent_poll(agent, Qtrue, current_fiber, queue);
+      }
+      break;
+    }
+    if (ref_count == 0) break;
+
+    LibevAgent_poll(agent, Qnil, current_fiber, queue);
+  }
+
+  if (next_fiber == Qnil) return Qnil;
+
+  // run next fiber
+  value = rb_ivar_get(next_fiber, ID_runnable_value);
+  FIBER_TRACE(3, SYM_fiber_run, next_fiber, value);
+
+  rb_ivar_set(next_fiber, ID_runnable, Qnil);
+  RB_GC_GUARD(next_fiber);
+  RB_GC_GUARD(value);
+  return (next_fiber == current_fiber) ? 
+    value : rb_funcall(next_fiber, ID_transfer, 1, value);
+}
+
+VALUE Thread_reset_fiber_scheduling(VALUE self) {
+  VALUE queue = rb_ivar_get(self, ID_run_queue);
+  rb_ary_clear(queue);
+  Thread_fiber_reset_ref_count(self);
+  return self;
+}
+
+VALUE Thread_fiber_break_out_of_ev_loop(VALUE self, VALUE fiber, VALUE resume_obj) {
+  VALUE agent = rb_ivar_get(self, ID_ivar_agent);
+  if (fiber != Qnil) {
+    Thread_schedule_fiber_with_priority(self, fiber, resume_obj);
+  }
+
+  if (LibevAgent_break(agent) == Qnil) {
+    // we're not inside the ev_loop, so we just do a switchpoint
+    Thread_switch_fiber(self);
+  }
+
+  return self;
+}
+
+void Init_Thread() {
+  rb_define_method(rb_cThread, "setup_fiber_scheduling", Thread_setup_fiber_scheduling, 0);
+  rb_define_method(rb_cThread, "reset_fiber_scheduling", Thread_reset_fiber_scheduling, 0);
+  rb_define_method(rb_cThread, "fiber_scheduling_stats", Thread_fiber_scheduling_stats, 0);
+  rb_define_method(rb_cThread, "break_out_of_ev_loop", Thread_fiber_break_out_of_ev_loop, 2);
+
+  rb_define_method(rb_cThread, "schedule_fiber", Thread_schedule_fiber, 2);
+  rb_define_method(rb_cThread, "schedule_fiber_with_priority",
+    Thread_schedule_fiber_with_priority, 2);
+  rb_define_method(rb_cThread, "switch_fiber", Thread_switch_fiber, 0);
+
+  ID_deactivate_all_watchers_post_fork = rb_intern("deactivate_all_watchers_post_fork");
+  ID_empty                    = rb_intern("empty?");
+  ID_ivar_agent               = rb_intern("@agent");
+  ID_ivar_join_wait_queue     = rb_intern("@join_wait_queue");
+  ID_ivar_main_fiber          = rb_intern("@main_fiber");
+  ID_ivar_result              = rb_intern("@result");
+  ID_ivar_terminated          = rb_intern("@terminated");
+  ID_pop                      = rb_intern("pop");
+  ID_push                     = rb_intern("push");
+  ID_run_queue                = rb_intern("run_queue");
+  ID_runnable_next            = rb_intern("runnable_next");
+  ID_stop                     = rb_intern("stop");
+
+  SYM_scheduled_fibers = ID2SYM(rb_intern("scheduled_fibers"));
+  SYM_pending_watchers = ID2SYM(rb_intern("pending_watchers"));
+  rb_global_variable(&SYM_scheduled_fibers);
+  rb_global_variable(&SYM_pending_watchers);
+}

data/ext/{gyro → polyphony}/tracing.c

@@ -1,4 +1,4 @@
-#include "gyro.h"
+#include "polyphony.h"
 
 int __tracing_enabled__ = 0;
 

data/lib/polyphony.rb

@@ -1,45 +1,50 @@
 # frozen_string_literal: true
 
 require 'fiber'
-require_relative './gyro_ext'
+require_relative './polyphony_ext'
 
-Thread.event_selector = Gyro::Selector
-Thread.current.setup_fiber_scheduling
+module Polyphony
+  # Map Queue to Libev queue implementation
+  Queue = LibevQueue
+end
 
 require_relative './polyphony/extensions/core'
 require_relative './polyphony/extensions/thread'
 require_relative './polyphony/extensions/fiber'
 require_relative './polyphony/extensions/io'
 
+Thread.current.setup_fiber_scheduling
+Thread.current.agent = Polyphony::LibevAgent.new
+
 require_relative './polyphony/core/global_api'
 require_relative './polyphony/core/resource_pool'
 require_relative './polyphony/net'
-
 require_relative './polyphony/adapters/process'
+require_relative './polyphony/event'
 
 # Main Polyphony API
 module Polyphony
   class << self
     def wait_for_signal(sig)
+      raise "should be reimplemented"
+
       fiber = Fiber.current
-      Gyro.ref
+      # Polyphony.ref
       old_trap = trap(sig) do
-        Gyro.unref
+        # Polyphony.unref
         fiber.schedule(sig)
         trap(sig, old_trap)
       end
       suspend
+
     end
 
     def fork(&block)
-      old_threads = Thread.list - [Thread.current]
       Kernel.fork do
-        old_threads.each(&:deactivate_all_watchers_post_fork)
-
-        # Since the fiber doing the fork will become the main fiber of the
-        # forked process, we leave it behind by transferring to a new fiber
-        # created in the context of the forked process, which rescues *all*
-        # exceptions, including Interrupt and SystemExit.
+        # # Since the fiber doing the fork will become the main fiber of the
+        # # forked process, we leave it behind by transferring to a new fiber
+        # # created in the context of the forked process, which rescues *all*
+        # # exceptions, including Interrupt and SystemExit.
         spin_forked_block(&block).transfer
       end
     end
@@ -65,9 +70,9 @@ module Polyphony
       trap('SIGTERM', 'DEFAULT')
       trap('SIGINT', 'DEFAULT')
 
-      Thread.current.post_fork
       Thread.current.setup
       Fiber.current.setup_main_fiber
+      Thread.current.agent.post_fork
 
       install_terminating_signal_handlers
 

data/lib/polyphony/adapters/irb.rb

@@ -16,7 +16,7 @@ if Object.constants.include?(:Reline)
         fiber.cancel
       end
       read_ios.each do |io|
-        io.read_watcher.await
+        Thread.current.agent.wait_io(io, false)
         return [io]
       end
     rescue Polyphony::Cancel

data/lib/polyphony/adapters/postgres.rb

@@ -10,12 +10,13 @@ module ::PG
   end
 
   def self.connect_async(conn)
+    socket_io = conn.socket_io
     loop do
       res = conn.connect_poll
       case res
       when PGRES_POLLING_FAILED   then raise Error, conn.error_message
-      when PGRES_POLLING_READING  then conn.socket_io.read_watcher.await
-      when PGRES_POLLING_WRITING  then conn.socket_io.write_watcher.await
+      when PGRES_POLLING_READING  then Thread.current.agent.wait_io(socket_io, false)
+      when PGRES_POLLING_WRITING  then Thread.current.agent.wait_io(socket_io, true)
       when PGRES_POLLING_OK       then return conn.setnonblocking(true)
       end
     end
@@ -41,7 +42,7 @@ class ::PG::Connection
 
   def get_result(&block)
     while is_busy
-      socket_io.read_watcher.await
+      Thread.current.agent.wait_io(socket_io, false)
       consume_input
     end
     orig_get_result(&block)
@@ -58,7 +59,7 @@ class ::PG::Connection
 
   def block(_timeout = 0)
     while is_busy
-      socket_io.read_watcher.await
+      Thread.current.agent.wait_io(socket_io, false)
       consume_input
     end
   end
@@ -96,7 +97,7 @@ class ::PG::Connection
     return move_on_after(timeout) { wait_for_notify(&block) } if timeout
 
     loop do
-      socket_io.read_watcher.await
+      Thread.current.agent.wait_io(socket_io, false)
       consume_input
       notice = notifies
       next unless notice

data/lib/polyphony/adapters/process.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module Polyphony
+  # Process patches
   module Process
     class << self
       def watch(cmd = nil, &block)
         terminated = nil
         pid = cmd ? Kernel.spawn(cmd) : Polyphony.fork(&block)
-        watcher = Gyro::Child.new(pid)
-        watcher.await
+        Thread.current.agent.waitpid(pid)
         terminated = true
       ensure
         kill_process(pid) unless terminated || pid.nil?
       end
-      
+
       def kill_process(pid)
         cancel_after(5) do
           kill_and_await('TERM', pid)
@@ -20,10 +20,10 @@ module Polyphony
       rescue Polyphony::Cancel
         kill_and_await(-9, pid)
       end
-      
+
       def kill_and_await(sig, pid)
         ::Process.kill(sig, pid)
-        Gyro::Child.new(pid).await
+        Thread.current.agent.waitpid(pid)
       rescue SystemCallError
         # ignore
         puts 'SystemCallError in kill_and_await'

data/lib/polyphony/adapters/trace.rb

@@ -5,6 +5,7 @@ require_relative '../../polyphony'
 STOCK_EVENTS = %i[line call return c_call c_return b_call b_return].freeze
 
 module Polyphony
+  # Tracing functionality for Polyphony
   module Trace
     class << self
       def new(*events)
@@ -12,10 +13,10 @@ module Polyphony
         events = STOCK_EVENTS if events.empty?
         ::TracePoint.new(*events) { |tp| yield trace_record(tp, start_stamp) }
       end
-      
+
       def trace_record(trp, start_stamp)
         stamp = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start_stamp
-      
+
         { stamp: stamp, event: trp.event, location: "#{trp.path}:#{trp.lineno}",
           self: trp.self, binding: trp.binding, fiber: tp_fiber(trp),
           lineno: trp.lineno, method_id: trp.method_id,
@@ -23,103 +24,103 @@ module Polyphony
           return_value: tp_return_value(trp), schedule_value: tp_schedule_value(trp),
           exception: tp_raised_exception(trp) }
       end
-      
+
       def tp_fiber(trp)
         trp.is_a?(FiberTracePoint) ? trp.fiber : Fiber.current
       end
-      
+
       PARAMS_EVENTS = %i[call c_call b_call].freeze
-      
+
       def tp_params(trp)
         PARAMS_EVENTS.include?(trp.event) ? trp.parameters : nil
       end
-      
+
       RETURN_VALUE_EVENTS = %i[return c_return b_return].freeze
-      
+
       def tp_return_value(trp)
         RETURN_VALUE_EVENTS.include?(trp.event) ? trp.return_value : nil
       end
-      
+
       SCHEDULE_VALUE_EVENTS = %i[fiber_schedule fiber_run].freeze
-      
+
       def tp_schedule_value(trp)
         SCHEDULE_VALUE_EVENTS.include?(trp.event) ? trp.value : nil
       end
-      
+
       def tp_raised_exception(trp)
         trp.event == :raise && trp.raised_exception
       end
-      
+
       def analyze(records)
         by_fiber = Hash.new { |h, f| h[f] = [] }
         records.each_with_object(by_fiber) { |r, h| h[r[:fiber]] << r }
         { by_fiber: by_fiber }
       end
-      
+
       # Implements fake TracePoint instances for fiber-related events
       class FiberTracePoint
         attr_reader :event, :fiber, :value
-      
+
         def initialize(tpoint)
           @tp = tpoint
           @event = tpoint.return_value[0]
           @fiber = tpoint.return_value[1]
           @value = tpoint.return_value[2]
         end
-      
+
         def lineno
           @tp.lineno
         end
-      
+
         def method_id
           @tp.method_id
         end
-      
+
         def path
           @tp.path
         end
-      
+
         def self
           @tp.self
         end
-      
+
         def binding
           @tp.binding
         end
       end
-      
+
       class << ::TracePoint
         POLYPHONY_FILE_REGEXP = /^#{::Exception::POLYPHONY_DIR}/.freeze
-      
+
         alias_method :orig_new, :new
         def new(*args, &block)
           events_mask, fiber_events_mask = event_masks(args)
-      
+
           orig_new(*events_mask) do |tp|
             handle_tp_event(tp, fiber_events_mask, &block)
           end
         end
-      
+
         def handle_tp_event(tpoint, fiber_events_mask)
           # next unless !$watched_fiber || Fiber.current == $watched_fiber
-      
+
           if tpoint.method_id == :__fiber_trace__
             return if tpoint.event != :c_return
             return unless fiber_events_mask.include?(tpoint.return_value[0])
-      
+
             tpoint = FiberTracePoint.new(tpoint)
           elsif tpoint.path =~ POLYPHONY_FILE_REGEXP
             return
           end
-      
+
           yield tpoint
         end
-      
+
         ALL_FIBER_EVENTS = %i[
           fiber_create fiber_terminate fiber_schedule fiber_switchpoint fiber_run
           fiber_ev_loop_enter fiber_ev_loop_leave
         ].freeze
-      
+
         def event_masks(events)
           events.each_with_object([[], []]) do |e, masks|
             case e
@@ -135,4 +136,3 @@ module Polyphony
     end
   end
 end
-