skaes-ruby-prof 0.7.3

data/lib/ruby-prof/call_tree_printer.rb

@@ -0,0 +1,84 @@
+require 'ruby-prof/abstract_printer'
+
+module RubyProf
+  # Generate profiling information in calltree format
+  # for use by kcachegrind and similar tools.
+
+  class CallTreePrinter  < AbstractPrinter
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+        
+      # add a header - this information is somewhat arbitrary
+      @output << "events: "
+      case RubyProf.measure_mode
+        when RubyProf::PROCESS_TIME
+          @value_scale = RubyProf::CLOCKS_PER_SEC;
+          @output << 'process_time'
+        when RubyProf::WALL_TIME
+          @value_scale = 1_000_000
+          @output << 'wall_time'
+        when RubyProf.const_defined?(:CPU_TIME) && RubyProf::CPU_TIME
+          @value_scale = RubyProf.cpu_frequency
+          @output << 'cpu_time'
+        when RubyProf.const_defined?(:ALLOCATIONS) && RubyProf::ALLOCATIONS
+          @value_scale = 1
+          @output << 'allocations'
+        when RubyProf.const_defined?(:MEMORY) && RubyProf::MEMORY
+          @value_scale = 1
+          @output << 'memory'
+        when RubyProf.const_defined?(:GC_RUNS) && RubyProf::GC_RUNS
+          @value_scale = 1
+          @output << 'gc_runs'
+        when RubyProf.const_defined?(:GC_TIME) && RubyProf::GC_TIME
+          @value_scale = 1000000
+          @output << 'gc_time'
+        else
+          raise "Unknown measure mode: #{RubyProf.measure_mode}"
+      end
+      @output << "\n\n"
+
+      print_threads
+    end
+
+    def print_threads
+      @result.threads.each do |thread_id, methods|
+        print_methods(thread_id, methods)
+      end
+    end
+
+    def convert(value)
+      (value * @value_scale).round
+    end
+
+    def file(method)
+      File.expand_path(method.source_file)
+    end
+
+    def name(method)
+      "#{method.klass_name}::#{method.method_name}"
+    end
+
+    def print_methods(thread_id, methods)
+      methods.reverse_each do |method| 
+        # Print out the file and method name
+        @output << "fl=#{file(method)}\n"
+        @output << "fn=#{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|
+          @output << "cfl=#{file(callee.target)}\n"
+          @output << "cfn=#{name(callee.target)}\n"
+          @output << "calls=#{callee.called} #{callee.line}\n"
+
+          # Print out total times here!
+          @output << "#{callee.line} #{convert(callee.total_time)}\n"
+        end
+      @output << "\n"
+      end
+    end #end print_methods
+  end # end class
+end # end packages

data/lib/ruby-prof/flat_printer.rb

@@ -0,0 +1,79 @@
+require 'ruby-prof/abstract_printer'
+
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text. 
+  # To use the flat printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlatPrinter.new(result)
+  #   printer.print(STDOUT, 0)
+  #
+  class FlatPrinter < AbstractPrinter
+    # Print a flat profile report to the provided output.
+    # 
+    # output - Any IO oject, including STDOUT or a file. 
+    # The default value is STDOUT.
+    # 
+    # 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 
+    
+    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.sort.last
+      total_time = toplevel.total_time
+      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    
+      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
+                      method.self_time,                    # self
+                      method.wait_time,                    # wait
+                      method.children_time,                # children
+                      method.called,                       # calls
+                    method_name(method)                  # name
+                  ]
+      end
+    end
+  end
+end 
+

data/lib/ruby-prof/graph_html_printer.rb

@@ -0,0 +1,272 @@
+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:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::GraphHtmlPrinter.new(result)
+  #   printer.print(STDOUT, :min_percent=>0)
+  #
+  # 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
+  # total time divided by the overall total time) that
+  # 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
+    # object generated from a profiling run.
+    def initialize(result)
+      super(result)
+      @thread_times = Hash.new
+      calculate_thread_times
+    end
+
+    # Print a graph html report to the provided output.
+    #
+    # output - Any IO oject, including STDOUT or a file.
+    # The default value is STDOUT.
+    #
+    # 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
+      erb = ERB.new(template, nil, nil)
+      erb.filename = filename
+      @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
+    #--
+    def calculate_thread_times
+      @overall_threads_time = 0.0
+      @thread_times = Hash.new
+      @result.threads.each do |thread_id, methods|
+        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
+    # specified by the user, since they will not be
+    # printed out.
+    def create_link(thread_id, method)
+      if self.total_percent(thread_id, method) < min_percent
+        # Just return name
+        h method.full_name
+      else
+        href = '#' + method_href(thread_id, method)
+        "<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
+        "<a href=\"txmt://open?url=file://#{h srcfile}&line=#{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;
+    }
+  </style>
+  </head>
+  <body>
+    <h1>Profile Report</h1>
+    <!-- Threads Table -->
+    <table>
+      <tr>
+        <th>Thread ID</th>
+        <th>Total Time</th>
+      </tr>
+      <% for thread_id in @result.threads.keys.sort %>
+      <tr>
+        <td><a href="#<%= thread_id %>"><%= thread_id %></a></td>
+        <td><%= thread_time(thread_id) %></td>
+      </tr>
+      <% end %>
+    </table>
+
+    <!-- Methods Tables -->
+    <% 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>
+
+      <table>
+        <tr>
+          <th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Total") %></th>
+          <th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Self") %></th>
+          <th><%= sprintf("%#{TIME_WIDTH}s", "Total") %></th>
+          <th><%= sprintf("%#{TIME_WIDTH}s", "Self") %></th>
+          <th><%= sprintf("%#{TIME_WIDTH}s", "Wait") %></th>
+          <th><%= sprintf("%#{TIME_WIDTH+2}s", "Child") %></th>
+          <th><%= sprintf("%#{CALL_WIDTH}s", "Calls") %></th>
+          <th class="method_name">Name</th>
+          <th>Line</th>
+        </tr>
+
+        <% min_time = @options[:min_time] || (@options[:nonzero] ? 0.005 : nil)
+           methods.sort.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
+                 next unless caller.parent
+                 next if min_time && caller.total_time < min_time  %>
+              <tr>
+                <td>&nbsp;</td>
+                <td>&nbsp;</td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.total_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.self_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.wait_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.children_time) %></td>
+                <% 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><%= file_link(caller.parent.target.source_file, caller.line) %></td>
+              </tr>
+            <% end %>
+
+            <tr class="method">
+              <td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", total_percentage) %></td>
+              <td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", self_percentage) %></td>
+              <td><%= sprintf("%#{TIME_WIDTH}.2f", method.total_time) %></td>
+              <td><%= sprintf("%#{TIME_WIDTH}.2f", method.self_time) %></td>
+              <td><%= sprintf("%#{TIME_WIDTH}.2f", method.wait_time) %></td>
+              <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><%= file_link(method.source_file, method.line) %></td>
+            </tr>
+
+            <!-- Children -->
+            <% for callee in method.aggregate_children %>
+            <%   next if min_time && callee.total_time < min_time  %>
+              <tr>
+                <td>&nbsp;</td>
+                <td>&nbsp;</td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.total_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.self_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.wait_time) %></td>
+                <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.children_time) %></td>
+                <% 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><%= file_link(method.source_file, callee.line) %></td>
+              </tr>
+            <% end %>
+            <!-- Create divider row -->
+            <tr class="break"><td colspan="9"></td></tr>
+        <% end %>
+      </table>
+    <% end %>
+  </body>
+</html>'
+    end
+  end
+end
+

data/lib/ruby-prof/graph_printer.rb

@@ -0,0 +1,164 @@
+require 'ruby-prof/abstract_printer'
+
+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, 5)
+  #   printer.print(STDOUT, 0)
+  #
+  # 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 
+  # total time divided by the overall total time) that
+  # 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 GraphPrinter < AbstractPrinter
+    PERCENTAGE_WIDTH = 8
+    TIME_WIDTH = 10
+    CALL_WIDTH = 17
+  
+    # Create a GraphPrinter.  Result is a RubyProf::Result  
+    # object generated from a profiling run.
+    def initialize(result)
+      super(result)
+      @thread_times = Hash.new
+      calculate_thread_times
+    end
+
+    def calculate_thread_times
+      # Cache thread times since this is an expensive
+      # operation with the required sorting      
+      @result.threads.each do |thread_id, methods|
+        top = methods.sort.last
+        
+        thread_time = 0.01
+        thread_time = top.total_time if top.total_time > 0
+
+        @thread_times[thread_id] = thread_time 
+      end
+    end
+    
+    # Print a graph report to the provided output.
+    # 
+    # output - Any IO oject, including STDOUT or a file. 
+    # The default value is STDOUT.
+    # 
+    # 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 
+    def print_threads
+      # sort assumes that spawned threads have higher object_ids
+      @result.threads.sort.each do |thread_id, methods|
+        print_methods(thread_id, methods)
+        @output << "\n" * 2
+      end
+    end
+    
+    def print_methods(thread_id, methods)
+      # Sort methods from longest to shortest total time
+      methods = methods.sort
+      
+      toplevel = methods.last
+      total_time = toplevel.total_time
+      if total_time == 0
+        total_time = 0.01
+      end
+      
+      print_heading(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
+        
+        @output << "-" * 80 << "\n"
+
+        print_parents(thread_id, 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}.2f", method.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", method.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", method.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", method.children_time)
+        @output << sprintf("%#{CALL_WIDTH}i", method.called)
+        @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_heading(thread_id)
+      @output << "Thread ID: #{thread_id}\n"
+      @output << "Total Time: #{@thread_times[thread_id]}\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_parents(thread_id, method)
+      method.aggregate_parents.each do |caller|
+        next unless caller.parent
+        @output << " " * 2 * PERCENTAGE_WIDTH
+        @output << sprintf("%#{TIME_WIDTH}.2f", caller.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", caller.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", caller.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", 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.each do |child|
+        # Get children method
+        
+        @output << " " * 2 * PERCENTAGE_WIDTH
+        
+        @output << sprintf("%#{TIME_WIDTH}.2f", child.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", child.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", child.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", 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
+  end
+end 
+