ruby-prof 0.18.0 → 1.0.0

data/lib/ruby-prof/printers/call_tree_printer.rb

@@ -5,14 +5,25 @@ require 'thread'
 require 'fileutils'
 
 module RubyProf
-  # Generate profiling information in callgrind format for use by
+  # Generates profiling information in callgrind format for use by
   # kcachegrind and similar tools.
-  #
-  # Note: when profiling for a callgrind printer, one should use the
-  # merge_fibers: true option when creating the profile. Otherwise
-  # each fiber would appear as a separate profile.
 
   class CallTreePrinter < AbstractPrinter
+    def calltree_name(method_info)
+      klass_path = method_info.klass_name.gsub("::", '/')
+      result = "#{klass_path}::#{method_info.method_name}"
+
+      case method_info.klass_flags
+        when 0x2
+          "#{result}^"
+        when 0x4
+          "#{result}^"
+        when 0x8
+         "#{result}*"
+        else
+         result
+      end
+    end
 
     def determine_event_specification_and_value_scale
       @event_specification = "events: "
@@ -23,9 +34,6 @@ module RubyProf
         when RubyProf::WALL_TIME
           @value_scale = 1_000_000
           @event_specification << 'wall_time'
-        when RubyProf.const_defined?(:CPU_TIME) && RubyProf::CPU_TIME
-          @value_scale = RubyProf.cpu_frequency
-          @event_specification << 'cpu_time'
         when RubyProf.const_defined?(:ALLOCATIONS) && RubyProf::ALLOCATIONS
           @value_scale = 1
           @event_specification << 'allocations'
@@ -72,7 +80,7 @@ module RubyProf
     end
 
     def file(method)
-      File.expand_path(method.source_file)
+      method.source_file ? File.expand_path(method.source_file) : ''
     end
 
     def print_thread(thread)
@@ -123,15 +131,15 @@ module RubyProf
     def print_method(output, method)
       # Print out the file and method name
       output << "fl=#{file(method)}\n"
-      output << "fn=#{method.calltree_name}\n"
+      output << "fn=#{self.calltree_name(method)}\n"
 
       # Now print out the function line number and its self time
       output << "#{method.line} #{convert(method.self_time)}\n"
 
       # Now print out all the children methods
-      method.children.each do |callee|
+      method.callees.each do |callee|
         output << "cfl=#{file(callee.target)}\n"
-        output << "cfn=#{callee.target.calltree_name}\n"
+        output << "cfn=#{self.calltree_name(callee.target)}\n"
         output << "calls=#{callee.called} #{callee.line}\n"
 
         # Print out total times here!

data/lib/ruby-prof/printers/dot_printer.rb

@@ -4,6 +4,7 @@ require 'set'
 
 module RubyProf
   # Generates a graphviz graph in dot format.
+  #
   # To use the dot printer:
   #
   #   result = RubyProf.profile do
@@ -84,7 +85,7 @@ module RubyProf
         total_percentage = (method.total_time/total_time) * 100
 
         next if total_percentage < min_percent
-        name = method_name(method).split("#").last
+        name = method.full_name.split("#").last
         puts "#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];"
         @seen_methods << method
         print_edges(total_time, method)
@@ -113,13 +114,12 @@ module RubyProf
     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
+      method.callers.sort_by(&:total_time).reverse.each do |call_info|
+        target_percentage = (call_info.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}];"
+        puts "#{dot_id(method)} -> #{dot_id(call_info.target)} [label=\"#{call_info.called}/#{call_info.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];"
       end
     end
 

data/lib/ruby-prof/printers/flat_printer.rb

@@ -19,21 +19,8 @@ module RubyProf
 
     private
 
-    #def print_threads
-    #  @result.threads.each do |thread|
-    #    print_thread(thread)
-    #    @output << "\n" * 2
-    #  end
-    #end
-
-    def print_header(thread)
-      @output << "Measure Mode: %s\n" % RubyProf.measure_mode_string
-      @output << "Thread ID: %d\n" % thread.id
-      @output << "Fiber ID: %d\n" % thread.fiber_id unless thread.id == thread.fiber_id
-      @output << "Total: %0.6f\n" % thread.total_time
-      @output << "Sort by: #{sort_method}\n"
-      @output << "\n"
-      @output << " %self      total      self      wait     child     calls  name\n"
+    def print_column_headers
+      @output << " %self      total      self      wait     child     calls  name                           location\n"
     end
 
     def print_methods(thread)
@@ -49,7 +36,7 @@ module RubyProf
         #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  %9.3f %9.3f %9.3f %9.3f %8d  %s%s\n" % [
+        @output << "%6.2f  %9.3f %9.3f %9.3f %9.3f %8d  %s%-30s %s\n" % [
                       method.self_time / total_time * 100, # %self
                       method.total_time,                   # total
                       method.self_time,                    # self
@@ -57,14 +44,9 @@ module RubyProf
                       method.children_time,                # children
                       method.called,                       # calls
                       method.recursive? ? "*" : " ",       # cycle
-                      method_name(method)                  # name
-                  ]
+                      method.full_name,                    # method_name]
+                      method_location(method)]             # location]
       end
     end
-
-    def print_footer(thread)
-      @output << "\n"
-      @output << "* indicates recursively called methods\n"
-    end
   end
-end
+end

data/lib/ruby-prof/printers/graph_html_printer.rb

@@ -14,33 +14,18 @@ module RubyProf
   #   printer.print(STDOUT, :min_percent=>0)
   #
   # The Graph printer takes the following options in its print methods:
-  #   :filename    - specify a file to use that contains the ERB
-  #                  template to use, instead of the built-in self.template
-  #
-  #   :template    - specify an ERB template to use, instead of the
-  #                  built-in self.template
-  #
-  #    :editor_uri - Specifies editor uri scheme used for opening files
-  #                  e.g. :atm or :mvim. For OS X default is :txmt.
-  #                  Use RUBY_PROF_EDITOR_URI environment variable to overide.
 
   class GraphHtmlPrinter < AbstractPrinter
     include ERB::Util
 
     def setup_options(options)
       super(options)
-
-      filename = options[:filename]
-      template = filename ? File.read(filename).untaint : (options[:template] || self.template)
-      @erb = ERB.new(template)
-      @erb.filename = filename
+      @erb = ERB.new(self.template)
     end
 
     def print(output = STDOUT, options = {})
-      @output = output
       setup_options(options)
-      @editor = editor_uri
-      @output << @erb.result(binding).split("\n").map(&:rstrip).join("\n") << "\n"
+      output << @erb.result(binding)
     end
 
     # Creates a link to a method.  Note that we do not create
@@ -63,187 +48,17 @@ module RubyProf
     end
 
     def file_link(path, linenum)
-      srcfile = File.expand_path(path)
-      if srcfile =~ /\/ruby_runtime$/
+      if path.nil?
         ""
       else
-        if @editor
-          "<a href=\"#{@editor}://" \
-          "open?url=file://#{h srcfile}&line=#{linenum}\"" \
-          "title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
-        else
-          "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
-        end
+        srcfile = File.expand_path(path)
+        "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
       end
     end
 
     def template
-'
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-  <style media="all" type="text/css">
-    table {
-      border-collapse: collapse;
-      border: 1px solid #CCC;
-      font-family: Verdana, Arial, Helvetica, sans-serif;
-      font-size: 9pt;
-      line-height: normal;
-      width: 100%;
-    }
-
-    th {
-      text-align: center;
-      border-top: 1px solid #FB7A31;
-      border-bottom: 1px solid #FB7A31;
-      background: #FFC;
-      padding: 0.3em;
-      border-left: 1px solid silver;
-    }
-
-    tr.break td {
-      border: 0;
-      border-top: 1px solid #FB7A31;
-      padding: 0;
-      margin: 0;
-    }
-
-    tr.method td {
-      font-weight: bold;
-    }
-
-    td {
-      padding: 0.3em;
-    }
-
-    td:first-child {
-      width: 190px;
-      }
-
-    td {
-      border-left: 1px solid #CCC;
-      text-align: center;
-    }
-
-    .method_name {
-      text-align: left;
-    }
-
-    tfoot td {
-      text-align: left;
-    }
-  </style>
-  </head>
-  <body>
-    <h1>Profile Report: <%= RubyProf.measure_mode_string %></h1>
-    <!-- Threads Table -->
-    <table>
-      <tr>
-        <th>Thread ID</th>
-        <th>Fiber ID</th>
-        <th>Total Time</th>
-      </tr>
-      <% for thread in @result.threads %>
-      <tr>
-        <td><%= thread.id %></td>
-        <td><a href="#<%= thread.fiber_id %>"><%= thread.fiber_id %></a></td>
-        <td><%= thread.total_time %></td>
-      </tr>
-      <% end %>
-    </table>
-    <!-- Methods Tables -->
-    <%
-       for thread in @result.threads
-         methods = thread.methods
-         total_time = thread.total_time
-    %>
-      <h2><a name="<%= thread.fiber_id %>">Thread <%= thread.id %>, Fiber: <%= thread.fiber_id %></a></h2>
-      <table>
-        <thead>
-          <tr>
-            <th>%Total</th>
-            <th>%Self</th>
-            <th>Total</th>
-            <th>Self</th>
-            <th>Wait</th>
-            <th>Child</th>
-            <th>Calls</th>
-            <th class="method_name">Name</th>
-            <th>Line</th>
-          </tr>
-        </thead>
-        <tbody>
-          <%
-             min_time = @options[:min_time] || (@options[:nonzero] ? 0.005 : nil)
-             methods.sort_by(&sort_method).reverse_each do |method|
-               total_percentage = (method.total_time/total_time) * 100
-               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
-                    next if min_time && caller.total_time < min_time
-               %>
-                 <tr>
-                   <td>&nbsp;</td>
-                   <td>&nbsp;</td>
-                   <td><%= sprintf("%.2f", caller.total_time) %></td>
-                   <td><%= sprintf("%.2f", caller.self_time) %></td>
-                   <td><%= sprintf("%.2f", caller.wait_time) %></td>
-                   <td><%= sprintf("%.2f", caller.children_time) %></td>
-                   <td><%= "#{caller.called}/#{method.called}" %></td>
-                   <td class="method_name"><%= create_link(thread, total_time, caller.parent.target) %></td>
-                   <td><%= file_link(caller.parent.target.source_file, caller.line) %></td>
-                 </tr>
-               <% end %>
-               <tr class="method">
-                 <td><%= sprintf("%.2f%%", total_percentage) %></td>
-                 <td><%= sprintf("%.2f%%", self_percentage) %></td>
-                 <td><%= sprintf("%.2f", method.total_time) %></td>
-                 <td><%= sprintf("%.2f", method.self_time) %></td>
-                 <td><%= sprintf("%.2f", method.wait_time) %></td>
-                 <td><%= sprintf("%.2f", method.children_time) %></td>
-                 <td><%= sprintf("%i", method.called) %></td>
-                 <td class="method_name">
-                   <a name="<%= method_href(thread, method) %>">
-                     <%= method.recursive? ? "*" : " "%><%= h method.full_name %>
-                   </a>
-                 </td>
-                 <td><%= file_link(method.source_file, method.line) %></td>
-               </tr>
-               <!-- Children -->
-               <%
-                  for callee in method.aggregate_children.sort_by(&:total_time).reverse
-                    next if min_time && callee.total_time < min_time
-               %>
-                 <tr>
-                   <td>&nbsp;</td>
-                   <td>&nbsp;</td>
-                   <td><%= sprintf("%.2f", callee.total_time) %></td>
-                   <td><%= sprintf("%.2f", callee.self_time) %></td>
-                   <td><%= sprintf("%.2f", callee.wait_time) %></td>
-                   <td><%= sprintf("%.2f", callee.children_time) %></td>
-                   <td><%= "#{callee.called}/#{callee.target.called}" %></td>
-                   <td class="method_name"><%= create_link(thread, total_time, callee.target) %></td>
-                   <td><%= file_link(method.source_file, callee.line) %></td>
-                 </tr>
-               <% end %>
-               <!-- Create divider row -->
-               <tr class="break"><td colspan="9"></td></tr>
-          <% end %>
-        </tbody>
-        <tfoot>
-          <tr>
-            <td colspan="9">* indicates recursively called methods</td>
-          </tr>
-        </tfoot>
-      </table>
-    <% end %>
-  </body>
-</html>'
+      path = File.expand_path(File.join(__FILE__, '..', '..', 'assets', 'graph_printer.html.erb'))
+      File.read(path, :mode => 'rb')
     end
   end
 end

data/lib/ruby-prof/printers/graph_printer.rb

@@ -20,10 +20,14 @@ module RubyProf
 
     private
 
+    def sort_method
+      @options[:sort_method] || :total_time
+    end
+
     def print_header(thread)
       @output << "Measure Mode: %s\n" % RubyProf.measure_mode_string
       @output << "Thread ID: #{thread.id}\n"
-      @output << "Fiber ID: #{thread.fiber_id}\n" unless thread.id == thread.fiber_id
+      @output << "Fiber ID: #{thread.fiber_id}\n"
       @output << "Total Time: #{thread.total_time}\n"
       @output << "Sort by: #{sort_method}\n"
       @output << "\n"
@@ -37,6 +41,7 @@ module RubyProf
       @output << sprintf("%#{TIME_WIDTH}s", "child")
       @output << sprintf("%#{CALL_WIDTH}s", "calls")
       @output << "     name"
+      @output << "                          location"
       @output << "\n"
     end
 
@@ -52,7 +57,7 @@ module RubyProf
 
         self_percentage = (method.self_time/total_time) * 100
 
-        @output << "-" * 80 << "\n"
+        @output << "-" * 150 << "\n"
         print_parents(thread, method)
 
         # 1 is for % sign
@@ -64,10 +69,8 @@ module RubyProf
         @output << sprintf("%#{TIME_WIDTH}.3f", method.children_time)
         @output << sprintf("%#{CALL_WIDTH}i", method.called)
         @output << sprintf("    %s",  method.recursive? ? "*" : " ")
-        @output << sprintf("%s", method_name(method))
-        if print_file
-          @output << sprintf("  %s:%s", method.source_file, method.line)
-        end
+        @output << sprintf("%-30s", method.full_name)
+        @output << sprintf(" %s", method_location(method))
         @output << "\n"
 
         print_children(method)
@@ -75,8 +78,8 @@ module RubyProf
     end
 
     def print_parents(thread, method)
-      method.aggregate_parents.sort_by(&:total_time).each do |caller|
-        next unless caller.parent
+      return if method.root?
+      method.callers.sort_by(&:total_time).each do |caller|
         @output << " " * 2 * PERCENTAGE_WIDTH
         @output << sprintf("%#{TIME_WIDTH}.3f", caller.total_time)
         @output << sprintf("%#{TIME_WIDTH}.3f", caller.self_time)
@@ -85,13 +88,13 @@ module RubyProf
 
         call_called = "#{caller.called}/#{method.called}"
         @output << sprintf("%#{CALL_WIDTH}s", call_called)
-        @output << sprintf("     %s", caller.parent.target.full_name)
+        @output << sprintf("     %s", caller.parent.full_name)
         @output << "\n"
       end
     end
 
     def print_children(method)
-      method.aggregate_children.sort_by(&:total_time).reverse.each do |child|
+      method.callees.sort_by(&:total_time).reverse.each do |child|
         # Get children method
 
         @output << " " * 2 * PERCENTAGE_WIDTH
@@ -107,10 +110,5 @@ module RubyProf
         @output << "\n"
       end
     end
-
-    def print_footer(thread)
-      @output << "\n"
-      @output << "* indicates recursively called methods\n"
-    end
   end
 end