evt 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c45ef9b7d8ed527d6280ca836777fb2c54822e23c9414c0cdeb234561115f47
-  data.tar.gz: 9543f98474500b00ae1a68009a261db1538d986e71bb7d9437bc9f190aff3c38
+  metadata.gz: e3b69b158f74a67ae86879e3a7019a32a1a6579bbf8cc707f7438ad68ffac2f4
+  data.tar.gz: 50aae949da244dde5e4f665e4eb08c2ea446a13a7f73bd3101a23000d9ac7a63
 SHA512:
-  metadata.gz: d9fe5b68df1d9e72d10314744ac173bc4f99a3d420034d861b4d1685c1f36bfbe24c993c9686c5862d45926dd8ddb901759d913dfb0ab39d730c380bfa27f3d4
-  data.tar.gz: cfbe9a5c112c71d96a737f29d9b4c5e1fd078b060331d999b7007a846b8e2a71f4de2eeebfc53e22dae8c33bf89afb15df5b36205b17f43f6f7e00096d3950f7
+  metadata.gz: 44b1a6e2b93d049f8c205910d7df2eb08221eb64a861b2e28870d39b0fac23fdc94a8ec100be574ba6bc63b991435068c7f79f3ce3fc4d13f101950974d903f7
+  data.tar.gz: e3db93cccddec122644ed83b249737ae35fbb18d70a8811e2e70f362fcfce3084be41b0a6421a966b407b63809888e72d528b640d4b2c636b2c95eaaa802210c

data/.travis.yml

@@ -1,6 +1,25 @@
 ---
 language: ruby
 cache: bundler
-rvm:
-  - ruby-head
+rvm: 2.7.1
+matrix:
+  include:
+    - rvm: 2.7.1
+      os: linux
+    - rvm: 2.7.1
+      os: osx
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
 before_install: gem install bundler -v 2.1.4
+script:
+  - gem list -l
+  - bundle exec rake compile
+  - bundle exec rake
+
+bundler_args: --jobs 1 --retry 3
+
+notifications:
+  email: false

data/README.md

@@ -1,2 +1,26 @@
 # evt
-A low-level Event Handler designed for Ruby 3 Scheduler
+
+[![Build Status](https://travis-ci.org/dsh0416/evt.svg?branch=master)](https://travis-ci.org/dsh0416/evt)
+
+A Handcrafted Low-Level Event Handler designed as Ruby 3 Scheduler. 
+
+Supports `epoll`, `kqueue`, IOCP (WIP), and Ruby `select` fallback.
+
+```ruby
+require 'evt'
+
+rd, wr = IO.pipe
+Thread.current.scheduler = Evt::Scheduler.new
+
+hit = 0
+fiber = Fiber.new do
+    scheduler.wait_readable(rd)
+    hit += 1
+end
+
+wr.write('Hello World')
+fiber.resume
+Thread.current.scheduler.run
+
+puts hit # => 1
+```

data/ext/evt/evt.c

@@ -1,26 +1,20 @@
-#include <ruby.h>
-
-VALUE Scheduler = Qnil;
-
-void Init_evt_ext();
-VALUE method_scheduler_init(VALUE self);
-VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest);
-VALUE method_scheduler_deregister(VALUE self, VALUE io);
-VALUE method_scheduler_wait(VALUE self);
+#include "evt.h"
 
 void Init_evt_ext()
 {
-  Scheduler = rb_define_class("Scheduler", rb_cObject);
-  rb_define_method(Scheduler, "init_selector", method_scheduler_init, 0);
-  rb_define_method(Scheduler, "register", method_scheduler_register, 2);
-  rb_define_method(Scheduler, "deregister", method_scheduler_deregister, 1);
-  rb_define_method(Scheduler, "wait", method_scheduler_wait, 0);
+    Evt = rb_define_module("Evt");
+    Scheduler = rb_define_class_under(Evt, "Scheduler", rb_cObject);
+    rb_define_singleton_method(Scheduler, "backend", method_scheduler_backend, 0);
+    rb_define_method(Scheduler, "init_selector", method_scheduler_init, 0);
+    rb_define_method(Scheduler, "register", method_scheduler_register, 2);
+    rb_define_method(Scheduler, "deregister", method_scheduler_deregister, 1);
+    rb_define_method(Scheduler, "wait", method_scheduler_wait, 0);
 }
 
 
 #if defined(__linux__) // TODO: Do more checks for using epoll
 #include <sys/epoll.h>
-#define EPOLL_MAX_EVENTS 65535
+#define EPOLL_MAX_EVENTS 64
 
 VALUE method_scheduler_init(VALUE self) {
     rb_iv_set(self, "@epfd", INT2NUM(epoll_create(1))); // Size of epoll is ignored after Linux 2.6.8.
@@ -56,7 +50,7 @@ VALUE method_scheduler_deregister(VALUE self, VALUE io) {
 }
 
 VALUE method_scheduler_wait(VALUE self) {
-    int n, epfd, i, event_flag;
+    int n, epfd, i, event_flag, timeout;
     VALUE next_timeout, obj_io, readables, writables, result;
     ID id_next_timeout = rb_intern("next_timeout");
     ID id_push = rb_intern("push");
@@ -66,10 +60,16 @@ VALUE method_scheduler_wait(VALUE self) {
     readables = rb_ary_new();
     writables = rb_ary_new();
 
+    if (next_timeout == Qnil) {
+        timeout = -1;
+    } else {
+        timeout = NUM2INT(next_timeout);
+    }
+
     struct epoll_event* events = (struct epoll_event*) xmalloc(sizeof(struct epoll_event) * EPOLL_MAX_EVENTS);
     
-    n = epoll_wait(epfd, events, EPOLL_MAX_EVENTS, next_timeout);
-    // Check if n > 0
+    n = epoll_wait(epfd, events, EPOLL_MAX_EVENTS, timeout);
+    // TODO: Check if n >= 0
 
     for (i = 0; i < n; i++) {
         event_flag = events[i].events;
@@ -89,6 +89,98 @@ VALUE method_scheduler_wait(VALUE self) {
     xfree(events);
     return result;
 }
+
+VALUE method_scheduler_backend() {
+    return rb_str_new_cstr("epoll");
+}
+#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__APPLE__)
+#include <sys/event.h>
+#define KQUEUE_MAX_EVENTS 64
+
+VALUE method_scheduler_init(VALUE self) {
+    rb_iv_set(self, "@kq", INT2NUM(kqueue()));
+    return Qnil;
+}
+
+VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest) {
+    struct kevent event;
+    u_short event_flags = 0;
+    ID id_fileno = rb_intern("fileno");
+    int kq = NUM2INT(rb_iv_get(self, "@kq"));
+    int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
+    int ruby_interest = NUM2INT(interest);
+    int readable = NUM2INT(rb_const_get(rb_cIO, rb_intern("WAIT_READABLE")));
+    int writable = NUM2INT(rb_const_get(rb_cIO, rb_intern("WAIT_WRITABLE")));
+    
+    if (ruby_interest & readable) {
+        event_flags |= EVFILT_READ;
+    } else if (ruby_interest & writable) {
+        event_flags |= EVFILT_WRITE;
+    }
+
+    EV_SET(&event, fd, event_flags, EV_ADD|EV_ENABLE, 0, 0, (void*) io);
+    kevent(kq, &event, 1, NULL, 0, NULL); // TODO: Check the return value
+    return Qnil;
+}
+
+VALUE method_scheduler_deregister(VALUE self, VALUE io) {
+    struct kevent event;
+    ID id_fileno = rb_intern("fileno");
+    int kq = NUM2INT(rb_iv_get(self, "@kq"));
+    int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
+    EV_SET(&event, fd, 0, EV_DELETE, 0, 0, NULL);
+    kevent(kq, &event, 1, NULL, 0, NULL); // TODO: Check the return value
+    return Qnil;
+}
+
+VALUE method_scheduler_wait(VALUE self) {
+    int n, kq, i;
+    u_short event_flags = 0;
+
+    struct kevent* events; // Event Triggered
+    struct timespec timeout;
+    VALUE next_timeout, obj_io, readables, writables, result;
+    ID id_next_timeout = rb_intern("next_timeout");
+    ID id_push = rb_intern("push");
+
+    kq = NUM2INT(rb_iv_get(self, "@kq"));
+    next_timeout = rb_funcall(self, id_next_timeout, 0);
+    readables = rb_ary_new();
+    writables = rb_ary_new();
+
+   events = (struct kevent*) xmalloc(sizeof(struct kevent) * KQUEUE_MAX_EVENTS);
+
+    if (next_timeout == Qnil || NUM2INT(next_timeout) == -1) {
+        n = kevent(kq, NULL, 0, events, KQUEUE_MAX_EVENTS, NULL);
+    } else {
+        timeout.tv_sec = next_timeout / 1000;
+        timeout.tv_nsec = next_timeout % 1000 * 1000 * 1000;
+        n = kevent(kq, NULL, 0, events, KQUEUE_MAX_EVENTS, &timeout);
+    }
+
+    // TODO: Check if n >= 0
+    for (i = 0; i < n; i++) {
+        event_flags = events[i].filter;
+        if (event_flags & EVFILT_READ) {
+            obj_io = (VALUE) events[i].udata;
+            rb_funcall(readables, id_push, 1, obj_io);
+        } else if (event_flags & EVFILT_WRITE) {
+            obj_io = (VALUE) events[i].udata;
+            rb_funcall(writables, id_push, 1, obj_io);
+        }
+    }
+
+    result = rb_ary_new2(2);
+    rb_ary_store(result, 0, readables);
+    rb_ary_store(result, 1, writables);
+
+    xfree(events);
+    return result;
+}
+
+VALUE method_scheduler_backend() {
+    return rb_str_new_cstr("kqueue");
+}
 #else
 // Fallback to IO.select
 VALUE method_scheduler_init(VALUE self) {
@@ -119,4 +211,8 @@ VALUE method_scheduler_wait(VALUE self) {
 
     return rb_funcall(rb_cIO, id_select, 4, readable_keys, writable_keys, rb_ary_new(), next_timeout);
 }
+
+VALUE method_scheduler_backend() {
+    return rb_str_new_cstr("ruby");
+}
 #endif

data/ext/evt/evt.h

@@ -0,0 +1,11 @@
+#include <ruby.h>
+
+VALUE Evt = Qnil;
+VALUE Scheduler = Qnil;
+
+void Init_evt_ext();
+VALUE method_scheduler_init(VALUE self);
+VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest);
+VALUE method_scheduler_deregister(VALUE self, VALUE io);
+VALUE method_scheduler_wait(VALUE self);
+VALUE method_scheduler_backend();

data/lib/evt.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'evt/version'
-require 'evt_ext'
+require_relative 'evt/io'
+require_relative 'evt_ext'
 require_relative 'evt/scheduler'
 
 module Evt
-  class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/evt/io.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Patch for 2.7.1 when tests
+class IO
+  WAIT_READABLE = 1
+  WAIT_WRITABLE = 3
+end

data/lib/evt/scheduler.rb

@@ -9,12 +9,7 @@ rescue LoadError
   # Ignore.
 end
 
-class IO
-  WAIT_READABLE = 1
-  WAIT_WRITABLE = 3
-end
-
-class Scheduler
+class Evt::Scheduler
   def initialize
     @readable = {}
     @writable = {}
@@ -46,7 +41,6 @@ class Scheduler
 
   def run
     while @readable.any? or @writable.any? or @waiting.any?
-      # Can only handle file descriptors up to 1024...
       readable, writable = self.wait
 
       # puts "readable: #{readable}" if readable&.any?
@@ -162,9 +156,7 @@ class Scheduler
 
   def fiber(&block)
     fiber = Fiber.new(blocking: false, &block)
-
     fiber.resume
-
     return fiber
   end
 end

data/lib/evt/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Evt
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Delton Ding
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -42,8 +42,10 @@ files:
 - Rakefile
 - evt.gemspec
 - ext/evt/evt.c
+- ext/evt/evt.h
 - ext/evt/extconf.rb
 - lib/evt.rb
+- lib/evt/io.rb
 - lib/evt/scheduler.rb
 - lib/evt/version.rb
 homepage: https://github.com/dsh0416/evt