7e16571eb0
This commit changes the libc++ frame recognizer to hide implementation details of libc++ more aggressively. The applied heuristic is rather straightforward: We consider every function name starting with `__` as an implementation detail. This works pretty neatly for `std::invoke`, `std::function`, `std::sort`, `std::map::emplace` and many others. Also, this should align quite nicely with libc++'s general coding convention of using the `__` for their implementation details, thereby keeping the future maintenance effort low. However, this heuristic by itself does not work in 100% of the cases: E.g., `std::ranges::sort` is not a function, but an object with an overloaded `operator()`, which means that there is no actual call `std::ranges::sort` in the call stack. Instead, there is a `std::ranges::__sort::operator()` call. To make sure that we don't hide this stack frame, we never hide the frame which represents the entry point from user code into libc++ code
68 lines
2.7 KiB
Python
68 lines
2.7 KiB
Python
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
|
|
|
|
class LibCxxInternalsRecognizerTestCase(TestBase):
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
@add_test_categories(["libc++"])
|
|
def test_frame_recognizer(self):
|
|
"""Test that implementation details of libc++ are hidden"""
|
|
self.build()
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, "break here", lldb.SBFileSpec("main.cpp")
|
|
)
|
|
|
|
expected_parents = {
|
|
"sort_less(int, int)": ["::sort", "test_algorithms"],
|
|
# `std::ranges::sort` is implemented as an object of types `__sort`.
|
|
# We never hide the frame of the entry-point into the standard library, even
|
|
# if the name starts with `__` which usually indicates an internal function.
|
|
"ranges_sort_less(int, int)": [
|
|
"ranges::__sort::operator()",
|
|
"test_algorithms",
|
|
],
|
|
# `ranges::views::transform` internally uses `std::invoke`, and that
|
|
# call also shows up in the stack trace
|
|
"view_transform(int)": [
|
|
"::invoke",
|
|
"ranges::transform_view",
|
|
"test_algorithms",
|
|
],
|
|
# Various types of `invoke` calls
|
|
"consume_number(int)": ["::invoke", "test_invoke"],
|
|
"invoke_add(int, int)": ["::invoke", "test_invoke"],
|
|
"Callable::member_function(int) const": ["::invoke", "test_invoke"],
|
|
"Callable::operator()(int) const": ["::invoke", "test_invoke"],
|
|
# Containers
|
|
"MyKey::operator<(MyKey const&) const": [
|
|
"less",
|
|
"::emplace",
|
|
"test_containers",
|
|
],
|
|
}
|
|
stop_set = set()
|
|
while process.GetState() != lldb.eStateExited:
|
|
fn = thread.GetFrameAtIndex(0).GetFunctionName()
|
|
stop_set.add(fn)
|
|
self.assertIn(fn, expected_parents.keys())
|
|
frame_id = 1
|
|
for expected_parent in expected_parents[fn]:
|
|
# Skip all hidden frames
|
|
while (
|
|
frame_id < thread.GetNumFrames()
|
|
and thread.GetFrameAtIndex(frame_id).IsHidden()
|
|
):
|
|
frame_id = frame_id + 1
|
|
# Expect the correct parent frame
|
|
self.assertIn(
|
|
expected_parent, thread.GetFrameAtIndex(frame_id).GetFunctionName()
|
|
)
|
|
frame_id = frame_id + 1
|
|
process.Continue()
|
|
|
|
# Make sure that we actually verified all intended scenarios
|
|
self.assertEqual(len(stop_set), len(expected_parents))
|