[lldb] Fix SBThread::StepOverUntil for discontinuous functions #123046
+154
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I think the only issue here was that we would erroneously consider functions which are "in the middle" of the function were stepping to as a part of the function, and would try to step into them (likely stepping out of the function instead) instead of giving up early.
|
@llvm/pr-subscribers-lldb Author: Pavel Labath (labath) ChangesI think the only issue here was that we would erroneously consider functions which are "in the middle" of the function were stepping to as a part of the function, and would try to step into them (likely stepping out of the function instead) instead of giving up early. Full diff: https://github.com/llvm/llvm-project/pull/123046.diff 5 Files Affected:
diff --git a/lldb/source/API/SBThread.cpp b/lldb/source/API/SBThread.cpp
index 4e61c83889b0b0..4481d1113d89e2 100644
--- a/lldb/source/API/SBThread.cpp
+++ b/lldb/source/API/SBThread.cpp
@@ -842,7 +842,7 @@ SBError SBThread::StepOverUntil(lldb::SBFrame &sb_frame,
// appropriate error message.
bool all_in_function = true;
- AddressRange fun_range = frame_sc.function->GetAddressRange();
+ AddressRanges fun_ranges = frame_sc.function->GetAddressRanges();
std::vector<addr_t> step_over_until_addrs;
const bool abort_other_plans = false;
@@ -859,7 +859,9 @@ SBError SBThread::StepOverUntil(lldb::SBFrame &sb_frame,
addr_t step_addr =
sc.line_entry.range.GetBaseAddress().GetLoadAddress(target);
if (step_addr != LLDB_INVALID_ADDRESS) {
- if (fun_range.ContainsLoadAddress(step_addr, target))
+ if (llvm::any_of(fun_ranges, [&](const AddressRange &r) {
+ return r.ContainsLoadAddress(step_addr, target);
+ }))
step_over_until_addrs.push_back(step_addr);
else
all_in_function = false;
diff --git a/lldb/test/API/functionalities/thread/step_until/TestStepUntilAPI.py b/lldb/test/API/functionalities/thread/step_until/TestStepUntilAPI.py
new file mode 100644
index 00000000000000..95f3552d8968b7
--- /dev/null
+++ b/lldb/test/API/functionalities/thread/step_until/TestStepUntilAPI.py
@@ -0,0 +1,135 @@
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class StepUntilTestCase(TestBase):
+
+ NO_DEBUG_INFO_TESTCASE = True
+
+ def setUp(self):
+ super().setUp()
+
+ self.main_source = "main.c"
+ self.main_spec = lldb.SBFileSpec(self.main_source)
+ self.less_than_two = line_number("main.c", "Less than 2")
+ self.greater_than_two = line_number("main.c", "Greater than or equal to 2.")
+ self.back_out_in_main = line_number("main.c", "Back out in main")
+ self.in_foo = line_number("main.c", "In foo")
+
+ def _build_dict_for_discontinuity(self):
+ return dict(
+ CFLAGS_EXTRAS="-funique-basic-block-section-names "
+ + "-ffunction-sections -fbasic-block-sections=list="
+ + self.getSourcePath("function.list"),
+ LD_EXTRAS="-Wl,--section-ordering-file="
+ + self.getSourcePath("symbol.order"),
+ )
+
+ def _do_until(self, build_dict, args, until_line, expected_line):
+ self.build(dictionary=build_dict)
+ launch_info = lldb.SBLaunchInfo(args)
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "At the start", self.main_spec, launch_info
+ )
+
+ self.assertSuccess(
+ thread.StepOverUntil(self.frame(), self.main_spec, until_line)
+ )
+
+ self.runCmd("process status")
+
+ line = self.frame().GetLineEntry().GetLine()
+ self.assertEqual(
+ line, expected_line, "Did not get the expected stop line number"
+ )
+
+ def _assertDiscontinuity(self):
+ target = self.target()
+ foo = target.FindFunctions("foo")
+ self.assertEqual(len(foo), 1)
+ foo = foo[0]
+
+ call_me = self.target().FindFunctions("call_me")
+ self.assertEqual(len(call_me), 1)
+ call_me = call_me[0]
+
+ foo_addr = foo.function.GetStartAddress().GetLoadAddress(target)
+ found_before = False
+ found_after = False
+ for range in call_me.function.GetRanges():
+ addr = range.GetBaseAddress().GetLoadAddress(target)
+ if addr < foo_addr:
+ found_before = True
+ if addr > foo_addr:
+ found_after = True
+
+ self.assertTrue(
+ found_before and found_after,
+ "'foo' is not between 'call_me'" + str(foo) + str(call_me),
+ )
+
+ def test_hitting(self):
+ """Test SBThread.StepOverUntil - targeting a line and hitting it."""
+ self._do_until(None, None, self.less_than_two, self.less_than_two)
+
+ @skipIf(oslist=lldbplatformutil.getDarwinOSTriples() + ["windows"])
+ def test_hitting_discontinuous(self):
+ """Test SBThread.StepOverUntil - targeting a line and hitting it -- with
+ discontinuous functions"""
+ self._do_until(
+ self._build_dict_for_discontinuity(),
+ None,
+ self.less_than_two,
+ self.less_than_two,
+ )
+ self._assertDiscontinuity()
+
+ def test_missing(self):
+ """Test SBThread.StepOverUntil - targeting a line and missing it by stepping out to call site"""
+ self._do_until(
+ None, ["foo", "bar", "baz"], self.less_than_two, self.back_out_in_main
+ )
+
+ @skipIf(oslist=lldbplatformutil.getDarwinOSTriples() + ["windows"])
+ def test_missing_discontinuous(self):
+ """Test SBThread.StepOverUntil - targeting a line and missing it by
+ stepping out to call site -- with discontinuous functions"""
+ self._do_until(
+ self._build_dict_for_discontinuity(),
+ ["foo", "bar", "baz"],
+ self.less_than_two,
+ self.back_out_in_main,
+ )
+ self._assertDiscontinuity()
+
+ def test_bad_line(self):
+ """Test that we get an error if attempting to step outside the current
+ function"""
+ self.build()
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "At the start", self.main_spec
+ )
+ self.assertIn(
+ "step until target not in current function",
+ thread.StepOverUntil(
+ self.frame(), self.main_spec, self.in_foo
+ ).GetCString(),
+ )
+
+ @skipIf(oslist=lldbplatformutil.getDarwinOSTriples() + ["windows"])
+ def test_bad_line_discontinuous(self):
+ """Test that we get an error if attempting to step outside the current
+ function -- and the function is discontinuous"""
+ self.build(dictionary=self._build_dict_for_discontinuity())
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "At the start", self.main_spec
+ )
+ self.assertIn(
+ "step until target not in current function",
+ thread.StepOverUntil(
+ self.frame(), self.main_spec, self.in_foo
+ ).GetCString(),
+ )
+ self._assertDiscontinuity()
diff --git a/lldb/test/API/functionalities/thread/step_until/function.list b/lldb/test/API/functionalities/thread/step_until/function.list
new file mode 100644
index 00000000000000..5900fe8c350695
--- /dev/null
+++ b/lldb/test/API/functionalities/thread/step_until/function.list
@@ -0,0 +1 @@
+!call_me
diff --git a/lldb/test/API/functionalities/thread/step_until/main.c b/lldb/test/API/functionalities/thread/step_until/main.c
index bb866079cf5f54..4c52308f030e98 100644
--- a/lldb/test/API/functionalities/thread/step_until/main.c
+++ b/lldb/test/API/functionalities/thread/step_until/main.c
@@ -4,6 +4,9 @@
* unrelated to the program, just to achieve consistent
* debug line tables, across platforms, that are not
* dependent on compiler optimzations. */
+
+int foo(int x) { return x; /* In foo */ }
+
int call_me(int argc) {
printf ("At the start, argc: %d.\n", argc);
diff --git a/lldb/test/API/functionalities/thread/step_until/symbol.order b/lldb/test/API/functionalities/thread/step_until/symbol.order
new file mode 100644
index 00000000000000..72519faefdc787
--- /dev/null
+++ b/lldb/test/API/functionalities/thread/step_until/symbol.order
@@ -0,0 +1,7 @@
+.text : {
+ *(.text.call_me)
+ *(.text.foo)
+ *(.text.call_me.call_me.__part.1)
+ *(.text.call_me.call_me.__part.2)
+ *(.text.call_me.call_me.__part.3)
+}
|
|
✅ With the latest revision this PR passed the Python code formatter. |
jimingham
reviewed
Jan 15, 2025
lldb/source/API/SBThread.cpp
Outdated
| @@ -859,7 +859,9 @@ SBError SBThread::StepOverUntil(lldb::SBFrame &sb_frame, | |||
| addr_t step_addr = | |||
| sc.line_entry.range.GetBaseAddress().GetLoadAddress(target); | |||
| if (step_addr != LLDB_INVALID_ADDRESS) { | |||
| if (fun_range.ContainsLoadAddress(step_addr, target)) | |||
| if (llvm::any_of(fun_ranges, [&](const AddressRange &r) { | |||
There was a problem hiding this comment.
Why isn't there an AddressRanges::ContainsLoadAddress? Seems silly to have to write this loop by hand.
There was a problem hiding this comment.
AddressRanges is a typedef for vector.
How about using Block::GetRangeContainingLoadAddress (Function::GetAddressRanges just returns the data from the function Block) for this instead (see new version of the patch)? Other possibilities might be:
- add Function::GetRangeContainingLoadAddress or Function::ContainsLoadAddress
- add a free function (
ContainsLoadAddress(ArrayRef<AddressRange>, addr_t, Target))
There was a problem hiding this comment.
It feels awkward to have to manually dial up the function block to see if an address exists in that function. I'd vote for Function::GetRangeContainingLoadAddress - that just seems like something a Function should be able to tell you.
jimingham
reviewed
Jan 15, 2025
lldb/test/API/functionalities/thread/step_until/TestStepUntilAPI.py
Outdated
Show resolved
Hide resolved
|
LGTM modulo the couple little niggles. Thanks for the extra testing! |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/18/builds/9983 Here is the relevant piece of the build log for the reference |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think the only issue here was that we would erroneously consider functions which are "in the middle" of the function were stepping to as a part of the function, and would try to step into them (likely stepping out of the function instead) instead of giving up early.