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