polyphony 0.43.6 → 0.43.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b048cfa1e0d7cd542840ab9f2198349b2474d40a6d943b584d1bcb57593ca41d
-  data.tar.gz: 0d9ed9fc45ec2165018e61f8befbdefb5668cfcf4b7628a648a055f5b6052e4c
+  metadata.gz: bea457e28d23f96570d448855d00cf76250a55fcb02e12c4305cb551cb55faf4
+  data.tar.gz: dc97409e61ce82c20eef25101a2c53046635461ef81302e54b121e5bb9c25aa1
 SHA512:
-  metadata.gz: a962cb0db032fd58a8db4024d9a6ad2d1be5307caff72d9508bdf879bafbd6c55a5c79e9bc69a9d3bda96d2f72fda51ed2f978e96fa0ca636458284e9e9dbbaf
-  data.tar.gz: 2b419313309e898003399f780abcf7641de34c3350ae5d7c10c785209e3e6c12e4d741b01676a49ec1ec2f3f15ea8f9001636ec44880e13583d68168f82c9cb7
+  metadata.gz: 53d345ee472bc77fc993880a1a725064bb934ec2789fa72bd97ec07b558942369860fb7077e0fcff6c95cfcff0c0d712090f70b1d9ff7f652160d15ddfc77de4
+  data.tar.gz: 513a79eeb8a7766078d159cf85d367a6f3f50a0870825275408081d9cfe4e446e7f0b0120bd712f6281ccd0787779ec464b20c9e17c3c60178ceb39c061033c7

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.43.8 2020-07-21
+
+* Rename `LibevQueue` to `Queue`
+* Reimplement Event using `Agent#wait_event`
+* Improve Queue shift queue performance
+* Introduce `Agent#wait_event` API for waiting on asynchronous events
+* Minimize `fcntl` syscalls in IO operations 
+
+## 0.43.7 2020-07-20
+
+* Fix memory leak in ResourcePool (#31)
+* Check and adjust file position before reading (#30)
+* Minor documentation fixes
+
 ## 0.43.6 2020-07-18
 
 * Allow brute-force interrupting with second Ctrl-C

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.43.6)
+    polyphony (0.43.8)
 
 GEM
   remote: https://rubygems.org/

data/TODO.md

@@ -1,6 +1,5 @@
-## 0.43 
-
-- Reimplement ResourcePool, Channel, Mutex using LibevQueue
+- Implement `LibevAgent#connect` API
+- Reimplement ResourcePool, Channel, Mutex using Queue
 -- Add `Fiber#schedule_with_priority` method, aliased by `Fiber#wakeup`
 - Implement agent interface is virtual function table
 - Implement proxy agent for plugging in a user-provided agent class

data/docs/getting-started/overview.md

@@ -113,8 +113,8 @@ active concurrent connections, each advancing at its own pace, consuming only a
 single CPU core.
 
 Nevertheless, Polyphony fully supports multithreading, with each thread having
-its own fiber run queue and its own libev event loop. In addition, Polyphony
-enables cross-thread communication using  
+its own fiber run queue and its own libev event loop. Polyphony even enables
+cross-thread communication using [fiber messaging](#message-passing). 
 
 ## Fibers vs Callbacks
 

data/examples/performance/fiber_transfer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'fiber'
+
+class Fiber
+  attr_accessor :next
+end
+
+# This program shows how the performance 
+
+def run(num_fibers)
+  count = 0
+
+  GC.disable
+
+  first = nil
+  last = nil
+  supervisor = Fiber.current
+  num_fibers.times do
+    fiber = Fiber.new do
+      loop do
+        count += 1
+        if count == 1_000_000
+          supervisor.transfer
+        else
+          Fiber.current.next.transfer
+        end
+      end
+    end
+    first ||= fiber
+    last.next = fiber if last
+    last = fiber
+  end
+
+  last.next = first
+  
+  t0 = Time.now
+  first.transfer
+  elapsed = Time.now - t0
+
+  puts "fibers: #{num_fibers} count: #{count} rate: #{count / elapsed}"
+  GC.start
+end
+
+run(100)
+run(1000)
+run(10000)

data/ext/polyphony/libev_agent.c

@@ -1,6 +1,8 @@
 #include <netdb.h>
 #include <sys/socket.h>
 #include <sys/uio.h>
+#include <unistd.h>
+#include <fcntl.h>
 
 #include "polyphony.h"
 #include "../libev/ev.h"
@@ -131,7 +133,7 @@ VALUE LibevAgent_poll(VALUE self, VALUE nowait, VALUE current_fiber, VALUE queue
   GetLibevAgent(self, agent);
 
   if (is_nowait) {
-    long runnable_count = LibevQueue_len(queue);
+    long runnable_count = Queue_len(queue);
     agent->run_no_wait_count++;
     if (agent->run_no_wait_count < runnable_count || agent->run_no_wait_count < 10)
       return self;
@@ -278,6 +280,31 @@ VALUE libev_snooze() {
   return Thread_switch_fiber(rb_thread_current());
 }
 
+ID ID_ivar_is_nonblocking;
+
+// Since we need to ensure that fd's are non-blocking before every I/O
+// operation, here we improve upon Ruby's rb_io_set_nonblock by caching the
+// "nonblock" state in an instance variable. Calling rb_ivar_get on every read
+// is still much cheaper than doing a fcntl syscall on every read! Preliminary
+// benchmarks (with a "hello world" HTTP server) show throughput is improved
+// by 10-13%.
+inline void io_set_nonblock(rb_io_t *fptr, VALUE io) {
+#ifdef _WIN32
+  return rb_w32_set_nonblock(fptr->fd);
+#elif defined(F_GETFL)
+  VALUE is_nonblocking = rb_ivar_get(io, ID_ivar_is_nonblocking);
+  if (is_nonblocking == Qnil) {
+    rb_ivar_set(io, ID_ivar_is_nonblocking, Qtrue);
+    int oflags = fcntl(fptr->fd, F_GETFL);
+    if (oflags == -1) return;
+    if (oflags & O_NONBLOCK) return;
+    oflags |= O_NONBLOCK;
+    fcntl(fptr->fd, F_SETFL, oflags);
+  }
+#endif
+  return;
+}
+
 VALUE LibevAgent_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof) {
   struct LibevAgent_t *agent;
   struct libev_io watcher;
@@ -295,11 +322,20 @@ VALUE LibevAgent_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eo
   if (underlying_io != Qnil) io = underlying_io;
   GetOpenFile(io, fptr);
   rb_io_check_byte_readable(fptr);
-  rb_io_set_nonblock(fptr);
+  io_set_nonblock(fptr, io);
   watcher.fiber = Qnil;
   
   OBJ_TAINT(str);
 
+  // Apparently after reopening a closed file, the file position is not reset,
+  // which causes the read to fail. Fortunately we can use fptr->rbuf.len to
+  // find out if that's the case.
+  // See: https://github.com/digital-fabric/polyphony/issues/30
+  if (fptr->rbuf.len > 0) {
+    lseek(fptr->fd, -fptr->rbuf.len, SEEK_CUR);
+    fptr->rbuf.len = 0;
+  }
+
   while (1) {
     ssize_t n = read(fptr->fd, buf, len - total);
     if (n < 0) {
@@ -349,6 +385,7 @@ VALUE LibevAgent_read_loop(VALUE self, VALUE io) {
     shrinkable = io_setstrbuf(&str, len); \
     buf = RSTRING_PTR(str); \
     total = 0; \
+    OBJ_TAINT(str); \
   }
 
   #define YIELD_STR() { \
@@ -375,10 +412,17 @@ VALUE LibevAgent_read_loop(VALUE self, VALUE io) {
   if (underlying_io != Qnil) io = underlying_io;
   GetOpenFile(io, fptr);
   rb_io_check_byte_readable(fptr);
-  rb_io_set_nonblock(fptr);
+  io_set_nonblock(fptr, io);
   watcher.fiber = Qnil;
 
-  OBJ_TAINT(str);
+  // Apparently after reopening a closed file, the file position is not reset,
+  // which causes the read to fail. Fortunately we can use fptr->rbuf.len to
+  // find out if that's the case.
+  // See: https://github.com/digital-fabric/polyphony/issues/30
+  if (fptr->rbuf.len > 0) {
+    lseek(fptr->fd, -fptr->rbuf.len, SEEK_CUR);
+    fptr->rbuf.len = 0;
+  }
 
   while (1) {
     ssize_t n = read(fptr->fd, buf, len);
@@ -553,7 +597,7 @@ VALUE LibevAgent_accept(VALUE self, VALUE sock) {
 
   GetLibevAgent(self, agent);
   GetOpenFile(sock, fptr);
-  rb_io_set_nonblock(fptr);
+  io_set_nonblock(fptr, sock);
   watcher.fiber = Qnil;
   while (1) {
     fd = accept(fptr->fd, &addr, &len);
@@ -579,7 +623,7 @@ VALUE LibevAgent_accept(VALUE self, VALUE sock) {
       fp->fd = fd;
       fp->mode = FMODE_READWRITE | FMODE_DUPLEX;
       rb_io_ascii8bit_binmode(socket);
-      rb_io_set_nonblock(fp);
+      io_set_nonblock(fp, socket);
       rb_io_synchronized(fp);
       
       // if (rsock_do_not_reverse_lookup) {
@@ -608,7 +652,7 @@ VALUE LibevAgent_accept_loop(VALUE self, VALUE sock) {
 
   GetLibevAgent(self, agent);
   GetOpenFile(sock, fptr);
-  rb_io_set_nonblock(fptr);
+  io_set_nonblock(fptr, sock);
   watcher.fiber = Qnil;
 
   while (1) {
@@ -634,7 +678,7 @@ VALUE LibevAgent_accept_loop(VALUE self, VALUE sock) {
       fp->fd = fd;
       fp->mode = FMODE_READWRITE | FMODE_DUPLEX;
       rb_io_ascii8bit_binmode(socket);
-      rb_io_set_nonblock(fp);
+      io_set_nonblock(fp, socket);
       rb_io_synchronized(fp);
 
       rb_yield(socket);
@@ -662,7 +706,7 @@ error:
 
 //   GetLibevAgent(self, agent);
 //   GetOpenFile(sock, fptr);
-//   rb_io_set_nonblock(fptr);
+//   io_set_nonblock(fptr, sock);
 //   watcher.fiber = Qnil;
 
 //   addr.sin_family = AF_INET; 
@@ -737,6 +781,7 @@ VALUE LibevAgent_sleep(VALUE self, VALUE duration) {
   ev_timer_start(agent->ev_loop, &watcher.timer);
 
   switchpoint_result = libev_await(agent);
+
   ev_timer_stop(agent->ev_loop, &watcher.timer);
 
   TEST_RESUME_EXCEPTION(switchpoint_result);
@@ -785,6 +830,25 @@ struct ev_loop *LibevAgent_ev_loop(VALUE self) {
   return agent->ev_loop;
 }
 
+void LibevAgent_async_callback(EV_P_ ev_async *w, int revents) { }
+
+VALUE LibevAgent_wait_event(VALUE self, VALUE raise) {
+  struct LibevAgent_t *agent;
+  struct ev_async async;
+  VALUE switchpoint_result = Qnil;
+  GetLibevAgent(self, agent);
+
+  ev_async_init(&async, LibevAgent_async_callback);
+  ev_async_start(agent->ev_loop, &async);
+  
+  switchpoint_result = libev_await(agent);
+  ev_async_stop(agent->ev_loop, &async);
+
+  if (RTEST(raise)) TEST_RESUME_EXCEPTION(switchpoint_result);
+  RB_GC_GUARD(switchpoint_result);
+  return switchpoint_result;
+}
+
 void Init_LibevAgent() {
   rb_require("socket");
   cTCPSocket = rb_const_get(rb_cObject, rb_intern("TCPSocket"));
@@ -812,4 +876,7 @@ void Init_LibevAgent() {
   rb_define_method(cLibevAgent, "wait_io", LibevAgent_wait_io, 2);
   rb_define_method(cLibevAgent, "sleep", LibevAgent_sleep, 1);
   rb_define_method(cLibevAgent, "waitpid", LibevAgent_waitpid, 1);
+  rb_define_method(cLibevAgent, "wait_event", LibevAgent_wait_event, 1);
+
+  ID_ivar_is_nonblocking = rb_intern("@is_nonblocking");
 }

data/ext/polyphony/polyphony.c

@@ -2,7 +2,6 @@
 
 VALUE mPolyphony;
 
-ID ID_await_no_raise;
 ID ID_call;
 ID ID_caller;
 ID ID_clear;
@@ -54,7 +53,6 @@ void Init_Polyphony() {
   rb_define_global_function("snooze", Polyphony_snooze, 0);
   rb_define_global_function("suspend", Polyphony_suspend, 0);
 
-  ID_await_no_raise = rb_intern("await_no_raise");
   ID_call           = rb_intern("call");
   ID_caller         = rb_intern("caller");
   ID_clear          = rb_intern("clear");

data/ext/polyphony/polyphony.h

@@ -19,10 +19,9 @@
 }
 
 extern VALUE mPolyphony;
-extern VALUE cLibevQueue;
+extern VALUE cQueue;
 extern VALUE cEvent;
 
-extern ID ID_await_no_raise;
 extern ID ID_call;
 extern ID ID_caller;
 extern ID ID_clear;
@@ -75,15 +74,16 @@ VALUE LibevAgent_ref(VALUE self);
 VALUE LibevAgent_unref(VALUE self);
 int LibevAgent_ref_count(VALUE self);
 void LibevAgent_reset_ref_count(VALUE self);
-
-VALUE LibevQueue_push(VALUE self, VALUE value);
-VALUE LibevQueue_unshift(VALUE self, VALUE value);
-VALUE LibevQueue_shift(VALUE self);
-VALUE LibevQueue_shift_no_wait(VALUE self);
-VALUE LibevQueue_clear(VALUE self);
-VALUE LibevQueue_delete(VALUE self, VALUE value);
-long LibevQueue_len(VALUE self);
-void LibevQueue_trace(VALUE self);
+VALUE LibevAgent_wait_event(VALUE self, VALUE raise);
+
+VALUE Queue_push(VALUE self, VALUE value);
+VALUE Queue_unshift(VALUE self, VALUE value);
+VALUE Queue_shift(VALUE self);
+VALUE Queue_shift_no_wait(VALUE self);
+VALUE Queue_clear(VALUE self);
+VALUE Queue_delete(VALUE self, VALUE value);
+long Queue_len(VALUE self);
+void Queue_trace(VALUE self);
 
 VALUE Polyphony_snooze(VALUE self);
 

data/ext/polyphony/polyphony_ext.c

@@ -3,7 +3,7 @@
 void Init_Fiber();
 void Init_Polyphony();
 void Init_LibevAgent();
-void Init_LibevQueue();
+void Init_Queue();
 void Init_Thread();
 void Init_Tracing();
 
@@ -12,7 +12,7 @@ void Init_polyphony_ext() {
 
   Init_Polyphony();
   Init_LibevAgent();
-  Init_LibevQueue();
+  Init_Queue();
 
   Init_Fiber();
   Init_Thread();

data/ext/polyphony/queue.c

@@ -0,0 +1,168 @@
+#include "polyphony.h"
+#include "ring_buffer.h"
+
+typedef struct queue {
+  ring_buffer values;
+  ring_buffer shift_queue;
+} Queue_t;
+
+VALUE cQueue = Qnil;
+
+static void Queue_mark(void *ptr) {
+  Queue_t *queue = ptr;
+  ring_buffer_mark(&queue->values);
+  ring_buffer_mark(&queue->shift_queue);
+}
+
+static void Queue_free(void *ptr) {
+  Queue_t *queue = ptr;
+  ring_buffer_free(&queue->values);
+  ring_buffer_free(&queue->shift_queue);
+  xfree(ptr);
+}
+
+static size_t Queue_size(const void *ptr) {
+  return sizeof(Queue_t);
+}
+
+static const rb_data_type_t Queue_type = {
+  "Queue",
+  {Queue_mark, Queue_free, Queue_size,},
+  0, 0, 0
+};
+
+static VALUE Queue_allocate(VALUE klass) {
+  Queue_t *queue;
+
+  queue = ALLOC(Queue_t);
+  return TypedData_Wrap_Struct(klass, &Queue_type, queue);
+}
+
+#define GetQueue(obj, queue) \
+  TypedData_Get_Struct((obj), Queue_t, &Queue_type, (queue))
+
+static VALUE Queue_initialize(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  ring_buffer_init(&queue->values);
+  ring_buffer_init(&queue->shift_queue);
+
+  return self;
+}
+
+VALUE Queue_push(VALUE self, VALUE value) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+  if (queue->shift_queue.count > 0) {
+    VALUE fiber = ring_buffer_shift(&queue->shift_queue);
+    if (fiber != Qnil) Fiber_make_runnable(fiber, Qnil);
+  }
+  ring_buffer_push(&queue->values, value);
+  return self;
+}
+
+VALUE Queue_unshift(VALUE self, VALUE value) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+  if (queue->shift_queue.count > 0) {
+    VALUE fiber = ring_buffer_shift(&queue->shift_queue);
+    if (fiber != Qnil) Fiber_make_runnable(fiber, Qnil);
+  }
+  ring_buffer_unshift(&queue->values, value);
+  return self;
+}
+
+VALUE Queue_shift(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  if (queue->values.count == 0) {
+    VALUE agent = rb_ivar_get(rb_thread_current(), ID_ivar_agent);
+    VALUE fiber = rb_fiber_current();
+    VALUE switchpoint_result = Qnil;
+    ring_buffer_push(&queue->shift_queue, fiber);
+    switchpoint_result = LibevAgent_wait_event(agent, Qnil);
+    if (RTEST(rb_obj_is_kind_of(switchpoint_result, rb_eException))) {
+      ring_buffer_delete(&queue->shift_queue, fiber);
+      return rb_funcall(rb_mKernel, ID_raise, 1, switchpoint_result);
+    }
+    RB_GC_GUARD(agent);
+    RB_GC_GUARD(switchpoint_result);
+  }
+
+  return ring_buffer_shift(&queue->values);
+}
+
+VALUE Queue_shift_no_wait(VALUE self) {
+    Queue_t *queue;
+  GetQueue(self, queue);
+
+  return ring_buffer_shift(&queue->values);
+}
+
+VALUE Queue_delete(VALUE self, VALUE value) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  ring_buffer_delete(&queue->values, value);
+  return self;
+}
+
+VALUE Queue_clear(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  ring_buffer_clear(&queue->values);
+  return self;
+}
+
+long Queue_len(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return queue->values.count;
+}
+
+VALUE Queue_shift_each(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  ring_buffer_shift_each(&queue->values);
+  return self;
+}
+
+VALUE Queue_shift_all(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return ring_buffer_shift_all(&queue->values);
+}
+
+VALUE Queue_empty_p(VALUE self) {
+  Queue_t *queue;
+  GetQueue(self, queue);
+
+  return (queue->values.count == 0) ? Qtrue : Qfalse;
+}
+
+void Init_Queue() {
+  cQueue = rb_define_class_under(mPolyphony, "Queue", rb_cData);
+  rb_define_alloc_func(cQueue, Queue_allocate);
+
+  rb_define_method(cQueue, "initialize", Queue_initialize, 0);
+  rb_define_method(cQueue, "push", Queue_push, 1);
+  rb_define_method(cQueue, "<<", Queue_push, 1);
+  rb_define_method(cQueue, "unshift", Queue_unshift, 1);
+
+  rb_define_method(cQueue, "shift", Queue_shift, 0);
+  rb_define_method(cQueue, "pop", Queue_shift, 0);
+  rb_define_method(cQueue, "shift_no_wait", Queue_shift_no_wait, 0);
+  rb_define_method(cQueue, "delete", Queue_delete, 1);
+
+  rb_define_method(cQueue, "shift_each", Queue_shift_each, 0);
+  rb_define_method(cQueue, "shift_all", Queue_shift_all, 0);
+  rb_define_method(cQueue, "empty?", Queue_empty_p, 0);
+}
+
+

data/ext/polyphony/ring_buffer.c

@@ -17,18 +17,7 @@ int ring_buffer_empty_p(ring_buffer *buffer) {
   return buffer->count == 0;
 }
 
-#define TRACE_RING_BUFFER(func, buffer) printf( \
-  "%s size: %d count: %d head: %d tail: %d\n", \
-  func, \
-  buffer->size, \
-  buffer->count, \
-  buffer->head, \
-  buffer->tail \
-)
-
 VALUE ring_buffer_shift(ring_buffer *buffer) {
-  // TRACE_RING_BUFFER("ring_buffer_shift", buffer);
-
   VALUE value;
   if (buffer->count == 0) return Qnil;
 
@@ -40,11 +29,8 @@ VALUE ring_buffer_shift(ring_buffer *buffer) {
 }
 
 void ring_buffer_resize(ring_buffer *buffer) {
-  // TRACE_RING_BUFFER("ring_buffer_resize", buffer);
-
   unsigned int old_size = buffer->size;
   buffer->size = old_size == 1 ? 4 : old_size * 2;
-  // printf("new size: %d\n", buffer->size);
   buffer->entries = realloc(buffer->entries, buffer->size * sizeof(VALUE));
   for (unsigned int idx = 0; idx < buffer->head && idx < buffer->tail; idx++)
     buffer->entries[old_size + idx] = buffer->entries[idx];
@@ -52,9 +38,6 @@ void ring_buffer_resize(ring_buffer *buffer) {
 }
 
 void ring_buffer_unshift(ring_buffer *buffer, VALUE value) {
-  // TRACE_RING_BUFFER("ring_buffer_unshift", buffer);
-  // INSPECT(value);
-
   if (buffer->count == buffer->size) ring_buffer_resize(buffer);
 
   buffer->head = (buffer->head - 1) % buffer->size;
@@ -63,8 +46,6 @@ void ring_buffer_unshift(ring_buffer *buffer, VALUE value) {
 }
 
 void ring_buffer_push(ring_buffer *buffer, VALUE value) {
-  // TRACE_RING_BUFFER("ring_buffer_push", buffer);
-  // INSPECT(value);
   if (buffer->count == buffer->size) ring_buffer_resize(buffer);
 
   buffer->entries[buffer->tail] = value;
@@ -78,8 +59,6 @@ void ring_buffer_mark(ring_buffer *buffer) {
 }
 
 void ring_buffer_shift_each(ring_buffer *buffer) {
-  // TRACE_RING_BUFFER("ring_buffer_shift_each", buffer);
-
   for (unsigned int i = 0; i < buffer->count; i++)
     rb_yield(buffer->entries[(buffer->head + i) % buffer->size]);
 
@@ -87,7 +66,6 @@ void ring_buffer_shift_each(ring_buffer *buffer) {
 }
 
 VALUE ring_buffer_shift_all(ring_buffer *buffer) {
-  // TRACE_RING_BUFFER("ring_buffer_all", buffer);
   VALUE array = rb_ary_new_capa(buffer->count);
   for (unsigned int i = 0; i < buffer->count; i++)
     rb_ary_push(array, buffer->entries[(buffer->head + i) % buffer->size]);
@@ -104,7 +82,6 @@ void ring_buffer_delete_at(ring_buffer *buffer, unsigned int idx) {
 }
 
 void ring_buffer_delete(ring_buffer *buffer, VALUE value) {
-  // TRACE_RING_BUFFER("ring_buffer_delete", buffer);
   for (unsigned int i = 0; i < buffer->count; i++) {
     unsigned int idx = (buffer->head + i) % buffer->size;
     if (buffer->entries[idx] == value) {
@@ -115,6 +92,5 @@ void ring_buffer_delete(ring_buffer *buffer, VALUE value) {
 }
 
 void ring_buffer_clear(ring_buffer *buffer) {
-  // TRACE_RING_BUFFER("ring_buffer_clear", buffer);
   buffer->count = buffer->head = buffer->tail = 0;
 }

data/ext/polyphony/thread.c

@@ -11,7 +11,7 @@ ID ID_runnable_next;
 ID ID_stop;
 
 static VALUE Thread_setup_fiber_scheduling(VALUE self) {
-  VALUE queue = rb_funcall(cLibevQueue, ID_new, 0);
+  VALUE queue = rb_funcall(cQueue, ID_new, 0);
   
   rb_ivar_set(self, ID_ivar_main_fiber, rb_fiber_current());
   rb_ivar_set(self, ID_run_queue, queue);
@@ -60,7 +60,7 @@ VALUE Thread_schedule_fiber(VALUE self, VALUE fiber, VALUE value) {
   }
 
   queue = rb_ivar_get(self, ID_run_queue);
-  LibevQueue_push(queue, fiber);
+  Queue_push(queue, fiber);
   rb_ivar_set(fiber, ID_runnable, Qtrue);
 
   if (rb_thread_current() != self) {
@@ -87,13 +87,13 @@ VALUE Thread_schedule_fiber_with_priority(VALUE self, VALUE fiber, VALUE value)
 
   // if fiber is already scheduled, remove it from the run queue
   if (rb_ivar_get(fiber, ID_runnable) != Qnil) {
-    LibevQueue_delete(queue, fiber);
+    Queue_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
-  LibevQueue_unshift(queue, fiber);
+  Queue_unshift(queue, fiber);
 
   if (rb_thread_current() != self) {
     // if the fiber scheduling is done across threads, we need to make sure the
@@ -114,6 +114,7 @@ VALUE Thread_switch_fiber(VALUE self) {
   VALUE value;
   VALUE agent = rb_ivar_get(self, ID_ivar_agent);
   int ref_count;
+  int agent_was_polled = 0;1;
 
   if (__tracing_enabled__) {
     if (rb_ivar_get(current_fiber, ID_ivar_running) != Qfalse) {
@@ -123,9 +124,9 @@ VALUE Thread_switch_fiber(VALUE self) {
 
   ref_count = LibevAgent_ref_count(agent);
   while (1) {
-    next_fiber = LibevQueue_shift_no_wait(queue);
+    next_fiber = Queue_shift_no_wait(queue);
     if (next_fiber != Qnil) {
-      if (ref_count > 0) {
+      if (agent_was_polled == 0 && ref_count > 0) {
         // this mechanism prevents event starvation in case the run queue never
         // empties
         LibevAgent_poll(agent, Qtrue, current_fiber, queue);
@@ -135,6 +136,7 @@ VALUE Thread_switch_fiber(VALUE self) {
     if (ref_count == 0) break;
 
     LibevAgent_poll(agent, Qnil, current_fiber, queue);
+    agent_was_polled = 1;
   }
 
   if (next_fiber == Qnil) return Qnil;
@@ -152,13 +154,13 @@ VALUE Thread_switch_fiber(VALUE self) {
 
 VALUE Thread_run_queue_trace(VALUE self) {
   VALUE queue = rb_ivar_get(self, ID_run_queue);
-  LibevQueue_trace(queue);
+  Queue_trace(queue);
   return self;
 }
 
 VALUE Thread_reset_fiber_scheduling(VALUE self) {
   VALUE queue = rb_ivar_get(self, ID_run_queue);
-  LibevQueue_clear(queue);
+  Queue_clear(queue);
   Thread_fiber_reset_ref_count(self);
   return self;
 }

data/lib/polyphony.rb

@@ -4,9 +4,6 @@ require 'fiber'
 require_relative './polyphony_ext'
 
 module Polyphony
-  # Map Queue to Libev queue implementation
-  Queue = LibevQueue
-
   # replace core Queue class with our own
   verbose = $VERBOSE
   $VERBOSE = nil

data/lib/polyphony/core/resource_pool.rb

@@ -36,7 +36,7 @@ module Polyphony
           @acquired_resources[fiber] = resource
           yield resource
         ensure
-          @acquired_resources[fiber] = nil
+          @acquired_resources.delete fiber
           Thread.current.agent.unref
           release(resource) if resource
         end

data/lib/polyphony/event.rb

@@ -3,25 +3,15 @@
 module Polyphony
   # Event watcher for thread-safe synchronisation
   class Event
-    def initialize
-      @i, @o = IO.pipe
-    end
-
     def await
-      Thread.current.agent.read(@i, +'', 8192, false)
-      raise @value if @value.is_a?(Exception)
-
-      @value
-    end
-
-    def await_no_raise
-      Thread.current.agent.read(@i, +'', 8192, false)
-      @value
+      @fiber = Fiber.current
+      Thread.current.agent.wait_event(true)
     end
 
     def signal(value = nil)
-      @value = value
-      Thread.current.agent.write(@o, '1')
+      @fiber&.schedule(value)
+    ensure
+      @fiber = nil
     end
   end
 end

data/lib/polyphony/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polyphony
-  VERSION = '0.43.6'
+  VERSION = '0.43.8'
 end

data/test/helper.rb

@@ -32,7 +32,7 @@ class MiniTest::Test
     Fiber.current.setup_main_fiber
     Fiber.current.instance_variable_set(:@auto_watcher, nil)
     Thread.current.agent = Polyphony::LibevAgent.new
-    sleep 0
+    sleep 0 # apparently this helps with timer accuracy
   end
 
   def teardown

data/test/test_agent.rb

@@ -97,7 +97,7 @@ class AgentTest < MiniTest::Test
     o.close
 
     # read_loop will snooze after every read
-    4.times { snooze }
+    6.times { snooze }
 
     assert_equal [:ready, 'foo', 'bar', :done], buf
   end

data/test/test_event.rb

@@ -45,4 +45,15 @@ class EventTest < MiniTest::Test
     t&.kill
     t&.join
   end
+
+  def test_exception_while_waiting_for_event
+    e = Polyphony::Event.new
+
+    f = spin { e.await }
+    g = spin { f.raise 'foo' }
+
+    assert_raises(RuntimeError) do
+      f.await
+    end
+  end
 end

data/test/test_io.rb

@@ -91,6 +91,20 @@ class IOTest < MiniTest::Test
 
     assert_raises(EOFError) { i.readpartial(1) }    
   end
+
+  # see https://github.com/digital-fabric/polyphony/issues/30
+  def test_reopened_tempfile
+    file = Tempfile.new
+    file << 'hello: world'
+    file.close
+
+    buf = nil
+    File.open(file, 'r:bom|utf-8') do |f|
+      buf = f.read(16384)
+    end
+
+    assert_equal 'hello: world', buf
+  end
 end
 
 class IOClassMethodsTest < MiniTest::Test

data/test/test_queue.rb

@@ -96,4 +96,17 @@ class QueueTest < MiniTest::Test
     assert_nil f2.await
     assert_equal :bar, f3.await
   end
+
+  def test_fiber_removal_from_queue_simple
+    f1 = spin { @queue.shift }
+    
+    # let fibers run
+    snooze
+
+    f1.stop
+    snooze
+
+    @queue << :foo
+    assert_nil f1.await
+  end
 end

data/test/test_socket.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'helper'
-require 'localhost/authority'
 
 class SocketTest < MiniTest::Test
   def setup
@@ -32,46 +31,4 @@ class SocketTest < MiniTest::Test
     server_fiber&.await
     server&.close
   end
-
-  def test_openssl
-    authority = Localhost::Authority.fetch
-    context = authority.server_context
-    port = rand(1234..5678)
-    sock = TCPServer.new('127.0.0.1', port)
-    server = OpenSSL::SSL::SSLServer.new(sock, context)
-
-    server_fiber = spin do
-      while (socket = server.accept)
-        puts "accepted: #{socket.inspect}"
-        spin do
-          while (data = socket.gets(8192))
-            socket << data
-          end
-        end
-      end
-    end
-
-    snooze
-    p 1
-    sock = TCPSocket.new('127.0.0.1', port)
-    p 2
-    sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
-    context = OpenSSL::SSL::SSLContext.new
-    context.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    client = OpenSSL::SSL::SSLSocket.new(sock, context)
-    client.sync_close = true
-    client.hostname = 'localhost'
-    p 3
-    client.connect
-    p 4
-    client.write("GET / HTTP/1.0\r\nHost: realiteq.net\r\n\r\n")#("1234\n")
-    p 5
-    assert_equal "1234\n", client.readpartial(8192)
-    p 6
-    client.close
-  ensure
-    server_fiber&.stop
-    server_fiber&.await
-    server&.close
-  end
 end

data/test/test_trace.rb

@@ -34,7 +34,8 @@ class TraceTest < MiniTest::Test
 
   def test_2_fiber_trace
     records = []
-    t = Polyphony::Trace.new(:fiber_all) { |r| records << r if r[:event] =~ /^fiber_/ }
+    thread = Thread.current
+    t = Polyphony::Trace.new(:fiber_all) { |r| records << r if Thread.current == thread && r[:event] =~ /^fiber_/ }
     t.enable
     Polyphony.trace(true)
 
@@ -42,23 +43,23 @@ class TraceTest < MiniTest::Test
     suspend
     sleep 0
 
-    events = records.map { |r| [r[:fiber], r[:event]] }
+    events = records.map { |r| [r[:fiber] == f ? :f : :current, r[:event]] }
     assert_equal [
-      [f, :fiber_create],
-      [f, :fiber_schedule],
-      [Fiber.current, :fiber_switchpoint],
-      [f, :fiber_run],
-      [f, :fiber_switchpoint],
-      [f, :fiber_ev_loop_enter],
-      [f, :fiber_schedule],
-      [f, :fiber_ev_loop_leave],
-      [f, :fiber_run],
-      [f, :fiber_terminate],
-      [Fiber.current, :fiber_switchpoint],
-      [Fiber.current, :fiber_ev_loop_enter],
-      [Fiber.current, :fiber_schedule],
-      [Fiber.current, :fiber_ev_loop_leave],
-      [Fiber.current, :fiber_run]
+      [:f, :fiber_create],
+      [:f, :fiber_schedule],
+      [:current, :fiber_switchpoint],
+      [:f, :fiber_run],
+      [:f, :fiber_switchpoint],
+      [:f, :fiber_ev_loop_enter],
+      [:f, :fiber_schedule],
+      [:f, :fiber_ev_loop_leave],
+      [:f, :fiber_run],
+      [:f, :fiber_terminate],
+      [:current, :fiber_switchpoint],
+      [:current, :fiber_ev_loop_enter],
+      [:current, :fiber_schedule],
+      [:current, :fiber_ev_loop_leave],
+      [:current, :fiber_run]
     ], events
   ensure
     t&.disable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.43.6
+  version: 0.43.8
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -354,6 +354,7 @@ files:
 - examples/io/xx-tcpserver.rb
 - examples/io/xx-tcpsocket.rb
 - examples/io/xx-zip.rb
+- examples/performance/fiber_transfer.rb
 - examples/performance/fs_read.rb
 - examples/performance/mem-usage.rb
 - examples/performance/messaging.rb
@@ -392,10 +393,10 @@ files:
 - ext/polyphony/libev.c
 - ext/polyphony/libev.h
 - ext/polyphony/libev_agent.c
-- ext/polyphony/libev_queue.c
 - ext/polyphony/polyphony.c
 - ext/polyphony/polyphony.h
 - ext/polyphony/polyphony_ext.c
+- ext/polyphony/queue.c
 - ext/polyphony/ring_buffer.c
 - ext/polyphony/ring_buffer.h
 - ext/polyphony/thread.c
@@ -474,7 +475,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Fine grained concurrency for Ruby

data/ext/polyphony/libev_queue.c

@@ -1,288 +0,0 @@
-#include "polyphony.h"
-#include "ring_buffer.h"
-
-struct async_watcher {
-  ev_async async;
-  struct ev_loop *ev_loop;
-  VALUE fiber;
-};
-
-struct async_watcher_queue {
-  struct async_watcher **queue;
-  unsigned int length;
-  unsigned int count;
-  unsigned int push_idx;
-  unsigned int shift_idx;
-};
-
-void async_watcher_queue_init(struct async_watcher_queue *queue) {
-  queue->length = 1;
-  queue->count = 0;
-  queue->queue = malloc(sizeof(struct async_watcher *) * queue->length);
-  queue->push_idx = 0;
-  queue->shift_idx = 0;
-}
-
-void async_watcher_queue_free(struct async_watcher_queue *queue) {
-  free(queue->queue);
-}
-
-void async_watcher_queue_realign(struct async_watcher_queue *queue) {
-  memmove(
-    queue->queue,
-    queue->queue + queue->shift_idx,
-    queue->count * sizeof(struct async_watcher *)
-  );
-  queue->push_idx = queue->push_idx - queue->shift_idx;
-  queue->shift_idx = 0;
-}
-
-#define QUEUE_REALIGN_THRESHOLD 32
-
-void async_watcher_queue_push(struct async_watcher_queue *queue, struct async_watcher *watcher) {
-  if (queue->count == 0) {
-    queue->push_idx = 0;
-    queue->shift_idx = 0;
-  }
-  if (queue->push_idx == queue->length) {
-    // prevent shift idx moving too much away from zero
-    if (queue->length >= QUEUE_REALIGN_THRESHOLD && queue->shift_idx >= (queue->length / 2))
-      async_watcher_queue_realign(queue);
-    else {
-      queue->length = (queue->length == 1) ? 4 : queue->length * 2;
-      queue->queue = realloc(queue->queue, sizeof(struct async_watcher *) * queue->length);
-    }
-  }
-  queue->count++;
-  queue->queue[queue->push_idx++] = watcher;
-}
-
-struct async_watcher *async_watcher_queue_shift(struct async_watcher_queue *queue) {
-  if (queue->count == 0) return 0;
-
-  queue->count--;
-
-  return queue->queue[queue->shift_idx++];
-}
-
-void async_watcher_queue_remove_at_idx(struct async_watcher_queue *queue, unsigned int remove_idx) {
-  queue->count--;
-  queue->push_idx--;
-  if (remove_idx < queue->push_idx)
-    memmove(
-      queue->queue + remove_idx,
-      queue->queue + remove_idx + 1,
-      (queue->push_idx - remove_idx) * sizeof(struct async_watcher *)
-    );
-}
-
-void async_watcher_queue_remove_by_fiber(struct async_watcher_queue *queue, VALUE fiber) {
-  if (queue->count == 0) return;
-
-  for (unsigned idx = queue->shift_idx; idx < queue->push_idx; idx++) {
-    if (queue->queue[idx]->fiber == fiber) {
-      async_watcher_queue_remove_at_idx(queue, idx);
-      return; 
-    }
-  }
-}
-
-typedef struct queue {
-  ring_buffer values;
-  struct async_watcher_queue shift_queue;
-} LibevQueue_t;
-
-VALUE cLibevQueue = Qnil;
-
-static void LibevQueue_mark(void *ptr) {
-  LibevQueue_t *queue = ptr;
-  ring_buffer_mark(&queue->values);
-}
-
-static void LibevQueue_free(void *ptr) {
-  LibevQueue_t *queue = ptr;
-  ring_buffer_free(&queue->values);
-  async_watcher_queue_free(&queue->shift_queue);
-  xfree(ptr);
-}
-
-static size_t LibevQueue_size(const void *ptr) {
-  return sizeof(LibevQueue_t);
-}
-
-static const rb_data_type_t LibevQueue_type = {
-  "Queue",
-  {LibevQueue_mark, LibevQueue_free, LibevQueue_size,},
-  0, 0, 0
-};
-
-static VALUE LibevQueue_allocate(VALUE klass) {
-  LibevQueue_t *queue;
-
-  queue = ALLOC(LibevQueue_t);
-  return TypedData_Wrap_Struct(klass, &LibevQueue_type, queue);
-}
-
-#define GetQueue(obj, queue) \
-  TypedData_Get_Struct((obj), LibevQueue_t, &LibevQueue_type, (queue))
-
-static VALUE LibevQueue_initialize(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  ring_buffer_init(&queue->values);
-  async_watcher_queue_init(&queue->shift_queue);
-
-  return self;
-}
-
-VALUE LibevQueue_push(VALUE self, VALUE value) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-  if (queue->shift_queue.count > 0) {
-    struct async_watcher *watcher = async_watcher_queue_shift(&queue->shift_queue);
-    if (watcher) {
-      ev_async_send(watcher->ev_loop, &watcher->async);
-    }
-  }
-  ring_buffer_push(&queue->values, value);
-  return self;
-}
-
-VALUE LibevQueue_unshift(VALUE self, VALUE value) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-  if (queue->shift_queue.count > 0) {
-    struct async_watcher *watcher = async_watcher_queue_shift(&queue->shift_queue);
-    if (watcher) {
-      ev_async_send(watcher->ev_loop, &watcher->async);
-    }
-  }
-  ring_buffer_unshift(&queue->values, value);
-  return self;
-}
-
-struct ev_loop *LibevAgent_ev_loop(VALUE self);
-
-void async_watcher_queue_callback(struct ev_loop *ev_loop, struct ev_async *ev_async, int revents) {
-  struct async_watcher *watcher = (struct async_watcher *)ev_async;
-  Fiber_make_runnable(watcher->fiber, Qnil);
-}
-
-VALUE libev_agent_await(VALUE self);
-
-VALUE LibevQueue_shift(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  if (queue->values.count == 0) {
-    struct async_watcher watcher;
-    VALUE agent = rb_ivar_get(rb_thread_current(), ID_ivar_agent);
-    VALUE switchpoint_result = Qnil;
-
-    watcher.ev_loop = LibevAgent_ev_loop(agent);
-    watcher.fiber = rb_fiber_current();    
-    async_watcher_queue_push(&queue->shift_queue, &watcher);
-    ev_async_init(&watcher.async, async_watcher_queue_callback);
-    ev_async_start(watcher.ev_loop, &watcher.async);
-    
-    switchpoint_result = libev_agent_await(agent);
-    ev_async_stop(watcher.ev_loop, &watcher.async);
-
-    if (RTEST(rb_obj_is_kind_of(switchpoint_result, rb_eException))) {
-      async_watcher_queue_remove_by_fiber(&queue->shift_queue, watcher.fiber);
-      return rb_funcall(rb_mKernel, ID_raise, 1, switchpoint_result);
-    }
-    RB_GC_GUARD(watcher.fiber);
-    RB_GC_GUARD(agent);
-    RB_GC_GUARD(switchpoint_result);
-  }
-
-  return ring_buffer_shift(&queue->values);
-}
-
-VALUE LibevQueue_shift_no_wait(VALUE self) {
-    LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  return ring_buffer_shift(&queue->values);
-}
-
-VALUE LibevQueue_delete(VALUE self, VALUE value) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  ring_buffer_delete(&queue->values, value);
-  return self;
-}
-
-VALUE LibevQueue_clear(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  ring_buffer_clear(&queue->values);
-  return self;
-}
-
-long LibevQueue_len(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  return queue->values.count;
-}
-
-VALUE LibevQueue_shift_each(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  ring_buffer_shift_each(&queue->values);
-  return self;
-}
-
-VALUE LibevQueue_shift_all(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  return ring_buffer_shift_all(&queue->values);
-}
-
-VALUE LibevQueue_empty_p(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  return (queue->values.count == 0) ? Qtrue : Qfalse;
-}
-
-void LibevQueue_trace(VALUE self) {
-  LibevQueue_t *queue;
-  GetQueue(self, queue);
-
-  printf(
-    "queue size: %d count: %d head: %d tail: %d\n",
-    queue->values.size,
-    queue->values.count,
-    queue->values.head,
-    queue->values.tail
-  );
-}
-
-void Init_LibevQueue() {
-  cLibevQueue = rb_define_class_under(mPolyphony, "LibevQueue", rb_cData);
-  rb_define_alloc_func(cLibevQueue, LibevQueue_allocate);
-
-  rb_define_method(cLibevQueue, "initialize", LibevQueue_initialize, 0);
-  rb_define_method(cLibevQueue, "push", LibevQueue_push, 1);
-  rb_define_method(cLibevQueue, "<<", LibevQueue_push, 1);
-  rb_define_method(cLibevQueue, "unshift", LibevQueue_unshift, 1);
-
-  rb_define_method(cLibevQueue, "shift", LibevQueue_shift, 0);
-  rb_define_method(cLibevQueue, "pop", LibevQueue_shift, 0);
-  rb_define_method(cLibevQueue, "shift_no_wait", LibevQueue_shift_no_wait, 0);
-  rb_define_method(cLibevQueue, "delete", LibevQueue_delete, 1);
-
-  rb_define_method(cLibevQueue, "shift_each", LibevQueue_shift_each, 0);
-  rb_define_method(cLibevQueue, "shift_all", LibevQueue_shift_all, 0);
-  rb_define_method(cLibevQueue, "empty?", LibevQueue_empty_p, 0);
-}
-
-