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 def test_launch_scripted_process_stack_frames(self): 39 """Test that we can launch an lldb scripted process from the command 40 line, check its process ID and read string from memory.""" 41 self.build() 42 target = self.dbg.CreateTarget(self.getBuildArtifact("a.out")) 43 self.assertTrue(target, VALID_TARGET) 44 45 main_module = self.get_module_with_name(target, "a.out") 46 self.assertTrue(main_module, "Invalid main module.") 47 error = target.SetModuleLoadAddress(main_module, 0) 48 self.assertSuccess(error, "Reloading main module at offset 0 failed.") 49 50 scripted_dylib = self.get_module_with_name(target, "libbaz.dylib") 51 self.assertTrue(scripted_dylib, "Dynamic library libbaz.dylib not found.") 52 self.assertEqual( 53 scripted_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target), 54 0xFFFFFFFFFFFFFFFF, 55 ) 56 57 os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"] = "1" 58 59 def cleanup(): 60 del os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"] 61 62 self.addTearDownHook(cleanup) 63 64 scripted_process_example_relpath = "stack_core_scripted_process.py" 65 self.runCmd( 66 "command script import " 67 + os.path.join(self.getSourceDir(), scripted_process_example_relpath) 68 ) 69 70 corefile_process = None 71 with tempfile.NamedTemporaryFile() as file: 72 self.create_stack_skinny_corefile(file.name) 73 corefile_target = self.dbg.CreateTarget(None) 74 corefile_process = corefile_target.LoadCore( 75 self.getBuildArtifact(file.name) 76 ) 77 self.assertTrue(corefile_process, PROCESS_IS_VALID) 78 79 structured_data = lldb.SBStructuredData() 80 structured_data.SetFromJSON( 81 json.dumps( 82 { 83 "backing_target_idx": self.dbg.GetIndexOfTarget( 84 corefile_process.GetTarget() 85 ), 86 "libbaz_path": self.getBuildArtifact("libbaz.dylib"), 87 } 88 ) 89 ) 90 launch_info = lldb.SBLaunchInfo(None) 91 launch_info.SetProcessPluginName("ScriptedProcess") 92 launch_info.SetScriptedProcessClassName( 93 "stack_core_scripted_process.StackCoreScriptedProcess" 94 ) 95 launch_info.SetScriptedProcessDictionary(structured_data) 96 97 error = lldb.SBError() 98 process = target.Launch(launch_info, error) 99 self.assertSuccess(error) 100 self.assertTrue(process, PROCESS_IS_VALID) 101 self.assertEqual(process.GetProcessID(), 42) 102 103 self.assertEqual(process.GetNumThreads(), 2) 104 thread = process.GetSelectedThread() 105 self.assertTrue(thread, "Invalid thread.") 106 self.assertEqual(thread.GetName(), "StackCoreScriptedThread.thread-1") 107 108 self.assertTrue(target.triple, "Invalid target triple") 109 arch = target.triple.split("-")[0] 110 supported_arch = ["x86_64", "arm64", "arm64e"] 111 self.assertIn(arch, supported_arch) 112 # When creating a corefile of a arm process, lldb saves the exception 113 # that triggers the breakpoint in the LC_NOTES of the corefile, so they 114 # can be reloaded with the corefile on the next debug session. 115 if arch in "arm64e": 116 self.assertTrue(thread.GetStopReason(), lldb.eStopReasonException) 117 # However, it's architecture specific, and corefiles made from intel 118 # process don't save any metadata to retrieve to stop reason. 119 # To mitigate this, the StackCoreScriptedProcess will report a 120 # eStopReasonSignal with a SIGTRAP, mimicking what debugserver does. 121 else: 122 self.assertTrue(thread.GetStopReason(), lldb.eStopReasonSignal) 123 124 self.assertEqual(thread.GetNumFrames(), 5) 125 frame = thread.GetSelectedFrame() 126 self.assertTrue(frame, "Invalid frame.") 127 func = frame.GetFunction() 128 self.assertTrue(func, "Invalid function.") 129 130 self.assertIn("baz", frame.GetFunctionName()) 131 self.assertGreater(frame.vars.GetSize(), 0) 132 self.assertEqual(int(frame.vars.GetFirstValueByName("k").GetValue()), 42) 133 self.assertEqual( 134 int(frame.vars.GetFirstValueByName("j").Dereference().GetValue()), 42 * 42 135 ) 136 137 corefile_dylib = self.get_module_with_name(corefile_target, "libbaz.dylib") 138 self.assertTrue(corefile_dylib, "Dynamic library libbaz.dylib not found.") 139 scripted_dylib = self.get_module_with_name(target, "libbaz.dylib") 140 self.assertTrue(scripted_dylib, "Dynamic library libbaz.dylib not found.") 141 self.assertEqual( 142 scripted_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target), 143 corefile_dylib.GetObjectFileHeaderAddress().GetLoadAddress(target), 144 ) 145