evt 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b69b158f74a67ae86879e3a7019a32a1a6579bbf8cc707f7438ad68ffac2f4
-  data.tar.gz: 50aae949da244dde5e4f665e4eb08c2ea446a13a7f73bd3101a23000d9ac7a63
+  metadata.gz: 2a40fa492b119e2e67823ab476e39454de3027efbfab820c5d38a4562314f43a
+  data.tar.gz: 357b5b8d9c00ca7ed7df013aa6826e5ec85e72f329009272eaf985d7db519abf
 SHA512:
-  metadata.gz: 44b1a6e2b93d049f8c205910d7df2eb08221eb64a861b2e28870d39b0fac23fdc94a8ec100be574ba6bc63b991435068c7f79f3ce3fc4d13f101950974d903f7
-  data.tar.gz: e3db93cccddec122644ed83b249737ae35fbb18d70a8811e2e70f362fcfce3084be41b0a6421a966b407b63809888e72d528b640d4b2c636b2c95eaaa802210c
+  metadata.gz: '09cf37c36d93a8fa0144a324934055ede6063203f506af41fcd6a2dd8ebeb0509ff5996726ab92badac63e020b1b56301d18eed967c7fa830286aafde1b38001'
+  data.tar.gz: 869b7f1d95960362d2049ebfddb3a18fdad4a2558f64d27f7e5306f57025592a2402086f2ded46291a95f0fd4fe200f9040e83a449e29a61e0245e25e8f8d1ad

data/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: CI Tests
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '0 7 * * SUN'
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - { 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:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: false
+      - name: Install Dependencies
+        run: |
+            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
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@master
+        with:
+          ruby-version: '3.0'
+          bundler-cache: false
+      - name: Install Dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Build
+        run: gem build evt.gemspec

data/.gitignore

@@ -9,3 +9,4 @@
 /*.gem
 /lib/*.bundle
 /lib/*.so
+Gemfile.lock

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in evt.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"

data/README.md

@@ -1,26 +1,88 @@
-# evt
+# Evt
 
-[![Build Status](https://travis-ci.org/dsh0416/evt.svg?branch=master)](https://travis-ci.org/dsh0416/evt)
+The Event Library that designed for Ruby 3.0 Fiber Scheduler.
 
-A Handcrafted Low-Level Event Handler designed as Ruby 3 Scheduler. 
+**This gem is still under development, APIs and features are not stable. Advices and PRs are highly welcome.**
 
-Supports `epoll`, `kqueue`, IOCP (WIP), and Ruby `select` fallback.
+[![CI Tests](https://github.com/dsh0416/evt/workflows/CI%20Tests/badge.svg)](https://github.com/dsh0416/evt/actions?query=workflow%3A%22CI+Tests%22)
+[![Gem Version](https://badge.fury.io/rb/evt.svg)](https://rubygems.org/gems/evt)
+[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/evt?type=total)](https://rubygems.org/gems/evt)
+
+## Features
+
+### IO Backend Support
+
+|                 | Linux       | Windows     | macOS       | FreeBSD     |
+| --------------- | ----------- | ------------| ----------- | ----------- |
+| io_uring        | ✅  (See 1) | ❌          | ❌          | ❌          |
+| epoll           | ✅  (See 2) | ❌          | ❌          | ❌          |
+| kqueue          | ❌          | ❌          | ✅ (⚠️ See 5) | ✅          |
+| IOCP            | ❌          | ❌ (⚠️See 3) | ❌          | ❌          |
+| Ruby (`select`) | ✅ Fallback | ✅ (⚠️See 4) | ✅ Fallback | ✅ Fallback |
+
+1. when liburing is installed
+2. when kernel version >= 2.6.8
+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).
+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
+gem install evt
+```
+
+## Usage
 
 ```ruby
 require 'evt'
 
 rd, wr = IO.pipe
-Thread.current.scheduler = Evt::Scheduler.new
+scheduler = Evt::Scheduler.new
+
+Fiber.set_scheduler scheduler
 
-hit = 0
-fiber = Fiber.new do
-    scheduler.wait_readable(rd)
-    hit += 1
+Fiber.schedule do
+  message = rd.read(20)
+  puts message
+  rd.close
 end
 
-wr.write('Hello World')
-fiber.resume
-Thread.current.scheduler.run
+Fiber.schedule do
+  wr.write("Hello World")
+  wr.close
+end
+
+scheduler.run
 
-puts hit # => 1
+# "Hello World"
 ```
+
+## Roadmap
+
+- [x] Support epoll/kqueue/select
+- [x] Upgrade to the latest Scheduler API
+- [x] Support io_uring
+- [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.7.1'
+  spec.required_ruby_version = '>= 3.0.0.rc1'
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/dsh0416/evt"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.vscode)/}) }
   end
   spec.require_paths = ["lib"]
   spec.extensions = ['ext/evt/extconf.rb']

data/ext/evt/epoll.h

@@ -0,0 +1,89 @@
+#ifndef EPOLL_H
+#define EPOLL_G
+#include "evt.h"
+
+#if HAVE_SYS_EPOLL_H
+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.
+    return Qnil;
+}
+
+VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest) {
+    struct epoll_event event;
+    ID id_fileno = rb_intern("fileno");
+    int epfd = NUM2INT(rb_iv_get(self, "@epfd"));
+    int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
+    int ruby_interest = NUM2INT(interest);
+    int readable = NUM2INT(rb_const_get(rb_cIO, rb_intern("READABLE")));
+    int writable = NUM2INT(rb_const_get(rb_cIO, rb_intern("WRITABLE")));
+    
+    if (ruby_interest & readable) {
+        event.events |= EPOLLIN;
+    }
+
+    if (ruby_interest & writable) {
+        event.events |= EPOLLOUT;
+    }
+
+    event.data.ptr = (void*) io;
+
+    epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &event);
+    return Qnil;
+}
+
+VALUE method_scheduler_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_wait(VALUE self) {
+    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");
+    
+    epfd = NUM2INT(rb_iv_get(self, "@epfd"));
+    next_timeout = rb_funcall(self, id_next_timeout, 0);
+    readables = rb_ary_new();
+    writables = rb_ary_new();
+
+    if (next_timeout == Qnil) {
+        timeout = -1;
+    } else {
+        timeout = NUM2INT(next_timeout);
+    }
+
+    struct epoll_event events[EPOLL_MAX_EVENTS];
+    
+    n = epoll_wait(epfd, events, EPOLL_MAX_EVENTS, timeout);
+    if (n < 0) {
+        rb_raise(rb_eIOError, "unable to call epoll_wait");
+    }
+
+    for (i = 0; i < n; i++) {
+        event_flag = events[i].events;
+        if (event_flag & EPOLLIN) {
+            obj_io = (VALUE) events[i].data.ptr;
+            rb_funcall(readables, id_push, 1, obj_io);
+        }
+
+        if (event_flag & EPOLLOUT) {
+            obj_io = (VALUE) events[i].data.ptr;
+            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);
+    return result;
+}
+
+VALUE method_scheduler_backend(VALUE klass) {
+    return rb_str_new_cstr("epoll");
+}
+#endif
+#endif

data/ext/evt/evt.c

@@ -1,218 +1,36 @@
+#ifndef EVT_C
+#define EVT_C
+
 #include "evt.h"
 
 void Init_evt_ext()
 {
     Evt = rb_define_module("Evt");
     Scheduler = rb_define_class_under(Evt, "Scheduler", rb_cObject);
+    Payload = rb_define_class_under(Scheduler, "Payload", rb_cObject);
+    Fiber = rb_define_class("Fiber", 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 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.
-    return Qnil;
-}
-
-VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest) {
-    struct epoll_event event;
-    ID id_fileno = rb_intern("fileno");
-    int epfd = NUM2INT(rb_iv_get(self, "@epfd"));
-    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.events |= EPOLLIN;
-    } else if (ruby_interest & writable) {
-        event.events |= EPOLLOUT;
-    }
-    event.data.ptr = (void*) io;
-
-    epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &event);
-    return Qnil;
-}
-
-VALUE method_scheduler_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_wait(VALUE self) {
-    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");
-    
-    epfd = NUM2INT(rb_iv_get(self, "@epfd"));
-    next_timeout = rb_funcall(self, id_next_timeout, 0);
-    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, timeout);
-    // TODO: Check if n >= 0
-
-    for (i = 0; i < n; i++) {
-        event_flag = events[i].events;
-        if (event_flag & EPOLLIN) {
-            obj_io = (VALUE) events[i].data.ptr;
-            rb_funcall(readables, id_push, 1, obj_io);
-        } else if (event_flag & EPOLLOUT) {
-            obj_io = (VALUE) events[i].data.ptr;
-            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("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");
-}
+#if HAVELIBURING_H
+    rb_define_method(Scheduler, "io_read", method_scheduler_io_read, 4);
+    rb_define_method(Scheduler, "io_write", method_scheduler_io_read, 4);
+#endif
+}
+
+#if HAVE_LIBURING_H
+    #include "uring.h"
+#elif HAVE_SYS_EPOLL_H
+    #include "epoll.h"
+#elif HAVE_SYS_EVENT_H
+    #include "kqueue.h"
+#elif HAVE_WINDOWS_H
+    #include "select.h"
+    // #include "iocp.h"
 #else
-// Fallback to IO.select
-VALUE method_scheduler_init(VALUE self) {
-    return Qnil;
-}
-
-VALUE method_scheduler_register(VALUE self, VALUE io, VALUE interest) {
-    return Qnil;
-}
-
-VALUE method_scheduler_deregister(VALUE self, VALUE io) {
-    return Qnil;
-}
-
-VALUE method_scheduler_wait(VALUE self) {
-    // return IO.select(@readable.keys, @writable.keys, [], next_timeout)
-    VALUE readable, writable, readable_keys, writable_keys, next_timeout;
-    ID id_select = rb_intern("select");
-    ID id_keys = rb_intern("keys");
-    ID id_next_timeout = rb_intern("next_timeout");
-
-    readable = rb_iv_get(self, "@readable");
-    writable = rb_iv_get(self, "@writable");
-
-    readable_keys = rb_funcall(readable, id_keys, 0);
-    writable_keys = rb_funcall(writable, id_keys, 0);
-    next_timeout = rb_funcall(self, id_next_timeout, 0);
-
-    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
+    #include "select.h"
+#endif
+#endif