xref: /llvm-project/lldb/test/API/python_api/process/read-mem-cstring/TestReadMemCString.py (revision 619e2e095fb1cd1e60b745cf1a10af9f67a4cd41) 
1"""Test reading c-strings from memory via SB API."""
2
3
4import os
5import lldb
6from lldbsuite.test.decorators import *
7from lldbsuite.test.lldbtest import *
8from lldbsuite.test import lldbutil
9
10
11class TestReadMemCString(TestBase):
12
13    mydir = TestBase.compute_mydir(__file__)
14    NO_DEBUG_INFO_TESTCASE = True
15
16    @skipIfReproducer # SBProcess::ReadCStringFromMemory is not instrumented.
17    def test_read_memory_c_string(self):
18        """Test corner case behavior of SBProcess::ReadCStringFromMemory"""
19        self.build()
20        self.dbg.SetAsync(False)
21
22        self.main_source = "main.c"
23        self.main_source_path = os.path.join(self.getSourceDir(),
24                                             self.main_source)
25        self.main_source_spec = lldb.SBFileSpec(self.main_source_path)
26        self.exe = self.getBuildArtifact("read-mem-cstring")
27
28        (target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
29            self, 'breakpoint here', self.main_source_spec, None, self.exe)
30
31        frame = thread.GetFrameAtIndex(0)
32
33        err = lldb.SBError()
34
35        empty_str_addr = frame.FindVariable("empty_string").GetValueAsUnsigned(err)
36        self.assertTrue(err.Success())
37        self.assertTrue(empty_str_addr != lldb.LLDB_INVALID_ADDRESS)
38
39        one_letter_str_addr = frame.FindVariable("one_letter_string").GetValueAsUnsigned(err)
40        self.assertTrue(err.Success())
41        self.assertTrue(one_letter_str_addr != lldb.LLDB_INVALID_ADDRESS)
42
43        invalid_memory_str_addr = frame.FindVariable("invalid_memory_string").GetValueAsUnsigned(err)
44        self.assertTrue(err.Success())
45        self.assertTrue(invalid_memory_str_addr != lldb.LLDB_INVALID_ADDRESS)
46
47        # Important:  An empty (0-length) c-string must come back as a Python string, not a
48        # None object.
49        empty_str = process.ReadCStringFromMemory(empty_str_addr, 2048, err)
50        self.assertTrue(err.Success())
51        self.assertEqual(empty_str, "")
52
53        one_letter_string = process.ReadCStringFromMemory(one_letter_str_addr, 2048, err)
54        self.assertTrue(err.Success())
55        self.assertEqual(one_letter_string, "1")
56
57        invalid_memory_string = process.ReadCStringFromMemory(invalid_memory_str_addr, 2048, err)
58        self.assertTrue(err.Fail())
59        self.assertTrue(invalid_memory_string == "" or invalid_memory_string == None)
60