ruby-prof 0.16.2 → 1.1.0

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

@@ -1,260 +1,182 @@
-# encoding: utf-8
-
-require 'erb'
-require 'fileutils'
-require 'base64'
-
-module RubyProf
-  # prints a HTML visualization of the call tree
-  class CallStackPrinter < AbstractPrinter
-    include ERB::Util
-
-    # Specify print options.
-    #
-    # options - Hash table
-    #   :min_percent - Number 0 to 100 that specifes the minimum
-    #                  %self (the methods self time divided by the
-    #                  overall total time) that a method must take
-    #                  for it to be printed out in the report.
-    #                  Default value is 0.
-    #
-    #   :print_file  - True or false. Specifies if a method's source
-    #                  file should be printed.  Default value if false.
-    #
-    #   :threshold   - a float from 0 to 100 that sets the threshold of
-    #                  results displayed.
-    #                  Default value is 1.0
-    #
-    #   :title       - a String to overide the default "ruby-prof call tree"
-    #                  title of the report.
-    #
-    #   :expansion   - a float from 0 to 100 that sets the threshold of
-    #                  results that are expanded, if the percent_total
-    #                  exceeds it.
-    #                  Default value is 10.0
-    #
-    #   :application - a String to overide the name of the application,
-    #                  as it appears on the report.
-    #
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-      if @graph_html = options.delete(:graph)
-        @graph_html = "file://" + @graph_html if @graph_html[0]=="/"
-      end
-
-      print_header
-
-      @overall_threads_time = @result.threads.inject(0) do |val, thread|
-        val += thread.total_time
-      end
-
-      @result.threads.each do |thread|
-        @current_thread_id = thread.fiber_id
-        @overall_time = thread.total_time
-        thread_info = "Thread: #{thread.id}"
-        thread_info << ", Fiber: #{thread.fiber_id}" unless thread.id == thread.fiber_id
-        thread_info << " (#{"%4.2f%%" % ((@overall_time/@overall_threads_time)*100)} ~ #{@overall_time})"
-        @output.print "<div class=\"thread\">#{thread_info}</div>"
-        @output.print "<ul name=\"thread\">"
-        thread.methods.each do |m|
-          # $stderr.print m.dump
-          next unless m.root?
-          m.call_infos.each do |ci|
-            next unless ci.root?
-            print_stack ci, thread.total_time
-          end
-        end
-        @output.print "</ul>"
-      end
-
-      print_footer
-
-    end
-
-    def print_stack(call_info, parent_time)
-      total_time = call_info.total_time
-      percent_parent = (total_time/parent_time)*100
-      percent_total = (total_time/@overall_time)*100
-      return unless percent_total > min_percent
-      color = self.color(percent_total)
-      kids = call_info.children
-      visible = percent_total >= threshold
-      expanded = percent_total >= expansion
-      display = visible ? "block" : "none"
-      @output.print "<li class=\"color#{color}\" style=\"display:#{display}\">"
-      if kids.empty?
-        @output.print "<a href=\"#\" class=\"toggle empty\" ></a>"
-      else
-        visible_children = kids.any?{|ci| (ci.total_time/@overall_time)*100 >= threshold}
-        image = visible_children ? (expanded ? "minus" : "plus") : "empty"
-        @output.print "<a href=\"#\" class=\"toggle #{image}\" ></a>"
-      end
-      @output.printf "<span> %4.2f%% (%4.2f%%) %s %s</span>\n", percent_total, percent_parent, link(call_info), graph_link(call_info)
-      unless kids.empty?
-        if expanded
-          @output.print "<ul>"
-        else
-          @output.print '<ul style="display:none">'
-        end
-        kids.sort_by{|c| -c.total_time}.each do |callinfo|
-          print_stack callinfo, total_time
-        end
-        @output.print "</ul>"
-      end
-      @output.print "</li>"
-    end
-
-    def name(call_info)
-      method = call_info.target
-      method.full_name
-    end
-
-    def link(call_info)
-      method = call_info.target
-      file = File.expand_path(method.source_file)
-      if file =~ /\/ruby_runtime$/
-        h(name(call_info))
-      else
-        if RUBY_PLATFORM =~ /darwin/
-          "<a href=\"txmt://open?url=file://#{file}&line=#{method.line}\">#{h(name(call_info))}</a>"
-        else
-          "<a href=\"file://#{file}##{method.line}\">#{h(name(call_info))}</a>"
-        end
-      end
-    end
-
-    def graph_link(call_info)
-      total_calls = call_info.target.call_infos.inject(0){|t, ci| t += ci.called}
-      href = "#{@graph_html}##{method_href(call_info.target)}"
-      totals = @graph_html ? "<a href='#{href}'>#{total_calls}</a>" : total_calls.to_s
-      "[#{call_info.called} calls, #{totals} total]"
-    end
-
-    def method_href(method)
-      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + @current_thread_id.to_s)
-    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
-
-    def dump(ci)
-      $stderr.printf "%s/%d t:%f s:%f w:%f  \n", ci, ci.object_id, ci.total_time, ci.self_time, ci.wait_time
-    end
-
-    def color(p)
-      case i = p.to_i
-      when 0..5
-        "01"
-      when 5..10
-        "05"
-      when 100
-        "9"
-      else
-        "#{i/10}"
-      end
-    end
-
-    def application
-      @options[:application] || $PROGRAM_NAME
-    end
-
-    def arguments
-      ARGV.join(' ')
-    end
-
-    def title
-      @title ||= @options.delete(:title) || "ruby-prof call tree"
-    end
-
-    def threshold
-      @options[:threshold] || 1.0
-    end
-
-    def expansion
-      @options[:expansion] || 10.0
-    end
-
-    def print_header
-      @output.puts "<html><head>"
-      @output.puts '<meta http-equiv="content-type" content="text/html; charset=utf-8">'
-      @output.puts "<title>#{h title}</title>"
-      print_css
-      print_java_script
-      @output.puts '</head><body><div style="display: inline-block;">'
-      print_title_bar
-      print_commands
-      print_help
-    end
-
-    def print_footer
-      @output.puts '<div id="sentinel"></div></div></body></html>'
-    end
-
-    def open_asset(file)
-      path = File.join(File.expand_path('../../assets', __FILE__), file)
-      File.open(path, 'rb').read
-    end
-
-    def print_css
-      html = open_asset('call_stack_printer.css.html')
-      @output.puts html.gsub('%s', base64_image)
-    end
-
-    def base64_image
-      file = open_asset('call_stack_printer.png')
-      Base64.encode64(file).gsub(/\n/, '')
-    end
-
-    def print_java_script
-      html = open_asset('call_stack_printer.js.html')
-      @output.puts html
-    end
-
-    def print_title_bar
-      @output.puts <<-"end_title_bar"
-<div id="titlebar">
-Call tree for application <b>#{h application} #{h arguments}</b><br/>
-Generated on #{Time.now} with options #{h @options.inspect}<br/>
-</div>
-end_title_bar
-    end
-
-    def print_commands
-      @output.puts <<-"end_commands"
-<div id=\"commands\">
-<span style=\"font-size: 11pt; font-weight: bold;\">Threshold:</span>
-<input value=\"#{h threshold}\" size=\"3\" id=\"threshold\" type=\"text\">
-<input value=\"Apply\" onclick=\"setThreshold();\" type=\"submit\">
-<input value=\"Expand All\" onclick=\"expandAll(event);\" type=\"submit\">
-<input value=\"Collapse All\" onclick=\"collapseAll(event);\" type=\"submit\">
-<input value=\"Show Help\" onclick=\"toggleHelp(this);\" type=\"submit\">
-</div>
-end_commands
-    end
-
-    def print_help
-      @output.puts <<-'end_help'
-<div style="display: none;" id="help">
-&#8226; Enter a decimal value <i>d</i> into the threshold field and click "Apply"
-        to hide all nodes marked with time values lower than <i>d</i>.<br>
-&#8226; Click on "Expand All" for full tree expansion.<br>
-&#8226; Click on "Collapse All" to show only top level nodes.<br>
-&#8226; Use a, s, d, w as in Quake or Urban Terror to navigate the tree.<br>
-&#8226; Use f and b to navigate the tree in preorder forward and backwards.<br>
-&#8226; Use x to toggle visibility of a subtree.<br>
-&#8226; Use * to expand/collapse a whole subtree.<br>
-&#8226; Use h to navigate to thread root.<br>
-&#8226; Use n and p to navigate between threads.<br>
-&#8226; Click on background to move focus to a subtree.<br>
-</div>
-end_help
-    end
-  end
-end
-
+# encoding: utf-8
+
+require 'erb'
+require 'fileutils'
+require 'base64'
+require 'set'
+
+module RubyProf
+  # Prints a HTML visualization of the call tree.
+  #
+  # To use the printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::CallStackPrinter.new(result)
+  #   printer.print(STDOUT)
+
+  class CallStackPrinter < AbstractPrinter
+    include ERB::Util
+
+    # Specify print options.
+    #
+    # options - Hash table
+    #   :min_percent - Number 0 to 100 that specifes the minimum
+    #                  %self (the methods self time divided by the
+    #                  overall total time) that a method must take
+    #                  for it to be printed out in the report.
+    #                  Default value is 0.
+    #
+    #   :threshold   - a float from 0 to 100 that sets the threshold of
+    #                  results displayed.
+    #                  Default value is 1.0
+    #
+    #   :title       - a String to overide the default "ruby-prof call tree"
+    #                  title of the report.
+    #
+    #   :expansion   - a float from 0 to 100 that sets the threshold of
+    #                  results that are expanded, if the percent_total
+    #                  exceeds it.
+    #                  Default value is 10.0
+    #
+    #   :application - a String to overide the name of the application,
+    #                  as it appears on the report.
+    def print(output = STDOUT, options = {})
+      setup_options(options)
+      output << @erb.result(binding)
+      a = 1
+    end
+
+    # :enddoc:
+    def setup_options(options)
+      super(options)
+      @erb = ERB.new(self.template)
+    end
+
+    def print_stack(output, visited, call_info, parent_time)
+      total_time = call_info.total_time
+      percent_parent = (total_time/parent_time)*100
+      percent_total = (total_time/@overall_time)*100
+      return unless percent_total > min_percent
+      color = self.color(percent_total)
+      kids = call_info.target.callees
+      visible = percent_total >= threshold
+      expanded = percent_total >= expansion
+      display = visible ? "block" : "none"
+
+      output << "<li class=\"color#{color}\" style=\"display:#{display}\">" << "\n"
+
+      if visited.include?(call_info)
+        output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
+        output << "<span>%s %s</span>" % [link(call_info.target, true), graph_link(call_info)] << "\n"
+      else
+        visited << call_info
+
+        if kids.empty?
+          output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
+        else
+          visible_children = kids.any?{|ci| (ci.total_time/@overall_time)*100 >= threshold}
+          image = visible_children ? (expanded ? "minus" : "plus") : "empty"
+          output << "<a href=\"#\" class=\"toggle #{image}\" ></a>" << "\n"
+        end
+        output << "<span>%4.2f%% (%4.2f%%) %s %s</span>" % [percent_total, percent_parent,
+                                                            link(call_info.target, false), graph_link(call_info)] << "\n"
+
+        unless kids.empty?
+          output <<  (expanded ? '<ul>' : '<ul style="display:none">')  << "\n"
+          kids.sort_by{|c| -c.total_time}.each do |child_call_info|
+            print_stack(output, visited, child_call_info, total_time)
+          end
+          output << '</ul>' << "\n"
+        end
+
+        visited.delete(call_info)
+      end
+      output << '</li>' << "\n"
+    end
+
+    def name(call_info)
+      method = call_info.target
+      method.full_name
+    end
+
+    def link(method, recursive)
+      method_name = "#{recursive ? '*' : ''}#{method.full_name}"
+      if method.source_file.nil?
+        h method_name
+      else
+        file = File.expand_path(method.source_file)
+       "<a href=\"file://#{file}##{method.line}\">#{h method_name}</a>"
+      end
+    end
+
+    def graph_link(call_info)
+      total_calls = call_info.target.called
+      href = "#{method_href(call_info.target)}"
+      totals = total_calls.to_s
+      "[#{call_info.called} calls, #{totals} total]"
+    end
+
+    def method_href(method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_"))
+    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
+
+    def dump(ci)
+      $stderr.printf "%s/%d t:%f s:%f w:%f  \n", ci, ci.object_id, ci.total_time, ci.self_time, ci.wait_time
+    end
+
+    def color(p)
+      case i = p.to_i
+      when 0..5
+        "01"
+      when 5..10
+        "05"
+      when 100
+        "9"
+      else
+        "#{i/10}"
+      end
+    end
+
+    def application
+      @options[:application] || $PROGRAM_NAME
+    end
+
+    def arguments
+      ARGV.join(' ')
+    end
+
+    def title
+      @title ||= @options.delete(:title) || "ruby-prof call tree"
+    end
+
+    def threshold
+      @options[:threshold] || 1.0
+    end
+
+    def expansion
+      @options[:expansion] || 10.0
+    end
+
+    def base64_image
+      @data ||= begin
+        file = open_asset('call_stack_printer.png')
+        Base64.encode64(file).gsub(/\n/, '')
+      end
+    end
+
+    def template
+      open_asset('call_stack_printer.html.erb')
+    end
+  end
+end

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

@@ -1,130 +1,151 @@
-# encoding: utf-8
-
-require 'fiber'
-require 'thread'
-require 'fileutils'
-
-module RubyProf
-  # Generate 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 determine_event_specification_and_value_scale
-      @event_specification = "events: "
-      case RubyProf.measure_mode
-        when RubyProf::PROCESS_TIME
-          @value_scale = RubyProf::CLOCKS_PER_SEC
-          @event_specification << 'process_time'
-        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'
-        when RubyProf.const_defined?(:MEMORY) && RubyProf::MEMORY
-          @value_scale = 1
-          @event_specification << 'memory'
-        when RubyProf.const_defined?(:GC_RUNS) && RubyProf::GC_RUNS
-          @value_scale = 1
-          @event_specification << 'gc_runs'
-        when RubyProf.const_defined?(:GC_TIME) && RubyProf::GC_TIME
-          @value_scale = 1000000
-          @event_specification << 'gc_time'
-        else
-          raise "Unknown measure mode: #{RubyProf.measure_mode}"
-      end
-    end
-
-    def print(options = {})
-      setup_options(options)
-      determine_event_specification_and_value_scale
-      print_threads
-    end
-
-    def print_threads
-      remove_subsidiary_files_from_previous_profile_runs
-      # TODO: merge fibers of a given thread here, instead of relying
-      # on the profiler to merge fibers.
-      @result.threads.each do |thread|
-        print_thread(thread)
-      end
-    end
-
-    def convert(value)
-      (value * @value_scale).round
-    end
-
-    def file(method)
-      File.expand_path(method.source_file)
-    end
-
-    def print_thread(thread)
-      File.open(file_path_for_thread(thread), "w") do |f|
-        print_headers(f, thread)
-        thread.methods.reverse_each do |method|
-          print_method(f, method)
-        end
-      end
-    end
-
-    def path
-      @options[:path] || "."
-    end
-
-    def base_name
-      @options[:profile] || "profile"
-    end
-
-    def remove_subsidiary_files_from_previous_profile_runs
-      pattern = [base_name, "callgrind.out", $$, "*"].join(".")
-      files = Dir.glob(File.join(path, pattern))
-      FileUtils.rm_f(files)
-    end
-
-    def file_name_for_thread(thread)
-      if thread.fiber_id == Fiber.current.object_id
-        [base_name, "callgrind.out", $$].join(".")
-      else
-        [base_name, "callgrind.out", $$, thread.fiber_id].join(".")
-      end
-    end
-
-    def file_path_for_thread(thread)
-      File.join(path, file_name_for_thread(thread))
-    end
-
-    def print_headers(output, thread)
-      output << "#{@event_specification}\n\n"
-      # this doesn't work. kcachegrind does not fully support the spec.
-      # output << "thread: #{thread.id}\n\n"
-    end
-
-    def print_method(output, method)
-      # Print out the file and method name
-      output << "fl=#{file(method)}\n"
-      output << "fn=#{method_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=#{method_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
+# encoding: utf-8
+
+require 'fiber'
+require 'thread'
+require 'fileutils'
+
+module RubyProf
+  # Generates profiling information in callgrind format for use by
+  # kcachegrind and similar tools.
+
+  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: "
+      case RubyProf.measure_mode
+        when RubyProf::PROCESS_TIME
+          @value_scale = RubyProf::CLOCKS_PER_SEC
+          @event_specification << 'process_time'
+        when RubyProf::WALL_TIME
+          @value_scale = 1_000_000
+          @event_specification << 'wall_time'
+        when RubyProf.const_defined?(:ALLOCATIONS) && RubyProf::ALLOCATIONS
+          @value_scale = 1
+          @event_specification << 'allocations'
+        when RubyProf.const_defined?(:MEMORY) && RubyProf::MEMORY
+          @value_scale = 1
+          @event_specification << 'memory'
+        when RubyProf.const_defined?(:GC_RUNS) && RubyProf::GC_RUNS
+          @value_scale = 1
+          @event_specification << 'gc_runs'
+        when RubyProf.const_defined?(:GC_TIME) && RubyProf::GC_TIME
+          @value_scale = 1000000
+          @event_specification << 'gc_time'
+        else
+          raise "Unknown measure mode: #{RubyProf.measure_mode}"
+      end
+    end
+
+    def print(options = {})
+      validate_print_params(options)
+      setup_options(options)
+      determine_event_specification_and_value_scale
+      print_threads
+    end
+
+    def validate_print_params(options)
+      if options.is_a?(IO)
+        raise ArgumentError, "#{self.class.name}#print cannot print to IO objects"
+      elsif !options.is_a?(Hash)
+        raise ArgumentError, "#{self.class.name}#print requires an options hash"
+      end
+    end
+
+    def print_threads
+      remove_subsidiary_files_from_previous_profile_runs
+      # TODO: merge fibers of a given thread here, instead of relying
+      # on the profiler to merge fibers.
+      @result.threads.each do |thread|
+        print_thread(thread)
+      end
+    end
+
+    def convert(value)
+      (value * @value_scale).round
+    end
+
+    def file(method)
+      method.source_file ? File.expand_path(method.source_file) : ''
+    end
+
+    def print_thread(thread)
+      File.open(file_path_for_thread(thread), "w") do |f|
+        print_headers(f, thread)
+        thread.methods.reverse_each do |method|
+          print_method(f, method)
+        end
+      end
+    end
+
+    def path
+      @options[:path] || "."
+    end
+
+    def self.needs_dir?
+      true
+    end
+
+    def base_name
+      @options[:profile] || "profile"
+    end
+
+    def remove_subsidiary_files_from_previous_profile_runs
+      pattern = [base_name, "callgrind.out", $$, "*"].join(".")
+      files = Dir.glob(File.join(path, pattern))
+      FileUtils.rm_f(files)
+    end
+
+    def file_name_for_thread(thread)
+      if thread.fiber_id == Fiber.current.object_id
+        [base_name, "callgrind.out", $$].join(".")
+      else
+        [base_name, "callgrind.out", $$, thread.fiber_id].join(".")
+      end
+    end
+
+    def file_path_for_thread(thread)
+      File.join(path, file_name_for_thread(thread))
+    end
+
+    def print_headers(output, thread)
+      output << "#{@event_specification}\n\n"
+      # this doesn't work. kcachegrind does not fully support the spec.
+      # output << "thread: #{thread.id}\n\n"
+    end
+
+    def print_method(output, method)
+      # Print out the file and method name
+      output << "fl=#{file(method)}\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.callees.each do |callee|
+        output << "cfl=#{file(callee.target)}\n"
+        output << "cfn=#{self.calltree_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