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 # A regular expression that matches a value history number.
122 set valnum_re "\\\$$decimal"
124 ### Only procedures should come after this point.
127 # gdb_version -- extract and print the version number of GDB
129 proc default_gdb_version {} {
131 global INTERNAL_GDBFLAGS GDBFLAGS
135 if {[info exists inotify_pid]} {
136 eval exec kill $inotify_pid
139 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
140 set tmp [lindex $output 1]
142 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
143 if ![is_remote host] {
144 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
146 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
150 proc gdb_version { } {
151 return [default_gdb_version]
155 # gdb_unload -- unload a file if one is loaded
156 # Return 0 on success, -1 on error.
165 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
166 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
167 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
171 -re "Discard symbol table from .*y or n.*$" {
175 -re "$gdb_prompt $" {}
177 perror "couldn't unload file in $GDB (timeout)."
184 # Many of the tests depend on setting breakpoints at various places and
185 # running until that breakpoint is reached. At times, we want to start
186 # with a clean-slate with respect to breakpoints, so this utility proc
187 # lets us do this without duplicating this code everywhere.
190 proc delete_breakpoints {} {
193 # we need a larger timeout value here or this thing just confuses
194 # itself. May need a better implementation if possible. - guo
198 set msg "delete all breakpoints in delete_breakpoints"
200 gdb_test_multiple "delete breakpoints" "$msg" {
201 -re "Delete all breakpoints.*y or n.*$" {
205 -re "$gdb_prompt $" {
211 # Confirm with "info breakpoints".
213 set msg "info breakpoints"
214 gdb_test_multiple $msg $msg {
215 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
218 -re "$gdb_prompt $" {
224 perror "breakpoints not deleted"
228 # Generic run command.
230 # The second pattern below matches up to the first newline *only*.
231 # Using ``.*$'' could swallow up output that we attempt to match
234 # N.B. This function does not wait for gdb to return to the prompt,
235 # that is the caller's responsibility.
237 proc gdb_run_cmd {args} {
238 global gdb_prompt use_gdb_stub
240 foreach command [gdb_init_commands] {
241 send_gdb "$command\n"
243 -re "$gdb_prompt $" { }
245 perror "gdb_init_command for target failed"
252 if [target_info exists gdb,do_reload_on_run] {
253 if { [gdb_reload] != 0 } {
256 send_gdb "continue\n"
258 -re "Continu\[^\r\n\]*\[\r\n\]" {}
264 if [target_info exists gdb,start_symbol] {
265 set start [target_info gdb,start_symbol]
269 send_gdb "jump *$start\n"
271 while { $start_attempt } {
272 # Cap (re)start attempts at three to ensure that this loop
273 # always eventually fails. Don't worry about trying to be
274 # clever and not send a command when it has failed.
275 if [expr $start_attempt > 3] {
276 perror "Jump to start() failed (retry count exceeded)"
279 set start_attempt [expr $start_attempt + 1]
281 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
284 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
285 perror "Can't find start symbol to run in gdb_run"
288 -re "No symbol \"start\" in current.*$gdb_prompt $" {
289 send_gdb "jump *_start\n"
291 -re "No symbol.*context.*$gdb_prompt $" {
294 -re "Line.* Jump anyway.*y or n. $" {
297 -re "The program is not being run.*$gdb_prompt $" {
298 if { [gdb_reload] != 0 } {
301 send_gdb "jump *$start\n"
304 perror "Jump to start() failed (timeout)"
312 if [target_info exists gdb,do_reload_on_run] {
313 if { [gdb_reload] != 0 } {
317 send_gdb "run $args\n"
318 # This doesn't work quite right yet.
319 # Use -notransfer here so that test cases (like chng-sym.exp)
320 # may test for additional start-up messages.
322 -re "The program .* has been started already.*y or n. $" {
326 -notransfer -re "Starting program: \[^\r\n\]*" {}
327 -notransfer -re "$gdb_prompt $" {
328 # There is no more input expected.
333 # Generic start command. Return 0 if we could start the program, -1
336 # N.B. This function does not wait for gdb to return to the prompt,
337 # that is the caller's responsibility.
339 proc gdb_start_cmd {args} {
340 global gdb_prompt use_gdb_stub
342 foreach command [gdb_init_commands] {
343 send_gdb "$command\n"
345 -re "$gdb_prompt $" { }
347 perror "gdb_init_command for target failed"
357 send_gdb "start $args\n"
358 # Use -notransfer here so that test cases (like chng-sym.exp)
359 # may test for additional start-up messages.
361 -re "The program .* has been started already.*y or n. $" {
365 -notransfer -re "Starting program: \[^\r\n\]*" {
372 # Set a breakpoint at FUNCTION. If there is an additional argument it is
373 # a list of options; the supported options are allow-pending, temporary,
374 # message, no-message, and passfail.
375 # The result is 1 for success, 0 for failure.
377 # Note: The handling of message vs no-message is messed up, but it's based
378 # on historical usage. By default this function does not print passes,
380 # no-message: turns off printing of fails (and passes, but they're already off)
381 # message: turns on printing of passes (and fails, but they're already on)
383 proc gdb_breakpoint { function args } {
387 set pending_response n
388 if {[lsearch -exact $args allow-pending] != -1} {
389 set pending_response y
392 set break_command "break"
393 set break_message "Breakpoint"
394 if {[lsearch -exact $args temporary] != -1} {
395 set break_command "tbreak"
396 set break_message "Temporary breakpoint"
401 set no_message_loc [lsearch -exact $args no-message]
402 set message_loc [lsearch -exact $args message]
403 # The last one to appear in args wins.
404 if { $no_message_loc > $message_loc } {
406 } elseif { $message_loc > $no_message_loc } {
410 set test_name "setting breakpoint at $function"
412 send_gdb "$break_command $function\n"
413 # The first two regexps are what we get with -g, the third is without -g.
415 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
416 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
417 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
418 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
419 if {$pending_response == "n"} {
426 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
427 send_gdb "$pending_response\n"
430 -re "A problem internal to GDB has been detected" {
432 fail "$test_name (GDB internal error)"
434 gdb_internal_error_resync
437 -re "$gdb_prompt $" {
445 fail "$test_name (eof)"
451 fail "$test_name (timeout)"
462 # Set breakpoint at function and run gdb until it breaks there.
463 # Since this is the only breakpoint that will be set, if it stops
464 # at a breakpoint, we will assume it is the one we want. We can't
465 # just compare to "function" because it might be a fully qualified,
466 # single quoted C++ function specifier.
468 # If there are additional arguments, pass them to gdb_breakpoint.
469 # We recognize no-message/message ourselves.
470 # The default is no-message.
471 # no-message is messed up here, like gdb_breakpoint: to preserve
472 # historical usage fails are always printed by default.
473 # no-message: turns off printing of fails (and passes, but they're already off)
474 # message: turns on printing of passes (and fails, but they're already on)
476 proc runto { function args } {
482 # Default to "no-message".
483 set args "no-message $args"
487 set no_message_loc [lsearch -exact $args no-message]
488 set message_loc [lsearch -exact $args message]
489 # The last one to appear in args wins.
490 if { $no_message_loc > $message_loc } {
492 } elseif { $message_loc > $no_message_loc } {
496 set test_name "running to $function in runto"
498 # We need to use eval here to pass our varargs args to gdb_breakpoint
499 # which is also a varargs function.
500 # But we also have to be careful because $function may have multiple
501 # elements, and we don't want Tcl to move the remaining elements after
502 # the first to $args. That is why $function is wrapped in {}.
503 if ![eval gdb_breakpoint {$function} $args] {
509 # the "at foo.c:36" output we get with -g.
510 # the "in func" output we get without -g.
512 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
518 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
524 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
526 unsupported "Non-stop mode not supported"
530 -re ".*A problem internal to GDB has been detected" {
532 fail "$test_name (GDB internal error)"
534 gdb_internal_error_resync
537 -re "$gdb_prompt $" {
545 fail "$test_name (eof)"
551 fail "$test_name (timeout)"
562 # Ask gdb to run until we hit a breakpoint at main.
564 # N.B. This function deletes all existing breakpoints.
565 # If you don't want that, use gdb_start_cmd.
567 proc runto_main { } {
568 return [runto main no-message]
571 ### Continue, and expect to hit a breakpoint.
572 ### Report a pass or fail, depending on whether it seems to have
573 ### worked. Use NAME as part of the test name; each call to
574 ### continue_to_breakpoint should use a NAME which is unique within
576 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
578 set full_name "continue to breakpoint: $name"
580 gdb_test_multiple "continue" $full_name {
581 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
588 # gdb_internal_error_resync:
590 # Answer the questions GDB asks after it reports an internal error
591 # until we get back to a GDB prompt. Decline to quit the debugging
592 # session, and decline to create a core file. Return non-zero if the
595 # This procedure just answers whatever questions come up until it sees
596 # a GDB prompt; it doesn't require you to have matched the input up to
597 # any specific point. However, it only answers questions it sees in
598 # the output itself, so if you've matched a question, you had better
599 # answer it yourself before calling this.
601 # You can use this function thus:
605 # -re ".*A problem internal to GDB has been detected" {
606 # gdb_internal_error_resync
611 proc gdb_internal_error_resync {} {
614 verbose -log "Resyncing due to internal error."
617 while {$count < 10} {
619 -re "Quit this debugging session\\? \\(y or n\\) $" {
623 -re "Create a core file of GDB\\? \\(y or n\\) $" {
627 -re "$gdb_prompt $" {
628 # We're resynchronized.
632 perror "Could not resync from internal error (timeout)"
637 perror "Could not resync from internal error (resync count exceeded)"
642 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
643 # Send a command to gdb; test the result.
645 # COMMAND is the command to execute, send to GDB with send_gdb. If
646 # this is the null string no command is sent.
647 # MESSAGE is a message to be printed with the built-in failure patterns
648 # if one of them matches. If MESSAGE is empty COMMAND will be used.
649 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
650 # patterns. Pattern elements will be evaluated in the caller's
651 # context; action elements will be executed in the caller's context.
652 # Unlike patterns for gdb_test, these patterns should generally include
653 # the final newline and prompt.
656 # 1 if the test failed, according to a built-in failure pattern
657 # 0 if only user-supplied patterns matched
658 # -1 if there was an internal error.
660 # You can use this function thus:
662 # gdb_test_multiple "print foo" "test foo" {
663 # -re "expected output 1" {
666 # -re "expected output 2" {
671 # Like with "expect", you can also specify the spawn id to match with
672 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
673 # $gdb_spawn_id. The former matches inferior I/O, while the latter
674 # matches GDB I/O. E.g.:
676 # send_inferior "hello\n"
677 # gdb_test_multiple "continue" "test echo" {
678 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
681 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
682 # fail "hit breakpoint"
686 # The standard patterns, such as "Inferior exited..." and "A problem
687 # ...", all being implicitly appended to that list. These are always
688 # expected from $gdb_spawn_id. IOW, callers do not need to worry
689 # about resetting "-i" back to $gdb_spawn_id explicitly.
691 proc gdb_test_multiple { command message user_code } {
692 global verbose use_gdb_stub
693 global gdb_prompt pagination_prompt
696 global inferior_exited_re
697 upvar timeout timeout
698 upvar expect_out expect_out
701 if { $message == "" } {
705 if [string match "*\[\r\n\]" $command] {
706 error "Invalid trailing newline in \"$message\" test"
709 if [string match "*\[\r\n\]*" $message] {
710 error "Invalid newline in \"$message\" test"
714 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
716 error "gdbserver does not support $command without extended-remote"
719 # TCL/EXPECT WART ALERT
720 # Expect does something very strange when it receives a single braced
721 # argument. It splits it along word separators and performs substitutions.
722 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
723 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
724 # double-quoted list item, "\[ab\]" is just a long way of representing
725 # "[ab]", because the backslashes will be removed by lindex.
727 # Unfortunately, there appears to be no easy way to duplicate the splitting
728 # that expect will do from within TCL. And many places make use of the
729 # "\[0-9\]" construct, so we need to support that; and some places make use
730 # of the "[func]" construct, so we need to support that too. In order to
731 # get this right we have to substitute quoted list elements differently
732 # from braced list elements.
734 # We do this roughly the same way that Expect does it. We have to use two
735 # lists, because if we leave unquoted newlines in the argument to uplevel
736 # they'll be treated as command separators, and if we escape newlines
737 # we mangle newlines inside of command blocks. This assumes that the
738 # input doesn't contain a pattern which contains actual embedded newlines
741 regsub -all {\n} ${user_code} { } subst_code
742 set subst_code [uplevel list $subst_code]
744 set processed_code ""
746 set expecting_action 0
748 foreach item $user_code subst_item $subst_code {
749 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
750 lappend processed_code $item
753 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
754 lappend processed_code $item
757 if { $item == "-timeout" || $item == "-i" } {
759 lappend processed_code $item
762 if { $expecting_arg } {
764 lappend processed_code $subst_item
767 if { $expecting_action } {
768 lappend processed_code "uplevel [list $item]"
769 set expecting_action 0
770 # Cosmetic, no effect on the list.
771 append processed_code "\n"
774 set expecting_action 1
775 lappend processed_code $subst_item
776 if {$patterns != ""} {
779 append patterns "\"$subst_item\""
782 # Also purely cosmetic.
783 regsub -all {\r} $patterns {\\r} patterns
784 regsub -all {\n} $patterns {\\n} patterns
787 send_user "Sending \"$command\" to gdb\n"
788 send_user "Looking to match \"$patterns\"\n"
789 send_user "Message is \"$message\"\n"
793 set string "${command}\n"
794 if { $command != "" } {
795 set multi_line_re "\[\r\n\] *>"
796 while { "$string" != "" } {
797 set foo [string first "\n" "$string"]
798 set len [string length "$string"]
799 if { $foo < [expr $len - 1] } {
800 set str [string range "$string" 0 $foo]
801 if { [send_gdb "$str"] != "" } {
804 if { ! $suppress_flag } {
805 perror "Couldn't send $command to GDB."
810 # since we're checking if each line of the multi-line
811 # command are 'accepted' by GDB here,
812 # we need to set -notransfer expect option so that
813 # command output is not lost for pattern matching
816 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
817 timeout { verbose "partial: timeout" 3 }
819 set string [string range "$string" [expr $foo + 1] end]
820 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
825 if { "$string" != "" } {
826 if { [send_gdb "$string"] != "" } {
829 if { ! $suppress_flag } {
830 perror "Couldn't send $command to GDB."
839 -re ".*A problem internal to GDB has been detected" {
840 fail "$message (GDB internal error)"
841 gdb_internal_error_resync
844 -re "\\*\\*\\* DOSEXIT code.*" {
845 if { $message != "" } {
848 gdb_suppress_entire_file "GDB died"
852 append code $processed_code
854 # Reset the spawn id, in case the processed code used -i.
857 -re "Ending remote debugging.*$gdb_prompt $" {
858 if ![isnative] then {
859 warning "Can`t communicate to remote target."
865 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
866 perror "Undefined command \"$command\"."
870 -re "Ambiguous command.*$gdb_prompt $" {
871 perror "\"$command\" is not a unique command name."
875 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
876 if ![string match "" $message] then {
877 set errmsg "$message (the program exited)"
879 set errmsg "$command (the program exited)"
884 -re "$inferior_exited_re normally.*$gdb_prompt $" {
885 if ![string match "" $message] then {
886 set errmsg "$message (the program exited)"
888 set errmsg "$command (the program exited)"
893 -re "The program is not being run.*$gdb_prompt $" {
894 if ![string match "" $message] then {
895 set errmsg "$message (the program is no longer running)"
897 set errmsg "$command (the program is no longer running)"
902 -re "\r\n$gdb_prompt $" {
903 if ![string match "" $message] then {
908 -re "$pagination_prompt" {
910 perror "Window too small."
914 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
916 gdb_expect -re "$gdb_prompt $"
917 fail "$message (got interactive prompt)"
920 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
922 gdb_expect -re "$gdb_prompt $"
923 fail "$message (got breakpoint menu)"
927 # Patterns below apply to any spawn id specified.
930 perror "Process no longer exists"
931 if { $message != "" } {
937 perror "internal buffer is full."
942 if ![string match "" $message] then {
943 fail "$message (timeout)"
950 set code [catch {gdb_expect $code} string]
952 global errorInfo errorCode
953 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
954 } elseif {$code > 1} {
955 return -code $code $string
960 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
961 # Send a command to gdb; test the result.
963 # COMMAND is the command to execute, send to GDB with send_gdb. If
964 # this is the null string no command is sent.
965 # PATTERN is the pattern to match for a PASS, and must NOT include
966 # the \r\n sequence immediately before the gdb prompt. This argument
967 # may be omitted to just match the prompt, ignoring whatever output
969 # MESSAGE is an optional message to be printed. If this is
970 # omitted, then the pass/fail messages use the command string as the
971 # message. (If this is the empty string, then sometimes we don't
972 # call pass or fail at all; I don't understand this at all.)
973 # QUESTION is a question GDB may ask in response to COMMAND, like
975 # RESPONSE is the response to send if QUESTION appears.
978 # 1 if the test failed,
979 # 0 if the test passes,
980 # -1 if there was an internal error.
982 proc gdb_test { args } {
984 upvar timeout timeout
986 if [llength $args]>2 then {
987 set message [lindex $args 2]
989 set message [lindex $args 0]
991 set command [lindex $args 0]
992 set pattern [lindex $args 1]
994 if [llength $args]==5 {
995 set question_string [lindex $args 3]
996 set response_string [lindex $args 4]
998 set question_string "^FOOBAR$"
1001 return [gdb_test_multiple $command $message {
1002 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
1003 if ![string match "" $message] then {
1007 -re "(${question_string})$" {
1008 send_gdb "$response_string\n"
1014 # gdb_test_no_output COMMAND MESSAGE
1015 # Send a command to GDB and verify that this command generated no output.
1017 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1018 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1019 # the message. (If MESSAGE is the empty string, then sometimes we do not
1020 # call pass or fail at all; I don't understand this at all.)
1022 proc gdb_test_no_output { args } {
1024 set command [lindex $args 0]
1025 if [llength $args]>1 then {
1026 set message [lindex $args 1]
1028 set message $command
1031 set command_regex [string_to_regexp $command]
1032 gdb_test_multiple $command $message {
1033 -re "^$command_regex\r\n$gdb_prompt $" {
1034 if ![string match "" $message] then {
1041 # Send a command and then wait for a sequence of outputs.
1042 # This is useful when the sequence is long and contains ".*", a single
1043 # regexp to match the entire output can get a timeout much easier.
1045 # COMMAND is the command to send.
1046 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1047 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1048 # processed in order, and all must be present in the output.
1050 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1051 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1052 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1054 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1055 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1058 # 1 if the test failed,
1059 # 0 if the test passes,
1060 # -1 if there was an internal error.
1062 proc gdb_test_sequence { command test_name expected_output_list } {
1064 if { $test_name == "" } {
1065 set test_name $command
1067 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1068 send_gdb "$command\n"
1069 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1073 # Test that a command gives an error. For pass or fail, return
1074 # a 1 to indicate that more tests can proceed. However a timeout
1075 # is a serious error, generates a special fail message, and causes
1076 # a 0 to be returned to indicate that more tests are likely to fail
1079 proc test_print_reject { args } {
1083 if [llength $args]==2 then {
1084 set expectthis [lindex $args 1]
1086 set expectthis "should never match this bogus string"
1088 set sendthis [lindex $args 0]
1089 if $verbose>2 then {
1090 send_user "Sending \"$sendthis\" to gdb\n"
1091 send_user "Looking to match \"$expectthis\"\n"
1093 send_gdb "$sendthis\n"
1094 #FIXME: Should add timeout as parameter.
1096 -re "A .* in expression.*\\.*$gdb_prompt $" {
1097 pass "reject $sendthis"
1100 -re "Invalid syntax in expression.*$gdb_prompt $" {
1101 pass "reject $sendthis"
1104 -re "Junk after end of expression.*$gdb_prompt $" {
1105 pass "reject $sendthis"
1108 -re "Invalid number.*$gdb_prompt $" {
1109 pass "reject $sendthis"
1112 -re "Invalid character constant.*$gdb_prompt $" {
1113 pass "reject $sendthis"
1116 -re "No symbol table is loaded.*$gdb_prompt $" {
1117 pass "reject $sendthis"
1120 -re "No symbol .* in current context.*$gdb_prompt $" {
1121 pass "reject $sendthis"
1124 -re "Unmatched single quote.*$gdb_prompt $" {
1125 pass "reject $sendthis"
1128 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1129 pass "reject $sendthis"
1132 -re "$expectthis.*$gdb_prompt $" {
1133 pass "reject $sendthis"
1136 -re ".*$gdb_prompt $" {
1137 fail "reject $sendthis"
1141 fail "reject $sendthis (eof or timeout)"
1148 # Same as gdb_test, but the second parameter is not a regexp,
1149 # but a string that must match exactly.
1151 proc gdb_test_exact { args } {
1152 upvar timeout timeout
1154 set command [lindex $args 0]
1156 # This applies a special meaning to a null string pattern. Without
1157 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1158 # messages from commands that should have no output except a new
1159 # prompt. With this, only results of a null string will match a null
1162 set pattern [lindex $args 1]
1163 if [string match $pattern ""] {
1164 set pattern [string_to_regexp [lindex $args 0]]
1166 set pattern [string_to_regexp [lindex $args 1]]
1169 # It is most natural to write the pattern argument with only
1170 # embedded \n's, especially if you are trying to avoid Tcl quoting
1171 # problems. But gdb_expect really wants to see \r\n in patterns. So
1172 # transform the pattern here. First transform \r\n back to \n, in
1173 # case some users of gdb_test_exact already do the right thing.
1174 regsub -all "\r\n" $pattern "\n" pattern
1175 regsub -all "\n" $pattern "\r\n" pattern
1176 if [llength $args]==3 then {
1177 set message [lindex $args 2]
1179 set message $command
1182 return [gdb_test $command $pattern $message]
1185 # Wrapper around gdb_test_multiple that looks for a list of expected
1186 # output elements, but which can appear in any order.
1187 # CMD is the gdb command.
1188 # NAME is the name of the test.
1189 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1191 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1192 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1193 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1195 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1196 # of text per element and then strip trailing \r\n's.
1198 # gdb_test_list_exact "foo" "bar" \
1199 # "\[^\r\n\]+\[\r\n\]+" \
1202 # {expected result 1} \
1203 # {expected result 2} \
1206 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1209 set matches [lsort $result_match_list]
1211 gdb_test_multiple $cmd $name {
1212 "$cmd\[\r\n\]" { exp_continue }
1213 -re $elm_find_regexp {
1214 set str $expect_out(0,string)
1215 verbose -log "seen: $str" 3
1216 regexp -- $elm_extract_regexp $str elm_seen
1217 verbose -log "extracted: $elm_seen" 3
1218 lappend seen $elm_seen
1221 -re "$gdb_prompt $" {
1223 foreach got [lsort $seen] have $matches {
1224 if {![string equal $got $have]} {
1229 if {[string length $failed] != 0} {
1230 fail "$name ($failed not found)"
1238 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1239 # Send a command to gdb; expect inferior and gdb output.
1241 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1244 # INFERIOR_PATTERN is the pattern to match against inferior output.
1246 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1247 # include the \r\n sequence immediately before the gdb prompt, nor the
1248 # prompt. The default is empty.
1250 # Both inferior and gdb patterns must match for a PASS.
1252 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1255 # 1 if the test failed,
1256 # 0 if the test passes,
1257 # -1 if there was an internal error.
1260 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1261 global inferior_spawn_id gdb_spawn_id
1264 if {$message == ""} {
1265 set message $command
1268 set inferior_matched 0
1271 # Use an indirect spawn id list, and remove the inferior spawn id
1272 # from the expected output as soon as it matches, in case
1273 # $inferior_pattern happens to be a prefix of the resulting full
1274 # gdb pattern below (e.g., "\r\n").
1275 global gdb_test_stdio_spawn_id_list
1276 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1278 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1279 # then we may see gdb's output arriving before the inferior's
1281 set res [gdb_test_multiple $command $message {
1282 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1283 set inferior_matched 1
1284 if {!$gdb_matched} {
1285 set gdb_test_stdio_spawn_id_list ""
1289 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1291 if {!$inferior_matched} {
1299 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1306 # Issue a PASS and return true if evaluating CONDITION in the caller's
1307 # frame returns true, and issue a FAIL and return false otherwise.
1308 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1309 # omitted or is empty, then the pass/fail messages use the condition
1310 # string as the message.
1312 proc gdb_assert { condition {message ""} } {
1313 if { $message == ""} {
1314 set message $condition
1317 set res [uplevel 1 expr $condition]
1326 proc gdb_reinitialize_dir { subdir } {
1329 if [is_remote host] {
1334 -re "Reinitialize source path to empty.*y or n. " {
1337 -re "Source directories searched.*$gdb_prompt $" {
1338 send_gdb "dir $subdir\n"
1340 -re "Source directories searched.*$gdb_prompt $" {
1341 verbose "Dir set to $subdir"
1343 -re "$gdb_prompt $" {
1344 perror "Dir \"$subdir\" failed."
1348 -re "$gdb_prompt $" {
1349 perror "Dir \"$subdir\" failed."
1353 -re "$gdb_prompt $" {
1354 perror "Dir \"$subdir\" failed."
1360 # gdb_exit -- exit the GDB, killing the target program if necessary
1362 proc default_gdb_exit {} {
1364 global INTERNAL_GDBFLAGS GDBFLAGS
1366 global gdb_spawn_id inferior_spawn_id
1367 global inotify_log_file
1369 gdb_stop_suppressing_tests
1371 if ![info exists gdb_spawn_id] {
1375 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1377 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1378 set fd [open $inotify_log_file]
1379 set data [read -nonewline $fd]
1382 if {[string compare $data ""] != 0} {
1383 warning "parallel-unsafe file creations noticed"
1386 set fd [open $inotify_log_file w]
1391 if { [is_remote host] && [board_info host exists fileid] } {
1398 -re "DOSEXIT code" { }
1403 if ![is_remote host] {
1407 unset inferior_spawn_id
1410 # Load a file into the debugger.
1411 # The return value is 0 for success, -1 for failure.
1413 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1414 # to one of these values:
1416 # debug file was loaded successfully and has debug information
1417 # nodebug file was loaded successfully and has no debug information
1418 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1420 # fail file was not loaded
1422 # I tried returning this information as part of the return value,
1423 # but ran into a mess because of the many re-implementations of
1424 # gdb_load in config/*.exp.
1426 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1427 # this if they can get more information set.
1429 proc gdb_file_cmd { arg } {
1433 global last_loaded_file
1435 # Save this for the benefit of gdbserver-support.exp.
1436 set last_loaded_file $arg
1438 # Set whether debug info was found.
1439 # Default to "fail".
1440 global gdb_file_cmd_debug_info
1441 set gdb_file_cmd_debug_info "fail"
1443 if [is_remote host] {
1444 set arg [remote_download host $arg]
1446 perror "download failed"
1451 # The file command used to kill the remote target. For the benefit
1452 # of the testsuite, preserve this behavior.
1455 -re "Kill the program being debugged. .y or n. $" {
1457 verbose "\t\tKilling previous program being debugged"
1460 -re "$gdb_prompt $" {
1465 send_gdb "file $arg\n"
1467 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1468 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1469 set gdb_file_cmd_debug_info "lzma"
1472 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1473 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1474 set gdb_file_cmd_debug_info "nodebug"
1477 -re "Reading symbols from.*done.*$gdb_prompt $" {
1478 verbose "\t\tLoaded $arg into $GDB"
1479 set gdb_file_cmd_debug_info "debug"
1482 -re "Load new symbol table from \".*\".*y or n. $" {
1485 -re "Reading symbols from.*done.*$gdb_prompt $" {
1486 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1487 set gdb_file_cmd_debug_info "debug"
1491 perror "Couldn't load $arg, other program already loaded (timeout)."
1495 perror "Couldn't load $arg, other program already loaded (eof)."
1500 -re "No such file or directory.*$gdb_prompt $" {
1501 perror "($arg) No such file or directory"
1504 -re "A problem internal to GDB has been detected" {
1505 fail "($arg) (GDB internal error)"
1506 gdb_internal_error_resync
1509 -re "$gdb_prompt $" {
1510 perror "Couldn't load $arg into $GDB."
1514 perror "Couldn't load $arg into $GDB (timeout)."
1518 # This is an attempt to detect a core dump, but seems not to
1519 # work. Perhaps we need to match .* followed by eof, in which
1520 # gdb_expect does not seem to have a way to do that.
1521 perror "Couldn't load $arg into $GDB (eof)."
1527 # Default gdb_spawn procedure.
1529 proc default_gdb_spawn { } {
1532 global INTERNAL_GDBFLAGS GDBFLAGS
1535 gdb_stop_suppressing_tests
1537 # Set the default value, it may be overriden later by specific testfile.
1539 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1540 # is already started after connecting and run/attach are not supported.
1541 # This is used for the "remote" protocol. After GDB starts you should
1542 # check global $use_gdb_stub instead of the board as the testfile may force
1543 # a specific different target protocol itself.
1544 set use_gdb_stub [target_info exists use_gdb_stub]
1546 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1548 if [info exists gdb_spawn_id] {
1552 if ![is_remote host] {
1553 if { [which $GDB] == 0 } then {
1554 perror "$GDB does not exist."
1558 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1559 if { $res < 0 || $res == "" } {
1560 perror "Spawning $GDB failed."
1564 set gdb_spawn_id $res
1568 # Default gdb_start procedure.
1570 proc default_gdb_start { } {
1571 global gdb_prompt pagination_prompt
1573 global inferior_spawn_id
1575 if [info exists gdb_spawn_id] {
1584 # Default to assuming inferior I/O is done on GDB's terminal.
1585 if {![info exists inferior_spawn_id]} {
1586 set inferior_spawn_id $gdb_spawn_id
1589 # When running over NFS, particularly if running many simultaneous
1590 # tests on different hosts all using the same server, things can
1591 # get really slow. Give gdb at least 3 minutes to start up.
1593 while { $loop_again } {
1596 -re "$pagination_prompt" {
1597 verbose "Hit pagination during startup. Pressing enter to continue."
1601 -re "\[\r\n\]$gdb_prompt $" {
1602 verbose "GDB initialized."
1604 -re "$gdb_prompt $" {
1605 perror "GDB never initialized."
1610 perror "(timeout) GDB never initialized after 10 seconds."
1618 # force the height to "unlimited", so no pagers get used
1620 send_gdb "set height 0\n"
1622 -re "$gdb_prompt $" {
1623 verbose "Setting height to 0." 2
1626 warning "Couldn't set the height to 0"
1629 # force the width to "unlimited", so no wraparound occurs
1630 send_gdb "set width 0\n"
1632 -re "$gdb_prompt $" {
1633 verbose "Setting width to 0." 2
1636 warning "Couldn't set the width to 0."
1642 # Utility procedure to give user control of the gdb prompt in a script. It is
1643 # meant to be used for debugging test cases, and should not be left in the
1646 proc gdb_interact { } {
1648 set spawn_id $gdb_spawn_id
1650 send_user "+------------------------------------------+\n"
1651 send_user "| Script interrupted, you can now interact |\n"
1652 send_user "| with by gdb. Type >>> to continue. |\n"
1653 send_user "+------------------------------------------+\n"
1660 # Examine the output of compilation to determine whether compilation
1661 # failed or not. If it failed determine whether it is due to missing
1662 # compiler or due to compiler error. Report pass, fail or unsupported
1665 proc gdb_compile_test {src output} {
1666 if { $output == "" } {
1667 pass "compilation [file tail $src]"
1668 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1669 unsupported "compilation [file tail $src]"
1670 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1671 unsupported "compilation [file tail $src]"
1672 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1673 unsupported "compilation [file tail $src]"
1675 verbose -log "compilation failed: $output" 2
1676 fail "compilation [file tail $src]"
1680 # Return a 1 for configurations for which we don't even want to try to
1683 proc skip_cplus_tests {} {
1684 if { [istarget "h8300-*-*"] } {
1688 # The C++ IO streams are too large for HC11/HC12 and are thus not
1689 # available. The gdb C++ tests use them and don't compile.
1690 if { [istarget "m6811-*-*"] } {
1693 if { [istarget "m6812-*-*"] } {
1699 # Return a 1 for configurations for which don't have both C++ and the STL.
1701 proc skip_stl_tests {} {
1702 # Symbian supports the C++ language, but the STL is missing
1703 # (both headers and libraries).
1704 if { [istarget "arm*-*-symbianelf*"] } {
1708 return [skip_cplus_tests]
1711 # Return a 1 if I don't even want to try to test FORTRAN.
1713 proc skip_fortran_tests {} {
1717 # Return a 1 if I don't even want to try to test ada.
1719 proc skip_ada_tests {} {
1723 # Return a 1 if I don't even want to try to test GO.
1725 proc skip_go_tests {} {
1729 # Return a 1 if I don't even want to try to test D.
1731 proc skip_d_tests {} {
1735 # Return 1 to skip Rust tests, 0 to try them.
1736 proc skip_rust_tests {} {
1737 return [expr {![isnative]}]
1740 # Return a 1 for configurations that do not support Python scripting.
1741 # PROMPT_REGEXP is the expected prompt.
1743 proc skip_python_tests_prompt { prompt_regexp } {
1744 global gdb_py_is_py3k
1745 global gdb_py_is_py24
1747 gdb_test_multiple "python print ('test')" "verify python support" {
1748 -re "not supported.*$prompt_regexp" {
1749 unsupported "Python support is disabled."
1752 -re "$prompt_regexp" {}
1755 set gdb_py_is_py24 0
1756 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1757 -re "3.*$prompt_regexp" {
1758 set gdb_py_is_py3k 1
1760 -re ".*$prompt_regexp" {
1761 set gdb_py_is_py3k 0
1764 if { $gdb_py_is_py3k == 0 } {
1765 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1766 -re "\[45\].*$prompt_regexp" {
1767 set gdb_py_is_py24 1
1769 -re ".*$prompt_regexp" {
1770 set gdb_py_is_py24 0
1778 # Return a 1 for configurations that do not support Python scripting.
1779 # Note: This also sets various globals that specify which version of Python
1780 # is in use. See skip_python_tests_prompt.
1782 proc skip_python_tests {} {
1784 return [skip_python_tests_prompt "$gdb_prompt $"]
1787 # Return a 1 if we should skip shared library tests.
1789 proc skip_shlib_tests {} {
1790 # Run the shared library tests on native systems.
1795 # An abbreviated list of remote targets where we should be able to
1796 # run shared library tests.
1797 if {([istarget *-*-linux*]
1798 || [istarget *-*-*bsd*]
1799 || [istarget *-*-solaris2*]
1800 || [istarget arm*-*-symbianelf*]
1801 || [istarget *-*-mingw*]
1802 || [istarget *-*-cygwin*]
1803 || [istarget *-*-pe*])} {
1810 # Return 1 if we should skip tui related tests.
1812 proc skip_tui_tests {} {
1815 gdb_test_multiple "help layout" "verify tui support" {
1816 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1819 -re "$gdb_prompt $" {
1826 # Test files shall make sure all the test result lines in gdb.sum are
1827 # unique in a test run, so that comparing the gdb.sum files of two
1828 # test runs gives correct results. Test files that exercise
1829 # variations of the same tests more than once, shall prefix the
1830 # different test invocations with different identifying strings in
1831 # order to make them unique.
1833 # About test prefixes:
1835 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1836 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1837 # underlined substring in
1839 # PASS: gdb.base/mytest.exp: some test
1840 # ^^^^^^^^^^^^^^^^^^^^
1844 # The easiest way to adjust the test prefix is to append a test
1845 # variation prefix to the $pf_prefix, using the with_test_prefix
1848 # proc do_tests {} {
1849 # gdb_test ... ... "test foo"
1850 # gdb_test ... ... "test bar"
1852 # with_test_prefix "subvariation a" {
1853 # gdb_test ... ... "test x"
1856 # with_test_prefix "subvariation b" {
1857 # gdb_test ... ... "test x"
1861 # with_test_prefix "variation1" {
1862 # ...do setup for variation 1...
1866 # with_test_prefix "variation2" {
1867 # ...do setup for variation 2...
1873 # PASS: gdb.base/mytest.exp: variation1: test foo
1874 # PASS: gdb.base/mytest.exp: variation1: test bar
1875 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1876 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1877 # PASS: gdb.base/mytest.exp: variation2: test foo
1878 # PASS: gdb.base/mytest.exp: variation2: test bar
1879 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1880 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1882 # If for some reason more flexibility is necessary, one can also
1883 # manipulate the pf_prefix global directly, treating it as a string.
1887 # set saved_pf_prefix
1888 # append pf_prefix "${foo}: bar"
1889 # ... actual tests ...
1890 # set pf_prefix $saved_pf_prefix
1893 # Run BODY in the context of the caller, with the current test prefix
1894 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1895 # Returns the result of BODY.
1897 proc with_test_prefix { prefix body } {
1900 set saved $pf_prefix
1901 append pf_prefix " " $prefix ":"
1902 set code [catch {uplevel 1 $body} result]
1903 set pf_prefix $saved
1906 global errorInfo errorCode
1907 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1909 return -code $code $result
1913 # Wrapper for foreach that calls with_test_prefix on each iteration,
1914 # including the iterator's name and current value in the prefix.
1916 proc foreach_with_prefix {var list body} {
1918 foreach myvar $list {
1919 with_test_prefix "$var=$myvar" {
1925 # Like TCL's native proc, but defines a procedure that wraps its body
1926 # within 'with_test_prefix "$proc_name" { ... }'.
1927 proc proc_with_prefix {name arguments body} {
1928 # Define the advertised proc.
1929 proc $name $arguments [list with_test_prefix $name $body]
1933 # Run BODY in the context of the caller. After BODY is run, the variables
1934 # listed in VARS will be reset to the values they had before BODY was run.
1936 # This is useful for providing a scope in which it is safe to temporarily
1937 # modify global variables, e.g.
1939 # global INTERNAL_GDBFLAGS
1942 # set foo GDBHISTSIZE
1944 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1945 # append INTERNAL_GDBFLAGS " -nx"
1946 # unset -nocomplain env(GDBHISTSIZE)
1951 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1952 # modified inside BODY, this proc guarantees that the modifications will be
1953 # undone after BODY finishes executing.
1955 proc save_vars { vars body } {
1956 array set saved_scalars { }
1957 array set saved_arrays { }
1961 # First evaluate VAR in the context of the caller in case the variable
1962 # name may be a not-yet-interpolated string like env($foo)
1963 set var [uplevel 1 list $var]
1965 if [uplevel 1 [list info exists $var]] {
1966 if [uplevel 1 [list array exists $var]] {
1967 set saved_arrays($var) [uplevel 1 [list array get $var]]
1969 set saved_scalars($var) [uplevel 1 [list set $var]]
1972 lappend unset_vars $var
1976 set code [catch {uplevel 1 $body} result]
1978 foreach {var value} [array get saved_scalars] {
1979 uplevel 1 [list set $var $value]
1982 foreach {var value} [array get saved_arrays] {
1983 uplevel 1 [list unset $var]
1984 uplevel 1 [list array set $var $value]
1987 foreach var $unset_vars {
1988 uplevel 1 [list unset -nocomplain $var]
1992 global errorInfo errorCode
1993 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1995 return -code $code $result
2000 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2001 # PROMPT. When BODY is finished, restore GDB prompt and variable
2003 # Returns the result of BODY.
2007 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2008 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2009 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2010 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2011 # a) It's more intuitive for callers to pass the plain text form.
2012 # b) We need two forms of the prompt:
2013 # - a regexp to use in output matching,
2014 # - a value to pass to the "set prompt" command.
2015 # c) It's easier to convert the plain text form to its regexp form.
2017 # 2) Don't add a trailing space, we do that here.
2019 proc with_gdb_prompt { prompt body } {
2022 # Convert "(foo)" to "\(foo\)".
2023 # We don't use string_to_regexp because while it works today it's not
2024 # clear it will work tomorrow: the value we need must work as both a
2025 # regexp *and* as the argument to the "set prompt" command, at least until
2026 # we start recording both forms separately instead of just $gdb_prompt.
2027 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2029 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2031 set saved $gdb_prompt
2033 verbose -log "Setting gdb prompt to \"$prompt \"."
2034 set gdb_prompt $prompt
2035 gdb_test_no_output "set prompt $prompt " ""
2037 set code [catch {uplevel 1 $body} result]
2039 verbose -log "Restoring gdb prompt to \"$saved \"."
2040 set gdb_prompt $saved
2041 gdb_test_no_output "set prompt $saved " ""
2044 global errorInfo errorCode
2045 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2047 return -code $code $result
2051 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2052 # BODY is finished, restore target-charset.
2054 proc with_target_charset { target_charset body } {
2058 gdb_test_multiple "show target-charset" "" {
2059 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2060 set saved $expect_out(1,string)
2062 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2063 set saved $expect_out(1,string)
2065 -re ".*$gdb_prompt " {
2066 fail "get target-charset"
2070 gdb_test_no_output "set target-charset $target_charset" ""
2072 set code [catch {uplevel 1 $body} result]
2074 gdb_test_no_output "set target-charset $saved" ""
2077 global errorInfo errorCode
2078 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2080 return -code $code $result
2084 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2085 # mi_gdb_test etc. default to using it.
2087 proc switch_gdb_spawn_id {spawn_id} {
2089 global board board_info
2091 set gdb_spawn_id $spawn_id
2092 set board [host_info name]
2093 set board_info($board,fileid) $spawn_id
2096 # Clear the default spawn id.
2098 proc clear_gdb_spawn_id {} {
2100 global board board_info
2102 unset -nocomplain gdb_spawn_id
2103 set board [host_info name]
2104 unset -nocomplain board_info($board,fileid)
2107 # Run BODY with SPAWN_ID as current spawn id.
2109 proc with_spawn_id { spawn_id body } {
2112 if [info exists gdb_spawn_id] {
2113 set saved_spawn_id $gdb_spawn_id
2116 switch_gdb_spawn_id $spawn_id
2118 set code [catch {uplevel 1 $body} result]
2120 if [info exists saved_spawn_id] {
2121 switch_gdb_spawn_id $saved_spawn_id
2127 global errorInfo errorCode
2128 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2130 return -code $code $result
2134 # Select the largest timeout from all the timeouts:
2135 # - the local "timeout" variable of the scope two levels above,
2136 # - the global "timeout" variable,
2137 # - the board variable "gdb,timeout".
2139 proc get_largest_timeout {} {
2140 upvar #0 timeout gtimeout
2141 upvar 2 timeout timeout
2144 if [info exists timeout] {
2147 if { [info exists gtimeout] && $gtimeout > $tmt } {
2150 if { [target_info exists gdb,timeout]
2151 && [target_info gdb,timeout] > $tmt } {
2152 set tmt [target_info gdb,timeout]
2162 # Run tests in BODY with timeout increased by factor of FACTOR. When
2163 # BODY is finished, restore timeout.
2165 proc with_timeout_factor { factor body } {
2168 set savedtimeout $timeout
2170 set timeout [expr [get_largest_timeout] * $factor]
2171 set code [catch {uplevel 1 $body} result]
2173 set timeout $savedtimeout
2175 global errorInfo errorCode
2176 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2178 return -code $code $result
2182 # Return 1 if _Complex types are supported, otherwise, return 0.
2184 gdb_caching_proc support_complex_tests {
2186 if { [gdb_skip_float_test] } {
2187 # If floating point is not supported, _Complex is not
2192 # Set up, compile, and execute a test program containing _Complex types.
2193 # Include the current process ID in the file names to prevent conflicts
2194 # with invocations for multiple testsuites.
2195 set src [standard_temp_file complex[pid].c]
2196 set exe [standard_temp_file complex[pid].x]
2198 gdb_produce_source $src {
2202 _Complex long double cld;
2207 verbose "compiling testfile $src" 2
2208 set compile_flags {debug nowarnings quiet}
2209 set lines [gdb_compile $src $exe executable $compile_flags]
2213 if ![string match "" $lines] then {
2214 verbose "testfile compilation failed, returning 0" 2
2223 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2226 proc supports_get_siginfo_type {} {
2227 if { [istarget "*-*-linux*"] } {
2234 # Return 1 if the target supports hardware single stepping.
2236 proc can_hardware_single_step {} {
2238 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2239 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2240 || [istarget "nios2-*-*"] } {
2247 # Return 1 if target hardware or OS supports single stepping to signal
2248 # handler, otherwise, return 0.
2250 proc can_single_step_to_signal_handler {} {
2251 # Targets don't have hardware single step. On these targets, when
2252 # a signal is delivered during software single step, gdb is unable
2253 # to determine the next instruction addresses, because start of signal
2254 # handler is one of them.
2255 return [can_hardware_single_step]
2258 # Return 1 if target supports process record, otherwise return 0.
2260 proc supports_process_record {} {
2262 if [target_info exists gdb,use_precord] {
2263 return [target_info gdb,use_precord]
2266 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2267 || [istarget "i\[34567\]86-*-linux*"]
2268 || [istarget "aarch64*-*-linux*"]
2269 || [istarget "powerpc*-*-linux*"]
2270 || [istarget "s390*-*-linux*"] } {
2277 # Return 1 if target supports reverse debugging, otherwise return 0.
2279 proc supports_reverse {} {
2281 if [target_info exists gdb,can_reverse] {
2282 return [target_info gdb,can_reverse]
2285 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2286 || [istarget "i\[34567\]86-*-linux*"]
2287 || [istarget "aarch64*-*-linux*"]
2288 || [istarget "powerpc*-*-linux*"]
2289 || [istarget "s390*-*-linux*"] } {
2296 # Return 1 if readline library is used.
2298 proc readline_is_used { } {
2301 gdb_test_multiple "show editing" "" {
2302 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2305 -re ".*$gdb_prompt $" {
2311 # Return 1 if target is ELF.
2312 gdb_caching_proc is_elf_target {
2313 set me "is_elf_target"
2315 set src [standard_temp_file is_elf_target[pid].c]
2316 set obj [standard_temp_file is_elf_target[pid].o]
2318 gdb_produce_source $src {
2319 int foo () {return 0;}
2322 verbose "$me: compiling testfile $src" 2
2323 set lines [gdb_compile $src $obj object {quiet}]
2327 if ![string match "" $lines] then {
2328 verbose "$me: testfile compilation failed, returning 0" 2
2332 set fp_obj [open $obj "r"]
2333 fconfigure $fp_obj -translation binary
2334 set data [read $fp_obj]
2339 set ELFMAG "\u007FELF"
2341 if {[string compare -length 4 $data $ELFMAG] != 0} {
2342 verbose "$me: returning 0" 2
2346 verbose "$me: returning 1" 2
2350 # Return 1 if the memory at address zero is readable.
2352 gdb_caching_proc is_address_zero_readable {
2356 gdb_test_multiple "x 0" "" {
2357 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2360 -re ".*$gdb_prompt $" {
2368 # Produce source file NAME and write SOURCES into it.
2370 proc gdb_produce_source { name sources } {
2372 set f [open $name "w"]
2378 # Return 1 if target is ILP32.
2379 # This cannot be decided simply from looking at the target string,
2380 # as it might depend on externally passed compiler options like -m64.
2381 gdb_caching_proc is_ilp32_target {
2382 set me "is_ilp32_target"
2384 set src [standard_temp_file ilp32[pid].c]
2385 set obj [standard_temp_file ilp32[pid].o]
2387 gdb_produce_source $src {
2388 int dummy[sizeof (int) == 4
2389 && sizeof (void *) == 4
2390 && sizeof (long) == 4 ? 1 : -1];
2393 verbose "$me: compiling testfile $src" 2
2394 set lines [gdb_compile $src $obj object {quiet}]
2398 if ![string match "" $lines] then {
2399 verbose "$me: testfile compilation failed, returning 0" 2
2403 verbose "$me: returning 1" 2
2407 # Return 1 if target is LP64.
2408 # This cannot be decided simply from looking at the target string,
2409 # as it might depend on externally passed compiler options like -m64.
2410 gdb_caching_proc is_lp64_target {
2411 set me "is_lp64_target"
2413 set src [standard_temp_file lp64[pid].c]
2414 set obj [standard_temp_file lp64[pid].o]
2416 gdb_produce_source $src {
2417 int dummy[sizeof (int) == 4
2418 && sizeof (void *) == 8
2419 && sizeof (long) == 8 ? 1 : -1];
2422 verbose "$me: compiling testfile $src" 2
2423 set lines [gdb_compile $src $obj object {quiet}]
2427 if ![string match "" $lines] then {
2428 verbose "$me: testfile compilation failed, returning 0" 2
2432 verbose "$me: returning 1" 2
2436 # Return 1 if target has 64 bit addresses.
2437 # This cannot be decided simply from looking at the target string,
2438 # as it might depend on externally passed compiler options like -m64.
2439 gdb_caching_proc is_64_target {
2440 set me "is_64_target"
2442 set src [standard_temp_file is64[pid].c]
2443 set obj [standard_temp_file is64[pid].o]
2445 gdb_produce_source $src {
2446 int function(void) { return 3; }
2447 int dummy[sizeof (&function) == 8 ? 1 : -1];
2450 verbose "$me: compiling testfile $src" 2
2451 set lines [gdb_compile $src $obj object {quiet}]
2455 if ![string match "" $lines] then {
2456 verbose "$me: testfile compilation failed, returning 0" 2
2460 verbose "$me: returning 1" 2
2464 # Return 1 if target has x86_64 registers - either amd64 or x32.
2465 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2466 # just from the target string.
2467 gdb_caching_proc is_amd64_regs_target {
2468 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2472 set me "is_amd64_regs_target"
2474 set src [standard_temp_file reg64[pid].s]
2475 set obj [standard_temp_file reg64[pid].o]
2479 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2480 lappend list "\tincq %$reg"
2482 gdb_produce_source $src [join $list \n]
2484 verbose "$me: compiling testfile $src" 2
2485 set lines [gdb_compile $src $obj object {quiet}]
2489 if ![string match "" $lines] then {
2490 verbose "$me: testfile compilation failed, returning 0" 2
2494 verbose "$me: returning 1" 2
2498 # Return 1 if this target is an x86 or x86-64 with -m32.
2499 proc is_x86_like_target {} {
2500 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2503 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2506 # Return 1 if this target is an arm or aarch32 on aarch64.
2508 gdb_caching_proc is_aarch32_target {
2509 if { [istarget "arm*-*-*"] } {
2513 if { ![istarget "aarch64*-*-*"] } {
2517 set me "is_aarch32_target"
2519 set src [standard_temp_file aarch32[pid].s]
2520 set obj [standard_temp_file aarch32[pid].o]
2525 lappend list "\tmov $reg, $reg"
2527 gdb_produce_source $src [join $list \n]
2529 verbose "$me: compiling testfile $src" 2
2530 set lines [gdb_compile $src $obj object {quiet}]
2534 if ![string match "" $lines] then {
2535 verbose "$me: testfile compilation failed, returning 0" 2
2539 verbose "$me: returning 1" 2
2543 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2545 proc is_aarch64_target {} {
2546 if { ![istarget "aarch64*-*-*"] } {
2550 return [expr ![is_aarch32_target]]
2553 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2554 proc support_displaced_stepping {} {
2556 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2557 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2558 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2559 || [istarget "aarch64*-*-linux*"] } {
2566 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2567 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2569 gdb_caching_proc skip_altivec_tests {
2570 global srcdir subdir gdb_prompt inferior_exited_re
2572 set me "skip_altivec_tests"
2574 # Some simulators are known to not support VMX instructions.
2575 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2576 verbose "$me: target known to not support VMX, returning 1" 2
2580 # Make sure we have a compiler that understands altivec.
2581 set compile_flags {debug nowarnings}
2582 if [get_compiler_info] {
2583 warning "Could not get compiler info"
2586 if [test_compiler_info gcc*] {
2587 set compile_flags "$compile_flags additional_flags=-maltivec"
2588 } elseif [test_compiler_info xlc*] {
2589 set compile_flags "$compile_flags additional_flags=-qaltivec"
2591 verbose "Could not compile with altivec support, returning 1" 2
2595 # Set up, compile, and execute a test program containing VMX instructions.
2596 # Include the current process ID in the file names to prevent conflicts
2597 # with invocations for multiple testsuites.
2598 set src [standard_temp_file vmx[pid].c]
2599 set exe [standard_temp_file vmx[pid].x]
2601 gdb_produce_source $src {
2604 asm volatile ("vor v0,v0,v0");
2606 asm volatile ("vor 0,0,0");
2612 verbose "$me: compiling testfile $src" 2
2613 set lines [gdb_compile $src $exe executable $compile_flags]
2616 if ![string match "" $lines] then {
2617 verbose "$me: testfile compilation failed, returning 1" 2
2621 # No error message, compilation succeeded so now run it via gdb.
2625 gdb_reinitialize_dir $srcdir/$subdir
2629 -re ".*Illegal instruction.*${gdb_prompt} $" {
2630 verbose -log "\n$me altivec hardware not detected"
2631 set skip_vmx_tests 1
2633 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2634 verbose -log "\n$me: altivec hardware detected"
2635 set skip_vmx_tests 0
2638 warning "\n$me: default case taken"
2639 set skip_vmx_tests 1
2643 remote_file build delete $exe
2645 verbose "$me: returning $skip_vmx_tests" 2
2646 return $skip_vmx_tests
2649 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2650 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2652 gdb_caching_proc skip_vsx_tests {
2653 global srcdir subdir gdb_prompt inferior_exited_re
2655 set me "skip_vsx_tests"
2657 # Some simulators are known to not support Altivec instructions, so
2658 # they won't support VSX instructions as well.
2659 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2660 verbose "$me: target known to not support VSX, returning 1" 2
2664 # Make sure we have a compiler that understands altivec.
2665 set compile_flags {debug nowarnings quiet}
2666 if [get_compiler_info] {
2667 warning "Could not get compiler info"
2670 if [test_compiler_info gcc*] {
2671 set compile_flags "$compile_flags additional_flags=-mvsx"
2672 } elseif [test_compiler_info xlc*] {
2673 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2675 verbose "Could not compile with vsx support, returning 1" 2
2679 set src [standard_temp_file vsx[pid].c]
2680 set exe [standard_temp_file vsx[pid].x]
2682 gdb_produce_source $src {
2684 double a[2] = { 1.0, 2.0 };
2686 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2688 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2694 verbose "$me: compiling testfile $src" 2
2695 set lines [gdb_compile $src $exe executable $compile_flags]
2698 if ![string match "" $lines] then {
2699 verbose "$me: testfile compilation failed, returning 1" 2
2703 # No error message, compilation succeeded so now run it via gdb.
2707 gdb_reinitialize_dir $srcdir/$subdir
2711 -re ".*Illegal instruction.*${gdb_prompt} $" {
2712 verbose -log "\n$me VSX hardware not detected"
2713 set skip_vsx_tests 1
2715 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2716 verbose -log "\n$me: VSX hardware detected"
2717 set skip_vsx_tests 0
2720 warning "\n$me: default case taken"
2721 set skip_vsx_tests 1
2725 remote_file build delete $exe
2727 verbose "$me: returning $skip_vsx_tests" 2
2728 return $skip_vsx_tests
2731 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2732 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2734 gdb_caching_proc skip_tsx_tests {
2735 global srcdir subdir gdb_prompt inferior_exited_re
2737 set me "skip_tsx_tests"
2739 set src [standard_temp_file tsx[pid].c]
2740 set exe [standard_temp_file tsx[pid].x]
2742 gdb_produce_source $src {
2744 asm volatile ("xbegin .L0");
2745 asm volatile ("xend");
2746 asm volatile (".L0: nop");
2751 verbose "$me: compiling testfile $src" 2
2752 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2755 if ![string match "" $lines] then {
2756 verbose "$me: testfile compilation failed." 2
2760 # No error message, compilation succeeded so now run it via gdb.
2764 gdb_reinitialize_dir $srcdir/$subdir
2768 -re ".*Illegal instruction.*${gdb_prompt} $" {
2769 verbose -log "$me: TSX hardware not detected."
2770 set skip_tsx_tests 1
2772 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2773 verbose -log "$me: TSX hardware detected."
2774 set skip_tsx_tests 0
2777 warning "\n$me: default case taken."
2778 set skip_tsx_tests 1
2782 remote_file build delete $exe
2784 verbose "$me: returning $skip_tsx_tests" 2
2785 return $skip_tsx_tests
2788 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2789 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2791 gdb_caching_proc skip_btrace_tests {
2792 global srcdir subdir gdb_prompt inferior_exited_re
2794 set me "skip_btrace_tests"
2795 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2796 verbose "$me: target does not support btrace, returning 1" 2
2800 # Set up, compile, and execute a test program.
2801 # Include the current process ID in the file names to prevent conflicts
2802 # with invocations for multiple testsuites.
2803 set src [standard_temp_file btrace[pid].c]
2804 set exe [standard_temp_file btrace[pid].x]
2806 gdb_produce_source $src {
2807 int main(void) { return 0; }
2810 verbose "$me: compiling testfile $src" 2
2811 set compile_flags {debug nowarnings quiet}
2812 set lines [gdb_compile $src $exe executable $compile_flags]
2814 if ![string match "" $lines] then {
2815 verbose "$me: testfile compilation failed, returning 1" 2
2820 # No error message, compilation succeeded so now run it via gdb.
2824 gdb_reinitialize_dir $srcdir/$subdir
2831 # In case of an unexpected output, we return 2 as a fail value.
2832 set skip_btrace_tests 2
2833 gdb_test_multiple "record btrace" "check btrace support" {
2834 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2835 set skip_btrace_tests 1
2837 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2838 set skip_btrace_tests 1
2840 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2841 set skip_btrace_tests 1
2843 -re "^record btrace\r\n$gdb_prompt $" {
2844 set skip_btrace_tests 0
2848 remote_file build delete $exe
2850 verbose "$me: returning $skip_btrace_tests" 2
2851 return $skip_btrace_tests
2854 # Run a test on the target to see if it supports btrace pt hardware.
2855 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2856 # from the GCC testsuite.
2858 gdb_caching_proc skip_btrace_pt_tests {
2859 global srcdir subdir gdb_prompt inferior_exited_re
2861 set me "skip_btrace_tests"
2862 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2863 verbose "$me: target does not support btrace, returning 1" 2
2867 # Set up, compile, and execute a test program.
2868 # Include the current process ID in the file names to prevent conflicts
2869 # with invocations for multiple testsuites.
2870 set src [standard_temp_file btrace[pid].c]
2871 set exe [standard_temp_file btrace[pid].x]
2873 gdb_produce_source $src {
2874 int main(void) { return 0; }
2877 verbose "$me: compiling testfile $src" 2
2878 set compile_flags {debug nowarnings quiet}
2879 set lines [gdb_compile $src $exe executable $compile_flags]
2881 if ![string match "" $lines] then {
2882 verbose "$me: testfile compilation failed, returning 1" 2
2887 # No error message, compilation succeeded so now run it via gdb.
2891 gdb_reinitialize_dir $srcdir/$subdir
2898 # In case of an unexpected output, we return 2 as a fail value.
2899 set skip_btrace_tests 2
2900 gdb_test_multiple "record btrace pt" "check btrace support" {
2901 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2902 set skip_btrace_tests 1
2904 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2905 set skip_btrace_tests 1
2907 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2908 set skip_btrace_tests 1
2910 -re "GDB does not support.*\r\n$gdb_prompt $" {
2911 set skip_btrace_tests 1
2913 -re "^record btrace pt\r\n$gdb_prompt $" {
2914 set skip_btrace_tests 0
2918 remote_file build delete $exe
2920 verbose "$me: returning $skip_btrace_tests" 2
2921 return $skip_btrace_tests
2924 # Return whether we should skip tests for showing inlined functions in
2925 # backtraces. Requires get_compiler_info and get_debug_format.
2927 proc skip_inline_frame_tests {} {
2928 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2929 if { ! [test_debug_format "DWARF 2"] } {
2933 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2934 if { ([test_compiler_info "gcc-2-*"]
2935 || [test_compiler_info "gcc-3-*"]
2936 || [test_compiler_info "gcc-4-0-*"]) } {
2943 # Return whether we should skip tests for showing variables from
2944 # inlined functions. Requires get_compiler_info and get_debug_format.
2946 proc skip_inline_var_tests {} {
2947 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2948 if { ! [test_debug_format "DWARF 2"] } {
2955 # Return a 1 if we should skip tests that require hardware breakpoints
2957 proc skip_hw_breakpoint_tests {} {
2958 # Skip tests if requested by the board (note that no_hardware_watchpoints
2959 # disables both watchpoints and breakpoints)
2960 if { [target_info exists gdb,no_hardware_watchpoints]} {
2964 # These targets support hardware breakpoints natively
2965 if { [istarget "i?86-*-*"]
2966 || [istarget "x86_64-*-*"]
2967 || [istarget "ia64-*-*"]
2968 || [istarget "arm*-*-*"]
2969 || [istarget "aarch64*-*-*"]
2970 || [istarget "s390*-*-*"] } {
2977 # Return a 1 if we should skip tests that require hardware watchpoints
2979 proc skip_hw_watchpoint_tests {} {
2980 # Skip tests if requested by the board
2981 if { [target_info exists gdb,no_hardware_watchpoints]} {
2985 # These targets support hardware watchpoints natively
2986 if { [istarget "i?86-*-*"]
2987 || [istarget "x86_64-*-*"]
2988 || [istarget "ia64-*-*"]
2989 || [istarget "arm*-*-*"]
2990 || [istarget "aarch64*-*-*"]
2991 || [istarget "powerpc*-*-linux*"]
2992 || [istarget "s390*-*-*"] } {
2999 # Return a 1 if we should skip tests that require *multiple* hardware
3000 # watchpoints to be active at the same time
3002 proc skip_hw_watchpoint_multi_tests {} {
3003 if { [skip_hw_watchpoint_tests] } {
3007 # These targets support just a single hardware watchpoint
3008 if { [istarget "arm*-*-*"]
3009 || [istarget "powerpc*-*-linux*"] } {
3016 # Return a 1 if we should skip tests that require read/access watchpoints
3018 proc skip_hw_watchpoint_access_tests {} {
3019 if { [skip_hw_watchpoint_tests] } {
3023 # These targets support just write watchpoints
3024 if { [istarget "s390*-*-*"] } {
3031 # Return 1 if we should skip tests that require the runtime unwinder
3032 # hook. This must be invoked while gdb is running, after shared
3033 # libraries have been loaded. This is needed because otherwise a
3034 # shared libgcc won't be visible.
3036 proc skip_unwinder_tests {} {
3040 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3041 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3043 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3046 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3050 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3051 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3054 -re "\r\n$gdb_prompt $" {
3061 # Return 0 if we should skip tests that require the libstdc++ stap
3062 # probes. This must be invoked while gdb is running, after shared
3063 # libraries have been loaded.
3065 proc skip_libstdcxx_probe_tests {} {
3069 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3070 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3073 -re "\r\n$gdb_prompt $" {
3079 # Return 1 if we should skip tests of the "compile" feature.
3080 # This must be invoked after the inferior has been started.
3082 proc skip_compile_feature_tests {} {
3086 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3087 "Could not load libcc1.*\r\n$gdb_prompt $" {
3090 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3093 -re "\r\n$gdb_prompt $" {
3099 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3102 proc gdb_is_target_remote_prompt { prompt_regexp } {
3104 set test "probe for target remote"
3105 gdb_test_multiple "maint print target-stack" $test {
3106 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3110 -re "$prompt_regexp" {
3117 # Check whether we're testing with the remote or extended-remote
3120 proc gdb_is_target_remote {} {
3123 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3126 # Return the effective value of use_gdb_stub.
3128 # If the use_gdb_stub global has been set (it is set when the gdb process is
3129 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3130 # property from the board file.
3132 # This is the preferred way of checking use_gdb_stub, since it allows to check
3133 # the value before the gdb has been spawned and it will return the correct value
3134 # even when it was overriden by the test.
3136 proc use_gdb_stub {} {
3139 if [info exists use_gdb_stub] {
3140 return $use_gdb_stub
3143 return [target_info exists use_gdb_stub]
3146 # Return 1 if the current remote target is an instance of our GDBserver, 0
3147 # otherwise. Return -1 if there was an error and we can't tell.
3149 gdb_caching_proc target_is_gdbserver {
3153 set test "Probing for GDBserver"
3155 gdb_test_multiple "monitor help" $test {
3156 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3159 -re "$gdb_prompt $" {
3164 if { $is_gdbserver == -1 } {
3165 verbose -log "Unable to tell whether we are using GDBserver or not."
3168 return $is_gdbserver
3171 # N.B. compiler_info is intended to be local to this file.
3172 # Call test_compiler_info with no arguments to fetch its value.
3173 # Yes, this is counterintuitive when there's get_compiler_info,
3174 # but that's the current API.
3175 if [info exists compiler_info] {
3181 # Figure out what compiler I am using.
3182 # The result is cached so only the first invocation runs the compiler.
3184 # ARG can be empty or "C++". If empty, "C" is assumed.
3186 # There are several ways to do this, with various problems.
3188 # [ gdb_compile -E $ifile -o $binfile.ci ]
3189 # source $binfile.ci
3191 # Single Unix Spec v3 says that "-E -o ..." together are not
3192 # specified. And in fact, the native compiler on hp-ux 11 (among
3193 # others) does not work with "-E -o ...". Most targets used to do
3194 # this, and it mostly worked, because it works with gcc.
3196 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3197 # source $binfile.ci
3199 # This avoids the problem with -E and -o together. This almost works
3200 # if the build machine is the same as the host machine, which is
3201 # usually true of the targets which are not gcc. But this code does
3202 # not figure which compiler to call, and it always ends up using the C
3203 # compiler. Not good for setting hp_aCC_compiler. Target
3204 # hppa*-*-hpux* used to do this.
3206 # [ gdb_compile -E $ifile > $binfile.ci ]
3207 # source $binfile.ci
3209 # dejagnu target_compile says that it supports output redirection,
3210 # but the code is completely different from the normal path and I
3211 # don't want to sweep the mines from that path. So I didn't even try
3214 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3217 # I actually do this for all targets now. gdb_compile runs the right
3218 # compiler, and TCL captures the output, and I eval the output.
3220 # Unfortunately, expect logs the output of the command as it goes by,
3221 # and dejagnu helpfully prints a second copy of it right afterwards.
3222 # So I turn off expect logging for a moment.
3224 # [ gdb_compile $ifile $ciexe_file executable $args ]
3225 # [ remote_exec $ciexe_file ]
3226 # [ source $ci_file.out ]
3228 # I could give up on -E and just do this.
3229 # I didn't get desperate enough to try this.
3231 # -- chastain 2004-01-06
3233 proc get_compiler_info {{arg ""}} {
3234 # For compiler.c and compiler.cc
3237 # I am going to play with the log to keep noise out.
3241 # These come from compiler.c or compiler.cc
3242 global compiler_info
3244 # Legacy global data symbols.
3247 if [info exists compiler_info] {
3252 # Choose which file to preprocess.
3253 set ifile "${srcdir}/lib/compiler.c"
3254 if { $arg == "c++" } {
3255 set ifile "${srcdir}/lib/compiler.cc"
3258 # Run $ifile through the right preprocessor.
3259 # Toggle gdb.log to keep the compiler output out of the log.
3260 set saved_log [log_file -info]
3262 if [is_remote host] {
3263 # We have to use -E and -o together, despite the comments
3264 # above, because of how DejaGnu handles remote host testing.
3265 set ppout "$outdir/compiler.i"
3266 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3267 set file [open $ppout r]
3268 set cppout [read $file]
3271 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3273 eval log_file $saved_log
3277 foreach cppline [ split "$cppout" "\n" ] {
3278 if { [ regexp "^#" "$cppline" ] } {
3280 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3282 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3284 verbose "get_compiler_info: $cppline" 2
3288 verbose -log "get_compiler_info: $cppline"
3293 # Set to unknown if for some reason compiler_info didn't get defined.
3294 if ![info exists compiler_info] {
3295 verbose -log "get_compiler_info: compiler_info not provided"
3296 set compiler_info "unknown"
3298 # Also set to unknown compiler if any diagnostics happened.
3300 verbose -log "get_compiler_info: got unexpected diagnostics"
3301 set compiler_info "unknown"
3304 # Set the legacy symbols.
3306 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3308 # Log what happened.
3309 verbose -log "get_compiler_info: $compiler_info"
3311 # Most compilers will evaluate comparisons and other boolean
3312 # operations to 0 or 1.
3313 uplevel \#0 { set true 1 }
3314 uplevel \#0 { set false 0 }
3319 # Return the compiler_info string if no arg is provided.
3320 # Otherwise the argument is a glob-style expression to match against
3323 proc test_compiler_info { {compiler ""} } {
3324 global compiler_info
3327 # If no arg, return the compiler_info string.
3328 if [string match "" $compiler] {
3329 return $compiler_info
3332 return [string match $compiler $compiler_info]
3335 proc current_target_name { } {
3337 if [info exists target_info(target,name)] {
3338 set answer $target_info(target,name)
3345 set gdb_wrapper_initialized 0
3346 set gdb_wrapper_target ""
3348 proc gdb_wrapper_init { args } {
3349 global gdb_wrapper_initialized
3350 global gdb_wrapper_file
3351 global gdb_wrapper_flags
3352 global gdb_wrapper_target
3354 if { $gdb_wrapper_initialized == 1 } { return; }
3356 if {[target_info exists needs_status_wrapper] && \
3357 [target_info needs_status_wrapper] != "0"} {
3358 set result [build_wrapper "testglue.o"]
3359 if { $result != "" } {
3360 set gdb_wrapper_file [lindex $result 0]
3361 set gdb_wrapper_flags [lindex $result 1]
3363 warning "Status wrapper failed to build."
3366 set gdb_wrapper_initialized 1
3367 set gdb_wrapper_target [current_target_name]
3370 # Some targets need to always link a special object in. Save its path here.
3371 global gdb_saved_set_unbuffered_mode_obj
3372 set gdb_saved_set_unbuffered_mode_obj ""
3374 # Compile source files specified by SOURCE into a binary of type TYPE at path
3375 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3376 # parameter and most options are passed directly to it.
3378 # The type can be one of the following:
3380 # - object: Compile into an object file.
3381 # - executable: Compile and link into an executable.
3382 # - preprocess: Preprocess the source files.
3383 # - assembly: Generate assembly listing.
3385 # The following options are understood and processed by gdb_compile:
3387 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3388 # quirks to be able to use shared libraries.
3389 # - shlib_load: Link with appropriate libraries to allow the test to
3390 # dynamically load libraries at runtime. For example, on Linux, this adds
3391 # -ldl so that the test can use dlopen.
3392 # - nowarnings: Inhibit all compiler warnings.
3394 # And here are some of the not too obscure options understood by DejaGnu that
3395 # influence the compilation:
3397 # - additional_flags=flag: Add FLAG to the compiler flags.
3398 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3399 # argument can be a file, in which case it's added to the sources, or a
3401 # - ldflags=flag: Add FLAG to the linker flags.
3402 # - incdir=path: Add PATH to the searched include directories.
3403 # - libdir=path: Add PATH to the linker searched directories.
3404 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3405 # - debug: Build with debug information.
3406 # - optimize: Build with optimization.
3408 proc gdb_compile {source dest type options} {
3409 global GDB_TESTCASE_OPTIONS
3410 global gdb_wrapper_file
3411 global gdb_wrapper_flags
3412 global gdb_wrapper_initialized
3415 global gdb_saved_set_unbuffered_mode_obj
3417 set outdir [file dirname $dest]
3419 # Add platform-specific options if a shared library was specified using
3420 # "shlib=librarypath" in OPTIONS.
3424 foreach opt $options {
3425 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3426 if [test_compiler_info "xlc-*"] {
3427 # IBM xlc compiler doesn't accept shared library named other
3428 # than .so: use "-Wl," to bypass this
3429 lappend source "-Wl,$shlib_name"
3430 } elseif { ([istarget "*-*-mingw*"]
3431 || [istarget *-*-cygwin*]
3432 || [istarget *-*-pe*])} {
3433 lappend source "${shlib_name}.a"
3435 lappend source $shlib_name
3437 if { $shlib_found == 0 } {
3439 if { ([istarget "*-*-mingw*"]
3440 || [istarget *-*-cygwin*]) } {
3441 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3443 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3444 # Undo debian's change in the default.
3445 # Put it at the front to not override any user-provided
3446 # value, and to make sure it appears in front of all the
3448 lappend new_options "early_flags=-Wl,--no-as-needed"
3451 } elseif { $opt == "shlib_load" } {
3454 lappend new_options $opt
3458 # Because we link with libraries using their basename, we may need
3459 # (depending on the platform) to set a special rpath value, to allow
3460 # the executable to find the libraries it depends on.
3461 if { $shlib_load || $shlib_found } {
3462 if { ([istarget "*-*-mingw*"]
3463 || [istarget *-*-cygwin*]
3464 || [istarget *-*-pe*]) } {
3465 # Do not need anything.
3466 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3467 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3468 } elseif { [istarget arm*-*-symbianelf*] } {
3469 if { $shlib_load } {
3470 lappend new_options "libs=-ldl"
3473 if { $shlib_load } {
3474 lappend new_options "libs=-ldl"
3476 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3479 set options $new_options
3481 if [info exists GDB_TESTCASE_OPTIONS] {
3482 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3484 verbose "options are $options"
3485 verbose "source is $source $dest $type $options"
3487 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3489 if {[target_info exists needs_status_wrapper] && \
3490 [target_info needs_status_wrapper] != "0" && \
3491 [info exists gdb_wrapper_file]} {
3492 lappend options "libs=${gdb_wrapper_file}"
3493 lappend options "ldflags=${gdb_wrapper_flags}"
3496 # Replace the "nowarnings" option with the appropriate additional_flags
3497 # to disable compiler warnings.
3498 set nowarnings [lsearch -exact $options nowarnings]
3499 if {$nowarnings != -1} {
3500 if [target_info exists gdb,nowarnings_flag] {
3501 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3503 set flag "additional_flags=-w"
3505 set options [lreplace $options $nowarnings $nowarnings $flag]
3508 if { $type == "executable" } {
3509 if { ([istarget "*-*-mingw*"]
3510 || [istarget "*-*-*djgpp"]
3511 || [istarget "*-*-cygwin*"])} {
3512 # Force output to unbuffered mode, by linking in an object file
3513 # with a global contructor that calls setvbuf.
3515 # Compile the special object seperatelly for two reasons:
3516 # 1) Insulate it from $options.
3517 # 2) Avoid compiling it for every gdb_compile invocation,
3518 # which is time consuming, especially if we're remote
3521 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3522 verbose "compiling gdb_saved_set_unbuffered_obj"
3523 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3524 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3526 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3527 if { $result != "" } {
3530 if {[is_remote host]} {
3531 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3533 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3535 # Link a copy of the output object, because the
3536 # original may be automatically deleted.
3537 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3539 verbose "gdb_saved_set_unbuffered_obj already compiled"
3542 # Rely on the internal knowledge that the global ctors are ran in
3543 # reverse link order. In that case, we can use ldflags to
3544 # avoid copying the object file to the host multiple
3546 # This object can only be added if standard libraries are
3547 # used. Thus, we need to disable it if -nostdlib option is used
3548 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3549 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3554 set result [target_compile $source $dest $type $options]
3556 # Prune uninteresting compiler (and linker) output.
3557 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3559 regsub "\[\r\n\]*$" "$result" "" result
3560 regsub "^\[\r\n\]*" "$result" "" result
3562 if {[lsearch $options quiet] < 0} {
3563 # We shall update this on a per language basis, to avoid
3564 # changing the entire testsuite in one go.
3565 if {[lsearch $options f77] >= 0} {
3566 gdb_compile_test $source $result
3567 } elseif { $result != "" } {
3568 clone_output "gdb compile failed, $result"
3575 # This is just like gdb_compile, above, except that it tries compiling
3576 # against several different thread libraries, to see which one this
3578 proc gdb_compile_pthreads {source dest type options} {
3580 set why_msg "unrecognized error"
3581 foreach lib {-lpthreads -lpthread -lthread ""} {
3582 # This kind of wipes out whatever libs the caller may have
3583 # set. Or maybe theirs will override ours. How infelicitous.
3584 set options_with_lib [concat $options [list libs=$lib quiet]]
3585 set ccout [gdb_compile $source $dest $type $options_with_lib]
3586 switch -regexp -- $ccout {
3587 ".*no posix threads support.*" {
3588 set why_msg "missing threads include file"
3591 ".*cannot open -lpthread.*" {
3592 set why_msg "missing runtime threads library"
3594 ".*Can't find library for -lpthread.*" {
3595 set why_msg "missing runtime threads library"
3598 pass "successfully compiled posix threads test case"
3604 if {!$built_binfile} {
3605 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3610 # Build a shared library from SOURCES.
3612 proc gdb_compile_shlib {sources dest options} {
3613 set obj_options $options
3616 if { [lsearch -exact $options "c++"] >= 0 } {
3617 set info_options "c++"
3619 if [get_compiler_info ${info_options}] {
3623 switch -glob [test_compiler_info] {
3625 lappend obj_options "additional_flags=-qpic"
3628 if { !([istarget "*-*-cygwin*"]
3629 || [istarget "*-*-mingw*"]) } {
3630 lappend obj_options "additional_flags=-fpic"
3634 if { !([istarget "powerpc*-*-aix*"]
3635 || [istarget "rs6000*-*-aix*"]
3636 || [istarget "*-*-cygwin*"]
3637 || [istarget "*-*-mingw*"]
3638 || [istarget "*-*-pe*"]) } {
3639 lappend obj_options "additional_flags=-fpic"
3643 lappend obj_options "additional_flags=-fpic"
3646 # don't know what the compiler is...
3650 set outdir [file dirname $dest]
3652 foreach source $sources {
3653 set sourcebase [file tail $source]
3654 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3657 lappend objects ${outdir}/${sourcebase}.o
3660 set link_options $options
3661 if [test_compiler_info "xlc-*"] {
3662 lappend link_options "additional_flags=-qmkshrobj"
3664 lappend link_options "additional_flags=-shared"
3666 if { ([istarget "*-*-mingw*"]
3667 || [istarget *-*-cygwin*]
3668 || [istarget *-*-pe*]) } {
3669 if { [is_remote host] } {
3670 set name [file tail ${dest}]
3674 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3676 # Set the soname of the library. This causes the linker on ELF
3677 # systems to create the DT_NEEDED entry in the executable referring
3678 # to the soname of the library, and not its absolute path. This
3679 # (using the absolute path) would be problem when testing on a
3682 # In conjunction with setting the soname, we add the special
3683 # rpath=$ORIGIN value when building the executable, so that it's
3684 # able to find the library in its own directory.
3685 set destbase [file tail $dest]
3686 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3689 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3692 if { [is_remote host]
3693 && ([istarget "*-*-mingw*"]
3694 || [istarget *-*-cygwin*]
3695 || [istarget *-*-pe*]) } {
3696 set dest_tail_name [file tail ${dest}]
3697 remote_upload host $dest_tail_name.a ${dest}.a
3698 remote_file host delete $dest_tail_name.a
3704 # This is just like gdb_compile_shlib, above, except that it tries compiling
3705 # against several different thread libraries, to see which one this
3707 proc gdb_compile_shlib_pthreads {sources dest options} {
3709 set why_msg "unrecognized error"
3710 foreach lib {-lpthreads -lpthread -lthread ""} {
3711 # This kind of wipes out whatever libs the caller may have
3712 # set. Or maybe theirs will override ours. How infelicitous.
3713 set options_with_lib [concat $options [list libs=$lib quiet]]
3714 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3715 switch -regexp -- $ccout {
3716 ".*no posix threads support.*" {
3717 set why_msg "missing threads include file"
3720 ".*cannot open -lpthread.*" {
3721 set why_msg "missing runtime threads library"
3723 ".*Can't find library for -lpthread.*" {
3724 set why_msg "missing runtime threads library"
3727 pass "successfully compiled posix threads test case"
3733 if {!$built_binfile} {
3734 unsupported "Couldn't compile $sources: ${why_msg}"
3739 # This is just like gdb_compile_pthreads, above, except that we always add the
3740 # objc library for compiling Objective-C programs
3741 proc gdb_compile_objc {source dest type options} {
3743 set why_msg "unrecognized error"
3744 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3745 # This kind of wipes out whatever libs the caller may have
3746 # set. Or maybe theirs will override ours. How infelicitous.
3747 if { $lib == "solaris" } {
3748 set lib "-lpthread -lposix4"
3750 if { $lib != "-lobjc" } {
3751 set lib "-lobjc $lib"
3753 set options_with_lib [concat $options [list libs=$lib quiet]]
3754 set ccout [gdb_compile $source $dest $type $options_with_lib]
3755 switch -regexp -- $ccout {
3756 ".*no posix threads support.*" {
3757 set why_msg "missing threads include file"
3760 ".*cannot open -lpthread.*" {
3761 set why_msg "missing runtime threads library"
3763 ".*Can't find library for -lpthread.*" {
3764 set why_msg "missing runtime threads library"
3767 pass "successfully compiled objc with posix threads test case"
3773 if {!$built_binfile} {
3774 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3779 proc send_gdb { string } {
3780 global suppress_flag
3781 if { $suppress_flag } {
3784 return [remote_send host "$string"]
3787 # Send STRING to the inferior's terminal.
3789 proc send_inferior { string } {
3790 global inferior_spawn_id
3792 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3802 proc gdb_expect { args } {
3803 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3804 set atimeout [lindex $args 0]
3805 set expcode [list [lindex $args 1]]
3810 # A timeout argument takes precedence, otherwise of all the timeouts
3811 # select the largest.
3812 if [info exists atimeout] {
3815 set tmt [get_largest_timeout]
3818 global suppress_flag
3819 global remote_suppress_flag
3820 if [info exists remote_suppress_flag] {
3821 set old_val $remote_suppress_flag
3823 if [info exists suppress_flag] {
3824 if { $suppress_flag } {
3825 set remote_suppress_flag 1
3829 {uplevel remote_expect host $tmt $expcode} string]
3830 if [info exists old_val] {
3831 set remote_suppress_flag $old_val
3833 if [info exists remote_suppress_flag] {
3834 unset remote_suppress_flag
3839 global errorInfo errorCode
3841 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3843 return -code $code $string
3847 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3849 # Check for long sequence of output by parts.
3850 # TEST: is the test message to be printed with the test success/fail.
3851 # SENTINEL: Is the terminal pattern indicating that output has finished.
3852 # LIST: is the sequence of outputs to match.
3853 # If the sentinel is recognized early, it is considered an error.
3856 # 1 if the test failed,
3857 # 0 if the test passes,
3858 # -1 if there was an internal error.
3860 proc gdb_expect_list {test sentinel list} {
3862 global suppress_flag
3865 if { $suppress_flag } {
3867 unresolved "${test}"
3869 while { ${index} < [llength ${list}] } {
3870 set pattern [lindex ${list} ${index}]
3871 set index [expr ${index} + 1]
3872 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3873 if { ${index} == [llength ${list}] } {
3876 -re "${pattern}${sentinel}" {
3877 # pass "${test}, pattern ${index} + sentinel"
3880 fail "${test} (pattern ${index} + sentinel)"
3883 -re ".*A problem internal to GDB has been detected" {
3884 fail "${test} (GDB internal error)"
3886 gdb_internal_error_resync
3889 fail "${test} (pattern ${index} + sentinel) (timeout)"
3894 # unresolved "${test}, pattern ${index} + sentinel"
3900 # pass "${test}, pattern ${index}"
3903 fail "${test} (pattern ${index})"
3906 -re ".*A problem internal to GDB has been detected" {
3907 fail "${test} (GDB internal error)"
3909 gdb_internal_error_resync
3912 fail "${test} (pattern ${index}) (timeout)"
3917 # unresolved "${test}, pattern ${index}"
3931 proc gdb_suppress_entire_file { reason } {
3932 global suppress_flag
3935 set suppress_flag -1
3939 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3940 # gdb_expect to fail immediately (until the next call to
3941 # gdb_stop_suppressing_tests).
3943 proc gdb_suppress_tests { args } {
3944 global suppress_flag
3946 return; # fnf - disable pending review of results where
3947 # testsuite ran better without this
3950 if { $suppress_flag == 1 } {
3951 if { [llength $args] > 0 } {
3952 warning "[lindex $args 0]\n"
3954 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3960 # Clear suppress_flag.
3962 proc gdb_stop_suppressing_tests { } {
3963 global suppress_flag
3965 if [info exists suppress_flag] {
3966 if { $suppress_flag > 0 } {
3968 clone_output "Tests restarted.\n"
3975 proc gdb_clear_suppressed { } {
3976 global suppress_flag
3981 # Spawn the gdb process.
3983 # This doesn't expect any output or do any other initialization,
3984 # leaving those to the caller.
3986 # Overridable function -- you can override this function in your
3989 proc gdb_spawn { } {
3993 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3995 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3998 set saved_gdbflags $GDBFLAGS
4000 if {$GDBFLAGS != ""} {
4003 append GDBFLAGS $cmdline_flags
4007 set GDBFLAGS $saved_gdbflags
4012 # Start gdb running, wait for prompt, and disable the pagers.
4014 # Overridable function -- you can override this function in your
4017 proc gdb_start { } {
4022 catch default_gdb_exit
4025 # Return true if we can spawn a program on the target and attach to
4028 proc can_spawn_for_attach { } {
4029 # We use exp_pid to get the inferior's pid, assuming that gives
4030 # back the pid of the program. On remote boards, that would give
4031 # us instead the PID of e.g., the ssh client, etc.
4032 if [is_remote target] then {
4036 # The "attach" command doesn't make sense when the target is
4037 # stub-like, where GDB finds the program already started on
4038 # initial connection.
4039 if {[target_info exists use_gdb_stub]} {
4047 # Kill a progress previously started with spawn_wait_for_attach, and
4048 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4051 proc kill_wait_spawned_process { proc_spawn_id } {
4052 set pid [exp_pid -i $proc_spawn_id]
4054 verbose -log "killing ${pid}"
4055 remote_exec build "kill -9 ${pid}"
4057 verbose -log "closing ${proc_spawn_id}"
4058 catch "close -i $proc_spawn_id"
4059 verbose -log "waiting for ${proc_spawn_id}"
4061 # If somehow GDB ends up still attached to the process here, a
4062 # blocking wait hangs until gdb is killed (or until gdb / the
4063 # ptracer reaps the exit status too, but that won't happen because
4064 # something went wrong.) Passing -nowait makes expect tell Tcl to
4065 # wait for the PID in the background. That's fine because we
4066 # don't care about the exit status. */
4067 wait -nowait -i $proc_spawn_id
4070 # Returns the process id corresponding to the given spawn id.
4072 proc spawn_id_get_pid { spawn_id } {
4073 set testpid [exp_pid -i $spawn_id]
4075 if { [istarget "*-*-cygwin*"] } {
4076 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4077 # might be different due to the way fork/exec works.
4078 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4084 # Start a set of programs running and then wait for a bit, to be sure
4085 # that they can be attached to. Return a list of processes spawn IDs,
4086 # one element for each process spawned. It's a test error to call
4087 # this when [can_spawn_for_attach] is false.
4089 proc spawn_wait_for_attach { executable_list } {
4090 set spawn_id_list {}
4092 if ![can_spawn_for_attach] {
4093 # The caller should have checked can_spawn_for_attach itself
4094 # before getting here.
4095 error "can't spawn for attach with this target/board"
4098 foreach {executable} $executable_list {
4099 # Note we use Expect's spawn, not Tcl's exec, because with
4100 # spawn we control when to wait for/reap the process. That
4101 # allows killing the process by PID without being subject to
4103 lappend spawn_id_list [remote_spawn target $executable]
4108 return $spawn_id_list
4112 # gdb_load_cmd -- load a file into the debugger.
4113 # ARGS - additional args to load command.
4114 # return a -1 if anything goes wrong.
4116 proc gdb_load_cmd { args } {
4119 if [target_info exists gdb_load_timeout] {
4120 set loadtimeout [target_info gdb_load_timeout]
4122 set loadtimeout 1600
4124 send_gdb "load $args\n"
4125 verbose "Timeout is now $loadtimeout seconds" 2
4126 gdb_expect $loadtimeout {
4127 -re "Loading section\[^\r\]*\r\n" {
4130 -re "Start address\[\r\]*\r\n" {
4133 -re "Transfer rate\[\r\]*\r\n" {
4136 -re "Memory access error\[^\r\]*\r\n" {
4137 perror "Failed to load program"
4140 -re "$gdb_prompt $" {
4143 -re "(.*)\r\n$gdb_prompt " {
4144 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4148 perror "Timed out trying to load $args."
4155 # Invoke "gcore". CORE is the name of the core file to write. TEST
4156 # is the name of the test case. This will return 1 if the core file
4157 # was created, 0 otherwise. If this fails to make a core file because
4158 # this configuration of gdb does not support making core files, it
4159 # will call "unsupported", not "fail". However, if this fails to make
4160 # a core file for some other reason, then it will call "fail".
4162 proc gdb_gcore_cmd {core test} {
4166 gdb_test_multiple "gcore $core" $test {
4167 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4171 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4179 # Load core file CORE. TEST is the name of the test case.
4180 # This will record a pass/fail for loading the core file.
4182 # 1 - core file is successfully loaded
4183 # 0 - core file loaded but has a non fatal error
4184 # -1 - core file failed to load
4186 proc gdb_core_cmd { core test } {
4189 gdb_test_multiple "core $core" "$test" {
4190 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4193 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4194 fail "$test (bad file format)"
4197 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4198 fail "$test (file not found)"
4201 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4202 fail "$test (incomplete note section)"
4205 -re "Core was generated by .*\r\n$gdb_prompt $" {
4209 -re ".*$gdb_prompt $" {
4214 fail "$test (timeout)"
4218 fail "unsupported output from 'core' command"
4222 # Return the filename to download to the target and load on the target
4223 # for this shared library. Normally just LIBNAME, unless shared libraries
4224 # for this target have separate link and load images.
4226 proc shlib_target_file { libname } {
4230 # Return the filename GDB will load symbols from when debugging this
4231 # shared library. Normally just LIBNAME, unless shared libraries for
4232 # this target have separate link and load images.
4234 proc shlib_symbol_file { libname } {
4238 # Return the filename to download to the target and load for this
4239 # executable. Normally just BINFILE unless it is renamed to something
4240 # else for this target.
4242 proc exec_target_file { binfile } {
4246 # Return the filename GDB will load symbols from when debugging this
4247 # executable. Normally just BINFILE unless executables for this target
4248 # have separate files for symbols.
4250 proc exec_symbol_file { binfile } {
4254 # Rename the executable file. Normally this is just BINFILE1 being renamed
4255 # to BINFILE2, but some targets require multiple binary files.
4256 proc gdb_rename_execfile { binfile1 binfile2 } {
4257 file rename -force [exec_target_file ${binfile1}] \
4258 [exec_target_file ${binfile2}]
4259 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4260 file rename -force [exec_symbol_file ${binfile1}] \
4261 [exec_symbol_file ${binfile2}]
4265 # "Touch" the executable file to update the date. Normally this is just
4266 # BINFILE, but some targets require multiple files.
4267 proc gdb_touch_execfile { binfile } {
4268 set time [clock seconds]
4269 file mtime [exec_target_file ${binfile}] $time
4270 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4271 file mtime [exec_symbol_file ${binfile}] $time
4275 # Like remote_download but provides a gdb-specific behavior.
4277 # If the destination board is remote, the local file FROMFILE is transferred as
4278 # usual with remote_download to TOFILE on the remote board. The destination
4279 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4282 # If the destination board is local, the destination path TOFILE is passed
4283 # through standard_output_file, and FROMFILE is copied there.
4285 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4288 proc gdb_remote_download {dest fromfile {tofile {}}} {
4289 # If TOFILE is not given, default to the same filename as FROMFILE.
4290 if {[string length $tofile] == 0} {
4291 set tofile [file tail $fromfile]
4294 if {[is_remote $dest]} {
4295 # When the DEST is remote, we simply send the file to DEST.
4298 set destname [remote_download $dest $fromfile $tofile]
4299 lappend cleanfiles $destname
4303 # When the DEST is local, we copy the file to the test directory (where
4304 # the executable is).
4306 # Note that we pass TOFILE through standard_output_file, regardless of
4307 # whether it is absolute or relative, because we don't want the tests
4308 # to be able to write outside their standard output directory.
4310 set tofile [standard_output_file $tofile]
4312 file copy -force $fromfile $tofile
4318 # gdb_load_shlib LIB...
4320 # Copy the listed library to the target.
4322 proc gdb_load_shlib { file } {
4323 set dest [gdb_remote_download target [shlib_target_file $file]]
4325 if {[is_remote target]} {
4326 # If the target is remote, we need to tell gdb where to find the
4329 # We could set this even when not testing remotely, but a user
4330 # generally won't set it unless necessary. In order to make the tests
4331 # more like the real-life scenarios, we don't set it for local testing.
4332 gdb_test "set solib-search-path [file dirname $file]" "" ""
4339 # gdb_load -- load a file into the debugger. Specifying no file
4340 # defaults to the executable currently being debugged.
4341 # The return value is 0 for success, -1 for failure.
4342 # Many files in config/*.exp override this procedure.
4344 proc gdb_load { arg } {
4346 return [gdb_file_cmd $arg]
4351 # gdb_reload -- load a file into the target. Called before "running",
4352 # either the first time or after already starting the program once,
4353 # for remote targets. Most files that override gdb_load should now
4354 # override this instead.
4356 proc gdb_reload { } {
4357 # For the benefit of existing configurations, default to gdb_load.
4358 # Specifying no file defaults to the executable currently being
4360 return [gdb_load ""]
4363 proc gdb_continue { function } {
4366 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4369 proc default_gdb_init { test_file_name } {
4370 global gdb_wrapper_initialized
4371 global gdb_wrapper_target
4372 global gdb_test_file_name
4378 gdb_clear_suppressed
4380 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4382 # Make sure that the wrapper is rebuilt
4383 # with the appropriate multilib option.
4384 if { $gdb_wrapper_target != [current_target_name] } {
4385 set gdb_wrapper_initialized 0
4388 # Unlike most tests, we have a small number of tests that generate
4389 # a very large amount of output. We therefore increase the expect
4390 # buffer size to be able to contain the entire test output. This
4391 # is especially needed by gdb.base/info-macros.exp.
4393 # Also set this value for the currently running GDB.
4394 match_max [match_max -d]
4396 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4397 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4400 if [target_info exists gdb_prompt] {
4401 set gdb_prompt [target_info gdb_prompt]
4403 set gdb_prompt "\\(gdb\\)"
4406 if [info exists use_gdb_stub] {
4411 # Return a path using GDB_PARALLEL.
4412 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4413 # GDB_PARALLEL must be defined, the caller must check.
4415 # The default value for GDB_PARALLEL is, canonically, ".".
4416 # The catch is that tests don't expect an additional "./" in file paths so
4417 # omit any directory for the default case.
4418 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4419 # its special handling.
4421 proc make_gdb_parallel_path { args } {
4422 global GDB_PARALLEL objdir
4423 set joiner [list "file" "join" $objdir]
4424 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4425 lappend joiner $GDB_PARALLEL
4427 set joiner [concat $joiner $args]
4428 return [eval $joiner]
4431 # Turn BASENAME into a full file name in the standard output
4432 # directory. It is ok if BASENAME is the empty string; in this case
4433 # the directory is returned.
4435 proc standard_output_file {basename} {
4436 global objdir subdir gdb_test_file_name
4438 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4440 return [file join $dir $basename]
4443 # Return the name of a file in our standard temporary directory.
4445 proc standard_temp_file {basename} {
4446 # Since a particular runtest invocation is only executing a single test
4447 # file at any given time, we can use the runtest pid to build the
4448 # path of the temp directory.
4449 set dir [make_gdb_parallel_path temp [pid]]
4451 return [file join $dir $basename]
4454 # Set 'testfile', 'srcfile', and 'binfile'.
4456 # ARGS is a list of source file specifications.
4457 # Without any arguments, the .exp file's base name is used to
4458 # compute the source file name. The ".c" extension is added in this case.
4459 # If ARGS is not empty, each entry is a source file specification.
4460 # If the specification starts with a ".", it is treated as a suffix
4461 # to append to the .exp file's base name.
4462 # If the specification is the empty string, it is treated as if it
4464 # Otherwise it is a file name.
4465 # The first file in the list is used to set the 'srcfile' global.
4466 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4468 # Most tests should call this without arguments.
4470 # If a completely different binary file name is needed, then it
4471 # should be handled in the .exp file with a suitable comment.
4473 proc standard_testfile {args} {
4474 global gdb_test_file_name
4476 global gdb_test_file_last_vars
4479 global testfile binfile
4481 set testfile $gdb_test_file_name
4482 set binfile [standard_output_file ${testfile}]
4484 if {[llength $args] == 0} {
4488 # Unset our previous output variables.
4489 # This can help catch hidden bugs.
4490 if {[info exists gdb_test_file_last_vars]} {
4491 foreach varname $gdb_test_file_last_vars {
4493 catch {unset $varname}
4496 # 'executable' is often set by tests.
4497 set gdb_test_file_last_vars {executable}
4501 set varname srcfile$suffix
4504 # Handle an extension.
4507 } elseif {[string range $arg 0 0] == "."} {
4508 set arg $testfile$arg
4512 lappend gdb_test_file_last_vars $varname
4514 if {$suffix == ""} {
4522 # The default timeout used when testing GDB commands. We want to use
4523 # the same timeout as the default dejagnu timeout, unless the user has
4524 # already provided a specific value (probably through a site.exp file).
4525 global gdb_test_timeout
4526 if ![info exists gdb_test_timeout] {
4527 set gdb_test_timeout $timeout
4530 # A list of global variables that GDB testcases should not use.
4531 # We try to prevent their use by monitoring write accesses and raising
4532 # an error when that happens.
4533 set banned_variables { bug_id prms_id }
4535 # A list of procedures that GDB testcases should not use.
4536 # We try to prevent their use by monitoring invocations and raising
4537 # an error when that happens.
4538 set banned_procedures { strace }
4540 # gdb_init is called by runtest at start, but also by several
4541 # tests directly; gdb_finish is only called from within runtest after
4542 # each test source execution.
4543 # Placing several traces by repetitive calls to gdb_init leads
4544 # to problems, as only one trace is removed in gdb_finish.
4545 # To overcome this possible problem, we add a variable that records
4546 # if the banned variables and procedures are already traced.
4549 proc gdb_init { test_file_name } {
4550 # Reset the timeout value to the default. This way, any testcase
4551 # that changes the timeout value without resetting it cannot affect
4552 # the timeout used in subsequent testcases.
4553 global gdb_test_timeout
4555 set timeout $gdb_test_timeout
4557 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4558 && [target_info exists gdb_reverse_timeout] } {
4559 set timeout [target_info gdb_reverse_timeout]
4562 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4563 # debugging tool to help confirm that the test suite is
4564 # parallel-safe. You need "inotifywait" from the
4565 # inotify-tools package to use this.
4566 global GDB_INOTIFY inotify_pid
4567 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4568 global outdir tool inotify_log_file
4570 set exclusions {outputs temp gdb[.](log|sum) cache}
4571 set exclusion_re ([join $exclusions |])
4573 set inotify_log_file [standard_temp_file inotify.out]
4574 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4575 --exclude $exclusion_re \
4576 |& tee -a $outdir/$tool.log $inotify_log_file &]
4578 # Wait for the watches; hopefully this is long enough.
4581 # Clear the log so that we don't emit a warning the first time
4583 set fd [open $inotify_log_file w]
4587 # Block writes to all banned variables, and invocation of all
4588 # banned procedures...
4589 global banned_variables
4590 global banned_procedures
4591 global banned_traced
4592 if (!$banned_traced) {
4593 foreach banned_var $banned_variables {
4594 global "$banned_var"
4595 trace add variable "$banned_var" write error
4597 foreach banned_proc $banned_procedures {
4598 global "$banned_proc"
4599 trace add execution "$banned_proc" enter error
4604 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4605 # messages as expected.
4610 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4611 # the test results. Even if /dev/null doesn't exist on the particular
4612 # platform, the readline library will use the default setting just by
4613 # failing to open the file. OTOH, opening /dev/null successfully will
4614 # also result in the default settings being used since nothing will be
4615 # read from this file.
4616 setenv INPUTRC "/dev/null"
4618 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4619 # bindings, so make sure that an appropriate terminal is selected.
4620 # The same bug doesn't show up if we use ^P / ^N instead.
4623 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4624 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4625 # especially having color output turned on can cause tests to fail.
4626 setenv GREP_OPTIONS ""
4628 # Clear $gdbserver_reconnect_p.
4629 global gdbserver_reconnect_p
4630 set gdbserver_reconnect_p 1
4631 unset gdbserver_reconnect_p
4633 return [default_gdb_init $test_file_name]
4636 proc gdb_finish { } {
4637 global gdbserver_reconnect_p
4641 # Exit first, so that the files are no longer in use.
4644 if { [llength $cleanfiles] > 0 } {
4645 eval remote_file target delete $cleanfiles
4649 # Unblock write access to the banned variables. Dejagnu typically
4650 # resets some of them between testcases.
4651 global banned_variables
4652 global banned_procedures
4653 global banned_traced
4654 if ($banned_traced) {
4655 foreach banned_var $banned_variables {
4656 global "$banned_var"
4657 trace remove variable "$banned_var" write error
4659 foreach banned_proc $banned_procedures {
4660 global "$banned_proc"
4661 trace remove execution "$banned_proc" enter error
4668 set debug_format "unknown"
4670 # Run the gdb command "info source" and extract the debugging format
4671 # information from the output and save it in debug_format.
4673 proc get_debug_format { } {
4679 set debug_format "unknown"
4680 send_gdb "info source\n"
4682 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4683 set debug_format $expect_out(1,string)
4684 verbose "debug format is $debug_format"
4687 -re "No current source file.\r\n$gdb_prompt $" {
4688 perror "get_debug_format used when no current source file"
4691 -re "$gdb_prompt $" {
4692 warning "couldn't check debug format (no valid response)."
4696 warning "couldn't check debug format (timeout)."
4702 # Return true if FORMAT matches the debug format the current test was
4703 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4704 # `*', `[...]', and so on.
4706 # This function depends on variables set by `get_debug_format', above.
4708 proc test_debug_format {format} {
4711 return [expr [string match $format $debug_format] != 0]
4714 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4715 # COFF, stabs, etc). If that format matches the format that the
4716 # current test was compiled with, then the next test is expected to
4717 # fail for any target. Returns 1 if the next test or set of tests is
4718 # expected to fail, 0 otherwise (or if it is unknown). Must have
4719 # previously called get_debug_format.
4720 proc setup_xfail_format { format } {
4721 set ret [test_debug_format $format]
4729 # gdb_get_line_number TEXT [FILE]
4731 # Search the source file FILE, and return the line number of the
4732 # first line containing TEXT. If no match is found, an error is thrown.
4734 # TEXT is a string literal, not a regular expression.
4736 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4737 # specified, and does not start with "/", then it is assumed to be in
4738 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4739 # by changing the callers and the interface at the same time.
4740 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4741 # gdb.base/ena-dis-br.exp.
4743 # Use this function to keep your test scripts independent of the
4744 # exact line numbering of the source file. Don't write:
4746 # send_gdb "break 20"
4748 # This means that if anyone ever edits your test's source file,
4749 # your test could break. Instead, put a comment like this on the
4750 # source file line you want to break at:
4752 # /* breakpoint spot: frotz.exp: test name */
4754 # and then write, in your test script (which we assume is named
4757 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4759 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4762 # % puts "foo [lindex "bar baz" 1]"
4765 # Tcl is quite clever, for a little stringy language.)
4769 # The previous implementation of this procedure used the gdb search command.
4770 # This version is different:
4772 # . It works with MI, and it also works when gdb is not running.
4774 # . It operates on the build machine, not the host machine.
4776 # . For now, this implementation fakes a current directory of
4777 # $srcdir/$subdir to be compatible with the old implementation.
4778 # This will go away eventually and some callers will need to
4781 # . The TEXT argument is literal text and matches literally,
4782 # not a regular expression as it was before.
4784 # . State changes in gdb, such as changing the current file
4785 # and setting $_, no longer happen.
4787 # After a bit of time we can forget about the differences from the
4788 # old implementation.
4790 # --chastain 2004-08-05
4792 proc gdb_get_line_number { text { file "" } } {
4797 if { "$file" == "" } then {
4800 if { ! [regexp "^/" "$file"] } then {
4801 set file "$srcdir/$subdir/$file"
4804 if { [ catch { set fd [open "$file"] } message ] } then {
4809 for { set line 1 } { 1 } { incr line } {
4810 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4813 if { $nchar < 0 } then {
4816 if { [string first "$text" "$body"] >= 0 } then {
4822 if { [ catch { close "$fd" } message ] } then {
4827 error "undefined tag \"$text\""
4833 # Continue the program until it ends.
4835 # MSSG is the error message that gets printed. If not given, a
4837 # COMMAND is the command to invoke. If not given, "continue" is
4839 # ALLOW_EXTRA is a flag indicating whether the test should expect
4840 # extra output between the "Continuing." line and the program
4841 # exiting. By default it is zero; if nonzero, any extra output
4844 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4845 global inferior_exited_re use_gdb_stub
4848 set text "continue until exit"
4850 set text "continue until exit at $mssg"
4858 # By default, we don't rely on exit() behavior of remote stubs --
4859 # it's common for exit() to be implemented as a simple infinite
4860 # loop, or a forced crash/reset. For native targets, by default, we
4861 # assume process exit is reported as such. If a non-reliable target
4862 # is used, we set a breakpoint at exit, and continue to that.
4863 if { [target_info exists exit_is_reliable] } {
4864 set exit_is_reliable [target_info exit_is_reliable]
4866 set exit_is_reliable [expr ! $use_gdb_stub]
4869 if { ! $exit_is_reliable } {
4870 if {![gdb_breakpoint "exit"]} {
4873 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4876 # Continue until we exit. Should not stop again.
4877 # Don't bother to check the output of the program, that may be
4878 # extremely tough for some remote systems.
4880 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4885 proc rerun_to_main {} {
4886 global gdb_prompt use_gdb_stub
4891 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4892 {pass "rerun to main" ; return 0}
4893 -re "$gdb_prompt $"\
4894 {fail "rerun to main" ; return 0}
4895 timeout {fail "(timeout) rerun to main" ; return 0}
4900 -re "The program .* has been started already.*y or n. $" {
4904 -re "Starting program.*$gdb_prompt $"\
4905 {pass "rerun to main" ; return 0}
4906 -re "$gdb_prompt $"\
4907 {fail "rerun to main" ; return 0}
4908 timeout {fail "(timeout) rerun to main" ; return 0}
4913 # Return true if a test should be skipped due to lack of floating
4914 # point support or GDB can't fetch the contents from floating point
4917 gdb_caching_proc gdb_skip_float_test {
4918 if [target_info exists gdb,skip_float_tests] {
4922 # There is an ARM kernel ptrace bug that hardware VFP registers
4923 # are not updated after GDB ptrace set VFP registers. The bug
4924 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
4925 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
4926 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
4927 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
4928 # This kernel bug is detected by check how does GDB change the
4929 # program result by changing one VFP register.
4930 if { [istarget "arm*-*-linux*"] } {
4932 set compile_flags {debug nowarnings }
4934 # Set up, compile, and execute a test program having VFP
4936 set src [standard_temp_file arm_vfp[pid].c]
4937 set exe [standard_temp_file arm_vfp[pid].x]
4939 gdb_produce_source $src {
4944 asm ("vldr d0, [%0]" : : "r" (&d));
4945 asm ("vldr d1, [%0]" : : "r" (&d));
4946 asm (".global break_here\n"
4948 asm ("vcmp.f64 d0, d1\n"
4949 "vmrs APSR_nzcv, fpscr\n"
4950 "bne L_value_different\n"
4953 "L_value_different:\n"
4955 "L_end:\n" : "=r" (ret) :);
4957 /* Return $d0 != $d1. */
4962 verbose "compiling testfile $src" 2
4963 set lines [gdb_compile $src $exe executable $compile_flags]
4966 if ![string match "" $lines] then {
4967 verbose "testfile compilation failed, returning 1" 2
4971 # No error message, compilation succeeded so now run it via gdb.
4972 # Run the test up to 5 times to detect whether ptrace can
4973 # correctly update VFP registers or not.
4975 for {set i 0} {$i < 5} {incr i} {
4976 global gdb_prompt srcdir subdir
4980 gdb_reinitialize_dir $srcdir/$subdir
4984 gdb_test "break *break_here"
4985 gdb_continue_to_breakpoint "break_here"
4987 # Modify $d0 to a different value, so the exit code should
4989 gdb_test "set \$d0 = 5.0"
4991 set test "continue to exit"
4992 gdb_test_multiple "continue" "$test" {
4993 -re "exited with code 01.*$gdb_prompt $" {
4995 -re "exited normally.*$gdb_prompt $" {
4996 # However, the exit code is 0. That means something
4997 # wrong in setting VFP registers.
5005 remote_file build delete $exe
5007 return $skip_vfp_test
5012 # Print a message and return true if a test should be skipped
5013 # due to lack of stdio support.
5015 proc gdb_skip_stdio_test { msg } {
5016 if [target_info exists gdb,noinferiorio] {
5017 verbose "Skipping test '$msg': no inferior i/o."
5023 proc gdb_skip_bogus_test { msg } {
5027 # Return true if a test should be skipped due to lack of XML support
5029 # NOTE: This must be called while gdb is *not* running.
5031 gdb_caching_proc gdb_skip_xml_test {
5035 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5039 gdb_test_multiple "set tdesc filename $xml_file" "" {
5040 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5043 -re ".*$gdb_prompt $" { }
5049 # Return true if argv[0] is available.
5051 gdb_caching_proc gdb_has_argv0 {
5054 # Set up, compile, and execute a test program to check whether
5055 # argv[0] is available.
5056 set src [standard_temp_file has_argv0[pid].c]
5057 set exe [standard_temp_file has_argv0[pid].x]
5059 gdb_produce_source $src {
5060 int main (int argc, char **argv) {
5065 gdb_compile $src $exe executable {debug}
5068 proc gdb_has_argv0_1 { exe } {
5069 global srcdir subdir
5070 global gdb_prompt hex
5074 gdb_reinitialize_dir $srcdir/$subdir
5077 # Set breakpoint on main.
5078 gdb_test_multiple "break main" "break main" {
5079 -re "Breakpoint.*${gdb_prompt} $" {
5081 -re "${gdb_prompt} $" {
5088 gdb_test_multiple "" "run to main" {
5089 -re "Breakpoint.*${gdb_prompt} $" {
5091 -re "${gdb_prompt} $" {
5096 set old_elements "200"
5097 set test "show print elements"
5098 gdb_test_multiple $test $test {
5099 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5100 set old_elements $expect_out(1,string)
5103 set old_repeats "200"
5104 set test "show print repeats"
5105 gdb_test_multiple $test $test {
5106 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5107 set old_repeats $expect_out(1,string)
5110 gdb_test_no_output "set print elements unlimited" ""
5111 gdb_test_no_output "set print repeats unlimited" ""
5114 # Check whether argc is 1.
5115 gdb_test_multiple "p argc" "p argc" {
5116 -re " = 1\r\n${gdb_prompt} $" {
5118 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5119 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5122 -re "${gdb_prompt} $" {
5126 -re "${gdb_prompt} $" {
5130 gdb_test_no_output "set print elements $old_elements" ""
5131 gdb_test_no_output "set print repeats $old_repeats" ""
5136 set result [gdb_has_argv0_1 $exe]
5143 && ([istarget *-*-linux*]
5144 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5145 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5146 || [istarget *-*-openbsd*]
5147 || [istarget *-*-darwin*]
5148 || [istarget *-*-solaris*]
5149 || [istarget *-*-aix*]
5150 || [istarget *-*-gnu*]
5151 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5152 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5153 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5154 || [istarget *-*-symbianelf*]
5155 || [istarget *-*-osf*]
5156 || [istarget *-*-dicos*]
5157 || [istarget *-*-nto*]
5158 || [istarget *-*-*vms*]
5159 || [istarget *-*-lynx*178]) } {
5160 fail "argv\[0\] should be available on this target"
5166 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5167 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5168 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5169 # the name of a debuginfo only file. This file will be stored in the same
5172 # Functions for separate debug info testing
5174 # starting with an executable:
5175 # foo --> original executable
5177 # at the end of the process we have:
5178 # foo.stripped --> foo w/o debug info
5179 # foo.debug --> foo's debug info
5180 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5182 # Fetch the build id from the file.
5183 # Returns "" if there is none.
5185 proc get_build_id { filename } {
5186 if { ([istarget "*-*-mingw*"]
5187 || [istarget *-*-cygwin*]) } {
5188 set objdump_program [gdb_find_objdump]
5189 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5190 verbose "result is $result"
5191 verbose "output is $output"
5197 set tmp [standard_output_file "${filename}-tmp"]
5198 set objcopy_program [gdb_find_objcopy]
5199 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5200 verbose "result is $result"
5201 verbose "output is $output"
5206 fconfigure $fi -translation binary
5207 # Skip the NOTE header.
5212 if ![string compare $data ""] then {
5215 # Convert it to hex.
5216 binary scan $data H* data
5221 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5222 # converted to the form: .build-id/ab/cdef1234...89.debug
5223 # Return "" if no build-id found.
5224 proc build_id_debug_filename_get { filename } {
5225 set data [get_build_id $filename]
5226 if { $data == "" } {
5229 regsub {^..} $data {\0/} data
5230 return ".build-id/${data}.debug"
5233 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5234 # list of optional flags. The only currently supported flag is no-main,
5235 # which removes the symbol entry for main from the separate debug file.
5237 # Function returns zero on success. Function will return non-zero failure code
5238 # on some targets not supporting separate debug info (such as i386-msdos).
5240 proc gdb_gnu_strip_debug { dest args } {
5242 # Use the first separate debug info file location searched by GDB so the
5243 # run cannot be broken by some stale file searched with higher precedence.
5244 set debug_file "${dest}.debug"
5246 set strip_to_file_program [transform strip]
5247 set objcopy_program [gdb_find_objcopy]
5249 set debug_link [file tail $debug_file]
5250 set stripped_file "${dest}.stripped"
5252 # Get rid of the debug info, and store result in stripped_file
5253 # something like gdb/testsuite/gdb.base/blah.stripped.
5254 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5255 verbose "result is $result"
5256 verbose "output is $output"
5261 # Workaround PR binutils/10802:
5262 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5263 set perm [file attributes ${dest} -permissions]
5264 file attributes ${stripped_file} -permissions $perm
5266 # Get rid of everything but the debug info, and store result in debug_file
5267 # This will be in the .debug subdirectory, see above.
5268 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5269 verbose "result is $result"
5270 verbose "output is $output"
5275 # If no-main is passed, strip the symbol for main from the separate
5276 # file. This is to simulate the behavior of elfutils's eu-strip, which
5277 # leaves the symtab in the original file only. There's no way to get
5278 # objcopy or strip to remove the symbol table without also removing the
5279 # debugging sections, so this is as close as we can get.
5280 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5281 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5282 verbose "result is $result"
5283 verbose "output is $output"
5287 file delete "${debug_file}"
5288 file rename "${debug_file}-tmp" "${debug_file}"
5291 # Link the two previous output files together, adding the .gnu_debuglink
5292 # section to the stripped_file, containing a pointer to the debug_file,
5293 # save the new file in dest.
5294 # This will be the regular executable filename, in the usual location.
5295 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5296 verbose "result is $result"
5297 verbose "output is $output"
5302 # Workaround PR binutils/10802:
5303 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5304 set perm [file attributes ${stripped_file} -permissions]
5305 file attributes ${dest} -permissions $perm
5310 # Test the output of GDB_COMMAND matches the pattern obtained
5311 # by concatenating all elements of EXPECTED_LINES. This makes
5312 # it possible to split otherwise very long string into pieces.
5313 # If third argument is not empty, it's used as the name of the
5314 # test to be printed on pass/fail.
5315 proc help_test_raw { gdb_command expected_lines args } {
5316 set message $gdb_command
5317 if [llength $args]>0 then {
5318 set message [lindex $args 0]
5320 set expected_output [join $expected_lines ""]
5321 gdb_test "${gdb_command}" "${expected_output}" $message
5324 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5325 # are regular expressions that should match the beginning of output,
5326 # before the list of commands in that class. The presence of
5327 # command list and standard epilogue will be tested automatically.
5328 # Notice that the '[' and ']' characters don't need to be escaped for strings
5329 # wrapped in {} braces.
5330 proc test_class_help { command_class expected_initial_lines args } {
5332 "List of commands\:.*[\r\n]+"
5333 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5334 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5335 "Command name abbreviations are allowed if unambiguous\."
5337 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5339 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5342 # COMMAND_LIST should have either one element -- command to test, or
5343 # two elements -- abbreviated command to test, and full command the first
5344 # element is abbreviation of.
5345 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5346 # are regular expressions that should match the beginning of output,
5347 # before the list of subcommands. The presence of
5348 # subcommand list and standard epilogue will be tested automatically.
5349 proc test_prefix_command_help { command_list expected_initial_lines args } {
5350 set command [lindex $command_list 0]
5351 if {[llength $command_list]>1} {
5352 set full_command [lindex $command_list 1]
5354 set full_command $command
5356 # Use 'list' and not just {} because we want variables to
5357 # be expanded in this list.
5358 set l_stock_body [list\
5359 "List of $full_command subcommands\:.*\[\r\n\]+"\
5360 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5361 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5362 "Command name abbreviations are allowed if unambiguous\."]
5363 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5364 if {[llength $args]>0} {
5365 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5367 help_test_raw "help ${command}" $l_entire_body
5371 # Build executable named EXECUTABLE from specifications that allow
5372 # different options to be passed to different sub-compilations.
5373 # TESTNAME is the name of the test; this is passed to 'untested' if
5375 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5376 # contains the option "pthreads", then gdb_compile_pthreads is used.
5377 # ARGS is a flat list of source specifications, of the form:
5378 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5379 # Each SOURCE is compiled to an object file using its OPTIONS,
5380 # using gdb_compile.
5381 # Returns 0 on success, -1 on failure.
5382 proc build_executable_from_specs {testname executable options args} {
5386 set binfile [standard_output_file $executable]
5389 if { [lsearch -exact $options "c++"] >= 0 } {
5390 set info_options "c++"
5392 if [get_compiler_info ${info_options}] {
5396 set func gdb_compile
5397 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5398 if {$func_index != -1} {
5399 set func "${func}_[lindex $options $func_index]"
5402 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5403 # parameter. They also requires $sources while gdb_compile and
5404 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5405 if [string match gdb_compile_shlib* $func] {
5407 foreach {s local_options} $args {
5408 if { [regexp "^/" "$s"] } then {
5409 lappend sources_path "$s"
5411 lappend sources_path "$srcdir/$subdir/$s"
5414 set ret [$func $sources_path "${binfile}" $options]
5415 } elseif {[lsearch -exact $options rust] != -1} {
5417 foreach {s local_options} $args {
5418 if { [regexp "^/" "$s"] } then {
5419 lappend sources_path "$s"
5421 lappend sources_path "$srcdir/$subdir/$s"
5424 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5428 foreach {s local_options} $args {
5429 if { ! [regexp "^/" "$s"] } then {
5430 set s "$srcdir/$subdir/$s"
5432 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5436 lappend objects "${binfile}${i}.o"
5439 set ret [$func $objects "${binfile}" executable $options]
5449 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5450 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5451 # to pass to untested, if something is wrong. OPTIONS are passed
5452 # to gdb_compile directly.
5453 proc build_executable { testname executable {sources ""} {options {debug}} } {
5454 if {[llength $sources]==0} {
5455 set sources ${executable}.c
5458 set arglist [list $testname $executable $options]
5459 foreach source $sources {
5460 lappend arglist $source $options
5463 return [eval build_executable_from_specs $arglist]
5466 # Starts fresh GDB binary and loads an optional executable into GDB.
5467 # Usage: clean_restart [executable]
5468 # EXECUTABLE is the basename of the binary.
5470 proc clean_restart { args } {
5474 if { [llength $args] > 1 } {
5475 error "bad number of args: [llength $args]"
5480 gdb_reinitialize_dir $srcdir/$subdir
5482 if { [llength $args] >= 1 } {
5483 set executable [lindex $args 0]
5484 set binfile [standard_output_file ${executable}]
5489 # Prepares for testing by calling build_executable_full, then
5491 # TESTNAME is the name of the test.
5492 # Each element in ARGS is a list of the form
5493 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5494 # These are passed to build_executable_from_specs, which see.
5495 # The last EXECUTABLE is passed to clean_restart.
5496 # Returns 0 on success, non-zero on failure.
5497 proc prepare_for_testing_full {testname args} {
5498 foreach spec $args {
5499 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5502 set executable [lindex $spec 0]
5504 clean_restart $executable
5508 # Prepares for testing, by calling build_executable, and then clean_restart.
5509 # Please refer to build_executable for parameter description.
5510 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5512 if {[build_executable $testname $executable $sources $options] == -1} {
5515 clean_restart $executable
5520 proc get_valueof { fmt exp default } {
5523 set test "get valueof \"${exp}\""
5525 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5526 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5527 set val $expect_out(1,string)
5531 fail "$test (timeout)"
5537 proc get_integer_valueof { exp default } {
5540 set test "get integer valueof \"${exp}\""
5542 gdb_test_multiple "print /d ${exp}" "$test" {
5543 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5544 set val $expect_out(1,string)
5548 fail "$test (timeout)"
5554 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5555 # (using "print /x"). DEFAULT is used as fallback if print fails.
5556 # TEST is the test message to use. If can be ommitted, in which case
5557 # a test message is built from EXP.
5559 proc get_hexadecimal_valueof { exp default {test ""} } {
5563 set test "get hexadecimal valueof \"${exp}\""
5567 gdb_test_multiple "print /x ${exp}" $test {
5568 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5569 set val $expect_out(1,string)
5576 proc get_sizeof { type default } {
5577 return [get_integer_valueof "sizeof (${type})" $default]
5580 proc get_target_charset { } {
5583 gdb_test_multiple "show target-charset" "" {
5584 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5585 return $expect_out(1,string)
5587 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5588 return $expect_out(1,string)
5592 # Pick a reasonable default.
5593 warning "Unable to read target-charset."
5597 # Get the address of VAR.
5599 proc get_var_address { var } {
5600 global gdb_prompt hex
5602 # Match output like:
5604 # $5 = (int (*)()) 0
5605 # $6 = (int (*)()) 0x24 <function_bar>
5607 gdb_test_multiple "print &${var}" "get address of ${var}" {
5608 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5610 pass "get address of ${var}"
5611 if { $expect_out(1,string) == "0" } {
5614 return $expect_out(1,string)
5621 # Get the current value for remotetimeout and return it.
5622 proc get_remotetimeout { } {
5626 gdb_test_multiple "show remotetimeout" "" {
5627 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5628 return $expect_out(1,string)
5632 # Pick the default that gdb uses
5633 warning "Unable to read remotetimeout"
5637 # Set the remotetimeout to the specified timeout. Nothing is returned.
5638 proc set_remotetimeout { timeout } {
5641 gdb_test_multiple "set remotetimeout $timeout" "" {
5642 -re "$gdb_prompt $" {
5643 verbose "Set remotetimeout to $timeout\n"
5648 # ROOT and FULL are file names. Returns the relative path from ROOT
5649 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5650 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5653 proc relative_filename {root full} {
5654 set root_split [file split $root]
5655 set full_split [file split $full]
5657 set len [llength $root_split]
5659 if {[eval file join $root_split]
5660 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5661 error "$full not a subdir of $root"
5664 return [eval file join [lrange $full_split $len end]]
5667 # Log gdb command line and script if requested.
5668 if {[info exists TRANSCRIPT]} {
5669 rename send_gdb real_send_gdb
5670 rename remote_spawn real_remote_spawn
5671 rename remote_close real_remote_close
5673 global gdb_transcript
5674 set gdb_transcript ""
5676 global gdb_trans_count
5677 set gdb_trans_count 1
5679 proc remote_spawn {args} {
5680 global gdb_transcript gdb_trans_count outdir
5682 if {$gdb_transcript != ""} {
5683 close $gdb_transcript
5685 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5686 puts $gdb_transcript [lindex $args 1]
5687 incr gdb_trans_count
5689 return [uplevel real_remote_spawn $args]
5692 proc remote_close {args} {
5693 global gdb_transcript
5695 if {$gdb_transcript != ""} {
5696 close $gdb_transcript
5697 set gdb_transcript ""
5700 return [uplevel real_remote_close $args]
5703 proc send_gdb {args} {
5704 global gdb_transcript
5706 if {$gdb_transcript != ""} {
5707 puts -nonewline $gdb_transcript [lindex $args 0]
5710 return [uplevel real_send_gdb $args]
5714 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5715 if {[info exists GDB_PARALLEL]} {
5716 if {[is_remote host]} {
5720 [make_gdb_parallel_path outputs] \
5721 [make_gdb_parallel_path temp] \
5722 [make_gdb_parallel_path cache]
5726 proc core_find {binfile {deletefiles {}} {arg ""}} {
5727 global objdir subdir
5729 set destcore "$binfile.core"
5730 file delete $destcore
5732 # Create a core file named "$destcore" rather than just "core", to
5733 # avoid problems with sys admin types that like to regularly prune all
5734 # files named "core" from the system.
5736 # Arbitrarily try setting the core size limit to "unlimited" since
5737 # this does not hurt on systems where the command does not work and
5738 # allows us to generate a core on systems where it does.
5740 # Some systems append "core" to the name of the program; others append
5741 # the name of the program to "core"; still others (like Linux, as of
5742 # May 2003) create cores named "core.PID". In the latter case, we
5743 # could have many core files lying around, and it may be difficult to
5744 # tell which one is ours, so let's run the program in a subdirectory.
5746 set coredir [standard_output_file coredir.[getpid]]
5748 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5749 # remote_exec host "${binfile}"
5750 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5751 if [remote_file build exists $i] {
5752 remote_exec build "mv $i $destcore"
5756 # Check for "core.PID".
5757 if { $found == 0 } {
5758 set names [glob -nocomplain -directory $coredir core.*]
5759 if {[llength $names] == 1} {
5760 set corefile [file join $coredir [lindex $names 0]]
5761 remote_exec build "mv $corefile $destcore"
5765 if { $found == 0 } {
5766 # The braindamaged HPUX shell quits after the ulimit -c above
5767 # without executing ${binfile}. So we try again without the
5768 # ulimit here if we didn't find a core file above.
5769 # Oh, I should mention that any "braindamaged" non-Unix system has
5770 # the same problem. I like the cd bit too, it's really neat'n stuff.
5771 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5772 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5773 if [remote_file build exists $i] {
5774 remote_exec build "mv $i $destcore"
5780 # Try to clean up after ourselves.
5781 foreach deletefile $deletefiles {
5782 remote_file build delete [file join $coredir $deletefile]
5784 remote_exec build "rmdir $coredir"
5786 if { $found == 0 } {
5787 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5793 # gdb_target_symbol_prefix compiles a test program and then examines
5794 # the output from objdump to determine the prefix (such as underscore)
5795 # for linker symbol prefixes.
5797 gdb_caching_proc gdb_target_symbol_prefix {
5798 # Set up and compile a simple test program...
5799 set src [standard_temp_file main[pid].c]
5800 set exe [standard_temp_file main[pid].x]
5802 gdb_produce_source $src {
5808 verbose "compiling testfile $src" 2
5809 set compile_flags {debug nowarnings quiet}
5810 set lines [gdb_compile $src $exe executable $compile_flags]
5814 if ![string match "" $lines] then {
5815 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5817 set objdump_program [gdb_find_objdump]
5818 set result [catch "exec $objdump_program --syms $exe" output]
5821 && ![regexp -lineanchor \
5822 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5823 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5833 # gdb_target_symbol returns the provided symbol with the correct prefix
5834 # prepended. (See gdb_target_symbol_prefix, above.)
5836 proc gdb_target_symbol { symbol } {
5837 set prefix [gdb_target_symbol_prefix]
5838 return "${prefix}${symbol}"
5841 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5842 # added to gdb_compile options to define the C-preprocessor macro
5843 # SYMBOL_PREFIX with a value that can be prepended to symbols
5844 # for targets which require a prefix, such as underscore.
5846 # This version (_asm) defines the prefix without double quotes
5847 # surrounding the prefix. It is used to define the macro
5848 # SYMBOL_PREFIX for assembly language files. Another version, below,
5849 # is used for symbols in inline assembler in C/C++ files.
5851 # The lack of quotes in this version (_asm) makes it possible to
5852 # define supporting macros in the .S file. (The version which
5853 # uses quotes for the prefix won't work for such files since it's
5854 # impossible to define a quote-stripping macro in C.)
5856 # It's possible to use this version (_asm) for C/C++ source files too,
5857 # but a string is usually required in such files; providing a version
5858 # (no _asm) which encloses the prefix with double quotes makes it
5859 # somewhat easier to define the supporting macros in the test case.
5861 proc gdb_target_symbol_prefix_flags_asm {} {
5862 set prefix [gdb_target_symbol_prefix]
5863 if {$prefix ne ""} {
5864 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5870 # gdb_target_symbol_prefix_flags returns the same string as
5871 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5872 # enclosed in double quotes if there is a prefix.
5874 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5875 # extended discussion.
5877 proc gdb_target_symbol_prefix_flags {} {
5878 set prefix [gdb_target_symbol_prefix]
5879 if {$prefix ne ""} {
5880 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5886 # A wrapper for 'remote_exec host' that passes or fails a test.
5887 # Returns 0 if all went well, nonzero on failure.
5888 # TEST is the name of the test, other arguments are as for remote_exec.
5890 proc run_on_host { test program args } {
5891 verbose -log "run_on_host: $program $args"
5892 # remote_exec doesn't work properly if the output is set but the
5893 # input is the empty string -- so replace an empty input with
5895 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5896 set args [lreplace $args 1 1 "/dev/null"]
5898 set result [eval remote_exec host [list $program] $args]
5899 verbose "result is $result"
5900 set status [lindex $result 0]
5901 set output [lindex $result 1]
5906 verbose -log "run_on_host failed: $output"
5912 # Return non-zero if "board_info debug_flags" mentions Fission.
5913 # http://gcc.gnu.org/wiki/DebugFission
5914 # Fission doesn't support everything yet.
5915 # This supports working around bug 15954.
5917 proc using_fission { } {
5918 set debug_flags [board_info [target_info name] debug_flags]
5919 return [regexp -- "-gsplit-dwarf" $debug_flags]
5922 # Search the caller's ARGS list and set variables according to the list of
5923 # valid options described by ARGSET.
5925 # The first member of each one- or two-element list in ARGSET defines the
5926 # name of a variable that will be added to the caller's scope.
5928 # If only one element is given to describe an option, it the value is
5929 # 0 if the option is not present in (the caller's) ARGS or 1 if
5932 # If two elements are given, the second element is the default value of
5933 # the variable. This is then overwritten if the option exists in ARGS.
5935 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5936 # any optional components.
5939 # proc myproc {foo args} {
5940 # parse_args {{bar} {baz "abc"} {qux}}
5943 # myproc ABC -bar -baz DEF peanut butter
5944 # will define the following variables in myproc:
5945 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5946 # args will be the list {peanut butter}
5948 proc parse_args { argset } {
5951 foreach argument $argset {
5952 if {[llength $argument] == 1} {
5953 # No default specified, so we assume that we should set
5954 # the value to 1 if the arg is present and 0 if it's not.
5955 # It is assumed that no value is given with the argument.
5956 set result [lsearch -exact $args "-$argument"]
5957 if {$result != -1} then {
5958 uplevel 1 [list set $argument 1]
5959 set args [lreplace $args $result $result]
5961 uplevel 1 [list set $argument 0]
5963 } elseif {[llength $argument] == 2} {
5964 # There are two items in the argument. The second is a
5965 # default value to use if the item is not present.
5966 # Otherwise, the variable is set to whatever is provided
5967 # after the item in the args.
5968 set arg [lindex $argument 0]
5969 set result [lsearch -exact $args "-[lindex $arg 0]"]
5970 if {$result != -1} then {
5971 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5972 set args [lreplace $args $result [expr $result+1]]
5974 uplevel 1 [list set $arg [lindex $argument 1]]
5977 error "Badly formatted argument \"$argument\" in argument set"
5981 # The remaining args should be checked to see that they match the
5982 # number of items expected to be passed into the procedure...
5985 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5986 # return that string.
5988 proc capture_command_output { command prefix } {
5992 set output_string ""
5993 gdb_test_multiple "$command" "capture_command_output for $command" {
5994 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5995 set output_string $expect_out(1,string)
5998 return $output_string
6001 # A convenience function that joins all the arguments together, with a
6002 # regexp that matches exactly one end of line in between each argument.
6003 # This function is ideal to write the expected output of a GDB command
6004 # that generates more than a couple of lines, as this allows us to write
6005 # each line as a separate string, which is easier to read by a human
6008 proc multi_line { args } {
6009 return [join $args "\r\n"]
6012 # Similar to the above, but while multi_line is meant to be used to
6013 # match GDB output, this one is meant to be used to build strings to
6014 # send as GDB input.
6016 proc multi_line_input { args } {
6017 return [join $args "\n"]
6021 # Always load compatibility stuff.