ruby-prof 0.18.0 → 1.0.0

data/lib/ruby-prof/call_info.rb

@@ -1,115 +1,57 @@
 # encoding: utf-8
 
 module RubyProf
+  # The CallInfo class is used to track the relationships between methods. It is a helper class used by
+  # RubyProf::MethodInfo to keep track of which methods called a given method and which methods a given
+  # method called. Each CallInfo has a parent and target method. You cannot create a CallInfo object directly,
+  # they are generated while running a profile.
   class CallInfo
-    # part of this class is defined in C code.
-    # it provides the following attributes pertaining to tree structure:
-    # depth:      tree level (0 == root)
-    # parent:     parent call info (can be nil)
-    # children:   array of call info children (can be empty)
-    # target:     method info (containing an array of call infos)
-
-    def children_time
-      children.inject(0) do |sum, call_info|
-        sum += call_info.total_time
-      end
+    # The number of times the parent method called the target method
+    def called
+      self.measurement.called
     end
 
-    def stack
-      @stack ||= begin
-        methods = Array.new
-        call_info = self
-
-        while call_info
-          methods << call_info.target
-          call_info = call_info.parent
-        end
-        methods.reverse
-      end
+    # The total time resulting from the parent method calling the target method
+    def total_time
+      self.measurement.total_time
     end
 
-    def call_sequence
-      @call_sequence ||= begin
-        stack.map {|method| method.full_name}.join('->')
-      end
-    end
-
-    def root?
-      self.parent.nil?
+    # The self time (of the parent) resulting from the parent method calling the target method
+    def self_time
+      self.measurement.self_time
     end
 
-    def descendent_of(other)
-      p = self.parent
-      while p && p != other && p.depth > other.depth
-        p = p.parent
-      end
-      p == other
+    # The wait time (of the parent) resulting from the parent method calling the target method
+    def wait_time
+      self.measurement.wait_time
     end
 
-    def self.roots_of(call_infos)
-      roots = []
-      sorted = call_infos.sort_by(&:depth).reverse
-      while call_info = sorted.shift
-        roots << call_info unless sorted.any?{|p| call_info.descendent_of(p)}
+    # The time spent in child methods resulting from the parent method calling the target method
+    def children_time
+      self.total_time - self.self_time - self.wait_time
+    end
+
+    # Compares two CallInfo instances. The comparison is based on the CallInfo#parent, CallInfo#target,
+    # and total time.
+    def <=>(other)
+      if self.target == other.target && self.parent == other.parent
+        0
+      elsif self.total_time < other.total_time
+        -1
+      elsif self.total_time > other.total_time
+        1
+      else
+        self.target.full_name <=> other.target.full_name
       end
-      roots
     end
 
+    # :nodoc:
     def to_s
-      "#{target.full_name} (c: #{called}, tt: #{total_time}, st: #{self_time}, ct: #{children_time})"
+      "#{parent ? parent.full_name : '<nil>'} - #{target.full_name}"
     end
 
     def inspect
-      super + "(#{target.full_name}, d: #{depth}, c: #{called}, tt: #{total_time}, st: #{self_time}, ct: #{children_time})"
-    end
-
-    # eliminate call info from the call tree.
-    # adds self and wait time to parent and attaches called methods to parent.
-    # merges call trees for methods called from both praent end self.
-    def eliminate!
-      # puts "eliminating #{self}"
-      return unless parent
-      parent.add_self_time(self)
-      parent.add_wait_time(self)
-      children.each do |kid|
-        if call = parent.find_call(kid)
-          call.merge_call_tree(kid)
-        else
-          parent.children << kid
-          # $stderr.puts "setting parent of #{kid}\nto #{parent}"
-          kid.parent = parent
-        end
-      end
-      parent.children.delete(self)
-    end
-
-    # find a specific call in list of children. returns nil if not found.
-    # note: there can't be more than one child with a given target method. in other words:
-    # x.children.grep{|y|y.target==m}.size <= 1 for all method infos m and call infos x
-    def find_call(other)
-      matching = children.select { |kid| kid.target == other.target }
-      raise "inconsistent call tree" unless matching.size <= 1
-      matching.first
-    end
-
-    # merge two call trees. adds self, wait, and total time of other to self and merges children of other into children of self.
-    def merge_call_tree(other)
-      # $stderr.puts "merging #{self}\nand #{other}"
-      self.called += other.called
-      add_self_time(other)
-      add_wait_time(other)
-      add_total_time(other)
-      other.children.each do |other_kid|
-        if kid = find_call(other_kid)
-          # $stderr.puts "merging kids"
-          kid.merge_call_tree(other_kid)
-        else
-          other_kid.parent = self
-          children << other_kid
-        end
-      end
-      other.children.clear
-      other.target.call_infos.delete(other)
+      super + "(#{self.to_s})"
     end
   end
 end

data/lib/ruby-prof/call_info_visitor.rb

@@ -1,24 +1,22 @@
-# The call info visitor class does a depth-first traversal across a
-# list of method infos. At each call_info node, the visitor executes
-# the block provided in the #visit method. The block is passed two
-# parameters, the event and the call_info instance. Event will be
-# either :enter or :exit.
-#
-#   visitor = RubyProf::CallInfoVisitor.new(result.threads.first.top_call_infos)
-#
-#   method_names = Array.new
-#
-#   visitor.visit do |call_info, event|
-#     method_names << call_info.target.full_name if event == :enter
-#   end
-#
-#   puts method_names
-
 module RubyProf
+  # The call info visitor class does a depth-first traversal across a
+  # list of method infos. At each call_info node, the visitor executes
+  # the block provided in the #visit method. The block is passed two
+  # parameters, the event and the call_info instance. Event will be
+  # either :enter or :exit.
+  #
+  #   visitor = RubyProf::CallInfoVisitor.new(result.threads.first.root_methods)
+  #
+  #   method_names = Array.new
+  #
+  #   visitor.visit do |call_info, event|
+  #     method_names << call_info.target.full_name if event == :enter
+  #   end
+  #
+  #   puts method_names
   class CallInfoVisitor
-
-    def initialize(call_infos)
-      @call_infos = CallInfo.roots_of(call_infos)
+    def initialize(root_methods)
+      @call_infos = root_methods.map(&:callers).flatten
     end
 
     def visit(&block)
@@ -28,13 +26,13 @@ module RubyProf
     end
 
     private
+
     def visit_call_info(call_info, &block)
       yield call_info, :enter
-      call_info.children.each do |child|
+      call_info.target.callees.each do |child|
         visit_call_info(child, &block)
       end
       yield call_info, :exit
     end
   end
-
 end

data/lib/ruby-prof/compatibility.rb

@@ -1,53 +1,16 @@
 # encoding: utf-8
 
-# These methods are here for backwards compatability with previous RubyProf releases
+# These methods are deprecated and are available for backwards compatability.
 module RubyProf
-  # Measurements
-  def self.cpu_frequency
-    Measure::CpuTime.frequency
-  end
-
-  def self.measure_allocations
-    Measure::Allocations.measure
-  end
-
-  def self.measure_cpu_time
-    Measure::CpuTime.measure
-  end
-
-  def self.measure_gc_runs
-    Measure::GcRuns.measure
-  end
-
-  def self.measure_gc_time
-    Measure::GcTime.measure
-  end
-
-  def self.measure_memory
-    Measure::Memory.measure
-  end
-
-  def self.measure_process_time
-    Measure::ProcessTime.measure
-  end
-
-  def self.measure_wall_time
-    Measure::WallTime.measure
-  end
-
   # call-seq:
   # measure_mode -> measure_mode
   #
   # Returns what ruby-prof is measuring.  Valid values include:
   #
-  # *RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and GetLocalTime on Windows.  This is default.
-  # *RubyProf::PROCESS_TIME - Measure process time.  It is implemented using the clock functions in the C Runtime library.
-  # *RubyProf::CPU_TIME - Measure time using the CPU clock counter.  This mode is only supported on Pentium or PowerPC platforms.
-  # *RubyProf::ALLOCATIONS - Measure object allocations.  This requires a patched Ruby interpreter.
-  # *RubyProf::MEMORY - Measure memory size.  This requires a patched Ruby interpreter.
-  # *RubyProf::GC_RUNS - Measure number of garbage collections.  This requires a patched Ruby interpreter.
-  # *RubyProf::GC_TIME - Measure time spent doing garbage collection.  This requires a patched Ruby interpreter.*/
-
+  # * RubyProf::WALL_TIME
+  # * RubyProf::PROCESS_TIME
+  # * RubyProf::ALLOCATIONS
+  # * RubyProf::MEMORY
   def self.measure_mode
     @measure_mode ||= RubyProf::WALL_TIME
   end
@@ -57,66 +20,38 @@ module RubyProf
   #
   # Specifies what ruby-prof should measure.  Valid values include:
   #
-  # *RubyProf::WALL_TIME - Measure wall time using gettimeofday on Linx and GetLocalTime on Windows.  This is default.
-  # *RubyProf::PROCESS_TIME - Measure process time.  It is implemented using the clock functions in the C Runtime library.
-  # *RubyProf::CPU_TIME - Measure time using the CPU clock counter.  This mode is only supported on Pentium or PowerPC platforms.
-  # *RubyProf::ALLOCATIONS - Measure object allocations.  This requires a patched Ruby interpreter.
-  # *RubyProf::MEMORY - Measure memory size.  This requires a patched Ruby interpreter.
-  # *RubyProf::GC_RUNS - Measure number of garbage collections.  This requires a patched Ruby interpreter.
-  # *RubyProf::GC_TIME - Measure time spent doing garbage collection.  This requires a patched Ruby interpreter.*/
+  # * RubyProf::WALL_TIME - Wall time measures the real-world time elapsed between any two moments. If there are other processes concurrently running on the system that use significant CPU or disk time during a profiling run then the reported results will be larger than expected. On Windows, wall time is measured using GetTickCount(), on MacOS by mach_absolute_time, on Linux by clock_gettime and otherwise by gettimeofday.
+  # * RubyProf::PROCESS_TIME - Process time measures the time used by a process between any two moments. It is unaffected by other processes concurrently running on the system. Remember with process time that calls to methods like sleep will not be included in profiling results. On Windows, process time is measured using GetProcessTimes and on other platforms by clock_gettime.
+  # * RubyProf::ALLOCATIONS - Object allocations measures show how many objects each method in a program allocates. Measurements are done via Ruby's GC.stat api.
+  # * RubyProf::MEMORY - Memory measures how much memory each method in a program uses. Measurements are done via Ruby's TracePoint api.
   def self.measure_mode=(value)
     @measure_mode = value
   end
 
-  def self.measure_mode_string
-    case measure_mode
-    when WALL_TIME    then "wall_time"
-    when CPU_TIME     then "cpu_time"
-    when PROCESS_TIME then "process_time_time"
-    when ALLOCATIONS  then "allocations"
-    when MEMORY       then "memory"
-    when GC_TIME      then "gc_time"
-    when GC_RUNS      then "gc_runs"
-    end
-  end
-
-  # call-seq:
-  # exclude_threads -> exclude_threads
-  #
-  # Returns threads ruby-prof should exclude from profiling
-
+  # Returns the threads that ruby-prof should exclude from profiling
   def self.exclude_threads
     @exclude_threads ||= Array.new
   end
 
-  # call-seq:
-  # exclude_threads= -> void
-  #
-  # Specifies what threads ruby-prof should exclude from profiling
-
+  # Specifies which threads ruby-prof should exclude from profiling
   def self.exclude_threads=(value)
     @exclude_threads = value
   end
 
-  # Profiling
-  def self.start_script(script)
-    start
-    load script
-  end
-
+  # Starts profiling
   def self.start
     ensure_not_running!
-    @profile = Profile.new(measure_mode: measure_mode, exclude_threads: exclude_threads)
-    enable_gc_stats_if_needed
+    @profile = Profile.new(:measure_mode => measure_mode, :exclude_threads => exclude_threads)
     @profile.start
   end
 
+  # Pauses profiling
   def self.pause
     ensure_running!
-    disable_gc_stats_if_needed
     @profile.pause
   end
 
+  # Is a profile running?
   def self.running?
     if defined?(@profile) and @profile
       @profile.running?
@@ -125,55 +60,50 @@ module RubyProf
     end
   end
 
+  # Resume profiling
   def self.resume
     ensure_running!
-    enable_gc_stats_if_needed
     @profile.resume
   end
 
+  # Stops profiling
   def self.stop
     ensure_running!
     result = @profile.stop
-    disable_gc_stats_if_needed
     @profile = nil
     result
   end
 
-  # Profile a block
+  # Profiles a block
   def self.profile(options = {}, &block)
     ensure_not_running!
-    gc_stat_was_enabled = enable_gc_stats_if_needed
-    options = { measure_mode: measure_mode, exclude_threads: exclude_threads }.merge!(options)
-    result = Profile.profile(options, &block)
-  ensure
-    disable_gc_stats_if_needed(gc_stat_was_enabled)
-    result
+    options = {:measure_mode => measure_mode, :exclude_threads => exclude_threads }.merge!(options)
+    Profile.profile(options, &block)
   end
 
-
-private
-  def self.ensure_running!
-    raise(RuntimeError, "RubyProf.start was not yet called") unless running?
+  # :nodoc:
+  def self.measure_mode_string
+    case measure_mode
+      when WALL_TIME    then "wall_time"
+      when PROCESS_TIME then "process_time"
+      when ALLOCATIONS  then "allocations"
+      when MEMORY       then "memory"
+    end
   end
 
-  def self.ensure_not_running!
-    raise(RuntimeError, "RubyProf is already running") if running?
+  # :nodoc:
+  def self.start_script(script)
+    start
+    load script
   end
 
-  # for GC.allocated_size to work GC statistics should be enabled
-  def self.enable_gc_stats_if_needed
-    if measure_mode_requires_gc_stats_enabled?
-      @gc_stat_was_enabled = GC.enable_stats
-    end
-  end
+  private
 
-  def self.disable_gc_stats_if_needed(was_enabled=nil)
-    was_enabled ||= defined?(@gc_stat_was_enabled) && @gc_stat_was_enabled
-    GC.disable_stats if measure_mode_requires_gc_stats_enabled? && !was_enabled
+  def self.ensure_running!
+    raise(RuntimeError, "RubyProf.start was not yet called") unless running?
   end
 
-  def self.measure_mode_requires_gc_stats_enabled?
-    GC.respond_to?(:enable_stats) &&
-      [RubyProf::MEMORY, RubyProf::GC_TIME, RubyProf::GC_RUNS].include?(measure_mode)
+  def self.ensure_not_running!
+    raise(RuntimeError, "RubyProf is already running") if running?
   end
 end

data/lib/ruby-prof/exclude_common_methods.rb

@@ -0,0 +1,198 @@
+require 'set'
+
+# :enddoc:
+module RubyProf
+  module ExcludeCommonMethods
+    ENUMERABLE_NAMES = Enumerable.instance_methods(false)
+
+    def self.apply!(profile)
+      ##
+      #  Kernel Methods
+      ##
+
+      exclude_methods(profile, Kernel, [
+        :dup,
+        :initialize_dup,
+        :tap,
+        :send,
+        :public_send,
+      ])
+
+      ##
+      #  Fundamental Types
+      ##
+
+      exclude_methods(profile, BasicObject,  :"!=")
+      exclude_methods(profile, Method,       :"[]")
+      exclude_methods(profile, Module,       :new)
+      exclude_methods(profile, Class,        :new)
+      exclude_methods(profile, Proc,         :call, :yield)
+      exclude_methods(profile, Range,        :each)
+      exclude_methods(profile, Integer,      :times)
+
+      ##
+      #  Value Types
+      ##
+
+      exclude_methods(profile, String, [
+        :sub,
+        :sub!,
+        :gsub,
+        :gsub!,
+      ])
+
+      ##
+      #  Emumerables
+      ##
+
+      exclude_enumerable(profile, Enumerable)
+      exclude_enumerable(profile, Enumerator)
+
+      ##
+      #  Collections
+      ##
+
+      exclude_enumerable(profile, Array, [
+        :each_index,
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :sort!,
+        :sort_by!,
+        :index,
+        :delete_if,
+        :keep_if,
+        :drop_while,
+        :uniq,
+        :uniq!,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+
+      exclude_enumerable(profile, Hash, [
+        :dup,
+        :initialize_dup,
+        :fetch,
+        :"[]",
+        :"[]=",
+        :each_key,
+        :each_value,
+        :each_pair,
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :delete_if,
+        :keep_if,
+        :slice,
+        :slice!,
+        :except,
+        :except!,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+
+      exclude_enumerable(profile, Set, [
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :classify,
+        :delete_if,
+        :keep_if,
+        :divide,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+
+      ##
+      #  Garbage Collection
+      ##
+
+      exclude_singleton_methods(profile, GC, [
+        :start
+      ])
+
+      ##
+      #  Unicorn
+      ##
+
+      if defined?(Unicorn)
+        exclude_methods(profile, Unicorn::HttpServer, :process_client)
+      end
+
+      if defined?(Unicorn::OobGC)
+        exclude_methods(profile, Unicorn::OobGC, :process_client)
+      end
+
+      ##
+      #  New Relic
+      ##
+
+      if defined?(NewRelic::Agent)
+        if defined?(NewRelic::Agent::Instrumentation::MiddlewareTracing)
+          exclude_methods(profile, NewRelic::Agent::Instrumentation::MiddlewareTracing, [
+            :call
+          ])
+        end
+
+        if defined?(NewRelic::Agent::MethodTracerHelpers)
+          exclude_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
+            :trace_execution_scoped,
+            :log_errors,
+          ])
+
+          exclude_singleton_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
+            :trace_execution_scoped,
+            :log_errors,
+          ])
+        end
+
+        if defined?(NewRelic::Agent::MethodTracer)
+          exclude_methods(profile, NewRelic::Agent::MethodTracer, [
+            :trace_execution_scoped,
+            :trace_execution_unscoped,
+          ])
+        end
+      end
+
+        ##
+        #  Miscellaneous Methods
+        ##
+
+      if defined?(Mustache)
+        exclude_methods(profile, Mustache::Context, [
+          :fetch
+        ])
+      end
+    end
+
+    private
+
+    def self.exclude_enumerable(profile, mod, *method_or_methods)
+      exclude_methods(profile, mod, [:each, *method_or_methods])
+      exclude_methods(profile, mod, ENUMERABLE_NAMES)
+    end
+
+    def self.exclude_methods(profile, mod, *method_or_methods)
+      profile.exclude_methods!(mod, method_or_methods)
+    end
+
+    def self.exclude_singleton_methods(profile, mod, *method_or_methods)
+      profile.exclude_singleton_methods!(mod, method_or_methods)
+    end
+  end
+end