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. This argument
963 # may be omitted to just match the prompt, ignoring whatever output
965 # MESSAGE is an optional message to be printed. If this is
966 # omitted, then the pass/fail messages use the command string as the
967 # message. (If this is the empty string, then sometimes we don't
968 # call pass or fail at all; I don't understand this at all.)
969 # QUESTION is a question GDB may ask in response to COMMAND, like
971 # RESPONSE is the response to send if QUESTION appears.
974 # 1 if the test failed,
975 # 0 if the test passes,
976 # -1 if there was an internal error.
978 proc gdb_test { args } {
982 upvar timeout timeout
984 if [llength $args]>2 then {
985 set message [lindex $args 2]
987 set message [lindex $args 0]
989 set command [lindex $args 0]
990 set pattern [lindex $args 1]
992 if [llength $args]==5 {
993 set question_string [lindex $args 3]
994 set response_string [lindex $args 4]
996 set question_string "^FOOBAR$"
999 return [gdb_test_multiple $command $message {
1000 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
1001 if ![string match "" $message] then {
1005 -re "(${question_string})$" {
1006 send_gdb "$response_string\n"
1012 # gdb_test_no_output COMMAND MESSAGE
1013 # Send a command to GDB and verify that this command generated no output.
1015 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1016 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1017 # the message. (If MESSAGE is the empty string, then sometimes we do not
1018 # call pass or fail at all; I don't understand this at all.)
1020 proc gdb_test_no_output { args } {
1022 set command [lindex $args 0]
1023 if [llength $args]>1 then {
1024 set message [lindex $args 1]
1026 set message $command
1029 set command_regex [string_to_regexp $command]
1030 gdb_test_multiple $command $message {
1031 -re "^$command_regex\r\n$gdb_prompt $" {
1032 if ![string match "" $message] then {
1039 # Send a command and then wait for a sequence of outputs.
1040 # This is useful when the sequence is long and contains ".*", a single
1041 # regexp to match the entire output can get a timeout much easier.
1043 # COMMAND is the command to send.
1044 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1045 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1046 # processed in order, and all must be present in the output.
1048 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1049 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1050 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1052 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1053 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1056 # 1 if the test failed,
1057 # 0 if the test passes,
1058 # -1 if there was an internal error.
1060 proc gdb_test_sequence { command test_name expected_output_list } {
1062 if { $test_name == "" } {
1063 set test_name $command
1065 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1066 send_gdb "$command\n"
1067 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1071 # Test that a command gives an error. For pass or fail, return
1072 # a 1 to indicate that more tests can proceed. However a timeout
1073 # is a serious error, generates a special fail message, and causes
1074 # a 0 to be returned to indicate that more tests are likely to fail
1077 proc test_print_reject { args } {
1081 if [llength $args]==2 then {
1082 set expectthis [lindex $args 1]
1084 set expectthis "should never match this bogus string"
1086 set sendthis [lindex $args 0]
1087 if $verbose>2 then {
1088 send_user "Sending \"$sendthis\" to gdb\n"
1089 send_user "Looking to match \"$expectthis\"\n"
1091 send_gdb "$sendthis\n"
1092 #FIXME: Should add timeout as parameter.
1094 -re "A .* in expression.*\\.*$gdb_prompt $" {
1095 pass "reject $sendthis"
1098 -re "Invalid syntax in expression.*$gdb_prompt $" {
1099 pass "reject $sendthis"
1102 -re "Junk after end of expression.*$gdb_prompt $" {
1103 pass "reject $sendthis"
1106 -re "Invalid number.*$gdb_prompt $" {
1107 pass "reject $sendthis"
1110 -re "Invalid character constant.*$gdb_prompt $" {
1111 pass "reject $sendthis"
1114 -re "No symbol table is loaded.*$gdb_prompt $" {
1115 pass "reject $sendthis"
1118 -re "No symbol .* in current context.*$gdb_prompt $" {
1119 pass "reject $sendthis"
1122 -re "Unmatched single quote.*$gdb_prompt $" {
1123 pass "reject $sendthis"
1126 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1127 pass "reject $sendthis"
1130 -re "$expectthis.*$gdb_prompt $" {
1131 pass "reject $sendthis"
1134 -re ".*$gdb_prompt $" {
1135 fail "reject $sendthis"
1139 fail "reject $sendthis (eof or timeout)"
1146 # Same as gdb_test, but the second parameter is not a regexp,
1147 # but a string that must match exactly.
1149 proc gdb_test_exact { args } {
1150 upvar timeout timeout
1152 set command [lindex $args 0]
1154 # This applies a special meaning to a null string pattern. Without
1155 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1156 # messages from commands that should have no output except a new
1157 # prompt. With this, only results of a null string will match a null
1160 set pattern [lindex $args 1]
1161 if [string match $pattern ""] {
1162 set pattern [string_to_regexp [lindex $args 0]]
1164 set pattern [string_to_regexp [lindex $args 1]]
1167 # It is most natural to write the pattern argument with only
1168 # embedded \n's, especially if you are trying to avoid Tcl quoting
1169 # problems. But gdb_expect really wants to see \r\n in patterns. So
1170 # transform the pattern here. First transform \r\n back to \n, in
1171 # case some users of gdb_test_exact already do the right thing.
1172 regsub -all "\r\n" $pattern "\n" pattern
1173 regsub -all "\n" $pattern "\r\n" pattern
1174 if [llength $args]==3 then {
1175 set message [lindex $args 2]
1177 set message $command
1180 return [gdb_test $command $pattern $message]
1183 # Wrapper around gdb_test_multiple that looks for a list of expected
1184 # output elements, but which can appear in any order.
1185 # CMD is the gdb command.
1186 # NAME is the name of the test.
1187 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1189 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1190 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1191 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1193 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1194 # of text per element and then strip trailing \r\n's.
1196 # gdb_test_list_exact "foo" "bar" \
1197 # "\[^\r\n\]+\[\r\n\]+" \
1200 # {expected result 1} \
1201 # {expected result 2} \
1204 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1207 set matches [lsort $result_match_list]
1209 gdb_test_multiple $cmd $name {
1210 "$cmd\[\r\n\]" { exp_continue }
1211 -re $elm_find_regexp {
1212 set str $expect_out(0,string)
1213 verbose -log "seen: $str" 3
1214 regexp -- $elm_extract_regexp $str elm_seen
1215 verbose -log "extracted: $elm_seen" 3
1216 lappend seen $elm_seen
1219 -re "$gdb_prompt $" {
1221 foreach got [lsort $seen] have $matches {
1222 if {![string equal $got $have]} {
1227 if {[string length $failed] != 0} {
1228 fail "$name ($failed not found)"
1236 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1237 # Send a command to gdb; expect inferior and gdb output.
1239 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1242 # INFERIOR_PATTERN is the pattern to match against inferior output.
1244 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1245 # include the \r\n sequence immediately before the gdb prompt, nor the
1246 # prompt. The default is empty.
1248 # Both inferior and gdb patterns must match for a PASS.
1250 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1253 # 1 if the test failed,
1254 # 0 if the test passes,
1255 # -1 if there was an internal error.
1258 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1259 global inferior_spawn_id gdb_spawn_id
1262 if {$message == ""} {
1263 set message $command
1266 set inferior_matched 0
1269 # Use an indirect spawn id list, and remove the inferior spawn id
1270 # from the expected output as soon as it matches, in case
1271 # $inferior_pattern happens to be a prefix of the resulting full
1272 # gdb pattern below (e.g., "\r\n").
1273 global gdb_test_stdio_spawn_id_list
1274 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1276 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1277 # then we may see gdb's output arriving before the inferior's
1279 set res [gdb_test_multiple $command $message {
1280 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1281 set inferior_matched 1
1282 if {!$gdb_matched} {
1283 set gdb_test_stdio_spawn_id_list ""
1287 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1289 if {!$inferior_matched} {
1297 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1304 # Issue a PASS and return true if evaluating CONDITION in the caller's
1305 # frame returns true, and issue a FAIL and return false otherwise.
1306 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1307 # omitted or is empty, then the pass/fail messages use the condition
1308 # string as the message.
1310 proc gdb_assert { condition {message ""} } {
1311 if { $message == ""} {
1312 set message $condition
1315 set res [uplevel 1 expr $condition]
1324 proc gdb_reinitialize_dir { subdir } {
1327 if [is_remote host] {
1332 -re "Reinitialize source path to empty.*y or n. " {
1335 -re "Source directories searched.*$gdb_prompt $" {
1336 send_gdb "dir $subdir\n"
1338 -re "Source directories searched.*$gdb_prompt $" {
1339 verbose "Dir set to $subdir"
1341 -re "$gdb_prompt $" {
1342 perror "Dir \"$subdir\" failed."
1346 -re "$gdb_prompt $" {
1347 perror "Dir \"$subdir\" failed."
1351 -re "$gdb_prompt $" {
1352 perror "Dir \"$subdir\" failed."
1358 # gdb_exit -- exit the GDB, killing the target program if necessary
1360 proc default_gdb_exit {} {
1362 global INTERNAL_GDBFLAGS GDBFLAGS
1365 global inotify_log_file
1367 gdb_stop_suppressing_tests
1369 if ![info exists gdb_spawn_id] {
1373 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1375 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1376 set fd [open $inotify_log_file]
1377 set data [read -nonewline $fd]
1380 if {[string compare $data ""] != 0} {
1381 warning "parallel-unsafe file creations noticed"
1384 set fd [open $inotify_log_file w]
1389 if { [is_remote host] && [board_info host exists fileid] } {
1396 -re "DOSEXIT code" { }
1401 if ![is_remote host] {
1407 # Load a file into the debugger.
1408 # The return value is 0 for success, -1 for failure.
1410 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1411 # to one of these values:
1413 # debug file was loaded successfully and has debug information
1414 # nodebug file was loaded successfully and has no debug information
1415 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1417 # fail file was not loaded
1419 # I tried returning this information as part of the return value,
1420 # but ran into a mess because of the many re-implementations of
1421 # gdb_load in config/*.exp.
1423 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1424 # this if they can get more information set.
1426 proc gdb_file_cmd { arg } {
1430 global last_loaded_file
1432 # Save this for the benefit of gdbserver-support.exp.
1433 set last_loaded_file $arg
1435 # Set whether debug info was found.
1436 # Default to "fail".
1437 global gdb_file_cmd_debug_info
1438 set gdb_file_cmd_debug_info "fail"
1440 if [is_remote host] {
1441 set arg [remote_download host $arg]
1443 perror "download failed"
1448 # The file command used to kill the remote target. For the benefit
1449 # of the testsuite, preserve this behavior.
1452 -re "Kill the program being debugged. .y or n. $" {
1454 verbose "\t\tKilling previous program being debugged"
1457 -re "$gdb_prompt $" {
1462 send_gdb "file $arg\n"
1464 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1465 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1466 set gdb_file_cmd_debug_info "lzma"
1469 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1470 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1471 set gdb_file_cmd_debug_info "nodebug"
1474 -re "Reading symbols from.*done.*$gdb_prompt $" {
1475 verbose "\t\tLoaded $arg into $GDB"
1476 set gdb_file_cmd_debug_info "debug"
1479 -re "Load new symbol table from \".*\".*y or n. $" {
1482 -re "Reading symbols from.*done.*$gdb_prompt $" {
1483 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1484 set gdb_file_cmd_debug_info "debug"
1488 perror "Couldn't load $arg, other program already loaded (timeout)."
1492 perror "Couldn't load $arg, other program already loaded (eof)."
1497 -re "No such file or directory.*$gdb_prompt $" {
1498 perror "($arg) No such file or directory"
1501 -re "A problem internal to GDB has been detected" {
1502 fail "($arg) (GDB internal error)"
1503 gdb_internal_error_resync
1506 -re "$gdb_prompt $" {
1507 perror "Couldn't load $arg into $GDB."
1511 perror "Couldn't load $arg into $GDB (timeout)."
1515 # This is an attempt to detect a core dump, but seems not to
1516 # work. Perhaps we need to match .* followed by eof, in which
1517 # gdb_expect does not seem to have a way to do that.
1518 perror "Couldn't load $arg into $GDB (eof)."
1524 # Default gdb_spawn procedure.
1526 proc default_gdb_spawn { } {
1529 global INTERNAL_GDBFLAGS GDBFLAGS
1532 gdb_stop_suppressing_tests
1534 # Set the default value, it may be overriden later by specific testfile.
1536 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1537 # is already started after connecting and run/attach are not supported.
1538 # This is used for the "remote" protocol. After GDB starts you should
1539 # check global $use_gdb_stub instead of the board as the testfile may force
1540 # a specific different target protocol itself.
1541 set use_gdb_stub [target_info exists use_gdb_stub]
1543 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1545 if [info exists gdb_spawn_id] {
1549 if ![is_remote host] {
1550 if { [which $GDB] == 0 } then {
1551 perror "$GDB does not exist."
1555 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1556 if { $res < 0 || $res == "" } {
1557 perror "Spawning $GDB failed."
1561 set gdb_spawn_id $res
1565 # Default gdb_start procedure.
1567 proc default_gdb_start { } {
1568 global gdb_prompt pagination_prompt
1570 global inferior_spawn_id
1572 if [info exists gdb_spawn_id] {
1581 # Default to assuming inferior I/O is done on GDB's terminal.
1582 if {![info exists inferior_spawn_id]} {
1583 set inferior_spawn_id $gdb_spawn_id
1586 # When running over NFS, particularly if running many simultaneous
1587 # tests on different hosts all using the same server, things can
1588 # get really slow. Give gdb at least 3 minutes to start up.
1590 while { $loop_again } {
1593 -re "$pagination_prompt" {
1594 verbose "Hit pagination during startup. Pressing enter to continue."
1598 -re "\[\r\n\]$gdb_prompt $" {
1599 verbose "GDB initialized."
1601 -re "$gdb_prompt $" {
1602 perror "GDB never initialized."
1607 perror "(timeout) GDB never initialized after 10 seconds."
1615 # force the height to "unlimited", so no pagers get used
1617 send_gdb "set height 0\n"
1619 -re "$gdb_prompt $" {
1620 verbose "Setting height to 0." 2
1623 warning "Couldn't set the height to 0"
1626 # force the width to "unlimited", so no wraparound occurs
1627 send_gdb "set width 0\n"
1629 -re "$gdb_prompt $" {
1630 verbose "Setting width to 0." 2
1633 warning "Couldn't set the width to 0."
1639 # Utility procedure to give user control of the gdb prompt in a script. It is
1640 # meant to be used for debugging test cases, and should not be left in the
1643 proc gdb_interact { } {
1645 set spawn_id $gdb_spawn_id
1647 send_user "+------------------------------------------+\n"
1648 send_user "| Script interrupted, you can now interact |\n"
1649 send_user "| with by gdb. Type >>> to continue. |\n"
1650 send_user "+------------------------------------------+\n"
1657 # Examine the output of compilation to determine whether compilation
1658 # failed or not. If it failed determine whether it is due to missing
1659 # compiler or due to compiler error. Report pass, fail or unsupported
1662 proc gdb_compile_test {src output} {
1663 if { $output == "" } {
1664 pass "compilation [file tail $src]"
1665 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1666 unsupported "compilation [file tail $src]"
1667 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1668 unsupported "compilation [file tail $src]"
1669 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1670 unsupported "compilation [file tail $src]"
1672 verbose -log "compilation failed: $output" 2
1673 fail "compilation [file tail $src]"
1677 # Return a 1 for configurations for which we don't even want to try to
1680 proc skip_cplus_tests {} {
1681 if { [istarget "h8300-*-*"] } {
1685 # The C++ IO streams are too large for HC11/HC12 and are thus not
1686 # available. The gdb C++ tests use them and don't compile.
1687 if { [istarget "m6811-*-*"] } {
1690 if { [istarget "m6812-*-*"] } {
1696 # Return a 1 for configurations for which don't have both C++ and the STL.
1698 proc skip_stl_tests {} {
1699 # Symbian supports the C++ language, but the STL is missing
1700 # (both headers and libraries).
1701 if { [istarget "arm*-*-symbianelf*"] } {
1705 return [skip_cplus_tests]
1708 # Return a 1 if I don't even want to try to test FORTRAN.
1710 proc skip_fortran_tests {} {
1714 # Return a 1 if I don't even want to try to test ada.
1716 proc skip_ada_tests {} {
1720 # Return a 1 if I don't even want to try to test GO.
1722 proc skip_go_tests {} {
1726 # Return a 1 if I don't even want to try to test java.
1728 proc skip_java_tests {} {
1732 # Return a 1 if I don't even want to try to test D.
1734 proc skip_d_tests {} {
1738 # Return a 1 for configurations that do not support Python scripting.
1739 # PROMPT_REGEXP is the expected prompt.
1741 proc skip_python_tests_prompt { prompt_regexp } {
1742 global gdb_py_is_py3k
1743 global gdb_py_is_py24
1745 gdb_test_multiple "python print ('test')" "verify python support" {
1746 -re "not supported.*$prompt_regexp" {
1747 unsupported "Python support is disabled."
1750 -re "$prompt_regexp" {}
1753 set gdb_py_is_py24 0
1754 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1755 -re "3.*$prompt_regexp" {
1756 set gdb_py_is_py3k 1
1758 -re ".*$prompt_regexp" {
1759 set gdb_py_is_py3k 0
1762 if { $gdb_py_is_py3k == 0 } {
1763 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1764 -re "\[45\].*$prompt_regexp" {
1765 set gdb_py_is_py24 1
1767 -re ".*$prompt_regexp" {
1768 set gdb_py_is_py24 0
1776 # Return a 1 for configurations that do not support Python scripting.
1777 # Note: This also sets various globals that specify which version of Python
1778 # is in use. See skip_python_tests_prompt.
1780 proc skip_python_tests {} {
1782 return [skip_python_tests_prompt "$gdb_prompt $"]
1785 # Return a 1 if we should skip shared library tests.
1787 proc skip_shlib_tests {} {
1788 # Run the shared library tests on native systems.
1793 # An abbreviated list of remote targets where we should be able to
1794 # run shared library tests.
1795 if {([istarget *-*-linux*]
1796 || [istarget *-*-*bsd*]
1797 || [istarget *-*-solaris2*]
1798 || [istarget arm*-*-symbianelf*]
1799 || [istarget *-*-mingw*]
1800 || [istarget *-*-cygwin*]
1801 || [istarget *-*-pe*])} {
1808 # Return 1 if we should skip tui related tests.
1810 proc skip_tui_tests {} {
1813 gdb_test_multiple "help layout" "verify tui support" {
1814 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1817 -re "$gdb_prompt $" {
1824 # Test files shall make sure all the test result lines in gdb.sum are
1825 # unique in a test run, so that comparing the gdb.sum files of two
1826 # test runs gives correct results. Test files that exercise
1827 # variations of the same tests more than once, shall prefix the
1828 # different test invocations with different identifying strings in
1829 # order to make them unique.
1831 # About test prefixes:
1833 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1834 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1835 # underlined substring in
1837 # PASS: gdb.base/mytest.exp: some test
1838 # ^^^^^^^^^^^^^^^^^^^^
1842 # The easiest way to adjust the test prefix is to append a test
1843 # variation prefix to the $pf_prefix, using the with_test_prefix
1846 # proc do_tests {} {
1847 # gdb_test ... ... "test foo"
1848 # gdb_test ... ... "test bar"
1850 # with_test_prefix "subvariation a" {
1851 # gdb_test ... ... "test x"
1854 # with_test_prefix "subvariation b" {
1855 # gdb_test ... ... "test x"
1859 # with_test_prefix "variation1" {
1860 # ...do setup for variation 1...
1864 # with_test_prefix "variation2" {
1865 # ...do setup for variation 2...
1871 # PASS: gdb.base/mytest.exp: variation1: test foo
1872 # PASS: gdb.base/mytest.exp: variation1: test bar
1873 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1874 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1875 # PASS: gdb.base/mytest.exp: variation2: test foo
1876 # PASS: gdb.base/mytest.exp: variation2: test bar
1877 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1878 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1880 # If for some reason more flexibility is necessary, one can also
1881 # manipulate the pf_prefix global directly, treating it as a string.
1885 # set saved_pf_prefix
1886 # append pf_prefix "${foo}: bar"
1887 # ... actual tests ...
1888 # set pf_prefix $saved_pf_prefix
1891 # Run BODY in the context of the caller, with the current test prefix
1892 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1893 # Returns the result of BODY.
1895 proc with_test_prefix { prefix body } {
1898 set saved $pf_prefix
1899 append pf_prefix " " $prefix ":"
1900 set code [catch {uplevel 1 $body} result]
1901 set pf_prefix $saved
1904 global errorInfo errorCode
1905 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1907 return -code $code $result
1911 # Run BODY in the context of the caller. After BODY is run, the variables
1912 # listed in VARS will be reset to the values they had before BODY was run.
1914 # This is useful for providing a scope in which it is safe to temporarily
1915 # modify global variables, e.g.
1917 # global INTERNAL_GDBFLAGS
1920 # set foo GDBHISTSIZE
1922 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1923 # append INTERNAL_GDBFLAGS " -nx"
1924 # unset -nocomplain env(GDBHISTSIZE)
1929 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1930 # modified inside BODY, this proc guarantees that the modifications will be
1931 # undone after BODY finishes executing.
1933 proc save_vars { vars body } {
1934 array set saved_scalars { }
1935 array set saved_arrays { }
1939 # First evaluate VAR in the context of the caller in case the variable
1940 # name may be a not-yet-interpolated string like env($foo)
1941 set var [uplevel 1 list $var]
1943 if [uplevel 1 [list info exists $var]] {
1944 if [uplevel 1 [list array exists $var]] {
1945 set saved_arrays($var) [uplevel 1 [list array get $var]]
1947 set saved_scalars($var) [uplevel 1 [list set $var]]
1950 lappend unset_vars $var
1954 set code [catch {uplevel 1 $body} result]
1956 foreach {var value} [array get saved_scalars] {
1957 uplevel 1 [list set $var $value]
1960 foreach {var value} [array get saved_arrays] {
1961 uplevel 1 [list unset $var]
1962 uplevel 1 [list array set $var $value]
1965 foreach var $unset_vars {
1966 uplevel 1 [list unset -nocomplain $var]
1970 global errorInfo errorCode
1971 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1973 return -code $code $result
1978 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1979 # PROMPT. When BODY is finished, restore GDB prompt and variable
1981 # Returns the result of BODY.
1985 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
1986 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
1987 # TCL). PROMPT is internally converted to a suitable regexp for matching.
1988 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
1989 # a) It's more intuitive for callers to pass the plain text form.
1990 # b) We need two forms of the prompt:
1991 # - a regexp to use in output matching,
1992 # - a value to pass to the "set prompt" command.
1993 # c) It's easier to convert the plain text form to its regexp form.
1995 # 2) Don't add a trailing space, we do that here.
1997 proc with_gdb_prompt { prompt body } {
2000 # Convert "(foo)" to "\(foo\)".
2001 # We don't use string_to_regexp because while it works today it's not
2002 # clear it will work tomorrow: the value we need must work as both a
2003 # regexp *and* as the argument to the "set prompt" command, at least until
2004 # we start recording both forms separately instead of just $gdb_prompt.
2005 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2007 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2009 set saved $gdb_prompt
2011 verbose -log "Setting gdb prompt to \"$prompt \"."
2012 set gdb_prompt $prompt
2013 gdb_test_no_output "set prompt $prompt " ""
2015 set code [catch {uplevel 1 $body} result]
2017 verbose -log "Restoring gdb prompt to \"$saved \"."
2018 set gdb_prompt $saved
2019 gdb_test_no_output "set prompt $saved " ""
2022 global errorInfo errorCode
2023 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2025 return -code $code $result
2029 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2030 # BODY is finished, restore target-charset.
2032 proc with_target_charset { target_charset body } {
2036 gdb_test_multiple "show target-charset" "" {
2037 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2038 set saved $expect_out(1,string)
2040 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2041 set saved $expect_out(1,string)
2043 -re ".*$gdb_prompt " {
2044 fail "get target-charset"
2048 gdb_test_no_output "set target-charset $target_charset" ""
2050 set code [catch {uplevel 1 $body} result]
2052 gdb_test_no_output "set target-charset $saved" ""
2055 global errorInfo errorCode
2056 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2058 return -code $code $result
2062 # Select the largest timeout from all the timeouts:
2063 # - the local "timeout" variable of the scope two levels above,
2064 # - the global "timeout" variable,
2065 # - the board variable "gdb,timeout".
2067 proc get_largest_timeout {} {
2068 upvar #0 timeout gtimeout
2069 upvar 2 timeout timeout
2072 if [info exists timeout] {
2075 if { [info exists gtimeout] && $gtimeout > $tmt } {
2078 if { [target_info exists gdb,timeout]
2079 && [target_info gdb,timeout] > $tmt } {
2080 set tmt [target_info gdb,timeout]
2090 # Run tests in BODY with timeout increased by factor of FACTOR. When
2091 # BODY is finished, restore timeout.
2093 proc with_timeout_factor { factor body } {
2096 set savedtimeout $timeout
2098 set timeout [expr [get_largest_timeout] * $factor]
2099 set code [catch {uplevel 1 $body} result]
2101 set timeout $savedtimeout
2103 global errorInfo errorCode
2104 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2106 return -code $code $result
2110 # Return 1 if _Complex types are supported, otherwise, return 0.
2112 gdb_caching_proc support_complex_tests {
2113 # Set up, compile, and execute a test program containing _Complex types.
2114 # Include the current process ID in the file names to prevent conflicts
2115 # with invocations for multiple testsuites.
2116 set src [standard_temp_file complex[pid].c]
2117 set exe [standard_temp_file complex[pid].x]
2119 gdb_produce_source $src {
2123 _Complex long double cld;
2128 verbose "compiling testfile $src" 2
2129 set compile_flags {debug nowarnings quiet}
2130 set lines [gdb_compile $src $exe executable $compile_flags]
2134 if ![string match "" $lines] then {
2135 verbose "testfile compilation failed, returning 0" 2
2144 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2147 proc supports_get_siginfo_type {} {
2148 if { [istarget "*-*-linux*"] } {
2155 # Return 1 if the target supports hardware single stepping.
2157 proc can_hardware_single_step {} {
2159 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2160 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2161 || [istarget "nios2-*-*"] } {
2168 # Return 1 if target hardware or OS supports single stepping to signal
2169 # handler, otherwise, return 0.
2171 proc can_single_step_to_signal_handler {} {
2172 # Targets don't have hardware single step. On these targets, when
2173 # a signal is delivered during software single step, gdb is unable
2174 # to determine the next instruction addresses, because start of signal
2175 # handler is one of them.
2176 return [can_hardware_single_step]
2179 # Return 1 if target supports process record, otherwise return 0.
2181 proc supports_process_record {} {
2183 if [target_info exists gdb,use_precord] {
2184 return [target_info gdb,use_precord]
2187 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2188 || [istarget "i\[34567\]86-*-linux*"]
2189 || [istarget "aarch64*-*-linux*"]
2190 || [istarget "powerpc*-*-linux*"]
2191 || [istarget "s390*-*-linux*"] } {
2198 # Return 1 if target supports reverse debugging, otherwise return 0.
2200 proc supports_reverse {} {
2202 if [target_info exists gdb,can_reverse] {
2203 return [target_info gdb,can_reverse]
2206 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2207 || [istarget "i\[34567\]86-*-linux*"]
2208 || [istarget "aarch64*-*-linux*"]
2209 || [istarget "powerpc*-*-linux*"]
2210 || [istarget "s390*-*-linux*"] } {
2217 # Return 1 if readline library is used.
2219 proc readline_is_used { } {
2222 gdb_test_multiple "show editing" "" {
2223 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2226 -re ".*$gdb_prompt $" {
2232 # Return 1 if target is ELF.
2233 gdb_caching_proc is_elf_target {
2234 set me "is_elf_target"
2236 set src [standard_temp_file is_elf_target[pid].c]
2237 set obj [standard_temp_file is_elf_target[pid].o]
2239 gdb_produce_source $src {
2240 int foo () {return 0;}
2243 verbose "$me: compiling testfile $src" 2
2244 set lines [gdb_compile $src $obj object {quiet}]
2248 if ![string match "" $lines] then {
2249 verbose "$me: testfile compilation failed, returning 0" 2
2253 set fp_obj [open $obj "r"]
2254 fconfigure $fp_obj -translation binary
2255 set data [read $fp_obj]
2260 set ELFMAG "\u007FELF"
2262 if {[string compare -length 4 $data $ELFMAG] != 0} {
2263 verbose "$me: returning 0" 2
2267 verbose "$me: returning 1" 2
2271 # Return 1 if the memory at address zero is readable.
2273 gdb_caching_proc is_address_zero_readable {
2277 gdb_test_multiple "x 0" "" {
2278 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2281 -re ".*$gdb_prompt $" {
2289 # Produce source file NAME and write SOURCES into it.
2291 proc gdb_produce_source { name sources } {
2293 set f [open $name "w"]
2299 # Return 1 if target is ILP32.
2300 # This cannot be decided simply from looking at the target string,
2301 # as it might depend on externally passed compiler options like -m64.
2302 gdb_caching_proc is_ilp32_target {
2303 set me "is_ilp32_target"
2305 set src [standard_temp_file ilp32[pid].c]
2306 set obj [standard_temp_file ilp32[pid].o]
2308 gdb_produce_source $src {
2309 int dummy[sizeof (int) == 4
2310 && sizeof (void *) == 4
2311 && sizeof (long) == 4 ? 1 : -1];
2314 verbose "$me: compiling testfile $src" 2
2315 set lines [gdb_compile $src $obj object {quiet}]
2319 if ![string match "" $lines] then {
2320 verbose "$me: testfile compilation failed, returning 0" 2
2324 verbose "$me: returning 1" 2
2328 # Return 1 if target is LP64.
2329 # This cannot be decided simply from looking at the target string,
2330 # as it might depend on externally passed compiler options like -m64.
2331 gdb_caching_proc is_lp64_target {
2332 set me "is_lp64_target"
2334 set src [standard_temp_file lp64[pid].c]
2335 set obj [standard_temp_file lp64[pid].o]
2337 gdb_produce_source $src {
2338 int dummy[sizeof (int) == 4
2339 && sizeof (void *) == 8
2340 && sizeof (long) == 8 ? 1 : -1];
2343 verbose "$me: compiling testfile $src" 2
2344 set lines [gdb_compile $src $obj object {quiet}]
2348 if ![string match "" $lines] then {
2349 verbose "$me: testfile compilation failed, returning 0" 2
2353 verbose "$me: returning 1" 2
2357 # Return 1 if target has 64 bit addresses.
2358 # This cannot be decided simply from looking at the target string,
2359 # as it might depend on externally passed compiler options like -m64.
2360 gdb_caching_proc is_64_target {
2361 set me "is_64_target"
2363 set src [standard_temp_file is64[pid].c]
2364 set obj [standard_temp_file is64[pid].o]
2366 gdb_produce_source $src {
2367 int function(void) { return 3; }
2368 int dummy[sizeof (&function) == 8 ? 1 : -1];
2371 verbose "$me: compiling testfile $src" 2
2372 set lines [gdb_compile $src $obj object {quiet}]
2376 if ![string match "" $lines] then {
2377 verbose "$me: testfile compilation failed, returning 0" 2
2381 verbose "$me: returning 1" 2
2385 # Return 1 if target has x86_64 registers - either amd64 or x32.
2386 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2387 # just from the target string.
2388 gdb_caching_proc is_amd64_regs_target {
2389 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2393 set me "is_amd64_regs_target"
2395 set src [standard_temp_file reg64[pid].s]
2396 set obj [standard_temp_file reg64[pid].o]
2400 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2401 lappend list "\tincq %$reg"
2403 gdb_produce_source $src [join $list \n]
2405 verbose "$me: compiling testfile $src" 2
2406 set lines [gdb_compile $src $obj object {quiet}]
2410 if ![string match "" $lines] then {
2411 verbose "$me: testfile compilation failed, returning 0" 2
2415 verbose "$me: returning 1" 2
2419 # Return 1 if this target is an x86 or x86-64 with -m32.
2420 proc is_x86_like_target {} {
2421 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2424 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2427 # Return 1 if this target is an arm or aarch32 on aarch64.
2429 gdb_caching_proc is_aarch32_target {
2430 if { [istarget "arm*-*-*"] } {
2434 if { ![istarget "aarch64*-*-*"] } {
2438 set me "is_aarch32_target"
2440 set src [standard_temp_file aarch32[pid].s]
2441 set obj [standard_temp_file aarch32[pid].o]
2446 lappend list "\tmov $reg, $reg"
2448 gdb_produce_source $src [join $list \n]
2450 verbose "$me: compiling testfile $src" 2
2451 set lines [gdb_compile $src $obj object {quiet}]
2455 if ![string match "" $lines] then {
2456 verbose "$me: testfile compilation failed, returning 0" 2
2460 verbose "$me: returning 1" 2
2464 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2466 proc is_aarch64_target {} {
2467 if { ![istarget "aarch64*-*-*"] } {
2471 return [expr ![is_aarch32_target]]
2474 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2475 proc support_displaced_stepping {} {
2477 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2478 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2479 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2480 || [istarget "aarch64*-*-linux*"] } {
2487 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2488 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2490 gdb_caching_proc skip_altivec_tests {
2491 global srcdir subdir gdb_prompt inferior_exited_re
2493 set me "skip_altivec_tests"
2495 # Some simulators are known to not support VMX instructions.
2496 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2497 verbose "$me: target known to not support VMX, returning 1" 2
2501 # Make sure we have a compiler that understands altivec.
2502 set compile_flags {debug nowarnings}
2503 if [get_compiler_info] {
2504 warning "Could not get compiler info"
2507 if [test_compiler_info gcc*] {
2508 set compile_flags "$compile_flags additional_flags=-maltivec"
2509 } elseif [test_compiler_info xlc*] {
2510 set compile_flags "$compile_flags additional_flags=-qaltivec"
2512 verbose "Could not compile with altivec support, returning 1" 2
2516 # Set up, compile, and execute a test program containing VMX instructions.
2517 # Include the current process ID in the file names to prevent conflicts
2518 # with invocations for multiple testsuites.
2519 set src [standard_temp_file vmx[pid].c]
2520 set exe [standard_temp_file vmx[pid].x]
2522 gdb_produce_source $src {
2525 asm volatile ("vor v0,v0,v0");
2527 asm volatile ("vor 0,0,0");
2533 verbose "$me: compiling testfile $src" 2
2534 set lines [gdb_compile $src $exe executable $compile_flags]
2537 if ![string match "" $lines] then {
2538 verbose "$me: testfile compilation failed, returning 1" 2
2542 # No error message, compilation succeeded so now run it via gdb.
2546 gdb_reinitialize_dir $srcdir/$subdir
2550 -re ".*Illegal instruction.*${gdb_prompt} $" {
2551 verbose -log "\n$me altivec hardware not detected"
2552 set skip_vmx_tests 1
2554 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2555 verbose -log "\n$me: altivec hardware detected"
2556 set skip_vmx_tests 0
2559 warning "\n$me: default case taken"
2560 set skip_vmx_tests 1
2564 remote_file build delete $exe
2566 verbose "$me: returning $skip_vmx_tests" 2
2567 return $skip_vmx_tests
2570 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2571 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2573 gdb_caching_proc skip_vsx_tests {
2574 global srcdir subdir gdb_prompt inferior_exited_re
2576 set me "skip_vsx_tests"
2578 # Some simulators are known to not support Altivec instructions, so
2579 # they won't support VSX instructions as well.
2580 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2581 verbose "$me: target known to not support VSX, returning 1" 2
2585 # Make sure we have a compiler that understands altivec.
2586 set compile_flags {debug nowarnings quiet}
2587 if [get_compiler_info] {
2588 warning "Could not get compiler info"
2591 if [test_compiler_info gcc*] {
2592 set compile_flags "$compile_flags additional_flags=-mvsx"
2593 } elseif [test_compiler_info xlc*] {
2594 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2596 verbose "Could not compile with vsx support, returning 1" 2
2600 set src [standard_temp_file vsx[pid].c]
2601 set exe [standard_temp_file vsx[pid].x]
2603 gdb_produce_source $src {
2605 double a[2] = { 1.0, 2.0 };
2607 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2609 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2615 verbose "$me: compiling testfile $src" 2
2616 set lines [gdb_compile $src $exe executable $compile_flags]
2619 if ![string match "" $lines] then {
2620 verbose "$me: testfile compilation failed, returning 1" 2
2624 # No error message, compilation succeeded so now run it via gdb.
2628 gdb_reinitialize_dir $srcdir/$subdir
2632 -re ".*Illegal instruction.*${gdb_prompt} $" {
2633 verbose -log "\n$me VSX hardware not detected"
2634 set skip_vsx_tests 1
2636 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2637 verbose -log "\n$me: VSX hardware detected"
2638 set skip_vsx_tests 0
2641 warning "\n$me: default case taken"
2642 set skip_vsx_tests 1
2646 remote_file build delete $exe
2648 verbose "$me: returning $skip_vsx_tests" 2
2649 return $skip_vsx_tests
2652 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2653 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2655 gdb_caching_proc skip_tsx_tests {
2656 global srcdir subdir gdb_prompt inferior_exited_re
2658 set me "skip_tsx_tests"
2660 set src [standard_temp_file tsx[pid].c]
2661 set exe [standard_temp_file tsx[pid].x]
2663 gdb_produce_source $src {
2665 asm volatile ("xbegin .L0");
2666 asm volatile ("xend");
2667 asm volatile (".L0: nop");
2672 verbose "$me: compiling testfile $src" 2
2673 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2676 if ![string match "" $lines] then {
2677 verbose "$me: testfile compilation failed." 2
2681 # No error message, compilation succeeded so now run it via gdb.
2685 gdb_reinitialize_dir $srcdir/$subdir
2689 -re ".*Illegal instruction.*${gdb_prompt} $" {
2690 verbose -log "$me: TSX hardware not detected."
2691 set skip_tsx_tests 1
2693 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2694 verbose -log "$me: TSX hardware detected."
2695 set skip_tsx_tests 0
2698 warning "\n$me: default case taken."
2699 set skip_tsx_tests 1
2703 remote_file build delete $exe
2705 verbose "$me: returning $skip_tsx_tests" 2
2706 return $skip_tsx_tests
2709 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2710 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2712 gdb_caching_proc skip_btrace_tests {
2713 global srcdir subdir gdb_prompt inferior_exited_re
2715 set me "skip_btrace_tests"
2716 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2717 verbose "$me: target does not support btrace, returning 1" 2
2721 # Set up, compile, and execute a test program.
2722 # Include the current process ID in the file names to prevent conflicts
2723 # with invocations for multiple testsuites.
2724 set src [standard_temp_file btrace[pid].c]
2725 set exe [standard_temp_file btrace[pid].x]
2727 gdb_produce_source $src {
2728 int main(void) { return 0; }
2731 verbose "$me: compiling testfile $src" 2
2732 set compile_flags {debug nowarnings quiet}
2733 set lines [gdb_compile $src $exe executable $compile_flags]
2735 if ![string match "" $lines] then {
2736 verbose "$me: testfile compilation failed, returning 1" 2
2741 # No error message, compilation succeeded so now run it via gdb.
2745 gdb_reinitialize_dir $srcdir/$subdir
2752 # In case of an unexpected output, we return 2 as a fail value.
2753 set skip_btrace_tests 2
2754 gdb_test_multiple "record btrace" "check btrace support" {
2755 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2756 set skip_btrace_tests 1
2758 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2759 set skip_btrace_tests 1
2761 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2762 set skip_btrace_tests 1
2764 -re "^record btrace\r\n$gdb_prompt $" {
2765 set skip_btrace_tests 0
2769 remote_file build delete $exe
2771 verbose "$me: returning $skip_btrace_tests" 2
2772 return $skip_btrace_tests
2775 # Run a test on the target to see if it supports btrace pt hardware.
2776 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2777 # from the GCC testsuite.
2779 gdb_caching_proc skip_btrace_pt_tests {
2780 global srcdir subdir gdb_prompt inferior_exited_re
2782 set me "skip_btrace_tests"
2783 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2784 verbose "$me: target does not support btrace, returning 1" 2
2788 # Set up, compile, and execute a test program.
2789 # Include the current process ID in the file names to prevent conflicts
2790 # with invocations for multiple testsuites.
2791 set src [standard_temp_file btrace[pid].c]
2792 set exe [standard_temp_file btrace[pid].x]
2794 gdb_produce_source $src {
2795 int main(void) { return 0; }
2798 verbose "$me: compiling testfile $src" 2
2799 set compile_flags {debug nowarnings quiet}
2800 set lines [gdb_compile $src $exe executable $compile_flags]
2802 if ![string match "" $lines] then {
2803 verbose "$me: testfile compilation failed, returning 1" 2
2808 # No error message, compilation succeeded so now run it via gdb.
2812 gdb_reinitialize_dir $srcdir/$subdir
2819 # In case of an unexpected output, we return 2 as a fail value.
2820 set skip_btrace_tests 2
2821 gdb_test_multiple "record btrace pt" "check btrace support" {
2822 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2823 set skip_btrace_tests 1
2825 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2826 set skip_btrace_tests 1
2828 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2829 set skip_btrace_tests 1
2831 -re "GDB does not support.*\r\n$gdb_prompt $" {
2832 set skip_btrace_tests 1
2834 -re "^record btrace pt\r\n$gdb_prompt $" {
2835 set skip_btrace_tests 0
2839 remote_file build delete $exe
2841 verbose "$me: returning $skip_btrace_tests" 2
2842 return $skip_btrace_tests
2845 # Return whether we should skip tests for showing inlined functions in
2846 # backtraces. Requires get_compiler_info and get_debug_format.
2848 proc skip_inline_frame_tests {} {
2849 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2850 if { ! [test_debug_format "DWARF 2"] } {
2854 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2855 if { ([test_compiler_info "gcc-2-*"]
2856 || [test_compiler_info "gcc-3-*"]
2857 || [test_compiler_info "gcc-4-0-*"]) } {
2864 # Return whether we should skip tests for showing variables from
2865 # inlined functions. Requires get_compiler_info and get_debug_format.
2867 proc skip_inline_var_tests {} {
2868 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2869 if { ! [test_debug_format "DWARF 2"] } {
2876 # Return a 1 if we should skip tests that require hardware breakpoints
2878 proc skip_hw_breakpoint_tests {} {
2879 # Skip tests if requested by the board (note that no_hardware_watchpoints
2880 # disables both watchpoints and breakpoints)
2881 if { [target_info exists gdb,no_hardware_watchpoints]} {
2885 # These targets support hardware breakpoints natively
2886 if { [istarget "i?86-*-*"]
2887 || [istarget "x86_64-*-*"]
2888 || [istarget "ia64-*-*"]
2889 || [istarget "arm*-*-*"]
2890 || [istarget "aarch64*-*-*"]} {
2897 # Return a 1 if we should skip tests that require hardware watchpoints
2899 proc skip_hw_watchpoint_tests {} {
2900 # Skip tests if requested by the board
2901 if { [target_info exists gdb,no_hardware_watchpoints]} {
2905 # These targets support hardware watchpoints natively
2906 if { [istarget "i?86-*-*"]
2907 || [istarget "x86_64-*-*"]
2908 || [istarget "ia64-*-*"]
2909 || [istarget "arm*-*-*"]
2910 || [istarget "aarch64*-*-*"]
2911 || [istarget "powerpc*-*-linux*"]
2912 || [istarget "s390*-*-*"] } {
2919 # Return a 1 if we should skip tests that require *multiple* hardware
2920 # watchpoints to be active at the same time
2922 proc skip_hw_watchpoint_multi_tests {} {
2923 if { [skip_hw_watchpoint_tests] } {
2927 # These targets support just a single hardware watchpoint
2928 if { [istarget "arm*-*-*"]
2929 || [istarget "powerpc*-*-linux*"] } {
2936 # Return a 1 if we should skip tests that require read/access watchpoints
2938 proc skip_hw_watchpoint_access_tests {} {
2939 if { [skip_hw_watchpoint_tests] } {
2943 # These targets support just write watchpoints
2944 if { [istarget "s390*-*-*"] } {
2951 # Return 1 if we should skip tests that require the runtime unwinder
2952 # hook. This must be invoked while gdb is running, after shared
2953 # libraries have been loaded. This is needed because otherwise a
2954 # shared libgcc won't be visible.
2956 proc skip_unwinder_tests {} {
2960 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2961 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2963 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2966 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2970 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2971 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2974 -re "\r\n$gdb_prompt $" {
2981 # Return 0 if we should skip tests that require the libstdc++ stap
2982 # probes. This must be invoked while gdb is running, after shared
2983 # libraries have been loaded.
2985 proc skip_libstdcxx_probe_tests {} {
2989 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2990 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2993 -re "\r\n$gdb_prompt $" {
2999 # Return 1 if we should skip tests of the "compile" feature.
3000 # This must be invoked after the inferior has been started.
3002 proc skip_compile_feature_tests {} {
3006 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3007 "Could not load libcc1.*\r\n$gdb_prompt $" {
3010 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3013 -re "\r\n$gdb_prompt $" {
3019 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3022 proc gdb_is_target_remote_prompt { prompt_regexp } {
3024 set test "probe for target remote"
3025 gdb_test_multiple "maint print target-stack" $test {
3026 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3030 -re "$prompt_regexp" {
3037 # Check whether we're testing with the remote or extended-remote
3040 proc gdb_is_target_remote {} {
3043 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3046 # Return 1 if the current remote target is an instance of our GDBserver, 0
3047 # otherwise. Return -1 if there was an error and we can't tell.
3049 gdb_caching_proc target_is_gdbserver {
3053 set test "Probing for GDBserver"
3055 gdb_test_multiple "monitor help" $test {
3056 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3059 -re "$gdb_prompt $" {
3064 if { $is_gdbserver == -1 } {
3065 verbose -log "Unable to tell whether we are using GDBserver or not."
3068 return $is_gdbserver
3071 # N.B. compiler_info is intended to be local to this file.
3072 # Call test_compiler_info with no arguments to fetch its value.
3073 # Yes, this is counterintuitive when there's get_compiler_info,
3074 # but that's the current API.
3075 if [info exists compiler_info] {
3081 # Figure out what compiler I am using.
3082 # The result is cached so only the first invocation runs the compiler.
3084 # ARG can be empty or "C++". If empty, "C" is assumed.
3086 # There are several ways to do this, with various problems.
3088 # [ gdb_compile -E $ifile -o $binfile.ci ]
3089 # source $binfile.ci
3091 # Single Unix Spec v3 says that "-E -o ..." together are not
3092 # specified. And in fact, the native compiler on hp-ux 11 (among
3093 # others) does not work with "-E -o ...". Most targets used to do
3094 # this, and it mostly worked, because it works with gcc.
3096 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3097 # source $binfile.ci
3099 # This avoids the problem with -E and -o together. This almost works
3100 # if the build machine is the same as the host machine, which is
3101 # usually true of the targets which are not gcc. But this code does
3102 # not figure which compiler to call, and it always ends up using the C
3103 # compiler. Not good for setting hp_aCC_compiler. Target
3104 # hppa*-*-hpux* used to do this.
3106 # [ gdb_compile -E $ifile > $binfile.ci ]
3107 # source $binfile.ci
3109 # dejagnu target_compile says that it supports output redirection,
3110 # but the code is completely different from the normal path and I
3111 # don't want to sweep the mines from that path. So I didn't even try
3114 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3117 # I actually do this for all targets now. gdb_compile runs the right
3118 # compiler, and TCL captures the output, and I eval the output.
3120 # Unfortunately, expect logs the output of the command as it goes by,
3121 # and dejagnu helpfully prints a second copy of it right afterwards.
3122 # So I turn off expect logging for a moment.
3124 # [ gdb_compile $ifile $ciexe_file executable $args ]
3125 # [ remote_exec $ciexe_file ]
3126 # [ source $ci_file.out ]
3128 # I could give up on -E and just do this.
3129 # I didn't get desperate enough to try this.
3131 # -- chastain 2004-01-06
3133 proc get_compiler_info {{arg ""}} {
3134 # For compiler.c and compiler.cc
3137 # I am going to play with the log to keep noise out.
3141 # These come from compiler.c or compiler.cc
3142 global compiler_info
3144 # Legacy global data symbols.
3147 if [info exists compiler_info] {
3152 # Choose which file to preprocess.
3153 set ifile "${srcdir}/lib/compiler.c"
3154 if { $arg == "c++" } {
3155 set ifile "${srcdir}/lib/compiler.cc"
3158 # Run $ifile through the right preprocessor.
3159 # Toggle gdb.log to keep the compiler output out of the log.
3160 set saved_log [log_file -info]
3162 if [is_remote host] {
3163 # We have to use -E and -o together, despite the comments
3164 # above, because of how DejaGnu handles remote host testing.
3165 set ppout "$outdir/compiler.i"
3166 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3167 set file [open $ppout r]
3168 set cppout [read $file]
3171 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3173 eval log_file $saved_log
3177 foreach cppline [ split "$cppout" "\n" ] {
3178 if { [ regexp "^#" "$cppline" ] } {
3180 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3182 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3184 verbose "get_compiler_info: $cppline" 2
3188 verbose -log "get_compiler_info: $cppline"
3193 # Set to unknown if for some reason compiler_info didn't get defined.
3194 if ![info exists compiler_info] {
3195 verbose -log "get_compiler_info: compiler_info not provided"
3196 set compiler_info "unknown"
3198 # Also set to unknown compiler if any diagnostics happened.
3200 verbose -log "get_compiler_info: got unexpected diagnostics"
3201 set compiler_info "unknown"
3204 # Set the legacy symbols.
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 }
3212 # Log what happened.
3213 verbose -log "get_compiler_info: $compiler_info"
3215 # Most compilers will evaluate comparisons and other boolean
3216 # operations to 0 or 1.
3217 uplevel \#0 { set true 1 }
3218 uplevel \#0 { set false 0 }
3223 # Return the compiler_info string if no arg is provided.
3224 # Otherwise the argument is a glob-style expression to match against
3227 proc test_compiler_info { {compiler ""} } {
3228 global compiler_info
3231 # If no arg, return the compiler_info string.
3232 if [string match "" $compiler] {
3233 return $compiler_info
3236 return [string match $compiler $compiler_info]
3239 proc current_target_name { } {
3241 if [info exists target_info(target,name)] {
3242 set answer $target_info(target,name)
3249 set gdb_wrapper_initialized 0
3250 set gdb_wrapper_target ""
3252 proc gdb_wrapper_init { args } {
3253 global gdb_wrapper_initialized
3254 global gdb_wrapper_file
3255 global gdb_wrapper_flags
3256 global gdb_wrapper_target
3258 if { $gdb_wrapper_initialized == 1 } { return; }
3260 if {[target_info exists needs_status_wrapper] && \
3261 [target_info needs_status_wrapper] != "0"} {
3262 set result [build_wrapper "testglue.o"]
3263 if { $result != "" } {
3264 set gdb_wrapper_file [lindex $result 0]
3265 set gdb_wrapper_flags [lindex $result 1]
3267 warning "Status wrapper failed to build."
3270 set gdb_wrapper_initialized 1
3271 set gdb_wrapper_target [current_target_name]
3274 # Some targets need to always link a special object in. Save its path here.
3275 global gdb_saved_set_unbuffered_mode_obj
3276 set gdb_saved_set_unbuffered_mode_obj ""
3278 # Compile source files specified by SOURCE into a binary of type TYPE at path
3279 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3280 # parameter and most options are passed directly to it.
3282 # The type can be one of the following:
3284 # - object: Compile into an object file.
3285 # - executable: Compile and link into an executable.
3286 # - preprocess: Preprocess the source files.
3287 # - assembly: Generate assembly listing.
3289 # The following options are understood and processed by gdb_compile:
3291 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3292 # quirks to be able to use shared libraries.
3293 # - shlib_load: Link with appropriate libraries to allow the test to
3294 # dynamically load libraries at runtime. For example, on Linux, this adds
3295 # -ldl so that the test can use dlopen.
3296 # - nowarnings: Inhibit all compiler warnings.
3298 # And here are some of the not too obscure options understood by DejaGnu that
3299 # influence the compilation:
3301 # - additional_flags=flag: Add FLAG to the compiler flags.
3302 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3303 # argument can be a file, in which case it's added to the sources, or a
3305 # - ldflags=flag: Add FLAG to the linker flags.
3306 # - incdir=path: Add PATH to the searched include directories.
3307 # - libdir=path: Add PATH to the linker searched directories.
3308 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3309 # - debug: Build with debug information.
3310 # - optimize: Build with optimization.
3312 proc gdb_compile {source dest type options} {
3313 global GDB_TESTCASE_OPTIONS
3314 global gdb_wrapper_file
3315 global gdb_wrapper_flags
3316 global gdb_wrapper_initialized
3319 global gdb_saved_set_unbuffered_mode_obj
3321 set outdir [file dirname $dest]
3323 # Add platform-specific options if a shared library was specified using
3324 # "shlib=librarypath" in OPTIONS.
3328 foreach opt $options {
3329 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3330 if [test_compiler_info "xlc-*"] {
3331 # IBM xlc compiler doesn't accept shared library named other
3332 # than .so: use "-Wl," to bypass this
3333 lappend source "-Wl,$shlib_name"
3334 } elseif { ([istarget "*-*-mingw*"]
3335 || [istarget *-*-cygwin*]
3336 || [istarget *-*-pe*])} {
3337 lappend source "${shlib_name}.a"
3339 lappend source $shlib_name
3341 if { $shlib_found == 0 } {
3343 if { ([istarget "*-*-mingw*"]
3344 || [istarget *-*-cygwin*]) } {
3345 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3347 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3348 # Undo debian's change in the default.
3349 # Put it at the front to not override any user-provided
3350 # value, and to make sure it appears in front of all the
3352 lappend new_options "early_flags=-Wl,--no-as-needed"
3355 } elseif { $opt == "shlib_load" } {
3358 lappend new_options $opt
3362 # We typically link to shared libraries using an absolute path, and
3363 # that's how they are found at runtime. If we are going to
3364 # dynamically load one by basename, we must specify rpath. If we
3365 # are using a remote host, DejaGNU will link to the shared library
3366 # using a relative path, so again we must specify an rpath.
3367 if { $shlib_load || ($shlib_found && [is_remote target]) } {
3368 if { ([istarget "*-*-mingw*"]
3369 || [istarget *-*-cygwin*]
3370 || [istarget *-*-pe*]) } {
3371 # Do not need anything.
3372 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3373 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3374 } elseif { [istarget arm*-*-symbianelf*] } {
3375 if { $shlib_load } {
3376 lappend new_options "libs=-ldl"
3379 if { $shlib_load } {
3380 lappend new_options "libs=-ldl"
3382 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3385 set options $new_options
3387 if [info exists GDB_TESTCASE_OPTIONS] {
3388 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3390 verbose "options are $options"
3391 verbose "source is $source $dest $type $options"
3393 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3395 if {[target_info exists needs_status_wrapper] && \
3396 [target_info needs_status_wrapper] != "0" && \
3397 [info exists gdb_wrapper_file]} {
3398 lappend options "libs=${gdb_wrapper_file}"
3399 lappend options "ldflags=${gdb_wrapper_flags}"
3402 # Replace the "nowarnings" option with the appropriate additional_flags
3403 # to disable compiler warnings.
3404 set nowarnings [lsearch -exact $options nowarnings]
3405 if {$nowarnings != -1} {
3406 if [target_info exists gdb,nowarnings_flag] {
3407 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3409 set flag "additional_flags=-w"
3411 set options [lreplace $options $nowarnings $nowarnings $flag]
3414 if { $type == "executable" } {
3415 if { ([istarget "*-*-mingw*"]
3416 || [istarget "*-*-*djgpp"]
3417 || [istarget "*-*-cygwin*"])} {
3418 # Force output to unbuffered mode, by linking in an object file
3419 # with a global contructor that calls setvbuf.
3421 # Compile the special object seperatelly for two reasons:
3422 # 1) Insulate it from $options.
3423 # 2) Avoid compiling it for every gdb_compile invocation,
3424 # which is time consuming, especially if we're remote
3427 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3428 verbose "compiling gdb_saved_set_unbuffered_obj"
3429 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3430 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3432 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3433 if { $result != "" } {
3436 if {[is_remote host]} {
3437 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3439 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3441 # Link a copy of the output object, because the
3442 # original may be automatically deleted.
3443 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3445 verbose "gdb_saved_set_unbuffered_obj already compiled"
3448 # Rely on the internal knowledge that the global ctors are ran in
3449 # reverse link order. In that case, we can use ldflags to
3450 # avoid copying the object file to the host multiple
3452 # This object can only be added if standard libraries are
3453 # used. Thus, we need to disable it if -nostdlib option is used
3454 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3455 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3460 set result [target_compile $source $dest $type $options]
3462 # Prune uninteresting compiler (and linker) output.
3463 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3465 regsub "\[\r\n\]*$" "$result" "" result
3466 regsub "^\[\r\n\]*" "$result" "" result
3468 if {[lsearch $options quiet] < 0} {
3469 # We shall update this on a per language basis, to avoid
3470 # changing the entire testsuite in one go.
3471 if {[lsearch $options f77] >= 0} {
3472 gdb_compile_test $source $result
3473 } elseif { $result != "" } {
3474 clone_output "gdb compile failed, $result"
3481 # This is just like gdb_compile, above, except that it tries compiling
3482 # against several different thread libraries, to see which one this
3484 proc gdb_compile_pthreads {source dest type options} {
3486 set why_msg "unrecognized error"
3487 foreach lib {-lpthreads -lpthread -lthread ""} {
3488 # This kind of wipes out whatever libs the caller may have
3489 # set. Or maybe theirs will override ours. How infelicitous.
3490 set options_with_lib [concat $options [list libs=$lib quiet]]
3491 set ccout [gdb_compile $source $dest $type $options_with_lib]
3492 switch -regexp -- $ccout {
3493 ".*no posix threads support.*" {
3494 set why_msg "missing threads include file"
3497 ".*cannot open -lpthread.*" {
3498 set why_msg "missing runtime threads library"
3500 ".*Can't find library for -lpthread.*" {
3501 set why_msg "missing runtime threads library"
3504 pass "successfully compiled posix threads test case"
3510 if {!$built_binfile} {
3511 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3516 # Build a shared library from SOURCES.
3518 proc gdb_compile_shlib {sources dest options} {
3519 set obj_options $options
3522 if { [lsearch -exact $options "c++"] >= 0 } {
3523 set info_options "c++"
3525 if [get_compiler_info ${info_options}] {
3529 switch -glob [test_compiler_info] {
3531 lappend obj_options "additional_flags=-qpic"
3534 if { !([istarget "*-*-cygwin*"]
3535 || [istarget "*-*-mingw*"]) } {
3536 lappend obj_options "additional_flags=-fpic"
3540 if { !([istarget "powerpc*-*-aix*"]
3541 || [istarget "rs6000*-*-aix*"]
3542 || [istarget "*-*-cygwin*"]
3543 || [istarget "*-*-mingw*"]
3544 || [istarget "*-*-pe*"]) } {
3545 lappend obj_options "additional_flags=-fpic"
3549 # don't know what the compiler is...
3553 set outdir [file dirname $dest]
3555 foreach source $sources {
3556 set sourcebase [file tail $source]
3557 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3560 lappend objects ${outdir}/${sourcebase}.o
3563 set link_options $options
3564 if [test_compiler_info "xlc-*"] {
3565 lappend link_options "additional_flags=-qmkshrobj"
3567 lappend link_options "additional_flags=-shared"
3569 if { ([istarget "*-*-mingw*"]
3570 || [istarget *-*-cygwin*]
3571 || [istarget *-*-pe*]) } {
3572 if { [is_remote host] } {
3573 set name [file tail ${dest}]
3577 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3578 } elseif [is_remote target] {
3579 # By default, we do not set the soname. This causes the linker
3580 # on ELF systems to create a DT_NEEDED entry in the executable
3581 # refering to the full path name of the library. This is a
3582 # problem in remote testing if the library is in a different
3583 # directory there. To fix this, we set a soname of just the
3584 # base filename for the library, and add an appropriate -rpath
3585 # to the main executable (in gdb_compile).
3586 set destbase [file tail $dest]
3587 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3590 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3593 if { [is_remote host]
3594 && ([istarget "*-*-mingw*"]
3595 || [istarget *-*-cygwin*]
3596 || [istarget *-*-pe*]) } {
3597 set dest_tail_name [file tail ${dest}]
3598 remote_upload host $dest_tail_name.a ${dest}.a
3599 remote_file host delete $dest_tail_name.a
3605 # This is just like gdb_compile_shlib, above, except that it tries compiling
3606 # against several different thread libraries, to see which one this
3608 proc gdb_compile_shlib_pthreads {sources dest options} {
3610 set why_msg "unrecognized error"
3611 foreach lib {-lpthreads -lpthread -lthread ""} {
3612 # This kind of wipes out whatever libs the caller may have
3613 # set. Or maybe theirs will override ours. How infelicitous.
3614 set options_with_lib [concat $options [list libs=$lib quiet]]
3615 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3616 switch -regexp -- $ccout {
3617 ".*no posix threads support.*" {
3618 set why_msg "missing threads include file"
3621 ".*cannot open -lpthread.*" {
3622 set why_msg "missing runtime threads library"
3624 ".*Can't find library for -lpthread.*" {
3625 set why_msg "missing runtime threads library"
3628 pass "successfully compiled posix threads test case"
3634 if {!$built_binfile} {
3635 unsupported "Couldn't compile $sources: ${why_msg}"
3640 # This is just like gdb_compile_pthreads, above, except that we always add the
3641 # objc library for compiling Objective-C programs
3642 proc gdb_compile_objc {source dest type options} {
3644 set why_msg "unrecognized error"
3645 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3646 # This kind of wipes out whatever libs the caller may have
3647 # set. Or maybe theirs will override ours. How infelicitous.
3648 if { $lib == "solaris" } {
3649 set lib "-lpthread -lposix4"
3651 if { $lib != "-lobjc" } {
3652 set lib "-lobjc $lib"
3654 set options_with_lib [concat $options [list libs=$lib quiet]]
3655 set ccout [gdb_compile $source $dest $type $options_with_lib]
3656 switch -regexp -- $ccout {
3657 ".*no posix threads support.*" {
3658 set why_msg "missing threads include file"
3661 ".*cannot open -lpthread.*" {
3662 set why_msg "missing runtime threads library"
3664 ".*Can't find library for -lpthread.*" {
3665 set why_msg "missing runtime threads library"
3668 pass "successfully compiled objc with posix threads test case"
3674 if {!$built_binfile} {
3675 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3680 proc send_gdb { string } {
3681 global suppress_flag
3682 if { $suppress_flag } {
3685 return [remote_send host "$string"]
3688 # Send STRING to the inferior's terminal.
3690 proc send_inferior { string } {
3691 global inferior_spawn_id
3693 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3703 proc gdb_expect { args } {
3704 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3705 set atimeout [lindex $args 0]
3706 set expcode [list [lindex $args 1]]
3711 # A timeout argument takes precedence, otherwise of all the timeouts
3712 # select the largest.
3713 if [info exists atimeout] {
3716 set tmt [get_largest_timeout]
3719 global suppress_flag
3720 global remote_suppress_flag
3721 if [info exists remote_suppress_flag] {
3722 set old_val $remote_suppress_flag
3724 if [info exists suppress_flag] {
3725 if { $suppress_flag } {
3726 set remote_suppress_flag 1
3730 {uplevel remote_expect host $tmt $expcode} string]
3731 if [info exists old_val] {
3732 set remote_suppress_flag $old_val
3734 if [info exists remote_suppress_flag] {
3735 unset remote_suppress_flag
3740 global errorInfo errorCode
3742 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3744 return -code $code $string
3748 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3750 # Check for long sequence of output by parts.
3751 # TEST: is the test message to be printed with the test success/fail.
3752 # SENTINEL: Is the terminal pattern indicating that output has finished.
3753 # LIST: is the sequence of outputs to match.
3754 # If the sentinel is recognized early, it is considered an error.
3757 # 1 if the test failed,
3758 # 0 if the test passes,
3759 # -1 if there was an internal error.
3761 proc gdb_expect_list {test sentinel list} {
3763 global suppress_flag
3766 if { $suppress_flag } {
3768 unresolved "${test}"
3770 while { ${index} < [llength ${list}] } {
3771 set pattern [lindex ${list} ${index}]
3772 set index [expr ${index} + 1]
3773 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3774 if { ${index} == [llength ${list}] } {
3777 -re "${pattern}${sentinel}" {
3778 # pass "${test}, pattern ${index} + sentinel"
3781 fail "${test} (pattern ${index} + sentinel)"
3784 -re ".*A problem internal to GDB has been detected" {
3785 fail "${test} (GDB internal error)"
3787 gdb_internal_error_resync
3790 fail "${test} (pattern ${index} + sentinel) (timeout)"
3795 # unresolved "${test}, pattern ${index} + sentinel"
3801 # pass "${test}, pattern ${index}"
3804 fail "${test} (pattern ${index})"
3807 -re ".*A problem internal to GDB has been detected" {
3808 fail "${test} (GDB internal error)"
3810 gdb_internal_error_resync
3813 fail "${test} (pattern ${index}) (timeout)"
3818 # unresolved "${test}, pattern ${index}"
3832 proc gdb_suppress_entire_file { reason } {
3833 global suppress_flag
3836 set suppress_flag -1
3840 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3841 # gdb_expect to fail immediately (until the next call to
3842 # gdb_stop_suppressing_tests).
3844 proc gdb_suppress_tests { args } {
3845 global suppress_flag
3847 return; # fnf - disable pending review of results where
3848 # testsuite ran better without this
3851 if { $suppress_flag == 1 } {
3852 if { [llength $args] > 0 } {
3853 warning "[lindex $args 0]\n"
3855 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3861 # Clear suppress_flag.
3863 proc gdb_stop_suppressing_tests { } {
3864 global suppress_flag
3866 if [info exists suppress_flag] {
3867 if { $suppress_flag > 0 } {
3869 clone_output "Tests restarted.\n"
3876 proc gdb_clear_suppressed { } {
3877 global suppress_flag
3882 # Spawn the gdb process.
3884 # This doesn't expect any output or do any other initialization,
3885 # leaving those to the caller.
3887 # Overridable function -- you can override this function in your
3890 proc gdb_spawn { } {
3894 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3896 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3899 set saved_gdbflags $GDBFLAGS
3901 if {$GDBFLAGS != ""} {
3904 append GDBFLAGS $cmdline_flags
3908 set GDBFLAGS $saved_gdbflags
3913 # Start gdb running, wait for prompt, and disable the pagers.
3915 # Overridable function -- you can override this function in your
3918 proc gdb_start { } {
3923 catch default_gdb_exit
3926 # Return true if we can spawn a program on the target and attach to
3929 proc can_spawn_for_attach { } {
3930 # We use exp_pid to get the inferior's pid, assuming that gives
3931 # back the pid of the program. On remote boards, that would give
3932 # us instead the PID of e.g., the ssh client, etc.
3933 if [is_remote target] then {
3937 # The "attach" command doesn't make sense when the target is
3938 # stub-like, where GDB finds the program already started on
3939 # initial connection.
3940 if {[target_info exists use_gdb_stub]} {
3948 # Kill a progress previously started with spawn_wait_for_attach, and
3949 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
3952 proc kill_wait_spawned_process { proc_spawn_id } {
3953 set pid [exp_pid -i $proc_spawn_id]
3955 verbose -log "killing ${pid}"
3956 remote_exec build "kill -9 ${pid}"
3958 verbose -log "closing ${proc_spawn_id}"
3959 catch "close -i $proc_spawn_id"
3960 verbose -log "waiting for ${proc_spawn_id}"
3962 # If somehow GDB ends up still attached to the process here, a
3963 # blocking wait hangs until gdb is killed (or until gdb / the
3964 # ptracer reaps the exit status too, but that won't happen because
3965 # something went wrong.) Passing -nowait makes expect tell Tcl to
3966 # wait for the PID in the background. That's fine because we
3967 # don't care about the exit status. */
3968 wait -nowait -i $proc_spawn_id
3971 # Returns the process id corresponding to the given spawn id.
3973 proc spawn_id_get_pid { spawn_id } {
3974 set testpid [exp_pid -i $spawn_id]
3976 if { [istarget "*-*-cygwin*"] } {
3977 # testpid is the Cygwin PID, GDB uses the Windows PID, which
3978 # might be different due to the way fork/exec works.
3979 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
3985 # Start a set of programs running and then wait for a bit, to be sure
3986 # that they can be attached to. Return a list of processes spawn IDs,
3987 # one element for each process spawned. It's a test error to call
3988 # this when [can_spawn_for_attach] is false.
3990 proc spawn_wait_for_attach { executable_list } {
3991 set spawn_id_list {}
3993 if ![can_spawn_for_attach] {
3994 # The caller should have checked can_spawn_for_attach itself
3995 # before getting here.
3996 error "can't spawn for attach with this target/board"
3999 foreach {executable} $executable_list {
4000 # Note we use Expect's spawn, not Tcl's exec, because with
4001 # spawn we control when to wait for/reap the process. That
4002 # allows killing the process by PID without being subject to
4004 lappend spawn_id_list [remote_spawn target $executable]
4009 return $spawn_id_list
4013 # gdb_load_cmd -- load a file into the debugger.
4014 # ARGS - additional args to load command.
4015 # return a -1 if anything goes wrong.
4017 proc gdb_load_cmd { args } {
4020 if [target_info exists gdb_load_timeout] {
4021 set loadtimeout [target_info gdb_load_timeout]
4023 set loadtimeout 1600
4025 send_gdb "load $args\n"
4026 verbose "Timeout is now $loadtimeout seconds" 2
4027 gdb_expect $loadtimeout {
4028 -re "Loading section\[^\r\]*\r\n" {
4031 -re "Start address\[\r\]*\r\n" {
4034 -re "Transfer rate\[\r\]*\r\n" {
4037 -re "Memory access error\[^\r\]*\r\n" {
4038 perror "Failed to load program"
4041 -re "$gdb_prompt $" {
4044 -re "(.*)\r\n$gdb_prompt " {
4045 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4049 perror "Timed out trying to load $args."
4056 # Invoke "gcore". CORE is the name of the core file to write. TEST
4057 # is the name of the test case. This will return 1 if the core file
4058 # was created, 0 otherwise. If this fails to make a core file because
4059 # this configuration of gdb does not support making core files, it
4060 # will call "unsupported", not "fail". However, if this fails to make
4061 # a core file for some other reason, then it will call "fail".
4063 proc gdb_gcore_cmd {core test} {
4067 gdb_test_multiple "gcore $core" $test {
4068 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4072 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4080 # Load core file CORE. TEST is the name of the test case.
4081 # This will record a pass/fail for loading the core file.
4083 # 1 - core file is successfully loaded
4084 # 0 - core file loaded but has a non fatal error
4085 # -1 - core file failed to load
4087 proc gdb_core_cmd { core test } {
4090 gdb_test_multiple "core $core" "$test" {
4091 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4094 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4095 fail "$test (bad file format)"
4098 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4099 fail "$test (file not found)"
4102 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4103 fail "$test (incomplete note section)"
4106 -re "Core was generated by .*\r\n$gdb_prompt $" {
4110 -re ".*$gdb_prompt $" {
4115 fail "$test (timeout)"
4119 fail "unsupported output from 'core' command"
4123 # Return the filename to download to the target and load on the target
4124 # for this shared library. Normally just LIBNAME, unless shared libraries
4125 # for this target have separate link and load images.
4127 proc shlib_target_file { libname } {
4131 # Return the filename GDB will load symbols from when debugging this
4132 # shared library. Normally just LIBNAME, unless shared libraries for
4133 # this target have separate link and load images.
4135 proc shlib_symbol_file { libname } {
4139 # Return the filename to download to the target and load for this
4140 # executable. Normally just BINFILE unless it is renamed to something
4141 # else for this target.
4143 proc exec_target_file { binfile } {
4147 # Return the filename GDB will load symbols from when debugging this
4148 # executable. Normally just BINFILE unless executables for this target
4149 # have separate files for symbols.
4151 proc exec_symbol_file { binfile } {
4155 # Rename the executable file. Normally this is just BINFILE1 being renamed
4156 # to BINFILE2, but some targets require multiple binary files.
4157 proc gdb_rename_execfile { binfile1 binfile2 } {
4158 file rename -force [exec_target_file ${binfile1}] \
4159 [exec_target_file ${binfile2}]
4160 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4161 file rename -force [exec_symbol_file ${binfile1}] \
4162 [exec_symbol_file ${binfile2}]
4166 # "Touch" the executable file to update the date. Normally this is just
4167 # BINFILE, but some targets require multiple files.
4168 proc gdb_touch_execfile { binfile } {
4169 set time [clock seconds]
4170 file mtime [exec_target_file ${binfile}] $time
4171 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4172 file mtime [exec_symbol_file ${binfile}] $time
4176 # Like remote_download but provides a gdb-specific behavior. If DEST
4177 # is "host", and the host is not remote, and TOFILE is not specified,
4178 # then the [file tail] of FROMFILE is passed through
4179 # standard_output_file to compute the destination.
4181 proc gdb_remote_download {dest fromfile {tofile {}}} {
4182 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
4183 set tofile [standard_output_file [file tail $fromfile]]
4186 if { $tofile == "" } {
4187 return [remote_download $dest $fromfile]
4189 return [remote_download $dest $fromfile $tofile]
4195 # Copy a file to the remote target and return its target filename.
4196 # Schedule the file to be deleted at the end of this test.
4198 proc gdb_download { filename } {
4201 set destname [remote_download target $filename]
4202 lappend cleanfiles $destname
4206 # gdb_load_shlibs LIB...
4208 # Copy the listed libraries to the target.
4210 proc gdb_load_shlibs { args } {
4211 if {![is_remote target]} {
4215 foreach file $args {
4216 gdb_download [shlib_target_file $file]
4219 # Even if the target supplies full paths for shared libraries,
4220 # they may not be paths for this system.
4221 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
4225 # gdb_load -- load a file into the debugger. Specifying no file
4226 # defaults to the executable currently being debugged.
4227 # The return value is 0 for success, -1 for failure.
4228 # Many files in config/*.exp override this procedure.
4230 proc gdb_load { arg } {
4232 return [gdb_file_cmd $arg]
4237 # gdb_reload -- load a file into the target. Called before "running",
4238 # either the first time or after already starting the program once,
4239 # for remote targets. Most files that override gdb_load should now
4240 # override this instead.
4242 proc gdb_reload { } {
4243 # For the benefit of existing configurations, default to gdb_load.
4244 # Specifying no file defaults to the executable currently being
4246 return [gdb_load ""]
4249 proc gdb_continue { function } {
4252 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4255 proc default_gdb_init { test_file_name } {
4256 global gdb_wrapper_initialized
4257 global gdb_wrapper_target
4258 global gdb_test_file_name
4264 gdb_clear_suppressed
4266 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4268 # Make sure that the wrapper is rebuilt
4269 # with the appropriate multilib option.
4270 if { $gdb_wrapper_target != [current_target_name] } {
4271 set gdb_wrapper_initialized 0
4274 # Unlike most tests, we have a small number of tests that generate
4275 # a very large amount of output. We therefore increase the expect
4276 # buffer size to be able to contain the entire test output. This
4277 # is especially needed by gdb.base/info-macros.exp.
4279 # Also set this value for the currently running GDB.
4280 match_max [match_max -d]
4282 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4283 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4286 if [target_info exists gdb_prompt] {
4287 set gdb_prompt [target_info gdb_prompt]
4289 set gdb_prompt "\\(gdb\\)"
4292 if [info exists use_gdb_stub] {
4297 # Return a path using GDB_PARALLEL.
4298 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4299 # GDB_PARALLEL must be defined, the caller must check.
4301 # The default value for GDB_PARALLEL is, canonically, ".".
4302 # The catch is that tests don't expect an additional "./" in file paths so
4303 # omit any directory for the default case.
4304 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4305 # its special handling.
4307 proc make_gdb_parallel_path { args } {
4308 global GDB_PARALLEL objdir
4309 set joiner [list "file" "join" $objdir]
4310 if { $GDB_PARALLEL != "yes" } {
4311 lappend joiner $GDB_PARALLEL
4313 set joiner [concat $joiner $args]
4314 return [eval $joiner]
4317 # Turn BASENAME into a full file name in the standard output
4318 # directory. It is ok if BASENAME is the empty string; in this case
4319 # the directory is returned.
4321 proc standard_output_file {basename} {
4322 global objdir subdir gdb_test_file_name GDB_PARALLEL
4324 if {[info exists GDB_PARALLEL]} {
4325 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4327 return [file join $dir $basename]
4329 return [file join $objdir $subdir $basename]
4333 # Return the name of a file in our standard temporary directory.
4335 proc standard_temp_file {basename} {
4336 global objdir GDB_PARALLEL
4338 if {[info exists GDB_PARALLEL]} {
4339 return [make_gdb_parallel_path temp $basename]
4345 # Set 'testfile', 'srcfile', and 'binfile'.
4347 # ARGS is a list of source file specifications.
4348 # Without any arguments, the .exp file's base name is used to
4349 # compute the source file name. The ".c" extension is added in this case.
4350 # If ARGS is not empty, each entry is a source file specification.
4351 # If the specification starts with a ".", it is treated as a suffix
4352 # to append to the .exp file's base name.
4353 # If the specification is the empty string, it is treated as if it
4355 # Otherwise it is a file name.
4356 # The first file in the list is used to set the 'srcfile' global.
4357 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4359 # Most tests should call this without arguments.
4361 # If a completely different binary file name is needed, then it
4362 # should be handled in the .exp file with a suitable comment.
4364 proc standard_testfile {args} {
4365 global gdb_test_file_name
4367 global gdb_test_file_last_vars
4370 global testfile binfile
4372 set testfile $gdb_test_file_name
4373 set binfile [standard_output_file ${testfile}]
4375 if {[llength $args] == 0} {
4379 # Unset our previous output variables.
4380 # This can help catch hidden bugs.
4381 if {[info exists gdb_test_file_last_vars]} {
4382 foreach varname $gdb_test_file_last_vars {
4384 catch {unset $varname}
4387 # 'executable' is often set by tests.
4388 set gdb_test_file_last_vars {executable}
4392 set varname srcfile$suffix
4395 # Handle an extension.
4398 } elseif {[string range $arg 0 0] == "."} {
4399 set arg $testfile$arg
4403 lappend gdb_test_file_last_vars $varname
4405 if {$suffix == ""} {
4413 # The default timeout used when testing GDB commands. We want to use
4414 # the same timeout as the default dejagnu timeout, unless the user has
4415 # already provided a specific value (probably through a site.exp file).
4416 global gdb_test_timeout
4417 if ![info exists gdb_test_timeout] {
4418 set gdb_test_timeout $timeout
4421 # A list of global variables that GDB testcases should not use.
4422 # We try to prevent their use by monitoring write accesses and raising
4423 # an error when that happens.
4424 set banned_variables { bug_id prms_id }
4426 # A list of procedures that GDB testcases should not use.
4427 # We try to prevent their use by monitoring invocations and raising
4428 # an error when that happens.
4429 set banned_procedures { strace }
4431 # gdb_init is called by runtest at start, but also by several
4432 # tests directly; gdb_finish is only called from within runtest after
4433 # each test source execution.
4434 # Placing several traces by repetitive calls to gdb_init leads
4435 # to problems, as only one trace is removed in gdb_finish.
4436 # To overcome this possible problem, we add a variable that records
4437 # if the banned variables and procedures are already traced.
4440 proc gdb_init { test_file_name } {
4441 # Reset the timeout value to the default. This way, any testcase
4442 # that changes the timeout value without resetting it cannot affect
4443 # the timeout used in subsequent testcases.
4444 global gdb_test_timeout
4446 set timeout $gdb_test_timeout
4448 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4449 && [target_info exists gdb_reverse_timeout] } {
4450 set timeout [target_info gdb_reverse_timeout]
4453 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4454 # debugging tool to help confirm that the test suite is
4455 # parallel-safe. You need "inotifywait" from the
4456 # inotify-tools package to use this.
4457 global GDB_INOTIFY inotify_pid
4458 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4459 global outdir tool inotify_log_file
4461 set exclusions {outputs temp gdb[.](log|sum) cache}
4462 set exclusion_re ([join $exclusions |])
4464 set inotify_log_file [standard_temp_file inotify.out]
4465 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4466 --exclude $exclusion_re \
4467 |& tee -a $outdir/$tool.log $inotify_log_file &]
4469 # Wait for the watches; hopefully this is long enough.
4472 # Clear the log so that we don't emit a warning the first time
4474 set fd [open $inotify_log_file w]
4478 # Block writes to all banned variables, and invocation of all
4479 # banned procedures...
4480 global banned_variables
4481 global banned_procedures
4482 global banned_traced
4483 if (!$banned_traced) {
4484 foreach banned_var $banned_variables {
4485 global "$banned_var"
4486 trace add variable "$banned_var" write error
4488 foreach banned_proc $banned_procedures {
4489 global "$banned_proc"
4490 trace add execution "$banned_proc" enter error
4495 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4496 # messages as expected.
4501 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4502 # the test results. Even if /dev/null doesn't exist on the particular
4503 # platform, the readline library will use the default setting just by
4504 # failing to open the file. OTOH, opening /dev/null successfully will
4505 # also result in the default settings being used since nothing will be
4506 # read from this file.
4507 setenv INPUTRC "/dev/null"
4509 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4510 # bindings, so make sure that an appropriate terminal is selected.
4511 # The same bug doesn't show up if we use ^P / ^N instead.
4514 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4515 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4516 # especially having color output turned on can cause tests to fail.
4517 setenv GREP_OPTIONS ""
4519 # Clear $gdbserver_reconnect_p.
4520 global gdbserver_reconnect_p
4521 set gdbserver_reconnect_p 1
4522 unset gdbserver_reconnect_p
4524 return [default_gdb_init $test_file_name]
4527 proc gdb_finish { } {
4528 global gdbserver_reconnect_p
4532 # Exit first, so that the files are no longer in use.
4535 if { [llength $cleanfiles] > 0 } {
4536 eval remote_file target delete $cleanfiles
4540 # Unblock write access to the banned variables. Dejagnu typically
4541 # resets some of them between testcases.
4542 global banned_variables
4543 global banned_procedures
4544 global banned_traced
4545 if ($banned_traced) {
4546 foreach banned_var $banned_variables {
4547 global "$banned_var"
4548 trace remove variable "$banned_var" write error
4550 foreach banned_proc $banned_procedures {
4551 global "$banned_proc"
4552 trace remove execution "$banned_proc" enter error
4559 set debug_format "unknown"
4561 # Run the gdb command "info source" and extract the debugging format
4562 # information from the output and save it in debug_format.
4564 proc get_debug_format { } {
4570 set debug_format "unknown"
4571 send_gdb "info source\n"
4573 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4574 set debug_format $expect_out(1,string)
4575 verbose "debug format is $debug_format"
4578 -re "No current source file.\r\n$gdb_prompt $" {
4579 perror "get_debug_format used when no current source file"
4582 -re "$gdb_prompt $" {
4583 warning "couldn't check debug format (no valid response)."
4587 warning "couldn't check debug format (timeout)."
4593 # Return true if FORMAT matches the debug format the current test was
4594 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4595 # `*', `[...]', and so on.
4597 # This function depends on variables set by `get_debug_format', above.
4599 proc test_debug_format {format} {
4602 return [expr [string match $format $debug_format] != 0]
4605 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4606 # COFF, stabs, etc). If that format matches the format that the
4607 # current test was compiled with, then the next test is expected to
4608 # fail for any target. Returns 1 if the next test or set of tests is
4609 # expected to fail, 0 otherwise (or if it is unknown). Must have
4610 # previously called get_debug_format.
4611 proc setup_xfail_format { format } {
4612 set ret [test_debug_format $format]
4620 # gdb_get_line_number TEXT [FILE]
4622 # Search the source file FILE, and return the line number of the
4623 # first line containing TEXT. If no match is found, an error is thrown.
4625 # TEXT is a string literal, not a regular expression.
4627 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4628 # specified, and does not start with "/", then it is assumed to be in
4629 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4630 # by changing the callers and the interface at the same time.
4631 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4632 # gdb.base/ena-dis-br.exp.
4634 # Use this function to keep your test scripts independent of the
4635 # exact line numbering of the source file. Don't write:
4637 # send_gdb "break 20"
4639 # This means that if anyone ever edits your test's source file,
4640 # your test could break. Instead, put a comment like this on the
4641 # source file line you want to break at:
4643 # /* breakpoint spot: frotz.exp: test name */
4645 # and then write, in your test script (which we assume is named
4648 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4650 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4653 # % puts "foo [lindex "bar baz" 1]"
4656 # Tcl is quite clever, for a little stringy language.)
4660 # The previous implementation of this procedure used the gdb search command.
4661 # This version is different:
4663 # . It works with MI, and it also works when gdb is not running.
4665 # . It operates on the build machine, not the host machine.
4667 # . For now, this implementation fakes a current directory of
4668 # $srcdir/$subdir to be compatible with the old implementation.
4669 # This will go away eventually and some callers will need to
4672 # . The TEXT argument is literal text and matches literally,
4673 # not a regular expression as it was before.
4675 # . State changes in gdb, such as changing the current file
4676 # and setting $_, no longer happen.
4678 # After a bit of time we can forget about the differences from the
4679 # old implementation.
4681 # --chastain 2004-08-05
4683 proc gdb_get_line_number { text { file "" } } {
4688 if { "$file" == "" } then {
4691 if { ! [regexp "^/" "$file"] } then {
4692 set file "$srcdir/$subdir/$file"
4695 if { [ catch { set fd [open "$file"] } message ] } then {
4700 for { set line 1 } { 1 } { incr line } {
4701 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4704 if { $nchar < 0 } then {
4707 if { [string first "$text" "$body"] >= 0 } then {
4713 if { [ catch { close "$fd" } message ] } then {
4718 error "undefined tag \"$text\""
4724 # Continue the program until it ends.
4726 # MSSG is the error message that gets printed. If not given, a
4728 # COMMAND is the command to invoke. If not given, "continue" is
4730 # ALLOW_EXTRA is a flag indicating whether the test should expect
4731 # extra output between the "Continuing." line and the program
4732 # exiting. By default it is zero; if nonzero, any extra output
4735 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4736 global inferior_exited_re use_gdb_stub
4739 set text "continue until exit"
4741 set text "continue until exit at $mssg"
4749 # By default, we don't rely on exit() behavior of remote stubs --
4750 # it's common for exit() to be implemented as a simple infinite
4751 # loop, or a forced crash/reset. For native targets, by default, we
4752 # assume process exit is reported as such. If a non-reliable target
4753 # is used, we set a breakpoint at exit, and continue to that.
4754 if { [target_info exists exit_is_reliable] } {
4755 set exit_is_reliable [target_info exit_is_reliable]
4757 set exit_is_reliable [expr ! $use_gdb_stub]
4760 if { ! $exit_is_reliable } {
4761 if {![gdb_breakpoint "exit"]} {
4764 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4767 # Continue until we exit. Should not stop again.
4768 # Don't bother to check the output of the program, that may be
4769 # extremely tough for some remote systems.
4771 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4776 proc rerun_to_main {} {
4777 global gdb_prompt use_gdb_stub
4782 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4783 {pass "rerun to main" ; return 0}
4784 -re "$gdb_prompt $"\
4785 {fail "rerun to main" ; return 0}
4786 timeout {fail "(timeout) rerun to main" ; return 0}
4791 -re "The program .* has been started already.*y or n. $" {
4795 -re "Starting program.*$gdb_prompt $"\
4796 {pass "rerun to main" ; return 0}
4797 -re "$gdb_prompt $"\
4798 {fail "rerun to main" ; return 0}
4799 timeout {fail "(timeout) rerun to main" ; return 0}
4804 # Print a message and return true if a test should be skipped
4805 # due to lack of floating point suport.
4807 proc gdb_skip_float_test { msg } {
4808 if [target_info exists gdb,skip_float_tests] {
4809 verbose "Skipping test '$msg': no float tests."
4815 # Print a message and return true if a test should be skipped
4816 # due to lack of stdio support.
4818 proc gdb_skip_stdio_test { msg } {
4819 if [target_info exists gdb,noinferiorio] {
4820 verbose "Skipping test '$msg': no inferior i/o."
4826 proc gdb_skip_bogus_test { msg } {
4830 # Return true if a test should be skipped due to lack of XML support
4832 # NOTE: This must be called while gdb is *not* running.
4834 gdb_caching_proc gdb_skip_xml_test {
4838 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4842 gdb_test_multiple "set tdesc filename $xml_file" "" {
4843 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4846 -re ".*$gdb_prompt $" { }
4852 # Return true if argv[0] is available.
4854 gdb_caching_proc gdb_has_argv0 {
4857 # Set up, compile, and execute a test program to check whether
4858 # argv[0] is available.
4859 set src [standard_temp_file has_argv0[pid].c]
4860 set exe [standard_temp_file has_argv0[pid].x]
4862 gdb_produce_source $src {
4863 int main (int argc, char **argv) {
4868 gdb_compile $src $exe executable {debug}
4871 proc gdb_has_argv0_1 { exe } {
4872 global srcdir subdir
4873 global gdb_prompt hex
4877 gdb_reinitialize_dir $srcdir/$subdir
4880 # Set breakpoint on main.
4881 gdb_test_multiple "break main" "break main" {
4882 -re "Breakpoint.*${gdb_prompt} $" {
4884 -re "${gdb_prompt} $" {
4891 gdb_test_multiple "" "run to main" {
4892 -re "Breakpoint.*${gdb_prompt} $" {
4894 -re "${gdb_prompt} $" {
4899 # Check whether argc is 1.
4900 gdb_test_multiple "p argc" "p argc" {
4901 -re " = 1\r\n${gdb_prompt} $" {
4903 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4904 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4907 -re "${gdb_prompt} $" {
4912 -re "${gdb_prompt} $" {
4919 set result [gdb_has_argv0_1 $exe]
4926 && ([istarget *-*-linux*]
4927 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4928 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4929 || [istarget *-*-openbsd*]
4930 || [istarget *-*-darwin*]
4931 || [istarget *-*-solaris*]
4932 || [istarget *-*-aix*]
4933 || [istarget *-*-gnu*]
4934 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
4935 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
4936 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
4937 || [istarget *-*-symbianelf*]
4938 || [istarget *-*-osf*]
4939 || [istarget *-*-dicos*]
4940 || [istarget *-*-nto*]
4941 || [istarget *-*-*vms*]
4942 || [istarget *-*-lynx*178]) } {
4943 fail "argv\[0\] should be available on this target"
4949 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
4950 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4951 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
4952 # the name of a debuginfo only file. This file will be stored in the same
4955 # Functions for separate debug info testing
4957 # starting with an executable:
4958 # foo --> original executable
4960 # at the end of the process we have:
4961 # foo.stripped --> foo w/o debug info
4962 # foo.debug --> foo's debug info
4963 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4965 # Fetch the build id from the file.
4966 # Returns "" if there is none.
4968 proc get_build_id { filename } {
4969 if { ([istarget "*-*-mingw*"]
4970 || [istarget *-*-cygwin*]) } {
4971 set objdump_program [gdb_find_objdump]
4972 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
4973 verbose "result is $result"
4974 verbose "output is $output"
4980 set tmp [standard_output_file "${filename}-tmp"]
4981 set objcopy_program [gdb_find_objcopy]
4982 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
4983 verbose "result is $result"
4984 verbose "output is $output"
4989 fconfigure $fi -translation binary
4990 # Skip the NOTE header.
4995 if ![string compare $data ""] then {
4998 # Convert it to hex.
4999 binary scan $data H* data
5004 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5005 # converted to the form: .build-id/ab/cdef1234...89.debug
5006 # Return "" if no build-id found.
5007 proc build_id_debug_filename_get { filename } {
5008 set data [get_build_id $filename]
5009 if { $data == "" } {
5012 regsub {^..} $data {\0/} data
5013 return ".build-id/${data}.debug"
5016 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5017 # list of optional flags. The only currently supported flag is no-main,
5018 # which removes the symbol entry for main from the separate debug file.
5020 # Function returns zero on success. Function will return non-zero failure code
5021 # on some targets not supporting separate debug info (such as i386-msdos).
5023 proc gdb_gnu_strip_debug { dest args } {
5025 # Use the first separate debug info file location searched by GDB so the
5026 # run cannot be broken by some stale file searched with higher precedence.
5027 set debug_file "${dest}.debug"
5029 set strip_to_file_program [transform strip]
5030 set objcopy_program [gdb_find_objcopy]
5032 set debug_link [file tail $debug_file]
5033 set stripped_file "${dest}.stripped"
5035 # Get rid of the debug info, and store result in stripped_file
5036 # something like gdb/testsuite/gdb.base/blah.stripped.
5037 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5038 verbose "result is $result"
5039 verbose "output is $output"
5044 # Workaround PR binutils/10802:
5045 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5046 set perm [file attributes ${dest} -permissions]
5047 file attributes ${stripped_file} -permissions $perm
5049 # Get rid of everything but the debug info, and store result in debug_file
5050 # This will be in the .debug subdirectory, see above.
5051 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5052 verbose "result is $result"
5053 verbose "output is $output"
5058 # If no-main is passed, strip the symbol for main from the separate
5059 # file. This is to simulate the behavior of elfutils's eu-strip, which
5060 # leaves the symtab in the original file only. There's no way to get
5061 # objcopy or strip to remove the symbol table without also removing the
5062 # debugging sections, so this is as close as we can get.
5063 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5064 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5065 verbose "result is $result"
5066 verbose "output is $output"
5070 file delete "${debug_file}"
5071 file rename "${debug_file}-tmp" "${debug_file}"
5074 # Link the two previous output files together, adding the .gnu_debuglink
5075 # section to the stripped_file, containing a pointer to the debug_file,
5076 # save the new file in dest.
5077 # This will be the regular executable filename, in the usual location.
5078 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5079 verbose "result is $result"
5080 verbose "output is $output"
5085 # Workaround PR binutils/10802:
5086 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5087 set perm [file attributes ${stripped_file} -permissions]
5088 file attributes ${dest} -permissions $perm
5093 # Test the output of GDB_COMMAND matches the pattern obtained
5094 # by concatenating all elements of EXPECTED_LINES. This makes
5095 # it possible to split otherwise very long string into pieces.
5096 # If third argument is not empty, it's used as the name of the
5097 # test to be printed on pass/fail.
5098 proc help_test_raw { gdb_command expected_lines args } {
5099 set message $gdb_command
5100 if [llength $args]>0 then {
5101 set message [lindex $args 0]
5103 set expected_output [join $expected_lines ""]
5104 gdb_test "${gdb_command}" "${expected_output}" $message
5107 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5108 # are regular expressions that should match the beginning of output,
5109 # before the list of commands in that class. The presence of
5110 # command list and standard epilogue will be tested automatically.
5111 # Notice that the '[' and ']' characters don't need to be escaped for strings
5112 # wrapped in {} braces.
5113 proc test_class_help { command_class expected_initial_lines args } {
5115 "List of commands\:.*[\r\n]+"
5116 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5117 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5118 "Command name abbreviations are allowed if unambiguous\."
5120 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5122 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5125 # COMMAND_LIST should have either one element -- command to test, or
5126 # two elements -- abbreviated command to test, and full command the first
5127 # element is abbreviation of.
5128 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5129 # are regular expressions that should match the beginning of output,
5130 # before the list of subcommands. The presence of
5131 # subcommand list and standard epilogue will be tested automatically.
5132 proc test_prefix_command_help { command_list expected_initial_lines args } {
5133 set command [lindex $command_list 0]
5134 if {[llength $command_list]>1} {
5135 set full_command [lindex $command_list 1]
5137 set full_command $command
5139 # Use 'list' and not just {} because we want variables to
5140 # be expanded in this list.
5141 set l_stock_body [list\
5142 "List of $full_command subcommands\:.*\[\r\n\]+"\
5143 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5144 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5145 "Command name abbreviations are allowed if unambiguous\."]
5146 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5147 if {[llength $args]>0} {
5148 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5150 help_test_raw "help ${command}" $l_entire_body
5154 # Build executable named EXECUTABLE from specifications that allow
5155 # different options to be passed to different sub-compilations.
5156 # TESTNAME is the name of the test; this is passed to 'untested' if
5158 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5159 # contains the option "pthreads", then gdb_compile_pthreads is used.
5160 # ARGS is a flat list of source specifications, of the form:
5161 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5162 # Each SOURCE is compiled to an object file using its OPTIONS,
5163 # using gdb_compile.
5164 # Returns 0 on success, -1 on failure.
5165 proc build_executable_from_specs {testname executable options args} {
5169 set binfile [standard_output_file $executable]
5172 if { [lsearch -exact $options "c++"] >= 0 } {
5173 set info_options "c++"
5175 if [get_compiler_info ${info_options}] {
5179 set func gdb_compile
5180 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5181 if {$func_index != -1} {
5182 set func "${func}_[lindex $options $func_index]"
5185 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5186 # parameter. They also requires $sources while gdb_compile and
5187 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5188 if [string match gdb_compile_shlib* $func] {
5190 foreach {s local_options} $args {
5191 if { [regexp "^/" "$s"] } then {
5192 lappend sources_path "$s"
5194 lappend sources_path "$srcdir/$subdir/$s"
5197 set ret [$func $sources_path "${binfile}" $options]
5201 foreach {s local_options} $args {
5202 if { ! [regexp "^/" "$s"] } then {
5203 set s "$srcdir/$subdir/$s"
5205 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5209 lappend objects "${binfile}${i}.o"
5212 set ret [$func $objects "${binfile}" executable $options]
5222 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5223 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5224 # to pass to untested, if something is wrong. OPTIONS are passed
5225 # to gdb_compile directly.
5226 proc build_executable { testname executable {sources ""} {options {debug}} } {
5227 if {[llength $sources]==0} {
5228 set sources ${executable}.c
5231 set arglist [list $testname $executable $options]
5232 foreach source $sources {
5233 lappend arglist $source $options
5236 return [eval build_executable_from_specs $arglist]
5239 # Starts fresh GDB binary and loads an optional executable into GDB.
5240 # Usage: clean_restart [executable]
5241 # EXECUTABLE is the basename of the binary.
5243 proc clean_restart { args } {
5247 if { [llength $args] > 1 } {
5248 error "bad number of args: [llength $args]"
5253 gdb_reinitialize_dir $srcdir/$subdir
5255 if { [llength $args] >= 1 } {
5256 set executable [lindex $args 0]
5257 set binfile [standard_output_file ${executable}]
5262 # Prepares for testing by calling build_executable_full, then
5264 # TESTNAME is the name of the test.
5265 # Each element in ARGS is a list of the form
5266 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5267 # These are passed to build_executable_from_specs, which see.
5268 # The last EXECUTABLE is passed to clean_restart.
5269 # Returns 0 on success, non-zero on failure.
5270 proc prepare_for_testing_full {testname args} {
5271 foreach spec $args {
5272 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5275 set executable [lindex $spec 0]
5277 clean_restart $executable
5281 # Prepares for testing, by calling build_executable, and then clean_restart.
5282 # Please refer to build_executable for parameter description.
5283 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5285 if {[build_executable $testname $executable $sources $options] == -1} {
5288 clean_restart $executable
5293 proc get_valueof { fmt exp default } {
5296 set test "get valueof \"${exp}\""
5298 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5299 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5300 set val $expect_out(1,string)
5304 fail "$test (timeout)"
5310 proc get_integer_valueof { exp default } {
5313 set test "get integer valueof \"${exp}\""
5315 gdb_test_multiple "print /d ${exp}" "$test" {
5316 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5317 set val $expect_out(1,string)
5321 fail "$test (timeout)"
5327 proc get_hexadecimal_valueof { exp default } {
5329 send_gdb "print /x ${exp}\n"
5330 set test "get hexadecimal valueof \"${exp}\""
5332 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5333 set val $expect_out(1,string)
5338 fail "$test (timeout)"
5344 proc get_sizeof { type default } {
5345 return [get_integer_valueof "sizeof (${type})" $default]
5348 proc get_target_charset { } {
5351 gdb_test_multiple "show target-charset" "" {
5352 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5353 return $expect_out(1,string)
5355 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5356 return $expect_out(1,string)
5360 # Pick a reasonable default.
5361 warning "Unable to read target-charset."
5365 # Get the current value for remotetimeout and return it.
5366 proc get_remotetimeout { } {
5370 gdb_test_multiple "show remotetimeout" "" {
5371 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5372 return $expect_out(1,string)
5376 # Pick the default that gdb uses
5377 warning "Unable to read remotetimeout"
5381 # Set the remotetimeout to the specified timeout. Nothing is returned.
5382 proc set_remotetimeout { timeout } {
5385 gdb_test_multiple "set remotetimeout $timeout" "" {
5386 -re "$gdb_prompt $" {
5387 verbose "Set remotetimeout to $timeout\n"
5392 # ROOT and FULL are file names. Returns the relative path from ROOT
5393 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5394 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5397 proc relative_filename {root full} {
5398 set root_split [file split $root]
5399 set full_split [file split $full]
5401 set len [llength $root_split]
5403 if {[eval file join $root_split]
5404 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5405 error "$full not a subdir of $root"
5408 return [eval file join [lrange $full_split $len end]]
5411 # Log gdb command line and script if requested.
5412 if {[info exists TRANSCRIPT]} {
5413 rename send_gdb real_send_gdb
5414 rename remote_spawn real_remote_spawn
5415 rename remote_close real_remote_close
5417 global gdb_transcript
5418 set gdb_transcript ""
5420 global gdb_trans_count
5421 set gdb_trans_count 1
5423 proc remote_spawn {args} {
5424 global gdb_transcript gdb_trans_count outdir
5426 if {$gdb_transcript != ""} {
5427 close $gdb_transcript
5429 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5430 puts $gdb_transcript [lindex $args 1]
5431 incr gdb_trans_count
5433 return [uplevel real_remote_spawn $args]
5436 proc remote_close {args} {
5437 global gdb_transcript
5439 if {$gdb_transcript != ""} {
5440 close $gdb_transcript
5441 set gdb_transcript ""
5444 return [uplevel real_remote_close $args]
5447 proc send_gdb {args} {
5448 global gdb_transcript
5450 if {$gdb_transcript != ""} {
5451 puts -nonewline $gdb_transcript [lindex $args 0]
5454 return [uplevel real_send_gdb $args]
5458 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5459 if {[info exists GDB_PARALLEL]} {
5460 if {[is_remote host]} {
5464 [make_gdb_parallel_path outputs] \
5465 [make_gdb_parallel_path temp] \
5466 [make_gdb_parallel_path cache]
5470 proc core_find {binfile {deletefiles {}} {arg ""}} {
5471 global objdir subdir
5473 set destcore "$binfile.core"
5474 file delete $destcore
5476 # Create a core file named "$destcore" rather than just "core", to
5477 # avoid problems with sys admin types that like to regularly prune all
5478 # files named "core" from the system.
5480 # Arbitrarily try setting the core size limit to "unlimited" since
5481 # this does not hurt on systems where the command does not work and
5482 # allows us to generate a core on systems where it does.
5484 # Some systems append "core" to the name of the program; others append
5485 # the name of the program to "core"; still others (like Linux, as of
5486 # May 2003) create cores named "core.PID". In the latter case, we
5487 # could have many core files lying around, and it may be difficult to
5488 # tell which one is ours, so let's run the program in a subdirectory.
5490 set coredir [standard_output_file coredir.[getpid]]
5492 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5493 # remote_exec host "${binfile}"
5494 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5495 if [remote_file build exists $i] {
5496 remote_exec build "mv $i $destcore"
5500 # Check for "core.PID".
5501 if { $found == 0 } {
5502 set names [glob -nocomplain -directory $coredir core.*]
5503 if {[llength $names] == 1} {
5504 set corefile [file join $coredir [lindex $names 0]]
5505 remote_exec build "mv $corefile $destcore"
5509 if { $found == 0 } {
5510 # The braindamaged HPUX shell quits after the ulimit -c above
5511 # without executing ${binfile}. So we try again without the
5512 # ulimit here if we didn't find a core file above.
5513 # Oh, I should mention that any "braindamaged" non-Unix system has
5514 # the same problem. I like the cd bit too, it's really neat'n stuff.
5515 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5516 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5517 if [remote_file build exists $i] {
5518 remote_exec build "mv $i $destcore"
5524 # Try to clean up after ourselves.
5525 foreach deletefile $deletefiles {
5526 remote_file build delete [file join $coredir $deletefile]
5528 remote_exec build "rmdir $coredir"
5530 if { $found == 0 } {
5531 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5537 # gdb_target_symbol_prefix compiles a test program and then examines
5538 # the output from objdump to determine the prefix (such as underscore)
5539 # for linker symbol prefixes.
5541 gdb_caching_proc gdb_target_symbol_prefix {
5542 # Set up and compile a simple test program...
5543 set src [standard_temp_file main[pid].c]
5544 set exe [standard_temp_file main[pid].x]
5546 gdb_produce_source $src {
5552 verbose "compiling testfile $src" 2
5553 set compile_flags {debug nowarnings quiet}
5554 set lines [gdb_compile $src $exe executable $compile_flags]
5558 if ![string match "" $lines] then {
5559 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5561 set objdump_program [gdb_find_objdump]
5562 set result [catch "exec $objdump_program --syms $exe" output]
5565 && ![regexp -lineanchor \
5566 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5567 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5577 # gdb_target_symbol returns the provided symbol with the correct prefix
5578 # prepended. (See gdb_target_symbol_prefix, above.)
5580 proc gdb_target_symbol { symbol } {
5581 set prefix [gdb_target_symbol_prefix]
5582 return "${prefix}${symbol}"
5585 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5586 # added to gdb_compile options to define the C-preprocessor macro
5587 # SYMBOL_PREFIX with a value that can be prepended to symbols
5588 # for targets which require a prefix, such as underscore.
5590 # This version (_asm) defines the prefix without double quotes
5591 # surrounding the prefix. It is used to define the macro
5592 # SYMBOL_PREFIX for assembly language files. Another version, below,
5593 # is used for symbols in inline assembler in C/C++ files.
5595 # The lack of quotes in this version (_asm) makes it possible to
5596 # define supporting macros in the .S file. (The version which
5597 # uses quotes for the prefix won't work for such files since it's
5598 # impossible to define a quote-stripping macro in C.)
5600 # It's possible to use this version (_asm) for C/C++ source files too,
5601 # but a string is usually required in such files; providing a version
5602 # (no _asm) which encloses the prefix with double quotes makes it
5603 # somewhat easier to define the supporting macros in the test case.
5605 proc gdb_target_symbol_prefix_flags_asm {} {
5606 set prefix [gdb_target_symbol_prefix]
5607 if {$prefix ne ""} {
5608 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5614 # gdb_target_symbol_prefix_flags returns the same string as
5615 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5616 # enclosed in double quotes if there is a prefix.
5618 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5619 # extended discussion.
5621 proc gdb_target_symbol_prefix_flags {} {
5622 set prefix [gdb_target_symbol_prefix]
5623 if {$prefix ne ""} {
5624 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5630 # A wrapper for 'remote_exec host' that passes or fails a test.
5631 # Returns 0 if all went well, nonzero on failure.
5632 # TEST is the name of the test, other arguments are as for remote_exec.
5634 proc run_on_host { test program args } {
5635 verbose -log "run_on_host: $program $args"
5636 # remote_exec doesn't work properly if the output is set but the
5637 # input is the empty string -- so replace an empty input with
5639 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5640 set args [lreplace $args 1 1 "/dev/null"]
5642 set result [eval remote_exec host [list $program] $args]
5643 verbose "result is $result"
5644 set status [lindex $result 0]
5645 set output [lindex $result 1]
5650 verbose -log "run_on_host failed: $output"
5656 # Return non-zero if "board_info debug_flags" mentions Fission.
5657 # http://gcc.gnu.org/wiki/DebugFission
5658 # Fission doesn't support everything yet.
5659 # This supports working around bug 15954.
5661 proc using_fission { } {
5662 set debug_flags [board_info [target_info name] debug_flags]
5663 return [regexp -- "-gsplit-dwarf" $debug_flags]
5666 # Search the caller's ARGS list and set variables according to the list of
5667 # valid options described by ARGSET.
5669 # The first member of each one- or two-element list in ARGSET defines the
5670 # name of a variable that will be added to the caller's scope.
5672 # If only one element is given to describe an option, it the value is
5673 # 0 if the option is not present in (the caller's) ARGS or 1 if
5676 # If two elements are given, the second element is the default value of
5677 # the variable. This is then overwritten if the option exists in ARGS.
5679 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5680 # any optional components.
5683 # proc myproc {foo args} {
5684 # parse_args {{bar} {baz "abc"} {qux}}
5687 # myproc ABC -bar -baz DEF peanut butter
5688 # will define the following variables in myproc:
5689 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5690 # args will be the list {peanut butter}
5692 proc parse_args { argset } {
5695 foreach argument $argset {
5696 if {[llength $argument] == 1} {
5697 # No default specified, so we assume that we should set
5698 # the value to 1 if the arg is present and 0 if it's not.
5699 # It is assumed that no value is given with the argument.
5700 set result [lsearch -exact $args "-$argument"]
5701 if {$result != -1} then {
5702 uplevel 1 [list set $argument 1]
5703 set args [lreplace $args $result $result]
5705 uplevel 1 [list set $argument 0]
5707 } elseif {[llength $argument] == 2} {
5708 # There are two items in the argument. The second is a
5709 # default value to use if the item is not present.
5710 # Otherwise, the variable is set to whatever is provided
5711 # after the item in the args.
5712 set arg [lindex $argument 0]
5713 set result [lsearch -exact $args "-[lindex $arg 0]"]
5714 if {$result != -1} then {
5715 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5716 set args [lreplace $args $result [expr $result+1]]
5718 uplevel 1 [list set $arg [lindex $argument 1]]
5721 error "Badly formatted argument \"$argument\" in argument set"
5725 # The remaining args should be checked to see that they match the
5726 # number of items expected to be passed into the procedure...
5729 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5730 # return that string.
5732 proc capture_command_output { command prefix } {
5736 set output_string ""
5737 gdb_test_multiple "$command" "capture_command_output for $command" {
5738 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5739 set output_string $expect_out(1,string)
5742 return $output_string
5745 # A convenience function that joins all the arguments together, with a
5746 # regexp that matches exactly one end of line in between each argument.
5747 # This function is ideal to write the expected output of a GDB command
5748 # that generates more than a couple of lines, as this allows us to write
5749 # each line as a separate string, which is easier to read by a human
5752 proc multi_line { args } {
5753 return [join $args "\r\n"]
5756 # Always load compatibility stuff.