4fdb8cb42f
stop-hooks are supposed to trigger every time the process stops, but as initially implemented they would only fire when control was returned to the user. So for instance when a process was launched the stop hook would only trigger when the process hit a breakpoint or crashed. However, it would be really useful to be able to trigger a stop hook when lldb first gains control over the process. One way to do that would be to implement general "target lifecycle events" and then send process created events that users could bind actions to. OTOH, extending the stop hooks to fire when lldb first gains control over the process is a pretty natural extension to the notion of a stop hook. So this patch takes the shorter route to that ability by making stop-hooks fire when lldb first gains control over the process. I also added the ability to specify whether to trigger the stop hook "on gaining control". I'm on the fence about whether to set the default to be "trigger on gaining control" or "don't trigger on gaining control". Since I think it's a generally useful feature, I've set the default to "trigger on gaining control".
112 lines
4.4 KiB
Python
112 lines
4.4 KiB
Python
"""
|
|
Test stop hook functionality
|
|
"""
|
|
|
|
|
|
import lldb
|
|
import lldbsuite.test.lldbutil as lldbutil
|
|
from lldbsuite.test.lldbtest import *
|
|
|
|
|
|
class TestStopHooks(TestBase):
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
def setUp(self):
|
|
TestBase.setUp(self)
|
|
self.build()
|
|
self.main_source_file = lldb.SBFileSpec("main.c")
|
|
full_path = os.path.join(self.getSourceDir(), "main.c")
|
|
self.main_start_line = line_number(full_path, "main()")
|
|
|
|
def test_stop_hooks_step_out(self):
|
|
"""Test that stop hooks fire on step-out."""
|
|
self.step_out_test()
|
|
|
|
def test_stop_hooks_after_expr(self):
|
|
"""Test that a stop hook fires when hitting a breakpoint that
|
|
runs an expression"""
|
|
self.after_expr_test()
|
|
|
|
def test_stop_hooks_before_and_after_creation(self):
|
|
"""Test that if we add stop hooks in the dummy target,
|
|
they aren't overridden by the ones set directly in the target."""
|
|
self.before_and_after_target()
|
|
|
|
def step_out_test(self):
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, "Set a breakpoint here", self.main_source_file
|
|
)
|
|
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
result = lldb.SBCommandReturnObject()
|
|
# Add two stop hooks here, one to auto-continue and one not. Make sure
|
|
# that we still stop in that case.
|
|
interp.HandleCommand("target stop-hook add -G false -o 'expr g_var++'", result)
|
|
self.assertTrue(result.Succeeded(), "Set the target stop hook")
|
|
|
|
interp.HandleCommand("target stop-hook add -G true -o 'expr g_var++'", result)
|
|
self.assertTrue(result.Succeeded(), "Set the second target stop hook")
|
|
|
|
thread.StepOut()
|
|
var = target.FindFirstGlobalVariable("g_var")
|
|
self.assertTrue(var.IsValid())
|
|
self.assertEqual(var.GetValueAsUnsigned(), 2, "Updated g_var")
|
|
|
|
def after_expr_test(self):
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
result = lldb.SBCommandReturnObject()
|
|
interp.HandleCommand("target stop-hook add -o 'expr g_var++' -I false", result)
|
|
self.assertTrue(result.Succeeded(), "Set the target stop hook")
|
|
|
|
(target, process, thread, first_bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, "Set a breakpoint here", self.main_source_file
|
|
)
|
|
|
|
var = target.FindFirstGlobalVariable("g_var")
|
|
self.assertTrue(var.IsValid())
|
|
self.assertEqual(var.GetValueAsUnsigned(), 1, "Updated g_var")
|
|
|
|
bkpt = target.BreakpointCreateBySourceRegex(
|
|
"Continue to here", self.main_source_file
|
|
)
|
|
self.assertNotEqual(bkpt.GetNumLocations(), 0, "Set the second breakpoint")
|
|
commands = lldb.SBStringList()
|
|
commands.AppendString("expr increment_gvar()")
|
|
bkpt.SetCommandLineCommands(commands)
|
|
|
|
threads = lldbutil.continue_to_breakpoint(process, bkpt)
|
|
self.assertEqual(len(threads), 1, "Hit my breakpoint")
|
|
|
|
self.assertTrue(var.IsValid())
|
|
self.assertEqual(var.GetValueAsUnsigned(), 3, "Updated g_var")
|
|
|
|
# Make sure running an expression does NOT run the stop hook.
|
|
# Our expression will increment it by one, but the stop shouldn't
|
|
# have gotten it to 5.
|
|
threads[0].frames[0].EvaluateExpression("increment_gvar()")
|
|
self.assertTrue(var.IsValid())
|
|
self.assertEqual(var.GetValueAsUnsigned(), 4, "Updated g_var")
|
|
|
|
# Make sure a rerun doesn't upset the state we've set up:
|
|
process.Kill()
|
|
lldbutil.run_to_breakpoint_do_run(self, target, first_bkpt)
|
|
var = target.FindFirstGlobalVariable("g_var")
|
|
self.assertTrue(var.IsValid())
|
|
self.assertEqual(var.GetValueAsUnsigned(), 1, "Updated g_var")
|
|
|
|
def before_and_after_target(self):
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
result = lldb.SBCommandReturnObject()
|
|
interp.HandleCommand("target stop-hook add -o 'expr g_var++'", result)
|
|
self.assertTrue(result.Succeeded(), "Set the target stop hook")
|
|
|
|
(target, process, thread, first_bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, "Set a breakpoint here", self.main_source_file
|
|
)
|
|
|
|
interp.HandleCommand("target stop-hook add -o 'thread backtrace'", result)
|
|
self.assertTrue(result.Succeeded(), "Set the target stop hook")
|
|
self.expect(
|
|
"target stop-hook list", substrs=["expr g_var++", "thread backtrace"]
|
|
)
|