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"
465 -re "A .* in expression.*\\.*$gdb_prompt $" {
466 pass "reject $sendthis"
469 -re "Invalid syntax in expression.*$gdb_prompt $" {
470 pass "reject $sendthis"
473 -re "Junk after end of expression.*$gdb_prompt $" {
474 pass "reject $sendthis"
477 -re "Invalid number.*$gdb_prompt $" {
478 pass "reject $sendthis"
481 -re "Invalid character constant.*$gdb_prompt $" {
482 pass "reject $sendthis"
485 -re "No symbol table is loaded.*$gdb_prompt $" {
486 pass "reject $sendthis"
489 -re "No symbol .* in current context.*$gdb_prompt $" {
490 pass "reject $sendthis"
493 -re "$expectthis.*$gdb_prompt $" {
494 pass "reject $sendthis"
497 -re ".*$gdb_prompt $" {
498 fail "reject $sendthis"
502 fail "reject $sendthis (eof or timeout)"
508 # Given an input string, adds backslashes as needed to create a
509 # regexp that will match the string.
511 proc string_to_regexp {str} {
513 regsub -all {[]*+.|()^$\[]} $str {\\&} result
517 # Same as gdb_test, but the second parameter is not a regexp,
518 # but a string that must match exactly.
520 proc gdb_test_exact { args } {
521 upvar timeout timeout
523 set command [lindex $args 0]
525 # This applies a special meaning to a null string pattern. Without
526 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
527 # messages from commands that should have no output except a new
528 # prompt. With this, only results of a null string will match a null
531 set pattern [lindex $args 1]
532 if [string match $pattern ""] {
533 set pattern [string_to_regexp [lindex $args 0]]
535 set pattern [string_to_regexp [lindex $args 1]]
538 # It is most natural to write the pattern argument with only
539 # embedded \n's, especially if you are trying to avoid Tcl quoting
540 # problems. But gdb_expect really wants to see \r\n in patterns. So
541 # transform the pattern here. First transform \r\n back to \n, in
542 # case some users of gdb_test_exact already do the right thing.
543 regsub -all "\r\n" $pattern "\n" pattern
544 regsub -all "\n" $pattern "\r\n" pattern
545 if [llength $args]==3 then {
546 set message [lindex $args 2]
551 return [gdb_test $command $pattern $message]
554 proc gdb_reinitialize_dir { subdir } {
557 if [is_remote host] {
562 -re "Reinitialize source path to empty.*y or n. " {
565 -re "Source directories searched.*$gdb_prompt $" {
566 send_gdb "dir $subdir\n"
568 -re "Source directories searched.*$gdb_prompt $" {
569 verbose "Dir set to $subdir"
571 -re "$gdb_prompt $" {
572 perror "Dir \"$subdir\" failed."
576 -re "$gdb_prompt $" {
577 perror "Dir \"$subdir\" failed."
581 -re "$gdb_prompt $" {
582 perror "Dir \"$subdir\" failed."
588 # gdb_exit -- exit the GDB, killing the target program if necessary
590 proc default_gdb_exit {} {
596 gdb_stop_suppressing_tests;
598 if ![info exists gdb_spawn_id] {
602 verbose "Quitting $GDB $GDBFLAGS"
604 # This used to be 1 for unix-gdb.exp
606 verbose "Timeout is now $timeout seconds" 2
608 if [is_remote host] {
611 -re "and kill it.*y or n. " {
624 # load a file into the debugger.
625 # return a -1 if anything goes wrong.
627 proc gdb_file_cmd { arg } {
633 upvar timeout timeout
635 if [is_remote host] {
636 set arg [remote_download host $arg];
638 error "download failed"
643 send_gdb "file $arg\n"
645 -re "Reading symbols from.*done.*$gdb_prompt $" {
646 verbose "\t\tLoaded $arg into the $GDB"
649 -re "has no symbol-table.*$gdb_prompt $" {
650 perror "$arg wasn't compiled with \"-g\""
653 -re "A program is being debugged already.*Kill it.*y or n. $" {
655 verbose "\t\tKilling previous program being debugged"
658 -re "Load new symbol table from \".*\".*y or n. $" {
661 -re "Reading symbols from.*done.*$gdb_prompt $" {
662 verbose "\t\tLoaded $arg with new symbol table into $GDB"
666 perror "(timeout) Couldn't load $arg, other program already loaded."
671 -re "No such file or directory.*$gdb_prompt $" {
672 perror "($arg) No such file or directory\n"
675 -re "$gdb_prompt $" {
676 perror "couldn't load $arg into $GDB."
680 perror "couldn't load $arg into $GDB (timed out)."
684 # This is an attempt to detect a core dump, but seems not to
685 # work. Perhaps we need to match .* followed by eof, in which
686 # gdb_expect does not seem to have a way to do that.
687 perror "couldn't load $arg into $GDB (end of file)."
694 # start gdb -- start gdb running, default procedure
696 # When running over NFS, particularly if running many simultaneous
697 # tests on different hosts all using the same server, things can
698 # get really slow. Give gdb at least 3 minutes to start up.
700 proc default_gdb_start { } {
708 gdb_stop_suppressing_tests;
710 verbose "Spawning $GDB -nw $GDBFLAGS"
712 if [info exists gdb_spawn_id] {
716 set oldtimeout $timeout
717 set timeout [expr "$timeout + 180"]
718 if [is_remote host] {
719 set res [remote_spawn host "$GDB -nw $GDBFLAGS --command gdbinit"];
721 if { [which $GDB] == 0 } then {
722 perror "$GDB does not exist."
726 set res [remote_spawn host "$GDB -nw $GDBFLAGS"];
728 if { $res < 0 || $res == "" } {
729 perror "Spawning $GDB failed."
734 -re "\[\r\n\]$gdb_prompt $" {
735 verbose "GDB initialized."
737 -re "$gdb_prompt $" {
738 perror "GDB never initialized."
739 set timeout $oldtimeout
740 verbose "Timeout restored to $timeout seconds" 2
744 perror "(timeout) GDB never initialized after $timeout seconds."
749 set timeout $oldtimeout
750 verbose "Timeout restored to $timeout seconds" 2
752 # force the height to "unlimited", so no pagers get used
754 send_gdb "set height 0\n"
756 -re "$gdb_prompt $" {
757 verbose "Setting height to 0." 2
760 warning "Couldn't set the height to 0"
763 # force the width to "unlimited", so no wraparound occurs
764 send_gdb "set width 0\n"
766 -re "$gdb_prompt $" {
767 verbose "Setting width to 0." 2
770 warning "Couldn't set the width to 0."
777 # FIXME: this is a copy of the new library procedure, but it's here too
778 # till the new dejagnu gets installed everywhere. I'd hate to break the
782 if ![info exists argv0] then {
783 proc exp_continue { } {
788 # * For crosses, the CHILL runtime doesn't build because it can't find
789 # setjmp.h, stdio.h, etc.
790 # * For AIX (as of 16 Mar 95), (a) there is no language code for
791 # CHILL in output_epilog in gcc/config/rs6000/rs6000.c, (b) collect2
792 # does not get along with AIX's too-clever linker.
793 # * On Irix5, there is a bug whereby set of bool, etc., don't get
794 # TYPE_LOW_BOUND for the bool right because force_to_range_type doesn't
795 # work with stub types.
796 # Lots of things seem to fail on the PA, and since it's not a supported
797 # chill target at the moment, don't run the chill tests.
799 proc skip_chill_tests {} {
800 if ![info exists do_chill_tests] {
803 eval set skip_chill [expr ![isnative] || [istarget "*-*-aix*"] || [istarget "*-*-irix5*"] || [istarget "*-*-irix6*"] || [istarget "alpha-*-osf*"] || [istarget "hppa*-*-*"]]
804 verbose "Skip chill tests is $skip_chill"
808 proc get_compiler_info {binfile} {
809 # Create and source the file that provides information about the compiler
810 # used to compile the test case.
813 # These two come from compiler.c.
814 global signed_keyword_not_used
817 if { [gdb_compile "${srcdir}/${subdir}/compiler.c" "${binfile}.ci" preprocess {}] != "" } {
818 perror "Couldn't make ${binfile}.ci file"
825 proc gdb_compile {source dest type options} {
826 global GDB_TESTCASE_OPTIONS;
828 if [target_info exists gdb_stub] {
829 set options2 { "additional_flags=-Dusestubs" }
830 lappend options "libs=[target_info gdb_stub]";
831 set options [concat $options2 $options]
833 if [info exists GDB_TESTCASE_OPTIONS] {
834 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
836 verbose "options are $options"
837 verbose "source is $source $dest $type $options"
838 set result [target_compile $source $dest $type $options];
839 regsub "\[\r\n\]*$" "$result" "" result;
840 regsub "^\[\r\n\]*" "$result" "" result;
841 if { $result != "" } {
842 clone_output "gdb compile failed, $result"
847 proc send_gdb { string } {
848 global suppress_flag;
849 if { $suppress_flag } {
852 return [remote_send host "$string"];
858 proc gdb_expect { args } {
859 upvar timeout timeout
860 if [target_info exists gdb,timeout] {
861 if [info exists timeout] {
863 if { $timeout < [target_info gdb,timeout] } {
864 set timeout [target_info gdb,timeout];
867 set timeout [target_info gdb,timeout];
870 set code [catch {uplevel remote_expect host $timeout $args} string];
871 if [target_info exists gdb,timeout] {
872 if [info exists oldt] {
880 global errorInfo errorCode;
882 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
883 } elseif {$code == 2} {
884 return -code return $string
885 } elseif {$code == 3} {
887 } elseif {$code > 4} {
888 return -code $code $string
893 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
894 # gdb_expect to fail immediately (until the next call to
895 # gdb_stop_suppressing_tests).
897 proc gdb_suppress_tests { args } {
898 global suppress_flag;
902 if { [llength $args] > 0 } {
903 warning "[lindex $args 0]\n";
905 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
910 # Clear suppress_flag.
912 proc gdb_stop_suppressing_tests { } {
913 global suppress_flag;
915 if [info exists suppress_flag] {
916 if { $suppress_flag != 0 } {
918 clone_output "Tests restarted.\n";
930 catch default_gdb_exit
934 # gdb_load -- load a file into the debugger.
935 # return a -1 if anything goes wrong.
937 proc gdb_load { arg } {
938 return [gdb_file_cmd $arg]
941 proc gdb_continue { function } {
944 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
947 proc default_gdb_init { args } {
948 gdb_stop_suppressing_tests;
950 # Uh, this is lame. Really, really, really lame. But there's this *one*
951 # testcase that will fail in random places if we don't increase this.
954 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
955 if { [llength $args] > 0 } {
958 set file [lindex $args 0];
960 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
964 proc gdb_init { args } {
965 return [default_gdb_init];
968 proc gdb_finish { } {