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 "*-*-linux*"] } {
2010 # Return 1 if target hardware or OS supports single stepping to signal
2011 # handler, otherwise, return 0.
2013 proc can_single_step_to_signal_handler {} {
2015 # Targets don't have hardware single step. On these targets, when
2016 # a signal is delivered during software single step, gdb is unable
2017 # to determine the next instruction addresses, because start of signal
2018 # handler is one of them.
2019 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2020 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2021 || [istarget "nios2-*-*"] } {
2028 # Return 1 if target supports process record, otherwise return 0.
2030 proc supports_process_record {} {
2032 if [target_info exists gdb,use_precord] {
2033 return [target_info gdb,use_precord]
2036 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2037 || [istarget "i\[34567\]86-*-linux*"]
2038 || [istarget "aarch64*-*-linux*"]
2039 || [istarget "powerpc*-*-linux*"] } {
2046 # Return 1 if target supports reverse debugging, otherwise return 0.
2048 proc supports_reverse {} {
2050 if [target_info exists gdb,can_reverse] {
2051 return [target_info gdb,can_reverse]
2054 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2055 || [istarget "i\[34567\]86-*-linux*"]
2056 || [istarget "aarch64*-*-linux*"]
2057 || [istarget "powerpc*-*-linux*"] } {
2064 # Return 1 if readline library is used.
2066 proc readline_is_used { } {
2069 gdb_test_multiple "show editing" "" {
2070 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2073 -re ".*$gdb_prompt $" {
2079 # Return 1 if target is ELF.
2080 gdb_caching_proc is_elf_target {
2081 set me "is_elf_target"
2083 set src [standard_temp_file is_elf_target[pid].c]
2084 set obj [standard_temp_file is_elf_target[pid].o]
2086 gdb_produce_source $src {
2087 int foo () {return 0;}
2090 verbose "$me: compiling testfile $src" 2
2091 set lines [gdb_compile $src $obj object {quiet}]
2095 if ![string match "" $lines] then {
2096 verbose "$me: testfile compilation failed, returning 0" 2
2100 set fp_obj [open $obj "r"]
2101 fconfigure $fp_obj -translation binary
2102 set data [read $fp_obj]
2107 set ELFMAG "\u007FELF"
2109 if {[string compare -length 4 $data $ELFMAG] != 0} {
2110 verbose "$me: returning 0" 2
2114 verbose "$me: returning 1" 2
2118 # Return 1 if the memory at address zero is readable.
2120 gdb_caching_proc is_address_zero_readable {
2124 gdb_test_multiple "x 0" "" {
2125 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2128 -re ".*$gdb_prompt $" {
2136 # Produce source file NAME and write SOURCES into it.
2138 proc gdb_produce_source { name sources } {
2140 set f [open $name "w"]
2146 # Return 1 if target is ILP32.
2147 # This cannot be decided simply from looking at the target string,
2148 # as it might depend on externally passed compiler options like -m64.
2149 gdb_caching_proc is_ilp32_target {
2150 set me "is_ilp32_target"
2152 set src [standard_temp_file ilp32[pid].c]
2153 set obj [standard_temp_file ilp32[pid].o]
2155 gdb_produce_source $src {
2156 int dummy[sizeof (int) == 4
2157 && sizeof (void *) == 4
2158 && sizeof (long) == 4 ? 1 : -1];
2161 verbose "$me: compiling testfile $src" 2
2162 set lines [gdb_compile $src $obj object {quiet}]
2166 if ![string match "" $lines] then {
2167 verbose "$me: testfile compilation failed, returning 0" 2
2171 verbose "$me: returning 1" 2
2175 # Return 1 if target is LP64.
2176 # This cannot be decided simply from looking at the target string,
2177 # as it might depend on externally passed compiler options like -m64.
2178 gdb_caching_proc is_lp64_target {
2179 set me "is_lp64_target"
2181 set src [standard_temp_file lp64[pid].c]
2182 set obj [standard_temp_file lp64[pid].o]
2184 gdb_produce_source $src {
2185 int dummy[sizeof (int) == 4
2186 && sizeof (void *) == 8
2187 && sizeof (long) == 8 ? 1 : -1];
2190 verbose "$me: compiling testfile $src" 2
2191 set lines [gdb_compile $src $obj object {quiet}]
2195 if ![string match "" $lines] then {
2196 verbose "$me: testfile compilation failed, returning 0" 2
2200 verbose "$me: returning 1" 2
2204 # Return 1 if target has 64 bit addresses.
2205 # This cannot be decided simply from looking at the target string,
2206 # as it might depend on externally passed compiler options like -m64.
2207 gdb_caching_proc is_64_target {
2208 set me "is_64_target"
2210 set src [standard_temp_file is64[pid].c]
2211 set obj [standard_temp_file is64[pid].o]
2213 gdb_produce_source $src {
2214 int function(void) { return 3; }
2215 int dummy[sizeof (&function) == 8 ? 1 : -1];
2218 verbose "$me: compiling testfile $src" 2
2219 set lines [gdb_compile $src $obj object {quiet}]
2223 if ![string match "" $lines] then {
2224 verbose "$me: testfile compilation failed, returning 0" 2
2228 verbose "$me: returning 1" 2
2232 # Return 1 if target has x86_64 registers - either amd64 or x32.
2233 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2234 # just from the target string.
2235 gdb_caching_proc is_amd64_regs_target {
2236 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2240 set me "is_amd64_regs_target"
2242 set src [standard_temp_file reg64[pid].s]
2243 set obj [standard_temp_file reg64[pid].o]
2247 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2248 lappend list "\tincq %$reg"
2250 gdb_produce_source $src [join $list \n]
2252 verbose "$me: compiling testfile $src" 2
2253 set lines [gdb_compile $src $obj object {quiet}]
2257 if ![string match "" $lines] then {
2258 verbose "$me: testfile compilation failed, returning 0" 2
2262 verbose "$me: returning 1" 2
2266 # Return 1 if this target is an x86 or x86-64 with -m32.
2267 proc is_x86_like_target {} {
2268 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2271 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2274 # Return 1 if this target is an arm or aarch32 on aarch64.
2276 gdb_caching_proc is_aarch32_target {
2277 if { [istarget "arm*-*-*"] } {
2281 if { ![istarget "aarch64*-*-*"] } {
2285 set me "is_aarch32_target"
2287 set src [standard_temp_file aarch32[pid].s]
2288 set obj [standard_temp_file aarch32[pid].o]
2293 lappend list "\tmov $reg, $reg"
2295 gdb_produce_source $src [join $list \n]
2297 verbose "$me: compiling testfile $src" 2
2298 set lines [gdb_compile $src $obj object {quiet}]
2302 if ![string match "" $lines] then {
2303 verbose "$me: testfile compilation failed, returning 0" 2
2307 verbose "$me: returning 1" 2
2311 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2313 proc is_aarch64_target {} {
2314 if { ![istarget "aarch64*-*-*"] } {
2318 return [expr ![is_aarch32_target]]
2321 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2322 proc support_displaced_stepping {} {
2324 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2325 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2326 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
2333 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2334 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2336 gdb_caching_proc skip_altivec_tests {
2337 global srcdir subdir gdb_prompt inferior_exited_re
2339 set me "skip_altivec_tests"
2341 # Some simulators are known to not support VMX instructions.
2342 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2343 verbose "$me: target known to not support VMX, returning 1" 2
2347 # Make sure we have a compiler that understands altivec.
2348 set compile_flags {debug nowarnings}
2349 if [get_compiler_info] {
2350 warning "Could not get compiler info"
2353 if [test_compiler_info gcc*] {
2354 set compile_flags "$compile_flags additional_flags=-maltivec"
2355 } elseif [test_compiler_info xlc*] {
2356 set compile_flags "$compile_flags additional_flags=-qaltivec"
2358 verbose "Could not compile with altivec support, returning 1" 2
2362 # Set up, compile, and execute a test program containing VMX instructions.
2363 # Include the current process ID in the file names to prevent conflicts
2364 # with invocations for multiple testsuites.
2365 set src [standard_temp_file vmx[pid].c]
2366 set exe [standard_temp_file vmx[pid].x]
2368 gdb_produce_source $src {
2371 asm volatile ("vor v0,v0,v0");
2373 asm volatile ("vor 0,0,0");
2379 verbose "$me: compiling testfile $src" 2
2380 set lines [gdb_compile $src $exe executable $compile_flags]
2383 if ![string match "" $lines] then {
2384 verbose "$me: testfile compilation failed, returning 1" 2
2388 # No error message, compilation succeeded so now run it via gdb.
2392 gdb_reinitialize_dir $srcdir/$subdir
2396 -re ".*Illegal instruction.*${gdb_prompt} $" {
2397 verbose -log "\n$me altivec hardware not detected"
2398 set skip_vmx_tests 1
2400 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2401 verbose -log "\n$me: altivec hardware detected"
2402 set skip_vmx_tests 0
2405 warning "\n$me: default case taken"
2406 set skip_vmx_tests 1
2410 remote_file build delete $exe
2412 verbose "$me: returning $skip_vmx_tests" 2
2413 return $skip_vmx_tests
2416 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2417 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2419 gdb_caching_proc skip_vsx_tests {
2420 global srcdir subdir gdb_prompt inferior_exited_re
2422 set me "skip_vsx_tests"
2424 # Some simulators are known to not support Altivec instructions, so
2425 # they won't support VSX instructions as well.
2426 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2427 verbose "$me: target known to not support VSX, returning 1" 2
2431 # Make sure we have a compiler that understands altivec.
2432 set compile_flags {debug nowarnings quiet}
2433 if [get_compiler_info] {
2434 warning "Could not get compiler info"
2437 if [test_compiler_info gcc*] {
2438 set compile_flags "$compile_flags additional_flags=-mvsx"
2439 } elseif [test_compiler_info xlc*] {
2440 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2442 verbose "Could not compile with vsx support, returning 1" 2
2446 set src [standard_temp_file vsx[pid].c]
2447 set exe [standard_temp_file vsx[pid].x]
2449 gdb_produce_source $src {
2451 double a[2] = { 1.0, 2.0 };
2453 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2455 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2461 verbose "$me: compiling testfile $src" 2
2462 set lines [gdb_compile $src $exe executable $compile_flags]
2465 if ![string match "" $lines] then {
2466 verbose "$me: testfile compilation failed, returning 1" 2
2470 # No error message, compilation succeeded so now run it via gdb.
2474 gdb_reinitialize_dir $srcdir/$subdir
2478 -re ".*Illegal instruction.*${gdb_prompt} $" {
2479 verbose -log "\n$me VSX hardware not detected"
2480 set skip_vsx_tests 1
2482 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2483 verbose -log "\n$me: VSX hardware detected"
2484 set skip_vsx_tests 0
2487 warning "\n$me: default case taken"
2488 set skip_vsx_tests 1
2492 remote_file build delete $exe
2494 verbose "$me: returning $skip_vsx_tests" 2
2495 return $skip_vsx_tests
2498 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2499 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2501 gdb_caching_proc skip_btrace_tests {
2502 global srcdir subdir gdb_prompt inferior_exited_re
2504 set me "skip_btrace_tests"
2505 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2506 verbose "$me: target does not support btrace, returning 1" 2
2510 # Set up, compile, and execute a test program.
2511 # Include the current process ID in the file names to prevent conflicts
2512 # with invocations for multiple testsuites.
2513 set src [standard_temp_file btrace[pid].c]
2514 set exe [standard_temp_file btrace[pid].x]
2516 gdb_produce_source $src {
2517 int main(void) { return 0; }
2520 verbose "$me: compiling testfile $src" 2
2521 set compile_flags {debug nowarnings quiet}
2522 set lines [gdb_compile $src $exe executable $compile_flags]
2524 if ![string match "" $lines] then {
2525 verbose "$me: testfile compilation failed, returning 1" 2
2530 # No error message, compilation succeeded so now run it via gdb.
2534 gdb_reinitialize_dir $srcdir/$subdir
2541 # In case of an unexpected output, we return 2 as a fail value.
2542 set skip_btrace_tests 2
2543 gdb_test_multiple "record btrace" "check btrace support" {
2544 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2545 set skip_btrace_tests 1
2547 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2548 set skip_btrace_tests 1
2550 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2551 set skip_btrace_tests 1
2553 -re "^record btrace\r\n$gdb_prompt $" {
2554 set skip_btrace_tests 0
2558 remote_file build delete $exe
2560 verbose "$me: returning $skip_btrace_tests" 2
2561 return $skip_btrace_tests
2564 # Skip all the tests in the file if you are not on an hppa running
2567 proc skip_hp_tests {} {
2568 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
2569 verbose "Skip hp tests is $skip_hp"
2573 # Return whether we should skip tests for showing inlined functions in
2574 # backtraces. Requires get_compiler_info and get_debug_format.
2576 proc skip_inline_frame_tests {} {
2577 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2578 if { ! [test_debug_format "DWARF 2"] } {
2582 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2583 if { ([test_compiler_info "gcc-2-*"]
2584 || [test_compiler_info "gcc-3-*"]
2585 || [test_compiler_info "gcc-4-0-*"]) } {
2592 # Return whether we should skip tests for showing variables from
2593 # inlined functions. Requires get_compiler_info and get_debug_format.
2595 proc skip_inline_var_tests {} {
2596 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2597 if { ! [test_debug_format "DWARF 2"] } {
2604 # Return a 1 if we should skip tests that require hardware breakpoints
2606 proc skip_hw_breakpoint_tests {} {
2607 # Skip tests if requested by the board (note that no_hardware_watchpoints
2608 # disables both watchpoints and breakpoints)
2609 if { [target_info exists gdb,no_hardware_watchpoints]} {
2613 # These targets support hardware breakpoints natively
2614 if { [istarget "i?86-*-*"]
2615 || [istarget "x86_64-*-*"]
2616 || [istarget "ia64-*-*"]
2617 || [istarget "arm*-*-*"]
2618 || [istarget "aarch64*-*-*"]} {
2625 # Return a 1 if we should skip tests that require hardware watchpoints
2627 proc skip_hw_watchpoint_tests {} {
2628 # Skip tests if requested by the board
2629 if { [target_info exists gdb,no_hardware_watchpoints]} {
2633 # These targets support hardware watchpoints natively
2634 if { [istarget "i?86-*-*"]
2635 || [istarget "x86_64-*-*"]
2636 || [istarget "ia64-*-*"]
2637 || [istarget "arm*-*-*"]
2638 || [istarget "aarch64*-*-*"]
2639 || [istarget "powerpc*-*-linux*"]
2640 || [istarget "s390*-*-*"] } {
2647 # Return a 1 if we should skip tests that require *multiple* hardware
2648 # watchpoints to be active at the same time
2650 proc skip_hw_watchpoint_multi_tests {} {
2651 if { [skip_hw_watchpoint_tests] } {
2655 # These targets support just a single hardware watchpoint
2656 if { [istarget "arm*-*-*"]
2657 || [istarget "powerpc*-*-linux*"] } {
2664 # Return a 1 if we should skip tests that require read/access watchpoints
2666 proc skip_hw_watchpoint_access_tests {} {
2667 if { [skip_hw_watchpoint_tests] } {
2671 # These targets support just write watchpoints
2672 if { [istarget "s390*-*-*"] } {
2679 # Return 1 if we should skip tests that require the runtime unwinder
2680 # hook. This must be invoked while gdb is running, after shared
2681 # libraries have been loaded. This is needed because otherwise a
2682 # shared libgcc won't be visible.
2684 proc skip_unwinder_tests {} {
2688 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2689 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2691 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2694 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2698 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2699 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2702 -re "\r\n$gdb_prompt $" {
2709 # Return 0 if we should skip tests that require the libstdc++ stap
2710 # probes. This must be invoked while gdb is running, after shared
2711 # libraries have been loaded.
2713 proc skip_libstdcxx_probe_tests {} {
2717 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2718 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2721 -re "\r\n$gdb_prompt $" {
2727 # Return 1 if we should skip tests of the "compile" feature.
2728 # This must be invoked after the inferior has been started.
2730 proc skip_compile_feature_tests {} {
2734 gdb_test_multiple "compile code -- ;" "check for working compile command" {
2735 "Could not load libcc1.*\r\n$gdb_prompt $" {
2738 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
2741 -re "\r\n$gdb_prompt $" {
2747 # Check whether we're testing with the remote or extended-remote
2750 proc gdb_is_target_remote {} {
2753 set test "probe for target remote"
2754 gdb_test_multiple "maint print target-stack" $test {
2755 -re ".*emote serial target in gdb-specific protocol.*$gdb_prompt $" {
2759 -re "$gdb_prompt $" {
2766 # Return 1 if the current remote target is an instance of our GDBserver, 0
2767 # otherwise. Return -1 if there was an error and we can't tell.
2769 gdb_caching_proc target_is_gdbserver {
2773 set test "Probing for GDBserver"
2775 gdb_test_multiple "monitor help" $test {
2776 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
2779 -re "$gdb_prompt $" {
2784 if { $is_gdbserver == -1 } {
2785 verbose -log "Unable to tell whether we are using GDBserver or not."
2788 return $is_gdbserver
2791 set compiler_info "unknown"
2793 set hp_cc_compiler 0
2794 set hp_aCC_compiler 0
2796 # Figure out what compiler I am using.
2798 # ARG can be empty or "C++". If empty, "C" is assumed.
2800 # There are several ways to do this, with various problems.
2802 # [ gdb_compile -E $ifile -o $binfile.ci ]
2803 # source $binfile.ci
2805 # Single Unix Spec v3 says that "-E -o ..." together are not
2806 # specified. And in fact, the native compiler on hp-ux 11 (among
2807 # others) does not work with "-E -o ...". Most targets used to do
2808 # this, and it mostly worked, because it works with gcc.
2810 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2811 # source $binfile.ci
2813 # This avoids the problem with -E and -o together. This almost works
2814 # if the build machine is the same as the host machine, which is
2815 # usually true of the targets which are not gcc. But this code does
2816 # not figure which compiler to call, and it always ends up using the C
2817 # compiler. Not good for setting hp_aCC_compiler. Target
2818 # hppa*-*-hpux* used to do this.
2820 # [ gdb_compile -E $ifile > $binfile.ci ]
2821 # source $binfile.ci
2823 # dejagnu target_compile says that it supports output redirection,
2824 # but the code is completely different from the normal path and I
2825 # don't want to sweep the mines from that path. So I didn't even try
2828 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2831 # I actually do this for all targets now. gdb_compile runs the right
2832 # compiler, and TCL captures the output, and I eval the output.
2834 # Unfortunately, expect logs the output of the command as it goes by,
2835 # and dejagnu helpfully prints a second copy of it right afterwards.
2836 # So I turn off expect logging for a moment.
2838 # [ gdb_compile $ifile $ciexe_file executable $args ]
2839 # [ remote_exec $ciexe_file ]
2840 # [ source $ci_file.out ]
2842 # I could give up on -E and just do this.
2843 # I didn't get desperate enough to try this.
2845 # -- chastain 2004-01-06
2847 proc get_compiler_info {{arg ""}} {
2848 # For compiler.c and compiler.cc
2851 # I am going to play with the log to keep noise out.
2855 # These come from compiler.c or compiler.cc
2856 global compiler_info
2858 # Legacy global data symbols.
2860 global hp_cc_compiler
2861 global hp_aCC_compiler
2863 # Choose which file to preprocess.
2864 set ifile "${srcdir}/lib/compiler.c"
2865 if { $arg == "c++" } {
2866 set ifile "${srcdir}/lib/compiler.cc"
2869 # Run $ifile through the right preprocessor.
2870 # Toggle gdb.log to keep the compiler output out of the log.
2871 set saved_log [log_file -info]
2873 if [is_remote host] {
2874 # We have to use -E and -o together, despite the comments
2875 # above, because of how DejaGnu handles remote host testing.
2876 set ppout "$outdir/compiler.i"
2877 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
2878 set file [open $ppout r]
2879 set cppout [read $file]
2882 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
2884 eval log_file $saved_log
2888 foreach cppline [ split "$cppout" "\n" ] {
2889 if { [ regexp "^#" "$cppline" ] } {
2891 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2893 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2895 verbose "get_compiler_info: $cppline" 2
2899 verbose -log "get_compiler_info: $cppline"
2904 # Reset to unknown compiler if any diagnostics happened.
2906 set compiler_info "unknown"
2909 # Set the legacy symbols.
2911 set hp_cc_compiler 0
2912 set hp_aCC_compiler 0
2913 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2914 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2915 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2916 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2917 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2918 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2919 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2921 # Log what happened.
2922 verbose -log "get_compiler_info: $compiler_info"
2924 # Most compilers will evaluate comparisons and other boolean
2925 # operations to 0 or 1.
2926 uplevel \#0 { set true 1 }
2927 uplevel \#0 { set false 0 }
2929 # Use of aCC results in boolean results being displayed as
2931 if { $hp_aCC_compiler } {
2932 uplevel \#0 { set true true }
2933 uplevel \#0 { set false false }
2939 proc test_compiler_info { {compiler ""} } {
2940 global compiler_info
2942 # if no arg, return the compiler_info string
2944 if [string match "" $compiler] {
2945 if [info exists compiler_info] {
2946 return $compiler_info
2948 perror "No compiler info found."
2952 return [string match $compiler $compiler_info]
2955 proc current_target_name { } {
2957 if [info exists target_info(target,name)] {
2958 set answer $target_info(target,name)
2965 set gdb_wrapper_initialized 0
2966 set gdb_wrapper_target ""
2968 proc gdb_wrapper_init { args } {
2969 global gdb_wrapper_initialized
2970 global gdb_wrapper_file
2971 global gdb_wrapper_flags
2972 global gdb_wrapper_target
2974 if { $gdb_wrapper_initialized == 1 } { return; }
2976 if {[target_info exists needs_status_wrapper] && \
2977 [target_info needs_status_wrapper] != "0"} {
2978 set result [build_wrapper "testglue.o"]
2979 if { $result != "" } {
2980 set gdb_wrapper_file [lindex $result 0]
2981 set gdb_wrapper_flags [lindex $result 1]
2983 warning "Status wrapper failed to build."
2986 set gdb_wrapper_initialized 1
2987 set gdb_wrapper_target [current_target_name]
2990 # Some targets need to always link a special object in. Save its path here.
2991 global gdb_saved_set_unbuffered_mode_obj
2992 set gdb_saved_set_unbuffered_mode_obj ""
2994 proc gdb_compile {source dest type options} {
2995 global GDB_TESTCASE_OPTIONS
2996 global gdb_wrapper_file
2997 global gdb_wrapper_flags
2998 global gdb_wrapper_initialized
3001 global gdb_saved_set_unbuffered_mode_obj
3003 set outdir [file dirname $dest]
3005 # Add platform-specific options if a shared library was specified using
3006 # "shlib=librarypath" in OPTIONS.
3010 foreach opt $options {
3011 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3012 if [test_compiler_info "xlc-*"] {
3013 # IBM xlc compiler doesn't accept shared library named other
3014 # than .so: use "-Wl," to bypass this
3015 lappend source "-Wl,$shlib_name"
3016 } elseif { ([istarget "*-*-mingw*"]
3017 || [istarget *-*-cygwin*]
3018 || [istarget *-*-pe*])} {
3019 lappend source "${shlib_name}.a"
3021 lappend source $shlib_name
3023 if { $shlib_found == 0 } {
3025 if { ([istarget "*-*-mingw*"]
3026 || [istarget *-*-cygwin*]) } {
3027 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3030 } elseif { $opt == "shlib_load" } {
3033 lappend new_options $opt
3037 # We typically link to shared libraries using an absolute path, and
3038 # that's how they are found at runtime. If we are going to
3039 # dynamically load one by basename, we must specify rpath. If we
3040 # are using a remote host, DejaGNU will link to the shared library
3041 # using a relative path, so again we must specify an rpath.
3042 if { $shlib_load || ($shlib_found && [is_remote target]) } {
3043 if { ([istarget "*-*-mingw*"]
3044 || [istarget *-*-cygwin*]
3045 || [istarget *-*-pe*]
3046 || [istarget hppa*-*-hpux*])} {
3047 # Do not need anything.
3048 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3049 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3050 } elseif { [istarget arm*-*-symbianelf*] } {
3051 if { $shlib_load } {
3052 lappend new_options "libs=-ldl"
3055 if { $shlib_load } {
3056 lappend new_options "libs=-ldl"
3058 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3061 set options $new_options
3063 if [info exists GDB_TESTCASE_OPTIONS] {
3064 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3066 verbose "options are $options"
3067 verbose "source is $source $dest $type $options"
3069 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3071 if {[target_info exists needs_status_wrapper] && \
3072 [target_info needs_status_wrapper] != "0" && \
3073 [info exists gdb_wrapper_file]} {
3074 lappend options "libs=${gdb_wrapper_file}"
3075 lappend options "ldflags=${gdb_wrapper_flags}"
3078 # Replace the "nowarnings" option with the appropriate additional_flags
3079 # to disable compiler warnings.
3080 set nowarnings [lsearch -exact $options nowarnings]
3081 if {$nowarnings != -1} {
3082 if [target_info exists gdb,nowarnings_flag] {
3083 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3085 set flag "additional_flags=-w"
3087 set options [lreplace $options $nowarnings $nowarnings $flag]
3090 if { $type == "executable" } {
3091 if { ([istarget "*-*-mingw*"]
3092 || [istarget "*-*-*djgpp"]
3093 || [istarget "*-*-cygwin*"])} {
3094 # Force output to unbuffered mode, by linking in an object file
3095 # with a global contructor that calls setvbuf.
3097 # Compile the special object seperatelly for two reasons:
3098 # 1) Insulate it from $options.
3099 # 2) Avoid compiling it for every gdb_compile invocation,
3100 # which is time consuming, especially if we're remote
3103 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3104 verbose "compiling gdb_saved_set_unbuffered_obj"
3105 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3106 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3108 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3109 if { $result != "" } {
3112 if {[is_remote host]} {
3113 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3115 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3117 # Link a copy of the output object, because the
3118 # original may be automatically deleted.
3119 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3121 verbose "gdb_saved_set_unbuffered_obj already compiled"
3124 # Rely on the internal knowledge that the global ctors are ran in
3125 # reverse link order. In that case, we can use ldflags to
3126 # avoid copying the object file to the host multiple
3128 # This object can only be added if standard libraries are
3129 # used. Thus, we need to disable it if -nostdlib option is used
3130 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3131 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3136 set result [target_compile $source $dest $type $options]
3138 # Prune uninteresting compiler (and linker) output.
3139 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3141 regsub "\[\r\n\]*$" "$result" "" result
3142 regsub "^\[\r\n\]*" "$result" "" result
3144 if {[lsearch $options quiet] < 0} {
3145 # We shall update this on a per language basis, to avoid
3146 # changing the entire testsuite in one go.
3147 if {[lsearch $options f77] >= 0} {
3148 gdb_compile_test $source $result
3149 } elseif { $result != "" } {
3150 clone_output "gdb compile failed, $result"
3157 # This is just like gdb_compile, above, except that it tries compiling
3158 # against several different thread libraries, to see which one this
3160 proc gdb_compile_pthreads {source dest type options} {
3162 set why_msg "unrecognized error"
3163 foreach lib {-lpthreads -lpthread -lthread ""} {
3164 # This kind of wipes out whatever libs the caller may have
3165 # set. Or maybe theirs will override ours. How infelicitous.
3166 set options_with_lib [concat $options [list libs=$lib quiet]]
3167 set ccout [gdb_compile $source $dest $type $options_with_lib]
3168 switch -regexp -- $ccout {
3169 ".*no posix threads support.*" {
3170 set why_msg "missing threads include file"
3173 ".*cannot open -lpthread.*" {
3174 set why_msg "missing runtime threads library"
3176 ".*Can't find library for -lpthread.*" {
3177 set why_msg "missing runtime threads library"
3180 pass "successfully compiled posix threads test case"
3186 if {!$built_binfile} {
3187 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3192 # Build a shared library from SOURCES.
3194 proc gdb_compile_shlib {sources dest options} {
3195 set obj_options $options
3198 if { [lsearch -exact $options "c++"] >= 0 } {
3199 set info_options "c++"
3201 if [get_compiler_info ${info_options}] {
3205 switch -glob [test_compiler_info] {
3207 lappend obj_options "additional_flags=-qpic"
3210 if { !([istarget "*-*-cygwin*"]
3211 || [istarget "*-*-mingw*"]) } {
3212 lappend obj_options "additional_flags=-fpic"
3216 if { !([istarget "powerpc*-*-aix*"]
3217 || [istarget "rs6000*-*-aix*"]
3218 || [istarget "*-*-cygwin*"]
3219 || [istarget "*-*-mingw*"]
3220 || [istarget "*-*-pe*"]) } {
3221 lappend obj_options "additional_flags=-fpic"
3225 switch -glob [istarget] {
3227 lappend obj_options "additional_flags=+z"
3230 # don't know what the compiler is...
3236 set outdir [file dirname $dest]
3238 foreach source $sources {
3239 set sourcebase [file tail $source]
3240 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3243 lappend objects ${outdir}/${sourcebase}.o
3246 if [istarget "hppa*-*-hpux*"] {
3247 remote_exec build "ld -b ${objects} -o ${dest}"
3249 set link_options $options
3250 if [test_compiler_info "xlc-*"] {
3251 lappend link_options "additional_flags=-qmkshrobj"
3253 lappend link_options "additional_flags=-shared"
3255 if { ([istarget "*-*-mingw*"]
3256 || [istarget *-*-cygwin*]
3257 || [istarget *-*-pe*]) } {
3258 if { [is_remote host] } {
3259 set name [file tail ${dest}]
3263 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3264 } elseif [is_remote target] {
3265 # By default, we do not set the soname. This causes the linker
3266 # on ELF systems to create a DT_NEEDED entry in the executable
3267 # refering to the full path name of the library. This is a
3268 # problem in remote testing if the library is in a different
3269 # directory there. To fix this, we set a soname of just the
3270 # base filename for the library, and add an appropriate -rpath
3271 # to the main executable (in gdb_compile).
3272 set destbase [file tail $dest]
3273 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3276 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3279 if { [is_remote host]
3280 && ([istarget "*-*-mingw*"]
3281 || [istarget *-*-cygwin*]
3282 || [istarget *-*-pe*]) } {
3283 set dest_tail_name [file tail ${dest}]
3284 remote_upload host $dest_tail_name.a ${dest}.a
3285 remote_file host delete $dest_tail_name.a
3291 # This is just like gdb_compile_shlib, above, except that it tries compiling
3292 # against several different thread libraries, to see which one this
3294 proc gdb_compile_shlib_pthreads {sources dest options} {
3296 set why_msg "unrecognized error"
3297 foreach lib {-lpthreads -lpthread -lthread ""} {
3298 # This kind of wipes out whatever libs the caller may have
3299 # set. Or maybe theirs will override ours. How infelicitous.
3300 set options_with_lib [concat $options [list libs=$lib quiet]]
3301 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3302 switch -regexp -- $ccout {
3303 ".*no posix threads support.*" {
3304 set why_msg "missing threads include file"
3307 ".*cannot open -lpthread.*" {
3308 set why_msg "missing runtime threads library"
3310 ".*Can't find library for -lpthread.*" {
3311 set why_msg "missing runtime threads library"
3314 pass "successfully compiled posix threads test case"
3320 if {!$built_binfile} {
3321 unsupported "Couldn't compile $sources: ${why_msg}"
3326 # This is just like gdb_compile_pthreads, above, except that we always add the
3327 # objc library for compiling Objective-C programs
3328 proc gdb_compile_objc {source dest type options} {
3330 set why_msg "unrecognized error"
3331 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3332 # This kind of wipes out whatever libs the caller may have
3333 # set. Or maybe theirs will override ours. How infelicitous.
3334 if { $lib == "solaris" } {
3335 set lib "-lpthread -lposix4"
3337 if { $lib != "-lobjc" } {
3338 set lib "-lobjc $lib"
3340 set options_with_lib [concat $options [list libs=$lib quiet]]
3341 set ccout [gdb_compile $source $dest $type $options_with_lib]
3342 switch -regexp -- $ccout {
3343 ".*no posix threads support.*" {
3344 set why_msg "missing threads include file"
3347 ".*cannot open -lpthread.*" {
3348 set why_msg "missing runtime threads library"
3350 ".*Can't find library for -lpthread.*" {
3351 set why_msg "missing runtime threads library"
3354 pass "successfully compiled objc with posix threads test case"
3360 if {!$built_binfile} {
3361 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3366 proc send_gdb { string } {
3367 global suppress_flag
3368 if { $suppress_flag } {
3371 return [remote_send host "$string"]
3374 # Send STRING to the inferior's terminal.
3376 proc send_inferior { string } {
3377 global inferior_spawn_id
3379 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3389 proc gdb_expect { args } {
3390 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3391 set atimeout [lindex $args 0]
3392 set expcode [list [lindex $args 1]]
3397 # A timeout argument takes precedence, otherwise of all the timeouts
3398 # select the largest.
3399 if [info exists atimeout] {
3402 set tmt [get_largest_timeout]
3405 global suppress_flag
3406 global remote_suppress_flag
3407 if [info exists remote_suppress_flag] {
3408 set old_val $remote_suppress_flag
3410 if [info exists suppress_flag] {
3411 if { $suppress_flag } {
3412 set remote_suppress_flag 1
3416 {uplevel remote_expect host $tmt $expcode} string]
3417 if [info exists old_val] {
3418 set remote_suppress_flag $old_val
3420 if [info exists remote_suppress_flag] {
3421 unset remote_suppress_flag
3426 global errorInfo errorCode
3428 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3430 return -code $code $string
3434 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3436 # Check for long sequence of output by parts.
3437 # TEST: is the test message to be printed with the test success/fail.
3438 # SENTINEL: Is the terminal pattern indicating that output has finished.
3439 # LIST: is the sequence of outputs to match.
3440 # If the sentinel is recognized early, it is considered an error.
3443 # 1 if the test failed,
3444 # 0 if the test passes,
3445 # -1 if there was an internal error.
3447 proc gdb_expect_list {test sentinel list} {
3449 global suppress_flag
3452 if { $suppress_flag } {
3454 unresolved "${test}"
3456 while { ${index} < [llength ${list}] } {
3457 set pattern [lindex ${list} ${index}]
3458 set index [expr ${index} + 1]
3459 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3460 if { ${index} == [llength ${list}] } {
3463 -re "${pattern}${sentinel}" {
3464 # pass "${test}, pattern ${index} + sentinel"
3467 fail "${test} (pattern ${index} + sentinel)"
3470 -re ".*A problem internal to GDB has been detected" {
3471 fail "${test} (GDB internal error)"
3473 gdb_internal_error_resync
3476 fail "${test} (pattern ${index} + sentinel) (timeout)"
3481 # unresolved "${test}, pattern ${index} + sentinel"
3487 # pass "${test}, pattern ${index}"
3490 fail "${test} (pattern ${index})"
3493 -re ".*A problem internal to GDB has been detected" {
3494 fail "${test} (GDB internal error)"
3496 gdb_internal_error_resync
3499 fail "${test} (pattern ${index}) (timeout)"
3504 # unresolved "${test}, pattern ${index}"
3518 proc gdb_suppress_entire_file { reason } {
3519 global suppress_flag
3522 set suppress_flag -1
3526 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3527 # gdb_expect to fail immediately (until the next call to
3528 # gdb_stop_suppressing_tests).
3530 proc gdb_suppress_tests { args } {
3531 global suppress_flag
3533 return; # fnf - disable pending review of results where
3534 # testsuite ran better without this
3537 if { $suppress_flag == 1 } {
3538 if { [llength $args] > 0 } {
3539 warning "[lindex $args 0]\n"
3541 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3547 # Clear suppress_flag.
3549 proc gdb_stop_suppressing_tests { } {
3550 global suppress_flag
3552 if [info exists suppress_flag] {
3553 if { $suppress_flag > 0 } {
3555 clone_output "Tests restarted.\n"
3562 proc gdb_clear_suppressed { } {
3563 global suppress_flag
3568 # Spawn the gdb process.
3570 # This doesn't expect any output or do any other initialization,
3571 # leaving those to the caller.
3573 # Overridable function -- you can override this function in your
3576 proc gdb_spawn { } {
3580 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3582 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3585 set saved_gdbflags $GDBFLAGS
3587 if {$GDBFLAGS != ""} {
3590 append GDBFLAGS $cmdline_flags
3594 set GDBFLAGS $saved_gdbflags
3599 # Start gdb running, wait for prompt, and disable the pagers.
3601 # Overridable function -- you can override this function in your
3604 proc gdb_start { } {
3609 catch default_gdb_exit
3612 # Return true if we can spawn a program on the target and attach to
3615 proc can_spawn_for_attach { } {
3616 # We use TCL's exec to get the inferior's pid.
3617 if [is_remote target] then {
3621 # The "attach" command doesn't make sense when the target is
3622 # stub-like, where GDB finds the program already started on
3623 # initial connection.
3624 if {[target_info exists use_gdb_stub]} {
3632 # Start a set of programs running and then wait for a bit, to be sure
3633 # that they can be attached to. Return a list of the processes' PIDs.
3634 # It's a test error to call this when [can_spawn_for_attach] is false.
3636 proc spawn_wait_for_attach { executable_list } {
3639 if ![can_spawn_for_attach] {
3640 # The caller should have checked can_spawn_for_attach itself
3641 # before getting here.
3642 error "can't spawn for attach with this target/board"
3645 foreach {executable} $executable_list {
3646 lappend pid_list [eval exec $executable &]
3651 if { [istarget "*-*-cygwin*"] } {
3652 for {set i 0} {$i < [llength $pid_list]} {incr i} {
3653 # testpid is the Cygwin PID, GDB uses the Windows PID,
3654 # which might be different due to the way fork/exec works.
3655 set testpid [lindex $pid_list $i]
3656 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
3657 set pid_list [lreplace $pid_list $i $i $testpid]
3665 # gdb_load_cmd -- load a file into the debugger.
3666 # ARGS - additional args to load command.
3667 # return a -1 if anything goes wrong.
3669 proc gdb_load_cmd { args } {
3672 if [target_info exists gdb_load_timeout] {
3673 set loadtimeout [target_info gdb_load_timeout]
3675 set loadtimeout 1600
3677 send_gdb "load $args\n"
3678 verbose "Timeout is now $loadtimeout seconds" 2
3679 gdb_expect $loadtimeout {
3680 -re "Loading section\[^\r\]*\r\n" {
3683 -re "Start address\[\r\]*\r\n" {
3686 -re "Transfer rate\[\r\]*\r\n" {
3689 -re "Memory access error\[^\r\]*\r\n" {
3690 perror "Failed to load program"
3693 -re "$gdb_prompt $" {
3696 -re "(.*)\r\n$gdb_prompt " {
3697 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3701 perror "Timed out trying to load $args."
3708 # Invoke "gcore". CORE is the name of the core file to write. TEST
3709 # is the name of the test case. This will return 1 if the core file
3710 # was created, 0 otherwise. If this fails to make a core file because
3711 # this configuration of gdb does not support making core files, it
3712 # will call "unsupported", not "fail". However, if this fails to make
3713 # a core file for some other reason, then it will call "fail".
3715 proc gdb_gcore_cmd {core test} {
3719 gdb_test_multiple "gcore $core" $test {
3720 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3724 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
3732 # Load core file CORE. TEST is the name of the test case.
3733 # This will record a pass/fail for loading the core file.
3735 # 1 - core file is successfully loaded
3736 # 0 - core file loaded but has a non fatal error
3737 # -1 - core file failed to load
3739 proc gdb_core_cmd { core test } {
3742 gdb_test_multiple "core $core" "$test" {
3743 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
3746 -re " is not a core dump:.*\r\n$gdb_prompt $" {
3747 fail "$test (bad file format)"
3750 -re ": No such file or directory.*\r\n$gdb_prompt $" {
3751 fail "$test (file not found)"
3754 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
3755 fail "$test (incomplete note section)"
3758 -re "Core was generated by .*\r\n$gdb_prompt $" {
3762 -re ".*$gdb_prompt $" {
3767 fail "$test (timeout)"
3771 fail "unsupported output from 'core' command"
3775 # Return the filename to download to the target and load on the target
3776 # for this shared library. Normally just LIBNAME, unless shared libraries
3777 # for this target have separate link and load images.
3779 proc shlib_target_file { libname } {
3783 # Return the filename GDB will load symbols from when debugging this
3784 # shared library. Normally just LIBNAME, unless shared libraries for
3785 # this target have separate link and load images.
3787 proc shlib_symbol_file { libname } {
3791 # Return the filename to download to the target and load for this
3792 # executable. Normally just BINFILE unless it is renamed to something
3793 # else for this target.
3795 proc exec_target_file { binfile } {
3799 # Return the filename GDB will load symbols from when debugging this
3800 # executable. Normally just BINFILE unless executables for this target
3801 # have separate files for symbols.
3803 proc exec_symbol_file { binfile } {
3807 # Rename the executable file. Normally this is just BINFILE1 being renamed
3808 # to BINFILE2, but some targets require multiple binary files.
3809 proc gdb_rename_execfile { binfile1 binfile2 } {
3810 file rename -force [exec_target_file ${binfile1}] \
3811 [exec_target_file ${binfile2}]
3812 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
3813 file rename -force [exec_symbol_file ${binfile1}] \
3814 [exec_symbol_file ${binfile2}]
3818 # "Touch" the executable file to update the date. Normally this is just
3819 # BINFILE, but some targets require multiple files.
3820 proc gdb_touch_execfile { binfile } {
3821 set time [clock seconds]
3822 file mtime [exec_target_file ${binfile}] $time
3823 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
3824 file mtime [exec_symbol_file ${binfile}] $time
3828 # Like remote_download but provides a gdb-specific behavior. If DEST
3829 # is "host", and the host is not remote, and TOFILE is not specified,
3830 # then the [file tail] of FROMFILE is passed through
3831 # standard_output_file to compute the destination.
3833 proc gdb_remote_download {dest fromfile {tofile {}}} {
3834 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
3835 set tofile [standard_output_file [file tail $fromfile]]
3838 if { $tofile == "" } {
3839 return [remote_download $dest $fromfile]
3841 return [remote_download $dest $fromfile $tofile]
3847 # Copy a file to the remote target and return its target filename.
3848 # Schedule the file to be deleted at the end of this test.
3850 proc gdb_download { filename } {
3853 set destname [remote_download target $filename]
3854 lappend cleanfiles $destname
3858 # gdb_load_shlibs LIB...
3860 # Copy the listed libraries to the target.
3862 proc gdb_load_shlibs { args } {
3863 if {![is_remote target]} {
3867 foreach file $args {
3868 gdb_download [shlib_target_file $file]
3871 # Even if the target supplies full paths for shared libraries,
3872 # they may not be paths for this system.
3873 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3877 # gdb_load -- load a file into the debugger. Specifying no file
3878 # defaults to the executable currently being debugged.
3879 # The return value is 0 for success, -1 for failure.
3880 # Many files in config/*.exp override this procedure.
3882 proc gdb_load { arg } {
3884 return [gdb_file_cmd $arg]
3889 # gdb_reload -- load a file into the target. Called before "running",
3890 # either the first time or after already starting the program once,
3891 # for remote targets. Most files that override gdb_load should now
3892 # override this instead.
3894 proc gdb_reload { } {
3895 # For the benefit of existing configurations, default to gdb_load.
3896 # Specifying no file defaults to the executable currently being
3898 return [gdb_load ""]
3901 proc gdb_continue { function } {
3904 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
3907 proc default_gdb_init { test_file_name } {
3908 global gdb_wrapper_initialized
3909 global gdb_wrapper_target
3910 global gdb_test_file_name
3916 gdb_clear_suppressed
3918 set gdb_test_file_name [file rootname [file tail $test_file_name]]
3920 # Make sure that the wrapper is rebuilt
3921 # with the appropriate multilib option.
3922 if { $gdb_wrapper_target != [current_target_name] } {
3923 set gdb_wrapper_initialized 0
3926 # Unlike most tests, we have a small number of tests that generate
3927 # a very large amount of output. We therefore increase the expect
3928 # buffer size to be able to contain the entire test output. This
3929 # is especially needed by gdb.base/info-macros.exp.
3931 # Also set this value for the currently running GDB.
3932 match_max [match_max -d]
3934 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
3935 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
3938 if [target_info exists gdb_prompt] {
3939 set gdb_prompt [target_info gdb_prompt]
3941 set gdb_prompt "\\(gdb\\)"
3944 if [info exists use_gdb_stub] {
3949 # Turn BASENAME into a full file name in the standard output
3950 # directory. It is ok if BASENAME is the empty string; in this case
3951 # the directory is returned.
3953 proc standard_output_file {basename} {
3954 global objdir subdir gdb_test_file_name GDB_PARALLEL
3956 if {[info exists GDB_PARALLEL]} {
3957 set dir [file join $objdir outputs $subdir $gdb_test_file_name]
3959 return [file join $dir $basename]
3961 return [file join $objdir $subdir $basename]
3965 # Return the name of a file in our standard temporary directory.
3967 proc standard_temp_file {basename} {
3968 global objdir GDB_PARALLEL
3970 if {[info exists GDB_PARALLEL]} {
3971 return [file join $objdir temp $basename]
3977 # Set 'testfile', 'srcfile', and 'binfile'.
3979 # ARGS is a list of source file specifications.
3980 # Without any arguments, the .exp file's base name is used to
3981 # compute the source file name. The ".c" extension is added in this case.
3982 # If ARGS is not empty, each entry is a source file specification.
3983 # If the specification starts with a ".", it is treated as a suffix
3984 # to append to the .exp file's base name.
3985 # If the specification is the empty string, it is treated as if it
3987 # Otherwise it is a file name.
3988 # The first file in the list is used to set the 'srcfile' global.
3989 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3991 # Most tests should call this without arguments.
3993 # If a completely different binary file name is needed, then it
3994 # should be handled in the .exp file with a suitable comment.
3996 proc standard_testfile {args} {
3997 global gdb_test_file_name
3999 global gdb_test_file_last_vars
4002 global testfile binfile
4004 set testfile $gdb_test_file_name
4005 set binfile [standard_output_file ${testfile}]
4007 if {[llength $args] == 0} {
4011 # Unset our previous output variables.
4012 # This can help catch hidden bugs.
4013 if {[info exists gdb_test_file_last_vars]} {
4014 foreach varname $gdb_test_file_last_vars {
4016 catch {unset $varname}
4019 # 'executable' is often set by tests.
4020 set gdb_test_file_last_vars {executable}
4024 set varname srcfile$suffix
4027 # Handle an extension.
4030 } elseif {[string range $arg 0 0] == "."} {
4031 set arg $testfile$arg
4035 lappend gdb_test_file_last_vars $varname
4037 if {$suffix == ""} {
4045 # The default timeout used when testing GDB commands. We want to use
4046 # the same timeout as the default dejagnu timeout, unless the user has
4047 # already provided a specific value (probably through a site.exp file).
4048 global gdb_test_timeout
4049 if ![info exists gdb_test_timeout] {
4050 set gdb_test_timeout $timeout
4053 # A list of global variables that GDB testcases should not use.
4054 # We try to prevent their use by monitoring write accesses and raising
4055 # an error when that happens.
4056 set banned_variables { bug_id prms_id }
4058 # A list of procedures that GDB testcases should not use.
4059 # We try to prevent their use by monitoring invocations and raising
4060 # an error when that happens.
4061 set banned_procedures { strace }
4063 # gdb_init is called by runtest at start, but also by several
4064 # tests directly; gdb_finish is only called from within runtest after
4065 # each test source execution.
4066 # Placing several traces by repetitive calls to gdb_init leads
4067 # to problems, as only one trace is removed in gdb_finish.
4068 # To overcome this possible problem, we add a variable that records
4069 # if the banned variables and procedures are already traced.
4072 proc gdb_init { test_file_name } {
4073 # Reset the timeout value to the default. This way, any testcase
4074 # that changes the timeout value without resetting it cannot affect
4075 # the timeout used in subsequent testcases.
4076 global gdb_test_timeout
4078 set timeout $gdb_test_timeout
4080 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4081 && [target_info exists gdb_reverse_timeout] } {
4082 set timeout [target_info gdb_reverse_timeout]
4085 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4086 # debugging tool to help confirm that the test suite is
4087 # parallel-safe. You need "inotifywait" from the
4088 # inotify-tools package to use this.
4089 global GDB_INOTIFY inotify_pid
4090 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4091 global outdir tool inotify_log_file
4093 set exclusions {outputs temp gdb[.](log|sum) cache}
4094 set exclusion_re ([join $exclusions |])
4096 set inotify_log_file [standard_temp_file inotify.out]
4097 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4098 --exclude $exclusion_re \
4099 |& tee -a $outdir/$tool.log $inotify_log_file &]
4101 # Wait for the watches; hopefully this is long enough.
4104 # Clear the log so that we don't emit a warning the first time
4106 set fd [open $inotify_log_file w]
4110 # Block writes to all banned variables, and invocation of all
4111 # banned procedures...
4112 global banned_variables
4113 global banned_procedures
4114 global banned_traced
4115 if (!$banned_traced) {
4116 foreach banned_var $banned_variables {
4117 global "$banned_var"
4118 trace add variable "$banned_var" write error
4120 foreach banned_proc $banned_procedures {
4121 global "$banned_proc"
4122 trace add execution "$banned_proc" enter error
4127 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4128 # messages as expected.
4133 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4134 # the test results. Even if /dev/null doesn't exist on the particular
4135 # platform, the readline library will use the default setting just by
4136 # failing to open the file. OTOH, opening /dev/null successfully will
4137 # also result in the default settings being used since nothing will be
4138 # read from this file.
4139 setenv INPUTRC "/dev/null"
4141 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4142 # bindings, so make sure that an appropriate terminal is selected.
4143 # The same bug doesn't show up if we use ^P / ^N instead.
4146 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4147 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4148 # especially having color output turned on can cause tests to fail.
4149 setenv GREP_OPTIONS ""
4151 # Clear $gdbserver_reconnect_p.
4152 global gdbserver_reconnect_p
4153 set gdbserver_reconnect_p 1
4154 unset gdbserver_reconnect_p
4156 return [default_gdb_init $test_file_name]
4159 proc gdb_finish { } {
4160 global gdbserver_reconnect_p
4164 # Exit first, so that the files are no longer in use.
4167 if { [llength $cleanfiles] > 0 } {
4168 eval remote_file target delete $cleanfiles
4172 # Unblock write access to the banned variables. Dejagnu typically
4173 # resets some of them between testcases.
4174 global banned_variables
4175 global banned_procedures
4176 global banned_traced
4177 if ($banned_traced) {
4178 foreach banned_var $banned_variables {
4179 global "$banned_var"
4180 trace remove variable "$banned_var" write error
4182 foreach banned_proc $banned_procedures {
4183 global "$banned_proc"
4184 trace remove execution "$banned_proc" enter error
4191 set debug_format "unknown"
4193 # Run the gdb command "info source" and extract the debugging format
4194 # information from the output and save it in debug_format.
4196 proc get_debug_format { } {
4202 set debug_format "unknown"
4203 send_gdb "info source\n"
4205 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4206 set debug_format $expect_out(1,string)
4207 verbose "debug format is $debug_format"
4210 -re "No current source file.\r\n$gdb_prompt $" {
4211 perror "get_debug_format used when no current source file"
4214 -re "$gdb_prompt $" {
4215 warning "couldn't check debug format (no valid response)."
4219 warning "couldn't check debug format (timeout)."
4225 # Return true if FORMAT matches the debug format the current test was
4226 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4227 # `*', `[...]', and so on.
4229 # This function depends on variables set by `get_debug_format', above.
4231 proc test_debug_format {format} {
4234 return [expr [string match $format $debug_format] != 0]
4237 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4238 # COFF, stabs, etc). If that format matches the format that the
4239 # current test was compiled with, then the next test is expected to
4240 # fail for any target. Returns 1 if the next test or set of tests is
4241 # expected to fail, 0 otherwise (or if it is unknown). Must have
4242 # previously called get_debug_format.
4243 proc setup_xfail_format { format } {
4244 set ret [test_debug_format $format]
4252 # gdb_get_line_number TEXT [FILE]
4254 # Search the source file FILE, and return the line number of the
4255 # first line containing TEXT. If no match is found, an error is thrown.
4257 # TEXT is a string literal, not a regular expression.
4259 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4260 # specified, and does not start with "/", then it is assumed to be in
4261 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4262 # by changing the callers and the interface at the same time.
4263 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4264 # gdb.base/ena-dis-br.exp.
4266 # Use this function to keep your test scripts independent of the
4267 # exact line numbering of the source file. Don't write:
4269 # send_gdb "break 20"
4271 # This means that if anyone ever edits your test's source file,
4272 # your test could break. Instead, put a comment like this on the
4273 # source file line you want to break at:
4275 # /* breakpoint spot: frotz.exp: test name */
4277 # and then write, in your test script (which we assume is named
4280 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4282 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4285 # % puts "foo [lindex "bar baz" 1]"
4288 # Tcl is quite clever, for a little stringy language.)
4292 # The previous implementation of this procedure used the gdb search command.
4293 # This version is different:
4295 # . It works with MI, and it also works when gdb is not running.
4297 # . It operates on the build machine, not the host machine.
4299 # . For now, this implementation fakes a current directory of
4300 # $srcdir/$subdir to be compatible with the old implementation.
4301 # This will go away eventually and some callers will need to
4304 # . The TEXT argument is literal text and matches literally,
4305 # not a regular expression as it was before.
4307 # . State changes in gdb, such as changing the current file
4308 # and setting $_, no longer happen.
4310 # After a bit of time we can forget about the differences from the
4311 # old implementation.
4313 # --chastain 2004-08-05
4315 proc gdb_get_line_number { text { file "" } } {
4320 if { "$file" == "" } then {
4323 if { ! [regexp "^/" "$file"] } then {
4324 set file "$srcdir/$subdir/$file"
4327 if { [ catch { set fd [open "$file"] } message ] } then {
4332 for { set line 1 } { 1 } { incr line } {
4333 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4336 if { $nchar < 0 } then {
4339 if { [string first "$text" "$body"] >= 0 } then {
4345 if { [ catch { close "$fd" } message ] } then {
4350 error "undefined tag \"$text\""
4356 # Continue the program until it ends.
4358 # MSSG is the error message that gets printed. If not given, a
4360 # COMMAND is the command to invoke. If not given, "continue" is
4362 # ALLOW_EXTRA is a flag indicating whether the test should expect
4363 # extra output between the "Continuing." line and the program
4364 # exiting. By default it is zero; if nonzero, any extra output
4367 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4368 global inferior_exited_re use_gdb_stub
4371 set text "continue until exit"
4373 set text "continue until exit at $mssg"
4381 # By default, we don't rely on exit() behavior of remote stubs --
4382 # it's common for exit() to be implemented as a simple infinite
4383 # loop, or a forced crash/reset. For native targets, by default, we
4384 # assume process exit is reported as such. If a non-reliable target
4385 # is used, we set a breakpoint at exit, and continue to that.
4386 if { [target_info exists exit_is_reliable] } {
4387 set exit_is_reliable [target_info exit_is_reliable]
4389 set exit_is_reliable [expr ! $use_gdb_stub]
4392 if { ! $exit_is_reliable } {
4393 if {![gdb_breakpoint "exit"]} {
4396 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4399 # Continue until we exit. Should not stop again.
4400 # Don't bother to check the output of the program, that may be
4401 # extremely tough for some remote systems.
4403 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4408 proc rerun_to_main {} {
4409 global gdb_prompt use_gdb_stub
4414 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4415 {pass "rerun to main" ; return 0}
4416 -re "$gdb_prompt $"\
4417 {fail "rerun to main" ; return 0}
4418 timeout {fail "(timeout) rerun to main" ; return 0}
4423 -re "The program .* has been started already.*y or n. $" {
4427 -re "Starting program.*$gdb_prompt $"\
4428 {pass "rerun to main" ; return 0}
4429 -re "$gdb_prompt $"\
4430 {fail "rerun to main" ; return 0}
4431 timeout {fail "(timeout) rerun to main" ; return 0}
4436 # Print a message and return true if a test should be skipped
4437 # due to lack of floating point suport.
4439 proc gdb_skip_float_test { msg } {
4440 if [target_info exists gdb,skip_float_tests] {
4441 verbose "Skipping test '$msg': no float tests."
4447 # Print a message and return true if a test should be skipped
4448 # due to lack of stdio support.
4450 proc gdb_skip_stdio_test { msg } {
4451 if [target_info exists gdb,noinferiorio] {
4452 verbose "Skipping test '$msg': no inferior i/o."
4458 proc gdb_skip_bogus_test { msg } {
4462 # Return true if a test should be skipped due to lack of XML support
4464 # NOTE: This must be called while gdb is *not* running.
4466 gdb_caching_proc gdb_skip_xml_test {
4470 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4474 gdb_test_multiple "set tdesc filename $xml_file" "" {
4475 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4478 -re ".*$gdb_prompt $" { }
4484 # Return true if argv[0] is available.
4486 gdb_caching_proc gdb_has_argv0 {
4489 # Set up, compile, and execute a test program to check whether
4490 # argv[0] is available.
4491 set src [standard_temp_file has_argv0[pid].c]
4492 set exe [standard_temp_file has_argv0[pid].x]
4494 gdb_produce_source $src {
4495 int main (int argc, char **argv) {
4500 gdb_compile $src $exe executable {debug}
4503 proc gdb_has_argv0_1 { exe } {
4504 global srcdir subdir
4505 global gdb_prompt hex
4509 gdb_reinitialize_dir $srcdir/$subdir
4512 # Set breakpoint on main.
4513 gdb_test_multiple "break main" "break main" {
4514 -re "Breakpoint.*${gdb_prompt} $" {
4516 -re "${gdb_prompt} $" {
4523 gdb_test_multiple "" "run to main" {
4524 -re "Breakpoint.*${gdb_prompt} $" {
4526 -re "${gdb_prompt} $" {
4531 # Check whether argc is 1.
4532 gdb_test_multiple "p argc" "p argc" {
4533 -re " = 1\r\n${gdb_prompt} $" {
4535 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4536 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4539 -re "${gdb_prompt} $" {
4544 -re "${gdb_prompt} $" {
4551 set result [gdb_has_argv0_1 $exe]
4558 && ([istarget *-*-linux*]
4559 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4560 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4561 || [istarget *-*-openbsd*]
4562 || [istarget *-*-darwin*]
4563 || [istarget *-*-solaris*]
4564 || [istarget *-*-aix*]
4565 || [istarget *-*-gnu*]
4566 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
4567 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
4568 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
4569 || [istarget *-*-symbianelf*]
4570 || [istarget *-*-osf*]
4571 || [istarget *-*-hpux*]
4572 || [istarget *-*-dicos*]
4573 || [istarget *-*-nto*]
4574 || [istarget *-*-*vms*]
4575 || [istarget *-*-lynx*178]) } {
4576 fail "argv\[0\] should be available on this target"
4582 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
4583 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4584 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
4585 # the name of a debuginfo only file. This file will be stored in the same
4588 # Functions for separate debug info testing
4590 # starting with an executable:
4591 # foo --> original executable
4593 # at the end of the process we have:
4594 # foo.stripped --> foo w/o debug info
4595 # foo.debug --> foo's debug info
4596 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4598 # Fetch the build id from the file.
4599 # Returns "" if there is none.
4601 proc get_build_id { filename } {
4602 if { ([istarget "*-*-mingw*"]
4603 || [istarget *-*-cygwin*]) } {
4604 set objdump_program [gdb_find_objdump]
4605 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
4606 verbose "result is $result"
4607 verbose "output is $output"
4613 set tmp [standard_output_file "${filename}-tmp"]
4614 set objcopy_program [gdb_find_objcopy]
4615 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
4616 verbose "result is $result"
4617 verbose "output is $output"
4622 fconfigure $fi -translation binary
4623 # Skip the NOTE header.
4628 if ![string compare $data ""] then {
4631 # Convert it to hex.
4632 binary scan $data H* data
4637 # Return the build-id hex string (usually 160 bits as 40 hex characters)
4638 # converted to the form: .build-id/ab/cdef1234...89.debug
4639 # Return "" if no build-id found.
4640 proc build_id_debug_filename_get { filename } {
4641 set data [get_build_id $filename]
4642 if { $data == "" } {
4645 regsub {^..} $data {\0/} data
4646 return ".build-id/${data}.debug"
4649 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
4650 # list of optional flags. The only currently supported flag is no-main,
4651 # which removes the symbol entry for main from the separate debug file.
4653 # Function returns zero on success. Function will return non-zero failure code
4654 # on some targets not supporting separate debug info (such as i386-msdos).
4656 proc gdb_gnu_strip_debug { dest args } {
4658 # Use the first separate debug info file location searched by GDB so the
4659 # run cannot be broken by some stale file searched with higher precedence.
4660 set debug_file "${dest}.debug"
4662 set strip_to_file_program [transform strip]
4663 set objcopy_program [gdb_find_objcopy]
4665 set debug_link [file tail $debug_file]
4666 set stripped_file "${dest}.stripped"
4668 # Get rid of the debug info, and store result in stripped_file
4669 # something like gdb/testsuite/gdb.base/blah.stripped.
4670 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
4671 verbose "result is $result"
4672 verbose "output is $output"
4677 # Workaround PR binutils/10802:
4678 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4679 set perm [file attributes ${dest} -permissions]
4680 file attributes ${stripped_file} -permissions $perm
4682 # Get rid of everything but the debug info, and store result in debug_file
4683 # This will be in the .debug subdirectory, see above.
4684 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
4685 verbose "result is $result"
4686 verbose "output is $output"
4691 # If no-main is passed, strip the symbol for main from the separate
4692 # file. This is to simulate the behavior of elfutils's eu-strip, which
4693 # leaves the symtab in the original file only. There's no way to get
4694 # objcopy or strip to remove the symbol table without also removing the
4695 # debugging sections, so this is as close as we can get.
4696 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
4697 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
4698 verbose "result is $result"
4699 verbose "output is $output"
4703 file delete "${debug_file}"
4704 file rename "${debug_file}-tmp" "${debug_file}"
4707 # Link the two previous output files together, adding the .gnu_debuglink
4708 # section to the stripped_file, containing a pointer to the debug_file,
4709 # save the new file in dest.
4710 # This will be the regular executable filename, in the usual location.
4711 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
4712 verbose "result is $result"
4713 verbose "output is $output"
4718 # Workaround PR binutils/10802:
4719 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4720 set perm [file attributes ${stripped_file} -permissions]
4721 file attributes ${dest} -permissions $perm
4726 # Test the output of GDB_COMMAND matches the pattern obtained
4727 # by concatenating all elements of EXPECTED_LINES. This makes
4728 # it possible to split otherwise very long string into pieces.
4729 # If third argument is not empty, it's used as the name of the
4730 # test to be printed on pass/fail.
4731 proc help_test_raw { gdb_command expected_lines args } {
4732 set message $gdb_command
4733 if [llength $args]>0 then {
4734 set message [lindex $args 0]
4736 set expected_output [join $expected_lines ""]
4737 gdb_test "${gdb_command}" "${expected_output}" $message
4740 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
4741 # are regular expressions that should match the beginning of output,
4742 # before the list of commands in that class. The presence of
4743 # command list and standard epilogue will be tested automatically.
4744 # Notice that the '[' and ']' characters don't need to be escaped for strings
4745 # wrapped in {} braces.
4746 proc test_class_help { command_class expected_initial_lines args } {
4748 "List of commands\:.*[\r\n]+"
4749 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
4750 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
4751 "Command name abbreviations are allowed if unambiguous\."
4753 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4755 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
4758 # COMMAND_LIST should have either one element -- command to test, or
4759 # two elements -- abbreviated command to test, and full command the first
4760 # element is abbreviation of.
4761 # The command must be a prefix command. EXPECTED_INITIAL_LINES
4762 # are regular expressions that should match the beginning of output,
4763 # before the list of subcommands. The presence of
4764 # subcommand list and standard epilogue will be tested automatically.
4765 proc test_prefix_command_help { command_list expected_initial_lines args } {
4766 set command [lindex $command_list 0]
4767 if {[llength $command_list]>1} {
4768 set full_command [lindex $command_list 1]
4770 set full_command $command
4772 # Use 'list' and not just {} because we want variables to
4773 # be expanded in this list.
4774 set l_stock_body [list\
4775 "List of $full_command subcommands\:.*\[\r\n\]+"\
4776 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
4777 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
4778 "Command name abbreviations are allowed if unambiguous\."]
4779 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4780 if {[llength $args]>0} {
4781 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
4783 help_test_raw "help ${command}" $l_entire_body
4787 # Build executable named EXECUTABLE from specifications that allow
4788 # different options to be passed to different sub-compilations.
4789 # TESTNAME is the name of the test; this is passed to 'untested' if
4791 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
4792 # contains the option "pthreads", then gdb_compile_pthreads is used.
4793 # ARGS is a flat list of source specifications, of the form:
4794 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
4795 # Each SOURCE is compiled to an object file using its OPTIONS,
4796 # using gdb_compile.
4797 # Returns 0 on success, -1 on failure.
4798 proc build_executable_from_specs {testname executable options args} {
4802 set binfile [standard_output_file $executable]
4805 if { [lsearch -exact $options "c++"] >= 0 } {
4806 set info_options "c++"
4808 if [get_compiler_info ${info_options}] {
4812 set func gdb_compile
4813 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
4814 if {$func_index != -1} {
4815 set func "${func}_[lindex $options $func_index]"
4818 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
4819 # parameter. They also requires $sources while gdb_compile and
4820 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
4821 if [string match gdb_compile_shlib* $func] {
4823 foreach {s local_options} $args {
4824 if { [regexp "^/" "$s"] } then {
4825 lappend sources_path "$s"
4827 lappend sources_path "$srcdir/$subdir/$s"
4830 set ret [$func $sources_path "${binfile}" $options]
4834 foreach {s local_options} $args {
4835 if { ! [regexp "^/" "$s"] } then {
4836 set s "$srcdir/$subdir/$s"
4838 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
4842 lappend objects "${binfile}${i}.o"
4845 set ret [$func $objects "${binfile}" executable $options]
4855 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4856 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4857 # to pass to untested, if something is wrong. OPTIONS are passed
4858 # to gdb_compile directly.
4859 proc build_executable { testname executable {sources ""} {options {debug}} } {
4860 if {[llength $sources]==0} {
4861 set sources ${executable}.c
4864 set arglist [list $testname $executable $options]
4865 foreach source $sources {
4866 lappend arglist $source $options
4869 return [eval build_executable_from_specs $arglist]
4872 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
4873 # the basename of the binary.
4874 # The return value is 0 for success, -1 for failure.
4875 proc clean_restart { executable } {
4878 set binfile [standard_output_file ${executable}]
4882 gdb_reinitialize_dir $srcdir/$subdir
4883 return [gdb_load ${binfile}]
4886 # Prepares for testing by calling build_executable_full, then
4888 # TESTNAME is the name of the test.
4889 # Each element in ARGS is a list of the form
4890 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
4891 # These are passed to build_executable_from_specs, which see.
4892 # The last EXECUTABLE is passed to clean_restart.
4893 # Returns 0 on success, non-zero on failure.
4894 proc prepare_for_testing_full {testname args} {
4895 foreach spec $args {
4896 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4899 set executable [lindex $spec 0]
4901 clean_restart $executable
4905 # Prepares for testing, by calling build_executable, and then clean_restart.
4906 # Please refer to build_executable for parameter description.
4907 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4909 if {[build_executable $testname $executable $sources $options] == -1} {
4912 clean_restart $executable
4917 proc get_valueof { fmt exp default } {
4920 set test "get valueof \"${exp}\""
4922 gdb_test_multiple "print${fmt} ${exp}" "$test" {
4923 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4924 set val $expect_out(1,string)
4928 fail "$test (timeout)"
4934 proc get_integer_valueof { exp default } {
4937 set test "get integer valueof \"${exp}\""
4939 gdb_test_multiple "print /d ${exp}" "$test" {
4940 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4941 set val $expect_out(1,string)
4945 fail "$test (timeout)"
4951 proc get_hexadecimal_valueof { exp default } {
4953 send_gdb "print /x ${exp}\n"
4954 set test "get hexadecimal valueof \"${exp}\""
4956 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4957 set val $expect_out(1,string)
4962 fail "$test (timeout)"
4968 proc get_sizeof { type default } {
4969 return [get_integer_valueof "sizeof (${type})" $default]
4972 proc get_target_charset { } {
4975 gdb_test_multiple "show target-charset" "" {
4976 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
4977 return $expect_out(1,string)
4979 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
4980 return $expect_out(1,string)
4984 # Pick a reasonable default.
4985 warning "Unable to read target-charset."
4989 # Get the current value for remotetimeout and return it.
4990 proc get_remotetimeout { } {
4994 gdb_test_multiple "show remotetimeout" "" {
4995 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
4996 return $expect_out(1,string)
5000 # Pick the default that gdb uses
5001 warning "Unable to read remotetimeout"
5005 # Set the remotetimeout to the specified timeout. Nothing is returned.
5006 proc set_remotetimeout { timeout } {
5009 gdb_test_multiple "set remotetimeout $timeout" "" {
5010 -re "$gdb_prompt $" {
5011 verbose "Set remotetimeout to $timeout\n"
5016 # ROOT and FULL are file names. Returns the relative path from ROOT
5017 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5018 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5021 proc relative_filename {root full} {
5022 set root_split [file split $root]
5023 set full_split [file split $full]
5025 set len [llength $root_split]
5027 if {[eval file join $root_split]
5028 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5029 error "$full not a subdir of $root"
5032 return [eval file join [lrange $full_split $len end]]
5035 # Log gdb command line and script if requested.
5036 if {[info exists TRANSCRIPT]} {
5037 rename send_gdb real_send_gdb
5038 rename remote_spawn real_remote_spawn
5039 rename remote_close real_remote_close
5041 global gdb_transcript
5042 set gdb_transcript ""
5044 global gdb_trans_count
5045 set gdb_trans_count 1
5047 proc remote_spawn {args} {
5048 global gdb_transcript gdb_trans_count outdir
5050 if {$gdb_transcript != ""} {
5051 close $gdb_transcript
5053 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5054 puts $gdb_transcript [lindex $args 1]
5055 incr gdb_trans_count
5057 return [uplevel real_remote_spawn $args]
5060 proc remote_close {args} {
5061 global gdb_transcript
5063 if {$gdb_transcript != ""} {
5064 close $gdb_transcript
5065 set gdb_transcript ""
5068 return [uplevel real_remote_close $args]
5071 proc send_gdb {args} {
5072 global gdb_transcript
5074 if {$gdb_transcript != ""} {
5075 puts -nonewline $gdb_transcript [lindex $args 0]
5078 return [uplevel real_send_gdb $args]
5082 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5083 if {[info exists GDB_PARALLEL]} {
5084 if {[is_remote host]} {
5087 file mkdir outputs temp cache
5091 proc core_find {binfile {deletefiles {}} {arg ""}} {
5092 global objdir subdir
5094 set destcore "$binfile.core"
5095 file delete $destcore
5097 # Create a core file named "$destcore" rather than just "core", to
5098 # avoid problems with sys admin types that like to regularly prune all
5099 # files named "core" from the system.
5101 # Arbitrarily try setting the core size limit to "unlimited" since
5102 # this does not hurt on systems where the command does not work and
5103 # allows us to generate a core on systems where it does.
5105 # Some systems append "core" to the name of the program; others append
5106 # the name of the program to "core"; still others (like Linux, as of
5107 # May 2003) create cores named "core.PID". In the latter case, we
5108 # could have many core files lying around, and it may be difficult to
5109 # tell which one is ours, so let's run the program in a subdirectory.
5111 set coredir [standard_output_file coredir.[getpid]]
5113 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5114 # remote_exec host "${binfile}"
5115 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5116 if [remote_file build exists $i] {
5117 remote_exec build "mv $i $destcore"
5121 # Check for "core.PID".
5122 if { $found == 0 } {
5123 set names [glob -nocomplain -directory $coredir core.*]
5124 if {[llength $names] == 1} {
5125 set corefile [file join $coredir [lindex $names 0]]
5126 remote_exec build "mv $corefile $destcore"
5130 if { $found == 0 } {
5131 # The braindamaged HPUX shell quits after the ulimit -c above
5132 # without executing ${binfile}. So we try again without the
5133 # ulimit here if we didn't find a core file above.
5134 # Oh, I should mention that any "braindamaged" non-Unix system has
5135 # the same problem. I like the cd bit too, it's really neat'n stuff.
5136 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5137 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5138 if [remote_file build exists $i] {
5139 remote_exec build "mv $i $destcore"
5145 # Try to clean up after ourselves.
5146 foreach deletefile $deletefiles {
5147 remote_file build delete [file join $coredir $deletefile]
5149 remote_exec build "rmdir $coredir"
5151 if { $found == 0 } {
5152 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5158 # gdb_target_symbol_prefix_flags returns a string that can be added
5159 # to gdb_compile options to define SYMBOL_PREFIX macro value
5160 # symbol_prefix_flags returns a string that can be added
5161 # for targets that use underscore as symbol prefix.
5162 # TODO: find out automatically if the target needs this.
5164 proc gdb_target_symbol_prefix_flags {} {
5165 if { [istarget "i?86-*-cygwin*"] || [istarget "i?86-*-mingw*"]
5166 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
5167 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
5173 # A wrapper for 'remote_exec host' that passes or fails a test.
5174 # Returns 0 if all went well, nonzero on failure.
5175 # TEST is the name of the test, other arguments are as for remote_exec.
5177 proc run_on_host { test program args } {
5178 verbose -log "run_on_host: $program $args"
5179 # remote_exec doesn't work properly if the output is set but the
5180 # input is the empty string -- so replace an empty input with
5182 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5183 set args [lreplace $args 1 1 "/dev/null"]
5185 set result [eval remote_exec host [list $program] $args]
5186 verbose "result is $result"
5187 set status [lindex $result 0]
5188 set output [lindex $result 1]
5193 verbose -log "run_on_host failed: $output"
5199 # Return non-zero if "board_info debug_flags" mentions Fission.
5200 # http://gcc.gnu.org/wiki/DebugFission
5201 # Fission doesn't support everything yet.
5202 # This supports working around bug 15954.
5204 proc using_fission { } {
5205 set debug_flags [board_info [target_info name] debug_flags]
5206 return [regexp -- "-gsplit-dwarf" $debug_flags]
5209 # Search the caller's ARGS list and set variables according to the list of
5210 # valid options described by ARGSET.
5212 # The first member of each one- or two-element list in ARGSET defines the
5213 # name of a variable that will be added to the caller's scope.
5215 # If only one element is given to describe an option, it the value is
5216 # 0 if the option is not present in (the caller's) ARGS or 1 if
5219 # If two elements are given, the second element is the default value of
5220 # the variable. This is then overwritten if the option exists in ARGS.
5222 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5223 # any optional components.
5226 # proc myproc {foo args} {
5227 # parse_args {{bar} {baz "abc"} {qux}}
5230 # myproc ABC -bar -baz DEF peanut butter
5231 # will define the following variables in myproc:
5232 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5233 # args will be the list {peanut butter}
5235 proc parse_args { argset } {
5238 foreach argument $argset {
5239 if {[llength $argument] == 1} {
5240 # No default specified, so we assume that we should set
5241 # the value to 1 if the arg is present and 0 if it's not.
5242 # It is assumed that no value is given with the argument.
5243 set result [lsearch -exact $args "-$argument"]
5244 if {$result != -1} then {
5245 uplevel 1 [list set $argument 1]
5246 set args [lreplace $args $result $result]
5248 uplevel 1 [list set $argument 0]
5250 } elseif {[llength $argument] == 2} {
5251 # There are two items in the argument. The second is a
5252 # default value to use if the item is not present.
5253 # Otherwise, the variable is set to whatever is provided
5254 # after the item in the args.
5255 set arg [lindex $argument 0]
5256 set result [lsearch -exact $args "-[lindex $arg 0]"]
5257 if {$result != -1} then {
5258 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5259 set args [lreplace $args $result [expr $result+1]]
5261 uplevel 1 [list set $arg [lindex $argument 1]]
5264 error "Badly formatted argument \"$argument\" in argument set"
5268 # The remaining args should be checked to see that they match the
5269 # number of items expected to be passed into the procedure...
5272 # Capture the output of COMMAND in a string ignoring PREFIX; return that string.
5273 proc capture_command_output { command prefix } {
5277 set output_string ""
5278 gdb_test_multiple "$command" "capture_command_output for $command" {
5279 -re "${command}\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5280 set output_string $expect_out(1,string)
5283 return $output_string
5286 # A convenience function that joins all the arguments together, with a
5287 # regexp that matches exactly one end of line in between each argument.
5288 # This function is ideal to write the expected output of a GDB command
5289 # that generates more than a couple of lines, as this allows us to write
5290 # each line as a separate string, which is easier to read by a human
5293 proc multi_line { args } {
5294 return [join $args "\r\n"]
5297 # Always load compatibility stuff.