benchmark-interface 0.1

data/lib/benchmark-interface/benchmark-set.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  class BenchmarkSet
+
+    attr_reader :iterations
+
+    def initialize
+      @benchmarks = []
+      @counter = 0
+      @@current = self
+      @iterations = 1
+    end
+
+    def load_benchmarks(path)
+      @path = path
+      @@current = self
+      load(path)
+    end
+
+    def load_mri_benchmarks(path, options)
+      @path = path
+      @@current = self
+      Frontends::MRI.load_mri path, options
+    end
+
+    def register(name, code)
+      name = implicit_name unless name
+      @benchmarks.push Benchmark.new(name, code)
+    end
+
+    def implicit_name
+      file = File.basename(@path, '.rb')
+      @counter += 1
+      "#{file}:#{@counter}"
+    end
+
+    def prepare
+      # Don't give benchmarks line numbers if there's only one
+
+      if @benchmarks.size == 1
+        @benchmarks.first.remove_line_numbers
+      end
+
+      # Give benchmarks iterations if needed
+
+      if @benchmarks.any?(&:needs_iterating?)
+        iterations = @benchmarks.map(&:iterations_for_one_second).min
+
+        puts "This benchmark set contains blocks that want a number of iterations - running all iterations #{iterations} times"
+
+        @benchmarks.each do |b|
+          b.iterate iterations
+        end
+
+        @iterations = iterations
+      end
+    end
+
+    def benchmarks(names=nil)
+      if names
+        @benchmarks.select { |b| names.include?(b.name) }
+      else
+        @benchmarks
+      end
+    end
+
+    def benchmark(name)
+      benchmarks([name]).first
+    end
+
+    @@current = nil
+
+    def self.current
+      @@current
+    end
+
+  end
+end

data/lib/benchmark-interface/benchmark.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  class Benchmark
+  
+    attr_reader :name, :block
+  
+    def initialize(name, block)
+      @name = name
+      @block = block
+    end
+
+    def remove_line_numbers
+      @name = @name.split(':')[0...-1].join(':') if @name.include? ':'
+    end
+
+    def time_block(desired_time)
+      iterations = 1
+      while true
+        start = Time.now
+        if block.arity == 1
+          block.call iterations
+        else
+          iterations.times do
+            block.call
+          end
+        end
+
+        time = Time.now - start
+        return [time, iterations] if time >= desired_time
+        iterations *= 2
+      end
+    end
+
+    def basic_iteration_time
+      time, iterations = time_block(0.1)
+      time / iterations.to_f
+    end
+
+    def iterations_for_one_second
+      _, iterations = time_block(1)
+      iterations
+    end
+    
+    def needs_iterating?
+      @block.arity == 1
+    end
+
+    def iterate(iterations)
+      original_block = @block
+
+      if original_block.arity == 1
+        @block = Proc.new do
+          original_block.call iterations
+        end
+      else
+        @block = Proc.new do
+          iterations.times do
+            original_block.call
+          end
+        end
+      end
+    end
+  
+  end
+end

data/lib/benchmark-interface/frontends/bench9000.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+input = harness_input
+
+unless harness_verify(harness_sample(input))
+  abort 'result was incorrect'
+end
+
+Object.instance_eval do
+  alias_method :user_harness_sample, :harness_sample
+end
+
+BenchmarkInterface.benchmark do
+  user_harness_sample input
+end

data/lib/benchmark-interface/frontends/bench9000micro.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+input = micro_harness_input
+
+SMALL_PRIME = 149
+
+Object.instance_eval do
+  alias_method :user_micro_harness_sample, :micro_harness_sample
+end
+
+BenchmarkInterface.benchmark do
+  user_micro_harness_sample input
+end

data/lib/benchmark-interface/frontends/benchmark.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  
+  class BenchmarkContext
+    
+    def report(name=nil, &block)
+      BenchmarkInterface.benchmark name, &block
+    end
+    
+  end
+  
+end
+
+module Benchmark
+
+  CAPTION = "      user     system      total        real\n"
+  FORMAT  = "%10.6u %10.6y %10.6t %10.6r\n"
+
+  def self.measure(name=nil, &block)
+    BenchmarkInterface.benchmark name, &block
+  end
+
+  def self.realtime(name=nil, &block)
+    BenchmarkInterface.benchmark name, &block
+  end
+
+  def self.benchmark(caption='', label_width=nil, format=nil, *labels)
+    yield BenchmarkInterface::BenchmarkContext.new
+  end
+
+  def self.realtime(name=nil, &block)
+    BenchmarkInterface.benchmark name, &block
+  end
+  
+  def self.bm(label_width=0, *labels)
+    yield BenchmarkInterface::BenchmarkContext.new
+  end
+
+  def self.bmbm(label_width=0)
+    yield BenchmarkInterface::BenchmarkContext.new
+  end
+  
+end

data/lib/benchmark-interface/frontends/bips.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  
+  class BipsContext
+    
+    attr_accessor :compare, :hold, :time, :warmup, :iterations
+    
+    def config(options)
+      # Ignore
+    end
+    
+    def compare!
+      # Ignore
+    end
+    
+    def item(name=nil, code=nil, &block)
+      raise 'cannot have both a string and a block' if code && block
+      block = eval("Proc.new { #{code} }") if code
+      BenchmarkInterface.benchmark name, &block
+    end
+    alias_method :report, :item
+    
+  end
+  
+end
+
+module Benchmark
+  
+  def self.ips
+    yield BenchmarkInterface::BipsContext.new
+  end
+  
+end

data/lib/benchmark-interface/frontends/mri.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  module Frontends
+    module MRI
+
+      CACHE_FILE = 'mri-rewrite-cache.rb'
+
+      def self.load_mri(path, options)
+        if options['--use-cache']
+          load CACHE_FILE
+        else
+          require 'parser/current'
+          require 'unparser'
+
+          source = File.read(path)
+          buffer = Parser::Source::Buffer.new(source)
+          buffer.source = source
+          parser = Parser::CurrentRuby.new
+          ast = parser.parse(buffer)
+
+          abort "AST rooted at unexpected #{ast.type.inspect}" unless ast.type == :begin
+          last = ast.children.last
+          abort "Last statement #{last.type.inspect} unexpected" unless [:while, :block, :send, :lvasgn].include? last.type
+
+          assigns = {}
+
+          rewriter = Class.new(Parser::Rewriter) do
+            define_method :on_lvasgn do |node|
+              if node == last
+                on_node node
+              elsif node.children.last.type == :int
+                name = node.children.first
+                value = node.children.last.children.last
+                assigns[name] = value
+              end
+            end
+
+            define_method :on_node do |node|
+              return unless node == last
+
+              assigns_source = ''
+
+              assigns.each do |name, value|
+                if node.to_s.include? "(lvar #{name.inspect})"
+                  assigns_source += "#{name} = #{value}; "
+                end
+              end
+
+              insert_before node.location.expression, 'BenchmarkInterface.benchmark { ' + assigns_source
+              insert_after node.location.expression, ' }'
+            end
+
+            alias_method :on_while, :on_node
+            alias_method :on_block, :on_node
+            alias_method :on_send, :on_node
+          end
+
+          rewriter = rewriter.new
+          rewritten = rewriter.rewrite(buffer, ast)
+
+          if options['--show-rewrite']
+            puts rewritten
+          end
+
+          if options['--cache']
+            File.write(CACHE_FILE, rewritten)
+            exit 1
+          else
+            Object.instance_eval rewritten
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/lib/benchmark-interface/frontends/perfer.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  
+  class PerferContext
+    
+    def iterate(name, &block)
+      BenchmarkInterface.benchmark name, &block
+    end
+    
+  end
+  
+end
+
+module Perfer
+  
+  def self.session(name)
+    yield BenchmarkInterface::PerferContext.new
+  end
+  
+end

data/lib/benchmark-interface/frontends/rbench.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0
+# GNU General Public License version 2
+# GNU Lesser General Public License version 2.1
+
+module BenchmarkInterface
+  
+  class RBenchContext
+    
+    def initialize
+      @columns = []
+    end
+    
+    def format(options)
+      # Ignore
+    end
+    
+    def column(name, options=nil)
+      singleton_class = (class << self; self end)
+      singleton_class.class_eval "def #{name}(&block); rbench_benchmark #{name.inspect}, block; end"
+      @columns.push name
+    end
+    
+    def group(name)
+      @group_name = name
+      yield self
+    ensure
+      @group_name = nil
+    end
+    
+    def report(name, &block)
+      if @columns.size == 0
+        BenchmarkInterface.benchmark name, &block
+      else
+        @report_name = name
+        instance_eval &block
+      end
+    ensure
+      @report_name = nil
+    end
+    
+    def summary(title)
+      # Ignore
+    end
+    
+    def rbench_benchmark(column_name, block)
+      name = [@group_name, @report_name, column_name].compact.join('-')
+      BenchmarkInterface.benchmark name, &block
+    end
+    
+  end
+  
+end
+
+module RBench
+  
+  def self.run(count, &block)
+    BenchmarkInterface::RBenchContext.new.instance_eval &block
+  end
+  
+end