polyphony 0.51.0 → 0.52.0

data/ext/polyphony/backend_libev.c

@@ -1,3 +1,41 @@
+/*
+# Libev-based blocking ops backend for Polyphony
+
+## Backend initialization
+
+The backend is initialized by creating an event loop. For the main thread the
+default event loop is used, but we since we don't need to handle any signals
+(see the waitpid implementation below) we might as well use a non-default event
+loop for the main thread at some time in the future.
+
+In addition, we create an async watcher that is used for interrupting the #poll
+method from another thread.
+
+## Blocking operations
+
+I/O operations start by making sure the io has been set to non-blocking
+operation (O_NONBLOCK). That way, if the syscall would block, we'd get an
+EWOULDBLOCK or EAGAIN instead of blocking.
+
+Once the OS has indicated that the operation would block, we start a watcher
+(its type corresponding to the desired operation), and call ev_xxxx_start. in We
+then call Thread_switch_fiber and switch to another fiber while waiting for the
+watcher to be triggered.
+
+## Polling for events
+
+Backend_poll is called either once the corresponding thread has no more work to
+do (no runnable fibers) or periodically while the thread is scheduling fibers in
+order to prevent event starvation.
+
+## Behaviour of waitpid
+
+On Linux 5.3+, pidfd_open will be used, otherwise a libev child watcher will be
+used. Note that if a child watcher is used, waitpid will only work from the main
+thread.
+
+*/
+
 #ifdef POLYPHONY_BACKEND_LIBEV
 
 #include <netdb.h>
@@ -76,17 +114,27 @@ void break_async_callback(struct ev_loop *ev_loop, struct ev_async *ev_async, in
   // of a *blocking* event loop (waking it up) in a thread-safe, signal-safe manner
 }
 
+inline struct ev_loop *libev_new_loop() {
+  #ifdef POLYPHONY_USE_PIDFD_OPEN
+    return ev_loop_new(EVFLAG_NOSIGMASK);
+  #else
+    int is_main_thread = (rb_thread_current() == rb_thread_main());
+    return is_main_thread ? EV_DEFAULT : ev_loop_new(EVFLAG_NOSIGMASK);
+  #endif
+}
+
 static VALUE Backend_initialize(VALUE self) {
   Backend_t *backend;
-  VALUE thread = rb_thread_current();
-  int is_main_thread = (thread == rb_thread_main());
-
+  
   GetBackend(self, backend);
-  backend->ev_loop = is_main_thread ? EV_DEFAULT : ev_loop_new(EVFLAG_NOSIGMASK);
+  backend->ev_loop = libev_new_loop();
 
+  // start async watcher used for breaking a poll op (from another thread)
   ev_async_init(&backend->break_async, break_async_callback);
   ev_async_start(backend->ev_loop, &backend->break_async);
-  ev_unref(backend->ev_loop); // don't count the break_async watcher
+  // the break_async watcher is unreferenced, in order for Backend_poll to not
+  // block when no other watcher is active
+  ev_unref(backend->ev_loop);
 
   backend->currently_polling = 0;
   backend->pending_count = 0;
@@ -672,6 +720,55 @@ error:
   return RAISE_EXCEPTION(switchpoint_result);
 }
 
+VALUE Backend_send(VALUE self, VALUE io, VALUE str, VALUE flags) {
+  Backend_t *backend;
+  struct libev_io watcher;
+  rb_io_t *fptr;
+  VALUE switchpoint_result = Qnil;
+  VALUE underlying_io;
+  char *buf = StringValuePtr(str);
+  long len = RSTRING_LEN(str);
+  long left = len;
+  int flags_int = NUM2INT(flags);
+
+  underlying_io = rb_ivar_get(io, ID_ivar_io);
+  if (underlying_io != Qnil) io = underlying_io;
+  GetBackend(self, backend);
+  io = rb_io_get_write_io(io);
+  GetOpenFile(io, fptr);
+  io_set_nonblock(fptr, io);
+  watcher.fiber = Qnil;
+
+  while (left > 0) {
+    ssize_t n = send(fptr->fd, buf, left, flags_int);
+    if (n < 0) {
+      int e = errno;
+      if ((e != EWOULDBLOCK && e != EAGAIN)) rb_syserr_fail(e, strerror(e));
+
+      switchpoint_result = libev_wait_fd_with_watcher(backend, fptr->fd, &watcher, EV_WRITE);
+
+      if (TEST_EXCEPTION(switchpoint_result)) goto error;
+    }
+    else {
+      buf += n;
+      left -= n;
+    }
+  }
+
+  if (watcher.fiber == Qnil) {
+    switchpoint_result = backend_snooze();
+
+    if (TEST_EXCEPTION(switchpoint_result)) goto error;
+  }
+
+  RB_GC_GUARD(watcher.fiber);
+  RB_GC_GUARD(switchpoint_result);
+
+  return INT2NUM(len);
+error:
+  return RAISE_EXCEPTION(switchpoint_result);
+}
+
 VALUE Backend_wait_io(VALUE self, VALUE io, VALUE write) {
   Backend_t *backend;
   rb_io_t *fptr;
@@ -799,6 +896,7 @@ VALUE Backend_timeout(int argc,VALUE *argv, VALUE self) {
   return result;
 }
 
+#ifdef POLYPHONY_USE_PIDFD_OPEN
 VALUE Backend_waitpid(VALUE self, VALUE pid) {
   int pid_int = NUM2INT(pid);
   int fd = pidfd_open(pid_int, 0);
@@ -811,18 +909,53 @@ VALUE Backend_waitpid(VALUE self, VALUE pid) {
     RAISE_IF_EXCEPTION(resume_value);
     RB_GC_GUARD(resume_value);
   }
+  else {
+    int e = errno;
+    rb_syserr_fail(e, strerror(e));
+  }
 
   int status = 0;
   pid_t ret = waitpid(pid_int, &status, WNOHANG);
   if (ret < 0) {
     int e = errno;
-    if (e == ECHILD)
-      ret = pid_int;
-    else
-      rb_syserr_fail(e, strerror(e));
+    rb_syserr_fail(e, strerror(e));
   }
   return rb_ary_new_from_args(2, INT2NUM(ret), INT2NUM(WEXITSTATUS(status)));
 }
+#else
+struct libev_child {
+  struct ev_child child;
+  VALUE fiber;
+};
+
+void Backend_child_callback(EV_P_ ev_child *w, int revents) {
+  struct libev_child *watcher = (struct libev_child *)w;
+  int exit_status = WEXITSTATUS(w->rstatus);
+  VALUE status;
+
+  status = rb_ary_new_from_args(2, INT2NUM(w->rpid), INT2NUM(exit_status));
+  Fiber_make_runnable(watcher->fiber, status);
+}
+
+VALUE Backend_waitpid(VALUE self, VALUE pid) {
+  Backend_t *backend;
+  struct libev_child watcher;
+  VALUE switchpoint_result = Qnil;
+  GetBackend(self, backend);
+
+  watcher.fiber = rb_fiber_current();
+  ev_child_init(&watcher.child, Backend_child_callback, NUM2INT(pid), 0);
+  ev_child_start(backend->ev_loop, &watcher.child);
+
+  switchpoint_result = backend_await(backend);
+
+  ev_child_stop(backend->ev_loop, &watcher.child);
+  RAISE_IF_EXCEPTION(switchpoint_result);
+  RB_GC_GUARD(watcher.fiber);
+  RB_GC_GUARD(switchpoint_result);
+  return switchpoint_result;
+}
+#endif
 
 void Backend_async_callback(EV_P_ ev_async *w, int revents) { }
 
@@ -851,7 +984,7 @@ VALUE Backend_kind(VALUE self) {
 void Init_Backend() {
   ev_set_allocator(xrealloc);
 
-  VALUE cBackend = rb_define_class_under(mPolyphony, "Backend", rb_cData);
+  VALUE cBackend = rb_define_class_under(mPolyphony, "Backend", rb_cObject);
   rb_define_alloc_func(cBackend, Backend_allocate);
 
   rb_define_method(cBackend, "initialize", Backend_initialize, 0);
@@ -871,7 +1004,8 @@ void Init_Backend() {
   rb_define_method(cBackend, "recv", Backend_recv, 3);
   rb_define_method(cBackend, "recv_loop", Backend_read_loop, 1);
   rb_define_method(cBackend, "recv_feed_loop", Backend_feed_loop, 3);
-  rb_define_method(cBackend, "send", Backend_write, 2);
+  rb_define_method(cBackend, "send", Backend_send, 3);
+  rb_define_method(cBackend, "sendv", Backend_sendv, 3);
   rb_define_method(cBackend, "wait_io", Backend_wait_io, 2);
   rb_define_method(cBackend, "sleep", Backend_sleep, 1);
   rb_define_method(cBackend, "timer_loop", Backend_timer_loop, 1);

data/ext/polyphony/event.c

@@ -77,7 +77,7 @@ VALUE Event_await(VALUE self) {
 }
 
 void Init_Event() {
-  cEvent = rb_define_class_under(mPolyphony, "Event", rb_cData);
+  cEvent = rb_define_class_under(mPolyphony, "Event", rb_cObject);
   rb_define_alloc_func(cEvent, Event_allocate);
 
   rb_define_method(cEvent, "initialize", Event_initialize, 0);

data/ext/polyphony/extconf.rb

@@ -4,15 +4,19 @@ require 'rubygems'
 require 'mkmf'
 
 use_liburing = false
+use_pidfd_open = false
 force_use_libev = ENV['POLYPHONY_USE_LIBEV'] != nil
 
-if !force_use_libev && RUBY_PLATFORM =~ /linux/ && `uname -sr` =~ /Linux 5\.([\d+])/
+if RUBY_PLATFORM =~ /linux/ && `uname -sr` =~ /Linux 5\.([\d+])/
   kernel_minor_version = $1.gsub('.', '').to_i
-  use_liburing = kernel_minor_version >= 6
+  use_liburing = !force_use_libev && kernel_minor_version >= 6
+  use_pidfd_open = kernel_minor_version >= 3
 end
 
+$defs << '-DPOLYPHONY_USE_PIDFD_OPEN' if use_pidfd_open
 if use_liburing
   $defs << "-DPOLYPHONY_BACKEND_LIBURING"
+  $defs << "-DPOLYPHONY_UNSET_NONBLOCK" if RUBY_VERSION =~ /^3/
   $CFLAGS << " -Wno-pointer-arith"
 else
   $defs << "-DPOLYPHONY_BACKEND_LIBEV"
@@ -23,6 +27,7 @@ else
   $defs << '-DEV_USE_KQUEUE'       if have_header('sys/event.h') && have_header('sys/queue.h')
   $defs << '-DEV_USE_PORT'         if have_type('port_event_t', 'port.h')
   $defs << '-DHAVE_SYS_RESOURCE_H' if have_header('sys/resource.h')  
+
   $CFLAGS << " -Wno-comment"
   $CFLAGS << " -Wno-unused-result"
   $CFLAGS << " -Wno-dangling-else"

data/ext/polyphony/polyphony.c

@@ -46,11 +46,105 @@ VALUE Polyphony_trace(VALUE self, VALUE enabled) {
   return Qnil;
 }
 
+#define BACKEND() (rb_ivar_get(rb_thread_current(), ID_ivar_backend))
+
+VALUE Polyphony_backend_accept(VALUE self, VALUE server_socket, VALUE socket_class) {
+  return Backend_accept(BACKEND(), server_socket, socket_class);
+}
+
+VALUE Polyphony_backend_accept_loop(VALUE self, VALUE server_socket, VALUE socket_class) {
+  return Backend_accept_loop(BACKEND(), server_socket, socket_class);
+}
+
+VALUE Polyphony_backend_connect(VALUE self, VALUE io, VALUE addr, VALUE port) {
+  return Backend_connect(BACKEND(), io, addr, port);
+}
+
+VALUE Polyphony_backend_feed_loop(VALUE self, VALUE io, VALUE receiver, VALUE method) {
+  return Backend_feed_loop(BACKEND(), io, receiver, method);
+}
+
+VALUE Polyphony_backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof) {
+  return Backend_read(BACKEND(), io, str, length, to_eof);
+}
+
+VALUE Polyphony_backend_read_loop(VALUE self, VALUE io) {
+  return Backend_read_loop(BACKEND(), io);
+}
+
+VALUE Polyphony_backend_recv(VALUE self, VALUE io, VALUE str, VALUE length) {
+  return Backend_recv(BACKEND(), io, str, length);
+}
+
+VALUE Polyphony_backend_recv_loop(VALUE self, VALUE io) {
+  return Backend_recv_loop(BACKEND(), io);
+}
+
+VALUE Polyphony_backend_recv_feed_loop(VALUE self, VALUE io, VALUE receiver, VALUE method) {
+  return Backend_recv_feed_loop(BACKEND(), io, receiver, method);
+}
+
+VALUE Polyphony_backend_send(VALUE self, VALUE io, VALUE msg, VALUE flags) {
+  return Backend_send(BACKEND(), io, msg, flags);
+}
+
+VALUE Polyphony_backend_sendv(VALUE self, VALUE io, VALUE ary, VALUE flags) {
+  return Backend_sendv(BACKEND(), io, ary, flags);
+}
+
+VALUE Polyphony_backend_sleep(VALUE self, VALUE duration) {
+  return Backend_sleep(BACKEND(), duration);
+}
+
+VALUE Polyphony_backend_timeout(int argc,VALUE *argv, VALUE self) {
+  return Backend_timeout(argc, argv, BACKEND());
+}
+
+VALUE Polyphony_backend_timer_loop(VALUE self, VALUE interval) {
+  return Backend_timer_loop(BACKEND(), interval);
+}
+
+VALUE Polyphony_backend_wait_event(VALUE self, VALUE raise) {
+  return Backend_wait_event(BACKEND(), raise);
+}
+
+VALUE Polyphony_backend_wait_io(VALUE self, VALUE io, VALUE write) {
+  return Backend_wait_io(BACKEND(), io, write);
+}
+
+VALUE Polyphony_backend_waitpid(VALUE self, VALUE pid) {
+  return Backend_waitpid(BACKEND(), pid);
+}
+
+VALUE Polyphony_backend_write(int argc, VALUE *argv, VALUE self) {
+  return Backend_write_m(argc, argv, BACKEND());
+}
+
 void Init_Polyphony() {
   mPolyphony = rb_define_module("Polyphony");
 
   rb_define_singleton_method(mPolyphony, "trace", Polyphony_trace, 1);
 
+  // backend methods
+  rb_define_singleton_method(mPolyphony, "backend_accept", Polyphony_backend_accept, 2);
+  rb_define_singleton_method(mPolyphony, "backend_accept_loop", Polyphony_backend_accept_loop, 2);
+  rb_define_singleton_method(mPolyphony, "backend_connect", Polyphony_backend_connect, 3);
+  rb_define_singleton_method(mPolyphony, "backend_feed_loop", Polyphony_backend_feed_loop, 3);
+  rb_define_singleton_method(mPolyphony, "backend_read", Polyphony_backend_read, 4);
+  rb_define_singleton_method(mPolyphony, "backend_read_loop", Polyphony_backend_read_loop, 1);
+  rb_define_singleton_method(mPolyphony, "backend_recv", Polyphony_backend_recv, 3);
+  rb_define_singleton_method(mPolyphony, "backend_recv_loop", Polyphony_backend_recv_loop, 1);
+  rb_define_singleton_method(mPolyphony, "backend_recv_feed_loop", Polyphony_backend_recv_feed_loop, 3);
+  rb_define_singleton_method(mPolyphony, "backend_send", Polyphony_backend_send, 3);
+  rb_define_singleton_method(mPolyphony, "backend_sendv", Polyphony_backend_sendv, 3);
+  rb_define_singleton_method(mPolyphony, "backend_sleep", Polyphony_backend_sleep, 1);
+  rb_define_singleton_method(mPolyphony, "backend_timeout", Polyphony_backend_timeout, -1);
+  rb_define_singleton_method(mPolyphony, "backend_timer_loop", Polyphony_backend_timer_loop, 1);
+  rb_define_singleton_method(mPolyphony, "backend_wait_event", Polyphony_backend_wait_event, 1);
+  rb_define_singleton_method(mPolyphony, "backend_wait_io", Polyphony_backend_wait_io, 2);
+  rb_define_singleton_method(mPolyphony, "backend_waitpid", Polyphony_backend_waitpid, 1);
+  rb_define_singleton_method(mPolyphony, "backend_write", Polyphony_backend_write, -1);
+
   rb_define_global_function("snooze", Polyphony_snooze, 0);
   rb_define_global_function("suspend", Polyphony_suspend, 0);
 

data/ext/polyphony/polyphony.h

@@ -23,9 +23,9 @@
 #define COND_TRACE(...) if (__tracing_enabled__) { TRACE(__VA_ARGS__); }
 
 // exceptions
-#define TEST_EXCEPTION(ret) (RTEST(rb_obj_is_kind_of(ret, rb_eException)))
+#define TEST_EXCEPTION(ret) (rb_obj_is_kind_of(ret, rb_eException) == Qtrue)
 #define RAISE_EXCEPTION(e) rb_funcall(e, ID_invoke, 0);
-#define RAISE_IF_EXCEPTION(ret) if (RTEST(rb_obj_is_kind_of(ret, rb_eException))) { RAISE_EXCEPTION(ret); }
+#define RAISE_IF_EXCEPTION(ret) if (rb_obj_is_kind_of(ret, rb_eException) == Qtrue) { RAISE_EXCEPTION(ret); }
 #define RAISE_IF_NOT_NIL(ret) if (ret != Qnil) { RAISE_EXCEPTION(ret); }
 
 // Fiber#transfer
@@ -89,6 +89,32 @@ void Runqueue_clear(VALUE self);
 long Runqueue_len(VALUE self);
 int Runqueue_empty_p(VALUE self);
 
+#ifdef POLYPHONY_BACKEND_LIBEV
+#define Backend_recv_loop Backend_read_loop
+#define Backend_recv_feed_loop Backend_feed_loop
+#endif
+
+// Backend public interface
+
+VALUE Backend_accept(VALUE self, VALUE server_socket, VALUE socket_class);
+VALUE Backend_accept_loop(VALUE self, VALUE server_socket, VALUE socket_class);
+VALUE Backend_connect(VALUE self, VALUE io, VALUE addr, VALUE port);
+VALUE Backend_feed_loop(VALUE self, VALUE io, VALUE receiver, VALUE method);
+VALUE Backend_read(VALUE self, VALUE io, VALUE str, VALUE length, VALUE to_eof);
+VALUE Backend_read_loop(VALUE self, VALUE io);
+VALUE Backend_recv(VALUE self, VALUE io, VALUE str, VALUE length);
+VALUE Backend_recv_loop(VALUE self, VALUE io);
+VALUE Backend_recv_feed_loop(VALUE self, VALUE io, VALUE receiver, VALUE method);
+VALUE Backend_send(VALUE self, VALUE io, VALUE msg, VALUE flags);
+VALUE Backend_sendv(VALUE self, VALUE io, VALUE ary, VALUE flags);
+VALUE Backend_sleep(VALUE self, VALUE duration);
+VALUE Backend_timeout(int argc,VALUE *argv, VALUE self);
+VALUE Backend_timer_loop(VALUE self, VALUE interval);
+VALUE Backend_wait_event(VALUE self, VALUE raise);
+VALUE Backend_wait_io(VALUE self, VALUE io, VALUE write);
+VALUE Backend_waitpid(VALUE self, VALUE pid);
+VALUE Backend_write_m(int argc, VALUE *argv, VALUE self);
+
 unsigned int Backend_pending_count(VALUE self);
 VALUE Backend_poll(VALUE self, VALUE nowait, VALUE current_fiber, VALUE runqueue);
 VALUE Backend_wait_event(VALUE self, VALUE raise_on_exception);

data/ext/polyphony/queue.c

@@ -247,7 +247,7 @@ VALUE Queue_size_m(VALUE self) {
 }
 
 void Init_Queue() {
-  cQueue = rb_define_class_under(mPolyphony, "Queue", rb_cData);
+  cQueue = rb_define_class_under(mPolyphony, "Queue", rb_cObject);
   rb_define_alloc_func(cQueue, Queue_allocate);
 
   rb_define_method(cQueue, "initialize", Queue_initialize, -1);

data/ext/polyphony/runqueue.c

@@ -101,7 +101,7 @@ int Runqueue_empty_p(VALUE self) {
 }
 
 void Init_Runqueue() {
-  cRunqueue = rb_define_class_under(mPolyphony, "Runqueue", rb_cData);
+  cRunqueue = rb_define_class_under(mPolyphony, "Runqueue", rb_cObject);
   rb_define_alloc_func(cRunqueue, Runqueue_allocate);
 
   rb_define_method(cRunqueue, "initialize", Runqueue_initialize, 0);

data/lib/polyphony/adapters/irb.rb

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

data/lib/polyphony/adapters/mysql2.rb

@@ -13,7 +13,7 @@ Mysql2::Client.prepend(Module.new do
 
   def query(sql, **options)
     super
-    Thread.current.backend.wait_io(@io, false)
+    Polyphony.backend_wait_io(@io, false)
     async_result
   end
 end)

data/lib/polyphony/adapters/postgres.rb

@@ -15,8 +15,8 @@ module ::PG
       res = conn.connect_poll
       case res
       when PGRES_POLLING_FAILED   then raise Error, conn.error_message
-      when PGRES_POLLING_READING  then Thread.current.backend.wait_io(socket_io, false)
-      when PGRES_POLLING_WRITING  then Thread.current.backend.wait_io(socket_io, true)
+      when PGRES_POLLING_READING  then Polyphony.backend_wait_io(socket_io, false)
+      when PGRES_POLLING_WRITING  then Polyphony.backend_wait_io(socket_io, true)
       when PGRES_POLLING_OK       then return conn.setnonblocking(true)
       end
     end
@@ -42,7 +42,7 @@ class ::PG::Connection
 
   def get_result(&block)
     while is_busy
-      Thread.current.backend.wait_io(socket_io, false)
+      Polyphony.backend_wait_io(socket_io, false)
       consume_input
     end
     orig_get_result(&block)
@@ -59,7 +59,7 @@ class ::PG::Connection
 
   def block(_timeout = 0)
     while is_busy
-      Thread.current.backend.wait_io(socket_io, false)
+      Polyphony.backend_wait_io(socket_io, false)
       consume_input
     end
   end
@@ -97,7 +97,7 @@ class ::PG::Connection
     return move_on_after(timeout) { wait_for_notify(&block) } if timeout
 
     while true
-      Thread.current.backend.wait_io(socket_io, false)
+      Polyphony.backend_wait_io(socket_io, false)
       consume_input
       notice = notifies
       next unless notice