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