evt 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9466e3fd37da9807dc59525feebfe9252489a460a83111febf95973ff77fee56
-  data.tar.gz: 531808277a49049dc156144294346730a457d717699e091348125086dca529de
+  metadata.gz: 2a40fa492b119e2e67823ab476e39454de3027efbfab820c5d38a4562314f43a
+  data.tar.gz: 357b5b8d9c00ca7ed7df013aa6826e5ec85e72f329009272eaf985d7db519abf
 SHA512:
-  metadata.gz: c12a241295309fd31bf21bc4957374a636ff046b6aa1c5f670113f0cdeedb3df74f974145ba6f19f9e442d5f8d9ae373d70bfee6ae417dc09e9b620d57bcc78f
-  data.tar.gz: b3a369c7640d4770a89e7d37166930a757ca25266132fbd0544f2f0a065670de1c13578ea4cf7fc43ad1fb2c2020757b20cc972e85c23cab720bb229103fb070
+  metadata.gz: '09cf37c36d93a8fa0144a324934055ede6063203f506af41fcd6a2dd8ebeb0509ff5996726ab92badac63e020b1b56301d18eed967c7fa830286aafde1b38001'
+  data.tar.gz: 869b7f1d95960362d2049ebfddb3a18fdad4a2558f64d27f7e5306f57025592a2402086f2ded46291a95f0fd4fe200f9040e83a449e29a61e0245e25e8f8d1ad

data/.github/workflows/test.yml

@@ -12,13 +12,13 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - { os: ubuntu-20.04, ruby: '3.0' }
-        - { os: ubuntu-20.04, ruby: ruby-head }
-        - { os: macos-11.0, ruby: '3.0' }
-        - { os: macos-11.0, ruby: ruby-head }
-        - { os: windows-2019, ruby: mingw }
-        - { os: windows-2019, ruby: mswin }
-    name: ${{ matrix.os }} ${{ matrix.ruby }}
+        - { os: ubuntu-20.04, ruby: '3.0', backend: epoll }
+        - { os: ubuntu-20.04, ruby: '3.0', backend: ruby, disable-epoll: 1 }
+        - { os: macos-11.0, ruby: '3.0', backend: kqueue }
+        - { os: macos-11.0, ruby: '3.0', backend: ruby, disable-kqueue: 1 }
+        - { os: windows-2019, ruby: mingw, backend: ruby }
+        - { os: windows-2019, ruby: mswin, backend: ruby }
+    name: test ${{ matrix.os }} ${{ matrix.ruby }} ${{ matrix.backend }}
     runs-on: ${{ matrix.os }}
     timeout-minutes: 5
     steps:
@@ -32,6 +32,9 @@ jobs:
             gem install bundler
             bundle install --jobs 4 --retry 3
       - name: Compile
+        env:
+          DISABLE_EPOLL: ${{ matrix.disable-epoll }}
+          DISABLE_KQUEUE: ${{ matrix.disable-kqueue }}
         run: rake compile
       - name: Test
         run: rake

data/README.md

@@ -1,6 +1,6 @@
 # Evt
 
-The Event Library that designed for Ruby 3.0.
+The Event Library that designed for Ruby 3.0 Fiber Scheduler.
 
 **This gem is still under development, APIs and features are not stable. Advices and PRs are highly welcome.**
 
@@ -10,8 +10,6 @@ The Event Library that designed for Ruby 3.0.
 
 ## Features
 
-
-
 ### IO Backend Support
 
 |                 | Linux       | Windows     | macOS       | FreeBSD     |
@@ -28,6 +26,22 @@ The Event Library that designed for Ruby 3.0.
 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).
 5. `kqueue` performance in Darwin is very poor. **MAY BE DISABLED IN THE FUTURE.**
 
+### 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 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 |
+
 ## Install
 
 ```bash
@@ -68,6 +82,7 @@ scheduler.run
 - [x] Support iov features of io_uring
 - [x] Support IOCP (**NOT ENABLED YET**)
 - [x] Setup tests with Ruby 3
+- [x] Selectable backend compilation by environment variable
 - [ ] Support IOCP with iov features
 - [ ] Setup more tests for production purpose
 - [ ] Documentation for usages

data/evt.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Delton Ding"]
   spec.email         = ["dsh0416@gmail.com"]
 
-  spec.summary       = "A low-level Event Handler designed for Ruby 3 Scheduler"
+  spec.summary       = "The Event Library that designed for Ruby 3.0 Fiber Scheluer."
   spec.description   = "A low-level Event Handler designed for Ruby 3 Scheduler for better performance"
   spec.homepage      = "https://github.com/dsh0416/evt"
   spec.license       = 'BSD-3-Clause'
-  spec.required_ruby_version = '>= 2.8.0.dev'
+  spec.required_ruby_version = '>= 3.0.0.rc1'
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/dsh0416/evt"

data/ext/evt/epoll.h

@@ -56,7 +56,7 @@ VALUE method_scheduler_wait(VALUE self) {
         timeout = NUM2INT(next_timeout);
     }
 
-    struct epoll_event* events = (struct epoll_event*) xmalloc(sizeof(struct epoll_event) * EPOLL_MAX_EVENTS);
+    struct epoll_event events[EPOLL_MAX_EVENTS];
     
     n = epoll_wait(epfd, events, EPOLL_MAX_EVENTS, timeout);
     if (n < 0) {
@@ -79,8 +79,6 @@ VALUE method_scheduler_wait(VALUE self) {
     result = rb_ary_new2(2);
     rb_ary_store(result, 0, readables);
     rb_ary_store(result, 1, writables);
-
-    xfree(events);
     return result;
 }
 

data/ext/evt/evt.c

@@ -30,5 +30,7 @@ void Init_evt_ext()
 #elif HAVE_WINDOWS_H
     #include "select.h"
     // #include "iocp.h"
+#else
+    #include "select.h"
 #endif
 #endif

data/ext/evt/extconf.rb

@@ -2,11 +2,22 @@ require 'mkmf'
 extension_name = 'evt_ext'
 dir_config(extension_name)
 
-have_library('uring')
-have_header('liburing.h')
-have_header('sys/epoll.h')
-have_header('sys/event.h')
-have_header('Windows.h') 
+def env_defined?(v)
+  return false if ENV[v].nil?
+  return false if ENV[v].empty?
+  return false if ENV[v].upcase == 'FALSE'
+  return false if ENV[v] == '0'
+  true
+end
+
+unless env_defined?('DISABLE_URING')
+  have_library('uring')
+  have_header('liburing.h')
+end
+
+have_header('sys/epoll.h') unless env_defined?('DISABLE_EPOLL')
+have_header('sys/event.h') unless env_defined?('DISABLE_KQUEUE')
+have_header('Windows.h')  unless env_defined?('DISABLE_IOCP')
 
 create_header
 create_makefile(extension_name)

data/ext/evt/kqueue.h

@@ -27,26 +27,20 @@ VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest) {
         event_flags |= EVFILT_WRITE;
     }
 
-    EV_SET(&event, fd, event_flags, EV_ADD|EV_ENABLE, 0, 0, (void*) io);
+    EV_SET(&event, fd, event_flags, EV_ADD|EV_ENABLE|EV_ONESHOT, 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, (void*) io);
-    kevent(kq, &event, 1, NULL, 0, (void*) io); // TODO: Check the return value
+    // One-shot mode
     return Qnil;
 }
 
 VALUE method_scheduler_wait(VALUE self) {
     int n, kq, i;
     u_short event_flags = 0;
-
-    struct kevent* events; // Event Triggered
+    struct kevent events[KQUEUE_MAX_EVENTS];
     struct timespec timeout;
     VALUE next_timeout, obj_io, readables, writables, result;
     ID id_next_timeout = rb_intern("next_timeout");
@@ -57,8 +51,6 @@ VALUE method_scheduler_wait(VALUE self) {
     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 {
@@ -85,7 +77,6 @@ VALUE method_scheduler_wait(VALUE self) {
     rb_ary_store(result, 0, readables);
     rb_ary_store(result, 1, writables);
 
-    xfree(events);
     return result;
 }
 

data/ext/evt/uring.h

@@ -101,6 +101,7 @@ VALUE method_scheduler_wait(VALUE self) {
         } else {
             rb_funcall(iovs, id_push, 1, obj_io);
         }
+        io_uring_cqe_seen(ring, cqes[i]);
     }
 
     if (ret == 0) {

data/lib/evt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Delton Ding
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -65,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.8.0.dev
+      version: 3.0.0.rc1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -75,5 +75,5 @@ requirements: []
 rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
-summary: A low-level Event Handler designed for Ruby 3 Scheduler
+summary: The Event Library that designed for Ruby 3.0 Fiber Scheluer.
 test_files: []