1 # Copyright 1992-2016 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. This argument
963 # may be omitted to just match the prompt, ignoring whatever output
965 # MESSAGE is an optional message to be printed. If this is
966 # omitted, then the pass/fail messages use the command string as the
967 # message. (If this is the empty string, then sometimes we don't
968 # call pass or fail at all; I don't understand this at all.)
969 # QUESTION is a question GDB may ask in response to COMMAND, like
971 # RESPONSE is the response to send if QUESTION appears.
974 # 1 if the test failed,
975 # 0 if the test passes,
976 # -1 if there was an internal error.
978 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)"
1234 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1235 # Send a command to gdb; expect inferior and gdb output.
1237 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1240 # INFERIOR_PATTERN is the pattern to match against inferior output.
1242 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1243 # include the \r\n sequence immediately before the gdb prompt, nor the
1244 # prompt. The default is empty.
1246 # Both inferior and gdb patterns must match for a PASS.
1248 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1251 # 1 if the test failed,
1252 # 0 if the test passes,
1253 # -1 if there was an internal error.
1256 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1257 global inferior_spawn_id gdb_spawn_id
1260 if {$message == ""} {
1261 set message $command
1264 set inferior_matched 0
1267 # Use an indirect spawn id list, and remove the inferior spawn id
1268 # from the expected output as soon as it matches, in case
1269 # $inferior_pattern happens to be a prefix of the resulting full
1270 # gdb pattern below (e.g., "\r\n").
1271 global gdb_test_stdio_spawn_id_list
1272 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1274 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1275 # then we may see gdb's output arriving before the inferior's
1277 set res [gdb_test_multiple $command $message {
1278 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1279 set inferior_matched 1
1280 if {!$gdb_matched} {
1281 set gdb_test_stdio_spawn_id_list ""
1285 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1287 if {!$inferior_matched} {
1295 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1302 # Issue a PASS and return true if evaluating CONDITION in the caller's
1303 # frame returns true, and issue a FAIL and return false otherwise.
1304 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1305 # omitted or is empty, then the pass/fail messages use the condition
1306 # string as the message.
1308 proc gdb_assert { condition {message ""} } {
1309 if { $message == ""} {
1310 set message $condition
1313 set res [uplevel 1 expr $condition]
1322 proc gdb_reinitialize_dir { subdir } {
1325 if [is_remote host] {
1330 -re "Reinitialize source path to empty.*y or n. " {
1333 -re "Source directories searched.*$gdb_prompt $" {
1334 send_gdb "dir $subdir\n"
1336 -re "Source directories searched.*$gdb_prompt $" {
1337 verbose "Dir set to $subdir"
1339 -re "$gdb_prompt $" {
1340 perror "Dir \"$subdir\" failed."
1344 -re "$gdb_prompt $" {
1345 perror "Dir \"$subdir\" failed."
1349 -re "$gdb_prompt $" {
1350 perror "Dir \"$subdir\" failed."
1356 # gdb_exit -- exit the GDB, killing the target program if necessary
1358 proc default_gdb_exit {} {
1360 global INTERNAL_GDBFLAGS GDBFLAGS
1362 global gdb_spawn_id inferior_spawn_id
1363 global inotify_log_file
1365 gdb_stop_suppressing_tests
1367 if ![info exists gdb_spawn_id] {
1371 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1373 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1374 set fd [open $inotify_log_file]
1375 set data [read -nonewline $fd]
1378 if {[string compare $data ""] != 0} {
1379 warning "parallel-unsafe file creations noticed"
1382 set fd [open $inotify_log_file w]
1387 if { [is_remote host] && [board_info host exists fileid] } {
1394 -re "DOSEXIT code" { }
1399 if ![is_remote host] {
1403 unset inferior_spawn_id
1406 # Load a file into the debugger.
1407 # The return value is 0 for success, -1 for failure.
1409 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1410 # to one of these values:
1412 # debug file was loaded successfully and has debug information
1413 # nodebug file was loaded successfully and has no debug information
1414 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1416 # fail file was not loaded
1418 # I tried returning this information as part of the return value,
1419 # but ran into a mess because of the many re-implementations of
1420 # gdb_load in config/*.exp.
1422 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1423 # this if they can get more information set.
1425 proc gdb_file_cmd { arg } {
1429 global last_loaded_file
1431 # Save this for the benefit of gdbserver-support.exp.
1432 set last_loaded_file $arg
1434 # Set whether debug info was found.
1435 # Default to "fail".
1436 global gdb_file_cmd_debug_info
1437 set gdb_file_cmd_debug_info "fail"
1439 if [is_remote host] {
1440 set arg [remote_download host $arg]
1442 perror "download failed"
1447 # The file command used to kill the remote target. For the benefit
1448 # of the testsuite, preserve this behavior.
1451 -re "Kill the program being debugged. .y or n. $" {
1453 verbose "\t\tKilling previous program being debugged"
1456 -re "$gdb_prompt $" {
1461 send_gdb "file $arg\n"
1463 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1464 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1465 set gdb_file_cmd_debug_info "lzma"
1468 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1469 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1470 set gdb_file_cmd_debug_info "nodebug"
1473 -re "Reading symbols from.*done.*$gdb_prompt $" {
1474 verbose "\t\tLoaded $arg into $GDB"
1475 set gdb_file_cmd_debug_info "debug"
1478 -re "Load new symbol table from \".*\".*y or n. $" {
1481 -re "Reading symbols from.*done.*$gdb_prompt $" {
1482 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1483 set gdb_file_cmd_debug_info "debug"
1487 perror "Couldn't load $arg, other program already loaded (timeout)."
1491 perror "Couldn't load $arg, other program already loaded (eof)."
1496 -re "No such file or directory.*$gdb_prompt $" {
1497 perror "($arg) No such file or directory"
1500 -re "A problem internal to GDB has been detected" {
1501 fail "($arg) (GDB internal error)"
1502 gdb_internal_error_resync
1505 -re "$gdb_prompt $" {
1506 perror "Couldn't load $arg into $GDB."
1510 perror "Couldn't load $arg into $GDB (timeout)."
1514 # This is an attempt to detect a core dump, but seems not to
1515 # work. Perhaps we need to match .* followed by eof, in which
1516 # gdb_expect does not seem to have a way to do that.
1517 perror "Couldn't load $arg into $GDB (eof)."
1523 # Default gdb_spawn procedure.
1525 proc default_gdb_spawn { } {
1528 global INTERNAL_GDBFLAGS GDBFLAGS
1531 gdb_stop_suppressing_tests
1533 # Set the default value, it may be overriden later by specific testfile.
1535 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1536 # is already started after connecting and run/attach are not supported.
1537 # This is used for the "remote" protocol. After GDB starts you should
1538 # check global $use_gdb_stub instead of the board as the testfile may force
1539 # a specific different target protocol itself.
1540 set use_gdb_stub [target_info exists use_gdb_stub]
1542 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1544 if [info exists gdb_spawn_id] {
1548 if ![is_remote host] {
1549 if { [which $GDB] == 0 } then {
1550 perror "$GDB does not exist."
1554 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1555 if { $res < 0 || $res == "" } {
1556 perror "Spawning $GDB failed."
1560 set gdb_spawn_id $res
1564 # Default gdb_start procedure.
1566 proc default_gdb_start { } {
1567 global gdb_prompt pagination_prompt
1569 global inferior_spawn_id
1571 if [info exists gdb_spawn_id] {
1580 # Default to assuming inferior I/O is done on GDB's terminal.
1581 if {![info exists inferior_spawn_id]} {
1582 set inferior_spawn_id $gdb_spawn_id
1585 # When running over NFS, particularly if running many simultaneous
1586 # tests on different hosts all using the same server, things can
1587 # get really slow. Give gdb at least 3 minutes to start up.
1589 while { $loop_again } {
1592 -re "$pagination_prompt" {
1593 verbose "Hit pagination during startup. Pressing enter to continue."
1597 -re "\[\r\n\]$gdb_prompt $" {
1598 verbose "GDB initialized."
1600 -re "$gdb_prompt $" {
1601 perror "GDB never initialized."
1606 perror "(timeout) GDB never initialized after 10 seconds."
1614 # force the height to "unlimited", so no pagers get used
1616 send_gdb "set height 0\n"
1618 -re "$gdb_prompt $" {
1619 verbose "Setting height to 0." 2
1622 warning "Couldn't set the height to 0"
1625 # force the width to "unlimited", so no wraparound occurs
1626 send_gdb "set width 0\n"
1628 -re "$gdb_prompt $" {
1629 verbose "Setting width to 0." 2
1632 warning "Couldn't set the width to 0."
1638 # Utility procedure to give user control of the gdb prompt in a script. It is
1639 # meant to be used for debugging test cases, and should not be left in the
1642 proc gdb_interact { } {
1644 set spawn_id $gdb_spawn_id
1646 send_user "+------------------------------------------+\n"
1647 send_user "| Script interrupted, you can now interact |\n"
1648 send_user "| with by gdb. Type >>> to continue. |\n"
1649 send_user "+------------------------------------------+\n"
1656 # Examine the output of compilation to determine whether compilation
1657 # failed or not. If it failed determine whether it is due to missing
1658 # compiler or due to compiler error. Report pass, fail or unsupported
1661 proc gdb_compile_test {src output} {
1662 if { $output == "" } {
1663 pass "compilation [file tail $src]"
1664 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1665 unsupported "compilation [file tail $src]"
1666 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1667 unsupported "compilation [file tail $src]"
1668 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1669 unsupported "compilation [file tail $src]"
1671 verbose -log "compilation failed: $output" 2
1672 fail "compilation [file tail $src]"
1676 # Return a 1 for configurations for which we don't even want to try to
1679 proc skip_cplus_tests {} {
1680 if { [istarget "h8300-*-*"] } {
1684 # The C++ IO streams are too large for HC11/HC12 and are thus not
1685 # available. The gdb C++ tests use them and don't compile.
1686 if { [istarget "m6811-*-*"] } {
1689 if { [istarget "m6812-*-*"] } {
1695 # Return a 1 for configurations for which don't have both C++ and the STL.
1697 proc skip_stl_tests {} {
1698 # Symbian supports the C++ language, but the STL is missing
1699 # (both headers and libraries).
1700 if { [istarget "arm*-*-symbianelf*"] } {
1704 return [skip_cplus_tests]
1707 # Return a 1 if I don't even want to try to test FORTRAN.
1709 proc skip_fortran_tests {} {
1713 # Return a 1 if I don't even want to try to test ada.
1715 proc skip_ada_tests {} {
1719 # Return a 1 if I don't even want to try to test GO.
1721 proc skip_go_tests {} {
1725 # Return a 1 if I don't even want to try to test D.
1727 proc skip_d_tests {} {
1731 # Return 1 to skip Rust tests, 0 to try them.
1732 proc skip_rust_tests {} {
1733 return [expr {![isnative]}]
1736 # Return a 1 for configurations that do not support Python scripting.
1737 # PROMPT_REGEXP is the expected prompt.
1739 proc skip_python_tests_prompt { prompt_regexp } {
1740 global gdb_py_is_py3k
1741 global gdb_py_is_py24
1743 gdb_test_multiple "python print ('test')" "verify python support" {
1744 -re "not supported.*$prompt_regexp" {
1745 unsupported "Python support is disabled."
1748 -re "$prompt_regexp" {}
1751 set gdb_py_is_py24 0
1752 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1753 -re "3.*$prompt_regexp" {
1754 set gdb_py_is_py3k 1
1756 -re ".*$prompt_regexp" {
1757 set gdb_py_is_py3k 0
1760 if { $gdb_py_is_py3k == 0 } {
1761 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1762 -re "\[45\].*$prompt_regexp" {
1763 set gdb_py_is_py24 1
1765 -re ".*$prompt_regexp" {
1766 set gdb_py_is_py24 0
1774 # Return a 1 for configurations that do not support Python scripting.
1775 # Note: This also sets various globals that specify which version of Python
1776 # is in use. See skip_python_tests_prompt.
1778 proc skip_python_tests {} {
1780 return [skip_python_tests_prompt "$gdb_prompt $"]
1783 # Return a 1 if we should skip shared library tests.
1785 proc skip_shlib_tests {} {
1786 # Run the shared library tests on native systems.
1791 # An abbreviated list of remote targets where we should be able to
1792 # run shared library tests.
1793 if {([istarget *-*-linux*]
1794 || [istarget *-*-*bsd*]
1795 || [istarget *-*-solaris2*]
1796 || [istarget arm*-*-symbianelf*]
1797 || [istarget *-*-mingw*]
1798 || [istarget *-*-cygwin*]
1799 || [istarget *-*-pe*])} {
1806 # Return 1 if we should skip tui related tests.
1808 proc skip_tui_tests {} {
1811 gdb_test_multiple "help layout" "verify tui support" {
1812 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1815 -re "$gdb_prompt $" {
1822 # Test files shall make sure all the test result lines in gdb.sum are
1823 # unique in a test run, so that comparing the gdb.sum files of two
1824 # test runs gives correct results. Test files that exercise
1825 # variations of the same tests more than once, shall prefix the
1826 # different test invocations with different identifying strings in
1827 # order to make them unique.
1829 # About test prefixes:
1831 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1832 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1833 # underlined substring in
1835 # PASS: gdb.base/mytest.exp: some test
1836 # ^^^^^^^^^^^^^^^^^^^^
1840 # The easiest way to adjust the test prefix is to append a test
1841 # variation prefix to the $pf_prefix, using the with_test_prefix
1844 # proc do_tests {} {
1845 # gdb_test ... ... "test foo"
1846 # gdb_test ... ... "test bar"
1848 # with_test_prefix "subvariation a" {
1849 # gdb_test ... ... "test x"
1852 # with_test_prefix "subvariation b" {
1853 # gdb_test ... ... "test x"
1857 # with_test_prefix "variation1" {
1858 # ...do setup for variation 1...
1862 # with_test_prefix "variation2" {
1863 # ...do setup for variation 2...
1869 # PASS: gdb.base/mytest.exp: variation1: test foo
1870 # PASS: gdb.base/mytest.exp: variation1: test bar
1871 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1872 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1873 # PASS: gdb.base/mytest.exp: variation2: test foo
1874 # PASS: gdb.base/mytest.exp: variation2: test bar
1875 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1876 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1878 # If for some reason more flexibility is necessary, one can also
1879 # manipulate the pf_prefix global directly, treating it as a string.
1883 # set saved_pf_prefix
1884 # append pf_prefix "${foo}: bar"
1885 # ... actual tests ...
1886 # set pf_prefix $saved_pf_prefix
1889 # Run BODY in the context of the caller, with the current test prefix
1890 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1891 # Returns the result of BODY.
1893 proc with_test_prefix { prefix body } {
1896 set saved $pf_prefix
1897 append pf_prefix " " $prefix ":"
1898 set code [catch {uplevel 1 $body} result]
1899 set pf_prefix $saved
1902 global errorInfo errorCode
1903 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1905 return -code $code $result
1909 # Wrapper for foreach that calls with_test_prefix on each iteration,
1910 # including the iterator's name and current value in the prefix.
1912 proc foreach_with_prefix {var list body} {
1914 foreach myvar $list {
1915 with_test_prefix "$var=$myvar" {
1921 # Run BODY in the context of the caller. After BODY is run, the variables
1922 # listed in VARS will be reset to the values they had before BODY was run.
1924 # This is useful for providing a scope in which it is safe to temporarily
1925 # modify global variables, e.g.
1927 # global INTERNAL_GDBFLAGS
1930 # set foo GDBHISTSIZE
1932 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1933 # append INTERNAL_GDBFLAGS " -nx"
1934 # unset -nocomplain env(GDBHISTSIZE)
1939 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1940 # modified inside BODY, this proc guarantees that the modifications will be
1941 # undone after BODY finishes executing.
1943 proc save_vars { vars body } {
1944 array set saved_scalars { }
1945 array set saved_arrays { }
1949 # First evaluate VAR in the context of the caller in case the variable
1950 # name may be a not-yet-interpolated string like env($foo)
1951 set var [uplevel 1 list $var]
1953 if [uplevel 1 [list info exists $var]] {
1954 if [uplevel 1 [list array exists $var]] {
1955 set saved_arrays($var) [uplevel 1 [list array get $var]]
1957 set saved_scalars($var) [uplevel 1 [list set $var]]
1960 lappend unset_vars $var
1964 set code [catch {uplevel 1 $body} result]
1966 foreach {var value} [array get saved_scalars] {
1967 uplevel 1 [list set $var $value]
1970 foreach {var value} [array get saved_arrays] {
1971 uplevel 1 [list unset $var]
1972 uplevel 1 [list array set $var $value]
1975 foreach var $unset_vars {
1976 uplevel 1 [list unset -nocomplain $var]
1980 global errorInfo errorCode
1981 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1983 return -code $code $result
1988 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1989 # PROMPT. When BODY is finished, restore GDB prompt and variable
1991 # Returns the result of BODY.
1995 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
1996 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
1997 # TCL). PROMPT is internally converted to a suitable regexp for matching.
1998 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
1999 # a) It's more intuitive for callers to pass the plain text form.
2000 # b) We need two forms of the prompt:
2001 # - a regexp to use in output matching,
2002 # - a value to pass to the "set prompt" command.
2003 # c) It's easier to convert the plain text form to its regexp form.
2005 # 2) Don't add a trailing space, we do that here.
2007 proc with_gdb_prompt { prompt body } {
2010 # Convert "(foo)" to "\(foo\)".
2011 # We don't use string_to_regexp because while it works today it's not
2012 # clear it will work tomorrow: the value we need must work as both a
2013 # regexp *and* as the argument to the "set prompt" command, at least until
2014 # we start recording both forms separately instead of just $gdb_prompt.
2015 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2017 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2019 set saved $gdb_prompt
2021 verbose -log "Setting gdb prompt to \"$prompt \"."
2022 set gdb_prompt $prompt
2023 gdb_test_no_output "set prompt $prompt " ""
2025 set code [catch {uplevel 1 $body} result]
2027 verbose -log "Restoring gdb prompt to \"$saved \"."
2028 set gdb_prompt $saved
2029 gdb_test_no_output "set prompt $saved " ""
2032 global errorInfo errorCode
2033 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2035 return -code $code $result
2039 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2040 # BODY is finished, restore target-charset.
2042 proc with_target_charset { target_charset body } {
2046 gdb_test_multiple "show target-charset" "" {
2047 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2048 set saved $expect_out(1,string)
2050 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2051 set saved $expect_out(1,string)
2053 -re ".*$gdb_prompt " {
2054 fail "get target-charset"
2058 gdb_test_no_output "set target-charset $target_charset" ""
2060 set code [catch {uplevel 1 $body} result]
2062 gdb_test_no_output "set target-charset $saved" ""
2065 global errorInfo errorCode
2066 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2068 return -code $code $result
2072 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2073 # mi_gdb_test etc. default to using it.
2075 proc switch_gdb_spawn_id {spawn_id} {
2077 global board board_info
2079 set gdb_spawn_id $spawn_id
2080 set board [host_info name]
2081 set board_info($board,fileid) $spawn_id
2084 # Clear the default spawn id.
2086 proc clear_gdb_spawn_id {} {
2088 global board board_info
2090 unset -nocomplain gdb_spawn_id
2091 set board [host_info name]
2092 unset -nocomplain board_info($board,fileid)
2095 # Run BODY with SPAWN_ID as current spawn id.
2097 proc with_spawn_id { spawn_id body } {
2100 if [info exists gdb_spawn_id] {
2101 set saved_spawn_id $gdb_spawn_id
2104 switch_gdb_spawn_id $spawn_id
2106 set code [catch {uplevel 1 $body} result]
2108 if [info exists saved_spawn_id] {
2109 switch_gdb_spawn_id $saved_spawn_id
2115 global errorInfo errorCode
2116 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2118 return -code $code $result
2122 # Select the largest timeout from all the timeouts:
2123 # - the local "timeout" variable of the scope two levels above,
2124 # - the global "timeout" variable,
2125 # - the board variable "gdb,timeout".
2127 proc get_largest_timeout {} {
2128 upvar #0 timeout gtimeout
2129 upvar 2 timeout timeout
2132 if [info exists timeout] {
2135 if { [info exists gtimeout] && $gtimeout > $tmt } {
2138 if { [target_info exists gdb,timeout]
2139 && [target_info gdb,timeout] > $tmt } {
2140 set tmt [target_info gdb,timeout]
2150 # Run tests in BODY with timeout increased by factor of FACTOR. When
2151 # BODY is finished, restore timeout.
2153 proc with_timeout_factor { factor body } {
2156 set savedtimeout $timeout
2158 set timeout [expr [get_largest_timeout] * $factor]
2159 set code [catch {uplevel 1 $body} result]
2161 set timeout $savedtimeout
2163 global errorInfo errorCode
2164 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2166 return -code $code $result
2170 # Return 1 if _Complex types are supported, otherwise, return 0.
2172 gdb_caching_proc support_complex_tests {
2174 if { [gdb_skip_float_test] } {
2175 # If floating point is not supported, _Complex is not
2180 # Set up, compile, and execute a test program containing _Complex types.
2181 # Include the current process ID in the file names to prevent conflicts
2182 # with invocations for multiple testsuites.
2183 set src [standard_temp_file complex[pid].c]
2184 set exe [standard_temp_file complex[pid].x]
2186 gdb_produce_source $src {
2190 _Complex long double cld;
2195 verbose "compiling testfile $src" 2
2196 set compile_flags {debug nowarnings quiet}
2197 set lines [gdb_compile $src $exe executable $compile_flags]
2201 if ![string match "" $lines] then {
2202 verbose "testfile compilation failed, returning 0" 2
2211 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2214 proc supports_get_siginfo_type {} {
2215 if { [istarget "*-*-linux*"] } {
2222 # Return 1 if the target supports hardware single stepping.
2224 proc can_hardware_single_step {} {
2226 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2227 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2228 || [istarget "nios2-*-*"] } {
2235 # Return 1 if target hardware or OS supports single stepping to signal
2236 # handler, otherwise, return 0.
2238 proc can_single_step_to_signal_handler {} {
2239 # Targets don't have hardware single step. On these targets, when
2240 # a signal is delivered during software single step, gdb is unable
2241 # to determine the next instruction addresses, because start of signal
2242 # handler is one of them.
2243 return [can_hardware_single_step]
2246 # Return 1 if target supports process record, otherwise return 0.
2248 proc supports_process_record {} {
2250 if [target_info exists gdb,use_precord] {
2251 return [target_info gdb,use_precord]
2254 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2255 || [istarget "i\[34567\]86-*-linux*"]
2256 || [istarget "aarch64*-*-linux*"]
2257 || [istarget "powerpc*-*-linux*"]
2258 || [istarget "s390*-*-linux*"] } {
2265 # Return 1 if target supports reverse debugging, otherwise return 0.
2267 proc supports_reverse {} {
2269 if [target_info exists gdb,can_reverse] {
2270 return [target_info gdb,can_reverse]
2273 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2274 || [istarget "i\[34567\]86-*-linux*"]
2275 || [istarget "aarch64*-*-linux*"]
2276 || [istarget "powerpc*-*-linux*"]
2277 || [istarget "s390*-*-linux*"] } {
2284 # Return 1 if readline library is used.
2286 proc readline_is_used { } {
2289 gdb_test_multiple "show editing" "" {
2290 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2293 -re ".*$gdb_prompt $" {
2299 # Return 1 if target is ELF.
2300 gdb_caching_proc is_elf_target {
2301 set me "is_elf_target"
2303 set src [standard_temp_file is_elf_target[pid].c]
2304 set obj [standard_temp_file is_elf_target[pid].o]
2306 gdb_produce_source $src {
2307 int foo () {return 0;}
2310 verbose "$me: compiling testfile $src" 2
2311 set lines [gdb_compile $src $obj object {quiet}]
2315 if ![string match "" $lines] then {
2316 verbose "$me: testfile compilation failed, returning 0" 2
2320 set fp_obj [open $obj "r"]
2321 fconfigure $fp_obj -translation binary
2322 set data [read $fp_obj]
2327 set ELFMAG "\u007FELF"
2329 if {[string compare -length 4 $data $ELFMAG] != 0} {
2330 verbose "$me: returning 0" 2
2334 verbose "$me: returning 1" 2
2338 # Return 1 if the memory at address zero is readable.
2340 gdb_caching_proc is_address_zero_readable {
2344 gdb_test_multiple "x 0" "" {
2345 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2348 -re ".*$gdb_prompt $" {
2356 # Produce source file NAME and write SOURCES into it.
2358 proc gdb_produce_source { name sources } {
2360 set f [open $name "w"]
2366 # Return 1 if target is ILP32.
2367 # This cannot be decided simply from looking at the target string,
2368 # as it might depend on externally passed compiler options like -m64.
2369 gdb_caching_proc is_ilp32_target {
2370 set me "is_ilp32_target"
2372 set src [standard_temp_file ilp32[pid].c]
2373 set obj [standard_temp_file ilp32[pid].o]
2375 gdb_produce_source $src {
2376 int dummy[sizeof (int) == 4
2377 && sizeof (void *) == 4
2378 && sizeof (long) == 4 ? 1 : -1];
2381 verbose "$me: compiling testfile $src" 2
2382 set lines [gdb_compile $src $obj object {quiet}]
2386 if ![string match "" $lines] then {
2387 verbose "$me: testfile compilation failed, returning 0" 2
2391 verbose "$me: returning 1" 2
2395 # Return 1 if target is LP64.
2396 # This cannot be decided simply from looking at the target string,
2397 # as it might depend on externally passed compiler options like -m64.
2398 gdb_caching_proc is_lp64_target {
2399 set me "is_lp64_target"
2401 set src [standard_temp_file lp64[pid].c]
2402 set obj [standard_temp_file lp64[pid].o]
2404 gdb_produce_source $src {
2405 int dummy[sizeof (int) == 4
2406 && sizeof (void *) == 8
2407 && sizeof (long) == 8 ? 1 : -1];
2410 verbose "$me: compiling testfile $src" 2
2411 set lines [gdb_compile $src $obj object {quiet}]
2415 if ![string match "" $lines] then {
2416 verbose "$me: testfile compilation failed, returning 0" 2
2420 verbose "$me: returning 1" 2
2424 # Return 1 if target has 64 bit addresses.
2425 # This cannot be decided simply from looking at the target string,
2426 # as it might depend on externally passed compiler options like -m64.
2427 gdb_caching_proc is_64_target {
2428 set me "is_64_target"
2430 set src [standard_temp_file is64[pid].c]
2431 set obj [standard_temp_file is64[pid].o]
2433 gdb_produce_source $src {
2434 int function(void) { return 3; }
2435 int dummy[sizeof (&function) == 8 ? 1 : -1];
2438 verbose "$me: compiling testfile $src" 2
2439 set lines [gdb_compile $src $obj object {quiet}]
2443 if ![string match "" $lines] then {
2444 verbose "$me: testfile compilation failed, returning 0" 2
2448 verbose "$me: returning 1" 2
2452 # Return 1 if target has x86_64 registers - either amd64 or x32.
2453 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2454 # just from the target string.
2455 gdb_caching_proc is_amd64_regs_target {
2456 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2460 set me "is_amd64_regs_target"
2462 set src [standard_temp_file reg64[pid].s]
2463 set obj [standard_temp_file reg64[pid].o]
2467 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2468 lappend list "\tincq %$reg"
2470 gdb_produce_source $src [join $list \n]
2472 verbose "$me: compiling testfile $src" 2
2473 set lines [gdb_compile $src $obj object {quiet}]
2477 if ![string match "" $lines] then {
2478 verbose "$me: testfile compilation failed, returning 0" 2
2482 verbose "$me: returning 1" 2
2486 # Return 1 if this target is an x86 or x86-64 with -m32.
2487 proc is_x86_like_target {} {
2488 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2491 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2494 # Return 1 if this target is an arm or aarch32 on aarch64.
2496 gdb_caching_proc is_aarch32_target {
2497 if { [istarget "arm*-*-*"] } {
2501 if { ![istarget "aarch64*-*-*"] } {
2505 set me "is_aarch32_target"
2507 set src [standard_temp_file aarch32[pid].s]
2508 set obj [standard_temp_file aarch32[pid].o]
2513 lappend list "\tmov $reg, $reg"
2515 gdb_produce_source $src [join $list \n]
2517 verbose "$me: compiling testfile $src" 2
2518 set lines [gdb_compile $src $obj object {quiet}]
2522 if ![string match "" $lines] then {
2523 verbose "$me: testfile compilation failed, returning 0" 2
2527 verbose "$me: returning 1" 2
2531 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2533 proc is_aarch64_target {} {
2534 if { ![istarget "aarch64*-*-*"] } {
2538 return [expr ![is_aarch32_target]]
2541 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2542 proc support_displaced_stepping {} {
2544 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2545 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2546 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2547 || [istarget "aarch64*-*-linux*"] } {
2554 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2555 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2557 gdb_caching_proc skip_altivec_tests {
2558 global srcdir subdir gdb_prompt inferior_exited_re
2560 set me "skip_altivec_tests"
2562 # Some simulators are known to not support VMX instructions.
2563 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2564 verbose "$me: target known to not support VMX, returning 1" 2
2568 # Make sure we have a compiler that understands altivec.
2569 set compile_flags {debug nowarnings}
2570 if [get_compiler_info] {
2571 warning "Could not get compiler info"
2574 if [test_compiler_info gcc*] {
2575 set compile_flags "$compile_flags additional_flags=-maltivec"
2576 } elseif [test_compiler_info xlc*] {
2577 set compile_flags "$compile_flags additional_flags=-qaltivec"
2579 verbose "Could not compile with altivec support, returning 1" 2
2583 # Set up, compile, and execute a test program containing VMX instructions.
2584 # Include the current process ID in the file names to prevent conflicts
2585 # with invocations for multiple testsuites.
2586 set src [standard_temp_file vmx[pid].c]
2587 set exe [standard_temp_file vmx[pid].x]
2589 gdb_produce_source $src {
2592 asm volatile ("vor v0,v0,v0");
2594 asm volatile ("vor 0,0,0");
2600 verbose "$me: compiling testfile $src" 2
2601 set lines [gdb_compile $src $exe executable $compile_flags]
2604 if ![string match "" $lines] then {
2605 verbose "$me: testfile compilation failed, returning 1" 2
2609 # No error message, compilation succeeded so now run it via gdb.
2613 gdb_reinitialize_dir $srcdir/$subdir
2617 -re ".*Illegal instruction.*${gdb_prompt} $" {
2618 verbose -log "\n$me altivec hardware not detected"
2619 set skip_vmx_tests 1
2621 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2622 verbose -log "\n$me: altivec hardware detected"
2623 set skip_vmx_tests 0
2626 warning "\n$me: default case taken"
2627 set skip_vmx_tests 1
2631 remote_file build delete $exe
2633 verbose "$me: returning $skip_vmx_tests" 2
2634 return $skip_vmx_tests
2637 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2638 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2640 gdb_caching_proc skip_vsx_tests {
2641 global srcdir subdir gdb_prompt inferior_exited_re
2643 set me "skip_vsx_tests"
2645 # Some simulators are known to not support Altivec instructions, so
2646 # they won't support VSX instructions as well.
2647 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2648 verbose "$me: target known to not support VSX, returning 1" 2
2652 # Make sure we have a compiler that understands altivec.
2653 set compile_flags {debug nowarnings quiet}
2654 if [get_compiler_info] {
2655 warning "Could not get compiler info"
2658 if [test_compiler_info gcc*] {
2659 set compile_flags "$compile_flags additional_flags=-mvsx"
2660 } elseif [test_compiler_info xlc*] {
2661 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2663 verbose "Could not compile with vsx support, returning 1" 2
2667 set src [standard_temp_file vsx[pid].c]
2668 set exe [standard_temp_file vsx[pid].x]
2670 gdb_produce_source $src {
2672 double a[2] = { 1.0, 2.0 };
2674 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2676 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2682 verbose "$me: compiling testfile $src" 2
2683 set lines [gdb_compile $src $exe executable $compile_flags]
2686 if ![string match "" $lines] then {
2687 verbose "$me: testfile compilation failed, returning 1" 2
2691 # No error message, compilation succeeded so now run it via gdb.
2695 gdb_reinitialize_dir $srcdir/$subdir
2699 -re ".*Illegal instruction.*${gdb_prompt} $" {
2700 verbose -log "\n$me VSX hardware not detected"
2701 set skip_vsx_tests 1
2703 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2704 verbose -log "\n$me: VSX hardware detected"
2705 set skip_vsx_tests 0
2708 warning "\n$me: default case taken"
2709 set skip_vsx_tests 1
2713 remote_file build delete $exe
2715 verbose "$me: returning $skip_vsx_tests" 2
2716 return $skip_vsx_tests
2719 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2720 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2722 gdb_caching_proc skip_tsx_tests {
2723 global srcdir subdir gdb_prompt inferior_exited_re
2725 set me "skip_tsx_tests"
2727 set src [standard_temp_file tsx[pid].c]
2728 set exe [standard_temp_file tsx[pid].x]
2730 gdb_produce_source $src {
2732 asm volatile ("xbegin .L0");
2733 asm volatile ("xend");
2734 asm volatile (".L0: nop");
2739 verbose "$me: compiling testfile $src" 2
2740 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2743 if ![string match "" $lines] then {
2744 verbose "$me: testfile compilation failed." 2
2748 # No error message, compilation succeeded so now run it via gdb.
2752 gdb_reinitialize_dir $srcdir/$subdir
2756 -re ".*Illegal instruction.*${gdb_prompt} $" {
2757 verbose -log "$me: TSX hardware not detected."
2758 set skip_tsx_tests 1
2760 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2761 verbose -log "$me: TSX hardware detected."
2762 set skip_tsx_tests 0
2765 warning "\n$me: default case taken."
2766 set skip_tsx_tests 1
2770 remote_file build delete $exe
2772 verbose "$me: returning $skip_tsx_tests" 2
2773 return $skip_tsx_tests
2776 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2777 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2779 gdb_caching_proc skip_btrace_tests {
2780 global srcdir subdir gdb_prompt inferior_exited_re
2782 set me "skip_btrace_tests"
2783 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2784 verbose "$me: target does not support btrace, returning 1" 2
2788 # Set up, compile, and execute a test program.
2789 # Include the current process ID in the file names to prevent conflicts
2790 # with invocations for multiple testsuites.
2791 set src [standard_temp_file btrace[pid].c]
2792 set exe [standard_temp_file btrace[pid].x]
2794 gdb_produce_source $src {
2795 int main(void) { return 0; }
2798 verbose "$me: compiling testfile $src" 2
2799 set compile_flags {debug nowarnings quiet}
2800 set lines [gdb_compile $src $exe executable $compile_flags]
2802 if ![string match "" $lines] then {
2803 verbose "$me: testfile compilation failed, returning 1" 2
2808 # No error message, compilation succeeded so now run it via gdb.
2812 gdb_reinitialize_dir $srcdir/$subdir
2819 # In case of an unexpected output, we return 2 as a fail value.
2820 set skip_btrace_tests 2
2821 gdb_test_multiple "record btrace" "check btrace support" {
2822 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2823 set skip_btrace_tests 1
2825 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2826 set skip_btrace_tests 1
2828 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2829 set skip_btrace_tests 1
2831 -re "^record btrace\r\n$gdb_prompt $" {
2832 set skip_btrace_tests 0
2836 remote_file build delete $exe
2838 verbose "$me: returning $skip_btrace_tests" 2
2839 return $skip_btrace_tests
2842 # Run a test on the target to see if it supports btrace pt hardware.
2843 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2844 # from the GCC testsuite.
2846 gdb_caching_proc skip_btrace_pt_tests {
2847 global srcdir subdir gdb_prompt inferior_exited_re
2849 set me "skip_btrace_tests"
2850 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2851 verbose "$me: target does not support btrace, returning 1" 2
2855 # Set up, compile, and execute a test program.
2856 # Include the current process ID in the file names to prevent conflicts
2857 # with invocations for multiple testsuites.
2858 set src [standard_temp_file btrace[pid].c]
2859 set exe [standard_temp_file btrace[pid].x]
2861 gdb_produce_source $src {
2862 int main(void) { return 0; }
2865 verbose "$me: compiling testfile $src" 2
2866 set compile_flags {debug nowarnings quiet}
2867 set lines [gdb_compile $src $exe executable $compile_flags]
2869 if ![string match "" $lines] then {
2870 verbose "$me: testfile compilation failed, returning 1" 2
2875 # No error message, compilation succeeded so now run it via gdb.
2879 gdb_reinitialize_dir $srcdir/$subdir
2886 # In case of an unexpected output, we return 2 as a fail value.
2887 set skip_btrace_tests 2
2888 gdb_test_multiple "record btrace pt" "check btrace support" {
2889 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2890 set skip_btrace_tests 1
2892 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2893 set skip_btrace_tests 1
2895 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2896 set skip_btrace_tests 1
2898 -re "GDB does not support.*\r\n$gdb_prompt $" {
2899 set skip_btrace_tests 1
2901 -re "^record btrace pt\r\n$gdb_prompt $" {
2902 set skip_btrace_tests 0
2906 remote_file build delete $exe
2908 verbose "$me: returning $skip_btrace_tests" 2
2909 return $skip_btrace_tests
2912 # Return whether we should skip tests for showing inlined functions in
2913 # backtraces. Requires get_compiler_info and get_debug_format.
2915 proc skip_inline_frame_tests {} {
2916 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2917 if { ! [test_debug_format "DWARF 2"] } {
2921 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2922 if { ([test_compiler_info "gcc-2-*"]
2923 || [test_compiler_info "gcc-3-*"]
2924 || [test_compiler_info "gcc-4-0-*"]) } {
2931 # Return whether we should skip tests for showing variables from
2932 # inlined functions. Requires get_compiler_info and get_debug_format.
2934 proc skip_inline_var_tests {} {
2935 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2936 if { ! [test_debug_format "DWARF 2"] } {
2943 # Return a 1 if we should skip tests that require hardware breakpoints
2945 proc skip_hw_breakpoint_tests {} {
2946 # Skip tests if requested by the board (note that no_hardware_watchpoints
2947 # disables both watchpoints and breakpoints)
2948 if { [target_info exists gdb,no_hardware_watchpoints]} {
2952 # These targets support hardware breakpoints natively
2953 if { [istarget "i?86-*-*"]
2954 || [istarget "x86_64-*-*"]
2955 || [istarget "ia64-*-*"]
2956 || [istarget "arm*-*-*"]
2957 || [istarget "aarch64*-*-*"]
2958 || [istarget "s390*-*-*"] } {
2965 # Return a 1 if we should skip tests that require hardware watchpoints
2967 proc skip_hw_watchpoint_tests {} {
2968 # Skip tests if requested by the board
2969 if { [target_info exists gdb,no_hardware_watchpoints]} {
2973 # These targets support hardware watchpoints natively
2974 if { [istarget "i?86-*-*"]
2975 || [istarget "x86_64-*-*"]
2976 || [istarget "ia64-*-*"]
2977 || [istarget "arm*-*-*"]
2978 || [istarget "aarch64*-*-*"]
2979 || [istarget "powerpc*-*-linux*"]
2980 || [istarget "s390*-*-*"] } {
2987 # Return a 1 if we should skip tests that require *multiple* hardware
2988 # watchpoints to be active at the same time
2990 proc skip_hw_watchpoint_multi_tests {} {
2991 if { [skip_hw_watchpoint_tests] } {
2995 # These targets support just a single hardware watchpoint
2996 if { [istarget "arm*-*-*"]
2997 || [istarget "powerpc*-*-linux*"] } {
3004 # Return a 1 if we should skip tests that require read/access watchpoints
3006 proc skip_hw_watchpoint_access_tests {} {
3007 if { [skip_hw_watchpoint_tests] } {
3011 # These targets support just write watchpoints
3012 if { [istarget "s390*-*-*"] } {
3019 # Return 1 if we should skip tests that require the runtime unwinder
3020 # hook. This must be invoked while gdb is running, after shared
3021 # libraries have been loaded. This is needed because otherwise a
3022 # shared libgcc won't be visible.
3024 proc skip_unwinder_tests {} {
3028 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3029 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3031 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3034 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3038 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3039 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3042 -re "\r\n$gdb_prompt $" {
3049 # Return 0 if we should skip tests that require the libstdc++ stap
3050 # probes. This must be invoked while gdb is running, after shared
3051 # libraries have been loaded.
3053 proc skip_libstdcxx_probe_tests {} {
3057 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3058 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3061 -re "\r\n$gdb_prompt $" {
3067 # Return 1 if we should skip tests of the "compile" feature.
3068 # This must be invoked after the inferior has been started.
3070 proc skip_compile_feature_tests {} {
3074 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3075 "Could not load libcc1.*\r\n$gdb_prompt $" {
3078 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3081 -re "\r\n$gdb_prompt $" {
3087 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3090 proc gdb_is_target_remote_prompt { prompt_regexp } {
3092 set test "probe for target remote"
3093 gdb_test_multiple "maint print target-stack" $test {
3094 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3098 -re "$prompt_regexp" {
3105 # Check whether we're testing with the remote or extended-remote
3108 proc gdb_is_target_remote {} {
3111 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3114 # Return the effective value of use_gdb_stub.
3116 # If the use_gdb_stub global has been set (it is set when the gdb process is
3117 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3118 # property from the board file.
3120 # This is the preferred way of checking use_gdb_stub, since it allows to check
3121 # the value before the gdb has been spawned and it will return the correct value
3122 # even when it was overriden by the test.
3124 proc use_gdb_stub {} {
3127 if [info exists use_gdb_stub] {
3128 return $use_gdb_stub
3131 return [target_info exists use_gdb_stub]
3134 # Return 1 if the current remote target is an instance of our GDBserver, 0
3135 # otherwise. Return -1 if there was an error and we can't tell.
3137 gdb_caching_proc target_is_gdbserver {
3141 set test "Probing for GDBserver"
3143 gdb_test_multiple "monitor help" $test {
3144 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3147 -re "$gdb_prompt $" {
3152 if { $is_gdbserver == -1 } {
3153 verbose -log "Unable to tell whether we are using GDBserver or not."
3156 return $is_gdbserver
3159 # N.B. compiler_info is intended to be local to this file.
3160 # Call test_compiler_info with no arguments to fetch its value.
3161 # Yes, this is counterintuitive when there's get_compiler_info,
3162 # but that's the current API.
3163 if [info exists compiler_info] {
3169 # Figure out what compiler I am using.
3170 # The result is cached so only the first invocation runs the compiler.
3172 # ARG can be empty or "C++". If empty, "C" is assumed.
3174 # There are several ways to do this, with various problems.
3176 # [ gdb_compile -E $ifile -o $binfile.ci ]
3177 # source $binfile.ci
3179 # Single Unix Spec v3 says that "-E -o ..." together are not
3180 # specified. And in fact, the native compiler on hp-ux 11 (among
3181 # others) does not work with "-E -o ...". Most targets used to do
3182 # this, and it mostly worked, because it works with gcc.
3184 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3185 # source $binfile.ci
3187 # This avoids the problem with -E and -o together. This almost works
3188 # if the build machine is the same as the host machine, which is
3189 # usually true of the targets which are not gcc. But this code does
3190 # not figure which compiler to call, and it always ends up using the C
3191 # compiler. Not good for setting hp_aCC_compiler. Target
3192 # hppa*-*-hpux* used to do this.
3194 # [ gdb_compile -E $ifile > $binfile.ci ]
3195 # source $binfile.ci
3197 # dejagnu target_compile says that it supports output redirection,
3198 # but the code is completely different from the normal path and I
3199 # don't want to sweep the mines from that path. So I didn't even try
3202 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3205 # I actually do this for all targets now. gdb_compile runs the right
3206 # compiler, and TCL captures the output, and I eval the output.
3208 # Unfortunately, expect logs the output of the command as it goes by,
3209 # and dejagnu helpfully prints a second copy of it right afterwards.
3210 # So I turn off expect logging for a moment.
3212 # [ gdb_compile $ifile $ciexe_file executable $args ]
3213 # [ remote_exec $ciexe_file ]
3214 # [ source $ci_file.out ]
3216 # I could give up on -E and just do this.
3217 # I didn't get desperate enough to try this.
3219 # -- chastain 2004-01-06
3221 proc get_compiler_info {{arg ""}} {
3222 # For compiler.c and compiler.cc
3225 # I am going to play with the log to keep noise out.
3229 # These come from compiler.c or compiler.cc
3230 global compiler_info
3232 # Legacy global data symbols.
3235 if [info exists compiler_info] {
3240 # Choose which file to preprocess.
3241 set ifile "${srcdir}/lib/compiler.c"
3242 if { $arg == "c++" } {
3243 set ifile "${srcdir}/lib/compiler.cc"
3246 # Run $ifile through the right preprocessor.
3247 # Toggle gdb.log to keep the compiler output out of the log.
3248 set saved_log [log_file -info]
3250 if [is_remote host] {
3251 # We have to use -E and -o together, despite the comments
3252 # above, because of how DejaGnu handles remote host testing.
3253 set ppout "$outdir/compiler.i"
3254 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3255 set file [open $ppout r]
3256 set cppout [read $file]
3259 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3261 eval log_file $saved_log
3265 foreach cppline [ split "$cppout" "\n" ] {
3266 if { [ regexp "^#" "$cppline" ] } {
3268 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3270 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3272 verbose "get_compiler_info: $cppline" 2
3276 verbose -log "get_compiler_info: $cppline"
3281 # Set to unknown if for some reason compiler_info didn't get defined.
3282 if ![info exists compiler_info] {
3283 verbose -log "get_compiler_info: compiler_info not provided"
3284 set compiler_info "unknown"
3286 # Also set to unknown compiler if any diagnostics happened.
3288 verbose -log "get_compiler_info: got unexpected diagnostics"
3289 set compiler_info "unknown"
3292 # Set the legacy symbols.
3294 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3296 # Log what happened.
3297 verbose -log "get_compiler_info: $compiler_info"
3299 # Most compilers will evaluate comparisons and other boolean
3300 # operations to 0 or 1.
3301 uplevel \#0 { set true 1 }
3302 uplevel \#0 { set false 0 }
3307 # Return the compiler_info string if no arg is provided.
3308 # Otherwise the argument is a glob-style expression to match against
3311 proc test_compiler_info { {compiler ""} } {
3312 global compiler_info
3315 # If no arg, return the compiler_info string.
3316 if [string match "" $compiler] {
3317 return $compiler_info
3320 return [string match $compiler $compiler_info]
3323 proc current_target_name { } {
3325 if [info exists target_info(target,name)] {
3326 set answer $target_info(target,name)
3333 set gdb_wrapper_initialized 0
3334 set gdb_wrapper_target ""
3336 proc gdb_wrapper_init { args } {
3337 global gdb_wrapper_initialized
3338 global gdb_wrapper_file
3339 global gdb_wrapper_flags
3340 global gdb_wrapper_target
3342 if { $gdb_wrapper_initialized == 1 } { return; }
3344 if {[target_info exists needs_status_wrapper] && \
3345 [target_info needs_status_wrapper] != "0"} {
3346 set result [build_wrapper "testglue.o"]
3347 if { $result != "" } {
3348 set gdb_wrapper_file [lindex $result 0]
3349 set gdb_wrapper_flags [lindex $result 1]
3351 warning "Status wrapper failed to build."
3354 set gdb_wrapper_initialized 1
3355 set gdb_wrapper_target [current_target_name]
3358 # Some targets need to always link a special object in. Save its path here.
3359 global gdb_saved_set_unbuffered_mode_obj
3360 set gdb_saved_set_unbuffered_mode_obj ""
3362 # Compile source files specified by SOURCE into a binary of type TYPE at path
3363 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3364 # parameter and most options are passed directly to it.
3366 # The type can be one of the following:
3368 # - object: Compile into an object file.
3369 # - executable: Compile and link into an executable.
3370 # - preprocess: Preprocess the source files.
3371 # - assembly: Generate assembly listing.
3373 # The following options are understood and processed by gdb_compile:
3375 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3376 # quirks to be able to use shared libraries.
3377 # - shlib_load: Link with appropriate libraries to allow the test to
3378 # dynamically load libraries at runtime. For example, on Linux, this adds
3379 # -ldl so that the test can use dlopen.
3380 # - nowarnings: Inhibit all compiler warnings.
3382 # And here are some of the not too obscure options understood by DejaGnu that
3383 # influence the compilation:
3385 # - additional_flags=flag: Add FLAG to the compiler flags.
3386 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3387 # argument can be a file, in which case it's added to the sources, or a
3389 # - ldflags=flag: Add FLAG to the linker flags.
3390 # - incdir=path: Add PATH to the searched include directories.
3391 # - libdir=path: Add PATH to the linker searched directories.
3392 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3393 # - debug: Build with debug information.
3394 # - optimize: Build with optimization.
3396 proc gdb_compile {source dest type options} {
3397 global GDB_TESTCASE_OPTIONS
3398 global gdb_wrapper_file
3399 global gdb_wrapper_flags
3400 global gdb_wrapper_initialized
3403 global gdb_saved_set_unbuffered_mode_obj
3405 set outdir [file dirname $dest]
3407 # Add platform-specific options if a shared library was specified using
3408 # "shlib=librarypath" in OPTIONS.
3412 foreach opt $options {
3413 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3414 if [test_compiler_info "xlc-*"] {
3415 # IBM xlc compiler doesn't accept shared library named other
3416 # than .so: use "-Wl," to bypass this
3417 lappend source "-Wl,$shlib_name"
3418 } elseif { ([istarget "*-*-mingw*"]
3419 || [istarget *-*-cygwin*]
3420 || [istarget *-*-pe*])} {
3421 lappend source "${shlib_name}.a"
3423 lappend source $shlib_name
3425 if { $shlib_found == 0 } {
3427 if { ([istarget "*-*-mingw*"]
3428 || [istarget *-*-cygwin*]) } {
3429 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3431 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3432 # Undo debian's change in the default.
3433 # Put it at the front to not override any user-provided
3434 # value, and to make sure it appears in front of all the
3436 lappend new_options "early_flags=-Wl,--no-as-needed"
3439 } elseif { $opt == "shlib_load" } {
3442 lappend new_options $opt
3446 # Because we link with libraries using their basename, we may need
3447 # (depending on the platform) to set a special rpath value, to allow
3448 # the executable to find the libraries it depends on.
3449 if { $shlib_load || $shlib_found } {
3450 if { ([istarget "*-*-mingw*"]
3451 || [istarget *-*-cygwin*]
3452 || [istarget *-*-pe*]) } {
3453 # Do not need anything.
3454 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3455 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3456 } elseif { [istarget arm*-*-symbianelf*] } {
3457 if { $shlib_load } {
3458 lappend new_options "libs=-ldl"
3461 if { $shlib_load } {
3462 lappend new_options "libs=-ldl"
3464 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3467 set options $new_options
3469 if [info exists GDB_TESTCASE_OPTIONS] {
3470 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3472 verbose "options are $options"
3473 verbose "source is $source $dest $type $options"
3475 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3477 if {[target_info exists needs_status_wrapper] && \
3478 [target_info needs_status_wrapper] != "0" && \
3479 [info exists gdb_wrapper_file]} {
3480 lappend options "libs=${gdb_wrapper_file}"
3481 lappend options "ldflags=${gdb_wrapper_flags}"
3484 # Replace the "nowarnings" option with the appropriate additional_flags
3485 # to disable compiler warnings.
3486 set nowarnings [lsearch -exact $options nowarnings]
3487 if {$nowarnings != -1} {
3488 if [target_info exists gdb,nowarnings_flag] {
3489 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3491 set flag "additional_flags=-w"
3493 set options [lreplace $options $nowarnings $nowarnings $flag]
3496 if { $type == "executable" } {
3497 if { ([istarget "*-*-mingw*"]
3498 || [istarget "*-*-*djgpp"]
3499 || [istarget "*-*-cygwin*"])} {
3500 # Force output to unbuffered mode, by linking in an object file
3501 # with a global contructor that calls setvbuf.
3503 # Compile the special object seperatelly for two reasons:
3504 # 1) Insulate it from $options.
3505 # 2) Avoid compiling it for every gdb_compile invocation,
3506 # which is time consuming, especially if we're remote
3509 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3510 verbose "compiling gdb_saved_set_unbuffered_obj"
3511 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3512 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3514 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3515 if { $result != "" } {
3518 if {[is_remote host]} {
3519 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3521 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3523 # Link a copy of the output object, because the
3524 # original may be automatically deleted.
3525 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3527 verbose "gdb_saved_set_unbuffered_obj already compiled"
3530 # Rely on the internal knowledge that the global ctors are ran in
3531 # reverse link order. In that case, we can use ldflags to
3532 # avoid copying the object file to the host multiple
3534 # This object can only be added if standard libraries are
3535 # used. Thus, we need to disable it if -nostdlib option is used
3536 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3537 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3542 set result [target_compile $source $dest $type $options]
3544 # Prune uninteresting compiler (and linker) output.
3545 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3547 regsub "\[\r\n\]*$" "$result" "" result
3548 regsub "^\[\r\n\]*" "$result" "" result
3550 if {[lsearch $options quiet] < 0} {
3551 # We shall update this on a per language basis, to avoid
3552 # changing the entire testsuite in one go.
3553 if {[lsearch $options f77] >= 0} {
3554 gdb_compile_test $source $result
3555 } elseif { $result != "" } {
3556 clone_output "gdb compile failed, $result"
3563 # This is just like gdb_compile, above, except that it tries compiling
3564 # against several different thread libraries, to see which one this
3566 proc gdb_compile_pthreads {source dest type options} {
3568 set why_msg "unrecognized error"
3569 foreach lib {-lpthreads -lpthread -lthread ""} {
3570 # This kind of wipes out whatever libs the caller may have
3571 # set. Or maybe theirs will override ours. How infelicitous.
3572 set options_with_lib [concat $options [list libs=$lib quiet]]
3573 set ccout [gdb_compile $source $dest $type $options_with_lib]
3574 switch -regexp -- $ccout {
3575 ".*no posix threads support.*" {
3576 set why_msg "missing threads include file"
3579 ".*cannot open -lpthread.*" {
3580 set why_msg "missing runtime threads library"
3582 ".*Can't find library for -lpthread.*" {
3583 set why_msg "missing runtime threads library"
3586 pass "successfully compiled posix threads test case"
3592 if {!$built_binfile} {
3593 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3598 # Build a shared library from SOURCES.
3600 proc gdb_compile_shlib {sources dest options} {
3601 set obj_options $options
3604 if { [lsearch -exact $options "c++"] >= 0 } {
3605 set info_options "c++"
3607 if [get_compiler_info ${info_options}] {
3611 switch -glob [test_compiler_info] {
3613 lappend obj_options "additional_flags=-qpic"
3616 if { !([istarget "*-*-cygwin*"]
3617 || [istarget "*-*-mingw*"]) } {
3618 lappend obj_options "additional_flags=-fpic"
3622 if { !([istarget "powerpc*-*-aix*"]
3623 || [istarget "rs6000*-*-aix*"]
3624 || [istarget "*-*-cygwin*"]
3625 || [istarget "*-*-mingw*"]
3626 || [istarget "*-*-pe*"]) } {
3627 lappend obj_options "additional_flags=-fpic"
3631 lappend obj_options "additional_flags=-fpic"
3634 # don't know what the compiler is...
3638 set outdir [file dirname $dest]
3640 foreach source $sources {
3641 set sourcebase [file tail $source]
3642 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3645 lappend objects ${outdir}/${sourcebase}.o
3648 set link_options $options
3649 if [test_compiler_info "xlc-*"] {
3650 lappend link_options "additional_flags=-qmkshrobj"
3652 lappend link_options "additional_flags=-shared"
3654 if { ([istarget "*-*-mingw*"]
3655 || [istarget *-*-cygwin*]
3656 || [istarget *-*-pe*]) } {
3657 if { [is_remote host] } {
3658 set name [file tail ${dest}]
3662 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3664 # Set the soname of the library. This causes the linker on ELF
3665 # systems to create the DT_NEEDED entry in the executable referring
3666 # to the soname of the library, and not its absolute path. This
3667 # (using the absolute path) would be problem when testing on a
3670 # In conjunction with setting the soname, we add the special
3671 # rpath=$ORIGIN value when building the executable, so that it's
3672 # able to find the library in its own directory.
3673 set destbase [file tail $dest]
3674 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3677 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3680 if { [is_remote host]
3681 && ([istarget "*-*-mingw*"]
3682 || [istarget *-*-cygwin*]
3683 || [istarget *-*-pe*]) } {
3684 set dest_tail_name [file tail ${dest}]
3685 remote_upload host $dest_tail_name.a ${dest}.a
3686 remote_file host delete $dest_tail_name.a
3692 # This is just like gdb_compile_shlib, above, except that it tries compiling
3693 # against several different thread libraries, to see which one this
3695 proc gdb_compile_shlib_pthreads {sources dest options} {
3697 set why_msg "unrecognized error"
3698 foreach lib {-lpthreads -lpthread -lthread ""} {
3699 # This kind of wipes out whatever libs the caller may have
3700 # set. Or maybe theirs will override ours. How infelicitous.
3701 set options_with_lib [concat $options [list libs=$lib quiet]]
3702 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3703 switch -regexp -- $ccout {
3704 ".*no posix threads support.*" {
3705 set why_msg "missing threads include file"
3708 ".*cannot open -lpthread.*" {
3709 set why_msg "missing runtime threads library"
3711 ".*Can't find library for -lpthread.*" {
3712 set why_msg "missing runtime threads library"
3715 pass "successfully compiled posix threads test case"
3721 if {!$built_binfile} {
3722 unsupported "Couldn't compile $sources: ${why_msg}"
3727 # This is just like gdb_compile_pthreads, above, except that we always add the
3728 # objc library for compiling Objective-C programs
3729 proc gdb_compile_objc {source dest type options} {
3731 set why_msg "unrecognized error"
3732 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3733 # This kind of wipes out whatever libs the caller may have
3734 # set. Or maybe theirs will override ours. How infelicitous.
3735 if { $lib == "solaris" } {
3736 set lib "-lpthread -lposix4"
3738 if { $lib != "-lobjc" } {
3739 set lib "-lobjc $lib"
3741 set options_with_lib [concat $options [list libs=$lib quiet]]
3742 set ccout [gdb_compile $source $dest $type $options_with_lib]
3743 switch -regexp -- $ccout {
3744 ".*no posix threads support.*" {
3745 set why_msg "missing threads include file"
3748 ".*cannot open -lpthread.*" {
3749 set why_msg "missing runtime threads library"
3751 ".*Can't find library for -lpthread.*" {
3752 set why_msg "missing runtime threads library"
3755 pass "successfully compiled objc with posix threads test case"
3761 if {!$built_binfile} {
3762 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3767 proc send_gdb { string } {
3768 global suppress_flag
3769 if { $suppress_flag } {
3772 return [remote_send host "$string"]
3775 # Send STRING to the inferior's terminal.
3777 proc send_inferior { string } {
3778 global inferior_spawn_id
3780 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3790 proc gdb_expect { args } {
3791 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3792 set atimeout [lindex $args 0]
3793 set expcode [list [lindex $args 1]]
3798 # A timeout argument takes precedence, otherwise of all the timeouts
3799 # select the largest.
3800 if [info exists atimeout] {
3803 set tmt [get_largest_timeout]
3806 global suppress_flag
3807 global remote_suppress_flag
3808 if [info exists remote_suppress_flag] {
3809 set old_val $remote_suppress_flag
3811 if [info exists suppress_flag] {
3812 if { $suppress_flag } {
3813 set remote_suppress_flag 1
3817 {uplevel remote_expect host $tmt $expcode} string]
3818 if [info exists old_val] {
3819 set remote_suppress_flag $old_val
3821 if [info exists remote_suppress_flag] {
3822 unset remote_suppress_flag
3827 global errorInfo errorCode
3829 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3831 return -code $code $string
3835 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3837 # Check for long sequence of output by parts.
3838 # TEST: is the test message to be printed with the test success/fail.
3839 # SENTINEL: Is the terminal pattern indicating that output has finished.
3840 # LIST: is the sequence of outputs to match.
3841 # If the sentinel is recognized early, it is considered an error.
3844 # 1 if the test failed,
3845 # 0 if the test passes,
3846 # -1 if there was an internal error.
3848 proc gdb_expect_list {test sentinel list} {
3850 global suppress_flag
3853 if { $suppress_flag } {
3855 unresolved "${test}"
3857 while { ${index} < [llength ${list}] } {
3858 set pattern [lindex ${list} ${index}]
3859 set index [expr ${index} + 1]
3860 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3861 if { ${index} == [llength ${list}] } {
3864 -re "${pattern}${sentinel}" {
3865 # pass "${test}, pattern ${index} + sentinel"
3868 fail "${test} (pattern ${index} + sentinel)"
3871 -re ".*A problem internal to GDB has been detected" {
3872 fail "${test} (GDB internal error)"
3874 gdb_internal_error_resync
3877 fail "${test} (pattern ${index} + sentinel) (timeout)"
3882 # unresolved "${test}, pattern ${index} + sentinel"
3888 # pass "${test}, pattern ${index}"
3891 fail "${test} (pattern ${index})"
3894 -re ".*A problem internal to GDB has been detected" {
3895 fail "${test} (GDB internal error)"
3897 gdb_internal_error_resync
3900 fail "${test} (pattern ${index}) (timeout)"
3905 # unresolved "${test}, pattern ${index}"
3919 proc gdb_suppress_entire_file { reason } {
3920 global suppress_flag
3923 set suppress_flag -1
3927 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3928 # gdb_expect to fail immediately (until the next call to
3929 # gdb_stop_suppressing_tests).
3931 proc gdb_suppress_tests { args } {
3932 global suppress_flag
3934 return; # fnf - disable pending review of results where
3935 # testsuite ran better without this
3938 if { $suppress_flag == 1 } {
3939 if { [llength $args] > 0 } {
3940 warning "[lindex $args 0]\n"
3942 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3948 # Clear suppress_flag.
3950 proc gdb_stop_suppressing_tests { } {
3951 global suppress_flag
3953 if [info exists suppress_flag] {
3954 if { $suppress_flag > 0 } {
3956 clone_output "Tests restarted.\n"
3963 proc gdb_clear_suppressed { } {
3964 global suppress_flag
3969 # Spawn the gdb process.
3971 # This doesn't expect any output or do any other initialization,
3972 # leaving those to the caller.
3974 # Overridable function -- you can override this function in your
3977 proc gdb_spawn { } {
3981 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3983 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3986 set saved_gdbflags $GDBFLAGS
3988 if {$GDBFLAGS != ""} {
3991 append GDBFLAGS $cmdline_flags
3995 set GDBFLAGS $saved_gdbflags
4000 # Start gdb running, wait for prompt, and disable the pagers.
4002 # Overridable function -- you can override this function in your
4005 proc gdb_start { } {
4010 catch default_gdb_exit
4013 # Return true if we can spawn a program on the target and attach to
4016 proc can_spawn_for_attach { } {
4017 # We use exp_pid to get the inferior's pid, assuming that gives
4018 # back the pid of the program. On remote boards, that would give
4019 # us instead the PID of e.g., the ssh client, etc.
4020 if [is_remote target] then {
4024 # The "attach" command doesn't make sense when the target is
4025 # stub-like, where GDB finds the program already started on
4026 # initial connection.
4027 if {[target_info exists use_gdb_stub]} {
4035 # Kill a progress previously started with spawn_wait_for_attach, and
4036 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4039 proc kill_wait_spawned_process { proc_spawn_id } {
4040 set pid [exp_pid -i $proc_spawn_id]
4042 verbose -log "killing ${pid}"
4043 remote_exec build "kill -9 ${pid}"
4045 verbose -log "closing ${proc_spawn_id}"
4046 catch "close -i $proc_spawn_id"
4047 verbose -log "waiting for ${proc_spawn_id}"
4049 # If somehow GDB ends up still attached to the process here, a
4050 # blocking wait hangs until gdb is killed (or until gdb / the
4051 # ptracer reaps the exit status too, but that won't happen because
4052 # something went wrong.) Passing -nowait makes expect tell Tcl to
4053 # wait for the PID in the background. That's fine because we
4054 # don't care about the exit status. */
4055 wait -nowait -i $proc_spawn_id
4058 # Returns the process id corresponding to the given spawn id.
4060 proc spawn_id_get_pid { spawn_id } {
4061 set testpid [exp_pid -i $spawn_id]
4063 if { [istarget "*-*-cygwin*"] } {
4064 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4065 # might be different due to the way fork/exec works.
4066 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4072 # Start a set of programs running and then wait for a bit, to be sure
4073 # that they can be attached to. Return a list of processes spawn IDs,
4074 # one element for each process spawned. It's a test error to call
4075 # this when [can_spawn_for_attach] is false.
4077 proc spawn_wait_for_attach { executable_list } {
4078 set spawn_id_list {}
4080 if ![can_spawn_for_attach] {
4081 # The caller should have checked can_spawn_for_attach itself
4082 # before getting here.
4083 error "can't spawn for attach with this target/board"
4086 foreach {executable} $executable_list {
4087 # Note we use Expect's spawn, not Tcl's exec, because with
4088 # spawn we control when to wait for/reap the process. That
4089 # allows killing the process by PID without being subject to
4091 lappend spawn_id_list [remote_spawn target $executable]
4096 return $spawn_id_list
4100 # gdb_load_cmd -- load a file into the debugger.
4101 # ARGS - additional args to load command.
4102 # return a -1 if anything goes wrong.
4104 proc gdb_load_cmd { args } {
4107 if [target_info exists gdb_load_timeout] {
4108 set loadtimeout [target_info gdb_load_timeout]
4110 set loadtimeout 1600
4112 send_gdb "load $args\n"
4113 verbose "Timeout is now $loadtimeout seconds" 2
4114 gdb_expect $loadtimeout {
4115 -re "Loading section\[^\r\]*\r\n" {
4118 -re "Start address\[\r\]*\r\n" {
4121 -re "Transfer rate\[\r\]*\r\n" {
4124 -re "Memory access error\[^\r\]*\r\n" {
4125 perror "Failed to load program"
4128 -re "$gdb_prompt $" {
4131 -re "(.*)\r\n$gdb_prompt " {
4132 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4136 perror "Timed out trying to load $args."
4143 # Invoke "gcore". CORE is the name of the core file to write. TEST
4144 # is the name of the test case. This will return 1 if the core file
4145 # was created, 0 otherwise. If this fails to make a core file because
4146 # this configuration of gdb does not support making core files, it
4147 # will call "unsupported", not "fail". However, if this fails to make
4148 # a core file for some other reason, then it will call "fail".
4150 proc gdb_gcore_cmd {core test} {
4154 gdb_test_multiple "gcore $core" $test {
4155 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4159 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4167 # Load core file CORE. TEST is the name of the test case.
4168 # This will record a pass/fail for loading the core file.
4170 # 1 - core file is successfully loaded
4171 # 0 - core file loaded but has a non fatal error
4172 # -1 - core file failed to load
4174 proc gdb_core_cmd { core test } {
4177 gdb_test_multiple "core $core" "$test" {
4178 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4181 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4182 fail "$test (bad file format)"
4185 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4186 fail "$test (file not found)"
4189 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4190 fail "$test (incomplete note section)"
4193 -re "Core was generated by .*\r\n$gdb_prompt $" {
4197 -re ".*$gdb_prompt $" {
4202 fail "$test (timeout)"
4206 fail "unsupported output from 'core' command"
4210 # Return the filename to download to the target and load on the target
4211 # for this shared library. Normally just LIBNAME, unless shared libraries
4212 # for this target have separate link and load images.
4214 proc shlib_target_file { libname } {
4218 # Return the filename GDB will load symbols from when debugging this
4219 # shared library. Normally just LIBNAME, unless shared libraries for
4220 # this target have separate link and load images.
4222 proc shlib_symbol_file { libname } {
4226 # Return the filename to download to the target and load for this
4227 # executable. Normally just BINFILE unless it is renamed to something
4228 # else for this target.
4230 proc exec_target_file { binfile } {
4234 # Return the filename GDB will load symbols from when debugging this
4235 # executable. Normally just BINFILE unless executables for this target
4236 # have separate files for symbols.
4238 proc exec_symbol_file { binfile } {
4242 # Rename the executable file. Normally this is just BINFILE1 being renamed
4243 # to BINFILE2, but some targets require multiple binary files.
4244 proc gdb_rename_execfile { binfile1 binfile2 } {
4245 file rename -force [exec_target_file ${binfile1}] \
4246 [exec_target_file ${binfile2}]
4247 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4248 file rename -force [exec_symbol_file ${binfile1}] \
4249 [exec_symbol_file ${binfile2}]
4253 # "Touch" the executable file to update the date. Normally this is just
4254 # BINFILE, but some targets require multiple files.
4255 proc gdb_touch_execfile { binfile } {
4256 set time [clock seconds]
4257 file mtime [exec_target_file ${binfile}] $time
4258 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4259 file mtime [exec_symbol_file ${binfile}] $time
4263 # Like remote_download but provides a gdb-specific behavior.
4265 # If the destination board is remote, the local file FROMFILE is transferred as
4266 # usual with remote_download to TOFILE on the remote board. The destination
4267 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4270 # If the destination board is local, the destination path TOFILE is passed
4271 # through standard_output_file, and FROMFILE is copied there.
4273 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4276 proc gdb_remote_download {dest fromfile {tofile {}}} {
4277 # If TOFILE is not given, default to the same filename as FROMFILE.
4278 if {[string length $tofile] == 0} {
4279 set tofile [file tail $fromfile]
4282 if {[is_remote $dest]} {
4283 # When the DEST is remote, we simply send the file to DEST.
4286 set destname [remote_download $dest $fromfile $tofile]
4287 lappend cleanfiles $destname
4291 # When the DEST is local, we copy the file to the test directory (where
4292 # the executable is).
4294 # Note that we pass TOFILE through standard_output_file, regardless of
4295 # whether it is absolute or relative, because we don't want the tests
4296 # to be able to write outside their standard output directory.
4298 set tofile [standard_output_file $tofile]
4300 file copy -force $fromfile $tofile
4306 # gdb_load_shlib LIB...
4308 # Copy the listed library to the target.
4310 proc gdb_load_shlib { file } {
4311 set dest [gdb_remote_download target [shlib_target_file $file]]
4313 if {[is_remote target]} {
4314 # If the target is remote, we need to tell gdb where to find the
4317 # We could set this even when not testing remotely, but a user
4318 # generally won't set it unless necessary. In order to make the tests
4319 # more like the real-life scenarios, we don't set it for local testing.
4320 gdb_test "set solib-search-path [file dirname $file]" "" ""
4327 # gdb_load -- load a file into the debugger. Specifying no file
4328 # defaults to the executable currently being debugged.
4329 # The return value is 0 for success, -1 for failure.
4330 # Many files in config/*.exp override this procedure.
4332 proc gdb_load { arg } {
4334 return [gdb_file_cmd $arg]
4339 # gdb_reload -- load a file into the target. Called before "running",
4340 # either the first time or after already starting the program once,
4341 # for remote targets. Most files that override gdb_load should now
4342 # override this instead.
4344 proc gdb_reload { } {
4345 # For the benefit of existing configurations, default to gdb_load.
4346 # Specifying no file defaults to the executable currently being
4348 return [gdb_load ""]
4351 proc gdb_continue { function } {
4354 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4357 proc default_gdb_init { test_file_name } {
4358 global gdb_wrapper_initialized
4359 global gdb_wrapper_target
4360 global gdb_test_file_name
4366 gdb_clear_suppressed
4368 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4370 # Make sure that the wrapper is rebuilt
4371 # with the appropriate multilib option.
4372 if { $gdb_wrapper_target != [current_target_name] } {
4373 set gdb_wrapper_initialized 0
4376 # Unlike most tests, we have a small number of tests that generate
4377 # a very large amount of output. We therefore increase the expect
4378 # buffer size to be able to contain the entire test output. This
4379 # is especially needed by gdb.base/info-macros.exp.
4381 # Also set this value for the currently running GDB.
4382 match_max [match_max -d]
4384 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4385 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4388 if [target_info exists gdb_prompt] {
4389 set gdb_prompt [target_info gdb_prompt]
4391 set gdb_prompt "\\(gdb\\)"
4394 if [info exists use_gdb_stub] {
4399 # Return a path using GDB_PARALLEL.
4400 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4401 # GDB_PARALLEL must be defined, the caller must check.
4403 # The default value for GDB_PARALLEL is, canonically, ".".
4404 # The catch is that tests don't expect an additional "./" in file paths so
4405 # omit any directory for the default case.
4406 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4407 # its special handling.
4409 proc make_gdb_parallel_path { args } {
4410 global GDB_PARALLEL objdir
4411 set joiner [list "file" "join" $objdir]
4412 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4413 lappend joiner $GDB_PARALLEL
4415 set joiner [concat $joiner $args]
4416 return [eval $joiner]
4419 # Turn BASENAME into a full file name in the standard output
4420 # directory. It is ok if BASENAME is the empty string; in this case
4421 # the directory is returned.
4423 proc standard_output_file {basename} {
4424 global objdir subdir gdb_test_file_name
4426 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4428 return [file join $dir $basename]
4431 # Return the name of a file in our standard temporary directory.
4433 proc standard_temp_file {basename} {
4434 # Since a particular runtest invocation is only executing a single test
4435 # file at any given time, we can use the runtest pid to build the
4436 # path of the temp directory.
4437 set dir [make_gdb_parallel_path temp [pid]]
4439 return [file join $dir $basename]
4442 # Set 'testfile', 'srcfile', and 'binfile'.
4444 # ARGS is a list of source file specifications.
4445 # Without any arguments, the .exp file's base name is used to
4446 # compute the source file name. The ".c" extension is added in this case.
4447 # If ARGS is not empty, each entry is a source file specification.
4448 # If the specification starts with a ".", it is treated as a suffix
4449 # to append to the .exp file's base name.
4450 # If the specification is the empty string, it is treated as if it
4452 # Otherwise it is a file name.
4453 # The first file in the list is used to set the 'srcfile' global.
4454 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4456 # Most tests should call this without arguments.
4458 # If a completely different binary file name is needed, then it
4459 # should be handled in the .exp file with a suitable comment.
4461 proc standard_testfile {args} {
4462 global gdb_test_file_name
4464 global gdb_test_file_last_vars
4467 global testfile binfile
4469 set testfile $gdb_test_file_name
4470 set binfile [standard_output_file ${testfile}]
4472 if {[llength $args] == 0} {
4476 # Unset our previous output variables.
4477 # This can help catch hidden bugs.
4478 if {[info exists gdb_test_file_last_vars]} {
4479 foreach varname $gdb_test_file_last_vars {
4481 catch {unset $varname}
4484 # 'executable' is often set by tests.
4485 set gdb_test_file_last_vars {executable}
4489 set varname srcfile$suffix
4492 # Handle an extension.
4495 } elseif {[string range $arg 0 0] == "."} {
4496 set arg $testfile$arg
4500 lappend gdb_test_file_last_vars $varname
4502 if {$suffix == ""} {
4510 # The default timeout used when testing GDB commands. We want to use
4511 # the same timeout as the default dejagnu timeout, unless the user has
4512 # already provided a specific value (probably through a site.exp file).
4513 global gdb_test_timeout
4514 if ![info exists gdb_test_timeout] {
4515 set gdb_test_timeout $timeout
4518 # A list of global variables that GDB testcases should not use.
4519 # We try to prevent their use by monitoring write accesses and raising
4520 # an error when that happens.
4521 set banned_variables { bug_id prms_id }
4523 # A list of procedures that GDB testcases should not use.
4524 # We try to prevent their use by monitoring invocations and raising
4525 # an error when that happens.
4526 set banned_procedures { strace }
4528 # gdb_init is called by runtest at start, but also by several
4529 # tests directly; gdb_finish is only called from within runtest after
4530 # each test source execution.
4531 # Placing several traces by repetitive calls to gdb_init leads
4532 # to problems, as only one trace is removed in gdb_finish.
4533 # To overcome this possible problem, we add a variable that records
4534 # if the banned variables and procedures are already traced.
4537 proc gdb_init { test_file_name } {
4538 # Reset the timeout value to the default. This way, any testcase
4539 # that changes the timeout value without resetting it cannot affect
4540 # the timeout used in subsequent testcases.
4541 global gdb_test_timeout
4543 set timeout $gdb_test_timeout
4545 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4546 && [target_info exists gdb_reverse_timeout] } {
4547 set timeout [target_info gdb_reverse_timeout]
4550 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4551 # debugging tool to help confirm that the test suite is
4552 # parallel-safe. You need "inotifywait" from the
4553 # inotify-tools package to use this.
4554 global GDB_INOTIFY inotify_pid
4555 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4556 global outdir tool inotify_log_file
4558 set exclusions {outputs temp gdb[.](log|sum) cache}
4559 set exclusion_re ([join $exclusions |])
4561 set inotify_log_file [standard_temp_file inotify.out]
4562 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4563 --exclude $exclusion_re \
4564 |& tee -a $outdir/$tool.log $inotify_log_file &]
4566 # Wait for the watches; hopefully this is long enough.
4569 # Clear the log so that we don't emit a warning the first time
4571 set fd [open $inotify_log_file w]
4575 # Block writes to all banned variables, and invocation of all
4576 # banned procedures...
4577 global banned_variables
4578 global banned_procedures
4579 global banned_traced
4580 if (!$banned_traced) {
4581 foreach banned_var $banned_variables {
4582 global "$banned_var"
4583 trace add variable "$banned_var" write error
4585 foreach banned_proc $banned_procedures {
4586 global "$banned_proc"
4587 trace add execution "$banned_proc" enter error
4592 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4593 # messages as expected.
4598 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4599 # the test results. Even if /dev/null doesn't exist on the particular
4600 # platform, the readline library will use the default setting just by
4601 # failing to open the file. OTOH, opening /dev/null successfully will
4602 # also result in the default settings being used since nothing will be
4603 # read from this file.
4604 setenv INPUTRC "/dev/null"
4606 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4607 # bindings, so make sure that an appropriate terminal is selected.
4608 # The same bug doesn't show up if we use ^P / ^N instead.
4611 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4612 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4613 # especially having color output turned on can cause tests to fail.
4614 setenv GREP_OPTIONS ""
4616 # Clear $gdbserver_reconnect_p.
4617 global gdbserver_reconnect_p
4618 set gdbserver_reconnect_p 1
4619 unset gdbserver_reconnect_p
4621 return [default_gdb_init $test_file_name]
4624 proc gdb_finish { } {
4625 global gdbserver_reconnect_p
4629 # Exit first, so that the files are no longer in use.
4632 if { [llength $cleanfiles] > 0 } {
4633 eval remote_file target delete $cleanfiles
4637 # Unblock write access to the banned variables. Dejagnu typically
4638 # resets some of them between testcases.
4639 global banned_variables
4640 global banned_procedures
4641 global banned_traced
4642 if ($banned_traced) {
4643 foreach banned_var $banned_variables {
4644 global "$banned_var"
4645 trace remove variable "$banned_var" write error
4647 foreach banned_proc $banned_procedures {
4648 global "$banned_proc"
4649 trace remove execution "$banned_proc" enter error
4656 set debug_format "unknown"
4658 # Run the gdb command "info source" and extract the debugging format
4659 # information from the output and save it in debug_format.
4661 proc get_debug_format { } {
4667 set debug_format "unknown"
4668 send_gdb "info source\n"
4670 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4671 set debug_format $expect_out(1,string)
4672 verbose "debug format is $debug_format"
4675 -re "No current source file.\r\n$gdb_prompt $" {
4676 perror "get_debug_format used when no current source file"
4679 -re "$gdb_prompt $" {
4680 warning "couldn't check debug format (no valid response)."
4684 warning "couldn't check debug format (timeout)."
4690 # Return true if FORMAT matches the debug format the current test was
4691 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4692 # `*', `[...]', and so on.
4694 # This function depends on variables set by `get_debug_format', above.
4696 proc test_debug_format {format} {
4699 return [expr [string match $format $debug_format] != 0]
4702 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4703 # COFF, stabs, etc). If that format matches the format that the
4704 # current test was compiled with, then the next test is expected to
4705 # fail for any target. Returns 1 if the next test or set of tests is
4706 # expected to fail, 0 otherwise (or if it is unknown). Must have
4707 # previously called get_debug_format.
4708 proc setup_xfail_format { format } {
4709 set ret [test_debug_format $format]
4717 # gdb_get_line_number TEXT [FILE]
4719 # Search the source file FILE, and return the line number of the
4720 # first line containing TEXT. If no match is found, an error is thrown.
4722 # TEXT is a string literal, not a regular expression.
4724 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4725 # specified, and does not start with "/", then it is assumed to be in
4726 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4727 # by changing the callers and the interface at the same time.
4728 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4729 # gdb.base/ena-dis-br.exp.
4731 # Use this function to keep your test scripts independent of the
4732 # exact line numbering of the source file. Don't write:
4734 # send_gdb "break 20"
4736 # This means that if anyone ever edits your test's source file,
4737 # your test could break. Instead, put a comment like this on the
4738 # source file line you want to break at:
4740 # /* breakpoint spot: frotz.exp: test name */
4742 # and then write, in your test script (which we assume is named
4745 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4747 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4750 # % puts "foo [lindex "bar baz" 1]"
4753 # Tcl is quite clever, for a little stringy language.)
4757 # The previous implementation of this procedure used the gdb search command.
4758 # This version is different:
4760 # . It works with MI, and it also works when gdb is not running.
4762 # . It operates on the build machine, not the host machine.
4764 # . For now, this implementation fakes a current directory of
4765 # $srcdir/$subdir to be compatible with the old implementation.
4766 # This will go away eventually and some callers will need to
4769 # . The TEXT argument is literal text and matches literally,
4770 # not a regular expression as it was before.
4772 # . State changes in gdb, such as changing the current file
4773 # and setting $_, no longer happen.
4775 # After a bit of time we can forget about the differences from the
4776 # old implementation.
4778 # --chastain 2004-08-05
4780 proc gdb_get_line_number { text { file "" } } {
4785 if { "$file" == "" } then {
4788 if { ! [regexp "^/" "$file"] } then {
4789 set file "$srcdir/$subdir/$file"
4792 if { [ catch { set fd [open "$file"] } message ] } then {
4797 for { set line 1 } { 1 } { incr line } {
4798 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4801 if { $nchar < 0 } then {
4804 if { [string first "$text" "$body"] >= 0 } then {
4810 if { [ catch { close "$fd" } message ] } then {
4815 error "undefined tag \"$text\""
4821 # Continue the program until it ends.
4823 # MSSG is the error message that gets printed. If not given, a
4825 # COMMAND is the command to invoke. If not given, "continue" is
4827 # ALLOW_EXTRA is a flag indicating whether the test should expect
4828 # extra output between the "Continuing." line and the program
4829 # exiting. By default it is zero; if nonzero, any extra output
4832 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4833 global inferior_exited_re use_gdb_stub
4836 set text "continue until exit"
4838 set text "continue until exit at $mssg"
4846 # By default, we don't rely on exit() behavior of remote stubs --
4847 # it's common for exit() to be implemented as a simple infinite
4848 # loop, or a forced crash/reset. For native targets, by default, we
4849 # assume process exit is reported as such. If a non-reliable target
4850 # is used, we set a breakpoint at exit, and continue to that.
4851 if { [target_info exists exit_is_reliable] } {
4852 set exit_is_reliable [target_info exit_is_reliable]
4854 set exit_is_reliable [expr ! $use_gdb_stub]
4857 if { ! $exit_is_reliable } {
4858 if {![gdb_breakpoint "exit"]} {
4861 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4864 # Continue until we exit. Should not stop again.
4865 # Don't bother to check the output of the program, that may be
4866 # extremely tough for some remote systems.
4868 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4873 proc rerun_to_main {} {
4874 global gdb_prompt use_gdb_stub
4879 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4880 {pass "rerun to main" ; return 0}
4881 -re "$gdb_prompt $"\
4882 {fail "rerun to main" ; return 0}
4883 timeout {fail "(timeout) rerun to main" ; return 0}
4888 -re "The program .* has been started already.*y or n. $" {
4892 -re "Starting program.*$gdb_prompt $"\
4893 {pass "rerun to main" ; return 0}
4894 -re "$gdb_prompt $"\
4895 {fail "rerun to main" ; return 0}
4896 timeout {fail "(timeout) rerun to main" ; return 0}
4901 # Return true if a test should be skipped due to lack of floating
4902 # point support or GDB can't fetch the contents from floating point
4905 gdb_caching_proc gdb_skip_float_test {
4906 if [target_info exists gdb,skip_float_tests] {
4910 # There is an ARM kernel ptrace bug that hardware VFP registers
4911 # are not updated after GDB ptrace set VFP registers. The bug
4912 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
4913 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
4914 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
4915 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
4916 # This kernel bug is detected by check how does GDB change the
4917 # program result by changing one VFP register.
4918 if { [istarget "arm*-*-linux*"] } {
4920 set compile_flags {debug nowarnings }
4922 # Set up, compile, and execute a test program having VFP
4924 set src [standard_temp_file arm_vfp[pid].c]
4925 set exe [standard_temp_file arm_vfp[pid].x]
4927 gdb_produce_source $src {
4932 asm ("vldr d0, [%0]" : : "r" (&d));
4933 asm ("vldr d1, [%0]" : : "r" (&d));
4934 asm (".global break_here\n"
4936 asm ("vcmp.f64 d0, d1\n"
4937 "vmrs APSR_nzcv, fpscr\n"
4938 "bne L_value_different\n"
4941 "L_value_different:\n"
4943 "L_end:\n" : "=r" (ret) :);
4945 /* Return $d0 != $d1. */
4950 verbose "compiling testfile $src" 2
4951 set lines [gdb_compile $src $exe executable $compile_flags]
4954 if ![string match "" $lines] then {
4955 verbose "testfile compilation failed, returning 1" 2
4959 # No error message, compilation succeeded so now run it via gdb.
4960 # Run the test up to 5 times to detect whether ptrace can
4961 # correctly update VFP registers or not.
4963 for {set i 0} {$i < 5} {incr i} {
4964 global gdb_prompt srcdir subdir
4968 gdb_reinitialize_dir $srcdir/$subdir
4972 gdb_test "break *break_here"
4973 gdb_continue_to_breakpoint "break_here"
4975 # Modify $d0 to a different value, so the exit code should
4977 gdb_test "set \$d0 = 5.0"
4979 set test "continue to exit"
4980 gdb_test_multiple "continue" "$test" {
4981 -re "exited with code 01.*$gdb_prompt $" {
4983 -re "exited normally.*$gdb_prompt $" {
4984 # However, the exit code is 0. That means something
4985 # wrong in setting VFP registers.
4993 remote_file build delete $exe
4995 return $skip_vfp_test
5000 # Print a message and return true if a test should be skipped
5001 # due to lack of stdio support.
5003 proc gdb_skip_stdio_test { msg } {
5004 if [target_info exists gdb,noinferiorio] {
5005 verbose "Skipping test '$msg': no inferior i/o."
5011 proc gdb_skip_bogus_test { msg } {
5015 # Return true if a test should be skipped due to lack of XML support
5017 # NOTE: This must be called while gdb is *not* running.
5019 gdb_caching_proc gdb_skip_xml_test {
5023 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5027 gdb_test_multiple "set tdesc filename $xml_file" "" {
5028 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5031 -re ".*$gdb_prompt $" { }
5037 # Return true if argv[0] is available.
5039 gdb_caching_proc gdb_has_argv0 {
5042 # Set up, compile, and execute a test program to check whether
5043 # argv[0] is available.
5044 set src [standard_temp_file has_argv0[pid].c]
5045 set exe [standard_temp_file has_argv0[pid].x]
5047 gdb_produce_source $src {
5048 int main (int argc, char **argv) {
5053 gdb_compile $src $exe executable {debug}
5056 proc gdb_has_argv0_1 { exe } {
5057 global srcdir subdir
5058 global gdb_prompt hex
5062 gdb_reinitialize_dir $srcdir/$subdir
5065 # Set breakpoint on main.
5066 gdb_test_multiple "break main" "break main" {
5067 -re "Breakpoint.*${gdb_prompt} $" {
5069 -re "${gdb_prompt} $" {
5076 gdb_test_multiple "" "run to main" {
5077 -re "Breakpoint.*${gdb_prompt} $" {
5079 -re "${gdb_prompt} $" {
5084 set old_elements "200"
5085 set test "show print elements"
5086 gdb_test_multiple $test $test {
5087 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5088 set old_elements $expect_out(1,string)
5091 set old_repeats "200"
5092 set test "show print repeats"
5093 gdb_test_multiple $test $test {
5094 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5095 set old_repeats $expect_out(1,string)
5098 gdb_test_no_output "set print elements unlimited" ""
5099 gdb_test_no_output "set print repeats unlimited" ""
5102 # Check whether argc is 1.
5103 gdb_test_multiple "p argc" "p argc" {
5104 -re " = 1\r\n${gdb_prompt} $" {
5106 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5107 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5110 -re "${gdb_prompt} $" {
5114 -re "${gdb_prompt} $" {
5118 gdb_test_no_output "set print elements $old_elements" ""
5119 gdb_test_no_output "set print repeats $old_repeats" ""
5124 set result [gdb_has_argv0_1 $exe]
5131 && ([istarget *-*-linux*]
5132 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5133 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5134 || [istarget *-*-openbsd*]
5135 || [istarget *-*-darwin*]
5136 || [istarget *-*-solaris*]
5137 || [istarget *-*-aix*]
5138 || [istarget *-*-gnu*]
5139 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5140 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5141 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5142 || [istarget *-*-symbianelf*]
5143 || [istarget *-*-osf*]
5144 || [istarget *-*-dicos*]
5145 || [istarget *-*-nto*]
5146 || [istarget *-*-*vms*]
5147 || [istarget *-*-lynx*178]) } {
5148 fail "argv\[0\] should be available on this target"
5154 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5155 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5156 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5157 # the name of a debuginfo only file. This file will be stored in the same
5160 # Functions for separate debug info testing
5162 # starting with an executable:
5163 # foo --> original executable
5165 # at the end of the process we have:
5166 # foo.stripped --> foo w/o debug info
5167 # foo.debug --> foo's debug info
5168 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5170 # Fetch the build id from the file.
5171 # Returns "" if there is none.
5173 proc get_build_id { filename } {
5174 if { ([istarget "*-*-mingw*"]
5175 || [istarget *-*-cygwin*]) } {
5176 set objdump_program [gdb_find_objdump]
5177 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5178 verbose "result is $result"
5179 verbose "output is $output"
5185 set tmp [standard_output_file "${filename}-tmp"]
5186 set objcopy_program [gdb_find_objcopy]
5187 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5188 verbose "result is $result"
5189 verbose "output is $output"
5194 fconfigure $fi -translation binary
5195 # Skip the NOTE header.
5200 if ![string compare $data ""] then {
5203 # Convert it to hex.
5204 binary scan $data H* data
5209 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5210 # converted to the form: .build-id/ab/cdef1234...89.debug
5211 # Return "" if no build-id found.
5212 proc build_id_debug_filename_get { filename } {
5213 set data [get_build_id $filename]
5214 if { $data == "" } {
5217 regsub {^..} $data {\0/} data
5218 return ".build-id/${data}.debug"
5221 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5222 # list of optional flags. The only currently supported flag is no-main,
5223 # which removes the symbol entry for main from the separate debug file.
5225 # Function returns zero on success. Function will return non-zero failure code
5226 # on some targets not supporting separate debug info (such as i386-msdos).
5228 proc gdb_gnu_strip_debug { dest args } {
5230 # Use the first separate debug info file location searched by GDB so the
5231 # run cannot be broken by some stale file searched with higher precedence.
5232 set debug_file "${dest}.debug"
5234 set strip_to_file_program [transform strip]
5235 set objcopy_program [gdb_find_objcopy]
5237 set debug_link [file tail $debug_file]
5238 set stripped_file "${dest}.stripped"
5240 # Get rid of the debug info, and store result in stripped_file
5241 # something like gdb/testsuite/gdb.base/blah.stripped.
5242 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5243 verbose "result is $result"
5244 verbose "output is $output"
5249 # Workaround PR binutils/10802:
5250 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5251 set perm [file attributes ${dest} -permissions]
5252 file attributes ${stripped_file} -permissions $perm
5254 # Get rid of everything but the debug info, and store result in debug_file
5255 # This will be in the .debug subdirectory, see above.
5256 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5257 verbose "result is $result"
5258 verbose "output is $output"
5263 # If no-main is passed, strip the symbol for main from the separate
5264 # file. This is to simulate the behavior of elfutils's eu-strip, which
5265 # leaves the symtab in the original file only. There's no way to get
5266 # objcopy or strip to remove the symbol table without also removing the
5267 # debugging sections, so this is as close as we can get.
5268 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5269 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5270 verbose "result is $result"
5271 verbose "output is $output"
5275 file delete "${debug_file}"
5276 file rename "${debug_file}-tmp" "${debug_file}"
5279 # Link the two previous output files together, adding the .gnu_debuglink
5280 # section to the stripped_file, containing a pointer to the debug_file,
5281 # save the new file in dest.
5282 # This will be the regular executable filename, in the usual location.
5283 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5284 verbose "result is $result"
5285 verbose "output is $output"
5290 # Workaround PR binutils/10802:
5291 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5292 set perm [file attributes ${stripped_file} -permissions]
5293 file attributes ${dest} -permissions $perm
5298 # Test the output of GDB_COMMAND matches the pattern obtained
5299 # by concatenating all elements of EXPECTED_LINES. This makes
5300 # it possible to split otherwise very long string into pieces.
5301 # If third argument is not empty, it's used as the name of the
5302 # test to be printed on pass/fail.
5303 proc help_test_raw { gdb_command expected_lines args } {
5304 set message $gdb_command
5305 if [llength $args]>0 then {
5306 set message [lindex $args 0]
5308 set expected_output [join $expected_lines ""]
5309 gdb_test "${gdb_command}" "${expected_output}" $message
5312 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5313 # are regular expressions that should match the beginning of output,
5314 # before the list of commands in that class. The presence of
5315 # command list and standard epilogue will be tested automatically.
5316 # Notice that the '[' and ']' characters don't need to be escaped for strings
5317 # wrapped in {} braces.
5318 proc test_class_help { command_class expected_initial_lines args } {
5320 "List of commands\:.*[\r\n]+"
5321 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5322 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5323 "Command name abbreviations are allowed if unambiguous\."
5325 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5327 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5330 # COMMAND_LIST should have either one element -- command to test, or
5331 # two elements -- abbreviated command to test, and full command the first
5332 # element is abbreviation of.
5333 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5334 # are regular expressions that should match the beginning of output,
5335 # before the list of subcommands. The presence of
5336 # subcommand list and standard epilogue will be tested automatically.
5337 proc test_prefix_command_help { command_list expected_initial_lines args } {
5338 set command [lindex $command_list 0]
5339 if {[llength $command_list]>1} {
5340 set full_command [lindex $command_list 1]
5342 set full_command $command
5344 # Use 'list' and not just {} because we want variables to
5345 # be expanded in this list.
5346 set l_stock_body [list\
5347 "List of $full_command subcommands\:.*\[\r\n\]+"\
5348 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5349 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5350 "Command name abbreviations are allowed if unambiguous\."]
5351 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5352 if {[llength $args]>0} {
5353 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5355 help_test_raw "help ${command}" $l_entire_body
5359 # Build executable named EXECUTABLE from specifications that allow
5360 # different options to be passed to different sub-compilations.
5361 # TESTNAME is the name of the test; this is passed to 'untested' if
5363 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5364 # contains the option "pthreads", then gdb_compile_pthreads is used.
5365 # ARGS is a flat list of source specifications, of the form:
5366 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5367 # Each SOURCE is compiled to an object file using its OPTIONS,
5368 # using gdb_compile.
5369 # Returns 0 on success, -1 on failure.
5370 proc build_executable_from_specs {testname executable options args} {
5374 set binfile [standard_output_file $executable]
5377 if { [lsearch -exact $options "c++"] >= 0 } {
5378 set info_options "c++"
5380 if [get_compiler_info ${info_options}] {
5384 set func gdb_compile
5385 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5386 if {$func_index != -1} {
5387 set func "${func}_[lindex $options $func_index]"
5390 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5391 # parameter. They also requires $sources while gdb_compile and
5392 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5393 if [string match gdb_compile_shlib* $func] {
5395 foreach {s local_options} $args {
5396 if { [regexp "^/" "$s"] } then {
5397 lappend sources_path "$s"
5399 lappend sources_path "$srcdir/$subdir/$s"
5402 set ret [$func $sources_path "${binfile}" $options]
5403 } elseif {[lsearch -exact $options rust] != -1} {
5405 foreach {s local_options} $args {
5406 if { [regexp "^/" "$s"] } then {
5407 lappend sources_path "$s"
5409 lappend sources_path "$srcdir/$subdir/$s"
5412 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5416 foreach {s local_options} $args {
5417 if { ! [regexp "^/" "$s"] } then {
5418 set s "$srcdir/$subdir/$s"
5420 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5424 lappend objects "${binfile}${i}.o"
5427 set ret [$func $objects "${binfile}" executable $options]
5437 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5438 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5439 # to pass to untested, if something is wrong. OPTIONS are passed
5440 # to gdb_compile directly.
5441 proc build_executable { testname executable {sources ""} {options {debug}} } {
5442 if {[llength $sources]==0} {
5443 set sources ${executable}.c
5446 set arglist [list $testname $executable $options]
5447 foreach source $sources {
5448 lappend arglist $source $options
5451 return [eval build_executable_from_specs $arglist]
5454 # Starts fresh GDB binary and loads an optional executable into GDB.
5455 # Usage: clean_restart [executable]
5456 # EXECUTABLE is the basename of the binary.
5458 proc clean_restart { args } {
5462 if { [llength $args] > 1 } {
5463 error "bad number of args: [llength $args]"
5468 gdb_reinitialize_dir $srcdir/$subdir
5470 if { [llength $args] >= 1 } {
5471 set executable [lindex $args 0]
5472 set binfile [standard_output_file ${executable}]
5477 # Prepares for testing by calling build_executable_full, then
5479 # TESTNAME is the name of the test.
5480 # Each element in ARGS is a list of the form
5481 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5482 # These are passed to build_executable_from_specs, which see.
5483 # The last EXECUTABLE is passed to clean_restart.
5484 # Returns 0 on success, non-zero on failure.
5485 proc prepare_for_testing_full {testname args} {
5486 foreach spec $args {
5487 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5490 set executable [lindex $spec 0]
5492 clean_restart $executable
5496 # Prepares for testing, by calling build_executable, and then clean_restart.
5497 # Please refer to build_executable for parameter description.
5498 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5500 if {[build_executable $testname $executable $sources $options] == -1} {
5503 clean_restart $executable
5508 proc get_valueof { fmt exp default } {
5511 set test "get valueof \"${exp}\""
5513 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5514 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5515 set val $expect_out(1,string)
5519 fail "$test (timeout)"
5525 proc get_integer_valueof { exp default } {
5528 set test "get integer valueof \"${exp}\""
5530 gdb_test_multiple "print /d ${exp}" "$test" {
5531 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5532 set val $expect_out(1,string)
5536 fail "$test (timeout)"
5542 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5543 # (using "print /x"). DEFAULT is used as fallback if print fails.
5544 # TEST is the test message to use. If can be ommitted, in which case
5545 # a test message is built from EXP.
5547 proc get_hexadecimal_valueof { exp default {test ""} } {
5551 set test "get hexadecimal valueof \"${exp}\""
5555 gdb_test_multiple "print /x ${exp}" $test {
5556 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5557 set val $expect_out(1,string)
5564 proc get_sizeof { type default } {
5565 return [get_integer_valueof "sizeof (${type})" $default]
5568 proc get_target_charset { } {
5571 gdb_test_multiple "show target-charset" "" {
5572 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5573 return $expect_out(1,string)
5575 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5576 return $expect_out(1,string)
5580 # Pick a reasonable default.
5581 warning "Unable to read target-charset."
5585 # Get the address of VAR.
5587 proc get_var_address { var } {
5588 global gdb_prompt hex
5590 # Match output like:
5592 # $5 = (int (*)()) 0
5593 # $6 = (int (*)()) 0x24 <function_bar>
5595 gdb_test_multiple "print &${var}" "get address of ${var}" {
5596 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5598 pass "get address of ${var}"
5599 if { $expect_out(1,string) == "0" } {
5602 return $expect_out(1,string)
5609 # Get the current value for remotetimeout and return it.
5610 proc get_remotetimeout { } {
5614 gdb_test_multiple "show remotetimeout" "" {
5615 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5616 return $expect_out(1,string)
5620 # Pick the default that gdb uses
5621 warning "Unable to read remotetimeout"
5625 # Set the remotetimeout to the specified timeout. Nothing is returned.
5626 proc set_remotetimeout { timeout } {
5629 gdb_test_multiple "set remotetimeout $timeout" "" {
5630 -re "$gdb_prompt $" {
5631 verbose "Set remotetimeout to $timeout\n"
5636 # ROOT and FULL are file names. Returns the relative path from ROOT
5637 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5638 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5641 proc relative_filename {root full} {
5642 set root_split [file split $root]
5643 set full_split [file split $full]
5645 set len [llength $root_split]
5647 if {[eval file join $root_split]
5648 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5649 error "$full not a subdir of $root"
5652 return [eval file join [lrange $full_split $len end]]
5655 # Log gdb command line and script if requested.
5656 if {[info exists TRANSCRIPT]} {
5657 rename send_gdb real_send_gdb
5658 rename remote_spawn real_remote_spawn
5659 rename remote_close real_remote_close
5661 global gdb_transcript
5662 set gdb_transcript ""
5664 global gdb_trans_count
5665 set gdb_trans_count 1
5667 proc remote_spawn {args} {
5668 global gdb_transcript gdb_trans_count outdir
5670 if {$gdb_transcript != ""} {
5671 close $gdb_transcript
5673 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5674 puts $gdb_transcript [lindex $args 1]
5675 incr gdb_trans_count
5677 return [uplevel real_remote_spawn $args]
5680 proc remote_close {args} {
5681 global gdb_transcript
5683 if {$gdb_transcript != ""} {
5684 close $gdb_transcript
5685 set gdb_transcript ""
5688 return [uplevel real_remote_close $args]
5691 proc send_gdb {args} {
5692 global gdb_transcript
5694 if {$gdb_transcript != ""} {
5695 puts -nonewline $gdb_transcript [lindex $args 0]
5698 return [uplevel real_send_gdb $args]
5702 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5703 if {[info exists GDB_PARALLEL]} {
5704 if {[is_remote host]} {
5708 [make_gdb_parallel_path outputs] \
5709 [make_gdb_parallel_path temp] \
5710 [make_gdb_parallel_path cache]
5714 proc core_find {binfile {deletefiles {}} {arg ""}} {
5715 global objdir subdir
5717 set destcore "$binfile.core"
5718 file delete $destcore
5720 # Create a core file named "$destcore" rather than just "core", to
5721 # avoid problems with sys admin types that like to regularly prune all
5722 # files named "core" from the system.
5724 # Arbitrarily try setting the core size limit to "unlimited" since
5725 # this does not hurt on systems where the command does not work and
5726 # allows us to generate a core on systems where it does.
5728 # Some systems append "core" to the name of the program; others append
5729 # the name of the program to "core"; still others (like Linux, as of
5730 # May 2003) create cores named "core.PID". In the latter case, we
5731 # could have many core files lying around, and it may be difficult to
5732 # tell which one is ours, so let's run the program in a subdirectory.
5734 set coredir [standard_output_file coredir.[getpid]]
5736 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5737 # remote_exec host "${binfile}"
5738 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5739 if [remote_file build exists $i] {
5740 remote_exec build "mv $i $destcore"
5744 # Check for "core.PID".
5745 if { $found == 0 } {
5746 set names [glob -nocomplain -directory $coredir core.*]
5747 if {[llength $names] == 1} {
5748 set corefile [file join $coredir [lindex $names 0]]
5749 remote_exec build "mv $corefile $destcore"
5753 if { $found == 0 } {
5754 # The braindamaged HPUX shell quits after the ulimit -c above
5755 # without executing ${binfile}. So we try again without the
5756 # ulimit here if we didn't find a core file above.
5757 # Oh, I should mention that any "braindamaged" non-Unix system has
5758 # the same problem. I like the cd bit too, it's really neat'n stuff.
5759 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5760 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5761 if [remote_file build exists $i] {
5762 remote_exec build "mv $i $destcore"
5768 # Try to clean up after ourselves.
5769 foreach deletefile $deletefiles {
5770 remote_file build delete [file join $coredir $deletefile]
5772 remote_exec build "rmdir $coredir"
5774 if { $found == 0 } {
5775 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5781 # gdb_target_symbol_prefix compiles a test program and then examines
5782 # the output from objdump to determine the prefix (such as underscore)
5783 # for linker symbol prefixes.
5785 gdb_caching_proc gdb_target_symbol_prefix {
5786 # Set up and compile a simple test program...
5787 set src [standard_temp_file main[pid].c]
5788 set exe [standard_temp_file main[pid].x]
5790 gdb_produce_source $src {
5796 verbose "compiling testfile $src" 2
5797 set compile_flags {debug nowarnings quiet}
5798 set lines [gdb_compile $src $exe executable $compile_flags]
5802 if ![string match "" $lines] then {
5803 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5805 set objdump_program [gdb_find_objdump]
5806 set result [catch "exec $objdump_program --syms $exe" output]
5809 && ![regexp -lineanchor \
5810 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5811 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5821 # gdb_target_symbol returns the provided symbol with the correct prefix
5822 # prepended. (See gdb_target_symbol_prefix, above.)
5824 proc gdb_target_symbol { symbol } {
5825 set prefix [gdb_target_symbol_prefix]
5826 return "${prefix}${symbol}"
5829 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5830 # added to gdb_compile options to define the C-preprocessor macro
5831 # SYMBOL_PREFIX with a value that can be prepended to symbols
5832 # for targets which require a prefix, such as underscore.
5834 # This version (_asm) defines the prefix without double quotes
5835 # surrounding the prefix. It is used to define the macro
5836 # SYMBOL_PREFIX for assembly language files. Another version, below,
5837 # is used for symbols in inline assembler in C/C++ files.
5839 # The lack of quotes in this version (_asm) makes it possible to
5840 # define supporting macros in the .S file. (The version which
5841 # uses quotes for the prefix won't work for such files since it's
5842 # impossible to define a quote-stripping macro in C.)
5844 # It's possible to use this version (_asm) for C/C++ source files too,
5845 # but a string is usually required in such files; providing a version
5846 # (no _asm) which encloses the prefix with double quotes makes it
5847 # somewhat easier to define the supporting macros in the test case.
5849 proc gdb_target_symbol_prefix_flags_asm {} {
5850 set prefix [gdb_target_symbol_prefix]
5851 if {$prefix ne ""} {
5852 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5858 # gdb_target_symbol_prefix_flags returns the same string as
5859 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5860 # enclosed in double quotes if there is a prefix.
5862 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5863 # extended discussion.
5865 proc gdb_target_symbol_prefix_flags {} {
5866 set prefix [gdb_target_symbol_prefix]
5867 if {$prefix ne ""} {
5868 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5874 # A wrapper for 'remote_exec host' that passes or fails a test.
5875 # Returns 0 if all went well, nonzero on failure.
5876 # TEST is the name of the test, other arguments are as for remote_exec.
5878 proc run_on_host { test program args } {
5879 verbose -log "run_on_host: $program $args"
5880 # remote_exec doesn't work properly if the output is set but the
5881 # input is the empty string -- so replace an empty input with
5883 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5884 set args [lreplace $args 1 1 "/dev/null"]
5886 set result [eval remote_exec host [list $program] $args]
5887 verbose "result is $result"
5888 set status [lindex $result 0]
5889 set output [lindex $result 1]
5894 verbose -log "run_on_host failed: $output"
5900 # Return non-zero if "board_info debug_flags" mentions Fission.
5901 # http://gcc.gnu.org/wiki/DebugFission
5902 # Fission doesn't support everything yet.
5903 # This supports working around bug 15954.
5905 proc using_fission { } {
5906 set debug_flags [board_info [target_info name] debug_flags]
5907 return [regexp -- "-gsplit-dwarf" $debug_flags]
5910 # Search the caller's ARGS list and set variables according to the list of
5911 # valid options described by ARGSET.
5913 # The first member of each one- or two-element list in ARGSET defines the
5914 # name of a variable that will be added to the caller's scope.
5916 # If only one element is given to describe an option, it the value is
5917 # 0 if the option is not present in (the caller's) ARGS or 1 if
5920 # If two elements are given, the second element is the default value of
5921 # the variable. This is then overwritten if the option exists in ARGS.
5923 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5924 # any optional components.
5927 # proc myproc {foo args} {
5928 # parse_args {{bar} {baz "abc"} {qux}}
5931 # myproc ABC -bar -baz DEF peanut butter
5932 # will define the following variables in myproc:
5933 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5934 # args will be the list {peanut butter}
5936 proc parse_args { argset } {
5939 foreach argument $argset {
5940 if {[llength $argument] == 1} {
5941 # No default specified, so we assume that we should set
5942 # the value to 1 if the arg is present and 0 if it's not.
5943 # It is assumed that no value is given with the argument.
5944 set result [lsearch -exact $args "-$argument"]
5945 if {$result != -1} then {
5946 uplevel 1 [list set $argument 1]
5947 set args [lreplace $args $result $result]
5949 uplevel 1 [list set $argument 0]
5951 } elseif {[llength $argument] == 2} {
5952 # There are two items in the argument. The second is a
5953 # default value to use if the item is not present.
5954 # Otherwise, the variable is set to whatever is provided
5955 # after the item in the args.
5956 set arg [lindex $argument 0]
5957 set result [lsearch -exact $args "-[lindex $arg 0]"]
5958 if {$result != -1} then {
5959 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5960 set args [lreplace $args $result [expr $result+1]]
5962 uplevel 1 [list set $arg [lindex $argument 1]]
5965 error "Badly formatted argument \"$argument\" in argument set"
5969 # The remaining args should be checked to see that they match the
5970 # number of items expected to be passed into the procedure...
5973 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5974 # return that string.
5976 proc capture_command_output { command prefix } {
5980 set output_string ""
5981 gdb_test_multiple "$command" "capture_command_output for $command" {
5982 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5983 set output_string $expect_out(1,string)
5986 return $output_string
5989 # A convenience function that joins all the arguments together, with a
5990 # regexp that matches exactly one end of line in between each argument.
5991 # This function is ideal to write the expected output of a GDB command
5992 # that generates more than a couple of lines, as this allows us to write
5993 # each line as a separate string, which is easier to read by a human
5996 proc multi_line { args } {
5997 return [join $args "\r\n"]
6000 # Always load compatibility stuff.