ruby-prof 1.1.0-x64-mingw32 → 1.4.2-x64-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a058890ba891a0ccc0d5ef289dd4a5e0067359592ed04f95047a3bf30d0839
-  data.tar.gz: 833c854ce3e2790ea696f411f5b3c8fd1fd9827e9eca4ffa0d2e3bb21871dd60
+  metadata.gz: 73600e70119580caad0f948db3b7140018caefc19479b564d74162b978c95bd1
+  data.tar.gz: 227e85a005cc3e043ccd81b13d44aea555dd038f7506e683c48cead1ff2c7e33
 SHA512:
-  metadata.gz: e9c9c5e882ecd371ceb24365d46446e863fbcfaac365dbd84c1aed3ffd24fafe2d7b8e7bc7d09babe07fc8e0d8877fb5c112917b6c1915305cb881dc34f8d49c
-  data.tar.gz: 3206613c98c989672a6d329280c3076efb173e4fea0828b09f57ef4698f546aab8ec8cda04e6ef6ccd9d35101f8b2ae5af0a36b04f5c04fca6afa59543e34706
+  metadata.gz: 1af26fb86402e3d42fc9cac2c0657d14b74e0b0ff11424ffce1ae7f747d3583d135474ee77a9a70ed3f47768232f70a8d21aab868151075c93d5e61bfd2bf7ce
+  data.tar.gz: e34707b1a27a4da44897f19476dcdf5d1570662f10a897bb28397c70d4b3241eac64eff14bf2ebed7d9f4fd0436a82d4b2ae9652bcd803f00586e3ad66cb915a

data/CHANGES

@@ -1,3 +1,50 @@
+1.4.2 (2020-11-3)
+=====================
+* Do NOT use Ruby 2.7.0 and 2.7.1 with ruby-prof. A bug in those versions of ruby causes ruby-prof to
+not work. Version 2.7.2 works correctly.
+* Fix crash caused be reallocating an internal stack that keeps tracks of frames *after* getting a reference to the
+top frame in the stack (Charlie Savage).
+* Fix bug where the flat printer did not correctly report the correct measurement mode.
+
+1.4.1 (2020-05-14)
+=====================
+* Fix compiling on older versions of gcc that do not default to c99 (Charlie Savage)
+
+1.4.0 (2020-05-12)
+=====================
+* API change - remove merge_fibers support since it resulted in incorrect results or crashes (Charlie Savage)
+* Fix crash when profiling memory usage (Charlie Savage)
+* When tracing execution correctly print out newobj tracepoint events (Charlie Savage)
+* Remove no longer needed code for building extensions (Charlie Savage)
+
+1.3.2 (2020-04-19)
+=====================
+* Fix rack profiler so it is thread safe (Charlie Savage)
+* Fix loading of prebuilt binaries on mingw64 to use Ruby's major and minor version (Charlie Savage)
+
+1.3.1 (2020-03-11)
+=====================
+* Add max_percent and filter_by options to flat printer (Sean McGivern)
+* Include binary in mingw64 build (Charlie Savage)
+
+1.3.0 (2020-02-22)
+=====================
+* Update C code to use newer RTypedData API versus older RData API.
+* Update C code to use rb_cObject versus the older, deprecated, rb_cData.
+* Update memory management - CallInfo's now keep alive their owning Profile instances. Fixes crashes that
+  could happen in rare instances.
+
+1.2.0 (2020-01-23)
+=====================
+* Fix call stack printer broken in version 1.0.0 (Charlie Savage)
+* Ruby 2.7.0 support (Charlie Savage)
+* Switch to Windows high precision timer for measuring wall time (Charlie Savage)
+* Much better support for reverse call trees - if you start RubyProf at the bottom
+  of a call tree it will correctly calculate times as it ascends the tree (Charlie Savage)
+* Port AggregateCallInfo from Ruby to C to increase performance
+* API change - CallInfo has been renamed CallTree
+* Fix crashes on Ruby 2.4.*
+
 1.1.0 (2019-12-14)
 =====================
 Changes
@@ -342,7 +389,7 @@ Fixes
 
 0.7.1 (2008-11-28)
 ========================
-* Added new AggregateCallInfo class for printers to
+* Added new AggregateCallTree class for printers to
   make results easier to read.  Take this call sequence
   for example:
 

data/Rakefile

@@ -6,13 +6,6 @@ require "rake/testtask"
 require "rdoc/task"
 require "date"
 require "rake/clean"
-begin
-  require "bundler/setup"
-  Bundler::GemHelper.install_tasks
-  [:build, :install, :release].each {|t| Rake::Task[t].enhance [:rdoc] }
-rescue LoadError
-  $stderr.puts "Install bundler to get support for simplified gem publishing"
-end
 
 # To release a version of ruby-prof:
 #   * Update lib/ruby-prof/version.rb
@@ -23,10 +16,6 @@ end
 #   * rake package to create the gems
 #   * Tag the release (git tag 0.10.1)
 #   * Push to ruybgems.org (gem push pkg/<gem files>)
-# For a ruby only release, just run
-#   * rake release
-# it will push changes to github, tag the release, build the package and upload it to rubygems.org
-# and in case you forgot to increment the version number or have uncommitted changes, it will refuse to work
 
 GEM_NAME = 'ruby-prof'
 SO_NAME = 'ruby_prof'
@@ -38,9 +27,9 @@ Rake::ExtensionTask.new do |ext|
   ext.gem_spec = default_spec
   ext.name = SO_NAME
   ext.ext_dir = "ext/#{SO_NAME}"
-  ext.lib_dir = "lib/#{RUBY_VERSION}"
+  ext.lib_dir = "lib/#{Gem::Version.new(RUBY_VERSION).segments[0..1].join('.')}"
   ext.cross_compile = true
-  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+  ext.cross_platform = ['x64-mingw32']
 end
 
 # Rake task to build the default package
@@ -58,7 +47,6 @@ if RUBY_PLATFORM.match(/win32|mingw32/)
   win_spec = default_spec.clone
   win_spec.platform = Gem::Platform::CURRENT
   win_spec.files += Dir.glob('lib/**/*.so')
-  win_spec.instance_variable_set(:@cache_file, nil) # Hack to work around gem issue
 
   # Unset extensions
   win_spec.extensions = nil

data/bin/ruby-prof

@@ -1,7 +1,6 @@
 #! /usr/bin/env ruby
 
 # First require ruby-prof
-require 'rubygems'
 require 'ruby-prof'
 
 # Now setup option parser
@@ -14,64 +13,45 @@ module RubyProf
   # Profiles a Ruby program.
   #
   # == Usage
-  #
-  # ruby_prof [options] <script.rb> [--] [script-options]
+  # 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 reports.
-  #
-  #  -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
-  #                                   memory - Allocated memory
-  #
-  #  -s, --sort=sort_mode           Select how ruby-prof results should be sorted:
-  #                                   total - Total time
-  #                                   self - Self time
-  #                                   wait - Wait time
-  #                                   child - Child time
-  #
-  #  --replace-progname             Replace $0 when loading the .rb files.
-  #
-  #  --specialized-instruction      Turn on specified instruction.
-  #
-  #  -v                             Show version, set $VERBOSE to true, profile script if option given
-  #
-  #  -d                             Set $DEBUG to true
-  #
-  #  -R, --require-noprof lib       Require a specific library (not profiled)
-  #
-  #  -E, --eval-noprof code         Execute the ruby statements (not profiled)
-  #
-  #  -x, --exclude regexp           Exclude methods by regexp (see method elimination)
-  #
-  #  -X, --exclude-file file        Exclude methods by regexp listed in file (see method elimination)
-  #
-  #  --exclude-common-cycles        Make common iterators like Integer#times appear inlined
-  #
-  #  --exclude-common-callbacks     Make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph
-  #
-  #  -h, --help                     Show help message
-  #
-  #  --version                      Show version
-  #
-  #
+  #    -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
@@ -84,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" +
@@ -182,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
@@ -313,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
@@ -342,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

@@ -1,36 +1,16 @@
 require "mkmf"
 
-if RUBY_ENGINE != "ruby"
-  STDERR.puts("\n\n***** This gem is MRI-specific. It does not support #{RUBY_ENGINE}. *****\n\n")
-  exit(1)
-end
-
-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'
-
-# And since we are using C99
-CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
+# 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"])
 
-def add_define(name, value = nil)
-  if value
-    $defs.push("-D#{name}=#{value}")
-  else
-    $defs.push("-D#{name}")
-  end
+# We want to intermix declarations and code (ie, don't define all variables at the top of the method)
+unless RUBY_PLATFORM =~ /mswin/
+  $CFLAGS += ' -std=c99'
 end
 
-def windows?
-  RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+# And since we are using C99 we want to disable Ruby sending these warnings to gcc
+if CONFIG['warnflags']
+  CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
 end
 
-add_define("RUBY_PROF_RUBY_VERSION", RUBY_VERSION.split('.')[0..2].inject(0){|v,d| v*100+d.to_i})
-
-# 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")