]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/testsuite/lib/gdbserver-support.exp
Update years in copyright notice for the GDB files.
[thirdparty/binutils-gdb.git] / gdb / testsuite / lib / gdbserver-support.exp
index 71535d0085787bd615a857ed6d039eedb368c14a..79ecc5a547e53a20e61b8df4691f41eb433b5fcb 100644 (file)
@@ -1,18 +1,17 @@
-# Copyright 2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+# Copyright 2000-2013 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 2 of the License, or
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 # This file is based on config/gdbserver.exp, which was written by
 # Michael Snyder (msnyder@redhat.com).
@@ -22,6 +21,8 @@
 #
 #   set_board_info gdb_protocol "remote"
 #      Unles you have a gdbserver that uses a different protocol...
+#      After GDB starts you should check global $gdbserver_protocol instead as
+#      the testfile may force a specific different target protocol itself.
 #
 #   set_board_info gdb_server_prog
 #      This will be the path to the gdbserver program you want to test.
@@ -35,6 +36,8 @@
 #   set_board_info gdb,socketport
 #      Port id to use for socket connection.  If not set explicitly,
 #      it will start at "2345" and increment for each use.
+#      After GDB starts you should check global $gdbserver_gdbport for the
+#      real port used.  It is not useful if $gdbserver_reconnect_p was not set.
 #
 
 #
@@ -44,6 +47,7 @@
 proc gdb_target_cmd { targetname serialport } {
     global gdb_prompt
 
+    set serialport_re [string_to_regexp $serialport]
     for {set i 1} {$i <= 3} {incr i} {
        send_gdb "target $targetname $serialport\n"
        gdb_expect 60 {
@@ -51,34 +55,46 @@ proc gdb_target_cmd { targetname serialport } {
                send_gdb "y\n"
                exp_continue
            }
-           -re "Couldn't establish connection to remote.*$gdb_prompt" {
+           -re "unknown host.*$gdb_prompt" {
+               verbose "Couldn't look up $serialport"
+           }
+           -re "Couldn't establish connection to remote.*$gdb_prompt $" {
                verbose "Connection failed"
            }
            -re "Remote MIPS debugging.*$gdb_prompt" {
                verbose "Set target to $targetname"
                return 0
            }
-           -re "Remote debugging using .*$serialport.*$gdb_prompt" {
+           -re "Remote debugging using .*$serialport_re.*$gdb_prompt $" {
+               verbose "Set target to $targetname"
+               return 0
+           }
+           -re "Remote debugging using stdio.*$gdb_prompt $" {
                verbose "Set target to $targetname"
                return 0
            }
-           -re "Remote target $targetname connected to.*$gdb_prompt" {
+           -re "Remote target $targetname connected to.*$gdb_prompt $" {
                verbose "Set target to $targetname"
                return 0
            }
-           -re "Connected to.*$gdb_prompt" { 
+           -re "Connected to.*$gdb_prompt $" { 
                verbose "Set target to $targetname"
                return 0
            }
-           -re "Ending remote.*$gdb_prompt" { }
-           -re "Connection refused.*$gdb_prompt" {
+           -re "Ending remote.*$gdb_prompt $" { }
+           -re "Connection refused.*$gdb_prompt $" {
                verbose "Connection refused by remote target.  Pausing, and trying again."
                sleep 30
                continue
            }
-           -re "Timeout reading from remote system.*$gdb_prompt" {
+           -re "Timeout reading from remote system.*$gdb_prompt $" {
                verbose "Got timeout error from gdb."
            }
+           -notransfer -re "Remote debugging using .*\r\n> $" {
+               # We got an unexpected prompt while creating the target.
+               # Leave it there for the test to diagnose.
+               return 1
+           }
            timeout {
                send_gdb "\ 3"
                break
@@ -96,6 +112,11 @@ set portnum "2345"
 
 proc find_gdbserver { } {
   global GDB
+  global GDBSERVER
+
+  if [info exists GDBSERVER] {
+    return ${GDBSERVER}
+  }
 
   if [target_info exists gdb_server_prog] {
     return [target_info gdb_server_prog]
@@ -123,12 +144,60 @@ proc skip_gdbserver_tests { } {
   return 0
 }
 
-# Start a gdbserver process running SERVER_EXEC, and connect GDB
-# to it.  CHILD_ARGS are passed to the inferior.
+# Download the currently loaded program to the target if necessary.
+# Return the target system filename.
+# NOTE: This was named "gdbserver_download", but that collides with the
+# dejagnu "download" API function when using load_generic_config "gdbserver".
+
+proc gdbserver_download_current_prog { } {
+    global gdbserver_host_exec
+    global gdbserver_host_mtime
+    global gdbserver_server_exec
+    global last_loaded_file
+
+    set host_exec $last_loaded_file
+
+    # If we already downloaded a file to the target, see if we can reuse it.
+    set reuse 0
+    if { [info exists gdbserver_server_exec] } {
+       set reuse 1
+
+       # If the file has changed, we can not.
+       if { $host_exec != $gdbserver_host_exec } {
+           set reuse 0
+       }
+
+       # If the mtime has changed, we can not.
+       if { [file mtime $host_exec] != $gdbserver_host_mtime } {
+           set reuse 0
+       }
+    }
+
+    if { $reuse == 0 } {
+       set gdbserver_host_exec $host_exec
+       set gdbserver_host_mtime [file mtime $host_exec]
+       if [is_remote target] {
+           set gdbserver_server_exec [gdb_download $host_exec]
+       } else {
+           set gdbserver_server_exec $host_exec
+       }
+    }
+
+    return $gdbserver_server_exec
+}
+
+# Default routine to compute the argument to "target remote".
+
+proc gdbserver_default_get_remote_address { host port } {
+    return "$host$port"
+}
+
+# Start a gdbserver process with initial OPTIONS and trailing ARGUMENTS.
+# The port will be filled in between them automatically.
 #
 # Returns the target protocol and socket to connect to.
 
-proc gdbserver_spawn { server_exec child_args } {
+proc gdbserver_start { options arguments } {
     global portnum
 
     # Port id -- either specified in baseboard file, or managed here.
@@ -141,11 +210,20 @@ proc gdbserver_spawn { server_exec child_args } {
 
     # Extract the local and remote host ids from the target board struct.
     if [target_info exists sockethost] {
-       set debughost  [target_info sockethost]
+       set debughost [target_info sockethost]
     } else {
        set debughost "localhost:"
     }
 
+    # Some boards use a different value for the port that is passed to
+    # gdbserver and the port that is passed to the "target remote" command.
+    # One example is the stdio gdbserver support.
+    if [target_info exists gdb,get_remote_address] {
+       set get_remote_address [target_info gdb,get_remote_address]
+    } else {
+       set get_remote_address gdbserver_default_get_remote_address
+    }
+
     # Extract the protocol
     if [target_info exists gdb_protocol] {
        set protocol [target_info gdb_protocol]
@@ -155,26 +233,48 @@ proc gdbserver_spawn { server_exec child_args } {
 
     set gdbserver [find_gdbserver]
 
-    # Export the host:port pair.
-    set gdbport $debughost$portnum
-
-    # Fire off the debug agent.  This flavour of gdbserver takes as
-    # arguments the port information, the name of the executable file to
-    # be debugged, and any arguments.
-    set gdbserver_command "$gdbserver :$portnum $server_exec"
-    if { $child_args != "" } {
-       append gdbserver_command " $child_args"
-    }
+    # Loop till we find a free port.
+    while 1 {
+       # Fire off the debug agent.
+       set gdbserver_command "$gdbserver"
+
+       # If gdbserver_reconnect will be called $gdbserver_reconnect_p must be
+       # set to true already during gdbserver_start.
+       global gdbserver_reconnect_p
+       if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} {
+           # GDB client could accidentally connect to a stale server.
+           # append gdbserver_command " --debug --once"
+           append gdbserver_command " --once"
+       }
 
-    set server_spawn_id [remote_spawn target $gdbserver_command]
+       if { $options != "" } {
+           append gdbserver_command " $options"
+       }
+       if { $portnum != "" } {
+           append gdbserver_command " :$portnum"
+       }
+       if { $arguments != "" } {
+           append gdbserver_command " $arguments"
+       }
 
-    # Wait for the server to produce at least one line and an additional
-    # character of output.  This will wait until any TCP socket has been
-    # created, so that GDB can connect.
-    expect {
-       -i $server_spawn_id
-       -notransfer
-       -re ".*\n." { }
+       set server_spawn_id [remote_spawn target $gdbserver_command]
+
+       # Wait for the server to open its TCP socket, so that GDB can connect.
+       expect {
+           -i $server_spawn_id
+           -notransfer
+           -re "Listening on" { }
+           -re "Can't bind address: Address already in use\\.\r\n" {
+               verbose -log "Port $portnum is already in use."
+               if ![target_info exists gdb,socketport] {
+                   # Bump the port number to avoid the conflict.
+                   wait -i $expect_out(spawn_id)
+                   incr portnum
+                   continue
+               }
+           }
+       }
+       break
     }
 
     # We can't just call close, because if gdbserver is local then that means
@@ -183,68 +283,126 @@ proc gdbserver_spawn { server_exec child_args } {
     # don't need to redirect output.
     expect_background {
        -i $server_spawn_id
-       -re "." { }
+       full_buffer { }
        eof {
            # The spawn ID is already closed now (but not yet waited for).
            wait -i $expect_out(spawn_id)
        }
     }
 
-    return [list $protocol $gdbport]
+    return [list $protocol [$get_remote_address $debughost $portnum]]
 }
 
-proc infer_host_exec { } {
-    set host_exec ""
+# Start a gdbserver process running SERVER_EXEC, and connect GDB
+# to it.  CHILD_ARGS are passed to the inferior.
+#
+# Returns the target protocol and socket to connect to.
+
+proc gdbserver_spawn { child_args } {
+    set target_exec [gdbserver_download_current_prog]
 
-    send_gdb "info files\n"
-    gdb_expect 30 {
-       -re "Symbols from \"(\[^\"\]+)\"" {
-           set host_exec $expect_out(1,string)
+    # Fire off the debug agent.  This flavour of gdbserver takes as
+    # arguments the port information, the name of the executable file to
+    # be debugged, and any arguments.
+    set arguments "$target_exec"
+    if { $child_args != "" } {
+       append arguments " $child_args"
+    }
+    return [gdbserver_start "" $arguments]
+}
+
+# Start a gdbserver process running HOST_EXEC and pass CHILD_ARGS
+# to it.  Return 0 on success, or non-zero on failure.
+
+proc gdbserver_run { child_args } {
+    global gdbserver_protocol
+    global gdbserver_gdbport
+
+    # Kill anything running before we try to start gdbserver, in case
+    # we are sharing a serial connection.
+    global gdb_prompt
+    send_gdb "kill\n"
+    gdb_expect 120 {
+       -re "Kill the program being debugged. .y or n. $" {
+           send_gdb "y\n"
+           verbose "\t\tKilling previous program being debugged"
            exp_continue
        }
-       -re "Local exec file:\[\r\n\]+\[ \t\]*`(\[^'\]+)'," {
-           set host_exec $expect_out(1,string)
-           exp_continue
+       -re "$gdb_prompt $" {
+           # OK.
        }
-       -re "$gdb_prompt $" { }
     }
 
-    return $host_exec
-}
+    set res [gdbserver_spawn $child_args]
+    set gdbserver_protocol [lindex $res 0]
+    set gdbserver_gdbport [lindex $res 1]
 
-# Start a gdbserver process running HOST_EXEC and pass CHILD_ARGS
-# to it.  Return 0 on success, or non-zero on failure.
+    return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
+}
 
-proc gdbserver_load { host_exec child_args } {
-    global gdbserver_host_exec
-    global gdbserver_server_exec
+# Reconnect to the previous gdbserver session.
 
-    # If we weren't passed an explicit binary, try to reuse the current
-    # one.  If we were, be sure to redownload it.
+proc gdbserver_reconnect { } {
+    global gdbserver_protocol
+    global gdbserver_gdbport
 
-    if { $host_exec == "" && $gdbserver_host_exec == "" } {
-       set gdbserver_host_exec [infer_host_exec]
-    } elseif { $host_exec != "" } {
-       set gdbserver_host_exec $host_exec
-       if [info exists gdbserver_server_exec] { unset gdbserver_server_exec }
+    global gdbserver_reconnect_p;
+    if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} {
+       error "gdbserver_reconnect_p is not set before gdbserver_reconnect"
+       return 0
     }
 
-    if { ! [info exists gdbserver_server_exec] } {
-       if [is_remote target] {
-           set gdbserver_server_exec [remote_download target $host_exec /tmp/[file tail $gdbserver_host_exec].[pid]]
-       } else {
-           set gdbserver_server_exec $gdbserver_host_exec
-       }
+    return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
+}
+
+# Start and connect to a gdbserver in extended mode.  Note this frobs
+# $gdbserver_protocol, so should be used only from a board that
+# usually connects in target remote mode.
+proc gdbserver_start_extended { } {
+    global gdbserver_protocol
+    global gdbserver_gdbport
+    global use_gdb_stub
+
+    set res [gdbserver_start "--multi" ""]
+    set gdbserver_protocol [lindex $res 0]
+    if { [string first "extended-" $gdbserver_protocol] != 0} {
+       set gdbserver_protocol "extended-$gdbserver_protocol"
     }
+    set gdbserver_gdbport [lindex $res 1]
 
-    set res [gdbserver_spawn $gdbserver_server_exec $child_args]
-    set protocol [lindex $res 0]
-    set gdbport [lindex $res 1]
+    # Even if the board file is testing with target remote, our caller
+    # wants to test against gdbserver in extended-remote mode.  Make sure to
+    # disable stub-like techniques.
+    set use_gdb_stub 0
 
-    if { $host_exec != "" } {
-       if [gdb_file_cmd $host_exec] {
-           return -1
-       }
-    }
-    gdb_target_cmd $protocol $gdbport
+    return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
+}
+
+# Start and connect to a gdbserver in extended/multi mode.  Unlike
+# gdbserver_start_extended, this does not frob $gdbserver_protocol.
+
+proc gdbserver_start_multi { } {
+    global gdbserver_protocol
+    global gdbserver_gdbport
+
+    set res [gdbserver_start "--multi" ""]
+    set gdbserver_protocol [lindex $res 0]
+    set gdbserver_gdbport [lindex $res 1]
+
+    return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
+}
+
+# Start a gdbserver process in multi/extended mode, and have GDB
+# connect to it (MI version).  Return 0 on success, or non-zero on
+# failure.
+
+proc mi_gdbserver_start_multi { } {
+    global gdbserver_protocol
+    global gdbserver_gdbport
+
+    set res [gdbserver_start "--multi" ""]
+    set gdbserver_protocol [lindex $res 0]
+    set gdbserver_gdbport [lindex $res 1]
+
+    return [mi_gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
 }