1 # Copyright 1992-2018 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)"
983 # Patterns below apply to any spawn id specified.
986 perror "Process no longer exists"
987 if { $message != "" } {
993 perror "internal buffer is full."
998 if ![string match "" $message] then {
999 fail "$message (timeout)"
1006 set code [catch {gdb_expect $code} string]
1008 global errorInfo errorCode
1009 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1010 } elseif {$code > 1} {
1011 return -code $code $string
1016 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1017 # Send a command to gdb; test the result.
1019 # COMMAND is the command to execute, send to GDB with send_gdb. If
1020 # this is the null string no command is sent.
1021 # PATTERN is the pattern to match for a PASS, and must NOT include
1022 # the \r\n sequence immediately before the gdb prompt. This argument
1023 # may be omitted to just match the prompt, ignoring whatever output
1025 # MESSAGE is an optional message to be printed. If this is
1026 # omitted, then the pass/fail messages use the command string as the
1027 # message. (If this is the empty string, then sometimes we don't
1028 # call pass or fail at all; I don't understand this at all.)
1029 # QUESTION is a question GDB may ask in response to COMMAND, like
1031 # RESPONSE is the response to send if QUESTION appears.
1034 # 1 if the test failed,
1035 # 0 if the test passes,
1036 # -1 if there was an internal error.
1038 proc gdb_test { args } {
1040 upvar timeout timeout
1042 if [llength $args]>2 then {
1043 set message [lindex $args 2]
1045 set message [lindex $args 0]
1047 set command [lindex $args 0]
1048 set pattern [lindex $args 1]
1050 if [llength $args]==5 {
1051 set question_string [lindex $args 3]
1052 set response_string [lindex $args 4]
1054 set question_string "^FOOBAR$"
1057 return [gdb_test_multiple $command $message {
1058 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1059 if ![string match "" $message] then {
1063 -re "(${question_string})$" {
1064 send_gdb "$response_string\n"
1070 # gdb_test_no_output COMMAND MESSAGE
1071 # Send a command to GDB and verify that this command generated no output.
1073 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1074 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1075 # the message. (If MESSAGE is the empty string, then sometimes we do not
1076 # call pass or fail at all; I don't understand this at all.)
1078 proc gdb_test_no_output { args } {
1080 set command [lindex $args 0]
1081 if [llength $args]>1 then {
1082 set message [lindex $args 1]
1084 set message $command
1087 set command_regex [string_to_regexp $command]
1088 gdb_test_multiple $command $message {
1089 -re "^$command_regex\r\n$gdb_prompt $" {
1090 if ![string match "" $message] then {
1097 # Send a command and then wait for a sequence of outputs.
1098 # This is useful when the sequence is long and contains ".*", a single
1099 # regexp to match the entire output can get a timeout much easier.
1101 # COMMAND is the command to execute, send to GDB with send_gdb. If
1102 # this is the null string no command is sent.
1103 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1104 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1105 # processed in order, and all must be present in the output.
1107 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1108 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1109 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1111 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1112 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1115 # 1 if the test failed,
1116 # 0 if the test passes,
1117 # -1 if there was an internal error.
1119 proc gdb_test_sequence { command test_name expected_output_list } {
1121 if { $test_name == "" } {
1122 set test_name $command
1124 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1125 if { $command != "" } {
1126 send_gdb "$command\n"
1128 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1132 # Test that a command gives an error. For pass or fail, return
1133 # a 1 to indicate that more tests can proceed. However a timeout
1134 # is a serious error, generates a special fail message, and causes
1135 # a 0 to be returned to indicate that more tests are likely to fail
1138 proc test_print_reject { args } {
1142 if [llength $args]==2 then {
1143 set expectthis [lindex $args 1]
1145 set expectthis "should never match this bogus string"
1147 set sendthis [lindex $args 0]
1148 if $verbose>2 then {
1149 send_user "Sending \"$sendthis\" to gdb\n"
1150 send_user "Looking to match \"$expectthis\"\n"
1152 send_gdb "$sendthis\n"
1153 #FIXME: Should add timeout as parameter.
1155 -re "A .* in expression.*\\.*$gdb_prompt $" {
1156 pass "reject $sendthis"
1159 -re "Invalid syntax in expression.*$gdb_prompt $" {
1160 pass "reject $sendthis"
1163 -re "Junk after end of expression.*$gdb_prompt $" {
1164 pass "reject $sendthis"
1167 -re "Invalid number.*$gdb_prompt $" {
1168 pass "reject $sendthis"
1171 -re "Invalid character constant.*$gdb_prompt $" {
1172 pass "reject $sendthis"
1175 -re "No symbol table is loaded.*$gdb_prompt $" {
1176 pass "reject $sendthis"
1179 -re "No symbol .* in current context.*$gdb_prompt $" {
1180 pass "reject $sendthis"
1183 -re "Unmatched single quote.*$gdb_prompt $" {
1184 pass "reject $sendthis"
1187 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1188 pass "reject $sendthis"
1191 -re "$expectthis.*$gdb_prompt $" {
1192 pass "reject $sendthis"
1195 -re ".*$gdb_prompt $" {
1196 fail "reject $sendthis"
1200 fail "reject $sendthis (eof or timeout)"
1207 # Same as gdb_test, but the second parameter is not a regexp,
1208 # but a string that must match exactly.
1210 proc gdb_test_exact { args } {
1211 upvar timeout timeout
1213 set command [lindex $args 0]
1215 # This applies a special meaning to a null string pattern. Without
1216 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1217 # messages from commands that should have no output except a new
1218 # prompt. With this, only results of a null string will match a null
1221 set pattern [lindex $args 1]
1222 if [string match $pattern ""] {
1223 set pattern [string_to_regexp [lindex $args 0]]
1225 set pattern [string_to_regexp [lindex $args 1]]
1228 # It is most natural to write the pattern argument with only
1229 # embedded \n's, especially if you are trying to avoid Tcl quoting
1230 # problems. But gdb_expect really wants to see \r\n in patterns. So
1231 # transform the pattern here. First transform \r\n back to \n, in
1232 # case some users of gdb_test_exact already do the right thing.
1233 regsub -all "\r\n" $pattern "\n" pattern
1234 regsub -all "\n" $pattern "\r\n" pattern
1235 if [llength $args]==3 then {
1236 set message [lindex $args 2]
1238 set message $command
1241 return [gdb_test $command $pattern $message]
1244 # Wrapper around gdb_test_multiple that looks for a list of expected
1245 # output elements, but which can appear in any order.
1246 # CMD is the gdb command.
1247 # NAME is the name of the test.
1248 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1250 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1251 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1252 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1254 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1255 # of text per element and then strip trailing \r\n's.
1257 # gdb_test_list_exact "foo" "bar" \
1258 # "\[^\r\n\]+\[\r\n\]+" \
1261 # {expected result 1} \
1262 # {expected result 2} \
1265 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1268 set matches [lsort $result_match_list]
1270 gdb_test_multiple $cmd $name {
1271 "$cmd\[\r\n\]" { exp_continue }
1272 -re $elm_find_regexp {
1273 set str $expect_out(0,string)
1274 verbose -log "seen: $str" 3
1275 regexp -- $elm_extract_regexp $str elm_seen
1276 verbose -log "extracted: $elm_seen" 3
1277 lappend seen $elm_seen
1280 -re "$gdb_prompt $" {
1282 foreach got [lsort $seen] have $matches {
1283 if {![string equal $got $have]} {
1288 if {[string length $failed] != 0} {
1289 fail "$name ($failed not found)"
1297 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1298 # Send a command to gdb; expect inferior and gdb output.
1300 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1303 # INFERIOR_PATTERN is the pattern to match against inferior output.
1305 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1306 # include the \r\n sequence immediately before the gdb prompt, nor the
1307 # prompt. The default is empty.
1309 # Both inferior and gdb patterns must match for a PASS.
1311 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1314 # 1 if the test failed,
1315 # 0 if the test passes,
1316 # -1 if there was an internal error.
1319 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1320 global inferior_spawn_id gdb_spawn_id
1323 if {$message == ""} {
1324 set message $command
1327 set inferior_matched 0
1330 # Use an indirect spawn id list, and remove the inferior spawn id
1331 # from the expected output as soon as it matches, in case
1332 # $inferior_pattern happens to be a prefix of the resulting full
1333 # gdb pattern below (e.g., "\r\n").
1334 global gdb_test_stdio_spawn_id_list
1335 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1337 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1338 # then we may see gdb's output arriving before the inferior's
1340 set res [gdb_test_multiple $command $message {
1341 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1342 set inferior_matched 1
1343 if {!$gdb_matched} {
1344 set gdb_test_stdio_spawn_id_list ""
1348 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1350 if {!$inferior_matched} {
1358 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1365 # Issue a PASS and return true if evaluating CONDITION in the caller's
1366 # frame returns true, and issue a FAIL and return false otherwise.
1367 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1368 # omitted or is empty, then the pass/fail messages use the condition
1369 # string as the message.
1371 proc gdb_assert { condition {message ""} } {
1372 if { $message == ""} {
1373 set message $condition
1376 set res [uplevel 1 expr $condition]
1385 proc gdb_reinitialize_dir { subdir } {
1388 if [is_remote host] {
1393 -re "Reinitialize source path to empty.*y or n. " {
1396 -re "Source directories searched.*$gdb_prompt $" {
1397 send_gdb "dir $subdir\n"
1399 -re "Source directories searched.*$gdb_prompt $" {
1400 verbose "Dir set to $subdir"
1402 -re "$gdb_prompt $" {
1403 perror "Dir \"$subdir\" failed."
1407 -re "$gdb_prompt $" {
1408 perror "Dir \"$subdir\" failed."
1412 -re "$gdb_prompt $" {
1413 perror "Dir \"$subdir\" failed."
1419 # gdb_exit -- exit the GDB, killing the target program if necessary
1421 proc default_gdb_exit {} {
1423 global INTERNAL_GDBFLAGS GDBFLAGS
1425 global gdb_spawn_id inferior_spawn_id
1426 global inotify_log_file
1428 gdb_stop_suppressing_tests
1430 if ![info exists gdb_spawn_id] {
1434 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1436 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1437 set fd [open $inotify_log_file]
1438 set data [read -nonewline $fd]
1441 if {[string compare $data ""] != 0} {
1442 warning "parallel-unsafe file creations noticed"
1445 set fd [open $inotify_log_file w]
1450 if { [is_remote host] && [board_info host exists fileid] } {
1457 -re "DOSEXIT code" { }
1462 if ![is_remote host] {
1466 unset inferior_spawn_id
1469 # Load a file into the debugger.
1470 # The return value is 0 for success, -1 for failure.
1472 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1473 # to one of these values:
1475 # debug file was loaded successfully and has debug information
1476 # nodebug file was loaded successfully and has no debug information
1477 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1479 # fail file was not loaded
1481 # I tried returning this information as part of the return value,
1482 # but ran into a mess because of the many re-implementations of
1483 # gdb_load in config/*.exp.
1485 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1486 # this if they can get more information set.
1488 proc gdb_file_cmd { arg } {
1492 global last_loaded_file
1494 # Save this for the benefit of gdbserver-support.exp.
1495 set last_loaded_file $arg
1497 # Set whether debug info was found.
1498 # Default to "fail".
1499 global gdb_file_cmd_debug_info
1500 set gdb_file_cmd_debug_info "fail"
1502 if [is_remote host] {
1503 set arg [remote_download host $arg]
1505 perror "download failed"
1510 # The file command used to kill the remote target. For the benefit
1511 # of the testsuite, preserve this behavior.
1514 -re "Kill the program being debugged. .y or n. $" {
1516 verbose "\t\tKilling previous program being debugged"
1519 -re "$gdb_prompt $" {
1524 send_gdb "file $arg\n"
1526 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1527 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1528 set gdb_file_cmd_debug_info "lzma"
1531 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1532 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1533 set gdb_file_cmd_debug_info "nodebug"
1536 -re "Reading symbols from.*$gdb_prompt $" {
1537 verbose "\t\tLoaded $arg into $GDB"
1538 set gdb_file_cmd_debug_info "debug"
1541 -re "Load new symbol table from \".*\".*y or n. $" {
1544 -re "Reading symbols from.*$gdb_prompt $" {
1545 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1546 set gdb_file_cmd_debug_info "debug"
1550 perror "Couldn't load $arg, other program already loaded (timeout)."
1554 perror "Couldn't load $arg, other program already loaded (eof)."
1559 -re "No such file or directory.*$gdb_prompt $" {
1560 perror "($arg) No such file or directory"
1563 -re "A problem internal to GDB has been detected" {
1564 fail "($arg) (GDB internal error)"
1565 gdb_internal_error_resync
1568 -re "$gdb_prompt $" {
1569 perror "Couldn't load $arg into $GDB."
1573 perror "Couldn't load $arg into $GDB (timeout)."
1577 # This is an attempt to detect a core dump, but seems not to
1578 # work. Perhaps we need to match .* followed by eof, in which
1579 # gdb_expect does not seem to have a way to do that.
1580 perror "Couldn't load $arg into $GDB (eof)."
1586 # Default gdb_spawn procedure.
1588 proc default_gdb_spawn { } {
1591 global INTERNAL_GDBFLAGS GDBFLAGS
1594 gdb_stop_suppressing_tests
1596 # Set the default value, it may be overriden later by specific testfile.
1598 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1599 # is already started after connecting and run/attach are not supported.
1600 # This is used for the "remote" protocol. After GDB starts you should
1601 # check global $use_gdb_stub instead of the board as the testfile may force
1602 # a specific different target protocol itself.
1603 set use_gdb_stub [target_info exists use_gdb_stub]
1605 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1607 if [info exists gdb_spawn_id] {
1611 if ![is_remote host] {
1612 if { [which $GDB] == 0 } then {
1613 perror "$GDB does not exist."
1617 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1618 if { $res < 0 || $res == "" } {
1619 perror "Spawning $GDB failed."
1623 set gdb_spawn_id $res
1627 # Default gdb_start procedure.
1629 proc default_gdb_start { } {
1630 global gdb_prompt pagination_prompt
1632 global inferior_spawn_id
1634 if [info exists gdb_spawn_id] {
1643 # Default to assuming inferior I/O is done on GDB's terminal.
1644 if {![info exists inferior_spawn_id]} {
1645 set inferior_spawn_id $gdb_spawn_id
1648 # When running over NFS, particularly if running many simultaneous
1649 # tests on different hosts all using the same server, things can
1650 # get really slow. Give gdb at least 3 minutes to start up.
1652 while { $loop_again } {
1655 -re "$pagination_prompt" {
1656 verbose "Hit pagination during startup. Pressing enter to continue."
1660 -re "\[\r\n\]$gdb_prompt $" {
1661 verbose "GDB initialized."
1663 -re "$gdb_prompt $" {
1664 perror "GDB never initialized."
1669 perror "(timeout) GDB never initialized after 10 seconds."
1677 # force the height to "unlimited", so no pagers get used
1679 send_gdb "set height 0\n"
1681 -re "$gdb_prompt $" {
1682 verbose "Setting height to 0." 2
1685 warning "Couldn't set the height to 0"
1688 # force the width to "unlimited", so no wraparound occurs
1689 send_gdb "set width 0\n"
1691 -re "$gdb_prompt $" {
1692 verbose "Setting width to 0." 2
1695 warning "Couldn't set the width to 0."
1701 # Utility procedure to give user control of the gdb prompt in a script. It is
1702 # meant to be used for debugging test cases, and should not be left in the
1705 proc gdb_interact { } {
1707 set spawn_id $gdb_spawn_id
1709 send_user "+------------------------------------------+\n"
1710 send_user "| Script interrupted, you can now interact |\n"
1711 send_user "| with by gdb. Type >>> to continue. |\n"
1712 send_user "+------------------------------------------+\n"
1719 # Examine the output of compilation to determine whether compilation
1720 # failed or not. If it failed determine whether it is due to missing
1721 # compiler or due to compiler error. Report pass, fail or unsupported
1724 proc gdb_compile_test {src output} {
1725 if { $output == "" } {
1726 pass "compilation [file tail $src]"
1727 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1728 unsupported "compilation [file tail $src]"
1729 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1730 unsupported "compilation [file tail $src]"
1731 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1732 unsupported "compilation [file tail $src]"
1734 verbose -log "compilation failed: $output" 2
1735 fail "compilation [file tail $src]"
1739 # Return a 1 for configurations for which we don't even want to try to
1742 proc skip_cplus_tests {} {
1743 if { [istarget "h8300-*-*"] } {
1747 # The C++ IO streams are too large for HC11/HC12 and are thus not
1748 # available. The gdb C++ tests use them and don't compile.
1749 if { [istarget "m6811-*-*"] } {
1752 if { [istarget "m6812-*-*"] } {
1758 # Return a 1 for configurations for which don't have both C++ and the STL.
1760 proc skip_stl_tests {} {
1761 # Symbian supports the C++ language, but the STL is missing
1762 # (both headers and libraries).
1763 if { [istarget "arm*-*-symbianelf*"] } {
1767 return [skip_cplus_tests]
1770 # Return a 1 if I don't even want to try to test FORTRAN.
1772 proc skip_fortran_tests {} {
1776 # Return a 1 if I don't even want to try to test ada.
1778 proc skip_ada_tests {} {
1782 # Return a 1 if I don't even want to try to test GO.
1784 proc skip_go_tests {} {
1788 # Return a 1 if I don't even want to try to test D.
1790 proc skip_d_tests {} {
1794 # Return 1 to skip Rust tests, 0 to try them.
1795 proc skip_rust_tests {} {
1796 return [expr {![isnative]}]
1799 # Return a 1 for configurations that do not support Python scripting.
1800 # PROMPT_REGEXP is the expected prompt.
1802 proc skip_python_tests_prompt { prompt_regexp } {
1803 global gdb_py_is_py3k
1804 global gdb_py_is_py24
1806 gdb_test_multiple "python print ('test')" "verify python support" {
1807 -re "not supported.*$prompt_regexp" {
1808 unsupported "Python support is disabled."
1811 -re "$prompt_regexp" {}
1814 set gdb_py_is_py24 0
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
1823 if { $gdb_py_is_py3k == 0 } {
1824 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1825 -re "\[45\].*$prompt_regexp" {
1826 set gdb_py_is_py24 1
1828 -re ".*$prompt_regexp" {
1829 set gdb_py_is_py24 0
1837 # Return a 1 for configurations that do not support Python scripting.
1838 # Note: This also sets various globals that specify which version of Python
1839 # is in use. See skip_python_tests_prompt.
1841 proc skip_python_tests {} {
1843 return [skip_python_tests_prompt "$gdb_prompt $"]
1846 # Return a 1 if we should skip shared library tests.
1848 proc skip_shlib_tests {} {
1849 # Run the shared library tests on native systems.
1854 # An abbreviated list of remote targets where we should be able to
1855 # run shared library tests.
1856 if {([istarget *-*-linux*]
1857 || [istarget *-*-*bsd*]
1858 || [istarget *-*-solaris2*]
1859 || [istarget arm*-*-symbianelf*]
1860 || [istarget *-*-mingw*]
1861 || [istarget *-*-cygwin*]
1862 || [istarget *-*-pe*])} {
1869 # Return 1 if we should skip tui related tests.
1871 proc skip_tui_tests {} {
1874 gdb_test_multiple "help layout" "verify tui support" {
1875 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1878 -re "$gdb_prompt $" {
1885 # Test files shall make sure all the test result lines in gdb.sum are
1886 # unique in a test run, so that comparing the gdb.sum files of two
1887 # test runs gives correct results. Test files that exercise
1888 # variations of the same tests more than once, shall prefix the
1889 # different test invocations with different identifying strings in
1890 # order to make them unique.
1892 # About test prefixes:
1894 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1895 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1896 # underlined substring in
1898 # PASS: gdb.base/mytest.exp: some test
1899 # ^^^^^^^^^^^^^^^^^^^^
1903 # The easiest way to adjust the test prefix is to append a test
1904 # variation prefix to the $pf_prefix, using the with_test_prefix
1907 # proc do_tests {} {
1908 # gdb_test ... ... "test foo"
1909 # gdb_test ... ... "test bar"
1911 # with_test_prefix "subvariation a" {
1912 # gdb_test ... ... "test x"
1915 # with_test_prefix "subvariation b" {
1916 # gdb_test ... ... "test x"
1920 # with_test_prefix "variation1" {
1921 # ...do setup for variation 1...
1925 # with_test_prefix "variation2" {
1926 # ...do setup for variation 2...
1932 # PASS: gdb.base/mytest.exp: variation1: test foo
1933 # PASS: gdb.base/mytest.exp: variation1: test bar
1934 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1935 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1936 # PASS: gdb.base/mytest.exp: variation2: test foo
1937 # PASS: gdb.base/mytest.exp: variation2: test bar
1938 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1939 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1941 # If for some reason more flexibility is necessary, one can also
1942 # manipulate the pf_prefix global directly, treating it as a string.
1946 # set saved_pf_prefix
1947 # append pf_prefix "${foo}: bar"
1948 # ... actual tests ...
1949 # set pf_prefix $saved_pf_prefix
1952 # Run BODY in the context of the caller, with the current test prefix
1953 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1954 # Returns the result of BODY.
1956 proc with_test_prefix { prefix body } {
1959 set saved $pf_prefix
1960 append pf_prefix " " $prefix ":"
1961 set code [catch {uplevel 1 $body} result]
1962 set pf_prefix $saved
1965 global errorInfo errorCode
1966 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1968 return -code $code $result
1972 # Wrapper for foreach that calls with_test_prefix on each iteration,
1973 # including the iterator's name and current value in the prefix.
1975 proc foreach_with_prefix {var list body} {
1977 foreach myvar $list {
1978 with_test_prefix "$var=$myvar" {
1984 # Like TCL's native proc, but defines a procedure that wraps its body
1985 # within 'with_test_prefix "$proc_name" { ... }'.
1986 proc proc_with_prefix {name arguments body} {
1987 # Define the advertised proc.
1988 proc $name $arguments [list with_test_prefix $name $body]
1992 # Run BODY in the context of the caller. After BODY is run, the variables
1993 # listed in VARS will be reset to the values they had before BODY was run.
1995 # This is useful for providing a scope in which it is safe to temporarily
1996 # modify global variables, e.g.
1998 # global INTERNAL_GDBFLAGS
2001 # set foo GDBHISTSIZE
2003 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2004 # append INTERNAL_GDBFLAGS " -nx"
2005 # unset -nocomplain env(GDBHISTSIZE)
2010 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2011 # modified inside BODY, this proc guarantees that the modifications will be
2012 # undone after BODY finishes executing.
2014 proc save_vars { vars body } {
2015 array set saved_scalars { }
2016 array set saved_arrays { }
2020 # First evaluate VAR in the context of the caller in case the variable
2021 # name may be a not-yet-interpolated string like env($foo)
2022 set var [uplevel 1 list $var]
2024 if [uplevel 1 [list info exists $var]] {
2025 if [uplevel 1 [list array exists $var]] {
2026 set saved_arrays($var) [uplevel 1 [list array get $var]]
2028 set saved_scalars($var) [uplevel 1 [list set $var]]
2031 lappend unset_vars $var
2035 set code [catch {uplevel 1 $body} result]
2037 foreach {var value} [array get saved_scalars] {
2038 uplevel 1 [list set $var $value]
2041 foreach {var value} [array get saved_arrays] {
2042 uplevel 1 [list unset $var]
2043 uplevel 1 [list array set $var $value]
2046 foreach var $unset_vars {
2047 uplevel 1 [list unset -nocomplain $var]
2051 global errorInfo errorCode
2052 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2054 return -code $code $result
2058 # Run tests in BODY with the current working directory (CWD) set to
2059 # DIR. When BODY is finished, restore the original CWD. Return the
2062 # This procedure doesn't check if DIR is a valid directory, so you
2063 # have to make sure of that.
2065 proc with_cwd { dir body } {
2067 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2070 set code [catch {uplevel 1 $body} result]
2072 verbose -log "Switching back to $saved_dir."
2076 global errorInfo errorCode
2077 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2079 return -code $code $result
2083 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2084 # PROMPT. When BODY is finished, restore GDB prompt and variable
2086 # Returns the result of BODY.
2090 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2091 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2092 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2093 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2094 # a) It's more intuitive for callers to pass the plain text form.
2095 # b) We need two forms of the prompt:
2096 # - a regexp to use in output matching,
2097 # - a value to pass to the "set prompt" command.
2098 # c) It's easier to convert the plain text form to its regexp form.
2100 # 2) Don't add a trailing space, we do that here.
2102 proc with_gdb_prompt { prompt body } {
2105 # Convert "(foo)" to "\(foo\)".
2106 # We don't use string_to_regexp because while it works today it's not
2107 # clear it will work tomorrow: the value we need must work as both a
2108 # regexp *and* as the argument to the "set prompt" command, at least until
2109 # we start recording both forms separately instead of just $gdb_prompt.
2110 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2112 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2114 set saved $gdb_prompt
2116 verbose -log "Setting gdb prompt to \"$prompt \"."
2117 set gdb_prompt $prompt
2118 gdb_test_no_output "set prompt $prompt " ""
2120 set code [catch {uplevel 1 $body} result]
2122 verbose -log "Restoring gdb prompt to \"$saved \"."
2123 set gdb_prompt $saved
2124 gdb_test_no_output "set prompt $saved " ""
2127 global errorInfo errorCode
2128 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2130 return -code $code $result
2134 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2135 # BODY is finished, restore target-charset.
2137 proc with_target_charset { target_charset body } {
2141 gdb_test_multiple "show target-charset" "" {
2142 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2143 set saved $expect_out(1,string)
2145 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2146 set saved $expect_out(1,string)
2148 -re ".*$gdb_prompt " {
2149 fail "get target-charset"
2153 gdb_test_no_output "set target-charset $target_charset" ""
2155 set code [catch {uplevel 1 $body} result]
2157 gdb_test_no_output "set target-charset $saved" ""
2160 global errorInfo errorCode
2161 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2163 return -code $code $result
2167 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2168 # mi_gdb_test etc. default to using it.
2170 proc switch_gdb_spawn_id {spawn_id} {
2172 global board board_info
2174 set gdb_spawn_id $spawn_id
2175 set board [host_info name]
2176 set board_info($board,fileid) $spawn_id
2179 # Clear the default spawn id.
2181 proc clear_gdb_spawn_id {} {
2183 global board board_info
2185 unset -nocomplain gdb_spawn_id
2186 set board [host_info name]
2187 unset -nocomplain board_info($board,fileid)
2190 # Run BODY with SPAWN_ID as current spawn id.
2192 proc with_spawn_id { spawn_id body } {
2195 if [info exists gdb_spawn_id] {
2196 set saved_spawn_id $gdb_spawn_id
2199 switch_gdb_spawn_id $spawn_id
2201 set code [catch {uplevel 1 $body} result]
2203 if [info exists saved_spawn_id] {
2204 switch_gdb_spawn_id $saved_spawn_id
2210 global errorInfo errorCode
2211 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2213 return -code $code $result
2217 # Select the largest timeout from all the timeouts:
2218 # - the local "timeout" variable of the scope two levels above,
2219 # - the global "timeout" variable,
2220 # - the board variable "gdb,timeout".
2222 proc get_largest_timeout {} {
2223 upvar #0 timeout gtimeout
2224 upvar 2 timeout timeout
2227 if [info exists timeout] {
2230 if { [info exists gtimeout] && $gtimeout > $tmt } {
2233 if { [target_info exists gdb,timeout]
2234 && [target_info gdb,timeout] > $tmt } {
2235 set tmt [target_info gdb,timeout]
2245 # Run tests in BODY with timeout increased by factor of FACTOR. When
2246 # BODY is finished, restore timeout.
2248 proc with_timeout_factor { factor body } {
2251 set savedtimeout $timeout
2253 set timeout [expr [get_largest_timeout] * $factor]
2254 set code [catch {uplevel 1 $body} result]
2256 set timeout $savedtimeout
2258 global errorInfo errorCode
2259 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2261 return -code $code $result
2265 # Return 1 if _Complex types are supported, otherwise, return 0.
2267 gdb_caching_proc support_complex_tests {
2269 if { [gdb_skip_float_test] } {
2270 # If floating point is not supported, _Complex is not
2275 # Compile a test program containing _Complex types.
2277 return [gdb_can_simple_compile complex {
2281 _Complex long double cld;
2287 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2290 proc supports_get_siginfo_type {} {
2291 if { [istarget "*-*-linux*"] } {
2298 # Return 1 if the target supports hardware single stepping.
2300 proc can_hardware_single_step {} {
2302 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2303 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2304 || [istarget "nios2-*-*"] } {
2311 # Return 1 if target hardware or OS supports single stepping to signal
2312 # handler, otherwise, return 0.
2314 proc can_single_step_to_signal_handler {} {
2315 # Targets don't have hardware single step. On these targets, when
2316 # a signal is delivered during software single step, gdb is unable
2317 # to determine the next instruction addresses, because start of signal
2318 # handler is one of them.
2319 return [can_hardware_single_step]
2322 # Return 1 if target supports process record, otherwise return 0.
2324 proc supports_process_record {} {
2326 if [target_info exists gdb,use_precord] {
2327 return [target_info gdb,use_precord]
2330 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2331 || [istarget "i\[34567\]86-*-linux*"]
2332 || [istarget "aarch64*-*-linux*"]
2333 || [istarget "powerpc*-*-linux*"]
2334 || [istarget "s390*-*-linux*"] } {
2341 # Return 1 if target supports reverse debugging, otherwise return 0.
2343 proc supports_reverse {} {
2345 if [target_info exists gdb,can_reverse] {
2346 return [target_info gdb,can_reverse]
2349 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2350 || [istarget "i\[34567\]86-*-linux*"]
2351 || [istarget "aarch64*-*-linux*"]
2352 || [istarget "powerpc*-*-linux*"]
2353 || [istarget "s390*-*-linux*"] } {
2360 # Return 1 if readline library is used.
2362 proc readline_is_used { } {
2365 gdb_test_multiple "show editing" "" {
2366 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2369 -re ".*$gdb_prompt $" {
2375 # Return 1 if target is ELF.
2376 gdb_caching_proc is_elf_target {
2377 set me "is_elf_target"
2379 set src { int foo () {return 0;} }
2380 if {![gdb_simple_compile elf_target $src]} {
2384 set fp_obj [open $obj "r"]
2385 fconfigure $fp_obj -translation binary
2386 set data [read $fp_obj]
2391 set ELFMAG "\u007FELF"
2393 if {[string compare -length 4 $data $ELFMAG] != 0} {
2394 verbose "$me: returning 0" 2
2398 verbose "$me: returning 1" 2
2402 # Return 1 if the memory at address zero is readable.
2404 gdb_caching_proc is_address_zero_readable {
2408 gdb_test_multiple "x 0" "" {
2409 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2412 -re ".*$gdb_prompt $" {
2420 # Produce source file NAME and write SOURCES into it.
2422 proc gdb_produce_source { name sources } {
2424 set f [open $name "w"]
2430 # Return 1 if target is ILP32.
2431 # This cannot be decided simply from looking at the target string,
2432 # as it might depend on externally passed compiler options like -m64.
2433 gdb_caching_proc is_ilp32_target {
2434 return [gdb_can_simple_compile is_ilp32_target {
2435 int dummy[sizeof (int) == 4
2436 && sizeof (void *) == 4
2437 && sizeof (long) == 4 ? 1 : -1];
2441 # Return 1 if target is LP64.
2442 # This cannot be decided simply from looking at the target string,
2443 # as it might depend on externally passed compiler options like -m64.
2444 gdb_caching_proc is_lp64_target {
2445 return [gdb_can_simple_compile is_lp64_target {
2446 int dummy[sizeof (int) == 4
2447 && sizeof (void *) == 8
2448 && sizeof (long) == 8 ? 1 : -1];
2452 # Return 1 if target has 64 bit addresses.
2453 # This cannot be decided simply from looking at the target string,
2454 # as it might depend on externally passed compiler options like -m64.
2455 gdb_caching_proc is_64_target {
2456 return [gdb_can_simple_compile is_64_target {
2457 int function(void) { return 3; }
2458 int dummy[sizeof (&function) == 8 ? 1 : -1];
2462 # Return 1 if target has x86_64 registers - either amd64 or x32.
2463 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2464 # just from the target string.
2465 gdb_caching_proc is_amd64_regs_target {
2466 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2470 return [gdb_can_simple_compile is_amd64_regs_target {
2480 # Return 1 if this target is an x86 or x86-64 with -m32.
2481 proc is_x86_like_target {} {
2482 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2485 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2488 # Return 1 if this target is an arm or aarch32 on aarch64.
2490 gdb_caching_proc is_aarch32_target {
2491 if { [istarget "arm*-*-*"] } {
2495 if { ![istarget "aarch64*-*-*"] } {
2502 lappend list "\tmov $reg, $reg"
2505 return [gdb_can_simple_compile aarch32 [join $list \n]]
2508 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2510 proc is_aarch64_target {} {
2511 if { ![istarget "aarch64*-*-*"] } {
2515 return [expr ![is_aarch32_target]]
2518 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2519 proc support_displaced_stepping {} {
2521 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2522 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2523 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2524 || [istarget "aarch64*-*-linux*"] } {
2531 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2532 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2534 gdb_caching_proc skip_altivec_tests {
2535 global srcdir subdir gdb_prompt inferior_exited_re
2537 set me "skip_altivec_tests"
2539 # Some simulators are known to not support VMX instructions.
2540 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2541 verbose "$me: target known to not support VMX, returning 1" 2
2545 # Make sure we have a compiler that understands altivec.
2546 if [get_compiler_info] {
2547 warning "Could not get compiler info"
2550 if [test_compiler_info gcc*] {
2551 set compile_flags "additional_flags=-maltivec"
2552 } elseif [test_compiler_info xlc*] {
2553 set compile_flags "additional_flags=-qaltivec"
2555 verbose "Could not compile with altivec support, returning 1" 2
2559 # Compile a test program containing VMX instructions.
2563 asm volatile ("vor v0,v0,v0");
2565 asm volatile ("vor 0,0,0");
2570 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2574 # Compilation succeeded so now run it via gdb.
2578 gdb_reinitialize_dir $srcdir/$subdir
2582 -re ".*Illegal instruction.*${gdb_prompt} $" {
2583 verbose -log "\n$me altivec hardware not detected"
2584 set skip_vmx_tests 1
2586 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2587 verbose -log "\n$me: altivec hardware detected"
2588 set skip_vmx_tests 0
2591 warning "\n$me: default case taken"
2592 set skip_vmx_tests 1
2596 remote_file build delete $obj
2598 verbose "$me: returning $skip_vmx_tests" 2
2599 return $skip_vmx_tests
2602 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2603 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2605 gdb_caching_proc skip_vsx_tests {
2606 global srcdir subdir gdb_prompt inferior_exited_re
2608 set me "skip_vsx_tests"
2610 # Some simulators are known to not support Altivec instructions, so
2611 # they won't support VSX instructions as well.
2612 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2613 verbose "$me: target known to not support VSX, returning 1" 2
2617 # Make sure we have a compiler that understands altivec.
2618 if [get_compiler_info] {
2619 warning "Could not get compiler info"
2622 if [test_compiler_info gcc*] {
2623 set compile_flags "additional_flags=-mvsx"
2624 } elseif [test_compiler_info xlc*] {
2625 set compile_flags "additional_flags=-qasm=gcc"
2627 verbose "Could not compile with vsx support, returning 1" 2
2631 # Compile a test program containing VSX instructions.
2634 double a[2] = { 1.0, 2.0 };
2636 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2638 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2643 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2647 # No error message, compilation succeeded so now run it via gdb.
2651 gdb_reinitialize_dir $srcdir/$subdir
2655 -re ".*Illegal instruction.*${gdb_prompt} $" {
2656 verbose -log "\n$me VSX hardware not detected"
2657 set skip_vsx_tests 1
2659 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2660 verbose -log "\n$me: VSX hardware detected"
2661 set skip_vsx_tests 0
2664 warning "\n$me: default case taken"
2665 set skip_vsx_tests 1
2669 remote_file build delete $obj
2671 verbose "$me: returning $skip_vsx_tests" 2
2672 return $skip_vsx_tests
2675 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2676 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2678 gdb_caching_proc skip_tsx_tests {
2679 global srcdir subdir gdb_prompt inferior_exited_re
2681 set me "skip_tsx_tests"
2683 # Compile a test program.
2686 asm volatile ("xbegin .L0");
2687 asm volatile ("xend");
2688 asm volatile (".L0: nop");
2692 if {![gdb_simple_compile $me $src executable]} {
2696 # No error message, compilation succeeded so now run it via gdb.
2700 gdb_reinitialize_dir $srcdir/$subdir
2704 -re ".*Illegal instruction.*${gdb_prompt} $" {
2705 verbose -log "$me: TSX hardware not detected."
2706 set skip_tsx_tests 1
2708 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2709 verbose -log "$me: TSX hardware detected."
2710 set skip_tsx_tests 0
2713 warning "\n$me: default case taken."
2714 set skip_tsx_tests 1
2718 remote_file build delete $obj
2720 verbose "$me: returning $skip_tsx_tests" 2
2721 return $skip_tsx_tests
2724 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2725 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2727 gdb_caching_proc skip_btrace_tests {
2728 global srcdir subdir gdb_prompt inferior_exited_re
2730 set me "skip_btrace_tests"
2731 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2732 verbose "$me: target does not support btrace, returning 1" 2
2736 # Compile a test program.
2737 set src { int main() { return 0; } }
2738 if {![gdb_simple_compile $me $src executable]} {
2742 # No error message, compilation succeeded so now run it via gdb.
2746 gdb_reinitialize_dir $srcdir/$subdir
2751 # In case of an unexpected output, we return 2 as a fail value.
2752 set skip_btrace_tests 2
2753 gdb_test_multiple "record btrace" "check btrace support" {
2754 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2755 set skip_btrace_tests 1
2757 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2758 set skip_btrace_tests 1
2760 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2761 set skip_btrace_tests 1
2763 -re "^record btrace\r\n$gdb_prompt $" {
2764 set skip_btrace_tests 0
2768 remote_file build delete $obj
2770 verbose "$me: returning $skip_btrace_tests" 2
2771 return $skip_btrace_tests
2774 # Run a test on the target to see if it supports btrace pt hardware.
2775 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2776 # from the GCC testsuite.
2778 gdb_caching_proc skip_btrace_pt_tests {
2779 global srcdir subdir gdb_prompt inferior_exited_re
2781 set me "skip_btrace_tests"
2782 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2783 verbose "$me: target does not support btrace, returning 1" 2
2787 # Compile a test program.
2788 set src { int main() { return 0; } }
2789 if {![gdb_simple_compile $me $src executable]} {
2793 # No error message, compilation succeeded so now run it via gdb.
2797 gdb_reinitialize_dir $srcdir/$subdir
2802 # In case of an unexpected output, we return 2 as a fail value.
2803 set skip_btrace_tests 2
2804 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2805 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2806 set skip_btrace_tests 1
2808 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2809 set skip_btrace_tests 1
2811 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2812 set skip_btrace_tests 1
2814 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2815 set skip_btrace_tests 1
2817 -re "^record btrace pt\r\n$gdb_prompt $" {
2818 set skip_btrace_tests 0
2822 remote_file build delete $obj
2824 verbose "$me: returning $skip_btrace_tests" 2
2825 return $skip_btrace_tests
2828 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2829 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2831 gdb_caching_proc skip_aarch64_sve_tests {
2832 global srcdir subdir gdb_prompt inferior_exited_re
2834 set me "skip_aarch64_sve_tests"
2836 if { ![is_aarch64_target]} {
2840 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2842 # Compile a test program containing SVE instructions.
2845 asm volatile ("ptrue p0.b");
2849 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2853 # Compilation succeeded so now run it via gdb.
2857 -re ".*Illegal instruction.*${gdb_prompt} $" {
2858 verbose -log "\n$me sve hardware not detected"
2859 set skip_sve_tests 1
2861 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2862 verbose -log "\n$me: sve hardware detected"
2863 set skip_sve_tests 0
2866 warning "\n$me: default case taken"
2867 set skip_sve_tests 1
2871 remote_file build delete $obj
2873 verbose "$me: returning $skip_sve_tests" 2
2874 return $skip_sve_tests
2878 # A helper that compiles a test case to see if __int128 is supported.
2879 proc gdb_int128_helper {lang} {
2880 return [gdb_can_simple_compile "i128-for-$lang" {
2882 int main() { return 0; }
2886 # Return true if the C compiler understands the __int128 type.
2887 gdb_caching_proc has_int128_c {
2888 return [gdb_int128_helper c]
2891 # Return true if the C++ compiler understands the __int128 type.
2892 gdb_caching_proc has_int128_cxx {
2893 return [gdb_int128_helper c++]
2896 # Return true if the IFUNC feature is unsupported.
2897 gdb_caching_proc skip_ifunc_tests {
2898 if [gdb_can_simple_compile ifunc {
2900 typedef void F (void);
2901 F* g (void) { return &f_; }
2902 void f () __attribute__ ((ifunc ("g")));
2910 # Return whether we should skip tests for showing inlined functions in
2911 # backtraces. Requires get_compiler_info and get_debug_format.
2913 proc skip_inline_frame_tests {} {
2914 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2915 if { ! [test_debug_format "DWARF 2"] } {
2919 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2920 if { ([test_compiler_info "gcc-2-*"]
2921 || [test_compiler_info "gcc-3-*"]
2922 || [test_compiler_info "gcc-4-0-*"]) } {
2929 # Return whether we should skip tests for showing variables from
2930 # inlined functions. Requires get_compiler_info and get_debug_format.
2932 proc skip_inline_var_tests {} {
2933 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2934 if { ! [test_debug_format "DWARF 2"] } {
2941 # Return a 1 if we should skip tests that require hardware breakpoints
2943 proc skip_hw_breakpoint_tests {} {
2944 # Skip tests if requested by the board (note that no_hardware_watchpoints
2945 # disables both watchpoints and breakpoints)
2946 if { [target_info exists gdb,no_hardware_watchpoints]} {
2950 # These targets support hardware breakpoints natively
2951 if { [istarget "i?86-*-*"]
2952 || [istarget "x86_64-*-*"]
2953 || [istarget "ia64-*-*"]
2954 || [istarget "arm*-*-*"]
2955 || [istarget "aarch64*-*-*"]
2956 || [istarget "s390*-*-*"] } {
2963 # Return a 1 if we should skip tests that require hardware watchpoints
2965 proc skip_hw_watchpoint_tests {} {
2966 # Skip tests if requested by the board
2967 if { [target_info exists gdb,no_hardware_watchpoints]} {
2971 # These targets support hardware watchpoints natively
2972 if { [istarget "i?86-*-*"]
2973 || [istarget "x86_64-*-*"]
2974 || [istarget "ia64-*-*"]
2975 || [istarget "arm*-*-*"]
2976 || [istarget "aarch64*-*-*"]
2977 || [istarget "powerpc*-*-linux*"]
2978 || [istarget "s390*-*-*"] } {
2985 # Return a 1 if we should skip tests that require *multiple* hardware
2986 # watchpoints to be active at the same time
2988 proc skip_hw_watchpoint_multi_tests {} {
2989 if { [skip_hw_watchpoint_tests] } {
2993 # These targets support just a single hardware watchpoint
2994 if { [istarget "arm*-*-*"]
2995 || [istarget "powerpc*-*-linux*"] } {
3002 # Return a 1 if we should skip tests that require read/access watchpoints
3004 proc skip_hw_watchpoint_access_tests {} {
3005 if { [skip_hw_watchpoint_tests] } {
3009 # These targets support just write watchpoints
3010 if { [istarget "s390*-*-*"] } {
3017 # Return 1 if we should skip tests that require the runtime unwinder
3018 # hook. This must be invoked while gdb is running, after shared
3019 # libraries have been loaded. This is needed because otherwise a
3020 # shared libgcc won't be visible.
3022 proc skip_unwinder_tests {} {
3026 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3027 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3029 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3032 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3036 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3037 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3040 -re "\r\n$gdb_prompt $" {
3047 # Return 0 if we should skip tests that require the libstdc++ stap
3048 # probes. This must be invoked while gdb is running, after shared
3049 # libraries have been loaded.
3051 proc skip_libstdcxx_probe_tests {} {
3055 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3056 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3059 -re "\r\n$gdb_prompt $" {
3065 # Return 1 if we should skip tests of the "compile" feature.
3066 # This must be invoked after the inferior has been started.
3068 proc skip_compile_feature_tests {} {
3072 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3073 "Could not load libcc1.*\r\n$gdb_prompt $" {
3076 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3079 -re "\r\n$gdb_prompt $" {
3085 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3086 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3087 # is a regexp that will match the output of "maint print target-stack" if
3088 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3089 # matching the expected prompt after the command output.
3091 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3092 set test "probe for target ${target_name}"
3093 gdb_test_multiple "maint print target-stack" $test {
3094 -re "${target_stack_regexp}${prompt_regexp}" {
3098 -re "$prompt_regexp" {
3105 # Helper for gdb_is_target_remote where the expected prompt is variable.
3107 proc gdb_is_target_remote_prompt { prompt_regexp } {
3108 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3111 # Check whether we're testing with the remote or extended-remote
3114 proc gdb_is_target_remote { } {
3117 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3120 # Check whether we're testing with the native target.
3122 proc gdb_is_target_native { } {
3125 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3128 # Return the effective value of use_gdb_stub.
3130 # If the use_gdb_stub global has been set (it is set when the gdb process is
3131 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3132 # property from the board file.
3134 # This is the preferred way of checking use_gdb_stub, since it allows to check
3135 # the value before the gdb has been spawned and it will return the correct value
3136 # even when it was overriden by the test.
3138 proc use_gdb_stub {} {
3141 if [info exists use_gdb_stub] {
3142 return $use_gdb_stub
3145 return [target_info exists use_gdb_stub]
3148 # Return 1 if the current remote target is an instance of our GDBserver, 0
3149 # otherwise. Return -1 if there was an error and we can't tell.
3151 gdb_caching_proc target_is_gdbserver {
3155 set test "probing for GDBserver"
3157 gdb_test_multiple "monitor help" $test {
3158 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3161 -re "$gdb_prompt $" {
3166 if { $is_gdbserver == -1 } {
3167 verbose -log "Unable to tell whether we are using GDBserver or not."
3170 return $is_gdbserver
3173 # N.B. compiler_info is intended to be local to this file.
3174 # Call test_compiler_info with no arguments to fetch its value.
3175 # Yes, this is counterintuitive when there's get_compiler_info,
3176 # but that's the current API.
3177 if [info exists compiler_info] {
3183 # Figure out what compiler I am using.
3184 # The result is cached so only the first invocation runs the compiler.
3186 # ARG can be empty or "C++". If empty, "C" is assumed.
3188 # There are several ways to do this, with various problems.
3190 # [ gdb_compile -E $ifile -o $binfile.ci ]
3191 # source $binfile.ci
3193 # Single Unix Spec v3 says that "-E -o ..." together are not
3194 # specified. And in fact, the native compiler on hp-ux 11 (among
3195 # others) does not work with "-E -o ...". Most targets used to do
3196 # this, and it mostly worked, because it works with gcc.
3198 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3199 # source $binfile.ci
3201 # This avoids the problem with -E and -o together. This almost works
3202 # if the build machine is the same as the host machine, which is
3203 # usually true of the targets which are not gcc. But this code does
3204 # not figure which compiler to call, and it always ends up using the C
3205 # compiler. Not good for setting hp_aCC_compiler. Target
3206 # hppa*-*-hpux* used to do this.
3208 # [ gdb_compile -E $ifile > $binfile.ci ]
3209 # source $binfile.ci
3211 # dejagnu target_compile says that it supports output redirection,
3212 # but the code is completely different from the normal path and I
3213 # don't want to sweep the mines from that path. So I didn't even try
3216 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3219 # I actually do this for all targets now. gdb_compile runs the right
3220 # compiler, and TCL captures the output, and I eval the output.
3222 # Unfortunately, expect logs the output of the command as it goes by,
3223 # and dejagnu helpfully prints a second copy of it right afterwards.
3224 # So I turn off expect logging for a moment.
3226 # [ gdb_compile $ifile $ciexe_file executable $args ]
3227 # [ remote_exec $ciexe_file ]
3228 # [ source $ci_file.out ]
3230 # I could give up on -E and just do this.
3231 # I didn't get desperate enough to try this.
3233 # -- chastain 2004-01-06
3235 proc get_compiler_info {{arg ""}} {
3236 # For compiler.c and compiler.cc
3239 # I am going to play with the log to keep noise out.
3243 # These come from compiler.c or compiler.cc
3244 global compiler_info
3246 # Legacy global data symbols.
3249 if [info exists compiler_info] {
3254 # Choose which file to preprocess.
3255 set ifile "${srcdir}/lib/compiler.c"
3256 if { $arg == "c++" } {
3257 set ifile "${srcdir}/lib/compiler.cc"
3260 # Run $ifile through the right preprocessor.
3261 # Toggle gdb.log to keep the compiler output out of the log.
3262 set saved_log [log_file -info]
3264 if [is_remote host] {
3265 # We have to use -E and -o together, despite the comments
3266 # above, because of how DejaGnu handles remote host testing.
3267 set ppout "$outdir/compiler.i"
3268 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3269 set file [open $ppout r]
3270 set cppout [read $file]
3273 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3275 eval log_file $saved_log
3279 foreach cppline [ split "$cppout" "\n" ] {
3280 if { [ regexp "^#" "$cppline" ] } {
3282 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3284 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3286 verbose "get_compiler_info: $cppline" 2
3290 verbose -log "get_compiler_info: $cppline"
3295 # Set to unknown if for some reason compiler_info didn't get defined.
3296 if ![info exists compiler_info] {
3297 verbose -log "get_compiler_info: compiler_info not provided"
3298 set compiler_info "unknown"
3300 # Also set to unknown compiler if any diagnostics happened.
3302 verbose -log "get_compiler_info: got unexpected diagnostics"
3303 set compiler_info "unknown"
3306 # Set the legacy symbols.
3308 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3310 # Log what happened.
3311 verbose -log "get_compiler_info: $compiler_info"
3313 # Most compilers will evaluate comparisons and other boolean
3314 # operations to 0 or 1.
3315 uplevel \#0 { set true 1 }
3316 uplevel \#0 { set false 0 }
3321 # Return the compiler_info string if no arg is provided.
3322 # Otherwise the argument is a glob-style expression to match against
3325 proc test_compiler_info { {compiler ""} } {
3326 global compiler_info
3329 # If no arg, return the compiler_info string.
3330 if [string match "" $compiler] {
3331 return $compiler_info
3334 return [string match $compiler $compiler_info]
3337 proc current_target_name { } {
3339 if [info exists target_info(target,name)] {
3340 set answer $target_info(target,name)
3347 set gdb_wrapper_initialized 0
3348 set gdb_wrapper_target ""
3350 proc gdb_wrapper_init { args } {
3351 global gdb_wrapper_initialized
3352 global gdb_wrapper_file
3353 global gdb_wrapper_flags
3354 global gdb_wrapper_target
3356 if { $gdb_wrapper_initialized == 1 } { return; }
3358 if {[target_info exists needs_status_wrapper] && \
3359 [target_info needs_status_wrapper] != "0"} {
3360 set result [build_wrapper "testglue.o"]
3361 if { $result != "" } {
3362 set gdb_wrapper_file [lindex $result 0]
3363 set gdb_wrapper_flags [lindex $result 1]
3365 warning "Status wrapper failed to build."
3368 set gdb_wrapper_initialized 1
3369 set gdb_wrapper_target [current_target_name]
3372 # Determine options that we always want to pass to the compiler.
3373 gdb_caching_proc universal_compile_options {
3374 set me "universal_compile_options"
3377 set src [standard_temp_file ccopts[pid].c]
3378 set obj [standard_temp_file ccopts[pid].o]
3380 gdb_produce_source $src {
3381 int foo(void) { return 0; }
3384 # Try an option for disabling colored diagnostics. Some compilers
3385 # yield colored diagnostics by default (when run from a tty) unless
3386 # such an option is specified.
3387 set opt "additional_flags=-fdiagnostics-color=never"
3388 set lines [target_compile $src $obj object [list "quiet" $opt]]
3389 if [string match "" $lines] then {
3390 # Seems to have worked; use the option.
3391 lappend options $opt
3396 verbose "$me: returning $options" 2
3400 # Compile the code in $code to a file based on $name, using the flags
3401 # $compile_flag as well as debug, nowarning and quiet.
3402 # Return 1 if code can be compiled
3403 # Leave the file name of the resulting object in the upvar object.
3405 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3408 switch -regexp -- $type {
3422 set src [standard_temp_file $name-[pid].c]
3423 set obj [standard_temp_file $name-[pid].$postfix]
3424 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3426 gdb_produce_source $src $code
3428 verbose "$name: compiling testfile $src" 2
3429 set lines [gdb_compile $src $obj $type $compile_flags]
3433 if ![string match "" $lines] then {
3434 verbose "$name: compilation failed, returning 0" 2
3440 # Compile the code in $code to a file based on $name, using the flags
3441 # $compile_flag as well as debug, nowarning and quiet.
3442 # Return 1 if code can be compiled
3443 # Delete all created files and objects.
3445 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3446 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3447 file delete $temp_obj
3451 # Some targets need to always link a special object in. Save its path here.
3452 global gdb_saved_set_unbuffered_mode_obj
3453 set gdb_saved_set_unbuffered_mode_obj ""
3455 # Compile source files specified by SOURCE into a binary of type TYPE at path
3456 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3457 # parameter and most options are passed directly to it.
3459 # The type can be one of the following:
3461 # - object: Compile into an object file.
3462 # - executable: Compile and link into an executable.
3463 # - preprocess: Preprocess the source files.
3464 # - assembly: Generate assembly listing.
3466 # The following options are understood and processed by gdb_compile:
3468 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3469 # quirks to be able to use shared libraries.
3470 # - shlib_load: Link with appropriate libraries to allow the test to
3471 # dynamically load libraries at runtime. For example, on Linux, this adds
3472 # -ldl so that the test can use dlopen.
3473 # - nowarnings: Inhibit all compiler warnings.
3475 # And here are some of the not too obscure options understood by DejaGnu that
3476 # influence the compilation:
3478 # - additional_flags=flag: Add FLAG to the compiler flags.
3479 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3480 # argument can be a file, in which case it's added to the sources, or a
3482 # - ldflags=flag: Add FLAG to the linker flags.
3483 # - incdir=path: Add PATH to the searched include directories.
3484 # - libdir=path: Add PATH to the linker searched directories.
3485 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3486 # - debug: Build with debug information.
3487 # - optimize: Build with optimization.
3489 proc gdb_compile {source dest type options} {
3490 global GDB_TESTCASE_OPTIONS
3491 global gdb_wrapper_file
3492 global gdb_wrapper_flags
3493 global gdb_wrapper_initialized
3496 global gdb_saved_set_unbuffered_mode_obj
3498 set outdir [file dirname $dest]
3500 # Add platform-specific options if a shared library was specified using
3501 # "shlib=librarypath" in OPTIONS.
3503 if {[lsearch -exact $options rust] != -1} {
3504 # -fdiagnostics-color is not a rustcc option.
3506 set new_options [universal_compile_options]
3510 foreach opt $options {
3511 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3512 && $type == "executable"} {
3513 if [test_compiler_info "xlc-*"] {
3514 # IBM xlc compiler doesn't accept shared library named other
3515 # than .so: use "-Wl," to bypass this
3516 lappend source "-Wl,$shlib_name"
3517 } elseif { ([istarget "*-*-mingw*"]
3518 || [istarget *-*-cygwin*]
3519 || [istarget *-*-pe*])} {
3520 lappend source "${shlib_name}.a"
3522 lappend source $shlib_name
3524 if { $shlib_found == 0 } {
3526 if { ([istarget "*-*-mingw*"]
3527 || [istarget *-*-cygwin*]) } {
3528 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3530 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3531 # Undo debian's change in the default.
3532 # Put it at the front to not override any user-provided
3533 # value, and to make sure it appears in front of all the
3535 lappend new_options "early_flags=-Wl,--no-as-needed"
3538 } elseif { $opt == "shlib_load" && $type == "executable" } {
3541 lappend new_options $opt
3545 # Because we link with libraries using their basename, we may need
3546 # (depending on the platform) to set a special rpath value, to allow
3547 # the executable to find the libraries it depends on.
3548 if { $shlib_load || $shlib_found } {
3549 if { ([istarget "*-*-mingw*"]
3550 || [istarget *-*-cygwin*]
3551 || [istarget *-*-pe*]) } {
3552 # Do not need anything.
3553 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3554 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3555 } elseif { [istarget arm*-*-symbianelf*] } {
3556 if { $shlib_load } {
3557 lappend new_options "libs=-ldl"
3560 if { $shlib_load } {
3561 lappend new_options "libs=-ldl"
3563 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3566 set options $new_options
3568 if [info exists GDB_TESTCASE_OPTIONS] {
3569 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3571 verbose "options are $options"
3572 verbose "source is $source $dest $type $options"
3574 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3576 if {[target_info exists needs_status_wrapper] && \
3577 [target_info needs_status_wrapper] != "0" && \
3578 [info exists gdb_wrapper_file]} {
3579 lappend options "libs=${gdb_wrapper_file}"
3580 lappend options "ldflags=${gdb_wrapper_flags}"
3583 # Replace the "nowarnings" option with the appropriate additional_flags
3584 # to disable compiler warnings.
3585 set nowarnings [lsearch -exact $options nowarnings]
3586 if {$nowarnings != -1} {
3587 if [target_info exists gdb,nowarnings_flag] {
3588 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3590 set flag "additional_flags=-w"
3592 set options [lreplace $options $nowarnings $nowarnings $flag]
3595 if { $type == "executable" } {
3596 if { ([istarget "*-*-mingw*"]
3597 || [istarget "*-*-*djgpp"]
3598 || [istarget "*-*-cygwin*"])} {
3599 # Force output to unbuffered mode, by linking in an object file
3600 # with a global contructor that calls setvbuf.
3602 # Compile the special object seperatelly for two reasons:
3603 # 1) Insulate it from $options.
3604 # 2) Avoid compiling it for every gdb_compile invocation,
3605 # which is time consuming, especially if we're remote
3608 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3609 verbose "compiling gdb_saved_set_unbuffered_obj"
3610 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3611 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3613 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3614 if { $result != "" } {
3617 if {[is_remote host]} {
3618 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3620 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3622 # Link a copy of the output object, because the
3623 # original may be automatically deleted.
3624 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3626 verbose "gdb_saved_set_unbuffered_obj already compiled"
3629 # Rely on the internal knowledge that the global ctors are ran in
3630 # reverse link order. In that case, we can use ldflags to
3631 # avoid copying the object file to the host multiple
3633 # This object can only be added if standard libraries are
3634 # used. Thus, we need to disable it if -nostdlib option is used
3635 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3636 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3641 set result [target_compile $source $dest $type $options]
3643 # Prune uninteresting compiler (and linker) output.
3644 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3646 regsub "\[\r\n\]*$" "$result" "" result
3647 regsub "^\[\r\n\]*" "$result" "" result
3649 if {[lsearch $options quiet] < 0} {
3650 # We shall update this on a per language basis, to avoid
3651 # changing the entire testsuite in one go.
3652 if {[lsearch $options f77] >= 0} {
3653 gdb_compile_test $source $result
3654 } elseif { $result != "" } {
3655 clone_output "gdb compile failed, $result"
3662 # This is just like gdb_compile, above, except that it tries compiling
3663 # against several different thread libraries, to see which one this
3665 proc gdb_compile_pthreads {source dest type options} {
3667 set why_msg "unrecognized error"
3668 foreach lib {-lpthreads -lpthread -lthread ""} {
3669 # This kind of wipes out whatever libs the caller may have
3670 # set. Or maybe theirs will override ours. How infelicitous.
3671 set options_with_lib [concat $options [list libs=$lib quiet]]
3672 set ccout [gdb_compile $source $dest $type $options_with_lib]
3673 switch -regexp -- $ccout {
3674 ".*no posix threads support.*" {
3675 set why_msg "missing threads include file"
3678 ".*cannot open -lpthread.*" {
3679 set why_msg "missing runtime threads library"
3681 ".*Can't find library for -lpthread.*" {
3682 set why_msg "missing runtime threads library"
3685 pass "successfully compiled posix threads test case"
3691 if {!$built_binfile} {
3692 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3697 # Build a shared library from SOURCES.
3699 proc gdb_compile_shlib {sources dest options} {
3700 set obj_options $options
3703 if { [lsearch -exact $options "c++"] >= 0 } {
3704 set info_options "c++"
3706 if [get_compiler_info ${info_options}] {
3710 switch -glob [test_compiler_info] {
3712 lappend obj_options "additional_flags=-qpic"
3715 if { !([istarget "*-*-cygwin*"]
3716 || [istarget "*-*-mingw*"]) } {
3717 lappend obj_options "additional_flags=-fpic"
3721 if { !([istarget "powerpc*-*-aix*"]
3722 || [istarget "rs6000*-*-aix*"]
3723 || [istarget "*-*-cygwin*"]
3724 || [istarget "*-*-mingw*"]
3725 || [istarget "*-*-pe*"]) } {
3726 lappend obj_options "additional_flags=-fpic"
3730 lappend obj_options "additional_flags=-fpic"
3733 # don't know what the compiler is...
3737 set outdir [file dirname $dest]
3739 foreach source $sources {
3740 set sourcebase [file tail $source]
3741 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3744 lappend objects ${outdir}/${sourcebase}.o
3747 set link_options $options
3748 if [test_compiler_info "xlc-*"] {
3749 lappend link_options "additional_flags=-qmkshrobj"
3751 lappend link_options "additional_flags=-shared"
3753 if { ([istarget "*-*-mingw*"]
3754 || [istarget *-*-cygwin*]
3755 || [istarget *-*-pe*]) } {
3756 if { [is_remote host] } {
3757 set name [file tail ${dest}]
3761 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3763 # Set the soname of the library. This causes the linker on ELF
3764 # systems to create the DT_NEEDED entry in the executable referring
3765 # to the soname of the library, and not its absolute path. This
3766 # (using the absolute path) would be problem when testing on a
3769 # In conjunction with setting the soname, we add the special
3770 # rpath=$ORIGIN value when building the executable, so that it's
3771 # able to find the library in its own directory.
3772 set destbase [file tail $dest]
3773 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3776 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3779 if { [is_remote host]
3780 && ([istarget "*-*-mingw*"]
3781 || [istarget *-*-cygwin*]
3782 || [istarget *-*-pe*]) } {
3783 set dest_tail_name [file tail ${dest}]
3784 remote_upload host $dest_tail_name.a ${dest}.a
3785 remote_file host delete $dest_tail_name.a
3791 # This is just like gdb_compile_shlib, above, except that it tries compiling
3792 # against several different thread libraries, to see which one this
3794 proc gdb_compile_shlib_pthreads {sources dest options} {
3796 set why_msg "unrecognized error"
3797 foreach lib {-lpthreads -lpthread -lthread ""} {
3798 # This kind of wipes out whatever libs the caller may have
3799 # set. Or maybe theirs will override ours. How infelicitous.
3800 set options_with_lib [concat $options [list libs=$lib quiet]]
3801 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3802 switch -regexp -- $ccout {
3803 ".*no posix threads support.*" {
3804 set why_msg "missing threads include file"
3807 ".*cannot open -lpthread.*" {
3808 set why_msg "missing runtime threads library"
3810 ".*Can't find library for -lpthread.*" {
3811 set why_msg "missing runtime threads library"
3814 pass "successfully compiled posix threads test case"
3820 if {!$built_binfile} {
3821 unsupported "couldn't compile $sources: ${why_msg}"
3826 # This is just like gdb_compile_pthreads, above, except that we always add the
3827 # objc library for compiling Objective-C programs
3828 proc gdb_compile_objc {source dest type options} {
3830 set why_msg "unrecognized error"
3831 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3832 # This kind of wipes out whatever libs the caller may have
3833 # set. Or maybe theirs will override ours. How infelicitous.
3834 if { $lib == "solaris" } {
3835 set lib "-lpthread -lposix4"
3837 if { $lib != "-lobjc" } {
3838 set lib "-lobjc $lib"
3840 set options_with_lib [concat $options [list libs=$lib quiet]]
3841 set ccout [gdb_compile $source $dest $type $options_with_lib]
3842 switch -regexp -- $ccout {
3843 ".*no posix threads support.*" {
3844 set why_msg "missing threads include file"
3847 ".*cannot open -lpthread.*" {
3848 set why_msg "missing runtime threads library"
3850 ".*Can't find library for -lpthread.*" {
3851 set why_msg "missing runtime threads library"
3854 pass "successfully compiled objc with posix threads test case"
3860 if {!$built_binfile} {
3861 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3866 proc send_gdb { string } {
3867 global suppress_flag
3868 if { $suppress_flag } {
3871 return [remote_send host "$string"]
3874 # Send STRING to the inferior's terminal.
3876 proc send_inferior { string } {
3877 global inferior_spawn_id
3879 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3889 proc gdb_expect { args } {
3890 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3891 set atimeout [lindex $args 0]
3892 set expcode [list [lindex $args 1]]
3897 # A timeout argument takes precedence, otherwise of all the timeouts
3898 # select the largest.
3899 if [info exists atimeout] {
3902 set tmt [get_largest_timeout]
3905 global suppress_flag
3906 global remote_suppress_flag
3907 if [info exists remote_suppress_flag] {
3908 set old_val $remote_suppress_flag
3910 if [info exists suppress_flag] {
3911 if { $suppress_flag } {
3912 set remote_suppress_flag 1
3916 {uplevel remote_expect host $tmt $expcode} string]
3917 if [info exists old_val] {
3918 set remote_suppress_flag $old_val
3920 if [info exists remote_suppress_flag] {
3921 unset remote_suppress_flag
3926 global errorInfo errorCode
3928 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3930 return -code $code $string
3934 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3936 # Check for long sequence of output by parts.
3937 # TEST: is the test message to be printed with the test success/fail.
3938 # SENTINEL: Is the terminal pattern indicating that output has finished.
3939 # LIST: is the sequence of outputs to match.
3940 # If the sentinel is recognized early, it is considered an error.
3943 # 1 if the test failed,
3944 # 0 if the test passes,
3945 # -1 if there was an internal error.
3947 proc gdb_expect_list {test sentinel list} {
3949 global suppress_flag
3952 if { $suppress_flag } {
3954 unresolved "${test}"
3956 while { ${index} < [llength ${list}] } {
3957 set pattern [lindex ${list} ${index}]
3958 set index [expr ${index} + 1]
3959 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3960 if { ${index} == [llength ${list}] } {
3963 -re "${pattern}${sentinel}" {
3964 # pass "${test}, pattern ${index} + sentinel"
3967 fail "${test} (pattern ${index} + sentinel)"
3970 -re ".*A problem internal to GDB has been detected" {
3971 fail "${test} (GDB internal error)"
3973 gdb_internal_error_resync
3976 fail "${test} (pattern ${index} + sentinel) (timeout)"
3981 # unresolved "${test}, pattern ${index} + sentinel"
3987 # pass "${test}, pattern ${index}"
3990 fail "${test} (pattern ${index})"
3993 -re ".*A problem internal to GDB has been detected" {
3994 fail "${test} (GDB internal error)"
3996 gdb_internal_error_resync
3999 fail "${test} (pattern ${index}) (timeout)"
4004 # unresolved "${test}, pattern ${index}"
4018 proc gdb_suppress_entire_file { reason } {
4019 global suppress_flag
4022 set suppress_flag -1
4026 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4027 # gdb_expect to fail immediately (until the next call to
4028 # gdb_stop_suppressing_tests).
4030 proc gdb_suppress_tests { args } {
4031 global suppress_flag
4033 return; # fnf - disable pending review of results where
4034 # testsuite ran better without this
4037 if { $suppress_flag == 1 } {
4038 if { [llength $args] > 0 } {
4039 warning "[lindex $args 0]\n"
4041 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4047 # Clear suppress_flag.
4049 proc gdb_stop_suppressing_tests { } {
4050 global suppress_flag
4052 if [info exists suppress_flag] {
4053 if { $suppress_flag > 0 } {
4055 clone_output "Tests restarted.\n"
4062 proc gdb_clear_suppressed { } {
4063 global suppress_flag
4068 # Spawn the gdb process.
4070 # This doesn't expect any output or do any other initialization,
4071 # leaving those to the caller.
4073 # Overridable function -- you can override this function in your
4076 proc gdb_spawn { } {
4080 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4082 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4085 set saved_gdbflags $GDBFLAGS
4087 if {$GDBFLAGS != ""} {
4090 append GDBFLAGS $cmdline_flags
4094 set GDBFLAGS $saved_gdbflags
4099 # Start gdb running, wait for prompt, and disable the pagers.
4101 # Overridable function -- you can override this function in your
4104 proc gdb_start { } {
4109 catch default_gdb_exit
4112 # Return true if we can spawn a program on the target and attach to
4115 proc can_spawn_for_attach { } {
4116 # We use exp_pid to get the inferior's pid, assuming that gives
4117 # back the pid of the program. On remote boards, that would give
4118 # us instead the PID of e.g., the ssh client, etc.
4119 if [is_remote target] then {
4123 # The "attach" command doesn't make sense when the target is
4124 # stub-like, where GDB finds the program already started on
4125 # initial connection.
4126 if {[target_info exists use_gdb_stub]} {
4134 # Kill a progress previously started with spawn_wait_for_attach, and
4135 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4138 proc kill_wait_spawned_process { proc_spawn_id } {
4139 set pid [exp_pid -i $proc_spawn_id]
4141 verbose -log "killing ${pid}"
4142 remote_exec build "kill -9 ${pid}"
4144 verbose -log "closing ${proc_spawn_id}"
4145 catch "close -i $proc_spawn_id"
4146 verbose -log "waiting for ${proc_spawn_id}"
4148 # If somehow GDB ends up still attached to the process here, a
4149 # blocking wait hangs until gdb is killed (or until gdb / the
4150 # ptracer reaps the exit status too, but that won't happen because
4151 # something went wrong.) Passing -nowait makes expect tell Tcl to
4152 # wait for the PID in the background. That's fine because we
4153 # don't care about the exit status. */
4154 wait -nowait -i $proc_spawn_id
4157 # Returns the process id corresponding to the given spawn id.
4159 proc spawn_id_get_pid { spawn_id } {
4160 set testpid [exp_pid -i $spawn_id]
4162 if { [istarget "*-*-cygwin*"] } {
4163 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4164 # might be different due to the way fork/exec works.
4165 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4171 # Start a set of programs running and then wait for a bit, to be sure
4172 # that they can be attached to. Return a list of processes spawn IDs,
4173 # one element for each process spawned. It's a test error to call
4174 # this when [can_spawn_for_attach] is false.
4176 proc spawn_wait_for_attach { executable_list } {
4177 set spawn_id_list {}
4179 if ![can_spawn_for_attach] {
4180 # The caller should have checked can_spawn_for_attach itself
4181 # before getting here.
4182 error "can't spawn for attach with this target/board"
4185 foreach {executable} $executable_list {
4186 # Note we use Expect's spawn, not Tcl's exec, because with
4187 # spawn we control when to wait for/reap the process. That
4188 # allows killing the process by PID without being subject to
4190 lappend spawn_id_list [remote_spawn target $executable]
4195 return $spawn_id_list
4199 # gdb_load_cmd -- load a file into the debugger.
4200 # ARGS - additional args to load command.
4201 # return a -1 if anything goes wrong.
4203 proc gdb_load_cmd { args } {
4206 if [target_info exists gdb_load_timeout] {
4207 set loadtimeout [target_info gdb_load_timeout]
4209 set loadtimeout 1600
4211 send_gdb "load $args\n"
4212 verbose "Timeout is now $loadtimeout seconds" 2
4213 gdb_expect $loadtimeout {
4214 -re "Loading section\[^\r\]*\r\n" {
4217 -re "Start address\[\r\]*\r\n" {
4220 -re "Transfer rate\[\r\]*\r\n" {
4223 -re "Memory access error\[^\r\]*\r\n" {
4224 perror "Failed to load program"
4227 -re "$gdb_prompt $" {
4230 -re "(.*)\r\n$gdb_prompt " {
4231 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4235 perror "Timed out trying to load $args."
4242 # Invoke "gcore". CORE is the name of the core file to write. TEST
4243 # is the name of the test case. This will return 1 if the core file
4244 # was created, 0 otherwise. If this fails to make a core file because
4245 # this configuration of gdb does not support making core files, it
4246 # will call "unsupported", not "fail". However, if this fails to make
4247 # a core file for some other reason, then it will call "fail".
4249 proc gdb_gcore_cmd {core test} {
4253 gdb_test_multiple "gcore $core" $test {
4254 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4258 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4266 # Load core file CORE. TEST is the name of the test case.
4267 # This will record a pass/fail for loading the core file.
4269 # 1 - core file is successfully loaded
4270 # 0 - core file loaded but has a non fatal error
4271 # -1 - core file failed to load
4273 proc gdb_core_cmd { core test } {
4276 gdb_test_multiple "core $core" "$test" {
4277 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4280 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4281 fail "$test (bad file format)"
4284 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4285 fail "$test (file not found)"
4288 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4289 fail "$test (incomplete note section)"
4292 -re "Core was generated by .*\r\n$gdb_prompt $" {
4296 -re ".*$gdb_prompt $" {
4301 fail "$test (timeout)"
4305 fail "unsupported output from 'core' command"
4309 # Return the filename to download to the target and load on the target
4310 # for this shared library. Normally just LIBNAME, unless shared libraries
4311 # for this target have separate link and load images.
4313 proc shlib_target_file { libname } {
4317 # Return the filename GDB will load symbols from when debugging this
4318 # shared library. Normally just LIBNAME, unless shared libraries for
4319 # this target have separate link and load images.
4321 proc shlib_symbol_file { libname } {
4325 # Return the filename to download to the target and load for this
4326 # executable. Normally just BINFILE unless it is renamed to something
4327 # else for this target.
4329 proc exec_target_file { binfile } {
4333 # Return the filename GDB will load symbols from when debugging this
4334 # executable. Normally just BINFILE unless executables for this target
4335 # have separate files for symbols.
4337 proc exec_symbol_file { binfile } {
4341 # Rename the executable file. Normally this is just BINFILE1 being renamed
4342 # to BINFILE2, but some targets require multiple binary files.
4343 proc gdb_rename_execfile { binfile1 binfile2 } {
4344 file rename -force [exec_target_file ${binfile1}] \
4345 [exec_target_file ${binfile2}]
4346 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4347 file rename -force [exec_symbol_file ${binfile1}] \
4348 [exec_symbol_file ${binfile2}]
4352 # "Touch" the executable file to update the date. Normally this is just
4353 # BINFILE, but some targets require multiple files.
4354 proc gdb_touch_execfile { binfile } {
4355 set time [clock seconds]
4356 file mtime [exec_target_file ${binfile}] $time
4357 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4358 file mtime [exec_symbol_file ${binfile}] $time
4362 # Like remote_download but provides a gdb-specific behavior.
4364 # If the destination board is remote, the local file FROMFILE is transferred as
4365 # usual with remote_download to TOFILE on the remote board. The destination
4366 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4369 # If the destination board is local, the destination path TOFILE is passed
4370 # through standard_output_file, and FROMFILE is copied there.
4372 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4375 proc gdb_remote_download {dest fromfile {tofile {}}} {
4376 # If TOFILE is not given, default to the same filename as FROMFILE.
4377 if {[string length $tofile] == 0} {
4378 set tofile [file tail $fromfile]
4381 if {[is_remote $dest]} {
4382 # When the DEST is remote, we simply send the file to DEST.
4385 set destname [remote_download $dest $fromfile $tofile]
4386 lappend cleanfiles $destname
4390 # When the DEST is local, we copy the file to the test directory (where
4391 # the executable is).
4393 # Note that we pass TOFILE through standard_output_file, regardless of
4394 # whether it is absolute or relative, because we don't want the tests
4395 # to be able to write outside their standard output directory.
4397 set tofile [standard_output_file $tofile]
4399 file copy -force $fromfile $tofile
4405 # gdb_load_shlib LIB...
4407 # Copy the listed library to the target.
4409 proc gdb_load_shlib { file } {
4412 if ![info exists gdb_spawn_id] {
4413 perror "gdb_load_shlib: GDB is not running"
4416 set dest [gdb_remote_download target [shlib_target_file $file]]
4418 if {[is_remote target]} {
4419 # If the target is remote, we need to tell gdb where to find the
4422 # We could set this even when not testing remotely, but a user
4423 # generally won't set it unless necessary. In order to make the tests
4424 # more like the real-life scenarios, we don't set it for local testing.
4425 gdb_test "set solib-search-path [file dirname $file]" "" ""
4432 # gdb_load -- load a file into the debugger. Specifying no file
4433 # defaults to the executable currently being debugged.
4434 # The return value is 0 for success, -1 for failure.
4435 # Many files in config/*.exp override this procedure.
4437 proc gdb_load { arg } {
4439 return [gdb_file_cmd $arg]
4444 # gdb_reload -- load a file into the target. Called before "running",
4445 # either the first time or after already starting the program once,
4446 # for remote targets. Most files that override gdb_load should now
4447 # override this instead.
4449 proc gdb_reload { } {
4450 # For the benefit of existing configurations, default to gdb_load.
4451 # Specifying no file defaults to the executable currently being
4453 return [gdb_load ""]
4456 proc gdb_continue { function } {
4459 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4462 proc default_gdb_init { test_file_name } {
4463 global gdb_wrapper_initialized
4464 global gdb_wrapper_target
4465 global gdb_test_file_name
4471 gdb_clear_suppressed
4473 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4475 # Make sure that the wrapper is rebuilt
4476 # with the appropriate multilib option.
4477 if { $gdb_wrapper_target != [current_target_name] } {
4478 set gdb_wrapper_initialized 0
4481 # Unlike most tests, we have a small number of tests that generate
4482 # a very large amount of output. We therefore increase the expect
4483 # buffer size to be able to contain the entire test output. This
4484 # is especially needed by gdb.base/info-macros.exp.
4486 # Also set this value for the currently running GDB.
4487 match_max [match_max -d]
4489 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4490 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4493 if [target_info exists gdb_prompt] {
4494 set gdb_prompt [target_info gdb_prompt]
4496 set gdb_prompt "\\(gdb\\)"
4499 if [info exists use_gdb_stub] {
4504 # Return a path using GDB_PARALLEL.
4505 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4506 # GDB_PARALLEL must be defined, the caller must check.
4508 # The default value for GDB_PARALLEL is, canonically, ".".
4509 # The catch is that tests don't expect an additional "./" in file paths so
4510 # omit any directory for the default case.
4511 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4512 # its special handling.
4514 proc make_gdb_parallel_path { args } {
4515 global GDB_PARALLEL objdir
4516 set joiner [list "file" "join" $objdir]
4517 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4518 lappend joiner $GDB_PARALLEL
4520 set joiner [concat $joiner $args]
4521 return [eval $joiner]
4524 # Turn BASENAME into a full file name in the standard output
4525 # directory. It is ok if BASENAME is the empty string; in this case
4526 # the directory is returned.
4528 proc standard_output_file {basename} {
4529 global objdir subdir gdb_test_file_name
4531 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4533 return [file join $dir $basename]
4536 # Return the name of a file in our standard temporary directory.
4538 proc standard_temp_file {basename} {
4539 # Since a particular runtest invocation is only executing a single test
4540 # file at any given time, we can use the runtest pid to build the
4541 # path of the temp directory.
4542 set dir [make_gdb_parallel_path temp [pid]]
4544 return [file join $dir $basename]
4547 # Set 'testfile', 'srcfile', and 'binfile'.
4549 # ARGS is a list of source file specifications.
4550 # Without any arguments, the .exp file's base name is used to
4551 # compute the source file name. The ".c" extension is added in this case.
4552 # If ARGS is not empty, each entry is a source file specification.
4553 # If the specification starts with a ".", it is treated as a suffix
4554 # to append to the .exp file's base name.
4555 # If the specification is the empty string, it is treated as if it
4557 # Otherwise it is a file name.
4558 # The first file in the list is used to set the 'srcfile' global.
4559 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4561 # Most tests should call this without arguments.
4563 # If a completely different binary file name is needed, then it
4564 # should be handled in the .exp file with a suitable comment.
4566 proc standard_testfile {args} {
4567 global gdb_test_file_name
4569 global gdb_test_file_last_vars
4572 global testfile binfile
4574 set testfile $gdb_test_file_name
4575 set binfile [standard_output_file ${testfile}]
4577 if {[llength $args] == 0} {
4581 # Unset our previous output variables.
4582 # This can help catch hidden bugs.
4583 if {[info exists gdb_test_file_last_vars]} {
4584 foreach varname $gdb_test_file_last_vars {
4586 catch {unset $varname}
4589 # 'executable' is often set by tests.
4590 set gdb_test_file_last_vars {executable}
4594 set varname srcfile$suffix
4597 # Handle an extension.
4600 } elseif {[string range $arg 0 0] == "."} {
4601 set arg $testfile$arg
4605 lappend gdb_test_file_last_vars $varname
4607 if {$suffix == ""} {
4615 # The default timeout used when testing GDB commands. We want to use
4616 # the same timeout as the default dejagnu timeout, unless the user has
4617 # already provided a specific value (probably through a site.exp file).
4618 global gdb_test_timeout
4619 if ![info exists gdb_test_timeout] {
4620 set gdb_test_timeout $timeout
4623 # A list of global variables that GDB testcases should not use.
4624 # We try to prevent their use by monitoring write accesses and raising
4625 # an error when that happens.
4626 set banned_variables { bug_id prms_id }
4628 # A list of procedures that GDB testcases should not use.
4629 # We try to prevent their use by monitoring invocations and raising
4630 # an error when that happens.
4631 set banned_procedures { strace }
4633 # gdb_init is called by runtest at start, but also by several
4634 # tests directly; gdb_finish is only called from within runtest after
4635 # each test source execution.
4636 # Placing several traces by repetitive calls to gdb_init leads
4637 # to problems, as only one trace is removed in gdb_finish.
4638 # To overcome this possible problem, we add a variable that records
4639 # if the banned variables and procedures are already traced.
4642 proc gdb_init { test_file_name } {
4643 # Reset the timeout value to the default. This way, any testcase
4644 # that changes the timeout value without resetting it cannot affect
4645 # the timeout used in subsequent testcases.
4646 global gdb_test_timeout
4648 set timeout $gdb_test_timeout
4650 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4651 && [target_info exists gdb_reverse_timeout] } {
4652 set timeout [target_info gdb_reverse_timeout]
4655 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4656 # debugging tool to help confirm that the test suite is
4657 # parallel-safe. You need "inotifywait" from the
4658 # inotify-tools package to use this.
4659 global GDB_INOTIFY inotify_pid
4660 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4661 global outdir tool inotify_log_file
4663 set exclusions {outputs temp gdb[.](log|sum) cache}
4664 set exclusion_re ([join $exclusions |])
4666 set inotify_log_file [standard_temp_file inotify.out]
4667 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4668 --exclude $exclusion_re \
4669 |& tee -a $outdir/$tool.log $inotify_log_file &]
4671 # Wait for the watches; hopefully this is long enough.
4674 # Clear the log so that we don't emit a warning the first time
4676 set fd [open $inotify_log_file w]
4680 # Block writes to all banned variables, and invocation of all
4681 # banned procedures...
4682 global banned_variables
4683 global banned_procedures
4684 global banned_traced
4685 if (!$banned_traced) {
4686 foreach banned_var $banned_variables {
4687 global "$banned_var"
4688 trace add variable "$banned_var" write error
4690 foreach banned_proc $banned_procedures {
4691 global "$banned_proc"
4692 trace add execution "$banned_proc" enter error
4697 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4698 # messages as expected.
4703 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4704 # the test results. Even if /dev/null doesn't exist on the particular
4705 # platform, the readline library will use the default setting just by
4706 # failing to open the file. OTOH, opening /dev/null successfully will
4707 # also result in the default settings being used since nothing will be
4708 # read from this file.
4709 setenv INPUTRC "/dev/null"
4711 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4712 # bindings, so make sure that an appropriate terminal is selected.
4713 # The same bug doesn't show up if we use ^P / ^N instead.
4716 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4717 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4718 # especially having color output turned on can cause tests to fail.
4719 setenv GREP_OPTIONS ""
4721 # Clear $gdbserver_reconnect_p.
4722 global gdbserver_reconnect_p
4723 set gdbserver_reconnect_p 1
4724 unset gdbserver_reconnect_p
4726 return [default_gdb_init $test_file_name]
4729 proc gdb_finish { } {
4730 global gdbserver_reconnect_p
4734 # Exit first, so that the files are no longer in use.
4737 if { [llength $cleanfiles] > 0 } {
4738 eval remote_file target delete $cleanfiles
4742 # Unblock write access to the banned variables. Dejagnu typically
4743 # resets some of them between testcases.
4744 global banned_variables
4745 global banned_procedures
4746 global banned_traced
4747 if ($banned_traced) {
4748 foreach banned_var $banned_variables {
4749 global "$banned_var"
4750 trace remove variable "$banned_var" write error
4752 foreach banned_proc $banned_procedures {
4753 global "$banned_proc"
4754 trace remove execution "$banned_proc" enter error
4761 set debug_format "unknown"
4763 # Run the gdb command "info source" and extract the debugging format
4764 # information from the output and save it in debug_format.
4766 proc get_debug_format { } {
4772 set debug_format "unknown"
4773 send_gdb "info source\n"
4775 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4776 set debug_format $expect_out(1,string)
4777 verbose "debug format is $debug_format"
4780 -re "No current source file.\r\n$gdb_prompt $" {
4781 perror "get_debug_format used when no current source file"
4784 -re "$gdb_prompt $" {
4785 warning "couldn't check debug format (no valid response)."
4789 warning "couldn't check debug format (timeout)."
4795 # Return true if FORMAT matches the debug format the current test was
4796 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4797 # `*', `[...]', and so on.
4799 # This function depends on variables set by `get_debug_format', above.
4801 proc test_debug_format {format} {
4804 return [expr [string match $format $debug_format] != 0]
4807 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4808 # COFF, stabs, etc). If that format matches the format that the
4809 # current test was compiled with, then the next test is expected to
4810 # fail for any target. Returns 1 if the next test or set of tests is
4811 # expected to fail, 0 otherwise (or if it is unknown). Must have
4812 # previously called get_debug_format.
4813 proc setup_xfail_format { format } {
4814 set ret [test_debug_format $format]
4822 # gdb_get_line_number TEXT [FILE]
4824 # Search the source file FILE, and return the line number of the
4825 # first line containing TEXT. If no match is found, an error is thrown.
4827 # TEXT is a string literal, not a regular expression.
4829 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4830 # specified, and does not start with "/", then it is assumed to be in
4831 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4832 # by changing the callers and the interface at the same time.
4833 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4834 # gdb.base/ena-dis-br.exp.
4836 # Use this function to keep your test scripts independent of the
4837 # exact line numbering of the source file. Don't write:
4839 # send_gdb "break 20"
4841 # This means that if anyone ever edits your test's source file,
4842 # your test could break. Instead, put a comment like this on the
4843 # source file line you want to break at:
4845 # /* breakpoint spot: frotz.exp: test name */
4847 # and then write, in your test script (which we assume is named
4850 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4852 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4855 # % puts "foo [lindex "bar baz" 1]"
4858 # Tcl is quite clever, for a little stringy language.)
4862 # The previous implementation of this procedure used the gdb search command.
4863 # This version is different:
4865 # . It works with MI, and it also works when gdb is not running.
4867 # . It operates on the build machine, not the host machine.
4869 # . For now, this implementation fakes a current directory of
4870 # $srcdir/$subdir to be compatible with the old implementation.
4871 # This will go away eventually and some callers will need to
4874 # . The TEXT argument is literal text and matches literally,
4875 # not a regular expression as it was before.
4877 # . State changes in gdb, such as changing the current file
4878 # and setting $_, no longer happen.
4880 # After a bit of time we can forget about the differences from the
4881 # old implementation.
4883 # --chastain 2004-08-05
4885 proc gdb_get_line_number { text { file "" } } {
4890 if { "$file" == "" } then {
4893 if { ! [regexp "^/" "$file"] } then {
4894 set file "$srcdir/$subdir/$file"
4897 if { [ catch { set fd [open "$file"] } message ] } then {
4902 for { set line 1 } { 1 } { incr line } {
4903 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4906 if { $nchar < 0 } then {
4909 if { [string first "$text" "$body"] >= 0 } then {
4915 if { [ catch { close "$fd" } message ] } then {
4920 error "undefined tag \"$text\""
4926 # Continue the program until it ends.
4928 # MSSG is the error message that gets printed. If not given, a
4930 # COMMAND is the command to invoke. If not given, "continue" is
4932 # ALLOW_EXTRA is a flag indicating whether the test should expect
4933 # extra output between the "Continuing." line and the program
4934 # exiting. By default it is zero; if nonzero, any extra output
4937 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4938 global inferior_exited_re use_gdb_stub
4941 set text "continue until exit"
4943 set text "continue until exit at $mssg"
4951 # By default, we don't rely on exit() behavior of remote stubs --
4952 # it's common for exit() to be implemented as a simple infinite
4953 # loop, or a forced crash/reset. For native targets, by default, we
4954 # assume process exit is reported as such. If a non-reliable target
4955 # is used, we set a breakpoint at exit, and continue to that.
4956 if { [target_info exists exit_is_reliable] } {
4957 set exit_is_reliable [target_info exit_is_reliable]
4959 set exit_is_reliable [expr ! $use_gdb_stub]
4962 if { ! $exit_is_reliable } {
4963 if {![gdb_breakpoint "exit"]} {
4966 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4969 # Continue until we exit. Should not stop again.
4970 # Don't bother to check the output of the program, that may be
4971 # extremely tough for some remote systems.
4973 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4978 proc rerun_to_main {} {
4979 global gdb_prompt use_gdb_stub
4984 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4985 {pass "rerun to main" ; return 0}
4986 -re "$gdb_prompt $"\
4987 {fail "rerun to main" ; return 0}
4988 timeout {fail "(timeout) rerun to main" ; return 0}
4993 -re "The program .* has been started already.*y or n. $" {
4997 -re "Starting program.*$gdb_prompt $"\
4998 {pass "rerun to main" ; return 0}
4999 -re "$gdb_prompt $"\
5000 {fail "rerun to main" ; return 0}
5001 timeout {fail "(timeout) rerun to main" ; return 0}
5006 # Return true if a test should be skipped due to lack of floating
5007 # point support or GDB can't fetch the contents from floating point
5010 gdb_caching_proc gdb_skip_float_test {
5011 if [target_info exists gdb,skip_float_tests] {
5015 # There is an ARM kernel ptrace bug that hardware VFP registers
5016 # are not updated after GDB ptrace set VFP registers. The bug
5017 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5018 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5019 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5020 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5021 # This kernel bug is detected by check how does GDB change the
5022 # program result by changing one VFP register.
5023 if { [istarget "arm*-*-linux*"] } {
5025 set compile_flags {debug nowarnings }
5027 # Set up, compile, and execute a test program having VFP
5029 set src [standard_temp_file arm_vfp[pid].c]
5030 set exe [standard_temp_file arm_vfp[pid].x]
5032 gdb_produce_source $src {
5037 asm ("vldr d0, [%0]" : : "r" (&d));
5038 asm ("vldr d1, [%0]" : : "r" (&d));
5039 asm (".global break_here\n"
5041 asm ("vcmp.f64 d0, d1\n"
5042 "vmrs APSR_nzcv, fpscr\n"
5043 "bne L_value_different\n"
5046 "L_value_different:\n"
5048 "L_end:\n" : "=r" (ret) :);
5050 /* Return $d0 != $d1. */
5055 verbose "compiling testfile $src" 2
5056 set lines [gdb_compile $src $exe executable $compile_flags]
5059 if ![string match "" $lines] then {
5060 verbose "testfile compilation failed, returning 1" 2
5064 # No error message, compilation succeeded so now run it via gdb.
5065 # Run the test up to 5 times to detect whether ptrace can
5066 # correctly update VFP registers or not.
5068 for {set i 0} {$i < 5} {incr i} {
5069 global gdb_prompt srcdir subdir
5073 gdb_reinitialize_dir $srcdir/$subdir
5077 gdb_test "break *break_here"
5078 gdb_continue_to_breakpoint "break_here"
5080 # Modify $d0 to a different value, so the exit code should
5082 gdb_test "set \$d0 = 5.0"
5084 set test "continue to exit"
5085 gdb_test_multiple "continue" "$test" {
5086 -re "exited with code 01.*$gdb_prompt $" {
5088 -re "exited normally.*$gdb_prompt $" {
5089 # However, the exit code is 0. That means something
5090 # wrong in setting VFP registers.
5098 remote_file build delete $exe
5100 return $skip_vfp_test
5105 # Print a message and return true if a test should be skipped
5106 # due to lack of stdio support.
5108 proc gdb_skip_stdio_test { msg } {
5109 if [target_info exists gdb,noinferiorio] {
5110 verbose "Skipping test '$msg': no inferior i/o."
5116 proc gdb_skip_bogus_test { msg } {
5120 # Return true if a test should be skipped due to lack of XML support
5122 # NOTE: This must be called while gdb is *not* running.
5124 gdb_caching_proc gdb_skip_xml_test {
5129 if { [info exists gdb_spawn_id] } {
5130 error "GDB must not be running in gdb_skip_xml_tests."
5133 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5137 gdb_test_multiple "set tdesc filename $xml_file" "" {
5138 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5141 -re ".*$gdb_prompt $" { }
5147 # Return true if argv[0] is available.
5149 gdb_caching_proc gdb_has_argv0 {
5152 # Compile and execute a test program to check whether argv[0] is available.
5153 gdb_simple_compile has_argv0 {
5154 int main (int argc, char **argv) {
5161 proc gdb_has_argv0_1 { exe } {
5162 global srcdir subdir
5163 global gdb_prompt hex
5167 gdb_reinitialize_dir $srcdir/$subdir
5170 # Set breakpoint on main.
5171 gdb_test_multiple "break main" "break main" {
5172 -re "Breakpoint.*${gdb_prompt} $" {
5174 -re "${gdb_prompt} $" {
5181 gdb_test_multiple "" "run to main" {
5182 -re "Breakpoint.*${gdb_prompt} $" {
5184 -re "${gdb_prompt} $" {
5189 set old_elements "200"
5190 set test "show print elements"
5191 gdb_test_multiple $test $test {
5192 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5193 set old_elements $expect_out(1,string)
5196 set old_repeats "200"
5197 set test "show print repeats"
5198 gdb_test_multiple $test $test {
5199 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5200 set old_repeats $expect_out(1,string)
5203 gdb_test_no_output "set print elements unlimited" ""
5204 gdb_test_no_output "set print repeats unlimited" ""
5207 # Check whether argc is 1.
5208 gdb_test_multiple "p argc" "p argc" {
5209 -re " = 1\r\n${gdb_prompt} $" {
5211 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5212 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5215 -re "${gdb_prompt} $" {
5219 -re "${gdb_prompt} $" {
5223 gdb_test_no_output "set print elements $old_elements" ""
5224 gdb_test_no_output "set print repeats $old_repeats" ""
5229 set result [gdb_has_argv0_1 $obj]
5235 && ([istarget *-*-linux*]
5236 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5237 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5238 || [istarget *-*-openbsd*]
5239 || [istarget *-*-darwin*]
5240 || [istarget *-*-solaris*]
5241 || [istarget *-*-aix*]
5242 || [istarget *-*-gnu*]
5243 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5244 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5245 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5246 || [istarget *-*-symbianelf*]
5247 || [istarget *-*-osf*]
5248 || [istarget *-*-dicos*]
5249 || [istarget *-*-nto*]
5250 || [istarget *-*-*vms*]
5251 || [istarget *-*-lynx*178]) } {
5252 fail "argv\[0\] should be available on this target"
5258 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5259 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5260 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5261 # the name of a debuginfo only file. This file will be stored in the same
5264 # Functions for separate debug info testing
5266 # starting with an executable:
5267 # foo --> original executable
5269 # at the end of the process we have:
5270 # foo.stripped --> foo w/o debug info
5271 # foo.debug --> foo's debug info
5272 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5274 # Fetch the build id from the file.
5275 # Returns "" if there is none.
5277 proc get_build_id { filename } {
5278 if { ([istarget "*-*-mingw*"]
5279 || [istarget *-*-cygwin*]) } {
5280 set objdump_program [gdb_find_objdump]
5281 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5282 verbose "result is $result"
5283 verbose "output is $output"
5289 set tmp [standard_output_file "${filename}-tmp"]
5290 set objcopy_program [gdb_find_objcopy]
5291 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5292 verbose "result is $result"
5293 verbose "output is $output"
5298 fconfigure $fi -translation binary
5299 # Skip the NOTE header.
5304 if ![string compare $data ""] then {
5307 # Convert it to hex.
5308 binary scan $data H* data
5313 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5314 # converted to the form: .build-id/ab/cdef1234...89.debug
5315 # Return "" if no build-id found.
5316 proc build_id_debug_filename_get { filename } {
5317 set data [get_build_id $filename]
5318 if { $data == "" } {
5321 regsub {^..} $data {\0/} data
5322 return ".build-id/${data}.debug"
5325 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5326 # list of optional flags. The only currently supported flag is no-main,
5327 # which removes the symbol entry for main from the separate debug file.
5329 # Function returns zero on success. Function will return non-zero failure code
5330 # on some targets not supporting separate debug info (such as i386-msdos).
5332 proc gdb_gnu_strip_debug { dest args } {
5334 # Use the first separate debug info file location searched by GDB so the
5335 # run cannot be broken by some stale file searched with higher precedence.
5336 set debug_file "${dest}.debug"
5338 set strip_to_file_program [transform strip]
5339 set objcopy_program [gdb_find_objcopy]
5341 set debug_link [file tail $debug_file]
5342 set stripped_file "${dest}.stripped"
5344 # Get rid of the debug info, and store result in stripped_file
5345 # something like gdb/testsuite/gdb.base/blah.stripped.
5346 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5347 verbose "result is $result"
5348 verbose "output is $output"
5353 # Workaround PR binutils/10802:
5354 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5355 set perm [file attributes ${dest} -permissions]
5356 file attributes ${stripped_file} -permissions $perm
5358 # Get rid of everything but the debug info, and store result in debug_file
5359 # This will be in the .debug subdirectory, see above.
5360 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5361 verbose "result is $result"
5362 verbose "output is $output"
5367 # If no-main is passed, strip the symbol for main from the separate
5368 # file. This is to simulate the behavior of elfutils's eu-strip, which
5369 # leaves the symtab in the original file only. There's no way to get
5370 # objcopy or strip to remove the symbol table without also removing the
5371 # debugging sections, so this is as close as we can get.
5372 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5373 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5374 verbose "result is $result"
5375 verbose "output is $output"
5379 file delete "${debug_file}"
5380 file rename "${debug_file}-tmp" "${debug_file}"
5383 # Link the two previous output files together, adding the .gnu_debuglink
5384 # section to the stripped_file, containing a pointer to the debug_file,
5385 # save the new file in dest.
5386 # This will be the regular executable filename, in the usual location.
5387 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5388 verbose "result is $result"
5389 verbose "output is $output"
5394 # Workaround PR binutils/10802:
5395 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5396 set perm [file attributes ${stripped_file} -permissions]
5397 file attributes ${dest} -permissions $perm
5402 # Test the output of GDB_COMMAND matches the pattern obtained
5403 # by concatenating all elements of EXPECTED_LINES. This makes
5404 # it possible to split otherwise very long string into pieces.
5405 # If third argument is not empty, it's used as the name of the
5406 # test to be printed on pass/fail.
5407 proc help_test_raw { gdb_command expected_lines args } {
5408 set message $gdb_command
5409 if [llength $args]>0 then {
5410 set message [lindex $args 0]
5412 set expected_output [join $expected_lines ""]
5413 gdb_test "${gdb_command}" "${expected_output}" $message
5416 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5417 # are regular expressions that should match the beginning of output,
5418 # before the list of commands in that class. The presence of
5419 # command list and standard epilogue will be tested automatically.
5420 # Notice that the '[' and ']' characters don't need to be escaped for strings
5421 # wrapped in {} braces.
5422 proc test_class_help { command_class expected_initial_lines args } {
5424 "List of commands\:.*[\r\n]+"
5425 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5426 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5427 "Command name abbreviations are allowed if unambiguous\."
5429 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5431 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5434 # COMMAND_LIST should have either one element -- command to test, or
5435 # two elements -- abbreviated command to test, and full command the first
5436 # element is abbreviation of.
5437 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5438 # are regular expressions that should match the beginning of output,
5439 # before the list of subcommands. The presence of
5440 # subcommand list and standard epilogue will be tested automatically.
5441 proc test_prefix_command_help { command_list expected_initial_lines args } {
5442 set command [lindex $command_list 0]
5443 if {[llength $command_list]>1} {
5444 set full_command [lindex $command_list 1]
5446 set full_command $command
5448 # Use 'list' and not just {} because we want variables to
5449 # be expanded in this list.
5450 set l_stock_body [list\
5451 "List of $full_command subcommands\:.*\[\r\n\]+"\
5452 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5453 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5454 "Command name abbreviations are allowed if unambiguous\."]
5455 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5456 if {[llength $args]>0} {
5457 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5459 help_test_raw "help ${command}" $l_entire_body
5463 # Build executable named EXECUTABLE from specifications that allow
5464 # different options to be passed to different sub-compilations.
5465 # TESTNAME is the name of the test; this is passed to 'untested' if
5467 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5468 # contains the option "pthreads", then gdb_compile_pthreads is used.
5469 # ARGS is a flat list of source specifications, of the form:
5470 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5471 # Each SOURCE is compiled to an object file using its OPTIONS,
5472 # using gdb_compile.
5473 # Returns 0 on success, -1 on failure.
5474 proc build_executable_from_specs {testname executable options args} {
5478 set binfile [standard_output_file $executable]
5481 if { [lsearch -exact $options "c++"] >= 0 } {
5482 set info_options "c++"
5484 if [get_compiler_info ${info_options}] {
5488 set func gdb_compile
5489 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5490 if {$func_index != -1} {
5491 set func "${func}_[lindex $options $func_index]"
5494 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5495 # parameter. They also requires $sources while gdb_compile and
5496 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5497 if [string match gdb_compile_shlib* $func] {
5499 foreach {s local_options} $args {
5500 if { [regexp "^/" "$s"] } then {
5501 lappend sources_path "$s"
5503 lappend sources_path "$srcdir/$subdir/$s"
5506 set ret [$func $sources_path "${binfile}" $options]
5507 } elseif {[lsearch -exact $options rust] != -1} {
5509 foreach {s local_options} $args {
5510 if { [regexp "^/" "$s"] } then {
5511 lappend sources_path "$s"
5513 lappend sources_path "$srcdir/$subdir/$s"
5516 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5520 foreach {s local_options} $args {
5521 if { ! [regexp "^/" "$s"] } then {
5522 set s "$srcdir/$subdir/$s"
5524 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5528 lappend objects "${binfile}${i}.o"
5531 set ret [$func $objects "${binfile}" executable $options]
5541 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5542 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5543 # to pass to untested, if something is wrong. OPTIONS are passed
5544 # to gdb_compile directly.
5545 proc build_executable { testname executable {sources ""} {options {debug}} } {
5546 if {[llength $sources]==0} {
5547 set sources ${executable}.c
5550 set arglist [list $testname $executable $options]
5551 foreach source $sources {
5552 lappend arglist $source $options
5555 return [eval build_executable_from_specs $arglist]
5558 # Starts fresh GDB binary and loads an optional executable into GDB.
5559 # Usage: clean_restart [executable]
5560 # EXECUTABLE is the basename of the binary.
5562 proc clean_restart { args } {
5566 if { [llength $args] > 1 } {
5567 error "bad number of args: [llength $args]"
5572 gdb_reinitialize_dir $srcdir/$subdir
5574 if { [llength $args] >= 1 } {
5575 set executable [lindex $args 0]
5576 set binfile [standard_output_file ${executable}]
5581 # Prepares for testing by calling build_executable_full, then
5583 # TESTNAME is the name of the test.
5584 # Each element in ARGS is a list of the form
5585 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5586 # These are passed to build_executable_from_specs, which see.
5587 # The last EXECUTABLE is passed to clean_restart.
5588 # Returns 0 on success, non-zero on failure.
5589 proc prepare_for_testing_full {testname args} {
5590 foreach spec $args {
5591 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5594 set executable [lindex $spec 0]
5596 clean_restart $executable
5600 # Prepares for testing, by calling build_executable, and then clean_restart.
5601 # Please refer to build_executable for parameter description.
5602 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5604 if {[build_executable $testname $executable $sources $options] == -1} {
5607 clean_restart $executable
5612 # Retrieve the value of EXP in the inferior, represented in format
5613 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5614 # print fails. TEST is the test message to use. It can be omitted,
5615 # in which case a test message is built from EXP.
5617 proc get_valueof { fmt exp default {test ""} } {
5621 set test "get valueof \"${exp}\""
5625 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5626 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5627 set val $expect_out(1,string)
5631 fail "$test (timeout)"
5637 # Retrieve the value of EXP in the inferior, as a signed decimal value
5638 # (using "print /d"). DEFAULT is used as fallback if print fails.
5639 # TEST is the test message to use. It can be omitted, in which case
5640 # a test message is built from EXP.
5642 proc get_integer_valueof { exp default {test ""} } {
5646 set test "get integer valueof \"${exp}\""
5650 gdb_test_multiple "print /d ${exp}" "$test" {
5651 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5652 set val $expect_out(1,string)
5656 fail "$test (timeout)"
5662 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5663 # (using "print /x"). DEFAULT is used as fallback if print fails.
5664 # TEST is the test message to use. It can be omitted, in which case
5665 # a test message is built from EXP.
5667 proc get_hexadecimal_valueof { exp default {test ""} } {
5671 set test "get hexadecimal valueof \"${exp}\""
5675 gdb_test_multiple "print /x ${exp}" $test {
5676 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5677 set val $expect_out(1,string)
5684 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5685 # is used as fallback if print fails. TEST is the test message to use.
5686 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5688 proc get_sizeof { type default {test ""} } {
5689 return [get_integer_valueof "sizeof (${type})" $default $test]
5692 proc get_target_charset { } {
5695 gdb_test_multiple "show target-charset" "" {
5696 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5697 return $expect_out(1,string)
5699 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5700 return $expect_out(1,string)
5704 # Pick a reasonable default.
5705 warning "Unable to read target-charset."
5709 # Get the address of VAR.
5711 proc get_var_address { var } {
5712 global gdb_prompt hex
5714 # Match output like:
5716 # $5 = (int (*)()) 0
5717 # $6 = (int (*)()) 0x24 <function_bar>
5719 gdb_test_multiple "print &${var}" "get address of ${var}" {
5720 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5722 pass "get address of ${var}"
5723 if { $expect_out(1,string) == "0" } {
5726 return $expect_out(1,string)
5733 # Return the frame number for the currently selected frame
5734 proc get_current_frame_number {{test_name ""}} {
5737 if { $test_name == "" } {
5738 set test_name "get current frame number"
5741 gdb_test_multiple "frame" $test_name {
5742 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5743 set frame_num $expect_out(1,string)
5749 # Get the current value for remotetimeout and return it.
5750 proc get_remotetimeout { } {
5754 gdb_test_multiple "show remotetimeout" "" {
5755 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5756 return $expect_out(1,string)
5760 # Pick the default that gdb uses
5761 warning "Unable to read remotetimeout"
5765 # Set the remotetimeout to the specified timeout. Nothing is returned.
5766 proc set_remotetimeout { timeout } {
5769 gdb_test_multiple "set remotetimeout $timeout" "" {
5770 -re "$gdb_prompt $" {
5771 verbose "Set remotetimeout to $timeout\n"
5776 # Get the target's current endianness and return it.
5777 proc get_endianness { } {
5780 gdb_test_multiple "show endian" "determine endianness" {
5781 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5783 return $expect_out(1,string)
5789 # ROOT and FULL are file names. Returns the relative path from ROOT
5790 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5791 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5794 proc relative_filename {root full} {
5795 set root_split [file split $root]
5796 set full_split [file split $full]
5798 set len [llength $root_split]
5800 if {[eval file join $root_split]
5801 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5802 error "$full not a subdir of $root"
5805 return [eval file join [lrange $full_split $len end]]
5808 # Log gdb command line and script if requested.
5809 if {[info exists TRANSCRIPT]} {
5810 rename send_gdb real_send_gdb
5811 rename remote_spawn real_remote_spawn
5812 rename remote_close real_remote_close
5814 global gdb_transcript
5815 set gdb_transcript ""
5817 global gdb_trans_count
5818 set gdb_trans_count 1
5820 proc remote_spawn {args} {
5821 global gdb_transcript gdb_trans_count outdir
5823 if {$gdb_transcript != ""} {
5824 close $gdb_transcript
5826 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5827 puts $gdb_transcript [lindex $args 1]
5828 incr gdb_trans_count
5830 return [uplevel real_remote_spawn $args]
5833 proc remote_close {args} {
5834 global gdb_transcript
5836 if {$gdb_transcript != ""} {
5837 close $gdb_transcript
5838 set gdb_transcript ""
5841 return [uplevel real_remote_close $args]
5844 proc send_gdb {args} {
5845 global gdb_transcript
5847 if {$gdb_transcript != ""} {
5848 puts -nonewline $gdb_transcript [lindex $args 0]
5851 return [uplevel real_send_gdb $args]
5855 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5856 if {[info exists GDB_PARALLEL]} {
5857 if {[is_remote host]} {
5861 [make_gdb_parallel_path outputs] \
5862 [make_gdb_parallel_path temp] \
5863 [make_gdb_parallel_path cache]
5867 proc core_find {binfile {deletefiles {}} {arg ""}} {
5868 global objdir subdir
5870 set destcore "$binfile.core"
5871 file delete $destcore
5873 # Create a core file named "$destcore" rather than just "core", to
5874 # avoid problems with sys admin types that like to regularly prune all
5875 # files named "core" from the system.
5877 # Arbitrarily try setting the core size limit to "unlimited" since
5878 # this does not hurt on systems where the command does not work and
5879 # allows us to generate a core on systems where it does.
5881 # Some systems append "core" to the name of the program; others append
5882 # the name of the program to "core"; still others (like Linux, as of
5883 # May 2003) create cores named "core.PID". In the latter case, we
5884 # could have many core files lying around, and it may be difficult to
5885 # tell which one is ours, so let's run the program in a subdirectory.
5887 set coredir [standard_output_file coredir.[getpid]]
5889 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5890 # remote_exec host "${binfile}"
5891 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5892 if [remote_file build exists $i] {
5893 remote_exec build "mv $i $destcore"
5897 # Check for "core.PID".
5898 if { $found == 0 } {
5899 set names [glob -nocomplain -directory $coredir core.*]
5900 if {[llength $names] == 1} {
5901 set corefile [file join $coredir [lindex $names 0]]
5902 remote_exec build "mv $corefile $destcore"
5906 if { $found == 0 } {
5907 # The braindamaged HPUX shell quits after the ulimit -c above
5908 # without executing ${binfile}. So we try again without the
5909 # ulimit here if we didn't find a core file above.
5910 # Oh, I should mention that any "braindamaged" non-Unix system has
5911 # the same problem. I like the cd bit too, it's really neat'n stuff.
5912 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5913 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5914 if [remote_file build exists $i] {
5915 remote_exec build "mv $i $destcore"
5921 # Try to clean up after ourselves.
5922 foreach deletefile $deletefiles {
5923 remote_file build delete [file join $coredir $deletefile]
5925 remote_exec build "rmdir $coredir"
5927 if { $found == 0 } {
5928 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5934 # gdb_target_symbol_prefix compiles a test program and then examines
5935 # the output from objdump to determine the prefix (such as underscore)
5936 # for linker symbol prefixes.
5938 gdb_caching_proc gdb_target_symbol_prefix {
5939 # Compile a simple test program...
5940 set src { int main() { return 0; } }
5941 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
5947 set objdump_program [gdb_find_objdump]
5948 set result [catch "exec $objdump_program --syms $obj" output]
5951 && ![regexp -lineanchor \
5952 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5953 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5961 # Return 1 if target supports scheduler locking, otherwise return 0.
5963 gdb_caching_proc target_supports_scheduler_locking {
5966 set me "gdb_target_supports_scheduler_locking"
5968 set src { int main() { return 0; } }
5969 if {![gdb_simple_compile $me $src executable]} {
5976 set supports_schedule_locking -1
5977 set current_schedule_locking_mode ""
5979 set test "reading current scheduler-locking mode"
5980 gdb_test_multiple "show scheduler-locking" $test {
5981 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
5982 set current_schedule_locking_mode $expect_out(1,string)
5984 -re "$gdb_prompt $" {
5985 set supports_schedule_locking 0
5988 set supports_schedule_locking 0
5992 if { $supports_schedule_locking == -1 } {
5993 set test "checking for scheduler-locking support"
5994 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
5995 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
5996 set supports_schedule_locking 0
5998 -re "$gdb_prompt $" {
5999 set supports_schedule_locking 1
6002 set supports_schedule_locking 0
6007 if { $supports_schedule_locking == -1 } {
6008 set supports_schedule_locking 0
6012 remote_file build delete $obj
6013 verbose "$me: returning $supports_schedule_locking" 2
6014 return $supports_schedule_locking
6017 # gdb_target_symbol returns the provided symbol with the correct prefix
6018 # prepended. (See gdb_target_symbol_prefix, above.)
6020 proc gdb_target_symbol { symbol } {
6021 set prefix [gdb_target_symbol_prefix]
6022 return "${prefix}${symbol}"
6025 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6026 # added to gdb_compile options to define the C-preprocessor macro
6027 # SYMBOL_PREFIX with a value that can be prepended to symbols
6028 # for targets which require a prefix, such as underscore.
6030 # This version (_asm) defines the prefix without double quotes
6031 # surrounding the prefix. It is used to define the macro
6032 # SYMBOL_PREFIX for assembly language files. Another version, below,
6033 # is used for symbols in inline assembler in C/C++ files.
6035 # The lack of quotes in this version (_asm) makes it possible to
6036 # define supporting macros in the .S file. (The version which
6037 # uses quotes for the prefix won't work for such files since it's
6038 # impossible to define a quote-stripping macro in C.)
6040 # It's possible to use this version (_asm) for C/C++ source files too,
6041 # but a string is usually required in such files; providing a version
6042 # (no _asm) which encloses the prefix with double quotes makes it
6043 # somewhat easier to define the supporting macros in the test case.
6045 proc gdb_target_symbol_prefix_flags_asm {} {
6046 set prefix [gdb_target_symbol_prefix]
6047 if {$prefix ne ""} {
6048 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6054 # gdb_target_symbol_prefix_flags returns the same string as
6055 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6056 # enclosed in double quotes if there is a prefix.
6058 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6059 # extended discussion.
6061 proc gdb_target_symbol_prefix_flags {} {
6062 set prefix [gdb_target_symbol_prefix]
6063 if {$prefix ne ""} {
6064 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6070 # A wrapper for 'remote_exec host' that passes or fails a test.
6071 # Returns 0 if all went well, nonzero on failure.
6072 # TEST is the name of the test, other arguments are as for remote_exec.
6074 proc run_on_host { test program args } {
6075 verbose -log "run_on_host: $program $args"
6076 # remote_exec doesn't work properly if the output is set but the
6077 # input is the empty string -- so replace an empty input with
6079 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6080 set args [lreplace $args 1 1 "/dev/null"]
6082 set result [eval remote_exec host [list $program] $args]
6083 verbose "result is $result"
6084 set status [lindex $result 0]
6085 set output [lindex $result 1]
6090 verbose -log "run_on_host failed: $output"
6096 # Return non-zero if "board_info debug_flags" mentions Fission.
6097 # http://gcc.gnu.org/wiki/DebugFission
6098 # Fission doesn't support everything yet.
6099 # This supports working around bug 15954.
6101 proc using_fission { } {
6102 set debug_flags [board_info [target_info name] debug_flags]
6103 return [regexp -- "-gsplit-dwarf" $debug_flags]
6106 # Search the caller's ARGS list and set variables according to the list of
6107 # valid options described by ARGSET.
6109 # The first member of each one- or two-element list in ARGSET defines the
6110 # name of a variable that will be added to the caller's scope.
6112 # If only one element is given to describe an option, it the value is
6113 # 0 if the option is not present in (the caller's) ARGS or 1 if
6116 # If two elements are given, the second element is the default value of
6117 # the variable. This is then overwritten if the option exists in ARGS.
6119 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6120 # any optional components.
6123 # proc myproc {foo args} {
6124 # parse_args {{bar} {baz "abc"} {qux}}
6127 # myproc ABC -bar -baz DEF peanut butter
6128 # will define the following variables in myproc:
6129 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6130 # args will be the list {peanut butter}
6132 proc parse_args { argset } {
6135 foreach argument $argset {
6136 if {[llength $argument] == 1} {
6137 # No default specified, so we assume that we should set
6138 # the value to 1 if the arg is present and 0 if it's not.
6139 # It is assumed that no value is given with the argument.
6140 set result [lsearch -exact $args "-$argument"]
6141 if {$result != -1} then {
6142 uplevel 1 [list set $argument 1]
6143 set args [lreplace $args $result $result]
6145 uplevel 1 [list set $argument 0]
6147 } elseif {[llength $argument] == 2} {
6148 # There are two items in the argument. The second is a
6149 # default value to use if the item is not present.
6150 # Otherwise, the variable is set to whatever is provided
6151 # after the item in the args.
6152 set arg [lindex $argument 0]
6153 set result [lsearch -exact $args "-[lindex $arg 0]"]
6154 if {$result != -1} then {
6155 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6156 set args [lreplace $args $result [expr $result+1]]
6158 uplevel 1 [list set $arg [lindex $argument 1]]
6161 error "Badly formatted argument \"$argument\" in argument set"
6165 # The remaining args should be checked to see that they match the
6166 # number of items expected to be passed into the procedure...
6169 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6170 # return that string.
6172 proc capture_command_output { command prefix } {
6176 set output_string ""
6177 gdb_test_multiple "$command" "capture_command_output for $command" {
6178 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6179 set output_string $expect_out(1,string)
6182 return $output_string
6185 # A convenience function that joins all the arguments together, with a
6186 # regexp that matches exactly one end of line in between each argument.
6187 # This function is ideal to write the expected output of a GDB command
6188 # that generates more than a couple of lines, as this allows us to write
6189 # each line as a separate string, which is easier to read by a human
6192 proc multi_line { args } {
6193 return [join $args "\r\n"]
6196 # Similar to the above, but while multi_line is meant to be used to
6197 # match GDB output, this one is meant to be used to build strings to
6198 # send as GDB input.
6200 proc multi_line_input { args } {
6201 return [join $args "\n"]
6204 # Return the version of the DejaGnu framework.
6206 # The return value is a list containing the major, minor and patch version
6207 # numbers. If the version does not contain a minor or patch number, they will
6208 # be set to 0. For example:
6214 proc dejagnu_version { } {
6215 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6216 global frame_version
6218 verbose -log "DejaGnu version: $frame_version"
6219 verbose -log "Expect version: [exp_version]"
6220 verbose -log "Tcl version: [info tclversion]"
6222 set dg_ver [split $frame_version .]
6224 while { [llength $dg_ver] < 3 } {
6231 # Define user-defined command COMMAND using the COMMAND_LIST as the
6232 # command's definition. The terminating "end" is added automatically.
6234 proc gdb_define_cmd {command command_list} {
6237 set input [multi_line_input {*}$command_list "end"]
6238 set test "define $command"
6240 gdb_test_multiple "define $command" $test {
6242 gdb_test_multiple $input $test {
6243 -re "\r\n$gdb_prompt " {
6250 # Always load compatibility stuff.