1 # Copyright 1992-2015 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.
963 # MESSAGE is an optional message to be printed. If this is
964 # omitted, then the pass/fail messages use the command string as the
965 # message. (If this is the empty string, then sometimes we don't
966 # call pass or fail at all; I don't understand this at all.)
967 # QUESTION is a question GDB may ask in response to COMMAND, like
969 # RESPONSE is the response to send if QUESTION appears.
972 # 1 if the test failed,
973 # 0 if the test passes,
974 # -1 if there was an internal error.
976 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
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] {
1405 # Load a file into the debugger.
1406 # The return value is 0 for success, -1 for failure.
1408 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1409 # to one of these values:
1411 # debug file was loaded successfully and has debug information
1412 # nodebug file was loaded successfully and has no debug information
1413 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1415 # fail file was not loaded
1417 # I tried returning this information as part of the return value,
1418 # but ran into a mess because of the many re-implementations of
1419 # gdb_load in config/*.exp.
1421 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1422 # this if they can get more information set.
1424 proc gdb_file_cmd { arg } {
1428 global last_loaded_file
1430 # Save this for the benefit of gdbserver-support.exp.
1431 set last_loaded_file $arg
1433 # Set whether debug info was found.
1434 # Default to "fail".
1435 global gdb_file_cmd_debug_info
1436 set gdb_file_cmd_debug_info "fail"
1438 if [is_remote host] {
1439 set arg [remote_download host $arg]
1441 perror "download failed"
1446 # The file command used to kill the remote target. For the benefit
1447 # of the testsuite, preserve this behavior.
1450 -re "Kill the program being debugged. .y or n. $" {
1452 verbose "\t\tKilling previous program being debugged"
1455 -re "$gdb_prompt $" {
1460 send_gdb "file $arg\n"
1462 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1463 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1464 set gdb_file_cmd_debug_info "lzma"
1467 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1468 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1469 set gdb_file_cmd_debug_info "nodebug"
1472 -re "Reading symbols from.*done.*$gdb_prompt $" {
1473 verbose "\t\tLoaded $arg into $GDB"
1474 set gdb_file_cmd_debug_info "debug"
1477 -re "Load new symbol table from \".*\".*y or n. $" {
1480 -re "Reading symbols from.*done.*$gdb_prompt $" {
1481 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1482 set gdb_file_cmd_debug_info "debug"
1486 perror "Couldn't load $arg, other program already loaded (timeout)."
1490 perror "Couldn't load $arg, other program already loaded (eof)."
1495 -re "No such file or directory.*$gdb_prompt $" {
1496 perror "($arg) No such file or directory"
1499 -re "A problem internal to GDB has been detected" {
1500 fail "($arg) (GDB internal error)"
1501 gdb_internal_error_resync
1504 -re "$gdb_prompt $" {
1505 perror "Couldn't load $arg into $GDB."
1509 perror "Couldn't load $arg into $GDB (timeout)."
1513 # This is an attempt to detect a core dump, but seems not to
1514 # work. Perhaps we need to match .* followed by eof, in which
1515 # gdb_expect does not seem to have a way to do that.
1516 perror "Couldn't load $arg into $GDB (eof)."
1522 # Default gdb_spawn procedure.
1524 proc default_gdb_spawn { } {
1527 global INTERNAL_GDBFLAGS GDBFLAGS
1530 gdb_stop_suppressing_tests
1532 # Set the default value, it may be overriden later by specific testfile.
1534 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1535 # is already started after connecting and run/attach are not supported.
1536 # This is used for the "remote" protocol. After GDB starts you should
1537 # check global $use_gdb_stub instead of the board as the testfile may force
1538 # a specific different target protocol itself.
1539 set use_gdb_stub [target_info exists use_gdb_stub]
1541 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1543 if [info exists gdb_spawn_id] {
1547 if ![is_remote host] {
1548 if { [which $GDB] == 0 } then {
1549 perror "$GDB does not exist."
1553 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1554 if { $res < 0 || $res == "" } {
1555 perror "Spawning $GDB failed."
1559 set gdb_spawn_id $res
1563 # Default gdb_start procedure.
1565 proc default_gdb_start { } {
1566 global gdb_prompt pagination_prompt
1568 global inferior_spawn_id
1570 if [info exists gdb_spawn_id] {
1579 # Default to assuming inferior I/O is done on GDB's terminal.
1580 if {![info exists inferior_spawn_id]} {
1581 set inferior_spawn_id $gdb_spawn_id
1584 # When running over NFS, particularly if running many simultaneous
1585 # tests on different hosts all using the same server, things can
1586 # get really slow. Give gdb at least 3 minutes to start up.
1588 while { $loop_again } {
1591 -re "$pagination_prompt" {
1592 verbose "Hit pagination during startup. Pressing enter to continue."
1596 -re "\[\r\n\]$gdb_prompt $" {
1597 verbose "GDB initialized."
1599 -re "$gdb_prompt $" {
1600 perror "GDB never initialized."
1605 perror "(timeout) GDB never initialized after 10 seconds."
1613 # force the height to "unlimited", so no pagers get used
1615 send_gdb "set height 0\n"
1617 -re "$gdb_prompt $" {
1618 verbose "Setting height to 0." 2
1621 warning "Couldn't set the height to 0"
1624 # force the width to "unlimited", so no wraparound occurs
1625 send_gdb "set width 0\n"
1627 -re "$gdb_prompt $" {
1628 verbose "Setting width to 0." 2
1631 warning "Couldn't set the width to 0."
1637 # Utility procedure to give user control of the gdb prompt in a script. It is
1638 # meant to be used for debugging test cases, and should not be left in the
1641 proc gdb_interact { } {
1643 set spawn_id $gdb_spawn_id
1645 send_user "+------------------------------------------+\n"
1646 send_user "| Script interrupted, you can now interact |\n"
1647 send_user "| with by gdb. Type >>> to continue. |\n"
1648 send_user "+------------------------------------------+\n"
1655 # Examine the output of compilation to determine whether compilation
1656 # failed or not. If it failed determine whether it is due to missing
1657 # compiler or due to compiler error. Report pass, fail or unsupported
1660 proc gdb_compile_test {src output} {
1661 if { $output == "" } {
1662 pass "compilation [file tail $src]"
1663 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1664 unsupported "compilation [file tail $src]"
1665 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1666 unsupported "compilation [file tail $src]"
1667 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1668 unsupported "compilation [file tail $src]"
1670 verbose -log "compilation failed: $output" 2
1671 fail "compilation [file tail $src]"
1675 # Return a 1 for configurations for which we don't even want to try to
1678 proc skip_cplus_tests {} {
1679 if { [istarget "h8300-*-*"] } {
1683 # The C++ IO streams are too large for HC11/HC12 and are thus not
1684 # available. The gdb C++ tests use them and don't compile.
1685 if { [istarget "m6811-*-*"] } {
1688 if { [istarget "m6812-*-*"] } {
1694 # Return a 1 for configurations for which don't have both C++ and the STL.
1696 proc skip_stl_tests {} {
1697 # Symbian supports the C++ language, but the STL is missing
1698 # (both headers and libraries).
1699 if { [istarget "arm*-*-symbianelf*"] } {
1703 return [skip_cplus_tests]
1706 # Return a 1 if I don't even want to try to test FORTRAN.
1708 proc skip_fortran_tests {} {
1712 # Return a 1 if I don't even want to try to test ada.
1714 proc skip_ada_tests {} {
1718 # Return a 1 if I don't even want to try to test GO.
1720 proc skip_go_tests {} {
1724 # Return a 1 if I don't even want to try to test java.
1726 proc skip_java_tests {} {
1730 # Return a 1 if I don't even want to try to test D.
1732 proc skip_d_tests {} {
1736 # Return a 1 for configurations that do not support Python scripting.
1737 # PROMPT_REGEXP is the expected prompt.
1739 proc skip_python_tests_prompt { prompt_regexp } {
1740 global gdb_py_is_py3k
1741 global gdb_py_is_py24
1743 gdb_test_multiple "python print ('test')" "verify python support" {
1744 -re "not supported.*$prompt_regexp" {
1745 unsupported "Python support is disabled."
1748 -re "$prompt_regexp" {}
1751 set gdb_py_is_py24 0
1752 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1753 -re "3.*$prompt_regexp" {
1754 set gdb_py_is_py3k 1
1756 -re ".*$prompt_regexp" {
1757 set gdb_py_is_py3k 0
1760 if { $gdb_py_is_py3k == 0 } {
1761 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1762 -re "\[45\].*$prompt_regexp" {
1763 set gdb_py_is_py24 1
1765 -re ".*$prompt_regexp" {
1766 set gdb_py_is_py24 0
1774 # Return a 1 for configurations that do not support Python scripting.
1775 # Note: This also sets various globals that specify which version of Python
1776 # is in use. See skip_python_tests_prompt.
1778 proc skip_python_tests {} {
1780 return [skip_python_tests_prompt "$gdb_prompt $"]
1783 # Return a 1 if we should skip shared library tests.
1785 proc skip_shlib_tests {} {
1786 # Run the shared library tests on native systems.
1791 # An abbreviated list of remote targets where we should be able to
1792 # run shared library tests.
1793 if {([istarget *-*-linux*]
1794 || [istarget *-*-*bsd*]
1795 || [istarget *-*-solaris2*]
1796 || [istarget arm*-*-symbianelf*]
1797 || [istarget *-*-mingw*]
1798 || [istarget *-*-cygwin*]
1799 || [istarget *-*-pe*])} {
1806 # Return 1 if we should skip tui related tests.
1808 proc skip_tui_tests {} {
1811 gdb_test_multiple "help layout" "verify tui support" {
1812 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1815 -re "$gdb_prompt $" {
1822 # Test files shall make sure all the test result lines in gdb.sum are
1823 # unique in a test run, so that comparing the gdb.sum files of two
1824 # test runs gives correct results. Test files that exercise
1825 # variations of the same tests more than once, shall prefix the
1826 # different test invocations with different identifying strings in
1827 # order to make them unique.
1829 # About test prefixes:
1831 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1832 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1833 # underlined substring in
1835 # PASS: gdb.base/mytest.exp: some test
1836 # ^^^^^^^^^^^^^^^^^^^^
1840 # The easiest way to adjust the test prefix is to append a test
1841 # variation prefix to the $pf_prefix, using the with_test_prefix
1844 # proc do_tests {} {
1845 # gdb_test ... ... "test foo"
1846 # gdb_test ... ... "test bar"
1848 # with_test_prefix "subvariation a" {
1849 # gdb_test ... ... "test x"
1852 # with_test_prefix "subvariation b" {
1853 # gdb_test ... ... "test x"
1857 # with_test_prefix "variation1" {
1858 # ...do setup for variation 1...
1862 # with_test_prefix "variation2" {
1863 # ...do setup for variation 2...
1869 # PASS: gdb.base/mytest.exp: variation1: test foo
1870 # PASS: gdb.base/mytest.exp: variation1: test bar
1871 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1872 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1873 # PASS: gdb.base/mytest.exp: variation2: test foo
1874 # PASS: gdb.base/mytest.exp: variation2: test bar
1875 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1876 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1878 # If for some reason more flexibility is necessary, one can also
1879 # manipulate the pf_prefix global directly, treating it as a string.
1883 # set saved_pf_prefix
1884 # append pf_prefix "${foo}: bar"
1885 # ... actual tests ...
1886 # set pf_prefix $saved_pf_prefix
1889 # Run BODY in the context of the caller, with the current test prefix
1890 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1891 # Returns the result of BODY.
1893 proc with_test_prefix { prefix body } {
1896 set saved $pf_prefix
1897 append pf_prefix " " $prefix ":"
1898 set code [catch {uplevel 1 $body} result]
1899 set pf_prefix $saved
1902 global errorInfo errorCode
1903 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1905 return -code $code $result
1909 # Run BODY in the context of the caller. After BODY is run, the variables
1910 # listed in VARS will be reset to the values they had before BODY was run.
1912 # This is useful for providing a scope in which it is safe to temporarily
1913 # modify global variables, e.g.
1915 # global INTERNAL_GDBFLAGS
1918 # set foo GDBHISTSIZE
1920 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1921 # append INTERNAL_GDBFLAGS " -nx"
1922 # unset -nocomplain env(GDBHISTSIZE)
1927 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1928 # modified inside BODY, this proc guarantees that the modifications will be
1929 # undone after BODY finishes executing.
1931 proc save_vars { vars body } {
1932 array set saved_scalars { }
1933 array set saved_arrays { }
1937 # First evaluate VAR in the context of the caller in case the variable
1938 # name may be a not-yet-interpolated string like env($foo)
1939 set var [uplevel 1 list $var]
1941 if [uplevel 1 [list info exists $var]] {
1942 if [uplevel 1 [list array exists $var]] {
1943 set saved_arrays($var) [uplevel 1 [list array get $var]]
1945 set saved_scalars($var) [uplevel 1 [list set $var]]
1948 lappend unset_vars $var
1952 set code [catch {uplevel 1 $body} result]
1954 foreach {var value} [array get saved_scalars] {
1955 uplevel 1 [list set $var $value]
1958 foreach {var value} [array get saved_arrays] {
1959 uplevel 1 [list unset $var]
1960 uplevel 1 [list array set $var $value]
1963 foreach var $unset_vars {
1964 uplevel 1 [list unset -nocomplain $var]
1968 global errorInfo errorCode
1969 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1971 return -code $code $result
1976 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1977 # PROMPT. When BODY is finished, restore GDB prompt and variable
1979 # Returns the result of BODY.
1983 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
1984 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
1985 # TCL). PROMPT is internally converted to a suitable regexp for matching.
1986 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
1987 # a) It's more intuitive for callers to pass the plain text form.
1988 # b) We need two forms of the prompt:
1989 # - a regexp to use in output matching,
1990 # - a value to pass to the "set prompt" command.
1991 # c) It's easier to convert the plain text form to its regexp form.
1993 # 2) Don't add a trailing space, we do that here.
1995 proc with_gdb_prompt { prompt body } {
1998 # Convert "(foo)" to "\(foo\)".
1999 # We don't use string_to_regexp because while it works today it's not
2000 # clear it will work tomorrow: the value we need must work as both a
2001 # regexp *and* as the argument to the "set prompt" command, at least until
2002 # we start recording both forms separately instead of just $gdb_prompt.
2003 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2005 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2007 set saved $gdb_prompt
2009 verbose -log "Setting gdb prompt to \"$prompt \"."
2010 set gdb_prompt $prompt
2011 gdb_test_no_output "set prompt $prompt " ""
2013 set code [catch {uplevel 1 $body} result]
2015 verbose -log "Restoring gdb prompt to \"$saved \"."
2016 set gdb_prompt $saved
2017 gdb_test_no_output "set prompt $saved " ""
2020 global errorInfo errorCode
2021 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2023 return -code $code $result
2027 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2028 # BODY is finished, restore target-charset.
2030 proc with_target_charset { target_charset body } {
2034 gdb_test_multiple "show target-charset" "" {
2035 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2036 set saved $expect_out(1,string)
2038 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2039 set saved $expect_out(1,string)
2041 -re ".*$gdb_prompt " {
2042 fail "get target-charset"
2046 gdb_test_no_output "set target-charset $target_charset" ""
2048 set code [catch {uplevel 1 $body} result]
2050 gdb_test_no_output "set target-charset $saved" ""
2053 global errorInfo errorCode
2054 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2056 return -code $code $result
2060 # Select the largest timeout from all the timeouts:
2061 # - the local "timeout" variable of the scope two levels above,
2062 # - the global "timeout" variable,
2063 # - the board variable "gdb,timeout".
2065 proc get_largest_timeout {} {
2066 upvar #0 timeout gtimeout
2067 upvar 2 timeout timeout
2070 if [info exists timeout] {
2073 if { [info exists gtimeout] && $gtimeout > $tmt } {
2076 if { [target_info exists gdb,timeout]
2077 && [target_info gdb,timeout] > $tmt } {
2078 set tmt [target_info gdb,timeout]
2088 # Run tests in BODY with timeout increased by factor of FACTOR. When
2089 # BODY is finished, restore timeout.
2091 proc with_timeout_factor { factor body } {
2094 set savedtimeout $timeout
2096 set timeout [expr [get_largest_timeout] * $factor]
2097 set code [catch {uplevel 1 $body} result]
2099 set timeout $savedtimeout
2101 global errorInfo errorCode
2102 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2104 return -code $code $result
2108 # Return 1 if _Complex types are supported, otherwise, return 0.
2110 gdb_caching_proc support_complex_tests {
2111 # Set up, compile, and execute a test program containing _Complex types.
2112 # Include the current process ID in the file names to prevent conflicts
2113 # with invocations for multiple testsuites.
2114 set src [standard_temp_file complex[pid].c]
2115 set exe [standard_temp_file complex[pid].x]
2117 gdb_produce_source $src {
2121 _Complex long double cld;
2126 verbose "compiling testfile $src" 2
2127 set compile_flags {debug nowarnings quiet}
2128 set lines [gdb_compile $src $exe executable $compile_flags]
2132 if ![string match "" $lines] then {
2133 verbose "testfile compilation failed, returning 0" 2
2142 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2145 proc supports_get_siginfo_type {} {
2146 if { [istarget "*-*-linux*"] } {
2153 # Return 1 if the target supports hardware single stepping.
2155 proc can_hardware_single_step {} {
2157 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2158 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2159 || [istarget "nios2-*-*"] } {
2166 # Return 1 if target hardware or OS supports single stepping to signal
2167 # handler, otherwise, return 0.
2169 proc can_single_step_to_signal_handler {} {
2170 # Targets don't have hardware single step. On these targets, when
2171 # a signal is delivered during software single step, gdb is unable
2172 # to determine the next instruction addresses, because start of signal
2173 # handler is one of them.
2174 return [can_hardware_single_step]
2177 # Return 1 if target supports process record, otherwise return 0.
2179 proc supports_process_record {} {
2181 if [target_info exists gdb,use_precord] {
2182 return [target_info gdb,use_precord]
2185 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2186 || [istarget "i\[34567\]86-*-linux*"]
2187 || [istarget "aarch64*-*-linux*"]
2188 || [istarget "powerpc*-*-linux*"] } {
2195 # Return 1 if target supports reverse debugging, otherwise return 0.
2197 proc supports_reverse {} {
2199 if [target_info exists gdb,can_reverse] {
2200 return [target_info gdb,can_reverse]
2203 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2204 || [istarget "i\[34567\]86-*-linux*"]
2205 || [istarget "aarch64*-*-linux*"]
2206 || [istarget "powerpc*-*-linux*"] } {
2213 # Return 1 if readline library is used.
2215 proc readline_is_used { } {
2218 gdb_test_multiple "show editing" "" {
2219 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2222 -re ".*$gdb_prompt $" {
2228 # Return 1 if target is ELF.
2229 gdb_caching_proc is_elf_target {
2230 set me "is_elf_target"
2232 set src [standard_temp_file is_elf_target[pid].c]
2233 set obj [standard_temp_file is_elf_target[pid].o]
2235 gdb_produce_source $src {
2236 int foo () {return 0;}
2239 verbose "$me: compiling testfile $src" 2
2240 set lines [gdb_compile $src $obj object {quiet}]
2244 if ![string match "" $lines] then {
2245 verbose "$me: testfile compilation failed, returning 0" 2
2249 set fp_obj [open $obj "r"]
2250 fconfigure $fp_obj -translation binary
2251 set data [read $fp_obj]
2256 set ELFMAG "\u007FELF"
2258 if {[string compare -length 4 $data $ELFMAG] != 0} {
2259 verbose "$me: returning 0" 2
2263 verbose "$me: returning 1" 2
2267 # Return 1 if the memory at address zero is readable.
2269 gdb_caching_proc is_address_zero_readable {
2273 gdb_test_multiple "x 0" "" {
2274 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2277 -re ".*$gdb_prompt $" {
2285 # Produce source file NAME and write SOURCES into it.
2287 proc gdb_produce_source { name sources } {
2289 set f [open $name "w"]
2295 # Return 1 if target is ILP32.
2296 # This cannot be decided simply from looking at the target string,
2297 # as it might depend on externally passed compiler options like -m64.
2298 gdb_caching_proc is_ilp32_target {
2299 set me "is_ilp32_target"
2301 set src [standard_temp_file ilp32[pid].c]
2302 set obj [standard_temp_file ilp32[pid].o]
2304 gdb_produce_source $src {
2305 int dummy[sizeof (int) == 4
2306 && sizeof (void *) == 4
2307 && sizeof (long) == 4 ? 1 : -1];
2310 verbose "$me: compiling testfile $src" 2
2311 set lines [gdb_compile $src $obj object {quiet}]
2315 if ![string match "" $lines] then {
2316 verbose "$me: testfile compilation failed, returning 0" 2
2320 verbose "$me: returning 1" 2
2324 # Return 1 if target is LP64.
2325 # This cannot be decided simply from looking at the target string,
2326 # as it might depend on externally passed compiler options like -m64.
2327 gdb_caching_proc is_lp64_target {
2328 set me "is_lp64_target"
2330 set src [standard_temp_file lp64[pid].c]
2331 set obj [standard_temp_file lp64[pid].o]
2333 gdb_produce_source $src {
2334 int dummy[sizeof (int) == 4
2335 && sizeof (void *) == 8
2336 && sizeof (long) == 8 ? 1 : -1];
2339 verbose "$me: compiling testfile $src" 2
2340 set lines [gdb_compile $src $obj object {quiet}]
2344 if ![string match "" $lines] then {
2345 verbose "$me: testfile compilation failed, returning 0" 2
2349 verbose "$me: returning 1" 2
2353 # Return 1 if target has 64 bit addresses.
2354 # This cannot be decided simply from looking at the target string,
2355 # as it might depend on externally passed compiler options like -m64.
2356 gdb_caching_proc is_64_target {
2357 set me "is_64_target"
2359 set src [standard_temp_file is64[pid].c]
2360 set obj [standard_temp_file is64[pid].o]
2362 gdb_produce_source $src {
2363 int function(void) { return 3; }
2364 int dummy[sizeof (&function) == 8 ? 1 : -1];
2367 verbose "$me: compiling testfile $src" 2
2368 set lines [gdb_compile $src $obj object {quiet}]
2372 if ![string match "" $lines] then {
2373 verbose "$me: testfile compilation failed, returning 0" 2
2377 verbose "$me: returning 1" 2
2381 # Return 1 if target has x86_64 registers - either amd64 or x32.
2382 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2383 # just from the target string.
2384 gdb_caching_proc is_amd64_regs_target {
2385 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2389 set me "is_amd64_regs_target"
2391 set src [standard_temp_file reg64[pid].s]
2392 set obj [standard_temp_file reg64[pid].o]
2396 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2397 lappend list "\tincq %$reg"
2399 gdb_produce_source $src [join $list \n]
2401 verbose "$me: compiling testfile $src" 2
2402 set lines [gdb_compile $src $obj object {quiet}]
2406 if ![string match "" $lines] then {
2407 verbose "$me: testfile compilation failed, returning 0" 2
2411 verbose "$me: returning 1" 2
2415 # Return 1 if this target is an x86 or x86-64 with -m32.
2416 proc is_x86_like_target {} {
2417 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2420 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2423 # Return 1 if this target is an arm or aarch32 on aarch64.
2425 gdb_caching_proc is_aarch32_target {
2426 if { [istarget "arm*-*-*"] } {
2430 if { ![istarget "aarch64*-*-*"] } {
2434 set me "is_aarch32_target"
2436 set src [standard_temp_file aarch32[pid].s]
2437 set obj [standard_temp_file aarch32[pid].o]
2442 lappend list "\tmov $reg, $reg"
2444 gdb_produce_source $src [join $list \n]
2446 verbose "$me: compiling testfile $src" 2
2447 set lines [gdb_compile $src $obj object {quiet}]
2451 if ![string match "" $lines] then {
2452 verbose "$me: testfile compilation failed, returning 0" 2
2456 verbose "$me: returning 1" 2
2460 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2462 proc is_aarch64_target {} {
2463 if { ![istarget "aarch64*-*-*"] } {
2467 return [expr ![is_aarch32_target]]
2470 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2471 proc support_displaced_stepping {} {
2473 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2474 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2475 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2476 || [istarget "aarch64*-*-linux*"] } {
2483 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2484 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2486 gdb_caching_proc skip_altivec_tests {
2487 global srcdir subdir gdb_prompt inferior_exited_re
2489 set me "skip_altivec_tests"
2491 # Some simulators are known to not support VMX instructions.
2492 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2493 verbose "$me: target known to not support VMX, returning 1" 2
2497 # Make sure we have a compiler that understands altivec.
2498 set compile_flags {debug nowarnings}
2499 if [get_compiler_info] {
2500 warning "Could not get compiler info"
2503 if [test_compiler_info gcc*] {
2504 set compile_flags "$compile_flags additional_flags=-maltivec"
2505 } elseif [test_compiler_info xlc*] {
2506 set compile_flags "$compile_flags additional_flags=-qaltivec"
2508 verbose "Could not compile with altivec support, returning 1" 2
2512 # Set up, compile, and execute a test program containing VMX instructions.
2513 # Include the current process ID in the file names to prevent conflicts
2514 # with invocations for multiple testsuites.
2515 set src [standard_temp_file vmx[pid].c]
2516 set exe [standard_temp_file vmx[pid].x]
2518 gdb_produce_source $src {
2521 asm volatile ("vor v0,v0,v0");
2523 asm volatile ("vor 0,0,0");
2529 verbose "$me: compiling testfile $src" 2
2530 set lines [gdb_compile $src $exe executable $compile_flags]
2533 if ![string match "" $lines] then {
2534 verbose "$me: testfile compilation failed, returning 1" 2
2538 # No error message, compilation succeeded so now run it via gdb.
2542 gdb_reinitialize_dir $srcdir/$subdir
2546 -re ".*Illegal instruction.*${gdb_prompt} $" {
2547 verbose -log "\n$me altivec hardware not detected"
2548 set skip_vmx_tests 1
2550 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2551 verbose -log "\n$me: altivec hardware detected"
2552 set skip_vmx_tests 0
2555 warning "\n$me: default case taken"
2556 set skip_vmx_tests 1
2560 remote_file build delete $exe
2562 verbose "$me: returning $skip_vmx_tests" 2
2563 return $skip_vmx_tests
2566 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2567 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2569 gdb_caching_proc skip_vsx_tests {
2570 global srcdir subdir gdb_prompt inferior_exited_re
2572 set me "skip_vsx_tests"
2574 # Some simulators are known to not support Altivec instructions, so
2575 # they won't support VSX instructions as well.
2576 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2577 verbose "$me: target known to not support VSX, returning 1" 2
2581 # Make sure we have a compiler that understands altivec.
2582 set compile_flags {debug nowarnings quiet}
2583 if [get_compiler_info] {
2584 warning "Could not get compiler info"
2587 if [test_compiler_info gcc*] {
2588 set compile_flags "$compile_flags additional_flags=-mvsx"
2589 } elseif [test_compiler_info xlc*] {
2590 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2592 verbose "Could not compile with vsx support, returning 1" 2
2596 set src [standard_temp_file vsx[pid].c]
2597 set exe [standard_temp_file vsx[pid].x]
2599 gdb_produce_source $src {
2601 double a[2] = { 1.0, 2.0 };
2603 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2605 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2611 verbose "$me: compiling testfile $src" 2
2612 set lines [gdb_compile $src $exe executable $compile_flags]
2615 if ![string match "" $lines] then {
2616 verbose "$me: testfile compilation failed, returning 1" 2
2620 # No error message, compilation succeeded so now run it via gdb.
2624 gdb_reinitialize_dir $srcdir/$subdir
2628 -re ".*Illegal instruction.*${gdb_prompt} $" {
2629 verbose -log "\n$me VSX hardware not detected"
2630 set skip_vsx_tests 1
2632 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2633 verbose -log "\n$me: VSX hardware detected"
2634 set skip_vsx_tests 0
2637 warning "\n$me: default case taken"
2638 set skip_vsx_tests 1
2642 remote_file build delete $exe
2644 verbose "$me: returning $skip_vsx_tests" 2
2645 return $skip_vsx_tests
2648 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2649 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2651 gdb_caching_proc skip_tsx_tests {
2652 global srcdir subdir gdb_prompt inferior_exited_re
2654 set me "skip_tsx_tests"
2656 set src [standard_temp_file tsx[pid].c]
2657 set exe [standard_temp_file tsx[pid].x]
2659 gdb_produce_source $src {
2661 asm volatile ("xbegin .L0");
2662 asm volatile ("xend");
2663 asm volatile (".L0: nop");
2668 verbose "$me: compiling testfile $src" 2
2669 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2672 if ![string match "" $lines] then {
2673 verbose "$me: testfile compilation failed." 2
2677 # No error message, compilation succeeded so now run it via gdb.
2681 gdb_reinitialize_dir $srcdir/$subdir
2685 -re ".*Illegal instruction.*${gdb_prompt} $" {
2686 verbose -log "$me: TSX hardware not detected."
2687 set skip_tsx_tests 1
2689 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2690 verbose -log "$me: TSX hardware detected."
2691 set skip_tsx_tests 0
2694 warning "\n$me: default case taken."
2695 set skip_tsx_tests 1
2699 remote_file build delete $exe
2701 verbose "$me: returning $skip_tsx_tests" 2
2702 return $skip_tsx_tests
2705 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2706 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2708 gdb_caching_proc skip_btrace_tests {
2709 global srcdir subdir gdb_prompt inferior_exited_re
2711 set me "skip_btrace_tests"
2712 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2713 verbose "$me: target does not support btrace, returning 1" 2
2717 # Set up, compile, and execute a test program.
2718 # Include the current process ID in the file names to prevent conflicts
2719 # with invocations for multiple testsuites.
2720 set src [standard_temp_file btrace[pid].c]
2721 set exe [standard_temp_file btrace[pid].x]
2723 gdb_produce_source $src {
2724 int main(void) { return 0; }
2727 verbose "$me: compiling testfile $src" 2
2728 set compile_flags {debug nowarnings quiet}
2729 set lines [gdb_compile $src $exe executable $compile_flags]
2731 if ![string match "" $lines] then {
2732 verbose "$me: testfile compilation failed, returning 1" 2
2737 # No error message, compilation succeeded so now run it via gdb.
2741 gdb_reinitialize_dir $srcdir/$subdir
2748 # In case of an unexpected output, we return 2 as a fail value.
2749 set skip_btrace_tests 2
2750 gdb_test_multiple "record btrace" "check btrace support" {
2751 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2752 set skip_btrace_tests 1
2754 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2755 set skip_btrace_tests 1
2757 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2758 set skip_btrace_tests 1
2760 -re "^record btrace\r\n$gdb_prompt $" {
2761 set skip_btrace_tests 0
2765 remote_file build delete $exe
2767 verbose "$me: returning $skip_btrace_tests" 2
2768 return $skip_btrace_tests
2771 # Run a test on the target to see if it supports btrace pt hardware.
2772 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2773 # from the GCC testsuite.
2775 gdb_caching_proc skip_btrace_pt_tests {
2776 global srcdir subdir gdb_prompt inferior_exited_re
2778 set me "skip_btrace_tests"
2779 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2780 verbose "$me: target does not support btrace, returning 1" 2
2784 # Set up, compile, and execute a test program.
2785 # Include the current process ID in the file names to prevent conflicts
2786 # with invocations for multiple testsuites.
2787 set src [standard_temp_file btrace[pid].c]
2788 set exe [standard_temp_file btrace[pid].x]
2790 gdb_produce_source $src {
2791 int main(void) { return 0; }
2794 verbose "$me: compiling testfile $src" 2
2795 set compile_flags {debug nowarnings quiet}
2796 set lines [gdb_compile $src $exe executable $compile_flags]
2798 if ![string match "" $lines] then {
2799 verbose "$me: testfile compilation failed, returning 1" 2
2804 # No error message, compilation succeeded so now run it via gdb.
2808 gdb_reinitialize_dir $srcdir/$subdir
2815 # In case of an unexpected output, we return 2 as a fail value.
2816 set skip_btrace_tests 2
2817 gdb_test_multiple "record btrace pt" "check btrace support" {
2818 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2819 set skip_btrace_tests 1
2821 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2822 set skip_btrace_tests 1
2824 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2825 set skip_btrace_tests 1
2827 -re "^record btrace pt\r\n$gdb_prompt $" {
2828 set skip_btrace_tests 0
2832 remote_file build delete $exe
2834 verbose "$me: returning $skip_btrace_tests" 2
2835 return $skip_btrace_tests
2838 # Skip all the tests in the file if you are not on an hppa running
2841 proc skip_hp_tests {} {
2842 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
2843 verbose "Skip hp tests is $skip_hp"
2847 # Return whether we should skip tests for showing inlined functions in
2848 # backtraces. Requires get_compiler_info and get_debug_format.
2850 proc skip_inline_frame_tests {} {
2851 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2852 if { ! [test_debug_format "DWARF 2"] } {
2856 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2857 if { ([test_compiler_info "gcc-2-*"]
2858 || [test_compiler_info "gcc-3-*"]
2859 || [test_compiler_info "gcc-4-0-*"]) } {
2866 # Return whether we should skip tests for showing variables from
2867 # inlined functions. Requires get_compiler_info and get_debug_format.
2869 proc skip_inline_var_tests {} {
2870 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2871 if { ! [test_debug_format "DWARF 2"] } {
2878 # Return a 1 if we should skip tests that require hardware breakpoints
2880 proc skip_hw_breakpoint_tests {} {
2881 # Skip tests if requested by the board (note that no_hardware_watchpoints
2882 # disables both watchpoints and breakpoints)
2883 if { [target_info exists gdb,no_hardware_watchpoints]} {
2887 # These targets support hardware breakpoints natively
2888 if { [istarget "i?86-*-*"]
2889 || [istarget "x86_64-*-*"]
2890 || [istarget "ia64-*-*"]
2891 || [istarget "arm*-*-*"]
2892 || [istarget "aarch64*-*-*"]} {
2899 # Return a 1 if we should skip tests that require hardware watchpoints
2901 proc skip_hw_watchpoint_tests {} {
2902 # Skip tests if requested by the board
2903 if { [target_info exists gdb,no_hardware_watchpoints]} {
2907 # These targets support hardware watchpoints natively
2908 if { [istarget "i?86-*-*"]
2909 || [istarget "x86_64-*-*"]
2910 || [istarget "ia64-*-*"]
2911 || [istarget "arm*-*-*"]
2912 || [istarget "aarch64*-*-*"]
2913 || [istarget "powerpc*-*-linux*"]
2914 || [istarget "s390*-*-*"] } {
2921 # Return a 1 if we should skip tests that require *multiple* hardware
2922 # watchpoints to be active at the same time
2924 proc skip_hw_watchpoint_multi_tests {} {
2925 if { [skip_hw_watchpoint_tests] } {
2929 # These targets support just a single hardware watchpoint
2930 if { [istarget "arm*-*-*"]
2931 || [istarget "powerpc*-*-linux*"] } {
2938 # Return a 1 if we should skip tests that require read/access watchpoints
2940 proc skip_hw_watchpoint_access_tests {} {
2941 if { [skip_hw_watchpoint_tests] } {
2945 # These targets support just write watchpoints
2946 if { [istarget "s390*-*-*"] } {
2953 # Return 1 if we should skip tests that require the runtime unwinder
2954 # hook. This must be invoked while gdb is running, after shared
2955 # libraries have been loaded. This is needed because otherwise a
2956 # shared libgcc won't be visible.
2958 proc skip_unwinder_tests {} {
2962 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2963 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2965 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2968 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2972 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2973 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2976 -re "\r\n$gdb_prompt $" {
2983 # Return 0 if we should skip tests that require the libstdc++ stap
2984 # probes. This must be invoked while gdb is running, after shared
2985 # libraries have been loaded.
2987 proc skip_libstdcxx_probe_tests {} {
2991 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2992 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2995 -re "\r\n$gdb_prompt $" {
3001 # Return 1 if we should skip tests of the "compile" feature.
3002 # This must be invoked after the inferior has been started.
3004 proc skip_compile_feature_tests {} {
3008 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3009 "Could not load libcc1.*\r\n$gdb_prompt $" {
3012 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3015 -re "\r\n$gdb_prompt $" {
3021 # Check whether we're testing with the remote or extended-remote
3024 proc gdb_is_target_remote {} {
3027 set test "probe for target remote"
3028 gdb_test_multiple "maint print target-stack" $test {
3029 -re ".*emote serial target in gdb-specific protocol.*$gdb_prompt $" {
3033 -re "$gdb_prompt $" {
3040 # Return 1 if the current remote target is an instance of our GDBserver, 0
3041 # otherwise. Return -1 if there was an error and we can't tell.
3043 gdb_caching_proc target_is_gdbserver {
3047 set test "Probing for GDBserver"
3049 gdb_test_multiple "monitor help" $test {
3050 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3053 -re "$gdb_prompt $" {
3058 if { $is_gdbserver == -1 } {
3059 verbose -log "Unable to tell whether we are using GDBserver or not."
3062 return $is_gdbserver
3065 # N.B. compiler_info is intended to be local to this file.
3066 # Call test_compiler_info with no arguments to fetch its value.
3067 # Yes, this is counterintuitive when there's get_compiler_info,
3068 # but that's the current API.
3069 if [info exists compiler_info] {
3074 set hp_cc_compiler 0
3075 set hp_aCC_compiler 0
3077 # Figure out what compiler I am using.
3078 # The result is cached so only the first invocation runs the compiler.
3080 # ARG can be empty or "C++". If empty, "C" is assumed.
3082 # There are several ways to do this, with various problems.
3084 # [ gdb_compile -E $ifile -o $binfile.ci ]
3085 # source $binfile.ci
3087 # Single Unix Spec v3 says that "-E -o ..." together are not
3088 # specified. And in fact, the native compiler on hp-ux 11 (among
3089 # others) does not work with "-E -o ...". Most targets used to do
3090 # this, and it mostly worked, because it works with gcc.
3092 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3093 # source $binfile.ci
3095 # This avoids the problem with -E and -o together. This almost works
3096 # if the build machine is the same as the host machine, which is
3097 # usually true of the targets which are not gcc. But this code does
3098 # not figure which compiler to call, and it always ends up using the C
3099 # compiler. Not good for setting hp_aCC_compiler. Target
3100 # hppa*-*-hpux* used to do this.
3102 # [ gdb_compile -E $ifile > $binfile.ci ]
3103 # source $binfile.ci
3105 # dejagnu target_compile says that it supports output redirection,
3106 # but the code is completely different from the normal path and I
3107 # don't want to sweep the mines from that path. So I didn't even try
3110 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3113 # I actually do this for all targets now. gdb_compile runs the right
3114 # compiler, and TCL captures the output, and I eval the output.
3116 # Unfortunately, expect logs the output of the command as it goes by,
3117 # and dejagnu helpfully prints a second copy of it right afterwards.
3118 # So I turn off expect logging for a moment.
3120 # [ gdb_compile $ifile $ciexe_file executable $args ]
3121 # [ remote_exec $ciexe_file ]
3122 # [ source $ci_file.out ]
3124 # I could give up on -E and just do this.
3125 # I didn't get desperate enough to try this.
3127 # -- chastain 2004-01-06
3129 proc get_compiler_info {{arg ""}} {
3130 # For compiler.c and compiler.cc
3133 # I am going to play with the log to keep noise out.
3137 # These come from compiler.c or compiler.cc
3138 global compiler_info
3140 # Legacy global data symbols.
3142 global hp_cc_compiler
3143 global hp_aCC_compiler
3145 if [info exists compiler_info] {
3150 # Choose which file to preprocess.
3151 set ifile "${srcdir}/lib/compiler.c"
3152 if { $arg == "c++" } {
3153 set ifile "${srcdir}/lib/compiler.cc"
3156 # Run $ifile through the right preprocessor.
3157 # Toggle gdb.log to keep the compiler output out of the log.
3158 set saved_log [log_file -info]
3160 if [is_remote host] {
3161 # We have to use -E and -o together, despite the comments
3162 # above, because of how DejaGnu handles remote host testing.
3163 set ppout "$outdir/compiler.i"
3164 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3165 set file [open $ppout r]
3166 set cppout [read $file]
3169 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3171 eval log_file $saved_log
3175 foreach cppline [ split "$cppout" "\n" ] {
3176 if { [ regexp "^#" "$cppline" ] } {
3178 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3180 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3182 verbose "get_compiler_info: $cppline" 2
3186 verbose -log "get_compiler_info: $cppline"
3191 # Set to unknown if for some reason compiler_info didn't get defined.
3192 if ![info exists compiler_info] {
3193 verbose -log "get_compiler_info: compiler_info not provided"
3194 set compiler_info "unknown"
3196 # Also set to unknown compiler if any diagnostics happened.
3198 verbose -log "get_compiler_info: got unexpected diagnostics"
3199 set compiler_info "unknown"
3202 # Set the legacy symbols.
3204 set hp_cc_compiler 0
3205 set hp_aCC_compiler 0
3206 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
3207 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
3208 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
3209 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
3210 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
3211 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
3212 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
3214 # Log what happened.
3215 verbose -log "get_compiler_info: $compiler_info"
3217 # Most compilers will evaluate comparisons and other boolean
3218 # operations to 0 or 1.
3219 uplevel \#0 { set true 1 }
3220 uplevel \#0 { set false 0 }
3222 # Use of aCC results in boolean results being displayed as
3224 if { $hp_aCC_compiler } {
3225 uplevel \#0 { set true true }
3226 uplevel \#0 { set false false }
3232 # Return the compiler_info string if no arg is provided.
3233 # Otherwise the argument is a glob-style expression to match against
3236 proc test_compiler_info { {compiler ""} } {
3237 global compiler_info
3240 # If no arg, return the compiler_info string.
3241 if [string match "" $compiler] {
3242 return $compiler_info
3245 return [string match $compiler $compiler_info]
3248 proc current_target_name { } {
3250 if [info exists target_info(target,name)] {
3251 set answer $target_info(target,name)
3258 set gdb_wrapper_initialized 0
3259 set gdb_wrapper_target ""
3261 proc gdb_wrapper_init { args } {
3262 global gdb_wrapper_initialized
3263 global gdb_wrapper_file
3264 global gdb_wrapper_flags
3265 global gdb_wrapper_target
3267 if { $gdb_wrapper_initialized == 1 } { return; }
3269 if {[target_info exists needs_status_wrapper] && \
3270 [target_info needs_status_wrapper] != "0"} {
3271 set result [build_wrapper "testglue.o"]
3272 if { $result != "" } {
3273 set gdb_wrapper_file [lindex $result 0]
3274 set gdb_wrapper_flags [lindex $result 1]
3276 warning "Status wrapper failed to build."
3279 set gdb_wrapper_initialized 1
3280 set gdb_wrapper_target [current_target_name]
3283 # Some targets need to always link a special object in. Save its path here.
3284 global gdb_saved_set_unbuffered_mode_obj
3285 set gdb_saved_set_unbuffered_mode_obj ""
3287 proc gdb_compile {source dest type options} {
3288 global GDB_TESTCASE_OPTIONS
3289 global gdb_wrapper_file
3290 global gdb_wrapper_flags
3291 global gdb_wrapper_initialized
3294 global gdb_saved_set_unbuffered_mode_obj
3296 set outdir [file dirname $dest]
3298 # Add platform-specific options if a shared library was specified using
3299 # "shlib=librarypath" in OPTIONS.
3303 foreach opt $options {
3304 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3305 if [test_compiler_info "xlc-*"] {
3306 # IBM xlc compiler doesn't accept shared library named other
3307 # than .so: use "-Wl," to bypass this
3308 lappend source "-Wl,$shlib_name"
3309 } elseif { ([istarget "*-*-mingw*"]
3310 || [istarget *-*-cygwin*]
3311 || [istarget *-*-pe*])} {
3312 lappend source "${shlib_name}.a"
3314 lappend source $shlib_name
3316 if { $shlib_found == 0 } {
3318 if { ([istarget "*-*-mingw*"]
3319 || [istarget *-*-cygwin*]) } {
3320 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3322 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3323 # Undo debian's change in the default.
3324 # Put it at the front to not override any user-provided
3325 # value, and to make sure it appears in front of all the
3327 lappend new_options "early_flags=-Wl,--no-as-needed"
3330 } elseif { $opt == "shlib_load" } {
3333 lappend new_options $opt
3337 # We typically link to shared libraries using an absolute path, and
3338 # that's how they are found at runtime. If we are going to
3339 # dynamically load one by basename, we must specify rpath. If we
3340 # are using a remote host, DejaGNU will link to the shared library
3341 # using a relative path, so again we must specify an rpath.
3342 if { $shlib_load || ($shlib_found && [is_remote target]) } {
3343 if { ([istarget "*-*-mingw*"]
3344 || [istarget *-*-cygwin*]
3345 || [istarget *-*-pe*]
3346 || [istarget hppa*-*-hpux*])} {
3347 # Do not need anything.
3348 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3349 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3350 } elseif { [istarget arm*-*-symbianelf*] } {
3351 if { $shlib_load } {
3352 lappend new_options "libs=-ldl"
3355 if { $shlib_load } {
3356 lappend new_options "libs=-ldl"
3358 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3361 set options $new_options
3363 if [info exists GDB_TESTCASE_OPTIONS] {
3364 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3366 verbose "options are $options"
3367 verbose "source is $source $dest $type $options"
3369 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3371 if {[target_info exists needs_status_wrapper] && \
3372 [target_info needs_status_wrapper] != "0" && \
3373 [info exists gdb_wrapper_file]} {
3374 lappend options "libs=${gdb_wrapper_file}"
3375 lappend options "ldflags=${gdb_wrapper_flags}"
3378 # Replace the "nowarnings" option with the appropriate additional_flags
3379 # to disable compiler warnings.
3380 set nowarnings [lsearch -exact $options nowarnings]
3381 if {$nowarnings != -1} {
3382 if [target_info exists gdb,nowarnings_flag] {
3383 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3385 set flag "additional_flags=-w"
3387 set options [lreplace $options $nowarnings $nowarnings $flag]
3390 if { $type == "executable" } {
3391 if { ([istarget "*-*-mingw*"]
3392 || [istarget "*-*-*djgpp"]
3393 || [istarget "*-*-cygwin*"])} {
3394 # Force output to unbuffered mode, by linking in an object file
3395 # with a global contructor that calls setvbuf.
3397 # Compile the special object seperatelly for two reasons:
3398 # 1) Insulate it from $options.
3399 # 2) Avoid compiling it for every gdb_compile invocation,
3400 # which is time consuming, especially if we're remote
3403 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3404 verbose "compiling gdb_saved_set_unbuffered_obj"
3405 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3406 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3408 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3409 if { $result != "" } {
3412 if {[is_remote host]} {
3413 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3415 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3417 # Link a copy of the output object, because the
3418 # original may be automatically deleted.
3419 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3421 verbose "gdb_saved_set_unbuffered_obj already compiled"
3424 # Rely on the internal knowledge that the global ctors are ran in
3425 # reverse link order. In that case, we can use ldflags to
3426 # avoid copying the object file to the host multiple
3428 # This object can only be added if standard libraries are
3429 # used. Thus, we need to disable it if -nostdlib option is used
3430 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3431 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3436 set result [target_compile $source $dest $type $options]
3438 # Prune uninteresting compiler (and linker) output.
3439 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3441 regsub "\[\r\n\]*$" "$result" "" result
3442 regsub "^\[\r\n\]*" "$result" "" result
3444 if {[lsearch $options quiet] < 0} {
3445 # We shall update this on a per language basis, to avoid
3446 # changing the entire testsuite in one go.
3447 if {[lsearch $options f77] >= 0} {
3448 gdb_compile_test $source $result
3449 } elseif { $result != "" } {
3450 clone_output "gdb compile failed, $result"
3457 # This is just like gdb_compile, above, except that it tries compiling
3458 # against several different thread libraries, to see which one this
3460 proc gdb_compile_pthreads {source dest type options} {
3462 set why_msg "unrecognized error"
3463 foreach lib {-lpthreads -lpthread -lthread ""} {
3464 # This kind of wipes out whatever libs the caller may have
3465 # set. Or maybe theirs will override ours. How infelicitous.
3466 set options_with_lib [concat $options [list libs=$lib quiet]]
3467 set ccout [gdb_compile $source $dest $type $options_with_lib]
3468 switch -regexp -- $ccout {
3469 ".*no posix threads support.*" {
3470 set why_msg "missing threads include file"
3473 ".*cannot open -lpthread.*" {
3474 set why_msg "missing runtime threads library"
3476 ".*Can't find library for -lpthread.*" {
3477 set why_msg "missing runtime threads library"
3480 pass "successfully compiled posix threads test case"
3486 if {!$built_binfile} {
3487 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3492 # Build a shared library from SOURCES.
3494 proc gdb_compile_shlib {sources dest options} {
3495 set obj_options $options
3498 if { [lsearch -exact $options "c++"] >= 0 } {
3499 set info_options "c++"
3501 if [get_compiler_info ${info_options}] {
3505 switch -glob [test_compiler_info] {
3507 lappend obj_options "additional_flags=-qpic"
3510 if { !([istarget "*-*-cygwin*"]
3511 || [istarget "*-*-mingw*"]) } {
3512 lappend obj_options "additional_flags=-fpic"
3516 if { !([istarget "powerpc*-*-aix*"]
3517 || [istarget "rs6000*-*-aix*"]
3518 || [istarget "*-*-cygwin*"]
3519 || [istarget "*-*-mingw*"]
3520 || [istarget "*-*-pe*"]) } {
3521 lappend obj_options "additional_flags=-fpic"
3525 switch -glob [istarget] {
3527 lappend obj_options "additional_flags=+z"
3530 # don't know what the compiler is...
3536 set outdir [file dirname $dest]
3538 foreach source $sources {
3539 set sourcebase [file tail $source]
3540 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3543 lappend objects ${outdir}/${sourcebase}.o
3546 if [istarget "hppa*-*-hpux*"] {
3547 remote_exec build "ld -b ${objects} -o ${dest}"
3549 set link_options $options
3550 if [test_compiler_info "xlc-*"] {
3551 lappend link_options "additional_flags=-qmkshrobj"
3553 lappend link_options "additional_flags=-shared"
3555 if { ([istarget "*-*-mingw*"]
3556 || [istarget *-*-cygwin*]
3557 || [istarget *-*-pe*]) } {
3558 if { [is_remote host] } {
3559 set name [file tail ${dest}]
3563 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3564 } elseif [is_remote target] {
3565 # By default, we do not set the soname. This causes the linker
3566 # on ELF systems to create a DT_NEEDED entry in the executable
3567 # refering to the full path name of the library. This is a
3568 # problem in remote testing if the library is in a different
3569 # directory there. To fix this, we set a soname of just the
3570 # base filename for the library, and add an appropriate -rpath
3571 # to the main executable (in gdb_compile).
3572 set destbase [file tail $dest]
3573 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3576 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3579 if { [is_remote host]
3580 && ([istarget "*-*-mingw*"]
3581 || [istarget *-*-cygwin*]
3582 || [istarget *-*-pe*]) } {
3583 set dest_tail_name [file tail ${dest}]
3584 remote_upload host $dest_tail_name.a ${dest}.a
3585 remote_file host delete $dest_tail_name.a
3591 # This is just like gdb_compile_shlib, above, except that it tries compiling
3592 # against several different thread libraries, to see which one this
3594 proc gdb_compile_shlib_pthreads {sources dest options} {
3596 set why_msg "unrecognized error"
3597 foreach lib {-lpthreads -lpthread -lthread ""} {
3598 # This kind of wipes out whatever libs the caller may have
3599 # set. Or maybe theirs will override ours. How infelicitous.
3600 set options_with_lib [concat $options [list libs=$lib quiet]]
3601 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3602 switch -regexp -- $ccout {
3603 ".*no posix threads support.*" {
3604 set why_msg "missing threads include file"
3607 ".*cannot open -lpthread.*" {
3608 set why_msg "missing runtime threads library"
3610 ".*Can't find library for -lpthread.*" {
3611 set why_msg "missing runtime threads library"
3614 pass "successfully compiled posix threads test case"
3620 if {!$built_binfile} {
3621 unsupported "Couldn't compile $sources: ${why_msg}"
3626 # This is just like gdb_compile_pthreads, above, except that we always add the
3627 # objc library for compiling Objective-C programs
3628 proc gdb_compile_objc {source dest type options} {
3630 set why_msg "unrecognized error"
3631 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3632 # This kind of wipes out whatever libs the caller may have
3633 # set. Or maybe theirs will override ours. How infelicitous.
3634 if { $lib == "solaris" } {
3635 set lib "-lpthread -lposix4"
3637 if { $lib != "-lobjc" } {
3638 set lib "-lobjc $lib"
3640 set options_with_lib [concat $options [list libs=$lib quiet]]
3641 set ccout [gdb_compile $source $dest $type $options_with_lib]
3642 switch -regexp -- $ccout {
3643 ".*no posix threads support.*" {
3644 set why_msg "missing threads include file"
3647 ".*cannot open -lpthread.*" {
3648 set why_msg "missing runtime threads library"
3650 ".*Can't find library for -lpthread.*" {
3651 set why_msg "missing runtime threads library"
3654 pass "successfully compiled objc with posix threads test case"
3660 if {!$built_binfile} {
3661 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3666 proc send_gdb { string } {
3667 global suppress_flag
3668 if { $suppress_flag } {
3671 return [remote_send host "$string"]
3674 # Send STRING to the inferior's terminal.
3676 proc send_inferior { string } {
3677 global inferior_spawn_id
3679 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3689 proc gdb_expect { args } {
3690 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3691 set atimeout [lindex $args 0]
3692 set expcode [list [lindex $args 1]]
3697 # A timeout argument takes precedence, otherwise of all the timeouts
3698 # select the largest.
3699 if [info exists atimeout] {
3702 set tmt [get_largest_timeout]
3705 global suppress_flag
3706 global remote_suppress_flag
3707 if [info exists remote_suppress_flag] {
3708 set old_val $remote_suppress_flag
3710 if [info exists suppress_flag] {
3711 if { $suppress_flag } {
3712 set remote_suppress_flag 1
3716 {uplevel remote_expect host $tmt $expcode} string]
3717 if [info exists old_val] {
3718 set remote_suppress_flag $old_val
3720 if [info exists remote_suppress_flag] {
3721 unset remote_suppress_flag
3726 global errorInfo errorCode
3728 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3730 return -code $code $string
3734 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3736 # Check for long sequence of output by parts.
3737 # TEST: is the test message to be printed with the test success/fail.
3738 # SENTINEL: Is the terminal pattern indicating that output has finished.
3739 # LIST: is the sequence of outputs to match.
3740 # If the sentinel is recognized early, it is considered an error.
3743 # 1 if the test failed,
3744 # 0 if the test passes,
3745 # -1 if there was an internal error.
3747 proc gdb_expect_list {test sentinel list} {
3749 global suppress_flag
3752 if { $suppress_flag } {
3754 unresolved "${test}"
3756 while { ${index} < [llength ${list}] } {
3757 set pattern [lindex ${list} ${index}]
3758 set index [expr ${index} + 1]
3759 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3760 if { ${index} == [llength ${list}] } {
3763 -re "${pattern}${sentinel}" {
3764 # pass "${test}, pattern ${index} + sentinel"
3767 fail "${test} (pattern ${index} + sentinel)"
3770 -re ".*A problem internal to GDB has been detected" {
3771 fail "${test} (GDB internal error)"
3773 gdb_internal_error_resync
3776 fail "${test} (pattern ${index} + sentinel) (timeout)"
3781 # unresolved "${test}, pattern ${index} + sentinel"
3787 # pass "${test}, pattern ${index}"
3790 fail "${test} (pattern ${index})"
3793 -re ".*A problem internal to GDB has been detected" {
3794 fail "${test} (GDB internal error)"
3796 gdb_internal_error_resync
3799 fail "${test} (pattern ${index}) (timeout)"
3804 # unresolved "${test}, pattern ${index}"
3818 proc gdb_suppress_entire_file { reason } {
3819 global suppress_flag
3822 set suppress_flag -1
3826 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3827 # gdb_expect to fail immediately (until the next call to
3828 # gdb_stop_suppressing_tests).
3830 proc gdb_suppress_tests { args } {
3831 global suppress_flag
3833 return; # fnf - disable pending review of results where
3834 # testsuite ran better without this
3837 if { $suppress_flag == 1 } {
3838 if { [llength $args] > 0 } {
3839 warning "[lindex $args 0]\n"
3841 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3847 # Clear suppress_flag.
3849 proc gdb_stop_suppressing_tests { } {
3850 global suppress_flag
3852 if [info exists suppress_flag] {
3853 if { $suppress_flag > 0 } {
3855 clone_output "Tests restarted.\n"
3862 proc gdb_clear_suppressed { } {
3863 global suppress_flag
3868 # Spawn the gdb process.
3870 # This doesn't expect any output or do any other initialization,
3871 # leaving those to the caller.
3873 # Overridable function -- you can override this function in your
3876 proc gdb_spawn { } {
3880 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3882 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3885 set saved_gdbflags $GDBFLAGS
3887 if {$GDBFLAGS != ""} {
3890 append GDBFLAGS $cmdline_flags
3894 set GDBFLAGS $saved_gdbflags
3899 # Start gdb running, wait for prompt, and disable the pagers.
3901 # Overridable function -- you can override this function in your
3904 proc gdb_start { } {
3909 catch default_gdb_exit
3912 # Return true if we can spawn a program on the target and attach to
3915 proc can_spawn_for_attach { } {
3916 # We use exp_pid to get the inferior's pid, assuming that gives
3917 # back the pid of the program. On remote boards, that would give
3918 # us instead the PID of e.g., the ssh client, etc.
3919 if [is_remote target] then {
3923 # The "attach" command doesn't make sense when the target is
3924 # stub-like, where GDB finds the program already started on
3925 # initial connection.
3926 if {[target_info exists use_gdb_stub]} {
3934 # Kill a progress previously started with spawn_wait_for_attach, and
3935 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
3938 proc kill_wait_spawned_process { proc_spawn_id } {
3939 set pid [exp_pid -i $proc_spawn_id]
3941 verbose -log "killing ${pid}"
3942 remote_exec build "kill -9 ${pid}"
3944 verbose -log "closing ${proc_spawn_id}"
3945 catch "close -i $proc_spawn_id"
3946 verbose -log "waiting for ${proc_spawn_id}"
3948 # If somehow GDB ends up still attached to the process here, a
3949 # blocking wait hangs until gdb is killed (or until gdb / the
3950 # ptracer reaps the exit status too, but that won't happen because
3951 # something went wrong.) Passing -nowait makes expect tell Tcl to
3952 # wait for the PID in the background. That's fine because we
3953 # don't care about the exit status. */
3954 wait -nowait -i $proc_spawn_id
3957 # Returns the process id corresponding to the given spawn id.
3959 proc spawn_id_get_pid { spawn_id } {
3960 set testpid [exp_pid -i $spawn_id]
3962 if { [istarget "*-*-cygwin*"] } {
3963 # testpid is the Cygwin PID, GDB uses the Windows PID, which
3964 # might be different due to the way fork/exec works.
3965 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
3971 # Start a set of programs running and then wait for a bit, to be sure
3972 # that they can be attached to. Return a list of processes spawn IDs,
3973 # one element for each process spawned. It's a test error to call
3974 # this when [can_spawn_for_attach] is false.
3976 proc spawn_wait_for_attach { executable_list } {
3977 set spawn_id_list {}
3979 if ![can_spawn_for_attach] {
3980 # The caller should have checked can_spawn_for_attach itself
3981 # before getting here.
3982 error "can't spawn for attach with this target/board"
3985 foreach {executable} $executable_list {
3986 # Note we use Expect's spawn, not Tcl's exec, because with
3987 # spawn we control when to wait for/reap the process. That
3988 # allows killing the process by PID without being subject to
3990 lappend spawn_id_list [remote_spawn target $executable]
3995 return $spawn_id_list
3999 # gdb_load_cmd -- load a file into the debugger.
4000 # ARGS - additional args to load command.
4001 # return a -1 if anything goes wrong.
4003 proc gdb_load_cmd { args } {
4006 if [target_info exists gdb_load_timeout] {
4007 set loadtimeout [target_info gdb_load_timeout]
4009 set loadtimeout 1600
4011 send_gdb "load $args\n"
4012 verbose "Timeout is now $loadtimeout seconds" 2
4013 gdb_expect $loadtimeout {
4014 -re "Loading section\[^\r\]*\r\n" {
4017 -re "Start address\[\r\]*\r\n" {
4020 -re "Transfer rate\[\r\]*\r\n" {
4023 -re "Memory access error\[^\r\]*\r\n" {
4024 perror "Failed to load program"
4027 -re "$gdb_prompt $" {
4030 -re "(.*)\r\n$gdb_prompt " {
4031 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4035 perror "Timed out trying to load $args."
4042 # Invoke "gcore". CORE is the name of the core file to write. TEST
4043 # is the name of the test case. This will return 1 if the core file
4044 # was created, 0 otherwise. If this fails to make a core file because
4045 # this configuration of gdb does not support making core files, it
4046 # will call "unsupported", not "fail". However, if this fails to make
4047 # a core file for some other reason, then it will call "fail".
4049 proc gdb_gcore_cmd {core test} {
4053 gdb_test_multiple "gcore $core" $test {
4054 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4058 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4066 # Load core file CORE. TEST is the name of the test case.
4067 # This will record a pass/fail for loading the core file.
4069 # 1 - core file is successfully loaded
4070 # 0 - core file loaded but has a non fatal error
4071 # -1 - core file failed to load
4073 proc gdb_core_cmd { core test } {
4076 gdb_test_multiple "core $core" "$test" {
4077 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4080 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4081 fail "$test (bad file format)"
4084 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4085 fail "$test (file not found)"
4088 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4089 fail "$test (incomplete note section)"
4092 -re "Core was generated by .*\r\n$gdb_prompt $" {
4096 -re ".*$gdb_prompt $" {
4101 fail "$test (timeout)"
4105 fail "unsupported output from 'core' command"
4109 # Return the filename to download to the target and load on the target
4110 # for this shared library. Normally just LIBNAME, unless shared libraries
4111 # for this target have separate link and load images.
4113 proc shlib_target_file { libname } {
4117 # Return the filename GDB will load symbols from when debugging this
4118 # shared library. Normally just LIBNAME, unless shared libraries for
4119 # this target have separate link and load images.
4121 proc shlib_symbol_file { libname } {
4125 # Return the filename to download to the target and load for this
4126 # executable. Normally just BINFILE unless it is renamed to something
4127 # else for this target.
4129 proc exec_target_file { binfile } {
4133 # Return the filename GDB will load symbols from when debugging this
4134 # executable. Normally just BINFILE unless executables for this target
4135 # have separate files for symbols.
4137 proc exec_symbol_file { binfile } {
4141 # Rename the executable file. Normally this is just BINFILE1 being renamed
4142 # to BINFILE2, but some targets require multiple binary files.
4143 proc gdb_rename_execfile { binfile1 binfile2 } {
4144 file rename -force [exec_target_file ${binfile1}] \
4145 [exec_target_file ${binfile2}]
4146 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4147 file rename -force [exec_symbol_file ${binfile1}] \
4148 [exec_symbol_file ${binfile2}]
4152 # "Touch" the executable file to update the date. Normally this is just
4153 # BINFILE, but some targets require multiple files.
4154 proc gdb_touch_execfile { binfile } {
4155 set time [clock seconds]
4156 file mtime [exec_target_file ${binfile}] $time
4157 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4158 file mtime [exec_symbol_file ${binfile}] $time
4162 # Like remote_download but provides a gdb-specific behavior. If DEST
4163 # is "host", and the host is not remote, and TOFILE is not specified,
4164 # then the [file tail] of FROMFILE is passed through
4165 # standard_output_file to compute the destination.
4167 proc gdb_remote_download {dest fromfile {tofile {}}} {
4168 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
4169 set tofile [standard_output_file [file tail $fromfile]]
4172 if { $tofile == "" } {
4173 return [remote_download $dest $fromfile]
4175 return [remote_download $dest $fromfile $tofile]
4181 # Copy a file to the remote target and return its target filename.
4182 # Schedule the file to be deleted at the end of this test.
4184 proc gdb_download { filename } {
4187 set destname [remote_download target $filename]
4188 lappend cleanfiles $destname
4192 # gdb_load_shlibs LIB...
4194 # Copy the listed libraries to the target.
4196 proc gdb_load_shlibs { args } {
4197 if {![is_remote target]} {
4201 foreach file $args {
4202 gdb_download [shlib_target_file $file]
4205 # Even if the target supplies full paths for shared libraries,
4206 # they may not be paths for this system.
4207 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
4211 # gdb_load -- load a file into the debugger. Specifying no file
4212 # defaults to the executable currently being debugged.
4213 # The return value is 0 for success, -1 for failure.
4214 # Many files in config/*.exp override this procedure.
4216 proc gdb_load { arg } {
4218 return [gdb_file_cmd $arg]
4223 # gdb_reload -- load a file into the target. Called before "running",
4224 # either the first time or after already starting the program once,
4225 # for remote targets. Most files that override gdb_load should now
4226 # override this instead.
4228 proc gdb_reload { } {
4229 # For the benefit of existing configurations, default to gdb_load.
4230 # Specifying no file defaults to the executable currently being
4232 return [gdb_load ""]
4235 proc gdb_continue { function } {
4238 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4241 proc default_gdb_init { test_file_name } {
4242 global gdb_wrapper_initialized
4243 global gdb_wrapper_target
4244 global gdb_test_file_name
4250 gdb_clear_suppressed
4252 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4254 # Make sure that the wrapper is rebuilt
4255 # with the appropriate multilib option.
4256 if { $gdb_wrapper_target != [current_target_name] } {
4257 set gdb_wrapper_initialized 0
4260 # Unlike most tests, we have a small number of tests that generate
4261 # a very large amount of output. We therefore increase the expect
4262 # buffer size to be able to contain the entire test output. This
4263 # is especially needed by gdb.base/info-macros.exp.
4265 # Also set this value for the currently running GDB.
4266 match_max [match_max -d]
4268 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4269 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4272 if [target_info exists gdb_prompt] {
4273 set gdb_prompt [target_info gdb_prompt]
4275 set gdb_prompt "\\(gdb\\)"
4278 if [info exists use_gdb_stub] {
4283 # Return a path using GDB_PARALLEL.
4284 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4285 # GDB_PARALLEL must be defined, the caller must check.
4287 # The default value for GDB_PARALLEL is, canonically, ".".
4288 # The catch is that tests don't expect an additional "./" in file paths so
4289 # omit any directory for the default case.
4290 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4291 # its special handling.
4293 proc make_gdb_parallel_path { args } {
4294 global GDB_PARALLEL objdir
4295 set joiner [list "file" "join" $objdir]
4296 if { $GDB_PARALLEL != "yes" } {
4297 lappend joiner $GDB_PARALLEL
4299 set joiner [concat $joiner $args]
4300 return [eval $joiner]
4303 # Turn BASENAME into a full file name in the standard output
4304 # directory. It is ok if BASENAME is the empty string; in this case
4305 # the directory is returned.
4307 proc standard_output_file {basename} {
4308 global objdir subdir gdb_test_file_name GDB_PARALLEL
4310 if {[info exists GDB_PARALLEL]} {
4311 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4313 return [file join $dir $basename]
4315 return [file join $objdir $subdir $basename]
4319 # Return the name of a file in our standard temporary directory.
4321 proc standard_temp_file {basename} {
4322 global objdir GDB_PARALLEL
4324 if {[info exists GDB_PARALLEL]} {
4325 return [make_gdb_parallel_path temp $basename]
4331 # Set 'testfile', 'srcfile', and 'binfile'.
4333 # ARGS is a list of source file specifications.
4334 # Without any arguments, the .exp file's base name is used to
4335 # compute the source file name. The ".c" extension is added in this case.
4336 # If ARGS is not empty, each entry is a source file specification.
4337 # If the specification starts with a ".", it is treated as a suffix
4338 # to append to the .exp file's base name.
4339 # If the specification is the empty string, it is treated as if it
4341 # Otherwise it is a file name.
4342 # The first file in the list is used to set the 'srcfile' global.
4343 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4345 # Most tests should call this without arguments.
4347 # If a completely different binary file name is needed, then it
4348 # should be handled in the .exp file with a suitable comment.
4350 proc standard_testfile {args} {
4351 global gdb_test_file_name
4353 global gdb_test_file_last_vars
4356 global testfile binfile
4358 set testfile $gdb_test_file_name
4359 set binfile [standard_output_file ${testfile}]
4361 if {[llength $args] == 0} {
4365 # Unset our previous output variables.
4366 # This can help catch hidden bugs.
4367 if {[info exists gdb_test_file_last_vars]} {
4368 foreach varname $gdb_test_file_last_vars {
4370 catch {unset $varname}
4373 # 'executable' is often set by tests.
4374 set gdb_test_file_last_vars {executable}
4378 set varname srcfile$suffix
4381 # Handle an extension.
4384 } elseif {[string range $arg 0 0] == "."} {
4385 set arg $testfile$arg
4389 lappend gdb_test_file_last_vars $varname
4391 if {$suffix == ""} {
4399 # The default timeout used when testing GDB commands. We want to use
4400 # the same timeout as the default dejagnu timeout, unless the user has
4401 # already provided a specific value (probably through a site.exp file).
4402 global gdb_test_timeout
4403 if ![info exists gdb_test_timeout] {
4404 set gdb_test_timeout $timeout
4407 # A list of global variables that GDB testcases should not use.
4408 # We try to prevent their use by monitoring write accesses and raising
4409 # an error when that happens.
4410 set banned_variables { bug_id prms_id }
4412 # A list of procedures that GDB testcases should not use.
4413 # We try to prevent their use by monitoring invocations and raising
4414 # an error when that happens.
4415 set banned_procedures { strace }
4417 # gdb_init is called by runtest at start, but also by several
4418 # tests directly; gdb_finish is only called from within runtest after
4419 # each test source execution.
4420 # Placing several traces by repetitive calls to gdb_init leads
4421 # to problems, as only one trace is removed in gdb_finish.
4422 # To overcome this possible problem, we add a variable that records
4423 # if the banned variables and procedures are already traced.
4426 proc gdb_init { test_file_name } {
4427 # Reset the timeout value to the default. This way, any testcase
4428 # that changes the timeout value without resetting it cannot affect
4429 # the timeout used in subsequent testcases.
4430 global gdb_test_timeout
4432 set timeout $gdb_test_timeout
4434 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4435 && [target_info exists gdb_reverse_timeout] } {
4436 set timeout [target_info gdb_reverse_timeout]
4439 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4440 # debugging tool to help confirm that the test suite is
4441 # parallel-safe. You need "inotifywait" from the
4442 # inotify-tools package to use this.
4443 global GDB_INOTIFY inotify_pid
4444 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4445 global outdir tool inotify_log_file
4447 set exclusions {outputs temp gdb[.](log|sum) cache}
4448 set exclusion_re ([join $exclusions |])
4450 set inotify_log_file [standard_temp_file inotify.out]
4451 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4452 --exclude $exclusion_re \
4453 |& tee -a $outdir/$tool.log $inotify_log_file &]
4455 # Wait for the watches; hopefully this is long enough.
4458 # Clear the log so that we don't emit a warning the first time
4460 set fd [open $inotify_log_file w]
4464 # Block writes to all banned variables, and invocation of all
4465 # banned procedures...
4466 global banned_variables
4467 global banned_procedures
4468 global banned_traced
4469 if (!$banned_traced) {
4470 foreach banned_var $banned_variables {
4471 global "$banned_var"
4472 trace add variable "$banned_var" write error
4474 foreach banned_proc $banned_procedures {
4475 global "$banned_proc"
4476 trace add execution "$banned_proc" enter error
4481 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4482 # messages as expected.
4487 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4488 # the test results. Even if /dev/null doesn't exist on the particular
4489 # platform, the readline library will use the default setting just by
4490 # failing to open the file. OTOH, opening /dev/null successfully will
4491 # also result in the default settings being used since nothing will be
4492 # read from this file.
4493 setenv INPUTRC "/dev/null"
4495 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4496 # bindings, so make sure that an appropriate terminal is selected.
4497 # The same bug doesn't show up if we use ^P / ^N instead.
4500 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4501 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4502 # especially having color output turned on can cause tests to fail.
4503 setenv GREP_OPTIONS ""
4505 # Clear $gdbserver_reconnect_p.
4506 global gdbserver_reconnect_p
4507 set gdbserver_reconnect_p 1
4508 unset gdbserver_reconnect_p
4510 return [default_gdb_init $test_file_name]
4513 proc gdb_finish { } {
4514 global gdbserver_reconnect_p
4518 # Exit first, so that the files are no longer in use.
4521 if { [llength $cleanfiles] > 0 } {
4522 eval remote_file target delete $cleanfiles
4526 # Unblock write access to the banned variables. Dejagnu typically
4527 # resets some of them between testcases.
4528 global banned_variables
4529 global banned_procedures
4530 global banned_traced
4531 if ($banned_traced) {
4532 foreach banned_var $banned_variables {
4533 global "$banned_var"
4534 trace remove variable "$banned_var" write error
4536 foreach banned_proc $banned_procedures {
4537 global "$banned_proc"
4538 trace remove execution "$banned_proc" enter error
4545 set debug_format "unknown"
4547 # Run the gdb command "info source" and extract the debugging format
4548 # information from the output and save it in debug_format.
4550 proc get_debug_format { } {
4556 set debug_format "unknown"
4557 send_gdb "info source\n"
4559 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4560 set debug_format $expect_out(1,string)
4561 verbose "debug format is $debug_format"
4564 -re "No current source file.\r\n$gdb_prompt $" {
4565 perror "get_debug_format used when no current source file"
4568 -re "$gdb_prompt $" {
4569 warning "couldn't check debug format (no valid response)."
4573 warning "couldn't check debug format (timeout)."
4579 # Return true if FORMAT matches the debug format the current test was
4580 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4581 # `*', `[...]', and so on.
4583 # This function depends on variables set by `get_debug_format', above.
4585 proc test_debug_format {format} {
4588 return [expr [string match $format $debug_format] != 0]
4591 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4592 # COFF, stabs, etc). If that format matches the format that the
4593 # current test was compiled with, then the next test is expected to
4594 # fail for any target. Returns 1 if the next test or set of tests is
4595 # expected to fail, 0 otherwise (or if it is unknown). Must have
4596 # previously called get_debug_format.
4597 proc setup_xfail_format { format } {
4598 set ret [test_debug_format $format]
4606 # gdb_get_line_number TEXT [FILE]
4608 # Search the source file FILE, and return the line number of the
4609 # first line containing TEXT. If no match is found, an error is thrown.
4611 # TEXT is a string literal, not a regular expression.
4613 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4614 # specified, and does not start with "/", then it is assumed to be in
4615 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4616 # by changing the callers and the interface at the same time.
4617 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4618 # gdb.base/ena-dis-br.exp.
4620 # Use this function to keep your test scripts independent of the
4621 # exact line numbering of the source file. Don't write:
4623 # send_gdb "break 20"
4625 # This means that if anyone ever edits your test's source file,
4626 # your test could break. Instead, put a comment like this on the
4627 # source file line you want to break at:
4629 # /* breakpoint spot: frotz.exp: test name */
4631 # and then write, in your test script (which we assume is named
4634 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4636 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4639 # % puts "foo [lindex "bar baz" 1]"
4642 # Tcl is quite clever, for a little stringy language.)
4646 # The previous implementation of this procedure used the gdb search command.
4647 # This version is different:
4649 # . It works with MI, and it also works when gdb is not running.
4651 # . It operates on the build machine, not the host machine.
4653 # . For now, this implementation fakes a current directory of
4654 # $srcdir/$subdir to be compatible with the old implementation.
4655 # This will go away eventually and some callers will need to
4658 # . The TEXT argument is literal text and matches literally,
4659 # not a regular expression as it was before.
4661 # . State changes in gdb, such as changing the current file
4662 # and setting $_, no longer happen.
4664 # After a bit of time we can forget about the differences from the
4665 # old implementation.
4667 # --chastain 2004-08-05
4669 proc gdb_get_line_number { text { file "" } } {
4674 if { "$file" == "" } then {
4677 if { ! [regexp "^/" "$file"] } then {
4678 set file "$srcdir/$subdir/$file"
4681 if { [ catch { set fd [open "$file"] } message ] } then {
4686 for { set line 1 } { 1 } { incr line } {
4687 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4690 if { $nchar < 0 } then {
4693 if { [string first "$text" "$body"] >= 0 } then {
4699 if { [ catch { close "$fd" } message ] } then {
4704 error "undefined tag \"$text\""
4710 # Continue the program until it ends.
4712 # MSSG is the error message that gets printed. If not given, a
4714 # COMMAND is the command to invoke. If not given, "continue" is
4716 # ALLOW_EXTRA is a flag indicating whether the test should expect
4717 # extra output between the "Continuing." line and the program
4718 # exiting. By default it is zero; if nonzero, any extra output
4721 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4722 global inferior_exited_re use_gdb_stub
4725 set text "continue until exit"
4727 set text "continue until exit at $mssg"
4735 # By default, we don't rely on exit() behavior of remote stubs --
4736 # it's common for exit() to be implemented as a simple infinite
4737 # loop, or a forced crash/reset. For native targets, by default, we
4738 # assume process exit is reported as such. If a non-reliable target
4739 # is used, we set a breakpoint at exit, and continue to that.
4740 if { [target_info exists exit_is_reliable] } {
4741 set exit_is_reliable [target_info exit_is_reliable]
4743 set exit_is_reliable [expr ! $use_gdb_stub]
4746 if { ! $exit_is_reliable } {
4747 if {![gdb_breakpoint "exit"]} {
4750 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4753 # Continue until we exit. Should not stop again.
4754 # Don't bother to check the output of the program, that may be
4755 # extremely tough for some remote systems.
4757 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4762 proc rerun_to_main {} {
4763 global gdb_prompt use_gdb_stub
4768 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4769 {pass "rerun to main" ; return 0}
4770 -re "$gdb_prompt $"\
4771 {fail "rerun to main" ; return 0}
4772 timeout {fail "(timeout) rerun to main" ; return 0}
4777 -re "The program .* has been started already.*y or n. $" {
4781 -re "Starting program.*$gdb_prompt $"\
4782 {pass "rerun to main" ; return 0}
4783 -re "$gdb_prompt $"\
4784 {fail "rerun to main" ; return 0}
4785 timeout {fail "(timeout) rerun to main" ; return 0}
4790 # Print a message and return true if a test should be skipped
4791 # due to lack of floating point suport.
4793 proc gdb_skip_float_test { msg } {
4794 if [target_info exists gdb,skip_float_tests] {
4795 verbose "Skipping test '$msg': no float tests."
4801 # Print a message and return true if a test should be skipped
4802 # due to lack of stdio support.
4804 proc gdb_skip_stdio_test { msg } {
4805 if [target_info exists gdb,noinferiorio] {
4806 verbose "Skipping test '$msg': no inferior i/o."
4812 proc gdb_skip_bogus_test { msg } {
4816 # Return true if a test should be skipped due to lack of XML support
4818 # NOTE: This must be called while gdb is *not* running.
4820 gdb_caching_proc gdb_skip_xml_test {
4824 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4828 gdb_test_multiple "set tdesc filename $xml_file" "" {
4829 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4832 -re ".*$gdb_prompt $" { }
4838 # Return true if argv[0] is available.
4840 gdb_caching_proc gdb_has_argv0 {
4843 # Set up, compile, and execute a test program to check whether
4844 # argv[0] is available.
4845 set src [standard_temp_file has_argv0[pid].c]
4846 set exe [standard_temp_file has_argv0[pid].x]
4848 gdb_produce_source $src {
4849 int main (int argc, char **argv) {
4854 gdb_compile $src $exe executable {debug}
4857 proc gdb_has_argv0_1 { exe } {
4858 global srcdir subdir
4859 global gdb_prompt hex
4863 gdb_reinitialize_dir $srcdir/$subdir
4866 # Set breakpoint on main.
4867 gdb_test_multiple "break main" "break main" {
4868 -re "Breakpoint.*${gdb_prompt} $" {
4870 -re "${gdb_prompt} $" {
4877 gdb_test_multiple "" "run to main" {
4878 -re "Breakpoint.*${gdb_prompt} $" {
4880 -re "${gdb_prompt} $" {
4885 # Check whether argc is 1.
4886 gdb_test_multiple "p argc" "p argc" {
4887 -re " = 1\r\n${gdb_prompt} $" {
4889 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4890 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4893 -re "${gdb_prompt} $" {
4898 -re "${gdb_prompt} $" {
4905 set result [gdb_has_argv0_1 $exe]
4912 && ([istarget *-*-linux*]
4913 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4914 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4915 || [istarget *-*-openbsd*]
4916 || [istarget *-*-darwin*]
4917 || [istarget *-*-solaris*]
4918 || [istarget *-*-aix*]
4919 || [istarget *-*-gnu*]
4920 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
4921 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
4922 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
4923 || [istarget *-*-symbianelf*]
4924 || [istarget *-*-osf*]
4925 || [istarget *-*-hpux*]
4926 || [istarget *-*-dicos*]
4927 || [istarget *-*-nto*]
4928 || [istarget *-*-*vms*]
4929 || [istarget *-*-lynx*178]) } {
4930 fail "argv\[0\] should be available on this target"
4936 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
4937 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4938 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
4939 # the name of a debuginfo only file. This file will be stored in the same
4942 # Functions for separate debug info testing
4944 # starting with an executable:
4945 # foo --> original executable
4947 # at the end of the process we have:
4948 # foo.stripped --> foo w/o debug info
4949 # foo.debug --> foo's debug info
4950 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4952 # Fetch the build id from the file.
4953 # Returns "" if there is none.
4955 proc get_build_id { filename } {
4956 if { ([istarget "*-*-mingw*"]
4957 || [istarget *-*-cygwin*]) } {
4958 set objdump_program [gdb_find_objdump]
4959 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
4960 verbose "result is $result"
4961 verbose "output is $output"
4967 set tmp [standard_output_file "${filename}-tmp"]
4968 set objcopy_program [gdb_find_objcopy]
4969 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
4970 verbose "result is $result"
4971 verbose "output is $output"
4976 fconfigure $fi -translation binary
4977 # Skip the NOTE header.
4982 if ![string compare $data ""] then {
4985 # Convert it to hex.
4986 binary scan $data H* data
4991 # Return the build-id hex string (usually 160 bits as 40 hex characters)
4992 # converted to the form: .build-id/ab/cdef1234...89.debug
4993 # Return "" if no build-id found.
4994 proc build_id_debug_filename_get { filename } {
4995 set data [get_build_id $filename]
4996 if { $data == "" } {
4999 regsub {^..} $data {\0/} data
5000 return ".build-id/${data}.debug"
5003 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5004 # list of optional flags. The only currently supported flag is no-main,
5005 # which removes the symbol entry for main from the separate debug file.
5007 # Function returns zero on success. Function will return non-zero failure code
5008 # on some targets not supporting separate debug info (such as i386-msdos).
5010 proc gdb_gnu_strip_debug { dest args } {
5012 # Use the first separate debug info file location searched by GDB so the
5013 # run cannot be broken by some stale file searched with higher precedence.
5014 set debug_file "${dest}.debug"
5016 set strip_to_file_program [transform strip]
5017 set objcopy_program [gdb_find_objcopy]
5019 set debug_link [file tail $debug_file]
5020 set stripped_file "${dest}.stripped"
5022 # Get rid of the debug info, and store result in stripped_file
5023 # something like gdb/testsuite/gdb.base/blah.stripped.
5024 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5025 verbose "result is $result"
5026 verbose "output is $output"
5031 # Workaround PR binutils/10802:
5032 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5033 set perm [file attributes ${dest} -permissions]
5034 file attributes ${stripped_file} -permissions $perm
5036 # Get rid of everything but the debug info, and store result in debug_file
5037 # This will be in the .debug subdirectory, see above.
5038 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5039 verbose "result is $result"
5040 verbose "output is $output"
5045 # If no-main is passed, strip the symbol for main from the separate
5046 # file. This is to simulate the behavior of elfutils's eu-strip, which
5047 # leaves the symtab in the original file only. There's no way to get
5048 # objcopy or strip to remove the symbol table without also removing the
5049 # debugging sections, so this is as close as we can get.
5050 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5051 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5052 verbose "result is $result"
5053 verbose "output is $output"
5057 file delete "${debug_file}"
5058 file rename "${debug_file}-tmp" "${debug_file}"
5061 # Link the two previous output files together, adding the .gnu_debuglink
5062 # section to the stripped_file, containing a pointer to the debug_file,
5063 # save the new file in dest.
5064 # This will be the regular executable filename, in the usual location.
5065 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5066 verbose "result is $result"
5067 verbose "output is $output"
5072 # Workaround PR binutils/10802:
5073 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5074 set perm [file attributes ${stripped_file} -permissions]
5075 file attributes ${dest} -permissions $perm
5080 # Test the output of GDB_COMMAND matches the pattern obtained
5081 # by concatenating all elements of EXPECTED_LINES. This makes
5082 # it possible to split otherwise very long string into pieces.
5083 # If third argument is not empty, it's used as the name of the
5084 # test to be printed on pass/fail.
5085 proc help_test_raw { gdb_command expected_lines args } {
5086 set message $gdb_command
5087 if [llength $args]>0 then {
5088 set message [lindex $args 0]
5090 set expected_output [join $expected_lines ""]
5091 gdb_test "${gdb_command}" "${expected_output}" $message
5094 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5095 # are regular expressions that should match the beginning of output,
5096 # before the list of commands in that class. The presence of
5097 # command list and standard epilogue will be tested automatically.
5098 # Notice that the '[' and ']' characters don't need to be escaped for strings
5099 # wrapped in {} braces.
5100 proc test_class_help { command_class expected_initial_lines args } {
5102 "List of commands\:.*[\r\n]+"
5103 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5104 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5105 "Command name abbreviations are allowed if unambiguous\."
5107 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5109 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5112 # COMMAND_LIST should have either one element -- command to test, or
5113 # two elements -- abbreviated command to test, and full command the first
5114 # element is abbreviation of.
5115 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5116 # are regular expressions that should match the beginning of output,
5117 # before the list of subcommands. The presence of
5118 # subcommand list and standard epilogue will be tested automatically.
5119 proc test_prefix_command_help { command_list expected_initial_lines args } {
5120 set command [lindex $command_list 0]
5121 if {[llength $command_list]>1} {
5122 set full_command [lindex $command_list 1]
5124 set full_command $command
5126 # Use 'list' and not just {} because we want variables to
5127 # be expanded in this list.
5128 set l_stock_body [list\
5129 "List of $full_command subcommands\:.*\[\r\n\]+"\
5130 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5131 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5132 "Command name abbreviations are allowed if unambiguous\."]
5133 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5134 if {[llength $args]>0} {
5135 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5137 help_test_raw "help ${command}" $l_entire_body
5141 # Build executable named EXECUTABLE from specifications that allow
5142 # different options to be passed to different sub-compilations.
5143 # TESTNAME is the name of the test; this is passed to 'untested' if
5145 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5146 # contains the option "pthreads", then gdb_compile_pthreads is used.
5147 # ARGS is a flat list of source specifications, of the form:
5148 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5149 # Each SOURCE is compiled to an object file using its OPTIONS,
5150 # using gdb_compile.
5151 # Returns 0 on success, -1 on failure.
5152 proc build_executable_from_specs {testname executable options args} {
5156 set binfile [standard_output_file $executable]
5159 if { [lsearch -exact $options "c++"] >= 0 } {
5160 set info_options "c++"
5162 if [get_compiler_info ${info_options}] {
5166 set func gdb_compile
5167 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5168 if {$func_index != -1} {
5169 set func "${func}_[lindex $options $func_index]"
5172 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5173 # parameter. They also requires $sources while gdb_compile and
5174 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5175 if [string match gdb_compile_shlib* $func] {
5177 foreach {s local_options} $args {
5178 if { [regexp "^/" "$s"] } then {
5179 lappend sources_path "$s"
5181 lappend sources_path "$srcdir/$subdir/$s"
5184 set ret [$func $sources_path "${binfile}" $options]
5188 foreach {s local_options} $args {
5189 if { ! [regexp "^/" "$s"] } then {
5190 set s "$srcdir/$subdir/$s"
5192 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5196 lappend objects "${binfile}${i}.o"
5199 set ret [$func $objects "${binfile}" executable $options]
5209 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5210 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5211 # to pass to untested, if something is wrong. OPTIONS are passed
5212 # to gdb_compile directly.
5213 proc build_executable { testname executable {sources ""} {options {debug}} } {
5214 if {[llength $sources]==0} {
5215 set sources ${executable}.c
5218 set arglist [list $testname $executable $options]
5219 foreach source $sources {
5220 lappend arglist $source $options
5223 return [eval build_executable_from_specs $arglist]
5226 # Starts fresh GDB binary and loads an optional executable into GDB.
5227 # Usage: clean_restart [executable]
5228 # EXECUTABLE is the basename of the binary.
5230 proc clean_restart { args } {
5234 if { [llength $args] > 1 } {
5235 error "bad number of args: [llength $args]"
5240 gdb_reinitialize_dir $srcdir/$subdir
5242 if { [llength $args] >= 1 } {
5243 set executable [lindex $args 0]
5244 set binfile [standard_output_file ${executable}]
5249 # Prepares for testing by calling build_executable_full, then
5251 # TESTNAME is the name of the test.
5252 # Each element in ARGS is a list of the form
5253 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5254 # These are passed to build_executable_from_specs, which see.
5255 # The last EXECUTABLE is passed to clean_restart.
5256 # Returns 0 on success, non-zero on failure.
5257 proc prepare_for_testing_full {testname args} {
5258 foreach spec $args {
5259 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5262 set executable [lindex $spec 0]
5264 clean_restart $executable
5268 # Prepares for testing, by calling build_executable, and then clean_restart.
5269 # Please refer to build_executable for parameter description.
5270 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5272 if {[build_executable $testname $executable $sources $options] == -1} {
5275 clean_restart $executable
5280 proc get_valueof { fmt exp default } {
5283 set test "get valueof \"${exp}\""
5285 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5286 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5287 set val $expect_out(1,string)
5291 fail "$test (timeout)"
5297 proc get_integer_valueof { exp default } {
5300 set test "get integer valueof \"${exp}\""
5302 gdb_test_multiple "print /d ${exp}" "$test" {
5303 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5304 set val $expect_out(1,string)
5308 fail "$test (timeout)"
5314 proc get_hexadecimal_valueof { exp default } {
5316 send_gdb "print /x ${exp}\n"
5317 set test "get hexadecimal valueof \"${exp}\""
5319 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5320 set val $expect_out(1,string)
5325 fail "$test (timeout)"
5331 proc get_sizeof { type default } {
5332 return [get_integer_valueof "sizeof (${type})" $default]
5335 proc get_target_charset { } {
5338 gdb_test_multiple "show target-charset" "" {
5339 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5340 return $expect_out(1,string)
5342 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5343 return $expect_out(1,string)
5347 # Pick a reasonable default.
5348 warning "Unable to read target-charset."
5352 # Get the current value for remotetimeout and return it.
5353 proc get_remotetimeout { } {
5357 gdb_test_multiple "show remotetimeout" "" {
5358 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5359 return $expect_out(1,string)
5363 # Pick the default that gdb uses
5364 warning "Unable to read remotetimeout"
5368 # Set the remotetimeout to the specified timeout. Nothing is returned.
5369 proc set_remotetimeout { timeout } {
5372 gdb_test_multiple "set remotetimeout $timeout" "" {
5373 -re "$gdb_prompt $" {
5374 verbose "Set remotetimeout to $timeout\n"
5379 # ROOT and FULL are file names. Returns the relative path from ROOT
5380 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5381 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5384 proc relative_filename {root full} {
5385 set root_split [file split $root]
5386 set full_split [file split $full]
5388 set len [llength $root_split]
5390 if {[eval file join $root_split]
5391 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5392 error "$full not a subdir of $root"
5395 return [eval file join [lrange $full_split $len end]]
5398 # Log gdb command line and script if requested.
5399 if {[info exists TRANSCRIPT]} {
5400 rename send_gdb real_send_gdb
5401 rename remote_spawn real_remote_spawn
5402 rename remote_close real_remote_close
5404 global gdb_transcript
5405 set gdb_transcript ""
5407 global gdb_trans_count
5408 set gdb_trans_count 1
5410 proc remote_spawn {args} {
5411 global gdb_transcript gdb_trans_count outdir
5413 if {$gdb_transcript != ""} {
5414 close $gdb_transcript
5416 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5417 puts $gdb_transcript [lindex $args 1]
5418 incr gdb_trans_count
5420 return [uplevel real_remote_spawn $args]
5423 proc remote_close {args} {
5424 global gdb_transcript
5426 if {$gdb_transcript != ""} {
5427 close $gdb_transcript
5428 set gdb_transcript ""
5431 return [uplevel real_remote_close $args]
5434 proc send_gdb {args} {
5435 global gdb_transcript
5437 if {$gdb_transcript != ""} {
5438 puts -nonewline $gdb_transcript [lindex $args 0]
5441 return [uplevel real_send_gdb $args]
5445 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5446 if {[info exists GDB_PARALLEL]} {
5447 if {[is_remote host]} {
5451 [make_gdb_parallel_path outputs] \
5452 [make_gdb_parallel_path temp] \
5453 [make_gdb_parallel_path cache]
5457 proc core_find {binfile {deletefiles {}} {arg ""}} {
5458 global objdir subdir
5460 set destcore "$binfile.core"
5461 file delete $destcore
5463 # Create a core file named "$destcore" rather than just "core", to
5464 # avoid problems with sys admin types that like to regularly prune all
5465 # files named "core" from the system.
5467 # Arbitrarily try setting the core size limit to "unlimited" since
5468 # this does not hurt on systems where the command does not work and
5469 # allows us to generate a core on systems where it does.
5471 # Some systems append "core" to the name of the program; others append
5472 # the name of the program to "core"; still others (like Linux, as of
5473 # May 2003) create cores named "core.PID". In the latter case, we
5474 # could have many core files lying around, and it may be difficult to
5475 # tell which one is ours, so let's run the program in a subdirectory.
5477 set coredir [standard_output_file coredir.[getpid]]
5479 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5480 # remote_exec host "${binfile}"
5481 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5482 if [remote_file build exists $i] {
5483 remote_exec build "mv $i $destcore"
5487 # Check for "core.PID".
5488 if { $found == 0 } {
5489 set names [glob -nocomplain -directory $coredir core.*]
5490 if {[llength $names] == 1} {
5491 set corefile [file join $coredir [lindex $names 0]]
5492 remote_exec build "mv $corefile $destcore"
5496 if { $found == 0 } {
5497 # The braindamaged HPUX shell quits after the ulimit -c above
5498 # without executing ${binfile}. So we try again without the
5499 # ulimit here if we didn't find a core file above.
5500 # Oh, I should mention that any "braindamaged" non-Unix system has
5501 # the same problem. I like the cd bit too, it's really neat'n stuff.
5502 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5503 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5504 if [remote_file build exists $i] {
5505 remote_exec build "mv $i $destcore"
5511 # Try to clean up after ourselves.
5512 foreach deletefile $deletefiles {
5513 remote_file build delete [file join $coredir $deletefile]
5515 remote_exec build "rmdir $coredir"
5517 if { $found == 0 } {
5518 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5524 # gdb_target_symbol_prefix_flags returns a string that can be added
5525 # to gdb_compile options to define SYMBOL_PREFIX macro value
5526 # symbol_prefix_flags returns a string that can be added
5527 # for targets that use underscore as symbol prefix.
5528 # TODO: find out automatically if the target needs this.
5530 proc gdb_target_symbol_prefix_flags {} {
5531 if { [istarget "i?86-*-cygwin*"] || [istarget "i?86-*-mingw*"]
5532 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
5533 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
5539 # A wrapper for 'remote_exec host' that passes or fails a test.
5540 # Returns 0 if all went well, nonzero on failure.
5541 # TEST is the name of the test, other arguments are as for remote_exec.
5543 proc run_on_host { test program args } {
5544 verbose -log "run_on_host: $program $args"
5545 # remote_exec doesn't work properly if the output is set but the
5546 # input is the empty string -- so replace an empty input with
5548 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5549 set args [lreplace $args 1 1 "/dev/null"]
5551 set result [eval remote_exec host [list $program] $args]
5552 verbose "result is $result"
5553 set status [lindex $result 0]
5554 set output [lindex $result 1]
5559 verbose -log "run_on_host failed: $output"
5565 # Return non-zero if "board_info debug_flags" mentions Fission.
5566 # http://gcc.gnu.org/wiki/DebugFission
5567 # Fission doesn't support everything yet.
5568 # This supports working around bug 15954.
5570 proc using_fission { } {
5571 set debug_flags [board_info [target_info name] debug_flags]
5572 return [regexp -- "-gsplit-dwarf" $debug_flags]
5575 # Search the caller's ARGS list and set variables according to the list of
5576 # valid options described by ARGSET.
5578 # The first member of each one- or two-element list in ARGSET defines the
5579 # name of a variable that will be added to the caller's scope.
5581 # If only one element is given to describe an option, it the value is
5582 # 0 if the option is not present in (the caller's) ARGS or 1 if
5585 # If two elements are given, the second element is the default value of
5586 # the variable. This is then overwritten if the option exists in ARGS.
5588 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5589 # any optional components.
5592 # proc myproc {foo args} {
5593 # parse_args {{bar} {baz "abc"} {qux}}
5596 # myproc ABC -bar -baz DEF peanut butter
5597 # will define the following variables in myproc:
5598 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5599 # args will be the list {peanut butter}
5601 proc parse_args { argset } {
5604 foreach argument $argset {
5605 if {[llength $argument] == 1} {
5606 # No default specified, so we assume that we should set
5607 # the value to 1 if the arg is present and 0 if it's not.
5608 # It is assumed that no value is given with the argument.
5609 set result [lsearch -exact $args "-$argument"]
5610 if {$result != -1} then {
5611 uplevel 1 [list set $argument 1]
5612 set args [lreplace $args $result $result]
5614 uplevel 1 [list set $argument 0]
5616 } elseif {[llength $argument] == 2} {
5617 # There are two items in the argument. The second is a
5618 # default value to use if the item is not present.
5619 # Otherwise, the variable is set to whatever is provided
5620 # after the item in the args.
5621 set arg [lindex $argument 0]
5622 set result [lsearch -exact $args "-[lindex $arg 0]"]
5623 if {$result != -1} then {
5624 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5625 set args [lreplace $args $result [expr $result+1]]
5627 uplevel 1 [list set $arg [lindex $argument 1]]
5630 error "Badly formatted argument \"$argument\" in argument set"
5634 # The remaining args should be checked to see that they match the
5635 # number of items expected to be passed into the procedure...
5638 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5639 # return that string.
5641 proc capture_command_output { command prefix } {
5645 set output_string ""
5646 gdb_test_multiple "$command" "capture_command_output for $command" {
5647 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5648 set output_string $expect_out(1,string)
5651 return $output_string
5654 # A convenience function that joins all the arguments together, with a
5655 # regexp that matches exactly one end of line in between each argument.
5656 # This function is ideal to write the expected output of a GDB command
5657 # that generates more than a couple of lines, as this allows us to write
5658 # each line as a separate string, which is easier to read by a human
5661 proc multi_line { args } {
5662 return [join $args "\r\n"]
5665 # Always load compatibility stuff.