ruby-prof 0.18.0 → 1.2.0

data/Rakefile

@@ -40,7 +40,7 @@ Rake::ExtensionTask.new do |ext|
   ext.ext_dir = "ext/#{SO_NAME}"
   ext.lib_dir = "lib/#{RUBY_VERSION}"
   ext.cross_compile = true
-  ext.cross_platform = ['x86-mswin32-60', 'x86-mingw32-60']
+  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
 end
 
 # Rake task to build the default package
@@ -80,12 +80,9 @@ RDoc::Task.new("rdoc") do |rdoc|
   rdoc.options << '--main' << 'README.rdoc'
   rdoc.rdoc_files.include('bin/*',
                           'doc/*.rdoc',
-                          'examples/flat.txt',
-                          'examples/graph.txt',
-                          'examples/graph.html',
                           'lib/**/*.rb',
-                          'ext/ruby_prof/ruby_prof.c',
-                          'ext/ruby_prof/measure_*.h',
+                          'ext/ruby_prof/*.c',
+                          'ext/ruby_prof/*.h',
                           'README.rdoc',
                           'LICENSE')
 end

data/bin/ruby-prof

@@ -1,20 +1,6 @@
 #! /usr/bin/env ruby
 
-# == Synopsis
-#
-# Profiles a Ruby program.
-#
-# == Usage
-#
-# ruby_prof [options] <script.rb> [--] [script-options]"
-#
-# Various options:
-#        run "$ ruby-prof --help" to see them
-#
-# See also the readme "reports" section for the various outputs
-
 # First require ruby-prof
-require 'rubygems'
 require 'ruby-prof'
 
 # Now setup option parser
@@ -22,8 +8,50 @@ require 'ostruct'
 require 'optparse'
 
 module RubyProf
+  # == Synopsis
+  #
+  # Profiles a Ruby program.
+  #
+  # == Usage
+  # ruby-prof [options] <script.rb> [--] [profiled-script-command-line-options]
+  #
+  # Options:
+  #    -p, --printer=printer            Select a printer:
+  #                                       flat - Prints a flat profile as text (default).
+  #                                       graph - Prints a graph profile as text.
+  #                                       graph_html - Prints a graph profile as html.
+  #                                       call_tree - format for KCacheGrind
+  #                                       call_stack - prints a HTML visualization of the call tree
+  #                                       dot - Prints a graph profile as a dot file
+  #                                       multi - Creates several reports in output directory
+  #    -m, --min_percent=min_percent    The minimum percent a method must take before
+  #                                       being included in output reports.
+  #                                       This option is not supported for call tree.
+  #    -f, --file=path                  Output results to a file instead of standard out.
+  #        --mode=measure_mode          Select what ruby-prof should measure:
+  #                                       wall - Wall time (default).
+  #                                       process - Process time.
+  #                                       allocations - Object allocations (requires patched Ruby interpreter).
+  #                                       memory - Allocated memory in KB (requires patched Ruby interpreter).
+  #    -s, --sort=sort_mode             Select how ruby-prof results should be sorted:
+  #                                       total - Total time
+  #                                       self - Self time
+  #                                       wait - Wait time
+  #                                       child - Child time
+  #        --allow_exceptions           Raise exceptions encountered during profiling (true) or suppress them (false)
+  #    -R, --require-noprof=lib         require a specific library (not profiled)
+  #    -E, --eval-noprof=code           execute the ruby statements (not profiled)
+  #        --exclude=methods    A comma separated list of methods to exclude.
+  #                                       Specify instance methods via # (Integer#times)
+  #                                       Specify class methods via . (Integer.superclass)
+  #        --exclude-common             Remove common methods from the profile
+  #    -h, --help                       Show help message
+  #    -v, --version version            Show version (1.1.0)
+
   class Cmd
+    # :enddoc:
     attr_accessor :options
+    attr_reader :profile
 
     def initialize
       setup_options
@@ -36,15 +64,52 @@ module RubyProf
     def setup_options
       @options = OpenStruct.new
       options.printer = RubyProf::FlatPrinter
+      options.measure_mode = RubyProf::WALL_TIME
       options.min_percent = 0
       options.file = nil
-      options.replace_prog_name = false
-      options.specialized_instruction = false
-
+      options.allow_exceptions = false
+      options.exclude_common = false
+      options.exclude = Array.new
       options.pre_libs = Array.new
       options.pre_execs = Array.new
     end
 
+    # This is copied from ActiveSupport:
+    def constantize(camel_cased_word)
+      if !camel_cased_word.include?("::")
+        Object.const_get(camel_cased_word)
+      else
+        names = camel_cased_word.split("::")
+
+        # Trigger a built-in NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check if it is owned directly. The check
+            # stops when we reach Object or the end of ancestors tree.
+            constant = constant.ancestors.inject(constant) do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+    end
+
     def option_parser
       OptionParser.new do |opts|
         opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
@@ -56,7 +121,6 @@ module RubyProf
         opts.on('-p printer', '--printer=printer', [:flat, :flat_with_line_numbers, :graph, :graph_html, :call_tree, :call_stack, :dot, :multi],
                 'Select a printer:',
                 '  flat - Prints a flat profile as text (default).',
-                '  flat_with_line_numbers - same as flat, with line numbers.',
                 '  graph - Prints a graph profile as text.',
                 '  graph_html - Prints a graph profile as html.',
                 '  call_tree - format for KCacheGrind',
@@ -65,12 +129,9 @@ module RubyProf
                 '  multi - Creates several reports in output directory'
         ) do |printer|
 
-
           case printer
           when :flat
             options.printer = RubyProf::FlatPrinter
-          when :flat_with_line_numbers
-            options.printer = RubyProf::FlatPrinterWithLineNumbers
           when :graph
             options.printer = RubyProf::GraphPrinter
           when :graph_html
@@ -89,7 +150,7 @@ module RubyProf
         opts.on('-m min_percent', '--min_percent=min_percent', Float,
                 'The minimum percent a method must take before ',
                 '  being included in output reports.',
-                '  this option is not supported for call tree.') do |min_percent|
+                '  This option is not supported for call tree.') do |min_percent|
           options.min_percent = min_percent
         end
 
@@ -100,31 +161,22 @@ module RubyProf
         end
 
         opts.on('--mode=measure_mode',
-                [:process, :wall, :cpu, :allocations, :memory, :gc_runs, :gc_time],
+                [:process, :wall, :allocations, :memory],
                 'Select what ruby-prof should measure:',
                 '  wall - Wall time (default).',
                 '  process - Process time.',
-                '  cpu - CPU time (Pentium and PowerPCs only).',
                 '  allocations - Object allocations (requires patched Ruby interpreter).',
-                '  memory - Allocated memory in KB (requires patched Ruby interpreter).',
-                '  gc_runs - Number of garbage collections (requires patched Ruby interpreter).',
-                '  gc_time - Time spent in garbage collection (requires patched Ruby interpreter).') do |measure_mode|
+                '  memory - Allocated memory in KB (requires patched Ruby interpreter).') do |measure_mode|
 
           case measure_mode
           when :wall
             options.measure_mode = RubyProf::WALL_TIME
           when :process
             options.measure_mode = RubyProf::PROCESS_TIME
-          when :cpu
-            options.measure_mode = RubyProf::CPU_TIME
           when :allocations
             options.measure_mode = RubyProf::ALLOCATIONS
           when :memory
             options.measure_mode = RubyProf::MEMORY
-          when :gc_runs
-            options.measure_mode = RubyProf::GC_RUNS
-          when :gc_time
-            options.measure_mode = RubyProf::GC_TIME
           end
         end
 
@@ -147,94 +199,45 @@ module RubyProf
                                 end
         end
 
-        opts.on("--replace-progname", "Replace $0 when loading the .rb files.") do
-          options.replace_prog_name = true
-        end
-
-        if defined?(RubyVM)
-          opts.on("--specialized-instruction", "Turn on specified instruction.") do
-            options.specialized_instruction = true
-          end
-        end
-
         opts.on_tail("-h", "--help", "Show help message") do
           puts opts
           exit
         end
 
-        opts.on_tail("--version", "Show version #{RubyProf::VERSION}") do
+        opts.on_tail("-v version", "--version", "Show version (#{RubyProf::VERSION})") do
           puts "ruby_prof " + RubyProf::VERSION
           exit
         end
 
-        opts.on("-v","Show version, set $VERBOSE to true, profile script if option given") do
-          puts "ruby version: " + [RUBY_PATCHLEVEL, RUBY_PLATFORM, RUBY_VERSION].join(' ')
-          $VERBOSE = true
-        end
-
-        opts.on("-d", "Set $DEBUG to true") do
-          $DEBUG = true
+        opts.on('--allow_exceptions', 'Raise exceptions encountered during profiling (true) or suppress them (false)') do
+          options.allow_exceptions = true
         end
 
-        opts.on('-R lib', '--require-noprof lib', 'require a specific library (not profiled)') do |lib|
+        opts.on('-R lib', '--require-noprof=lib', 'require a specific library (not profiled)') do |lib|
           options.pre_libs << lib
         end
 
-        opts.on('-E code', '--eval-noprof code', 'execute the ruby statements (not profiled)') do |code|
+        opts.on('-E code', '--eval-noprof=code', 'execute the ruby statements (not profiled)') do |code|
           options.pre_execs << code
         end
 
-        opts.on('-x regexp', '--exclude regexp', 'exclude methods by regexp (see method elimination)') do|meth|
-          options.eliminate_methods ||= []
-          options.eliminate_methods << Regexp.new(meth)
-        end
-
-        opts.on('-X file', '--exclude-file file', 'exclude methods by regexp listed in file (see method elimination)') do|file|
-          options.eliminate_methods_files ||= []
-          options.eliminate_methods_files << file
-        end
-
-        opts.on('--exclude-common-cycles', 'make common iterators like Integer#times appear inlined') do |meth|
-          options.eliminate_methods ||= []
-          options.eliminate_methods += %w{
-            Integer#times
-            Integer#upto
-            Integer#downto
-            Enumerator#each
-            Enumerator#each_with_index
-            Enumerator#each_with_object
-
-            Array#each
-            Array#each_index
-            Array#reverse_each
-            Array#map
-
-            Hash#each
-            Hash#each_pair
-            Hash#each_key
-            Hash#each_value
-
-            Range#each
-            Enumerable#each_cons
-            Enumerable#each_entry
-            Enumerable#each_slice
-            Enumerable#each_with_index
-            Enumerable#each_with_object
-            Enumerable#reverse_each
-            Enumerable#inject
-            Enumerable#collect
-            Enumerable#reduce
-          }
-          #TODO: may be the whole Enumerable module should be excluded via 'Enumerable#.*', we need feedback on use cases.
+        opts.on('--exclude=methods', String,
+                'A comma separated list of methods to exclude.',
+                '  Specify instance methods via # (Integer#times)',
+                '  Specify class methods via . (Integer.superclass)') do |exclude_string|
+          exclude_string.split(',').each do |string|
+            match = string.strip.match(/(.*)(#|\.)(.*)/)
+            klass = constantize(match[1])
+            if match[2] == '.'
+              klass = klass.singleton_class
+            end
+            method = match[3].to_sym
+            options.exclude << [klass, method]
+          end
         end
 
-        opts.on('--exclude-common-callbacks', 'make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph') do|meth|
-          options.eliminate_methods ||= []
-          options.eliminate_methods += %w{
-            Method#call
-            Proc#call
-            ActiveSupport::Callbacks::ClassMethods#__run_callback
-          }
+        opts.on('--exclude-common', 'Remove common methods from the profile') do
+          options.exclude_common = true
         end
       end
     end
@@ -278,23 +281,15 @@ module RubyProf
     end
 
     def run
-      # Get the script we will execute
       script = ARGV.shift
-      if options.replace_prog_name
-        $0 = File.expand_path(script)
+      @profile = Profile.new(options.to_h)
+      options.exclude.each do |klass, method|
+        @profile.exclude_method!(klass, method)
       end
 
-      # Set VM compile option
-      if defined?(RubyVM)
-        RubyVM::InstructionSequence.compile_option = {
-            :trace_instruction => true,
-            :specialized_instruction => options.specialized_instruction
-        }
+      profile.profile do
+       load script
       end
-
-      # Set the measure mode
-      RubyProf.measure_mode = options.measure_mode if options.measure_mode
-      RubyProf.start_script(script)
     end
   end
 end
@@ -307,20 +302,8 @@ cmd = RubyProf::Cmd.new
 # *after* any other one that will be installed.
 
 at_exit {
-  # Stop profiling
-  result = RubyProf.stop
-
-  # Eliminate unwanted methods from call graph
-  if cmd.options.eliminate_methods
-    result.eliminate_methods!(cmd.options.eliminate_methods)
-  end
-
-  if cmd.options.eliminate_methods_files
-    cmd.options.eliminate_methods_files.each {|f| result.eliminate_methods!(f)}
-  end
-
   # Create a printer
-  printer = cmd.options.printer.new(result)
+  printer = cmd.options.printer.new(cmd.profile)
   printer_options = {:min_percent => cmd.options.min_percent, :sort_method => cmd.options.sort_method}
 
   # Get output

data/ext/ruby_prof/extconf.rb

@@ -5,34 +5,16 @@ if RUBY_ENGINE != "ruby"
   exit(1)
 end
 
-if RUBY_VERSION < "1.9.3"
-  STDERR.puts("\n\n***** Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to 1.9.3 or higher. *****\n\n")
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
+  STDERR.puts("\n\n***** Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to 2.3 or higher. *****\n\n")
   exit(1)
 end
 
 # For the love of bitfields...
 $CFLAGS += ' -std=c99'
 
-# standard ruby methods
-have_func("rb_gc_stat")
-have_func("rb_gc_count")
-have_func("rb_remove_event_hook_with_data")
-
-# Alexander Dymo GC patch
-have_func("rb_os_allocated_objects")
-have_func("rb_gc_allocated_size")
-
-# Stefan Kaes GC patches
-have_func("rb_gc_collections")
-have_func("rb_gc_time")
-# for ruby 2.1
-have_func("rb_gc_total_time")
-have_func("rb_gc_total_mallocs")
-have_func("rb_gc_total_malloced_bytes")
-
-# Lloyd Hilaiel's heap info patch
-have_func("rb_heap_total_mem")
-have_func("rb_gc_heap_info")
+# And since we are using C99
+CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
 
 def add_define(name, value = nil)
   if value
@@ -46,23 +28,9 @@ def windows?
   RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
 end
 
-if !windows? && RUBY_PLATFORM !~ /(darwin|openbsd)/
-  $LDFLAGS += " -lrt" # for clock_gettime
-end
 add_define("RUBY_PROF_RUBY_VERSION", RUBY_VERSION.split('.')[0..2].inject(0){|v,d| v*100+d.to_i})
 
-# for ruby 1.9, determine whether threads inherit trace flags (latest 1.9.2 and later should work correctly)
-if RUBY_VERSION > "1.9"
-  require 'set'
-  threads = Set.new
-  set_trace_func lambda { |*args| threads << Thread.current.object_id }
-  Thread.new{1}.join
-  set_trace_func nil
-  if threads.size < 2
-    # if we end up here, ruby does not automatically activate tracing in spawned threads
-    STDERR.puts("Ruby #{RUBY_VERSION} does not activate tracing in spawned threads. Consider upgrading.")
-    exit(1)
-  end
-end
+# This function was added in Ruby 2.5, so once Ruby 2.4 is no longer supported this can be removed
+have_func('rb_tracearg_callee_id', ["ruby.h"])
 
 create_makefile("ruby_prof")

data/ext/ruby_prof/rp_aggregate_call_tree.c

@@ -0,0 +1,41 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#include "rp_aggregate_call_tree.h"
+
+VALUE cRpAggregateCallTree;
+
+void prof_aggregate_call_tree_mark(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+
+    if (call_tree->object != Qnil)
+        rb_gc_mark(call_tree->object);
+
+    if (call_tree->source_file != Qnil)
+        rb_gc_mark(call_tree->source_file);
+
+    prof_measurement_mark(call_tree->measurement);
+}
+
+static void prof_aggregate_call_tree_ruby_gc_free(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+    prof_call_tree_free(call_tree);
+}
+
+VALUE prof_aggregate_call_tree_wrap(prof_call_tree_t* call_tree)
+{
+    if (call_tree->object == Qnil)
+    {
+        call_tree->object = Data_Wrap_Struct(cRpAggregateCallTree, prof_aggregate_call_tree_mark, prof_aggregate_call_tree_ruby_gc_free, call_tree);
+    }
+    return call_tree->object;
+}
+
+void rp_init_aggregate_call_tree()
+{
+    // AggregateCallTree
+    cRpAggregateCallTree = rb_define_class_under(mProf, "AggregateCallTree", cRpCallTree);
+    rb_undef_method(CLASS_OF(cRpAggregateCallTree), "new");
+}