1 # Copyright 1992-2019 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
89 # absolute path ie. /foo/
90 set fullname_syntax_POSIX {/[^\n]*/}
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
92 # UNC path ie. \\D\foo\
93 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
96 # ie. \foo\, but don't match \\.*\
97 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
99 # ie. a:\foo\ && a:foo\
100 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
103 # d:foo and \abc should be considered valid as an absolute path.
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
112 if ![info exists env(EXEEXT)] {
115 set EXEEXT $env(EXEEXT)
120 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
122 # A regular expression that matches a value history number.
124 set valnum_re "\\\$$decimal"
126 ### Only procedures should come after this point.
129 # gdb_version -- extract and print the version number of GDB
131 proc default_gdb_version {} {
133 global INTERNAL_GDBFLAGS GDBFLAGS
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
144 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
145 if ![is_remote host] {
146 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
148 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
152 proc gdb_version { } {
153 return [default_gdb_version]
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
170 send_gdb "y\n" answer
173 -re "Discard symbol table from .*y or n.*$" {
174 send_gdb "y\n" answer
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
204 send_gdb "y\n" answer
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # The second pattern below matches up to the first newline *only*.
246 # Using ``.*$'' could swallow up output that we attempt to match
249 # N.B. This function does not wait for gdb to return to the prompt,
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
256 send_gdb "$command\n"
258 -re "$gdb_prompt $" { }
260 perror "gdb_init_command for target failed"
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
271 send_gdb "continue\n"
273 -re "Continu\[^\r\n\]*\[\r\n\]" {}
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
284 send_gdb "jump *$start\n"
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
290 if [expr $start_attempt > 3] {
291 perror "Jump to start() failed (retry count exceeded)"
294 set start_attempt [expr $start_attempt + 1]
296 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
299 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
300 perror "Can't find start symbol to run in gdb_run"
303 -re "No symbol \"start\" in current.*$gdb_prompt $" {
304 send_gdb "jump *_start\n"
306 -re "No symbol.*context.*$gdb_prompt $" {
309 -re "Line.* Jump anyway.*y or n. $" {
310 send_gdb "y\n" answer
312 -re "The program is not being run.*$gdb_prompt $" {
313 if { [gdb_reload] != 0 } {
316 send_gdb "jump *$start\n"
319 perror "Jump to start() failed (timeout)"
327 if [target_info exists gdb,do_reload_on_run] {
328 if { [gdb_reload] != 0 } {
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
337 -re "The program .* has been started already.*y or n. $" {
338 send_gdb "y\n" answer
341 -notransfer -re "Starting program: \[^\r\n\]*" {}
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
348 # Generic start command. Return 0 if we could start the program, -1
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
354 proc gdb_start_cmd {args} {
355 global gdb_prompt use_gdb_stub
357 foreach command [gdb_init_commands] {
358 send_gdb "$command\n"
360 -re "$gdb_prompt $" { }
362 perror "gdb_init_command for target failed"
372 send_gdb "start $args\n"
373 # Use -notransfer here so that test cases (like chng-sym.exp)
374 # may test for additional start-up messages.
376 -re "The program .* has been started already.*y or n. $" {
377 send_gdb "y\n" answer
380 -notransfer -re "Starting program: \[^\r\n\]*" {
387 # Generic starti command. Return 0 if we could start the program, -1
390 # N.B. This function does not wait for gdb to return to the prompt,
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
397 send_gdb "$command\n"
399 -re "$gdb_prompt $" { }
401 perror "gdb_init_command for target failed"
411 send_gdb "starti $args\n"
413 -re "The program .* has been started already.*y or n. $" {
414 send_gdb "y\n" answer
417 -re "Starting program: \[^\r\n\]*" {
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
429 # Note: The handling of message vs no-message is messed up, but it's based
430 # on historical usage. By default this function does not print passes,
432 # no-message: turns off printing of fails (and passes, but they're already off)
433 # message: turns on printing of passes (and fails, but they're already on)
435 proc gdb_breakpoint { function args } {
439 set pending_response n
440 if {[lsearch -exact $args allow-pending] != -1} {
441 set pending_response y
444 set break_command "break"
445 set break_message "Breakpoint"
446 if {[lsearch -exact $args temporary] != -1} {
447 set break_command "tbreak"
448 set break_message "Temporary breakpoint"
451 if {[lsearch -exact $args qualified] != -1} {
452 append break_command " -qualified"
457 set no_message_loc [lsearch -exact $args no-message]
458 set message_loc [lsearch -exact $args message]
459 # The last one to appear in args wins.
460 if { $no_message_loc > $message_loc } {
462 } elseif { $message_loc > $no_message_loc } {
466 set test_name "setting breakpoint at $function"
468 send_gdb "$break_command $function\n"
469 # The first two regexps are what we get with -g, the third is without -g.
471 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
474 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
475 if {$pending_response == "n"} {
482 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
483 send_gdb "$pending_response\n"
486 -re "A problem internal to GDB has been detected" {
488 fail "$test_name (GDB internal error)"
490 gdb_internal_error_resync
493 -re "$gdb_prompt $" {
501 fail "$test_name (eof)"
507 fail "$test_name (timeout)"
518 # Set breakpoint at function and run gdb until it breaks there.
519 # Since this is the only breakpoint that will be set, if it stops
520 # at a breakpoint, we will assume it is the one we want. We can't
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
529 # no-message: turns off printing of fails (and passes, but they're already off)
530 # message: turns on printing of passes (and fails, but they're already on)
532 proc runto { function args } {
538 # Default to "no-message".
539 set args "no-message $args"
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
548 } elseif { $message_loc > $no_message_loc } {
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
557 # elements, and we don't want Tcl to move the remaining elements after
558 # the first to $args. That is why $function is wrapped in {}.
559 if ![eval gdb_breakpoint {$function} $args] {
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
568 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
574 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
580 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
582 unsupported "non-stop mode not supported"
586 -re ".*A problem internal to GDB has been detected" {
588 fail "$test_name (GDB internal error)"
590 gdb_internal_error_resync
593 -re "$gdb_prompt $" {
601 fail "$test_name (eof)"
607 fail "$test_name (timeout)"
618 # Ask gdb to run until we hit a breakpoint at main.
620 # N.B. This function deletes all existing breakpoints.
621 # If you don't want that, use gdb_start_cmd.
623 proc runto_main { } {
624 return [runto main no-message]
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
634 set full_name "continue to breakpoint: $name"
636 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\\) $" {
676 send_gdb "n\n" answer
679 -re "Create a core file of GDB\\? \\(y or n\\) $" {
680 send_gdb "n\n" answer
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)\\) " {
974 send_gdb "n\n" answer
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. " {
1454 send_gdb "y\n" answer
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] } {
1514 send_gdb "y\n" answer
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. Mark as optional so it doesn't
1572 # get written to the stdin log.
1573 send_gdb "kill\n" optional
1575 -re "Kill the program being debugged. .y or n. $" {
1576 send_gdb "y\n" answer
1577 verbose "\t\tKilling previous program being debugged"
1580 -re "$gdb_prompt $" {
1585 send_gdb "file $arg\n"
1587 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1588 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1589 set gdb_file_cmd_debug_info "lzma"
1592 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1593 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1594 set gdb_file_cmd_debug_info "nodebug"
1597 -re "Reading symbols from.*$gdb_prompt $" {
1598 verbose "\t\tLoaded $arg into $GDB"
1599 set gdb_file_cmd_debug_info "debug"
1602 -re "Load new symbol table from \".*\".*y or n. $" {
1603 send_gdb "y\n" answer
1605 -re "Reading symbols from.*$gdb_prompt $" {
1606 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1607 set gdb_file_cmd_debug_info "debug"
1611 perror "Couldn't load $arg, other program already loaded (timeout)."
1615 perror "Couldn't load $arg, other program already loaded (eof)."
1620 -re "No such file or directory.*$gdb_prompt $" {
1621 perror "($arg) No such file or directory"
1624 -re "A problem internal to GDB has been detected" {
1625 fail "($arg) (GDB internal error)"
1626 gdb_internal_error_resync
1629 -re "$gdb_prompt $" {
1630 perror "Couldn't load $arg into $GDB."
1634 perror "Couldn't load $arg into $GDB (timeout)."
1638 # This is an attempt to detect a core dump, but seems not to
1639 # work. Perhaps we need to match .* followed by eof, in which
1640 # gdb_expect does not seem to have a way to do that.
1641 perror "Couldn't load $arg into $GDB (eof)."
1647 # Default gdb_spawn procedure.
1649 proc default_gdb_spawn { } {
1652 global INTERNAL_GDBFLAGS GDBFLAGS
1655 gdb_stop_suppressing_tests
1657 # Set the default value, it may be overriden later by specific testfile.
1659 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1660 # is already started after connecting and run/attach are not supported.
1661 # This is used for the "remote" protocol. After GDB starts you should
1662 # check global $use_gdb_stub instead of the board as the testfile may force
1663 # a specific different target protocol itself.
1664 set use_gdb_stub [target_info exists use_gdb_stub]
1666 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1667 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1669 if [info exists gdb_spawn_id] {
1673 if ![is_remote host] {
1674 if { [which $GDB] == 0 } then {
1675 perror "$GDB does not exist."
1679 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1680 if { $res < 0 || $res == "" } {
1681 perror "Spawning $GDB failed."
1685 set gdb_spawn_id $res
1689 # Default gdb_start procedure.
1691 proc default_gdb_start { } {
1694 global inferior_spawn_id
1696 if [info exists gdb_spawn_id] {
1700 # Keep track of the number of times GDB has been launched.
1701 global gdb_instances
1711 # Default to assuming inferior I/O is done on GDB's terminal.
1712 if {![info exists inferior_spawn_id]} {
1713 set inferior_spawn_id $gdb_spawn_id
1716 # When running over NFS, particularly if running many simultaneous
1717 # tests on different hosts all using the same server, things can
1718 # get really slow. Give gdb at least 3 minutes to start up.
1720 -re "\[\r\n\]$gdb_prompt $" {
1721 verbose "GDB initialized."
1723 -re "$gdb_prompt $" {
1724 perror "GDB never initialized."
1729 perror "(timeout) GDB never initialized after 10 seconds."
1736 # force the height to "unlimited", so no pagers get used
1738 send_gdb "set height 0\n"
1740 -re "$gdb_prompt $" {
1741 verbose "Setting height to 0." 2
1744 warning "Couldn't set the height to 0"
1747 # force the width to "unlimited", so no wraparound occurs
1748 send_gdb "set width 0\n"
1750 -re "$gdb_prompt $" {
1751 verbose "Setting width to 0." 2
1754 warning "Couldn't set the width to 0."
1762 # Utility procedure to give user control of the gdb prompt in a script. It is
1763 # meant to be used for debugging test cases, and should not be left in the
1766 proc gdb_interact { } {
1768 set spawn_id $gdb_spawn_id
1770 send_user "+------------------------------------------+\n"
1771 send_user "| Script interrupted, you can now interact |\n"
1772 send_user "| with by gdb. Type >>> to continue. |\n"
1773 send_user "+------------------------------------------+\n"
1780 # Examine the output of compilation to determine whether compilation
1781 # failed or not. If it failed determine whether it is due to missing
1782 # compiler or due to compiler error. Report pass, fail or unsupported
1785 proc gdb_compile_test {src output} {
1786 if { $output == "" } {
1787 pass "compilation [file tail $src]"
1788 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1789 unsupported "compilation [file tail $src]"
1790 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1791 unsupported "compilation [file tail $src]"
1792 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1793 unsupported "compilation [file tail $src]"
1795 verbose -log "compilation failed: $output" 2
1796 fail "compilation [file tail $src]"
1800 # Return a 1 for configurations for which we don't even want to try to
1803 proc skip_cplus_tests {} {
1804 if { [istarget "h8300-*-*"] } {
1808 # The C++ IO streams are too large for HC11/HC12 and are thus not
1809 # available. The gdb C++ tests use them and don't compile.
1810 if { [istarget "m6811-*-*"] } {
1813 if { [istarget "m6812-*-*"] } {
1819 # Return a 1 for configurations for which don't have both C++ and the STL.
1821 proc skip_stl_tests {} {
1822 # Symbian supports the C++ language, but the STL is missing
1823 # (both headers and libraries).
1824 if { [istarget "arm*-*-symbianelf*"] } {
1828 return [skip_cplus_tests]
1831 # Return a 1 if I don't even want to try to test FORTRAN.
1833 proc skip_fortran_tests {} {
1837 # Return a 1 if I don't even want to try to test ada.
1839 proc skip_ada_tests {} {
1843 # Return a 1 if I don't even want to try to test GO.
1845 proc skip_go_tests {} {
1849 # Return a 1 if I don't even want to try to test D.
1851 proc skip_d_tests {} {
1855 # Return 1 to skip Rust tests, 0 to try them.
1856 proc skip_rust_tests {} {
1857 return [expr {![isnative]}]
1860 # Return a 1 for configurations that do not support Python scripting.
1861 # PROMPT_REGEXP is the expected prompt.
1863 proc skip_python_tests_prompt { prompt_regexp } {
1864 global gdb_py_is_py3k
1866 gdb_test_multiple "python print ('test')" "verify python support" {
1867 -re "not supported.*$prompt_regexp" {
1868 unsupported "Python support is disabled."
1871 -re "$prompt_regexp" {}
1874 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1875 -re "3.*$prompt_regexp" {
1876 set gdb_py_is_py3k 1
1878 -re ".*$prompt_regexp" {
1879 set gdb_py_is_py3k 0
1886 # Return a 1 for configurations that do not support Python scripting.
1887 # Note: This also sets various globals that specify which version of Python
1888 # is in use. See skip_python_tests_prompt.
1890 proc skip_python_tests {} {
1892 return [skip_python_tests_prompt "$gdb_prompt $"]
1895 # Return a 1 if we should skip shared library tests.
1897 proc skip_shlib_tests {} {
1898 # Run the shared library tests on native systems.
1903 # An abbreviated list of remote targets where we should be able to
1904 # run shared library tests.
1905 if {([istarget *-*-linux*]
1906 || [istarget *-*-*bsd*]
1907 || [istarget *-*-solaris2*]
1908 || [istarget arm*-*-symbianelf*]
1909 || [istarget *-*-mingw*]
1910 || [istarget *-*-cygwin*]
1911 || [istarget *-*-pe*])} {
1918 # Return 1 if we should skip tui related tests.
1920 proc skip_tui_tests {} {
1923 gdb_test_multiple "help layout" "verify tui support" {
1924 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1927 -re "$gdb_prompt $" {
1934 # Test files shall make sure all the test result lines in gdb.sum are
1935 # unique in a test run, so that comparing the gdb.sum files of two
1936 # test runs gives correct results. Test files that exercise
1937 # variations of the same tests more than once, shall prefix the
1938 # different test invocations with different identifying strings in
1939 # order to make them unique.
1941 # About test prefixes:
1943 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1944 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1945 # underlined substring in
1947 # PASS: gdb.base/mytest.exp: some test
1948 # ^^^^^^^^^^^^^^^^^^^^
1952 # The easiest way to adjust the test prefix is to append a test
1953 # variation prefix to the $pf_prefix, using the with_test_prefix
1956 # proc do_tests {} {
1957 # gdb_test ... ... "test foo"
1958 # gdb_test ... ... "test bar"
1960 # with_test_prefix "subvariation a" {
1961 # gdb_test ... ... "test x"
1964 # with_test_prefix "subvariation b" {
1965 # gdb_test ... ... "test x"
1969 # with_test_prefix "variation1" {
1970 # ...do setup for variation 1...
1974 # with_test_prefix "variation2" {
1975 # ...do setup for variation 2...
1981 # PASS: gdb.base/mytest.exp: variation1: test foo
1982 # PASS: gdb.base/mytest.exp: variation1: test bar
1983 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1984 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1985 # PASS: gdb.base/mytest.exp: variation2: test foo
1986 # PASS: gdb.base/mytest.exp: variation2: test bar
1987 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1988 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1990 # If for some reason more flexibility is necessary, one can also
1991 # manipulate the pf_prefix global directly, treating it as a string.
1995 # set saved_pf_prefix
1996 # append pf_prefix "${foo}: bar"
1997 # ... actual tests ...
1998 # set pf_prefix $saved_pf_prefix
2001 # Run BODY in the context of the caller, with the current test prefix
2002 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2003 # Returns the result of BODY.
2005 proc with_test_prefix { prefix body } {
2008 set saved $pf_prefix
2009 append pf_prefix " " $prefix ":"
2010 set code [catch {uplevel 1 $body} result]
2011 set pf_prefix $saved
2014 global errorInfo errorCode
2015 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2017 return -code $code $result
2021 # Wrapper for foreach that calls with_test_prefix on each iteration,
2022 # including the iterator's name and current value in the prefix.
2024 proc foreach_with_prefix {var list body} {
2026 foreach myvar $list {
2027 with_test_prefix "$var=$myvar" {
2028 set code [catch {uplevel 1 $body} result]
2032 global errorInfo errorCode
2033 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2035 return -code $code $result
2040 # Like TCL's native proc, but defines a procedure that wraps its body
2041 # within 'with_test_prefix "$proc_name" { ... }'.
2042 proc proc_with_prefix {name arguments body} {
2043 # Define the advertised proc.
2044 proc $name $arguments [list with_test_prefix $name $body]
2048 # Run BODY in the context of the caller. After BODY is run, the variables
2049 # listed in VARS will be reset to the values they had before BODY was run.
2051 # This is useful for providing a scope in which it is safe to temporarily
2052 # modify global variables, e.g.
2054 # global INTERNAL_GDBFLAGS
2057 # set foo GDBHISTSIZE
2059 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2060 # append INTERNAL_GDBFLAGS " -nx"
2061 # unset -nocomplain env(GDBHISTSIZE)
2066 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2067 # modified inside BODY, this proc guarantees that the modifications will be
2068 # undone after BODY finishes executing.
2070 proc save_vars { vars body } {
2071 array set saved_scalars { }
2072 array set saved_arrays { }
2076 # First evaluate VAR in the context of the caller in case the variable
2077 # name may be a not-yet-interpolated string like env($foo)
2078 set var [uplevel 1 list $var]
2080 if [uplevel 1 [list info exists $var]] {
2081 if [uplevel 1 [list array exists $var]] {
2082 set saved_arrays($var) [uplevel 1 [list array get $var]]
2084 set saved_scalars($var) [uplevel 1 [list set $var]]
2087 lappend unset_vars $var
2091 set code [catch {uplevel 1 $body} result]
2093 foreach {var value} [array get saved_scalars] {
2094 uplevel 1 [list set $var $value]
2097 foreach {var value} [array get saved_arrays] {
2098 uplevel 1 [list unset $var]
2099 uplevel 1 [list array set $var $value]
2102 foreach var $unset_vars {
2103 uplevel 1 [list unset -nocomplain $var]
2107 global errorInfo errorCode
2108 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2110 return -code $code $result
2114 # Run tests in BODY with the current working directory (CWD) set to
2115 # DIR. When BODY is finished, restore the original CWD. Return the
2118 # This procedure doesn't check if DIR is a valid directory, so you
2119 # have to make sure of that.
2121 proc with_cwd { dir body } {
2123 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2126 set code [catch {uplevel 1 $body} result]
2128 verbose -log "Switching back to $saved_dir."
2132 global errorInfo errorCode
2133 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2135 return -code $code $result
2139 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2140 # PROMPT. When BODY is finished, restore GDB prompt and variable
2142 # Returns the result of BODY.
2146 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2147 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2148 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2149 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2150 # a) It's more intuitive for callers to pass the plain text form.
2151 # b) We need two forms of the prompt:
2152 # - a regexp to use in output matching,
2153 # - a value to pass to the "set prompt" command.
2154 # c) It's easier to convert the plain text form to its regexp form.
2156 # 2) Don't add a trailing space, we do that here.
2158 proc with_gdb_prompt { prompt body } {
2161 # Convert "(foo)" to "\(foo\)".
2162 # We don't use string_to_regexp because while it works today it's not
2163 # clear it will work tomorrow: the value we need must work as both a
2164 # regexp *and* as the argument to the "set prompt" command, at least until
2165 # we start recording both forms separately instead of just $gdb_prompt.
2166 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2168 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2170 set saved $gdb_prompt
2172 verbose -log "Setting gdb prompt to \"$prompt \"."
2173 set gdb_prompt $prompt
2174 gdb_test_no_output "set prompt $prompt " ""
2176 set code [catch {uplevel 1 $body} result]
2178 verbose -log "Restoring gdb prompt to \"$saved \"."
2179 set gdb_prompt $saved
2180 gdb_test_no_output "set prompt $saved " ""
2183 global errorInfo errorCode
2184 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2186 return -code $code $result
2190 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2191 # BODY is finished, restore target-charset.
2193 proc with_target_charset { target_charset body } {
2197 gdb_test_multiple "show target-charset" "" {
2198 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2199 set saved $expect_out(1,string)
2201 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2202 set saved $expect_out(1,string)
2204 -re ".*$gdb_prompt " {
2205 fail "get target-charset"
2209 gdb_test_no_output "set target-charset $target_charset" ""
2211 set code [catch {uplevel 1 $body} result]
2213 gdb_test_no_output "set target-charset $saved" ""
2216 global errorInfo errorCode
2217 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2219 return -code $code $result
2223 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2224 # mi_gdb_test etc. default to using it.
2226 proc switch_gdb_spawn_id {spawn_id} {
2228 global board board_info
2230 set gdb_spawn_id $spawn_id
2231 set board [host_info name]
2232 set board_info($board,fileid) $spawn_id
2235 # Clear the default spawn id.
2237 proc clear_gdb_spawn_id {} {
2239 global board board_info
2241 unset -nocomplain gdb_spawn_id
2242 set board [host_info name]
2243 unset -nocomplain board_info($board,fileid)
2246 # Run BODY with SPAWN_ID as current spawn id.
2248 proc with_spawn_id { spawn_id body } {
2251 if [info exists gdb_spawn_id] {
2252 set saved_spawn_id $gdb_spawn_id
2255 switch_gdb_spawn_id $spawn_id
2257 set code [catch {uplevel 1 $body} result]
2259 if [info exists saved_spawn_id] {
2260 switch_gdb_spawn_id $saved_spawn_id
2266 global errorInfo errorCode
2267 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2269 return -code $code $result
2273 # Select the largest timeout from all the timeouts:
2274 # - the local "timeout" variable of the scope two levels above,
2275 # - the global "timeout" variable,
2276 # - the board variable "gdb,timeout".
2278 proc get_largest_timeout {} {
2279 upvar #0 timeout gtimeout
2280 upvar 2 timeout timeout
2283 if [info exists timeout] {
2286 if { [info exists gtimeout] && $gtimeout > $tmt } {
2289 if { [target_info exists gdb,timeout]
2290 && [target_info gdb,timeout] > $tmt } {
2291 set tmt [target_info gdb,timeout]
2301 # Run tests in BODY with timeout increased by factor of FACTOR. When
2302 # BODY is finished, restore timeout.
2304 proc with_timeout_factor { factor body } {
2307 set savedtimeout $timeout
2309 set timeout [expr [get_largest_timeout] * $factor]
2310 set code [catch {uplevel 1 $body} result]
2312 set timeout $savedtimeout
2314 global errorInfo errorCode
2315 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2317 return -code $code $result
2321 # Return 1 if _Complex types are supported, otherwise, return 0.
2323 gdb_caching_proc support_complex_tests {
2325 if { [gdb_skip_float_test] } {
2326 # If floating point is not supported, _Complex is not
2331 # Compile a test program containing _Complex types.
2333 return [gdb_can_simple_compile complex {
2337 _Complex long double cld;
2343 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2346 proc supports_get_siginfo_type {} {
2347 if { [istarget "*-*-linux*"] } {
2354 # Return 1 if the target supports hardware single stepping.
2356 proc can_hardware_single_step {} {
2358 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2359 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2360 || [istarget "nios2-*-*"] } {
2367 # Return 1 if target hardware or OS supports single stepping to signal
2368 # handler, otherwise, return 0.
2370 proc can_single_step_to_signal_handler {} {
2371 # Targets don't have hardware single step. On these targets, when
2372 # a signal is delivered during software single step, gdb is unable
2373 # to determine the next instruction addresses, because start of signal
2374 # handler is one of them.
2375 return [can_hardware_single_step]
2378 # Return 1 if target supports process record, otherwise return 0.
2380 proc supports_process_record {} {
2382 if [target_info exists gdb,use_precord] {
2383 return [target_info gdb,use_precord]
2386 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2387 || [istarget "i\[34567\]86-*-linux*"]
2388 || [istarget "aarch64*-*-linux*"]
2389 || [istarget "powerpc*-*-linux*"]
2390 || [istarget "s390*-*-linux*"] } {
2397 # Return 1 if target supports reverse debugging, otherwise return 0.
2399 proc supports_reverse {} {
2401 if [target_info exists gdb,can_reverse] {
2402 return [target_info gdb,can_reverse]
2405 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2406 || [istarget "i\[34567\]86-*-linux*"]
2407 || [istarget "aarch64*-*-linux*"]
2408 || [istarget "powerpc*-*-linux*"]
2409 || [istarget "s390*-*-linux*"] } {
2416 # Return 1 if readline library is used.
2418 proc readline_is_used { } {
2421 gdb_test_multiple "show editing" "" {
2422 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2425 -re ".*$gdb_prompt $" {
2431 # Return 1 if target is ELF.
2432 gdb_caching_proc is_elf_target {
2433 set me "is_elf_target"
2435 set src { int foo () {return 0;} }
2436 if {![gdb_simple_compile elf_target $src]} {
2440 set fp_obj [open $obj "r"]
2441 fconfigure $fp_obj -translation binary
2442 set data [read $fp_obj]
2447 set ELFMAG "\u007FELF"
2449 if {[string compare -length 4 $data $ELFMAG] != 0} {
2450 verbose "$me: returning 0" 2
2454 verbose "$me: returning 1" 2
2458 # Return 1 if the memory at address zero is readable.
2460 gdb_caching_proc is_address_zero_readable {
2464 gdb_test_multiple "x 0" "" {
2465 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2468 -re ".*$gdb_prompt $" {
2476 # Produce source file NAME and write SOURCES into it.
2478 proc gdb_produce_source { name sources } {
2480 set f [open $name "w"]
2486 # Return 1 if target is ILP32.
2487 # This cannot be decided simply from looking at the target string,
2488 # as it might depend on externally passed compiler options like -m64.
2489 gdb_caching_proc is_ilp32_target {
2490 return [gdb_can_simple_compile is_ilp32_target {
2491 int dummy[sizeof (int) == 4
2492 && sizeof (void *) == 4
2493 && sizeof (long) == 4 ? 1 : -1];
2497 # Return 1 if target is LP64.
2498 # This cannot be decided simply from looking at the target string,
2499 # as it might depend on externally passed compiler options like -m64.
2500 gdb_caching_proc is_lp64_target {
2501 return [gdb_can_simple_compile is_lp64_target {
2502 int dummy[sizeof (int) == 4
2503 && sizeof (void *) == 8
2504 && sizeof (long) == 8 ? 1 : -1];
2508 # Return 1 if target has 64 bit addresses.
2509 # This cannot be decided simply from looking at the target string,
2510 # as it might depend on externally passed compiler options like -m64.
2511 gdb_caching_proc is_64_target {
2512 return [gdb_can_simple_compile is_64_target {
2513 int function(void) { return 3; }
2514 int dummy[sizeof (&function) == 8 ? 1 : -1];
2518 # Return 1 if target has x86_64 registers - either amd64 or x32.
2519 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2520 # just from the target string.
2521 gdb_caching_proc is_amd64_regs_target {
2522 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2526 return [gdb_can_simple_compile is_amd64_regs_target {
2536 # Return 1 if this target is an x86 or x86-64 with -m32.
2537 proc is_x86_like_target {} {
2538 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2541 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2544 # Return 1 if this target is an arm or aarch32 on aarch64.
2546 gdb_caching_proc is_aarch32_target {
2547 if { [istarget "arm*-*-*"] } {
2551 if { ![istarget "aarch64*-*-*"] } {
2558 lappend list "\tmov $reg, $reg"
2561 return [gdb_can_simple_compile aarch32 [join $list \n]]
2564 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2566 proc is_aarch64_target {} {
2567 if { ![istarget "aarch64*-*-*"] } {
2571 return [expr ![is_aarch32_target]]
2574 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2575 proc support_displaced_stepping {} {
2577 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2578 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2579 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2580 || [istarget "aarch64*-*-linux*"] } {
2587 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2588 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2590 gdb_caching_proc skip_altivec_tests {
2591 global srcdir subdir gdb_prompt inferior_exited_re
2593 set me "skip_altivec_tests"
2595 # Some simulators are known to not support VMX instructions.
2596 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2597 verbose "$me: target known to not support VMX, returning 1" 2
2601 # Make sure we have a compiler that understands altivec.
2602 if [get_compiler_info] {
2603 warning "Could not get compiler info"
2606 if [test_compiler_info gcc*] {
2607 set compile_flags "additional_flags=-maltivec"
2608 } elseif [test_compiler_info xlc*] {
2609 set compile_flags "additional_flags=-qaltivec"
2611 verbose "Could not compile with altivec support, returning 1" 2
2615 # Compile a test program containing VMX instructions.
2619 asm volatile ("vor v0,v0,v0");
2621 asm volatile ("vor 0,0,0");
2626 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2630 # Compilation succeeded so now run it via gdb.
2634 gdb_reinitialize_dir $srcdir/$subdir
2638 -re ".*Illegal instruction.*${gdb_prompt} $" {
2639 verbose -log "\n$me altivec hardware not detected"
2640 set skip_vmx_tests 1
2642 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2643 verbose -log "\n$me: altivec hardware detected"
2644 set skip_vmx_tests 0
2647 warning "\n$me: default case taken"
2648 set skip_vmx_tests 1
2652 remote_file build delete $obj
2654 verbose "$me: returning $skip_vmx_tests" 2
2655 return $skip_vmx_tests
2658 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2659 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2661 gdb_caching_proc skip_vsx_tests {
2662 global srcdir subdir gdb_prompt inferior_exited_re
2664 set me "skip_vsx_tests"
2666 # Some simulators are known to not support Altivec instructions, so
2667 # they won't support VSX instructions as well.
2668 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2669 verbose "$me: target known to not support VSX, returning 1" 2
2673 # Make sure we have a compiler that understands altivec.
2674 if [get_compiler_info] {
2675 warning "Could not get compiler info"
2678 if [test_compiler_info gcc*] {
2679 set compile_flags "additional_flags=-mvsx"
2680 } elseif [test_compiler_info xlc*] {
2681 set compile_flags "additional_flags=-qasm=gcc"
2683 verbose "Could not compile with vsx support, returning 1" 2
2687 # Compile a test program containing VSX instructions.
2690 double a[2] = { 1.0, 2.0 };
2692 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2694 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2699 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2703 # No error message, compilation succeeded so now run it via gdb.
2707 gdb_reinitialize_dir $srcdir/$subdir
2711 -re ".*Illegal instruction.*${gdb_prompt} $" {
2712 verbose -log "\n$me VSX hardware not detected"
2713 set skip_vsx_tests 1
2715 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2716 verbose -log "\n$me: VSX hardware detected"
2717 set skip_vsx_tests 0
2720 warning "\n$me: default case taken"
2721 set skip_vsx_tests 1
2725 remote_file build delete $obj
2727 verbose "$me: returning $skip_vsx_tests" 2
2728 return $skip_vsx_tests
2731 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2732 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2734 gdb_caching_proc skip_tsx_tests {
2735 global srcdir subdir gdb_prompt inferior_exited_re
2737 set me "skip_tsx_tests"
2739 # Compile a test program.
2742 asm volatile ("xbegin .L0");
2743 asm volatile ("xend");
2744 asm volatile (".L0: nop");
2748 if {![gdb_simple_compile $me $src executable]} {
2752 # No error message, compilation succeeded so now run it via gdb.
2756 gdb_reinitialize_dir $srcdir/$subdir
2760 -re ".*Illegal instruction.*${gdb_prompt} $" {
2761 verbose -log "$me: TSX hardware not detected."
2762 set skip_tsx_tests 1
2764 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2765 verbose -log "$me: TSX hardware detected."
2766 set skip_tsx_tests 0
2769 warning "\n$me: default case taken."
2770 set skip_tsx_tests 1
2774 remote_file build delete $obj
2776 verbose "$me: returning $skip_tsx_tests" 2
2777 return $skip_tsx_tests
2780 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2781 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2783 gdb_caching_proc skip_btrace_tests {
2784 global srcdir subdir gdb_prompt inferior_exited_re
2786 set me "skip_btrace_tests"
2787 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2788 verbose "$me: target does not support btrace, returning 1" 2
2792 # Compile a test program.
2793 set src { int main() { return 0; } }
2794 if {![gdb_simple_compile $me $src executable]} {
2798 # No error message, compilation succeeded so now run it via gdb.
2802 gdb_reinitialize_dir $srcdir/$subdir
2807 # In case of an unexpected output, we return 2 as a fail value.
2808 set skip_btrace_tests 2
2809 gdb_test_multiple "record btrace" "check btrace support" {
2810 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2811 set skip_btrace_tests 1
2813 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2814 set skip_btrace_tests 1
2816 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2817 set skip_btrace_tests 1
2819 -re "^record btrace\r\n$gdb_prompt $" {
2820 set skip_btrace_tests 0
2824 remote_file build delete $obj
2826 verbose "$me: returning $skip_btrace_tests" 2
2827 return $skip_btrace_tests
2830 # Run a test on the target to see if it supports btrace pt hardware.
2831 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2832 # from the GCC testsuite.
2834 gdb_caching_proc skip_btrace_pt_tests {
2835 global srcdir subdir gdb_prompt inferior_exited_re
2837 set me "skip_btrace_tests"
2838 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2839 verbose "$me: target does not support btrace, returning 1" 2
2843 # Compile a test program.
2844 set src { int main() { return 0; } }
2845 if {![gdb_simple_compile $me $src executable]} {
2849 # No error message, compilation succeeded so now run it via gdb.
2853 gdb_reinitialize_dir $srcdir/$subdir
2858 # In case of an unexpected output, we return 2 as a fail value.
2859 set skip_btrace_tests 2
2860 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2861 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2862 set skip_btrace_tests 1
2864 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2865 set skip_btrace_tests 1
2867 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2868 set skip_btrace_tests 1
2870 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2871 set skip_btrace_tests 1
2873 -re "^record btrace pt\r\n$gdb_prompt $" {
2874 set skip_btrace_tests 0
2878 remote_file build delete $obj
2880 verbose "$me: returning $skip_btrace_tests" 2
2881 return $skip_btrace_tests
2884 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2885 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2887 gdb_caching_proc skip_aarch64_sve_tests {
2888 global srcdir subdir gdb_prompt inferior_exited_re
2890 set me "skip_aarch64_sve_tests"
2892 if { ![is_aarch64_target]} {
2896 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2898 # Compile a test program containing SVE instructions.
2901 asm volatile ("ptrue p0.b");
2905 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2909 # Compilation succeeded so now run it via gdb.
2913 -re ".*Illegal instruction.*${gdb_prompt} $" {
2914 verbose -log "\n$me sve hardware not detected"
2915 set skip_sve_tests 1
2917 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2918 verbose -log "\n$me: sve hardware detected"
2919 set skip_sve_tests 0
2922 warning "\n$me: default case taken"
2923 set skip_sve_tests 1
2927 remote_file build delete $obj
2929 verbose "$me: returning $skip_sve_tests" 2
2930 return $skip_sve_tests
2934 # A helper that compiles a test case to see if __int128 is supported.
2935 proc gdb_int128_helper {lang} {
2936 return [gdb_can_simple_compile "i128-for-$lang" {
2938 int main() { return 0; }
2942 # Return true if the C compiler understands the __int128 type.
2943 gdb_caching_proc has_int128_c {
2944 return [gdb_int128_helper c]
2947 # Return true if the C++ compiler understands the __int128 type.
2948 gdb_caching_proc has_int128_cxx {
2949 return [gdb_int128_helper c++]
2952 # Return true if the IFUNC feature is unsupported.
2953 gdb_caching_proc skip_ifunc_tests {
2954 if [gdb_can_simple_compile ifunc {
2956 typedef void F (void);
2957 F* g (void) { return &f_; }
2958 void f () __attribute__ ((ifunc ("g")));
2966 # Return whether we should skip tests for showing inlined functions in
2967 # backtraces. Requires get_compiler_info and get_debug_format.
2969 proc skip_inline_frame_tests {} {
2970 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2971 if { ! [test_debug_format "DWARF 2"] } {
2975 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2976 if { ([test_compiler_info "gcc-2-*"]
2977 || [test_compiler_info "gcc-3-*"]
2978 || [test_compiler_info "gcc-4-0-*"]) } {
2985 # Return whether we should skip tests for showing variables from
2986 # inlined functions. Requires get_compiler_info and get_debug_format.
2988 proc skip_inline_var_tests {} {
2989 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2990 if { ! [test_debug_format "DWARF 2"] } {
2997 # Return a 1 if we should skip tests that require hardware breakpoints
2999 proc skip_hw_breakpoint_tests {} {
3000 # Skip tests if requested by the board (note that no_hardware_watchpoints
3001 # disables both watchpoints and breakpoints)
3002 if { [target_info exists gdb,no_hardware_watchpoints]} {
3006 # These targets support hardware breakpoints natively
3007 if { [istarget "i?86-*-*"]
3008 || [istarget "x86_64-*-*"]
3009 || [istarget "ia64-*-*"]
3010 || [istarget "arm*-*-*"]
3011 || [istarget "aarch64*-*-*"]
3012 || [istarget "s390*-*-*"] } {
3019 # Return a 1 if we should skip tests that require hardware watchpoints
3021 proc skip_hw_watchpoint_tests {} {
3022 # Skip tests if requested by the board
3023 if { [target_info exists gdb,no_hardware_watchpoints]} {
3027 # These targets support hardware watchpoints natively
3028 if { [istarget "i?86-*-*"]
3029 || [istarget "x86_64-*-*"]
3030 || [istarget "ia64-*-*"]
3031 || [istarget "arm*-*-*"]
3032 || [istarget "aarch64*-*-*"]
3033 || [istarget "powerpc*-*-linux*"]
3034 || [istarget "s390*-*-*"] } {
3041 # Return a 1 if we should skip tests that require *multiple* hardware
3042 # watchpoints to be active at the same time
3044 proc skip_hw_watchpoint_multi_tests {} {
3045 if { [skip_hw_watchpoint_tests] } {
3049 # These targets support just a single hardware watchpoint
3050 if { [istarget "arm*-*-*"]
3051 || [istarget "powerpc*-*-linux*"] } {
3058 # Return a 1 if we should skip tests that require read/access watchpoints
3060 proc skip_hw_watchpoint_access_tests {} {
3061 if { [skip_hw_watchpoint_tests] } {
3065 # These targets support just write watchpoints
3066 if { [istarget "s390*-*-*"] } {
3073 # Return 1 if we should skip tests that require the runtime unwinder
3074 # hook. This must be invoked while gdb is running, after shared
3075 # libraries have been loaded. This is needed because otherwise a
3076 # shared libgcc won't be visible.
3078 proc skip_unwinder_tests {} {
3082 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3083 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3085 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3088 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3092 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3093 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3096 -re "\r\n$gdb_prompt $" {
3103 # Return 0 if we should skip tests that require the libstdc++ stap
3104 # probes. This must be invoked while gdb is running, after shared
3105 # libraries have been loaded.
3107 proc skip_libstdcxx_probe_tests {} {
3111 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3112 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3115 -re "\r\n$gdb_prompt $" {
3121 # Return 1 if we should skip tests of the "compile" feature.
3122 # This must be invoked after the inferior has been started.
3124 proc skip_compile_feature_tests {} {
3128 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3129 "Could not load libcc1.*\r\n$gdb_prompt $" {
3132 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3135 -re "\r\n$gdb_prompt $" {
3141 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3142 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3143 # is a regexp that will match the output of "maint print target-stack" if
3144 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3145 # matching the expected prompt after the command output.
3147 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3148 set test "probe for target ${target_name}"
3149 gdb_test_multiple "maint print target-stack" $test {
3150 -re "${target_stack_regexp}${prompt_regexp}" {
3154 -re "$prompt_regexp" {
3161 # Helper for gdb_is_target_remote where the expected prompt is variable.
3163 proc gdb_is_target_remote_prompt { prompt_regexp } {
3164 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3167 # Check whether we're testing with the remote or extended-remote
3170 proc gdb_is_target_remote { } {
3173 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3176 # Check whether we're testing with the native target.
3178 proc gdb_is_target_native { } {
3181 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3184 # Return the effective value of use_gdb_stub.
3186 # If the use_gdb_stub global has been set (it is set when the gdb process is
3187 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3188 # property from the board file.
3190 # This is the preferred way of checking use_gdb_stub, since it allows to check
3191 # the value before the gdb has been spawned and it will return the correct value
3192 # even when it was overriden by the test.
3194 proc use_gdb_stub {} {
3197 if [info exists use_gdb_stub] {
3198 return $use_gdb_stub
3201 return [target_info exists use_gdb_stub]
3204 # Return 1 if the current remote target is an instance of our GDBserver, 0
3205 # otherwise. Return -1 if there was an error and we can't tell.
3207 gdb_caching_proc target_is_gdbserver {
3211 set test "probing for GDBserver"
3213 gdb_test_multiple "monitor help" $test {
3214 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3217 -re "$gdb_prompt $" {
3222 if { $is_gdbserver == -1 } {
3223 verbose -log "Unable to tell whether we are using GDBserver or not."
3226 return $is_gdbserver
3229 # N.B. compiler_info is intended to be local to this file.
3230 # Call test_compiler_info with no arguments to fetch its value.
3231 # Yes, this is counterintuitive when there's get_compiler_info,
3232 # but that's the current API.
3233 if [info exists compiler_info] {
3239 # Figure out what compiler I am using.
3240 # The result is cached so only the first invocation runs the compiler.
3242 # ARG can be empty or "C++". If empty, "C" is assumed.
3244 # There are several ways to do this, with various problems.
3246 # [ gdb_compile -E $ifile -o $binfile.ci ]
3247 # source $binfile.ci
3249 # Single Unix Spec v3 says that "-E -o ..." together are not
3250 # specified. And in fact, the native compiler on hp-ux 11 (among
3251 # others) does not work with "-E -o ...". Most targets used to do
3252 # this, and it mostly worked, because it works with gcc.
3254 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3255 # source $binfile.ci
3257 # This avoids the problem with -E and -o together. This almost works
3258 # if the build machine is the same as the host machine, which is
3259 # usually true of the targets which are not gcc. But this code does
3260 # not figure which compiler to call, and it always ends up using the C
3261 # compiler. Not good for setting hp_aCC_compiler. Target
3262 # hppa*-*-hpux* used to do this.
3264 # [ gdb_compile -E $ifile > $binfile.ci ]
3265 # source $binfile.ci
3267 # dejagnu target_compile says that it supports output redirection,
3268 # but the code is completely different from the normal path and I
3269 # don't want to sweep the mines from that path. So I didn't even try
3272 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3275 # I actually do this for all targets now. gdb_compile runs the right
3276 # compiler, and TCL captures the output, and I eval the output.
3278 # Unfortunately, expect logs the output of the command as it goes by,
3279 # and dejagnu helpfully prints a second copy of it right afterwards.
3280 # So I turn off expect logging for a moment.
3282 # [ gdb_compile $ifile $ciexe_file executable $args ]
3283 # [ remote_exec $ciexe_file ]
3284 # [ source $ci_file.out ]
3286 # I could give up on -E and just do this.
3287 # I didn't get desperate enough to try this.
3289 # -- chastain 2004-01-06
3291 proc get_compiler_info {{arg ""}} {
3292 # For compiler.c and compiler.cc
3295 # I am going to play with the log to keep noise out.
3299 # These come from compiler.c or compiler.cc
3300 global compiler_info
3302 # Legacy global data symbols.
3305 if [info exists compiler_info] {
3310 # Choose which file to preprocess.
3311 set ifile "${srcdir}/lib/compiler.c"
3312 if { $arg == "c++" } {
3313 set ifile "${srcdir}/lib/compiler.cc"
3316 # Run $ifile through the right preprocessor.
3317 # Toggle gdb.log to keep the compiler output out of the log.
3318 set saved_log [log_file -info]
3320 if [is_remote host] {
3321 # We have to use -E and -o together, despite the comments
3322 # above, because of how DejaGnu handles remote host testing.
3323 set ppout "$outdir/compiler.i"
3324 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3325 set file [open $ppout r]
3326 set cppout [read $file]
3329 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3331 eval log_file $saved_log
3335 foreach cppline [ split "$cppout" "\n" ] {
3336 if { [ regexp "^#" "$cppline" ] } {
3338 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3340 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3342 verbose "get_compiler_info: $cppline" 2
3346 verbose -log "get_compiler_info: $cppline"
3351 # Set to unknown if for some reason compiler_info didn't get defined.
3352 if ![info exists compiler_info] {
3353 verbose -log "get_compiler_info: compiler_info not provided"
3354 set compiler_info "unknown"
3356 # Also set to unknown compiler if any diagnostics happened.
3358 verbose -log "get_compiler_info: got unexpected diagnostics"
3359 set compiler_info "unknown"
3362 # Set the legacy symbols.
3364 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3366 # Log what happened.
3367 verbose -log "get_compiler_info: $compiler_info"
3369 # Most compilers will evaluate comparisons and other boolean
3370 # operations to 0 or 1.
3371 uplevel \#0 { set true 1 }
3372 uplevel \#0 { set false 0 }
3377 # Return the compiler_info string if no arg is provided.
3378 # Otherwise the argument is a glob-style expression to match against
3381 proc test_compiler_info { {compiler ""} } {
3382 global compiler_info
3385 # If no arg, return the compiler_info string.
3386 if [string match "" $compiler] {
3387 return $compiler_info
3390 return [string match $compiler $compiler_info]
3393 proc current_target_name { } {
3395 if [info exists target_info(target,name)] {
3396 set answer $target_info(target,name)
3403 set gdb_wrapper_initialized 0
3404 set gdb_wrapper_target ""
3406 proc gdb_wrapper_init { args } {
3407 global gdb_wrapper_initialized
3408 global gdb_wrapper_file
3409 global gdb_wrapper_flags
3410 global gdb_wrapper_target
3412 if { $gdb_wrapper_initialized == 1 } { return; }
3414 if {[target_info exists needs_status_wrapper] && \
3415 [target_info needs_status_wrapper] != "0"} {
3416 set result [build_wrapper "testglue.o"]
3417 if { $result != "" } {
3418 set gdb_wrapper_file [lindex $result 0]
3419 set gdb_wrapper_flags [lindex $result 1]
3421 warning "Status wrapper failed to build."
3424 set gdb_wrapper_initialized 1
3425 set gdb_wrapper_target [current_target_name]
3428 # Determine options that we always want to pass to the compiler.
3429 gdb_caching_proc universal_compile_options {
3430 set me "universal_compile_options"
3433 set src [standard_temp_file ccopts[pid].c]
3434 set obj [standard_temp_file ccopts[pid].o]
3436 gdb_produce_source $src {
3437 int foo(void) { return 0; }
3440 # Try an option for disabling colored diagnostics. Some compilers
3441 # yield colored diagnostics by default (when run from a tty) unless
3442 # such an option is specified.
3443 set opt "additional_flags=-fdiagnostics-color=never"
3444 set lines [target_compile $src $obj object [list "quiet" $opt]]
3445 if [string match "" $lines] then {
3446 # Seems to have worked; use the option.
3447 lappend options $opt
3452 verbose "$me: returning $options" 2
3456 # Compile the code in $code to a file based on $name, using the flags
3457 # $compile_flag as well as debug, nowarning and quiet.
3458 # Return 1 if code can be compiled
3459 # Leave the file name of the resulting object in the upvar object.
3461 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3464 switch -regexp -- $type {
3478 set src [standard_temp_file $name-[pid].c]
3479 set obj [standard_temp_file $name-[pid].$postfix]
3480 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3482 gdb_produce_source $src $code
3484 verbose "$name: compiling testfile $src" 2
3485 set lines [gdb_compile $src $obj $type $compile_flags]
3489 if ![string match "" $lines] then {
3490 verbose "$name: compilation failed, returning 0" 2
3496 # Compile the code in $code to a file based on $name, using the flags
3497 # $compile_flag as well as debug, nowarning and quiet.
3498 # Return 1 if code can be compiled
3499 # Delete all created files and objects.
3501 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3502 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3503 file delete $temp_obj
3507 # Some targets need to always link a special object in. Save its path here.
3508 global gdb_saved_set_unbuffered_mode_obj
3509 set gdb_saved_set_unbuffered_mode_obj ""
3511 # Compile source files specified by SOURCE into a binary of type TYPE at path
3512 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3513 # parameter and most options are passed directly to it.
3515 # The type can be one of the following:
3517 # - object: Compile into an object file.
3518 # - executable: Compile and link into an executable.
3519 # - preprocess: Preprocess the source files.
3520 # - assembly: Generate assembly listing.
3522 # The following options are understood and processed by gdb_compile:
3524 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3525 # quirks to be able to use shared libraries.
3526 # - shlib_load: Link with appropriate libraries to allow the test to
3527 # dynamically load libraries at runtime. For example, on Linux, this adds
3528 # -ldl so that the test can use dlopen.
3529 # - nowarnings: Inhibit all compiler warnings.
3530 # - pie: Force creation of PIE executables.
3531 # - nopie: Prevent creation of PIE executables.
3533 # And here are some of the not too obscure options understood by DejaGnu that
3534 # influence the compilation:
3536 # - additional_flags=flag: Add FLAG to the compiler flags.
3537 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3538 # argument can be a file, in which case it's added to the sources, or a
3540 # - ldflags=flag: Add FLAG to the linker flags.
3541 # - incdir=path: Add PATH to the searched include directories.
3542 # - libdir=path: Add PATH to the linker searched directories.
3543 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3544 # - debug: Build with debug information.
3545 # - optimize: Build with optimization.
3547 proc gdb_compile {source dest type options} {
3548 global GDB_TESTCASE_OPTIONS
3549 global gdb_wrapper_file
3550 global gdb_wrapper_flags
3551 global gdb_wrapper_initialized
3554 global gdb_saved_set_unbuffered_mode_obj
3556 set outdir [file dirname $dest]
3558 # Add platform-specific options if a shared library was specified using
3559 # "shlib=librarypath" in OPTIONS.
3561 if {[lsearch -exact $options rust] != -1} {
3562 # -fdiagnostics-color is not a rustcc option.
3564 set new_options [universal_compile_options]
3568 set getting_compiler_info 0
3569 foreach opt $options {
3570 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3571 && $type == "executable"} {
3572 if [test_compiler_info "xlc-*"] {
3573 # IBM xlc compiler doesn't accept shared library named other
3574 # than .so: use "-Wl," to bypass this
3575 lappend source "-Wl,$shlib_name"
3576 } elseif { ([istarget "*-*-mingw*"]
3577 || [istarget *-*-cygwin*]
3578 || [istarget *-*-pe*])} {
3579 lappend source "${shlib_name}.a"
3581 lappend source $shlib_name
3583 if { $shlib_found == 0 } {
3585 if { ([istarget "*-*-mingw*"]
3586 || [istarget *-*-cygwin*]) } {
3587 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3589 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3590 # Undo debian's change in the default.
3591 # Put it at the front to not override any user-provided
3592 # value, and to make sure it appears in front of all the
3594 lappend new_options "early_flags=-Wl,--no-as-needed"
3597 } elseif { $opt == "shlib_load" && $type == "executable" } {
3599 } elseif { $opt == "getting_compiler_info" } {
3600 # If this is set, calling test_compiler_info will cause recursion.
3601 set getting_compiler_info 1
3603 lappend new_options $opt
3607 # Ensure stack protector is disabled for GCC, as this causes problems with
3608 # DWARF line numbering.
3609 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3610 # This option defaults to on for Debian/Ubuntu.
3611 if { $getting_compiler_info == 0
3612 && [test_compiler_info {gcc-*-*}]
3613 && !([test_compiler_info {gcc-[0-3]-*}]
3614 || [test_compiler_info {gcc-4-0-*}])
3615 && [lsearch -exact $options rust] == -1} {
3616 # Put it at the front to not override any user-provided value.
3617 lappend new_options "early_flags=-fno-stack-protector"
3620 # Because we link with libraries using their basename, we may need
3621 # (depending on the platform) to set a special rpath value, to allow
3622 # the executable to find the libraries it depends on.
3623 if { $shlib_load || $shlib_found } {
3624 if { ([istarget "*-*-mingw*"]
3625 || [istarget *-*-cygwin*]
3626 || [istarget *-*-pe*]) } {
3627 # Do not need anything.
3628 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3629 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3630 } elseif { [istarget arm*-*-symbianelf*] } {
3631 if { $shlib_load } {
3632 lappend new_options "libs=-ldl"
3635 if { $shlib_load } {
3636 lappend new_options "libs=-ldl"
3638 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3641 set options $new_options
3643 if [info exists GDB_TESTCASE_OPTIONS] {
3644 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3646 verbose "options are $options"
3647 verbose "source is $source $dest $type $options"
3649 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3651 if {[target_info exists needs_status_wrapper] && \
3652 [target_info needs_status_wrapper] != "0" && \
3653 [info exists gdb_wrapper_file]} {
3654 lappend options "libs=${gdb_wrapper_file}"
3655 lappend options "ldflags=${gdb_wrapper_flags}"
3658 # Replace the "nowarnings" option with the appropriate additional_flags
3659 # to disable compiler warnings.
3660 set nowarnings [lsearch -exact $options nowarnings]
3661 if {$nowarnings != -1} {
3662 if [target_info exists gdb,nowarnings_flag] {
3663 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3665 set flag "additional_flags=-w"
3667 set options [lreplace $options $nowarnings $nowarnings $flag]
3670 # Replace the "pie" option with the appropriate compiler and linker flags
3671 # to enable PIE executables.
3672 set pie [lsearch -exact $options pie]
3674 if [target_info exists gdb,pie_flag] {
3675 set flag "additional_flags=[target_info gdb,pie_flag]"
3677 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3678 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3679 # a maximum size. On other architectures the two flags are
3680 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3681 # onwards default GCC to using fPIE. If you do require fpie, then
3682 # it can be set using the pie_flag.
3683 set flag "additional_flags=-fPIE"
3685 set options [lreplace $options $pie $pie $flag]
3687 if [target_info exists gdb,pie_ldflag] {
3688 set flag "ldflags=[target_info gdb,pie_ldflag]"
3690 set flag "ldflags=-pie"
3692 lappend options "$flag"
3695 # Replace the "nopie" option with the appropriate linker flag to disable
3696 # PIE executables. There are no compiler flags for this option.
3697 set nopie [lsearch -exact $options nopie]
3699 if [target_info exists gdb,nopie_flag] {
3700 set flag "ldflags=[target_info gdb,nopie_flag]"
3702 set flag "ldflags=-no-pie"
3704 set options [lreplace $options $nopie $nopie $flag]
3707 if { $type == "executable" } {
3708 if { ([istarget "*-*-mingw*"]
3709 || [istarget "*-*-*djgpp"]
3710 || [istarget "*-*-cygwin*"])} {
3711 # Force output to unbuffered mode, by linking in an object file
3712 # with a global contructor that calls setvbuf.
3714 # Compile the special object seperatelly for two reasons:
3715 # 1) Insulate it from $options.
3716 # 2) Avoid compiling it for every gdb_compile invocation,
3717 # which is time consuming, especially if we're remote
3720 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3721 verbose "compiling gdb_saved_set_unbuffered_obj"
3722 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3723 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3725 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3726 if { $result != "" } {
3729 if {[is_remote host]} {
3730 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3732 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3734 # Link a copy of the output object, because the
3735 # original may be automatically deleted.
3736 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3738 verbose "gdb_saved_set_unbuffered_obj already compiled"
3741 # Rely on the internal knowledge that the global ctors are ran in
3742 # reverse link order. In that case, we can use ldflags to
3743 # avoid copying the object file to the host multiple
3745 # This object can only be added if standard libraries are
3746 # used. Thus, we need to disable it if -nostdlib option is used
3747 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3748 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3753 set result [target_compile $source $dest $type $options]
3755 # Prune uninteresting compiler (and linker) output.
3756 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3758 regsub "\[\r\n\]*$" "$result" "" result
3759 regsub "^\[\r\n\]*" "$result" "" result
3761 if {[lsearch $options quiet] < 0} {
3762 # We shall update this on a per language basis, to avoid
3763 # changing the entire testsuite in one go.
3764 if {[lsearch $options f77] >= 0} {
3765 gdb_compile_test $source $result
3766 } elseif { $result != "" } {
3767 clone_output "gdb compile failed, $result"
3774 # This is just like gdb_compile, above, except that it tries compiling
3775 # against several different thread libraries, to see which one this
3777 proc gdb_compile_pthreads {source dest type options} {
3779 set why_msg "unrecognized error"
3780 foreach lib {-lpthreads -lpthread -lthread ""} {
3781 # This kind of wipes out whatever libs the caller may have
3782 # set. Or maybe theirs will override ours. How infelicitous.
3783 set options_with_lib [concat $options [list libs=$lib quiet]]
3784 set ccout [gdb_compile $source $dest $type $options_with_lib]
3785 switch -regexp -- $ccout {
3786 ".*no posix threads support.*" {
3787 set why_msg "missing threads include file"
3790 ".*cannot open -lpthread.*" {
3791 set why_msg "missing runtime threads library"
3793 ".*Can't find library for -lpthread.*" {
3794 set why_msg "missing runtime threads library"
3797 pass "successfully compiled posix threads test case"
3803 if {!$built_binfile} {
3804 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3809 # Build a shared library from SOURCES.
3811 proc gdb_compile_shlib {sources dest options} {
3812 set obj_options $options
3815 if { [lsearch -exact $options "c++"] >= 0 } {
3816 set info_options "c++"
3818 if [get_compiler_info ${info_options}] {
3822 switch -glob [test_compiler_info] {
3824 lappend obj_options "additional_flags=-qpic"
3827 if { !([istarget "*-*-cygwin*"]
3828 || [istarget "*-*-mingw*"]) } {
3829 lappend obj_options "additional_flags=-fpic"
3833 if { !([istarget "powerpc*-*-aix*"]
3834 || [istarget "rs6000*-*-aix*"]
3835 || [istarget "*-*-cygwin*"]
3836 || [istarget "*-*-mingw*"]
3837 || [istarget "*-*-pe*"]) } {
3838 lappend obj_options "additional_flags=-fpic"
3842 lappend obj_options "additional_flags=-fpic"
3845 # don't know what the compiler is...
3849 set outdir [file dirname $dest]
3851 foreach source $sources {
3852 set sourcebase [file tail $source]
3853 if {[file extension $source] == ".o"} {
3854 # Already a .o file.
3855 lappend objects $source
3856 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
3857 $obj_options] != ""} {
3860 lappend objects ${outdir}/${sourcebase}.o
3864 set link_options $options
3865 if [test_compiler_info "xlc-*"] {
3866 lappend link_options "additional_flags=-qmkshrobj"
3868 lappend link_options "additional_flags=-shared"
3870 if { ([istarget "*-*-mingw*"]
3871 || [istarget *-*-cygwin*]
3872 || [istarget *-*-pe*]) } {
3873 if { [is_remote host] } {
3874 set name [file tail ${dest}]
3878 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3880 # Set the soname of the library. This causes the linker on ELF
3881 # systems to create the DT_NEEDED entry in the executable referring
3882 # to the soname of the library, and not its absolute path. This
3883 # (using the absolute path) would be problem when testing on a
3886 # In conjunction with setting the soname, we add the special
3887 # rpath=$ORIGIN value when building the executable, so that it's
3888 # able to find the library in its own directory.
3889 set destbase [file tail $dest]
3890 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3893 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3896 if { [is_remote host]
3897 && ([istarget "*-*-mingw*"]
3898 || [istarget *-*-cygwin*]
3899 || [istarget *-*-pe*]) } {
3900 set dest_tail_name [file tail ${dest}]
3901 remote_upload host $dest_tail_name.a ${dest}.a
3902 remote_file host delete $dest_tail_name.a
3908 # This is just like gdb_compile_shlib, above, except that it tries compiling
3909 # against several different thread libraries, to see which one this
3911 proc gdb_compile_shlib_pthreads {sources dest options} {
3913 set why_msg "unrecognized error"
3914 foreach lib {-lpthreads -lpthread -lthread ""} {
3915 # This kind of wipes out whatever libs the caller may have
3916 # set. Or maybe theirs will override ours. How infelicitous.
3917 set options_with_lib [concat $options [list libs=$lib quiet]]
3918 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3919 switch -regexp -- $ccout {
3920 ".*no posix threads support.*" {
3921 set why_msg "missing threads include file"
3924 ".*cannot open -lpthread.*" {
3925 set why_msg "missing runtime threads library"
3927 ".*Can't find library for -lpthread.*" {
3928 set why_msg "missing runtime threads library"
3931 pass "successfully compiled posix threads test case"
3937 if {!$built_binfile} {
3938 unsupported "couldn't compile $sources: ${why_msg}"
3943 # This is just like gdb_compile_pthreads, above, except that we always add the
3944 # objc library for compiling Objective-C programs
3945 proc gdb_compile_objc {source dest type options} {
3947 set why_msg "unrecognized error"
3948 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3949 # This kind of wipes out whatever libs the caller may have
3950 # set. Or maybe theirs will override ours. How infelicitous.
3951 if { $lib == "solaris" } {
3952 set lib "-lpthread -lposix4"
3954 if { $lib != "-lobjc" } {
3955 set lib "-lobjc $lib"
3957 set options_with_lib [concat $options [list libs=$lib quiet]]
3958 set ccout [gdb_compile $source $dest $type $options_with_lib]
3959 switch -regexp -- $ccout {
3960 ".*no posix threads support.*" {
3961 set why_msg "missing threads include file"
3964 ".*cannot open -lpthread.*" {
3965 set why_msg "missing runtime threads library"
3967 ".*Can't find library for -lpthread.*" {
3968 set why_msg "missing runtime threads library"
3971 pass "successfully compiled objc with posix threads test case"
3977 if {!$built_binfile} {
3978 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3983 # Send a command to GDB.
3984 # For options for TYPE see gdb_stdin_log_write
3986 proc send_gdb { string {type standard}} {
3987 global suppress_flag
3988 if { $suppress_flag } {
3991 gdb_stdin_log_write $string $type
3992 return [remote_send host "$string"]
3995 # Send STRING to the inferior's terminal.
3997 proc send_inferior { string } {
3998 global inferior_spawn_id
4000 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
4010 proc gdb_expect { args } {
4011 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4012 set atimeout [lindex $args 0]
4013 set expcode [list [lindex $args 1]]
4018 # A timeout argument takes precedence, otherwise of all the timeouts
4019 # select the largest.
4020 if [info exists atimeout] {
4023 set tmt [get_largest_timeout]
4026 global suppress_flag
4027 global remote_suppress_flag
4028 if [info exists remote_suppress_flag] {
4029 set old_val $remote_suppress_flag
4031 if [info exists suppress_flag] {
4032 if { $suppress_flag } {
4033 set remote_suppress_flag 1
4037 {uplevel remote_expect host $tmt $expcode} string]
4038 if [info exists old_val] {
4039 set remote_suppress_flag $old_val
4041 if [info exists remote_suppress_flag] {
4042 unset remote_suppress_flag
4047 global errorInfo errorCode
4049 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4051 return -code $code $string
4055 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4057 # Check for long sequence of output by parts.
4058 # TEST: is the test message to be printed with the test success/fail.
4059 # SENTINEL: Is the terminal pattern indicating that output has finished.
4060 # LIST: is the sequence of outputs to match.
4061 # If the sentinel is recognized early, it is considered an error.
4064 # 1 if the test failed,
4065 # 0 if the test passes,
4066 # -1 if there was an internal error.
4068 proc gdb_expect_list {test sentinel list} {
4070 global suppress_flag
4073 if { $suppress_flag } {
4075 unresolved "${test}"
4077 while { ${index} < [llength ${list}] } {
4078 set pattern [lindex ${list} ${index}]
4079 set index [expr ${index} + 1]
4080 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4081 if { ${index} == [llength ${list}] } {
4084 -re "${pattern}${sentinel}" {
4085 # pass "${test}, pattern ${index} + sentinel"
4088 fail "${test} (pattern ${index} + sentinel)"
4091 -re ".*A problem internal to GDB has been detected" {
4092 fail "${test} (GDB internal error)"
4094 gdb_internal_error_resync
4097 fail "${test} (pattern ${index} + sentinel) (timeout)"
4102 # unresolved "${test}, pattern ${index} + sentinel"
4108 # pass "${test}, pattern ${index}"
4111 fail "${test} (pattern ${index})"
4114 -re ".*A problem internal to GDB has been detected" {
4115 fail "${test} (GDB internal error)"
4117 gdb_internal_error_resync
4120 fail "${test} (pattern ${index}) (timeout)"
4125 # unresolved "${test}, pattern ${index}"
4139 proc gdb_suppress_entire_file { reason } {
4140 global suppress_flag
4143 set suppress_flag -1
4147 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4148 # gdb_expect to fail immediately (until the next call to
4149 # gdb_stop_suppressing_tests).
4151 proc gdb_suppress_tests { args } {
4152 global suppress_flag
4154 return; # fnf - disable pending review of results where
4155 # testsuite ran better without this
4158 if { $suppress_flag == 1 } {
4159 if { [llength $args] > 0 } {
4160 warning "[lindex $args 0]\n"
4162 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4168 # Clear suppress_flag.
4170 proc gdb_stop_suppressing_tests { } {
4171 global suppress_flag
4173 if [info exists suppress_flag] {
4174 if { $suppress_flag > 0 } {
4176 clone_output "Tests restarted.\n"
4183 proc gdb_clear_suppressed { } {
4184 global suppress_flag
4189 # Spawn the gdb process.
4191 # This doesn't expect any output or do any other initialization,
4192 # leaving those to the caller.
4194 # Overridable function -- you can override this function in your
4197 proc gdb_spawn { } {
4201 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4203 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4206 set saved_gdbflags $GDBFLAGS
4208 if {$GDBFLAGS != ""} {
4211 append GDBFLAGS $cmdline_flags
4215 set GDBFLAGS $saved_gdbflags
4220 # Start gdb running, wait for prompt, and disable the pagers.
4222 # Overridable function -- you can override this function in your
4225 proc gdb_start { } {
4230 catch default_gdb_exit
4233 # Return true if we can spawn a program on the target and attach to
4236 proc can_spawn_for_attach { } {
4237 # We use exp_pid to get the inferior's pid, assuming that gives
4238 # back the pid of the program. On remote boards, that would give
4239 # us instead the PID of e.g., the ssh client, etc.
4240 if [is_remote target] then {
4244 # The "attach" command doesn't make sense when the target is
4245 # stub-like, where GDB finds the program already started on
4246 # initial connection.
4247 if {[target_info exists use_gdb_stub]} {
4255 # Kill a progress previously started with spawn_wait_for_attach, and
4256 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4259 proc kill_wait_spawned_process { proc_spawn_id } {
4260 set pid [exp_pid -i $proc_spawn_id]
4262 verbose -log "killing ${pid}"
4263 remote_exec build "kill -9 ${pid}"
4265 verbose -log "closing ${proc_spawn_id}"
4266 catch "close -i $proc_spawn_id"
4267 verbose -log "waiting for ${proc_spawn_id}"
4269 # If somehow GDB ends up still attached to the process here, a
4270 # blocking wait hangs until gdb is killed (or until gdb / the
4271 # ptracer reaps the exit status too, but that won't happen because
4272 # something went wrong.) Passing -nowait makes expect tell Tcl to
4273 # wait for the PID in the background. That's fine because we
4274 # don't care about the exit status. */
4275 wait -nowait -i $proc_spawn_id
4278 # Returns the process id corresponding to the given spawn id.
4280 proc spawn_id_get_pid { spawn_id } {
4281 set testpid [exp_pid -i $spawn_id]
4283 if { [istarget "*-*-cygwin*"] } {
4284 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4285 # might be different due to the way fork/exec works.
4286 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4292 # Start a set of programs running and then wait for a bit, to be sure
4293 # that they can be attached to. Return a list of processes spawn IDs,
4294 # one element for each process spawned. It's a test error to call
4295 # this when [can_spawn_for_attach] is false.
4297 proc spawn_wait_for_attach { executable_list } {
4298 set spawn_id_list {}
4300 if ![can_spawn_for_attach] {
4301 # The caller should have checked can_spawn_for_attach itself
4302 # before getting here.
4303 error "can't spawn for attach with this target/board"
4306 foreach {executable} $executable_list {
4307 # Note we use Expect's spawn, not Tcl's exec, because with
4308 # spawn we control when to wait for/reap the process. That
4309 # allows killing the process by PID without being subject to
4311 lappend spawn_id_list [remote_spawn target $executable]
4316 return $spawn_id_list
4320 # gdb_load_cmd -- load a file into the debugger.
4321 # ARGS - additional args to load command.
4322 # return a -1 if anything goes wrong.
4324 proc gdb_load_cmd { args } {
4327 if [target_info exists gdb_load_timeout] {
4328 set loadtimeout [target_info gdb_load_timeout]
4330 set loadtimeout 1600
4332 send_gdb "load $args\n"
4333 verbose "Timeout is now $loadtimeout seconds" 2
4334 gdb_expect $loadtimeout {
4335 -re "Loading section\[^\r\]*\r\n" {
4338 -re "Start address\[\r\]*\r\n" {
4341 -re "Transfer rate\[\r\]*\r\n" {
4344 -re "Memory access error\[^\r\]*\r\n" {
4345 perror "Failed to load program"
4348 -re "$gdb_prompt $" {
4351 -re "(.*)\r\n$gdb_prompt " {
4352 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4356 perror "Timed out trying to load $args."
4363 # Invoke "gcore". CORE is the name of the core file to write. TEST
4364 # is the name of the test case. This will return 1 if the core file
4365 # was created, 0 otherwise. If this fails to make a core file because
4366 # this configuration of gdb does not support making core files, it
4367 # will call "unsupported", not "fail". However, if this fails to make
4368 # a core file for some other reason, then it will call "fail".
4370 proc gdb_gcore_cmd {core test} {
4374 gdb_test_multiple "gcore $core" $test {
4375 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4379 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4387 # Load core file CORE. TEST is the name of the test case.
4388 # This will record a pass/fail for loading the core file.
4390 # 1 - core file is successfully loaded
4391 # 0 - core file loaded but has a non fatal error
4392 # -1 - core file failed to load
4394 proc gdb_core_cmd { core test } {
4397 gdb_test_multiple "core $core" "$test" {
4398 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4401 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4402 fail "$test (bad file format)"
4405 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4406 fail "$test (file not found)"
4409 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4410 fail "$test (incomplete note section)"
4413 -re "Core was generated by .*\r\n$gdb_prompt $" {
4417 -re ".*$gdb_prompt $" {
4422 fail "$test (timeout)"
4426 fail "unsupported output from 'core' command"
4430 # Return the filename to download to the target and load on the target
4431 # for this shared library. Normally just LIBNAME, unless shared libraries
4432 # for this target have separate link and load images.
4434 proc shlib_target_file { libname } {
4438 # Return the filename GDB will load symbols from when debugging this
4439 # shared library. Normally just LIBNAME, unless shared libraries for
4440 # this target have separate link and load images.
4442 proc shlib_symbol_file { libname } {
4446 # Return the filename to download to the target and load for this
4447 # executable. Normally just BINFILE unless it is renamed to something
4448 # else for this target.
4450 proc exec_target_file { binfile } {
4454 # Return the filename GDB will load symbols from when debugging this
4455 # executable. Normally just BINFILE unless executables for this target
4456 # have separate files for symbols.
4458 proc exec_symbol_file { binfile } {
4462 # Rename the executable file. Normally this is just BINFILE1 being renamed
4463 # to BINFILE2, but some targets require multiple binary files.
4464 proc gdb_rename_execfile { binfile1 binfile2 } {
4465 file rename -force [exec_target_file ${binfile1}] \
4466 [exec_target_file ${binfile2}]
4467 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4468 file rename -force [exec_symbol_file ${binfile1}] \
4469 [exec_symbol_file ${binfile2}]
4473 # "Touch" the executable file to update the date. Normally this is just
4474 # BINFILE, but some targets require multiple files.
4475 proc gdb_touch_execfile { binfile } {
4476 set time [clock seconds]
4477 file mtime [exec_target_file ${binfile}] $time
4478 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4479 file mtime [exec_symbol_file ${binfile}] $time
4483 # Like remote_download but provides a gdb-specific behavior.
4485 # If the destination board is remote, the local file FROMFILE is transferred as
4486 # usual with remote_download to TOFILE on the remote board. The destination
4487 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4490 # If the destination board is local, the destination path TOFILE is passed
4491 # through standard_output_file, and FROMFILE is copied there.
4493 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4496 proc gdb_remote_download {dest fromfile {tofile {}}} {
4497 # If TOFILE is not given, default to the same filename as FROMFILE.
4498 if {[string length $tofile] == 0} {
4499 set tofile [file tail $fromfile]
4502 if {[is_remote $dest]} {
4503 # When the DEST is remote, we simply send the file to DEST.
4506 set destname [remote_download $dest $fromfile $tofile]
4507 lappend cleanfiles $destname
4511 # When the DEST is local, we copy the file to the test directory (where
4512 # the executable is).
4514 # Note that we pass TOFILE through standard_output_file, regardless of
4515 # whether it is absolute or relative, because we don't want the tests
4516 # to be able to write outside their standard output directory.
4518 set tofile [standard_output_file $tofile]
4520 file copy -force $fromfile $tofile
4526 # gdb_load_shlib LIB...
4528 # Copy the listed library to the target.
4530 proc gdb_load_shlib { file } {
4533 if ![info exists gdb_spawn_id] {
4534 perror "gdb_load_shlib: GDB is not running"
4537 set dest [gdb_remote_download target [shlib_target_file $file]]
4539 if {[is_remote target]} {
4540 # If the target is remote, we need to tell gdb where to find the
4543 # We could set this even when not testing remotely, but a user
4544 # generally won't set it unless necessary. In order to make the tests
4545 # more like the real-life scenarios, we don't set it for local testing.
4546 gdb_test "set solib-search-path [file dirname $file]" "" ""
4553 # gdb_load -- load a file into the debugger. Specifying no file
4554 # defaults to the executable currently being debugged.
4555 # The return value is 0 for success, -1 for failure.
4556 # Many files in config/*.exp override this procedure.
4558 proc gdb_load { arg } {
4560 return [gdb_file_cmd $arg]
4565 # gdb_reload -- load a file into the target. Called before "running",
4566 # either the first time or after already starting the program once,
4567 # for remote targets. Most files that override gdb_load should now
4568 # override this instead.
4570 proc gdb_reload { } {
4571 # For the benefit of existing configurations, default to gdb_load.
4572 # Specifying no file defaults to the executable currently being
4574 return [gdb_load ""]
4577 proc gdb_continue { function } {
4580 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4583 proc default_gdb_init { test_file_name } {
4584 global gdb_wrapper_initialized
4585 global gdb_wrapper_target
4586 global gdb_test_file_name
4592 gdb_clear_suppressed
4594 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4596 # Make sure that the wrapper is rebuilt
4597 # with the appropriate multilib option.
4598 if { $gdb_wrapper_target != [current_target_name] } {
4599 set gdb_wrapper_initialized 0
4602 # Unlike most tests, we have a small number of tests that generate
4603 # a very large amount of output. We therefore increase the expect
4604 # buffer size to be able to contain the entire test output. This
4605 # is especially needed by gdb.base/info-macros.exp.
4607 # Also set this value for the currently running GDB.
4608 match_max [match_max -d]
4610 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4611 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4614 if [target_info exists gdb_prompt] {
4615 set gdb_prompt [target_info gdb_prompt]
4617 set gdb_prompt "\\(gdb\\)"
4620 if [info exists use_gdb_stub] {
4625 # Return a path using GDB_PARALLEL.
4626 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4627 # GDB_PARALLEL must be defined, the caller must check.
4629 # The default value for GDB_PARALLEL is, canonically, ".".
4630 # The catch is that tests don't expect an additional "./" in file paths so
4631 # omit any directory for the default case.
4632 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4633 # its special handling.
4635 proc make_gdb_parallel_path { args } {
4636 global GDB_PARALLEL objdir
4637 set joiner [list "file" "join" $objdir]
4638 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4639 lappend joiner $GDB_PARALLEL
4641 set joiner [concat $joiner $args]
4642 return [eval $joiner]
4645 # Turn BASENAME into a full file name in the standard output
4646 # directory. It is ok if BASENAME is the empty string; in this case
4647 # the directory is returned.
4649 proc standard_output_file {basename} {
4650 global objdir subdir gdb_test_file_name
4652 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4654 return [file join $dir $basename]
4657 # Turn BASENAME into a full file name in the standard output directory. If
4658 # GDB has been launched more than once then append the count, starting with
4661 proc standard_output_file_with_gdb_instance {basename} {
4662 global gdb_instances
4663 set count [expr $gdb_instances - 1 ]
4666 return [standard_output_file $basename]
4668 return [standard_output_file ${basename}.${count}]
4671 # Return the name of a file in our standard temporary directory.
4673 proc standard_temp_file {basename} {
4674 # Since a particular runtest invocation is only executing a single test
4675 # file at any given time, we can use the runtest pid to build the
4676 # path of the temp directory.
4677 set dir [make_gdb_parallel_path temp [pid]]
4679 return [file join $dir $basename]
4682 # Set 'testfile', 'srcfile', and 'binfile'.
4684 # ARGS is a list of source file specifications.
4685 # Without any arguments, the .exp file's base name is used to
4686 # compute the source file name. The ".c" extension is added in this case.
4687 # If ARGS is not empty, each entry is a source file specification.
4688 # If the specification starts with a ".", it is treated as a suffix
4689 # to append to the .exp file's base name.
4690 # If the specification is the empty string, it is treated as if it
4692 # Otherwise it is a file name.
4693 # The first file in the list is used to set the 'srcfile' global.
4694 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4696 # Most tests should call this without arguments.
4698 # If a completely different binary file name is needed, then it
4699 # should be handled in the .exp file with a suitable comment.
4701 proc standard_testfile {args} {
4702 global gdb_test_file_name
4704 global gdb_test_file_last_vars
4707 global testfile binfile
4709 set testfile $gdb_test_file_name
4710 set binfile [standard_output_file ${testfile}]
4712 if {[llength $args] == 0} {
4716 # Unset our previous output variables.
4717 # This can help catch hidden bugs.
4718 if {[info exists gdb_test_file_last_vars]} {
4719 foreach varname $gdb_test_file_last_vars {
4721 catch {unset $varname}
4724 # 'executable' is often set by tests.
4725 set gdb_test_file_last_vars {executable}
4729 set varname srcfile$suffix
4732 # Handle an extension.
4735 } elseif {[string range $arg 0 0] == "."} {
4736 set arg $testfile$arg
4740 lappend gdb_test_file_last_vars $varname
4742 if {$suffix == ""} {
4750 # The default timeout used when testing GDB commands. We want to use
4751 # the same timeout as the default dejagnu timeout, unless the user has
4752 # already provided a specific value (probably through a site.exp file).
4753 global gdb_test_timeout
4754 if ![info exists gdb_test_timeout] {
4755 set gdb_test_timeout $timeout
4758 # A list of global variables that GDB testcases should not use.
4759 # We try to prevent their use by monitoring write accesses and raising
4760 # an error when that happens.
4761 set banned_variables { bug_id prms_id }
4763 # A list of procedures that GDB testcases should not use.
4764 # We try to prevent their use by monitoring invocations and raising
4765 # an error when that happens.
4766 set banned_procedures { strace }
4768 # gdb_init is called by runtest at start, but also by several
4769 # tests directly; gdb_finish is only called from within runtest after
4770 # each test source execution.
4771 # Placing several traces by repetitive calls to gdb_init leads
4772 # to problems, as only one trace is removed in gdb_finish.
4773 # To overcome this possible problem, we add a variable that records
4774 # if the banned variables and procedures are already traced.
4777 proc gdb_init { test_file_name } {
4778 # Reset the timeout value to the default. This way, any testcase
4779 # that changes the timeout value without resetting it cannot affect
4780 # the timeout used in subsequent testcases.
4781 global gdb_test_timeout
4783 set timeout $gdb_test_timeout
4785 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4786 && [target_info exists gdb_reverse_timeout] } {
4787 set timeout [target_info gdb_reverse_timeout]
4790 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4791 # debugging tool to help confirm that the test suite is
4792 # parallel-safe. You need "inotifywait" from the
4793 # inotify-tools package to use this.
4794 global GDB_INOTIFY inotify_pid
4795 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4796 global outdir tool inotify_log_file
4798 set exclusions {outputs temp gdb[.](log|sum) cache}
4799 set exclusion_re ([join $exclusions |])
4801 set inotify_log_file [standard_temp_file inotify.out]
4802 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4803 --exclude $exclusion_re \
4804 |& tee -a $outdir/$tool.log $inotify_log_file &]
4806 # Wait for the watches; hopefully this is long enough.
4809 # Clear the log so that we don't emit a warning the first time
4811 set fd [open $inotify_log_file w]
4815 # Block writes to all banned variables, and invocation of all
4816 # banned procedures...
4817 global banned_variables
4818 global banned_procedures
4819 global banned_traced
4820 if (!$banned_traced) {
4821 foreach banned_var $banned_variables {
4822 global "$banned_var"
4823 trace add variable "$banned_var" write error
4825 foreach banned_proc $banned_procedures {
4826 global "$banned_proc"
4827 trace add execution "$banned_proc" enter error
4832 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4833 # messages as expected.
4838 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4839 # the test results. Even if /dev/null doesn't exist on the particular
4840 # platform, the readline library will use the default setting just by
4841 # failing to open the file. OTOH, opening /dev/null successfully will
4842 # also result in the default settings being used since nothing will be
4843 # read from this file.
4844 setenv INPUTRC "/dev/null"
4846 # This disables style output, which would interfere with many
4850 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
4851 # during startup. See "man expect" for details about stty_init.
4853 set stty_init "rows 25 cols 80"
4855 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4856 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4857 # especially having color output turned on can cause tests to fail.
4858 setenv GREP_OPTIONS ""
4860 # Clear $gdbserver_reconnect_p.
4861 global gdbserver_reconnect_p
4862 set gdbserver_reconnect_p 1
4863 unset gdbserver_reconnect_p
4865 # Reset GDB number of instances
4866 global gdb_instances
4869 return [default_gdb_init $test_file_name]
4872 proc gdb_finish { } {
4873 global gdbserver_reconnect_p
4877 # Exit first, so that the files are no longer in use.
4880 if { [llength $cleanfiles] > 0 } {
4881 eval remote_file target delete $cleanfiles
4885 # Unblock write access to the banned variables. Dejagnu typically
4886 # resets some of them between testcases.
4887 global banned_variables
4888 global banned_procedures
4889 global banned_traced
4890 if ($banned_traced) {
4891 foreach banned_var $banned_variables {
4892 global "$banned_var"
4893 trace remove variable "$banned_var" write error
4895 foreach banned_proc $banned_procedures {
4896 global "$banned_proc"
4897 trace remove execution "$banned_proc" enter error
4904 set debug_format "unknown"
4906 # Run the gdb command "info source" and extract the debugging format
4907 # information from the output and save it in debug_format.
4909 proc get_debug_format { } {
4915 set debug_format "unknown"
4916 send_gdb "info source\n"
4918 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4919 set debug_format $expect_out(1,string)
4920 verbose "debug format is $debug_format"
4923 -re "No current source file.\r\n$gdb_prompt $" {
4924 perror "get_debug_format used when no current source file"
4927 -re "$gdb_prompt $" {
4928 warning "couldn't check debug format (no valid response)."
4932 warning "couldn't check debug format (timeout)."
4938 # Return true if FORMAT matches the debug format the current test was
4939 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4940 # `*', `[...]', and so on.
4942 # This function depends on variables set by `get_debug_format', above.
4944 proc test_debug_format {format} {
4947 return [expr [string match $format $debug_format] != 0]
4950 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4951 # COFF, stabs, etc). If that format matches the format that the
4952 # current test was compiled with, then the next test is expected to
4953 # fail for any target. Returns 1 if the next test or set of tests is
4954 # expected to fail, 0 otherwise (or if it is unknown). Must have
4955 # previously called get_debug_format.
4956 proc setup_xfail_format { format } {
4957 set ret [test_debug_format $format]
4965 # gdb_get_line_number TEXT [FILE]
4967 # Search the source file FILE, and return the line number of the
4968 # first line containing TEXT. If no match is found, an error is thrown.
4970 # TEXT is a string literal, not a regular expression.
4972 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4973 # specified, and does not start with "/", then it is assumed to be in
4974 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4975 # by changing the callers and the interface at the same time.
4976 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4977 # gdb.base/ena-dis-br.exp.
4979 # Use this function to keep your test scripts independent of the
4980 # exact line numbering of the source file. Don't write:
4982 # send_gdb "break 20"
4984 # This means that if anyone ever edits your test's source file,
4985 # your test could break. Instead, put a comment like this on the
4986 # source file line you want to break at:
4988 # /* breakpoint spot: frotz.exp: test name */
4990 # and then write, in your test script (which we assume is named
4993 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4995 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4998 # % puts "foo [lindex "bar baz" 1]"
5001 # Tcl is quite clever, for a little stringy language.)
5005 # The previous implementation of this procedure used the gdb search command.
5006 # This version is different:
5008 # . It works with MI, and it also works when gdb is not running.
5010 # . It operates on the build machine, not the host machine.
5012 # . For now, this implementation fakes a current directory of
5013 # $srcdir/$subdir to be compatible with the old implementation.
5014 # This will go away eventually and some callers will need to
5017 # . The TEXT argument is literal text and matches literally,
5018 # not a regular expression as it was before.
5020 # . State changes in gdb, such as changing the current file
5021 # and setting $_, no longer happen.
5023 # After a bit of time we can forget about the differences from the
5024 # old implementation.
5026 # --chastain 2004-08-05
5028 proc gdb_get_line_number { text { file "" } } {
5033 if { "$file" == "" } then {
5036 if { ! [regexp "^/" "$file"] } then {
5037 set file "$srcdir/$subdir/$file"
5040 if { [ catch { set fd [open "$file"] } message ] } then {
5045 for { set line 1 } { 1 } { incr line } {
5046 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5049 if { $nchar < 0 } then {
5052 if { [string first "$text" "$body"] >= 0 } then {
5058 if { [ catch { close "$fd" } message ] } then {
5063 error "undefined tag \"$text\""
5069 # Continue the program until it ends.
5071 # MSSG is the error message that gets printed. If not given, a
5073 # COMMAND is the command to invoke. If not given, "continue" is
5075 # ALLOW_EXTRA is a flag indicating whether the test should expect
5076 # extra output between the "Continuing." line and the program
5077 # exiting. By default it is zero; if nonzero, any extra output
5080 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5081 global inferior_exited_re use_gdb_stub
5084 set text "continue until exit"
5086 set text "continue until exit at $mssg"
5094 # By default, we don't rely on exit() behavior of remote stubs --
5095 # it's common for exit() to be implemented as a simple infinite
5096 # loop, or a forced crash/reset. For native targets, by default, we
5097 # assume process exit is reported as such. If a non-reliable target
5098 # is used, we set a breakpoint at exit, and continue to that.
5099 if { [target_info exists exit_is_reliable] } {
5100 set exit_is_reliable [target_info exit_is_reliable]
5102 set exit_is_reliable [expr ! $use_gdb_stub]
5105 if { ! $exit_is_reliable } {
5106 if {![gdb_breakpoint "exit"]} {
5109 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5112 # Continue until we exit. Should not stop again.
5113 # Don't bother to check the output of the program, that may be
5114 # extremely tough for some remote systems.
5116 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5121 proc rerun_to_main {} {
5122 global gdb_prompt use_gdb_stub
5127 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5128 {pass "rerun to main" ; return 0}
5129 -re "$gdb_prompt $"\
5130 {fail "rerun to main" ; return 0}
5131 timeout {fail "(timeout) rerun to main" ; return 0}
5136 -re "The program .* has been started already.*y or n. $" {
5137 send_gdb "y\n" answer
5140 -re "Starting program.*$gdb_prompt $"\
5141 {pass "rerun to main" ; return 0}
5142 -re "$gdb_prompt $"\
5143 {fail "rerun to main" ; return 0}
5144 timeout {fail "(timeout) rerun to main" ; return 0}
5149 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5151 proc exec_has_index_section { executable } {
5152 set readelf_program [gdb_find_readelf]
5153 set res [catch {exec $readelf_program -S $executable \
5154 | grep -E "\.gdb_index|\.debug_names" }]
5161 # Return true if a test should be skipped due to lack of floating
5162 # point support or GDB can't fetch the contents from floating point
5165 gdb_caching_proc gdb_skip_float_test {
5166 if [target_info exists gdb,skip_float_tests] {
5170 # There is an ARM kernel ptrace bug that hardware VFP registers
5171 # are not updated after GDB ptrace set VFP registers. The bug
5172 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5173 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5174 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5175 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5176 # This kernel bug is detected by check how does GDB change the
5177 # program result by changing one VFP register.
5178 if { [istarget "arm*-*-linux*"] } {
5180 set compile_flags {debug nowarnings }
5182 # Set up, compile, and execute a test program having VFP
5184 set src [standard_temp_file arm_vfp[pid].c]
5185 set exe [standard_temp_file arm_vfp[pid].x]
5187 gdb_produce_source $src {
5192 asm ("vldr d0, [%0]" : : "r" (&d));
5193 asm ("vldr d1, [%0]" : : "r" (&d));
5194 asm (".global break_here\n"
5196 asm ("vcmp.f64 d0, d1\n"
5197 "vmrs APSR_nzcv, fpscr\n"
5198 "bne L_value_different\n"
5201 "L_value_different:\n"
5203 "L_end:\n" : "=r" (ret) :);
5205 /* Return $d0 != $d1. */
5210 verbose "compiling testfile $src" 2
5211 set lines [gdb_compile $src $exe executable $compile_flags]
5214 if ![string match "" $lines] then {
5215 verbose "testfile compilation failed, returning 1" 2
5219 # No error message, compilation succeeded so now run it via gdb.
5220 # Run the test up to 5 times to detect whether ptrace can
5221 # correctly update VFP registers or not.
5223 for {set i 0} {$i < 5} {incr i} {
5224 global gdb_prompt srcdir subdir
5228 gdb_reinitialize_dir $srcdir/$subdir
5232 gdb_test "break *break_here"
5233 gdb_continue_to_breakpoint "break_here"
5235 # Modify $d0 to a different value, so the exit code should
5237 gdb_test "set \$d0 = 5.0"
5239 set test "continue to exit"
5240 gdb_test_multiple "continue" "$test" {
5241 -re "exited with code 01.*$gdb_prompt $" {
5243 -re "exited normally.*$gdb_prompt $" {
5244 # However, the exit code is 0. That means something
5245 # wrong in setting VFP registers.
5253 remote_file build delete $exe
5255 return $skip_vfp_test
5260 # Print a message and return true if a test should be skipped
5261 # due to lack of stdio support.
5263 proc gdb_skip_stdio_test { msg } {
5264 if [target_info exists gdb,noinferiorio] {
5265 verbose "Skipping test '$msg': no inferior i/o."
5271 proc gdb_skip_bogus_test { msg } {
5275 # Return true if a test should be skipped due to lack of XML support
5277 # NOTE: This must be called while gdb is *not* running.
5279 gdb_caching_proc gdb_skip_xml_test {
5284 if { [info exists gdb_spawn_id] } {
5285 error "GDB must not be running in gdb_skip_xml_tests."
5288 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5292 gdb_test_multiple "set tdesc filename $xml_file" "" {
5293 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5296 -re ".*$gdb_prompt $" { }
5302 # Return true if argv[0] is available.
5304 gdb_caching_proc gdb_has_argv0 {
5307 # Compile and execute a test program to check whether argv[0] is available.
5308 gdb_simple_compile has_argv0 {
5309 int main (int argc, char **argv) {
5316 proc gdb_has_argv0_1 { exe } {
5317 global srcdir subdir
5318 global gdb_prompt hex
5322 gdb_reinitialize_dir $srcdir/$subdir
5325 # Set breakpoint on main.
5326 gdb_test_multiple "break main" "break main" {
5327 -re "Breakpoint.*${gdb_prompt} $" {
5329 -re "${gdb_prompt} $" {
5336 gdb_test_multiple "" "run to main" {
5337 -re "Breakpoint.*${gdb_prompt} $" {
5339 -re "${gdb_prompt} $" {
5344 set old_elements "200"
5345 set test "show print elements"
5346 gdb_test_multiple $test $test {
5347 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5348 set old_elements $expect_out(1,string)
5351 set old_repeats "200"
5352 set test "show print repeats"
5353 gdb_test_multiple $test $test {
5354 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5355 set old_repeats $expect_out(1,string)
5358 gdb_test_no_output "set print elements unlimited" ""
5359 gdb_test_no_output "set print repeats unlimited" ""
5362 # Check whether argc is 1.
5363 gdb_test_multiple "p argc" "p argc" {
5364 -re " = 1\r\n${gdb_prompt} $" {
5366 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5367 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5370 -re "${gdb_prompt} $" {
5374 -re "${gdb_prompt} $" {
5378 gdb_test_no_output "set print elements $old_elements" ""
5379 gdb_test_no_output "set print repeats $old_repeats" ""
5384 set result [gdb_has_argv0_1 $obj]
5390 && ([istarget *-*-linux*]
5391 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5392 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5393 || [istarget *-*-openbsd*]
5394 || [istarget *-*-darwin*]
5395 || [istarget *-*-solaris*]
5396 || [istarget *-*-aix*]
5397 || [istarget *-*-gnu*]
5398 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5399 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5400 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5401 || [istarget *-*-symbianelf*]
5402 || [istarget *-*-osf*]
5403 || [istarget *-*-dicos*]
5404 || [istarget *-*-nto*]
5405 || [istarget *-*-*vms*]
5406 || [istarget *-*-lynx*178]) } {
5407 fail "argv\[0\] should be available on this target"
5413 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5414 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5415 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5416 # the name of a debuginfo only file. This file will be stored in the same
5419 # Functions for separate debug info testing
5421 # starting with an executable:
5422 # foo --> original executable
5424 # at the end of the process we have:
5425 # foo.stripped --> foo w/o debug info
5426 # foo.debug --> foo's debug info
5427 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5429 # Fetch the build id from the file.
5430 # Returns "" if there is none.
5432 proc get_build_id { filename } {
5433 if { ([istarget "*-*-mingw*"]
5434 || [istarget *-*-cygwin*]) } {
5435 set objdump_program [gdb_find_objdump]
5436 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5437 verbose "result is $result"
5438 verbose "output is $output"
5444 set tmp [standard_output_file "${filename}-tmp"]
5445 set objcopy_program [gdb_find_objcopy]
5446 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5447 verbose "result is $result"
5448 verbose "output is $output"
5453 fconfigure $fi -translation binary
5454 # Skip the NOTE header.
5459 if ![string compare $data ""] then {
5462 # Convert it to hex.
5463 binary scan $data H* data
5468 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5469 # converted to the form: .build-id/ab/cdef1234...89.debug
5470 # Return "" if no build-id found.
5471 proc build_id_debug_filename_get { filename } {
5472 set data [get_build_id $filename]
5473 if { $data == "" } {
5476 regsub {^..} $data {\0/} data
5477 return ".build-id/${data}.debug"
5480 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5481 # list of optional flags. The only currently supported flag is no-main,
5482 # which removes the symbol entry for main from the separate debug file.
5484 # Function returns zero on success. Function will return non-zero failure code
5485 # on some targets not supporting separate debug info (such as i386-msdos).
5487 proc gdb_gnu_strip_debug { dest args } {
5489 # Use the first separate debug info file location searched by GDB so the
5490 # run cannot be broken by some stale file searched with higher precedence.
5491 set debug_file "${dest}.debug"
5493 set strip_to_file_program [transform strip]
5494 set objcopy_program [gdb_find_objcopy]
5496 set debug_link [file tail $debug_file]
5497 set stripped_file "${dest}.stripped"
5499 # Get rid of the debug info, and store result in stripped_file
5500 # something like gdb/testsuite/gdb.base/blah.stripped.
5501 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5502 verbose "result is $result"
5503 verbose "output is $output"
5508 # Workaround PR binutils/10802:
5509 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5510 set perm [file attributes ${dest} -permissions]
5511 file attributes ${stripped_file} -permissions $perm
5513 # Get rid of everything but the debug info, and store result in debug_file
5514 # This will be in the .debug subdirectory, see above.
5515 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5516 verbose "result is $result"
5517 verbose "output is $output"
5522 # If no-main is passed, strip the symbol for main from the separate
5523 # file. This is to simulate the behavior of elfutils's eu-strip, which
5524 # leaves the symtab in the original file only. There's no way to get
5525 # objcopy or strip to remove the symbol table without also removing the
5526 # debugging sections, so this is as close as we can get.
5527 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5528 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5529 verbose "result is $result"
5530 verbose "output is $output"
5534 file delete "${debug_file}"
5535 file rename "${debug_file}-tmp" "${debug_file}"
5538 # Link the two previous output files together, adding the .gnu_debuglink
5539 # section to the stripped_file, containing a pointer to the debug_file,
5540 # save the new file in dest.
5541 # This will be the regular executable filename, in the usual location.
5542 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5543 verbose "result is $result"
5544 verbose "output is $output"
5549 # Workaround PR binutils/10802:
5550 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5551 set perm [file attributes ${stripped_file} -permissions]
5552 file attributes ${dest} -permissions $perm
5557 # Test the output of GDB_COMMAND matches the pattern obtained
5558 # by concatenating all elements of EXPECTED_LINES. This makes
5559 # it possible to split otherwise very long string into pieces.
5560 # If third argument TESTNAME is not empty, it's used as the name of the
5561 # test to be printed on pass/fail.
5562 proc help_test_raw { gdb_command expected_lines {testname {}} } {
5563 if {$testname == {}} {
5564 set message $gdb_command
5566 set message $testname
5568 set expected_output [join $expected_lines ""]
5569 gdb_test "${gdb_command}" "${expected_output}" $message
5572 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
5573 set help_list_trailer {
5574 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5575 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
5576 "Command name abbreviations are allowed if unambiguous\."
5579 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5580 # are regular expressions that should match the beginning of output,
5581 # before the list of commands in that class.
5582 # LIST_OF_COMMANDS are regular expressions that should match the
5583 # list of commands in that class. If empty, the command list will be
5584 # matched automatically. The presence of standard epilogue will be tested
5586 # If last argument TESTNAME is not empty, it's used as the name of the
5587 # test to be printed on pass/fail.
5588 # Notice that the '[' and ']' characters don't need to be escaped for strings
5589 # wrapped in {} braces.
5590 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
5591 global help_list_trailer
5592 if {[llength $list_of_commands]>0} {
5593 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
5594 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
5595 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
5597 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
5600 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5602 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
5603 $l_stock_body $help_list_trailer]
5605 help_test_raw "help ${command_class}" $l_entire_body $testname
5608 # Like test_class_help but specialised to test "help user-defined".
5609 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
5610 test_class_help "user-defined" {
5611 "User-defined commands\.[\r\n]+"
5612 "The commands in this class are those defined by the user\.[\r\n]+"
5613 "Use the \"define\" command to define a command\.[\r\n]+"
5614 } $list_of_commands $testname
5618 # COMMAND_LIST should have either one element -- command to test, or
5619 # two elements -- abbreviated command to test, and full command the first
5620 # element is abbreviation of.
5621 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5622 # are regular expressions that should match the beginning of output,
5623 # before the list of subcommands. The presence of
5624 # subcommand list and standard epilogue will be tested automatically.
5625 proc test_prefix_command_help { command_list expected_initial_lines args } {
5626 global help_list_trailer
5627 set command [lindex $command_list 0]
5628 if {[llength $command_list]>1} {
5629 set full_command [lindex $command_list 1]
5631 set full_command $command
5633 # Use 'list' and not just {} because we want variables to
5634 # be expanded in this list.
5635 set l_stock_body [list\
5636 "List of $full_command subcommands\:.*\[\r\n\]+"\
5637 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
5638 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
5639 if {[llength $args]>0} {
5640 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5642 help_test_raw "help ${command}" $l_entire_body
5646 # Build executable named EXECUTABLE from specifications that allow
5647 # different options to be passed to different sub-compilations.
5648 # TESTNAME is the name of the test; this is passed to 'untested' if
5650 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5651 # contains the option "pthreads", then gdb_compile_pthreads is used.
5652 # ARGS is a flat list of source specifications, of the form:
5653 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5654 # Each SOURCE is compiled to an object file using its OPTIONS,
5655 # using gdb_compile.
5656 # Returns 0 on success, -1 on failure.
5657 proc build_executable_from_specs {testname executable options args} {
5661 set binfile [standard_output_file $executable]
5664 if { [lsearch -exact $options "c++"] >= 0 } {
5665 set info_options "c++"
5667 if [get_compiler_info ${info_options}] {
5671 set func gdb_compile
5672 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5673 if {$func_index != -1} {
5674 set func "${func}_[lindex $options $func_index]"
5677 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5678 # parameter. They also requires $sources while gdb_compile and
5679 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5680 if [string match gdb_compile_shlib* $func] {
5682 foreach {s local_options} $args {
5683 if { [regexp "^/" "$s"] } then {
5684 lappend sources_path "$s"
5686 lappend sources_path "$srcdir/$subdir/$s"
5689 set ret [$func $sources_path "${binfile}" $options]
5690 } elseif {[lsearch -exact $options rust] != -1} {
5692 foreach {s local_options} $args {
5693 if { [regexp "^/" "$s"] } then {
5694 lappend sources_path "$s"
5696 lappend sources_path "$srcdir/$subdir/$s"
5699 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5703 foreach {s local_options} $args {
5704 if { ! [regexp "^/" "$s"] } then {
5705 set s "$srcdir/$subdir/$s"
5707 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5711 lappend objects "${binfile}${i}.o"
5714 set ret [$func $objects "${binfile}" executable $options]
5724 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5725 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5726 # to pass to untested, if something is wrong. OPTIONS are passed
5727 # to gdb_compile directly.
5728 proc build_executable { testname executable {sources ""} {options {debug}} } {
5729 if {[llength $sources]==0} {
5730 set sources ${executable}.c
5733 set arglist [list $testname $executable $options]
5734 foreach source $sources {
5735 lappend arglist $source $options
5738 return [eval build_executable_from_specs $arglist]
5741 # Starts fresh GDB binary and loads an optional executable into GDB.
5742 # Usage: clean_restart [executable]
5743 # EXECUTABLE is the basename of the binary.
5745 proc clean_restart { args } {
5749 if { [llength $args] > 1 } {
5750 error "bad number of args: [llength $args]"
5755 gdb_reinitialize_dir $srcdir/$subdir
5757 if { [llength $args] >= 1 } {
5758 set executable [lindex $args 0]
5759 set binfile [standard_output_file ${executable}]
5764 # Prepares for testing by calling build_executable_full, then
5766 # TESTNAME is the name of the test.
5767 # Each element in ARGS is a list of the form
5768 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5769 # These are passed to build_executable_from_specs, which see.
5770 # The last EXECUTABLE is passed to clean_restart.
5771 # Returns 0 on success, non-zero on failure.
5772 proc prepare_for_testing_full {testname args} {
5773 foreach spec $args {
5774 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5777 set executable [lindex $spec 0]
5779 clean_restart $executable
5783 # Prepares for testing, by calling build_executable, and then clean_restart.
5784 # Please refer to build_executable for parameter description.
5785 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5787 if {[build_executable $testname $executable $sources $options] == -1} {
5790 clean_restart $executable
5795 # Retrieve the value of EXP in the inferior, represented in format
5796 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5797 # print fails. TEST is the test message to use. It can be omitted,
5798 # in which case a test message is built from EXP.
5800 proc get_valueof { fmt exp default {test ""} } {
5804 set test "get valueof \"${exp}\""
5808 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5809 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5810 set val $expect_out(1,string)
5814 fail "$test (timeout)"
5820 # Retrieve the value of EXP in the inferior, as a signed decimal value
5821 # (using "print /d"). DEFAULT is used as fallback if print fails.
5822 # TEST is the test message to use. It can be omitted, in which case
5823 # a test message is built from EXP.
5825 proc get_integer_valueof { exp default {test ""} } {
5829 set test "get integer valueof \"${exp}\""
5833 gdb_test_multiple "print /d ${exp}" "$test" {
5834 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5835 set val $expect_out(1,string)
5839 fail "$test (timeout)"
5845 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5846 # (using "print /x"). DEFAULT is used as fallback if print fails.
5847 # TEST is the test message to use. It can be omitted, in which case
5848 # a test message is built from EXP.
5850 proc get_hexadecimal_valueof { exp default {test ""} } {
5854 set test "get hexadecimal valueof \"${exp}\""
5858 gdb_test_multiple "print /x ${exp}" $test {
5859 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5860 set val $expect_out(1,string)
5867 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5868 # is used as fallback if print fails. TEST is the test message to use.
5869 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5871 proc get_sizeof { type default {test ""} } {
5872 return [get_integer_valueof "sizeof (${type})" $default $test]
5875 proc get_target_charset { } {
5878 gdb_test_multiple "show target-charset" "" {
5879 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5880 return $expect_out(1,string)
5882 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5883 return $expect_out(1,string)
5887 # Pick a reasonable default.
5888 warning "Unable to read target-charset."
5892 # Get the address of VAR.
5894 proc get_var_address { var } {
5895 global gdb_prompt hex
5897 # Match output like:
5899 # $5 = (int (*)()) 0
5900 # $6 = (int (*)()) 0x24 <function_bar>
5902 gdb_test_multiple "print &${var}" "get address of ${var}" {
5903 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5905 pass "get address of ${var}"
5906 if { $expect_out(1,string) == "0" } {
5909 return $expect_out(1,string)
5916 # Return the frame number for the currently selected frame
5917 proc get_current_frame_number {{test_name ""}} {
5920 if { $test_name == "" } {
5921 set test_name "get current frame number"
5924 gdb_test_multiple "frame" $test_name {
5925 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5926 set frame_num $expect_out(1,string)
5932 # Get the current value for remotetimeout and return it.
5933 proc get_remotetimeout { } {
5937 gdb_test_multiple "show remotetimeout" "" {
5938 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5939 return $expect_out(1,string)
5943 # Pick the default that gdb uses
5944 warning "Unable to read remotetimeout"
5948 # Set the remotetimeout to the specified timeout. Nothing is returned.
5949 proc set_remotetimeout { timeout } {
5952 gdb_test_multiple "set remotetimeout $timeout" "" {
5953 -re "$gdb_prompt $" {
5954 verbose "Set remotetimeout to $timeout\n"
5959 # Get the target's current endianness and return it.
5960 proc get_endianness { } {
5963 gdb_test_multiple "show endian" "determine endianness" {
5964 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5966 return $expect_out(1,string)
5972 # ROOT and FULL are file names. Returns the relative path from ROOT
5973 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5974 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5977 proc relative_filename {root full} {
5978 set root_split [file split $root]
5979 set full_split [file split $full]
5981 set len [llength $root_split]
5983 if {[eval file join $root_split]
5984 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5985 error "$full not a subdir of $root"
5988 return [eval file join [lrange $full_split $len end]]
5991 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5992 if {[info exists GDB_PARALLEL]} {
5993 if {[is_remote host]} {
5997 [make_gdb_parallel_path outputs] \
5998 [make_gdb_parallel_path temp] \
5999 [make_gdb_parallel_path cache]
6003 proc core_find {binfile {deletefiles {}} {arg ""}} {
6004 global objdir subdir
6006 set destcore "$binfile.core"
6007 file delete $destcore
6009 # Create a core file named "$destcore" rather than just "core", to
6010 # avoid problems with sys admin types that like to regularly prune all
6011 # files named "core" from the system.
6013 # Arbitrarily try setting the core size limit to "unlimited" since
6014 # this does not hurt on systems where the command does not work and
6015 # allows us to generate a core on systems where it does.
6017 # Some systems append "core" to the name of the program; others append
6018 # the name of the program to "core"; still others (like Linux, as of
6019 # May 2003) create cores named "core.PID". In the latter case, we
6020 # could have many core files lying around, and it may be difficult to
6021 # tell which one is ours, so let's run the program in a subdirectory.
6023 set coredir [standard_output_file coredir.[getpid]]
6025 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6026 # remote_exec host "${binfile}"
6027 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6028 if [remote_file build exists $i] {
6029 remote_exec build "mv $i $destcore"
6033 # Check for "core.PID".
6034 if { $found == 0 } {
6035 set names [glob -nocomplain -directory $coredir core.*]
6036 if {[llength $names] == 1} {
6037 set corefile [file join $coredir [lindex $names 0]]
6038 remote_exec build "mv $corefile $destcore"
6042 if { $found == 0 } {
6043 # The braindamaged HPUX shell quits after the ulimit -c above
6044 # without executing ${binfile}. So we try again without the
6045 # ulimit here if we didn't find a core file above.
6046 # Oh, I should mention that any "braindamaged" non-Unix system has
6047 # the same problem. I like the cd bit too, it's really neat'n stuff.
6048 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6049 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6050 if [remote_file build exists $i] {
6051 remote_exec build "mv $i $destcore"
6057 # Try to clean up after ourselves.
6058 foreach deletefile $deletefiles {
6059 remote_file build delete [file join $coredir $deletefile]
6061 remote_exec build "rmdir $coredir"
6063 if { $found == 0 } {
6064 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6070 # gdb_target_symbol_prefix compiles a test program and then examines
6071 # the output from objdump to determine the prefix (such as underscore)
6072 # for linker symbol prefixes.
6074 gdb_caching_proc gdb_target_symbol_prefix {
6075 # Compile a simple test program...
6076 set src { int main() { return 0; } }
6077 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6083 set objdump_program [gdb_find_objdump]
6084 set result [catch "exec $objdump_program --syms $obj" output]
6087 && ![regexp -lineanchor \
6088 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6089 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6097 # Return 1 if target supports scheduler locking, otherwise return 0.
6099 gdb_caching_proc target_supports_scheduler_locking {
6102 set me "gdb_target_supports_scheduler_locking"
6104 set src { int main() { return 0; } }
6105 if {![gdb_simple_compile $me $src executable]} {
6114 set supports_schedule_locking -1
6115 set current_schedule_locking_mode ""
6117 set test "reading current scheduler-locking mode"
6118 gdb_test_multiple "show scheduler-locking" $test {
6119 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6120 set current_schedule_locking_mode $expect_out(1,string)
6122 -re "$gdb_prompt $" {
6123 set supports_schedule_locking 0
6126 set supports_schedule_locking 0
6130 if { $supports_schedule_locking == -1 } {
6131 set test "checking for scheduler-locking support"
6132 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6133 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6134 set supports_schedule_locking 0
6136 -re "$gdb_prompt $" {
6137 set supports_schedule_locking 1
6140 set supports_schedule_locking 0
6145 if { $supports_schedule_locking == -1 } {
6146 set supports_schedule_locking 0
6150 remote_file build delete $obj
6151 verbose "$me: returning $supports_schedule_locking" 2
6152 return $supports_schedule_locking
6155 # gdb_target_symbol returns the provided symbol with the correct prefix
6156 # prepended. (See gdb_target_symbol_prefix, above.)
6158 proc gdb_target_symbol { symbol } {
6159 set prefix [gdb_target_symbol_prefix]
6160 return "${prefix}${symbol}"
6163 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6164 # added to gdb_compile options to define the C-preprocessor macro
6165 # SYMBOL_PREFIX with a value that can be prepended to symbols
6166 # for targets which require a prefix, such as underscore.
6168 # This version (_asm) defines the prefix without double quotes
6169 # surrounding the prefix. It is used to define the macro
6170 # SYMBOL_PREFIX for assembly language files. Another version, below,
6171 # is used for symbols in inline assembler in C/C++ files.
6173 # The lack of quotes in this version (_asm) makes it possible to
6174 # define supporting macros in the .S file. (The version which
6175 # uses quotes for the prefix won't work for such files since it's
6176 # impossible to define a quote-stripping macro in C.)
6178 # It's possible to use this version (_asm) for C/C++ source files too,
6179 # but a string is usually required in such files; providing a version
6180 # (no _asm) which encloses the prefix with double quotes makes it
6181 # somewhat easier to define the supporting macros in the test case.
6183 proc gdb_target_symbol_prefix_flags_asm {} {
6184 set prefix [gdb_target_symbol_prefix]
6185 if {$prefix ne ""} {
6186 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6192 # gdb_target_symbol_prefix_flags returns the same string as
6193 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6194 # enclosed in double quotes if there is a prefix.
6196 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6197 # extended discussion.
6199 proc gdb_target_symbol_prefix_flags {} {
6200 set prefix [gdb_target_symbol_prefix]
6201 if {$prefix ne ""} {
6202 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6208 # A wrapper for 'remote_exec host' that passes or fails a test.
6209 # Returns 0 if all went well, nonzero on failure.
6210 # TEST is the name of the test, other arguments are as for remote_exec.
6212 proc run_on_host { test program args } {
6213 verbose -log "run_on_host: $program $args"
6214 # remote_exec doesn't work properly if the output is set but the
6215 # input is the empty string -- so replace an empty input with
6217 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6218 set args [lreplace $args 1 1 "/dev/null"]
6220 set result [eval remote_exec host [list $program] $args]
6221 verbose "result is $result"
6222 set status [lindex $result 0]
6223 set output [lindex $result 1]
6228 verbose -log "run_on_host failed: $output"
6234 # Return non-zero if "board_info debug_flags" mentions Fission.
6235 # http://gcc.gnu.org/wiki/DebugFission
6236 # Fission doesn't support everything yet.
6237 # This supports working around bug 15954.
6239 proc using_fission { } {
6240 set debug_flags [board_info [target_info name] debug_flags]
6241 return [regexp -- "-gsplit-dwarf" $debug_flags]
6244 # Search the caller's ARGS list and set variables according to the list of
6245 # valid options described by ARGSET.
6247 # The first member of each one- or two-element list in ARGSET defines the
6248 # name of a variable that will be added to the caller's scope.
6250 # If only one element is given to describe an option, it the value is
6251 # 0 if the option is not present in (the caller's) ARGS or 1 if
6254 # If two elements are given, the second element is the default value of
6255 # the variable. This is then overwritten if the option exists in ARGS.
6257 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6258 # any optional components.
6261 # proc myproc {foo args} {
6262 # parse_args {{bar} {baz "abc"} {qux}}
6265 # myproc ABC -bar -baz DEF peanut butter
6266 # will define the following variables in myproc:
6267 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6268 # args will be the list {peanut butter}
6270 proc parse_args { argset } {
6273 foreach argument $argset {
6274 if {[llength $argument] == 1} {
6275 # No default specified, so we assume that we should set
6276 # the value to 1 if the arg is present and 0 if it's not.
6277 # It is assumed that no value is given with the argument.
6278 set result [lsearch -exact $args "-$argument"]
6279 if {$result != -1} then {
6280 uplevel 1 [list set $argument 1]
6281 set args [lreplace $args $result $result]
6283 uplevel 1 [list set $argument 0]
6285 } elseif {[llength $argument] == 2} {
6286 # There are two items in the argument. The second is a
6287 # default value to use if the item is not present.
6288 # Otherwise, the variable is set to whatever is provided
6289 # after the item in the args.
6290 set arg [lindex $argument 0]
6291 set result [lsearch -exact $args "-[lindex $arg 0]"]
6292 if {$result != -1} then {
6293 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6294 set args [lreplace $args $result [expr $result+1]]
6296 uplevel 1 [list set $arg [lindex $argument 1]]
6299 error "Badly formatted argument \"$argument\" in argument set"
6303 # The remaining args should be checked to see that they match the
6304 # number of items expected to be passed into the procedure...
6307 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6308 # return that string.
6310 proc capture_command_output { command prefix } {
6314 set output_string ""
6315 gdb_test_multiple "$command" "capture_command_output for $command" {
6316 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6317 set output_string $expect_out(1,string)
6320 return $output_string
6323 # A convenience function that joins all the arguments together, with a
6324 # regexp that matches exactly one end of line in between each argument.
6325 # This function is ideal to write the expected output of a GDB command
6326 # that generates more than a couple of lines, as this allows us to write
6327 # each line as a separate string, which is easier to read by a human
6330 proc multi_line { args } {
6331 return [join $args "\r\n"]
6334 # Similar to the above, but while multi_line is meant to be used to
6335 # match GDB output, this one is meant to be used to build strings to
6336 # send as GDB input.
6338 proc multi_line_input { args } {
6339 return [join $args "\n"]
6342 # Return the version of the DejaGnu framework.
6344 # The return value is a list containing the major, minor and patch version
6345 # numbers. If the version does not contain a minor or patch number, they will
6346 # be set to 0. For example:
6352 proc dejagnu_version { } {
6353 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6354 global frame_version
6356 verbose -log "DejaGnu version: $frame_version"
6357 verbose -log "Expect version: [exp_version]"
6358 verbose -log "Tcl version: [info tclversion]"
6360 set dg_ver [split $frame_version .]
6362 while { [llength $dg_ver] < 3 } {
6369 # Define user-defined command COMMAND using the COMMAND_LIST as the
6370 # command's definition. The terminating "end" is added automatically.
6372 proc gdb_define_cmd {command command_list} {
6375 set input [multi_line_input {*}$command_list "end"]
6376 set test "define $command"
6378 gdb_test_multiple "define $command" $test {
6380 gdb_test_multiple $input $test {
6381 -re "\r\n$gdb_prompt " {
6388 # Override the 'cd' builtin with a version that ensures that the
6389 # log file keeps pointing at the same file. We need this because
6390 # unfortunately the path to the log file is recorded using an
6391 # relative path name, and, we sometimes need to close/reopen the log
6392 # after changing the current directory. See get_compiler_info.
6394 rename cd builtin_cd
6398 # Get the existing log file flags.
6399 set log_file_info [log_file -info]
6401 # Split the flags into args and file name.
6402 set log_file_flags ""
6403 set log_file_file ""
6404 foreach arg [ split "$log_file_info" " "] {
6405 if [string match "-*" $arg] {
6406 lappend log_file_flags $arg
6408 lappend log_file_file $arg
6412 # If there was an existing file, ensure it is an absolute path, and then
6414 if { $log_file_file != "" } {
6415 set log_file_file [file normalize $log_file_file]
6417 log_file $log_file_flags "$log_file_file"
6420 # Call the builtin version of cd.
6424 # Return a list of all languages supported by GDB, suitable for use in
6425 # 'set language NAME'. This doesn't include either the 'local' or
6427 proc gdb_supported_languages {} {
6428 return [list c objective-c c++ d go fortran modula-2 asm pascal \
6429 opencl rust minimal ada]
6432 # Check if debugging is enabled for gdb.
6434 proc gdb_debug_enabled { } {
6437 # If not already read, get the debug setting from environment or board setting.
6438 if {![info exists gdbdebug]} {
6440 if [info exists env(GDB_DEBUG)] {
6441 set gdbdebug $env(GDB_DEBUG)
6442 } elseif [target_info exists gdb,debug] {
6443 set gdbdebug [target_info gdb,debug]
6449 # Ensure it not empty.
6450 return [expr { $gdbdebug != "" }]
6453 # Turn on debugging if enabled, or reset if already on.
6455 proc gdb_debug_init { } {
6459 if ![gdb_debug_enabled] {
6463 # First ensure logging is off.
6464 send_gdb "set logging off\n"
6466 set debugfile [standard_output_file gdb.debug]
6467 send_gdb "set logging file $debugfile\n"
6469 send_gdb "set logging debugredirect\n"
6472 foreach entry [split $gdbdebug ,] {
6473 send_gdb "set debug $entry 1\n"
6476 # Now that everything is set, enable logging.
6477 send_gdb "set logging on\n"
6479 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
6480 timeout { warning "Couldn't set logging file" }
6484 # Check if debugging is enabled for gdbserver.
6486 proc gdbserver_debug_enabled { } {
6487 # Always disabled for GDB only setups.
6491 # Open the file for logging gdb input
6493 proc gdb_stdin_log_init { } {
6496 if {[info exists in_file]} {
6497 # Close existing file.
6498 catch "close $in_file"
6501 set logfile [standard_output_file_with_gdb_instance gdb.in]
6502 set in_file [open $logfile w]
6505 # Write to the file for logging gdb input.
6506 # TYPE can be one of the following:
6507 # "standard" : Default. Standard message written to the log
6508 # "answer" : Answer to a question (eg "Y"). Not written the log.
6509 # "optional" : Optional message. Not written to the log.
6511 proc gdb_stdin_log_write { message {type standard} } {
6514 if {![info exists in_file]} {
6518 # Check message types.
6519 switch -regexp -- $type {
6529 puts -nonewline $in_file "$message"
6532 # Write the command line used to invocate gdb to the cmd file.
6534 proc gdb_write_cmd_file { cmdline } {
6535 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
6536 set cmd_file [open $logfile w]
6537 puts $cmd_file $cmdline
6538 catch "close $cmd_file"
6541 # Always load compatibility stuff.