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