evt 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40b96a960c2027db56a915a8c4d6e20f8d29fd9f195003ef1a93cf9fad13a151
-  data.tar.gz: d6f99c7c134954a47b68c56f9a68f1227ed9ac90cefedefbef33a9c8978730aa
+  metadata.gz: 945c1a802be8b4e03b88c44138a139367288409b27c83a6f2904d0ecc94d2a40
+  data.tar.gz: 7b88e16f4a082f536c5b0eb9a7f68e67e6e1f5ab4586dbe771f7c57b9004447a
 SHA512:
-  metadata.gz: 75dbf1e519db25b8a0f63958cb2578fe852f12374eaed0a5a3b9595b30315ad92971477db2b27ed1bd2db6bd051553fa93eaa41263ed45c08c57ace0b43117fd
-  data.tar.gz: 905988d2a76fed454cd42b3acc014d5ddce044ecdf918352d8a6ede58213b3006dda7588a7d5889c6a4b16b23cce0a14308d71e4ba02430efcfe0fcdfa8f38c6
+  metadata.gz: f042da98ff5f85de3b4fce59a2726f2f4c46a1da8817abb524d700cd0413fc4118cb6c0a766a69abdc7e4ae5f0acdd35bc653b0c33116239c1e776f4c3218f23
+  data.tar.gz: 1824a4935d712e62268b9cad01f52c445ccecfcaa859b11fd93749f28ef3f259370b011af395ae269c9c03544b7ab5c1bb6ad3afd18cc8eea4a6d576e151ff76

data/README.md

@@ -15,13 +15,13 @@ The Event Library that designed for Ruby 3.0 Fiber Scheduler.
 
 |                 | Linux       | Windows     | macOS       | FreeBSD     |
 | --------------- | ----------- | ------------| ----------- | ----------- |
-| io_uring        | ✅  (See 1) | ❌          | ❌          | ❌          |
+| io_uring        | ⚠️  (See 1) | ❌          | ❌          | ❌          |
 | epoll           | ✅  (See 2) | ❌          | ❌          | ❌          |
 | kqueue          | ❌          | ❌          | ✅ (⚠️ See 5) | ✅          |
 | IOCP            | ❌          | ❌ (⚠️See 3) | ❌          | ❌          |
 | Ruby (`IO.select`) | ✅ Fallback | ✅ (⚠️See 4) | ✅ Fallback | ✅ Fallback |
 
-1. when liburing is installed
+1. when liburing is installed. (Currently fixing)
 2. when kernel version >= 2.6.9
 3. WOULD NOT WORK until `FILE_FLAG_OVERLAPPED` is included in I/O initialization process.
 4. Some I/Os are not able to be nonblock under Windows. See [Scheduler Docs](https://docs.ruby-lang.org/en/master/doc/scheduler_md.html#label-IO).
@@ -29,22 +29,20 @@ The Event Library that designed for Ruby 3.0 Fiber Scheduler.
 
 ### Benchmark
 
-The benchmark is running under `v0.2.2` version. See [evt-server-benchmark](https://github.com/dsh0416/evt-server-benchmark) for test code, the test is running under a single-thread server.
+The benchmark is running under `v0.3.1` version. See `example.rb` in [midori](https://github.com/midori-rb/midori.rb) for test code, the test is running under a single-thread server.
 
 The test command is `wrk -t4 -c8192 -d30s http://localhost:3001`.
 
 All of the systems have set their file descriptor limit to maximum.
-
-| OS    | CPU         | Memory | Backend                | req/s    |
-| ----- | ----------- | ------ | ---------------------- | -------- |
-| Linux | Ryzen 2700x | 64GB   | epoll                  | 54680.08 |
-| Linux | Ryzen 2700x | 64GB   | io_uring               | 50245.53 |
-| Linux | Ryzen 2700x | 64GB   | IO.select (using poll) | 44159.23 |
-| macOS | i7-6820HQ   | 16GB   | kqueue                 | 37855.53 |
-| macOS | i7-6820HQ   | 16GB   | IO.select (using poll) | 28293.36 |
-
-The benchmark uses an invalid parser, and `wrk` is very error-sensitive. The benchmark can't close the connection properly.
-Use a valid parser, recent updates to my [midori](https://github.com/midori-rb/midori.rb) is able to use Ruby scheduler, which could achives 247k+ req/s on single thread with `kqueue` and 647k+ req/s with `epoll`.
+On systems raising "Fiber unable to allocate memory", `sudo sysctl -w vm.max_map_count=1000000` is set.
+
+| OS    | CPU         | Memory | Backend                | req/s         |
+| ----- | ----------- | ------ | ---------------------- | --------------|
+| Linux | Ryzen 2700x | 64GB   | epoll                  | 1853259.47    |
+| Linux | Ryzen 2700x | 64GB   | io_uring               | require fixes |
+| Linux | Ryzen 2700x | 64GB   | IO.select (using poll) | 1636849.15    |
+| macOS | i7-6820HQ   | 16GB   | kqueue                 | 247370.37     |
+| macOS | i7-6820HQ   | 16GB   | IO.select (using poll) | 323391.38     |
 
 ## Install
 

data/evt.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake-compiler', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0.20.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.4'
 end

data/ext/evt/epoll.h

@@ -25,20 +25,14 @@ VALUE method_scheduler_epoll_register(VALUE self, VALUE io, VALUE interest) {
         event.events |= EPOLLOUT;
     }
 
+    event.events |=EPOLLONESHOT;
+
     event.data.ptr = (void*) io;
 
     epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &event);
     return Qnil;
 }
 
-VALUE method_scheduler_epoll_deregister(VALUE self, VALUE io) {
-    ID id_fileno = rb_intern("fileno");
-    int epfd = NUM2INT(rb_iv_get(self, "@epfd"));
-    int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
-    epoll_ctl(epfd, EPOLL_CTL_DEL, fd, NULL); // Require Linux 2.6.9 for NULL event.
-    return Qnil;
-}
-
 VALUE method_scheduler_epoll_wait(VALUE self) {
     int n, epfd, i, event_flag, timeout;
     VALUE next_timeout, obj_io, readables, writables, result;

data/ext/evt/evt.c

@@ -24,7 +24,6 @@ void Init_evt_ext()
     rb_define_singleton_method(Bundled, "epoll_backend", method_scheduler_epoll_backend, 0);
     rb_define_method(Bundled, "epoll_init_selector", method_scheduler_epoll_init, 0);
     rb_define_method(Bundled, "epoll_register", method_scheduler_epoll_register, 2);
-    rb_define_method(Bundled, "epoll_deregister", method_scheduler_epoll_deregister, 1);
     rb_define_method(Bundled, "epoll_wait", method_scheduler_epoll_wait, 0);
 #endif
 #if HAVE_SYS_EVENT_H

data/ext/evt/evt.h

@@ -13,7 +13,6 @@ void Init_evt_ext();
 #if HAVE_LIBURING_H
     VALUE method_scheduler_uring_init(VALUE self);
     VALUE method_scheduler_uring_register(VALUE self, VALUE io, VALUE interest);
-    VALUE method_scheduler_uring_deregister(VALUE self, VALUE io);
     VALUE method_scheduler_uring_wait(VALUE self);
     VALUE method_scheduler_uring_backend(VALUE klass);
     VALUE method_scheduler_uring_io_read(VALUE self, VALUE io, VALUE buffer, VALUE offset, VALUE length);
@@ -46,7 +45,6 @@ void Init_evt_ext();
 #if HAVE_SYS_EPOLL_H
     VALUE method_scheduler_epoll_init(VALUE self);
     VALUE method_scheduler_epoll_register(VALUE self, VALUE io, VALUE interest);
-    VALUE method_scheduler_epoll_deregister(VALUE self, VALUE io);
     VALUE method_scheduler_epoll_wait(VALUE self);
     VALUE method_scheduler_epoll_backend(VALUE klass);
     #include <sys/epoll.h>
@@ -55,7 +53,6 @@ void Init_evt_ext();
 #if HAVE_SYS_EVENT_H
     VALUE method_scheduler_kqueue_init(VALUE self);
     VALUE method_scheduler_kqueue_register(VALUE self, VALUE io, VALUE interest);
-    VALUE method_scheduler_kqueue_deregister(VALUE self, VALUE io);
     VALUE method_scheduler_kqueue_wait(VALUE self);
     VALUE method_scheduler_kqueue_backend(VALUE klass);
     #include <sys/event.h>

data/ext/evt/uring.h

@@ -79,6 +79,12 @@ VALUE method_scheduler_uring_wait(VALUE self) {
     iovs = rb_ary_new();
 
     TypedData_Get_Struct(rb_iv_get(self, "@ring"), struct io_uring, &type_uring_payload, ring);
+
+    struct __kernel_timespec ts;
+    ts.tv_sec = NUM2INT(next_timeout);
+    ts.tv_nsec = 0;
+
+    io_uring_wait_cqe_timeout(ring, cqes, &ts);
     ret = io_uring_peek_batch_cqe(ring, cqes, URING_MAX_EVENTS);
 
     for (i = 0; i < ret; i++) {
@@ -94,21 +100,14 @@ VALUE method_scheduler_uring_wait(VALUE self) {
                 rb_funcall(writables, id_push, 1, obj_io);
             }
         } else {
-            rb_funcall(iovs, id_push, 1, obj_io);
+            VALUE v = rb_ary_new2(2);
+            rb_ary_store(v, 0, obj_io);
+            rb_ary_store(v, 1, obj_io);
+            rb_funcall(iovs, id_push, 1, SIZET2NUM(cqes[i]->res));
         }
         io_uring_cqe_seen(ring, cqes[i]);
     }
 
-    if (ret == 0) {
-       if (next_timeout != Qnil && NUM2INT(next_timeout) != -1) {
-            // sleep
-            time = next_timeout / 1000;
-            rb_funcall(rb_mKernel, id_sleep, 1, rb_float_new(time));
-       } else {
-            rb_funcall(rb_mKernel, id_sleep, 1, rb_float_new(0.001)); // To avoid infinite loop
-       }
-    }
-
     result = rb_ary_new2(3);
     rb_ary_store(result, 0, readables);
     rb_ary_store(result, 1, writables);
@@ -132,27 +131,23 @@ VALUE method_scheduler_uring_io_read(VALUE self, VALUE io, VALUE buffer, VALUE o
     int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
 
     read_buffer = (char*) xmalloc(NUM2SIZET(length));
-    struct iovec iov = {
-        .iov_base = read_buffer,
-        .iov_len = NUM2SIZET(length),
-    };
 
     data = (struct uring_data*) xmalloc(sizeof(struct uring_data));
     data->is_poll = false;
     data->io = io;
     data->poll_mask = 0;
     
-    io_uring_prep_readv(sqe, fd, &iov, 1, NUM2SIZET(offset));
+    io_uring_prep_read(sqe, fd, read_buffer, 1, NUM2SIZET(length), NUM2SIZET(offset));
     io_uring_sqe_set_data(sqe, data);
     io_uring_submit(ring);
 
+    VALUE ret = rb_funcall(Fiber, rb_intern("yield"), 0); // Fiber.yield
+
     VALUE result = rb_str_new(read_buffer, strlen(read_buffer));
     if (buffer != Qnil) {
         rb_str_append(buffer, result);
     }
-
-    rb_funcall(Fiber, rb_intern("yield"), 0); // Fiber.yield
-    return result;
+    return ret;
 }
 
 VALUE method_scheduler_uring_io_write(VALUE self, VALUE io, VALUE buffer, VALUE offset, VALUE length) {
@@ -170,21 +165,16 @@ VALUE method_scheduler_uring_io_write(VALUE self, VALUE io, VALUE buffer, VALUE
     int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
 
     write_buffer = StringValueCStr(buffer);
-    struct iovec iov = {
-        .iov_base = write_buffer,
-        .iov_len = NUM2SIZET(length),
-    };
 
     data = (struct uring_data*) xmalloc(sizeof(struct uring_data));
     data->is_poll = false;
     data->io = io;
     data->poll_mask = 0;
     
-    io_uring_prep_writev(sqe, fd, &iov, 1, NUM2SIZET(offset));
+    io_uring_prep_write(sqe, fd, write_buffer, NUM2SIZET(length), NUM2SIZET(offset));
     io_uring_sqe_set_data(sqe, data);
     io_uring_submit(ring);
-    rb_funcall(Fiber, rb_intern("yield"), 0); // Fiber.yield
-    return length;
+    return rb_funcall(Fiber, rb_intern("yield"), 0);
 }
 
 VALUE method_scheduler_uring_backend(VALUE klass) {

data/lib/evt/backends/bundled.rb

@@ -23,7 +23,7 @@ class Evt::Bundled
   attr_reader :waiting
 
   def next_timeout
-    _fiber, timeout = @waiting.min_by{|key, value| value}
+    _fiber, timeout = @waiting.min_by{ |key, value| value }
 
     if timeout
       offset = timeout - current_time
@@ -49,9 +49,10 @@ class Evt::Bundled
       end
 
       unless iovs.nil?
-        iovs&.each do |io|
+        iovs&.each do |v|
+          io, ret = v
           fiber = @iovs.delete(io)
-          fiber&.resume
+          fiber&.resume(ret)
         end
       end
 
@@ -63,7 +64,7 @@ class Evt::Bundled
 
         waiting.each do |fiber, timeout|
           if timeout <= time
-            fiber.resume
+            fiber.resume if fiber.is_a? Fiber and fiber.alive?
           else
             @waiting[fiber] = timeout
           end
@@ -78,7 +79,7 @@ class Evt::Bundled
         end
 
         ready.each do |fiber|
-          fiber.resume
+          fiber.resume if fiber.is_a? Fiber and fiber.alive?
         end
       end
     end
@@ -100,7 +101,6 @@ class Evt::Bundled
     @writable[io] = Fiber.current unless (events & IO::WRITABLE).zero?
     self.register(io, events)
     Fiber.yield
-    self.deregister(io)
     true
   end
 
@@ -150,8 +150,8 @@ class Evt::Bundled
   end
 
   # Collect closed streams in readables and writables
-  def collect
-    if @collect_counter < COLLECT_COUNTER_MAX
+  def collect(force=false)
+    if @collect_counter < COLLECT_COUNTER_MAX and !force
       @collect_counter += 1
       return
     end
@@ -165,6 +165,10 @@ class Evt::Bundled
     @writable.keys.each do |io|
       @writable.delete(io) if io.closed?
     end
+
+    @iovs.keys.each do |io|
+      @iovs.delete(io) if io.closed?
+    end
   end
 
   # Intercept the creation of a non-blocking fiber.

data/lib/evt/backends/epoll.rb

@@ -17,10 +17,6 @@ class Evt::Epoll < Evt::Bundled
     epoll_register(io, interest)
   end
 
-  def deregister(io)
-    epoll_deregister(io)
-  end
-
   def wait
     epoll_wait
   end

data/lib/evt/backends/iocp.rb

@@ -15,10 +15,6 @@ class Evt::Iocp < Evt::Bundled
     # Placeholder
   end
 
-  def deregister(io)
-    # Placeholder
-  end
-
   def io_read(io, buffer, offset, length)
     # Placeholder
   end

data/lib/evt/backends/kqueue.rb

@@ -17,10 +17,6 @@ class Evt::Kqueue < Evt::Bundled
     kqueue_register(io, interest)
   end
 
-  def deregister(io)
-    # Kqueue running under one-shot mode, no need to deregister
-  end
-
   def wait
     kqueue_wait
   end

data/lib/evt/backends/select.rb

@@ -17,11 +17,10 @@ class Evt::Select < Evt::Bundled
     # Select is stateless
   end
 
-  def deregister(io)
-    # Select is stateless
-  end
-
   def wait
     select_wait
+  rescue Errno::EBADF => _
+    collect(true)
+    return [], []
   end
 end

data/lib/evt/backends/uring.rb

@@ -14,11 +14,7 @@ class Evt::Uring < Evt::Bundled
   end
 
   def register(io, interest)
-    uring_register(io, register)
-  end
-
-  def deregister(io)
-    # io_uring running under one-shot mode, no need to deregister
+    uring_register(io, interest)
   end
 
   def io_read(io, buffer, offset, length)

data/lib/evt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Evt
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Delton Ding
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: A low-level Event Handler designed for Ruby 3 Scheduler for better performance
 email:
 - dsh0416@gmail.com