1 # Copyright 1992-2015 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
34 # The spawn ID used for I/O interaction with the inferior. For native
35 # targets, or remote targets that can do I/O through GDB
36 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
37 # Otherwise, the board may set this to some other spawn ID. E.g.,
38 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
39 # so input/output is done on gdbserver's tty.
40 global inferior_spawn_id
42 if [info exists TOOL_EXECUTABLE] {
43 set GDB $TOOL_EXECUTABLE
45 if ![info exists GDB] {
46 if ![is_remote host] {
47 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
49 set GDB [transform gdb]
52 verbose "using GDB = $GDB" 2
54 # GDBFLAGS is available for the user to set on the command line.
55 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
56 # Testcases may use it to add additional flags, but they must:
57 # - append new flags, not overwrite
58 # - restore the original value when done
60 if ![info exists GDBFLAGS] {
63 verbose "using GDBFLAGS = $GDBFLAGS" 2
65 # Make the build data directory available to tests.
66 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
68 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
69 global INTERNAL_GDBFLAGS
70 if ![info exists INTERNAL_GDBFLAGS] {
71 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
74 # The variable gdb_prompt is a regexp which matches the gdb prompt.
75 # Set it if it is not already set. This is also set by default_gdb_init
76 # but it's not clear what removing one of them will break.
77 # See with_gdb_prompt for more details on prompt handling.
79 if ![info exists gdb_prompt] then {
80 set gdb_prompt "\\(gdb\\)"
83 # A regexp that matches the pagination prompt.
84 set pagination_prompt [string_to_regexp "---Type <return> to continue, or q <return> to quit---"]
86 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
87 # absolute path ie. /foo/
88 set fullname_syntax_POSIX {/[^\n]*/}
89 # The variable fullname_syntax_UNC is a regexp which matches a Windows
90 # UNC path ie. \\D\foo\
91 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
92 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
93 # particular DOS case that GDB most likely will output
94 # ie. \foo\, but don't match \\.*\
95 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
96 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
97 # ie. a:\foo\ && a:foo\
98 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
99 # The variable fullname_syntax is a regexp which matches what GDB considers
100 # an absolute path. It is currently debatable if the Windows style paths
101 # d:foo and \abc should be considered valid as an absolute path.
102 # Also, the purpse of this regexp is not to recognize a well formed
103 # absolute path, but to say with certainty that a path is absolute.
104 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
106 # Needed for some tests under Cygwin.
110 if ![info exists env(EXEEXT)] {
113 set EXEEXT $env(EXEEXT)
118 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
120 ### Only procedures should come after this point.
123 # gdb_version -- extract and print the version number of GDB
125 proc default_gdb_version {} {
127 global INTERNAL_GDBFLAGS GDBFLAGS
131 if {[info exists inotify_pid]} {
132 eval exec kill $inotify_pid
135 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
136 set tmp [lindex $output 1]
138 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
139 if ![is_remote host] {
140 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
142 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
146 proc gdb_version { } {
147 return [default_gdb_version]
151 # gdb_unload -- unload a file if one is loaded
152 # Return 0 on success, -1 on error.
161 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
162 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
163 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
167 -re "Discard symbol table from .*y or n.*$" {
171 -re "$gdb_prompt $" {}
173 perror "couldn't unload file in $GDB (timeout)."
180 # Many of the tests depend on setting breakpoints at various places and
181 # running until that breakpoint is reached. At times, we want to start
182 # with a clean-slate with respect to breakpoints, so this utility proc
183 # lets us do this without duplicating this code everywhere.
186 proc delete_breakpoints {} {
189 # we need a larger timeout value here or this thing just confuses
190 # itself. May need a better implementation if possible. - guo
194 set msg "delete all breakpoints in delete_breakpoints"
196 gdb_test_multiple "delete breakpoints" "$msg" {
197 -re "Delete all breakpoints.*y or n.*$" {
201 -re "$gdb_prompt $" {
207 # Confirm with "info breakpoints".
209 set msg "info breakpoints"
210 gdb_test_multiple $msg $msg {
211 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
214 -re "$gdb_prompt $" {
220 perror "breakpoints not deleted"
224 # Generic run command.
226 # The second pattern below matches up to the first newline *only*.
227 # Using ``.*$'' could swallow up output that we attempt to match
230 # N.B. This function does not wait for gdb to return to the prompt,
231 # that is the caller's responsibility.
233 proc gdb_run_cmd {args} {
234 global gdb_prompt use_gdb_stub
236 foreach command [gdb_init_commands] {
237 send_gdb "$command\n"
239 -re "$gdb_prompt $" { }
241 perror "gdb_init_command for target failed"
248 if [target_info exists gdb,do_reload_on_run] {
249 if { [gdb_reload] != 0 } {
252 send_gdb "continue\n"
254 -re "Continu\[^\r\n\]*\[\r\n\]" {}
260 if [target_info exists gdb,start_symbol] {
261 set start [target_info gdb,start_symbol]
265 send_gdb "jump *$start\n"
267 while { $start_attempt } {
268 # Cap (re)start attempts at three to ensure that this loop
269 # always eventually fails. Don't worry about trying to be
270 # clever and not send a command when it has failed.
271 if [expr $start_attempt > 3] {
272 perror "Jump to start() failed (retry count exceeded)"
275 set start_attempt [expr $start_attempt + 1]
277 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
280 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
281 perror "Can't find start symbol to run in gdb_run"
284 -re "No symbol \"start\" in current.*$gdb_prompt $" {
285 send_gdb "jump *_start\n"
287 -re "No symbol.*context.*$gdb_prompt $" {
290 -re "Line.* Jump anyway.*y or n. $" {
293 -re "The program is not being run.*$gdb_prompt $" {
294 if { [gdb_reload] != 0 } {
297 send_gdb "jump *$start\n"
300 perror "Jump to start() failed (timeout)"
308 if [target_info exists gdb,do_reload_on_run] {
309 if { [gdb_reload] != 0 } {
313 send_gdb "run $args\n"
314 # This doesn't work quite right yet.
315 # Use -notransfer here so that test cases (like chng-sym.exp)
316 # may test for additional start-up messages.
318 -re "The program .* has been started already.*y or n. $" {
322 -notransfer -re "Starting program: \[^\r\n\]*" {}
323 -notransfer -re "$gdb_prompt $" {
324 # There is no more input expected.
329 # Generic start command. Return 0 if we could start the program, -1
332 # N.B. This function does not wait for gdb to return to the prompt,
333 # that is the caller's responsibility.
335 proc gdb_start_cmd {args} {
336 global gdb_prompt use_gdb_stub
338 foreach command [gdb_init_commands] {
339 send_gdb "$command\n"
341 -re "$gdb_prompt $" { }
343 perror "gdb_init_command for target failed"
353 send_gdb "start $args\n"
354 # Use -notransfer here so that test cases (like chng-sym.exp)
355 # may test for additional start-up messages.
357 -re "The program .* has been started already.*y or n. $" {
361 -notransfer -re "Starting program: \[^\r\n\]*" {
368 # Set a breakpoint at FUNCTION. If there is an additional argument it is
369 # a list of options; the supported options are allow-pending, temporary,
370 # message, no-message, and passfail.
371 # The result is 1 for success, 0 for failure.
373 # Note: The handling of message vs no-message is messed up, but it's based
374 # on historical usage. By default this function does not print passes,
376 # no-message: turns off printing of fails (and passes, but they're already off)
377 # message: turns on printing of passes (and fails, but they're already on)
379 proc gdb_breakpoint { function args } {
383 set pending_response n
384 if {[lsearch -exact $args allow-pending] != -1} {
385 set pending_response y
388 set break_command "break"
389 set break_message "Breakpoint"
390 if {[lsearch -exact $args temporary] != -1} {
391 set break_command "tbreak"
392 set break_message "Temporary breakpoint"
397 set no_message_loc [lsearch -exact $args no-message]
398 set message_loc [lsearch -exact $args message]
399 # The last one to appear in args wins.
400 if { $no_message_loc > $message_loc } {
402 } elseif { $message_loc > $no_message_loc } {
406 set test_name "setting breakpoint at $function"
408 send_gdb "$break_command $function\n"
409 # The first two regexps are what we get with -g, the third is without -g.
411 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
412 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
413 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
414 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
415 if {$pending_response == "n"} {
422 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
423 send_gdb "$pending_response\n"
426 -re "A problem internal to GDB has been detected" {
428 fail "$test_name (GDB internal error)"
430 gdb_internal_error_resync
433 -re "$gdb_prompt $" {
441 fail "$test_name (eof)"
447 fail "$test_name (timeout)"
458 # Set breakpoint at function and run gdb until it breaks there.
459 # Since this is the only breakpoint that will be set, if it stops
460 # at a breakpoint, we will assume it is the one we want. We can't
461 # just compare to "function" because it might be a fully qualified,
462 # single quoted C++ function specifier.
464 # If there are additional arguments, pass them to gdb_breakpoint.
465 # We recognize no-message/message ourselves.
466 # The default is no-message.
467 # no-message is messed up here, like gdb_breakpoint: to preserve
468 # historical usage fails are always printed by default.
469 # no-message: turns off printing of fails (and passes, but they're already off)
470 # message: turns on printing of passes (and fails, but they're already on)
472 proc runto { function args } {
478 # Default to "no-message".
479 set args "no-message $args"
483 set no_message_loc [lsearch -exact $args no-message]
484 set message_loc [lsearch -exact $args message]
485 # The last one to appear in args wins.
486 if { $no_message_loc > $message_loc } {
488 } elseif { $message_loc > $no_message_loc } {
492 set test_name "running to $function in runto"
494 # We need to use eval here to pass our varargs args to gdb_breakpoint
495 # which is also a varargs function.
496 # But we also have to be careful because $function may have multiple
497 # elements, and we don't want Tcl to move the remaining elements after
498 # the first to $args. That is why $function is wrapped in {}.
499 if ![eval gdb_breakpoint {$function} $args] {
505 # the "at foo.c:36" output we get with -g.
506 # the "in func" output we get without -g.
508 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
514 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
520 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
522 unsupported "Non-stop mode not supported"
526 -re ".*A problem internal to GDB has been detected" {
528 fail "$test_name (GDB internal error)"
530 gdb_internal_error_resync
533 -re "$gdb_prompt $" {
541 fail "$test_name (eof)"
547 fail "$test_name (timeout)"
558 # Ask gdb to run until we hit a breakpoint at main.
560 # N.B. This function deletes all existing breakpoints.
561 # If you don't want that, use gdb_start_cmd.
563 proc runto_main { } {
564 return [runto main no-message]
567 ### Continue, and expect to hit a breakpoint.
568 ### Report a pass or fail, depending on whether it seems to have
569 ### worked. Use NAME as part of the test name; each call to
570 ### continue_to_breakpoint should use a NAME which is unique within
572 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
574 set full_name "continue to breakpoint: $name"
576 gdb_test_multiple "continue" $full_name {
577 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
584 # gdb_internal_error_resync:
586 # Answer the questions GDB asks after it reports an internal error
587 # until we get back to a GDB prompt. Decline to quit the debugging
588 # session, and decline to create a core file. Return non-zero if the
591 # This procedure just answers whatever questions come up until it sees
592 # a GDB prompt; it doesn't require you to have matched the input up to
593 # any specific point. However, it only answers questions it sees in
594 # the output itself, so if you've matched a question, you had better
595 # answer it yourself before calling this.
597 # You can use this function thus:
601 # -re ".*A problem internal to GDB has been detected" {
602 # gdb_internal_error_resync
607 proc gdb_internal_error_resync {} {
610 verbose -log "Resyncing due to internal error."
613 while {$count < 10} {
615 -re "Quit this debugging session\\? \\(y or n\\) $" {
619 -re "Create a core file of GDB\\? \\(y or n\\) $" {
623 -re "$gdb_prompt $" {
624 # We're resynchronized.
628 perror "Could not resync from internal error (timeout)"
633 perror "Could not resync from internal error (resync count exceeded)"
638 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
639 # Send a command to gdb; test the result.
641 # COMMAND is the command to execute, send to GDB with send_gdb. If
642 # this is the null string no command is sent.
643 # MESSAGE is a message to be printed with the built-in failure patterns
644 # if one of them matches. If MESSAGE is empty COMMAND will be used.
645 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
646 # patterns. Pattern elements will be evaluated in the caller's
647 # context; action elements will be executed in the caller's context.
648 # Unlike patterns for gdb_test, these patterns should generally include
649 # the final newline and prompt.
652 # 1 if the test failed, according to a built-in failure pattern
653 # 0 if only user-supplied patterns matched
654 # -1 if there was an internal error.
656 # You can use this function thus:
658 # gdb_test_multiple "print foo" "test foo" {
659 # -re "expected output 1" {
662 # -re "expected output 2" {
667 # Like with "expect", you can also specify the spawn id to match with
668 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
669 # $gdb_spawn_id. The former matches inferior I/O, while the latter
670 # matches GDB I/O. E.g.:
672 # send_inferior "hello\n"
673 # gdb_test_multiple "continue" "test echo" {
674 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
677 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
678 # fail "hit breakpoint"
682 # The standard patterns, such as "Inferior exited..." and "A problem
683 # ...", all being implicitly appended to that list. These are always
684 # expected from $gdb_spawn_id. IOW, callers do not need to worry
685 # about resetting "-i" back to $gdb_spawn_id explicitly.
687 proc gdb_test_multiple { command message user_code } {
688 global verbose use_gdb_stub
689 global gdb_prompt pagination_prompt
692 global inferior_exited_re
693 upvar timeout timeout
694 upvar expect_out expect_out
697 if { $message == "" } {
701 if [string match "*\[\r\n\]" $command] {
702 error "Invalid trailing newline in \"$message\" test"
705 if [string match "*\[\r\n\]*" $message] {
706 error "Invalid newline in \"$message\" test"
710 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
712 error "gdbserver does not support $command without extended-remote"
715 # TCL/EXPECT WART ALERT
716 # Expect does something very strange when it receives a single braced
717 # argument. It splits it along word separators and performs substitutions.
718 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
719 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
720 # double-quoted list item, "\[ab\]" is just a long way of representing
721 # "[ab]", because the backslashes will be removed by lindex.
723 # Unfortunately, there appears to be no easy way to duplicate the splitting
724 # that expect will do from within TCL. And many places make use of the
725 # "\[0-9\]" construct, so we need to support that; and some places make use
726 # of the "[func]" construct, so we need to support that too. In order to
727 # get this right we have to substitute quoted list elements differently
728 # from braced list elements.
730 # We do this roughly the same way that Expect does it. We have to use two
731 # lists, because if we leave unquoted newlines in the argument to uplevel
732 # they'll be treated as command separators, and if we escape newlines
733 # we mangle newlines inside of command blocks. This assumes that the
734 # input doesn't contain a pattern which contains actual embedded newlines
737 regsub -all {\n} ${user_code} { } subst_code
738 set subst_code [uplevel list $subst_code]
740 set processed_code ""
742 set expecting_action 0
744 foreach item $user_code subst_item $subst_code {
745 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
746 lappend processed_code $item
749 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
750 lappend processed_code $item
753 if { $item == "-timeout" || $item == "-i" } {
755 lappend processed_code $item
758 if { $expecting_arg } {
760 lappend processed_code $subst_item
763 if { $expecting_action } {
764 lappend processed_code "uplevel [list $item]"
765 set expecting_action 0
766 # Cosmetic, no effect on the list.
767 append processed_code "\n"
770 set expecting_action 1
771 lappend processed_code $subst_item
772 if {$patterns != ""} {
775 append patterns "\"$subst_item\""
778 # Also purely cosmetic.
779 regsub -all {\r} $patterns {\\r} patterns
780 regsub -all {\n} $patterns {\\n} patterns
783 send_user "Sending \"$command\" to gdb\n"
784 send_user "Looking to match \"$patterns\"\n"
785 send_user "Message is \"$message\"\n"
789 set string "${command}\n"
790 if { $command != "" } {
791 set multi_line_re "\[\r\n\] *>"
792 while { "$string" != "" } {
793 set foo [string first "\n" "$string"]
794 set len [string length "$string"]
795 if { $foo < [expr $len - 1] } {
796 set str [string range "$string" 0 $foo]
797 if { [send_gdb "$str"] != "" } {
800 if { ! $suppress_flag } {
801 perror "Couldn't send $command to GDB."
806 # since we're checking if each line of the multi-line
807 # command are 'accepted' by GDB here,
808 # we need to set -notransfer expect option so that
809 # command output is not lost for pattern matching
812 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
813 timeout { verbose "partial: timeout" 3 }
815 set string [string range "$string" [expr $foo + 1] end]
816 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
821 if { "$string" != "" } {
822 if { [send_gdb "$string"] != "" } {
825 if { ! $suppress_flag } {
826 perror "Couldn't send $command to GDB."
835 -re ".*A problem internal to GDB has been detected" {
836 fail "$message (GDB internal error)"
837 gdb_internal_error_resync
840 -re "\\*\\*\\* DOSEXIT code.*" {
841 if { $message != "" } {
844 gdb_suppress_entire_file "GDB died"
848 append code $processed_code
850 # Reset the spawn id, in case the processed code used -i.
853 -re "Ending remote debugging.*$gdb_prompt $" {
854 if ![isnative] then {
855 warning "Can`t communicate to remote target."
861 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
862 perror "Undefined command \"$command\"."
866 -re "Ambiguous command.*$gdb_prompt $" {
867 perror "\"$command\" is not a unique command name."
871 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
872 if ![string match "" $message] then {
873 set errmsg "$message (the program exited)"
875 set errmsg "$command (the program exited)"
880 -re "$inferior_exited_re normally.*$gdb_prompt $" {
881 if ![string match "" $message] then {
882 set errmsg "$message (the program exited)"
884 set errmsg "$command (the program exited)"
889 -re "The program is not being run.*$gdb_prompt $" {
890 if ![string match "" $message] then {
891 set errmsg "$message (the program is no longer running)"
893 set errmsg "$command (the program is no longer running)"
898 -re "\r\n$gdb_prompt $" {
899 if ![string match "" $message] then {
904 -re "$pagination_prompt" {
906 perror "Window too small."
910 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
912 gdb_expect -re "$gdb_prompt $"
913 fail "$message (got interactive prompt)"
916 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
918 gdb_expect -re "$gdb_prompt $"
919 fail "$message (got breakpoint menu)"
923 # Patterns below apply to any spawn id specified.
926 perror "Process no longer exists"
927 if { $message != "" } {
933 perror "internal buffer is full."
938 if ![string match "" $message] then {
939 fail "$message (timeout)"
946 set code [catch {gdb_expect $code} string]
948 global errorInfo errorCode
949 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
950 } elseif {$code > 1} {
951 return -code $code $string
956 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
957 # Send a command to gdb; test the result.
959 # COMMAND is the command to execute, send to GDB with send_gdb. If
960 # this is the null string no command is sent.
961 # PATTERN is the pattern to match for a PASS, and must NOT include
962 # the \r\n sequence immediately before the gdb prompt.
963 # MESSAGE is an optional message to be printed. If this is
964 # omitted, then the pass/fail messages use the command string as the
965 # message. (If this is the empty string, then sometimes we don't
966 # call pass or fail at all; I don't understand this at all.)
967 # QUESTION is a question GDB may ask in response to COMMAND, like
969 # RESPONSE is the response to send if QUESTION appears.
972 # 1 if the test failed,
973 # 0 if the test passes,
974 # -1 if there was an internal error.
976 proc gdb_test { args } {
980 upvar timeout timeout
982 if [llength $args]>2 then {
983 set message [lindex $args 2]
985 set message [lindex $args 0]
987 set command [lindex $args 0]
988 set pattern [lindex $args 1]
990 if [llength $args]==5 {
991 set question_string [lindex $args 3]
992 set response_string [lindex $args 4]
994 set question_string "^FOOBAR$"
997 return [gdb_test_multiple $command $message {
998 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
999 if ![string match "" $message] then {
1003 -re "(${question_string})$" {
1004 send_gdb "$response_string\n"
1010 # gdb_test_no_output COMMAND MESSAGE
1011 # Send a command to GDB and verify that this command generated no output.
1013 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1014 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1015 # the message. (If MESSAGE is the empty string, then sometimes we do not
1016 # call pass or fail at all; I don't understand this at all.)
1018 proc gdb_test_no_output { args } {
1020 set command [lindex $args 0]
1021 if [llength $args]>1 then {
1022 set message [lindex $args 1]
1024 set message $command
1027 set command_regex [string_to_regexp $command]
1028 gdb_test_multiple $command $message {
1029 -re "^$command_regex\r\n$gdb_prompt $" {
1030 if ![string match "" $message] then {
1037 # Send a command and then wait for a sequence of outputs.
1038 # This is useful when the sequence is long and contains ".*", a single
1039 # regexp to match the entire output can get a timeout much easier.
1041 # COMMAND is the command to send.
1042 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1043 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1044 # processed in order, and all must be present in the output.
1046 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1047 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1048 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1050 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1051 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1054 # 1 if the test failed,
1055 # 0 if the test passes,
1056 # -1 if there was an internal error.
1058 proc gdb_test_sequence { command test_name expected_output_list } {
1060 if { $test_name == "" } {
1061 set test_name $command
1063 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1064 send_gdb "$command\n"
1065 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1069 # Test that a command gives an error. For pass or fail, return
1070 # a 1 to indicate that more tests can proceed. However a timeout
1071 # is a serious error, generates a special fail message, and causes
1072 # a 0 to be returned to indicate that more tests are likely to fail
1075 proc test_print_reject { args } {
1079 if [llength $args]==2 then {
1080 set expectthis [lindex $args 1]
1082 set expectthis "should never match this bogus string"
1084 set sendthis [lindex $args 0]
1085 if $verbose>2 then {
1086 send_user "Sending \"$sendthis\" to gdb\n"
1087 send_user "Looking to match \"$expectthis\"\n"
1089 send_gdb "$sendthis\n"
1090 #FIXME: Should add timeout as parameter.
1092 -re "A .* in expression.*\\.*$gdb_prompt $" {
1093 pass "reject $sendthis"
1096 -re "Invalid syntax in expression.*$gdb_prompt $" {
1097 pass "reject $sendthis"
1100 -re "Junk after end of expression.*$gdb_prompt $" {
1101 pass "reject $sendthis"
1104 -re "Invalid number.*$gdb_prompt $" {
1105 pass "reject $sendthis"
1108 -re "Invalid character constant.*$gdb_prompt $" {
1109 pass "reject $sendthis"
1112 -re "No symbol table is loaded.*$gdb_prompt $" {
1113 pass "reject $sendthis"
1116 -re "No symbol .* in current context.*$gdb_prompt $" {
1117 pass "reject $sendthis"
1120 -re "Unmatched single quote.*$gdb_prompt $" {
1121 pass "reject $sendthis"
1124 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1125 pass "reject $sendthis"
1128 -re "$expectthis.*$gdb_prompt $" {
1129 pass "reject $sendthis"
1132 -re ".*$gdb_prompt $" {
1133 fail "reject $sendthis"
1137 fail "reject $sendthis (eof or timeout)"
1144 # Same as gdb_test, but the second parameter is not a regexp,
1145 # but a string that must match exactly.
1147 proc gdb_test_exact { args } {
1148 upvar timeout timeout
1150 set command [lindex $args 0]
1152 # This applies a special meaning to a null string pattern. Without
1153 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1154 # messages from commands that should have no output except a new
1155 # prompt. With this, only results of a null string will match a null
1158 set pattern [lindex $args 1]
1159 if [string match $pattern ""] {
1160 set pattern [string_to_regexp [lindex $args 0]]
1162 set pattern [string_to_regexp [lindex $args 1]]
1165 # It is most natural to write the pattern argument with only
1166 # embedded \n's, especially if you are trying to avoid Tcl quoting
1167 # problems. But gdb_expect really wants to see \r\n in patterns. So
1168 # transform the pattern here. First transform \r\n back to \n, in
1169 # case some users of gdb_test_exact already do the right thing.
1170 regsub -all "\r\n" $pattern "\n" pattern
1171 regsub -all "\n" $pattern "\r\n" pattern
1172 if [llength $args]==3 then {
1173 set message [lindex $args 2]
1175 set message $command
1178 return [gdb_test $command $pattern $message]
1181 # Wrapper around gdb_test_multiple that looks for a list of expected
1182 # output elements, but which can appear in any order.
1183 # CMD is the gdb command.
1184 # NAME is the name of the test.
1185 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1187 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1188 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1189 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1191 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1192 # of text per element and then strip trailing \r\n's.
1194 # gdb_test_list_exact "foo" "bar" \
1195 # "\[^\r\n\]+\[\r\n\]+" \
1198 # {expected result 1} \
1199 # {expected result 2} \
1202 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1205 set matches [lsort $result_match_list]
1207 gdb_test_multiple $cmd $name {
1208 "$cmd\[\r\n\]" { exp_continue }
1209 -re $elm_find_regexp {
1210 set str $expect_out(0,string)
1211 verbose -log "seen: $str" 3
1212 regexp -- $elm_extract_regexp $str elm_seen
1213 verbose -log "extracted: $elm_seen" 3
1214 lappend seen $elm_seen
1217 -re "$gdb_prompt $" {
1219 foreach got [lsort $seen] have $matches {
1220 if {![string equal $got $have]} {
1225 if {[string length $failed] != 0} {
1226 fail "$name ($failed not found)"
1235 # Issue a PASS and return true if evaluating CONDITION in the caller's
1236 # frame returns true, and issue a FAIL and return false otherwise.
1237 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1238 # omitted or is empty, then the pass/fail messages use the condition
1239 # string as the message.
1241 proc gdb_assert { condition {message ""} } {
1242 if { $message == ""} {
1243 set message $condition
1246 set res [uplevel 1 expr $condition]
1255 proc gdb_reinitialize_dir { subdir } {
1258 if [is_remote host] {
1263 -re "Reinitialize source path to empty.*y or n. " {
1266 -re "Source directories searched.*$gdb_prompt $" {
1267 send_gdb "dir $subdir\n"
1269 -re "Source directories searched.*$gdb_prompt $" {
1270 verbose "Dir set to $subdir"
1272 -re "$gdb_prompt $" {
1273 perror "Dir \"$subdir\" failed."
1277 -re "$gdb_prompt $" {
1278 perror "Dir \"$subdir\" failed."
1282 -re "$gdb_prompt $" {
1283 perror "Dir \"$subdir\" failed."
1289 # gdb_exit -- exit the GDB, killing the target program if necessary
1291 proc default_gdb_exit {} {
1293 global INTERNAL_GDBFLAGS GDBFLAGS
1296 global inotify_log_file
1298 gdb_stop_suppressing_tests
1300 if ![info exists gdb_spawn_id] {
1304 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1306 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1307 set fd [open $inotify_log_file]
1308 set data [read -nonewline $fd]
1311 if {[string compare $data ""] != 0} {
1312 warning "parallel-unsafe file creations noticed"
1315 set fd [open $inotify_log_file w]
1320 if { [is_remote host] && [board_info host exists fileid] } {
1327 -re "DOSEXIT code" { }
1332 if ![is_remote host] {
1338 # Load a file into the debugger.
1339 # The return value is 0 for success, -1 for failure.
1341 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1342 # to one of these values:
1344 # debug file was loaded successfully and has debug information
1345 # nodebug file was loaded successfully and has no debug information
1346 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1348 # fail file was not loaded
1350 # I tried returning this information as part of the return value,
1351 # but ran into a mess because of the many re-implementations of
1352 # gdb_load in config/*.exp.
1354 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1355 # this if they can get more information set.
1357 proc gdb_file_cmd { arg } {
1361 global last_loaded_file
1363 # Save this for the benefit of gdbserver-support.exp.
1364 set last_loaded_file $arg
1366 # Set whether debug info was found.
1367 # Default to "fail".
1368 global gdb_file_cmd_debug_info
1369 set gdb_file_cmd_debug_info "fail"
1371 if [is_remote host] {
1372 set arg [remote_download host $arg]
1374 perror "download failed"
1379 # The file command used to kill the remote target. For the benefit
1380 # of the testsuite, preserve this behavior.
1383 -re "Kill the program being debugged. .y or n. $" {
1385 verbose "\t\tKilling previous program being debugged"
1388 -re "$gdb_prompt $" {
1393 send_gdb "file $arg\n"
1395 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1396 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1397 set gdb_file_cmd_debug_info "lzma"
1400 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1401 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1402 set gdb_file_cmd_debug_info "nodebug"
1405 -re "Reading symbols from.*done.*$gdb_prompt $" {
1406 verbose "\t\tLoaded $arg into $GDB"
1407 set gdb_file_cmd_debug_info "debug"
1410 -re "Load new symbol table from \".*\".*y or n. $" {
1413 -re "Reading symbols from.*done.*$gdb_prompt $" {
1414 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1415 set gdb_file_cmd_debug_info "debug"
1419 perror "Couldn't load $arg, other program already loaded (timeout)."
1423 perror "Couldn't load $arg, other program already loaded (eof)."
1428 -re "No such file or directory.*$gdb_prompt $" {
1429 perror "($arg) No such file or directory"
1432 -re "A problem internal to GDB has been detected" {
1433 fail "($arg) (GDB internal error)"
1434 gdb_internal_error_resync
1437 -re "$gdb_prompt $" {
1438 perror "Couldn't load $arg into $GDB."
1442 perror "Couldn't load $arg into $GDB (timeout)."
1446 # This is an attempt to detect a core dump, but seems not to
1447 # work. Perhaps we need to match .* followed by eof, in which
1448 # gdb_expect does not seem to have a way to do that.
1449 perror "Couldn't load $arg into $GDB (eof)."
1455 # Default gdb_spawn procedure.
1457 proc default_gdb_spawn { } {
1460 global INTERNAL_GDBFLAGS GDBFLAGS
1463 gdb_stop_suppressing_tests
1465 # Set the default value, it may be overriden later by specific testfile.
1467 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1468 # is already started after connecting and run/attach are not supported.
1469 # This is used for the "remote" protocol. After GDB starts you should
1470 # check global $use_gdb_stub instead of the board as the testfile may force
1471 # a specific different target protocol itself.
1472 set use_gdb_stub [target_info exists use_gdb_stub]
1474 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1476 if [info exists gdb_spawn_id] {
1480 if ![is_remote host] {
1481 if { [which $GDB] == 0 } then {
1482 perror "$GDB does not exist."
1486 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1487 if { $res < 0 || $res == "" } {
1488 perror "Spawning $GDB failed."
1492 set gdb_spawn_id $res
1496 # Default gdb_start procedure.
1498 proc default_gdb_start { } {
1499 global gdb_prompt pagination_prompt
1501 global inferior_spawn_id
1503 if [info exists gdb_spawn_id] {
1512 # Default to assuming inferior I/O is done on GDB's terminal.
1513 if {![info exists inferior_spawn_id]} {
1514 set inferior_spawn_id $gdb_spawn_id
1517 # When running over NFS, particularly if running many simultaneous
1518 # tests on different hosts all using the same server, things can
1519 # get really slow. Give gdb at least 3 minutes to start up.
1521 while { $loop_again } {
1524 -re "$pagination_prompt" {
1525 verbose "Hit pagination during startup. Pressing enter to continue."
1529 -re "\[\r\n\]$gdb_prompt $" {
1530 verbose "GDB initialized."
1532 -re "$gdb_prompt $" {
1533 perror "GDB never initialized."
1538 perror "(timeout) GDB never initialized after 10 seconds."
1546 # force the height to "unlimited", so no pagers get used
1548 send_gdb "set height 0\n"
1550 -re "$gdb_prompt $" {
1551 verbose "Setting height to 0." 2
1554 warning "Couldn't set the height to 0"
1557 # force the width to "unlimited", so no wraparound occurs
1558 send_gdb "set width 0\n"
1560 -re "$gdb_prompt $" {
1561 verbose "Setting width to 0." 2
1564 warning "Couldn't set the width to 0."
1570 # Utility procedure to give user control of the gdb prompt in a script. It is
1571 # meant to be used for debugging test cases, and should not be left in the
1574 proc gdb_interact { } {
1576 set spawn_id $gdb_spawn_id
1578 send_user "+------------------------------------------+\n"
1579 send_user "| Script interrupted, you can now interact |\n"
1580 send_user "| with by gdb. Type >>> to continue. |\n"
1581 send_user "+------------------------------------------+\n"
1588 # Examine the output of compilation to determine whether compilation
1589 # failed or not. If it failed determine whether it is due to missing
1590 # compiler or due to compiler error. Report pass, fail or unsupported
1593 proc gdb_compile_test {src output} {
1594 if { $output == "" } {
1595 pass "compilation [file tail $src]"
1596 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1597 unsupported "compilation [file tail $src]"
1598 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1599 unsupported "compilation [file tail $src]"
1600 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1601 unsupported "compilation [file tail $src]"
1603 verbose -log "compilation failed: $output" 2
1604 fail "compilation [file tail $src]"
1608 # Return a 1 for configurations for which we don't even want to try to
1611 proc skip_cplus_tests {} {
1612 if { [istarget "h8300-*-*"] } {
1616 # The C++ IO streams are too large for HC11/HC12 and are thus not
1617 # available. The gdb C++ tests use them and don't compile.
1618 if { [istarget "m6811-*-*"] } {
1621 if { [istarget "m6812-*-*"] } {
1627 # Return a 1 for configurations for which don't have both C++ and the STL.
1629 proc skip_stl_tests {} {
1630 # Symbian supports the C++ language, but the STL is missing
1631 # (both headers and libraries).
1632 if { [istarget "arm*-*-symbianelf*"] } {
1636 return [skip_cplus_tests]
1639 # Return a 1 if I don't even want to try to test FORTRAN.
1641 proc skip_fortran_tests {} {
1645 # Return a 1 if I don't even want to try to test ada.
1647 proc skip_ada_tests {} {
1651 # Return a 1 if I don't even want to try to test GO.
1653 proc skip_go_tests {} {
1657 # Return a 1 if I don't even want to try to test java.
1659 proc skip_java_tests {} {
1663 # Return a 1 if I don't even want to try to test D.
1665 proc skip_d_tests {} {
1669 # Return a 1 for configurations that do not support Python scripting.
1671 proc skip_python_tests {} {
1673 global gdb_py_is_py3k
1674 global gdb_py_is_py24
1676 gdb_test_multiple "python print ('test')" "verify python support" {
1677 -re "not supported.*$gdb_prompt $" {
1678 unsupported "Python support is disabled."
1681 -re "$gdb_prompt $" {}
1684 set gdb_py_is_py24 0
1685 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1686 -re "3.*$gdb_prompt $" {
1687 set gdb_py_is_py3k 1
1689 -re ".*$gdb_prompt $" {
1690 set gdb_py_is_py3k 0
1693 if { $gdb_py_is_py3k == 0 } {
1694 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1695 -re "\[45\].*$gdb_prompt $" {
1696 set gdb_py_is_py24 1
1698 -re ".*$gdb_prompt $" {
1699 set gdb_py_is_py24 0
1707 # Return a 1 if we should skip shared library tests.
1709 proc skip_shlib_tests {} {
1710 # Run the shared library tests on native systems.
1715 # An abbreviated list of remote targets where we should be able to
1716 # run shared library tests.
1717 if {([istarget *-*-linux*]
1718 || [istarget *-*-*bsd*]
1719 || [istarget *-*-solaris2*]
1720 || [istarget arm*-*-symbianelf*]
1721 || [istarget *-*-mingw*]
1722 || [istarget *-*-cygwin*]
1723 || [istarget *-*-pe*])} {
1730 # Return 1 if we should skip tui related tests.
1732 proc skip_tui_tests {} {
1735 gdb_test_multiple "help layout" "verify tui support" {
1736 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1739 -re "$gdb_prompt $" {
1746 # Test files shall make sure all the test result lines in gdb.sum are
1747 # unique in a test run, so that comparing the gdb.sum files of two
1748 # test runs gives correct results. Test files that exercise
1749 # variations of the same tests more than once, shall prefix the
1750 # different test invocations with different identifying strings in
1751 # order to make them unique.
1753 # About test prefixes:
1755 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1756 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1757 # underlined substring in
1759 # PASS: gdb.base/mytest.exp: some test
1760 # ^^^^^^^^^^^^^^^^^^^^
1764 # The easiest way to adjust the test prefix is to append a test
1765 # variation prefix to the $pf_prefix, using the with_test_prefix
1768 # proc do_tests {} {
1769 # gdb_test ... ... "test foo"
1770 # gdb_test ... ... "test bar"
1772 # with_test_prefix "subvariation a" {
1773 # gdb_test ... ... "test x"
1776 # with_test_prefix "subvariation b" {
1777 # gdb_test ... ... "test x"
1781 # with_test_prefix "variation1" {
1782 # ...do setup for variation 1...
1786 # with_test_prefix "variation2" {
1787 # ...do setup for variation 2...
1793 # PASS: gdb.base/mytest.exp: variation1: test foo
1794 # PASS: gdb.base/mytest.exp: variation1: test bar
1795 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1796 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1797 # PASS: gdb.base/mytest.exp: variation2: test foo
1798 # PASS: gdb.base/mytest.exp: variation2: test bar
1799 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1800 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1802 # If for some reason more flexibility is necessary, one can also
1803 # manipulate the pf_prefix global directly, treating it as a string.
1807 # set saved_pf_prefix
1808 # append pf_prefix "${foo}: bar"
1809 # ... actual tests ...
1810 # set pf_prefix $saved_pf_prefix
1813 # Run BODY in the context of the caller, with the current test prefix
1814 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1815 # Returns the result of BODY.
1817 proc with_test_prefix { prefix body } {
1820 set saved $pf_prefix
1821 append pf_prefix " " $prefix ":"
1822 set code [catch {uplevel 1 $body} result]
1823 set pf_prefix $saved
1826 global errorInfo errorCode
1827 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1829 return -code $code $result
1833 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1834 # PROMPT. When BODY is finished, restore GDB prompt and variable
1836 # Returns the result of BODY.
1840 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
1841 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
1842 # TCL). PROMPT is internally converted to a suitable regexp for matching.
1843 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
1844 # a) It's more intuitive for callers to pass the plain text form.
1845 # b) We need two forms of the prompt:
1846 # - a regexp to use in output matching,
1847 # - a value to pass to the "set prompt" command.
1848 # c) It's easier to convert the plain text form to its regexp form.
1850 # 2) Don't add a trailing space, we do that here.
1852 proc with_gdb_prompt { prompt body } {
1855 # Convert "(foo)" to "\(foo\)".
1856 # We don't use string_to_regexp because while it works today it's not
1857 # clear it will work tomorrow: the value we need must work as both a
1858 # regexp *and* as the argument to the "set prompt" command, at least until
1859 # we start recording both forms separately instead of just $gdb_prompt.
1860 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
1862 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
1864 set saved $gdb_prompt
1866 verbose -log "Setting gdb prompt to \"$prompt \"."
1867 set gdb_prompt $prompt
1868 gdb_test_no_output "set prompt $prompt " ""
1870 set code [catch {uplevel 1 $body} result]
1872 verbose -log "Restoring gdb prompt to \"$saved \"."
1873 set gdb_prompt $saved
1874 gdb_test_no_output "set prompt $saved " ""
1877 global errorInfo errorCode
1878 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1880 return -code $code $result
1884 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
1885 # BODY is finished, restore target-charset.
1887 proc with_target_charset { target_charset body } {
1891 gdb_test_multiple "show target-charset" "" {
1892 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
1893 set saved $expect_out(1,string)
1895 -re "The target character set is \"(.*)\".*$gdb_prompt " {
1896 set saved $expect_out(1,string)
1898 -re ".*$gdb_prompt " {
1899 fail "get target-charset"
1903 gdb_test_no_output "set target-charset $target_charset" ""
1905 set code [catch {uplevel 1 $body} result]
1907 gdb_test_no_output "set target-charset $saved" ""
1910 global errorInfo errorCode
1911 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1913 return -code $code $result
1917 # Select the largest timeout from all the timeouts:
1918 # - the local "timeout" variable of the scope two levels above,
1919 # - the global "timeout" variable,
1920 # - the board variable "gdb,timeout".
1922 proc get_largest_timeout {} {
1923 upvar #0 timeout gtimeout
1924 upvar 2 timeout timeout
1927 if [info exists timeout] {
1930 if { [info exists gtimeout] && $gtimeout > $tmt } {
1933 if { [target_info exists gdb,timeout]
1934 && [target_info gdb,timeout] > $tmt } {
1935 set tmt [target_info gdb,timeout]
1945 # Run tests in BODY with timeout increased by factor of FACTOR. When
1946 # BODY is finished, restore timeout.
1948 proc with_timeout_factor { factor body } {
1951 set savedtimeout $timeout
1953 set timeout [expr [get_largest_timeout] * $factor]
1954 set code [catch {uplevel 1 $body} result]
1956 set timeout $savedtimeout
1958 global errorInfo errorCode
1959 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1961 return -code $code $result
1965 # Return 1 if _Complex types are supported, otherwise, return 0.
1967 gdb_caching_proc support_complex_tests {
1968 # Set up, compile, and execute a test program containing _Complex types.
1969 # Include the current process ID in the file names to prevent conflicts
1970 # with invocations for multiple testsuites.
1971 set src [standard_temp_file complex[pid].c]
1972 set exe [standard_temp_file complex[pid].x]
1974 gdb_produce_source $src {
1978 _Complex long double cld;
1983 verbose "compiling testfile $src" 2
1984 set compile_flags {debug nowarnings quiet}
1985 set lines [gdb_compile $src $exe executable $compile_flags]
1989 if ![string match "" $lines] then {
1990 verbose "testfile compilation failed, returning 0" 2
1999 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2002 proc supports_get_siginfo_type {} {
2003 if { [istarget "i?86-*-linux*"]
2004 || [istarget "x86_64-*-linux*"]
2005 || [istarget "arm*-*-linux*"] } {
2012 # Return 1 if target hardware or OS supports single stepping to signal
2013 # handler, otherwise, return 0.
2015 proc can_single_step_to_signal_handler {} {
2017 # Targets don't have hardware single step. On these targets, when
2018 # a signal is delivered during software single step, gdb is unable
2019 # to determine the next instruction addresses, because start of signal
2020 # handler is one of them.
2021 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2022 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2023 || [istarget "nios2-*-*"] } {
2030 # Return 1 if target supports process record, otherwise return 0.
2032 proc supports_process_record {} {
2034 if [target_info exists gdb,use_precord] {
2035 return [target_info gdb,use_precord]
2038 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2039 || [istarget "i\[34567\]86-*-linux*"]
2040 || [istarget "aarch64*-*-linux*"]
2041 || [istarget "powerpc*-*-linux*"] } {
2048 # Return 1 if target supports reverse debugging, otherwise return 0.
2050 proc supports_reverse {} {
2052 if [target_info exists gdb,can_reverse] {
2053 return [target_info gdb,can_reverse]
2056 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2057 || [istarget "i\[34567\]86-*-linux*"]
2058 || [istarget "aarch64*-*-linux*"]
2059 || [istarget "powerpc*-*-linux*"] } {
2066 # Return 1 if readline library is used.
2068 proc readline_is_used { } {
2071 gdb_test_multiple "show editing" "" {
2072 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2075 -re ".*$gdb_prompt $" {
2081 # Return 1 if target is ELF.
2082 gdb_caching_proc is_elf_target {
2083 set me "is_elf_target"
2085 set src [standard_temp_file is_elf_target[pid].c]
2086 set obj [standard_temp_file is_elf_target[pid].o]
2088 gdb_produce_source $src {
2089 int foo () {return 0;}
2092 verbose "$me: compiling testfile $src" 2
2093 set lines [gdb_compile $src $obj object {quiet}]
2097 if ![string match "" $lines] then {
2098 verbose "$me: testfile compilation failed, returning 0" 2
2102 set fp_obj [open $obj "r"]
2103 fconfigure $fp_obj -translation binary
2104 set data [read $fp_obj]
2109 set ELFMAG "\u007FELF"
2111 if {[string compare -length 4 $data $ELFMAG] != 0} {
2112 verbose "$me: returning 0" 2
2116 verbose "$me: returning 1" 2
2120 # Return 1 if the memory at address zero is readable.
2122 gdb_caching_proc is_address_zero_readable {
2126 gdb_test_multiple "x 0" "" {
2127 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2130 -re ".*$gdb_prompt $" {
2138 # Produce source file NAME and write SOURCES into it.
2140 proc gdb_produce_source { name sources } {
2142 set f [open $name "w"]
2148 # Return 1 if target is ILP32.
2149 # This cannot be decided simply from looking at the target string,
2150 # as it might depend on externally passed compiler options like -m64.
2151 gdb_caching_proc is_ilp32_target {
2152 set me "is_ilp32_target"
2154 set src [standard_temp_file ilp32[pid].c]
2155 set obj [standard_temp_file ilp32[pid].o]
2157 gdb_produce_source $src {
2158 int dummy[sizeof (int) == 4
2159 && sizeof (void *) == 4
2160 && sizeof (long) == 4 ? 1 : -1];
2163 verbose "$me: compiling testfile $src" 2
2164 set lines [gdb_compile $src $obj object {quiet}]
2168 if ![string match "" $lines] then {
2169 verbose "$me: testfile compilation failed, returning 0" 2
2173 verbose "$me: returning 1" 2
2177 # Return 1 if target is LP64.
2178 # This cannot be decided simply from looking at the target string,
2179 # as it might depend on externally passed compiler options like -m64.
2180 gdb_caching_proc is_lp64_target {
2181 set me "is_lp64_target"
2183 set src [standard_temp_file lp64[pid].c]
2184 set obj [standard_temp_file lp64[pid].o]
2186 gdb_produce_source $src {
2187 int dummy[sizeof (int) == 4
2188 && sizeof (void *) == 8
2189 && sizeof (long) == 8 ? 1 : -1];
2192 verbose "$me: compiling testfile $src" 2
2193 set lines [gdb_compile $src $obj object {quiet}]
2197 if ![string match "" $lines] then {
2198 verbose "$me: testfile compilation failed, returning 0" 2
2202 verbose "$me: returning 1" 2
2206 # Return 1 if target has 64 bit addresses.
2207 # This cannot be decided simply from looking at the target string,
2208 # as it might depend on externally passed compiler options like -m64.
2209 gdb_caching_proc is_64_target {
2210 set me "is_64_target"
2212 set src [standard_temp_file is64[pid].c]
2213 set obj [standard_temp_file is64[pid].o]
2215 gdb_produce_source $src {
2216 int function(void) { return 3; }
2217 int dummy[sizeof (&function) == 8 ? 1 : -1];
2220 verbose "$me: compiling testfile $src" 2
2221 set lines [gdb_compile $src $obj object {quiet}]
2225 if ![string match "" $lines] then {
2226 verbose "$me: testfile compilation failed, returning 0" 2
2230 verbose "$me: returning 1" 2
2234 # Return 1 if target has x86_64 registers - either amd64 or x32.
2235 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2236 # just from the target string.
2237 gdb_caching_proc is_amd64_regs_target {
2238 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2242 set me "is_amd64_regs_target"
2244 set src [standard_temp_file reg64[pid].s]
2245 set obj [standard_temp_file reg64[pid].o]
2249 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2250 lappend list "\tincq %$reg"
2252 gdb_produce_source $src [join $list \n]
2254 verbose "$me: compiling testfile $src" 2
2255 set lines [gdb_compile $src $obj object {quiet}]
2259 if ![string match "" $lines] then {
2260 verbose "$me: testfile compilation failed, returning 0" 2
2264 verbose "$me: returning 1" 2
2268 # Return 1 if this target is an x86 or x86-64 with -m32.
2269 proc is_x86_like_target {} {
2270 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2273 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2276 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2277 proc support_displaced_stepping {} {
2279 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2280 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2281 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
2288 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2289 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2291 gdb_caching_proc skip_altivec_tests {
2292 global srcdir subdir gdb_prompt inferior_exited_re
2294 set me "skip_altivec_tests"
2296 # Some simulators are known to not support VMX instructions.
2297 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2298 verbose "$me: target known to not support VMX, returning 1" 2
2302 # Make sure we have a compiler that understands altivec.
2303 set compile_flags {debug nowarnings}
2304 if [get_compiler_info] {
2305 warning "Could not get compiler info"
2308 if [test_compiler_info gcc*] {
2309 set compile_flags "$compile_flags additional_flags=-maltivec"
2310 } elseif [test_compiler_info xlc*] {
2311 set compile_flags "$compile_flags additional_flags=-qaltivec"
2313 verbose "Could not compile with altivec support, returning 1" 2
2317 # Set up, compile, and execute a test program containing VMX instructions.
2318 # Include the current process ID in the file names to prevent conflicts
2319 # with invocations for multiple testsuites.
2320 set src [standard_temp_file vmx[pid].c]
2321 set exe [standard_temp_file vmx[pid].x]
2323 gdb_produce_source $src {
2326 asm volatile ("vor v0,v0,v0");
2328 asm volatile ("vor 0,0,0");
2334 verbose "$me: compiling testfile $src" 2
2335 set lines [gdb_compile $src $exe executable $compile_flags]
2338 if ![string match "" $lines] then {
2339 verbose "$me: testfile compilation failed, returning 1" 2
2343 # No error message, compilation succeeded so now run it via gdb.
2347 gdb_reinitialize_dir $srcdir/$subdir
2351 -re ".*Illegal instruction.*${gdb_prompt} $" {
2352 verbose -log "\n$me altivec hardware not detected"
2353 set skip_vmx_tests 1
2355 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2356 verbose -log "\n$me: altivec hardware detected"
2357 set skip_vmx_tests 0
2360 warning "\n$me: default case taken"
2361 set skip_vmx_tests 1
2365 remote_file build delete $exe
2367 verbose "$me: returning $skip_vmx_tests" 2
2368 return $skip_vmx_tests
2371 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2372 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2374 gdb_caching_proc skip_vsx_tests {
2375 global srcdir subdir gdb_prompt inferior_exited_re
2377 set me "skip_vsx_tests"
2379 # Some simulators are known to not support Altivec instructions, so
2380 # they won't support VSX instructions as well.
2381 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2382 verbose "$me: target known to not support VSX, returning 1" 2
2386 # Make sure we have a compiler that understands altivec.
2387 set compile_flags {debug nowarnings quiet}
2388 if [get_compiler_info] {
2389 warning "Could not get compiler info"
2392 if [test_compiler_info gcc*] {
2393 set compile_flags "$compile_flags additional_flags=-mvsx"
2394 } elseif [test_compiler_info xlc*] {
2395 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2397 verbose "Could not compile with vsx support, returning 1" 2
2401 set src [standard_temp_file vsx[pid].c]
2402 set exe [standard_temp_file vsx[pid].x]
2404 gdb_produce_source $src {
2406 double a[2] = { 1.0, 2.0 };
2408 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2410 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2416 verbose "$me: compiling testfile $src" 2
2417 set lines [gdb_compile $src $exe executable $compile_flags]
2420 if ![string match "" $lines] then {
2421 verbose "$me: testfile compilation failed, returning 1" 2
2425 # No error message, compilation succeeded so now run it via gdb.
2429 gdb_reinitialize_dir $srcdir/$subdir
2433 -re ".*Illegal instruction.*${gdb_prompt} $" {
2434 verbose -log "\n$me VSX hardware not detected"
2435 set skip_vsx_tests 1
2437 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2438 verbose -log "\n$me: VSX hardware detected"
2439 set skip_vsx_tests 0
2442 warning "\n$me: default case taken"
2443 set skip_vsx_tests 1
2447 remote_file build delete $exe
2449 verbose "$me: returning $skip_vsx_tests" 2
2450 return $skip_vsx_tests
2453 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2454 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2456 gdb_caching_proc skip_btrace_tests {
2457 global srcdir subdir gdb_prompt inferior_exited_re
2459 set me "skip_btrace_tests"
2460 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2461 verbose "$me: target does not support btrace, returning 1" 2
2465 # Set up, compile, and execute a test program.
2466 # Include the current process ID in the file names to prevent conflicts
2467 # with invocations for multiple testsuites.
2468 set src [standard_temp_file btrace[pid].c]
2469 set exe [standard_temp_file btrace[pid].x]
2471 gdb_produce_source $src {
2472 int main(void) { return 0; }
2475 verbose "$me: compiling testfile $src" 2
2476 set compile_flags {debug nowarnings quiet}
2477 set lines [gdb_compile $src $exe executable $compile_flags]
2479 if ![string match "" $lines] then {
2480 verbose "$me: testfile compilation failed, returning 1" 2
2485 # No error message, compilation succeeded so now run it via gdb.
2489 gdb_reinitialize_dir $srcdir/$subdir
2496 # In case of an unexpected output, we return 2 as a fail value.
2497 set skip_btrace_tests 2
2498 gdb_test_multiple "record btrace" "check btrace support" {
2499 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2500 set skip_btrace_tests 1
2502 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2503 set skip_btrace_tests 1
2505 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2506 set skip_btrace_tests 1
2508 -re "^record btrace\r\n$gdb_prompt $" {
2509 set skip_btrace_tests 0
2513 remote_file build delete $exe
2515 verbose "$me: returning $skip_btrace_tests" 2
2516 return $skip_btrace_tests
2519 # Skip all the tests in the file if you are not on an hppa running
2522 proc skip_hp_tests {} {
2523 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
2524 verbose "Skip hp tests is $skip_hp"
2528 # Return whether we should skip tests for showing inlined functions in
2529 # backtraces. Requires get_compiler_info and get_debug_format.
2531 proc skip_inline_frame_tests {} {
2532 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2533 if { ! [test_debug_format "DWARF 2"] } {
2537 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2538 if { ([test_compiler_info "gcc-2-*"]
2539 || [test_compiler_info "gcc-3-*"]
2540 || [test_compiler_info "gcc-4-0-*"]) } {
2547 # Return whether we should skip tests for showing variables from
2548 # inlined functions. Requires get_compiler_info and get_debug_format.
2550 proc skip_inline_var_tests {} {
2551 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2552 if { ! [test_debug_format "DWARF 2"] } {
2559 # Return a 1 if we should skip tests that require hardware breakpoints
2561 proc skip_hw_breakpoint_tests {} {
2562 # Skip tests if requested by the board (note that no_hardware_watchpoints
2563 # disables both watchpoints and breakpoints)
2564 if { [target_info exists gdb,no_hardware_watchpoints]} {
2568 # These targets support hardware breakpoints natively
2569 if { [istarget "i?86-*-*"]
2570 || [istarget "x86_64-*-*"]
2571 || [istarget "ia64-*-*"]
2572 || [istarget "arm*-*-*"]
2573 || [istarget "aarch64*-*-*"]} {
2580 # Return a 1 if we should skip tests that require hardware watchpoints
2582 proc skip_hw_watchpoint_tests {} {
2583 # Skip tests if requested by the board
2584 if { [target_info exists gdb,no_hardware_watchpoints]} {
2588 # These targets support hardware watchpoints natively
2589 if { [istarget "i?86-*-*"]
2590 || [istarget "x86_64-*-*"]
2591 || [istarget "ia64-*-*"]
2592 || [istarget "arm*-*-*"]
2593 || [istarget "aarch64*-*-*"]
2594 || [istarget "powerpc*-*-linux*"]
2595 || [istarget "s390*-*-*"] } {
2602 # Return a 1 if we should skip tests that require *multiple* hardware
2603 # watchpoints to be active at the same time
2605 proc skip_hw_watchpoint_multi_tests {} {
2606 if { [skip_hw_watchpoint_tests] } {
2610 # These targets support just a single hardware watchpoint
2611 if { [istarget "arm*-*-*"]
2612 || [istarget "powerpc*-*-linux*"] } {
2619 # Return a 1 if we should skip tests that require read/access watchpoints
2621 proc skip_hw_watchpoint_access_tests {} {
2622 if { [skip_hw_watchpoint_tests] } {
2626 # These targets support just write watchpoints
2627 if { [istarget "s390*-*-*"] } {
2634 # Return 1 if we should skip tests that require the runtime unwinder
2635 # hook. This must be invoked while gdb is running, after shared
2636 # libraries have been loaded. This is needed because otherwise a
2637 # shared libgcc won't be visible.
2639 proc skip_unwinder_tests {} {
2643 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2644 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2646 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2649 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2653 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2654 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2657 -re "\r\n$gdb_prompt $" {
2664 # Return 0 if we should skip tests that require the libstdc++ stap
2665 # probes. This must be invoked while gdb is running, after shared
2666 # libraries have been loaded.
2668 proc skip_libstdcxx_probe_tests {} {
2672 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2673 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2676 -re "\r\n$gdb_prompt $" {
2682 # Return 1 if we should skip tests of the "compile" feature.
2683 # This must be invoked after the inferior has been started.
2685 proc skip_compile_feature_tests {} {
2689 gdb_test_multiple "compile code -- ;" "check for working compile command" {
2690 "Could not load libcc1.*\r\n$gdb_prompt $" {
2693 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
2696 -re "\r\n$gdb_prompt $" {
2702 # Check whether we're testing with the remote or extended-remote
2705 proc gdb_is_target_remote {} {
2708 set test "probe for target remote"
2709 gdb_test_multiple "maint print target-stack" $test {
2710 -re ".*emote serial target in gdb-specific protocol.*$gdb_prompt $" {
2714 -re "$gdb_prompt $" {
2721 # Return 1 if the current remote target is an instance of our GDBserver, 0
2722 # otherwise. Return -1 if there was an error and we can't tell.
2724 gdb_caching_proc target_is_gdbserver {
2728 set test "Probing for GDBserver"
2730 gdb_test_multiple "monitor help" $test {
2731 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
2734 -re "$gdb_prompt $" {
2739 if { $is_gdbserver == -1 } {
2740 verbose -log "Unable to tell whether we are using GDBserver or not."
2743 return $is_gdbserver
2746 set compiler_info "unknown"
2748 set hp_cc_compiler 0
2749 set hp_aCC_compiler 0
2751 # Figure out what compiler I am using.
2753 # ARG can be empty or "C++". If empty, "C" is assumed.
2755 # There are several ways to do this, with various problems.
2757 # [ gdb_compile -E $ifile -o $binfile.ci ]
2758 # source $binfile.ci
2760 # Single Unix Spec v3 says that "-E -o ..." together are not
2761 # specified. And in fact, the native compiler on hp-ux 11 (among
2762 # others) does not work with "-E -o ...". Most targets used to do
2763 # this, and it mostly worked, because it works with gcc.
2765 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2766 # source $binfile.ci
2768 # This avoids the problem with -E and -o together. This almost works
2769 # if the build machine is the same as the host machine, which is
2770 # usually true of the targets which are not gcc. But this code does
2771 # not figure which compiler to call, and it always ends up using the C
2772 # compiler. Not good for setting hp_aCC_compiler. Target
2773 # hppa*-*-hpux* used to do this.
2775 # [ gdb_compile -E $ifile > $binfile.ci ]
2776 # source $binfile.ci
2778 # dejagnu target_compile says that it supports output redirection,
2779 # but the code is completely different from the normal path and I
2780 # don't want to sweep the mines from that path. So I didn't even try
2783 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2786 # I actually do this for all targets now. gdb_compile runs the right
2787 # compiler, and TCL captures the output, and I eval the output.
2789 # Unfortunately, expect logs the output of the command as it goes by,
2790 # and dejagnu helpfully prints a second copy of it right afterwards.
2791 # So I turn off expect logging for a moment.
2793 # [ gdb_compile $ifile $ciexe_file executable $args ]
2794 # [ remote_exec $ciexe_file ]
2795 # [ source $ci_file.out ]
2797 # I could give up on -E and just do this.
2798 # I didn't get desperate enough to try this.
2800 # -- chastain 2004-01-06
2802 proc get_compiler_info {{arg ""}} {
2803 # For compiler.c and compiler.cc
2806 # I am going to play with the log to keep noise out.
2810 # These come from compiler.c or compiler.cc
2811 global compiler_info
2813 # Legacy global data symbols.
2815 global hp_cc_compiler
2816 global hp_aCC_compiler
2818 # Choose which file to preprocess.
2819 set ifile "${srcdir}/lib/compiler.c"
2820 if { $arg == "c++" } {
2821 set ifile "${srcdir}/lib/compiler.cc"
2824 # Run $ifile through the right preprocessor.
2825 # Toggle gdb.log to keep the compiler output out of the log.
2826 set saved_log [log_file -info]
2828 if [is_remote host] {
2829 # We have to use -E and -o together, despite the comments
2830 # above, because of how DejaGnu handles remote host testing.
2831 set ppout "$outdir/compiler.i"
2832 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
2833 set file [open $ppout r]
2834 set cppout [read $file]
2837 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
2839 eval log_file $saved_log
2843 foreach cppline [ split "$cppout" "\n" ] {
2844 if { [ regexp "^#" "$cppline" ] } {
2846 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2848 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2850 verbose "get_compiler_info: $cppline" 2
2854 verbose -log "get_compiler_info: $cppline"
2859 # Reset to unknown compiler if any diagnostics happened.
2861 set compiler_info "unknown"
2864 # Set the legacy symbols.
2866 set hp_cc_compiler 0
2867 set hp_aCC_compiler 0
2868 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2869 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2870 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2871 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2872 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2873 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2874 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2876 # Log what happened.
2877 verbose -log "get_compiler_info: $compiler_info"
2879 # Most compilers will evaluate comparisons and other boolean
2880 # operations to 0 or 1.
2881 uplevel \#0 { set true 1 }
2882 uplevel \#0 { set false 0 }
2884 # Use of aCC results in boolean results being displayed as
2886 if { $hp_aCC_compiler } {
2887 uplevel \#0 { set true true }
2888 uplevel \#0 { set false false }
2894 proc test_compiler_info { {compiler ""} } {
2895 global compiler_info
2897 # if no arg, return the compiler_info string
2899 if [string match "" $compiler] {
2900 if [info exists compiler_info] {
2901 return $compiler_info
2903 perror "No compiler info found."
2907 return [string match $compiler $compiler_info]
2910 proc current_target_name { } {
2912 if [info exists target_info(target,name)] {
2913 set answer $target_info(target,name)
2920 set gdb_wrapper_initialized 0
2921 set gdb_wrapper_target ""
2923 proc gdb_wrapper_init { args } {
2924 global gdb_wrapper_initialized
2925 global gdb_wrapper_file
2926 global gdb_wrapper_flags
2927 global gdb_wrapper_target
2929 if { $gdb_wrapper_initialized == 1 } { return; }
2931 if {[target_info exists needs_status_wrapper] && \
2932 [target_info needs_status_wrapper] != "0"} {
2933 set result [build_wrapper "testglue.o"]
2934 if { $result != "" } {
2935 set gdb_wrapper_file [lindex $result 0]
2936 set gdb_wrapper_flags [lindex $result 1]
2938 warning "Status wrapper failed to build."
2941 set gdb_wrapper_initialized 1
2942 set gdb_wrapper_target [current_target_name]
2945 # Some targets need to always link a special object in. Save its path here.
2946 global gdb_saved_set_unbuffered_mode_obj
2947 set gdb_saved_set_unbuffered_mode_obj ""
2949 proc gdb_compile {source dest type options} {
2950 global GDB_TESTCASE_OPTIONS
2951 global gdb_wrapper_file
2952 global gdb_wrapper_flags
2953 global gdb_wrapper_initialized
2956 global gdb_saved_set_unbuffered_mode_obj
2958 set outdir [file dirname $dest]
2960 # Add platform-specific options if a shared library was specified using
2961 # "shlib=librarypath" in OPTIONS.
2965 foreach opt $options {
2966 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2967 if [test_compiler_info "xlc-*"] {
2968 # IBM xlc compiler doesn't accept shared library named other
2969 # than .so: use "-Wl," to bypass this
2970 lappend source "-Wl,$shlib_name"
2971 } elseif { ([istarget "*-*-mingw*"]
2972 || [istarget *-*-cygwin*]
2973 || [istarget *-*-pe*])} {
2974 lappend source "${shlib_name}.a"
2976 lappend source $shlib_name
2978 if { $shlib_found == 0 } {
2980 if { ([istarget "*-*-mingw*"]
2981 || [istarget *-*-cygwin*]) } {
2982 lappend new_options "additional_flags=-Wl,--enable-auto-import"
2985 } elseif { $opt == "shlib_load" } {
2988 lappend new_options $opt
2992 # We typically link to shared libraries using an absolute path, and
2993 # that's how they are found at runtime. If we are going to
2994 # dynamically load one by basename, we must specify rpath. If we
2995 # are using a remote host, DejaGNU will link to the shared library
2996 # using a relative path, so again we must specify an rpath.
2997 if { $shlib_load || ($shlib_found && [is_remote target]) } {
2998 if { ([istarget "*-*-mingw*"]
2999 || [istarget *-*-cygwin*]
3000 || [istarget *-*-pe*]
3001 || [istarget hppa*-*-hpux*])} {
3002 # Do not need anything.
3003 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3004 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3005 } elseif { [istarget arm*-*-symbianelf*] } {
3006 if { $shlib_load } {
3007 lappend new_options "libs=-ldl"
3010 if { $shlib_load } {
3011 lappend new_options "libs=-ldl"
3013 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3016 set options $new_options
3018 if [info exists GDB_TESTCASE_OPTIONS] {
3019 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3021 verbose "options are $options"
3022 verbose "source is $source $dest $type $options"
3024 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3026 if {[target_info exists needs_status_wrapper] && \
3027 [target_info needs_status_wrapper] != "0" && \
3028 [info exists gdb_wrapper_file]} {
3029 lappend options "libs=${gdb_wrapper_file}"
3030 lappend options "ldflags=${gdb_wrapper_flags}"
3033 # Replace the "nowarnings" option with the appropriate additional_flags
3034 # to disable compiler warnings.
3035 set nowarnings [lsearch -exact $options nowarnings]
3036 if {$nowarnings != -1} {
3037 if [target_info exists gdb,nowarnings_flag] {
3038 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3040 set flag "additional_flags=-w"
3042 set options [lreplace $options $nowarnings $nowarnings $flag]
3045 if { $type == "executable" } {
3046 if { ([istarget "*-*-mingw*"]
3047 || [istarget "*-*-*djgpp"]
3048 || [istarget "*-*-cygwin*"])} {
3049 # Force output to unbuffered mode, by linking in an object file
3050 # with a global contructor that calls setvbuf.
3052 # Compile the special object seperatelly for two reasons:
3053 # 1) Insulate it from $options.
3054 # 2) Avoid compiling it for every gdb_compile invocation,
3055 # which is time consuming, especially if we're remote
3058 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3059 verbose "compiling gdb_saved_set_unbuffered_obj"
3060 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3061 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3063 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3064 if { $result != "" } {
3067 if {[is_remote host]} {
3068 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3070 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3072 # Link a copy of the output object, because the
3073 # original may be automatically deleted.
3074 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3076 verbose "gdb_saved_set_unbuffered_obj already compiled"
3079 # Rely on the internal knowledge that the global ctors are ran in
3080 # reverse link order. In that case, we can use ldflags to
3081 # avoid copying the object file to the host multiple
3083 # This object can only be added if standard libraries are
3084 # used. Thus, we need to disable it if -nostdlib option is used
3085 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3086 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3091 set result [target_compile $source $dest $type $options]
3093 # Prune uninteresting compiler (and linker) output.
3094 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3096 regsub "\[\r\n\]*$" "$result" "" result
3097 regsub "^\[\r\n\]*" "$result" "" result
3099 if {[lsearch $options quiet] < 0} {
3100 # We shall update this on a per language basis, to avoid
3101 # changing the entire testsuite in one go.
3102 if {[lsearch $options f77] >= 0} {
3103 gdb_compile_test $source $result
3104 } elseif { $result != "" } {
3105 clone_output "gdb compile failed, $result"
3112 # This is just like gdb_compile, above, except that it tries compiling
3113 # against several different thread libraries, to see which one this
3115 proc gdb_compile_pthreads {source dest type options} {
3117 set why_msg "unrecognized error"
3118 foreach lib {-lpthreads -lpthread -lthread ""} {
3119 # This kind of wipes out whatever libs the caller may have
3120 # set. Or maybe theirs will override ours. How infelicitous.
3121 set options_with_lib [concat $options [list libs=$lib quiet]]
3122 set ccout [gdb_compile $source $dest $type $options_with_lib]
3123 switch -regexp -- $ccout {
3124 ".*no posix threads support.*" {
3125 set why_msg "missing threads include file"
3128 ".*cannot open -lpthread.*" {
3129 set why_msg "missing runtime threads library"
3131 ".*Can't find library for -lpthread.*" {
3132 set why_msg "missing runtime threads library"
3135 pass "successfully compiled posix threads test case"
3141 if {!$built_binfile} {
3142 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3147 # Build a shared library from SOURCES.
3149 proc gdb_compile_shlib {sources dest options} {
3150 set obj_options $options
3153 if { [lsearch -exact $options "c++"] >= 0 } {
3154 set info_options "c++"
3156 if [get_compiler_info ${info_options}] {
3160 switch -glob [test_compiler_info] {
3162 lappend obj_options "additional_flags=-qpic"
3165 if { !([istarget "*-*-cygwin*"]
3166 || [istarget "*-*-mingw*"]) } {
3167 lappend obj_options "additional_flags=-fpic"
3171 if { !([istarget "powerpc*-*-aix*"]
3172 || [istarget "rs6000*-*-aix*"]
3173 || [istarget "*-*-cygwin*"]
3174 || [istarget "*-*-mingw*"]
3175 || [istarget "*-*-pe*"]) } {
3176 lappend obj_options "additional_flags=-fpic"
3180 switch -glob [istarget] {
3182 lappend obj_options "additional_flags=+z"
3185 # don't know what the compiler is...
3191 set outdir [file dirname $dest]
3193 foreach source $sources {
3194 set sourcebase [file tail $source]
3195 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3198 lappend objects ${outdir}/${sourcebase}.o
3201 if [istarget "hppa*-*-hpux*"] {
3202 remote_exec build "ld -b ${objects} -o ${dest}"
3204 set link_options $options
3205 if [test_compiler_info "xlc-*"] {
3206 lappend link_options "additional_flags=-qmkshrobj"
3208 lappend link_options "additional_flags=-shared"
3210 if { ([istarget "*-*-mingw*"]
3211 || [istarget *-*-cygwin*]
3212 || [istarget *-*-pe*]) } {
3213 if { [is_remote host] } {
3214 set name [file tail ${dest}]
3218 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3219 } elseif [is_remote target] {
3220 # By default, we do not set the soname. This causes the linker
3221 # on ELF systems to create a DT_NEEDED entry in the executable
3222 # refering to the full path name of the library. This is a
3223 # problem in remote testing if the library is in a different
3224 # directory there. To fix this, we set a soname of just the
3225 # base filename for the library, and add an appropriate -rpath
3226 # to the main executable (in gdb_compile).
3227 set destbase [file tail $dest]
3228 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3231 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3234 if { [is_remote host]
3235 && ([istarget "*-*-mingw*"]
3236 || [istarget *-*-cygwin*]
3237 || [istarget *-*-pe*]) } {
3238 set dest_tail_name [file tail ${dest}]
3239 remote_upload host $dest_tail_name.a ${dest}.a
3240 remote_file host delete $dest_tail_name.a
3246 # This is just like gdb_compile_shlib, above, except that it tries compiling
3247 # against several different thread libraries, to see which one this
3249 proc gdb_compile_shlib_pthreads {sources dest options} {
3251 set why_msg "unrecognized error"
3252 foreach lib {-lpthreads -lpthread -lthread ""} {
3253 # This kind of wipes out whatever libs the caller may have
3254 # set. Or maybe theirs will override ours. How infelicitous.
3255 set options_with_lib [concat $options [list libs=$lib quiet]]
3256 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3257 switch -regexp -- $ccout {
3258 ".*no posix threads support.*" {
3259 set why_msg "missing threads include file"
3262 ".*cannot open -lpthread.*" {
3263 set why_msg "missing runtime threads library"
3265 ".*Can't find library for -lpthread.*" {
3266 set why_msg "missing runtime threads library"
3269 pass "successfully compiled posix threads test case"
3275 if {!$built_binfile} {
3276 unsupported "Couldn't compile $sources: ${why_msg}"
3281 # This is just like gdb_compile_pthreads, above, except that we always add the
3282 # objc library for compiling Objective-C programs
3283 proc gdb_compile_objc {source dest type options} {
3285 set why_msg "unrecognized error"
3286 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3287 # This kind of wipes out whatever libs the caller may have
3288 # set. Or maybe theirs will override ours. How infelicitous.
3289 if { $lib == "solaris" } {
3290 set lib "-lpthread -lposix4"
3292 if { $lib != "-lobjc" } {
3293 set lib "-lobjc $lib"
3295 set options_with_lib [concat $options [list libs=$lib quiet]]
3296 set ccout [gdb_compile $source $dest $type $options_with_lib]
3297 switch -regexp -- $ccout {
3298 ".*no posix threads support.*" {
3299 set why_msg "missing threads include file"
3302 ".*cannot open -lpthread.*" {
3303 set why_msg "missing runtime threads library"
3305 ".*Can't find library for -lpthread.*" {
3306 set why_msg "missing runtime threads library"
3309 pass "successfully compiled objc with posix threads test case"
3315 if {!$built_binfile} {
3316 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3321 proc send_gdb { string } {
3322 global suppress_flag
3323 if { $suppress_flag } {
3326 return [remote_send host "$string"]
3329 # Send STRING to the inferior's terminal.
3331 proc send_inferior { string } {
3332 global inferior_spawn_id
3334 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3344 proc gdb_expect { args } {
3345 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3346 set atimeout [lindex $args 0]
3347 set expcode [list [lindex $args 1]]
3352 # A timeout argument takes precedence, otherwise of all the timeouts
3353 # select the largest.
3354 if [info exists atimeout] {
3357 set tmt [get_largest_timeout]
3360 global suppress_flag
3361 global remote_suppress_flag
3362 if [info exists remote_suppress_flag] {
3363 set old_val $remote_suppress_flag
3365 if [info exists suppress_flag] {
3366 if { $suppress_flag } {
3367 set remote_suppress_flag 1
3371 {uplevel remote_expect host $tmt $expcode} string]
3372 if [info exists old_val] {
3373 set remote_suppress_flag $old_val
3375 if [info exists remote_suppress_flag] {
3376 unset remote_suppress_flag
3381 global errorInfo errorCode
3383 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3385 return -code $code $string
3389 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3391 # Check for long sequence of output by parts.
3392 # TEST: is the test message to be printed with the test success/fail.
3393 # SENTINEL: Is the terminal pattern indicating that output has finished.
3394 # LIST: is the sequence of outputs to match.
3395 # If the sentinel is recognized early, it is considered an error.
3398 # 1 if the test failed,
3399 # 0 if the test passes,
3400 # -1 if there was an internal error.
3402 proc gdb_expect_list {test sentinel list} {
3404 global suppress_flag
3407 if { $suppress_flag } {
3409 unresolved "${test}"
3411 while { ${index} < [llength ${list}] } {
3412 set pattern [lindex ${list} ${index}]
3413 set index [expr ${index} + 1]
3414 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3415 if { ${index} == [llength ${list}] } {
3418 -re "${pattern}${sentinel}" {
3419 # pass "${test}, pattern ${index} + sentinel"
3422 fail "${test} (pattern ${index} + sentinel)"
3425 -re ".*A problem internal to GDB has been detected" {
3426 fail "${test} (GDB internal error)"
3428 gdb_internal_error_resync
3431 fail "${test} (pattern ${index} + sentinel) (timeout)"
3436 # unresolved "${test}, pattern ${index} + sentinel"
3442 # pass "${test}, pattern ${index}"
3445 fail "${test} (pattern ${index})"
3448 -re ".*A problem internal to GDB has been detected" {
3449 fail "${test} (GDB internal error)"
3451 gdb_internal_error_resync
3454 fail "${test} (pattern ${index}) (timeout)"
3459 # unresolved "${test}, pattern ${index}"
3473 proc gdb_suppress_entire_file { reason } {
3474 global suppress_flag
3477 set suppress_flag -1
3481 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3482 # gdb_expect to fail immediately (until the next call to
3483 # gdb_stop_suppressing_tests).
3485 proc gdb_suppress_tests { args } {
3486 global suppress_flag
3488 return; # fnf - disable pending review of results where
3489 # testsuite ran better without this
3492 if { $suppress_flag == 1 } {
3493 if { [llength $args] > 0 } {
3494 warning "[lindex $args 0]\n"
3496 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3502 # Clear suppress_flag.
3504 proc gdb_stop_suppressing_tests { } {
3505 global suppress_flag
3507 if [info exists suppress_flag] {
3508 if { $suppress_flag > 0 } {
3510 clone_output "Tests restarted.\n"
3517 proc gdb_clear_suppressed { } {
3518 global suppress_flag
3523 # Spawn the gdb process.
3525 # This doesn't expect any output or do any other initialization,
3526 # leaving those to the caller.
3528 # Overridable function -- you can override this function in your
3531 proc gdb_spawn { } {
3535 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3537 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3540 set saved_gdbflags $GDBFLAGS
3542 if {$GDBFLAGS != ""} {
3545 append GDBFLAGS $cmdline_flags
3549 set GDBFLAGS $saved_gdbflags
3554 # Start gdb running, wait for prompt, and disable the pagers.
3556 # Overridable function -- you can override this function in your
3559 proc gdb_start { } {
3564 catch default_gdb_exit
3567 # Return true if we can spawn a program on the target and attach to
3570 proc can_spawn_for_attach { } {
3571 # We use TCL's exec to get the inferior's pid.
3572 if [is_remote target] then {
3576 # The "attach" command doesn't make sense when the target is
3577 # stub-like, where GDB finds the program already started on
3578 # initial connection.
3579 if {[target_info exists use_gdb_stub]} {
3587 # Start a set of programs running and then wait for a bit, to be sure
3588 # that they can be attached to. Return a list of the processes' PIDs.
3589 # It's a test error to call this when [can_spawn_for_attach] is false.
3591 proc spawn_wait_for_attach { executable_list } {
3594 if ![can_spawn_for_attach] {
3595 # The caller should have checked can_spawn_for_attach itself
3596 # before getting here.
3597 error "can't spawn for attach with this target/board"
3600 foreach {executable} $executable_list {
3601 lappend pid_list [eval exec $executable &]
3606 if { [istarget "*-*-cygwin*"] } {
3607 for {set i 0} {$i < [llength $pid_list]} {incr i} {
3608 # testpid is the Cygwin PID, GDB uses the Windows PID,
3609 # which might be different due to the way fork/exec works.
3610 set testpid [lindex $pid_list $i]
3611 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
3612 set pid_list [lreplace $pid_list $i $i $testpid]
3620 # gdb_load_cmd -- load a file into the debugger.
3621 # ARGS - additional args to load command.
3622 # return a -1 if anything goes wrong.
3624 proc gdb_load_cmd { args } {
3627 if [target_info exists gdb_load_timeout] {
3628 set loadtimeout [target_info gdb_load_timeout]
3630 set loadtimeout 1600
3632 send_gdb "load $args\n"
3633 verbose "Timeout is now $loadtimeout seconds" 2
3634 gdb_expect $loadtimeout {
3635 -re "Loading section\[^\r\]*\r\n" {
3638 -re "Start address\[\r\]*\r\n" {
3641 -re "Transfer rate\[\r\]*\r\n" {
3644 -re "Memory access error\[^\r\]*\r\n" {
3645 perror "Failed to load program"
3648 -re "$gdb_prompt $" {
3651 -re "(.*)\r\n$gdb_prompt " {
3652 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3656 perror "Timed out trying to load $args."
3663 # Invoke "gcore". CORE is the name of the core file to write. TEST
3664 # is the name of the test case. This will return 1 if the core file
3665 # was created, 0 otherwise. If this fails to make a core file because
3666 # this configuration of gdb does not support making core files, it
3667 # will call "unsupported", not "fail". However, if this fails to make
3668 # a core file for some other reason, then it will call "fail".
3670 proc gdb_gcore_cmd {core test} {
3674 gdb_test_multiple "gcore $core" $test {
3675 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3679 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
3687 # Load core file CORE. TEST is the name of the test case.
3688 # This will record a pass/fail for loading the core file.
3690 # 1 - core file is successfully loaded
3691 # 0 - core file loaded but has a non fatal error
3692 # -1 - core file failed to load
3694 proc gdb_core_cmd { core test } {
3697 gdb_test_multiple "core $core" "$test" {
3698 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
3701 -re " is not a core dump:.*\r\n$gdb_prompt $" {
3702 fail "$test (bad file format)"
3705 -re ": No such file or directory.*\r\n$gdb_prompt $" {
3706 fail "$test (file not found)"
3709 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
3710 fail "$test (incomplete note section)"
3713 -re "Core was generated by .*\r\n$gdb_prompt $" {
3717 -re ".*$gdb_prompt $" {
3722 fail "$test (timeout)"
3726 fail "unsupported output from 'core' command"
3730 # Return the filename to download to the target and load on the target
3731 # for this shared library. Normally just LIBNAME, unless shared libraries
3732 # for this target have separate link and load images.
3734 proc shlib_target_file { libname } {
3738 # Return the filename GDB will load symbols from when debugging this
3739 # shared library. Normally just LIBNAME, unless shared libraries for
3740 # this target have separate link and load images.
3742 proc shlib_symbol_file { libname } {
3746 # Return the filename to download to the target and load for this
3747 # executable. Normally just BINFILE unless it is renamed to something
3748 # else for this target.
3750 proc exec_target_file { binfile } {
3754 # Return the filename GDB will load symbols from when debugging this
3755 # executable. Normally just BINFILE unless executables for this target
3756 # have separate files for symbols.
3758 proc exec_symbol_file { binfile } {
3762 # Rename the executable file. Normally this is just BINFILE1 being renamed
3763 # to BINFILE2, but some targets require multiple binary files.
3764 proc gdb_rename_execfile { binfile1 binfile2 } {
3765 file rename -force [exec_target_file ${binfile1}] \
3766 [exec_target_file ${binfile2}]
3767 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
3768 file rename -force [exec_symbol_file ${binfile1}] \
3769 [exec_symbol_file ${binfile2}]
3773 # "Touch" the executable file to update the date. Normally this is just
3774 # BINFILE, but some targets require multiple files.
3775 proc gdb_touch_execfile { binfile } {
3776 set time [clock seconds]
3777 file mtime [exec_target_file ${binfile}] $time
3778 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
3779 file mtime [exec_symbol_file ${binfile}] $time
3783 # Like remote_download but provides a gdb-specific behavior. If DEST
3784 # is "host", and the host is not remote, and TOFILE is not specified,
3785 # then the [file tail] of FROMFILE is passed through
3786 # standard_output_file to compute the destination.
3788 proc gdb_remote_download {dest fromfile {tofile {}}} {
3789 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
3790 set tofile [standard_output_file [file tail $fromfile]]
3793 if { $tofile == "" } {
3794 return [remote_download $dest $fromfile]
3796 return [remote_download $dest $fromfile $tofile]
3802 # Copy a file to the remote target and return its target filename.
3803 # Schedule the file to be deleted at the end of this test.
3805 proc gdb_download { filename } {
3808 set destname [remote_download target $filename]
3809 lappend cleanfiles $destname
3813 # gdb_load_shlibs LIB...
3815 # Copy the listed libraries to the target.
3817 proc gdb_load_shlibs { args } {
3818 if {![is_remote target]} {
3822 foreach file $args {
3823 gdb_download [shlib_target_file $file]
3826 # Even if the target supplies full paths for shared libraries,
3827 # they may not be paths for this system.
3828 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3832 # gdb_load -- load a file into the debugger. Specifying no file
3833 # defaults to the executable currently being debugged.
3834 # The return value is 0 for success, -1 for failure.
3835 # Many files in config/*.exp override this procedure.
3837 proc gdb_load { arg } {
3839 return [gdb_file_cmd $arg]
3844 # gdb_reload -- load a file into the target. Called before "running",
3845 # either the first time or after already starting the program once,
3846 # for remote targets. Most files that override gdb_load should now
3847 # override this instead.
3849 proc gdb_reload { } {
3850 # For the benefit of existing configurations, default to gdb_load.
3851 # Specifying no file defaults to the executable currently being
3853 return [gdb_load ""]
3856 proc gdb_continue { function } {
3859 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
3862 proc default_gdb_init { test_file_name } {
3863 global gdb_wrapper_initialized
3864 global gdb_wrapper_target
3865 global gdb_test_file_name
3871 gdb_clear_suppressed
3873 set gdb_test_file_name [file rootname [file tail $test_file_name]]
3875 # Make sure that the wrapper is rebuilt
3876 # with the appropriate multilib option.
3877 if { $gdb_wrapper_target != [current_target_name] } {
3878 set gdb_wrapper_initialized 0
3881 # Unlike most tests, we have a small number of tests that generate
3882 # a very large amount of output. We therefore increase the expect
3883 # buffer size to be able to contain the entire test output. This
3884 # is especially needed by gdb.base/info-macros.exp.
3886 # Also set this value for the currently running GDB.
3887 match_max [match_max -d]
3889 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
3890 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
3893 if [target_info exists gdb_prompt] {
3894 set gdb_prompt [target_info gdb_prompt]
3896 set gdb_prompt "\\(gdb\\)"
3899 if [info exists use_gdb_stub] {
3904 # Turn BASENAME into a full file name in the standard output
3905 # directory. It is ok if BASENAME is the empty string; in this case
3906 # the directory is returned.
3908 proc standard_output_file {basename} {
3909 global objdir subdir gdb_test_file_name GDB_PARALLEL
3911 if {[info exists GDB_PARALLEL]} {
3912 set dir [file join $objdir outputs $subdir $gdb_test_file_name]
3914 return [file join $dir $basename]
3916 return [file join $objdir $subdir $basename]
3920 # Return the name of a file in our standard temporary directory.
3922 proc standard_temp_file {basename} {
3923 global objdir GDB_PARALLEL
3925 if {[info exists GDB_PARALLEL]} {
3926 return [file join $objdir temp $basename]
3932 # Set 'testfile', 'srcfile', and 'binfile'.
3934 # ARGS is a list of source file specifications.
3935 # Without any arguments, the .exp file's base name is used to
3936 # compute the source file name. The ".c" extension is added in this case.
3937 # If ARGS is not empty, each entry is a source file specification.
3938 # If the specification starts with a ".", it is treated as a suffix
3939 # to append to the .exp file's base name.
3940 # If the specification is the empty string, it is treated as if it
3942 # Otherwise it is a file name.
3943 # The first file in the list is used to set the 'srcfile' global.
3944 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3946 # Most tests should call this without arguments.
3948 # If a completely different binary file name is needed, then it
3949 # should be handled in the .exp file with a suitable comment.
3951 proc standard_testfile {args} {
3952 global gdb_test_file_name
3954 global gdb_test_file_last_vars
3957 global testfile binfile
3959 set testfile $gdb_test_file_name
3960 set binfile [standard_output_file ${testfile}]
3962 if {[llength $args] == 0} {
3966 # Unset our previous output variables.
3967 # This can help catch hidden bugs.
3968 if {[info exists gdb_test_file_last_vars]} {
3969 foreach varname $gdb_test_file_last_vars {
3971 catch {unset $varname}
3974 # 'executable' is often set by tests.
3975 set gdb_test_file_last_vars {executable}
3979 set varname srcfile$suffix
3982 # Handle an extension.
3985 } elseif {[string range $arg 0 0] == "."} {
3986 set arg $testfile$arg
3990 lappend gdb_test_file_last_vars $varname
3992 if {$suffix == ""} {
4000 # The default timeout used when testing GDB commands. We want to use
4001 # the same timeout as the default dejagnu timeout, unless the user has
4002 # already provided a specific value (probably through a site.exp file).
4003 global gdb_test_timeout
4004 if ![info exists gdb_test_timeout] {
4005 set gdb_test_timeout $timeout
4008 # A list of global variables that GDB testcases should not use.
4009 # We try to prevent their use by monitoring write accesses and raising
4010 # an error when that happens.
4011 set banned_variables { bug_id prms_id }
4013 # A list of procedures that GDB testcases should not use.
4014 # We try to prevent their use by monitoring invocations and raising
4015 # an error when that happens.
4016 set banned_procedures { strace }
4018 # gdb_init is called by runtest at start, but also by several
4019 # tests directly; gdb_finish is only called from within runtest after
4020 # each test source execution.
4021 # Placing several traces by repetitive calls to gdb_init leads
4022 # to problems, as only one trace is removed in gdb_finish.
4023 # To overcome this possible problem, we add a variable that records
4024 # if the banned variables and procedures are already traced.
4027 proc gdb_init { test_file_name } {
4028 # Reset the timeout value to the default. This way, any testcase
4029 # that changes the timeout value without resetting it cannot affect
4030 # the timeout used in subsequent testcases.
4031 global gdb_test_timeout
4033 set timeout $gdb_test_timeout
4035 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4036 && [target_info exists gdb_reverse_timeout] } {
4037 set timeout [target_info gdb_reverse_timeout]
4040 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4041 # debugging tool to help confirm that the test suite is
4042 # parallel-safe. You need "inotifywait" from the
4043 # inotify-tools package to use this.
4044 global GDB_INOTIFY inotify_pid
4045 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4046 global outdir tool inotify_log_file
4048 set exclusions {outputs temp gdb[.](log|sum) cache}
4049 set exclusion_re ([join $exclusions |])
4051 set inotify_log_file [standard_temp_file inotify.out]
4052 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4053 --exclude $exclusion_re \
4054 |& tee -a $outdir/$tool.log $inotify_log_file &]
4056 # Wait for the watches; hopefully this is long enough.
4059 # Clear the log so that we don't emit a warning the first time
4061 set fd [open $inotify_log_file w]
4065 # Block writes to all banned variables, and invocation of all
4066 # banned procedures...
4067 global banned_variables
4068 global banned_procedures
4069 global banned_traced
4070 if (!$banned_traced) {
4071 foreach banned_var $banned_variables {
4072 global "$banned_var"
4073 trace add variable "$banned_var" write error
4075 foreach banned_proc $banned_procedures {
4076 global "$banned_proc"
4077 trace add execution "$banned_proc" enter error
4082 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4083 # messages as expected.
4088 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4089 # the test results. Even if /dev/null doesn't exist on the particular
4090 # platform, the readline library will use the default setting just by
4091 # failing to open the file. OTOH, opening /dev/null successfully will
4092 # also result in the default settings being used since nothing will be
4093 # read from this file.
4094 setenv INPUTRC "/dev/null"
4096 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4097 # bindings, so make sure that an appropriate terminal is selected.
4098 # The same bug doesn't show up if we use ^P / ^N instead.
4101 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4102 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4103 # especially having color output turned on can cause tests to fail.
4104 setenv GREP_OPTIONS ""
4106 # Clear $gdbserver_reconnect_p.
4107 global gdbserver_reconnect_p
4108 set gdbserver_reconnect_p 1
4109 unset gdbserver_reconnect_p
4111 return [default_gdb_init $test_file_name]
4114 proc gdb_finish { } {
4115 global gdbserver_reconnect_p
4119 # Exit first, so that the files are no longer in use.
4122 if { [llength $cleanfiles] > 0 } {
4123 eval remote_file target delete $cleanfiles
4127 # Unblock write access to the banned variables. Dejagnu typically
4128 # resets some of them between testcases.
4129 global banned_variables
4130 global banned_procedures
4131 global banned_traced
4132 if ($banned_traced) {
4133 foreach banned_var $banned_variables {
4134 global "$banned_var"
4135 trace remove variable "$banned_var" write error
4137 foreach banned_proc $banned_procedures {
4138 global "$banned_proc"
4139 trace remove execution "$banned_proc" enter error
4146 set debug_format "unknown"
4148 # Run the gdb command "info source" and extract the debugging format
4149 # information from the output and save it in debug_format.
4151 proc get_debug_format { } {
4157 set debug_format "unknown"
4158 send_gdb "info source\n"
4160 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4161 set debug_format $expect_out(1,string)
4162 verbose "debug format is $debug_format"
4165 -re "No current source file.\r\n$gdb_prompt $" {
4166 perror "get_debug_format used when no current source file"
4169 -re "$gdb_prompt $" {
4170 warning "couldn't check debug format (no valid response)."
4174 warning "couldn't check debug format (timeout)."
4180 # Return true if FORMAT matches the debug format the current test was
4181 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4182 # `*', `[...]', and so on.
4184 # This function depends on variables set by `get_debug_format', above.
4186 proc test_debug_format {format} {
4189 return [expr [string match $format $debug_format] != 0]
4192 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4193 # COFF, stabs, etc). If that format matches the format that the
4194 # current test was compiled with, then the next test is expected to
4195 # fail for any target. Returns 1 if the next test or set of tests is
4196 # expected to fail, 0 otherwise (or if it is unknown). Must have
4197 # previously called get_debug_format.
4198 proc setup_xfail_format { format } {
4199 set ret [test_debug_format $format]
4207 # gdb_get_line_number TEXT [FILE]
4209 # Search the source file FILE, and return the line number of the
4210 # first line containing TEXT. If no match is found, an error is thrown.
4212 # TEXT is a string literal, not a regular expression.
4214 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4215 # specified, and does not start with "/", then it is assumed to be in
4216 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4217 # by changing the callers and the interface at the same time.
4218 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4219 # gdb.base/ena-dis-br.exp.
4221 # Use this function to keep your test scripts independent of the
4222 # exact line numbering of the source file. Don't write:
4224 # send_gdb "break 20"
4226 # This means that if anyone ever edits your test's source file,
4227 # your test could break. Instead, put a comment like this on the
4228 # source file line you want to break at:
4230 # /* breakpoint spot: frotz.exp: test name */
4232 # and then write, in your test script (which we assume is named
4235 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4237 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4240 # % puts "foo [lindex "bar baz" 1]"
4243 # Tcl is quite clever, for a little stringy language.)
4247 # The previous implementation of this procedure used the gdb search command.
4248 # This version is different:
4250 # . It works with MI, and it also works when gdb is not running.
4252 # . It operates on the build machine, not the host machine.
4254 # . For now, this implementation fakes a current directory of
4255 # $srcdir/$subdir to be compatible with the old implementation.
4256 # This will go away eventually and some callers will need to
4259 # . The TEXT argument is literal text and matches literally,
4260 # not a regular expression as it was before.
4262 # . State changes in gdb, such as changing the current file
4263 # and setting $_, no longer happen.
4265 # After a bit of time we can forget about the differences from the
4266 # old implementation.
4268 # --chastain 2004-08-05
4270 proc gdb_get_line_number { text { file "" } } {
4275 if { "$file" == "" } then {
4278 if { ! [regexp "^/" "$file"] } then {
4279 set file "$srcdir/$subdir/$file"
4282 if { [ catch { set fd [open "$file"] } message ] } then {
4287 for { set line 1 } { 1 } { incr line } {
4288 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4291 if { $nchar < 0 } then {
4294 if { [string first "$text" "$body"] >= 0 } then {
4300 if { [ catch { close "$fd" } message ] } then {
4305 error "undefined tag \"$text\""
4311 # Continue the program until it ends.
4313 # MSSG is the error message that gets printed. If not given, a
4315 # COMMAND is the command to invoke. If not given, "continue" is
4317 # ALLOW_EXTRA is a flag indicating whether the test should expect
4318 # extra output between the "Continuing." line and the program
4319 # exiting. By default it is zero; if nonzero, any extra output
4322 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4323 global inferior_exited_re use_gdb_stub
4326 set text "continue until exit"
4328 set text "continue until exit at $mssg"
4336 # By default, we don't rely on exit() behavior of remote stubs --
4337 # it's common for exit() to be implemented as a simple infinite
4338 # loop, or a forced crash/reset. For native targets, by default, we
4339 # assume process exit is reported as such. If a non-reliable target
4340 # is used, we set a breakpoint at exit, and continue to that.
4341 if { [target_info exists exit_is_reliable] } {
4342 set exit_is_reliable [target_info exit_is_reliable]
4344 set exit_is_reliable [expr ! $use_gdb_stub]
4347 if { ! $exit_is_reliable } {
4348 if {![gdb_breakpoint "exit"]} {
4351 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4354 # Continue until we exit. Should not stop again.
4355 # Don't bother to check the output of the program, that may be
4356 # extremely tough for some remote systems.
4358 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4363 proc rerun_to_main {} {
4364 global gdb_prompt use_gdb_stub
4369 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4370 {pass "rerun to main" ; return 0}
4371 -re "$gdb_prompt $"\
4372 {fail "rerun to main" ; return 0}
4373 timeout {fail "(timeout) rerun to main" ; return 0}
4378 -re "The program .* has been started already.*y or n. $" {
4382 -re "Starting program.*$gdb_prompt $"\
4383 {pass "rerun to main" ; return 0}
4384 -re "$gdb_prompt $"\
4385 {fail "rerun to main" ; return 0}
4386 timeout {fail "(timeout) rerun to main" ; return 0}
4391 # Print a message and return true if a test should be skipped
4392 # due to lack of floating point suport.
4394 proc gdb_skip_float_test { msg } {
4395 if [target_info exists gdb,skip_float_tests] {
4396 verbose "Skipping test '$msg': no float tests."
4402 # Print a message and return true if a test should be skipped
4403 # due to lack of stdio support.
4405 proc gdb_skip_stdio_test { msg } {
4406 if [target_info exists gdb,noinferiorio] {
4407 verbose "Skipping test '$msg': no inferior i/o."
4413 proc gdb_skip_bogus_test { msg } {
4417 # Return true if a test should be skipped due to lack of XML support
4419 # NOTE: This must be called while gdb is *not* running.
4421 gdb_caching_proc gdb_skip_xml_test {
4425 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4429 gdb_test_multiple "set tdesc filename $xml_file" "" {
4430 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4433 -re ".*$gdb_prompt $" { }
4439 # Return true if argv[0] is available.
4441 gdb_caching_proc gdb_has_argv0 {
4444 # Set up, compile, and execute a test program to check whether
4445 # argv[0] is available.
4446 set src [standard_temp_file has_argv0[pid].c]
4447 set exe [standard_temp_file has_argv0[pid].x]
4449 gdb_produce_source $src {
4450 int main (int argc, char **argv) {
4455 gdb_compile $src $exe executable {debug}
4458 proc gdb_has_argv0_1 { exe } {
4459 global srcdir subdir
4460 global gdb_prompt hex
4464 gdb_reinitialize_dir $srcdir/$subdir
4467 # Set breakpoint on main.
4468 gdb_test_multiple "break main" "break main" {
4469 -re "Breakpoint.*${gdb_prompt} $" {
4471 -re "${gdb_prompt} $" {
4478 gdb_test_multiple "" "run to main" {
4479 -re "Breakpoint.*${gdb_prompt} $" {
4481 -re "${gdb_prompt} $" {
4486 # Check whether argc is 1.
4487 gdb_test_multiple "p argc" "p argc" {
4488 -re " = 1\r\n${gdb_prompt} $" {
4490 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4491 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4494 -re "${gdb_prompt} $" {
4499 -re "${gdb_prompt} $" {
4506 set result [gdb_has_argv0_1 $exe]
4513 && ([istarget *-*-linux*]
4514 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4515 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4516 || [istarget *-*-openbsd*]
4517 || [istarget *-*-darwin*]
4518 || [istarget *-*-solaris*]
4519 || [istarget *-*-aix*]
4520 || [istarget *-*-gnu*]
4521 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
4522 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
4523 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
4524 || [istarget *-*-symbianelf*]
4525 || [istarget *-*-osf*]
4526 || [istarget *-*-hpux*]
4527 || [istarget *-*-dicos*]
4528 || [istarget *-*-nto*]
4529 || [istarget *-*-*vms*]
4530 || [istarget *-*-lynx*178]) } {
4531 fail "argv\[0\] should be available on this target"
4537 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
4538 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4539 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
4540 # the name of a debuginfo only file. This file will be stored in the same
4543 # Functions for separate debug info testing
4545 # starting with an executable:
4546 # foo --> original executable
4548 # at the end of the process we have:
4549 # foo.stripped --> foo w/o debug info
4550 # foo.debug --> foo's debug info
4551 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4553 # Fetch the build id from the file.
4554 # Returns "" if there is none.
4556 proc get_build_id { filename } {
4557 if { ([istarget "*-*-mingw*"]
4558 || [istarget *-*-cygwin*]) } {
4559 set objdump_program [gdb_find_objdump]
4560 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
4561 verbose "result is $result"
4562 verbose "output is $output"
4568 set tmp [standard_output_file "${filename}-tmp"]
4569 set objcopy_program [gdb_find_objcopy]
4570 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
4571 verbose "result is $result"
4572 verbose "output is $output"
4577 fconfigure $fi -translation binary
4578 # Skip the NOTE header.
4583 if ![string compare $data ""] then {
4586 # Convert it to hex.
4587 binary scan $data H* data
4592 # Return the build-id hex string (usually 160 bits as 40 hex characters)
4593 # converted to the form: .build-id/ab/cdef1234...89.debug
4594 # Return "" if no build-id found.
4595 proc build_id_debug_filename_get { filename } {
4596 set data [get_build_id $filename]
4597 if { $data == "" } {
4600 regsub {^..} $data {\0/} data
4601 return ".build-id/${data}.debug"
4604 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
4605 # list of optional flags. The only currently supported flag is no-main,
4606 # which removes the symbol entry for main from the separate debug file.
4608 # Function returns zero on success. Function will return non-zero failure code
4609 # on some targets not supporting separate debug info (such as i386-msdos).
4611 proc gdb_gnu_strip_debug { dest args } {
4613 # Use the first separate debug info file location searched by GDB so the
4614 # run cannot be broken by some stale file searched with higher precedence.
4615 set debug_file "${dest}.debug"
4617 set strip_to_file_program [transform strip]
4618 set objcopy_program [gdb_find_objcopy]
4620 set debug_link [file tail $debug_file]
4621 set stripped_file "${dest}.stripped"
4623 # Get rid of the debug info, and store result in stripped_file
4624 # something like gdb/testsuite/gdb.base/blah.stripped.
4625 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
4626 verbose "result is $result"
4627 verbose "output is $output"
4632 # Workaround PR binutils/10802:
4633 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4634 set perm [file attributes ${dest} -permissions]
4635 file attributes ${stripped_file} -permissions $perm
4637 # Get rid of everything but the debug info, and store result in debug_file
4638 # This will be in the .debug subdirectory, see above.
4639 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
4640 verbose "result is $result"
4641 verbose "output is $output"
4646 # If no-main is passed, strip the symbol for main from the separate
4647 # file. This is to simulate the behavior of elfutils's eu-strip, which
4648 # leaves the symtab in the original file only. There's no way to get
4649 # objcopy or strip to remove the symbol table without also removing the
4650 # debugging sections, so this is as close as we can get.
4651 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
4652 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
4653 verbose "result is $result"
4654 verbose "output is $output"
4658 file delete "${debug_file}"
4659 file rename "${debug_file}-tmp" "${debug_file}"
4662 # Link the two previous output files together, adding the .gnu_debuglink
4663 # section to the stripped_file, containing a pointer to the debug_file,
4664 # save the new file in dest.
4665 # This will be the regular executable filename, in the usual location.
4666 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
4667 verbose "result is $result"
4668 verbose "output is $output"
4673 # Workaround PR binutils/10802:
4674 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4675 set perm [file attributes ${stripped_file} -permissions]
4676 file attributes ${dest} -permissions $perm
4681 # Test the output of GDB_COMMAND matches the pattern obtained
4682 # by concatenating all elements of EXPECTED_LINES. This makes
4683 # it possible to split otherwise very long string into pieces.
4684 # If third argument is not empty, it's used as the name of the
4685 # test to be printed on pass/fail.
4686 proc help_test_raw { gdb_command expected_lines args } {
4687 set message $gdb_command
4688 if [llength $args]>0 then {
4689 set message [lindex $args 0]
4691 set expected_output [join $expected_lines ""]
4692 gdb_test "${gdb_command}" "${expected_output}" $message
4695 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
4696 # are regular expressions that should match the beginning of output,
4697 # before the list of commands in that class. The presence of
4698 # command list and standard epilogue will be tested automatically.
4699 proc test_class_help { command_class expected_initial_lines args } {
4701 "List of commands\:.*\[\r\n\]+"
4702 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
4703 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
4704 "Command name abbreviations are allowed if unambiguous\."
4706 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4708 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
4711 # COMMAND_LIST should have either one element -- command to test, or
4712 # two elements -- abbreviated command to test, and full command the first
4713 # element is abbreviation of.
4714 # The command must be a prefix command. EXPECTED_INITIAL_LINES
4715 # are regular expressions that should match the beginning of output,
4716 # before the list of subcommands. The presence of
4717 # subcommand list and standard epilogue will be tested automatically.
4718 proc test_prefix_command_help { command_list expected_initial_lines args } {
4719 set command [lindex $command_list 0]
4720 if {[llength $command_list]>1} {
4721 set full_command [lindex $command_list 1]
4723 set full_command $command
4725 # Use 'list' and not just {} because we want variables to
4726 # be expanded in this list.
4727 set l_stock_body [list\
4728 "List of $full_command subcommands\:.*\[\r\n\]+"\
4729 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
4730 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
4731 "Command name abbreviations are allowed if unambiguous\."]
4732 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4733 if {[llength $args]>0} {
4734 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
4736 help_test_raw "help ${command}" $l_entire_body
4740 # Build executable named EXECUTABLE from specifications that allow
4741 # different options to be passed to different sub-compilations.
4742 # TESTNAME is the name of the test; this is passed to 'untested' if
4744 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
4745 # contains the option "pthreads", then gdb_compile_pthreads is used.
4746 # ARGS is a flat list of source specifications, of the form:
4747 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
4748 # Each SOURCE is compiled to an object file using its OPTIONS,
4749 # using gdb_compile.
4750 # Returns 0 on success, -1 on failure.
4751 proc build_executable_from_specs {testname executable options args} {
4755 set binfile [standard_output_file $executable]
4758 if { [lsearch -exact $options "c++"] >= 0 } {
4759 set info_options "c++"
4761 if [get_compiler_info ${info_options}] {
4765 set func gdb_compile
4766 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
4767 if {$func_index != -1} {
4768 set func "${func}_[lindex $options $func_index]"
4771 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
4772 # parameter. They also requires $sources while gdb_compile and
4773 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
4774 if [string match gdb_compile_shlib* $func] {
4776 foreach {s local_options} $args {
4777 if { [regexp "^/" "$s"] } then {
4778 lappend sources_path "$s"
4780 lappend sources_path "$srcdir/$subdir/$s"
4783 set ret [$func $sources_path "${binfile}" $options]
4787 foreach {s local_options} $args {
4788 if { ! [regexp "^/" "$s"] } then {
4789 set s "$srcdir/$subdir/$s"
4791 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
4795 lappend objects "${binfile}${i}.o"
4798 set ret [$func $objects "${binfile}" executable $options]
4808 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4809 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4810 # to pass to untested, if something is wrong. OPTIONS are passed
4811 # to gdb_compile directly.
4812 proc build_executable { testname executable {sources ""} {options {debug}} } {
4813 if {[llength $sources]==0} {
4814 set sources ${executable}.c
4817 set arglist [list $testname $executable $options]
4818 foreach source $sources {
4819 lappend arglist $source $options
4822 return [eval build_executable_from_specs $arglist]
4825 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
4826 # the basename of the binary.
4827 # The return value is 0 for success, -1 for failure.
4828 proc clean_restart { executable } {
4831 set binfile [standard_output_file ${executable}]
4835 gdb_reinitialize_dir $srcdir/$subdir
4836 return [gdb_load ${binfile}]
4839 # Prepares for testing by calling build_executable_full, then
4841 # TESTNAME is the name of the test.
4842 # Each element in ARGS is a list of the form
4843 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
4844 # These are passed to build_executable_from_specs, which see.
4845 # The last EXECUTABLE is passed to clean_restart.
4846 # Returns 0 on success, non-zero on failure.
4847 proc prepare_for_testing_full {testname args} {
4848 foreach spec $args {
4849 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4852 set executable [lindex $spec 0]
4854 clean_restart $executable
4858 # Prepares for testing, by calling build_executable, and then clean_restart.
4859 # Please refer to build_executable for parameter description.
4860 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4862 if {[build_executable $testname $executable $sources $options] == -1} {
4865 clean_restart $executable
4870 proc get_valueof { fmt exp default } {
4873 set test "get valueof \"${exp}\""
4875 gdb_test_multiple "print${fmt} ${exp}" "$test" {
4876 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4877 set val $expect_out(1,string)
4881 fail "$test (timeout)"
4887 proc get_integer_valueof { exp default } {
4890 set test "get integer valueof \"${exp}\""
4892 gdb_test_multiple "print /d ${exp}" "$test" {
4893 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4894 set val $expect_out(1,string)
4898 fail "$test (timeout)"
4904 proc get_hexadecimal_valueof { exp default } {
4906 send_gdb "print /x ${exp}\n"
4907 set test "get hexadecimal valueof \"${exp}\""
4909 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4910 set val $expect_out(1,string)
4915 fail "$test (timeout)"
4921 proc get_sizeof { type default } {
4922 return [get_integer_valueof "sizeof (${type})" $default]
4925 proc get_target_charset { } {
4928 gdb_test_multiple "show target-charset" "" {
4929 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
4930 return $expect_out(1,string)
4932 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
4933 return $expect_out(1,string)
4937 # Pick a reasonable default.
4938 warning "Unable to read target-charset."
4942 # Get the current value for remotetimeout and return it.
4943 proc get_remotetimeout { } {
4947 gdb_test_multiple "show remotetimeout" "" {
4948 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
4949 return $expect_out(1,string)
4953 # Pick the default that gdb uses
4954 warning "Unable to read remotetimeout"
4958 # Set the remotetimeout to the specified timeout. Nothing is returned.
4959 proc set_remotetimeout { timeout } {
4962 gdb_test_multiple "set remotetimeout $timeout" "" {
4963 -re "$gdb_prompt $" {
4964 verbose "Set remotetimeout to $timeout\n"
4969 # ROOT and FULL are file names. Returns the relative path from ROOT
4970 # to FULL. Note that FULL must be in a subdirectory of ROOT.
4971 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
4974 proc relative_filename {root full} {
4975 set root_split [file split $root]
4976 set full_split [file split $full]
4978 set len [llength $root_split]
4980 if {[eval file join $root_split]
4981 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
4982 error "$full not a subdir of $root"
4985 return [eval file join [lrange $full_split $len end]]
4988 # Log gdb command line and script if requested.
4989 if {[info exists TRANSCRIPT]} {
4990 rename send_gdb real_send_gdb
4991 rename remote_spawn real_remote_spawn
4992 rename remote_close real_remote_close
4994 global gdb_transcript
4995 set gdb_transcript ""
4997 global gdb_trans_count
4998 set gdb_trans_count 1
5000 proc remote_spawn {args} {
5001 global gdb_transcript gdb_trans_count outdir
5003 if {$gdb_transcript != ""} {
5004 close $gdb_transcript
5006 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5007 puts $gdb_transcript [lindex $args 1]
5008 incr gdb_trans_count
5010 return [uplevel real_remote_spawn $args]
5013 proc remote_close {args} {
5014 global gdb_transcript
5016 if {$gdb_transcript != ""} {
5017 close $gdb_transcript
5018 set gdb_transcript ""
5021 return [uplevel real_remote_close $args]
5024 proc send_gdb {args} {
5025 global gdb_transcript
5027 if {$gdb_transcript != ""} {
5028 puts -nonewline $gdb_transcript [lindex $args 0]
5031 return [uplevel real_send_gdb $args]
5035 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5036 if {[info exists GDB_PARALLEL]} {
5037 if {[is_remote host]} {
5040 file mkdir outputs temp cache
5044 proc core_find {binfile {deletefiles {}} {arg ""}} {
5045 global objdir subdir
5047 set destcore "$binfile.core"
5048 file delete $destcore
5050 # Create a core file named "$destcore" rather than just "core", to
5051 # avoid problems with sys admin types that like to regularly prune all
5052 # files named "core" from the system.
5054 # Arbitrarily try setting the core size limit to "unlimited" since
5055 # this does not hurt on systems where the command does not work and
5056 # allows us to generate a core on systems where it does.
5058 # Some systems append "core" to the name of the program; others append
5059 # the name of the program to "core"; still others (like Linux, as of
5060 # May 2003) create cores named "core.PID". In the latter case, we
5061 # could have many core files lying around, and it may be difficult to
5062 # tell which one is ours, so let's run the program in a subdirectory.
5064 set coredir [standard_output_file coredir.[getpid]]
5066 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5067 # remote_exec host "${binfile}"
5068 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5069 if [remote_file build exists $i] {
5070 remote_exec build "mv $i $destcore"
5074 # Check for "core.PID".
5075 if { $found == 0 } {
5076 set names [glob -nocomplain -directory $coredir core.*]
5077 if {[llength $names] == 1} {
5078 set corefile [file join $coredir [lindex $names 0]]
5079 remote_exec build "mv $corefile $destcore"
5083 if { $found == 0 } {
5084 # The braindamaged HPUX shell quits after the ulimit -c above
5085 # without executing ${binfile}. So we try again without the
5086 # ulimit here if we didn't find a core file above.
5087 # Oh, I should mention that any "braindamaged" non-Unix system has
5088 # the same problem. I like the cd bit too, it's really neat'n stuff.
5089 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5090 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5091 if [remote_file build exists $i] {
5092 remote_exec build "mv $i $destcore"
5098 # Try to clean up after ourselves.
5099 foreach deletefile $deletefiles {
5100 remote_file build delete [file join $coredir $deletefile]
5102 remote_exec build "rmdir $coredir"
5104 if { $found == 0 } {
5105 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5111 # gdb_target_symbol_prefix_flags returns a string that can be added
5112 # to gdb_compile options to define SYMBOL_PREFIX macro value
5113 # symbol_prefix_flags returns a string that can be added
5114 # for targets that use underscore as symbol prefix.
5115 # TODO: find out automatically if the target needs this.
5117 proc gdb_target_symbol_prefix_flags {} {
5118 if { [istarget "i?86-*-cygwin*"] || [istarget "i?86-*-mingw*"]
5119 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
5120 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
5126 # A wrapper for 'remote_exec host' that passes or fails a test.
5127 # Returns 0 if all went well, nonzero on failure.
5128 # TEST is the name of the test, other arguments are as for remote_exec.
5130 proc run_on_host { test program args } {
5131 verbose -log "run_on_host: $program $args"
5132 # remote_exec doesn't work properly if the output is set but the
5133 # input is the empty string -- so replace an empty input with
5135 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5136 set args [lreplace $args 1 1 "/dev/null"]
5138 set result [eval remote_exec host [list $program] $args]
5139 verbose "result is $result"
5140 set status [lindex $result 0]
5141 set output [lindex $result 1]
5146 verbose -log "run_on_host failed: $output"
5152 # Return non-zero if "board_info debug_flags" mentions Fission.
5153 # http://gcc.gnu.org/wiki/DebugFission
5154 # Fission doesn't support everything yet.
5155 # This supports working around bug 15954.
5157 proc using_fission { } {
5158 set debug_flags [board_info [target_info name] debug_flags]
5159 return [regexp -- "-gsplit-dwarf" $debug_flags]
5162 # Search the caller's ARGS list and set variables according to the list of
5163 # valid options described by ARGSET.
5165 # The first member of each one- or two-element list in ARGSET defines the
5166 # name of a variable that will be added to the caller's scope.
5168 # If only one element is given to describe an option, it the value is
5169 # 0 if the option is not present in (the caller's) ARGS or 1 if
5172 # If two elements are given, the second element is the default value of
5173 # the variable. This is then overwritten if the option exists in ARGS.
5175 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5176 # any optional components.
5179 # proc myproc {foo args} {
5180 # parse_args {{bar} {baz "abc"} {qux}}
5183 # myproc ABC -bar -baz DEF peanut butter
5184 # will define the following variables in myproc:
5185 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5186 # args will be the list {peanut butter}
5188 proc parse_args { argset } {
5191 foreach argument $argset {
5192 if {[llength $argument] == 1} {
5193 # No default specified, so we assume that we should set
5194 # the value to 1 if the arg is present and 0 if it's not.
5195 # It is assumed that no value is given with the argument.
5196 set result [lsearch -exact $args "-$argument"]
5197 if {$result != -1} then {
5198 uplevel 1 [list set $argument 1]
5199 set args [lreplace $args $result $result]
5201 uplevel 1 [list set $argument 0]
5203 } elseif {[llength $argument] == 2} {
5204 # There are two items in the argument. The second is a
5205 # default value to use if the item is not present.
5206 # Otherwise, the variable is set to whatever is provided
5207 # after the item in the args.
5208 set arg [lindex $argument 0]
5209 set result [lsearch -exact $args "-[lindex $arg 0]"]
5210 if {$result != -1} then {
5211 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5212 set args [lreplace $args $result [expr $result+1]]
5214 uplevel 1 [list set $arg [lindex $argument 1]]
5217 error "Badly formatted argument \"$argument\" in argument set"
5221 # The remaining args should be checked to see that they match the
5222 # number of items expected to be passed into the procedure...
5225 # Capture the output of COMMAND in a string ignoring PREFIX; return that string.
5226 proc capture_command_output { command prefix } {
5230 set output_string ""
5231 gdb_test_multiple "$command" "capture_command_output for $command" {
5232 -re "${command}\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5233 set output_string $expect_out(1,string)
5236 return $output_string
5239 # A convenience function that joins all the arguments together, with a
5240 # regexp that matches exactly one end of line in between each argument.
5241 # This function is ideal to write the expected output of a GDB command
5242 # that generates more than a couple of lines, as this allows us to write
5243 # each line as a separate string, which is easier to read by a human
5246 proc multi_line { args } {
5247 return [join $args "\r\n"]
5250 # Always load compatibility stuff.