evt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cba38d1879267d4e9ffa38598b11e4062a9c93f4c539c451ed480397109fea2
-  data.tar.gz: 33cd316d1ca95d4e28a884a24ded65e87d1d63eb64c098620ab9133e03d2c455
+  metadata.gz: 4c45ef9b7d8ed527d6280ca836777fb2c54822e23c9414c0cdeb234561115f47
+  data.tar.gz: 9543f98474500b00ae1a68009a261db1538d986e71bb7d9437bc9f190aff3c38
 SHA512:
-  metadata.gz: cb6126c17c2087bf8fb906d9f79d00adf844f83e53af6943d70693b97ee46cfadffffccbd97427cf13b4d11bfb3802107b16f35e12ac70d465b274ca7ddb4e77
-  data.tar.gz: ea632137e88bd34eac453a2a3af24a025ea635025d8758657d9704410e37fd01d6286fcb0c625e63423ce30e8a7eff221730955e13e4681731fa7def2eaf4d67
+  metadata.gz: d9fe5b68df1d9e72d10314744ac173bc4f99a3d420034d861b4d1685c1f36bfbe24c993c9686c5862d45926dd8ddb901759d913dfb0ab39d730c380bfa27f3d4
+  data.tar.gz: cfbe9a5c112c71d96a737f29d9b4c5e1fd078b060331d999b7007a846b8e2a71f4de2eeebfc53e22dae8c33bf89afb15df5b36205b17f43f6f7e00096d3950f7

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem
+/lib/*.bundle
+/lib/*.so

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - ruby-head
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dsh0416@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    evt (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  evt!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rake-compiler (~> 1.0)
+
+BUNDLED WITH
+   2.2.0.dev

data/README.md

@@ -1,40 +1,2 @@
-# Evt
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/evt`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'evt'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install evt
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/evt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/evt/blob/master/CODE_OF_CONDUCT.md).
-
-
-## Code of Conduct
-
-Everyone interacting in the Evt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/evt/blob/master/CODE_OF_CONDUCT.md).
+# evt
+A low-level Event Handler designed for Ruby 3 Scheduler

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+spec = Gem::Specification.load('evt.gemspec')
+Rake::ExtensionTask.new('evt_ext', spec) do |ext|
+  ext.ext_dir = "ext/evt"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/evt.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/evt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evt"
+  spec.version       = Evt::VERSION
+  spec.authors       = ["Delton Ding"]
+  spec.email         = ["dsh0416@gmail.com"]
+
+  spec.summary       = "A low-level Event Handler designed for Ruby 3 Scheduler"
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dsh0416/evt"
+
+  # 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)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.extensions = ['ext/evt/extconf.rb']
+
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+end

data/ext/evt/evt.c

@@ -0,0 +1,122 @@
+#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);
+
+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);
+}
+
+
+#if defined(__linux__) // TODO: Do more checks for using epoll
+#include <sys/epoll.h>
+#define EPOLL_MAX_EVENTS 65535
+
+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;
+    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();
+
+    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
+
+    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;
+}
+#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);
+}
+#endif

data/ext/evt/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+extension_name = 'evt_ext'
+create_header
+dir_config(extension_name)
+create_makefile(extension_name)

data/lib/evt.rb

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

data/lib/evt/scheduler.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'fiber'
+require 'socket'
+
+begin
+  require 'io/nonblock'
+rescue LoadError
+  # Ignore.
+end
+
+class IO
+  WAIT_READABLE = 1
+  WAIT_WRITABLE = 3
+end
+
+class Scheduler
+  def initialize
+    @readable = {}
+    @writable = {}
+    @waiting = {}
+    @blocking = []
+
+    @ios = ObjectSpace::WeakMap.new
+    init_selector
+  end
+
+  attr :readable
+  attr :writable
+  attr :waiting
+  attr :blocking
+
+  def next_timeout
+    _fiber, timeout = @waiting.min_by{|key, value| value}
+
+    if timeout
+      offset = timeout - current_time
+
+      if offset < 0
+        return 0
+      else
+        return offset
+      end
+    end
+  end
+
+  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?
+      # puts "writable: #{writable}" if writable&.any?
+
+      readable&.each do |io|
+        @readable[io]&.resume
+      end
+
+      writable&.each do |io|
+        @writable[io]&.resume
+      end
+
+      if @waiting.any?
+        time = current_time
+        waiting = @waiting
+        @waiting = {}
+
+        waiting.each do |fiber, timeout|
+          if timeout <= time
+            fiber.resume
+          else
+            @waiting[fiber] = timeout
+          end
+        end
+      end
+    end
+  end
+
+  def for_fd(fd)
+    @ios[fd] ||= ::IO.for_fd(fd, autoclose: false)
+  end
+
+  def wait_readable(io)
+    @readable[io] = Fiber.current
+    self.register(io, IO::WAIT_READABLE)
+    Fiber.yield
+    @readable.delete(io)
+    self.deregister(io)
+    return true
+  end
+
+  def wait_readable_fd(fd)
+    wait_readable(
+      for_fd(fd)
+    )
+  end
+
+  def wait_writable(io)
+    @writable[io] = Fiber.current
+    self.register(io, IO::WAIT_READABLE)
+    Fiber.yield
+    @writable.delete(io)
+    self.deregister(io)
+    return true
+  end
+
+  def wait_writable_fd(fd)
+    wait_writable(
+      for_fd(fd)
+    )
+  end
+
+  def current_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+
+  def wait_sleep(duration = nil)
+    @waiting[Fiber.current] = current_time + duration
+
+    Fiber.yield
+
+    return true
+  end
+
+  def wait_any(io, events, duration)
+    unless (events & IO::WAIT_READABLE).zero?
+      @readable[io] = Fiber.current
+    end
+
+    unless (events & IO::WAIT_WRITABLE).zero?
+      @writable[io] = Fiber.current
+    end
+
+    self.register(io, events)
+
+    Fiber.yield
+
+    @readable.delete(io)
+    @writable.delete(io)
+    self.deregister(io)
+
+    return true
+  end
+
+
+  def wait_for_single_fd(fd, events, duration)
+    wait_any(
+      for_fd(fd),
+      events,
+      duration
+    )
+  end
+
+  def enter_blocking_region
+    # puts "Enter blocking region: #{caller.first}"
+  end
+
+  def exit_blocking_region
+    # puts "Exit blocking region: #{caller.first}"
+    @blocking << caller.first
+  end
+
+  def fiber(&block)
+    fiber = Fiber.new(blocking: false, &block)
+
+    fiber.resume
+
+    return fiber
+  end
+end

data/lib/evt/version.rb

@@ -0,0 +1,3 @@
+module Evt
+  VERSION = "0.1.1"
+end

metadata

@@ -1,27 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: evt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Delton Ding
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2020-08-17 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A low-level Event Handler designed for Ruby 3 Scheduler for better performance
 email:
 - dsh0416@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/evt/extconf.rb
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- evt.gemspec
+- ext/evt/evt.c
+- ext/evt/extconf.rb
+- lib/evt.rb
+- lib/evt/scheduler.rb
+- lib/evt/version.rb
 homepage: https://github.com/dsh0416/evt
-licenses: []
+licenses:
+- BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/dsh0416/evt
   source_code_uri: https://github.com/dsh0416/evt
@@ -33,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="