async_scheduler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6aa42c918acbc09fc86659737ee084809b5ce364e5052477598e15507531990
+  data.tar.gz: d9227670b7d089727630103dfe6d964663b0c407e5f34ae7e09f3e720937d6df
+SHA512:
+  metadata.gz: '08331e26a7522de45cefedd85543ce2482ae875b2e31f9f270c9cb1c790f412fd988328a460a0e3bc08ec02931506e52eb9b01b90a1163758cc1be2a769408ac'
+  data.tar.gz: 4516d7b4da5b733008a3782216af11fd1d13400e2bb6170abc5ea53f4d8f30104986b08f45b04b73c4be1505c3417192f3cff21182627db4717cc3e57641864f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.1] - 2023-10-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at heyjudejudejude1968@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in async_scheduler.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+# TODO: Remove gems below before releasing!
+gem 'pry'
+gem 'pry-doc'
+gem 'pry-byebug'
+gem 'pry-stack_explorer'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 kudojp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+⚠️ This project is still work in progress, and not published as a gem yet.
+
+# AsyncScheduler
+
+[![CI](https://github.com/kudojp/async_scheduler/actions/workflows/ci.yaml/badge.svg)](https://github.com/kudojp/async_scheduler/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/kudojp/async_scheduler/branch/main/graph/badge.svg?token=1JZU04RYFD)](https://codecov.io/gh/kudojp/async_scheduler)
+[![License](https://img.shields.io/github/license/kudojp/async_scheduler)](./LICENSE)
+
+This is a Fiber Schduler, which is a missing piece to do concurrent programming in Ruby language.  
+If you are not familiar with the concept of Fiber Schduler, please refer to my presentation: [Ruby の FiberScheduler を布教したい](https://speakerdeck.com/kudojp/ruby-false-fiberscheduler-wobu-jiao-sitai). (Sorry in Japanese.)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async_scheduler'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install async_scheduler
+```
+
+## Usage
+
+Set this scheduler in the current thread.
+Then, surround each of blocking oerations in `Fiber.schedule` block so  that they are executed concurrently.
+
+```rb
+Fiber.set_schduler AsyncScheduler::Scheduler.new
+
+Fiber.schedule do
+  File.read("file1.txt") # some blocking operation
+end
+
+Fiber.schedule do
+  File.read("file2.txt") # some blocking operation
+end
+
+puts "Finished"
+```
+
+
+## Development
+
+Add and run spec.
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kudojp/async_scheduler. 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/kudojp/async_scheduler/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AsyncScheduler project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/async_scheduler/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/async_scheduler.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/async_scheduler/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "async_scheduler"
+  spec.version = AsyncScheduler::VERSION
+  spec.authors = ["kudojp"]
+  spec.email = ["heyjudejudejude1968@gmail.com"]
+
+  spec.summary = "Asynchronous task scheduler in Ruby"
+  spec.description = "This is a task scheduler which implements the FiberScheduler interface"
+  spec.homepage = "https://github.com/kudojp/async_scheduler"
+  spec.license = "MIT"
+  # The interface of FiberScheduler#io_read had a breaking change from Ruby 3.0 to 3.1.
+  # - Ruby 3.0: #io_read takes 4 arguments.
+  # - Ruby 3.1: #io_read takes 3 arguments.
+  # The implementation of scheduler#io_read in this gem takes only 3 arguments.
+  spec.required_ruby_version = "~> 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kudojp/async_scheduler"
+  spec.metadata["changelog_uri"] = "https://github.com/kudojp/async_scheduler/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "resolv_fiber", "~>0.1"
+
+  spec.add_development_dependency "simplecov-cobertura"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "async_scheduler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codecov.yaml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 30%
+    patch: false

data/lib/async_scheduler/cross_thread_usage_detector.rb

@@ -0,0 +1,18 @@
+module CrossThreadUsageDetector
+  class BelongingThreadAlreadySetError < StandardError; end
+  class CrossThreadUsageError < StandardError; end
+
+  def set_belonging_thread!
+    if defined? @belonging_thread_object_id
+      raise BelongingThreadAlreadySetError.new("@belonging_thread_object_id is already set with #{@belonging_thread_object_id}, but it is attempted to set again with #{Thread.current.object_id}.")
+    end
+
+    @belonging_thread_object_id = Thread.current.object_id
+  end
+
+  def validate_used_in_original_thread!
+    return if @belonging_thread_object_id == Thread.current.object_id
+
+    raise CrossThreadUsageError.new("Cross-thread usage detected. FiberScheduler was originally registered to a thread (#{@belonging_thread_object_id}), but it is attempted to be used in another thread (#{Thread.current.object_id}).")
+  end
+end

data/lib/async_scheduler/scheduler.rb

@@ -0,0 +1,336 @@
+require 'set'
+require 'resolv_fiber'
+require_relative './cross_thread_usage_detector'
+
+module AsyncScheduler
+  # This class implements Fiber::SchedulerInterface.
+  # See https://ruby-doc.org/core-3.1.0/Fiber/SchedulerInterface.html for details.
+  class Scheduler
+    include CrossThreadUsageDetector
+
+    def initialize
+      set_belonging_thread!
+
+      # (key, value) = (Fiber object, timeout<not nil>)
+      @waitings = {}
+      # (key, value) = (blocking io, Fiber object)
+      @input_waitings = {}
+      @output_waitings = {}
+      # Fibers which are blocking and whose timeouts are not determined.
+      # e.g. Fiber which includes sleep()
+      @blockings = Set.new()
+      # (key, value) = (socket, Hash{:blocked_fiber => <Fiber object>, :timeout => <timeout>})
+      @blocking_sockets = {}
+      # NOTE: When either of the sockets(value) is ready, the fiber(key) can be resumed.
+      @fiber_to_all_blocker_sockets = Hash.new{|h, fiber| h[fiber] = Set.new}
+    end
+
+    # Implementation of the Fiber.schedule.
+    # The method is expected to immediately run the given block of code in a separate non-blocking fiber,
+    # and to return that Fiber.
+    def fiber(&block)
+      validate_used_in_original_thread!
+
+      fiber = Fiber.new(blocking: false, &block)
+      fiber.resume
+      fiber
+    end
+
+    # Invoked by methods like Thread.join, and by Mutex, to signify that current Fiber is blocked until further notice (e.g. unblock) or until timeout has elapsed.
+    # blocker is what we are waiting on, informational only (for debugging and logging). There are no guarantee about its value.
+    # Expected to return boolean, specifying whether the blocking operation was successful or not.
+    def block(blocker, timeout = nil)
+      validate_used_in_original_thread!
+
+      # TODO: Make use of blocker.
+      if timeout
+        @waitings[Fiber.current] = timeout
+      else
+        @blockings << Fiber.current
+      end
+
+      true
+    end
+
+    # Invoked to wake up Fiber previously blocked with block (for example, Mutex#lock calls block and Mutex#unlock calls unblock).
+    # The scheduler should use the fiber parameter to understand which fiber is unblocked.
+    # blocker is what was awaited for, but it is informational only (for debugging and logging),
+    # and it is not guaranteed to be the same value as the blocker for block.
+    def unblock(blocker, fiber)
+      validate_used_in_original_thread!
+
+      # TODO: Make use of blocker.
+      @blockings.delete fiber
+      fiber.resume
+    end
+
+    # Invoked by Kernel#sleep and Mutex#sleep and is expected to provide an implementation of sleeping in a non-blocking way.
+    # Implementation might register the current fiber in some list of “which fiber wait until what moment”,
+    # call Fiber.yield to pass control, and then in close resume the fibers whose wait period has elapsed.
+    def kernel_sleep(duration = nil)
+      validate_used_in_original_thread!
+
+      timeout = duration ? Process.clock_gettime(Process::CLOCK_MONOTONIC) + duration : nil
+      if block(:kernel_sleep, timeout)
+        Fiber.yield
+      else
+        raise RuntimeError.new("Failed to sleep")
+      end
+    end
+
+    # Invoked by Timeout.timeout to execute the given block within the given duration.
+    # It can also be invoked directly by the scheduler or user code.
+    #
+    # This implementation will only interrupt non-blocking operations.
+    # If the block is executed successfully, its result will be returned.
+    def timeout_after(duration, exception_class, *exception_arguments, &block) # → result of block
+      validate_used_in_original_thread!
+
+      current_fiber = Fiber.current
+
+      if duration
+        self.fiber() do
+          sleep(duration)
+          if current_fiber.alive?
+            current_fiber.raise(exception_class, *exception_arguments)
+          end
+        end
+      end
+
+      yield duration
+    end
+
+    # Called when the current thread exits. The scheduler is expected to implement this method in order to allow all waiting fibers to finalize their execution.
+    # The suggested pattern is to implement the main event loop in the close method.
+    def close
+      validate_used_in_original_thread!
+
+      while !@waitings.empty? || !@blockings.empty? || !@input_waitings.empty? || !@output_waitings.empty? || !@blocking_sockets.empty?
+        # For blocking I/Os...
+        while !@input_waitings.empty? || !@output_waitings.empty? || !@blocking_sockets.empty?
+          soonest_timeout_ = self.soonest_timeout
+          select_duration =
+            if soonest_timeout_.nil?
+              nil
+            else
+              duration = soonest_timeout_ - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              # duration here should be very close to 0 even if it is negative.
+              [duration, 0].max
+            end
+
+          # NOTE: IO.select will keep blocking until timeout even if any new event is added to @waitings.
+          # TODO: Don't wait for the input  ready when the corresponding fiber gets terminated, and when it is the only one in @input_waitings.
+          # TODO: Don't wait for the output ready when the corresponding fiber gets terminated, and when it is the only one in @output_waitings.
+          inputs_ready, outputs_ready = IO.select(
+            @input_waitings.keys + @blocking_sockets.keys,
+            @output_waitings.keys,
+            [],
+            select_duration
+          )
+
+          inputs_ready&.each do |input|
+            if @input_waitings[input]
+              fiber_non_blocking = @input_waitings.delete(input)
+              fiber_non_blocking.resume if fiber_non_blocking.alive?
+            elsif @blocking_sockets[input]
+              fiber = @blocking_sockets.delete(input).fetch(:blocked_fiber)
+              # ref. comment in #address_resolve
+              @fiber_to_all_blocker_sockets.fetch(fiber).each do |socket|
+                @blocking_sockets.delete(socket)
+              end
+              fiber.resume
+            else
+              raise
+            end
+          end
+
+          current_clock_monotonic_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+          timeout_sockets = @blocking_sockets.select{|socket, blocked| blocked.fetch(:timeout) && (blocked.fetch(:timeout) <= current_clock_monotonic_time)}.keys
+          # NOTE: timeout_sockets is nil when there is no rejected element.
+          @blocking_sockets.reject!{|socket| timeout_sockets&.include? socket}
+          timeout_sockets&.each do |socket|
+            @fiber_to_all_blocker_sockets.fetch(fiber).delete(socket)
+            fiber.resume if @fiber_to_all_blocker_sockets.fetch(fiber).empty? && fiber.alive?
+          end
+
+          outputs_ready&.each do |output|
+            fiber_non_blocking = @output_waitings.delete(output)
+            fiber_non_blocking.resume if fiber_non_blocking.alive?
+          end
+        end
+
+        unless @waitings.empty?
+          # TODO: Use a min heap for @waitings
+          resumable_fibers = @waitings.select{|_fiber, timeout| timeout <= Process.clock_gettime(Process::CLOCK_MONOTONIC)}
+                                      .map{|fiber, _timeout| fiber}
+                                      .to_set
+          resumable_fibers.each{|fiber| fiber.resume if fiber.alive?}
+          @waitings.reject!{|fiber, _timeout| resumable_fibers.include? fiber}
+        end
+
+        # Unfortunately, current scheduler is unfair to @blockings. Even if any of @blockings is ready, current scheduler has no way to notice it.
+        @blockings.select!{|fiber| fiber.alive?}
+      end
+    end
+
+    def soonest_timeout
+      waitings_earliest_timeout = @waitings.empty? ? nil : @waitings.min_by{|fiber, timeout| timeout}[1]
+      blocking_socket_earliest_timeout = @blocking_sockets.select{|_socket, blocked| blocked.fetch(:timeout)}.values.min_by{|blocked| blocked.fetch(:timeout)}[0]&.fetch(:timeout)
+
+      if waitings_earliest_timeout && blocking_socket_earliest_timeout
+        return [waitings_earliest_timeout, blocking_socket_earliest_timeout].min
+      end
+
+      waitings_earliest_timeout || blocking_socket_earliest_timeout
+    end
+    private_methods :soonest_timeout
+
+    # Invoked by IO#wait, IO#wait_readable, IO#wait_writable to ask whether the specified descriptor is ready for specified events within the specified timeout.
+    # events is a bit mask of IO::READABLE, IO::WRITABLE, and IO::PRIORITY.
+
+    # Suggested implementation should register which Fiber is waiting for which resources and immediately calling Fiber.yield to pass control to other fibers.
+    # Then, in the close method, the scheduler might dispatch all the I/O resources to fibers waiting for it.
+    # Expected to return the subset of events that are ready immediately.
+    def io_wait(io, events, _timeout)
+      validate_used_in_original_thread!
+
+      # TODO: use timeout parameter
+      # TODO?: Expected to return the subset of events that are ready immediately.
+
+      if events & IO::READABLE == IO::READABLE
+        @input_waitings[io] = Fiber.current
+      end
+
+      if events & IO::WRITABLE == IO::WRITABLE
+        @output_waitings[io] = Fiber.current
+      end
+
+      Fiber.yield
+    end
+
+    # Invoked by IO#read to read length bytes from io into a specified buffer (see IO::Buffer).
+    # The length argument is the “minimum length to be read”. If the IO buffer size is 8KiB, but the length is 1024 (1KiB), up to 8KiB might be read, but at least 1KiB will be.
+    # Generally, the only case where less data than length will be read is if there is an error reading the data.
+    # Specifying a length of 0 is valid and means try reading at least once and return any available data.
+
+    # Suggested implementation should try to read from io in a non-blocking manner and call io_wait if the io is not ready (which will yield control to other fibers).
+    # See IO::Buffer for an interface available to return data.
+    # Expected to return number of bytes read, or, in case of an error, -errno (negated number corresponding to system's error code).
+    def io_read(io, buffer, length) # return length or -errno
+      validate_used_in_original_thread!
+
+      read_string = ""
+      offset = 0
+      while offset < length || length == 0
+        read_nonblock = Fiber.new(blocking: true) do
+          # AsyncScheduler::Scheduler#io_read is hooked to IO#read_nonblock.
+          # To avoid an infinite call loop, IO#read_nonblock is called inside a Fiber whose blocking=true.
+          # ref. https://docs.ruby-lang.org/ja/latest/method/IO/i/read_nonblock.html
+          io.read_nonblock(buffer.size-offset, read_string, exception: false)
+        end
+
+        begin
+          # This fiber is resumed only here.
+          result = read_nonblock.resume
+        rescue SystemCallError => e
+          return -e.errno
+        end
+
+        case result
+        when :wait_readable
+          io_wait(io, IO::READABLE, nil)
+        when nil # when reaching EOF
+          # TODO: Investigate if it is expected to break here.
+          break
+        else
+          offset += buffer.set_string(read_string, offset) # this does not work with `#set_string(result)`
+          break if length == 0
+        end
+      end
+      return offset
+    end
+
+    # Invoked by IO#write to write length bytes to io from from a specified buffer (see IO::Buffer).
+    # The length argument is the “(minimum) length to be written”.
+    # If the IO buffer size is 8KiB, but the length specified is 1024 (1KiB), at most 8KiB will be written, but at least 1KiB will be.
+    # Generally, the only case where less data than length will be written is if there is an error writing the data.
+
+    # Specifying a length of 0 is valid and means try writing at least once, as much data as possible.
+    # Suggested implementation should try to write to io in a non-blocking manner and call io_wait if the io is not ready (which will yield control to other fibers).
+    # See IO::Buffer for an interface available to get data from buffer efficiently.
+    # Expected to return number of bytes written, or, in case of an error, -errno (negated number corresponding to system's error code).
+    def io_write(io, buffer, length) # returns: written length or -errnoclick to toggle source
+      validate_used_in_original_thread!
+
+      offset = 0
+
+      while offset < length || length == 0
+        write_nonblock = Fiber.new(blocking: true) do
+          # TODO: Investigate if this #write_nonblock method call should be in a non-blocking fiber.
+          # IO#read_nonblock is hooked to Scheduler#io_wait, so it has to be wrapped.
+          # If IO#read_nonblock is hooked to Scheduler#io_read, this method call has to be wrapped too.
+          # ref. https://docs.ruby-lang.org/ja/latest/class/IO.html#I_WRITE_NONBLOCK
+          io.write_nonblock(buffer.get_string(offset), exception: false)
+        end
+
+        begin
+          result = write_nonblock.resume
+        rescue SystemCallError => e
+          return -e.errno
+        end
+
+        case result
+        when :wait_writable
+          io_wait(io, IO::WRITABLE, nil)
+        else
+          offset += result
+          break if length == 0 # Specification says it tries writing at least once if length == 0
+        end
+      end
+      return offset
+    end
+
+    # Invoked by any method that performs a non-reverse DNS lookup. (e.g. Addrinfo.getaddrinfo)
+    # The method is expected to return an array of strings corresponding to ip addresses the hostname is resolved to, or nil if it can not be resolved.
+    def address_resolve(hostname)
+      # NOTE:
+      # Asynchronous DNS lookup is slower than sequential DNS lookup in a single thread in my experiment.
+      # Remove #address_resolve when this scheduler is used in a performance critical application.
+      # Run $ `bundle exec rspec spec/blockings/address_resolve_spec.rb` to confirm it.
+
+      validate_used_in_original_thread!
+      fiber = ::ResolvFiber.getaddresses_fiber(hostname)
+      # Fiber.yield inside of this fiber is located in the loop and may be called multiple times.
+      # So here in the caller, the fiber has to be resumed multiple times till the fiber becomes terminated.
+      loop do
+        result = fiber.resume
+        return result unless fiber.alive?
+
+        socks, timeout = result
+        # In my experiment, socks here are:
+        # - socket to connect to the DNS server which has IPv4 address
+        # - socket to connect to the DNS server which has IPv6 address
+        # When either of these is ready, DNS resolution is done.
+        socks.each do |sock|
+          # Fiber.current is blocked by multiple sockets in this way:
+          #    @blocking_sockets = {
+          #       first_socket:  { blocked_fiber: Fiber.current, timeout: 1111 },
+          #       second_socket: { blocked_fiber: Fiber.current, timeout: 1111 },
+          #    }
+          # If first_socket is ready, both of `first_socket` and `second_socket` must be removed from @blocking_sockets before the fiber gets resumed.
+          # (@fiber_to_all_blocker_sockets is used to realize this.)
+          # Otherwise, when second_socket is ready, `Fiber.current` will be resumed again unexpectedly.
+          # Same thing can be said if second_socket is ready first.
+          @blocking_sockets[sock] = {
+            blocked_fiber: Fiber.current,
+            timeout: timeout,
+          }
+          @fiber_to_all_blocker_sockets[Fiber.current] << sock
+        end
+
+        Fiber.yield
+      end
+    end
+  end
+end

data/lib/async_scheduler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AsyncScheduler
+  VERSION = "0.1.1"
+end

data/lib/async_scheduler.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "async_scheduler/version"
+require_relative "async_scheduler/scheduler"
+
+module AsyncScheduler
+end

data/sig/async_std_scheduler.rbs

@@ -0,0 +1,4 @@
+module AsyncScheduler
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: async_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- kudojp
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resolv_fiber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a task scheduler which implements the FiberScheduler interface
+email:
+- heyjudejudejude1968@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- async_scheduler.gemspec
+- bin/console
+- bin/setup
+- codecov.yaml
+- lib/async_scheduler.rb
+- lib/async_scheduler/cross_thread_usage_detector.rb
+- lib/async_scheduler/scheduler.rb
+- lib/async_scheduler/version.rb
+- sig/async_std_scheduler.rbs
+homepage: https://github.com/kudojp/async_scheduler
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kudojp/async_scheduler
+  source_code_uri: https://github.com/kudojp/async_scheduler
+  changelog_uri: https://github.com/kudojp/async_scheduler/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Asynchronous task scheduler in Ruby
+test_files: []