Commit | Line | Data |
---|---|---|
32d0add0 | 1 | # Copyright 2000-2015 Free Software Foundation, Inc. |
6f8eac0e DJ |
2 | |
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 | |
e22f8b7c | 5 | # the Free Software Foundation; either version 3 of the License, or |
6f8eac0e | 6 | # (at your option) any later version. |
e22f8b7c | 7 | # |
6f8eac0e DJ |
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. | |
e22f8b7c | 12 | # |
6f8eac0e | 13 | # You should have received a copy of the GNU General Public License |
e22f8b7c | 14 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
6f8eac0e DJ |
15 | |
16 | # This file is based on config/gdbserver.exp, which was written by | |
17 | # Michael Snyder (msnyder@redhat.com). | |
18 | ||
19 | # | |
20 | # To be addressed or set in your baseboard config file: | |
21 | # | |
22 | # set_board_info gdb_protocol "remote" | |
23 | # Unles you have a gdbserver that uses a different protocol... | |
e11ac3a3 JK |
24 | # After GDB starts you should check global $gdbserver_protocol instead as |
25 | # the testfile may force a specific different target protocol itself. | |
6f8eac0e DJ |
26 | # |
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". | |
30 | # | |
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. | |
35 | # | |
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. | |
e11ac3a3 JK |
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. | |
6f8eac0e DJ |
41 | # |
42 | ||
43 | # | |
44 | # gdb_target_cmd | |
45 | # Send gdb the "target" command | |
46 | # | |
47 | proc gdb_target_cmd { targetname serialport } { | |
48 | global gdb_prompt | |
49 | ||
ef783a7d | 50 | set serialport_re [string_to_regexp $serialport] |
6f8eac0e DJ |
51 | for {set i 1} {$i <= 3} {incr i} { |
52 | send_gdb "target $targetname $serialport\n" | |
53 | gdb_expect 60 { | |
54 | -re "A program is being debugged already.*ill it.*y or n. $" { | |
55 | send_gdb "y\n" | |
56 | exp_continue | |
57 | } | |
401ea829 JB |
58 | -re "unknown host.*$gdb_prompt" { |
59 | verbose "Couldn't look up $serialport" | |
60 | } | |
2f83a18e | 61 | -re "Couldn't establish connection to remote.*$gdb_prompt $" { |
6f8eac0e DJ |
62 | verbose "Connection failed" |
63 | } | |
64 | -re "Remote MIPS debugging.*$gdb_prompt" { | |
65 | verbose "Set target to $targetname" | |
66 | return 0 | |
67 | } | |
ef783a7d | 68 | -re "Remote debugging using .*$serialport_re.*$gdb_prompt $" { |
6f8eac0e DJ |
69 | verbose "Set target to $targetname" |
70 | return 0 | |
71 | } | |
e0f9f062 DE |
72 | -re "Remote debugging using stdio.*$gdb_prompt $" { |
73 | verbose "Set target to $targetname" | |
74 | return 0 | |
75 | } | |
2f83a18e | 76 | -re "Remote target $targetname connected to.*$gdb_prompt $" { |
6f8eac0e DJ |
77 | verbose "Set target to $targetname" |
78 | return 0 | |
79 | } | |
2f83a18e | 80 | -re "Connected to.*$gdb_prompt $" { |
6f8eac0e DJ |
81 | verbose "Set target to $targetname" |
82 | return 0 | |
83 | } | |
2f83a18e DJ |
84 | -re "Ending remote.*$gdb_prompt $" { } |
85 | -re "Connection refused.*$gdb_prompt $" { | |
6f8eac0e DJ |
86 | verbose "Connection refused by remote target. Pausing, and trying again." |
87 | sleep 30 | |
88 | continue | |
89 | } | |
2f83a18e | 90 | -re "Timeout reading from remote system.*$gdb_prompt $" { |
6f8eac0e DJ |
91 | verbose "Got timeout error from gdb." |
92 | } | |
b741e217 DJ |
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. | |
96 | return 1 | |
97 | } | |
6f8eac0e DJ |
98 | timeout { |
99 | send_gdb "\ 3" | |
100 | break | |
101 | } | |
102 | } | |
103 | } | |
104 | return 1 | |
105 | } | |
106 | ||
107 | ||
108 | global portnum | |
109 | set portnum "2345" | |
110 | ||
111 | # Locate the gdbserver binary. Returns "" if gdbserver could not be found. | |
112 | ||
113 | proc find_gdbserver { } { | |
114 | global GDB | |
6fadd07a DE |
115 | global GDBSERVER |
116 | ||
117 | if [info exists GDBSERVER] { | |
118 | return ${GDBSERVER} | |
119 | } | |
6f8eac0e DJ |
120 | |
121 | if [target_info exists gdb_server_prog] { | |
122 | return [target_info gdb_server_prog] | |
123 | } | |
124 | ||
125 | set gdbserver "${GDB}server" | |
126 | if { [file isdirectory $gdbserver] } { | |
127 | append gdbserver "/gdbserver" | |
128 | } | |
129 | ||
130 | if { [file executable $gdbserver] } { | |
131 | return $gdbserver | |
132 | } | |
133 | ||
134 | return "" | |
135 | } | |
136 | ||
137 | # Return non-zero if we should skip gdbserver-specific tests. | |
138 | ||
139 | proc skip_gdbserver_tests { } { | |
140 | if { [find_gdbserver] == "" } { | |
141 | return 1 | |
142 | } | |
143 | ||
144 | return 0 | |
145 | } | |
146 | ||
2d717e4f DJ |
147 | # Download the currently loaded program to the target if necessary. |
148 | # Return the target system filename. | |
6496a609 DE |
149 | # NOTE: This was named "gdbserver_download", but that collides with the |
150 | # dejagnu "download" API function when using load_generic_config "gdbserver". | |
6f8eac0e | 151 | |
6496a609 | 152 | proc gdbserver_download_current_prog { } { |
b741e217 DJ |
153 | global gdbserver_host_exec |
154 | global gdbserver_host_mtime | |
155 | global gdbserver_server_exec | |
156 | global last_loaded_file | |
157 | ||
158 | set host_exec $last_loaded_file | |
159 | ||
160 | # If we already downloaded a file to the target, see if we can reuse it. | |
161 | set reuse 0 | |
162 | if { [info exists gdbserver_server_exec] } { | |
163 | set reuse 1 | |
164 | ||
165 | # If the file has changed, we can not. | |
166 | if { $host_exec != $gdbserver_host_exec } { | |
167 | set reuse 0 | |
168 | } | |
169 | ||
170 | # If the mtime has changed, we can not. | |
171 | if { [file mtime $host_exec] != $gdbserver_host_mtime } { | |
172 | set reuse 0 | |
173 | } | |
174 | } | |
175 | ||
176 | if { $reuse == 0 } { | |
177 | set gdbserver_host_exec $host_exec | |
178 | set gdbserver_host_mtime [file mtime $host_exec] | |
179 | if [is_remote target] { | |
93f02886 | 180 | set gdbserver_server_exec [gdb_download $host_exec] |
b741e217 DJ |
181 | } else { |
182 | set gdbserver_server_exec $host_exec | |
183 | } | |
184 | } | |
6f8eac0e | 185 | |
2d717e4f DJ |
186 | return $gdbserver_server_exec |
187 | } | |
188 | ||
e0f9f062 DE |
189 | # Default routine to compute the argument to "target remote". |
190 | ||
191 | proc gdbserver_default_get_remote_address { host port } { | |
ab19de87 DE |
192 | # Historically HOST included the trailing ":". |
193 | # To avoid breaking any board files out there we leave things alone. | |
e0f9f062 DE |
194 | return "$host$port" |
195 | } | |
196 | ||
ab19de87 DE |
197 | # Default routine to compute the "comm" argument for gdbserver. |
198 | ||
199 | proc gdbserver_default_get_comm_port { port } { | |
200 | return ":$port" | |
201 | } | |
202 | ||
2d717e4f DJ |
203 | # Start a gdbserver process with initial OPTIONS and trailing ARGUMENTS. |
204 | # The port will be filled in between them automatically. | |
205 | # | |
206 | # Returns the target protocol and socket to connect to. | |
207 | ||
208 | proc gdbserver_start { options arguments } { | |
209 | global portnum | |
210 | ||
6f8eac0e DJ |
211 | # Port id -- either specified in baseboard file, or managed here. |
212 | if [target_info exists gdb,socketport] { | |
213 | set portnum [target_info gdb,socketport] | |
214 | } else { | |
215 | # Bump the port number to avoid conflicts with hung ports. | |
216 | incr portnum | |
217 | } | |
218 | ||
219 | # Extract the local and remote host ids from the target board struct. | |
220 | if [target_info exists sockethost] { | |
2d717e4f | 221 | set debughost [target_info sockethost] |
6f8eac0e DJ |
222 | } else { |
223 | set debughost "localhost:" | |
224 | } | |
225 | ||
e0f9f062 DE |
226 | # Some boards use a different value for the port that is passed to |
227 | # gdbserver and the port that is passed to the "target remote" command. | |
228 | # One example is the stdio gdbserver support. | |
229 | if [target_info exists gdb,get_remote_address] { | |
230 | set get_remote_address [target_info gdb,get_remote_address] | |
231 | } else { | |
232 | set get_remote_address gdbserver_default_get_remote_address | |
233 | } | |
ab19de87 DE |
234 | if [target_info exists gdbserver,get_comm_port] { |
235 | set get_comm_port [target_info gdbserver,get_comm_port] | |
236 | } else { | |
237 | set get_comm_port gdbserver_default_get_comm_port | |
238 | } | |
e0f9f062 | 239 | |
6f8eac0e DJ |
240 | # Extract the protocol |
241 | if [target_info exists gdb_protocol] { | |
242 | set protocol [target_info gdb_protocol] | |
243 | } else { | |
244 | set protocol "remote" | |
245 | } | |
246 | ||
247 | set gdbserver [find_gdbserver] | |
248 | ||
047427a8 JK |
249 | # Loop till we find a free port. |
250 | while 1 { | |
047427a8 JK |
251 | # Fire off the debug agent. |
252 | set gdbserver_command "$gdbserver" | |
03f2bd59 JK |
253 | |
254 | # If gdbserver_reconnect will be called $gdbserver_reconnect_p must be | |
255 | # set to true already during gdbserver_start. | |
256 | global gdbserver_reconnect_p | |
257 | if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} { | |
258 | # GDB client could accidentally connect to a stale server. | |
f196051f | 259 | # append gdbserver_command " --debug --once" |
03f2bd59 JK |
260 | append gdbserver_command " --once" |
261 | } | |
262 | ||
047427a8 JK |
263 | if { $options != "" } { |
264 | append gdbserver_command " $options" | |
265 | } | |
e0f9f062 | 266 | if { $portnum != "" } { |
ab19de87 | 267 | append gdbserver_command " [$get_comm_port $portnum]" |
e0f9f062 | 268 | } |
047427a8 JK |
269 | if { $arguments != "" } { |
270 | append gdbserver_command " $arguments" | |
271 | } | |
6f8eac0e | 272 | |
6423214f | 273 | global server_spawn_id |
047427a8 JK |
274 | set server_spawn_id [remote_spawn target $gdbserver_command] |
275 | ||
f71c18e7 PA |
276 | # GDBserver doesn't do inferior I/O through GDB. But we can |
277 | # talk to the program using GDBserver's tty instead. | |
278 | global inferior_spawn_id | |
279 | set inferior_spawn_id $server_spawn_id | |
280 | ||
047427a8 JK |
281 | # Wait for the server to open its TCP socket, so that GDB can connect. |
282 | expect { | |
283 | -i $server_spawn_id | |
2bdd10b7 | 284 | -timeout 120 |
047427a8 JK |
285 | -notransfer |
286 | -re "Listening on" { } | |
287 | -re "Can't bind address: Address already in use\\.\r\n" { | |
288 | verbose -log "Port $portnum is already in use." | |
289 | if ![target_info exists gdb,socketport] { | |
290 | # Bump the port number to avoid the conflict. | |
291 | wait -i $expect_out(spawn_id) | |
292 | incr portnum | |
293 | continue | |
294 | } | |
295 | } | |
09635af7 MR |
296 | timeout { |
297 | error "Timeout waiting for gdbserver response." | |
298 | } | |
047427a8 JK |
299 | } |
300 | break | |
6f8eac0e DJ |
301 | } |
302 | ||
e0f9f062 | 303 | return [list $protocol [$get_remote_address $debughost $portnum]] |
6f8eac0e DJ |
304 | } |
305 | ||
2d717e4f DJ |
306 | # Start a gdbserver process running SERVER_EXEC, and connect GDB |
307 | # to it. CHILD_ARGS are passed to the inferior. | |
308 | # | |
309 | # Returns the target protocol and socket to connect to. | |
310 | ||
311 | proc gdbserver_spawn { child_args } { | |
6496a609 | 312 | set target_exec [gdbserver_download_current_prog] |
2d717e4f DJ |
313 | |
314 | # Fire off the debug agent. This flavour of gdbserver takes as | |
315 | # arguments the port information, the name of the executable file to | |
316 | # be debugged, and any arguments. | |
317 | set arguments "$target_exec" | |
318 | if { $child_args != "" } { | |
319 | append arguments " $child_args" | |
320 | } | |
321 | return [gdbserver_start "" $arguments] | |
322 | } | |
323 | ||
6423214f PA |
324 | # Close the GDBserver connection. |
325 | ||
326 | proc close_gdbserver {} { | |
f71c18e7 | 327 | global server_spawn_id inferior_spawn_id |
6423214f PA |
328 | |
329 | # We can't just call close, because if gdbserver is local then that means | |
330 | # that it will get a SIGHUP. Doing it this way could also allow us to | |
331 | # get at the inferior's input or output if necessary, and means that we | |
332 | # don't need to redirect output. | |
333 | ||
334 | if {![info exists server_spawn_id]} { | |
335 | return | |
336 | } | |
337 | ||
338 | verbose "Quitting GDBserver" | |
339 | ||
340 | catch "close -i $server_spawn_id" | |
341 | catch "wait -i $server_spawn_id" | |
342 | unset server_spawn_id | |
f71c18e7 | 343 | unset inferior_spawn_id |
6423214f PA |
344 | } |
345 | ||
346 | # Hook into GDB exit, and close GDBserver. | |
347 | ||
348 | if { [info procs gdbserver_gdb_exit] == "" } { | |
349 | rename gdb_exit gdbserver_orig_gdb_exit | |
350 | } | |
351 | proc gdb_exit {} { | |
f71c18e7 | 352 | global gdb_spawn_id server_spawn_id inferior_spawn_id |
6423214f | 353 | global gdb_prompt |
1ca99c42 PA |
354 | global gdbserver_reconnect_p |
355 | ||
356 | # Leave GDBserver running if we're exiting GDB in order to | |
357 | # reconnect to the same instance of GDBserver again. | |
358 | if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p} { | |
359 | gdbserver_orig_gdb_exit | |
360 | return | |
361 | } | |
6423214f PA |
362 | |
363 | if {[info exists gdb_spawn_id] && [info exists server_spawn_id]} { | |
2efe15c4 YQ |
364 | # GDB may be terminated in an expected way or an unexpected way, |
365 | # but DejaGNU doesn't know that, so gdb_spawn_id isn't unset. | |
366 | # Catch the exceptions. | |
367 | catch { | |
368 | send_gdb "monitor exit\n"; | |
369 | # We use expect rather than gdb_expect because | |
370 | # we want to suppress printing exception messages, otherwise, | |
371 | # remote_expect, invoked by gdb_expect, prints the exceptions. | |
372 | expect { | |
373 | -i "$gdb_spawn_id" -re "$gdb_prompt $" { | |
374 | exp_continue | |
375 | } | |
376 | -i "$server_spawn_id" eof { | |
377 | wait -i $expect_out(spawn_id) | |
378 | unset server_spawn_id | |
379 | unset inferior_spawn_id | |
380 | } | |
6423214f PA |
381 | } |
382 | } | |
383 | } | |
384 | close_gdbserver | |
385 | ||
386 | gdbserver_orig_gdb_exit | |
387 | } | |
388 | ||
6f8eac0e | 389 | # Start a gdbserver process running HOST_EXEC and pass CHILD_ARGS |
09635af7 MR |
390 | # to it. Return 0 on success, or non-zero on failure: 2 if gdbserver |
391 | # failed to start or 1 if we couldn't connect to it. | |
6f8eac0e | 392 | |
b741e217 | 393 | proc gdbserver_run { child_args } { |
b0f4b84b DJ |
394 | global gdbserver_protocol |
395 | global gdbserver_gdbport | |
396 | ||
2226f861 DJ |
397 | # Kill anything running before we try to start gdbserver, in case |
398 | # we are sharing a serial connection. | |
399 | global gdb_prompt | |
400 | send_gdb "kill\n" | |
401 | gdb_expect 120 { | |
402 | -re "Kill the program being debugged. .y or n. $" { | |
403 | send_gdb "y\n" | |
404 | verbose "\t\tKilling previous program being debugged" | |
405 | exp_continue | |
406 | } | |
407 | -re "$gdb_prompt $" { | |
408 | # OK. | |
409 | } | |
410 | } | |
411 | ||
09635af7 MR |
412 | if { [catch { gdbserver_spawn $child_args } res] == 1 } { |
413 | perror $res | |
414 | return 2 | |
415 | } | |
b0f4b84b DJ |
416 | set gdbserver_protocol [lindex $res 0] |
417 | set gdbserver_gdbport [lindex $res 1] | |
418 | ||
419 | return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport] | |
420 | } | |
421 | ||
422 | # Reconnect to the previous gdbserver session. | |
423 | ||
424 | proc gdbserver_reconnect { } { | |
425 | global gdbserver_protocol | |
426 | global gdbserver_gdbport | |
6f8eac0e | 427 | |
4ec70201 | 428 | global gdbserver_reconnect_p |
03f2bd59 JK |
429 | if {![info exists gdbserver_reconnect_p] || !$gdbserver_reconnect_p} { |
430 | error "gdbserver_reconnect_p is not set before gdbserver_reconnect" | |
431 | return 0 | |
432 | } | |
433 | ||
b0f4b84b | 434 | return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport] |
6f8eac0e | 435 | } |
2d717e4f | 436 | |
8cfe207c YQ |
437 | # Start gdbserver in extended mode with OPTIONS and connect to it. Note |
438 | # this frobs $gdbserver_protocol, so should be used only from a board | |
439 | # that usually connects in target remote mode. | |
440 | proc gdbserver_start_extended { {options ""} } { | |
e11ac3a3 JK |
441 | global gdbserver_protocol |
442 | global gdbserver_gdbport | |
443 | global use_gdb_stub | |
444 | ||
8cfe207c YQ |
445 | set gdbserver_options "--multi" |
446 | ||
447 | if { $options != "" } { | |
448 | append gdbserver_options " $options" | |
449 | } | |
450 | ||
451 | if { [catch { gdbserver_start $gdbserver_options "" } res] == 1 } { | |
09635af7 MR |
452 | perror $res |
453 | return 2 | |
454 | } | |
a1999d40 PA |
455 | set gdbserver_protocol [lindex $res 0] |
456 | if { [string first "extended-" $gdbserver_protocol] != 0} { | |
457 | set gdbserver_protocol "extended-$gdbserver_protocol" | |
458 | } | |
2d717e4f DJ |
459 | set gdbserver_gdbport [lindex $res 1] |
460 | ||
e11ac3a3 JK |
461 | # Even if the board file is testing with target remote, our caller |
462 | # wants to test against gdbserver in extended-remote mode. Make sure to | |
463 | # disable stub-like techniques. | |
464 | set use_gdb_stub 0 | |
465 | ||
2d717e4f DJ |
466 | return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport] |
467 | } | |
048fe15a PA |
468 | |
469 | # Start and connect to a gdbserver in extended/multi mode. Unlike | |
470 | # gdbserver_start_extended, this does not frob $gdbserver_protocol. | |
471 | ||
472 | proc gdbserver_start_multi { } { | |
473 | global gdbserver_protocol | |
474 | global gdbserver_gdbport | |
475 | ||
09635af7 MR |
476 | if { [catch { gdbserver_start "--multi" "" } res] == 1 } { |
477 | perror $res | |
478 | return 2 | |
479 | } | |
048fe15a PA |
480 | set gdbserver_protocol [lindex $res 0] |
481 | set gdbserver_gdbport [lindex $res 1] | |
482 | ||
483 | return [gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport] | |
484 | } | |
485 | ||
486 | # Start a gdbserver process in multi/extended mode, and have GDB | |
487 | # connect to it (MI version). Return 0 on success, or non-zero on | |
488 | # failure. | |
489 | ||
490 | proc mi_gdbserver_start_multi { } { | |
491 | global gdbserver_protocol | |
492 | global gdbserver_gdbport | |
493 | ||
09635af7 MR |
494 | if { [catch { gdbserver_start "--multi" "" } res] == 1 } { |
495 | perror $res | |
496 | return 2 | |
497 | } | |
048fe15a PA |
498 | set gdbserver_protocol [lindex $res 0] |
499 | set gdbserver_gdbport [lindex $res 1] | |
500 | ||
501 | return [mi_gdb_target_cmd $gdbserver_protocol $gdbserver_gdbport] | |
502 | } |