1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
2 # 2003, 2004, 2005, 2007, 2008, 2009 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
45 # GDBFLAGS is available for the user to set on the command line.
46 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
47 # Testcases may use it to add additional flags, but they must:
48 # - append new flags, not overwrite
49 # - restore the original value when done
51 if ![info exists GDBFLAGS] {
54 verbose "using GDBFLAGS = $GDBFLAGS" 2
56 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
57 set INTERNAL_GDBFLAGS "-nw -nx"
59 # The variable gdb_prompt is a regexp which matches the gdb prompt.
60 # Set it if it is not already set.
62 if ![info exists gdb_prompt] then {
63 set gdb_prompt "\[(\]gdb\[)\]"
66 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
67 # absolute path ie. /foo/
68 set fullname_syntax_POSIX {/[^\n]*/}
69 # The variable fullname_syntax_UNC is a regexp which matches a Windows
70 # UNC path ie. \\D\foo\
71 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
72 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
73 # particular DOS case that GDB most likely will output
74 # ie. \foo\, but don't match \\.*\
75 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
76 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
77 # ie. a:\foo\ && a:foo\
78 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
79 # The variable fullname_syntax is a regexp which matches what GDB considers
80 # an absolute path. It is currently debatable if the Windows style paths
81 # d:foo and \abc should be considered valid as an absolute path.
82 # Also, the purpse of this regexp is not to recognize a well formed
83 # absolute path, but to say with certainty that a path is absolute.
84 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
86 # Needed for some tests under Cygwin.
90 if ![info exists env(EXEEXT)] {
93 set EXEEXT $env(EXEEXT)
98 ### Only procedures should come after this point.
101 # gdb_version -- extract and print the version number of GDB
103 proc default_gdb_version {} {
105 global INTERNAL_GDBFLAGS GDBFLAGS
107 set fileid [open "gdb_cmd" w];
110 set cmdfile [remote_download host "gdb_cmd"];
111 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --command $cmdfile"]
112 remote_file build delete "gdb_cmd";
113 remote_file host delete "$cmdfile";
114 set tmp [lindex $output 1];
116 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
117 if ![is_remote host] {
118 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
120 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
124 proc gdb_version { } {
125 return [default_gdb_version];
129 # gdb_unload -- unload a file if one is loaded
138 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
139 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
140 -re "A program is being debugged already..*Kill it.*y or n. $"\
142 verbose "\t\tKilling previous program being debugged"
145 -re "Discard symbol table from .*y or n.*$" {
149 -re "$gdb_prompt $" {}
151 perror "couldn't unload file in $GDB (timed out)."
157 # Many of the tests depend on setting breakpoints at various places and
158 # running until that breakpoint is reached. At times, we want to start
159 # with a clean-slate with respect to breakpoints, so this utility proc
160 # lets us do this without duplicating this code everywhere.
163 proc delete_breakpoints {} {
166 # we need a larger timeout value here or this thing just confuses
167 # itself. May need a better implementation if possible. - guo
169 send_gdb "delete breakpoints\n"
171 -re "Delete all breakpoints.*y or n.*$" {
175 -re "$gdb_prompt $" { # This happens if there were no breakpoints
177 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
179 send_gdb "info breakpoints\n"
181 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
182 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
183 -re "Delete all breakpoints.*or n.*$" {
187 timeout { perror "info breakpoints (timeout)" ; return }
193 # Generic run command.
195 # The second pattern below matches up to the first newline *only*.
196 # Using ``.*$'' could swallow up output that we attempt to match
199 proc gdb_run_cmd {args} {
202 if [target_info exists gdb_init_command] {
203 send_gdb "[target_info gdb_init_command]\n";
205 -re "$gdb_prompt $" { }
207 perror "gdb_init_command for target failed";
213 if [target_info exists use_gdb_stub] {
214 if [target_info exists gdb,do_reload_on_run] {
215 if { [gdb_reload] != 0 } {
218 send_gdb "continue\n";
220 -re "Continu\[^\r\n\]*\[\r\n\]" {}
226 if [target_info exists gdb,start_symbol] {
227 set start [target_info gdb,start_symbol];
231 send_gdb "jump *$start\n"
233 while { $start_attempt } {
234 # Cap (re)start attempts at three to ensure that this loop
235 # always eventually fails. Don't worry about trying to be
236 # clever and not send a command when it has failed.
237 if [expr $start_attempt > 3] {
238 perror "Jump to start() failed (retry count exceeded)";
241 set start_attempt [expr $start_attempt + 1];
243 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
246 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
247 perror "Can't find start symbol to run in gdb_run";
250 -re "No symbol \"start\" in current.*$gdb_prompt $" {
251 send_gdb "jump *_start\n";
253 -re "No symbol.*context.*$gdb_prompt $" {
256 -re "Line.* Jump anyway.*y or n. $" {
259 -re "The program is not being run.*$gdb_prompt $" {
260 if { [gdb_reload] != 0 } {
263 send_gdb "jump *$start\n";
266 perror "Jump to start() failed (timeout)";
271 if [target_info exists gdb_stub] {
273 -re "$gdb_prompt $" {
274 send_gdb "continue\n"
281 if [target_info exists gdb,do_reload_on_run] {
282 if { [gdb_reload] != 0 } {
286 send_gdb "run $args\n"
287 # This doesn't work quite right yet.
288 # Use -notransfer here so that test cases (like chng-sym.exp)
289 # may test for additional start-up messages.
291 -re "The program .* has been started already.*y or n. $" {
295 -notransfer -re "Starting program: \[^\r\n\]*" {}
299 # Generic start command. Return 0 if we could start the program, -1
302 proc gdb_start_cmd {args} {
305 if [target_info exists gdb_init_command] {
306 send_gdb "[target_info gdb_init_command]\n";
308 -re "$gdb_prompt $" { }
310 perror "gdb_init_command for target failed";
316 if [target_info exists use_gdb_stub] {
320 send_gdb "start $args\n"
322 -re "The program .* has been started already.*y or n. $" {
326 # Use -notransfer here so that test cases (like chng-sym.exp)
327 # may test for additional start-up messages.
328 -notransfer -re "Starting program: \[^\r\n\]*" {
335 # Set a breakpoint at FUNCTION. If there is an additional argument it is
336 # a list of options; the supported options are allow-pending, temporary,
339 proc gdb_breakpoint { function args } {
343 set pending_response n
344 if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
345 set pending_response y
348 set break_command "break"
349 set break_message "Breakpoint"
350 if {[lsearch -exact [lindex $args 0] temporary] != -1} {
351 set break_command "tbreak"
352 set break_message "Temporary breakpoint"
356 if {[lsearch -exact [lindex $args 0] no-message] != -1} {
360 send_gdb "$break_command $function\n"
361 # The first two regexps are what we get with -g, the third is without -g.
363 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
364 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
365 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
366 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
367 if {$pending_response == "n"} {
368 if { $no_message == 0 } {
369 fail "setting breakpoint at $function"
374 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
375 send_gdb "$pending_response\n"
378 -re "$gdb_prompt $" {
379 if { $no_message == 0 } {
380 fail "setting breakpoint at $function"
385 if { $no_message == 0 } {
386 fail "setting breakpoint at $function (timeout)"
394 # Set breakpoint at function and run gdb until it breaks there.
395 # Since this is the only breakpoint that will be set, if it stops
396 # at a breakpoint, we will assume it is the one we want. We can't
397 # just compare to "function" because it might be a fully qualified,
398 # single quoted C++ function specifier. If there's an additional argument,
399 # pass it to gdb_breakpoint.
401 proc runto { function args } {
407 if ![gdb_breakpoint $function [lindex $args 0]] {
413 # the "at foo.c:36" output we get with -g.
414 # the "in func" output we get without -g.
416 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
419 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
422 -re "$gdb_prompt $" {
423 fail "running to $function in runto"
427 fail "running to $function in runto (end of file)"
431 fail "running to $function in runto (timeout)"
439 # runto_main -- ask gdb to run until we hit a breakpoint at main.
440 # The case where the target uses stubs has to be handled
441 # specially--if it uses stubs, assuming we hit
442 # breakpoint() and just step out of the function.
444 proc runto_main { } {
448 if ![target_info exists gdb_stub] {
460 ### Continue, and expect to hit a breakpoint.
461 ### Report a pass or fail, depending on whether it seems to have
462 ### worked. Use NAME as part of the test name; each call to
463 ### continue_to_breakpoint should use a NAME which is unique within
465 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
467 set full_name "continue to breakpoint: $name"
469 send_gdb "continue\n"
471 -re "Breakpoint .* (at|in) $location_pattern\r\n$gdb_prompt $" {
474 -re ".*$gdb_prompt $" {
478 fail "$full_name (timeout)"
484 # gdb_internal_error_resync:
486 # Answer the questions GDB asks after it reports an internal error
487 # until we get back to a GDB prompt. Decline to quit the debugging
488 # session, and decline to create a core file. Return non-zero if the
491 # This procedure just answers whatever questions come up until it sees
492 # a GDB prompt; it doesn't require you to have matched the input up to
493 # any specific point. However, it only answers questions it sees in
494 # the output itself, so if you've matched a question, you had better
495 # answer it yourself before calling this.
497 # You can use this function thus:
501 # -re ".*A problem internal to GDB has been detected" {
502 # gdb_internal_error_resync
507 proc gdb_internal_error_resync {} {
511 while {$count < 10} {
513 -re "Quit this debugging session\\? \\(y or n\\) $" {
517 -re "Create a core file of GDB\\? \\(y or n\\) $" {
521 -re "$gdb_prompt $" {
522 # We're resynchronized.
526 perror "Could not resync from internal error (timeout)"
531 perror "Could not resync from internal error (resync count exceeded)"
536 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
537 # Send a command to gdb; test the result.
539 # COMMAND is the command to execute, send to GDB with send_gdb. If
540 # this is the null string no command is sent.
541 # MESSAGE is a message to be printed with the built-in failure patterns
542 # if one of them matches. If MESSAGE is empty COMMAND will be used.
543 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
544 # patterns. Pattern elements will be evaluated in the caller's
545 # context; action elements will be executed in the caller's context.
546 # Unlike patterns for gdb_test, these patterns should generally include
547 # the final newline and prompt.
550 # 1 if the test failed, according to a built-in failure pattern
551 # 0 if only user-supplied patterns matched
552 # -1 if there was an internal error.
554 # You can use this function thus:
556 # gdb_test_multiple "print foo" "test foo" {
557 # -re "expected output 1" {
560 # -re "expected output 2" {
565 # The standard patterns, such as "Program exited..." and "A problem
566 # ...", all being implicitly appended to that list.
568 proc gdb_test_multiple { command message user_code } {
572 upvar timeout timeout
573 upvar expect_out expect_out
575 if { $message == "" } {
579 # TCL/EXPECT WART ALERT
580 # Expect does something very strange when it receives a single braced
581 # argument. It splits it along word separators and performs substitutions.
582 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
583 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
584 # double-quoted list item, "\[ab\]" is just a long way of representing
585 # "[ab]", because the backslashes will be removed by lindex.
587 # Unfortunately, there appears to be no easy way to duplicate the splitting
588 # that expect will do from within TCL. And many places make use of the
589 # "\[0-9\]" construct, so we need to support that; and some places make use
590 # of the "[func]" construct, so we need to support that too. In order to
591 # get this right we have to substitute quoted list elements differently
592 # from braced list elements.
594 # We do this roughly the same way that Expect does it. We have to use two
595 # lists, because if we leave unquoted newlines in the argument to uplevel
596 # they'll be treated as command separators, and if we escape newlines
597 # we mangle newlines inside of command blocks. This assumes that the
598 # input doesn't contain a pattern which contains actual embedded newlines
601 regsub -all {\n} ${user_code} { } subst_code
602 set subst_code [uplevel list $subst_code]
604 set processed_code ""
606 set expecting_action 0
607 foreach item $user_code subst_item $subst_code {
608 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
609 lappend processed_code $item
612 if {$item == "-indices" || $item == "-re" || $item == "-ex"} {
613 lappend processed_code $item
616 if { $expecting_action } {
617 lappend processed_code "uplevel [list $item]"
618 set expecting_action 0
619 # Cosmetic, no effect on the list.
620 append processed_code "\n"
623 set expecting_action 1
624 lappend processed_code $subst_item
625 if {$patterns != ""} {
628 append patterns "\"$subst_item\""
631 # Also purely cosmetic.
632 regsub -all {\r} $patterns {\\r} patterns
633 regsub -all {\n} $patterns {\\n} patterns
636 send_user "Sending \"$command\" to gdb\n"
637 send_user "Looking to match \"$patterns\"\n"
638 send_user "Message is \"$message\"\n"
642 set string "${command}\n";
643 if { $command != "" } {
644 while { "$string" != "" } {
645 set foo [string first "\n" "$string"];
646 set len [string length "$string"];
647 if { $foo < [expr $len - 1] } {
648 set str [string range "$string" 0 $foo];
649 if { [send_gdb "$str"] != "" } {
650 global suppress_flag;
652 if { ! $suppress_flag } {
653 perror "Couldn't send $command to GDB.";
658 # since we're checking if each line of the multi-line
659 # command are 'accepted' by GDB here,
660 # we need to set -notransfer expect option so that
661 # command output is not lost for pattern matching
664 -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
665 timeout { verbose "partial: timeout" 3 }
667 set string [string range "$string" [expr $foo + 1] end];
672 if { "$string" != "" } {
673 if { [send_gdb "$string"] != "" } {
674 global suppress_flag;
676 if { ! $suppress_flag } {
677 perror "Couldn't send $command to GDB.";
685 if [target_info exists gdb,timeout] {
686 set tmt [target_info gdb,timeout];
688 if [info exists timeout] {
692 if [info exists timeout] {
701 -re ".*A problem internal to GDB has been detected" {
702 fail "$message (GDB internal error)"
703 gdb_internal_error_resync
705 -re "\\*\\*\\* DOSEXIT code.*" {
706 if { $message != "" } {
709 gdb_suppress_entire_file "GDB died";
713 append code $processed_code
715 -re "Ending remote debugging.*$gdb_prompt $" {
716 if ![isnative] then {
717 warning "Can`t communicate to remote target."
723 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
724 perror "Undefined command \"$command\"."
728 -re "Ambiguous command.*$gdb_prompt $" {
729 perror "\"$command\" is not a unique command name."
733 -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
734 if ![string match "" $message] then {
735 set errmsg "$message (the program exited)"
737 set errmsg "$command (the program exited)"
742 -re "EXIT code \[0-9\r\n\]+Program exited normally.*$gdb_prompt $" {
743 if ![string match "" $message] then {
744 set errmsg "$message (the program exited)"
746 set errmsg "$command (the program exited)"
751 -re "The program is not being run.*$gdb_prompt $" {
752 if ![string match "" $message] then {
753 set errmsg "$message (the program is no longer running)"
755 set errmsg "$command (the program is no longer running)"
760 -re "\r\n$gdb_prompt $" {
761 if ![string match "" $message] then {
768 perror "Window too small."
772 -re "\\(y or n\\) " {
774 perror "Got interactive prompt."
779 perror "Process no longer exists"
780 if { $message != "" } {
786 perror "internal buffer is full."
791 if ![string match "" $message] then {
792 fail "$message (timeout)"
799 set code [catch {gdb_expect $tmt $code} string]
801 global errorInfo errorCode;
802 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
803 } elseif {$code == 2} {
804 return -code return $string
805 } elseif {$code == 3} {
807 } elseif {$code > 4} {
808 return -code $code $string
813 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
814 # Send a command to gdb; test the result.
816 # COMMAND is the command to execute, send to GDB with send_gdb. If
817 # this is the null string no command is sent.
818 # PATTERN is the pattern to match for a PASS, and must NOT include
819 # the \r\n sequence immediately before the gdb prompt.
820 # MESSAGE is an optional message to be printed. If this is
821 # omitted, then the pass/fail messages use the command string as the
822 # message. (If this is the empty string, then sometimes we don't
823 # call pass or fail at all; I don't understand this at all.)
824 # QUESTION is a question GDB may ask in response to COMMAND, like
826 # RESPONSE is the response to send if QUESTION appears.
829 # 1 if the test failed,
830 # 0 if the test passes,
831 # -1 if there was an internal error.
833 proc gdb_test { args } {
837 upvar timeout timeout
839 if [llength $args]>2 then {
840 set message [lindex $args 2]
842 set message [lindex $args 0]
844 set command [lindex $args 0]
845 set pattern [lindex $args 1]
847 if [llength $args]==5 {
848 set question_string [lindex $args 3];
849 set response_string [lindex $args 4];
851 set question_string "^FOOBAR$"
854 return [gdb_test_multiple $command $message {
855 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
856 if ![string match "" $message] then {
860 -re "(${question_string})$" {
861 send_gdb "$response_string\n";
867 # Test that a command gives an error. For pass or fail, return
868 # a 1 to indicate that more tests can proceed. However a timeout
869 # is a serious error, generates a special fail message, and causes
870 # a 0 to be returned to indicate that more tests are likely to fail
873 proc test_print_reject { args } {
877 if [llength $args]==2 then {
878 set expectthis [lindex $args 1]
880 set expectthis "should never match this bogus string"
882 set sendthis [lindex $args 0]
884 send_user "Sending \"$sendthis\" to gdb\n"
885 send_user "Looking to match \"$expectthis\"\n"
887 send_gdb "$sendthis\n"
888 #FIXME: Should add timeout as parameter.
890 -re "A .* in expression.*\\.*$gdb_prompt $" {
891 pass "reject $sendthis"
894 -re "Invalid syntax in expression.*$gdb_prompt $" {
895 pass "reject $sendthis"
898 -re "Junk after end of expression.*$gdb_prompt $" {
899 pass "reject $sendthis"
902 -re "Invalid number.*$gdb_prompt $" {
903 pass "reject $sendthis"
906 -re "Invalid character constant.*$gdb_prompt $" {
907 pass "reject $sendthis"
910 -re "No symbol table is loaded.*$gdb_prompt $" {
911 pass "reject $sendthis"
914 -re "No symbol .* in current context.*$gdb_prompt $" {
915 pass "reject $sendthis"
918 -re "Unmatched single quote.*$gdb_prompt $" {
919 pass "reject $sendthis"
922 -re "A character constant must contain at least one character.*$gdb_prompt $" {
923 pass "reject $sendthis"
926 -re "$expectthis.*$gdb_prompt $" {
927 pass "reject $sendthis"
930 -re ".*$gdb_prompt $" {
931 fail "reject $sendthis"
935 fail "reject $sendthis (eof or timeout)"
941 # Given an input string, adds backslashes as needed to create a
942 # regexp that will match the string.
944 proc string_to_regexp {str} {
946 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
950 # Same as gdb_test, but the second parameter is not a regexp,
951 # but a string that must match exactly.
953 proc gdb_test_exact { args } {
954 upvar timeout timeout
956 set command [lindex $args 0]
958 # This applies a special meaning to a null string pattern. Without
959 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
960 # messages from commands that should have no output except a new
961 # prompt. With this, only results of a null string will match a null
964 set pattern [lindex $args 1]
965 if [string match $pattern ""] {
966 set pattern [string_to_regexp [lindex $args 0]]
968 set pattern [string_to_regexp [lindex $args 1]]
971 # It is most natural to write the pattern argument with only
972 # embedded \n's, especially if you are trying to avoid Tcl quoting
973 # problems. But gdb_expect really wants to see \r\n in patterns. So
974 # transform the pattern here. First transform \r\n back to \n, in
975 # case some users of gdb_test_exact already do the right thing.
976 regsub -all "\r\n" $pattern "\n" pattern
977 regsub -all "\n" $pattern "\r\n" pattern
978 if [llength $args]==3 then {
979 set message [lindex $args 2]
984 return [gdb_test $command $pattern $message]
987 proc gdb_reinitialize_dir { subdir } {
990 if [is_remote host] {
995 -re "Reinitialize source path to empty.*y or n. " {
998 -re "Source directories searched.*$gdb_prompt $" {
999 send_gdb "dir $subdir\n"
1001 -re "Source directories searched.*$gdb_prompt $" {
1002 verbose "Dir set to $subdir"
1004 -re "$gdb_prompt $" {
1005 perror "Dir \"$subdir\" failed."
1009 -re "$gdb_prompt $" {
1010 perror "Dir \"$subdir\" failed."
1014 -re "$gdb_prompt $" {
1015 perror "Dir \"$subdir\" failed."
1021 # gdb_exit -- exit the GDB, killing the target program if necessary
1023 proc default_gdb_exit {} {
1025 global INTERNAL_GDBFLAGS GDBFLAGS
1027 global gdb_spawn_id;
1029 gdb_stop_suppressing_tests;
1031 if ![info exists gdb_spawn_id] {
1035 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1037 if { [is_remote host] && [board_info host exists fileid] } {
1044 -re "DOSEXIT code" { }
1049 if ![is_remote host] {
1055 # Load a file into the debugger.
1056 # The return value is 0 for success, -1 for failure.
1058 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1059 # to one of these values:
1061 # debug file was loaded successfully and has debug information
1062 # nodebug file was loaded successfully and has no debug information
1063 # fail file was not loaded
1065 # I tried returning this information as part of the return value,
1066 # but ran into a mess because of the many re-implementations of
1067 # gdb_load in config/*.exp.
1069 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1070 # this if they can get more information set.
1072 proc gdb_file_cmd { arg } {
1076 global last_loaded_file
1078 set last_loaded_file $arg
1080 # Set whether debug info was found.
1081 # Default to "fail".
1082 global gdb_file_cmd_debug_info
1083 set gdb_file_cmd_debug_info "fail"
1085 if [is_remote host] {
1086 set arg [remote_download host $arg]
1088 perror "download failed"
1093 # The file command used to kill the remote target. For the benefit
1094 # of the testsuite, preserve this behavior.
1097 -re "Kill the program being debugged. .y or n. $" {
1099 verbose "\t\tKilling previous program being debugged"
1102 -re "$gdb_prompt $" {
1107 send_gdb "file $arg\n"
1109 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1110 verbose "\t\tLoaded $arg into the $GDB with no debugging symbols"
1111 set gdb_file_cmd_debug_info "nodebug"
1114 -re "Reading symbols from.*done.*$gdb_prompt $" {
1115 verbose "\t\tLoaded $arg into the $GDB"
1116 set gdb_file_cmd_debug_info "debug"
1119 -re "Load new symbol table from \".*\".*y or n. $" {
1122 -re "Reading symbols from.*done.*$gdb_prompt $" {
1123 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1124 set gdb_file_cmd_debug_info "debug"
1128 perror "(timeout) Couldn't load $arg, other program already loaded."
1133 -re "No such file or directory.*$gdb_prompt $" {
1134 perror "($arg) No such file or directory"
1137 -re "$gdb_prompt $" {
1138 perror "couldn't load $arg into $GDB."
1142 perror "couldn't load $arg into $GDB (timed out)."
1146 # This is an attempt to detect a core dump, but seems not to
1147 # work. Perhaps we need to match .* followed by eof, in which
1148 # gdb_expect does not seem to have a way to do that.
1149 perror "couldn't load $arg into $GDB (end of file)."
1156 # start gdb -- start gdb running, default procedure
1158 # When running over NFS, particularly if running many simultaneous
1159 # tests on different hosts all using the same server, things can
1160 # get really slow. Give gdb at least 3 minutes to start up.
1162 proc default_gdb_start { } {
1165 global INTERNAL_GDBFLAGS GDBFLAGS
1168 global gdb_spawn_id;
1171 gdb_stop_suppressing_tests;
1175 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
1176 # the test results. Even if /dev/null doesn't exist on the particular
1177 # platform, the readline library will use the default setting just by
1178 # failing to open the file. OTOH, opening /dev/null successfully will
1179 # also result in the default settings being used since nothing will be
1180 # read from this file.
1181 set env(INPUTRC) "/dev/null"
1183 # The gdb.base/readline.exp arrow key test relies on the standard VT100
1184 # bindings, so make sure that an appropriate terminal is selected.
1185 # The same bug doesn't show up if we use ^P / ^N instead.
1186 set env(TERM) "vt100"
1188 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1190 if [info exists gdb_spawn_id] {
1194 if ![is_remote host] {
1195 if { [which $GDB] == 0 } then {
1196 perror "$GDB does not exist."
1200 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"];
1201 if { $res < 0 || $res == "" } {
1202 perror "Spawning $GDB failed."
1206 -re "\[\r\n\]$gdb_prompt $" {
1207 verbose "GDB initialized."
1209 -re "$gdb_prompt $" {
1210 perror "GDB never initialized."
1214 perror "(timeout) GDB never initialized after 10 seconds."
1219 set gdb_spawn_id -1;
1220 # force the height to "unlimited", so no pagers get used
1222 send_gdb "set height 0\n"
1224 -re "$gdb_prompt $" {
1225 verbose "Setting height to 0." 2
1228 warning "Couldn't set the height to 0"
1231 # force the width to "unlimited", so no wraparound occurs
1232 send_gdb "set width 0\n"
1234 -re "$gdb_prompt $" {
1235 verbose "Setting width to 0." 2
1238 warning "Couldn't set the width to 0."
1244 # Return a 1 for configurations for which we don't even want to try to
1247 proc skip_cplus_tests {} {
1248 if { [istarget "h8300-*-*"] } {
1252 # The C++ IO streams are too large for HC11/HC12 and are thus not
1253 # available. The gdb C++ tests use them and don't compile.
1254 if { [istarget "m6811-*-*"] } {
1257 if { [istarget "m6812-*-*"] } {
1263 # Return a 1 if I don't even want to try to test FORTRAN.
1265 proc skip_fortran_tests {} {
1269 # Return a 1 if we should skip shared library tests.
1271 proc skip_shlib_tests {} {
1272 # Run the shared library tests on native systems.
1277 # An abbreviated list of remote targets where we should be able to
1278 # run shared library tests.
1279 if {([istarget *-*-linux*]
1280 || [istarget *-*-*bsd*]
1281 || [istarget *-*-solaris2*]
1282 || [istarget arm*-*-symbianelf*]
1283 || [istarget *-*-mingw*]
1284 || [istarget *-*-cygwin*]
1285 || [istarget *-*-pe*])} {
1292 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1293 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1295 proc skip_altivec_tests {} {
1296 global skip_vmx_tests_saved
1297 global srcdir subdir gdb_prompt
1299 # Use the cached value, if it exists.
1300 set me "skip_altivec_tests"
1301 if [info exists skip_vmx_tests_saved] {
1302 verbose "$me: returning saved $skip_vmx_tests_saved" 2
1303 return $skip_vmx_tests_saved
1306 # Some simulators are known to not support VMX instructions.
1307 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1308 verbose "$me: target known to not support VMX, returning 1" 2
1309 return [set skip_vmx_tests_saved 1]
1312 # Make sure we have a compiler that understands altivec.
1313 set compile_flags {debug nowarnings}
1314 if [get_compiler_info not-used] {
1315 warning "Could not get compiler info"
1318 if [test_compiler_info gcc*] {
1319 set compile_flags "$compile_flags additional_flags=-maltivec"
1320 } elseif [test_compiler_info xlc*] {
1321 set compile_flags "$compile_flags additional_flags=-qaltivec"
1323 verbose "Could not compile with altivec support, returning 1" 2
1327 # Set up, compile, and execute a test program containing VMX instructions.
1328 # Include the current process ID in the file names to prevent conflicts
1329 # with invocations for multiple testsuites.
1333 set f [open $src "w"]
1334 puts $f "int main() {"
1335 puts $f "#ifdef __MACH__"
1336 puts $f " asm volatile (\"vor v0,v0,v0\");"
1338 puts $f " asm volatile (\"vor 0,0,0\");"
1340 puts $f " return 0; }"
1343 verbose "$me: compiling testfile $src" 2
1344 set lines [gdb_compile $src $exe executable $compile_flags]
1347 if ![string match "" $lines] then {
1348 verbose "$me: testfile compilation failed, returning 1" 2
1349 return [set skip_vmx_tests_saved 1]
1352 # No error message, compilation succeeded so now run it via gdb.
1356 gdb_reinitialize_dir $srcdir/$subdir
1360 -re ".*Illegal instruction.*${gdb_prompt} $" {
1361 verbose -log "\n$me altivec hardware not detected"
1362 set skip_vmx_tests_saved 1
1364 -re ".*Program exited normally.*${gdb_prompt} $" {
1365 verbose -log "\n$me: altivec hardware detected"
1366 set skip_vmx_tests_saved 0
1369 warning "\n$me: default case taken"
1370 set skip_vmx_tests_saved 1
1374 remote_file build delete $exe
1376 verbose "$me: returning $skip_vmx_tests_saved" 2
1377 return $skip_vmx_tests_saved
1380 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1381 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1383 proc skip_vsx_tests {} {
1384 global skip_vsx_tests_saved
1385 global srcdir subdir gdb_prompt
1387 # Use the cached value, if it exists.
1388 set me "skip_vsx_tests"
1389 if [info exists skip_vsx_tests_saved] {
1390 verbose "$me: returning saved $skip_vsx_tests_saved" 2
1391 return $skip_vsx_tests_saved
1394 # Some simulators are known to not support Altivec instructions, so
1395 # they won't support VSX instructions as well.
1396 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1397 verbose "$me: target known to not support VSX, returning 1" 2
1398 return [set skip_vsx_tests_saved 1]
1401 # Make sure we have a compiler that understands altivec.
1402 set compile_flags {debug nowarnings quiet}
1403 if [get_compiler_info not-used] {
1404 warning "Could not get compiler info"
1407 if [test_compiler_info gcc*] {
1408 set compile_flags "$compile_flags additional_flags=-mvsx"
1409 } elseif [test_compiler_info xlc*] {
1410 set compile_flags "$compile_flags additional_flags=-qvsx"
1412 verbose "Could not compile with vsx support, returning 1" 2
1419 set f [open $src "w"]
1420 puts $f "int main() {"
1421 puts $f "#ifdef __MACH__"
1422 puts $f " asm volatile (\"lxvd2x v0,v0,v0\");"
1424 puts $f " asm volatile (\"lxvd2x 0,0,0\");"
1426 puts $f " return 0; }"
1429 verbose "$me: compiling testfile $src" 2
1430 set lines [gdb_compile $src $exe executable $compile_flags]
1433 if ![string match "" $lines] then {
1434 verbose "$me: testfile compilation failed, returning 1" 2
1435 return [set skip_vsx_tests_saved 1]
1438 # No error message, compilation succeeded so now run it via gdb.
1442 gdb_reinitialize_dir $srcdir/$subdir
1446 -re ".*Illegal instruction.*${gdb_prompt} $" {
1447 verbose -log "\n$me VSX hardware not detected"
1448 set skip_vsx_tests_saved 1
1450 -re ".*Program exited normally.*${gdb_prompt} $" {
1451 verbose -log "\n$me: VSX hardware detected"
1452 set skip_vsx_tests_saved 0
1455 warning "\n$me: default case taken"
1456 set skip_vsx_tests_saved 1
1460 remote_file build delete $exe
1462 verbose "$me: returning $skip_vsx_tests_saved" 2
1463 return $skip_vsx_tests_saved
1466 # Skip all the tests in the file if you are not on an hppa running
1469 proc skip_hp_tests {} {
1470 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
1471 verbose "Skip hp tests is $skip_hp"
1475 # Return whether we should skip tests for showing inlined functions in
1476 # backtraces. Requires get_compiler_info and get_debug_format.
1478 proc skip_inline_frame_tests {} {
1479 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1480 if { ! [test_debug_format "DWARF 2"] } {
1484 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
1485 if { ([test_compiler_info "gcc-2-*"]
1486 || [test_compiler_info "gcc-3-*"]
1487 || [test_compiler_info "gcc-4-0-*"]) } {
1494 # Return whether we should skip tests for showing variables from
1495 # inlined functions. Requires get_compiler_info and get_debug_format.
1497 proc skip_inline_var_tests {} {
1498 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1499 if { ! [test_debug_format "DWARF 2"] } {
1506 set compiler_info "unknown"
1508 set hp_cc_compiler 0
1509 set hp_aCC_compiler 0
1511 # Figure out what compiler I am using.
1513 # BINFILE is a "compiler information" output file. This implementation
1514 # does not use BINFILE.
1516 # ARGS can be empty or "C++". If empty, "C" is assumed.
1518 # There are several ways to do this, with various problems.
1520 # [ gdb_compile -E $ifile -o $binfile.ci ]
1521 # source $binfile.ci
1523 # Single Unix Spec v3 says that "-E -o ..." together are not
1524 # specified. And in fact, the native compiler on hp-ux 11 (among
1525 # others) does not work with "-E -o ...". Most targets used to do
1526 # this, and it mostly worked, because it works with gcc.
1528 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1529 # source $binfile.ci
1531 # This avoids the problem with -E and -o together. This almost works
1532 # if the build machine is the same as the host machine, which is
1533 # usually true of the targets which are not gcc. But this code does
1534 # not figure which compiler to call, and it always ends up using the C
1535 # compiler. Not good for setting hp_aCC_compiler. Targets
1536 # hppa*-*-hpux* and mips*-*-irix* used to do this.
1538 # [ gdb_compile -E $ifile > $binfile.ci ]
1539 # source $binfile.ci
1541 # dejagnu target_compile says that it supports output redirection,
1542 # but the code is completely different from the normal path and I
1543 # don't want to sweep the mines from that path. So I didn't even try
1546 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1549 # I actually do this for all targets now. gdb_compile runs the right
1550 # compiler, and TCL captures the output, and I eval the output.
1552 # Unfortunately, expect logs the output of the command as it goes by,
1553 # and dejagnu helpfully prints a second copy of it right afterwards.
1554 # So I turn off expect logging for a moment.
1556 # [ gdb_compile $ifile $ciexe_file executable $args ]
1557 # [ remote_exec $ciexe_file ]
1558 # [ source $ci_file.out ]
1560 # I could give up on -E and just do this.
1561 # I didn't get desperate enough to try this.
1563 # -- chastain 2004-01-06
1565 proc get_compiler_info {binfile args} {
1566 # For compiler.c and compiler.cc
1569 # I am going to play with the log to keep noise out.
1573 # These come from compiler.c or compiler.cc
1574 global compiler_info
1576 # Legacy global data symbols.
1578 global hp_cc_compiler
1579 global hp_aCC_compiler
1581 # Choose which file to preprocess.
1582 set ifile "${srcdir}/lib/compiler.c"
1583 if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1584 set ifile "${srcdir}/lib/compiler.cc"
1587 # Run $ifile through the right preprocessor.
1588 # Toggle gdb.log to keep the compiler output out of the log.
1590 if [is_remote host] {
1591 # We have to use -E and -o together, despite the comments
1592 # above, because of how DejaGnu handles remote host testing.
1593 set ppout "$outdir/compiler.i"
1594 gdb_compile "${ifile}" "$ppout" preprocess [list "$args" quiet]
1595 set file [open $ppout r]
1596 set cppout [read $file]
1599 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
1601 log_file -a "$outdir/$tool.log"
1605 foreach cppline [ split "$cppout" "\n" ] {
1606 if { [ regexp "^#" "$cppline" ] } {
1608 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
1610 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
1612 verbose "get_compiler_info: $cppline" 2
1616 verbose -log "get_compiler_info: $cppline"
1621 # Reset to unknown compiler if any diagnostics happened.
1623 set compiler_info "unknown"
1626 # Set the legacy symbols.
1628 set hp_cc_compiler 0
1629 set hp_aCC_compiler 0
1630 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
1631 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
1632 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
1633 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
1634 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
1635 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
1636 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
1638 # Log what happened.
1639 verbose -log "get_compiler_info: $compiler_info"
1641 # Most compilers will evaluate comparisons and other boolean
1642 # operations to 0 or 1.
1643 uplevel \#0 { set true 1 }
1644 uplevel \#0 { set false 0 }
1646 # Use of aCC results in boolean results being displayed as
1648 if { $hp_aCC_compiler } {
1649 uplevel \#0 { set true true }
1650 uplevel \#0 { set false false }
1656 proc test_compiler_info { {compiler ""} } {
1657 global compiler_info
1659 # if no arg, return the compiler_info string
1661 if [string match "" $compiler] {
1662 if [info exists compiler_info] {
1663 return $compiler_info
1665 perror "No compiler info found."
1669 return [string match $compiler $compiler_info]
1672 set gdb_wrapper_initialized 0
1674 proc gdb_wrapper_init { args } {
1675 global gdb_wrapper_initialized;
1676 global gdb_wrapper_file;
1677 global gdb_wrapper_flags;
1679 if { $gdb_wrapper_initialized == 1 } { return; }
1681 if {[target_info exists needs_status_wrapper] && \
1682 [target_info needs_status_wrapper] != "0"} {
1683 set result [build_wrapper "testglue.o"];
1684 if { $result != "" } {
1685 set gdb_wrapper_file [lindex $result 0];
1686 set gdb_wrapper_flags [lindex $result 1];
1688 warning "Status wrapper failed to build."
1691 set gdb_wrapper_initialized 1
1694 # Some targets need to always link a special object in. Save its path here.
1695 global gdb_saved_set_unbuffered_mode_obj
1696 set gdb_saved_set_unbuffered_mode_obj ""
1698 proc gdb_compile {source dest type options} {
1699 global GDB_TESTCASE_OPTIONS;
1700 global gdb_wrapper_file;
1701 global gdb_wrapper_flags;
1702 global gdb_wrapper_initialized;
1705 global gdb_saved_set_unbuffered_mode_obj
1707 set outdir [file dirname $dest]
1709 # Add platform-specific options if a shared library was specified using
1710 # "shlib=librarypath" in OPTIONS.
1713 foreach opt $options {
1714 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
1715 if [test_compiler_info "xlc-*"] {
1716 # IBM xlc compiler doesn't accept shared library named other
1717 # than .so: use "-Wl," to bypass this
1718 lappend source "-Wl,$shlib_name"
1719 } elseif { ([istarget "*-*-mingw*"]
1720 || [istarget *-*-cygwin*]
1721 || [istarget *-*-pe*])} {
1722 lappend source "${shlib_name}.a"
1724 lappend source $shlib_name
1726 if {$shlib_found == 0} {
1728 if { ([test_compiler_info "gcc-*"]
1729 && ([istarget "powerpc*-*-aix*"]
1730 || [istarget "rs6000*-*-aix*"] )) } {
1731 lappend options "additional_flags=-L${outdir}"
1732 } elseif { [istarget "mips-sgi-irix*"] } {
1733 lappend options "additional_flags=-rpath ${outdir}"
1736 } elseif { $opt == "shlib_load" } {
1737 if { ([istarget "*-*-mingw*"]
1738 || [istarget *-*-cygwin*]
1739 || [istarget *-*-pe*]
1740 || [istarget arm*-*-symbianelf*]
1741 || [istarget hppa*-*-hpux*])} {
1742 # Do not need anything.
1743 } elseif { [istarget *-*-openbsd*] } {
1744 lappend new_options "additional_flags=-Wl,-rpath,${outdir}"
1746 lappend new_options "libs=-ldl"
1747 lappend new_options "additional_flags=-Wl,-rpath,\\\$ORIGIN"
1750 lappend new_options $opt
1753 set options $new_options
1755 if [target_info exists gdb_stub] {
1756 set options2 { "additional_flags=-Dusestubs" }
1757 lappend options "libs=[target_info gdb_stub]";
1758 set options [concat $options2 $options]
1760 if [target_info exists is_vxworks] {
1761 set options2 { "additional_flags=-Dvxworks" }
1762 lappend options "libs=[target_info gdb_stub]";
1763 set options [concat $options2 $options]
1765 if [info exists GDB_TESTCASE_OPTIONS] {
1766 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
1768 verbose "options are $options"
1769 verbose "source is $source $dest $type $options"
1771 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
1773 if {[target_info exists needs_status_wrapper] && \
1774 [target_info needs_status_wrapper] != "0" && \
1775 [info exists gdb_wrapper_file]} {
1776 lappend options "libs=${gdb_wrapper_file}"
1777 lappend options "ldflags=${gdb_wrapper_flags}"
1780 # Replace the "nowarnings" option with the appropriate additional_flags
1781 # to disable compiler warnings.
1782 set nowarnings [lsearch -exact $options nowarnings]
1783 if {$nowarnings != -1} {
1784 if [target_info exists gdb,nowarnings_flag] {
1785 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
1787 set flag "additional_flags=-w"
1789 set options [lreplace $options $nowarnings $nowarnings $flag]
1792 if { $type == "executable" } {
1793 if { ([istarget "*-*-mingw*"]
1794 || [istarget "*-*-*djgpp"]
1795 || [istarget "*-*-cygwin*"])} {
1796 # Force output to unbuffered mode, by linking in an object file
1797 # with a global contructor that calls setvbuf.
1799 # Compile the special object seperatelly for two reasons:
1800 # 1) Insulate it from $options.
1801 # 2) Avoid compiling it for every gdb_compile invocation,
1802 # which is time consuming, especially if we're remote
1805 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
1806 verbose "compiling gdb_saved_set_unbuffered_obj"
1807 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
1808 set unbuf_obj ${objdir}/set_unbuffered_mode.o
1810 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
1811 if { $result != "" } {
1815 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
1816 # Link a copy of the output object, because the
1817 # original may be automatically deleted.
1818 remote_exec host "cp -f $unbuf_obj $gdb_saved_set_unbuffered_mode_obj"
1820 verbose "gdb_saved_set_unbuffered_obj already compiled"
1823 # Rely on the internal knowledge that the global ctors are ran in
1824 # reverse link order. In that case, we can use ldflags to
1825 # avoid copying the object file to the host multiple
1827 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
1831 set result [target_compile $source $dest $type $options];
1833 # Prune uninteresting compiler (and linker) output.
1834 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
1836 regsub "\[\r\n\]*$" "$result" "" result;
1837 regsub "^\[\r\n\]*" "$result" "" result;
1839 if { $result != "" && [lsearch $options quiet] == -1} {
1840 clone_output "gdb compile failed, $result"
1846 # This is just like gdb_compile, above, except that it tries compiling
1847 # against several different thread libraries, to see which one this
1849 proc gdb_compile_pthreads {source dest type options} {
1851 set why_msg "unrecognized error"
1852 foreach lib {-lpthreads -lpthread -lthread} {
1853 # This kind of wipes out whatever libs the caller may have
1854 # set. Or maybe theirs will override ours. How infelicitous.
1855 set options_with_lib [concat $options [list libs=$lib quiet]]
1856 set ccout [gdb_compile $source $dest $type $options_with_lib]
1857 switch -regexp -- $ccout {
1858 ".*no posix threads support.*" {
1859 set why_msg "missing threads include file"
1862 ".*cannot open -lpthread.*" {
1863 set why_msg "missing runtime threads library"
1865 ".*Can't find library for -lpthread.*" {
1866 set why_msg "missing runtime threads library"
1869 pass "successfully compiled posix threads test case"
1875 if {!$built_binfile} {
1876 unsupported "Couldn't compile $source: ${why_msg}"
1881 # Build a shared library from SOURCES. You must use get_compiler_info
1884 proc gdb_compile_shlib {sources dest options} {
1885 set obj_options $options
1887 switch -glob [test_compiler_info] {
1889 lappend obj_options "additional_flags=-qpic"
1892 if { !([istarget "powerpc*-*-aix*"]
1893 || [istarget "rs6000*-*-aix*"]
1894 || [istarget "*-*-cygwin*"]
1895 || [istarget "*-*-mingw*"]
1896 || [istarget "*-*-pe*"]) } {
1897 lappend obj_options "additional_flags=-fpic"
1901 switch -glob [istarget] {
1903 lappend obj_options "additional_flags=+z"
1906 # Disable SGI compiler's implicit -Dsgi
1907 lappend obj_options "additional_flags=-Usgi"
1910 # don't know what the compiler is...
1916 set outdir [file dirname $dest]
1918 foreach source $sources {
1919 set sourcebase [file tail $source]
1920 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
1923 lappend objects ${outdir}/${sourcebase}.o
1926 if [istarget "hppa*-*-hpux*"] {
1927 remote_exec build "ld -b ${objects} -o ${dest}"
1929 set link_options $options
1930 if [test_compiler_info "xlc-*"] {
1931 lappend link_options "additional_flags=-qmkshrobj"
1933 lappend link_options "additional_flags=-shared"
1935 if { ([istarget "*-*-mingw*"]
1936 || [istarget *-*-cygwin*]
1937 || [istarget *-*-pe*])} {
1938 lappend link_options "additional_flags=-Wl,--out-implib,${dest}.a"
1941 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
1947 # This is just like gdb_compile_pthreads, above, except that we always add the
1948 # objc library for compiling Objective-C programs
1949 proc gdb_compile_objc {source dest type options} {
1951 set why_msg "unrecognized error"
1952 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
1953 # This kind of wipes out whatever libs the caller may have
1954 # set. Or maybe theirs will override ours. How infelicitous.
1955 if { $lib == "solaris" } {
1956 set lib "-lpthread -lposix4"
1958 if { $lib != "-lobjc" } {
1959 set lib "-lobjc $lib"
1961 set options_with_lib [concat $options [list libs=$lib quiet]]
1962 set ccout [gdb_compile $source $dest $type $options_with_lib]
1963 switch -regexp -- $ccout {
1964 ".*no posix threads support.*" {
1965 set why_msg "missing threads include file"
1968 ".*cannot open -lpthread.*" {
1969 set why_msg "missing runtime threads library"
1971 ".*Can't find library for -lpthread.*" {
1972 set why_msg "missing runtime threads library"
1975 pass "successfully compiled objc with posix threads test case"
1981 if {!$built_binfile} {
1982 unsupported "Couldn't compile $source: ${why_msg}"
1987 proc send_gdb { string } {
1988 global suppress_flag;
1989 if { $suppress_flag } {
1990 return "suppressed";
1992 return [remote_send host "$string"];
1998 proc gdb_expect { args } {
1999 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
2000 set atimeout [lindex $args 0];
2001 set expcode [list [lindex $args 1]];
2006 upvar timeout timeout;
2008 if [target_info exists gdb,timeout] {
2009 if [info exists timeout] {
2010 if { $timeout < [target_info gdb,timeout] } {
2011 set gtimeout [target_info gdb,timeout];
2013 set gtimeout $timeout;
2016 set gtimeout [target_info gdb,timeout];
2020 if ![info exists gtimeout] {
2022 if [info exists timeout] {
2023 set gtimeout $timeout;
2027 if [info exists atimeout] {
2028 if { ![info exists gtimeout] || $gtimeout < $atimeout } {
2029 set $gtimeout $atimeout;
2032 if ![info exists gtimeout] {
2038 global suppress_flag;
2039 global remote_suppress_flag;
2040 if [info exists remote_suppress_flag] {
2041 set old_val $remote_suppress_flag;
2043 if [info exists suppress_flag] {
2044 if { $suppress_flag } {
2045 set remote_suppress_flag 1;
2049 {uplevel remote_expect host $gtimeout $expcode} string];
2050 if [info exists old_val] {
2051 set remote_suppress_flag $old_val;
2053 if [info exists remote_suppress_flag] {
2054 unset remote_suppress_flag;
2059 global errorInfo errorCode;
2061 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
2062 } elseif {$code == 2} {
2063 return -code return $string
2064 } elseif {$code == 3} {
2066 } elseif {$code > 4} {
2067 return -code $code $string
2071 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
2073 # Check for long sequence of output by parts.
2074 # MESSAGE: is the test message to be printed with the test success/fail.
2075 # SENTINEL: Is the terminal pattern indicating that output has finished.
2076 # LIST: is the sequence of outputs to match.
2077 # If the sentinel is recognized early, it is considered an error.
2080 # 1 if the test failed,
2081 # 0 if the test passes,
2082 # -1 if there was an internal error.
2084 proc gdb_expect_list {test sentinel list} {
2086 global suppress_flag
2089 if { $suppress_flag } {
2091 unresolved "${test}"
2093 while { ${index} < [llength ${list}] } {
2094 set pattern [lindex ${list} ${index}]
2095 set index [expr ${index} + 1]
2096 if { ${index} == [llength ${list}] } {
2099 -re "${pattern}${sentinel}" {
2100 # pass "${test}, pattern ${index} + sentinel"
2103 fail "${test} (pattern ${index} + sentinel)"
2106 -re ".*A problem internal to GDB has been detected" {
2107 fail "${test} (GDB internal error)"
2109 gdb_internal_error_resync
2112 fail "${test} (pattern ${index} + sentinel) (timeout)"
2117 # unresolved "${test}, pattern ${index} + sentinel"
2123 # pass "${test}, pattern ${index}"
2126 fail "${test} (pattern ${index})"
2129 -re ".*A problem internal to GDB has been detected" {
2130 fail "${test} (GDB internal error)"
2132 gdb_internal_error_resync
2135 fail "${test} (pattern ${index}) (timeout)"
2140 # unresolved "${test}, pattern ${index}"
2154 proc gdb_suppress_entire_file { reason } {
2155 global suppress_flag;
2157 warning "$reason\n";
2158 set suppress_flag -1;
2162 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
2163 # gdb_expect to fail immediately (until the next call to
2164 # gdb_stop_suppressing_tests).
2166 proc gdb_suppress_tests { args } {
2167 global suppress_flag;
2169 return; # fnf - disable pending review of results where
2170 # testsuite ran better without this
2173 if { $suppress_flag == 1 } {
2174 if { [llength $args] > 0 } {
2175 warning "[lindex $args 0]\n";
2177 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
2183 # Clear suppress_flag.
2185 proc gdb_stop_suppressing_tests { } {
2186 global suppress_flag;
2188 if [info exists suppress_flag] {
2189 if { $suppress_flag > 0 } {
2190 set suppress_flag 0;
2191 clone_output "Tests restarted.\n";
2194 set suppress_flag 0;
2198 proc gdb_clear_suppressed { } {
2199 global suppress_flag;
2201 set suppress_flag 0;
2204 proc gdb_start { } {
2209 catch default_gdb_exit
2213 # gdb_load_cmd -- load a file into the debugger.
2214 # ARGS - additional args to load command.
2215 # return a -1 if anything goes wrong.
2217 proc gdb_load_cmd { args } {
2220 if [target_info exists gdb_load_timeout] {
2221 set loadtimeout [target_info gdb_load_timeout]
2223 set loadtimeout 1600
2225 send_gdb "load $args\n"
2226 verbose "Timeout is now $loadtimeout seconds" 2
2227 gdb_expect $loadtimeout {
2228 -re "Loading section\[^\r\]*\r\n" {
2231 -re "Start address\[\r\]*\r\n" {
2234 -re "Transfer rate\[\r\]*\r\n" {
2237 -re "Memory access error\[^\r\]*\r\n" {
2238 perror "Failed to load program"
2241 -re "$gdb_prompt $" {
2244 -re "(.*)\r\n$gdb_prompt " {
2245 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
2249 perror "Timed out trying to load $args."
2258 # Copy a file to the remote target and return its target filename.
2259 # Schedule the file to be deleted at the end of this test.
2261 proc gdb_download { filename } {
2264 set destname [remote_download target $filename]
2265 lappend cleanfiles $destname
2269 # gdb_load_shlibs LIB...
2271 # Copy the listed libraries to the target.
2273 proc gdb_load_shlibs { args } {
2274 if {![is_remote target]} {
2278 foreach file $args {
2282 # Even if the target supplies full paths for shared libraries,
2283 # they may not be paths for this system.
2284 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
2288 # gdb_load -- load a file into the debugger.
2289 # Many files in config/*.exp override this procedure.
2291 proc gdb_load { arg } {
2292 return [gdb_file_cmd $arg]
2295 # gdb_reload -- load a file into the target. Called before "running",
2296 # either the first time or after already starting the program once,
2297 # for remote targets. Most files that override gdb_load should now
2298 # override this instead.
2300 proc gdb_reload { } {
2301 # For the benefit of existing configurations, default to gdb_load.
2302 # Specifying no file defaults to the executable currently being
2304 return [gdb_load ""]
2307 proc gdb_continue { function } {
2310 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
2313 proc default_gdb_init { args } {
2314 global gdb_wrapper_initialized
2319 gdb_clear_suppressed;
2321 # Make sure that the wrapper is rebuilt
2322 # with the appropriate multilib option.
2323 set gdb_wrapper_initialized 0
2325 # Unlike most tests, we have a small number of tests that generate
2326 # a very large amount of output. We therefore increase the expect
2327 # buffer size to be able to contain the entire test output.
2330 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
2331 if { [llength $args] > 0 } {
2334 set file [lindex $args 0];
2336 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
2339 if [target_info exists gdb_prompt] {
2340 set gdb_prompt [target_info gdb_prompt];
2342 set gdb_prompt "\\(gdb\\)"
2346 proc gdb_init { args } {
2347 return [eval default_gdb_init $args];
2350 proc gdb_finish { } {
2353 # Exit first, so that the files are no longer in use.
2356 if { [llength $cleanfiles] > 0 } {
2357 eval remote_file target delete $cleanfiles
2363 set debug_format "unknown"
2365 # Run the gdb command "info source" and extract the debugging format
2366 # information from the output and save it in debug_format.
2368 proc get_debug_format { } {
2374 set debug_format "unknown"
2375 send_gdb "info source\n"
2377 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
2378 set debug_format $expect_out(1,string)
2379 verbose "debug format is $debug_format"
2382 -re "No current source file.\r\n$gdb_prompt $" {
2383 perror "get_debug_format used when no current source file"
2386 -re "$gdb_prompt $" {
2387 warning "couldn't check debug format (no valid response)."
2391 warning "couldn't check debug format (timed out)."
2397 # Return true if FORMAT matches the debug format the current test was
2398 # compiled with. FORMAT is a shell-style globbing pattern; it can use
2399 # `*', `[...]', and so on.
2401 # This function depends on variables set by `get_debug_format', above.
2403 proc test_debug_format {format} {
2406 return [expr [string match $format $debug_format] != 0]
2409 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
2410 # COFF, stabs, etc). If that format matches the format that the
2411 # current test was compiled with, then the next test is expected to
2412 # fail for any target. Returns 1 if the next test or set of tests is
2413 # expected to fail, 0 otherwise (or if it is unknown). Must have
2414 # previously called get_debug_format.
2415 proc setup_xfail_format { format } {
2416 set ret [test_debug_format $format];
2424 proc gdb_step_for_stub { } {
2427 if ![target_info exists gdb,use_breakpoint_for_stub] {
2428 if [target_info exists gdb_stub_step_command] {
2429 set command [target_info gdb_stub_step_command];
2433 send_gdb "${command}\n";
2436 -re "(main.* at |.*in .*start).*$gdb_prompt" {
2439 -re ".*$gdb_prompt" {
2441 if { $tries == 5 } {
2442 fail "stepping out of breakpoint function";
2445 send_gdb "${command}\n";
2449 fail "stepping out of breakpoint function";
2456 -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
2457 set file $expect_out(1,string);
2458 set linenum [expr $expect_out(2,string) + 1];
2459 set breakplace "${file}:${linenum}";
2463 send_gdb "break ${breakplace}\n";
2465 -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
2466 set breakpoint $expect_out(1,string);
2468 -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
2469 set breakpoint $expect_out(1,string);
2473 send_gdb "continue\n";
2475 -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
2476 gdb_test "delete $breakpoint" ".*" "";
2483 # gdb_get_line_number TEXT [FILE]
2485 # Search the source file FILE, and return the line number of the
2486 # first line containing TEXT. If no match is found, return -1.
2488 # TEXT is a string literal, not a regular expression.
2490 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
2491 # specified, and does not start with "/", then it is assumed to be in
2492 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
2493 # by changing the callers and the interface at the same time.
2494 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
2495 # gdb.base/ena-dis-br.exp.
2497 # Use this function to keep your test scripts independent of the
2498 # exact line numbering of the source file. Don't write:
2500 # send_gdb "break 20"
2502 # This means that if anyone ever edits your test's source file,
2503 # your test could break. Instead, put a comment like this on the
2504 # source file line you want to break at:
2506 # /* breakpoint spot: frotz.exp: test name */
2508 # and then write, in your test script (which we assume is named
2511 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
2513 # (Yes, Tcl knows how to handle the nested quotes and brackets.
2516 # % puts "foo [lindex "bar baz" 1]"
2519 # Tcl is quite clever, for a little stringy language.)
2523 # The previous implementation of this procedure used the gdb search command.
2524 # This version is different:
2526 # . It works with MI, and it also works when gdb is not running.
2528 # . It operates on the build machine, not the host machine.
2530 # . For now, this implementation fakes a current directory of
2531 # $srcdir/$subdir to be compatible with the old implementation.
2532 # This will go away eventually and some callers will need to
2535 # . The TEXT argument is literal text and matches literally,
2536 # not a regular expression as it was before.
2538 # . State changes in gdb, such as changing the current file
2539 # and setting $_, no longer happen.
2541 # After a bit of time we can forget about the differences from the
2542 # old implementation.
2544 # --chastain 2004-08-05
2546 proc gdb_get_line_number { text { file "" } } {
2551 if { "$file" == "" } then {
2554 if { ! [regexp "^/" "$file"] } then {
2555 set file "$srcdir/$subdir/$file"
2558 if { [ catch { set fd [open "$file"] } message ] } then {
2564 for { set line 1 } { 1 } { incr line } {
2565 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
2569 if { $nchar < 0 } then {
2572 if { [string first "$text" "$body"] >= 0 } then {
2578 if { [ catch { close "$fd" } message ] } then {
2586 # gdb_continue_to_end:
2587 # The case where the target uses stubs has to be handled specially. If a
2588 # stub is used, we set a breakpoint at exit because we cannot rely on
2589 # exit() behavior of a remote target.
2591 # mssg is the error message that gets printed.
2593 proc gdb_continue_to_end {mssg} {
2594 if [target_info exists use_gdb_stub] {
2595 if {![gdb_breakpoint "exit"]} {
2598 gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
2599 "continue until exit at $mssg"
2601 # Continue until we exit. Should not stop again.
2602 # Don't bother to check the output of the program, that may be
2603 # extremely tough for some remote systems.
2604 gdb_test "continue"\
2605 "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|Program exited normally\\.).*"\
2606 "continue until exit at $mssg"
2610 proc rerun_to_main {} {
2613 if [target_info exists use_gdb_stub] {
2616 -re ".*Breakpoint .*main .*$gdb_prompt $"\
2617 {pass "rerun to main" ; return 0}
2618 -re "$gdb_prompt $"\
2619 {fail "rerun to main" ; return 0}
2620 timeout {fail "(timeout) rerun to main" ; return 0}
2625 -re "The program .* has been started already.*y or n. $" {
2629 -re "Starting program.*$gdb_prompt $"\
2630 {pass "rerun to main" ; return 0}
2631 -re "$gdb_prompt $"\
2632 {fail "rerun to main" ; return 0}
2633 timeout {fail "(timeout) rerun to main" ; return 0}
2638 # Print a message and return true if a test should be skipped
2639 # due to lack of floating point suport.
2641 proc gdb_skip_float_test { msg } {
2642 if [target_info exists gdb,skip_float_tests] {
2643 verbose "Skipping test '$msg': no float tests.";
2649 # Print a message and return true if a test should be skipped
2650 # due to lack of stdio support.
2652 proc gdb_skip_stdio_test { msg } {
2653 if [target_info exists gdb,noinferiorio] {
2654 verbose "Skipping test '$msg': no inferior i/o.";
2660 proc gdb_skip_bogus_test { msg } {
2664 # Return true if a test should be skipped due to lack of XML support
2667 proc gdb_skip_xml_test { } {
2670 global xml_missing_cached
2672 if {[info exists xml_missing_cached]} {
2673 return $xml_missing_cached
2677 set xml_missing_cached 0
2678 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
2679 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
2680 set xml_missing_cached 1
2682 -re ".*$gdb_prompt $" { }
2685 return $xml_missing_cached
2688 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
2689 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
2690 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
2691 # the name of a debuginfo only file. This file will be stored in the
2692 # gdb.base/.debug subdirectory.
2694 # Functions for separate debug info testing
2696 # starting with an executable:
2697 # foo --> original executable
2699 # at the end of the process we have:
2700 # foo.stripped --> foo w/o debug info
2701 # .debug/foo.debug --> foo's debug info
2702 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
2704 # Return the name of the file in which we should stor EXEC's separated
2705 # debug info. EXEC contains the full path.
2706 proc separate_debug_filename { exec } {
2708 # In a .debug subdirectory off the same directory where the testcase
2709 # executable is going to be. Something like:
2710 # <your-path>/gdb/testsuite/gdb.base/.debug/blah.debug.
2711 # This is the default location where gdb expects to findi
2712 # the debug info file.
2714 set exec_dir [file dirname $exec]
2715 set exec_file [file tail $exec]
2716 set debug_dir [file join $exec_dir ".debug"]
2717 set debug_file [file join $debug_dir "${exec_file}.debug"]
2722 # Return the build-id hex string (usually 160 bits as 40 hex characters)
2723 # converted to the form: .build-id/ab/cdef1234...89.debug
2724 # Return "" if no build-id found.
2725 proc build_id_debug_filename_get { exec } {
2726 set tmp "${exec}-tmp"
2727 set objcopy_program [transform objcopy]
2729 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
2730 verbose "result is $result"
2731 verbose "output is $output"
2736 fconfigure $fi -translation binary
2737 # Skip the NOTE header.
2742 if ![string compare $data ""] then {
2745 # Convert it to hex.
2746 binary scan $data H* data
2747 set data [regsub {^..} $data {\0/}]
2748 return ".build-id/${data}.debug";
2751 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
2752 # list of optional flags. The only currently supported flag is no-main,
2753 # which removes the symbol entry for main from the separate debug file.
2755 proc gdb_gnu_strip_debug { dest args } {
2757 set debug_file [separate_debug_filename $dest]
2758 set strip_to_file_program [transform strip]
2759 set objcopy_program [transform objcopy]
2761 # Make sure the directory that will hold the separated debug
2762 # info actually exists.
2763 set debug_dir [file dirname $debug_file]
2764 if {! [file isdirectory $debug_dir]} {
2765 file mkdir $debug_dir
2768 set debug_link [file tail $debug_file]
2769 set stripped_file "${dest}.stripped"
2771 # Get rid of the debug info, and store result in stripped_file
2772 # something like gdb/testsuite/gdb.base/blah.stripped.
2773 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
2774 verbose "result is $result"
2775 verbose "output is $output"
2780 # Get rid of everything but the debug info, and store result in debug_file
2781 # This will be in the .debug subdirectory, see above.
2782 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
2783 verbose "result is $result"
2784 verbose "output is $output"
2789 # If no-main is passed, strip the symbol for main from the separate
2790 # file. This is to simulate the behavior of elfutils's eu-strip, which
2791 # leaves the symtab in the original file only. There's no way to get
2792 # objcopy or strip to remove the symbol table without also removing the
2793 # debugging sections, so this is as close as we can get.
2794 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
2795 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
2796 verbose "result is $result"
2797 verbose "output is $output"
2801 file delete "${debug_file}"
2802 file rename "${debug_file}-tmp" "${debug_file}"
2805 # Link the two previous output files together, adding the .gnu_debuglink
2806 # section to the stripped_file, containing a pointer to the debug_file,
2807 # save the new file in dest.
2808 # This will be the regular executable filename, in the usual location.
2809 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
2810 verbose "result is $result"
2811 verbose "output is $output"
2819 # Test the output of GDB_COMMAND matches the pattern obtained
2820 # by concatenating all elements of EXPECTED_LINES. This makes
2821 # it possible to split otherwise very long string into pieces.
2822 # If third argument is not empty, it's used as the name of the
2823 # test to be printed on pass/fail.
2824 proc help_test_raw { gdb_command expected_lines args } {
2825 set message $gdb_command
2826 if [llength $args]>0 then {
2827 set message [lindex $args 0]
2829 set expected_output [join $expected_lines ""]
2830 gdb_test "${gdb_command}" "${expected_output}" $message
2833 # Test the output of "help COMMNAD_CLASS". EXPECTED_INITIAL_LINES
2834 # are regular expressions that should match the beginning of output,
2835 # before the list of commands in that class. The presence of
2836 # command list and standard epilogue will be tested automatically.
2837 proc test_class_help { command_class expected_initial_lines args } {
2839 "List of commands\:.*\[\r\n\]+"
2840 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
2841 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
2842 "Command name abbreviations are allowed if unambiguous\."
2844 set l_entire_body [concat $expected_initial_lines $l_stock_body]
2846 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
2849 # COMMAND_LIST should have either one element -- command to test, or
2850 # two elements -- abbreviated command to test, and full command the first
2851 # element is abbreviation of.
2852 # The command must be a prefix command. EXPECTED_INITIAL_LINES
2853 # are regular expressions that should match the beginning of output,
2854 # before the list of subcommands. The presence of
2855 # subcommand list and standard epilogue will be tested automatically.
2856 proc test_prefix_command_help { command_list expected_initial_lines args } {
2857 set command [lindex $command_list 0]
2858 if {[llength $command_list]>1} {
2859 set full_command [lindex $command_list 1]
2861 set full_command $command
2863 # Use 'list' and not just {} because we want variables to
2864 # be expanded in this list.
2865 set l_stock_body [list\
2866 "List of $full_command subcommands\:.*\[\r\n\]+"\
2867 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
2868 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
2869 "Command name abbreviations are allowed if unambiguous\."]
2870 set l_entire_body [concat $expected_initial_lines $l_stock_body]
2871 if {[llength $args]>0} {
2872 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
2874 help_test_raw "help ${command}" $l_entire_body
2878 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
2879 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
2880 # to pass to untested, if something is wrong. OPTIONS are passed
2881 # to gdb_compile directly.
2882 proc build_executable { testname executable {sources ""} {options {debug}} } {
2887 if {[llength $sources]==0} {
2888 set sources ${executable}.c
2891 set binfile ${objdir}/${subdir}/${executable}
2894 for {set i 0} "\$i<[llength $sources]" {incr i} {
2895 set s [lindex $sources $i]
2896 if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $options] != "" } {
2900 lappend objects "${binfile}${i}.o"
2903 if { [gdb_compile $objects "${binfile}" executable $options] != "" } {
2908 if [get_compiler_info ${binfile}] {
2914 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
2915 # the name of binary in ${objdir}/${subdir}.
2916 proc clean_restart { executable } {
2920 set binfile ${objdir}/${subdir}/${executable}
2924 gdb_reinitialize_dir $srcdir/$subdir
2927 if [target_info exists gdb_stub] {
2932 # Prepares for testing, by calling build_executable, and then clean_restart.
2933 # Please refer to build_executable for parameter description.
2934 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
2936 if {[build_executable $testname $executable $sources $options] == -1} {
2939 clean_restart $executable
2944 proc get_valueof { fmt exp default } {
2947 set test "get valueof \"${exp}\""
2949 gdb_test_multiple "print${fmt} ${exp}" "$test" {
2950 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
2951 set val $expect_out(1,string)
2955 fail "$test (timeout)"
2961 proc get_integer_valueof { exp default } {
2964 set test "get integer valueof \"${exp}\""
2966 gdb_test_multiple "print /d ${exp}" "$test" {
2967 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
2968 set val $expect_out(1,string)
2972 fail "$test (timeout)"
2978 proc get_hexadecimal_valueof { exp default } {
2980 send_gdb "print /x ${exp}\n"
2981 set test "get hexadecimal valueof \"${exp}\""
2983 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
2984 set val $expect_out(1,string)
2989 fail "$test (timeout)"
2995 proc get_sizeof { type default } {
2996 return [get_integer_valueof "sizeof (${type})" $default]
2999 # Log gdb command line and script if requested.
3000 if {[info exists TRANSCRIPT]} {
3001 rename send_gdb real_send_gdb
3002 rename remote_spawn real_remote_spawn
3003 rename remote_close real_remote_close
3005 global gdb_transcript
3006 set gdb_transcript ""
3008 global gdb_trans_count
3009 set gdb_trans_count 1
3011 proc remote_spawn {args} {
3012 global gdb_transcript gdb_trans_count outdir
3014 if {$gdb_transcript != ""} {
3015 close $gdb_transcript
3017 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
3018 puts $gdb_transcript [lindex $args 1]
3019 incr gdb_trans_count
3021 return [uplevel real_remote_spawn $args]
3024 proc remote_close {args} {
3025 global gdb_transcript
3027 if {$gdb_transcript != ""} {
3028 close $gdb_transcript
3029 set gdb_transcript ""
3032 return [uplevel real_remote_close $args]
3035 proc send_gdb {args} {
3036 global gdb_transcript
3038 if {$gdb_transcript != ""} {
3039 puts -nonewline $gdb_transcript [lindex $args 0]
3042 return [uplevel real_send_gdb $args]