| """ |
| Test lldb breakpoint command add/list/delete. |
| """ |
| |
| from __future__ import print_function |
| |
| |
| import os |
| import time |
| import lldb |
| from lldbsuite.test.decorators import * |
| from lldbsuite.test.lldbtest import * |
| from lldbsuite.test import lldbutil |
| import side_effect |
| |
| |
| class BreakpointCommandTestCase(TestBase): |
| |
| NO_DEBUG_INFO_TESTCASE = True |
| mydir = TestBase.compute_mydir(__file__) |
| |
| @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24528") |
| def test_breakpoint_command_sequence(self): |
| """Test a sequence of breakpoint command add, list, and delete.""" |
| self.build() |
| self.breakpoint_command_sequence() |
| |
| @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24528") |
| def test_script_parameters(self): |
| """Test a sequence of breakpoint command add, list, and delete.""" |
| self.build() |
| self.breakpoint_command_script_parameters() |
| |
| def test_commands_on_creation(self): |
| self.build() |
| self.breakpoint_commands_on_creation() |
| |
| def setUp(self): |
| # Call super's setUp(). |
| TestBase.setUp(self) |
| # Find the line number to break inside main(). |
| self.line = line_number('main.c', '// Set break point at this line.') |
| # disable "There is a running process, kill it and restart?" prompt |
| self.runCmd("settings set auto-confirm true") |
| self.addTearDownHook( |
| lambda: self.runCmd("settings clear auto-confirm")) |
| |
| @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24528") |
| def test_delete_all_breakpoints(self): |
| """Test that deleting all breakpoints works.""" |
| self.build() |
| exe = self.getBuildArtifact("a.out") |
| self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET) |
| |
| lldbutil.run_break_set_by_symbol(self, "main") |
| lldbutil.run_break_set_by_file_and_line( |
| self, "main.c", self.line, num_expected_locations=1, loc_exact=True) |
| |
| self.runCmd("run", RUN_SUCCEEDED) |
| |
| self.runCmd("breakpoint delete") |
| self.runCmd("process continue") |
| self.expect("process status", PROCESS_STOPPED, |
| patterns=['Process .* exited with status = 0']) |
| |
| |
| def breakpoint_command_sequence(self): |
| """Test a sequence of breakpoint command add, list, and delete.""" |
| exe = self.getBuildArtifact("a.out") |
| self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET) |
| |
| # Add three breakpoints on the same line. The first time we don't specify the file, |
| # since the default file is the one containing main: |
| lldbutil.run_break_set_by_file_and_line( |
| self, None, self.line, num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "main.c", self.line, num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "main.c", self.line, num_expected_locations=1, loc_exact=True) |
| # Breakpoint 4 - set at the same location as breakpoint 1 to test |
| # setting breakpoint commands on two breakpoints at a time |
| lldbutil.run_break_set_by_file_and_line( |
| self, None, self.line, num_expected_locations=1, loc_exact=True) |
| # Make sure relative path source breakpoints work as expected. We test |
| # with partial paths with and without "./" prefixes. |
| lldbutil.run_break_set_by_file_and_line( |
| self, "./main.c", self.line, |
| num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "breakpoint_command/main.c", self.line, |
| num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "./breakpoint_command/main.c", self.line, |
| num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "breakpoint/breakpoint_command/main.c", self.line, |
| num_expected_locations=1, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "./breakpoint/breakpoint_command/main.c", self.line, |
| num_expected_locations=1, loc_exact=True) |
| # Test relative breakpoints with incorrect paths and make sure we get |
| # no breakpoint locations |
| lldbutil.run_break_set_by_file_and_line( |
| self, "invalid/main.c", self.line, |
| num_expected_locations=0, loc_exact=True) |
| lldbutil.run_break_set_by_file_and_line( |
| self, "./invalid/main.c", self.line, |
| num_expected_locations=0, loc_exact=True) |
| # Now add callbacks for the breakpoints just created. |
| self.runCmd( |
| "breakpoint command add -s command -o 'frame variable --show-types --scope' 1 4") |
| self.runCmd( |
| "breakpoint command add -s python -o 'import side_effect; side_effect.one_liner = \"one liner was here\"' 2") |
| self.runCmd( |
| "breakpoint command add --python-function bktptcmd.function 3") |
| |
| # Check that the breakpoint commands are correctly set. |
| |
| # The breakpoint list now only contains breakpoint 1. |
| self.expect( |
| "breakpoint list", "Breakpoints 1 & 2 created", substrs=[ |
| "2: file = 'main.c', line = %d, exact_match = 0, locations = 1" % |
| self.line], patterns=[ |
| "1: file = '.*main.c', line = %d, exact_match = 0, locations = 1" % |
| self.line]) |
| |
| self.expect( |
| "breakpoint list -f", |
| "Breakpoints 1 & 2 created", |
| substrs=[ |
| "2: file = 'main.c', line = %d, exact_match = 0, locations = 1" % |
| self.line], |
| patterns=[ |
| "1: file = '.*main.c', line = %d, exact_match = 0, locations = 1" % |
| self.line, |
| "1.1: .+at main.c:%d, .+unresolved, hit count = 0" % |
| self.line, |
| "2.1: .+at main.c:%d, .+unresolved, hit count = 0" % |
| self.line]) |
| |
| self.expect("breakpoint command list 1", "Breakpoint 1 command ok", |
| substrs=["Breakpoint commands:", |
| "frame variable --show-types --scope"]) |
| self.expect("breakpoint command list 2", "Breakpoint 2 command ok", |
| substrs=["Breakpoint commands (Python):", |
| "import side_effect", |
| "side_effect.one_liner"]) |
| self.expect("breakpoint command list 3", "Breakpoint 3 command ok", |
| substrs=["Breakpoint commands (Python):", |
| "bktptcmd.function(frame, bp_loc, internal_dict)"]) |
| |
| self.expect("breakpoint command list 4", "Breakpoint 4 command ok", |
| substrs=["Breakpoint commands:", |
| "frame variable --show-types --scope"]) |
| |
| self.runCmd("breakpoint delete 4") |
| |
| self.runCmd("command script import --allow-reload ./bktptcmd.py") |
| |
| # Next lets try some other breakpoint kinds. First break with a regular expression |
| # and then specify only one file. The first time we should get two locations, |
| # the second time only one: |
| |
| lldbutil.run_break_set_by_regexp( |
| self, r"._MyFunction", num_expected_locations=2) |
| |
| lldbutil.run_break_set_by_regexp( |
| self, |
| r"._MyFunction", |
| extra_options="-f a.c", |
| num_expected_locations=1) |
| |
| lldbutil.run_break_set_by_regexp( |
| self, |
| r"._MyFunction", |
| extra_options="-f a.c -f b.c", |
| num_expected_locations=2) |
| |
| # Now try a source regex breakpoint: |
| lldbutil.run_break_set_by_source_regexp( |
| self, |
| r"is about to return [12]0", |
| extra_options="-f a.c -f b.c", |
| num_expected_locations=2) |
| |
| lldbutil.run_break_set_by_source_regexp( |
| self, |
| r"is about to return [12]0", |
| extra_options="-f a.c", |
| num_expected_locations=1) |
| |
| # Reset our canary variables and run the program. |
| side_effect.one_liner = None |
| side_effect.bktptcmd = None |
| self.runCmd("run", RUN_SUCCEEDED) |
| |
| # Check the value of canary variables. |
| self.assertEquals("one liner was here", side_effect.one_liner) |
| self.assertEquals("function was here", side_effect.bktptcmd) |
| |
| # Finish the program. |
| self.runCmd("process continue") |
| |
| # Remove the breakpoint command associated with breakpoint 1. |
| self.runCmd("breakpoint command delete 1") |
| |
| # Remove breakpoint 2. |
| self.runCmd("breakpoint delete 2") |
| |
| self.expect( |
| "breakpoint command list 1", |
| startstr="Breakpoint 1 does not have an associated command.") |
| self.expect( |
| "breakpoint command list 2", |
| error=True, |
| startstr="error: '2' is not a currently valid breakpoint ID.") |
| |
| # The breakpoint list now only contains breakpoint 1. |
| self.expect( |
| "breakpoint list -f", |
| "Breakpoint 1 exists", |
| patterns=[ |
| "1: file = '.*main.c', line = %d, exact_match = 0, locations = 1, resolved = 1" % |
| self.line, |
| "hit count = 1"]) |
| |
| # Not breakpoint 2. |
| self.expect( |
| "breakpoint list -f", |
| "No more breakpoint 2", |
| matching=False, |
| substrs=[ |
| "2: file = 'main.c', line = %d, exact_match = 0, locations = 1, resolved = 1" % |
| self.line]) |
| |
| # Run the program again, with breakpoint 1 remaining. |
| self.runCmd("run", RUN_SUCCEEDED) |
| |
| # We should be stopped again due to breakpoint 1. |
| |
| # The stop reason of the thread should be breakpoint. |
| self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT, |
| substrs=['stopped', |
| 'stop reason = breakpoint']) |
| |
| # The breakpoint should have a hit count of 2. |
| self.expect("breakpoint list -f", BREAKPOINT_HIT_TWICE, |
| substrs=['resolved, hit count = 2']) |
| |
| def breakpoint_command_script_parameters(self): |
| """Test that the frame and breakpoint location are being properly passed to the script breakpoint command function.""" |
| exe = self.getBuildArtifact("a.out") |
| self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET) |
| |
| # Add a breakpoint. |
| lldbutil.run_break_set_by_file_and_line( |
| self, "main.c", self.line, num_expected_locations=1, loc_exact=True) |
| |
| # Now add callbacks for the breakpoints just created. |
| self.runCmd("breakpoint command add -s python -o 'import side_effect; side_effect.frame = str(frame); side_effect.bp_loc = str(bp_loc)' 1") |
| |
| # Reset canary variables and run. |
| side_effect.frame = None |
| side_effect.bp_loc = None |
| self.runCmd("run", RUN_SUCCEEDED) |
| |
| self.expect(side_effect.frame, exe=False, startstr="frame #0:") |
| self.expect(side_effect.bp_loc, exe=False, |
| patterns=["1.* where = .*main .* resolved, hit count = 1"]) |
| |
| def breakpoint_commands_on_creation(self): |
| """Test that setting breakpoint commands when creating the breakpoint works""" |
| exe = self.getBuildArtifact("a.out") |
| target = self.dbg.CreateTarget(exe) |
| self.assertTrue(target.IsValid(), "Created an invalid target.") |
| |
| # Add a breakpoint. |
| lldbutil.run_break_set_by_file_and_line( |
| self, "main.c", self.line, num_expected_locations=1, loc_exact=True, |
| extra_options='-C bt -C "thread list" -C continue') |
| |
| bkpt = target.FindBreakpointByID(1) |
| self.assertTrue(bkpt.IsValid(), "Couldn't find breakpoint 1") |
| com_list = lldb.SBStringList() |
| bkpt.GetCommandLineCommands(com_list) |
| self.assertEqual(com_list.GetSize(), 3, "Got the wrong number of commands") |
| self.assertEqual(com_list.GetStringAtIndex(0), "bt", "First bt") |
| self.assertEqual(com_list.GetStringAtIndex(1), "thread list", "Next thread list") |
| self.assertEqual(com_list.GetStringAtIndex(2), "continue", "Last continue") |
