evt-diagnostics-sample 0.0.0.1 → 0.1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a786541d5b410f511239dc0b4bffae31a291e6acda5e29820f1341e07ef4bc16
-  data.tar.gz: c79e144b6eb931a8f2fb17d3511c2f16ea96c813a084816ba62bec22c2f96528
+  metadata.gz: b6d0f5e4778b4584977955ca08b46df3df2278447dc87eeb9155a27a7d87f79d
+  data.tar.gz: cbc2304f16628b0e17520f0c73252c76cc733fbbb3357be4b9bbbd19e8af8aba
 SHA512:
-  metadata.gz: 7b23eb759ad7564f324b35b36b1193356742b4fadf7da3a27bb75045e71756d746944cdf40ce6048eed168d4d0588877e6e11f7cd64e33edff3051a9fd8fd3f7
-  data.tar.gz: bf16c81eb241c74363141bd938bd88c25d021f325247f786ddc7a53d75c7193321d8de6df9c30ffce4c55cff9349f807f9df23335031d82495e8b3cbf749da63
+  metadata.gz: fae5a8f6b0578d2c28f3fe7a68e0036b4acc23a410dca001296f0e275a08595b034f95f83471175bcbceb82cc7a807686c8b44c5a675db773c878282d2987f63
+  data.tar.gz: 6d9c12df6b21dccb70534c67116201cab94e0eb1484d320e0763a88390a522eeec46795ab315cb3854474e5361a7e601ae1aeb40e1f9b12d3e1fe8073757c2b8

data/lib/diagnostics/sample.rb

@@ -1,4 +1,15 @@
+require 'bigdecimal'
+
+require 'clock'
+require 'configure'
+require 'dependency'
 require 'log'
+require 'schema'
 
+require 'diagnostics/sample/defaults'
 require 'diagnostics/sample/log'
+require 'diagnostics/sample/measure'
+require 'diagnostics/sample/measure/clock'
+require 'diagnostics/sample/result'
+
 require 'diagnostics/sample/sample'

data/lib/diagnostics/sample/controls.rb

@@ -0,0 +1,4 @@
+require 'clock/controls'
+
+require 'diagnostics/sample/controls/clock'
+require 'diagnostics/sample/controls/time'

data/lib/diagnostics/sample/controls/clock.rb

@@ -0,0 +1,58 @@
+module Diagnostics
+  class Sample
+    module Controls
+      module Clock
+        def self.example(**args)
+          Incrementing.example(**args)
+        end
+
+        class Incrementing
+          def elapsed_seconds
+            @elapsed_seconds ||= 0
+          end
+          attr_writer :elapsed_seconds
+
+          initializer :start_time, :interval_nanoseconds
+
+          def self.build(interval: nil, start_time: nil)
+            interval ||= Defaults.interval_seconds
+            start_time ||= Defaults.start_time
+
+            interval_nanoseconds = interval * 1_000_000
+
+            new(start_time, interval_nanoseconds)
+          end
+
+          def self.example(**args)
+            build(**args)
+          end
+
+          def next
+            offset = elapsed_seconds
+
+            self.elapsed_seconds += interval_nanoseconds
+
+            start_time_nanoseconds + offset
+          end
+
+          def start_time_nanoseconds
+            start_time.to_i * 1_000_000
+          end
+
+          alias_method :now, :next
+
+          module Defaults
+            def self.interval_seconds
+              1
+            end
+
+            def self.start_time
+              Time.example
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/controls/time.rb

@@ -0,0 +1,7 @@
+module Diagnostics
+  class Sample
+    module Controls
+      Time = ::Clock::Controls::Time
+    end
+  end
+end

data/lib/diagnostics/sample/defaults.rb

@@ -0,0 +1,17 @@
+module Diagnostics
+  class Sample
+    module Defaults
+      def self.gc
+        false
+      end
+
+      def self.cycles
+        1
+      end
+
+      def self.warmup_cycles
+        0
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/log.rb

@@ -1,5 +1,5 @@
 module Diagnostics
-  module Sample
+  class Sample
     class Log < ::Log
       def tag!(tags)
         tags << :diagnostics_sample

data/lib/diagnostics/sample/measure.rb

@@ -0,0 +1,64 @@
+module Diagnostics
+  class Sample
+    class Measure
+      include Log::Dependency
+      extend Configure::Macro
+
+      configure :measure
+
+      dependency :clock, Clock
+
+      attr_writer :gc
+      def gc
+        @gc ||= Defaults.gc
+      end
+
+      initializer :action
+
+      def configure(gc: nil)
+        self.gc = gc unless gc.nil?
+
+        Clock.configure(self)
+      end
+
+      def self.build(gc: nil, action: nil, &block_action)
+        action ||= block_action
+
+        instance = new(action)
+        instance.configure(gc: gc)
+        instance
+      end
+
+      def self.call(gc: nil, action: nil, &block_action)
+        instance = build(gc: gc, action: action, &block_action)
+        instance.()
+      end
+
+      def call
+        logger.trace { "Measuring action (GC: #{gc.inspect})" }
+
+        ::GC.disable unless gc
+
+        start_time = clock.now
+
+        action.()
+
+        end_time = clock.now
+
+        ::GC.enable unless gc
+
+        elapsed_time = end_time - start_time
+
+        logger.trace { "Action measured (GC: #{gc.inspect}, Elapsed Time: #{LogText.elapsed_time_milliseconds(elapsed_time)})" }
+
+        elapsed_time
+      end
+
+      module LogText
+        def self.elapsed_time_milliseconds(elapsed_time_nanoseconds)
+          "%fms" % Rational(elapsed_time_nanoseconds, 1_000_000)
+        end
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/measure/clock.rb

@@ -0,0 +1,22 @@
+module Diagnostics
+  class Sample
+    class Measure
+      class Clock
+        extend ::Configure::Macro
+
+        self.default_factory_method = :new
+
+        configure :clock
+
+        def now
+          Process.clock_gettime(
+            Process::CLOCK_MONOTONIC,
+            :nanosecond
+          )
+        end
+
+        Substitute = ::Clock::UTC::Substitute
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/result.rb

@@ -0,0 +1,40 @@
+module Diagnostics
+  class Sample
+    class Result
+      include Schema::DataStructure
+
+      attribute :cycles, Integer, default: 0
+      attribute :cycle_time_milliseconds, Float, default: 0.0
+      attribute :warmup_cycles, Integer, default: 0
+      attribute :warmup_cycle_time_milliseconds, Float, default: 0.0
+
+      def cycle(elapsed_time)
+        self.cycle_time_milliseconds += elapsed_time
+
+        self.cycles += 1
+      end
+
+      def warmup_cycle(elapsed_time)
+        self.warmup_cycle_time_milliseconds += elapsed_time
+
+        self.warmup_cycles += 1
+      end
+
+      def mean_cycle_time_milliseconds
+        cycle_time_milliseconds / cycles
+      end
+
+      def mean_warmup_cycle_time_milliseconds
+        warmup_cycle_time_milliseconds / warmup_cycles
+      end
+
+      def cycle_frequency
+        cycles / (cycle_time_milliseconds / 1_000)
+      end
+
+      def warmup_cycle_frequency
+        warmup_cycles / (warmup_cycle_time_milliseconds / 1_000)
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/sample.rb

@@ -0,0 +1,64 @@
+module Diagnostics
+  class Sample
+    include Log::Dependency
+
+    dependency :measure, Measure
+
+    def configure(action: nil, gc: nil)
+      Measure.configure(self, action: action, gc: gc)
+    end
+
+    attr_writer :cycles
+    def cycles
+      @cycles ||= Defaults.cycles
+    end
+
+    attr_writer :warmup_cycles
+    def warmup_cycles
+      @warmup_cycles ||= Defaults.warmup_cycles
+    end
+
+    def result
+      @result ||= Result.new
+    end
+
+    def self.build(cycles=nil, warmup_cycles: nil, gc: nil, &action)
+      instance = new
+
+      instance.cycles = cycles unless cycles.nil?
+      instance.warmup_cycles = warmup_cycles unless warmup_cycles.nil?
+
+      instance.configure(action: action, gc: gc)
+      instance
+    end
+
+    def self.call(cycles=nil, warmup_cycles: nil, gc: nil, &action)
+      instance = build(cycles, warmup_cycles: warmup_cycles, gc: gc, &action)
+      instance.()
+    end
+
+    def call
+      logger.trace { "Starting warmup (Warmup Cycles: #{warmup_cycles})" }
+
+      warmup_cycles.times do
+        elapsed_time = measure.()
+
+        result.warmup_cycle(elapsed_time)
+      end
+
+      logger.debug { "Finished warmup (Warmup Cycles: #{warmup_cycles})" }
+
+      logger.trace { "Starting sample (Cycles: #{cycles}, Warmup Cycles: #{warmup_cycles})" }
+
+      cycles.times do
+        elapsed_time = measure.()
+
+        result.cycle(elapsed_time)
+      end
+
+      logger.info { "Finished sample (Cycles: #{cycles}, Warmup Cycles: #{warmup_cycles}, Mean Cycle Time: #{result.mean_cycle_time_milliseconds}ms)" }
+
+      result
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-diagnostics-sample
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1
+  version: 0.1.0.0
 platform: ruby
 authors:
 - The Eventide Project
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evt-log
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-configure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test_bench
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +74,13 @@ extra_rdoc_files: []
 files:
 - lib/diagnostics/sample.rb
 - lib/diagnostics/sample/controls.rb
+- lib/diagnostics/sample/controls/clock.rb
+- lib/diagnostics/sample/controls/time.rb
+- lib/diagnostics/sample/defaults.rb
 - lib/diagnostics/sample/log.rb
+- lib/diagnostics/sample/measure.rb
+- lib/diagnostics/sample/measure/clock.rb
+- lib/diagnostics/sample/result.rb
 - lib/diagnostics/sample/sample.rb
 homepage: https://github.com/eventide-project/diagnostics-sample
 licenses:
@@ -68,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sampling and measurement of execution cycles