1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
2 # 2003, 2004, 2005, 2007 Free Software Foundation, Inc.
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # This file was written by Fred Fish. (fnf@cygnus.com)
19 # Generic gdb subroutines that should work for any target. If these
20 # need to be modified for any target, it can be done with a variable
21 # or by passing arguments.
24 # Tests would fail, logs on get_compiler_info() would be missing.
25 send_error "`site.exp' not found, run `make site.exp'!\n"
33 if [info exists TOOL_EXECUTABLE] {
34 set GDB $TOOL_EXECUTABLE;
36 if ![info exists GDB] {
37 if ![is_remote host] {
38 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
40 set GDB [transform gdb];
43 verbose "using GDB = $GDB" 2
46 if ![info exists GDBFLAGS] {
49 verbose "using GDBFLAGS = $GDBFLAGS" 2
51 # The variable gdb_prompt is a regexp which matches the gdb prompt.
52 # Set it if it is not already set.
54 if ![info exists gdb_prompt] then {
55 set gdb_prompt "\[(\]gdb\[)\]"
58 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
59 # absolute path ie. /foo/
60 set fullname_syntax_POSIX "/.*/"
61 # The variable fullname_syntax_UNC is a regexp which matches a Windows
62 # UNC path ie. \\D\foo\
63 set fullname_syntax_UNC {\\\\[^\\]+\\.+\\}
64 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
65 # particular DOS case that GDB most likely will output
66 # ie. \foo\, but don't match \\.*\
67 set fullname_syntax_DOS_CASE {\\[^\\].*\\}
68 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
69 # ie. a:\foo\ && a:foo\
70 set fullname_syntax_DOS {[a-zA-Z]:.*\\}
71 # The variable fullname_syntax is a regexp which matches what GDB considers
72 # an absolute path. It is currently debatable if the Windows style paths
73 # d:foo and \abc should be considered valid as an absolute path.
74 # Also, the purpse of this regexp is not to recognize a well formed
75 # absolute path, but to say with certainty that a path is absolute.
76 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
78 # Needed for some tests under Cygwin.
82 if ![info exists env(EXEEXT)] {
85 set EXEEXT $env(EXEEXT)
88 ### Only procedures should come after this point.
91 # gdb_version -- extract and print the version number of GDB
93 proc default_gdb_version {} {
97 set fileid [open "gdb_cmd" w];
100 set cmdfile [remote_download host "gdb_cmd"];
101 set output [remote_exec host "$GDB -nw --command $cmdfile"]
102 remote_file build delete "gdb_cmd";
103 remote_file host delete "$cmdfile";
104 set tmp [lindex $output 1];
106 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
107 if ![is_remote host] {
108 clone_output "[which $GDB] version $version $GDBFLAGS\n"
110 clone_output "$GDB on remote host version $version $GDBFLAGS\n"
114 proc gdb_version { } {
115 return [default_gdb_version];
119 # gdb_unload -- unload a file if one is loaded
128 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
129 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
130 -re "A program is being debugged already..*Kill it.*y or n. $"\
132 verbose "\t\tKilling previous program being debugged"
135 -re "Discard symbol table from .*y or n.*$" {
139 -re "$gdb_prompt $" {}
141 perror "couldn't unload file in $GDB (timed out)."
147 # Many of the tests depend on setting breakpoints at various places and
148 # running until that breakpoint is reached. At times, we want to start
149 # with a clean-slate with respect to breakpoints, so this utility proc
150 # lets us do this without duplicating this code everywhere.
153 proc delete_breakpoints {} {
156 # we need a larger timeout value here or this thing just confuses
157 # itself. May need a better implementation if possible. - guo
159 send_gdb "delete breakpoints\n"
161 -re "Delete all breakpoints.*y or n.*$" {
165 -re "$gdb_prompt $" { # This happens if there were no breakpoints
167 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
169 send_gdb "info breakpoints\n"
171 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
172 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
173 -re "Delete all breakpoints.*or n.*$" {
177 timeout { perror "info breakpoints (timeout)" ; return }
183 # Generic run command.
185 # The second pattern below matches up to the first newline *only*.
186 # Using ``.*$'' could swallow up output that we attempt to match
189 proc gdb_run_cmd {args} {
192 if [target_info exists gdb_init_command] {
193 send_gdb "[target_info gdb_init_command]\n";
195 -re "$gdb_prompt $" { }
197 perror "gdb_init_command for target failed";
203 if [target_info exists use_gdb_stub] {
204 if [target_info exists gdb,do_reload_on_run] {
205 if { [gdb_reload] != 0 } {
208 send_gdb "continue\n";
210 -re "Continu\[^\r\n\]*\[\r\n\]" {}
216 if [target_info exists gdb,start_symbol] {
217 set start [target_info gdb,start_symbol];
221 send_gdb "jump *$start\n"
223 while { $start_attempt } {
224 # Cap (re)start attempts at three to ensure that this loop
225 # always eventually fails. Don't worry about trying to be
226 # clever and not send a command when it has failed.
227 if [expr $start_attempt > 3] {
228 perror "Jump to start() failed (retry count exceeded)";
231 set start_attempt [expr $start_attempt + 1];
233 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
236 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
237 perror "Can't find start symbol to run in gdb_run";
240 -re "No symbol \"start\" in current.*$gdb_prompt $" {
241 send_gdb "jump *_start\n";
243 -re "No symbol.*context.*$gdb_prompt $" {
246 -re "Line.* Jump anyway.*y or n. $" {
249 -re "The program is not being run.*$gdb_prompt $" {
250 if { [gdb_reload] != 0 } {
253 send_gdb "jump *$start\n";
256 perror "Jump to start() failed (timeout)";
261 if [target_info exists gdb_stub] {
263 -re "$gdb_prompt $" {
264 send_gdb "continue\n"
271 if [target_info exists gdb,do_reload_on_run] {
272 if { [gdb_reload] != 0 } {
276 send_gdb "run $args\n"
277 # This doesn't work quite right yet.
279 -re "The program .* has been started already.*y or n. $" {
283 # Use -notransfer here so that test cases (like chng-sym.exp)
284 # may test for additional start-up messages.
285 -notransfer -re "Starting program: \[^\r\n\]*" {}
289 # Generic start command. Return 0 if we could start the program, -1
292 proc gdb_start_cmd {args} {
295 if [target_info exists gdb_init_command] {
296 send_gdb "[target_info gdb_init_command]\n";
298 -re "$gdb_prompt $" { }
300 perror "gdb_init_command for target failed";
306 if [target_info exists use_gdb_stub] {
310 send_gdb "start $args\n"
312 -re "The program .* has been started already.*y or n. $" {
316 # Use -notransfer here so that test cases (like chng-sym.exp)
317 # may test for additional start-up messages.
318 -notransfer -re "Starting program: \[^\r\n\]*" {
325 # Set a breakpoint at FUNCTION. If there is an additional argument it is
326 # a list of options; the supported options are allow-pending and temporary.
328 proc gdb_breakpoint { function args } {
332 set pending_response n
333 if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
334 set pending_response y
337 set break_command "break"
338 if {[lsearch -exact [lindex $args 0] temporary] != -1} {
339 set break_command "tbreak"
342 send_gdb "$break_command $function\n"
343 # The first two regexps are what we get with -g, the third is without -g.
345 -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
346 -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
347 -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
348 -re "Breakpoint \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
349 if {$pending_response == "n"} {
350 fail "setting breakpoint at $function"
354 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
355 send_gdb "$pending_response\n"
358 -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
359 timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
364 # Set breakpoint at function and run gdb until it breaks there.
365 # Since this is the only breakpoint that will be set, if it stops
366 # at a breakpoint, we will assume it is the one we want. We can't
367 # just compare to "function" because it might be a fully qualified,
368 # single quoted C++ function specifier. If there's an additional argument,
369 # pass it to gdb_breakpoint.
371 proc runto { function args } {
377 if ![gdb_breakpoint $function [lindex $args 0]] {
383 # the "at foo.c:36" output we get with -g.
384 # the "in func" output we get without -g.
386 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
389 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
392 -re "$gdb_prompt $" {
393 fail "running to $function in runto"
397 fail "running to $function in runto (timeout)"
405 # runto_main -- ask gdb to run until we hit a breakpoint at main.
406 # The case where the target uses stubs has to be handled
407 # specially--if it uses stubs, assuming we hit
408 # breakpoint() and just step out of the function.
410 proc runto_main { } {
414 if ![target_info exists gdb_stub] {
426 ### Continue, and expect to hit a breakpoint.
427 ### Report a pass or fail, depending on whether it seems to have
428 ### worked. Use NAME as part of the test name; each call to
429 ### continue_to_breakpoint should use a NAME which is unique within
431 proc gdb_continue_to_breakpoint {name} {
433 set full_name "continue to breakpoint: $name"
435 send_gdb "continue\n"
437 -re "Breakpoint .* at .*\r\n$gdb_prompt $" {
440 -re ".*$gdb_prompt $" {
444 fail "$full_name (timeout)"
450 # gdb_internal_error_resync:
452 # Answer the questions GDB asks after it reports an internal error
453 # until we get back to a GDB prompt. Decline to quit the debugging
454 # session, and decline to create a core file. Return non-zero if the
457 # This procedure just answers whatever questions come up until it sees
458 # a GDB prompt; it doesn't require you to have matched the input up to
459 # any specific point. However, it only answers questions it sees in
460 # the output itself, so if you've matched a question, you had better
461 # answer it yourself before calling this.
463 # You can use this function thus:
467 # -re ".*A problem internal to GDB has been detected" {
468 # gdb_internal_error_resync
473 proc gdb_internal_error_resync {} {
477 while {$count < 10} {
479 -re "Quit this debugging session\\? \\(y or n\\) $" {
483 -re "Create a core file of GDB\\? \\(y or n\\) $" {
487 -re "$gdb_prompt $" {
488 # We're resynchronized.
492 perror "Could not resync from internal error (timeout)"
497 perror "Could not resync from internal error (resync count exceeded)"
502 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
503 # Send a command to gdb; test the result.
505 # COMMAND is the command to execute, send to GDB with send_gdb. If
506 # this is the null string no command is sent.
507 # MESSAGE is a message to be printed with the built-in failure patterns
508 # if one of them matches. If MESSAGE is empty COMMAND will be used.
509 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
510 # patterns. Pattern elements will be evaluated in the caller's
511 # context; action elements will be executed in the caller's context.
512 # Unlike patterns for gdb_test, these patterns should generally include
513 # the final newline and prompt.
516 # 1 if the test failed, according to a built-in failure pattern
517 # 0 if only user-supplied patterns matched
518 # -1 if there was an internal error.
520 # You can use this function thus:
522 # gdb_test_multiple "print foo" "test foo" {
523 # -re "expected output 1" {
526 # -re "expected output 2" {
531 # The standard patterns, such as "Program exited..." and "A problem
532 # ...", all being implicitly appended to that list.
534 proc gdb_test_multiple { command message user_code } {
538 upvar timeout timeout
539 upvar expect_out expect_out
541 if { $message == "" } {
545 # TCL/EXPECT WART ALERT
546 # Expect does something very strange when it receives a single braced
547 # argument. It splits it along word separators and performs substitutions.
548 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
549 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
550 # double-quoted list item, "\[ab\]" is just a long way of representing
551 # "[ab]", because the backslashes will be removed by lindex.
553 # Unfortunately, there appears to be no easy way to duplicate the splitting
554 # that expect will do from within TCL. And many places make use of the
555 # "\[0-9\]" construct, so we need to support that; and some places make use
556 # of the "[func]" construct, so we need to support that too. In order to
557 # get this right we have to substitute quoted list elements differently
558 # from braced list elements.
560 # We do this roughly the same way that Expect does it. We have to use two
561 # lists, because if we leave unquoted newlines in the argument to uplevel
562 # they'll be treated as command separators, and if we escape newlines
563 # we mangle newlines inside of command blocks. This assumes that the
564 # input doesn't contain a pattern which contains actual embedded newlines
567 regsub -all {\n} ${user_code} { } subst_code
568 set subst_code [uplevel list $subst_code]
570 set processed_code ""
572 set expecting_action 0
573 foreach item $user_code subst_item $subst_code {
574 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
575 lappend processed_code $item
578 if {$item == "-indices" || $item == "-re" || $item == "-ex"} {
579 lappend processed_code $item
582 if { $expecting_action } {
583 lappend processed_code "uplevel [list $item]"
584 set expecting_action 0
585 # Cosmetic, no effect on the list.
586 append processed_code "\n"
589 set expecting_action 1
590 lappend processed_code $subst_item
591 if {$patterns != ""} {
594 append patterns "\"$subst_item\""
597 # Also purely cosmetic.
598 regsub -all {\r} $patterns {\\r} patterns
599 regsub -all {\n} $patterns {\\n} patterns
602 send_user "Sending \"$command\" to gdb\n"
603 send_user "Looking to match \"$patterns\"\n"
604 send_user "Message is \"$message\"\n"
608 set string "${command}\n";
609 if { $command != "" } {
610 while { "$string" != "" } {
611 set foo [string first "\n" "$string"];
612 set len [string length "$string"];
613 if { $foo < [expr $len - 1] } {
614 set str [string range "$string" 0 $foo];
615 if { [send_gdb "$str"] != "" } {
616 global suppress_flag;
618 if { ! $suppress_flag } {
619 perror "Couldn't send $command to GDB.";
624 # since we're checking if each line of the multi-line
625 # command are 'accepted' by GDB here,
626 # we need to set -notransfer expect option so that
627 # command output is not lost for pattern matching
630 -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
631 timeout { verbose "partial: timeout" 3 }
633 set string [string range "$string" [expr $foo + 1] end];
638 if { "$string" != "" } {
639 if { [send_gdb "$string"] != "" } {
640 global suppress_flag;
642 if { ! $suppress_flag } {
643 perror "Couldn't send $command to GDB.";
651 if [target_info exists gdb,timeout] {
652 set tmt [target_info gdb,timeout];
654 if [info exists timeout] {
658 if [info exists timeout] {
667 -re ".*A problem internal to GDB has been detected" {
668 fail "$message (GDB internal error)"
669 gdb_internal_error_resync
671 -re "\\*\\*\\* DOSEXIT code.*" {
672 if { $message != "" } {
675 gdb_suppress_entire_file "GDB died";
679 append code $processed_code
681 -re "Ending remote debugging.*$gdb_prompt $" {
682 if ![isnative] then {
683 warning "Can`t communicate to remote target."
689 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
690 perror "Undefined command \"$command\"."
694 -re "Ambiguous command.*$gdb_prompt $" {
695 perror "\"$command\" is not a unique command name."
699 -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
700 if ![string match "" $message] then {
701 set errmsg "$message (the program exited)"
703 set errmsg "$command (the program exited)"
708 -re "EXIT code \[0-9\r\n\]+Program exited normally.*$gdb_prompt $" {
709 if ![string match "" $message] then {
710 set errmsg "$message (the program exited)"
712 set errmsg "$command (the program exited)"
717 -re "The program is not being run.*$gdb_prompt $" {
718 if ![string match "" $message] then {
719 set errmsg "$message (the program is no longer running)"
721 set errmsg "$command (the program is no longer running)"
726 -re "\r\n$gdb_prompt $" {
727 if ![string match "" $message] then {
734 perror "Window too small."
738 -re "\\(y or n\\) " {
740 perror "Got interactive prompt."
745 perror "Process no longer exists"
746 if { $message != "" } {
752 perror "internal buffer is full."
757 if ![string match "" $message] then {
758 fail "$message (timeout)"
765 set code [catch {gdb_expect $tmt $code} string]
767 global errorInfo errorCode;
768 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
769 } elseif {$code == 2} {
770 return -code return $string
771 } elseif {$code == 3} {
773 } elseif {$code > 4} {
774 return -code $code $string
779 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
780 # Send a command to gdb; test the result.
782 # COMMAND is the command to execute, send to GDB with send_gdb. If
783 # this is the null string no command is sent.
784 # PATTERN is the pattern to match for a PASS, and must NOT include
785 # the \r\n sequence immediately before the gdb prompt.
786 # MESSAGE is an optional message to be printed. If this is
787 # omitted, then the pass/fail messages use the command string as the
788 # message. (If this is the empty string, then sometimes we don't
789 # call pass or fail at all; I don't understand this at all.)
790 # QUESTION is a question GDB may ask in response to COMMAND, like
792 # RESPONSE is the response to send if QUESTION appears.
795 # 1 if the test failed,
796 # 0 if the test passes,
797 # -1 if there was an internal error.
799 proc gdb_test { args } {
803 upvar timeout timeout
805 if [llength $args]>2 then {
806 set message [lindex $args 2]
808 set message [lindex $args 0]
810 set command [lindex $args 0]
811 set pattern [lindex $args 1]
813 if [llength $args]==5 {
814 set question_string [lindex $args 3];
815 set response_string [lindex $args 4];
817 set question_string "^FOOBAR$"
820 return [gdb_test_multiple $command $message {
821 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
822 if ![string match "" $message] then {
826 -re "(${question_string})$" {
827 send_gdb "$response_string\n";
833 # Test that a command gives an error. For pass or fail, return
834 # a 1 to indicate that more tests can proceed. However a timeout
835 # is a serious error, generates a special fail message, and causes
836 # a 0 to be returned to indicate that more tests are likely to fail
839 proc test_print_reject { args } {
843 if [llength $args]==2 then {
844 set expectthis [lindex $args 1]
846 set expectthis "should never match this bogus string"
848 set sendthis [lindex $args 0]
850 send_user "Sending \"$sendthis\" to gdb\n"
851 send_user "Looking to match \"$expectthis\"\n"
853 send_gdb "$sendthis\n"
854 #FIXME: Should add timeout as parameter.
856 -re "A .* in expression.*\\.*$gdb_prompt $" {
857 pass "reject $sendthis"
860 -re "Invalid syntax in expression.*$gdb_prompt $" {
861 pass "reject $sendthis"
864 -re "Junk after end of expression.*$gdb_prompt $" {
865 pass "reject $sendthis"
868 -re "Invalid number.*$gdb_prompt $" {
869 pass "reject $sendthis"
872 -re "Invalid character constant.*$gdb_prompt $" {
873 pass "reject $sendthis"
876 -re "No symbol table is loaded.*$gdb_prompt $" {
877 pass "reject $sendthis"
880 -re "No symbol .* in current context.*$gdb_prompt $" {
881 pass "reject $sendthis"
884 -re "Unmatched single quote.*$gdb_prompt $" {
885 pass "reject $sendthis"
888 -re "A character constant must contain at least one character.*$gdb_prompt $" {
889 pass "reject $sendthis"
892 -re "$expectthis.*$gdb_prompt $" {
893 pass "reject $sendthis"
896 -re ".*$gdb_prompt $" {
897 fail "reject $sendthis"
901 fail "reject $sendthis (eof or timeout)"
907 # Given an input string, adds backslashes as needed to create a
908 # regexp that will match the string.
910 proc string_to_regexp {str} {
912 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
916 # Same as gdb_test, but the second parameter is not a regexp,
917 # but a string that must match exactly.
919 proc gdb_test_exact { args } {
920 upvar timeout timeout
922 set command [lindex $args 0]
924 # This applies a special meaning to a null string pattern. Without
925 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
926 # messages from commands that should have no output except a new
927 # prompt. With this, only results of a null string will match a null
930 set pattern [lindex $args 1]
931 if [string match $pattern ""] {
932 set pattern [string_to_regexp [lindex $args 0]]
934 set pattern [string_to_regexp [lindex $args 1]]
937 # It is most natural to write the pattern argument with only
938 # embedded \n's, especially if you are trying to avoid Tcl quoting
939 # problems. But gdb_expect really wants to see \r\n in patterns. So
940 # transform the pattern here. First transform \r\n back to \n, in
941 # case some users of gdb_test_exact already do the right thing.
942 regsub -all "\r\n" $pattern "\n" pattern
943 regsub -all "\n" $pattern "\r\n" pattern
944 if [llength $args]==3 then {
945 set message [lindex $args 2]
950 return [gdb_test $command $pattern $message]
953 proc gdb_reinitialize_dir { subdir } {
956 if [is_remote host] {
961 -re "Reinitialize source path to empty.*y or n. " {
964 -re "Source directories searched.*$gdb_prompt $" {
965 send_gdb "dir $subdir\n"
967 -re "Source directories searched.*$gdb_prompt $" {
968 verbose "Dir set to $subdir"
970 -re "$gdb_prompt $" {
971 perror "Dir \"$subdir\" failed."
975 -re "$gdb_prompt $" {
976 perror "Dir \"$subdir\" failed."
980 -re "$gdb_prompt $" {
981 perror "Dir \"$subdir\" failed."
987 # gdb_exit -- exit the GDB, killing the target program if necessary
989 proc default_gdb_exit {} {
995 gdb_stop_suppressing_tests;
997 if ![info exists gdb_spawn_id] {
1001 verbose "Quitting $GDB $GDBFLAGS"
1003 if { [is_remote host] && [board_info host exists fileid] } {
1010 -re "DOSEXIT code" { }
1015 if ![is_remote host] {
1021 # Load a file into the debugger.
1022 # The return value is 0 for success, -1 for failure.
1024 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1025 # to one of these values:
1027 # debug file was loaded successfully and has debug information
1028 # nodebug file was loaded successfully and has no debug information
1029 # fail file was not loaded
1031 # I tried returning this information as part of the return value,
1032 # but ran into a mess because of the many re-implementations of
1033 # gdb_load in config/*.exp.
1035 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1036 # this if they can get more information set.
1038 proc gdb_file_cmd { arg } {
1042 global last_loaded_file
1044 set last_loaded_file $arg
1046 # Set whether debug info was found.
1047 # Default to "fail".
1048 global gdb_file_cmd_debug_info
1049 set gdb_file_cmd_debug_info "fail"
1051 if [is_remote host] {
1052 set arg [remote_download host $arg]
1054 perror "download failed"
1059 # The file command used to kill the remote target. For the benefit
1060 # of the testsuite, preserve this behavior.
1063 -re "Kill the program being debugged. .y or n. $" {
1065 verbose "\t\tKilling previous program being debugged"
1068 -re "$gdb_prompt $" {
1073 send_gdb "file $arg\n"
1075 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1076 verbose "\t\tLoaded $arg into the $GDB with no debugging symbols"
1077 set gdb_file_cmd_debug_info "nodebug"
1080 -re "Reading symbols from.*done.*$gdb_prompt $" {
1081 verbose "\t\tLoaded $arg into the $GDB"
1082 set gdb_file_cmd_debug_info "debug"
1085 -re "Load new symbol table from \".*\".*y or n. $" {
1088 -re "Reading symbols from.*done.*$gdb_prompt $" {
1089 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1090 set gdb_file_cmd_debug_info "debug"
1094 perror "(timeout) Couldn't load $arg, other program already loaded."
1099 -re "No such file or directory.*$gdb_prompt $" {
1100 perror "($arg) No such file or directory"
1103 -re "$gdb_prompt $" {
1104 perror "couldn't load $arg into $GDB."
1108 perror "couldn't load $arg into $GDB (timed out)."
1112 # This is an attempt to detect a core dump, but seems not to
1113 # work. Perhaps we need to match .* followed by eof, in which
1114 # gdb_expect does not seem to have a way to do that.
1115 perror "couldn't load $arg into $GDB (end of file)."
1122 # start gdb -- start gdb running, default procedure
1124 # When running over NFS, particularly if running many simultaneous
1125 # tests on different hosts all using the same server, things can
1126 # get really slow. Give gdb at least 3 minutes to start up.
1128 proc default_gdb_start { } {
1134 global gdb_spawn_id;
1136 gdb_stop_suppressing_tests;
1138 verbose "Spawning $GDB -nw $GDBFLAGS"
1140 if [info exists gdb_spawn_id] {
1144 if ![is_remote host] {
1145 if { [which $GDB] == 0 } then {
1146 perror "$GDB does not exist."
1150 set res [remote_spawn host "$GDB -nw $GDBFLAGS [host_info gdb_opts]"];
1151 if { $res < 0 || $res == "" } {
1152 perror "Spawning $GDB failed."
1156 -re "\[\r\n\]$gdb_prompt $" {
1157 verbose "GDB initialized."
1159 -re "$gdb_prompt $" {
1160 perror "GDB never initialized."
1164 perror "(timeout) GDB never initialized after 10 seconds."
1169 set gdb_spawn_id -1;
1170 # force the height to "unlimited", so no pagers get used
1172 send_gdb "set height 0\n"
1174 -re "$gdb_prompt $" {
1175 verbose "Setting height to 0." 2
1178 warning "Couldn't set the height to 0"
1181 # force the width to "unlimited", so no wraparound occurs
1182 send_gdb "set width 0\n"
1184 -re "$gdb_prompt $" {
1185 verbose "Setting width to 0." 2
1188 warning "Couldn't set the width to 0."
1194 # Return a 1 for configurations for which we don't even want to try to
1197 proc skip_cplus_tests {} {
1198 if { [istarget "h8300-*-*"] } {
1202 # The C++ IO streams are too large for HC11/HC12 and are thus not
1203 # available. The gdb C++ tests use them and don't compile.
1204 if { [istarget "m6811-*-*"] } {
1207 if { [istarget "m6812-*-*"] } {
1213 # Return a 1 if I don't even want to try to test FORTRAN.
1215 proc skip_fortran_tests {} {
1219 # Return a 1 if we should skip shared library tests.
1221 proc skip_shlib_tests {} {
1222 # Run the shared library tests on native systems.
1227 # An abbreviated list of remote targets where we should be able to
1228 # run shared library tests.
1229 if {([istarget *-*-linux*]
1230 || [istarget *-*-*bsd*]
1231 || [istarget *-*-solaris2*]
1232 || [istarget arm*-*-symbianelf*]
1233 || [istarget *-*-mingw*]
1234 || [istarget *-*-cygwin*]
1235 || [istarget *-*-pe*])} {
1242 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1243 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1245 proc skip_altivec_tests {} {
1246 global skip_vmx_tests_saved
1247 global srcdir subdir gdb_prompt
1249 # Use the cached value, if it exists.
1250 set me "skip_altivec_tests"
1251 if [info exists skip_vmx_tests_saved] {
1252 verbose "$me: returning saved $skip_vmx_tests_saved" 2
1253 return $skip_vmx_tests_saved
1256 # Some simulators are known to not support VMX instructions.
1257 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1258 verbose "$me: target known to not support VMX, returning 1" 2
1259 return [set skip_vmx_tests_saved 1]
1262 # Make sure we have a compiler that understands altivec.
1263 set compile_flags {debug nowarnings}
1264 if [get_compiler_info not-used] {
1265 warning "Could not get compiler info"
1268 if [test_compiler_info gcc*] {
1269 set compile_flags "$compile_flags additional_flags=-maltivec"
1270 } elseif [test_compiler_info xlc*] {
1271 set compile_flags "$compile_flags additional_flags=-qaltivec"
1273 verbose "Could not compile with altivec support, returning 1" 2
1277 # Set up, compile, and execute a test program containing VMX instructions.
1278 # Include the current process ID in the file names to prevent conflicts
1279 # with invocations for multiple testsuites.
1283 set f [open $src "w"]
1284 puts $f "int main() {"
1285 puts $f "#ifdef __MACH__"
1286 puts $f " asm volatile (\"vor v0,v0,v0\");"
1288 puts $f " asm volatile (\"vor 0,0,0\");"
1290 puts $f " return 0; }"
1293 verbose "$me: compiling testfile $src" 2
1294 set lines [gdb_compile $src $exe executable $compile_flags]
1297 if ![string match "" $lines] then {
1298 verbose "$me: testfile compilation failed, returning 1" 2
1299 return [set skip_vmx_tests_saved 1]
1302 # No error message, compilation succeeded so now run it via gdb.
1306 gdb_reinitialize_dir $srcdir/$subdir
1310 -re ".*Illegal instruction.*${gdb_prompt} $" {
1311 verbose -log "\n$me altivec hardware not detected"
1312 set skip_vmx_tests_saved 1
1314 -re ".*Program exited normally.*${gdb_prompt} $" {
1315 verbose -log "\n$me: altivec hardware detected"
1316 set skip_vmx_tests_saved 0
1319 warning "\n$me: default case taken"
1320 set skip_vmx_tests_saved 1
1324 remote_file build delete $exe
1326 verbose "$me: returning $skip_vmx_tests_saved" 2
1327 return $skip_vmx_tests_saved
1330 # Skip all the tests in the file if you are not on an hppa running
1333 proc skip_hp_tests {} {
1334 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
1335 verbose "Skip hp tests is $skip_hp"
1339 set compiler_info "unknown"
1341 set hp_cc_compiler 0
1342 set hp_aCC_compiler 0
1344 # Figure out what compiler I am using.
1346 # BINFILE is a "compiler information" output file. This implementation
1347 # does not use BINFILE.
1349 # ARGS can be empty or "C++". If empty, "C" is assumed.
1351 # There are several ways to do this, with various problems.
1353 # [ gdb_compile -E $ifile -o $binfile.ci ]
1354 # source $binfile.ci
1356 # Single Unix Spec v3 says that "-E -o ..." together are not
1357 # specified. And in fact, the native compiler on hp-ux 11 (among
1358 # others) does not work with "-E -o ...". Most targets used to do
1359 # this, and it mostly worked, because it works with gcc.
1361 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1362 # source $binfile.ci
1364 # This avoids the problem with -E and -o together. This almost works
1365 # if the build machine is the same as the host machine, which is
1366 # usually true of the targets which are not gcc. But this code does
1367 # not figure which compiler to call, and it always ends up using the C
1368 # compiler. Not good for setting hp_aCC_compiler. Targets
1369 # hppa*-*-hpux* and mips*-*-irix* used to do this.
1371 # [ gdb_compile -E $ifile > $binfile.ci ]
1372 # source $binfile.ci
1374 # dejagnu target_compile says that it supports output redirection,
1375 # but the code is completely different from the normal path and I
1376 # don't want to sweep the mines from that path. So I didn't even try
1379 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1382 # I actually do this for all targets now. gdb_compile runs the right
1383 # compiler, and TCL captures the output, and I eval the output.
1385 # Unfortunately, expect logs the output of the command as it goes by,
1386 # and dejagnu helpfully prints a second copy of it right afterwards.
1387 # So I turn off expect logging for a moment.
1389 # [ gdb_compile $ifile $ciexe_file executable $args ]
1390 # [ remote_exec $ciexe_file ]
1391 # [ source $ci_file.out ]
1393 # I could give up on -E and just do this.
1394 # I didn't get desperate enough to try this.
1396 # -- chastain 2004-01-06
1398 proc get_compiler_info {binfile args} {
1399 # For compiler.c and compiler.cc
1402 # I am going to play with the log to keep noise out.
1406 # These come from compiler.c or compiler.cc
1407 global compiler_info
1409 # Legacy global data symbols.
1411 global hp_cc_compiler
1412 global hp_aCC_compiler
1414 # Choose which file to preprocess.
1415 set ifile "${srcdir}/lib/compiler.c"
1416 if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1417 set ifile "${srcdir}/lib/compiler.cc"
1420 # Run $ifile through the right preprocessor.
1421 # Toggle gdb.log to keep the compiler output out of the log.
1423 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
1424 log_file -a "$outdir/$tool.log"
1428 foreach cppline [ split "$cppout" "\n" ] {
1429 if { [ regexp "^#" "$cppline" ] } {
1431 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
1433 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
1435 verbose "get_compiler_info: $cppline" 2
1439 verbose -log "get_compiler_info: $cppline"
1444 # Reset to unknown compiler if any diagnostics happened.
1446 set compiler_info "unknown"
1449 # Set the legacy symbols.
1451 set hp_cc_compiler 0
1452 set hp_aCC_compiler 0
1453 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
1454 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
1455 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
1456 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
1457 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
1458 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
1459 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
1461 # Log what happened.
1462 verbose -log "get_compiler_info: $compiler_info"
1464 # Most compilers will evaluate comparisons and other boolean
1465 # operations to 0 or 1.
1466 uplevel \#0 { set true 1 }
1467 uplevel \#0 { set false 0 }
1469 # Use of aCC results in boolean results being displayed as
1471 if { $hp_aCC_compiler } {
1472 uplevel \#0 { set true true }
1473 uplevel \#0 { set false false }
1479 proc test_compiler_info { {compiler ""} } {
1480 global compiler_info
1482 # if no arg, return the compiler_info string
1484 if [string match "" $compiler] {
1485 if [info exists compiler_info] {
1486 return $compiler_info
1488 perror "No compiler info found."
1492 return [string match $compiler $compiler_info]
1495 set gdb_wrapper_initialized 0
1497 proc gdb_wrapper_init { args } {
1498 global gdb_wrapper_initialized;
1499 global gdb_wrapper_file;
1500 global gdb_wrapper_flags;
1502 if { $gdb_wrapper_initialized == 1 } { return; }
1504 if {[target_info exists needs_status_wrapper] && \
1505 [target_info needs_status_wrapper] != "0"} {
1506 set result [build_wrapper "testglue.o"];
1507 if { $result != "" } {
1508 set gdb_wrapper_file [lindex $result 0];
1509 set gdb_wrapper_flags [lindex $result 1];
1511 warning "Status wrapper failed to build."
1514 set gdb_wrapper_initialized 1
1517 proc gdb_compile {source dest type options} {
1518 global GDB_TESTCASE_OPTIONS;
1519 global gdb_wrapper_file;
1520 global gdb_wrapper_flags;
1521 global gdb_wrapper_initialized;
1523 # Add platform-specific options if a shared library was specified using
1524 # "shlib=librarypath" in OPTIONS.
1527 foreach opt $options {
1528 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
1529 if [test_compiler_info "xlc-*"] {
1530 # IBM xlc compiler doesn't accept shared library named other
1531 # than .so: use "-Wl," to bypass this
1532 lappend source "-Wl,$shlib_name"
1533 } elseif { ([istarget "*-*-mingw*"]
1534 || [istarget *-*-cygwin*]
1535 || [istarget *-*-pe*])} {
1536 lappend source "${shlib_name}.a"
1538 lappend source $shlib_name
1540 if {$shlib_found == 0} {
1542 if { ([test_compiler_info "gcc-*"]
1543 && ([istarget "powerpc*-*-aix*"]
1544 || [istarget "rs6000*-*-aix*"] )) } {
1545 lappend options "additional_flags=-L${objdir}/${subdir}"
1546 } elseif { [istarget "mips-sgi-irix*"] } {
1547 lappend options "additional_flags=-rpath ${objdir}/${subdir}"
1550 } elseif { $opt == "shlib_load" } {
1551 if { ([istarget "*-*-mingw*"]
1552 || [istarget *-*-cygwin*]
1553 || [istarget *-*-pe*]
1554 || [istarget arm*-*-symbianelf*]
1555 || [istarget hppa*-*-hpux*])} {
1556 # Do not need anything.
1558 lappend new_options "libs=-ldl"
1559 lappend new_options "additional_flags=-Wl,-rpath,\\\$ORIGIN"
1562 lappend new_options $opt
1565 set options $new_options
1567 if [target_info exists gdb_stub] {
1568 set options2 { "additional_flags=-Dusestubs" }
1569 lappend options "libs=[target_info gdb_stub]";
1570 set options [concat $options2 $options]
1572 if [target_info exists is_vxworks] {
1573 set options2 { "additional_flags=-Dvxworks" }
1574 lappend options "libs=[target_info gdb_stub]";
1575 set options [concat $options2 $options]
1577 if [info exists GDB_TESTCASE_OPTIONS] {
1578 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
1580 verbose "options are $options"
1581 verbose "source is $source $dest $type $options"
1583 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
1585 if {[target_info exists needs_status_wrapper] && \
1586 [target_info needs_status_wrapper] != "0" && \
1587 [info exists gdb_wrapper_file]} {
1588 lappend options "libs=${gdb_wrapper_file}"
1589 lappend options "ldflags=${gdb_wrapper_flags}"
1592 # Replace the "nowarnings" option with the appropriate additional_flags
1593 # to disable compiler warnings.
1594 set nowarnings [lsearch -exact $options nowarnings]
1595 if {$nowarnings != -1} {
1596 if [target_info exists gdb,nowarnings_flag] {
1597 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
1599 set flag "additional_flags=-w"
1601 set options [lreplace $options $nowarnings $nowarnings $flag]
1604 set result [target_compile $source $dest $type $options];
1606 # Prune uninteresting compiler (and linker) output.
1607 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
1609 regsub "\[\r\n\]*$" "$result" "" result;
1610 regsub "^\[\r\n\]*" "$result" "" result;
1612 if { $result != "" && [lsearch $options quiet] == -1} {
1613 clone_output "gdb compile failed, $result"
1619 # This is just like gdb_compile, above, except that it tries compiling
1620 # against several different thread libraries, to see which one this
1622 proc gdb_compile_pthreads {source dest type options} {
1624 set why_msg "unrecognized error"
1625 foreach lib {-lpthreads -lpthread -lthread} {
1626 # This kind of wipes out whatever libs the caller may have
1627 # set. Or maybe theirs will override ours. How infelicitous.
1628 set options_with_lib [concat $options [list libs=$lib quiet]]
1629 set ccout [gdb_compile $source $dest $type $options_with_lib]
1630 switch -regexp -- $ccout {
1631 ".*no posix threads support.*" {
1632 set why_msg "missing threads include file"
1635 ".*cannot open -lpthread.*" {
1636 set why_msg "missing runtime threads library"
1638 ".*Can't find library for -lpthread.*" {
1639 set why_msg "missing runtime threads library"
1642 pass "successfully compiled posix threads test case"
1648 if {!$built_binfile} {
1649 unsupported "Couldn't compile $source: ${why_msg}"
1654 # Build a shared library from SOURCES. You must use get_compiler_info
1657 proc gdb_compile_shlib {sources dest options} {
1658 set obj_options $options
1660 switch -glob [test_compiler_info] {
1662 lappend obj_options "additional_flags=-qpic"
1665 if { !([istarget "powerpc*-*-aix*"]
1666 || [istarget "rs6000*-*-aix*"]
1667 || [istarget "*-*-cygwin*"]
1668 || [istarget "*-*-mingw*"]
1669 || [istarget "*-*-pe*"]) } {
1670 lappend obj_options "additional_flags=-fpic"
1674 switch -glob [istarget] {
1676 lappend obj_options "additional_flags=+z"
1679 # Disable SGI compiler's implicit -Dsgi
1680 lappend obj_options "additional_flags=-Usgi"
1683 # don't know what the compiler is...
1689 set outdir [file dirname $dest]
1691 foreach source $sources {
1692 set sourcebase [file tail $source]
1693 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
1696 lappend objects ${outdir}/${sourcebase}.o
1699 if [istarget "hppa*-*-hpux*"] {
1700 remote_exec build "ld -b ${objects} -o ${dest}"
1702 set link_options $options
1703 if [test_compiler_info "xlc-*"] {
1704 lappend link_options "additional_flags=-qmkshrobj"
1706 lappend link_options "additional_flags=-shared"
1708 if { ([istarget "*-*-mingw*"]
1709 || [istarget *-*-cygwin*]
1710 || [istarget *-*-pe*])} {
1711 lappend link_options "additional_flags=-Wl,--out-implib,${dest}.a"
1714 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
1720 # This is just like gdb_compile_pthreads, above, except that we always add the
1721 # objc library for compiling Objective-C programs
1722 proc gdb_compile_objc {source dest type options} {
1724 set why_msg "unrecognized error"
1725 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
1726 # This kind of wipes out whatever libs the caller may have
1727 # set. Or maybe theirs will override ours. How infelicitous.
1728 if { $lib == "solaris" } {
1729 set lib "-lpthread -lposix4"
1731 if { $lib != "-lobjc" } {
1732 set lib "-lobjc $lib"
1734 set options_with_lib [concat $options [list libs=$lib quiet]]
1735 set ccout [gdb_compile $source $dest $type $options_with_lib]
1736 switch -regexp -- $ccout {
1737 ".*no posix threads support.*" {
1738 set why_msg "missing threads include file"
1741 ".*cannot open -lpthread.*" {
1742 set why_msg "missing runtime threads library"
1744 ".*Can't find library for -lpthread.*" {
1745 set why_msg "missing runtime threads library"
1748 pass "successfully compiled objc with posix threads test case"
1754 if {!$built_binfile} {
1755 unsupported "Couldn't compile $source: ${why_msg}"
1760 proc send_gdb { string } {
1761 global suppress_flag;
1762 if { $suppress_flag } {
1763 return "suppressed";
1765 return [remote_send host "$string"];
1771 proc gdb_expect { args } {
1772 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
1773 set gtimeout [lindex $args 0];
1774 set expcode [list [lindex $args 1]];
1776 upvar timeout timeout;
1779 if [target_info exists gdb,timeout] {
1780 if [info exists timeout] {
1781 if { $timeout < [target_info gdb,timeout] } {
1782 set gtimeout [target_info gdb,timeout];
1784 set gtimeout $timeout;
1787 set gtimeout [target_info gdb,timeout];
1791 if ![info exists gtimeout] {
1793 if [info exists timeout] {
1794 set gtimeout $timeout;
1801 global suppress_flag;
1802 global remote_suppress_flag;
1803 if [info exists remote_suppress_flag] {
1804 set old_val $remote_suppress_flag;
1806 if [info exists suppress_flag] {
1807 if { $suppress_flag } {
1808 set remote_suppress_flag 1;
1812 {uplevel remote_expect host $gtimeout $expcode} string];
1813 if [info exists old_val] {
1814 set remote_suppress_flag $old_val;
1816 if [info exists remote_suppress_flag] {
1817 unset remote_suppress_flag;
1822 global errorInfo errorCode;
1824 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1825 } elseif {$code == 2} {
1826 return -code return $string
1827 } elseif {$code == 3} {
1829 } elseif {$code > 4} {
1830 return -code $code $string
1834 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
1836 # Check for long sequence of output by parts.
1837 # MESSAGE: is the test message to be printed with the test success/fail.
1838 # SENTINEL: Is the terminal pattern indicating that output has finished.
1839 # LIST: is the sequence of outputs to match.
1840 # If the sentinel is recognized early, it is considered an error.
1843 # 1 if the test failed,
1844 # 0 if the test passes,
1845 # -1 if there was an internal error.
1847 proc gdb_expect_list {test sentinel list} {
1849 global suppress_flag
1852 if { $suppress_flag } {
1854 unresolved "${test}"
1856 while { ${index} < [llength ${list}] } {
1857 set pattern [lindex ${list} ${index}]
1858 set index [expr ${index} + 1]
1859 if { ${index} == [llength ${list}] } {
1862 -re "${pattern}${sentinel}" {
1863 # pass "${test}, pattern ${index} + sentinel"
1866 fail "${test} (pattern ${index} + sentinel)"
1869 -re ".*A problem internal to GDB has been detected" {
1870 fail "${test} (GDB internal error)"
1872 gdb_internal_error_resync
1875 fail "${test} (pattern ${index} + sentinel) (timeout)"
1880 # unresolved "${test}, pattern ${index} + sentinel"
1886 # pass "${test}, pattern ${index}"
1889 fail "${test} (pattern ${index})"
1892 -re ".*A problem internal to GDB has been detected" {
1893 fail "${test} (GDB internal error)"
1895 gdb_internal_error_resync
1898 fail "${test} (pattern ${index}) (timeout)"
1903 # unresolved "${test}, pattern ${index}"
1917 proc gdb_suppress_entire_file { reason } {
1918 global suppress_flag;
1920 warning "$reason\n";
1921 set suppress_flag -1;
1925 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
1926 # gdb_expect to fail immediately (until the next call to
1927 # gdb_stop_suppressing_tests).
1929 proc gdb_suppress_tests { args } {
1930 global suppress_flag;
1932 return; # fnf - disable pending review of results where
1933 # testsuite ran better without this
1936 if { $suppress_flag == 1 } {
1937 if { [llength $args] > 0 } {
1938 warning "[lindex $args 0]\n";
1940 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
1946 # Clear suppress_flag.
1948 proc gdb_stop_suppressing_tests { } {
1949 global suppress_flag;
1951 if [info exists suppress_flag] {
1952 if { $suppress_flag > 0 } {
1953 set suppress_flag 0;
1954 clone_output "Tests restarted.\n";
1957 set suppress_flag 0;
1961 proc gdb_clear_suppressed { } {
1962 global suppress_flag;
1964 set suppress_flag 0;
1967 proc gdb_start { } {
1972 catch default_gdb_exit
1976 # gdb_load_cmd -- load a file into the debugger.
1977 # ARGS - additional args to load command.
1978 # return a -1 if anything goes wrong.
1980 proc gdb_load_cmd { args } {
1983 if [target_info exists gdb_load_timeout] {
1984 set loadtimeout [target_info gdb_load_timeout]
1986 set loadtimeout 1600
1988 send_gdb "load $args\n"
1989 verbose "Timeout is now $timeout seconds" 2
1990 gdb_expect $loadtimeout {
1991 -re "Loading section\[^\r\]*\r\n" {
1994 -re "Start address\[\r\]*\r\n" {
1997 -re "Transfer rate\[\r\]*\r\n" {
2000 -re "Memory access error\[^\r\]*\r\n" {
2001 perror "Failed to load program"
2004 -re "$gdb_prompt $" {
2007 -re "(.*)\r\n$gdb_prompt " {
2008 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
2012 perror "Timed out trying to load $arg."
2021 # Copy a file to the remote target and return its target filename.
2022 # Schedule the file to be deleted at the end of this test.
2024 proc gdb_download { filename } {
2027 set destname [remote_download target $filename]
2028 lappend cleanfiles $destname
2032 # gdb_load_shlibs LIB...
2034 # Copy the listed libraries to the target.
2036 proc gdb_load_shlibs { args } {
2037 if {![is_remote target]} {
2041 foreach file $args {
2045 # Even if the target supplies full paths for shared libraries,
2046 # they may not be paths for this system.
2047 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
2051 # gdb_load -- load a file into the debugger.
2052 # Many files in config/*.exp override this procedure.
2054 proc gdb_load { arg } {
2055 return [gdb_file_cmd $arg]
2058 # gdb_reload -- load a file into the target. Called before "running",
2059 # either the first time or after already starting the program once,
2060 # for remote targets. Most files that override gdb_load should now
2061 # override this instead.
2063 proc gdb_reload { } {
2064 # For the benefit of existing configurations, default to gdb_load.
2065 # Specifying no file defaults to the executable currently being
2067 return [gdb_load ""]
2070 proc gdb_continue { function } {
2073 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
2076 proc default_gdb_init { args } {
2077 global gdb_wrapper_initialized
2082 gdb_clear_suppressed;
2084 # Make sure that the wrapper is rebuilt
2085 # with the appropriate multilib option.
2086 set gdb_wrapper_initialized 0
2088 # Unlike most tests, we have a small number of tests that generate
2089 # a very large amount of output. We therefore increase the expect
2090 # buffer size to be able to contain the entire test output.
2093 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
2094 if { [llength $args] > 0 } {
2097 set file [lindex $args 0];
2099 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
2102 if [target_info exists gdb_prompt] {
2103 set gdb_prompt [target_info gdb_prompt];
2105 set gdb_prompt "\\(gdb\\)"
2109 proc gdb_init { args } {
2110 return [eval default_gdb_init $args];
2113 proc gdb_finish { } {
2116 # Exit first, so that the files are no longer in use.
2119 if { [llength $cleanfiles] > 0 } {
2120 eval remote_file target delete $cleanfiles
2126 set debug_format "unknown"
2128 # Run the gdb command "info source" and extract the debugging format
2129 # information from the output and save it in debug_format.
2131 proc get_debug_format { } {
2137 set debug_format "unknown"
2138 send_gdb "info source\n"
2140 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
2141 set debug_format $expect_out(1,string)
2142 verbose "debug format is $debug_format"
2145 -re "No current source file.\r\n$gdb_prompt $" {
2146 perror "get_debug_format used when no current source file"
2149 -re "$gdb_prompt $" {
2150 warning "couldn't check debug format (no valid response)."
2154 warning "couldn't check debug format (timed out)."
2160 # Return true if FORMAT matches the debug format the current test was
2161 # compiled with. FORMAT is a shell-style globbing pattern; it can use
2162 # `*', `[...]', and so on.
2164 # This function depends on variables set by `get_debug_format', above.
2166 proc test_debug_format {format} {
2169 return [expr [string match $format $debug_format] != 0]
2172 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
2173 # COFF, stabs, etc). If that format matches the format that the
2174 # current test was compiled with, then the next test is expected to
2175 # fail for any target. Returns 1 if the next test or set of tests is
2176 # expected to fail, 0 otherwise (or if it is unknown). Must have
2177 # previously called get_debug_format.
2178 proc setup_xfail_format { format } {
2179 set ret [test_debug_format $format];
2187 proc gdb_step_for_stub { } {
2190 if ![target_info exists gdb,use_breakpoint_for_stub] {
2191 if [target_info exists gdb_stub_step_command] {
2192 set command [target_info gdb_stub_step_command];
2196 send_gdb "${command}\n";
2199 -re "(main.* at |.*in .*start).*$gdb_prompt" {
2202 -re ".*$gdb_prompt" {
2204 if { $tries == 5 } {
2205 fail "stepping out of breakpoint function";
2208 send_gdb "${command}\n";
2212 fail "stepping out of breakpoint function";
2219 -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
2220 set file $expect_out(1,string);
2221 set linenum [expr $expect_out(2,string) + 1];
2222 set breakplace "${file}:${linenum}";
2226 send_gdb "break ${breakplace}\n";
2228 -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
2229 set breakpoint $expect_out(1,string);
2231 -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
2232 set breakpoint $expect_out(1,string);
2236 send_gdb "continue\n";
2238 -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
2239 gdb_test "delete $breakpoint" ".*" "";
2246 # gdb_get_line_number TEXT [FILE]
2248 # Search the source file FILE, and return the line number of the
2249 # first line containing TEXT. If no match is found, return -1.
2251 # TEXT is a string literal, not a regular expression.
2253 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
2254 # specified, and does not start with "/", then it is assumed to be in
2255 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
2256 # by changing the callers and the interface at the same time.
2257 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
2258 # gdb.base/ena-dis-br.exp.
2260 # Use this function to keep your test scripts independent of the
2261 # exact line numbering of the source file. Don't write:
2263 # send_gdb "break 20"
2265 # This means that if anyone ever edits your test's source file,
2266 # your test could break. Instead, put a comment like this on the
2267 # source file line you want to break at:
2269 # /* breakpoint spot: frotz.exp: test name */
2271 # and then write, in your test script (which we assume is named
2274 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
2276 # (Yes, Tcl knows how to handle the nested quotes and brackets.
2279 # % puts "foo [lindex "bar baz" 1]"
2282 # Tcl is quite clever, for a little stringy language.)
2286 # The previous implementation of this procedure used the gdb search command.
2287 # This version is different:
2289 # . It works with MI, and it also works when gdb is not running.
2291 # . It operates on the build machine, not the host machine.
2293 # . For now, this implementation fakes a current directory of
2294 # $srcdir/$subdir to be compatible with the old implementation.
2295 # This will go away eventually and some callers will need to
2298 # . The TEXT argument is literal text and matches literally,
2299 # not a regular expression as it was before.
2301 # . State changes in gdb, such as changing the current file
2302 # and setting $_, no longer happen.
2304 # After a bit of time we can forget about the differences from the
2305 # old implementation.
2307 # --chastain 2004-08-05
2309 proc gdb_get_line_number { text { file "" } } {
2314 if { "$file" == "" } then {
2317 if { ! [regexp "^/" "$file"] } then {
2318 set file "$srcdir/$subdir/$file"
2321 if { [ catch { set fd [open "$file"] } message ] } then {
2327 for { set line 1 } { 1 } { incr line } {
2328 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
2332 if { $nchar < 0 } then {
2335 if { [string first "$text" "$body"] >= 0 } then {
2341 if { [ catch { close "$fd" } message ] } then {
2349 # gdb_continue_to_end:
2350 # The case where the target uses stubs has to be handled specially. If a
2351 # stub is used, we set a breakpoint at exit because we cannot rely on
2352 # exit() behavior of a remote target.
2354 # mssg is the error message that gets printed.
2356 proc gdb_continue_to_end {mssg} {
2357 if [target_info exists use_gdb_stub] {
2358 if {![gdb_breakpoint "exit"]} {
2361 gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
2362 "continue until exit at $mssg"
2364 # Continue until we exit. Should not stop again.
2365 # Don't bother to check the output of the program, that may be
2366 # extremely tough for some remote systems.
2367 gdb_test "continue"\
2368 "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|Program exited normally\\.).*"\
2369 "continue until exit at $mssg"
2373 proc rerun_to_main {} {
2376 if [target_info exists use_gdb_stub] {
2379 -re ".*Breakpoint .*main .*$gdb_prompt $"\
2380 {pass "rerun to main" ; return 0}
2381 -re "$gdb_prompt $"\
2382 {fail "rerun to main" ; return 0}
2383 timeout {fail "(timeout) rerun to main" ; return 0}
2388 -re "The program .* has been started already.*y or n. $" {
2392 -re "Starting program.*$gdb_prompt $"\
2393 {pass "rerun to main" ; return 0}
2394 -re "$gdb_prompt $"\
2395 {fail "rerun to main" ; return 0}
2396 timeout {fail "(timeout) rerun to main" ; return 0}
2401 # Print a message and return true if a test should be skipped
2402 # due to lack of floating point suport.
2404 proc gdb_skip_float_test { msg } {
2405 if [target_info exists gdb,skip_float_tests] {
2406 verbose "Skipping test '$msg': no float tests.";
2412 # Print a message and return true if a test should be skipped
2413 # due to lack of stdio support.
2415 proc gdb_skip_stdio_test { msg } {
2416 if [target_info exists gdb,noinferiorio] {
2417 verbose "Skipping test '$msg': no inferior i/o.";
2423 proc gdb_skip_bogus_test { msg } {
2427 # Return true if a test should be skipped due to lack of XML support
2430 proc gdb_skip_xml_test { } {
2433 global xml_missing_cached
2435 if {[info exists xml_missing_cached]} {
2436 return $xml_missing_cached
2440 set xml_missing_cached 0
2441 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
2442 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
2443 set xml_missing_cached 1
2445 -re ".*$gdb_prompt $" { }
2448 return $xml_missing_cached
2451 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
2452 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
2453 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
2454 # the name of a debuginfo only file. This file will be stored in the
2455 # gdb.base/.debug subdirectory.
2457 # Functions for separate debug info testing
2459 # starting with an executable:
2460 # foo --> original executable
2462 # at the end of the process we have:
2463 # foo.stripped --> foo w/o debug info
2464 # .debug/foo.debug --> foo's debug info
2465 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
2467 # Return the name of the file in which we should stor EXEC's separated
2468 # debug info. EXEC contains the full path.
2469 proc separate_debug_filename { exec } {
2471 # In a .debug subdirectory off the same directory where the testcase
2472 # executable is going to be. Something like:
2473 # <your-path>/gdb/testsuite/gdb.base/.debug/blah.debug.
2474 # This is the default location where gdb expects to findi
2475 # the debug info file.
2477 set exec_dir [file dirname $exec]
2478 set exec_file [file tail $exec]
2479 set debug_dir [file join $exec_dir ".debug"]
2480 set debug_file [file join $debug_dir "${exec_file}.debug"]
2485 # Return the build-id hex string (usually 160 bits as 40 hex characters)
2486 # converted to the form: .build-id/ab/cdef1234...89.debug
2487 # Return "" if no build-id found.
2488 proc build_id_debug_filename_get { exec } {
2489 set tmp "${exec}-tmp"
2490 exec objcopy -j .note.gnu.build-id -O binary $exec $tmp
2492 # Skip the NOTE header.
2500 # Convert it to hex.
2501 binary scan $data H* data
2502 set data [regsub {^..} $data {\0/}]
2503 return ".build-id/${data}.debug";
2506 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
2507 # list of optional flags. The only currently supported flag is no-main,
2508 # which removes the symbol entry for main from the separate debug file.
2510 proc gdb_gnu_strip_debug { dest args } {
2512 # First, make sure that we can do this. This is nasty. We need to
2513 # check for the stabs debug format. To do this we must run gdb on
2514 # the unstripped executable, list 'main' (as to have a default
2515 # source file), use get_debug_format (which does 'info source')
2516 # and then see if the debug info is stabs. If so, we bail out. We
2517 # cannot do this any other way because get_debug_format finds out
2518 # the debug format using gdb itself, and in case of stabs we get
2519 # an error loading the program if it is already stripped. An
2520 # alternative would be to find out the debug info from the flags
2521 # passed to dejagnu when the test is run.
2526 gdb_test "list main" "" ""
2528 if { [test_debug_format "stabs"] } then {
2529 # The separate debug info feature doesn't work well in
2530 # binutils with stabs. It produces a corrupted debug info
2531 # only file, and gdb chokes on it. It is almost impossible to
2532 # capture the failing message out of gdb, because it happens
2533 # inside gdb_load. At that point any error message is
2534 # intercepted by dejagnu itself, and, because of the error
2535 # threshold, any faulty test result is changed into an
2536 # UNRESOLVED. (see dejagnu/lib/framework.exp)
2537 unsupported "no separate debug info handling with stabs"
2539 } elseif { [test_debug_format "unknown"] } then {
2540 # gdb doesn't know what the debug format is. We are out of luck here.
2541 unsupported "unknown debugging format"
2546 set debug_file [separate_debug_filename $dest]
2547 set strip_to_file_program [transform strip]
2548 set objcopy_program [transform objcopy]
2550 # Make sure the directory that will hold the separated debug
2551 # info actually exists.
2552 set debug_dir [file dirname $debug_file]
2553 if {! [file isdirectory $debug_dir]} {
2554 file mkdir $debug_dir
2557 set debug_link [file tail $debug_file]
2558 set stripped_file "${dest}.stripped"
2560 # Get rid of the debug info, and store result in stripped_file
2561 # something like gdb/testsuite/gdb.base/blah.stripped.
2562 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
2563 verbose "result is $result"
2564 verbose "output is $output"
2569 # Get rid of everything but the debug info, and store result in debug_file
2570 # This will be in the .debug subdirectory, see above.
2571 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
2572 verbose "result is $result"
2573 verbose "output is $output"
2578 # If no-main is passed, strip the symbol for main from the separate
2579 # file. This is to simulate the behavior of elfutils's eu-strip, which
2580 # leaves the symtab in the original file only. There's no way to get
2581 # objcopy or strip to remove the symbol table without also removing the
2582 # debugging sections, so this is as close as we can get.
2583 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
2584 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
2585 verbose "result is $result"
2586 verbose "output is $output"
2590 file delete "${debug_file}"
2591 file rename "${debug_file}-tmp" "${debug_file}"
2594 # Link the two previous output files together, adding the .gnu_debuglink
2595 # section to the stripped_file, containing a pointer to the debug_file,
2596 # save the new file in dest.
2597 # This will be the regular executable filename, in the usual location.
2598 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
2599 verbose "result is $result"
2600 verbose "output is $output"
2608 # Test the output of GDB_COMMAND matches the pattern obtained
2609 # by concatenating all elements of EXPECTED_LINES. This makes
2610 # it possible to split otherwise very long string into pieces.
2611 # If third argument is not empty, it's used as the name of the
2612 # test to be printed on pass/fail.
2613 proc help_test_raw { gdb_command expected_lines args } {
2614 set message $gdb_command
2615 if [llength $args]>0 then {
2616 set message [lindex $args 0]
2618 set expected_output [join $expected_lines ""]
2619 gdb_test "${gdb_command}" "${expected_output}" $message
2622 # Test the output of "help COMMNAD_CLASS". EXPECTED_INITIAL_LINES
2623 # are regular expressions that should match the beginning of output,
2624 # before the list of commands in that class. The presence of
2625 # command list and standard epilogue will be tested automatically.
2626 proc test_class_help { command_class expected_initial_lines args } {
2628 "List of commands\:.*\[\r\n\]+"
2629 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
2630 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
2631 "Command name abbreviations are allowed if unambiguous\."
2633 set l_entire_body [concat $expected_initial_lines $l_stock_body]
2635 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
2638 # COMMAND_LIST should have either one element -- command to test, or
2639 # two elements -- abbreviated command to test, and full command the first
2640 # element is abbreviation of.
2641 # The command must be a prefix command. EXPECTED_INITIAL_LINES
2642 # are regular expressions that should match the beginning of output,
2643 # before the list of subcommands. The presence of
2644 # subcommand list and standard epilogue will be tested automatically.
2645 proc test_prefix_command_help { command_list expected_initial_lines args } {
2646 set command [lindex $command_list 0]
2647 if {[llength $command_list]>1} {
2648 set full_command [lindex $command_list 1]
2650 set full_command $command
2652 # Use 'list' and not just {} because we want variables to
2653 # be expanded in this list.
2654 set l_stock_body [list\
2655 "List of $full_command subcommands\:.*\[\r\n\]+"\
2656 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
2657 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
2658 "Command name abbreviations are allowed if unambiguous\."]
2659 set l_entire_body [concat $expected_initial_lines $l_stock_body]
2660 if {[llength $args]>0} {
2661 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
2663 help_test_raw "help ${command}" $l_entire_body