1 # Copyright 1992-2016 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
34 # The spawn ID used for I/O interaction with the inferior. For native
35 # targets, or remote targets that can do I/O through GDB
36 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
37 # Otherwise, the board may set this to some other spawn ID. E.g.,
38 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
39 # so input/output is done on gdbserver's tty.
40 global inferior_spawn_id
42 if [info exists TOOL_EXECUTABLE] {
43 set GDB $TOOL_EXECUTABLE
45 if ![info exists GDB] {
46 if ![is_remote host] {
47 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
49 set GDB [transform gdb]
52 verbose "using GDB = $GDB" 2
54 # GDBFLAGS is available for the user to set on the command line.
55 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
56 # Testcases may use it to add additional flags, but they must:
57 # - append new flags, not overwrite
58 # - restore the original value when done
60 if ![info exists GDBFLAGS] {
63 verbose "using GDBFLAGS = $GDBFLAGS" 2
65 # Make the build data directory available to tests.
66 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
68 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
69 global INTERNAL_GDBFLAGS
70 if ![info exists INTERNAL_GDBFLAGS] {
71 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
74 # The variable gdb_prompt is a regexp which matches the gdb prompt.
75 # Set it if it is not already set. This is also set by default_gdb_init
76 # but it's not clear what removing one of them will break.
77 # See with_gdb_prompt for more details on prompt handling.
79 if ![info exists gdb_prompt] then {
80 set gdb_prompt "\\(gdb\\)"
83 # A regexp that matches the pagination prompt.
84 set pagination_prompt [string_to_regexp "---Type <return> to continue, or q <return> to quit---"]
86 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
87 # absolute path ie. /foo/
88 set fullname_syntax_POSIX {/[^\n]*/}
89 # The variable fullname_syntax_UNC is a regexp which matches a Windows
90 # UNC path ie. \\D\foo\
91 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
92 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
93 # particular DOS case that GDB most likely will output
94 # ie. \foo\, but don't match \\.*\
95 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
96 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
97 # ie. a:\foo\ && a:foo\
98 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
99 # The variable fullname_syntax is a regexp which matches what GDB considers
100 # an absolute path. It is currently debatable if the Windows style paths
101 # d:foo and \abc should be considered valid as an absolute path.
102 # Also, the purpse of this regexp is not to recognize a well formed
103 # absolute path, but to say with certainty that a path is absolute.
104 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
106 # Needed for some tests under Cygwin.
110 if ![info exists env(EXEEXT)] {
113 set EXEEXT $env(EXEEXT)
118 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
120 ### Only procedures should come after this point.
123 # gdb_version -- extract and print the version number of GDB
125 proc default_gdb_version {} {
127 global INTERNAL_GDBFLAGS GDBFLAGS
131 if {[info exists inotify_pid]} {
132 eval exec kill $inotify_pid
135 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
136 set tmp [lindex $output 1]
138 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
139 if ![is_remote host] {
140 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
142 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
146 proc gdb_version { } {
147 return [default_gdb_version]
151 # gdb_unload -- unload a file if one is loaded
152 # Return 0 on success, -1 on error.
161 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
162 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
163 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
167 -re "Discard symbol table from .*y or n.*$" {
171 -re "$gdb_prompt $" {}
173 perror "couldn't unload file in $GDB (timeout)."
180 # Many of the tests depend on setting breakpoints at various places and
181 # running until that breakpoint is reached. At times, we want to start
182 # with a clean-slate with respect to breakpoints, so this utility proc
183 # lets us do this without duplicating this code everywhere.
186 proc delete_breakpoints {} {
189 # we need a larger timeout value here or this thing just confuses
190 # itself. May need a better implementation if possible. - guo
194 set msg "delete all breakpoints in delete_breakpoints"
196 gdb_test_multiple "delete breakpoints" "$msg" {
197 -re "Delete all breakpoints.*y or n.*$" {
201 -re "$gdb_prompt $" {
207 # Confirm with "info breakpoints".
209 set msg "info breakpoints"
210 gdb_test_multiple $msg $msg {
211 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
214 -re "$gdb_prompt $" {
220 perror "breakpoints not deleted"
224 # Generic run command.
226 # The second pattern below matches up to the first newline *only*.
227 # Using ``.*$'' could swallow up output that we attempt to match
230 # N.B. This function does not wait for gdb to return to the prompt,
231 # that is the caller's responsibility.
233 proc gdb_run_cmd {args} {
234 global gdb_prompt use_gdb_stub
236 foreach command [gdb_init_commands] {
237 send_gdb "$command\n"
239 -re "$gdb_prompt $" { }
241 perror "gdb_init_command for target failed"
248 if [target_info exists gdb,do_reload_on_run] {
249 if { [gdb_reload] != 0 } {
252 send_gdb "continue\n"
254 -re "Continu\[^\r\n\]*\[\r\n\]" {}
260 if [target_info exists gdb,start_symbol] {
261 set start [target_info gdb,start_symbol]
265 send_gdb "jump *$start\n"
267 while { $start_attempt } {
268 # Cap (re)start attempts at three to ensure that this loop
269 # always eventually fails. Don't worry about trying to be
270 # clever and not send a command when it has failed.
271 if [expr $start_attempt > 3] {
272 perror "Jump to start() failed (retry count exceeded)"
275 set start_attempt [expr $start_attempt + 1]
277 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
280 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
281 perror "Can't find start symbol to run in gdb_run"
284 -re "No symbol \"start\" in current.*$gdb_prompt $" {
285 send_gdb "jump *_start\n"
287 -re "No symbol.*context.*$gdb_prompt $" {
290 -re "Line.* Jump anyway.*y or n. $" {
293 -re "The program is not being run.*$gdb_prompt $" {
294 if { [gdb_reload] != 0 } {
297 send_gdb "jump *$start\n"
300 perror "Jump to start() failed (timeout)"
308 if [target_info exists gdb,do_reload_on_run] {
309 if { [gdb_reload] != 0 } {
313 send_gdb "run $args\n"
314 # This doesn't work quite right yet.
315 # Use -notransfer here so that test cases (like chng-sym.exp)
316 # may test for additional start-up messages.
318 -re "The program .* has been started already.*y or n. $" {
322 -notransfer -re "Starting program: \[^\r\n\]*" {}
323 -notransfer -re "$gdb_prompt $" {
324 # There is no more input expected.
329 # Generic start command. Return 0 if we could start the program, -1
332 # N.B. This function does not wait for gdb to return to the prompt,
333 # that is the caller's responsibility.
335 proc gdb_start_cmd {args} {
336 global gdb_prompt use_gdb_stub
338 foreach command [gdb_init_commands] {
339 send_gdb "$command\n"
341 -re "$gdb_prompt $" { }
343 perror "gdb_init_command for target failed"
353 send_gdb "start $args\n"
354 # Use -notransfer here so that test cases (like chng-sym.exp)
355 # may test for additional start-up messages.
357 -re "The program .* has been started already.*y or n. $" {
361 -notransfer -re "Starting program: \[^\r\n\]*" {
368 # Set a breakpoint at FUNCTION. If there is an additional argument it is
369 # a list of options; the supported options are allow-pending, temporary,
370 # message, no-message, and passfail.
371 # The result is 1 for success, 0 for failure.
373 # Note: The handling of message vs no-message is messed up, but it's based
374 # on historical usage. By default this function does not print passes,
376 # no-message: turns off printing of fails (and passes, but they're already off)
377 # message: turns on printing of passes (and fails, but they're already on)
379 proc gdb_breakpoint { function args } {
383 set pending_response n
384 if {[lsearch -exact $args allow-pending] != -1} {
385 set pending_response y
388 set break_command "break"
389 set break_message "Breakpoint"
390 if {[lsearch -exact $args temporary] != -1} {
391 set break_command "tbreak"
392 set break_message "Temporary breakpoint"
397 set no_message_loc [lsearch -exact $args no-message]
398 set message_loc [lsearch -exact $args message]
399 # The last one to appear in args wins.
400 if { $no_message_loc > $message_loc } {
402 } elseif { $message_loc > $no_message_loc } {
406 set test_name "setting breakpoint at $function"
408 send_gdb "$break_command $function\n"
409 # The first two regexps are what we get with -g, the third is without -g.
411 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
412 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
413 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
414 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
415 if {$pending_response == "n"} {
422 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
423 send_gdb "$pending_response\n"
426 -re "A problem internal to GDB has been detected" {
428 fail "$test_name (GDB internal error)"
430 gdb_internal_error_resync
433 -re "$gdb_prompt $" {
441 fail "$test_name (eof)"
447 fail "$test_name (timeout)"
458 # Set breakpoint at function and run gdb until it breaks there.
459 # Since this is the only breakpoint that will be set, if it stops
460 # at a breakpoint, we will assume it is the one we want. We can't
461 # just compare to "function" because it might be a fully qualified,
462 # single quoted C++ function specifier.
464 # If there are additional arguments, pass them to gdb_breakpoint.
465 # We recognize no-message/message ourselves.
466 # The default is no-message.
467 # no-message is messed up here, like gdb_breakpoint: to preserve
468 # historical usage fails are always printed by default.
469 # no-message: turns off printing of fails (and passes, but they're already off)
470 # message: turns on printing of passes (and fails, but they're already on)
472 proc runto { function args } {
478 # Default to "no-message".
479 set args "no-message $args"
483 set no_message_loc [lsearch -exact $args no-message]
484 set message_loc [lsearch -exact $args message]
485 # The last one to appear in args wins.
486 if { $no_message_loc > $message_loc } {
488 } elseif { $message_loc > $no_message_loc } {
492 set test_name "running to $function in runto"
494 # We need to use eval here to pass our varargs args to gdb_breakpoint
495 # which is also a varargs function.
496 # But we also have to be careful because $function may have multiple
497 # elements, and we don't want Tcl to move the remaining elements after
498 # the first to $args. That is why $function is wrapped in {}.
499 if ![eval gdb_breakpoint {$function} $args] {
505 # the "at foo.c:36" output we get with -g.
506 # the "in func" output we get without -g.
508 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
514 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
520 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
522 unsupported "Non-stop mode not supported"
526 -re ".*A problem internal to GDB has been detected" {
528 fail "$test_name (GDB internal error)"
530 gdb_internal_error_resync
533 -re "$gdb_prompt $" {
541 fail "$test_name (eof)"
547 fail "$test_name (timeout)"
558 # Ask gdb to run until we hit a breakpoint at main.
560 # N.B. This function deletes all existing breakpoints.
561 # If you don't want that, use gdb_start_cmd.
563 proc runto_main { } {
564 return [runto main no-message]
567 ### Continue, and expect to hit a breakpoint.
568 ### Report a pass or fail, depending on whether it seems to have
569 ### worked. Use NAME as part of the test name; each call to
570 ### continue_to_breakpoint should use a NAME which is unique within
572 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
574 set full_name "continue to breakpoint: $name"
576 gdb_test_multiple "continue" $full_name {
577 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
584 # gdb_internal_error_resync:
586 # Answer the questions GDB asks after it reports an internal error
587 # until we get back to a GDB prompt. Decline to quit the debugging
588 # session, and decline to create a core file. Return non-zero if the
591 # This procedure just answers whatever questions come up until it sees
592 # a GDB prompt; it doesn't require you to have matched the input up to
593 # any specific point. However, it only answers questions it sees in
594 # the output itself, so if you've matched a question, you had better
595 # answer it yourself before calling this.
597 # You can use this function thus:
601 # -re ".*A problem internal to GDB has been detected" {
602 # gdb_internal_error_resync
607 proc gdb_internal_error_resync {} {
610 verbose -log "Resyncing due to internal error."
613 while {$count < 10} {
615 -re "Quit this debugging session\\? \\(y or n\\) $" {
619 -re "Create a core file of GDB\\? \\(y or n\\) $" {
623 -re "$gdb_prompt $" {
624 # We're resynchronized.
628 perror "Could not resync from internal error (timeout)"
633 perror "Could not resync from internal error (resync count exceeded)"
638 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
639 # Send a command to gdb; test the result.
641 # COMMAND is the command to execute, send to GDB with send_gdb. If
642 # this is the null string no command is sent.
643 # MESSAGE is a message to be printed with the built-in failure patterns
644 # if one of them matches. If MESSAGE is empty COMMAND will be used.
645 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
646 # patterns. Pattern elements will be evaluated in the caller's
647 # context; action elements will be executed in the caller's context.
648 # Unlike patterns for gdb_test, these patterns should generally include
649 # the final newline and prompt.
652 # 1 if the test failed, according to a built-in failure pattern
653 # 0 if only user-supplied patterns matched
654 # -1 if there was an internal error.
656 # You can use this function thus:
658 # gdb_test_multiple "print foo" "test foo" {
659 # -re "expected output 1" {
662 # -re "expected output 2" {
667 # Like with "expect", you can also specify the spawn id to match with
668 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
669 # $gdb_spawn_id. The former matches inferior I/O, while the latter
670 # matches GDB I/O. E.g.:
672 # send_inferior "hello\n"
673 # gdb_test_multiple "continue" "test echo" {
674 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
677 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
678 # fail "hit breakpoint"
682 # The standard patterns, such as "Inferior exited..." and "A problem
683 # ...", all being implicitly appended to that list. These are always
684 # expected from $gdb_spawn_id. IOW, callers do not need to worry
685 # about resetting "-i" back to $gdb_spawn_id explicitly.
687 proc gdb_test_multiple { command message user_code } {
688 global verbose use_gdb_stub
689 global gdb_prompt pagination_prompt
692 global inferior_exited_re
693 upvar timeout timeout
694 upvar expect_out expect_out
697 if { $message == "" } {
701 if [string match "*\[\r\n\]" $command] {
702 error "Invalid trailing newline in \"$message\" test"
705 if [string match "*\[\r\n\]*" $message] {
706 error "Invalid newline in \"$message\" test"
710 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
712 error "gdbserver does not support $command without extended-remote"
715 # TCL/EXPECT WART ALERT
716 # Expect does something very strange when it receives a single braced
717 # argument. It splits it along word separators and performs substitutions.
718 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
719 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
720 # double-quoted list item, "\[ab\]" is just a long way of representing
721 # "[ab]", because the backslashes will be removed by lindex.
723 # Unfortunately, there appears to be no easy way to duplicate the splitting
724 # that expect will do from within TCL. And many places make use of the
725 # "\[0-9\]" construct, so we need to support that; and some places make use
726 # of the "[func]" construct, so we need to support that too. In order to
727 # get this right we have to substitute quoted list elements differently
728 # from braced list elements.
730 # We do this roughly the same way that Expect does it. We have to use two
731 # lists, because if we leave unquoted newlines in the argument to uplevel
732 # they'll be treated as command separators, and if we escape newlines
733 # we mangle newlines inside of command blocks. This assumes that the
734 # input doesn't contain a pattern which contains actual embedded newlines
737 regsub -all {\n} ${user_code} { } subst_code
738 set subst_code [uplevel list $subst_code]
740 set processed_code ""
742 set expecting_action 0
744 foreach item $user_code subst_item $subst_code {
745 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
746 lappend processed_code $item
749 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
750 lappend processed_code $item
753 if { $item == "-timeout" || $item == "-i" } {
755 lappend processed_code $item
758 if { $expecting_arg } {
760 lappend processed_code $subst_item
763 if { $expecting_action } {
764 lappend processed_code "uplevel [list $item]"
765 set expecting_action 0
766 # Cosmetic, no effect on the list.
767 append processed_code "\n"
770 set expecting_action 1
771 lappend processed_code $subst_item
772 if {$patterns != ""} {
775 append patterns "\"$subst_item\""
778 # Also purely cosmetic.
779 regsub -all {\r} $patterns {\\r} patterns
780 regsub -all {\n} $patterns {\\n} patterns
783 send_user "Sending \"$command\" to gdb\n"
784 send_user "Looking to match \"$patterns\"\n"
785 send_user "Message is \"$message\"\n"
789 set string "${command}\n"
790 if { $command != "" } {
791 set multi_line_re "\[\r\n\] *>"
792 while { "$string" != "" } {
793 set foo [string first "\n" "$string"]
794 set len [string length "$string"]
795 if { $foo < [expr $len - 1] } {
796 set str [string range "$string" 0 $foo]
797 if { [send_gdb "$str"] != "" } {
800 if { ! $suppress_flag } {
801 perror "Couldn't send $command to GDB."
806 # since we're checking if each line of the multi-line
807 # command are 'accepted' by GDB here,
808 # we need to set -notransfer expect option so that
809 # command output is not lost for pattern matching
812 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
813 timeout { verbose "partial: timeout" 3 }
815 set string [string range "$string" [expr $foo + 1] end]
816 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
821 if { "$string" != "" } {
822 if { [send_gdb "$string"] != "" } {
825 if { ! $suppress_flag } {
826 perror "Couldn't send $command to GDB."
835 -re ".*A problem internal to GDB has been detected" {
836 fail "$message (GDB internal error)"
837 gdb_internal_error_resync
840 -re "\\*\\*\\* DOSEXIT code.*" {
841 if { $message != "" } {
844 gdb_suppress_entire_file "GDB died"
848 append code $processed_code
850 # Reset the spawn id, in case the processed code used -i.
853 -re "Ending remote debugging.*$gdb_prompt $" {
854 if ![isnative] then {
855 warning "Can`t communicate to remote target."
861 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
862 perror "Undefined command \"$command\"."
866 -re "Ambiguous command.*$gdb_prompt $" {
867 perror "\"$command\" is not a unique command name."
871 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
872 if ![string match "" $message] then {
873 set errmsg "$message (the program exited)"
875 set errmsg "$command (the program exited)"
880 -re "$inferior_exited_re normally.*$gdb_prompt $" {
881 if ![string match "" $message] then {
882 set errmsg "$message (the program exited)"
884 set errmsg "$command (the program exited)"
889 -re "The program is not being run.*$gdb_prompt $" {
890 if ![string match "" $message] then {
891 set errmsg "$message (the program is no longer running)"
893 set errmsg "$command (the program is no longer running)"
898 -re "\r\n$gdb_prompt $" {
899 if ![string match "" $message] then {
904 -re "$pagination_prompt" {
906 perror "Window too small."
910 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
912 gdb_expect -re "$gdb_prompt $"
913 fail "$message (got interactive prompt)"
916 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
918 gdb_expect -re "$gdb_prompt $"
919 fail "$message (got breakpoint menu)"
923 # Patterns below apply to any spawn id specified.
926 perror "Process no longer exists"
927 if { $message != "" } {
933 perror "internal buffer is full."
938 if ![string match "" $message] then {
939 fail "$message (timeout)"
946 set code [catch {gdb_expect $code} string]
948 global errorInfo errorCode
949 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
950 } elseif {$code > 1} {
951 return -code $code $string
956 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
957 # Send a command to gdb; test the result.
959 # COMMAND is the command to execute, send to GDB with send_gdb. If
960 # this is the null string no command is sent.
961 # PATTERN is the pattern to match for a PASS, and must NOT include
962 # the \r\n sequence immediately before the gdb prompt. This argument
963 # may be omitted to just match the prompt, ignoring whatever output
965 # MESSAGE is an optional message to be printed. If this is
966 # omitted, then the pass/fail messages use the command string as the
967 # message. (If this is the empty string, then sometimes we don't
968 # call pass or fail at all; I don't understand this at all.)
969 # QUESTION is a question GDB may ask in response to COMMAND, like
971 # RESPONSE is the response to send if QUESTION appears.
974 # 1 if the test failed,
975 # 0 if the test passes,
976 # -1 if there was an internal error.
978 proc gdb_test { args } {
980 upvar timeout timeout
982 if [llength $args]>2 then {
983 set message [lindex $args 2]
985 set message [lindex $args 0]
987 set command [lindex $args 0]
988 set pattern [lindex $args 1]
990 if [llength $args]==5 {
991 set question_string [lindex $args 3]
992 set response_string [lindex $args 4]
994 set question_string "^FOOBAR$"
997 return [gdb_test_multiple $command $message {
998 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
999 if ![string match "" $message] then {
1003 -re "(${question_string})$" {
1004 send_gdb "$response_string\n"
1010 # gdb_test_no_output COMMAND MESSAGE
1011 # Send a command to GDB and verify that this command generated no output.
1013 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1014 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1015 # the message. (If MESSAGE is the empty string, then sometimes we do not
1016 # call pass or fail at all; I don't understand this at all.)
1018 proc gdb_test_no_output { args } {
1020 set command [lindex $args 0]
1021 if [llength $args]>1 then {
1022 set message [lindex $args 1]
1024 set message $command
1027 set command_regex [string_to_regexp $command]
1028 gdb_test_multiple $command $message {
1029 -re "^$command_regex\r\n$gdb_prompt $" {
1030 if ![string match "" $message] then {
1037 # Send a command and then wait for a sequence of outputs.
1038 # This is useful when the sequence is long and contains ".*", a single
1039 # regexp to match the entire output can get a timeout much easier.
1041 # COMMAND is the command to send.
1042 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1043 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1044 # processed in order, and all must be present in the output.
1046 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1047 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1048 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1050 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1051 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1054 # 1 if the test failed,
1055 # 0 if the test passes,
1056 # -1 if there was an internal error.
1058 proc gdb_test_sequence { command test_name expected_output_list } {
1060 if { $test_name == "" } {
1061 set test_name $command
1063 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1064 send_gdb "$command\n"
1065 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1069 # Test that a command gives an error. For pass or fail, return
1070 # a 1 to indicate that more tests can proceed. However a timeout
1071 # is a serious error, generates a special fail message, and causes
1072 # a 0 to be returned to indicate that more tests are likely to fail
1075 proc test_print_reject { args } {
1079 if [llength $args]==2 then {
1080 set expectthis [lindex $args 1]
1082 set expectthis "should never match this bogus string"
1084 set sendthis [lindex $args 0]
1085 if $verbose>2 then {
1086 send_user "Sending \"$sendthis\" to gdb\n"
1087 send_user "Looking to match \"$expectthis\"\n"
1089 send_gdb "$sendthis\n"
1090 #FIXME: Should add timeout as parameter.
1092 -re "A .* in expression.*\\.*$gdb_prompt $" {
1093 pass "reject $sendthis"
1096 -re "Invalid syntax in expression.*$gdb_prompt $" {
1097 pass "reject $sendthis"
1100 -re "Junk after end of expression.*$gdb_prompt $" {
1101 pass "reject $sendthis"
1104 -re "Invalid number.*$gdb_prompt $" {
1105 pass "reject $sendthis"
1108 -re "Invalid character constant.*$gdb_prompt $" {
1109 pass "reject $sendthis"
1112 -re "No symbol table is loaded.*$gdb_prompt $" {
1113 pass "reject $sendthis"
1116 -re "No symbol .* in current context.*$gdb_prompt $" {
1117 pass "reject $sendthis"
1120 -re "Unmatched single quote.*$gdb_prompt $" {
1121 pass "reject $sendthis"
1124 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1125 pass "reject $sendthis"
1128 -re "$expectthis.*$gdb_prompt $" {
1129 pass "reject $sendthis"
1132 -re ".*$gdb_prompt $" {
1133 fail "reject $sendthis"
1137 fail "reject $sendthis (eof or timeout)"
1144 # Same as gdb_test, but the second parameter is not a regexp,
1145 # but a string that must match exactly.
1147 proc gdb_test_exact { args } {
1148 upvar timeout timeout
1150 set command [lindex $args 0]
1152 # This applies a special meaning to a null string pattern. Without
1153 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1154 # messages from commands that should have no output except a new
1155 # prompt. With this, only results of a null string will match a null
1158 set pattern [lindex $args 1]
1159 if [string match $pattern ""] {
1160 set pattern [string_to_regexp [lindex $args 0]]
1162 set pattern [string_to_regexp [lindex $args 1]]
1165 # It is most natural to write the pattern argument with only
1166 # embedded \n's, especially if you are trying to avoid Tcl quoting
1167 # problems. But gdb_expect really wants to see \r\n in patterns. So
1168 # transform the pattern here. First transform \r\n back to \n, in
1169 # case some users of gdb_test_exact already do the right thing.
1170 regsub -all "\r\n" $pattern "\n" pattern
1171 regsub -all "\n" $pattern "\r\n" pattern
1172 if [llength $args]==3 then {
1173 set message [lindex $args 2]
1175 set message $command
1178 return [gdb_test $command $pattern $message]
1181 # Wrapper around gdb_test_multiple that looks for a list of expected
1182 # output elements, but which can appear in any order.
1183 # CMD is the gdb command.
1184 # NAME is the name of the test.
1185 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1187 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1188 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1189 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1191 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1192 # of text per element and then strip trailing \r\n's.
1194 # gdb_test_list_exact "foo" "bar" \
1195 # "\[^\r\n\]+\[\r\n\]+" \
1198 # {expected result 1} \
1199 # {expected result 2} \
1202 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1205 set matches [lsort $result_match_list]
1207 gdb_test_multiple $cmd $name {
1208 "$cmd\[\r\n\]" { exp_continue }
1209 -re $elm_find_regexp {
1210 set str $expect_out(0,string)
1211 verbose -log "seen: $str" 3
1212 regexp -- $elm_extract_regexp $str elm_seen
1213 verbose -log "extracted: $elm_seen" 3
1214 lappend seen $elm_seen
1217 -re "$gdb_prompt $" {
1219 foreach got [lsort $seen] have $matches {
1220 if {![string equal $got $have]} {
1225 if {[string length $failed] != 0} {
1226 fail "$name ($failed not found)"
1234 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1235 # Send a command to gdb; expect inferior and gdb output.
1237 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1240 # INFERIOR_PATTERN is the pattern to match against inferior output.
1242 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1243 # include the \r\n sequence immediately before the gdb prompt, nor the
1244 # prompt. The default is empty.
1246 # Both inferior and gdb patterns must match for a PASS.
1248 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1251 # 1 if the test failed,
1252 # 0 if the test passes,
1253 # -1 if there was an internal error.
1256 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1257 global inferior_spawn_id gdb_spawn_id
1260 if {$message == ""} {
1261 set message $command
1264 set inferior_matched 0
1267 # Use an indirect spawn id list, and remove the inferior spawn id
1268 # from the expected output as soon as it matches, in case
1269 # $inferior_pattern happens to be a prefix of the resulting full
1270 # gdb pattern below (e.g., "\r\n").
1271 global gdb_test_stdio_spawn_id_list
1272 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1274 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1275 # then we may see gdb's output arriving before the inferior's
1277 set res [gdb_test_multiple $command $message {
1278 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1279 set inferior_matched 1
1280 if {!$gdb_matched} {
1281 set gdb_test_stdio_spawn_id_list ""
1285 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1287 if {!$inferior_matched} {
1295 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1302 # Issue a PASS and return true if evaluating CONDITION in the caller's
1303 # frame returns true, and issue a FAIL and return false otherwise.
1304 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1305 # omitted or is empty, then the pass/fail messages use the condition
1306 # string as the message.
1308 proc gdb_assert { condition {message ""} } {
1309 if { $message == ""} {
1310 set message $condition
1313 set res [uplevel 1 expr $condition]
1322 proc gdb_reinitialize_dir { subdir } {
1325 if [is_remote host] {
1330 -re "Reinitialize source path to empty.*y or n. " {
1333 -re "Source directories searched.*$gdb_prompt $" {
1334 send_gdb "dir $subdir\n"
1336 -re "Source directories searched.*$gdb_prompt $" {
1337 verbose "Dir set to $subdir"
1339 -re "$gdb_prompt $" {
1340 perror "Dir \"$subdir\" failed."
1344 -re "$gdb_prompt $" {
1345 perror "Dir \"$subdir\" failed."
1349 -re "$gdb_prompt $" {
1350 perror "Dir \"$subdir\" failed."
1356 # gdb_exit -- exit the GDB, killing the target program if necessary
1358 proc default_gdb_exit {} {
1360 global INTERNAL_GDBFLAGS GDBFLAGS
1362 global gdb_spawn_id inferior_spawn_id
1363 global inotify_log_file
1365 gdb_stop_suppressing_tests
1367 if ![info exists gdb_spawn_id] {
1371 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1373 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1374 set fd [open $inotify_log_file]
1375 set data [read -nonewline $fd]
1378 if {[string compare $data ""] != 0} {
1379 warning "parallel-unsafe file creations noticed"
1382 set fd [open $inotify_log_file w]
1387 if { [is_remote host] && [board_info host exists fileid] } {
1394 -re "DOSEXIT code" { }
1399 if ![is_remote host] {
1403 unset inferior_spawn_id
1406 # Load a file into the debugger.
1407 # The return value is 0 for success, -1 for failure.
1409 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1410 # to one of these values:
1412 # debug file was loaded successfully and has debug information
1413 # nodebug file was loaded successfully and has no debug information
1414 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1416 # fail file was not loaded
1418 # I tried returning this information as part of the return value,
1419 # but ran into a mess because of the many re-implementations of
1420 # gdb_load in config/*.exp.
1422 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1423 # this if they can get more information set.
1425 proc gdb_file_cmd { arg } {
1429 global last_loaded_file
1431 # Save this for the benefit of gdbserver-support.exp.
1432 set last_loaded_file $arg
1434 # Set whether debug info was found.
1435 # Default to "fail".
1436 global gdb_file_cmd_debug_info
1437 set gdb_file_cmd_debug_info "fail"
1439 if [is_remote host] {
1440 set arg [remote_download host $arg]
1442 perror "download failed"
1447 # The file command used to kill the remote target. For the benefit
1448 # of the testsuite, preserve this behavior.
1451 -re "Kill the program being debugged. .y or n. $" {
1453 verbose "\t\tKilling previous program being debugged"
1456 -re "$gdb_prompt $" {
1461 send_gdb "file $arg\n"
1463 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1464 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1465 set gdb_file_cmd_debug_info "lzma"
1468 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1469 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1470 set gdb_file_cmd_debug_info "nodebug"
1473 -re "Reading symbols from.*done.*$gdb_prompt $" {
1474 verbose "\t\tLoaded $arg into $GDB"
1475 set gdb_file_cmd_debug_info "debug"
1478 -re "Load new symbol table from \".*\".*y or n. $" {
1481 -re "Reading symbols from.*done.*$gdb_prompt $" {
1482 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1483 set gdb_file_cmd_debug_info "debug"
1487 perror "Couldn't load $arg, other program already loaded (timeout)."
1491 perror "Couldn't load $arg, other program already loaded (eof)."
1496 -re "No such file or directory.*$gdb_prompt $" {
1497 perror "($arg) No such file or directory"
1500 -re "A problem internal to GDB has been detected" {
1501 fail "($arg) (GDB internal error)"
1502 gdb_internal_error_resync
1505 -re "$gdb_prompt $" {
1506 perror "Couldn't load $arg into $GDB."
1510 perror "Couldn't load $arg into $GDB (timeout)."
1514 # This is an attempt to detect a core dump, but seems not to
1515 # work. Perhaps we need to match .* followed by eof, in which
1516 # gdb_expect does not seem to have a way to do that.
1517 perror "Couldn't load $arg into $GDB (eof)."
1523 # Default gdb_spawn procedure.
1525 proc default_gdb_spawn { } {
1528 global INTERNAL_GDBFLAGS GDBFLAGS
1531 gdb_stop_suppressing_tests
1533 # Set the default value, it may be overriden later by specific testfile.
1535 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1536 # is already started after connecting and run/attach are not supported.
1537 # This is used for the "remote" protocol. After GDB starts you should
1538 # check global $use_gdb_stub instead of the board as the testfile may force
1539 # a specific different target protocol itself.
1540 set use_gdb_stub [target_info exists use_gdb_stub]
1542 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1544 if [info exists gdb_spawn_id] {
1548 if ![is_remote host] {
1549 if { [which $GDB] == 0 } then {
1550 perror "$GDB does not exist."
1554 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1555 if { $res < 0 || $res == "" } {
1556 perror "Spawning $GDB failed."
1560 set gdb_spawn_id $res
1564 # Default gdb_start procedure.
1566 proc default_gdb_start { } {
1567 global gdb_prompt pagination_prompt
1569 global inferior_spawn_id
1571 if [info exists gdb_spawn_id] {
1580 # Default to assuming inferior I/O is done on GDB's terminal.
1581 if {![info exists inferior_spawn_id]} {
1582 set inferior_spawn_id $gdb_spawn_id
1585 # When running over NFS, particularly if running many simultaneous
1586 # tests on different hosts all using the same server, things can
1587 # get really slow. Give gdb at least 3 minutes to start up.
1589 while { $loop_again } {
1592 -re "$pagination_prompt" {
1593 verbose "Hit pagination during startup. Pressing enter to continue."
1597 -re "\[\r\n\]$gdb_prompt $" {
1598 verbose "GDB initialized."
1600 -re "$gdb_prompt $" {
1601 perror "GDB never initialized."
1606 perror "(timeout) GDB never initialized after 10 seconds."
1614 # force the height to "unlimited", so no pagers get used
1616 send_gdb "set height 0\n"
1618 -re "$gdb_prompt $" {
1619 verbose "Setting height to 0." 2
1622 warning "Couldn't set the height to 0"
1625 # force the width to "unlimited", so no wraparound occurs
1626 send_gdb "set width 0\n"
1628 -re "$gdb_prompt $" {
1629 verbose "Setting width to 0." 2
1632 warning "Couldn't set the width to 0."
1638 # Utility procedure to give user control of the gdb prompt in a script. It is
1639 # meant to be used for debugging test cases, and should not be left in the
1642 proc gdb_interact { } {
1644 set spawn_id $gdb_spawn_id
1646 send_user "+------------------------------------------+\n"
1647 send_user "| Script interrupted, you can now interact |\n"
1648 send_user "| with by gdb. Type >>> to continue. |\n"
1649 send_user "+------------------------------------------+\n"
1656 # Examine the output of compilation to determine whether compilation
1657 # failed or not. If it failed determine whether it is due to missing
1658 # compiler or due to compiler error. Report pass, fail or unsupported
1661 proc gdb_compile_test {src output} {
1662 if { $output == "" } {
1663 pass "compilation [file tail $src]"
1664 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1665 unsupported "compilation [file tail $src]"
1666 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1667 unsupported "compilation [file tail $src]"
1668 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1669 unsupported "compilation [file tail $src]"
1671 verbose -log "compilation failed: $output" 2
1672 fail "compilation [file tail $src]"
1676 # Return a 1 for configurations for which we don't even want to try to
1679 proc skip_cplus_tests {} {
1680 if { [istarget "h8300-*-*"] } {
1684 # The C++ IO streams are too large for HC11/HC12 and are thus not
1685 # available. The gdb C++ tests use them and don't compile.
1686 if { [istarget "m6811-*-*"] } {
1689 if { [istarget "m6812-*-*"] } {
1695 # Return a 1 for configurations for which don't have both C++ and the STL.
1697 proc skip_stl_tests {} {
1698 # Symbian supports the C++ language, but the STL is missing
1699 # (both headers and libraries).
1700 if { [istarget "arm*-*-symbianelf*"] } {
1704 return [skip_cplus_tests]
1707 # Return a 1 if I don't even want to try to test FORTRAN.
1709 proc skip_fortran_tests {} {
1713 # Return a 1 if I don't even want to try to test ada.
1715 proc skip_ada_tests {} {
1719 # Return a 1 if I don't even want to try to test GO.
1721 proc skip_go_tests {} {
1725 # Return a 1 if I don't even want to try to test java.
1727 proc skip_java_tests {} {
1731 # Return a 1 if I don't even want to try to test D.
1733 proc skip_d_tests {} {
1737 # Return 1 to skip Rust tests, 0 to try them.
1738 proc skip_rust_tests {} {
1739 return [expr {![isnative]}]
1742 # Return a 1 for configurations that do not support Python scripting.
1743 # PROMPT_REGEXP is the expected prompt.
1745 proc skip_python_tests_prompt { prompt_regexp } {
1746 global gdb_py_is_py3k
1747 global gdb_py_is_py24
1749 gdb_test_multiple "python print ('test')" "verify python support" {
1750 -re "not supported.*$prompt_regexp" {
1751 unsupported "Python support is disabled."
1754 -re "$prompt_regexp" {}
1757 set gdb_py_is_py24 0
1758 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1759 -re "3.*$prompt_regexp" {
1760 set gdb_py_is_py3k 1
1762 -re ".*$prompt_regexp" {
1763 set gdb_py_is_py3k 0
1766 if { $gdb_py_is_py3k == 0 } {
1767 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1768 -re "\[45\].*$prompt_regexp" {
1769 set gdb_py_is_py24 1
1771 -re ".*$prompt_regexp" {
1772 set gdb_py_is_py24 0
1780 # Return a 1 for configurations that do not support Python scripting.
1781 # Note: This also sets various globals that specify which version of Python
1782 # is in use. See skip_python_tests_prompt.
1784 proc skip_python_tests {} {
1786 return [skip_python_tests_prompt "$gdb_prompt $"]
1789 # Return a 1 if we should skip shared library tests.
1791 proc skip_shlib_tests {} {
1792 # Run the shared library tests on native systems.
1797 # An abbreviated list of remote targets where we should be able to
1798 # run shared library tests.
1799 if {([istarget *-*-linux*]
1800 || [istarget *-*-*bsd*]
1801 || [istarget *-*-solaris2*]
1802 || [istarget arm*-*-symbianelf*]
1803 || [istarget *-*-mingw*]
1804 || [istarget *-*-cygwin*]
1805 || [istarget *-*-pe*])} {
1812 # Return 1 if we should skip tui related tests.
1814 proc skip_tui_tests {} {
1817 gdb_test_multiple "help layout" "verify tui support" {
1818 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1821 -re "$gdb_prompt $" {
1828 # Test files shall make sure all the test result lines in gdb.sum are
1829 # unique in a test run, so that comparing the gdb.sum files of two
1830 # test runs gives correct results. Test files that exercise
1831 # variations of the same tests more than once, shall prefix the
1832 # different test invocations with different identifying strings in
1833 # order to make them unique.
1835 # About test prefixes:
1837 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1838 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1839 # underlined substring in
1841 # PASS: gdb.base/mytest.exp: some test
1842 # ^^^^^^^^^^^^^^^^^^^^
1846 # The easiest way to adjust the test prefix is to append a test
1847 # variation prefix to the $pf_prefix, using the with_test_prefix
1850 # proc do_tests {} {
1851 # gdb_test ... ... "test foo"
1852 # gdb_test ... ... "test bar"
1854 # with_test_prefix "subvariation a" {
1855 # gdb_test ... ... "test x"
1858 # with_test_prefix "subvariation b" {
1859 # gdb_test ... ... "test x"
1863 # with_test_prefix "variation1" {
1864 # ...do setup for variation 1...
1868 # with_test_prefix "variation2" {
1869 # ...do setup for variation 2...
1875 # PASS: gdb.base/mytest.exp: variation1: test foo
1876 # PASS: gdb.base/mytest.exp: variation1: test bar
1877 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1878 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1879 # PASS: gdb.base/mytest.exp: variation2: test foo
1880 # PASS: gdb.base/mytest.exp: variation2: test bar
1881 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1882 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1884 # If for some reason more flexibility is necessary, one can also
1885 # manipulate the pf_prefix global directly, treating it as a string.
1889 # set saved_pf_prefix
1890 # append pf_prefix "${foo}: bar"
1891 # ... actual tests ...
1892 # set pf_prefix $saved_pf_prefix
1895 # Run BODY in the context of the caller, with the current test prefix
1896 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1897 # Returns the result of BODY.
1899 proc with_test_prefix { prefix body } {
1902 set saved $pf_prefix
1903 append pf_prefix " " $prefix ":"
1904 set code [catch {uplevel 1 $body} result]
1905 set pf_prefix $saved
1908 global errorInfo errorCode
1909 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1911 return -code $code $result
1915 # Wrapper for foreach that calls with_test_prefix on each iteration,
1916 # including the iterator's name and current value in the prefix.
1918 proc foreach_with_prefix {var list body} {
1920 foreach myvar $list {
1921 with_test_prefix "$var=$myvar" {
1927 # Run BODY in the context of the caller. After BODY is run, the variables
1928 # listed in VARS will be reset to the values they had before BODY was run.
1930 # This is useful for providing a scope in which it is safe to temporarily
1931 # modify global variables, e.g.
1933 # global INTERNAL_GDBFLAGS
1936 # set foo GDBHISTSIZE
1938 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1939 # append INTERNAL_GDBFLAGS " -nx"
1940 # unset -nocomplain env(GDBHISTSIZE)
1945 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1946 # modified inside BODY, this proc guarantees that the modifications will be
1947 # undone after BODY finishes executing.
1949 proc save_vars { vars body } {
1950 array set saved_scalars { }
1951 array set saved_arrays { }
1955 # First evaluate VAR in the context of the caller in case the variable
1956 # name may be a not-yet-interpolated string like env($foo)
1957 set var [uplevel 1 list $var]
1959 if [uplevel 1 [list info exists $var]] {
1960 if [uplevel 1 [list array exists $var]] {
1961 set saved_arrays($var) [uplevel 1 [list array get $var]]
1963 set saved_scalars($var) [uplevel 1 [list set $var]]
1966 lappend unset_vars $var
1970 set code [catch {uplevel 1 $body} result]
1972 foreach {var value} [array get saved_scalars] {
1973 uplevel 1 [list set $var $value]
1976 foreach {var value} [array get saved_arrays] {
1977 uplevel 1 [list unset $var]
1978 uplevel 1 [list array set $var $value]
1981 foreach var $unset_vars {
1982 uplevel 1 [list unset -nocomplain $var]
1986 global errorInfo errorCode
1987 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1989 return -code $code $result
1994 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1995 # PROMPT. When BODY is finished, restore GDB prompt and variable
1997 # Returns the result of BODY.
2001 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2002 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2003 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2004 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2005 # a) It's more intuitive for callers to pass the plain text form.
2006 # b) We need two forms of the prompt:
2007 # - a regexp to use in output matching,
2008 # - a value to pass to the "set prompt" command.
2009 # c) It's easier to convert the plain text form to its regexp form.
2011 # 2) Don't add a trailing space, we do that here.
2013 proc with_gdb_prompt { prompt body } {
2016 # Convert "(foo)" to "\(foo\)".
2017 # We don't use string_to_regexp because while it works today it's not
2018 # clear it will work tomorrow: the value we need must work as both a
2019 # regexp *and* as the argument to the "set prompt" command, at least until
2020 # we start recording both forms separately instead of just $gdb_prompt.
2021 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2023 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2025 set saved $gdb_prompt
2027 verbose -log "Setting gdb prompt to \"$prompt \"."
2028 set gdb_prompt $prompt
2029 gdb_test_no_output "set prompt $prompt " ""
2031 set code [catch {uplevel 1 $body} result]
2033 verbose -log "Restoring gdb prompt to \"$saved \"."
2034 set gdb_prompt $saved
2035 gdb_test_no_output "set prompt $saved " ""
2038 global errorInfo errorCode
2039 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2041 return -code $code $result
2045 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2046 # BODY is finished, restore target-charset.
2048 proc with_target_charset { target_charset body } {
2052 gdb_test_multiple "show target-charset" "" {
2053 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2054 set saved $expect_out(1,string)
2056 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2057 set saved $expect_out(1,string)
2059 -re ".*$gdb_prompt " {
2060 fail "get target-charset"
2064 gdb_test_no_output "set target-charset $target_charset" ""
2066 set code [catch {uplevel 1 $body} result]
2068 gdb_test_no_output "set target-charset $saved" ""
2071 global errorInfo errorCode
2072 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2074 return -code $code $result
2078 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2079 # mi_gdb_test etc. default to using it.
2081 proc switch_gdb_spawn_id {spawn_id} {
2083 global board board_info
2085 set gdb_spawn_id $spawn_id
2086 set board [host_info name]
2087 set board_info($board,fileid) $spawn_id
2090 # Clear the default spawn id.
2092 proc clear_gdb_spawn_id {} {
2094 global board board_info
2096 unset -nocomplain gdb_spawn_id
2097 set board [host_info name]
2098 unset -nocomplain board_info($board,fileid)
2101 # Run BODY with SPAWN_ID as current spawn id.
2103 proc with_spawn_id { spawn_id body } {
2106 if [info exists gdb_spawn_id] {
2107 set saved_spawn_id $gdb_spawn_id
2110 switch_gdb_spawn_id $spawn_id
2112 set code [catch {uplevel 1 $body} result]
2114 if [info exists saved_spawn_id] {
2115 switch_gdb_spawn_id $saved_spawn_id
2121 global errorInfo errorCode
2122 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2124 return -code $code $result
2128 # Select the largest timeout from all the timeouts:
2129 # - the local "timeout" variable of the scope two levels above,
2130 # - the global "timeout" variable,
2131 # - the board variable "gdb,timeout".
2133 proc get_largest_timeout {} {
2134 upvar #0 timeout gtimeout
2135 upvar 2 timeout timeout
2138 if [info exists timeout] {
2141 if { [info exists gtimeout] && $gtimeout > $tmt } {
2144 if { [target_info exists gdb,timeout]
2145 && [target_info gdb,timeout] > $tmt } {
2146 set tmt [target_info gdb,timeout]
2156 # Run tests in BODY with timeout increased by factor of FACTOR. When
2157 # BODY is finished, restore timeout.
2159 proc with_timeout_factor { factor body } {
2162 set savedtimeout $timeout
2164 set timeout [expr [get_largest_timeout] * $factor]
2165 set code [catch {uplevel 1 $body} result]
2167 set timeout $savedtimeout
2169 global errorInfo errorCode
2170 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2172 return -code $code $result
2176 # Return 1 if _Complex types are supported, otherwise, return 0.
2178 gdb_caching_proc support_complex_tests {
2179 # Set up, compile, and execute a test program containing _Complex types.
2180 # Include the current process ID in the file names to prevent conflicts
2181 # with invocations for multiple testsuites.
2182 set src [standard_temp_file complex[pid].c]
2183 set exe [standard_temp_file complex[pid].x]
2185 gdb_produce_source $src {
2189 _Complex long double cld;
2194 verbose "compiling testfile $src" 2
2195 set compile_flags {debug nowarnings quiet}
2196 set lines [gdb_compile $src $exe executable $compile_flags]
2200 if ![string match "" $lines] then {
2201 verbose "testfile compilation failed, returning 0" 2
2210 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2213 proc supports_get_siginfo_type {} {
2214 if { [istarget "*-*-linux*"] } {
2221 # Return 1 if the target supports hardware single stepping.
2223 proc can_hardware_single_step {} {
2225 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2226 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2227 || [istarget "nios2-*-*"] } {
2234 # Return 1 if target hardware or OS supports single stepping to signal
2235 # handler, otherwise, return 0.
2237 proc can_single_step_to_signal_handler {} {
2238 # Targets don't have hardware single step. On these targets, when
2239 # a signal is delivered during software single step, gdb is unable
2240 # to determine the next instruction addresses, because start of signal
2241 # handler is one of them.
2242 return [can_hardware_single_step]
2245 # Return 1 if target supports process record, otherwise return 0.
2247 proc supports_process_record {} {
2249 if [target_info exists gdb,use_precord] {
2250 return [target_info gdb,use_precord]
2253 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2254 || [istarget "i\[34567\]86-*-linux*"]
2255 || [istarget "aarch64*-*-linux*"]
2256 || [istarget "powerpc*-*-linux*"]
2257 || [istarget "s390*-*-linux*"] } {
2264 # Return 1 if target supports reverse debugging, otherwise return 0.
2266 proc supports_reverse {} {
2268 if [target_info exists gdb,can_reverse] {
2269 return [target_info gdb,can_reverse]
2272 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2273 || [istarget "i\[34567\]86-*-linux*"]
2274 || [istarget "aarch64*-*-linux*"]
2275 || [istarget "powerpc*-*-linux*"]
2276 || [istarget "s390*-*-linux*"] } {
2283 # Return 1 if readline library is used.
2285 proc readline_is_used { } {
2288 gdb_test_multiple "show editing" "" {
2289 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2292 -re ".*$gdb_prompt $" {
2298 # Return 1 if target is ELF.
2299 gdb_caching_proc is_elf_target {
2300 set me "is_elf_target"
2302 set src [standard_temp_file is_elf_target[pid].c]
2303 set obj [standard_temp_file is_elf_target[pid].o]
2305 gdb_produce_source $src {
2306 int foo () {return 0;}
2309 verbose "$me: compiling testfile $src" 2
2310 set lines [gdb_compile $src $obj object {quiet}]
2314 if ![string match "" $lines] then {
2315 verbose "$me: testfile compilation failed, returning 0" 2
2319 set fp_obj [open $obj "r"]
2320 fconfigure $fp_obj -translation binary
2321 set data [read $fp_obj]
2326 set ELFMAG "\u007FELF"
2328 if {[string compare -length 4 $data $ELFMAG] != 0} {
2329 verbose "$me: returning 0" 2
2333 verbose "$me: returning 1" 2
2337 # Return 1 if the memory at address zero is readable.
2339 gdb_caching_proc is_address_zero_readable {
2343 gdb_test_multiple "x 0" "" {
2344 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2347 -re ".*$gdb_prompt $" {
2355 # Produce source file NAME and write SOURCES into it.
2357 proc gdb_produce_source { name sources } {
2359 set f [open $name "w"]
2365 # Return 1 if target is ILP32.
2366 # This cannot be decided simply from looking at the target string,
2367 # as it might depend on externally passed compiler options like -m64.
2368 gdb_caching_proc is_ilp32_target {
2369 set me "is_ilp32_target"
2371 set src [standard_temp_file ilp32[pid].c]
2372 set obj [standard_temp_file ilp32[pid].o]
2374 gdb_produce_source $src {
2375 int dummy[sizeof (int) == 4
2376 && sizeof (void *) == 4
2377 && sizeof (long) == 4 ? 1 : -1];
2380 verbose "$me: compiling testfile $src" 2
2381 set lines [gdb_compile $src $obj object {quiet}]
2385 if ![string match "" $lines] then {
2386 verbose "$me: testfile compilation failed, returning 0" 2
2390 verbose "$me: returning 1" 2
2394 # Return 1 if target is LP64.
2395 # This cannot be decided simply from looking at the target string,
2396 # as it might depend on externally passed compiler options like -m64.
2397 gdb_caching_proc is_lp64_target {
2398 set me "is_lp64_target"
2400 set src [standard_temp_file lp64[pid].c]
2401 set obj [standard_temp_file lp64[pid].o]
2403 gdb_produce_source $src {
2404 int dummy[sizeof (int) == 4
2405 && sizeof (void *) == 8
2406 && sizeof (long) == 8 ? 1 : -1];
2409 verbose "$me: compiling testfile $src" 2
2410 set lines [gdb_compile $src $obj object {quiet}]
2414 if ![string match "" $lines] then {
2415 verbose "$me: testfile compilation failed, returning 0" 2
2419 verbose "$me: returning 1" 2
2423 # Return 1 if target has 64 bit addresses.
2424 # This cannot be decided simply from looking at the target string,
2425 # as it might depend on externally passed compiler options like -m64.
2426 gdb_caching_proc is_64_target {
2427 set me "is_64_target"
2429 set src [standard_temp_file is64[pid].c]
2430 set obj [standard_temp_file is64[pid].o]
2432 gdb_produce_source $src {
2433 int function(void) { return 3; }
2434 int dummy[sizeof (&function) == 8 ? 1 : -1];
2437 verbose "$me: compiling testfile $src" 2
2438 set lines [gdb_compile $src $obj object {quiet}]
2442 if ![string match "" $lines] then {
2443 verbose "$me: testfile compilation failed, returning 0" 2
2447 verbose "$me: returning 1" 2
2451 # Return 1 if target has x86_64 registers - either amd64 or x32.
2452 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2453 # just from the target string.
2454 gdb_caching_proc is_amd64_regs_target {
2455 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2459 set me "is_amd64_regs_target"
2461 set src [standard_temp_file reg64[pid].s]
2462 set obj [standard_temp_file reg64[pid].o]
2466 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2467 lappend list "\tincq %$reg"
2469 gdb_produce_source $src [join $list \n]
2471 verbose "$me: compiling testfile $src" 2
2472 set lines [gdb_compile $src $obj object {quiet}]
2476 if ![string match "" $lines] then {
2477 verbose "$me: testfile compilation failed, returning 0" 2
2481 verbose "$me: returning 1" 2
2485 # Return 1 if this target is an x86 or x86-64 with -m32.
2486 proc is_x86_like_target {} {
2487 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2490 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2493 # Return 1 if this target is an arm or aarch32 on aarch64.
2495 gdb_caching_proc is_aarch32_target {
2496 if { [istarget "arm*-*-*"] } {
2500 if { ![istarget "aarch64*-*-*"] } {
2504 set me "is_aarch32_target"
2506 set src [standard_temp_file aarch32[pid].s]
2507 set obj [standard_temp_file aarch32[pid].o]
2512 lappend list "\tmov $reg, $reg"
2514 gdb_produce_source $src [join $list \n]
2516 verbose "$me: compiling testfile $src" 2
2517 set lines [gdb_compile $src $obj object {quiet}]
2521 if ![string match "" $lines] then {
2522 verbose "$me: testfile compilation failed, returning 0" 2
2526 verbose "$me: returning 1" 2
2530 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2532 proc is_aarch64_target {} {
2533 if { ![istarget "aarch64*-*-*"] } {
2537 return [expr ![is_aarch32_target]]
2540 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2541 proc support_displaced_stepping {} {
2543 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2544 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2545 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2546 || [istarget "aarch64*-*-linux*"] } {
2553 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2554 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2556 gdb_caching_proc skip_altivec_tests {
2557 global srcdir subdir gdb_prompt inferior_exited_re
2559 set me "skip_altivec_tests"
2561 # Some simulators are known to not support VMX instructions.
2562 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2563 verbose "$me: target known to not support VMX, returning 1" 2
2567 # Make sure we have a compiler that understands altivec.
2568 set compile_flags {debug nowarnings}
2569 if [get_compiler_info] {
2570 warning "Could not get compiler info"
2573 if [test_compiler_info gcc*] {
2574 set compile_flags "$compile_flags additional_flags=-maltivec"
2575 } elseif [test_compiler_info xlc*] {
2576 set compile_flags "$compile_flags additional_flags=-qaltivec"
2578 verbose "Could not compile with altivec support, returning 1" 2
2582 # Set up, compile, and execute a test program containing VMX instructions.
2583 # Include the current process ID in the file names to prevent conflicts
2584 # with invocations for multiple testsuites.
2585 set src [standard_temp_file vmx[pid].c]
2586 set exe [standard_temp_file vmx[pid].x]
2588 gdb_produce_source $src {
2591 asm volatile ("vor v0,v0,v0");
2593 asm volatile ("vor 0,0,0");
2599 verbose "$me: compiling testfile $src" 2
2600 set lines [gdb_compile $src $exe executable $compile_flags]
2603 if ![string match "" $lines] then {
2604 verbose "$me: testfile compilation failed, returning 1" 2
2608 # No error message, compilation succeeded so now run it via gdb.
2612 gdb_reinitialize_dir $srcdir/$subdir
2616 -re ".*Illegal instruction.*${gdb_prompt} $" {
2617 verbose -log "\n$me altivec hardware not detected"
2618 set skip_vmx_tests 1
2620 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2621 verbose -log "\n$me: altivec hardware detected"
2622 set skip_vmx_tests 0
2625 warning "\n$me: default case taken"
2626 set skip_vmx_tests 1
2630 remote_file build delete $exe
2632 verbose "$me: returning $skip_vmx_tests" 2
2633 return $skip_vmx_tests
2636 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2637 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2639 gdb_caching_proc skip_vsx_tests {
2640 global srcdir subdir gdb_prompt inferior_exited_re
2642 set me "skip_vsx_tests"
2644 # Some simulators are known to not support Altivec instructions, so
2645 # they won't support VSX instructions as well.
2646 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2647 verbose "$me: target known to not support VSX, returning 1" 2
2651 # Make sure we have a compiler that understands altivec.
2652 set compile_flags {debug nowarnings quiet}
2653 if [get_compiler_info] {
2654 warning "Could not get compiler info"
2657 if [test_compiler_info gcc*] {
2658 set compile_flags "$compile_flags additional_flags=-mvsx"
2659 } elseif [test_compiler_info xlc*] {
2660 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2662 verbose "Could not compile with vsx support, returning 1" 2
2666 set src [standard_temp_file vsx[pid].c]
2667 set exe [standard_temp_file vsx[pid].x]
2669 gdb_produce_source $src {
2671 double a[2] = { 1.0, 2.0 };
2673 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2675 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2681 verbose "$me: compiling testfile $src" 2
2682 set lines [gdb_compile $src $exe executable $compile_flags]
2685 if ![string match "" $lines] then {
2686 verbose "$me: testfile compilation failed, returning 1" 2
2690 # No error message, compilation succeeded so now run it via gdb.
2694 gdb_reinitialize_dir $srcdir/$subdir
2698 -re ".*Illegal instruction.*${gdb_prompt} $" {
2699 verbose -log "\n$me VSX hardware not detected"
2700 set skip_vsx_tests 1
2702 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2703 verbose -log "\n$me: VSX hardware detected"
2704 set skip_vsx_tests 0
2707 warning "\n$me: default case taken"
2708 set skip_vsx_tests 1
2712 remote_file build delete $exe
2714 verbose "$me: returning $skip_vsx_tests" 2
2715 return $skip_vsx_tests
2718 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2719 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2721 gdb_caching_proc skip_tsx_tests {
2722 global srcdir subdir gdb_prompt inferior_exited_re
2724 set me "skip_tsx_tests"
2726 set src [standard_temp_file tsx[pid].c]
2727 set exe [standard_temp_file tsx[pid].x]
2729 gdb_produce_source $src {
2731 asm volatile ("xbegin .L0");
2732 asm volatile ("xend");
2733 asm volatile (".L0: nop");
2738 verbose "$me: compiling testfile $src" 2
2739 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2742 if ![string match "" $lines] then {
2743 verbose "$me: testfile compilation failed." 2
2747 # No error message, compilation succeeded so now run it via gdb.
2751 gdb_reinitialize_dir $srcdir/$subdir
2755 -re ".*Illegal instruction.*${gdb_prompt} $" {
2756 verbose -log "$me: TSX hardware not detected."
2757 set skip_tsx_tests 1
2759 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2760 verbose -log "$me: TSX hardware detected."
2761 set skip_tsx_tests 0
2764 warning "\n$me: default case taken."
2765 set skip_tsx_tests 1
2769 remote_file build delete $exe
2771 verbose "$me: returning $skip_tsx_tests" 2
2772 return $skip_tsx_tests
2775 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2776 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2778 gdb_caching_proc skip_btrace_tests {
2779 global srcdir subdir gdb_prompt inferior_exited_re
2781 set me "skip_btrace_tests"
2782 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2783 verbose "$me: target does not support btrace, returning 1" 2
2787 # Set up, compile, and execute a test program.
2788 # Include the current process ID in the file names to prevent conflicts
2789 # with invocations for multiple testsuites.
2790 set src [standard_temp_file btrace[pid].c]
2791 set exe [standard_temp_file btrace[pid].x]
2793 gdb_produce_source $src {
2794 int main(void) { return 0; }
2797 verbose "$me: compiling testfile $src" 2
2798 set compile_flags {debug nowarnings quiet}
2799 set lines [gdb_compile $src $exe executable $compile_flags]
2801 if ![string match "" $lines] then {
2802 verbose "$me: testfile compilation failed, returning 1" 2
2807 # No error message, compilation succeeded so now run it via gdb.
2811 gdb_reinitialize_dir $srcdir/$subdir
2818 # In case of an unexpected output, we return 2 as a fail value.
2819 set skip_btrace_tests 2
2820 gdb_test_multiple "record btrace" "check btrace support" {
2821 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2822 set skip_btrace_tests 1
2824 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2825 set skip_btrace_tests 1
2827 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2828 set skip_btrace_tests 1
2830 -re "^record btrace\r\n$gdb_prompt $" {
2831 set skip_btrace_tests 0
2835 remote_file build delete $exe
2837 verbose "$me: returning $skip_btrace_tests" 2
2838 return $skip_btrace_tests
2841 # Run a test on the target to see if it supports btrace pt hardware.
2842 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2843 # from the GCC testsuite.
2845 gdb_caching_proc skip_btrace_pt_tests {
2846 global srcdir subdir gdb_prompt inferior_exited_re
2848 set me "skip_btrace_tests"
2849 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2850 verbose "$me: target does not support btrace, returning 1" 2
2854 # Set up, compile, and execute a test program.
2855 # Include the current process ID in the file names to prevent conflicts
2856 # with invocations for multiple testsuites.
2857 set src [standard_temp_file btrace[pid].c]
2858 set exe [standard_temp_file btrace[pid].x]
2860 gdb_produce_source $src {
2861 int main(void) { return 0; }
2864 verbose "$me: compiling testfile $src" 2
2865 set compile_flags {debug nowarnings quiet}
2866 set lines [gdb_compile $src $exe executable $compile_flags]
2868 if ![string match "" $lines] then {
2869 verbose "$me: testfile compilation failed, returning 1" 2
2874 # No error message, compilation succeeded so now run it via gdb.
2878 gdb_reinitialize_dir $srcdir/$subdir
2885 # In case of an unexpected output, we return 2 as a fail value.
2886 set skip_btrace_tests 2
2887 gdb_test_multiple "record btrace pt" "check btrace support" {
2888 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2889 set skip_btrace_tests 1
2891 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2892 set skip_btrace_tests 1
2894 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2895 set skip_btrace_tests 1
2897 -re "GDB does not support.*\r\n$gdb_prompt $" {
2898 set skip_btrace_tests 1
2900 -re "^record btrace pt\r\n$gdb_prompt $" {
2901 set skip_btrace_tests 0
2905 remote_file build delete $exe
2907 verbose "$me: returning $skip_btrace_tests" 2
2908 return $skip_btrace_tests
2911 # Return whether we should skip tests for showing inlined functions in
2912 # backtraces. Requires get_compiler_info and get_debug_format.
2914 proc skip_inline_frame_tests {} {
2915 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2916 if { ! [test_debug_format "DWARF 2"] } {
2920 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2921 if { ([test_compiler_info "gcc-2-*"]
2922 || [test_compiler_info "gcc-3-*"]
2923 || [test_compiler_info "gcc-4-0-*"]) } {
2930 # Return whether we should skip tests for showing variables from
2931 # inlined functions. Requires get_compiler_info and get_debug_format.
2933 proc skip_inline_var_tests {} {
2934 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2935 if { ! [test_debug_format "DWARF 2"] } {
2942 # Return a 1 if we should skip tests that require hardware breakpoints
2944 proc skip_hw_breakpoint_tests {} {
2945 # Skip tests if requested by the board (note that no_hardware_watchpoints
2946 # disables both watchpoints and breakpoints)
2947 if { [target_info exists gdb,no_hardware_watchpoints]} {
2951 # These targets support hardware breakpoints natively
2952 if { [istarget "i?86-*-*"]
2953 || [istarget "x86_64-*-*"]
2954 || [istarget "ia64-*-*"]
2955 || [istarget "arm*-*-*"]
2956 || [istarget "aarch64*-*-*"]
2957 || [istarget "s390*-*-*"] } {
2964 # Return a 1 if we should skip tests that require hardware watchpoints
2966 proc skip_hw_watchpoint_tests {} {
2967 # Skip tests if requested by the board
2968 if { [target_info exists gdb,no_hardware_watchpoints]} {
2972 # These targets support hardware watchpoints natively
2973 if { [istarget "i?86-*-*"]
2974 || [istarget "x86_64-*-*"]
2975 || [istarget "ia64-*-*"]
2976 || [istarget "arm*-*-*"]
2977 || [istarget "aarch64*-*-*"]
2978 || [istarget "powerpc*-*-linux*"]
2979 || [istarget "s390*-*-*"] } {
2986 # Return a 1 if we should skip tests that require *multiple* hardware
2987 # watchpoints to be active at the same time
2989 proc skip_hw_watchpoint_multi_tests {} {
2990 if { [skip_hw_watchpoint_tests] } {
2994 # These targets support just a single hardware watchpoint
2995 if { [istarget "arm*-*-*"]
2996 || [istarget "powerpc*-*-linux*"] } {
3003 # Return a 1 if we should skip tests that require read/access watchpoints
3005 proc skip_hw_watchpoint_access_tests {} {
3006 if { [skip_hw_watchpoint_tests] } {
3010 # These targets support just write watchpoints
3011 if { [istarget "s390*-*-*"] } {
3018 # Return 1 if we should skip tests that require the runtime unwinder
3019 # hook. This must be invoked while gdb is running, after shared
3020 # libraries have been loaded. This is needed because otherwise a
3021 # shared libgcc won't be visible.
3023 proc skip_unwinder_tests {} {
3027 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3028 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3030 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3033 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3037 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3038 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3041 -re "\r\n$gdb_prompt $" {
3048 # Return 0 if we should skip tests that require the libstdc++ stap
3049 # probes. This must be invoked while gdb is running, after shared
3050 # libraries have been loaded.
3052 proc skip_libstdcxx_probe_tests {} {
3056 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3057 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3060 -re "\r\n$gdb_prompt $" {
3066 # Return 1 if we should skip tests of the "compile" feature.
3067 # This must be invoked after the inferior has been started.
3069 proc skip_compile_feature_tests {} {
3073 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3074 "Could not load libcc1.*\r\n$gdb_prompt $" {
3077 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3080 -re "\r\n$gdb_prompt $" {
3086 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3089 proc gdb_is_target_remote_prompt { prompt_regexp } {
3091 set test "probe for target remote"
3092 gdb_test_multiple "maint print target-stack" $test {
3093 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3097 -re "$prompt_regexp" {
3104 # Check whether we're testing with the remote or extended-remote
3107 proc gdb_is_target_remote {} {
3110 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3113 # Return the effective value of use_gdb_stub.
3115 # If the use_gdb_stub global has been set (it is set when the gdb process is
3116 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3117 # property from the board file.
3119 # This is the preferred way of checking use_gdb_stub, since it allows to check
3120 # the value before the gdb has been spawned and it will return the correct value
3121 # even when it was overriden by the test.
3123 proc use_gdb_stub {} {
3126 if [info exists use_gdb_stub] {
3127 return $use_gdb_stub
3130 return [target_info exists use_gdb_stub]
3133 # Return 1 if the current remote target is an instance of our GDBserver, 0
3134 # otherwise. Return -1 if there was an error and we can't tell.
3136 gdb_caching_proc target_is_gdbserver {
3140 set test "Probing for GDBserver"
3142 gdb_test_multiple "monitor help" $test {
3143 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3146 -re "$gdb_prompt $" {
3151 if { $is_gdbserver == -1 } {
3152 verbose -log "Unable to tell whether we are using GDBserver or not."
3155 return $is_gdbserver
3158 # N.B. compiler_info is intended to be local to this file.
3159 # Call test_compiler_info with no arguments to fetch its value.
3160 # Yes, this is counterintuitive when there's get_compiler_info,
3161 # but that's the current API.
3162 if [info exists compiler_info] {
3168 # Figure out what compiler I am using.
3169 # The result is cached so only the first invocation runs the compiler.
3171 # ARG can be empty or "C++". If empty, "C" is assumed.
3173 # There are several ways to do this, with various problems.
3175 # [ gdb_compile -E $ifile -o $binfile.ci ]
3176 # source $binfile.ci
3178 # Single Unix Spec v3 says that "-E -o ..." together are not
3179 # specified. And in fact, the native compiler on hp-ux 11 (among
3180 # others) does not work with "-E -o ...". Most targets used to do
3181 # this, and it mostly worked, because it works with gcc.
3183 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3184 # source $binfile.ci
3186 # This avoids the problem with -E and -o together. This almost works
3187 # if the build machine is the same as the host machine, which is
3188 # usually true of the targets which are not gcc. But this code does
3189 # not figure which compiler to call, and it always ends up using the C
3190 # compiler. Not good for setting hp_aCC_compiler. Target
3191 # hppa*-*-hpux* used to do this.
3193 # [ gdb_compile -E $ifile > $binfile.ci ]
3194 # source $binfile.ci
3196 # dejagnu target_compile says that it supports output redirection,
3197 # but the code is completely different from the normal path and I
3198 # don't want to sweep the mines from that path. So I didn't even try
3201 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3204 # I actually do this for all targets now. gdb_compile runs the right
3205 # compiler, and TCL captures the output, and I eval the output.
3207 # Unfortunately, expect logs the output of the command as it goes by,
3208 # and dejagnu helpfully prints a second copy of it right afterwards.
3209 # So I turn off expect logging for a moment.
3211 # [ gdb_compile $ifile $ciexe_file executable $args ]
3212 # [ remote_exec $ciexe_file ]
3213 # [ source $ci_file.out ]
3215 # I could give up on -E and just do this.
3216 # I didn't get desperate enough to try this.
3218 # -- chastain 2004-01-06
3220 proc get_compiler_info {{arg ""}} {
3221 # For compiler.c and compiler.cc
3224 # I am going to play with the log to keep noise out.
3228 # These come from compiler.c or compiler.cc
3229 global compiler_info
3231 # Legacy global data symbols.
3234 if [info exists compiler_info] {
3239 # Choose which file to preprocess.
3240 set ifile "${srcdir}/lib/compiler.c"
3241 if { $arg == "c++" } {
3242 set ifile "${srcdir}/lib/compiler.cc"
3245 # Run $ifile through the right preprocessor.
3246 # Toggle gdb.log to keep the compiler output out of the log.
3247 set saved_log [log_file -info]
3249 if [is_remote host] {
3250 # We have to use -E and -o together, despite the comments
3251 # above, because of how DejaGnu handles remote host testing.
3252 set ppout "$outdir/compiler.i"
3253 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3254 set file [open $ppout r]
3255 set cppout [read $file]
3258 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3260 eval log_file $saved_log
3264 foreach cppline [ split "$cppout" "\n" ] {
3265 if { [ regexp "^#" "$cppline" ] } {
3267 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3269 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3271 verbose "get_compiler_info: $cppline" 2
3275 verbose -log "get_compiler_info: $cppline"
3280 # Set to unknown if for some reason compiler_info didn't get defined.
3281 if ![info exists compiler_info] {
3282 verbose -log "get_compiler_info: compiler_info not provided"
3283 set compiler_info "unknown"
3285 # Also set to unknown compiler if any diagnostics happened.
3287 verbose -log "get_compiler_info: got unexpected diagnostics"
3288 set compiler_info "unknown"
3291 # Set the legacy symbols.
3293 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
3294 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
3295 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
3296 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
3297 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
3299 # Log what happened.
3300 verbose -log "get_compiler_info: $compiler_info"
3302 # Most compilers will evaluate comparisons and other boolean
3303 # operations to 0 or 1.
3304 uplevel \#0 { set true 1 }
3305 uplevel \#0 { set false 0 }
3310 # Return the compiler_info string if no arg is provided.
3311 # Otherwise the argument is a glob-style expression to match against
3314 proc test_compiler_info { {compiler ""} } {
3315 global compiler_info
3318 # If no arg, return the compiler_info string.
3319 if [string match "" $compiler] {
3320 return $compiler_info
3323 return [string match $compiler $compiler_info]
3326 proc current_target_name { } {
3328 if [info exists target_info(target,name)] {
3329 set answer $target_info(target,name)
3336 set gdb_wrapper_initialized 0
3337 set gdb_wrapper_target ""
3339 proc gdb_wrapper_init { args } {
3340 global gdb_wrapper_initialized
3341 global gdb_wrapper_file
3342 global gdb_wrapper_flags
3343 global gdb_wrapper_target
3345 if { $gdb_wrapper_initialized == 1 } { return; }
3347 if {[target_info exists needs_status_wrapper] && \
3348 [target_info needs_status_wrapper] != "0"} {
3349 set result [build_wrapper "testglue.o"]
3350 if { $result != "" } {
3351 set gdb_wrapper_file [lindex $result 0]
3352 set gdb_wrapper_flags [lindex $result 1]
3354 warning "Status wrapper failed to build."
3357 set gdb_wrapper_initialized 1
3358 set gdb_wrapper_target [current_target_name]
3361 # Some targets need to always link a special object in. Save its path here.
3362 global gdb_saved_set_unbuffered_mode_obj
3363 set gdb_saved_set_unbuffered_mode_obj ""
3365 # Compile source files specified by SOURCE into a binary of type TYPE at path
3366 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3367 # parameter and most options are passed directly to it.
3369 # The type can be one of the following:
3371 # - object: Compile into an object file.
3372 # - executable: Compile and link into an executable.
3373 # - preprocess: Preprocess the source files.
3374 # - assembly: Generate assembly listing.
3376 # The following options are understood and processed by gdb_compile:
3378 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3379 # quirks to be able to use shared libraries.
3380 # - shlib_load: Link with appropriate libraries to allow the test to
3381 # dynamically load libraries at runtime. For example, on Linux, this adds
3382 # -ldl so that the test can use dlopen.
3383 # - nowarnings: Inhibit all compiler warnings.
3385 # And here are some of the not too obscure options understood by DejaGnu that
3386 # influence the compilation:
3388 # - additional_flags=flag: Add FLAG to the compiler flags.
3389 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3390 # argument can be a file, in which case it's added to the sources, or a
3392 # - ldflags=flag: Add FLAG to the linker flags.
3393 # - incdir=path: Add PATH to the searched include directories.
3394 # - libdir=path: Add PATH to the linker searched directories.
3395 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3396 # - debug: Build with debug information.
3397 # - optimize: Build with optimization.
3399 proc gdb_compile {source dest type options} {
3400 global GDB_TESTCASE_OPTIONS
3401 global gdb_wrapper_file
3402 global gdb_wrapper_flags
3403 global gdb_wrapper_initialized
3406 global gdb_saved_set_unbuffered_mode_obj
3408 set outdir [file dirname $dest]
3410 # Add platform-specific options if a shared library was specified using
3411 # "shlib=librarypath" in OPTIONS.
3415 foreach opt $options {
3416 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3417 if [test_compiler_info "xlc-*"] {
3418 # IBM xlc compiler doesn't accept shared library named other
3419 # than .so: use "-Wl," to bypass this
3420 lappend source "-Wl,$shlib_name"
3421 } elseif { ([istarget "*-*-mingw*"]
3422 || [istarget *-*-cygwin*]
3423 || [istarget *-*-pe*])} {
3424 lappend source "${shlib_name}.a"
3426 lappend source $shlib_name
3428 if { $shlib_found == 0 } {
3430 if { ([istarget "*-*-mingw*"]
3431 || [istarget *-*-cygwin*]) } {
3432 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3434 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3435 # Undo debian's change in the default.
3436 # Put it at the front to not override any user-provided
3437 # value, and to make sure it appears in front of all the
3439 lappend new_options "early_flags=-Wl,--no-as-needed"
3442 } elseif { $opt == "shlib_load" } {
3445 lappend new_options $opt
3449 # Because we link with libraries using their basename, we may need
3450 # (depending on the platform) to set a special rpath value, to allow
3451 # the executable to find the libraries it depends on.
3452 if { $shlib_load || $shlib_found } {
3453 if { ([istarget "*-*-mingw*"]
3454 || [istarget *-*-cygwin*]
3455 || [istarget *-*-pe*]) } {
3456 # Do not need anything.
3457 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3458 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3459 } elseif { [istarget arm*-*-symbianelf*] } {
3460 if { $shlib_load } {
3461 lappend new_options "libs=-ldl"
3464 if { $shlib_load } {
3465 lappend new_options "libs=-ldl"
3467 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3470 set options $new_options
3472 if [info exists GDB_TESTCASE_OPTIONS] {
3473 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3475 verbose "options are $options"
3476 verbose "source is $source $dest $type $options"
3478 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3480 if {[target_info exists needs_status_wrapper] && \
3481 [target_info needs_status_wrapper] != "0" && \
3482 [info exists gdb_wrapper_file]} {
3483 lappend options "libs=${gdb_wrapper_file}"
3484 lappend options "ldflags=${gdb_wrapper_flags}"
3487 # Replace the "nowarnings" option with the appropriate additional_flags
3488 # to disable compiler warnings.
3489 set nowarnings [lsearch -exact $options nowarnings]
3490 if {$nowarnings != -1} {
3491 if [target_info exists gdb,nowarnings_flag] {
3492 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3494 set flag "additional_flags=-w"
3496 set options [lreplace $options $nowarnings $nowarnings $flag]
3499 if { $type == "executable" } {
3500 if { ([istarget "*-*-mingw*"]
3501 || [istarget "*-*-*djgpp"]
3502 || [istarget "*-*-cygwin*"])} {
3503 # Force output to unbuffered mode, by linking in an object file
3504 # with a global contructor that calls setvbuf.
3506 # Compile the special object seperatelly for two reasons:
3507 # 1) Insulate it from $options.
3508 # 2) Avoid compiling it for every gdb_compile invocation,
3509 # which is time consuming, especially if we're remote
3512 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3513 verbose "compiling gdb_saved_set_unbuffered_obj"
3514 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3515 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3517 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3518 if { $result != "" } {
3521 if {[is_remote host]} {
3522 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3524 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3526 # Link a copy of the output object, because the
3527 # original may be automatically deleted.
3528 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3530 verbose "gdb_saved_set_unbuffered_obj already compiled"
3533 # Rely on the internal knowledge that the global ctors are ran in
3534 # reverse link order. In that case, we can use ldflags to
3535 # avoid copying the object file to the host multiple
3537 # This object can only be added if standard libraries are
3538 # used. Thus, we need to disable it if -nostdlib option is used
3539 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3540 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3545 set result [target_compile $source $dest $type $options]
3547 # Prune uninteresting compiler (and linker) output.
3548 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3550 regsub "\[\r\n\]*$" "$result" "" result
3551 regsub "^\[\r\n\]*" "$result" "" result
3553 if {[lsearch $options quiet] < 0} {
3554 # We shall update this on a per language basis, to avoid
3555 # changing the entire testsuite in one go.
3556 if {[lsearch $options f77] >= 0} {
3557 gdb_compile_test $source $result
3558 } elseif { $result != "" } {
3559 clone_output "gdb compile failed, $result"
3566 # This is just like gdb_compile, above, except that it tries compiling
3567 # against several different thread libraries, to see which one this
3569 proc gdb_compile_pthreads {source dest type options} {
3571 set why_msg "unrecognized error"
3572 foreach lib {-lpthreads -lpthread -lthread ""} {
3573 # This kind of wipes out whatever libs the caller may have
3574 # set. Or maybe theirs will override ours. How infelicitous.
3575 set options_with_lib [concat $options [list libs=$lib quiet]]
3576 set ccout [gdb_compile $source $dest $type $options_with_lib]
3577 switch -regexp -- $ccout {
3578 ".*no posix threads support.*" {
3579 set why_msg "missing threads include file"
3582 ".*cannot open -lpthread.*" {
3583 set why_msg "missing runtime threads library"
3585 ".*Can't find library for -lpthread.*" {
3586 set why_msg "missing runtime threads library"
3589 pass "successfully compiled posix threads test case"
3595 if {!$built_binfile} {
3596 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3601 # Build a shared library from SOURCES.
3603 proc gdb_compile_shlib {sources dest options} {
3604 set obj_options $options
3607 if { [lsearch -exact $options "c++"] >= 0 } {
3608 set info_options "c++"
3610 if [get_compiler_info ${info_options}] {
3614 switch -glob [test_compiler_info] {
3616 lappend obj_options "additional_flags=-qpic"
3619 if { !([istarget "*-*-cygwin*"]
3620 || [istarget "*-*-mingw*"]) } {
3621 lappend obj_options "additional_flags=-fpic"
3625 if { !([istarget "powerpc*-*-aix*"]
3626 || [istarget "rs6000*-*-aix*"]
3627 || [istarget "*-*-cygwin*"]
3628 || [istarget "*-*-mingw*"]
3629 || [istarget "*-*-pe*"]) } {
3630 lappend obj_options "additional_flags=-fpic"
3634 lappend obj_options "additional_flags=-fpic"
3637 # don't know what the compiler is...
3641 set outdir [file dirname $dest]
3643 foreach source $sources {
3644 set sourcebase [file tail $source]
3645 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3648 lappend objects ${outdir}/${sourcebase}.o
3651 set link_options $options
3652 if [test_compiler_info "xlc-*"] {
3653 lappend link_options "additional_flags=-qmkshrobj"
3655 lappend link_options "additional_flags=-shared"
3657 if { ([istarget "*-*-mingw*"]
3658 || [istarget *-*-cygwin*]
3659 || [istarget *-*-pe*]) } {
3660 if { [is_remote host] } {
3661 set name [file tail ${dest}]
3665 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3667 # Set the soname of the library. This causes the linker on ELF
3668 # systems to create the DT_NEEDED entry in the executable referring
3669 # to the soname of the library, and not its absolute path. This
3670 # (using the absolute path) would be problem when testing on a
3673 # In conjunction with setting the soname, we add the special
3674 # rpath=$ORIGIN value when building the executable, so that it's
3675 # able to find the library in its own directory.
3676 set destbase [file tail $dest]
3677 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3680 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3683 if { [is_remote host]
3684 && ([istarget "*-*-mingw*"]
3685 || [istarget *-*-cygwin*]
3686 || [istarget *-*-pe*]) } {
3687 set dest_tail_name [file tail ${dest}]
3688 remote_upload host $dest_tail_name.a ${dest}.a
3689 remote_file host delete $dest_tail_name.a
3695 # This is just like gdb_compile_shlib, above, except that it tries compiling
3696 # against several different thread libraries, to see which one this
3698 proc gdb_compile_shlib_pthreads {sources dest options} {
3700 set why_msg "unrecognized error"
3701 foreach lib {-lpthreads -lpthread -lthread ""} {
3702 # This kind of wipes out whatever libs the caller may have
3703 # set. Or maybe theirs will override ours. How infelicitous.
3704 set options_with_lib [concat $options [list libs=$lib quiet]]
3705 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3706 switch -regexp -- $ccout {
3707 ".*no posix threads support.*" {
3708 set why_msg "missing threads include file"
3711 ".*cannot open -lpthread.*" {
3712 set why_msg "missing runtime threads library"
3714 ".*Can't find library for -lpthread.*" {
3715 set why_msg "missing runtime threads library"
3718 pass "successfully compiled posix threads test case"
3724 if {!$built_binfile} {
3725 unsupported "Couldn't compile $sources: ${why_msg}"
3730 # This is just like gdb_compile_pthreads, above, except that we always add the
3731 # objc library for compiling Objective-C programs
3732 proc gdb_compile_objc {source dest type options} {
3734 set why_msg "unrecognized error"
3735 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3736 # This kind of wipes out whatever libs the caller may have
3737 # set. Or maybe theirs will override ours. How infelicitous.
3738 if { $lib == "solaris" } {
3739 set lib "-lpthread -lposix4"
3741 if { $lib != "-lobjc" } {
3742 set lib "-lobjc $lib"
3744 set options_with_lib [concat $options [list libs=$lib quiet]]
3745 set ccout [gdb_compile $source $dest $type $options_with_lib]
3746 switch -regexp -- $ccout {
3747 ".*no posix threads support.*" {
3748 set why_msg "missing threads include file"
3751 ".*cannot open -lpthread.*" {
3752 set why_msg "missing runtime threads library"
3754 ".*Can't find library for -lpthread.*" {
3755 set why_msg "missing runtime threads library"
3758 pass "successfully compiled objc with posix threads test case"
3764 if {!$built_binfile} {
3765 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3770 proc send_gdb { string } {
3771 global suppress_flag
3772 if { $suppress_flag } {
3775 return [remote_send host "$string"]
3778 # Send STRING to the inferior's terminal.
3780 proc send_inferior { string } {
3781 global inferior_spawn_id
3783 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3793 proc gdb_expect { args } {
3794 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3795 set atimeout [lindex $args 0]
3796 set expcode [list [lindex $args 1]]
3801 # A timeout argument takes precedence, otherwise of all the timeouts
3802 # select the largest.
3803 if [info exists atimeout] {
3806 set tmt [get_largest_timeout]
3809 global suppress_flag
3810 global remote_suppress_flag
3811 if [info exists remote_suppress_flag] {
3812 set old_val $remote_suppress_flag
3814 if [info exists suppress_flag] {
3815 if { $suppress_flag } {
3816 set remote_suppress_flag 1
3820 {uplevel remote_expect host $tmt $expcode} string]
3821 if [info exists old_val] {
3822 set remote_suppress_flag $old_val
3824 if [info exists remote_suppress_flag] {
3825 unset remote_suppress_flag
3830 global errorInfo errorCode
3832 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3834 return -code $code $string
3838 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3840 # Check for long sequence of output by parts.
3841 # TEST: is the test message to be printed with the test success/fail.
3842 # SENTINEL: Is the terminal pattern indicating that output has finished.
3843 # LIST: is the sequence of outputs to match.
3844 # If the sentinel is recognized early, it is considered an error.
3847 # 1 if the test failed,
3848 # 0 if the test passes,
3849 # -1 if there was an internal error.
3851 proc gdb_expect_list {test sentinel list} {
3853 global suppress_flag
3856 if { $suppress_flag } {
3858 unresolved "${test}"
3860 while { ${index} < [llength ${list}] } {
3861 set pattern [lindex ${list} ${index}]
3862 set index [expr ${index} + 1]
3863 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3864 if { ${index} == [llength ${list}] } {
3867 -re "${pattern}${sentinel}" {
3868 # pass "${test}, pattern ${index} + sentinel"
3871 fail "${test} (pattern ${index} + sentinel)"
3874 -re ".*A problem internal to GDB has been detected" {
3875 fail "${test} (GDB internal error)"
3877 gdb_internal_error_resync
3880 fail "${test} (pattern ${index} + sentinel) (timeout)"
3885 # unresolved "${test}, pattern ${index} + sentinel"
3891 # pass "${test}, pattern ${index}"
3894 fail "${test} (pattern ${index})"
3897 -re ".*A problem internal to GDB has been detected" {
3898 fail "${test} (GDB internal error)"
3900 gdb_internal_error_resync
3903 fail "${test} (pattern ${index}) (timeout)"
3908 # unresolved "${test}, pattern ${index}"
3922 proc gdb_suppress_entire_file { reason } {
3923 global suppress_flag
3926 set suppress_flag -1
3930 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3931 # gdb_expect to fail immediately (until the next call to
3932 # gdb_stop_suppressing_tests).
3934 proc gdb_suppress_tests { args } {
3935 global suppress_flag
3937 return; # fnf - disable pending review of results where
3938 # testsuite ran better without this
3941 if { $suppress_flag == 1 } {
3942 if { [llength $args] > 0 } {
3943 warning "[lindex $args 0]\n"
3945 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3951 # Clear suppress_flag.
3953 proc gdb_stop_suppressing_tests { } {
3954 global suppress_flag
3956 if [info exists suppress_flag] {
3957 if { $suppress_flag > 0 } {
3959 clone_output "Tests restarted.\n"
3966 proc gdb_clear_suppressed { } {
3967 global suppress_flag
3972 # Spawn the gdb process.
3974 # This doesn't expect any output or do any other initialization,
3975 # leaving those to the caller.
3977 # Overridable function -- you can override this function in your
3980 proc gdb_spawn { } {
3984 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3986 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3989 set saved_gdbflags $GDBFLAGS
3991 if {$GDBFLAGS != ""} {
3994 append GDBFLAGS $cmdline_flags
3998 set GDBFLAGS $saved_gdbflags
4003 # Start gdb running, wait for prompt, and disable the pagers.
4005 # Overridable function -- you can override this function in your
4008 proc gdb_start { } {
4013 catch default_gdb_exit
4016 # Return true if we can spawn a program on the target and attach to
4019 proc can_spawn_for_attach { } {
4020 # We use exp_pid to get the inferior's pid, assuming that gives
4021 # back the pid of the program. On remote boards, that would give
4022 # us instead the PID of e.g., the ssh client, etc.
4023 if [is_remote target] then {
4027 # The "attach" command doesn't make sense when the target is
4028 # stub-like, where GDB finds the program already started on
4029 # initial connection.
4030 if {[target_info exists use_gdb_stub]} {
4038 # Kill a progress previously started with spawn_wait_for_attach, and
4039 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4042 proc kill_wait_spawned_process { proc_spawn_id } {
4043 set pid [exp_pid -i $proc_spawn_id]
4045 verbose -log "killing ${pid}"
4046 remote_exec build "kill -9 ${pid}"
4048 verbose -log "closing ${proc_spawn_id}"
4049 catch "close -i $proc_spawn_id"
4050 verbose -log "waiting for ${proc_spawn_id}"
4052 # If somehow GDB ends up still attached to the process here, a
4053 # blocking wait hangs until gdb is killed (or until gdb / the
4054 # ptracer reaps the exit status too, but that won't happen because
4055 # something went wrong.) Passing -nowait makes expect tell Tcl to
4056 # wait for the PID in the background. That's fine because we
4057 # don't care about the exit status. */
4058 wait -nowait -i $proc_spawn_id
4061 # Returns the process id corresponding to the given spawn id.
4063 proc spawn_id_get_pid { spawn_id } {
4064 set testpid [exp_pid -i $spawn_id]
4066 if { [istarget "*-*-cygwin*"] } {
4067 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4068 # might be different due to the way fork/exec works.
4069 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4075 # Start a set of programs running and then wait for a bit, to be sure
4076 # that they can be attached to. Return a list of processes spawn IDs,
4077 # one element for each process spawned. It's a test error to call
4078 # this when [can_spawn_for_attach] is false.
4080 proc spawn_wait_for_attach { executable_list } {
4081 set spawn_id_list {}
4083 if ![can_spawn_for_attach] {
4084 # The caller should have checked can_spawn_for_attach itself
4085 # before getting here.
4086 error "can't spawn for attach with this target/board"
4089 foreach {executable} $executable_list {
4090 # Note we use Expect's spawn, not Tcl's exec, because with
4091 # spawn we control when to wait for/reap the process. That
4092 # allows killing the process by PID without being subject to
4094 lappend spawn_id_list [remote_spawn target $executable]
4099 return $spawn_id_list
4103 # gdb_load_cmd -- load a file into the debugger.
4104 # ARGS - additional args to load command.
4105 # return a -1 if anything goes wrong.
4107 proc gdb_load_cmd { args } {
4110 if [target_info exists gdb_load_timeout] {
4111 set loadtimeout [target_info gdb_load_timeout]
4113 set loadtimeout 1600
4115 send_gdb "load $args\n"
4116 verbose "Timeout is now $loadtimeout seconds" 2
4117 gdb_expect $loadtimeout {
4118 -re "Loading section\[^\r\]*\r\n" {
4121 -re "Start address\[\r\]*\r\n" {
4124 -re "Transfer rate\[\r\]*\r\n" {
4127 -re "Memory access error\[^\r\]*\r\n" {
4128 perror "Failed to load program"
4131 -re "$gdb_prompt $" {
4134 -re "(.*)\r\n$gdb_prompt " {
4135 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4139 perror "Timed out trying to load $args."
4146 # Invoke "gcore". CORE is the name of the core file to write. TEST
4147 # is the name of the test case. This will return 1 if the core file
4148 # was created, 0 otherwise. If this fails to make a core file because
4149 # this configuration of gdb does not support making core files, it
4150 # will call "unsupported", not "fail". However, if this fails to make
4151 # a core file for some other reason, then it will call "fail".
4153 proc gdb_gcore_cmd {core test} {
4157 gdb_test_multiple "gcore $core" $test {
4158 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4162 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4170 # Load core file CORE. TEST is the name of the test case.
4171 # This will record a pass/fail for loading the core file.
4173 # 1 - core file is successfully loaded
4174 # 0 - core file loaded but has a non fatal error
4175 # -1 - core file failed to load
4177 proc gdb_core_cmd { core test } {
4180 gdb_test_multiple "core $core" "$test" {
4181 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4184 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4185 fail "$test (bad file format)"
4188 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4189 fail "$test (file not found)"
4192 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4193 fail "$test (incomplete note section)"
4196 -re "Core was generated by .*\r\n$gdb_prompt $" {
4200 -re ".*$gdb_prompt $" {
4205 fail "$test (timeout)"
4209 fail "unsupported output from 'core' command"
4213 # Return the filename to download to the target and load on the target
4214 # for this shared library. Normally just LIBNAME, unless shared libraries
4215 # for this target have separate link and load images.
4217 proc shlib_target_file { libname } {
4221 # Return the filename GDB will load symbols from when debugging this
4222 # shared library. Normally just LIBNAME, unless shared libraries for
4223 # this target have separate link and load images.
4225 proc shlib_symbol_file { libname } {
4229 # Return the filename to download to the target and load for this
4230 # executable. Normally just BINFILE unless it is renamed to something
4231 # else for this target.
4233 proc exec_target_file { binfile } {
4237 # Return the filename GDB will load symbols from when debugging this
4238 # executable. Normally just BINFILE unless executables for this target
4239 # have separate files for symbols.
4241 proc exec_symbol_file { binfile } {
4245 # Rename the executable file. Normally this is just BINFILE1 being renamed
4246 # to BINFILE2, but some targets require multiple binary files.
4247 proc gdb_rename_execfile { binfile1 binfile2 } {
4248 file rename -force [exec_target_file ${binfile1}] \
4249 [exec_target_file ${binfile2}]
4250 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4251 file rename -force [exec_symbol_file ${binfile1}] \
4252 [exec_symbol_file ${binfile2}]
4256 # "Touch" the executable file to update the date. Normally this is just
4257 # BINFILE, but some targets require multiple files.
4258 proc gdb_touch_execfile { binfile } {
4259 set time [clock seconds]
4260 file mtime [exec_target_file ${binfile}] $time
4261 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4262 file mtime [exec_symbol_file ${binfile}] $time
4266 # Like remote_download but provides a gdb-specific behavior.
4268 # If the destination board is remote, the local file FROMFILE is transferred as
4269 # usual with remote_download to TOFILE on the remote board. The destination
4270 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4273 # If the destination board is local, the destination path TOFILE is passed
4274 # through standard_output_file, and FROMFILE is copied there.
4276 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4279 proc gdb_remote_download {dest fromfile {tofile {}}} {
4280 # If TOFILE is not given, default to the same filename as FROMFILE.
4281 if {[string length $tofile] == 0} {
4282 set tofile [file tail $fromfile]
4285 if {[is_remote $dest]} {
4286 # When the DEST is remote, we simply send the file to DEST.
4289 set destname [remote_download $dest $fromfile $tofile]
4290 lappend cleanfiles $destname
4294 # When the DEST is local, we copy the file to the test directory (where
4295 # the executable is).
4297 # Note that we pass TOFILE through standard_output_file, regardless of
4298 # whether it is absolute or relative, because we don't want the tests
4299 # to be able to write outside their standard output directory.
4301 set tofile [standard_output_file $tofile]
4303 file copy -force $fromfile $tofile
4309 # gdb_load_shlib LIB...
4311 # Copy the listed library to the target.
4313 proc gdb_load_shlib { file } {
4314 set dest [gdb_remote_download target [shlib_target_file $file]]
4316 if {[is_remote target]} {
4317 # If the target is remote, we need to tell gdb where to find the
4320 # We could set this even when not testing remotely, but a user
4321 # generally won't set it unless necessary. In order to make the tests
4322 # more like the real-life scenarios, we don't set it for local testing.
4323 gdb_test "set solib-search-path [file dirname $file]" "" ""
4330 # gdb_load -- load a file into the debugger. Specifying no file
4331 # defaults to the executable currently being debugged.
4332 # The return value is 0 for success, -1 for failure.
4333 # Many files in config/*.exp override this procedure.
4335 proc gdb_load { arg } {
4337 return [gdb_file_cmd $arg]
4342 # gdb_reload -- load a file into the target. Called before "running",
4343 # either the first time or after already starting the program once,
4344 # for remote targets. Most files that override gdb_load should now
4345 # override this instead.
4347 proc gdb_reload { } {
4348 # For the benefit of existing configurations, default to gdb_load.
4349 # Specifying no file defaults to the executable currently being
4351 return [gdb_load ""]
4354 proc gdb_continue { function } {
4357 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4360 proc default_gdb_init { test_file_name } {
4361 global gdb_wrapper_initialized
4362 global gdb_wrapper_target
4363 global gdb_test_file_name
4369 gdb_clear_suppressed
4371 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4373 # Make sure that the wrapper is rebuilt
4374 # with the appropriate multilib option.
4375 if { $gdb_wrapper_target != [current_target_name] } {
4376 set gdb_wrapper_initialized 0
4379 # Unlike most tests, we have a small number of tests that generate
4380 # a very large amount of output. We therefore increase the expect
4381 # buffer size to be able to contain the entire test output. This
4382 # is especially needed by gdb.base/info-macros.exp.
4384 # Also set this value for the currently running GDB.
4385 match_max [match_max -d]
4387 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4388 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4391 if [target_info exists gdb_prompt] {
4392 set gdb_prompt [target_info gdb_prompt]
4394 set gdb_prompt "\\(gdb\\)"
4397 if [info exists use_gdb_stub] {
4402 # Return a path using GDB_PARALLEL.
4403 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4404 # GDB_PARALLEL must be defined, the caller must check.
4406 # The default value for GDB_PARALLEL is, canonically, ".".
4407 # The catch is that tests don't expect an additional "./" in file paths so
4408 # omit any directory for the default case.
4409 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4410 # its special handling.
4412 proc make_gdb_parallel_path { args } {
4413 global GDB_PARALLEL objdir
4414 set joiner [list "file" "join" $objdir]
4415 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4416 lappend joiner $GDB_PARALLEL
4418 set joiner [concat $joiner $args]
4419 return [eval $joiner]
4422 # Turn BASENAME into a full file name in the standard output
4423 # directory. It is ok if BASENAME is the empty string; in this case
4424 # the directory is returned.
4426 proc standard_output_file {basename} {
4427 global objdir subdir gdb_test_file_name
4429 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4431 return [file join $dir $basename]
4434 # Return the name of a file in our standard temporary directory.
4436 proc standard_temp_file {basename} {
4437 # Since a particular runtest invocation is only executing a single test
4438 # file at any given time, we can use the runtest pid to build the
4439 # path of the temp directory.
4440 set dir [make_gdb_parallel_path temp [pid]]
4442 return [file join $dir $basename]
4445 # Set 'testfile', 'srcfile', and 'binfile'.
4447 # ARGS is a list of source file specifications.
4448 # Without any arguments, the .exp file's base name is used to
4449 # compute the source file name. The ".c" extension is added in this case.
4450 # If ARGS is not empty, each entry is a source file specification.
4451 # If the specification starts with a ".", it is treated as a suffix
4452 # to append to the .exp file's base name.
4453 # If the specification is the empty string, it is treated as if it
4455 # Otherwise it is a file name.
4456 # The first file in the list is used to set the 'srcfile' global.
4457 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4459 # Most tests should call this without arguments.
4461 # If a completely different binary file name is needed, then it
4462 # should be handled in the .exp file with a suitable comment.
4464 proc standard_testfile {args} {
4465 global gdb_test_file_name
4467 global gdb_test_file_last_vars
4470 global testfile binfile
4472 set testfile $gdb_test_file_name
4473 set binfile [standard_output_file ${testfile}]
4475 if {[llength $args] == 0} {
4479 # Unset our previous output variables.
4480 # This can help catch hidden bugs.
4481 if {[info exists gdb_test_file_last_vars]} {
4482 foreach varname $gdb_test_file_last_vars {
4484 catch {unset $varname}
4487 # 'executable' is often set by tests.
4488 set gdb_test_file_last_vars {executable}
4492 set varname srcfile$suffix
4495 # Handle an extension.
4498 } elseif {[string range $arg 0 0] == "."} {
4499 set arg $testfile$arg
4503 lappend gdb_test_file_last_vars $varname
4505 if {$suffix == ""} {
4513 # The default timeout used when testing GDB commands. We want to use
4514 # the same timeout as the default dejagnu timeout, unless the user has
4515 # already provided a specific value (probably through a site.exp file).
4516 global gdb_test_timeout
4517 if ![info exists gdb_test_timeout] {
4518 set gdb_test_timeout $timeout
4521 # A list of global variables that GDB testcases should not use.
4522 # We try to prevent their use by monitoring write accesses and raising
4523 # an error when that happens.
4524 set banned_variables { bug_id prms_id }
4526 # A list of procedures that GDB testcases should not use.
4527 # We try to prevent their use by monitoring invocations and raising
4528 # an error when that happens.
4529 set banned_procedures { strace }
4531 # gdb_init is called by runtest at start, but also by several
4532 # tests directly; gdb_finish is only called from within runtest after
4533 # each test source execution.
4534 # Placing several traces by repetitive calls to gdb_init leads
4535 # to problems, as only one trace is removed in gdb_finish.
4536 # To overcome this possible problem, we add a variable that records
4537 # if the banned variables and procedures are already traced.
4540 proc gdb_init { test_file_name } {
4541 # Reset the timeout value to the default. This way, any testcase
4542 # that changes the timeout value without resetting it cannot affect
4543 # the timeout used in subsequent testcases.
4544 global gdb_test_timeout
4546 set timeout $gdb_test_timeout
4548 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4549 && [target_info exists gdb_reverse_timeout] } {
4550 set timeout [target_info gdb_reverse_timeout]
4553 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4554 # debugging tool to help confirm that the test suite is
4555 # parallel-safe. You need "inotifywait" from the
4556 # inotify-tools package to use this.
4557 global GDB_INOTIFY inotify_pid
4558 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4559 global outdir tool inotify_log_file
4561 set exclusions {outputs temp gdb[.](log|sum) cache}
4562 set exclusion_re ([join $exclusions |])
4564 set inotify_log_file [standard_temp_file inotify.out]
4565 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4566 --exclude $exclusion_re \
4567 |& tee -a $outdir/$tool.log $inotify_log_file &]
4569 # Wait for the watches; hopefully this is long enough.
4572 # Clear the log so that we don't emit a warning the first time
4574 set fd [open $inotify_log_file w]
4578 # Block writes to all banned variables, and invocation of all
4579 # banned procedures...
4580 global banned_variables
4581 global banned_procedures
4582 global banned_traced
4583 if (!$banned_traced) {
4584 foreach banned_var $banned_variables {
4585 global "$banned_var"
4586 trace add variable "$banned_var" write error
4588 foreach banned_proc $banned_procedures {
4589 global "$banned_proc"
4590 trace add execution "$banned_proc" enter error
4595 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4596 # messages as expected.
4601 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4602 # the test results. Even if /dev/null doesn't exist on the particular
4603 # platform, the readline library will use the default setting just by
4604 # failing to open the file. OTOH, opening /dev/null successfully will
4605 # also result in the default settings being used since nothing will be
4606 # read from this file.
4607 setenv INPUTRC "/dev/null"
4609 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4610 # bindings, so make sure that an appropriate terminal is selected.
4611 # The same bug doesn't show up if we use ^P / ^N instead.
4614 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4615 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4616 # especially having color output turned on can cause tests to fail.
4617 setenv GREP_OPTIONS ""
4619 # Clear $gdbserver_reconnect_p.
4620 global gdbserver_reconnect_p
4621 set gdbserver_reconnect_p 1
4622 unset gdbserver_reconnect_p
4624 return [default_gdb_init $test_file_name]
4627 proc gdb_finish { } {
4628 global gdbserver_reconnect_p
4632 # Exit first, so that the files are no longer in use.
4635 if { [llength $cleanfiles] > 0 } {
4636 eval remote_file target delete $cleanfiles
4640 # Unblock write access to the banned variables. Dejagnu typically
4641 # resets some of them between testcases.
4642 global banned_variables
4643 global banned_procedures
4644 global banned_traced
4645 if ($banned_traced) {
4646 foreach banned_var $banned_variables {
4647 global "$banned_var"
4648 trace remove variable "$banned_var" write error
4650 foreach banned_proc $banned_procedures {
4651 global "$banned_proc"
4652 trace remove execution "$banned_proc" enter error
4659 set debug_format "unknown"
4661 # Run the gdb command "info source" and extract the debugging format
4662 # information from the output and save it in debug_format.
4664 proc get_debug_format { } {
4670 set debug_format "unknown"
4671 send_gdb "info source\n"
4673 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4674 set debug_format $expect_out(1,string)
4675 verbose "debug format is $debug_format"
4678 -re "No current source file.\r\n$gdb_prompt $" {
4679 perror "get_debug_format used when no current source file"
4682 -re "$gdb_prompt $" {
4683 warning "couldn't check debug format (no valid response)."
4687 warning "couldn't check debug format (timeout)."
4693 # Return true if FORMAT matches the debug format the current test was
4694 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4695 # `*', `[...]', and so on.
4697 # This function depends on variables set by `get_debug_format', above.
4699 proc test_debug_format {format} {
4702 return [expr [string match $format $debug_format] != 0]
4705 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4706 # COFF, stabs, etc). If that format matches the format that the
4707 # current test was compiled with, then the next test is expected to
4708 # fail for any target. Returns 1 if the next test or set of tests is
4709 # expected to fail, 0 otherwise (or if it is unknown). Must have
4710 # previously called get_debug_format.
4711 proc setup_xfail_format { format } {
4712 set ret [test_debug_format $format]
4720 # gdb_get_line_number TEXT [FILE]
4722 # Search the source file FILE, and return the line number of the
4723 # first line containing TEXT. If no match is found, an error is thrown.
4725 # TEXT is a string literal, not a regular expression.
4727 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4728 # specified, and does not start with "/", then it is assumed to be in
4729 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4730 # by changing the callers and the interface at the same time.
4731 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4732 # gdb.base/ena-dis-br.exp.
4734 # Use this function to keep your test scripts independent of the
4735 # exact line numbering of the source file. Don't write:
4737 # send_gdb "break 20"
4739 # This means that if anyone ever edits your test's source file,
4740 # your test could break. Instead, put a comment like this on the
4741 # source file line you want to break at:
4743 # /* breakpoint spot: frotz.exp: test name */
4745 # and then write, in your test script (which we assume is named
4748 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4750 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4753 # % puts "foo [lindex "bar baz" 1]"
4756 # Tcl is quite clever, for a little stringy language.)
4760 # The previous implementation of this procedure used the gdb search command.
4761 # This version is different:
4763 # . It works with MI, and it also works when gdb is not running.
4765 # . It operates on the build machine, not the host machine.
4767 # . For now, this implementation fakes a current directory of
4768 # $srcdir/$subdir to be compatible with the old implementation.
4769 # This will go away eventually and some callers will need to
4772 # . The TEXT argument is literal text and matches literally,
4773 # not a regular expression as it was before.
4775 # . State changes in gdb, such as changing the current file
4776 # and setting $_, no longer happen.
4778 # After a bit of time we can forget about the differences from the
4779 # old implementation.
4781 # --chastain 2004-08-05
4783 proc gdb_get_line_number { text { file "" } } {
4788 if { "$file" == "" } then {
4791 if { ! [regexp "^/" "$file"] } then {
4792 set file "$srcdir/$subdir/$file"
4795 if { [ catch { set fd [open "$file"] } message ] } then {
4800 for { set line 1 } { 1 } { incr line } {
4801 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4804 if { $nchar < 0 } then {
4807 if { [string first "$text" "$body"] >= 0 } then {
4813 if { [ catch { close "$fd" } message ] } then {
4818 error "undefined tag \"$text\""
4824 # Continue the program until it ends.
4826 # MSSG is the error message that gets printed. If not given, a
4828 # COMMAND is the command to invoke. If not given, "continue" is
4830 # ALLOW_EXTRA is a flag indicating whether the test should expect
4831 # extra output between the "Continuing." line and the program
4832 # exiting. By default it is zero; if nonzero, any extra output
4835 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4836 global inferior_exited_re use_gdb_stub
4839 set text "continue until exit"
4841 set text "continue until exit at $mssg"
4849 # By default, we don't rely on exit() behavior of remote stubs --
4850 # it's common for exit() to be implemented as a simple infinite
4851 # loop, or a forced crash/reset. For native targets, by default, we
4852 # assume process exit is reported as such. If a non-reliable target
4853 # is used, we set a breakpoint at exit, and continue to that.
4854 if { [target_info exists exit_is_reliable] } {
4855 set exit_is_reliable [target_info exit_is_reliable]
4857 set exit_is_reliable [expr ! $use_gdb_stub]
4860 if { ! $exit_is_reliable } {
4861 if {![gdb_breakpoint "exit"]} {
4864 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4867 # Continue until we exit. Should not stop again.
4868 # Don't bother to check the output of the program, that may be
4869 # extremely tough for some remote systems.
4871 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4876 proc rerun_to_main {} {
4877 global gdb_prompt use_gdb_stub
4882 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4883 {pass "rerun to main" ; return 0}
4884 -re "$gdb_prompt $"\
4885 {fail "rerun to main" ; return 0}
4886 timeout {fail "(timeout) rerun to main" ; return 0}
4891 -re "The program .* has been started already.*y or n. $" {
4895 -re "Starting program.*$gdb_prompt $"\
4896 {pass "rerun to main" ; return 0}
4897 -re "$gdb_prompt $"\
4898 {fail "rerun to main" ; return 0}
4899 timeout {fail "(timeout) rerun to main" ; return 0}
4904 # Return true if a test should be skipped due to lack of floating
4905 # point support or GDB can't fetch the contents from floating point
4908 gdb_caching_proc gdb_skip_float_test {
4909 if [target_info exists gdb,skip_float_tests] {
4913 # There is an ARM kernel ptrace bug that hardware VFP registers
4914 # are not updated after GDB ptrace set VFP registers. The bug
4915 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
4916 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
4917 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
4918 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
4919 # This kernel bug is detected by check how does GDB change the
4920 # program result by changing one VFP register.
4921 if { [istarget "arm*-*-linux*"] } {
4923 set compile_flags {debug nowarnings }
4925 # Set up, compile, and execute a test program having VFP
4927 set src [standard_temp_file arm_vfp[pid].c]
4928 set exe [standard_temp_file arm_vfp[pid].x]
4930 gdb_produce_source $src {
4935 asm ("vldr d0, [%0]" : : "r" (&d));
4936 asm ("vldr d1, [%0]" : : "r" (&d));
4937 asm (".global break_here\n"
4939 asm ("vcmp.f64 d0, d1\n"
4940 "vmrs APSR_nzcv, fpscr\n"
4941 "bne L_value_different\n"
4944 "L_value_different:\n"
4946 "L_end:\n" : "=r" (ret) :);
4948 /* Return $d0 != $d1. */
4953 verbose "compiling testfile $src" 2
4954 set lines [gdb_compile $src $exe executable $compile_flags]
4957 if ![string match "" $lines] then {
4958 verbose "testfile compilation failed, returning 1" 2
4962 # No error message, compilation succeeded so now run it via gdb.
4963 # Run the test up to 5 times to detect whether ptrace can
4964 # correctly update VFP registers or not.
4966 for {set i 0} {$i < 5} {incr i} {
4967 global gdb_prompt srcdir subdir
4971 gdb_reinitialize_dir $srcdir/$subdir
4975 gdb_test "break *break_here"
4976 gdb_continue_to_breakpoint "break_here"
4978 # Modify $d0 to a different value, so the exit code should
4980 gdb_test "set \$d0 = 5.0"
4982 set test "continue to exit"
4983 gdb_test_multiple "continue" "$test" {
4984 -re "exited with code 01.*$gdb_prompt $" {
4986 -re "exited normally.*$gdb_prompt $" {
4987 # However, the exit code is 0. That means something
4988 # wrong in setting VFP registers.
4996 remote_file build delete $exe
4998 return $skip_vfp_test
5003 # Print a message and return true if a test should be skipped
5004 # due to lack of stdio support.
5006 proc gdb_skip_stdio_test { msg } {
5007 if [target_info exists gdb,noinferiorio] {
5008 verbose "Skipping test '$msg': no inferior i/o."
5014 proc gdb_skip_bogus_test { msg } {
5018 # Return true if a test should be skipped due to lack of XML support
5020 # NOTE: This must be called while gdb is *not* running.
5022 gdb_caching_proc gdb_skip_xml_test {
5026 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5030 gdb_test_multiple "set tdesc filename $xml_file" "" {
5031 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5034 -re ".*$gdb_prompt $" { }
5040 # Return true if argv[0] is available.
5042 gdb_caching_proc gdb_has_argv0 {
5045 # Set up, compile, and execute a test program to check whether
5046 # argv[0] is available.
5047 set src [standard_temp_file has_argv0[pid].c]
5048 set exe [standard_temp_file has_argv0[pid].x]
5050 gdb_produce_source $src {
5051 int main (int argc, char **argv) {
5056 gdb_compile $src $exe executable {debug}
5059 proc gdb_has_argv0_1 { exe } {
5060 global srcdir subdir
5061 global gdb_prompt hex
5065 gdb_reinitialize_dir $srcdir/$subdir
5068 # Set breakpoint on main.
5069 gdb_test_multiple "break main" "break main" {
5070 -re "Breakpoint.*${gdb_prompt} $" {
5072 -re "${gdb_prompt} $" {
5079 gdb_test_multiple "" "run to main" {
5080 -re "Breakpoint.*${gdb_prompt} $" {
5082 -re "${gdb_prompt} $" {
5087 set old_elements "200"
5088 set test "show print elements"
5089 gdb_test_multiple $test $test {
5090 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5091 set old_elements $expect_out(1,string)
5094 set old_repeats "200"
5095 set test "show print repeats"
5096 gdb_test_multiple $test $test {
5097 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5098 set old_repeats $expect_out(1,string)
5101 gdb_test_no_output "set print elements unlimited" ""
5102 gdb_test_no_output "set print repeats unlimited" ""
5105 # Check whether argc is 1.
5106 gdb_test_multiple "p argc" "p argc" {
5107 -re " = 1\r\n${gdb_prompt} $" {
5109 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5110 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5113 -re "${gdb_prompt} $" {
5117 -re "${gdb_prompt} $" {
5121 gdb_test_no_output "set print elements $old_elements" ""
5122 gdb_test_no_output "set print repeats $old_repeats" ""
5127 set result [gdb_has_argv0_1 $exe]
5134 && ([istarget *-*-linux*]
5135 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5136 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5137 || [istarget *-*-openbsd*]
5138 || [istarget *-*-darwin*]
5139 || [istarget *-*-solaris*]
5140 || [istarget *-*-aix*]
5141 || [istarget *-*-gnu*]
5142 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5143 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5144 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5145 || [istarget *-*-symbianelf*]
5146 || [istarget *-*-osf*]
5147 || [istarget *-*-dicos*]
5148 || [istarget *-*-nto*]
5149 || [istarget *-*-*vms*]
5150 || [istarget *-*-lynx*178]) } {
5151 fail "argv\[0\] should be available on this target"
5157 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5158 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5159 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5160 # the name of a debuginfo only file. This file will be stored in the same
5163 # Functions for separate debug info testing
5165 # starting with an executable:
5166 # foo --> original executable
5168 # at the end of the process we have:
5169 # foo.stripped --> foo w/o debug info
5170 # foo.debug --> foo's debug info
5171 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5173 # Fetch the build id from the file.
5174 # Returns "" if there is none.
5176 proc get_build_id { filename } {
5177 if { ([istarget "*-*-mingw*"]
5178 || [istarget *-*-cygwin*]) } {
5179 set objdump_program [gdb_find_objdump]
5180 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5181 verbose "result is $result"
5182 verbose "output is $output"
5188 set tmp [standard_output_file "${filename}-tmp"]
5189 set objcopy_program [gdb_find_objcopy]
5190 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5191 verbose "result is $result"
5192 verbose "output is $output"
5197 fconfigure $fi -translation binary
5198 # Skip the NOTE header.
5203 if ![string compare $data ""] then {
5206 # Convert it to hex.
5207 binary scan $data H* data
5212 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5213 # converted to the form: .build-id/ab/cdef1234...89.debug
5214 # Return "" if no build-id found.
5215 proc build_id_debug_filename_get { filename } {
5216 set data [get_build_id $filename]
5217 if { $data == "" } {
5220 regsub {^..} $data {\0/} data
5221 return ".build-id/${data}.debug"
5224 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5225 # list of optional flags. The only currently supported flag is no-main,
5226 # which removes the symbol entry for main from the separate debug file.
5228 # Function returns zero on success. Function will return non-zero failure code
5229 # on some targets not supporting separate debug info (such as i386-msdos).
5231 proc gdb_gnu_strip_debug { dest args } {
5233 # Use the first separate debug info file location searched by GDB so the
5234 # run cannot be broken by some stale file searched with higher precedence.
5235 set debug_file "${dest}.debug"
5237 set strip_to_file_program [transform strip]
5238 set objcopy_program [gdb_find_objcopy]
5240 set debug_link [file tail $debug_file]
5241 set stripped_file "${dest}.stripped"
5243 # Get rid of the debug info, and store result in stripped_file
5244 # something like gdb/testsuite/gdb.base/blah.stripped.
5245 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5246 verbose "result is $result"
5247 verbose "output is $output"
5252 # Workaround PR binutils/10802:
5253 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5254 set perm [file attributes ${dest} -permissions]
5255 file attributes ${stripped_file} -permissions $perm
5257 # Get rid of everything but the debug info, and store result in debug_file
5258 # This will be in the .debug subdirectory, see above.
5259 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5260 verbose "result is $result"
5261 verbose "output is $output"
5266 # If no-main is passed, strip the symbol for main from the separate
5267 # file. This is to simulate the behavior of elfutils's eu-strip, which
5268 # leaves the symtab in the original file only. There's no way to get
5269 # objcopy or strip to remove the symbol table without also removing the
5270 # debugging sections, so this is as close as we can get.
5271 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5272 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5273 verbose "result is $result"
5274 verbose "output is $output"
5278 file delete "${debug_file}"
5279 file rename "${debug_file}-tmp" "${debug_file}"
5282 # Link the two previous output files together, adding the .gnu_debuglink
5283 # section to the stripped_file, containing a pointer to the debug_file,
5284 # save the new file in dest.
5285 # This will be the regular executable filename, in the usual location.
5286 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5287 verbose "result is $result"
5288 verbose "output is $output"
5293 # Workaround PR binutils/10802:
5294 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5295 set perm [file attributes ${stripped_file} -permissions]
5296 file attributes ${dest} -permissions $perm
5301 # Test the output of GDB_COMMAND matches the pattern obtained
5302 # by concatenating all elements of EXPECTED_LINES. This makes
5303 # it possible to split otherwise very long string into pieces.
5304 # If third argument is not empty, it's used as the name of the
5305 # test to be printed on pass/fail.
5306 proc help_test_raw { gdb_command expected_lines args } {
5307 set message $gdb_command
5308 if [llength $args]>0 then {
5309 set message [lindex $args 0]
5311 set expected_output [join $expected_lines ""]
5312 gdb_test "${gdb_command}" "${expected_output}" $message
5315 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5316 # are regular expressions that should match the beginning of output,
5317 # before the list of commands in that class. The presence of
5318 # command list and standard epilogue will be tested automatically.
5319 # Notice that the '[' and ']' characters don't need to be escaped for strings
5320 # wrapped in {} braces.
5321 proc test_class_help { command_class expected_initial_lines args } {
5323 "List of commands\:.*[\r\n]+"
5324 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5325 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5326 "Command name abbreviations are allowed if unambiguous\."
5328 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5330 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5333 # COMMAND_LIST should have either one element -- command to test, or
5334 # two elements -- abbreviated command to test, and full command the first
5335 # element is abbreviation of.
5336 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5337 # are regular expressions that should match the beginning of output,
5338 # before the list of subcommands. The presence of
5339 # subcommand list and standard epilogue will be tested automatically.
5340 proc test_prefix_command_help { command_list expected_initial_lines args } {
5341 set command [lindex $command_list 0]
5342 if {[llength $command_list]>1} {
5343 set full_command [lindex $command_list 1]
5345 set full_command $command
5347 # Use 'list' and not just {} because we want variables to
5348 # be expanded in this list.
5349 set l_stock_body [list\
5350 "List of $full_command subcommands\:.*\[\r\n\]+"\
5351 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5352 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5353 "Command name abbreviations are allowed if unambiguous\."]
5354 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5355 if {[llength $args]>0} {
5356 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5358 help_test_raw "help ${command}" $l_entire_body
5362 # Build executable named EXECUTABLE from specifications that allow
5363 # different options to be passed to different sub-compilations.
5364 # TESTNAME is the name of the test; this is passed to 'untested' if
5366 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5367 # contains the option "pthreads", then gdb_compile_pthreads is used.
5368 # ARGS is a flat list of source specifications, of the form:
5369 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5370 # Each SOURCE is compiled to an object file using its OPTIONS,
5371 # using gdb_compile.
5372 # Returns 0 on success, -1 on failure.
5373 proc build_executable_from_specs {testname executable options args} {
5377 set binfile [standard_output_file $executable]
5380 if { [lsearch -exact $options "c++"] >= 0 } {
5381 set info_options "c++"
5383 if [get_compiler_info ${info_options}] {
5387 set func gdb_compile
5388 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5389 if {$func_index != -1} {
5390 set func "${func}_[lindex $options $func_index]"
5393 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5394 # parameter. They also requires $sources while gdb_compile and
5395 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5396 if [string match gdb_compile_shlib* $func] {
5398 foreach {s local_options} $args {
5399 if { [regexp "^/" "$s"] } then {
5400 lappend sources_path "$s"
5402 lappend sources_path "$srcdir/$subdir/$s"
5405 set ret [$func $sources_path "${binfile}" $options]
5406 } elseif {[lsearch -exact $options rust] != -1} {
5408 foreach {s local_options} $args {
5409 if { [regexp "^/" "$s"] } then {
5410 lappend sources_path "$s"
5412 lappend sources_path "$srcdir/$subdir/$s"
5415 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5419 foreach {s local_options} $args {
5420 if { ! [regexp "^/" "$s"] } then {
5421 set s "$srcdir/$subdir/$s"
5423 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5427 lappend objects "${binfile}${i}.o"
5430 set ret [$func $objects "${binfile}" executable $options]
5440 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5441 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5442 # to pass to untested, if something is wrong. OPTIONS are passed
5443 # to gdb_compile directly.
5444 proc build_executable { testname executable {sources ""} {options {debug}} } {
5445 if {[llength $sources]==0} {
5446 set sources ${executable}.c
5449 set arglist [list $testname $executable $options]
5450 foreach source $sources {
5451 lappend arglist $source $options
5454 return [eval build_executable_from_specs $arglist]
5457 # Starts fresh GDB binary and loads an optional executable into GDB.
5458 # Usage: clean_restart [executable]
5459 # EXECUTABLE is the basename of the binary.
5461 proc clean_restart { args } {
5465 if { [llength $args] > 1 } {
5466 error "bad number of args: [llength $args]"
5471 gdb_reinitialize_dir $srcdir/$subdir
5473 if { [llength $args] >= 1 } {
5474 set executable [lindex $args 0]
5475 set binfile [standard_output_file ${executable}]
5480 # Prepares for testing by calling build_executable_full, then
5482 # TESTNAME is the name of the test.
5483 # Each element in ARGS is a list of the form
5484 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5485 # These are passed to build_executable_from_specs, which see.
5486 # The last EXECUTABLE is passed to clean_restart.
5487 # Returns 0 on success, non-zero on failure.
5488 proc prepare_for_testing_full {testname args} {
5489 foreach spec $args {
5490 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5493 set executable [lindex $spec 0]
5495 clean_restart $executable
5499 # Prepares for testing, by calling build_executable, and then clean_restart.
5500 # Please refer to build_executable for parameter description.
5501 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5503 if {[build_executable $testname $executable $sources $options] == -1} {
5506 clean_restart $executable
5511 proc get_valueof { fmt exp default } {
5514 set test "get valueof \"${exp}\""
5516 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5517 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5518 set val $expect_out(1,string)
5522 fail "$test (timeout)"
5528 proc get_integer_valueof { exp default } {
5531 set test "get integer valueof \"${exp}\""
5533 gdb_test_multiple "print /d ${exp}" "$test" {
5534 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5535 set val $expect_out(1,string)
5539 fail "$test (timeout)"
5545 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5546 # (using "print /x"). DEFAULT is used as fallback if print fails.
5547 # TEST is the test message to use. If can be ommitted, in which case
5548 # a test message is built from EXP.
5550 proc get_hexadecimal_valueof { exp default {test ""} } {
5554 set test "get hexadecimal valueof \"${exp}\""
5558 gdb_test_multiple "print /x ${exp}" $test {
5559 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5560 set val $expect_out(1,string)
5567 proc get_sizeof { type default } {
5568 return [get_integer_valueof "sizeof (${type})" $default]
5571 proc get_target_charset { } {
5574 gdb_test_multiple "show target-charset" "" {
5575 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5576 return $expect_out(1,string)
5578 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5579 return $expect_out(1,string)
5583 # Pick a reasonable default.
5584 warning "Unable to read target-charset."
5588 # Get the current value for remotetimeout and return it.
5589 proc get_remotetimeout { } {
5593 gdb_test_multiple "show remotetimeout" "" {
5594 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5595 return $expect_out(1,string)
5599 # Pick the default that gdb uses
5600 warning "Unable to read remotetimeout"
5604 # Set the remotetimeout to the specified timeout. Nothing is returned.
5605 proc set_remotetimeout { timeout } {
5608 gdb_test_multiple "set remotetimeout $timeout" "" {
5609 -re "$gdb_prompt $" {
5610 verbose "Set remotetimeout to $timeout\n"
5615 # ROOT and FULL are file names. Returns the relative path from ROOT
5616 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5617 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5620 proc relative_filename {root full} {
5621 set root_split [file split $root]
5622 set full_split [file split $full]
5624 set len [llength $root_split]
5626 if {[eval file join $root_split]
5627 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5628 error "$full not a subdir of $root"
5631 return [eval file join [lrange $full_split $len end]]
5634 # Log gdb command line and script if requested.
5635 if {[info exists TRANSCRIPT]} {
5636 rename send_gdb real_send_gdb
5637 rename remote_spawn real_remote_spawn
5638 rename remote_close real_remote_close
5640 global gdb_transcript
5641 set gdb_transcript ""
5643 global gdb_trans_count
5644 set gdb_trans_count 1
5646 proc remote_spawn {args} {
5647 global gdb_transcript gdb_trans_count outdir
5649 if {$gdb_transcript != ""} {
5650 close $gdb_transcript
5652 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5653 puts $gdb_transcript [lindex $args 1]
5654 incr gdb_trans_count
5656 return [uplevel real_remote_spawn $args]
5659 proc remote_close {args} {
5660 global gdb_transcript
5662 if {$gdb_transcript != ""} {
5663 close $gdb_transcript
5664 set gdb_transcript ""
5667 return [uplevel real_remote_close $args]
5670 proc send_gdb {args} {
5671 global gdb_transcript
5673 if {$gdb_transcript != ""} {
5674 puts -nonewline $gdb_transcript [lindex $args 0]
5677 return [uplevel real_send_gdb $args]
5681 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5682 if {[info exists GDB_PARALLEL]} {
5683 if {[is_remote host]} {
5687 [make_gdb_parallel_path outputs] \
5688 [make_gdb_parallel_path temp] \
5689 [make_gdb_parallel_path cache]
5693 proc core_find {binfile {deletefiles {}} {arg ""}} {
5694 global objdir subdir
5696 set destcore "$binfile.core"
5697 file delete $destcore
5699 # Create a core file named "$destcore" rather than just "core", to
5700 # avoid problems with sys admin types that like to regularly prune all
5701 # files named "core" from the system.
5703 # Arbitrarily try setting the core size limit to "unlimited" since
5704 # this does not hurt on systems where the command does not work and
5705 # allows us to generate a core on systems where it does.
5707 # Some systems append "core" to the name of the program; others append
5708 # the name of the program to "core"; still others (like Linux, as of
5709 # May 2003) create cores named "core.PID". In the latter case, we
5710 # could have many core files lying around, and it may be difficult to
5711 # tell which one is ours, so let's run the program in a subdirectory.
5713 set coredir [standard_output_file coredir.[getpid]]
5715 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5716 # remote_exec host "${binfile}"
5717 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5718 if [remote_file build exists $i] {
5719 remote_exec build "mv $i $destcore"
5723 # Check for "core.PID".
5724 if { $found == 0 } {
5725 set names [glob -nocomplain -directory $coredir core.*]
5726 if {[llength $names] == 1} {
5727 set corefile [file join $coredir [lindex $names 0]]
5728 remote_exec build "mv $corefile $destcore"
5732 if { $found == 0 } {
5733 # The braindamaged HPUX shell quits after the ulimit -c above
5734 # without executing ${binfile}. So we try again without the
5735 # ulimit here if we didn't find a core file above.
5736 # Oh, I should mention that any "braindamaged" non-Unix system has
5737 # the same problem. I like the cd bit too, it's really neat'n stuff.
5738 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5739 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5740 if [remote_file build exists $i] {
5741 remote_exec build "mv $i $destcore"
5747 # Try to clean up after ourselves.
5748 foreach deletefile $deletefiles {
5749 remote_file build delete [file join $coredir $deletefile]
5751 remote_exec build "rmdir $coredir"
5753 if { $found == 0 } {
5754 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5760 # gdb_target_symbol_prefix compiles a test program and then examines
5761 # the output from objdump to determine the prefix (such as underscore)
5762 # for linker symbol prefixes.
5764 gdb_caching_proc gdb_target_symbol_prefix {
5765 # Set up and compile a simple test program...
5766 set src [standard_temp_file main[pid].c]
5767 set exe [standard_temp_file main[pid].x]
5769 gdb_produce_source $src {
5775 verbose "compiling testfile $src" 2
5776 set compile_flags {debug nowarnings quiet}
5777 set lines [gdb_compile $src $exe executable $compile_flags]
5781 if ![string match "" $lines] then {
5782 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5784 set objdump_program [gdb_find_objdump]
5785 set result [catch "exec $objdump_program --syms $exe" output]
5788 && ![regexp -lineanchor \
5789 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5790 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5800 # gdb_target_symbol returns the provided symbol with the correct prefix
5801 # prepended. (See gdb_target_symbol_prefix, above.)
5803 proc gdb_target_symbol { symbol } {
5804 set prefix [gdb_target_symbol_prefix]
5805 return "${prefix}${symbol}"
5808 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5809 # added to gdb_compile options to define the C-preprocessor macro
5810 # SYMBOL_PREFIX with a value that can be prepended to symbols
5811 # for targets which require a prefix, such as underscore.
5813 # This version (_asm) defines the prefix without double quotes
5814 # surrounding the prefix. It is used to define the macro
5815 # SYMBOL_PREFIX for assembly language files. Another version, below,
5816 # is used for symbols in inline assembler in C/C++ files.
5818 # The lack of quotes in this version (_asm) makes it possible to
5819 # define supporting macros in the .S file. (The version which
5820 # uses quotes for the prefix won't work for such files since it's
5821 # impossible to define a quote-stripping macro in C.)
5823 # It's possible to use this version (_asm) for C/C++ source files too,
5824 # but a string is usually required in such files; providing a version
5825 # (no _asm) which encloses the prefix with double quotes makes it
5826 # somewhat easier to define the supporting macros in the test case.
5828 proc gdb_target_symbol_prefix_flags_asm {} {
5829 set prefix [gdb_target_symbol_prefix]
5830 if {$prefix ne ""} {
5831 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5837 # gdb_target_symbol_prefix_flags returns the same string as
5838 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5839 # enclosed in double quotes if there is a prefix.
5841 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5842 # extended discussion.
5844 proc gdb_target_symbol_prefix_flags {} {
5845 set prefix [gdb_target_symbol_prefix]
5846 if {$prefix ne ""} {
5847 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5853 # A wrapper for 'remote_exec host' that passes or fails a test.
5854 # Returns 0 if all went well, nonzero on failure.
5855 # TEST is the name of the test, other arguments are as for remote_exec.
5857 proc run_on_host { test program args } {
5858 verbose -log "run_on_host: $program $args"
5859 # remote_exec doesn't work properly if the output is set but the
5860 # input is the empty string -- so replace an empty input with
5862 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5863 set args [lreplace $args 1 1 "/dev/null"]
5865 set result [eval remote_exec host [list $program] $args]
5866 verbose "result is $result"
5867 set status [lindex $result 0]
5868 set output [lindex $result 1]
5873 verbose -log "run_on_host failed: $output"
5879 # Return non-zero if "board_info debug_flags" mentions Fission.
5880 # http://gcc.gnu.org/wiki/DebugFission
5881 # Fission doesn't support everything yet.
5882 # This supports working around bug 15954.
5884 proc using_fission { } {
5885 set debug_flags [board_info [target_info name] debug_flags]
5886 return [regexp -- "-gsplit-dwarf" $debug_flags]
5889 # Search the caller's ARGS list and set variables according to the list of
5890 # valid options described by ARGSET.
5892 # The first member of each one- or two-element list in ARGSET defines the
5893 # name of a variable that will be added to the caller's scope.
5895 # If only one element is given to describe an option, it the value is
5896 # 0 if the option is not present in (the caller's) ARGS or 1 if
5899 # If two elements are given, the second element is the default value of
5900 # the variable. This is then overwritten if the option exists in ARGS.
5902 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5903 # any optional components.
5906 # proc myproc {foo args} {
5907 # parse_args {{bar} {baz "abc"} {qux}}
5910 # myproc ABC -bar -baz DEF peanut butter
5911 # will define the following variables in myproc:
5912 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5913 # args will be the list {peanut butter}
5915 proc parse_args { argset } {
5918 foreach argument $argset {
5919 if {[llength $argument] == 1} {
5920 # No default specified, so we assume that we should set
5921 # the value to 1 if the arg is present and 0 if it's not.
5922 # It is assumed that no value is given with the argument.
5923 set result [lsearch -exact $args "-$argument"]
5924 if {$result != -1} then {
5925 uplevel 1 [list set $argument 1]
5926 set args [lreplace $args $result $result]
5928 uplevel 1 [list set $argument 0]
5930 } elseif {[llength $argument] == 2} {
5931 # There are two items in the argument. The second is a
5932 # default value to use if the item is not present.
5933 # Otherwise, the variable is set to whatever is provided
5934 # after the item in the args.
5935 set arg [lindex $argument 0]
5936 set result [lsearch -exact $args "-[lindex $arg 0]"]
5937 if {$result != -1} then {
5938 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5939 set args [lreplace $args $result [expr $result+1]]
5941 uplevel 1 [list set $arg [lindex $argument 1]]
5944 error "Badly formatted argument \"$argument\" in argument set"
5948 # The remaining args should be checked to see that they match the
5949 # number of items expected to be passed into the procedure...
5952 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5953 # return that string.
5955 proc capture_command_output { command prefix } {
5959 set output_string ""
5960 gdb_test_multiple "$command" "capture_command_output for $command" {
5961 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5962 set output_string $expect_out(1,string)
5965 return $output_string
5968 # A convenience function that joins all the arguments together, with a
5969 # regexp that matches exactly one end of line in between each argument.
5970 # This function is ideal to write the expected output of a GDB command
5971 # that generates more than a couple of lines, as this allows us to write
5972 # each line as a separate string, which is easier to read by a human
5975 proc multi_line { args } {
5976 return [join $args "\r\n"]
5979 # Always load compatibility stuff.