2
0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2025-01-18 12:24:38 +08:00
binutils-gdb/gdb/testsuite/gdb.base/step-over-syscall.exp
Luis Machado 16b10d6e61 Harden gdb.base/step-over-syscall.exp
New in v3:
- Verify if the syscall number matches what is expected for the target.
- Used gdb_assert for one more check.

New in v2:

- Set initial values to -1 instead of 0.
- Rewrote RE to prevent unexpected matching when parsing one character at a
  time.
- Used gdb_assert for an additional check.
- Validated with check-read1

There are a couple problems with this test.

First
--

gdb.base/step-over-syscall.exp records the address of a syscall instruction
within fork/vfork/clone functions and also the address of the instruction
after that syscall instruction.

It uses these couples addresses to make sure we stepped over a syscall
instruction (fork/vfork/clone events) correctly.

The way the test fetches the addresses of the instructions is by stepi-ing
its way through the fork/vfork/clone functions until it finds a match for
a syscall. Then it stepi's once again to get the address of the next
instruction.

This assumes that stepi-ing over a syscall is working correctly and landing
in the right PC. This is not the case for AArch64/Linux, where we're
landing a couple instructions after the syscall in some cases.

The following patch lets the test execute as before, but adds a new instruction
address check using the x command as opposed to stepi.

I didn't want to change how the test works since we may also be
interested in checking if stepi-ing over the syscall under different
conditions (displaced stepping on/off) yields the same results. I don't
feel strongly about this, so i'm OK with changing how we compare PC's for
the entire test if folks decide it is reasonable.

Second
--

FAIL: gdb.base/step-over-syscall.exp: vfork: displaced=off: continue to vfork (3rd time) (the program exited)
FAIL: gdb.base/step-over-syscall.exp: vfork: displaced=off: continue to syscall insn vfork (the program is no longer running)
FAIL: gdb.base/step-over-syscall.exp: vfork: displaced=off: single step over vfork (the program is no longer running)

Depending on the glibc version we may have different code generated for the
fork/vfork/clone functions.

I ran into the situation where vfork for newer glibc's on AArch64/Linux is
very short, so "break vfork" will put a breakpoint right at the syscall
instruction, which is something the testcase isn't expecting (a off-by-1
of sorts).

The patch adds extra code to handle this case. If the test detects we're
already sitting at a syscall instruction, it records the address and moves
on to record the address after that particular instruction.

Another measure is to "break *$syscall" instead of "break $syscall". That
guarantees we're stopping at the first instruction of the syscall function,
if it ever happens that the syscall instruction is the first instruction of
those functions.

With these changes i can fix some failures for aarch64-linux-gnu and also
expose the problems i've reported here:

https://sourceware.org/ml/gdb-patches/2019-12/msg01071.html

These tests now fail for aarch64-linux-gnu (patch for this is going through
reviews):

FAIL: gdb.base/step-over-syscall.exp: vfork: displaced=off: pc after stepi matches insn addr after syscall
FAIL: gdb.base/step-over-syscall.exp: vfork: displaced=on: pc after stepi matches insn addr after syscall

gdb/testsuite/ChangeLog:

2020-01-27  Luis Machado  <luis.machado@linaro.org>

	* gdb.base/step-over-syscall.exp (setup): Check if we're already
	sitting at a syscall instruction when we hit the syscall function's
	breakpoint.
	Check PC against one obtained with the x command.
	Validate syscall number.
	(step_over_syscall): Don't continue to the syscall instruction if
	we're already there.
2020-01-27 17:28:06 -03:00

358 lines
11 KiB
Plaintext

# This testcase is part of GDB, the GNU debugger.
# Copyright 2011-2020 Free Software Foundation, Inc.
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set syscall_insn ""
set syscall_register ""
array set syscall_number {}
# Define the syscall instructions, registers and numbers for each target.
if { [istarget "i\[34567\]86-*-linux*"] || [istarget "x86_64-*-linux*"] } {
set syscall_insn "\[ \t\](int|syscall|sysenter)\[ \t\]"
set syscall_register "eax"
array set syscall_number {fork "(56|120)" vfork "(58|190)" \
clone "(56|120)"}
} elseif { [istarget "aarch64*-*-linux*"] || [istarget "arm*-*-linux*"] } {
set syscall_insn "\[ \t\](swi|svc)\[ \t\]"
if { [istarget "aarch64*-*-linux*"] } {
set syscall_register "x8"
} else {
set syscall_register "r7"
}
array set syscall_number {fork "(120|220)" vfork "(190|220)" \
clone "(120|220)"}
} else {
return -1
}
proc_with_prefix check_pc_after_cross_syscall { syscall syscall_insn_next_addr } {
set syscall_insn_next_addr_found [get_hexadecimal_valueof "\$pc" "0"]
gdb_assert {$syscall_insn_next_addr != 0 \
&& $syscall_insn_next_addr == $syscall_insn_next_addr_found} \
"single step over $syscall final pc"
}
# Verify the syscall number is the correct one.
proc syscall_number_matches { syscall } {
global syscall_register syscall_number
if {[gdb_test "p \$$syscall_register" ".*= $syscall_number($syscall)" \
"syscall number matches"] != 0} {
return 0
}
return 1
}
# Restart GDB and set up the test. Return a list in which the first one
# is the address of syscall instruction and the second one is the address
# of the next instruction address of syscall instruction. If anything
# wrong, the two elements of list are -1.
proc setup { syscall } {
global gdb_prompt syscall_insn
global hex
set next_insn_addr -1
set testfile "step-over-$syscall"
clean_restart $testfile
if { ![runto main] } then {
fail "run to main ($syscall)"
return -1
}
# Delete the breakpoint on main.
gdb_test_no_output "delete break 1"
gdb_test_no_output "set displaced-stepping off" \
"set displaced-stepping off during test setup"
gdb_test "break \*$syscall" "Breakpoint \[0-9\]* at .*"
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, (.* in |__libc_|)$syscall \\(\\).*" \
"continue to $syscall (1st time)"
# Hit the breakpoint on $syscall for the first time. In this time,
# we will let PLT resolution done, and the number single steps we will
# do later will be reduced.
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, (.* in |__libc_|)$syscall \\(\\).*" \
"continue to $syscall (2nd time)"
# Hit the breakpoint on $syscall for the second time. In this time,
# the address of syscall insn and next insn of syscall are recorded.
# Check if the first instruction we stopped at is the syscall one.
set syscall_insn_addr -1
gdb_test_multiple "display/i \$pc" "fetch first stop pc" {
-re "display/i .*: x/i .*=> ($hex) .*:.*$syscall_insn.*$gdb_prompt $" {
set insn_addr $expect_out(1,string)
# Is the syscall number the correct one?
if {[syscall_number_matches $syscall]} {
set syscall_insn_addr $insn_addr
}
pass $gdb_test_name
}
-re ".*$gdb_prompt $" {
pass $gdb_test_name
}
}
# If we are not at the syscall instruction yet, keep looking for it with
# stepi commands.
if {$syscall_insn_addr == -1} {
# Single step until we see a syscall insn or we reach the
# upper bound of loop iterations.
set steps 0
set max_steps 1000
gdb_test_multiple "stepi" "find syscall insn in $syscall" {
-re ".*$syscall_insn.*$gdb_prompt $" {
# Is the syscall number the correct one?
if {[syscall_number_matches $syscall]} {
pass $gdb_test_name
} else {
exp_continue
}
}
-re "x/i .*=>.*\r\n$gdb_prompt $" {
incr steps
if {$steps == $max_steps} {
fail $gdb_test_name
} else {
send_gdb "stepi\n"
exp_continue
}
}
}
if {$steps == $max_steps} {
return { -1, -1 }
}
}
# We have found the syscall instruction. Now record the next instruction.
# Use the X command instead of stepi since we can't guarantee
# stepi is working properly.
gdb_test_multiple "x/2i \$pc" "pc before/after syscall instruction" {
-re "x/2i .*=> ($hex) .*:.*$syscall_insn.* ($hex) .*:.*$gdb_prompt $" {
set syscall_insn_addr $expect_out(1,string)
set next_insn_addr $expect_out(3,string)
pass $gdb_test_name
}
}
if {[gdb_test "stepi" "x/i .*=>.*" "stepi $syscall insn"] != 0} {
return { -1, -1 }
}
set pc_after_stepi [get_hexadecimal_valueof "\$pc" "0" \
"pc after stepi"]
gdb_assert {$next_insn_addr == $pc_after_stepi} \
"pc after stepi matches insn addr after syscall"
return [list $syscall_insn_addr $pc_after_stepi]
}
proc step_over_syscall { syscall } {
with_test_prefix "$syscall" {
global syscall_insn
global gdb_prompt
set testfile "step-over-$syscall"
if [build_executable ${testfile}.exp ${testfile} ${testfile}.c {debug}] {
untested "failed to compile"
return -1
}
foreach_with_prefix displaced {"off" "on"} {
if {$displaced == "on" && ![support_displaced_stepping]} {
continue
}
if { $displaced == "on" && $syscall == "clone" } {
# GDB doesn't support stepping over clone syscall with
# displaced stepping.
kfail "gdb/19675" "single step over clone"
continue
}
set ret [setup $syscall]
set syscall_insn_addr [lindex $ret 0]
set syscall_insn_next_addr [lindex $ret 1]
if { $syscall_insn_addr == -1 } {
return -1
}
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, (.* in |__libc_|)$syscall \\(\\).*" \
"continue to $syscall (3rd time)"
# Hit the breakpoint on $syscall for the third time. In this time, we'll set
# breakpoint on the syscall insn we recorded previously, and single step over it.
set syscall_insn_bp 0
gdb_test_multiple "break \*$syscall_insn_addr" "break on syscall insn" {
-re "Breakpoint (\[0-9\]*) at .*$gdb_prompt $" {
set syscall_insn_bp $expect_out(1,string)
pass "break on syscall insns"
}
}
# Check if the syscall breakpoint is at the syscall instruction
# address. If so, no need to continue, otherwise we will run the
# inferior to completion.
if {$syscall_insn_addr != [get_hexadecimal_valueof "\$pc" "0"]} {
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, .*" \
"continue to syscall insn $syscall"
}
gdb_test_no_output "set displaced-stepping $displaced"
# Check the address of next instruction of syscall.
if {[gdb_test "stepi" "x/i .*=>.*" "single step over $syscall"] != 0} {
return -1
}
check_pc_after_cross_syscall $syscall $syscall_insn_next_addr
# Delete breakpoint syscall insns to avoid interference to other syscalls.
delete_breakpoints
gdb_test "break marker" "Breakpoint.*at.* file .*${testfile}.c, line.*"
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, marker \\(\\) at.*" \
"continue to marker ($syscall)"
}
}
}
# Set a breakpoint with a condition that evals false on syscall
# instruction. In fact, it tests GDBserver steps over syscall
# instruction. SYSCALL is the syscall the program calls.
# FOLLOW_FORK is either "parent" or "child". DETACH_ON_FORK is
# "on" or "off".
proc break_cond_on_syscall { syscall follow_fork detach_on_fork } {
with_test_prefix "break cond on target : $syscall" {
set testfile "step-over-$syscall"
set ret [setup $syscall]
set syscall_insn_addr [lindex $ret 0]
set syscall_insn_next_addr [lindex $ret 1]
if { $syscall_insn_addr == -1 } {
return -1
}
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, (.* in |__libc_|)$syscall \\(\\).*" \
"continue to $syscall"
# Delete breakpoint syscall insns to avoid interference with other syscalls.
delete_breakpoints
gdb_test "set follow-fork-mode $follow_fork"
gdb_test "set detach-on-fork $detach_on_fork"
# Create a breakpoint with a condition that evals false.
gdb_test "break \*$syscall_insn_addr if main == 0" \
"Breakpoint \[0-9\]* at .*"
if { $syscall == "clone" } {
# Create a breakpoint in the child with the condition that
# evals false, so that GDBserver can get the event from the
# child but GDB doesn't see it. In this way, we don't have
# to adjust the test flow for "clone".
# This is a regression test for PR server/19736. In this way,
# we can test that GDBserver gets an event from the child and
# set suspend count correctly while the parent is stepping over
# the breakpoint.
gdb_test "break clone_fn if main == 0"
}
if { $syscall == "clone" } {
# follow-fork and detach-on-fork only make sense to
# fork and vfork.
gdb_test "break marker" "Breakpoint.*at.* file .*${testfile}.c, line.*"
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, marker \\(\\) at.*" \
"continue to marker"
} else {
if { $follow_fork == "child" } {
gdb_test "continue" "exited normally.*" "continue to end of inf 2"
if { $detach_on_fork == "off" } {
gdb_test "inferior 1"
gdb_test "break marker" "Breakpoint.*at.*"
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, marker \\(\\) at.*" \
"continue to marker"
}
} else {
gdb_test "break marker" "Breakpoint.*at.* file .*${testfile}.c, line.*"
gdb_test "continue" "Continuing\\..*Breakpoint \[0-9\]+, marker \\(\\) at.*" \
"continue to marker"
}
}
}
}
step_over_syscall "fork"
step_over_syscall "vfork"
step_over_syscall "clone"
set testfile "step-over-fork"
clean_restart $testfile
if { ![runto main] } then {
fail "run to main"
return -1
}
set cond_bp_target 1
set test "set breakpoint condition-evaluation target"
gdb_test_multiple $test $test {
-re "warning: Target does not support breakpoint condition evaluation.\r\nUsing host evaluation mode instead.\r\n$gdb_prompt $" {
# Target doesn't support breakpoint condition
# evaluation on its side.
set cond_bp_target 0
}
-re "^$test\r\n$gdb_prompt $" {
}
}
if { $cond_bp_target } {
foreach_with_prefix detach-on-fork {"on" "off"} {
foreach_with_prefix follow-fork {"parent" "child"} {
foreach syscall { "fork" "vfork" "clone" } {
if { $syscall == "vfork"
&& ${follow-fork} == "parent"
&& ${detach-on-fork} == "off" } {
# Both vforked child process and parent process are
# under GDB's control, but GDB follows the parent
# process only, which can't be run until vforked child
# finishes. Skip the test in this scenario.
continue
}
break_cond_on_syscall $syscall ${follow-fork} ${detach-on-fork}
}
}
}
}