railsbench 0.9.2 → 0.9.8

data/lib/railsbench/benchmark_specs.rb

@@ -1,63 +1,63 @@
-require 'delegate'
-require 'yaml'
-require 'erb'
-
-class BenchmarkSpec < DelegateClass(Hash)
-  attr_accessor :name
-
-  READERS = %w(uri method post_data query_string new_session action controller session_data)
-  READERS.each do |method|
-    define_method(method) { self[method] }
-  end
-
-  def initialize(name, hash)
-    super(hash)
-    @name = name
-  end
-
-  def inspect
-    "BenchmarkSpec(#{name},#{super})"
-  end
-
-  class << self
-    def load(name, file_name = nil)
-      unless file_name
-        file_name = ENV['RAILS_ROOT'] + "/config/benchmarks.yml"
-      end
-      @@specs = YAML::load(ERB.new(IO.read(file_name)).result)
-      raise "There is no benchmark named '#{name}'" unless @@specs[name]
-      parse(@@specs, name)
-    end
-
-    def parse(specs, name)
-      spec = specs[name]
-      if spec.is_a?(String)
-        spec.split(/, */).collect!{ |n| parse(specs, n) }.flatten
-      elsif spec.is_a?(Hash)
-        [ BenchmarkSpec.new(name,spec) ]
-      elsif spec.is_a?(Array)
-        spec.collect{|n| parse(specs, n)}.flatten
-      else
-        raise "oops: unknown entry type in benchmark specification"
-      end
-    end
-  end
-end
-
-__END__
-
-#  Copyright (C) 2007  Stefan Kaes
-#
-#  This program is free software; you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation; either version 2 of the License, or
-#  (at your option) any later version.
-#
-#  This program is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#
-#  You should have received a copy of the GNU General Public License
-#  along with this program; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+require 'delegate'
+require 'yaml'
+require 'erb'
+
+class BenchmarkSpec < DelegateClass(Hash)
+  attr_accessor :name
+
+  READERS = %w(uri method post_data query_string new_session action controller session_data xhr raw_data)
+  READERS.each do |method|
+    define_method(method) { self[method] }
+  end
+
+  def initialize(name, hash)
+    super(hash)
+    @name = name
+  end
+
+  def inspect
+    "BenchmarkSpec(#{name},#{super})"
+  end
+
+  class << self
+    def load(name, file_name = nil)
+      unless file_name
+        file_name = ENV['RAILS_ROOT'] + "/config/benchmarks.yml"
+      end
+      @@specs = YAML::load(ERB.new(IO.read(file_name)).result)
+      raise "There is no benchmark named '#{name}'" unless @@specs[name]
+      parse(@@specs, name)
+    end
+
+    def parse(specs, name)
+      spec = specs[name]
+      if spec.is_a?(String)
+        spec.split(/, */).collect!{ |n| parse(specs, n) }.flatten
+      elsif spec.is_a?(Hash)
+        [ BenchmarkSpec.new(name,spec) ]
+      elsif spec.is_a?(Array)
+        spec.collect{|n| parse(specs, n)}.flatten
+      else
+        raise "oops: unknown entry type in benchmark specification"
+      end
+    end
+  end
+end
+
+__END__
+
+#  Copyright (C) 2007, 2008  Stefan Kaes
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

data/lib/railsbench/gc_info.rb

@@ -25,6 +25,15 @@ require "set"
 # kept 0173634 / freed 0002389 objects of type NODE
 # GC time: 47 msec
 
+# Sentinel:
+# HEAP[ 0]: size= 300000
+# HEAP[ 1]: size= 600000
+# ...
+# number of requests processed: 1000
+# 128334 nodes malloced for 17345 KB
+# 396 leaks for 10464 total leaked bytes.
+
+
 GCAttributes = [:processed, :live, :freelist, :freed, :time]
 GCSummaries  = [:min, :max, :mean, :stddev, :stddev_percentage]
 
@@ -41,7 +50,8 @@ class GCInfo
 
   attr_reader(*GCAttributes)
   attr_reader :entries, :num_requests, :collections, :garbage_produced, :time_total, :topology
-  attr_reader :live_objects, :freed_objects, :object_types
+  attr_reader :live_objects, :freed_objects, :object_types, :garbage_totals
+  attr_reader :mallocs, :malloced, :leaks, :leaked
 
   GCAttributes.each do |attr|
     GCSummaries.each do |method|
@@ -54,6 +64,7 @@ class GCInfo
     @num_requests = 0
     @topology = []
     @object_types = Set.new
+    @mallocs = @malloced = @leaks = @leaked = 0
 
     file.each_line do |line|
       case line
@@ -72,11 +83,18 @@ class GCInfo
       when /^number of requests processed: (\d+)$/
         @num_requests = $1.to_i
       when /^HEAP\[\s*(\d+)\]: size=\s*(\d+)$/
+        @topology = [] if $1.to_i == 0
         @topology << $2.to_i
       when /^kept (\d+) \/ freed (\d+) objects of type ([a-zA-Z]+)/
         @object_types.add($3)
         @entries.last.live_objects[$3] = $1.to_i
         @entries.last.freed_objects[$3] = $2.to_i
+      when /^(\d+) nodes malloced for (\d+) KB$/
+        @mallocs = $1.to_i
+        @malloced = $2.to_i * 1024
+      when /^(\d+) leaks for (\d+) total leaked bytes.$/
+        @leaks = $1.to_i
+        @leaked = $2.to_i
       end
     end
 
@@ -85,10 +103,18 @@ class GCInfo
     @garbage_produced = @entries.map{|e| e.freed}.sum
     @live_objects = @entries.map{|e| e.live_objects}
     @freed_objects = @entries.map{|e| e.freed_objects}
+    @freelist = @entries.map{|e| e.freelist}
+    @garbage_totals = @freed_objects.inject(Hash.new(0)) do |totals, freed|
+      freed.each do |object_type, count|
+        totals[object_type] += freed[object_type] || 0
+      end
+      totals
+    end
 
     GCAttributes.each do |attr|
       a = @entries.map{|e| e.send attr}
-      a.pop
+      # we need to pop the last entry, as the freelist is not empty when doing the last forced GC
+      a.pop if :freelist == attr.to_sym
 
       [:min, :max, :mean].each do |method|
         instance_variable_set "@#{attr}_#{method}", (a.send method)
@@ -99,6 +125,15 @@ class GCInfo
     end
   end
 
+  OBJECT_TYPES = %w(NODE STRING ARRAY HASH SCOPE VARMAP CLASS ICLASS REGEXP FLOAT MATCH FILE DATA MODULE OBJECT)
+
+  class << self
+    def object_types(list_of_gc_infos)
+      list_of_gc_infos.inject(OBJECT_TYPES) do |object_types, gci|
+        (object_types + gci.object_types.to_a).uniq
+      end
+    end
+  end
 end
 
 
@@ -106,7 +141,7 @@ end
 ### mode:ruby ***
 ### End: ***
 
-#    Copyright (C) 2006, 2007  Stefan Kaes
+#    Copyright (C) 2006, 2007, 2008  Stefan Kaes
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by

data/lib/railsbench/perf_info.rb

@@ -129,7 +129,7 @@ end
 ### mode:ruby ***
 ### End: ***
 
-#    Copyright (C) 2006, 2007  Stefan Kaes
+#    Copyright (C) 2006, 2007, 2008  Stefan Kaes
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by

data/lib/railsbench/perf_utils.rb

@@ -1,179 +1,202 @@
-# some utility methods
-
-class Array
-  def index_map
-    res = {}
-    each_with_index{|element, index| res[index] = element}
-    res
-  end
-
-  def restrict_to(index_set)
-    res = []
-    each_with_index{|e,i| res << e if index_set.include?(i)}
-    res
-  end
-
-  def sum
-    inject(0.0){|r,v| r += v }
-  end
-
-  def mean
-    sum/length
-  end
-
-  def stddev(mean=nil)
-    mean ||= self.mean
-    r = inject(0.0){|r,v| r += (v-mean)*(v-mean) }
-    Math.sqrt(r/(length-1))
-  end
-end
-
-def stddev_percentage(stddev, mean)
-  stddev.zero? ? 0.0 : (stddev/mean)*100
-end
-
-def die(msg, error_code=1)
-  $stderr.puts msg
-  exit error_code
-end
-
-class File
-  def self.open_or_die(filename, &block)
-    filename = filename.sub(/^\/([cdefgh])(\/)/, '\1:\2') if RUBY_PLATFORM =~ /win32/
-    begin
-      if stat(filename).readable?
-        open(filename, &block)
-      else
-        die "file #{filename} is unreadable"
-      end
-    rescue
-      die "file #{filename} does not exist"
-    end
-  end
-end
-
-def truncate(text, length = 32, truncate_string = "...")
-  if text.nil? then return "" end
-  l = truncate_string.length + 1
-
-  if $KCODE == "NONE"
-    text.length > length ? text[0..(length - l)] + truncate_string : text
-  else
-    chars = text.split(//)
-    chars.length > length ? chars[0..(length - l)].join + truncate_string : text
-  end
-end
-
-RAILSBENCH_BINDIR = File.expand_path(File.dirname(__FILE__) + "/../../script")
-
-def enable_gc_stats(file)
-  ENV['RUBY_GC_STATS'] = "1"
-  ENV['RUBY_GC_DATA_FILE'] = file
-end
-
-def disable_gc_stats
-  ENV.delete 'RUBY_GC_STATS'
-  ENV.delete 'RUBY_GC_DATA_FILE'
-end
-
-def unset_gc_variables
-  %w(RUBY_HEAP_MIN_SLOTS RUBY_GC_MALLOC_LIMIT RUBY_HEAP_FREE_MIN).each{|v| ENV.delete v}
-end
-
-def load_gc_variables(gc_spec)
-  File.open_or_die("#{ENV['RAILS_ROOT']}/config/#{gc_spec}.gc").each_line do |line|
-    ENV[$1] = $2 if line =~ /^(.*)=(.*)$/
-  end
-end
-
-def set_gc_variables(argv)
-  gc_spec = nil
-  argv.each{|arg| gc_spec=$1 if arg =~ /-gc=([^ ]*)/}
-
-  if gc_spec
-    load_gc_variables(gc_spec)
-  else
-    unset_gc_variables
-  end
-end
-
-def benchmark_file_name(benchmark, config_name, prefix=nil, suffix=nil)
-  perf_data_dir = (ENV['RAILS_PERF_DATA'] ||= ENV['HOME'])
-  date = Time.now.strftime '%m-%d'
-  suffix = ".#{suffix}" if suffix
-  ENV['RAILS_BENCHMARK_FILE'] =
-    if config_name
-      "#{perf_data_dir}/#{date}.#{benchmark}.#{config_name}#{suffix}.txt"
-    else
-      "#{perf_data_dir}/perf_run#{prefix}.#{benchmark}#{suffix}.txt"
-    end
-end
-
-def quote_arguments(argv)
-  argv.map{|a| a.include?(' ') ? "'#{a}'" : a.to_s}.join(' ')
-end
-
-def perf_run(script, iterations, options, raw_data_file)
-  perf_runs = (ENV['RAILS_PERF_RUNS'] ||= "3").to_i
-
-  disable_gc_stats
-  set_gc_variables([iterations, options])
-
-  perf_options = "#{iterations} #{options}"
-  null = (RUBY_PLATFORM =~ /win32/i) ? 'nul' : '/dev/null'
-
-  perf_cmd = "ruby #{RAILSBENCH_BINDIR}/perf_bench #{perf_options}"
-  print_cmd = "ruby #{RAILSBENCH_BINDIR}/perf_times #{raw_data_file}"
-
-  puts "benchmarking #{perf_runs} runs with options #{perf_options}"
-
-  File.open(raw_data_file, "w"){ |f| f.puts perf_cmd }
-  perf_runs.times do
-    system("#{perf_cmd} >#{null}") || die("#{script}: #{perf_cmd} returned #{$?}")
-  end
-  File.open(raw_data_file, "a" ){|f| f.puts }
-
-  unset_gc_variables
-  system(print_cmd) || die("#{script}: #{print_cmd} returned #{$?}")
-end
-
-def perf_run_gc(script, iterations, options, raw_data_file)
-  warmup = "-warmup"
-  warmup = "" if options =~ /-warmup/
-
-  enable_gc_stats(raw_data_file)
-  set_gc_variables([options])
-
-  perf_options = "#{iterations} #{warmup} #{options}"
-  null = (RUBY_PLATFORM =~ /win32/) ? 'nul' : '/dev/null'
-
-  perf_cmd = "ruby #{RAILSBENCH_BINDIR}/run_urls #{perf_options} >#{null}"
-  print_cmd = "ruby #{RAILSBENCH_BINDIR}/perf_times_gc #{raw_data_file}"
-
-  puts "benchmarking GC performance with options #{perf_options}"
-  puts
-
-  system(perf_cmd) || die("#{script}: #{perf_cmd} returned #{$?}")
-
-  disable_gc_stats
-  unset_gc_variables
-  system(print_cmd) || die("#{script}: #{print_cmd} returned #{$?}")
-end
-
-__END__
-
-#  Copyright (C) 2005, 2006, 2007  Stefan Kaes
-#
-#  This program is free software; you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation; either version 2 of the License, or
-#  (at your option) any later version.
-#
-#  This program is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#
-#  You should have received a copy of the GNU General Public License
-#  along with this program; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+# some utility methods
+
+class Array
+  def index_map
+    res = {}
+    each_with_index{|element, index| res[index] = element}
+    res
+  end
+
+  def restrict_to(index_set)
+    res = []
+    each_with_index{|e,i| res << e if index_set.include?(i)}
+    res
+  end
+
+  def sum
+    inject(0.0){|r,v| r += v }
+  end
+
+  def mean
+    sum/length
+  end
+
+  def stddev(mean=nil)
+    mean ||= self.mean
+    r = inject(0.0){|r,v| r += (v-mean)*(v-mean) }
+    Math.sqrt(r/(length-1))
+  end
+end
+
+def stddev_percentage(stddev, mean)
+  stddev.zero? ? 0.0 : (stddev/mean)*100
+end
+
+def determine_rails_root_or_die!(msg=nil)
+  unless ENV['RAILS_ROOT']
+    if File.directory?("config") && File.exists?("config/environment.rb")
+      ENV['RAILS_ROOT'] = File.expand_path(".")
+    else
+      die(msg || "#{File.basename $PROGRAM_NAME}: $RAILS_ROOT not set and could not be configured automatically")
+    end
+  end
+end
+
+def die(msg, error_code=1)
+  $stderr.puts msg
+  exit error_code
+end
+
+class File
+  def self.open_or_die(filename, &block)
+    filename = filename.sub(/^\/([cdefgh])(\/)/, '\1:\2') if RUBY_PLATFORM =~ /win32/
+    begin
+      if stat(filename).readable?
+        open(filename, &block)
+      else
+        die "file #{filename} is unreadable"
+      end
+    rescue
+      die "file #{filename} does not exist"
+    end
+  end
+end
+
+def truncate(text, length = 32, truncate_string = "...")
+  if text.nil? then return "" end
+  l = truncate_string.length + 1
+
+  if RUBY_VERSION !~ /1.9/ && $KCODE == "NONE"
+    text.length > length ? text[0..(length - l)] + truncate_string : text
+  else
+    chars = text.split(//)
+    chars.length > length ? chars[0..(length - l)].join + truncate_string : text
+  end
+end
+
+RAILSBENCH_BINDIR = File.expand_path(File.dirname(__FILE__) + "/../../script")
+
+def enable_gc_stats(file)
+  ENV['RUBY_GC_STATS'] = "1"
+  ENV['RUBY_GC_DATA_FILE'] = file
+end
+
+def disable_gc_stats
+  ENV.delete 'RUBY_GC_STATS'
+  ENV.delete 'RUBY_GC_DATA_FILE'
+end
+
+def unset_gc_variables
+  %w(RUBY_HEAP_MIN_SLOTS RUBY_GC_MALLOC_LIMIT RUBY_HEAP_FREE_MIN).each{|v| ENV.delete v}
+end
+
+def load_gc_variables(gc_spec)
+  File.open_or_die("#{ENV['RAILS_ROOT']}/config/#{gc_spec}.gc").each_line do |line|
+    ENV[$1] = $2 if line =~ /^(?:export )?(.*)=(.*)$/
+  end
+end
+
+def set_gc_variables(argv)
+  gc_spec = nil
+  argv.each{|arg| gc_spec=$1 if arg =~ /-gc=([^ ]*)/}
+
+  if gc_spec
+    load_gc_variables(gc_spec)
+  else
+    unset_gc_variables
+  end
+end
+
+def benchmark_file_name(benchmark, config_name, prefix=nil, suffix=nil)
+  perf_data_dir = (ENV['RAILS_PERF_DATA'] ||= ENV['HOME'])
+  date = Time.now.strftime '%m-%d'
+  suffix = ".#{suffix}" if suffix
+  ENV['RAILS_BENCHMARK_FILE'] =
+    if config_name
+      "#{perf_data_dir}/#{date}.#{benchmark}.#{config_name}#{suffix}.txt"
+    else
+      "#{perf_data_dir}/perf_run#{prefix}.#{benchmark}#{suffix}.txt"
+    end
+end
+
+def quote_arguments(argv)
+  argv.map{|a| a.include?(' ') ? "'#{a}'" : a.to_s}.join(' ')
+end
+
+def ruby
+  ENV['RUBY'] || "ruby"
+end
+
+def perf_run(script, iterations, options, raw_data_file)
+  perf_runs = (ENV['RAILS_PERF_RUNS'] ||= "3").to_i
+
+  disable_gc_stats
+  set_gc_variables([iterations, options])
+
+  perf_options = "#{iterations} #{options}"
+  null = (RUBY_PLATFORM =~ /win32/i) ? 'nul' : '/dev/null'
+
+  perf_cmd = "#{ruby} #{RAILSBENCH_BINDIR}/perf_bench #{perf_options}"
+  print_cmd = "#{ruby} #{RAILSBENCH_BINDIR}/perf_times #{raw_data_file}"
+
+  puts "benchmarking #{perf_runs} runs with options #{perf_options}"
+
+  File.open(raw_data_file, "w"){ |f| f.puts perf_cmd }
+  perf_runs.times do
+    system("#{perf_cmd} >#{null}") || die("#{script}: #{perf_cmd} returned #{$?}")
+  end
+  File.open(raw_data_file, "a" ){|f| f.puts }
+
+  unset_gc_variables
+  system(print_cmd) || die("#{script}: #{print_cmd} returned #{$?}")
+end
+
+def perf_run_gc(script, iterations, options, raw_data_file)
+  warmup = "-warmup"
+  warmup = "" if options =~ /-warmup/
+
+  enable_gc_stats(raw_data_file)
+  set_gc_variables([options])
+
+  perf_options = "#{iterations} #{warmup} #{options}"
+  null = (RUBY_PLATFORM =~ /win32/) ? 'nul' : '/dev/null'
+
+  perf_cmd = "#{ruby} #{RAILSBENCH_BINDIR}/run_urls #{perf_options} >#{null}"
+  print_cmd = "#{ruby} #{RAILSBENCH_BINDIR}/perf_times_gc #{raw_data_file}"
+
+  if options =~ /-leaks/
+    if RUBY_PLATFORM =~ /darwin9/
+      puts "enabling MallocStackLogging"
+      perf_cmd.insert(0, "MallocStackLogging=1 ")
+    else
+      die "leak debugging not supported on #{RUBY_PLATFORM}"
+    end
+  end
+
+  puts "benchmarking GC performance with options #{perf_options}"
+  puts
+
+  system(perf_cmd) || die("#{script}: #{perf_cmd} returned #{$?}")
+
+  disable_gc_stats
+  unset_gc_variables
+  system(print_cmd) || die("#{script}: #{print_cmd} returned #{$?}")
+end
+
+__END__
+
+#  Copyright (C) 2005-2008  Stefan Kaes
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA