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. $" {
173 -re "Discard symbol table from .*y or n.*$" {
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.*$" {
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. $" {
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. $" {
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. $" {
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. $" {
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 gdb_test_multiple "continue" $full_name {
637 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
644 # gdb_internal_error_resync:
646 # Answer the questions GDB asks after it reports an internal error
647 # until we get back to a GDB prompt. Decline to quit the debugging
648 # session, and decline to create a core file. Return non-zero if the
651 # This procedure just answers whatever questions come up until it sees
652 # a GDB prompt; it doesn't require you to have matched the input up to
653 # any specific point. However, it only answers questions it sees in
654 # the output itself, so if you've matched a question, you had better
655 # answer it yourself before calling this.
657 # You can use this function thus:
661 # -re ".*A problem internal to GDB has been detected" {
662 # gdb_internal_error_resync
667 proc gdb_internal_error_resync {} {
670 verbose -log "Resyncing due to internal error."
673 while {$count < 10} {
675 -re "Quit this debugging session\\? \\(y or n\\) $" {
679 -re "Create a core file of GDB\\? \\(y or n\\) $" {
683 -re "$gdb_prompt $" {
684 # We're resynchronized.
688 perror "Could not resync from internal error (timeout)"
693 perror "Could not resync from internal error (resync count exceeded)"
698 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
699 # Send a command to gdb; test the result.
701 # COMMAND is the command to execute, send to GDB with send_gdb. If
702 # this is the null string no command is sent.
703 # MESSAGE is a message to be printed with the built-in failure patterns
704 # if one of them matches. If MESSAGE is empty COMMAND will be used.
705 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
706 # patterns. Pattern elements will be evaluated in the caller's
707 # context; action elements will be executed in the caller's context.
708 # Unlike patterns for gdb_test, these patterns should generally include
709 # the final newline and prompt.
712 # 1 if the test failed, according to a built-in failure pattern
713 # 0 if only user-supplied patterns matched
714 # -1 if there was an internal error.
716 # You can use this function thus:
718 # gdb_test_multiple "print foo" "test foo" {
719 # -re "expected output 1" {
722 # -re "expected output 2" {
727 # Like with "expect", you can also specify the spawn id to match with
728 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
729 # $gdb_spawn_id. The former matches inferior I/O, while the latter
730 # matches GDB I/O. E.g.:
732 # send_inferior "hello\n"
733 # gdb_test_multiple "continue" "test echo" {
734 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
737 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
738 # fail "hit breakpoint"
742 # The standard patterns, such as "Inferior exited..." and "A problem
743 # ...", all being implicitly appended to that list. These are always
744 # expected from $gdb_spawn_id. IOW, callers do not need to worry
745 # about resetting "-i" back to $gdb_spawn_id explicitly.
747 proc gdb_test_multiple { command message user_code } {
748 global verbose use_gdb_stub
749 global gdb_prompt pagination_prompt
752 global inferior_exited_re
753 upvar timeout timeout
754 upvar expect_out expect_out
757 if { $message == "" } {
761 if [string match "*\[\r\n\]" $command] {
762 error "Invalid trailing newline in \"$message\" test"
765 if [string match "*\[\r\n\]*" $message] {
766 error "Invalid newline in \"$message\" test"
770 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
772 error "gdbserver does not support $command without extended-remote"
775 # TCL/EXPECT WART ALERT
776 # Expect does something very strange when it receives a single braced
777 # argument. It splits it along word separators and performs substitutions.
778 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
779 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
780 # double-quoted list item, "\[ab\]" is just a long way of representing
781 # "[ab]", because the backslashes will be removed by lindex.
783 # Unfortunately, there appears to be no easy way to duplicate the splitting
784 # that expect will do from within TCL. And many places make use of the
785 # "\[0-9\]" construct, so we need to support that; and some places make use
786 # of the "[func]" construct, so we need to support that too. In order to
787 # get this right we have to substitute quoted list elements differently
788 # from braced list elements.
790 # We do this roughly the same way that Expect does it. We have to use two
791 # lists, because if we leave unquoted newlines in the argument to uplevel
792 # they'll be treated as command separators, and if we escape newlines
793 # we mangle newlines inside of command blocks. This assumes that the
794 # input doesn't contain a pattern which contains actual embedded newlines
797 regsub -all {\n} ${user_code} { } subst_code
798 set subst_code [uplevel list $subst_code]
800 set processed_code ""
802 set expecting_action 0
804 foreach item $user_code subst_item $subst_code {
805 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
806 lappend processed_code $item
809 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
810 lappend processed_code $item
813 if { $item == "-timeout" || $item == "-i" } {
815 lappend processed_code $item
818 if { $expecting_arg } {
820 lappend processed_code $subst_item
823 if { $expecting_action } {
824 lappend processed_code "uplevel [list $item]"
825 set expecting_action 0
826 # Cosmetic, no effect on the list.
827 append processed_code "\n"
830 set expecting_action 1
831 lappend processed_code $subst_item
832 if {$patterns != ""} {
835 append patterns "\"$subst_item\""
838 # Also purely cosmetic.
839 regsub -all {\r} $patterns {\\r} patterns
840 regsub -all {\n} $patterns {\\n} patterns
843 send_user "Sending \"$command\" to gdb\n"
844 send_user "Looking to match \"$patterns\"\n"
845 send_user "Message is \"$message\"\n"
849 set string "${command}\n"
850 if { $command != "" } {
851 set multi_line_re "\[\r\n\] *>"
852 while { "$string" != "" } {
853 set foo [string first "\n" "$string"]
854 set len [string length "$string"]
855 if { $foo < [expr $len - 1] } {
856 set str [string range "$string" 0 $foo]
857 if { [send_gdb "$str"] != "" } {
860 if { ! $suppress_flag } {
861 perror "Couldn't send $command to GDB."
866 # since we're checking if each line of the multi-line
867 # command are 'accepted' by GDB here,
868 # we need to set -notransfer expect option so that
869 # command output is not lost for pattern matching
872 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
873 timeout { verbose "partial: timeout" 3 }
875 set string [string range "$string" [expr $foo + 1] end]
876 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
881 if { "$string" != "" } {
882 if { [send_gdb "$string"] != "" } {
885 if { ! $suppress_flag } {
886 perror "Couldn't send $command to GDB."
895 -re ".*A problem internal to GDB has been detected" {
896 fail "$message (GDB internal error)"
897 gdb_internal_error_resync
900 -re "\\*\\*\\* DOSEXIT code.*" {
901 if { $message != "" } {
904 gdb_suppress_entire_file "GDB died"
908 append code $processed_code
910 # Reset the spawn id, in case the processed code used -i.
916 -re "Ending remote debugging.*$gdb_prompt $" {
917 if ![isnative] then {
918 warning "Can`t communicate to remote target."
924 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
925 perror "Undefined command \"$command\"."
929 -re "Ambiguous command.*$gdb_prompt $" {
930 perror "\"$command\" is not a unique command name."
934 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
935 if ![string match "" $message] then {
936 set errmsg "$message (the program exited)"
938 set errmsg "$command (the program exited)"
943 -re "$inferior_exited_re normally.*$gdb_prompt $" {
944 if ![string match "" $message] then {
945 set errmsg "$message (the program exited)"
947 set errmsg "$command (the program exited)"
952 -re "The program is not being run.*$gdb_prompt $" {
953 if ![string match "" $message] then {
954 set errmsg "$message (the program is no longer running)"
956 set errmsg "$command (the program is no longer running)"
961 -re "\r\n$gdb_prompt $" {
962 if ![string match "" $message] then {
967 -re "$pagination_prompt" {
969 perror "Window too small."
973 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
975 gdb_expect -re "$gdb_prompt $"
976 fail "$message (got interactive prompt)"
979 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
981 gdb_expect -re "$gdb_prompt $"
982 fail "$message (got breakpoint menu)"
988 perror "GDB process no longer exists"
989 set wait_status [wait -i $gdb_spawn_id]
990 verbose -log "GDB process exited with wait status $wait_status"
991 if { $message != "" } {
998 # Now patterns that apply to any spawn id specified.
1002 perror "Process no longer exists"
1003 if { $message != "" } {
1009 perror "internal buffer is full."
1014 if ![string match "" $message] then {
1015 fail "$message (timeout)"
1021 # remote_expect calls the eof section if there is an error on the
1022 # expect call. We already have eof sections above, and we don't
1023 # want them to get called in that situation. Since the last eof
1024 # section becomes the error section, here we define another eof
1025 # section, but with an empty spawn_id list, so that it won't ever
1029 # This comment is here because the eof section must not be
1030 # the empty string, otherwise remote_expect won't realize
1036 set code [catch {gdb_expect $code} string]
1038 global errorInfo errorCode
1039 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1040 } elseif {$code > 1} {
1041 return -code $code $string
1046 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1047 # Send a command to gdb; test the result.
1049 # COMMAND is the command to execute, send to GDB with send_gdb. If
1050 # this is the null string no command is sent.
1051 # PATTERN is the pattern to match for a PASS, and must NOT include
1052 # the \r\n sequence immediately before the gdb prompt. This argument
1053 # may be omitted to just match the prompt, ignoring whatever output
1055 # MESSAGE is an optional message to be printed. If this is
1056 # omitted, then the pass/fail messages use the command string as the
1057 # message. (If this is the empty string, then sometimes we don't
1058 # call pass or fail at all; I don't understand this at all.)
1059 # QUESTION is a question GDB may ask in response to COMMAND, like
1061 # RESPONSE is the response to send if QUESTION appears.
1064 # 1 if the test failed,
1065 # 0 if the test passes,
1066 # -1 if there was an internal error.
1068 proc gdb_test { args } {
1070 upvar timeout timeout
1072 if [llength $args]>2 then {
1073 set message [lindex $args 2]
1075 set message [lindex $args 0]
1077 set command [lindex $args 0]
1078 set pattern [lindex $args 1]
1080 if [llength $args]==5 {
1081 set question_string [lindex $args 3]
1082 set response_string [lindex $args 4]
1084 set question_string "^FOOBAR$"
1087 return [gdb_test_multiple $command $message {
1088 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1089 if ![string match "" $message] then {
1093 -re "(${question_string})$" {
1094 send_gdb "$response_string\n"
1100 # gdb_test_no_output COMMAND MESSAGE
1101 # Send a command to GDB and verify that this command generated no output.
1103 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1104 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1105 # the message. (If MESSAGE is the empty string, then sometimes we do not
1106 # call pass or fail at all; I don't understand this at all.)
1108 proc gdb_test_no_output { args } {
1110 set command [lindex $args 0]
1111 if [llength $args]>1 then {
1112 set message [lindex $args 1]
1114 set message $command
1117 set command_regex [string_to_regexp $command]
1118 gdb_test_multiple $command $message {
1119 -re "^$command_regex\r\n$gdb_prompt $" {
1120 if ![string match "" $message] then {
1127 # Send a command and then wait for a sequence of outputs.
1128 # This is useful when the sequence is long and contains ".*", a single
1129 # regexp to match the entire output can get a timeout much easier.
1131 # COMMAND is the command to execute, send to GDB with send_gdb. If
1132 # this is the null string no command is sent.
1133 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1134 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1135 # processed in order, and all must be present in the output.
1137 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1138 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1139 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1141 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1142 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1145 # 1 if the test failed,
1146 # 0 if the test passes,
1147 # -1 if there was an internal error.
1149 proc gdb_test_sequence { command test_name expected_output_list } {
1151 if { $test_name == "" } {
1152 set test_name $command
1154 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1155 if { $command != "" } {
1156 send_gdb "$command\n"
1158 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1162 # Test that a command gives an error. For pass or fail, return
1163 # a 1 to indicate that more tests can proceed. However a timeout
1164 # is a serious error, generates a special fail message, and causes
1165 # a 0 to be returned to indicate that more tests are likely to fail
1168 proc test_print_reject { args } {
1172 if [llength $args]==2 then {
1173 set expectthis [lindex $args 1]
1175 set expectthis "should never match this bogus string"
1177 set sendthis [lindex $args 0]
1178 if $verbose>2 then {
1179 send_user "Sending \"$sendthis\" to gdb\n"
1180 send_user "Looking to match \"$expectthis\"\n"
1182 send_gdb "$sendthis\n"
1183 #FIXME: Should add timeout as parameter.
1185 -re "A .* in expression.*\\.*$gdb_prompt $" {
1186 pass "reject $sendthis"
1189 -re "Invalid syntax in expression.*$gdb_prompt $" {
1190 pass "reject $sendthis"
1193 -re "Junk after end of expression.*$gdb_prompt $" {
1194 pass "reject $sendthis"
1197 -re "Invalid number.*$gdb_prompt $" {
1198 pass "reject $sendthis"
1201 -re "Invalid character constant.*$gdb_prompt $" {
1202 pass "reject $sendthis"
1205 -re "No symbol table is loaded.*$gdb_prompt $" {
1206 pass "reject $sendthis"
1209 -re "No symbol .* in current context.*$gdb_prompt $" {
1210 pass "reject $sendthis"
1213 -re "Unmatched single quote.*$gdb_prompt $" {
1214 pass "reject $sendthis"
1217 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1218 pass "reject $sendthis"
1221 -re "$expectthis.*$gdb_prompt $" {
1222 pass "reject $sendthis"
1225 -re ".*$gdb_prompt $" {
1226 fail "reject $sendthis"
1230 fail "reject $sendthis (eof or timeout)"
1237 # Same as gdb_test, but the second parameter is not a regexp,
1238 # but a string that must match exactly.
1240 proc gdb_test_exact { args } {
1241 upvar timeout timeout
1243 set command [lindex $args 0]
1245 # This applies a special meaning to a null string pattern. Without
1246 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1247 # messages from commands that should have no output except a new
1248 # prompt. With this, only results of a null string will match a null
1251 set pattern [lindex $args 1]
1252 if [string match $pattern ""] {
1253 set pattern [string_to_regexp [lindex $args 0]]
1255 set pattern [string_to_regexp [lindex $args 1]]
1258 # It is most natural to write the pattern argument with only
1259 # embedded \n's, especially if you are trying to avoid Tcl quoting
1260 # problems. But gdb_expect really wants to see \r\n in patterns. So
1261 # transform the pattern here. First transform \r\n back to \n, in
1262 # case some users of gdb_test_exact already do the right thing.
1263 regsub -all "\r\n" $pattern "\n" pattern
1264 regsub -all "\n" $pattern "\r\n" pattern
1265 if [llength $args]==3 then {
1266 set message [lindex $args 2]
1268 set message $command
1271 return [gdb_test $command $pattern $message]
1274 # Wrapper around gdb_test_multiple that looks for a list of expected
1275 # output elements, but which can appear in any order.
1276 # CMD is the gdb command.
1277 # NAME is the name of the test.
1278 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1280 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1281 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1282 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1284 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1285 # of text per element and then strip trailing \r\n's.
1287 # gdb_test_list_exact "foo" "bar" \
1288 # "\[^\r\n\]+\[\r\n\]+" \
1291 # {expected result 1} \
1292 # {expected result 2} \
1295 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1298 set matches [lsort $result_match_list]
1300 gdb_test_multiple $cmd $name {
1301 "$cmd\[\r\n\]" { exp_continue }
1302 -re $elm_find_regexp {
1303 set str $expect_out(0,string)
1304 verbose -log "seen: $str" 3
1305 regexp -- $elm_extract_regexp $str elm_seen
1306 verbose -log "extracted: $elm_seen" 3
1307 lappend seen $elm_seen
1310 -re "$gdb_prompt $" {
1312 foreach got [lsort $seen] have $matches {
1313 if {![string equal $got $have]} {
1318 if {[string length $failed] != 0} {
1319 fail "$name ($failed not found)"
1327 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1328 # Send a command to gdb; expect inferior and gdb output.
1330 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1333 # INFERIOR_PATTERN is the pattern to match against inferior output.
1335 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1336 # include the \r\n sequence immediately before the gdb prompt, nor the
1337 # prompt. The default is empty.
1339 # Both inferior and gdb patterns must match for a PASS.
1341 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1344 # 1 if the test failed,
1345 # 0 if the test passes,
1346 # -1 if there was an internal error.
1349 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1350 global inferior_spawn_id gdb_spawn_id
1353 if {$message == ""} {
1354 set message $command
1357 set inferior_matched 0
1360 # Use an indirect spawn id list, and remove the inferior spawn id
1361 # from the expected output as soon as it matches, in case
1362 # $inferior_pattern happens to be a prefix of the resulting full
1363 # gdb pattern below (e.g., "\r\n").
1364 global gdb_test_stdio_spawn_id_list
1365 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1367 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1368 # then we may see gdb's output arriving before the inferior's
1370 set res [gdb_test_multiple $command $message {
1371 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1372 set inferior_matched 1
1373 if {!$gdb_matched} {
1374 set gdb_test_stdio_spawn_id_list ""
1378 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1380 if {!$inferior_matched} {
1388 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1393 # get_print_expr_at_depths EXP OUTPUTS
1395 # Used for testing 'set print max-depth'. Prints the expression EXP
1396 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1397 # of `n` different patterns to match at each of the depths from 0 to
1400 # This proc does one final check with the max-depth set to 'unlimited'
1401 # which is tested against the last pattern in the OUTPUTS list. The
1402 # OUTPUTS list is therefore required to match every depth from 0 to a
1403 # depth where the whole of EXP is printed with no ellipsis.
1405 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1406 proc gdb_print_expr_at_depths {exp outputs} {
1407 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1408 if { $depth == [llength $outputs] } {
1409 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1410 set depth_string "unlimited"
1412 set expected_result [lindex $outputs $depth]
1413 set depth_string $depth
1416 with_test_prefix "exp='$exp': depth=${depth_string}" {
1417 gdb_test_no_output "set print max-depth ${depth_string}"
1418 gdb_test "p $exp" "$expected_result"
1425 # Issue a PASS and return true if evaluating CONDITION in the caller's
1426 # frame returns true, and issue a FAIL and return false otherwise.
1427 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1428 # omitted or is empty, then the pass/fail messages use the condition
1429 # string as the message.
1431 proc gdb_assert { condition {message ""} } {
1432 if { $message == ""} {
1433 set message $condition
1436 set res [uplevel 1 expr $condition]
1445 proc gdb_reinitialize_dir { subdir } {
1448 if [is_remote host] {
1453 -re "Reinitialize source path to empty.*y or n. " {
1456 -re "Source directories searched.*$gdb_prompt $" {
1457 send_gdb "dir $subdir\n"
1459 -re "Source directories searched.*$gdb_prompt $" {
1460 verbose "Dir set to $subdir"
1462 -re "$gdb_prompt $" {
1463 perror "Dir \"$subdir\" failed."
1467 -re "$gdb_prompt $" {
1468 perror "Dir \"$subdir\" failed."
1472 -re "$gdb_prompt $" {
1473 perror "Dir \"$subdir\" failed."
1479 # gdb_exit -- exit the GDB, killing the target program if necessary
1481 proc default_gdb_exit {} {
1483 global INTERNAL_GDBFLAGS GDBFLAGS
1485 global gdb_spawn_id inferior_spawn_id
1486 global inotify_log_file
1488 gdb_stop_suppressing_tests
1490 if ![info exists gdb_spawn_id] {
1494 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1496 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1497 set fd [open $inotify_log_file]
1498 set data [read -nonewline $fd]
1501 if {[string compare $data ""] != 0} {
1502 warning "parallel-unsafe file creations noticed"
1505 set fd [open $inotify_log_file w]
1510 if { [is_remote host] && [board_info host exists fileid] } {
1517 -re "DOSEXIT code" { }
1522 if ![is_remote host] {
1526 unset inferior_spawn_id
1529 # Load a file into the debugger.
1530 # The return value is 0 for success, -1 for failure.
1532 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1533 # to one of these values:
1535 # debug file was loaded successfully and has debug information
1536 # nodebug file was loaded successfully and has no debug information
1537 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1539 # fail file was not loaded
1541 # I tried returning this information as part of the return value,
1542 # but ran into a mess because of the many re-implementations of
1543 # gdb_load in config/*.exp.
1545 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1546 # this if they can get more information set.
1548 proc gdb_file_cmd { arg } {
1552 global last_loaded_file
1554 # Save this for the benefit of gdbserver-support.exp.
1555 set last_loaded_file $arg
1557 # Set whether debug info was found.
1558 # Default to "fail".
1559 global gdb_file_cmd_debug_info
1560 set gdb_file_cmd_debug_info "fail"
1562 if [is_remote host] {
1563 set arg [remote_download host $arg]
1565 perror "download failed"
1570 # The file command used to kill the remote target. For the benefit
1571 # of the testsuite, preserve this behavior.
1574 -re "Kill the program being debugged. .y or n. $" {
1576 verbose "\t\tKilling previous program being debugged"
1579 -re "$gdb_prompt $" {
1584 send_gdb "file $arg\n"
1586 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1587 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1588 set gdb_file_cmd_debug_info "lzma"
1591 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1592 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1593 set gdb_file_cmd_debug_info "nodebug"
1596 -re "Reading symbols from.*$gdb_prompt $" {
1597 verbose "\t\tLoaded $arg into $GDB"
1598 set gdb_file_cmd_debug_info "debug"
1601 -re "Load new symbol table from \".*\".*y or n. $" {
1604 -re "Reading symbols from.*$gdb_prompt $" {
1605 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1606 set gdb_file_cmd_debug_info "debug"
1610 perror "Couldn't load $arg, other program already loaded (timeout)."
1614 perror "Couldn't load $arg, other program already loaded (eof)."
1619 -re "No such file or directory.*$gdb_prompt $" {
1620 perror "($arg) No such file or directory"
1623 -re "A problem internal to GDB has been detected" {
1624 fail "($arg) (GDB internal error)"
1625 gdb_internal_error_resync
1628 -re "$gdb_prompt $" {
1629 perror "Couldn't load $arg into $GDB."
1633 perror "Couldn't load $arg into $GDB (timeout)."
1637 # This is an attempt to detect a core dump, but seems not to
1638 # work. Perhaps we need to match .* followed by eof, in which
1639 # gdb_expect does not seem to have a way to do that.
1640 perror "Couldn't load $arg into $GDB (eof)."
1646 # Default gdb_spawn procedure.
1648 proc default_gdb_spawn { } {
1651 global INTERNAL_GDBFLAGS GDBFLAGS
1654 gdb_stop_suppressing_tests
1656 # Set the default value, it may be overriden later by specific testfile.
1658 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1659 # is already started after connecting and run/attach are not supported.
1660 # This is used for the "remote" protocol. After GDB starts you should
1661 # check global $use_gdb_stub instead of the board as the testfile may force
1662 # a specific different target protocol itself.
1663 set use_gdb_stub [target_info exists use_gdb_stub]
1665 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1667 if [info exists gdb_spawn_id] {
1671 if ![is_remote host] {
1672 if { [which $GDB] == 0 } then {
1673 perror "$GDB does not exist."
1677 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1678 if { $res < 0 || $res == "" } {
1679 perror "Spawning $GDB failed."
1683 set gdb_spawn_id $res
1687 # Default gdb_start procedure.
1689 proc default_gdb_start { } {
1692 global inferior_spawn_id
1694 if [info exists gdb_spawn_id] {
1703 # Default to assuming inferior I/O is done on GDB's terminal.
1704 if {![info exists inferior_spawn_id]} {
1705 set inferior_spawn_id $gdb_spawn_id
1708 # When running over NFS, particularly if running many simultaneous
1709 # tests on different hosts all using the same server, things can
1710 # get really slow. Give gdb at least 3 minutes to start up.
1712 -re "\[\r\n\]$gdb_prompt $" {
1713 verbose "GDB initialized."
1715 -re "$gdb_prompt $" {
1716 perror "GDB never initialized."
1721 perror "(timeout) GDB never initialized after 10 seconds."
1728 # force the height to "unlimited", so no pagers get used
1730 send_gdb "set height 0\n"
1732 -re "$gdb_prompt $" {
1733 verbose "Setting height to 0." 2
1736 warning "Couldn't set the height to 0"
1739 # force the width to "unlimited", so no wraparound occurs
1740 send_gdb "set width 0\n"
1742 -re "$gdb_prompt $" {
1743 verbose "Setting width to 0." 2
1746 warning "Couldn't set the width to 0."
1754 # Utility procedure to give user control of the gdb prompt in a script. It is
1755 # meant to be used for debugging test cases, and should not be left in the
1758 proc gdb_interact { } {
1760 set spawn_id $gdb_spawn_id
1762 send_user "+------------------------------------------+\n"
1763 send_user "| Script interrupted, you can now interact |\n"
1764 send_user "| with by gdb. Type >>> to continue. |\n"
1765 send_user "+------------------------------------------+\n"
1772 # Examine the output of compilation to determine whether compilation
1773 # failed or not. If it failed determine whether it is due to missing
1774 # compiler or due to compiler error. Report pass, fail or unsupported
1777 proc gdb_compile_test {src output} {
1778 if { $output == "" } {
1779 pass "compilation [file tail $src]"
1780 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1781 unsupported "compilation [file tail $src]"
1782 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1783 unsupported "compilation [file tail $src]"
1784 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1785 unsupported "compilation [file tail $src]"
1787 verbose -log "compilation failed: $output" 2
1788 fail "compilation [file tail $src]"
1792 # Return a 1 for configurations for which we don't even want to try to
1795 proc skip_cplus_tests {} {
1796 if { [istarget "h8300-*-*"] } {
1800 # The C++ IO streams are too large for HC11/HC12 and are thus not
1801 # available. The gdb C++ tests use them and don't compile.
1802 if { [istarget "m6811-*-*"] } {
1805 if { [istarget "m6812-*-*"] } {
1811 # Return a 1 for configurations for which don't have both C++ and the STL.
1813 proc skip_stl_tests {} {
1814 # Symbian supports the C++ language, but the STL is missing
1815 # (both headers and libraries).
1816 if { [istarget "arm*-*-symbianelf*"] } {
1820 return [skip_cplus_tests]
1823 # Return a 1 if I don't even want to try to test FORTRAN.
1825 proc skip_fortran_tests {} {
1829 # Return a 1 if I don't even want to try to test ada.
1831 proc skip_ada_tests {} {
1835 # Return a 1 if I don't even want to try to test GO.
1837 proc skip_go_tests {} {
1841 # Return a 1 if I don't even want to try to test D.
1843 proc skip_d_tests {} {
1847 # Return 1 to skip Rust tests, 0 to try them.
1848 proc skip_rust_tests {} {
1849 return [expr {![isnative]}]
1852 # Return a 1 for configurations that do not support Python scripting.
1853 # PROMPT_REGEXP is the expected prompt.
1855 proc skip_python_tests_prompt { prompt_regexp } {
1856 global gdb_py_is_py3k
1858 gdb_test_multiple "python print ('test')" "verify python support" {
1859 -re "not supported.*$prompt_regexp" {
1860 unsupported "Python support is disabled."
1863 -re "$prompt_regexp" {}
1866 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1867 -re "3.*$prompt_regexp" {
1868 set gdb_py_is_py3k 1
1870 -re ".*$prompt_regexp" {
1871 set gdb_py_is_py3k 0
1878 # Return a 1 for configurations that do not support Python scripting.
1879 # Note: This also sets various globals that specify which version of Python
1880 # is in use. See skip_python_tests_prompt.
1882 proc skip_python_tests {} {
1884 return [skip_python_tests_prompt "$gdb_prompt $"]
1887 # Return a 1 if we should skip shared library tests.
1889 proc skip_shlib_tests {} {
1890 # Run the shared library tests on native systems.
1895 # An abbreviated list of remote targets where we should be able to
1896 # run shared library tests.
1897 if {([istarget *-*-linux*]
1898 || [istarget *-*-*bsd*]
1899 || [istarget *-*-solaris2*]
1900 || [istarget arm*-*-symbianelf*]
1901 || [istarget *-*-mingw*]
1902 || [istarget *-*-cygwin*]
1903 || [istarget *-*-pe*])} {
1910 # Return 1 if we should skip tui related tests.
1912 proc skip_tui_tests {} {
1915 gdb_test_multiple "help layout" "verify tui support" {
1916 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1919 -re "$gdb_prompt $" {
1926 # Test files shall make sure all the test result lines in gdb.sum are
1927 # unique in a test run, so that comparing the gdb.sum files of two
1928 # test runs gives correct results. Test files that exercise
1929 # variations of the same tests more than once, shall prefix the
1930 # different test invocations with different identifying strings in
1931 # order to make them unique.
1933 # About test prefixes:
1935 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1936 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1937 # underlined substring in
1939 # PASS: gdb.base/mytest.exp: some test
1940 # ^^^^^^^^^^^^^^^^^^^^
1944 # The easiest way to adjust the test prefix is to append a test
1945 # variation prefix to the $pf_prefix, using the with_test_prefix
1948 # proc do_tests {} {
1949 # gdb_test ... ... "test foo"
1950 # gdb_test ... ... "test bar"
1952 # with_test_prefix "subvariation a" {
1953 # gdb_test ... ... "test x"
1956 # with_test_prefix "subvariation b" {
1957 # gdb_test ... ... "test x"
1961 # with_test_prefix "variation1" {
1962 # ...do setup for variation 1...
1966 # with_test_prefix "variation2" {
1967 # ...do setup for variation 2...
1973 # PASS: gdb.base/mytest.exp: variation1: test foo
1974 # PASS: gdb.base/mytest.exp: variation1: test bar
1975 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1976 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1977 # PASS: gdb.base/mytest.exp: variation2: test foo
1978 # PASS: gdb.base/mytest.exp: variation2: test bar
1979 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1980 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1982 # If for some reason more flexibility is necessary, one can also
1983 # manipulate the pf_prefix global directly, treating it as a string.
1987 # set saved_pf_prefix
1988 # append pf_prefix "${foo}: bar"
1989 # ... actual tests ...
1990 # set pf_prefix $saved_pf_prefix
1993 # Run BODY in the context of the caller, with the current test prefix
1994 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1995 # Returns the result of BODY.
1997 proc with_test_prefix { prefix body } {
2000 set saved $pf_prefix
2001 append pf_prefix " " $prefix ":"
2002 set code [catch {uplevel 1 $body} result]
2003 set pf_prefix $saved
2006 global errorInfo errorCode
2007 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2009 return -code $code $result
2013 # Wrapper for foreach that calls with_test_prefix on each iteration,
2014 # including the iterator's name and current value in the prefix.
2016 proc foreach_with_prefix {var list body} {
2018 foreach myvar $list {
2019 with_test_prefix "$var=$myvar" {
2025 # Like TCL's native proc, but defines a procedure that wraps its body
2026 # within 'with_test_prefix "$proc_name" { ... }'.
2027 proc proc_with_prefix {name arguments body} {
2028 # Define the advertised proc.
2029 proc $name $arguments [list with_test_prefix $name $body]
2033 # Run BODY in the context of the caller. After BODY is run, the variables
2034 # listed in VARS will be reset to the values they had before BODY was run.
2036 # This is useful for providing a scope in which it is safe to temporarily
2037 # modify global variables, e.g.
2039 # global INTERNAL_GDBFLAGS
2042 # set foo GDBHISTSIZE
2044 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2045 # append INTERNAL_GDBFLAGS " -nx"
2046 # unset -nocomplain env(GDBHISTSIZE)
2051 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2052 # modified inside BODY, this proc guarantees that the modifications will be
2053 # undone after BODY finishes executing.
2055 proc save_vars { vars body } {
2056 array set saved_scalars { }
2057 array set saved_arrays { }
2061 # First evaluate VAR in the context of the caller in case the variable
2062 # name may be a not-yet-interpolated string like env($foo)
2063 set var [uplevel 1 list $var]
2065 if [uplevel 1 [list info exists $var]] {
2066 if [uplevel 1 [list array exists $var]] {
2067 set saved_arrays($var) [uplevel 1 [list array get $var]]
2069 set saved_scalars($var) [uplevel 1 [list set $var]]
2072 lappend unset_vars $var
2076 set code [catch {uplevel 1 $body} result]
2078 foreach {var value} [array get saved_scalars] {
2079 uplevel 1 [list set $var $value]
2082 foreach {var value} [array get saved_arrays] {
2083 uplevel 1 [list unset $var]
2084 uplevel 1 [list array set $var $value]
2087 foreach var $unset_vars {
2088 uplevel 1 [list unset -nocomplain $var]
2092 global errorInfo errorCode
2093 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2095 return -code $code $result
2099 # Run tests in BODY with the current working directory (CWD) set to
2100 # DIR. When BODY is finished, restore the original CWD. Return the
2103 # This procedure doesn't check if DIR is a valid directory, so you
2104 # have to make sure of that.
2106 proc with_cwd { dir body } {
2108 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2111 set code [catch {uplevel 1 $body} result]
2113 verbose -log "Switching back to $saved_dir."
2117 global errorInfo errorCode
2118 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2120 return -code $code $result
2124 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2125 # PROMPT. When BODY is finished, restore GDB prompt and variable
2127 # Returns the result of BODY.
2131 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2132 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2133 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2134 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2135 # a) It's more intuitive for callers to pass the plain text form.
2136 # b) We need two forms of the prompt:
2137 # - a regexp to use in output matching,
2138 # - a value to pass to the "set prompt" command.
2139 # c) It's easier to convert the plain text form to its regexp form.
2141 # 2) Don't add a trailing space, we do that here.
2143 proc with_gdb_prompt { prompt body } {
2146 # Convert "(foo)" to "\(foo\)".
2147 # We don't use string_to_regexp because while it works today it's not
2148 # clear it will work tomorrow: the value we need must work as both a
2149 # regexp *and* as the argument to the "set prompt" command, at least until
2150 # we start recording both forms separately instead of just $gdb_prompt.
2151 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2153 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2155 set saved $gdb_prompt
2157 verbose -log "Setting gdb prompt to \"$prompt \"."
2158 set gdb_prompt $prompt
2159 gdb_test_no_output "set prompt $prompt " ""
2161 set code [catch {uplevel 1 $body} result]
2163 verbose -log "Restoring gdb prompt to \"$saved \"."
2164 set gdb_prompt $saved
2165 gdb_test_no_output "set prompt $saved " ""
2168 global errorInfo errorCode
2169 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2171 return -code $code $result
2175 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2176 # BODY is finished, restore target-charset.
2178 proc with_target_charset { target_charset body } {
2182 gdb_test_multiple "show target-charset" "" {
2183 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2184 set saved $expect_out(1,string)
2186 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2187 set saved $expect_out(1,string)
2189 -re ".*$gdb_prompt " {
2190 fail "get target-charset"
2194 gdb_test_no_output "set target-charset $target_charset" ""
2196 set code [catch {uplevel 1 $body} result]
2198 gdb_test_no_output "set target-charset $saved" ""
2201 global errorInfo errorCode
2202 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2204 return -code $code $result
2208 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2209 # mi_gdb_test etc. default to using it.
2211 proc switch_gdb_spawn_id {spawn_id} {
2213 global board board_info
2215 set gdb_spawn_id $spawn_id
2216 set board [host_info name]
2217 set board_info($board,fileid) $spawn_id
2220 # Clear the default spawn id.
2222 proc clear_gdb_spawn_id {} {
2224 global board board_info
2226 unset -nocomplain gdb_spawn_id
2227 set board [host_info name]
2228 unset -nocomplain board_info($board,fileid)
2231 # Run BODY with SPAWN_ID as current spawn id.
2233 proc with_spawn_id { spawn_id body } {
2236 if [info exists gdb_spawn_id] {
2237 set saved_spawn_id $gdb_spawn_id
2240 switch_gdb_spawn_id $spawn_id
2242 set code [catch {uplevel 1 $body} result]
2244 if [info exists saved_spawn_id] {
2245 switch_gdb_spawn_id $saved_spawn_id
2251 global errorInfo errorCode
2252 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2254 return -code $code $result
2258 # Select the largest timeout from all the timeouts:
2259 # - the local "timeout" variable of the scope two levels above,
2260 # - the global "timeout" variable,
2261 # - the board variable "gdb,timeout".
2263 proc get_largest_timeout {} {
2264 upvar #0 timeout gtimeout
2265 upvar 2 timeout timeout
2268 if [info exists timeout] {
2271 if { [info exists gtimeout] && $gtimeout > $tmt } {
2274 if { [target_info exists gdb,timeout]
2275 && [target_info gdb,timeout] > $tmt } {
2276 set tmt [target_info gdb,timeout]
2286 # Run tests in BODY with timeout increased by factor of FACTOR. When
2287 # BODY is finished, restore timeout.
2289 proc with_timeout_factor { factor body } {
2292 set savedtimeout $timeout
2294 set timeout [expr [get_largest_timeout] * $factor]
2295 set code [catch {uplevel 1 $body} result]
2297 set timeout $savedtimeout
2299 global errorInfo errorCode
2300 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2302 return -code $code $result
2306 # Return 1 if _Complex types are supported, otherwise, return 0.
2308 gdb_caching_proc support_complex_tests {
2310 if { [gdb_skip_float_test] } {
2311 # If floating point is not supported, _Complex is not
2316 # Compile a test program containing _Complex types.
2318 return [gdb_can_simple_compile complex {
2322 _Complex long double cld;
2328 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2331 proc supports_get_siginfo_type {} {
2332 if { [istarget "*-*-linux*"] } {
2339 # Return 1 if the target supports hardware single stepping.
2341 proc can_hardware_single_step {} {
2343 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2344 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2345 || [istarget "nios2-*-*"] } {
2352 # Return 1 if target hardware or OS supports single stepping to signal
2353 # handler, otherwise, return 0.
2355 proc can_single_step_to_signal_handler {} {
2356 # Targets don't have hardware single step. On these targets, when
2357 # a signal is delivered during software single step, gdb is unable
2358 # to determine the next instruction addresses, because start of signal
2359 # handler is one of them.
2360 return [can_hardware_single_step]
2363 # Return 1 if target supports process record, otherwise return 0.
2365 proc supports_process_record {} {
2367 if [target_info exists gdb,use_precord] {
2368 return [target_info gdb,use_precord]
2371 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2372 || [istarget "i\[34567\]86-*-linux*"]
2373 || [istarget "aarch64*-*-linux*"]
2374 || [istarget "powerpc*-*-linux*"]
2375 || [istarget "s390*-*-linux*"] } {
2382 # Return 1 if target supports reverse debugging, otherwise return 0.
2384 proc supports_reverse {} {
2386 if [target_info exists gdb,can_reverse] {
2387 return [target_info gdb,can_reverse]
2390 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2391 || [istarget "i\[34567\]86-*-linux*"]
2392 || [istarget "aarch64*-*-linux*"]
2393 || [istarget "powerpc*-*-linux*"]
2394 || [istarget "s390*-*-linux*"] } {
2401 # Return 1 if readline library is used.
2403 proc readline_is_used { } {
2406 gdb_test_multiple "show editing" "" {
2407 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2410 -re ".*$gdb_prompt $" {
2416 # Return 1 if target is ELF.
2417 gdb_caching_proc is_elf_target {
2418 set me "is_elf_target"
2420 set src { int foo () {return 0;} }
2421 if {![gdb_simple_compile elf_target $src]} {
2425 set fp_obj [open $obj "r"]
2426 fconfigure $fp_obj -translation binary
2427 set data [read $fp_obj]
2432 set ELFMAG "\u007FELF"
2434 if {[string compare -length 4 $data $ELFMAG] != 0} {
2435 verbose "$me: returning 0" 2
2439 verbose "$me: returning 1" 2
2443 # Return 1 if the memory at address zero is readable.
2445 gdb_caching_proc is_address_zero_readable {
2449 gdb_test_multiple "x 0" "" {
2450 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2453 -re ".*$gdb_prompt $" {
2461 # Produce source file NAME and write SOURCES into it.
2463 proc gdb_produce_source { name sources } {
2465 set f [open $name "w"]
2471 # Return 1 if target is ILP32.
2472 # This cannot be decided simply from looking at the target string,
2473 # as it might depend on externally passed compiler options like -m64.
2474 gdb_caching_proc is_ilp32_target {
2475 return [gdb_can_simple_compile is_ilp32_target {
2476 int dummy[sizeof (int) == 4
2477 && sizeof (void *) == 4
2478 && sizeof (long) == 4 ? 1 : -1];
2482 # Return 1 if target is LP64.
2483 # This cannot be decided simply from looking at the target string,
2484 # as it might depend on externally passed compiler options like -m64.
2485 gdb_caching_proc is_lp64_target {
2486 return [gdb_can_simple_compile is_lp64_target {
2487 int dummy[sizeof (int) == 4
2488 && sizeof (void *) == 8
2489 && sizeof (long) == 8 ? 1 : -1];
2493 # Return 1 if target has 64 bit addresses.
2494 # This cannot be decided simply from looking at the target string,
2495 # as it might depend on externally passed compiler options like -m64.
2496 gdb_caching_proc is_64_target {
2497 return [gdb_can_simple_compile is_64_target {
2498 int function(void) { return 3; }
2499 int dummy[sizeof (&function) == 8 ? 1 : -1];
2503 # Return 1 if target has x86_64 registers - either amd64 or x32.
2504 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2505 # just from the target string.
2506 gdb_caching_proc is_amd64_regs_target {
2507 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2511 return [gdb_can_simple_compile is_amd64_regs_target {
2521 # Return 1 if this target is an x86 or x86-64 with -m32.
2522 proc is_x86_like_target {} {
2523 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2526 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2529 # Return 1 if this target is an arm or aarch32 on aarch64.
2531 gdb_caching_proc is_aarch32_target {
2532 if { [istarget "arm*-*-*"] } {
2536 if { ![istarget "aarch64*-*-*"] } {
2543 lappend list "\tmov $reg, $reg"
2546 return [gdb_can_simple_compile aarch32 [join $list \n]]
2549 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2551 proc is_aarch64_target {} {
2552 if { ![istarget "aarch64*-*-*"] } {
2556 return [expr ![is_aarch32_target]]
2559 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2560 proc support_displaced_stepping {} {
2562 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2563 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2564 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2565 || [istarget "aarch64*-*-linux*"] } {
2572 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2573 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2575 gdb_caching_proc skip_altivec_tests {
2576 global srcdir subdir gdb_prompt inferior_exited_re
2578 set me "skip_altivec_tests"
2580 # Some simulators are known to not support VMX instructions.
2581 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2582 verbose "$me: target known to not support VMX, returning 1" 2
2586 # Make sure we have a compiler that understands altivec.
2587 if [get_compiler_info] {
2588 warning "Could not get compiler info"
2591 if [test_compiler_info gcc*] {
2592 set compile_flags "additional_flags=-maltivec"
2593 } elseif [test_compiler_info xlc*] {
2594 set compile_flags "additional_flags=-qaltivec"
2596 verbose "Could not compile with altivec support, returning 1" 2
2600 # Compile a test program containing VMX instructions.
2604 asm volatile ("vor v0,v0,v0");
2606 asm volatile ("vor 0,0,0");
2611 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2615 # Compilation succeeded so now run it via gdb.
2619 gdb_reinitialize_dir $srcdir/$subdir
2623 -re ".*Illegal instruction.*${gdb_prompt} $" {
2624 verbose -log "\n$me altivec hardware not detected"
2625 set skip_vmx_tests 1
2627 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2628 verbose -log "\n$me: altivec hardware detected"
2629 set skip_vmx_tests 0
2632 warning "\n$me: default case taken"
2633 set skip_vmx_tests 1
2637 remote_file build delete $obj
2639 verbose "$me: returning $skip_vmx_tests" 2
2640 return $skip_vmx_tests
2643 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2644 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2646 gdb_caching_proc skip_vsx_tests {
2647 global srcdir subdir gdb_prompt inferior_exited_re
2649 set me "skip_vsx_tests"
2651 # Some simulators are known to not support Altivec instructions, so
2652 # they won't support VSX instructions as well.
2653 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2654 verbose "$me: target known to not support VSX, returning 1" 2
2658 # Make sure we have a compiler that understands altivec.
2659 if [get_compiler_info] {
2660 warning "Could not get compiler info"
2663 if [test_compiler_info gcc*] {
2664 set compile_flags "additional_flags=-mvsx"
2665 } elseif [test_compiler_info xlc*] {
2666 set compile_flags "additional_flags=-qasm=gcc"
2668 verbose "Could not compile with vsx support, returning 1" 2
2672 # Compile a test program containing VSX instructions.
2675 double a[2] = { 1.0, 2.0 };
2677 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2679 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2684 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2688 # No error message, compilation succeeded so now run it via gdb.
2692 gdb_reinitialize_dir $srcdir/$subdir
2696 -re ".*Illegal instruction.*${gdb_prompt} $" {
2697 verbose -log "\n$me VSX hardware not detected"
2698 set skip_vsx_tests 1
2700 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2701 verbose -log "\n$me: VSX hardware detected"
2702 set skip_vsx_tests 0
2705 warning "\n$me: default case taken"
2706 set skip_vsx_tests 1
2710 remote_file build delete $obj
2712 verbose "$me: returning $skip_vsx_tests" 2
2713 return $skip_vsx_tests
2716 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2717 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2719 gdb_caching_proc skip_tsx_tests {
2720 global srcdir subdir gdb_prompt inferior_exited_re
2722 set me "skip_tsx_tests"
2724 # Compile a test program.
2727 asm volatile ("xbegin .L0");
2728 asm volatile ("xend");
2729 asm volatile (".L0: nop");
2733 if {![gdb_simple_compile $me $src executable]} {
2737 # No error message, compilation succeeded so now run it via gdb.
2741 gdb_reinitialize_dir $srcdir/$subdir
2745 -re ".*Illegal instruction.*${gdb_prompt} $" {
2746 verbose -log "$me: TSX hardware not detected."
2747 set skip_tsx_tests 1
2749 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2750 verbose -log "$me: TSX hardware detected."
2751 set skip_tsx_tests 0
2754 warning "\n$me: default case taken."
2755 set skip_tsx_tests 1
2759 remote_file build delete $obj
2761 verbose "$me: returning $skip_tsx_tests" 2
2762 return $skip_tsx_tests
2765 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2766 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2768 gdb_caching_proc skip_btrace_tests {
2769 global srcdir subdir gdb_prompt inferior_exited_re
2771 set me "skip_btrace_tests"
2772 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2773 verbose "$me: target does not support btrace, returning 1" 2
2777 # Compile a test program.
2778 set src { int main() { return 0; } }
2779 if {![gdb_simple_compile $me $src executable]} {
2783 # No error message, compilation succeeded so now run it via gdb.
2787 gdb_reinitialize_dir $srcdir/$subdir
2792 # In case of an unexpected output, we return 2 as a fail value.
2793 set skip_btrace_tests 2
2794 gdb_test_multiple "record btrace" "check btrace support" {
2795 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2796 set skip_btrace_tests 1
2798 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2799 set skip_btrace_tests 1
2801 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2802 set skip_btrace_tests 1
2804 -re "^record btrace\r\n$gdb_prompt $" {
2805 set skip_btrace_tests 0
2809 remote_file build delete $obj
2811 verbose "$me: returning $skip_btrace_tests" 2
2812 return $skip_btrace_tests
2815 # Run a test on the target to see if it supports btrace pt hardware.
2816 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2817 # from the GCC testsuite.
2819 gdb_caching_proc skip_btrace_pt_tests {
2820 global srcdir subdir gdb_prompt inferior_exited_re
2822 set me "skip_btrace_tests"
2823 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2824 verbose "$me: target does not support btrace, returning 1" 2
2828 # Compile a test program.
2829 set src { int main() { return 0; } }
2830 if {![gdb_simple_compile $me $src executable]} {
2834 # No error message, compilation succeeded so now run it via gdb.
2838 gdb_reinitialize_dir $srcdir/$subdir
2843 # In case of an unexpected output, we return 2 as a fail value.
2844 set skip_btrace_tests 2
2845 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2846 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2847 set skip_btrace_tests 1
2849 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2850 set skip_btrace_tests 1
2852 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2853 set skip_btrace_tests 1
2855 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2856 set skip_btrace_tests 1
2858 -re "^record btrace pt\r\n$gdb_prompt $" {
2859 set skip_btrace_tests 0
2863 remote_file build delete $obj
2865 verbose "$me: returning $skip_btrace_tests" 2
2866 return $skip_btrace_tests
2869 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2870 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2872 gdb_caching_proc skip_aarch64_sve_tests {
2873 global srcdir subdir gdb_prompt inferior_exited_re
2875 set me "skip_aarch64_sve_tests"
2877 if { ![is_aarch64_target]} {
2881 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2883 # Compile a test program containing SVE instructions.
2886 asm volatile ("ptrue p0.b");
2890 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2894 # Compilation succeeded so now run it via gdb.
2898 -re ".*Illegal instruction.*${gdb_prompt} $" {
2899 verbose -log "\n$me sve hardware not detected"
2900 set skip_sve_tests 1
2902 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2903 verbose -log "\n$me: sve hardware detected"
2904 set skip_sve_tests 0
2907 warning "\n$me: default case taken"
2908 set skip_sve_tests 1
2912 remote_file build delete $obj
2914 verbose "$me: returning $skip_sve_tests" 2
2915 return $skip_sve_tests
2919 # A helper that compiles a test case to see if __int128 is supported.
2920 proc gdb_int128_helper {lang} {
2921 return [gdb_can_simple_compile "i128-for-$lang" {
2923 int main() { return 0; }
2927 # Return true if the C compiler understands the __int128 type.
2928 gdb_caching_proc has_int128_c {
2929 return [gdb_int128_helper c]
2932 # Return true if the C++ compiler understands the __int128 type.
2933 gdb_caching_proc has_int128_cxx {
2934 return [gdb_int128_helper c++]
2937 # Return true if the IFUNC feature is unsupported.
2938 gdb_caching_proc skip_ifunc_tests {
2939 if [gdb_can_simple_compile ifunc {
2941 typedef void F (void);
2942 F* g (void) { return &f_; }
2943 void f () __attribute__ ((ifunc ("g")));
2951 # Return whether we should skip tests for showing inlined functions in
2952 # backtraces. Requires get_compiler_info and get_debug_format.
2954 proc skip_inline_frame_tests {} {
2955 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2956 if { ! [test_debug_format "DWARF 2"] } {
2960 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2961 if { ([test_compiler_info "gcc-2-*"]
2962 || [test_compiler_info "gcc-3-*"]
2963 || [test_compiler_info "gcc-4-0-*"]) } {
2970 # Return whether we should skip tests for showing variables from
2971 # inlined functions. Requires get_compiler_info and get_debug_format.
2973 proc skip_inline_var_tests {} {
2974 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2975 if { ! [test_debug_format "DWARF 2"] } {
2982 # Return a 1 if we should skip tests that require hardware breakpoints
2984 proc skip_hw_breakpoint_tests {} {
2985 # Skip tests if requested by the board (note that no_hardware_watchpoints
2986 # disables both watchpoints and breakpoints)
2987 if { [target_info exists gdb,no_hardware_watchpoints]} {
2991 # These targets support hardware breakpoints natively
2992 if { [istarget "i?86-*-*"]
2993 || [istarget "x86_64-*-*"]
2994 || [istarget "ia64-*-*"]
2995 || [istarget "arm*-*-*"]
2996 || [istarget "aarch64*-*-*"]
2997 || [istarget "s390*-*-*"] } {
3004 # Return a 1 if we should skip tests that require hardware watchpoints
3006 proc skip_hw_watchpoint_tests {} {
3007 # Skip tests if requested by the board
3008 if { [target_info exists gdb,no_hardware_watchpoints]} {
3012 # These targets support hardware watchpoints natively
3013 if { [istarget "i?86-*-*"]
3014 || [istarget "x86_64-*-*"]
3015 || [istarget "ia64-*-*"]
3016 || [istarget "arm*-*-*"]
3017 || [istarget "aarch64*-*-*"]
3018 || [istarget "powerpc*-*-linux*"]
3019 || [istarget "s390*-*-*"] } {
3026 # Return a 1 if we should skip tests that require *multiple* hardware
3027 # watchpoints to be active at the same time
3029 proc skip_hw_watchpoint_multi_tests {} {
3030 if { [skip_hw_watchpoint_tests] } {
3034 # These targets support just a single hardware watchpoint
3035 if { [istarget "arm*-*-*"]
3036 || [istarget "powerpc*-*-linux*"] } {
3043 # Return a 1 if we should skip tests that require read/access watchpoints
3045 proc skip_hw_watchpoint_access_tests {} {
3046 if { [skip_hw_watchpoint_tests] } {
3050 # These targets support just write watchpoints
3051 if { [istarget "s390*-*-*"] } {
3058 # Return 1 if we should skip tests that require the runtime unwinder
3059 # hook. This must be invoked while gdb is running, after shared
3060 # libraries have been loaded. This is needed because otherwise a
3061 # shared libgcc won't be visible.
3063 proc skip_unwinder_tests {} {
3067 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3068 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3070 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3073 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3077 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3078 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3081 -re "\r\n$gdb_prompt $" {
3088 # Return 0 if we should skip tests that require the libstdc++ stap
3089 # probes. This must be invoked while gdb is running, after shared
3090 # libraries have been loaded.
3092 proc skip_libstdcxx_probe_tests {} {
3096 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3097 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3100 -re "\r\n$gdb_prompt $" {
3106 # Return 1 if we should skip tests of the "compile" feature.
3107 # This must be invoked after the inferior has been started.
3109 proc skip_compile_feature_tests {} {
3113 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3114 "Could not load libcc1.*\r\n$gdb_prompt $" {
3117 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3120 -re "\r\n$gdb_prompt $" {
3126 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3127 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3128 # is a regexp that will match the output of "maint print target-stack" if
3129 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3130 # matching the expected prompt after the command output.
3132 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3133 set test "probe for target ${target_name}"
3134 gdb_test_multiple "maint print target-stack" $test {
3135 -re "${target_stack_regexp}${prompt_regexp}" {
3139 -re "$prompt_regexp" {
3146 # Helper for gdb_is_target_remote where the expected prompt is variable.
3148 proc gdb_is_target_remote_prompt { prompt_regexp } {
3149 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3152 # Check whether we're testing with the remote or extended-remote
3155 proc gdb_is_target_remote { } {
3158 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3161 # Check whether we're testing with the native target.
3163 proc gdb_is_target_native { } {
3166 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3169 # Return the effective value of use_gdb_stub.
3171 # If the use_gdb_stub global has been set (it is set when the gdb process is
3172 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3173 # property from the board file.
3175 # This is the preferred way of checking use_gdb_stub, since it allows to check
3176 # the value before the gdb has been spawned and it will return the correct value
3177 # even when it was overriden by the test.
3179 proc use_gdb_stub {} {
3182 if [info exists use_gdb_stub] {
3183 return $use_gdb_stub
3186 return [target_info exists use_gdb_stub]
3189 # Return 1 if the current remote target is an instance of our GDBserver, 0
3190 # otherwise. Return -1 if there was an error and we can't tell.
3192 gdb_caching_proc target_is_gdbserver {
3196 set test "probing for GDBserver"
3198 gdb_test_multiple "monitor help" $test {
3199 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3202 -re "$gdb_prompt $" {
3207 if { $is_gdbserver == -1 } {
3208 verbose -log "Unable to tell whether we are using GDBserver or not."
3211 return $is_gdbserver
3214 # N.B. compiler_info is intended to be local to this file.
3215 # Call test_compiler_info with no arguments to fetch its value.
3216 # Yes, this is counterintuitive when there's get_compiler_info,
3217 # but that's the current API.
3218 if [info exists compiler_info] {
3224 # Figure out what compiler I am using.
3225 # The result is cached so only the first invocation runs the compiler.
3227 # ARG can be empty or "C++". If empty, "C" is assumed.
3229 # There are several ways to do this, with various problems.
3231 # [ gdb_compile -E $ifile -o $binfile.ci ]
3232 # source $binfile.ci
3234 # Single Unix Spec v3 says that "-E -o ..." together are not
3235 # specified. And in fact, the native compiler on hp-ux 11 (among
3236 # others) does not work with "-E -o ...". Most targets used to do
3237 # this, and it mostly worked, because it works with gcc.
3239 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3240 # source $binfile.ci
3242 # This avoids the problem with -E and -o together. This almost works
3243 # if the build machine is the same as the host machine, which is
3244 # usually true of the targets which are not gcc. But this code does
3245 # not figure which compiler to call, and it always ends up using the C
3246 # compiler. Not good for setting hp_aCC_compiler. Target
3247 # hppa*-*-hpux* used to do this.
3249 # [ gdb_compile -E $ifile > $binfile.ci ]
3250 # source $binfile.ci
3252 # dejagnu target_compile says that it supports output redirection,
3253 # but the code is completely different from the normal path and I
3254 # don't want to sweep the mines from that path. So I didn't even try
3257 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3260 # I actually do this for all targets now. gdb_compile runs the right
3261 # compiler, and TCL captures the output, and I eval the output.
3263 # Unfortunately, expect logs the output of the command as it goes by,
3264 # and dejagnu helpfully prints a second copy of it right afterwards.
3265 # So I turn off expect logging for a moment.
3267 # [ gdb_compile $ifile $ciexe_file executable $args ]
3268 # [ remote_exec $ciexe_file ]
3269 # [ source $ci_file.out ]
3271 # I could give up on -E and just do this.
3272 # I didn't get desperate enough to try this.
3274 # -- chastain 2004-01-06
3276 proc get_compiler_info {{arg ""}} {
3277 # For compiler.c and compiler.cc
3280 # I am going to play with the log to keep noise out.
3284 # These come from compiler.c or compiler.cc
3285 global compiler_info
3287 # Legacy global data symbols.
3290 if [info exists compiler_info] {
3295 # Choose which file to preprocess.
3296 set ifile "${srcdir}/lib/compiler.c"
3297 if { $arg == "c++" } {
3298 set ifile "${srcdir}/lib/compiler.cc"
3301 # Run $ifile through the right preprocessor.
3302 # Toggle gdb.log to keep the compiler output out of the log.
3303 set saved_log [log_file -info]
3305 if [is_remote host] {
3306 # We have to use -E and -o together, despite the comments
3307 # above, because of how DejaGnu handles remote host testing.
3308 set ppout "$outdir/compiler.i"
3309 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3310 set file [open $ppout r]
3311 set cppout [read $file]
3314 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3316 eval log_file $saved_log
3320 foreach cppline [ split "$cppout" "\n" ] {
3321 if { [ regexp "^#" "$cppline" ] } {
3323 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3325 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3327 verbose "get_compiler_info: $cppline" 2
3331 verbose -log "get_compiler_info: $cppline"
3336 # Set to unknown if for some reason compiler_info didn't get defined.
3337 if ![info exists compiler_info] {
3338 verbose -log "get_compiler_info: compiler_info not provided"
3339 set compiler_info "unknown"
3341 # Also set to unknown compiler if any diagnostics happened.
3343 verbose -log "get_compiler_info: got unexpected diagnostics"
3344 set compiler_info "unknown"
3347 # Set the legacy symbols.
3349 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3351 # Log what happened.
3352 verbose -log "get_compiler_info: $compiler_info"
3354 # Most compilers will evaluate comparisons and other boolean
3355 # operations to 0 or 1.
3356 uplevel \#0 { set true 1 }
3357 uplevel \#0 { set false 0 }
3362 # Return the compiler_info string if no arg is provided.
3363 # Otherwise the argument is a glob-style expression to match against
3366 proc test_compiler_info { {compiler ""} } {
3367 global compiler_info
3370 # If no arg, return the compiler_info string.
3371 if [string match "" $compiler] {
3372 return $compiler_info
3375 return [string match $compiler $compiler_info]
3378 proc current_target_name { } {
3380 if [info exists target_info(target,name)] {
3381 set answer $target_info(target,name)
3388 set gdb_wrapper_initialized 0
3389 set gdb_wrapper_target ""
3391 proc gdb_wrapper_init { args } {
3392 global gdb_wrapper_initialized
3393 global gdb_wrapper_file
3394 global gdb_wrapper_flags
3395 global gdb_wrapper_target
3397 if { $gdb_wrapper_initialized == 1 } { return; }
3399 if {[target_info exists needs_status_wrapper] && \
3400 [target_info needs_status_wrapper] != "0"} {
3401 set result [build_wrapper "testglue.o"]
3402 if { $result != "" } {
3403 set gdb_wrapper_file [lindex $result 0]
3404 set gdb_wrapper_flags [lindex $result 1]
3406 warning "Status wrapper failed to build."
3409 set gdb_wrapper_initialized 1
3410 set gdb_wrapper_target [current_target_name]
3413 # Determine options that we always want to pass to the compiler.
3414 gdb_caching_proc universal_compile_options {
3415 set me "universal_compile_options"
3418 set src [standard_temp_file ccopts[pid].c]
3419 set obj [standard_temp_file ccopts[pid].o]
3421 gdb_produce_source $src {
3422 int foo(void) { return 0; }
3425 # Try an option for disabling colored diagnostics. Some compilers
3426 # yield colored diagnostics by default (when run from a tty) unless
3427 # such an option is specified.
3428 set opt "additional_flags=-fdiagnostics-color=never"
3429 set lines [target_compile $src $obj object [list "quiet" $opt]]
3430 if [string match "" $lines] then {
3431 # Seems to have worked; use the option.
3432 lappend options $opt
3437 verbose "$me: returning $options" 2
3441 # Compile the code in $code to a file based on $name, using the flags
3442 # $compile_flag as well as debug, nowarning and quiet.
3443 # Return 1 if code can be compiled
3444 # Leave the file name of the resulting object in the upvar object.
3446 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3449 switch -regexp -- $type {
3463 set src [standard_temp_file $name-[pid].c]
3464 set obj [standard_temp_file $name-[pid].$postfix]
3465 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3467 gdb_produce_source $src $code
3469 verbose "$name: compiling testfile $src" 2
3470 set lines [gdb_compile $src $obj $type $compile_flags]
3474 if ![string match "" $lines] then {
3475 verbose "$name: compilation failed, returning 0" 2
3481 # Compile the code in $code to a file based on $name, using the flags
3482 # $compile_flag as well as debug, nowarning and quiet.
3483 # Return 1 if code can be compiled
3484 # Delete all created files and objects.
3486 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3487 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3488 file delete $temp_obj
3492 # Some targets need to always link a special object in. Save its path here.
3493 global gdb_saved_set_unbuffered_mode_obj
3494 set gdb_saved_set_unbuffered_mode_obj ""
3496 # Compile source files specified by SOURCE into a binary of type TYPE at path
3497 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3498 # parameter and most options are passed directly to it.
3500 # The type can be one of the following:
3502 # - object: Compile into an object file.
3503 # - executable: Compile and link into an executable.
3504 # - preprocess: Preprocess the source files.
3505 # - assembly: Generate assembly listing.
3507 # The following options are understood and processed by gdb_compile:
3509 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3510 # quirks to be able to use shared libraries.
3511 # - shlib_load: Link with appropriate libraries to allow the test to
3512 # dynamically load libraries at runtime. For example, on Linux, this adds
3513 # -ldl so that the test can use dlopen.
3514 # - nowarnings: Inhibit all compiler warnings.
3515 # - pie: Force creation of PIE executables.
3516 # - nopie: Prevent creation of PIE executables.
3518 # And here are some of the not too obscure options understood by DejaGnu that
3519 # influence the compilation:
3521 # - additional_flags=flag: Add FLAG to the compiler flags.
3522 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3523 # argument can be a file, in which case it's added to the sources, or a
3525 # - ldflags=flag: Add FLAG to the linker flags.
3526 # - incdir=path: Add PATH to the searched include directories.
3527 # - libdir=path: Add PATH to the linker searched directories.
3528 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3529 # - debug: Build with debug information.
3530 # - optimize: Build with optimization.
3532 proc gdb_compile {source dest type options} {
3533 global GDB_TESTCASE_OPTIONS
3534 global gdb_wrapper_file
3535 global gdb_wrapper_flags
3536 global gdb_wrapper_initialized
3539 global gdb_saved_set_unbuffered_mode_obj
3541 set outdir [file dirname $dest]
3543 # Add platform-specific options if a shared library was specified using
3544 # "shlib=librarypath" in OPTIONS.
3546 if {[lsearch -exact $options rust] != -1} {
3547 # -fdiagnostics-color is not a rustcc option.
3549 set new_options [universal_compile_options]
3553 set getting_compiler_info 0
3554 foreach opt $options {
3555 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3556 && $type == "executable"} {
3557 if [test_compiler_info "xlc-*"] {
3558 # IBM xlc compiler doesn't accept shared library named other
3559 # than .so: use "-Wl," to bypass this
3560 lappend source "-Wl,$shlib_name"
3561 } elseif { ([istarget "*-*-mingw*"]
3562 || [istarget *-*-cygwin*]
3563 || [istarget *-*-pe*])} {
3564 lappend source "${shlib_name}.a"
3566 lappend source $shlib_name
3568 if { $shlib_found == 0 } {
3570 if { ([istarget "*-*-mingw*"]
3571 || [istarget *-*-cygwin*]) } {
3572 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3574 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3575 # Undo debian's change in the default.
3576 # Put it at the front to not override any user-provided
3577 # value, and to make sure it appears in front of all the
3579 lappend new_options "early_flags=-Wl,--no-as-needed"
3582 } elseif { $opt == "shlib_load" && $type == "executable" } {
3584 } elseif { $opt == "getting_compiler_info" } {
3585 # If this is set, calling test_compiler_info will cause recursion.
3586 set getting_compiler_info 1
3588 lappend new_options $opt
3592 # Ensure stack protector is disabled for GCC, as this causes problems with
3593 # DWARF line numbering.
3594 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3595 # This option defaults to on for Debian/Ubuntu.
3596 if { $getting_compiler_info == 0
3597 && [test_compiler_info {gcc-*-*}]
3598 && !([test_compiler_info {gcc-[0-3]-*}]
3599 || [test_compiler_info {gcc-4-0-*}])
3600 && [lsearch -exact $options rust] == -1} {
3601 # Put it at the front to not override any user-provided value.
3602 lappend new_options "early_flags=-fno-stack-protector"
3605 # Because we link with libraries using their basename, we may need
3606 # (depending on the platform) to set a special rpath value, to allow
3607 # the executable to find the libraries it depends on.
3608 if { $shlib_load || $shlib_found } {
3609 if { ([istarget "*-*-mingw*"]
3610 || [istarget *-*-cygwin*]
3611 || [istarget *-*-pe*]) } {
3612 # Do not need anything.
3613 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3614 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3615 } elseif { [istarget arm*-*-symbianelf*] } {
3616 if { $shlib_load } {
3617 lappend new_options "libs=-ldl"
3620 if { $shlib_load } {
3621 lappend new_options "libs=-ldl"
3623 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3626 set options $new_options
3628 if [info exists GDB_TESTCASE_OPTIONS] {
3629 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3631 verbose "options are $options"
3632 verbose "source is $source $dest $type $options"
3634 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3636 if {[target_info exists needs_status_wrapper] && \
3637 [target_info needs_status_wrapper] != "0" && \
3638 [info exists gdb_wrapper_file]} {
3639 lappend options "libs=${gdb_wrapper_file}"
3640 lappend options "ldflags=${gdb_wrapper_flags}"
3643 # Replace the "nowarnings" option with the appropriate additional_flags
3644 # to disable compiler warnings.
3645 set nowarnings [lsearch -exact $options nowarnings]
3646 if {$nowarnings != -1} {
3647 if [target_info exists gdb,nowarnings_flag] {
3648 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3650 set flag "additional_flags=-w"
3652 set options [lreplace $options $nowarnings $nowarnings $flag]
3655 # Replace the "pie" option with the appropriate compiler and linker flags
3656 # to enable PIE executables.
3657 set pie [lsearch -exact $options pie]
3659 if [target_info exists gdb,pie_flag] {
3660 set flag "additional_flags=[target_info gdb,pie_flag]"
3662 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3663 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3664 # a maximum size. On other architectures the two flags are
3665 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3666 # onwards default GCC to using fPIE. If you do require fpie, then
3667 # it can be set using the pie_flag.
3668 set flag "additional_flags=-fPIE"
3670 set options [lreplace $options $pie $pie $flag]
3672 if [target_info exists gdb,pie_ldflag] {
3673 set flag "ldflags=[target_info gdb,pie_ldflag]"
3675 set flag "ldflags=-pie"
3677 lappend options "$flag"
3680 # Replace the "nopie" option with the appropriate linker flag to disable
3681 # PIE executables. There are no compiler flags for this option.
3682 set nopie [lsearch -exact $options nopie]
3684 if [target_info exists gdb,nopie_flag] {
3685 set flag "ldflags=[target_info gdb,nopie_flag]"
3687 set flag "ldflags=-no-pie"
3689 set options [lreplace $options $nopie $nopie $flag]
3692 if { $type == "executable" } {
3693 if { ([istarget "*-*-mingw*"]
3694 || [istarget "*-*-*djgpp"]
3695 || [istarget "*-*-cygwin*"])} {
3696 # Force output to unbuffered mode, by linking in an object file
3697 # with a global contructor that calls setvbuf.
3699 # Compile the special object seperatelly for two reasons:
3700 # 1) Insulate it from $options.
3701 # 2) Avoid compiling it for every gdb_compile invocation,
3702 # which is time consuming, especially if we're remote
3705 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3706 verbose "compiling gdb_saved_set_unbuffered_obj"
3707 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3708 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3710 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3711 if { $result != "" } {
3714 if {[is_remote host]} {
3715 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3717 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3719 # Link a copy of the output object, because the
3720 # original may be automatically deleted.
3721 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3723 verbose "gdb_saved_set_unbuffered_obj already compiled"
3726 # Rely on the internal knowledge that the global ctors are ran in
3727 # reverse link order. In that case, we can use ldflags to
3728 # avoid copying the object file to the host multiple
3730 # This object can only be added if standard libraries are
3731 # used. Thus, we need to disable it if -nostdlib option is used
3732 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3733 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3738 set result [target_compile $source $dest $type $options]
3740 # Prune uninteresting compiler (and linker) output.
3741 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3743 regsub "\[\r\n\]*$" "$result" "" result
3744 regsub "^\[\r\n\]*" "$result" "" result
3746 if {[lsearch $options quiet] < 0} {
3747 # We shall update this on a per language basis, to avoid
3748 # changing the entire testsuite in one go.
3749 if {[lsearch $options f77] >= 0} {
3750 gdb_compile_test $source $result
3751 } elseif { $result != "" } {
3752 clone_output "gdb compile failed, $result"
3759 # This is just like gdb_compile, above, except that it tries compiling
3760 # against several different thread libraries, to see which one this
3762 proc gdb_compile_pthreads {source dest type options} {
3764 set why_msg "unrecognized error"
3765 foreach lib {-lpthreads -lpthread -lthread ""} {
3766 # This kind of wipes out whatever libs the caller may have
3767 # set. Or maybe theirs will override ours. How infelicitous.
3768 set options_with_lib [concat $options [list libs=$lib quiet]]
3769 set ccout [gdb_compile $source $dest $type $options_with_lib]
3770 switch -regexp -- $ccout {
3771 ".*no posix threads support.*" {
3772 set why_msg "missing threads include file"
3775 ".*cannot open -lpthread.*" {
3776 set why_msg "missing runtime threads library"
3778 ".*Can't find library for -lpthread.*" {
3779 set why_msg "missing runtime threads library"
3782 pass "successfully compiled posix threads test case"
3788 if {!$built_binfile} {
3789 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3794 # Build a shared library from SOURCES.
3796 proc gdb_compile_shlib {sources dest options} {
3797 set obj_options $options
3800 if { [lsearch -exact $options "c++"] >= 0 } {
3801 set info_options "c++"
3803 if [get_compiler_info ${info_options}] {
3807 switch -glob [test_compiler_info] {
3809 lappend obj_options "additional_flags=-qpic"
3812 if { !([istarget "*-*-cygwin*"]
3813 || [istarget "*-*-mingw*"]) } {
3814 lappend obj_options "additional_flags=-fpic"
3818 if { !([istarget "powerpc*-*-aix*"]
3819 || [istarget "rs6000*-*-aix*"]
3820 || [istarget "*-*-cygwin*"]
3821 || [istarget "*-*-mingw*"]
3822 || [istarget "*-*-pe*"]) } {
3823 lappend obj_options "additional_flags=-fpic"
3827 lappend obj_options "additional_flags=-fpic"
3830 # don't know what the compiler is...
3834 set outdir [file dirname $dest]
3836 foreach source $sources {
3837 set sourcebase [file tail $source]
3838 if {[file extension $source] == ".o"} {
3839 # Already a .o file.
3840 lappend objects $source
3841 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
3842 $obj_options] != ""} {
3845 lappend objects ${outdir}/${sourcebase}.o
3849 set link_options $options
3850 if [test_compiler_info "xlc-*"] {
3851 lappend link_options "additional_flags=-qmkshrobj"
3853 lappend link_options "additional_flags=-shared"
3855 if { ([istarget "*-*-mingw*"]
3856 || [istarget *-*-cygwin*]
3857 || [istarget *-*-pe*]) } {
3858 if { [is_remote host] } {
3859 set name [file tail ${dest}]
3863 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3865 # Set the soname of the library. This causes the linker on ELF
3866 # systems to create the DT_NEEDED entry in the executable referring
3867 # to the soname of the library, and not its absolute path. This
3868 # (using the absolute path) would be problem when testing on a
3871 # In conjunction with setting the soname, we add the special
3872 # rpath=$ORIGIN value when building the executable, so that it's
3873 # able to find the library in its own directory.
3874 set destbase [file tail $dest]
3875 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3878 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3881 if { [is_remote host]
3882 && ([istarget "*-*-mingw*"]
3883 || [istarget *-*-cygwin*]
3884 || [istarget *-*-pe*]) } {
3885 set dest_tail_name [file tail ${dest}]
3886 remote_upload host $dest_tail_name.a ${dest}.a
3887 remote_file host delete $dest_tail_name.a
3893 # This is just like gdb_compile_shlib, above, except that it tries compiling
3894 # against several different thread libraries, to see which one this
3896 proc gdb_compile_shlib_pthreads {sources dest options} {
3898 set why_msg "unrecognized error"
3899 foreach lib {-lpthreads -lpthread -lthread ""} {
3900 # This kind of wipes out whatever libs the caller may have
3901 # set. Or maybe theirs will override ours. How infelicitous.
3902 set options_with_lib [concat $options [list libs=$lib quiet]]
3903 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3904 switch -regexp -- $ccout {
3905 ".*no posix threads support.*" {
3906 set why_msg "missing threads include file"
3909 ".*cannot open -lpthread.*" {
3910 set why_msg "missing runtime threads library"
3912 ".*Can't find library for -lpthread.*" {
3913 set why_msg "missing runtime threads library"
3916 pass "successfully compiled posix threads test case"
3922 if {!$built_binfile} {
3923 unsupported "couldn't compile $sources: ${why_msg}"
3928 # This is just like gdb_compile_pthreads, above, except that we always add the
3929 # objc library for compiling Objective-C programs
3930 proc gdb_compile_objc {source dest type options} {
3932 set why_msg "unrecognized error"
3933 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3934 # This kind of wipes out whatever libs the caller may have
3935 # set. Or maybe theirs will override ours. How infelicitous.
3936 if { $lib == "solaris" } {
3937 set lib "-lpthread -lposix4"
3939 if { $lib != "-lobjc" } {
3940 set lib "-lobjc $lib"
3942 set options_with_lib [concat $options [list libs=$lib quiet]]
3943 set ccout [gdb_compile $source $dest $type $options_with_lib]
3944 switch -regexp -- $ccout {
3945 ".*no posix threads support.*" {
3946 set why_msg "missing threads include file"
3949 ".*cannot open -lpthread.*" {
3950 set why_msg "missing runtime threads library"
3952 ".*Can't find library for -lpthread.*" {
3953 set why_msg "missing runtime threads library"
3956 pass "successfully compiled objc with posix threads test case"
3962 if {!$built_binfile} {
3963 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3968 proc send_gdb { string } {
3969 global suppress_flag
3970 if { $suppress_flag } {
3973 return [remote_send host "$string"]
3976 # Send STRING to the inferior's terminal.
3978 proc send_inferior { string } {
3979 global inferior_spawn_id
3981 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3991 proc gdb_expect { args } {
3992 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3993 set atimeout [lindex $args 0]
3994 set expcode [list [lindex $args 1]]
3999 # A timeout argument takes precedence, otherwise of all the timeouts
4000 # select the largest.
4001 if [info exists atimeout] {
4004 set tmt [get_largest_timeout]
4007 global suppress_flag
4008 global remote_suppress_flag
4009 if [info exists remote_suppress_flag] {
4010 set old_val $remote_suppress_flag
4012 if [info exists suppress_flag] {
4013 if { $suppress_flag } {
4014 set remote_suppress_flag 1
4018 {uplevel remote_expect host $tmt $expcode} string]
4019 if [info exists old_val] {
4020 set remote_suppress_flag $old_val
4022 if [info exists remote_suppress_flag] {
4023 unset remote_suppress_flag
4028 global errorInfo errorCode
4030 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4032 return -code $code $string
4036 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4038 # Check for long sequence of output by parts.
4039 # TEST: is the test message to be printed with the test success/fail.
4040 # SENTINEL: Is the terminal pattern indicating that output has finished.
4041 # LIST: is the sequence of outputs to match.
4042 # If the sentinel is recognized early, it is considered an error.
4045 # 1 if the test failed,
4046 # 0 if the test passes,
4047 # -1 if there was an internal error.
4049 proc gdb_expect_list {test sentinel list} {
4051 global suppress_flag
4054 if { $suppress_flag } {
4056 unresolved "${test}"
4058 while { ${index} < [llength ${list}] } {
4059 set pattern [lindex ${list} ${index}]
4060 set index [expr ${index} + 1]
4061 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4062 if { ${index} == [llength ${list}] } {
4065 -re "${pattern}${sentinel}" {
4066 # pass "${test}, pattern ${index} + sentinel"
4069 fail "${test} (pattern ${index} + sentinel)"
4072 -re ".*A problem internal to GDB has been detected" {
4073 fail "${test} (GDB internal error)"
4075 gdb_internal_error_resync
4078 fail "${test} (pattern ${index} + sentinel) (timeout)"
4083 # unresolved "${test}, pattern ${index} + sentinel"
4089 # pass "${test}, pattern ${index}"
4092 fail "${test} (pattern ${index})"
4095 -re ".*A problem internal to GDB has been detected" {
4096 fail "${test} (GDB internal error)"
4098 gdb_internal_error_resync
4101 fail "${test} (pattern ${index}) (timeout)"
4106 # unresolved "${test}, pattern ${index}"
4120 proc gdb_suppress_entire_file { reason } {
4121 global suppress_flag
4124 set suppress_flag -1
4128 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4129 # gdb_expect to fail immediately (until the next call to
4130 # gdb_stop_suppressing_tests).
4132 proc gdb_suppress_tests { args } {
4133 global suppress_flag
4135 return; # fnf - disable pending review of results where
4136 # testsuite ran better without this
4139 if { $suppress_flag == 1 } {
4140 if { [llength $args] > 0 } {
4141 warning "[lindex $args 0]\n"
4143 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4149 # Clear suppress_flag.
4151 proc gdb_stop_suppressing_tests { } {
4152 global suppress_flag
4154 if [info exists suppress_flag] {
4155 if { $suppress_flag > 0 } {
4157 clone_output "Tests restarted.\n"
4164 proc gdb_clear_suppressed { } {
4165 global suppress_flag
4170 # Spawn the gdb process.
4172 # This doesn't expect any output or do any other initialization,
4173 # leaving those to the caller.
4175 # Overridable function -- you can override this function in your
4178 proc gdb_spawn { } {
4182 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4184 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4187 set saved_gdbflags $GDBFLAGS
4189 if {$GDBFLAGS != ""} {
4192 append GDBFLAGS $cmdline_flags
4196 set GDBFLAGS $saved_gdbflags
4201 # Start gdb running, wait for prompt, and disable the pagers.
4203 # Overridable function -- you can override this function in your
4206 proc gdb_start { } {
4211 catch default_gdb_exit
4214 # Return true if we can spawn a program on the target and attach to
4217 proc can_spawn_for_attach { } {
4218 # We use exp_pid to get the inferior's pid, assuming that gives
4219 # back the pid of the program. On remote boards, that would give
4220 # us instead the PID of e.g., the ssh client, etc.
4221 if [is_remote target] then {
4225 # The "attach" command doesn't make sense when the target is
4226 # stub-like, where GDB finds the program already started on
4227 # initial connection.
4228 if {[target_info exists use_gdb_stub]} {
4236 # Kill a progress previously started with spawn_wait_for_attach, and
4237 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4240 proc kill_wait_spawned_process { proc_spawn_id } {
4241 set pid [exp_pid -i $proc_spawn_id]
4243 verbose -log "killing ${pid}"
4244 remote_exec build "kill -9 ${pid}"
4246 verbose -log "closing ${proc_spawn_id}"
4247 catch "close -i $proc_spawn_id"
4248 verbose -log "waiting for ${proc_spawn_id}"
4250 # If somehow GDB ends up still attached to the process here, a
4251 # blocking wait hangs until gdb is killed (or until gdb / the
4252 # ptracer reaps the exit status too, but that won't happen because
4253 # something went wrong.) Passing -nowait makes expect tell Tcl to
4254 # wait for the PID in the background. That's fine because we
4255 # don't care about the exit status. */
4256 wait -nowait -i $proc_spawn_id
4259 # Returns the process id corresponding to the given spawn id.
4261 proc spawn_id_get_pid { spawn_id } {
4262 set testpid [exp_pid -i $spawn_id]
4264 if { [istarget "*-*-cygwin*"] } {
4265 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4266 # might be different due to the way fork/exec works.
4267 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4273 # Start a set of programs running and then wait for a bit, to be sure
4274 # that they can be attached to. Return a list of processes spawn IDs,
4275 # one element for each process spawned. It's a test error to call
4276 # this when [can_spawn_for_attach] is false.
4278 proc spawn_wait_for_attach { executable_list } {
4279 set spawn_id_list {}
4281 if ![can_spawn_for_attach] {
4282 # The caller should have checked can_spawn_for_attach itself
4283 # before getting here.
4284 error "can't spawn for attach with this target/board"
4287 foreach {executable} $executable_list {
4288 # Note we use Expect's spawn, not Tcl's exec, because with
4289 # spawn we control when to wait for/reap the process. That
4290 # allows killing the process by PID without being subject to
4292 lappend spawn_id_list [remote_spawn target $executable]
4297 return $spawn_id_list
4301 # gdb_load_cmd -- load a file into the debugger.
4302 # ARGS - additional args to load command.
4303 # return a -1 if anything goes wrong.
4305 proc gdb_load_cmd { args } {
4308 if [target_info exists gdb_load_timeout] {
4309 set loadtimeout [target_info gdb_load_timeout]
4311 set loadtimeout 1600
4313 send_gdb "load $args\n"
4314 verbose "Timeout is now $loadtimeout seconds" 2
4315 gdb_expect $loadtimeout {
4316 -re "Loading section\[^\r\]*\r\n" {
4319 -re "Start address\[\r\]*\r\n" {
4322 -re "Transfer rate\[\r\]*\r\n" {
4325 -re "Memory access error\[^\r\]*\r\n" {
4326 perror "Failed to load program"
4329 -re "$gdb_prompt $" {
4332 -re "(.*)\r\n$gdb_prompt " {
4333 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4337 perror "Timed out trying to load $args."
4344 # Invoke "gcore". CORE is the name of the core file to write. TEST
4345 # is the name of the test case. This will return 1 if the core file
4346 # was created, 0 otherwise. If this fails to make a core file because
4347 # this configuration of gdb does not support making core files, it
4348 # will call "unsupported", not "fail". However, if this fails to make
4349 # a core file for some other reason, then it will call "fail".
4351 proc gdb_gcore_cmd {core test} {
4355 gdb_test_multiple "gcore $core" $test {
4356 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4360 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4368 # Load core file CORE. TEST is the name of the test case.
4369 # This will record a pass/fail for loading the core file.
4371 # 1 - core file is successfully loaded
4372 # 0 - core file loaded but has a non fatal error
4373 # -1 - core file failed to load
4375 proc gdb_core_cmd { core test } {
4378 gdb_test_multiple "core $core" "$test" {
4379 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4382 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4383 fail "$test (bad file format)"
4386 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4387 fail "$test (file not found)"
4390 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4391 fail "$test (incomplete note section)"
4394 -re "Core was generated by .*\r\n$gdb_prompt $" {
4398 -re ".*$gdb_prompt $" {
4403 fail "$test (timeout)"
4407 fail "unsupported output from 'core' command"
4411 # Return the filename to download to the target and load on the target
4412 # for this shared library. Normally just LIBNAME, unless shared libraries
4413 # for this target have separate link and load images.
4415 proc shlib_target_file { libname } {
4419 # Return the filename GDB will load symbols from when debugging this
4420 # shared library. Normally just LIBNAME, unless shared libraries for
4421 # this target have separate link and load images.
4423 proc shlib_symbol_file { libname } {
4427 # Return the filename to download to the target and load for this
4428 # executable. Normally just BINFILE unless it is renamed to something
4429 # else for this target.
4431 proc exec_target_file { binfile } {
4435 # Return the filename GDB will load symbols from when debugging this
4436 # executable. Normally just BINFILE unless executables for this target
4437 # have separate files for symbols.
4439 proc exec_symbol_file { binfile } {
4443 # Rename the executable file. Normally this is just BINFILE1 being renamed
4444 # to BINFILE2, but some targets require multiple binary files.
4445 proc gdb_rename_execfile { binfile1 binfile2 } {
4446 file rename -force [exec_target_file ${binfile1}] \
4447 [exec_target_file ${binfile2}]
4448 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4449 file rename -force [exec_symbol_file ${binfile1}] \
4450 [exec_symbol_file ${binfile2}]
4454 # "Touch" the executable file to update the date. Normally this is just
4455 # BINFILE, but some targets require multiple files.
4456 proc gdb_touch_execfile { binfile } {
4457 set time [clock seconds]
4458 file mtime [exec_target_file ${binfile}] $time
4459 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4460 file mtime [exec_symbol_file ${binfile}] $time
4464 # Like remote_download but provides a gdb-specific behavior.
4466 # If the destination board is remote, the local file FROMFILE is transferred as
4467 # usual with remote_download to TOFILE on the remote board. The destination
4468 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4471 # If the destination board is local, the destination path TOFILE is passed
4472 # through standard_output_file, and FROMFILE is copied there.
4474 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4477 proc gdb_remote_download {dest fromfile {tofile {}}} {
4478 # If TOFILE is not given, default to the same filename as FROMFILE.
4479 if {[string length $tofile] == 0} {
4480 set tofile [file tail $fromfile]
4483 if {[is_remote $dest]} {
4484 # When the DEST is remote, we simply send the file to DEST.
4487 set destname [remote_download $dest $fromfile $tofile]
4488 lappend cleanfiles $destname
4492 # When the DEST is local, we copy the file to the test directory (where
4493 # the executable is).
4495 # Note that we pass TOFILE through standard_output_file, regardless of
4496 # whether it is absolute or relative, because we don't want the tests
4497 # to be able to write outside their standard output directory.
4499 set tofile [standard_output_file $tofile]
4501 file copy -force $fromfile $tofile
4507 # gdb_load_shlib LIB...
4509 # Copy the listed library to the target.
4511 proc gdb_load_shlib { file } {
4514 if ![info exists gdb_spawn_id] {
4515 perror "gdb_load_shlib: GDB is not running"
4518 set dest [gdb_remote_download target [shlib_target_file $file]]
4520 if {[is_remote target]} {
4521 # If the target is remote, we need to tell gdb where to find the
4524 # We could set this even when not testing remotely, but a user
4525 # generally won't set it unless necessary. In order to make the tests
4526 # more like the real-life scenarios, we don't set it for local testing.
4527 gdb_test "set solib-search-path [file dirname $file]" "" ""
4534 # gdb_load -- load a file into the debugger. Specifying no file
4535 # defaults to the executable currently being debugged.
4536 # The return value is 0 for success, -1 for failure.
4537 # Many files in config/*.exp override this procedure.
4539 proc gdb_load { arg } {
4541 return [gdb_file_cmd $arg]
4546 # gdb_reload -- load a file into the target. Called before "running",
4547 # either the first time or after already starting the program once,
4548 # for remote targets. Most files that override gdb_load should now
4549 # override this instead.
4551 proc gdb_reload { } {
4552 # For the benefit of existing configurations, default to gdb_load.
4553 # Specifying no file defaults to the executable currently being
4555 return [gdb_load ""]
4558 proc gdb_continue { function } {
4561 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4564 proc default_gdb_init { test_file_name } {
4565 global gdb_wrapper_initialized
4566 global gdb_wrapper_target
4567 global gdb_test_file_name
4573 gdb_clear_suppressed
4575 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4577 # Make sure that the wrapper is rebuilt
4578 # with the appropriate multilib option.
4579 if { $gdb_wrapper_target != [current_target_name] } {
4580 set gdb_wrapper_initialized 0
4583 # Unlike most tests, we have a small number of tests that generate
4584 # a very large amount of output. We therefore increase the expect
4585 # buffer size to be able to contain the entire test output. This
4586 # is especially needed by gdb.base/info-macros.exp.
4588 # Also set this value for the currently running GDB.
4589 match_max [match_max -d]
4591 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4592 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4595 if [target_info exists gdb_prompt] {
4596 set gdb_prompt [target_info gdb_prompt]
4598 set gdb_prompt "\\(gdb\\)"
4601 if [info exists use_gdb_stub] {
4606 # Return a path using GDB_PARALLEL.
4607 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4608 # GDB_PARALLEL must be defined, the caller must check.
4610 # The default value for GDB_PARALLEL is, canonically, ".".
4611 # The catch is that tests don't expect an additional "./" in file paths so
4612 # omit any directory for the default case.
4613 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4614 # its special handling.
4616 proc make_gdb_parallel_path { args } {
4617 global GDB_PARALLEL objdir
4618 set joiner [list "file" "join" $objdir]
4619 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4620 lappend joiner $GDB_PARALLEL
4622 set joiner [concat $joiner $args]
4623 return [eval $joiner]
4626 # Turn BASENAME into a full file name in the standard output
4627 # directory. It is ok if BASENAME is the empty string; in this case
4628 # the directory is returned.
4630 proc standard_output_file {basename} {
4631 global objdir subdir gdb_test_file_name
4633 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4635 return [file join $dir $basename]
4638 # Return the name of a file in our standard temporary directory.
4640 proc standard_temp_file {basename} {
4641 # Since a particular runtest invocation is only executing a single test
4642 # file at any given time, we can use the runtest pid to build the
4643 # path of the temp directory.
4644 set dir [make_gdb_parallel_path temp [pid]]
4646 return [file join $dir $basename]
4649 # Set 'testfile', 'srcfile', and 'binfile'.
4651 # ARGS is a list of source file specifications.
4652 # Without any arguments, the .exp file's base name is used to
4653 # compute the source file name. The ".c" extension is added in this case.
4654 # If ARGS is not empty, each entry is a source file specification.
4655 # If the specification starts with a ".", it is treated as a suffix
4656 # to append to the .exp file's base name.
4657 # If the specification is the empty string, it is treated as if it
4659 # Otherwise it is a file name.
4660 # The first file in the list is used to set the 'srcfile' global.
4661 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4663 # Most tests should call this without arguments.
4665 # If a completely different binary file name is needed, then it
4666 # should be handled in the .exp file with a suitable comment.
4668 proc standard_testfile {args} {
4669 global gdb_test_file_name
4671 global gdb_test_file_last_vars
4674 global testfile binfile
4676 set testfile $gdb_test_file_name
4677 set binfile [standard_output_file ${testfile}]
4679 if {[llength $args] == 0} {
4683 # Unset our previous output variables.
4684 # This can help catch hidden bugs.
4685 if {[info exists gdb_test_file_last_vars]} {
4686 foreach varname $gdb_test_file_last_vars {
4688 catch {unset $varname}
4691 # 'executable' is often set by tests.
4692 set gdb_test_file_last_vars {executable}
4696 set varname srcfile$suffix
4699 # Handle an extension.
4702 } elseif {[string range $arg 0 0] == "."} {
4703 set arg $testfile$arg
4707 lappend gdb_test_file_last_vars $varname
4709 if {$suffix == ""} {
4717 # The default timeout used when testing GDB commands. We want to use
4718 # the same timeout as the default dejagnu timeout, unless the user has
4719 # already provided a specific value (probably through a site.exp file).
4720 global gdb_test_timeout
4721 if ![info exists gdb_test_timeout] {
4722 set gdb_test_timeout $timeout
4725 # A list of global variables that GDB testcases should not use.
4726 # We try to prevent their use by monitoring write accesses and raising
4727 # an error when that happens.
4728 set banned_variables { bug_id prms_id }
4730 # A list of procedures that GDB testcases should not use.
4731 # We try to prevent their use by monitoring invocations and raising
4732 # an error when that happens.
4733 set banned_procedures { strace }
4735 # gdb_init is called by runtest at start, but also by several
4736 # tests directly; gdb_finish is only called from within runtest after
4737 # each test source execution.
4738 # Placing several traces by repetitive calls to gdb_init leads
4739 # to problems, as only one trace is removed in gdb_finish.
4740 # To overcome this possible problem, we add a variable that records
4741 # if the banned variables and procedures are already traced.
4744 proc gdb_init { test_file_name } {
4745 # Reset the timeout value to the default. This way, any testcase
4746 # that changes the timeout value without resetting it cannot affect
4747 # the timeout used in subsequent testcases.
4748 global gdb_test_timeout
4750 set timeout $gdb_test_timeout
4752 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4753 && [target_info exists gdb_reverse_timeout] } {
4754 set timeout [target_info gdb_reverse_timeout]
4757 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4758 # debugging tool to help confirm that the test suite is
4759 # parallel-safe. You need "inotifywait" from the
4760 # inotify-tools package to use this.
4761 global GDB_INOTIFY inotify_pid
4762 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4763 global outdir tool inotify_log_file
4765 set exclusions {outputs temp gdb[.](log|sum) cache}
4766 set exclusion_re ([join $exclusions |])
4768 set inotify_log_file [standard_temp_file inotify.out]
4769 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4770 --exclude $exclusion_re \
4771 |& tee -a $outdir/$tool.log $inotify_log_file &]
4773 # Wait for the watches; hopefully this is long enough.
4776 # Clear the log so that we don't emit a warning the first time
4778 set fd [open $inotify_log_file w]
4782 # Block writes to all banned variables, and invocation of all
4783 # banned procedures...
4784 global banned_variables
4785 global banned_procedures
4786 global banned_traced
4787 if (!$banned_traced) {
4788 foreach banned_var $banned_variables {
4789 global "$banned_var"
4790 trace add variable "$banned_var" write error
4792 foreach banned_proc $banned_procedures {
4793 global "$banned_proc"
4794 trace add execution "$banned_proc" enter error
4799 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4800 # messages as expected.
4805 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4806 # the test results. Even if /dev/null doesn't exist on the particular
4807 # platform, the readline library will use the default setting just by
4808 # failing to open the file. OTOH, opening /dev/null successfully will
4809 # also result in the default settings being used since nothing will be
4810 # read from this file.
4811 setenv INPUTRC "/dev/null"
4813 # This disables style output, which would interfere with many
4817 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
4818 # during startup. See "man expect" for details about stty_init.
4820 set stty_init "rows 25 cols 80"
4822 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4823 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4824 # especially having color output turned on can cause tests to fail.
4825 setenv GREP_OPTIONS ""
4827 # Clear $gdbserver_reconnect_p.
4828 global gdbserver_reconnect_p
4829 set gdbserver_reconnect_p 1
4830 unset gdbserver_reconnect_p
4832 return [default_gdb_init $test_file_name]
4835 proc gdb_finish { } {
4836 global gdbserver_reconnect_p
4840 # Exit first, so that the files are no longer in use.
4843 if { [llength $cleanfiles] > 0 } {
4844 eval remote_file target delete $cleanfiles
4848 # Unblock write access to the banned variables. Dejagnu typically
4849 # resets some of them between testcases.
4850 global banned_variables
4851 global banned_procedures
4852 global banned_traced
4853 if ($banned_traced) {
4854 foreach banned_var $banned_variables {
4855 global "$banned_var"
4856 trace remove variable "$banned_var" write error
4858 foreach banned_proc $banned_procedures {
4859 global "$banned_proc"
4860 trace remove execution "$banned_proc" enter error
4867 set debug_format "unknown"
4869 # Run the gdb command "info source" and extract the debugging format
4870 # information from the output and save it in debug_format.
4872 proc get_debug_format { } {
4878 set debug_format "unknown"
4879 send_gdb "info source\n"
4881 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4882 set debug_format $expect_out(1,string)
4883 verbose "debug format is $debug_format"
4886 -re "No current source file.\r\n$gdb_prompt $" {
4887 perror "get_debug_format used when no current source file"
4890 -re "$gdb_prompt $" {
4891 warning "couldn't check debug format (no valid response)."
4895 warning "couldn't check debug format (timeout)."
4901 # Return true if FORMAT matches the debug format the current test was
4902 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4903 # `*', `[...]', and so on.
4905 # This function depends on variables set by `get_debug_format', above.
4907 proc test_debug_format {format} {
4910 return [expr [string match $format $debug_format] != 0]
4913 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4914 # COFF, stabs, etc). If that format matches the format that the
4915 # current test was compiled with, then the next test is expected to
4916 # fail for any target. Returns 1 if the next test or set of tests is
4917 # expected to fail, 0 otherwise (or if it is unknown). Must have
4918 # previously called get_debug_format.
4919 proc setup_xfail_format { format } {
4920 set ret [test_debug_format $format]
4928 # gdb_get_line_number TEXT [FILE]
4930 # Search the source file FILE, and return the line number of the
4931 # first line containing TEXT. If no match is found, an error is thrown.
4933 # TEXT is a string literal, not a regular expression.
4935 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4936 # specified, and does not start with "/", then it is assumed to be in
4937 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4938 # by changing the callers and the interface at the same time.
4939 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4940 # gdb.base/ena-dis-br.exp.
4942 # Use this function to keep your test scripts independent of the
4943 # exact line numbering of the source file. Don't write:
4945 # send_gdb "break 20"
4947 # This means that if anyone ever edits your test's source file,
4948 # your test could break. Instead, put a comment like this on the
4949 # source file line you want to break at:
4951 # /* breakpoint spot: frotz.exp: test name */
4953 # and then write, in your test script (which we assume is named
4956 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4958 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4961 # % puts "foo [lindex "bar baz" 1]"
4964 # Tcl is quite clever, for a little stringy language.)
4968 # The previous implementation of this procedure used the gdb search command.
4969 # This version is different:
4971 # . It works with MI, and it also works when gdb is not running.
4973 # . It operates on the build machine, not the host machine.
4975 # . For now, this implementation fakes a current directory of
4976 # $srcdir/$subdir to be compatible with the old implementation.
4977 # This will go away eventually and some callers will need to
4980 # . The TEXT argument is literal text and matches literally,
4981 # not a regular expression as it was before.
4983 # . State changes in gdb, such as changing the current file
4984 # and setting $_, no longer happen.
4986 # After a bit of time we can forget about the differences from the
4987 # old implementation.
4989 # --chastain 2004-08-05
4991 proc gdb_get_line_number { text { file "" } } {
4996 if { "$file" == "" } then {
4999 if { ! [regexp "^/" "$file"] } then {
5000 set file "$srcdir/$subdir/$file"
5003 if { [ catch { set fd [open "$file"] } message ] } then {
5008 for { set line 1 } { 1 } { incr line } {
5009 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5012 if { $nchar < 0 } then {
5015 if { [string first "$text" "$body"] >= 0 } then {
5021 if { [ catch { close "$fd" } message ] } then {
5026 error "undefined tag \"$text\""
5032 # Continue the program until it ends.
5034 # MSSG is the error message that gets printed. If not given, a
5036 # COMMAND is the command to invoke. If not given, "continue" is
5038 # ALLOW_EXTRA is a flag indicating whether the test should expect
5039 # extra output between the "Continuing." line and the program
5040 # exiting. By default it is zero; if nonzero, any extra output
5043 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5044 global inferior_exited_re use_gdb_stub
5047 set text "continue until exit"
5049 set text "continue until exit at $mssg"
5057 # By default, we don't rely on exit() behavior of remote stubs --
5058 # it's common for exit() to be implemented as a simple infinite
5059 # loop, or a forced crash/reset. For native targets, by default, we
5060 # assume process exit is reported as such. If a non-reliable target
5061 # is used, we set a breakpoint at exit, and continue to that.
5062 if { [target_info exists exit_is_reliable] } {
5063 set exit_is_reliable [target_info exit_is_reliable]
5065 set exit_is_reliable [expr ! $use_gdb_stub]
5068 if { ! $exit_is_reliable } {
5069 if {![gdb_breakpoint "exit"]} {
5072 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5075 # Continue until we exit. Should not stop again.
5076 # Don't bother to check the output of the program, that may be
5077 # extremely tough for some remote systems.
5079 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5084 proc rerun_to_main {} {
5085 global gdb_prompt use_gdb_stub
5090 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5091 {pass "rerun to main" ; return 0}
5092 -re "$gdb_prompt $"\
5093 {fail "rerun to main" ; return 0}
5094 timeout {fail "(timeout) rerun to main" ; return 0}
5099 -re "The program .* has been started already.*y or n. $" {
5103 -re "Starting program.*$gdb_prompt $"\
5104 {pass "rerun to main" ; return 0}
5105 -re "$gdb_prompt $"\
5106 {fail "rerun to main" ; return 0}
5107 timeout {fail "(timeout) rerun to main" ; return 0}
5112 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5114 proc exec_has_index_section { executable } {
5115 set readelf_program [gdb_find_readelf]
5116 set res [catch {exec $readelf_program -S $executable \
5117 | grep -E "\.gdb_index|\.debug_names" }]
5124 # Return true if a test should be skipped due to lack of floating
5125 # point support or GDB can't fetch the contents from floating point
5128 gdb_caching_proc gdb_skip_float_test {
5129 if [target_info exists gdb,skip_float_tests] {
5133 # There is an ARM kernel ptrace bug that hardware VFP registers
5134 # are not updated after GDB ptrace set VFP registers. The bug
5135 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5136 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5137 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5138 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5139 # This kernel bug is detected by check how does GDB change the
5140 # program result by changing one VFP register.
5141 if { [istarget "arm*-*-linux*"] } {
5143 set compile_flags {debug nowarnings }
5145 # Set up, compile, and execute a test program having VFP
5147 set src [standard_temp_file arm_vfp[pid].c]
5148 set exe [standard_temp_file arm_vfp[pid].x]
5150 gdb_produce_source $src {
5155 asm ("vldr d0, [%0]" : : "r" (&d));
5156 asm ("vldr d1, [%0]" : : "r" (&d));
5157 asm (".global break_here\n"
5159 asm ("vcmp.f64 d0, d1\n"
5160 "vmrs APSR_nzcv, fpscr\n"
5161 "bne L_value_different\n"
5164 "L_value_different:\n"
5166 "L_end:\n" : "=r" (ret) :);
5168 /* Return $d0 != $d1. */
5173 verbose "compiling testfile $src" 2
5174 set lines [gdb_compile $src $exe executable $compile_flags]
5177 if ![string match "" $lines] then {
5178 verbose "testfile compilation failed, returning 1" 2
5182 # No error message, compilation succeeded so now run it via gdb.
5183 # Run the test up to 5 times to detect whether ptrace can
5184 # correctly update VFP registers or not.
5186 for {set i 0} {$i < 5} {incr i} {
5187 global gdb_prompt srcdir subdir
5191 gdb_reinitialize_dir $srcdir/$subdir
5195 gdb_test "break *break_here"
5196 gdb_continue_to_breakpoint "break_here"
5198 # Modify $d0 to a different value, so the exit code should
5200 gdb_test "set \$d0 = 5.0"
5202 set test "continue to exit"
5203 gdb_test_multiple "continue" "$test" {
5204 -re "exited with code 01.*$gdb_prompt $" {
5206 -re "exited normally.*$gdb_prompt $" {
5207 # However, the exit code is 0. That means something
5208 # wrong in setting VFP registers.
5216 remote_file build delete $exe
5218 return $skip_vfp_test
5223 # Print a message and return true if a test should be skipped
5224 # due to lack of stdio support.
5226 proc gdb_skip_stdio_test { msg } {
5227 if [target_info exists gdb,noinferiorio] {
5228 verbose "Skipping test '$msg': no inferior i/o."
5234 proc gdb_skip_bogus_test { msg } {
5238 # Return true if a test should be skipped due to lack of XML support
5240 # NOTE: This must be called while gdb is *not* running.
5242 gdb_caching_proc gdb_skip_xml_test {
5247 if { [info exists gdb_spawn_id] } {
5248 error "GDB must not be running in gdb_skip_xml_tests."
5251 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5255 gdb_test_multiple "set tdesc filename $xml_file" "" {
5256 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5259 -re ".*$gdb_prompt $" { }
5265 # Return true if argv[0] is available.
5267 gdb_caching_proc gdb_has_argv0 {
5270 # Compile and execute a test program to check whether argv[0] is available.
5271 gdb_simple_compile has_argv0 {
5272 int main (int argc, char **argv) {
5279 proc gdb_has_argv0_1 { exe } {
5280 global srcdir subdir
5281 global gdb_prompt hex
5285 gdb_reinitialize_dir $srcdir/$subdir
5288 # Set breakpoint on main.
5289 gdb_test_multiple "break main" "break main" {
5290 -re "Breakpoint.*${gdb_prompt} $" {
5292 -re "${gdb_prompt} $" {
5299 gdb_test_multiple "" "run to main" {
5300 -re "Breakpoint.*${gdb_prompt} $" {
5302 -re "${gdb_prompt} $" {
5307 set old_elements "200"
5308 set test "show print elements"
5309 gdb_test_multiple $test $test {
5310 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5311 set old_elements $expect_out(1,string)
5314 set old_repeats "200"
5315 set test "show print repeats"
5316 gdb_test_multiple $test $test {
5317 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5318 set old_repeats $expect_out(1,string)
5321 gdb_test_no_output "set print elements unlimited" ""
5322 gdb_test_no_output "set print repeats unlimited" ""
5325 # Check whether argc is 1.
5326 gdb_test_multiple "p argc" "p argc" {
5327 -re " = 1\r\n${gdb_prompt} $" {
5329 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5330 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5333 -re "${gdb_prompt} $" {
5337 -re "${gdb_prompt} $" {
5341 gdb_test_no_output "set print elements $old_elements" ""
5342 gdb_test_no_output "set print repeats $old_repeats" ""
5347 set result [gdb_has_argv0_1 $obj]
5353 && ([istarget *-*-linux*]
5354 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5355 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5356 || [istarget *-*-openbsd*]
5357 || [istarget *-*-darwin*]
5358 || [istarget *-*-solaris*]
5359 || [istarget *-*-aix*]
5360 || [istarget *-*-gnu*]
5361 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5362 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5363 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5364 || [istarget *-*-symbianelf*]
5365 || [istarget *-*-osf*]
5366 || [istarget *-*-dicos*]
5367 || [istarget *-*-nto*]
5368 || [istarget *-*-*vms*]
5369 || [istarget *-*-lynx*178]) } {
5370 fail "argv\[0\] should be available on this target"
5376 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5377 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5378 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5379 # the name of a debuginfo only file. This file will be stored in the same
5382 # Functions for separate debug info testing
5384 # starting with an executable:
5385 # foo --> original executable
5387 # at the end of the process we have:
5388 # foo.stripped --> foo w/o debug info
5389 # foo.debug --> foo's debug info
5390 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5392 # Fetch the build id from the file.
5393 # Returns "" if there is none.
5395 proc get_build_id { filename } {
5396 if { ([istarget "*-*-mingw*"]
5397 || [istarget *-*-cygwin*]) } {
5398 set objdump_program [gdb_find_objdump]
5399 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5400 verbose "result is $result"
5401 verbose "output is $output"
5407 set tmp [standard_output_file "${filename}-tmp"]
5408 set objcopy_program [gdb_find_objcopy]
5409 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5410 verbose "result is $result"
5411 verbose "output is $output"
5416 fconfigure $fi -translation binary
5417 # Skip the NOTE header.
5422 if ![string compare $data ""] then {
5425 # Convert it to hex.
5426 binary scan $data H* data
5431 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5432 # converted to the form: .build-id/ab/cdef1234...89.debug
5433 # Return "" if no build-id found.
5434 proc build_id_debug_filename_get { filename } {
5435 set data [get_build_id $filename]
5436 if { $data == "" } {
5439 regsub {^..} $data {\0/} data
5440 return ".build-id/${data}.debug"
5443 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5444 # list of optional flags. The only currently supported flag is no-main,
5445 # which removes the symbol entry for main from the separate debug file.
5447 # Function returns zero on success. Function will return non-zero failure code
5448 # on some targets not supporting separate debug info (such as i386-msdos).
5450 proc gdb_gnu_strip_debug { dest args } {
5452 # Use the first separate debug info file location searched by GDB so the
5453 # run cannot be broken by some stale file searched with higher precedence.
5454 set debug_file "${dest}.debug"
5456 set strip_to_file_program [transform strip]
5457 set objcopy_program [gdb_find_objcopy]
5459 set debug_link [file tail $debug_file]
5460 set stripped_file "${dest}.stripped"
5462 # Get rid of the debug info, and store result in stripped_file
5463 # something like gdb/testsuite/gdb.base/blah.stripped.
5464 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5465 verbose "result is $result"
5466 verbose "output is $output"
5471 # Workaround PR binutils/10802:
5472 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5473 set perm [file attributes ${dest} -permissions]
5474 file attributes ${stripped_file} -permissions $perm
5476 # Get rid of everything but the debug info, and store result in debug_file
5477 # This will be in the .debug subdirectory, see above.
5478 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5479 verbose "result is $result"
5480 verbose "output is $output"
5485 # If no-main is passed, strip the symbol for main from the separate
5486 # file. This is to simulate the behavior of elfutils's eu-strip, which
5487 # leaves the symtab in the original file only. There's no way to get
5488 # objcopy or strip to remove the symbol table without also removing the
5489 # debugging sections, so this is as close as we can get.
5490 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5491 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5492 verbose "result is $result"
5493 verbose "output is $output"
5497 file delete "${debug_file}"
5498 file rename "${debug_file}-tmp" "${debug_file}"
5501 # Link the two previous output files together, adding the .gnu_debuglink
5502 # section to the stripped_file, containing a pointer to the debug_file,
5503 # save the new file in dest.
5504 # This will be the regular executable filename, in the usual location.
5505 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5506 verbose "result is $result"
5507 verbose "output is $output"
5512 # Workaround PR binutils/10802:
5513 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5514 set perm [file attributes ${stripped_file} -permissions]
5515 file attributes ${dest} -permissions $perm
5520 # Test the output of GDB_COMMAND matches the pattern obtained
5521 # by concatenating all elements of EXPECTED_LINES. This makes
5522 # it possible to split otherwise very long string into pieces.
5523 # If third argument is not empty, it's used as the name of the
5524 # test to be printed on pass/fail.
5525 proc help_test_raw { gdb_command expected_lines args } {
5526 set message $gdb_command
5527 if [llength $args]>0 then {
5528 set message [lindex $args 0]
5530 set expected_output [join $expected_lines ""]
5531 gdb_test "${gdb_command}" "${expected_output}" $message
5534 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5535 # are regular expressions that should match the beginning of output,
5536 # before the list of commands in that class. The presence of
5537 # command list and standard epilogue will be tested automatically.
5538 # Notice that the '[' and ']' characters don't need to be escaped for strings
5539 # wrapped in {} braces.
5540 proc test_class_help { command_class expected_initial_lines args } {
5542 "List of commands\:.*[\r\n]+"
5543 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5544 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5545 "Command name abbreviations are allowed if unambiguous\."
5547 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5549 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5552 # COMMAND_LIST should have either one element -- command to test, or
5553 # two elements -- abbreviated command to test, and full command the first
5554 # element is abbreviation of.
5555 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5556 # are regular expressions that should match the beginning of output,
5557 # before the list of subcommands. The presence of
5558 # subcommand list and standard epilogue will be tested automatically.
5559 proc test_prefix_command_help { command_list expected_initial_lines args } {
5560 set command [lindex $command_list 0]
5561 if {[llength $command_list]>1} {
5562 set full_command [lindex $command_list 1]
5564 set full_command $command
5566 # Use 'list' and not just {} because we want variables to
5567 # be expanded in this list.
5568 set l_stock_body [list\
5569 "List of $full_command subcommands\:.*\[\r\n\]+"\
5570 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5571 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5572 "Command name abbreviations are allowed if unambiguous\."]
5573 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5574 if {[llength $args]>0} {
5575 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5577 help_test_raw "help ${command}" $l_entire_body
5581 # Build executable named EXECUTABLE from specifications that allow
5582 # different options to be passed to different sub-compilations.
5583 # TESTNAME is the name of the test; this is passed to 'untested' if
5585 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5586 # contains the option "pthreads", then gdb_compile_pthreads is used.
5587 # ARGS is a flat list of source specifications, of the form:
5588 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5589 # Each SOURCE is compiled to an object file using its OPTIONS,
5590 # using gdb_compile.
5591 # Returns 0 on success, -1 on failure.
5592 proc build_executable_from_specs {testname executable options args} {
5596 set binfile [standard_output_file $executable]
5599 if { [lsearch -exact $options "c++"] >= 0 } {
5600 set info_options "c++"
5602 if [get_compiler_info ${info_options}] {
5606 set func gdb_compile
5607 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5608 if {$func_index != -1} {
5609 set func "${func}_[lindex $options $func_index]"
5612 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5613 # parameter. They also requires $sources while gdb_compile and
5614 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5615 if [string match gdb_compile_shlib* $func] {
5617 foreach {s local_options} $args {
5618 if { [regexp "^/" "$s"] } then {
5619 lappend sources_path "$s"
5621 lappend sources_path "$srcdir/$subdir/$s"
5624 set ret [$func $sources_path "${binfile}" $options]
5625 } elseif {[lsearch -exact $options rust] != -1} {
5627 foreach {s local_options} $args {
5628 if { [regexp "^/" "$s"] } then {
5629 lappend sources_path "$s"
5631 lappend sources_path "$srcdir/$subdir/$s"
5634 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5638 foreach {s local_options} $args {
5639 if { ! [regexp "^/" "$s"] } then {
5640 set s "$srcdir/$subdir/$s"
5642 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5646 lappend objects "${binfile}${i}.o"
5649 set ret [$func $objects "${binfile}" executable $options]
5659 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5660 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5661 # to pass to untested, if something is wrong. OPTIONS are passed
5662 # to gdb_compile directly.
5663 proc build_executable { testname executable {sources ""} {options {debug}} } {
5664 if {[llength $sources]==0} {
5665 set sources ${executable}.c
5668 set arglist [list $testname $executable $options]
5669 foreach source $sources {
5670 lappend arglist $source $options
5673 return [eval build_executable_from_specs $arglist]
5676 # Starts fresh GDB binary and loads an optional executable into GDB.
5677 # Usage: clean_restart [executable]
5678 # EXECUTABLE is the basename of the binary.
5680 proc clean_restart { args } {
5684 if { [llength $args] > 1 } {
5685 error "bad number of args: [llength $args]"
5690 gdb_reinitialize_dir $srcdir/$subdir
5692 if { [llength $args] >= 1 } {
5693 set executable [lindex $args 0]
5694 set binfile [standard_output_file ${executable}]
5699 # Prepares for testing by calling build_executable_full, then
5701 # TESTNAME is the name of the test.
5702 # Each element in ARGS is a list of the form
5703 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5704 # These are passed to build_executable_from_specs, which see.
5705 # The last EXECUTABLE is passed to clean_restart.
5706 # Returns 0 on success, non-zero on failure.
5707 proc prepare_for_testing_full {testname args} {
5708 foreach spec $args {
5709 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5712 set executable [lindex $spec 0]
5714 clean_restart $executable
5718 # Prepares for testing, by calling build_executable, and then clean_restart.
5719 # Please refer to build_executable for parameter description.
5720 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5722 if {[build_executable $testname $executable $sources $options] == -1} {
5725 clean_restart $executable
5730 # Retrieve the value of EXP in the inferior, represented in format
5731 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5732 # print fails. TEST is the test message to use. It can be omitted,
5733 # in which case a test message is built from EXP.
5735 proc get_valueof { fmt exp default {test ""} } {
5739 set test "get valueof \"${exp}\""
5743 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5744 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5745 set val $expect_out(1,string)
5749 fail "$test (timeout)"
5755 # Retrieve the value of EXP in the inferior, as a signed decimal value
5756 # (using "print /d"). DEFAULT is used as fallback if print fails.
5757 # TEST is the test message to use. It can be omitted, in which case
5758 # a test message is built from EXP.
5760 proc get_integer_valueof { exp default {test ""} } {
5764 set test "get integer valueof \"${exp}\""
5768 gdb_test_multiple "print /d ${exp}" "$test" {
5769 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5770 set val $expect_out(1,string)
5774 fail "$test (timeout)"
5780 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5781 # (using "print /x"). DEFAULT is used as fallback if print fails.
5782 # TEST is the test message to use. It can be omitted, in which case
5783 # a test message is built from EXP.
5785 proc get_hexadecimal_valueof { exp default {test ""} } {
5789 set test "get hexadecimal valueof \"${exp}\""
5793 gdb_test_multiple "print /x ${exp}" $test {
5794 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5795 set val $expect_out(1,string)
5802 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5803 # is used as fallback if print fails. TEST is the test message to use.
5804 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5806 proc get_sizeof { type default {test ""} } {
5807 return [get_integer_valueof "sizeof (${type})" $default $test]
5810 proc get_target_charset { } {
5813 gdb_test_multiple "show target-charset" "" {
5814 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5815 return $expect_out(1,string)
5817 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5818 return $expect_out(1,string)
5822 # Pick a reasonable default.
5823 warning "Unable to read target-charset."
5827 # Get the address of VAR.
5829 proc get_var_address { var } {
5830 global gdb_prompt hex
5832 # Match output like:
5834 # $5 = (int (*)()) 0
5835 # $6 = (int (*)()) 0x24 <function_bar>
5837 gdb_test_multiple "print &${var}" "get address of ${var}" {
5838 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5840 pass "get address of ${var}"
5841 if { $expect_out(1,string) == "0" } {
5844 return $expect_out(1,string)
5851 # Return the frame number for the currently selected frame
5852 proc get_current_frame_number {{test_name ""}} {
5855 if { $test_name == "" } {
5856 set test_name "get current frame number"
5859 gdb_test_multiple "frame" $test_name {
5860 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5861 set frame_num $expect_out(1,string)
5867 # Get the current value for remotetimeout and return it.
5868 proc get_remotetimeout { } {
5872 gdb_test_multiple "show remotetimeout" "" {
5873 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5874 return $expect_out(1,string)
5878 # Pick the default that gdb uses
5879 warning "Unable to read remotetimeout"
5883 # Set the remotetimeout to the specified timeout. Nothing is returned.
5884 proc set_remotetimeout { timeout } {
5887 gdb_test_multiple "set remotetimeout $timeout" "" {
5888 -re "$gdb_prompt $" {
5889 verbose "Set remotetimeout to $timeout\n"
5894 # Get the target's current endianness and return it.
5895 proc get_endianness { } {
5898 gdb_test_multiple "show endian" "determine endianness" {
5899 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5901 return $expect_out(1,string)
5907 # ROOT and FULL are file names. Returns the relative path from ROOT
5908 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5909 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5912 proc relative_filename {root full} {
5913 set root_split [file split $root]
5914 set full_split [file split $full]
5916 set len [llength $root_split]
5918 if {[eval file join $root_split]
5919 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5920 error "$full not a subdir of $root"
5923 return [eval file join [lrange $full_split $len end]]
5926 # Log gdb command line and script if requested.
5927 if {[info exists TRANSCRIPT]} {
5928 rename send_gdb real_send_gdb
5929 rename remote_spawn real_remote_spawn
5930 rename remote_close real_remote_close
5932 global gdb_transcript
5933 set gdb_transcript ""
5935 global gdb_trans_count
5936 set gdb_trans_count 1
5938 proc remote_spawn {args} {
5939 global gdb_transcript gdb_trans_count outdir
5941 if {$gdb_transcript != ""} {
5942 close $gdb_transcript
5944 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5945 puts $gdb_transcript [lindex $args 1]
5946 incr gdb_trans_count
5948 return [uplevel real_remote_spawn $args]
5951 proc remote_close {args} {
5952 global gdb_transcript
5954 if {$gdb_transcript != ""} {
5955 close $gdb_transcript
5956 set gdb_transcript ""
5959 return [uplevel real_remote_close $args]
5962 proc send_gdb {args} {
5963 global gdb_transcript
5965 if {$gdb_transcript != ""} {
5966 puts -nonewline $gdb_transcript [lindex $args 0]
5969 return [uplevel real_send_gdb $args]
5973 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5974 if {[info exists GDB_PARALLEL]} {
5975 if {[is_remote host]} {
5979 [make_gdb_parallel_path outputs] \
5980 [make_gdb_parallel_path temp] \
5981 [make_gdb_parallel_path cache]
5985 proc core_find {binfile {deletefiles {}} {arg ""}} {
5986 global objdir subdir
5988 set destcore "$binfile.core"
5989 file delete $destcore
5991 # Create a core file named "$destcore" rather than just "core", to
5992 # avoid problems with sys admin types that like to regularly prune all
5993 # files named "core" from the system.
5995 # Arbitrarily try setting the core size limit to "unlimited" since
5996 # this does not hurt on systems where the command does not work and
5997 # allows us to generate a core on systems where it does.
5999 # Some systems append "core" to the name of the program; others append
6000 # the name of the program to "core"; still others (like Linux, as of
6001 # May 2003) create cores named "core.PID". In the latter case, we
6002 # could have many core files lying around, and it may be difficult to
6003 # tell which one is ours, so let's run the program in a subdirectory.
6005 set coredir [standard_output_file coredir.[getpid]]
6007 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6008 # remote_exec host "${binfile}"
6009 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6010 if [remote_file build exists $i] {
6011 remote_exec build "mv $i $destcore"
6015 # Check for "core.PID".
6016 if { $found == 0 } {
6017 set names [glob -nocomplain -directory $coredir core.*]
6018 if {[llength $names] == 1} {
6019 set corefile [file join $coredir [lindex $names 0]]
6020 remote_exec build "mv $corefile $destcore"
6024 if { $found == 0 } {
6025 # The braindamaged HPUX shell quits after the ulimit -c above
6026 # without executing ${binfile}. So we try again without the
6027 # ulimit here if we didn't find a core file above.
6028 # Oh, I should mention that any "braindamaged" non-Unix system has
6029 # the same problem. I like the cd bit too, it's really neat'n stuff.
6030 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6031 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6032 if [remote_file build exists $i] {
6033 remote_exec build "mv $i $destcore"
6039 # Try to clean up after ourselves.
6040 foreach deletefile $deletefiles {
6041 remote_file build delete [file join $coredir $deletefile]
6043 remote_exec build "rmdir $coredir"
6045 if { $found == 0 } {
6046 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6052 # gdb_target_symbol_prefix compiles a test program and then examines
6053 # the output from objdump to determine the prefix (such as underscore)
6054 # for linker symbol prefixes.
6056 gdb_caching_proc gdb_target_symbol_prefix {
6057 # Compile a simple test program...
6058 set src { int main() { return 0; } }
6059 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6065 set objdump_program [gdb_find_objdump]
6066 set result [catch "exec $objdump_program --syms $obj" output]
6069 && ![regexp -lineanchor \
6070 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6071 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6079 # Return 1 if target supports scheduler locking, otherwise return 0.
6081 gdb_caching_proc target_supports_scheduler_locking {
6084 set me "gdb_target_supports_scheduler_locking"
6086 set src { int main() { return 0; } }
6087 if {![gdb_simple_compile $me $src executable]} {
6096 set supports_schedule_locking -1
6097 set current_schedule_locking_mode ""
6099 set test "reading current scheduler-locking mode"
6100 gdb_test_multiple "show scheduler-locking" $test {
6101 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6102 set current_schedule_locking_mode $expect_out(1,string)
6104 -re "$gdb_prompt $" {
6105 set supports_schedule_locking 0
6108 set supports_schedule_locking 0
6112 if { $supports_schedule_locking == -1 } {
6113 set test "checking for scheduler-locking support"
6114 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6115 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6116 set supports_schedule_locking 0
6118 -re "$gdb_prompt $" {
6119 set supports_schedule_locking 1
6122 set supports_schedule_locking 0
6127 if { $supports_schedule_locking == -1 } {
6128 set supports_schedule_locking 0
6132 remote_file build delete $obj
6133 verbose "$me: returning $supports_schedule_locking" 2
6134 return $supports_schedule_locking
6137 # gdb_target_symbol returns the provided symbol with the correct prefix
6138 # prepended. (See gdb_target_symbol_prefix, above.)
6140 proc gdb_target_symbol { symbol } {
6141 set prefix [gdb_target_symbol_prefix]
6142 return "${prefix}${symbol}"
6145 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6146 # added to gdb_compile options to define the C-preprocessor macro
6147 # SYMBOL_PREFIX with a value that can be prepended to symbols
6148 # for targets which require a prefix, such as underscore.
6150 # This version (_asm) defines the prefix without double quotes
6151 # surrounding the prefix. It is used to define the macro
6152 # SYMBOL_PREFIX for assembly language files. Another version, below,
6153 # is used for symbols in inline assembler in C/C++ files.
6155 # The lack of quotes in this version (_asm) makes it possible to
6156 # define supporting macros in the .S file. (The version which
6157 # uses quotes for the prefix won't work for such files since it's
6158 # impossible to define a quote-stripping macro in C.)
6160 # It's possible to use this version (_asm) for C/C++ source files too,
6161 # but a string is usually required in such files; providing a version
6162 # (no _asm) which encloses the prefix with double quotes makes it
6163 # somewhat easier to define the supporting macros in the test case.
6165 proc gdb_target_symbol_prefix_flags_asm {} {
6166 set prefix [gdb_target_symbol_prefix]
6167 if {$prefix ne ""} {
6168 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6174 # gdb_target_symbol_prefix_flags returns the same string as
6175 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6176 # enclosed in double quotes if there is a prefix.
6178 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6179 # extended discussion.
6181 proc gdb_target_symbol_prefix_flags {} {
6182 set prefix [gdb_target_symbol_prefix]
6183 if {$prefix ne ""} {
6184 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6190 # A wrapper for 'remote_exec host' that passes or fails a test.
6191 # Returns 0 if all went well, nonzero on failure.
6192 # TEST is the name of the test, other arguments are as for remote_exec.
6194 proc run_on_host { test program args } {
6195 verbose -log "run_on_host: $program $args"
6196 # remote_exec doesn't work properly if the output is set but the
6197 # input is the empty string -- so replace an empty input with
6199 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6200 set args [lreplace $args 1 1 "/dev/null"]
6202 set result [eval remote_exec host [list $program] $args]
6203 verbose "result is $result"
6204 set status [lindex $result 0]
6205 set output [lindex $result 1]
6210 verbose -log "run_on_host failed: $output"
6216 # Return non-zero if "board_info debug_flags" mentions Fission.
6217 # http://gcc.gnu.org/wiki/DebugFission
6218 # Fission doesn't support everything yet.
6219 # This supports working around bug 15954.
6221 proc using_fission { } {
6222 set debug_flags [board_info [target_info name] debug_flags]
6223 return [regexp -- "-gsplit-dwarf" $debug_flags]
6226 # Search the caller's ARGS list and set variables according to the list of
6227 # valid options described by ARGSET.
6229 # The first member of each one- or two-element list in ARGSET defines the
6230 # name of a variable that will be added to the caller's scope.
6232 # If only one element is given to describe an option, it the value is
6233 # 0 if the option is not present in (the caller's) ARGS or 1 if
6236 # If two elements are given, the second element is the default value of
6237 # the variable. This is then overwritten if the option exists in ARGS.
6239 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6240 # any optional components.
6243 # proc myproc {foo args} {
6244 # parse_args {{bar} {baz "abc"} {qux}}
6247 # myproc ABC -bar -baz DEF peanut butter
6248 # will define the following variables in myproc:
6249 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6250 # args will be the list {peanut butter}
6252 proc parse_args { argset } {
6255 foreach argument $argset {
6256 if {[llength $argument] == 1} {
6257 # No default specified, so we assume that we should set
6258 # the value to 1 if the arg is present and 0 if it's not.
6259 # It is assumed that no value is given with the argument.
6260 set result [lsearch -exact $args "-$argument"]
6261 if {$result != -1} then {
6262 uplevel 1 [list set $argument 1]
6263 set args [lreplace $args $result $result]
6265 uplevel 1 [list set $argument 0]
6267 } elseif {[llength $argument] == 2} {
6268 # There are two items in the argument. The second is a
6269 # default value to use if the item is not present.
6270 # Otherwise, the variable is set to whatever is provided
6271 # after the item in the args.
6272 set arg [lindex $argument 0]
6273 set result [lsearch -exact $args "-[lindex $arg 0]"]
6274 if {$result != -1} then {
6275 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6276 set args [lreplace $args $result [expr $result+1]]
6278 uplevel 1 [list set $arg [lindex $argument 1]]
6281 error "Badly formatted argument \"$argument\" in argument set"
6285 # The remaining args should be checked to see that they match the
6286 # number of items expected to be passed into the procedure...
6289 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6290 # return that string.
6292 proc capture_command_output { command prefix } {
6296 set output_string ""
6297 gdb_test_multiple "$command" "capture_command_output for $command" {
6298 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6299 set output_string $expect_out(1,string)
6302 return $output_string
6305 # A convenience function that joins all the arguments together, with a
6306 # regexp that matches exactly one end of line in between each argument.
6307 # This function is ideal to write the expected output of a GDB command
6308 # that generates more than a couple of lines, as this allows us to write
6309 # each line as a separate string, which is easier to read by a human
6312 proc multi_line { args } {
6313 return [join $args "\r\n"]
6316 # Similar to the above, but while multi_line is meant to be used to
6317 # match GDB output, this one is meant to be used to build strings to
6318 # send as GDB input.
6320 proc multi_line_input { args } {
6321 return [join $args "\n"]
6324 # Return the version of the DejaGnu framework.
6326 # The return value is a list containing the major, minor and patch version
6327 # numbers. If the version does not contain a minor or patch number, they will
6328 # be set to 0. For example:
6334 proc dejagnu_version { } {
6335 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6336 global frame_version
6338 verbose -log "DejaGnu version: $frame_version"
6339 verbose -log "Expect version: [exp_version]"
6340 verbose -log "Tcl version: [info tclversion]"
6342 set dg_ver [split $frame_version .]
6344 while { [llength $dg_ver] < 3 } {
6351 # Define user-defined command COMMAND using the COMMAND_LIST as the
6352 # command's definition. The terminating "end" is added automatically.
6354 proc gdb_define_cmd {command command_list} {
6357 set input [multi_line_input {*}$command_list "end"]
6358 set test "define $command"
6360 gdb_test_multiple "define $command" $test {
6362 gdb_test_multiple $input $test {
6363 -re "\r\n$gdb_prompt " {
6370 # Override the 'cd' builtin with a version that ensures that the
6371 # log file keeps pointing at the same file. We need this because
6372 # unfortunately the path to the log file is recorded using an
6373 # relative path name, and, we sometimes need to close/reopen the log
6374 # after changing the current directory. See get_compiler_info.
6376 rename cd builtin_cd
6380 # Get the existing log file flags.
6381 set log_file_info [log_file -info]
6383 # Split the flags into args and file name.
6384 set log_file_flags ""
6385 set log_file_file ""
6386 foreach arg [ split "$log_file_info" " "] {
6387 if [string match "-*" $arg] {
6388 lappend log_file_flags $arg
6390 lappend log_file_file $arg
6394 # If there was an existing file, ensure it is an absolute path, and then
6396 if { $log_file_file != "" } {
6397 set log_file_file [file normalize $log_file_file]
6399 log_file $log_file_flags "$log_file_file"
6402 # Call the builtin version of cd.
6406 # Return a list of all languages supported by GDB, suitable for use in
6407 # 'set language NAME'. This doesn't include either the 'local' or
6409 proc gdb_supported_languages {} {
6410 return [list c objective-c c++ d go fortran modula-2 asm pascal \
6411 opencl rust minimal ada]
6414 # Check if debugging is enabled for gdb.
6416 proc gdb_debug_enabled { } {
6419 # If not already read, get the debug setting from environment or board setting.
6420 if {![info exists gdbdebug]} {
6422 if [info exists env(GDB_DEBUG)] {
6423 set gdbdebug $env(GDB_DEBUG)
6424 } elseif [target_info exists gdb,debug] {
6425 set gdbdebug [target_info gdb,debug]
6431 # Ensure it not empty.
6432 return [expr { $gdbdebug != "" }]
6435 # Turn on debugging if enabled, or reset if already on.
6437 proc gdb_debug_init { } {
6441 if ![gdb_debug_enabled] {
6445 # First ensure logging is off.
6446 send_gdb "set logging off\n"
6448 set debugfile [standard_output_file gdb.debug]
6449 send_gdb "set logging file $debugfile\n"
6451 send_gdb "set logging debugredirect\n"
6454 foreach entry [split $gdbdebug ,] {
6455 send_gdb "set debug $entry 1\n"
6458 # Now that everything is set, enable logging.
6459 send_gdb "set logging on\n"
6461 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
6462 timeout { warning "Couldn't set logging file" }
6466 # Check if debugging is enabled for gdbserver.
6468 proc gdbserver_debug_enabled { } {
6469 # Always disabled for GDB only setups.
6473 # Always load compatibility stuff.