199451b44SJordan Rupprecht"""Test reading c-strings from memory via SB API."""
299451b44SJordan Rupprecht
399451b44SJordan Rupprecht
499451b44SJordan Rupprechtimport os
599451b44SJordan Rupprechtimport lldb
699451b44SJordan Rupprechtfrom lldbsuite.test.decorators import *
799451b44SJordan Rupprechtfrom lldbsuite.test.lldbtest import *
899451b44SJordan Rupprechtfrom lldbsuite.test import lldbutil
999451b44SJordan Rupprecht
1099451b44SJordan Rupprecht
1199451b44SJordan Rupprechtclass TestReadMemCString(TestBase):
1299451b44SJordan Rupprecht    NO_DEBUG_INFO_TESTCASE = True
1399451b44SJordan Rupprecht
1499451b44SJordan Rupprecht    def test_read_memory_c_string(self):
1599451b44SJordan Rupprecht        """Test corner case behavior of SBProcess::ReadCStringFromMemory"""
1699451b44SJordan Rupprecht        self.build()
1799451b44SJordan Rupprecht        self.dbg.SetAsync(False)
1899451b44SJordan Rupprecht
1999451b44SJordan Rupprecht        self.main_source = "main.c"
2099451b44SJordan Rupprecht        self.main_source_path = os.path.join(self.getSourceDir(),
2199451b44SJordan Rupprecht                                             self.main_source)
2299451b44SJordan Rupprecht        self.main_source_spec = lldb.SBFileSpec(self.main_source_path)
2399451b44SJordan Rupprecht        self.exe = self.getBuildArtifact("read-mem-cstring")
2499451b44SJordan Rupprecht
2599451b44SJordan Rupprecht        (target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
2699451b44SJordan Rupprecht            self, 'breakpoint here', self.main_source_spec, None, self.exe)
2799451b44SJordan Rupprecht
2899451b44SJordan Rupprecht        frame = thread.GetFrameAtIndex(0)
2999451b44SJordan Rupprecht
3099451b44SJordan Rupprecht        err = lldb.SBError()
3199451b44SJordan Rupprecht
3299451b44SJordan Rupprecht        empty_str_addr = frame.FindVariable("empty_string").GetValueAsUnsigned(err)
33*779bbbf2SDave Lee        self.assertSuccess(err)
3499451b44SJordan Rupprecht        self.assertTrue(empty_str_addr != lldb.LLDB_INVALID_ADDRESS)
3599451b44SJordan Rupprecht
3699451b44SJordan Rupprecht        one_letter_str_addr = frame.FindVariable("one_letter_string").GetValueAsUnsigned(err)
37*779bbbf2SDave Lee        self.assertSuccess(err)
3899451b44SJordan Rupprecht        self.assertTrue(one_letter_str_addr != lldb.LLDB_INVALID_ADDRESS)
3999451b44SJordan Rupprecht
4099451b44SJordan Rupprecht        invalid_memory_str_addr = frame.FindVariable("invalid_memory_string").GetValueAsUnsigned(err)
41*779bbbf2SDave Lee        self.assertSuccess(err)
4299451b44SJordan Rupprecht        self.assertTrue(invalid_memory_str_addr != lldb.LLDB_INVALID_ADDRESS)
4399451b44SJordan Rupprecht
4499451b44SJordan Rupprecht        # Important:  An empty (0-length) c-string must come back as a Python string, not a
4599451b44SJordan Rupprecht        # None object.
4699451b44SJordan Rupprecht        empty_str = process.ReadCStringFromMemory(empty_str_addr, 2048, err)
47*779bbbf2SDave Lee        self.assertSuccess(err)
48619e2e09SDave Lee        self.assertEqual(empty_str, "")
4999451b44SJordan Rupprecht
5099451b44SJordan Rupprecht        one_letter_string = process.ReadCStringFromMemory(one_letter_str_addr, 2048, err)
51*779bbbf2SDave Lee        self.assertSuccess(err)
52619e2e09SDave Lee        self.assertEqual(one_letter_string, "1")
5399451b44SJordan Rupprecht
5499451b44SJordan Rupprecht        invalid_memory_string = process.ReadCStringFromMemory(invalid_memory_str_addr, 2048, err)
5599451b44SJordan Rupprecht        self.assertTrue(err.Fail())
5699451b44SJordan Rupprecht        self.assertTrue(invalid_memory_string == "" or invalid_memory_string == None)
57