1 # Copyright (C) 1999, 2000 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 2 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, write to the Free Software
15 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 # Please email any bugs, comments, and/or additions to this file to:
18 # bug-gdb@prep.ai.mit.edu
20 # This file was based on a file written by Fred Fish. (fnf@cygnus.com)
22 # Test setup routines that work with the MI interpreter.
24 # The variable mi_gdb_prompt is a regexp which matches the gdb mi prompt.
25 # Set it if it is not already set.
27 if ![info exists mi_gdb_prompt] then {
28 set mi_gdb_prompt "\[(\]gdb\[)\] \r\n"
34 # mi_gdb_exit -- exit the GDB, killing the target program if necessary
37 catch mi_uncatched_gdb_exit
40 proc mi_uncatched_gdb_exit {} {
49 gdb_stop_suppressing_tests;
51 if { [info procs sid_exit] != "" } {
55 if ![info exists gdb_spawn_id] {
59 verbose "Quitting $GDB $GDBFLAGS $MIFLAGS"
61 if { [is_remote host] && [board_info host exists fileid] } {
62 send_gdb "999-gdb-exit\n";
68 -re "Undefined command.*$gdb_prompt $" {
72 -re "DOSEXIT code" { }
77 if ![is_remote host] {
84 # start gdb -- start gdb running, default procedure
86 # When running over NFS, particularly if running many simultaneous
87 # tests on different hosts all using the same server, things can
88 # get really slow. Give gdb at least 3 minutes to start up.
90 proc mi_gdb_start { } {
100 gdb_stop_suppressing_tests;
102 verbose "Spawning $GDB -nw $GDBFLAGS $MIFLAGS"
104 if [info exists gdb_spawn_id] {
108 if ![is_remote host] {
109 if { [which $GDB] == 0 } then {
110 perror "$GDB does not exist."
114 set res [remote_spawn host "$GDB -nw $GDBFLAGS $MIFLAGS [host_info gdb_opts]"];
115 if { $res < 0 || $res == "" } {
116 perror "Spawning $GDB failed."
120 -re ".*MI_OUT.*$mi_gdb_prompt$" {
121 verbose "GDB initialized."
123 -re ".*$mi_gdb_prompt$" {
124 untested "Skip mi tests (output not in headless format)."
128 -re ".*$gdb_prompt $" {
129 untested "Skip mi tests (got non-mi prompt)."
133 -re ".*unrecognized option.*for a complete list of options." {
134 untested "Skip mi tests (not compiled with mi support)."
138 -re ".*Interpreter `mi' unrecognized." {
139 untested "Skip mi tests (not compiled with mi support)."
144 perror "(timeout) GDB never initialized after 10 seconds."
151 # FIXME: mi output does not go through pagers, so these can be removed.
152 # force the height to "unlimited", so no pagers get used
153 send_gdb "100-gdb-set height 0\n"
155 -re ".*100-gdb-set height 0\r\n100\\\^done\r\n$mi_gdb_prompt$" {
156 verbose "Setting height to 0." 2
159 warning "Couldn't set the height to 0"
162 # force the width to "unlimited", so no wraparound occurs
163 send_gdb "101-gdb-set width 0\n"
165 -re ".*101-gdb-set width 0\r\n101\\\^done\r\n$mi_gdb_prompt$" {
166 verbose "Setting width to 0." 2
169 warning "Couldn't set the width to 0."
174 if { [info procs sid_start] != "" } {
175 verbose "Spawning SID"
182 # Many of the tests depend on setting breakpoints at various places and
183 # running until that breakpoint is reached. At times, we want to start
184 # with a clean-slate with respect to breakpoints, so this utility proc
185 # lets us do this without duplicating this code everywhere.
188 proc mi_delete_breakpoints {} {
191 # FIXME: The mi operation won't accept a prompt back and will use the 'all' arg
192 send_gdb "102-break-delete\n"
194 -re "Delete all breakpoints.*y or n.*$" {
198 -re ".*102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" {
199 # This happens if there were no breakpoints
201 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
204 # The correct output is not "No breakpoints or watchpoints." but an
205 # empty BreakpointTable. Also, a query is not acceptable with mi.
206 send_gdb "103-break-list\n"
208 -re "103-break-list\r\n103\\\^done,BreakpointTable=\{\}\r\n$mi_gdb_prompt$" {}
209 -re "103-break-list\r\n103\\\^doneNo breakpoints or watchpoints.\r\n\r\n$mi_gdb_prompt$" {warning "Unexpected console text received"}
210 -re "$mi_gdb_prompt$" { perror "Breakpoints not deleted" ; return }
211 -re "Delete all breakpoints.*or n.*$" {
212 warning "Unexpected prompt for breakpoints deletion";
216 timeout { perror "-break-list (timeout)" ; return }
220 proc mi_gdb_reinitialize_dir { subdir } {
224 if { $suppress_flag } {
228 if [is_remote host] {
232 send_gdb "104-environment-directory\n"
234 -re ".*Reinitialize source path to empty.*y or n. " {
235 warning "Got confirmation prompt for dir reinitialization."
238 -re "$mi_gdb_prompt$" {}
239 timeout {error "Dir reinitialization failed (timeout)"}
242 -re "$mi_gdb_prompt$" {}
243 timeout {error "Dir reinitialization failed (timeout)"}
246 send_gdb "105-environment-directory $subdir\n"
248 -re "Source directories searched.*$mi_gdb_prompt$" {
249 verbose "Dir set to $subdir"
251 -re "105\\\^done\r\n$mi_gdb_prompt$" {
252 # FIXME: We return just the prompt for now.
253 verbose "Dir set to $subdir"
254 # perror "Dir \"$subdir\" failed."
260 # load a file into the debugger.
261 # return a -1 if anything goes wrong.
263 proc mi_gdb_load { arg } {
269 upvar timeout timeout
274 # FIXME: Several of these patterns are only acceptable for console
275 # output. Queries are an error for mi.
276 send_gdb "105-file-exec-and-symbols $arg\n"
278 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
279 verbose "\t\tLoaded $arg into the $GDB"
282 -re "has no symbol-table.*$mi_gdb_prompt$" {
283 perror "$arg wasn't compiled with \"-g\""
286 -re "A program is being debugged already.*Kill it.*y or n. $" {
288 verbose "\t\tKilling previous program being debugged"
291 -re "Load new symbol table from \".*\".*y or n. $" {
294 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
295 verbose "\t\tLoaded $arg with new symbol table into $GDB"
299 perror "(timeout) Couldn't load $arg, other program already loaded."
304 -re "No such file or directory.*$mi_gdb_prompt$" {
305 perror "($arg) No such file or directory\n"
308 -re "105-file-exec-and-symbols .*\r\n105\\\^done\r\n$mi_gdb_prompt$" {
309 # We are just giving the prompt back for now
313 perror "couldn't load $arg into $GDB (timed out)."
317 # This is an attempt to detect a core dump, but seems not to
318 # work. Perhaps we need to match .* followed by eof, in which
319 # gdb_expect does not seem to have a way to do that.
320 perror "couldn't load $arg into $GDB (end of file)."
326 if { [info procs send_target_sid] != "" } {
327 # For SID, things get complex
330 -re "\\^done,.*$mi_gdb_prompt$" {
333 perror "Unable to connect to SID target"
337 send_gdb "48-target-download\n"
339 -re "48\\^done.*$mi_gdb_prompt$" {
342 perror "Unable to download to SID target"
346 } elseif { [target_info protocol] == "sim" } {
347 # For the simulator, just connect to it directly.
348 send_gdb "47-target-select sim\n"
350 -re "47\\^connected.*$mi_gdb_prompt$" {
353 perror "Unable to select sim target"
357 send_gdb "48-target-download\n"
359 -re "48\\^done.*$mi_gdb_prompt$" {
362 perror "Unable to download to sim target"
370 # mi_gdb_test COMMAND PATTERN MESSAGE -- send a command to gdb; test the result.
372 # COMMAND is the command to execute, send to GDB with send_gdb. If
373 # this is the null string no command is sent.
374 # PATTERN is the pattern to match for a PASS, and must NOT include
375 # the \r\n sequence immediately before the gdb prompt.
376 # MESSAGE is an optional message to be printed. If this is
377 # omitted, then the pass/fail messages use the command string as the
378 # message. (If this is the empty string, then sometimes we don't
379 # call pass or fail at all; I don't understand this at all.)
382 # 1 if the test failed,
383 # 0 if the test passes,
384 # -1 if there was an internal error.
386 proc mi_gdb_test { args } {
390 upvar timeout timeout
392 if [llength $args]>2 then {
393 set message [lindex $args 2]
395 set message [lindex $args 0]
397 set command [lindex $args 0]
398 set pattern [lindex $args 1]
400 if [llength $args]==5 {
401 set question_string [lindex $args 3];
402 set response_string [lindex $args 4];
404 set question_string "^FOOBAR$"
408 send_user "Sending \"$command\" to gdb\n"
409 send_user "Looking to match \"$pattern\"\n"
410 send_user "Message is \"$message\"\n"
414 set string "${command}\n";
415 if { $command != "" } {
416 while { "$string" != "" } {
417 set foo [string first "\n" "$string"];
418 set len [string length "$string"];
419 if { $foo < [expr $len - 1] } {
420 set str [string range "$string" 0 $foo];
421 if { [send_gdb "$str"] != "" } {
422 global suppress_flag;
424 if { ! $suppress_flag } {
425 perror "Couldn't send $command to GDB.";
434 set string [string range "$string" [expr $foo + 1] end];
439 if { "$string" != "" } {
440 if { [send_gdb "$string"] != "" } {
441 global suppress_flag;
443 if { ! $suppress_flag } {
444 perror "Couldn't send $command to GDB.";
452 if [info exists timeout] {
456 if [info exists timeout] {
463 -re "\\*\\*\\* DOSEXIT code.*" {
464 if { $message != "" } {
467 gdb_suppress_entire_file "GDB died";
470 -re "Ending remote debugging.*$mi_gdb_prompt\[ \]*$" {
471 if ![isnative] then {
472 warning "Can`t communicate to remote target."
478 -re "(${question_string})$" {
479 send_gdb "$response_string\n";
482 -re "Undefined.* command:.*$mi_gdb_prompt\[ \]*$" {
483 perror "Undefined command \"$command\"."
487 -re "Ambiguous command.*$mi_gdb_prompt\[ \]*$" {
488 perror "\"$command\" is not a unique command name."
492 -re "\[\r\n\]*($pattern)\[\r\n\]+$mi_gdb_prompt\[ \]*$" {
493 if ![string match "" $message] then {
498 -re "Program exited with code \[0-9\]+.*$mi_gdb_prompt\[ \]*$" {
499 if ![string match "" $message] then {
500 set errmsg "$message: the program exited"
502 set errmsg "$command: the program exited"
507 -re "The program is not being run.*$mi_gdb_prompt\[ \]*$" {
508 if ![string match "" $message] then {
509 set errmsg "$message: the program is no longer running"
511 set errmsg "$command: the program is no longer running"
516 -re ".*$mi_gdb_prompt\[ \]*$" {
517 if ![string match "" $message] then {
524 perror "Window too small."
527 -re "\\(y or n\\) " {
529 perror "Got interactive prompt."
533 perror "Process no longer exists"
534 if { $message != "" } {
540 perror "internal buffer is full."
544 if ![string match "" $message] then {
545 fail "$message (timeout)"
554 # MI run command. (A modified version of gdb_run_cmd)
557 # In patterns, the newline sequence ``\r\n'' is matched explicitly as
558 # ``.*$'' could swallow up output that we attempt to match elsewhere.
560 proc mi_run_cmd {args} {
562 if { $suppress_flag } {
567 if [target_info exists gdb_init_command] {
568 send_gdb "[target_info gdb_init_command]\n";
570 -re "$mi_gdb_prompt$" { }
572 perror "gdb_init_command for target failed";
578 if [target_info exists use_gdb_stub] {
579 if [target_info exists gdb,do_reload_on_run] {
580 # Specifying no file, defaults to the executable
581 # currently being debugged.
582 if { [mi_gdb_load ""] < 0 } {
585 send_gdb "000-exec-continue\n";
587 -re "Continu\[^\r\n\]*\[\r\n\]" {}
594 send_gdb "000-exec-run $args\n"
596 -re "000\\^running\r\n${mi_gdb_prompt}" {
599 perror "Unable to start target"
603 # NOTE: Shortly after this there will be a ``000*stopping,...(gdb)''
607 # Just like run-to-main but works with the MI interface
610 proc mi_run_to_main { } {
612 if { $suppress_flag } {
624 set test "mi run-to-main"
625 mi_delete_breakpoints
626 mi_gdb_reinitialize_dir $srcdir/$subdir
627 mi_gdb_load ${binfile}
629 mi_gdb_test "200-break-insert main" \
630 "200\\^done,bkpt=\{number=\"1\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"main\",file=\".*\",line=\"\[0-9\]*\",times=\"0\"\}" \
635 -re "000\\*stopped,reason=\"breakpoint-hit\",bkptno=\"1\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\"main\",args=\{\},file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" {
640 fail "$test (timeout)"
647 # Next to the next statement
649 proc mi_next { test } {
651 if { $suppress_flag } {
655 send_gdb "220-exec-next\n"
657 -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"end-stepping-range\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\".*\",args=\{.*\},,file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" {
669 # Step to the next statement
671 proc mi_step { test } {
673 if { $suppress_flag } {
677 send_gdb "220-exec-step\n"
679 -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"end-stepping-range\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\".*\",args=\{.*\},,file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" {
692 # change-log-default-name: "../gdb.mi/ChangeLog-mi"