Fix rb_profile_frames output includes dummy main thread frame

The `rb_profile_frames` API did not skip the two dummy frames that
each thread has at its beginning. This was unlike `backtrace_each` and
`rb_ec_parcial_backtrace_object`, which do skip them.

This does not seem to be a problem for non-main thread frames,
because both `VM_FRAME_RUBYFRAME_P(cfp)` and
`rb_vm_frame_method_entry(cfp)` are NULL for them.

BUT, on the main thread `VM_FRAME_RUBYFRAME_P(cfp)` was true
and thus the dummy thread was still included in the output of
`rb_profile_frames`.

I've now made `rb_profile_frames` skip this extra frame (like
`backtrace_each` and friends), as well as add a test that asserts
the size and contents of `rb_profile_frames`.

Fixes [Bug #18907] (<https://bugs.ruby-lang.org/issues/18907>)
This commit is contained in:
Ivo Anjo 2022-07-11 14:51:44 +01:00 committed by Yusuke Endoh
parent cc29b43c7a
commit 649bfbe00d
Notes: git 2022-07-26 10:44:04 +09:00
3 changed files with 28 additions and 0 deletions

View file

@ -137,6 +137,30 @@ class TestProfileFrames < Test::Unit::TestCase
}
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)]
assert_equal(backtrace_locations.size, profile_frames.size)
# 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, _, _, _, _, _, _, lineno)), i|
next if absolute_path == "<cfunc>" # ...except for cfunc 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