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.*done.*$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.*done.*$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.*done.*$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.*done.*$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 # A helper that compiles a test case to see if __int128 is supported.
2829 proc gdb_int128_helper {lang} {
2830 return [gdb_can_simple_compile "i128-for-$lang" {
2832 int main() { return 0; }
2836 # Return true if the C compiler understands the __int128 type.
2837 gdb_caching_proc has_int128_c {
2838 return [gdb_int128_helper c]
2841 # Return true if the C++ compiler understands the __int128 type.
2842 gdb_caching_proc has_int128_cxx {
2843 return [gdb_int128_helper c++]
2846 # Return whether we should skip tests for showing inlined functions in
2847 # backtraces. Requires get_compiler_info and get_debug_format.
2849 proc skip_inline_frame_tests {} {
2850 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2851 if { ! [test_debug_format "DWARF 2"] } {
2855 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2856 if { ([test_compiler_info "gcc-2-*"]
2857 || [test_compiler_info "gcc-3-*"]
2858 || [test_compiler_info "gcc-4-0-*"]) } {
2865 # Return whether we should skip tests for showing variables from
2866 # inlined functions. Requires get_compiler_info and get_debug_format.
2868 proc skip_inline_var_tests {} {
2869 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2870 if { ! [test_debug_format "DWARF 2"] } {
2877 # Return a 1 if we should skip tests that require hardware breakpoints
2879 proc skip_hw_breakpoint_tests {} {
2880 # Skip tests if requested by the board (note that no_hardware_watchpoints
2881 # disables both watchpoints and breakpoints)
2882 if { [target_info exists gdb,no_hardware_watchpoints]} {
2886 # These targets support hardware breakpoints natively
2887 if { [istarget "i?86-*-*"]
2888 || [istarget "x86_64-*-*"]
2889 || [istarget "ia64-*-*"]
2890 || [istarget "arm*-*-*"]
2891 || [istarget "aarch64*-*-*"]
2892 || [istarget "s390*-*-*"] } {
2899 # Return a 1 if we should skip tests that require hardware watchpoints
2901 proc skip_hw_watchpoint_tests {} {
2902 # Skip tests if requested by the board
2903 if { [target_info exists gdb,no_hardware_watchpoints]} {
2907 # These targets support hardware watchpoints natively
2908 if { [istarget "i?86-*-*"]
2909 || [istarget "x86_64-*-*"]
2910 || [istarget "ia64-*-*"]
2911 || [istarget "arm*-*-*"]
2912 || [istarget "aarch64*-*-*"]
2913 || [istarget "powerpc*-*-linux*"]
2914 || [istarget "s390*-*-*"] } {
2921 # Return a 1 if we should skip tests that require *multiple* hardware
2922 # watchpoints to be active at the same time
2924 proc skip_hw_watchpoint_multi_tests {} {
2925 if { [skip_hw_watchpoint_tests] } {
2929 # These targets support just a single hardware watchpoint
2930 if { [istarget "arm*-*-*"]
2931 || [istarget "powerpc*-*-linux*"] } {
2938 # Return a 1 if we should skip tests that require read/access watchpoints
2940 proc skip_hw_watchpoint_access_tests {} {
2941 if { [skip_hw_watchpoint_tests] } {
2945 # These targets support just write watchpoints
2946 if { [istarget "s390*-*-*"] } {
2953 # Return 1 if we should skip tests that require the runtime unwinder
2954 # hook. This must be invoked while gdb is running, after shared
2955 # libraries have been loaded. This is needed because otherwise a
2956 # shared libgcc won't be visible.
2958 proc skip_unwinder_tests {} {
2962 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2963 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2965 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2968 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2972 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2973 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2976 -re "\r\n$gdb_prompt $" {
2983 # Return 0 if we should skip tests that require the libstdc++ stap
2984 # probes. This must be invoked while gdb is running, after shared
2985 # libraries have been loaded.
2987 proc skip_libstdcxx_probe_tests {} {
2991 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2992 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2995 -re "\r\n$gdb_prompt $" {
3001 # Return 1 if we should skip tests of the "compile" feature.
3002 # This must be invoked after the inferior has been started.
3004 proc skip_compile_feature_tests {} {
3008 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3009 "Could not load libcc1.*\r\n$gdb_prompt $" {
3012 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3015 -re "\r\n$gdb_prompt $" {
3021 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3022 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3023 # is a regexp that will match the output of "maint print target-stack" if
3024 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3025 # matching the expected prompt after the command output.
3027 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3028 set test "probe for target ${target_name}"
3029 gdb_test_multiple "maint print target-stack" $test {
3030 -re "${target_stack_regexp}${prompt_regexp}" {
3034 -re "$prompt_regexp" {
3041 # Helper for gdb_is_target_remote where the expected prompt is variable.
3043 proc gdb_is_target_remote_prompt { prompt_regexp } {
3044 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3047 # Check whether we're testing with the remote or extended-remote
3050 proc gdb_is_target_remote { } {
3053 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3056 # Check whether we're testing with the native target.
3058 proc gdb_is_target_native { } {
3061 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3064 # Return the effective value of use_gdb_stub.
3066 # If the use_gdb_stub global has been set (it is set when the gdb process is
3067 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3068 # property from the board file.
3070 # This is the preferred way of checking use_gdb_stub, since it allows to check
3071 # the value before the gdb has been spawned and it will return the correct value
3072 # even when it was overriden by the test.
3074 proc use_gdb_stub {} {
3077 if [info exists use_gdb_stub] {
3078 return $use_gdb_stub
3081 return [target_info exists use_gdb_stub]
3084 # Return 1 if the current remote target is an instance of our GDBserver, 0
3085 # otherwise. Return -1 if there was an error and we can't tell.
3087 gdb_caching_proc target_is_gdbserver {
3091 set test "probing for GDBserver"
3093 gdb_test_multiple "monitor help" $test {
3094 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3097 -re "$gdb_prompt $" {
3102 if { $is_gdbserver == -1 } {
3103 verbose -log "Unable to tell whether we are using GDBserver or not."
3106 return $is_gdbserver
3109 # N.B. compiler_info is intended to be local to this file.
3110 # Call test_compiler_info with no arguments to fetch its value.
3111 # Yes, this is counterintuitive when there's get_compiler_info,
3112 # but that's the current API.
3113 if [info exists compiler_info] {
3119 # Figure out what compiler I am using.
3120 # The result is cached so only the first invocation runs the compiler.
3122 # ARG can be empty or "C++". If empty, "C" is assumed.
3124 # There are several ways to do this, with various problems.
3126 # [ gdb_compile -E $ifile -o $binfile.ci ]
3127 # source $binfile.ci
3129 # Single Unix Spec v3 says that "-E -o ..." together are not
3130 # specified. And in fact, the native compiler on hp-ux 11 (among
3131 # others) does not work with "-E -o ...". Most targets used to do
3132 # this, and it mostly worked, because it works with gcc.
3134 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3135 # source $binfile.ci
3137 # This avoids the problem with -E and -o together. This almost works
3138 # if the build machine is the same as the host machine, which is
3139 # usually true of the targets which are not gcc. But this code does
3140 # not figure which compiler to call, and it always ends up using the C
3141 # compiler. Not good for setting hp_aCC_compiler. Target
3142 # hppa*-*-hpux* used to do this.
3144 # [ gdb_compile -E $ifile > $binfile.ci ]
3145 # source $binfile.ci
3147 # dejagnu target_compile says that it supports output redirection,
3148 # but the code is completely different from the normal path and I
3149 # don't want to sweep the mines from that path. So I didn't even try
3152 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3155 # I actually do this for all targets now. gdb_compile runs the right
3156 # compiler, and TCL captures the output, and I eval the output.
3158 # Unfortunately, expect logs the output of the command as it goes by,
3159 # and dejagnu helpfully prints a second copy of it right afterwards.
3160 # So I turn off expect logging for a moment.
3162 # [ gdb_compile $ifile $ciexe_file executable $args ]
3163 # [ remote_exec $ciexe_file ]
3164 # [ source $ci_file.out ]
3166 # I could give up on -E and just do this.
3167 # I didn't get desperate enough to try this.
3169 # -- chastain 2004-01-06
3171 proc get_compiler_info {{arg ""}} {
3172 # For compiler.c and compiler.cc
3175 # I am going to play with the log to keep noise out.
3179 # These come from compiler.c or compiler.cc
3180 global compiler_info
3182 # Legacy global data symbols.
3185 if [info exists compiler_info] {
3190 # Choose which file to preprocess.
3191 set ifile "${srcdir}/lib/compiler.c"
3192 if { $arg == "c++" } {
3193 set ifile "${srcdir}/lib/compiler.cc"
3196 # Run $ifile through the right preprocessor.
3197 # Toggle gdb.log to keep the compiler output out of the log.
3198 set saved_log [log_file -info]
3200 if [is_remote host] {
3201 # We have to use -E and -o together, despite the comments
3202 # above, because of how DejaGnu handles remote host testing.
3203 set ppout "$outdir/compiler.i"
3204 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3205 set file [open $ppout r]
3206 set cppout [read $file]
3209 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3211 eval log_file $saved_log
3215 foreach cppline [ split "$cppout" "\n" ] {
3216 if { [ regexp "^#" "$cppline" ] } {
3218 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3220 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3222 verbose "get_compiler_info: $cppline" 2
3226 verbose -log "get_compiler_info: $cppline"
3231 # Set to unknown if for some reason compiler_info didn't get defined.
3232 if ![info exists compiler_info] {
3233 verbose -log "get_compiler_info: compiler_info not provided"
3234 set compiler_info "unknown"
3236 # Also set to unknown compiler if any diagnostics happened.
3238 verbose -log "get_compiler_info: got unexpected diagnostics"
3239 set compiler_info "unknown"
3242 # Set the legacy symbols.
3244 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3246 # Log what happened.
3247 verbose -log "get_compiler_info: $compiler_info"
3249 # Most compilers will evaluate comparisons and other boolean
3250 # operations to 0 or 1.
3251 uplevel \#0 { set true 1 }
3252 uplevel \#0 { set false 0 }
3257 # Return the compiler_info string if no arg is provided.
3258 # Otherwise the argument is a glob-style expression to match against
3261 proc test_compiler_info { {compiler ""} } {
3262 global compiler_info
3265 # If no arg, return the compiler_info string.
3266 if [string match "" $compiler] {
3267 return $compiler_info
3270 return [string match $compiler $compiler_info]
3273 proc current_target_name { } {
3275 if [info exists target_info(target,name)] {
3276 set answer $target_info(target,name)
3283 set gdb_wrapper_initialized 0
3284 set gdb_wrapper_target ""
3286 proc gdb_wrapper_init { args } {
3287 global gdb_wrapper_initialized
3288 global gdb_wrapper_file
3289 global gdb_wrapper_flags
3290 global gdb_wrapper_target
3292 if { $gdb_wrapper_initialized == 1 } { return; }
3294 if {[target_info exists needs_status_wrapper] && \
3295 [target_info needs_status_wrapper] != "0"} {
3296 set result [build_wrapper "testglue.o"]
3297 if { $result != "" } {
3298 set gdb_wrapper_file [lindex $result 0]
3299 set gdb_wrapper_flags [lindex $result 1]
3301 warning "Status wrapper failed to build."
3304 set gdb_wrapper_initialized 1
3305 set gdb_wrapper_target [current_target_name]
3308 # Determine options that we always want to pass to the compiler.
3309 gdb_caching_proc universal_compile_options {
3310 set me "universal_compile_options"
3313 set src [standard_temp_file ccopts[pid].c]
3314 set obj [standard_temp_file ccopts[pid].o]
3316 gdb_produce_source $src {
3317 int foo(void) { return 0; }
3320 # Try an option for disabling colored diagnostics. Some compilers
3321 # yield colored diagnostics by default (when run from a tty) unless
3322 # such an option is specified.
3323 set opt "additional_flags=-fdiagnostics-color=never"
3324 set lines [target_compile $src $obj object [list "quiet" $opt]]
3325 if [string match "" $lines] then {
3326 # Seems to have worked; use the option.
3327 lappend options $opt
3332 verbose "$me: returning $options" 2
3336 # Compile the code in $code to a file based on $name, using the flags
3337 # $compile_flag as well as debug, nowarning and quiet.
3338 # Return 1 if code can be compiled
3339 # Leave the file name of the resulting object in the upvar object.
3341 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3344 switch -regexp -- $type {
3358 set src [standard_temp_file $name-[pid].c]
3359 set obj [standard_temp_file $name-[pid].$postfix]
3360 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3362 gdb_produce_source $src $code
3364 verbose "$name: compiling testfile $src" 2
3365 set lines [gdb_compile $src $obj $type $compile_flags]
3369 if ![string match "" $lines] then {
3370 verbose "$name: compilation failed, returning 0" 2
3376 # Compile the code in $code to a file based on $name, using the flags
3377 # $compile_flag as well as debug, nowarning and quiet.
3378 # Return 1 if code can be compiled
3379 # Delete all created files and objects.
3381 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3382 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3383 file delete $temp_obj
3387 # Some targets need to always link a special object in. Save its path here.
3388 global gdb_saved_set_unbuffered_mode_obj
3389 set gdb_saved_set_unbuffered_mode_obj ""
3391 # Compile source files specified by SOURCE into a binary of type TYPE at path
3392 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3393 # parameter and most options are passed directly to it.
3395 # The type can be one of the following:
3397 # - object: Compile into an object file.
3398 # - executable: Compile and link into an executable.
3399 # - preprocess: Preprocess the source files.
3400 # - assembly: Generate assembly listing.
3402 # The following options are understood and processed by gdb_compile:
3404 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3405 # quirks to be able to use shared libraries.
3406 # - shlib_load: Link with appropriate libraries to allow the test to
3407 # dynamically load libraries at runtime. For example, on Linux, this adds
3408 # -ldl so that the test can use dlopen.
3409 # - nowarnings: Inhibit all compiler warnings.
3411 # And here are some of the not too obscure options understood by DejaGnu that
3412 # influence the compilation:
3414 # - additional_flags=flag: Add FLAG to the compiler flags.
3415 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3416 # argument can be a file, in which case it's added to the sources, or a
3418 # - ldflags=flag: Add FLAG to the linker flags.
3419 # - incdir=path: Add PATH to the searched include directories.
3420 # - libdir=path: Add PATH to the linker searched directories.
3421 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3422 # - debug: Build with debug information.
3423 # - optimize: Build with optimization.
3425 proc gdb_compile {source dest type options} {
3426 global GDB_TESTCASE_OPTIONS
3427 global gdb_wrapper_file
3428 global gdb_wrapper_flags
3429 global gdb_wrapper_initialized
3432 global gdb_saved_set_unbuffered_mode_obj
3434 set outdir [file dirname $dest]
3436 # Add platform-specific options if a shared library was specified using
3437 # "shlib=librarypath" in OPTIONS.
3439 if {[lsearch -exact $options rust] != -1} {
3440 # -fdiagnostics-color is not a rustcc option.
3442 set new_options [universal_compile_options]
3446 foreach opt $options {
3447 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3448 && $type == "executable"} {
3449 if [test_compiler_info "xlc-*"] {
3450 # IBM xlc compiler doesn't accept shared library named other
3451 # than .so: use "-Wl," to bypass this
3452 lappend source "-Wl,$shlib_name"
3453 } elseif { ([istarget "*-*-mingw*"]
3454 || [istarget *-*-cygwin*]
3455 || [istarget *-*-pe*])} {
3456 lappend source "${shlib_name}.a"
3458 lappend source $shlib_name
3460 if { $shlib_found == 0 } {
3462 if { ([istarget "*-*-mingw*"]
3463 || [istarget *-*-cygwin*]) } {
3464 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3466 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3467 # Undo debian's change in the default.
3468 # Put it at the front to not override any user-provided
3469 # value, and to make sure it appears in front of all the
3471 lappend new_options "early_flags=-Wl,--no-as-needed"
3474 } elseif { $opt == "shlib_load" && $type == "executable" } {
3477 lappend new_options $opt
3481 # Because we link with libraries using their basename, we may need
3482 # (depending on the platform) to set a special rpath value, to allow
3483 # the executable to find the libraries it depends on.
3484 if { $shlib_load || $shlib_found } {
3485 if { ([istarget "*-*-mingw*"]
3486 || [istarget *-*-cygwin*]
3487 || [istarget *-*-pe*]) } {
3488 # Do not need anything.
3489 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3490 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3491 } elseif { [istarget arm*-*-symbianelf*] } {
3492 if { $shlib_load } {
3493 lappend new_options "libs=-ldl"
3496 if { $shlib_load } {
3497 lappend new_options "libs=-ldl"
3499 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3502 set options $new_options
3504 if [info exists GDB_TESTCASE_OPTIONS] {
3505 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3507 verbose "options are $options"
3508 verbose "source is $source $dest $type $options"
3510 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3512 if {[target_info exists needs_status_wrapper] && \
3513 [target_info needs_status_wrapper] != "0" && \
3514 [info exists gdb_wrapper_file]} {
3515 lappend options "libs=${gdb_wrapper_file}"
3516 lappend options "ldflags=${gdb_wrapper_flags}"
3519 # Replace the "nowarnings" option with the appropriate additional_flags
3520 # to disable compiler warnings.
3521 set nowarnings [lsearch -exact $options nowarnings]
3522 if {$nowarnings != -1} {
3523 if [target_info exists gdb,nowarnings_flag] {
3524 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3526 set flag "additional_flags=-w"
3528 set options [lreplace $options $nowarnings $nowarnings $flag]
3531 if { $type == "executable" } {
3532 if { ([istarget "*-*-mingw*"]
3533 || [istarget "*-*-*djgpp"]
3534 || [istarget "*-*-cygwin*"])} {
3535 # Force output to unbuffered mode, by linking in an object file
3536 # with a global contructor that calls setvbuf.
3538 # Compile the special object seperatelly for two reasons:
3539 # 1) Insulate it from $options.
3540 # 2) Avoid compiling it for every gdb_compile invocation,
3541 # which is time consuming, especially if we're remote
3544 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3545 verbose "compiling gdb_saved_set_unbuffered_obj"
3546 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3547 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3549 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3550 if { $result != "" } {
3553 if {[is_remote host]} {
3554 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3556 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3558 # Link a copy of the output object, because the
3559 # original may be automatically deleted.
3560 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3562 verbose "gdb_saved_set_unbuffered_obj already compiled"
3565 # Rely on the internal knowledge that the global ctors are ran in
3566 # reverse link order. In that case, we can use ldflags to
3567 # avoid copying the object file to the host multiple
3569 # This object can only be added if standard libraries are
3570 # used. Thus, we need to disable it if -nostdlib option is used
3571 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3572 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3577 set result [target_compile $source $dest $type $options]
3579 # Prune uninteresting compiler (and linker) output.
3580 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3582 regsub "\[\r\n\]*$" "$result" "" result
3583 regsub "^\[\r\n\]*" "$result" "" result
3585 if {[lsearch $options quiet] < 0} {
3586 # We shall update this on a per language basis, to avoid
3587 # changing the entire testsuite in one go.
3588 if {[lsearch $options f77] >= 0} {
3589 gdb_compile_test $source $result
3590 } elseif { $result != "" } {
3591 clone_output "gdb compile failed, $result"
3598 # This is just like gdb_compile, above, except that it tries compiling
3599 # against several different thread libraries, to see which one this
3601 proc gdb_compile_pthreads {source dest type options} {
3603 set why_msg "unrecognized error"
3604 foreach lib {-lpthreads -lpthread -lthread ""} {
3605 # This kind of wipes out whatever libs the caller may have
3606 # set. Or maybe theirs will override ours. How infelicitous.
3607 set options_with_lib [concat $options [list libs=$lib quiet]]
3608 set ccout [gdb_compile $source $dest $type $options_with_lib]
3609 switch -regexp -- $ccout {
3610 ".*no posix threads support.*" {
3611 set why_msg "missing threads include file"
3614 ".*cannot open -lpthread.*" {
3615 set why_msg "missing runtime threads library"
3617 ".*Can't find library for -lpthread.*" {
3618 set why_msg "missing runtime threads library"
3621 pass "successfully compiled posix threads test case"
3627 if {!$built_binfile} {
3628 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3633 # Build a shared library from SOURCES.
3635 proc gdb_compile_shlib {sources dest options} {
3636 set obj_options $options
3639 if { [lsearch -exact $options "c++"] >= 0 } {
3640 set info_options "c++"
3642 if [get_compiler_info ${info_options}] {
3646 switch -glob [test_compiler_info] {
3648 lappend obj_options "additional_flags=-qpic"
3651 if { !([istarget "*-*-cygwin*"]
3652 || [istarget "*-*-mingw*"]) } {
3653 lappend obj_options "additional_flags=-fpic"
3657 if { !([istarget "powerpc*-*-aix*"]
3658 || [istarget "rs6000*-*-aix*"]
3659 || [istarget "*-*-cygwin*"]
3660 || [istarget "*-*-mingw*"]
3661 || [istarget "*-*-pe*"]) } {
3662 lappend obj_options "additional_flags=-fpic"
3666 lappend obj_options "additional_flags=-fpic"
3669 # don't know what the compiler is...
3673 set outdir [file dirname $dest]
3675 foreach source $sources {
3676 set sourcebase [file tail $source]
3677 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3680 lappend objects ${outdir}/${sourcebase}.o
3683 set link_options $options
3684 if [test_compiler_info "xlc-*"] {
3685 lappend link_options "additional_flags=-qmkshrobj"
3687 lappend link_options "additional_flags=-shared"
3689 if { ([istarget "*-*-mingw*"]
3690 || [istarget *-*-cygwin*]
3691 || [istarget *-*-pe*]) } {
3692 if { [is_remote host] } {
3693 set name [file tail ${dest}]
3697 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3699 # Set the soname of the library. This causes the linker on ELF
3700 # systems to create the DT_NEEDED entry in the executable referring
3701 # to the soname of the library, and not its absolute path. This
3702 # (using the absolute path) would be problem when testing on a
3705 # In conjunction with setting the soname, we add the special
3706 # rpath=$ORIGIN value when building the executable, so that it's
3707 # able to find the library in its own directory.
3708 set destbase [file tail $dest]
3709 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3712 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3715 if { [is_remote host]
3716 && ([istarget "*-*-mingw*"]
3717 || [istarget *-*-cygwin*]
3718 || [istarget *-*-pe*]) } {
3719 set dest_tail_name [file tail ${dest}]
3720 remote_upload host $dest_tail_name.a ${dest}.a
3721 remote_file host delete $dest_tail_name.a
3727 # This is just like gdb_compile_shlib, above, except that it tries compiling
3728 # against several different thread libraries, to see which one this
3730 proc gdb_compile_shlib_pthreads {sources dest options} {
3732 set why_msg "unrecognized error"
3733 foreach lib {-lpthreads -lpthread -lthread ""} {
3734 # This kind of wipes out whatever libs the caller may have
3735 # set. Or maybe theirs will override ours. How infelicitous.
3736 set options_with_lib [concat $options [list libs=$lib quiet]]
3737 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3738 switch -regexp -- $ccout {
3739 ".*no posix threads support.*" {
3740 set why_msg "missing threads include file"
3743 ".*cannot open -lpthread.*" {
3744 set why_msg "missing runtime threads library"
3746 ".*Can't find library for -lpthread.*" {
3747 set why_msg "missing runtime threads library"
3750 pass "successfully compiled posix threads test case"
3756 if {!$built_binfile} {
3757 unsupported "couldn't compile $sources: ${why_msg}"
3762 # This is just like gdb_compile_pthreads, above, except that we always add the
3763 # objc library for compiling Objective-C programs
3764 proc gdb_compile_objc {source dest type options} {
3766 set why_msg "unrecognized error"
3767 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3768 # This kind of wipes out whatever libs the caller may have
3769 # set. Or maybe theirs will override ours. How infelicitous.
3770 if { $lib == "solaris" } {
3771 set lib "-lpthread -lposix4"
3773 if { $lib != "-lobjc" } {
3774 set lib "-lobjc $lib"
3776 set options_with_lib [concat $options [list libs=$lib quiet]]
3777 set ccout [gdb_compile $source $dest $type $options_with_lib]
3778 switch -regexp -- $ccout {
3779 ".*no posix threads support.*" {
3780 set why_msg "missing threads include file"
3783 ".*cannot open -lpthread.*" {
3784 set why_msg "missing runtime threads library"
3786 ".*Can't find library for -lpthread.*" {
3787 set why_msg "missing runtime threads library"
3790 pass "successfully compiled objc with posix threads test case"
3796 if {!$built_binfile} {
3797 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3802 proc send_gdb { string } {
3803 global suppress_flag
3804 if { $suppress_flag } {
3807 return [remote_send host "$string"]
3810 # Send STRING to the inferior's terminal.
3812 proc send_inferior { string } {
3813 global inferior_spawn_id
3815 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3825 proc gdb_expect { args } {
3826 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3827 set atimeout [lindex $args 0]
3828 set expcode [list [lindex $args 1]]
3833 # A timeout argument takes precedence, otherwise of all the timeouts
3834 # select the largest.
3835 if [info exists atimeout] {
3838 set tmt [get_largest_timeout]
3841 global suppress_flag
3842 global remote_suppress_flag
3843 if [info exists remote_suppress_flag] {
3844 set old_val $remote_suppress_flag
3846 if [info exists suppress_flag] {
3847 if { $suppress_flag } {
3848 set remote_suppress_flag 1
3852 {uplevel remote_expect host $tmt $expcode} string]
3853 if [info exists old_val] {
3854 set remote_suppress_flag $old_val
3856 if [info exists remote_suppress_flag] {
3857 unset remote_suppress_flag
3862 global errorInfo errorCode
3864 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3866 return -code $code $string
3870 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3872 # Check for long sequence of output by parts.
3873 # TEST: is the test message to be printed with the test success/fail.
3874 # SENTINEL: Is the terminal pattern indicating that output has finished.
3875 # LIST: is the sequence of outputs to match.
3876 # If the sentinel is recognized early, it is considered an error.
3879 # 1 if the test failed,
3880 # 0 if the test passes,
3881 # -1 if there was an internal error.
3883 proc gdb_expect_list {test sentinel list} {
3885 global suppress_flag
3888 if { $suppress_flag } {
3890 unresolved "${test}"
3892 while { ${index} < [llength ${list}] } {
3893 set pattern [lindex ${list} ${index}]
3894 set index [expr ${index} + 1]
3895 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3896 if { ${index} == [llength ${list}] } {
3899 -re "${pattern}${sentinel}" {
3900 # pass "${test}, pattern ${index} + sentinel"
3903 fail "${test} (pattern ${index} + sentinel)"
3906 -re ".*A problem internal to GDB has been detected" {
3907 fail "${test} (GDB internal error)"
3909 gdb_internal_error_resync
3912 fail "${test} (pattern ${index} + sentinel) (timeout)"
3917 # unresolved "${test}, pattern ${index} + sentinel"
3923 # pass "${test}, pattern ${index}"
3926 fail "${test} (pattern ${index})"
3929 -re ".*A problem internal to GDB has been detected" {
3930 fail "${test} (GDB internal error)"
3932 gdb_internal_error_resync
3935 fail "${test} (pattern ${index}) (timeout)"
3940 # unresolved "${test}, pattern ${index}"
3954 proc gdb_suppress_entire_file { reason } {
3955 global suppress_flag
3958 set suppress_flag -1
3962 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3963 # gdb_expect to fail immediately (until the next call to
3964 # gdb_stop_suppressing_tests).
3966 proc gdb_suppress_tests { args } {
3967 global suppress_flag
3969 return; # fnf - disable pending review of results where
3970 # testsuite ran better without this
3973 if { $suppress_flag == 1 } {
3974 if { [llength $args] > 0 } {
3975 warning "[lindex $args 0]\n"
3977 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3983 # Clear suppress_flag.
3985 proc gdb_stop_suppressing_tests { } {
3986 global suppress_flag
3988 if [info exists suppress_flag] {
3989 if { $suppress_flag > 0 } {
3991 clone_output "Tests restarted.\n"
3998 proc gdb_clear_suppressed { } {
3999 global suppress_flag
4004 # Spawn the gdb process.
4006 # This doesn't expect any output or do any other initialization,
4007 # leaving those to the caller.
4009 # Overridable function -- you can override this function in your
4012 proc gdb_spawn { } {
4016 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4018 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4021 set saved_gdbflags $GDBFLAGS
4023 if {$GDBFLAGS != ""} {
4026 append GDBFLAGS $cmdline_flags
4030 set GDBFLAGS $saved_gdbflags
4035 # Start gdb running, wait for prompt, and disable the pagers.
4037 # Overridable function -- you can override this function in your
4040 proc gdb_start { } {
4045 catch default_gdb_exit
4048 # Return true if we can spawn a program on the target and attach to
4051 proc can_spawn_for_attach { } {
4052 # We use exp_pid to get the inferior's pid, assuming that gives
4053 # back the pid of the program. On remote boards, that would give
4054 # us instead the PID of e.g., the ssh client, etc.
4055 if [is_remote target] then {
4059 # The "attach" command doesn't make sense when the target is
4060 # stub-like, where GDB finds the program already started on
4061 # initial connection.
4062 if {[target_info exists use_gdb_stub]} {
4070 # Kill a progress previously started with spawn_wait_for_attach, and
4071 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4074 proc kill_wait_spawned_process { proc_spawn_id } {
4075 set pid [exp_pid -i $proc_spawn_id]
4077 verbose -log "killing ${pid}"
4078 remote_exec build "kill -9 ${pid}"
4080 verbose -log "closing ${proc_spawn_id}"
4081 catch "close -i $proc_spawn_id"
4082 verbose -log "waiting for ${proc_spawn_id}"
4084 # If somehow GDB ends up still attached to the process here, a
4085 # blocking wait hangs until gdb is killed (or until gdb / the
4086 # ptracer reaps the exit status too, but that won't happen because
4087 # something went wrong.) Passing -nowait makes expect tell Tcl to
4088 # wait for the PID in the background. That's fine because we
4089 # don't care about the exit status. */
4090 wait -nowait -i $proc_spawn_id
4093 # Returns the process id corresponding to the given spawn id.
4095 proc spawn_id_get_pid { spawn_id } {
4096 set testpid [exp_pid -i $spawn_id]
4098 if { [istarget "*-*-cygwin*"] } {
4099 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4100 # might be different due to the way fork/exec works.
4101 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4107 # Start a set of programs running and then wait for a bit, to be sure
4108 # that they can be attached to. Return a list of processes spawn IDs,
4109 # one element for each process spawned. It's a test error to call
4110 # this when [can_spawn_for_attach] is false.
4112 proc spawn_wait_for_attach { executable_list } {
4113 set spawn_id_list {}
4115 if ![can_spawn_for_attach] {
4116 # The caller should have checked can_spawn_for_attach itself
4117 # before getting here.
4118 error "can't spawn for attach with this target/board"
4121 foreach {executable} $executable_list {
4122 # Note we use Expect's spawn, not Tcl's exec, because with
4123 # spawn we control when to wait for/reap the process. That
4124 # allows killing the process by PID without being subject to
4126 lappend spawn_id_list [remote_spawn target $executable]
4131 return $spawn_id_list
4135 # gdb_load_cmd -- load a file into the debugger.
4136 # ARGS - additional args to load command.
4137 # return a -1 if anything goes wrong.
4139 proc gdb_load_cmd { args } {
4142 if [target_info exists gdb_load_timeout] {
4143 set loadtimeout [target_info gdb_load_timeout]
4145 set loadtimeout 1600
4147 send_gdb "load $args\n"
4148 verbose "Timeout is now $loadtimeout seconds" 2
4149 gdb_expect $loadtimeout {
4150 -re "Loading section\[^\r\]*\r\n" {
4153 -re "Start address\[\r\]*\r\n" {
4156 -re "Transfer rate\[\r\]*\r\n" {
4159 -re "Memory access error\[^\r\]*\r\n" {
4160 perror "Failed to load program"
4163 -re "$gdb_prompt $" {
4166 -re "(.*)\r\n$gdb_prompt " {
4167 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4171 perror "Timed out trying to load $args."
4178 # Invoke "gcore". CORE is the name of the core file to write. TEST
4179 # is the name of the test case. This will return 1 if the core file
4180 # was created, 0 otherwise. If this fails to make a core file because
4181 # this configuration of gdb does not support making core files, it
4182 # will call "unsupported", not "fail". However, if this fails to make
4183 # a core file for some other reason, then it will call "fail".
4185 proc gdb_gcore_cmd {core test} {
4189 gdb_test_multiple "gcore $core" $test {
4190 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4194 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4202 # Load core file CORE. TEST is the name of the test case.
4203 # This will record a pass/fail for loading the core file.
4205 # 1 - core file is successfully loaded
4206 # 0 - core file loaded but has a non fatal error
4207 # -1 - core file failed to load
4209 proc gdb_core_cmd { core test } {
4212 gdb_test_multiple "core $core" "$test" {
4213 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4216 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4217 fail "$test (bad file format)"
4220 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4221 fail "$test (file not found)"
4224 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4225 fail "$test (incomplete note section)"
4228 -re "Core was generated by .*\r\n$gdb_prompt $" {
4232 -re ".*$gdb_prompt $" {
4237 fail "$test (timeout)"
4241 fail "unsupported output from 'core' command"
4245 # Return the filename to download to the target and load on the target
4246 # for this shared library. Normally just LIBNAME, unless shared libraries
4247 # for this target have separate link and load images.
4249 proc shlib_target_file { libname } {
4253 # Return the filename GDB will load symbols from when debugging this
4254 # shared library. Normally just LIBNAME, unless shared libraries for
4255 # this target have separate link and load images.
4257 proc shlib_symbol_file { libname } {
4261 # Return the filename to download to the target and load for this
4262 # executable. Normally just BINFILE unless it is renamed to something
4263 # else for this target.
4265 proc exec_target_file { binfile } {
4269 # Return the filename GDB will load symbols from when debugging this
4270 # executable. Normally just BINFILE unless executables for this target
4271 # have separate files for symbols.
4273 proc exec_symbol_file { binfile } {
4277 # Rename the executable file. Normally this is just BINFILE1 being renamed
4278 # to BINFILE2, but some targets require multiple binary files.
4279 proc gdb_rename_execfile { binfile1 binfile2 } {
4280 file rename -force [exec_target_file ${binfile1}] \
4281 [exec_target_file ${binfile2}]
4282 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4283 file rename -force [exec_symbol_file ${binfile1}] \
4284 [exec_symbol_file ${binfile2}]
4288 # "Touch" the executable file to update the date. Normally this is just
4289 # BINFILE, but some targets require multiple files.
4290 proc gdb_touch_execfile { binfile } {
4291 set time [clock seconds]
4292 file mtime [exec_target_file ${binfile}] $time
4293 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4294 file mtime [exec_symbol_file ${binfile}] $time
4298 # Like remote_download but provides a gdb-specific behavior.
4300 # If the destination board is remote, the local file FROMFILE is transferred as
4301 # usual with remote_download to TOFILE on the remote board. The destination
4302 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4305 # If the destination board is local, the destination path TOFILE is passed
4306 # through standard_output_file, and FROMFILE is copied there.
4308 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4311 proc gdb_remote_download {dest fromfile {tofile {}}} {
4312 # If TOFILE is not given, default to the same filename as FROMFILE.
4313 if {[string length $tofile] == 0} {
4314 set tofile [file tail $fromfile]
4317 if {[is_remote $dest]} {
4318 # When the DEST is remote, we simply send the file to DEST.
4321 set destname [remote_download $dest $fromfile $tofile]
4322 lappend cleanfiles $destname
4326 # When the DEST is local, we copy the file to the test directory (where
4327 # the executable is).
4329 # Note that we pass TOFILE through standard_output_file, regardless of
4330 # whether it is absolute or relative, because we don't want the tests
4331 # to be able to write outside their standard output directory.
4333 set tofile [standard_output_file $tofile]
4335 file copy -force $fromfile $tofile
4341 # gdb_load_shlib LIB...
4343 # Copy the listed library to the target.
4345 proc gdb_load_shlib { file } {
4348 if ![info exists gdb_spawn_id] {
4349 perror "gdb_load_shlib: GDB is not running"
4352 set dest [gdb_remote_download target [shlib_target_file $file]]
4354 if {[is_remote target]} {
4355 # If the target is remote, we need to tell gdb where to find the
4358 # We could set this even when not testing remotely, but a user
4359 # generally won't set it unless necessary. In order to make the tests
4360 # more like the real-life scenarios, we don't set it for local testing.
4361 gdb_test "set solib-search-path [file dirname $file]" "" ""
4368 # gdb_load -- load a file into the debugger. Specifying no file
4369 # defaults to the executable currently being debugged.
4370 # The return value is 0 for success, -1 for failure.
4371 # Many files in config/*.exp override this procedure.
4373 proc gdb_load { arg } {
4375 return [gdb_file_cmd $arg]
4380 # gdb_reload -- load a file into the target. Called before "running",
4381 # either the first time or after already starting the program once,
4382 # for remote targets. Most files that override gdb_load should now
4383 # override this instead.
4385 proc gdb_reload { } {
4386 # For the benefit of existing configurations, default to gdb_load.
4387 # Specifying no file defaults to the executable currently being
4389 return [gdb_load ""]
4392 proc gdb_continue { function } {
4395 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4398 proc default_gdb_init { test_file_name } {
4399 global gdb_wrapper_initialized
4400 global gdb_wrapper_target
4401 global gdb_test_file_name
4407 gdb_clear_suppressed
4409 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4411 # Make sure that the wrapper is rebuilt
4412 # with the appropriate multilib option.
4413 if { $gdb_wrapper_target != [current_target_name] } {
4414 set gdb_wrapper_initialized 0
4417 # Unlike most tests, we have a small number of tests that generate
4418 # a very large amount of output. We therefore increase the expect
4419 # buffer size to be able to contain the entire test output. This
4420 # is especially needed by gdb.base/info-macros.exp.
4422 # Also set this value for the currently running GDB.
4423 match_max [match_max -d]
4425 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4426 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4429 if [target_info exists gdb_prompt] {
4430 set gdb_prompt [target_info gdb_prompt]
4432 set gdb_prompt "\\(gdb\\)"
4435 if [info exists use_gdb_stub] {
4440 # Return a path using GDB_PARALLEL.
4441 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4442 # GDB_PARALLEL must be defined, the caller must check.
4444 # The default value for GDB_PARALLEL is, canonically, ".".
4445 # The catch is that tests don't expect an additional "./" in file paths so
4446 # omit any directory for the default case.
4447 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4448 # its special handling.
4450 proc make_gdb_parallel_path { args } {
4451 global GDB_PARALLEL objdir
4452 set joiner [list "file" "join" $objdir]
4453 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4454 lappend joiner $GDB_PARALLEL
4456 set joiner [concat $joiner $args]
4457 return [eval $joiner]
4460 # Turn BASENAME into a full file name in the standard output
4461 # directory. It is ok if BASENAME is the empty string; in this case
4462 # the directory is returned.
4464 proc standard_output_file {basename} {
4465 global objdir subdir gdb_test_file_name
4467 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4469 return [file join $dir $basename]
4472 # Return the name of a file in our standard temporary directory.
4474 proc standard_temp_file {basename} {
4475 # Since a particular runtest invocation is only executing a single test
4476 # file at any given time, we can use the runtest pid to build the
4477 # path of the temp directory.
4478 set dir [make_gdb_parallel_path temp [pid]]
4480 return [file join $dir $basename]
4483 # Set 'testfile', 'srcfile', and 'binfile'.
4485 # ARGS is a list of source file specifications.
4486 # Without any arguments, the .exp file's base name is used to
4487 # compute the source file name. The ".c" extension is added in this case.
4488 # If ARGS is not empty, each entry is a source file specification.
4489 # If the specification starts with a ".", it is treated as a suffix
4490 # to append to the .exp file's base name.
4491 # If the specification is the empty string, it is treated as if it
4493 # Otherwise it is a file name.
4494 # The first file in the list is used to set the 'srcfile' global.
4495 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4497 # Most tests should call this without arguments.
4499 # If a completely different binary file name is needed, then it
4500 # should be handled in the .exp file with a suitable comment.
4502 proc standard_testfile {args} {
4503 global gdb_test_file_name
4505 global gdb_test_file_last_vars
4508 global testfile binfile
4510 set testfile $gdb_test_file_name
4511 set binfile [standard_output_file ${testfile}]
4513 if {[llength $args] == 0} {
4517 # Unset our previous output variables.
4518 # This can help catch hidden bugs.
4519 if {[info exists gdb_test_file_last_vars]} {
4520 foreach varname $gdb_test_file_last_vars {
4522 catch {unset $varname}
4525 # 'executable' is often set by tests.
4526 set gdb_test_file_last_vars {executable}
4530 set varname srcfile$suffix
4533 # Handle an extension.
4536 } elseif {[string range $arg 0 0] == "."} {
4537 set arg $testfile$arg
4541 lappend gdb_test_file_last_vars $varname
4543 if {$suffix == ""} {
4551 # The default timeout used when testing GDB commands. We want to use
4552 # the same timeout as the default dejagnu timeout, unless the user has
4553 # already provided a specific value (probably through a site.exp file).
4554 global gdb_test_timeout
4555 if ![info exists gdb_test_timeout] {
4556 set gdb_test_timeout $timeout
4559 # A list of global variables that GDB testcases should not use.
4560 # We try to prevent their use by monitoring write accesses and raising
4561 # an error when that happens.
4562 set banned_variables { bug_id prms_id }
4564 # A list of procedures that GDB testcases should not use.
4565 # We try to prevent their use by monitoring invocations and raising
4566 # an error when that happens.
4567 set banned_procedures { strace }
4569 # gdb_init is called by runtest at start, but also by several
4570 # tests directly; gdb_finish is only called from within runtest after
4571 # each test source execution.
4572 # Placing several traces by repetitive calls to gdb_init leads
4573 # to problems, as only one trace is removed in gdb_finish.
4574 # To overcome this possible problem, we add a variable that records
4575 # if the banned variables and procedures are already traced.
4578 proc gdb_init { test_file_name } {
4579 # Reset the timeout value to the default. This way, any testcase
4580 # that changes the timeout value without resetting it cannot affect
4581 # the timeout used in subsequent testcases.
4582 global gdb_test_timeout
4584 set timeout $gdb_test_timeout
4586 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4587 && [target_info exists gdb_reverse_timeout] } {
4588 set timeout [target_info gdb_reverse_timeout]
4591 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4592 # debugging tool to help confirm that the test suite is
4593 # parallel-safe. You need "inotifywait" from the
4594 # inotify-tools package to use this.
4595 global GDB_INOTIFY inotify_pid
4596 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4597 global outdir tool inotify_log_file
4599 set exclusions {outputs temp gdb[.](log|sum) cache}
4600 set exclusion_re ([join $exclusions |])
4602 set inotify_log_file [standard_temp_file inotify.out]
4603 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4604 --exclude $exclusion_re \
4605 |& tee -a $outdir/$tool.log $inotify_log_file &]
4607 # Wait for the watches; hopefully this is long enough.
4610 # Clear the log so that we don't emit a warning the first time
4612 set fd [open $inotify_log_file w]
4616 # Block writes to all banned variables, and invocation of all
4617 # banned procedures...
4618 global banned_variables
4619 global banned_procedures
4620 global banned_traced
4621 if (!$banned_traced) {
4622 foreach banned_var $banned_variables {
4623 global "$banned_var"
4624 trace add variable "$banned_var" write error
4626 foreach banned_proc $banned_procedures {
4627 global "$banned_proc"
4628 trace add execution "$banned_proc" enter error
4633 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4634 # messages as expected.
4639 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4640 # the test results. Even if /dev/null doesn't exist on the particular
4641 # platform, the readline library will use the default setting just by
4642 # failing to open the file. OTOH, opening /dev/null successfully will
4643 # also result in the default settings being used since nothing will be
4644 # read from this file.
4645 setenv INPUTRC "/dev/null"
4647 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4648 # bindings, so make sure that an appropriate terminal is selected.
4649 # The same bug doesn't show up if we use ^P / ^N instead.
4652 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4653 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4654 # especially having color output turned on can cause tests to fail.
4655 setenv GREP_OPTIONS ""
4657 # Clear $gdbserver_reconnect_p.
4658 global gdbserver_reconnect_p
4659 set gdbserver_reconnect_p 1
4660 unset gdbserver_reconnect_p
4662 return [default_gdb_init $test_file_name]
4665 proc gdb_finish { } {
4666 global gdbserver_reconnect_p
4670 # Exit first, so that the files are no longer in use.
4673 if { [llength $cleanfiles] > 0 } {
4674 eval remote_file target delete $cleanfiles
4678 # Unblock write access to the banned variables. Dejagnu typically
4679 # resets some of them between testcases.
4680 global banned_variables
4681 global banned_procedures
4682 global banned_traced
4683 if ($banned_traced) {
4684 foreach banned_var $banned_variables {
4685 global "$banned_var"
4686 trace remove variable "$banned_var" write error
4688 foreach banned_proc $banned_procedures {
4689 global "$banned_proc"
4690 trace remove execution "$banned_proc" enter error
4697 set debug_format "unknown"
4699 # Run the gdb command "info source" and extract the debugging format
4700 # information from the output and save it in debug_format.
4702 proc get_debug_format { } {
4708 set debug_format "unknown"
4709 send_gdb "info source\n"
4711 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4712 set debug_format $expect_out(1,string)
4713 verbose "debug format is $debug_format"
4716 -re "No current source file.\r\n$gdb_prompt $" {
4717 perror "get_debug_format used when no current source file"
4720 -re "$gdb_prompt $" {
4721 warning "couldn't check debug format (no valid response)."
4725 warning "couldn't check debug format (timeout)."
4731 # Return true if FORMAT matches the debug format the current test was
4732 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4733 # `*', `[...]', and so on.
4735 # This function depends on variables set by `get_debug_format', above.
4737 proc test_debug_format {format} {
4740 return [expr [string match $format $debug_format] != 0]
4743 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4744 # COFF, stabs, etc). If that format matches the format that the
4745 # current test was compiled with, then the next test is expected to
4746 # fail for any target. Returns 1 if the next test or set of tests is
4747 # expected to fail, 0 otherwise (or if it is unknown). Must have
4748 # previously called get_debug_format.
4749 proc setup_xfail_format { format } {
4750 set ret [test_debug_format $format]
4758 # gdb_get_line_number TEXT [FILE]
4760 # Search the source file FILE, and return the line number of the
4761 # first line containing TEXT. If no match is found, an error is thrown.
4763 # TEXT is a string literal, not a regular expression.
4765 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4766 # specified, and does not start with "/", then it is assumed to be in
4767 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4768 # by changing the callers and the interface at the same time.
4769 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4770 # gdb.base/ena-dis-br.exp.
4772 # Use this function to keep your test scripts independent of the
4773 # exact line numbering of the source file. Don't write:
4775 # send_gdb "break 20"
4777 # This means that if anyone ever edits your test's source file,
4778 # your test could break. Instead, put a comment like this on the
4779 # source file line you want to break at:
4781 # /* breakpoint spot: frotz.exp: test name */
4783 # and then write, in your test script (which we assume is named
4786 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4788 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4791 # % puts "foo [lindex "bar baz" 1]"
4794 # Tcl is quite clever, for a little stringy language.)
4798 # The previous implementation of this procedure used the gdb search command.
4799 # This version is different:
4801 # . It works with MI, and it also works when gdb is not running.
4803 # . It operates on the build machine, not the host machine.
4805 # . For now, this implementation fakes a current directory of
4806 # $srcdir/$subdir to be compatible with the old implementation.
4807 # This will go away eventually and some callers will need to
4810 # . The TEXT argument is literal text and matches literally,
4811 # not a regular expression as it was before.
4813 # . State changes in gdb, such as changing the current file
4814 # and setting $_, no longer happen.
4816 # After a bit of time we can forget about the differences from the
4817 # old implementation.
4819 # --chastain 2004-08-05
4821 proc gdb_get_line_number { text { file "" } } {
4826 if { "$file" == "" } then {
4829 if { ! [regexp "^/" "$file"] } then {
4830 set file "$srcdir/$subdir/$file"
4833 if { [ catch { set fd [open "$file"] } message ] } then {
4838 for { set line 1 } { 1 } { incr line } {
4839 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4842 if { $nchar < 0 } then {
4845 if { [string first "$text" "$body"] >= 0 } then {
4851 if { [ catch { close "$fd" } message ] } then {
4856 error "undefined tag \"$text\""
4862 # Continue the program until it ends.
4864 # MSSG is the error message that gets printed. If not given, a
4866 # COMMAND is the command to invoke. If not given, "continue" is
4868 # ALLOW_EXTRA is a flag indicating whether the test should expect
4869 # extra output between the "Continuing." line and the program
4870 # exiting. By default it is zero; if nonzero, any extra output
4873 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4874 global inferior_exited_re use_gdb_stub
4877 set text "continue until exit"
4879 set text "continue until exit at $mssg"
4887 # By default, we don't rely on exit() behavior of remote stubs --
4888 # it's common for exit() to be implemented as a simple infinite
4889 # loop, or a forced crash/reset. For native targets, by default, we
4890 # assume process exit is reported as such. If a non-reliable target
4891 # is used, we set a breakpoint at exit, and continue to that.
4892 if { [target_info exists exit_is_reliable] } {
4893 set exit_is_reliable [target_info exit_is_reliable]
4895 set exit_is_reliable [expr ! $use_gdb_stub]
4898 if { ! $exit_is_reliable } {
4899 if {![gdb_breakpoint "exit"]} {
4902 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4905 # Continue until we exit. Should not stop again.
4906 # Don't bother to check the output of the program, that may be
4907 # extremely tough for some remote systems.
4909 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4914 proc rerun_to_main {} {
4915 global gdb_prompt use_gdb_stub
4920 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4921 {pass "rerun to main" ; return 0}
4922 -re "$gdb_prompt $"\
4923 {fail "rerun to main" ; return 0}
4924 timeout {fail "(timeout) rerun to main" ; return 0}
4929 -re "The program .* has been started already.*y or n. $" {
4933 -re "Starting program.*$gdb_prompt $"\
4934 {pass "rerun to main" ; return 0}
4935 -re "$gdb_prompt $"\
4936 {fail "rerun to main" ; return 0}
4937 timeout {fail "(timeout) rerun to main" ; return 0}
4942 # Return true if a test should be skipped due to lack of floating
4943 # point support or GDB can't fetch the contents from floating point
4946 gdb_caching_proc gdb_skip_float_test {
4947 if [target_info exists gdb,skip_float_tests] {
4951 # There is an ARM kernel ptrace bug that hardware VFP registers
4952 # are not updated after GDB ptrace set VFP registers. The bug
4953 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
4954 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
4955 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
4956 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
4957 # This kernel bug is detected by check how does GDB change the
4958 # program result by changing one VFP register.
4959 if { [istarget "arm*-*-linux*"] } {
4961 set compile_flags {debug nowarnings }
4963 # Set up, compile, and execute a test program having VFP
4965 set src [standard_temp_file arm_vfp[pid].c]
4966 set exe [standard_temp_file arm_vfp[pid].x]
4968 gdb_produce_source $src {
4973 asm ("vldr d0, [%0]" : : "r" (&d));
4974 asm ("vldr d1, [%0]" : : "r" (&d));
4975 asm (".global break_here\n"
4977 asm ("vcmp.f64 d0, d1\n"
4978 "vmrs APSR_nzcv, fpscr\n"
4979 "bne L_value_different\n"
4982 "L_value_different:\n"
4984 "L_end:\n" : "=r" (ret) :);
4986 /* Return $d0 != $d1. */
4991 verbose "compiling testfile $src" 2
4992 set lines [gdb_compile $src $exe executable $compile_flags]
4995 if ![string match "" $lines] then {
4996 verbose "testfile compilation failed, returning 1" 2
5000 # No error message, compilation succeeded so now run it via gdb.
5001 # Run the test up to 5 times to detect whether ptrace can
5002 # correctly update VFP registers or not.
5004 for {set i 0} {$i < 5} {incr i} {
5005 global gdb_prompt srcdir subdir
5009 gdb_reinitialize_dir $srcdir/$subdir
5013 gdb_test "break *break_here"
5014 gdb_continue_to_breakpoint "break_here"
5016 # Modify $d0 to a different value, so the exit code should
5018 gdb_test "set \$d0 = 5.0"
5020 set test "continue to exit"
5021 gdb_test_multiple "continue" "$test" {
5022 -re "exited with code 01.*$gdb_prompt $" {
5024 -re "exited normally.*$gdb_prompt $" {
5025 # However, the exit code is 0. That means something
5026 # wrong in setting VFP registers.
5034 remote_file build delete $exe
5036 return $skip_vfp_test
5041 # Print a message and return true if a test should be skipped
5042 # due to lack of stdio support.
5044 proc gdb_skip_stdio_test { msg } {
5045 if [target_info exists gdb,noinferiorio] {
5046 verbose "Skipping test '$msg': no inferior i/o."
5052 proc gdb_skip_bogus_test { msg } {
5056 # Return true if a test should be skipped due to lack of XML support
5058 # NOTE: This must be called while gdb is *not* running.
5060 gdb_caching_proc gdb_skip_xml_test {
5065 if { [info exists gdb_spawn_id] } {
5066 error "GDB must not be running in gdb_skip_xml_tests."
5069 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5073 gdb_test_multiple "set tdesc filename $xml_file" "" {
5074 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5077 -re ".*$gdb_prompt $" { }
5083 # Return true if argv[0] is available.
5085 gdb_caching_proc gdb_has_argv0 {
5088 # Compile and execute a test program to check whether argv[0] is available.
5089 gdb_simple_compile has_argv0 {
5090 int main (int argc, char **argv) {
5097 proc gdb_has_argv0_1 { exe } {
5098 global srcdir subdir
5099 global gdb_prompt hex
5103 gdb_reinitialize_dir $srcdir/$subdir
5106 # Set breakpoint on main.
5107 gdb_test_multiple "break main" "break main" {
5108 -re "Breakpoint.*${gdb_prompt} $" {
5110 -re "${gdb_prompt} $" {
5117 gdb_test_multiple "" "run to main" {
5118 -re "Breakpoint.*${gdb_prompt} $" {
5120 -re "${gdb_prompt} $" {
5125 set old_elements "200"
5126 set test "show print elements"
5127 gdb_test_multiple $test $test {
5128 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5129 set old_elements $expect_out(1,string)
5132 set old_repeats "200"
5133 set test "show print repeats"
5134 gdb_test_multiple $test $test {
5135 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5136 set old_repeats $expect_out(1,string)
5139 gdb_test_no_output "set print elements unlimited" ""
5140 gdb_test_no_output "set print repeats unlimited" ""
5143 # Check whether argc is 1.
5144 gdb_test_multiple "p argc" "p argc" {
5145 -re " = 1\r\n${gdb_prompt} $" {
5147 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5148 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5151 -re "${gdb_prompt} $" {
5155 -re "${gdb_prompt} $" {
5159 gdb_test_no_output "set print elements $old_elements" ""
5160 gdb_test_no_output "set print repeats $old_repeats" ""
5165 set result [gdb_has_argv0_1 $obj]
5171 && ([istarget *-*-linux*]
5172 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5173 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5174 || [istarget *-*-openbsd*]
5175 || [istarget *-*-darwin*]
5176 || [istarget *-*-solaris*]
5177 || [istarget *-*-aix*]
5178 || [istarget *-*-gnu*]
5179 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5180 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5181 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5182 || [istarget *-*-symbianelf*]
5183 || [istarget *-*-osf*]
5184 || [istarget *-*-dicos*]
5185 || [istarget *-*-nto*]
5186 || [istarget *-*-*vms*]
5187 || [istarget *-*-lynx*178]) } {
5188 fail "argv\[0\] should be available on this target"
5194 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5195 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5196 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5197 # the name of a debuginfo only file. This file will be stored in the same
5200 # Functions for separate debug info testing
5202 # starting with an executable:
5203 # foo --> original executable
5205 # at the end of the process we have:
5206 # foo.stripped --> foo w/o debug info
5207 # foo.debug --> foo's debug info
5208 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5210 # Fetch the build id from the file.
5211 # Returns "" if there is none.
5213 proc get_build_id { filename } {
5214 if { ([istarget "*-*-mingw*"]
5215 || [istarget *-*-cygwin*]) } {
5216 set objdump_program [gdb_find_objdump]
5217 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5218 verbose "result is $result"
5219 verbose "output is $output"
5225 set tmp [standard_output_file "${filename}-tmp"]
5226 set objcopy_program [gdb_find_objcopy]
5227 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5228 verbose "result is $result"
5229 verbose "output is $output"
5234 fconfigure $fi -translation binary
5235 # Skip the NOTE header.
5240 if ![string compare $data ""] then {
5243 # Convert it to hex.
5244 binary scan $data H* data
5249 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5250 # converted to the form: .build-id/ab/cdef1234...89.debug
5251 # Return "" if no build-id found.
5252 proc build_id_debug_filename_get { filename } {
5253 set data [get_build_id $filename]
5254 if { $data == "" } {
5257 regsub {^..} $data {\0/} data
5258 return ".build-id/${data}.debug"
5261 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5262 # list of optional flags. The only currently supported flag is no-main,
5263 # which removes the symbol entry for main from the separate debug file.
5265 # Function returns zero on success. Function will return non-zero failure code
5266 # on some targets not supporting separate debug info (such as i386-msdos).
5268 proc gdb_gnu_strip_debug { dest args } {
5270 # Use the first separate debug info file location searched by GDB so the
5271 # run cannot be broken by some stale file searched with higher precedence.
5272 set debug_file "${dest}.debug"
5274 set strip_to_file_program [transform strip]
5275 set objcopy_program [gdb_find_objcopy]
5277 set debug_link [file tail $debug_file]
5278 set stripped_file "${dest}.stripped"
5280 # Get rid of the debug info, and store result in stripped_file
5281 # something like gdb/testsuite/gdb.base/blah.stripped.
5282 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5283 verbose "result is $result"
5284 verbose "output is $output"
5289 # Workaround PR binutils/10802:
5290 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5291 set perm [file attributes ${dest} -permissions]
5292 file attributes ${stripped_file} -permissions $perm
5294 # Get rid of everything but the debug info, and store result in debug_file
5295 # This will be in the .debug subdirectory, see above.
5296 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5297 verbose "result is $result"
5298 verbose "output is $output"
5303 # If no-main is passed, strip the symbol for main from the separate
5304 # file. This is to simulate the behavior of elfutils's eu-strip, which
5305 # leaves the symtab in the original file only. There's no way to get
5306 # objcopy or strip to remove the symbol table without also removing the
5307 # debugging sections, so this is as close as we can get.
5308 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5309 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5310 verbose "result is $result"
5311 verbose "output is $output"
5315 file delete "${debug_file}"
5316 file rename "${debug_file}-tmp" "${debug_file}"
5319 # Link the two previous output files together, adding the .gnu_debuglink
5320 # section to the stripped_file, containing a pointer to the debug_file,
5321 # save the new file in dest.
5322 # This will be the regular executable filename, in the usual location.
5323 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5324 verbose "result is $result"
5325 verbose "output is $output"
5330 # Workaround PR binutils/10802:
5331 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5332 set perm [file attributes ${stripped_file} -permissions]
5333 file attributes ${dest} -permissions $perm
5338 # Test the output of GDB_COMMAND matches the pattern obtained
5339 # by concatenating all elements of EXPECTED_LINES. This makes
5340 # it possible to split otherwise very long string into pieces.
5341 # If third argument is not empty, it's used as the name of the
5342 # test to be printed on pass/fail.
5343 proc help_test_raw { gdb_command expected_lines args } {
5344 set message $gdb_command
5345 if [llength $args]>0 then {
5346 set message [lindex $args 0]
5348 set expected_output [join $expected_lines ""]
5349 gdb_test "${gdb_command}" "${expected_output}" $message
5352 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5353 # are regular expressions that should match the beginning of output,
5354 # before the list of commands in that class. The presence of
5355 # command list and standard epilogue will be tested automatically.
5356 # Notice that the '[' and ']' characters don't need to be escaped for strings
5357 # wrapped in {} braces.
5358 proc test_class_help { command_class expected_initial_lines args } {
5360 "List of commands\:.*[\r\n]+"
5361 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5362 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5363 "Command name abbreviations are allowed if unambiguous\."
5365 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5367 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5370 # COMMAND_LIST should have either one element -- command to test, or
5371 # two elements -- abbreviated command to test, and full command the first
5372 # element is abbreviation of.
5373 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5374 # are regular expressions that should match the beginning of output,
5375 # before the list of subcommands. The presence of
5376 # subcommand list and standard epilogue will be tested automatically.
5377 proc test_prefix_command_help { command_list expected_initial_lines args } {
5378 set command [lindex $command_list 0]
5379 if {[llength $command_list]>1} {
5380 set full_command [lindex $command_list 1]
5382 set full_command $command
5384 # Use 'list' and not just {} because we want variables to
5385 # be expanded in this list.
5386 set l_stock_body [list\
5387 "List of $full_command subcommands\:.*\[\r\n\]+"\
5388 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5389 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5390 "Command name abbreviations are allowed if unambiguous\."]
5391 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5392 if {[llength $args]>0} {
5393 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5395 help_test_raw "help ${command}" $l_entire_body
5399 # Build executable named EXECUTABLE from specifications that allow
5400 # different options to be passed to different sub-compilations.
5401 # TESTNAME is the name of the test; this is passed to 'untested' if
5403 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5404 # contains the option "pthreads", then gdb_compile_pthreads is used.
5405 # ARGS is a flat list of source specifications, of the form:
5406 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5407 # Each SOURCE is compiled to an object file using its OPTIONS,
5408 # using gdb_compile.
5409 # Returns 0 on success, -1 on failure.
5410 proc build_executable_from_specs {testname executable options args} {
5414 set binfile [standard_output_file $executable]
5417 if { [lsearch -exact $options "c++"] >= 0 } {
5418 set info_options "c++"
5420 if [get_compiler_info ${info_options}] {
5424 set func gdb_compile
5425 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5426 if {$func_index != -1} {
5427 set func "${func}_[lindex $options $func_index]"
5430 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5431 # parameter. They also requires $sources while gdb_compile and
5432 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5433 if [string match gdb_compile_shlib* $func] {
5435 foreach {s local_options} $args {
5436 if { [regexp "^/" "$s"] } then {
5437 lappend sources_path "$s"
5439 lappend sources_path "$srcdir/$subdir/$s"
5442 set ret [$func $sources_path "${binfile}" $options]
5443 } elseif {[lsearch -exact $options rust] != -1} {
5445 foreach {s local_options} $args {
5446 if { [regexp "^/" "$s"] } then {
5447 lappend sources_path "$s"
5449 lappend sources_path "$srcdir/$subdir/$s"
5452 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5456 foreach {s local_options} $args {
5457 if { ! [regexp "^/" "$s"] } then {
5458 set s "$srcdir/$subdir/$s"
5460 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5464 lappend objects "${binfile}${i}.o"
5467 set ret [$func $objects "${binfile}" executable $options]
5477 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5478 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5479 # to pass to untested, if something is wrong. OPTIONS are passed
5480 # to gdb_compile directly.
5481 proc build_executable { testname executable {sources ""} {options {debug}} } {
5482 if {[llength $sources]==0} {
5483 set sources ${executable}.c
5486 set arglist [list $testname $executable $options]
5487 foreach source $sources {
5488 lappend arglist $source $options
5491 return [eval build_executable_from_specs $arglist]
5494 # Starts fresh GDB binary and loads an optional executable into GDB.
5495 # Usage: clean_restart [executable]
5496 # EXECUTABLE is the basename of the binary.
5498 proc clean_restart { args } {
5502 if { [llength $args] > 1 } {
5503 error "bad number of args: [llength $args]"
5508 gdb_reinitialize_dir $srcdir/$subdir
5510 if { [llength $args] >= 1 } {
5511 set executable [lindex $args 0]
5512 set binfile [standard_output_file ${executable}]
5517 # Prepares for testing by calling build_executable_full, then
5519 # TESTNAME is the name of the test.
5520 # Each element in ARGS is a list of the form
5521 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5522 # These are passed to build_executable_from_specs, which see.
5523 # The last EXECUTABLE is passed to clean_restart.
5524 # Returns 0 on success, non-zero on failure.
5525 proc prepare_for_testing_full {testname args} {
5526 foreach spec $args {
5527 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5530 set executable [lindex $spec 0]
5532 clean_restart $executable
5536 # Prepares for testing, by calling build_executable, and then clean_restart.
5537 # Please refer to build_executable for parameter description.
5538 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5540 if {[build_executable $testname $executable $sources $options] == -1} {
5543 clean_restart $executable
5548 # Retrieve the value of EXP in the inferior, represented in format
5549 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5550 # print fails. TEST is the test message to use. It can be omitted,
5551 # in which case a test message is built from EXP.
5553 proc get_valueof { fmt exp default {test ""} } {
5557 set test "get valueof \"${exp}\""
5561 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5562 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5563 set val $expect_out(1,string)
5567 fail "$test (timeout)"
5573 # Retrieve the value of EXP in the inferior, as a signed decimal value
5574 # (using "print /d"). DEFAULT is used as fallback if print fails.
5575 # TEST is the test message to use. It can be omitted, in which case
5576 # a test message is built from EXP.
5578 proc get_integer_valueof { exp default {test ""} } {
5582 set test "get integer valueof \"${exp}\""
5586 gdb_test_multiple "print /d ${exp}" "$test" {
5587 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5588 set val $expect_out(1,string)
5592 fail "$test (timeout)"
5598 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5599 # (using "print /x"). DEFAULT is used as fallback if print fails.
5600 # TEST is the test message to use. It can be omitted, in which case
5601 # a test message is built from EXP.
5603 proc get_hexadecimal_valueof { exp default {test ""} } {
5607 set test "get hexadecimal valueof \"${exp}\""
5611 gdb_test_multiple "print /x ${exp}" $test {
5612 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5613 set val $expect_out(1,string)
5620 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5621 # is used as fallback if print fails. TEST is the test message to use.
5622 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5624 proc get_sizeof { type default {test ""} } {
5625 return [get_integer_valueof "sizeof (${type})" $default $test]
5628 proc get_target_charset { } {
5631 gdb_test_multiple "show target-charset" "" {
5632 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5633 return $expect_out(1,string)
5635 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5636 return $expect_out(1,string)
5640 # Pick a reasonable default.
5641 warning "Unable to read target-charset."
5645 # Get the address of VAR.
5647 proc get_var_address { var } {
5648 global gdb_prompt hex
5650 # Match output like:
5652 # $5 = (int (*)()) 0
5653 # $6 = (int (*)()) 0x24 <function_bar>
5655 gdb_test_multiple "print &${var}" "get address of ${var}" {
5656 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5658 pass "get address of ${var}"
5659 if { $expect_out(1,string) == "0" } {
5662 return $expect_out(1,string)
5669 # Return the frame number for the currently selected frame
5670 proc get_current_frame_number {{test_name ""}} {
5673 if { $test_name == "" } {
5674 set test_name "get current frame number"
5677 gdb_test_multiple "frame" $test_name {
5678 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5679 set frame_num $expect_out(1,string)
5685 # Get the current value for remotetimeout and return it.
5686 proc get_remotetimeout { } {
5690 gdb_test_multiple "show remotetimeout" "" {
5691 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5692 return $expect_out(1,string)
5696 # Pick the default that gdb uses
5697 warning "Unable to read remotetimeout"
5701 # Set the remotetimeout to the specified timeout. Nothing is returned.
5702 proc set_remotetimeout { timeout } {
5705 gdb_test_multiple "set remotetimeout $timeout" "" {
5706 -re "$gdb_prompt $" {
5707 verbose "Set remotetimeout to $timeout\n"
5712 # Get the target's current endianness and return it.
5713 proc get_endianness { } {
5716 gdb_test_multiple "show endian" "determine endianness" {
5717 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5719 return $expect_out(1,string)
5725 # ROOT and FULL are file names. Returns the relative path from ROOT
5726 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5727 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5730 proc relative_filename {root full} {
5731 set root_split [file split $root]
5732 set full_split [file split $full]
5734 set len [llength $root_split]
5736 if {[eval file join $root_split]
5737 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5738 error "$full not a subdir of $root"
5741 return [eval file join [lrange $full_split $len end]]
5744 # Log gdb command line and script if requested.
5745 if {[info exists TRANSCRIPT]} {
5746 rename send_gdb real_send_gdb
5747 rename remote_spawn real_remote_spawn
5748 rename remote_close real_remote_close
5750 global gdb_transcript
5751 set gdb_transcript ""
5753 global gdb_trans_count
5754 set gdb_trans_count 1
5756 proc remote_spawn {args} {
5757 global gdb_transcript gdb_trans_count outdir
5759 if {$gdb_transcript != ""} {
5760 close $gdb_transcript
5762 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5763 puts $gdb_transcript [lindex $args 1]
5764 incr gdb_trans_count
5766 return [uplevel real_remote_spawn $args]
5769 proc remote_close {args} {
5770 global gdb_transcript
5772 if {$gdb_transcript != ""} {
5773 close $gdb_transcript
5774 set gdb_transcript ""
5777 return [uplevel real_remote_close $args]
5780 proc send_gdb {args} {
5781 global gdb_transcript
5783 if {$gdb_transcript != ""} {
5784 puts -nonewline $gdb_transcript [lindex $args 0]
5787 return [uplevel real_send_gdb $args]
5791 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5792 if {[info exists GDB_PARALLEL]} {
5793 if {[is_remote host]} {
5797 [make_gdb_parallel_path outputs] \
5798 [make_gdb_parallel_path temp] \
5799 [make_gdb_parallel_path cache]
5803 proc core_find {binfile {deletefiles {}} {arg ""}} {
5804 global objdir subdir
5806 set destcore "$binfile.core"
5807 file delete $destcore
5809 # Create a core file named "$destcore" rather than just "core", to
5810 # avoid problems with sys admin types that like to regularly prune all
5811 # files named "core" from the system.
5813 # Arbitrarily try setting the core size limit to "unlimited" since
5814 # this does not hurt on systems where the command does not work and
5815 # allows us to generate a core on systems where it does.
5817 # Some systems append "core" to the name of the program; others append
5818 # the name of the program to "core"; still others (like Linux, as of
5819 # May 2003) create cores named "core.PID". In the latter case, we
5820 # could have many core files lying around, and it may be difficult to
5821 # tell which one is ours, so let's run the program in a subdirectory.
5823 set coredir [standard_output_file coredir.[getpid]]
5825 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5826 # remote_exec host "${binfile}"
5827 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5828 if [remote_file build exists $i] {
5829 remote_exec build "mv $i $destcore"
5833 # Check for "core.PID".
5834 if { $found == 0 } {
5835 set names [glob -nocomplain -directory $coredir core.*]
5836 if {[llength $names] == 1} {
5837 set corefile [file join $coredir [lindex $names 0]]
5838 remote_exec build "mv $corefile $destcore"
5842 if { $found == 0 } {
5843 # The braindamaged HPUX shell quits after the ulimit -c above
5844 # without executing ${binfile}. So we try again without the
5845 # ulimit here if we didn't find a core file above.
5846 # Oh, I should mention that any "braindamaged" non-Unix system has
5847 # the same problem. I like the cd bit too, it's really neat'n stuff.
5848 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5849 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5850 if [remote_file build exists $i] {
5851 remote_exec build "mv $i $destcore"
5857 # Try to clean up after ourselves.
5858 foreach deletefile $deletefiles {
5859 remote_file build delete [file join $coredir $deletefile]
5861 remote_exec build "rmdir $coredir"
5863 if { $found == 0 } {
5864 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5870 # gdb_target_symbol_prefix compiles a test program and then examines
5871 # the output from objdump to determine the prefix (such as underscore)
5872 # for linker symbol prefixes.
5874 gdb_caching_proc gdb_target_symbol_prefix {
5875 # Compile a simple test program...
5876 set src { int main() { return 0; } }
5877 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
5883 set objdump_program [gdb_find_objdump]
5884 set result [catch "exec $objdump_program --syms $obj" output]
5887 && ![regexp -lineanchor \
5888 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5889 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5897 # Return 1 if target supports scheduler locking, otherwise return 0.
5899 gdb_caching_proc target_supports_scheduler_locking {
5902 set me "gdb_target_supports_scheduler_locking"
5904 set src { int main() { return 0; } }
5905 if {![gdb_simple_compile $me $src executable]} {
5912 set supports_schedule_locking -1
5913 set current_schedule_locking_mode ""
5915 set test "reading current scheduler-locking mode"
5916 gdb_test_multiple "show scheduler-locking" $test {
5917 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
5918 set current_schedule_locking_mode $expect_out(1,string)
5920 -re "$gdb_prompt $" {
5921 set supports_schedule_locking 0
5924 set supports_schedule_locking 0
5928 if { $supports_schedule_locking == -1 } {
5929 set test "checking for scheduler-locking support"
5930 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
5931 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
5932 set supports_schedule_locking 0
5934 -re "$gdb_prompt $" {
5935 set supports_schedule_locking 1
5938 set supports_schedule_locking 0
5943 if { $supports_schedule_locking == -1 } {
5944 set supports_schedule_locking 0
5948 remote_file build delete $obj
5949 verbose "$me: returning $supports_schedule_locking" 2
5950 return $supports_schedule_locking
5953 # gdb_target_symbol returns the provided symbol with the correct prefix
5954 # prepended. (See gdb_target_symbol_prefix, above.)
5956 proc gdb_target_symbol { symbol } {
5957 set prefix [gdb_target_symbol_prefix]
5958 return "${prefix}${symbol}"
5961 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5962 # added to gdb_compile options to define the C-preprocessor macro
5963 # SYMBOL_PREFIX with a value that can be prepended to symbols
5964 # for targets which require a prefix, such as underscore.
5966 # This version (_asm) defines the prefix without double quotes
5967 # surrounding the prefix. It is used to define the macro
5968 # SYMBOL_PREFIX for assembly language files. Another version, below,
5969 # is used for symbols in inline assembler in C/C++ files.
5971 # The lack of quotes in this version (_asm) makes it possible to
5972 # define supporting macros in the .S file. (The version which
5973 # uses quotes for the prefix won't work for such files since it's
5974 # impossible to define a quote-stripping macro in C.)
5976 # It's possible to use this version (_asm) for C/C++ source files too,
5977 # but a string is usually required in such files; providing a version
5978 # (no _asm) which encloses the prefix with double quotes makes it
5979 # somewhat easier to define the supporting macros in the test case.
5981 proc gdb_target_symbol_prefix_flags_asm {} {
5982 set prefix [gdb_target_symbol_prefix]
5983 if {$prefix ne ""} {
5984 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5990 # gdb_target_symbol_prefix_flags returns the same string as
5991 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5992 # enclosed in double quotes if there is a prefix.
5994 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5995 # extended discussion.
5997 proc gdb_target_symbol_prefix_flags {} {
5998 set prefix [gdb_target_symbol_prefix]
5999 if {$prefix ne ""} {
6000 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6006 # A wrapper for 'remote_exec host' that passes or fails a test.
6007 # Returns 0 if all went well, nonzero on failure.
6008 # TEST is the name of the test, other arguments are as for remote_exec.
6010 proc run_on_host { test program args } {
6011 verbose -log "run_on_host: $program $args"
6012 # remote_exec doesn't work properly if the output is set but the
6013 # input is the empty string -- so replace an empty input with
6015 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6016 set args [lreplace $args 1 1 "/dev/null"]
6018 set result [eval remote_exec host [list $program] $args]
6019 verbose "result is $result"
6020 set status [lindex $result 0]
6021 set output [lindex $result 1]
6026 verbose -log "run_on_host failed: $output"
6032 # Return non-zero if "board_info debug_flags" mentions Fission.
6033 # http://gcc.gnu.org/wiki/DebugFission
6034 # Fission doesn't support everything yet.
6035 # This supports working around bug 15954.
6037 proc using_fission { } {
6038 set debug_flags [board_info [target_info name] debug_flags]
6039 return [regexp -- "-gsplit-dwarf" $debug_flags]
6042 # Search the caller's ARGS list and set variables according to the list of
6043 # valid options described by ARGSET.
6045 # The first member of each one- or two-element list in ARGSET defines the
6046 # name of a variable that will be added to the caller's scope.
6048 # If only one element is given to describe an option, it the value is
6049 # 0 if the option is not present in (the caller's) ARGS or 1 if
6052 # If two elements are given, the second element is the default value of
6053 # the variable. This is then overwritten if the option exists in ARGS.
6055 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6056 # any optional components.
6059 # proc myproc {foo args} {
6060 # parse_args {{bar} {baz "abc"} {qux}}
6063 # myproc ABC -bar -baz DEF peanut butter
6064 # will define the following variables in myproc:
6065 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6066 # args will be the list {peanut butter}
6068 proc parse_args { argset } {
6071 foreach argument $argset {
6072 if {[llength $argument] == 1} {
6073 # No default specified, so we assume that we should set
6074 # the value to 1 if the arg is present and 0 if it's not.
6075 # It is assumed that no value is given with the argument.
6076 set result [lsearch -exact $args "-$argument"]
6077 if {$result != -1} then {
6078 uplevel 1 [list set $argument 1]
6079 set args [lreplace $args $result $result]
6081 uplevel 1 [list set $argument 0]
6083 } elseif {[llength $argument] == 2} {
6084 # There are two items in the argument. The second is a
6085 # default value to use if the item is not present.
6086 # Otherwise, the variable is set to whatever is provided
6087 # after the item in the args.
6088 set arg [lindex $argument 0]
6089 set result [lsearch -exact $args "-[lindex $arg 0]"]
6090 if {$result != -1} then {
6091 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6092 set args [lreplace $args $result [expr $result+1]]
6094 uplevel 1 [list set $arg [lindex $argument 1]]
6097 error "Badly formatted argument \"$argument\" in argument set"
6101 # The remaining args should be checked to see that they match the
6102 # number of items expected to be passed into the procedure...
6105 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6106 # return that string.
6108 proc capture_command_output { command prefix } {
6112 set output_string ""
6113 gdb_test_multiple "$command" "capture_command_output for $command" {
6114 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6115 set output_string $expect_out(1,string)
6118 return $output_string
6121 # A convenience function that joins all the arguments together, with a
6122 # regexp that matches exactly one end of line in between each argument.
6123 # This function is ideal to write the expected output of a GDB command
6124 # that generates more than a couple of lines, as this allows us to write
6125 # each line as a separate string, which is easier to read by a human
6128 proc multi_line { args } {
6129 return [join $args "\r\n"]
6132 # Similar to the above, but while multi_line is meant to be used to
6133 # match GDB output, this one is meant to be used to build strings to
6134 # send as GDB input.
6136 proc multi_line_input { args } {
6137 return [join $args "\n"]
6140 # Return the version of the DejaGnu framework.
6142 # The return value is a list containing the major, minor and patch version
6143 # numbers. If the version does not contain a minor or patch number, they will
6144 # be set to 0. For example:
6150 proc dejagnu_version { } {
6151 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6152 global frame_version
6154 verbose -log "DejaGnu version: $frame_version"
6155 verbose -log "Expect version: [exp_version]"
6156 verbose -log "Tcl version: [info tclversion]"
6158 set dg_ver [split $frame_version .]
6160 while { [llength $dg_ver] < 3 } {
6167 # Define user-defined command COMMAND using the COMMAND_LIST as the
6168 # command's definition. The terminating "end" is added automatically.
6170 proc gdb_define_cmd {command command_list} {
6173 set input [multi_line_input {*}$command_list "end"]
6174 set test "define $command"
6176 gdb_test_multiple "define $command" $test {
6178 gdb_test_multiple $input $test {
6179 -re "\r\n$gdb_prompt " {
6186 # Always load compatibility stuff.