airbnb-ruby-prof 0.0.1

data/test/thread_test.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require 'timeout'
+require 'benchmark'
+
+# --  Tests ----
+class ThreadTest < TestCase
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def test_thread_count
+    RubyProf.start
+
+    thread = Thread.new do
+      sleep(1)
+    end
+
+    thread.join
+    result = RubyProf.stop
+    assert_equal(2, result.threads.length)
+  end
+
+  def test_thread_identity
+    RubyProf.start
+    sleep_thread = Thread.new do
+      sleep(1)
+    end
+    sleep_thread.join
+    result = RubyProf.stop
+
+    thread_ids = result.threads.map {|thread| thread.id}.sort
+    threads = [Thread.current, sleep_thread]
+    assert_equal(2, result.threads.length)
+
+    assert(thread_ids.include?(threads[0].object_id))
+    assert(thread_ids.include?(threads[1].object_id))
+
+    assert_instance_of(Thread, ObjectSpace._id2ref(thread_ids[0]))
+    assert(threads.include?(ObjectSpace._id2ref(thread_ids[0])))
+
+    assert_instance_of(Thread, ObjectSpace._id2ref(thread_ids[1]))
+    assert(threads.include?(ObjectSpace._id2ref(thread_ids[1])))
+  end
+
+  def test_thread_timings
+    RubyProf.start
+    thread = Thread.new do
+      sleep 0
+      # force it to hit thread.join, below, first
+      # thus forcing sleep(1), below, to be counted as (wall) self_time
+      # since we currently count time "in some other thread" as self.wait_time
+      # for whatever reason
+      sleep(1)
+    end
+    thread.join
+    result = RubyProf.stop
+
+    # Check background thread
+    assert_equal(2, result.threads.length)
+
+    rp_thread = result.threads.detect {|t| t.id == thread.object_id}
+    methods = rp_thread.methods.sort.reverse
+    # fails on travis. why?
+    # expected_methods = ["ThreadTest#test_thread_timings", "Kernel#sleep"]
+    # assert_equal(expected_methods, methods.map(&:full_name))
+
+    method = methods[0]
+    assert_equal('ThreadTest#test_thread_timings', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(1, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(1, method.children_time, 0.05)
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings', call_info.call_sequence)
+    assert_equal(1, call_info.children.length)
+
+    method = methods[1]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(2, method.called)
+    assert_in_delta(1, method.total_time, 0.05)
+    assert_in_delta(1.0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings->Kernel#sleep', call_info.call_sequence)
+    assert_equal(0, call_info.children.length)
+
+    # Check foreground thread
+    rp_thread = result.threads.detect {|athread| athread.id == Thread.current.object_id}
+    methods = rp_thread.methods.sort.reverse
+    assert_equal(4, methods.length)
+    methods = methods.sort.reverse
+
+    method = methods[0]
+    assert_equal('ThreadTest#test_thread_timings', method.full_name)
+    # the sub calls to Object#new, when popped,
+    # cause the parent frame to be created for method #test_thread_timings, which means a +1 when it's popped in the end
+    # xxxx a test that shows it the other way, too (never creates parent frame--if that's even possible)
+    assert_equal(1, method.called)
+    assert_in_delta(1, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(1, method.children_time, 0.05)
+
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings', call_info.call_sequence)
+    assert_equal(2, call_info.children.length)
+
+    method = methods[1]
+    assert_equal('Thread#join', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(1, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(1.0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings->Thread#join', call_info.call_sequence)
+    assert_equal(0, call_info.children.length)
+
+    method = methods[2]
+    assert_equal('<Class::Thread>#new', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings-><Class::Thread>#new', call_info.call_sequence)
+    assert_equal(1, call_info.children.length)
+
+    method = methods[3]
+    assert_equal('Thread#initialize', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    assert_equal(1, method.call_infos.length)
+    call_info = method.call_infos[0]
+    assert_equal('ThreadTest#test_thread_timings-><Class::Thread>#new->Thread#initialize', call_info.call_sequence)
+    assert_equal(0, call_info.children.length)
+  end
+
+  # useless test: what does it test?
+  def test_thread_back_and_forth
+    result = nil
+    seconds = Benchmark.realtime do
+      result = RubyProf.profile do
+        a = Thread.new { 100_000.times { sleep 0 }}
+        b = Thread.new { 100_000.times { sleep 0 }}
+        a.join
+        b.join
+      end
+    end
+    methods = result.threads.map {|thread| thread.methods}
+    timings = methods.flatten.sort
+    assert(timings[-1].total_time < seconds)
+  end
+
+  # useless test: what does it test?
+  def test_thread
+    RubyProf.profile do
+      begin
+        Timeout::timeout(2) do
+          while true
+            next
+          end
+        end
+      rescue Timeout::Error
+      end
+    end
+  end
+end

data/test/unique_call_path_test.rb

@@ -0,0 +1,202 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class UniqueCallPath
+  def method_a(i)
+    if i==1
+      method_b
+    else
+      method_c
+    end
+  end
+
+  def method_b
+    method_c
+  end
+
+  def method_c
+  end
+
+  def method_k(i)
+    method_a(i)
+  end
+end
+
+
+# --  Tests ----
+class UniqueCallPathTest < TestCase
+  def test_root_method
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf.profile do
+      unique_call_path.method_a(1)
+    end
+
+    root_methods = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.root?
+          root_methods.push(m)
+        end
+      end
+    end
+
+    assert_equal(1, root_methods.length)
+    assert_equal("UniqueCallPathTest#test_root_method", root_methods[0].full_name)
+  end
+
+  def test_root_children
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(2)
+    end
+
+    root_methods = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.root?
+          root_methods.push(m)
+        end
+      end
+    end
+
+    assert_equal(1, root_methods.length)
+
+    root_children = Array.new
+    root_methods[0].children.each do | c |
+      if c.parent.target.eql?(root_methods[0])
+        root_children.push(c)
+      end
+    end
+
+    children = root_children.sort do |c1, c2|
+      c1.target.full_name <=> c2.target.full_name
+    end
+
+    assert_equal(2, children.length)
+    assert_equal("UniqueCallPath#method_a", children[0].target.full_name)
+    assert_equal("UniqueCallPath#method_k", children[1].target.full_name)
+  end
+
+  def test_children_of
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(2)
+    end
+
+    root_methods = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.root?
+          root_methods.push(m)
+        end
+      end
+    end
+
+    assert_equal(1, root_methods.length)
+    method = root_methods[0]
+    assert_equal('UniqueCallPathTest#test_children_of', method.full_name)
+
+    call_info_a = nil
+    root_methods[0].children.each do | c |
+      if c.target.full_name == "UniqueCallPath#method_a"
+        call_info_a = c
+        break
+      end
+    end
+
+    assert !call_info_a.nil?
+
+    children_of_a = Array.new
+
+    call_info_a.children.each do | c |
+      if c.parent.eql?(call_info_a)
+        children_of_a.push(c)
+      end
+    end
+
+    assert_equal(2, call_info_a.target.children.length)
+
+    children_of_a = children_of_a.sort do |c1, c2|
+      c1.target.full_name <=> c2.target.full_name
+    end
+
+    assert_equal(1, children_of_a.length)
+    assert_equal("UniqueCallPath#method_b", children_of_a[0].target.full_name)
+  end
+
+  def test_id2ref
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf.profile do
+      unique_call_path.method_a(1)
+    end
+
+    root_methods = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.root?
+          root_methods.push(m)
+        end
+      end
+    end
+
+    child = root_methods[0].children[0]
+
+    refute_equal(0, child.object_id)
+    #assert_equal(RubyProf::CallInfo.id2ref(child.id).target.full_name, child.target.full_name)
+  end
+
+  def test_unique_path
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(1)
+    end
+
+    root_methods = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.root?
+          root_methods.push(m)
+        end
+      end
+    end
+
+    assert_equal(1, root_methods.length)
+
+    call_info_a = nil
+    root_methods[0].children.each do | c |
+      if c.target.full_name == "UniqueCallPath#method_a"
+        call_info_a = c
+        break
+      end
+    end
+
+    assert !call_info_a.nil?
+
+    children_of_a = Array.new
+    call_info_a.children.each do |c|
+      if c.parent.eql?(call_info_a)
+        children_of_a.push(c)
+      end
+    end
+
+    assert_equal(2, call_info_a.target.children.length)
+
+    children_of_a = children_of_a.sort do |c1, c2|
+      c1.target.full_name <=> c2.target.full_name
+    end
+
+    assert_equal(1, children_of_a.length)
+    assert_equal(1, children_of_a[0].called)
+    assert_equal("UniqueCallPath#method_b", children_of_a[0].target.full_name)
+  end
+end

data/test/yarv_test.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# tests for bugs reported by users
+class BugsTest < TestCase
+  def setup
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+    define_methods
+  end
+
+  def test_array_push_unoptimized
+    a = nil
+    result = RubyProf.profile do
+      a = self.array_push_unoptimized
+    end
+    assert_equal 2, a.length
+    assert_equal ["BugsTest#test_array_push_unoptimized", "BugsTest#array_push_unoptimized", 'Array#<<', "Array#push"], result.threads.first.methods.map(&:full_name)
+  end
+
+  def test_array_push_optimized
+    a = nil
+    result = RubyProf.profile do
+      a = self.array_push_optimized
+    end
+    assert_equal 2, a.length
+    assert_equal ["BugsTest#test_array_push_optimized", "BugsTest#array_push_optimized", "Array#push"], result.threads.first.methods.map(&:full_name)
+  end
+
+  private
+  def define_methods
+    return if respond_to?(:array_push_optimized)
+    old_compile_option = RubyVM::InstructionSequence.compile_option
+    RubyVM::InstructionSequence.compile_option = {
+      :trace_instruction => true,
+      :specialized_instruction => false
+    }
+    self.class.class_eval <<-"EOM"
+      def array_push_unoptimized
+        a = []
+        a << 1
+        a.push 2
+      end
+    EOM
+    RubyVM::InstructionSequence.compile_option = old_compile_option
+    self.class.class_eval <<-"EOM"
+      def array_push_optimized
+        a = []
+        a << 1
+        a.push 2
+      end
+    EOM
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: airbnb-ruby-prof
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  name: minitest
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake-compiler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+description: ! '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.
+
+'
+email: shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com, skaes@railsexpress.de
+executables:
+- ruby-prof
+- ruby-prof-check-trace
+extensions:
+- ext/ruby_prof/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGES
+- LICENSE
+- Rakefile
+- README.rdoc
+- ruby-prof.gemspec
+- bin/ruby-prof
+- bin/ruby-prof-check-trace
+- examples/flat.txt
+- examples/graph.dot
+- examples/graph.html
+- examples/graph.txt
+- examples/multi.flat.txt
+- examples/multi.graph.html
+- examples/multi.grind.dat
+- examples/multi.stack.html
+- examples/stack.html
+- ext/ruby_prof/extconf.rb
+- ext/ruby_prof/rp_call_info.c
+- ext/ruby_prof/rp_fast_call_tree_printer.c
+- ext/ruby_prof/rp_measure.c
+- ext/ruby_prof/rp_measure_allocations.c
+- ext/ruby_prof/rp_measure_cpu_time.c
+- ext/ruby_prof/rp_measure_gc_runs.c
+- ext/ruby_prof/rp_measure_gc_time.c
+- ext/ruby_prof/rp_measure_memory.c
+- ext/ruby_prof/rp_measure_process_time.c
+- ext/ruby_prof/rp_measure_wall_time.c
+- ext/ruby_prof/rp_method.c
+- ext/ruby_prof/rp_stack.c
+- ext/ruby_prof/rp_thread.c
+- ext/ruby_prof/ruby_prof.c
+- ext/ruby_prof/rp_call_info.h
+- ext/ruby_prof/rp_fast_call_tree_printer.h
+- ext/ruby_prof/rp_measure.h
+- ext/ruby_prof/rp_method.h
+- ext/ruby_prof/rp_stack.h
+- ext/ruby_prof/rp_thread.h
+- ext/ruby_prof/ruby_prof.h
+- ext/ruby_prof/vc/ruby_prof.sln
+- ext/ruby_prof/vc/ruby_prof_18.vcxproj
+- ext/ruby_prof/vc/ruby_prof_19.vcxproj
+- ext/ruby_prof/vc/ruby_prof_20.vcxproj
+- lib/ruby-prof.rb
+- lib/unprof.rb
+- lib/ruby-prof/aggregate_call_info.rb
+- lib/ruby-prof/call_info.rb
+- lib/ruby-prof/call_info_visitor.rb
+- lib/ruby-prof/compatibility.rb
+- lib/ruby-prof/method_info.rb
+- lib/ruby-prof/profile.rb
+- lib/ruby-prof/rack.rb
+- lib/ruby-prof/task.rb
+- lib/ruby-prof/thread.rb
+- lib/ruby-prof/version.rb
+- lib/ruby-prof/walker.rb
+- lib/ruby-prof/assets/call_stack_printer.css.html
+- lib/ruby-prof/assets/call_stack_printer.js.html
+- lib/ruby-prof/assets/flame_graph_printer.lib.css.html
+- lib/ruby-prof/assets/flame_graph_printer.lib.js.html
+- lib/ruby-prof/assets/flame_graph_printer.page.js.html
+- lib/ruby-prof/assets/call_stack_printer.png
+- lib/ruby-prof/assets/flame_graph_printer.tmpl.html.erb
+- lib/ruby-prof/profile/exclude_common_methods.rb
+- lib/ruby-prof/printers/abstract_printer.rb
+- lib/ruby-prof/printers/call_info_printer.rb
+- lib/ruby-prof/printers/call_stack_printer.rb
+- lib/ruby-prof/printers/call_tree_printer.rb
+- lib/ruby-prof/printers/dot_printer.rb
+- lib/ruby-prof/printers/fast_call_tree_printer.rb
+- lib/ruby-prof/printers/flame_graph_html_printer.rb
+- lib/ruby-prof/printers/flame_graph_json_printer.rb
+- lib/ruby-prof/printers/flat_printer.rb
+- lib/ruby-prof/printers/flat_printer_with_line_numbers.rb
+- lib/ruby-prof/printers/graph_html_printer.rb
+- lib/ruby-prof/printers/graph_printer.rb
+- lib/ruby-prof/printers/multi_printer.rb
+- test/aggregate_test.rb
+- test/basic_test.rb
+- test/block_test.rb
+- test/call_info_test.rb
+- test/call_info_visitor_test.rb
+- test/duplicate_names_test.rb
+- test/dynamic_method_test.rb
+- test/enumerable_test.rb
+- test/exceptions_test.rb
+- test/exclude_methods_test.rb
+- test/exclude_threads_test.rb
+- test/fiber_test.rb
+- test/issue137_test.rb
+- test/line_number_test.rb
+- test/measure_allocations_test.rb
+- test/measure_cpu_time_test.rb
+- test/measure_gc_runs_test.rb
+- test/measure_gc_time_test.rb
+- test/measure_memory_test.rb
+- test/measure_process_time_test.rb
+- test/measure_wall_time_test.rb
+- test/module_test.rb
+- test/multi_measure_test.rb
+- test/multi_printer_test.rb
+- test/no_method_class_test.rb
+- test/pause_resume_test.rb
+- test/prime.rb
+- test/printers_test.rb
+- test/printing_recursive_graph_test.rb
+- test/rack_test.rb
+- test/recursive_test.rb
+- test/singleton_test.rb
+- test/stack_printer_test.rb
+- test/stack_test.rb
+- test/start_stop_test.rb
+- test/test_helper.rb
+- test/thread_test.rb
+- test/unique_call_path_test.rb
+- test/yarv_test.rb
+homepage: https://github.com/ruby-prof/ruby-prof
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2681757346368382202
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fast Ruby profiler
+test_files:
+- test/test_helper.rb