ruby-prof 1.4.3 → 1.6.3

data/test/scheduler.rb

@@ -0,0 +1,363 @@
+# frozen_string_literal: true
+
+# This is an example and simplified scheduler for test purposes.
+# It is not efficient for a large number of file descriptors as it uses IO.select().
+# Production Fiber schedulers should use epoll/kqueue/etc.
+
+require 'fiber'
+require 'socket'
+
+begin
+  require 'io/nonblock'
+rescue LoadError
+  # Ignore.
+end
+
+class Scheduler
+  experimental = Warning[:experimental]
+  begin
+    Warning[:experimental] = false
+    IO::Buffer.new(0)
+  ensure
+    Warning[:experimental] = experimental
+  end
+
+  def initialize
+    @readable = {}
+    @writable = {}
+    @waiting = {}
+
+    @closed = false
+
+    @lock = Thread::Mutex.new
+    @blocking = Hash.new.compare_by_identity
+    @ready = []
+
+    @urgent = IO.pipe
+  end
+
+  attr :readable
+  attr :writable
+  attr :waiting
+
+  def next_timeout
+    _fiber, timeout = @waiting.min_by{|key, value| value}
+
+    if timeout
+      offset = timeout - current_time
+
+      if offset < 0
+        return 0
+      else
+        return offset
+      end
+    end
+  end
+
+  def run
+    # $stderr.puts [__method__, Fiber.current].inspect
+
+    while @readable.any? or @writable.any? or @waiting.any? or @blocking.any?
+      # Can only handle file descriptors up to 1024...
+      readable, writable = IO.select(@readable.keys + [@urgent.first], @writable.keys, [], next_timeout)
+
+      # puts "readable: #{readable}" if readable&.any?
+      # puts "writable: #{writable}" if writable&.any?
+
+      selected = {}
+
+      readable&.each do |io|
+        if fiber = @readable.delete(io)
+          @writable.delete(io) if @writable[io] == fiber
+          selected[fiber] = IO::READABLE
+        elsif io == @urgent.first
+          @urgent.first.read_nonblock(1024)
+        end
+      end
+
+      writable&.each do |io|
+        if fiber = @writable.delete(io)
+          @readable.delete(io) if @readable[io] == fiber
+          selected[fiber] = selected.fetch(fiber, 0) | IO::WRITABLE
+        end
+      end
+
+      selected.each do |fiber, events|
+        fiber.resume(events)
+      end
+
+      if @waiting.any?
+        time = current_time
+        waiting, @waiting = @waiting, {}
+
+        waiting.each do |fiber, timeout|
+          if fiber.alive?
+            if timeout <= time
+              fiber.resume
+            else
+              @waiting[fiber] = timeout
+            end
+          end
+        end
+      end
+
+      if @ready.any?
+        ready = nil
+
+        @lock.synchronize do
+          ready, @ready = @ready, []
+        end
+
+        ready.each do |fiber|
+          fiber.resume
+        end
+      end
+    end
+  end
+
+  def scheduler_close
+    close(true)
+  end
+
+  def close(internal = false)
+    # $stderr.puts [__method__, Fiber.current].inspect
+
+    unless internal
+      if Fiber.scheduler == self
+        return Fiber.set_scheduler(nil)
+      end
+    end
+
+    if @closed
+      raise "Scheduler already closed!"
+    end
+
+    self.run
+  ensure
+    if @urgent
+      @urgent.each(&:close)
+      @urgent = nil
+    end
+
+    @closed ||= true
+
+    # We freeze to detect any unintended modifications after the scheduler is closed:
+    self.freeze
+  end
+
+  def closed?
+    @closed
+  end
+
+  def current_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+
+  def timeout_after(duration, klass, message, &block)
+    fiber = Fiber.current
+
+    self.fiber do
+      sleep(duration)
+
+      if fiber&.alive?
+        fiber.raise(klass, message)
+      end
+    end
+
+    begin
+      yield(duration)
+    ensure
+      fiber = nil
+    end
+  end
+
+  def process_wait(pid, flags)
+    # $stderr.puts [__method__, pid, flags, Fiber.current].inspect
+
+    # This is a very simple way to implement a non-blocking wait:
+    Thread.new do
+      Process::Status.wait(pid, flags)
+    end.value
+  end
+
+  def io_wait(io, events, duration)
+    # $stderr.puts [__method__, io, events, duration, Fiber.current].inspect
+
+    unless (events & IO::READABLE).zero?
+      @readable[io] = Fiber.current
+    end
+
+    unless (events & IO::WRITABLE).zero?
+      @writable[io] = Fiber.current
+    end
+
+    Fiber.yield
+  ensure
+    @readable.delete(io)
+    @writable.delete(io)
+  end
+
+  def io_select(...)
+    # Emulate the operation using a non-blocking thread:
+    Thread.new do
+      IO.select(...)
+    end.value
+  end
+
+  # Used for Kernel#sleep and Thread::Mutex#sleep
+  def kernel_sleep(duration = nil)
+    # $stderr.puts [__method__, duration, Fiber.current].inspect
+
+    self.block(:sleep, duration)
+
+    return true
+  end
+
+  # Used when blocking on synchronization (Thread::Mutex#lock,
+  # Thread::Queue#pop, Thread::SizedQueue#push, ...)
+  def block(blocker, timeout = nil)
+    # $stderr.puts [__method__, blocker, timeout].inspect
+
+    fiber = Fiber.current
+
+    if timeout
+      @waiting[fiber] = current_time + timeout
+      begin
+        Fiber.yield
+      ensure
+        # Remove from @waiting in the case #unblock was called before the timeout expired:
+        @waiting.delete(fiber)
+      end
+    else
+      @blocking[fiber] = true
+      begin
+        Fiber.yield
+      ensure
+        @blocking.delete(fiber)
+      end
+    end
+  end
+
+  # Used when synchronization wakes up a previously-blocked fiber
+  # (Thread::Mutex#unlock, Thread::Queue#push, ...).
+  # This might be called from another thread.
+  def unblock(blocker, fiber)
+    # $stderr.puts [__method__, blocker, fiber].inspect
+    # $stderr.puts blocker.backtrace.inspect
+    # $stderr.puts fiber.backtrace.inspect
+
+    @lock.synchronize do
+      @ready << fiber
+    end
+
+    io = @urgent.last
+    io.write_nonblock('.')
+  end
+
+  def fiber(&block)
+    fiber = Fiber.new(blocking: false, &block)
+
+    fiber.resume
+
+    return fiber
+  end
+
+  def address_resolve(hostname)
+    Thread.new do
+      Addrinfo.getaddrinfo(hostname, nil).map(&:ip_address).uniq
+    end.value
+  end
+end
+
+class IOBufferScheduler < Scheduler
+  EAGAIN = -Errno::EAGAIN::Errno
+
+  def io_read(io, buffer, length, offset)
+    total = 0
+    io.nonblock = true
+
+    while true
+      maximum_size = buffer.size - offset
+      result = blocking{buffer.read(io, maximum_size, offset)}
+
+      if result > 0
+        total += result
+        offset += result
+        break if total >= length
+      elsif result == 0
+        break
+      elsif result == EAGAIN
+        if length > 0
+          self.io_wait(io, IO::READABLE, nil)
+        else
+          return result
+        end
+      elsif result < 0
+        return result
+      end
+    end
+
+    return total
+  end
+
+  def io_write(io, buffer, length, offset)
+    total = 0
+    io.nonblock = true
+
+    while true
+      maximum_size = buffer.size - offset
+      result = blocking{buffer.write(io, maximum_size, offset)}
+
+      if result > 0
+        total += result
+        offset += result
+        break if total >= length
+      elsif result == 0
+        break
+      elsif result == EAGAIN
+        if length > 0
+          self.io_wait(io, IO::WRITABLE, nil)
+        else
+          return result
+        end
+      elsif result < 0
+        return result
+      end
+    end
+
+    return total
+  end
+
+  def blocking(&block)
+    Fiber.blocking(&block)
+  end
+end
+
+class BrokenUnblockScheduler < Scheduler
+  def unblock(blocker, fiber)
+    super
+
+    raise "Broken unblock!"
+  end
+end
+
+class SleepingUnblockScheduler < Scheduler
+  # This method is invoked when the thread is exiting.
+  def unblock(blocker, fiber)
+    super
+
+    # This changes the current thread state to `THREAD_RUNNING` which causes `thread_join_sleep` to hang.
+    sleep(0.1)
+  end
+end
+
+class SleepingBlockingScheduler < Scheduler
+  def kernel_sleep(duration = nil)
+    # Deliberaly sleep in a blocking state which can trigger a deadlock if the implementation is not correct.
+    Fiber.blocking{sleep 0.0001}
+
+    self.block(:sleep, duration)
+
+    return true
+  end
+end

data/test/singleton_test.rb

@@ -26,7 +26,7 @@ end
 
 class SingletonTest < TestCase
   def test_singleton
-    result = RubyProf.profile do
+    result = RubyProf::Profile.profile do
       a = A.new
       a << :first_thing
       assert_equal(1, a.as.size)

data/test/stack_printer_test.rb

@@ -27,16 +27,12 @@ class STPT
 end
 
 class StackPrinterTest < 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_stack_can_be_printed
     start_time = Time.now
-    RubyProf.start
-    5.times{STPT.new.a}
-    result = RubyProf.stop
+    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+      5.times{STPT.new.a}
+    end
+
     end_time = Time.now
     expected_time = end_time - start_time
 
@@ -50,6 +46,7 @@ class StackPrinterTest < TestCase
   end
 
   private
+
   def print(result)
     test = caller.first =~ /in `(.*)'/ ? $1 : "test"
     testfile_name = "#{Dir.tmpdir}/ruby_prof_#{test}.html"

data/test/start_stop_test.rb

@@ -5,37 +5,34 @@ require File.expand_path('../test_helper', __FILE__)
 
 class StartStopTest < TestCase
   def setup
+    super
     # Need to use wall time for this test due to the sleep calls
-    RubyProf::measure_mode = RubyProf::WALL_TIME
+    @profile = RubyProf::Profile.new(measure_mode: RubyProf::WALL_TIME)
   end
 
   def method1
-     RubyProf.start
-     method2
+    @profile.start
+    method2
   end
 
   def method2
-     method3
+    method3
   end
 
   def method3
     sleep(2)
-    @result = RubyProf.stop
+    @result = @profile.stop
   end
 
   def test_extra_stop_should_raise
-    RubyProf.start
+    @profile.start
     assert_raises(RuntimeError) do
-      RubyProf.start
+      @profile.start
     end
 
+    @profile.stop # ok
     assert_raises(RuntimeError) do
-      RubyProf.profile {}
-    end
-
-    RubyProf.stop # ok
-    assert_raises(RuntimeError) do
-      RubyProf.stop
+      @profile.stop
     end
   end
 
@@ -43,7 +40,7 @@ class StartStopTest < TestCase
     method1
 
     # Ruby prof should be stopped
-    assert_equal(false, RubyProf.running?)
+    assert_equal(false, @profile.running?)
 
     methods = @result.threads.first.methods.sort.reverse
     assert_equal(4, methods.length)

data/test/test_helper.rb

@@ -1,17 +1,20 @@
 # encoding: UTF-8
 
+# To make testing/debugging easier test within this source tree versus an installed gem
 require 'bundler/setup'
-require 'minitest/autorun'
 
-# Disable minitest parallel tests. The problem is the thread switching will change test results
-# (self vs wait time)
-if Gem::Version.new(Minitest::VERSION) > Gem::Version.new('5.11.3')
-  ENV["MT_CPU"] = "0" # Newer versions minitest
-else
-  ENV["N"] = "0" # Older versions of minitest
-end
+# Add ext directory to load path to make it easier to test locally built extensions
+ext_path = File.expand_path(File.join(__dir__, '..', 'ext', 'ruby_prof'))
+$LOAD_PATH.unshift(File.expand_path(ext_path))
 
+# Now load code
 require 'ruby-prof'
 
+# Disable minitest parallel tests. The problem is the thread switching will change test results
+# (self vs wait time)
+ENV["MT_CPU"] = "0" # New versions of minitest
+ENV["N"] = "0" # Older versions of minitest
+
+require 'minitest/autorun'
 class TestCase < Minitest::Test
 end

data/test/thread_test.rb

@@ -4,33 +4,122 @@
 require File.expand_path('../test_helper', __FILE__)
 require 'timeout'
 require 'benchmark'
+require_relative './call_tree_builder'
 
 # --  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
+  def test_initialize
+    method_info = RubyProf::MethodInfo.new(Array, :size)
+    call_tree = RubyProf::CallTree.new(method_info)
+    thread = RubyProf::Thread.new(call_tree, Thread.current, Fiber.current)
+
+    assert_equal(call_tree, thread.call_tree)
+    assert(thread)
+    assert(thread.id)
+    assert(thread.fiber_id)
+
+    assert_equal(1, thread.methods.size)
+    assert_same(method_info, thread.methods[0])
+  end
+
+  def test_merge
+    call_tree_1 = create_call_tree_1
+    thread_1 = RubyProf::Thread.new(call_tree_1, Thread.current, Fiber.current)
+    assert_equal(6, thread_1.methods.size)
+
+    call_tree_2 = create_call_tree_2
+    thread_2 = RubyProf::Thread.new(call_tree_2, Thread.current, Fiber.current)
+    assert_equal(6, thread_2.methods.size)
+
+    thread_1.merge!(thread_2)
+    assert_equal(7, thread_1.methods.size)
+
+    # Method times
+    assert_in_delta(11.6, thread_1.methods[0].total_time, 0.00001) # root
+    assert_in_delta(4.1, thread_1.methods[1].total_time, 0.00001)  # a
+    assert_in_delta(1.5, thread_1.methods[2].total_time, 0.00001)  # aa
+    assert_in_delta(2.6, thread_1.methods[3].total_time, 0.00001)  # ab
+    assert_in_delta(7.5, thread_1.methods[4].total_time, 0.00001)  # b
+    assert_in_delta(6.6, thread_1.methods[5].total_time, 0.00001)  # bb
+    assert_in_delta(0.9, thread_1.methods[6].total_time, 0.00001)  # ba
+
+    # Root
+    call_tree = call_tree_1
+    assert_equal(:root, call_tree.target.method_name)
+    assert_in_delta(11.6, call_tree.total_time, 0.00001)
+    assert_in_delta(0, call_tree.self_time, 0.00001)
+    assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    assert_in_delta(11.6, call_tree.children_time, 0.00001)
+
+    # a
+    call_tree = call_tree_1.children[0]
+    assert_equal(:a, call_tree.target.method_name)
+    assert_in_delta(4.1, call_tree.total_time, 0.00001)
+    assert_in_delta(0, call_tree.self_time, 0.00001)
+    assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    assert_in_delta(4.1, call_tree.children_time, 0.00001)
+
+    # aa
+    call_tree = call_tree_1.children[0].children[0]
+    assert_equal(:aa, call_tree.target.method_name)
+    assert_in_delta(1.5, call_tree.total_time, 0.00001)
+    assert_in_delta(1.5, call_tree.self_time, 0.00001)
+    assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    assert_in_delta(0.0, call_tree.children_time, 0.00001)
+
+    # ab
+    call_tree = call_tree_1.children[0].children[1]
+    assert_equal(:ab, call_tree.target.method_name)
+    assert_in_delta(2.6, call_tree.total_time, 0.00001)
+    assert_in_delta(2.6, call_tree.self_time, 0.00001)
+    assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    assert_in_delta(0.0, call_tree.children_time, 0.00001)
+
+    # # b
+    # call_tree = call_tree_1.children[1]
+    # assert_equal(:b, call_tree.target.method_name)
+    # assert_in_delta(7.5, call_tree.total_time, 0.00001)
+    # assert_in_delta(0, call_tree.self_time, 0.00001)
+    # assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    # assert_in_delta(7.5, call_tree.children_time, 0.00001)
+
+    # bb
+    # call_tree = call_tree_1.children[1].children[0]
+    # assert_equal(:bb, call_tree.target.method_name)
+    # assert_in_delta(6.6, call_tree.total_time, 0.00001)
+    # assert_in_delta(6.6, call_tree.self_time, 0.00001)
+    # assert_in_delta(0.0, call_tree.wait_time, 0.00001)
+    # assert_in_delta(0.0, call_tree.children_time, 0.00001)
+
+    # ba
+    call_tree = call_tree_1.children[1].children[1]
+    assert_equal(:ba, call_tree.target.method_name)
+    assert_in_delta(0.9, call_tree.total_time, 0.00001)
+    assert_in_delta(0.7, call_tree.self_time, 0.00001)
+    assert_in_delta(0.2, call_tree.wait_time, 0.00001)
+    assert_in_delta(0.0, call_tree.children_time, 0.00001)
   end
 
   def test_thread_count
-    RubyProf.start
+    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+      thread = Thread.new do
+        sleep(1)
+      end
 
-    thread = Thread.new do
-      sleep(1)
+      thread.join
     end
-
-    thread.join
-    result = RubyProf.stop
     assert_equal(2, result.threads.length)
   end
 
   def test_thread_identity
-    RubyProf.start
+    profile = RubyProf::Profile.new(measure_mode: RubyProf::WALL_TIME)
+    profile.start
+
     sleep_thread = Thread.new do
       sleep(1)
     end
     sleep_thread.join
-    result = RubyProf.stop
+    result = profile.stop
 
     thread_ids = result.threads.map {|thread| thread.id}.sort
     threads = [Thread.current, sleep_thread]
@@ -47,7 +136,9 @@ class ThreadTest < TestCase
   end
 
   def test_thread_timings
-    RubyProf.start
+    profile = RubyProf::Profile.new(measure_mode: RubyProf::WALL_TIME)
+    profile.start
+
     thread = Thread.new do
       sleep 0
       # force it to hit thread.join, below, first
@@ -57,7 +148,7 @@ class ThreadTest < TestCase
       sleep(1)
     end
     thread.join
-    result = RubyProf.stop
+    result = profile.stop
 
     # Check background thread
     assert_equal(2, result.threads.length)
@@ -71,10 +162,10 @@ class ThreadTest < TestCase
     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(1, method.total_time, 0.1)
     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_in_delta(1, method.children_time, 0.1)
     assert_equal(0, method.call_trees.callers.length)
 
     method = methods[1]