1 # Copyright 1992-2019 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
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
89 # absolute path ie. /foo/
90 set fullname_syntax_POSIX {/[^\n]*/}
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
92 # UNC path ie. \\D\foo\
93 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
96 # ie. \foo\, but don't match \\.*\
97 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
99 # ie. a:\foo\ && a:foo\
100 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
103 # d:foo and \abc should be considered valid as an absolute path.
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
112 if ![info exists env(EXEEXT)] {
115 set EXEEXT $env(EXEEXT)
120 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
122 # A regular expression that matches a value history number.
124 set valnum_re "\\\$$decimal"
126 ### Only procedures should come after this point.
129 # gdb_version -- extract and print the version number of GDB
131 proc default_gdb_version {} {
133 global INTERNAL_GDBFLAGS GDBFLAGS
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
144 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
145 if ![is_remote host] {
146 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
148 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
152 proc gdb_version { } {
153 return [default_gdb_version]
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
170 send_gdb "y\n" answer
173 -re "Discard symbol table from .*y or n.*$" {
174 send_gdb "y\n" answer
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
204 send_gdb "y\n" answer
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # The second pattern below matches up to the first newline *only*.
246 # Using ``.*$'' could swallow up output that we attempt to match
249 # N.B. This function does not wait for gdb to return to the prompt,
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
256 send_gdb "$command\n"
258 -re "$gdb_prompt $" { }
260 perror "gdb_init_command for target failed"
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
271 send_gdb "continue\n"
273 -re "Continu\[^\r\n\]*\[\r\n\]" {}
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
284 send_gdb "jump *$start\n"
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
290 if [expr $start_attempt > 3] {
291 perror "Jump to start() failed (retry count exceeded)"
294 set start_attempt [expr $start_attempt + 1]
296 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
299 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
300 perror "Can't find start symbol to run in gdb_run"
303 -re "No symbol \"start\" in current.*$gdb_prompt $" {
304 send_gdb "jump *_start\n"
306 -re "No symbol.*context.*$gdb_prompt $" {
309 -re "Line.* Jump anyway.*y or n. $" {
310 send_gdb "y\n" answer
312 -re "The program is not being run.*$gdb_prompt $" {
313 if { [gdb_reload] != 0 } {
316 send_gdb "jump *$start\n"
319 perror "Jump to start() failed (timeout)"
327 if [target_info exists gdb,do_reload_on_run] {
328 if { [gdb_reload] != 0 } {
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
337 -re "The program .* has been started already.*y or n. $" {
338 send_gdb "y\n" answer
341 -notransfer -re "Starting program: \[^\r\n\]*" {}
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
348 # Generic start command. Return 0 if we could start the program, -1
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
354 proc gdb_start_cmd {args} {
355 global gdb_prompt use_gdb_stub
357 foreach command [gdb_init_commands] {
358 send_gdb "$command\n"
360 -re "$gdb_prompt $" { }
362 perror "gdb_init_command for target failed"
372 send_gdb "start $args\n"
373 # Use -notransfer here so that test cases (like chng-sym.exp)
374 # may test for additional start-up messages.
376 -re "The program .* has been started already.*y or n. $" {
377 send_gdb "y\n" answer
380 -notransfer -re "Starting program: \[^\r\n\]*" {
387 # Generic starti command. Return 0 if we could start the program, -1
390 # N.B. This function does not wait for gdb to return to the prompt,
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
397 send_gdb "$command\n"
399 -re "$gdb_prompt $" { }
401 perror "gdb_init_command for target failed"
411 send_gdb "starti $args\n"
413 -re "The program .* has been started already.*y or n. $" {
414 send_gdb "y\n" answer
417 -re "Starting program: \[^\r\n\]*" {
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
429 # Note: The handling of message vs no-message is messed up, but it's based
430 # on historical usage. By default this function does not print passes,
432 # no-message: turns off printing of fails (and passes, but they're already off)
433 # message: turns on printing of passes (and fails, but they're already on)
435 proc gdb_breakpoint { function args } {
439 set pending_response n
440 if {[lsearch -exact $args allow-pending] != -1} {
441 set pending_response y
444 set break_command "break"
445 set break_message "Breakpoint"
446 if {[lsearch -exact $args temporary] != -1} {
447 set break_command "tbreak"
448 set break_message "Temporary breakpoint"
451 if {[lsearch -exact $args qualified] != -1} {
452 append break_command " -qualified"
457 set no_message_loc [lsearch -exact $args no-message]
458 set message_loc [lsearch -exact $args message]
459 # The last one to appear in args wins.
460 if { $no_message_loc > $message_loc } {
462 } elseif { $message_loc > $no_message_loc } {
466 set test_name "setting breakpoint at $function"
468 send_gdb "$break_command $function\n"
469 # The first two regexps are what we get with -g, the third is without -g.
471 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
474 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
475 if {$pending_response == "n"} {
482 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
483 send_gdb "$pending_response\n"
486 -re "A problem internal to GDB has been detected" {
488 fail "$test_name (GDB internal error)"
490 gdb_internal_error_resync
493 -re "$gdb_prompt $" {
501 fail "$test_name (eof)"
507 fail "$test_name (timeout)"
518 # Set breakpoint at function and run gdb until it breaks there.
519 # Since this is the only breakpoint that will be set, if it stops
520 # at a breakpoint, we will assume it is the one we want. We can't
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
529 # no-message: turns off printing of fails (and passes, but they're already off)
530 # message: turns on printing of passes (and fails, but they're already on)
532 proc runto { function args } {
538 # Default to "no-message".
539 set args "no-message $args"
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
548 } elseif { $message_loc > $no_message_loc } {
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
557 # elements, and we don't want Tcl to move the remaining elements after
558 # the first to $args. That is why $function is wrapped in {}.
559 if ![eval gdb_breakpoint {$function} $args] {
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
568 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
574 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
580 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
582 unsupported "non-stop mode not supported"
586 -re ".*A problem internal to GDB has been detected" {
588 fail "$test_name (GDB internal error)"
590 gdb_internal_error_resync
593 -re "$gdb_prompt $" {
601 fail "$test_name (eof)"
607 fail "$test_name (timeout)"
618 # Ask gdb to run until we hit a breakpoint at main.
620 # N.B. This function deletes all existing breakpoints.
621 # If you don't want that, use gdb_start_cmd.
623 proc runto_main { } {
624 return [runto main no-message]
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
634 set full_name "continue to breakpoint: $name"
636 set kfail_pattern "Process record does not support instruction 0xfae64 at.*"
637 gdb_test_multiple "continue" $full_name {
638 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
641 -re "\[\r\n\]*(?:$kfail_pattern)\[\r\n\]+$gdb_prompt $" {
642 kfail "gdb/25038" $full_name
648 # gdb_internal_error_resync:
650 # Answer the questions GDB asks after it reports an internal error
651 # until we get back to a GDB prompt. Decline to quit the debugging
652 # session, and decline to create a core file. Return non-zero if the
655 # This procedure just answers whatever questions come up until it sees
656 # a GDB prompt; it doesn't require you to have matched the input up to
657 # any specific point. However, it only answers questions it sees in
658 # the output itself, so if you've matched a question, you had better
659 # answer it yourself before calling this.
661 # You can use this function thus:
665 # -re ".*A problem internal to GDB has been detected" {
666 # gdb_internal_error_resync
671 proc gdb_internal_error_resync {} {
674 verbose -log "Resyncing due to internal error."
677 while {$count < 10} {
679 -re "Quit this debugging session\\? \\(y or n\\) $" {
680 send_gdb "n\n" answer
683 -re "Create a core file of GDB\\? \\(y or n\\) $" {
684 send_gdb "n\n" answer
687 -re "$gdb_prompt $" {
688 # We're resynchronized.
692 perror "Could not resync from internal error (timeout)"
697 perror "Could not resync from internal error (resync count exceeded)"
702 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS PROMPT_REGEXP
703 # Send a command to gdb; test the result.
705 # COMMAND is the command to execute, send to GDB with send_gdb. If
706 # this is the null string no command is sent.
707 # MESSAGE is a message to be printed with the built-in failure patterns
708 # if one of them matches. If MESSAGE is empty COMMAND will be used.
709 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
710 # patterns. Pattern elements will be evaluated in the caller's
711 # context; action elements will be executed in the caller's context.
712 # Unlike patterns for gdb_test, these patterns should generally include
713 # the final newline and prompt.
714 # PROMPT_REGEXP is a regexp matching the expected prompt after the command
715 # output. If empty, defaults to "$gdb_prompt $"
718 # 1 if the test failed, according to a built-in failure pattern
719 # 0 if only user-supplied patterns matched
720 # -1 if there was an internal error.
722 # You can use this function thus:
724 # gdb_test_multiple "print foo" "test foo" {
725 # -re "expected output 1" {
728 # -re "expected output 2" {
733 # Within action elements you can also make use of the variable
734 # gdb_test_name. This variable is setup automatically by
735 # gdb_test_multiple, and contains the value of MESSAGE. You can then
736 # write this, which is equivalent to the above:
738 # gdb_test_multiple "print foo" "test foo" {
739 # -re "expected output 1" {
740 # pass $gdb_test_name
742 # -re "expected output 2" {
743 # fail $gdb_test_name
747 # Like with "expect", you can also specify the spawn id to match with
748 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
749 # $gdb_spawn_id. The former matches inferior I/O, while the latter
750 # matches GDB I/O. E.g.:
752 # send_inferior "hello\n"
753 # gdb_test_multiple "continue" "test echo" {
754 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
757 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
758 # fail "hit breakpoint"
762 # The standard patterns, such as "Inferior exited..." and "A problem
763 # ...", all being implicitly appended to that list. These are always
764 # expected from $gdb_spawn_id. IOW, callers do not need to worry
765 # about resetting "-i" back to $gdb_spawn_id explicitly.
767 # In EXPECT_ARGUMENTS we can use a -wrap pattern flag, that wraps the regexp
768 # pattern as gdb_test wraps its message argument.
769 # This allows us to rewrite:
770 # gdb_test <command> <pattern> <message>
772 # gdb_test_multiple <command> <message> {
773 # -re -wrap <pattern> {
774 # pass $gdb_test_name
778 # In EXPECT_ARGUMENTS, a pattern flag -early can be used. It makes sure the
779 # pattern is inserted before any implicit pattern added by gdb_test_multiple.
780 # Using this pattern flag, we can f.i. setup a kfail for an assertion failure
781 # <assert> during gdb_continue_to_breakpoint by the rewrite:
782 # gdb_continue_to_breakpoint <msg> <pattern>
784 # set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
785 # gdb_test_multiple "continue" "continue to breakpoint: <msg>" {
786 # -early -re "internal-error: <assert>" {
787 # setup_kfail gdb/nnnnn "*-*-*"
790 # -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
791 # pass $gdb_test_name
795 proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
796 global verbose use_gdb_stub
797 global gdb_prompt pagination_prompt
800 global inferior_exited_re
801 upvar timeout timeout
802 upvar expect_out expect_out
805 if { "$prompt_regexp" == "" } {
806 set prompt_regexp "$gdb_prompt $"
809 if { $message == "" } {
813 if [string match "*\[\r\n\]" $command] {
814 error "Invalid trailing newline in \"$message\" test"
817 if [string match "*\[\r\n\]*" $message] {
818 error "Invalid newline in \"$message\" test"
822 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
824 error "gdbserver does not support $command without extended-remote"
827 # TCL/EXPECT WART ALERT
828 # Expect does something very strange when it receives a single braced
829 # argument. It splits it along word separators and performs substitutions.
830 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
831 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
832 # double-quoted list item, "\[ab\]" is just a long way of representing
833 # "[ab]", because the backslashes will be removed by lindex.
835 # Unfortunately, there appears to be no easy way to duplicate the splitting
836 # that expect will do from within TCL. And many places make use of the
837 # "\[0-9\]" construct, so we need to support that; and some places make use
838 # of the "[func]" construct, so we need to support that too. In order to
839 # get this right we have to substitute quoted list elements differently
840 # from braced list elements.
842 # We do this roughly the same way that Expect does it. We have to use two
843 # lists, because if we leave unquoted newlines in the argument to uplevel
844 # they'll be treated as command separators, and if we escape newlines
845 # we mangle newlines inside of command blocks. This assumes that the
846 # input doesn't contain a pattern which contains actual embedded newlines
849 regsub -all {\n} ${user_code} { } subst_code
850 set subst_code [uplevel list $subst_code]
852 set processed_code ""
853 set early_processed_code ""
854 # The variable current_list holds the name of the currently processed
855 # list, either processed_code or early_processed_code.
856 set current_list "processed_code"
858 set expecting_action 0
861 foreach item $user_code subst_item $subst_code {
862 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
863 lappend $current_list $item
866 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
867 lappend $current_list $item
870 if { $item == "-early" } {
871 set current_list "early_processed_code"
874 if { $item == "-timeout" || $item == "-i" } {
876 lappend $current_list $item
879 if { $item == "-wrap" } {
883 if { $expecting_arg } {
885 lappend $current_list $subst_item
888 if { $expecting_action } {
889 lappend $current_list "uplevel [list $item]"
890 set expecting_action 0
891 # Cosmetic, no effect on the list.
892 append $current_list "\n"
893 # End the effect of -early, it only applies to one action.
894 set current_list "processed_code"
897 set expecting_action 1
898 if { $wrap_pattern } {
899 # Wrap subst_item as is done for the gdb_test PATTERN argument.
900 lappend $current_list \
901 "\[\r\n\]*(?:$subst_item)\[\r\n\]+$gdb_prompt $"
904 lappend $current_list $subst_item
906 if {$patterns != ""} {
909 append patterns "\"$subst_item\""
912 # Also purely cosmetic.
913 regsub -all {\r} $patterns {\\r} patterns
914 regsub -all {\n} $patterns {\\n} patterns
917 send_user "Sending \"$command\" to gdb\n"
918 send_user "Looking to match \"$patterns\"\n"
919 send_user "Message is \"$message\"\n"
923 set string "${command}\n"
924 if { $command != "" } {
925 set multi_line_re "\[\r\n\] *>"
926 while { "$string" != "" } {
927 set foo [string first "\n" "$string"]
928 set len [string length "$string"]
929 if { $foo < [expr $len - 1] } {
930 set str [string range "$string" 0 $foo]
931 if { [send_gdb "$str"] != "" } {
934 if { ! $suppress_flag } {
935 perror "Couldn't send $command to GDB."
940 # since we're checking if each line of the multi-line
941 # command are 'accepted' by GDB here,
942 # we need to set -notransfer expect option so that
943 # command output is not lost for pattern matching
946 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
947 timeout { verbose "partial: timeout" 3 }
949 set string [string range "$string" [expr $foo + 1] end]
950 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
955 if { "$string" != "" } {
956 if { [send_gdb "$string"] != "" } {
959 if { ! $suppress_flag } {
960 perror "Couldn't send $command to GDB."
968 set code $early_processed_code
970 -re ".*A problem internal to GDB has been detected" {
971 fail "$message (GDB internal error)"
972 gdb_internal_error_resync
975 -re "\\*\\*\\* DOSEXIT code.*" {
976 if { $message != "" } {
979 gdb_suppress_entire_file "GDB died"
983 append code $processed_code
985 # Reset the spawn id, in case the processed code used -i.
991 -re "Ending remote debugging.*$prompt_regexp" {
992 if ![isnative] then {
993 warning "Can`t communicate to remote target."
999 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
1000 perror "Undefined command \"$command\"."
1004 -re "Ambiguous command.*$prompt_regexp" {
1005 perror "\"$command\" is not a unique command name."
1009 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
1010 if ![string match "" $message] then {
1011 set errmsg "$message (the program exited)"
1013 set errmsg "$command (the program exited)"
1018 -re "$inferior_exited_re normally.*$prompt_regexp" {
1019 if ![string match "" $message] then {
1020 set errmsg "$message (the program exited)"
1022 set errmsg "$command (the program exited)"
1027 -re "The program is not being run.*$prompt_regexp" {
1028 if ![string match "" $message] then {
1029 set errmsg "$message (the program is no longer running)"
1031 set errmsg "$command (the program is no longer running)"
1036 -re "\r\n$prompt_regexp" {
1037 if ![string match "" $message] then {
1042 -re "$pagination_prompt" {
1044 perror "Window too small."
1048 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
1049 send_gdb "n\n" answer
1050 gdb_expect -re "$prompt_regexp"
1051 fail "$message (got interactive prompt)"
1054 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1056 gdb_expect -re "$prompt_regexp"
1057 fail "$message (got breakpoint menu)"
1063 perror "GDB process no longer exists"
1064 set wait_status [wait -i $gdb_spawn_id]
1065 verbose -log "GDB process exited with wait status $wait_status"
1066 if { $message != "" } {
1073 # Now patterns that apply to any spawn id specified.
1077 perror "Process no longer exists"
1078 if { $message != "" } {
1084 perror "internal buffer is full."
1089 if ![string match "" $message] then {
1090 fail "$message (timeout)"
1096 # remote_expect calls the eof section if there is an error on the
1097 # expect call. We already have eof sections above, and we don't
1098 # want them to get called in that situation. Since the last eof
1099 # section becomes the error section, here we define another eof
1100 # section, but with an empty spawn_id list, so that it won't ever
1104 # This comment is here because the eof section must not be
1105 # the empty string, otherwise remote_expect won't realize
1110 # Create gdb_test_name in the parent scope. If this variable
1111 # already exists, which it might if we have nested calls to
1112 # gdb_test_multiple, then preserve the old value, otherwise,
1113 # create a new variable in the parent scope.
1114 upvar gdb_test_name gdb_test_name
1115 if { [info exists gdb_test_name] } {
1116 set gdb_test_name_old "$gdb_test_name"
1118 set gdb_test_name "$message"
1121 set code [catch {gdb_expect $code} string]
1123 # Clean up the gdb_test_name variable. If we had a
1124 # previous value then restore it, otherwise, delete the variable
1125 # from the parent scope.
1126 if { [info exists gdb_test_name_old] } {
1127 set gdb_test_name "$gdb_test_name_old"
1133 global errorInfo errorCode
1134 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1135 } elseif {$code > 1} {
1136 return -code $code $string
1141 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1142 # Send a command to gdb; test the result.
1144 # COMMAND is the command to execute, send to GDB with send_gdb. If
1145 # this is the null string no command is sent.
1146 # PATTERN is the pattern to match for a PASS, and must NOT include
1147 # the \r\n sequence immediately before the gdb prompt. This argument
1148 # may be omitted to just match the prompt, ignoring whatever output
1150 # MESSAGE is an optional message to be printed. If this is
1151 # omitted, then the pass/fail messages use the command string as the
1152 # message. (If this is the empty string, then sometimes we don't
1153 # call pass or fail at all; I don't understand this at all.)
1154 # QUESTION is a question GDB may ask in response to COMMAND, like
1156 # RESPONSE is the response to send if QUESTION appears.
1159 # 1 if the test failed,
1160 # 0 if the test passes,
1161 # -1 if there was an internal error.
1163 proc gdb_test { args } {
1165 upvar timeout timeout
1167 if [llength $args]>2 then {
1168 set message [lindex $args 2]
1170 set message [lindex $args 0]
1172 set command [lindex $args 0]
1173 set pattern [lindex $args 1]
1177 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1178 if ![string match "" $message] then {
1184 if { [llength $args] == 5 } {
1185 set question_string [lindex $args 3]
1186 set response_string [lindex $args 4]
1188 -re "(${question_string})$" {
1189 send_gdb "$response_string\n"
1195 set user_code [join $user_code]
1196 return [gdb_test_multiple $command $message $user_code]
1199 # Return 1 if version MAJOR.MINOR is at least AT_LEAST_MAJOR.AT_LEAST_MINOR.
1200 proc version_at_least { major minor at_least_major at_least_minor} {
1201 if { $major > $at_least_major } {
1203 } elseif { $major == $at_least_major \
1204 && $minor >= $at_least_minor } {
1211 # Return 1 if tcl version used is at least MAJOR.MINOR
1212 proc tcl_version_at_least { major minor } {
1214 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1215 dummy tcl_version_major tcl_version_minor
1216 return [version_at_least $tcl_version_major $tcl_version_minor \
1220 if { [tcl_version_at_least 8 5] == 0 } {
1221 # lrepeat was added in tcl 8.5. Only add if missing.
1222 proc lrepeat { n element } {
1223 if { [string is integer -strict $n] == 0 } {
1224 error "expected integer but got \"$n\""
1227 error "bad count \"$n\": must be integer >= 0"
1230 for {set i 0} {$i < $n} {incr i} {
1231 lappend res $element
1237 # gdb_test_no_output COMMAND MESSAGE
1238 # Send a command to GDB and verify that this command generated no output.
1240 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1241 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1242 # the message. (If MESSAGE is the empty string, then sometimes we do not
1243 # call pass or fail at all; I don't understand this at all.)
1245 proc gdb_test_no_output { args } {
1247 set command [lindex $args 0]
1248 if [llength $args]>1 then {
1249 set message [lindex $args 1]
1251 set message $command
1254 set command_regex [string_to_regexp $command]
1255 gdb_test_multiple $command $message {
1256 -re "^$command_regex\r\n$gdb_prompt $" {
1257 if ![string match "" $message] then {
1264 # Send a command and then wait for a sequence of outputs.
1265 # This is useful when the sequence is long and contains ".*", a single
1266 # regexp to match the entire output can get a timeout much easier.
1268 # COMMAND is the command to execute, send to GDB with send_gdb. If
1269 # this is the null string no command is sent.
1270 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1271 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1272 # processed in order, and all must be present in the output.
1274 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1275 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1276 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1278 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1279 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1282 # 1 if the test failed,
1283 # 0 if the test passes,
1284 # -1 if there was an internal error.
1286 proc gdb_test_sequence { command test_name expected_output_list } {
1288 if { $test_name == "" } {
1289 set test_name $command
1291 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1292 if { $command != "" } {
1293 send_gdb "$command\n"
1295 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1299 # Test that a command gives an error. For pass or fail, return
1300 # a 1 to indicate that more tests can proceed. However a timeout
1301 # is a serious error, generates a special fail message, and causes
1302 # a 0 to be returned to indicate that more tests are likely to fail
1305 proc test_print_reject { args } {
1309 if [llength $args]==2 then {
1310 set expectthis [lindex $args 1]
1312 set expectthis "should never match this bogus string"
1314 set sendthis [lindex $args 0]
1315 if $verbose>2 then {
1316 send_user "Sending \"$sendthis\" to gdb\n"
1317 send_user "Looking to match \"$expectthis\"\n"
1319 send_gdb "$sendthis\n"
1320 #FIXME: Should add timeout as parameter.
1322 -re "A .* in expression.*\\.*$gdb_prompt $" {
1323 pass "reject $sendthis"
1326 -re "Invalid syntax in expression.*$gdb_prompt $" {
1327 pass "reject $sendthis"
1330 -re "Junk after end of expression.*$gdb_prompt $" {
1331 pass "reject $sendthis"
1334 -re "Invalid number.*$gdb_prompt $" {
1335 pass "reject $sendthis"
1338 -re "Invalid character constant.*$gdb_prompt $" {
1339 pass "reject $sendthis"
1342 -re "No symbol table is loaded.*$gdb_prompt $" {
1343 pass "reject $sendthis"
1346 -re "No symbol .* in current context.*$gdb_prompt $" {
1347 pass "reject $sendthis"
1350 -re "Unmatched single quote.*$gdb_prompt $" {
1351 pass "reject $sendthis"
1354 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1355 pass "reject $sendthis"
1358 -re "$expectthis.*$gdb_prompt $" {
1359 pass "reject $sendthis"
1362 -re ".*$gdb_prompt $" {
1363 fail "reject $sendthis"
1367 fail "reject $sendthis (eof or timeout)"
1374 # Same as gdb_test, but the second parameter is not a regexp,
1375 # but a string that must match exactly.
1377 proc gdb_test_exact { args } {
1378 upvar timeout timeout
1380 set command [lindex $args 0]
1382 # This applies a special meaning to a null string pattern. Without
1383 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1384 # messages from commands that should have no output except a new
1385 # prompt. With this, only results of a null string will match a null
1388 set pattern [lindex $args 1]
1389 if [string match $pattern ""] {
1390 set pattern [string_to_regexp [lindex $args 0]]
1392 set pattern [string_to_regexp [lindex $args 1]]
1395 # It is most natural to write the pattern argument with only
1396 # embedded \n's, especially if you are trying to avoid Tcl quoting
1397 # problems. But gdb_expect really wants to see \r\n in patterns. So
1398 # transform the pattern here. First transform \r\n back to \n, in
1399 # case some users of gdb_test_exact already do the right thing.
1400 regsub -all "\r\n" $pattern "\n" pattern
1401 regsub -all "\n" $pattern "\r\n" pattern
1402 if [llength $args]==3 then {
1403 set message [lindex $args 2]
1404 return [gdb_test $command $pattern $message]
1407 return [gdb_test $command $pattern]
1410 # Wrapper around gdb_test_multiple that looks for a list of expected
1411 # output elements, but which can appear in any order.
1412 # CMD is the gdb command.
1413 # NAME is the name of the test.
1414 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1416 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1417 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1418 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1420 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1421 # of text per element and then strip trailing \r\n's.
1423 # gdb_test_list_exact "foo" "bar" \
1424 # "\[^\r\n\]+\[\r\n\]+" \
1427 # {expected result 1} \
1428 # {expected result 2} \
1431 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1434 set matches [lsort $result_match_list]
1436 gdb_test_multiple $cmd $name {
1437 "$cmd\[\r\n\]" { exp_continue }
1438 -re $elm_find_regexp {
1439 set str $expect_out(0,string)
1440 verbose -log "seen: $str" 3
1441 regexp -- $elm_extract_regexp $str elm_seen
1442 verbose -log "extracted: $elm_seen" 3
1443 lappend seen $elm_seen
1446 -re "$gdb_prompt $" {
1448 foreach got [lsort $seen] have $matches {
1449 if {![string equal $got $have]} {
1454 if {[string length $failed] != 0} {
1455 fail "$name ($failed not found)"
1463 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1464 # Send a command to gdb; expect inferior and gdb output.
1466 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1469 # INFERIOR_PATTERN is the pattern to match against inferior output.
1471 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1472 # include the \r\n sequence immediately before the gdb prompt, nor the
1473 # prompt. The default is empty.
1475 # Both inferior and gdb patterns must match for a PASS.
1477 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1480 # 1 if the test failed,
1481 # 0 if the test passes,
1482 # -1 if there was an internal error.
1485 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1486 global inferior_spawn_id gdb_spawn_id
1489 if {$message == ""} {
1490 set message $command
1493 set inferior_matched 0
1496 # Use an indirect spawn id list, and remove the inferior spawn id
1497 # from the expected output as soon as it matches, in case
1498 # $inferior_pattern happens to be a prefix of the resulting full
1499 # gdb pattern below (e.g., "\r\n").
1500 global gdb_test_stdio_spawn_id_list
1501 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1503 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1504 # then we may see gdb's output arriving before the inferior's
1506 set res [gdb_test_multiple $command $message {
1507 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1508 set inferior_matched 1
1509 if {!$gdb_matched} {
1510 set gdb_test_stdio_spawn_id_list ""
1514 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1516 if {!$inferior_matched} {
1524 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1529 # get_print_expr_at_depths EXP OUTPUTS
1531 # Used for testing 'set print max-depth'. Prints the expression EXP
1532 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1533 # of `n` different patterns to match at each of the depths from 0 to
1536 # This proc does one final check with the max-depth set to 'unlimited'
1537 # which is tested against the last pattern in the OUTPUTS list. The
1538 # OUTPUTS list is therefore required to match every depth from 0 to a
1539 # depth where the whole of EXP is printed with no ellipsis.
1541 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1542 proc gdb_print_expr_at_depths {exp outputs} {
1543 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1544 if { $depth == [llength $outputs] } {
1545 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1546 set depth_string "unlimited"
1548 set expected_result [lindex $outputs $depth]
1549 set depth_string $depth
1552 with_test_prefix "exp='$exp': depth=${depth_string}" {
1553 gdb_test_no_output "set print max-depth ${depth_string}"
1554 gdb_test "p $exp" "$expected_result"
1561 # Issue a PASS and return true if evaluating CONDITION in the caller's
1562 # frame returns true, and issue a FAIL and return false otherwise.
1563 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1564 # omitted or is empty, then the pass/fail messages use the condition
1565 # string as the message.
1567 proc gdb_assert { condition {message ""} } {
1568 if { $message == ""} {
1569 set message $condition
1572 set res [uplevel 1 expr $condition]
1581 proc gdb_reinitialize_dir { subdir } {
1584 if [is_remote host] {
1589 -re "Reinitialize source path to empty.*y or n. " {
1590 send_gdb "y\n" answer
1592 -re "Source directories searched.*$gdb_prompt $" {
1593 send_gdb "dir $subdir\n"
1595 -re "Source directories searched.*$gdb_prompt $" {
1596 verbose "Dir set to $subdir"
1598 -re "$gdb_prompt $" {
1599 perror "Dir \"$subdir\" failed."
1603 -re "$gdb_prompt $" {
1604 perror "Dir \"$subdir\" failed."
1608 -re "$gdb_prompt $" {
1609 perror "Dir \"$subdir\" failed."
1615 # gdb_exit -- exit the GDB, killing the target program if necessary
1617 proc default_gdb_exit {} {
1619 global INTERNAL_GDBFLAGS GDBFLAGS
1621 global gdb_spawn_id inferior_spawn_id
1622 global inotify_log_file
1624 gdb_stop_suppressing_tests
1626 if ![info exists gdb_spawn_id] {
1630 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1632 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1633 set fd [open $inotify_log_file]
1634 set data [read -nonewline $fd]
1637 if {[string compare $data ""] != 0} {
1638 warning "parallel-unsafe file creations noticed"
1641 set fd [open $inotify_log_file w]
1646 if { [is_remote host] && [board_info host exists fileid] } {
1650 send_gdb "y\n" answer
1653 -re "DOSEXIT code" { }
1658 if ![is_remote host] {
1662 unset inferior_spawn_id
1665 # Load a file into the debugger.
1666 # The return value is 0 for success, -1 for failure.
1668 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1669 # to one of these values:
1671 # debug file was loaded successfully and has debug information
1672 # nodebug file was loaded successfully and has no debug information
1673 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1675 # fail file was not loaded
1677 # I tried returning this information as part of the return value,
1678 # but ran into a mess because of the many re-implementations of
1679 # gdb_load in config/*.exp.
1681 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1682 # this if they can get more information set.
1684 proc gdb_file_cmd { arg } {
1688 global last_loaded_file
1690 # Save this for the benefit of gdbserver-support.exp.
1691 set last_loaded_file $arg
1693 # Set whether debug info was found.
1694 # Default to "fail".
1695 global gdb_file_cmd_debug_info
1696 set gdb_file_cmd_debug_info "fail"
1698 if [is_remote host] {
1699 set arg [remote_download host $arg]
1701 perror "download failed"
1706 # The file command used to kill the remote target. For the benefit
1707 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
1708 # get written to the stdin log.
1709 send_gdb "kill\n" optional
1711 -re "Kill the program being debugged. .y or n. $" {
1712 send_gdb "y\n" answer
1713 verbose "\t\tKilling previous program being debugged"
1716 -re "$gdb_prompt $" {
1721 send_gdb "file $arg\n"
1723 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1724 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1725 set gdb_file_cmd_debug_info "lzma"
1728 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1729 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1730 set gdb_file_cmd_debug_info "nodebug"
1733 -re "Reading symbols from.*$gdb_prompt $" {
1734 verbose "\t\tLoaded $arg into $GDB"
1735 set gdb_file_cmd_debug_info "debug"
1738 -re "Load new symbol table from \".*\".*y or n. $" {
1739 send_gdb "y\n" answer
1741 -re "Reading symbols from.*$gdb_prompt $" {
1742 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1743 set gdb_file_cmd_debug_info "debug"
1747 perror "Couldn't load $arg, other program already loaded (timeout)."
1751 perror "Couldn't load $arg, other program already loaded (eof)."
1756 -re "No such file or directory.*$gdb_prompt $" {
1757 perror "($arg) No such file or directory"
1760 -re "A problem internal to GDB has been detected" {
1761 fail "($arg) (GDB internal error)"
1762 gdb_internal_error_resync
1765 -re "$gdb_prompt $" {
1766 perror "Couldn't load $arg into $GDB."
1770 perror "Couldn't load $arg into $GDB (timeout)."
1774 # This is an attempt to detect a core dump, but seems not to
1775 # work. Perhaps we need to match .* followed by eof, in which
1776 # gdb_expect does not seem to have a way to do that.
1777 perror "Couldn't load $arg into $GDB (eof)."
1783 # Default gdb_spawn procedure.
1785 proc default_gdb_spawn { } {
1788 global INTERNAL_GDBFLAGS GDBFLAGS
1791 gdb_stop_suppressing_tests
1793 # Set the default value, it may be overriden later by specific testfile.
1795 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1796 # is already started after connecting and run/attach are not supported.
1797 # This is used for the "remote" protocol. After GDB starts you should
1798 # check global $use_gdb_stub instead of the board as the testfile may force
1799 # a specific different target protocol itself.
1800 set use_gdb_stub [target_info exists use_gdb_stub]
1802 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1803 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1805 if [info exists gdb_spawn_id] {
1809 if ![is_remote host] {
1810 if { [which $GDB] == 0 } then {
1811 perror "$GDB does not exist."
1815 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1816 if { $res < 0 || $res == "" } {
1817 perror "Spawning $GDB failed."
1821 set gdb_spawn_id $res
1825 # Default gdb_start procedure.
1827 proc default_gdb_start { } {
1830 global inferior_spawn_id
1832 if [info exists gdb_spawn_id] {
1836 # Keep track of the number of times GDB has been launched.
1837 global gdb_instances
1847 # Default to assuming inferior I/O is done on GDB's terminal.
1848 if {![info exists inferior_spawn_id]} {
1849 set inferior_spawn_id $gdb_spawn_id
1852 # When running over NFS, particularly if running many simultaneous
1853 # tests on different hosts all using the same server, things can
1854 # get really slow. Give gdb at least 3 minutes to start up.
1856 -re "\[\r\n\]$gdb_prompt $" {
1857 verbose "GDB initialized."
1859 -re "$gdb_prompt $" {
1860 perror "GDB never initialized."
1865 perror "(timeout) GDB never initialized after 10 seconds."
1872 # force the height to "unlimited", so no pagers get used
1874 send_gdb "set height 0\n"
1876 -re "$gdb_prompt $" {
1877 verbose "Setting height to 0." 2
1880 warning "Couldn't set the height to 0"
1883 # force the width to "unlimited", so no wraparound occurs
1884 send_gdb "set width 0\n"
1886 -re "$gdb_prompt $" {
1887 verbose "Setting width to 0." 2
1890 warning "Couldn't set the width to 0."
1898 # Utility procedure to give user control of the gdb prompt in a script. It is
1899 # meant to be used for debugging test cases, and should not be left in the
1902 proc gdb_interact { } {
1904 set spawn_id $gdb_spawn_id
1906 send_user "+------------------------------------------+\n"
1907 send_user "| Script interrupted, you can now interact |\n"
1908 send_user "| with by gdb. Type >>> to continue. |\n"
1909 send_user "+------------------------------------------+\n"
1916 # Examine the output of compilation to determine whether compilation
1917 # failed or not. If it failed determine whether it is due to missing
1918 # compiler or due to compiler error. Report pass, fail or unsupported
1921 proc gdb_compile_test {src output} {
1922 if { $output == "" } {
1923 pass "compilation [file tail $src]"
1924 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1925 unsupported "compilation [file tail $src]"
1926 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1927 unsupported "compilation [file tail $src]"
1928 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1929 unsupported "compilation [file tail $src]"
1931 verbose -log "compilation failed: $output" 2
1932 fail "compilation [file tail $src]"
1936 # Return a 1 for configurations for which we don't even want to try to
1939 proc skip_cplus_tests {} {
1940 if { [istarget "h8300-*-*"] } {
1944 # The C++ IO streams are too large for HC11/HC12 and are thus not
1945 # available. The gdb C++ tests use them and don't compile.
1946 if { [istarget "m6811-*-*"] } {
1949 if { [istarget "m6812-*-*"] } {
1955 # Return a 1 for configurations for which don't have both C++ and the STL.
1957 proc skip_stl_tests {} {
1958 # Symbian supports the C++ language, but the STL is missing
1959 # (both headers and libraries).
1960 if { [istarget "arm*-*-symbianelf*"] } {
1964 return [skip_cplus_tests]
1967 # Return a 1 if I don't even want to try to test FORTRAN.
1969 proc skip_fortran_tests {} {
1973 # Return a 1 if I don't even want to try to test ada.
1975 proc skip_ada_tests {} {
1979 # Return a 1 if I don't even want to try to test GO.
1981 proc skip_go_tests {} {
1985 # Return a 1 if I don't even want to try to test D.
1987 proc skip_d_tests {} {
1991 # Return 1 to skip Rust tests, 0 to try them.
1992 proc skip_rust_tests {} {
1993 return [expr {![isnative]}]
1996 # Return a 1 for configurations that do not support Python scripting.
1997 # PROMPT_REGEXP is the expected prompt.
1999 proc skip_python_tests_prompt { prompt_regexp } {
2000 global gdb_py_is_py3k
2002 gdb_test_multiple "python print ('test')" "verify python support" {
2003 -re "not supported.*$prompt_regexp" {
2004 unsupported "Python support is disabled."
2007 -re "$prompt_regexp" {}
2010 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
2011 -re "3.*$prompt_regexp" {
2012 set gdb_py_is_py3k 1
2014 -re ".*$prompt_regexp" {
2015 set gdb_py_is_py3k 0
2022 # Return a 1 for configurations that do not support Python scripting.
2023 # Note: This also sets various globals that specify which version of Python
2024 # is in use. See skip_python_tests_prompt.
2026 proc skip_python_tests {} {
2028 return [skip_python_tests_prompt "$gdb_prompt $"]
2031 # Return a 1 if we should skip shared library tests.
2033 proc skip_shlib_tests {} {
2034 # Run the shared library tests on native systems.
2039 # An abbreviated list of remote targets where we should be able to
2040 # run shared library tests.
2041 if {([istarget *-*-linux*]
2042 || [istarget *-*-*bsd*]
2043 || [istarget *-*-solaris2*]
2044 || [istarget arm*-*-symbianelf*]
2045 || [istarget *-*-mingw*]
2046 || [istarget *-*-cygwin*]
2047 || [istarget *-*-pe*])} {
2054 # Return 1 if we should skip tui related tests.
2056 proc skip_tui_tests {} {
2059 gdb_test_multiple "help layout" "verify tui support" {
2060 -re "Undefined command: \"layout\".*$gdb_prompt $" {
2063 -re "$gdb_prompt $" {
2070 # Test files shall make sure all the test result lines in gdb.sum are
2071 # unique in a test run, so that comparing the gdb.sum files of two
2072 # test runs gives correct results. Test files that exercise
2073 # variations of the same tests more than once, shall prefix the
2074 # different test invocations with different identifying strings in
2075 # order to make them unique.
2077 # About test prefixes:
2079 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2080 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2081 # underlined substring in
2083 # PASS: gdb.base/mytest.exp: some test
2084 # ^^^^^^^^^^^^^^^^^^^^
2088 # The easiest way to adjust the test prefix is to append a test
2089 # variation prefix to the $pf_prefix, using the with_test_prefix
2092 # proc do_tests {} {
2093 # gdb_test ... ... "test foo"
2094 # gdb_test ... ... "test bar"
2096 # with_test_prefix "subvariation a" {
2097 # gdb_test ... ... "test x"
2100 # with_test_prefix "subvariation b" {
2101 # gdb_test ... ... "test x"
2105 # with_test_prefix "variation1" {
2106 # ...do setup for variation 1...
2110 # with_test_prefix "variation2" {
2111 # ...do setup for variation 2...
2117 # PASS: gdb.base/mytest.exp: variation1: test foo
2118 # PASS: gdb.base/mytest.exp: variation1: test bar
2119 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2120 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2121 # PASS: gdb.base/mytest.exp: variation2: test foo
2122 # PASS: gdb.base/mytest.exp: variation2: test bar
2123 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2124 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2126 # If for some reason more flexibility is necessary, one can also
2127 # manipulate the pf_prefix global directly, treating it as a string.
2131 # set saved_pf_prefix
2132 # append pf_prefix "${foo}: bar"
2133 # ... actual tests ...
2134 # set pf_prefix $saved_pf_prefix
2137 # Run BODY in the context of the caller, with the current test prefix
2138 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2139 # Returns the result of BODY.
2141 proc with_test_prefix { prefix body } {
2144 set saved $pf_prefix
2145 append pf_prefix " " $prefix ":"
2146 set code [catch {uplevel 1 $body} result]
2147 set pf_prefix $saved
2150 global errorInfo errorCode
2151 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2153 return -code $code $result
2157 # Wrapper for foreach that calls with_test_prefix on each iteration,
2158 # including the iterator's name and current value in the prefix.
2160 proc foreach_with_prefix {var list body} {
2162 foreach myvar $list {
2163 with_test_prefix "$var=$myvar" {
2164 set code [catch {uplevel 1 $body} result]
2168 global errorInfo errorCode
2169 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2170 } elseif {$code == 3} {
2172 } elseif {$code == 2} {
2173 return -code $code $result
2178 # Like TCL's native proc, but defines a procedure that wraps its body
2179 # within 'with_test_prefix "$proc_name" { ... }'.
2180 proc proc_with_prefix {name arguments body} {
2181 # Define the advertised proc.
2182 proc $name $arguments [list with_test_prefix $name $body]
2186 # Run BODY in the context of the caller. After BODY is run, the variables
2187 # listed in VARS will be reset to the values they had before BODY was run.
2189 # This is useful for providing a scope in which it is safe to temporarily
2190 # modify global variables, e.g.
2192 # global INTERNAL_GDBFLAGS
2195 # set foo GDBHISTSIZE
2197 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2198 # append INTERNAL_GDBFLAGS " -nx"
2199 # unset -nocomplain env(GDBHISTSIZE)
2204 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2205 # modified inside BODY, this proc guarantees that the modifications will be
2206 # undone after BODY finishes executing.
2208 proc save_vars { vars body } {
2209 array set saved_scalars { }
2210 array set saved_arrays { }
2214 # First evaluate VAR in the context of the caller in case the variable
2215 # name may be a not-yet-interpolated string like env($foo)
2216 set var [uplevel 1 list $var]
2218 if [uplevel 1 [list info exists $var]] {
2219 if [uplevel 1 [list array exists $var]] {
2220 set saved_arrays($var) [uplevel 1 [list array get $var]]
2222 set saved_scalars($var) [uplevel 1 [list set $var]]
2225 lappend unset_vars $var
2229 set code [catch {uplevel 1 $body} result]
2231 foreach {var value} [array get saved_scalars] {
2232 uplevel 1 [list set $var $value]
2235 foreach {var value} [array get saved_arrays] {
2236 uplevel 1 [list unset $var]
2237 uplevel 1 [list array set $var $value]
2240 foreach var $unset_vars {
2241 uplevel 1 [list unset -nocomplain $var]
2245 global errorInfo errorCode
2246 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2248 return -code $code $result
2252 # Run tests in BODY with the current working directory (CWD) set to
2253 # DIR. When BODY is finished, restore the original CWD. Return the
2256 # This procedure doesn't check if DIR is a valid directory, so you
2257 # have to make sure of that.
2259 proc with_cwd { dir body } {
2261 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2264 set code [catch {uplevel 1 $body} result]
2266 verbose -log "Switching back to $saved_dir."
2270 global errorInfo errorCode
2271 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2273 return -code $code $result
2277 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2278 # PROMPT. When BODY is finished, restore GDB prompt and variable
2280 # Returns the result of BODY.
2284 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2285 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2286 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2287 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2288 # a) It's more intuitive for callers to pass the plain text form.
2289 # b) We need two forms of the prompt:
2290 # - a regexp to use in output matching,
2291 # - a value to pass to the "set prompt" command.
2292 # c) It's easier to convert the plain text form to its regexp form.
2294 # 2) Don't add a trailing space, we do that here.
2296 proc with_gdb_prompt { prompt body } {
2299 # Convert "(foo)" to "\(foo\)".
2300 # We don't use string_to_regexp because while it works today it's not
2301 # clear it will work tomorrow: the value we need must work as both a
2302 # regexp *and* as the argument to the "set prompt" command, at least until
2303 # we start recording both forms separately instead of just $gdb_prompt.
2304 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2306 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2308 set saved $gdb_prompt
2310 verbose -log "Setting gdb prompt to \"$prompt \"."
2311 set gdb_prompt $prompt
2312 gdb_test_no_output "set prompt $prompt " ""
2314 set code [catch {uplevel 1 $body} result]
2316 verbose -log "Restoring gdb prompt to \"$saved \"."
2317 set gdb_prompt $saved
2318 gdb_test_no_output "set prompt $saved " ""
2321 global errorInfo errorCode
2322 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2324 return -code $code $result
2328 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2329 # BODY is finished, restore target-charset.
2331 proc with_target_charset { target_charset body } {
2335 gdb_test_multiple "show target-charset" "" {
2336 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2337 set saved $expect_out(1,string)
2339 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2340 set saved $expect_out(1,string)
2342 -re ".*$gdb_prompt " {
2343 fail "get target-charset"
2347 gdb_test_no_output "set target-charset $target_charset" ""
2349 set code [catch {uplevel 1 $body} result]
2351 gdb_test_no_output "set target-charset $saved" ""
2354 global errorInfo errorCode
2355 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2357 return -code $code $result
2361 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2362 # mi_gdb_test etc. default to using it.
2364 proc switch_gdb_spawn_id {spawn_id} {
2366 global board board_info
2368 set gdb_spawn_id $spawn_id
2369 set board [host_info name]
2370 set board_info($board,fileid) $spawn_id
2373 # Clear the default spawn id.
2375 proc clear_gdb_spawn_id {} {
2377 global board board_info
2379 unset -nocomplain gdb_spawn_id
2380 set board [host_info name]
2381 unset -nocomplain board_info($board,fileid)
2384 # Run BODY with SPAWN_ID as current spawn id.
2386 proc with_spawn_id { spawn_id body } {
2389 if [info exists gdb_spawn_id] {
2390 set saved_spawn_id $gdb_spawn_id
2393 switch_gdb_spawn_id $spawn_id
2395 set code [catch {uplevel 1 $body} result]
2397 if [info exists saved_spawn_id] {
2398 switch_gdb_spawn_id $saved_spawn_id
2404 global errorInfo errorCode
2405 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2407 return -code $code $result
2411 # Select the largest timeout from all the timeouts:
2412 # - the local "timeout" variable of the scope two levels above,
2413 # - the global "timeout" variable,
2414 # - the board variable "gdb,timeout".
2416 proc get_largest_timeout {} {
2417 upvar #0 timeout gtimeout
2418 upvar 2 timeout timeout
2421 if [info exists timeout] {
2424 if { [info exists gtimeout] && $gtimeout > $tmt } {
2427 if { [target_info exists gdb,timeout]
2428 && [target_info gdb,timeout] > $tmt } {
2429 set tmt [target_info gdb,timeout]
2439 # Run tests in BODY with timeout increased by factor of FACTOR. When
2440 # BODY is finished, restore timeout.
2442 proc with_timeout_factor { factor body } {
2445 set savedtimeout $timeout
2447 set timeout [expr [get_largest_timeout] * $factor]
2448 set code [catch {uplevel 1 $body} result]
2450 set timeout $savedtimeout
2452 global errorInfo errorCode
2453 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2455 return -code $code $result
2459 # Run BODY with timeout factor FACTOR if check-read1 is used.
2461 proc with_read1_timeout_factor { factor body } {
2462 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
2463 # Use timeout factor
2465 # Reset timeout factor
2468 return [uplevel [list with_timeout_factor $factor $body]]
2471 # Return 1 if _Complex types are supported, otherwise, return 0.
2473 gdb_caching_proc support_complex_tests {
2475 if { [gdb_skip_float_test] } {
2476 # If floating point is not supported, _Complex is not
2481 # Compile a test program containing _Complex types.
2483 return [gdb_can_simple_compile complex {
2487 _Complex long double cld;
2493 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2496 proc supports_get_siginfo_type {} {
2497 if { [istarget "*-*-linux*"] } {
2504 # Return 1 if the target supports hardware single stepping.
2506 proc can_hardware_single_step {} {
2508 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2509 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2510 || [istarget "nios2-*-*"] } {
2517 # Return 1 if target hardware or OS supports single stepping to signal
2518 # handler, otherwise, return 0.
2520 proc can_single_step_to_signal_handler {} {
2521 # Targets don't have hardware single step. On these targets, when
2522 # a signal is delivered during software single step, gdb is unable
2523 # to determine the next instruction addresses, because start of signal
2524 # handler is one of them.
2525 return [can_hardware_single_step]
2528 # Return 1 if target supports process record, otherwise return 0.
2530 proc supports_process_record {} {
2532 if [target_info exists gdb,use_precord] {
2533 return [target_info gdb,use_precord]
2536 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2537 || [istarget "i\[34567\]86-*-linux*"]
2538 || [istarget "aarch64*-*-linux*"]
2539 || [istarget "powerpc*-*-linux*"]
2540 || [istarget "s390*-*-linux*"] } {
2547 # Return 1 if target supports reverse debugging, otherwise return 0.
2549 proc supports_reverse {} {
2551 if [target_info exists gdb,can_reverse] {
2552 return [target_info gdb,can_reverse]
2555 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2556 || [istarget "i\[34567\]86-*-linux*"]
2557 || [istarget "aarch64*-*-linux*"]
2558 || [istarget "powerpc*-*-linux*"]
2559 || [istarget "s390*-*-linux*"] } {
2566 # Return 1 if readline library is used.
2568 proc readline_is_used { } {
2571 gdb_test_multiple "show editing" "" {
2572 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2575 -re ".*$gdb_prompt $" {
2581 # Return 1 if target is ELF.
2582 gdb_caching_proc is_elf_target {
2583 set me "is_elf_target"
2585 set src { int foo () {return 0;} }
2586 if {![gdb_simple_compile elf_target $src]} {
2590 set fp_obj [open $obj "r"]
2591 fconfigure $fp_obj -translation binary
2592 set data [read $fp_obj]
2597 set ELFMAG "\u007FELF"
2599 if {[string compare -length 4 $data $ELFMAG] != 0} {
2600 verbose "$me: returning 0" 2
2604 verbose "$me: returning 1" 2
2608 # Return 1 if the memory at address zero is readable.
2610 gdb_caching_proc is_address_zero_readable {
2614 gdb_test_multiple "x 0" "" {
2615 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2618 -re ".*$gdb_prompt $" {
2626 # Produce source file NAME and write SOURCES into it.
2628 proc gdb_produce_source { name sources } {
2630 set f [open $name "w"]
2636 # Return 1 if target is ILP32.
2637 # This cannot be decided simply from looking at the target string,
2638 # as it might depend on externally passed compiler options like -m64.
2639 gdb_caching_proc is_ilp32_target {
2640 return [gdb_can_simple_compile is_ilp32_target {
2641 int dummy[sizeof (int) == 4
2642 && sizeof (void *) == 4
2643 && sizeof (long) == 4 ? 1 : -1];
2647 # Return 1 if target is LP64.
2648 # This cannot be decided simply from looking at the target string,
2649 # as it might depend on externally passed compiler options like -m64.
2650 gdb_caching_proc is_lp64_target {
2651 return [gdb_can_simple_compile is_lp64_target {
2652 int dummy[sizeof (int) == 4
2653 && sizeof (void *) == 8
2654 && sizeof (long) == 8 ? 1 : -1];
2658 # Return 1 if target has 64 bit addresses.
2659 # This cannot be decided simply from looking at the target string,
2660 # as it might depend on externally passed compiler options like -m64.
2661 gdb_caching_proc is_64_target {
2662 return [gdb_can_simple_compile is_64_target {
2663 int function(void) { return 3; }
2664 int dummy[sizeof (&function) == 8 ? 1 : -1];
2668 # Return 1 if target has x86_64 registers - either amd64 or x32.
2669 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2670 # just from the target string.
2671 gdb_caching_proc is_amd64_regs_target {
2672 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2676 return [gdb_can_simple_compile is_amd64_regs_target {
2686 # Return 1 if this target is an x86 or x86-64 with -m32.
2687 proc is_x86_like_target {} {
2688 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2691 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2694 # Return 1 if this target is an arm or aarch32 on aarch64.
2696 gdb_caching_proc is_aarch32_target {
2697 if { [istarget "arm*-*-*"] } {
2701 if { ![istarget "aarch64*-*-*"] } {
2708 lappend list "\tmov $reg, $reg"
2711 return [gdb_can_simple_compile aarch32 [join $list \n]]
2714 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2716 proc is_aarch64_target {} {
2717 if { ![istarget "aarch64*-*-*"] } {
2721 return [expr ![is_aarch32_target]]
2724 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2725 proc support_displaced_stepping {} {
2727 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2728 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2729 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2730 || [istarget "aarch64*-*-linux*"] } {
2737 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2738 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2740 gdb_caching_proc skip_altivec_tests {
2741 global srcdir subdir gdb_prompt inferior_exited_re
2743 set me "skip_altivec_tests"
2745 # Some simulators are known to not support VMX instructions.
2746 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2747 verbose "$me: target known to not support VMX, returning 1" 2
2751 # Make sure we have a compiler that understands altivec.
2752 if [get_compiler_info] {
2753 warning "Could not get compiler info"
2756 if [test_compiler_info gcc*] {
2757 set compile_flags "additional_flags=-maltivec"
2758 } elseif [test_compiler_info xlc*] {
2759 set compile_flags "additional_flags=-qaltivec"
2761 verbose "Could not compile with altivec support, returning 1" 2
2765 # Compile a test program containing VMX instructions.
2769 asm volatile ("vor v0,v0,v0");
2771 asm volatile ("vor 0,0,0");
2776 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2780 # Compilation succeeded so now run it via gdb.
2784 gdb_reinitialize_dir $srcdir/$subdir
2788 -re ".*Illegal instruction.*${gdb_prompt} $" {
2789 verbose -log "\n$me altivec hardware not detected"
2790 set skip_vmx_tests 1
2792 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2793 verbose -log "\n$me: altivec hardware detected"
2794 set skip_vmx_tests 0
2797 warning "\n$me: default case taken"
2798 set skip_vmx_tests 1
2802 remote_file build delete $obj
2804 verbose "$me: returning $skip_vmx_tests" 2
2805 return $skip_vmx_tests
2808 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2809 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2811 gdb_caching_proc skip_vsx_tests {
2812 global srcdir subdir gdb_prompt inferior_exited_re
2814 set me "skip_vsx_tests"
2816 # Some simulators are known to not support Altivec instructions, so
2817 # they won't support VSX instructions as well.
2818 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2819 verbose "$me: target known to not support VSX, returning 1" 2
2823 # Make sure we have a compiler that understands altivec.
2824 if [get_compiler_info] {
2825 warning "Could not get compiler info"
2828 if [test_compiler_info gcc*] {
2829 set compile_flags "additional_flags=-mvsx"
2830 } elseif [test_compiler_info xlc*] {
2831 set compile_flags "additional_flags=-qasm=gcc"
2833 verbose "Could not compile with vsx support, returning 1" 2
2837 # Compile a test program containing VSX instructions.
2840 double a[2] = { 1.0, 2.0 };
2842 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2844 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2849 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2853 # No error message, compilation succeeded so now run it via gdb.
2857 gdb_reinitialize_dir $srcdir/$subdir
2861 -re ".*Illegal instruction.*${gdb_prompt} $" {
2862 verbose -log "\n$me VSX hardware not detected"
2863 set skip_vsx_tests 1
2865 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2866 verbose -log "\n$me: VSX hardware detected"
2867 set skip_vsx_tests 0
2870 warning "\n$me: default case taken"
2871 set skip_vsx_tests 1
2875 remote_file build delete $obj
2877 verbose "$me: returning $skip_vsx_tests" 2
2878 return $skip_vsx_tests
2881 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2882 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2884 gdb_caching_proc skip_tsx_tests {
2885 global srcdir subdir gdb_prompt inferior_exited_re
2887 set me "skip_tsx_tests"
2889 # Compile a test program.
2892 asm volatile ("xbegin .L0");
2893 asm volatile ("xend");
2894 asm volatile (".L0: nop");
2898 if {![gdb_simple_compile $me $src executable]} {
2902 # No error message, compilation succeeded so now run it via gdb.
2906 gdb_reinitialize_dir $srcdir/$subdir
2910 -re ".*Illegal instruction.*${gdb_prompt} $" {
2911 verbose -log "$me: TSX hardware not detected."
2912 set skip_tsx_tests 1
2914 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2915 verbose -log "$me: TSX hardware detected."
2916 set skip_tsx_tests 0
2919 warning "\n$me: default case taken."
2920 set skip_tsx_tests 1
2924 remote_file build delete $obj
2926 verbose "$me: returning $skip_tsx_tests" 2
2927 return $skip_tsx_tests
2930 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2931 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2933 gdb_caching_proc skip_btrace_tests {
2934 global srcdir subdir gdb_prompt inferior_exited_re
2936 set me "skip_btrace_tests"
2937 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2938 verbose "$me: target does not support btrace, returning 1" 2
2942 # Compile a test program.
2943 set src { int main() { return 0; } }
2944 if {![gdb_simple_compile $me $src executable]} {
2948 # No error message, compilation succeeded so now run it via gdb.
2952 gdb_reinitialize_dir $srcdir/$subdir
2957 # In case of an unexpected output, we return 2 as a fail value.
2958 set skip_btrace_tests 2
2959 gdb_test_multiple "record btrace" "check btrace support" {
2960 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2961 set skip_btrace_tests 1
2963 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2964 set skip_btrace_tests 1
2966 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2967 set skip_btrace_tests 1
2969 -re "^record btrace\r\n$gdb_prompt $" {
2970 set skip_btrace_tests 0
2974 remote_file build delete $obj
2976 verbose "$me: returning $skip_btrace_tests" 2
2977 return $skip_btrace_tests
2980 # Run a test on the target to see if it supports btrace pt hardware.
2981 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2982 # from the GCC testsuite.
2984 gdb_caching_proc skip_btrace_pt_tests {
2985 global srcdir subdir gdb_prompt inferior_exited_re
2987 set me "skip_btrace_tests"
2988 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2989 verbose "$me: target does not support btrace, returning 1" 2
2993 # Compile a test program.
2994 set src { int main() { return 0; } }
2995 if {![gdb_simple_compile $me $src executable]} {
2999 # No error message, compilation succeeded so now run it via gdb.
3003 gdb_reinitialize_dir $srcdir/$subdir
3008 # In case of an unexpected output, we return 2 as a fail value.
3009 set skip_btrace_tests 2
3010 gdb_test_multiple "record btrace pt" "check btrace pt support" {
3011 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3012 set skip_btrace_tests 1
3014 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3015 set skip_btrace_tests 1
3017 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3018 set skip_btrace_tests 1
3020 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
3021 set skip_btrace_tests 1
3023 -re "^record btrace pt\r\n$gdb_prompt $" {
3024 set skip_btrace_tests 0
3028 remote_file build delete $obj
3030 verbose "$me: returning $skip_btrace_tests" 2
3031 return $skip_btrace_tests
3034 # Run a test on the target to see if it supports Aarch64 SVE hardware.
3035 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
3037 gdb_caching_proc skip_aarch64_sve_tests {
3038 global srcdir subdir gdb_prompt inferior_exited_re
3040 set me "skip_aarch64_sve_tests"
3042 if { ![is_aarch64_target]} {
3046 set compile_flags "{additional_flags=-march=armv8-a+sve}"
3048 # Compile a test program containing SVE instructions.
3051 asm volatile ("ptrue p0.b");
3055 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3059 # Compilation succeeded so now run it via gdb.
3063 -re ".*Illegal instruction.*${gdb_prompt} $" {
3064 verbose -log "\n$me sve hardware not detected"
3065 set skip_sve_tests 1
3067 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3068 verbose -log "\n$me: sve hardware detected"
3069 set skip_sve_tests 0
3072 warning "\n$me: default case taken"
3073 set skip_sve_tests 1
3077 remote_file build delete $obj
3079 verbose "$me: returning $skip_sve_tests" 2
3080 return $skip_sve_tests
3084 # A helper that compiles a test case to see if __int128 is supported.
3085 proc gdb_int128_helper {lang} {
3086 return [gdb_can_simple_compile "i128-for-$lang" {
3088 int main() { return 0; }
3092 # Return true if the C compiler understands the __int128 type.
3093 gdb_caching_proc has_int128_c {
3094 return [gdb_int128_helper c]
3097 # Return true if the C++ compiler understands the __int128 type.
3098 gdb_caching_proc has_int128_cxx {
3099 return [gdb_int128_helper c++]
3102 # Return true if the IFUNC feature is unsupported.
3103 gdb_caching_proc skip_ifunc_tests {
3104 if [gdb_can_simple_compile ifunc {
3106 typedef void F (void);
3107 F* g (void) { return &f_; }
3108 void f () __attribute__ ((ifunc ("g")));
3116 # Return whether we should skip tests for showing inlined functions in
3117 # backtraces. Requires get_compiler_info and get_debug_format.
3119 proc skip_inline_frame_tests {} {
3120 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3121 if { ! [test_debug_format "DWARF 2"] } {
3125 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
3126 if { ([test_compiler_info "gcc-2-*"]
3127 || [test_compiler_info "gcc-3-*"]
3128 || [test_compiler_info "gcc-4-0-*"]) } {
3135 # Return whether we should skip tests for showing variables from
3136 # inlined functions. Requires get_compiler_info and get_debug_format.
3138 proc skip_inline_var_tests {} {
3139 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3140 if { ! [test_debug_format "DWARF 2"] } {
3147 # Return a 1 if we should skip tests that require hardware breakpoints
3149 proc skip_hw_breakpoint_tests {} {
3150 # Skip tests if requested by the board (note that no_hardware_watchpoints
3151 # disables both watchpoints and breakpoints)
3152 if { [target_info exists gdb,no_hardware_watchpoints]} {
3156 # These targets support hardware breakpoints natively
3157 if { [istarget "i?86-*-*"]
3158 || [istarget "x86_64-*-*"]
3159 || [istarget "ia64-*-*"]
3160 || [istarget "arm*-*-*"]
3161 || [istarget "aarch64*-*-*"]
3162 || [istarget "s390*-*-*"] } {
3169 # Return a 1 if we should skip tests that require hardware watchpoints
3171 proc skip_hw_watchpoint_tests {} {
3172 # Skip tests if requested by the board
3173 if { [target_info exists gdb,no_hardware_watchpoints]} {
3177 # These targets support hardware watchpoints natively
3178 if { [istarget "i?86-*-*"]
3179 || [istarget "x86_64-*-*"]
3180 || [istarget "ia64-*-*"]
3181 || [istarget "arm*-*-*"]
3182 || [istarget "aarch64*-*-*"]
3183 || [istarget "powerpc*-*-linux*"]
3184 || [istarget "s390*-*-*"] } {
3191 # Return a 1 if we should skip tests that require *multiple* hardware
3192 # watchpoints to be active at the same time
3194 proc skip_hw_watchpoint_multi_tests {} {
3195 if { [skip_hw_watchpoint_tests] } {
3199 # These targets support just a single hardware watchpoint
3200 if { [istarget "arm*-*-*"]
3201 || [istarget "powerpc*-*-linux*"] } {
3208 # Return a 1 if we should skip tests that require read/access watchpoints
3210 proc skip_hw_watchpoint_access_tests {} {
3211 if { [skip_hw_watchpoint_tests] } {
3215 # These targets support just write watchpoints
3216 if { [istarget "s390*-*-*"] } {
3223 # Return 1 if we should skip tests that require the runtime unwinder
3224 # hook. This must be invoked while gdb is running, after shared
3225 # libraries have been loaded. This is needed because otherwise a
3226 # shared libgcc won't be visible.
3228 proc skip_unwinder_tests {} {
3232 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3233 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3235 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3238 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3242 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3243 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3246 -re "\r\n$gdb_prompt $" {
3253 # Return 1 if we should skip tests that require the libstdc++ stap
3254 # probes. This must be invoked while gdb is running, after shared
3255 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
3257 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
3259 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3260 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
3263 -re "\r\n$prompt_regexp" {
3266 set skip [expr !$supported]
3270 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
3272 proc skip_libstdcxx_probe_tests {} {
3274 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
3277 # Return 1 if we should skip tests of the "compile" feature.
3278 # This must be invoked after the inferior has been started.
3280 proc skip_compile_feature_tests {} {
3284 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3285 "Could not load libcc1.*\r\n$gdb_prompt $" {
3288 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3291 -re "\r\n$gdb_prompt $" {
3297 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3298 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3299 # is a regexp that will match the output of "maint print target-stack" if
3300 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3301 # matching the expected prompt after the command output.
3303 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3304 set test "probe for target ${target_name}"
3305 gdb_test_multiple "maint print target-stack" $test {
3306 -re "${target_stack_regexp}${prompt_regexp}" {
3310 -re "$prompt_regexp" {
3317 # Helper for gdb_is_target_remote where the expected prompt is variable.
3319 proc gdb_is_target_remote_prompt { prompt_regexp } {
3320 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3323 # Check whether we're testing with the remote or extended-remote
3326 proc gdb_is_target_remote { } {
3329 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3332 # Check whether we're testing with the native target.
3334 proc gdb_is_target_native { } {
3337 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3340 # Return the effective value of use_gdb_stub.
3342 # If the use_gdb_stub global has been set (it is set when the gdb process is
3343 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3344 # property from the board file.
3346 # This is the preferred way of checking use_gdb_stub, since it allows to check
3347 # the value before the gdb has been spawned and it will return the correct value
3348 # even when it was overriden by the test.
3350 proc use_gdb_stub {} {
3353 if [info exists use_gdb_stub] {
3354 return $use_gdb_stub
3357 return [target_info exists use_gdb_stub]
3360 # Return 1 if the current remote target is an instance of our GDBserver, 0
3361 # otherwise. Return -1 if there was an error and we can't tell.
3363 gdb_caching_proc target_is_gdbserver {
3367 set test "probing for GDBserver"
3369 gdb_test_multiple "monitor help" $test {
3370 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3373 -re "$gdb_prompt $" {
3378 if { $is_gdbserver == -1 } {
3379 verbose -log "Unable to tell whether we are using GDBserver or not."
3382 return $is_gdbserver
3385 # N.B. compiler_info is intended to be local to this file.
3386 # Call test_compiler_info with no arguments to fetch its value.
3387 # Yes, this is counterintuitive when there's get_compiler_info,
3388 # but that's the current API.
3389 if [info exists compiler_info] {
3395 # Figure out what compiler I am using.
3396 # The result is cached so only the first invocation runs the compiler.
3398 # ARG can be empty or "C++". If empty, "C" is assumed.
3400 # There are several ways to do this, with various problems.
3402 # [ gdb_compile -E $ifile -o $binfile.ci ]
3403 # source $binfile.ci
3405 # Single Unix Spec v3 says that "-E -o ..." together are not
3406 # specified. And in fact, the native compiler on hp-ux 11 (among
3407 # others) does not work with "-E -o ...". Most targets used to do
3408 # this, and it mostly worked, because it works with gcc.
3410 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3411 # source $binfile.ci
3413 # This avoids the problem with -E and -o together. This almost works
3414 # if the build machine is the same as the host machine, which is
3415 # usually true of the targets which are not gcc. But this code does
3416 # not figure which compiler to call, and it always ends up using the C
3417 # compiler. Not good for setting hp_aCC_compiler. Target
3418 # hppa*-*-hpux* used to do this.
3420 # [ gdb_compile -E $ifile > $binfile.ci ]
3421 # source $binfile.ci
3423 # dejagnu target_compile says that it supports output redirection,
3424 # but the code is completely different from the normal path and I
3425 # don't want to sweep the mines from that path. So I didn't even try
3428 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3431 # I actually do this for all targets now. gdb_compile runs the right
3432 # compiler, and TCL captures the output, and I eval the output.
3434 # Unfortunately, expect logs the output of the command as it goes by,
3435 # and dejagnu helpfully prints a second copy of it right afterwards.
3436 # So I turn off expect logging for a moment.
3438 # [ gdb_compile $ifile $ciexe_file executable $args ]
3439 # [ remote_exec $ciexe_file ]
3440 # [ source $ci_file.out ]
3442 # I could give up on -E and just do this.
3443 # I didn't get desperate enough to try this.
3445 # -- chastain 2004-01-06
3447 proc get_compiler_info {{arg ""}} {
3448 # For compiler.c and compiler.cc
3451 # I am going to play with the log to keep noise out.
3455 # These come from compiler.c or compiler.cc
3456 global compiler_info
3458 # Legacy global data symbols.
3461 if [info exists compiler_info] {
3466 # Choose which file to preprocess.
3467 set ifile "${srcdir}/lib/compiler.c"
3468 if { $arg == "c++" } {
3469 set ifile "${srcdir}/lib/compiler.cc"
3472 # Run $ifile through the right preprocessor.
3473 # Toggle gdb.log to keep the compiler output out of the log.
3474 set saved_log [log_file -info]
3476 if [is_remote host] {
3477 # We have to use -E and -o together, despite the comments
3478 # above, because of how DejaGnu handles remote host testing.
3479 set ppout "$outdir/compiler.i"
3480 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3481 set file [open $ppout r]
3482 set cppout [read $file]
3485 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3487 eval log_file $saved_log
3491 foreach cppline [ split "$cppout" "\n" ] {
3492 if { [ regexp "^#" "$cppline" ] } {
3494 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3496 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3498 verbose "get_compiler_info: $cppline" 2
3502 verbose -log "get_compiler_info: $cppline"
3507 # Set to unknown if for some reason compiler_info didn't get defined.
3508 if ![info exists compiler_info] {
3509 verbose -log "get_compiler_info: compiler_info not provided"
3510 set compiler_info "unknown"
3512 # Also set to unknown compiler if any diagnostics happened.
3514 verbose -log "get_compiler_info: got unexpected diagnostics"
3515 set compiler_info "unknown"
3518 # Set the legacy symbols.
3520 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3522 # Log what happened.
3523 verbose -log "get_compiler_info: $compiler_info"
3525 # Most compilers will evaluate comparisons and other boolean
3526 # operations to 0 or 1.
3527 uplevel \#0 { set true 1 }
3528 uplevel \#0 { set false 0 }
3533 # Return the compiler_info string if no arg is provided.
3534 # Otherwise the argument is a glob-style expression to match against
3537 proc test_compiler_info { {compiler ""} } {
3538 global compiler_info
3541 # If no arg, return the compiler_info string.
3542 if [string match "" $compiler] {
3543 return $compiler_info
3546 return [string match $compiler $compiler_info]
3549 proc current_target_name { } {
3551 if [info exists target_info(target,name)] {
3552 set answer $target_info(target,name)
3559 set gdb_wrapper_initialized 0
3560 set gdb_wrapper_target ""
3562 proc gdb_wrapper_init { args } {
3563 global gdb_wrapper_initialized
3564 global gdb_wrapper_file
3565 global gdb_wrapper_flags
3566 global gdb_wrapper_target
3568 if { $gdb_wrapper_initialized == 1 } { return; }
3570 if {[target_info exists needs_status_wrapper] && \
3571 [target_info needs_status_wrapper] != "0"} {
3572 set result [build_wrapper "testglue.o"]
3573 if { $result != "" } {
3574 set gdb_wrapper_file [lindex $result 0]
3575 set gdb_wrapper_flags [lindex $result 1]
3577 warning "Status wrapper failed to build."
3580 set gdb_wrapper_initialized 1
3581 set gdb_wrapper_target [current_target_name]
3584 # Determine options that we always want to pass to the compiler.
3585 gdb_caching_proc universal_compile_options {
3586 set me "universal_compile_options"
3589 set src [standard_temp_file ccopts[pid].c]
3590 set obj [standard_temp_file ccopts[pid].o]
3592 gdb_produce_source $src {
3593 int foo(void) { return 0; }
3596 # Try an option for disabling colored diagnostics. Some compilers
3597 # yield colored diagnostics by default (when run from a tty) unless
3598 # such an option is specified.
3599 set opt "additional_flags=-fdiagnostics-color=never"
3600 set lines [target_compile $src $obj object [list "quiet" $opt]]
3601 if [string match "" $lines] then {
3602 # Seems to have worked; use the option.
3603 lappend options $opt
3608 verbose "$me: returning $options" 2
3612 # Compile the code in $code to a file based on $name, using the flags
3613 # $compile_flag as well as debug, nowarning and quiet.
3614 # Return 1 if code can be compiled
3615 # Leave the file name of the resulting object in the upvar object.
3617 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3620 switch -regexp -- $type {
3634 set src [standard_temp_file $name-[pid].c]
3635 set obj [standard_temp_file $name-[pid].$postfix]
3636 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3638 gdb_produce_source $src $code
3640 verbose "$name: compiling testfile $src" 2
3641 set lines [gdb_compile $src $obj $type $compile_flags]
3645 if ![string match "" $lines] then {
3646 verbose "$name: compilation failed, returning 0" 2
3652 # Compile the code in $code to a file based on $name, using the flags
3653 # $compile_flag as well as debug, nowarning and quiet.
3654 # Return 1 if code can be compiled
3655 # Delete all created files and objects.
3657 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3658 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3659 file delete $temp_obj
3663 # Some targets need to always link a special object in. Save its path here.
3664 global gdb_saved_set_unbuffered_mode_obj
3665 set gdb_saved_set_unbuffered_mode_obj ""
3667 # Compile source files specified by SOURCE into a binary of type TYPE at path
3668 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3669 # parameter and most options are passed directly to it.
3671 # The type can be one of the following:
3673 # - object: Compile into an object file.
3674 # - executable: Compile and link into an executable.
3675 # - preprocess: Preprocess the source files.
3676 # - assembly: Generate assembly listing.
3678 # The following options are understood and processed by gdb_compile:
3680 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3681 # quirks to be able to use shared libraries.
3682 # - shlib_load: Link with appropriate libraries to allow the test to
3683 # dynamically load libraries at runtime. For example, on Linux, this adds
3684 # -ldl so that the test can use dlopen.
3685 # - nowarnings: Inhibit all compiler warnings.
3686 # - pie: Force creation of PIE executables.
3687 # - nopie: Prevent creation of PIE executables.
3689 # And here are some of the not too obscure options understood by DejaGnu that
3690 # influence the compilation:
3692 # - additional_flags=flag: Add FLAG to the compiler flags.
3693 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3694 # argument can be a file, in which case it's added to the sources, or a
3696 # - ldflags=flag: Add FLAG to the linker flags.
3697 # - incdir=path: Add PATH to the searched include directories.
3698 # - libdir=path: Add PATH to the linker searched directories.
3699 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3700 # - debug: Build with debug information.
3701 # - optimize: Build with optimization.
3703 proc gdb_compile {source dest type options} {
3704 global GDB_TESTCASE_OPTIONS
3705 global gdb_wrapper_file
3706 global gdb_wrapper_flags
3707 global gdb_wrapper_initialized
3710 global gdb_saved_set_unbuffered_mode_obj
3712 set outdir [file dirname $dest]
3714 # Add platform-specific options if a shared library was specified using
3715 # "shlib=librarypath" in OPTIONS.
3717 if {[lsearch -exact $options rust] != -1} {
3718 # -fdiagnostics-color is not a rustcc option.
3720 set new_options [universal_compile_options]
3724 set getting_compiler_info 0
3725 foreach opt $options {
3726 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3727 && $type == "executable"} {
3728 if [test_compiler_info "xlc-*"] {
3729 # IBM xlc compiler doesn't accept shared library named other
3730 # than .so: use "-Wl," to bypass this
3731 lappend source "-Wl,$shlib_name"
3732 } elseif { ([istarget "*-*-mingw*"]
3733 || [istarget *-*-cygwin*]
3734 || [istarget *-*-pe*])} {
3735 lappend source "${shlib_name}.a"
3737 lappend source $shlib_name
3739 if { $shlib_found == 0 } {
3741 if { ([istarget "*-*-mingw*"]
3742 || [istarget *-*-cygwin*]) } {
3743 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3745 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3746 # Undo debian's change in the default.
3747 # Put it at the front to not override any user-provided
3748 # value, and to make sure it appears in front of all the
3750 lappend new_options "early_flags=-Wl,--no-as-needed"
3753 } elseif { $opt == "shlib_load" && $type == "executable" } {
3755 } elseif { $opt == "getting_compiler_info" } {
3756 # If this is set, calling test_compiler_info will cause recursion.
3757 set getting_compiler_info 1
3759 lappend new_options $opt
3763 # Ensure stack protector is disabled for GCC, as this causes problems with
3764 # DWARF line numbering.
3765 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3766 # This option defaults to on for Debian/Ubuntu.
3767 if { $getting_compiler_info == 0
3768 && [test_compiler_info {gcc-*-*}]
3769 && !([test_compiler_info {gcc-[0-3]-*}]
3770 || [test_compiler_info {gcc-4-0-*}])
3771 && [lsearch -exact $options rust] == -1} {
3772 # Put it at the front to not override any user-provided value.
3773 lappend new_options "early_flags=-fno-stack-protector"
3776 # Because we link with libraries using their basename, we may need
3777 # (depending on the platform) to set a special rpath value, to allow
3778 # the executable to find the libraries it depends on.
3779 if { $shlib_load || $shlib_found } {
3780 if { ([istarget "*-*-mingw*"]
3781 || [istarget *-*-cygwin*]
3782 || [istarget *-*-pe*]) } {
3783 # Do not need anything.
3784 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3785 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3786 } elseif { [istarget arm*-*-symbianelf*] } {
3787 if { $shlib_load } {
3788 lappend new_options "libs=-ldl"
3791 if { $shlib_load } {
3792 lappend new_options "libs=-ldl"
3794 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3797 set options $new_options
3799 if [info exists GDB_TESTCASE_OPTIONS] {
3800 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3802 verbose "options are $options"
3803 verbose "source is $source $dest $type $options"
3805 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3807 if {[target_info exists needs_status_wrapper] && \
3808 [target_info needs_status_wrapper] != "0" && \
3809 [info exists gdb_wrapper_file]} {
3810 lappend options "libs=${gdb_wrapper_file}"
3811 lappend options "ldflags=${gdb_wrapper_flags}"
3814 # Replace the "nowarnings" option with the appropriate additional_flags
3815 # to disable compiler warnings.
3816 set nowarnings [lsearch -exact $options nowarnings]
3817 if {$nowarnings != -1} {
3818 if [target_info exists gdb,nowarnings_flag] {
3819 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3821 set flag "additional_flags=-w"
3823 set options [lreplace $options $nowarnings $nowarnings $flag]
3826 # Replace the "pie" option with the appropriate compiler and linker flags
3827 # to enable PIE executables.
3828 set pie [lsearch -exact $options pie]
3830 if [target_info exists gdb,pie_flag] {
3831 set flag "additional_flags=[target_info gdb,pie_flag]"
3833 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3834 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3835 # a maximum size. On other architectures the two flags are
3836 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3837 # onwards default GCC to using fPIE. If you do require fpie, then
3838 # it can be set using the pie_flag.
3839 set flag "additional_flags=-fPIE"
3841 set options [lreplace $options $pie $pie $flag]
3843 if [target_info exists gdb,pie_ldflag] {
3844 set flag "ldflags=[target_info gdb,pie_ldflag]"
3846 set flag "ldflags=-pie"
3848 lappend options "$flag"
3851 # Replace the "nopie" option with the appropriate linker flag to disable
3852 # PIE executables. There are no compiler flags for this option.
3853 set nopie [lsearch -exact $options nopie]
3855 if [target_info exists gdb,nopie_flag] {
3856 set flag "ldflags=[target_info gdb,nopie_flag]"
3858 set flag "ldflags=-no-pie"
3860 set options [lreplace $options $nopie $nopie $flag]
3863 if { $type == "executable" } {
3864 if { ([istarget "*-*-mingw*"]
3865 || [istarget "*-*-*djgpp"]
3866 || [istarget "*-*-cygwin*"])} {
3867 # Force output to unbuffered mode, by linking in an object file
3868 # with a global contructor that calls setvbuf.
3870 # Compile the special object seperatelly for two reasons:
3871 # 1) Insulate it from $options.
3872 # 2) Avoid compiling it for every gdb_compile invocation,
3873 # which is time consuming, especially if we're remote
3876 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3877 verbose "compiling gdb_saved_set_unbuffered_obj"
3878 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3879 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3881 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3882 if { $result != "" } {
3885 if {[is_remote host]} {
3886 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3888 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3890 # Link a copy of the output object, because the
3891 # original may be automatically deleted.
3892 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3894 verbose "gdb_saved_set_unbuffered_obj already compiled"
3897 # Rely on the internal knowledge that the global ctors are ran in
3898 # reverse link order. In that case, we can use ldflags to
3899 # avoid copying the object file to the host multiple
3901 # This object can only be added if standard libraries are
3902 # used. Thus, we need to disable it if -nostdlib option is used
3903 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3904 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3909 set result [target_compile $source $dest $type $options]
3911 # Prune uninteresting compiler (and linker) output.
3912 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3914 regsub "\[\r\n\]*$" "$result" "" result
3915 regsub "^\[\r\n\]*" "$result" "" result
3917 if { $type == "executable" && $result == "" \
3918 && ($nopie != -1 || $pie != -1) } {
3919 set is_pie [exec_is_pie "$dest"]
3920 if { $nopie != -1 && $is_pie == 1 } {
3921 set result "nopie failed to prevent PIE executable"
3922 } elseif { $pie != -1 && $is_pie == 0 } {
3923 set result "pie failed to generate PIE executable"
3927 if {[lsearch $options quiet] < 0} {
3928 # We shall update this on a per language basis, to avoid
3929 # changing the entire testsuite in one go.
3930 if {[lsearch $options f77] >= 0} {
3931 gdb_compile_test $source $result
3932 } elseif { $result != "" } {
3933 clone_output "gdb compile failed, $result"
3940 # This is just like gdb_compile, above, except that it tries compiling
3941 # against several different thread libraries, to see which one this
3943 proc gdb_compile_pthreads {source dest type options} {
3945 set why_msg "unrecognized error"
3946 foreach lib {-lpthreads -lpthread -lthread ""} {
3947 # This kind of wipes out whatever libs the caller may have
3948 # set. Or maybe theirs will override ours. How infelicitous.
3949 set options_with_lib [concat $options [list libs=$lib quiet]]
3950 set ccout [gdb_compile $source $dest $type $options_with_lib]
3951 switch -regexp -- $ccout {
3952 ".*no posix threads support.*" {
3953 set why_msg "missing threads include file"
3956 ".*cannot open -lpthread.*" {
3957 set why_msg "missing runtime threads library"
3959 ".*Can't find library for -lpthread.*" {
3960 set why_msg "missing runtime threads library"
3963 pass "successfully compiled posix threads test case"
3969 if {!$built_binfile} {
3970 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3975 # Build a shared library from SOURCES.
3977 proc gdb_compile_shlib {sources dest options} {
3978 set obj_options $options
3981 if { [lsearch -exact $options "c++"] >= 0 } {
3982 set info_options "c++"
3984 if [get_compiler_info ${info_options}] {
3988 switch -glob [test_compiler_info] {
3990 lappend obj_options "additional_flags=-qpic"
3993 if { !([istarget "*-*-cygwin*"]
3994 || [istarget "*-*-mingw*"]) } {
3995 lappend obj_options "additional_flags=-fpic"
3999 if { !([istarget "powerpc*-*-aix*"]
4000 || [istarget "rs6000*-*-aix*"]
4001 || [istarget "*-*-cygwin*"]
4002 || [istarget "*-*-mingw*"]
4003 || [istarget "*-*-pe*"]) } {
4004 lappend obj_options "additional_flags=-fpic"
4008 lappend obj_options "additional_flags=-fpic"
4011 # don't know what the compiler is...
4015 set outdir [file dirname $dest]
4017 foreach source $sources {
4018 set sourcebase [file tail $source]
4019 if {[file extension $source] == ".o"} {
4020 # Already a .o file.
4021 lappend objects $source
4022 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
4023 $obj_options] != ""} {
4026 lappend objects ${outdir}/${sourcebase}.o
4030 set link_options $options
4031 if [test_compiler_info "xlc-*"] {
4032 lappend link_options "additional_flags=-qmkshrobj"
4034 lappend link_options "additional_flags=-shared"
4036 if { ([istarget "*-*-mingw*"]
4037 || [istarget *-*-cygwin*]
4038 || [istarget *-*-pe*]) } {
4039 if { [is_remote host] } {
4040 set name [file tail ${dest}]
4044 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
4046 # Set the soname of the library. This causes the linker on ELF
4047 # systems to create the DT_NEEDED entry in the executable referring
4048 # to the soname of the library, and not its absolute path. This
4049 # (using the absolute path) would be problem when testing on a
4052 # In conjunction with setting the soname, we add the special
4053 # rpath=$ORIGIN value when building the executable, so that it's
4054 # able to find the library in its own directory.
4055 set destbase [file tail $dest]
4056 lappend link_options "additional_flags=-Wl,-soname,$destbase"
4059 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
4062 if { [is_remote host]
4063 && ([istarget "*-*-mingw*"]
4064 || [istarget *-*-cygwin*]
4065 || [istarget *-*-pe*]) } {
4066 set dest_tail_name [file tail ${dest}]
4067 remote_upload host $dest_tail_name.a ${dest}.a
4068 remote_file host delete $dest_tail_name.a
4074 # This is just like gdb_compile_shlib, above, except that it tries compiling
4075 # against several different thread libraries, to see which one this
4077 proc gdb_compile_shlib_pthreads {sources dest options} {
4079 set why_msg "unrecognized error"
4080 foreach lib {-lpthreads -lpthread -lthread ""} {
4081 # This kind of wipes out whatever libs the caller may have
4082 # set. Or maybe theirs will override ours. How infelicitous.
4083 set options_with_lib [concat $options [list libs=$lib quiet]]
4084 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
4085 switch -regexp -- $ccout {
4086 ".*no posix threads support.*" {
4087 set why_msg "missing threads include file"
4090 ".*cannot open -lpthread.*" {
4091 set why_msg "missing runtime threads library"
4093 ".*Can't find library for -lpthread.*" {
4094 set why_msg "missing runtime threads library"
4097 pass "successfully compiled posix threads test case"
4103 if {!$built_binfile} {
4104 unsupported "couldn't compile $sources: ${why_msg}"
4109 # This is just like gdb_compile_pthreads, above, except that we always add the
4110 # objc library for compiling Objective-C programs
4111 proc gdb_compile_objc {source dest type options} {
4113 set why_msg "unrecognized error"
4114 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
4115 # This kind of wipes out whatever libs the caller may have
4116 # set. Or maybe theirs will override ours. How infelicitous.
4117 if { $lib == "solaris" } {
4118 set lib "-lpthread -lposix4"
4120 if { $lib != "-lobjc" } {
4121 set lib "-lobjc $lib"
4123 set options_with_lib [concat $options [list libs=$lib quiet]]
4124 set ccout [gdb_compile $source $dest $type $options_with_lib]
4125 switch -regexp -- $ccout {
4126 ".*no posix threads support.*" {
4127 set why_msg "missing threads include file"
4130 ".*cannot open -lpthread.*" {
4131 set why_msg "missing runtime threads library"
4133 ".*Can't find library for -lpthread.*" {
4134 set why_msg "missing runtime threads library"
4137 pass "successfully compiled objc with posix threads test case"
4143 if {!$built_binfile} {
4144 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4149 # Send a command to GDB.
4150 # For options for TYPE see gdb_stdin_log_write
4152 proc send_gdb { string {type standard}} {
4153 global suppress_flag
4154 if { $suppress_flag } {
4157 gdb_stdin_log_write $string $type
4158 return [remote_send host "$string"]
4161 # Send STRING to the inferior's terminal.
4163 proc send_inferior { string } {
4164 global inferior_spawn_id
4166 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
4176 proc gdb_expect { args } {
4177 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4178 set atimeout [lindex $args 0]
4179 set expcode [list [lindex $args 1]]
4184 # A timeout argument takes precedence, otherwise of all the timeouts
4185 # select the largest.
4186 if [info exists atimeout] {
4189 set tmt [get_largest_timeout]
4192 global suppress_flag
4193 global remote_suppress_flag
4194 if [info exists remote_suppress_flag] {
4195 set old_val $remote_suppress_flag
4197 if [info exists suppress_flag] {
4198 if { $suppress_flag } {
4199 set remote_suppress_flag 1
4203 {uplevel remote_expect host $tmt $expcode} string]
4204 if [info exists old_val] {
4205 set remote_suppress_flag $old_val
4207 if [info exists remote_suppress_flag] {
4208 unset remote_suppress_flag
4213 global errorInfo errorCode
4215 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4217 return -code $code $string
4221 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4223 # Check for long sequence of output by parts.
4224 # TEST: is the test message to be printed with the test success/fail.
4225 # SENTINEL: Is the terminal pattern indicating that output has finished.
4226 # LIST: is the sequence of outputs to match.
4227 # If the sentinel is recognized early, it is considered an error.
4230 # 1 if the test failed,
4231 # 0 if the test passes,
4232 # -1 if there was an internal error.
4234 proc gdb_expect_list {test sentinel list} {
4236 global suppress_flag
4239 if { $suppress_flag } {
4241 unresolved "${test}"
4243 while { ${index} < [llength ${list}] } {
4244 set pattern [lindex ${list} ${index}]
4245 set index [expr ${index} + 1]
4246 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4247 if { ${index} == [llength ${list}] } {
4250 -re "${pattern}${sentinel}" {
4251 # pass "${test}, pattern ${index} + sentinel"
4254 fail "${test} (pattern ${index} + sentinel)"
4257 -re ".*A problem internal to GDB has been detected" {
4258 fail "${test} (GDB internal error)"
4260 gdb_internal_error_resync
4263 fail "${test} (pattern ${index} + sentinel) (timeout)"
4268 # unresolved "${test}, pattern ${index} + sentinel"
4274 # pass "${test}, pattern ${index}"
4277 fail "${test} (pattern ${index})"
4280 -re ".*A problem internal to GDB has been detected" {
4281 fail "${test} (GDB internal error)"
4283 gdb_internal_error_resync
4286 fail "${test} (pattern ${index}) (timeout)"
4291 # unresolved "${test}, pattern ${index}"
4305 proc gdb_suppress_entire_file { reason } {
4306 global suppress_flag
4309 set suppress_flag -1
4313 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4314 # gdb_expect to fail immediately (until the next call to
4315 # gdb_stop_suppressing_tests).
4317 proc gdb_suppress_tests { args } {
4318 global suppress_flag
4320 return; # fnf - disable pending review of results where
4321 # testsuite ran better without this
4324 if { $suppress_flag == 1 } {
4325 if { [llength $args] > 0 } {
4326 warning "[lindex $args 0]\n"
4328 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4334 # Clear suppress_flag.
4336 proc gdb_stop_suppressing_tests { } {
4337 global suppress_flag
4339 if [info exists suppress_flag] {
4340 if { $suppress_flag > 0 } {
4342 clone_output "Tests restarted.\n"
4349 proc gdb_clear_suppressed { } {
4350 global suppress_flag
4355 # Spawn the gdb process.
4357 # This doesn't expect any output or do any other initialization,
4358 # leaving those to the caller.
4360 # Overridable function -- you can override this function in your
4363 proc gdb_spawn { } {
4367 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4369 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4372 set saved_gdbflags $GDBFLAGS
4374 if {$GDBFLAGS != ""} {
4377 append GDBFLAGS $cmdline_flags
4381 set GDBFLAGS $saved_gdbflags
4386 # Start gdb running, wait for prompt, and disable the pagers.
4388 # Overridable function -- you can override this function in your
4391 proc gdb_start { } {
4396 catch default_gdb_exit
4399 # Return true if we can spawn a program on the target and attach to
4402 proc can_spawn_for_attach { } {
4403 # We use exp_pid to get the inferior's pid, assuming that gives
4404 # back the pid of the program. On remote boards, that would give
4405 # us instead the PID of e.g., the ssh client, etc.
4406 if [is_remote target] then {
4410 # The "attach" command doesn't make sense when the target is
4411 # stub-like, where GDB finds the program already started on
4412 # initial connection.
4413 if {[target_info exists use_gdb_stub]} {
4421 # Kill a progress previously started with spawn_wait_for_attach, and
4422 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4425 proc kill_wait_spawned_process { proc_spawn_id } {
4426 set pid [exp_pid -i $proc_spawn_id]
4428 verbose -log "killing ${pid}"
4429 remote_exec build "kill -9 ${pid}"
4431 verbose -log "closing ${proc_spawn_id}"
4432 catch "close -i $proc_spawn_id"
4433 verbose -log "waiting for ${proc_spawn_id}"
4435 # If somehow GDB ends up still attached to the process here, a
4436 # blocking wait hangs until gdb is killed (or until gdb / the
4437 # ptracer reaps the exit status too, but that won't happen because
4438 # something went wrong.) Passing -nowait makes expect tell Tcl to
4439 # wait for the PID in the background. That's fine because we
4440 # don't care about the exit status. */
4441 wait -nowait -i $proc_spawn_id
4444 # Returns the process id corresponding to the given spawn id.
4446 proc spawn_id_get_pid { spawn_id } {
4447 set testpid [exp_pid -i $spawn_id]
4449 if { [istarget "*-*-cygwin*"] } {
4450 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4451 # might be different due to the way fork/exec works.
4452 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4458 # Start a set of programs running and then wait for a bit, to be sure
4459 # that they can be attached to. Return a list of processes spawn IDs,
4460 # one element for each process spawned. It's a test error to call
4461 # this when [can_spawn_for_attach] is false.
4463 proc spawn_wait_for_attach { executable_list } {
4464 set spawn_id_list {}
4466 if ![can_spawn_for_attach] {
4467 # The caller should have checked can_spawn_for_attach itself
4468 # before getting here.
4469 error "can't spawn for attach with this target/board"
4472 foreach {executable} $executable_list {
4473 # Note we use Expect's spawn, not Tcl's exec, because with
4474 # spawn we control when to wait for/reap the process. That
4475 # allows killing the process by PID without being subject to
4477 lappend spawn_id_list [remote_spawn target $executable]
4482 return $spawn_id_list
4486 # gdb_load_cmd -- load a file into the debugger.
4487 # ARGS - additional args to load command.
4488 # return a -1 if anything goes wrong.
4490 proc gdb_load_cmd { args } {
4493 if [target_info exists gdb_load_timeout] {
4494 set loadtimeout [target_info gdb_load_timeout]
4496 set loadtimeout 1600
4498 send_gdb "load $args\n"
4499 verbose "Timeout is now $loadtimeout seconds" 2
4500 gdb_expect $loadtimeout {
4501 -re "Loading section\[^\r\]*\r\n" {
4504 -re "Start address\[\r\]*\r\n" {
4507 -re "Transfer rate\[\r\]*\r\n" {
4510 -re "Memory access error\[^\r\]*\r\n" {
4511 perror "Failed to load program"
4514 -re "$gdb_prompt $" {
4517 -re "(.*)\r\n$gdb_prompt " {
4518 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4522 perror "Timed out trying to load $args."
4529 # Invoke "gcore". CORE is the name of the core file to write. TEST
4530 # is the name of the test case. This will return 1 if the core file
4531 # was created, 0 otherwise. If this fails to make a core file because
4532 # this configuration of gdb does not support making core files, it
4533 # will call "unsupported", not "fail". However, if this fails to make
4534 # a core file for some other reason, then it will call "fail".
4536 proc gdb_gcore_cmd {core test} {
4540 gdb_test_multiple "gcore $core" $test {
4541 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4545 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4553 # Load core file CORE. TEST is the name of the test case.
4554 # This will record a pass/fail for loading the core file.
4556 # 1 - core file is successfully loaded
4557 # 0 - core file loaded but has a non fatal error
4558 # -1 - core file failed to load
4560 proc gdb_core_cmd { core test } {
4563 gdb_test_multiple "core $core" "$test" {
4564 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4567 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4568 fail "$test (bad file format)"
4571 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4572 fail "$test (file not found)"
4575 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4576 fail "$test (incomplete note section)"
4579 -re "Core was generated by .*\r\n$gdb_prompt $" {
4583 -re ".*$gdb_prompt $" {
4588 fail "$test (timeout)"
4592 fail "unsupported output from 'core' command"
4596 # Return the filename to download to the target and load on the target
4597 # for this shared library. Normally just LIBNAME, unless shared libraries
4598 # for this target have separate link and load images.
4600 proc shlib_target_file { libname } {
4604 # Return the filename GDB will load symbols from when debugging this
4605 # shared library. Normally just LIBNAME, unless shared libraries for
4606 # this target have separate link and load images.
4608 proc shlib_symbol_file { libname } {
4612 # Return the filename to download to the target and load for this
4613 # executable. Normally just BINFILE unless it is renamed to something
4614 # else for this target.
4616 proc exec_target_file { binfile } {
4620 # Return the filename GDB will load symbols from when debugging this
4621 # executable. Normally just BINFILE unless executables for this target
4622 # have separate files for symbols.
4624 proc exec_symbol_file { binfile } {
4628 # Rename the executable file. Normally this is just BINFILE1 being renamed
4629 # to BINFILE2, but some targets require multiple binary files.
4630 proc gdb_rename_execfile { binfile1 binfile2 } {
4631 file rename -force [exec_target_file ${binfile1}] \
4632 [exec_target_file ${binfile2}]
4633 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4634 file rename -force [exec_symbol_file ${binfile1}] \
4635 [exec_symbol_file ${binfile2}]
4639 # "Touch" the executable file to update the date. Normally this is just
4640 # BINFILE, but some targets require multiple files.
4641 proc gdb_touch_execfile { binfile } {
4642 set time [clock seconds]
4643 file mtime [exec_target_file ${binfile}] $time
4644 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4645 file mtime [exec_symbol_file ${binfile}] $time
4649 # Like remote_download but provides a gdb-specific behavior.
4651 # If the destination board is remote, the local file FROMFILE is transferred as
4652 # usual with remote_download to TOFILE on the remote board. The destination
4653 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4656 # If the destination board is local, the destination path TOFILE is passed
4657 # through standard_output_file, and FROMFILE is copied there.
4659 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4662 proc gdb_remote_download {dest fromfile {tofile {}}} {
4663 # If TOFILE is not given, default to the same filename as FROMFILE.
4664 if {[string length $tofile] == 0} {
4665 set tofile [file tail $fromfile]
4668 if {[is_remote $dest]} {
4669 # When the DEST is remote, we simply send the file to DEST.
4672 set destname [remote_download $dest $fromfile $tofile]
4673 lappend cleanfiles $destname
4677 # When the DEST is local, we copy the file to the test directory (where
4678 # the executable is).
4680 # Note that we pass TOFILE through standard_output_file, regardless of
4681 # whether it is absolute or relative, because we don't want the tests
4682 # to be able to write outside their standard output directory.
4684 set tofile [standard_output_file $tofile]
4686 file copy -force $fromfile $tofile
4692 # gdb_load_shlib LIB...
4694 # Copy the listed library to the target.
4696 proc gdb_load_shlib { file } {
4699 if ![info exists gdb_spawn_id] {
4700 perror "gdb_load_shlib: GDB is not running"
4703 set dest [gdb_remote_download target [shlib_target_file $file]]
4705 if {[is_remote target]} {
4706 # If the target is remote, we need to tell gdb where to find the
4709 # We could set this even when not testing remotely, but a user
4710 # generally won't set it unless necessary. In order to make the tests
4711 # more like the real-life scenarios, we don't set it for local testing.
4712 gdb_test "set solib-search-path [file dirname $file]" "" ""
4719 # gdb_load -- load a file into the debugger. Specifying no file
4720 # defaults to the executable currently being debugged.
4721 # The return value is 0 for success, -1 for failure.
4722 # Many files in config/*.exp override this procedure.
4724 proc gdb_load { arg } {
4726 return [gdb_file_cmd $arg]
4731 # gdb_reload -- load a file into the target. Called before "running",
4732 # either the first time or after already starting the program once,
4733 # for remote targets. Most files that override gdb_load should now
4734 # override this instead.
4736 proc gdb_reload { } {
4737 # For the benefit of existing configurations, default to gdb_load.
4738 # Specifying no file defaults to the executable currently being
4740 return [gdb_load ""]
4743 proc gdb_continue { function } {
4746 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4749 proc default_gdb_init { test_file_name } {
4750 global gdb_wrapper_initialized
4751 global gdb_wrapper_target
4752 global gdb_test_file_name
4758 gdb_clear_suppressed
4760 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4762 # Make sure that the wrapper is rebuilt
4763 # with the appropriate multilib option.
4764 if { $gdb_wrapper_target != [current_target_name] } {
4765 set gdb_wrapper_initialized 0
4768 # Unlike most tests, we have a small number of tests that generate
4769 # a very large amount of output. We therefore increase the expect
4770 # buffer size to be able to contain the entire test output. This
4771 # is especially needed by gdb.base/info-macros.exp.
4773 # Also set this value for the currently running GDB.
4774 match_max [match_max -d]
4776 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4777 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4780 if [target_info exists gdb_prompt] {
4781 set gdb_prompt [target_info gdb_prompt]
4783 set gdb_prompt "\\(gdb\\)"
4786 if [info exists use_gdb_stub] {
4791 # Return a path using GDB_PARALLEL.
4792 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4793 # GDB_PARALLEL must be defined, the caller must check.
4795 # The default value for GDB_PARALLEL is, canonically, ".".
4796 # The catch is that tests don't expect an additional "./" in file paths so
4797 # omit any directory for the default case.
4798 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4799 # its special handling.
4801 proc make_gdb_parallel_path { args } {
4802 global GDB_PARALLEL objdir
4803 set joiner [list "file" "join" $objdir]
4804 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4805 lappend joiner $GDB_PARALLEL
4807 set joiner [concat $joiner $args]
4808 return [eval $joiner]
4811 # Turn BASENAME into a full file name in the standard output
4812 # directory. It is ok if BASENAME is the empty string; in this case
4813 # the directory is returned.
4815 proc standard_output_file {basename} {
4816 global objdir subdir gdb_test_file_name
4818 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4820 # If running on MinGW, replace /c/foo with c:/foo
4821 if { [ishost *-*-mingw*] } {
4822 set dir [regsub {^/([a-z])/} $dir {\1:/}]
4824 return [file join $dir $basename]
4827 # Turn BASENAME into a full file name in the standard output directory. If
4828 # GDB has been launched more than once then append the count, starting with
4831 proc standard_output_file_with_gdb_instance {basename} {
4832 global gdb_instances
4833 set count [expr $gdb_instances - 1 ]
4836 return [standard_output_file $basename]
4838 return [standard_output_file ${basename}.${count}]
4841 # Return the name of a file in our standard temporary directory.
4843 proc standard_temp_file {basename} {
4844 # Since a particular runtest invocation is only executing a single test
4845 # file at any given time, we can use the runtest pid to build the
4846 # path of the temp directory.
4847 set dir [make_gdb_parallel_path temp [pid]]
4849 return [file join $dir $basename]
4852 # Set 'testfile', 'srcfile', and 'binfile'.
4854 # ARGS is a list of source file specifications.
4855 # Without any arguments, the .exp file's base name is used to
4856 # compute the source file name. The ".c" extension is added in this case.
4857 # If ARGS is not empty, each entry is a source file specification.
4858 # If the specification starts with a ".", it is treated as a suffix
4859 # to append to the .exp file's base name.
4860 # If the specification is the empty string, it is treated as if it
4862 # Otherwise it is a file name.
4863 # The first file in the list is used to set the 'srcfile' global.
4864 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4866 # Most tests should call this without arguments.
4868 # If a completely different binary file name is needed, then it
4869 # should be handled in the .exp file with a suitable comment.
4871 proc standard_testfile {args} {
4872 global gdb_test_file_name
4874 global gdb_test_file_last_vars
4877 global testfile binfile
4879 set testfile $gdb_test_file_name
4880 set binfile [standard_output_file ${testfile}]
4882 if {[llength $args] == 0} {
4886 # Unset our previous output variables.
4887 # This can help catch hidden bugs.
4888 if {[info exists gdb_test_file_last_vars]} {
4889 foreach varname $gdb_test_file_last_vars {
4891 catch {unset $varname}
4894 # 'executable' is often set by tests.
4895 set gdb_test_file_last_vars {executable}
4899 set varname srcfile$suffix
4902 # Handle an extension.
4905 } elseif {[string range $arg 0 0] == "."} {
4906 set arg $testfile$arg
4910 lappend gdb_test_file_last_vars $varname
4912 if {$suffix == ""} {
4920 # The default timeout used when testing GDB commands. We want to use
4921 # the same timeout as the default dejagnu timeout, unless the user has
4922 # already provided a specific value (probably through a site.exp file).
4923 global gdb_test_timeout
4924 if ![info exists gdb_test_timeout] {
4925 set gdb_test_timeout $timeout
4928 # A list of global variables that GDB testcases should not use.
4929 # We try to prevent their use by monitoring write accesses and raising
4930 # an error when that happens.
4931 set banned_variables { bug_id prms_id }
4933 # A list of procedures that GDB testcases should not use.
4934 # We try to prevent their use by monitoring invocations and raising
4935 # an error when that happens.
4936 set banned_procedures { strace }
4938 # gdb_init is called by runtest at start, but also by several
4939 # tests directly; gdb_finish is only called from within runtest after
4940 # each test source execution.
4941 # Placing several traces by repetitive calls to gdb_init leads
4942 # to problems, as only one trace is removed in gdb_finish.
4943 # To overcome this possible problem, we add a variable that records
4944 # if the banned variables and procedures are already traced.
4947 proc gdb_init { test_file_name } {
4948 # Reset the timeout value to the default. This way, any testcase
4949 # that changes the timeout value without resetting it cannot affect
4950 # the timeout used in subsequent testcases.
4951 global gdb_test_timeout
4953 set timeout $gdb_test_timeout
4955 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4956 && [target_info exists gdb_reverse_timeout] } {
4957 set timeout [target_info gdb_reverse_timeout]
4960 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4961 # debugging tool to help confirm that the test suite is
4962 # parallel-safe. You need "inotifywait" from the
4963 # inotify-tools package to use this.
4964 global GDB_INOTIFY inotify_pid
4965 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4966 global outdir tool inotify_log_file
4968 set exclusions {outputs temp gdb[.](log|sum) cache}
4969 set exclusion_re ([join $exclusions |])
4971 set inotify_log_file [standard_temp_file inotify.out]
4972 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4973 --exclude $exclusion_re \
4974 |& tee -a $outdir/$tool.log $inotify_log_file &]
4976 # Wait for the watches; hopefully this is long enough.
4979 # Clear the log so that we don't emit a warning the first time
4981 set fd [open $inotify_log_file w]
4985 # Block writes to all banned variables, and invocation of all
4986 # banned procedures...
4987 global banned_variables
4988 global banned_procedures
4989 global banned_traced
4990 if (!$banned_traced) {
4991 foreach banned_var $banned_variables {
4992 global "$banned_var"
4993 trace add variable "$banned_var" write error
4995 foreach banned_proc $banned_procedures {
4996 global "$banned_proc"
4997 trace add execution "$banned_proc" enter error
5002 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
5003 # messages as expected.
5008 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
5009 # the test results. Even if /dev/null doesn't exist on the particular
5010 # platform, the readline library will use the default setting just by
5011 # failing to open the file. OTOH, opening /dev/null successfully will
5012 # also result in the default settings being used since nothing will be
5013 # read from this file.
5014 setenv INPUTRC "/dev/null"
5016 # This disables style output, which would interfere with many
5020 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
5021 # during startup. See "man expect" for details about stty_init.
5023 set stty_init "rows 25 cols 80"
5025 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
5026 # grep. Clear GREP_OPTIONS to make the behavior predictable,
5027 # especially having color output turned on can cause tests to fail.
5028 setenv GREP_OPTIONS ""
5030 # Clear $gdbserver_reconnect_p.
5031 global gdbserver_reconnect_p
5032 set gdbserver_reconnect_p 1
5033 unset gdbserver_reconnect_p
5035 # Reset GDB number of instances
5036 global gdb_instances
5039 return [default_gdb_init $test_file_name]
5042 proc gdb_finish { } {
5043 global gdbserver_reconnect_p
5047 # Exit first, so that the files are no longer in use.
5050 if { [llength $cleanfiles] > 0 } {
5051 eval remote_file target delete $cleanfiles
5055 # Unblock write access to the banned variables. Dejagnu typically
5056 # resets some of them between testcases.
5057 global banned_variables
5058 global banned_procedures
5059 global banned_traced
5060 if ($banned_traced) {
5061 foreach banned_var $banned_variables {
5062 global "$banned_var"
5063 trace remove variable "$banned_var" write error
5065 foreach banned_proc $banned_procedures {
5066 global "$banned_proc"
5067 trace remove execution "$banned_proc" enter error
5074 set debug_format "unknown"
5076 # Run the gdb command "info source" and extract the debugging format
5077 # information from the output and save it in debug_format.
5079 proc get_debug_format { } {
5085 set debug_format "unknown"
5086 send_gdb "info source\n"
5088 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
5089 set debug_format $expect_out(1,string)
5090 verbose "debug format is $debug_format"
5093 -re "No current source file.\r\n$gdb_prompt $" {
5094 perror "get_debug_format used when no current source file"
5097 -re "$gdb_prompt $" {
5098 warning "couldn't check debug format (no valid response)."
5102 warning "couldn't check debug format (timeout)."
5108 # Return true if FORMAT matches the debug format the current test was
5109 # compiled with. FORMAT is a shell-style globbing pattern; it can use
5110 # `*', `[...]', and so on.
5112 # This function depends on variables set by `get_debug_format', above.
5114 proc test_debug_format {format} {
5117 return [expr [string match $format $debug_format] != 0]
5120 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
5121 # COFF, stabs, etc). If that format matches the format that the
5122 # current test was compiled with, then the next test is expected to
5123 # fail for any target. Returns 1 if the next test or set of tests is
5124 # expected to fail, 0 otherwise (or if it is unknown). Must have
5125 # previously called get_debug_format.
5126 proc setup_xfail_format { format } {
5127 set ret [test_debug_format $format]
5135 # gdb_get_line_number TEXT [FILE]
5137 # Search the source file FILE, and return the line number of the
5138 # first line containing TEXT. If no match is found, an error is thrown.
5140 # TEXT is a string literal, not a regular expression.
5142 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
5143 # specified, and does not start with "/", then it is assumed to be in
5144 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
5145 # by changing the callers and the interface at the same time.
5146 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
5147 # gdb.base/ena-dis-br.exp.
5149 # Use this function to keep your test scripts independent of the
5150 # exact line numbering of the source file. Don't write:
5152 # send_gdb "break 20"
5154 # This means that if anyone ever edits your test's source file,
5155 # your test could break. Instead, put a comment like this on the
5156 # source file line you want to break at:
5158 # /* breakpoint spot: frotz.exp: test name */
5160 # and then write, in your test script (which we assume is named
5163 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
5165 # (Yes, Tcl knows how to handle the nested quotes and brackets.
5168 # % puts "foo [lindex "bar baz" 1]"
5171 # Tcl is quite clever, for a little stringy language.)
5175 # The previous implementation of this procedure used the gdb search command.
5176 # This version is different:
5178 # . It works with MI, and it also works when gdb is not running.
5180 # . It operates on the build machine, not the host machine.
5182 # . For now, this implementation fakes a current directory of
5183 # $srcdir/$subdir to be compatible with the old implementation.
5184 # This will go away eventually and some callers will need to
5187 # . The TEXT argument is literal text and matches literally,
5188 # not a regular expression as it was before.
5190 # . State changes in gdb, such as changing the current file
5191 # and setting $_, no longer happen.
5193 # After a bit of time we can forget about the differences from the
5194 # old implementation.
5196 # --chastain 2004-08-05
5198 proc gdb_get_line_number { text { file "" } } {
5203 if { "$file" == "" } then {
5206 if { ! [regexp "^/" "$file"] } then {
5207 set file "$srcdir/$subdir/$file"
5210 if { [ catch { set fd [open "$file"] } message ] } then {
5215 for { set line 1 } { 1 } { incr line } {
5216 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5219 if { $nchar < 0 } then {
5222 if { [string first "$text" "$body"] >= 0 } then {
5228 if { [ catch { close "$fd" } message ] } then {
5233 error "undefined tag \"$text\""
5239 # Continue the program until it ends.
5241 # MSSG is the error message that gets printed. If not given, a
5243 # COMMAND is the command to invoke. If not given, "continue" is
5245 # ALLOW_EXTRA is a flag indicating whether the test should expect
5246 # extra output between the "Continuing." line and the program
5247 # exiting. By default it is zero; if nonzero, any extra output
5250 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5251 global inferior_exited_re use_gdb_stub
5254 set text "continue until exit"
5256 set text "continue until exit at $mssg"
5264 # By default, we don't rely on exit() behavior of remote stubs --
5265 # it's common for exit() to be implemented as a simple infinite
5266 # loop, or a forced crash/reset. For native targets, by default, we
5267 # assume process exit is reported as such. If a non-reliable target
5268 # is used, we set a breakpoint at exit, and continue to that.
5269 if { [target_info exists exit_is_reliable] } {
5270 set exit_is_reliable [target_info exit_is_reliable]
5272 set exit_is_reliable [expr ! $use_gdb_stub]
5275 if { ! $exit_is_reliable } {
5276 if {![gdb_breakpoint "exit"]} {
5279 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5282 # Continue until we exit. Should not stop again.
5283 # Don't bother to check the output of the program, that may be
5284 # extremely tough for some remote systems.
5286 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5291 proc rerun_to_main {} {
5292 global gdb_prompt use_gdb_stub
5297 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5298 {pass "rerun to main" ; return 0}
5299 -re "$gdb_prompt $"\
5300 {fail "rerun to main" ; return 0}
5301 timeout {fail "(timeout) rerun to main" ; return 0}
5306 -re "The program .* has been started already.*y or n. $" {
5307 send_gdb "y\n" answer
5310 -re "Starting program.*$gdb_prompt $"\
5311 {pass "rerun to main" ; return 0}
5312 -re "$gdb_prompt $"\
5313 {fail "rerun to main" ; return 0}
5314 timeout {fail "(timeout) rerun to main" ; return 0}
5319 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5321 proc exec_has_index_section { executable } {
5322 set readelf_program [gdb_find_readelf]
5323 set res [catch {exec $readelf_program -S $executable \
5324 | grep -E "\.gdb_index|\.debug_names" }]
5331 # Return list with major and minor version of readelf, or an empty list.
5332 gdb_caching_proc readelf_version {
5333 set readelf_program [gdb_find_readelf]
5334 set res [catch {exec $readelf_program --version} output]
5338 set lines [split $output \n]
5339 set line [lindex $lines 0]
5340 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
5341 $line dummy major minor]
5345 return [list $major $minor]
5348 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
5349 proc readelf_prints_pie { } {
5350 set version [readelf_version]
5351 if { [llength $version] == 0 } {
5354 set major [lindex $version 0]
5355 set minor [lindex $version 1]
5356 # It would be better to construct a PIE executable and test if the PIE
5357 # flag is printed by readelf, but we cannot reliably construct a PIE
5358 # executable if the multilib_flags dictate otherwise
5359 # (--target_board=unix/-no-pie/-fno-PIE).
5360 return [version_at_least $major $minor 2 26]
5363 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
5364 # and -1 if unknown.
5366 proc exec_is_pie { executable } {
5367 set res [readelf_prints_pie]
5371 set readelf_program [gdb_find_readelf]
5372 set res [catch {exec $readelf_program -d $executable} output]
5376 set res [regexp -line {\(FLAGS_1\).*Flags:.* PIE($| )} $output]
5383 # Return true if a test should be skipped due to lack of floating
5384 # point support or GDB can't fetch the contents from floating point
5387 gdb_caching_proc gdb_skip_float_test {
5388 if [target_info exists gdb,skip_float_tests] {
5392 # There is an ARM kernel ptrace bug that hardware VFP registers
5393 # are not updated after GDB ptrace set VFP registers. The bug
5394 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5395 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5396 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5397 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5398 # This kernel bug is detected by check how does GDB change the
5399 # program result by changing one VFP register.
5400 if { [istarget "arm*-*-linux*"] } {
5402 set compile_flags {debug nowarnings }
5404 # Set up, compile, and execute a test program having VFP
5406 set src [standard_temp_file arm_vfp[pid].c]
5407 set exe [standard_temp_file arm_vfp[pid].x]
5409 gdb_produce_source $src {
5414 asm ("vldr d0, [%0]" : : "r" (&d));
5415 asm ("vldr d1, [%0]" : : "r" (&d));
5416 asm (".global break_here\n"
5418 asm ("vcmp.f64 d0, d1\n"
5419 "vmrs APSR_nzcv, fpscr\n"
5420 "bne L_value_different\n"
5423 "L_value_different:\n"
5425 "L_end:\n" : "=r" (ret) :);
5427 /* Return $d0 != $d1. */
5432 verbose "compiling testfile $src" 2
5433 set lines [gdb_compile $src $exe executable $compile_flags]
5436 if ![string match "" $lines] then {
5437 verbose "testfile compilation failed, returning 1" 2
5441 # No error message, compilation succeeded so now run it via gdb.
5442 # Run the test up to 5 times to detect whether ptrace can
5443 # correctly update VFP registers or not.
5445 for {set i 0} {$i < 5} {incr i} {
5446 global gdb_prompt srcdir subdir
5450 gdb_reinitialize_dir $srcdir/$subdir
5454 gdb_test "break *break_here"
5455 gdb_continue_to_breakpoint "break_here"
5457 # Modify $d0 to a different value, so the exit code should
5459 gdb_test "set \$d0 = 5.0"
5461 set test "continue to exit"
5462 gdb_test_multiple "continue" "$test" {
5463 -re "exited with code 01.*$gdb_prompt $" {
5465 -re "exited normally.*$gdb_prompt $" {
5466 # However, the exit code is 0. That means something
5467 # wrong in setting VFP registers.
5475 remote_file build delete $exe
5477 return $skip_vfp_test
5482 # Print a message and return true if a test should be skipped
5483 # due to lack of stdio support.
5485 proc gdb_skip_stdio_test { msg } {
5486 if [target_info exists gdb,noinferiorio] {
5487 verbose "Skipping test '$msg': no inferior i/o."
5493 proc gdb_skip_bogus_test { msg } {
5497 # Return true if a test should be skipped due to lack of XML support
5499 # NOTE: This must be called while gdb is *not* running.
5501 gdb_caching_proc gdb_skip_xml_test {
5506 if { [info exists gdb_spawn_id] } {
5507 error "GDB must not be running in gdb_skip_xml_tests."
5510 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5514 gdb_test_multiple "set tdesc filename $xml_file" "" {
5515 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5518 -re ".*$gdb_prompt $" { }
5524 # Return true if argv[0] is available.
5526 gdb_caching_proc gdb_has_argv0 {
5529 # Compile and execute a test program to check whether argv[0] is available.
5530 gdb_simple_compile has_argv0 {
5531 int main (int argc, char **argv) {
5538 proc gdb_has_argv0_1 { exe } {
5539 global srcdir subdir
5540 global gdb_prompt hex
5544 gdb_reinitialize_dir $srcdir/$subdir
5547 # Set breakpoint on main.
5548 gdb_test_multiple "break main" "break main" {
5549 -re "Breakpoint.*${gdb_prompt} $" {
5551 -re "${gdb_prompt} $" {
5558 gdb_test_multiple "" "run to main" {
5559 -re "Breakpoint.*${gdb_prompt} $" {
5561 -re "${gdb_prompt} $" {
5566 set old_elements "200"
5567 set test "show print elements"
5568 gdb_test_multiple $test $test {
5569 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5570 set old_elements $expect_out(1,string)
5573 set old_repeats "200"
5574 set test "show print repeats"
5575 gdb_test_multiple $test $test {
5576 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5577 set old_repeats $expect_out(1,string)
5580 gdb_test_no_output "set print elements unlimited" ""
5581 gdb_test_no_output "set print repeats unlimited" ""
5584 # Check whether argc is 1.
5585 gdb_test_multiple "p argc" "p argc" {
5586 -re " = 1\r\n${gdb_prompt} $" {
5588 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5589 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5592 -re "${gdb_prompt} $" {
5596 -re "${gdb_prompt} $" {
5600 gdb_test_no_output "set print elements $old_elements" ""
5601 gdb_test_no_output "set print repeats $old_repeats" ""
5606 set result [gdb_has_argv0_1 $obj]
5612 && ([istarget *-*-linux*]
5613 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5614 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5615 || [istarget *-*-openbsd*]
5616 || [istarget *-*-darwin*]
5617 || [istarget *-*-solaris*]
5618 || [istarget *-*-aix*]
5619 || [istarget *-*-gnu*]
5620 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5621 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5622 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5623 || [istarget *-*-symbianelf*]
5624 || [istarget *-*-osf*]
5625 || [istarget *-*-dicos*]
5626 || [istarget *-*-nto*]
5627 || [istarget *-*-*vms*]
5628 || [istarget *-*-lynx*178]) } {
5629 fail "argv\[0\] should be available on this target"
5635 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5636 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5637 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5638 # the name of a debuginfo only file. This file will be stored in the same
5641 # Functions for separate debug info testing
5643 # starting with an executable:
5644 # foo --> original executable
5646 # at the end of the process we have:
5647 # foo.stripped --> foo w/o debug info
5648 # foo.debug --> foo's debug info
5649 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5651 # Fetch the build id from the file.
5652 # Returns "" if there is none.
5654 proc get_build_id { filename } {
5655 if { ([istarget "*-*-mingw*"]
5656 || [istarget *-*-cygwin*]) } {
5657 set objdump_program [gdb_find_objdump]
5658 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5659 verbose "result is $result"
5660 verbose "output is $output"
5666 set tmp [standard_output_file "${filename}-tmp"]
5667 set objcopy_program [gdb_find_objcopy]
5668 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5669 verbose "result is $result"
5670 verbose "output is $output"
5675 fconfigure $fi -translation binary
5676 # Skip the NOTE header.
5681 if ![string compare $data ""] then {
5684 # Convert it to hex.
5685 binary scan $data H* data
5690 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5691 # converted to the form: .build-id/ab/cdef1234...89.debug
5692 # Return "" if no build-id found.
5693 proc build_id_debug_filename_get { filename } {
5694 set data [get_build_id $filename]
5695 if { $data == "" } {
5698 regsub {^..} $data {\0/} data
5699 return ".build-id/${data}.debug"
5702 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5703 # list of optional flags. The only currently supported flag is no-main,
5704 # which removes the symbol entry for main from the separate debug file.
5706 # Function returns zero on success. Function will return non-zero failure code
5707 # on some targets not supporting separate debug info (such as i386-msdos).
5709 proc gdb_gnu_strip_debug { dest args } {
5711 # Use the first separate debug info file location searched by GDB so the
5712 # run cannot be broken by some stale file searched with higher precedence.
5713 set debug_file "${dest}.debug"
5715 set strip_to_file_program [transform strip]
5716 set objcopy_program [gdb_find_objcopy]
5718 set debug_link [file tail $debug_file]
5719 set stripped_file "${dest}.stripped"
5721 # Get rid of the debug info, and store result in stripped_file
5722 # something like gdb/testsuite/gdb.base/blah.stripped.
5723 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5724 verbose "result is $result"
5725 verbose "output is $output"
5730 # Workaround PR binutils/10802:
5731 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5732 set perm [file attributes ${dest} -permissions]
5733 file attributes ${stripped_file} -permissions $perm
5735 # Get rid of everything but the debug info, and store result in debug_file
5736 # This will be in the .debug subdirectory, see above.
5737 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5738 verbose "result is $result"
5739 verbose "output is $output"
5744 # If no-main is passed, strip the symbol for main from the separate
5745 # file. This is to simulate the behavior of elfutils's eu-strip, which
5746 # leaves the symtab in the original file only. There's no way to get
5747 # objcopy or strip to remove the symbol table without also removing the
5748 # debugging sections, so this is as close as we can get.
5749 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5750 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5751 verbose "result is $result"
5752 verbose "output is $output"
5756 file delete "${debug_file}"
5757 file rename "${debug_file}-tmp" "${debug_file}"
5760 # Link the two previous output files together, adding the .gnu_debuglink
5761 # section to the stripped_file, containing a pointer to the debug_file,
5762 # save the new file in dest.
5763 # This will be the regular executable filename, in the usual location.
5764 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5765 verbose "result is $result"
5766 verbose "output is $output"
5771 # Workaround PR binutils/10802:
5772 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5773 set perm [file attributes ${stripped_file} -permissions]
5774 file attributes ${dest} -permissions $perm
5779 # Test the output of GDB_COMMAND matches the pattern obtained
5780 # by concatenating all elements of EXPECTED_LINES. This makes
5781 # it possible to split otherwise very long string into pieces.
5782 # If third argument TESTNAME is not empty, it's used as the name of the
5783 # test to be printed on pass/fail.
5784 proc help_test_raw { gdb_command expected_lines {testname {}} } {
5785 set expected_output [join $expected_lines ""]
5786 if {$testname != {}} {
5787 gdb_test "${gdb_command}" "${expected_output}" $testname
5791 gdb_test "${gdb_command}" "${expected_output}"
5794 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
5795 set help_list_trailer {
5796 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5797 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
5798 "Command name abbreviations are allowed if unambiguous\."
5801 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5802 # are regular expressions that should match the beginning of output,
5803 # before the list of commands in that class.
5804 # LIST_OF_COMMANDS are regular expressions that should match the
5805 # list of commands in that class. If empty, the command list will be
5806 # matched automatically. The presence of standard epilogue will be tested
5808 # If last argument TESTNAME is not empty, it's used as the name of the
5809 # test to be printed on pass/fail.
5810 # Notice that the '[' and ']' characters don't need to be escaped for strings
5811 # wrapped in {} braces.
5812 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
5813 global help_list_trailer
5814 if {[llength $list_of_commands]>0} {
5815 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
5816 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
5817 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
5819 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
5822 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5824 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
5825 $l_stock_body $help_list_trailer]
5827 help_test_raw "help ${command_class}" $l_entire_body $testname
5830 # Like test_class_help but specialised to test "help user-defined".
5831 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
5832 test_class_help "user-defined" {
5833 "User-defined commands\.[\r\n]+"
5834 "The commands in this class are those defined by the user\.[\r\n]+"
5835 "Use the \"define\" command to define a command\.[\r\n]+"
5836 } $list_of_commands $testname
5840 # COMMAND_LIST should have either one element -- command to test, or
5841 # two elements -- abbreviated command to test, and full command the first
5842 # element is abbreviation of.
5843 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5844 # are regular expressions that should match the beginning of output,
5845 # before the list of subcommands. The presence of
5846 # subcommand list and standard epilogue will be tested automatically.
5847 proc test_prefix_command_help { command_list expected_initial_lines args } {
5848 global help_list_trailer
5849 set command [lindex $command_list 0]
5850 if {[llength $command_list]>1} {
5851 set full_command [lindex $command_list 1]
5853 set full_command $command
5855 # Use 'list' and not just {} because we want variables to
5856 # be expanded in this list.
5857 set l_stock_body [list\
5858 "List of $full_command subcommands\:.*\[\r\n\]+"\
5859 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
5860 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
5861 if {[llength $args]>0} {
5862 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5864 help_test_raw "help ${command}" $l_entire_body
5868 # Build executable named EXECUTABLE from specifications that allow
5869 # different options to be passed to different sub-compilations.
5870 # TESTNAME is the name of the test; this is passed to 'untested' if
5872 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5873 # contains the option "pthreads", then gdb_compile_pthreads is used.
5874 # ARGS is a flat list of source specifications, of the form:
5875 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5876 # Each SOURCE is compiled to an object file using its OPTIONS,
5877 # using gdb_compile.
5878 # Returns 0 on success, -1 on failure.
5879 proc build_executable_from_specs {testname executable options args} {
5883 set binfile [standard_output_file $executable]
5886 if { [lsearch -exact $options "c++"] >= 0 } {
5887 set info_options "c++"
5889 if [get_compiler_info ${info_options}] {
5893 set func gdb_compile
5894 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5895 if {$func_index != -1} {
5896 set func "${func}_[lindex $options $func_index]"
5899 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5900 # parameter. They also requires $sources while gdb_compile and
5901 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5902 if [string match gdb_compile_shlib* $func] {
5904 foreach {s local_options} $args {
5905 if { [regexp "^/" "$s"] } then {
5906 lappend sources_path "$s"
5908 lappend sources_path "$srcdir/$subdir/$s"
5911 set ret [$func $sources_path "${binfile}" $options]
5912 } elseif {[lsearch -exact $options rust] != -1} {
5914 foreach {s local_options} $args {
5915 if { [regexp "^/" "$s"] } then {
5916 lappend sources_path "$s"
5918 lappend sources_path "$srcdir/$subdir/$s"
5921 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5925 foreach {s local_options} $args {
5926 if { ! [regexp "^/" "$s"] } then {
5927 set s "$srcdir/$subdir/$s"
5929 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5933 lappend objects "${binfile}${i}.o"
5936 set ret [$func $objects "${binfile}" executable $options]
5946 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5947 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5948 # to pass to untested, if something is wrong. OPTIONS are passed
5949 # to gdb_compile directly.
5950 proc build_executable { testname executable {sources ""} {options {debug}} } {
5951 if {[llength $sources]==0} {
5952 set sources ${executable}.c
5955 set arglist [list $testname $executable $options]
5956 foreach source $sources {
5957 lappend arglist $source $options
5960 return [eval build_executable_from_specs $arglist]
5963 # Starts fresh GDB binary and loads an optional executable into GDB.
5964 # Usage: clean_restart [executable]
5965 # EXECUTABLE is the basename of the binary.
5967 proc clean_restart { args } {
5971 if { [llength $args] > 1 } {
5972 error "bad number of args: [llength $args]"
5977 gdb_reinitialize_dir $srcdir/$subdir
5979 if { [llength $args] >= 1 } {
5980 set executable [lindex $args 0]
5981 set binfile [standard_output_file ${executable}]
5986 # Prepares for testing by calling build_executable_full, then
5988 # TESTNAME is the name of the test.
5989 # Each element in ARGS is a list of the form
5990 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5991 # These are passed to build_executable_from_specs, which see.
5992 # The last EXECUTABLE is passed to clean_restart.
5993 # Returns 0 on success, non-zero on failure.
5994 proc prepare_for_testing_full {testname args} {
5995 foreach spec $args {
5996 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5999 set executable [lindex $spec 0]
6001 clean_restart $executable
6005 # Prepares for testing, by calling build_executable, and then clean_restart.
6006 # Please refer to build_executable for parameter description.
6007 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
6009 if {[build_executable $testname $executable $sources $options] == -1} {
6012 clean_restart $executable
6017 # Retrieve the value of EXP in the inferior, represented in format
6018 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
6019 # print fails. TEST is the test message to use. It can be omitted,
6020 # in which case a test message is built from EXP.
6022 proc get_valueof { fmt exp default {test ""} } {
6026 set test "get valueof \"${exp}\""
6030 gdb_test_multiple "print${fmt} ${exp}" "$test" {
6031 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
6032 set val $expect_out(1,string)
6036 fail "$test (timeout)"
6042 # Retrieve the value of EXP in the inferior, as a signed decimal value
6043 # (using "print /d"). DEFAULT is used as fallback if print fails.
6044 # TEST is the test message to use. It can be omitted, in which case
6045 # a test message is built from EXP.
6047 proc get_integer_valueof { exp default {test ""} } {
6051 set test "get integer valueof \"${exp}\""
6055 gdb_test_multiple "print /d ${exp}" "$test" {
6056 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
6057 set val $expect_out(1,string)
6061 fail "$test (timeout)"
6067 # Retrieve the value of EXP in the inferior, as an hexadecimal value
6068 # (using "print /x"). DEFAULT is used as fallback if print fails.
6069 # TEST is the test message to use. It can be omitted, in which case
6070 # a test message is built from EXP.
6072 proc get_hexadecimal_valueof { exp default {test ""} } {
6076 set test "get hexadecimal valueof \"${exp}\""
6080 gdb_test_multiple "print /x ${exp}" $test {
6081 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
6082 set val $expect_out(1,string)
6089 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
6090 # is used as fallback if print fails. TEST is the test message to use.
6091 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
6093 proc get_sizeof { type default {test ""} } {
6094 return [get_integer_valueof "sizeof (${type})" $default $test]
6097 proc get_target_charset { } {
6100 gdb_test_multiple "show target-charset" "" {
6101 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
6102 return $expect_out(1,string)
6104 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
6105 return $expect_out(1,string)
6109 # Pick a reasonable default.
6110 warning "Unable to read target-charset."
6114 # Get the address of VAR.
6116 proc get_var_address { var } {
6117 global gdb_prompt hex
6119 # Match output like:
6121 # $5 = (int (*)()) 0
6122 # $6 = (int (*)()) 0x24 <function_bar>
6124 gdb_test_multiple "print &${var}" "get address of ${var}" {
6125 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
6127 pass "get address of ${var}"
6128 if { $expect_out(1,string) == "0" } {
6131 return $expect_out(1,string)
6138 # Return the frame number for the currently selected frame
6139 proc get_current_frame_number {{test_name ""}} {
6142 if { $test_name == "" } {
6143 set test_name "get current frame number"
6146 gdb_test_multiple "frame" $test_name {
6147 -re "#(\[0-9\]+) .*$gdb_prompt $" {
6148 set frame_num $expect_out(1,string)
6154 # Get the current value for remotetimeout and return it.
6155 proc get_remotetimeout { } {
6159 gdb_test_multiple "show remotetimeout" "" {
6160 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
6161 return $expect_out(1,string)
6165 # Pick the default that gdb uses
6166 warning "Unable to read remotetimeout"
6170 # Set the remotetimeout to the specified timeout. Nothing is returned.
6171 proc set_remotetimeout { timeout } {
6174 gdb_test_multiple "set remotetimeout $timeout" "" {
6175 -re "$gdb_prompt $" {
6176 verbose "Set remotetimeout to $timeout\n"
6181 # Get the target's current endianness and return it.
6182 proc get_endianness { } {
6185 gdb_test_multiple "show endian" "determine endianness" {
6186 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
6188 return $expect_out(1,string)
6194 # ROOT and FULL are file names. Returns the relative path from ROOT
6195 # to FULL. Note that FULL must be in a subdirectory of ROOT.
6196 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
6199 proc relative_filename {root full} {
6200 set root_split [file split $root]
6201 set full_split [file split $full]
6203 set len [llength $root_split]
6205 if {[eval file join $root_split]
6206 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
6207 error "$full not a subdir of $root"
6210 return [eval file join [lrange $full_split $len end]]
6213 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
6214 if {[info exists GDB_PARALLEL]} {
6215 if {[is_remote host]} {
6219 [make_gdb_parallel_path outputs] \
6220 [make_gdb_parallel_path temp] \
6221 [make_gdb_parallel_path cache]
6225 proc core_find {binfile {deletefiles {}} {arg ""}} {
6226 global objdir subdir
6228 set destcore "$binfile.core"
6229 file delete $destcore
6231 # Create a core file named "$destcore" rather than just "core", to
6232 # avoid problems with sys admin types that like to regularly prune all
6233 # files named "core" from the system.
6235 # Arbitrarily try setting the core size limit to "unlimited" since
6236 # this does not hurt on systems where the command does not work and
6237 # allows us to generate a core on systems where it does.
6239 # Some systems append "core" to the name of the program; others append
6240 # the name of the program to "core"; still others (like Linux, as of
6241 # May 2003) create cores named "core.PID". In the latter case, we
6242 # could have many core files lying around, and it may be difficult to
6243 # tell which one is ours, so let's run the program in a subdirectory.
6245 set coredir [standard_output_file coredir.[getpid]]
6247 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6248 # remote_exec host "${binfile}"
6249 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6250 if [remote_file build exists $i] {
6251 remote_exec build "mv $i $destcore"
6255 # Check for "core.PID".
6256 if { $found == 0 } {
6257 set names [glob -nocomplain -directory $coredir core.*]
6258 if {[llength $names] == 1} {
6259 set corefile [file join $coredir [lindex $names 0]]
6260 remote_exec build "mv $corefile $destcore"
6264 if { $found == 0 } {
6265 # The braindamaged HPUX shell quits after the ulimit -c above
6266 # without executing ${binfile}. So we try again without the
6267 # ulimit here if we didn't find a core file above.
6268 # Oh, I should mention that any "braindamaged" non-Unix system has
6269 # the same problem. I like the cd bit too, it's really neat'n stuff.
6270 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6271 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6272 if [remote_file build exists $i] {
6273 remote_exec build "mv $i $destcore"
6279 # Try to clean up after ourselves.
6280 foreach deletefile $deletefiles {
6281 remote_file build delete [file join $coredir $deletefile]
6283 remote_exec build "rmdir $coredir"
6285 if { $found == 0 } {
6286 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6292 # gdb_target_symbol_prefix compiles a test program and then examines
6293 # the output from objdump to determine the prefix (such as underscore)
6294 # for linker symbol prefixes.
6296 gdb_caching_proc gdb_target_symbol_prefix {
6297 # Compile a simple test program...
6298 set src { int main() { return 0; } }
6299 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6305 set objdump_program [gdb_find_objdump]
6306 set result [catch "exec $objdump_program --syms $obj" output]
6309 && ![regexp -lineanchor \
6310 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6311 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6319 # Return 1 if target supports scheduler locking, otherwise return 0.
6321 gdb_caching_proc target_supports_scheduler_locking {
6324 set me "gdb_target_supports_scheduler_locking"
6326 set src { int main() { return 0; } }
6327 if {![gdb_simple_compile $me $src executable]} {
6336 set supports_schedule_locking -1
6337 set current_schedule_locking_mode ""
6339 set test "reading current scheduler-locking mode"
6340 gdb_test_multiple "show scheduler-locking" $test {
6341 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6342 set current_schedule_locking_mode $expect_out(1,string)
6344 -re "$gdb_prompt $" {
6345 set supports_schedule_locking 0
6348 set supports_schedule_locking 0
6352 if { $supports_schedule_locking == -1 } {
6353 set test "checking for scheduler-locking support"
6354 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6355 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6356 set supports_schedule_locking 0
6358 -re "$gdb_prompt $" {
6359 set supports_schedule_locking 1
6362 set supports_schedule_locking 0
6367 if { $supports_schedule_locking == -1 } {
6368 set supports_schedule_locking 0
6372 remote_file build delete $obj
6373 verbose "$me: returning $supports_schedule_locking" 2
6374 return $supports_schedule_locking
6377 # gdb_target_symbol returns the provided symbol with the correct prefix
6378 # prepended. (See gdb_target_symbol_prefix, above.)
6380 proc gdb_target_symbol { symbol } {
6381 set prefix [gdb_target_symbol_prefix]
6382 return "${prefix}${symbol}"
6385 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6386 # added to gdb_compile options to define the C-preprocessor macro
6387 # SYMBOL_PREFIX with a value that can be prepended to symbols
6388 # for targets which require a prefix, such as underscore.
6390 # This version (_asm) defines the prefix without double quotes
6391 # surrounding the prefix. It is used to define the macro
6392 # SYMBOL_PREFIX for assembly language files. Another version, below,
6393 # is used for symbols in inline assembler in C/C++ files.
6395 # The lack of quotes in this version (_asm) makes it possible to
6396 # define supporting macros in the .S file. (The version which
6397 # uses quotes for the prefix won't work for such files since it's
6398 # impossible to define a quote-stripping macro in C.)
6400 # It's possible to use this version (_asm) for C/C++ source files too,
6401 # but a string is usually required in such files; providing a version
6402 # (no _asm) which encloses the prefix with double quotes makes it
6403 # somewhat easier to define the supporting macros in the test case.
6405 proc gdb_target_symbol_prefix_flags_asm {} {
6406 set prefix [gdb_target_symbol_prefix]
6407 if {$prefix ne ""} {
6408 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6414 # gdb_target_symbol_prefix_flags returns the same string as
6415 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6416 # enclosed in double quotes if there is a prefix.
6418 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6419 # extended discussion.
6421 proc gdb_target_symbol_prefix_flags {} {
6422 set prefix [gdb_target_symbol_prefix]
6423 if {$prefix ne ""} {
6424 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6430 # A wrapper for 'remote_exec host' that passes or fails a test.
6431 # Returns 0 if all went well, nonzero on failure.
6432 # TEST is the name of the test, other arguments are as for remote_exec.
6434 proc run_on_host { test program args } {
6435 verbose -log "run_on_host: $program $args"
6436 # remote_exec doesn't work properly if the output is set but the
6437 # input is the empty string -- so replace an empty input with
6439 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6440 set args [lreplace $args 1 1 "/dev/null"]
6442 set result [eval remote_exec host [list $program] $args]
6443 verbose "result is $result"
6444 set status [lindex $result 0]
6445 set output [lindex $result 1]
6450 verbose -log "run_on_host failed: $output"
6456 # Return non-zero if "board_info debug_flags" mentions Fission.
6457 # http://gcc.gnu.org/wiki/DebugFission
6458 # Fission doesn't support everything yet.
6459 # This supports working around bug 15954.
6461 proc using_fission { } {
6462 set debug_flags [board_info [target_info name] debug_flags]
6463 return [regexp -- "-gsplit-dwarf" $debug_flags]
6466 # Search the caller's ARGS list and set variables according to the list of
6467 # valid options described by ARGSET.
6469 # The first member of each one- or two-element list in ARGSET defines the
6470 # name of a variable that will be added to the caller's scope.
6472 # If only one element is given to describe an option, it the value is
6473 # 0 if the option is not present in (the caller's) ARGS or 1 if
6476 # If two elements are given, the second element is the default value of
6477 # the variable. This is then overwritten if the option exists in ARGS.
6479 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6480 # any optional components.
6483 # proc myproc {foo args} {
6484 # parse_args {{bar} {baz "abc"} {qux}}
6487 # myproc ABC -bar -baz DEF peanut butter
6488 # will define the following variables in myproc:
6489 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6490 # args will be the list {peanut butter}
6492 proc parse_args { argset } {
6495 foreach argument $argset {
6496 if {[llength $argument] == 1} {
6497 # No default specified, so we assume that we should set
6498 # the value to 1 if the arg is present and 0 if it's not.
6499 # It is assumed that no value is given with the argument.
6500 set result [lsearch -exact $args "-$argument"]
6501 if {$result != -1} then {
6502 uplevel 1 [list set $argument 1]
6503 set args [lreplace $args $result $result]
6505 uplevel 1 [list set $argument 0]
6507 } elseif {[llength $argument] == 2} {
6508 # There are two items in the argument. The second is a
6509 # default value to use if the item is not present.
6510 # Otherwise, the variable is set to whatever is provided
6511 # after the item in the args.
6512 set arg [lindex $argument 0]
6513 set result [lsearch -exact $args "-[lindex $arg 0]"]
6514 if {$result != -1} then {
6515 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6516 set args [lreplace $args $result [expr $result+1]]
6518 uplevel 1 [list set $arg [lindex $argument 1]]
6521 error "Badly formatted argument \"$argument\" in argument set"
6525 # The remaining args should be checked to see that they match the
6526 # number of items expected to be passed into the procedure...
6529 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6530 # return that string.
6532 proc capture_command_output { command prefix } {
6536 set output_string ""
6537 gdb_test_multiple "$command" "capture_command_output for $command" {
6538 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6539 set output_string $expect_out(1,string)
6542 return $output_string
6545 # A convenience function that joins all the arguments together, with a
6546 # regexp that matches exactly one end of line in between each argument.
6547 # This function is ideal to write the expected output of a GDB command
6548 # that generates more than a couple of lines, as this allows us to write
6549 # each line as a separate string, which is easier to read by a human
6552 proc multi_line { args } {
6553 return [join $args "\r\n"]
6556 # Similar to the above, but while multi_line is meant to be used to
6557 # match GDB output, this one is meant to be used to build strings to
6558 # send as GDB input.
6560 proc multi_line_input { args } {
6561 return [join $args "\n"]
6564 # Return the version of the DejaGnu framework.
6566 # The return value is a list containing the major, minor and patch version
6567 # numbers. If the version does not contain a minor or patch number, they will
6568 # be set to 0. For example:
6574 proc dejagnu_version { } {
6575 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6576 global frame_version
6578 verbose -log "DejaGnu version: $frame_version"
6579 verbose -log "Expect version: [exp_version]"
6580 verbose -log "Tcl version: [info tclversion]"
6582 set dg_ver [split $frame_version .]
6584 while { [llength $dg_ver] < 3 } {
6591 # Define user-defined command COMMAND using the COMMAND_LIST as the
6592 # command's definition. The terminating "end" is added automatically.
6594 proc gdb_define_cmd {command command_list} {
6597 set input [multi_line_input {*}$command_list "end"]
6598 set test "define $command"
6600 gdb_test_multiple "define $command" $test {
6602 gdb_test_multiple $input $test {
6603 -re "\r\n$gdb_prompt " {
6610 # Override the 'cd' builtin with a version that ensures that the
6611 # log file keeps pointing at the same file. We need this because
6612 # unfortunately the path to the log file is recorded using an
6613 # relative path name, and, we sometimes need to close/reopen the log
6614 # after changing the current directory. See get_compiler_info.
6616 rename cd builtin_cd
6620 # Get the existing log file flags.
6621 set log_file_info [log_file -info]
6623 # Split the flags into args and file name.
6624 set log_file_flags ""
6625 set log_file_file ""
6626 foreach arg [ split "$log_file_info" " "] {
6627 if [string match "-*" $arg] {
6628 lappend log_file_flags $arg
6630 lappend log_file_file $arg
6634 # If there was an existing file, ensure it is an absolute path, and then
6636 if { $log_file_file != "" } {
6637 set log_file_file [file normalize $log_file_file]
6639 log_file $log_file_flags "$log_file_file"
6642 # Call the builtin version of cd.
6646 # Return a list of all languages supported by GDB, suitable for use in
6647 # 'set language NAME'. This doesn't include either the 'local' or
6649 proc gdb_supported_languages {} {
6650 return [list c objective-c c++ d go fortran modula-2 asm pascal \
6651 opencl rust minimal ada]
6654 # Check if debugging is enabled for gdb.
6656 proc gdb_debug_enabled { } {
6659 # If not already read, get the debug setting from environment or board setting.
6660 if {![info exists gdbdebug]} {
6662 if [info exists env(GDB_DEBUG)] {
6663 set gdbdebug $env(GDB_DEBUG)
6664 } elseif [target_info exists gdb,debug] {
6665 set gdbdebug [target_info gdb,debug]
6671 # Ensure it not empty.
6672 return [expr { $gdbdebug != "" }]
6675 # Turn on debugging if enabled, or reset if already on.
6677 proc gdb_debug_init { } {
6681 if ![gdb_debug_enabled] {
6685 # First ensure logging is off.
6686 send_gdb "set logging off\n"
6688 set debugfile [standard_output_file gdb.debug]
6689 send_gdb "set logging file $debugfile\n"
6691 send_gdb "set logging debugredirect\n"
6694 foreach entry [split $gdbdebug ,] {
6695 send_gdb "set debug $entry 1\n"
6698 # Now that everything is set, enable logging.
6699 send_gdb "set logging on\n"
6701 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
6702 timeout { warning "Couldn't set logging file" }
6706 # Check if debugging is enabled for gdbserver.
6708 proc gdbserver_debug_enabled { } {
6709 # Always disabled for GDB only setups.
6713 # Open the file for logging gdb input
6715 proc gdb_stdin_log_init { } {
6718 if {[info exists in_file]} {
6719 # Close existing file.
6720 catch "close $in_file"
6723 set logfile [standard_output_file_with_gdb_instance gdb.in]
6724 set in_file [open $logfile w]
6727 # Write to the file for logging gdb input.
6728 # TYPE can be one of the following:
6729 # "standard" : Default. Standard message written to the log
6730 # "answer" : Answer to a question (eg "Y"). Not written the log.
6731 # "optional" : Optional message. Not written to the log.
6733 proc gdb_stdin_log_write { message {type standard} } {
6736 if {![info exists in_file]} {
6740 # Check message types.
6741 switch -regexp -- $type {
6751 puts -nonewline $in_file "$message"
6754 # Write the command line used to invocate gdb to the cmd file.
6756 proc gdb_write_cmd_file { cmdline } {
6757 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
6758 set cmd_file [open $logfile w]
6759 puts $cmd_file $cmdline
6760 catch "close $cmd_file"
6763 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
6766 proc cmp_file_string { file str msg } {
6767 if { ![file exists $file]} {
6772 set caught_error [catch {
6773 set fp [open "$file" r]
6774 set file_contents [read $fp]
6777 if { $caught_error } then {
6778 error "$error_message"
6783 if { $file_contents == $str } {
6790 # Does the compiler support CTF debug output using '-gt' compiler
6791 # flag? If not then we should skip these tests.
6793 gdb_caching_proc skip_ctf_tests {
6794 return ![gdb_can_simple_compile ctfdebug {
6798 } executable "additional_flags=-gt"]
6801 # Always load compatibility stuff.