[gdb/testsuite] Factor out lib/valgrind.exp

Factor out common code related to vgdb setup and cleanup in valgrind-bt.exp,
valgrind-disp-step.exp and gdb.base/valgrind-infcall.exp.

Tested on x86_64-linux with and without --target_board=native-gdbserver.

2018-10-31  Tom de Vries  <tdevries@suse.de>

	* lib/valgrind.exp: New file.
	 (vgdb_start, vgdb_stop): New procs, factored out of ...
	* gdb.base/valgrind-bt.exp: ... here, ...
	* gdb.base/valgrind-disp-step.exp: ... here and ...
	* gdb.base/valgrind-infcall.exp: ... here.

5 files changed, 125 insertions, 204 deletions

diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index 2f0085b..519466e 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,5 +1,13 @@
 2018-10-31  Tom de Vries  <tdevries@suse.de>
 
+	* lib/valgrind.exp: New file.
+	 (vgdb_start, vgdb_stop): New procs, factored out of ...
+	* gdb.base/valgrind-bt.exp: ... here, ...
+	* gdb.base/valgrind-disp-step.exp: ... here and ...
+	* gdb.base/valgrind-infcall.exp: ... here.
+
+2018-10-31  Tom de Vries  <tdevries@suse.de>
+
 	* lib/gdb.exp (get_valueof): Don't output read value in test name.
 
 2018-10-31  Andrew Burgess  <andrew.burgess@embecosm.com>
diff --git a/gdb/testsuite/gdb.base/valgrind-bt.exp b/gdb/testsuite/gdb.base/valgrind-bt.exp
index 348f743..eb127d1 100644
--- a/gdb/testsuite/gdb.base/valgrind-bt.exp
+++ b/gdb/testsuite/gdb.base/valgrind-bt.exp
@@ -13,6 +13,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+load_lib valgrind.exp
+
 if [is_remote target] {
     # The test always runs locally.
     return 0
@@ -23,74 +25,9 @@ if {[build_executable $testfile.exp $testfile $srcfile {debug}] == -1} {
     return -1
 }
 
-set test "spawn valgrind"
-set cmd "valgrind --vgdb-error=0 $binfile"
-set res [remote_spawn host $cmd]
-if { $res < 0 || $res == "" } {
-    verbose -log "Spawning $cmd failed."
-    unsupported $test
+if { [vgdb_start] == -1 } {
     return -1
 }
-pass $test
-# Declare GDB now as running.
-set gdb_spawn_id $res
-
-# GDB started by vgdb stops already after the startup is executed, like with
-# non-extended gdbserver.  It is also not correct to run/attach the inferior.
-set use_gdb_stub 1
-
-set test "valgrind started"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "Memcheck, a memory error detector\\.?\r\n" {
-	pass $test
-    }
-    -re "valgrind: failed to start tool 'memcheck' for platform '.*': No such file or directory" {
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: wrong ELF executable class" {
-	unsupported $test
-	return -1
-    }
-    -re "command not found" {
-	# The spawn succeeded, but then valgrind was not found - e.g. if
-	# we spawned SSH to a remote system.
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: Bad option.*--vgdb-error=0" {
-	# valgrind is not >= 3.7.0.
-	unsupported $test
-	return -1
-    }
-}
-
-set test "vgdb prompt"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "  (target remote | \[^\r\n\]*/vgdb \[^\r\n\]*)\r\n" {
-	set vgdbcmd $expect_out(1,string)
-	pass $test
-    }
-}
-
-# Do not kill valgrind.
-set valgrind_spawn_id [board_info host fileid]
-unset gdb_spawn_id
-set board [host_info name]
-unset_board_info fileid
-
-clean_restart $testfile
-
-# Make sure we're disconnected, in case we're testing with the
-# native-extended-gdbserver board, where gdb_start/gdb_load spawn
-# gdbserver and connect to it.
-gdb_test "disconnect" ".*"
-
-gdb_test "$vgdbcmd" " in \\.?_start .*" "target remote for vgdb"
-
-gdb_test "monitor v.set gdb_output" "valgrind output will go to gdb.*"
 
 set double_free [gdb_get_line_number "double-free"]
 
@@ -125,5 +62,4 @@ gdb_test "bt" "in main \\(.*\\) at .*${srcfile}:$double_free"
 # Explicitly kill the program so it doesn't dump core when we quit->detach.
 gdb_test "kill" "" "kill program" "Kill the program being debugged.*y or n. $" "y"
 
-# Only if valgrind got stuck.
-kill_wait_spawned_process $valgrind_spawn_id
+vgdb_stop
diff --git a/gdb/testsuite/gdb.base/valgrind-disp-step.exp b/gdb/testsuite/gdb.base/valgrind-disp-step.exp
index 6ce1644..2b610ef 100644
--- a/gdb/testsuite/gdb.base/valgrind-disp-step.exp
+++ b/gdb/testsuite/gdb.base/valgrind-disp-step.exp
@@ -18,6 +18,8 @@
 # really tests is that GDB falls back to in-line stepping
 # automatically instead of getting stuck or crashing.
 
+load_lib valgrind.exp
+
 if [is_remote target] {
     # The test always runs locally.
     return 0
@@ -28,74 +30,9 @@ if {[build_executable "failed to build" $testfile $srcfile {debug}] == -1} {
     return -1
 }
 
-set test "spawn valgrind"
-set cmd "valgrind --vgdb-error=0 $binfile"
-set res [remote_spawn host $cmd]
-if { $res < 0 || $res == "" } {
-    verbose -log "Spawning $cmd failed."
-    unsupported $test
+if { [vgdb_start] == -1 } {
     return -1
 }
-pass $test
-# Declare GDB now as running.
-set gdb_spawn_id $res
-
-# GDB started by vgdb stops already after the startup is executed, like with
-# non-extended gdbserver.  It is also not correct to run/attach the inferior.
-set use_gdb_stub 1
-
-set test "valgrind started"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "Memcheck, a memory error detector\\.?\r\n" {
-	pass $test
-    }
-    -re "valgrind: failed to start tool 'memcheck' for platform '.*': No such file or directory" {
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: wrong ELF executable class" {
-	unsupported $test
-	return -1
-    }
-    -re "command not found" {
-	# The spawn succeeded, but then valgrind was not found - e.g. if
-	# we spawned SSH to a remote system.
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: Bad option.*--vgdb-error=0" {
-	# valgrind is not >= 3.7.0.
-	unsupported $test
-	return -1
-    }
-}
-
-set test "vgdb prompt"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "  (target remote | \[^\r\n\]*/vgdb \[^\r\n\]*)\r\n" {
-	set vgdbcmd $expect_out(1,string)
-	pass $test
-    }
-}
-
-# Do not kill valgrind.
-set valgrind_pid [exp_pid -i [board_info host fileid]]
-unset gdb_spawn_id
-set board [host_info name]
-unset_board_info fileid
-
-clean_restart $testfile
-
-# Make sure we're disconnected, in case we're testing with the
-# native-extended-gdbserver board, where gdb_start/gdb_load spawn
-# gdbserver and connect to it.
-gdb_test "disconnect" ".*"
-
-gdb_test "$vgdbcmd" " in \\.?_start .*" "target remote for vgdb"
-
-gdb_test "monitor v.set gdb_output" "valgrind output will go to gdb.*"
 
 gdb_test_no_output "set displaced-stepping off"
 gdb_breakpoint "main" "breakpoint at main"
@@ -132,5 +69,4 @@ foreach displaced { "off" "on" } {
     }
 }
 
-# Only if valgrind got stuck.
-remote_exec host "kill -9 ${valgrind_pid}"
+vgdb_stop
diff --git a/gdb/testsuite/gdb.base/valgrind-infcall.exp b/gdb/testsuite/gdb.base/valgrind-infcall.exp
index 0a3774a..c25afc2 100644
--- a/gdb/testsuite/gdb.base/valgrind-infcall.exp
+++ b/gdb/testsuite/gdb.base/valgrind-infcall.exp
@@ -13,6 +13,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+load_lib valgrind.exp
+
 if [is_remote target] {
     # The test always runs locally.
     return 0
@@ -23,74 +25,9 @@ if {[build_executable $testfile.exp $testfile $srcfile {debug}] == -1} {
     return -1
 }
 
-set test "spawn valgrind"
-set cmd "valgrind --vgdb-error=0 $binfile"
-set res [remote_spawn host $cmd]
-if { $res < 0 || $res == "" } {
-    verbose -log "Spawning $cmd failed."
-    unsupported $test
+if { [vgdb_start] == -1 } {
     return -1
 }
-pass $test
-# Declare GDB now as running.
-set gdb_spawn_id $res
-
-# GDB started by vgdb stops already after the startup is executed, like with
-# non-extended gdbserver.  It is also not correct to run/attach the inferior.
-set use_gdb_stub 1
-
-set test "valgrind started"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "Memcheck, a memory error detector\\.?\r\n" {
-	pass $test
-    }
-    -re "valgrind: failed to start tool 'memcheck' for platform '.*': No such file or directory" {
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: wrong ELF executable class" {
-	unsupported $test
-	return -1
-    }
-    -re "command not found" {
-	# The spawn succeeded, but then valgrind was not found - e.g. if
-	# we spawned SSH to a remote system.
-	unsupported $test
-	return -1
-    }
-    -re "valgrind: Bad option.*--vgdb-error=0" {
-	# valgrind is not >= 3.7.0.
-	unsupported $test
-	return -1
-    }
-}
-
-set test "vgdb prompt"
-# The trailing '.' differs for different memcheck versions.
-gdb_test_multiple "" $test {
-    -re "  (target remote | \[^\r\n\]*/vgdb \[^\r\n\]*)\r\n" {
-	set vgdbcmd $expect_out(1,string)
-	pass $test
-    }
-}
-
-# Do not kill valgrind.
-set valgrind_spawn_id [board_info host fileid]
-unset gdb_spawn_id
-set board [host_info name]
-unset_board_info fileid
-
-clean_restart $testfile
-
-# Make sure we're disconnected, in case we're testing with the
-# native-extended-gdbserver board, where gdb_start/gdb_load spawn
-# gdbserver and connect to it.
-gdb_test "disconnect" ".*"
-
-gdb_test "$vgdbcmd" " in \\.?_start .*" "target remote for vgdb"
-
-gdb_test "monitor v.set gdb_output" "valgrind output will go to gdb.*"
 
 set continue_count 1
 set loop 1
@@ -130,5 +67,4 @@ gdb_test_multiple $test $test {
     }
 }
 
-# Only if valgrind got stuck.
-kill_wait_spawned_process $valgrind_spawn_id
+vgdb_stop
diff --git a/gdb/testsuite/lib/valgrind.exp b/gdb/testsuite/lib/valgrind.exp
new file mode 100644
index 0000000..2850ffa
--- /dev/null
+++ b/gdb/testsuite/lib/valgrind.exp
@@ -0,0 +1,105 @@
+# Copyright 2009-2018 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/>.
+
+# Generic subroutines for handling valgrind vgdb server.
+
+#
+# Start a vgdb server, and connect gdb to it.  Return 0 on success, and -1 on
+# error.
+#
+proc vgdb_start { } {
+    global binfile use_gdb_stub board testfile
+    global valgrind_spawn_id gdb_spawn_id
+
+    set test "spawn valgrind"
+    set cmd "valgrind --vgdb-error=0 $binfile"
+    set res [remote_spawn host $cmd]
+    if { $res < 0 || $res == "" } {
+	verbose -log "Spawning $cmd failed."
+	unsupported $test
+	return -1
+    }
+    pass $test
+    # Declare GDB now as running.
+    set gdb_spawn_id $res
+
+    # GDB started by vgdb stops already after the startup is executed, like with
+    # non-extended gdbserver.  It is also not correct to run/attach the inferior.
+    set use_gdb_stub 1
+
+    set test "valgrind started"
+    # The trailing '.' differs for different memcheck versions.
+    gdb_test_multiple "" $test {
+	-re "Memcheck, a memory error detector\\.?\r\n" {
+	    pass $test
+	}
+	-re "valgrind: failed to start tool 'memcheck' for platform '.*': No such file or directory" {
+	    unsupported $test
+	    return -1
+	}
+	-re "valgrind: wrong ELF executable class" {
+	    unsupported $test
+	    return -1
+	}
+	-re "command not found" {
+	    # The spawn succeeded, but then valgrind was not found - e.g. if
+	    # we spawned SSH to a remote system.
+	    unsupported $test
+	    return -1
+	}
+	-re "valgrind: Bad option.*--vgdb-error=0" {
+	    # valgrind is not >= 3.7.0.
+	    unsupported $test
+	    return -1
+	}
+    }
+
+    set test "vgdb prompt"
+    gdb_test_multiple "" $test {
+	-re "  (target remote | \[^\r\n\]*/vgdb \[^\r\n\]*)\r\n" {
+	    set vgdbcmd $expect_out(1,string)
+	    pass $test
+	}
+    }
+
+    # Do not kill valgrind.
+    set valgrind_spawn_id [board_info host fileid]
+    unset gdb_spawn_id
+    set board [host_info name]
+    unset_board_info fileid
+
+    clean_restart $testfile
+
+    # Make sure we're disconnected, in case we're testing with the
+    # native-extended-gdbserver board, where gdb_start/gdb_load spawn
+    # gdbserver and connect to it.
+    gdb_test "disconnect" ".*"
+
+    gdb_test "$vgdbcmd" " in \\.?_start .*" "target remote for vgdb"
+
+    gdb_test "monitor v.set gdb_output" "valgrind output will go to gdb.*"
+
+    return 0
+}
+
+#
+# Stop vgdb server.
+#
+proc vgdb_stop { } {
+    global valgrind_spawn_id
+
+    # Only if valgrind got stuck.
+    kill_wait_spawned_process $valgrind_spawn_id
+}