1 # Copyright 1992-2020 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"
28 # List of procs to run in gdb_finish.
29 set gdb_finish_hooks [list]
31 # Variable in which we keep track of globals that are allowed to be live
33 array set gdb_persistent_globals {}
35 # Mark variable names in ARG as a persistent global, and declare them as
36 # global in the calling context. Can be used to rewrite "global var_a var_b"
37 # into "gdb_persistent_global var_a var_b".
38 proc gdb_persistent_global { args } {
39 global gdb_persistent_globals
40 foreach varname $args {
41 uplevel 1 global $varname
42 set gdb_persistent_globals($varname) 1
46 # Mark variable names in ARG as a persistent global.
47 proc gdb_persistent_global_no_decl { args } {
48 global gdb_persistent_globals
49 foreach varname $args {
50 set gdb_persistent_globals($varname) 1
54 # Override proc load_lib.
55 rename load_lib saved_load_lib
56 # Run the runtest version of load_lib, and mark all variables that were
57 # created by this call as persistent.
58 proc load_lib { file } {
59 array set known_global {}
60 foreach varname [info globals] {
61 set known_globals($varname) 1
64 set code [catch "saved_load_lib $file" result]
66 foreach varname [info globals] {
67 if { ![info exists known_globals($varname)] } {
68 gdb_persistent_global_no_decl $varname
73 global errorInfo errorCode
74 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
75 } elseif {$code > 1} {
76 return -code $code $result
84 load_lib gdb-utils.exp
86 load_lib check-test-names.exp
90 # The spawn ID used for I/O interaction with the inferior. For native
91 # targets, or remote targets that can do I/O through GDB
92 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
93 # Otherwise, the board may set this to some other spawn ID. E.g.,
94 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
95 # so input/output is done on gdbserver's tty.
96 global inferior_spawn_id
98 if [info exists TOOL_EXECUTABLE] {
99 set GDB $TOOL_EXECUTABLE
101 if ![info exists GDB] {
102 if ![is_remote host] {
103 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
105 set GDB [transform gdb]
108 verbose "using GDB = $GDB" 2
110 # GDBFLAGS is available for the user to set on the command line.
111 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
112 # Testcases may use it to add additional flags, but they must:
113 # - append new flags, not overwrite
114 # - restore the original value when done
116 if ![info exists GDBFLAGS] {
119 verbose "using GDBFLAGS = $GDBFLAGS" 2
121 # Make the build data directory available to tests.
122 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
124 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
125 global INTERNAL_GDBFLAGS
126 if ![info exists INTERNAL_GDBFLAGS] {
127 set INTERNAL_GDBFLAGS \
131 "-data-directory $BUILD_DATA_DIRECTORY" \
132 {-iex "set height 0"} \
133 {-iex "set width 0"}]]
136 # The variable gdb_prompt is a regexp which matches the gdb prompt.
137 # Set it if it is not already set. This is also set by default_gdb_init
138 # but it's not clear what removing one of them will break.
139 # See with_gdb_prompt for more details on prompt handling.
141 if ![info exists gdb_prompt] then {
142 set gdb_prompt "\\(gdb\\)"
145 # A regexp that matches the pagination prompt.
146 set pagination_prompt \
147 "--Type <RET> for more, q to quit, c to continue without paging--"
149 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
150 # absolute path ie. /foo/
151 set fullname_syntax_POSIX {/[^\n]*/}
152 # The variable fullname_syntax_UNC is a regexp which matches a Windows
153 # UNC path ie. \\D\foo\
154 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
155 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
156 # particular DOS case that GDB most likely will output
157 # ie. \foo\, but don't match \\.*\
158 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
159 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
160 # ie. a:\foo\ && a:foo\
161 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
162 # The variable fullname_syntax is a regexp which matches what GDB considers
163 # an absolute path. It is currently debatable if the Windows style paths
164 # d:foo and \abc should be considered valid as an absolute path.
165 # Also, the purpse of this regexp is not to recognize a well formed
166 # absolute path, but to say with certainty that a path is absolute.
167 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
169 # Needed for some tests under Cygwin.
173 if ![info exists env(EXEEXT)] {
176 set EXEEXT $env(EXEEXT)
181 set inferior_exited_re "(?:\\\[Inferior \[0-9\]+ \\(\[^\n\r\]*\\) exited)"
183 # A regular expression that matches a value history number.
185 set valnum_re "\\\$$decimal"
187 ### Only procedures should come after this point.
190 # gdb_version -- extract and print the version number of GDB
192 proc default_gdb_version {} {
194 global INTERNAL_GDBFLAGS GDBFLAGS
198 if {[info exists inotify_pid]} {
199 eval exec kill $inotify_pid
202 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
203 set tmp [lindex $output 1]
205 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
206 if ![is_remote host] {
207 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
209 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
213 proc gdb_version { } {
214 return [default_gdb_version]
218 # gdb_unload -- unload a file if one is loaded
219 # Return 0 on success, -1 on error.
227 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
228 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
229 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
230 send_gdb "y\n" answer
233 -re "Discard symbol table from .*y or n.*$" {
234 send_gdb "y\n" answer
237 -re "$gdb_prompt $" {}
239 perror "couldn't unload file in $GDB (timeout)."
246 # Many of the tests depend on setting breakpoints at various places and
247 # running until that breakpoint is reached. At times, we want to start
248 # with a clean-slate with respect to breakpoints, so this utility proc
249 # lets us do this without duplicating this code everywhere.
252 proc delete_breakpoints {} {
255 # we need a larger timeout value here or this thing just confuses
256 # itself. May need a better implementation if possible. - guo
260 set msg "delete all breakpoints in delete_breakpoints"
262 gdb_test_multiple "delete breakpoints" "$msg" {
263 -re "Delete all breakpoints.*y or n.*$" {
264 send_gdb "y\n" answer
267 -re "$gdb_prompt $" {
273 # Confirm with "info breakpoints".
275 set msg "info breakpoints"
276 gdb_test_multiple $msg $msg {
277 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
280 -re "$gdb_prompt $" {
286 perror "breakpoints not deleted"
290 # Returns true iff the target supports using the "run" command.
292 proc target_can_use_run_cmd {} {
293 if [target_info exists use_gdb_stub] {
294 # In this case, when we connect, the inferior is already
303 # Generic run command.
305 # Return 0 if we could start the program, -1 if we could not.
307 # The second pattern below matches up to the first newline *only*.
308 # Using ``.*$'' could swallow up output that we attempt to match
311 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
312 # inferior arguments.
314 # N.B. This function does not wait for gdb to return to the prompt,
315 # that is the caller's responsibility.
317 proc gdb_run_cmd { {inferior_args {}} } {
318 global gdb_prompt use_gdb_stub
320 foreach command [gdb_init_commands] {
321 send_gdb "$command\n"
323 -re "$gdb_prompt $" { }
325 perror "gdb_init_command for target failed"
332 if [target_info exists gdb,do_reload_on_run] {
333 if { [gdb_reload $inferior_args] != 0 } {
336 send_gdb "continue\n"
338 -re "Continu\[^\r\n\]*\[\r\n\]" {}
344 if [target_info exists gdb,start_symbol] {
345 set start [target_info gdb,start_symbol]
349 send_gdb "jump *$start\n"
351 while { $start_attempt } {
352 # Cap (re)start attempts at three to ensure that this loop
353 # always eventually fails. Don't worry about trying to be
354 # clever and not send a command when it has failed.
355 if [expr $start_attempt > 3] {
356 perror "Jump to start() failed (retry count exceeded)"
359 set start_attempt [expr $start_attempt + 1]
361 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
364 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
365 perror "Can't find start symbol to run in gdb_run"
368 -re "No symbol \"start\" in current.*$gdb_prompt $" {
369 send_gdb "jump *_start\n"
371 -re "No symbol.*context.*$gdb_prompt $" {
374 -re "Line.* Jump anyway.*y or n. $" {
375 send_gdb "y\n" answer
377 -re "The program is not being run.*$gdb_prompt $" {
378 if { [gdb_reload $inferior_args] != 0 } {
381 send_gdb "jump *$start\n"
384 perror "Jump to start() failed (timeout)"
393 if [target_info exists gdb,do_reload_on_run] {
394 if { [gdb_reload $inferior_args] != 0 } {
398 send_gdb "run $inferior_args\n"
399 # This doesn't work quite right yet.
400 # Use -notransfer here so that test cases (like chng-sym.exp)
401 # may test for additional start-up messages.
403 -re "The program .* has been started already.*y or n. $" {
404 send_gdb "y\n" answer
407 -notransfer -re "Starting program: \[^\r\n\]*" {}
408 -notransfer -re "$gdb_prompt $" {
409 # There is no more input expected.
416 # Generic start command. Return 0 if we could start the program, -1
419 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
420 # inferior arguments.
422 # N.B. This function does not wait for gdb to return to the prompt,
423 # that is the caller's responsibility.
425 proc gdb_start_cmd { {inferior_args {}} } {
426 global gdb_prompt use_gdb_stub
428 foreach command [gdb_init_commands] {
429 send_gdb "$command\n"
431 -re "$gdb_prompt $" { }
433 perror "gdb_init_command for target failed"
443 send_gdb "start $inferior_args\n"
444 # Use -notransfer here so that test cases (like chng-sym.exp)
445 # may test for additional start-up messages.
447 -re "The program .* has been started already.*y or n. $" {
448 send_gdb "y\n" answer
451 -notransfer -re "Starting program: \[^\r\n\]*" {
458 # Generic starti command. Return 0 if we could start the program, -1
461 # INFERIOR_ARGS is passed as arguments to the starti command, so may contain
462 # inferior arguments.
464 # N.B. This function does not wait for gdb to return to the prompt,
465 # that is the caller's responsibility.
467 proc gdb_starti_cmd { {inferior_args {}} } {
468 global gdb_prompt use_gdb_stub
470 foreach command [gdb_init_commands] {
471 send_gdb "$command\n"
473 -re "$gdb_prompt $" { }
475 perror "gdb_init_command for target failed"
485 send_gdb "starti $inferior_args\n"
487 -re "The program .* has been started already.*y or n. $" {
488 send_gdb "y\n" answer
491 -re "Starting program: \[^\r\n\]*" {
498 # Set a breakpoint at FUNCTION. If there is an additional argument it is
499 # a list of options; the supported options are allow-pending, temporary,
500 # message, no-message and qualified.
501 # The result is 1 for success, 0 for failure.
503 # Note: The handling of message vs no-message is messed up, but it's based
504 # on historical usage. By default this function does not print passes,
506 # no-message: turns off printing of fails (and passes, but they're already off)
507 # message: turns on printing of passes (and fails, but they're already on)
509 proc gdb_breakpoint { function args } {
513 set pending_response n
514 if {[lsearch -exact $args allow-pending] != -1} {
515 set pending_response y
518 set break_command "break"
519 set break_message "Breakpoint"
520 if {[lsearch -exact $args temporary] != -1} {
521 set break_command "tbreak"
522 set break_message "Temporary breakpoint"
525 if {[lsearch -exact $args qualified] != -1} {
526 append break_command " -qualified"
531 set no_message_loc [lsearch -exact $args no-message]
532 set message_loc [lsearch -exact $args message]
533 # The last one to appear in args wins.
534 if { $no_message_loc > $message_loc } {
536 } elseif { $message_loc > $no_message_loc } {
540 set test_name "setting breakpoint at $function"
542 send_gdb "$break_command $function\n"
543 # The first two regexps are what we get with -g, the third is without -g.
545 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
546 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
547 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
548 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
549 if {$pending_response == "n"} {
556 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
557 send_gdb "$pending_response\n"
560 -re "A problem internal to GDB has been detected" {
562 fail "$test_name (GDB internal error)"
564 gdb_internal_error_resync
567 -re "$gdb_prompt $" {
574 perror "GDB process no longer exists"
576 set wait_status [wait -i $gdb_spawn_id]
577 verbose -log "GDB process exited with wait status $wait_status"
579 fail "$test_name (eof)"
585 fail "$test_name (timeout)"
596 # Set breakpoint at function and run gdb until it breaks there.
597 # Since this is the only breakpoint that will be set, if it stops
598 # at a breakpoint, we will assume it is the one we want. We can't
599 # just compare to "function" because it might be a fully qualified,
600 # single quoted C++ function specifier.
602 # If there are additional arguments, pass them to gdb_breakpoint.
603 # We recognize no-message/message ourselves.
604 # The default is no-message.
605 # no-message is messed up here, like gdb_breakpoint: to preserve
606 # historical usage fails are always printed by default.
607 # no-message: turns off printing of fails (and passes, but they're already off)
608 # message: turns on printing of passes (and fails, but they're already on)
610 proc runto { function args } {
616 # Default to "no-message".
617 set args "no-message $args"
621 set no_message_loc [lsearch -exact $args no-message]
622 set message_loc [lsearch -exact $args message]
623 # The last one to appear in args wins.
624 if { $no_message_loc > $message_loc } {
626 } elseif { $message_loc > $no_message_loc } {
630 set test_name "running to $function in runto"
632 # We need to use eval here to pass our varargs args to gdb_breakpoint
633 # which is also a varargs function.
634 # But we also have to be careful because $function may have multiple
635 # elements, and we don't want Tcl to move the remaining elements after
636 # the first to $args. That is why $function is wrapped in {}.
637 if ![eval gdb_breakpoint {$function} $args] {
643 # the "at foo.c:36" output we get with -g.
644 # the "in func" output we get without -g.
646 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
652 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
658 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
660 unsupported "non-stop mode not supported"
664 -re ".*A problem internal to GDB has been detected" {
665 # Always emit a FAIL if we encounter an internal error: internal
666 # errors are never expected.
667 fail "$test_name (GDB internal error)"
668 gdb_internal_error_resync
671 -re "$gdb_prompt $" {
679 fail "$test_name (eof)"
685 fail "$test_name (timeout)"
696 # Ask gdb to run until we hit a breakpoint at main.
698 # N.B. This function deletes all existing breakpoints.
699 # If you don't want that, use gdb_start_cmd.
701 proc runto_main { } {
702 return [runto main no-message qualified]
705 ### Continue, and expect to hit a breakpoint.
706 ### Report a pass or fail, depending on whether it seems to have
707 ### worked. Use NAME as part of the test name; each call to
708 ### continue_to_breakpoint should use a NAME which is unique within
710 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
712 set full_name "continue to breakpoint: $name"
714 set kfail_pattern "Process record does not support instruction 0xfae64 at.*"
715 gdb_test_multiple "continue" $full_name {
716 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
719 -re "\[\r\n\]*(?:$kfail_pattern)\[\r\n\]+$gdb_prompt $" {
720 kfail "gdb/25038" $full_name
726 # gdb_internal_error_resync:
728 # Answer the questions GDB asks after it reports an internal error
729 # until we get back to a GDB prompt. Decline to quit the debugging
730 # session, and decline to create a core file. Return non-zero if the
733 # This procedure just answers whatever questions come up until it sees
734 # a GDB prompt; it doesn't require you to have matched the input up to
735 # any specific point. However, it only answers questions it sees in
736 # the output itself, so if you've matched a question, you had better
737 # answer it yourself before calling this.
739 # You can use this function thus:
743 # -re ".*A problem internal to GDB has been detected" {
744 # gdb_internal_error_resync
749 proc gdb_internal_error_resync {} {
752 verbose -log "Resyncing due to internal error."
755 while {$count < 10} {
757 -re "Quit this debugging session\\? \\(y or n\\) $" {
758 send_gdb "n\n" answer
761 -re "Create a core file of GDB\\? \\(y or n\\) $" {
762 send_gdb "n\n" answer
765 -re "$gdb_prompt $" {
766 # We're resynchronized.
770 perror "Could not resync from internal error (timeout)"
775 perror "Could not resync from internal error (resync count exceeded)"
780 # gdb_test_multiple COMMAND MESSAGE [ -promp PROMPT_REGEXP] [ -lbl ]
782 # Send a command to gdb; test the result.
784 # COMMAND is the command to execute, send to GDB with send_gdb. If
785 # this is the null string no command is sent.
786 # MESSAGE is a message to be printed with the built-in failure patterns
787 # if one of them matches. If MESSAGE is empty COMMAND will be used.
788 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
789 # after the command output. If empty, defaults to "$gdb_prompt $".
790 # -lbl specifies that line-by-line matching will be used.
791 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
792 # patterns. Pattern elements will be evaluated in the caller's
793 # context; action elements will be executed in the caller's context.
794 # Unlike patterns for gdb_test, these patterns should generally include
795 # the final newline and prompt.
798 # 1 if the test failed, according to a built-in failure pattern
799 # 0 if only user-supplied patterns matched
800 # -1 if there was an internal error.
802 # You can use this function thus:
804 # gdb_test_multiple "print foo" "test foo" {
805 # -re "expected output 1" {
808 # -re "expected output 2" {
813 # Within action elements you can also make use of the variable
814 # gdb_test_name. This variable is setup automatically by
815 # gdb_test_multiple, and contains the value of MESSAGE. You can then
816 # write this, which is equivalent to the above:
818 # gdb_test_multiple "print foo" "test foo" {
819 # -re "expected output 1" {
820 # pass $gdb_test_name
822 # -re "expected output 2" {
823 # fail $gdb_test_name
827 # Like with "expect", you can also specify the spawn id to match with
828 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
829 # $gdb_spawn_id. The former matches inferior I/O, while the latter
830 # matches GDB I/O. E.g.:
832 # send_inferior "hello\n"
833 # gdb_test_multiple "continue" "test echo" {
834 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
837 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
838 # fail "hit breakpoint"
842 # The standard patterns, such as "Inferior exited..." and "A problem
843 # ...", all being implicitly appended to that list. These are always
844 # expected from $gdb_spawn_id. IOW, callers do not need to worry
845 # about resetting "-i" back to $gdb_spawn_id explicitly.
847 # In EXPECT_ARGUMENTS we can use a -wrap pattern flag, that wraps the regexp
848 # pattern as gdb_test wraps its message argument.
849 # This allows us to rewrite:
850 # gdb_test <command> <pattern> <message>
852 # gdb_test_multiple <command> <message> {
853 # -re -wrap <pattern> {
854 # pass $gdb_test_name
858 # In EXPECT_ARGUMENTS, a pattern flag -early can be used. It makes sure the
859 # pattern is inserted before any implicit pattern added by gdb_test_multiple.
860 # Using this pattern flag, we can f.i. setup a kfail for an assertion failure
861 # <assert> during gdb_continue_to_breakpoint by the rewrite:
862 # gdb_continue_to_breakpoint <msg> <pattern>
864 # set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
865 # gdb_test_multiple "continue" "continue to breakpoint: <msg>" {
866 # -early -re "internal-error: <assert>" {
867 # setup_kfail gdb/nnnnn "*-*-*"
870 # -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
871 # pass $gdb_test_name
875 proc gdb_test_multiple { command message args } {
876 global verbose use_gdb_stub
877 global gdb_prompt pagination_prompt
880 global inferior_exited_re
881 upvar timeout timeout
882 upvar expect_out expect_out
887 for {set i 0} {$i < [llength $args]} {incr i} {
888 set arg [lindex $args $i]
889 if { $arg == "-prompt" } {
891 set prompt_regexp [lindex $args $i]
892 } elseif { $arg == "-lbl" } {
899 if { [expr $i + 1] < [llength $args] } {
900 error "Too many arguments to gdb_test_multiple"
901 } elseif { ![info exists user_code] } {
902 error "Too few arguments to gdb_test_multiple"
905 if { "$prompt_regexp" == "" } {
906 set prompt_regexp "$gdb_prompt $"
909 if { $message == "" } {
913 if [string match "*\[\r\n\]" $command] {
914 error "Invalid trailing newline in \"$message\" test"
917 if [string match "*\[\r\n\]*" $message] {
918 error "Invalid newline in \"$message\" test"
922 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
924 error "gdbserver does not support $command without extended-remote"
927 # TCL/EXPECT WART ALERT
928 # Expect does something very strange when it receives a single braced
929 # argument. It splits it along word separators and performs substitutions.
930 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
931 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
932 # double-quoted list item, "\[ab\]" is just a long way of representing
933 # "[ab]", because the backslashes will be removed by lindex.
935 # Unfortunately, there appears to be no easy way to duplicate the splitting
936 # that expect will do from within TCL. And many places make use of the
937 # "\[0-9\]" construct, so we need to support that; and some places make use
938 # of the "[func]" construct, so we need to support that too. In order to
939 # get this right we have to substitute quoted list elements differently
940 # from braced list elements.
942 # We do this roughly the same way that Expect does it. We have to use two
943 # lists, because if we leave unquoted newlines in the argument to uplevel
944 # they'll be treated as command separators, and if we escape newlines
945 # we mangle newlines inside of command blocks. This assumes that the
946 # input doesn't contain a pattern which contains actual embedded newlines
949 regsub -all {\n} ${user_code} { } subst_code
950 set subst_code [uplevel list $subst_code]
952 set processed_code ""
953 set early_processed_code ""
954 # The variable current_list holds the name of the currently processed
955 # list, either processed_code or early_processed_code.
956 set current_list "processed_code"
958 set expecting_action 0
961 foreach item $user_code subst_item $subst_code {
962 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
963 lappend $current_list $item
966 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
967 lappend $current_list $item
970 if { $item == "-early" } {
971 set current_list "early_processed_code"
974 if { $item == "-timeout" || $item == "-i" } {
976 lappend $current_list $item
979 if { $item == "-wrap" } {
983 if { $expecting_arg } {
985 lappend $current_list $subst_item
988 if { $expecting_action } {
989 lappend $current_list "uplevel [list $item]"
990 set expecting_action 0
991 # Cosmetic, no effect on the list.
992 append $current_list "\n"
993 # End the effect of -early, it only applies to one action.
994 set current_list "processed_code"
997 set expecting_action 1
998 if { $wrap_pattern } {
999 # Wrap subst_item as is done for the gdb_test PATTERN argument.
1000 lappend $current_list \
1001 "\[\r\n\]*(?:$subst_item)\[\r\n\]+$gdb_prompt $"
1004 lappend $current_list $subst_item
1006 if {$patterns != ""} {
1007 append patterns "; "
1009 append patterns "\"$subst_item\""
1012 # Also purely cosmetic.
1013 regsub -all {\r} $patterns {\\r} patterns
1014 regsub -all {\n} $patterns {\\n} patterns
1016 if $verbose>2 then {
1017 send_user "Sending \"$command\" to gdb\n"
1018 send_user "Looking to match \"$patterns\"\n"
1019 send_user "Message is \"$message\"\n"
1023 set string "${command}\n"
1024 if { $command != "" } {
1025 set multi_line_re "\[\r\n\] *>"
1026 while { "$string" != "" } {
1027 set foo [string first "\n" "$string"]
1028 set len [string length "$string"]
1029 if { $foo < [expr $len - 1] } {
1030 set str [string range "$string" 0 $foo]
1031 if { [send_gdb "$str"] != "" } {
1032 global suppress_flag
1034 if { ! $suppress_flag } {
1035 perror "Couldn't send $command to GDB."
1040 # since we're checking if each line of the multi-line
1041 # command are 'accepted' by GDB here,
1042 # we need to set -notransfer expect option so that
1043 # command output is not lost for pattern matching
1046 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
1047 timeout { verbose "partial: timeout" 3 }
1049 set string [string range "$string" [expr $foo + 1] end]
1050 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
1055 if { "$string" != "" } {
1056 if { [send_gdb "$string"] != "" } {
1057 global suppress_flag
1059 if { ! $suppress_flag } {
1060 perror "Couldn't send $command to GDB."
1068 set code $early_processed_code
1070 -re ".*A problem internal to GDB has been detected" {
1071 fail "$message (GDB internal error)"
1072 gdb_internal_error_resync
1075 -re "\\*\\*\\* DOSEXIT code.*" {
1076 if { $message != "" } {
1079 gdb_suppress_entire_file "GDB died"
1083 append code $processed_code
1085 # Reset the spawn id, in case the processed code used -i.
1091 -re "Ending remote debugging.*$prompt_regexp" {
1092 if ![isnative] then {
1093 warning "Can`t communicate to remote target."
1099 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
1100 perror "Undefined command \"$command\"."
1104 -re "Ambiguous command.*$prompt_regexp" {
1105 perror "\"$command\" is not a unique command name."
1109 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
1110 if ![string match "" $message] then {
1111 set errmsg "$message (the program exited)"
1113 set errmsg "$command (the program exited)"
1118 -re "$inferior_exited_re normally.*$prompt_regexp" {
1119 if ![string match "" $message] then {
1120 set errmsg "$message (the program exited)"
1122 set errmsg "$command (the program exited)"
1127 -re "The program is not being run.*$prompt_regexp" {
1128 if ![string match "" $message] then {
1129 set errmsg "$message (the program is no longer running)"
1131 set errmsg "$command (the program is no longer running)"
1136 -re "\r\n$prompt_regexp" {
1137 if ![string match "" $message] then {
1142 -re "$pagination_prompt" {
1144 perror "Window too small."
1148 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
1149 send_gdb "n\n" answer
1150 gdb_expect -re "$prompt_regexp"
1151 fail "$message (got interactive prompt)"
1154 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1156 gdb_expect -re "$prompt_regexp"
1157 fail "$message (got breakpoint menu)"
1163 perror "GDB process no longer exists"
1164 set wait_status [wait -i $gdb_spawn_id]
1165 verbose -log "GDB process exited with wait status $wait_status"
1166 if { $message != "" } {
1173 if {$line_by_line} {
1175 -re "\r\n\[^\r\n\]*(?=\r\n)" {
1181 # Now patterns that apply to any spawn id specified.
1185 perror "Process no longer exists"
1186 if { $message != "" } {
1192 perror "internal buffer is full."
1197 if ![string match "" $message] then {
1198 fail "$message (timeout)"
1204 # remote_expect calls the eof section if there is an error on the
1205 # expect call. We already have eof sections above, and we don't
1206 # want them to get called in that situation. Since the last eof
1207 # section becomes the error section, here we define another eof
1208 # section, but with an empty spawn_id list, so that it won't ever
1212 # This comment is here because the eof section must not be
1213 # the empty string, otherwise remote_expect won't realize
1218 # Create gdb_test_name in the parent scope. If this variable
1219 # already exists, which it might if we have nested calls to
1220 # gdb_test_multiple, then preserve the old value, otherwise,
1221 # create a new variable in the parent scope.
1222 upvar gdb_test_name gdb_test_name
1223 if { [info exists gdb_test_name] } {
1224 set gdb_test_name_old "$gdb_test_name"
1226 set gdb_test_name "$message"
1229 set code [catch {gdb_expect $code} string]
1231 # Clean up the gdb_test_name variable. If we had a
1232 # previous value then restore it, otherwise, delete the variable
1233 # from the parent scope.
1234 if { [info exists gdb_test_name_old] } {
1235 set gdb_test_name "$gdb_test_name_old"
1241 global errorInfo errorCode
1242 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1243 } elseif {$code > 1} {
1244 return -code $code $string
1249 # Usage: gdb_test_multiline NAME INPUT RESULT {INPUT RESULT} ...
1250 # Run a test named NAME, consisting of multiple lines of input.
1251 # After each input line INPUT, search for result line RESULT.
1252 # Succeed if all results are seen; fail otherwise.
1254 proc gdb_test_multiline { name args } {
1257 foreach {input result} $args {
1259 if {[gdb_test_multiple $input "$name: input $inputnr: $input" {
1260 -re "\[\r\n\]*($result)\[\r\n\]+($gdb_prompt | *>)$" {
1271 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1272 # Send a command to gdb; test the result.
1274 # COMMAND is the command to execute, send to GDB with send_gdb. If
1275 # this is the null string no command is sent.
1276 # PATTERN is the pattern to match for a PASS, and must NOT include
1277 # the \r\n sequence immediately before the gdb prompt. This argument
1278 # may be omitted to just match the prompt, ignoring whatever output
1280 # MESSAGE is an optional message to be printed. If this is
1281 # omitted, then the pass/fail messages use the command string as the
1282 # message. (If this is the empty string, then sometimes we don't
1283 # call pass or fail at all; I don't understand this at all.)
1284 # QUESTION is a question GDB may ask in response to COMMAND, like
1286 # RESPONSE is the response to send if QUESTION appears.
1289 # 1 if the test failed,
1290 # 0 if the test passes,
1291 # -1 if there was an internal error.
1293 proc gdb_test { args } {
1295 upvar timeout timeout
1297 if [llength $args]>2 then {
1298 set message [lindex $args 2]
1300 set message [lindex $args 0]
1302 set command [lindex $args 0]
1303 set pattern [lindex $args 1]
1307 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1308 if ![string match "" $message] then {
1314 if { [llength $args] == 5 } {
1315 set question_string [lindex $args 3]
1316 set response_string [lindex $args 4]
1318 -re "(${question_string})$" {
1319 send_gdb "$response_string\n"
1325 set user_code [join $user_code]
1326 return [gdb_test_multiple $command $message $user_code]
1329 # Return 1 if version MAJOR.MINOR is at least AT_LEAST_MAJOR.AT_LEAST_MINOR.
1330 proc version_at_least { major minor at_least_major at_least_minor} {
1331 if { $major > $at_least_major } {
1333 } elseif { $major == $at_least_major \
1334 && $minor >= $at_least_minor } {
1341 # Return 1 if tcl version used is at least MAJOR.MINOR
1342 proc tcl_version_at_least { major minor } {
1344 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1345 dummy tcl_version_major tcl_version_minor
1346 return [version_at_least $tcl_version_major $tcl_version_minor \
1350 if { [tcl_version_at_least 8 5] == 0 } {
1351 # lrepeat was added in tcl 8.5. Only add if missing.
1352 proc lrepeat { n element } {
1353 if { [string is integer -strict $n] == 0 } {
1354 error "expected integer but got \"$n\""
1357 error "bad count \"$n\": must be integer >= 0"
1360 for {set i 0} {$i < $n} {incr i} {
1361 lappend res $element
1367 # gdb_test_no_output COMMAND MESSAGE
1368 # Send a command to GDB and verify that this command generated no output.
1370 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1371 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1372 # the message. (If MESSAGE is the empty string, then sometimes we do not
1373 # call pass or fail at all; I don't understand this at all.)
1375 proc gdb_test_no_output { args } {
1377 set command [lindex $args 0]
1378 if [llength $args]>1 then {
1379 set message [lindex $args 1]
1381 set message $command
1384 set command_regex [string_to_regexp $command]
1385 gdb_test_multiple $command $message {
1386 -re "^$command_regex\r\n$gdb_prompt $" {
1387 if ![string match "" $message] then {
1394 # Send a command and then wait for a sequence of outputs.
1395 # This is useful when the sequence is long and contains ".*", a single
1396 # regexp to match the entire output can get a timeout much easier.
1398 # COMMAND is the command to execute, send to GDB with send_gdb. If
1399 # this is the null string no command is sent.
1400 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1401 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1402 # processed in order, and all must be present in the output.
1404 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1405 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1406 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1408 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1409 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1412 # 1 if the test failed,
1413 # 0 if the test passes,
1414 # -1 if there was an internal error.
1416 proc gdb_test_sequence { command test_name expected_output_list } {
1418 if { $test_name == "" } {
1419 set test_name $command
1421 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1422 if { $command != "" } {
1423 send_gdb "$command\n"
1425 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1429 # Test that a command gives an error. For pass or fail, return
1430 # a 1 to indicate that more tests can proceed. However a timeout
1431 # is a serious error, generates a special fail message, and causes
1432 # a 0 to be returned to indicate that more tests are likely to fail
1435 proc test_print_reject { args } {
1439 if [llength $args]==2 then {
1440 set expectthis [lindex $args 1]
1442 set expectthis "should never match this bogus string"
1444 set sendthis [lindex $args 0]
1445 if $verbose>2 then {
1446 send_user "Sending \"$sendthis\" to gdb\n"
1447 send_user "Looking to match \"$expectthis\"\n"
1449 send_gdb "$sendthis\n"
1450 #FIXME: Should add timeout as parameter.
1452 -re "A .* in expression.*\\.*$gdb_prompt $" {
1453 pass "reject $sendthis"
1456 -re "Invalid syntax in expression.*$gdb_prompt $" {
1457 pass "reject $sendthis"
1460 -re "Junk after end of expression.*$gdb_prompt $" {
1461 pass "reject $sendthis"
1464 -re "Invalid number.*$gdb_prompt $" {
1465 pass "reject $sendthis"
1468 -re "Invalid character constant.*$gdb_prompt $" {
1469 pass "reject $sendthis"
1472 -re "No symbol table is loaded.*$gdb_prompt $" {
1473 pass "reject $sendthis"
1476 -re "No symbol .* in current context.*$gdb_prompt $" {
1477 pass "reject $sendthis"
1480 -re "Unmatched single quote.*$gdb_prompt $" {
1481 pass "reject $sendthis"
1484 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1485 pass "reject $sendthis"
1488 -re "$expectthis.*$gdb_prompt $" {
1489 pass "reject $sendthis"
1492 -re ".*$gdb_prompt $" {
1493 fail "reject $sendthis"
1497 fail "reject $sendthis (eof or timeout)"
1504 # Same as gdb_test, but the second parameter is not a regexp,
1505 # but a string that must match exactly.
1507 proc gdb_test_exact { args } {
1508 upvar timeout timeout
1510 set command [lindex $args 0]
1512 # This applies a special meaning to a null string pattern. Without
1513 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1514 # messages from commands that should have no output except a new
1515 # prompt. With this, only results of a null string will match a null
1518 set pattern [lindex $args 1]
1519 if [string match $pattern ""] {
1520 set pattern [string_to_regexp [lindex $args 0]]
1522 set pattern [string_to_regexp [lindex $args 1]]
1525 # It is most natural to write the pattern argument with only
1526 # embedded \n's, especially if you are trying to avoid Tcl quoting
1527 # problems. But gdb_expect really wants to see \r\n in patterns. So
1528 # transform the pattern here. First transform \r\n back to \n, in
1529 # case some users of gdb_test_exact already do the right thing.
1530 regsub -all "\r\n" $pattern "\n" pattern
1531 regsub -all "\n" $pattern "\r\n" pattern
1532 if [llength $args]==3 then {
1533 set message [lindex $args 2]
1534 return [gdb_test $command $pattern $message]
1537 return [gdb_test $command $pattern]
1540 # Wrapper around gdb_test_multiple that looks for a list of expected
1541 # output elements, but which can appear in any order.
1542 # CMD is the gdb command.
1543 # NAME is the name of the test.
1544 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1546 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1547 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1548 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1550 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1551 # of text per element and then strip trailing \r\n's.
1553 # gdb_test_list_exact "foo" "bar" \
1554 # "\[^\r\n\]+\[\r\n\]+" \
1557 # {expected result 1} \
1558 # {expected result 2} \
1561 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1564 set matches [lsort $result_match_list]
1566 gdb_test_multiple $cmd $name {
1567 "$cmd\[\r\n\]" { exp_continue }
1568 -re $elm_find_regexp {
1569 set str $expect_out(0,string)
1570 verbose -log "seen: $str" 3
1571 regexp -- $elm_extract_regexp $str elm_seen
1572 verbose -log "extracted: $elm_seen" 3
1573 lappend seen $elm_seen
1576 -re "$gdb_prompt $" {
1578 foreach got [lsort $seen] have $matches {
1579 if {![string equal $got $have]} {
1584 if {[string length $failed] != 0} {
1585 fail "$name ($failed not found)"
1593 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1594 # Send a command to gdb; expect inferior and gdb output.
1596 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1599 # INFERIOR_PATTERN is the pattern to match against inferior output.
1601 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1602 # include the \r\n sequence immediately before the gdb prompt, nor the
1603 # prompt. The default is empty.
1605 # Both inferior and gdb patterns must match for a PASS.
1607 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1610 # 1 if the test failed,
1611 # 0 if the test passes,
1612 # -1 if there was an internal error.
1615 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1616 global inferior_spawn_id gdb_spawn_id
1619 if {$message == ""} {
1620 set message $command
1623 set inferior_matched 0
1626 # Use an indirect spawn id list, and remove the inferior spawn id
1627 # from the expected output as soon as it matches, in case
1628 # $inferior_pattern happens to be a prefix of the resulting full
1629 # gdb pattern below (e.g., "\r\n").
1630 global gdb_test_stdio_spawn_id_list
1631 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1633 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1634 # then we may see gdb's output arriving before the inferior's
1636 set res [gdb_test_multiple $command $message {
1637 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1638 set inferior_matched 1
1639 if {!$gdb_matched} {
1640 set gdb_test_stdio_spawn_id_list ""
1644 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1646 if {!$inferior_matched} {
1654 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1659 # Wrapper around gdb_test_multiple to be used when testing expression
1660 # evaluation while 'set debug expression 1' is in effect.
1661 # Looks for some patterns that indicates the expression was rejected.
1663 # CMD is the command to execute, which should include an expression
1664 # that GDB will need to parse.
1666 # OUTPUT is the expected output pattern.
1668 # TESTNAME is the name to be used for the test, defaults to CMD if not
1670 proc gdb_test_debug_expr { cmd output {testname "" }} {
1673 if { ${testname} == "" } {
1677 gdb_test_multiple $cmd $testname {
1678 -re ".*Invalid expression.*\r\n$gdb_prompt $" {
1681 -re ".*\[\r\n\]$output\r\n$gdb_prompt $" {
1687 # get_print_expr_at_depths EXP OUTPUTS
1689 # Used for testing 'set print max-depth'. Prints the expression EXP
1690 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1691 # of `n` different patterns to match at each of the depths from 0 to
1694 # This proc does one final check with the max-depth set to 'unlimited'
1695 # which is tested against the last pattern in the OUTPUTS list. The
1696 # OUTPUTS list is therefore required to match every depth from 0 to a
1697 # depth where the whole of EXP is printed with no ellipsis.
1699 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1700 proc gdb_print_expr_at_depths {exp outputs} {
1701 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1702 if { $depth == [llength $outputs] } {
1703 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1704 set depth_string "unlimited"
1706 set expected_result [lindex $outputs $depth]
1707 set depth_string $depth
1710 with_test_prefix "exp='$exp': depth=${depth_string}" {
1711 gdb_test_no_output "set print max-depth ${depth_string}"
1712 gdb_test "p $exp" "$expected_result"
1719 # Issue a PASS and return true if evaluating CONDITION in the caller's
1720 # frame returns true, and issue a FAIL and return false otherwise.
1721 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1722 # omitted or is empty, then the pass/fail messages use the condition
1723 # string as the message.
1725 proc gdb_assert { condition {message ""} } {
1726 if { $message == ""} {
1727 set message $condition
1730 set code [catch {uplevel 1 expr $condition} res]
1732 # If code is 1 (TCL_ERROR), it means evaluation failed and res contains
1733 # an error message. Print the error message, and set res to 0 since we
1734 # want to return a boolean.
1735 warning "While evaluating expression in gdb_assert: $res"
1738 } elseif { !$res } {
1746 proc gdb_reinitialize_dir { subdir } {
1749 if [is_remote host] {
1754 -re "Reinitialize source path to empty.*y or n. " {
1755 send_gdb "y\n" answer
1757 -re "Source directories searched.*$gdb_prompt $" {
1758 send_gdb "dir $subdir\n"
1760 -re "Source directories searched.*$gdb_prompt $" {
1761 verbose "Dir set to $subdir"
1763 -re "$gdb_prompt $" {
1764 perror "Dir \"$subdir\" failed."
1768 -re "$gdb_prompt $" {
1769 perror "Dir \"$subdir\" failed."
1773 -re "$gdb_prompt $" {
1774 perror "Dir \"$subdir\" failed."
1780 # gdb_exit -- exit the GDB, killing the target program if necessary
1782 proc default_gdb_exit {} {
1784 global INTERNAL_GDBFLAGS GDBFLAGS
1785 global gdb_spawn_id inferior_spawn_id
1786 global inotify_log_file
1788 gdb_stop_suppressing_tests
1790 if ![info exists gdb_spawn_id] {
1794 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1796 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1797 set fd [open $inotify_log_file]
1798 set data [read -nonewline $fd]
1801 if {[string compare $data ""] != 0} {
1802 warning "parallel-unsafe file creations noticed"
1805 set fd [open $inotify_log_file w]
1810 if { [is_remote host] && [board_info host exists fileid] } {
1814 send_gdb "y\n" answer
1817 -re "DOSEXIT code" { }
1822 if ![is_remote host] {
1826 unset inferior_spawn_id
1829 # Load a file into the debugger.
1830 # The return value is 0 for success, -1 for failure.
1832 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1833 # to one of these values:
1835 # debug file was loaded successfully and has debug information
1836 # nodebug file was loaded successfully and has no debug information
1837 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1839 # fail file was not loaded
1841 # This procedure also set the global variable GDB_FILE_CMD_MSG to the
1842 # output of the file command in case of success.
1844 # I tried returning this information as part of the return value,
1845 # but ran into a mess because of the many re-implementations of
1846 # gdb_load in config/*.exp.
1848 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1849 # this if they can get more information set.
1851 proc gdb_file_cmd { arg } {
1854 global last_loaded_file
1856 # GCC for Windows target may create foo.exe given "-o foo".
1857 if { ![file exists $arg] && [file exists "$arg.exe"] } {
1861 # Save this for the benefit of gdbserver-support.exp.
1862 set last_loaded_file $arg
1864 # Set whether debug info was found.
1865 # Default to "fail".
1866 global gdb_file_cmd_debug_info gdb_file_cmd_msg
1867 set gdb_file_cmd_debug_info "fail"
1869 if [is_remote host] {
1870 set arg [remote_download host $arg]
1872 perror "download failed"
1877 # The file command used to kill the remote target. For the benefit
1878 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
1879 # get written to the stdin log.
1880 send_gdb "kill\n" optional
1882 -re "Kill the program being debugged. .y or n. $" {
1883 send_gdb "y\n" answer
1884 verbose "\t\tKilling previous program being debugged"
1887 -re "$gdb_prompt $" {
1892 send_gdb "file $arg\n"
1893 set new_symbol_table 0
1894 set basename [file tail $arg]
1896 -re "(Reading symbols from.*LZMA support was disabled.*$gdb_prompt $)" {
1897 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1898 set gdb_file_cmd_msg $expect_out(1,string)
1899 set gdb_file_cmd_debug_info "lzma"
1902 -re "(Reading symbols from.*no debugging symbols found.*$gdb_prompt $)" {
1903 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1904 set gdb_file_cmd_msg $expect_out(1,string)
1905 set gdb_file_cmd_debug_info "nodebug"
1908 -re "(Reading symbols from.*$gdb_prompt $)" {
1909 verbose "\t\tLoaded $arg into $GDB"
1910 set gdb_file_cmd_msg $expect_out(1,string)
1911 set gdb_file_cmd_debug_info "debug"
1914 -re "Load new symbol table from \".*\".*y or n. $" {
1915 if { $new_symbol_table > 0 } {
1916 perror [join [list "Couldn't load $basename,"
1917 "interactive prompt loop detected."]]
1920 send_gdb "y\n" answer
1921 incr new_symbol_table
1922 set suffix "-- with new symbol table"
1923 set arg "$arg $suffix"
1924 set basename "$basename $suffix"
1927 -re "No such file or directory.*$gdb_prompt $" {
1928 perror "($basename) No such file or directory"
1931 -re "A problem internal to GDB has been detected" {
1932 perror "Couldn't load $basename into GDB (GDB internal error)."
1933 gdb_internal_error_resync
1936 -re "$gdb_prompt $" {
1937 perror "Couldn't load $basename into GDB."
1941 perror "Couldn't load $basename into GDB (timeout)."
1945 # This is an attempt to detect a core dump, but seems not to
1946 # work. Perhaps we need to match .* followed by eof, in which
1947 # gdb_expect does not seem to have a way to do that.
1948 perror "Couldn't load $basename into GDB (eof)."
1954 # Default gdb_spawn procedure.
1956 proc default_gdb_spawn { } {
1959 global INTERNAL_GDBFLAGS GDBFLAGS
1962 gdb_stop_suppressing_tests
1964 # Set the default value, it may be overriden later by specific testfile.
1966 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1967 # is already started after connecting and run/attach are not supported.
1968 # This is used for the "remote" protocol. After GDB starts you should
1969 # check global $use_gdb_stub instead of the board as the testfile may force
1970 # a specific different target protocol itself.
1971 set use_gdb_stub [target_info exists use_gdb_stub]
1973 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1974 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1976 if [info exists gdb_spawn_id] {
1980 if ![is_remote host] {
1981 if { [which $GDB] == 0 } then {
1982 perror "$GDB does not exist."
1986 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1987 if { $res < 0 || $res == "" } {
1988 perror "Spawning $GDB failed."
1992 set gdb_spawn_id $res
1996 # Default gdb_start procedure.
1998 proc default_gdb_start { } {
2001 global inferior_spawn_id
2003 if [info exists gdb_spawn_id] {
2007 # Keep track of the number of times GDB has been launched.
2008 global gdb_instances
2018 # Default to assuming inferior I/O is done on GDB's terminal.
2019 if {![info exists inferior_spawn_id]} {
2020 set inferior_spawn_id $gdb_spawn_id
2023 # When running over NFS, particularly if running many simultaneous
2024 # tests on different hosts all using the same server, things can
2025 # get really slow. Give gdb at least 3 minutes to start up.
2027 -re "\[\r\n\]$gdb_prompt $" {
2028 verbose "GDB initialized."
2030 -re "$gdb_prompt $" {
2031 perror "GDB never initialized."
2036 perror "(timeout) GDB never initialized after 10 seconds."
2042 perror "(eof) GDB never initialized."
2048 # force the height to "unlimited", so no pagers get used
2050 send_gdb "set height 0\n"
2052 -re "$gdb_prompt $" {
2053 verbose "Setting height to 0." 2
2056 warning "Couldn't set the height to 0"
2059 # force the width to "unlimited", so no wraparound occurs
2060 send_gdb "set width 0\n"
2062 -re "$gdb_prompt $" {
2063 verbose "Setting width to 0." 2
2066 warning "Couldn't set the width to 0."
2074 # Utility procedure to give user control of the gdb prompt in a script. It is
2075 # meant to be used for debugging test cases, and should not be left in the
2078 proc gdb_interact { } {
2080 set spawn_id $gdb_spawn_id
2082 send_user "+------------------------------------------+\n"
2083 send_user "| Script interrupted, you can now interact |\n"
2084 send_user "| with by gdb. Type >>> to continue. |\n"
2085 send_user "+------------------------------------------+\n"
2092 # Examine the output of compilation to determine whether compilation
2093 # failed or not. If it failed determine whether it is due to missing
2094 # compiler or due to compiler error. Report pass, fail or unsupported
2097 proc gdb_compile_test {src output} {
2098 if { $output == "" } {
2099 pass "compilation [file tail $src]"
2100 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
2101 unsupported "compilation [file tail $src]"
2102 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
2103 unsupported "compilation [file tail $src]"
2104 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
2105 unsupported "compilation [file tail $src]"
2107 verbose -log "compilation failed: $output" 2
2108 fail "compilation [file tail $src]"
2112 # Return a 1 for configurations for which we don't even want to try to
2115 proc skip_cplus_tests {} {
2116 if { [istarget "h8300-*-*"] } {
2120 # The C++ IO streams are too large for HC11/HC12 and are thus not
2121 # available. The gdb C++ tests use them and don't compile.
2122 if { [istarget "m6811-*-*"] } {
2125 if { [istarget "m6812-*-*"] } {
2131 # Return a 1 for configurations for which don't have both C++ and the STL.
2133 proc skip_stl_tests {} {
2134 # Symbian supports the C++ language, but the STL is missing
2135 # (both headers and libraries).
2136 if { [istarget "arm*-*-symbianelf*"] } {
2140 return [skip_cplus_tests]
2143 # Return a 1 if I don't even want to try to test FORTRAN.
2145 proc skip_fortran_tests {} {
2149 # Return a 1 if I don't even want to try to test ada.
2151 proc skip_ada_tests {} {
2155 # Return a 1 if I don't even want to try to test GO.
2157 proc skip_go_tests {} {
2161 # Return a 1 if I don't even want to try to test D.
2163 proc skip_d_tests {} {
2167 # Return 1 to skip Rust tests, 0 to try them.
2168 proc skip_rust_tests {} {
2169 return [expr {![isnative]}]
2172 # Return a 1 for configurations that do not support Python scripting.
2173 # PROMPT_REGEXP is the expected prompt.
2175 proc skip_python_tests_prompt { prompt_regexp } {
2176 global gdb_py_is_py3k
2178 gdb_test_multiple "python print ('test')" "verify python support" \
2179 -prompt "$prompt_regexp" {
2180 -re "not supported.*$prompt_regexp" {
2181 unsupported "Python support is disabled."
2184 -re "$prompt_regexp" {}
2187 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" \
2188 -prompt "$prompt_regexp" {
2189 -re "3.*$prompt_regexp" {
2190 set gdb_py_is_py3k 1
2192 -re ".*$prompt_regexp" {
2193 set gdb_py_is_py3k 0
2200 # Return a 1 for configurations that do not support Python scripting.
2201 # Note: This also sets various globals that specify which version of Python
2202 # is in use. See skip_python_tests_prompt.
2204 proc skip_python_tests {} {
2206 return [skip_python_tests_prompt "$gdb_prompt $"]
2209 # Return a 1 if we should skip shared library tests.
2211 proc skip_shlib_tests {} {
2212 # Run the shared library tests on native systems.
2217 # An abbreviated list of remote targets where we should be able to
2218 # run shared library tests.
2219 if {([istarget *-*-linux*]
2220 || [istarget *-*-*bsd*]
2221 || [istarget *-*-solaris2*]
2222 || [istarget arm*-*-symbianelf*]
2223 || [istarget *-*-mingw*]
2224 || [istarget *-*-cygwin*]
2225 || [istarget *-*-pe*])} {
2232 # Return 1 if we should skip tui related tests.
2234 proc skip_tui_tests {} {
2237 gdb_test_multiple "help layout" "verify tui support" {
2238 -re "Undefined command: \"layout\".*$gdb_prompt $" {
2241 -re "$gdb_prompt $" {
2248 # Test files shall make sure all the test result lines in gdb.sum are
2249 # unique in a test run, so that comparing the gdb.sum files of two
2250 # test runs gives correct results. Test files that exercise
2251 # variations of the same tests more than once, shall prefix the
2252 # different test invocations with different identifying strings in
2253 # order to make them unique.
2255 # About test prefixes:
2257 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2258 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2259 # underlined substring in
2261 # PASS: gdb.base/mytest.exp: some test
2262 # ^^^^^^^^^^^^^^^^^^^^
2266 # The easiest way to adjust the test prefix is to append a test
2267 # variation prefix to the $pf_prefix, using the with_test_prefix
2270 # proc do_tests {} {
2271 # gdb_test ... ... "test foo"
2272 # gdb_test ... ... "test bar"
2274 # with_test_prefix "subvariation a" {
2275 # gdb_test ... ... "test x"
2278 # with_test_prefix "subvariation b" {
2279 # gdb_test ... ... "test x"
2283 # with_test_prefix "variation1" {
2284 # ...do setup for variation 1...
2288 # with_test_prefix "variation2" {
2289 # ...do setup for variation 2...
2295 # PASS: gdb.base/mytest.exp: variation1: test foo
2296 # PASS: gdb.base/mytest.exp: variation1: test bar
2297 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2298 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2299 # PASS: gdb.base/mytest.exp: variation2: test foo
2300 # PASS: gdb.base/mytest.exp: variation2: test bar
2301 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2302 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2304 # If for some reason more flexibility is necessary, one can also
2305 # manipulate the pf_prefix global directly, treating it as a string.
2309 # set saved_pf_prefix
2310 # append pf_prefix "${foo}: bar"
2311 # ... actual tests ...
2312 # set pf_prefix $saved_pf_prefix
2315 # Run BODY in the context of the caller, with the current test prefix
2316 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2317 # Returns the result of BODY.
2319 proc with_test_prefix { prefix body } {
2322 set saved $pf_prefix
2323 append pf_prefix " " $prefix ":"
2324 set code [catch {uplevel 1 $body} result]
2325 set pf_prefix $saved
2328 global errorInfo errorCode
2329 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2331 return -code $code $result
2335 # Wrapper for foreach that calls with_test_prefix on each iteration,
2336 # including the iterator's name and current value in the prefix.
2338 proc foreach_with_prefix {var list body} {
2340 foreach myvar $list {
2341 with_test_prefix "$var=$myvar" {
2342 set code [catch {uplevel 1 $body} result]
2346 global errorInfo errorCode
2347 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2348 } elseif {$code == 3} {
2350 } elseif {$code == 2} {
2351 return -code $code $result
2356 # Like TCL's native proc, but defines a procedure that wraps its body
2357 # within 'with_test_prefix "$proc_name" { ... }'.
2358 proc proc_with_prefix {name arguments body} {
2359 # Define the advertised proc.
2360 proc $name $arguments [list with_test_prefix $name $body]
2364 # Run BODY in the context of the caller. After BODY is run, the variables
2365 # listed in VARS will be reset to the values they had before BODY was run.
2367 # This is useful for providing a scope in which it is safe to temporarily
2368 # modify global variables, e.g.
2370 # global INTERNAL_GDBFLAGS
2373 # set foo GDBHISTSIZE
2375 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2376 # append INTERNAL_GDBFLAGS " -nx"
2377 # unset -nocomplain env(GDBHISTSIZE)
2382 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2383 # modified inside BODY, this proc guarantees that the modifications will be
2384 # undone after BODY finishes executing.
2386 proc save_vars { vars body } {
2387 array set saved_scalars { }
2388 array set saved_arrays { }
2392 # First evaluate VAR in the context of the caller in case the variable
2393 # name may be a not-yet-interpolated string like env($foo)
2394 set var [uplevel 1 list $var]
2396 if [uplevel 1 [list info exists $var]] {
2397 if [uplevel 1 [list array exists $var]] {
2398 set saved_arrays($var) [uplevel 1 [list array get $var]]
2400 set saved_scalars($var) [uplevel 1 [list set $var]]
2403 lappend unset_vars $var
2407 set code [catch {uplevel 1 $body} result]
2409 foreach {var value} [array get saved_scalars] {
2410 uplevel 1 [list set $var $value]
2413 foreach {var value} [array get saved_arrays] {
2414 uplevel 1 [list unset $var]
2415 uplevel 1 [list array set $var $value]
2418 foreach var $unset_vars {
2419 uplevel 1 [list unset -nocomplain $var]
2423 global errorInfo errorCode
2424 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2426 return -code $code $result
2430 # Run tests in BODY with the current working directory (CWD) set to
2431 # DIR. When BODY is finished, restore the original CWD. Return the
2434 # This procedure doesn't check if DIR is a valid directory, so you
2435 # have to make sure of that.
2437 proc with_cwd { dir body } {
2439 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2442 set code [catch {uplevel 1 $body} result]
2444 verbose -log "Switching back to $saved_dir."
2448 global errorInfo errorCode
2449 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2451 return -code $code $result
2455 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2456 # PROMPT. When BODY is finished, restore GDB prompt and variable
2458 # Returns the result of BODY.
2462 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2463 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2464 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2465 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2466 # a) It's more intuitive for callers to pass the plain text form.
2467 # b) We need two forms of the prompt:
2468 # - a regexp to use in output matching,
2469 # - a value to pass to the "set prompt" command.
2470 # c) It's easier to convert the plain text form to its regexp form.
2472 # 2) Don't add a trailing space, we do that here.
2474 proc with_gdb_prompt { prompt body } {
2477 # Convert "(foo)" to "\(foo\)".
2478 # We don't use string_to_regexp because while it works today it's not
2479 # clear it will work tomorrow: the value we need must work as both a
2480 # regexp *and* as the argument to the "set prompt" command, at least until
2481 # we start recording both forms separately instead of just $gdb_prompt.
2482 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2484 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2486 set saved $gdb_prompt
2488 verbose -log "Setting gdb prompt to \"$prompt \"."
2489 set gdb_prompt $prompt
2490 gdb_test_no_output "set prompt $prompt " ""
2492 set code [catch {uplevel 1 $body} result]
2494 verbose -log "Restoring gdb prompt to \"$saved \"."
2495 set gdb_prompt $saved
2496 gdb_test_no_output "set prompt $saved " ""
2499 global errorInfo errorCode
2500 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2502 return -code $code $result
2506 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2507 # BODY is finished, restore target-charset.
2509 proc with_target_charset { target_charset body } {
2513 gdb_test_multiple "show target-charset" "" {
2514 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2515 set saved $expect_out(1,string)
2517 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2518 set saved $expect_out(1,string)
2520 -re ".*$gdb_prompt " {
2521 fail "get target-charset"
2525 gdb_test_no_output "set target-charset $target_charset" ""
2527 set code [catch {uplevel 1 $body} result]
2529 gdb_test_no_output "set target-charset $saved" ""
2532 global errorInfo errorCode
2533 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2535 return -code $code $result
2539 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2540 # mi_gdb_test etc. default to using it.
2542 proc switch_gdb_spawn_id {spawn_id} {
2544 global board board_info
2546 set gdb_spawn_id $spawn_id
2547 set board [host_info name]
2548 set board_info($board,fileid) $spawn_id
2551 # Clear the default spawn id.
2553 proc clear_gdb_spawn_id {} {
2555 global board board_info
2557 unset -nocomplain gdb_spawn_id
2558 set board [host_info name]
2559 unset -nocomplain board_info($board,fileid)
2562 # Run BODY with SPAWN_ID as current spawn id.
2564 proc with_spawn_id { spawn_id body } {
2567 if [info exists gdb_spawn_id] {
2568 set saved_spawn_id $gdb_spawn_id
2571 switch_gdb_spawn_id $spawn_id
2573 set code [catch {uplevel 1 $body} result]
2575 if [info exists saved_spawn_id] {
2576 switch_gdb_spawn_id $saved_spawn_id
2582 global errorInfo errorCode
2583 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2585 return -code $code $result
2589 # Select the largest timeout from all the timeouts:
2590 # - the local "timeout" variable of the scope two levels above,
2591 # - the global "timeout" variable,
2592 # - the board variable "gdb,timeout".
2594 proc get_largest_timeout {} {
2595 upvar #0 timeout gtimeout
2596 upvar 2 timeout timeout
2599 if [info exists timeout] {
2602 if { [info exists gtimeout] && $gtimeout > $tmt } {
2605 if { [target_info exists gdb,timeout]
2606 && [target_info gdb,timeout] > $tmt } {
2607 set tmt [target_info gdb,timeout]
2617 # Run tests in BODY with timeout increased by factor of FACTOR. When
2618 # BODY is finished, restore timeout.
2620 proc with_timeout_factor { factor body } {
2623 set savedtimeout $timeout
2625 set timeout [expr [get_largest_timeout] * $factor]
2626 set code [catch {uplevel 1 $body} result]
2628 set timeout $savedtimeout
2630 global errorInfo errorCode
2631 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2633 return -code $code $result
2637 # Run BODY with timeout factor FACTOR if check-read1 is used.
2639 proc with_read1_timeout_factor { factor body } {
2640 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
2641 # Use timeout factor
2643 # Reset timeout factor
2646 return [uplevel [list with_timeout_factor $factor $body]]
2649 # Return 1 if _Complex types are supported, otherwise, return 0.
2651 gdb_caching_proc support_complex_tests {
2653 if { [gdb_skip_float_test] } {
2654 # If floating point is not supported, _Complex is not
2659 # Compile a test program containing _Complex types.
2661 return [gdb_can_simple_compile complex {
2665 _Complex long double cld;
2671 # Return 1 if compiling go is supported.
2672 gdb_caching_proc support_go_compile {
2674 return [gdb_can_simple_compile go-hello {
2678 fmt.Println("hello world")
2683 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2686 proc supports_get_siginfo_type {} {
2687 if { [istarget "*-*-linux*"] } {
2694 # Return 1 if the target supports hardware single stepping.
2696 proc can_hardware_single_step {} {
2698 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2699 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2700 || [istarget "nios2-*-*"] } {
2707 # Return 1 if target hardware or OS supports single stepping to signal
2708 # handler, otherwise, return 0.
2710 proc can_single_step_to_signal_handler {} {
2711 # Targets don't have hardware single step. On these targets, when
2712 # a signal is delivered during software single step, gdb is unable
2713 # to determine the next instruction addresses, because start of signal
2714 # handler is one of them.
2715 return [can_hardware_single_step]
2718 # Return 1 if target supports process record, otherwise return 0.
2720 proc supports_process_record {} {
2722 if [target_info exists gdb,use_precord] {
2723 return [target_info gdb,use_precord]
2726 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2727 || [istarget "i\[34567\]86-*-linux*"]
2728 || [istarget "aarch64*-*-linux*"]
2729 || [istarget "powerpc*-*-linux*"]
2730 || [istarget "s390*-*-linux*"] } {
2737 # Return 1 if target supports reverse debugging, otherwise return 0.
2739 proc supports_reverse {} {
2741 if [target_info exists gdb,can_reverse] {
2742 return [target_info gdb,can_reverse]
2745 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2746 || [istarget "i\[34567\]86-*-linux*"]
2747 || [istarget "aarch64*-*-linux*"]
2748 || [istarget "powerpc*-*-linux*"]
2749 || [istarget "s390*-*-linux*"] } {
2756 # Return 1 if readline library is used.
2758 proc readline_is_used { } {
2761 gdb_test_multiple "show editing" "" {
2762 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2765 -re ".*$gdb_prompt $" {
2771 # Return 1 if target is ELF.
2772 gdb_caching_proc is_elf_target {
2773 set me "is_elf_target"
2775 set src { int foo () {return 0;} }
2776 if {![gdb_simple_compile elf_target $src]} {
2780 set fp_obj [open $obj "r"]
2781 fconfigure $fp_obj -translation binary
2782 set data [read $fp_obj]
2787 set ELFMAG "\u007FELF"
2789 if {[string compare -length 4 $data $ELFMAG] != 0} {
2790 verbose "$me: returning 0" 2
2794 verbose "$me: returning 1" 2
2798 # Return 1 if the memory at address zero is readable.
2800 gdb_caching_proc is_address_zero_readable {
2804 gdb_test_multiple "x 0" "" {
2805 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2808 -re ".*$gdb_prompt $" {
2816 # Produce source file NAME and write SOURCES into it.
2818 proc gdb_produce_source { name sources } {
2820 set f [open $name "w"]
2826 # Return 1 if target is ILP32.
2827 # This cannot be decided simply from looking at the target string,
2828 # as it might depend on externally passed compiler options like -m64.
2829 gdb_caching_proc is_ilp32_target {
2830 return [gdb_can_simple_compile is_ilp32_target {
2831 int dummy[sizeof (int) == 4
2832 && sizeof (void *) == 4
2833 && sizeof (long) == 4 ? 1 : -1];
2837 # Return 1 if target is LP64.
2838 # This cannot be decided simply from looking at the target string,
2839 # as it might depend on externally passed compiler options like -m64.
2840 gdb_caching_proc is_lp64_target {
2841 return [gdb_can_simple_compile is_lp64_target {
2842 int dummy[sizeof (int) == 4
2843 && sizeof (void *) == 8
2844 && sizeof (long) == 8 ? 1 : -1];
2848 # Return 1 if target has 64 bit addresses.
2849 # This cannot be decided simply from looking at the target string,
2850 # as it might depend on externally passed compiler options like -m64.
2851 gdb_caching_proc is_64_target {
2852 return [gdb_can_simple_compile is_64_target {
2853 int function(void) { return 3; }
2854 int dummy[sizeof (&function) == 8 ? 1 : -1];
2858 # Return 1 if target has x86_64 registers - either amd64 or x32.
2859 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2860 # just from the target string.
2861 gdb_caching_proc is_amd64_regs_target {
2862 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2866 return [gdb_can_simple_compile is_amd64_regs_target {
2876 # Return 1 if this target is an x86 or x86-64 with -m32.
2877 proc is_x86_like_target {} {
2878 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2881 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2884 # Return 1 if this target is an arm or aarch32 on aarch64.
2886 gdb_caching_proc is_aarch32_target {
2887 if { [istarget "arm*-*-*"] } {
2891 if { ![istarget "aarch64*-*-*"] } {
2898 lappend list "\tmov $reg, $reg"
2901 return [gdb_can_simple_compile aarch32 [join $list \n]]
2904 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2906 proc is_aarch64_target {} {
2907 if { ![istarget "aarch64*-*-*"] } {
2911 return [expr ![is_aarch32_target]]
2914 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2915 proc support_displaced_stepping {} {
2917 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2918 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2919 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2920 || [istarget "aarch64*-*-linux*"] } {
2927 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2928 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2930 gdb_caching_proc skip_altivec_tests {
2931 global srcdir subdir gdb_prompt inferior_exited_re
2933 set me "skip_altivec_tests"
2935 # Some simulators are known to not support VMX instructions.
2936 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2937 verbose "$me: target known to not support VMX, returning 1" 2
2941 # Make sure we have a compiler that understands altivec.
2942 if [get_compiler_info] {
2943 warning "Could not get compiler info"
2946 if [test_compiler_info gcc*] {
2947 set compile_flags "additional_flags=-maltivec"
2948 } elseif [test_compiler_info xlc*] {
2949 set compile_flags "additional_flags=-qaltivec"
2951 verbose "Could not compile with altivec support, returning 1" 2
2955 # Compile a test program containing VMX instructions.
2959 asm volatile ("vor v0,v0,v0");
2961 asm volatile ("vor 0,0,0");
2966 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2970 # Compilation succeeded so now run it via gdb.
2974 gdb_reinitialize_dir $srcdir/$subdir
2978 -re ".*Illegal instruction.*${gdb_prompt} $" {
2979 verbose -log "\n$me altivec hardware not detected"
2980 set skip_vmx_tests 1
2982 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2983 verbose -log "\n$me: altivec hardware detected"
2984 set skip_vmx_tests 0
2987 warning "\n$me: default case taken"
2988 set skip_vmx_tests 1
2992 remote_file build delete $obj
2994 verbose "$me: returning $skip_vmx_tests" 2
2995 return $skip_vmx_tests
2998 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2999 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3001 gdb_caching_proc skip_vsx_tests {
3002 global srcdir subdir gdb_prompt inferior_exited_re
3004 set me "skip_vsx_tests"
3006 # Some simulators are known to not support Altivec instructions, so
3007 # they won't support VSX instructions as well.
3008 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
3009 verbose "$me: target known to not support VSX, returning 1" 2
3013 # Make sure we have a compiler that understands altivec.
3014 if [get_compiler_info] {
3015 warning "Could not get compiler info"
3018 if [test_compiler_info gcc*] {
3019 set compile_flags "additional_flags=-mvsx"
3020 } elseif [test_compiler_info xlc*] {
3021 set compile_flags "additional_flags=-qasm=gcc"
3023 verbose "Could not compile with vsx support, returning 1" 2
3027 # Compile a test program containing VSX instructions.
3030 double a[2] = { 1.0, 2.0 };
3032 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
3034 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
3039 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3043 # No error message, compilation succeeded so now run it via gdb.
3047 gdb_reinitialize_dir $srcdir/$subdir
3051 -re ".*Illegal instruction.*${gdb_prompt} $" {
3052 verbose -log "\n$me VSX hardware not detected"
3053 set skip_vsx_tests 1
3055 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3056 verbose -log "\n$me: VSX hardware detected"
3057 set skip_vsx_tests 0
3060 warning "\n$me: default case taken"
3061 set skip_vsx_tests 1
3065 remote_file build delete $obj
3067 verbose "$me: returning $skip_vsx_tests" 2
3068 return $skip_vsx_tests
3071 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
3072 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3074 gdb_caching_proc skip_tsx_tests {
3075 global srcdir subdir gdb_prompt inferior_exited_re
3077 set me "skip_tsx_tests"
3079 # Compile a test program.
3082 asm volatile ("xbegin .L0");
3083 asm volatile ("xend");
3084 asm volatile (".L0: nop");
3088 if {![gdb_simple_compile $me $src executable]} {
3092 # No error message, compilation succeeded so now run it via gdb.
3096 gdb_reinitialize_dir $srcdir/$subdir
3100 -re ".*Illegal instruction.*${gdb_prompt} $" {
3101 verbose -log "$me: TSX hardware not detected."
3102 set skip_tsx_tests 1
3104 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3105 verbose -log "$me: TSX hardware detected."
3106 set skip_tsx_tests 0
3109 warning "\n$me: default case taken."
3110 set skip_tsx_tests 1
3114 remote_file build delete $obj
3116 verbose "$me: returning $skip_tsx_tests" 2
3117 return $skip_tsx_tests
3120 # Run a test on the target to see if it supports avx512bf16. Return 0 if so,
3121 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3123 gdb_caching_proc skip_avx512bf16_tests {
3124 global srcdir subdir gdb_prompt inferior_exited_re
3126 set me "skip_avx512bf16_tests"
3127 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3128 verbose "$me: target does not support avx512bf16, returning 1" 2
3132 # Compile a test program.
3135 asm volatile ("vcvtne2ps2bf16 %xmm0, %xmm1, %xmm0");
3139 if {![gdb_simple_compile $me $src executable]} {
3143 # No error message, compilation succeeded so now run it via gdb.
3147 gdb_reinitialize_dir $srcdir/$subdir
3151 -re ".*Illegal instruction.*${gdb_prompt} $" {
3152 verbose -log "$me: avx512bf16 hardware not detected."
3153 set skip_avx512bf16_tests 1
3155 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3156 verbose -log "$me: avx512bf16 hardware detected."
3157 set skip_avx512bf16_tests 0
3160 warning "\n$me: default case taken."
3161 set skip_avx512bf16_tests 1
3165 remote_file build delete $obj
3167 verbose "$me: returning $skip_avx512bf16_tests" 2
3168 return $skip_avx512bf16_tests
3171 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
3172 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3174 gdb_caching_proc skip_btrace_tests {
3175 global srcdir subdir gdb_prompt inferior_exited_re
3177 set me "skip_btrace_tests"
3178 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3179 verbose "$me: target does not support btrace, returning 1" 2
3183 # Compile a test program.
3184 set src { int main() { return 0; } }
3185 if {![gdb_simple_compile $me $src executable]} {
3189 # No error message, compilation succeeded so now run it via gdb.
3193 gdb_reinitialize_dir $srcdir/$subdir
3198 # In case of an unexpected output, we return 2 as a fail value.
3199 set skip_btrace_tests 2
3200 gdb_test_multiple "record btrace" "check btrace support" {
3201 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3202 set skip_btrace_tests 1
3204 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3205 set skip_btrace_tests 1
3207 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3208 set skip_btrace_tests 1
3210 -re "^record btrace\r\n$gdb_prompt $" {
3211 set skip_btrace_tests 0
3215 remote_file build delete $obj
3217 verbose "$me: returning $skip_btrace_tests" 2
3218 return $skip_btrace_tests
3221 # Run a test on the target to see if it supports btrace pt hardware.
3222 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
3223 # from the GCC testsuite.
3225 gdb_caching_proc skip_btrace_pt_tests {
3226 global srcdir subdir gdb_prompt inferior_exited_re
3228 set me "skip_btrace_tests"
3229 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3230 verbose "$me: target does not support btrace, returning 1" 2
3234 # Compile a test program.
3235 set src { int main() { return 0; } }
3236 if {![gdb_simple_compile $me $src executable]} {
3240 # No error message, compilation succeeded so now run it via gdb.
3244 gdb_reinitialize_dir $srcdir/$subdir
3249 # In case of an unexpected output, we return 2 as a fail value.
3250 set skip_btrace_tests 2
3251 gdb_test_multiple "record btrace pt" "check btrace pt support" {
3252 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3253 set skip_btrace_tests 1
3255 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3256 set skip_btrace_tests 1
3258 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3259 set skip_btrace_tests 1
3261 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
3262 set skip_btrace_tests 1
3264 -re "^record btrace pt\r\n$gdb_prompt $" {
3265 set skip_btrace_tests 0
3269 remote_file build delete $obj
3271 verbose "$me: returning $skip_btrace_tests" 2
3272 return $skip_btrace_tests
3275 # Run a test on the target to see if it supports Aarch64 SVE hardware.
3276 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
3278 gdb_caching_proc skip_aarch64_sve_tests {
3279 global srcdir subdir gdb_prompt inferior_exited_re
3281 set me "skip_aarch64_sve_tests"
3283 if { ![is_aarch64_target]} {
3287 set compile_flags "{additional_flags=-march=armv8-a+sve}"
3289 # Compile a test program containing SVE instructions.
3292 asm volatile ("ptrue p0.b");
3296 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3300 # Compilation succeeded so now run it via gdb.
3304 -re ".*Illegal instruction.*${gdb_prompt} $" {
3305 verbose -log "\n$me sve hardware not detected"
3306 set skip_sve_tests 1
3308 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3309 verbose -log "\n$me: sve hardware detected"
3310 set skip_sve_tests 0
3313 warning "\n$me: default case taken"
3314 set skip_sve_tests 1
3318 remote_file build delete $obj
3320 verbose "$me: returning $skip_sve_tests" 2
3321 return $skip_sve_tests
3325 # A helper that compiles a test case to see if __int128 is supported.
3326 proc gdb_int128_helper {lang} {
3327 return [gdb_can_simple_compile "i128-for-$lang" {
3329 int main() { return 0; }
3333 # Return true if the C compiler understands the __int128 type.
3334 gdb_caching_proc has_int128_c {
3335 return [gdb_int128_helper c]
3338 # Return true if the C++ compiler understands the __int128 type.
3339 gdb_caching_proc has_int128_cxx {
3340 return [gdb_int128_helper c++]
3343 # Return true if the IFUNC feature is unsupported.
3344 gdb_caching_proc skip_ifunc_tests {
3345 if [gdb_can_simple_compile ifunc {
3347 typedef void F (void);
3348 F* g (void) { return &f_; }
3349 void f () __attribute__ ((ifunc ("g")));
3357 # Return whether we should skip tests for showing inlined functions in
3358 # backtraces. Requires get_compiler_info and get_debug_format.
3360 proc skip_inline_frame_tests {} {
3361 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3362 if { ! [test_debug_format "DWARF 2"] } {
3366 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
3367 if { ([test_compiler_info "gcc-2-*"]
3368 || [test_compiler_info "gcc-3-*"]
3369 || [test_compiler_info "gcc-4-0-*"]) } {
3376 # Return whether we should skip tests for showing variables from
3377 # inlined functions. Requires get_compiler_info and get_debug_format.
3379 proc skip_inline_var_tests {} {
3380 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3381 if { ! [test_debug_format "DWARF 2"] } {
3388 # Return a 1 if we should skip tests that require hardware breakpoints
3390 proc skip_hw_breakpoint_tests {} {
3391 # Skip tests if requested by the board (note that no_hardware_watchpoints
3392 # disables both watchpoints and breakpoints)
3393 if { [target_info exists gdb,no_hardware_watchpoints]} {
3397 # These targets support hardware breakpoints natively
3398 if { [istarget "i?86-*-*"]
3399 || [istarget "x86_64-*-*"]
3400 || [istarget "ia64-*-*"]
3401 || [istarget "arm*-*-*"]
3402 || [istarget "aarch64*-*-*"]
3403 || [istarget "s390*-*-*"] } {
3410 # Return a 1 if we should skip tests that require hardware watchpoints
3412 proc skip_hw_watchpoint_tests {} {
3413 # Skip tests if requested by the board
3414 if { [target_info exists gdb,no_hardware_watchpoints]} {
3418 # These targets support hardware watchpoints natively
3419 if { [istarget "i?86-*-*"]
3420 || [istarget "x86_64-*-*"]
3421 || [istarget "ia64-*-*"]
3422 || [istarget "arm*-*-*"]
3423 || [istarget "aarch64*-*-*"]
3424 || [istarget "powerpc*-*-linux*"]
3425 || [istarget "s390*-*-*"] } {
3432 # Return a 1 if we should skip tests that require *multiple* hardware
3433 # watchpoints to be active at the same time
3435 proc skip_hw_watchpoint_multi_tests {} {
3436 if { [skip_hw_watchpoint_tests] } {
3440 # These targets support just a single hardware watchpoint
3441 if { [istarget "arm*-*-*"]
3442 || [istarget "powerpc*-*-linux*"] } {
3449 # Return a 1 if we should skip tests that require read/access watchpoints
3451 proc skip_hw_watchpoint_access_tests {} {
3452 if { [skip_hw_watchpoint_tests] } {
3456 # These targets support just write watchpoints
3457 if { [istarget "s390*-*-*"] } {
3464 # Return 1 if we should skip tests that require the runtime unwinder
3465 # hook. This must be invoked while gdb is running, after shared
3466 # libraries have been loaded. This is needed because otherwise a
3467 # shared libgcc won't be visible.
3469 proc skip_unwinder_tests {} {
3473 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3474 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3476 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3479 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3483 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3484 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3487 -re "\r\n$gdb_prompt $" {
3494 # Return 1 if we should skip tests that require the libstdc++ stap
3495 # probes. This must be invoked while gdb is running, after shared
3496 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
3498 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
3500 gdb_test_multiple "info probe" "check for stap probe in libstdc++" \
3501 -prompt "$prompt_regexp" {
3502 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
3505 -re "\r\n$prompt_regexp" {
3508 set skip [expr !$supported]
3512 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
3514 proc skip_libstdcxx_probe_tests {} {
3516 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
3519 # Return 1 if we should skip tests of the "compile" feature.
3520 # This must be invoked after the inferior has been started.
3522 proc skip_compile_feature_tests {} {
3526 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3527 "Could not load libcc1.*\r\n$gdb_prompt $" {
3530 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3533 -re "\r\n$gdb_prompt $" {
3539 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3540 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3541 # is a regexp that will match the output of "maint print target-stack" if
3542 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3543 # matching the expected prompt after the command output.
3545 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3546 set test "probe for target ${target_name}"
3547 gdb_test_multiple "maint print target-stack" $test \
3548 -prompt "$prompt_regexp" {
3549 -re "${target_stack_regexp}${prompt_regexp}" {
3553 -re "$prompt_regexp" {
3560 # Helper for gdb_is_target_remote where the expected prompt is variable.
3562 proc gdb_is_target_remote_prompt { prompt_regexp } {
3563 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3566 # Check whether we're testing with the remote or extended-remote
3569 proc gdb_is_target_remote { } {
3572 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3575 # Check whether we're testing with the native target.
3577 proc gdb_is_target_native { } {
3580 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3583 # Return the effective value of use_gdb_stub.
3585 # If the use_gdb_stub global has been set (it is set when the gdb process is
3586 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3587 # property from the board file.
3589 # This is the preferred way of checking use_gdb_stub, since it allows to check
3590 # the value before the gdb has been spawned and it will return the correct value
3591 # even when it was overriden by the test.
3593 proc use_gdb_stub {} {
3596 if [info exists use_gdb_stub] {
3597 return $use_gdb_stub
3600 return [target_info exists use_gdb_stub]
3603 # Return 1 if the current remote target is an instance of our GDBserver, 0
3604 # otherwise. Return -1 if there was an error and we can't tell.
3606 gdb_caching_proc target_is_gdbserver {
3610 set test "probing for GDBserver"
3612 gdb_test_multiple "monitor help" $test {
3613 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3616 -re "$gdb_prompt $" {
3621 if { $is_gdbserver == -1 } {
3622 verbose -log "Unable to tell whether we are using GDBserver or not."
3625 return $is_gdbserver
3628 # N.B. compiler_info is intended to be local to this file.
3629 # Call test_compiler_info with no arguments to fetch its value.
3630 # Yes, this is counterintuitive when there's get_compiler_info,
3631 # but that's the current API.
3632 if [info exists compiler_info] {
3638 # Figure out what compiler I am using.
3639 # The result is cached so only the first invocation runs the compiler.
3641 # ARG can be empty or "C++". If empty, "C" is assumed.
3643 # There are several ways to do this, with various problems.
3645 # [ gdb_compile -E $ifile -o $binfile.ci ]
3646 # source $binfile.ci
3648 # Single Unix Spec v3 says that "-E -o ..." together are not
3649 # specified. And in fact, the native compiler on hp-ux 11 (among
3650 # others) does not work with "-E -o ...". Most targets used to do
3651 # this, and it mostly worked, because it works with gcc.
3653 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3654 # source $binfile.ci
3656 # This avoids the problem with -E and -o together. This almost works
3657 # if the build machine is the same as the host machine, which is
3658 # usually true of the targets which are not gcc. But this code does
3659 # not figure which compiler to call, and it always ends up using the C
3660 # compiler. Not good for setting hp_aCC_compiler. Target
3661 # hppa*-*-hpux* used to do this.
3663 # [ gdb_compile -E $ifile > $binfile.ci ]
3664 # source $binfile.ci
3666 # dejagnu target_compile says that it supports output redirection,
3667 # but the code is completely different from the normal path and I
3668 # don't want to sweep the mines from that path. So I didn't even try
3671 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3674 # I actually do this for all targets now. gdb_compile runs the right
3675 # compiler, and TCL captures the output, and I eval the output.
3677 # Unfortunately, expect logs the output of the command as it goes by,
3678 # and dejagnu helpfully prints a second copy of it right afterwards.
3679 # So I turn off expect logging for a moment.
3681 # [ gdb_compile $ifile $ciexe_file executable $args ]
3682 # [ remote_exec $ciexe_file ]
3683 # [ source $ci_file.out ]
3685 # I could give up on -E and just do this.
3686 # I didn't get desperate enough to try this.
3688 # -- chastain 2004-01-06
3690 proc get_compiler_info {{arg ""}} {
3691 # For compiler.c and compiler.cc
3694 # I am going to play with the log to keep noise out.
3698 # These come from compiler.c or compiler.cc
3699 global compiler_info
3701 # Legacy global data symbols.
3704 if [info exists compiler_info] {
3709 # Choose which file to preprocess.
3710 set ifile "${srcdir}/lib/compiler.c"
3711 if { $arg == "c++" } {
3712 set ifile "${srcdir}/lib/compiler.cc"
3715 # Run $ifile through the right preprocessor.
3716 # Toggle gdb.log to keep the compiler output out of the log.
3717 set saved_log [log_file -info]
3719 if [is_remote host] {
3720 # We have to use -E and -o together, despite the comments
3721 # above, because of how DejaGnu handles remote host testing.
3722 set ppout "$outdir/compiler.i"
3723 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3724 set file [open $ppout r]
3725 set cppout [read $file]
3728 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3730 eval log_file $saved_log
3734 foreach cppline [ split "$cppout" "\n" ] {
3735 if { [ regexp "^#" "$cppline" ] } {
3737 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3739 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3741 verbose "get_compiler_info: $cppline" 2
3745 verbose -log "get_compiler_info: $cppline"
3750 # Set to unknown if for some reason compiler_info didn't get defined.
3751 if ![info exists compiler_info] {
3752 verbose -log "get_compiler_info: compiler_info not provided"
3753 set compiler_info "unknown"
3755 # Also set to unknown compiler if any diagnostics happened.
3757 verbose -log "get_compiler_info: got unexpected diagnostics"
3758 set compiler_info "unknown"
3761 # Set the legacy symbols.
3763 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3765 # Log what happened.
3766 verbose -log "get_compiler_info: $compiler_info"
3768 # Most compilers will evaluate comparisons and other boolean
3769 # operations to 0 or 1.
3770 uplevel \#0 { set true 1 }
3771 uplevel \#0 { set false 0 }
3776 # Return the compiler_info string if no arg is provided.
3777 # Otherwise the argument is a glob-style expression to match against
3780 proc test_compiler_info { {compiler ""} } {
3781 global compiler_info
3784 # If no arg, return the compiler_info string.
3785 if [string match "" $compiler] {
3786 return $compiler_info
3789 return [string match $compiler $compiler_info]
3792 proc current_target_name { } {
3794 if [info exists target_info(target,name)] {
3795 set answer $target_info(target,name)
3802 set gdb_wrapper_initialized 0
3803 set gdb_wrapper_target ""
3804 set gdb_wrapper_file ""
3805 set gdb_wrapper_flags ""
3807 proc gdb_wrapper_init { args } {
3808 global gdb_wrapper_initialized
3809 global gdb_wrapper_file
3810 global gdb_wrapper_flags
3811 global gdb_wrapper_target
3813 if { $gdb_wrapper_initialized == 1 } { return; }
3815 if {[target_info exists needs_status_wrapper] && \
3816 [target_info needs_status_wrapper] != "0"} {
3817 set result [build_wrapper "testglue.o"]
3818 if { $result != "" } {
3819 set gdb_wrapper_file [lindex $result 0]
3820 if ![is_remote host] {
3821 set gdb_wrapper_file [file join [pwd] $gdb_wrapper_file]
3823 set gdb_wrapper_flags [lindex $result 1]
3825 warning "Status wrapper failed to build."
3828 set gdb_wrapper_file ""
3829 set gdb_wrapper_flags ""
3831 verbose "set gdb_wrapper_file = $gdb_wrapper_file"
3832 set gdb_wrapper_initialized 1
3833 set gdb_wrapper_target [current_target_name]
3836 # Determine options that we always want to pass to the compiler.
3837 gdb_caching_proc universal_compile_options {
3838 set me "universal_compile_options"
3841 set src [standard_temp_file ccopts[pid].c]
3842 set obj [standard_temp_file ccopts[pid].o]
3844 gdb_produce_source $src {
3845 int foo(void) { return 0; }
3848 # Try an option for disabling colored diagnostics. Some compilers
3849 # yield colored diagnostics by default (when run from a tty) unless
3850 # such an option is specified.
3851 set opt "additional_flags=-fdiagnostics-color=never"
3852 set lines [target_compile $src $obj object [list "quiet" $opt]]
3853 if [string match "" $lines] then {
3854 # Seems to have worked; use the option.
3855 lappend options $opt
3860 verbose "$me: returning $options" 2
3864 # Compile the code in $code to a file based on $name, using the flags
3865 # $compile_flag as well as debug, nowarning and quiet.
3866 # Return 1 if code can be compiled
3867 # Leave the file name of the resulting object in the upvar object.
3869 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3872 switch -regexp -- $type {
3887 foreach flag $compile_flags {
3888 if { "$flag" == "go" } {
3893 set src [standard_temp_file $name-[pid].$ext]
3894 set obj [standard_temp_file $name-[pid].$postfix]
3895 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3897 gdb_produce_source $src $code
3899 verbose "$name: compiling testfile $src" 2
3900 set lines [gdb_compile $src $obj $type $compile_flags]
3904 if ![string match "" $lines] then {
3905 verbose "$name: compilation failed, returning 0" 2
3911 # Compile the code in $code to a file based on $name, using the flags
3912 # $compile_flag as well as debug, nowarning and quiet.
3913 # Return 1 if code can be compiled
3914 # Delete all created files and objects.
3916 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3917 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3918 file delete $temp_obj
3922 # Some targets need to always link a special object in. Save its path here.
3923 global gdb_saved_set_unbuffered_mode_obj
3924 set gdb_saved_set_unbuffered_mode_obj ""
3926 # Compile source files specified by SOURCE into a binary of type TYPE at path
3927 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3928 # parameter and most options are passed directly to it.
3930 # The type can be one of the following:
3932 # - object: Compile into an object file.
3933 # - executable: Compile and link into an executable.
3934 # - preprocess: Preprocess the source files.
3935 # - assembly: Generate assembly listing.
3937 # The following options are understood and processed by gdb_compile:
3939 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3940 # quirks to be able to use shared libraries.
3941 # - shlib_load: Link with appropriate libraries to allow the test to
3942 # dynamically load libraries at runtime. For example, on Linux, this adds
3943 # -ldl so that the test can use dlopen.
3944 # - nowarnings: Inhibit all compiler warnings.
3945 # - pie: Force creation of PIE executables.
3946 # - nopie: Prevent creation of PIE executables.
3948 # And here are some of the not too obscure options understood by DejaGnu that
3949 # influence the compilation:
3951 # - additional_flags=flag: Add FLAG to the compiler flags.
3952 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3953 # argument can be a file, in which case it's added to the sources, or a
3955 # - ldflags=flag: Add FLAG to the linker flags.
3956 # - incdir=path: Add PATH to the searched include directories.
3957 # - libdir=path: Add PATH to the linker searched directories.
3958 # - ada, c++, f77, f90, go, rust: Compile the file as Ada, C++,
3959 # Fortran 77, Fortran 90, Go or Rust.
3960 # - debug: Build with debug information.
3961 # - optimize: Build with optimization.
3963 proc gdb_compile {source dest type options} {
3964 global GDB_TESTCASE_OPTIONS
3965 global gdb_wrapper_file
3966 global gdb_wrapper_flags
3969 global gdb_saved_set_unbuffered_mode_obj
3971 set outdir [file dirname $dest]
3973 # Add platform-specific options if a shared library was specified using
3974 # "shlib=librarypath" in OPTIONS.
3976 if {[lsearch -exact $options rust] != -1} {
3977 # -fdiagnostics-color is not a rustcc option.
3979 set new_options [universal_compile_options]
3982 # Some C/C++ testcases unconditionally pass -Wno-foo as additional
3983 # options to disable some warning. That is OK with GCC, because
3984 # by design, GCC accepts any -Wno-foo option, even if it doesn't
3985 # support -Wfoo. Clang however warns about unknown -Wno-foo by
3986 # default, unless you pass -Wno-unknown-warning-option as well.
3987 # We do that here, so that individual testcases don't have to
3989 if {[lsearch -exact $options getting_compiler_info] == -1
3990 && [lsearch -exact $options rust] == -1
3991 && [lsearch -exact $options ada] == -1
3992 && [lsearch -exact $options f77] == -1
3993 && [lsearch -exact $options f90] == -1
3994 && [lsearch -exact $options go] == -1
3995 && [test_compiler_info "clang-*"]} {
3996 lappend new_options "additional_flags=-Wno-unknown-warning-option"
3999 # Treating .c input files as C++ is deprecated in Clang, so
4000 # explicitly force C++ language.
4001 if { [lsearch -exact $options getting_compiler_info] == -1
4002 && [lsearch -exact $options c++] != -1
4003 && [string match *.c $source] != 0 } {
4005 # gdb_compile cannot handle this combination of options, the
4006 # result is a command like "clang -x c++ foo.c bar.so -o baz"
4007 # which tells Clang to treat bar.so as C++. The solution is
4008 # to call gdb_compile twice--once to compile, once to link--
4009 # either directly, or via build_executable_from_specs.
4010 if { [lsearch $options shlib=*] != -1 } {
4011 error "incompatible gdb_compile options"
4014 if {[test_compiler_info "clang-*"]} {
4015 lappend new_options early_flags=-x\ c++
4019 # Place (and look for) Fortran `.mod` files in the output
4020 # directory for this specific test.
4021 if {[lsearch -exact $options f77] != -1 \
4022 || [lsearch -exact $options f90] != -1 } {
4024 set mod_path [standard_output_file ""]
4025 lappend new_options "additional_flags=-J${mod_path}"
4030 set getting_compiler_info 0
4031 foreach opt $options {
4032 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
4033 && $type == "executable"} {
4034 if [test_compiler_info "xlc-*"] {
4035 # IBM xlc compiler doesn't accept shared library named other
4036 # than .so: use "-Wl," to bypass this
4037 lappend source "-Wl,$shlib_name"
4038 } elseif { ([istarget "*-*-mingw*"]
4039 || [istarget *-*-cygwin*]
4040 || [istarget *-*-pe*])} {
4041 lappend source "${shlib_name}.a"
4043 lappend source $shlib_name
4045 if { $shlib_found == 0 } {
4047 if { ([istarget "*-*-mingw*"]
4048 || [istarget *-*-cygwin*]) } {
4049 lappend new_options "additional_flags=-Wl,--enable-auto-import"
4051 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
4052 # Undo debian's change in the default.
4053 # Put it at the front to not override any user-provided
4054 # value, and to make sure it appears in front of all the
4056 lappend new_options "early_flags=-Wl,--no-as-needed"
4059 } elseif { $opt == "shlib_load" && $type == "executable" } {
4061 } elseif { $opt == "getting_compiler_info" } {
4062 # If this is set, calling test_compiler_info will cause recursion.
4063 set getting_compiler_info 1
4065 lappend new_options $opt
4069 # Ensure stack protector is disabled for GCC, as this causes problems with
4070 # DWARF line numbering.
4071 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
4072 # This option defaults to on for Debian/Ubuntu.
4073 if { $getting_compiler_info == 0
4074 && [test_compiler_info {gcc-*-*}]
4075 && !([test_compiler_info {gcc-[0-3]-*}]
4076 || [test_compiler_info {gcc-4-0-*}])
4077 && [lsearch -exact $options rust] == -1} {
4078 # Put it at the front to not override any user-provided value.
4079 lappend new_options "early_flags=-fno-stack-protector"
4082 # Because we link with libraries using their basename, we may need
4083 # (depending on the platform) to set a special rpath value, to allow
4084 # the executable to find the libraries it depends on.
4085 if { $shlib_load || $shlib_found } {
4086 if { ([istarget "*-*-mingw*"]
4087 || [istarget *-*-cygwin*]
4088 || [istarget *-*-pe*]) } {
4089 # Do not need anything.
4090 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
4091 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
4092 } elseif { [istarget arm*-*-symbianelf*] } {
4093 if { $shlib_load } {
4094 lappend new_options "libs=-ldl"
4097 if { $shlib_load } {
4098 lappend new_options "libs=-ldl"
4100 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
4103 set options $new_options
4105 if [info exists GDB_TESTCASE_OPTIONS] {
4106 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
4108 verbose "options are $options"
4109 verbose "source is $source $dest $type $options"
4113 if {[target_info exists needs_status_wrapper] && \
4114 [target_info needs_status_wrapper] != "0" && \
4115 $gdb_wrapper_file != "" } {
4116 lappend options "libs=${gdb_wrapper_file}"
4117 lappend options "ldflags=${gdb_wrapper_flags}"
4120 # Replace the "nowarnings" option with the appropriate additional_flags
4121 # to disable compiler warnings.
4122 set nowarnings [lsearch -exact $options nowarnings]
4123 if {$nowarnings != -1} {
4124 if [target_info exists gdb,nowarnings_flag] {
4125 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
4127 set flag "additional_flags=-w"
4129 set options [lreplace $options $nowarnings $nowarnings $flag]
4132 # Replace the "pie" option with the appropriate compiler and linker flags
4133 # to enable PIE executables.
4134 set pie [lsearch -exact $options pie]
4136 if [target_info exists gdb,pie_flag] {
4137 set flag "additional_flags=[target_info gdb,pie_flag]"
4139 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
4140 # and SPARC, fpie can cause compile errors due to the GOT exceeding
4141 # a maximum size. On other architectures the two flags are
4142 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
4143 # onwards default GCC to using fPIE. If you do require fpie, then
4144 # it can be set using the pie_flag.
4145 set flag "additional_flags=-fPIE"
4147 set options [lreplace $options $pie $pie $flag]
4149 if [target_info exists gdb,pie_ldflag] {
4150 set flag "ldflags=[target_info gdb,pie_ldflag]"
4152 set flag "ldflags=-pie"
4154 lappend options "$flag"
4157 # Replace the "nopie" option with the appropriate linker flag to disable
4158 # PIE executables. There are no compiler flags for this option.
4159 set nopie [lsearch -exact $options nopie]
4161 if [target_info exists gdb,nopie_flag] {
4162 set flag "ldflags=[target_info gdb,nopie_flag]"
4164 set flag "ldflags=-no-pie"
4166 set options [lreplace $options $nopie $nopie $flag]
4169 if { $type == "executable" } {
4170 if { ([istarget "*-*-mingw*"]
4171 || [istarget "*-*-*djgpp"]
4172 || [istarget "*-*-cygwin*"])} {
4173 # Force output to unbuffered mode, by linking in an object file
4174 # with a global contructor that calls setvbuf.
4176 # Compile the special object separately for two reasons:
4177 # 1) Insulate it from $options.
4178 # 2) Avoid compiling it for every gdb_compile invocation,
4179 # which is time consuming, especially if we're remote
4182 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
4183 verbose "compiling gdb_saved_set_unbuffered_obj"
4184 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
4185 set unbuf_obj ${objdir}/set_unbuffered_mode.o
4187 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
4188 if { $result != "" } {
4191 if {[is_remote host]} {
4192 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
4194 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
4196 # Link a copy of the output object, because the
4197 # original may be automatically deleted.
4198 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
4200 verbose "gdb_saved_set_unbuffered_obj already compiled"
4203 # Rely on the internal knowledge that the global ctors are ran in
4204 # reverse link order. In that case, we can use ldflags to
4205 # avoid copying the object file to the host multiple
4207 # This object can only be added if standard libraries are
4208 # used. Thus, we need to disable it if -nostdlib option is used
4209 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
4210 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
4215 set result [target_compile $source $dest $type $options]
4217 # Prune uninteresting compiler (and linker) output.
4218 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
4220 regsub "\[\r\n\]*$" "$result" "" result
4221 regsub "^\[\r\n\]*" "$result" "" result
4223 if { $type == "executable" && $result == "" \
4224 && ($nopie != -1 || $pie != -1) } {
4225 set is_pie [exec_is_pie "$dest"]
4226 if { $nopie != -1 && $is_pie == 1 } {
4227 set result "nopie failed to prevent PIE executable"
4228 } elseif { $pie != -1 && $is_pie == 0 } {
4229 set result "pie failed to generate PIE executable"
4233 if {[lsearch $options quiet] < 0} {
4234 # We shall update this on a per language basis, to avoid
4235 # changing the entire testsuite in one go.
4236 if {[lsearch $options f77] >= 0} {
4237 gdb_compile_test $source $result
4238 } elseif { $result != "" } {
4239 clone_output "gdb compile failed, $result"
4246 # This is just like gdb_compile, above, except that it tries compiling
4247 # against several different thread libraries, to see which one this
4249 proc gdb_compile_pthreads {source dest type options} {
4250 if {$type != "executable"} {
4251 return [gdb_compile $source $dest $type $options]
4254 set why_msg "unrecognized error"
4255 foreach lib {-lpthreads -lpthread -lthread ""} {
4256 # This kind of wipes out whatever libs the caller may have
4257 # set. Or maybe theirs will override ours. How infelicitous.
4258 set options_with_lib [concat $options [list libs=$lib quiet]]
4259 set ccout [gdb_compile $source $dest $type $options_with_lib]
4260 switch -regexp -- $ccout {
4261 ".*no posix threads support.*" {
4262 set why_msg "missing threads include file"
4265 ".*cannot open -lpthread.*" {
4266 set why_msg "missing runtime threads library"
4268 ".*Can't find library for -lpthread.*" {
4269 set why_msg "missing runtime threads library"
4272 pass "successfully compiled posix threads test case"
4278 if {!$built_binfile} {
4279 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4284 # Build a shared library from SOURCES.
4286 proc gdb_compile_shlib {sources dest options} {
4287 set obj_options $options
4290 if { [lsearch -exact $options "ada"] >= 0 } {
4295 if { [lsearch -exact $options "c++"] >= 0 } {
4296 set info_options "c++"
4298 if [get_compiler_info ${info_options}] {
4302 switch -glob [test_compiler_info] {
4304 lappend obj_options "additional_flags=-qpic"
4307 if { [istarget "*-*-cygwin*"]
4308 || [istarget "*-*-mingw*"] } {
4309 lappend obj_options "additional_flags=-fPIC"
4311 lappend obj_options "additional_flags=-fpic"
4315 if { [istarget "powerpc*-*-aix*"]
4316 || [istarget "rs6000*-*-aix*"]
4317 || [istarget "*-*-cygwin*"]
4318 || [istarget "*-*-mingw*"]
4319 || [istarget "*-*-pe*"] } {
4320 lappend obj_options "additional_flags=-fPIC"
4322 lappend obj_options "additional_flags=-fpic"
4326 lappend obj_options "additional_flags=-fpic"
4329 # don't know what the compiler is...
4330 lappend obj_options "additional_flags=-fPIC"
4334 set outdir [file dirname $dest]
4336 foreach source $sources {
4337 if {[file extension $source] == ".o"} {
4338 # Already a .o file.
4339 lappend objects $source
4343 set sourcebase [file tail $source]
4346 # Gnatmake doesn't like object name foo.adb.o, use foo.o.
4347 set sourcebase [file rootname $sourcebase]
4349 set object ${outdir}/${sourcebase}.o
4352 # Use gdb_compile_ada_1 instead of gdb_compile_ada to avoid the
4354 if {[gdb_compile_ada_1 $source $object object \
4355 $obj_options] != ""} {
4359 if {[gdb_compile $source $object object \
4360 $obj_options] != ""} {
4365 lappend objects $object
4368 set link_options $options
4370 # If we try to use gnatmake for the link, it will interpret the
4371 # object file as an .adb file. Remove ada from the options to
4373 set idx [lsearch $link_options "ada"]
4374 set link_options [lreplace $link_options $idx $idx]
4376 if [test_compiler_info "xlc-*"] {
4377 lappend link_options "additional_flags=-qmkshrobj"
4379 lappend link_options "additional_flags=-shared"
4381 if { ([istarget "*-*-mingw*"]
4382 || [istarget *-*-cygwin*]
4383 || [istarget *-*-pe*]) } {
4384 if { [is_remote host] } {
4385 set name [file tail ${dest}]
4389 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
4391 # Set the soname of the library. This causes the linker on ELF
4392 # systems to create the DT_NEEDED entry in the executable referring
4393 # to the soname of the library, and not its absolute path. This
4394 # (using the absolute path) would be problem when testing on a
4397 # In conjunction with setting the soname, we add the special
4398 # rpath=$ORIGIN value when building the executable, so that it's
4399 # able to find the library in its own directory.
4400 set destbase [file tail $dest]
4401 lappend link_options "additional_flags=-Wl,-soname,$destbase"
4404 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
4407 if { [is_remote host]
4408 && ([istarget "*-*-mingw*"]
4409 || [istarget *-*-cygwin*]
4410 || [istarget *-*-pe*]) } {
4411 set dest_tail_name [file tail ${dest}]
4412 remote_upload host $dest_tail_name.a ${dest}.a
4413 remote_file host delete $dest_tail_name.a
4419 # This is just like gdb_compile_shlib, above, except that it tries compiling
4420 # against several different thread libraries, to see which one this
4422 proc gdb_compile_shlib_pthreads {sources dest options} {
4424 set why_msg "unrecognized error"
4425 foreach lib {-lpthreads -lpthread -lthread ""} {
4426 # This kind of wipes out whatever libs the caller may have
4427 # set. Or maybe theirs will override ours. How infelicitous.
4428 set options_with_lib [concat $options [list libs=$lib quiet]]
4429 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
4430 switch -regexp -- $ccout {
4431 ".*no posix threads support.*" {
4432 set why_msg "missing threads include file"
4435 ".*cannot open -lpthread.*" {
4436 set why_msg "missing runtime threads library"
4438 ".*Can't find library for -lpthread.*" {
4439 set why_msg "missing runtime threads library"
4442 pass "successfully compiled posix threads test case"
4448 if {!$built_binfile} {
4449 unsupported "couldn't compile $sources: ${why_msg}"
4454 # This is just like gdb_compile_pthreads, above, except that we always add the
4455 # objc library for compiling Objective-C programs
4456 proc gdb_compile_objc {source dest type options} {
4458 set why_msg "unrecognized error"
4459 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
4460 # This kind of wipes out whatever libs the caller may have
4461 # set. Or maybe theirs will override ours. How infelicitous.
4462 if { $lib == "solaris" } {
4463 set lib "-lpthread -lposix4"
4465 if { $lib != "-lobjc" } {
4466 set lib "-lobjc $lib"
4468 set options_with_lib [concat $options [list libs=$lib quiet]]
4469 set ccout [gdb_compile $source $dest $type $options_with_lib]
4470 switch -regexp -- $ccout {
4471 ".*no posix threads support.*" {
4472 set why_msg "missing threads include file"
4475 ".*cannot open -lpthread.*" {
4476 set why_msg "missing runtime threads library"
4478 ".*Can't find library for -lpthread.*" {
4479 set why_msg "missing runtime threads library"
4482 pass "successfully compiled objc with posix threads test case"
4488 if {!$built_binfile} {
4489 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4494 # Build an OpenMP program from SOURCE. See prefatory comment for
4495 # gdb_compile, above, for discussion of the parameters to this proc.
4497 proc gdb_compile_openmp {source dest type options} {
4498 lappend options "additional_flags=-fopenmp"
4499 return [gdb_compile $source $dest $type $options]
4502 # Send a command to GDB.
4503 # For options for TYPE see gdb_stdin_log_write
4505 proc send_gdb { string {type standard}} {
4506 global suppress_flag
4507 if { $suppress_flag } {
4510 gdb_stdin_log_write $string $type
4511 return [remote_send host "$string"]
4514 # Send STRING to the inferior's terminal.
4516 proc send_inferior { string } {
4517 global inferior_spawn_id
4519 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
4529 proc gdb_expect { args } {
4530 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4531 set atimeout [lindex $args 0]
4532 set expcode [list [lindex $args 1]]
4537 # A timeout argument takes precedence, otherwise of all the timeouts
4538 # select the largest.
4539 if [info exists atimeout] {
4542 set tmt [get_largest_timeout]
4545 global suppress_flag
4546 global remote_suppress_flag
4547 if [info exists remote_suppress_flag] {
4548 set old_val $remote_suppress_flag
4550 if [info exists suppress_flag] {
4551 if { $suppress_flag } {
4552 set remote_suppress_flag 1
4556 {uplevel remote_expect host $tmt $expcode} string]
4557 if [info exists old_val] {
4558 set remote_suppress_flag $old_val
4560 if [info exists remote_suppress_flag] {
4561 unset remote_suppress_flag
4566 global errorInfo errorCode
4568 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4570 return -code $code $string
4574 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4576 # Check for long sequence of output by parts.
4577 # TEST: is the test message to be printed with the test success/fail.
4578 # SENTINEL: Is the terminal pattern indicating that output has finished.
4579 # LIST: is the sequence of outputs to match.
4580 # If the sentinel is recognized early, it is considered an error.
4583 # 1 if the test failed,
4584 # 0 if the test passes,
4585 # -1 if there was an internal error.
4587 proc gdb_expect_list {test sentinel list} {
4589 global suppress_flag
4592 if { $suppress_flag } {
4594 unresolved "${test}"
4596 while { ${index} < [llength ${list}] } {
4597 set pattern [lindex ${list} ${index}]
4598 set index [expr ${index} + 1]
4599 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4600 if { ${index} == [llength ${list}] } {
4603 -re "${pattern}${sentinel}" {
4604 # pass "${test}, pattern ${index} + sentinel"
4607 fail "${test} (pattern ${index} + sentinel)"
4610 -re ".*A problem internal to GDB has been detected" {
4611 fail "${test} (GDB internal error)"
4613 gdb_internal_error_resync
4616 fail "${test} (pattern ${index} + sentinel) (timeout)"
4621 # unresolved "${test}, pattern ${index} + sentinel"
4627 # pass "${test}, pattern ${index}"
4630 fail "${test} (pattern ${index})"
4633 -re ".*A problem internal to GDB has been detected" {
4634 fail "${test} (GDB internal error)"
4636 gdb_internal_error_resync
4639 fail "${test} (pattern ${index}) (timeout)"
4644 # unresolved "${test}, pattern ${index}"
4658 proc gdb_suppress_entire_file { reason } {
4659 global suppress_flag
4662 set suppress_flag -1
4666 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4667 # gdb_expect to fail immediately (until the next call to
4668 # gdb_stop_suppressing_tests).
4670 proc gdb_suppress_tests { args } {
4671 global suppress_flag
4673 return; # fnf - disable pending review of results where
4674 # testsuite ran better without this
4677 if { $suppress_flag == 1 } {
4678 if { [llength $args] > 0 } {
4679 warning "[lindex $args 0]\n"
4681 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4687 # Clear suppress_flag.
4689 proc gdb_stop_suppressing_tests { } {
4690 global suppress_flag
4692 if [info exists suppress_flag] {
4693 if { $suppress_flag > 0 } {
4695 clone_output "Tests restarted.\n"
4702 proc gdb_clear_suppressed { } {
4703 global suppress_flag
4708 # Spawn the gdb process.
4710 # This doesn't expect any output or do any other initialization,
4711 # leaving those to the caller.
4713 # Overridable function -- you can override this function in your
4716 proc gdb_spawn { } {
4720 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4722 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4725 set saved_gdbflags $GDBFLAGS
4727 if {$GDBFLAGS != ""} {
4730 append GDBFLAGS $cmdline_flags
4734 set GDBFLAGS $saved_gdbflags
4739 # Start gdb running, wait for prompt, and disable the pagers.
4741 # Overridable function -- you can override this function in your
4744 proc gdb_start { } {
4749 catch default_gdb_exit
4752 # Return true if we can spawn a program on the target and attach to
4755 proc can_spawn_for_attach { } {
4756 # We use exp_pid to get the inferior's pid, assuming that gives
4757 # back the pid of the program. On remote boards, that would give
4758 # us instead the PID of e.g., the ssh client, etc.
4759 if [is_remote target] then {
4763 # The "attach" command doesn't make sense when the target is
4764 # stub-like, where GDB finds the program already started on
4765 # initial connection.
4766 if {[target_info exists use_gdb_stub]} {
4774 # Kill a progress previously started with spawn_wait_for_attach, and
4775 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4778 proc kill_wait_spawned_process { proc_spawn_id } {
4779 set pid [exp_pid -i $proc_spawn_id]
4781 verbose -log "killing ${pid}"
4782 remote_exec build "kill -9 ${pid}"
4784 verbose -log "closing ${proc_spawn_id}"
4785 catch "close -i $proc_spawn_id"
4786 verbose -log "waiting for ${proc_spawn_id}"
4788 # If somehow GDB ends up still attached to the process here, a
4789 # blocking wait hangs until gdb is killed (or until gdb / the
4790 # ptracer reaps the exit status too, but that won't happen because
4791 # something went wrong.) Passing -nowait makes expect tell Tcl to
4792 # wait for the PID in the background. That's fine because we
4793 # don't care about the exit status. */
4794 wait -nowait -i $proc_spawn_id
4797 # Returns the process id corresponding to the given spawn id.
4799 proc spawn_id_get_pid { spawn_id } {
4800 set testpid [exp_pid -i $spawn_id]
4802 if { [istarget "*-*-cygwin*"] } {
4803 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4804 # might be different due to the way fork/exec works.
4805 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4811 # Start a set of programs running and then wait for a bit, to be sure
4812 # that they can be attached to. Return a list of processes spawn IDs,
4813 # one element for each process spawned. It's a test error to call
4814 # this when [can_spawn_for_attach] is false.
4816 proc spawn_wait_for_attach { executable_list } {
4817 set spawn_id_list {}
4819 if ![can_spawn_for_attach] {
4820 # The caller should have checked can_spawn_for_attach itself
4821 # before getting here.
4822 error "can't spawn for attach with this target/board"
4825 foreach {executable} $executable_list {
4826 # Note we use Expect's spawn, not Tcl's exec, because with
4827 # spawn we control when to wait for/reap the process. That
4828 # allows killing the process by PID without being subject to
4830 lappend spawn_id_list [remote_spawn target $executable]
4835 return $spawn_id_list
4839 # gdb_load_cmd -- load a file into the debugger.
4840 # ARGS - additional args to load command.
4841 # return a -1 if anything goes wrong.
4843 proc gdb_load_cmd { args } {
4846 if [target_info exists gdb_load_timeout] {
4847 set loadtimeout [target_info gdb_load_timeout]
4849 set loadtimeout 1600
4851 send_gdb "load $args\n"
4852 verbose "Timeout is now $loadtimeout seconds" 2
4853 gdb_expect $loadtimeout {
4854 -re "Loading section\[^\r\]*\r\n" {
4857 -re "Start address\[\r\]*\r\n" {
4860 -re "Transfer rate\[\r\]*\r\n" {
4863 -re "Memory access error\[^\r\]*\r\n" {
4864 perror "Failed to load program"
4867 -re "$gdb_prompt $" {
4870 -re "(.*)\r\n$gdb_prompt " {
4871 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4875 perror "Timed out trying to load $args."
4882 # Invoke "gcore". CORE is the name of the core file to write. TEST
4883 # is the name of the test case. This will return 1 if the core file
4884 # was created, 0 otherwise. If this fails to make a core file because
4885 # this configuration of gdb does not support making core files, it
4886 # will call "unsupported", not "fail". However, if this fails to make
4887 # a core file for some other reason, then it will call "fail".
4889 proc gdb_gcore_cmd {core test} {
4893 gdb_test_multiple "gcore $core" $test {
4894 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4898 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4906 # Load core file CORE. TEST is the name of the test case.
4907 # This will record a pass/fail for loading the core file.
4909 # 1 - core file is successfully loaded
4910 # 0 - core file loaded but has a non fatal error
4911 # -1 - core file failed to load
4913 proc gdb_core_cmd { core test } {
4916 gdb_test_multiple "core $core" "$test" {
4917 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4920 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4921 fail "$test (bad file format)"
4924 -re -wrap "[string_to_regexp $core]: No such file or directory.*" {
4925 fail "$test (file not found)"
4928 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4929 fail "$test (incomplete note section)"
4932 -re "Core was generated by .*\r\n$gdb_prompt $" {
4936 -re ".*$gdb_prompt $" {
4941 fail "$test (timeout)"
4945 fail "unsupported output from 'core' command"
4949 # Return the filename to download to the target and load on the target
4950 # for this shared library. Normally just LIBNAME, unless shared libraries
4951 # for this target have separate link and load images.
4953 proc shlib_target_file { libname } {
4957 # Return the filename GDB will load symbols from when debugging this
4958 # shared library. Normally just LIBNAME, unless shared libraries for
4959 # this target have separate link and load images.
4961 proc shlib_symbol_file { libname } {
4965 # Return the filename to download to the target and load for this
4966 # executable. Normally just BINFILE unless it is renamed to something
4967 # else for this target.
4969 proc exec_target_file { binfile } {
4973 # Return the filename GDB will load symbols from when debugging this
4974 # executable. Normally just BINFILE unless executables for this target
4975 # have separate files for symbols.
4977 proc exec_symbol_file { binfile } {
4981 # Rename the executable file. Normally this is just BINFILE1 being renamed
4982 # to BINFILE2, but some targets require multiple binary files.
4983 proc gdb_rename_execfile { binfile1 binfile2 } {
4984 file rename -force [exec_target_file ${binfile1}] \
4985 [exec_target_file ${binfile2}]
4986 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4987 file rename -force [exec_symbol_file ${binfile1}] \
4988 [exec_symbol_file ${binfile2}]
4992 # "Touch" the executable file to update the date. Normally this is just
4993 # BINFILE, but some targets require multiple files.
4994 proc gdb_touch_execfile { binfile } {
4995 set time [clock seconds]
4996 file mtime [exec_target_file ${binfile}] $time
4997 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4998 file mtime [exec_symbol_file ${binfile}] $time
5002 # Like remote_download but provides a gdb-specific behavior.
5004 # If the destination board is remote, the local file FROMFILE is transferred as
5005 # usual with remote_download to TOFILE on the remote board. The destination
5006 # filename is added to the CLEANFILES global, so it can be cleaned up at the
5009 # If the destination board is local, the destination path TOFILE is passed
5010 # through standard_output_file, and FROMFILE is copied there.
5012 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
5015 proc gdb_remote_download {dest fromfile {tofile {}}} {
5016 # If TOFILE is not given, default to the same filename as FROMFILE.
5017 if {[string length $tofile] == 0} {
5018 set tofile [file tail $fromfile]
5021 if {[is_remote $dest]} {
5022 # When the DEST is remote, we simply send the file to DEST.
5025 set destname [remote_download $dest $fromfile $tofile]
5026 lappend cleanfiles $destname
5030 # When the DEST is local, we copy the file to the test directory (where
5031 # the executable is).
5033 # Note that we pass TOFILE through standard_output_file, regardless of
5034 # whether it is absolute or relative, because we don't want the tests
5035 # to be able to write outside their standard output directory.
5037 set tofile [standard_output_file $tofile]
5039 file copy -force $fromfile $tofile
5045 # gdb_load_shlib LIB...
5047 # Copy the listed library to the target.
5049 proc gdb_load_shlib { file } {
5052 if ![info exists gdb_spawn_id] {
5053 perror "gdb_load_shlib: GDB is not running"
5056 set dest [gdb_remote_download target [shlib_target_file $file]]
5058 if {[is_remote target]} {
5059 # If the target is remote, we need to tell gdb where to find the
5062 # We could set this even when not testing remotely, but a user
5063 # generally won't set it unless necessary. In order to make the tests
5064 # more like the real-life scenarios, we don't set it for local testing.
5065 gdb_test "set solib-search-path [file dirname $file]" "" ""
5072 # gdb_load -- load a file into the debugger. Specifying no file
5073 # defaults to the executable currently being debugged.
5074 # The return value is 0 for success, -1 for failure.
5075 # Many files in config/*.exp override this procedure.
5077 proc gdb_load { arg } {
5079 return [gdb_file_cmd $arg]
5084 # gdb_reload -- load a file into the target. Called before "running",
5085 # either the first time or after already starting the program once,
5086 # for remote targets. Most files that override gdb_load should now
5087 # override this instead.
5089 # INFERIOR_ARGS contains the arguments to pass to the inferiors, as a
5090 # single string to get interpreted by a shell. If the target board
5091 # overriding gdb_reload is a "stub", then it should arrange things such
5092 # these arguments make their way to the inferior process.
5094 proc gdb_reload { {inferior_args {}} } {
5095 # For the benefit of existing configurations, default to gdb_load.
5096 # Specifying no file defaults to the executable currently being
5098 return [gdb_load ""]
5101 proc gdb_continue { function } {
5104 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
5107 # Default implementation of gdb_init.
5108 proc default_gdb_init { test_file_name } {
5109 global gdb_wrapper_initialized
5110 global gdb_wrapper_target
5111 global gdb_test_file_name
5115 # Reset the timeout value to the default. This way, any testcase
5116 # that changes the timeout value without resetting it cannot affect
5117 # the timeout used in subsequent testcases.
5118 global gdb_test_timeout
5120 set timeout $gdb_test_timeout
5122 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
5123 && [target_info exists gdb_reverse_timeout] } {
5124 set timeout [target_info gdb_reverse_timeout]
5127 # If GDB_INOTIFY is given, check for writes to '.'. This is a
5128 # debugging tool to help confirm that the test suite is
5129 # parallel-safe. You need "inotifywait" from the
5130 # inotify-tools package to use this.
5131 global GDB_INOTIFY inotify_pid
5132 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
5133 global outdir tool inotify_log_file
5135 set exclusions {outputs temp gdb[.](log|sum) cache}
5136 set exclusion_re ([join $exclusions |])
5138 set inotify_log_file [standard_temp_file inotify.out]
5139 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
5140 --exclude $exclusion_re \
5141 |& tee -a $outdir/$tool.log $inotify_log_file &]
5143 # Wait for the watches; hopefully this is long enough.
5146 # Clear the log so that we don't emit a warning the first time
5148 set fd [open $inotify_log_file w]
5152 # Block writes to all banned variables, and invocation of all
5153 # banned procedures...
5154 global banned_variables
5155 global banned_procedures
5156 global banned_traced
5157 if (!$banned_traced) {
5158 foreach banned_var $banned_variables {
5159 global "$banned_var"
5160 trace add variable "$banned_var" write error
5162 foreach banned_proc $banned_procedures {
5163 global "$banned_proc"
5164 trace add execution "$banned_proc" enter error
5169 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
5170 # messages as expected.
5175 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
5176 # the test results. Even if /dev/null doesn't exist on the particular
5177 # platform, the readline library will use the default setting just by
5178 # failing to open the file. OTOH, opening /dev/null successfully will
5179 # also result in the default settings being used since nothing will be
5180 # read from this file.
5181 setenv INPUTRC "/dev/null"
5183 # This disables style output, which would interfere with many
5187 # Ensure that GDBHISTFILE and GDBHISTSIZE are removed from the
5188 # environment, we don't want these modifications to the history
5190 unset -nocomplain ::env(GDBHISTFILE)
5191 unset -nocomplain ::env(GDBHISTSIZE)
5193 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
5194 # during startup. See "man expect" for details about stty_init.
5196 set stty_init "rows 25 cols 80"
5198 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
5199 # grep. Clear GREP_OPTIONS to make the behavior predictable,
5200 # especially having color output turned on can cause tests to fail.
5201 setenv GREP_OPTIONS ""
5203 # Clear $gdbserver_reconnect_p.
5204 global gdbserver_reconnect_p
5205 set gdbserver_reconnect_p 1
5206 unset gdbserver_reconnect_p
5208 # Clear $last_loaded_file
5209 global last_loaded_file
5210 unset -nocomplain last_loaded_file
5212 # Reset GDB number of instances
5213 global gdb_instances
5218 gdb_clear_suppressed
5220 set gdb_test_file_name [file rootname [file tail $test_file_name]]
5222 # Make sure that the wrapper is rebuilt
5223 # with the appropriate multilib option.
5224 if { $gdb_wrapper_target != [current_target_name] } {
5225 set gdb_wrapper_initialized 0
5228 # Unlike most tests, we have a small number of tests that generate
5229 # a very large amount of output. We therefore increase the expect
5230 # buffer size to be able to contain the entire test output. This
5231 # is especially needed by gdb.base/info-macros.exp.
5233 # Also set this value for the currently running GDB.
5234 match_max [match_max -d]
5236 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
5237 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
5240 if [target_info exists gdb_prompt] {
5241 set gdb_prompt [target_info gdb_prompt]
5243 set gdb_prompt "\\(gdb\\)"
5246 if [info exists use_gdb_stub] {
5250 gdb_setup_known_globals
5252 if { [info procs ::gdb_tcl_unknown] != "" } {
5253 # Dejagnu overrides proc unknown. The dejagnu version may trigger in a
5254 # test-case but abort the entire test run. To fix this, we install a
5255 # local version here, which reverts dejagnu's override, and restore
5256 # dejagnu's version in gdb_finish.
5257 rename ::unknown ::dejagnu_unknown
5258 proc unknown { args } {
5259 # Use tcl's unknown.
5260 set cmd [lindex $args 0]
5261 unresolved "testcase aborted due to invalid command name: $cmd"
5262 return [uplevel 1 ::gdb_tcl_unknown $args]
5267 # Return a path using GDB_PARALLEL.
5268 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
5269 # GDB_PARALLEL must be defined, the caller must check.
5271 # The default value for GDB_PARALLEL is, canonically, ".".
5272 # The catch is that tests don't expect an additional "./" in file paths so
5273 # omit any directory for the default case.
5274 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
5275 # its special handling.
5277 proc make_gdb_parallel_path { args } {
5278 global GDB_PARALLEL objdir
5279 set joiner [list "file" "join" $objdir]
5280 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
5281 lappend joiner $GDB_PARALLEL
5283 set joiner [concat $joiner $args]
5284 return [eval $joiner]
5287 # Turn BASENAME into a full file name in the standard output
5288 # directory. It is ok if BASENAME is the empty string; in this case
5289 # the directory is returned.
5291 proc standard_output_file {basename} {
5292 global objdir subdir gdb_test_file_name
5294 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
5296 # If running on MinGW, replace /c/foo with c:/foo
5297 if { [ishost *-*-mingw*] } {
5298 set dir [exec sh -c "cd ${dir} && pwd -W"]
5300 return [file join $dir $basename]
5303 # Turn BASENAME into a full file name in the standard output directory. If
5304 # GDB has been launched more than once then append the count, starting with
5307 proc standard_output_file_with_gdb_instance {basename} {
5308 global gdb_instances
5309 set count $gdb_instances
5312 return [standard_output_file $basename]
5314 return [standard_output_file ${basename}.${count}]
5317 # Return the name of a file in our standard temporary directory.
5319 proc standard_temp_file {basename} {
5320 # Since a particular runtest invocation is only executing a single test
5321 # file at any given time, we can use the runtest pid to build the
5322 # path of the temp directory.
5323 set dir [make_gdb_parallel_path temp [pid]]
5325 return [file join $dir $basename]
5328 # Rename file A to file B, if B does not already exists. Otherwise, leave B
5329 # as is and delete A. Return 1 if rename happened.
5331 proc tentative_rename { a b } {
5332 global errorInfo errorCode
5333 set code [catch {file rename -- $a $b} result]
5334 if { $code == 1 && [lindex $errorCode 0] == "POSIX" \
5335 && [lindex $errorCode 1] == "EEXIST" } {
5340 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
5341 } elseif {$code > 1} {
5342 return -code $code $result
5347 # Create a file with name FILENAME and contents TXT in the cache directory.
5348 # If EXECUTABLE, mark the new file for execution.
5350 proc cached_file { filename txt {executable 0}} {
5351 set filename [make_gdb_parallel_path cache $filename]
5353 if { [file exists $filename] } {
5357 set dir [file dirname $filename]
5360 set tmp_filename $filename.[pid]
5361 set fd [open $tmp_filename w]
5365 if { $executable } {
5366 exec chmod +x $tmp_filename
5368 tentative_rename $tmp_filename $filename
5373 # Set 'testfile', 'srcfile', and 'binfile'.
5375 # ARGS is a list of source file specifications.
5376 # Without any arguments, the .exp file's base name is used to
5377 # compute the source file name. The ".c" extension is added in this case.
5378 # If ARGS is not empty, each entry is a source file specification.
5379 # If the specification starts with a "." or "-", it is treated as a suffix
5380 # to append to the .exp file's base name.
5381 # If the specification is the empty string, it is treated as if it
5383 # Otherwise it is a file name.
5384 # The first file in the list is used to set the 'srcfile' global.
5385 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
5387 # Most tests should call this without arguments.
5389 # If a completely different binary file name is needed, then it
5390 # should be handled in the .exp file with a suitable comment.
5392 proc standard_testfile {args} {
5393 global gdb_test_file_name
5395 global gdb_test_file_last_vars
5398 global testfile binfile
5400 set testfile $gdb_test_file_name
5401 set binfile [standard_output_file ${testfile}]
5403 if {[llength $args] == 0} {
5407 # Unset our previous output variables.
5408 # This can help catch hidden bugs.
5409 if {[info exists gdb_test_file_last_vars]} {
5410 foreach varname $gdb_test_file_last_vars {
5412 catch {unset $varname}
5415 # 'executable' is often set by tests.
5416 set gdb_test_file_last_vars {executable}
5420 set varname srcfile$suffix
5423 # Handle an extension.
5427 set first [string range $arg 0 0]
5428 if { $first == "." || $first == "-" } {
5429 set arg $testfile$arg
5434 lappend gdb_test_file_last_vars $varname
5436 if {$suffix == ""} {
5444 # The default timeout used when testing GDB commands. We want to use
5445 # the same timeout as the default dejagnu timeout, unless the user has
5446 # already provided a specific value (probably through a site.exp file).
5447 global gdb_test_timeout
5448 if ![info exists gdb_test_timeout] {
5449 set gdb_test_timeout $timeout
5452 # A list of global variables that GDB testcases should not use.
5453 # We try to prevent their use by monitoring write accesses and raising
5454 # an error when that happens.
5455 set banned_variables { bug_id prms_id }
5457 # A list of procedures that GDB testcases should not use.
5458 # We try to prevent their use by monitoring invocations and raising
5459 # an error when that happens.
5460 set banned_procedures { strace }
5462 # gdb_init is called by runtest at start, but also by several
5463 # tests directly; gdb_finish is only called from within runtest after
5464 # each test source execution.
5465 # Placing several traces by repetitive calls to gdb_init leads
5466 # to problems, as only one trace is removed in gdb_finish.
5467 # To overcome this possible problem, we add a variable that records
5468 # if the banned variables and procedures are already traced.
5471 # Global array that holds the name of all global variables at the time
5472 # a test script is started. After the test script has completed any
5473 # global not in this list is deleted.
5474 array set gdb_known_globals {}
5476 # Setup the GDB_KNOWN_GLOBALS array with the names of all current
5478 proc gdb_setup_known_globals {} {
5479 global gdb_known_globals
5481 array set gdb_known_globals {}
5482 foreach varname [info globals] {
5483 set gdb_known_globals($varname) 1
5487 # Cleanup the global namespace. Any global not in the
5488 # GDB_KNOWN_GLOBALS array is unset, this ensures we don't "leak"
5489 # globals from one test script to another.
5490 proc gdb_cleanup_globals {} {
5491 global gdb_known_globals gdb_persistent_globals
5493 foreach varname [info globals] {
5494 if {![info exists gdb_known_globals($varname)]} {
5495 if { [info exists gdb_persistent_globals($varname)] } {
5498 uplevel #0 unset $varname
5503 # Create gdb_tcl_unknown, a copy tcl's ::unknown, provided it's present as a
5505 set temp [interp create]
5506 if { [interp eval $temp "info procs ::unknown"] != "" } {
5507 set old_args [interp eval $temp "info args ::unknown"]
5508 set old_body [interp eval $temp "info body ::unknown"]
5509 eval proc gdb_tcl_unknown {$old_args} {$old_body}
5514 # GDB implementation of ${tool}_init. Called right before executing the
5516 # Overridable function -- you can override this function in your
5518 proc gdb_init { args } {
5519 # A baseboard file overriding this proc and calling the default version
5520 # should behave the same as this proc. So, don't add code here, but to
5521 # the default version instead.
5522 return [default_gdb_init {*}$args]
5525 # GDB implementation of ${tool}_finish. Called right after executing the
5527 proc gdb_finish { } {
5528 global gdbserver_reconnect_p
5531 global known_globals
5533 if { [info procs ::gdb_tcl_unknown] != "" } {
5534 # Restore dejagnu's version of proc unknown.
5536 rename ::dejagnu_unknown ::unknown
5539 # Exit first, so that the files are no longer in use.
5542 if { [llength $cleanfiles] > 0 } {
5543 eval remote_file target delete $cleanfiles
5547 # Unblock write access to the banned variables. Dejagnu typically
5548 # resets some of them between testcases.
5549 global banned_variables
5550 global banned_procedures
5551 global banned_traced
5552 if ($banned_traced) {
5553 foreach banned_var $banned_variables {
5554 global "$banned_var"
5555 trace remove variable "$banned_var" write error
5557 foreach banned_proc $banned_procedures {
5558 global "$banned_proc"
5559 trace remove execution "$banned_proc" enter error
5564 global gdb_finish_hooks
5565 foreach gdb_finish_hook $gdb_finish_hooks {
5568 set gdb_finish_hooks [list]
5574 set debug_format "unknown"
5576 # Run the gdb command "info source" and extract the debugging format
5577 # information from the output and save it in debug_format.
5579 proc get_debug_format { } {
5584 set debug_format "unknown"
5585 send_gdb "info source\n"
5587 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
5588 set debug_format $expect_out(1,string)
5589 verbose "debug format is $debug_format"
5592 -re "No current source file.\r\n$gdb_prompt $" {
5593 perror "get_debug_format used when no current source file"
5596 -re "$gdb_prompt $" {
5597 warning "couldn't check debug format (no valid response)."
5601 warning "couldn't check debug format (timeout)."
5607 # Return true if FORMAT matches the debug format the current test was
5608 # compiled with. FORMAT is a shell-style globbing pattern; it can use
5609 # `*', `[...]', and so on.
5611 # This function depends on variables set by `get_debug_format', above.
5613 proc test_debug_format {format} {
5616 return [expr [string match $format $debug_format] != 0]
5619 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
5620 # COFF, stabs, etc). If that format matches the format that the
5621 # current test was compiled with, then the next test is expected to
5622 # fail for any target. Returns 1 if the next test or set of tests is
5623 # expected to fail, 0 otherwise (or if it is unknown). Must have
5624 # previously called get_debug_format.
5625 proc setup_xfail_format { format } {
5626 set ret [test_debug_format $format]
5634 # gdb_get_line_number TEXT [FILE]
5636 # Search the source file FILE, and return the line number of the
5637 # first line containing TEXT. If no match is found, an error is thrown.
5639 # TEXT is a string literal, not a regular expression.
5641 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
5642 # specified, and does not start with "/", then it is assumed to be in
5643 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
5644 # by changing the callers and the interface at the same time.
5645 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
5646 # gdb.base/ena-dis-br.exp.
5648 # Use this function to keep your test scripts independent of the
5649 # exact line numbering of the source file. Don't write:
5651 # send_gdb "break 20"
5653 # This means that if anyone ever edits your test's source file,
5654 # your test could break. Instead, put a comment like this on the
5655 # source file line you want to break at:
5657 # /* breakpoint spot: frotz.exp: test name */
5659 # and then write, in your test script (which we assume is named
5662 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
5664 # (Yes, Tcl knows how to handle the nested quotes and brackets.
5667 # % puts "foo [lindex "bar baz" 1]"
5670 # Tcl is quite clever, for a little stringy language.)
5674 # The previous implementation of this procedure used the gdb search command.
5675 # This version is different:
5677 # . It works with MI, and it also works when gdb is not running.
5679 # . It operates on the build machine, not the host machine.
5681 # . For now, this implementation fakes a current directory of
5682 # $srcdir/$subdir to be compatible with the old implementation.
5683 # This will go away eventually and some callers will need to
5686 # . The TEXT argument is literal text and matches literally,
5687 # not a regular expression as it was before.
5689 # . State changes in gdb, such as changing the current file
5690 # and setting $_, no longer happen.
5692 # After a bit of time we can forget about the differences from the
5693 # old implementation.
5695 # --chastain 2004-08-05
5697 proc gdb_get_line_number { text { file "" } } {
5702 if { "$file" == "" } then {
5705 if { ! [regexp "^/" "$file"] } then {
5706 set file "$srcdir/$subdir/$file"
5709 if { [ catch { set fd [open "$file"] } message ] } then {
5714 for { set line 1 } { 1 } { incr line } {
5715 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5718 if { $nchar < 0 } then {
5721 if { [string first "$text" "$body"] >= 0 } then {
5727 if { [ catch { close "$fd" } message ] } then {
5732 error "undefined tag \"$text\""
5738 # Continue the program until it ends.
5740 # MSSG is the error message that gets printed. If not given, a
5742 # COMMAND is the command to invoke. If not given, "continue" is
5744 # ALLOW_EXTRA is a flag indicating whether the test should expect
5745 # extra output between the "Continuing." line and the program
5746 # exiting. By default it is zero; if nonzero, any extra output
5749 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5750 global inferior_exited_re use_gdb_stub
5753 set text "continue until exit"
5755 set text "continue until exit at $mssg"
5763 # By default, we don't rely on exit() behavior of remote stubs --
5764 # it's common for exit() to be implemented as a simple infinite
5765 # loop, or a forced crash/reset. For native targets, by default, we
5766 # assume process exit is reported as such. If a non-reliable target
5767 # is used, we set a breakpoint at exit, and continue to that.
5768 if { [target_info exists exit_is_reliable] } {
5769 set exit_is_reliable [target_info exit_is_reliable]
5771 set exit_is_reliable [expr ! $use_gdb_stub]
5774 if { ! $exit_is_reliable } {
5775 if {![gdb_breakpoint "exit"]} {
5778 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5781 # Continue until we exit. Should not stop again.
5782 # Don't bother to check the output of the program, that may be
5783 # extremely tough for some remote systems.
5785 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5790 proc rerun_to_main {} {
5791 global gdb_prompt use_gdb_stub
5796 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5797 {pass "rerun to main" ; return 0}
5798 -re "$gdb_prompt $"\
5799 {fail "rerun to main" ; return 0}
5800 timeout {fail "(timeout) rerun to main" ; return 0}
5805 -re "The program .* has been started already.*y or n. $" {
5806 send_gdb "y\n" answer
5809 -re "Starting program.*$gdb_prompt $"\
5810 {pass "rerun to main" ; return 0}
5811 -re "$gdb_prompt $"\
5812 {fail "rerun to main" ; return 0}
5813 timeout {fail "(timeout) rerun to main" ; return 0}
5818 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5820 proc exec_has_index_section { executable } {
5821 set readelf_program [gdb_find_readelf]
5822 set res [catch {exec $readelf_program -S $executable \
5823 | grep -E "\.gdb_index|\.debug_names" }]
5830 # Return list with major and minor version of readelf, or an empty list.
5831 gdb_caching_proc readelf_version {
5832 set readelf_program [gdb_find_readelf]
5833 set res [catch {exec $readelf_program --version} output]
5837 set lines [split $output \n]
5838 set line [lindex $lines 0]
5839 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
5840 $line dummy major minor]
5844 return [list $major $minor]
5847 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
5848 proc readelf_prints_pie { } {
5849 set version [readelf_version]
5850 if { [llength $version] == 0 } {
5853 set major [lindex $version 0]
5854 set minor [lindex $version 1]
5855 # It would be better to construct a PIE executable and test if the PIE
5856 # flag is printed by readelf, but we cannot reliably construct a PIE
5857 # executable if the multilib_flags dictate otherwise
5858 # (--target_board=unix/-no-pie/-fno-PIE).
5859 return [version_at_least $major $minor 2 26]
5862 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
5863 # and -1 if unknown.
5865 proc exec_is_pie { executable } {
5866 set res [readelf_prints_pie]
5870 set readelf_program [gdb_find_readelf]
5871 # We're not testing readelf -d | grep "FLAGS_1.*Flags:.*PIE"
5872 # because the PIE flag is not set by all versions of gold, see PR
5874 set res [catch {exec $readelf_program -h $executable} output]
5878 set res [regexp -line {^[ \t]*Type:[ \t]*DYN \(Shared object file\)$} \
5886 # Return true if a test should be skipped due to lack of floating
5887 # point support or GDB can't fetch the contents from floating point
5890 gdb_caching_proc gdb_skip_float_test {
5891 if [target_info exists gdb,skip_float_tests] {
5895 # There is an ARM kernel ptrace bug that hardware VFP registers
5896 # are not updated after GDB ptrace set VFP registers. The bug
5897 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5898 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5899 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5900 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5901 # This kernel bug is detected by check how does GDB change the
5902 # program result by changing one VFP register.
5903 if { [istarget "arm*-*-linux*"] } {
5905 set compile_flags {debug nowarnings }
5907 # Set up, compile, and execute a test program having VFP
5909 set src [standard_temp_file arm_vfp[pid].c]
5910 set exe [standard_temp_file arm_vfp[pid].x]
5912 gdb_produce_source $src {
5917 asm ("vldr d0, [%0]" : : "r" (&d));
5918 asm ("vldr d1, [%0]" : : "r" (&d));
5919 asm (".global break_here\n"
5921 asm ("vcmp.f64 d0, d1\n"
5922 "vmrs APSR_nzcv, fpscr\n"
5923 "bne L_value_different\n"
5926 "L_value_different:\n"
5928 "L_end:\n" : "=r" (ret) :);
5930 /* Return $d0 != $d1. */
5935 verbose "compiling testfile $src" 2
5936 set lines [gdb_compile $src $exe executable $compile_flags]
5939 if ![string match "" $lines] then {
5940 verbose "testfile compilation failed, returning 1" 2
5944 # No error message, compilation succeeded so now run it via gdb.
5945 # Run the test up to 5 times to detect whether ptrace can
5946 # correctly update VFP registers or not.
5948 for {set i 0} {$i < 5} {incr i} {
5949 global gdb_prompt srcdir subdir
5953 gdb_reinitialize_dir $srcdir/$subdir
5957 gdb_test "break *break_here"
5958 gdb_continue_to_breakpoint "break_here"
5960 # Modify $d0 to a different value, so the exit code should
5962 gdb_test "set \$d0 = 5.0"
5964 set test "continue to exit"
5965 gdb_test_multiple "continue" "$test" {
5966 -re "exited with code 01.*$gdb_prompt $" {
5968 -re "exited normally.*$gdb_prompt $" {
5969 # However, the exit code is 0. That means something
5970 # wrong in setting VFP registers.
5978 remote_file build delete $exe
5980 return $skip_vfp_test
5985 # Print a message and return true if a test should be skipped
5986 # due to lack of stdio support.
5988 proc gdb_skip_stdio_test { msg } {
5989 if [target_info exists gdb,noinferiorio] {
5990 verbose "Skipping test '$msg': no inferior i/o."
5996 proc gdb_skip_bogus_test { msg } {
6000 # Return true if a test should be skipped due to lack of XML support
6002 # NOTE: This must be called while gdb is *not* running.
6004 gdb_caching_proc gdb_skip_xml_test {
6009 if { [info exists gdb_spawn_id] } {
6010 error "GDB must not be running in gdb_skip_xml_tests."
6013 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
6017 gdb_test_multiple "set tdesc filename $xml_file" "" {
6018 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
6021 -re ".*$gdb_prompt $" { }
6027 # Return true if argv[0] is available.
6029 gdb_caching_proc gdb_has_argv0 {
6032 # Compile and execute a test program to check whether argv[0] is available.
6033 gdb_simple_compile has_argv0 {
6034 int main (int argc, char **argv) {
6041 proc gdb_has_argv0_1 { exe } {
6042 global srcdir subdir
6043 global gdb_prompt hex
6047 gdb_reinitialize_dir $srcdir/$subdir
6050 # Set breakpoint on main.
6051 gdb_test_multiple "break -q main" "break -q main" {
6052 -re "Breakpoint.*${gdb_prompt} $" {
6054 -re "${gdb_prompt} $" {
6061 gdb_test_multiple "" "run to main" {
6062 -re "Breakpoint.*${gdb_prompt} $" {
6064 -re "${gdb_prompt} $" {
6069 set old_elements "200"
6070 set test "show print elements"
6071 gdb_test_multiple $test $test {
6072 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
6073 set old_elements $expect_out(1,string)
6076 set old_repeats "200"
6077 set test "show print repeats"
6078 gdb_test_multiple $test $test {
6079 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
6080 set old_repeats $expect_out(1,string)
6083 gdb_test_no_output "set print elements unlimited" ""
6084 gdb_test_no_output "set print repeats unlimited" ""
6087 # Check whether argc is 1.
6088 gdb_test_multiple "p argc" "p argc" {
6089 -re " = 1\r\n${gdb_prompt} $" {
6091 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
6092 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
6095 -re "${gdb_prompt} $" {
6099 -re "${gdb_prompt} $" {
6103 gdb_test_no_output "set print elements $old_elements" ""
6104 gdb_test_no_output "set print repeats $old_repeats" ""
6109 set result [gdb_has_argv0_1 $obj]
6115 && ([istarget *-*-linux*]
6116 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
6117 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
6118 || [istarget *-*-openbsd*]
6119 || [istarget *-*-darwin*]
6120 || [istarget *-*-solaris*]
6121 || [istarget *-*-aix*]
6122 || [istarget *-*-gnu*]
6123 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
6124 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
6125 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
6126 || [istarget *-*-symbianelf*]
6127 || [istarget *-*-osf*]
6128 || [istarget *-*-dicos*]
6129 || [istarget *-*-nto*]
6130 || [istarget *-*-*vms*]
6131 || [istarget *-*-lynx*178]) } {
6132 fail "argv\[0\] should be available on this target"
6138 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
6139 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
6140 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
6141 # the name of a debuginfo only file. This file will be stored in the same
6144 # Functions for separate debug info testing
6146 # starting with an executable:
6147 # foo --> original executable
6149 # at the end of the process we have:
6150 # foo.stripped --> foo w/o debug info
6151 # foo.debug --> foo's debug info
6152 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
6154 # Fetch the build id from the file.
6155 # Returns "" if there is none.
6157 proc get_build_id { filename } {
6158 if { ([istarget "*-*-mingw*"]
6159 || [istarget *-*-cygwin*]) } {
6160 set objdump_program [gdb_find_objdump]
6161 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
6162 verbose "result is $result"
6163 verbose "output is $output"
6169 set tmp [standard_output_file "${filename}-tmp"]
6170 set objcopy_program [gdb_find_objcopy]
6171 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
6172 verbose "result is $result"
6173 verbose "output is $output"
6178 fconfigure $fi -translation binary
6179 # Skip the NOTE header.
6184 if ![string compare $data ""] then {
6187 # Convert it to hex.
6188 binary scan $data H* data
6193 # Return the build-id hex string (usually 160 bits as 40 hex characters)
6194 # converted to the form: .build-id/ab/cdef1234...89.debug
6195 # Return "" if no build-id found.
6196 proc build_id_debug_filename_get { filename } {
6197 set data [get_build_id $filename]
6198 if { $data == "" } {
6201 regsub {^..} $data {\0/} data
6202 return ".build-id/${data}.debug"
6205 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
6206 # list of optional flags. The only currently supported flag is no-main,
6207 # which removes the symbol entry for main from the separate debug file.
6209 # Function returns zero on success. Function will return non-zero failure code
6210 # on some targets not supporting separate debug info (such as i386-msdos).
6212 proc gdb_gnu_strip_debug { dest args } {
6214 # Use the first separate debug info file location searched by GDB so the
6215 # run cannot be broken by some stale file searched with higher precedence.
6216 set debug_file "${dest}.debug"
6218 set strip_to_file_program [transform strip]
6219 set objcopy_program [gdb_find_objcopy]
6221 set debug_link [file tail $debug_file]
6222 set stripped_file "${dest}.stripped"
6224 # Get rid of the debug info, and store result in stripped_file
6225 # something like gdb/testsuite/gdb.base/blah.stripped.
6226 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
6227 verbose "result is $result"
6228 verbose "output is $output"
6233 # Workaround PR binutils/10802:
6234 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
6235 set perm [file attributes ${dest} -permissions]
6236 file attributes ${stripped_file} -permissions $perm
6238 # Get rid of everything but the debug info, and store result in debug_file
6239 # This will be in the .debug subdirectory, see above.
6240 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
6241 verbose "result is $result"
6242 verbose "output is $output"
6247 # If no-main is passed, strip the symbol for main from the separate
6248 # file. This is to simulate the behavior of elfutils's eu-strip, which
6249 # leaves the symtab in the original file only. There's no way to get
6250 # objcopy or strip to remove the symbol table without also removing the
6251 # debugging sections, so this is as close as we can get.
6252 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
6253 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
6254 verbose "result is $result"
6255 verbose "output is $output"
6259 file delete "${debug_file}"
6260 file rename "${debug_file}-tmp" "${debug_file}"
6263 # Link the two previous output files together, adding the .gnu_debuglink
6264 # section to the stripped_file, containing a pointer to the debug_file,
6265 # save the new file in dest.
6266 # This will be the regular executable filename, in the usual location.
6267 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
6268 verbose "result is $result"
6269 verbose "output is $output"
6274 # Workaround PR binutils/10802:
6275 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
6276 set perm [file attributes ${stripped_file} -permissions]
6277 file attributes ${dest} -permissions $perm
6282 # Test the output of GDB_COMMAND matches the pattern obtained
6283 # by concatenating all elements of EXPECTED_LINES. This makes
6284 # it possible to split otherwise very long string into pieces.
6285 # If third argument TESTNAME is not empty, it's used as the name of the
6286 # test to be printed on pass/fail.
6287 proc help_test_raw { gdb_command expected_lines {testname {}} } {
6288 set expected_output [join $expected_lines ""]
6289 if {$testname != {}} {
6290 gdb_test "${gdb_command}" "${expected_output}" $testname
6294 gdb_test "${gdb_command}" "${expected_output}"
6297 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
6298 set help_list_trailer {
6299 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
6300 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
6301 "Command name abbreviations are allowed if unambiguous\."
6304 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
6305 # are regular expressions that should match the beginning of output,
6306 # before the list of commands in that class.
6307 # LIST_OF_COMMANDS are regular expressions that should match the
6308 # list of commands in that class. If empty, the command list will be
6309 # matched automatically. The presence of standard epilogue will be tested
6311 # If last argument TESTNAME is not empty, it's used as the name of the
6312 # test to be printed on pass/fail.
6313 # Notice that the '[' and ']' characters don't need to be escaped for strings
6314 # wrapped in {} braces.
6315 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
6316 global help_list_trailer
6317 if {[llength $list_of_commands]>0} {
6318 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
6319 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
6320 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
6322 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
6325 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
6327 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
6328 $l_stock_body $help_list_trailer]
6330 help_test_raw "help ${command_class}" $l_entire_body $testname
6333 # Like test_class_help but specialised to test "help user-defined".
6334 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
6335 test_class_help "user-defined" {
6336 "User-defined commands\.[\r\n]+"
6337 "The commands in this class are those defined by the user\.[\r\n]+"
6338 "Use the \"define\" command to define a command\.[\r\n]+"
6339 } $list_of_commands $testname
6343 # COMMAND_LIST should have either one element -- command to test, or
6344 # two elements -- abbreviated command to test, and full command the first
6345 # element is abbreviation of.
6346 # The command must be a prefix command. EXPECTED_INITIAL_LINES
6347 # are regular expressions that should match the beginning of output,
6348 # before the list of subcommands. The presence of
6349 # subcommand list and standard epilogue will be tested automatically.
6350 proc test_prefix_command_help { command_list expected_initial_lines args } {
6351 global help_list_trailer
6352 set command [lindex $command_list 0]
6353 if {[llength $command_list]>1} {
6354 set full_command [lindex $command_list 1]
6356 set full_command $command
6358 # Use 'list' and not just {} because we want variables to
6359 # be expanded in this list.
6360 set l_stock_body [list\
6361 "List of $full_command subcommands\:.*\[\r\n\]+"\
6362 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
6363 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
6364 if {[llength $args]>0} {
6365 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
6367 help_test_raw "help ${command}" $l_entire_body
6371 # Build executable named EXECUTABLE from specifications that allow
6372 # different options to be passed to different sub-compilations.
6373 # TESTNAME is the name of the test; this is passed to 'untested' if
6375 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
6376 # contains the option "pthreads", then gdb_compile_pthreads is used.
6377 # ARGS is a flat list of source specifications, of the form:
6378 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
6379 # Each SOURCE is compiled to an object file using its OPTIONS,
6380 # using gdb_compile.
6381 # Returns 0 on success, -1 on failure.
6382 proc build_executable_from_specs {testname executable options args} {
6386 set binfile [standard_output_file $executable]
6389 if { [lsearch -exact $options "c++"] >= 0 } {
6390 set info_options "c++"
6392 if [get_compiler_info ${info_options}] {
6396 set func gdb_compile
6397 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads|openmp)$}]
6398 if {$func_index != -1} {
6399 set func "${func}_[lindex $options $func_index]"
6402 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
6403 # parameter. They also requires $sources while gdb_compile and
6404 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
6405 if [string match gdb_compile_shlib* $func] {
6407 foreach {s local_options} $args {
6408 if { [regexp "^/" "$s"] } then {
6409 lappend sources_path "$s"
6411 lappend sources_path "$srcdir/$subdir/$s"
6414 set ret [$func $sources_path "${binfile}" $options]
6415 } elseif {[lsearch -exact $options rust] != -1} {
6417 foreach {s local_options} $args {
6418 if { [regexp "^/" "$s"] } then {
6419 lappend sources_path "$s"
6421 lappend sources_path "$srcdir/$subdir/$s"
6424 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
6428 foreach {s local_options} $args {
6429 if { ! [regexp "^/" "$s"] } then {
6430 set s "$srcdir/$subdir/$s"
6432 if { [$func "${s}" "${binfile}${i}.o" object $local_options] != "" } {
6436 lappend objects "${binfile}${i}.o"
6439 set ret [$func $objects "${binfile}" executable $options]
6449 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
6450 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
6451 # to pass to untested, if something is wrong. OPTIONS are passed
6452 # to gdb_compile directly.
6453 proc build_executable { testname executable {sources ""} {options {debug}} } {
6454 if {[llength $sources]==0} {
6455 set sources ${executable}.c
6458 set arglist [list $testname $executable $options]
6459 foreach source $sources {
6460 lappend arglist $source $options
6463 return [eval build_executable_from_specs $arglist]
6466 # Starts fresh GDB binary and loads an optional executable into GDB.
6467 # Usage: clean_restart [executable]
6468 # EXECUTABLE is the basename of the binary.
6469 # Return -1 if starting gdb or loading the executable failed.
6471 proc clean_restart { args } {
6477 if { [llength $args] > 1 } {
6478 error "bad number of args: [llength $args]"
6483 # This is a clean restart, so reset error and warning count.
6488 # if { [gdb_start] == -1 } {
6491 # but gdb_start is a ${tool}_start proc, which doesn't have a defined
6492 # return value. So instead, we test for errcnt.
6494 if { $errcnt > 0 } {
6498 gdb_reinitialize_dir $srcdir/$subdir
6500 if { [llength $args] >= 1 } {
6501 set executable [lindex $args 0]
6502 set binfile [standard_output_file ${executable}]
6503 return [gdb_load ${binfile}]
6509 # Prepares for testing by calling build_executable_full, then
6511 # TESTNAME is the name of the test.
6512 # Each element in ARGS is a list of the form
6513 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
6514 # These are passed to build_executable_from_specs, which see.
6515 # The last EXECUTABLE is passed to clean_restart.
6516 # Returns 0 on success, non-zero on failure.
6517 proc prepare_for_testing_full {testname args} {
6518 foreach spec $args {
6519 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
6522 set executable [lindex $spec 0]
6524 clean_restart $executable
6528 # Prepares for testing, by calling build_executable, and then clean_restart.
6529 # Please refer to build_executable for parameter description.
6530 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
6532 if {[build_executable $testname $executable $sources $options] == -1} {
6535 clean_restart $executable
6540 # Retrieve the value of EXP in the inferior, represented in format
6541 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
6542 # print fails. TEST is the test message to use. It can be omitted,
6543 # in which case a test message is built from EXP.
6545 proc get_valueof { fmt exp default {test ""} } {
6549 set test "get valueof \"${exp}\""
6553 gdb_test_multiple "print${fmt} ${exp}" "$test" {
6554 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
6555 set val $expect_out(1,string)
6559 fail "$test (timeout)"
6565 # Retrieve the value of local var EXP in the inferior. DEFAULT is used as
6566 # fallback if print fails. TEST is the test message to use. It can be
6567 # omitted, in which case a test message is built from EXP.
6569 proc get_local_valueof { exp default {test ""} } {
6573 set test "get local valueof \"${exp}\""
6577 gdb_test_multiple "info locals ${exp}" "$test" {
6578 -re "$exp = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
6579 set val $expect_out(1,string)
6583 fail "$test (timeout)"
6589 # Retrieve the value of EXP in the inferior, as a signed decimal value
6590 # (using "print /d"). DEFAULT is used as fallback if print fails.
6591 # TEST is the test message to use. It can be omitted, in which case
6592 # a test message is built from EXP.
6594 proc get_integer_valueof { exp default {test ""} } {
6598 set test "get integer valueof \"${exp}\""
6602 gdb_test_multiple "print /d ${exp}" "$test" {
6603 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
6604 set val $expect_out(1,string)
6608 fail "$test (timeout)"
6614 # Retrieve the value of EXP in the inferior, as an hexadecimal value
6615 # (using "print /x"). DEFAULT is used as fallback if print fails.
6616 # TEST is the test message to use. It can be omitted, in which case
6617 # a test message is built from EXP.
6619 proc get_hexadecimal_valueof { exp default {test ""} } {
6623 set test "get hexadecimal valueof \"${exp}\""
6627 gdb_test_multiple "print /x ${exp}" $test {
6628 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
6629 set val $expect_out(1,string)
6636 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
6637 # is used as fallback if print fails. TEST is the test message to use.
6638 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
6640 proc get_sizeof { type default {test ""} } {
6641 return [get_integer_valueof "sizeof (${type})" $default $test]
6644 proc get_target_charset { } {
6647 gdb_test_multiple "show target-charset" "" {
6648 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
6649 return $expect_out(1,string)
6651 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
6652 return $expect_out(1,string)
6656 # Pick a reasonable default.
6657 warning "Unable to read target-charset."
6661 # Get the address of VAR.
6663 proc get_var_address { var } {
6664 global gdb_prompt hex
6666 # Match output like:
6668 # $5 = (int (*)()) 0
6669 # $6 = (int (*)()) 0x24 <function_bar>
6671 gdb_test_multiple "print &${var}" "get address of ${var}" {
6672 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
6674 pass "get address of ${var}"
6675 if { $expect_out(1,string) == "0" } {
6678 return $expect_out(1,string)
6685 # Return the frame number for the currently selected frame
6686 proc get_current_frame_number {{test_name ""}} {
6689 if { $test_name == "" } {
6690 set test_name "get current frame number"
6693 gdb_test_multiple "frame" $test_name {
6694 -re "#(\[0-9\]+) .*$gdb_prompt $" {
6695 set frame_num $expect_out(1,string)
6701 # Get the current value for remotetimeout and return it.
6702 proc get_remotetimeout { } {
6706 gdb_test_multiple "show remotetimeout" "" {
6707 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
6708 return $expect_out(1,string)
6712 # Pick the default that gdb uses
6713 warning "Unable to read remotetimeout"
6717 # Set the remotetimeout to the specified timeout. Nothing is returned.
6718 proc set_remotetimeout { timeout } {
6721 gdb_test_multiple "set remotetimeout $timeout" "" {
6722 -re "$gdb_prompt $" {
6723 verbose "Set remotetimeout to $timeout\n"
6728 # Get the target's current endianness and return it.
6729 proc get_endianness { } {
6732 gdb_test_multiple "show endian" "determine endianness" {
6733 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
6735 return $expect_out(1,string)
6741 # ROOT and FULL are file names. Returns the relative path from ROOT
6742 # to FULL. Note that FULL must be in a subdirectory of ROOT.
6743 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
6746 proc relative_filename {root full} {
6747 set root_split [file split $root]
6748 set full_split [file split $full]
6750 set len [llength $root_split]
6752 if {[eval file join $root_split]
6753 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
6754 error "$full not a subdir of $root"
6757 return [eval file join [lrange $full_split $len end]]
6760 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
6761 if {[info exists GDB_PARALLEL]} {
6762 if {[is_remote host]} {
6766 [make_gdb_parallel_path outputs] \
6767 [make_gdb_parallel_path temp] \
6768 [make_gdb_parallel_path cache]
6772 proc core_find {binfile {deletefiles {}} {arg ""}} {
6773 global objdir subdir
6775 set destcore "$binfile.core"
6776 file delete $destcore
6778 # Create a core file named "$destcore" rather than just "core", to
6779 # avoid problems with sys admin types that like to regularly prune all
6780 # files named "core" from the system.
6782 # Arbitrarily try setting the core size limit to "unlimited" since
6783 # this does not hurt on systems where the command does not work and
6784 # allows us to generate a core on systems where it does.
6786 # Some systems append "core" to the name of the program; others append
6787 # the name of the program to "core"; still others (like Linux, as of
6788 # May 2003) create cores named "core.PID". In the latter case, we
6789 # could have many core files lying around, and it may be difficult to
6790 # tell which one is ours, so let's run the program in a subdirectory.
6792 set coredir [standard_output_file coredir.[getpid]]
6794 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6795 # remote_exec host "${binfile}"
6796 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6797 if [remote_file build exists $i] {
6798 remote_exec build "mv $i $destcore"
6802 # Check for "core.PID".
6803 if { $found == 0 } {
6804 set names [glob -nocomplain -directory $coredir core.*]
6805 if {[llength $names] == 1} {
6806 set corefile [file join $coredir [lindex $names 0]]
6807 remote_exec build "mv $corefile $destcore"
6811 if { $found == 0 } {
6812 # The braindamaged HPUX shell quits after the ulimit -c above
6813 # without executing ${binfile}. So we try again without the
6814 # ulimit here if we didn't find a core file above.
6815 # Oh, I should mention that any "braindamaged" non-Unix system has
6816 # the same problem. I like the cd bit too, it's really neat'n stuff.
6817 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6818 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6819 if [remote_file build exists $i] {
6820 remote_exec build "mv $i $destcore"
6826 # Try to clean up after ourselves.
6827 foreach deletefile $deletefiles {
6828 remote_file build delete [file join $coredir $deletefile]
6830 remote_exec build "rmdir $coredir"
6832 if { $found == 0 } {
6833 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6839 # gdb_target_symbol_prefix compiles a test program and then examines
6840 # the output from objdump to determine the prefix (such as underscore)
6841 # for linker symbol prefixes.
6843 gdb_caching_proc gdb_target_symbol_prefix {
6844 # Compile a simple test program...
6845 set src { int main() { return 0; } }
6846 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6852 set objdump_program [gdb_find_objdump]
6853 set result [catch "exec $objdump_program --syms $obj" output]
6856 && ![regexp -lineanchor \
6857 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6858 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6866 # Return 1 if target supports scheduler locking, otherwise return 0.
6868 gdb_caching_proc target_supports_scheduler_locking {
6871 set me "gdb_target_supports_scheduler_locking"
6873 set src { int main() { return 0; } }
6874 if {![gdb_simple_compile $me $src executable]} {
6883 set supports_schedule_locking -1
6884 set current_schedule_locking_mode ""
6886 set test "reading current scheduler-locking mode"
6887 gdb_test_multiple "show scheduler-locking" $test {
6888 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6889 set current_schedule_locking_mode $expect_out(1,string)
6891 -re "$gdb_prompt $" {
6892 set supports_schedule_locking 0
6895 set supports_schedule_locking 0
6899 if { $supports_schedule_locking == -1 } {
6900 set test "checking for scheduler-locking support"
6901 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6902 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6903 set supports_schedule_locking 0
6905 -re "$gdb_prompt $" {
6906 set supports_schedule_locking 1
6909 set supports_schedule_locking 0
6914 if { $supports_schedule_locking == -1 } {
6915 set supports_schedule_locking 0
6919 remote_file build delete $obj
6920 verbose "$me: returning $supports_schedule_locking" 2
6921 return $supports_schedule_locking
6924 # Return 1 if compiler supports use of nested functions. Otherwise,
6927 gdb_caching_proc support_nested_function_tests {
6928 # Compile a test program containing a nested function
6929 return [gdb_can_simple_compile nested_func {
6939 # gdb_target_symbol returns the provided symbol with the correct prefix
6940 # prepended. (See gdb_target_symbol_prefix, above.)
6942 proc gdb_target_symbol { symbol } {
6943 set prefix [gdb_target_symbol_prefix]
6944 return "${prefix}${symbol}"
6947 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6948 # added to gdb_compile options to define the C-preprocessor macro
6949 # SYMBOL_PREFIX with a value that can be prepended to symbols
6950 # for targets which require a prefix, such as underscore.
6952 # This version (_asm) defines the prefix without double quotes
6953 # surrounding the prefix. It is used to define the macro
6954 # SYMBOL_PREFIX for assembly language files. Another version, below,
6955 # is used for symbols in inline assembler in C/C++ files.
6957 # The lack of quotes in this version (_asm) makes it possible to
6958 # define supporting macros in the .S file. (The version which
6959 # uses quotes for the prefix won't work for such files since it's
6960 # impossible to define a quote-stripping macro in C.)
6962 # It's possible to use this version (_asm) for C/C++ source files too,
6963 # but a string is usually required in such files; providing a version
6964 # (no _asm) which encloses the prefix with double quotes makes it
6965 # somewhat easier to define the supporting macros in the test case.
6967 proc gdb_target_symbol_prefix_flags_asm {} {
6968 set prefix [gdb_target_symbol_prefix]
6969 if {$prefix ne ""} {
6970 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6976 # gdb_target_symbol_prefix_flags returns the same string as
6977 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6978 # enclosed in double quotes if there is a prefix.
6980 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6981 # extended discussion.
6983 proc gdb_target_symbol_prefix_flags {} {
6984 set prefix [gdb_target_symbol_prefix]
6985 if {$prefix ne ""} {
6986 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6992 # A wrapper for 'remote_exec host' that passes or fails a test.
6993 # Returns 0 if all went well, nonzero on failure.
6994 # TEST is the name of the test, other arguments are as for remote_exec.
6996 proc run_on_host { test program args } {
6997 verbose -log "run_on_host: $program $args"
6998 # remote_exec doesn't work properly if the output is set but the
6999 # input is the empty string -- so replace an empty input with
7001 if {[llength $args] > 1 && [lindex $args 1] == ""} {
7002 set args [lreplace $args 1 1 "/dev/null"]
7004 set result [eval remote_exec host [list $program] $args]
7005 verbose "result is $result"
7006 set status [lindex $result 0]
7007 set output [lindex $result 1]
7012 verbose -log "run_on_host failed: $output"
7013 if { $output == "spawn failed" } {
7022 # Return non-zero if "board_info debug_flags" mentions Fission.
7023 # http://gcc.gnu.org/wiki/DebugFission
7024 # Fission doesn't support everything yet.
7025 # This supports working around bug 15954.
7027 proc using_fission { } {
7028 set debug_flags [board_info [target_info name] debug_flags]
7029 return [regexp -- "-gsplit-dwarf" $debug_flags]
7032 # Search the caller's ARGS list and set variables according to the list of
7033 # valid options described by ARGSET.
7035 # The first member of each one- or two-element list in ARGSET defines the
7036 # name of a variable that will be added to the caller's scope.
7038 # If only one element is given to describe an option, it the value is
7039 # 0 if the option is not present in (the caller's) ARGS or 1 if
7042 # If two elements are given, the second element is the default value of
7043 # the variable. This is then overwritten if the option exists in ARGS.
7045 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
7046 # any optional components.
7049 # proc myproc {foo args} {
7050 # parse_args {{bar} {baz "abc"} {qux}}
7053 # myproc ABC -bar -baz DEF peanut butter
7054 # will define the following variables in myproc:
7055 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
7056 # args will be the list {peanut butter}
7058 proc parse_args { argset } {
7061 foreach argument $argset {
7062 if {[llength $argument] == 1} {
7063 # No default specified, so we assume that we should set
7064 # the value to 1 if the arg is present and 0 if it's not.
7065 # It is assumed that no value is given with the argument.
7066 set result [lsearch -exact $args "-$argument"]
7067 if {$result != -1} then {
7068 uplevel 1 [list set $argument 1]
7069 set args [lreplace $args $result $result]
7071 uplevel 1 [list set $argument 0]
7073 } elseif {[llength $argument] == 2} {
7074 # There are two items in the argument. The second is a
7075 # default value to use if the item is not present.
7076 # Otherwise, the variable is set to whatever is provided
7077 # after the item in the args.
7078 set arg [lindex $argument 0]
7079 set result [lsearch -exact $args "-[lindex $arg 0]"]
7080 if {$result != -1} then {
7081 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
7082 set args [lreplace $args $result [expr $result+1]]
7084 uplevel 1 [list set $arg [lindex $argument 1]]
7087 error "Badly formatted argument \"$argument\" in argument set"
7091 # The remaining args should be checked to see that they match the
7092 # number of items expected to be passed into the procedure...
7095 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
7096 # return that string.
7098 proc capture_command_output { command prefix } {
7102 set output_string ""
7103 gdb_test_multiple "$command" "capture_command_output for $command" {
7104 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
7105 set output_string $expect_out(1,string)
7108 return $output_string
7111 # A convenience function that joins all the arguments together, with a
7112 # regexp that matches exactly one end of line in between each argument.
7113 # This function is ideal to write the expected output of a GDB command
7114 # that generates more than a couple of lines, as this allows us to write
7115 # each line as a separate string, which is easier to read by a human
7118 proc multi_line { args } {
7119 return [join $args "\r\n"]
7122 # Similar to the above, but while multi_line is meant to be used to
7123 # match GDB output, this one is meant to be used to build strings to
7124 # send as GDB input.
7126 proc multi_line_input { args } {
7127 return [join $args "\n"]
7130 # Return the version of the DejaGnu framework.
7132 # The return value is a list containing the major, minor and patch version
7133 # numbers. If the version does not contain a minor or patch number, they will
7134 # be set to 0. For example:
7140 proc dejagnu_version { } {
7141 # The frame_version variable is defined by DejaGnu, in runtest.exp.
7142 global frame_version
7144 verbose -log "DejaGnu version: $frame_version"
7145 verbose -log "Expect version: [exp_version]"
7146 verbose -log "Tcl version: [info tclversion]"
7148 set dg_ver [split $frame_version .]
7150 while { [llength $dg_ver] < 3 } {
7157 # Define user-defined command COMMAND using the COMMAND_LIST as the
7158 # command's definition. The terminating "end" is added automatically.
7160 proc gdb_define_cmd {command command_list} {
7163 set input [multi_line_input {*}$command_list "end"]
7164 set test "define $command"
7166 gdb_test_multiple "define $command" $test {
7168 gdb_test_multiple $input $test {
7169 -re "\r\n$gdb_prompt " {
7176 # Override the 'cd' builtin with a version that ensures that the
7177 # log file keeps pointing at the same file. We need this because
7178 # unfortunately the path to the log file is recorded using an
7179 # relative path name, and, we sometimes need to close/reopen the log
7180 # after changing the current directory. See get_compiler_info.
7182 rename cd builtin_cd
7186 # Get the existing log file flags.
7187 set log_file_info [log_file -info]
7189 # Split the flags into args and file name.
7190 set log_file_flags ""
7191 set log_file_file ""
7192 foreach arg [ split "$log_file_info" " "] {
7193 if [string match "-*" $arg] {
7194 lappend log_file_flags $arg
7196 lappend log_file_file $arg
7200 # If there was an existing file, ensure it is an absolute path, and then
7202 if { $log_file_file != "" } {
7203 set log_file_file [file normalize $log_file_file]
7205 log_file $log_file_flags "$log_file_file"
7208 # Call the builtin version of cd.
7212 # Return a list of all languages supported by GDB, suitable for use in
7213 # 'set language NAME'. This doesn't include either the 'local' or
7215 proc gdb_supported_languages {} {
7216 return [list c objective-c c++ d go fortran modula-2 asm pascal \
7217 opencl rust minimal ada]
7220 # Check if debugging is enabled for gdb.
7222 proc gdb_debug_enabled { } {
7225 # If not already read, get the debug setting from environment or board setting.
7226 if {![info exists gdbdebug]} {
7228 if [info exists env(GDB_DEBUG)] {
7229 set gdbdebug $env(GDB_DEBUG)
7230 } elseif [target_info exists gdb,debug] {
7231 set gdbdebug [target_info gdb,debug]
7237 # Ensure it not empty.
7238 return [expr { $gdbdebug != "" }]
7241 # Turn on debugging if enabled, or reset if already on.
7243 proc gdb_debug_init { } {
7247 if ![gdb_debug_enabled] {
7251 # First ensure logging is off.
7252 send_gdb "set logging off\n"
7254 set debugfile [standard_output_file gdb.debug]
7255 send_gdb "set logging file $debugfile\n"
7257 send_gdb "set logging debugredirect\n"
7260 foreach entry [split $gdbdebug ,] {
7261 send_gdb "set debug $entry 1\n"
7264 # Now that everything is set, enable logging.
7265 send_gdb "set logging on\n"
7267 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
7268 timeout { warning "Couldn't set logging file" }
7272 # Check if debugging is enabled for gdbserver.
7274 proc gdbserver_debug_enabled { } {
7275 # Always disabled for GDB only setups.
7279 # Open the file for logging gdb input
7281 proc gdb_stdin_log_init { } {
7282 gdb_persistent_global in_file
7284 if {[info exists in_file]} {
7285 # Close existing file.
7286 catch "close $in_file"
7289 set logfile [standard_output_file_with_gdb_instance gdb.in]
7290 set in_file [open $logfile w]
7293 # Write to the file for logging gdb input.
7294 # TYPE can be one of the following:
7295 # "standard" : Default. Standard message written to the log
7296 # "answer" : Answer to a question (eg "Y"). Not written the log.
7297 # "optional" : Optional message. Not written to the log.
7299 proc gdb_stdin_log_write { message {type standard} } {
7302 if {![info exists in_file]} {
7306 # Check message types.
7307 switch -regexp -- $type {
7316 # Write to the log and make sure the output is there, even in case
7318 puts -nonewline $in_file "$message"
7322 # Write the command line used to invocate gdb to the cmd file.
7324 proc gdb_write_cmd_file { cmdline } {
7325 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
7326 set cmd_file [open $logfile w]
7327 puts $cmd_file $cmdline
7328 catch "close $cmd_file"
7331 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
7334 proc cmp_file_string { file str msg } {
7335 if { ![file exists $file]} {
7340 set caught_error [catch {
7341 set fp [open "$file" r]
7342 set file_contents [read $fp]
7345 if { $caught_error } then {
7346 error "$error_message"
7351 if { $file_contents == $str } {
7358 # Does the compiler support CTF debug output using '-gt' compiler
7359 # flag? If not then we should skip these tests. We should also
7360 # skip them if libctf was explicitly disabled.
7362 gdb_caching_proc skip_ctf_tests {
7363 global enable_libctf
7365 if {$enable_libctf eq "no"} {
7369 return ![gdb_can_simple_compile ctfdebug {
7373 } executable "additional_flags=-gt"]
7376 # Return 1 if compiler supports -gstatement-frontiers. Otherwise,
7379 gdb_caching_proc supports_statement_frontiers {
7380 return [gdb_can_simple_compile supports_statement_frontiers {
7384 } executable "additional_flags=-gstatement-frontiers"]
7387 # Return 1 if compiler supports -mmpx -fcheck-pointer-bounds. Otherwise,
7390 gdb_caching_proc supports_mpx_check_pointer_bounds {
7391 set flags "additional_flags=-mmpx additional_flags=-fcheck-pointer-bounds"
7392 return [gdb_can_simple_compile supports_mpx_check_pointer_bounds {
7396 } executable $flags]
7399 # Return 1 if compiler supports -fcf-protection=. Otherwise,
7402 gdb_caching_proc supports_fcf_protection {
7403 return [gdb_can_simple_compile supports_fcf_protection {
7407 } executable "additional_flags=-fcf-protection=full"]
7410 # Return 1 if symbols were read in using -readnow. Otherwise, return 0.
7412 proc readnow { args } {
7413 if { [llength $args] == 1 } {
7414 set re [lindex $args 0]
7418 set cmd "maint print objfiles $re"
7419 gdb_test_multiple $cmd "" {
7420 -re -wrap "\r\n.gdb_index: faked for \"readnow\"\r\n.*" {
7431 # Return 1 if partial symbols are available. Otherwise, return 0.
7433 proc psymtabs_p { } {
7436 set cmd "maint info psymtab"
7437 gdb_test_multiple $cmd "" {
7438 -re "$cmd\r\n$gdb_prompt $" {
7449 # Verify that partial symtab expansion for $filename has state $readin.
7451 proc verify_psymtab_expanded { filename readin } {
7454 set cmd "maint info psymtab"
7455 set test "$cmd: $filename: $readin"
7456 set re [multi_line \
7457 " \{ psymtab \[^\r\n\]*$filename\[^\r\n\]*" \
7461 gdb_test_multiple $cmd $test {
7462 -re "$cmd\r\n$gdb_prompt $" {
7463 unsupported $gdb_test_name
7471 # Add a .gdb_index section to PROGRAM.
7472 # PROGRAM is assumed to be the output of standard_output_file.
7473 # Returns the 0 if there is a failure, otherwise 1.
7475 proc add_gdb_index { program } {
7476 global srcdir GDB env BUILD_DATA_DIRECTORY
7477 set contrib_dir "$srcdir/../contrib"
7478 set env(GDB) "$GDB --data-directory=$BUILD_DATA_DIRECTORY"
7479 set result [catch "exec $contrib_dir/gdb-add-index.sh $program" output]
7480 if { $result != 0 } {
7481 verbose -log "result is $result"
7482 verbose -log "output is $output"
7489 # Add a .gdb_index section to PROGRAM, unless it alread has an index
7490 # (.gdb_index/.debug_names). Gdb doesn't support building an index from a
7491 # program already using one. Return 1 if a .gdb_index was added, return 0
7492 # if it already contained an index, and -1 if an error occurred.
7494 proc ensure_gdb_index { binfile } {
7495 set testfile [file tail $binfile]
7496 set test "check if index present"
7497 gdb_test_multiple "mt print objfiles ${testfile}" $test {
7498 -re -wrap "gdb_index.*" {
7501 -re -wrap "debug_names.*" {
7504 -re -wrap "Psymtabs.*" {
7505 if { [add_gdb_index $binfile] != "1" } {
7514 # Return 1 if executable contains .debug_types section. Otherwise, return 0.
7516 proc debug_types { } {
7519 set cmd "maint info sections"
7520 gdb_test_multiple $cmd "" {
7521 -re -wrap "at $hex: .debug_types.*" {
7532 # Return the addresses in the line table for FILE for which is_stmt is true.
7534 proc is_stmt_addresses { file } {
7540 gdb_test_multiple "maint info line-table $file" "" {
7541 -re "\r\n$decimal\[ \t\]+$decimal\[ \t\]+($hex)\[ \t\]+Y\[^\r\n\]*" {
7542 lappend is_stmt $expect_out(1,string)
7552 # Return 1 if hex number VAL is an element of HEXLIST.
7554 proc hex_in_list { val hexlist } {
7555 # Normalize val by removing 0x prefix, and leading zeros.
7556 set val [regsub ^0x $val ""]
7557 set val [regsub ^0+ $val "0"]
7560 set index [lsearch -regexp $hexlist $re]
7561 return [expr $index != -1]
7564 # Override proc NAME to proc OVERRIDE for the duration of the execution of
7567 proc with_override { name override body } {
7568 # Implementation note: It's possible to implement the override using
7569 # rename, like this:
7570 # rename $name save_$name
7571 # rename $override $name
7572 # set code [catch {uplevel 1 $body} result]
7573 # rename $name $override
7574 # rename save_$name $name
7575 # but there are two issues here:
7576 # - the save_$name might clash with an existing proc
7577 # - the override is no longer available under its original name during
7579 # So, we use this more elaborate but cleaner mechanism.
7581 # Save the old proc.
7582 set old_args [info args $name]
7583 set old_body [info body $name]
7585 # Install the override.
7586 set new_args [info args $override]
7587 set new_body [info body $override]
7588 eval proc $name {$new_args} {$new_body}
7591 set code [catch {uplevel 1 $body} result]
7594 eval proc $name {$old_args} {$old_body}
7596 # Return as appropriate.
7598 global errorInfo errorCode
7599 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
7600 } elseif { $code > 1 } {
7601 return -code $code $result
7607 # Setup tuiterm.exp environment. To be used in test-cases instead of
7608 # "load_lib tuiterm.exp". Calls initialization function and schedules
7609 # finalization function.
7610 proc tuiterm_env { } {
7611 load_lib tuiterm.exp
7613 # Do initialization.
7616 # Schedule finalization.
7617 global gdb_finish_hooks
7618 lappend gdb_finish_hooks tuiterm_env_finish
7621 # Dejagnu has a version of note, but usage is not allowed outside of dejagnu.
7622 # Define a local version.
7623 proc gdb_note { message } {
7624 verbose -- "NOTE: $message" 0
7627 # Return 1 if compiler supports -fuse-ld=gold, otherwise return 0.
7628 gdb_caching_proc have_fuse_ld_gold {
7629 set me "have_fuse_ld_gold"
7630 set flags "additional_flags=-fuse-ld=gold"
7631 set src { int main() { return 0; } }
7632 return [gdb_simple_compile $me $src executable $flags]
7635 # Always load compatibility stuff.