ruby-prof 0.15.8 → 0.15.9

data/examples/graph.txt

@@ -1,170 +1,139 @@
-= Graph Profiles
-
-Graph profiles show how long each method runs, which methods call it
-and which methods it calls.
-
-As an example, here is the output from running printers_test.rb:
-
-
-Thread ID: 21277412
-  %total   %self     total      self    children               calls   Name
- --------------------------------------------------------------------------------
- 100.00%   0.00%      8.77      0.00      8.77                   1     #toplevel
-                      8.77      0.00      8.77                 1/1     Object#run_primes
- --------------------------------------------------------------------------------
-                      8.77      0.00      8.77                 1/1     #toplevel
- 100.00%   0.00%      8.77      0.00      8.77                   1     Object#run_primes
-                      0.02      0.00      0.02                 1/1     Object#make_random_array
-                      2.09      0.00      2.09                 1/1     Object#find_largest
-                      6.66      0.00      6.66                 1/1     Object#find_primes
- --------------------------------------------------------------------------------
-                      6.63      4.06      2.56             500/501     Object#is_prime
-                      2.09      0.00      2.09               1/501     Object#find_largest
-  99.48%  46.34%      8.72      4.06      4.66                 501     Integer#upto
-                      0.00      0.00      0.00               61/61     Array#[]
-                      0.00      0.00      0.00               61/61     Fixnum#>
-                      2.09      2.09      0.00               61/61     Kernel.sleep
-                      1.24      1.24      0.00       250862/250862     Fixnum#==
-                      1.33      1.33      0.00       250862/250862     Fixnum#%
- --------------------------------------------------------------------------------
-                      6.66      0.01      6.64                 1/1     Object#find_primes
-  75.93%   0.17%      6.66      0.01      6.64                   1     Array#select
-                      6.64      0.01      6.63             500/500     Object#is_prime
- --------------------------------------------------------------------------------
-                      6.66      0.00      6.66                 1/1     Object#run_primes
-  75.93%   0.00%      6.66      0.00      6.66                   1     Object#find_primes
-                      6.66      0.01      6.64                 1/1     Array#select
- --------------------------------------------------------------------------------
-                      6.64      0.01      6.63             500/500     Array#select
-  75.76%   0.17%      6.64      0.01      6.63                 500     Object#is_prime
-                      0.00      0.00      0.00             500/501     Fixnum#-
-                      6.63      4.06      2.56             500/501     Integer#upto
- --------------------------------------------------------------------------------
-                      2.09      0.00      2.09                 1/1     Object#run_primes
-  23.89%   0.00%      2.09      0.00      2.09                   1     Object#find_largest
-                      0.00      0.00      0.00               1/501     Fixnum#-
-                      2.09      0.00      2.09               1/501     Integer#upto
-                      0.00      0.00      0.00                 1/1     Array#first
-                      0.00      0.00      0.00                 1/1     Array#length
- --------------------------------------------------------------------------------
-                      2.09      2.09      0.00               61/61     Integer#upto
-  23.89%  23.89%      2.09      2.09      0.00                  61     Kernel.sleep
- --------------------------------------------------------------------------------
-                      1.33      1.33      0.00       250862/250862     Integer#upto
-  15.12%  15.12%      1.33      1.33      0.00              250862     Fixnum#%
- --------------------------------------------------------------------------------
-                      1.24      1.24      0.00       250862/250862     Integer#upto
-  14.13%  14.13%      1.24      1.24      0.00              250862     Fixnum#==
- --------------------------------------------------------------------------------
-                      0.02      0.00      0.02                 1/1     Object#run_primes
-   0.18%   0.00%      0.02      0.00      0.02                   1     Object#make_random_array
-                      0.02      0.02      0.00                 1/1     Array#each_index
-                      0.00      0.00      0.00                 1/1     Class#new
- --------------------------------------------------------------------------------
-                      0.02      0.02      0.00                 1/1     Object#make_random_array
-   0.18%   0.18%      0.02      0.02      0.00                   1     Array#each_index
-                      0.00      0.00      0.00             500/500     Kernel.rand
-                      0.00      0.00      0.00             500/500     Array#[]=
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00             500/501     Object#is_prime
-                      0.00      0.00      0.00               1/501     Object#find_largest
-   0.00%   0.00%      0.00      0.00      0.00                 501     Fixnum#-
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00                 1/1     Kernel.rand
-   0.00%   0.00%      0.00      0.00      0.00                   1     Integer#to_int
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00                 1/1     Object#find_largest
-   0.00%   0.00%      0.00      0.00      0.00                   1     Array#first
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00                 1/1     Class#new
-   0.00%   0.00%      0.00      0.00      0.00                   1     Array#initialize
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00                 1/1     Object#find_largest
-   0.00%   0.00%      0.00      0.00      0.00                   1     Array#length
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00                 1/1     Object#make_random_array
-   0.00%   0.00%      0.00      0.00      0.00                   1     Class#new
-                      0.00      0.00      0.00                 1/1     Array#initialize
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00               61/61     Integer#upto
-   0.00%   0.00%      0.00      0.00      0.00                  61     Fixnum#>
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00               61/61     Integer#upto
-   0.00%   0.00%      0.00      0.00      0.00                  61     Array#[]
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00             500/500     Array#each_index
-   0.00%   0.00%      0.00      0.00      0.00                 500     Array#[]=
- --------------------------------------------------------------------------------
-                      0.00      0.00      0.00             500/500     Array#each_index
-   0.00%   0.00%      0.00      0.00      0.00                 500     Kernel.rand
-                      0.00      0.00      0.00                 1/1     Integer#to_int
-
-
-
-== Overview
-Dashed lines divide the report into entries, with one entry
-per method.  Entries are sorted by total time which is the 
-time spent in the method plus its children. 
-
-Each entry has a primary line demarked by values in the 
-%total and %self columns.  The primary line represents 
-the method being profiled.  Lines above it are the methods
-that called this method (parents) while the lines below it
-are the methods it called (children).
-
-All values are in seconds.  For the primary line, the columns represent:
-
-	%total       - The percentage of time spent in this method and its children
-	%self        - The percentage of time spent in this method
-	total        - The time spent in this method and its children.
-	self         - The time spent in this method.
-	children     - The time spent in this method's children.
-	calls        - The number of times this method was called.
-	name         - The name of the method.
-  
-The interpretation of method names is:
-* #toplevel - The root method that calls all other methods
-* MyObject#test - An instance method "test" of the class "MyObject"
-* <Object:MyObject>#test - The <> characters indicate a singleton method on a singleton class.
-
-For example, we see that 99.48% of the time was spent in Integer#upto and its children.
-Of that time, 4.06 seconds was spent in Integer#upto itself and 4.66 in its children.
-Overall, Integer#upto was called 501 times.
-
-== Parents
-In each entry, the lines above the primary line are the methods that 
-called the current method.  If the current method is a root method then
-no parents are shown.
-
-
-For parent lines, the columns represent:
-
-	total        - The time spent in the current method and it children on behalf of the parent method.
-	self         - The time spent in this method on behalf of the parent method.
-	children     - The time spent in this method's children on behalf of the parent.
-	calls        - The number of times the parent method called this child
-  
-Looking at Integer#upto again, we see that it was called 500 times from Object#is_prime
-and 1 time from find_largest.  Of the 8.72 total seconds spent in Integer#upto, 6.63
-were done for Object#is_prime and 2.09 for Object#find_largest.
-
-
-== Children
-In each entry, the lines below the primary line are the methods that 
-the current method called.  If the current method is a leaf method then
-no children are shown.
-
-For children lines, the columns represent:
-
-	total        - The time spent in the child, and its children, on behalf of the current method
-	self         - The time spent in the child on behalf of the current method.
-	children     - The time spent in the child's children (ie, granchildren) in behalf of the current method
-	calls        - The number of times the child method was called by the current method.
-
-Taking our example of Integer#upto, we see that it called five other methods - Array#[],
-Fixnum#>, Kernel.sleep, Fixnum#= and Fixnum#%.  Looking at Kernel.sleep, we see that 
-its spent 2.09 seconds working for Integer#upto and its children spent 0 time working for
-Integer#upto.  To see the overall time Kernel.sleep took we would have to look up its entry
-in the graph table.
-
-
+= Graph Profiles
+
+Graph profiles show how long each method runs, which methods call it and which
+methods it calls.
+
+As an example, here is the output from running printers_test.rb:
+
+Measure Mode: wall_time
+Thread ID: 70310439543100
+Fiber ID: 70310456289620
+Total Time: 0.05264616012573242
+Sort by: total_time
+
+  %total   %self      total       self       wait      child            calls    name
+--------------------------------------------------------------------------------
+ 100.00%   0.01%      0.053      0.000      0.000      0.053                1      PrintersTest#setup
+                      0.053      0.000      0.000      0.053              1/1      Object#run_primes
+--------------------------------------------------------------------------------
+                      0.053      0.000      0.000      0.053              1/1      PrintersTest#setup
+  99.99%   0.01%      0.053      0.000      0.000      0.053                1      Object#run_primes
+                      0.052      0.000      0.000      0.052              1/1      Object#find_primes
+                      0.001      0.000      0.000      0.001              1/1      Object#make_random_array
+                      0.000      0.000      0.000      0.000              1/1      Object#find_largest
+--------------------------------------------------------------------------------
+                      0.052      0.000      0.000      0.052              1/1      Object#run_primes
+  98.35%   0.00%      0.052      0.000      0.000      0.052                1      Object#find_primes
+                      0.052      0.000      0.000      0.051              1/1      Array#select
+--------------------------------------------------------------------------------
+                      0.052      0.000      0.000      0.051              1/1      Object#find_primes
+  98.34%   0.61%      0.052      0.000      0.000      0.051                1      Array#select
+                      0.051      0.000      0.000      0.051        1000/1000      Object#is_prime
+--------------------------------------------------------------------------------
+                      0.051      0.000      0.000      0.051        1000/1000      Array#select
+  97.74%   0.93%      0.051      0.000      0.000      0.051             1000      Object#is_prime
+                      0.051      0.051      0.000      0.000        1000/1001      Integer#upto
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000           1/1001      Object#find_largest
+                      0.051      0.051      0.000      0.000        1000/1001      Object#is_prime
+  96.91%  96.91%      0.051      0.051      0.000      0.000             1001      Integer#upto
+--------------------------------------------------------------------------------
+                      0.001      0.000      0.000      0.001              1/1      Object#run_primes
+   1.51%   0.00%      0.001      0.000      0.000      0.001                1      Object#make_random_array
+                      0.001      0.000      0.000      0.000              1/1      Array#each_index
+                      0.000      0.000      0.000      0.000              1/1      Class#new
+--------------------------------------------------------------------------------
+                      0.001      0.000      0.000      0.000              1/1      Object#make_random_array
+   1.50%   0.56%      0.001      0.000      0.000      0.000                1      Array#each_index
+                      0.000      0.000      0.000      0.000        1000/1000      Kernel#rand
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000        1000/1000      Array#each_index
+   0.94%   0.72%      0.000      0.000      0.000      0.000             1000      Kernel#rand
+                      0.000      0.000      0.000      0.000        1000/1000      Kernel#respond_to_missing?
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000        1000/1000      Kernel#rand
+   0.22%   0.22%      0.000      0.000      0.000      0.000             1000      Kernel#respond_to_missing?
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000              1/1      Object#run_primes
+   0.12%   0.02%      0.000      0.000      0.000      0.000                1      Object#find_largest
+                      0.000      0.000      0.000      0.000           1/1001      Integer#upto
+                      0.000      0.000      0.000      0.000              1/1      Array#first
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000              1/1      Object#make_random_array
+   0.01%   0.00%      0.000      0.000      0.000      0.000                1      Class#new
+                      0.000      0.000      0.000      0.000              1/1      Array#initialize
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000              1/1      Class#new
+   0.01%   0.01%      0.000      0.000      0.000      0.000                1      Array#initialize
+--------------------------------------------------------------------------------
+                      0.000      0.000      0.000      0.000              1/1      Object#find_largest
+   0.00%   0.00%      0.000      0.000      0.000      0.000                1      Array#first
+
+
+== Overview
+
+Dashed lines divide the report into entries, with one entry per method.  Entries
+are sorted by total time which is the time spent in the method plus its
+children.
+
+Each entry has a primary line demarked by values in the %total and %self
+columns.  The primary line represents the method being profiled.  Lines above it
+are the methods that called this method (parents) while the lines below it are
+the methods it called (children).
+
+All values are in seconds.  For the primary line, the columns represent:
+
+   %total  - The percentage of time spent in this method and its children
+   %self   - The percentage of time spent in this method
+   total   - The time spent in this method and its children.
+   self    - The time spent in this method.
+   wait    - The time spent waiting for other threads in this method.
+   child   - The time spent in this method's children.
+   calls   - The number of times this method was called.
+   name    - The name of the method.
+
+The interpretation of method names is:
+   MyObject#test           - An instance method "test" of the class "MyObject"
+   <Object:MyObject>#test  - The <> characters indicate a singleton method on a singleton class.
+
+For example, we see that 97.74% of the time was spent in Object#is_prime and its
+children.  Of that time, almost everything was contributed by Integer#upto.
+Overall, Object#is_prime was called 1001 times and 1000 of those calls were made
+by Object#is_prime.
+
+
+== Parents
+
+In each entry, the lines above the primary line are the methods that called the
+current method.  If the current method is a root method then no parents are
+shown.
+
+For parent lines, the columns represent:
+
+   total  - The time spent in the current method and its children on behalf of the parent method.
+   self   - The time spent in this method on behalf of the parent method.
+   child  - The time spent in this method's children on behalf of the parent.
+   wait   - The time spent waiting for other threads in this method's children on behalf of the parent.
+   calls  - The number of times the parent method called the current method vs. the total number of calls of the current method.
+
+Looking at the main entry for Integer#upto, we see that it was called 1000 times
+from Object#is_prime and 1 time from find_largest.
+
+
+== Children
+
+In each entry, the lines below the primary line are the methods that
+the current method called.  If the current method is a leaf method then
+no children are shown.
+
+For children lines, the columns represent:
+
+   total  - The time spent in the child, and its descendants, on behalf of the current method
+   self	  - The time spent in the child on behalf of the current method.
+   wait	  - The time spent waiting for other threads in the child's and its descendants on behalf of the current method.
+   child  - The time spent in the child's descendants on behalf of the current method.
+   calls  - The number of times the child method was called by the current method vs. the total number of calls of the child method.
+
+If we look at the main entry for Objext#run_primes, we see that it called three
+other methods - Object#find_primes, Object#make_random_array and
+Object#find_largest.

data/ext/ruby_prof/extconf.rb

@@ -1,7 +1,12 @@
 require "mkmf"
 
+if RUBY_ENGINE != "ruby"
+  STDERR.puts("\n\n***** This gem is MRI-specific. It does not support #{RUBY_ENGINE}. *****\n\n")
+  exit(1)
+end
+
 if RUBY_VERSION < "1.9.3"
-  STDERR.puts("Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to 1.9.3 or higher")
+  STDERR.puts("\n\n***** Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to 1.9.3 or higher. *****\n\n")
   exit(1)
 end
 

data/lib/ruby-prof/aggregate_call_info.rb

@@ -2,13 +2,14 @@
 
 module RubyProf
   class AggregateCallInfo
-    attr_reader :call_infos
+    attr_reader :call_infos, :method_info
 
-    def initialize(call_infos)
+    def initialize(call_infos, method_info)
       if call_infos.length == 0
         raise(ArgumentError, "Must specify at least one call info.")
       end
       @call_infos = call_infos
+      @method_info = method_info
     end
 
     def target
@@ -30,23 +31,23 @@ module RubyProf
     end
 
     def total_time
-      aggregate_without_recursion(:total_time)
+      aggregate_roots(:total_time)
     end
 
     def self_time
-      aggregate_without_recursion(:self_time)
+      aggregate_roots(:self_time)
     end
 
     def wait_time
-      aggregate_without_recursion(:wait_time)
+      aggregate_roots(:wait_time)
     end
 
     def children_time
-      aggregate_without_recursion(:children_time)
+      aggregate_roots(:children_time)
     end
 
     def called
-      aggregate(:called)
+      aggregate_all(:called)
     end
 
     def to_s
@@ -55,15 +56,20 @@ module RubyProf
 
     private
 
-    def aggregate(method_name)
+    # return all call_infos which are not (grand) children of any other node in the list of given call_infos
+    def roots
+      @roots ||= method_info.recursive? ? CallInfo.roots_of(call_infos) : call_infos
+    end
+
+    def aggregate_all(method_name)
       call_infos.inject(0) do |sum, call_info|
         sum + call_info.send(method_name)
       end
     end
 
-    def aggregate_without_recursion(method_name)
-      call_infos.inject(0) do |sum, call_info|
-        call_info.recursive ? sum : sum + call_info.send(method_name)
+    def aggregate_roots(method_name)
+      roots.inject(0) do |sum, call_info|
+        sum + call_info.send(method_name)
       end
     end
   end

data/lib/ruby-prof/call_info.rb

@@ -11,28 +11,13 @@ module RubyProf
 
     attr_reader :recursive
 
-    def non_recursive?
-      @non_recursive
-    end
-
     def detect_recursion(visited_methods = Hash.new(0))
-      @recursive = (visited_methods[target] += 1) > 1
-      @non_recursive = true
-      children.each do |child|
-        @non_recursive = false if child.detect_recursion(visited_methods)
-      end
-      visited_methods.delete(target) if (visited_methods[target] -= 1) == 0
-      return !@non_recursive
-    end
-
-    def recalc_recursion(visited_methods = Hash.new(0))
-      return if @non_recursive
-      target.clear_cached_values_which_depend_on_recursiveness
       @recursive = (visited_methods[target] += 1) > 1
       children.each do |child|
-        child.recalc_recursion(visited_methods)
+        child.detect_recursion(visited_methods)
       end
       visited_methods.delete(target) if (visited_methods[target] -= 1) == 0
+      return @recursive
     end
 
     def children_time

data/lib/ruby-prof/method_info.rb

@@ -22,18 +22,10 @@ module RubyProf
       call_infos.each(&:detect_recursion)
     end
 
-    def recalc_recursion
-      call_infos.each(&:recalc_recursion)
-    end
-
-    def clear_cached_values_which_depend_on_recursiveness
-      @total_time = @self_time = @wait_time = @children_time = nil
-    end
-
     def called
       @called ||= begin
         call_infos.inject(0) do |sum, call_info|
-          sum += call_info.called
+          sum + call_info.called
         end
       end
     end
@@ -87,15 +79,7 @@ module RubyProf
     end
 
     def recursive?
-      call_infos.detect(&:recursive)
-    end
-
-    def non_recursive?
-      non_recursive == 1
-    end
-
-    def non_recursive
-      @non_recursive ||= call_infos.all?(&:non_recursive?) ? 1 : 0
+      (@recursive ||= call_infos.detect(&:recursive) ? :true : :false) == :true
     end
 
     def children
@@ -107,26 +91,26 @@ module RubyProf
     end
 
     def aggregate_parents
-      # Group call info's based on their parents
+      # group call infos based on their parents
       groups = self.call_infos.each_with_object({}) do |call_info, hash|
         key = call_info.parent ? call_info.parent.target : self
         (hash[key] ||= []) << call_info
       end
 
       groups.map do |key, value|
-        AggregateCallInfo.new(value)
+        AggregateCallInfo.new(value, self)
       end
     end
 
     def aggregate_children
-      # Group call info's based on their targets
+      # group call infos based on their targets
       groups = self.children.each_with_object({}) do |call_info, hash|
         key = call_info.target
         (hash[key] ||= []) << call_info
       end
 
       groups.map do |key, value|
-        AggregateCallInfo.new(value)
+        AggregateCallInfo.new(value, self)
       end
     end