1 # This testcase is part of GDB, the GNU debugger.
3 # Copyright 2004-2023 Free Software Foundation, Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Check that GDB can and only executes single instructions when
19 # stepping through a sequence of breakpoints interleaved by a signal
22 # This test is known to tickle the following problems: kernel letting
23 # the inferior execute both the system call, and the instruction
24 # following, when single-stepping a system call; kernel failing to
25 # propogate the single-step state when single-stepping the sigreturn
26 # system call, instead resuming the inferior at full speed; GDB
27 # doesn't know how to software single-step across a sigreturn
28 # instruction. Since the kernel problems can be "fixed" using
29 # software single-step this is KFAILed rather than XFAILed.
31 if [target_info exists gdb,nosignals] {
32 verbose "Skipping sigbpt.exp because of nosignals."
39 if {[prepare_for_testing "failed to prepare" $testfile $srcfile debug]} {
44 # Run to `main' where we begin our tests.
51 # If we can examine what's at memory address 0, it is possible that we
52 # could also execute it. This could probably make us run away,
53 # executing random code, which could have all sorts of ill effects,
54 # especially on targets without an MMU. Don't run the tests in that
57 if { [is_address_zero_readable] } {
58 untested "memory at address 0 is possibly executable"
62 gdb_test "break keeper"
64 # Run to bowler, and then single step until there's a SIGSEGV. Record
65 # the address of each single-step instruction (up to and including the
66 # instruction that causes the SIGSEGV) in bowler_addrs, and the address
67 # of the actual SIGSEGV in segv_addr.
68 # Note: this test detects which signal is received. Usually it is SIGSEGV
69 # (and we use SIGSEGV in comments) but on Darwin it is SIGBUS.
71 set bowler_addrs bowler
73 gdb_test {display/i $pc}
74 gdb_test "advance bowler" "bowler.*" "advance to the bowler"
75 set test "stepping to fault"
77 gdb_test_multiple "stepi" "$test" {
78 -re "Program received signal (SIGBUS|SIGSEGV).*pc(\r\n| *) *=> (0x\[0-9a-f\]*).*$gdb_prompt $" {
79 set signame $expect_out(1,string)
80 set segv_addr $expect_out(3,string)
83 -re " .*pc(\r\n| *)=> (0x\[0-9a-f\]*).*bowler.*$gdb_prompt $" {
84 set bowler_addrs [concat $expect_out(2,string) $bowler_addrs]
90 # Now record the address of the instruction following the faulting
91 # instruction in bowler_addrs.
93 set test "get insn after fault"
94 gdb_test_multiple {x/2i $pc} "$test" {
95 -re "=> (0x\[0-9a-f\]*).*bowler.*(0x\[0-9a-f\]*).*bowler.*$gdb_prompt $" {
96 set bowler_addrs [concat $expect_out(2,string) $bowler_addrs]
101 # Procedures for returning the address of the instruction before, at
102 # and after, the faulting instruction.
104 proc before_segv { } {
106 return [lindex $bowler_addrs 2]
111 return [lindex $bowler_addrs 1]
114 proc after_segv { } {
116 return [lindex $bowler_addrs 0]
119 # Check that the address table and SIGSEGV correspond.
121 set test "verify that ${signame} occurs at the last STEPI insn"
122 if {[string compare $segv_addr [at_segv]] == 0} {
125 fail "$test ($segv_addr [at_segv])"
128 # Check that the inferior is correctly single stepped all the way back
129 # to a faulting instruction.
131 proc stepi_out { name args } {
135 # Set SIGSEGV to pass+nostop and then run the inferior all the way
136 # through to the signal handler. With the handler is reached,
137 # disable SIGSEGV, ensuring that further signals stop the
138 # inferior. Stops a SIGSEGV infinite loop when a broke system
139 # keeps re-executing the faulting instruction.
140 with_test_prefix $name {
143 gdb_test "handle ${signame} nostop print pass" ".*" "${name}; pass ${signame}"
144 gdb_test "continue" "keeper.*" "${name}; continue to keeper"
145 gdb_test "handle ${signame} stop print nopass" ".*" "${name}; nopass ${signame}"
147 # Insert all the breakpoints. To avoid the need to step over
148 # these instructions, this is delayed until after the keeper has
150 for {set i 0} {$i < [llength $args]} {incr i} {
151 gdb_test "break [lindex $args $i]" "Breakpoint.*" \
152 "${name}; set breakpoint $i of [llength $args]"
155 # Single step our way out of the keeper, through the signal
156 # trampoline, and back to the instruction that faulted.
157 set test "${name}; stepi out of handler"
158 gdb_test_multiple "stepi" "$test" {
159 -re "Could not insert single-step breakpoint.*$gdb_prompt $" {
160 setup_kfail gdb/8841 "sparc*-*-openbsd*"
161 fail "$test (could not insert single-step breakpoint)"
163 -re "Cannot insert breakpoint.*Cannot access memory.*$gdb_prompt $" {
164 setup_kfail gdb/8841 "nios2*-*-linux*"
165 fail "$test (could not insert single-step breakpoint)"
167 -re "keeper.*$gdb_prompt $" {
171 -re "signal handler.*$gdb_prompt $" {
175 -re "Program received signal SIGSEGV.*$gdb_prompt $" {
176 kfail gdb/8807 "$test (executed fault insn)"
178 -re "Breakpoint.*pc(\r\n| *)[at_segv] .*bowler.*$gdb_prompt $" {
179 pass "$test (at breakpoint)"
181 -re "Breakpoint.*pc(\r\n| *)[after_segv] .*bowler.*$gdb_prompt $" {
182 kfail gdb/8807 "$test (executed breakpoint)"
184 -re "pc(\r\n| *)[at_segv] .*bowler.*$gdb_prompt $" {
187 -re "pc(\r\n| *)[after_segv] .*bowler.*$gdb_prompt $" {
188 kfail gdb/8807 "$test (skipped fault insn)"
190 -re "pc(\r\n| *)=> 0x\[a-z0-9\]* .*bowler.*$gdb_prompt $" {
191 kfail gdb/8807 "$test (corrupt pc)"
195 # Clear any breakpoints
196 for {set i 0} {$i < [llength $args]} {incr i} {
197 gdb_test "clear [lindex $args $i]" "Deleted .*" \
198 "${name}; clear breakpoint $i of [llength $args]"
202 # Let a signal handler exit, returning to a breakpoint instruction
203 # inserted at the original fault instruction. Check that the
204 # breakpoint is hit, and that single stepping off that breakpoint
205 # executes the underlying fault instruction causing a SIGSEGV.
207 proc cont_out { name args } {
211 # Set SIGSEGV to pass+nostop and then run the inferior all the way
212 # through to the signal handler. With the handler is reached,
213 # disable SIGSEGV, ensuring that further signals stop the
214 # inferior. Stops a SIGSEGV infinite loop when a broke system
215 # keeps re-executing the faulting instruction.
216 with_test_prefix $name {
219 gdb_test "handle ${signame} nostop print pass" ".*" "${name}; pass ${signame}"
220 gdb_test "continue" "keeper.*" "${name}; continue to keeper"
221 gdb_test "handle ${signame} stop print nopass" ".*" "${name}; nopass ${signame}"
223 # Insert all the breakpoints. To avoid the need to step over
224 # these instructions, this is delayed until after the keeper has
225 # been reached. Always set a breakpoint at the signal trampoline
227 set args [concat $args "*[at_segv]"]
228 for {set i 0} {$i < [llength $args]} {incr i} {
229 gdb_test "break [lindex $args $i]" "Breakpoint.*" \
230 "${name}; set breakpoint $i of [llength $args]"
233 # Let the handler return, it should "appear to hit" the breakpoint
234 # inserted at the faulting instruction. Note that the breakpoint
235 # instruction wasn't executed, rather the inferior was SIGTRAPed
236 # with the PC at the breakpoint.
237 gdb_test "continue" "Breakpoint.*pc(\r\n| *)=> [at_segv] .*" \
238 "${name}; continue to breakpoint at fault"
240 # Now single step the faulted instrction at that breakpoint.
242 "Program received signal ${signame}.*pc(\r\n| *)=> [at_segv] .*" \
243 "${name}; stepi fault"
245 # Clear any breakpoints
246 for {set i 0} {$i < [llength $args]} {incr i} {
247 gdb_test "clear [lindex $args $i]" "Deleted .*" \
248 "${name}; clear breakpoint $i of [llength $args]"
255 # Try to confuse DECR_PC_AFTER_BREAK architectures by scattering
256 # breakpoints around the faulting address. In all cases the inferior
257 # should single-step out of the signal trampoline halting (but not
258 # executing) the fault instruction.
261 stepi_out "stepi bp before segv" "*[before_segv]"
262 stepi_out "stepi bp at segv" "*[at_segv]"
263 stepi_out "stepi bp before and at segv" "*[at_segv]" "*[before_segv]"
266 # Try to confuse DECR_PC_AFTER_BREAK architectures by scattering
267 # breakpoints around the faulting address. In all cases the inferior
268 # should exit the signal trampoline halting at the breakpoint that
269 # replaced the fault instruction.
271 cont_out "cont bp after segv" "*[before_segv]"
272 cont_out "cont bp before and after segv" "*[before_segv]" "*[after_segv]"