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