Files
llvm/lldb/test/API/functionalities/memory/holes/TestMemoryHoles.py
Pavel Labath cc5c526c80 [lldb] Fix and speedup the memory find command (#104193)
This patch fixes an issue where the `memory find` command would
effectively stop searching after encountering a memory read error (which
could happen due to unreadable memory), without giving any indication
that it has done so (it would just print it could not find the pattern).

To make matters worse, it would not terminate after encountering this
error, but rather proceed to slowly increment the address pointer, which
meant that searching a large region could take a very long time (and
give the appearance that lldb is actually searching for the thing).

The patch fixes this first problem by detecting read errors and
skipping over (using GetMemoryRegionInfo) the unreadable parts of memory
and resuming the search after them. It also reads the memory in bulk
(`max(sizeof(pattern))`), which speeds up the search significantly (up
to 6x for live processes, 18x for core files).
2024-09-04 11:30:58 +02:00

74 lines
2.6 KiB
Python

"""
Test the memory commands operating on memory regions with holes (inaccessible
pages)
"""
import lldb
from lldbsuite.test.lldbtest import *
import lldbsuite.test.lldbutil as lldbutil
from lldbsuite.test.decorators import *
class MemoryHolesTestCase(TestBase):
NO_DEBUG_INFO_TESTCASE = True
def setUp(self):
super().setUp()
# Find the line number to break inside main().
self.line = line_number("main.cpp", "// break here")
def _prepare_inferior(self):
self.build()
exe = self.getBuildArtifact("a.out")
self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
# Break in main() after the variables are assigned values.
lldbutil.run_break_set_by_file_and_line(
self, "main.cpp", self.line, num_expected_locations=1, loc_exact=True
)
self.runCmd("run", RUN_SUCCEEDED)
# The stop reason of the thread should be breakpoint.
self.expect(
"thread list",
STOPPED_DUE_TO_BREAKPOINT,
substrs=["stopped", "stop reason = breakpoint"],
)
# The breakpoint should have a hit count of 1.
lldbutil.check_breakpoint(self, bpno=1, expected_hit_count=1)
# Avoid the expression evaluator, as it can allocate allocate memory
# inside the holes we've deliberately left empty.
self.memory = self.frame().FindVariable("mem_with_holes").GetValueAsUnsigned()
self.pagesize = self.frame().FindVariable("pagesize").GetValueAsUnsigned()
self.num_pages = (
self.target().FindFirstGlobalVariable("num_pages").GetValueAsUnsigned()
)
positions = self.frame().FindVariable("positions")
self.positions = [
positions.GetChildAtIndex(i).GetValueAsUnsigned()
for i in range(positions.GetNumChildren())
]
self.assertEqual(len(self.positions), 5)
def test_memory_read(self):
self._prepare_inferior()
error = lldb.SBError()
content = self.process().ReadMemory(self.memory, 2 * self.pagesize, error)
self.assertEqual(len(content), self.pagesize)
self.assertEqual(content[0:7], b"needle\0")
self.assertTrue(error.Fail())
def test_memory_find(self):
self._prepare_inferior()
matches = [f"data found at location: {p:#x}" for p in self.positions]
self.expect(
f'memory find --count {len(self.positions)+1} --string "needle" '
f"{self.memory:#x} {self.memory+self.pagesize*self.num_pages:#x}",
substrs=matches + ["no more matches within the range"],
)