1 # Copyright 1992-2019 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
89 # absolute path ie. /foo/
90 set fullname_syntax_POSIX {/[^\n]*/}
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
92 # UNC path ie. \\D\foo\
93 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
96 # ie. \foo\, but don't match \\.*\
97 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
99 # ie. a:\foo\ && a:foo\
100 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
103 # d:foo and \abc should be considered valid as an absolute path.
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
112 if ![info exists env(EXEEXT)] {
115 set EXEEXT $env(EXEEXT)
120 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
122 # A regular expression that matches a value history number.
124 set valnum_re "\\\$$decimal"
126 ### Only procedures should come after this point.
129 # gdb_version -- extract and print the version number of GDB
131 proc default_gdb_version {} {
133 global INTERNAL_GDBFLAGS GDBFLAGS
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
144 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
145 if ![is_remote host] {
146 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
148 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
152 proc gdb_version { } {
153 return [default_gdb_version]
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
170 send_gdb "y\n" answer
173 -re "Discard symbol table from .*y or n.*$" {
174 send_gdb "y\n" answer
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
204 send_gdb "y\n" answer
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # The second pattern below matches up to the first newline *only*.
246 # Using ``.*$'' could swallow up output that we attempt to match
249 # N.B. This function does not wait for gdb to return to the prompt,
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
256 send_gdb "$command\n"
258 -re "$gdb_prompt $" { }
260 perror "gdb_init_command for target failed"
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
271 send_gdb "continue\n"
273 -re "Continu\[^\r\n\]*\[\r\n\]" {}
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
284 send_gdb "jump *$start\n"
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
290 if [expr $start_attempt > 3] {
291 perror "Jump to start() failed (retry count exceeded)"
294 set start_attempt [expr $start_attempt + 1]
296 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
299 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
300 perror "Can't find start symbol to run in gdb_run"
303 -re "No symbol \"start\" in current.*$gdb_prompt $" {
304 send_gdb "jump *_start\n"
306 -re "No symbol.*context.*$gdb_prompt $" {
309 -re "Line.* Jump anyway.*y or n. $" {
310 send_gdb "y\n" answer
312 -re "The program is not being run.*$gdb_prompt $" {
313 if { [gdb_reload] != 0 } {
316 send_gdb "jump *$start\n"
319 perror "Jump to start() failed (timeout)"
327 if [target_info exists gdb,do_reload_on_run] {
328 if { [gdb_reload] != 0 } {
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
337 -re "The program .* has been started already.*y or n. $" {
338 send_gdb "y\n" answer
341 -notransfer -re "Starting program: \[^\r\n\]*" {}
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
348 # Generic start command. Return 0 if we could start the program, -1
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
354 proc gdb_start_cmd {args} {
355 global gdb_prompt use_gdb_stub
357 foreach command [gdb_init_commands] {
358 send_gdb "$command\n"
360 -re "$gdb_prompt $" { }
362 perror "gdb_init_command for target failed"
372 send_gdb "start $args\n"
373 # Use -notransfer here so that test cases (like chng-sym.exp)
374 # may test for additional start-up messages.
376 -re "The program .* has been started already.*y or n. $" {
377 send_gdb "y\n" answer
380 -notransfer -re "Starting program: \[^\r\n\]*" {
387 # Generic starti command. Return 0 if we could start the program, -1
390 # N.B. This function does not wait for gdb to return to the prompt,
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
397 send_gdb "$command\n"
399 -re "$gdb_prompt $" { }
401 perror "gdb_init_command for target failed"
411 send_gdb "starti $args\n"
413 -re "The program .* has been started already.*y or n. $" {
414 send_gdb "y\n" answer
417 -re "Starting program: \[^\r\n\]*" {
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
429 # Note: The handling of message vs no-message is messed up, but it's based
430 # on historical usage. By default this function does not print passes,
432 # no-message: turns off printing of fails (and passes, but they're already off)
433 # message: turns on printing of passes (and fails, but they're already on)
435 proc gdb_breakpoint { function args } {
439 set pending_response n
440 if {[lsearch -exact $args allow-pending] != -1} {
441 set pending_response y
444 set break_command "break"
445 set break_message "Breakpoint"
446 if {[lsearch -exact $args temporary] != -1} {
447 set break_command "tbreak"
448 set break_message "Temporary breakpoint"
451 if {[lsearch -exact $args qualified] != -1} {
452 append break_command " -qualified"
457 set no_message_loc [lsearch -exact $args no-message]
458 set message_loc [lsearch -exact $args message]
459 # The last one to appear in args wins.
460 if { $no_message_loc > $message_loc } {
462 } elseif { $message_loc > $no_message_loc } {
466 set test_name "setting breakpoint at $function"
468 send_gdb "$break_command $function\n"
469 # The first two regexps are what we get with -g, the third is without -g.
471 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
474 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
475 if {$pending_response == "n"} {
482 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
483 send_gdb "$pending_response\n"
486 -re "A problem internal to GDB has been detected" {
488 fail "$test_name (GDB internal error)"
490 gdb_internal_error_resync
493 -re "$gdb_prompt $" {
501 fail "$test_name (eof)"
507 fail "$test_name (timeout)"
518 # Set breakpoint at function and run gdb until it breaks there.
519 # Since this is the only breakpoint that will be set, if it stops
520 # at a breakpoint, we will assume it is the one we want. We can't
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
529 # no-message: turns off printing of fails (and passes, but they're already off)
530 # message: turns on printing of passes (and fails, but they're already on)
532 proc runto { function args } {
538 # Default to "no-message".
539 set args "no-message $args"
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
548 } elseif { $message_loc > $no_message_loc } {
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
557 # elements, and we don't want Tcl to move the remaining elements after
558 # the first to $args. That is why $function is wrapped in {}.
559 if ![eval gdb_breakpoint {$function} $args] {
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
568 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
574 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
580 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
582 unsupported "non-stop mode not supported"
586 -re ".*A problem internal to GDB has been detected" {
588 fail "$test_name (GDB internal error)"
590 gdb_internal_error_resync
593 -re "$gdb_prompt $" {
601 fail "$test_name (eof)"
607 fail "$test_name (timeout)"
618 # Ask gdb to run until we hit a breakpoint at main.
620 # N.B. This function deletes all existing breakpoints.
621 # If you don't want that, use gdb_start_cmd.
623 proc runto_main { } {
624 return [runto main no-message]
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
634 set full_name "continue to breakpoint: $name"
636 gdb_test_multiple "continue" $full_name {
637 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
644 # gdb_internal_error_resync:
646 # Answer the questions GDB asks after it reports an internal error
647 # until we get back to a GDB prompt. Decline to quit the debugging
648 # session, and decline to create a core file. Return non-zero if the
651 # This procedure just answers whatever questions come up until it sees
652 # a GDB prompt; it doesn't require you to have matched the input up to
653 # any specific point. However, it only answers questions it sees in
654 # the output itself, so if you've matched a question, you had better
655 # answer it yourself before calling this.
657 # You can use this function thus:
661 # -re ".*A problem internal to GDB has been detected" {
662 # gdb_internal_error_resync
667 proc gdb_internal_error_resync {} {
670 verbose -log "Resyncing due to internal error."
673 while {$count < 10} {
675 -re "Quit this debugging session\\? \\(y or n\\) $" {
676 send_gdb "n\n" answer
679 -re "Create a core file of GDB\\? \\(y or n\\) $" {
680 send_gdb "n\n" answer
683 -re "$gdb_prompt $" {
684 # We're resynchronized.
688 perror "Could not resync from internal error (timeout)"
693 perror "Could not resync from internal error (resync count exceeded)"
698 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS PROMPT_REGEXP
699 # Send a command to gdb; test the result.
701 # COMMAND is the command to execute, send to GDB with send_gdb. If
702 # this is the null string no command is sent.
703 # MESSAGE is a message to be printed with the built-in failure patterns
704 # if one of them matches. If MESSAGE is empty COMMAND will be used.
705 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
706 # patterns. Pattern elements will be evaluated in the caller's
707 # context; action elements will be executed in the caller's context.
708 # Unlike patterns for gdb_test, these patterns should generally include
709 # the final newline and prompt.
710 # PROMPT_REGEXP is a regexp matching the expected prompt after the command
711 # output. If empty, defaults to "$gdb_prompt $"
714 # 1 if the test failed, according to a built-in failure pattern
715 # 0 if only user-supplied patterns matched
716 # -1 if there was an internal error.
718 # You can use this function thus:
720 # gdb_test_multiple "print foo" "test foo" {
721 # -re "expected output 1" {
724 # -re "expected output 2" {
729 # Within action elements you can also make use of the variable
730 # gdb_test_name. This variable is setup automatically by
731 # gdb_test_multiple, and contains the value of MESSAGE. You can then
732 # write this, which is equivalent to the above:
734 # gdb_test_multiple "print foo" "test foo" {
735 # -re "expected output 1" {
736 # pass $gdb_test_name
738 # -re "expected output 2" {
739 # fail $gdb_test_name
743 # Like with "expect", you can also specify the spawn id to match with
744 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
745 # $gdb_spawn_id. The former matches inferior I/O, while the latter
746 # matches GDB I/O. E.g.:
748 # send_inferior "hello\n"
749 # gdb_test_multiple "continue" "test echo" {
750 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
753 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
754 # fail "hit breakpoint"
758 # The standard patterns, such as "Inferior exited..." and "A problem
759 # ...", all being implicitly appended to that list. These are always
760 # expected from $gdb_spawn_id. IOW, callers do not need to worry
761 # about resetting "-i" back to $gdb_spawn_id explicitly.
763 proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
764 global verbose use_gdb_stub
765 global gdb_prompt pagination_prompt
768 global inferior_exited_re
769 upvar timeout timeout
770 upvar expect_out expect_out
773 if { "$prompt_regexp" == "" } {
774 set prompt_regexp "$gdb_prompt $"
777 if { $message == "" } {
781 if [string match "*\[\r\n\]" $command] {
782 error "Invalid trailing newline in \"$message\" test"
785 if [string match "*\[\r\n\]*" $message] {
786 error "Invalid newline in \"$message\" test"
790 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
792 error "gdbserver does not support $command without extended-remote"
795 # TCL/EXPECT WART ALERT
796 # Expect does something very strange when it receives a single braced
797 # argument. It splits it along word separators and performs substitutions.
798 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
799 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
800 # double-quoted list item, "\[ab\]" is just a long way of representing
801 # "[ab]", because the backslashes will be removed by lindex.
803 # Unfortunately, there appears to be no easy way to duplicate the splitting
804 # that expect will do from within TCL. And many places make use of the
805 # "\[0-9\]" construct, so we need to support that; and some places make use
806 # of the "[func]" construct, so we need to support that too. In order to
807 # get this right we have to substitute quoted list elements differently
808 # from braced list elements.
810 # We do this roughly the same way that Expect does it. We have to use two
811 # lists, because if we leave unquoted newlines in the argument to uplevel
812 # they'll be treated as command separators, and if we escape newlines
813 # we mangle newlines inside of command blocks. This assumes that the
814 # input doesn't contain a pattern which contains actual embedded newlines
817 regsub -all {\n} ${user_code} { } subst_code
818 set subst_code [uplevel list $subst_code]
820 set processed_code ""
822 set expecting_action 0
824 foreach item $user_code subst_item $subst_code {
825 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
826 lappend processed_code $item
829 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
830 lappend processed_code $item
833 if { $item == "-timeout" || $item == "-i" } {
835 lappend processed_code $item
838 if { $expecting_arg } {
840 lappend processed_code $subst_item
843 if { $expecting_action } {
844 lappend processed_code "uplevel [list $item]"
845 set expecting_action 0
846 # Cosmetic, no effect on the list.
847 append processed_code "\n"
850 set expecting_action 1
851 lappend processed_code $subst_item
852 if {$patterns != ""} {
855 append patterns "\"$subst_item\""
858 # Also purely cosmetic.
859 regsub -all {\r} $patterns {\\r} patterns
860 regsub -all {\n} $patterns {\\n} patterns
863 send_user "Sending \"$command\" to gdb\n"
864 send_user "Looking to match \"$patterns\"\n"
865 send_user "Message is \"$message\"\n"
869 set string "${command}\n"
870 if { $command != "" } {
871 set multi_line_re "\[\r\n\] *>"
872 while { "$string" != "" } {
873 set foo [string first "\n" "$string"]
874 set len [string length "$string"]
875 if { $foo < [expr $len - 1] } {
876 set str [string range "$string" 0 $foo]
877 if { [send_gdb "$str"] != "" } {
880 if { ! $suppress_flag } {
881 perror "Couldn't send $command to GDB."
886 # since we're checking if each line of the multi-line
887 # command are 'accepted' by GDB here,
888 # we need to set -notransfer expect option so that
889 # command output is not lost for pattern matching
892 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
893 timeout { verbose "partial: timeout" 3 }
895 set string [string range "$string" [expr $foo + 1] end]
896 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
901 if { "$string" != "" } {
902 if { [send_gdb "$string"] != "" } {
905 if { ! $suppress_flag } {
906 perror "Couldn't send $command to GDB."
915 -re ".*A problem internal to GDB has been detected" {
916 fail "$message (GDB internal error)"
917 gdb_internal_error_resync
920 -re "\\*\\*\\* DOSEXIT code.*" {
921 if { $message != "" } {
924 gdb_suppress_entire_file "GDB died"
928 append code $processed_code
930 # Reset the spawn id, in case the processed code used -i.
936 -re "Ending remote debugging.*$prompt_regexp" {
937 if ![isnative] then {
938 warning "Can`t communicate to remote target."
944 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
945 perror "Undefined command \"$command\"."
949 -re "Ambiguous command.*$prompt_regexp" {
950 perror "\"$command\" is not a unique command name."
954 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
955 if ![string match "" $message] then {
956 set errmsg "$message (the program exited)"
958 set errmsg "$command (the program exited)"
963 -re "$inferior_exited_re normally.*$prompt_regexp" {
964 if ![string match "" $message] then {
965 set errmsg "$message (the program exited)"
967 set errmsg "$command (the program exited)"
972 -re "The program is not being run.*$prompt_regexp" {
973 if ![string match "" $message] then {
974 set errmsg "$message (the program is no longer running)"
976 set errmsg "$command (the program is no longer running)"
981 -re "\r\n$prompt_regexp" {
982 if ![string match "" $message] then {
987 -re "$pagination_prompt" {
989 perror "Window too small."
993 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
994 send_gdb "n\n" answer
995 gdb_expect -re "$prompt_regexp"
996 fail "$message (got interactive prompt)"
999 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1001 gdb_expect -re "$prompt_regexp"
1002 fail "$message (got breakpoint menu)"
1008 perror "GDB process no longer exists"
1009 set wait_status [wait -i $gdb_spawn_id]
1010 verbose -log "GDB process exited with wait status $wait_status"
1011 if { $message != "" } {
1018 # Now patterns that apply to any spawn id specified.
1022 perror "Process no longer exists"
1023 if { $message != "" } {
1029 perror "internal buffer is full."
1034 if ![string match "" $message] then {
1035 fail "$message (timeout)"
1041 # remote_expect calls the eof section if there is an error on the
1042 # expect call. We already have eof sections above, and we don't
1043 # want them to get called in that situation. Since the last eof
1044 # section becomes the error section, here we define another eof
1045 # section, but with an empty spawn_id list, so that it won't ever
1049 # This comment is here because the eof section must not be
1050 # the empty string, otherwise remote_expect won't realize
1055 # Create gdb_test_name in the parent scope. If this variable
1056 # already exists, which it might if we have nested calls to
1057 # gdb_test_multiple, then preserve the old value, otherwise,
1058 # create a new variable in the parent scope.
1059 upvar gdb_test_name gdb_test_name
1060 if { [info exists gdb_test_name] } {
1061 set gdb_test_name_old "$gdb_test_name"
1063 set gdb_test_name "$message"
1066 set code [catch {gdb_expect $code} string]
1068 # Clean up the gdb_test_name variable. If we had a
1069 # previous value then restore it, otherwise, delete the variable
1070 # from the parent scope.
1071 if { [info exists gdb_test_name_old] } {
1072 set gdb_test_name "$gdb_test_name_old"
1078 global errorInfo errorCode
1079 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1080 } elseif {$code > 1} {
1081 return -code $code $string
1086 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1087 # Send a command to gdb; test the result.
1089 # COMMAND is the command to execute, send to GDB with send_gdb. If
1090 # this is the null string no command is sent.
1091 # PATTERN is the pattern to match for a PASS, and must NOT include
1092 # the \r\n sequence immediately before the gdb prompt. This argument
1093 # may be omitted to just match the prompt, ignoring whatever output
1095 # MESSAGE is an optional message to be printed. If this is
1096 # omitted, then the pass/fail messages use the command string as the
1097 # message. (If this is the empty string, then sometimes we don't
1098 # call pass or fail at all; I don't understand this at all.)
1099 # QUESTION is a question GDB may ask in response to COMMAND, like
1101 # RESPONSE is the response to send if QUESTION appears.
1104 # 1 if the test failed,
1105 # 0 if the test passes,
1106 # -1 if there was an internal error.
1108 proc gdb_test { args } {
1110 upvar timeout timeout
1112 if [llength $args]>2 then {
1113 set message [lindex $args 2]
1115 set message [lindex $args 0]
1117 set command [lindex $args 0]
1118 set pattern [lindex $args 1]
1122 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1123 if ![string match "" $message] then {
1129 if { [llength $args] == 5 } {
1130 set question_string [lindex $args 3]
1131 set response_string [lindex $args 4]
1133 -re "(${question_string})$" {
1134 send_gdb "$response_string\n"
1140 set user_code [join $user_code]
1141 return [gdb_test_multiple $command $message $user_code]
1144 # Return 1 if version MAJOR.MINOR is at least AT_LEAST_MAJOR.AT_LEAST_MINOR.
1145 proc version_at_least { major minor at_least_major at_least_minor} {
1146 if { $major > $at_least_major } {
1148 } elseif { $major == $at_least_major \
1149 && $minor >= $at_least_minor } {
1156 # Return 1 if tcl version used is at least MAJOR.MINOR
1157 proc tcl_version_at_least { major minor } {
1159 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1160 dummy tcl_version_major tcl_version_minor
1161 return [version_at_least $tcl_version_major $tcl_version_minor \
1165 if { [tcl_version_at_least 8 5] == 0 } {
1166 # lrepeat was added in tcl 8.5. Only add if missing.
1167 proc lrepeat { n element } {
1168 if { [string is integer -strict $n] == 0 } {
1169 error "expected integer but got \"$n\""
1172 error "bad count \"$n\": must be integer >= 0"
1175 for {set i 0} {$i < $n} {incr i} {
1176 lappend res $element
1182 # gdb_test_no_output COMMAND MESSAGE
1183 # Send a command to GDB and verify that this command generated no output.
1185 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1186 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1187 # the message. (If MESSAGE is the empty string, then sometimes we do not
1188 # call pass or fail at all; I don't understand this at all.)
1190 proc gdb_test_no_output { args } {
1192 set command [lindex $args 0]
1193 if [llength $args]>1 then {
1194 set message [lindex $args 1]
1196 set message $command
1199 set command_regex [string_to_regexp $command]
1200 gdb_test_multiple $command $message {
1201 -re "^$command_regex\r\n$gdb_prompt $" {
1202 if ![string match "" $message] then {
1209 # Send a command and then wait for a sequence of outputs.
1210 # This is useful when the sequence is long and contains ".*", a single
1211 # regexp to match the entire output can get a timeout much easier.
1213 # COMMAND is the command to execute, send to GDB with send_gdb. If
1214 # this is the null string no command is sent.
1215 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1216 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1217 # processed in order, and all must be present in the output.
1219 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1220 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1221 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1223 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1224 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1227 # 1 if the test failed,
1228 # 0 if the test passes,
1229 # -1 if there was an internal error.
1231 proc gdb_test_sequence { command test_name expected_output_list } {
1233 if { $test_name == "" } {
1234 set test_name $command
1236 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1237 if { $command != "" } {
1238 send_gdb "$command\n"
1240 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1244 # Test that a command gives an error. For pass or fail, return
1245 # a 1 to indicate that more tests can proceed. However a timeout
1246 # is a serious error, generates a special fail message, and causes
1247 # a 0 to be returned to indicate that more tests are likely to fail
1250 proc test_print_reject { args } {
1254 if [llength $args]==2 then {
1255 set expectthis [lindex $args 1]
1257 set expectthis "should never match this bogus string"
1259 set sendthis [lindex $args 0]
1260 if $verbose>2 then {
1261 send_user "Sending \"$sendthis\" to gdb\n"
1262 send_user "Looking to match \"$expectthis\"\n"
1264 send_gdb "$sendthis\n"
1265 #FIXME: Should add timeout as parameter.
1267 -re "A .* in expression.*\\.*$gdb_prompt $" {
1268 pass "reject $sendthis"
1271 -re "Invalid syntax in expression.*$gdb_prompt $" {
1272 pass "reject $sendthis"
1275 -re "Junk after end of expression.*$gdb_prompt $" {
1276 pass "reject $sendthis"
1279 -re "Invalid number.*$gdb_prompt $" {
1280 pass "reject $sendthis"
1283 -re "Invalid character constant.*$gdb_prompt $" {
1284 pass "reject $sendthis"
1287 -re "No symbol table is loaded.*$gdb_prompt $" {
1288 pass "reject $sendthis"
1291 -re "No symbol .* in current context.*$gdb_prompt $" {
1292 pass "reject $sendthis"
1295 -re "Unmatched single quote.*$gdb_prompt $" {
1296 pass "reject $sendthis"
1299 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1300 pass "reject $sendthis"
1303 -re "$expectthis.*$gdb_prompt $" {
1304 pass "reject $sendthis"
1307 -re ".*$gdb_prompt $" {
1308 fail "reject $sendthis"
1312 fail "reject $sendthis (eof or timeout)"
1319 # Same as gdb_test, but the second parameter is not a regexp,
1320 # but a string that must match exactly.
1322 proc gdb_test_exact { args } {
1323 upvar timeout timeout
1325 set command [lindex $args 0]
1327 # This applies a special meaning to a null string pattern. Without
1328 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1329 # messages from commands that should have no output except a new
1330 # prompt. With this, only results of a null string will match a null
1333 set pattern [lindex $args 1]
1334 if [string match $pattern ""] {
1335 set pattern [string_to_regexp [lindex $args 0]]
1337 set pattern [string_to_regexp [lindex $args 1]]
1340 # It is most natural to write the pattern argument with only
1341 # embedded \n's, especially if you are trying to avoid Tcl quoting
1342 # problems. But gdb_expect really wants to see \r\n in patterns. So
1343 # transform the pattern here. First transform \r\n back to \n, in
1344 # case some users of gdb_test_exact already do the right thing.
1345 regsub -all "\r\n" $pattern "\n" pattern
1346 regsub -all "\n" $pattern "\r\n" pattern
1347 if [llength $args]==3 then {
1348 set message [lindex $args 2]
1350 set message $command
1353 return [gdb_test $command $pattern $message]
1356 # Wrapper around gdb_test_multiple that looks for a list of expected
1357 # output elements, but which can appear in any order.
1358 # CMD is the gdb command.
1359 # NAME is the name of the test.
1360 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1362 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1363 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1364 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1366 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1367 # of text per element and then strip trailing \r\n's.
1369 # gdb_test_list_exact "foo" "bar" \
1370 # "\[^\r\n\]+\[\r\n\]+" \
1373 # {expected result 1} \
1374 # {expected result 2} \
1377 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1380 set matches [lsort $result_match_list]
1382 gdb_test_multiple $cmd $name {
1383 "$cmd\[\r\n\]" { exp_continue }
1384 -re $elm_find_regexp {
1385 set str $expect_out(0,string)
1386 verbose -log "seen: $str" 3
1387 regexp -- $elm_extract_regexp $str elm_seen
1388 verbose -log "extracted: $elm_seen" 3
1389 lappend seen $elm_seen
1392 -re "$gdb_prompt $" {
1394 foreach got [lsort $seen] have $matches {
1395 if {![string equal $got $have]} {
1400 if {[string length $failed] != 0} {
1401 fail "$name ($failed not found)"
1409 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1410 # Send a command to gdb; expect inferior and gdb output.
1412 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1415 # INFERIOR_PATTERN is the pattern to match against inferior output.
1417 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1418 # include the \r\n sequence immediately before the gdb prompt, nor the
1419 # prompt. The default is empty.
1421 # Both inferior and gdb patterns must match for a PASS.
1423 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1426 # 1 if the test failed,
1427 # 0 if the test passes,
1428 # -1 if there was an internal error.
1431 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1432 global inferior_spawn_id gdb_spawn_id
1435 if {$message == ""} {
1436 set message $command
1439 set inferior_matched 0
1442 # Use an indirect spawn id list, and remove the inferior spawn id
1443 # from the expected output as soon as it matches, in case
1444 # $inferior_pattern happens to be a prefix of the resulting full
1445 # gdb pattern below (e.g., "\r\n").
1446 global gdb_test_stdio_spawn_id_list
1447 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1449 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1450 # then we may see gdb's output arriving before the inferior's
1452 set res [gdb_test_multiple $command $message {
1453 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1454 set inferior_matched 1
1455 if {!$gdb_matched} {
1456 set gdb_test_stdio_spawn_id_list ""
1460 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1462 if {!$inferior_matched} {
1470 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1475 # get_print_expr_at_depths EXP OUTPUTS
1477 # Used for testing 'set print max-depth'. Prints the expression EXP
1478 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1479 # of `n` different patterns to match at each of the depths from 0 to
1482 # This proc does one final check with the max-depth set to 'unlimited'
1483 # which is tested against the last pattern in the OUTPUTS list. The
1484 # OUTPUTS list is therefore required to match every depth from 0 to a
1485 # depth where the whole of EXP is printed with no ellipsis.
1487 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1488 proc gdb_print_expr_at_depths {exp outputs} {
1489 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1490 if { $depth == [llength $outputs] } {
1491 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1492 set depth_string "unlimited"
1494 set expected_result [lindex $outputs $depth]
1495 set depth_string $depth
1498 with_test_prefix "exp='$exp': depth=${depth_string}" {
1499 gdb_test_no_output "set print max-depth ${depth_string}"
1500 gdb_test "p $exp" "$expected_result"
1507 # Issue a PASS and return true if evaluating CONDITION in the caller's
1508 # frame returns true, and issue a FAIL and return false otherwise.
1509 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1510 # omitted or is empty, then the pass/fail messages use the condition
1511 # string as the message.
1513 proc gdb_assert { condition {message ""} } {
1514 if { $message == ""} {
1515 set message $condition
1518 set res [uplevel 1 expr $condition]
1527 proc gdb_reinitialize_dir { subdir } {
1530 if [is_remote host] {
1535 -re "Reinitialize source path to empty.*y or n. " {
1536 send_gdb "y\n" answer
1538 -re "Source directories searched.*$gdb_prompt $" {
1539 send_gdb "dir $subdir\n"
1541 -re "Source directories searched.*$gdb_prompt $" {
1542 verbose "Dir set to $subdir"
1544 -re "$gdb_prompt $" {
1545 perror "Dir \"$subdir\" failed."
1549 -re "$gdb_prompt $" {
1550 perror "Dir \"$subdir\" failed."
1554 -re "$gdb_prompt $" {
1555 perror "Dir \"$subdir\" failed."
1561 # gdb_exit -- exit the GDB, killing the target program if necessary
1563 proc default_gdb_exit {} {
1565 global INTERNAL_GDBFLAGS GDBFLAGS
1567 global gdb_spawn_id inferior_spawn_id
1568 global inotify_log_file
1570 gdb_stop_suppressing_tests
1572 if ![info exists gdb_spawn_id] {
1576 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1578 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1579 set fd [open $inotify_log_file]
1580 set data [read -nonewline $fd]
1583 if {[string compare $data ""] != 0} {
1584 warning "parallel-unsafe file creations noticed"
1587 set fd [open $inotify_log_file w]
1592 if { [is_remote host] && [board_info host exists fileid] } {
1596 send_gdb "y\n" answer
1599 -re "DOSEXIT code" { }
1604 if ![is_remote host] {
1608 unset inferior_spawn_id
1611 # Load a file into the debugger.
1612 # The return value is 0 for success, -1 for failure.
1614 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1615 # to one of these values:
1617 # debug file was loaded successfully and has debug information
1618 # nodebug file was loaded successfully and has no debug information
1619 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1621 # fail file was not loaded
1623 # I tried returning this information as part of the return value,
1624 # but ran into a mess because of the many re-implementations of
1625 # gdb_load in config/*.exp.
1627 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1628 # this if they can get more information set.
1630 proc gdb_file_cmd { arg } {
1634 global last_loaded_file
1636 # Save this for the benefit of gdbserver-support.exp.
1637 set last_loaded_file $arg
1639 # Set whether debug info was found.
1640 # Default to "fail".
1641 global gdb_file_cmd_debug_info
1642 set gdb_file_cmd_debug_info "fail"
1644 if [is_remote host] {
1645 set arg [remote_download host $arg]
1647 perror "download failed"
1652 # The file command used to kill the remote target. For the benefit
1653 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
1654 # get written to the stdin log.
1655 send_gdb "kill\n" optional
1657 -re "Kill the program being debugged. .y or n. $" {
1658 send_gdb "y\n" answer
1659 verbose "\t\tKilling previous program being debugged"
1662 -re "$gdb_prompt $" {
1667 send_gdb "file $arg\n"
1669 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1670 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1671 set gdb_file_cmd_debug_info "lzma"
1674 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1675 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1676 set gdb_file_cmd_debug_info "nodebug"
1679 -re "Reading symbols from.*$gdb_prompt $" {
1680 verbose "\t\tLoaded $arg into $GDB"
1681 set gdb_file_cmd_debug_info "debug"
1684 -re "Load new symbol table from \".*\".*y or n. $" {
1685 send_gdb "y\n" answer
1687 -re "Reading symbols from.*$gdb_prompt $" {
1688 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1689 set gdb_file_cmd_debug_info "debug"
1693 perror "Couldn't load $arg, other program already loaded (timeout)."
1697 perror "Couldn't load $arg, other program already loaded (eof)."
1702 -re "No such file or directory.*$gdb_prompt $" {
1703 perror "($arg) No such file or directory"
1706 -re "A problem internal to GDB has been detected" {
1707 fail "($arg) (GDB internal error)"
1708 gdb_internal_error_resync
1711 -re "$gdb_prompt $" {
1712 perror "Couldn't load $arg into $GDB."
1716 perror "Couldn't load $arg into $GDB (timeout)."
1720 # This is an attempt to detect a core dump, but seems not to
1721 # work. Perhaps we need to match .* followed by eof, in which
1722 # gdb_expect does not seem to have a way to do that.
1723 perror "Couldn't load $arg into $GDB (eof)."
1729 # Default gdb_spawn procedure.
1731 proc default_gdb_spawn { } {
1734 global INTERNAL_GDBFLAGS GDBFLAGS
1737 gdb_stop_suppressing_tests
1739 # Set the default value, it may be overriden later by specific testfile.
1741 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1742 # is already started after connecting and run/attach are not supported.
1743 # This is used for the "remote" protocol. After GDB starts you should
1744 # check global $use_gdb_stub instead of the board as the testfile may force
1745 # a specific different target protocol itself.
1746 set use_gdb_stub [target_info exists use_gdb_stub]
1748 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1749 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1751 if [info exists gdb_spawn_id] {
1755 if ![is_remote host] {
1756 if { [which $GDB] == 0 } then {
1757 perror "$GDB does not exist."
1761 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1762 if { $res < 0 || $res == "" } {
1763 perror "Spawning $GDB failed."
1767 set gdb_spawn_id $res
1771 # Default gdb_start procedure.
1773 proc default_gdb_start { } {
1776 global inferior_spawn_id
1778 if [info exists gdb_spawn_id] {
1782 # Keep track of the number of times GDB has been launched.
1783 global gdb_instances
1793 # Default to assuming inferior I/O is done on GDB's terminal.
1794 if {![info exists inferior_spawn_id]} {
1795 set inferior_spawn_id $gdb_spawn_id
1798 # When running over NFS, particularly if running many simultaneous
1799 # tests on different hosts all using the same server, things can
1800 # get really slow. Give gdb at least 3 minutes to start up.
1802 -re "\[\r\n\]$gdb_prompt $" {
1803 verbose "GDB initialized."
1805 -re "$gdb_prompt $" {
1806 perror "GDB never initialized."
1811 perror "(timeout) GDB never initialized after 10 seconds."
1818 # force the height to "unlimited", so no pagers get used
1820 send_gdb "set height 0\n"
1822 -re "$gdb_prompt $" {
1823 verbose "Setting height to 0." 2
1826 warning "Couldn't set the height to 0"
1829 # force the width to "unlimited", so no wraparound occurs
1830 send_gdb "set width 0\n"
1832 -re "$gdb_prompt $" {
1833 verbose "Setting width to 0." 2
1836 warning "Couldn't set the width to 0."
1844 # Utility procedure to give user control of the gdb prompt in a script. It is
1845 # meant to be used for debugging test cases, and should not be left in the
1848 proc gdb_interact { } {
1850 set spawn_id $gdb_spawn_id
1852 send_user "+------------------------------------------+\n"
1853 send_user "| Script interrupted, you can now interact |\n"
1854 send_user "| with by gdb. Type >>> to continue. |\n"
1855 send_user "+------------------------------------------+\n"
1862 # Examine the output of compilation to determine whether compilation
1863 # failed or not. If it failed determine whether it is due to missing
1864 # compiler or due to compiler error. Report pass, fail or unsupported
1867 proc gdb_compile_test {src output} {
1868 if { $output == "" } {
1869 pass "compilation [file tail $src]"
1870 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1871 unsupported "compilation [file tail $src]"
1872 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1873 unsupported "compilation [file tail $src]"
1874 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1875 unsupported "compilation [file tail $src]"
1877 verbose -log "compilation failed: $output" 2
1878 fail "compilation [file tail $src]"
1882 # Return a 1 for configurations for which we don't even want to try to
1885 proc skip_cplus_tests {} {
1886 if { [istarget "h8300-*-*"] } {
1890 # The C++ IO streams are too large for HC11/HC12 and are thus not
1891 # available. The gdb C++ tests use them and don't compile.
1892 if { [istarget "m6811-*-*"] } {
1895 if { [istarget "m6812-*-*"] } {
1901 # Return a 1 for configurations for which don't have both C++ and the STL.
1903 proc skip_stl_tests {} {
1904 # Symbian supports the C++ language, but the STL is missing
1905 # (both headers and libraries).
1906 if { [istarget "arm*-*-symbianelf*"] } {
1910 return [skip_cplus_tests]
1913 # Return a 1 if I don't even want to try to test FORTRAN.
1915 proc skip_fortran_tests {} {
1919 # Return a 1 if I don't even want to try to test ada.
1921 proc skip_ada_tests {} {
1925 # Return a 1 if I don't even want to try to test GO.
1927 proc skip_go_tests {} {
1931 # Return a 1 if I don't even want to try to test D.
1933 proc skip_d_tests {} {
1937 # Return 1 to skip Rust tests, 0 to try them.
1938 proc skip_rust_tests {} {
1939 return [expr {![isnative]}]
1942 # Return a 1 for configurations that do not support Python scripting.
1943 # PROMPT_REGEXP is the expected prompt.
1945 proc skip_python_tests_prompt { prompt_regexp } {
1946 global gdb_py_is_py3k
1948 gdb_test_multiple "python print ('test')" "verify python support" {
1949 -re "not supported.*$prompt_regexp" {
1950 unsupported "Python support is disabled."
1953 -re "$prompt_regexp" {}
1956 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1957 -re "3.*$prompt_regexp" {
1958 set gdb_py_is_py3k 1
1960 -re ".*$prompt_regexp" {
1961 set gdb_py_is_py3k 0
1968 # Return a 1 for configurations that do not support Python scripting.
1969 # Note: This also sets various globals that specify which version of Python
1970 # is in use. See skip_python_tests_prompt.
1972 proc skip_python_tests {} {
1974 return [skip_python_tests_prompt "$gdb_prompt $"]
1977 # Return a 1 if we should skip shared library tests.
1979 proc skip_shlib_tests {} {
1980 # Run the shared library tests on native systems.
1985 # An abbreviated list of remote targets where we should be able to
1986 # run shared library tests.
1987 if {([istarget *-*-linux*]
1988 || [istarget *-*-*bsd*]
1989 || [istarget *-*-solaris2*]
1990 || [istarget arm*-*-symbianelf*]
1991 || [istarget *-*-mingw*]
1992 || [istarget *-*-cygwin*]
1993 || [istarget *-*-pe*])} {
2000 # Return 1 if we should skip tui related tests.
2002 proc skip_tui_tests {} {
2005 gdb_test_multiple "help layout" "verify tui support" {
2006 -re "Undefined command: \"layout\".*$gdb_prompt $" {
2009 -re "$gdb_prompt $" {
2016 # Test files shall make sure all the test result lines in gdb.sum are
2017 # unique in a test run, so that comparing the gdb.sum files of two
2018 # test runs gives correct results. Test files that exercise
2019 # variations of the same tests more than once, shall prefix the
2020 # different test invocations with different identifying strings in
2021 # order to make them unique.
2023 # About test prefixes:
2025 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2026 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2027 # underlined substring in
2029 # PASS: gdb.base/mytest.exp: some test
2030 # ^^^^^^^^^^^^^^^^^^^^
2034 # The easiest way to adjust the test prefix is to append a test
2035 # variation prefix to the $pf_prefix, using the with_test_prefix
2038 # proc do_tests {} {
2039 # gdb_test ... ... "test foo"
2040 # gdb_test ... ... "test bar"
2042 # with_test_prefix "subvariation a" {
2043 # gdb_test ... ... "test x"
2046 # with_test_prefix "subvariation b" {
2047 # gdb_test ... ... "test x"
2051 # with_test_prefix "variation1" {
2052 # ...do setup for variation 1...
2056 # with_test_prefix "variation2" {
2057 # ...do setup for variation 2...
2063 # PASS: gdb.base/mytest.exp: variation1: test foo
2064 # PASS: gdb.base/mytest.exp: variation1: test bar
2065 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2066 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2067 # PASS: gdb.base/mytest.exp: variation2: test foo
2068 # PASS: gdb.base/mytest.exp: variation2: test bar
2069 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2070 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2072 # If for some reason more flexibility is necessary, one can also
2073 # manipulate the pf_prefix global directly, treating it as a string.
2077 # set saved_pf_prefix
2078 # append pf_prefix "${foo}: bar"
2079 # ... actual tests ...
2080 # set pf_prefix $saved_pf_prefix
2083 # Run BODY in the context of the caller, with the current test prefix
2084 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2085 # Returns the result of BODY.
2087 proc with_test_prefix { prefix body } {
2090 set saved $pf_prefix
2091 append pf_prefix " " $prefix ":"
2092 set code [catch {uplevel 1 $body} result]
2093 set pf_prefix $saved
2096 global errorInfo errorCode
2097 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2099 return -code $code $result
2103 # Wrapper for foreach that calls with_test_prefix on each iteration,
2104 # including the iterator's name and current value in the prefix.
2106 proc foreach_with_prefix {var list body} {
2108 foreach myvar $list {
2109 with_test_prefix "$var=$myvar" {
2110 set code [catch {uplevel 1 $body} result]
2114 global errorInfo errorCode
2115 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2116 } elseif {$code == 3} {
2118 } elseif {$code == 2} {
2119 return -code $code $result
2124 # Like TCL's native proc, but defines a procedure that wraps its body
2125 # within 'with_test_prefix "$proc_name" { ... }'.
2126 proc proc_with_prefix {name arguments body} {
2127 # Define the advertised proc.
2128 proc $name $arguments [list with_test_prefix $name $body]
2132 # Run BODY in the context of the caller. After BODY is run, the variables
2133 # listed in VARS will be reset to the values they had before BODY was run.
2135 # This is useful for providing a scope in which it is safe to temporarily
2136 # modify global variables, e.g.
2138 # global INTERNAL_GDBFLAGS
2141 # set foo GDBHISTSIZE
2143 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2144 # append INTERNAL_GDBFLAGS " -nx"
2145 # unset -nocomplain env(GDBHISTSIZE)
2150 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2151 # modified inside BODY, this proc guarantees that the modifications will be
2152 # undone after BODY finishes executing.
2154 proc save_vars { vars body } {
2155 array set saved_scalars { }
2156 array set saved_arrays { }
2160 # First evaluate VAR in the context of the caller in case the variable
2161 # name may be a not-yet-interpolated string like env($foo)
2162 set var [uplevel 1 list $var]
2164 if [uplevel 1 [list info exists $var]] {
2165 if [uplevel 1 [list array exists $var]] {
2166 set saved_arrays($var) [uplevel 1 [list array get $var]]
2168 set saved_scalars($var) [uplevel 1 [list set $var]]
2171 lappend unset_vars $var
2175 set code [catch {uplevel 1 $body} result]
2177 foreach {var value} [array get saved_scalars] {
2178 uplevel 1 [list set $var $value]
2181 foreach {var value} [array get saved_arrays] {
2182 uplevel 1 [list unset $var]
2183 uplevel 1 [list array set $var $value]
2186 foreach var $unset_vars {
2187 uplevel 1 [list unset -nocomplain $var]
2191 global errorInfo errorCode
2192 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2194 return -code $code $result
2198 # Run tests in BODY with the current working directory (CWD) set to
2199 # DIR. When BODY is finished, restore the original CWD. Return the
2202 # This procedure doesn't check if DIR is a valid directory, so you
2203 # have to make sure of that.
2205 proc with_cwd { dir body } {
2207 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2210 set code [catch {uplevel 1 $body} result]
2212 verbose -log "Switching back to $saved_dir."
2216 global errorInfo errorCode
2217 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2219 return -code $code $result
2223 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2224 # PROMPT. When BODY is finished, restore GDB prompt and variable
2226 # Returns the result of BODY.
2230 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2231 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2232 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2233 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2234 # a) It's more intuitive for callers to pass the plain text form.
2235 # b) We need two forms of the prompt:
2236 # - a regexp to use in output matching,
2237 # - a value to pass to the "set prompt" command.
2238 # c) It's easier to convert the plain text form to its regexp form.
2240 # 2) Don't add a trailing space, we do that here.
2242 proc with_gdb_prompt { prompt body } {
2245 # Convert "(foo)" to "\(foo\)".
2246 # We don't use string_to_regexp because while it works today it's not
2247 # clear it will work tomorrow: the value we need must work as both a
2248 # regexp *and* as the argument to the "set prompt" command, at least until
2249 # we start recording both forms separately instead of just $gdb_prompt.
2250 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2252 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2254 set saved $gdb_prompt
2256 verbose -log "Setting gdb prompt to \"$prompt \"."
2257 set gdb_prompt $prompt
2258 gdb_test_no_output "set prompt $prompt " ""
2260 set code [catch {uplevel 1 $body} result]
2262 verbose -log "Restoring gdb prompt to \"$saved \"."
2263 set gdb_prompt $saved
2264 gdb_test_no_output "set prompt $saved " ""
2267 global errorInfo errorCode
2268 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2270 return -code $code $result
2274 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2275 # BODY is finished, restore target-charset.
2277 proc with_target_charset { target_charset body } {
2281 gdb_test_multiple "show target-charset" "" {
2282 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2283 set saved $expect_out(1,string)
2285 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2286 set saved $expect_out(1,string)
2288 -re ".*$gdb_prompt " {
2289 fail "get target-charset"
2293 gdb_test_no_output "set target-charset $target_charset" ""
2295 set code [catch {uplevel 1 $body} result]
2297 gdb_test_no_output "set target-charset $saved" ""
2300 global errorInfo errorCode
2301 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2303 return -code $code $result
2307 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2308 # mi_gdb_test etc. default to using it.
2310 proc switch_gdb_spawn_id {spawn_id} {
2312 global board board_info
2314 set gdb_spawn_id $spawn_id
2315 set board [host_info name]
2316 set board_info($board,fileid) $spawn_id
2319 # Clear the default spawn id.
2321 proc clear_gdb_spawn_id {} {
2323 global board board_info
2325 unset -nocomplain gdb_spawn_id
2326 set board [host_info name]
2327 unset -nocomplain board_info($board,fileid)
2330 # Run BODY with SPAWN_ID as current spawn id.
2332 proc with_spawn_id { spawn_id body } {
2335 if [info exists gdb_spawn_id] {
2336 set saved_spawn_id $gdb_spawn_id
2339 switch_gdb_spawn_id $spawn_id
2341 set code [catch {uplevel 1 $body} result]
2343 if [info exists saved_spawn_id] {
2344 switch_gdb_spawn_id $saved_spawn_id
2350 global errorInfo errorCode
2351 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2353 return -code $code $result
2357 # Select the largest timeout from all the timeouts:
2358 # - the local "timeout" variable of the scope two levels above,
2359 # - the global "timeout" variable,
2360 # - the board variable "gdb,timeout".
2362 proc get_largest_timeout {} {
2363 upvar #0 timeout gtimeout
2364 upvar 2 timeout timeout
2367 if [info exists timeout] {
2370 if { [info exists gtimeout] && $gtimeout > $tmt } {
2373 if { [target_info exists gdb,timeout]
2374 && [target_info gdb,timeout] > $tmt } {
2375 set tmt [target_info gdb,timeout]
2385 # Run tests in BODY with timeout increased by factor of FACTOR. When
2386 # BODY is finished, restore timeout.
2388 proc with_timeout_factor { factor body } {
2391 set savedtimeout $timeout
2393 set timeout [expr [get_largest_timeout] * $factor]
2394 set code [catch {uplevel 1 $body} result]
2396 set timeout $savedtimeout
2398 global errorInfo errorCode
2399 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2401 return -code $code $result
2405 # Run BODY with timeout factor FACTOR if check-read1 is used.
2407 proc with_read1_timeout_factor { factor body } {
2408 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
2409 # Use timeout factor
2411 # Reset timeout factor
2414 return [uplevel [list with_timeout_factor $factor $body]]
2417 # Return 1 if _Complex types are supported, otherwise, return 0.
2419 gdb_caching_proc support_complex_tests {
2421 if { [gdb_skip_float_test] } {
2422 # If floating point is not supported, _Complex is not
2427 # Compile a test program containing _Complex types.
2429 return [gdb_can_simple_compile complex {
2433 _Complex long double cld;
2439 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2442 proc supports_get_siginfo_type {} {
2443 if { [istarget "*-*-linux*"] } {
2450 # Return 1 if the target supports hardware single stepping.
2452 proc can_hardware_single_step {} {
2454 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2455 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2456 || [istarget "nios2-*-*"] } {
2463 # Return 1 if target hardware or OS supports single stepping to signal
2464 # handler, otherwise, return 0.
2466 proc can_single_step_to_signal_handler {} {
2467 # Targets don't have hardware single step. On these targets, when
2468 # a signal is delivered during software single step, gdb is unable
2469 # to determine the next instruction addresses, because start of signal
2470 # handler is one of them.
2471 return [can_hardware_single_step]
2474 # Return 1 if target supports process record, otherwise return 0.
2476 proc supports_process_record {} {
2478 if [target_info exists gdb,use_precord] {
2479 return [target_info gdb,use_precord]
2482 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2483 || [istarget "i\[34567\]86-*-linux*"]
2484 || [istarget "aarch64*-*-linux*"]
2485 || [istarget "powerpc*-*-linux*"]
2486 || [istarget "s390*-*-linux*"] } {
2493 # Return 1 if target supports reverse debugging, otherwise return 0.
2495 proc supports_reverse {} {
2497 if [target_info exists gdb,can_reverse] {
2498 return [target_info gdb,can_reverse]
2501 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2502 || [istarget "i\[34567\]86-*-linux*"]
2503 || [istarget "aarch64*-*-linux*"]
2504 || [istarget "powerpc*-*-linux*"]
2505 || [istarget "s390*-*-linux*"] } {
2512 # Return 1 if readline library is used.
2514 proc readline_is_used { } {
2517 gdb_test_multiple "show editing" "" {
2518 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2521 -re ".*$gdb_prompt $" {
2527 # Return 1 if target is ELF.
2528 gdb_caching_proc is_elf_target {
2529 set me "is_elf_target"
2531 set src { int foo () {return 0;} }
2532 if {![gdb_simple_compile elf_target $src]} {
2536 set fp_obj [open $obj "r"]
2537 fconfigure $fp_obj -translation binary
2538 set data [read $fp_obj]
2543 set ELFMAG "\u007FELF"
2545 if {[string compare -length 4 $data $ELFMAG] != 0} {
2546 verbose "$me: returning 0" 2
2550 verbose "$me: returning 1" 2
2554 # Return 1 if the memory at address zero is readable.
2556 gdb_caching_proc is_address_zero_readable {
2560 gdb_test_multiple "x 0" "" {
2561 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2564 -re ".*$gdb_prompt $" {
2572 # Produce source file NAME and write SOURCES into it.
2574 proc gdb_produce_source { name sources } {
2576 set f [open $name "w"]
2582 # Return 1 if target is ILP32.
2583 # This cannot be decided simply from looking at the target string,
2584 # as it might depend on externally passed compiler options like -m64.
2585 gdb_caching_proc is_ilp32_target {
2586 return [gdb_can_simple_compile is_ilp32_target {
2587 int dummy[sizeof (int) == 4
2588 && sizeof (void *) == 4
2589 && sizeof (long) == 4 ? 1 : -1];
2593 # Return 1 if target is LP64.
2594 # This cannot be decided simply from looking at the target string,
2595 # as it might depend on externally passed compiler options like -m64.
2596 gdb_caching_proc is_lp64_target {
2597 return [gdb_can_simple_compile is_lp64_target {
2598 int dummy[sizeof (int) == 4
2599 && sizeof (void *) == 8
2600 && sizeof (long) == 8 ? 1 : -1];
2604 # Return 1 if target has 64 bit addresses.
2605 # This cannot be decided simply from looking at the target string,
2606 # as it might depend on externally passed compiler options like -m64.
2607 gdb_caching_proc is_64_target {
2608 return [gdb_can_simple_compile is_64_target {
2609 int function(void) { return 3; }
2610 int dummy[sizeof (&function) == 8 ? 1 : -1];
2614 # Return 1 if target has x86_64 registers - either amd64 or x32.
2615 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2616 # just from the target string.
2617 gdb_caching_proc is_amd64_regs_target {
2618 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2622 return [gdb_can_simple_compile is_amd64_regs_target {
2632 # Return 1 if this target is an x86 or x86-64 with -m32.
2633 proc is_x86_like_target {} {
2634 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2637 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2640 # Return 1 if this target is an arm or aarch32 on aarch64.
2642 gdb_caching_proc is_aarch32_target {
2643 if { [istarget "arm*-*-*"] } {
2647 if { ![istarget "aarch64*-*-*"] } {
2654 lappend list "\tmov $reg, $reg"
2657 return [gdb_can_simple_compile aarch32 [join $list \n]]
2660 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2662 proc is_aarch64_target {} {
2663 if { ![istarget "aarch64*-*-*"] } {
2667 return [expr ![is_aarch32_target]]
2670 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2671 proc support_displaced_stepping {} {
2673 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2674 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2675 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2676 || [istarget "aarch64*-*-linux*"] } {
2683 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2684 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2686 gdb_caching_proc skip_altivec_tests {
2687 global srcdir subdir gdb_prompt inferior_exited_re
2689 set me "skip_altivec_tests"
2691 # Some simulators are known to not support VMX instructions.
2692 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2693 verbose "$me: target known to not support VMX, returning 1" 2
2697 # Make sure we have a compiler that understands altivec.
2698 if [get_compiler_info] {
2699 warning "Could not get compiler info"
2702 if [test_compiler_info gcc*] {
2703 set compile_flags "additional_flags=-maltivec"
2704 } elseif [test_compiler_info xlc*] {
2705 set compile_flags "additional_flags=-qaltivec"
2707 verbose "Could not compile with altivec support, returning 1" 2
2711 # Compile a test program containing VMX instructions.
2715 asm volatile ("vor v0,v0,v0");
2717 asm volatile ("vor 0,0,0");
2722 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2726 # Compilation succeeded so now run it via gdb.
2730 gdb_reinitialize_dir $srcdir/$subdir
2734 -re ".*Illegal instruction.*${gdb_prompt} $" {
2735 verbose -log "\n$me altivec hardware not detected"
2736 set skip_vmx_tests 1
2738 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2739 verbose -log "\n$me: altivec hardware detected"
2740 set skip_vmx_tests 0
2743 warning "\n$me: default case taken"
2744 set skip_vmx_tests 1
2748 remote_file build delete $obj
2750 verbose "$me: returning $skip_vmx_tests" 2
2751 return $skip_vmx_tests
2754 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2755 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2757 gdb_caching_proc skip_vsx_tests {
2758 global srcdir subdir gdb_prompt inferior_exited_re
2760 set me "skip_vsx_tests"
2762 # Some simulators are known to not support Altivec instructions, so
2763 # they won't support VSX instructions as well.
2764 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2765 verbose "$me: target known to not support VSX, returning 1" 2
2769 # Make sure we have a compiler that understands altivec.
2770 if [get_compiler_info] {
2771 warning "Could not get compiler info"
2774 if [test_compiler_info gcc*] {
2775 set compile_flags "additional_flags=-mvsx"
2776 } elseif [test_compiler_info xlc*] {
2777 set compile_flags "additional_flags=-qasm=gcc"
2779 verbose "Could not compile with vsx support, returning 1" 2
2783 # Compile a test program containing VSX instructions.
2786 double a[2] = { 1.0, 2.0 };
2788 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2790 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2795 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2799 # No error message, compilation succeeded so now run it via gdb.
2803 gdb_reinitialize_dir $srcdir/$subdir
2807 -re ".*Illegal instruction.*${gdb_prompt} $" {
2808 verbose -log "\n$me VSX hardware not detected"
2809 set skip_vsx_tests 1
2811 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2812 verbose -log "\n$me: VSX hardware detected"
2813 set skip_vsx_tests 0
2816 warning "\n$me: default case taken"
2817 set skip_vsx_tests 1
2821 remote_file build delete $obj
2823 verbose "$me: returning $skip_vsx_tests" 2
2824 return $skip_vsx_tests
2827 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2828 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2830 gdb_caching_proc skip_tsx_tests {
2831 global srcdir subdir gdb_prompt inferior_exited_re
2833 set me "skip_tsx_tests"
2835 # Compile a test program.
2838 asm volatile ("xbegin .L0");
2839 asm volatile ("xend");
2840 asm volatile (".L0: nop");
2844 if {![gdb_simple_compile $me $src executable]} {
2848 # No error message, compilation succeeded so now run it via gdb.
2852 gdb_reinitialize_dir $srcdir/$subdir
2856 -re ".*Illegal instruction.*${gdb_prompt} $" {
2857 verbose -log "$me: TSX hardware not detected."
2858 set skip_tsx_tests 1
2860 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2861 verbose -log "$me: TSX hardware detected."
2862 set skip_tsx_tests 0
2865 warning "\n$me: default case taken."
2866 set skip_tsx_tests 1
2870 remote_file build delete $obj
2872 verbose "$me: returning $skip_tsx_tests" 2
2873 return $skip_tsx_tests
2876 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2877 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2879 gdb_caching_proc skip_btrace_tests {
2880 global srcdir subdir gdb_prompt inferior_exited_re
2882 set me "skip_btrace_tests"
2883 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2884 verbose "$me: target does not support btrace, returning 1" 2
2888 # Compile a test program.
2889 set src { int main() { return 0; } }
2890 if {![gdb_simple_compile $me $src executable]} {
2894 # No error message, compilation succeeded so now run it via gdb.
2898 gdb_reinitialize_dir $srcdir/$subdir
2903 # In case of an unexpected output, we return 2 as a fail value.
2904 set skip_btrace_tests 2
2905 gdb_test_multiple "record btrace" "check btrace support" {
2906 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2907 set skip_btrace_tests 1
2909 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2910 set skip_btrace_tests 1
2912 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2913 set skip_btrace_tests 1
2915 -re "^record btrace\r\n$gdb_prompt $" {
2916 set skip_btrace_tests 0
2920 remote_file build delete $obj
2922 verbose "$me: returning $skip_btrace_tests" 2
2923 return $skip_btrace_tests
2926 # Run a test on the target to see if it supports btrace pt hardware.
2927 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2928 # from the GCC testsuite.
2930 gdb_caching_proc skip_btrace_pt_tests {
2931 global srcdir subdir gdb_prompt inferior_exited_re
2933 set me "skip_btrace_tests"
2934 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2935 verbose "$me: target does not support btrace, returning 1" 2
2939 # Compile a test program.
2940 set src { int main() { return 0; } }
2941 if {![gdb_simple_compile $me $src executable]} {
2945 # No error message, compilation succeeded so now run it via gdb.
2949 gdb_reinitialize_dir $srcdir/$subdir
2954 # In case of an unexpected output, we return 2 as a fail value.
2955 set skip_btrace_tests 2
2956 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2957 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2958 set skip_btrace_tests 1
2960 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2961 set skip_btrace_tests 1
2963 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2964 set skip_btrace_tests 1
2966 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
2967 set skip_btrace_tests 1
2969 -re "^record btrace pt\r\n$gdb_prompt $" {
2970 set skip_btrace_tests 0
2974 remote_file build delete $obj
2976 verbose "$me: returning $skip_btrace_tests" 2
2977 return $skip_btrace_tests
2980 # Run a test on the target to see if it supports Aarch64 SVE hardware.
2981 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
2983 gdb_caching_proc skip_aarch64_sve_tests {
2984 global srcdir subdir gdb_prompt inferior_exited_re
2986 set me "skip_aarch64_sve_tests"
2988 if { ![is_aarch64_target]} {
2992 set compile_flags "{additional_flags=-march=armv8-a+sve}"
2994 # Compile a test program containing SVE instructions.
2997 asm volatile ("ptrue p0.b");
3001 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3005 # Compilation succeeded so now run it via gdb.
3009 -re ".*Illegal instruction.*${gdb_prompt} $" {
3010 verbose -log "\n$me sve hardware not detected"
3011 set skip_sve_tests 1
3013 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3014 verbose -log "\n$me: sve hardware detected"
3015 set skip_sve_tests 0
3018 warning "\n$me: default case taken"
3019 set skip_sve_tests 1
3023 remote_file build delete $obj
3025 verbose "$me: returning $skip_sve_tests" 2
3026 return $skip_sve_tests
3030 # A helper that compiles a test case to see if __int128 is supported.
3031 proc gdb_int128_helper {lang} {
3032 return [gdb_can_simple_compile "i128-for-$lang" {
3034 int main() { return 0; }
3038 # Return true if the C compiler understands the __int128 type.
3039 gdb_caching_proc has_int128_c {
3040 return [gdb_int128_helper c]
3043 # Return true if the C++ compiler understands the __int128 type.
3044 gdb_caching_proc has_int128_cxx {
3045 return [gdb_int128_helper c++]
3048 # Return true if the IFUNC feature is unsupported.
3049 gdb_caching_proc skip_ifunc_tests {
3050 if [gdb_can_simple_compile ifunc {
3052 typedef void F (void);
3053 F* g (void) { return &f_; }
3054 void f () __attribute__ ((ifunc ("g")));
3062 # Return whether we should skip tests for showing inlined functions in
3063 # backtraces. Requires get_compiler_info and get_debug_format.
3065 proc skip_inline_frame_tests {} {
3066 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3067 if { ! [test_debug_format "DWARF 2"] } {
3071 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
3072 if { ([test_compiler_info "gcc-2-*"]
3073 || [test_compiler_info "gcc-3-*"]
3074 || [test_compiler_info "gcc-4-0-*"]) } {
3081 # Return whether we should skip tests for showing variables from
3082 # inlined functions. Requires get_compiler_info and get_debug_format.
3084 proc skip_inline_var_tests {} {
3085 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3086 if { ! [test_debug_format "DWARF 2"] } {
3093 # Return a 1 if we should skip tests that require hardware breakpoints
3095 proc skip_hw_breakpoint_tests {} {
3096 # Skip tests if requested by the board (note that no_hardware_watchpoints
3097 # disables both watchpoints and breakpoints)
3098 if { [target_info exists gdb,no_hardware_watchpoints]} {
3102 # These targets support hardware breakpoints natively
3103 if { [istarget "i?86-*-*"]
3104 || [istarget "x86_64-*-*"]
3105 || [istarget "ia64-*-*"]
3106 || [istarget "arm*-*-*"]
3107 || [istarget "aarch64*-*-*"]
3108 || [istarget "s390*-*-*"] } {
3115 # Return a 1 if we should skip tests that require hardware watchpoints
3117 proc skip_hw_watchpoint_tests {} {
3118 # Skip tests if requested by the board
3119 if { [target_info exists gdb,no_hardware_watchpoints]} {
3123 # These targets support hardware watchpoints natively
3124 if { [istarget "i?86-*-*"]
3125 || [istarget "x86_64-*-*"]
3126 || [istarget "ia64-*-*"]
3127 || [istarget "arm*-*-*"]
3128 || [istarget "aarch64*-*-*"]
3129 || [istarget "powerpc*-*-linux*"]
3130 || [istarget "s390*-*-*"] } {
3137 # Return a 1 if we should skip tests that require *multiple* hardware
3138 # watchpoints to be active at the same time
3140 proc skip_hw_watchpoint_multi_tests {} {
3141 if { [skip_hw_watchpoint_tests] } {
3145 # These targets support just a single hardware watchpoint
3146 if { [istarget "arm*-*-*"]
3147 || [istarget "powerpc*-*-linux*"] } {
3154 # Return a 1 if we should skip tests that require read/access watchpoints
3156 proc skip_hw_watchpoint_access_tests {} {
3157 if { [skip_hw_watchpoint_tests] } {
3161 # These targets support just write watchpoints
3162 if { [istarget "s390*-*-*"] } {
3169 # Return 1 if we should skip tests that require the runtime unwinder
3170 # hook. This must be invoked while gdb is running, after shared
3171 # libraries have been loaded. This is needed because otherwise a
3172 # shared libgcc won't be visible.
3174 proc skip_unwinder_tests {} {
3178 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3179 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3181 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3184 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3188 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3189 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3192 -re "\r\n$gdb_prompt $" {
3199 # Return 1 if we should skip tests that require the libstdc++ stap
3200 # probes. This must be invoked while gdb is running, after shared
3201 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
3203 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
3205 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3206 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
3209 -re "\r\n$prompt_regexp" {
3212 set skip [expr !$supported]
3216 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
3218 proc skip_libstdcxx_probe_tests {} {
3220 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
3223 # Return 1 if we should skip tests of the "compile" feature.
3224 # This must be invoked after the inferior has been started.
3226 proc skip_compile_feature_tests {} {
3230 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3231 "Could not load libcc1.*\r\n$gdb_prompt $" {
3234 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3237 -re "\r\n$gdb_prompt $" {
3243 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3244 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3245 # is a regexp that will match the output of "maint print target-stack" if
3246 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3247 # matching the expected prompt after the command output.
3249 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3250 set test "probe for target ${target_name}"
3251 gdb_test_multiple "maint print target-stack" $test {
3252 -re "${target_stack_regexp}${prompt_regexp}" {
3256 -re "$prompt_regexp" {
3263 # Helper for gdb_is_target_remote where the expected prompt is variable.
3265 proc gdb_is_target_remote_prompt { prompt_regexp } {
3266 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3269 # Check whether we're testing with the remote or extended-remote
3272 proc gdb_is_target_remote { } {
3275 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3278 # Check whether we're testing with the native target.
3280 proc gdb_is_target_native { } {
3283 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3286 # Return the effective value of use_gdb_stub.
3288 # If the use_gdb_stub global has been set (it is set when the gdb process is
3289 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3290 # property from the board file.
3292 # This is the preferred way of checking use_gdb_stub, since it allows to check
3293 # the value before the gdb has been spawned and it will return the correct value
3294 # even when it was overriden by the test.
3296 proc use_gdb_stub {} {
3299 if [info exists use_gdb_stub] {
3300 return $use_gdb_stub
3303 return [target_info exists use_gdb_stub]
3306 # Return 1 if the current remote target is an instance of our GDBserver, 0
3307 # otherwise. Return -1 if there was an error and we can't tell.
3309 gdb_caching_proc target_is_gdbserver {
3313 set test "probing for GDBserver"
3315 gdb_test_multiple "monitor help" $test {
3316 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3319 -re "$gdb_prompt $" {
3324 if { $is_gdbserver == -1 } {
3325 verbose -log "Unable to tell whether we are using GDBserver or not."
3328 return $is_gdbserver
3331 # N.B. compiler_info is intended to be local to this file.
3332 # Call test_compiler_info with no arguments to fetch its value.
3333 # Yes, this is counterintuitive when there's get_compiler_info,
3334 # but that's the current API.
3335 if [info exists compiler_info] {
3341 # Figure out what compiler I am using.
3342 # The result is cached so only the first invocation runs the compiler.
3344 # ARG can be empty or "C++". If empty, "C" is assumed.
3346 # There are several ways to do this, with various problems.
3348 # [ gdb_compile -E $ifile -o $binfile.ci ]
3349 # source $binfile.ci
3351 # Single Unix Spec v3 says that "-E -o ..." together are not
3352 # specified. And in fact, the native compiler on hp-ux 11 (among
3353 # others) does not work with "-E -o ...". Most targets used to do
3354 # this, and it mostly worked, because it works with gcc.
3356 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3357 # source $binfile.ci
3359 # This avoids the problem with -E and -o together. This almost works
3360 # if the build machine is the same as the host machine, which is
3361 # usually true of the targets which are not gcc. But this code does
3362 # not figure which compiler to call, and it always ends up using the C
3363 # compiler. Not good for setting hp_aCC_compiler. Target
3364 # hppa*-*-hpux* used to do this.
3366 # [ gdb_compile -E $ifile > $binfile.ci ]
3367 # source $binfile.ci
3369 # dejagnu target_compile says that it supports output redirection,
3370 # but the code is completely different from the normal path and I
3371 # don't want to sweep the mines from that path. So I didn't even try
3374 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3377 # I actually do this for all targets now. gdb_compile runs the right
3378 # compiler, and TCL captures the output, and I eval the output.
3380 # Unfortunately, expect logs the output of the command as it goes by,
3381 # and dejagnu helpfully prints a second copy of it right afterwards.
3382 # So I turn off expect logging for a moment.
3384 # [ gdb_compile $ifile $ciexe_file executable $args ]
3385 # [ remote_exec $ciexe_file ]
3386 # [ source $ci_file.out ]
3388 # I could give up on -E and just do this.
3389 # I didn't get desperate enough to try this.
3391 # -- chastain 2004-01-06
3393 proc get_compiler_info {{arg ""}} {
3394 # For compiler.c and compiler.cc
3397 # I am going to play with the log to keep noise out.
3401 # These come from compiler.c or compiler.cc
3402 global compiler_info
3404 # Legacy global data symbols.
3407 if [info exists compiler_info] {
3412 # Choose which file to preprocess.
3413 set ifile "${srcdir}/lib/compiler.c"
3414 if { $arg == "c++" } {
3415 set ifile "${srcdir}/lib/compiler.cc"
3418 # Run $ifile through the right preprocessor.
3419 # Toggle gdb.log to keep the compiler output out of the log.
3420 set saved_log [log_file -info]
3422 if [is_remote host] {
3423 # We have to use -E and -o together, despite the comments
3424 # above, because of how DejaGnu handles remote host testing.
3425 set ppout "$outdir/compiler.i"
3426 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3427 set file [open $ppout r]
3428 set cppout [read $file]
3431 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3433 eval log_file $saved_log
3437 foreach cppline [ split "$cppout" "\n" ] {
3438 if { [ regexp "^#" "$cppline" ] } {
3440 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3442 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3444 verbose "get_compiler_info: $cppline" 2
3448 verbose -log "get_compiler_info: $cppline"
3453 # Set to unknown if for some reason compiler_info didn't get defined.
3454 if ![info exists compiler_info] {
3455 verbose -log "get_compiler_info: compiler_info not provided"
3456 set compiler_info "unknown"
3458 # Also set to unknown compiler if any diagnostics happened.
3460 verbose -log "get_compiler_info: got unexpected diagnostics"
3461 set compiler_info "unknown"
3464 # Set the legacy symbols.
3466 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3468 # Log what happened.
3469 verbose -log "get_compiler_info: $compiler_info"
3471 # Most compilers will evaluate comparisons and other boolean
3472 # operations to 0 or 1.
3473 uplevel \#0 { set true 1 }
3474 uplevel \#0 { set false 0 }
3479 # Return the compiler_info string if no arg is provided.
3480 # Otherwise the argument is a glob-style expression to match against
3483 proc test_compiler_info { {compiler ""} } {
3484 global compiler_info
3487 # If no arg, return the compiler_info string.
3488 if [string match "" $compiler] {
3489 return $compiler_info
3492 return [string match $compiler $compiler_info]
3495 proc current_target_name { } {
3497 if [info exists target_info(target,name)] {
3498 set answer $target_info(target,name)
3505 set gdb_wrapper_initialized 0
3506 set gdb_wrapper_target ""
3508 proc gdb_wrapper_init { args } {
3509 global gdb_wrapper_initialized
3510 global gdb_wrapper_file
3511 global gdb_wrapper_flags
3512 global gdb_wrapper_target
3514 if { $gdb_wrapper_initialized == 1 } { return; }
3516 if {[target_info exists needs_status_wrapper] && \
3517 [target_info needs_status_wrapper] != "0"} {
3518 set result [build_wrapper "testglue.o"]
3519 if { $result != "" } {
3520 set gdb_wrapper_file [lindex $result 0]
3521 set gdb_wrapper_flags [lindex $result 1]
3523 warning "Status wrapper failed to build."
3526 set gdb_wrapper_initialized 1
3527 set gdb_wrapper_target [current_target_name]
3530 # Determine options that we always want to pass to the compiler.
3531 gdb_caching_proc universal_compile_options {
3532 set me "universal_compile_options"
3535 set src [standard_temp_file ccopts[pid].c]
3536 set obj [standard_temp_file ccopts[pid].o]
3538 gdb_produce_source $src {
3539 int foo(void) { return 0; }
3542 # Try an option for disabling colored diagnostics. Some compilers
3543 # yield colored diagnostics by default (when run from a tty) unless
3544 # such an option is specified.
3545 set opt "additional_flags=-fdiagnostics-color=never"
3546 set lines [target_compile $src $obj object [list "quiet" $opt]]
3547 if [string match "" $lines] then {
3548 # Seems to have worked; use the option.
3549 lappend options $opt
3554 verbose "$me: returning $options" 2
3558 # Compile the code in $code to a file based on $name, using the flags
3559 # $compile_flag as well as debug, nowarning and quiet.
3560 # Return 1 if code can be compiled
3561 # Leave the file name of the resulting object in the upvar object.
3563 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3566 switch -regexp -- $type {
3580 set src [standard_temp_file $name-[pid].c]
3581 set obj [standard_temp_file $name-[pid].$postfix]
3582 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3584 gdb_produce_source $src $code
3586 verbose "$name: compiling testfile $src" 2
3587 set lines [gdb_compile $src $obj $type $compile_flags]
3591 if ![string match "" $lines] then {
3592 verbose "$name: compilation failed, returning 0" 2
3598 # Compile the code in $code to a file based on $name, using the flags
3599 # $compile_flag as well as debug, nowarning and quiet.
3600 # Return 1 if code can be compiled
3601 # Delete all created files and objects.
3603 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3604 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3605 file delete $temp_obj
3609 # Some targets need to always link a special object in. Save its path here.
3610 global gdb_saved_set_unbuffered_mode_obj
3611 set gdb_saved_set_unbuffered_mode_obj ""
3613 # Compile source files specified by SOURCE into a binary of type TYPE at path
3614 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3615 # parameter and most options are passed directly to it.
3617 # The type can be one of the following:
3619 # - object: Compile into an object file.
3620 # - executable: Compile and link into an executable.
3621 # - preprocess: Preprocess the source files.
3622 # - assembly: Generate assembly listing.
3624 # The following options are understood and processed by gdb_compile:
3626 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3627 # quirks to be able to use shared libraries.
3628 # - shlib_load: Link with appropriate libraries to allow the test to
3629 # dynamically load libraries at runtime. For example, on Linux, this adds
3630 # -ldl so that the test can use dlopen.
3631 # - nowarnings: Inhibit all compiler warnings.
3632 # - pie: Force creation of PIE executables.
3633 # - nopie: Prevent creation of PIE executables.
3635 # And here are some of the not too obscure options understood by DejaGnu that
3636 # influence the compilation:
3638 # - additional_flags=flag: Add FLAG to the compiler flags.
3639 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3640 # argument can be a file, in which case it's added to the sources, or a
3642 # - ldflags=flag: Add FLAG to the linker flags.
3643 # - incdir=path: Add PATH to the searched include directories.
3644 # - libdir=path: Add PATH to the linker searched directories.
3645 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3646 # - debug: Build with debug information.
3647 # - optimize: Build with optimization.
3649 proc gdb_compile {source dest type options} {
3650 global GDB_TESTCASE_OPTIONS
3651 global gdb_wrapper_file
3652 global gdb_wrapper_flags
3653 global gdb_wrapper_initialized
3656 global gdb_saved_set_unbuffered_mode_obj
3658 set outdir [file dirname $dest]
3660 # Add platform-specific options if a shared library was specified using
3661 # "shlib=librarypath" in OPTIONS.
3663 if {[lsearch -exact $options rust] != -1} {
3664 # -fdiagnostics-color is not a rustcc option.
3666 set new_options [universal_compile_options]
3670 set getting_compiler_info 0
3671 foreach opt $options {
3672 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3673 && $type == "executable"} {
3674 if [test_compiler_info "xlc-*"] {
3675 # IBM xlc compiler doesn't accept shared library named other
3676 # than .so: use "-Wl," to bypass this
3677 lappend source "-Wl,$shlib_name"
3678 } elseif { ([istarget "*-*-mingw*"]
3679 || [istarget *-*-cygwin*]
3680 || [istarget *-*-pe*])} {
3681 lappend source "${shlib_name}.a"
3683 lappend source $shlib_name
3685 if { $shlib_found == 0 } {
3687 if { ([istarget "*-*-mingw*"]
3688 || [istarget *-*-cygwin*]) } {
3689 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3691 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3692 # Undo debian's change in the default.
3693 # Put it at the front to not override any user-provided
3694 # value, and to make sure it appears in front of all the
3696 lappend new_options "early_flags=-Wl,--no-as-needed"
3699 } elseif { $opt == "shlib_load" && $type == "executable" } {
3701 } elseif { $opt == "getting_compiler_info" } {
3702 # If this is set, calling test_compiler_info will cause recursion.
3703 set getting_compiler_info 1
3705 lappend new_options $opt
3709 # Ensure stack protector is disabled for GCC, as this causes problems with
3710 # DWARF line numbering.
3711 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3712 # This option defaults to on for Debian/Ubuntu.
3713 if { $getting_compiler_info == 0
3714 && [test_compiler_info {gcc-*-*}]
3715 && !([test_compiler_info {gcc-[0-3]-*}]
3716 || [test_compiler_info {gcc-4-0-*}])
3717 && [lsearch -exact $options rust] == -1} {
3718 # Put it at the front to not override any user-provided value.
3719 lappend new_options "early_flags=-fno-stack-protector"
3722 # Because we link with libraries using their basename, we may need
3723 # (depending on the platform) to set a special rpath value, to allow
3724 # the executable to find the libraries it depends on.
3725 if { $shlib_load || $shlib_found } {
3726 if { ([istarget "*-*-mingw*"]
3727 || [istarget *-*-cygwin*]
3728 || [istarget *-*-pe*]) } {
3729 # Do not need anything.
3730 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3731 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3732 } elseif { [istarget arm*-*-symbianelf*] } {
3733 if { $shlib_load } {
3734 lappend new_options "libs=-ldl"
3737 if { $shlib_load } {
3738 lappend new_options "libs=-ldl"
3740 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3743 set options $new_options
3745 if [info exists GDB_TESTCASE_OPTIONS] {
3746 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3748 verbose "options are $options"
3749 verbose "source is $source $dest $type $options"
3751 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3753 if {[target_info exists needs_status_wrapper] && \
3754 [target_info needs_status_wrapper] != "0" && \
3755 [info exists gdb_wrapper_file]} {
3756 lappend options "libs=${gdb_wrapper_file}"
3757 lappend options "ldflags=${gdb_wrapper_flags}"
3760 # Replace the "nowarnings" option with the appropriate additional_flags
3761 # to disable compiler warnings.
3762 set nowarnings [lsearch -exact $options nowarnings]
3763 if {$nowarnings != -1} {
3764 if [target_info exists gdb,nowarnings_flag] {
3765 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3767 set flag "additional_flags=-w"
3769 set options [lreplace $options $nowarnings $nowarnings $flag]
3772 # Replace the "pie" option with the appropriate compiler and linker flags
3773 # to enable PIE executables.
3774 set pie [lsearch -exact $options pie]
3776 if [target_info exists gdb,pie_flag] {
3777 set flag "additional_flags=[target_info gdb,pie_flag]"
3779 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3780 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3781 # a maximum size. On other architectures the two flags are
3782 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3783 # onwards default GCC to using fPIE. If you do require fpie, then
3784 # it can be set using the pie_flag.
3785 set flag "additional_flags=-fPIE"
3787 set options [lreplace $options $pie $pie $flag]
3789 if [target_info exists gdb,pie_ldflag] {
3790 set flag "ldflags=[target_info gdb,pie_ldflag]"
3792 set flag "ldflags=-pie"
3794 lappend options "$flag"
3797 # Replace the "nopie" option with the appropriate linker flag to disable
3798 # PIE executables. There are no compiler flags for this option.
3799 set nopie [lsearch -exact $options nopie]
3801 if [target_info exists gdb,nopie_flag] {
3802 set flag "ldflags=[target_info gdb,nopie_flag]"
3804 set flag "ldflags=-no-pie"
3806 set options [lreplace $options $nopie $nopie $flag]
3809 if { $type == "executable" } {
3810 if { ([istarget "*-*-mingw*"]
3811 || [istarget "*-*-*djgpp"]
3812 || [istarget "*-*-cygwin*"])} {
3813 # Force output to unbuffered mode, by linking in an object file
3814 # with a global contructor that calls setvbuf.
3816 # Compile the special object seperatelly for two reasons:
3817 # 1) Insulate it from $options.
3818 # 2) Avoid compiling it for every gdb_compile invocation,
3819 # which is time consuming, especially if we're remote
3822 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3823 verbose "compiling gdb_saved_set_unbuffered_obj"
3824 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3825 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3827 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3828 if { $result != "" } {
3831 if {[is_remote host]} {
3832 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3834 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3836 # Link a copy of the output object, because the
3837 # original may be automatically deleted.
3838 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3840 verbose "gdb_saved_set_unbuffered_obj already compiled"
3843 # Rely on the internal knowledge that the global ctors are ran in
3844 # reverse link order. In that case, we can use ldflags to
3845 # avoid copying the object file to the host multiple
3847 # This object can only be added if standard libraries are
3848 # used. Thus, we need to disable it if -nostdlib option is used
3849 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3850 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3855 set result [target_compile $source $dest $type $options]
3857 # Prune uninteresting compiler (and linker) output.
3858 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3860 regsub "\[\r\n\]*$" "$result" "" result
3861 regsub "^\[\r\n\]*" "$result" "" result
3863 if { $type == "executable" && $result == "" \
3864 && ($nopie != -1 || $pie != -1) } {
3865 set is_pie [exec_is_pie "$dest"]
3866 if { $nopie != -1 && $is_pie == 1 } {
3867 set result "nopie failed to prevent PIE executable"
3868 } elseif { $pie != -1 && $is_pie == 0 } {
3869 set result "pie failed to generate PIE executable"
3873 if {[lsearch $options quiet] < 0} {
3874 # We shall update this on a per language basis, to avoid
3875 # changing the entire testsuite in one go.
3876 if {[lsearch $options f77] >= 0} {
3877 gdb_compile_test $source $result
3878 } elseif { $result != "" } {
3879 clone_output "gdb compile failed, $result"
3886 # This is just like gdb_compile, above, except that it tries compiling
3887 # against several different thread libraries, to see which one this
3889 proc gdb_compile_pthreads {source dest type options} {
3891 set why_msg "unrecognized error"
3892 foreach lib {-lpthreads -lpthread -lthread ""} {
3893 # This kind of wipes out whatever libs the caller may have
3894 # set. Or maybe theirs will override ours. How infelicitous.
3895 set options_with_lib [concat $options [list libs=$lib quiet]]
3896 set ccout [gdb_compile $source $dest $type $options_with_lib]
3897 switch -regexp -- $ccout {
3898 ".*no posix threads support.*" {
3899 set why_msg "missing threads include file"
3902 ".*cannot open -lpthread.*" {
3903 set why_msg "missing runtime threads library"
3905 ".*Can't find library for -lpthread.*" {
3906 set why_msg "missing runtime threads library"
3909 pass "successfully compiled posix threads test case"
3915 if {!$built_binfile} {
3916 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3921 # Build a shared library from SOURCES.
3923 proc gdb_compile_shlib {sources dest options} {
3924 set obj_options $options
3927 if { [lsearch -exact $options "c++"] >= 0 } {
3928 set info_options "c++"
3930 if [get_compiler_info ${info_options}] {
3934 switch -glob [test_compiler_info] {
3936 lappend obj_options "additional_flags=-qpic"
3939 if { !([istarget "*-*-cygwin*"]
3940 || [istarget "*-*-mingw*"]) } {
3941 lappend obj_options "additional_flags=-fpic"
3945 if { !([istarget "powerpc*-*-aix*"]
3946 || [istarget "rs6000*-*-aix*"]
3947 || [istarget "*-*-cygwin*"]
3948 || [istarget "*-*-mingw*"]
3949 || [istarget "*-*-pe*"]) } {
3950 lappend obj_options "additional_flags=-fpic"
3954 lappend obj_options "additional_flags=-fpic"
3957 # don't know what the compiler is...
3961 set outdir [file dirname $dest]
3963 foreach source $sources {
3964 set sourcebase [file tail $source]
3965 if {[file extension $source] == ".o"} {
3966 # Already a .o file.
3967 lappend objects $source
3968 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
3969 $obj_options] != ""} {
3972 lappend objects ${outdir}/${sourcebase}.o
3976 set link_options $options
3977 if [test_compiler_info "xlc-*"] {
3978 lappend link_options "additional_flags=-qmkshrobj"
3980 lappend link_options "additional_flags=-shared"
3982 if { ([istarget "*-*-mingw*"]
3983 || [istarget *-*-cygwin*]
3984 || [istarget *-*-pe*]) } {
3985 if { [is_remote host] } {
3986 set name [file tail ${dest}]
3990 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3992 # Set the soname of the library. This causes the linker on ELF
3993 # systems to create the DT_NEEDED entry in the executable referring
3994 # to the soname of the library, and not its absolute path. This
3995 # (using the absolute path) would be problem when testing on a
3998 # In conjunction with setting the soname, we add the special
3999 # rpath=$ORIGIN value when building the executable, so that it's
4000 # able to find the library in its own directory.
4001 set destbase [file tail $dest]
4002 lappend link_options "additional_flags=-Wl,-soname,$destbase"
4005 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
4008 if { [is_remote host]
4009 && ([istarget "*-*-mingw*"]
4010 || [istarget *-*-cygwin*]
4011 || [istarget *-*-pe*]) } {
4012 set dest_tail_name [file tail ${dest}]
4013 remote_upload host $dest_tail_name.a ${dest}.a
4014 remote_file host delete $dest_tail_name.a
4020 # This is just like gdb_compile_shlib, above, except that it tries compiling
4021 # against several different thread libraries, to see which one this
4023 proc gdb_compile_shlib_pthreads {sources dest options} {
4025 set why_msg "unrecognized error"
4026 foreach lib {-lpthreads -lpthread -lthread ""} {
4027 # This kind of wipes out whatever libs the caller may have
4028 # set. Or maybe theirs will override ours. How infelicitous.
4029 set options_with_lib [concat $options [list libs=$lib quiet]]
4030 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
4031 switch -regexp -- $ccout {
4032 ".*no posix threads support.*" {
4033 set why_msg "missing threads include file"
4036 ".*cannot open -lpthread.*" {
4037 set why_msg "missing runtime threads library"
4039 ".*Can't find library for -lpthread.*" {
4040 set why_msg "missing runtime threads library"
4043 pass "successfully compiled posix threads test case"
4049 if {!$built_binfile} {
4050 unsupported "couldn't compile $sources: ${why_msg}"
4055 # This is just like gdb_compile_pthreads, above, except that we always add the
4056 # objc library for compiling Objective-C programs
4057 proc gdb_compile_objc {source dest type options} {
4059 set why_msg "unrecognized error"
4060 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
4061 # This kind of wipes out whatever libs the caller may have
4062 # set. Or maybe theirs will override ours. How infelicitous.
4063 if { $lib == "solaris" } {
4064 set lib "-lpthread -lposix4"
4066 if { $lib != "-lobjc" } {
4067 set lib "-lobjc $lib"
4069 set options_with_lib [concat $options [list libs=$lib quiet]]
4070 set ccout [gdb_compile $source $dest $type $options_with_lib]
4071 switch -regexp -- $ccout {
4072 ".*no posix threads support.*" {
4073 set why_msg "missing threads include file"
4076 ".*cannot open -lpthread.*" {
4077 set why_msg "missing runtime threads library"
4079 ".*Can't find library for -lpthread.*" {
4080 set why_msg "missing runtime threads library"
4083 pass "successfully compiled objc with posix threads test case"
4089 if {!$built_binfile} {
4090 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4095 # Send a command to GDB.
4096 # For options for TYPE see gdb_stdin_log_write
4098 proc send_gdb { string {type standard}} {
4099 global suppress_flag
4100 if { $suppress_flag } {
4103 gdb_stdin_log_write $string $type
4104 return [remote_send host "$string"]
4107 # Send STRING to the inferior's terminal.
4109 proc send_inferior { string } {
4110 global inferior_spawn_id
4112 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
4122 proc gdb_expect { args } {
4123 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4124 set atimeout [lindex $args 0]
4125 set expcode [list [lindex $args 1]]
4130 # A timeout argument takes precedence, otherwise of all the timeouts
4131 # select the largest.
4132 if [info exists atimeout] {
4135 set tmt [get_largest_timeout]
4138 global suppress_flag
4139 global remote_suppress_flag
4140 if [info exists remote_suppress_flag] {
4141 set old_val $remote_suppress_flag
4143 if [info exists suppress_flag] {
4144 if { $suppress_flag } {
4145 set remote_suppress_flag 1
4149 {uplevel remote_expect host $tmt $expcode} string]
4150 if [info exists old_val] {
4151 set remote_suppress_flag $old_val
4153 if [info exists remote_suppress_flag] {
4154 unset remote_suppress_flag
4159 global errorInfo errorCode
4161 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4163 return -code $code $string
4167 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4169 # Check for long sequence of output by parts.
4170 # TEST: is the test message to be printed with the test success/fail.
4171 # SENTINEL: Is the terminal pattern indicating that output has finished.
4172 # LIST: is the sequence of outputs to match.
4173 # If the sentinel is recognized early, it is considered an error.
4176 # 1 if the test failed,
4177 # 0 if the test passes,
4178 # -1 if there was an internal error.
4180 proc gdb_expect_list {test sentinel list} {
4182 global suppress_flag
4185 if { $suppress_flag } {
4187 unresolved "${test}"
4189 while { ${index} < [llength ${list}] } {
4190 set pattern [lindex ${list} ${index}]
4191 set index [expr ${index} + 1]
4192 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4193 if { ${index} == [llength ${list}] } {
4196 -re "${pattern}${sentinel}" {
4197 # pass "${test}, pattern ${index} + sentinel"
4200 fail "${test} (pattern ${index} + sentinel)"
4203 -re ".*A problem internal to GDB has been detected" {
4204 fail "${test} (GDB internal error)"
4206 gdb_internal_error_resync
4209 fail "${test} (pattern ${index} + sentinel) (timeout)"
4214 # unresolved "${test}, pattern ${index} + sentinel"
4220 # pass "${test}, pattern ${index}"
4223 fail "${test} (pattern ${index})"
4226 -re ".*A problem internal to GDB has been detected" {
4227 fail "${test} (GDB internal error)"
4229 gdb_internal_error_resync
4232 fail "${test} (pattern ${index}) (timeout)"
4237 # unresolved "${test}, pattern ${index}"
4251 proc gdb_suppress_entire_file { reason } {
4252 global suppress_flag
4255 set suppress_flag -1
4259 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4260 # gdb_expect to fail immediately (until the next call to
4261 # gdb_stop_suppressing_tests).
4263 proc gdb_suppress_tests { args } {
4264 global suppress_flag
4266 return; # fnf - disable pending review of results where
4267 # testsuite ran better without this
4270 if { $suppress_flag == 1 } {
4271 if { [llength $args] > 0 } {
4272 warning "[lindex $args 0]\n"
4274 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4280 # Clear suppress_flag.
4282 proc gdb_stop_suppressing_tests { } {
4283 global suppress_flag
4285 if [info exists suppress_flag] {
4286 if { $suppress_flag > 0 } {
4288 clone_output "Tests restarted.\n"
4295 proc gdb_clear_suppressed { } {
4296 global suppress_flag
4301 # Spawn the gdb process.
4303 # This doesn't expect any output or do any other initialization,
4304 # leaving those to the caller.
4306 # Overridable function -- you can override this function in your
4309 proc gdb_spawn { } {
4313 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4315 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4318 set saved_gdbflags $GDBFLAGS
4320 if {$GDBFLAGS != ""} {
4323 append GDBFLAGS $cmdline_flags
4327 set GDBFLAGS $saved_gdbflags
4332 # Start gdb running, wait for prompt, and disable the pagers.
4334 # Overridable function -- you can override this function in your
4337 proc gdb_start { } {
4342 catch default_gdb_exit
4345 # Return true if we can spawn a program on the target and attach to
4348 proc can_spawn_for_attach { } {
4349 # We use exp_pid to get the inferior's pid, assuming that gives
4350 # back the pid of the program. On remote boards, that would give
4351 # us instead the PID of e.g., the ssh client, etc.
4352 if [is_remote target] then {
4356 # The "attach" command doesn't make sense when the target is
4357 # stub-like, where GDB finds the program already started on
4358 # initial connection.
4359 if {[target_info exists use_gdb_stub]} {
4367 # Kill a progress previously started with spawn_wait_for_attach, and
4368 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4371 proc kill_wait_spawned_process { proc_spawn_id } {
4372 set pid [exp_pid -i $proc_spawn_id]
4374 verbose -log "killing ${pid}"
4375 remote_exec build "kill -9 ${pid}"
4377 verbose -log "closing ${proc_spawn_id}"
4378 catch "close -i $proc_spawn_id"
4379 verbose -log "waiting for ${proc_spawn_id}"
4381 # If somehow GDB ends up still attached to the process here, a
4382 # blocking wait hangs until gdb is killed (or until gdb / the
4383 # ptracer reaps the exit status too, but that won't happen because
4384 # something went wrong.) Passing -nowait makes expect tell Tcl to
4385 # wait for the PID in the background. That's fine because we
4386 # don't care about the exit status. */
4387 wait -nowait -i $proc_spawn_id
4390 # Returns the process id corresponding to the given spawn id.
4392 proc spawn_id_get_pid { spawn_id } {
4393 set testpid [exp_pid -i $spawn_id]
4395 if { [istarget "*-*-cygwin*"] } {
4396 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4397 # might be different due to the way fork/exec works.
4398 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4404 # Start a set of programs running and then wait for a bit, to be sure
4405 # that they can be attached to. Return a list of processes spawn IDs,
4406 # one element for each process spawned. It's a test error to call
4407 # this when [can_spawn_for_attach] is false.
4409 proc spawn_wait_for_attach { executable_list } {
4410 set spawn_id_list {}
4412 if ![can_spawn_for_attach] {
4413 # The caller should have checked can_spawn_for_attach itself
4414 # before getting here.
4415 error "can't spawn for attach with this target/board"
4418 foreach {executable} $executable_list {
4419 # Note we use Expect's spawn, not Tcl's exec, because with
4420 # spawn we control when to wait for/reap the process. That
4421 # allows killing the process by PID without being subject to
4423 lappend spawn_id_list [remote_spawn target $executable]
4428 return $spawn_id_list
4432 # gdb_load_cmd -- load a file into the debugger.
4433 # ARGS - additional args to load command.
4434 # return a -1 if anything goes wrong.
4436 proc gdb_load_cmd { args } {
4439 if [target_info exists gdb_load_timeout] {
4440 set loadtimeout [target_info gdb_load_timeout]
4442 set loadtimeout 1600
4444 send_gdb "load $args\n"
4445 verbose "Timeout is now $loadtimeout seconds" 2
4446 gdb_expect $loadtimeout {
4447 -re "Loading section\[^\r\]*\r\n" {
4450 -re "Start address\[\r\]*\r\n" {
4453 -re "Transfer rate\[\r\]*\r\n" {
4456 -re "Memory access error\[^\r\]*\r\n" {
4457 perror "Failed to load program"
4460 -re "$gdb_prompt $" {
4463 -re "(.*)\r\n$gdb_prompt " {
4464 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4468 perror "Timed out trying to load $args."
4475 # Invoke "gcore". CORE is the name of the core file to write. TEST
4476 # is the name of the test case. This will return 1 if the core file
4477 # was created, 0 otherwise. If this fails to make a core file because
4478 # this configuration of gdb does not support making core files, it
4479 # will call "unsupported", not "fail". However, if this fails to make
4480 # a core file for some other reason, then it will call "fail".
4482 proc gdb_gcore_cmd {core test} {
4486 gdb_test_multiple "gcore $core" $test {
4487 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4491 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4499 # Load core file CORE. TEST is the name of the test case.
4500 # This will record a pass/fail for loading the core file.
4502 # 1 - core file is successfully loaded
4503 # 0 - core file loaded but has a non fatal error
4504 # -1 - core file failed to load
4506 proc gdb_core_cmd { core test } {
4509 gdb_test_multiple "core $core" "$test" {
4510 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4513 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4514 fail "$test (bad file format)"
4517 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4518 fail "$test (file not found)"
4521 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4522 fail "$test (incomplete note section)"
4525 -re "Core was generated by .*\r\n$gdb_prompt $" {
4529 -re ".*$gdb_prompt $" {
4534 fail "$test (timeout)"
4538 fail "unsupported output from 'core' command"
4542 # Return the filename to download to the target and load on the target
4543 # for this shared library. Normally just LIBNAME, unless shared libraries
4544 # for this target have separate link and load images.
4546 proc shlib_target_file { libname } {
4550 # Return the filename GDB will load symbols from when debugging this
4551 # shared library. Normally just LIBNAME, unless shared libraries for
4552 # this target have separate link and load images.
4554 proc shlib_symbol_file { libname } {
4558 # Return the filename to download to the target and load for this
4559 # executable. Normally just BINFILE unless it is renamed to something
4560 # else for this target.
4562 proc exec_target_file { binfile } {
4566 # Return the filename GDB will load symbols from when debugging this
4567 # executable. Normally just BINFILE unless executables for this target
4568 # have separate files for symbols.
4570 proc exec_symbol_file { binfile } {
4574 # Rename the executable file. Normally this is just BINFILE1 being renamed
4575 # to BINFILE2, but some targets require multiple binary files.
4576 proc gdb_rename_execfile { binfile1 binfile2 } {
4577 file rename -force [exec_target_file ${binfile1}] \
4578 [exec_target_file ${binfile2}]
4579 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4580 file rename -force [exec_symbol_file ${binfile1}] \
4581 [exec_symbol_file ${binfile2}]
4585 # "Touch" the executable file to update the date. Normally this is just
4586 # BINFILE, but some targets require multiple files.
4587 proc gdb_touch_execfile { binfile } {
4588 set time [clock seconds]
4589 file mtime [exec_target_file ${binfile}] $time
4590 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4591 file mtime [exec_symbol_file ${binfile}] $time
4595 # Like remote_download but provides a gdb-specific behavior.
4597 # If the destination board is remote, the local file FROMFILE is transferred as
4598 # usual with remote_download to TOFILE on the remote board. The destination
4599 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4602 # If the destination board is local, the destination path TOFILE is passed
4603 # through standard_output_file, and FROMFILE is copied there.
4605 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4608 proc gdb_remote_download {dest fromfile {tofile {}}} {
4609 # If TOFILE is not given, default to the same filename as FROMFILE.
4610 if {[string length $tofile] == 0} {
4611 set tofile [file tail $fromfile]
4614 if {[is_remote $dest]} {
4615 # When the DEST is remote, we simply send the file to DEST.
4618 set destname [remote_download $dest $fromfile $tofile]
4619 lappend cleanfiles $destname
4623 # When the DEST is local, we copy the file to the test directory (where
4624 # the executable is).
4626 # Note that we pass TOFILE through standard_output_file, regardless of
4627 # whether it is absolute or relative, because we don't want the tests
4628 # to be able to write outside their standard output directory.
4630 set tofile [standard_output_file $tofile]
4632 file copy -force $fromfile $tofile
4638 # gdb_load_shlib LIB...
4640 # Copy the listed library to the target.
4642 proc gdb_load_shlib { file } {
4645 if ![info exists gdb_spawn_id] {
4646 perror "gdb_load_shlib: GDB is not running"
4649 set dest [gdb_remote_download target [shlib_target_file $file]]
4651 if {[is_remote target]} {
4652 # If the target is remote, we need to tell gdb where to find the
4655 # We could set this even when not testing remotely, but a user
4656 # generally won't set it unless necessary. In order to make the tests
4657 # more like the real-life scenarios, we don't set it for local testing.
4658 gdb_test "set solib-search-path [file dirname $file]" "" ""
4665 # gdb_load -- load a file into the debugger. Specifying no file
4666 # defaults to the executable currently being debugged.
4667 # The return value is 0 for success, -1 for failure.
4668 # Many files in config/*.exp override this procedure.
4670 proc gdb_load { arg } {
4672 return [gdb_file_cmd $arg]
4677 # gdb_reload -- load a file into the target. Called before "running",
4678 # either the first time or after already starting the program once,
4679 # for remote targets. Most files that override gdb_load should now
4680 # override this instead.
4682 proc gdb_reload { } {
4683 # For the benefit of existing configurations, default to gdb_load.
4684 # Specifying no file defaults to the executable currently being
4686 return [gdb_load ""]
4689 proc gdb_continue { function } {
4692 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4695 proc default_gdb_init { test_file_name } {
4696 global gdb_wrapper_initialized
4697 global gdb_wrapper_target
4698 global gdb_test_file_name
4704 gdb_clear_suppressed
4706 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4708 # Make sure that the wrapper is rebuilt
4709 # with the appropriate multilib option.
4710 if { $gdb_wrapper_target != [current_target_name] } {
4711 set gdb_wrapper_initialized 0
4714 # Unlike most tests, we have a small number of tests that generate
4715 # a very large amount of output. We therefore increase the expect
4716 # buffer size to be able to contain the entire test output. This
4717 # is especially needed by gdb.base/info-macros.exp.
4719 # Also set this value for the currently running GDB.
4720 match_max [match_max -d]
4722 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4723 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4726 if [target_info exists gdb_prompt] {
4727 set gdb_prompt [target_info gdb_prompt]
4729 set gdb_prompt "\\(gdb\\)"
4732 if [info exists use_gdb_stub] {
4737 # Return a path using GDB_PARALLEL.
4738 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4739 # GDB_PARALLEL must be defined, the caller must check.
4741 # The default value for GDB_PARALLEL is, canonically, ".".
4742 # The catch is that tests don't expect an additional "./" in file paths so
4743 # omit any directory for the default case.
4744 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4745 # its special handling.
4747 proc make_gdb_parallel_path { args } {
4748 global GDB_PARALLEL objdir
4749 set joiner [list "file" "join" $objdir]
4750 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4751 lappend joiner $GDB_PARALLEL
4753 set joiner [concat $joiner $args]
4754 return [eval $joiner]
4757 # Turn BASENAME into a full file name in the standard output
4758 # directory. It is ok if BASENAME is the empty string; in this case
4759 # the directory is returned.
4761 proc standard_output_file {basename} {
4762 global objdir subdir gdb_test_file_name
4764 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4766 # If running on MinGW, replace /c/foo with c:/foo
4767 if { [ishost *-*-mingw*] } {
4768 set dir [regsub {^/([a-z])/} $dir {\1:/}]
4770 return [file join $dir $basename]
4773 # Turn BASENAME into a full file name in the standard output directory. If
4774 # GDB has been launched more than once then append the count, starting with
4777 proc standard_output_file_with_gdb_instance {basename} {
4778 global gdb_instances
4779 set count [expr $gdb_instances - 1 ]
4782 return [standard_output_file $basename]
4784 return [standard_output_file ${basename}.${count}]
4787 # Return the name of a file in our standard temporary directory.
4789 proc standard_temp_file {basename} {
4790 # Since a particular runtest invocation is only executing a single test
4791 # file at any given time, we can use the runtest pid to build the
4792 # path of the temp directory.
4793 set dir [make_gdb_parallel_path temp [pid]]
4795 return [file join $dir $basename]
4798 # Set 'testfile', 'srcfile', and 'binfile'.
4800 # ARGS is a list of source file specifications.
4801 # Without any arguments, the .exp file's base name is used to
4802 # compute the source file name. The ".c" extension is added in this case.
4803 # If ARGS is not empty, each entry is a source file specification.
4804 # If the specification starts with a ".", it is treated as a suffix
4805 # to append to the .exp file's base name.
4806 # If the specification is the empty string, it is treated as if it
4808 # Otherwise it is a file name.
4809 # The first file in the list is used to set the 'srcfile' global.
4810 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4812 # Most tests should call this without arguments.
4814 # If a completely different binary file name is needed, then it
4815 # should be handled in the .exp file with a suitable comment.
4817 proc standard_testfile {args} {
4818 global gdb_test_file_name
4820 global gdb_test_file_last_vars
4823 global testfile binfile
4825 set testfile $gdb_test_file_name
4826 set binfile [standard_output_file ${testfile}]
4828 if {[llength $args] == 0} {
4832 # Unset our previous output variables.
4833 # This can help catch hidden bugs.
4834 if {[info exists gdb_test_file_last_vars]} {
4835 foreach varname $gdb_test_file_last_vars {
4837 catch {unset $varname}
4840 # 'executable' is often set by tests.
4841 set gdb_test_file_last_vars {executable}
4845 set varname srcfile$suffix
4848 # Handle an extension.
4851 } elseif {[string range $arg 0 0] == "."} {
4852 set arg $testfile$arg
4856 lappend gdb_test_file_last_vars $varname
4858 if {$suffix == ""} {
4866 # The default timeout used when testing GDB commands. We want to use
4867 # the same timeout as the default dejagnu timeout, unless the user has
4868 # already provided a specific value (probably through a site.exp file).
4869 global gdb_test_timeout
4870 if ![info exists gdb_test_timeout] {
4871 set gdb_test_timeout $timeout
4874 # A list of global variables that GDB testcases should not use.
4875 # We try to prevent their use by monitoring write accesses and raising
4876 # an error when that happens.
4877 set banned_variables { bug_id prms_id }
4879 # A list of procedures that GDB testcases should not use.
4880 # We try to prevent their use by monitoring invocations and raising
4881 # an error when that happens.
4882 set banned_procedures { strace }
4884 # gdb_init is called by runtest at start, but also by several
4885 # tests directly; gdb_finish is only called from within runtest after
4886 # each test source execution.
4887 # Placing several traces by repetitive calls to gdb_init leads
4888 # to problems, as only one trace is removed in gdb_finish.
4889 # To overcome this possible problem, we add a variable that records
4890 # if the banned variables and procedures are already traced.
4893 proc gdb_init { test_file_name } {
4894 # Reset the timeout value to the default. This way, any testcase
4895 # that changes the timeout value without resetting it cannot affect
4896 # the timeout used in subsequent testcases.
4897 global gdb_test_timeout
4899 set timeout $gdb_test_timeout
4901 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4902 && [target_info exists gdb_reverse_timeout] } {
4903 set timeout [target_info gdb_reverse_timeout]
4906 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4907 # debugging tool to help confirm that the test suite is
4908 # parallel-safe. You need "inotifywait" from the
4909 # inotify-tools package to use this.
4910 global GDB_INOTIFY inotify_pid
4911 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4912 global outdir tool inotify_log_file
4914 set exclusions {outputs temp gdb[.](log|sum) cache}
4915 set exclusion_re ([join $exclusions |])
4917 set inotify_log_file [standard_temp_file inotify.out]
4918 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4919 --exclude $exclusion_re \
4920 |& tee -a $outdir/$tool.log $inotify_log_file &]
4922 # Wait for the watches; hopefully this is long enough.
4925 # Clear the log so that we don't emit a warning the first time
4927 set fd [open $inotify_log_file w]
4931 # Block writes to all banned variables, and invocation of all
4932 # banned procedures...
4933 global banned_variables
4934 global banned_procedures
4935 global banned_traced
4936 if (!$banned_traced) {
4937 foreach banned_var $banned_variables {
4938 global "$banned_var"
4939 trace add variable "$banned_var" write error
4941 foreach banned_proc $banned_procedures {
4942 global "$banned_proc"
4943 trace add execution "$banned_proc" enter error
4948 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4949 # messages as expected.
4954 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4955 # the test results. Even if /dev/null doesn't exist on the particular
4956 # platform, the readline library will use the default setting just by
4957 # failing to open the file. OTOH, opening /dev/null successfully will
4958 # also result in the default settings being used since nothing will be
4959 # read from this file.
4960 setenv INPUTRC "/dev/null"
4962 # This disables style output, which would interfere with many
4966 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
4967 # during startup. See "man expect" for details about stty_init.
4969 set stty_init "rows 25 cols 80"
4971 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4972 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4973 # especially having color output turned on can cause tests to fail.
4974 setenv GREP_OPTIONS ""
4976 # Clear $gdbserver_reconnect_p.
4977 global gdbserver_reconnect_p
4978 set gdbserver_reconnect_p 1
4979 unset gdbserver_reconnect_p
4981 # Reset GDB number of instances
4982 global gdb_instances
4985 return [default_gdb_init $test_file_name]
4988 proc gdb_finish { } {
4989 global gdbserver_reconnect_p
4993 # Exit first, so that the files are no longer in use.
4996 if { [llength $cleanfiles] > 0 } {
4997 eval remote_file target delete $cleanfiles
5001 # Unblock write access to the banned variables. Dejagnu typically
5002 # resets some of them between testcases.
5003 global banned_variables
5004 global banned_procedures
5005 global banned_traced
5006 if ($banned_traced) {
5007 foreach banned_var $banned_variables {
5008 global "$banned_var"
5009 trace remove variable "$banned_var" write error
5011 foreach banned_proc $banned_procedures {
5012 global "$banned_proc"
5013 trace remove execution "$banned_proc" enter error
5020 set debug_format "unknown"
5022 # Run the gdb command "info source" and extract the debugging format
5023 # information from the output and save it in debug_format.
5025 proc get_debug_format { } {
5031 set debug_format "unknown"
5032 send_gdb "info source\n"
5034 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
5035 set debug_format $expect_out(1,string)
5036 verbose "debug format is $debug_format"
5039 -re "No current source file.\r\n$gdb_prompt $" {
5040 perror "get_debug_format used when no current source file"
5043 -re "$gdb_prompt $" {
5044 warning "couldn't check debug format (no valid response)."
5048 warning "couldn't check debug format (timeout)."
5054 # Return true if FORMAT matches the debug format the current test was
5055 # compiled with. FORMAT is a shell-style globbing pattern; it can use
5056 # `*', `[...]', and so on.
5058 # This function depends on variables set by `get_debug_format', above.
5060 proc test_debug_format {format} {
5063 return [expr [string match $format $debug_format] != 0]
5066 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
5067 # COFF, stabs, etc). If that format matches the format that the
5068 # current test was compiled with, then the next test is expected to
5069 # fail for any target. Returns 1 if the next test or set of tests is
5070 # expected to fail, 0 otherwise (or if it is unknown). Must have
5071 # previously called get_debug_format.
5072 proc setup_xfail_format { format } {
5073 set ret [test_debug_format $format]
5081 # gdb_get_line_number TEXT [FILE]
5083 # Search the source file FILE, and return the line number of the
5084 # first line containing TEXT. If no match is found, an error is thrown.
5086 # TEXT is a string literal, not a regular expression.
5088 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
5089 # specified, and does not start with "/", then it is assumed to be in
5090 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
5091 # by changing the callers and the interface at the same time.
5092 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
5093 # gdb.base/ena-dis-br.exp.
5095 # Use this function to keep your test scripts independent of the
5096 # exact line numbering of the source file. Don't write:
5098 # send_gdb "break 20"
5100 # This means that if anyone ever edits your test's source file,
5101 # your test could break. Instead, put a comment like this on the
5102 # source file line you want to break at:
5104 # /* breakpoint spot: frotz.exp: test name */
5106 # and then write, in your test script (which we assume is named
5109 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
5111 # (Yes, Tcl knows how to handle the nested quotes and brackets.
5114 # % puts "foo [lindex "bar baz" 1]"
5117 # Tcl is quite clever, for a little stringy language.)
5121 # The previous implementation of this procedure used the gdb search command.
5122 # This version is different:
5124 # . It works with MI, and it also works when gdb is not running.
5126 # . It operates on the build machine, not the host machine.
5128 # . For now, this implementation fakes a current directory of
5129 # $srcdir/$subdir to be compatible with the old implementation.
5130 # This will go away eventually and some callers will need to
5133 # . The TEXT argument is literal text and matches literally,
5134 # not a regular expression as it was before.
5136 # . State changes in gdb, such as changing the current file
5137 # and setting $_, no longer happen.
5139 # After a bit of time we can forget about the differences from the
5140 # old implementation.
5142 # --chastain 2004-08-05
5144 proc gdb_get_line_number { text { file "" } } {
5149 if { "$file" == "" } then {
5152 if { ! [regexp "^/" "$file"] } then {
5153 set file "$srcdir/$subdir/$file"
5156 if { [ catch { set fd [open "$file"] } message ] } then {
5161 for { set line 1 } { 1 } { incr line } {
5162 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5165 if { $nchar < 0 } then {
5168 if { [string first "$text" "$body"] >= 0 } then {
5174 if { [ catch { close "$fd" } message ] } then {
5179 error "undefined tag \"$text\""
5185 # Continue the program until it ends.
5187 # MSSG is the error message that gets printed. If not given, a
5189 # COMMAND is the command to invoke. If not given, "continue" is
5191 # ALLOW_EXTRA is a flag indicating whether the test should expect
5192 # extra output between the "Continuing." line and the program
5193 # exiting. By default it is zero; if nonzero, any extra output
5196 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5197 global inferior_exited_re use_gdb_stub
5200 set text "continue until exit"
5202 set text "continue until exit at $mssg"
5210 # By default, we don't rely on exit() behavior of remote stubs --
5211 # it's common for exit() to be implemented as a simple infinite
5212 # loop, or a forced crash/reset. For native targets, by default, we
5213 # assume process exit is reported as such. If a non-reliable target
5214 # is used, we set a breakpoint at exit, and continue to that.
5215 if { [target_info exists exit_is_reliable] } {
5216 set exit_is_reliable [target_info exit_is_reliable]
5218 set exit_is_reliable [expr ! $use_gdb_stub]
5221 if { ! $exit_is_reliable } {
5222 if {![gdb_breakpoint "exit"]} {
5225 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5228 # Continue until we exit. Should not stop again.
5229 # Don't bother to check the output of the program, that may be
5230 # extremely tough for some remote systems.
5232 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5237 proc rerun_to_main {} {
5238 global gdb_prompt use_gdb_stub
5243 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5244 {pass "rerun to main" ; return 0}
5245 -re "$gdb_prompt $"\
5246 {fail "rerun to main" ; return 0}
5247 timeout {fail "(timeout) rerun to main" ; return 0}
5252 -re "The program .* has been started already.*y or n. $" {
5253 send_gdb "y\n" answer
5256 -re "Starting program.*$gdb_prompt $"\
5257 {pass "rerun to main" ; return 0}
5258 -re "$gdb_prompt $"\
5259 {fail "rerun to main" ; return 0}
5260 timeout {fail "(timeout) rerun to main" ; return 0}
5265 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5267 proc exec_has_index_section { executable } {
5268 set readelf_program [gdb_find_readelf]
5269 set res [catch {exec $readelf_program -S $executable \
5270 | grep -E "\.gdb_index|\.debug_names" }]
5277 # Return list with major and minor version of readelf, or an empty list.
5278 gdb_caching_proc readelf_version {
5279 set readelf_program [gdb_find_readelf]
5280 set res [catch {exec $readelf_program --version} output]
5284 set lines [split $output \n]
5285 set line [lindex $lines 0]
5286 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
5287 $line dummy major minor]
5291 return [list $major $minor]
5294 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
5295 proc readelf_prints_pie { } {
5296 set version [readelf_version]
5297 if { [llength $version] == 0 } {
5300 set major [lindex $version 0]
5301 set minor [lindex $version 1]
5302 # It would be better to construct a PIE executable and test if the PIE
5303 # flag is printed by readelf, but we cannot reliably construct a PIE
5304 # executable if the multilib_flags dictate otherwise
5305 # (--target_board=unix/-no-pie/-fno-PIE).
5306 return [version_at_least $major $minor 2 26]
5309 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
5310 # and -1 if unknown.
5312 proc exec_is_pie { executable } {
5313 set res [readelf_prints_pie]
5317 set readelf_program [gdb_find_readelf]
5318 set res [catch {exec $readelf_program -d $executable} output]
5322 set res [regexp -line {\(FLAGS_1\).*Flags:.* PIE($| )} $output]
5329 # Return true if a test should be skipped due to lack of floating
5330 # point support or GDB can't fetch the contents from floating point
5333 gdb_caching_proc gdb_skip_float_test {
5334 if [target_info exists gdb,skip_float_tests] {
5338 # There is an ARM kernel ptrace bug that hardware VFP registers
5339 # are not updated after GDB ptrace set VFP registers. The bug
5340 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5341 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5342 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5343 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5344 # This kernel bug is detected by check how does GDB change the
5345 # program result by changing one VFP register.
5346 if { [istarget "arm*-*-linux*"] } {
5348 set compile_flags {debug nowarnings }
5350 # Set up, compile, and execute a test program having VFP
5352 set src [standard_temp_file arm_vfp[pid].c]
5353 set exe [standard_temp_file arm_vfp[pid].x]
5355 gdb_produce_source $src {
5360 asm ("vldr d0, [%0]" : : "r" (&d));
5361 asm ("vldr d1, [%0]" : : "r" (&d));
5362 asm (".global break_here\n"
5364 asm ("vcmp.f64 d0, d1\n"
5365 "vmrs APSR_nzcv, fpscr\n"
5366 "bne L_value_different\n"
5369 "L_value_different:\n"
5371 "L_end:\n" : "=r" (ret) :);
5373 /* Return $d0 != $d1. */
5378 verbose "compiling testfile $src" 2
5379 set lines [gdb_compile $src $exe executable $compile_flags]
5382 if ![string match "" $lines] then {
5383 verbose "testfile compilation failed, returning 1" 2
5387 # No error message, compilation succeeded so now run it via gdb.
5388 # Run the test up to 5 times to detect whether ptrace can
5389 # correctly update VFP registers or not.
5391 for {set i 0} {$i < 5} {incr i} {
5392 global gdb_prompt srcdir subdir
5396 gdb_reinitialize_dir $srcdir/$subdir
5400 gdb_test "break *break_here"
5401 gdb_continue_to_breakpoint "break_here"
5403 # Modify $d0 to a different value, so the exit code should
5405 gdb_test "set \$d0 = 5.0"
5407 set test "continue to exit"
5408 gdb_test_multiple "continue" "$test" {
5409 -re "exited with code 01.*$gdb_prompt $" {
5411 -re "exited normally.*$gdb_prompt $" {
5412 # However, the exit code is 0. That means something
5413 # wrong in setting VFP registers.
5421 remote_file build delete $exe
5423 return $skip_vfp_test
5428 # Print a message and return true if a test should be skipped
5429 # due to lack of stdio support.
5431 proc gdb_skip_stdio_test { msg } {
5432 if [target_info exists gdb,noinferiorio] {
5433 verbose "Skipping test '$msg': no inferior i/o."
5439 proc gdb_skip_bogus_test { msg } {
5443 # Return true if a test should be skipped due to lack of XML support
5445 # NOTE: This must be called while gdb is *not* running.
5447 gdb_caching_proc gdb_skip_xml_test {
5452 if { [info exists gdb_spawn_id] } {
5453 error "GDB must not be running in gdb_skip_xml_tests."
5456 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5460 gdb_test_multiple "set tdesc filename $xml_file" "" {
5461 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5464 -re ".*$gdb_prompt $" { }
5470 # Return true if argv[0] is available.
5472 gdb_caching_proc gdb_has_argv0 {
5475 # Compile and execute a test program to check whether argv[0] is available.
5476 gdb_simple_compile has_argv0 {
5477 int main (int argc, char **argv) {
5484 proc gdb_has_argv0_1 { exe } {
5485 global srcdir subdir
5486 global gdb_prompt hex
5490 gdb_reinitialize_dir $srcdir/$subdir
5493 # Set breakpoint on main.
5494 gdb_test_multiple "break main" "break main" {
5495 -re "Breakpoint.*${gdb_prompt} $" {
5497 -re "${gdb_prompt} $" {
5504 gdb_test_multiple "" "run to main" {
5505 -re "Breakpoint.*${gdb_prompt} $" {
5507 -re "${gdb_prompt} $" {
5512 set old_elements "200"
5513 set test "show print elements"
5514 gdb_test_multiple $test $test {
5515 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5516 set old_elements $expect_out(1,string)
5519 set old_repeats "200"
5520 set test "show print repeats"
5521 gdb_test_multiple $test $test {
5522 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5523 set old_repeats $expect_out(1,string)
5526 gdb_test_no_output "set print elements unlimited" ""
5527 gdb_test_no_output "set print repeats unlimited" ""
5530 # Check whether argc is 1.
5531 gdb_test_multiple "p argc" "p argc" {
5532 -re " = 1\r\n${gdb_prompt} $" {
5534 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5535 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5538 -re "${gdb_prompt} $" {
5542 -re "${gdb_prompt} $" {
5546 gdb_test_no_output "set print elements $old_elements" ""
5547 gdb_test_no_output "set print repeats $old_repeats" ""
5552 set result [gdb_has_argv0_1 $obj]
5558 && ([istarget *-*-linux*]
5559 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5560 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5561 || [istarget *-*-openbsd*]
5562 || [istarget *-*-darwin*]
5563 || [istarget *-*-solaris*]
5564 || [istarget *-*-aix*]
5565 || [istarget *-*-gnu*]
5566 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5567 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5568 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5569 || [istarget *-*-symbianelf*]
5570 || [istarget *-*-osf*]
5571 || [istarget *-*-dicos*]
5572 || [istarget *-*-nto*]
5573 || [istarget *-*-*vms*]
5574 || [istarget *-*-lynx*178]) } {
5575 fail "argv\[0\] should be available on this target"
5581 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5582 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5583 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5584 # the name of a debuginfo only file. This file will be stored in the same
5587 # Functions for separate debug info testing
5589 # starting with an executable:
5590 # foo --> original executable
5592 # at the end of the process we have:
5593 # foo.stripped --> foo w/o debug info
5594 # foo.debug --> foo's debug info
5595 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5597 # Fetch the build id from the file.
5598 # Returns "" if there is none.
5600 proc get_build_id { filename } {
5601 if { ([istarget "*-*-mingw*"]
5602 || [istarget *-*-cygwin*]) } {
5603 set objdump_program [gdb_find_objdump]
5604 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5605 verbose "result is $result"
5606 verbose "output is $output"
5612 set tmp [standard_output_file "${filename}-tmp"]
5613 set objcopy_program [gdb_find_objcopy]
5614 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5615 verbose "result is $result"
5616 verbose "output is $output"
5621 fconfigure $fi -translation binary
5622 # Skip the NOTE header.
5627 if ![string compare $data ""] then {
5630 # Convert it to hex.
5631 binary scan $data H* data
5636 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5637 # converted to the form: .build-id/ab/cdef1234...89.debug
5638 # Return "" if no build-id found.
5639 proc build_id_debug_filename_get { filename } {
5640 set data [get_build_id $filename]
5641 if { $data == "" } {
5644 regsub {^..} $data {\0/} data
5645 return ".build-id/${data}.debug"
5648 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5649 # list of optional flags. The only currently supported flag is no-main,
5650 # which removes the symbol entry for main from the separate debug file.
5652 # Function returns zero on success. Function will return non-zero failure code
5653 # on some targets not supporting separate debug info (such as i386-msdos).
5655 proc gdb_gnu_strip_debug { dest args } {
5657 # Use the first separate debug info file location searched by GDB so the
5658 # run cannot be broken by some stale file searched with higher precedence.
5659 set debug_file "${dest}.debug"
5661 set strip_to_file_program [transform strip]
5662 set objcopy_program [gdb_find_objcopy]
5664 set debug_link [file tail $debug_file]
5665 set stripped_file "${dest}.stripped"
5667 # Get rid of the debug info, and store result in stripped_file
5668 # something like gdb/testsuite/gdb.base/blah.stripped.
5669 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5670 verbose "result is $result"
5671 verbose "output is $output"
5676 # Workaround PR binutils/10802:
5677 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5678 set perm [file attributes ${dest} -permissions]
5679 file attributes ${stripped_file} -permissions $perm
5681 # Get rid of everything but the debug info, and store result in debug_file
5682 # This will be in the .debug subdirectory, see above.
5683 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5684 verbose "result is $result"
5685 verbose "output is $output"
5690 # If no-main is passed, strip the symbol for main from the separate
5691 # file. This is to simulate the behavior of elfutils's eu-strip, which
5692 # leaves the symtab in the original file only. There's no way to get
5693 # objcopy or strip to remove the symbol table without also removing the
5694 # debugging sections, so this is as close as we can get.
5695 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5696 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5697 verbose "result is $result"
5698 verbose "output is $output"
5702 file delete "${debug_file}"
5703 file rename "${debug_file}-tmp" "${debug_file}"
5706 # Link the two previous output files together, adding the .gnu_debuglink
5707 # section to the stripped_file, containing a pointer to the debug_file,
5708 # save the new file in dest.
5709 # This will be the regular executable filename, in the usual location.
5710 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5711 verbose "result is $result"
5712 verbose "output is $output"
5717 # Workaround PR binutils/10802:
5718 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5719 set perm [file attributes ${stripped_file} -permissions]
5720 file attributes ${dest} -permissions $perm
5725 # Test the output of GDB_COMMAND matches the pattern obtained
5726 # by concatenating all elements of EXPECTED_LINES. This makes
5727 # it possible to split otherwise very long string into pieces.
5728 # If third argument TESTNAME is not empty, it's used as the name of the
5729 # test to be printed on pass/fail.
5730 proc help_test_raw { gdb_command expected_lines {testname {}} } {
5731 if {$testname == {}} {
5732 set message $gdb_command
5734 set message $testname
5736 set expected_output [join $expected_lines ""]
5737 gdb_test "${gdb_command}" "${expected_output}" $message
5740 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
5741 set help_list_trailer {
5742 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5743 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
5744 "Command name abbreviations are allowed if unambiguous\."
5747 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5748 # are regular expressions that should match the beginning of output,
5749 # before the list of commands in that class.
5750 # LIST_OF_COMMANDS are regular expressions that should match the
5751 # list of commands in that class. If empty, the command list will be
5752 # matched automatically. The presence of standard epilogue will be tested
5754 # If last argument TESTNAME is not empty, it's used as the name of the
5755 # test to be printed on pass/fail.
5756 # Notice that the '[' and ']' characters don't need to be escaped for strings
5757 # wrapped in {} braces.
5758 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
5759 global help_list_trailer
5760 if {[llength $list_of_commands]>0} {
5761 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
5762 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
5763 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
5765 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
5768 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5770 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
5771 $l_stock_body $help_list_trailer]
5773 help_test_raw "help ${command_class}" $l_entire_body $testname
5776 # Like test_class_help but specialised to test "help user-defined".
5777 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
5778 test_class_help "user-defined" {
5779 "User-defined commands\.[\r\n]+"
5780 "The commands in this class are those defined by the user\.[\r\n]+"
5781 "Use the \"define\" command to define a command\.[\r\n]+"
5782 } $list_of_commands $testname
5786 # COMMAND_LIST should have either one element -- command to test, or
5787 # two elements -- abbreviated command to test, and full command the first
5788 # element is abbreviation of.
5789 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5790 # are regular expressions that should match the beginning of output,
5791 # before the list of subcommands. The presence of
5792 # subcommand list and standard epilogue will be tested automatically.
5793 proc test_prefix_command_help { command_list expected_initial_lines args } {
5794 global help_list_trailer
5795 set command [lindex $command_list 0]
5796 if {[llength $command_list]>1} {
5797 set full_command [lindex $command_list 1]
5799 set full_command $command
5801 # Use 'list' and not just {} because we want variables to
5802 # be expanded in this list.
5803 set l_stock_body [list\
5804 "List of $full_command subcommands\:.*\[\r\n\]+"\
5805 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
5806 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
5807 if {[llength $args]>0} {
5808 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5810 help_test_raw "help ${command}" $l_entire_body
5814 # Build executable named EXECUTABLE from specifications that allow
5815 # different options to be passed to different sub-compilations.
5816 # TESTNAME is the name of the test; this is passed to 'untested' if
5818 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5819 # contains the option "pthreads", then gdb_compile_pthreads is used.
5820 # ARGS is a flat list of source specifications, of the form:
5821 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5822 # Each SOURCE is compiled to an object file using its OPTIONS,
5823 # using gdb_compile.
5824 # Returns 0 on success, -1 on failure.
5825 proc build_executable_from_specs {testname executable options args} {
5829 set binfile [standard_output_file $executable]
5832 if { [lsearch -exact $options "c++"] >= 0 } {
5833 set info_options "c++"
5835 if [get_compiler_info ${info_options}] {
5839 set func gdb_compile
5840 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5841 if {$func_index != -1} {
5842 set func "${func}_[lindex $options $func_index]"
5845 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5846 # parameter. They also requires $sources while gdb_compile and
5847 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5848 if [string match gdb_compile_shlib* $func] {
5850 foreach {s local_options} $args {
5851 if { [regexp "^/" "$s"] } then {
5852 lappend sources_path "$s"
5854 lappend sources_path "$srcdir/$subdir/$s"
5857 set ret [$func $sources_path "${binfile}" $options]
5858 } elseif {[lsearch -exact $options rust] != -1} {
5860 foreach {s local_options} $args {
5861 if { [regexp "^/" "$s"] } then {
5862 lappend sources_path "$s"
5864 lappend sources_path "$srcdir/$subdir/$s"
5867 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5871 foreach {s local_options} $args {
5872 if { ! [regexp "^/" "$s"] } then {
5873 set s "$srcdir/$subdir/$s"
5875 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5879 lappend objects "${binfile}${i}.o"
5882 set ret [$func $objects "${binfile}" executable $options]
5892 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5893 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5894 # to pass to untested, if something is wrong. OPTIONS are passed
5895 # to gdb_compile directly.
5896 proc build_executable { testname executable {sources ""} {options {debug}} } {
5897 if {[llength $sources]==0} {
5898 set sources ${executable}.c
5901 set arglist [list $testname $executable $options]
5902 foreach source $sources {
5903 lappend arglist $source $options
5906 return [eval build_executable_from_specs $arglist]
5909 # Starts fresh GDB binary and loads an optional executable into GDB.
5910 # Usage: clean_restart [executable]
5911 # EXECUTABLE is the basename of the binary.
5913 proc clean_restart { args } {
5917 if { [llength $args] > 1 } {
5918 error "bad number of args: [llength $args]"
5923 gdb_reinitialize_dir $srcdir/$subdir
5925 if { [llength $args] >= 1 } {
5926 set executable [lindex $args 0]
5927 set binfile [standard_output_file ${executable}]
5932 # Prepares for testing by calling build_executable_full, then
5934 # TESTNAME is the name of the test.
5935 # Each element in ARGS is a list of the form
5936 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5937 # These are passed to build_executable_from_specs, which see.
5938 # The last EXECUTABLE is passed to clean_restart.
5939 # Returns 0 on success, non-zero on failure.
5940 proc prepare_for_testing_full {testname args} {
5941 foreach spec $args {
5942 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5945 set executable [lindex $spec 0]
5947 clean_restart $executable
5951 # Prepares for testing, by calling build_executable, and then clean_restart.
5952 # Please refer to build_executable for parameter description.
5953 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5955 if {[build_executable $testname $executable $sources $options] == -1} {
5958 clean_restart $executable
5963 # Retrieve the value of EXP in the inferior, represented in format
5964 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5965 # print fails. TEST is the test message to use. It can be omitted,
5966 # in which case a test message is built from EXP.
5968 proc get_valueof { fmt exp default {test ""} } {
5972 set test "get valueof \"${exp}\""
5976 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5977 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5978 set val $expect_out(1,string)
5982 fail "$test (timeout)"
5988 # Retrieve the value of EXP in the inferior, as a signed decimal value
5989 # (using "print /d"). DEFAULT is used as fallback if print fails.
5990 # TEST is the test message to use. It can be omitted, in which case
5991 # a test message is built from EXP.
5993 proc get_integer_valueof { exp default {test ""} } {
5997 set test "get integer valueof \"${exp}\""
6001 gdb_test_multiple "print /d ${exp}" "$test" {
6002 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
6003 set val $expect_out(1,string)
6007 fail "$test (timeout)"
6013 # Retrieve the value of EXP in the inferior, as an hexadecimal value
6014 # (using "print /x"). DEFAULT is used as fallback if print fails.
6015 # TEST is the test message to use. It can be omitted, in which case
6016 # a test message is built from EXP.
6018 proc get_hexadecimal_valueof { exp default {test ""} } {
6022 set test "get hexadecimal valueof \"${exp}\""
6026 gdb_test_multiple "print /x ${exp}" $test {
6027 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
6028 set val $expect_out(1,string)
6035 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
6036 # is used as fallback if print fails. TEST is the test message to use.
6037 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
6039 proc get_sizeof { type default {test ""} } {
6040 return [get_integer_valueof "sizeof (${type})" $default $test]
6043 proc get_target_charset { } {
6046 gdb_test_multiple "show target-charset" "" {
6047 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
6048 return $expect_out(1,string)
6050 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
6051 return $expect_out(1,string)
6055 # Pick a reasonable default.
6056 warning "Unable to read target-charset."
6060 # Get the address of VAR.
6062 proc get_var_address { var } {
6063 global gdb_prompt hex
6065 # Match output like:
6067 # $5 = (int (*)()) 0
6068 # $6 = (int (*)()) 0x24 <function_bar>
6070 gdb_test_multiple "print &${var}" "get address of ${var}" {
6071 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
6073 pass "get address of ${var}"
6074 if { $expect_out(1,string) == "0" } {
6077 return $expect_out(1,string)
6084 # Return the frame number for the currently selected frame
6085 proc get_current_frame_number {{test_name ""}} {
6088 if { $test_name == "" } {
6089 set test_name "get current frame number"
6092 gdb_test_multiple "frame" $test_name {
6093 -re "#(\[0-9\]+) .*$gdb_prompt $" {
6094 set frame_num $expect_out(1,string)
6100 # Get the current value for remotetimeout and return it.
6101 proc get_remotetimeout { } {
6105 gdb_test_multiple "show remotetimeout" "" {
6106 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
6107 return $expect_out(1,string)
6111 # Pick the default that gdb uses
6112 warning "Unable to read remotetimeout"
6116 # Set the remotetimeout to the specified timeout. Nothing is returned.
6117 proc set_remotetimeout { timeout } {
6120 gdb_test_multiple "set remotetimeout $timeout" "" {
6121 -re "$gdb_prompt $" {
6122 verbose "Set remotetimeout to $timeout\n"
6127 # Get the target's current endianness and return it.
6128 proc get_endianness { } {
6131 gdb_test_multiple "show endian" "determine endianness" {
6132 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
6134 return $expect_out(1,string)
6140 # ROOT and FULL are file names. Returns the relative path from ROOT
6141 # to FULL. Note that FULL must be in a subdirectory of ROOT.
6142 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
6145 proc relative_filename {root full} {
6146 set root_split [file split $root]
6147 set full_split [file split $full]
6149 set len [llength $root_split]
6151 if {[eval file join $root_split]
6152 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
6153 error "$full not a subdir of $root"
6156 return [eval file join [lrange $full_split $len end]]
6159 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
6160 if {[info exists GDB_PARALLEL]} {
6161 if {[is_remote host]} {
6165 [make_gdb_parallel_path outputs] \
6166 [make_gdb_parallel_path temp] \
6167 [make_gdb_parallel_path cache]
6171 proc core_find {binfile {deletefiles {}} {arg ""}} {
6172 global objdir subdir
6174 set destcore "$binfile.core"
6175 file delete $destcore
6177 # Create a core file named "$destcore" rather than just "core", to
6178 # avoid problems with sys admin types that like to regularly prune all
6179 # files named "core" from the system.
6181 # Arbitrarily try setting the core size limit to "unlimited" since
6182 # this does not hurt on systems where the command does not work and
6183 # allows us to generate a core on systems where it does.
6185 # Some systems append "core" to the name of the program; others append
6186 # the name of the program to "core"; still others (like Linux, as of
6187 # May 2003) create cores named "core.PID". In the latter case, we
6188 # could have many core files lying around, and it may be difficult to
6189 # tell which one is ours, so let's run the program in a subdirectory.
6191 set coredir [standard_output_file coredir.[getpid]]
6193 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6194 # remote_exec host "${binfile}"
6195 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6196 if [remote_file build exists $i] {
6197 remote_exec build "mv $i $destcore"
6201 # Check for "core.PID".
6202 if { $found == 0 } {
6203 set names [glob -nocomplain -directory $coredir core.*]
6204 if {[llength $names] == 1} {
6205 set corefile [file join $coredir [lindex $names 0]]
6206 remote_exec build "mv $corefile $destcore"
6210 if { $found == 0 } {
6211 # The braindamaged HPUX shell quits after the ulimit -c above
6212 # without executing ${binfile}. So we try again without the
6213 # ulimit here if we didn't find a core file above.
6214 # Oh, I should mention that any "braindamaged" non-Unix system has
6215 # the same problem. I like the cd bit too, it's really neat'n stuff.
6216 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6217 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6218 if [remote_file build exists $i] {
6219 remote_exec build "mv $i $destcore"
6225 # Try to clean up after ourselves.
6226 foreach deletefile $deletefiles {
6227 remote_file build delete [file join $coredir $deletefile]
6229 remote_exec build "rmdir $coredir"
6231 if { $found == 0 } {
6232 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6238 # gdb_target_symbol_prefix compiles a test program and then examines
6239 # the output from objdump to determine the prefix (such as underscore)
6240 # for linker symbol prefixes.
6242 gdb_caching_proc gdb_target_symbol_prefix {
6243 # Compile a simple test program...
6244 set src { int main() { return 0; } }
6245 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6251 set objdump_program [gdb_find_objdump]
6252 set result [catch "exec $objdump_program --syms $obj" output]
6255 && ![regexp -lineanchor \
6256 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6257 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6265 # Return 1 if target supports scheduler locking, otherwise return 0.
6267 gdb_caching_proc target_supports_scheduler_locking {
6270 set me "gdb_target_supports_scheduler_locking"
6272 set src { int main() { return 0; } }
6273 if {![gdb_simple_compile $me $src executable]} {
6282 set supports_schedule_locking -1
6283 set current_schedule_locking_mode ""
6285 set test "reading current scheduler-locking mode"
6286 gdb_test_multiple "show scheduler-locking" $test {
6287 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6288 set current_schedule_locking_mode $expect_out(1,string)
6290 -re "$gdb_prompt $" {
6291 set supports_schedule_locking 0
6294 set supports_schedule_locking 0
6298 if { $supports_schedule_locking == -1 } {
6299 set test "checking for scheduler-locking support"
6300 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6301 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6302 set supports_schedule_locking 0
6304 -re "$gdb_prompt $" {
6305 set supports_schedule_locking 1
6308 set supports_schedule_locking 0
6313 if { $supports_schedule_locking == -1 } {
6314 set supports_schedule_locking 0
6318 remote_file build delete $obj
6319 verbose "$me: returning $supports_schedule_locking" 2
6320 return $supports_schedule_locking
6323 # gdb_target_symbol returns the provided symbol with the correct prefix
6324 # prepended. (See gdb_target_symbol_prefix, above.)
6326 proc gdb_target_symbol { symbol } {
6327 set prefix [gdb_target_symbol_prefix]
6328 return "${prefix}${symbol}"
6331 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6332 # added to gdb_compile options to define the C-preprocessor macro
6333 # SYMBOL_PREFIX with a value that can be prepended to symbols
6334 # for targets which require a prefix, such as underscore.
6336 # This version (_asm) defines the prefix without double quotes
6337 # surrounding the prefix. It is used to define the macro
6338 # SYMBOL_PREFIX for assembly language files. Another version, below,
6339 # is used for symbols in inline assembler in C/C++ files.
6341 # The lack of quotes in this version (_asm) makes it possible to
6342 # define supporting macros in the .S file. (The version which
6343 # uses quotes for the prefix won't work for such files since it's
6344 # impossible to define a quote-stripping macro in C.)
6346 # It's possible to use this version (_asm) for C/C++ source files too,
6347 # but a string is usually required in such files; providing a version
6348 # (no _asm) which encloses the prefix with double quotes makes it
6349 # somewhat easier to define the supporting macros in the test case.
6351 proc gdb_target_symbol_prefix_flags_asm {} {
6352 set prefix [gdb_target_symbol_prefix]
6353 if {$prefix ne ""} {
6354 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6360 # gdb_target_symbol_prefix_flags returns the same string as
6361 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6362 # enclosed in double quotes if there is a prefix.
6364 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6365 # extended discussion.
6367 proc gdb_target_symbol_prefix_flags {} {
6368 set prefix [gdb_target_symbol_prefix]
6369 if {$prefix ne ""} {
6370 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6376 # A wrapper for 'remote_exec host' that passes or fails a test.
6377 # Returns 0 if all went well, nonzero on failure.
6378 # TEST is the name of the test, other arguments are as for remote_exec.
6380 proc run_on_host { test program args } {
6381 verbose -log "run_on_host: $program $args"
6382 # remote_exec doesn't work properly if the output is set but the
6383 # input is the empty string -- so replace an empty input with
6385 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6386 set args [lreplace $args 1 1 "/dev/null"]
6388 set result [eval remote_exec host [list $program] $args]
6389 verbose "result is $result"
6390 set status [lindex $result 0]
6391 set output [lindex $result 1]
6396 verbose -log "run_on_host failed: $output"
6402 # Return non-zero if "board_info debug_flags" mentions Fission.
6403 # http://gcc.gnu.org/wiki/DebugFission
6404 # Fission doesn't support everything yet.
6405 # This supports working around bug 15954.
6407 proc using_fission { } {
6408 set debug_flags [board_info [target_info name] debug_flags]
6409 return [regexp -- "-gsplit-dwarf" $debug_flags]
6412 # Search the caller's ARGS list and set variables according to the list of
6413 # valid options described by ARGSET.
6415 # The first member of each one- or two-element list in ARGSET defines the
6416 # name of a variable that will be added to the caller's scope.
6418 # If only one element is given to describe an option, it the value is
6419 # 0 if the option is not present in (the caller's) ARGS or 1 if
6422 # If two elements are given, the second element is the default value of
6423 # the variable. This is then overwritten if the option exists in ARGS.
6425 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6426 # any optional components.
6429 # proc myproc {foo args} {
6430 # parse_args {{bar} {baz "abc"} {qux}}
6433 # myproc ABC -bar -baz DEF peanut butter
6434 # will define the following variables in myproc:
6435 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6436 # args will be the list {peanut butter}
6438 proc parse_args { argset } {
6441 foreach argument $argset {
6442 if {[llength $argument] == 1} {
6443 # No default specified, so we assume that we should set
6444 # the value to 1 if the arg is present and 0 if it's not.
6445 # It is assumed that no value is given with the argument.
6446 set result [lsearch -exact $args "-$argument"]
6447 if {$result != -1} then {
6448 uplevel 1 [list set $argument 1]
6449 set args [lreplace $args $result $result]
6451 uplevel 1 [list set $argument 0]
6453 } elseif {[llength $argument] == 2} {
6454 # There are two items in the argument. The second is a
6455 # default value to use if the item is not present.
6456 # Otherwise, the variable is set to whatever is provided
6457 # after the item in the args.
6458 set arg [lindex $argument 0]
6459 set result [lsearch -exact $args "-[lindex $arg 0]"]
6460 if {$result != -1} then {
6461 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6462 set args [lreplace $args $result [expr $result+1]]
6464 uplevel 1 [list set $arg [lindex $argument 1]]
6467 error "Badly formatted argument \"$argument\" in argument set"
6471 # The remaining args should be checked to see that they match the
6472 # number of items expected to be passed into the procedure...
6475 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6476 # return that string.
6478 proc capture_command_output { command prefix } {
6482 set output_string ""
6483 gdb_test_multiple "$command" "capture_command_output for $command" {
6484 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6485 set output_string $expect_out(1,string)
6488 return $output_string
6491 # A convenience function that joins all the arguments together, with a
6492 # regexp that matches exactly one end of line in between each argument.
6493 # This function is ideal to write the expected output of a GDB command
6494 # that generates more than a couple of lines, as this allows us to write
6495 # each line as a separate string, which is easier to read by a human
6498 proc multi_line { args } {
6499 return [join $args "\r\n"]
6502 # Similar to the above, but while multi_line is meant to be used to
6503 # match GDB output, this one is meant to be used to build strings to
6504 # send as GDB input.
6506 proc multi_line_input { args } {
6507 return [join $args "\n"]
6510 # Return the version of the DejaGnu framework.
6512 # The return value is a list containing the major, minor and patch version
6513 # numbers. If the version does not contain a minor or patch number, they will
6514 # be set to 0. For example:
6520 proc dejagnu_version { } {
6521 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6522 global frame_version
6524 verbose -log "DejaGnu version: $frame_version"
6525 verbose -log "Expect version: [exp_version]"
6526 verbose -log "Tcl version: [info tclversion]"
6528 set dg_ver [split $frame_version .]
6530 while { [llength $dg_ver] < 3 } {
6537 # Define user-defined command COMMAND using the COMMAND_LIST as the
6538 # command's definition. The terminating "end" is added automatically.
6540 proc gdb_define_cmd {command command_list} {
6543 set input [multi_line_input {*}$command_list "end"]
6544 set test "define $command"
6546 gdb_test_multiple "define $command" $test {
6548 gdb_test_multiple $input $test {
6549 -re "\r\n$gdb_prompt " {
6556 # Override the 'cd' builtin with a version that ensures that the
6557 # log file keeps pointing at the same file. We need this because
6558 # unfortunately the path to the log file is recorded using an
6559 # relative path name, and, we sometimes need to close/reopen the log
6560 # after changing the current directory. See get_compiler_info.
6562 rename cd builtin_cd
6566 # Get the existing log file flags.
6567 set log_file_info [log_file -info]
6569 # Split the flags into args and file name.
6570 set log_file_flags ""
6571 set log_file_file ""
6572 foreach arg [ split "$log_file_info" " "] {
6573 if [string match "-*" $arg] {
6574 lappend log_file_flags $arg
6576 lappend log_file_file $arg
6580 # If there was an existing file, ensure it is an absolute path, and then
6582 if { $log_file_file != "" } {
6583 set log_file_file [file normalize $log_file_file]
6585 log_file $log_file_flags "$log_file_file"
6588 # Call the builtin version of cd.
6592 # Return a list of all languages supported by GDB, suitable for use in
6593 # 'set language NAME'. This doesn't include either the 'local' or
6595 proc gdb_supported_languages {} {
6596 return [list c objective-c c++ d go fortran modula-2 asm pascal \
6597 opencl rust minimal ada]
6600 # Check if debugging is enabled for gdb.
6602 proc gdb_debug_enabled { } {
6605 # If not already read, get the debug setting from environment or board setting.
6606 if {![info exists gdbdebug]} {
6608 if [info exists env(GDB_DEBUG)] {
6609 set gdbdebug $env(GDB_DEBUG)
6610 } elseif [target_info exists gdb,debug] {
6611 set gdbdebug [target_info gdb,debug]
6617 # Ensure it not empty.
6618 return [expr { $gdbdebug != "" }]
6621 # Turn on debugging if enabled, or reset if already on.
6623 proc gdb_debug_init { } {
6627 if ![gdb_debug_enabled] {
6631 # First ensure logging is off.
6632 send_gdb "set logging off\n"
6634 set debugfile [standard_output_file gdb.debug]
6635 send_gdb "set logging file $debugfile\n"
6637 send_gdb "set logging debugredirect\n"
6640 foreach entry [split $gdbdebug ,] {
6641 send_gdb "set debug $entry 1\n"
6644 # Now that everything is set, enable logging.
6645 send_gdb "set logging on\n"
6647 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
6648 timeout { warning "Couldn't set logging file" }
6652 # Check if debugging is enabled for gdbserver.
6654 proc gdbserver_debug_enabled { } {
6655 # Always disabled for GDB only setups.
6659 # Open the file for logging gdb input
6661 proc gdb_stdin_log_init { } {
6664 if {[info exists in_file]} {
6665 # Close existing file.
6666 catch "close $in_file"
6669 set logfile [standard_output_file_with_gdb_instance gdb.in]
6670 set in_file [open $logfile w]
6673 # Write to the file for logging gdb input.
6674 # TYPE can be one of the following:
6675 # "standard" : Default. Standard message written to the log
6676 # "answer" : Answer to a question (eg "Y"). Not written the log.
6677 # "optional" : Optional message. Not written to the log.
6679 proc gdb_stdin_log_write { message {type standard} } {
6682 if {![info exists in_file]} {
6686 # Check message types.
6687 switch -regexp -- $type {
6697 puts -nonewline $in_file "$message"
6700 # Write the command line used to invocate gdb to the cmd file.
6702 proc gdb_write_cmd_file { cmdline } {
6703 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
6704 set cmd_file [open $logfile w]
6705 puts $cmd_file $cmdline
6706 catch "close $cmd_file"
6709 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
6712 proc cmp_file_string { file str msg } {
6713 if { ![file exists $file]} {
6718 set caught_error [catch {
6719 set fp [open "$file" r]
6720 set file_contents [read $fp]
6723 if { $caught_error } then {
6724 error "$error_message"
6729 if { $file_contents == $str } {
6736 # Always load compatibility stuff.