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