xref: /llvm-project/lldb/test/API/functionalities/scripted_process/TestStackCoreScriptedProcess.py (revision d10a61c8d2666a00ad483c71e72b49412a57c2bd) 
1"""
2Test python scripted process in lldb
3"""
4
5import os, json, tempfile
6
7import lldb
8from lldbsuite.test.decorators import *
9from lldbsuite.test.lldbtest import *
10from lldbsuite.test import lldbutil
11from lldbsuite.test import lldbtest
12
13
14class StackCoreScriptedProcesTestCase(TestBase):
15    NO_DEBUG_INFO_TESTCASE = True
16
17    def create_stack_skinny_corefile(self, file):
18        self.build()
19        target, process, thread, _ = lldbutil.run_to_source_breakpoint(
20            self, "// break here", lldb.SBFileSpec("baz.cpp")
21        )
22        self.assertTrue(process.IsValid(), "Process is invalid.")
23        # FIXME: Use SBAPI to save the process corefile.
24        self.runCmd("process save-core -s stack  " + file)
25        self.assertTrue(os.path.exists(file), "No stack-only corefile found.")
26        self.assertTrue(self.dbg.DeleteTarget(target), "Couldn't delete target")
27
28    def get_module_with_name(self, target, name):
29        for module in target.modules:
30            if name in module.GetFileSpec().GetFilename():
31                return module
32        return None
33
34    @skipUnlessDarwin
35    @skipIfOutOfTreeDebugserver
36    @skipIfRemote
37    @skipIfAsan  # On ASAN builds, this test times-out (rdar://98678134)
38    @skipIfDarwin
39    def test_launch_scripted_process_stack_frames(self):
40        """Test that we can launch an lldb scripted process from the command
41        line, check its process ID and read string from memory."""
42        self.build()
43        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
44        self.assertTrue(target, VALID_TARGET)
45
46        main_module = self.get_module_with_name(target, "a.out")
47        self.assertTrue(main_module, "Invalid main module.")
48        error = target.SetModuleLoadAddress(main_module, 0)
49        self.assertSuccess(error, "Reloading main module at offset 0 failed.")
50
51        scripted_dylib = self.get_module_with_name(target, "libbaz.dylib")
52        self.assertTrue(scripted_dylib, "Dynamic library libbaz.dylib not found.")
53        self.assertEqual(
54            scripted_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target),
55            0xFFFFFFFFFFFFFFFF,
56        )
57
58        os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"] = "1"
59
60        def cleanup():
61            del os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"]
62
63        self.addTearDownHook(cleanup)
64
65        scripted_process_example_relpath = "stack_core_scripted_process.py"
66        self.runCmd(
67            "command script import "
68            + os.path.join(self.getSourceDir(), scripted_process_example_relpath)
69        )
70
71        corefile_process = None
72        with tempfile.NamedTemporaryFile() as file:
73            self.create_stack_skinny_corefile(file.name)
74            corefile_target = self.dbg.CreateTarget(None)
75            corefile_process = corefile_target.LoadCore(
76                self.getBuildArtifact(file.name)
77            )
78        self.assertTrue(corefile_process, PROCESS_IS_VALID)
79
80        structured_data = lldb.SBStructuredData()
81        structured_data.SetFromJSON(
82            json.dumps(
83                {
84                    "backing_target_idx": self.dbg.GetIndexOfTarget(
85                        corefile_process.GetTarget()
86                    ),
87                    "libbaz_path": self.getBuildArtifact("libbaz.dylib"),
88                }
89            )
90        )
91        launch_info = lldb.SBLaunchInfo(None)
92        launch_info.SetProcessPluginName("ScriptedProcess")
93        launch_info.SetScriptedProcessClassName(
94            "stack_core_scripted_process.StackCoreScriptedProcess"
95        )
96        launch_info.SetScriptedProcessDictionary(structured_data)
97
98        error = lldb.SBError()
99        process = target.Launch(launch_info, error)
100        self.assertSuccess(error)
101        self.assertTrue(process, PROCESS_IS_VALID)
102        self.assertEqual(process.GetProcessID(), 42)
103
104        self.assertEqual(process.GetNumThreads(), 2)
105        thread = process.GetSelectedThread()
106        self.assertTrue(thread, "Invalid thread.")
107        self.assertEqual(thread.GetName(), "StackCoreScriptedThread.thread-1")
108
109        self.assertTrue(target.triple, "Invalid target triple")
110        arch = target.triple.split("-")[0]
111        supported_arch = ["x86_64", "arm64", "arm64e"]
112        self.assertIn(arch, supported_arch)
113        # When creating a corefile of a arm process, lldb saves the exception
114        # that triggers the breakpoint in the LC_NOTES of the corefile, so they
115        # can be reloaded with the corefile on the next debug session.
116        if arch in "arm64e":
117            self.assertTrue(thread.GetStopReason(), lldb.eStopReasonException)
118        # However, it's architecture specific, and corefiles made from intel
119        # process don't save any metadata to retrieve to stop reason.
120        # To mitigate this, the StackCoreScriptedProcess will report a
121        # eStopReasonSignal with a SIGTRAP, mimicking what debugserver does.
122        else:
123            self.assertTrue(thread.GetStopReason(), lldb.eStopReasonSignal)
124
125        self.assertEqual(thread.GetNumFrames(), 5)
126        frame = thread.GetSelectedFrame()
127        self.assertTrue(frame, "Invalid frame.")
128        func = frame.GetFunction()
129        self.assertTrue(func, "Invalid function.")
130
131        self.assertIn("baz", frame.GetFunctionName())
132        self.assertGreater(frame.vars.GetSize(), 0)
133        self.assertEqual(int(frame.vars.GetFirstValueByName("k").GetValue()), 42)
134        self.assertEqual(
135            int(frame.vars.GetFirstValueByName("j").Dereference().GetValue()), 42 * 42
136        )
137
138        corefile_dylib = self.get_module_with_name(corefile_target, "libbaz.dylib")
139        self.assertTrue(corefile_dylib, "Dynamic library libbaz.dylib not found.")
140        scripted_dylib = self.get_module_with_name(target, "libbaz.dylib")
141        self.assertTrue(scripted_dylib, "Dynamic library libbaz.dylib not found.")
142        self.assertEqual(
143            scripted_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target),
144            corefile_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target),
145        )
146