ruby-prof 1.0.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (C) 2005 - 2019 Shugo Maeda <shugo@ruby-lang.org>, Charlie Savage <cfis@savagexi.com> and
+                          Stefan Kaes <skaes@railsepxress.de>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,5 @@
+= ruby-prof
+
+{<img src="https://travis-ci.org/ruby-prof/ruby-prof.png?branch=master" alt="Build Status" />}[https://travis-ci.org/ruby-prof/ruby-prof]
+
+For an overview of ruby-prof please see https://ruby-prof.github.io

data/Rakefile

@@ -0,0 +1,110 @@
+# encoding: utf-8
+
+require "rubygems/package_task"
+require "rake/extensiontask"
+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
+#   * Update CHANGES
+#   * git commit to commit files
+#   * rake clobber to remove extra files
+#   * rake compile to build windows gems
+#   * 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'
+
+default_spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+# specify which versions/builds to cross compile
+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.cross_compile = true
+  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+end
+
+# Rake task to build the default package
+Gem::PackageTask.new(default_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+# make sure rdoc has been built when packaging
+# why do we ship rdoc as part of the gem?
+Rake::Task[:package].enhance [:rdoc]
+
+# Setup Windows Gem
+if RUBY_PLATFORM.match(/win32|mingw32/)
+  # Windows specification
+  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
+
+  # Rake task to build the windows package
+  Gem::PackageTask.new(win_spec) do |pkg|
+    pkg.need_tar = false
+  end
+end
+
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+RDoc::Task.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ruby-prof"
+  # Show source inline with line numbers
+  rdoc.options << "--line-numbers"
+  # Make the readme file the start page for the generated html
+  rdoc.options << '--main' << 'README.rdoc'
+  rdoc.rdoc_files.include('bin/*',
+                          'doc/*.rdoc',
+                          'lib/**/*.rb',
+                          'ext/ruby_prof/*.c',
+                          'ext/ruby_prof/*.h',
+                          'README.rdoc',
+                          'LICENSE')
+end
+
+task :default => :test
+
+for file in Dir['lib/**/*.{o,so,bundle}']
+  CLEAN.include file
+end
+for file in Dir['doc/**/*.{txt,dat,png,html}']
+  CLEAN.include file
+end
+CLEAN.reject!{|f| !File.exist?(f)}
+task :clean do
+  # remove tmp dir contents completely after cleaning
+  FileUtils.rm_rf('tmp/*')
+end
+
+desc 'Run the ruby-prof test suite'
+Rake::TestTask.new do |t|
+  t.libs += %w(lib ext test)
+  t.test_files = Dir['test/**_test.rb']
+  t.verbose = true
+  t.warning = true
+end

data/bin/ruby-prof

@@ -0,0 +1,380 @@
+#! /usr/bin/env ruby
+
+# First require ruby-prof
+require 'rubygems'
+require 'ruby-prof'
+
+# Now setup option parser
+require 'ostruct'
+require 'optparse'
+
+module RubyProf
+  # == Synopsis
+  #
+  # Profiles a Ruby program.
+  #
+  # == Usage
+  #
+  # ruby_prof [options] <script.rb> [--] [script-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
+  #
+  #
+  class Cmd
+    # :enddoc:
+    attr_accessor :options
+
+    def initialize
+      setup_options
+      parse_args
+
+      load_pre_libs
+      load_pre_execs
+    end
+
+    def setup_options
+      @options = OpenStruct.new
+      options.printer = RubyProf::FlatPrinter
+      options.min_percent = 0
+      options.file = nil
+      options.replace_prog_name = false
+      options.specialized_instruction = false
+
+      options.pre_libs = Array.new
+      options.pre_execs = Array.new
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
+            "Usage: ruby-prof [options] <script.rb> [--] [profiled-script-command-line-options]"
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        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).',
+                '  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'
+        ) do |printer|
+
+          case printer
+          when :flat
+            options.printer = RubyProf::FlatPrinter
+          when :graph
+            options.printer = RubyProf::GraphPrinter
+          when :graph_html
+            options.printer = RubyProf::GraphHtmlPrinter
+          when :call_tree
+            options.printer = RubyProf::CallTreePrinter
+          when :call_stack
+            options.printer = RubyProf::CallStackPrinter
+          when :dot
+            options.printer = RubyProf::DotPrinter
+          when :multi
+            options.printer = RubyProf::MultiPrinter
+          end
+        end
+
+        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|
+          options.min_percent = min_percent
+        end
+
+        opts.on('-f path', '--file=path',
+                'Output results to a file instead of standard out.') do |file|
+          options.file = file
+          options.old_wd = Dir.pwd
+        end
+
+        opts.on('--mode=measure_mode',
+                [:process, :wall, :allocations, :memory],
+                '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).') do |measure_mode|
+
+          case measure_mode
+          when :wall
+            options.measure_mode = RubyProf::WALL_TIME
+          when :process
+            options.measure_mode = RubyProf::PROCESS_TIME
+          when :allocations
+            options.measure_mode = RubyProf::ALLOCATIONS
+          when :memory
+            options.measure_mode = RubyProf::MEMORY
+          end
+        end
+
+        opts.on('-s sort_mode', '--sort=sort_mode', [:total, :self, :wait, :child],
+                'Select how ruby-prof results should be sorted:',
+                '  total - Total time',
+                '  self - Self time',
+                '  wait - Wait time',
+                '  child - Child time') do |sort_mode|
+
+          options.sort_method = case sort_mode
+                                when :total
+                                  :total_time
+                                when :self
+                                  :self_time
+                                when :wait
+                                  :wait_time
+                                when :child
+                                  :children_time
+                                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
+          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
+        end
+
+        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|
+          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.
+        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
+          }
+        end
+      end
+    end
+
+    def parse_args
+      # Make sure the user specified at least one file
+      if ARGV.length < 1 and not options.exec
+        puts self.option_parser
+        puts ""
+        puts "Must specify a script to run"
+        exit(-1)
+      end
+
+      self.option_parser.parse! ARGV
+
+      if options.printer.needs_dir?
+        options.file ||= "."
+        options.old_wd ||= Dir.pwd
+        if !File.directory?(options.file)
+          puts "'#{options.file}' is not a directory"
+          puts "#{options.printer} needs an existing directory path to put profiles under."
+          exit(-1)
+        end
+      end
+    rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument => e
+      puts self.option_parser
+      puts e.message
+      exit(-1)
+    end
+
+    def load_pre_libs
+      options.pre_libs.each do |lib|
+        require lib
+      end
+    end
+
+    def load_pre_execs
+      options.pre_execs.each do |exec|
+        eval(exec)
+      end
+    end
+
+    def run
+      # Get the script we will execute
+      script = ARGV.shift
+      if options.replace_prog_name
+        $0 = File.expand_path(script)
+      end
+
+      # Set VM compile option
+      if defined?(RubyVM)
+        RubyVM::InstructionSequence.compile_option = {
+            :trace_instruction => true,
+            :specialized_instruction => options.specialized_instruction
+        }
+      end
+
+      # Set the measure mode
+      RubyProf.measure_mode = options.measure_mode if options.measure_mode
+      RubyProf.start_script(script)
+    end
+  end
+end
+
+# Parse command line options
+cmd = RubyProf::Cmd.new
+
+# Install at_exit handler.  It is important that we do this
+# before loading the scripts so our at_exit handler run
+# *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_options = {:min_percent => cmd.options.min_percent, :sort_method => cmd.options.sort_method}
+
+  # Get output
+  if cmd.options.file
+    # write it relative to the dir they *started* in, as it's a bit surprising to write it in the dir they end up in.
+    Dir.chdir(cmd.options.old_wd) do
+      if printer.class.needs_dir?
+        printer.print(printer_options.merge(:path => cmd.options.file))
+      else
+        File.open(cmd.options.file, 'w') do |file|
+          printer.print(file, printer_options)
+        end
+      end
+    end
+  else
+    # Print out results
+    printer.print(STDOUT, printer_options)
+  end
+}
+
+# Now profile some code
+cmd.run