airbnb-ruby-prof 0.0.1

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

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
+  # To use the flat printer with line numbers:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlatPrinterWithLineNumbers.new(result)
+  #   printer.print(STDOUT, {})
+  #
+  class FlatPrinterWithLineNumbers < FlatPrinter
+    def print_methods(thread)
+      total_time = thread.total_time
+
+      methods = thread.methods.sort_by(&sort_method).reverse
+      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  %9.3f %9.3f %9.3f %9.3f %8d  %s%s" % [
+            method.self_time / total_time * 100, # %self
+            method.total_time,                   # total
+            method.self_time,                    # self
+            method.wait_time,                    # wait
+            method.children_time,                # children
+            method.called,                       # calls
+            method.recursive? ? "*" : " ",       # cycle
+            method_name(method)                  # name
+        ]
+         if method.source_file == 'ruby_runtime'
+           @output << "\n"
+         else
+           @output << "\n      defined at:\n"
+           @output << "          %s:%s\n" % [File.expand_path(method.source_file), method.line]
+         end
+
+         callers = []
+         method.call_infos.each do |ci|
+           if ci.parent && ci.parent.target.source_file != 'ruby_runtime'
+             callers << [method_name(ci.parent.target), File.expand_path(ci.parent.target.source_file), ci.parent.target.line]
+           end
+         end
+         # make sure callers are unique
+         callers.uniq!
+
+         unless callers.empty?
+           @output << "      called from:\n"
+           callers.each do |args|
+             @output << "          %s (%s:%s)\n" % args
+           end
+         end
+         @output << "\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,244 @@
+# encoding: utf-8
+
+require 'erb'
+
+module RubyProf
+  # 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]
+  #   end
+  #
+  #   printer = RubyProf::GraphHtmlPrinter.new(result)
+  #   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
+  #
+
+  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
+    end
+
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+      @output << @erb.result(binding).split("\n").map(&:rstrip).join("\n") << "\n"
+    end
+
+    # Creates a link to a method.  Note that we do not create
+    # links to methods which are under the min_perecent
+    # specified by the user, since they will not be
+    # printed out.
+    def create_link(thread, overall_time, method)
+      total_percent = (method.total_time/overall_time) * 100
+      if total_percent < min_percent
+        # Just return name
+        h method.full_name
+      else
+        href = '#' + method_href(thread, method)
+        "<a href=\"#{href}\">#{h method.full_name}</a>"
+      end
+    end
+
+    def method_href(thread, method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_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}##{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">
+<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>'
+    end
+  end
+end
+

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

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+module RubyProf
+  # Generates graph[link:files/examples/graph_txt.html] profile reports as text.
+  # To use the graph printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::GraphPrinter.new(result)
+  #   printer.print(STDOUT, {})
+  #
+  # The constructor takes two arguments. See the README
+
+  class GraphPrinter < AbstractPrinter
+    PERCENTAGE_WIDTH = 8
+    TIME_WIDTH = 11
+    CALL_WIDTH = 17
+
+    private
+
+    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 << "Total Time: #{thread.total_time}\n"
+      @output << "Sort by: #{sort_method}\n"
+      @output << "\n"
+
+      # 1 is for % sign
+      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%total")
+      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%self")
+      @output << sprintf("%#{TIME_WIDTH}s", "total")
+      @output << sprintf("%#{TIME_WIDTH}s", "self")
+      @output << sprintf("%#{TIME_WIDTH}s", "wait")
+      @output << sprintf("%#{TIME_WIDTH}s", "child")
+      @output << sprintf("%#{CALL_WIDTH}s", "calls")
+      @output << "     name"
+      @output << "\n"
+    end
+
+    def print_methods(thread)
+      total_time = thread.total_time
+      # Sort methods from longest to shortest total time
+      methods = thread.methods.sort_by(&sort_method)
+
+      # Print each method in total time order
+      methods.reverse_each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+        next if total_percentage < min_percent
+
+        self_percentage = (method.self_time/total_time) * 100
+
+        @output << "-" * 80 << "\n"
+        print_parents(thread, method)
+
+        # 1 is for % sign
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", total_percentage)
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", self_percentage)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.wait_time)
+        @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 << "\n"
+
+        print_children(method)
+      end
+    end
+
+    def print_parents(thread, method)
+      method.aggregate_parents.sort_by(&:total_time).each do |caller|
+        next unless caller.parent
+        @output << " " * 2 * PERCENTAGE_WIDTH
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.children_time)
+
+        call_called = "#{caller.called}/#{method.called}"
+        @output << sprintf("%#{CALL_WIDTH}s", call_called)
+        @output << sprintf("     %s", caller.parent.target.full_name)
+        @output << "\n"
+      end
+    end
+
+    def print_children(method)
+      method.aggregate_children.sort_by(&:total_time).reverse.each do |child|
+        # Get children method
+
+        @output << " " * 2 * PERCENTAGE_WIDTH
+
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.children_time)
+
+        call_called = "#{child.called}/#{child.target.called}"
+        @output << sprintf("%#{CALL_WIDTH}s", call_called)
+        @output << sprintf("     %s", child.target.full_name)
+        @output << "\n"
+      end
+    end
+
+    def print_footer(thread)
+      @output << "\n"
+      @output << "* indicates recursively called methods\n"
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module RubyProf
+  # Helper class to simplify printing profiles of several types from
+  # one profiling run. Currently prints a flat profile, a callgrind
+  # profile, a call stack profile and a graph profile.
+  class MultiPrinter
+    def initialize(result)
+      @stack_printer = CallStackPrinter.new(result)
+      @graph_printer = GraphHtmlPrinter.new(result)
+      @tree_printer = CallTreePrinter.new(result)
+      @flat_printer = FlatPrinter.new(result)
+    end
+
+    # create profile files under options[:path] or the current
+    # directory. options[:profile] is used as the base name for the
+    # pofile file, defaults to "profile".
+    def print(options)
+      @profile = options.delete(:profile) || "profile"
+      @directory = options.delete(:path) || File.expand_path(".")
+
+      File.open(stack_profile, "w") do |f|
+        @stack_printer.print(f, options.merge(:graph => "#{@profile}.graph.html"))
+      end
+
+      File.open(graph_profile, "w") do |f|
+        @graph_printer.print(f, options)
+      end
+
+      @tree_printer.print(options.merge(:path => @directory, :profile => @profile))
+
+      File.open(flat_profile, "w") do |f|
+        @flat_printer.print(f, options)
+      end
+    end
+
+    # the name of the call stack profile file
+    def stack_profile
+      "#{@directory}/#{@profile}.stack.html"
+    end
+
+    # the name of the graph profile file
+    def graph_profile
+      "#{@directory}/#{@profile}.graph.html"
+    end
+
+    # the name of the callgrind profile file
+    def tree_profile
+      "#{@directory}/#{@profile}.callgrind.out.#{$$}"
+    end
+
+    # the name of the flat profile file
+    def flat_profile
+      "#{@directory}/#{@profile}.flat.txt"
+    end
+
+  end
+end