1 # Copyright (C) 1992, 1994, 1995, 1997 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 written by Fred Fish. (fnf@cygnus.com)
22 # Generic gdb subroutines that should work for any target. If these
23 # need to be modified for any target, it can be done with a variable
24 # or by passing arguments.
32 if ![info exists CHILL_LIB] {
33 set CHILL_LIB [findfile $base_dir/../../gcc/ch/runtime/libchill.a "$base_dir/../../gcc/ch/runtime/libchill.a" [transform -lchill]]
35 verbose "using CHILL_LIB = $CHILL_LIB" 2
36 if ![info exists CHILL_RT0] {
37 set CHILL_RT0 [findfile $base_dir/../../gcc/ch/runtime/chillrt0.o "$base_dir/../../gcc/ch/runtime/chillrt0.o" ""]
39 verbose "using CHILL_RT0 = $CHILL_RT0" 2
41 if ![info exists GDB] {
42 if ![is_remote host] {
43 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
45 set GDB [transform gdb];
48 verbose "using GDB = $GDB" 2
51 if ![info exists GDBFLAGS] {
54 verbose "using GDBFLAGS = $GDBFLAGS" 2
56 # The variable prompt is a regexp which matches the gdb prompt. Set it if it
59 if ![info exists prompt] then {
60 set gdb_prompt "\[(\]gdb\[)\]"
64 # gdb_version -- extract and print the version number of GDB
66 proc default_gdb_version {} {
70 set fileid [open "gdb_cmd" w];
73 set cmdfile [remote_download host "gdb_cmd"];
74 set output [remote_exec host "$GDB -nw --command $cmdfile"]
75 remote_file build delete "gdb_cmd";
76 remote_file host delete "$cmdfile";
77 set tmp [lindex $output 1];
79 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
80 if ![is_remote host] {
81 clone_output "[which $GDB] version $version $GDBFLAGS\n"
83 clone_output "$GDB on remote host version $version $GDBFLAGS\n"
87 proc gdb_version { } {
88 return [default_gdb_version];
92 # gdb_unload -- unload a file if one is loaded
101 -re "No exec file now\[^\r\n\]*\[\r\n\]" { exp_continue }
102 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
103 -re "A program is being debugged already..*Kill it.*y or n. $"\
105 verbose "\t\tKilling previous program being debugged"
108 -re "Discard symbol table from .*y or n.*$" {
112 -re "$gdb_prompt $" {}
114 perror "couldn't unload file in $GDB (timed out)."
120 # Many of the tests depend on setting breakpoints at various places and
121 # running until that breakpoint is reached. At times, we want to start
122 # with a clean-slate with respect to breakpoints, so this utility proc
123 # lets us do this without duplicating this code everywhere.
126 proc delete_breakpoints {} {
129 send_gdb "delete breakpoints\n"
131 -re "Delete all breakpoints.*y or n.*$" {
135 -re "$gdb_prompt $" { # This happens if there were no breakpoints
137 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
139 send_gdb "info breakpoints\n"
141 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
142 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
143 -re "Delete all breakpoints.*or n.*$" {
147 timeout { perror "info breakpoints (timeout)" ; return }
153 # Generic run command.
155 # The second pattern below matches up to the first newline *only*.
156 # Using ``.*$'' could swallow up output that we attempt to match
159 proc gdb_run_cmd {args} {
162 if [target_info exists gdb_init_command] {
163 send_gdb "[target_info gdb_init_command]\n";
165 -re "$gdb_prompt $" { }
167 perror "gdb_init_command for target failed";
173 if [target_info exists use_gdb_stub] {
174 if [target_info exists gdb,start_symbol] {
175 set start [target_info gdb,start_symbol];
179 send_gdb "jump *$start\n"
181 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
182 if ![target_info exists gdb_stub] {
186 -re "No symbol \"start\" in current.*$gdb_prompt $" {
187 send_gdb "jump *_start\n";
190 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
191 perror "Can't find start symbol to run in gdb_run";
194 -re "Line.* Jump anyway.*y or n. $" {
198 -re "No symbol.*context.*$gdb_prompt $" {}
199 -re "The program is not being run.*$gdb_prompt $" {
201 send_gdb "jump *$start\n";
204 timeout { perror "Jump to start() failed (timeout)"; return }
206 if [target_info exists gdb_stub] {
208 -re "$gdb_prompt $" {
209 send_gdb "continue\n"
215 send_gdb "run $args\n"
216 # This doesn't work quite right yet.
218 -re "The program .* has been started already.*y or n. $" {
222 -re "Starting program: \[^\r\n\]*" {}
226 proc gdb_breakpoint { function } {
230 send_gdb "break $function\n"
231 # The first two regexps are what we get with -g, the third is without -g.
233 -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
234 -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
235 -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
236 -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
237 timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
242 # Set breakpoint at function and run gdb until it breaks there.
243 # Since this is the only breakpoint that will be set, if it stops
244 # at a breakpoint, we will assume it is the one we want. We can't
245 # just compare to "function" because it might be a fully qualified,
246 # single quoted C++ function specifier.
248 proc runto { function } {
254 if ![gdb_breakpoint $function] {
260 # the "at foo.c:36" output we get with -g.
261 # the "in func" output we get without -g.
263 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
266 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
269 -re "$gdb_prompt $" {
270 fail "running to $function in runto"
274 fail "running to $function in runto (timeout)"
282 # runto_main -- ask gdb to run until we hit a breakpoint at main.
283 # The case where the target uses stubs has to be handled
284 # specially--if it uses stubs, assuming we hit
285 # breakpoint() and just step out of the function.
291 if ![target_info exists gdb_stub] {
298 # if use stubs step out of the breakpoint() function.
300 -re "main.* at .*$gdb_prompt $" {}
301 -re "_start.*$gdb_prompt $" {}
302 timeout { fail "single step at breakpoint() (timeout)" ; return 0 }
308 # gdb_test -- send_gdb a command to gdb and test the result.
309 # Takes three parameters.
311 # First one is the command to execute. If this is the null string
312 # then no command is sent.
313 # Second one is the pattern to match for a PASS, and must NOT include
314 # the \r\n sequence immediately before the gdb prompt.
315 # Third one is an optional message to be printed. If this
316 # a null string "", then the pass/fail messages use the command
317 # string as the message.
319 # 1 if the test failed,
320 # 0 if the test passes,
321 # -1 if there was an internal error.
323 proc gdb_test { args } {
328 upvar timeout timeout
330 if [llength $args]>2 then {
331 set message [lindex $args 2]
333 set message [lindex $args 0]
335 set command [lindex $args 0]
336 set pattern [lindex $args 1]
338 if [llength $args]==5 {
339 set question_string [lindex $args 3];
340 set response_string [lindex $args 4];
342 set question_string "^FOOBAR$"
346 send_user "Sending \"$command\" to gdb\n"
347 send_user "Looking to match \"$pattern\"\n"
348 send_user "Message is \"$message\"\n"
352 if ![string match $command ""] {
353 if { [send_gdb "$command\n"] != "" } {
354 global suppress_flag;
356 if { ! $suppress_flag } {
357 perror "Couldn't send $command to GDB.";
365 -re "Ending remote debugging.*$gdb_prompt$" {
366 if ![isnative] then {
367 warning "Can`t communicate to remote target."
373 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
374 if ![string match "" $message] then {
379 -re "(${question_string})$" {
380 send_gdb "$response_string\n";
383 -re "Undefined command:.*$gdb_prompt" {
384 perror "Undefined command \"$command\"."
387 -re "Ambiguous command.*$gdb_prompt $" {
388 perror "\"$command\" is not a unique command name."
391 -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
392 if ![string match "" $message] then {
393 set errmsg "$message: the program exited"
395 set errmsg "$command: the program exited"
400 -re "The program is not being run.*$gdb_prompt $" {
401 if ![string match "" $message] then {
402 set errmsg "$message: the program is no longer running"
404 set errmsg "$command: the program is no longer running"
409 -re ".*$gdb_prompt $" {
410 if ![string match "" $message] then {
417 perror "Window too small."
419 -re "\\(y or n\\) " {
421 perror "Got interactive prompt."
424 perror "Process no longer exists"
425 if { $message != "" } {
431 perror "internal buffer is full."
434 if ![string match "" $message] then {
435 fail "$message (timeout)"
443 # Test that a command gives an error. For pass or fail, return
444 # a 1 to indicate that more tests can proceed. However a timeout
445 # is a serious error, generates a special fail message, and causes
446 # a 0 to be returned to indicate that more tests are likely to fail
449 proc test_print_reject { args } {
453 if [llength $args]==2 then {
454 set expectthis [lindex $args 1]
456 set expectthis "should never match this bogus string"
458 set sendthis [lindex $args 0]
460 send_user "Sending \"$sendthis\" to gdb\n"
461 send_user "Looking to match \"$expectthis\"\n"
463 send_gdb "$sendthis\n"
464 #FIXME: Should add timeout as parameter.
466 -re "A .* in expression.*\\.*$gdb_prompt $" {
467 pass "reject $sendthis"
470 -re "Invalid syntax in expression.*$gdb_prompt $" {
471 pass "reject $sendthis"
474 -re "Junk after end of expression.*$gdb_prompt $" {
475 pass "reject $sendthis"
478 -re "Invalid number.*$gdb_prompt $" {
479 pass "reject $sendthis"
482 -re "Invalid character constant.*$gdb_prompt $" {
483 pass "reject $sendthis"
486 -re "No symbol table is loaded.*$gdb_prompt $" {
487 pass "reject $sendthis"
490 -re "No symbol .* in current context.*$gdb_prompt $" {
491 pass "reject $sendthis"
494 -re "$expectthis.*$gdb_prompt $" {
495 pass "reject $sendthis"
498 -re ".*$gdb_prompt $" {
499 fail "reject $sendthis"
503 fail "reject $sendthis (eof or timeout)"
509 # Given an input string, adds backslashes as needed to create a
510 # regexp that will match the string.
512 proc string_to_regexp {str} {
514 regsub -all {[]*+.|()^$\[]} $str {\\&} result
518 # Same as gdb_test, but the second parameter is not a regexp,
519 # but a string that must match exactly.
521 proc gdb_test_exact { args } {
522 upvar timeout timeout
524 set command [lindex $args 0]
526 # This applies a special meaning to a null string pattern. Without
527 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
528 # messages from commands that should have no output except a new
529 # prompt. With this, only results of a null string will match a null
532 set pattern [lindex $args 1]
533 if [string match $pattern ""] {
534 set pattern [string_to_regexp [lindex $args 0]]
536 set pattern [string_to_regexp [lindex $args 1]]
539 # It is most natural to write the pattern argument with only
540 # embedded \n's, especially if you are trying to avoid Tcl quoting
541 # problems. But gdb_expect really wants to see \r\n in patterns. So
542 # transform the pattern here. First transform \r\n back to \n, in
543 # case some users of gdb_test_exact already do the right thing.
544 regsub -all "\r\n" $pattern "\n" pattern
545 regsub -all "\n" $pattern "\r\n" pattern
546 if [llength $args]==3 then {
547 set message [lindex $args 2]
552 return [gdb_test $command $pattern $message]
555 proc gdb_reinitialize_dir { subdir } {
558 if [is_remote host] {
563 -re "Reinitialize source path to empty.*y or n. " {
566 -re "Source directories searched.*$gdb_prompt $" {
567 send_gdb "dir $subdir\n"
569 -re "Source directories searched.*$gdb_prompt $" {
570 verbose "Dir set to $subdir"
572 -re "$gdb_prompt $" {
573 perror "Dir \"$subdir\" failed."
577 -re "$gdb_prompt $" {
578 perror "Dir \"$subdir\" failed."
582 -re "$gdb_prompt $" {
583 perror "Dir \"$subdir\" failed."
589 # gdb_exit -- exit the GDB, killing the target program if necessary
591 proc default_gdb_exit {} {
597 gdb_stop_suppressing_tests;
599 if ![info exists gdb_spawn_id] {
603 verbose "Quitting $GDB $GDBFLAGS"
605 if [is_remote host] {
608 -re "and kill it.*y or n. " {
621 # load a file into the debugger.
622 # return a -1 if anything goes wrong.
624 proc gdb_file_cmd { arg } {
630 upvar timeout timeout
632 if [is_remote host] {
633 set arg [remote_download host $arg];
635 error "download failed"
640 send_gdb "file $arg\n"
642 -re "Reading symbols from.*done.*$gdb_prompt $" {
643 verbose "\t\tLoaded $arg into the $GDB"
646 -re "has no symbol-table.*$gdb_prompt $" {
647 perror "$arg wasn't compiled with \"-g\""
650 -re "A program is being debugged already.*Kill it.*y or n. $" {
652 verbose "\t\tKilling previous program being debugged"
655 -re "Load new symbol table from \".*\".*y or n. $" {
658 -re "Reading symbols from.*done.*$gdb_prompt $" {
659 verbose "\t\tLoaded $arg with new symbol table into $GDB"
663 perror "(timeout) Couldn't load $arg, other program already loaded."
668 -re "No such file or directory.*$gdb_prompt $" {
669 perror "($arg) No such file or directory\n"
672 -re "$gdb_prompt $" {
673 perror "couldn't load $arg into $GDB."
677 perror "couldn't load $arg into $GDB (timed out)."
681 # This is an attempt to detect a core dump, but seems not to
682 # work. Perhaps we need to match .* followed by eof, in which
683 # gdb_expect does not seem to have a way to do that.
684 perror "couldn't load $arg into $GDB (end of file)."
691 # start gdb -- start gdb running, default procedure
693 # When running over NFS, particularly if running many simultaneous
694 # tests on different hosts all using the same server, things can
695 # get really slow. Give gdb at least 3 minutes to start up.
697 proc default_gdb_start { } {
705 gdb_stop_suppressing_tests;
707 verbose "Spawning $GDB -nw $GDBFLAGS"
709 if [info exists gdb_spawn_id] {
713 if [is_remote host] {
714 set res [remote_spawn host "$GDB -nw $GDBFLAGS --command gdbinit"];
716 if { [which $GDB] == 0 } then {
717 perror "$GDB does not exist."
721 set res [remote_spawn host "$GDB -nw $GDBFLAGS"];
723 if { $res < 0 || $res == "" } {
724 perror "Spawning $GDB failed."
728 -re "\[\r\n\]$gdb_prompt $" {
729 verbose "GDB initialized."
731 -re "$gdb_prompt $" {
732 perror "GDB never initialized."
736 perror "(timeout) GDB never initialized after 10 seconds."
742 # force the height to "unlimited", so no pagers get used
744 send_gdb "set height 0\n"
746 -re "$gdb_prompt $" {
747 verbose "Setting height to 0." 2
750 warning "Couldn't set the height to 0"
753 # force the width to "unlimited", so no wraparound occurs
754 send_gdb "set width 0\n"
756 -re "$gdb_prompt $" {
757 verbose "Setting width to 0." 2
760 warning "Couldn't set the width to 0."
766 # * For crosses, the CHILL runtime doesn't build because it can't find
767 # setjmp.h, stdio.h, etc.
768 # * For AIX (as of 16 Mar 95), (a) there is no language code for
769 # CHILL in output_epilog in gcc/config/rs6000/rs6000.c, (b) collect2
770 # does not get along with AIX's too-clever linker.
771 # * On Irix5, there is a bug whereby set of bool, etc., don't get
772 # TYPE_LOW_BOUND for the bool right because force_to_range_type doesn't
773 # work with stub types.
774 # Lots of things seem to fail on the PA, and since it's not a supported
775 # chill target at the moment, don't run the chill tests.
777 proc skip_chill_tests {} {
778 if ![info exists do_chill_tests] {
781 eval set skip_chill [expr ![isnative] || [istarget "*-*-aix*"] || [istarget "*-*-irix5*"] || [istarget "*-*-irix6*"] || [istarget "alpha-*-osf*"] || [istarget "hppa*-*-*"]]
782 verbose "Skip chill tests is $skip_chill"
786 proc get_compiler_info {binfile} {
787 # Create and source the file that provides information about the compiler
788 # used to compile the test case.
791 # These two come from compiler.c.
792 global signed_keyword_not_used
795 if { [gdb_compile "${srcdir}/${subdir}/compiler.c" "${binfile}.ci" preprocess {}] != "" } {
796 perror "Couldn't make ${binfile}.ci file"
803 proc gdb_compile {source dest type options} {
804 global GDB_TESTCASE_OPTIONS;
806 if [target_info exists gdb_stub] {
807 set options2 { "additional_flags=-Dusestubs" }
808 lappend options "libs=[target_info gdb_stub]";
809 set options [concat $options2 $options]
811 if [info exists GDB_TESTCASE_OPTIONS] {
812 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
814 verbose "options are $options"
815 verbose "source is $source $dest $type $options"
816 set result [target_compile $source $dest $type $options];
817 regsub "\[\r\n\]*$" "$result" "" result;
818 regsub "^\[\r\n\]*" "$result" "" result;
819 if { $result != "" } {
820 clone_output "gdb compile failed, $result"
825 proc send_gdb { string } {
826 global suppress_flag;
827 if { $suppress_flag } {
830 return [remote_send host "$string"];
836 proc gdb_expect { args } {
837 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
838 set gtimeout [lindex $args 0];
839 set expcode [list [lindex $args 1]];
841 upvar timeout timeout;
844 if [target_info exists gdb,timeout] {
845 if [info exists timeout] {
846 if { $timeout < [target_info gdb,timeout] } {
847 set gtimeout [target_info gdb,timeout];
849 set gtimeout $timeout;
852 set gtimeout [target_info gdb,timeout];
856 if ![info exists gtimeout] {
858 if [info exists timeout] {
859 set gtimeout $timeout;
866 set code [catch {uplevel remote_expect host $gtimeout $expcode} string];
869 global errorInfo errorCode;
871 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
872 } elseif {$code == 2} {
873 return -code return $string
874 } elseif {$code == 3} {
876 } elseif {$code > 4} {
877 return -code $code $string
882 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
883 # gdb_expect to fail immediately (until the next call to
884 # gdb_stop_suppressing_tests).
886 proc gdb_suppress_tests { args } {
887 global suppress_flag;
891 if { $suppress_flag == 1 } {
892 if { [llength $args] > 0 } {
893 warning "[lindex $args 0]\n";
895 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
901 # Clear suppress_flag.
903 proc gdb_stop_suppressing_tests { } {
904 global suppress_flag;
906 if [info exists suppress_flag] {
907 if { $suppress_flag != 0 } {
909 clone_output "Tests restarted.\n";
921 catch default_gdb_exit
925 # gdb_load -- load a file into the debugger.
926 # return a -1 if anything goes wrong.
928 proc gdb_load { arg } {
929 return [gdb_file_cmd $arg]
932 proc gdb_continue { function } {
935 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
938 proc default_gdb_init { args } {
939 gdb_stop_suppressing_tests;
941 # Uh, this is lame. Really, really, really lame. But there's this *one*
942 # testcase that will fail in random places if we don't increase this.
945 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
946 if { [llength $args] > 0 } {
949 set file [lindex $args 0];
951 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
955 proc gdb_init { args } {
956 return [eval default_gdb_init $args];
959 proc gdb_finish { } {