actuator 0.0.1

data/lib/actuator/mutex/replace.rb

@@ -0,0 +1,8 @@
+require_relative '../mutex'
+
+old_verbose, $VERBOSE = $VERBOSE, nil
+
+Mutex = Actuator::Mutex
+ConditionVariable = Actuator::ConditionVariable
+
+$VERBOSE = old_verbose

data/test/setup_test.rb

@@ -0,0 +1,63 @@
+require 'minitest'
+require 'minitest/autorun'
+
+#require_relative '../lib/actuator'
+gem 'actuator'
+require 'actuator'
+
+module Minitest
+  class << self
+    alias_method :run_without_actuator, :run
+
+    def run(args=[])
+      result = nil
+      Actuator.run do
+        Actuator.defer do
+          begin
+            result = run_without_actuator(args)
+          rescue => ex
+            Kernel.puts "#{ex.class}: #{ex.message}\n#{ex.backtrace.join "\n"}"
+            raise ex
+          end
+          Actuator.next_tick  { Actuator.stop }
+        end
+      end
+      result
+    end
+  end
+end
+
+module Actuator
+  class Test < Minitest::Test
+    @@_assert_queue = Queue.new
+    @@assert_thread = nil
+
+    # Defer to a thread so that we can sleep reliably without the reactor
+    def assert_async
+      fiber = Fiber.current
+      assert_threaded do
+        begin
+          yield
+        rescue => ex
+          Actuator.next_tick { fiber.resume(ex) }
+        else
+          Actuator.next_tick { fiber.resume }
+        end
+      end
+      result = Fiber.yield
+      raise result if result.is_a? Exception
+    end
+
+    # Reuse a single thread to reduce the variance of start delay
+    def assert_threaded(&block)
+      if @@assert_thread
+        @@_assert_queue << block
+      else
+        @@_assert_queue << block
+        @@assert_thread = Thread.new do
+          @@_assert_queue.pop.() while true
+        end
+      end
+    end
+  end
+end

data/test/test_actuator.rb

@@ -0,0 +1,90 @@
+require_relative "setup_test"
+
+module Actuator
+  class TestActuator < Test
+    PrecisionTestDuration = 10.0
+    PrecisionTestInterval = 0.002
+    PrecisionTotalSamples = (PrecisionTestDuration / PrecisionTestInterval).to_i
+
+    def setup
+      # If GC desyncs the assert thread too much it will cause false positives
+      GC.start full_mark: true, immediate_sweep: true
+    end
+
+    def test_once_off_timer
+      called = called2 = 0
+      timer = Timer.in(0.1) { called += 1 }
+      timer2 = Timer.in(0.1) { called2 += 1 }
+      assert_async do
+        timer2.destroy
+        assert timer2.destroyed?, 'destroyed? returned false after calling Timer#destroy'
+        Kernel.sleep 0.02
+        assert !timer.destroyed?, 'timer destroyed too early'
+        Kernel.sleep 0.1
+        assert timer.destroyed?, 'timer not destroyed within 20ms'
+        Kernel.sleep 0.1
+        assert called == 1, 'timer callback not called'
+        assert called2 == 0, 'timer callback called after being destroyed'
+      end
+    end
+
+    def test_interval_timer
+      called = called2 = 0
+      timer = Timer.every(0.005) { called += 1 }
+      timer2 = Timer.every(0.005) { called2 += 1; timer2.destroy }
+      assert_async do
+        Kernel.sleep 0.1
+        assert called > 10, "5ms interval timer only fired #{called} times in 100ms"
+        timer.destroy
+        total_called = called
+        Kernel.sleep 0.02
+        assert called == total_called, 'interval timer fired after being destroyed'
+        assert called2 > 0, '5ms interval timer never called'
+        assert called2 == 1, 'Timer#destroy did not work in interval callback'
+      end
+    end
+
+    #TODO: Implement sampling in the C++ extension to eliminate profiling overhead
+    def test_timer_precision
+      fiber = Fiber.current
+      timer = nil
+      lates = Array.new(PrecisionTotalSamples)
+      # Try skip initial warmup slowdowns so that they aren't included in the samples
+      Timer.in(0.5) do
+        attempts = 0
+        i = -1
+        scheduled_at = Actuator.now
+        timer = Timer.every(PrecisionTestInterval) do
+          now = Actuator.now
+          lates[i += 1] = (now - scheduled_at - PrecisionTestInterval) * 1_000_000
+          scheduled_at = Actuator.now
+          next if i < PrecisionTotalSamples - 1
+          lates.sort!
+          below_1000_count = 0
+          sum = 0.0; lates.each {|late| below_1000_count += 1 if late < 1000; sum += late }
+          mean = sum / lates.size
+          median = lates.size % 2 == 0 ? (lates[lates.size/2] + lates[lates.size/2-1]) / 2.0 : lates[(lates.size-1)/2]
+          sum = 0.0; lates.each {|late| sum += (late - mean) ** 2 }
+          std_deviation = Math.sqrt(sum / (lates.size - 1).to_f)
+          Log.puts "[Timer Precision] Total: #{lates.size}, Over 1ms: #{lates.size - below_1000_count}, Low: #{lates.first.round(1)} us, High: #{lates.last.round(1)} us, Median: #{median.round(1)} us, Variance: #{std_deviation.round(1)} us"
+          begin
+            # Most hardware will provide good precision but this should be able to pass on a Raspberry Pi v1 or a VM
+            assert lates.last < 10000, "a timer was over 10 ms late (#{lates.last.round(2)} us)"
+            assert median < 200, "average timer precision is worse than 200 us (#{median.round(2)} us)"
+            assert std_deviation < 500, "too much jitter, variance is over 500 us (#{std_deviation.round(2)} us)"
+          rescue Minitest::Assertion => ex
+            Log.puts "Retrying due to bad precision most likely caused by loaded hardware: #{ex.message}"
+            attempts += 1
+            raise if attempts > 9
+            i = -1
+            scheduled_at = Actuator.now
+            next
+          end
+          timer.destroy
+          fiber.resume
+        end
+      end
+      Fiber.yield
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: actuator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bawNg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: ''
+email:
+- bawng@intoxicated.co.za
+executables: []
+extensions:
+- ext/actuator/extconf.rb
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- ".autotest"
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- ext/actuator/actuator.c
+- ext/actuator/actuator.h
+- ext/actuator/clock.c
+- ext/actuator/clock.h
+- ext/actuator/debug.c
+- ext/actuator/debug.h
+- ext/actuator/extconf.rb
+- ext/actuator/log.cpp
+- ext/actuator/log.h
+- ext/actuator/reactor.cpp
+- ext/actuator/reactor.h
+- ext/actuator/ruby_helpers.c
+- ext/actuator/ruby_helpers.h
+- ext/actuator/timer.cpp
+- ext/actuator/timer.h
+- lib/actuator.rb
+- lib/actuator/fiber.rb
+- lib/actuator/fiber_pool.rb
+- lib/actuator/job.rb
+- lib/actuator/mutex.rb
+- lib/actuator/mutex/replace.rb
+- test/setup_test.rb
+- test/test_actuator.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []