ruby-prof 0.7.0 → 0.7.1

data/CHANGES

@@ -1,3 +1,24 @@
+0.7.1 (2008-11-28)
+========================
+* Added new AggregateCallInfo class for printers to
+  make results easier to read.  Take this call sequence
+  for example:
+
+   A   B   C
+   |   |   |
+   Z   A   A
+       |   |
+       Z   Z
+
+  By default, ruby-prof will show that Z was called by 3 separate
+  instances of A.  In an IDE that is helpful but in a text report
+  it is not since it makes the report much harder to read.
+  As a result, printers now aggregate together callers (and children),
+  matching ruby-prof's output from versions prior to 0.7.0.
+
+* Fixes for supporting x86_64 machines (Matt Sanford)
+
+
 0.7.0 (2008-11-04)
 ========================
 

data/README

@@ -33,7 +33,9 @@ The easiest way to install ruby-prof is by using Ruby Gems.  To install:
 <tt>gem install ruby-prof</tt>
 
 If you are running Windows, make sure to install the Win32 RubyGem which 
-includes a pre-built binary.
+includes a pre-built binary. Due to a bug in ruby-gems, you cannot
+install the gem to a path that contains spaces
+(see http://rubyforge.org/tracker/?func=detail&aid=23003&group_id=126&atid=577).
 
 ruby-prof is also available as a tarred gzip archive and zip archive. 
 

data/Rakefile

@@ -117,7 +117,7 @@ task :default => :package
 desc 'Run the ruby-prof test suite'
 Rake::TestTask.new do |t|
   t.libs += %w(lib ext test)
-  t.test_files = Dir['test/*_test.rb'] - %w(test/profile_unit_test.rb)
+  t.test_files = Dir['test/test_suite.rb']
   t.verbose = true
   t.warning = true
 end

data/ext/measure_cpu_time.h

@@ -26,7 +26,7 @@
 
 #include <ruby.h>
 
-#if defined(_WIN32) || (defined(__GNUC__) && (defined(__i386__) || defined(__powerpc__) || defined(__ppc__)))
+#if defined(_WIN32) || (defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__) || defined(__powerpc__) || defined(__ppc__)))
 #define MEASURE_CPU_TIME 2
 
 static unsigned long long cpu_frequency;
@@ -36,7 +36,7 @@ static unsigned long long cpu_frequency;
 static prof_measure_t
 measure_cpu_time()
 {
-#if defined(__i386__)
+#if defined(__i386__) || defined(__x86_64__) 
     unsigned long long x;
     __asm__ __volatile__ ("rdtsc" : "=A" (x));
     return x;

data/ext/mingw/Rakefile

@@ -15,7 +15,7 @@ task :install do
   # RUBYLIBDIR=#{dest_path}
   
   dest_path = ENV['RUBYLIBDIR']
-  
+
   # Copy the extension
   cp(EXTENSION_NAME, dest_path)
 end

data/ext/version.h

@@ -1,4 +1,4 @@
-#define RUBY_PROF_VERSION  "0.7.0"
+#define RUBY_PROF_VERSION  "0.7.1"
 #define RUBY_PROF_VERSION_MAJ   0
 #define RUBY_PROF_VERSION_MIN   7
-#define RUBY_PROF_VERSION_MIC   0
+#define RUBY_PROF_VERSION_MIC   1

data/lib/ruby-prof.rb

@@ -2,6 +2,7 @@ require "ruby_prof.so"
 
 require "ruby-prof/method_info"
 require "ruby-prof/call_info"
+require "ruby-prof/aggregate_call_info"
 require "ruby-prof/flat_printer"
 require "ruby-prof/graph_printer"
 require "ruby-prof/graph_html_printer"

data/lib/ruby-prof/abstract_printer.rb

@@ -37,6 +37,5 @@ module RubyProf
       end
       name
     end
-
   end
 end 

data/lib/ruby-prof/aggregate_call_info.rb

@@ -0,0 +1,62 @@
+module RubyProf
+  class AggregateCallInfo
+    attr_reader :call_infos
+    def initialize(call_infos)
+      if call_infos.length == 0
+        raise(ArgumentError, "Must specify at least one call info.")
+      end
+      @call_infos = call_infos
+    end
+
+    def target
+      call_infos.first.target
+    end
+
+    def parent
+      call_infos.first.parent
+    end
+
+    def line
+      call_infos.first.line
+    end
+
+    def children
+      call_infos.inject(Array.new) do |result, call_info|
+        result.concat(call_info.children)
+      end
+    end
+
+    def total_time
+      aggregate(:total_time)
+    end
+
+    def self_time
+      aggregate(:self_time)
+    end
+
+    def wait_time
+      aggregate(:wait_time)
+    end
+
+    def children_time
+      aggregate(:children_time)
+    end
+
+    def called
+      aggregate(:called)
+    end
+
+    def to_s
+      "#{call_infos.first.full_name}"
+    end
+
+    private
+
+    def aggregate(method_name)
+      self.call_infos.inject(0) do |sum, call_info|
+        sum += call_info.send(method_name)
+      end
+    end
+
+  end
+end

data/lib/ruby-prof/call_info.rb

@@ -39,7 +39,7 @@ module RubyProf
     def root?
       self.parent.nil?
     end
-    
+
     def to_s
       "#{call_sequence}"
     end

data/lib/ruby-prof/graph_html_printer.rb

@@ -198,7 +198,7 @@ module RubyProf
             self_percentage = (method.self_time/total_time) * 100 %>
           
             <!-- Parents -->
-            <% for caller in method.call_infos
+            <% for caller in method.aggregate_parents
                  next unless caller.parent
                  next if min_time && caller.total_time < min_time  %>
               <tr>
@@ -228,7 +228,7 @@ module RubyProf
             </tr>
 
             <!-- Children -->
-            <% for callee in method.children %>
+            <% for callee in method.aggregate_children %>
             <%   next if min_time && callee.total_time < min_time  %>
               <tr>
                 <td>&nbsp;</td>

data/lib/ruby-prof/graph_printer.rb

@@ -127,7 +127,7 @@ module RubyProf
     end
     
     def print_parents(thread_id, method)
-      method.call_infos.each do |caller|
+      method.aggregate_parents.each do |caller|
         next unless caller.parent
         @output << " " * 2 * PERCENTAGE_WIDTH
         @output << sprintf("%#{TIME_WIDTH}.2f", caller.total_time)
@@ -143,7 +143,7 @@ module RubyProf
     end
   
     def print_children(method)
-      method.children.each do |child|
+      method.aggregate_children.each do |child|
         # Get children method
         
         @output << " " * 2 * PERCENTAGE_WIDTH

data/lib/ruby-prof/group_by.rb

@@ -0,0 +1,10 @@
+unless Enumerable.method_defined?(:group_by)
+  module Enumerable
+    def group_by
+      inject(Hash.new) do |result, element|
+        (result[yield(element)] ||= []) << element
+        result
+      end
+    end
+  end
+end

data/lib/ruby-prof/method_info.rb

@@ -48,14 +48,6 @@ module RubyProf
       end
     end
 
-    def children
-      @children ||= begin
-        call_infos.map do |call_info|
-          call_info.children
-        end.flatten
-      end
-    end
-
     def children_time
       @children_time ||= begin
         call_infos.inject(0) do |sum, call_info|
@@ -78,8 +70,38 @@ module RubyProf
       end
     end
 
+    def children
+      @children ||= begin
+        call_infos.map do |call_info|
+          call_info.children
+        end.flatten
+      end
+    end
+
+    def aggregate_parents
+      aggregate_call_infos(self.call_infos)
+    end
+
+    def aggregate_children
+      aggregate_call_infos(self.children)
+    end
+
     def to_s
       full_name
     end
+
+    private
+
+    def aggregate_call_infos(call_infos)
+      groups = call_infos.inject(Hash.new) do |hash, call_info|
+        key = call_info.parent ? call_info.parent.target : self
+        (hash[key] ||= []) << call_info
+        hash
+      end
+
+      groups.map do |key, value|
+        AggregateCallInfo.new(value)
+      end
+    end
   end
 end

data/rails/example/example_test.rb.html

@@ -0,0 +1,14 @@
+<!-- Generator: GNU source-highlight 2.9
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> File<span style="color: #990000">.</span>dirname<span style="color: #990000">(</span><span style="font-weight: bold"><span style="color: #0000FF">__FILE__</span></span><span style="color: #990000">)</span> <span style="color: #990000">+</span> <span style="color: #FF0000">'../profile_test_helper'</span>
+
+<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> ExampleTest <span style="color: #990000">&lt;</span> Test<span style="color: #990000">::</span>Unit<span style="color: #990000">::</span>TestCase
+  <span style="font-weight: bold"><span style="color: #0000FF">include</span></span> RubyProf<span style="color: #990000">::</span>Test
+  
+  <span style="font-weight: bold"><span style="color: #0000FF">def</span></span> test_stuff
+    puts <span style="color: #FF0000">"Test method"</span>
+  <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>
+<span style="font-weight: bold"><span style="color: #0000FF">end</span></span>   
+</tt></pre>

data/test/aggregate_test.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'ruby-prof'
+
+# Test data
+#   A   B   C
+#   |   |   |
+#   Z   A   A
+#       |   |
+#       Z   Z
+
+class AggClass
+  def z
+    sleep 1
+  end
+  
+  def a
+    z
+  end
+
+  def b
+    a
+  end
+
+  def c
+   a
+  end
+end
+
+class AggregateTest < Test::Unit::TestCase
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def test_call_infos
+    c1 = AggClass.new
+    result = RubyProf.profile do
+      c1.a
+      c1.b
+      c1.c
+    end
+
+    methods = result.threads.values.first.sort.reverse
+    method = methods.find {|method| method.full_name == 'AggClass#z'}
+
+    # Check AggClass#z
+    assert_equal('AggClass#z', method.full_name)
+    assert_equal(3, method.called)
+    assert_in_delta(3, method.total_time, 0.01)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(0, method.self_time, 0.01)
+    assert_in_delta(3, method.children_time, 0.01)
+    assert_equal(3, method.call_infos.length)
+
+    call_info = method.call_infos[0]
+    assert_equal('AggregateTest#test_call_infos->AggClass#a->AggClass#z', call_info.call_sequence)
+    assert_equal(1, call_info.children.length)
+
+    call_info = method.call_infos[1]
+    assert_equal('AggregateTest#test_call_infos->AggClass#b->AggClass#a->AggClass#z', call_info.call_sequence)
+    assert_equal(1, call_info.children.length)
+
+    call_info = method.call_infos[2]
+    assert_equal('AggregateTest#test_call_infos->AggClass#c->AggClass#a->AggClass#z', call_info.call_sequence)
+    assert_equal(1, call_info.children.length)
+  end
+
+  def test_aggregates_parents
+    c1 = AggClass.new
+    result = RubyProf.profile do
+      c1.a
+      c1.b
+      c1.c
+    end
+
+    methods = result.threads.values.first.sort.reverse
+    method = methods.find {|method| method.full_name == 'AggClass#z'}
+
+    # Check AggClass#z
+    assert_equal('AggClass#z', method.full_name)
+
+    call_infos = method.aggregate_parents
+    assert_equal(1, call_infos.length)
+
+    call_info = call_infos.first
+    assert_equal('AggClass#a', call_info.parent.target.full_name)
+    assert_in_delta(3, call_info.total_time, 0.01)
+    assert_in_delta(0, call_info.wait_time, 0.01)
+    assert_in_delta(0, call_info.self_time, 0.01)
+    assert_in_delta(3, call_info.children_time, 0.01)
+    assert_equal(3, call_info.called)
+  end
+
+  def test_aggregates_children
+    c1 = AggClass.new
+    result = RubyProf.profile do
+      c1.a
+      c1.b
+      c1.c
+    end
+
+    methods = result.threads.values.first.sort.reverse
+    method = methods.find {|method| method.full_name == 'AggClass#a'}
+
+    # Check AggClass#a
+    assert_equal('AggClass#a', method.full_name)
+
+    call_infos = method.aggregate_children
+    assert_equal(1, call_infos.length)
+
+    call_info = call_infos.first
+    assert_equal('AggClass#z', call_info.target.full_name)
+    assert_in_delta(3, call_info.total_time, 0.01)
+    assert_in_delta(0, call_info.wait_time, 0.01)
+    assert_in_delta(0, call_info.self_time, 0.01)
+    assert_in_delta(3, call_info.children_time, 0.01)
+    assert_equal(3, call_info.called)
+  end
+end

data/test/stack_test.rb

@@ -10,7 +10,7 @@ require 'ruby-prof'
 #        \
 #         B
 
-class C1
+class StackClass
   def a
     sleep 1
     b
@@ -34,17 +34,17 @@ class StackTest < Test::Unit::TestCase
   end
 
   def test_call_sequence
-    c = C1.new
+    c = StackClass.new
     result = RubyProf.profile do
       c.a
     end
 
     # Length should be 5:
     #   StackTest#test_call_sequence
-    #   C1#a
+    #   StackClass#a
     #   Kernel#sleep
-    #   C1#c
-    #   C1#b
+    #   StackClass#c
+    #   StackClass#b
 
     methods = result.threads.values.first.sort.reverse
     assert_equal(5, methods.length)
@@ -63,9 +63,9 @@ class StackTest < Test::Unit::TestCase
     assert_equal('StackTest#test_call_sequence', call_info.call_sequence)
     assert_equal(1, call_info.children.length)
 
-    # Check C1#a
+    # Check StackClass#a
     method = methods[1]
-    assert_equal('C1#a', method.full_name)
+    assert_equal('StackClass#a', method.full_name)
     assert_equal(1, method.called)
     assert_in_delta(8, method.total_time, 0.01)
     assert_in_delta(0, method.wait_time, 0.01)
@@ -74,7 +74,7 @@ class StackTest < Test::Unit::TestCase
     assert_equal(1, method.call_infos.length)
 
     call_info = method.call_infos[0]
-    assert_equal('StackTest#test_call_sequence->C1#a', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a', call_info.call_sequence)
     assert_equal(3, call_info.children.length)
     
     # Check Kernel#sleep
@@ -88,24 +88,24 @@ class StackTest < Test::Unit::TestCase
     assert_equal(4, method.call_infos.length)
 
     call_info = method.call_infos[0]
-    assert_equal('StackTest#test_call_sequence->C1#a->Kernel#sleep', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
     call_info = method.call_infos[1]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#b->Kernel#sleep', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#b->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
     call_info = method.call_infos[2]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#c->Kernel#sleep', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#c->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
     call_info = method.call_infos[3]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#c->C1#b->Kernel#sleep', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#c->StackClass#b->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
-    # Check C1#c
+    # Check StackClass#c
     method = methods[3]
-    assert_equal('C1#c', method.full_name)
+    assert_equal('StackClass#c', method.full_name)
     assert_equal(1, method.called)
     assert_in_delta(5, method.total_time, 0.01)
     assert_in_delta(0, method.wait_time, 0.01)
@@ -114,12 +114,12 @@ class StackTest < Test::Unit::TestCase
     assert_equal(1, method.call_infos.length)
 
     call_info = method.call_infos[0]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#c', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#c', call_info.call_sequence)
     assert_equal(2, call_info.children.length)
 
-    # Check C1#b
+    # Check StackClass#b
     method = methods[4]
-    assert_equal('C1#b', method.full_name)
+    assert_equal('StackClass#b', method.full_name)
     assert_equal(2, method.called)
     assert_in_delta(4, method.total_time, 0.01)
     assert_in_delta(0, method.wait_time, 0.01)
@@ -128,11 +128,11 @@ class StackTest < Test::Unit::TestCase
     assert_equal(2, method.call_infos.length)
 
     call_info = method.call_infos[0]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#b', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#b', call_info.call_sequence)
     assert_equal(1, call_info.children.length)
 
     call_info = method.call_infos[1]
-    assert_equal('StackTest#test_call_sequence->C1#a->C1#c->C1#b', call_info.call_sequence)
+    assert_equal('StackTest#test_call_sequence->StackClass#a->StackClass#c->StackClass#b', call_info.call_sequence)
     assert_equal(1, call_info.children.length)
   end
 end

data/test/test_suite.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
 
+require 'aggregate_test'
 require 'basic_test'
 require 'duplicate_names_test'
 require 'exceptions_test'
@@ -9,7 +10,6 @@ require 'module_test'
 require 'no_method_class_test'
 require 'prime_test'
 require 'printers_test'
-require 'profile_unit_test'
 require 'recursive_test'
 require 'singleton_test'
 require 'stack_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-prof
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Shugo Maeda and Charlie Savage
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-11 00:00:00 -07:00
+date: 2008-11-30 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -49,11 +49,13 @@ files:
 - ext/vc/ruby_prof.vcproj
 - lib/ruby-prof
 - lib/ruby-prof/abstract_printer.rb
+- lib/ruby-prof/aggregate_call_info.rb
 - lib/ruby-prof/call_info.rb
 - lib/ruby-prof/call_tree_printer.rb
 - lib/ruby-prof/flat_printer.rb
 - lib/ruby-prof/graph_html_printer.rb
 - lib/ruby-prof/graph_printer.rb
+- lib/ruby-prof/group_by.rb
 - lib/ruby-prof/method_info.rb
 - lib/ruby-prof/task.rb
 - lib/ruby-prof/test.rb
@@ -63,7 +65,9 @@ files:
 - rails/environment/profile.rb
 - rails/example
 - rails/example/example_test.rb
+- rails/example/example_test.rb.html
 - rails/profile_test_helper.rb
+- test/aggregate_test.rb
 - test/basic_test.rb
 - test/duplicate_names_test.rb
 - test/exceptions_test.rb
@@ -75,7 +79,6 @@ files:
 - test/prime.rb
 - test/prime_test.rb
 - test/printers_test.rb
-- test/profile_unit_test.rb
 - test/recursive_test.rb
 - test/singleton_test.rb
 - test/stack_test.rb
@@ -105,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby-prof
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Fast Ruby profiler

data/test/profile_unit_test.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-require 'test/unit'
-require 'ruby-prof'
-
-# Need to use wall time for this test due to the sleep calls
-RubyProf::measure_mode = RubyProf::WALL_TIME
-
-# --  Tests ----
-class ProfileTest < Test::Unit::TestCase
-  include RubyProf::Test
-  
-  def teardown
-    profile_dir = output_dir
-    
-    #file_path = File.join(profile_dir, 'test_profile_profile_test.html')
-    #assert(File.exists?(file_path))
-  end
-  
-  def test_profile
-    sleep(1)    
-  end
-end