1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 # Free Software Foundation, Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 # Please email any bugs, comments, and/or additions to this file to:
20 # bug-gdb@prep.ai.mit.edu
22 # This file was written by Fred Fish. (fnf@cygnus.com)
24 # Generic gdb subroutines that should work for any target. If these
25 # need to be modified for any target, it can be done with a variable
26 # or by passing arguments.
32 if [info exists TOOL_EXECUTABLE] {
33 set GDB $TOOL_EXECUTABLE;
35 if ![info exists GDB] {
36 if ![is_remote host] {
37 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
39 set GDB [transform gdb];
42 verbose "using GDB = $GDB" 2
45 if ![info exists GDBFLAGS] {
48 verbose "using GDBFLAGS = $GDBFLAGS" 2
50 # The variable gdb_prompt is a regexp which matches the gdb prompt.
51 # Set it if it is not already set.
53 if ![info exists gdb_prompt] then {
54 set gdb_prompt "\[(\]gdb\[)\]"
57 # Needed for some tests under Cygwin.
61 if ![info exists env(EXEEXT)] {
64 set EXEEXT $env(EXEEXT)
67 ### Only procedures should come after this point.
70 # gdb_version -- extract and print the version number of GDB
72 proc default_gdb_version {} {
76 set fileid [open "gdb_cmd" w];
79 set cmdfile [remote_download host "gdb_cmd"];
80 set output [remote_exec host "$GDB -nw --command $cmdfile"]
81 remote_file build delete "gdb_cmd";
82 remote_file host delete "$cmdfile";
83 set tmp [lindex $output 1];
85 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
86 if ![is_remote host] {
87 clone_output "[which $GDB] version $version $GDBFLAGS\n"
89 clone_output "$GDB on remote host version $version $GDBFLAGS\n"
93 proc gdb_version { } {
94 return [default_gdb_version];
98 # gdb_unload -- unload a file if one is loaded
107 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
108 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
109 -re "A program is being debugged already..*Kill it.*y or n. $"\
111 verbose "\t\tKilling previous program being debugged"
114 -re "Discard symbol table from .*y or n.*$" {
118 -re "$gdb_prompt $" {}
120 perror "couldn't unload file in $GDB (timed out)."
126 # Many of the tests depend on setting breakpoints at various places and
127 # running until that breakpoint is reached. At times, we want to start
128 # with a clean-slate with respect to breakpoints, so this utility proc
129 # lets us do this without duplicating this code everywhere.
132 proc delete_breakpoints {} {
135 # we need a larger timeout value here or this thing just confuses
136 # itself. May need a better implementation if possible. - guo
138 send_gdb "delete breakpoints\n"
140 -re "Delete all breakpoints.*y or n.*$" {
144 -re "$gdb_prompt $" { # This happens if there were no breakpoints
146 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
148 send_gdb "info breakpoints\n"
150 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
151 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
152 -re "Delete all breakpoints.*or n.*$" {
156 timeout { perror "info breakpoints (timeout)" ; return }
162 # Generic run command.
164 # The second pattern below matches up to the first newline *only*.
165 # Using ``.*$'' could swallow up output that we attempt to match
168 proc gdb_run_cmd {args} {
171 if [target_info exists gdb_init_command] {
172 send_gdb "[target_info gdb_init_command]\n";
174 -re "$gdb_prompt $" { }
176 perror "gdb_init_command for target failed";
182 if [target_info exists use_gdb_stub] {
183 if [target_info exists gdb,do_reload_on_run] {
184 # Specifying no file, defaults to the executable
185 # currently being debugged.
186 if { [gdb_load ""] < 0 } {
189 send_gdb "continue\n";
191 -re "Continu\[^\r\n\]*\[\r\n\]" {}
197 if [target_info exists gdb,start_symbol] {
198 set start [target_info gdb,start_symbol];
202 send_gdb "jump *$start\n"
204 while { $start_attempt } {
205 # Cap (re)start attempts at three to ensure that this loop
206 # always eventually fails. Don't worry about trying to be
207 # clever and not send a command when it has failed.
208 if [expr $start_attempt > 3] {
209 perror "Jump to start() failed (retry count exceeded)";
212 set start_attempt [expr $start_attempt + 1];
214 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
217 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
218 perror "Can't find start symbol to run in gdb_run";
221 -re "No symbol \"start\" in current.*$gdb_prompt $" {
222 send_gdb "jump *_start\n";
224 -re "No symbol.*context.*$gdb_prompt $" {
227 -re "Line.* Jump anyway.*y or n. $" {
230 -re "The program is not being run.*$gdb_prompt $" {
231 if { [gdb_load ""] < 0 } {
234 send_gdb "jump *$start\n";
237 perror "Jump to start() failed (timeout)";
242 if [target_info exists gdb_stub] {
244 -re "$gdb_prompt $" {
245 send_gdb "continue\n"
252 if [target_info exists gdb,do_reload_on_run] {
253 if { [gdb_load ""] < 0 } {
257 send_gdb "run $args\n"
258 # This doesn't work quite right yet.
260 -re "The program .* has been started already.*y or n. $" {
264 -re "Starting program: \[^\r\n\]*" {}
268 # Set a breakpoint at FUNCTION. If there is an additional argument it is
269 # a list of options; the only currently supported option is allow-pending.
271 proc gdb_breakpoint { function args } {
275 set pending_response n
276 if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
277 set pending_response y
280 send_gdb "break $function\n"
281 # The first two regexps are what we get with -g, the third is without -g.
283 -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
284 -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
285 -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
286 -re "Breakpoint \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
287 if {$pending_response == "n"} {
288 fail "setting breakpoint at $function"
292 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
293 send_gdb "$pending_response\n"
296 -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
297 timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
302 # Set breakpoint at function and run gdb until it breaks there.
303 # Since this is the only breakpoint that will be set, if it stops
304 # at a breakpoint, we will assume it is the one we want. We can't
305 # just compare to "function" because it might be a fully qualified,
306 # single quoted C++ function specifier. If there's an additional argument,
307 # pass it to gdb_breakpoint.
309 proc runto { function args } {
315 if ![gdb_breakpoint $function [lindex $args 0]] {
321 # the "at foo.c:36" output we get with -g.
322 # the "in func" output we get without -g.
324 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
327 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
330 -re "$gdb_prompt $" {
331 fail "running to $function in runto"
335 fail "running to $function in runto (timeout)"
343 # runto_main -- ask gdb to run until we hit a breakpoint at main.
344 # The case where the target uses stubs has to be handled
345 # specially--if it uses stubs, assuming we hit
346 # breakpoint() and just step out of the function.
348 proc runto_main { } {
352 if ![target_info exists gdb_stub] {
364 ### Continue, and expect to hit a breakpoint.
365 ### Report a pass or fail, depending on whether it seems to have
366 ### worked. Use NAME as part of the test name; each call to
367 ### continue_to_breakpoint should use a NAME which is unique within
369 proc gdb_continue_to_breakpoint {name} {
371 set full_name "continue to breakpoint: $name"
373 send_gdb "continue\n"
375 -re "Breakpoint .* at .*\r\n$gdb_prompt $" {
378 -re ".*$gdb_prompt $" {
382 fail "$full_name (timeout)"
388 # gdb_internal_error_resync:
390 # Answer the questions GDB asks after it reports an internal error
391 # until we get back to a GDB prompt. Decline to quit the debugging
392 # session, and decline to create a core file. Return non-zero if the
395 # This procedure just answers whatever questions come up until it sees
396 # a GDB prompt; it doesn't require you to have matched the input up to
397 # any specific point. However, it only answers questions it sees in
398 # the output itself, so if you've matched a question, you had better
399 # answer it yourself before calling this.
401 # You can use this function thus:
405 # -re ".*A problem internal to GDB has been detected" {
406 # gdb_internal_error_resync
411 proc gdb_internal_error_resync {} {
415 while {$count < 10} {
417 -re "Quit this debugging session\\? \\(y or n\\) $" {
421 -re "Create a core file of GDB\\? \\(y or n\\) $" {
425 -re "$gdb_prompt $" {
426 # We're resynchronized.
430 perror "Could not resync from internal error (timeout)"
435 perror "Could not resync from internal error (resync count exceeded)"
440 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
441 # Send a command to gdb; test the result.
443 # COMMAND is the command to execute, send to GDB with send_gdb. If
444 # this is the null string no command is sent.
445 # MESSAGE is a message to be printed with the built-in failure patterns
446 # if one of them matches. If MESSAGE is empty COMMAND will be used.
447 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
448 # patterns. Pattern elements will be evaluated in the caller's
449 # context; action elements will be executed in the caller's context.
450 # Unlike patterns for gdb_test, these patterns should generally include
451 # the final newline and prompt.
454 # 1 if the test failed, according to a built-in failure pattern
455 # 0 if only user-supplied patterns matched
456 # -1 if there was an internal error.
458 # You can use this function thus:
460 # gdb_test_multiple "print foo" "test foo" {
461 # -re "expected output 1" {
464 # -re "expected output 2" {
469 # The standard patterns, such as "Program exited..." and "A problem
470 # ...", all being implicitly appended to that list.
472 proc gdb_test_multiple { command message user_code } {
476 upvar timeout timeout
477 upvar expect_out expect_out
479 if { $message == "" } {
483 # TCL/EXPECT WART ALERT
484 # Expect does something very strange when it receives a single braced
485 # argument. It splits it along word separators and performs substitutions.
486 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
487 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
488 # double-quoted list item, "\[ab\]" is just a long way of representing
489 # "[ab]", because the backslashes will be removed by lindex.
491 # Unfortunately, there appears to be no easy way to duplicate the splitting
492 # that expect will do from within TCL. And many places make use of the
493 # "\[0-9\]" construct, so we need to support that; and some places make use
494 # of the "[func]" construct, so we need to support that too. In order to
495 # get this right we have to substitute quoted list elements differently
496 # from braced list elements.
498 # We do this roughly the same way that Expect does it. We have to use two
499 # lists, because if we leave unquoted newlines in the argument to uplevel
500 # they'll be treated as command separators, and if we escape newlines
501 # we mangle newlines inside of command blocks. This assumes that the
502 # input doesn't contain a pattern which contains actual embedded newlines
505 regsub -all {\n} ${user_code} { } subst_code
506 set subst_code [uplevel list $subst_code]
508 set processed_code ""
510 set expecting_action 0
511 foreach item $user_code subst_item $subst_code {
512 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
513 lappend processed_code $item
516 if {$item == "-indices" || $item == "-re" || $item == "-ex"} {
517 lappend processed_code $item
520 if { $expecting_action } {
521 lappend processed_code "uplevel [list $item]"
522 set expecting_action 0
523 # Cosmetic, no effect on the list.
524 append processed_code "\n"
527 set expecting_action 1
528 lappend processed_code $subst_item
529 if {$patterns != ""} {
532 append patterns "\"$subst_item\""
535 # Also purely cosmetic.
536 regsub -all {\r} $patterns {\\r} patterns
537 regsub -all {\n} $patterns {\\n} patterns
540 send_user "Sending \"$command\" to gdb\n"
541 send_user "Looking to match \"$patterns\"\n"
542 send_user "Message is \"$message\"\n"
546 set string "${command}\n";
547 if { $command != "" } {
548 while { "$string" != "" } {
549 set foo [string first "\n" "$string"];
550 set len [string length "$string"];
551 if { $foo < [expr $len - 1] } {
552 set str [string range "$string" 0 $foo];
553 if { [send_gdb "$str"] != "" } {
554 global suppress_flag;
556 if { ! $suppress_flag } {
557 perror "Couldn't send $command to GDB.";
562 # since we're checking if each line of the multi-line
563 # command are 'accepted' by GDB here,
564 # we need to set -notransfer expect option so that
565 # command output is not lost for pattern matching
568 -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
569 timeout { verbose "partial: timeout" 3 }
571 set string [string range "$string" [expr $foo + 1] end];
576 if { "$string" != "" } {
577 if { [send_gdb "$string"] != "" } {
578 global suppress_flag;
580 if { ! $suppress_flag } {
581 perror "Couldn't send $command to GDB.";
589 if [target_info exists gdb,timeout] {
590 set tmt [target_info gdb,timeout];
592 if [info exists timeout] {
596 if [info exists timeout] {
605 -re ".*A problem internal to GDB has been detected" {
606 fail "$message (GDB internal error)"
607 gdb_internal_error_resync
609 -re "\\*\\*\\* DOSEXIT code.*" {
610 if { $message != "" } {
613 gdb_suppress_entire_file "GDB died";
616 -re "Ending remote debugging.*$gdb_prompt $" {
617 if ![isnative] then {
618 warning "Can`t communicate to remote target."
625 append code $processed_code
627 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
628 perror "Undefined command \"$command\"."
632 -re "Ambiguous command.*$gdb_prompt $" {
633 perror "\"$command\" is not a unique command name."
637 -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
638 if ![string match "" $message] then {
639 set errmsg "$message (the program exited)"
641 set errmsg "$command (the program exited)"
646 -re "EXIT code \[0-9\r\n\]+Program exited normally.*$gdb_prompt $" {
647 if ![string match "" $message] then {
648 set errmsg "$message (the program exited)"
650 set errmsg "$command (the program exited)"
655 -re "The program is not being run.*$gdb_prompt $" {
656 if ![string match "" $message] then {
657 set errmsg "$message (the program is no longer running)"
659 set errmsg "$command (the program is no longer running)"
664 -re ".*$gdb_prompt $" {
665 if ![string match "" $message] then {
672 perror "Window too small."
676 -re "\\(y or n\\) " {
678 perror "Got interactive prompt."
683 perror "Process no longer exists"
684 if { $message != "" } {
690 perror "internal buffer is full."
695 if ![string match "" $message] then {
696 fail "$message (timeout)"
703 gdb_expect $tmt $code
707 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
708 # Send a command to gdb; test the result.
710 # COMMAND is the command to execute, send to GDB with send_gdb. If
711 # this is the null string no command is sent.
712 # PATTERN is the pattern to match for a PASS, and must NOT include
713 # the \r\n sequence immediately before the gdb prompt.
714 # MESSAGE is an optional message to be printed. If this is
715 # omitted, then the pass/fail messages use the command string as the
716 # message. (If this is the empty string, then sometimes we don't
717 # call pass or fail at all; I don't understand this at all.)
718 # QUESTION is a question GDB may ask in response to COMMAND, like
720 # RESPONSE is the response to send if QUESTION appears.
723 # 1 if the test failed,
724 # 0 if the test passes,
725 # -1 if there was an internal error.
727 proc gdb_test { args } {
731 upvar timeout timeout
733 if [llength $args]>2 then {
734 set message [lindex $args 2]
736 set message [lindex $args 0]
738 set command [lindex $args 0]
739 set pattern [lindex $args 1]
741 if [llength $args]==5 {
742 set question_string [lindex $args 3];
743 set response_string [lindex $args 4];
745 set question_string "^FOOBAR$"
748 return [gdb_test_multiple $command $message {
749 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
750 if ![string match "" $message] then {
754 -re "(${question_string})$" {
755 send_gdb "$response_string\n";
761 # Test that a command gives an error. For pass or fail, return
762 # a 1 to indicate that more tests can proceed. However a timeout
763 # is a serious error, generates a special fail message, and causes
764 # a 0 to be returned to indicate that more tests are likely to fail
767 proc test_print_reject { args } {
771 if [llength $args]==2 then {
772 set expectthis [lindex $args 1]
774 set expectthis "should never match this bogus string"
776 set sendthis [lindex $args 0]
778 send_user "Sending \"$sendthis\" to gdb\n"
779 send_user "Looking to match \"$expectthis\"\n"
781 send_gdb "$sendthis\n"
782 #FIXME: Should add timeout as parameter.
784 -re "A .* in expression.*\\.*$gdb_prompt $" {
785 pass "reject $sendthis"
788 -re "Invalid syntax in expression.*$gdb_prompt $" {
789 pass "reject $sendthis"
792 -re "Junk after end of expression.*$gdb_prompt $" {
793 pass "reject $sendthis"
796 -re "Invalid number.*$gdb_prompt $" {
797 pass "reject $sendthis"
800 -re "Invalid character constant.*$gdb_prompt $" {
801 pass "reject $sendthis"
804 -re "No symbol table is loaded.*$gdb_prompt $" {
805 pass "reject $sendthis"
808 -re "No symbol .* in current context.*$gdb_prompt $" {
809 pass "reject $sendthis"
812 -re "Unmatched single quote.*$gdb_prompt $" {
813 pass "reject $sendthis"
816 -re "A character constant must contain at least one character.*$gdb_prompt $" {
817 pass "reject $sendthis"
820 -re "$expectthis.*$gdb_prompt $" {
821 pass "reject $sendthis"
824 -re ".*$gdb_prompt $" {
825 fail "reject $sendthis"
829 fail "reject $sendthis (eof or timeout)"
835 # Given an input string, adds backslashes as needed to create a
836 # regexp that will match the string.
838 proc string_to_regexp {str} {
840 regsub -all {[]*+.|()^$\[]} $str {\\&} result
844 # Same as gdb_test, but the second parameter is not a regexp,
845 # but a string that must match exactly.
847 proc gdb_test_exact { args } {
848 upvar timeout timeout
850 set command [lindex $args 0]
852 # This applies a special meaning to a null string pattern. Without
853 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
854 # messages from commands that should have no output except a new
855 # prompt. With this, only results of a null string will match a null
858 set pattern [lindex $args 1]
859 if [string match $pattern ""] {
860 set pattern [string_to_regexp [lindex $args 0]]
862 set pattern [string_to_regexp [lindex $args 1]]
865 # It is most natural to write the pattern argument with only
866 # embedded \n's, especially if you are trying to avoid Tcl quoting
867 # problems. But gdb_expect really wants to see \r\n in patterns. So
868 # transform the pattern here. First transform \r\n back to \n, in
869 # case some users of gdb_test_exact already do the right thing.
870 regsub -all "\r\n" $pattern "\n" pattern
871 regsub -all "\n" $pattern "\r\n" pattern
872 if [llength $args]==3 then {
873 set message [lindex $args 2]
878 return [gdb_test $command $pattern $message]
881 proc gdb_reinitialize_dir { subdir } {
884 if [is_remote host] {
889 -re "Reinitialize source path to empty.*y or n. " {
892 -re "Source directories searched.*$gdb_prompt $" {
893 send_gdb "dir $subdir\n"
895 -re "Source directories searched.*$gdb_prompt $" {
896 verbose "Dir set to $subdir"
898 -re "$gdb_prompt $" {
899 perror "Dir \"$subdir\" failed."
903 -re "$gdb_prompt $" {
904 perror "Dir \"$subdir\" failed."
908 -re "$gdb_prompt $" {
909 perror "Dir \"$subdir\" failed."
915 # gdb_exit -- exit the GDB, killing the target program if necessary
917 proc default_gdb_exit {} {
923 gdb_stop_suppressing_tests;
925 if ![info exists gdb_spawn_id] {
929 verbose "Quitting $GDB $GDBFLAGS"
931 if { [is_remote host] && [board_info host exists fileid] } {
938 -re "DOSEXIT code" { }
943 if ![is_remote host] {
950 # load a file into the debugger.
951 # return a -1 if anything goes wrong.
953 proc gdb_file_cmd { arg } {
959 upvar timeout timeout
961 if [is_remote host] {
962 set arg [remote_download host $arg];
964 error "download failed"
969 send_gdb "file $arg\n"
971 -re "Reading symbols from.*done.*$gdb_prompt $" {
972 verbose "\t\tLoaded $arg into the $GDB"
975 -re "has no symbol-table.*$gdb_prompt $" {
976 perror "$arg wasn't compiled with \"-g\""
979 -re "A program is being debugged already.*Kill it.*y or n. $" {
981 verbose "\t\tKilling previous program being debugged"
984 -re "Load new symbol table from \".*\".*y or n. $" {
987 -re "Reading symbols from.*done.*$gdb_prompt $" {
988 verbose "\t\tLoaded $arg with new symbol table into $GDB"
992 perror "(timeout) Couldn't load $arg, other program already loaded."
997 -re "No such file or directory.*$gdb_prompt $" {
998 perror "($arg) No such file or directory\n"
1001 -re "$gdb_prompt $" {
1002 perror "couldn't load $arg into $GDB."
1006 perror "couldn't load $arg into $GDB (timed out)."
1010 # This is an attempt to detect a core dump, but seems not to
1011 # work. Perhaps we need to match .* followed by eof, in which
1012 # gdb_expect does not seem to have a way to do that.
1013 perror "couldn't load $arg into $GDB (end of file)."
1020 # start gdb -- start gdb running, default procedure
1022 # When running over NFS, particularly if running many simultaneous
1023 # tests on different hosts all using the same server, things can
1024 # get really slow. Give gdb at least 3 minutes to start up.
1026 proc default_gdb_start { } {
1032 global gdb_spawn_id;
1034 gdb_stop_suppressing_tests;
1036 verbose "Spawning $GDB -nw $GDBFLAGS"
1038 if [info exists gdb_spawn_id] {
1042 if ![is_remote host] {
1043 if { [which $GDB] == 0 } then {
1044 perror "$GDB does not exist."
1048 set res [remote_spawn host "$GDB -nw $GDBFLAGS [host_info gdb_opts]"];
1049 if { $res < 0 || $res == "" } {
1050 perror "Spawning $GDB failed."
1054 -re "\[\r\n\]$gdb_prompt $" {
1055 verbose "GDB initialized."
1057 -re "$gdb_prompt $" {
1058 perror "GDB never initialized."
1062 perror "(timeout) GDB never initialized after 10 seconds."
1067 set gdb_spawn_id -1;
1068 # force the height to "unlimited", so no pagers get used
1070 send_gdb "set height 0\n"
1072 -re "$gdb_prompt $" {
1073 verbose "Setting height to 0." 2
1076 warning "Couldn't set the height to 0"
1079 # force the width to "unlimited", so no wraparound occurs
1080 send_gdb "set width 0\n"
1082 -re "$gdb_prompt $" {
1083 verbose "Setting width to 0." 2
1086 warning "Couldn't set the width to 0."
1092 # Return a 1 for configurations for which we don't even want to try to
1095 proc skip_cplus_tests {} {
1096 if { [istarget "d10v-*-*"] } {
1099 if { [istarget "h8300-*-*"] } {
1103 # The C++ IO streams are too large for HC11/HC12 and are thus not
1104 # available. The gdb C++ tests use them and don't compile.
1105 if { [istarget "m6811-*-*"] } {
1108 if { [istarget "m6812-*-*"] } {
1114 # Skip all the tests in the file if you are not on an hppa running
1117 proc skip_hp_tests {} {
1118 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
1119 verbose "Skip hp tests is $skip_hp"
1123 set compiler_info "unknown"
1125 set hp_cc_compiler 0
1126 set hp_aCC_compiler 0
1127 set signed_keyword_not_used 0
1129 # Figure out what compiler I am using.
1131 # BINFILE is a "compiler information" output file. This implementation
1132 # does not use BINFILE.
1134 # ARGS can be empty or "C++". If empty, "C" is assumed.
1136 # There are several ways to do this, with various problems.
1138 # [ gdb_compile -E $ifile -o $binfile.ci ]
1139 # source $binfile.ci
1141 # Single Unix Spec v3 says that "-E -o ..." together are not
1142 # specified. And in fact, the native compiler on hp-ux 11 (among
1143 # others) does not work with "-E -o ...". Most targets used to do
1144 # this, and it mostly worked, because it works with gcc.
1146 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1147 # source $binfile.ci
1149 # This avoids the problem with -E and -o together. This almost works
1150 # if the build machine is the same as the host machine, which is
1151 # usually true of the targets which are not gcc. But this code does
1152 # not figure which compiler to call, and it always ends up using the C
1153 # compiler. Not good for setting hp_aCC_compiler. Targets
1154 # hppa*-*-hpux* and mips*-*-irix* used to do this.
1156 # [ gdb_compile -E $ifile > $binfile.ci ]
1157 # source $binfile.ci
1159 # dejagnu target_compile says that it supports output redirection,
1160 # but the code is completely different from the normal path and I
1161 # don't want to sweep the mines from that path. So I didn't even try
1164 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1167 # I actually do this for all targets now. gdb_compile runs the right
1168 # compiler, and TCL captures the output, and I eval the output.
1170 # Unfortunately, expect logs the output of the command as it goes by,
1171 # and dejagnu helpfully prints a second copy of it right afterwards.
1172 # So I turn off expect logging for a moment.
1174 # [ gdb_compile $ifile $ciexe_file executable $args ]
1175 # [ remote_exec $ciexe_file ]
1176 # [ source $ci_file.out ]
1178 # I could give up on -E and just do this.
1179 # I didn't get desperate enough to try this.
1181 # -- chastain 2004-01-06
1183 proc get_compiler_info {binfile args} {
1184 # For compiler.c and compiler.cc
1187 # I am going to play with the log to keep noise out.
1191 # These come from compiler.c or compiler.cc
1192 global compiler_info
1194 global hp_cc_compiler
1195 global hp_aCC_compiler
1196 global signed_keyword_not_used
1198 # Choose which file to preprocess.
1199 set ifile "${srcdir}/lib/compiler.c"
1200 if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1201 set ifile "${srcdir}/lib/compiler.cc"
1204 # Run $ifile through the right preprocessor.
1205 # Toggle gdb.log to keep the compiler output out of the log.
1207 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
1208 log_file -a "$outdir/$tool.log"
1210 # Source the output.
1211 foreach cppline [ split "$cppout" "\n" ] {
1212 if { ! [ regexp "^#" "$cppline" ] } {
1213 if { ! [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
1214 verbose "get_compiler_info: $cppline" 2
1219 verbose -log "get_compiler_info: $compiler_info"
1221 # Most compilers will evaluate comparisons and other boolean
1222 # operations to 0 or 1.
1223 uplevel \#0 { set true 1 }
1224 uplevel \#0 { set false 0 }
1226 # Use of aCC results in boolean results being displayed as
1228 if { $hp_aCC_compiler } {
1229 uplevel \#0 { set true true }
1230 uplevel \#0 { set false false }
1236 proc test_compiler_info { compiler } {
1237 global compiler_info
1238 return [string match $compiler $compiler_info]
1241 set gdb_wrapper_initialized 0
1243 proc gdb_wrapper_init { args } {
1244 global gdb_wrapper_initialized;
1245 global gdb_wrapper_file;
1246 global gdb_wrapper_flags;
1248 if { $gdb_wrapper_initialized == 1 } { return; }
1250 if {[target_info exists needs_status_wrapper] && \
1251 [target_info needs_status_wrapper] != "0"} {
1252 set result [build_wrapper "testglue.o"];
1253 if { $result != "" } {
1254 set gdb_wrapper_file [lindex $result 0];
1255 set gdb_wrapper_flags [lindex $result 1];
1257 warning "Status wrapper failed to build."
1260 set gdb_wrapper_initialized 1
1263 proc gdb_compile {source dest type options} {
1264 global GDB_TESTCASE_OPTIONS;
1265 global gdb_wrapper_file;
1266 global gdb_wrapper_flags;
1267 global gdb_wrapper_initialized;
1269 if [target_info exists gdb_stub] {
1270 set options2 { "additional_flags=-Dusestubs" }
1271 lappend options "libs=[target_info gdb_stub]";
1272 set options [concat $options2 $options]
1274 if [target_info exists is_vxworks] {
1275 set options2 { "additional_flags=-Dvxworks" }
1276 lappend options "libs=[target_info gdb_stub]";
1277 set options [concat $options2 $options]
1279 if [info exists GDB_TESTCASE_OPTIONS] {
1280 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
1282 verbose "options are $options"
1283 verbose "source is $source $dest $type $options"
1285 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
1287 if {[target_info exists needs_status_wrapper] && \
1288 [target_info needs_status_wrapper] != "0" && \
1289 [info exists gdb_wrapper_file]} {
1290 lappend options "libs=${gdb_wrapper_file}"
1291 lappend options "ldflags=${gdb_wrapper_flags}"
1294 set result [target_compile $source $dest $type $options];
1295 regsub "\[\r\n\]*$" "$result" "" result;
1296 regsub "^\[\r\n\]*" "$result" "" result;
1297 if { $result != "" && [lsearch $options quiet] == -1} {
1298 clone_output "gdb compile failed, $result"
1304 # This is just like gdb_compile, above, except that it tries compiling
1305 # against several different thread libraries, to see which one this
1307 proc gdb_compile_pthreads {source dest type options} {
1309 set why_msg "unrecognized error"
1310 foreach lib {-lpthreads -lpthread -lthread} {
1311 # This kind of wipes out whatever libs the caller may have
1312 # set. Or maybe theirs will override ours. How infelicitous.
1313 set options_with_lib [concat $options [list libs=$lib quiet]]
1314 set ccout [gdb_compile $source $dest $type $options_with_lib]
1315 switch -regexp -- $ccout {
1316 ".*no posix threads support.*" {
1317 set why_msg "missing threads include file"
1320 ".*cannot open -lpthread.*" {
1321 set why_msg "missing runtime threads library"
1323 ".*Can't find library for -lpthread.*" {
1324 set why_msg "missing runtime threads library"
1327 pass "successfully compiled posix threads test case"
1333 if {!$built_binfile} {
1334 unsupported "Couldn't compile $source: ${why_msg}"
1339 # This is just like gdb_compile_pthreads, above, except that we always add the
1340 # objc library for compiling Objective-C programs
1341 proc gdb_compile_objc {source dest type options} {
1343 set why_msg "unrecognized error"
1344 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
1345 # This kind of wipes out whatever libs the caller may have
1346 # set. Or maybe theirs will override ours. How infelicitous.
1347 if { $lib == "solaris" } {
1348 set lib "-lpthread -lposix4"
1350 if { $lib != "-lobjc" } {
1351 set lib "-lobjc $lib"
1353 set options_with_lib [concat $options [list libs=$lib quiet]]
1354 set ccout [gdb_compile $source $dest $type $options_with_lib]
1355 switch -regexp -- $ccout {
1356 ".*no posix threads support.*" {
1357 set why_msg "missing threads include file"
1360 ".*cannot open -lpthread.*" {
1361 set why_msg "missing runtime threads library"
1363 ".*Can't find library for -lpthread.*" {
1364 set why_msg "missing runtime threads library"
1367 pass "successfully compiled objc with posix threads test case"
1373 if {!$built_binfile} {
1374 unsupported "Couldn't compile $source: ${why_msg}"
1379 proc send_gdb { string } {
1380 global suppress_flag;
1381 if { $suppress_flag } {
1382 return "suppressed";
1384 return [remote_send host "$string"];
1390 proc gdb_expect { args } {
1391 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
1392 set gtimeout [lindex $args 0];
1393 set expcode [list [lindex $args 1]];
1395 upvar timeout timeout;
1398 if [target_info exists gdb,timeout] {
1399 if [info exists timeout] {
1400 if { $timeout < [target_info gdb,timeout] } {
1401 set gtimeout [target_info gdb,timeout];
1403 set gtimeout $timeout;
1406 set gtimeout [target_info gdb,timeout];
1410 if ![info exists gtimeout] {
1412 if [info exists timeout] {
1413 set gtimeout $timeout;
1420 global suppress_flag;
1421 global remote_suppress_flag;
1422 if [info exists remote_suppress_flag] {
1423 set old_val $remote_suppress_flag;
1425 if [info exists suppress_flag] {
1426 if { $suppress_flag } {
1427 set remote_suppress_flag 1;
1431 {uplevel remote_expect host $gtimeout $expcode} string];
1432 if [info exists old_val] {
1433 set remote_suppress_flag $old_val;
1435 if [info exists remote_suppress_flag] {
1436 unset remote_suppress_flag;
1441 global errorInfo errorCode;
1443 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1444 } elseif {$code == 2} {
1445 return -code return $string
1446 } elseif {$code == 3} {
1448 } elseif {$code > 4} {
1449 return -code $code $string
1453 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
1455 # Check for long sequence of output by parts.
1456 # MESSAGE: is the test message to be printed with the test success/fail.
1457 # SENTINEL: Is the terminal pattern indicating that output has finished.
1458 # LIST: is the sequence of outputs to match.
1459 # If the sentinel is recognized early, it is considered an error.
1462 # 1 if the test failed,
1463 # 0 if the test passes,
1464 # -1 if there was an internal error.
1466 proc gdb_expect_list {test sentinel list} {
1468 global suppress_flag
1471 if { $suppress_flag } {
1473 unresolved "${test}"
1475 while { ${index} < [llength ${list}] } {
1476 set pattern [lindex ${list} ${index}]
1477 set index [expr ${index} + 1]
1478 if { ${index} == [llength ${list}] } {
1481 -re "${pattern}${sentinel}" {
1482 # pass "${test}, pattern ${index} + sentinel"
1485 fail "${test} (pattern ${index} + sentinel)"
1488 -re ".*A problem internal to GDB has been detected" {
1489 fail "${test} (GDB internal error)"
1491 gdb_internal_error_resync
1494 fail "${test} (pattern ${index} + sentinel) (timeout)"
1499 # unresolved "${test}, pattern ${index} + sentinel"
1505 # pass "${test}, pattern ${index}"
1508 fail "${test} (pattern ${index})"
1511 -re ".*A problem internal to GDB has been detected" {
1512 fail "${test} (GDB internal error)"
1514 gdb_internal_error_resync
1517 fail "${test} (pattern ${index}) (timeout)"
1522 # unresolved "${test}, pattern ${index}"
1536 proc gdb_suppress_entire_file { reason } {
1537 global suppress_flag;
1539 warning "$reason\n";
1540 set suppress_flag -1;
1544 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
1545 # gdb_expect to fail immediately (until the next call to
1546 # gdb_stop_suppressing_tests).
1548 proc gdb_suppress_tests { args } {
1549 global suppress_flag;
1551 return; # fnf - disable pending review of results where
1552 # testsuite ran better without this
1555 if { $suppress_flag == 1 } {
1556 if { [llength $args] > 0 } {
1557 warning "[lindex $args 0]\n";
1559 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
1565 # Clear suppress_flag.
1567 proc gdb_stop_suppressing_tests { } {
1568 global suppress_flag;
1570 if [info exists suppress_flag] {
1571 if { $suppress_flag > 0 } {
1572 set suppress_flag 0;
1573 clone_output "Tests restarted.\n";
1576 set suppress_flag 0;
1580 proc gdb_clear_suppressed { } {
1581 global suppress_flag;
1583 set suppress_flag 0;
1586 proc gdb_start { } {
1591 catch default_gdb_exit
1595 # gdb_load -- load a file into the debugger.
1596 # return a -1 if anything goes wrong.
1598 proc gdb_load { arg } {
1599 return [gdb_file_cmd $arg]
1602 proc gdb_continue { function } {
1605 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
1608 proc default_gdb_init { args } {
1609 global gdb_wrapper_initialized
1611 gdb_clear_suppressed;
1613 # Make sure that the wrapper is rebuilt
1614 # with the appropriate multilib option.
1615 set gdb_wrapper_initialized 0
1617 # Uh, this is lame. Really, really, really lame. But there's this *one*
1618 # testcase that will fail in random places if we don't increase this.
1621 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
1622 if { [llength $args] > 0 } {
1625 set file [lindex $args 0];
1627 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
1630 if [target_info exists gdb_prompt] {
1631 set gdb_prompt [target_info gdb_prompt];
1633 set gdb_prompt "\\(gdb\\)"
1637 proc gdb_init { args } {
1638 return [eval default_gdb_init $args];
1641 proc gdb_finish { } {
1646 set debug_format "unknown"
1648 # Run the gdb command "info source" and extract the debugging format
1649 # information from the output and save it in debug_format.
1651 proc get_debug_format { } {
1657 set debug_format "unknown"
1658 send_gdb "info source\n"
1660 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
1661 set debug_format $expect_out(1,string)
1662 verbose "debug format is $debug_format"
1665 -re "No current source file.\r\n$gdb_prompt $" {
1666 perror "get_debug_format used when no current source file"
1669 -re "$gdb_prompt $" {
1670 warning "couldn't check debug format (no valid response)."
1674 warning "couldn't check debug format (timed out)."
1680 # Return true if FORMAT matches the debug format the current test was
1681 # compiled with. FORMAT is a shell-style globbing pattern; it can use
1682 # `*', `[...]', and so on.
1684 # This function depends on variables set by `get_debug_format', above.
1686 proc test_debug_format {format} {
1689 return [expr [string match $format $debug_format] != 0]
1692 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
1693 # COFF, stabs, etc). If that format matches the format that the
1694 # current test was compiled with, then the next test is expected to
1695 # fail for any target. Returns 1 if the next test or set of tests is
1696 # expected to fail, 0 otherwise (or if it is unknown). Must have
1697 # previously called get_debug_format.
1698 proc setup_xfail_format { format } {
1699 set ret [test_debug_format $format];
1707 proc gdb_step_for_stub { } {
1710 if ![target_info exists gdb,use_breakpoint_for_stub] {
1711 if [target_info exists gdb_stub_step_command] {
1712 set command [target_info gdb_stub_step_command];
1716 send_gdb "${command}\n";
1719 -re "(main.* at |.*in .*start).*$gdb_prompt" {
1722 -re ".*$gdb_prompt" {
1724 if { $tries == 5 } {
1725 fail "stepping out of breakpoint function";
1728 send_gdb "${command}\n";
1732 fail "stepping out of breakpoint function";
1739 -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
1740 set file $expect_out(1,string);
1741 set linenum [expr $expect_out(2,string) + 1];
1742 set breakplace "${file}:${linenum}";
1746 send_gdb "break ${breakplace}\n";
1748 -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
1749 set breakpoint $expect_out(1,string);
1751 -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
1752 set breakpoint $expect_out(1,string);
1756 send_gdb "continue\n";
1758 -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
1759 gdb_test "delete $breakpoint" ".*" "";
1766 ### gdb_get_line_number TEXT [FILE]
1768 ### Search the source file FILE, and return the line number of a line
1769 ### containing TEXT. Use this function instead of hard-coding line
1770 ### numbers into your test script.
1772 ### Specifically, this function uses GDB's "search" command to search
1773 ### FILE for the first line containing TEXT, and returns its line
1774 ### number. Thus, FILE must be a source file, compiled into the
1775 ### executable you are running. If omitted, FILE defaults to the
1776 ### value of the global variable `srcfile'; most test scripts set
1777 ### `srcfile' appropriately at the top anyway.
1779 ### Use this function to keep your test scripts independent of the
1780 ### exact line numbering of the source file. Don't write:
1782 ### send_gdb "break 20"
1784 ### This means that if anyone ever edits your test's source file,
1785 ### your test could break. Instead, put a comment like this on the
1786 ### source file line you want to break at:
1788 ### /* breakpoint spot: frotz.exp: test name */
1790 ### and then write, in your test script (which we assume is named
1793 ### send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
1795 ### (Yes, Tcl knows how to handle the nested quotes and brackets.
1798 ### % puts "foo [lindex "bar baz" 1]"
1801 ### Tcl is quite clever, for a little stringy language.)
1803 proc gdb_get_line_number {text {file /omitted/}} {
1807 if {! [string compare $file /omitted/]} {
1812 gdb_test "list ${file}:1,1" ".*" ""
1813 send_gdb "search ${text}\n"
1815 -re "\[\r\n\]+(\[0-9\]+)\[ \t\].*${text}.*$gdb_prompt $" {
1816 set result $expect_out(1,string)
1818 -re ".*$gdb_prompt $" {
1819 fail "find line number containing \"${text}\""
1822 fail "find line number containing \"${text}\" (timeout)"
1828 # gdb_continue_to_end:
1829 # The case where the target uses stubs has to be handled specially. If a
1830 # stub is used, we set a breakpoint at exit because we cannot rely on
1831 # exit() behavior of a remote target.
1833 # mssg is the error message that gets printed.
1835 proc gdb_continue_to_end {mssg} {
1836 if [target_info exists use_gdb_stub] {
1837 if {![gdb_breakpoint "exit"]} {
1840 gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
1841 "continue until exit at $mssg"
1843 # Continue until we exit. Should not stop again.
1844 # Don't bother to check the output of the program, that may be
1845 # extremely tough for some remote systems.
1846 gdb_test "continue"\
1847 "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|Program exited normally\\.).*"\
1848 "continue until exit at $mssg"
1852 proc rerun_to_main {} {
1855 if [target_info exists use_gdb_stub] {
1858 -re ".*Breakpoint .*main .*$gdb_prompt $"\
1859 {pass "rerun to main" ; return 0}
1860 -re "$gdb_prompt $"\
1861 {fail "rerun to main" ; return 0}
1862 timeout {fail "(timeout) rerun to main" ; return 0}
1867 -re "The program .* has been started already.*y or n. $" {
1871 -re "Starting program.*$gdb_prompt $"\
1872 {pass "rerun to main" ; return 0}
1873 -re "$gdb_prompt $"\
1874 {fail "rerun to main" ; return 0}
1875 timeout {fail "(timeout) rerun to main" ; return 0}
1880 # Print a message and return true if a test should be skipped
1881 # due to lack of floating point suport.
1883 proc gdb_skip_float_test { msg } {
1884 if [target_info exists gdb,skip_float_tests] {
1885 verbose "Skipping test '$msg': no float tests.";
1891 # Print a message and return true if a test should be skipped
1892 # due to lack of stdio support.
1894 proc gdb_skip_stdio_test { msg } {
1895 if [target_info exists gdb,noinferiorio] {
1896 verbose "Skipping test '$msg': no inferior i/o.";
1902 proc gdb_skip_bogus_test { msg } {
1907 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
1908 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
1909 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
1910 # the name of a idebuginfo only file. This file will be stored in the
1911 # gdb.base/.debug subdirectory.
1913 # Functions for separate debug info testing
1915 # starting with an executable:
1916 # foo --> original executable
1918 # at the end of the process we have:
1919 # foo.stripped --> foo w/o debug info
1920 # .debug/foo.debug --> foo's debug info
1921 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
1923 # Return the name of the file in which we should stor EXEC's separated
1924 # debug info. EXEC contains the full path.
1925 proc separate_debug_filename { exec } {
1927 # In a .debug subdirectory off the same directory where the testcase
1928 # executable is going to be. Something like:
1929 # <your-path>/gdb/testsuite/gdb.base/.debug/blah.debug.
1930 # This is the default location where gdb expects to findi
1931 # the debug info file.
1933 set exec_dir [file dirname $exec]
1934 set exec_file [file tail $exec]
1935 set debug_dir [file join $exec_dir ".debug"]
1936 set debug_file [file join $debug_dir "${exec_file}.debug"]
1942 proc gdb_gnu_strip_debug { dest } {
1944 set debug_file [separate_debug_filename $dest]
1945 set strip_to_file_program strip
1946 set objcopy_program objcopy
1948 # Make sure the directory that will hold the separated debug
1949 # info actually exists.
1950 set debug_dir [file dirname $debug_file]
1951 if {! [file isdirectory $debug_dir]} {
1952 file mkdir $debug_dir
1955 set debug_link [file tail $debug_file]
1956 set stripped_file "${dest}.stripped"
1958 # Get rid of the debug info, and store result in stripped_file
1959 # something like gdb/testsuite/gdb.base/blah.stripped.
1960 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
1961 verbose "result is $result"
1962 verbose "output is $output"
1967 # Get rid of everything but the debug info, and store result in debug_file
1968 # This will be in the .debug subdirectory, see above.
1969 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
1970 verbose "result is $result"
1971 verbose "output is $output"
1976 # Link the two previous output files together, adding the .gnu_debuglink
1977 # section to the stripped_file, containing a pointer to the debug_file,
1978 # save the new file in dest.
1979 # This will be the regular executable filename, in the usual location.
1980 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
1981 verbose "result is $result"
1982 verbose "output is $output"