2 files changed, 376 insertions, 0 deletions
diff --git a/test/-ext-/debug/test_debug.rb b/test/-ext-/debug/test_debug.rb
new file mode 100644
index 0000000000..c9263d76fa
--- /dev/null
+++ b/test/-ext-/debug/test_debug.rb
@@ -0,0 +1,132 @@
+# frozen_string_literal: false
+require 'test/unit'
+require '-test-/debug'
+
+class TestDebug < Test::Unit::TestCase
+
+  def binds_check(binds, msg = nil)
+    count = Hash.new(0)
+    assert_instance_of(Array, binds, msg)
+    binds.each{|(_self, bind, klass, iseq, loc)|
+      if _self == self
+        count[:self] += 1
+      end
+
+      if bind
+        assert_instance_of(Binding, bind, msg)
+        count[:bind] += 1
+      end
+
+      if klass
+        assert(klass.instance_of?(Module) || klass.instance_of?(Class), msg)
+        count[:class] += 1
+      end
+
+      if iseq
+        count[:iseq] += 1
+        assert_instance_of(RubyVM::InstructionSequence, iseq, msg)
+
+        # Backtraces and source locations don't match for :c_trace methods
+        unless iseq.disasm.include?('C_TRACE')
+          # check same location
+          assert_equal(loc.path, iseq.path, msg)
+          assert_equal(loc.absolute_path, iseq.absolute_path, msg)
+          #assert_equal(loc.label, iseq.label, msg)
+          assert_operator(loc.lineno, :>=, iseq.first_lineno, msg)
+        end
+      end
+
+      assert_instance_of(Thread::Backtrace::Location, loc, msg)
+
+    }
+    assert_operator(0, :<, count[:self], msg)
+    assert_operator(0, :<, count[:bind], msg)
+    assert_operator(0, :<, count[:iseq], msg)
+    assert_operator(0, :<, count[:class], msg)
+  end
+
+  def test_inspector_open
+    binds = Bug::Debug.inspector
+    binds_check binds
+  end
+
+  def inspector_in_eval
+    eval("Bug::Debug.inspector")
+  end
+
+  def test_inspector_open_in_eval
+    bug7635 = '[ruby-core:51640]'
+    binds = inspector_in_eval
+    binds_check binds, bug7635
+  end
+
+  class MyRelation
+    include Enumerable
+
+    def each
+      yield :each_entry
+    end
+  end
+
+  def test_lazy_block
+    x = MyRelation.new.any? do
+      Bug::Debug.inspector
+      true
+    end
+    assert_equal true, x, '[Bug #15105]'
+  end
+end
+
+# This is a YJIT test, but we can't test this without a C extension that calls
+# rb_debug_inspector_open(), so we're testing it using "-test-/debug" here.
+class TestDebugWithYJIT < Test::Unit::TestCase
+  class LocalSetArray
+    def to_a
+      Bug::Debug.inspector.each do |_, binding,|
+        binding.local_variable_set(:local, :ok) if binding
+      end
+      [:ok]
+    end
+  end
+
+  class DebugArray
+    def to_a
+      Bug::Debug.inspector
+      [:ok]
+    end
+  end
+
+  def test_yjit_invalidates_getlocal_after_splatarray
+    val = getlocal_after_splatarray(LocalSetArray.new)
+    assert_equal [:ok, :ok], val
+  end
+
+  def test_yjit_invalidates_setlocal_after_splatarray
+    val = setlocal_after_splatarray(DebugArray.new)
+    assert_equal [:ok], val
+  end
+
+  def test_yjit_invalidates_setlocal_after_proc_call
+    val = setlocal_after_proc_call(proc { Bug::Debug.inspector; :ok })
+    assert_equal :ok, val
+  end
+
+  private
+
+  def getlocal_after_splatarray(array)
+    local = 1
+    [*array, local]
+  end
+
+  def setlocal_after_splatarray(array)
+    local = *array # setlocal followed by splatarray
+    itself # split a block using a C call
+    local # getlocal
+  end
+
+  def setlocal_after_proc_call(block)
+    local = block.call # setlocal followed by OPTIMIZED_METHOD_TYPE_CALL
+    itself # split a block using a C call
+    local # getlocal
+  end
+end if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
diff --git a/test/-ext-/debug/test_profile_frames.rb b/test/-ext-/debug/test_profile_frames.rb
new file mode 100644
index 0000000000..d79c94c468
--- /dev/null
+++ b/test/-ext-/debug/test_profile_frames.rb
@@ -0,0 +1,244 @@
+# frozen_string_literal: false
+require 'test/unit'
+require '-test-/debug'
+
+class SampleClassForTestProfileFrames
+  class << self
+    attr_accessor :sample4
+  end
+
+  self.sample4 = Module.new do
+    def self.corge(block)
+      Sample2.new.baz(block)
+    end
+  end
+
+  class Sample2
+    EVAL_LINE = __LINE__ + 3
+
+    def baz(block)
+      instance_eval "def zab(block) block.call end"
+      [self, zab(block)]
+    end
+  end
+
+  module Sample3
+    class << self
+      def qux(block)
+        SampleClassForTestProfileFrames.sample4.corge(block)
+      end
+    end
+  end
+
+  def self.bar(block)
+    Sample3.qux(block)
+  end
+
+  def foo(block)
+    self.class.bar(block)
+  end
+end
+
+class SampleClassForTestProfileThreadFrames
+  def initialize(mutex)
+    @mutex = mutex
+  end
+
+  def foo(block)
+    bar(block)
+  end
+
+  def bar(block)
+    block.call
+  end
+end
+
+class TestProfileFrames < Test::Unit::TestCase
+  def test_profile_frames
+    obj, frames = Fiber.new{
+      Fiber.yield SampleClassForTestProfileFrames.new.foo(lambda{ Bug::Debug.profile_frames(0, 10) })
+    }.resume
+
+    labels = [
+      nil,
+      "test_profile_frames",
+      "zab",
+      "baz",
+      "corge",
+      "qux",
+      "bar",
+      "foo",
+      "test_profile_frames",
+    ]
+    base_labels = [
+      nil,
+      "test_profile_frames",
+      "zab",
+      "baz",
+      "corge",
+      "qux",
+      "bar",
+      "foo",
+      "test_profile_frames",
+    ]
+    full_labels = [
+      "Bug::Debug.profile_frames",
+      "TestProfileFrames#test_profile_frames",
+      "#{obj.inspect}.zab",
+      "SampleClassForTestProfileFrames::Sample2#baz",
+      "#{SampleClassForTestProfileFrames.sample4.inspect}.corge",
+      "SampleClassForTestProfileFrames::Sample3.qux",
+      "SampleClassForTestProfileFrames.bar",
+      "SampleClassForTestProfileFrames#foo",
+      "TestProfileFrames#test_profile_frames",
+    ]
+    classes = [
+      Bug::Debug,
+      TestProfileFrames,
+      obj,
+      SampleClassForTestProfileFrames::Sample2,
+      SampleClassForTestProfileFrames.sample4,
+      SampleClassForTestProfileFrames::Sample3,
+      SampleClassForTestProfileFrames, # singleton method
+      SampleClassForTestProfileFrames,
+      TestProfileFrames,
+    ]
+    singleton_method_p = [
+      true, false, true, false, true, true, true, false, false, false,
+    ]
+    method_names = [
+      "profile_frames",
+      "test_profile_frames",
+      "zab",
+      "baz",
+      "corge",
+      "qux",
+      "bar",
+      "foo",
+      "test_profile_frames",
+    ]
+    qualified_method_names = [
+      "Bug::Debug.profile_frames",
+      "TestProfileFrames#test_profile_frames",
+      "#{obj.inspect}.zab",
+      "SampleClassForTestProfileFrames::Sample2#baz",
+      "#{SampleClassForTestProfileFrames.sample4.inspect}.corge",
+      "SampleClassForTestProfileFrames::Sample3.qux",
+      "SampleClassForTestProfileFrames.bar",
+      "SampleClassForTestProfileFrames#foo",
+      "TestProfileFrames#test_profile_frames",
+    ]
+    paths = [ nil, file=__FILE__, "(eval at #{__FILE__}:#{SampleClassForTestProfileFrames::Sample2::EVAL_LINE})", file, file, file, file, file, file, nil ]
+    absolute_paths = [ "<cfunc>", file, nil, file, file, file, file, file, file, nil ]
+
+    assert_equal(labels.size, frames.size)
+
+    frames.each.with_index{|(path, absolute_path, label, base_label, full_label, first_lineno,
+                            classpath, singleton_p, method_name, qualified_method_name), i|
+      err_msg = "#{i}th frame"
+      assert_equal(paths[i], path, err_msg)
+      assert_equal(absolute_paths[i], absolute_path, err_msg)
+      assert_equal(labels[i], label, err_msg)
+      assert_equal(base_labels[i], base_label, err_msg)
+      assert_equal(singleton_method_p[i], singleton_p, err_msg)
+      assert_equal(method_names[i], method_name, err_msg)
+      assert_equal(qualified_method_names[i], qualified_method_name, err_msg)
+      assert_equal(full_labels[i], full_label, err_msg)
+      assert_match(classes[i].inspect, classpath, err_msg)
+      if label == method_name
+        c = classes[i]
+        m = singleton_p ? c.method(method_name) : c.instance_method(method_name)
+        assert_equal(m.source_location[1], first_lineno, err_msg)
+      end
+    }
+  end
+
+  def test_profile_thread_frames
+    mutex = Mutex.new
+    th = Thread.new do
+      mutex.lock
+      Thread.stop
+      SampleClassForTestProfileThreadFrames.new(mutex).foo(lambda { mutex.unlock; loop { sleep(1) } } )
+    end
+
+    # ensure execution has reached SampleClassForTestProfileThreadFrames#bar before running profile_thread_frames
+    loop { break if th.status == "sleep"; sleep 0.1 }
+    th.run
+    mutex.lock # wait until SampleClassForTestProfileThreadFrames#bar has been called
+
+    frames = Bug::Debug.profile_thread_frames(th, 0, 10)
+
+    full_labels = [
+      "Kernel#sleep",
+      "TestProfileFrames#test_profile_thread_frames",
+      "Kernel#loop",
+      "TestProfileFrames#test_profile_thread_frames",
+      "SampleClassForTestProfileThreadFrames#bar",
+      "SampleClassForTestProfileThreadFrames#foo",
+      "TestProfileFrames#test_profile_thread_frames",
+    ]
+
+    frames.each.with_index do |frame, i|
+      assert_equal(full_labels[i], frame)
+    end
+
+  ensure
+    th.kill
+    th.join
+  end
+
+
+  def test_matches_backtrace_locations_main_thread
+    assert_equal(Thread.current, Thread.main)
+
+    # Keep these in the same line, so the backtraces match exactly
+    backtrace_locations, profile_frames = [Thread.current.backtrace_locations, Bug::Debug.profile_frames(0, 100)]
+
+    errmsg  = "backtrace_locations:\n  " + backtrace_locations.map.with_index{|loc, i| "#{i} #{loc}"}.join("\n  ")
+    errmsg += "\n\nprofile_frames:\n  "      + profile_frames.map.with_index{|(path, absolute_path, _, base_label, _, _, _, _, _, full_label, lineno), i|
+      if lineno
+        "#{i} #{absolute_path}:#{lineno} // #{full_label}"
+      else
+        "#{i} #{absolute_path} #{full_label}"
+      end
+    }.join("\n  ")
+    assert_equal(backtrace_locations.size, profile_frames.size, errmsg)
+
+    # The first entries are not going to match, since one is #backtrace_locations and the other #profile_frames
+    backtrace_locations.shift
+    profile_frames.shift
+
+    # The rest of the stack is expected to look the same...
+    backtrace_locations.zip(profile_frames).each.with_index do |(location, (path, absolute_path, _, base_label, label, _, _, _, _, _, lineno)), i|
+      next if absolute_path == "<cfunc>" # ...except for cfunc frames
+      next if label in "Array#each" | "Array#map" # ...except for :c_trace method frames
+
+      err_msg = "#{i}th frame"
+      assert_equal(location.absolute_path, absolute_path, err_msg)
+      assert_equal(location.base_label, base_label, err_msg)
+      assert_equal(location.lineno, lineno, err_msg)
+      assert_equal(location.path, path, err_msg)
+    end
+  end
+
+  def test_ifunc_frame
+    bug11851 = '[ruby-core:72409] [Bug #11851]'
+    assert_ruby_status([], <<~'end;', bug11851) # do
+      require '-test-/debug'
+      class A
+        include Bug::Debug
+        def x
+          profile_frames(0, 10)
+        end
+      end
+      def a
+        [A.new].each(&:x)
+      end
+      a
+    end;
+  end
+
+  def test_start
+    assert_equal Bug::Debug.profile_frames(0, 10).tap(&:shift), Bug::Debug.profile_frames(1, 9)
+  end
+end