benchmark_driver 0.8.6 → 0.9.0

data/lib/benchmark/output/markdown.rb

@@ -1,73 +0,0 @@
-class Benchmark::Output::Markdown
-  # This class requires runner to measure following fields in `Benchmark::Driver::BenchmarkResult` to show output.
-  REQUIRED_FIELDS = [:real]
-
-  # @param [Array<Benchmark::Driver::Configuration::Job>] jobs
-  # @param [Array<Benchmark::Driver::Configuration::Executable>] executables
-  # @param [Benchmark::Driver::Configuration::OutputOptions] options
-  def initialize(jobs:, executables:, options:)
-    @jobs = jobs
-    @executables = executables
-    @options = options
-    @name_length = jobs.map { |j| j.name.size }.max
-  end
-
-  def start_warming
-    $stdout.print 'warming up...'
-  end
-
-  # @param [String] name
-  def warming(name)
-    # noop
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def warmup_stats(result)
-    $stdout.print '.'
-  end
-
-  def start_running
-    $stdout.puts if @jobs.any?(&:warmup_needed?)
-
-    $stdout.print("|#{' ' * @name_length}|")
-    @executables.each do |executable|
-      $stdout.print('%-10s |' % executable.name)
-    end
-    $stdout.puts
-
-    $stdout.print("|:#{'-' * (@name_length-1)}|")
-    @executables.each do |executable|
-      $stdout.print(":#{'-' * 10}|")
-    end
-    $stdout.puts
-  end
-
-  # @param [String] name
-  def running(name)
-    $stdout.print("|%-#{@name_length}s|" % name)
-    @ran_num = 0
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def benchmark_stats(result)
-    if @options.compare
-      if @ran_num == 0
-        @base_real = result.real
-        $stdout.print('%-10.2f |' % 1)
-      else
-        $stdout.print('%-10.2f |' % (@base_real / result.real))
-      end
-    else
-      $stdout.print('%-10.3f |' % result.real)
-    end
-
-    @ran_num += 1
-    if @ran_num == @executables.size
-      $stdout.puts
-    end
-  end
-
-  def finish
-    # compare is done in table
-  end
-end

data/lib/benchmark/output/memory.rb

@@ -1,57 +0,0 @@
-class Benchmark::Output::Memory
-  # This class requires runner to measure following fields in `Benchmark::Driver::BenchmarkResult` to show output.
-  REQUIRED_FIELDS = [:max_rss]
-
-  # @param [Array<Benchmark::Driver::Configuration::Job>] jobs
-  # @param [Array<Benchmark::Driver::Configuration::Executable>] executables
-  # @param [Benchmark::Driver::Configuration::OutputOptions] options
-  def initialize(jobs:, executables:, options:)
-    @jobs = jobs
-    @executables = executables
-    @options = options
-    @name_length = jobs.map { |j| j.name.size }.max
-  end
-
-  def start_warming
-    $stdout.print 'warming up...'
-  end
-
-  # @param [String] name
-  def warming(name)
-    # noop
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def warmup_stats(result)
-    $stdout.print '.'
-  end
-
-  def start_running
-    $stdout.puts if @jobs.any?(&:warmup_needed?)
-    $stdout.puts 'max resident memory (KB):'
-    $stdout.print("%-#{@name_length}s  " % 'ruby')
-    @executables.each do |executable|
-      $stdout.print('%-6s  ' % executable.name)
-    end
-    $stdout.puts
-  end
-
-  # @param [String] name
-  def running(name)
-    $stdout.print("%-#{@name_length}s  " % name)
-    @ran_num = 0
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def benchmark_stats(result)
-    $stdout.print('%-6d  ' % result.max_rss)
-    @ran_num += 1
-    if @ran_num == @executables.size
-      $stdout.puts
-    end
-  end
-
-  def finish
-    # compare is not implemented yet
-  end
-end

data/lib/benchmark/output/time.rb

@@ -1,57 +0,0 @@
-class Benchmark::Output::Time
-  # This class requires runner to measure following fields in `Benchmark::Driver::BenchmarkResult` to show output.
-  REQUIRED_FIELDS = [:real]
-
-  # @param [Array<Benchmark::Driver::Configuration::Job>] jobs
-  # @param [Array<Benchmark::Driver::Configuration::Executable>] executables
-  # @param [Benchmark::Driver::Configuration::OutputOptions] options
-  def initialize(jobs:, executables:, options:)
-    @jobs = jobs
-    @executables = executables
-    @options = options
-    @name_length = jobs.map { |j| j.name.size }.max
-  end
-
-  def start_warming
-    $stdout.print 'warming up...'
-  end
-
-  # @param [String] name
-  def warming(name)
-    # noop
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def warmup_stats(result)
-    $stdout.print '.'
-  end
-
-  def start_running
-    $stdout.puts if @jobs.any?(&:warmup_needed?)
-    $stdout.puts 'benchmark results (s):'
-    $stdout.print("%-#{@name_length}s  " % 'ruby')
-    @executables.each do |executable|
-      $stdout.print('%-6s  ' % executable.name)
-    end
-    $stdout.puts
-  end
-
-  # @param [String] name
-  def running(name)
-    $stdout.print("%-#{@name_length}s  " % name)
-    @ran_num = 0
-  end
-
-  # @param [Benchmark::Driver::BenchmarkResult] result
-  def benchmark_stats(result)
-    $stdout.print('%-6.3f  ' % result.real)
-    @ran_num += 1
-    if @ran_num == @executables.size
-      $stdout.puts
-    end
-  end
-
-  def finish
-    # compare is not implemented yet
-  end
-end

data/lib/benchmark/runner.rb

@@ -1,14 +0,0 @@
-module Benchmark::Runner
-  # Benchmark::Runner is pluggable.
-  # Create `Benchmark::Runner::FooBar` as benchmark-runner-foo_bar.gem and specify `runner: foo_bar`.
-  #
-  # @param [Symbol] name
-  def self.find(name)
-    class_name = Benchmark::Driver::Configuration.camelize(name.to_s)
-    Benchmark::Runner.const_get(class_name, false)
-  end
-end
-
-require 'benchmark/runner/call'
-require 'benchmark/runner/eval'
-require 'benchmark/runner/exec'

data/lib/benchmark/runner/call.rb

@@ -1,97 +0,0 @@
-require 'benchmark/driver/benchmark_result'
-require 'benchmark/driver/duration_runner'
-require 'benchmark/driver/repeatable_runner'
-require 'benchmark/driver/time'
-
-# Run benchmark by calling #call on running ruby.
-#
-# Multiple Ruby binaries: x
-# Memory output: x
-class Benchmark::Runner::Call
-  # This class can provide fields in `Benchmark::Driver::BenchmarkResult` if required by output plugins.
-  SUPPORTED_FIELDS = [:real]
-
-  WARMUP_DURATION    = 2
-  BENCHMARK_DURATION = 5
-
-  # @param [Benchmark::Driver::Configuration::RunnerOptions] options
-  # @param [Benchmark::Output::*] output - Object that responds to methods used in this class
-  def initialize(options, output:)
-    @options = options
-    @output  = output
-  end
-
-  # @param [Benchmark::Driver::Configuration] config
-  def run(config)
-    validate_config(config)
-
-    if config.jobs.any?(&:warmup_needed?)
-      run_warmup(config.jobs)
-    end
-
-    @output.start_running
-
-    config.jobs.each do |job|
-      @output.running(job.name)
-
-      result = Benchmark::Driver::RepeatableRunner.new(job).run(
-        runner: method(:call_times),
-        repeat_count: @options.repeat_count,
-      )
-
-      @output.benchmark_stats(result)
-    end
-
-    @output.finish
-  end
-
-  private
-
-  def validate_config(config)
-    if config.runner_options.executables_specified?
-      raise ArgumentError.new("Benchmark::Runner::Call can't run other Ruby executables")
-    end
-
-    config.jobs.each do |job|
-      unless job.script.respond_to?(:call)
-        raise NotImplementedError.new(
-          "#{self.class.name} only accepts objects that respond to :call, but got #{job.script.inspect}"
-        )
-      end
-    end
-  end
-
-  # @param [Array<Benchmark::Driver::Configuration::Job>] jobs
-  # @return [Hash{ Benchmark::Driver::Configuration::Job => Integer }] iters_by_job
-  def run_warmup(jobs)
-    @output.start_warming
-
-    jobs.each do |job|
-      next if job.loop_count
-      @output.warming(job.name)
-
-      result = Benchmark::Driver::DurationRunner.new(job).run(
-        seconds:    WARMUP_DURATION,
-        unit_iters: 1,
-        runner:     method(:call_times),
-      )
-      job.guessed_count = (result.ips.to_f * BENCHMARK_DURATION).to_i
-
-      @output.warmup_stats(result)
-    end
-  end
-
-  def call_times(job, times)
-    script = job.script
-    i = 0
-
-    before = Benchmark::Driver::Time.now
-    while i < times
-      script.call
-      i += 1
-    end
-    after = Benchmark::Driver::Time.now
-
-    after.to_f - before.to_f
-  end
-end

data/lib/benchmark/runner/eval.rb

@@ -1,147 +0,0 @@
-require 'benchmark/driver/benchmark_result'
-require 'benchmark/driver/duration_runner'
-require 'benchmark/driver/repeatable_runner'
-require 'benchmark/driver/time'
-
-# Run benchmark by calling compiled script on running ruby.
-#
-# Multiple Ruby binaries: x
-# Memory output: x
-class Benchmark::Runner::Eval
-  # This class can provide fields in `Benchmark::Driver::BenchmarkResult` if required by output plugins.
-  SUPPORTED_FIELDS = [:real]
-
-  WARMUP_DURATION    = 2
-  BENCHMARK_DURATION = 5
-  GUESS_TIMES = [1, 1_000, 1_000_000, 10_000_000, 100_000_000]
-  GUESS_THRESHOLD = 0.4 # 400ms
-
-  # @param [Benchmark::Driver::Configuration::RunnerOptions] options
-  # @param [Benchmark::Output::*] output - Object that responds to methods used in this class
-  def initialize(options, output:)
-    @options = options
-    @output  = output
-  end
-
-  # @param [Benchmark::Driver::Configuration] config
-  def run(config)
-    validate_config(config)
-
-    if config.jobs.any?(&:warmup_needed?)
-      run_warmup(config.jobs)
-    end
-
-    @output.start_running
-
-    config.jobs.each do |job|
-      @output.running(job.name)
-
-      result = Benchmark::Driver::RepeatableRunner.new(job).run(
-        runner: method(:eval_times),
-        repeat_count: @options.repeat_count,
-      )
-
-      @output.benchmark_stats(result)
-    end
-
-    @output.finish
-  end
-
-  private
-
-  def validate_config(config)
-    if config.runner_options.executables_specified?
-      raise ArgumentError.new("#{self.class.name} can't run other Ruby executables")
-    end
-
-    config.jobs.each do |job|
-      unless job.script.is_a?(String)
-        raise NotImplementedError.new(
-          "#{self.class.name} only accepts String, but got #{job.script.inspect}"
-        )
-      end
-    end
-  end
-
-  # @param [Array<Benchmark::Driver::Configuration::Job>] jobs
-  # @return [Hash{ Benchmark::Driver::Configuration::Job => Integer }] iters_by_job
-  def run_warmup(jobs)
-    @output.start_warming
-
-    jobs.each do |job|
-      next if job.loop_count
-      @output.warming(job.name)
-
-      result = Benchmark::Driver::DurationRunner.new(job).run(
-        seconds:    WARMUP_DURATION,
-        unit_iters: guess_ip100ms(job),
-        runner:     method(:eval_times),
-      )
-      job.guessed_count = (result.ips.to_f * BENCHMARK_DURATION).to_i
-
-      @output.warmup_stats(result)
-    end
-  end
-
-  # @param [Benchmark::Driver::Configuration::Job] job
-  def guess_ip100ms(job)
-    ip100ms = 0
-    GUESS_TIMES.each do |times|
-      seconds = eval_times(job, times)
-      ip100ms = (times.to_f / (seconds * 10.0)).ceil # ceil for times=1
-      if GUESS_THRESHOLD < seconds
-        return ip100ms
-      end
-    end
-    if ip100ms < 0
-      raise Benchmark::Driver::ExecutionTimeTooShort.new(job, GUESS_TIMES.last)
-    end
-    ip100ms
-  end
-
-  def eval_times(job, times)
-    benchmark = BenchmarkScript.new(job.prelude, job.script)
-    overhead = benchmark.overhead(times)
-    full_script = benchmark.full_script(times)
-
-    before = Benchmark::Driver::Time.now
-    eval(overhead, TOPLEVEL_BINDING)
-    after = Benchmark::Driver::Time.now
-    overhead_duration = after.to_f - before.to_f
-
-    before = Benchmark::Driver::Time.now
-    eval(full_script, TOPLEVEL_BINDING)
-    after = Benchmark::Driver::Time.now
-    full_script_duration = after.to_f - before.to_f
-
-    full_script_duration - overhead_duration
-  end
-
-  class BenchmarkScript < Struct.new(:prelude, :script)
-    BATCH_SIZE = 1000
-
-    def overhead(times)
-      raise ArgumentError.new("Negative times: #{times}") if times < 0
-      <<-RUBY
-#{prelude}
-__benchmark_driver_i = 0
-while __benchmark_driver_i < #{times / BATCH_SIZE}
-  __benchmark_driver_i += 1
-end
-      RUBY
-    end
-
-    def full_script(times)
-      raise ArgumentError.new("Negative times: #{times}") if times < 0
-      <<-RUBY
-#{prelude}
-__benchmark_driver_i = 0
-while __benchmark_driver_i < #{times / BATCH_SIZE}
-  __benchmark_driver_i += 1
-  #{"#{script};" * BATCH_SIZE}
-end
-#{"#{script};" * (times % BATCH_SIZE)}
-      RUBY
-    end
-  end
-end