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 # Set up, compile, and execute a test program containing _Complex types.
2276 # Include the current process ID in the file names to prevent conflicts
2277 # with invocations for multiple testsuites.
2278 set src [standard_temp_file complex[pid].c]
2279 set exe [standard_temp_file complex[pid].x]
2281 gdb_produce_source $src {
2285 _Complex long double cld;
2290 verbose "compiling testfile $src" 2
2291 set compile_flags {debug nowarnings quiet}
2292 set lines [gdb_compile $src $exe executable $compile_flags]
2296 if ![string match "" $lines] then {
2297 verbose "testfile compilation failed, returning 0" 2
2306 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2309 proc supports_get_siginfo_type {} {
2310 if { [istarget "*-*-linux*"] } {
2317 # Return 1 if the target supports hardware single stepping.
2319 proc can_hardware_single_step {} {
2321 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2322 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2323 || [istarget "nios2-*-*"] } {
2330 # Return 1 if target hardware or OS supports single stepping to signal
2331 # handler, otherwise, return 0.
2333 proc can_single_step_to_signal_handler {} {
2334 # Targets don't have hardware single step. On these targets, when
2335 # a signal is delivered during software single step, gdb is unable
2336 # to determine the next instruction addresses, because start of signal
2337 # handler is one of them.
2338 return [can_hardware_single_step]
2341 # Return 1 if target supports process record, otherwise return 0.
2343 proc supports_process_record {} {
2345 if [target_info exists gdb,use_precord] {
2346 return [target_info gdb,use_precord]
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 target supports reverse debugging, otherwise return 0.
2362 proc supports_reverse {} {
2364 if [target_info exists gdb,can_reverse] {
2365 return [target_info gdb,can_reverse]
2368 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2369 || [istarget "i\[34567\]86-*-linux*"]
2370 || [istarget "aarch64*-*-linux*"]
2371 || [istarget "powerpc*-*-linux*"]
2372 || [istarget "s390*-*-linux*"] } {
2379 # Return 1 if readline library is used.
2381 proc readline_is_used { } {
2384 gdb_test_multiple "show editing" "" {
2385 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2388 -re ".*$gdb_prompt $" {
2394 # Return 1 if target is ELF.
2395 gdb_caching_proc is_elf_target {
2396 set me "is_elf_target"
2398 set src [standard_temp_file is_elf_target[pid].c]
2399 set obj [standard_temp_file is_elf_target[pid].o]
2401 gdb_produce_source $src {
2402 int foo () {return 0;}
2405 verbose "$me: compiling testfile $src" 2
2406 set lines [gdb_compile $src $obj object {quiet}]
2410 if ![string match "" $lines] then {
2411 verbose "$me: testfile compilation failed, returning 0" 2
2415 set fp_obj [open $obj "r"]
2416 fconfigure $fp_obj -translation binary
2417 set data [read $fp_obj]
2422 set ELFMAG "\u007FELF"
2424 if {[string compare -length 4 $data $ELFMAG] != 0} {
2425 verbose "$me: returning 0" 2
2429 verbose "$me: returning 1" 2
2433 # Return 1 if the memory at address zero is readable.
2435 gdb_caching_proc is_address_zero_readable {
2439 gdb_test_multiple "x 0" "" {
2440 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2443 -re ".*$gdb_prompt $" {
2451 # Produce source file NAME and write SOURCES into it.
2453 proc gdb_produce_source { name sources } {
2455 set f [open $name "w"]
2461 # Return 1 if target is ILP32.
2462 # This cannot be decided simply from looking at the target string,
2463 # as it might depend on externally passed compiler options like -m64.
2464 gdb_caching_proc is_ilp32_target {
2465 set me "is_ilp32_target"
2467 set src [standard_temp_file ilp32[pid].c]
2468 set obj [standard_temp_file ilp32[pid].o]
2470 gdb_produce_source $src {
2471 int dummy[sizeof (int) == 4
2472 && sizeof (void *) == 4
2473 && sizeof (long) == 4 ? 1 : -1];
2476 verbose "$me: compiling testfile $src" 2
2477 set lines [gdb_compile $src $obj object {quiet}]
2481 if ![string match "" $lines] then {
2482 verbose "$me: testfile compilation failed, returning 0" 2
2486 verbose "$me: returning 1" 2
2490 # Return 1 if target is LP64.
2491 # This cannot be decided simply from looking at the target string,
2492 # as it might depend on externally passed compiler options like -m64.
2493 gdb_caching_proc is_lp64_target {
2494 set me "is_lp64_target"
2496 set src [standard_temp_file lp64[pid].c]
2497 set obj [standard_temp_file lp64[pid].o]
2499 gdb_produce_source $src {
2500 int dummy[sizeof (int) == 4
2501 && sizeof (void *) == 8
2502 && sizeof (long) == 8 ? 1 : -1];
2505 verbose "$me: compiling testfile $src" 2
2506 set lines [gdb_compile $src $obj object {quiet}]
2510 if ![string match "" $lines] then {
2511 verbose "$me: testfile compilation failed, returning 0" 2
2515 verbose "$me: returning 1" 2
2519 # Return 1 if target has 64 bit addresses.
2520 # This cannot be decided simply from looking at the target string,
2521 # as it might depend on externally passed compiler options like -m64.
2522 gdb_caching_proc is_64_target {
2523 set me "is_64_target"
2525 set src [standard_temp_file is64[pid].c]
2526 set obj [standard_temp_file is64[pid].o]
2528 gdb_produce_source $src {
2529 int function(void) { return 3; }
2530 int dummy[sizeof (&function) == 8 ? 1 : -1];
2533 verbose "$me: compiling testfile $src" 2
2534 set lines [gdb_compile $src $obj object {quiet}]
2538 if ![string match "" $lines] then {
2539 verbose "$me: testfile compilation failed, returning 0" 2
2543 verbose "$me: returning 1" 2
2547 # Return 1 if target has x86_64 registers - either amd64 or x32.
2548 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2549 # just from the target string.
2550 gdb_caching_proc is_amd64_regs_target {
2551 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2555 set me "is_amd64_regs_target"
2557 set src [standard_temp_file reg64[pid].s]
2558 set obj [standard_temp_file reg64[pid].o]
2562 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2563 lappend list "\tincq %$reg"
2565 gdb_produce_source $src [join $list \n]
2567 verbose "$me: compiling testfile $src" 2
2568 set lines [gdb_compile $src $obj object {quiet}]
2572 if ![string match "" $lines] then {
2573 verbose "$me: testfile compilation failed, returning 0" 2
2577 verbose "$me: returning 1" 2
2581 # Return 1 if this target is an x86 or x86-64 with -m32.
2582 proc is_x86_like_target {} {
2583 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2586 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2589 # Return 1 if this target is an arm or aarch32 on aarch64.
2591 gdb_caching_proc is_aarch32_target {
2592 if { [istarget "arm*-*-*"] } {
2596 if { ![istarget "aarch64*-*-*"] } {
2600 set me "is_aarch32_target"
2602 set src [standard_temp_file aarch32[pid].s]
2603 set obj [standard_temp_file aarch32[pid].o]
2608 lappend list "\tmov $reg, $reg"
2610 gdb_produce_source $src [join $list \n]
2612 verbose "$me: compiling testfile $src" 2
2613 set lines [gdb_compile $src $obj object {quiet}]
2617 if ![string match "" $lines] then {
2618 verbose "$me: testfile compilation failed, returning 0" 2
2622 verbose "$me: returning 1" 2
2626 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2628 proc is_aarch64_target {} {
2629 if { ![istarget "aarch64*-*-*"] } {
2633 return [expr ![is_aarch32_target]]
2636 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2637 proc support_displaced_stepping {} {
2639 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2640 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2641 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2642 || [istarget "aarch64*-*-linux*"] } {
2649 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2650 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2652 gdb_caching_proc skip_altivec_tests {
2653 global srcdir subdir gdb_prompt inferior_exited_re
2655 set me "skip_altivec_tests"
2657 # Some simulators are known to not support VMX instructions.
2658 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2659 verbose "$me: target known to not support VMX, returning 1" 2
2663 # Make sure we have a compiler that understands altivec.
2664 set compile_flags {debug nowarnings}
2665 if [get_compiler_info] {
2666 warning "Could not get compiler info"
2669 if [test_compiler_info gcc*] {
2670 set compile_flags "$compile_flags additional_flags=-maltivec"
2671 } elseif [test_compiler_info xlc*] {
2672 set compile_flags "$compile_flags additional_flags=-qaltivec"
2674 verbose "Could not compile with altivec support, returning 1" 2
2678 # Set up, compile, and execute a test program containing VMX instructions.
2679 # Include the current process ID in the file names to prevent conflicts
2680 # with invocations for multiple testsuites.
2681 set src [standard_temp_file vmx[pid].c]
2682 set exe [standard_temp_file vmx[pid].x]
2684 gdb_produce_source $src {
2687 asm volatile ("vor v0,v0,v0");
2689 asm volatile ("vor 0,0,0");
2695 verbose "$me: compiling testfile $src" 2
2696 set lines [gdb_compile $src $exe executable $compile_flags]
2699 if ![string match "" $lines] then {
2700 verbose "$me: testfile compilation failed, returning 1" 2
2704 # No error message, compilation succeeded so now run it via gdb.
2708 gdb_reinitialize_dir $srcdir/$subdir
2712 -re ".*Illegal instruction.*${gdb_prompt} $" {
2713 verbose -log "\n$me altivec hardware not detected"
2714 set skip_vmx_tests 1
2716 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2717 verbose -log "\n$me: altivec hardware detected"
2718 set skip_vmx_tests 0
2721 warning "\n$me: default case taken"
2722 set skip_vmx_tests 1
2726 remote_file build delete $exe
2728 verbose "$me: returning $skip_vmx_tests" 2
2729 return $skip_vmx_tests
2732 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2733 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2735 gdb_caching_proc skip_vsx_tests {
2736 global srcdir subdir gdb_prompt inferior_exited_re
2738 set me "skip_vsx_tests"
2740 # Some simulators are known to not support Altivec instructions, so
2741 # they won't support VSX instructions as well.
2742 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2743 verbose "$me: target known to not support VSX, returning 1" 2
2747 # Make sure we have a compiler that understands altivec.
2748 set compile_flags {debug nowarnings quiet}
2749 if [get_compiler_info] {
2750 warning "Could not get compiler info"
2753 if [test_compiler_info gcc*] {
2754 set compile_flags "$compile_flags additional_flags=-mvsx"
2755 } elseif [test_compiler_info xlc*] {
2756 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2758 verbose "Could not compile with vsx support, returning 1" 2
2762 set src [standard_temp_file vsx[pid].c]
2763 set exe [standard_temp_file vsx[pid].x]
2765 gdb_produce_source $src {
2767 double a[2] = { 1.0, 2.0 };
2769 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2771 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2777 verbose "$me: compiling testfile $src" 2
2778 set lines [gdb_compile $src $exe executable $compile_flags]
2781 if ![string match "" $lines] then {
2782 verbose "$me: testfile compilation failed, returning 1" 2
2786 # No error message, compilation succeeded so now run it via gdb.
2790 gdb_reinitialize_dir $srcdir/$subdir
2794 -re ".*Illegal instruction.*${gdb_prompt} $" {
2795 verbose -log "\n$me VSX hardware not detected"
2796 set skip_vsx_tests 1
2798 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2799 verbose -log "\n$me: VSX hardware detected"
2800 set skip_vsx_tests 0
2803 warning "\n$me: default case taken"
2804 set skip_vsx_tests 1
2808 remote_file build delete $exe
2810 verbose "$me: returning $skip_vsx_tests" 2
2811 return $skip_vsx_tests
2814 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2815 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2817 gdb_caching_proc skip_tsx_tests {
2818 global srcdir subdir gdb_prompt inferior_exited_re
2820 set me "skip_tsx_tests"
2822 set src [standard_temp_file tsx[pid].c]
2823 set exe [standard_temp_file tsx[pid].x]
2825 gdb_produce_source $src {
2827 asm volatile ("xbegin .L0");
2828 asm volatile ("xend");
2829 asm volatile (".L0: nop");
2834 verbose "$me: compiling testfile $src" 2
2835 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2838 if ![string match "" $lines] then {
2839 verbose "$me: testfile compilation failed." 2
2843 # No error message, compilation succeeded so now run it via gdb.
2847 gdb_reinitialize_dir $srcdir/$subdir
2851 -re ".*Illegal instruction.*${gdb_prompt} $" {
2852 verbose -log "$me: TSX hardware not detected."
2853 set skip_tsx_tests 1
2855 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2856 verbose -log "$me: TSX hardware detected."
2857 set skip_tsx_tests 0
2860 warning "\n$me: default case taken."
2861 set skip_tsx_tests 1
2865 remote_file build delete $exe
2867 verbose "$me: returning $skip_tsx_tests" 2
2868 return $skip_tsx_tests
2871 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2872 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2874 gdb_caching_proc skip_btrace_tests {
2875 global srcdir subdir gdb_prompt inferior_exited_re
2877 set me "skip_btrace_tests"
2878 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2879 verbose "$me: target does not support btrace, returning 1" 2
2883 # Set up, compile, and execute a test program.
2884 # Include the current process ID in the file names to prevent conflicts
2885 # with invocations for multiple testsuites.
2886 set src [standard_temp_file btrace[pid].c]
2887 set exe [standard_temp_file btrace[pid].x]
2889 gdb_produce_source $src {
2890 int main(void) { return 0; }
2893 verbose "$me: compiling testfile $src" 2
2894 set compile_flags {debug nowarnings quiet}
2895 set lines [gdb_compile $src $exe executable $compile_flags]
2897 if ![string match "" $lines] then {
2898 verbose "$me: testfile compilation failed, returning 1" 2
2903 # No error message, compilation succeeded so now run it via gdb.
2907 gdb_reinitialize_dir $srcdir/$subdir
2914 # In case of an unexpected output, we return 2 as a fail value.
2915 set skip_btrace_tests 2
2916 gdb_test_multiple "record btrace" "check btrace support" {
2917 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2918 set skip_btrace_tests 1
2920 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2921 set skip_btrace_tests 1
2923 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2924 set skip_btrace_tests 1
2926 -re "^record btrace\r\n$gdb_prompt $" {
2927 set skip_btrace_tests 0
2931 remote_file build delete $exe
2933 verbose "$me: returning $skip_btrace_tests" 2
2934 return $skip_btrace_tests
2937 # Run a test on the target to see if it supports btrace pt hardware.
2938 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2939 # from the GCC testsuite.
2941 gdb_caching_proc skip_btrace_pt_tests {
2942 global srcdir subdir gdb_prompt inferior_exited_re
2944 set me "skip_btrace_tests"
2945 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2946 verbose "$me: target does not support btrace, returning 1" 2
2950 # Set up, compile, and execute a test program.
2951 # Include the current process ID in the file names to prevent conflicts
2952 # with invocations for multiple testsuites.
2953 set src [standard_temp_file btrace[pid].c]
2954 set exe [standard_temp_file btrace[pid].x]
2956 gdb_produce_source $src {
2957 int main(void) { return 0; }
2960 verbose "$me: compiling testfile $src" 2
2961 set compile_flags {debug nowarnings quiet}
2962 set lines [gdb_compile $src $exe executable $compile_flags]
2964 if ![string match "" $lines] then {
2965 verbose "$me: testfile compilation failed, returning 1" 2
2970 # No error message, compilation succeeded so now run it via gdb.
2974 gdb_reinitialize_dir $srcdir/$subdir
2981 # In case of an unexpected output, we return 2 as a fail value.
2982 set skip_btrace_tests 2
2983 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2984 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2985 set skip_btrace_tests 1
2987 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2988 set skip_btrace_tests 1
2990 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2991 set skip_btrace_tests 1
2993 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2994 set skip_btrace_tests 1
2996 -re "^record btrace pt\r\n$gdb_prompt $" {
2997 set skip_btrace_tests 0
3001 remote_file build delete $exe
3003 verbose "$me: returning $skip_btrace_tests" 2
3004 return $skip_btrace_tests
3007 # A helper that compiles a test case to see if __int128 is supported.
3008 proc gdb_int128_helper {lang} {
3009 set src [standard_temp_file i128[pid].c]
3010 set obj [standard_temp_file i128[pid].o]
3012 verbose -log "checking $lang for __int128"
3013 gdb_produce_source $src {
3015 int main() { return 0; }
3018 set lines [gdb_compile $src $obj object [list nowarnings quiet $lang]]
3022 set result [expr {!![string match "" $lines]}]
3023 verbose -log "__int128 for $lang result = $result"
3027 # Return true if the C compiler understands the __int128 type.
3028 gdb_caching_proc has_int128_c {
3029 return [gdb_int128_helper c]
3032 # Return true if the C++ compiler understands the __int128 type.
3033 gdb_caching_proc has_int128_cxx {
3034 return [gdb_int128_helper c++]
3037 # Return whether we should skip tests for showing inlined functions in
3038 # backtraces. Requires get_compiler_info and get_debug_format.
3040 proc skip_inline_frame_tests {} {
3041 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3042 if { ! [test_debug_format "DWARF 2"] } {
3046 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
3047 if { ([test_compiler_info "gcc-2-*"]
3048 || [test_compiler_info "gcc-3-*"]
3049 || [test_compiler_info "gcc-4-0-*"]) } {
3056 # Return whether we should skip tests for showing variables from
3057 # inlined functions. Requires get_compiler_info and get_debug_format.
3059 proc skip_inline_var_tests {} {
3060 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3061 if { ! [test_debug_format "DWARF 2"] } {
3068 # Return a 1 if we should skip tests that require hardware breakpoints
3070 proc skip_hw_breakpoint_tests {} {
3071 # Skip tests if requested by the board (note that no_hardware_watchpoints
3072 # disables both watchpoints and breakpoints)
3073 if { [target_info exists gdb,no_hardware_watchpoints]} {
3077 # These targets support hardware breakpoints natively
3078 if { [istarget "i?86-*-*"]
3079 || [istarget "x86_64-*-*"]
3080 || [istarget "ia64-*-*"]
3081 || [istarget "arm*-*-*"]
3082 || [istarget "aarch64*-*-*"]
3083 || [istarget "s390*-*-*"] } {
3090 # Return a 1 if we should skip tests that require hardware watchpoints
3092 proc skip_hw_watchpoint_tests {} {
3093 # Skip tests if requested by the board
3094 if { [target_info exists gdb,no_hardware_watchpoints]} {
3098 # These targets support hardware watchpoints natively
3099 if { [istarget "i?86-*-*"]
3100 || [istarget "x86_64-*-*"]
3101 || [istarget "ia64-*-*"]
3102 || [istarget "arm*-*-*"]
3103 || [istarget "aarch64*-*-*"]
3104 || [istarget "powerpc*-*-linux*"]
3105 || [istarget "s390*-*-*"] } {
3112 # Return a 1 if we should skip tests that require *multiple* hardware
3113 # watchpoints to be active at the same time
3115 proc skip_hw_watchpoint_multi_tests {} {
3116 if { [skip_hw_watchpoint_tests] } {
3120 # These targets support just a single hardware watchpoint
3121 if { [istarget "arm*-*-*"]
3122 || [istarget "powerpc*-*-linux*"] } {
3129 # Return a 1 if we should skip tests that require read/access watchpoints
3131 proc skip_hw_watchpoint_access_tests {} {
3132 if { [skip_hw_watchpoint_tests] } {
3136 # These targets support just write watchpoints
3137 if { [istarget "s390*-*-*"] } {
3144 # Return 1 if we should skip tests that require the runtime unwinder
3145 # hook. This must be invoked while gdb is running, after shared
3146 # libraries have been loaded. This is needed because otherwise a
3147 # shared libgcc won't be visible.
3149 proc skip_unwinder_tests {} {
3153 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3154 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3156 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3159 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3163 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3164 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3167 -re "\r\n$gdb_prompt $" {
3174 # Return 0 if we should skip tests that require the libstdc++ stap
3175 # probes. This must be invoked while gdb is running, after shared
3176 # libraries have been loaded.
3178 proc skip_libstdcxx_probe_tests {} {
3182 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3183 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3186 -re "\r\n$gdb_prompt $" {
3192 # Return 1 if we should skip tests of the "compile" feature.
3193 # This must be invoked after the inferior has been started.
3195 proc skip_compile_feature_tests {} {
3199 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3200 "Could not load libcc1.*\r\n$gdb_prompt $" {
3203 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3206 -re "\r\n$gdb_prompt $" {
3212 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3213 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3214 # is a regexp that will match the output of "maint print target-stack" if
3215 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3216 # matching the expected prompt after the command output.
3218 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3219 set test "probe for target ${target_name}"
3220 gdb_test_multiple "maint print target-stack" $test {
3221 -re "${target_stack_regexp}${prompt_regexp}" {
3225 -re "$prompt_regexp" {
3232 # Helper for gdb_is_target_remote where the expected prompt is variable.
3234 proc gdb_is_target_remote_prompt { prompt_regexp } {
3235 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3238 # Check whether we're testing with the remote or extended-remote
3241 proc gdb_is_target_remote { } {
3244 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3247 # Check whether we're testing with the native target.
3249 proc gdb_is_target_native { } {
3252 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3255 # Return the effective value of use_gdb_stub.
3257 # If the use_gdb_stub global has been set (it is set when the gdb process is
3258 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3259 # property from the board file.
3261 # This is the preferred way of checking use_gdb_stub, since it allows to check
3262 # the value before the gdb has been spawned and it will return the correct value
3263 # even when it was overriden by the test.
3265 proc use_gdb_stub {} {
3268 if [info exists use_gdb_stub] {
3269 return $use_gdb_stub
3272 return [target_info exists use_gdb_stub]
3275 # Return 1 if the current remote target is an instance of our GDBserver, 0
3276 # otherwise. Return -1 if there was an error and we can't tell.
3278 gdb_caching_proc target_is_gdbserver {
3282 set test "probing for GDBserver"
3284 gdb_test_multiple "monitor help" $test {
3285 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3288 -re "$gdb_prompt $" {
3293 if { $is_gdbserver == -1 } {
3294 verbose -log "Unable to tell whether we are using GDBserver or not."
3297 return $is_gdbserver
3300 # N.B. compiler_info is intended to be local to this file.
3301 # Call test_compiler_info with no arguments to fetch its value.
3302 # Yes, this is counterintuitive when there's get_compiler_info,
3303 # but that's the current API.
3304 if [info exists compiler_info] {
3310 # Figure out what compiler I am using.
3311 # The result is cached so only the first invocation runs the compiler.
3313 # ARG can be empty or "C++". If empty, "C" is assumed.
3315 # There are several ways to do this, with various problems.
3317 # [ gdb_compile -E $ifile -o $binfile.ci ]
3318 # source $binfile.ci
3320 # Single Unix Spec v3 says that "-E -o ..." together are not
3321 # specified. And in fact, the native compiler on hp-ux 11 (among
3322 # others) does not work with "-E -o ...". Most targets used to do
3323 # this, and it mostly worked, because it works with gcc.
3325 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3326 # source $binfile.ci
3328 # This avoids the problem with -E and -o together. This almost works
3329 # if the build machine is the same as the host machine, which is
3330 # usually true of the targets which are not gcc. But this code does
3331 # not figure which compiler to call, and it always ends up using the C
3332 # compiler. Not good for setting hp_aCC_compiler. Target
3333 # hppa*-*-hpux* used to do this.
3335 # [ gdb_compile -E $ifile > $binfile.ci ]
3336 # source $binfile.ci
3338 # dejagnu target_compile says that it supports output redirection,
3339 # but the code is completely different from the normal path and I
3340 # don't want to sweep the mines from that path. So I didn't even try
3343 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3346 # I actually do this for all targets now. gdb_compile runs the right
3347 # compiler, and TCL captures the output, and I eval the output.
3349 # Unfortunately, expect logs the output of the command as it goes by,
3350 # and dejagnu helpfully prints a second copy of it right afterwards.
3351 # So I turn off expect logging for a moment.
3353 # [ gdb_compile $ifile $ciexe_file executable $args ]
3354 # [ remote_exec $ciexe_file ]
3355 # [ source $ci_file.out ]
3357 # I could give up on -E and just do this.
3358 # I didn't get desperate enough to try this.
3360 # -- chastain 2004-01-06
3362 proc get_compiler_info {{arg ""}} {
3363 # For compiler.c and compiler.cc
3366 # I am going to play with the log to keep noise out.
3370 # These come from compiler.c or compiler.cc
3371 global compiler_info
3373 # Legacy global data symbols.
3376 if [info exists compiler_info] {
3381 # Choose which file to preprocess.
3382 set ifile "${srcdir}/lib/compiler.c"
3383 if { $arg == "c++" } {
3384 set ifile "${srcdir}/lib/compiler.cc"
3387 # Run $ifile through the right preprocessor.
3388 # Toggle gdb.log to keep the compiler output out of the log.
3389 set saved_log [log_file -info]
3391 if [is_remote host] {
3392 # We have to use -E and -o together, despite the comments
3393 # above, because of how DejaGnu handles remote host testing.
3394 set ppout "$outdir/compiler.i"
3395 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3396 set file [open $ppout r]
3397 set cppout [read $file]
3400 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3402 eval log_file $saved_log
3406 foreach cppline [ split "$cppout" "\n" ] {
3407 if { [ regexp "^#" "$cppline" ] } {
3409 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3411 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3413 verbose "get_compiler_info: $cppline" 2
3417 verbose -log "get_compiler_info: $cppline"
3422 # Set to unknown if for some reason compiler_info didn't get defined.
3423 if ![info exists compiler_info] {
3424 verbose -log "get_compiler_info: compiler_info not provided"
3425 set compiler_info "unknown"
3427 # Also set to unknown compiler if any diagnostics happened.
3429 verbose -log "get_compiler_info: got unexpected diagnostics"
3430 set compiler_info "unknown"
3433 # Set the legacy symbols.
3435 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3437 # Log what happened.
3438 verbose -log "get_compiler_info: $compiler_info"
3440 # Most compilers will evaluate comparisons and other boolean
3441 # operations to 0 or 1.
3442 uplevel \#0 { set true 1 }
3443 uplevel \#0 { set false 0 }
3448 # Return the compiler_info string if no arg is provided.
3449 # Otherwise the argument is a glob-style expression to match against
3452 proc test_compiler_info { {compiler ""} } {
3453 global compiler_info
3456 # If no arg, return the compiler_info string.
3457 if [string match "" $compiler] {
3458 return $compiler_info
3461 return [string match $compiler $compiler_info]
3464 proc current_target_name { } {
3466 if [info exists target_info(target,name)] {
3467 set answer $target_info(target,name)
3474 set gdb_wrapper_initialized 0
3475 set gdb_wrapper_target ""
3477 proc gdb_wrapper_init { args } {
3478 global gdb_wrapper_initialized
3479 global gdb_wrapper_file
3480 global gdb_wrapper_flags
3481 global gdb_wrapper_target
3483 if { $gdb_wrapper_initialized == 1 } { return; }
3485 if {[target_info exists needs_status_wrapper] && \
3486 [target_info needs_status_wrapper] != "0"} {
3487 set result [build_wrapper "testglue.o"]
3488 if { $result != "" } {
3489 set gdb_wrapper_file [lindex $result 0]
3490 set gdb_wrapper_flags [lindex $result 1]
3492 warning "Status wrapper failed to build."
3495 set gdb_wrapper_initialized 1
3496 set gdb_wrapper_target [current_target_name]
3499 # Determine options that we always want to pass to the compiler.
3500 gdb_caching_proc universal_compile_options {
3501 set me "universal_compile_options"
3504 set src [standard_temp_file ccopts[pid].c]
3505 set obj [standard_temp_file ccopts[pid].o]
3507 gdb_produce_source $src {
3508 int foo(void) { return 0; }
3511 # Try an option for disabling colored diagnostics. Some compilers
3512 # yield colored diagnostics by default (when run from a tty) unless
3513 # such an option is specified.
3514 set opt "additional_flags=-fdiagnostics-color=never"
3515 set lines [target_compile $src $obj object [list "quiet" $opt]]
3516 if [string match "" $lines] then {
3517 # Seems to have worked; use the option.
3518 lappend options $opt
3523 verbose "$me: returning $options" 2
3527 # Some targets need to always link a special object in. Save its path here.
3528 global gdb_saved_set_unbuffered_mode_obj
3529 set gdb_saved_set_unbuffered_mode_obj ""
3531 # Compile source files specified by SOURCE into a binary of type TYPE at path
3532 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3533 # parameter and most options are passed directly to it.
3535 # The type can be one of the following:
3537 # - object: Compile into an object file.
3538 # - executable: Compile and link into an executable.
3539 # - preprocess: Preprocess the source files.
3540 # - assembly: Generate assembly listing.
3542 # The following options are understood and processed by gdb_compile:
3544 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3545 # quirks to be able to use shared libraries.
3546 # - shlib_load: Link with appropriate libraries to allow the test to
3547 # dynamically load libraries at runtime. For example, on Linux, this adds
3548 # -ldl so that the test can use dlopen.
3549 # - nowarnings: Inhibit all compiler warnings.
3551 # And here are some of the not too obscure options understood by DejaGnu that
3552 # influence the compilation:
3554 # - additional_flags=flag: Add FLAG to the compiler flags.
3555 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3556 # argument can be a file, in which case it's added to the sources, or a
3558 # - ldflags=flag: Add FLAG to the linker flags.
3559 # - incdir=path: Add PATH to the searched include directories.
3560 # - libdir=path: Add PATH to the linker searched directories.
3561 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3562 # - debug: Build with debug information.
3563 # - optimize: Build with optimization.
3565 proc gdb_compile {source dest type options} {
3566 global GDB_TESTCASE_OPTIONS
3567 global gdb_wrapper_file
3568 global gdb_wrapper_flags
3569 global gdb_wrapper_initialized
3572 global gdb_saved_set_unbuffered_mode_obj
3574 set outdir [file dirname $dest]
3576 # Add platform-specific options if a shared library was specified using
3577 # "shlib=librarypath" in OPTIONS.
3579 if {[lsearch -exact $options rust] != -1} {
3580 # -fdiagnostics-color is not a rustcc option.
3582 set new_options [universal_compile_options]
3586 foreach opt $options {
3587 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3588 && $type == "executable"} {
3589 if [test_compiler_info "xlc-*"] {
3590 # IBM xlc compiler doesn't accept shared library named other
3591 # than .so: use "-Wl," to bypass this
3592 lappend source "-Wl,$shlib_name"
3593 } elseif { ([istarget "*-*-mingw*"]
3594 || [istarget *-*-cygwin*]
3595 || [istarget *-*-pe*])} {
3596 lappend source "${shlib_name}.a"
3598 lappend source $shlib_name
3600 if { $shlib_found == 0 } {
3602 if { ([istarget "*-*-mingw*"]
3603 || [istarget *-*-cygwin*]) } {
3604 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3606 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3607 # Undo debian's change in the default.
3608 # Put it at the front to not override any user-provided
3609 # value, and to make sure it appears in front of all the
3611 lappend new_options "early_flags=-Wl,--no-as-needed"
3614 } elseif { $opt == "shlib_load" && $type == "executable" } {
3617 lappend new_options $opt
3621 # Because we link with libraries using their basename, we may need
3622 # (depending on the platform) to set a special rpath value, to allow
3623 # the executable to find the libraries it depends on.
3624 if { $shlib_load || $shlib_found } {
3625 if { ([istarget "*-*-mingw*"]
3626 || [istarget *-*-cygwin*]
3627 || [istarget *-*-pe*]) } {
3628 # Do not need anything.
3629 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3630 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3631 } elseif { [istarget arm*-*-symbianelf*] } {
3632 if { $shlib_load } {
3633 lappend new_options "libs=-ldl"
3636 if { $shlib_load } {
3637 lappend new_options "libs=-ldl"
3639 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3642 set options $new_options
3644 if [info exists GDB_TESTCASE_OPTIONS] {
3645 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3647 verbose "options are $options"
3648 verbose "source is $source $dest $type $options"
3650 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3652 if {[target_info exists needs_status_wrapper] && \
3653 [target_info needs_status_wrapper] != "0" && \
3654 [info exists gdb_wrapper_file]} {
3655 lappend options "libs=${gdb_wrapper_file}"
3656 lappend options "ldflags=${gdb_wrapper_flags}"
3659 # Replace the "nowarnings" option with the appropriate additional_flags
3660 # to disable compiler warnings.
3661 set nowarnings [lsearch -exact $options nowarnings]
3662 if {$nowarnings != -1} {
3663 if [target_info exists gdb,nowarnings_flag] {
3664 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3666 set flag "additional_flags=-w"
3668 set options [lreplace $options $nowarnings $nowarnings $flag]
3671 if { $type == "executable" } {
3672 if { ([istarget "*-*-mingw*"]
3673 || [istarget "*-*-*djgpp"]
3674 || [istarget "*-*-cygwin*"])} {
3675 # Force output to unbuffered mode, by linking in an object file
3676 # with a global contructor that calls setvbuf.
3678 # Compile the special object seperatelly for two reasons:
3679 # 1) Insulate it from $options.
3680 # 2) Avoid compiling it for every gdb_compile invocation,
3681 # which is time consuming, especially if we're remote
3684 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3685 verbose "compiling gdb_saved_set_unbuffered_obj"
3686 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3687 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3689 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3690 if { $result != "" } {
3693 if {[is_remote host]} {
3694 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3696 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3698 # Link a copy of the output object, because the
3699 # original may be automatically deleted.
3700 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3702 verbose "gdb_saved_set_unbuffered_obj already compiled"
3705 # Rely on the internal knowledge that the global ctors are ran in
3706 # reverse link order. In that case, we can use ldflags to
3707 # avoid copying the object file to the host multiple
3709 # This object can only be added if standard libraries are
3710 # used. Thus, we need to disable it if -nostdlib option is used
3711 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3712 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3717 set result [target_compile $source $dest $type $options]
3719 # Prune uninteresting compiler (and linker) output.
3720 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3722 regsub "\[\r\n\]*$" "$result" "" result
3723 regsub "^\[\r\n\]*" "$result" "" result
3725 if {[lsearch $options quiet] < 0} {
3726 # We shall update this on a per language basis, to avoid
3727 # changing the entire testsuite in one go.
3728 if {[lsearch $options f77] >= 0} {
3729 gdb_compile_test $source $result
3730 } elseif { $result != "" } {
3731 clone_output "gdb compile failed, $result"
3738 # This is just like gdb_compile, above, except that it tries compiling
3739 # against several different thread libraries, to see which one this
3741 proc gdb_compile_pthreads {source dest type options} {
3743 set why_msg "unrecognized error"
3744 foreach lib {-lpthreads -lpthread -lthread ""} {
3745 # This kind of wipes out whatever libs the caller may have
3746 # set. Or maybe theirs will override ours. How infelicitous.
3747 set options_with_lib [concat $options [list libs=$lib quiet]]
3748 set ccout [gdb_compile $source $dest $type $options_with_lib]
3749 switch -regexp -- $ccout {
3750 ".*no posix threads support.*" {
3751 set why_msg "missing threads include file"
3754 ".*cannot open -lpthread.*" {
3755 set why_msg "missing runtime threads library"
3757 ".*Can't find library for -lpthread.*" {
3758 set why_msg "missing runtime threads library"
3761 pass "successfully compiled posix threads test case"
3767 if {!$built_binfile} {
3768 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3773 # Build a shared library from SOURCES.
3775 proc gdb_compile_shlib {sources dest options} {
3776 set obj_options $options
3779 if { [lsearch -exact $options "c++"] >= 0 } {
3780 set info_options "c++"
3782 if [get_compiler_info ${info_options}] {
3786 switch -glob [test_compiler_info] {
3788 lappend obj_options "additional_flags=-qpic"
3791 if { !([istarget "*-*-cygwin*"]
3792 || [istarget "*-*-mingw*"]) } {
3793 lappend obj_options "additional_flags=-fpic"
3797 if { !([istarget "powerpc*-*-aix*"]
3798 || [istarget "rs6000*-*-aix*"]
3799 || [istarget "*-*-cygwin*"]
3800 || [istarget "*-*-mingw*"]
3801 || [istarget "*-*-pe*"]) } {
3802 lappend obj_options "additional_flags=-fpic"
3806 lappend obj_options "additional_flags=-fpic"
3809 # don't know what the compiler is...
3813 set outdir [file dirname $dest]
3815 foreach source $sources {
3816 set sourcebase [file tail $source]
3817 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3820 lappend objects ${outdir}/${sourcebase}.o
3823 set link_options $options
3824 if [test_compiler_info "xlc-*"] {
3825 lappend link_options "additional_flags=-qmkshrobj"
3827 lappend link_options "additional_flags=-shared"
3829 if { ([istarget "*-*-mingw*"]
3830 || [istarget *-*-cygwin*]
3831 || [istarget *-*-pe*]) } {
3832 if { [is_remote host] } {
3833 set name [file tail ${dest}]
3837 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3839 # Set the soname of the library. This causes the linker on ELF
3840 # systems to create the DT_NEEDED entry in the executable referring
3841 # to the soname of the library, and not its absolute path. This
3842 # (using the absolute path) would be problem when testing on a
3845 # In conjunction with setting the soname, we add the special
3846 # rpath=$ORIGIN value when building the executable, so that it's
3847 # able to find the library in its own directory.
3848 set destbase [file tail $dest]
3849 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3852 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3855 if { [is_remote host]
3856 && ([istarget "*-*-mingw*"]
3857 || [istarget *-*-cygwin*]
3858 || [istarget *-*-pe*]) } {
3859 set dest_tail_name [file tail ${dest}]
3860 remote_upload host $dest_tail_name.a ${dest}.a
3861 remote_file host delete $dest_tail_name.a
3867 # This is just like gdb_compile_shlib, above, except that it tries compiling
3868 # against several different thread libraries, to see which one this
3870 proc gdb_compile_shlib_pthreads {sources dest options} {
3872 set why_msg "unrecognized error"
3873 foreach lib {-lpthreads -lpthread -lthread ""} {
3874 # This kind of wipes out whatever libs the caller may have
3875 # set. Or maybe theirs will override ours. How infelicitous.
3876 set options_with_lib [concat $options [list libs=$lib quiet]]
3877 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3878 switch -regexp -- $ccout {
3879 ".*no posix threads support.*" {
3880 set why_msg "missing threads include file"
3883 ".*cannot open -lpthread.*" {
3884 set why_msg "missing runtime threads library"
3886 ".*Can't find library for -lpthread.*" {
3887 set why_msg "missing runtime threads library"
3890 pass "successfully compiled posix threads test case"
3896 if {!$built_binfile} {
3897 unsupported "couldn't compile $sources: ${why_msg}"
3902 # This is just like gdb_compile_pthreads, above, except that we always add the
3903 # objc library for compiling Objective-C programs
3904 proc gdb_compile_objc {source dest type options} {
3906 set why_msg "unrecognized error"
3907 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3908 # This kind of wipes out whatever libs the caller may have
3909 # set. Or maybe theirs will override ours. How infelicitous.
3910 if { $lib == "solaris" } {
3911 set lib "-lpthread -lposix4"
3913 if { $lib != "-lobjc" } {
3914 set lib "-lobjc $lib"
3916 set options_with_lib [concat $options [list libs=$lib quiet]]
3917 set ccout [gdb_compile $source $dest $type $options_with_lib]
3918 switch -regexp -- $ccout {
3919 ".*no posix threads support.*" {
3920 set why_msg "missing threads include file"
3923 ".*cannot open -lpthread.*" {
3924 set why_msg "missing runtime threads library"
3926 ".*Can't find library for -lpthread.*" {
3927 set why_msg "missing runtime threads library"
3930 pass "successfully compiled objc with posix threads test case"
3936 if {!$built_binfile} {
3937 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3942 proc send_gdb { string } {
3943 global suppress_flag
3944 if { $suppress_flag } {
3947 return [remote_send host "$string"]
3950 # Send STRING to the inferior's terminal.
3952 proc send_inferior { string } {
3953 global inferior_spawn_id
3955 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3965 proc gdb_expect { args } {
3966 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3967 set atimeout [lindex $args 0]
3968 set expcode [list [lindex $args 1]]
3973 # A timeout argument takes precedence, otherwise of all the timeouts
3974 # select the largest.
3975 if [info exists atimeout] {
3978 set tmt [get_largest_timeout]
3981 global suppress_flag
3982 global remote_suppress_flag
3983 if [info exists remote_suppress_flag] {
3984 set old_val $remote_suppress_flag
3986 if [info exists suppress_flag] {
3987 if { $suppress_flag } {
3988 set remote_suppress_flag 1
3992 {uplevel remote_expect host $tmt $expcode} string]
3993 if [info exists old_val] {
3994 set remote_suppress_flag $old_val
3996 if [info exists remote_suppress_flag] {
3997 unset remote_suppress_flag
4002 global errorInfo errorCode
4004 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4006 return -code $code $string
4010 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4012 # Check for long sequence of output by parts.
4013 # TEST: is the test message to be printed with the test success/fail.
4014 # SENTINEL: Is the terminal pattern indicating that output has finished.
4015 # LIST: is the sequence of outputs to match.
4016 # If the sentinel is recognized early, it is considered an error.
4019 # 1 if the test failed,
4020 # 0 if the test passes,
4021 # -1 if there was an internal error.
4023 proc gdb_expect_list {test sentinel list} {
4025 global suppress_flag
4028 if { $suppress_flag } {
4030 unresolved "${test}"
4032 while { ${index} < [llength ${list}] } {
4033 set pattern [lindex ${list} ${index}]
4034 set index [expr ${index} + 1]
4035 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4036 if { ${index} == [llength ${list}] } {
4039 -re "${pattern}${sentinel}" {
4040 # pass "${test}, pattern ${index} + sentinel"
4043 fail "${test} (pattern ${index} + sentinel)"
4046 -re ".*A problem internal to GDB has been detected" {
4047 fail "${test} (GDB internal error)"
4049 gdb_internal_error_resync
4052 fail "${test} (pattern ${index} + sentinel) (timeout)"
4057 # unresolved "${test}, pattern ${index} + sentinel"
4063 # pass "${test}, pattern ${index}"
4066 fail "${test} (pattern ${index})"
4069 -re ".*A problem internal to GDB has been detected" {
4070 fail "${test} (GDB internal error)"
4072 gdb_internal_error_resync
4075 fail "${test} (pattern ${index}) (timeout)"
4080 # unresolved "${test}, pattern ${index}"
4094 proc gdb_suppress_entire_file { reason } {
4095 global suppress_flag
4098 set suppress_flag -1
4102 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4103 # gdb_expect to fail immediately (until the next call to
4104 # gdb_stop_suppressing_tests).
4106 proc gdb_suppress_tests { args } {
4107 global suppress_flag
4109 return; # fnf - disable pending review of results where
4110 # testsuite ran better without this
4113 if { $suppress_flag == 1 } {
4114 if { [llength $args] > 0 } {
4115 warning "[lindex $args 0]\n"
4117 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4123 # Clear suppress_flag.
4125 proc gdb_stop_suppressing_tests { } {
4126 global suppress_flag
4128 if [info exists suppress_flag] {
4129 if { $suppress_flag > 0 } {
4131 clone_output "Tests restarted.\n"
4138 proc gdb_clear_suppressed { } {
4139 global suppress_flag
4144 # Spawn the gdb process.
4146 # This doesn't expect any output or do any other initialization,
4147 # leaving those to the caller.
4149 # Overridable function -- you can override this function in your
4152 proc gdb_spawn { } {
4156 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4158 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4161 set saved_gdbflags $GDBFLAGS
4163 if {$GDBFLAGS != ""} {
4166 append GDBFLAGS $cmdline_flags
4170 set GDBFLAGS $saved_gdbflags
4175 # Start gdb running, wait for prompt, and disable the pagers.
4177 # Overridable function -- you can override this function in your
4180 proc gdb_start { } {
4185 catch default_gdb_exit
4188 # Return true if we can spawn a program on the target and attach to
4191 proc can_spawn_for_attach { } {
4192 # We use exp_pid to get the inferior's pid, assuming that gives
4193 # back the pid of the program. On remote boards, that would give
4194 # us instead the PID of e.g., the ssh client, etc.
4195 if [is_remote target] then {
4199 # The "attach" command doesn't make sense when the target is
4200 # stub-like, where GDB finds the program already started on
4201 # initial connection.
4202 if {[target_info exists use_gdb_stub]} {
4210 # Kill a progress previously started with spawn_wait_for_attach, and
4211 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4214 proc kill_wait_spawned_process { proc_spawn_id } {
4215 set pid [exp_pid -i $proc_spawn_id]
4217 verbose -log "killing ${pid}"
4218 remote_exec build "kill -9 ${pid}"
4220 verbose -log "closing ${proc_spawn_id}"
4221 catch "close -i $proc_spawn_id"
4222 verbose -log "waiting for ${proc_spawn_id}"
4224 # If somehow GDB ends up still attached to the process here, a
4225 # blocking wait hangs until gdb is killed (or until gdb / the
4226 # ptracer reaps the exit status too, but that won't happen because
4227 # something went wrong.) Passing -nowait makes expect tell Tcl to
4228 # wait for the PID in the background. That's fine because we
4229 # don't care about the exit status. */
4230 wait -nowait -i $proc_spawn_id
4233 # Returns the process id corresponding to the given spawn id.
4235 proc spawn_id_get_pid { spawn_id } {
4236 set testpid [exp_pid -i $spawn_id]
4238 if { [istarget "*-*-cygwin*"] } {
4239 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4240 # might be different due to the way fork/exec works.
4241 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4247 # Start a set of programs running and then wait for a bit, to be sure
4248 # that they can be attached to. Return a list of processes spawn IDs,
4249 # one element for each process spawned. It's a test error to call
4250 # this when [can_spawn_for_attach] is false.
4252 proc spawn_wait_for_attach { executable_list } {
4253 set spawn_id_list {}
4255 if ![can_spawn_for_attach] {
4256 # The caller should have checked can_spawn_for_attach itself
4257 # before getting here.
4258 error "can't spawn for attach with this target/board"
4261 foreach {executable} $executable_list {
4262 # Note we use Expect's spawn, not Tcl's exec, because with
4263 # spawn we control when to wait for/reap the process. That
4264 # allows killing the process by PID without being subject to
4266 lappend spawn_id_list [remote_spawn target $executable]
4271 return $spawn_id_list
4275 # gdb_load_cmd -- load a file into the debugger.
4276 # ARGS - additional args to load command.
4277 # return a -1 if anything goes wrong.
4279 proc gdb_load_cmd { args } {
4282 if [target_info exists gdb_load_timeout] {
4283 set loadtimeout [target_info gdb_load_timeout]
4285 set loadtimeout 1600
4287 send_gdb "load $args\n"
4288 verbose "Timeout is now $loadtimeout seconds" 2
4289 gdb_expect $loadtimeout {
4290 -re "Loading section\[^\r\]*\r\n" {
4293 -re "Start address\[\r\]*\r\n" {
4296 -re "Transfer rate\[\r\]*\r\n" {
4299 -re "Memory access error\[^\r\]*\r\n" {
4300 perror "Failed to load program"
4303 -re "$gdb_prompt $" {
4306 -re "(.*)\r\n$gdb_prompt " {
4307 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4311 perror "Timed out trying to load $args."
4318 # Invoke "gcore". CORE is the name of the core file to write. TEST
4319 # is the name of the test case. This will return 1 if the core file
4320 # was created, 0 otherwise. If this fails to make a core file because
4321 # this configuration of gdb does not support making core files, it
4322 # will call "unsupported", not "fail". However, if this fails to make
4323 # a core file for some other reason, then it will call "fail".
4325 proc gdb_gcore_cmd {core test} {
4329 gdb_test_multiple "gcore $core" $test {
4330 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4334 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4342 # Load core file CORE. TEST is the name of the test case.
4343 # This will record a pass/fail for loading the core file.
4345 # 1 - core file is successfully loaded
4346 # 0 - core file loaded but has a non fatal error
4347 # -1 - core file failed to load
4349 proc gdb_core_cmd { core test } {
4352 gdb_test_multiple "core $core" "$test" {
4353 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4356 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4357 fail "$test (bad file format)"
4360 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4361 fail "$test (file not found)"
4364 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4365 fail "$test (incomplete note section)"
4368 -re "Core was generated by .*\r\n$gdb_prompt $" {
4372 -re ".*$gdb_prompt $" {
4377 fail "$test (timeout)"
4381 fail "unsupported output from 'core' command"
4385 # Return the filename to download to the target and load on the target
4386 # for this shared library. Normally just LIBNAME, unless shared libraries
4387 # for this target have separate link and load images.
4389 proc shlib_target_file { libname } {
4393 # Return the filename GDB will load symbols from when debugging this
4394 # shared library. Normally just LIBNAME, unless shared libraries for
4395 # this target have separate link and load images.
4397 proc shlib_symbol_file { libname } {
4401 # Return the filename to download to the target and load for this
4402 # executable. Normally just BINFILE unless it is renamed to something
4403 # else for this target.
4405 proc exec_target_file { binfile } {
4409 # Return the filename GDB will load symbols from when debugging this
4410 # executable. Normally just BINFILE unless executables for this target
4411 # have separate files for symbols.
4413 proc exec_symbol_file { binfile } {
4417 # Rename the executable file. Normally this is just BINFILE1 being renamed
4418 # to BINFILE2, but some targets require multiple binary files.
4419 proc gdb_rename_execfile { binfile1 binfile2 } {
4420 file rename -force [exec_target_file ${binfile1}] \
4421 [exec_target_file ${binfile2}]
4422 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4423 file rename -force [exec_symbol_file ${binfile1}] \
4424 [exec_symbol_file ${binfile2}]
4428 # "Touch" the executable file to update the date. Normally this is just
4429 # BINFILE, but some targets require multiple files.
4430 proc gdb_touch_execfile { binfile } {
4431 set time [clock seconds]
4432 file mtime [exec_target_file ${binfile}] $time
4433 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4434 file mtime [exec_symbol_file ${binfile}] $time
4438 # Like remote_download but provides a gdb-specific behavior.
4440 # If the destination board is remote, the local file FROMFILE is transferred as
4441 # usual with remote_download to TOFILE on the remote board. The destination
4442 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4445 # If the destination board is local, the destination path TOFILE is passed
4446 # through standard_output_file, and FROMFILE is copied there.
4448 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4451 proc gdb_remote_download {dest fromfile {tofile {}}} {
4452 # If TOFILE is not given, default to the same filename as FROMFILE.
4453 if {[string length $tofile] == 0} {
4454 set tofile [file tail $fromfile]
4457 if {[is_remote $dest]} {
4458 # When the DEST is remote, we simply send the file to DEST.
4461 set destname [remote_download $dest $fromfile $tofile]
4462 lappend cleanfiles $destname
4466 # When the DEST is local, we copy the file to the test directory (where
4467 # the executable is).
4469 # Note that we pass TOFILE through standard_output_file, regardless of
4470 # whether it is absolute or relative, because we don't want the tests
4471 # to be able to write outside their standard output directory.
4473 set tofile [standard_output_file $tofile]
4475 file copy -force $fromfile $tofile
4481 # gdb_load_shlib LIB...
4483 # Copy the listed library to the target.
4485 proc gdb_load_shlib { file } {
4488 if ![info exists gdb_spawn_id] {
4489 perror "gdb_load_shlib: GDB is not running"
4492 set dest [gdb_remote_download target [shlib_target_file $file]]
4494 if {[is_remote target]} {
4495 # If the target is remote, we need to tell gdb where to find the
4498 # We could set this even when not testing remotely, but a user
4499 # generally won't set it unless necessary. In order to make the tests
4500 # more like the real-life scenarios, we don't set it for local testing.
4501 gdb_test "set solib-search-path [file dirname $file]" "" ""
4508 # gdb_load -- load a file into the debugger. Specifying no file
4509 # defaults to the executable currently being debugged.
4510 # The return value is 0 for success, -1 for failure.
4511 # Many files in config/*.exp override this procedure.
4513 proc gdb_load { arg } {
4515 return [gdb_file_cmd $arg]
4520 # gdb_reload -- load a file into the target. Called before "running",
4521 # either the first time or after already starting the program once,
4522 # for remote targets. Most files that override gdb_load should now
4523 # override this instead.
4525 proc gdb_reload { } {
4526 # For the benefit of existing configurations, default to gdb_load.
4527 # Specifying no file defaults to the executable currently being
4529 return [gdb_load ""]
4532 proc gdb_continue { function } {
4535 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4538 proc default_gdb_init { test_file_name } {
4539 global gdb_wrapper_initialized
4540 global gdb_wrapper_target
4541 global gdb_test_file_name
4547 gdb_clear_suppressed
4549 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4551 # Make sure that the wrapper is rebuilt
4552 # with the appropriate multilib option.
4553 if { $gdb_wrapper_target != [current_target_name] } {
4554 set gdb_wrapper_initialized 0
4557 # Unlike most tests, we have a small number of tests that generate
4558 # a very large amount of output. We therefore increase the expect
4559 # buffer size to be able to contain the entire test output. This
4560 # is especially needed by gdb.base/info-macros.exp.
4562 # Also set this value for the currently running GDB.
4563 match_max [match_max -d]
4565 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4566 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4569 if [target_info exists gdb_prompt] {
4570 set gdb_prompt [target_info gdb_prompt]
4572 set gdb_prompt "\\(gdb\\)"
4575 if [info exists use_gdb_stub] {
4580 # Return a path using GDB_PARALLEL.
4581 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4582 # GDB_PARALLEL must be defined, the caller must check.
4584 # The default value for GDB_PARALLEL is, canonically, ".".
4585 # The catch is that tests don't expect an additional "./" in file paths so
4586 # omit any directory for the default case.
4587 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4588 # its special handling.
4590 proc make_gdb_parallel_path { args } {
4591 global GDB_PARALLEL objdir
4592 set joiner [list "file" "join" $objdir]
4593 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4594 lappend joiner $GDB_PARALLEL
4596 set joiner [concat $joiner $args]
4597 return [eval $joiner]
4600 # Turn BASENAME into a full file name in the standard output
4601 # directory. It is ok if BASENAME is the empty string; in this case
4602 # the directory is returned.
4604 proc standard_output_file {basename} {
4605 global objdir subdir gdb_test_file_name
4607 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4609 return [file join $dir $basename]
4612 # Return the name of a file in our standard temporary directory.
4614 proc standard_temp_file {basename} {
4615 # Since a particular runtest invocation is only executing a single test
4616 # file at any given time, we can use the runtest pid to build the
4617 # path of the temp directory.
4618 set dir [make_gdb_parallel_path temp [pid]]
4620 return [file join $dir $basename]
4623 # Set 'testfile', 'srcfile', and 'binfile'.
4625 # ARGS is a list of source file specifications.
4626 # Without any arguments, the .exp file's base name is used to
4627 # compute the source file name. The ".c" extension is added in this case.
4628 # If ARGS is not empty, each entry is a source file specification.
4629 # If the specification starts with a ".", it is treated as a suffix
4630 # to append to the .exp file's base name.
4631 # If the specification is the empty string, it is treated as if it
4633 # Otherwise it is a file name.
4634 # The first file in the list is used to set the 'srcfile' global.
4635 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4637 # Most tests should call this without arguments.
4639 # If a completely different binary file name is needed, then it
4640 # should be handled in the .exp file with a suitable comment.
4642 proc standard_testfile {args} {
4643 global gdb_test_file_name
4645 global gdb_test_file_last_vars
4648 global testfile binfile
4650 set testfile $gdb_test_file_name
4651 set binfile [standard_output_file ${testfile}]
4653 if {[llength $args] == 0} {
4657 # Unset our previous output variables.
4658 # This can help catch hidden bugs.
4659 if {[info exists gdb_test_file_last_vars]} {
4660 foreach varname $gdb_test_file_last_vars {
4662 catch {unset $varname}
4665 # 'executable' is often set by tests.
4666 set gdb_test_file_last_vars {executable}
4670 set varname srcfile$suffix
4673 # Handle an extension.
4676 } elseif {[string range $arg 0 0] == "."} {
4677 set arg $testfile$arg
4681 lappend gdb_test_file_last_vars $varname
4683 if {$suffix == ""} {
4691 # The default timeout used when testing GDB commands. We want to use
4692 # the same timeout as the default dejagnu timeout, unless the user has
4693 # already provided a specific value (probably through a site.exp file).
4694 global gdb_test_timeout
4695 if ![info exists gdb_test_timeout] {
4696 set gdb_test_timeout $timeout
4699 # A list of global variables that GDB testcases should not use.
4700 # We try to prevent their use by monitoring write accesses and raising
4701 # an error when that happens.
4702 set banned_variables { bug_id prms_id }
4704 # A list of procedures that GDB testcases should not use.
4705 # We try to prevent their use by monitoring invocations and raising
4706 # an error when that happens.
4707 set banned_procedures { strace }
4709 # gdb_init is called by runtest at start, but also by several
4710 # tests directly; gdb_finish is only called from within runtest after
4711 # each test source execution.
4712 # Placing several traces by repetitive calls to gdb_init leads
4713 # to problems, as only one trace is removed in gdb_finish.
4714 # To overcome this possible problem, we add a variable that records
4715 # if the banned variables and procedures are already traced.
4718 proc gdb_init { test_file_name } {
4719 # Reset the timeout value to the default. This way, any testcase
4720 # that changes the timeout value without resetting it cannot affect
4721 # the timeout used in subsequent testcases.
4722 global gdb_test_timeout
4724 set timeout $gdb_test_timeout
4726 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4727 && [target_info exists gdb_reverse_timeout] } {
4728 set timeout [target_info gdb_reverse_timeout]
4731 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4732 # debugging tool to help confirm that the test suite is
4733 # parallel-safe. You need "inotifywait" from the
4734 # inotify-tools package to use this.
4735 global GDB_INOTIFY inotify_pid
4736 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4737 global outdir tool inotify_log_file
4739 set exclusions {outputs temp gdb[.](log|sum) cache}
4740 set exclusion_re ([join $exclusions |])
4742 set inotify_log_file [standard_temp_file inotify.out]
4743 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4744 --exclude $exclusion_re \
4745 |& tee -a $outdir/$tool.log $inotify_log_file &]
4747 # Wait for the watches; hopefully this is long enough.
4750 # Clear the log so that we don't emit a warning the first time
4752 set fd [open $inotify_log_file w]
4756 # Block writes to all banned variables, and invocation of all
4757 # banned procedures...
4758 global banned_variables
4759 global banned_procedures
4760 global banned_traced
4761 if (!$banned_traced) {
4762 foreach banned_var $banned_variables {
4763 global "$banned_var"
4764 trace add variable "$banned_var" write error
4766 foreach banned_proc $banned_procedures {
4767 global "$banned_proc"
4768 trace add execution "$banned_proc" enter error
4773 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4774 # messages as expected.
4779 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4780 # the test results. Even if /dev/null doesn't exist on the particular
4781 # platform, the readline library will use the default setting just by
4782 # failing to open the file. OTOH, opening /dev/null successfully will
4783 # also result in the default settings being used since nothing will be
4784 # read from this file.
4785 setenv INPUTRC "/dev/null"
4787 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4788 # bindings, so make sure that an appropriate terminal is selected.
4789 # The same bug doesn't show up if we use ^P / ^N instead.
4792 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4793 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4794 # especially having color output turned on can cause tests to fail.
4795 setenv GREP_OPTIONS ""
4797 # Clear $gdbserver_reconnect_p.
4798 global gdbserver_reconnect_p
4799 set gdbserver_reconnect_p 1
4800 unset gdbserver_reconnect_p
4802 return [default_gdb_init $test_file_name]
4805 proc gdb_finish { } {
4806 global gdbserver_reconnect_p
4810 # Exit first, so that the files are no longer in use.
4813 if { [llength $cleanfiles] > 0 } {
4814 eval remote_file target delete $cleanfiles
4818 # Unblock write access to the banned variables. Dejagnu typically
4819 # resets some of them between testcases.
4820 global banned_variables
4821 global banned_procedures
4822 global banned_traced
4823 if ($banned_traced) {
4824 foreach banned_var $banned_variables {
4825 global "$banned_var"
4826 trace remove variable "$banned_var" write error
4828 foreach banned_proc $banned_procedures {
4829 global "$banned_proc"
4830 trace remove execution "$banned_proc" enter error
4837 set debug_format "unknown"
4839 # Run the gdb command "info source" and extract the debugging format
4840 # information from the output and save it in debug_format.
4842 proc get_debug_format { } {
4848 set debug_format "unknown"
4849 send_gdb "info source\n"
4851 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4852 set debug_format $expect_out(1,string)
4853 verbose "debug format is $debug_format"
4856 -re "No current source file.\r\n$gdb_prompt $" {
4857 perror "get_debug_format used when no current source file"
4860 -re "$gdb_prompt $" {
4861 warning "couldn't check debug format (no valid response)."
4865 warning "couldn't check debug format (timeout)."
4871 # Return true if FORMAT matches the debug format the current test was
4872 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4873 # `*', `[...]', and so on.
4875 # This function depends on variables set by `get_debug_format', above.
4877 proc test_debug_format {format} {
4880 return [expr [string match $format $debug_format] != 0]
4883 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4884 # COFF, stabs, etc). If that format matches the format that the
4885 # current test was compiled with, then the next test is expected to
4886 # fail for any target. Returns 1 if the next test or set of tests is
4887 # expected to fail, 0 otherwise (or if it is unknown). Must have
4888 # previously called get_debug_format.
4889 proc setup_xfail_format { format } {
4890 set ret [test_debug_format $format]
4898 # gdb_get_line_number TEXT [FILE]
4900 # Search the source file FILE, and return the line number of the
4901 # first line containing TEXT. If no match is found, an error is thrown.
4903 # TEXT is a string literal, not a regular expression.
4905 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4906 # specified, and does not start with "/", then it is assumed to be in
4907 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4908 # by changing the callers and the interface at the same time.
4909 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4910 # gdb.base/ena-dis-br.exp.
4912 # Use this function to keep your test scripts independent of the
4913 # exact line numbering of the source file. Don't write:
4915 # send_gdb "break 20"
4917 # This means that if anyone ever edits your test's source file,
4918 # your test could break. Instead, put a comment like this on the
4919 # source file line you want to break at:
4921 # /* breakpoint spot: frotz.exp: test name */
4923 # and then write, in your test script (which we assume is named
4926 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4928 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4931 # % puts "foo [lindex "bar baz" 1]"
4934 # Tcl is quite clever, for a little stringy language.)
4938 # The previous implementation of this procedure used the gdb search command.
4939 # This version is different:
4941 # . It works with MI, and it also works when gdb is not running.
4943 # . It operates on the build machine, not the host machine.
4945 # . For now, this implementation fakes a current directory of
4946 # $srcdir/$subdir to be compatible with the old implementation.
4947 # This will go away eventually and some callers will need to
4950 # . The TEXT argument is literal text and matches literally,
4951 # not a regular expression as it was before.
4953 # . State changes in gdb, such as changing the current file
4954 # and setting $_, no longer happen.
4956 # After a bit of time we can forget about the differences from the
4957 # old implementation.
4959 # --chastain 2004-08-05
4961 proc gdb_get_line_number { text { file "" } } {
4966 if { "$file" == "" } then {
4969 if { ! [regexp "^/" "$file"] } then {
4970 set file "$srcdir/$subdir/$file"
4973 if { [ catch { set fd [open "$file"] } message ] } then {
4978 for { set line 1 } { 1 } { incr line } {
4979 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4982 if { $nchar < 0 } then {
4985 if { [string first "$text" "$body"] >= 0 } then {
4991 if { [ catch { close "$fd" } message ] } then {
4996 error "undefined tag \"$text\""
5002 # Continue the program until it ends.
5004 # MSSG is the error message that gets printed. If not given, a
5006 # COMMAND is the command to invoke. If not given, "continue" is
5008 # ALLOW_EXTRA is a flag indicating whether the test should expect
5009 # extra output between the "Continuing." line and the program
5010 # exiting. By default it is zero; if nonzero, any extra output
5013 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5014 global inferior_exited_re use_gdb_stub
5017 set text "continue until exit"
5019 set text "continue until exit at $mssg"
5027 # By default, we don't rely on exit() behavior of remote stubs --
5028 # it's common for exit() to be implemented as a simple infinite
5029 # loop, or a forced crash/reset. For native targets, by default, we
5030 # assume process exit is reported as such. If a non-reliable target
5031 # is used, we set a breakpoint at exit, and continue to that.
5032 if { [target_info exists exit_is_reliable] } {
5033 set exit_is_reliable [target_info exit_is_reliable]
5035 set exit_is_reliable [expr ! $use_gdb_stub]
5038 if { ! $exit_is_reliable } {
5039 if {![gdb_breakpoint "exit"]} {
5042 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5045 # Continue until we exit. Should not stop again.
5046 # Don't bother to check the output of the program, that may be
5047 # extremely tough for some remote systems.
5049 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5054 proc rerun_to_main {} {
5055 global gdb_prompt use_gdb_stub
5060 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5061 {pass "rerun to main" ; return 0}
5062 -re "$gdb_prompt $"\
5063 {fail "rerun to main" ; return 0}
5064 timeout {fail "(timeout) rerun to main" ; return 0}
5069 -re "The program .* has been started already.*y or n. $" {
5073 -re "Starting program.*$gdb_prompt $"\
5074 {pass "rerun to main" ; return 0}
5075 -re "$gdb_prompt $"\
5076 {fail "rerun to main" ; return 0}
5077 timeout {fail "(timeout) rerun to main" ; return 0}
5082 # Return true if a test should be skipped due to lack of floating
5083 # point support or GDB can't fetch the contents from floating point
5086 gdb_caching_proc gdb_skip_float_test {
5087 if [target_info exists gdb,skip_float_tests] {
5091 # There is an ARM kernel ptrace bug that hardware VFP registers
5092 # are not updated after GDB ptrace set VFP registers. The bug
5093 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5094 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5095 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5096 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5097 # This kernel bug is detected by check how does GDB change the
5098 # program result by changing one VFP register.
5099 if { [istarget "arm*-*-linux*"] } {
5101 set compile_flags {debug nowarnings }
5103 # Set up, compile, and execute a test program having VFP
5105 set src [standard_temp_file arm_vfp[pid].c]
5106 set exe [standard_temp_file arm_vfp[pid].x]
5108 gdb_produce_source $src {
5113 asm ("vldr d0, [%0]" : : "r" (&d));
5114 asm ("vldr d1, [%0]" : : "r" (&d));
5115 asm (".global break_here\n"
5117 asm ("vcmp.f64 d0, d1\n"
5118 "vmrs APSR_nzcv, fpscr\n"
5119 "bne L_value_different\n"
5122 "L_value_different:\n"
5124 "L_end:\n" : "=r" (ret) :);
5126 /* Return $d0 != $d1. */
5131 verbose "compiling testfile $src" 2
5132 set lines [gdb_compile $src $exe executable $compile_flags]
5135 if ![string match "" $lines] then {
5136 verbose "testfile compilation failed, returning 1" 2
5140 # No error message, compilation succeeded so now run it via gdb.
5141 # Run the test up to 5 times to detect whether ptrace can
5142 # correctly update VFP registers or not.
5144 for {set i 0} {$i < 5} {incr i} {
5145 global gdb_prompt srcdir subdir
5149 gdb_reinitialize_dir $srcdir/$subdir
5153 gdb_test "break *break_here"
5154 gdb_continue_to_breakpoint "break_here"
5156 # Modify $d0 to a different value, so the exit code should
5158 gdb_test "set \$d0 = 5.0"
5160 set test "continue to exit"
5161 gdb_test_multiple "continue" "$test" {
5162 -re "exited with code 01.*$gdb_prompt $" {
5164 -re "exited normally.*$gdb_prompt $" {
5165 # However, the exit code is 0. That means something
5166 # wrong in setting VFP registers.
5174 remote_file build delete $exe
5176 return $skip_vfp_test
5181 # Print a message and return true if a test should be skipped
5182 # due to lack of stdio support.
5184 proc gdb_skip_stdio_test { msg } {
5185 if [target_info exists gdb,noinferiorio] {
5186 verbose "Skipping test '$msg': no inferior i/o."
5192 proc gdb_skip_bogus_test { msg } {
5196 # Return true if a test should be skipped due to lack of XML support
5198 # NOTE: This must be called while gdb is *not* running.
5200 gdb_caching_proc gdb_skip_xml_test {
5205 if { [info exists gdb_spawn_id] } {
5206 error "GDB must not be running in gdb_skip_xml_tests."
5209 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5213 gdb_test_multiple "set tdesc filename $xml_file" "" {
5214 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5217 -re ".*$gdb_prompt $" { }
5223 # Return true if argv[0] is available.
5225 gdb_caching_proc gdb_has_argv0 {
5228 # Set up, compile, and execute a test program to check whether
5229 # argv[0] is available.
5230 set src [standard_temp_file has_argv0[pid].c]
5231 set exe [standard_temp_file has_argv0[pid].x]
5233 gdb_produce_source $src {
5234 int main (int argc, char **argv) {
5239 gdb_compile $src $exe executable {debug}
5242 proc gdb_has_argv0_1 { exe } {
5243 global srcdir subdir
5244 global gdb_prompt hex
5248 gdb_reinitialize_dir $srcdir/$subdir
5251 # Set breakpoint on main.
5252 gdb_test_multiple "break main" "break main" {
5253 -re "Breakpoint.*${gdb_prompt} $" {
5255 -re "${gdb_prompt} $" {
5262 gdb_test_multiple "" "run to main" {
5263 -re "Breakpoint.*${gdb_prompt} $" {
5265 -re "${gdb_prompt} $" {
5270 set old_elements "200"
5271 set test "show print elements"
5272 gdb_test_multiple $test $test {
5273 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5274 set old_elements $expect_out(1,string)
5277 set old_repeats "200"
5278 set test "show print repeats"
5279 gdb_test_multiple $test $test {
5280 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5281 set old_repeats $expect_out(1,string)
5284 gdb_test_no_output "set print elements unlimited" ""
5285 gdb_test_no_output "set print repeats unlimited" ""
5288 # Check whether argc is 1.
5289 gdb_test_multiple "p argc" "p argc" {
5290 -re " = 1\r\n${gdb_prompt} $" {
5292 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5293 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5296 -re "${gdb_prompt} $" {
5300 -re "${gdb_prompt} $" {
5304 gdb_test_no_output "set print elements $old_elements" ""
5305 gdb_test_no_output "set print repeats $old_repeats" ""
5310 set result [gdb_has_argv0_1 $exe]
5317 && ([istarget *-*-linux*]
5318 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5319 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5320 || [istarget *-*-openbsd*]
5321 || [istarget *-*-darwin*]
5322 || [istarget *-*-solaris*]
5323 || [istarget *-*-aix*]
5324 || [istarget *-*-gnu*]
5325 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5326 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5327 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5328 || [istarget *-*-symbianelf*]
5329 || [istarget *-*-osf*]
5330 || [istarget *-*-dicos*]
5331 || [istarget *-*-nto*]
5332 || [istarget *-*-*vms*]
5333 || [istarget *-*-lynx*178]) } {
5334 fail "argv\[0\] should be available on this target"
5340 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5341 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5342 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5343 # the name of a debuginfo only file. This file will be stored in the same
5346 # Functions for separate debug info testing
5348 # starting with an executable:
5349 # foo --> original executable
5351 # at the end of the process we have:
5352 # foo.stripped --> foo w/o debug info
5353 # foo.debug --> foo's debug info
5354 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5356 # Fetch the build id from the file.
5357 # Returns "" if there is none.
5359 proc get_build_id { filename } {
5360 if { ([istarget "*-*-mingw*"]
5361 || [istarget *-*-cygwin*]) } {
5362 set objdump_program [gdb_find_objdump]
5363 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5364 verbose "result is $result"
5365 verbose "output is $output"
5371 set tmp [standard_output_file "${filename}-tmp"]
5372 set objcopy_program [gdb_find_objcopy]
5373 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5374 verbose "result is $result"
5375 verbose "output is $output"
5380 fconfigure $fi -translation binary
5381 # Skip the NOTE header.
5386 if ![string compare $data ""] then {
5389 # Convert it to hex.
5390 binary scan $data H* data
5395 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5396 # converted to the form: .build-id/ab/cdef1234...89.debug
5397 # Return "" if no build-id found.
5398 proc build_id_debug_filename_get { filename } {
5399 set data [get_build_id $filename]
5400 if { $data == "" } {
5403 regsub {^..} $data {\0/} data
5404 return ".build-id/${data}.debug"
5407 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5408 # list of optional flags. The only currently supported flag is no-main,
5409 # which removes the symbol entry for main from the separate debug file.
5411 # Function returns zero on success. Function will return non-zero failure code
5412 # on some targets not supporting separate debug info (such as i386-msdos).
5414 proc gdb_gnu_strip_debug { dest args } {
5416 # Use the first separate debug info file location searched by GDB so the
5417 # run cannot be broken by some stale file searched with higher precedence.
5418 set debug_file "${dest}.debug"
5420 set strip_to_file_program [transform strip]
5421 set objcopy_program [gdb_find_objcopy]
5423 set debug_link [file tail $debug_file]
5424 set stripped_file "${dest}.stripped"
5426 # Get rid of the debug info, and store result in stripped_file
5427 # something like gdb/testsuite/gdb.base/blah.stripped.
5428 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5429 verbose "result is $result"
5430 verbose "output is $output"
5435 # Workaround PR binutils/10802:
5436 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5437 set perm [file attributes ${dest} -permissions]
5438 file attributes ${stripped_file} -permissions $perm
5440 # Get rid of everything but the debug info, and store result in debug_file
5441 # This will be in the .debug subdirectory, see above.
5442 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5443 verbose "result is $result"
5444 verbose "output is $output"
5449 # If no-main is passed, strip the symbol for main from the separate
5450 # file. This is to simulate the behavior of elfutils's eu-strip, which
5451 # leaves the symtab in the original file only. There's no way to get
5452 # objcopy or strip to remove the symbol table without also removing the
5453 # debugging sections, so this is as close as we can get.
5454 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5455 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5456 verbose "result is $result"
5457 verbose "output is $output"
5461 file delete "${debug_file}"
5462 file rename "${debug_file}-tmp" "${debug_file}"
5465 # Link the two previous output files together, adding the .gnu_debuglink
5466 # section to the stripped_file, containing a pointer to the debug_file,
5467 # save the new file in dest.
5468 # This will be the regular executable filename, in the usual location.
5469 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5470 verbose "result is $result"
5471 verbose "output is $output"
5476 # Workaround PR binutils/10802:
5477 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5478 set perm [file attributes ${stripped_file} -permissions]
5479 file attributes ${dest} -permissions $perm
5484 # Test the output of GDB_COMMAND matches the pattern obtained
5485 # by concatenating all elements of EXPECTED_LINES. This makes
5486 # it possible to split otherwise very long string into pieces.
5487 # If third argument is not empty, it's used as the name of the
5488 # test to be printed on pass/fail.
5489 proc help_test_raw { gdb_command expected_lines args } {
5490 set message $gdb_command
5491 if [llength $args]>0 then {
5492 set message [lindex $args 0]
5494 set expected_output [join $expected_lines ""]
5495 gdb_test "${gdb_command}" "${expected_output}" $message
5498 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5499 # are regular expressions that should match the beginning of output,
5500 # before the list of commands in that class. The presence of
5501 # command list and standard epilogue will be tested automatically.
5502 # Notice that the '[' and ']' characters don't need to be escaped for strings
5503 # wrapped in {} braces.
5504 proc test_class_help { command_class expected_initial_lines args } {
5506 "List of commands\:.*[\r\n]+"
5507 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5508 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5509 "Command name abbreviations are allowed if unambiguous\."
5511 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5513 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5516 # COMMAND_LIST should have either one element -- command to test, or
5517 # two elements -- abbreviated command to test, and full command the first
5518 # element is abbreviation of.
5519 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5520 # are regular expressions that should match the beginning of output,
5521 # before the list of subcommands. The presence of
5522 # subcommand list and standard epilogue will be tested automatically.
5523 proc test_prefix_command_help { command_list expected_initial_lines args } {
5524 set command [lindex $command_list 0]
5525 if {[llength $command_list]>1} {
5526 set full_command [lindex $command_list 1]
5528 set full_command $command
5530 # Use 'list' and not just {} because we want variables to
5531 # be expanded in this list.
5532 set l_stock_body [list\
5533 "List of $full_command subcommands\:.*\[\r\n\]+"\
5534 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5535 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5536 "Command name abbreviations are allowed if unambiguous\."]
5537 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5538 if {[llength $args]>0} {
5539 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5541 help_test_raw "help ${command}" $l_entire_body
5545 # Build executable named EXECUTABLE from specifications that allow
5546 # different options to be passed to different sub-compilations.
5547 # TESTNAME is the name of the test; this is passed to 'untested' if
5549 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5550 # contains the option "pthreads", then gdb_compile_pthreads is used.
5551 # ARGS is a flat list of source specifications, of the form:
5552 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5553 # Each SOURCE is compiled to an object file using its OPTIONS,
5554 # using gdb_compile.
5555 # Returns 0 on success, -1 on failure.
5556 proc build_executable_from_specs {testname executable options args} {
5560 set binfile [standard_output_file $executable]
5563 if { [lsearch -exact $options "c++"] >= 0 } {
5564 set info_options "c++"
5566 if [get_compiler_info ${info_options}] {
5570 set func gdb_compile
5571 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5572 if {$func_index != -1} {
5573 set func "${func}_[lindex $options $func_index]"
5576 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5577 # parameter. They also requires $sources while gdb_compile and
5578 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5579 if [string match gdb_compile_shlib* $func] {
5581 foreach {s local_options} $args {
5582 if { [regexp "^/" "$s"] } then {
5583 lappend sources_path "$s"
5585 lappend sources_path "$srcdir/$subdir/$s"
5588 set ret [$func $sources_path "${binfile}" $options]
5589 } elseif {[lsearch -exact $options rust] != -1} {
5591 foreach {s local_options} $args {
5592 if { [regexp "^/" "$s"] } then {
5593 lappend sources_path "$s"
5595 lappend sources_path "$srcdir/$subdir/$s"
5598 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5602 foreach {s local_options} $args {
5603 if { ! [regexp "^/" "$s"] } then {
5604 set s "$srcdir/$subdir/$s"
5606 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5610 lappend objects "${binfile}${i}.o"
5613 set ret [$func $objects "${binfile}" executable $options]
5623 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5624 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5625 # to pass to untested, if something is wrong. OPTIONS are passed
5626 # to gdb_compile directly.
5627 proc build_executable { testname executable {sources ""} {options {debug}} } {
5628 if {[llength $sources]==0} {
5629 set sources ${executable}.c
5632 set arglist [list $testname $executable $options]
5633 foreach source $sources {
5634 lappend arglist $source $options
5637 return [eval build_executable_from_specs $arglist]
5640 # Starts fresh GDB binary and loads an optional executable into GDB.
5641 # Usage: clean_restart [executable]
5642 # EXECUTABLE is the basename of the binary.
5644 proc clean_restart { args } {
5648 if { [llength $args] > 1 } {
5649 error "bad number of args: [llength $args]"
5654 gdb_reinitialize_dir $srcdir/$subdir
5656 if { [llength $args] >= 1 } {
5657 set executable [lindex $args 0]
5658 set binfile [standard_output_file ${executable}]
5663 # Prepares for testing by calling build_executable_full, then
5665 # TESTNAME is the name of the test.
5666 # Each element in ARGS is a list of the form
5667 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5668 # These are passed to build_executable_from_specs, which see.
5669 # The last EXECUTABLE is passed to clean_restart.
5670 # Returns 0 on success, non-zero on failure.
5671 proc prepare_for_testing_full {testname args} {
5672 foreach spec $args {
5673 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5676 set executable [lindex $spec 0]
5678 clean_restart $executable
5682 # Prepares for testing, by calling build_executable, and then clean_restart.
5683 # Please refer to build_executable for parameter description.
5684 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5686 if {[build_executable $testname $executable $sources $options] == -1} {
5689 clean_restart $executable
5694 # Retrieve the value of EXP in the inferior, represented in format
5695 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5696 # print fails. TEST is the test message to use. It can be omitted,
5697 # in which case a test message is built from EXP.
5699 proc get_valueof { fmt exp default {test ""} } {
5703 set test "get valueof \"${exp}\""
5707 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5708 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5709 set val $expect_out(1,string)
5713 fail "$test (timeout)"
5719 # Retrieve the value of EXP in the inferior, as a signed decimal value
5720 # (using "print /d"). DEFAULT is used as fallback if print fails.
5721 # TEST is the test message to use. It can be omitted, in which case
5722 # a test message is built from EXP.
5724 proc get_integer_valueof { exp default {test ""} } {
5728 set test "get integer valueof \"${exp}\""
5732 gdb_test_multiple "print /d ${exp}" "$test" {
5733 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5734 set val $expect_out(1,string)
5738 fail "$test (timeout)"
5744 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5745 # (using "print /x"). DEFAULT is used as fallback if print fails.
5746 # TEST is the test message to use. It can be omitted, in which case
5747 # a test message is built from EXP.
5749 proc get_hexadecimal_valueof { exp default {test ""} } {
5753 set test "get hexadecimal valueof \"${exp}\""
5757 gdb_test_multiple "print /x ${exp}" $test {
5758 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5759 set val $expect_out(1,string)
5766 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5767 # is used as fallback if print fails. TEST is the test message to use.
5768 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5770 proc get_sizeof { type default {test ""} } {
5771 return [get_integer_valueof "sizeof (${type})" $default $test]
5774 proc get_target_charset { } {
5777 gdb_test_multiple "show target-charset" "" {
5778 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5779 return $expect_out(1,string)
5781 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5782 return $expect_out(1,string)
5786 # Pick a reasonable default.
5787 warning "Unable to read target-charset."
5791 # Get the address of VAR.
5793 proc get_var_address { var } {
5794 global gdb_prompt hex
5796 # Match output like:
5798 # $5 = (int (*)()) 0
5799 # $6 = (int (*)()) 0x24 <function_bar>
5801 gdb_test_multiple "print &${var}" "get address of ${var}" {
5802 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5804 pass "get address of ${var}"
5805 if { $expect_out(1,string) == "0" } {
5808 return $expect_out(1,string)
5815 # Return the frame number for the currently selected frame
5816 proc get_current_frame_number {{test_name ""}} {
5819 if { $test_name == "" } {
5820 set test_name "get current frame number"
5823 gdb_test_multiple "frame" $test_name {
5824 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5825 set frame_num $expect_out(1,string)
5831 # Get the current value for remotetimeout and return it.
5832 proc get_remotetimeout { } {
5836 gdb_test_multiple "show remotetimeout" "" {
5837 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5838 return $expect_out(1,string)
5842 # Pick the default that gdb uses
5843 warning "Unable to read remotetimeout"
5847 # Set the remotetimeout to the specified timeout. Nothing is returned.
5848 proc set_remotetimeout { timeout } {
5851 gdb_test_multiple "set remotetimeout $timeout" "" {
5852 -re "$gdb_prompt $" {
5853 verbose "Set remotetimeout to $timeout\n"
5858 # Get the target's current endianness and return it.
5859 proc get_endianness { } {
5862 gdb_test_multiple "show endian" "determine endianness" {
5863 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5865 return $expect_out(1,string)
5871 # ROOT and FULL are file names. Returns the relative path from ROOT
5872 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5873 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5876 proc relative_filename {root full} {
5877 set root_split [file split $root]
5878 set full_split [file split $full]
5880 set len [llength $root_split]
5882 if {[eval file join $root_split]
5883 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5884 error "$full not a subdir of $root"
5887 return [eval file join [lrange $full_split $len end]]
5890 # Log gdb command line and script if requested.
5891 if {[info exists TRANSCRIPT]} {
5892 rename send_gdb real_send_gdb
5893 rename remote_spawn real_remote_spawn
5894 rename remote_close real_remote_close
5896 global gdb_transcript
5897 set gdb_transcript ""
5899 global gdb_trans_count
5900 set gdb_trans_count 1
5902 proc remote_spawn {args} {
5903 global gdb_transcript gdb_trans_count outdir
5905 if {$gdb_transcript != ""} {
5906 close $gdb_transcript
5908 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5909 puts $gdb_transcript [lindex $args 1]
5910 incr gdb_trans_count
5912 return [uplevel real_remote_spawn $args]
5915 proc remote_close {args} {
5916 global gdb_transcript
5918 if {$gdb_transcript != ""} {
5919 close $gdb_transcript
5920 set gdb_transcript ""
5923 return [uplevel real_remote_close $args]
5926 proc send_gdb {args} {
5927 global gdb_transcript
5929 if {$gdb_transcript != ""} {
5930 puts -nonewline $gdb_transcript [lindex $args 0]
5933 return [uplevel real_send_gdb $args]
5937 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5938 if {[info exists GDB_PARALLEL]} {
5939 if {[is_remote host]} {
5943 [make_gdb_parallel_path outputs] \
5944 [make_gdb_parallel_path temp] \
5945 [make_gdb_parallel_path cache]
5949 proc core_find {binfile {deletefiles {}} {arg ""}} {
5950 global objdir subdir
5952 set destcore "$binfile.core"
5953 file delete $destcore
5955 # Create a core file named "$destcore" rather than just "core", to
5956 # avoid problems with sys admin types that like to regularly prune all
5957 # files named "core" from the system.
5959 # Arbitrarily try setting the core size limit to "unlimited" since
5960 # this does not hurt on systems where the command does not work and
5961 # allows us to generate a core on systems where it does.
5963 # Some systems append "core" to the name of the program; others append
5964 # the name of the program to "core"; still others (like Linux, as of
5965 # May 2003) create cores named "core.PID". In the latter case, we
5966 # could have many core files lying around, and it may be difficult to
5967 # tell which one is ours, so let's run the program in a subdirectory.
5969 set coredir [standard_output_file coredir.[getpid]]
5971 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5972 # remote_exec host "${binfile}"
5973 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5974 if [remote_file build exists $i] {
5975 remote_exec build "mv $i $destcore"
5979 # Check for "core.PID".
5980 if { $found == 0 } {
5981 set names [glob -nocomplain -directory $coredir core.*]
5982 if {[llength $names] == 1} {
5983 set corefile [file join $coredir [lindex $names 0]]
5984 remote_exec build "mv $corefile $destcore"
5988 if { $found == 0 } {
5989 # The braindamaged HPUX shell quits after the ulimit -c above
5990 # without executing ${binfile}. So we try again without the
5991 # ulimit here if we didn't find a core file above.
5992 # Oh, I should mention that any "braindamaged" non-Unix system has
5993 # the same problem. I like the cd bit too, it's really neat'n stuff.
5994 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5995 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5996 if [remote_file build exists $i] {
5997 remote_exec build "mv $i $destcore"
6003 # Try to clean up after ourselves.
6004 foreach deletefile $deletefiles {
6005 remote_file build delete [file join $coredir $deletefile]
6007 remote_exec build "rmdir $coredir"
6009 if { $found == 0 } {
6010 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6016 # gdb_target_symbol_prefix compiles a test program and then examines
6017 # the output from objdump to determine the prefix (such as underscore)
6018 # for linker symbol prefixes.
6020 gdb_caching_proc gdb_target_symbol_prefix {
6021 # Set up and compile a simple test program...
6022 set src [standard_temp_file main[pid].c]
6023 set exe [standard_temp_file main[pid].x]
6025 gdb_produce_source $src {
6031 verbose "compiling testfile $src" 2
6032 set compile_flags {debug nowarnings quiet}
6033 set lines [gdb_compile $src $exe executable $compile_flags]
6037 if ![string match "" $lines] then {
6038 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
6040 set objdump_program [gdb_find_objdump]
6041 set result [catch "exec $objdump_program --syms $exe" output]
6044 && ![regexp -lineanchor \
6045 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6046 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6056 # gdb_target_symbol returns the provided symbol with the correct prefix
6057 # prepended. (See gdb_target_symbol_prefix, above.)
6059 proc gdb_target_symbol { symbol } {
6060 set prefix [gdb_target_symbol_prefix]
6061 return "${prefix}${symbol}"
6064 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6065 # added to gdb_compile options to define the C-preprocessor macro
6066 # SYMBOL_PREFIX with a value that can be prepended to symbols
6067 # for targets which require a prefix, such as underscore.
6069 # This version (_asm) defines the prefix without double quotes
6070 # surrounding the prefix. It is used to define the macro
6071 # SYMBOL_PREFIX for assembly language files. Another version, below,
6072 # is used for symbols in inline assembler in C/C++ files.
6074 # The lack of quotes in this version (_asm) makes it possible to
6075 # define supporting macros in the .S file. (The version which
6076 # uses quotes for the prefix won't work for such files since it's
6077 # impossible to define a quote-stripping macro in C.)
6079 # It's possible to use this version (_asm) for C/C++ source files too,
6080 # but a string is usually required in such files; providing a version
6081 # (no _asm) which encloses the prefix with double quotes makes it
6082 # somewhat easier to define the supporting macros in the test case.
6084 proc gdb_target_symbol_prefix_flags_asm {} {
6085 set prefix [gdb_target_symbol_prefix]
6086 if {$prefix ne ""} {
6087 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6093 # gdb_target_symbol_prefix_flags returns the same string as
6094 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6095 # enclosed in double quotes if there is a prefix.
6097 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6098 # extended discussion.
6100 proc gdb_target_symbol_prefix_flags {} {
6101 set prefix [gdb_target_symbol_prefix]
6102 if {$prefix ne ""} {
6103 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6109 # A wrapper for 'remote_exec host' that passes or fails a test.
6110 # Returns 0 if all went well, nonzero on failure.
6111 # TEST is the name of the test, other arguments are as for remote_exec.
6113 proc run_on_host { test program args } {
6114 verbose -log "run_on_host: $program $args"
6115 # remote_exec doesn't work properly if the output is set but the
6116 # input is the empty string -- so replace an empty input with
6118 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6119 set args [lreplace $args 1 1 "/dev/null"]
6121 set result [eval remote_exec host [list $program] $args]
6122 verbose "result is $result"
6123 set status [lindex $result 0]
6124 set output [lindex $result 1]
6129 verbose -log "run_on_host failed: $output"
6135 # Return non-zero if "board_info debug_flags" mentions Fission.
6136 # http://gcc.gnu.org/wiki/DebugFission
6137 # Fission doesn't support everything yet.
6138 # This supports working around bug 15954.
6140 proc using_fission { } {
6141 set debug_flags [board_info [target_info name] debug_flags]
6142 return [regexp -- "-gsplit-dwarf" $debug_flags]
6145 # Search the caller's ARGS list and set variables according to the list of
6146 # valid options described by ARGSET.
6148 # The first member of each one- or two-element list in ARGSET defines the
6149 # name of a variable that will be added to the caller's scope.
6151 # If only one element is given to describe an option, it the value is
6152 # 0 if the option is not present in (the caller's) ARGS or 1 if
6155 # If two elements are given, the second element is the default value of
6156 # the variable. This is then overwritten if the option exists in ARGS.
6158 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6159 # any optional components.
6162 # proc myproc {foo args} {
6163 # parse_args {{bar} {baz "abc"} {qux}}
6166 # myproc ABC -bar -baz DEF peanut butter
6167 # will define the following variables in myproc:
6168 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6169 # args will be the list {peanut butter}
6171 proc parse_args { argset } {
6174 foreach argument $argset {
6175 if {[llength $argument] == 1} {
6176 # No default specified, so we assume that we should set
6177 # the value to 1 if the arg is present and 0 if it's not.
6178 # It is assumed that no value is given with the argument.
6179 set result [lsearch -exact $args "-$argument"]
6180 if {$result != -1} then {
6181 uplevel 1 [list set $argument 1]
6182 set args [lreplace $args $result $result]
6184 uplevel 1 [list set $argument 0]
6186 } elseif {[llength $argument] == 2} {
6187 # There are two items in the argument. The second is a
6188 # default value to use if the item is not present.
6189 # Otherwise, the variable is set to whatever is provided
6190 # after the item in the args.
6191 set arg [lindex $argument 0]
6192 set result [lsearch -exact $args "-[lindex $arg 0]"]
6193 if {$result != -1} then {
6194 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6195 set args [lreplace $args $result [expr $result+1]]
6197 uplevel 1 [list set $arg [lindex $argument 1]]
6200 error "Badly formatted argument \"$argument\" in argument set"
6204 # The remaining args should be checked to see that they match the
6205 # number of items expected to be passed into the procedure...
6208 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6209 # return that string.
6211 proc capture_command_output { command prefix } {
6215 set output_string ""
6216 gdb_test_multiple "$command" "capture_command_output for $command" {
6217 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6218 set output_string $expect_out(1,string)
6221 return $output_string
6224 # A convenience function that joins all the arguments together, with a
6225 # regexp that matches exactly one end of line in between each argument.
6226 # This function is ideal to write the expected output of a GDB command
6227 # that generates more than a couple of lines, as this allows us to write
6228 # each line as a separate string, which is easier to read by a human
6231 proc multi_line { args } {
6232 return [join $args "\r\n"]
6235 # Similar to the above, but while multi_line is meant to be used to
6236 # match GDB output, this one is meant to be used to build strings to
6237 # send as GDB input.
6239 proc multi_line_input { args } {
6240 return [join $args "\n"]
6243 # Return the version of the DejaGnu framework.
6245 # The return value is a list containing the major, minor and patch version
6246 # numbers. If the version does not contain a minor or patch number, they will
6247 # be set to 0. For example:
6253 proc dejagnu_version { } {
6254 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6255 global frame_version
6257 verbose -log "DejaGnu version: $frame_version"
6258 verbose -log "Expect version: [exp_version]"
6259 verbose -log "Tcl version: [info tclversion]"
6261 set dg_ver [split $frame_version .]
6263 while { [llength $dg_ver] < 3 } {
6270 # Define user-defined command COMMAND using the COMMAND_LIST as the
6271 # command's definition. The terminating "end" is added automatically.
6273 proc gdb_define_cmd {command command_list} {
6276 set input [multi_line_input {*}$command_list "end"]
6277 set test "define $command"
6279 gdb_test_multiple "define $command" $test {
6281 gdb_test_multiple $input $test {
6282 -re "\r\n$gdb_prompt " {
6289 # Always load compatibility stuff.