1 # Copyright 2000-2016 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file is based on config/gdbserver.exp, which was written by
17 # Michael Snyder (msnyder@redhat.com).
20 # To be addressed or set in your baseboard config file:
22 # set_board_info gdb_protocol "remote"
23 # Unles you have a gdbserver that uses a different protocol...
24 # After GDB starts you should check global $gdbserver_protocol instead as
25 # the testfile may force a specific different target protocol itself.
27 # set_board_info gdb_server_prog
28 # This will be the path to the gdbserver program you want to test.
29 # Defaults to "gdbserver".
31 # set_board_info sockethost
32 # The name of the host computer whose socket is being used.
33 # Defaults to "localhost". Note: old gdbserver requires
34 # that you define this, but libremote/gdbserver does not.
36 # set_board_info gdb,socketport
37 # Port id to use for socket connection. If not set explicitly,
38 # it will start at "2345" and increment for each use.
39 # After GDB starts you should check global $gdbserver_gdbport for the
40 # real port used. It is not useful if $gdbserver_reconnect_p was not set.
45 # Send gdb the "target" command
47 proc gdb_target_cmd { targetname serialport } {
50 set serialport_re [string_to_regexp $serialport]
51 for {set i 1} {$i <= 3} {incr i} {
52 send_gdb "target $targetname $serialport\n"
54 -re "A program is being debugged already.*ill it.*y or n. $" {
58 -re "unknown host.*$gdb_prompt" {
59 verbose "Couldn't look up $serialport"
61 -re "Couldn't establish connection to remote.*$gdb_prompt $" {
62 verbose "Connection failed"
64 -re "Remote MIPS debugging.*$gdb_prompt" {
65 verbose "Set target to $targetname"
68 -re "Remote debugging using .*$serialport_re.*$gdb_prompt $" {
69 verbose "Set target to $targetname"
72 -re "Remote debugging using stdio.*$gdb_prompt $" {
73 verbose "Set target to $targetname"
76 -re "Remote target $targetname connected to.*$gdb_prompt $" {
77 verbose "Set target to $targetname"
80 -re "Connected to.*$gdb_prompt $" {
81 verbose "Set target to $targetname"
84 -re "Ending remote.*$gdb_prompt $" { }
85 -re "Connection refused.*$gdb_prompt $" {
86 verbose "Connection refused by remote target. Pausing, and trying again."
90 -re "Timeout reading from remote system.*$gdb_prompt $" {
91 verbose "Got timeout error from gdb."
93 -notransfer -re "Remote debugging using .*\r\n> $" {
94 # We got an unexpected prompt while creating the target.
95 # Leave it there for the test to diagnose.
111 # Locate the gdbserver binary. Returns "" if gdbserver could not be found.
113 proc find_gdbserver { } {
117 if [info exists GDBSERVER] {
121 if [target_info exists gdb_server_prog] {
122 return [target_info gdb_server_prog]
125 set gdbserver "${GDB}server"
126 if { [file isdirectory $gdbserver] } {
127 append gdbserver "/gdbserver"
130 if { [file executable $gdbserver] } {
137 # Return non-zero if we should skip gdbserver-specific tests.
139 proc skip_gdbserver_tests { } {
140 if { [find_gdbserver] == "" } {
147 # Download the currently loaded program to the target if necessary.
148 # Return the target system filename.
149 # NOTE: This was named "gdbserver_download", but that collides with the
150 # dejagnu "download" API function when using load_generic_config "gdbserver".
152 proc gdbserver_download_current_prog { } {
153 global gdbserver_host_exec
154 global gdbserver_host_mtime
155 global gdbserver_server_exec
156 global last_loaded_file
158 set host_exec $last_loaded_file
160 # If we already downloaded a file to the target, see if we can reuse it.
162 if { [info exists gdbserver_server_exec] } {
165 # If the file has changed, we can not.
166 if { $host_exec != $gdbserver_host_exec } {
170 # If the mtime has changed, we can not.
171 if { [file mtime $host_exec] != $gdbserver_host_mtime } {
177 set gdbserver_host_exec $host_exec
178 set gdbserver_host_mtime [file mtime $host_exec]
179 set gdbserver_server_exec [gdb_remote_download target $host_exec]
182 return $gdbserver_server_exec
185 # Default routine to compute the argument to "target remote".
187 proc gdbserver_default_get_remote_address { host port } {
188 # Historically HOST included the trailing ":".
189 # To avoid breaking any board files out there we leave things alone.
193 # Default routine to compute the "comm" argument for gdbserver.
195 proc gdbserver_default_get_comm_port { port } {
199 # Start a gdbserver process with initial OPTIONS and trailing ARGUMENTS.
200 # The port will be filled in between them automatically.
202 # Returns the target protocol and socket to connect to.
204 proc gdbserver_start { options arguments } {
207 # Port id -- either specified in baseboard file, or managed here.
208 if [target_info exists gdb,socketport] {
209 set portnum [target_info gdb,socketport]
211 # Bump the port number to avoid conflicts with hung ports.
215 # Extract the local and remote host ids from the target board struct.
216 if [target_info exists sockethost] {
217 set debughost [target_info sockethost]
219 set debughost "localhost:"
222 # Some boards use a different value for the port that is passed to
223 # gdbserver and the port that is passed to the "target remote" command.
224 # One example is the stdio gdbserver support.
225 if [target_info exists gdb,get_remote_address] {
226 set get_remote_address [target_info gdb,get_remote_address]
228 set get_remote_address gdbserver_default_get_remote_address
230 if [target_info exists gdbserver,get_comm_port] {
231 set get_comm_port [target_info gdbserver,get_comm_port]
233 set get_comm_port gdbserver_default_get_comm_port
236 # Extract the protocol
237 if [target_info exists gdb_protocol] {
238 set protocol [target_info gdb_protocol]
240 set protocol "remote"
243 set gdbserver [find_gdbserver]
245 # Loop till we find a free port.
247 # Fire off the debug agent.
248 set gdbserver_command "$gdbserver"
250 # If gdbserver_reconnect will be called $gdbserver_reconnect_p must be
251 # set to true already during gdbserver_start.
252 global gdbserver_reconnect_p
253 if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} {
254 # GDB client could accidentally connect to a stale server.
255 # append gdbserver_command " --debug --once"
256 append gdbserver_command " --once"
259 if { $options != "" } {
260 append gdbserver_command " $options"
262 if { $portnum != "" } {
263 append gdbserver_command " [$get_comm_port $portnum]"
265 if { $arguments != "" } {
266 append gdbserver_command " $arguments"
269 global server_spawn_id
270 set server_spawn_id [remote_spawn target $gdbserver_command]
272 # GDBserver doesn't do inferior I/O through GDB. But we can
273 # talk to the program using GDBserver's tty instead.
274 global inferior_spawn_id
275 set inferior_spawn_id $server_spawn_id
277 # Wait for the server to open its TCP socket, so that GDB can connect.
282 -re "Listening on" { }
283 -re "Can't bind address: Address already in use\\.\r\n" {
284 verbose -log "Port $portnum is already in use."
285 if ![target_info exists gdb,socketport] {
286 # Bump the port number to avoid the conflict.
287 wait -i $expect_out(spawn_id)
293 error "Timeout waiting for gdbserver response."
299 return [list $protocol [$get_remote_address $debughost $portnum]]
302 # Start a gdbserver process running SERVER_EXEC, and connect GDB
303 # to it. CHILD_ARGS are passed to the inferior.
305 # Returns the target protocol and socket to connect to.
307 proc gdbserver_spawn { child_args } {
308 set target_exec [gdbserver_download_current_prog]
310 # Fire off the debug agent. This flavour of gdbserver takes as
311 # arguments the port information, the name of the executable file to
312 # be debugged, and any arguments.
313 set arguments "$target_exec"
314 if { $child_args != "" } {
315 append arguments " $child_args"
317 return [gdbserver_start "" $arguments]
320 # Close the GDBserver connection.
322 proc close_gdbserver {} {
323 global server_spawn_id inferior_spawn_id
325 # We can't just call close, because if gdbserver is local then that means
326 # that it will get a SIGHUP. Doing it this way could also allow us to
327 # get at the inferior's input or output if necessary, and means that we
328 # don't need to redirect output.
330 if {![info exists server_spawn_id]} {
334 verbose "Quitting GDBserver"
336 catch "close -i $server_spawn_id"
337 catch "wait -i $server_spawn_id"
338 unset server_spawn_id
339 unset inferior_spawn_id
342 # Hook into GDB exit, and close GDBserver.
344 if { [info procs gdbserver_gdb_exit] == "" } {
345 rename gdb_exit gdbserver_orig_gdb_exit
348 global gdb_spawn_id server_spawn_id inferior_spawn_id
350 global gdbserver_reconnect_p
352 # Leave GDBserver running if we're exiting GDB in order to
353 # reconnect to the same instance of GDBserver again.
354 if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p} {
355 gdbserver_orig_gdb_exit
359 if {[info exists gdb_spawn_id] && [info exists server_spawn_id]} {
360 # GDB may be terminated in an expected way or an unexpected way,
361 # but DejaGNU doesn't know that, so gdb_spawn_id isn't unset.
362 # Catch the exceptions.
364 send_gdb "monitor exit\n";
365 # We use expect rather than gdb_expect because
366 # we want to suppress printing exception messages, otherwise,
367 # remote_expect, invoked by gdb_expect, prints the exceptions.
369 -i "$gdb_spawn_id" -re "$gdb_prompt $" {
372 -i "$server_spawn_id" eof {
373 wait -i $expect_out(spawn_id)
374 unset server_spawn_id
375 unset inferior_spawn_id
382 gdbserver_orig_gdb_exit
385 # Start a gdbserver process running HOST_EXEC and pass CHILD_ARGS
386 # to it. Return 0 on success, or non-zero on failure: 2 if gdbserver
387 # failed to start or 1 if we couldn't connect to it.
389 proc gdbserver_run { child_args } {
390 global gdbserver_protocol
391 global gdbserver_gdbport
393 # Kill anything running before we try to start gdbserver, in case
394 # we are sharing a serial connection.
398 -re "Kill the program being debugged. .y or n. $" {
400 verbose "\t\tKilling previous program being debugged"
403 -re "$gdb_prompt $" {
408 if { [catch { gdbserver_spawn $child_args } res] == 1 } {
412 set gdbserver_protocol [lindex $res 0]
413 set gdbserver_gdbport [lindex $res 1]
415 return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
418 # Reconnect to the previous gdbserver session.
420 proc gdbserver_reconnect { } {
421 global gdbserver_protocol
422 global gdbserver_gdbport
424 global gdbserver_reconnect_p
425 if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} {
426 error "gdbserver_reconnect_p is not set before gdbserver_reconnect"
430 return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
433 # Start gdbserver in extended mode with OPTIONS and connect to it. Note
434 # this frobs $gdbserver_protocol, so should be used only from a board
435 # that usually connects in target remote mode.
436 proc gdbserver_start_extended { {options ""} } {
437 global gdbserver_protocol
438 global gdbserver_gdbport
441 set gdbserver_options "--multi"
443 if { $options != "" } {
444 append gdbserver_options " $options"
447 if { [catch { gdbserver_start $gdbserver_options "" } res] == 1 } {
451 set gdbserver_protocol [lindex $res 0]
452 if { [string first "extended-" $gdbserver_protocol] != 0} {
453 set gdbserver_protocol "extended-$gdbserver_protocol"
455 set gdbserver_gdbport [lindex $res 1]
457 # Even if the board file is testing with target remote, our caller
458 # wants to test against gdbserver in extended-remote mode. Make sure to
459 # disable stub-like techniques.
462 return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
465 # Start and connect to a gdbserver in extended/multi mode. Unlike
466 # gdbserver_start_extended, this does not frob $gdbserver_protocol.
468 proc gdbserver_start_multi { } {
469 global gdbserver_protocol
470 global gdbserver_gdbport
472 if { [catch { gdbserver_start "--multi" "" } res] == 1 } {
476 set gdbserver_protocol [lindex $res 0]
477 set gdbserver_gdbport [lindex $res 1]
479 return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]
482 # Start a gdbserver process in multi/extended mode, and have GDB
483 # connect to it (MI version). Return 0 on success, or non-zero on
486 proc mi_gdbserver_start_multi { } {
487 global gdbserver_protocol
488 global gdbserver_gdbport
490 if { [catch { gdbserver_start "--multi" "" } res] == 1 } {
494 set gdbserver_protocol [lindex $res 0]
495 set gdbserver_gdbport [lindex $res 1]
497 return [mi_gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport]