xref: /llvm-project/lldb/test/API/python_api/process/read-mem-cstring/TestReadMemCString.py (revision 1fb5c7a2f17f10e768160fe23d4a04537c7224c1) 
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    NO_DEBUG_INFO_TESTCASE = True
13
14    def test_read_memory_c_string(self):
15        """Test corner case behavior of SBProcess::ReadCStringFromMemory"""
16        self.build()
17        self.dbg.SetAsync(False)
18
19        self.main_source = "main.c"
20        self.main_source_path = os.path.join(self.getSourceDir(),
21                                             self.main_source)
22        self.main_source_spec = lldb.SBFileSpec(self.main_source_path)
23        self.exe = self.getBuildArtifact("read-mem-cstring")
24
25        (target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
26            self, 'breakpoint here', self.main_source_spec, None, self.exe)
27
28        frame = thread.GetFrameAtIndex(0)
29
30        err = lldb.SBError()
31
32        empty_str_addr = frame.FindVariable("empty_string").GetValueAsUnsigned(err)
33        self.assertSuccess(err)
34        self.assertNotEqual(empty_str_addr, lldb.LLDB_INVALID_ADDRESS)
35
36        one_letter_str_addr = frame.FindVariable("one_letter_string").GetValueAsUnsigned(err)
37        self.assertSuccess(err)
38        self.assertNotEqual(one_letter_str_addr, lldb.LLDB_INVALID_ADDRESS)
39
40        invalid_memory_str_addr = frame.FindVariable("invalid_memory_string").GetValueAsUnsigned(err)
41        self.assertSuccess(err)
42        self.assertNotEqual(invalid_memory_str_addr, lldb.LLDB_INVALID_ADDRESS)
43
44        # Important:  An empty (0-length) c-string must come back as a Python string, not a
45        # None object.
46        empty_str = process.ReadCStringFromMemory(empty_str_addr, 2048, err)
47        self.assertSuccess(err)
48        self.assertEqual(empty_str, "")
49
50        one_letter_string = process.ReadCStringFromMemory(one_letter_str_addr, 2048, err)
51        self.assertSuccess(err)
52        self.assertEqual(one_letter_string, "1")
53
54        invalid_memory_string = process.ReadCStringFromMemory(invalid_memory_str_addr, 2048, err)
55        self.assertTrue(err.Fail())
56        self.assertTrue(invalid_memory_string == "" or invalid_memory_string == None)
57