1"""Test that lldb functions correctly after the inferior has crashed while in a recursive routine."""
2
3
4
5import lldb
6from lldbsuite.test.decorators import *
7from lldbsuite.test.lldbtest import *
8from lldbsuite.test import lldbplatformutil
9from lldbsuite.test import lldbutil
10
11
12class CrashingRecursiveInferiorTestCase(TestBase):
13
14    mydir = TestBase.compute_mydir(__file__)
15
16    @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24778")
17    @expectedFailureNetBSD
18    def test_recursive_inferior_crashing(self):
19        """Test that lldb reliably catches the inferior crashing (command)."""
20        self.build()
21        self.recursive_inferior_crashing()
22
23    @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24778")
24    def test_recursive_inferior_crashing_register(self):
25        """Test that lldb reliably reads registers from the inferior after crashing (command)."""
26        self.build()
27        self.recursive_inferior_crashing_registers()
28
29    @add_test_categories(['pyapi'])
30    def test_recursive_inferior_crashing_python(self):
31        """Test that lldb reliably catches the inferior crashing (Python API)."""
32        self.build()
33        self.recursive_inferior_crashing_python()
34
35    def test_recursive_inferior_crashing_expr(self):
36        """Test that the lldb expression interpreter can read from the inferior after crashing (command)."""
37        self.build()
38        self.recursive_inferior_crashing_expr()
39
40    def set_breakpoint(self, line):
41        lldbutil.run_break_set_by_file_and_line(
42            self, "main.c", line, num_expected_locations=1, loc_exact=True)
43
44    def check_stop_reason(self):
45        # We should have one crashing thread
46        self.assertEqual(
47            len(lldbutil.get_crashed_threads(self, self.dbg.GetSelectedTarget().GetProcess())),
48            1,
49            STOPPED_DUE_TO_EXC_BAD_ACCESS)
50
51    def setUp(self):
52        # Call super's setUp().
53        TestBase.setUp(self)
54        # Find the line number of the crash.
55        self.line = line_number('main.c', '// Crash here.')
56
57    def recursive_inferior_crashing(self):
58        """Inferior crashes upon launching; lldb should catch the event and stop."""
59        exe = self.getBuildArtifact("a.out")
60        self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
61
62        self.runCmd("run", RUN_SUCCEEDED)
63
64        # The exact stop reason depends on the platform
65        if self.platformIsDarwin():
66            stop_reason = 'stop reason = EXC_BAD_ACCESS'
67        elif self.getPlatform() == "linux" or self.getPlatform() == "freebsd":
68            stop_reason = 'stop reason = signal SIGSEGV'
69        else:
70            stop_reason = 'stop reason = invalid address'
71        self.expect("thread list", STOPPED_DUE_TO_EXC_BAD_ACCESS,
72                    substrs=['stopped',
73                             stop_reason])
74
75        # And it should report a backtrace that includes main and the crash
76        # site.
77        self.expect(
78            "thread backtrace all",
79            substrs=[
80                stop_reason,
81                'recursive_function',
82                'main',
83                'argc',
84                'argv',
85            ])
86
87        # And it should report the correct line number.
88        self.expect("thread backtrace all",
89                    substrs=[stop_reason,
90                             'main.c:%d' % self.line])
91
92    def recursive_inferior_crashing_python(self):
93        """Inferior crashes upon launching; lldb should catch the event and stop."""
94        exe = self.getBuildArtifact("a.out")
95
96        target = self.dbg.CreateTarget(exe)
97        self.assertTrue(target, VALID_TARGET)
98
99        # Now launch the process, and do not stop at entry point.
100        # Both argv and envp are null.
101        process = target.LaunchSimple(
102            None, None, self.get_process_working_directory())
103
104        if process.GetState() != lldb.eStateStopped:
105            self.fail("Process should be in the 'stopped' state, "
106                      "instead the actual state is: '%s'" %
107                      lldbutil.state_type_to_str(process.GetState()))
108
109        threads = lldbutil.get_crashed_threads(self, process)
110        self.assertEqual(
111            len(threads),
112            1,
113            "Failed to stop the thread upon bad access exception")
114
115        if self.TraceOn():
116            lldbutil.print_stacktrace(threads[0])
117
118    def recursive_inferior_crashing_registers(self):
119        """Test that lldb can read registers after crashing."""
120        exe = self.getBuildArtifact("a.out")
121        self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
122
123        self.runCmd("run", RUN_SUCCEEDED)
124        self.check_stop_reason()
125
126        # lldb should be able to read from registers from the inferior after
127        # crashing.
128        lldbplatformutil.check_first_register_readable(self)
129
130    def recursive_inferior_crashing_expr(self):
131        """Test that the lldb expression interpreter can read symbols after crashing."""
132        exe = self.getBuildArtifact("a.out")
133        self.runCmd("file " + exe, CURRENT_EXECUTABLE_SET)
134
135        self.runCmd("run", RUN_SUCCEEDED)
136        self.check_stop_reason()
137
138        # The lldb expression interpreter should be able to read from addresses
139        # of the inferior after a crash.
140        self.expect("p i",
141                    startstr='(int) $0 =')
142