1 # Copyright 1992-2019 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
89 # absolute path ie. /foo/
90 set fullname_syntax_POSIX {/[^\n]*/}
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
92 # UNC path ie. \\D\foo\
93 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
96 # ie. \foo\, but don't match \\.*\
97 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
99 # ie. a:\foo\ && a:foo\
100 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
103 # d:foo and \abc should be considered valid as an absolute path.
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
112 if ![info exists env(EXEEXT)] {
115 set EXEEXT $env(EXEEXT)
120 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
122 # A regular expression that matches a value history number.
124 set valnum_re "\\\$$decimal"
126 ### Only procedures should come after this point.
129 # gdb_version -- extract and print the version number of GDB
131 proc default_gdb_version {} {
133 global INTERNAL_GDBFLAGS GDBFLAGS
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
144 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
145 if ![is_remote host] {
146 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
148 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
152 proc gdb_version { } {
153 return [default_gdb_version]
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
173 -re "Discard symbol table from .*y or n.*$" {
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # The second pattern below matches up to the first newline *only*.
246 # Using ``.*$'' could swallow up output that we attempt to match
249 # N.B. This function does not wait for gdb to return to the prompt,
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
256 send_gdb "$command\n"
258 -re "$gdb_prompt $" { }
260 perror "gdb_init_command for target failed"
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
271 send_gdb "continue\n"
273 -re "Continu\[^\r\n\]*\[\r\n\]" {}
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
284 send_gdb "jump *$start\n"
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
290 if [expr $start_attempt > 3] {
291 perror "Jump to start() failed (retry count exceeded)"
294 set start_attempt [expr $start_attempt + 1]
296 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
299 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
300 perror "Can't find start symbol to run in gdb_run"
303 -re "No symbol \"start\" in current.*$gdb_prompt $" {
304 send_gdb "jump *_start\n"
306 -re "No symbol.*context.*$gdb_prompt $" {
309 -re "Line.* Jump anyway.*y or n. $" {
312 -re "The program is not being run.*$gdb_prompt $" {
313 if { [gdb_reload] != 0 } {
316 send_gdb "jump *$start\n"
319 perror "Jump to start() failed (timeout)"
327 if [target_info exists gdb,do_reload_on_run] {
328 if { [gdb_reload] != 0 } {
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
337 -re "The program .* has been started already.*y or n. $" {
341 -notransfer -re "Starting program: \[^\r\n\]*" {}
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
348 # Generic start command. Return 0 if we could start the program, -1
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
354 proc gdb_start_cmd {args} {
355 global gdb_prompt use_gdb_stub
357 foreach command [gdb_init_commands] {
358 send_gdb "$command\n"
360 -re "$gdb_prompt $" { }
362 perror "gdb_init_command for target failed"
372 send_gdb "start $args\n"
373 # Use -notransfer here so that test cases (like chng-sym.exp)
374 # may test for additional start-up messages.
376 -re "The program .* has been started already.*y or n. $" {
380 -notransfer -re "Starting program: \[^\r\n\]*" {
387 # Generic starti command. Return 0 if we could start the program, -1
390 # N.B. This function does not wait for gdb to return to the prompt,
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
397 send_gdb "$command\n"
399 -re "$gdb_prompt $" { }
401 perror "gdb_init_command for target failed"
411 send_gdb "starti $args\n"
413 -re "The program .* has been started already.*y or n. $" {
417 -re "Starting program: \[^\r\n\]*" {
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
429 # Note: The handling of message vs no-message is messed up, but it's based
430 # on historical usage. By default this function does not print passes,
432 # no-message: turns off printing of fails (and passes, but they're already off)
433 # message: turns on printing of passes (and fails, but they're already on)
435 proc gdb_breakpoint { function args } {
439 set pending_response n
440 if {[lsearch -exact $args allow-pending] != -1} {
441 set pending_response y
444 set break_command "break"
445 set break_message "Breakpoint"
446 if {[lsearch -exact $args temporary] != -1} {
447 set break_command "tbreak"
448 set break_message "Temporary breakpoint"
451 if {[lsearch -exact $args qualified] != -1} {
452 append break_command " -qualified"
457 set no_message_loc [lsearch -exact $args no-message]
458 set message_loc [lsearch -exact $args message]
459 # The last one to appear in args wins.
460 if { $no_message_loc > $message_loc } {
462 } elseif { $message_loc > $no_message_loc } {
466 set test_name "setting breakpoint at $function"
468 send_gdb "$break_command $function\n"
469 # The first two regexps are what we get with -g, the third is without -g.
471 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
474 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
475 if {$pending_response == "n"} {
482 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
483 send_gdb "$pending_response\n"
486 -re "A problem internal to GDB has been detected" {
488 fail "$test_name (GDB internal error)"
490 gdb_internal_error_resync
493 -re "$gdb_prompt $" {
501 fail "$test_name (eof)"
507 fail "$test_name (timeout)"
518 # Set breakpoint at function and run gdb until it breaks there.
519 # Since this is the only breakpoint that will be set, if it stops
520 # at a breakpoint, we will assume it is the one we want. We can't
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
529 # no-message: turns off printing of fails (and passes, but they're already off)
530 # message: turns on printing of passes (and fails, but they're already on)
532 proc runto { function args } {
538 # Default to "no-message".
539 set args "no-message $args"
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
548 } elseif { $message_loc > $no_message_loc } {
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
557 # elements, and we don't want Tcl to move the remaining elements after
558 # the first to $args. That is why $function is wrapped in {}.
559 if ![eval gdb_breakpoint {$function} $args] {
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
568 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
574 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
580 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
582 unsupported "non-stop mode not supported"
586 -re ".*A problem internal to GDB has been detected" {
588 fail "$test_name (GDB internal error)"
590 gdb_internal_error_resync
593 -re "$gdb_prompt $" {
601 fail "$test_name (eof)"
607 fail "$test_name (timeout)"
618 # Ask gdb to run until we hit a breakpoint at main.
620 # N.B. This function deletes all existing breakpoints.
621 # If you don't want that, use gdb_start_cmd.
623 proc runto_main { } {
624 return [runto main no-message]
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
634 set full_name "continue to breakpoint: $name"
636 gdb_test_multiple "continue" $full_name {
637 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
644 # gdb_internal_error_resync:
646 # Answer the questions GDB asks after it reports an internal error
647 # until we get back to a GDB prompt. Decline to quit the debugging
648 # session, and decline to create a core file. Return non-zero if the
651 # This procedure just answers whatever questions come up until it sees
652 # a GDB prompt; it doesn't require you to have matched the input up to
653 # any specific point. However, it only answers questions it sees in
654 # the output itself, so if you've matched a question, you had better
655 # answer it yourself before calling this.
657 # You can use this function thus:
661 # -re ".*A problem internal to GDB has been detected" {
662 # gdb_internal_error_resync
667 proc gdb_internal_error_resync {} {
670 verbose -log "Resyncing due to internal error."
673 while {$count < 10} {
675 -re "Quit this debugging session\\? \\(y or n\\) $" {
679 -re "Create a core file of GDB\\? \\(y or n\\) $" {
683 -re "$gdb_prompt $" {
684 # We're resynchronized.
688 perror "Could not resync from internal error (timeout)"
693 perror "Could not resync from internal error (resync count exceeded)"
698 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
699 # Send a command to gdb; test the result.
701 # COMMAND is the command to execute, send to GDB with send_gdb. If
702 # this is the null string no command is sent.
703 # MESSAGE is a message to be printed with the built-in failure patterns
704 # if one of them matches. If MESSAGE is empty COMMAND will be used.
705 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
706 # patterns. Pattern elements will be evaluated in the caller's
707 # context; action elements will be executed in the caller's context.
708 # Unlike patterns for gdb_test, these patterns should generally include
709 # the final newline and prompt.
712 # 1 if the test failed, according to a built-in failure pattern
713 # 0 if only user-supplied patterns matched
714 # -1 if there was an internal error.
716 # You can use this function thus:
718 # gdb_test_multiple "print foo" "test foo" {
719 # -re "expected output 1" {
722 # -re "expected output 2" {
727 # Like with "expect", you can also specify the spawn id to match with
728 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
729 # $gdb_spawn_id. The former matches inferior I/O, while the latter
730 # matches GDB I/O. E.g.:
732 # send_inferior "hello\n"
733 # gdb_test_multiple "continue" "test echo" {
734 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
737 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
738 # fail "hit breakpoint"
742 # The standard patterns, such as "Inferior exited..." and "A problem
743 # ...", all being implicitly appended to that list. These are always
744 # expected from $gdb_spawn_id. IOW, callers do not need to worry
745 # about resetting "-i" back to $gdb_spawn_id explicitly.
747 proc gdb_test_multiple { command message user_code } {
748 global verbose use_gdb_stub
749 global gdb_prompt pagination_prompt
752 global inferior_exited_re
753 upvar timeout timeout
754 upvar expect_out expect_out
757 if { $message == "" } {
761 if [string match "*\[\r\n\]" $command] {
762 error "Invalid trailing newline in \"$message\" test"
765 if [string match "*\[\r\n\]*" $message] {
766 error "Invalid newline in \"$message\" test"
770 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
772 error "gdbserver does not support $command without extended-remote"
775 # TCL/EXPECT WART ALERT
776 # Expect does something very strange when it receives a single braced
777 # argument. It splits it along word separators and performs substitutions.
778 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
779 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
780 # double-quoted list item, "\[ab\]" is just a long way of representing
781 # "[ab]", because the backslashes will be removed by lindex.
783 # Unfortunately, there appears to be no easy way to duplicate the splitting
784 # that expect will do from within TCL. And many places make use of the
785 # "\[0-9\]" construct, so we need to support that; and some places make use
786 # of the "[func]" construct, so we need to support that too. In order to
787 # get this right we have to substitute quoted list elements differently
788 # from braced list elements.
790 # We do this roughly the same way that Expect does it. We have to use two
791 # lists, because if we leave unquoted newlines in the argument to uplevel
792 # they'll be treated as command separators, and if we escape newlines
793 # we mangle newlines inside of command blocks. This assumes that the
794 # input doesn't contain a pattern which contains actual embedded newlines
797 regsub -all {\n} ${user_code} { } subst_code
798 set subst_code [uplevel list $subst_code]
800 set processed_code ""
802 set expecting_action 0
804 foreach item $user_code subst_item $subst_code {
805 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
806 lappend processed_code $item
809 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
810 lappend processed_code $item
813 if { $item == "-timeout" || $item == "-i" } {
815 lappend processed_code $item
818 if { $expecting_arg } {
820 lappend processed_code $subst_item
823 if { $expecting_action } {
824 lappend processed_code "uplevel [list $item]"
825 set expecting_action 0
826 # Cosmetic, no effect on the list.
827 append processed_code "\n"
830 set expecting_action 1
831 lappend processed_code $subst_item
832 if {$patterns != ""} {
835 append patterns "\"$subst_item\""
838 # Also purely cosmetic.
839 regsub -all {\r} $patterns {\\r} patterns
840 regsub -all {\n} $patterns {\\n} patterns
843 send_user "Sending \"$command\" to gdb\n"
844 send_user "Looking to match \"$patterns\"\n"
845 send_user "Message is \"$message\"\n"
849 set string "${command}\n"
850 if { $command != "" } {
851 set multi_line_re "\[\r\n\] *>"
852 while { "$string" != "" } {
853 set foo [string first "\n" "$string"]
854 set len [string length "$string"]
855 if { $foo < [expr $len - 1] } {
856 set str [string range "$string" 0 $foo]
857 if { [send_gdb "$str"] != "" } {
860 if { ! $suppress_flag } {
861 perror "Couldn't send $command to GDB."
866 # since we're checking if each line of the multi-line
867 # command are 'accepted' by GDB here,
868 # we need to set -notransfer expect option so that
869 # command output is not lost for pattern matching
872 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
873 timeout { verbose "partial: timeout" 3 }
875 set string [string range "$string" [expr $foo + 1] end]
876 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
881 if { "$string" != "" } {
882 if { [send_gdb "$string"] != "" } {
885 if { ! $suppress_flag } {
886 perror "Couldn't send $command to GDB."
895 -re ".*A problem internal to GDB has been detected" {
896 fail "$message (GDB internal error)"
897 gdb_internal_error_resync
900 -re "\\*\\*\\* DOSEXIT code.*" {
901 if { $message != "" } {
904 gdb_suppress_entire_file "GDB died"
908 append code $processed_code
910 # Reset the spawn id, in case the processed code used -i.
916 -re "Ending remote debugging.*$gdb_prompt $" {
917 if ![isnative] then {
918 warning "Can`t communicate to remote target."
924 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
925 perror "Undefined command \"$command\"."
929 -re "Ambiguous command.*$gdb_prompt $" {
930 perror "\"$command\" is not a unique command name."
934 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
935 if ![string match "" $message] then {
936 set errmsg "$message (the program exited)"
938 set errmsg "$command (the program exited)"
943 -re "$inferior_exited_re normally.*$gdb_prompt $" {
944 if ![string match "" $message] then {
945 set errmsg "$message (the program exited)"
947 set errmsg "$command (the program exited)"
952 -re "The program is not being run.*$gdb_prompt $" {
953 if ![string match "" $message] then {
954 set errmsg "$message (the program is no longer running)"
956 set errmsg "$command (the program is no longer running)"
961 -re "\r\n$gdb_prompt $" {
962 if ![string match "" $message] then {
967 -re "$pagination_prompt" {
969 perror "Window too small."
973 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
975 gdb_expect -re "$gdb_prompt $"
976 fail "$message (got interactive prompt)"
979 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
981 gdb_expect -re "$gdb_prompt $"
982 fail "$message (got breakpoint menu)"
988 perror "GDB process no longer exists"
989 set wait_status [wait -i $gdb_spawn_id]
990 verbose -log "GDB process exited with wait status $wait_status"
991 if { $message != "" } {
998 # Now patterns that apply to any spawn id specified.
1002 perror "Process no longer exists"
1003 if { $message != "" } {
1009 perror "internal buffer is full."
1014 if ![string match "" $message] then {
1015 fail "$message (timeout)"
1021 # remote_expect calls the eof section if there is an error on the
1022 # expect call. We already have eof sections above, and we don't
1023 # want them to get called in that situation. Since the last eof
1024 # section becomes the error section, here we define another eof
1025 # section, but with an empty spawn_id list, so that it won't ever
1029 # This comment is here because the eof section must not be
1030 # the empty string, otherwise remote_expect won't realize
1036 set code [catch {gdb_expect $code} string]
1038 global errorInfo errorCode
1039 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1040 } elseif {$code > 1} {
1041 return -code $code $string
1046 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1047 # Send a command to gdb; test the result.
1049 # COMMAND is the command to execute, send to GDB with send_gdb. If
1050 # this is the null string no command is sent.
1051 # PATTERN is the pattern to match for a PASS, and must NOT include
1052 # the \r\n sequence immediately before the gdb prompt. This argument
1053 # may be omitted to just match the prompt, ignoring whatever output
1055 # MESSAGE is an optional message to be printed. If this is
1056 # omitted, then the pass/fail messages use the command string as the
1057 # message. (If this is the empty string, then sometimes we don't
1058 # call pass or fail at all; I don't understand this at all.)
1059 # QUESTION is a question GDB may ask in response to COMMAND, like
1061 # RESPONSE is the response to send if QUESTION appears.
1064 # 1 if the test failed,
1065 # 0 if the test passes,
1066 # -1 if there was an internal error.
1068 proc gdb_test { args } {
1070 upvar timeout timeout
1072 if [llength $args]>2 then {
1073 set message [lindex $args 2]
1075 set message [lindex $args 0]
1077 set command [lindex $args 0]
1078 set pattern [lindex $args 1]
1080 if [llength $args]==5 {
1081 set question_string [lindex $args 3]
1082 set response_string [lindex $args 4]
1084 set question_string "^FOOBAR$"
1087 return [gdb_test_multiple $command $message {
1088 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1089 if ![string match "" $message] then {
1093 -re "(${question_string})$" {
1094 send_gdb "$response_string\n"
1100 # gdb_test_no_output COMMAND MESSAGE
1101 # Send a command to GDB and verify that this command generated no output.
1103 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1104 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1105 # the message. (If MESSAGE is the empty string, then sometimes we do not
1106 # call pass or fail at all; I don't understand this at all.)
1108 proc gdb_test_no_output { args } {
1110 set command [lindex $args 0]
1111 if [llength $args]>1 then {
1112 set message [lindex $args 1]
1114 set message $command
1117 set command_regex [string_to_regexp $command]
1118 gdb_test_multiple $command $message {
1119 -re "^$command_regex\r\n$gdb_prompt $" {
1120 if ![string match "" $message] then {
1127 # Send a command and then wait for a sequence of outputs.
1128 # This is useful when the sequence is long and contains ".*", a single
1129 # regexp to match the entire output can get a timeout much easier.
1131 # COMMAND is the command to execute, send to GDB with send_gdb. If
1132 # this is the null string no command is sent.
1133 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1134 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1135 # processed in order, and all must be present in the output.
1137 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1138 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1139 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1141 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1142 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1145 # 1 if the test failed,
1146 # 0 if the test passes,
1147 # -1 if there was an internal error.
1149 proc gdb_test_sequence { command test_name expected_output_list } {
1151 if { $test_name == "" } {
1152 set test_name $command
1154 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1155 if { $command != "" } {
1156 send_gdb "$command\n"
1158 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1162 # Test that a command gives an error. For pass or fail, return
1163 # a 1 to indicate that more tests can proceed. However a timeout
1164 # is a serious error, generates a special fail message, and causes
1165 # a 0 to be returned to indicate that more tests are likely to fail
1168 proc test_print_reject { args } {
1172 if [llength $args]==2 then {
1173 set expectthis [lindex $args 1]
1175 set expectthis "should never match this bogus string"
1177 set sendthis [lindex $args 0]
1178 if $verbose>2 then {
1179 send_user "Sending \"$sendthis\" to gdb\n"
1180 send_user "Looking to match \"$expectthis\"\n"
1182 send_gdb "$sendthis\n"
1183 #FIXME: Should add timeout as parameter.
1185 -re "A .* in expression.*\\.*$gdb_prompt $" {
1186 pass "reject $sendthis"
1189 -re "Invalid syntax in expression.*$gdb_prompt $" {
1190 pass "reject $sendthis"
1193 -re "Junk after end of expression.*$gdb_prompt $" {
1194 pass "reject $sendthis"
1197 -re "Invalid number.*$gdb_prompt $" {
1198 pass "reject $sendthis"
1201 -re "Invalid character constant.*$gdb_prompt $" {
1202 pass "reject $sendthis"
1205 -re "No symbol table is loaded.*$gdb_prompt $" {
1206 pass "reject $sendthis"
1209 -re "No symbol .* in current context.*$gdb_prompt $" {
1210 pass "reject $sendthis"
1213 -re "Unmatched single quote.*$gdb_prompt $" {
1214 pass "reject $sendthis"
1217 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1218 pass "reject $sendthis"
1221 -re "$expectthis.*$gdb_prompt $" {
1222 pass "reject $sendthis"
1225 -re ".*$gdb_prompt $" {
1226 fail "reject $sendthis"
1230 fail "reject $sendthis (eof or timeout)"
1237 # Same as gdb_test, but the second parameter is not a regexp,
1238 # but a string that must match exactly.
1240 proc gdb_test_exact { args } {
1241 upvar timeout timeout
1243 set command [lindex $args 0]
1245 # This applies a special meaning to a null string pattern. Without
1246 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1247 # messages from commands that should have no output except a new
1248 # prompt. With this, only results of a null string will match a null
1251 set pattern [lindex $args 1]
1252 if [string match $pattern ""] {
1253 set pattern [string_to_regexp [lindex $args 0]]
1255 set pattern [string_to_regexp [lindex $args 1]]
1258 # It is most natural to write the pattern argument with only
1259 # embedded \n's, especially if you are trying to avoid Tcl quoting
1260 # problems. But gdb_expect really wants to see \r\n in patterns. So
1261 # transform the pattern here. First transform \r\n back to \n, in
1262 # case some users of gdb_test_exact already do the right thing.
1263 regsub -all "\r\n" $pattern "\n" pattern
1264 regsub -all "\n" $pattern "\r\n" pattern
1265 if [llength $args]==3 then {
1266 set message [lindex $args 2]
1268 set message $command
1271 return [gdb_test $command $pattern $message]
1274 # Wrapper around gdb_test_multiple that looks for a list of expected
1275 # output elements, but which can appear in any order.
1276 # CMD is the gdb command.
1277 # NAME is the name of the test.
1278 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1280 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1281 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1282 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1284 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1285 # of text per element and then strip trailing \r\n's.
1287 # gdb_test_list_exact "foo" "bar" \
1288 # "\[^\r\n\]+\[\r\n\]+" \
1291 # {expected result 1} \
1292 # {expected result 2} \
1295 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1298 set matches [lsort $result_match_list]
1300 gdb_test_multiple $cmd $name {
1301 "$cmd\[\r\n\]" { exp_continue }
1302 -re $elm_find_regexp {
1303 set str $expect_out(0,string)
1304 verbose -log "seen: $str" 3
1305 regexp -- $elm_extract_regexp $str elm_seen
1306 verbose -log "extracted: $elm_seen" 3
1307 lappend seen $elm_seen
1310 -re "$gdb_prompt $" {
1312 foreach got [lsort $seen] have $matches {
1313 if {![string equal $got $have]} {
1318 if {[string length $failed] != 0} {
1319 fail "$name ($failed not found)"
1327 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1328 # Send a command to gdb; expect inferior and gdb output.
1330 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1333 # INFERIOR_PATTERN is the pattern to match against inferior output.
1335 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1336 # include the \r\n sequence immediately before the gdb prompt, nor the
1337 # prompt. The default is empty.
1339 # Both inferior and gdb patterns must match for a PASS.
1341 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1344 # 1 if the test failed,
1345 # 0 if the test passes,
1346 # -1 if there was an internal error.
1349 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1350 global inferior_spawn_id gdb_spawn_id
1353 if {$message == ""} {
1354 set message $command
1357 set inferior_matched 0
1360 # Use an indirect spawn id list, and remove the inferior spawn id
1361 # from the expected output as soon as it matches, in case
1362 # $inferior_pattern happens to be a prefix of the resulting full
1363 # gdb pattern below (e.g., "\r\n").
1364 global gdb_test_stdio_spawn_id_list
1365 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1367 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1368 # then we may see gdb's output arriving before the inferior's
1370 set res [gdb_test_multiple $command $message {
1371 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1372 set inferior_matched 1
1373 if {!$gdb_matched} {
1374 set gdb_test_stdio_spawn_id_list ""
1378 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1380 if {!$inferior_matched} {
1388 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1395 # Issue a PASS and return true if evaluating CONDITION in the caller's
1396 # frame returns true, and issue a FAIL and return false otherwise.
1397 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1398 # omitted or is empty, then the pass/fail messages use the condition
1399 # string as the message.
1401 proc gdb_assert { condition {message ""} } {
1402 if { $message == ""} {
1403 set message $condition
1406 set res [uplevel 1 expr $condition]
1415 proc gdb_reinitialize_dir { subdir } {
1418 if [is_remote host] {
1423 -re "Reinitialize source path to empty.*y or n. " {
1426 -re "Source directories searched.*$gdb_prompt $" {
1427 send_gdb "dir $subdir\n"
1429 -re "Source directories searched.*$gdb_prompt $" {
1430 verbose "Dir set to $subdir"
1432 -re "$gdb_prompt $" {
1433 perror "Dir \"$subdir\" failed."
1437 -re "$gdb_prompt $" {
1438 perror "Dir \"$subdir\" failed."
1442 -re "$gdb_prompt $" {
1443 perror "Dir \"$subdir\" failed."
1449 # gdb_exit -- exit the GDB, killing the target program if necessary
1451 proc default_gdb_exit {} {
1453 global INTERNAL_GDBFLAGS GDBFLAGS
1455 global gdb_spawn_id inferior_spawn_id
1456 global inotify_log_file
1458 gdb_stop_suppressing_tests
1460 if ![info exists gdb_spawn_id] {
1464 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1466 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1467 set fd [open $inotify_log_file]
1468 set data [read -nonewline $fd]
1471 if {[string compare $data ""] != 0} {
1472 warning "parallel-unsafe file creations noticed"
1475 set fd [open $inotify_log_file w]
1480 if { [is_remote host] && [board_info host exists fileid] } {
1487 -re "DOSEXIT code" { }
1492 if ![is_remote host] {
1496 unset inferior_spawn_id
1499 # Load a file into the debugger.
1500 # The return value is 0 for success, -1 for failure.
1502 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1503 # to one of these values:
1505 # debug file was loaded successfully and has debug information
1506 # nodebug file was loaded successfully and has no debug information
1507 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1509 # fail file was not loaded
1511 # I tried returning this information as part of the return value,
1512 # but ran into a mess because of the many re-implementations of
1513 # gdb_load in config/*.exp.
1515 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1516 # this if they can get more information set.
1518 proc gdb_file_cmd { arg } {
1522 global last_loaded_file
1524 # Save this for the benefit of gdbserver-support.exp.
1525 set last_loaded_file $arg
1527 # Set whether debug info was found.
1528 # Default to "fail".
1529 global gdb_file_cmd_debug_info
1530 set gdb_file_cmd_debug_info "fail"
1532 if [is_remote host] {
1533 set arg [remote_download host $arg]
1535 perror "download failed"
1540 # The file command used to kill the remote target. For the benefit
1541 # of the testsuite, preserve this behavior.
1544 -re "Kill the program being debugged. .y or n. $" {
1546 verbose "\t\tKilling previous program being debugged"
1549 -re "$gdb_prompt $" {
1554 send_gdb "file $arg\n"
1556 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1557 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1558 set gdb_file_cmd_debug_info "lzma"
1561 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1562 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1563 set gdb_file_cmd_debug_info "nodebug"
1566 -re "Reading symbols from.*$gdb_prompt $" {
1567 verbose "\t\tLoaded $arg into $GDB"
1568 set gdb_file_cmd_debug_info "debug"
1571 -re "Load new symbol table from \".*\".*y or n. $" {
1574 -re "Reading symbols from.*$gdb_prompt $" {
1575 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1576 set gdb_file_cmd_debug_info "debug"
1580 perror "Couldn't load $arg, other program already loaded (timeout)."
1584 perror "Couldn't load $arg, other program already loaded (eof)."
1589 -re "No such file or directory.*$gdb_prompt $" {
1590 perror "($arg) No such file or directory"
1593 -re "A problem internal to GDB has been detected" {
1594 fail "($arg) (GDB internal error)"
1595 gdb_internal_error_resync
1598 -re "$gdb_prompt $" {
1599 perror "Couldn't load $arg into $GDB."
1603 perror "Couldn't load $arg into $GDB (timeout)."
1607 # This is an attempt to detect a core dump, but seems not to
1608 # work. Perhaps we need to match .* followed by eof, in which
1609 # gdb_expect does not seem to have a way to do that.
1610 perror "Couldn't load $arg into $GDB (eof)."
1616 # Default gdb_spawn procedure.
1618 proc default_gdb_spawn { } {
1621 global INTERNAL_GDBFLAGS GDBFLAGS
1624 gdb_stop_suppressing_tests
1626 # Set the default value, it may be overriden later by specific testfile.
1628 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1629 # is already started after connecting and run/attach are not supported.
1630 # This is used for the "remote" protocol. After GDB starts you should
1631 # check global $use_gdb_stub instead of the board as the testfile may force
1632 # a specific different target protocol itself.
1633 set use_gdb_stub [target_info exists use_gdb_stub]
1635 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1637 if [info exists gdb_spawn_id] {
1641 if ![is_remote host] {
1642 if { [which $GDB] == 0 } then {
1643 perror "$GDB does not exist."
1647 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1648 if { $res < 0 || $res == "" } {
1649 perror "Spawning $GDB failed."
1653 set gdb_spawn_id $res
1657 # Default gdb_start procedure.
1659 proc default_gdb_start { } {
1662 global inferior_spawn_id
1664 if [info exists gdb_spawn_id] {
1673 # Default to assuming inferior I/O is done on GDB's terminal.
1674 if {![info exists inferior_spawn_id]} {
1675 set inferior_spawn_id $gdb_spawn_id
1678 # When running over NFS, particularly if running many simultaneous
1679 # tests on different hosts all using the same server, things can
1680 # get really slow. Give gdb at least 3 minutes to start up.
1682 -re "\[\r\n\]$gdb_prompt $" {
1683 verbose "GDB initialized."
1685 -re "$gdb_prompt $" {
1686 perror "GDB never initialized."
1691 perror "(timeout) GDB never initialized after 10 seconds."
1698 # force the height to "unlimited", so no pagers get used
1700 send_gdb "set height 0\n"
1702 -re "$gdb_prompt $" {
1703 verbose "Setting height to 0." 2
1706 warning "Couldn't set the height to 0"
1709 # force the width to "unlimited", so no wraparound occurs
1710 send_gdb "set width 0\n"
1712 -re "$gdb_prompt $" {
1713 verbose "Setting width to 0." 2
1716 warning "Couldn't set the width to 0."
1722 # Utility procedure to give user control of the gdb prompt in a script. It is
1723 # meant to be used for debugging test cases, and should not be left in the
1726 proc gdb_interact { } {
1728 set spawn_id $gdb_spawn_id
1730 send_user "+------------------------------------------+\n"
1731 send_user "| Script interrupted, you can now interact |\n"
1732 send_user "| with by gdb. Type >>> to continue. |\n"
1733 send_user "+------------------------------------------+\n"
1740 # Examine the output of compilation to determine whether compilation
1741 # failed or not. If it failed determine whether it is due to missing
1742 # compiler or due to compiler error. Report pass, fail or unsupported
1745 proc gdb_compile_test {src output} {
1746 if { $output == "" } {
1747 pass "compilation [file tail $src]"
1748 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1749 unsupported "compilation [file tail $src]"
1750 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1751 unsupported "compilation [file tail $src]"
1752 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1753 unsupported "compilation [file tail $src]"
1755 verbose -log "compilation failed: $output" 2
1756 fail "compilation [file tail $src]"
1760 # Return a 1 for configurations for which we don't even want to try to
1763 proc skip_cplus_tests {} {
1764 if { [istarget "h8300-*-*"] } {
1768 # The C++ IO streams are too large for HC11/HC12 and are thus not
1769 # available. The gdb C++ tests use them and don't compile.
1770 if { [istarget "m6811-*-*"] } {
1773 if { [istarget "m6812-*-*"] } {
1779 # Return a 1 for configurations for which don't have both C++ and the STL.
1781 proc skip_stl_tests {} {
1782 # Symbian supports the C++ language, but the STL is missing
1783 # (both headers and libraries).
1784 if { [istarget "arm*-*-symbianelf*"] } {
1788 return [skip_cplus_tests]
1791 # Return a 1 if I don't even want to try to test FORTRAN.
1793 proc skip_fortran_tests {} {
1797 # Return a 1 if I don't even want to try to test ada.
1799 proc skip_ada_tests {} {
1803 # Return a 1 if I don't even want to try to test GO.
1805 proc skip_go_tests {} {
1809 # Return a 1 if I don't even want to try to test D.
1811 proc skip_d_tests {} {
1815 # Return 1 to skip Rust tests, 0 to try them.
1816 proc skip_rust_tests {} {
1817 return [expr {![isnative]}]
1820 # Return a 1 for configurations that do not support Python scripting.
1821 # PROMPT_REGEXP is the expected prompt.
1823 proc skip_python_tests_prompt { prompt_regexp } {
1824 global gdb_py_is_py3k
1826 gdb_test_multiple "python print ('test')" "verify python support" {
1827 -re "not supported.*$prompt_regexp" {
1828 unsupported "Python support is disabled."
1831 -re "$prompt_regexp" {}
1834 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1835 -re "3.*$prompt_regexp" {
1836 set gdb_py_is_py3k 1
1838 -re ".*$prompt_regexp" {
1839 set gdb_py_is_py3k 0
1846 # Return a 1 for configurations that do not support Python scripting.
1847 # Note: This also sets various globals that specify which version of Python
1848 # is in use. See skip_python_tests_prompt.
1850 proc skip_python_tests {} {
1852 return [skip_python_tests_prompt "$gdb_prompt $"]
1855 # Return a 1 if we should skip shared library tests.
1857 proc skip_shlib_tests {} {
1858 # Run the shared library tests on native systems.
1863 # An abbreviated list of remote targets where we should be able to
1864 # run shared library tests.
1865 if {([istarget *-*-linux*]
1866 || [istarget *-*-*bsd*]
1867 || [istarget *-*-solaris2*]
1868 || [istarget arm*-*-symbianelf*]
1869 || [istarget *-*-mingw*]
1870 || [istarget *-*-cygwin*]
1871 || [istarget *-*-pe*])} {
1878 # Return 1 if we should skip tui related tests.
1880 proc skip_tui_tests {} {
1883 gdb_test_multiple "help layout" "verify tui support" {
1884 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1887 -re "$gdb_prompt $" {
1894 # Test files shall make sure all the test result lines in gdb.sum are
1895 # unique in a test run, so that comparing the gdb.sum files of two
1896 # test runs gives correct results. Test files that exercise
1897 # variations of the same tests more than once, shall prefix the
1898 # different test invocations with different identifying strings in
1899 # order to make them unique.
1901 # About test prefixes:
1903 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1904 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1905 # underlined substring in
1907 # PASS: gdb.base/mytest.exp: some test
1908 # ^^^^^^^^^^^^^^^^^^^^
1912 # The easiest way to adjust the test prefix is to append a test
1913 # variation prefix to the $pf_prefix, using the with_test_prefix
1916 # proc do_tests {} {
1917 # gdb_test ... ... "test foo"
1918 # gdb_test ... ... "test bar"
1920 # with_test_prefix "subvariation a" {
1921 # gdb_test ... ... "test x"
1924 # with_test_prefix "subvariation b" {
1925 # gdb_test ... ... "test x"
1929 # with_test_prefix "variation1" {
1930 # ...do setup for variation 1...
1934 # with_test_prefix "variation2" {
1935 # ...do setup for variation 2...
1941 # PASS: gdb.base/mytest.exp: variation1: test foo
1942 # PASS: gdb.base/mytest.exp: variation1: test bar
1943 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1944 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1945 # PASS: gdb.base/mytest.exp: variation2: test foo
1946 # PASS: gdb.base/mytest.exp: variation2: test bar
1947 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1948 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1950 # If for some reason more flexibility is necessary, one can also
1951 # manipulate the pf_prefix global directly, treating it as a string.
1955 # set saved_pf_prefix
1956 # append pf_prefix "${foo}: bar"
1957 # ... actual tests ...
1958 # set pf_prefix $saved_pf_prefix
1961 # Run BODY in the context of the caller, with the current test prefix
1962 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1963 # Returns the result of BODY.
1965 proc with_test_prefix { prefix body } {
1968 set saved $pf_prefix
1969 append pf_prefix " " $prefix ":"
1970 set code [catch {uplevel 1 $body} result]
1971 set pf_prefix $saved
1974 global errorInfo errorCode
1975 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1977 return -code $code $result
1981 # Wrapper for foreach that calls with_test_prefix on each iteration,
1982 # including the iterator's name and current value in the prefix.
1984 proc foreach_with_prefix {var list body} {
1986 foreach myvar $list {
1987 with_test_prefix "$var=$myvar" {
1993 # Like TCL's native proc, but defines a procedure that wraps its body
1994 # within 'with_test_prefix "$proc_name" { ... }'.
1995 proc proc_with_prefix {name arguments body} {
1996 # Define the advertised proc.
1997 proc $name $arguments [list with_test_prefix $name $body]
2001 # Run BODY in the context of the caller. After BODY is run, the variables
2002 # listed in VARS will be reset to the values they had before BODY was run.
2004 # This is useful for providing a scope in which it is safe to temporarily
2005 # modify global variables, e.g.
2007 # global INTERNAL_GDBFLAGS
2010 # set foo GDBHISTSIZE
2012 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2013 # append INTERNAL_GDBFLAGS " -nx"
2014 # unset -nocomplain env(GDBHISTSIZE)
2019 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2020 # modified inside BODY, this proc guarantees that the modifications will be
2021 # undone after BODY finishes executing.
2023 proc save_vars { vars body } {
2024 array set saved_scalars { }
2025 array set saved_arrays { }
2029 # First evaluate VAR in the context of the caller in case the variable
2030 # name may be a not-yet-interpolated string like env($foo)
2031 set var [uplevel 1 list $var]
2033 if [uplevel 1 [list info exists $var]] {
2034 if [uplevel 1 [list array exists $var]] {
2035 set saved_arrays($var) [uplevel 1 [list array get $var]]
2037 set saved_scalars($var) [uplevel 1 [list set $var]]
2040 lappend unset_vars $var
2044 set code [catch {uplevel 1 $body} result]
2046 foreach {var value} [array get saved_scalars] {
2047 uplevel 1 [list set $var $value]
2050 foreach {var value} [array get saved_arrays] {
2051 uplevel 1 [list unset $var]
2052 uplevel 1 [list array set $var $value]
2055 foreach var $unset_vars {
2056 uplevel 1 [list unset -nocomplain $var]
2060 global errorInfo errorCode
2061 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2063 return -code $code $result
2067 # Run tests in BODY with the current working directory (CWD) set to
2068 # DIR. When BODY is finished, restore the original CWD. Return the
2071 # This procedure doesn't check if DIR is a valid directory, so you
2072 # have to make sure of that.
2074 proc with_cwd { dir body } {
2076 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2079 set code [catch {uplevel 1 $body} result]
2081 verbose -log "Switching back to $saved_dir."
2085 global errorInfo errorCode
2086 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2088 return -code $code $result
2092 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2093 # PROMPT. When BODY is finished, restore GDB prompt and variable
2095 # Returns the result of BODY.
2099 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2100 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2101 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2102 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2103 # a) It's more intuitive for callers to pass the plain text form.
2104 # b) We need two forms of the prompt:
2105 # - a regexp to use in output matching,
2106 # - a value to pass to the "set prompt" command.
2107 # c) It's easier to convert the plain text form to its regexp form.
2109 # 2) Don't add a trailing space, we do that here.
2111 proc with_gdb_prompt { prompt body } {
2114 # Convert "(foo)" to "\(foo\)".
2115 # We don't use string_to_regexp because while it works today it's not
2116 # clear it will work tomorrow: the value we need must work as both a
2117 # regexp *and* as the argument to the "set prompt" command, at least until
2118 # we start recording both forms separately instead of just $gdb_prompt.
2119 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2121 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2123 set saved $gdb_prompt
2125 verbose -log "Setting gdb prompt to \"$prompt \"."
2126 set gdb_prompt $prompt
2127 gdb_test_no_output "set prompt $prompt " ""
2129 set code [catch {uplevel 1 $body} result]
2131 verbose -log "Restoring gdb prompt to \"$saved \"."
2132 set gdb_prompt $saved
2133 gdb_test_no_output "set prompt $saved " ""
2136 global errorInfo errorCode
2137 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2139 return -code $code $result
2143 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2144 # BODY is finished, restore target-charset.
2146 proc with_target_charset { target_charset body } {
2150 gdb_test_multiple "show target-charset" "" {
2151 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2152 set saved $expect_out(1,string)
2154 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2155 set saved $expect_out(1,string)
2157 -re ".*$gdb_prompt " {
2158 fail "get target-charset"
2162 gdb_test_no_output "set target-charset $target_charset" ""
2164 set code [catch {uplevel 1 $body} result]
2166 gdb_test_no_output "set target-charset $saved" ""
2169 global errorInfo errorCode
2170 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2172 return -code $code $result
2176 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2177 # mi_gdb_test etc. default to using it.
2179 proc switch_gdb_spawn_id {spawn_id} {
2181 global board board_info
2183 set gdb_spawn_id $spawn_id
2184 set board [host_info name]
2185 set board_info($board,fileid) $spawn_id
2188 # Clear the default spawn id.
2190 proc clear_gdb_spawn_id {} {
2192 global board board_info
2194 unset -nocomplain gdb_spawn_id
2195 set board [host_info name]
2196 unset -nocomplain board_info($board,fileid)
2199 # Run BODY with SPAWN_ID as current spawn id.
2201 proc with_spawn_id { spawn_id body } {
2204 if [info exists gdb_spawn_id] {
2205 set saved_spawn_id $gdb_spawn_id
2208 switch_gdb_spawn_id $spawn_id
2210 set code [catch {uplevel 1 $body} result]
2212 if [info exists saved_spawn_id] {
2213 switch_gdb_spawn_id $saved_spawn_id
2219 global errorInfo errorCode
2220 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2222 return -code $code $result
2226 # Select the largest timeout from all the timeouts:
2227 # - the local "timeout" variable of the scope two levels above,
2228 # - the global "timeout" variable,
2229 # - the board variable "gdb,timeout".
2231 proc get_largest_timeout {} {
2232 upvar #0 timeout gtimeout
2233 upvar 2 timeout timeout
2236 if [info exists timeout] {
2239 if { [info exists gtimeout] && $gtimeout > $tmt } {
2242 if { [target_info exists gdb,timeout]
2243 && [target_info gdb,timeout] > $tmt } {
2244 set tmt [target_info gdb,timeout]
2254 # Run tests in BODY with timeout increased by factor of FACTOR. When
2255 # BODY is finished, restore timeout.
2257 proc with_timeout_factor { factor body } {
2260 set savedtimeout $timeout
2262 set timeout [expr [get_largest_timeout] * $factor]
2263 set code [catch {uplevel 1 $body} result]
2265 set timeout $savedtimeout
2267 global errorInfo errorCode
2268 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2270 return -code $code $result
2274 # Return 1 if _Complex types are supported, otherwise, return 0.
2276 gdb_caching_proc support_complex_tests {
2278 if { [gdb_skip_float_test] } {
2279 # If floating point is not supported, _Complex is not
2284 # Compile a test program containing _Complex types.
2286 return [gdb_can_simple_compile complex {
2290 _Complex long double cld;
2296 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2299 proc supports_get_siginfo_type {} {
2300 if { [istarget "*-*-linux*"] } {
2307 # Return 1 if the target supports hardware single stepping.
2309 proc can_hardware_single_step {} {
2311 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2312 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2313 || [istarget "nios2-*-*"] } {
2320 # Return 1 if target hardware or OS supports single stepping to signal
2321 # handler, otherwise, return 0.
2323 proc can_single_step_to_signal_handler {} {
2324 # Targets don't have hardware single step. On these targets, when
2325 # a signal is delivered during software single step, gdb is unable
2326 # to determine the next instruction addresses, because start of signal
2327 # handler is one of them.
2328 return [can_hardware_single_step]
2331 # Return 1 if target supports process record, otherwise return 0.
2333 proc supports_process_record {} {
2335 if [target_info exists gdb,use_precord] {
2336 return [target_info gdb,use_precord]
2339 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2340 || [istarget "i\[34567\]86-*-linux*"]
2341 || [istarget "aarch64*-*-linux*"]
2342 || [istarget "powerpc*-*-linux*"]
2343 || [istarget "s390*-*-linux*"] } {
2350 # Return 1 if target supports reverse debugging, otherwise return 0.
2352 proc supports_reverse {} {
2354 if [target_info exists gdb,can_reverse] {
2355 return [target_info gdb,can_reverse]
2358 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2359 || [istarget "i\[34567\]86-*-linux*"]
2360 || [istarget "aarch64*-*-linux*"]
2361 || [istarget "powerpc*-*-linux*"]
2362 || [istarget "s390*-*-linux*"] } {
2369 # Return 1 if readline library is used.
2371 proc readline_is_used { } {
2374 gdb_test_multiple "show editing" "" {
2375 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2378 -re ".*$gdb_prompt $" {
2384 # Return 1 if target is ELF.
2385 gdb_caching_proc is_elf_target {
2386 set me "is_elf_target"
2388 set src { int foo () {return 0;} }
2389 if {![gdb_simple_compile elf_target $src]} {
2393 set fp_obj [open $obj "r"]
2394 fconfigure $fp_obj -translation binary
2395 set data [read $fp_obj]
2400 set ELFMAG "\u007FELF"
2402 if {[string compare -length 4 $data $ELFMAG] != 0} {
2403 verbose "$me: returning 0" 2
2407 verbose "$me: returning 1" 2
2411 # Return 1 if the memory at address zero is readable.
2413 gdb_caching_proc is_address_zero_readable {
2417 gdb_test_multiple "x 0" "" {
2418 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2421 -re ".*$gdb_prompt $" {
2429 # Produce source file NAME and write SOURCES into it.
2431 proc gdb_produce_source { name sources } {
2433 set f [open $name "w"]
2439 # Return 1 if target is ILP32.
2440 # This cannot be decided simply from looking at the target string,
2441 # as it might depend on externally passed compiler options like -m64.
2442 gdb_caching_proc is_ilp32_target {
2443 return [gdb_can_simple_compile is_ilp32_target {
2444 int dummy[sizeof (int) == 4
2445 && sizeof (void *) == 4
2446 && sizeof (long) == 4 ? 1 : -1];
2450 # Return 1 if target is LP64.
2451 # This cannot be decided simply from looking at the target string,
2452 # as it might depend on externally passed compiler options like -m64.
2453 gdb_caching_proc is_lp64_target {
2454 return [gdb_can_simple_compile is_lp64_target {
2455 int dummy[sizeof (int) == 4
2456 && sizeof (void *) == 8
2457 && sizeof (long) == 8 ? 1 : -1];
2461 # Return 1 if target has 64 bit addresses.
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_64_target {
2465 return [gdb_can_simple_compile is_64_target {
2466 int function(void) { return 3; }
2467 int dummy[sizeof (&function) == 8 ? 1 : -1];
2471 # Return 1 if target has x86_64 registers - either amd64 or x32.
2472 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2473 # just from the target string.
2474 gdb_caching_proc is_amd64_regs_target {
2475 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2479 return [gdb_can_simple_compile is_amd64_regs_target {
2489 # Return 1 if this target is an x86 or x86-64 with -m32.
2490 proc is_x86_like_target {} {
2491 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2494 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2497 # Return 1 if this target is an arm or aarch32 on aarch64.
2499 gdb_caching_proc is_aarch32_target {
2500 if { [istarget "arm*-*-*"] } {
2504 if { ![istarget "aarch64*-*-*"] } {
2511 lappend list "\tmov $reg, $reg"
2514 return [gdb_can_simple_compile aarch32 [join $list \n]]
2517 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2519 proc is_aarch64_target {} {
2520 if { ![istarget "aarch64*-*-*"] } {
2524 return [expr ![is_aarch32_target]]
2527 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2528 proc support_displaced_stepping {} {
2530 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2531 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2532 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2533 || [istarget "aarch64*-*-linux*"] } {
2540 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2541 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2543 gdb_caching_proc skip_altivec_tests {
2544 global srcdir subdir gdb_prompt inferior_exited_re
2546 set me "skip_altivec_tests"
2548 # Some simulators are known to not support VMX instructions.
2549 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2550 verbose "$me: target known to not support VMX, returning 1" 2
2554 # Make sure we have a compiler that understands altivec.
2555 if [get_compiler_info] {
2556 warning "Could not get compiler info"
2559 if [test_compiler_info gcc*] {
2560 set compile_flags "additional_flags=-maltivec"
2561 } elseif [test_compiler_info xlc*] {
2562 set compile_flags "additional_flags=-qaltivec"
2564 verbose "Could not compile with altivec support, returning 1" 2
2568 # Compile a test program containing VMX instructions.
2572 asm volatile ("vor v0,v0,v0");
2574 asm volatile ("vor 0,0,0");
2579 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2583 # Compilation succeeded so now run it via gdb.
2587 gdb_reinitialize_dir $srcdir/$subdir
2591 -re ".*Illegal instruction.*${gdb_prompt} $" {
2592 verbose -log "\n$me altivec hardware not detected"
2593 set skip_vmx_tests 1
2595 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2596 verbose -log "\n$me: altivec hardware detected"
2597 set skip_vmx_tests 0
2600 warning "\n$me: default case taken"
2601 set skip_vmx_tests 1
2605 remote_file build delete $obj
2607 verbose "$me: returning $skip_vmx_tests" 2
2608 return $skip_vmx_tests
2611 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2612 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2614 gdb_caching_proc skip_vsx_tests {
2615 global srcdir subdir gdb_prompt inferior_exited_re
2617 set me "skip_vsx_tests"
2619 # Some simulators are known to not support Altivec instructions, so
2620 # they won't support VSX instructions as well.
2621 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2622 verbose "$me: target known to not support VSX, returning 1" 2
2626 # Make sure we have a compiler that understands altivec.
2627 if [get_compiler_info] {
2628 warning "Could not get compiler info"
2631 if [test_compiler_info gcc*] {
2632 set compile_flags "additional_flags=-mvsx"
2633 } elseif [test_compiler_info xlc*] {
2634 set compile_flags "additional_flags=-qasm=gcc"
2636 verbose "Could not compile with vsx support, returning 1" 2
2640 # Compile a test program containing VSX instructions.
2643 double a[2] = { 1.0, 2.0 };
2645 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2647 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2652 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2656 # No error message, compilation succeeded so now run it via gdb.
2660 gdb_reinitialize_dir $srcdir/$subdir
2664 -re ".*Illegal instruction.*${gdb_prompt} $" {
2665 verbose -log "\n$me VSX hardware not detected"
2666 set skip_vsx_tests 1
2668 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2669 verbose -log "\n$me: VSX hardware detected"
2670 set skip_vsx_tests 0
2673 warning "\n$me: default case taken"
2674 set skip_vsx_tests 1
2678 remote_file build delete $obj
2680 verbose "$me: returning $skip_vsx_tests" 2
2681 return $skip_vsx_tests
2684 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2685 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2687 gdb_caching_proc skip_tsx_tests {
2688 global srcdir subdir gdb_prompt inferior_exited_re
2690 set me "skip_tsx_tests"
2692 # Compile a test program.
2695 asm volatile ("xbegin .L0");
2696 asm volatile ("xend");
2697 asm volatile (".L0: nop");
2701 if {![gdb_simple_compile $me $src executable]} {
2705 # No error message, compilation succeeded so now run it via gdb.
2709 gdb_reinitialize_dir $srcdir/$subdir
2713 -re ".*Illegal instruction.*${gdb_prompt} $" {
2714 verbose -log "$me: TSX hardware not detected."
2715 set skip_tsx_tests 1
2717 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2718 verbose -log "$me: TSX hardware detected."
2719 set skip_tsx_tests 0
2722 warning "\n$me: default case taken."
2723 set skip_tsx_tests 1
2727 remote_file build delete $obj
2729 verbose "$me: returning $skip_tsx_tests" 2
2730 return $skip_tsx_tests
2733 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2734 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2736 gdb_caching_proc skip_btrace_tests {
2737 global srcdir subdir gdb_prompt inferior_exited_re
2739 set me "skip_btrace_tests"
2740 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2741 verbose "$me: target does not support btrace, returning 1" 2
2745 # Compile a test program.
2746 set src { int main() { return 0; } }
2747 if {![gdb_simple_compile $me $src executable]} {
2751 # No error message, compilation succeeded so now run it via gdb.
2755 gdb_reinitialize_dir $srcdir/$subdir
2760 # In case of an unexpected output, we return 2 as a fail value.
2761 set skip_btrace_tests 2
2762 gdb_test_multiple "record btrace" "check btrace support" {
2763 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2764 set skip_btrace_tests 1
2766 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2767 set skip_btrace_tests 1
2769 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2770 set skip_btrace_tests 1
2772 -re "^record btrace\r\n$gdb_prompt $" {
2773 set skip_btrace_tests 0
2777 remote_file build delete $obj
2779 verbose "$me: returning $skip_btrace_tests" 2
2780 return $skip_btrace_tests
2783 # Run a test on the target to see if it supports btrace pt hardware.
2784 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2785 # from the GCC testsuite.
2787 gdb_caching_proc skip_btrace_pt_tests {
2788 global srcdir subdir gdb_prompt inferior_exited_re
2790 set me "skip_btrace_tests"
2791 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2792 verbose "$me: target does not support btrace, returning 1" 2
2796 # Compile a test program.
2797 set src { int main() { return 0; } }
2798 if {![gdb_simple_compile $me $src executable]} {
2802 # No error message, compilation succeeded so now run it via gdb.
2806 gdb_reinitialize_dir $srcdir/$subdir
2811 # In case of an unexpected output, we return 2 as a fail value.
2812 set skip_btrace_tests 2
2813 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2814 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2815 set skip_btrace_tests 1
2817 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2818 set skip_btrace_tests 1
2820 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2821 set skip_btrace_tests 1
2823 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2824 set skip_btrace_tests 1
2826 -re "^record btrace pt\r\n$gdb_prompt $" {
2827 set skip_btrace_tests 0
2831 remote_file build delete $obj
2833 verbose "$me: returning $skip_btrace_tests" 2
2834 return $skip_btrace_tests
2837 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2838 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2840 gdb_caching_proc skip_aarch64_sve_tests {
2841 global srcdir subdir gdb_prompt inferior_exited_re
2843 set me "skip_aarch64_sve_tests"
2845 if { ![is_aarch64_target]} {
2849 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2851 # Compile a test program containing SVE instructions.
2854 asm volatile ("ptrue p0.b");
2858 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2862 # Compilation succeeded so now run it via gdb.
2866 -re ".*Illegal instruction.*${gdb_prompt} $" {
2867 verbose -log "\n$me sve hardware not detected"
2868 set skip_sve_tests 1
2870 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2871 verbose -log "\n$me: sve hardware detected"
2872 set skip_sve_tests 0
2875 warning "\n$me: default case taken"
2876 set skip_sve_tests 1
2880 remote_file build delete $obj
2882 verbose "$me: returning $skip_sve_tests" 2
2883 return $skip_sve_tests
2887 # A helper that compiles a test case to see if __int128 is supported.
2888 proc gdb_int128_helper {lang} {
2889 return [gdb_can_simple_compile "i128-for-$lang" {
2891 int main() { return 0; }
2895 # Return true if the C compiler understands the __int128 type.
2896 gdb_caching_proc has_int128_c {
2897 return [gdb_int128_helper c]
2900 # Return true if the C++ compiler understands the __int128 type.
2901 gdb_caching_proc has_int128_cxx {
2902 return [gdb_int128_helper c++]
2905 # Return true if the IFUNC feature is unsupported.
2906 gdb_caching_proc skip_ifunc_tests {
2907 if [gdb_can_simple_compile ifunc {
2909 typedef void F (void);
2910 F* g (void) { return &f_; }
2911 void f () __attribute__ ((ifunc ("g")));
2919 # Return whether we should skip tests for showing inlined functions in
2920 # backtraces. Requires get_compiler_info and get_debug_format.
2922 proc skip_inline_frame_tests {} {
2923 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2924 if { ! [test_debug_format "DWARF 2"] } {
2928 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2929 if { ([test_compiler_info "gcc-2-*"]
2930 || [test_compiler_info "gcc-3-*"]
2931 || [test_compiler_info "gcc-4-0-*"]) } {
2938 # Return whether we should skip tests for showing variables from
2939 # inlined functions. Requires get_compiler_info and get_debug_format.
2941 proc skip_inline_var_tests {} {
2942 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2943 if { ! [test_debug_format "DWARF 2"] } {
2950 # Return a 1 if we should skip tests that require hardware breakpoints
2952 proc skip_hw_breakpoint_tests {} {
2953 # Skip tests if requested by the board (note that no_hardware_watchpoints
2954 # disables both watchpoints and breakpoints)
2955 if { [target_info exists gdb,no_hardware_watchpoints]} {
2959 # These targets support hardware breakpoints natively
2960 if { [istarget "i?86-*-*"]
2961 || [istarget "x86_64-*-*"]
2962 || [istarget "ia64-*-*"]
2963 || [istarget "arm*-*-*"]
2964 || [istarget "aarch64*-*-*"]
2965 || [istarget "s390*-*-*"] } {
2972 # Return a 1 if we should skip tests that require hardware watchpoints
2974 proc skip_hw_watchpoint_tests {} {
2975 # Skip tests if requested by the board
2976 if { [target_info exists gdb,no_hardware_watchpoints]} {
2980 # These targets support hardware watchpoints natively
2981 if { [istarget "i?86-*-*"]
2982 || [istarget "x86_64-*-*"]
2983 || [istarget "ia64-*-*"]
2984 || [istarget "arm*-*-*"]
2985 || [istarget "aarch64*-*-*"]
2986 || [istarget "powerpc*-*-linux*"]
2987 || [istarget "s390*-*-*"] } {
2994 # Return a 1 if we should skip tests that require *multiple* hardware
2995 # watchpoints to be active at the same time
2997 proc skip_hw_watchpoint_multi_tests {} {
2998 if { [skip_hw_watchpoint_tests] } {
3002 # These targets support just a single hardware watchpoint
3003 if { [istarget "arm*-*-*"]
3004 || [istarget "powerpc*-*-linux*"] } {
3011 # Return a 1 if we should skip tests that require read/access watchpoints
3013 proc skip_hw_watchpoint_access_tests {} {
3014 if { [skip_hw_watchpoint_tests] } {
3018 # These targets support just write watchpoints
3019 if { [istarget "s390*-*-*"] } {
3026 # Return 1 if we should skip tests that require the runtime unwinder
3027 # hook. This must be invoked while gdb is running, after shared
3028 # libraries have been loaded. This is needed because otherwise a
3029 # shared libgcc won't be visible.
3031 proc skip_unwinder_tests {} {
3035 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3036 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3038 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3041 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3045 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3046 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3049 -re "\r\n$gdb_prompt $" {
3056 # Return 0 if we should skip tests that require the libstdc++ stap
3057 # probes. This must be invoked while gdb is running, after shared
3058 # libraries have been loaded.
3060 proc skip_libstdcxx_probe_tests {} {
3064 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3065 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3068 -re "\r\n$gdb_prompt $" {
3074 # Return 1 if we should skip tests of the "compile" feature.
3075 # This must be invoked after the inferior has been started.
3077 proc skip_compile_feature_tests {} {
3081 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3082 "Could not load libcc1.*\r\n$gdb_prompt $" {
3085 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3088 -re "\r\n$gdb_prompt $" {
3094 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3095 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3096 # is a regexp that will match the output of "maint print target-stack" if
3097 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3098 # matching the expected prompt after the command output.
3100 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3101 set test "probe for target ${target_name}"
3102 gdb_test_multiple "maint print target-stack" $test {
3103 -re "${target_stack_regexp}${prompt_regexp}" {
3107 -re "$prompt_regexp" {
3114 # Helper for gdb_is_target_remote where the expected prompt is variable.
3116 proc gdb_is_target_remote_prompt { prompt_regexp } {
3117 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3120 # Check whether we're testing with the remote or extended-remote
3123 proc gdb_is_target_remote { } {
3126 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3129 # Check whether we're testing with the native target.
3131 proc gdb_is_target_native { } {
3134 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3137 # Return the effective value of use_gdb_stub.
3139 # If the use_gdb_stub global has been set (it is set when the gdb process is
3140 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3141 # property from the board file.
3143 # This is the preferred way of checking use_gdb_stub, since it allows to check
3144 # the value before the gdb has been spawned and it will return the correct value
3145 # even when it was overriden by the test.
3147 proc use_gdb_stub {} {
3150 if [info exists use_gdb_stub] {
3151 return $use_gdb_stub
3154 return [target_info exists use_gdb_stub]
3157 # Return 1 if the current remote target is an instance of our GDBserver, 0
3158 # otherwise. Return -1 if there was an error and we can't tell.
3160 gdb_caching_proc target_is_gdbserver {
3164 set test "probing for GDBserver"
3166 gdb_test_multiple "monitor help" $test {
3167 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3170 -re "$gdb_prompt $" {
3175 if { $is_gdbserver == -1 } {
3176 verbose -log "Unable to tell whether we are using GDBserver or not."
3179 return $is_gdbserver
3182 # N.B. compiler_info is intended to be local to this file.
3183 # Call test_compiler_info with no arguments to fetch its value.
3184 # Yes, this is counterintuitive when there's get_compiler_info,
3185 # but that's the current API.
3186 if [info exists compiler_info] {
3192 # Figure out what compiler I am using.
3193 # The result is cached so only the first invocation runs the compiler.
3195 # ARG can be empty or "C++". If empty, "C" is assumed.
3197 # There are several ways to do this, with various problems.
3199 # [ gdb_compile -E $ifile -o $binfile.ci ]
3200 # source $binfile.ci
3202 # Single Unix Spec v3 says that "-E -o ..." together are not
3203 # specified. And in fact, the native compiler on hp-ux 11 (among
3204 # others) does not work with "-E -o ...". Most targets used to do
3205 # this, and it mostly worked, because it works with gcc.
3207 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3208 # source $binfile.ci
3210 # This avoids the problem with -E and -o together. This almost works
3211 # if the build machine is the same as the host machine, which is
3212 # usually true of the targets which are not gcc. But this code does
3213 # not figure which compiler to call, and it always ends up using the C
3214 # compiler. Not good for setting hp_aCC_compiler. Target
3215 # hppa*-*-hpux* used to do this.
3217 # [ gdb_compile -E $ifile > $binfile.ci ]
3218 # source $binfile.ci
3220 # dejagnu target_compile says that it supports output redirection,
3221 # but the code is completely different from the normal path and I
3222 # don't want to sweep the mines from that path. So I didn't even try
3225 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3228 # I actually do this for all targets now. gdb_compile runs the right
3229 # compiler, and TCL captures the output, and I eval the output.
3231 # Unfortunately, expect logs the output of the command as it goes by,
3232 # and dejagnu helpfully prints a second copy of it right afterwards.
3233 # So I turn off expect logging for a moment.
3235 # [ gdb_compile $ifile $ciexe_file executable $args ]
3236 # [ remote_exec $ciexe_file ]
3237 # [ source $ci_file.out ]
3239 # I could give up on -E and just do this.
3240 # I didn't get desperate enough to try this.
3242 # -- chastain 2004-01-06
3244 proc get_compiler_info {{arg ""}} {
3245 # For compiler.c and compiler.cc
3248 # I am going to play with the log to keep noise out.
3252 # These come from compiler.c or compiler.cc
3253 global compiler_info
3255 # Legacy global data symbols.
3258 if [info exists compiler_info] {
3263 # Choose which file to preprocess.
3264 set ifile "${srcdir}/lib/compiler.c"
3265 if { $arg == "c++" } {
3266 set ifile "${srcdir}/lib/compiler.cc"
3269 # Run $ifile through the right preprocessor.
3270 # Toggle gdb.log to keep the compiler output out of the log.
3271 set saved_log [log_file -info]
3273 if [is_remote host] {
3274 # We have to use -E and -o together, despite the comments
3275 # above, because of how DejaGnu handles remote host testing.
3276 set ppout "$outdir/compiler.i"
3277 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3278 set file [open $ppout r]
3279 set cppout [read $file]
3282 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3284 eval log_file $saved_log
3288 foreach cppline [ split "$cppout" "\n" ] {
3289 if { [ regexp "^#" "$cppline" ] } {
3291 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3293 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3295 verbose "get_compiler_info: $cppline" 2
3299 verbose -log "get_compiler_info: $cppline"
3304 # Set to unknown if for some reason compiler_info didn't get defined.
3305 if ![info exists compiler_info] {
3306 verbose -log "get_compiler_info: compiler_info not provided"
3307 set compiler_info "unknown"
3309 # Also set to unknown compiler if any diagnostics happened.
3311 verbose -log "get_compiler_info: got unexpected diagnostics"
3312 set compiler_info "unknown"
3315 # Set the legacy symbols.
3317 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3319 # Log what happened.
3320 verbose -log "get_compiler_info: $compiler_info"
3322 # Most compilers will evaluate comparisons and other boolean
3323 # operations to 0 or 1.
3324 uplevel \#0 { set true 1 }
3325 uplevel \#0 { set false 0 }
3330 # Return the compiler_info string if no arg is provided.
3331 # Otherwise the argument is a glob-style expression to match against
3334 proc test_compiler_info { {compiler ""} } {
3335 global compiler_info
3338 # If no arg, return the compiler_info string.
3339 if [string match "" $compiler] {
3340 return $compiler_info
3343 return [string match $compiler $compiler_info]
3346 proc current_target_name { } {
3348 if [info exists target_info(target,name)] {
3349 set answer $target_info(target,name)
3356 set gdb_wrapper_initialized 0
3357 set gdb_wrapper_target ""
3359 proc gdb_wrapper_init { args } {
3360 global gdb_wrapper_initialized
3361 global gdb_wrapper_file
3362 global gdb_wrapper_flags
3363 global gdb_wrapper_target
3365 if { $gdb_wrapper_initialized == 1 } { return; }
3367 if {[target_info exists needs_status_wrapper] && \
3368 [target_info needs_status_wrapper] != "0"} {
3369 set result [build_wrapper "testglue.o"]
3370 if { $result != "" } {
3371 set gdb_wrapper_file [lindex $result 0]
3372 set gdb_wrapper_flags [lindex $result 1]
3374 warning "Status wrapper failed to build."
3377 set gdb_wrapper_initialized 1
3378 set gdb_wrapper_target [current_target_name]
3381 # Determine options that we always want to pass to the compiler.
3382 gdb_caching_proc universal_compile_options {
3383 set me "universal_compile_options"
3386 set src [standard_temp_file ccopts[pid].c]
3387 set obj [standard_temp_file ccopts[pid].o]
3389 gdb_produce_source $src {
3390 int foo(void) { return 0; }
3393 # Try an option for disabling colored diagnostics. Some compilers
3394 # yield colored diagnostics by default (when run from a tty) unless
3395 # such an option is specified.
3396 set opt "additional_flags=-fdiagnostics-color=never"
3397 set lines [target_compile $src $obj object [list "quiet" $opt]]
3398 if [string match "" $lines] then {
3399 # Seems to have worked; use the option.
3400 lappend options $opt
3405 verbose "$me: returning $options" 2
3409 # Compile the code in $code to a file based on $name, using the flags
3410 # $compile_flag as well as debug, nowarning and quiet.
3411 # Return 1 if code can be compiled
3412 # Leave the file name of the resulting object in the upvar object.
3414 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3417 switch -regexp -- $type {
3431 set src [standard_temp_file $name-[pid].c]
3432 set obj [standard_temp_file $name-[pid].$postfix]
3433 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3435 gdb_produce_source $src $code
3437 verbose "$name: compiling testfile $src" 2
3438 set lines [gdb_compile $src $obj $type $compile_flags]
3442 if ![string match "" $lines] then {
3443 verbose "$name: compilation failed, returning 0" 2
3449 # Compile the code in $code to a file based on $name, using the flags
3450 # $compile_flag as well as debug, nowarning and quiet.
3451 # Return 1 if code can be compiled
3452 # Delete all created files and objects.
3454 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3455 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3456 file delete $temp_obj
3460 # Some targets need to always link a special object in. Save its path here.
3461 global gdb_saved_set_unbuffered_mode_obj
3462 set gdb_saved_set_unbuffered_mode_obj ""
3464 # Compile source files specified by SOURCE into a binary of type TYPE at path
3465 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3466 # parameter and most options are passed directly to it.
3468 # The type can be one of the following:
3470 # - object: Compile into an object file.
3471 # - executable: Compile and link into an executable.
3472 # - preprocess: Preprocess the source files.
3473 # - assembly: Generate assembly listing.
3475 # The following options are understood and processed by gdb_compile:
3477 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3478 # quirks to be able to use shared libraries.
3479 # - shlib_load: Link with appropriate libraries to allow the test to
3480 # dynamically load libraries at runtime. For example, on Linux, this adds
3481 # -ldl so that the test can use dlopen.
3482 # - nowarnings: Inhibit all compiler warnings.
3483 # - pie: Force creation of PIE executables.
3484 # - nopie: Prevent creation of PIE executables.
3486 # And here are some of the not too obscure options understood by DejaGnu that
3487 # influence the compilation:
3489 # - additional_flags=flag: Add FLAG to the compiler flags.
3490 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3491 # argument can be a file, in which case it's added to the sources, or a
3493 # - ldflags=flag: Add FLAG to the linker flags.
3494 # - incdir=path: Add PATH to the searched include directories.
3495 # - libdir=path: Add PATH to the linker searched directories.
3496 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3497 # - debug: Build with debug information.
3498 # - optimize: Build with optimization.
3500 proc gdb_compile {source dest type options} {
3501 global GDB_TESTCASE_OPTIONS
3502 global gdb_wrapper_file
3503 global gdb_wrapper_flags
3504 global gdb_wrapper_initialized
3507 global gdb_saved_set_unbuffered_mode_obj
3509 set outdir [file dirname $dest]
3511 # Add platform-specific options if a shared library was specified using
3512 # "shlib=librarypath" in OPTIONS.
3514 if {[lsearch -exact $options rust] != -1} {
3515 # -fdiagnostics-color is not a rustcc option.
3517 set new_options [universal_compile_options]
3521 set getting_compiler_info 0
3522 foreach opt $options {
3523 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3524 && $type == "executable"} {
3525 if [test_compiler_info "xlc-*"] {
3526 # IBM xlc compiler doesn't accept shared library named other
3527 # than .so: use "-Wl," to bypass this
3528 lappend source "-Wl,$shlib_name"
3529 } elseif { ([istarget "*-*-mingw*"]
3530 || [istarget *-*-cygwin*]
3531 || [istarget *-*-pe*])} {
3532 lappend source "${shlib_name}.a"
3534 lappend source $shlib_name
3536 if { $shlib_found == 0 } {
3538 if { ([istarget "*-*-mingw*"]
3539 || [istarget *-*-cygwin*]) } {
3540 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3542 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3543 # Undo debian's change in the default.
3544 # Put it at the front to not override any user-provided
3545 # value, and to make sure it appears in front of all the
3547 lappend new_options "early_flags=-Wl,--no-as-needed"
3550 } elseif { $opt == "shlib_load" && $type == "executable" } {
3552 } elseif { $opt == "getting_compiler_info" } {
3553 # If this is set, calling test_compiler_info will cause recursion.
3554 set getting_compiler_info 1
3556 lappend new_options $opt
3560 # Ensure stack protector is disabled for GCC, as this causes problems with
3561 # DWARF line numbering.
3562 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3563 # This option defaults to on for Debian/Ubuntu.
3564 if { $getting_compiler_info == 0
3565 && [test_compiler_info {gcc-*-*}]
3566 && !([test_compiler_info {gcc-[0-3]-*}]
3567 || [test_compiler_info {gcc-4-0-*}]) } {
3568 # Put it at the front to not override any user-provided value.
3569 lappend new_options "early_flags=-fno-stack-protector"
3572 # Because we link with libraries using their basename, we may need
3573 # (depending on the platform) to set a special rpath value, to allow
3574 # the executable to find the libraries it depends on.
3575 if { $shlib_load || $shlib_found } {
3576 if { ([istarget "*-*-mingw*"]
3577 || [istarget *-*-cygwin*]
3578 || [istarget *-*-pe*]) } {
3579 # Do not need anything.
3580 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3581 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3582 } elseif { [istarget arm*-*-symbianelf*] } {
3583 if { $shlib_load } {
3584 lappend new_options "libs=-ldl"
3587 if { $shlib_load } {
3588 lappend new_options "libs=-ldl"
3590 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3593 set options $new_options
3595 if [info exists GDB_TESTCASE_OPTIONS] {
3596 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3598 verbose "options are $options"
3599 verbose "source is $source $dest $type $options"
3601 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3603 if {[target_info exists needs_status_wrapper] && \
3604 [target_info needs_status_wrapper] != "0" && \
3605 [info exists gdb_wrapper_file]} {
3606 lappend options "libs=${gdb_wrapper_file}"
3607 lappend options "ldflags=${gdb_wrapper_flags}"
3610 # Replace the "nowarnings" option with the appropriate additional_flags
3611 # to disable compiler warnings.
3612 set nowarnings [lsearch -exact $options nowarnings]
3613 if {$nowarnings != -1} {
3614 if [target_info exists gdb,nowarnings_flag] {
3615 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3617 set flag "additional_flags=-w"
3619 set options [lreplace $options $nowarnings $nowarnings $flag]
3622 # Replace the "pie" option with the appropriate compiler and linker flags
3623 # to enable PIE executables.
3624 set pie [lsearch -exact $options pie]
3626 if [target_info exists gdb,pie_flag] {
3627 set flag "additional_flags=[target_info gdb,pie_flag]"
3629 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3630 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3631 # a maximum size. On other architectures the two flags are
3632 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3633 # onwards default GCC to using fPIE. If you do require fpie, then
3634 # it can be set using the pie_flag.
3635 set flag "additional_flags=-fPIE"
3637 set options [lreplace $options $pie $pie $flag]
3639 if [target_info exists gdb,pie_ldflag] {
3640 set flag "ldflags=[target_info gdb,pie_ldflag]"
3642 set flag "ldflags=-pie"
3644 lappend options "$flag"
3647 # Replace the "nopie" option with the appropriate linker flag to disable
3648 # PIE executables. There are no compiler flags for this option.
3649 set nopie [lsearch -exact $options nopie]
3651 if [target_info exists gdb,nopie_flag] {
3652 set flag "ldflags=[target_info gdb,nopie_flag]"
3654 set flag "ldflags=-no-pie"
3656 set options [lreplace $options $nopie $nopie $flag]
3659 if { $type == "executable" } {
3660 if { ([istarget "*-*-mingw*"]
3661 || [istarget "*-*-*djgpp"]
3662 || [istarget "*-*-cygwin*"])} {
3663 # Force output to unbuffered mode, by linking in an object file
3664 # with a global contructor that calls setvbuf.
3666 # Compile the special object seperatelly for two reasons:
3667 # 1) Insulate it from $options.
3668 # 2) Avoid compiling it for every gdb_compile invocation,
3669 # which is time consuming, especially if we're remote
3672 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3673 verbose "compiling gdb_saved_set_unbuffered_obj"
3674 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3675 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3677 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3678 if { $result != "" } {
3681 if {[is_remote host]} {
3682 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3684 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3686 # Link a copy of the output object, because the
3687 # original may be automatically deleted.
3688 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3690 verbose "gdb_saved_set_unbuffered_obj already compiled"
3693 # Rely on the internal knowledge that the global ctors are ran in
3694 # reverse link order. In that case, we can use ldflags to
3695 # avoid copying the object file to the host multiple
3697 # This object can only be added if standard libraries are
3698 # used. Thus, we need to disable it if -nostdlib option is used
3699 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3700 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3705 set result [target_compile $source $dest $type $options]
3707 # Prune uninteresting compiler (and linker) output.
3708 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3710 regsub "\[\r\n\]*$" "$result" "" result
3711 regsub "^\[\r\n\]*" "$result" "" result
3713 if {[lsearch $options quiet] < 0} {
3714 # We shall update this on a per language basis, to avoid
3715 # changing the entire testsuite in one go.
3716 if {[lsearch $options f77] >= 0} {
3717 gdb_compile_test $source $result
3718 } elseif { $result != "" } {
3719 clone_output "gdb compile failed, $result"
3726 # This is just like gdb_compile, above, except that it tries compiling
3727 # against several different thread libraries, to see which one this
3729 proc gdb_compile_pthreads {source dest type options} {
3731 set why_msg "unrecognized error"
3732 foreach lib {-lpthreads -lpthread -lthread ""} {
3733 # This kind of wipes out whatever libs the caller may have
3734 # set. Or maybe theirs will override ours. How infelicitous.
3735 set options_with_lib [concat $options [list libs=$lib quiet]]
3736 set ccout [gdb_compile $source $dest $type $options_with_lib]
3737 switch -regexp -- $ccout {
3738 ".*no posix threads support.*" {
3739 set why_msg "missing threads include file"
3742 ".*cannot open -lpthread.*" {
3743 set why_msg "missing runtime threads library"
3745 ".*Can't find library for -lpthread.*" {
3746 set why_msg "missing runtime threads library"
3749 pass "successfully compiled posix threads test case"
3755 if {!$built_binfile} {
3756 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3761 # Build a shared library from SOURCES.
3763 proc gdb_compile_shlib {sources dest options} {
3764 set obj_options $options
3767 if { [lsearch -exact $options "c++"] >= 0 } {
3768 set info_options "c++"
3770 if [get_compiler_info ${info_options}] {
3774 switch -glob [test_compiler_info] {
3776 lappend obj_options "additional_flags=-qpic"
3779 if { !([istarget "*-*-cygwin*"]
3780 || [istarget "*-*-mingw*"]) } {
3781 lappend obj_options "additional_flags=-fpic"
3785 if { !([istarget "powerpc*-*-aix*"]
3786 || [istarget "rs6000*-*-aix*"]
3787 || [istarget "*-*-cygwin*"]
3788 || [istarget "*-*-mingw*"]
3789 || [istarget "*-*-pe*"]) } {
3790 lappend obj_options "additional_flags=-fpic"
3794 lappend obj_options "additional_flags=-fpic"
3797 # don't know what the compiler is...
3801 set outdir [file dirname $dest]
3803 foreach source $sources {
3804 set sourcebase [file tail $source]
3805 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3808 lappend objects ${outdir}/${sourcebase}.o
3811 set link_options $options
3812 if [test_compiler_info "xlc-*"] {
3813 lappend link_options "additional_flags=-qmkshrobj"
3815 lappend link_options "additional_flags=-shared"
3817 if { ([istarget "*-*-mingw*"]
3818 || [istarget *-*-cygwin*]
3819 || [istarget *-*-pe*]) } {
3820 if { [is_remote host] } {
3821 set name [file tail ${dest}]
3825 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3827 # Set the soname of the library. This causes the linker on ELF
3828 # systems to create the DT_NEEDED entry in the executable referring
3829 # to the soname of the library, and not its absolute path. This
3830 # (using the absolute path) would be problem when testing on a
3833 # In conjunction with setting the soname, we add the special
3834 # rpath=$ORIGIN value when building the executable, so that it's
3835 # able to find the library in its own directory.
3836 set destbase [file tail $dest]
3837 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3840 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3843 if { [is_remote host]
3844 && ([istarget "*-*-mingw*"]
3845 || [istarget *-*-cygwin*]
3846 || [istarget *-*-pe*]) } {
3847 set dest_tail_name [file tail ${dest}]
3848 remote_upload host $dest_tail_name.a ${dest}.a
3849 remote_file host delete $dest_tail_name.a
3855 # This is just like gdb_compile_shlib, above, except that it tries compiling
3856 # against several different thread libraries, to see which one this
3858 proc gdb_compile_shlib_pthreads {sources dest options} {
3860 set why_msg "unrecognized error"
3861 foreach lib {-lpthreads -lpthread -lthread ""} {
3862 # This kind of wipes out whatever libs the caller may have
3863 # set. Or maybe theirs will override ours. How infelicitous.
3864 set options_with_lib [concat $options [list libs=$lib quiet]]
3865 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3866 switch -regexp -- $ccout {
3867 ".*no posix threads support.*" {
3868 set why_msg "missing threads include file"
3871 ".*cannot open -lpthread.*" {
3872 set why_msg "missing runtime threads library"
3874 ".*Can't find library for -lpthread.*" {
3875 set why_msg "missing runtime threads library"
3878 pass "successfully compiled posix threads test case"
3884 if {!$built_binfile} {
3885 unsupported "couldn't compile $sources: ${why_msg}"
3890 # This is just like gdb_compile_pthreads, above, except that we always add the
3891 # objc library for compiling Objective-C programs
3892 proc gdb_compile_objc {source dest type options} {
3894 set why_msg "unrecognized error"
3895 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3896 # This kind of wipes out whatever libs the caller may have
3897 # set. Or maybe theirs will override ours. How infelicitous.
3898 if { $lib == "solaris" } {
3899 set lib "-lpthread -lposix4"
3901 if { $lib != "-lobjc" } {
3902 set lib "-lobjc $lib"
3904 set options_with_lib [concat $options [list libs=$lib quiet]]
3905 set ccout [gdb_compile $source $dest $type $options_with_lib]
3906 switch -regexp -- $ccout {
3907 ".*no posix threads support.*" {
3908 set why_msg "missing threads include file"
3911 ".*cannot open -lpthread.*" {
3912 set why_msg "missing runtime threads library"
3914 ".*Can't find library for -lpthread.*" {
3915 set why_msg "missing runtime threads library"
3918 pass "successfully compiled objc with posix threads test case"
3924 if {!$built_binfile} {
3925 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3930 proc send_gdb { string } {
3931 global suppress_flag
3932 if { $suppress_flag } {
3935 return [remote_send host "$string"]
3938 # Send STRING to the inferior's terminal.
3940 proc send_inferior { string } {
3941 global inferior_spawn_id
3943 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3953 proc gdb_expect { args } {
3954 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3955 set atimeout [lindex $args 0]
3956 set expcode [list [lindex $args 1]]
3961 # A timeout argument takes precedence, otherwise of all the timeouts
3962 # select the largest.
3963 if [info exists atimeout] {
3966 set tmt [get_largest_timeout]
3969 global suppress_flag
3970 global remote_suppress_flag
3971 if [info exists remote_suppress_flag] {
3972 set old_val $remote_suppress_flag
3974 if [info exists suppress_flag] {
3975 if { $suppress_flag } {
3976 set remote_suppress_flag 1
3980 {uplevel remote_expect host $tmt $expcode} string]
3981 if [info exists old_val] {
3982 set remote_suppress_flag $old_val
3984 if [info exists remote_suppress_flag] {
3985 unset remote_suppress_flag
3990 global errorInfo errorCode
3992 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3994 return -code $code $string
3998 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4000 # Check for long sequence of output by parts.
4001 # TEST: is the test message to be printed with the test success/fail.
4002 # SENTINEL: Is the terminal pattern indicating that output has finished.
4003 # LIST: is the sequence of outputs to match.
4004 # If the sentinel is recognized early, it is considered an error.
4007 # 1 if the test failed,
4008 # 0 if the test passes,
4009 # -1 if there was an internal error.
4011 proc gdb_expect_list {test sentinel list} {
4013 global suppress_flag
4016 if { $suppress_flag } {
4018 unresolved "${test}"
4020 while { ${index} < [llength ${list}] } {
4021 set pattern [lindex ${list} ${index}]
4022 set index [expr ${index} + 1]
4023 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4024 if { ${index} == [llength ${list}] } {
4027 -re "${pattern}${sentinel}" {
4028 # pass "${test}, pattern ${index} + sentinel"
4031 fail "${test} (pattern ${index} + sentinel)"
4034 -re ".*A problem internal to GDB has been detected" {
4035 fail "${test} (GDB internal error)"
4037 gdb_internal_error_resync
4040 fail "${test} (pattern ${index} + sentinel) (timeout)"
4045 # unresolved "${test}, pattern ${index} + sentinel"
4051 # pass "${test}, pattern ${index}"
4054 fail "${test} (pattern ${index})"
4057 -re ".*A problem internal to GDB has been detected" {
4058 fail "${test} (GDB internal error)"
4060 gdb_internal_error_resync
4063 fail "${test} (pattern ${index}) (timeout)"
4068 # unresolved "${test}, pattern ${index}"
4082 proc gdb_suppress_entire_file { reason } {
4083 global suppress_flag
4086 set suppress_flag -1
4090 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4091 # gdb_expect to fail immediately (until the next call to
4092 # gdb_stop_suppressing_tests).
4094 proc gdb_suppress_tests { args } {
4095 global suppress_flag
4097 return; # fnf - disable pending review of results where
4098 # testsuite ran better without this
4101 if { $suppress_flag == 1 } {
4102 if { [llength $args] > 0 } {
4103 warning "[lindex $args 0]\n"
4105 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4111 # Clear suppress_flag.
4113 proc gdb_stop_suppressing_tests { } {
4114 global suppress_flag
4116 if [info exists suppress_flag] {
4117 if { $suppress_flag > 0 } {
4119 clone_output "Tests restarted.\n"
4126 proc gdb_clear_suppressed { } {
4127 global suppress_flag
4132 # Spawn the gdb process.
4134 # This doesn't expect any output or do any other initialization,
4135 # leaving those to the caller.
4137 # Overridable function -- you can override this function in your
4140 proc gdb_spawn { } {
4144 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4146 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4149 set saved_gdbflags $GDBFLAGS
4151 if {$GDBFLAGS != ""} {
4154 append GDBFLAGS $cmdline_flags
4158 set GDBFLAGS $saved_gdbflags
4163 # Start gdb running, wait for prompt, and disable the pagers.
4165 # Overridable function -- you can override this function in your
4168 proc gdb_start { } {
4173 catch default_gdb_exit
4176 # Return true if we can spawn a program on the target and attach to
4179 proc can_spawn_for_attach { } {
4180 # We use exp_pid to get the inferior's pid, assuming that gives
4181 # back the pid of the program. On remote boards, that would give
4182 # us instead the PID of e.g., the ssh client, etc.
4183 if [is_remote target] then {
4187 # The "attach" command doesn't make sense when the target is
4188 # stub-like, where GDB finds the program already started on
4189 # initial connection.
4190 if {[target_info exists use_gdb_stub]} {
4198 # Kill a progress previously started with spawn_wait_for_attach, and
4199 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4202 proc kill_wait_spawned_process { proc_spawn_id } {
4203 set pid [exp_pid -i $proc_spawn_id]
4205 verbose -log "killing ${pid}"
4206 remote_exec build "kill -9 ${pid}"
4208 verbose -log "closing ${proc_spawn_id}"
4209 catch "close -i $proc_spawn_id"
4210 verbose -log "waiting for ${proc_spawn_id}"
4212 # If somehow GDB ends up still attached to the process here, a
4213 # blocking wait hangs until gdb is killed (or until gdb / the
4214 # ptracer reaps the exit status too, but that won't happen because
4215 # something went wrong.) Passing -nowait makes expect tell Tcl to
4216 # wait for the PID in the background. That's fine because we
4217 # don't care about the exit status. */
4218 wait -nowait -i $proc_spawn_id
4221 # Returns the process id corresponding to the given spawn id.
4223 proc spawn_id_get_pid { spawn_id } {
4224 set testpid [exp_pid -i $spawn_id]
4226 if { [istarget "*-*-cygwin*"] } {
4227 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4228 # might be different due to the way fork/exec works.
4229 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4235 # Start a set of programs running and then wait for a bit, to be sure
4236 # that they can be attached to. Return a list of processes spawn IDs,
4237 # one element for each process spawned. It's a test error to call
4238 # this when [can_spawn_for_attach] is false.
4240 proc spawn_wait_for_attach { executable_list } {
4241 set spawn_id_list {}
4243 if ![can_spawn_for_attach] {
4244 # The caller should have checked can_spawn_for_attach itself
4245 # before getting here.
4246 error "can't spawn for attach with this target/board"
4249 foreach {executable} $executable_list {
4250 # Note we use Expect's spawn, not Tcl's exec, because with
4251 # spawn we control when to wait for/reap the process. That
4252 # allows killing the process by PID without being subject to
4254 lappend spawn_id_list [remote_spawn target $executable]
4259 return $spawn_id_list
4263 # gdb_load_cmd -- load a file into the debugger.
4264 # ARGS - additional args to load command.
4265 # return a -1 if anything goes wrong.
4267 proc gdb_load_cmd { args } {
4270 if [target_info exists gdb_load_timeout] {
4271 set loadtimeout [target_info gdb_load_timeout]
4273 set loadtimeout 1600
4275 send_gdb "load $args\n"
4276 verbose "Timeout is now $loadtimeout seconds" 2
4277 gdb_expect $loadtimeout {
4278 -re "Loading section\[^\r\]*\r\n" {
4281 -re "Start address\[\r\]*\r\n" {
4284 -re "Transfer rate\[\r\]*\r\n" {
4287 -re "Memory access error\[^\r\]*\r\n" {
4288 perror "Failed to load program"
4291 -re "$gdb_prompt $" {
4294 -re "(.*)\r\n$gdb_prompt " {
4295 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4299 perror "Timed out trying to load $args."
4306 # Invoke "gcore". CORE is the name of the core file to write. TEST
4307 # is the name of the test case. This will return 1 if the core file
4308 # was created, 0 otherwise. If this fails to make a core file because
4309 # this configuration of gdb does not support making core files, it
4310 # will call "unsupported", not "fail". However, if this fails to make
4311 # a core file for some other reason, then it will call "fail".
4313 proc gdb_gcore_cmd {core test} {
4317 gdb_test_multiple "gcore $core" $test {
4318 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4322 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4330 # Load core file CORE. TEST is the name of the test case.
4331 # This will record a pass/fail for loading the core file.
4333 # 1 - core file is successfully loaded
4334 # 0 - core file loaded but has a non fatal error
4335 # -1 - core file failed to load
4337 proc gdb_core_cmd { core test } {
4340 gdb_test_multiple "core $core" "$test" {
4341 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4344 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4345 fail "$test (bad file format)"
4348 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4349 fail "$test (file not found)"
4352 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4353 fail "$test (incomplete note section)"
4356 -re "Core was generated by .*\r\n$gdb_prompt $" {
4360 -re ".*$gdb_prompt $" {
4365 fail "$test (timeout)"
4369 fail "unsupported output from 'core' command"
4373 # Return the filename to download to the target and load on the target
4374 # for this shared library. Normally just LIBNAME, unless shared libraries
4375 # for this target have separate link and load images.
4377 proc shlib_target_file { libname } {
4381 # Return the filename GDB will load symbols from when debugging this
4382 # shared library. Normally just LIBNAME, unless shared libraries for
4383 # this target have separate link and load images.
4385 proc shlib_symbol_file { libname } {
4389 # Return the filename to download to the target and load for this
4390 # executable. Normally just BINFILE unless it is renamed to something
4391 # else for this target.
4393 proc exec_target_file { binfile } {
4397 # Return the filename GDB will load symbols from when debugging this
4398 # executable. Normally just BINFILE unless executables for this target
4399 # have separate files for symbols.
4401 proc exec_symbol_file { binfile } {
4405 # Rename the executable file. Normally this is just BINFILE1 being renamed
4406 # to BINFILE2, but some targets require multiple binary files.
4407 proc gdb_rename_execfile { binfile1 binfile2 } {
4408 file rename -force [exec_target_file ${binfile1}] \
4409 [exec_target_file ${binfile2}]
4410 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4411 file rename -force [exec_symbol_file ${binfile1}] \
4412 [exec_symbol_file ${binfile2}]
4416 # "Touch" the executable file to update the date. Normally this is just
4417 # BINFILE, but some targets require multiple files.
4418 proc gdb_touch_execfile { binfile } {
4419 set time [clock seconds]
4420 file mtime [exec_target_file ${binfile}] $time
4421 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4422 file mtime [exec_symbol_file ${binfile}] $time
4426 # Like remote_download but provides a gdb-specific behavior.
4428 # If the destination board is remote, the local file FROMFILE is transferred as
4429 # usual with remote_download to TOFILE on the remote board. The destination
4430 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4433 # If the destination board is local, the destination path TOFILE is passed
4434 # through standard_output_file, and FROMFILE is copied there.
4436 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4439 proc gdb_remote_download {dest fromfile {tofile {}}} {
4440 # If TOFILE is not given, default to the same filename as FROMFILE.
4441 if {[string length $tofile] == 0} {
4442 set tofile [file tail $fromfile]
4445 if {[is_remote $dest]} {
4446 # When the DEST is remote, we simply send the file to DEST.
4449 set destname [remote_download $dest $fromfile $tofile]
4450 lappend cleanfiles $destname
4454 # When the DEST is local, we copy the file to the test directory (where
4455 # the executable is).
4457 # Note that we pass TOFILE through standard_output_file, regardless of
4458 # whether it is absolute or relative, because we don't want the tests
4459 # to be able to write outside their standard output directory.
4461 set tofile [standard_output_file $tofile]
4463 file copy -force $fromfile $tofile
4469 # gdb_load_shlib LIB...
4471 # Copy the listed library to the target.
4473 proc gdb_load_shlib { file } {
4476 if ![info exists gdb_spawn_id] {
4477 perror "gdb_load_shlib: GDB is not running"
4480 set dest [gdb_remote_download target [shlib_target_file $file]]
4482 if {[is_remote target]} {
4483 # If the target is remote, we need to tell gdb where to find the
4486 # We could set this even when not testing remotely, but a user
4487 # generally won't set it unless necessary. In order to make the tests
4488 # more like the real-life scenarios, we don't set it for local testing.
4489 gdb_test "set solib-search-path [file dirname $file]" "" ""
4496 # gdb_load -- load a file into the debugger. Specifying no file
4497 # defaults to the executable currently being debugged.
4498 # The return value is 0 for success, -1 for failure.
4499 # Many files in config/*.exp override this procedure.
4501 proc gdb_load { arg } {
4503 return [gdb_file_cmd $arg]
4508 # gdb_reload -- load a file into the target. Called before "running",
4509 # either the first time or after already starting the program once,
4510 # for remote targets. Most files that override gdb_load should now
4511 # override this instead.
4513 proc gdb_reload { } {
4514 # For the benefit of existing configurations, default to gdb_load.
4515 # Specifying no file defaults to the executable currently being
4517 return [gdb_load ""]
4520 proc gdb_continue { function } {
4523 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4526 proc default_gdb_init { test_file_name } {
4527 global gdb_wrapper_initialized
4528 global gdb_wrapper_target
4529 global gdb_test_file_name
4535 gdb_clear_suppressed
4537 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4539 # Make sure that the wrapper is rebuilt
4540 # with the appropriate multilib option.
4541 if { $gdb_wrapper_target != [current_target_name] } {
4542 set gdb_wrapper_initialized 0
4545 # Unlike most tests, we have a small number of tests that generate
4546 # a very large amount of output. We therefore increase the expect
4547 # buffer size to be able to contain the entire test output. This
4548 # is especially needed by gdb.base/info-macros.exp.
4550 # Also set this value for the currently running GDB.
4551 match_max [match_max -d]
4553 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4554 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4557 if [target_info exists gdb_prompt] {
4558 set gdb_prompt [target_info gdb_prompt]
4560 set gdb_prompt "\\(gdb\\)"
4563 if [info exists use_gdb_stub] {
4568 # Return a path using GDB_PARALLEL.
4569 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4570 # GDB_PARALLEL must be defined, the caller must check.
4572 # The default value for GDB_PARALLEL is, canonically, ".".
4573 # The catch is that tests don't expect an additional "./" in file paths so
4574 # omit any directory for the default case.
4575 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4576 # its special handling.
4578 proc make_gdb_parallel_path { args } {
4579 global GDB_PARALLEL objdir
4580 set joiner [list "file" "join" $objdir]
4581 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4582 lappend joiner $GDB_PARALLEL
4584 set joiner [concat $joiner $args]
4585 return [eval $joiner]
4588 # Turn BASENAME into a full file name in the standard output
4589 # directory. It is ok if BASENAME is the empty string; in this case
4590 # the directory is returned.
4592 proc standard_output_file {basename} {
4593 global objdir subdir gdb_test_file_name
4595 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4597 return [file join $dir $basename]
4600 # Return the name of a file in our standard temporary directory.
4602 proc standard_temp_file {basename} {
4603 # Since a particular runtest invocation is only executing a single test
4604 # file at any given time, we can use the runtest pid to build the
4605 # path of the temp directory.
4606 set dir [make_gdb_parallel_path temp [pid]]
4608 return [file join $dir $basename]
4611 # Set 'testfile', 'srcfile', and 'binfile'.
4613 # ARGS is a list of source file specifications.
4614 # Without any arguments, the .exp file's base name is used to
4615 # compute the source file name. The ".c" extension is added in this case.
4616 # If ARGS is not empty, each entry is a source file specification.
4617 # If the specification starts with a ".", it is treated as a suffix
4618 # to append to the .exp file's base name.
4619 # If the specification is the empty string, it is treated as if it
4621 # Otherwise it is a file name.
4622 # The first file in the list is used to set the 'srcfile' global.
4623 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4625 # Most tests should call this without arguments.
4627 # If a completely different binary file name is needed, then it
4628 # should be handled in the .exp file with a suitable comment.
4630 proc standard_testfile {args} {
4631 global gdb_test_file_name
4633 global gdb_test_file_last_vars
4636 global testfile binfile
4638 set testfile $gdb_test_file_name
4639 set binfile [standard_output_file ${testfile}]
4641 if {[llength $args] == 0} {
4645 # Unset our previous output variables.
4646 # This can help catch hidden bugs.
4647 if {[info exists gdb_test_file_last_vars]} {
4648 foreach varname $gdb_test_file_last_vars {
4650 catch {unset $varname}
4653 # 'executable' is often set by tests.
4654 set gdb_test_file_last_vars {executable}
4658 set varname srcfile$suffix
4661 # Handle an extension.
4664 } elseif {[string range $arg 0 0] == "."} {
4665 set arg $testfile$arg
4669 lappend gdb_test_file_last_vars $varname
4671 if {$suffix == ""} {
4679 # The default timeout used when testing GDB commands. We want to use
4680 # the same timeout as the default dejagnu timeout, unless the user has
4681 # already provided a specific value (probably through a site.exp file).
4682 global gdb_test_timeout
4683 if ![info exists gdb_test_timeout] {
4684 set gdb_test_timeout $timeout
4687 # A list of global variables that GDB testcases should not use.
4688 # We try to prevent their use by monitoring write accesses and raising
4689 # an error when that happens.
4690 set banned_variables { bug_id prms_id }
4692 # A list of procedures that GDB testcases should not use.
4693 # We try to prevent their use by monitoring invocations and raising
4694 # an error when that happens.
4695 set banned_procedures { strace }
4697 # gdb_init is called by runtest at start, but also by several
4698 # tests directly; gdb_finish is only called from within runtest after
4699 # each test source execution.
4700 # Placing several traces by repetitive calls to gdb_init leads
4701 # to problems, as only one trace is removed in gdb_finish.
4702 # To overcome this possible problem, we add a variable that records
4703 # if the banned variables and procedures are already traced.
4706 proc gdb_init { test_file_name } {
4707 # Reset the timeout value to the default. This way, any testcase
4708 # that changes the timeout value without resetting it cannot affect
4709 # the timeout used in subsequent testcases.
4710 global gdb_test_timeout
4712 set timeout $gdb_test_timeout
4714 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4715 && [target_info exists gdb_reverse_timeout] } {
4716 set timeout [target_info gdb_reverse_timeout]
4719 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4720 # debugging tool to help confirm that the test suite is
4721 # parallel-safe. You need "inotifywait" from the
4722 # inotify-tools package to use this.
4723 global GDB_INOTIFY inotify_pid
4724 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4725 global outdir tool inotify_log_file
4727 set exclusions {outputs temp gdb[.](log|sum) cache}
4728 set exclusion_re ([join $exclusions |])
4730 set inotify_log_file [standard_temp_file inotify.out]
4731 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4732 --exclude $exclusion_re \
4733 |& tee -a $outdir/$tool.log $inotify_log_file &]
4735 # Wait for the watches; hopefully this is long enough.
4738 # Clear the log so that we don't emit a warning the first time
4740 set fd [open $inotify_log_file w]
4744 # Block writes to all banned variables, and invocation of all
4745 # banned procedures...
4746 global banned_variables
4747 global banned_procedures
4748 global banned_traced
4749 if (!$banned_traced) {
4750 foreach banned_var $banned_variables {
4751 global "$banned_var"
4752 trace add variable "$banned_var" write error
4754 foreach banned_proc $banned_procedures {
4755 global "$banned_proc"
4756 trace add execution "$banned_proc" enter error
4761 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4762 # messages as expected.
4767 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4768 # the test results. Even if /dev/null doesn't exist on the particular
4769 # platform, the readline library will use the default setting just by
4770 # failing to open the file. OTOH, opening /dev/null successfully will
4771 # also result in the default settings being used since nothing will be
4772 # read from this file.
4773 setenv INPUTRC "/dev/null"
4775 # This disables style output, which would interfere with many
4779 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
4780 # during startup. See "man expect" for details about stty_init.
4782 set stty_init "rows 25 cols 80"
4784 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4785 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4786 # especially having color output turned on can cause tests to fail.
4787 setenv GREP_OPTIONS ""
4789 # Clear $gdbserver_reconnect_p.
4790 global gdbserver_reconnect_p
4791 set gdbserver_reconnect_p 1
4792 unset gdbserver_reconnect_p
4794 return [default_gdb_init $test_file_name]
4797 proc gdb_finish { } {
4798 global gdbserver_reconnect_p
4802 # Exit first, so that the files are no longer in use.
4805 if { [llength $cleanfiles] > 0 } {
4806 eval remote_file target delete $cleanfiles
4810 # Unblock write access to the banned variables. Dejagnu typically
4811 # resets some of them between testcases.
4812 global banned_variables
4813 global banned_procedures
4814 global banned_traced
4815 if ($banned_traced) {
4816 foreach banned_var $banned_variables {
4817 global "$banned_var"
4818 trace remove variable "$banned_var" write error
4820 foreach banned_proc $banned_procedures {
4821 global "$banned_proc"
4822 trace remove execution "$banned_proc" enter error
4829 set debug_format "unknown"
4831 # Run the gdb command "info source" and extract the debugging format
4832 # information from the output and save it in debug_format.
4834 proc get_debug_format { } {
4840 set debug_format "unknown"
4841 send_gdb "info source\n"
4843 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4844 set debug_format $expect_out(1,string)
4845 verbose "debug format is $debug_format"
4848 -re "No current source file.\r\n$gdb_prompt $" {
4849 perror "get_debug_format used when no current source file"
4852 -re "$gdb_prompt $" {
4853 warning "couldn't check debug format (no valid response)."
4857 warning "couldn't check debug format (timeout)."
4863 # Return true if FORMAT matches the debug format the current test was
4864 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4865 # `*', `[...]', and so on.
4867 # This function depends on variables set by `get_debug_format', above.
4869 proc test_debug_format {format} {
4872 return [expr [string match $format $debug_format] != 0]
4875 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4876 # COFF, stabs, etc). If that format matches the format that the
4877 # current test was compiled with, then the next test is expected to
4878 # fail for any target. Returns 1 if the next test or set of tests is
4879 # expected to fail, 0 otherwise (or if it is unknown). Must have
4880 # previously called get_debug_format.
4881 proc setup_xfail_format { format } {
4882 set ret [test_debug_format $format]
4890 # gdb_get_line_number TEXT [FILE]
4892 # Search the source file FILE, and return the line number of the
4893 # first line containing TEXT. If no match is found, an error is thrown.
4895 # TEXT is a string literal, not a regular expression.
4897 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4898 # specified, and does not start with "/", then it is assumed to be in
4899 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4900 # by changing the callers and the interface at the same time.
4901 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4902 # gdb.base/ena-dis-br.exp.
4904 # Use this function to keep your test scripts independent of the
4905 # exact line numbering of the source file. Don't write:
4907 # send_gdb "break 20"
4909 # This means that if anyone ever edits your test's source file,
4910 # your test could break. Instead, put a comment like this on the
4911 # source file line you want to break at:
4913 # /* breakpoint spot: frotz.exp: test name */
4915 # and then write, in your test script (which we assume is named
4918 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4920 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4923 # % puts "foo [lindex "bar baz" 1]"
4926 # Tcl is quite clever, for a little stringy language.)
4930 # The previous implementation of this procedure used the gdb search command.
4931 # This version is different:
4933 # . It works with MI, and it also works when gdb is not running.
4935 # . It operates on the build machine, not the host machine.
4937 # . For now, this implementation fakes a current directory of
4938 # $srcdir/$subdir to be compatible with the old implementation.
4939 # This will go away eventually and some callers will need to
4942 # . The TEXT argument is literal text and matches literally,
4943 # not a regular expression as it was before.
4945 # . State changes in gdb, such as changing the current file
4946 # and setting $_, no longer happen.
4948 # After a bit of time we can forget about the differences from the
4949 # old implementation.
4951 # --chastain 2004-08-05
4953 proc gdb_get_line_number { text { file "" } } {
4958 if { "$file" == "" } then {
4961 if { ! [regexp "^/" "$file"] } then {
4962 set file "$srcdir/$subdir/$file"
4965 if { [ catch { set fd [open "$file"] } message ] } then {
4970 for { set line 1 } { 1 } { incr line } {
4971 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4974 if { $nchar < 0 } then {
4977 if { [string first "$text" "$body"] >= 0 } then {
4983 if { [ catch { close "$fd" } message ] } then {
4988 error "undefined tag \"$text\""
4994 # Continue the program until it ends.
4996 # MSSG is the error message that gets printed. If not given, a
4998 # COMMAND is the command to invoke. If not given, "continue" is
5000 # ALLOW_EXTRA is a flag indicating whether the test should expect
5001 # extra output between the "Continuing." line and the program
5002 # exiting. By default it is zero; if nonzero, any extra output
5005 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5006 global inferior_exited_re use_gdb_stub
5009 set text "continue until exit"
5011 set text "continue until exit at $mssg"
5019 # By default, we don't rely on exit() behavior of remote stubs --
5020 # it's common for exit() to be implemented as a simple infinite
5021 # loop, or a forced crash/reset. For native targets, by default, we
5022 # assume process exit is reported as such. If a non-reliable target
5023 # is used, we set a breakpoint at exit, and continue to that.
5024 if { [target_info exists exit_is_reliable] } {
5025 set exit_is_reliable [target_info exit_is_reliable]
5027 set exit_is_reliable [expr ! $use_gdb_stub]
5030 if { ! $exit_is_reliable } {
5031 if {![gdb_breakpoint "exit"]} {
5034 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5037 # Continue until we exit. Should not stop again.
5038 # Don't bother to check the output of the program, that may be
5039 # extremely tough for some remote systems.
5041 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5046 proc rerun_to_main {} {
5047 global gdb_prompt use_gdb_stub
5052 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5053 {pass "rerun to main" ; return 0}
5054 -re "$gdb_prompt $"\
5055 {fail "rerun to main" ; return 0}
5056 timeout {fail "(timeout) rerun to main" ; return 0}
5061 -re "The program .* has been started already.*y or n. $" {
5065 -re "Starting program.*$gdb_prompt $"\
5066 {pass "rerun to main" ; return 0}
5067 -re "$gdb_prompt $"\
5068 {fail "rerun to main" ; return 0}
5069 timeout {fail "(timeout) rerun to main" ; return 0}
5074 # Return true if a test should be skipped due to lack of floating
5075 # point support or GDB can't fetch the contents from floating point
5078 gdb_caching_proc gdb_skip_float_test {
5079 if [target_info exists gdb,skip_float_tests] {
5083 # There is an ARM kernel ptrace bug that hardware VFP registers
5084 # are not updated after GDB ptrace set VFP registers. The bug
5085 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5086 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5087 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5088 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5089 # This kernel bug is detected by check how does GDB change the
5090 # program result by changing one VFP register.
5091 if { [istarget "arm*-*-linux*"] } {
5093 set compile_flags {debug nowarnings }
5095 # Set up, compile, and execute a test program having VFP
5097 set src [standard_temp_file arm_vfp[pid].c]
5098 set exe [standard_temp_file arm_vfp[pid].x]
5100 gdb_produce_source $src {
5105 asm ("vldr d0, [%0]" : : "r" (&d));
5106 asm ("vldr d1, [%0]" : : "r" (&d));
5107 asm (".global break_here\n"
5109 asm ("vcmp.f64 d0, d1\n"
5110 "vmrs APSR_nzcv, fpscr\n"
5111 "bne L_value_different\n"
5114 "L_value_different:\n"
5116 "L_end:\n" : "=r" (ret) :);
5118 /* Return $d0 != $d1. */
5123 verbose "compiling testfile $src" 2
5124 set lines [gdb_compile $src $exe executable $compile_flags]
5127 if ![string match "" $lines] then {
5128 verbose "testfile compilation failed, returning 1" 2
5132 # No error message, compilation succeeded so now run it via gdb.
5133 # Run the test up to 5 times to detect whether ptrace can
5134 # correctly update VFP registers or not.
5136 for {set i 0} {$i < 5} {incr i} {
5137 global gdb_prompt srcdir subdir
5141 gdb_reinitialize_dir $srcdir/$subdir
5145 gdb_test "break *break_here"
5146 gdb_continue_to_breakpoint "break_here"
5148 # Modify $d0 to a different value, so the exit code should
5150 gdb_test "set \$d0 = 5.0"
5152 set test "continue to exit"
5153 gdb_test_multiple "continue" "$test" {
5154 -re "exited with code 01.*$gdb_prompt $" {
5156 -re "exited normally.*$gdb_prompt $" {
5157 # However, the exit code is 0. That means something
5158 # wrong in setting VFP registers.
5166 remote_file build delete $exe
5168 return $skip_vfp_test
5173 # Print a message and return true if a test should be skipped
5174 # due to lack of stdio support.
5176 proc gdb_skip_stdio_test { msg } {
5177 if [target_info exists gdb,noinferiorio] {
5178 verbose "Skipping test '$msg': no inferior i/o."
5184 proc gdb_skip_bogus_test { msg } {
5188 # Return true if a test should be skipped due to lack of XML support
5190 # NOTE: This must be called while gdb is *not* running.
5192 gdb_caching_proc gdb_skip_xml_test {
5197 if { [info exists gdb_spawn_id] } {
5198 error "GDB must not be running in gdb_skip_xml_tests."
5201 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5205 gdb_test_multiple "set tdesc filename $xml_file" "" {
5206 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5209 -re ".*$gdb_prompt $" { }
5215 # Return true if argv[0] is available.
5217 gdb_caching_proc gdb_has_argv0 {
5220 # Compile and execute a test program to check whether argv[0] is available.
5221 gdb_simple_compile has_argv0 {
5222 int main (int argc, char **argv) {
5229 proc gdb_has_argv0_1 { exe } {
5230 global srcdir subdir
5231 global gdb_prompt hex
5235 gdb_reinitialize_dir $srcdir/$subdir
5238 # Set breakpoint on main.
5239 gdb_test_multiple "break main" "break main" {
5240 -re "Breakpoint.*${gdb_prompt} $" {
5242 -re "${gdb_prompt} $" {
5249 gdb_test_multiple "" "run to main" {
5250 -re "Breakpoint.*${gdb_prompt} $" {
5252 -re "${gdb_prompt} $" {
5257 set old_elements "200"
5258 set test "show print elements"
5259 gdb_test_multiple $test $test {
5260 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5261 set old_elements $expect_out(1,string)
5264 set old_repeats "200"
5265 set test "show print repeats"
5266 gdb_test_multiple $test $test {
5267 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5268 set old_repeats $expect_out(1,string)
5271 gdb_test_no_output "set print elements unlimited" ""
5272 gdb_test_no_output "set print repeats unlimited" ""
5275 # Check whether argc is 1.
5276 gdb_test_multiple "p argc" "p argc" {
5277 -re " = 1\r\n${gdb_prompt} $" {
5279 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5280 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5283 -re "${gdb_prompt} $" {
5287 -re "${gdb_prompt} $" {
5291 gdb_test_no_output "set print elements $old_elements" ""
5292 gdb_test_no_output "set print repeats $old_repeats" ""
5297 set result [gdb_has_argv0_1 $obj]
5303 && ([istarget *-*-linux*]
5304 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5305 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5306 || [istarget *-*-openbsd*]
5307 || [istarget *-*-darwin*]
5308 || [istarget *-*-solaris*]
5309 || [istarget *-*-aix*]
5310 || [istarget *-*-gnu*]
5311 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5312 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5313 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5314 || [istarget *-*-symbianelf*]
5315 || [istarget *-*-osf*]
5316 || [istarget *-*-dicos*]
5317 || [istarget *-*-nto*]
5318 || [istarget *-*-*vms*]
5319 || [istarget *-*-lynx*178]) } {
5320 fail "argv\[0\] should be available on this target"
5326 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5327 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5328 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5329 # the name of a debuginfo only file. This file will be stored in the same
5332 # Functions for separate debug info testing
5334 # starting with an executable:
5335 # foo --> original executable
5337 # at the end of the process we have:
5338 # foo.stripped --> foo w/o debug info
5339 # foo.debug --> foo's debug info
5340 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5342 # Fetch the build id from the file.
5343 # Returns "" if there is none.
5345 proc get_build_id { filename } {
5346 if { ([istarget "*-*-mingw*"]
5347 || [istarget *-*-cygwin*]) } {
5348 set objdump_program [gdb_find_objdump]
5349 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5350 verbose "result is $result"
5351 verbose "output is $output"
5357 set tmp [standard_output_file "${filename}-tmp"]
5358 set objcopy_program [gdb_find_objcopy]
5359 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5360 verbose "result is $result"
5361 verbose "output is $output"
5366 fconfigure $fi -translation binary
5367 # Skip the NOTE header.
5372 if ![string compare $data ""] then {
5375 # Convert it to hex.
5376 binary scan $data H* data
5381 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5382 # converted to the form: .build-id/ab/cdef1234...89.debug
5383 # Return "" if no build-id found.
5384 proc build_id_debug_filename_get { filename } {
5385 set data [get_build_id $filename]
5386 if { $data == "" } {
5389 regsub {^..} $data {\0/} data
5390 return ".build-id/${data}.debug"
5393 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5394 # list of optional flags. The only currently supported flag is no-main,
5395 # which removes the symbol entry for main from the separate debug file.
5397 # Function returns zero on success. Function will return non-zero failure code
5398 # on some targets not supporting separate debug info (such as i386-msdos).
5400 proc gdb_gnu_strip_debug { dest args } {
5402 # Use the first separate debug info file location searched by GDB so the
5403 # run cannot be broken by some stale file searched with higher precedence.
5404 set debug_file "${dest}.debug"
5406 set strip_to_file_program [transform strip]
5407 set objcopy_program [gdb_find_objcopy]
5409 set debug_link [file tail $debug_file]
5410 set stripped_file "${dest}.stripped"
5412 # Get rid of the debug info, and store result in stripped_file
5413 # something like gdb/testsuite/gdb.base/blah.stripped.
5414 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5415 verbose "result is $result"
5416 verbose "output is $output"
5421 # Workaround PR binutils/10802:
5422 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5423 set perm [file attributes ${dest} -permissions]
5424 file attributes ${stripped_file} -permissions $perm
5426 # Get rid of everything but the debug info, and store result in debug_file
5427 # This will be in the .debug subdirectory, see above.
5428 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5429 verbose "result is $result"
5430 verbose "output is $output"
5435 # If no-main is passed, strip the symbol for main from the separate
5436 # file. This is to simulate the behavior of elfutils's eu-strip, which
5437 # leaves the symtab in the original file only. There's no way to get
5438 # objcopy or strip to remove the symbol table without also removing the
5439 # debugging sections, so this is as close as we can get.
5440 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5441 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5442 verbose "result is $result"
5443 verbose "output is $output"
5447 file delete "${debug_file}"
5448 file rename "${debug_file}-tmp" "${debug_file}"
5451 # Link the two previous output files together, adding the .gnu_debuglink
5452 # section to the stripped_file, containing a pointer to the debug_file,
5453 # save the new file in dest.
5454 # This will be the regular executable filename, in the usual location.
5455 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5456 verbose "result is $result"
5457 verbose "output is $output"
5462 # Workaround PR binutils/10802:
5463 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5464 set perm [file attributes ${stripped_file} -permissions]
5465 file attributes ${dest} -permissions $perm
5470 # Test the output of GDB_COMMAND matches the pattern obtained
5471 # by concatenating all elements of EXPECTED_LINES. This makes
5472 # it possible to split otherwise very long string into pieces.
5473 # If third argument is not empty, it's used as the name of the
5474 # test to be printed on pass/fail.
5475 proc help_test_raw { gdb_command expected_lines args } {
5476 set message $gdb_command
5477 if [llength $args]>0 then {
5478 set message [lindex $args 0]
5480 set expected_output [join $expected_lines ""]
5481 gdb_test "${gdb_command}" "${expected_output}" $message
5484 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5485 # are regular expressions that should match the beginning of output,
5486 # before the list of commands in that class. The presence of
5487 # command list and standard epilogue will be tested automatically.
5488 # Notice that the '[' and ']' characters don't need to be escaped for strings
5489 # wrapped in {} braces.
5490 proc test_class_help { command_class expected_initial_lines args } {
5492 "List of commands\:.*[\r\n]+"
5493 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5494 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5495 "Command name abbreviations are allowed if unambiguous\."
5497 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5499 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5502 # COMMAND_LIST should have either one element -- command to test, or
5503 # two elements -- abbreviated command to test, and full command the first
5504 # element is abbreviation of.
5505 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5506 # are regular expressions that should match the beginning of output,
5507 # before the list of subcommands. The presence of
5508 # subcommand list and standard epilogue will be tested automatically.
5509 proc test_prefix_command_help { command_list expected_initial_lines args } {
5510 set command [lindex $command_list 0]
5511 if {[llength $command_list]>1} {
5512 set full_command [lindex $command_list 1]
5514 set full_command $command
5516 # Use 'list' and not just {} because we want variables to
5517 # be expanded in this list.
5518 set l_stock_body [list\
5519 "List of $full_command subcommands\:.*\[\r\n\]+"\
5520 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5521 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5522 "Command name abbreviations are allowed if unambiguous\."]
5523 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5524 if {[llength $args]>0} {
5525 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5527 help_test_raw "help ${command}" $l_entire_body
5531 # Build executable named EXECUTABLE from specifications that allow
5532 # different options to be passed to different sub-compilations.
5533 # TESTNAME is the name of the test; this is passed to 'untested' if
5535 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5536 # contains the option "pthreads", then gdb_compile_pthreads is used.
5537 # ARGS is a flat list of source specifications, of the form:
5538 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5539 # Each SOURCE is compiled to an object file using its OPTIONS,
5540 # using gdb_compile.
5541 # Returns 0 on success, -1 on failure.
5542 proc build_executable_from_specs {testname executable options args} {
5546 set binfile [standard_output_file $executable]
5549 if { [lsearch -exact $options "c++"] >= 0 } {
5550 set info_options "c++"
5552 if [get_compiler_info ${info_options}] {
5556 set func gdb_compile
5557 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5558 if {$func_index != -1} {
5559 set func "${func}_[lindex $options $func_index]"
5562 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5563 # parameter. They also requires $sources while gdb_compile and
5564 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5565 if [string match gdb_compile_shlib* $func] {
5567 foreach {s local_options} $args {
5568 if { [regexp "^/" "$s"] } then {
5569 lappend sources_path "$s"
5571 lappend sources_path "$srcdir/$subdir/$s"
5574 set ret [$func $sources_path "${binfile}" $options]
5575 } elseif {[lsearch -exact $options rust] != -1} {
5577 foreach {s local_options} $args {
5578 if { [regexp "^/" "$s"] } then {
5579 lappend sources_path "$s"
5581 lappend sources_path "$srcdir/$subdir/$s"
5584 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5588 foreach {s local_options} $args {
5589 if { ! [regexp "^/" "$s"] } then {
5590 set s "$srcdir/$subdir/$s"
5592 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5596 lappend objects "${binfile}${i}.o"
5599 set ret [$func $objects "${binfile}" executable $options]
5609 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5610 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5611 # to pass to untested, if something is wrong. OPTIONS are passed
5612 # to gdb_compile directly.
5613 proc build_executable { testname executable {sources ""} {options {debug}} } {
5614 if {[llength $sources]==0} {
5615 set sources ${executable}.c
5618 set arglist [list $testname $executable $options]
5619 foreach source $sources {
5620 lappend arglist $source $options
5623 return [eval build_executable_from_specs $arglist]
5626 # Starts fresh GDB binary and loads an optional executable into GDB.
5627 # Usage: clean_restart [executable]
5628 # EXECUTABLE is the basename of the binary.
5630 proc clean_restart { args } {
5634 if { [llength $args] > 1 } {
5635 error "bad number of args: [llength $args]"
5640 gdb_reinitialize_dir $srcdir/$subdir
5642 if { [llength $args] >= 1 } {
5643 set executable [lindex $args 0]
5644 set binfile [standard_output_file ${executable}]
5649 # Prepares for testing by calling build_executable_full, then
5651 # TESTNAME is the name of the test.
5652 # Each element in ARGS is a list of the form
5653 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5654 # These are passed to build_executable_from_specs, which see.
5655 # The last EXECUTABLE is passed to clean_restart.
5656 # Returns 0 on success, non-zero on failure.
5657 proc prepare_for_testing_full {testname args} {
5658 foreach spec $args {
5659 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5662 set executable [lindex $spec 0]
5664 clean_restart $executable
5668 # Prepares for testing, by calling build_executable, and then clean_restart.
5669 # Please refer to build_executable for parameter description.
5670 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5672 if {[build_executable $testname $executable $sources $options] == -1} {
5675 clean_restart $executable
5680 # Retrieve the value of EXP in the inferior, represented in format
5681 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5682 # print fails. TEST is the test message to use. It can be omitted,
5683 # in which case a test message is built from EXP.
5685 proc get_valueof { fmt exp default {test ""} } {
5689 set test "get valueof \"${exp}\""
5693 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5694 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5695 set val $expect_out(1,string)
5699 fail "$test (timeout)"
5705 # Retrieve the value of EXP in the inferior, as a signed decimal value
5706 # (using "print /d"). DEFAULT is used as fallback if print fails.
5707 # TEST is the test message to use. It can be omitted, in which case
5708 # a test message is built from EXP.
5710 proc get_integer_valueof { exp default {test ""} } {
5714 set test "get integer valueof \"${exp}\""
5718 gdb_test_multiple "print /d ${exp}" "$test" {
5719 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5720 set val $expect_out(1,string)
5724 fail "$test (timeout)"
5730 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5731 # (using "print /x"). DEFAULT is used as fallback if print fails.
5732 # TEST is the test message to use. It can be omitted, in which case
5733 # a test message is built from EXP.
5735 proc get_hexadecimal_valueof { exp default {test ""} } {
5739 set test "get hexadecimal valueof \"${exp}\""
5743 gdb_test_multiple "print /x ${exp}" $test {
5744 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5745 set val $expect_out(1,string)
5752 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5753 # is used as fallback if print fails. TEST is the test message to use.
5754 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5756 proc get_sizeof { type default {test ""} } {
5757 return [get_integer_valueof "sizeof (${type})" $default $test]
5760 proc get_target_charset { } {
5763 gdb_test_multiple "show target-charset" "" {
5764 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5765 return $expect_out(1,string)
5767 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5768 return $expect_out(1,string)
5772 # Pick a reasonable default.
5773 warning "Unable to read target-charset."
5777 # Get the address of VAR.
5779 proc get_var_address { var } {
5780 global gdb_prompt hex
5782 # Match output like:
5784 # $5 = (int (*)()) 0
5785 # $6 = (int (*)()) 0x24 <function_bar>
5787 gdb_test_multiple "print &${var}" "get address of ${var}" {
5788 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5790 pass "get address of ${var}"
5791 if { $expect_out(1,string) == "0" } {
5794 return $expect_out(1,string)
5801 # Return the frame number for the currently selected frame
5802 proc get_current_frame_number {{test_name ""}} {
5805 if { $test_name == "" } {
5806 set test_name "get current frame number"
5809 gdb_test_multiple "frame" $test_name {
5810 -re "#(\[0-9\]+) .*$gdb_prompt $" {
5811 set frame_num $expect_out(1,string)
5817 # Get the current value for remotetimeout and return it.
5818 proc get_remotetimeout { } {
5822 gdb_test_multiple "show remotetimeout" "" {
5823 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5824 return $expect_out(1,string)
5828 # Pick the default that gdb uses
5829 warning "Unable to read remotetimeout"
5833 # Set the remotetimeout to the specified timeout. Nothing is returned.
5834 proc set_remotetimeout { timeout } {
5837 gdb_test_multiple "set remotetimeout $timeout" "" {
5838 -re "$gdb_prompt $" {
5839 verbose "Set remotetimeout to $timeout\n"
5844 # Get the target's current endianness and return it.
5845 proc get_endianness { } {
5848 gdb_test_multiple "show endian" "determine endianness" {
5849 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5851 return $expect_out(1,string)
5857 # ROOT and FULL are file names. Returns the relative path from ROOT
5858 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5859 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5862 proc relative_filename {root full} {
5863 set root_split [file split $root]
5864 set full_split [file split $full]
5866 set len [llength $root_split]
5868 if {[eval file join $root_split]
5869 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5870 error "$full not a subdir of $root"
5873 return [eval file join [lrange $full_split $len end]]
5876 # Log gdb command line and script if requested.
5877 if {[info exists TRANSCRIPT]} {
5878 rename send_gdb real_send_gdb
5879 rename remote_spawn real_remote_spawn
5880 rename remote_close real_remote_close
5882 global gdb_transcript
5883 set gdb_transcript ""
5885 global gdb_trans_count
5886 set gdb_trans_count 1
5888 proc remote_spawn {args} {
5889 global gdb_transcript gdb_trans_count outdir
5891 if {$gdb_transcript != ""} {
5892 close $gdb_transcript
5894 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5895 puts $gdb_transcript [lindex $args 1]
5896 incr gdb_trans_count
5898 return [uplevel real_remote_spawn $args]
5901 proc remote_close {args} {
5902 global gdb_transcript
5904 if {$gdb_transcript != ""} {
5905 close $gdb_transcript
5906 set gdb_transcript ""
5909 return [uplevel real_remote_close $args]
5912 proc send_gdb {args} {
5913 global gdb_transcript
5915 if {$gdb_transcript != ""} {
5916 puts -nonewline $gdb_transcript [lindex $args 0]
5919 return [uplevel real_send_gdb $args]
5923 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5924 if {[info exists GDB_PARALLEL]} {
5925 if {[is_remote host]} {
5929 [make_gdb_parallel_path outputs] \
5930 [make_gdb_parallel_path temp] \
5931 [make_gdb_parallel_path cache]
5935 proc core_find {binfile {deletefiles {}} {arg ""}} {
5936 global objdir subdir
5938 set destcore "$binfile.core"
5939 file delete $destcore
5941 # Create a core file named "$destcore" rather than just "core", to
5942 # avoid problems with sys admin types that like to regularly prune all
5943 # files named "core" from the system.
5945 # Arbitrarily try setting the core size limit to "unlimited" since
5946 # this does not hurt on systems where the command does not work and
5947 # allows us to generate a core on systems where it does.
5949 # Some systems append "core" to the name of the program; others append
5950 # the name of the program to "core"; still others (like Linux, as of
5951 # May 2003) create cores named "core.PID". In the latter case, we
5952 # could have many core files lying around, and it may be difficult to
5953 # tell which one is ours, so let's run the program in a subdirectory.
5955 set coredir [standard_output_file coredir.[getpid]]
5957 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5958 # remote_exec host "${binfile}"
5959 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5960 if [remote_file build exists $i] {
5961 remote_exec build "mv $i $destcore"
5965 # Check for "core.PID".
5966 if { $found == 0 } {
5967 set names [glob -nocomplain -directory $coredir core.*]
5968 if {[llength $names] == 1} {
5969 set corefile [file join $coredir [lindex $names 0]]
5970 remote_exec build "mv $corefile $destcore"
5974 if { $found == 0 } {
5975 # The braindamaged HPUX shell quits after the ulimit -c above
5976 # without executing ${binfile}. So we try again without the
5977 # ulimit here if we didn't find a core file above.
5978 # Oh, I should mention that any "braindamaged" non-Unix system has
5979 # the same problem. I like the cd bit too, it's really neat'n stuff.
5980 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5981 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5982 if [remote_file build exists $i] {
5983 remote_exec build "mv $i $destcore"
5989 # Try to clean up after ourselves.
5990 foreach deletefile $deletefiles {
5991 remote_file build delete [file join $coredir $deletefile]
5993 remote_exec build "rmdir $coredir"
5995 if { $found == 0 } {
5996 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6002 # gdb_target_symbol_prefix compiles a test program and then examines
6003 # the output from objdump to determine the prefix (such as underscore)
6004 # for linker symbol prefixes.
6006 gdb_caching_proc gdb_target_symbol_prefix {
6007 # Compile a simple test program...
6008 set src { int main() { return 0; } }
6009 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6015 set objdump_program [gdb_find_objdump]
6016 set result [catch "exec $objdump_program --syms $obj" output]
6019 && ![regexp -lineanchor \
6020 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6021 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6029 # Return 1 if target supports scheduler locking, otherwise return 0.
6031 gdb_caching_proc target_supports_scheduler_locking {
6034 set me "gdb_target_supports_scheduler_locking"
6036 set src { int main() { return 0; } }
6037 if {![gdb_simple_compile $me $src executable]} {
6046 set supports_schedule_locking -1
6047 set current_schedule_locking_mode ""
6049 set test "reading current scheduler-locking mode"
6050 gdb_test_multiple "show scheduler-locking" $test {
6051 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6052 set current_schedule_locking_mode $expect_out(1,string)
6054 -re "$gdb_prompt $" {
6055 set supports_schedule_locking 0
6058 set supports_schedule_locking 0
6062 if { $supports_schedule_locking == -1 } {
6063 set test "checking for scheduler-locking support"
6064 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6065 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6066 set supports_schedule_locking 0
6068 -re "$gdb_prompt $" {
6069 set supports_schedule_locking 1
6072 set supports_schedule_locking 0
6077 if { $supports_schedule_locking == -1 } {
6078 set supports_schedule_locking 0
6082 remote_file build delete $obj
6083 verbose "$me: returning $supports_schedule_locking" 2
6084 return $supports_schedule_locking
6087 # gdb_target_symbol returns the provided symbol with the correct prefix
6088 # prepended. (See gdb_target_symbol_prefix, above.)
6090 proc gdb_target_symbol { symbol } {
6091 set prefix [gdb_target_symbol_prefix]
6092 return "${prefix}${symbol}"
6095 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6096 # added to gdb_compile options to define the C-preprocessor macro
6097 # SYMBOL_PREFIX with a value that can be prepended to symbols
6098 # for targets which require a prefix, such as underscore.
6100 # This version (_asm) defines the prefix without double quotes
6101 # surrounding the prefix. It is used to define the macro
6102 # SYMBOL_PREFIX for assembly language files. Another version, below,
6103 # is used for symbols in inline assembler in C/C++ files.
6105 # The lack of quotes in this version (_asm) makes it possible to
6106 # define supporting macros in the .S file. (The version which
6107 # uses quotes for the prefix won't work for such files since it's
6108 # impossible to define a quote-stripping macro in C.)
6110 # It's possible to use this version (_asm) for C/C++ source files too,
6111 # but a string is usually required in such files; providing a version
6112 # (no _asm) which encloses the prefix with double quotes makes it
6113 # somewhat easier to define the supporting macros in the test case.
6115 proc gdb_target_symbol_prefix_flags_asm {} {
6116 set prefix [gdb_target_symbol_prefix]
6117 if {$prefix ne ""} {
6118 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6124 # gdb_target_symbol_prefix_flags returns the same string as
6125 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6126 # enclosed in double quotes if there is a prefix.
6128 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6129 # extended discussion.
6131 proc gdb_target_symbol_prefix_flags {} {
6132 set prefix [gdb_target_symbol_prefix]
6133 if {$prefix ne ""} {
6134 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6140 # A wrapper for 'remote_exec host' that passes or fails a test.
6141 # Returns 0 if all went well, nonzero on failure.
6142 # TEST is the name of the test, other arguments are as for remote_exec.
6144 proc run_on_host { test program args } {
6145 verbose -log "run_on_host: $program $args"
6146 # remote_exec doesn't work properly if the output is set but the
6147 # input is the empty string -- so replace an empty input with
6149 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6150 set args [lreplace $args 1 1 "/dev/null"]
6152 set result [eval remote_exec host [list $program] $args]
6153 verbose "result is $result"
6154 set status [lindex $result 0]
6155 set output [lindex $result 1]
6160 verbose -log "run_on_host failed: $output"
6166 # Return non-zero if "board_info debug_flags" mentions Fission.
6167 # http://gcc.gnu.org/wiki/DebugFission
6168 # Fission doesn't support everything yet.
6169 # This supports working around bug 15954.
6171 proc using_fission { } {
6172 set debug_flags [board_info [target_info name] debug_flags]
6173 return [regexp -- "-gsplit-dwarf" $debug_flags]
6176 # Search the caller's ARGS list and set variables according to the list of
6177 # valid options described by ARGSET.
6179 # The first member of each one- or two-element list in ARGSET defines the
6180 # name of a variable that will be added to the caller's scope.
6182 # If only one element is given to describe an option, it the value is
6183 # 0 if the option is not present in (the caller's) ARGS or 1 if
6186 # If two elements are given, the second element is the default value of
6187 # the variable. This is then overwritten if the option exists in ARGS.
6189 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6190 # any optional components.
6193 # proc myproc {foo args} {
6194 # parse_args {{bar} {baz "abc"} {qux}}
6197 # myproc ABC -bar -baz DEF peanut butter
6198 # will define the following variables in myproc:
6199 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6200 # args will be the list {peanut butter}
6202 proc parse_args { argset } {
6205 foreach argument $argset {
6206 if {[llength $argument] == 1} {
6207 # No default specified, so we assume that we should set
6208 # the value to 1 if the arg is present and 0 if it's not.
6209 # It is assumed that no value is given with the argument.
6210 set result [lsearch -exact $args "-$argument"]
6211 if {$result != -1} then {
6212 uplevel 1 [list set $argument 1]
6213 set args [lreplace $args $result $result]
6215 uplevel 1 [list set $argument 0]
6217 } elseif {[llength $argument] == 2} {
6218 # There are two items in the argument. The second is a
6219 # default value to use if the item is not present.
6220 # Otherwise, the variable is set to whatever is provided
6221 # after the item in the args.
6222 set arg [lindex $argument 0]
6223 set result [lsearch -exact $args "-[lindex $arg 0]"]
6224 if {$result != -1} then {
6225 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6226 set args [lreplace $args $result [expr $result+1]]
6228 uplevel 1 [list set $arg [lindex $argument 1]]
6231 error "Badly formatted argument \"$argument\" in argument set"
6235 # The remaining args should be checked to see that they match the
6236 # number of items expected to be passed into the procedure...
6239 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6240 # return that string.
6242 proc capture_command_output { command prefix } {
6246 set output_string ""
6247 gdb_test_multiple "$command" "capture_command_output for $command" {
6248 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6249 set output_string $expect_out(1,string)
6252 return $output_string
6255 # A convenience function that joins all the arguments together, with a
6256 # regexp that matches exactly one end of line in between each argument.
6257 # This function is ideal to write the expected output of a GDB command
6258 # that generates more than a couple of lines, as this allows us to write
6259 # each line as a separate string, which is easier to read by a human
6262 proc multi_line { args } {
6263 return [join $args "\r\n"]
6266 # Similar to the above, but while multi_line is meant to be used to
6267 # match GDB output, this one is meant to be used to build strings to
6268 # send as GDB input.
6270 proc multi_line_input { args } {
6271 return [join $args "\n"]
6274 # Return the version of the DejaGnu framework.
6276 # The return value is a list containing the major, minor and patch version
6277 # numbers. If the version does not contain a minor or patch number, they will
6278 # be set to 0. For example:
6284 proc dejagnu_version { } {
6285 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6286 global frame_version
6288 verbose -log "DejaGnu version: $frame_version"
6289 verbose -log "Expect version: [exp_version]"
6290 verbose -log "Tcl version: [info tclversion]"
6292 set dg_ver [split $frame_version .]
6294 while { [llength $dg_ver] < 3 } {
6301 # Define user-defined command COMMAND using the COMMAND_LIST as the
6302 # command's definition. The terminating "end" is added automatically.
6304 proc gdb_define_cmd {command command_list} {
6307 set input [multi_line_input {*}$command_list "end"]
6308 set test "define $command"
6310 gdb_test_multiple "define $command" $test {
6312 gdb_test_multiple $input $test {
6313 -re "\r\n$gdb_prompt " {
6320 # Override the 'cd' builtin with a version that ensures that the
6321 # log file keeps pointing at the same file. We need this because
6322 # unfortunately the path to the log file is recorded using an
6323 # relative path name, and, we sometimes need to close/reopen the log
6324 # after changing the current directory. See get_compiler_info.
6326 rename cd builtin_cd
6330 # Get the existing log file flags.
6331 set log_file_info [log_file -info]
6333 # Split the flags into args and file name.
6334 set log_file_flags ""
6335 set log_file_file ""
6336 foreach arg [ split "$log_file_info" " "] {
6337 if [string match "-*" $arg] {
6338 lappend log_file_flags $arg
6340 lappend log_file_file $arg
6344 # If there was an existing file, ensure it is an absolute path, and then
6346 if { $log_file_file != "" } {
6347 set log_file_file [file normalize $log_file_file]
6349 log_file $log_file_flags "$log_file_file"
6352 # Call the builtin version of cd.
6356 # Always load compatibility stuff.