a3d4f739ee
This patch should address a bug when a user have multiple scripted processes in the same debugging session. In order for the scripted process plugin to be able to call into the scripted object instance methods to fetch the necessary data to reconstruct its state, the scripted process plugin calls into a scripted process interface, that has a reference to the created script object instance. However, prior to this patch, we only had a single instance of the scripted process interface, living the script interpreter. So every time a new scripted process plugin was created, it would overwrite the script object instance that was held by the single scripted process interface in the script interpreter. That would cause all the method calls made to the scripted process interface to be dispatched by the last instanciated script object instance, which is wrong. In order to prevent that, this patch moves the scripted process interface reference to be help by the scripted process plugin itself. rdar://104882562 Differential Revision: https://reviews.llvm.org/D143308 Signed-off-by: Med Ismail Bennani <medismail.bennani@gmail.com>
187 lines
7.4 KiB
Python
187 lines
7.4 KiB
Python
"""
|
|
Test python scripted process in lldb
|
|
"""
|
|
|
|
import os, shutil
|
|
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
from lldbsuite.test import lldbtest
|
|
|
|
import dummy_scripted_process
|
|
|
|
class ScriptedProcesTestCase(TestBase):
|
|
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
@skipUnlessDarwin
|
|
def test_python_plugin_package(self):
|
|
"""Test that the lldb python module has a `plugins.scripted_process`
|
|
package."""
|
|
self.expect('script import lldb.plugins',
|
|
substrs=["ModuleNotFoundError"], matching=False)
|
|
|
|
self.expect('script dir(lldb.plugins)',
|
|
substrs=["scripted_process"])
|
|
|
|
self.expect('script import lldb.plugins.scripted_process',
|
|
substrs=["ModuleNotFoundError"], matching=False)
|
|
|
|
self.expect('script dir(lldb.plugins.scripted_process)',
|
|
substrs=["ScriptedProcess"])
|
|
|
|
self.expect('script from lldb.plugins.scripted_process import ScriptedProcess',
|
|
substrs=["ImportError"], matching=False)
|
|
|
|
self.expect('script dir(ScriptedProcess)',
|
|
substrs=["launch"])
|
|
|
|
def move_blueprint_to_dsym(self, blueprint_name):
|
|
blueprint_origin_path = os.path.join(self.getSourceDir(), blueprint_name)
|
|
dsym_bundle = self.getBuildArtifact("a.out.dSYM")
|
|
blueprint_destination_path = os.path.join(dsym_bundle, "Contents",
|
|
"Resources", "Python")
|
|
if not os.path.exists(blueprint_destination_path):
|
|
os.mkdir(blueprint_destination_path)
|
|
|
|
blueprint_destination_path = os.path.join(blueprint_destination_path, "a_out.py")
|
|
shutil.copy(blueprint_origin_path, blueprint_destination_path)
|
|
|
|
@skipUnlessDarwin
|
|
def test_invalid_scripted_register_context(self):
|
|
"""Test that we can launch an lldb scripted process with an invalid
|
|
Scripted Thread, with invalid register context."""
|
|
self.build()
|
|
|
|
os.environ['SKIP_SCRIPTED_PROCESS_LAUNCH'] = '1'
|
|
def cleanup():
|
|
del os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"]
|
|
self.addTearDownHook(cleanup)
|
|
|
|
self.runCmd("settings set target.load-script-from-symbol-file true")
|
|
self.move_blueprint_to_dsym('invalid_scripted_process.py')
|
|
target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
|
|
self.assertTrue(target, VALID_TARGET)
|
|
log_file = self.getBuildArtifact('thread.log')
|
|
self.runCmd("log enable lldb thread -f " + log_file)
|
|
self.assertTrue(os.path.isfile(log_file))
|
|
|
|
launch_info = lldb.SBLaunchInfo(None)
|
|
launch_info.SetProcessPluginName("ScriptedProcess")
|
|
launch_info.SetScriptedProcessClassName("a_out.InvalidScriptedProcess")
|
|
error = lldb.SBError()
|
|
|
|
process = target.Launch(launch_info, error)
|
|
|
|
self.assertSuccess(error)
|
|
self.assertTrue(process, PROCESS_IS_VALID)
|
|
self.assertEqual(process.GetProcessID(), 666)
|
|
self.assertEqual(process.GetNumThreads(), 0)
|
|
|
|
addr = 0x500000000
|
|
buff = process.ReadMemory(addr, 4, error)
|
|
self.assertEqual(buff, None)
|
|
self.assertTrue(error.Fail())
|
|
self.assertEqual(error.GetCString(), "This is an invalid scripted process!")
|
|
|
|
with open(log_file, 'r') as f:
|
|
log = f.read()
|
|
|
|
self.assertIn("Failed to get scripted thread registers data.", log)
|
|
|
|
@skipUnlessDarwin
|
|
def test_scripted_process_and_scripted_thread(self):
|
|
"""Test that we can launch an lldb scripted process using the SBAPI,
|
|
check its process ID, read string from memory, check scripted thread
|
|
id, name stop reason and register context.
|
|
"""
|
|
self.build()
|
|
target_0 = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
|
|
self.assertTrue(target_0, VALID_TARGET)
|
|
|
|
os.environ['SKIP_SCRIPTED_PROCESS_LAUNCH'] = '1'
|
|
def cleanup():
|
|
del os.environ["SKIP_SCRIPTED_PROCESS_LAUNCH"]
|
|
self.addTearDownHook(cleanup)
|
|
|
|
scripted_process_example_relpath = 'dummy_scripted_process.py'
|
|
self.runCmd("command script import " + os.path.join(self.getSourceDir(),
|
|
scripted_process_example_relpath))
|
|
|
|
launch_info = lldb.SBLaunchInfo(None)
|
|
launch_info.SetProcessPluginName("ScriptedProcess")
|
|
launch_info.SetScriptedProcessClassName("dummy_scripted_process.DummyScriptedProcess")
|
|
|
|
error = lldb.SBError()
|
|
process_0 = target_0.Launch(launch_info, error)
|
|
self.assertTrue(process_0 and process_0.IsValid(), PROCESS_IS_VALID)
|
|
self.assertEqual(process_0.GetProcessID(), 42)
|
|
self.assertEqual(process_0.GetNumThreads(), 1)
|
|
|
|
py_impl = process_0.GetScriptedImplementation()
|
|
self.assertTrue(py_impl)
|
|
self.assertTrue(isinstance(py_impl, dummy_scripted_process.DummyScriptedProcess))
|
|
self.assertFalse(hasattr(py_impl, 'my_super_secret_member'))
|
|
py_impl.my_super_secret_member = 42
|
|
self.assertTrue(hasattr(py_impl, 'my_super_secret_member'))
|
|
self.assertEqual(py_impl.my_super_secret_method(), 42)
|
|
|
|
# Try reading from target #0 process ...
|
|
addr = 0x500000000
|
|
message = "Hello, target 0"
|
|
buff = process_0.ReadCStringFromMemory(addr, len(message) + 1, error)
|
|
self.assertSuccess(error)
|
|
self.assertEqual(buff, message)
|
|
|
|
target_1 = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
|
|
self.assertTrue(target_1, VALID_TARGET)
|
|
error = lldb.SBError()
|
|
process_1 = target_1.Launch(launch_info, error)
|
|
self.assertTrue(process_1 and process_1.IsValid(), PROCESS_IS_VALID)
|
|
self.assertEqual(process_1.GetProcessID(), 42)
|
|
self.assertEqual(process_1.GetNumThreads(), 1)
|
|
|
|
# ... then try reading from target #1 process ...
|
|
addr = 0x500000000
|
|
message = "Hello, target 1"
|
|
buff = process_1.ReadCStringFromMemory(addr, len(message) + 1, error)
|
|
self.assertSuccess(error)
|
|
self.assertEqual(buff, message)
|
|
|
|
# ... now, reading again from target #0 process to make sure the call
|
|
# gets dispatched to the right target.
|
|
addr = 0x500000000
|
|
message = "Hello, target 0"
|
|
buff = process_0.ReadCStringFromMemory(addr, len(message) + 1, error)
|
|
self.assertSuccess(error)
|
|
self.assertEqual(buff, message)
|
|
|
|
thread = process_0.GetSelectedThread()
|
|
self.assertTrue(thread, "Invalid thread.")
|
|
self.assertEqual(thread.GetThreadID(), 0x19)
|
|
self.assertEqual(thread.GetName(), "DummyScriptedThread.thread-1")
|
|
self.assertStopReason(thread.GetStopReason(), lldb.eStopReasonSignal)
|
|
|
|
self.assertGreater(thread.GetNumFrames(), 0)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
GPRs = None
|
|
register_set = frame.registers # Returns an SBValueList.
|
|
for regs in register_set:
|
|
if 'general purpose' in regs.name.lower():
|
|
GPRs = regs
|
|
break
|
|
|
|
self.assertTrue(GPRs, "Invalid General Purpose Registers Set")
|
|
self.assertGreater(GPRs.GetNumChildren(), 0)
|
|
for idx, reg in enumerate(GPRs, start=1):
|
|
if idx > 21:
|
|
break
|
|
self.assertEqual(idx, int(reg.value, 16))
|
|
|
|
self.assertTrue(frame.IsArtificial(), "Frame is not artificial")
|
|
pc = frame.GetPCAddress().GetLoadAddress(target_0)
|
|
self.assertEqual(pc, 0x0100001b00)
|