ruby-prof 1.1.0

data/lib/ruby-prof/task.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'rake'
+require 'rake/testtask'
+require 'fileutils'
+
+module RubyProf
+
+  # Define a task library for profiling unit tests with ruby-prof.
+  #
+  # All of the options provided by
+  # the Rake:TestTask are supported except the loader
+  # which is set to ruby-prof.  For detailed information
+  # please refer to the Rake:TestTask documentation.
+  #
+  # ruby-prof specific options include:
+  #
+  #   output_dir - For each file specified an output
+  #                file with profile information will be
+  #                written to the output directory.
+  #                By default, the output directory is
+  #                called "profile" and is created underneath
+  #                the current working directory.
+  #
+  #   printer - Specifies the output printer.  Valid values include
+  #             :flat, :graph, :graph_html and :call_tree.
+  #
+  #   min_percent - Methods that take less than the specified percent
+  #                 will not be written out.
+  #
+  # Example:
+  #
+  #   require 'ruby-prof/task'
+  #
+  #   RubyProf::ProfileTask.new do |t|
+  #     t.test_files = FileList['test/test*.rb']
+  #     t.output_dir = "c:/temp"
+  #     t.printer = :graph
+  #     t.min_percent = 10
+  #   end
+  #
+  # If rake is invoked with a "TEST=filename" command line option,
+  # then the list of test files will be overridden to include only the
+  # filename specified on the command line.  This provides an easy way
+  # to run just one test.
+  #
+  # If rake is invoked with a "TESTOPTS=options" command line option,
+  # then the given options are passed to the test process after a
+  # '--'.  This allows Test::Unit options to be passed to the test
+  # suite.
+  #
+  # Examples:
+  #
+  #   rake profile                           # run tests normally
+  #   rake profile TEST=just_one_file.rb     # run just one test file.
+  #   rake profile TESTOPTS="-v"             # run in verbose mode
+  #   rake profile TESTOPTS="--runner=fox"   # use the fox test runner
+
+  class ProfileTask < Rake::TestTask
+    attr_accessor :output_dir
+    attr_accessor :min_percent
+    attr_accessor :printer
+
+    def initialize(name = :profile)
+      super(name)
+    end
+
+    # Create the tasks defined by this task lib.
+    def define
+      lib_path = @libs.join(File::PATH_SEPARATOR)
+      desc "Profile" + (@name==:profile ? "" : " for #{@name}")
+
+      task @name do
+        create_output_directory
+
+        @ruby_opts.unshift( "-I#{lib_path}" )
+        @ruby_opts.unshift( "-w" ) if @warning
+        @ruby_opts.push("-S ruby-prof")
+        @ruby_opts.push("--printer #{@printer}")
+        @ruby_opts.push("--min_percent #{@min_percent}")
+
+        file_list.each do |file_path|
+          run_script(file_path)
+        end
+      end
+      self
+    end
+
+    # Run script
+    def run_script(script_path)
+      run_code = ''
+      RakeFileUtils.verbose(@verbose) do
+        file_name = File.basename(script_path, File.extname(script_path))
+        case @printer
+          when :flat, :graph, :call_tree
+            file_name += ".txt"
+          when :graph_html
+            file_name += ".html"
+          else
+            file_name += ".txt"
+        end
+
+        output_file_path = File.join(output_directory, file_name)
+
+        command_line = @ruby_opts.join(" ") +
+                      " --file=" + output_file_path +
+                      " " + script_path
+
+        puts "ruby " + command_line
+        # We have to catch the exeption to continue on.  However,
+        # the error message will have been output to STDERR
+        # already by the time we get here so we don't have to
+        # do that again
+        begin
+          ruby command_line
+        rescue => e
+          STDOUT << e << "\n"
+          STDOUT.flush
+        end
+        puts ""
+        puts ""
+      end
+    end
+
+    def output_directory
+      File.expand_path(@output_dir)
+    end
+
+    def create_output_directory
+      if not File.exist?(output_directory)
+        Dir.mkdir(output_directory)
+      end
+    end
+
+    def clean_output_directory
+      if File.exist?(output_directory)
+        files = Dir.glob(output_directory + '/*')
+        FileUtils.rm(files)
+      end
+    end
+
+    def option_list # :nodoc:
+      ENV['OPTIONS'] || @options.join(" ") || ""
+    end
+  end
+end

data/lib/ruby-prof/thread.rb

@@ -0,0 +1,35 @@
+module RubyProf
+  class Thread
+    # Returns the root methods (ie, methods that were not called by other methods) that were profiled while
+    # this thread was executing. Generally there is only one root method (multiple root methods can occur
+    # when Profile#pause is used). By starting with the root methods, you can descend down the profile
+    # call tree.
+    def root_methods
+      self.methods.select do |method_info|
+        method_info.root?
+      end
+    end
+
+    # Returns the total time this thread was executed.
+    def total_time
+      self.root_methods.inject(0) do |sum, method_info|
+        method_info.callers.each do |call_info|
+          sum += call_info.total_time
+        end
+        sum
+      end
+    end
+
+    # Returns the amount of time this thread waited while other thread executed.
+    def wait_time
+      # wait_time, like self:time, is always method local
+      # thus we need to sum over all methods and call infos
+      self.methods.inject(0) do |sum, method_info|
+        method_info.callers.each do |call_info|
+          sum += call_info.wait_time
+        end
+        sum
+      end
+    end
+  end
+end

data/lib/ruby-prof/version.rb

@@ -0,0 +1,3 @@
+module RubyProf
+  VERSION = "1.1.0"
+end

data/lib/unprof.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require "ruby-prof"
+
+at_exit {
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+}
+RubyProf.start

data/ruby-prof.gemspec

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-prof/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-prof"
+
+  spec.homepage = "https://github.com/ruby-prof/ruby-prof/"
+  spec.summary = "Fast Ruby profiler"
+  spec.description = <<-EOF
+ruby-prof is a fast code profiler for Ruby. It is a C extension and
+therefore is many times faster than the standard Ruby profiler. It
+supports both flat and graph profiles.  For each method, graph profiles
+show how long the method ran, which methods called it and which
+methods it called. RubyProf generate both text and html and can output
+it to standard out or to a file.
+EOF
+  spec.license = 'BSD-2-Clause'
+  spec.version = RubyProf::VERSION
+
+  spec.author = "Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes"
+  spec.email = "shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com, skaes@railsexpress.de"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "lib"
+  spec.bindir = "bin"
+  spec.executables = ["ruby-prof", "ruby-prof-check-trace"]
+  spec.extensions = ["ext/ruby_prof/extconf.rb"]
+  spec.files = Dir['CHANGES',
+                   'LICENSE',
+                   'Rakefile',
+                   'README.rdoc',
+                   'ruby-prof.gemspec',
+                   'bin/ruby-prof',
+                   'bin/ruby-prof-check-trace',
+                   'doc/**/*',
+                   'examples/*',
+                   'ext/ruby_prof/extconf.rb',
+                   'ext/ruby_prof/*.c',
+                   'ext/ruby_prof/*.h',
+                   'ext/ruby_prof/vc/*.sln',
+                   'ext/ruby_prof/vc/*.vcxproj',
+                   'lib/ruby-prof.rb',
+                   'lib/unprof.rb',
+                   'lib/ruby-prof/*.rb',
+                   'lib/ruby-prof/assets/*',
+                   'lib/ruby-prof/profile/*.rb',
+                   'lib/ruby-prof/printers/*.rb',
+                   'test/*.rb']
+
+  spec.test_files = Dir["test/test_*.rb"]
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.date = Time.now.strftime('%Y-%m-%d')
+  spec.homepage = 'https://github.com/ruby-prof/ruby-prof'
+  spec.add_development_dependency('minitest')
+  spec.add_development_dependency('rake-compiler')
+  spec.add_development_dependency('rdoc')
+end

data/test/abstract_printer_test.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class AbstractPrinterTest < TestCase
+  def setup
+    @result = {}
+    @printer = RubyProf::AbstractPrinter.new(@result)
+    @options = {}
+    @printer.setup_options(@options)
+  end
+
+  private
+
+  def with_const_stubbed(name, value)
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    old_value = Object.const_get(name)
+
+    Object.const_set(name, value)
+    yield
+    Object.const_set(name, old_value)
+
+    $VERBOSE = old_verbose
+  end
+end

data/test/alias_test.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path("../test_helper", __FILE__)
+
+class AliasTest < TestCase
+  class TestMe
+    def some_method
+      sleep(0.1)
+    end
+
+    alias :some_method_original :some_method
+    def some_method
+      some_method_original
+    end
+  end
+
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  # This test only correct works on Ruby 2.5 and higher because - see:
+  # https://bugs.ruby-lang.org/issues/12747
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    def test_alias
+      result = RubyProf.profile do
+        TestMe.new.some_method
+      end
+
+      methods = result.threads.first.methods
+      assert_equal(6, methods.count)
+
+      # Method 0
+      method = methods[0]
+      assert_equal('AliasTest#test_alias', method.full_name)
+      assert_equal(28, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_nil(call_info.parent)
+      assert_equal(28, call_info.line)
+
+      assert_equal(2, method.callees.count)
+      call_info = method.callees[0]
+      assert_equal('Class#new', call_info.target.full_name)
+      assert_equal(28, call_info.line)
+
+      call_info = method.callees[1]
+      assert_equal('AliasTest::TestMe#some_method', call_info.target.full_name)
+      assert_equal(28, call_info.line)
+
+      # Method 1
+      method = methods[1]
+      assert_equal('Class#new', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_equal('AliasTest#test_alias', call_info.parent.full_name)
+      assert_equal(28, call_info.line)
+
+      assert_equal(1, method.callees.count)
+      call_info = method.callees[0]
+      assert_equal('BasicObject#initialize', call_info.target.full_name)
+      assert_equal(0, call_info.line)
+
+      # Method 2
+      method = methods[2]
+      assert_equal('BasicObject#initialize', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_equal('Class#new', call_info.parent.full_name)
+      assert_equal(0, call_info.line)
+
+      assert_equal(0, method.callees.count)
+
+      # Method 3
+      method = methods[3]
+      assert_equal('AliasTest::TestMe#some_method', method.full_name)
+      assert_equal(13, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_equal('AliasTest#test_alias', call_info.parent.full_name)
+      assert_equal(28, call_info.line)
+
+      assert_equal(1, method.callees.count)
+      call_info = method.callees[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_info.target.full_name)
+      assert_equal(14, call_info.line)
+
+      # Method 4
+      method = methods[4]
+      assert_equal('AliasTest::TestMe#some_method_original', method.full_name)
+      assert_equal(8, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_equal('AliasTest::TestMe#some_method', call_info.parent.full_name)
+      assert_equal(14, call_info.line)
+
+      assert_equal(1, method.callees.count)
+      call_info = method.callees[0]
+      assert_equal('Kernel#sleep', call_info.target.full_name)
+      assert_equal(9, call_info.line)
+
+      # Method 5
+      method = methods[5]
+      assert_equal('Kernel#sleep', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.callers.count)
+      call_info = method.callers[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_info.parent.full_name)
+      assert_equal(9, call_info.line)
+
+      assert_equal(0, method.callees.count)
+    end
+  end
+end

data/test/basic_test.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require_relative './measure_times'
+
+class BasicTest < TestCase
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def start
+    RubyProf.start
+    RubyProf::C1.sleep_wait
+  end
+
+  def test_running
+    assert(!RubyProf.running?)
+    RubyProf.start
+    assert(RubyProf.running?)
+    RubyProf.stop
+    assert(!RubyProf.running?)
+  end
+
+  def test_double_profile
+    RubyProf.start
+    assert_raises(RuntimeError) do
+      RubyProf.start
+    end
+    RubyProf.stop
+  end
+
+  def test_no_block
+    assert_raises(ArgumentError) do
+      RubyProf.profile
+    end
+  end
+
+  def test_traceback
+    RubyProf.start
+    assert_raises(NoMethodError) do
+      RubyProf.xxx
+    end
+
+    RubyProf.stop
+  end
+
+  def test_leave_method
+    start
+    sleep 0.15
+    profile = RubyProf.stop
+
+    assert_equal(1, profile.threads.count)
+
+    thread = profile.threads.first
+    assert_in_delta(0.25, thread.total_time, 0.05)
+
+    root_methods = thread.root_methods.sort
+    assert_equal(2, root_methods.count)
+    assert_equal("BasicTest#start", root_methods[0].full_name)
+    assert_equal("BasicTest#test_leave_method", root_methods[1].full_name)
+
+    assert_equal(4, thread.methods.length)
+    methods = profile.threads.first.methods.sort
+
+    # Check times
+    assert_equal("<Class::RubyProf::C1>#sleep_wait", methods[0].full_name)
+    assert_in_delta(0.1, methods[0].total_time, 0.05)
+    assert_in_delta(0.0,  methods[0].wait_time, 0.05)
+    assert_in_delta(0.0,  methods[0].self_time, 0.05)
+
+    assert_equal("BasicTest#start", methods[1].full_name)
+    assert_in_delta(0.1, methods[1].total_time, 0.05)
+    assert_in_delta(0.0, methods[1].wait_time, 0.05)
+    assert_in_delta(0.0, methods[1].self_time, 0.05)
+
+    assert_equal("BasicTest#test_leave_method", methods[2].full_name)
+    assert_in_delta(0.15, methods[2].total_time, 0.05)
+    assert_in_delta(0.0, methods[2].wait_time, 0.05)
+    assert_in_delta(0.0, methods[2].self_time, 0.05)
+
+    assert_equal("Kernel#sleep", methods[3].full_name)
+    assert_in_delta(0.25, methods[3].total_time, 0.05)
+    assert_in_delta(0.0, methods[3].wait_time, 0.05)
+    assert_in_delta(0.25, methods[3].self_time, 0.05)
+  end
+
+  def test_leave_method_2
+    start
+    RubyProf::C1.sleep_wait
+    RubyProf::C1.sleep_wait
+    profile = RubyProf.stop
+
+    assert_equal(1, profile.threads.count)
+
+    thread = profile.threads.first
+    assert_in_delta(0.3, thread.total_time, 0.05)
+
+    root_methods = thread.root_methods.sort
+    assert_equal(2, root_methods.count)
+    assert_equal("BasicTest#start", root_methods[0].full_name)
+    assert_equal("BasicTest#test_leave_method_2", root_methods[1].full_name)
+
+    assert_equal(4, thread.methods.length)
+    methods = profile.threads.first.methods.sort
+
+    # Check times
+    assert_equal("BasicTest#start", methods[0].full_name)
+    assert_in_delta(0.1, methods[0].total_time, 0.05)
+    assert_in_delta(0.0, methods[0].wait_time, 0.05)
+    assert_in_delta(0.0, methods[0].self_time, 0.05)
+
+    assert_equal("BasicTest#test_leave_method_2", methods[1].full_name)
+    assert_in_delta(0.2, methods[1].total_time, 0.05)
+    assert_in_delta(0.0, methods[1].wait_time, 0.05)
+    assert_in_delta(0.0, methods[1].self_time, 0.05)
+
+    assert_equal("Kernel#sleep", methods[2].full_name)
+    assert_in_delta(0.3, methods[2].total_time, 0.05)
+    assert_in_delta(0.0, methods[2].wait_time, 0.05)
+    assert_in_delta(0.3, methods[2].self_time, 0.05)
+
+    assert_equal("<Class::RubyProf::C1>#sleep_wait", methods[3].full_name)
+    assert_in_delta(0.3, methods[3].total_time, 0.05)
+    assert_in_delta(0.0, methods[3].wait_time, 0.05)
+    assert_in_delta(0.0, methods[3].self_time, 0.05)
+  end
+end