Skip to content

[lldb] Verify target stop-hooks support with scripted process #91107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,10 @@ def cleanup():
+ os.path.join(self.getSourceDir(), scripted_process_example_relpath)
)

self.runCmd(
"target stop-hook add -k first -v 1 -k second -v 2 -P dummy_scripted_process.DummyStopHook"
)

launch_info = lldb.SBLaunchInfo(None)
launch_info.SetProcessPluginName("ScriptedProcess")
launch_info.SetScriptedProcessClassName(
Expand All @@ -207,6 +211,9 @@ def cleanup():
self.assertTrue(hasattr(py_impl, "my_super_secret_member"))
self.assertEqual(py_impl.my_super_secret_method(), 42)

self.assertTrue(hasattr(py_impl, "handled_stop"))
self.assertTrue(py_impl.handled_stop)

# Try reading from target #0 process ...
addr = 0x500000000
message = "Hello, target 0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@
from lldb.plugins.scripted_process import ScriptedThread


class DummyStopHook:
def __init__(self, target, args, internal_dict):
self.target = target
self.args = args

def handle_stop(self, exe_ctx, stream):
print("My DummyStopHook triggered. Printing args: \n%s" % self.args)
sp = exe_ctx.process.GetScriptedImplementation()
sp.handled_stop = True

class DummyScriptedProcess(ScriptedProcess):
memory = None

Expand All @@ -18,6 +28,7 @@ def __init__(self, exe_ctx: lldb.SBExecutionContext, args: lldb.SBStructuredData
debugger = self.target.GetDebugger()
index = debugger.GetIndexOfTarget(self.target)
self.memory[addr] = "Hello, target " + str(index)
self.handled_stop = False

def read_memory_at_address(
self, addr: int, size: int, error: lldb.SBError
Expand Down Expand Up @@ -99,7 +110,13 @@ def get_register_context(self) -> str:


def __lldb_init_module(debugger, dict):
# This is used when loading the script in an interactive debug session to
# automatically, register the stop-hook and launch the scripted process.
if not "SKIP_SCRIPTED_PROCESS_LAUNCH" in os.environ:
debugger.HandleCommand(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you have to add the stop hook here when the module is initialized and also in the test case?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this for when loading the file it by hand when debugging, so I don't have to type the command every time I load it in an interactive debug session. As you can see it only takes this path when SKIP_SCRIPTED_PROCESS_LAUNCH is set, which is not the case in the test.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like it would be worth documenting in a comment?

"target stop-hook add -k first -v 1 -k second -v 2 -P %s.%s"
% (__name__, DummyStopHook.__name__)
)
debugger.HandleCommand(
"process launch -C %s.%s" % (__name__, DummyScriptedProcess.__name__)
)
Expand All @@ -108,3 +125,7 @@ def __lldb_init_module(debugger, dict):
"Name of the class that will manage the scripted process: '%s.%s'"
% (__name__, DummyScriptedProcess.__name__)
)
print(
"Name of the class that will manage the stop-hook: '%s.%s'"
% (__name__, DummyStopHook.__name__)
)