ruby-prof 0.8.2 → 0.9.0

data/lib/ruby-prof/call_tree_printer.rb

@@ -8,7 +8,7 @@ module RubyProf
     def print(output = STDOUT, options = {})
       @output = output
       setup_options(options)
-        
+
       # add a header - this information is somewhat arbitrary
       @output << "events: "
       case RubyProf.measure_mode
@@ -56,7 +56,7 @@ module RubyProf
     end
 
     def print_methods(thread_id, methods)
-      methods.reverse_each do |method| 
+      methods.reverse_each do |method|
         # Print out the file and method name
         @output << "fl=#{file(method)}\n"
         @output << "fn=#{method_name(method)}\n"

data/lib/ruby-prof/dot_printer.rb

@@ -0,0 +1,151 @@
+require 'set'
+require 'ruby-prof/abstract_printer'
+
+module RubyProf
+  # Generates a graphviz graph in dot format.
+  # To use the dot printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::DotPrinter.new(result)
+  #   printer.print(STDOUT)
+  # 
+  # You can use either dot viewer such as GraphViz, or the dot command line tool
+  # to reformat the output into a wide variety of outputs:
+  # 
+  #   dot -Tpng graph.dot > graph.png
+  # 
+  class DotPrinter < RubyProf::AbstractPrinter  
+    CLASS_COLOR = '"#666666"'
+    EDGE_COLOR  = '"#666666"'
+    
+    # Creates the DotPrinter using a RubyProf::Result.
+    def initialize(result)
+      super(result)
+      @seen_methods = Set.new
+    end
+        
+    # Print a graph report to the provided output.
+    #  
+    # output - Any IO object, including STDOUT or a file. The default value is
+    # STDOUT.
+    #  
+    # options - Hash of print options.  See #setup_options 
+    #           for more information.
+    #
+    # When profiling results that cover a large number of method calls it
+    # helps to use the :min_percent option, for example:
+    #  
+    #   DotPrinter.new(result).print(STDOUT, :min_percent=>5)
+    # 
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+      
+      total_time = thread_times.values.inject{|a,b| a+b}
+      
+      puts 'digraph "Profile" {'
+      puts "label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
+      puts "labelloc=t;"
+      puts "labeljust=l;"
+      print_threads
+      puts '}'
+    end
+
+    private 
+    
+    # Something of a hack, figure out which constant went with the
+    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
+    # forget what measurement was made.
+    def mode_name
+      mode = RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
+    end
+    
+    # Computes the total time per thread:
+    def thread_times
+      @thread_times ||= begin
+        times = {}
+        @result.threads.each do |thread_id, methods|
+          toplevel = methods.sort.last
+
+          total_time = toplevel.total_time
+          # This looks like a hack for very small times... from GraphPrinter
+          total_time = 0.01 if total_time == 0 
+          times[thread_id] = total_time
+        end
+        
+        times
+      end
+    end
+    
+    def print_threads
+      # sort assumes that spawned threads have higher object_ids
+      @result.threads.sort.each do |thread_id, methods|
+        puts "subgraph \"Thread #{thread_id}\" {"
+        
+        print_methods(thread_id, methods)
+        puts "}"
+        
+        print_classes(thread_id, methods)
+      end
+    end
+    
+    # Determines an ID to use to represent the subject in the Dot file.
+    def dot_id(subject)
+      subject.object_id
+    end
+    
+    def print_methods(thread_id, methods)
+      total_time = thread_times[thread_id]
+      # Print each method in total time order
+      methods.reverse_each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+        self_percentage = (method.self_time/total_time) * 100
+        
+        next if total_percentage < min_percent
+        name = method_name(method).split("#").last
+        puts "#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];"
+        @seen_methods << method
+        print_edges(total_time, method)
+      end
+    end
+      
+    def print_classes(thread_id, methods)
+      methods.group_by{|m| m.klass_name}.each do |cls, methods|
+        # Filter down to just seen methods
+        big_methods, small_methods  = methods.partition{|m| @seen_methods.include? m}
+        
+        if !big_methods.empty?
+          puts "subgraph cluster_#{cls.object_id} {"
+          puts "label = \"#{cls}\";"
+          puts "fontcolor = #{CLASS_COLOR};"
+          puts "fontsize = 16;"
+          puts "color = #{CLASS_COLOR};"
+          big_methods.each do |m|
+            puts "#{m.object_id};"
+          end
+          puts "}"  
+        end        
+      end
+    end
+    
+    def print_edges(total_time, method)
+      method.aggregate_children.sort_by(&:total_time).reverse.each do |child|
+        
+        target_percentage = (child.target.total_time / total_time) * 100.0
+        next if target_percentage < min_percent
+        
+        # Get children method
+        puts "#{dot_id(method)} -> #{dot_id(child.target)} [label=\"#{child.called}/#{child.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];"
+      end
+    end
+    
+    # Silly little helper for printing to the @output
+    def puts(str)
+      @output.puts(str)
+    end
+    
+  end
+end

data/lib/ruby-prof/flat_printer.rb

@@ -1,7 +1,7 @@
 require 'ruby-prof/abstract_printer'
 
 module RubyProf
-  # Generates flat[link:files/examples/flat_txt.html] profile reports as text. 
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
   # To use the flat printer:
   #
   #   result = RubyProf.profile do
@@ -13,28 +13,28 @@ module RubyProf
   #
   class FlatPrinter < AbstractPrinter
     # Print a flat profile report to the provided output.
-    # 
-    # output - Any IO oject, including STDOUT or a file. 
+    #
+    # output - Any IO oject, including STDOUT or a file.
     # The default value is STDOUT.
-    # 
-    # options - Hash of print options.  See #setup_options 
+    #
+    # options - Hash of print options.  See #setup_options
     #           for more information.
     #
     def print(output = STDOUT, options = {})
       @output = output
       setup_options(options)
       print_threads
-    end      
-    
-    private 
-    
+    end
+
+    private
+
     def print_threads
       @result.threads.each do |thread_id, methods|
         print_methods(thread_id, methods)
         @output << "\n" * 2
       end
     end
-    
+
     def print_methods(thread_id, methods)
       # Get total time
       toplevel = methods.max
@@ -42,27 +42,27 @@ module RubyProf
       if total_time == 0
         total_time = 0.01
       end
-      
+
       # Now sort methods by largest self time,
       # not total time like in other printouts
       methods = methods.sort do |m1, m2|
         m1.self_time <=> m2.self_time
       end.reverse
-      
+
       @output << "Thread ID: %d\n" % thread_id
       @output << "Total: %0.6f\n" % total_time
       @output << "\n"
       @output << " %self     total     self     wait    child    calls  name\n"
 
-      sum = 0    
+      sum = 0
       methods.each do |method|
         self_percent = (method.self_time / total_time) * 100
         next if self_percent < min_percent
-        
+
         sum += method.self_time
         #self_time_called = method.called > 0 ? method.self_time/method.called : 0
         #total_time_called = method.called > 0? method.total_time/method.called : 0
-        
+
         @output << "%6.2f  %8.2f %8.2f %8.2f %8.2f %8d  %s\n" % [
                       method.self_time / total_time * 100, # %self
                       method.total_time,                   # total
@@ -75,4 +75,4 @@ module RubyProf
       end
     end
   end
-end
+end

data/lib/ruby-prof/flat_printer_with_line_numbers.rb

@@ -1,7 +1,7 @@
 require 'ruby-prof/abstract_printer'
 require 'pathname'
 module RubyProf
-  # Generates flat[link:files/examples/flat_txt.html] profile reports as text. 
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
   # To use the flat printer with line numbers:
   #
   #   result = RubyProf.profile do
@@ -20,26 +20,26 @@ module RubyProf
       if total_time == 0
         total_time = 0.01
       end
-      
+
       # Now sort methods by largest self time,
       # not total time like in other printouts
       methods = methods.sort do |m1, m2|
         m1.self_time <=> m2.self_time
       end.reverse
-      
+
       @output << "Thread ID: %d\n" % thread_id
       @output << "Total: %0.6f\n" % total_time
       @output << "\n"
       @output << " %self     total     self     wait    child    calls  name\n"
-      sum = 0    
+      sum = 0
       methods.each do |method|
         self_percent = (method.self_time / total_time) * 100
         next if self_percent < min_percent
-        
+
         sum += method.self_time
         #self_time_called = method.called > 0 ? method.self_time/method.called : 0
         #total_time_called = method.called > 0? method.total_time/method.called : 0
-        
+
         @output << "%6.2f  %8.2f %8.2f %8.2f %8.2f %8d  %s " % [
                       method.self_time / total_time * 100, # %self
                       method.total_time,                   # total
@@ -47,26 +47,26 @@ module RubyProf
                       method.wait_time,                    # wait
                       method.children_time,                # children
                       method.called,                       # calls
-                      method_name(method),                 # name                      
+                      method_name(method),                 # name
                   ]
          if method.source_file != 'ruby_runtime'
            @output << "  %s:%s" % [File.expand_path(method.source_file), method.line]
          end
          @output << "\n\tcalled from: "
-         
+
          # make sure they're unique
-         method.call_infos.map{|ci| 
+         method.call_infos.map{|ci|
            if ci.parent && ci.parent.target.source_file != 'ruby_runtime'
               [method_name(ci.parent.target), File.expand_path(ci.parent.target.source_file), ci.parent.target.line]
            else
               nil
-           end 
+           end
          }.compact.uniq.each{|args|
-             @output << " %s (%s:%s) " % args             
+             @output << " %s (%s:%s) " % args
          }
-         @output << "\n\n"         
+         @output << "\n\n"
       end
     end
   end
-end 
+end
 

data/lib/ruby-prof/graph_html_printer.rb

@@ -2,8 +2,8 @@ require 'ruby-prof/abstract_printer'
 require 'erb'
 
 module RubyProf
-  # Generates graph[link:files/examples/graph_html.html] profile reports as html. 
-  # To use the grap html printer:
+  # Generates graph[link:files/examples/graph_html.html] profile reports as html.
+  # To use the graph html printer:
   #
   #   result = RubyProf.profile do
   #     [code to profile]
@@ -14,20 +14,20 @@ module RubyProf
   #
   # The constructor takes two arguments.  The first is
   # a RubyProf::Result object generated from a profiling
-  # run.  The second is the minimum %total (the methods 
+  # run.  The second is the minimum %total (the methods
   # total time divided by the overall total time) that
-  # a method must take for it to be printed out in 
+  # a method must take for it to be printed out in
   # the report.  Use this parameter to eliminate methods
   # that are not important to the overall profiling results.
-  
+
   class GraphHtmlPrinter < AbstractPrinter
     include ERB::Util
-    
+
     PERCENTAGE_WIDTH = 8
     TIME_WIDTH = 10
     CALL_WIDTH = 20
-  
-    # Create a GraphPrinter.  Result is a RubyProf::Result  
+
+    # Create a GraphPrinter.  Result is a RubyProf::Result
     # object generated from a profiling run.
     def initialize(result)
       super(result)
@@ -36,17 +36,17 @@ module RubyProf
     end
 
     # Print a graph html report to the provided output.
-    # 
-    # output - Any IO oject, including STDOUT or a file. 
+    #
+    # output - Any IO oject, including STDOUT or a file.
     # The default value is STDOUT.
-    # 
-    # options - Hash of print options.  See #setup_options 
+    #
+    # options - Hash of print options.  See #setup_options
     #           for more information.
     #
     def print(output = STDOUT, options = {})
       @output = output
       setup_options(options)
-      
+
       filename = options[:filename]
       template = filename ? File.read(filename).untaint : (options[:template] || self.template)
       _erbout = @output
@@ -55,38 +55,46 @@ module RubyProf
       @output << erb.result(binding)
     end
 
+    def total_time(call_infos)
+      sum(call_infos.map{|ci| ci.total_time})
+    end
+
+    def sum(a)
+      a.inject(0.0){|s,t| s+=t}
+    end
+
     # These methods should be private but then ERB doesn't
-    # work.  Turn off RDOC though 
+    # work.  Turn off RDOC though
     #--
     def calculate_thread_times
       # Cache thread times since this is an expensive
-      # operation with the required sorting      
+      # operation with the required sorting
+      @overall_threads_time = 0.0
+      @thread_times = Hash.new
       @result.threads.each do |thread_id, methods|
-        top = methods.max
-        
-        thread_time = 0.01
-        thread_time = top.total_time if top.total_time > 0
-
-        @thread_times[thread_id] = thread_time 
+        roots = methods.select{|m| m.root?}
+        thread_total_time = sum(roots.map{|r| self.total_time(r.call_infos)})
+        @overall_threads_time += thread_total_time
+        @thread_times[thread_id] = thread_total_time
       end
     end
-    
+
     def thread_time(thread_id)
       @thread_times[thread_id]
     end
-   
+
     def total_percent(thread_id, method)
       overall_time = self.thread_time(thread_id)
       (method.total_time/overall_time) * 100
     end
-    
+
     def self_percent(method)
       overall_time = self.thread_time(method.thread_id)
       (method.self_time/overall_time) * 100
     end
 
     # Creates a link to a method.  Note that we do not create
-    # links to methods which are under the min_perecent 
+    # links to methods which are under the min_perecent
     # specified by the user, since they will not be
     # printed out.
     def create_link(thread_id, method)
@@ -95,14 +103,27 @@ module RubyProf
         h method.full_name
       else
         href = '#' + method_href(thread_id, method)
-        "<a href=\"#{href}\">#{h method.full_name}</a>" 
+        "<a href=\"#{href}\">#{h method.full_name}</a>"
       end
     end
-    
+
     def method_href(thread_id, method)
       h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread_id.to_s)
     end
-    
+
+    def file_link(path, linenum)
+      srcfile = File.expand_path(path)
+      if srcfile =~ /\/ruby_runtime$/
+        ""
+      else
+        if RUBY_PLATFORM =~ /darwin/
+          "<a href=\"txmt://open?url=file://#{h srcfile}&line=#{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
+        else
+          "<a href=\"file://#{h srcfile}?line=#{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
+        end
+      end
+    end
+
     def template
 '
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
@@ -149,7 +170,7 @@ module RubyProf
     td {
       border-left: 1px solid #CCC;
       text-align: center;
-    } 
+    }
 
     .method_name {
       text-align: left;
@@ -164,7 +185,7 @@ module RubyProf
         <th>Thread ID</th>
         <th>Total Time</th>
       </tr>
-      <% for thread_id, methods in @result.threads %>
+      <% for thread_id in @result.threads.keys.sort %>
       <tr>
         <td><a href="#<%= thread_id %>"><%= thread_id %></a></td>
         <td><%= thread_time(thread_id) %></td>
@@ -173,7 +194,8 @@ module RubyProf
     </table>
 
     <!-- Methods Tables -->
-    <% for thread_id, methods in @result.threads
+    <% for thread_id in @result.threads.keys.sort
+         methods = @result.threads[thread_id]
          total_time = thread_time(thread_id) %>
       <h2><a name="<%= thread_id %>">Thread <%= thread_id %></a></h2>
 
@@ -196,7 +218,7 @@ module RubyProf
             next if total_percentage < min_percent
             next if min_time && method.total_time < min_time
             self_percentage = (method.self_time/total_time) * 100 %>
-          
+
             <!-- Parents -->
             <% for caller in method.aggregate_parents.sort_by(&:total_time)
                  next unless caller.parent
@@ -211,7 +233,7 @@ module RubyProf
                 <% called = "#{caller.called}/#{method.called}" %>
                 <td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
                 <td class="method_name"><%= create_link(thread_id, caller.parent.target) %></td>
-                <td><a href="file://<%=h srcfile=File.expand_path(caller.parent.target.source_file) %>#line=<%= linenum=caller.line %>" title="<%=h srcfile %>:<%= linenum %>"><%= caller.line %></a></td>
+                <td><%= file_link(caller.parent.target.source_file, caller.line) %></td>
               </tr>
             <% end %>
 
@@ -224,7 +246,7 @@ module RubyProf
               <td><%= sprintf("%#{TIME_WIDTH}.2f", method.children_time) %></td>
               <td><%= sprintf("%#{CALL_WIDTH}i", method.called) %></td>
               <td class="method_name"><a name="<%= method_href(thread_id, method) %>"><%= h method.full_name %></a></td>
-              <td><a href="file://<%=h srcfile=File.expand_path(method.source_file) %>#line=<%= linenum=method.line %>" title="<%=h srcfile %>:<%= linenum %>"><%= method.line %></a></td>
+              <td><%= file_link(method.source_file, method.line) %></td>
             </tr>
 
             <!-- Children -->
@@ -240,7 +262,7 @@ module RubyProf
                 <% called = "#{callee.called}/#{callee.target.called}" %>
                 <td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
                 <td class="method_name"><%= create_link(thread_id, callee.target) %></td>
-                <td><a href="file://<%=h srcfile=File.expand_path(method.source_file) %>#line=<%= linenum=callee.line %>" title="<%=h srcfile %>:<%= linenum %>"><%= callee.line %></a></td>
+                <td><%= file_link(method.source_file, callee.line) %></td>
               </tr>
             <% end %>
             <!-- Create divider row -->
@@ -252,5 +274,5 @@ module RubyProf
 </html>'
     end
   end
-end 
+end