1 # Copyright 1992-2019 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
89 # absolute path ie. /foo/
90 set fullname_syntax_POSIX {/[^\n]*/}
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
92 # UNC path ie. \\D\foo\
93 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
96 # ie. \foo\, but don't match \\.*\
97 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
99 # ie. a:\foo\ && a:foo\
100 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
103 # d:foo and \abc should be considered valid as an absolute path.
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
112 if ![info exists env(EXEEXT)] {
115 set EXEEXT $env(EXEEXT)
120 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
122 # A regular expression that matches a value history number.
124 set valnum_re "\\\$$decimal"
126 ### Only procedures should come after this point.
129 # gdb_version -- extract and print the version number of GDB
131 proc default_gdb_version {} {
133 global INTERNAL_GDBFLAGS GDBFLAGS
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
144 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
145 if ![is_remote host] {
146 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
148 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
152 proc gdb_version { } {
153 return [default_gdb_version]
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
173 -re "Discard symbol table from .*y or n.*$" {
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # The second pattern below matches up to the first newline *only*.
246 # Using ``.*$'' could swallow up output that we attempt to match
249 # N.B. This function does not wait for gdb to return to the prompt,
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
256 send_gdb "$command\n"
258 -re "$gdb_prompt $" { }
260 perror "gdb_init_command for target failed"
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
271 send_gdb "continue\n"
273 -re "Continu\[^\r\n\]*\[\r\n\]" {}
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
284 send_gdb "jump *$start\n"
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
290 if [expr $start_attempt > 3] {
291 perror "Jump to start() failed (retry count exceeded)"
294 set start_attempt [expr $start_attempt + 1]
296 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
299 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
300 perror "Can't find start symbol to run in gdb_run"
303 -re "No symbol \"start\" in current.*$gdb_prompt $" {
304 send_gdb "jump *_start\n"
306 -re "No symbol.*context.*$gdb_prompt $" {
309 -re "Line.* Jump anyway.*y or n. $" {
312 -re "The program is not being run.*$gdb_prompt $" {
313 if { [gdb_reload] != 0 } {
316 send_gdb "jump *$start\n"
319 perror "Jump to start() failed (timeout)"
327 if [target_info exists gdb,do_reload_on_run] {
328 if { [gdb_reload] != 0 } {
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
337 -re "The program .* has been started already.*y or n. $" {
341 -notransfer -re "Starting program: \[^\r\n\]*" {}
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
348 # Generic start command. Return 0 if we could start the program, -1
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
354 proc gdb_start_cmd {args} {
355 global gdb_prompt use_gdb_stub
357 foreach command [gdb_init_commands] {
358 send_gdb "$command\n"
360 -re "$gdb_prompt $" { }
362 perror "gdb_init_command for target failed"
372 send_gdb "start $args\n"
373 # Use -notransfer here so that test cases (like chng-sym.exp)
374 # may test for additional start-up messages.
376 -re "The program .* has been started already.*y or n. $" {
380 -notransfer -re "Starting program: \[^\r\n\]*" {
387 # Generic starti command. Return 0 if we could start the program, -1
390 # N.B. This function does not wait for gdb to return to the prompt,
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
397 send_gdb "$command\n"
399 -re "$gdb_prompt $" { }
401 perror "gdb_init_command for target failed"
411 send_gdb "starti $args\n"
413 -re "The program .* has been started already.*y or n. $" {
417 -re "Starting program: \[^\r\n\]*" {
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
429 # Note: The handling of message vs no-message is messed up, but it's based
430 # on historical usage. By default this function does not print passes,
432 # no-message: turns off printing of fails (and passes, but they're already off)
433 # message: turns on printing of passes (and fails, but they're already on)
435 proc gdb_breakpoint { function args } {
439 set pending_response n
440 if {[lsearch -exact $args allow-pending] != -1} {
441 set pending_response y
444 set break_command "break"
445 set break_message "Breakpoint"
446 if {[lsearch -exact $args temporary] != -1} {
447 set break_command "tbreak"
448 set break_message "Temporary breakpoint"
451 if {[lsearch -exact $args qualified] != -1} {
452 append break_command " -qualified"
457 set no_message_loc [lsearch -exact $args no-message]
458 set message_loc [lsearch -exact $args message]
459 # The last one to appear in args wins.
460 if { $no_message_loc > $message_loc } {
462 } elseif { $message_loc > $no_message_loc } {
466 set test_name "setting breakpoint at $function"
468 send_gdb "$break_command $function\n"
469 # The first two regexps are what we get with -g, the third is without -g.
471 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
474 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
475 if {$pending_response == "n"} {
482 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
483 send_gdb "$pending_response\n"
486 -re "A problem internal to GDB has been detected" {
488 fail "$test_name (GDB internal error)"
490 gdb_internal_error_resync
493 -re "$gdb_prompt $" {
501 fail "$test_name (eof)"
507 fail "$test_name (timeout)"
518 # Set breakpoint at function and run gdb until it breaks there.
519 # Since this is the only breakpoint that will be set, if it stops
520 # at a breakpoint, we will assume it is the one we want. We can't
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
529 # no-message: turns off printing of fails (and passes, but they're already off)
530 # message: turns on printing of passes (and fails, but they're already on)
532 proc runto { function args } {
538 # Default to "no-message".
539 set args "no-message $args"
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
548 } elseif { $message_loc > $no_message_loc } {
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
557 # elements, and we don't want Tcl to move the remaining elements after
558 # the first to $args. That is why $function is wrapped in {}.
559 if ![eval gdb_breakpoint {$function} $args] {
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
568 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
574 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
580 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
582 unsupported "non-stop mode not supported"
586 -re ".*A problem internal to GDB has been detected" {
588 fail "$test_name (GDB internal error)"
590 gdb_internal_error_resync
593 -re "$gdb_prompt $" {
601 fail "$test_name (eof)"
607 fail "$test_name (timeout)"
618 # Ask gdb to run until we hit a breakpoint at main.
620 # N.B. This function deletes all existing breakpoints.
621 # If you don't want that, use gdb_start_cmd.
623 proc runto_main { } {
624 return [runto main no-message]
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
634 set full_name "continue to breakpoint: $name"
636 gdb_test_multiple "continue" $full_name {
637 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
644 # gdb_internal_error_resync:
646 # Answer the questions GDB asks after it reports an internal error
647 # until we get back to a GDB prompt. Decline to quit the debugging
648 # session, and decline to create a core file. Return non-zero if the
651 # This procedure just answers whatever questions come up until it sees
652 # a GDB prompt; it doesn't require you to have matched the input up to
653 # any specific point. However, it only answers questions it sees in
654 # the output itself, so if you've matched a question, you had better
655 # answer it yourself before calling this.
657 # You can use this function thus:
661 # -re ".*A problem internal to GDB has been detected" {
662 # gdb_internal_error_resync
667 proc gdb_internal_error_resync {} {
670 verbose -log "Resyncing due to internal error."
673 while {$count < 10} {
675 -re "Quit this debugging session\\? \\(y or n\\) $" {
679 -re "Create a core file of GDB\\? \\(y or n\\) $" {
683 -re "$gdb_prompt $" {
684 # We're resynchronized.
688 perror "Could not resync from internal error (timeout)"
693 perror "Could not resync from internal error (resync count exceeded)"
698 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
699 # Send a command to gdb; test the result.
701 # COMMAND is the command to execute, send to GDB with send_gdb. If
702 # this is the null string no command is sent.
703 # MESSAGE is a message to be printed with the built-in failure patterns
704 # if one of them matches. If MESSAGE is empty COMMAND will be used.
705 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
706 # patterns. Pattern elements will be evaluated in the caller's
707 # context; action elements will be executed in the caller's context.
708 # Unlike patterns for gdb_test, these patterns should generally include
709 # the final newline and prompt.
712 # 1 if the test failed, according to a built-in failure pattern
713 # 0 if only user-supplied patterns matched
714 # -1 if there was an internal error.
716 # You can use this function thus:
718 # gdb_test_multiple "print foo" "test foo" {
719 # -re "expected output 1" {
722 # -re "expected output 2" {
727 # Like with "expect", you can also specify the spawn id to match with
728 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
729 # $gdb_spawn_id. The former matches inferior I/O, while the latter
730 # matches GDB I/O. E.g.:
732 # send_inferior "hello\n"
733 # gdb_test_multiple "continue" "test echo" {
734 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
737 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
738 # fail "hit breakpoint"
742 # The standard patterns, such as "Inferior exited..." and "A problem
743 # ...", all being implicitly appended to that list. These are always
744 # expected from $gdb_spawn_id. IOW, callers do not need to worry
745 # about resetting "-i" back to $gdb_spawn_id explicitly.
747 proc gdb_test_multiple { command message user_code } {
748 global verbose use_gdb_stub
749 global gdb_prompt pagination_prompt
752 global inferior_exited_re
753 upvar timeout timeout
754 upvar expect_out expect_out
757 if { $message == "" } {
761 if [string match "*\[\r\n\]" $command] {
762 error "Invalid trailing newline in \"$message\" test"
765 if [string match "*\[\r\n\]*" $message] {
766 error "Invalid newline in \"$message\" test"
770 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
772 error "gdbserver does not support $command without extended-remote"
775 # TCL/EXPECT WART ALERT
776 # Expect does something very strange when it receives a single braced
777 # argument. It splits it along word separators and performs substitutions.
778 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
779 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
780 # double-quoted list item, "\[ab\]" is just a long way of representing
781 # "[ab]", because the backslashes will be removed by lindex.
783 # Unfortunately, there appears to be no easy way to duplicate the splitting
784 # that expect will do from within TCL. And many places make use of the
785 # "\[0-9\]" construct, so we need to support that; and some places make use
786 # of the "[func]" construct, so we need to support that too. In order to
787 # get this right we have to substitute quoted list elements differently
788 # from braced list elements.
790 # We do this roughly the same way that Expect does it. We have to use two
791 # lists, because if we leave unquoted newlines in the argument to uplevel
792 # they'll be treated as command separators, and if we escape newlines
793 # we mangle newlines inside of command blocks. This assumes that the
794 # input doesn't contain a pattern which contains actual embedded newlines
797 regsub -all {\n} ${user_code} { } subst_code
798 set subst_code [uplevel list $subst_code]
800 set processed_code ""
802 set expecting_action 0
804 foreach item $user_code subst_item $subst_code {
805 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
806 lappend processed_code $item
809 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
810 lappend processed_code $item
813 if { $item == "-timeout" || $item == "-i" } {
815 lappend processed_code $item
818 if { $expecting_arg } {
820 lappend processed_code $subst_item
823 if { $expecting_action } {
824 lappend processed_code "uplevel [list $item]"
825 set expecting_action 0
826 # Cosmetic, no effect on the list.
827 append processed_code "\n"
830 set expecting_action 1
831 lappend processed_code $subst_item
832 if {$patterns != ""} {
835 append patterns "\"$subst_item\""
838 # Also purely cosmetic.
839 regsub -all {\r} $patterns {\\r} patterns
840 regsub -all {\n} $patterns {\\n} patterns
843 send_user "Sending \"$command\" to gdb\n"
844 send_user "Looking to match \"$patterns\"\n"
845 send_user "Message is \"$message\"\n"
849 set string "${command}\n"
850 if { $command != "" } {
851 set multi_line_re "\[\r\n\] *>"
852 while { "$string" != "" } {
853 set foo [string first "\n" "$string"]
854 set len [string length "$string"]
855 if { $foo < [expr $len - 1] } {
856 set str [string range "$string" 0 $foo]
857 if { [send_gdb "$str"] != "" } {
860 if { ! $suppress_flag } {
861 perror "Couldn't send $command to GDB."
866 # since we're checking if each line of the multi-line
867 # command are 'accepted' by GDB here,
868 # we need to set -notransfer expect option so that
869 # command output is not lost for pattern matching
872 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
873 timeout { verbose "partial: timeout" 3 }
875 set string [string range "$string" [expr $foo + 1] end]
876 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
881 if { "$string" != "" } {
882 if { [send_gdb "$string"] != "" } {
885 if { ! $suppress_flag } {
886 perror "Couldn't send $command to GDB."
895 -re ".*A problem internal to GDB has been detected" {
896 fail "$message (GDB internal error)"
897 gdb_internal_error_resync
900 -re "\\*\\*\\* DOSEXIT code.*" {
901 if { $message != "" } {
904 gdb_suppress_entire_file "GDB died"
908 append code $processed_code
910 # Reset the spawn id, in case the processed code used -i.
913 -re "Ending remote debugging.*$gdb_prompt $" {
914 if ![isnative] then {
915 warning "Can`t communicate to remote target."
921 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
922 perror "Undefined command \"$command\"."
926 -re "Ambiguous command.*$gdb_prompt $" {
927 perror "\"$command\" is not a unique command name."
931 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
932 if ![string match "" $message] then {
933 set errmsg "$message (the program exited)"
935 set errmsg "$command (the program exited)"
940 -re "$inferior_exited_re normally.*$gdb_prompt $" {
941 if ![string match "" $message] then {
942 set errmsg "$message (the program exited)"
944 set errmsg "$command (the program exited)"
949 -re "The program is not being run.*$gdb_prompt $" {
950 if ![string match "" $message] then {
951 set errmsg "$message (the program is no longer running)"
953 set errmsg "$command (the program is no longer running)"
958 -re "\r\n$gdb_prompt $" {
959 if ![string match "" $message] then {
964 -re "$pagination_prompt" {
966 perror "Window too small."
970 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
972 gdb_expect -re "$gdb_prompt $"
973 fail "$message (got interactive prompt)"
976 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
978 gdb_expect -re "$gdb_prompt $"
979 fail "$message (got breakpoint menu)"
985 perror "GDB process no longer exists"
986 set wait_status [wait -i $gdb_spawn_id]
987 verbose -log "GDB process exited with wait status $wait_status"
988 if { $message != "" } {
994 # Patterns below apply to any spawn id specified.
997 perror "Process no longer exists"
998 if { $message != "" } {
1004 perror "internal buffer is full."
1009 if ![string match "" $message] then {
1010 fail "$message (timeout)"
1017 set code [catch {gdb_expect $code} string]
1019 global errorInfo errorCode
1020 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1021 } elseif {$code > 1} {
1022 return -code $code $string
1027 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1028 # Send a command to gdb; test the result.
1030 # COMMAND is the command to execute, send to GDB with send_gdb. If
1031 # this is the null string no command is sent.
1032 # PATTERN is the pattern to match for a PASS, and must NOT include
1033 # the \r\n sequence immediately before the gdb prompt. This argument
1034 # may be omitted to just match the prompt, ignoring whatever output
1036 # MESSAGE is an optional message to be printed. If this is
1037 # omitted, then the pass/fail messages use the command string as the
1038 # message. (If this is the empty string, then sometimes we don't
1039 # call pass or fail at all; I don't understand this at all.)
1040 # QUESTION is a question GDB may ask in response to COMMAND, like
1042 # RESPONSE is the response to send if QUESTION appears.
1045 # 1 if the test failed,
1046 # 0 if the test passes,
1047 # -1 if there was an internal error.
1049 proc gdb_test { args } {
1051 upvar timeout timeout
1053 if [llength $args]>2 then {
1054 set message [lindex $args 2]
1056 set message [lindex $args 0]
1058 set command [lindex $args 0]
1059 set pattern [lindex $args 1]
1061 if [llength $args]==5 {
1062 set question_string [lindex $args 3]
1063 set response_string [lindex $args 4]
1065 set question_string "^FOOBAR$"
1068 return [gdb_test_multiple $command $message {
1069 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1070 if ![string match "" $message] then {
1074 -re "(${question_string})$" {
1075 send_gdb "$response_string\n"
1081 # gdb_test_no_output COMMAND MESSAGE
1082 # Send a command to GDB and verify that this command generated no output.
1084 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1085 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1086 # the message. (If MESSAGE is the empty string, then sometimes we do not
1087 # call pass or fail at all; I don't understand this at all.)
1089 proc gdb_test_no_output { args } {
1091 set command [lindex $args 0]
1092 if [llength $args]>1 then {
1093 set message [lindex $args 1]
1095 set message $command
1098 set command_regex [string_to_regexp $command]
1099 gdb_test_multiple $command $message {
1100 -re "^$command_regex\r\n$gdb_prompt $" {
1101 if ![string match "" $message] then {
1108 # Send a command and then wait for a sequence of outputs.
1109 # This is useful when the sequence is long and contains ".*", a single
1110 # regexp to match the entire output can get a timeout much easier.
1112 # COMMAND is the command to execute, send to GDB with send_gdb. If
1113 # this is the null string no command is sent.
1114 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1115 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1116 # processed in order, and all must be present in the output.
1118 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1119 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1120 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1122 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1123 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1126 # 1 if the test failed,
1127 # 0 if the test passes,
1128 # -1 if there was an internal error.
1130 proc gdb_test_sequence { command test_name expected_output_list } {
1132 if { $test_name == "" } {
1133 set test_name $command
1135 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1136 if { $command != "" } {
1137 send_gdb "$command\n"
1139 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1143 # Test that a command gives an error. For pass or fail, return
1144 # a 1 to indicate that more tests can proceed. However a timeout
1145 # is a serious error, generates a special fail message, and causes
1146 # a 0 to be returned to indicate that more tests are likely to fail
1149 proc test_print_reject { args } {
1153 if [llength $args]==2 then {
1154 set expectthis [lindex $args 1]
1156 set expectthis "should never match this bogus string"
1158 set sendthis [lindex $args 0]
1159 if $verbose>2 then {
1160 send_user "Sending \"$sendthis\" to gdb\n"
1161 send_user "Looking to match \"$expectthis\"\n"
1163 send_gdb "$sendthis\n"
1164 #FIXME: Should add timeout as parameter.
1166 -re "A .* in expression.*\\.*$gdb_prompt $" {
1167 pass "reject $sendthis"
1170 -re "Invalid syntax in expression.*$gdb_prompt $" {
1171 pass "reject $sendthis"
1174 -re "Junk after end of expression.*$gdb_prompt $" {
1175 pass "reject $sendthis"
1178 -re "Invalid number.*$gdb_prompt $" {
1179 pass "reject $sendthis"
1182 -re "Invalid character constant.*$gdb_prompt $" {
1183 pass "reject $sendthis"
1186 -re "No symbol table is loaded.*$gdb_prompt $" {
1187 pass "reject $sendthis"
1190 -re "No symbol .* in current context.*$gdb_prompt $" {
1191 pass "reject $sendthis"
1194 -re "Unmatched single quote.*$gdb_prompt $" {
1195 pass "reject $sendthis"
1198 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1199 pass "reject $sendthis"
1202 -re "$expectthis.*$gdb_prompt $" {
1203 pass "reject $sendthis"
1206 -re ".*$gdb_prompt $" {
1207 fail "reject $sendthis"
1211 fail "reject $sendthis (eof or timeout)"
1218 # Same as gdb_test, but the second parameter is not a regexp,
1219 # but a string that must match exactly.
1221 proc gdb_test_exact { args } {
1222 upvar timeout timeout
1224 set command [lindex $args 0]
1226 # This applies a special meaning to a null string pattern. Without
1227 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1228 # messages from commands that should have no output except a new
1229 # prompt. With this, only results of a null string will match a null
1232 set pattern [lindex $args 1]
1233 if [string match $pattern ""] {
1234 set pattern [string_to_regexp [lindex $args 0]]
1236 set pattern [string_to_regexp [lindex $args 1]]
1239 # It is most natural to write the pattern argument with only
1240 # embedded \n's, especially if you are trying to avoid Tcl quoting
1241 # problems. But gdb_expect really wants to see \r\n in patterns. So
1242 # transform the pattern here. First transform \r\n back to \n, in
1243 # case some users of gdb_test_exact already do the right thing.
1244 regsub -all "\r\n" $pattern "\n" pattern
1245 regsub -all "\n" $pattern "\r\n" pattern
1246 if [llength $args]==3 then {
1247 set message [lindex $args 2]
1249 set message $command
1252 return [gdb_test $command $pattern $message]
1255 # Wrapper around gdb_test_multiple that looks for a list of expected
1256 # output elements, but which can appear in any order.
1257 # CMD is the gdb command.
1258 # NAME is the name of the test.
1259 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1261 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1262 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1263 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1265 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1266 # of text per element and then strip trailing \r\n's.
1268 # gdb_test_list_exact "foo" "bar" \
1269 # "\[^\r\n\]+\[\r\n\]+" \
1272 # {expected result 1} \
1273 # {expected result 2} \
1276 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1279 set matches [lsort $result_match_list]
1281 gdb_test_multiple $cmd $name {
1282 "$cmd\[\r\n\]" { exp_continue }
1283 -re $elm_find_regexp {
1284 set str $expect_out(0,string)
1285 verbose -log "seen: $str" 3
1286 regexp -- $elm_extract_regexp $str elm_seen
1287 verbose -log "extracted: $elm_seen" 3
1288 lappend seen $elm_seen
1291 -re "$gdb_prompt $" {
1293 foreach got [lsort $seen] have $matches {
1294 if {![string equal $got $have]} {
1299 if {[string length $failed] != 0} {
1300 fail "$name ($failed not found)"
1308 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1309 # Send a command to gdb; expect inferior and gdb output.
1311 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1314 # INFERIOR_PATTERN is the pattern to match against inferior output.
1316 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1317 # include the \r\n sequence immediately before the gdb prompt, nor the
1318 # prompt. The default is empty.
1320 # Both inferior and gdb patterns must match for a PASS.
1322 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1325 # 1 if the test failed,
1326 # 0 if the test passes,
1327 # -1 if there was an internal error.
1330 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1331 global inferior_spawn_id gdb_spawn_id
1334 if {$message == ""} {
1335 set message $command
1338 set inferior_matched 0
1341 # Use an indirect spawn id list, and remove the inferior spawn id
1342 # from the expected output as soon as it matches, in case
1343 # $inferior_pattern happens to be a prefix of the resulting full
1344 # gdb pattern below (e.g., "\r\n").
1345 global gdb_test_stdio_spawn_id_list
1346 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1348 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1349 # then we may see gdb's output arriving before the inferior's
1351 set res [gdb_test_multiple $command $message {
1352 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1353 set inferior_matched 1
1354 if {!$gdb_matched} {
1355 set gdb_test_stdio_spawn_id_list ""
1359 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1361 if {!$inferior_matched} {
1369 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1376 # Issue a PASS and return true if evaluating CONDITION in the caller's
1377 # frame returns true, and issue a FAIL and return false otherwise.
1378 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1379 # omitted or is empty, then the pass/fail messages use the condition
1380 # string as the message.
1382 proc gdb_assert { condition {message ""} } {
1383 if { $message == ""} {
1384 set message $condition
1387 set res [uplevel 1 expr $condition]
1396 proc gdb_reinitialize_dir { subdir } {
1399 if [is_remote host] {
1404 -re "Reinitialize source path to empty.*y or n. " {
1407 -re "Source directories searched.*$gdb_prompt $" {
1408 send_gdb "dir $subdir\n"
1410 -re "Source directories searched.*$gdb_prompt $" {
1411 verbose "Dir set to $subdir"
1413 -re "$gdb_prompt $" {
1414 perror "Dir \"$subdir\" failed."
1418 -re "$gdb_prompt $" {
1419 perror "Dir \"$subdir\" failed."
1423 -re "$gdb_prompt $" {
1424 perror "Dir \"$subdir\" failed."
1430 # gdb_exit -- exit the GDB, killing the target program if necessary
1432 proc default_gdb_exit {} {
1434 global INTERNAL_GDBFLAGS GDBFLAGS
1436 global gdb_spawn_id inferior_spawn_id
1437 global inotify_log_file
1439 gdb_stop_suppressing_tests
1441 if ![info exists gdb_spawn_id] {
1445 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1447 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1448 set fd [open $inotify_log_file]
1449 set data [read -nonewline $fd]
1452 if {[string compare $data ""] != 0} {
1453 warning "parallel-unsafe file creations noticed"
1456 set fd [open $inotify_log_file w]
1461 if { [is_remote host] && [board_info host exists fileid] } {
1468 -re "DOSEXIT code" { }
1473 if ![is_remote host] {
1477 unset inferior_spawn_id
1480 # Load a file into the debugger.
1481 # The return value is 0 for success, -1 for failure.
1483 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1484 # to one of these values:
1486 # debug file was loaded successfully and has debug information
1487 # nodebug file was loaded successfully and has no debug information
1488 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1490 # fail file was not loaded
1492 # I tried returning this information as part of the return value,
1493 # but ran into a mess because of the many re-implementations of
1494 # gdb_load in config/*.exp.
1496 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1497 # this if they can get more information set.
1499 proc gdb_file_cmd { arg } {
1503 global last_loaded_file
1505 # Save this for the benefit of gdbserver-support.exp.
1506 set last_loaded_file $arg
1508 # Set whether debug info was found.
1509 # Default to "fail".
1510 global gdb_file_cmd_debug_info
1511 set gdb_file_cmd_debug_info "fail"
1513 if [is_remote host] {
1514 set arg [remote_download host $arg]
1516 perror "download failed"
1521 # The file command used to kill the remote target. For the benefit
1522 # of the testsuite, preserve this behavior.
1525 -re "Kill the program being debugged. .y or n. $" {
1527 verbose "\t\tKilling previous program being debugged"
1530 -re "$gdb_prompt $" {
1535 send_gdb "file $arg\n"
1537 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1538 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1539 set gdb_file_cmd_debug_info "lzma"
1542 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1543 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1544 set gdb_file_cmd_debug_info "nodebug"
1547 -re "Reading symbols from.*$gdb_prompt $" {
1548 verbose "\t\tLoaded $arg into $GDB"
1549 set gdb_file_cmd_debug_info "debug"
1552 -re "Load new symbol table from \".*\".*y or n. $" {
1555 -re "Reading symbols from.*$gdb_prompt $" {
1556 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1557 set gdb_file_cmd_debug_info "debug"
1561 perror "Couldn't load $arg, other program already loaded (timeout)."
1565 perror "Couldn't load $arg, other program already loaded (eof)."
1570 -re "No such file or directory.*$gdb_prompt $" {
1571 perror "($arg) No such file or directory"
1574 -re "A problem internal to GDB has been detected" {
1575 fail "($arg) (GDB internal error)"
1576 gdb_internal_error_resync
1579 -re "$gdb_prompt $" {
1580 perror "Couldn't load $arg into $GDB."
1584 perror "Couldn't load $arg into $GDB (timeout)."
1588 # This is an attempt to detect a core dump, but seems not to
1589 # work. Perhaps we need to match .* followed by eof, in which
1590 # gdb_expect does not seem to have a way to do that.
1591 perror "Couldn't load $arg into $GDB (eof)."
1597 # Default gdb_spawn procedure.
1599 proc default_gdb_spawn { } {
1602 global INTERNAL_GDBFLAGS GDBFLAGS
1605 gdb_stop_suppressing_tests
1607 # Set the default value, it may be overriden later by specific testfile.
1609 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1610 # is already started after connecting and run/attach are not supported.
1611 # This is used for the "remote" protocol. After GDB starts you should
1612 # check global $use_gdb_stub instead of the board as the testfile may force
1613 # a specific different target protocol itself.
1614 set use_gdb_stub [target_info exists use_gdb_stub]
1616 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1618 if [info exists gdb_spawn_id] {
1622 if ![is_remote host] {
1623 if { [which $GDB] == 0 } then {
1624 perror "$GDB does not exist."
1628 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1629 if { $res < 0 || $res == "" } {
1630 perror "Spawning $GDB failed."
1634 set gdb_spawn_id $res
1638 # Default gdb_start procedure.
1640 proc default_gdb_start { } {
1643 global inferior_spawn_id
1645 if [info exists gdb_spawn_id] {
1654 # Default to assuming inferior I/O is done on GDB's terminal.
1655 if {![info exists inferior_spawn_id]} {
1656 set inferior_spawn_id $gdb_spawn_id
1659 # When running over NFS, particularly if running many simultaneous
1660 # tests on different hosts all using the same server, things can
1661 # get really slow. Give gdb at least 3 minutes to start up.
1663 -re "\[\r\n\]$gdb_prompt $" {
1664 verbose "GDB initialized."
1666 -re "$gdb_prompt $" {
1667 perror "GDB never initialized."
1672 perror "(timeout) GDB never initialized after 10 seconds."
1679 # force the height to "unlimited", so no pagers get used
1681 send_gdb "set height 0\n"
1683 -re "$gdb_prompt $" {
1684 verbose "Setting height to 0." 2
1687 warning "Couldn't set the height to 0"
1690 # force the width to "unlimited", so no wraparound occurs
1691 send_gdb "set width 0\n"
1693 -re "$gdb_prompt $" {
1694 verbose "Setting width to 0." 2
1697 warning "Couldn't set the width to 0."
1703 # Utility procedure to give user control of the gdb prompt in a script. It is
1704 # meant to be used for debugging test cases, and should not be left in the
1707 proc gdb_interact { } {
1709 set spawn_id $gdb_spawn_id
1711 send_user "+------------------------------------------+\n"
1712 send_user "| Script interrupted, you can now interact |\n"
1713 send_user "| with by gdb. Type >>> to continue. |\n"
1714 send_user "+------------------------------------------+\n"
1721 # Examine the output of compilation to determine whether compilation
1722 # failed or not. If it failed determine whether it is due to missing
1723 # compiler or due to compiler error. Report pass, fail or unsupported
1726 proc gdb_compile_test {src output} {
1727 if { $output == "" } {
1728 pass "compilation [file tail $src]"
1729 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1730 unsupported "compilation [file tail $src]"
1731 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1732 unsupported "compilation [file tail $src]"
1733 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1734 unsupported "compilation [file tail $src]"
1736 verbose -log "compilation failed: $output" 2
1737 fail "compilation [file tail $src]"
1741 # Return a 1 for configurations for which we don't even want to try to
1744 proc skip_cplus_tests {} {
1745 if { [istarget "h8300-*-*"] } {
1749 # The C++ IO streams are too large for HC11/HC12 and are thus not
1750 # available. The gdb C++ tests use them and don't compile.
1751 if { [istarget "m6811-*-*"] } {
1754 if { [istarget "m6812-*-*"] } {
1760 # Return a 1 for configurations for which don't have both C++ and the STL.
1762 proc skip_stl_tests {} {
1763 # Symbian supports the C++ language, but the STL is missing
1764 # (both headers and libraries).
1765 if { [istarget "arm*-*-symbianelf*"] } {
1769 return [skip_cplus_tests]
1772 # Return a 1 if I don't even want to try to test FORTRAN.
1774 proc skip_fortran_tests {} {
1778 # Return a 1 if I don't even want to try to test ada.
1780 proc skip_ada_tests {} {
1784 # Return a 1 if I don't even want to try to test GO.
1786 proc skip_go_tests {} {
1790 # Return a 1 if I don't even want to try to test D.
1792 proc skip_d_tests {} {
1796 # Return 1 to skip Rust tests, 0 to try them.
1797 proc skip_rust_tests {} {
1798 return [expr {![isnative]}]
1801 # Return a 1 for configurations that do not support Python scripting.
1802 # PROMPT_REGEXP is the expected prompt.
1804 proc skip_python_tests_prompt { prompt_regexp } {
1805 global gdb_py_is_py3k
1807 gdb_test_multiple "python print ('test')" "verify python support" {
1808 -re "not supported.*$prompt_regexp" {
1809 unsupported "Python support is disabled."
1812 -re "$prompt_regexp" {}
1815 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1816 -re "3.*$prompt_regexp" {
1817 set gdb_py_is_py3k 1
1819 -re ".*$prompt_regexp" {
1820 set gdb_py_is_py3k 0
1827 # Return a 1 for configurations that do not support Python scripting.
1828 # Note: This also sets various globals that specify which version of Python
1829 # is in use. See skip_python_tests_prompt.
1831 proc skip_python_tests {} {
1833 return [skip_python_tests_prompt "$gdb_prompt $"]
1836 # Return a 1 if we should skip shared library tests.
1838 proc skip_shlib_tests {} {
1839 # Run the shared library tests on native systems.
1844 # An abbreviated list of remote targets where we should be able to
1845 # run shared library tests.
1846 if {([istarget *-*-linux*]
1847 || [istarget *-*-*bsd*]
1848 || [istarget *-*-solaris2*]
1849 || [istarget arm*-*-symbianelf*]
1850 || [istarget *-*-mingw*]
1851 || [istarget *-*-cygwin*]
1852 || [istarget *-*-pe*])} {
1859 # Return 1 if we should skip tui related tests.
1861 proc skip_tui_tests {} {
1864 gdb_test_multiple "help layout" "verify tui support" {
1865 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1868 -re "$gdb_prompt $" {
1875 # Test files shall make sure all the test result lines in gdb.sum are
1876 # unique in a test run, so that comparing the gdb.sum files of two
1877 # test runs gives correct results. Test files that exercise
1878 # variations of the same tests more than once, shall prefix the
1879 # different test invocations with different identifying strings in
1880 # order to make them unique.
1882 # About test prefixes:
1884 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1885 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1886 # underlined substring in
1888 # PASS: gdb.base/mytest.exp: some test
1889 # ^^^^^^^^^^^^^^^^^^^^
1893 # The easiest way to adjust the test prefix is to append a test
1894 # variation prefix to the $pf_prefix, using the with_test_prefix
1897 # proc do_tests {} {
1898 # gdb_test ... ... "test foo"
1899 # gdb_test ... ... "test bar"
1901 # with_test_prefix "subvariation a" {
1902 # gdb_test ... ... "test x"
1905 # with_test_prefix "subvariation b" {
1906 # gdb_test ... ... "test x"
1910 # with_test_prefix "variation1" {
1911 # ...do setup for variation 1...
1915 # with_test_prefix "variation2" {
1916 # ...do setup for variation 2...
1922 # PASS: gdb.base/mytest.exp: variation1: test foo
1923 # PASS: gdb.base/mytest.exp: variation1: test bar
1924 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1925 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1926 # PASS: gdb.base/mytest.exp: variation2: test foo
1927 # PASS: gdb.base/mytest.exp: variation2: test bar
1928 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1929 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1931 # If for some reason more flexibility is necessary, one can also
1932 # manipulate the pf_prefix global directly, treating it as a string.
1936 # set saved_pf_prefix
1937 # append pf_prefix "${foo}: bar"
1938 # ... actual tests ...
1939 # set pf_prefix $saved_pf_prefix
1942 # Run BODY in the context of the caller, with the current test prefix
1943 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1944 # Returns the result of BODY.
1946 proc with_test_prefix { prefix body } {
1949 set saved $pf_prefix
1950 append pf_prefix " " $prefix ":"
1951 set code [catch {uplevel 1 $body} result]
1952 set pf_prefix $saved
1955 global errorInfo errorCode
1956 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1958 return -code $code $result
1962 # Wrapper for foreach that calls with_test_prefix on each iteration,
1963 # including the iterator's name and current value in the prefix.
1965 proc foreach_with_prefix {var list body} {
1967 foreach myvar $list {
1968 with_test_prefix "$var=$myvar" {
1974 # Like TCL's native proc, but defines a procedure that wraps its body
1975 # within 'with_test_prefix "$proc_name" { ... }'.
1976 proc proc_with_prefix {name arguments body} {
1977 # Define the advertised proc.
1978 proc $name $arguments [list with_test_prefix $name $body]
1982 # Run BODY in the context of the caller. After BODY is run, the variables
1983 # listed in VARS will be reset to the values they had before BODY was run.
1985 # This is useful for providing a scope in which it is safe to temporarily
1986 # modify global variables, e.g.
1988 # global INTERNAL_GDBFLAGS
1991 # set foo GDBHISTSIZE
1993 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1994 # append INTERNAL_GDBFLAGS " -nx"
1995 # unset -nocomplain env(GDBHISTSIZE)
2000 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2001 # modified inside BODY, this proc guarantees that the modifications will be
2002 # undone after BODY finishes executing.
2004 proc save_vars { vars body } {
2005 array set saved_scalars { }
2006 array set saved_arrays { }
2010 # First evaluate VAR in the context of the caller in case the variable
2011 # name may be a not-yet-interpolated string like env($foo)
2012 set var [uplevel 1 list $var]
2014 if [uplevel 1 [list info exists $var]] {
2015 if [uplevel 1 [list array exists $var]] {
2016 set saved_arrays($var) [uplevel 1 [list array get $var]]
2018 set saved_scalars($var) [uplevel 1 [list set $var]]
2021 lappend unset_vars $var
2025 set code [catch {uplevel 1 $body} result]
2027 foreach {var value} [array get saved_scalars] {
2028 uplevel 1 [list set $var $value]
2031 foreach {var value} [array get saved_arrays] {
2032 uplevel 1 [list unset $var]
2033 uplevel 1 [list array set $var $value]
2036 foreach var $unset_vars {
2037 uplevel 1 [list unset -nocomplain $var]
2041 global errorInfo errorCode
2042 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2044 return -code $code $result
2048 # Run tests in BODY with the current working directory (CWD) set to
2049 # DIR. When BODY is finished, restore the original CWD. Return the
2052 # This procedure doesn't check if DIR is a valid directory, so you
2053 # have to make sure of that.
2055 proc with_cwd { dir body } {
2057 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2060 set code [catch {uplevel 1 $body} result]
2062 verbose -log "Switching back to $saved_dir."
2066 global errorInfo errorCode
2067 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2069 return -code $code $result
2073 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2074 # PROMPT. When BODY is finished, restore GDB prompt and variable
2076 # Returns the result of BODY.
2080 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2081 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2082 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2083 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2084 # a) It's more intuitive for callers to pass the plain text form.
2085 # b) We need two forms of the prompt:
2086 # - a regexp to use in output matching,
2087 # - a value to pass to the "set prompt" command.
2088 # c) It's easier to convert the plain text form to its regexp form.
2090 # 2) Don't add a trailing space, we do that here.
2092 proc with_gdb_prompt { prompt body } {
2095 # Convert "(foo)" to "\(foo\)".
2096 # We don't use string_to_regexp because while it works today it's not
2097 # clear it will work tomorrow: the value we need must work as both a
2098 # regexp *and* as the argument to the "set prompt" command, at least until
2099 # we start recording both forms separately instead of just $gdb_prompt.
2100 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2102 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2104 set saved $gdb_prompt
2106 verbose -log "Setting gdb prompt to \"$prompt \"."
2107 set gdb_prompt $prompt
2108 gdb_test_no_output "set prompt $prompt " ""
2110 set code [catch {uplevel 1 $body} result]
2112 verbose -log "Restoring gdb prompt to \"$saved \"."
2113 set gdb_prompt $saved
2114 gdb_test_no_output "set prompt $saved " ""
2117 global errorInfo errorCode
2118 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2120 return -code $code $result
2124 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2125 # BODY is finished, restore target-charset.
2127 proc with_target_charset { target_charset body } {
2131 gdb_test_multiple "show target-charset" "" {
2132 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2133 set saved $expect_out(1,string)
2135 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2136 set saved $expect_out(1,string)
2138 -re ".*$gdb_prompt " {
2139 fail "get target-charset"
2143 gdb_test_no_output "set target-charset $target_charset" ""
2145 set code [catch {uplevel 1 $body} result]
2147 gdb_test_no_output "set target-charset $saved" ""
2150 global errorInfo errorCode
2151 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2153 return -code $code $result
2157 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2158 # mi_gdb_test etc. default to using it.
2160 proc switch_gdb_spawn_id {spawn_id} {
2162 global board board_info
2164 set gdb_spawn_id $spawn_id
2165 set board [host_info name]
2166 set board_info($board,fileid) $spawn_id
2169 # Clear the default spawn id.
2171 proc clear_gdb_spawn_id {} {
2173 global board board_info
2175 unset -nocomplain gdb_spawn_id
2176 set board [host_info name]
2177 unset -nocomplain board_info($board,fileid)
2180 # Run BODY with SPAWN_ID as current spawn id.
2182 proc with_spawn_id { spawn_id body } {
2185 if [info exists gdb_spawn_id] {
2186 set saved_spawn_id $gdb_spawn_id
2189 switch_gdb_spawn_id $spawn_id
2191 set code [catch {uplevel 1 $body} result]
2193 if [info exists saved_spawn_id] {
2194 switch_gdb_spawn_id $saved_spawn_id
2200 global errorInfo errorCode
2201 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2203 return -code $code $result
2207 # Select the largest timeout from all the timeouts:
2208 # - the local "timeout" variable of the scope two levels above,
2209 # - the global "timeout" variable,
2210 # - the board variable "gdb,timeout".
2212 proc get_largest_timeout {} {
2213 upvar #0 timeout gtimeout
2214 upvar 2 timeout timeout
2217 if [info exists timeout] {
2220 if { [info exists gtimeout] && $gtimeout > $tmt } {
2223 if { [target_info exists gdb,timeout]
2224 && [target_info gdb,timeout] > $tmt } {
2225 set tmt [target_info gdb,timeout]
2235 # Run tests in BODY with timeout increased by factor of FACTOR. When
2236 # BODY is finished, restore timeout.
2238 proc with_timeout_factor { factor body } {
2241 set savedtimeout $timeout
2243 set timeout [expr [get_largest_timeout] * $factor]
2244 set code [catch {uplevel 1 $body} result]
2246 set timeout $savedtimeout
2248 global errorInfo errorCode
2249 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2251 return -code $code $result
2255 # Return 1 if _Complex types are supported, otherwise, return 0.
2257 gdb_caching_proc support_complex_tests {
2259 if { [gdb_skip_float_test] } {
2260 # If floating point is not supported, _Complex is not
2265 # Compile a test program containing _Complex types.
2267 return [gdb_can_simple_compile complex {
2271 _Complex long double cld;
2277 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2280 proc supports_get_siginfo_type {} {
2281 if { [istarget "*-*-linux*"] } {
2288 # Return 1 if the target supports hardware single stepping.
2290 proc can_hardware_single_step {} {
2292 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2293 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2294 || [istarget "nios2-*-*"] } {
2301 # Return 1 if target hardware or OS supports single stepping to signal
2302 # handler, otherwise, return 0.
2304 proc can_single_step_to_signal_handler {} {
2305 # Targets don't have hardware single step. On these targets, when
2306 # a signal is delivered during software single step, gdb is unable
2307 # to determine the next instruction addresses, because start of signal
2308 # handler is one of them.
2309 return [can_hardware_single_step]
2312 # Return 1 if target supports process record, otherwise return 0.
2314 proc supports_process_record {} {
2316 if [target_info exists gdb,use_precord] {
2317 return [target_info gdb,use_precord]
2320 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2321 || [istarget "i\[34567\]86-*-linux*"]
2322 || [istarget "aarch64*-*-linux*"]
2323 || [istarget "powerpc*-*-linux*"]
2324 || [istarget "s390*-*-linux*"] } {
2331 # Return 1 if target supports reverse debugging, otherwise return 0.
2333 proc supports_reverse {} {
2335 if [target_info exists gdb,can_reverse] {
2336 return [target_info gdb,can_reverse]
2339 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2340 || [istarget "i\[34567\]86-*-linux*"]
2341 || [istarget "aarch64*-*-linux*"]
2342 || [istarget "powerpc*-*-linux*"]
2343 || [istarget "s390*-*-linux*"] } {
2350 # Return 1 if readline library is used.
2352 proc readline_is_used { } {
2355 gdb_test_multiple "show editing" "" {
2356 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2359 -re ".*$gdb_prompt $" {
2365 # Return 1 if target is ELF.
2366 gdb_caching_proc is_elf_target {
2367 set me "is_elf_target"
2369 set src { int foo () {return 0;} }
2370 if {![gdb_simple_compile elf_target $src]} {
2374 set fp_obj [open $obj "r"]
2375 fconfigure $fp_obj -translation binary
2376 set data [read $fp_obj]
2381 set ELFMAG "\u007FELF"
2383 if {[string compare -length 4 $data $ELFMAG] != 0} {
2384 verbose "$me: returning 0" 2
2388 verbose "$me: returning 1" 2
2392 # Return 1 if the memory at address zero is readable.
2394 gdb_caching_proc is_address_zero_readable {
2398 gdb_test_multiple "x 0" "" {
2399 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2402 -re ".*$gdb_prompt $" {
2410 # Produce source file NAME and write SOURCES into it.
2412 proc gdb_produce_source { name sources } {
2414 set f [open $name "w"]
2420 # Return 1 if target is ILP32.
2421 # This cannot be decided simply from looking at the target string,
2422 # as it might depend on externally passed compiler options like -m64.
2423 gdb_caching_proc is_ilp32_target {
2424 return [gdb_can_simple_compile is_ilp32_target {
2425 int dummy[sizeof (int) == 4
2426 && sizeof (void *) == 4
2427 && sizeof (long) == 4 ? 1 : -1];
2431 # Return 1 if target is LP64.
2432 # This cannot be decided simply from looking at the target string,
2433 # as it might depend on externally passed compiler options like -m64.
2434 gdb_caching_proc is_lp64_target {
2435 return [gdb_can_simple_compile is_lp64_target {
2436 int dummy[sizeof (int) == 4
2437 && sizeof (void *) == 8
2438 && sizeof (long) == 8 ? 1 : -1];
2442 # Return 1 if target has 64 bit addresses.
2443 # This cannot be decided simply from looking at the target string,
2444 # as it might depend on externally passed compiler options like -m64.
2445 gdb_caching_proc is_64_target {
2446 return [gdb_can_simple_compile is_64_target {
2447 int function(void) { return 3; }
2448 int dummy[sizeof (&function) == 8 ? 1 : -1];
2452 # Return 1 if target has x86_64 registers - either amd64 or x32.
2453 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2454 # just from the target string.
2455 gdb_caching_proc is_amd64_regs_target {
2456 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2460 return [gdb_can_simple_compile is_amd64_regs_target {
2470 # Return 1 if this target is an x86 or x86-64 with -m32.
2471 proc is_x86_like_target {} {
2472 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2475 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2478 # Return 1 if this target is an arm or aarch32 on aarch64.
2480 gdb_caching_proc is_aarch32_target {
2481 if { [istarget "arm*-*-*"] } {
2485 if { ![istarget "aarch64*-*-*"] } {
2492 lappend list "\tmov $reg, $reg"
2495 return [gdb_can_simple_compile aarch32 [join $list \n]]
2498 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2500 proc is_aarch64_target {} {
2501 if { ![istarget "aarch64*-*-*"] } {
2505 return [expr ![is_aarch32_target]]
2508 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2509 proc support_displaced_stepping {} {
2511 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2512 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2513 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2514 || [istarget "aarch64*-*-linux*"] } {
2521 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2522 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2524 gdb_caching_proc skip_altivec_tests {
2525 global srcdir subdir gdb_prompt inferior_exited_re
2527 set me "skip_altivec_tests"
2529 # Some simulators are known to not support VMX instructions.
2530 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2531 verbose "$me: target known to not support VMX, returning 1" 2
2535 # Make sure we have a compiler that understands altivec.
2536 if [get_compiler_info] {
2537 warning "Could not get compiler info"
2540 if [test_compiler_info gcc*] {
2541 set compile_flags "additional_flags=-maltivec"
2542 } elseif [test_compiler_info xlc*] {
2543 set compile_flags "additional_flags=-qaltivec"
2545 verbose "Could not compile with altivec support, returning 1" 2
2549 # Compile a test program containing VMX instructions.
2553 asm volatile ("vor v0,v0,v0");
2555 asm volatile ("vor 0,0,0");
2560 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2564 # Compilation succeeded so now run it via gdb.
2568 gdb_reinitialize_dir $srcdir/$subdir
2572 -re ".*Illegal instruction.*${gdb_prompt} $" {
2573 verbose -log "\n$me altivec hardware not detected"
2574 set skip_vmx_tests 1
2576 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2577 verbose -log "\n$me: altivec hardware detected"
2578 set skip_vmx_tests 0
2581 warning "\n$me: default case taken"
2582 set skip_vmx_tests 1
2586 remote_file build delete $obj
2588 verbose "$me: returning $skip_vmx_tests" 2
2589 return $skip_vmx_tests
2592 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2593 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2595 gdb_caching_proc skip_vsx_tests {
2596 global srcdir subdir gdb_prompt inferior_exited_re
2598 set me "skip_vsx_tests"
2600 # Some simulators are known to not support Altivec instructions, so
2601 # they won't support VSX instructions as well.
2602 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2603 verbose "$me: target known to not support VSX, returning 1" 2
2607 # Make sure we have a compiler that understands altivec.
2608 if [get_compiler_info] {
2609 warning "Could not get compiler info"
2612 if [test_compiler_info gcc*] {
2613 set compile_flags "additional_flags=-mvsx"
2614 } elseif [test_compiler_info xlc*] {
2615 set compile_flags "additional_flags=-qasm=gcc"
2617 verbose "Could not compile with vsx support, returning 1" 2
2621 # Compile a test program containing VSX instructions.
2624 double a[2] = { 1.0, 2.0 };
2626 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2628 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2633 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2637 # No error message, compilation succeeded so now run it via gdb.
2641 gdb_reinitialize_dir $srcdir/$subdir
2645 -re ".*Illegal instruction.*${gdb_prompt} $" {
2646 verbose -log "\n$me VSX hardware not detected"
2647 set skip_vsx_tests 1
2649 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2650 verbose -log "\n$me: VSX hardware detected"
2651 set skip_vsx_tests 0
2654 warning "\n$me: default case taken"
2655 set skip_vsx_tests 1
2659 remote_file build delete $obj
2661 verbose "$me: returning $skip_vsx_tests" 2
2662 return $skip_vsx_tests
2665 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2666 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2668 gdb_caching_proc skip_tsx_tests {
2669 global srcdir subdir gdb_prompt inferior_exited_re
2671 set me "skip_tsx_tests"
2673 # Compile a test program.
2676 asm volatile ("xbegin .L0");
2677 asm volatile ("xend");
2678 asm volatile (".L0: nop");
2682 if {![gdb_simple_compile $me $src executable]} {
2686 # No error message, compilation succeeded so now run it via gdb.
2690 gdb_reinitialize_dir $srcdir/$subdir
2694 -re ".*Illegal instruction.*${gdb_prompt} $" {
2695 verbose -log "$me: TSX hardware not detected."
2696 set skip_tsx_tests 1
2698 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2699 verbose -log "$me: TSX hardware detected."
2700 set skip_tsx_tests 0
2703 warning "\n$me: default case taken."
2704 set skip_tsx_tests 1
2708 remote_file build delete $obj
2710 verbose "$me: returning $skip_tsx_tests" 2
2711 return $skip_tsx_tests
2714 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2715 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2717 gdb_caching_proc skip_btrace_tests {
2718 global srcdir subdir gdb_prompt inferior_exited_re
2720 set me "skip_btrace_tests"
2721 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2722 verbose "$me: target does not support btrace, returning 1" 2
2726 # Compile a test program.
2727 set src { int main() { return 0; } }
2728 if {![gdb_simple_compile $me $src executable]} {
2732 # No error message, compilation succeeded so now run it via gdb.
2736 gdb_reinitialize_dir $srcdir/$subdir
2741 # In case of an unexpected output, we return 2 as a fail value.
2742 set skip_btrace_tests 2
2743 gdb_test_multiple "record btrace" "check btrace support" {
2744 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2745 set skip_btrace_tests 1
2747 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2748 set skip_btrace_tests 1
2750 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2751 set skip_btrace_tests 1
2753 -re "^record btrace\r\n$gdb_prompt $" {
2754 set skip_btrace_tests 0
2758 remote_file build delete $obj
2760 verbose "$me: returning $skip_btrace_tests" 2
2761 return $skip_btrace_tests
2764 # Run a test on the target to see if it supports btrace pt hardware.
2765 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2766 # from the GCC testsuite.
2768 gdb_caching_proc skip_btrace_pt_tests {
2769 global srcdir subdir gdb_prompt inferior_exited_re
2771 set me "skip_btrace_tests"
2772 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2773 verbose "$me: target does not support btrace, returning 1" 2
2777 # Compile a test program.
2778 set src { int main() { return 0; } }
2779 if {![gdb_simple_compile $me $src executable]} {
2783 # No error message, compilation succeeded so now run it via gdb.
2787 gdb_reinitialize_dir $srcdir/$subdir
2792 # In case of an unexpected output, we return 2 as a fail value.
2793 set skip_btrace_tests 2
2794 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2795 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2796 set skip_btrace_tests 1
2798 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2799 set skip_btrace_tests 1
2801 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2802 set skip_btrace_tests 1
2804 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2805 set skip_btrace_tests 1
2807 -re "^record btrace pt\r\n$gdb_prompt $" {
2808 set skip_btrace_tests 0
2812 remote_file build delete $obj
2814 verbose "$me: returning $skip_btrace_tests" 2
2815 return $skip_btrace_tests
2818 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2819 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2821 gdb_caching_proc skip_aarch64_sve_tests {
2822 global srcdir subdir gdb_prompt inferior_exited_re
2824 set me "skip_aarch64_sve_tests"
2826 if { ![is_aarch64_target]} {
2830 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2832 # Compile a test program containing SVE instructions.
2835 asm volatile ("ptrue p0.b");
2839 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2843 # Compilation succeeded so now run it via gdb.
2847 -re ".*Illegal instruction.*${gdb_prompt} $" {
2848 verbose -log "\n$me sve hardware not detected"
2849 set skip_sve_tests 1
2851 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2852 verbose -log "\n$me: sve hardware detected"
2853 set skip_sve_tests 0
2856 warning "\n$me: default case taken"
2857 set skip_sve_tests 1
2861 remote_file build delete $obj
2863 verbose "$me: returning $skip_sve_tests" 2
2864 return $skip_sve_tests
2868 # A helper that compiles a test case to see if __int128 is supported.
2869 proc gdb_int128_helper {lang} {
2870 return [gdb_can_simple_compile "i128-for-$lang" {
2872 int main() { return 0; }
2876 # Return true if the C compiler understands the __int128 type.
2877 gdb_caching_proc has_int128_c {
2878 return [gdb_int128_helper c]
2881 # Return true if the C++ compiler understands the __int128 type.
2882 gdb_caching_proc has_int128_cxx {
2883 return [gdb_int128_helper c++]
2886 # Return true if the IFUNC feature is unsupported.
2887 gdb_caching_proc skip_ifunc_tests {
2888 if [gdb_can_simple_compile ifunc {
2890 typedef void F (void);
2891 F* g (void) { return &f_; }
2892 void f () __attribute__ ((ifunc ("g")));
2900 # Return whether we should skip tests for showing inlined functions in
2901 # backtraces. Requires get_compiler_info and get_debug_format.
2903 proc skip_inline_frame_tests {} {
2904 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2905 if { ! [test_debug_format "DWARF 2"] } {
2909 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2910 if { ([test_compiler_info "gcc-2-*"]
2911 || [test_compiler_info "gcc-3-*"]
2912 || [test_compiler_info "gcc-4-0-*"]) } {
2919 # Return whether we should skip tests for showing variables from
2920 # inlined functions. Requires get_compiler_info and get_debug_format.
2922 proc skip_inline_var_tests {} {
2923 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2924 if { ! [test_debug_format "DWARF 2"] } {
2931 # Return a 1 if we should skip tests that require hardware breakpoints
2933 proc skip_hw_breakpoint_tests {} {
2934 # Skip tests if requested by the board (note that no_hardware_watchpoints
2935 # disables both watchpoints and breakpoints)
2936 if { [target_info exists gdb,no_hardware_watchpoints]} {
2940 # These targets support hardware breakpoints natively
2941 if { [istarget "i?86-*-*"]
2942 || [istarget "x86_64-*-*"]
2943 || [istarget "ia64-*-*"]
2944 || [istarget "arm*-*-*"]
2945 || [istarget "aarch64*-*-*"]
2946 || [istarget "s390*-*-*"] } {
2953 # Return a 1 if we should skip tests that require hardware watchpoints
2955 proc skip_hw_watchpoint_tests {} {
2956 # Skip tests if requested by the board
2957 if { [target_info exists gdb,no_hardware_watchpoints]} {
2961 # These targets support hardware watchpoints natively
2962 if { [istarget "i?86-*-*"]
2963 || [istarget "x86_64-*-*"]
2964 || [istarget "ia64-*-*"]
2965 || [istarget "arm*-*-*"]
2966 || [istarget "aarch64*-*-*"]
2967 || [istarget "powerpc*-*-linux*"]
2968 || [istarget "s390*-*-*"] } {
2975 # Return a 1 if we should skip tests that require *multiple* hardware
2976 # watchpoints to be active at the same time
2978 proc skip_hw_watchpoint_multi_tests {} {
2979 if { [skip_hw_watchpoint_tests] } {
2983 # These targets support just a single hardware watchpoint
2984 if { [istarget "arm*-*-*"]
2985 || [istarget "powerpc*-*-linux*"] } {
2992 # Return a 1 if we should skip tests that require read/access watchpoints
2994 proc skip_hw_watchpoint_access_tests {} {
2995 if { [skip_hw_watchpoint_tests] } {
2999 # These targets support just write watchpoints
3000 if { [istarget "s390*-*-*"] } {
3007 # Return 1 if we should skip tests that require the runtime unwinder
3008 # hook. This must be invoked while gdb is running, after shared
3009 # libraries have been loaded. This is needed because otherwise a
3010 # shared libgcc won't be visible.
3012 proc skip_unwinder_tests {} {
3016 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3017 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3019 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3022 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3026 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3027 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3030 -re "\r\n$gdb_prompt $" {
3037 # Return 0 if we should skip tests that require the libstdc++ stap
3038 # probes. This must be invoked while gdb is running, after shared
3039 # libraries have been loaded.
3041 proc skip_libstdcxx_probe_tests {} {
3045 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3046 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3049 -re "\r\n$gdb_prompt $" {
3055 # Return 1 if we should skip tests of the "compile" feature.
3056 # This must be invoked after the inferior has been started.
3058 proc skip_compile_feature_tests {} {
3062 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3063 "Could not load libcc1.*\r\n$gdb_prompt $" {
3066 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3069 -re "\r\n$gdb_prompt $" {
3075 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3076 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3077 # is a regexp that will match the output of "maint print target-stack" if
3078 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3079 # matching the expected prompt after the command output.
3081 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3082 set test "probe for target ${target_name}"
3083 gdb_test_multiple "maint print target-stack" $test {
3084 -re "${target_stack_regexp}${prompt_regexp}" {
3088 -re "$prompt_regexp" {
3095 # Helper for gdb_is_target_remote where the expected prompt is variable.
3097 proc gdb_is_target_remote_prompt { prompt_regexp } {
3098 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3101 # Check whether we're testing with the remote or extended-remote
3104 proc gdb_is_target_remote { } {
3107 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3110 # Check whether we're testing with the native target.
3112 proc gdb_is_target_native { } {
3115 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3118 # Return the effective value of use_gdb_stub.
3120 # If the use_gdb_stub global has been set (it is set when the gdb process is
3121 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3122 # property from the board file.
3124 # This is the preferred way of checking use_gdb_stub, since it allows to check
3125 # the value before the gdb has been spawned and it will return the correct value
3126 # even when it was overriden by the test.
3128 proc use_gdb_stub {} {
3131 if [info exists use_gdb_stub] {
3132 return $use_gdb_stub
3135 return [target_info exists use_gdb_stub]
3138 # Return 1 if the current remote target is an instance of our GDBserver, 0
3139 # otherwise. Return -1 if there was an error and we can't tell.
3141 gdb_caching_proc target_is_gdbserver {
3145 set test "probing for GDBserver"
3147 gdb_test_multiple "monitor help" $test {
3148 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3151 -re "$gdb_prompt $" {
3156 if { $is_gdbserver == -1 } {
3157 verbose -log "Unable to tell whether we are using GDBserver or not."
3160 return $is_gdbserver
3163 # N.B. compiler_info is intended to be local to this file.
3164 # Call test_compiler_info with no arguments to fetch its value.
3165 # Yes, this is counterintuitive when there's get_compiler_info,
3166 # but that's the current API.
3167 if [info exists compiler_info] {
3173 # Figure out what compiler I am using.
3174 # The result is cached so only the first invocation runs the compiler.
3176 # ARG can be empty or "C++". If empty, "C" is assumed.
3178 # There are several ways to do this, with various problems.
3180 # [ gdb_compile -E $ifile -o $binfile.ci ]
3181 # source $binfile.ci
3183 # Single Unix Spec v3 says that "-E -o ..." together are not
3184 # specified. And in fact, the native compiler on hp-ux 11 (among
3185 # others) does not work with "-E -o ...". Most targets used to do
3186 # this, and it mostly worked, because it works with gcc.
3188 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3189 # source $binfile.ci
3191 # This avoids the problem with -E and -o together. This almost works
3192 # if the build machine is the same as the host machine, which is
3193 # usually true of the targets which are not gcc. But this code does
3194 # not figure which compiler to call, and it always ends up using the C
3195 # compiler. Not good for setting hp_aCC_compiler. Target
3196 # hppa*-*-hpux* used to do this.
3198 # [ gdb_compile -E $ifile > $binfile.ci ]
3199 # source $binfile.ci
3201 # dejagnu target_compile says that it supports output redirection,
3202 # but the code is completely different from the normal path and I
3203 # don't want to sweep the mines from that path. So I didn't even try
3206 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3209 # I actually do this for all targets now. gdb_compile runs the right
3210 # compiler, and TCL captures the output, and I eval the output.
3212 # Unfortunately, expect logs the output of the command as it goes by,
3213 # and dejagnu helpfully prints a second copy of it right afterwards.
3214 # So I turn off expect logging for a moment.
3216 # [ gdb_compile $ifile $ciexe_file executable $args ]
3217 # [ remote_exec $ciexe_file ]
3218 # [ source $ci_file.out ]
3220 # I could give up on -E and just do this.
3221 # I didn't get desperate enough to try this.
3223 # -- chastain 2004-01-06
3225 proc get_compiler_info {{arg ""}} {
3226 # For compiler.c and compiler.cc
3229 # I am going to play with the log to keep noise out.
3233 # These come from compiler.c or compiler.cc
3234 global compiler_info
3236 # Legacy global data symbols.
3239 if [info exists compiler_info] {
3244 # Choose which file to preprocess.
3245 set ifile "${srcdir}/lib/compiler.c"
3246 if { $arg == "c++" } {
3247 set ifile "${srcdir}/lib/compiler.cc"
3250 # Run $ifile through the right preprocessor.
3251 # Toggle gdb.log to keep the compiler output out of the log.
3252 set saved_log [log_file -info]
3254 if [is_remote host] {
3255 # We have to use -E and -o together, despite the comments
3256 # above, because of how DejaGnu handles remote host testing.
3257 set ppout "$outdir/compiler.i"
3258 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3259 set file [open $ppout r]
3260 set cppout [read $file]
3263 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3265 eval log_file $saved_log
3269 foreach cppline [ split "$cppout" "\n" ] {
3270 if { [ regexp "^#" "$cppline" ] } {
3272 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3274 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3276 verbose "get_compiler_info: $cppline" 2
3280 verbose -log "get_compiler_info: $cppline"
3285 # Set to unknown if for some reason compiler_info didn't get defined.
3286 if ![info exists compiler_info] {
3287 verbose -log "get_compiler_info: compiler_info not provided"
3288 set compiler_info "unknown"
3290 # Also set to unknown compiler if any diagnostics happened.
3292 verbose -log "get_compiler_info: got unexpected diagnostics"
3293 set compiler_info "unknown"
3296 # Set the legacy symbols.
3298 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3300 # Log what happened.
3301 verbose -log "get_compiler_info: $compiler_info"
3303 # Most compilers will evaluate comparisons and other boolean
3304 # operations to 0 or 1.
3305 uplevel \#0 { set true 1 }
3306 uplevel \#0 { set false 0 }
3311 # Return the compiler_info string if no arg is provided.
3312 # Otherwise the argument is a glob-style expression to match against
3315 proc test_compiler_info { {compiler ""} } {
3316 global compiler_info
3319 # If no arg, return the compiler_info string.
3320 if [string match "" $compiler] {
3321 return $compiler_info
3324 return [string match $compiler $compiler_info]
3327 proc current_target_name { } {
3329 if [info exists target_info(target,name)] {
3330 set answer $target_info(target,name)
3337 set gdb_wrapper_initialized 0
3338 set gdb_wrapper_target ""
3340 proc gdb_wrapper_init { args } {
3341 global gdb_wrapper_initialized
3342 global gdb_wrapper_file
3343 global gdb_wrapper_flags
3344 global gdb_wrapper_target
3346 if { $gdb_wrapper_initialized == 1 } { return; }
3348 if {[target_info exists needs_status_wrapper] && \
3349 [target_info needs_status_wrapper] != "0"} {
3350 set result [build_wrapper "testglue.o"]
3351 if { $result != "" } {
3352 set gdb_wrapper_file [lindex $result 0]
3353 set gdb_wrapper_flags [lindex $result 1]
3355 warning "Status wrapper failed to build."
3358 set gdb_wrapper_initialized 1
3359 set gdb_wrapper_target [current_target_name]
3362 # Determine options that we always want to pass to the compiler.
3363 gdb_caching_proc universal_compile_options {
3364 set me "universal_compile_options"
3367 set src [standard_temp_file ccopts[pid].c]
3368 set obj [standard_temp_file ccopts[pid].o]
3370 gdb_produce_source $src {
3371 int foo(void) { return 0; }
3374 # Try an option for disabling colored diagnostics. Some compilers
3375 # yield colored diagnostics by default (when run from a tty) unless
3376 # such an option is specified.
3377 set opt "additional_flags=-fdiagnostics-color=never"
3378 set lines [target_compile $src $obj object [list "quiet" $opt]]
3379 if [string match "" $lines] then {
3380 # Seems to have worked; use the option.
3381 lappend options $opt
3386 verbose "$me: returning $options" 2
3390 # Compile the code in $code to a file based on $name, using the flags
3391 # $compile_flag as well as debug, nowarning and quiet.
3392 # Return 1 if code can be compiled
3393 # Leave the file name of the resulting object in the upvar object.
3395 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3398 switch -regexp -- $type {
3412 set src [standard_temp_file $name-[pid].c]
3413 set obj [standard_temp_file $name-[pid].$postfix]
3414 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3416 gdb_produce_source $src $code
3418 verbose "$name: compiling testfile $src" 2
3419 set lines [gdb_compile $src $obj $type $compile_flags]
3423 if ![string match "" $lines] then {
3424 verbose "$name: compilation failed, returning 0" 2
3430 # Compile the code in $code to a file based on $name, using the flags
3431 # $compile_flag as well as debug, nowarning and quiet.
3432 # Return 1 if code can be compiled
3433 # Delete all created files and objects.
3435 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3436 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3437 file delete $temp_obj
3441 # Some targets need to always link a special object in. Save its path here.
3442 global gdb_saved_set_unbuffered_mode_obj
3443 set gdb_saved_set_unbuffered_mode_obj ""
3445 # Compile source files specified by SOURCE into a binary of type TYPE at path
3446 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3447 # parameter and most options are passed directly to it.
3449 # The type can be one of the following:
3451 # - object: Compile into an object file.
3452 # - executable: Compile and link into an executable.
3453 # - preprocess: Preprocess the source files.
3454 # - assembly: Generate assembly listing.
3456 # The following options are understood and processed by gdb_compile:
3458 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3459 # quirks to be able to use shared libraries.
3460 # - shlib_load: Link with appropriate libraries to allow the test to
3461 # dynamically load libraries at runtime. For example, on Linux, this adds
3462 # -ldl so that the test can use dlopen.
3463 # - nowarnings: Inhibit all compiler warnings.
3464 # - nopie: Prevent creation of PIE executables.
3466 # And here are some of the not too obscure options understood by DejaGnu that
3467 # influence the compilation:
3469 # - additional_flags=flag: Add FLAG to the compiler flags.
3470 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3471 # argument can be a file, in which case it's added to the sources, or a
3473 # - ldflags=flag: Add FLAG to the linker flags.
3474 # - incdir=path: Add PATH to the searched include directories.
3475 # - libdir=path: Add PATH to the linker searched directories.
3476 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3477 # - debug: Build with debug information.
3478 # - optimize: Build with optimization.
3480 proc gdb_compile {source dest type options} {
3481 global GDB_TESTCASE_OPTIONS
3482 global gdb_wrapper_file
3483 global gdb_wrapper_flags
3484 global gdb_wrapper_initialized
3487 global gdb_saved_set_unbuffered_mode_obj
3489 set outdir [file dirname $dest]
3491 # Add platform-specific options if a shared library was specified using
3492 # "shlib=librarypath" in OPTIONS.
3494 if {[lsearch -exact $options rust] != -1} {
3495 # -fdiagnostics-color is not a rustcc option.
3497 set new_options [universal_compile_options]
3501 set getting_compiler_info 0
3502 foreach opt $options {
3503 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3504 && $type == "executable"} {
3505 if [test_compiler_info "xlc-*"] {
3506 # IBM xlc compiler doesn't accept shared library named other
3507 # than .so: use "-Wl," to bypass this
3508 lappend source "-Wl,$shlib_name"
3509 } elseif { ([istarget "*-*-mingw*"]
3510 || [istarget *-*-cygwin*]
3511 || [istarget *-*-pe*])} {
3512 lappend source "${shlib_name}.a"
3514 lappend source $shlib_name
3516 if { $shlib_found == 0 } {
3518 if { ([istarget "*-*-mingw*"]
3519 || [istarget *-*-cygwin*]) } {
3520 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3522 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3523 # Undo debian's change in the default.
3524 # Put it at the front to not override any user-provided
3525 # value, and to make sure it appears in front of all the
3527 lappend new_options "early_flags=-Wl,--no-as-needed"
3530 } elseif { $opt == "shlib_load" && $type == "executable" } {
3532 } elseif { $opt == "getting_compiler_info" } {
3533 # If this is set, calling test_compiler_info will cause recursion.
3534 set getting_compiler_info 1
3536 lappend new_options $opt
3540 # Ensure stack protector is disabled for GCC, as this causes problems with
3541 # DWARF line numbering.
3542 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3543 # This option defaults to on for Debian/Ubuntu.
3544 if { $getting_compiler_info == 0
3545 && [test_compiler_info {gcc-*-*}]
3546 && !([test_compiler_info {gcc-[0-3]-*}]
3547 || [test_compiler_info {gcc-4-0-*}]) } {
3548 # Put it at the front to not override any user-provided value.
3549 lappend new_options "early_flags=-fno-stack-protector"
3552 # Because we link with libraries using their basename, we may need
3553 # (depending on the platform) to set a special rpath value, to allow
3554 # the executable to find the libraries it depends on.
3555 if { $shlib_load || $shlib_found } {
3556 if { ([istarget "*-*-mingw*"]
3557 || [istarget *-*-cygwin*]
3558 || [istarget *-*-pe*]) } {
3559 # Do not need anything.
3560 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3561 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3562 } elseif { [istarget arm*-*-symbianelf*] } {
3563 if { $shlib_load } {
3564 lappend new_options "libs=-ldl"
3567 if { $shlib_load } {
3568 lappend new_options "libs=-ldl"
3570 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3573 set options $new_options
3575 if [info exists GDB_TESTCASE_OPTIONS] {
3576 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3578 verbose "options are $options"
3579 verbose "source is $source $dest $type $options"
3581 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3583 if {[target_info exists needs_status_wrapper] && \
3584 [target_info needs_status_wrapper] != "0" && \
3585 [info exists gdb_wrapper_file]} {
3586 lappend options "libs=${gdb_wrapper_file}"
3587 lappend options "ldflags=${gdb_wrapper_flags}"
3590 # Replace the "nowarnings" option with the appropriate additional_flags
3591 # to disable compiler warnings.
3592 set nowarnings [lsearch -exact $options nowarnings]
3593 if {$nowarnings != -1} {
3594 if [target_info exists gdb,nowarnings_flag] {
3595 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3597 set flag "additional_flags=-w"
3599 set options [lreplace $options $nowarnings $nowarnings $flag]
3602 # Replace the "nopie" option with the appropriate additional_flags
3603 # to disable PIE executables.
3604 set nopie [lsearch -exact $options nopie]
3606 if [target_info exists gdb,nopie_flag] {
3607 set flag "ldflags=[target_info gdb,nopie_flag]"
3609 set flag "ldflags=-no-pie"
3611 set options [lreplace $options $nopie $nopie $flag]
3614 if { $type == "executable" } {
3615 if { ([istarget "*-*-mingw*"]
3616 || [istarget "*-*-*djgpp"]
3617 || [istarget "*-*-cygwin*"])} {
3618 # Force output to unbuffered mode, by linking in an object file
3619 # with a global contructor that calls setvbuf.
3621 # Compile the special object seperatelly for two reasons:
3622 # 1) Insulate it from $options.
3623 # 2) Avoid compiling it for every gdb_compile invocation,
3624 # which is time consuming, especially if we're remote
3627 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3628 verbose "compiling gdb_saved_set_unbuffered_obj"
3629 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3630 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3632 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3633 if { $result != "" } {
3636 if {[is_remote host]} {
3637 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3639 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3641 # Link a copy of the output object, because the
3642 # original may be automatically deleted.
3643 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3645 verbose "gdb_saved_set_unbuffered_obj already compiled"
3648 # Rely on the internal knowledge that the global ctors are ran in
3649 # reverse link order. In that case, we can use ldflags to
3650 # avoid copying the object file to the host multiple
3652 # This object can only be added if standard libraries are
3653 # used. Thus, we need to disable it if -nostdlib option is used
3654 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3655 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3660 set result [target_compile $source $dest $type $options]
3662 # Prune uninteresting compiler (and linker) output.
3663 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3665 regsub "\[\r\n\]*$" "$result" "" result
3666 regsub "^\[\r\n\]*" "$result" "" result
3668 if {[lsearch $options quiet] < 0} {
3669 # We shall update this on a per language basis, to avoid
3670 # changing the entire testsuite in one go.
3671 if {[lsearch $options f77] >= 0} {
3672 gdb_compile_test $source $result
3673 } elseif { $result != "" } {
3674 clone_output "gdb compile failed, $result"
3681 # This is just like gdb_compile, above, except that it tries compiling
3682 # against several different thread libraries, to see which one this
3684 proc gdb_compile_pthreads {source dest type options} {
3686 set why_msg "unrecognized error"
3687 foreach lib {-lpthreads -lpthread -lthread ""} {
3688 # This kind of wipes out whatever libs the caller may have
3689 # set. Or maybe theirs will override ours. How infelicitous.
3690 set options_with_lib [concat $options [list libs=$lib quiet]]
3691 set ccout [gdb_compile $source $dest $type $options_with_lib]
3692 switch -regexp -- $ccout {
3693 ".*no posix threads support.*" {
3694 set why_msg "missing threads include file"
3697 ".*cannot open -lpthread.*" {
3698 set why_msg "missing runtime threads library"
3700 ".*Can't find library for -lpthread.*" {
3701 set why_msg "missing runtime threads library"
3704 pass "successfully compiled posix threads test case"
3710 if {!$built_binfile} {
3711 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3716 # Build a shared library from SOURCES.
3718 proc gdb_compile_shlib {sources dest options} {
3719 set obj_options $options
3722 if { [lsearch -exact $options "c++"] >= 0 } {
3723 set info_options "c++"
3725 if [get_compiler_info ${info_options}] {
3729 switch -glob [test_compiler_info] {
3731 lappend obj_options "additional_flags=-qpic"
3734 if { !([istarget "*-*-cygwin*"]
3735 || [istarget "*-*-mingw*"]) } {
3736 lappend obj_options "additional_flags=-fpic"
3740 if { !([istarget "powerpc*-*-aix*"]
3741 || [istarget "rs6000*-*-aix*"]
3742 || [istarget "*-*-cygwin*"]
3743 || [istarget "*-*-mingw*"]
3744 || [istarget "*-*-pe*"]) } {
3745 lappend obj_options "additional_flags=-fpic"
3749 lappend obj_options "additional_flags=-fpic"
3752 # don't know what the compiler is...
3756 set outdir [file dirname $dest]
3758 foreach source $sources {
3759 set sourcebase [file tail $source]
3760 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3763 lappend objects ${outdir}/${sourcebase}.o
3766 set link_options $options
3767 if [test_compiler_info "xlc-*"] {
3768 lappend link_options "additional_flags=-qmkshrobj"
3770 lappend link_options "additional_flags=-shared"
3772 if { ([istarget "*-*-mingw*"]
3773 || [istarget *-*-cygwin*]
3774 || [istarget *-*-pe*]) } {
3775 if { [is_remote host] } {
3776 set name [file tail ${dest}]
3780 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3782 # Set the soname of the library. This causes the linker on ELF
3783 # systems to create the DT_NEEDED entry in the executable referring
3784 # to the soname of the library, and not its absolute path. This
3785 # (using the absolute path) would be problem when testing on a
3788 # In conjunction with setting the soname, we add the special
3789 # rpath=$ORIGIN value when building the executable, so that it's
3790 # able to find the library in its own directory.
3791 set destbase [file tail $dest]
3792 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3795 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3798 if { [is_remote host]
3799 && ([istarget "*-*-mingw*"]
3800 || [istarget *-*-cygwin*]
3801 || [istarget *-*-pe*]) } {
3802 set dest_tail_name [file tail ${dest}]
3803 remote_upload host $dest_tail_name.a ${dest}.a
3804 remote_file host delete $dest_tail_name.a
3810 # This is just like gdb_compile_shlib, above, except that it tries compiling
3811 # against several different thread libraries, to see which one this
3813 proc gdb_compile_shlib_pthreads {sources dest options} {
3815 set why_msg "unrecognized error"
3816 foreach lib {-lpthreads -lpthread -lthread ""} {
3817 # This kind of wipes out whatever libs the caller may have
3818 # set. Or maybe theirs will override ours. How infelicitous.
3819 set options_with_lib [concat $options [list libs=$lib quiet]]
3820 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3821 switch -regexp -- $ccout {
3822 ".*no posix threads support.*" {
3823 set why_msg "missing threads include file"
3826 ".*cannot open -lpthread.*" {
3827 set why_msg "missing runtime threads library"
3829 ".*Can't find library for -lpthread.*" {
3830 set why_msg "missing runtime threads library"
3833 pass "successfully compiled posix threads test case"
3839 if {!$built_binfile} {
3840 unsupported "couldn't compile $sources: ${why_msg}"
3845 # This is just like gdb_compile_pthreads, above, except that we always add the
3846 # objc library for compiling Objective-C programs
3847 proc gdb_compile_objc {source dest type options} {
3849 set why_msg "unrecognized error"
3850 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3851 # This kind of wipes out whatever libs the caller may have
3852 # set. Or maybe theirs will override ours. How infelicitous.
3853 if { $lib == "solaris" } {
3854 set lib "-lpthread -lposix4"
3856 if { $lib != "-lobjc" } {
3857 set lib "-lobjc $lib"
3859 set options_with_lib [concat $options [list libs=$lib quiet]]
3860 set ccout [gdb_compile $source $dest $type $options_with_lib]
3861 switch -regexp -- $ccout {
3862 ".*no posix threads support.*" {
3863 set why_msg "missing threads include file"
3866 ".*cannot open -lpthread.*" {
3867 set why_msg "missing runtime threads library"
3869 ".*Can't find library for -lpthread.*" {
3870 set why_msg "missing runtime threads library"
3873 pass "successfully compiled objc with posix threads test case"
3879 if {!$built_binfile} {
3880 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3885 proc send_gdb { string } {
3886 global suppress_flag
3887 if { $suppress_flag } {
3890 return [remote_send host "$string"]
3893 # Send STRING to the inferior's terminal.
3895 proc send_inferior { string } {
3896 global inferior_spawn_id
3898 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3908 proc gdb_expect { args } {
3909 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3910 set atimeout [lindex $args 0]
3911 set expcode [list [lindex $args 1]]
3916 # A timeout argument takes precedence, otherwise of all the timeouts
3917 # select the largest.
3918 if [info exists atimeout] {
3921 set tmt [get_largest_timeout]
3924 global suppress_flag
3925 global remote_suppress_flag
3926 if [info exists remote_suppress_flag] {
3927 set old_val $remote_suppress_flag
3929 if [info exists suppress_flag] {
3930 if { $suppress_flag } {
3931 set remote_suppress_flag 1
3935 {uplevel remote_expect host $tmt $expcode} string]
3936 if [info exists old_val] {
3937 set remote_suppress_flag $old_val
3939 if [info exists remote_suppress_flag] {
3940 unset remote_suppress_flag
3945 global errorInfo errorCode
3947 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3949 return -code $code $string
3953 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3955 # Check for long sequence of output by parts.
3956 # TEST: is the test message to be printed with the test success/fail.
3957 # SENTINEL: Is the terminal pattern indicating that output has finished.
3958 # LIST: is the sequence of outputs to match.
3959 # If the sentinel is recognized early, it is considered an error.
3962 # 1 if the test failed,
3963 # 0 if the test passes,
3964 # -1 if there was an internal error.
3966 proc gdb_expect_list {test sentinel list} {
3968 global suppress_flag
3971 if { $suppress_flag } {
3973 unresolved "${test}"
3975 while { ${index} < [llength ${list}] } {
3976 set pattern [lindex ${list} ${index}]
3977 set index [expr ${index} + 1]
3978 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3979 if { ${index} == [llength ${list}] } {
3982 -re "${pattern}${sentinel}" {
3983 # pass "${test}, pattern ${index} + sentinel"
3986 fail "${test} (pattern ${index} + sentinel)"
3989 -re ".*A problem internal to GDB has been detected" {
3990 fail "${test} (GDB internal error)"
3992 gdb_internal_error_resync
3995 fail "${test} (pattern ${index} + sentinel) (timeout)"
4000 # unresolved "${test}, pattern ${index} + sentinel"
4006 # pass "${test}, pattern ${index}"
4009 fail "${test} (pattern ${index})"
4012 -re ".*A problem internal to GDB has been detected" {
4013 fail "${test} (GDB internal error)"
4015 gdb_internal_error_resync
4018 fail "${test} (pattern ${index}) (timeout)"
4023 # unresolved "${test}, pattern ${index}"
4037 proc gdb_suppress_entire_file { reason } {
4038 global suppress_flag
4041 set suppress_flag -1
4045 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4046 # gdb_expect to fail immediately (until the next call to
4047 # gdb_stop_suppressing_tests).
4049 proc gdb_suppress_tests { args } {
4050 global suppress_flag
4052 return; # fnf - disable pending review of results where
4053 # testsuite ran better without this
4056 if { $suppress_flag == 1 } {
4057 if { [llength $args] > 0 } {
4058 warning "[lindex $args 0]\n"
4060 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4066 # Clear suppress_flag.
4068 proc gdb_stop_suppressing_tests { } {
4069 global suppress_flag
4071 if [info exists suppress_flag] {
4072 if { $suppress_flag > 0 } {
4074 clone_output "Tests restarted.\n"
4081 proc gdb_clear_suppressed { } {
4082 global suppress_flag
4087 # Spawn the gdb process.
4089 # This doesn't expect any output or do any other initialization,
4090 # leaving those to the caller.
4092 # Overridable function -- you can override this function in your
4095 proc gdb_spawn { } {
4099 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4101 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4104 set saved_gdbflags $GDBFLAGS
4106 if {$GDBFLAGS != ""} {
4109 append GDBFLAGS $cmdline_flags
4113 set GDBFLAGS $saved_gdbflags
4118 # Start gdb running, wait for prompt, and disable the pagers.
4120 # Overridable function -- you can override this function in your
4123 proc gdb_start { } {
4128 catch default_gdb_exit
4131 # Return true if we can spawn a program on the target and attach to
4134 proc can_spawn_for_attach { } {
4135 # We use exp_pid to get the inferior's pid, assuming that gives
4136 # back the pid of the program. On remote boards, that would give
4137 # us instead the PID of e.g., the ssh client, etc.
4138 if [is_remote target] then {
4142 # The "attach" command doesn't make sense when the target is
4143 # stub-like, where GDB finds the program already started on
4144 # initial connection.
4145 if {[target_info exists use_gdb_stub]} {
4153 # Kill a progress previously started with spawn_wait_for_attach, and
4154 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4157 proc kill_wait_spawned_process { proc_spawn_id } {
4158 set pid [exp_pid -i $proc_spawn_id]
4160 verbose -log "killing ${pid}"
4161 remote_exec build "kill -9 ${pid}"
4163 verbose -log "closing ${proc_spawn_id}"
4164 catch "close -i $proc_spawn_id"
4165 verbose -log "waiting for ${proc_spawn_id}"
4167 # If somehow GDB ends up still attached to the process here, a
4168 # blocking wait hangs until gdb is killed (or until gdb / the
4169 # ptracer reaps the exit status too, but that won't happen because
4170 # something went wrong.) Passing -nowait makes expect tell Tcl to
4171 # wait for the PID in the background. That's fine because we
4172 # don't care about the exit status. */
4173 wait -nowait -i $proc_spawn_id
4176 # Returns the process id corresponding to the given spawn id.
4178 proc spawn_id_get_pid { spawn_id } {
4179 set testpid [exp_pid -i $spawn_id]
4181 if { [istarget "*-*-cygwin*"] } {
4182 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4183 # might be different due to the way fork/exec works.
4184 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4190 # Start a set of programs running and then wait for a bit, to be sure
4191 # that they can be attached to. Return a list of processes spawn IDs,
4192 # one element for each process spawned. It's a test error to call
4193 # this when [can_spawn_for_attach] is false.
4195 proc spawn_wait_for_attach { executable_list } {
4196 set spawn_id_list {}
4198 if ![can_spawn_for_attach] {
4199 # The caller should have checked can_spawn_for_attach itself
4200 # before getting here.
4201 error "can't spawn for attach with this target/board"
4204 foreach {executable} $executable_list {
4205 # Note we use Expect's spawn, not Tcl's exec, because with
4206 # spawn we control when to wait for/reap the process. That
4207 # allows killing the process by PID without being subject to
4209 lappend spawn_id_list [remote_spawn target $executable]
4214 return $spawn_id_list
4218 # gdb_load_cmd -- load a file into the debugger.
4219 # ARGS - additional args to load command.
4220 # return a -1 if anything goes wrong.
4222 proc gdb_load_cmd { args } {
4225 if [target_info exists gdb_load_timeout] {
4226 set loadtimeout [target_info gdb_load_timeout]
4228 set loadtimeout 1600
4230 send_gdb "load $args\n"
4231 verbose "Timeout is now $loadtimeout seconds" 2
4232 gdb_expect $loadtimeout {
4233 -re "Loading section\[^\r\]*\r\n" {
4236 -re "Start address\[\r\]*\r\n" {
4239 -re "Transfer rate\[\r\]*\r\n" {
4242 -re "Memory access error\[^\r\]*\r\n" {
4243 perror "Failed to load program"
4246 -re "$gdb_prompt $" {
4249 -re "(.*)\r\n$gdb_prompt " {
4250 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4254 perror "Timed out trying to load $args."
4261 # Invoke "gcore". CORE is the name of the core file to write. TEST
4262 # is the name of the test case. This will return 1 if the core file
4263 # was created, 0 otherwise. If this fails to make a core file because
4264 # this configuration of gdb does not support making core files, it
4265 # will call "unsupported", not "fail". However, if this fails to make
4266 # a core file for some other reason, then it will call "fail".
4268 proc gdb_gcore_cmd {core test} {
4272 gdb_test_multiple "gcore $core" $test {
4273 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4277 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4285 # Load core file CORE. TEST is the name of the test case.
4286 # This will record a pass/fail for loading the core file.
4288 # 1 - core file is successfully loaded
4289 # 0 - core file loaded but has a non fatal error
4290 # -1 - core file failed to load
4292 proc gdb_core_cmd { core test } {
4295 gdb_test_multiple "core $core" "$test" {
4296 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4299 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4300 fail "$test (bad file format)"
4303 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4304 fail "$test (file not found)"
4307 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4308 fail "$test (incomplete note section)"
4311 -re "Core was generated by .*\r\n$gdb_prompt $" {
4315 -re ".*$gdb_prompt $" {
4320 fail "$test (timeout)"
4324 fail "unsupported output from 'core' command"
4328 # Return the filename to download to the target and load on the target
4329 # for this shared library. Normally just LIBNAME, unless shared libraries
4330 # for this target have separate link and load images.
4332 proc shlib_target_file { libname } {
4336 # Return the filename GDB will load symbols from when debugging this
4337 # shared library. Normally just LIBNAME, unless shared libraries for
4338 # this target have separate link and load images.
4340 proc shlib_symbol_file { libname } {
4344 # Return the filename to download to the target and load for this
4345 # executable. Normally just BINFILE unless it is renamed to something
4346 # else for this target.
4348 proc exec_target_file { binfile } {
4352 # Return the filename GDB will load symbols from when debugging this
4353 # executable. Normally just BINFILE unless executables for this target
4354 # have separate files for symbols.
4356 proc exec_symbol_file { binfile } {
4360 # Rename the executable file. Normally this is just BINFILE1 being renamed
4361 # to BINFILE2, but some targets require multiple binary files.
4362 proc gdb_rename_execfile { binfile1 binfile2 } {
4363 file rename -force [exec_target_file ${binfile1}] \
4364 [exec_target_file ${binfile2}]
4365 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4366 file rename -force [exec_symbol_file ${binfile1}] \
4367 [exec_symbol_file ${binfile2}]
4371 # "Touch" the executable file to update the date. Normally this is just
4372 # BINFILE, but some targets require multiple files.
4373 proc gdb_touch_execfile { binfile } {
4374 set time [clock seconds]
4375 file mtime [exec_target_file ${binfile}] $time
4376 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4377 file mtime [exec_symbol_file ${binfile}] $time
4381 # Like remote_download but provides a gdb-specific behavior.
4383 # If the destination board is remote, the local file FROMFILE is transferred as
4384 # usual with remote_download to TOFILE on the remote board. The destination
4385 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4388 # If the destination board is local, the destination path TOFILE is passed
4389 # through standard_output_file, and FROMFILE is copied there.
4391 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4394 proc gdb_remote_download {dest fromfile {tofile {}}} {
4395 # If TOFILE is not given, default to the same filename as FROMFILE.
4396 if {[string length $tofile] == 0} {
4397 set tofile [file tail $fromfile]
4400 if {[is_remote $dest]} {
4401 # When the DEST is remote, we simply send the file to DEST.
4404 set destname [remote_download $dest $fromfile $tofile]
4405 lappend cleanfiles $destname
4409 # When the DEST is local, we copy the file to the test directory (where
4410 # the executable is).
4412 # Note that we pass TOFILE through standard_output_file, regardless of
4413 # whether it is absolute or relative, because we don't want the tests
4414 # to be able to write outside their standard output directory.
4416 set tofile [standard_output_file $tofile]
4418 file copy -force $fromfile $tofile
4424 # gdb_load_shlib LIB...
4426 # Copy the listed library to the target.
4428 proc gdb_load_shlib { file } {
4431 if ![info exists gdb_spawn_id] {
4432 perror "gdb_load_shlib: GDB is not running"
4435 set dest [gdb_remote_download target [shlib_target_file $file]]
4437 if {[is_remote target]} {
4438 # If the target is remote, we need to tell gdb where to find the
4441 # We could set this even when not testing remotely, but a user
4442 # generally won't set it unless necessary. In order to make the tests
4443 # more like the real-life scenarios, we don't set it for local testing.
4444 gdb_test "set solib-search-path [file dirname $file]" "" ""
4451 # gdb_load -- load a file into the debugger. Specifying no file
4452 # defaults to the executable currently being debugged.
4453 # The return value is 0 for success, -1 for failure.
4454 # Many files in config/*.exp override this procedure.
4456 proc gdb_load { arg } {
4458 return [gdb_file_cmd $arg]
4463 # gdb_reload -- load a file into the target. Called before "running",
4464 # either the first time or after already starting the program once,
4465 # for remote targets. Most files that override gdb_load should now
4466 # override this instead.
4468 proc gdb_reload { } {
4469 # For the benefit of existing configurations, default to gdb_load.
4470 # Specifying no file defaults to the executable currently being
4472 return [gdb_load ""]
4475 proc gdb_continue { function } {
4478 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4481 proc default_gdb_init { test_file_name } {
4482 global gdb_wrapper_initialized
4483 global gdb_wrapper_target
4484 global gdb_test_file_name
4490 gdb_clear_suppressed
4492 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4494 # Make sure that the wrapper is rebuilt
4495 # with the appropriate multilib option.
4496 if { $gdb_wrapper_target != [current_target_name] } {
4497 set gdb_wrapper_initialized 0
4500 # Unlike most tests, we have a small number of tests that generate
4501 # a very large amount of output. We therefore increase the expect
4502 # buffer size to be able to contain the entire test output. This
4503 # is especially needed by gdb.base/info-macros.exp.
4505 # Also set this value for the currently running GDB.
4506 match_max [match_max -d]
4508 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4509 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4512 if [target_info exists gdb_prompt] {
4513 set gdb_prompt [target_info gdb_prompt]
4515 set gdb_prompt "\\(gdb\\)"
4518 if [info exists use_gdb_stub] {
4523 # Return a path using GDB_PARALLEL.
4524 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4525 # GDB_PARALLEL must be defined, the caller must check.
4527 # The default value for GDB_PARALLEL is, canonically, ".".
4528 # The catch is that tests don't expect an additional "./" in file paths so
4529 # omit any directory for the default case.
4530 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4531 # its special handling.
4533 proc make_gdb_parallel_path { args } {
4534 global GDB_PARALLEL objdir
4535 set joiner [list "file" "join" $objdir]
4536 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4537 lappend joiner $GDB_PARALLEL
4539 set joiner [concat $joiner $args]
4540 return [eval $joiner]
4543 # Turn BASENAME into a full file name in the standard output
4544 # directory. It is ok if BASENAME is the empty string; in this case
4545 # the directory is returned.
4547 proc standard_output_file {basename} {
4548 global objdir subdir gdb_test_file_name
4550 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4552 return [file join $dir $basename]
4555 # Return the name of a file in our standard temporary directory.
4557 proc standard_temp_file {basename} {
4558 # Since a particular runtest invocation is only executing a single test
4559 # file at any given time, we can use the runtest pid to build the
4560 # path of the temp directory.
4561 set dir [make_gdb_parallel_path temp [pid]]
4563 return [file join $dir $basename]
4566 # Set 'testfile', 'srcfile', and 'binfile'.
4568 # ARGS is a list of source file specifications.
4569 # Without any arguments, the .exp file's base name is used to
4570 # compute the source file name. The ".c" extension is added in this case.
4571 # If ARGS is not empty, each entry is a source file specification.
4572 # If the specification starts with a ".", it is treated as a suffix
4573 # to append to the .exp file's base name.
4574 # If the specification is the empty string, it is treated as if it
4576 # Otherwise it is a file name.
4577 # The first file in the list is used to set the 'srcfile' global.
4578 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4580 # Most tests should call this without arguments.
4582 # If a completely different binary file name is needed, then it
4583 # should be handled in the .exp file with a suitable comment.
4585 proc standard_testfile {args} {
4586 global gdb_test_file_name
4588 global gdb_test_file_last_vars
4591 global testfile binfile
4593 set testfile $gdb_test_file_name
4594 set binfile [standard_output_file ${testfile}]
4596 if {[llength $args] == 0} {
4600 # Unset our previous output variables.
4601 # This can help catch hidden bugs.
4602 if {[info exists gdb_test_file_last_vars]} {
4603 foreach varname $gdb_test_file_last_vars {
4605 catch {unset $varname}
4608 # 'executable' is often set by tests.
4609 set gdb_test_file_last_vars {executable}
4613 set varname srcfile$suffix
4616 # Handle an extension.
4619 } elseif {[string range $arg 0 0] == "."} {
4620 set arg $testfile$arg
4624 lappend gdb_test_file_last_vars $varname
4626 if {$suffix == ""} {
4634 # The default timeout used when testing GDB commands. We want to use
4635 # the same timeout as the default dejagnu timeout, unless the user has
4636 # already provided a specific value (probably through a site.exp file).
4637 global gdb_test_timeout
4638 if ![info exists gdb_test_timeout] {
4639 set gdb_test_timeout $timeout
4642 # A list of global variables that GDB testcases should not use.
4643 # We try to prevent their use by monitoring write accesses and raising
4644 # an error when that happens.
4645 set banned_variables { bug_id prms_id }
4647 # A list of procedures that GDB testcases should not use.
4648 # We try to prevent their use by monitoring invocations and raising
4649 # an error when that happens.
4650 set banned_procedures { strace }
4652 # gdb_init is called by runtest at start, but also by several
4653 # tests directly; gdb_finish is only called from within runtest after
4654 # each test source execution.
4655 # Placing several traces by repetitive calls to gdb_init leads
4656 # to problems, as only one trace is removed in gdb_finish.
4657 # To overcome this possible problem, we add a variable that records
4658 # if the banned variables and procedures are already traced.
4661 proc gdb_init { test_file_name } {
4662 # Reset the timeout value to the default. This way, any testcase
4663 # that changes the timeout value without resetting it cannot affect
4664 # the timeout used in subsequent testcases.
4665 global gdb_test_timeout
4667 set timeout $gdb_test_timeout
4669 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4670 && [target_info exists gdb_reverse_timeout] } {
4671 set timeout [target_info gdb_reverse_timeout]
4674 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4675 # debugging tool to help confirm that the test suite is
4676 # parallel-safe. You need "inotifywait" from the
4677 # inotify-tools package to use this.
4678 global GDB_INOTIFY inotify_pid
4679 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4680 global outdir tool inotify_log_file
4682 set exclusions {outputs temp gdb[.](log|sum) cache}
4683 set exclusion_re ([join $exclusions |])
4685 set inotify_log_file [standard_temp_file inotify.out]
4686 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4687 --exclude $exclusion_re \
4688 |& tee -a $outdir/$tool.log $inotify_log_file &]
4690 # Wait for the watches; hopefully this is long enough.
4693 # Clear the log so that we don't emit a warning the first time
4695 set fd [open $inotify_log_file w]
4699 # Block writes to all banned variables, and invocation of all
4700 # banned procedures...
4701 global banned_variables
4702 global banned_procedures
4703 global banned_traced
4704 if (!$banned_traced) {
4705 foreach banned_var $banned_variables {
4706 global "$banned_var"
4707 trace add variable "$banned_var" write error
4709 foreach banned_proc $banned_procedures {
4710 global "$banned_proc"
4711 trace add execution "$banned_proc" enter error
4716 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4717 # messages as expected.
4722 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4723 # the test results. Even if /dev/null doesn't exist on the particular
4724 # platform, the readline library will use the default setting just by
4725 # failing to open the file. OTOH, opening /dev/null successfully will
4726 # also result in the default settings being used since nothing will be
4727 # read from this file.
4728 setenv INPUTRC "/dev/null"
4730 # This disables style output, which would interfere with many
4734 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
4735 # during startup. See "man expect" for details about stty_init.
4737 set stty_init "rows 25 cols 80"
4739 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4740 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4741 # especially having color output turned on can cause tests to fail.
4742 setenv GREP_OPTIONS ""
4744 # Clear $gdbserver_reconnect_p.
4745 global gdbserver_reconnect_p
4746 set gdbserver_reconnect_p 1
4747 unset gdbserver_reconnect_p
4749 return [default_gdb_init $test_file_name]
4752 proc gdb_finish { } {
4753 global gdbserver_reconnect_p
4757 # Exit first, so that the files are no longer in use.
4760 if { [llength $cleanfiles] > 0 } {
4761 eval remote_file target delete $cleanfiles
4765 # Unblock write access to the banned variables. Dejagnu typically
4766 # resets some of them between testcases.
4767 global banned_variables
4768 global banned_procedures
4769 global banned_traced
4770 if ($banned_traced) {
4771 foreach banned_var $banned_variables {
4772 global "$banned_var"
4773 trace remove variable "$banned_var" write error
4775 foreach banned_proc $banned_procedures {
4776 global "$banned_proc"
4777 trace remove execution "$banned_proc" enter error
4784 set debug_format "unknown"
4786 # Run the gdb command "info source" and extract the debugging format
4787 # information from the output and save it in debug_format.
4789 proc get_debug_format { } {
4795 set debug_format "unknown"
4796 send_gdb "info source\n"
4798 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4799 set debug_format $expect_out(1,string)
4800 verbose "debug format is $debug_format"
4803 -re "No current source file.\r\n$gdb_prompt $" {
4804 perror "get_debug_format used when no current source file"
4807 -re "$gdb_prompt $" {
4808 warning "couldn't check debug format (no valid response)."
4812 warning "couldn't check debug format (timeout)."
4818 # Return true if FORMAT matches the debug format the current test was
4819 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4820 # `*', `[...]', and so on.
4822 # This function depends on variables set by `get_debug_format', above.
4824 proc test_debug_format {format} {
4827 return [expr [string match $format $debug_format] != 0]
4830 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4831 # COFF, stabs, etc). If that format matches the format that the
4832 # current test was compiled with, then the next test is expected to
4833 # fail for any target. Returns 1 if the next test or set of tests is
4834 # expected to fail, 0 otherwise (or if it is unknown). Must have
4835 # previously called get_debug_format.
4836 proc setup_xfail_format { format } {
4837 set ret [test_debug_format $format]
4845 # gdb_get_line_number TEXT [FILE]
4847 # Search the source file FILE, and return the line number of the
4848 # first line containing TEXT. If no match is found, an error is thrown.
4850 # TEXT is a string literal, not a regular expression.
4852 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4853 # specified, and does not start with "/", then it is assumed to be in
4854 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4855 # by changing the callers and the interface at the same time.
4856 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4857 # gdb.base/ena-dis-br.exp.
4859 # Use this function to keep your test scripts independent of the
4860 # exact line numbering of the source file. Don't write:
4862 # send_gdb "break 20"
4864 # This means that if anyone ever edits your test's source file,
4865 # your test could break. Instead, put a comment like this on the
4866 # source file line you want to break at:
4868 # /* breakpoint spot: frotz.exp: test name */
4870 # and then write, in your test script (which we assume is named
4873 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4875 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4878 # % puts "foo [lindex "bar baz" 1]"
4881 # Tcl is quite clever, for a little stringy language.)
4885 # The previous implementation of this procedure used the gdb search command.
4886 # This version is different:
4888 # . It works with MI, and it also works when gdb is not running.
4890 # . It operates on the build machine, not the host machine.
4892 # . For now, this implementation fakes a current directory of
4893 # $srcdir/$subdir to be compatible with the old implementation.
4894 # This will go away eventually and some callers will need to
4897 # . The TEXT argument is literal text and matches literally,
4898 # not a regular expression as it was before.
4900 # . State changes in gdb, such as changing the current file
4901 # and setting $_, no longer happen.
4903 # After a bit of time we can forget about the differences from the
4904 # old implementation.
4906 # --chastain 2004-08-05
4908 proc gdb_get_line_number { text { file "" } } {
4913 if { "$file" == "" } then {
4916 if { ! [regexp "^/" "$file"] } then {
4917 set file "$srcdir/$subdir/$file"
4920 if { [ catch { set fd [open "$file"] } message ] } then {
4925 for { set line 1 } { 1 } { incr line } {
4926 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4929 if { $nchar < 0 } then {
4932 if { [string first "$text" "$body"] >= 0 } then {
4938 if { [ catch { close "$fd" } message ] } then {
4943 error "undefined tag \"$text\""
4949 # Continue the program until it ends.
4951 # MSSG is the error message that gets printed. If not given, a
4953 # COMMAND is the command to invoke. If not given, "continue" is
4955 # ALLOW_EXTRA is a flag indicating whether the test should expect
4956 # extra output between the "Continuing." line and the program
4957 # exiting. By default it is zero; if nonzero, any extra output
4960 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4961 global inferior_exited_re use_gdb_stub
4964 set text "continue until exit"
4966 set text "continue until exit at $mssg"
4974 # By default, we don't rely on exit() behavior of remote stubs --
4975 # it's common for exit() to be implemented as a simple infinite
4976 # loop, or a forced crash/reset. For native targets, by default, we
4977 # assume process exit is reported as such. If a non-reliable target
4978 # is used, we set a breakpoint at exit, and continue to that.
4979 if { [target_info exists exit_is_reliable] } {
4980 set exit_is_reliable [target_info exit_is_reliable]
4982 set exit_is_reliable [expr ! $use_gdb_stub]
4985 if { ! $exit_is_reliable } {
4986 if {![gdb_breakpoint "exit"]} {
4989 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4992 # Continue until we exit. Should not stop again.
4993 # Don't bother to check the output of the program, that may be
4994 # extremely tough for some remote systems.
4996 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5001 proc rerun_to_main {} {
5002 global gdb_prompt use_gdb_stub
5007 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5008 {pass "rerun to main" ; return 0}
5009 -re "$gdb_prompt $"\
5010 {fail "rerun to main" ; return 0}
5011 timeout {fail "(timeout) rerun to main" ; return 0}
5016 -re "The program .* has been started already.*y or n. $" {
5020 -re "Starting program.*$gdb_prompt $"\
5021 {pass "rerun to main" ; return 0}
5022 -re "$gdb_prompt $"\
5023 {fail "rerun to main" ; return 0}
5024 timeout {fail "(timeout) rerun to main" ; return 0}
5029 # Return true if a test should be skipped due to lack of floating
5030 # point support or GDB can't fetch the contents from floating point
5033 gdb_caching_proc gdb_skip_float_test {
5034 if [target_info exists gdb,skip_float_tests] {
5038 # There is an ARM kernel ptrace bug that hardware VFP registers
5039 # are not updated after GDB ptrace set VFP registers. The bug
5040 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5041 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5042 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5043 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5044 # This kernel bug is detected by check how does GDB change the
5045 # program result by changing one VFP register.
5046 if { [istarget "arm*-*-linux*"] } {
5048 set compile_flags {debug nowarnings }
5050 # Set up, compile, and execute a test program having VFP
5052 set src [standard_temp_file arm_vfp[pid].c]
5053 set exe [standard_temp_file arm_vfp[pid].x]
5055 gdb_produce_source $src {
5060 asm ("vldr d0, [%0]" : : "r" (&d));
5061 asm ("vldr d1, [%0]" : : "r" (&d));
5062 asm (".global break_here\n"
5064 asm ("vcmp.f64 d0, d1\n"
5065 "vmrs APSR_nzcv, fpscr\n"
5066 "bne L_value_different\n"
5069 "L_value_different:\n"
5071 "L_end:\n" : "=r" (ret) :);
5073 /* Return $d0 != $d1. */
5078 verbose "compiling testfile $src" 2
5079 set lines [gdb_compile $src $exe executable $compile_flags]
5082 if ![string match "" $lines] then {
5083 verbose "testfile compilation failed, returning 1" 2
5087 # No error message, compilation succeeded so now run it via gdb.
5088 # Run the test up to 5 times to detect whether ptrace can
5089 # correctly update VFP registers or not.
5091 for {set i 0} {$i < 5} {incr i} {
5092 global gdb_prompt srcdir subdir
5096 gdb_reinitialize_dir $srcdir/$subdir
5100 gdb_test "break *break_here"
5101 gdb_continue_to_breakpoint "break_here"
5103 # Modify $d0 to a different value, so the exit code should
5105 gdb_test "set \$d0 = 5.0"
5107 set test "continue to exit"
5108 gdb_test_multiple "continue" "$test" {
5109 -re "exited with code 01.*$gdb_prompt $" {
5111 -re "exited normally.*$gdb_prompt $" {
5112 # However, the exit code is 0. That means something
5113 # wrong in setting VFP registers.
5121 remote_file build delete $exe
5123 return $skip_vfp_test
5128 # Print a message and return true if a test should be skipped
5129 # due to lack of stdio support.
5131 proc gdb_skip_stdio_test { msg } {
5132 if [target_info exists gdb,noinferiorio] {
5133 verbose "Skipping test '$msg': no inferior i/o."
5139 proc gdb_skip_bogus_test { msg } {
5143 # Return true if a test should be skipped due to lack of XML support
5145 # NOTE: This must be called while gdb is *not* running.
5147 gdb_caching_proc gdb_skip_xml_test {
5152 if { [info exists gdb_spawn_id] } {
5153 error "GDB must not be running in gdb_skip_xml_tests."
5156 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5160 gdb_test_multiple "set tdesc filename $xml_file" "" {
5161 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5164 -re ".*$gdb_prompt $" { }
5170 # Return true if argv[0] is available.
5172 gdb_caching_proc gdb_has_argv0 {
5175 # Compile and execute a test program to check whether argv[0] is available.
5176 gdb_simple_compile has_argv0 {
5177 int main (int argc, char **argv) {
5184 proc gdb_has_argv0_1 { exe } {
5185 global srcdir subdir
5186 global gdb_prompt hex
5190 gdb_reinitialize_dir $srcdir/$subdir
5193 # Set breakpoint on main.
5194 gdb_test_multiple "break main" "break main" {
5195 -re "Breakpoint.*${gdb_prompt} $" {
5197 -re "${gdb_prompt} $" {
5204 gdb_test_multiple "" "run to main" {
5205 -re "Breakpoint.*${gdb_prompt} $" {
5207 -re "${gdb_prompt} $" {
5212 set old_elements "200"
5213 set test "show print elements"
5214 gdb_test_multiple $test $test {
5215 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5216 set old_elements $expect_out(1,string)
5219 set old_repeats "200"
5220 set test "show print repeats"
5221 gdb_test_multiple $test $test {
5222 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5223 set old_repeats $expect_out(1,string)
5226 gdb_test_no_output "set print elements unlimited" ""
5227 gdb_test_no_output "set print repeats unlimited" ""
5230 # Check whether argc is 1.
5231 gdb_test_multiple "p argc" "p argc" {
5232 -re " = 1\r\n${gdb_prompt} $" {
5234 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5235 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5238 -re "${gdb_prompt} $" {
5242 -re "${gdb_prompt} $" {
5246 gdb_test_no_output "set print elements $old_elements" ""
5247 gdb_test_no_output "set print repeats $old_repeats" ""
5252 set result [gdb_has_argv0_1 $obj]
5258 && ([istarget *-*-linux*]
5259 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5260 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5261 || [istarget *-*-openbsd*]
5262 || [istarget *-*-darwin*]
5263 || [istarget *-*-solaris*]
5264 || [istarget *-*-aix*]
5265 || [istarget *-*-gnu*]
5266 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5267 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5268 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5269 || [istarget *-*-symbianelf*]
5270 || [istarget *-*-osf*]
5271 || [istarget *-*-dicos*]
5272 || [istarget *-*-nto*]
5273 || [istarget *-*-*vms*]
5274 || [istarget *-*-lynx*178]) } {
5275 fail "argv\[0\] should be available on this target"
5281 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5282 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5283 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5284 # the name of a debuginfo only file. This file will be stored in the same
5287 # Functions for separate debug info testing
5289 # starting with an executable:
5290 # foo --> original executable
5292 # at the end of the process we have:
5293 # foo.stripped --> foo w/o debug info
5294 # foo.debug --> foo's debug info
5295 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5297 # Fetch the build id from the file.
5298 # Returns "" if there is none.
5300 proc get_build_id { filename } {
5301 if { ([istarget "*-*-mingw*"]
5302 || [istarget *-*-cygwin*]) } {
5303 set objdump_program [gdb_find_objdump]
5304 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5305 verbose "result is $result"
5306 verbose "output is $output"
5312 set tmp [standard_output_file "${filename}-tmp"]
5313 set objcopy_program [gdb_find_objcopy]
5314 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5315 verbose "result is $result"
5316 verbose "output is $output"
5321 fconfigure $fi -translation binary
5322 # Skip the NOTE header.
5327 if ![string compare $data ""] then {
5330 # Convert it to hex.
5331 binary scan $data H* data
5336 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5337 # converted to the form: .build-id/ab/cdef1234...89.debug
5338 # Return "" if no build-id found.
5339 proc build_id_debug_filename_get { filename } {
5340 set data [get_build_id $filename]
5341 if { $data == "" } {
5344 regsub {^..} $data {\0/} data
5345 return ".build-id/${data}.debug"
5348 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5349 # list of optional flags. The only currently supported flag is no-main,
5350 # which removes the symbol entry for main from the separate debug file.
5352 # Function returns zero on success. Function will return non-zero failure code
5353 # on some targets not supporting separate debug info (such as i386-msdos).
5355 proc gdb_gnu_strip_debug { dest args } {
5357 # Use the first separate debug info file location searched by GDB so the
5358 # run cannot be broken by some stale file searched with higher precedence.
5359 set debug_file "${dest}.debug"
5361 set strip_to_file_program [transform strip]
5362 set objcopy_program [gdb_find_objcopy]
5364 set debug_link [file tail $debug_file]
5365 set stripped_file "${dest}.stripped"
5367 # Get rid of the debug info, and store result in stripped_file
5368 # something like gdb/testsuite/gdb.base/blah.stripped.
5369 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5370 verbose "result is $result"
5371 verbose "output is $output"
5376 # Workaround PR binutils/10802:
5377 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5378 set perm [file attributes ${dest} -permissions]
5379 file attributes ${stripped_file} -permissions $perm
5381 # Get rid of everything but the debug info, and store result in debug_file
5382 # This will be in the .debug subdirectory, see above.
5383 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5384 verbose "result is $result"
5385 verbose "output is $output"
5390 # If no-main is passed, strip the symbol for main from the separate
5391 # file. This is to simulate the behavior of elfutils's eu-strip, which
5392 # leaves the symtab in the original file only. There's no way to get
5393 # objcopy or strip to remove the symbol table without also removing the
5394 # debugging sections, so this is as close as we can get.
5395 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5396 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5397 verbose "result is $result"
5398 verbose "output is $output"
5402 file delete "${debug_file}"
5403 file rename "${debug_file}-tmp" "${debug_file}"
5406 # Link the two previous output files together, adding the .gnu_debuglink
5407 # section to the stripped_file, containing a pointer to the debug_file,
5408 # save the new file in dest.
5409 # This will be the regular executable filename, in the usual location.
5410 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5411 verbose "result is $result"
5412 verbose "output is $output"
5417 # Workaround PR binutils/10802:
5418 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5419 set perm [file attributes ${stripped_file} -permissions]
5420 file attributes ${dest} -permissions $perm
5425 # Test the output of GDB_COMMAND matches the pattern obtained
5426 # by concatenating all elements of EXPECTED_LINES. This makes
5427 # it possible to split otherwise very long string into pieces.
5428 # If third argument is not empty, it's used as the name of the
5429 # test to be printed on pass/fail.
5430 proc help_test_raw { gdb_command expected_lines args } {
5431 set message $gdb_command
5432 if [llength $args]>0 then {
5433 set message [lindex $args 0]
5435 set expected_output [join $expected_lines ""]
5436 gdb_test "${gdb_command}" "${expected_output}" $message
5439 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5440 # are regular expressions that should match the beginning of output,
5441 # before the list of commands in that class. The presence of
5442 # command list and standard epilogue will be tested automatically.
5443 # Notice that the '[' and ']' characters don't need to be escaped for strings
5444 # wrapped in {} braces.
5445 proc test_class_help { command_class expected_initial_lines args } {
5447 "List of commands\:.*[\r\n]+"
5448 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5449 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5450 "Command name abbreviations are allowed if unambiguous\."
5452 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5454 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5457 # COMMAND_LIST should have either one element -- command to test, or
5458 # two elements -- abbreviated command to test, and full command the first
5459 # element is abbreviation of.
5460 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5461 # are regular expressions that should match the beginning of output,
5462 # before the list of subcommands. The presence of
5463 # subcommand list and standard epilogue will be tested automatically.
5464 proc test_prefix_command_help { command_list expected_initial_lines args } {
5465 set command [lindex $command_list 0]
5466 if {[llength $command_list]>1} {
5467 set full_command [lindex $command_list 1]
5469 set full_command $command
5471 # Use 'list' and not just {} because we want variables to
5472 # be expanded in this list.
5473 set l_stock_body [list\
5474 "List of $full_command subcommands\:.*\[\r\n\]+"\
5475 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5476 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5477 "Command name abbreviations are allowed if unambiguous\."]
5478 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5479 if {[llength $args]>0} {
5480 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5482 help_test_raw "help ${command}" $l_entire_body
5486 # Build executable named EXECUTABLE from specifications that allow
5487 # different options to be passed to different sub-compilations.
5488 # TESTNAME is the name of the test; this is passed to 'untested' if
5490 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5491 # contains the option "pthreads", then gdb_compile_pthreads is used.
5492 # ARGS is a flat list of source specifications, of the form:
5493 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5494 # Each SOURCE is compiled to an object file using its OPTIONS,
5495 # using gdb_compile.
5496 # Returns 0 on success, -1 on failure.
5497 proc build_executable_from_specs {testname executable options args} {
5501 set binfile [standard_output_file $executable]
5504 if { [lsearch -exact $options "c++"] >= 0 } {
5505 set info_options "c++"
5507 if [get_compiler_info ${info_options}] {
5511 set func gdb_compile
5512 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5513 if {$func_index != -1} {
5514 set func "${func}_[lindex $options $func_index]"
5517 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5518 # parameter. They also requires $sources while gdb_compile and
5519 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5520 if [string match gdb_compile_shlib* $func] {
5522 foreach {s local_options} $args {
5523 if { [regexp "^/" "$s"] } then {
5524 lappend sources_path "$s"
5526 lappend sources_path "$srcdir/$subdir/$s"
5529 set ret [$func $sources_path "${binfile}" $options]
5530 } elseif {[lsearch -exact $options rust] != -1} {
5532 foreach {s local_options} $args {
5533 if { [regexp "^/" "$s"] } then {
5534 lappend sources_path "$s"
5536 lappend sources_path "$srcdir/$subdir/$s"
5539 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5543 foreach {s local_options} $args {
5544 if { ! [regexp "^/" "$s"] } then {
5545 set s "$srcdir/$subdir/$s"
5547 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5551 lappend objects "${binfile}${i}.o"
5554 set ret [$func $objects "${binfile}" executable $options]
5564 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5565 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5566 # to pass to untested, if something is wrong. OPTIONS are passed
5567 # to gdb_compile directly.
5568 proc build_executable { testname executable {sources ""} {options {debug}} } {
5569 if {[llength $sources]==0} {
5570 set sources ${executable}.c
5573 set arglist [list $testname $executable $options]
5574 foreach source $sources {
5575 lappend arglist $source $options
5578 return [eval build_executable_from_specs $arglist]
5581 # Starts fresh GDB binary and loads an optional executable into GDB.
5582 # Usage: clean_restart [executable]
5583 # EXECUTABLE is the basename of the binary.
5585 proc clean_restart { args } {
5589 if { [llength $args] > 1 } {
5590 error "bad number of args: [llength $args]"
5595 gdb_reinitialize_dir $srcdir/$subdir
5597 if { [llength $args] >= 1 } {
5598 set executable [lindex $args 0]
5599 set binfile [standard_output_file ${executable}]
5604 # Prepares for testing by calling build_executable_full, then
5606 # TESTNAME is the name of the test.
5607 # Each element in ARGS is a list of the form
5608 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5609 # These are passed to build_executable_from_specs, which see.
5610 # The last EXECUTABLE is passed to clean_restart.
5611 # Returns 0 on success, non-zero on failure.
5612 proc prepare_for_testing_full {testname args} {
5613 foreach spec $args {
5614 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5617 set executable [lindex $spec 0]
5619 clean_restart $executable
5623 # Prepares for testing, by calling build_executable, and then clean_restart.
5624 # Please refer to build_executable for parameter description.
5625 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5627 if {[build_executable $testname $executable $sources $options] == -1} {
5630 clean_restart $executable
5635 # Retrieve the value of EXP in the inferior, represented in format
5636 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5637 # print fails. TEST is the test message to use. It can be omitted,
5638 # in which case a test message is built from EXP.
5640 proc get_valueof { fmt exp default {test ""} } {
5644 set test "get valueof \"${exp}\""
5648 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5649 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5650 set val $expect_out(1,string)
5654 fail "$test (timeout)"
5660 # Retrieve the value of EXP in the inferior, as a signed decimal value
5661 # (using "print /d"). DEFAULT is used as fallback if print fails.
5662 # TEST is the test message to use. It can be omitted, in which case
5663 # a test message is built from EXP.
5665 proc get_integer_valueof { exp default {test ""} } {
5669 set test "get integer valueof \"${exp}\""
5673 gdb_test_multiple "print /d ${exp}" "$test" {
5674 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5675 set val $expect_out(1,string)
5679 fail "$test (timeout)"
5685 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5686 # (using "print /x"). DEFAULT is used as fallback if print fails.
5687 # TEST is the test message to use. It can be omitted, in which case
5688 # a test message is built from EXP.
5690 proc get_hexadecimal_valueof { exp default {test ""} } {
5694 set test "get hexadecimal valueof \"${exp}\""
5698 gdb_test_multiple "print /x ${exp}" $test {
5699 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5700 set val $expect_out(1,string)
5707 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5708 # is used as fallback if print fails. TEST is the test message to use.
5709 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5711 proc get_sizeof { type default {test ""} } {
5712 return [get_integer_valueof "sizeof (${type})" $default $test]
5715 proc get_target_charset { } {
5718 gdb_test_multiple "show target-charset" "" {
5719 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5720 return $expect_out(1,string)
5722 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5723 return $expect_out(1,string)
5727 # Pick a reasonable default.
5728 warning "Unable to read target-charset."
5732 # Get the address of VAR.
5734 proc get_var_address { var } {
5735 global gdb_prompt hex
5737 # Match output like:
5739 # $5 = (int (*)()) 0
5740 # $6 = (int (*)()) 0x24 <function_bar>
5742 gdb_test_multiple "print &${var}" "get address of ${var}" {
5743 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5745 pass "get address of ${var}"
5746 if { $expect_out(1,string) == "0" } {
5749 return $expect_out(1,string)
5756 # Return the frame number for the currently selected frame
5757 proc get_current_frame_number {{test_name ""}} {
5760 if { $test_name == "" } {
5761 set test_name "get current frame number"
5764 gdb_test_multiple "frame" $test_name {
5765 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5766 set frame_num $expect_out(1,string)
5772 # Get the current value for remotetimeout and return it.
5773 proc get_remotetimeout { } {
5777 gdb_test_multiple "show remotetimeout" "" {
5778 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5779 return $expect_out(1,string)
5783 # Pick the default that gdb uses
5784 warning "Unable to read remotetimeout"
5788 # Set the remotetimeout to the specified timeout. Nothing is returned.
5789 proc set_remotetimeout { timeout } {
5792 gdb_test_multiple "set remotetimeout $timeout" "" {
5793 -re "$gdb_prompt $" {
5794 verbose "Set remotetimeout to $timeout\n"
5799 # Get the target's current endianness and return it.
5800 proc get_endianness { } {
5803 gdb_test_multiple "show endian" "determine endianness" {
5804 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5806 return $expect_out(1,string)
5812 # ROOT and FULL are file names. Returns the relative path from ROOT
5813 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5814 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5817 proc relative_filename {root full} {
5818 set root_split [file split $root]
5819 set full_split [file split $full]
5821 set len [llength $root_split]
5823 if {[eval file join $root_split]
5824 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5825 error "$full not a subdir of $root"
5828 return [eval file join [lrange $full_split $len end]]
5831 # Log gdb command line and script if requested.
5832 if {[info exists TRANSCRIPT]} {
5833 rename send_gdb real_send_gdb
5834 rename remote_spawn real_remote_spawn
5835 rename remote_close real_remote_close
5837 global gdb_transcript
5838 set gdb_transcript ""
5840 global gdb_trans_count
5841 set gdb_trans_count 1
5843 proc remote_spawn {args} {
5844 global gdb_transcript gdb_trans_count outdir
5846 if {$gdb_transcript != ""} {
5847 close $gdb_transcript
5849 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5850 puts $gdb_transcript [lindex $args 1]
5851 incr gdb_trans_count
5853 return [uplevel real_remote_spawn $args]
5856 proc remote_close {args} {
5857 global gdb_transcript
5859 if {$gdb_transcript != ""} {
5860 close $gdb_transcript
5861 set gdb_transcript ""
5864 return [uplevel real_remote_close $args]
5867 proc send_gdb {args} {
5868 global gdb_transcript
5870 if {$gdb_transcript != ""} {
5871 puts -nonewline $gdb_transcript [lindex $args 0]
5874 return [uplevel real_send_gdb $args]
5878 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5879 if {[info exists GDB_PARALLEL]} {
5880 if {[is_remote host]} {
5884 [make_gdb_parallel_path outputs] \
5885 [make_gdb_parallel_path temp] \
5886 [make_gdb_parallel_path cache]
5890 proc core_find {binfile {deletefiles {}} {arg ""}} {
5891 global objdir subdir
5893 set destcore "$binfile.core"
5894 file delete $destcore
5896 # Create a core file named "$destcore" rather than just "core", to
5897 # avoid problems with sys admin types that like to regularly prune all
5898 # files named "core" from the system.
5900 # Arbitrarily try setting the core size limit to "unlimited" since
5901 # this does not hurt on systems where the command does not work and
5902 # allows us to generate a core on systems where it does.
5904 # Some systems append "core" to the name of the program; others append
5905 # the name of the program to "core"; still others (like Linux, as of
5906 # May 2003) create cores named "core.PID". In the latter case, we
5907 # could have many core files lying around, and it may be difficult to
5908 # tell which one is ours, so let's run the program in a subdirectory.
5910 set coredir [standard_output_file coredir.[getpid]]
5912 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5913 # remote_exec host "${binfile}"
5914 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5915 if [remote_file build exists $i] {
5916 remote_exec build "mv $i $destcore"
5920 # Check for "core.PID".
5921 if { $found == 0 } {
5922 set names [glob -nocomplain -directory $coredir core.*]
5923 if {[llength $names] == 1} {
5924 set corefile [file join $coredir [lindex $names 0]]
5925 remote_exec build "mv $corefile $destcore"
5929 if { $found == 0 } {
5930 # The braindamaged HPUX shell quits after the ulimit -c above
5931 # without executing ${binfile}. So we try again without the
5932 # ulimit here if we didn't find a core file above.
5933 # Oh, I should mention that any "braindamaged" non-Unix system has
5934 # the same problem. I like the cd bit too, it's really neat'n stuff.
5935 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5936 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5937 if [remote_file build exists $i] {
5938 remote_exec build "mv $i $destcore"
5944 # Try to clean up after ourselves.
5945 foreach deletefile $deletefiles {
5946 remote_file build delete [file join $coredir $deletefile]
5948 remote_exec build "rmdir $coredir"
5950 if { $found == 0 } {
5951 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5957 # gdb_target_symbol_prefix compiles a test program and then examines
5958 # the output from objdump to determine the prefix (such as underscore)
5959 # for linker symbol prefixes.
5961 gdb_caching_proc gdb_target_symbol_prefix {
5962 # Compile a simple test program...
5963 set src { int main() { return 0; } }
5964 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
5970 set objdump_program [gdb_find_objdump]
5971 set result [catch "exec $objdump_program --syms $obj" output]
5974 && ![regexp -lineanchor \
5975 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5976 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5984 # Return 1 if target supports scheduler locking, otherwise return 0.
5986 gdb_caching_proc target_supports_scheduler_locking {
5989 set me "gdb_target_supports_scheduler_locking"
5991 set src { int main() { return 0; } }
5992 if {![gdb_simple_compile $me $src executable]} {
6001 set supports_schedule_locking -1
6002 set current_schedule_locking_mode ""
6004 set test "reading current scheduler-locking mode"
6005 gdb_test_multiple "show scheduler-locking" $test {
6006 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6007 set current_schedule_locking_mode $expect_out(1,string)
6009 -re "$gdb_prompt $" {
6010 set supports_schedule_locking 0
6013 set supports_schedule_locking 0
6017 if { $supports_schedule_locking == -1 } {
6018 set test "checking for scheduler-locking support"
6019 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6020 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6021 set supports_schedule_locking 0
6023 -re "$gdb_prompt $" {
6024 set supports_schedule_locking 1
6027 set supports_schedule_locking 0
6032 if { $supports_schedule_locking == -1 } {
6033 set supports_schedule_locking 0
6037 remote_file build delete $obj
6038 verbose "$me: returning $supports_schedule_locking" 2
6039 return $supports_schedule_locking
6042 # gdb_target_symbol returns the provided symbol with the correct prefix
6043 # prepended. (See gdb_target_symbol_prefix, above.)
6045 proc gdb_target_symbol { symbol } {
6046 set prefix [gdb_target_symbol_prefix]
6047 return "${prefix}${symbol}"
6050 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6051 # added to gdb_compile options to define the C-preprocessor macro
6052 # SYMBOL_PREFIX with a value that can be prepended to symbols
6053 # for targets which require a prefix, such as underscore.
6055 # This version (_asm) defines the prefix without double quotes
6056 # surrounding the prefix. It is used to define the macro
6057 # SYMBOL_PREFIX for assembly language files. Another version, below,
6058 # is used for symbols in inline assembler in C/C++ files.
6060 # The lack of quotes in this version (_asm) makes it possible to
6061 # define supporting macros in the .S file. (The version which
6062 # uses quotes for the prefix won't work for such files since it's
6063 # impossible to define a quote-stripping macro in C.)
6065 # It's possible to use this version (_asm) for C/C++ source files too,
6066 # but a string is usually required in such files; providing a version
6067 # (no _asm) which encloses the prefix with double quotes makes it
6068 # somewhat easier to define the supporting macros in the test case.
6070 proc gdb_target_symbol_prefix_flags_asm {} {
6071 set prefix [gdb_target_symbol_prefix]
6072 if {$prefix ne ""} {
6073 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6079 # gdb_target_symbol_prefix_flags returns the same string as
6080 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6081 # enclosed in double quotes if there is a prefix.
6083 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6084 # extended discussion.
6086 proc gdb_target_symbol_prefix_flags {} {
6087 set prefix [gdb_target_symbol_prefix]
6088 if {$prefix ne ""} {
6089 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6095 # A wrapper for 'remote_exec host' that passes or fails a test.
6096 # Returns 0 if all went well, nonzero on failure.
6097 # TEST is the name of the test, other arguments are as for remote_exec.
6099 proc run_on_host { test program args } {
6100 verbose -log "run_on_host: $program $args"
6101 # remote_exec doesn't work properly if the output is set but the
6102 # input is the empty string -- so replace an empty input with
6104 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6105 set args [lreplace $args 1 1 "/dev/null"]
6107 set result [eval remote_exec host [list $program] $args]
6108 verbose "result is $result"
6109 set status [lindex $result 0]
6110 set output [lindex $result 1]
6115 verbose -log "run_on_host failed: $output"
6121 # Return non-zero if "board_info debug_flags" mentions Fission.
6122 # http://gcc.gnu.org/wiki/DebugFission
6123 # Fission doesn't support everything yet.
6124 # This supports working around bug 15954.
6126 proc using_fission { } {
6127 set debug_flags [board_info [target_info name] debug_flags]
6128 return [regexp -- "-gsplit-dwarf" $debug_flags]
6131 # Search the caller's ARGS list and set variables according to the list of
6132 # valid options described by ARGSET.
6134 # The first member of each one- or two-element list in ARGSET defines the
6135 # name of a variable that will be added to the caller's scope.
6137 # If only one element is given to describe an option, it the value is
6138 # 0 if the option is not present in (the caller's) ARGS or 1 if
6141 # If two elements are given, the second element is the default value of
6142 # the variable. This is then overwritten if the option exists in ARGS.
6144 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6145 # any optional components.
6148 # proc myproc {foo args} {
6149 # parse_args {{bar} {baz "abc"} {qux}}
6152 # myproc ABC -bar -baz DEF peanut butter
6153 # will define the following variables in myproc:
6154 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6155 # args will be the list {peanut butter}
6157 proc parse_args { argset } {
6160 foreach argument $argset {
6161 if {[llength $argument] == 1} {
6162 # No default specified, so we assume that we should set
6163 # the value to 1 if the arg is present and 0 if it's not.
6164 # It is assumed that no value is given with the argument.
6165 set result [lsearch -exact $args "-$argument"]
6166 if {$result != -1} then {
6167 uplevel 1 [list set $argument 1]
6168 set args [lreplace $args $result $result]
6170 uplevel 1 [list set $argument 0]
6172 } elseif {[llength $argument] == 2} {
6173 # There are two items in the argument. The second is a
6174 # default value to use if the item is not present.
6175 # Otherwise, the variable is set to whatever is provided
6176 # after the item in the args.
6177 set arg [lindex $argument 0]
6178 set result [lsearch -exact $args "-[lindex $arg 0]"]
6179 if {$result != -1} then {
6180 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6181 set args [lreplace $args $result [expr $result+1]]
6183 uplevel 1 [list set $arg [lindex $argument 1]]
6186 error "Badly formatted argument \"$argument\" in argument set"
6190 # The remaining args should be checked to see that they match the
6191 # number of items expected to be passed into the procedure...
6194 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6195 # return that string.
6197 proc capture_command_output { command prefix } {
6201 set output_string ""
6202 gdb_test_multiple "$command" "capture_command_output for $command" {
6203 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6204 set output_string $expect_out(1,string)
6207 return $output_string
6210 # A convenience function that joins all the arguments together, with a
6211 # regexp that matches exactly one end of line in between each argument.
6212 # This function is ideal to write the expected output of a GDB command
6213 # that generates more than a couple of lines, as this allows us to write
6214 # each line as a separate string, which is easier to read by a human
6217 proc multi_line { args } {
6218 return [join $args "\r\n"]
6221 # Similar to the above, but while multi_line is meant to be used to
6222 # match GDB output, this one is meant to be used to build strings to
6223 # send as GDB input.
6225 proc multi_line_input { args } {
6226 return [join $args "\n"]
6229 # Return the version of the DejaGnu framework.
6231 # The return value is a list containing the major, minor and patch version
6232 # numbers. If the version does not contain a minor or patch number, they will
6233 # be set to 0. For example:
6239 proc dejagnu_version { } {
6240 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6241 global frame_version
6243 verbose -log "DejaGnu version: $frame_version"
6244 verbose -log "Expect version: [exp_version]"
6245 verbose -log "Tcl version: [info tclversion]"
6247 set dg_ver [split $frame_version .]
6249 while { [llength $dg_ver] < 3 } {
6256 # Define user-defined command COMMAND using the COMMAND_LIST as the
6257 # command's definition. The terminating "end" is added automatically.
6259 proc gdb_define_cmd {command command_list} {
6262 set input [multi_line_input {*}$command_list "end"]
6263 set test "define $command"
6265 gdb_test_multiple "define $command" $test {
6267 gdb_test_multiple $input $test {
6268 -re "\r\n$gdb_prompt " {
6275 # Override the 'cd' builtin with a version that ensures that the
6276 # log file keeps pointing at the same file. We need this because
6277 # unfortunately the path to the log file is recorded using an
6278 # relative path name, and, we sometimes need to close/reopen the log
6279 # after changing the current directory. See get_compiler_info.
6281 rename cd builtin_cd
6285 # Get the existing log file flags.
6286 set log_file_info [log_file -info]
6288 # Split the flags into args and file name.
6289 set log_file_flags ""
6290 set log_file_file ""
6291 foreach arg [ split "$log_file_info" " "] {
6292 if [string match "-*" $arg] {
6293 lappend log_file_flags $arg
6295 lappend log_file_file $arg
6299 # If there was an existing file, ensure it is an absolute path, and then
6301 if { $log_file_file != "" } {
6302 set log_file_file [file normalize $log_file_file]
6304 log_file $log_file_flags "$log_file_file"
6307 # Call the builtin version of cd.
6311 # Always load compatibility stuff.