1 # Copyright 1992-2016 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
34 # The spawn ID used for I/O interaction with the inferior. For native
35 # targets, or remote targets that can do I/O through GDB
36 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
37 # Otherwise, the board may set this to some other spawn ID. E.g.,
38 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
39 # so input/output is done on gdbserver's tty.
40 global inferior_spawn_id
42 if [info exists TOOL_EXECUTABLE] {
43 set GDB $TOOL_EXECUTABLE
45 if ![info exists GDB] {
46 if ![is_remote host] {
47 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
49 set GDB [transform gdb]
52 verbose "using GDB = $GDB" 2
54 # GDBFLAGS is available for the user to set on the command line.
55 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
56 # Testcases may use it to add additional flags, but they must:
57 # - append new flags, not overwrite
58 # - restore the original value when done
60 if ![info exists GDBFLAGS] {
63 verbose "using GDBFLAGS = $GDBFLAGS" 2
65 # Make the build data directory available to tests.
66 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
68 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
69 global INTERNAL_GDBFLAGS
70 if ![info exists INTERNAL_GDBFLAGS] {
71 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
74 # The variable gdb_prompt is a regexp which matches the gdb prompt.
75 # Set it if it is not already set. This is also set by default_gdb_init
76 # but it's not clear what removing one of them will break.
77 # See with_gdb_prompt for more details on prompt handling.
79 if ![info exists gdb_prompt] then {
80 set gdb_prompt "\\(gdb\\)"
83 # A regexp that matches the pagination prompt.
84 set pagination_prompt [string_to_regexp "---Type <return> to continue, or q <return> to quit---"]
86 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
87 # absolute path ie. /foo/
88 set fullname_syntax_POSIX {/[^\n]*/}
89 # The variable fullname_syntax_UNC is a regexp which matches a Windows
90 # UNC path ie. \\D\foo\
91 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
92 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
93 # particular DOS case that GDB most likely will output
94 # ie. \foo\, but don't match \\.*\
95 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
96 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
97 # ie. a:\foo\ && a:foo\
98 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
99 # The variable fullname_syntax is a regexp which matches what GDB considers
100 # an absolute path. It is currently debatable if the Windows style paths
101 # d:foo and \abc should be considered valid as an absolute path.
102 # Also, the purpse of this regexp is not to recognize a well formed
103 # absolute path, but to say with certainty that a path is absolute.
104 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
106 # Needed for some tests under Cygwin.
110 if ![info exists env(EXEEXT)] {
113 set EXEEXT $env(EXEEXT)
118 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
120 ### Only procedures should come after this point.
123 # gdb_version -- extract and print the version number of GDB
125 proc default_gdb_version {} {
127 global INTERNAL_GDBFLAGS GDBFLAGS
131 if {[info exists inotify_pid]} {
132 eval exec kill $inotify_pid
135 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
136 set tmp [lindex $output 1]
138 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
139 if ![is_remote host] {
140 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
142 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
146 proc gdb_version { } {
147 return [default_gdb_version]
151 # gdb_unload -- unload a file if one is loaded
152 # Return 0 on success, -1 on error.
161 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
162 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
163 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
167 -re "Discard symbol table from .*y or n.*$" {
171 -re "$gdb_prompt $" {}
173 perror "couldn't unload file in $GDB (timeout)."
180 # Many of the tests depend on setting breakpoints at various places and
181 # running until that breakpoint is reached. At times, we want to start
182 # with a clean-slate with respect to breakpoints, so this utility proc
183 # lets us do this without duplicating this code everywhere.
186 proc delete_breakpoints {} {
189 # we need a larger timeout value here or this thing just confuses
190 # itself. May need a better implementation if possible. - guo
194 set msg "delete all breakpoints in delete_breakpoints"
196 gdb_test_multiple "delete breakpoints" "$msg" {
197 -re "Delete all breakpoints.*y or n.*$" {
201 -re "$gdb_prompt $" {
207 # Confirm with "info breakpoints".
209 set msg "info breakpoints"
210 gdb_test_multiple $msg $msg {
211 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
214 -re "$gdb_prompt $" {
220 perror "breakpoints not deleted"
224 # Generic run command.
226 # The second pattern below matches up to the first newline *only*.
227 # Using ``.*$'' could swallow up output that we attempt to match
230 # N.B. This function does not wait for gdb to return to the prompt,
231 # that is the caller's responsibility.
233 proc gdb_run_cmd {args} {
234 global gdb_prompt use_gdb_stub
236 foreach command [gdb_init_commands] {
237 send_gdb "$command\n"
239 -re "$gdb_prompt $" { }
241 perror "gdb_init_command for target failed"
248 if [target_info exists gdb,do_reload_on_run] {
249 if { [gdb_reload] != 0 } {
252 send_gdb "continue\n"
254 -re "Continu\[^\r\n\]*\[\r\n\]" {}
260 if [target_info exists gdb,start_symbol] {
261 set start [target_info gdb,start_symbol]
265 send_gdb "jump *$start\n"
267 while { $start_attempt } {
268 # Cap (re)start attempts at three to ensure that this loop
269 # always eventually fails. Don't worry about trying to be
270 # clever and not send a command when it has failed.
271 if [expr $start_attempt > 3] {
272 perror "Jump to start() failed (retry count exceeded)"
275 set start_attempt [expr $start_attempt + 1]
277 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
280 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
281 perror "Can't find start symbol to run in gdb_run"
284 -re "No symbol \"start\" in current.*$gdb_prompt $" {
285 send_gdb "jump *_start\n"
287 -re "No symbol.*context.*$gdb_prompt $" {
290 -re "Line.* Jump anyway.*y or n. $" {
293 -re "The program is not being run.*$gdb_prompt $" {
294 if { [gdb_reload] != 0 } {
297 send_gdb "jump *$start\n"
300 perror "Jump to start() failed (timeout)"
308 if [target_info exists gdb,do_reload_on_run] {
309 if { [gdb_reload] != 0 } {
313 send_gdb "run $args\n"
314 # This doesn't work quite right yet.
315 # Use -notransfer here so that test cases (like chng-sym.exp)
316 # may test for additional start-up messages.
318 -re "The program .* has been started already.*y or n. $" {
322 -notransfer -re "Starting program: \[^\r\n\]*" {}
323 -notransfer -re "$gdb_prompt $" {
324 # There is no more input expected.
329 # Generic start command. Return 0 if we could start the program, -1
332 # N.B. This function does not wait for gdb to return to the prompt,
333 # that is the caller's responsibility.
335 proc gdb_start_cmd {args} {
336 global gdb_prompt use_gdb_stub
338 foreach command [gdb_init_commands] {
339 send_gdb "$command\n"
341 -re "$gdb_prompt $" { }
343 perror "gdb_init_command for target failed"
353 send_gdb "start $args\n"
354 # Use -notransfer here so that test cases (like chng-sym.exp)
355 # may test for additional start-up messages.
357 -re "The program .* has been started already.*y or n. $" {
361 -notransfer -re "Starting program: \[^\r\n\]*" {
368 # Set a breakpoint at FUNCTION. If there is an additional argument it is
369 # a list of options; the supported options are allow-pending, temporary,
370 # message, no-message, and passfail.
371 # The result is 1 for success, 0 for failure.
373 # Note: The handling of message vs no-message is messed up, but it's based
374 # on historical usage. By default this function does not print passes,
376 # no-message: turns off printing of fails (and passes, but they're already off)
377 # message: turns on printing of passes (and fails, but they're already on)
379 proc gdb_breakpoint { function args } {
383 set pending_response n
384 if {[lsearch -exact $args allow-pending] != -1} {
385 set pending_response y
388 set break_command "break"
389 set break_message "Breakpoint"
390 if {[lsearch -exact $args temporary] != -1} {
391 set break_command "tbreak"
392 set break_message "Temporary breakpoint"
397 set no_message_loc [lsearch -exact $args no-message]
398 set message_loc [lsearch -exact $args message]
399 # The last one to appear in args wins.
400 if { $no_message_loc > $message_loc } {
402 } elseif { $message_loc > $no_message_loc } {
406 set test_name "setting breakpoint at $function"
408 send_gdb "$break_command $function\n"
409 # The first two regexps are what we get with -g, the third is without -g.
411 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
412 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
413 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
414 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
415 if {$pending_response == "n"} {
422 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
423 send_gdb "$pending_response\n"
426 -re "A problem internal to GDB has been detected" {
428 fail "$test_name (GDB internal error)"
430 gdb_internal_error_resync
433 -re "$gdb_prompt $" {
441 fail "$test_name (eof)"
447 fail "$test_name (timeout)"
458 # Set breakpoint at function and run gdb until it breaks there.
459 # Since this is the only breakpoint that will be set, if it stops
460 # at a breakpoint, we will assume it is the one we want. We can't
461 # just compare to "function" because it might be a fully qualified,
462 # single quoted C++ function specifier.
464 # If there are additional arguments, pass them to gdb_breakpoint.
465 # We recognize no-message/message ourselves.
466 # The default is no-message.
467 # no-message is messed up here, like gdb_breakpoint: to preserve
468 # historical usage fails are always printed by default.
469 # no-message: turns off printing of fails (and passes, but they're already off)
470 # message: turns on printing of passes (and fails, but they're already on)
472 proc runto { function args } {
478 # Default to "no-message".
479 set args "no-message $args"
483 set no_message_loc [lsearch -exact $args no-message]
484 set message_loc [lsearch -exact $args message]
485 # The last one to appear in args wins.
486 if { $no_message_loc > $message_loc } {
488 } elseif { $message_loc > $no_message_loc } {
492 set test_name "running to $function in runto"
494 # We need to use eval here to pass our varargs args to gdb_breakpoint
495 # which is also a varargs function.
496 # But we also have to be careful because $function may have multiple
497 # elements, and we don't want Tcl to move the remaining elements after
498 # the first to $args. That is why $function is wrapped in {}.
499 if ![eval gdb_breakpoint {$function} $args] {
505 # the "at foo.c:36" output we get with -g.
506 # the "in func" output we get without -g.
508 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
514 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
520 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
522 unsupported "Non-stop mode not supported"
526 -re ".*A problem internal to GDB has been detected" {
528 fail "$test_name (GDB internal error)"
530 gdb_internal_error_resync
533 -re "$gdb_prompt $" {
541 fail "$test_name (eof)"
547 fail "$test_name (timeout)"
558 # Ask gdb to run until we hit a breakpoint at main.
560 # N.B. This function deletes all existing breakpoints.
561 # If you don't want that, use gdb_start_cmd.
563 proc runto_main { } {
564 return [runto main no-message]
567 ### Continue, and expect to hit a breakpoint.
568 ### Report a pass or fail, depending on whether it seems to have
569 ### worked. Use NAME as part of the test name; each call to
570 ### continue_to_breakpoint should use a NAME which is unique within
572 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
574 set full_name "continue to breakpoint: $name"
576 gdb_test_multiple "continue" $full_name {
577 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
584 # gdb_internal_error_resync:
586 # Answer the questions GDB asks after it reports an internal error
587 # until we get back to a GDB prompt. Decline to quit the debugging
588 # session, and decline to create a core file. Return non-zero if the
591 # This procedure just answers whatever questions come up until it sees
592 # a GDB prompt; it doesn't require you to have matched the input up to
593 # any specific point. However, it only answers questions it sees in
594 # the output itself, so if you've matched a question, you had better
595 # answer it yourself before calling this.
597 # You can use this function thus:
601 # -re ".*A problem internal to GDB has been detected" {
602 # gdb_internal_error_resync
607 proc gdb_internal_error_resync {} {
610 verbose -log "Resyncing due to internal error."
613 while {$count < 10} {
615 -re "Quit this debugging session\\? \\(y or n\\) $" {
619 -re "Create a core file of GDB\\? \\(y or n\\) $" {
623 -re "$gdb_prompt $" {
624 # We're resynchronized.
628 perror "Could not resync from internal error (timeout)"
633 perror "Could not resync from internal error (resync count exceeded)"
638 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
639 # Send a command to gdb; test the result.
641 # COMMAND is the command to execute, send to GDB with send_gdb. If
642 # this is the null string no command is sent.
643 # MESSAGE is a message to be printed with the built-in failure patterns
644 # if one of them matches. If MESSAGE is empty COMMAND will be used.
645 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
646 # patterns. Pattern elements will be evaluated in the caller's
647 # context; action elements will be executed in the caller's context.
648 # Unlike patterns for gdb_test, these patterns should generally include
649 # the final newline and prompt.
652 # 1 if the test failed, according to a built-in failure pattern
653 # 0 if only user-supplied patterns matched
654 # -1 if there was an internal error.
656 # You can use this function thus:
658 # gdb_test_multiple "print foo" "test foo" {
659 # -re "expected output 1" {
662 # -re "expected output 2" {
667 # Like with "expect", you can also specify the spawn id to match with
668 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
669 # $gdb_spawn_id. The former matches inferior I/O, while the latter
670 # matches GDB I/O. E.g.:
672 # send_inferior "hello\n"
673 # gdb_test_multiple "continue" "test echo" {
674 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
677 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
678 # fail "hit breakpoint"
682 # The standard patterns, such as "Inferior exited..." and "A problem
683 # ...", all being implicitly appended to that list. These are always
684 # expected from $gdb_spawn_id. IOW, callers do not need to worry
685 # about resetting "-i" back to $gdb_spawn_id explicitly.
687 proc gdb_test_multiple { command message user_code } {
688 global verbose use_gdb_stub
689 global gdb_prompt pagination_prompt
692 global inferior_exited_re
693 upvar timeout timeout
694 upvar expect_out expect_out
697 if { $message == "" } {
701 if [string match "*\[\r\n\]" $command] {
702 error "Invalid trailing newline in \"$message\" test"
705 if [string match "*\[\r\n\]*" $message] {
706 error "Invalid newline in \"$message\" test"
710 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
712 error "gdbserver does not support $command without extended-remote"
715 # TCL/EXPECT WART ALERT
716 # Expect does something very strange when it receives a single braced
717 # argument. It splits it along word separators and performs substitutions.
718 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
719 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
720 # double-quoted list item, "\[ab\]" is just a long way of representing
721 # "[ab]", because the backslashes will be removed by lindex.
723 # Unfortunately, there appears to be no easy way to duplicate the splitting
724 # that expect will do from within TCL. And many places make use of the
725 # "\[0-9\]" construct, so we need to support that; and some places make use
726 # of the "[func]" construct, so we need to support that too. In order to
727 # get this right we have to substitute quoted list elements differently
728 # from braced list elements.
730 # We do this roughly the same way that Expect does it. We have to use two
731 # lists, because if we leave unquoted newlines in the argument to uplevel
732 # they'll be treated as command separators, and if we escape newlines
733 # we mangle newlines inside of command blocks. This assumes that the
734 # input doesn't contain a pattern which contains actual embedded newlines
737 regsub -all {\n} ${user_code} { } subst_code
738 set subst_code [uplevel list $subst_code]
740 set processed_code ""
742 set expecting_action 0
744 foreach item $user_code subst_item $subst_code {
745 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
746 lappend processed_code $item
749 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
750 lappend processed_code $item
753 if { $item == "-timeout" || $item == "-i" } {
755 lappend processed_code $item
758 if { $expecting_arg } {
760 lappend processed_code $subst_item
763 if { $expecting_action } {
764 lappend processed_code "uplevel [list $item]"
765 set expecting_action 0
766 # Cosmetic, no effect on the list.
767 append processed_code "\n"
770 set expecting_action 1
771 lappend processed_code $subst_item
772 if {$patterns != ""} {
775 append patterns "\"$subst_item\""
778 # Also purely cosmetic.
779 regsub -all {\r} $patterns {\\r} patterns
780 regsub -all {\n} $patterns {\\n} patterns
783 send_user "Sending \"$command\" to gdb\n"
784 send_user "Looking to match \"$patterns\"\n"
785 send_user "Message is \"$message\"\n"
789 set string "${command}\n"
790 if { $command != "" } {
791 set multi_line_re "\[\r\n\] *>"
792 while { "$string" != "" } {
793 set foo [string first "\n" "$string"]
794 set len [string length "$string"]
795 if { $foo < [expr $len - 1] } {
796 set str [string range "$string" 0 $foo]
797 if { [send_gdb "$str"] != "" } {
800 if { ! $suppress_flag } {
801 perror "Couldn't send $command to GDB."
806 # since we're checking if each line of the multi-line
807 # command are 'accepted' by GDB here,
808 # we need to set -notransfer expect option so that
809 # command output is not lost for pattern matching
812 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
813 timeout { verbose "partial: timeout" 3 }
815 set string [string range "$string" [expr $foo + 1] end]
816 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
821 if { "$string" != "" } {
822 if { [send_gdb "$string"] != "" } {
825 if { ! $suppress_flag } {
826 perror "Couldn't send $command to GDB."
835 -re ".*A problem internal to GDB has been detected" {
836 fail "$message (GDB internal error)"
837 gdb_internal_error_resync
840 -re "\\*\\*\\* DOSEXIT code.*" {
841 if { $message != "" } {
844 gdb_suppress_entire_file "GDB died"
848 append code $processed_code
850 # Reset the spawn id, in case the processed code used -i.
853 -re "Ending remote debugging.*$gdb_prompt $" {
854 if ![isnative] then {
855 warning "Can`t communicate to remote target."
861 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
862 perror "Undefined command \"$command\"."
866 -re "Ambiguous command.*$gdb_prompt $" {
867 perror "\"$command\" is not a unique command name."
871 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
872 if ![string match "" $message] then {
873 set errmsg "$message (the program exited)"
875 set errmsg "$command (the program exited)"
880 -re "$inferior_exited_re normally.*$gdb_prompt $" {
881 if ![string match "" $message] then {
882 set errmsg "$message (the program exited)"
884 set errmsg "$command (the program exited)"
889 -re "The program is not being run.*$gdb_prompt $" {
890 if ![string match "" $message] then {
891 set errmsg "$message (the program is no longer running)"
893 set errmsg "$command (the program is no longer running)"
898 -re "\r\n$gdb_prompt $" {
899 if ![string match "" $message] then {
904 -re "$pagination_prompt" {
906 perror "Window too small."
910 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
912 gdb_expect -re "$gdb_prompt $"
913 fail "$message (got interactive prompt)"
916 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
918 gdb_expect -re "$gdb_prompt $"
919 fail "$message (got breakpoint menu)"
923 # Patterns below apply to any spawn id specified.
926 perror "Process no longer exists"
927 if { $message != "" } {
933 perror "internal buffer is full."
938 if ![string match "" $message] then {
939 fail "$message (timeout)"
946 set code [catch {gdb_expect $code} string]
948 global errorInfo errorCode
949 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
950 } elseif {$code > 1} {
951 return -code $code $string
956 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
957 # Send a command to gdb; test the result.
959 # COMMAND is the command to execute, send to GDB with send_gdb. If
960 # this is the null string no command is sent.
961 # PATTERN is the pattern to match for a PASS, and must NOT include
962 # the \r\n sequence immediately before the gdb prompt. This argument
963 # may be omitted to just match the prompt, ignoring whatever output
965 # MESSAGE is an optional message to be printed. If this is
966 # omitted, then the pass/fail messages use the command string as the
967 # message. (If this is the empty string, then sometimes we don't
968 # call pass or fail at all; I don't understand this at all.)
969 # QUESTION is a question GDB may ask in response to COMMAND, like
971 # RESPONSE is the response to send if QUESTION appears.
974 # 1 if the test failed,
975 # 0 if the test passes,
976 # -1 if there was an internal error.
978 proc gdb_test { args } {
980 upvar timeout timeout
982 if [llength $args]>2 then {
983 set message [lindex $args 2]
985 set message [lindex $args 0]
987 set command [lindex $args 0]
988 set pattern [lindex $args 1]
990 if [llength $args]==5 {
991 set question_string [lindex $args 3]
992 set response_string [lindex $args 4]
994 set question_string "^FOOBAR$"
997 return [gdb_test_multiple $command $message {
998 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
999 if ![string match "" $message] then {
1003 -re "(${question_string})$" {
1004 send_gdb "$response_string\n"
1010 # gdb_test_no_output COMMAND MESSAGE
1011 # Send a command to GDB and verify that this command generated no output.
1013 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1014 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1015 # the message. (If MESSAGE is the empty string, then sometimes we do not
1016 # call pass or fail at all; I don't understand this at all.)
1018 proc gdb_test_no_output { args } {
1020 set command [lindex $args 0]
1021 if [llength $args]>1 then {
1022 set message [lindex $args 1]
1024 set message $command
1027 set command_regex [string_to_regexp $command]
1028 gdb_test_multiple $command $message {
1029 -re "^$command_regex\r\n$gdb_prompt $" {
1030 if ![string match "" $message] then {
1037 # Send a command and then wait for a sequence of outputs.
1038 # This is useful when the sequence is long and contains ".*", a single
1039 # regexp to match the entire output can get a timeout much easier.
1041 # COMMAND is the command to send.
1042 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1043 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1044 # processed in order, and all must be present in the output.
1046 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1047 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1048 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1050 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1051 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1054 # 1 if the test failed,
1055 # 0 if the test passes,
1056 # -1 if there was an internal error.
1058 proc gdb_test_sequence { command test_name expected_output_list } {
1060 if { $test_name == "" } {
1061 set test_name $command
1063 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1064 send_gdb "$command\n"
1065 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1069 # Test that a command gives an error. For pass or fail, return
1070 # a 1 to indicate that more tests can proceed. However a timeout
1071 # is a serious error, generates a special fail message, and causes
1072 # a 0 to be returned to indicate that more tests are likely to fail
1075 proc test_print_reject { args } {
1079 if [llength $args]==2 then {
1080 set expectthis [lindex $args 1]
1082 set expectthis "should never match this bogus string"
1084 set sendthis [lindex $args 0]
1085 if $verbose>2 then {
1086 send_user "Sending \"$sendthis\" to gdb\n"
1087 send_user "Looking to match \"$expectthis\"\n"
1089 send_gdb "$sendthis\n"
1090 #FIXME: Should add timeout as parameter.
1092 -re "A .* in expression.*\\.*$gdb_prompt $" {
1093 pass "reject $sendthis"
1096 -re "Invalid syntax in expression.*$gdb_prompt $" {
1097 pass "reject $sendthis"
1100 -re "Junk after end of expression.*$gdb_prompt $" {
1101 pass "reject $sendthis"
1104 -re "Invalid number.*$gdb_prompt $" {
1105 pass "reject $sendthis"
1108 -re "Invalid character constant.*$gdb_prompt $" {
1109 pass "reject $sendthis"
1112 -re "No symbol table is loaded.*$gdb_prompt $" {
1113 pass "reject $sendthis"
1116 -re "No symbol .* in current context.*$gdb_prompt $" {
1117 pass "reject $sendthis"
1120 -re "Unmatched single quote.*$gdb_prompt $" {
1121 pass "reject $sendthis"
1124 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1125 pass "reject $sendthis"
1128 -re "$expectthis.*$gdb_prompt $" {
1129 pass "reject $sendthis"
1132 -re ".*$gdb_prompt $" {
1133 fail "reject $sendthis"
1137 fail "reject $sendthis (eof or timeout)"
1144 # Same as gdb_test, but the second parameter is not a regexp,
1145 # but a string that must match exactly.
1147 proc gdb_test_exact { args } {
1148 upvar timeout timeout
1150 set command [lindex $args 0]
1152 # This applies a special meaning to a null string pattern. Without
1153 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1154 # messages from commands that should have no output except a new
1155 # prompt. With this, only results of a null string will match a null
1158 set pattern [lindex $args 1]
1159 if [string match $pattern ""] {
1160 set pattern [string_to_regexp [lindex $args 0]]
1162 set pattern [string_to_regexp [lindex $args 1]]
1165 # It is most natural to write the pattern argument with only
1166 # embedded \n's, especially if you are trying to avoid Tcl quoting
1167 # problems. But gdb_expect really wants to see \r\n in patterns. So
1168 # transform the pattern here. First transform \r\n back to \n, in
1169 # case some users of gdb_test_exact already do the right thing.
1170 regsub -all "\r\n" $pattern "\n" pattern
1171 regsub -all "\n" $pattern "\r\n" pattern
1172 if [llength $args]==3 then {
1173 set message [lindex $args 2]
1175 set message $command
1178 return [gdb_test $command $pattern $message]
1181 # Wrapper around gdb_test_multiple that looks for a list of expected
1182 # output elements, but which can appear in any order.
1183 # CMD is the gdb command.
1184 # NAME is the name of the test.
1185 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1187 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1188 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1189 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1191 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1192 # of text per element and then strip trailing \r\n's.
1194 # gdb_test_list_exact "foo" "bar" \
1195 # "\[^\r\n\]+\[\r\n\]+" \
1198 # {expected result 1} \
1199 # {expected result 2} \
1202 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1205 set matches [lsort $result_match_list]
1207 gdb_test_multiple $cmd $name {
1208 "$cmd\[\r\n\]" { exp_continue }
1209 -re $elm_find_regexp {
1210 set str $expect_out(0,string)
1211 verbose -log "seen: $str" 3
1212 regexp -- $elm_extract_regexp $str elm_seen
1213 verbose -log "extracted: $elm_seen" 3
1214 lappend seen $elm_seen
1217 -re "$gdb_prompt $" {
1219 foreach got [lsort $seen] have $matches {
1220 if {![string equal $got $have]} {
1225 if {[string length $failed] != 0} {
1226 fail "$name ($failed not found)"
1234 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1235 # Send a command to gdb; expect inferior and gdb output.
1237 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1240 # INFERIOR_PATTERN is the pattern to match against inferior output.
1242 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1243 # include the \r\n sequence immediately before the gdb prompt, nor the
1244 # prompt. The default is empty.
1246 # Both inferior and gdb patterns must match for a PASS.
1248 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1251 # 1 if the test failed,
1252 # 0 if the test passes,
1253 # -1 if there was an internal error.
1256 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1257 global inferior_spawn_id gdb_spawn_id
1260 if {$message == ""} {
1261 set message $command
1264 set inferior_matched 0
1267 # Use an indirect spawn id list, and remove the inferior spawn id
1268 # from the expected output as soon as it matches, in case
1269 # $inferior_pattern happens to be a prefix of the resulting full
1270 # gdb pattern below (e.g., "\r\n").
1271 global gdb_test_stdio_spawn_id_list
1272 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1274 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1275 # then we may see gdb's output arriving before the inferior's
1277 set res [gdb_test_multiple $command $message {
1278 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1279 set inferior_matched 1
1280 if {!$gdb_matched} {
1281 set gdb_test_stdio_spawn_id_list ""
1285 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1287 if {!$inferior_matched} {
1295 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1302 # Issue a PASS and return true if evaluating CONDITION in the caller's
1303 # frame returns true, and issue a FAIL and return false otherwise.
1304 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1305 # omitted or is empty, then the pass/fail messages use the condition
1306 # string as the message.
1308 proc gdb_assert { condition {message ""} } {
1309 if { $message == ""} {
1310 set message $condition
1313 set res [uplevel 1 expr $condition]
1322 proc gdb_reinitialize_dir { subdir } {
1325 if [is_remote host] {
1330 -re "Reinitialize source path to empty.*y or n. " {
1333 -re "Source directories searched.*$gdb_prompt $" {
1334 send_gdb "dir $subdir\n"
1336 -re "Source directories searched.*$gdb_prompt $" {
1337 verbose "Dir set to $subdir"
1339 -re "$gdb_prompt $" {
1340 perror "Dir \"$subdir\" failed."
1344 -re "$gdb_prompt $" {
1345 perror "Dir \"$subdir\" failed."
1349 -re "$gdb_prompt $" {
1350 perror "Dir \"$subdir\" failed."
1356 # gdb_exit -- exit the GDB, killing the target program if necessary
1358 proc default_gdb_exit {} {
1360 global INTERNAL_GDBFLAGS GDBFLAGS
1363 global inotify_log_file
1365 gdb_stop_suppressing_tests
1367 if ![info exists gdb_spawn_id] {
1371 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1373 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1374 set fd [open $inotify_log_file]
1375 set data [read -nonewline $fd]
1378 if {[string compare $data ""] != 0} {
1379 warning "parallel-unsafe file creations noticed"
1382 set fd [open $inotify_log_file w]
1387 if { [is_remote host] && [board_info host exists fileid] } {
1394 -re "DOSEXIT code" { }
1399 if ![is_remote host] {
1405 # Load a file into the debugger.
1406 # The return value is 0 for success, -1 for failure.
1408 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1409 # to one of these values:
1411 # debug file was loaded successfully and has debug information
1412 # nodebug file was loaded successfully and has no debug information
1413 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1415 # fail file was not loaded
1417 # I tried returning this information as part of the return value,
1418 # but ran into a mess because of the many re-implementations of
1419 # gdb_load in config/*.exp.
1421 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1422 # this if they can get more information set.
1424 proc gdb_file_cmd { arg } {
1428 global last_loaded_file
1430 # Save this for the benefit of gdbserver-support.exp.
1431 set last_loaded_file $arg
1433 # Set whether debug info was found.
1434 # Default to "fail".
1435 global gdb_file_cmd_debug_info
1436 set gdb_file_cmd_debug_info "fail"
1438 if [is_remote host] {
1439 set arg [remote_download host $arg]
1441 perror "download failed"
1446 # The file command used to kill the remote target. For the benefit
1447 # of the testsuite, preserve this behavior.
1450 -re "Kill the program being debugged. .y or n. $" {
1452 verbose "\t\tKilling previous program being debugged"
1455 -re "$gdb_prompt $" {
1460 send_gdb "file $arg\n"
1462 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1463 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1464 set gdb_file_cmd_debug_info "lzma"
1467 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1468 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1469 set gdb_file_cmd_debug_info "nodebug"
1472 -re "Reading symbols from.*done.*$gdb_prompt $" {
1473 verbose "\t\tLoaded $arg into $GDB"
1474 set gdb_file_cmd_debug_info "debug"
1477 -re "Load new symbol table from \".*\".*y or n. $" {
1480 -re "Reading symbols from.*done.*$gdb_prompt $" {
1481 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1482 set gdb_file_cmd_debug_info "debug"
1486 perror "Couldn't load $arg, other program already loaded (timeout)."
1490 perror "Couldn't load $arg, other program already loaded (eof)."
1495 -re "No such file or directory.*$gdb_prompt $" {
1496 perror "($arg) No such file or directory"
1499 -re "A problem internal to GDB has been detected" {
1500 fail "($arg) (GDB internal error)"
1501 gdb_internal_error_resync
1504 -re "$gdb_prompt $" {
1505 perror "Couldn't load $arg into $GDB."
1509 perror "Couldn't load $arg into $GDB (timeout)."
1513 # This is an attempt to detect a core dump, but seems not to
1514 # work. Perhaps we need to match .* followed by eof, in which
1515 # gdb_expect does not seem to have a way to do that.
1516 perror "Couldn't load $arg into $GDB (eof)."
1522 # Default gdb_spawn procedure.
1524 proc default_gdb_spawn { } {
1527 global INTERNAL_GDBFLAGS GDBFLAGS
1530 gdb_stop_suppressing_tests
1532 # Set the default value, it may be overriden later by specific testfile.
1534 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1535 # is already started after connecting and run/attach are not supported.
1536 # This is used for the "remote" protocol. After GDB starts you should
1537 # check global $use_gdb_stub instead of the board as the testfile may force
1538 # a specific different target protocol itself.
1539 set use_gdb_stub [target_info exists use_gdb_stub]
1541 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1543 if [info exists gdb_spawn_id] {
1547 if ![is_remote host] {
1548 if { [which $GDB] == 0 } then {
1549 perror "$GDB does not exist."
1553 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1554 if { $res < 0 || $res == "" } {
1555 perror "Spawning $GDB failed."
1559 set gdb_spawn_id $res
1563 # Default gdb_start procedure.
1565 proc default_gdb_start { } {
1566 global gdb_prompt pagination_prompt
1568 global inferior_spawn_id
1570 if [info exists gdb_spawn_id] {
1579 # Default to assuming inferior I/O is done on GDB's terminal.
1580 if {![info exists inferior_spawn_id]} {
1581 set inferior_spawn_id $gdb_spawn_id
1584 # When running over NFS, particularly if running many simultaneous
1585 # tests on different hosts all using the same server, things can
1586 # get really slow. Give gdb at least 3 minutes to start up.
1588 while { $loop_again } {
1591 -re "$pagination_prompt" {
1592 verbose "Hit pagination during startup. Pressing enter to continue."
1596 -re "\[\r\n\]$gdb_prompt $" {
1597 verbose "GDB initialized."
1599 -re "$gdb_prompt $" {
1600 perror "GDB never initialized."
1605 perror "(timeout) GDB never initialized after 10 seconds."
1613 # force the height to "unlimited", so no pagers get used
1615 send_gdb "set height 0\n"
1617 -re "$gdb_prompt $" {
1618 verbose "Setting height to 0." 2
1621 warning "Couldn't set the height to 0"
1624 # force the width to "unlimited", so no wraparound occurs
1625 send_gdb "set width 0\n"
1627 -re "$gdb_prompt $" {
1628 verbose "Setting width to 0." 2
1631 warning "Couldn't set the width to 0."
1637 # Utility procedure to give user control of the gdb prompt in a script. It is
1638 # meant to be used for debugging test cases, and should not be left in the
1641 proc gdb_interact { } {
1643 set spawn_id $gdb_spawn_id
1645 send_user "+------------------------------------------+\n"
1646 send_user "| Script interrupted, you can now interact |\n"
1647 send_user "| with by gdb. Type >>> to continue. |\n"
1648 send_user "+------------------------------------------+\n"
1655 # Examine the output of compilation to determine whether compilation
1656 # failed or not. If it failed determine whether it is due to missing
1657 # compiler or due to compiler error. Report pass, fail or unsupported
1660 proc gdb_compile_test {src output} {
1661 if { $output == "" } {
1662 pass "compilation [file tail $src]"
1663 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1664 unsupported "compilation [file tail $src]"
1665 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1666 unsupported "compilation [file tail $src]"
1667 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1668 unsupported "compilation [file tail $src]"
1670 verbose -log "compilation failed: $output" 2
1671 fail "compilation [file tail $src]"
1675 # Return a 1 for configurations for which we don't even want to try to
1678 proc skip_cplus_tests {} {
1679 if { [istarget "h8300-*-*"] } {
1683 # The C++ IO streams are too large for HC11/HC12 and are thus not
1684 # available. The gdb C++ tests use them and don't compile.
1685 if { [istarget "m6811-*-*"] } {
1688 if { [istarget "m6812-*-*"] } {
1694 # Return a 1 for configurations for which don't have both C++ and the STL.
1696 proc skip_stl_tests {} {
1697 # Symbian supports the C++ language, but the STL is missing
1698 # (both headers and libraries).
1699 if { [istarget "arm*-*-symbianelf*"] } {
1703 return [skip_cplus_tests]
1706 # Return a 1 if I don't even want to try to test FORTRAN.
1708 proc skip_fortran_tests {} {
1712 # Return a 1 if I don't even want to try to test ada.
1714 proc skip_ada_tests {} {
1718 # Return a 1 if I don't even want to try to test GO.
1720 proc skip_go_tests {} {
1724 # Return a 1 if I don't even want to try to test java.
1726 proc skip_java_tests {} {
1730 # Return a 1 if I don't even want to try to test D.
1732 proc skip_d_tests {} {
1736 # Return 1 to skip Rust tests, 0 to try them.
1737 proc skip_rust_tests {} {
1738 return [expr {![isnative]}]
1741 # Return a 1 for configurations that do not support Python scripting.
1742 # PROMPT_REGEXP is the expected prompt.
1744 proc skip_python_tests_prompt { prompt_regexp } {
1745 global gdb_py_is_py3k
1746 global gdb_py_is_py24
1748 gdb_test_multiple "python print ('test')" "verify python support" {
1749 -re "not supported.*$prompt_regexp" {
1750 unsupported "Python support is disabled."
1753 -re "$prompt_regexp" {}
1756 set gdb_py_is_py24 0
1757 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1758 -re "3.*$prompt_regexp" {
1759 set gdb_py_is_py3k 1
1761 -re ".*$prompt_regexp" {
1762 set gdb_py_is_py3k 0
1765 if { $gdb_py_is_py3k == 0 } {
1766 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1767 -re "\[45\].*$prompt_regexp" {
1768 set gdb_py_is_py24 1
1770 -re ".*$prompt_regexp" {
1771 set gdb_py_is_py24 0
1779 # Return a 1 for configurations that do not support Python scripting.
1780 # Note: This also sets various globals that specify which version of Python
1781 # is in use. See skip_python_tests_prompt.
1783 proc skip_python_tests {} {
1785 return [skip_python_tests_prompt "$gdb_prompt $"]
1788 # Return a 1 if we should skip shared library tests.
1790 proc skip_shlib_tests {} {
1791 # Run the shared library tests on native systems.
1796 # An abbreviated list of remote targets where we should be able to
1797 # run shared library tests.
1798 if {([istarget *-*-linux*]
1799 || [istarget *-*-*bsd*]
1800 || [istarget *-*-solaris2*]
1801 || [istarget arm*-*-symbianelf*]
1802 || [istarget *-*-mingw*]
1803 || [istarget *-*-cygwin*]
1804 || [istarget *-*-pe*])} {
1811 # Return 1 if we should skip tui related tests.
1813 proc skip_tui_tests {} {
1816 gdb_test_multiple "help layout" "verify tui support" {
1817 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1820 -re "$gdb_prompt $" {
1827 # Test files shall make sure all the test result lines in gdb.sum are
1828 # unique in a test run, so that comparing the gdb.sum files of two
1829 # test runs gives correct results. Test files that exercise
1830 # variations of the same tests more than once, shall prefix the
1831 # different test invocations with different identifying strings in
1832 # order to make them unique.
1834 # About test prefixes:
1836 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1837 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1838 # underlined substring in
1840 # PASS: gdb.base/mytest.exp: some test
1841 # ^^^^^^^^^^^^^^^^^^^^
1845 # The easiest way to adjust the test prefix is to append a test
1846 # variation prefix to the $pf_prefix, using the with_test_prefix
1849 # proc do_tests {} {
1850 # gdb_test ... ... "test foo"
1851 # gdb_test ... ... "test bar"
1853 # with_test_prefix "subvariation a" {
1854 # gdb_test ... ... "test x"
1857 # with_test_prefix "subvariation b" {
1858 # gdb_test ... ... "test x"
1862 # with_test_prefix "variation1" {
1863 # ...do setup for variation 1...
1867 # with_test_prefix "variation2" {
1868 # ...do setup for variation 2...
1874 # PASS: gdb.base/mytest.exp: variation1: test foo
1875 # PASS: gdb.base/mytest.exp: variation1: test bar
1876 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1877 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1878 # PASS: gdb.base/mytest.exp: variation2: test foo
1879 # PASS: gdb.base/mytest.exp: variation2: test bar
1880 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1881 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1883 # If for some reason more flexibility is necessary, one can also
1884 # manipulate the pf_prefix global directly, treating it as a string.
1888 # set saved_pf_prefix
1889 # append pf_prefix "${foo}: bar"
1890 # ... actual tests ...
1891 # set pf_prefix $saved_pf_prefix
1894 # Run BODY in the context of the caller, with the current test prefix
1895 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1896 # Returns the result of BODY.
1898 proc with_test_prefix { prefix body } {
1901 set saved $pf_prefix
1902 append pf_prefix " " $prefix ":"
1903 set code [catch {uplevel 1 $body} result]
1904 set pf_prefix $saved
1907 global errorInfo errorCode
1908 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1910 return -code $code $result
1914 # Wrapper for foreach that calls with_test_prefix on each iteration,
1915 # including the iterator's name and current value in the prefix.
1917 proc foreach_with_prefix {var list body} {
1919 foreach myvar $list {
1920 with_test_prefix "$var=$myvar" {
1926 # Run BODY in the context of the caller. After BODY is run, the variables
1927 # listed in VARS will be reset to the values they had before BODY was run.
1929 # This is useful for providing a scope in which it is safe to temporarily
1930 # modify global variables, e.g.
1932 # global INTERNAL_GDBFLAGS
1935 # set foo GDBHISTSIZE
1937 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1938 # append INTERNAL_GDBFLAGS " -nx"
1939 # unset -nocomplain env(GDBHISTSIZE)
1944 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1945 # modified inside BODY, this proc guarantees that the modifications will be
1946 # undone after BODY finishes executing.
1948 proc save_vars { vars body } {
1949 array set saved_scalars { }
1950 array set saved_arrays { }
1954 # First evaluate VAR in the context of the caller in case the variable
1955 # name may be a not-yet-interpolated string like env($foo)
1956 set var [uplevel 1 list $var]
1958 if [uplevel 1 [list info exists $var]] {
1959 if [uplevel 1 [list array exists $var]] {
1960 set saved_arrays($var) [uplevel 1 [list array get $var]]
1962 set saved_scalars($var) [uplevel 1 [list set $var]]
1965 lappend unset_vars $var
1969 set code [catch {uplevel 1 $body} result]
1971 foreach {var value} [array get saved_scalars] {
1972 uplevel 1 [list set $var $value]
1975 foreach {var value} [array get saved_arrays] {
1976 uplevel 1 [list unset $var]
1977 uplevel 1 [list array set $var $value]
1980 foreach var $unset_vars {
1981 uplevel 1 [list unset -nocomplain $var]
1985 global errorInfo errorCode
1986 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1988 return -code $code $result
1993 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1994 # PROMPT. When BODY is finished, restore GDB prompt and variable
1996 # Returns the result of BODY.
2000 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2001 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2002 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2003 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2004 # a) It's more intuitive for callers to pass the plain text form.
2005 # b) We need two forms of the prompt:
2006 # - a regexp to use in output matching,
2007 # - a value to pass to the "set prompt" command.
2008 # c) It's easier to convert the plain text form to its regexp form.
2010 # 2) Don't add a trailing space, we do that here.
2012 proc with_gdb_prompt { prompt body } {
2015 # Convert "(foo)" to "\(foo\)".
2016 # We don't use string_to_regexp because while it works today it's not
2017 # clear it will work tomorrow: the value we need must work as both a
2018 # regexp *and* as the argument to the "set prompt" command, at least until
2019 # we start recording both forms separately instead of just $gdb_prompt.
2020 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2022 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2024 set saved $gdb_prompt
2026 verbose -log "Setting gdb prompt to \"$prompt \"."
2027 set gdb_prompt $prompt
2028 gdb_test_no_output "set prompt $prompt " ""
2030 set code [catch {uplevel 1 $body} result]
2032 verbose -log "Restoring gdb prompt to \"$saved \"."
2033 set gdb_prompt $saved
2034 gdb_test_no_output "set prompt $saved " ""
2037 global errorInfo errorCode
2038 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2040 return -code $code $result
2044 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2045 # BODY is finished, restore target-charset.
2047 proc with_target_charset { target_charset body } {
2051 gdb_test_multiple "show target-charset" "" {
2052 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2053 set saved $expect_out(1,string)
2055 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2056 set saved $expect_out(1,string)
2058 -re ".*$gdb_prompt " {
2059 fail "get target-charset"
2063 gdb_test_no_output "set target-charset $target_charset" ""
2065 set code [catch {uplevel 1 $body} result]
2067 gdb_test_no_output "set target-charset $saved" ""
2070 global errorInfo errorCode
2071 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2073 return -code $code $result
2077 # Select the largest timeout from all the timeouts:
2078 # - the local "timeout" variable of the scope two levels above,
2079 # - the global "timeout" variable,
2080 # - the board variable "gdb,timeout".
2082 proc get_largest_timeout {} {
2083 upvar #0 timeout gtimeout
2084 upvar 2 timeout timeout
2087 if [info exists timeout] {
2090 if { [info exists gtimeout] && $gtimeout > $tmt } {
2093 if { [target_info exists gdb,timeout]
2094 && [target_info gdb,timeout] > $tmt } {
2095 set tmt [target_info gdb,timeout]
2105 # Run tests in BODY with timeout increased by factor of FACTOR. When
2106 # BODY is finished, restore timeout.
2108 proc with_timeout_factor { factor body } {
2111 set savedtimeout $timeout
2113 set timeout [expr [get_largest_timeout] * $factor]
2114 set code [catch {uplevel 1 $body} result]
2116 set timeout $savedtimeout
2118 global errorInfo errorCode
2119 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2121 return -code $code $result
2125 # Return 1 if _Complex types are supported, otherwise, return 0.
2127 gdb_caching_proc support_complex_tests {
2128 # Set up, compile, and execute a test program containing _Complex types.
2129 # Include the current process ID in the file names to prevent conflicts
2130 # with invocations for multiple testsuites.
2131 set src [standard_temp_file complex[pid].c]
2132 set exe [standard_temp_file complex[pid].x]
2134 gdb_produce_source $src {
2138 _Complex long double cld;
2143 verbose "compiling testfile $src" 2
2144 set compile_flags {debug nowarnings quiet}
2145 set lines [gdb_compile $src $exe executable $compile_flags]
2149 if ![string match "" $lines] then {
2150 verbose "testfile compilation failed, returning 0" 2
2159 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2162 proc supports_get_siginfo_type {} {
2163 if { [istarget "*-*-linux*"] } {
2170 # Return 1 if the target supports hardware single stepping.
2172 proc can_hardware_single_step {} {
2174 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2175 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2176 || [istarget "nios2-*-*"] } {
2183 # Return 1 if target hardware or OS supports single stepping to signal
2184 # handler, otherwise, return 0.
2186 proc can_single_step_to_signal_handler {} {
2187 # Targets don't have hardware single step. On these targets, when
2188 # a signal is delivered during software single step, gdb is unable
2189 # to determine the next instruction addresses, because start of signal
2190 # handler is one of them.
2191 return [can_hardware_single_step]
2194 # Return 1 if target supports process record, otherwise return 0.
2196 proc supports_process_record {} {
2198 if [target_info exists gdb,use_precord] {
2199 return [target_info gdb,use_precord]
2202 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2203 || [istarget "i\[34567\]86-*-linux*"]
2204 || [istarget "aarch64*-*-linux*"]
2205 || [istarget "powerpc*-*-linux*"]
2206 || [istarget "s390*-*-linux*"] } {
2213 # Return 1 if target supports reverse debugging, otherwise return 0.
2215 proc supports_reverse {} {
2217 if [target_info exists gdb,can_reverse] {
2218 return [target_info gdb,can_reverse]
2221 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2222 || [istarget "i\[34567\]86-*-linux*"]
2223 || [istarget "aarch64*-*-linux*"]
2224 || [istarget "powerpc*-*-linux*"]
2225 || [istarget "s390*-*-linux*"] } {
2232 # Return 1 if readline library is used.
2234 proc readline_is_used { } {
2237 gdb_test_multiple "show editing" "" {
2238 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2241 -re ".*$gdb_prompt $" {
2247 # Return 1 if target is ELF.
2248 gdb_caching_proc is_elf_target {
2249 set me "is_elf_target"
2251 set src [standard_temp_file is_elf_target[pid].c]
2252 set obj [standard_temp_file is_elf_target[pid].o]
2254 gdb_produce_source $src {
2255 int foo () {return 0;}
2258 verbose "$me: compiling testfile $src" 2
2259 set lines [gdb_compile $src $obj object {quiet}]
2263 if ![string match "" $lines] then {
2264 verbose "$me: testfile compilation failed, returning 0" 2
2268 set fp_obj [open $obj "r"]
2269 fconfigure $fp_obj -translation binary
2270 set data [read $fp_obj]
2275 set ELFMAG "\u007FELF"
2277 if {[string compare -length 4 $data $ELFMAG] != 0} {
2278 verbose "$me: returning 0" 2
2282 verbose "$me: returning 1" 2
2286 # Return 1 if the memory at address zero is readable.
2288 gdb_caching_proc is_address_zero_readable {
2292 gdb_test_multiple "x 0" "" {
2293 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2296 -re ".*$gdb_prompt $" {
2304 # Produce source file NAME and write SOURCES into it.
2306 proc gdb_produce_source { name sources } {
2308 set f [open $name "w"]
2314 # Return 1 if target is ILP32.
2315 # This cannot be decided simply from looking at the target string,
2316 # as it might depend on externally passed compiler options like -m64.
2317 gdb_caching_proc is_ilp32_target {
2318 set me "is_ilp32_target"
2320 set src [standard_temp_file ilp32[pid].c]
2321 set obj [standard_temp_file ilp32[pid].o]
2323 gdb_produce_source $src {
2324 int dummy[sizeof (int) == 4
2325 && sizeof (void *) == 4
2326 && sizeof (long) == 4 ? 1 : -1];
2329 verbose "$me: compiling testfile $src" 2
2330 set lines [gdb_compile $src $obj object {quiet}]
2334 if ![string match "" $lines] then {
2335 verbose "$me: testfile compilation failed, returning 0" 2
2339 verbose "$me: returning 1" 2
2343 # Return 1 if target is LP64.
2344 # This cannot be decided simply from looking at the target string,
2345 # as it might depend on externally passed compiler options like -m64.
2346 gdb_caching_proc is_lp64_target {
2347 set me "is_lp64_target"
2349 set src [standard_temp_file lp64[pid].c]
2350 set obj [standard_temp_file lp64[pid].o]
2352 gdb_produce_source $src {
2353 int dummy[sizeof (int) == 4
2354 && sizeof (void *) == 8
2355 && sizeof (long) == 8 ? 1 : -1];
2358 verbose "$me: compiling testfile $src" 2
2359 set lines [gdb_compile $src $obj object {quiet}]
2363 if ![string match "" $lines] then {
2364 verbose "$me: testfile compilation failed, returning 0" 2
2368 verbose "$me: returning 1" 2
2372 # Return 1 if target has 64 bit addresses.
2373 # This cannot be decided simply from looking at the target string,
2374 # as it might depend on externally passed compiler options like -m64.
2375 gdb_caching_proc is_64_target {
2376 set me "is_64_target"
2378 set src [standard_temp_file is64[pid].c]
2379 set obj [standard_temp_file is64[pid].o]
2381 gdb_produce_source $src {
2382 int function(void) { return 3; }
2383 int dummy[sizeof (&function) == 8 ? 1 : -1];
2386 verbose "$me: compiling testfile $src" 2
2387 set lines [gdb_compile $src $obj object {quiet}]
2391 if ![string match "" $lines] then {
2392 verbose "$me: testfile compilation failed, returning 0" 2
2396 verbose "$me: returning 1" 2
2400 # Return 1 if target has x86_64 registers - either amd64 or x32.
2401 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2402 # just from the target string.
2403 gdb_caching_proc is_amd64_regs_target {
2404 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2408 set me "is_amd64_regs_target"
2410 set src [standard_temp_file reg64[pid].s]
2411 set obj [standard_temp_file reg64[pid].o]
2415 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2416 lappend list "\tincq %$reg"
2418 gdb_produce_source $src [join $list \n]
2420 verbose "$me: compiling testfile $src" 2
2421 set lines [gdb_compile $src $obj object {quiet}]
2425 if ![string match "" $lines] then {
2426 verbose "$me: testfile compilation failed, returning 0" 2
2430 verbose "$me: returning 1" 2
2434 # Return 1 if this target is an x86 or x86-64 with -m32.
2435 proc is_x86_like_target {} {
2436 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2439 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2442 # Return 1 if this target is an arm or aarch32 on aarch64.
2444 gdb_caching_proc is_aarch32_target {
2445 if { [istarget "arm*-*-*"] } {
2449 if { ![istarget "aarch64*-*-*"] } {
2453 set me "is_aarch32_target"
2455 set src [standard_temp_file aarch32[pid].s]
2456 set obj [standard_temp_file aarch32[pid].o]
2461 lappend list "\tmov $reg, $reg"
2463 gdb_produce_source $src [join $list \n]
2465 verbose "$me: compiling testfile $src" 2
2466 set lines [gdb_compile $src $obj object {quiet}]
2470 if ![string match "" $lines] then {
2471 verbose "$me: testfile compilation failed, returning 0" 2
2475 verbose "$me: returning 1" 2
2479 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2481 proc is_aarch64_target {} {
2482 if { ![istarget "aarch64*-*-*"] } {
2486 return [expr ![is_aarch32_target]]
2489 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2490 proc support_displaced_stepping {} {
2492 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2493 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2494 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2495 || [istarget "aarch64*-*-linux*"] } {
2502 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2503 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2505 gdb_caching_proc skip_altivec_tests {
2506 global srcdir subdir gdb_prompt inferior_exited_re
2508 set me "skip_altivec_tests"
2510 # Some simulators are known to not support VMX instructions.
2511 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2512 verbose "$me: target known to not support VMX, returning 1" 2
2516 # Make sure we have a compiler that understands altivec.
2517 set compile_flags {debug nowarnings}
2518 if [get_compiler_info] {
2519 warning "Could not get compiler info"
2522 if [test_compiler_info gcc*] {
2523 set compile_flags "$compile_flags additional_flags=-maltivec"
2524 } elseif [test_compiler_info xlc*] {
2525 set compile_flags "$compile_flags additional_flags=-qaltivec"
2527 verbose "Could not compile with altivec support, returning 1" 2
2531 # Set up, compile, and execute a test program containing VMX instructions.
2532 # Include the current process ID in the file names to prevent conflicts
2533 # with invocations for multiple testsuites.
2534 set src [standard_temp_file vmx[pid].c]
2535 set exe [standard_temp_file vmx[pid].x]
2537 gdb_produce_source $src {
2540 asm volatile ("vor v0,v0,v0");
2542 asm volatile ("vor 0,0,0");
2548 verbose "$me: compiling testfile $src" 2
2549 set lines [gdb_compile $src $exe executable $compile_flags]
2552 if ![string match "" $lines] then {
2553 verbose "$me: testfile compilation failed, returning 1" 2
2557 # No error message, compilation succeeded so now run it via gdb.
2561 gdb_reinitialize_dir $srcdir/$subdir
2565 -re ".*Illegal instruction.*${gdb_prompt} $" {
2566 verbose -log "\n$me altivec hardware not detected"
2567 set skip_vmx_tests 1
2569 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2570 verbose -log "\n$me: altivec hardware detected"
2571 set skip_vmx_tests 0
2574 warning "\n$me: default case taken"
2575 set skip_vmx_tests 1
2579 remote_file build delete $exe
2581 verbose "$me: returning $skip_vmx_tests" 2
2582 return $skip_vmx_tests
2585 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2586 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2588 gdb_caching_proc skip_vsx_tests {
2589 global srcdir subdir gdb_prompt inferior_exited_re
2591 set me "skip_vsx_tests"
2593 # Some simulators are known to not support Altivec instructions, so
2594 # they won't support VSX instructions as well.
2595 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2596 verbose "$me: target known to not support VSX, returning 1" 2
2600 # Make sure we have a compiler that understands altivec.
2601 set compile_flags {debug nowarnings quiet}
2602 if [get_compiler_info] {
2603 warning "Could not get compiler info"
2606 if [test_compiler_info gcc*] {
2607 set compile_flags "$compile_flags additional_flags=-mvsx"
2608 } elseif [test_compiler_info xlc*] {
2609 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2611 verbose "Could not compile with vsx support, returning 1" 2
2615 set src [standard_temp_file vsx[pid].c]
2616 set exe [standard_temp_file vsx[pid].x]
2618 gdb_produce_source $src {
2620 double a[2] = { 1.0, 2.0 };
2622 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2624 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2630 verbose "$me: compiling testfile $src" 2
2631 set lines [gdb_compile $src $exe executable $compile_flags]
2634 if ![string match "" $lines] then {
2635 verbose "$me: testfile compilation failed, returning 1" 2
2639 # No error message, compilation succeeded so now run it via gdb.
2643 gdb_reinitialize_dir $srcdir/$subdir
2647 -re ".*Illegal instruction.*${gdb_prompt} $" {
2648 verbose -log "\n$me VSX hardware not detected"
2649 set skip_vsx_tests 1
2651 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2652 verbose -log "\n$me: VSX hardware detected"
2653 set skip_vsx_tests 0
2656 warning "\n$me: default case taken"
2657 set skip_vsx_tests 1
2661 remote_file build delete $exe
2663 verbose "$me: returning $skip_vsx_tests" 2
2664 return $skip_vsx_tests
2667 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2668 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2670 gdb_caching_proc skip_tsx_tests {
2671 global srcdir subdir gdb_prompt inferior_exited_re
2673 set me "skip_tsx_tests"
2675 set src [standard_temp_file tsx[pid].c]
2676 set exe [standard_temp_file tsx[pid].x]
2678 gdb_produce_source $src {
2680 asm volatile ("xbegin .L0");
2681 asm volatile ("xend");
2682 asm volatile (".L0: nop");
2687 verbose "$me: compiling testfile $src" 2
2688 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2691 if ![string match "" $lines] then {
2692 verbose "$me: testfile compilation failed." 2
2696 # No error message, compilation succeeded so now run it via gdb.
2700 gdb_reinitialize_dir $srcdir/$subdir
2704 -re ".*Illegal instruction.*${gdb_prompt} $" {
2705 verbose -log "$me: TSX hardware not detected."
2706 set skip_tsx_tests 1
2708 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2709 verbose -log "$me: TSX hardware detected."
2710 set skip_tsx_tests 0
2713 warning "\n$me: default case taken."
2714 set skip_tsx_tests 1
2718 remote_file build delete $exe
2720 verbose "$me: returning $skip_tsx_tests" 2
2721 return $skip_tsx_tests
2724 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2725 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2727 gdb_caching_proc skip_btrace_tests {
2728 global srcdir subdir gdb_prompt inferior_exited_re
2730 set me "skip_btrace_tests"
2731 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2732 verbose "$me: target does not support btrace, returning 1" 2
2736 # Set up, compile, and execute a test program.
2737 # Include the current process ID in the file names to prevent conflicts
2738 # with invocations for multiple testsuites.
2739 set src [standard_temp_file btrace[pid].c]
2740 set exe [standard_temp_file btrace[pid].x]
2742 gdb_produce_source $src {
2743 int main(void) { return 0; }
2746 verbose "$me: compiling testfile $src" 2
2747 set compile_flags {debug nowarnings quiet}
2748 set lines [gdb_compile $src $exe executable $compile_flags]
2750 if ![string match "" $lines] then {
2751 verbose "$me: testfile compilation failed, returning 1" 2
2756 # No error message, compilation succeeded so now run it via gdb.
2760 gdb_reinitialize_dir $srcdir/$subdir
2767 # In case of an unexpected output, we return 2 as a fail value.
2768 set skip_btrace_tests 2
2769 gdb_test_multiple "record btrace" "check btrace support" {
2770 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2771 set skip_btrace_tests 1
2773 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2774 set skip_btrace_tests 1
2776 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2777 set skip_btrace_tests 1
2779 -re "^record btrace\r\n$gdb_prompt $" {
2780 set skip_btrace_tests 0
2784 remote_file build delete $exe
2786 verbose "$me: returning $skip_btrace_tests" 2
2787 return $skip_btrace_tests
2790 # Run a test on the target to see if it supports btrace pt hardware.
2791 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2792 # from the GCC testsuite.
2794 gdb_caching_proc skip_btrace_pt_tests {
2795 global srcdir subdir gdb_prompt inferior_exited_re
2797 set me "skip_btrace_tests"
2798 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2799 verbose "$me: target does not support btrace, returning 1" 2
2803 # Set up, compile, and execute a test program.
2804 # Include the current process ID in the file names to prevent conflicts
2805 # with invocations for multiple testsuites.
2806 set src [standard_temp_file btrace[pid].c]
2807 set exe [standard_temp_file btrace[pid].x]
2809 gdb_produce_source $src {
2810 int main(void) { return 0; }
2813 verbose "$me: compiling testfile $src" 2
2814 set compile_flags {debug nowarnings quiet}
2815 set lines [gdb_compile $src $exe executable $compile_flags]
2817 if ![string match "" $lines] then {
2818 verbose "$me: testfile compilation failed, returning 1" 2
2823 # No error message, compilation succeeded so now run it via gdb.
2827 gdb_reinitialize_dir $srcdir/$subdir
2834 # In case of an unexpected output, we return 2 as a fail value.
2835 set skip_btrace_tests 2
2836 gdb_test_multiple "record btrace pt" "check btrace support" {
2837 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2838 set skip_btrace_tests 1
2840 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2841 set skip_btrace_tests 1
2843 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2844 set skip_btrace_tests 1
2846 -re "GDB does not support.*\r\n$gdb_prompt $" {
2847 set skip_btrace_tests 1
2849 -re "^record btrace pt\r\n$gdb_prompt $" {
2850 set skip_btrace_tests 0
2854 remote_file build delete $exe
2856 verbose "$me: returning $skip_btrace_tests" 2
2857 return $skip_btrace_tests
2860 # Return whether we should skip tests for showing inlined functions in
2861 # backtraces. Requires get_compiler_info and get_debug_format.
2863 proc skip_inline_frame_tests {} {
2864 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2865 if { ! [test_debug_format "DWARF 2"] } {
2869 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2870 if { ([test_compiler_info "gcc-2-*"]
2871 || [test_compiler_info "gcc-3-*"]
2872 || [test_compiler_info "gcc-4-0-*"]) } {
2879 # Return whether we should skip tests for showing variables from
2880 # inlined functions. Requires get_compiler_info and get_debug_format.
2882 proc skip_inline_var_tests {} {
2883 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2884 if { ! [test_debug_format "DWARF 2"] } {
2891 # Return a 1 if we should skip tests that require hardware breakpoints
2893 proc skip_hw_breakpoint_tests {} {
2894 # Skip tests if requested by the board (note that no_hardware_watchpoints
2895 # disables both watchpoints and breakpoints)
2896 if { [target_info exists gdb,no_hardware_watchpoints]} {
2900 # These targets support hardware breakpoints natively
2901 if { [istarget "i?86-*-*"]
2902 || [istarget "x86_64-*-*"]
2903 || [istarget "ia64-*-*"]
2904 || [istarget "arm*-*-*"]
2905 || [istarget "aarch64*-*-*"]} {
2912 # Return a 1 if we should skip tests that require hardware watchpoints
2914 proc skip_hw_watchpoint_tests {} {
2915 # Skip tests if requested by the board
2916 if { [target_info exists gdb,no_hardware_watchpoints]} {
2920 # These targets support hardware watchpoints natively
2921 if { [istarget "i?86-*-*"]
2922 || [istarget "x86_64-*-*"]
2923 || [istarget "ia64-*-*"]
2924 || [istarget "arm*-*-*"]
2925 || [istarget "aarch64*-*-*"]
2926 || [istarget "powerpc*-*-linux*"]
2927 || [istarget "s390*-*-*"] } {
2934 # Return a 1 if we should skip tests that require *multiple* hardware
2935 # watchpoints to be active at the same time
2937 proc skip_hw_watchpoint_multi_tests {} {
2938 if { [skip_hw_watchpoint_tests] } {
2942 # These targets support just a single hardware watchpoint
2943 if { [istarget "arm*-*-*"]
2944 || [istarget "powerpc*-*-linux*"] } {
2951 # Return a 1 if we should skip tests that require read/access watchpoints
2953 proc skip_hw_watchpoint_access_tests {} {
2954 if { [skip_hw_watchpoint_tests] } {
2958 # These targets support just write watchpoints
2959 if { [istarget "s390*-*-*"] } {
2966 # Return 1 if we should skip tests that require the runtime unwinder
2967 # hook. This must be invoked while gdb is running, after shared
2968 # libraries have been loaded. This is needed because otherwise a
2969 # shared libgcc won't be visible.
2971 proc skip_unwinder_tests {} {
2975 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2976 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2978 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2981 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2985 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2986 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2989 -re "\r\n$gdb_prompt $" {
2996 # Return 0 if we should skip tests that require the libstdc++ stap
2997 # probes. This must be invoked while gdb is running, after shared
2998 # libraries have been loaded.
3000 proc skip_libstdcxx_probe_tests {} {
3004 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3005 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3008 -re "\r\n$gdb_prompt $" {
3014 # Return 1 if we should skip tests of the "compile" feature.
3015 # This must be invoked after the inferior has been started.
3017 proc skip_compile_feature_tests {} {
3021 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3022 "Could not load libcc1.*\r\n$gdb_prompt $" {
3025 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3028 -re "\r\n$gdb_prompt $" {
3034 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3037 proc gdb_is_target_remote_prompt { prompt_regexp } {
3039 set test "probe for target remote"
3040 gdb_test_multiple "maint print target-stack" $test {
3041 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3045 -re "$prompt_regexp" {
3052 # Check whether we're testing with the remote or extended-remote
3055 proc gdb_is_target_remote {} {
3058 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3061 # Return the effective value of use_gdb_stub.
3063 # If the use_gdb_stub global has been set (it is set when the gdb process is
3064 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3065 # property from the board file.
3067 # This is the preferred way of checking use_gdb_stub, since it allows to check
3068 # the value before the gdb has been spawned and it will return the correct value
3069 # even when it was overriden by the test.
3071 proc use_gdb_stub {} {
3074 if [info exists use_gdb_stub] {
3075 return $use_gdb_stub
3078 return [target_info exists use_gdb_stub]
3081 # Return 1 if the current remote target is an instance of our GDBserver, 0
3082 # otherwise. Return -1 if there was an error and we can't tell.
3084 gdb_caching_proc target_is_gdbserver {
3088 set test "Probing for GDBserver"
3090 gdb_test_multiple "monitor help" $test {
3091 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3094 -re "$gdb_prompt $" {
3099 if { $is_gdbserver == -1 } {
3100 verbose -log "Unable to tell whether we are using GDBserver or not."
3103 return $is_gdbserver
3106 # N.B. compiler_info is intended to be local to this file.
3107 # Call test_compiler_info with no arguments to fetch its value.
3108 # Yes, this is counterintuitive when there's get_compiler_info,
3109 # but that's the current API.
3110 if [info exists compiler_info] {
3116 # Figure out what compiler I am using.
3117 # The result is cached so only the first invocation runs the compiler.
3119 # ARG can be empty or "C++". If empty, "C" is assumed.
3121 # There are several ways to do this, with various problems.
3123 # [ gdb_compile -E $ifile -o $binfile.ci ]
3124 # source $binfile.ci
3126 # Single Unix Spec v3 says that "-E -o ..." together are not
3127 # specified. And in fact, the native compiler on hp-ux 11 (among
3128 # others) does not work with "-E -o ...". Most targets used to do
3129 # this, and it mostly worked, because it works with gcc.
3131 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3132 # source $binfile.ci
3134 # This avoids the problem with -E and -o together. This almost works
3135 # if the build machine is the same as the host machine, which is
3136 # usually true of the targets which are not gcc. But this code does
3137 # not figure which compiler to call, and it always ends up using the C
3138 # compiler. Not good for setting hp_aCC_compiler. Target
3139 # hppa*-*-hpux* used to do this.
3141 # [ gdb_compile -E $ifile > $binfile.ci ]
3142 # source $binfile.ci
3144 # dejagnu target_compile says that it supports output redirection,
3145 # but the code is completely different from the normal path and I
3146 # don't want to sweep the mines from that path. So I didn't even try
3149 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3152 # I actually do this for all targets now. gdb_compile runs the right
3153 # compiler, and TCL captures the output, and I eval the output.
3155 # Unfortunately, expect logs the output of the command as it goes by,
3156 # and dejagnu helpfully prints a second copy of it right afterwards.
3157 # So I turn off expect logging for a moment.
3159 # [ gdb_compile $ifile $ciexe_file executable $args ]
3160 # [ remote_exec $ciexe_file ]
3161 # [ source $ci_file.out ]
3163 # I could give up on -E and just do this.
3164 # I didn't get desperate enough to try this.
3166 # -- chastain 2004-01-06
3168 proc get_compiler_info {{arg ""}} {
3169 # For compiler.c and compiler.cc
3172 # I am going to play with the log to keep noise out.
3176 # These come from compiler.c or compiler.cc
3177 global compiler_info
3179 # Legacy global data symbols.
3182 if [info exists compiler_info] {
3187 # Choose which file to preprocess.
3188 set ifile "${srcdir}/lib/compiler.c"
3189 if { $arg == "c++" } {
3190 set ifile "${srcdir}/lib/compiler.cc"
3193 # Run $ifile through the right preprocessor.
3194 # Toggle gdb.log to keep the compiler output out of the log.
3195 set saved_log [log_file -info]
3197 if [is_remote host] {
3198 # We have to use -E and -o together, despite the comments
3199 # above, because of how DejaGnu handles remote host testing.
3200 set ppout "$outdir/compiler.i"
3201 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3202 set file [open $ppout r]
3203 set cppout [read $file]
3206 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3208 eval log_file $saved_log
3212 foreach cppline [ split "$cppout" "\n" ] {
3213 if { [ regexp "^#" "$cppline" ] } {
3215 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3217 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3219 verbose "get_compiler_info: $cppline" 2
3223 verbose -log "get_compiler_info: $cppline"
3228 # Set to unknown if for some reason compiler_info didn't get defined.
3229 if ![info exists compiler_info] {
3230 verbose -log "get_compiler_info: compiler_info not provided"
3231 set compiler_info "unknown"
3233 # Also set to unknown compiler if any diagnostics happened.
3235 verbose -log "get_compiler_info: got unexpected diagnostics"
3236 set compiler_info "unknown"
3239 # Set the legacy symbols.
3241 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
3242 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
3243 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
3244 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
3245 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
3247 # Log what happened.
3248 verbose -log "get_compiler_info: $compiler_info"
3250 # Most compilers will evaluate comparisons and other boolean
3251 # operations to 0 or 1.
3252 uplevel \#0 { set true 1 }
3253 uplevel \#0 { set false 0 }
3258 # Return the compiler_info string if no arg is provided.
3259 # Otherwise the argument is a glob-style expression to match against
3262 proc test_compiler_info { {compiler ""} } {
3263 global compiler_info
3266 # If no arg, return the compiler_info string.
3267 if [string match "" $compiler] {
3268 return $compiler_info
3271 return [string match $compiler $compiler_info]
3274 proc current_target_name { } {
3276 if [info exists target_info(target,name)] {
3277 set answer $target_info(target,name)
3284 set gdb_wrapper_initialized 0
3285 set gdb_wrapper_target ""
3287 proc gdb_wrapper_init { args } {
3288 global gdb_wrapper_initialized
3289 global gdb_wrapper_file
3290 global gdb_wrapper_flags
3291 global gdb_wrapper_target
3293 if { $gdb_wrapper_initialized == 1 } { return; }
3295 if {[target_info exists needs_status_wrapper] && \
3296 [target_info needs_status_wrapper] != "0"} {
3297 set result [build_wrapper "testglue.o"]
3298 if { $result != "" } {
3299 set gdb_wrapper_file [lindex $result 0]
3300 set gdb_wrapper_flags [lindex $result 1]
3302 warning "Status wrapper failed to build."
3305 set gdb_wrapper_initialized 1
3306 set gdb_wrapper_target [current_target_name]
3309 # Some targets need to always link a special object in. Save its path here.
3310 global gdb_saved_set_unbuffered_mode_obj
3311 set gdb_saved_set_unbuffered_mode_obj ""
3313 # Compile source files specified by SOURCE into a binary of type TYPE at path
3314 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3315 # parameter and most options are passed directly to it.
3317 # The type can be one of the following:
3319 # - object: Compile into an object file.
3320 # - executable: Compile and link into an executable.
3321 # - preprocess: Preprocess the source files.
3322 # - assembly: Generate assembly listing.
3324 # The following options are understood and processed by gdb_compile:
3326 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3327 # quirks to be able to use shared libraries.
3328 # - shlib_load: Link with appropriate libraries to allow the test to
3329 # dynamically load libraries at runtime. For example, on Linux, this adds
3330 # -ldl so that the test can use dlopen.
3331 # - nowarnings: Inhibit all compiler warnings.
3333 # And here are some of the not too obscure options understood by DejaGnu that
3334 # influence the compilation:
3336 # - additional_flags=flag: Add FLAG to the compiler flags.
3337 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3338 # argument can be a file, in which case it's added to the sources, or a
3340 # - ldflags=flag: Add FLAG to the linker flags.
3341 # - incdir=path: Add PATH to the searched include directories.
3342 # - libdir=path: Add PATH to the linker searched directories.
3343 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3344 # - debug: Build with debug information.
3345 # - optimize: Build with optimization.
3347 proc gdb_compile {source dest type options} {
3348 global GDB_TESTCASE_OPTIONS
3349 global gdb_wrapper_file
3350 global gdb_wrapper_flags
3351 global gdb_wrapper_initialized
3354 global gdb_saved_set_unbuffered_mode_obj
3356 set outdir [file dirname $dest]
3358 # Add platform-specific options if a shared library was specified using
3359 # "shlib=librarypath" in OPTIONS.
3363 foreach opt $options {
3364 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3365 if [test_compiler_info "xlc-*"] {
3366 # IBM xlc compiler doesn't accept shared library named other
3367 # than .so: use "-Wl," to bypass this
3368 lappend source "-Wl,$shlib_name"
3369 } elseif { ([istarget "*-*-mingw*"]
3370 || [istarget *-*-cygwin*]
3371 || [istarget *-*-pe*])} {
3372 lappend source "${shlib_name}.a"
3374 lappend source $shlib_name
3376 if { $shlib_found == 0 } {
3378 if { ([istarget "*-*-mingw*"]
3379 || [istarget *-*-cygwin*]) } {
3380 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3382 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3383 # Undo debian's change in the default.
3384 # Put it at the front to not override any user-provided
3385 # value, and to make sure it appears in front of all the
3387 lappend new_options "early_flags=-Wl,--no-as-needed"
3390 } elseif { $opt == "shlib_load" } {
3393 lappend new_options $opt
3397 # Because we link with libraries using their basename, we may need
3398 # (depending on the platform) to set a special rpath value, to allow
3399 # the executable to find the libraries it depends on.
3400 if { $shlib_load || $shlib_found } {
3401 if { ([istarget "*-*-mingw*"]
3402 || [istarget *-*-cygwin*]
3403 || [istarget *-*-pe*]) } {
3404 # Do not need anything.
3405 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3406 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3407 } elseif { [istarget arm*-*-symbianelf*] } {
3408 if { $shlib_load } {
3409 lappend new_options "libs=-ldl"
3412 if { $shlib_load } {
3413 lappend new_options "libs=-ldl"
3415 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3418 set options $new_options
3420 if [info exists GDB_TESTCASE_OPTIONS] {
3421 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3423 verbose "options are $options"
3424 verbose "source is $source $dest $type $options"
3426 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3428 if {[target_info exists needs_status_wrapper] && \
3429 [target_info needs_status_wrapper] != "0" && \
3430 [info exists gdb_wrapper_file]} {
3431 lappend options "libs=${gdb_wrapper_file}"
3432 lappend options "ldflags=${gdb_wrapper_flags}"
3435 # Replace the "nowarnings" option with the appropriate additional_flags
3436 # to disable compiler warnings.
3437 set nowarnings [lsearch -exact $options nowarnings]
3438 if {$nowarnings != -1} {
3439 if [target_info exists gdb,nowarnings_flag] {
3440 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3442 set flag "additional_flags=-w"
3444 set options [lreplace $options $nowarnings $nowarnings $flag]
3447 if { $type == "executable" } {
3448 if { ([istarget "*-*-mingw*"]
3449 || [istarget "*-*-*djgpp"]
3450 || [istarget "*-*-cygwin*"])} {
3451 # Force output to unbuffered mode, by linking in an object file
3452 # with a global contructor that calls setvbuf.
3454 # Compile the special object seperatelly for two reasons:
3455 # 1) Insulate it from $options.
3456 # 2) Avoid compiling it for every gdb_compile invocation,
3457 # which is time consuming, especially if we're remote
3460 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3461 verbose "compiling gdb_saved_set_unbuffered_obj"
3462 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3463 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3465 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3466 if { $result != "" } {
3469 if {[is_remote host]} {
3470 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3472 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3474 # Link a copy of the output object, because the
3475 # original may be automatically deleted.
3476 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3478 verbose "gdb_saved_set_unbuffered_obj already compiled"
3481 # Rely on the internal knowledge that the global ctors are ran in
3482 # reverse link order. In that case, we can use ldflags to
3483 # avoid copying the object file to the host multiple
3485 # This object can only be added if standard libraries are
3486 # used. Thus, we need to disable it if -nostdlib option is used
3487 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3488 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3493 set result [target_compile $source $dest $type $options]
3495 # Prune uninteresting compiler (and linker) output.
3496 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3498 regsub "\[\r\n\]*$" "$result" "" result
3499 regsub "^\[\r\n\]*" "$result" "" result
3501 if {[lsearch $options quiet] < 0} {
3502 # We shall update this on a per language basis, to avoid
3503 # changing the entire testsuite in one go.
3504 if {[lsearch $options f77] >= 0} {
3505 gdb_compile_test $source $result
3506 } elseif { $result != "" } {
3507 clone_output "gdb compile failed, $result"
3514 # This is just like gdb_compile, above, except that it tries compiling
3515 # against several different thread libraries, to see which one this
3517 proc gdb_compile_pthreads {source dest type options} {
3519 set why_msg "unrecognized error"
3520 foreach lib {-lpthreads -lpthread -lthread ""} {
3521 # This kind of wipes out whatever libs the caller may have
3522 # set. Or maybe theirs will override ours. How infelicitous.
3523 set options_with_lib [concat $options [list libs=$lib quiet]]
3524 set ccout [gdb_compile $source $dest $type $options_with_lib]
3525 switch -regexp -- $ccout {
3526 ".*no posix threads support.*" {
3527 set why_msg "missing threads include file"
3530 ".*cannot open -lpthread.*" {
3531 set why_msg "missing runtime threads library"
3533 ".*Can't find library for -lpthread.*" {
3534 set why_msg "missing runtime threads library"
3537 pass "successfully compiled posix threads test case"
3543 if {!$built_binfile} {
3544 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3549 # Build a shared library from SOURCES.
3551 proc gdb_compile_shlib {sources dest options} {
3552 set obj_options $options
3555 if { [lsearch -exact $options "c++"] >= 0 } {
3556 set info_options "c++"
3558 if [get_compiler_info ${info_options}] {
3562 switch -glob [test_compiler_info] {
3564 lappend obj_options "additional_flags=-qpic"
3567 if { !([istarget "*-*-cygwin*"]
3568 || [istarget "*-*-mingw*"]) } {
3569 lappend obj_options "additional_flags=-fpic"
3573 if { !([istarget "powerpc*-*-aix*"]
3574 || [istarget "rs6000*-*-aix*"]
3575 || [istarget "*-*-cygwin*"]
3576 || [istarget "*-*-mingw*"]
3577 || [istarget "*-*-pe*"]) } {
3578 lappend obj_options "additional_flags=-fpic"
3582 lappend obj_options "additional_flags=-fpic"
3585 # don't know what the compiler is...
3589 set outdir [file dirname $dest]
3591 foreach source $sources {
3592 set sourcebase [file tail $source]
3593 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3596 lappend objects ${outdir}/${sourcebase}.o
3599 set link_options $options
3600 if [test_compiler_info "xlc-*"] {
3601 lappend link_options "additional_flags=-qmkshrobj"
3603 lappend link_options "additional_flags=-shared"
3605 if { ([istarget "*-*-mingw*"]
3606 || [istarget *-*-cygwin*]
3607 || [istarget *-*-pe*]) } {
3608 if { [is_remote host] } {
3609 set name [file tail ${dest}]
3613 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3615 # Set the soname of the library. This causes the linker on ELF
3616 # systems to create the DT_NEEDED entry in the executable referring
3617 # to the soname of the library, and not its absolute path. This
3618 # (using the absolute path) would be problem when testing on a
3621 # In conjunction with setting the soname, we add the special
3622 # rpath=$ORIGIN value when building the executable, so that it's
3623 # able to find the library in its own directory.
3624 set destbase [file tail $dest]
3625 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3628 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3631 if { [is_remote host]
3632 && ([istarget "*-*-mingw*"]
3633 || [istarget *-*-cygwin*]
3634 || [istarget *-*-pe*]) } {
3635 set dest_tail_name [file tail ${dest}]
3636 remote_upload host $dest_tail_name.a ${dest}.a
3637 remote_file host delete $dest_tail_name.a
3643 # This is just like gdb_compile_shlib, above, except that it tries compiling
3644 # against several different thread libraries, to see which one this
3646 proc gdb_compile_shlib_pthreads {sources dest options} {
3648 set why_msg "unrecognized error"
3649 foreach lib {-lpthreads -lpthread -lthread ""} {
3650 # This kind of wipes out whatever libs the caller may have
3651 # set. Or maybe theirs will override ours. How infelicitous.
3652 set options_with_lib [concat $options [list libs=$lib quiet]]
3653 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3654 switch -regexp -- $ccout {
3655 ".*no posix threads support.*" {
3656 set why_msg "missing threads include file"
3659 ".*cannot open -lpthread.*" {
3660 set why_msg "missing runtime threads library"
3662 ".*Can't find library for -lpthread.*" {
3663 set why_msg "missing runtime threads library"
3666 pass "successfully compiled posix threads test case"
3672 if {!$built_binfile} {
3673 unsupported "Couldn't compile $sources: ${why_msg}"
3678 # This is just like gdb_compile_pthreads, above, except that we always add the
3679 # objc library for compiling Objective-C programs
3680 proc gdb_compile_objc {source dest type options} {
3682 set why_msg "unrecognized error"
3683 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3684 # This kind of wipes out whatever libs the caller may have
3685 # set. Or maybe theirs will override ours. How infelicitous.
3686 if { $lib == "solaris" } {
3687 set lib "-lpthread -lposix4"
3689 if { $lib != "-lobjc" } {
3690 set lib "-lobjc $lib"
3692 set options_with_lib [concat $options [list libs=$lib quiet]]
3693 set ccout [gdb_compile $source $dest $type $options_with_lib]
3694 switch -regexp -- $ccout {
3695 ".*no posix threads support.*" {
3696 set why_msg "missing threads include file"
3699 ".*cannot open -lpthread.*" {
3700 set why_msg "missing runtime threads library"
3702 ".*Can't find library for -lpthread.*" {
3703 set why_msg "missing runtime threads library"
3706 pass "successfully compiled objc with posix threads test case"
3712 if {!$built_binfile} {
3713 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3718 proc send_gdb { string } {
3719 global suppress_flag
3720 if { $suppress_flag } {
3723 return [remote_send host "$string"]
3726 # Send STRING to the inferior's terminal.
3728 proc send_inferior { string } {
3729 global inferior_spawn_id
3731 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3741 proc gdb_expect { args } {
3742 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3743 set atimeout [lindex $args 0]
3744 set expcode [list [lindex $args 1]]
3749 # A timeout argument takes precedence, otherwise of all the timeouts
3750 # select the largest.
3751 if [info exists atimeout] {
3754 set tmt [get_largest_timeout]
3757 global suppress_flag
3758 global remote_suppress_flag
3759 if [info exists remote_suppress_flag] {
3760 set old_val $remote_suppress_flag
3762 if [info exists suppress_flag] {
3763 if { $suppress_flag } {
3764 set remote_suppress_flag 1
3768 {uplevel remote_expect host $tmt $expcode} string]
3769 if [info exists old_val] {
3770 set remote_suppress_flag $old_val
3772 if [info exists remote_suppress_flag] {
3773 unset remote_suppress_flag
3778 global errorInfo errorCode
3780 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3782 return -code $code $string
3786 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3788 # Check for long sequence of output by parts.
3789 # TEST: is the test message to be printed with the test success/fail.
3790 # SENTINEL: Is the terminal pattern indicating that output has finished.
3791 # LIST: is the sequence of outputs to match.
3792 # If the sentinel is recognized early, it is considered an error.
3795 # 1 if the test failed,
3796 # 0 if the test passes,
3797 # -1 if there was an internal error.
3799 proc gdb_expect_list {test sentinel list} {
3801 global suppress_flag
3804 if { $suppress_flag } {
3806 unresolved "${test}"
3808 while { ${index} < [llength ${list}] } {
3809 set pattern [lindex ${list} ${index}]
3810 set index [expr ${index} + 1]
3811 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3812 if { ${index} == [llength ${list}] } {
3815 -re "${pattern}${sentinel}" {
3816 # pass "${test}, pattern ${index} + sentinel"
3819 fail "${test} (pattern ${index} + sentinel)"
3822 -re ".*A problem internal to GDB has been detected" {
3823 fail "${test} (GDB internal error)"
3825 gdb_internal_error_resync
3828 fail "${test} (pattern ${index} + sentinel) (timeout)"
3833 # unresolved "${test}, pattern ${index} + sentinel"
3839 # pass "${test}, pattern ${index}"
3842 fail "${test} (pattern ${index})"
3845 -re ".*A problem internal to GDB has been detected" {
3846 fail "${test} (GDB internal error)"
3848 gdb_internal_error_resync
3851 fail "${test} (pattern ${index}) (timeout)"
3856 # unresolved "${test}, pattern ${index}"
3870 proc gdb_suppress_entire_file { reason } {
3871 global suppress_flag
3874 set suppress_flag -1
3878 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3879 # gdb_expect to fail immediately (until the next call to
3880 # gdb_stop_suppressing_tests).
3882 proc gdb_suppress_tests { args } {
3883 global suppress_flag
3885 return; # fnf - disable pending review of results where
3886 # testsuite ran better without this
3889 if { $suppress_flag == 1 } {
3890 if { [llength $args] > 0 } {
3891 warning "[lindex $args 0]\n"
3893 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3899 # Clear suppress_flag.
3901 proc gdb_stop_suppressing_tests { } {
3902 global suppress_flag
3904 if [info exists suppress_flag] {
3905 if { $suppress_flag > 0 } {
3907 clone_output "Tests restarted.\n"
3914 proc gdb_clear_suppressed { } {
3915 global suppress_flag
3920 # Spawn the gdb process.
3922 # This doesn't expect any output or do any other initialization,
3923 # leaving those to the caller.
3925 # Overridable function -- you can override this function in your
3928 proc gdb_spawn { } {
3932 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3934 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3937 set saved_gdbflags $GDBFLAGS
3939 if {$GDBFLAGS != ""} {
3942 append GDBFLAGS $cmdline_flags
3946 set GDBFLAGS $saved_gdbflags
3951 # Start gdb running, wait for prompt, and disable the pagers.
3953 # Overridable function -- you can override this function in your
3956 proc gdb_start { } {
3961 catch default_gdb_exit
3964 # Return true if we can spawn a program on the target and attach to
3967 proc can_spawn_for_attach { } {
3968 # We use exp_pid to get the inferior's pid, assuming that gives
3969 # back the pid of the program. On remote boards, that would give
3970 # us instead the PID of e.g., the ssh client, etc.
3971 if [is_remote target] then {
3975 # The "attach" command doesn't make sense when the target is
3976 # stub-like, where GDB finds the program already started on
3977 # initial connection.
3978 if {[target_info exists use_gdb_stub]} {
3986 # Kill a progress previously started with spawn_wait_for_attach, and
3987 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
3990 proc kill_wait_spawned_process { proc_spawn_id } {
3991 set pid [exp_pid -i $proc_spawn_id]
3993 verbose -log "killing ${pid}"
3994 remote_exec build "kill -9 ${pid}"
3996 verbose -log "closing ${proc_spawn_id}"
3997 catch "close -i $proc_spawn_id"
3998 verbose -log "waiting for ${proc_spawn_id}"
4000 # If somehow GDB ends up still attached to the process here, a
4001 # blocking wait hangs until gdb is killed (or until gdb / the
4002 # ptracer reaps the exit status too, but that won't happen because
4003 # something went wrong.) Passing -nowait makes expect tell Tcl to
4004 # wait for the PID in the background. That's fine because we
4005 # don't care about the exit status. */
4006 wait -nowait -i $proc_spawn_id
4009 # Returns the process id corresponding to the given spawn id.
4011 proc spawn_id_get_pid { spawn_id } {
4012 set testpid [exp_pid -i $spawn_id]
4014 if { [istarget "*-*-cygwin*"] } {
4015 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4016 # might be different due to the way fork/exec works.
4017 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4023 # Start a set of programs running and then wait for a bit, to be sure
4024 # that they can be attached to. Return a list of processes spawn IDs,
4025 # one element for each process spawned. It's a test error to call
4026 # this when [can_spawn_for_attach] is false.
4028 proc spawn_wait_for_attach { executable_list } {
4029 set spawn_id_list {}
4031 if ![can_spawn_for_attach] {
4032 # The caller should have checked can_spawn_for_attach itself
4033 # before getting here.
4034 error "can't spawn for attach with this target/board"
4037 foreach {executable} $executable_list {
4038 # Note we use Expect's spawn, not Tcl's exec, because with
4039 # spawn we control when to wait for/reap the process. That
4040 # allows killing the process by PID without being subject to
4042 lappend spawn_id_list [remote_spawn target $executable]
4047 return $spawn_id_list
4051 # gdb_load_cmd -- load a file into the debugger.
4052 # ARGS - additional args to load command.
4053 # return a -1 if anything goes wrong.
4055 proc gdb_load_cmd { args } {
4058 if [target_info exists gdb_load_timeout] {
4059 set loadtimeout [target_info gdb_load_timeout]
4061 set loadtimeout 1600
4063 send_gdb "load $args\n"
4064 verbose "Timeout is now $loadtimeout seconds" 2
4065 gdb_expect $loadtimeout {
4066 -re "Loading section\[^\r\]*\r\n" {
4069 -re "Start address\[\r\]*\r\n" {
4072 -re "Transfer rate\[\r\]*\r\n" {
4075 -re "Memory access error\[^\r\]*\r\n" {
4076 perror "Failed to load program"
4079 -re "$gdb_prompt $" {
4082 -re "(.*)\r\n$gdb_prompt " {
4083 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4087 perror "Timed out trying to load $args."
4094 # Invoke "gcore". CORE is the name of the core file to write. TEST
4095 # is the name of the test case. This will return 1 if the core file
4096 # was created, 0 otherwise. If this fails to make a core file because
4097 # this configuration of gdb does not support making core files, it
4098 # will call "unsupported", not "fail". However, if this fails to make
4099 # a core file for some other reason, then it will call "fail".
4101 proc gdb_gcore_cmd {core test} {
4105 gdb_test_multiple "gcore $core" $test {
4106 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4110 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4118 # Load core file CORE. TEST is the name of the test case.
4119 # This will record a pass/fail for loading the core file.
4121 # 1 - core file is successfully loaded
4122 # 0 - core file loaded but has a non fatal error
4123 # -1 - core file failed to load
4125 proc gdb_core_cmd { core test } {
4128 gdb_test_multiple "core $core" "$test" {
4129 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4132 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4133 fail "$test (bad file format)"
4136 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4137 fail "$test (file not found)"
4140 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4141 fail "$test (incomplete note section)"
4144 -re "Core was generated by .*\r\n$gdb_prompt $" {
4148 -re ".*$gdb_prompt $" {
4153 fail "$test (timeout)"
4157 fail "unsupported output from 'core' command"
4161 # Return the filename to download to the target and load on the target
4162 # for this shared library. Normally just LIBNAME, unless shared libraries
4163 # for this target have separate link and load images.
4165 proc shlib_target_file { libname } {
4169 # Return the filename GDB will load symbols from when debugging this
4170 # shared library. Normally just LIBNAME, unless shared libraries for
4171 # this target have separate link and load images.
4173 proc shlib_symbol_file { libname } {
4177 # Return the filename to download to the target and load for this
4178 # executable. Normally just BINFILE unless it is renamed to something
4179 # else for this target.
4181 proc exec_target_file { binfile } {
4185 # Return the filename GDB will load symbols from when debugging this
4186 # executable. Normally just BINFILE unless executables for this target
4187 # have separate files for symbols.
4189 proc exec_symbol_file { binfile } {
4193 # Rename the executable file. Normally this is just BINFILE1 being renamed
4194 # to BINFILE2, but some targets require multiple binary files.
4195 proc gdb_rename_execfile { binfile1 binfile2 } {
4196 file rename -force [exec_target_file ${binfile1}] \
4197 [exec_target_file ${binfile2}]
4198 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4199 file rename -force [exec_symbol_file ${binfile1}] \
4200 [exec_symbol_file ${binfile2}]
4204 # "Touch" the executable file to update the date. Normally this is just
4205 # BINFILE, but some targets require multiple files.
4206 proc gdb_touch_execfile { binfile } {
4207 set time [clock seconds]
4208 file mtime [exec_target_file ${binfile}] $time
4209 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4210 file mtime [exec_symbol_file ${binfile}] $time
4214 # Like remote_download but provides a gdb-specific behavior.
4216 # If the destination board is remote, the local file FROMFILE is transferred as
4217 # usual with remote_download to TOFILE on the remote board. The destination
4218 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4221 # If the destination board is local, the destination path TOFILE is passed
4222 # through standard_output_file, and FROMFILE is copied there.
4224 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4227 proc gdb_remote_download {dest fromfile {tofile {}}} {
4228 # If TOFILE is not given, default to the same filename as FROMFILE.
4229 if {[string length $tofile] == 0} {
4230 set tofile [file tail $fromfile]
4233 if {[is_remote $dest]} {
4234 # When the DEST is remote, we simply send the file to DEST.
4237 set destname [remote_download $dest $fromfile $tofile]
4238 lappend cleanfiles $destname
4242 # When the DEST is local, we copy the file to the test directory (where
4243 # the executable is).
4245 # Note that we pass TOFILE through standard_output_file, regardless of
4246 # whether it is absolute or relative, because we don't want the tests
4247 # to be able to write outside their standard output directory.
4249 set tofile [standard_output_file $tofile]
4251 file copy -force $fromfile $tofile
4257 # gdb_load_shlib LIB...
4259 # Copy the listed library to the target.
4261 proc gdb_load_shlib { file } {
4262 set dest [gdb_remote_download target [shlib_target_file $file]]
4264 if {[is_remote target]} {
4265 # If the target is remote, we need to tell gdb where to find the
4268 # We could set this even when not testing remotely, but a user
4269 # generally won't set it unless necessary. In order to make the tests
4270 # more like the real-life scenarios, we don't set it for local testing.
4271 gdb_test "set solib-search-path [file dirname $file]" "" ""
4278 # gdb_load -- load a file into the debugger. Specifying no file
4279 # defaults to the executable currently being debugged.
4280 # The return value is 0 for success, -1 for failure.
4281 # Many files in config/*.exp override this procedure.
4283 proc gdb_load { arg } {
4285 return [gdb_file_cmd $arg]
4290 # gdb_reload -- load a file into the target. Called before "running",
4291 # either the first time or after already starting the program once,
4292 # for remote targets. Most files that override gdb_load should now
4293 # override this instead.
4295 proc gdb_reload { } {
4296 # For the benefit of existing configurations, default to gdb_load.
4297 # Specifying no file defaults to the executable currently being
4299 return [gdb_load ""]
4302 proc gdb_continue { function } {
4305 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4308 proc default_gdb_init { test_file_name } {
4309 global gdb_wrapper_initialized
4310 global gdb_wrapper_target
4311 global gdb_test_file_name
4317 gdb_clear_suppressed
4319 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4321 # Make sure that the wrapper is rebuilt
4322 # with the appropriate multilib option.
4323 if { $gdb_wrapper_target != [current_target_name] } {
4324 set gdb_wrapper_initialized 0
4327 # Unlike most tests, we have a small number of tests that generate
4328 # a very large amount of output. We therefore increase the expect
4329 # buffer size to be able to contain the entire test output. This
4330 # is especially needed by gdb.base/info-macros.exp.
4332 # Also set this value for the currently running GDB.
4333 match_max [match_max -d]
4335 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4336 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4339 if [target_info exists gdb_prompt] {
4340 set gdb_prompt [target_info gdb_prompt]
4342 set gdb_prompt "\\(gdb\\)"
4345 if [info exists use_gdb_stub] {
4350 # Return a path using GDB_PARALLEL.
4351 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4352 # GDB_PARALLEL must be defined, the caller must check.
4354 # The default value for GDB_PARALLEL is, canonically, ".".
4355 # The catch is that tests don't expect an additional "./" in file paths so
4356 # omit any directory for the default case.
4357 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4358 # its special handling.
4360 proc make_gdb_parallel_path { args } {
4361 global GDB_PARALLEL objdir
4362 set joiner [list "file" "join" $objdir]
4363 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4364 lappend joiner $GDB_PARALLEL
4366 set joiner [concat $joiner $args]
4367 return [eval $joiner]
4370 # Turn BASENAME into a full file name in the standard output
4371 # directory. It is ok if BASENAME is the empty string; in this case
4372 # the directory is returned.
4374 proc standard_output_file {basename} {
4375 global objdir subdir gdb_test_file_name
4377 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4379 return [file join $dir $basename]
4382 # Return the name of a file in our standard temporary directory.
4384 proc standard_temp_file {basename} {
4385 # Since a particular runtest invocation is only executing a single test
4386 # file at any given time, we can use the runtest pid to build the
4387 # path of the temp directory.
4388 set dir [make_gdb_parallel_path temp [pid]]
4390 return [file join $dir $basename]
4393 # Set 'testfile', 'srcfile', and 'binfile'.
4395 # ARGS is a list of source file specifications.
4396 # Without any arguments, the .exp file's base name is used to
4397 # compute the source file name. The ".c" extension is added in this case.
4398 # If ARGS is not empty, each entry is a source file specification.
4399 # If the specification starts with a ".", it is treated as a suffix
4400 # to append to the .exp file's base name.
4401 # If the specification is the empty string, it is treated as if it
4403 # Otherwise it is a file name.
4404 # The first file in the list is used to set the 'srcfile' global.
4405 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4407 # Most tests should call this without arguments.
4409 # If a completely different binary file name is needed, then it
4410 # should be handled in the .exp file with a suitable comment.
4412 proc standard_testfile {args} {
4413 global gdb_test_file_name
4415 global gdb_test_file_last_vars
4418 global testfile binfile
4420 set testfile $gdb_test_file_name
4421 set binfile [standard_output_file ${testfile}]
4423 if {[llength $args] == 0} {
4427 # Unset our previous output variables.
4428 # This can help catch hidden bugs.
4429 if {[info exists gdb_test_file_last_vars]} {
4430 foreach varname $gdb_test_file_last_vars {
4432 catch {unset $varname}
4435 # 'executable' is often set by tests.
4436 set gdb_test_file_last_vars {executable}
4440 set varname srcfile$suffix
4443 # Handle an extension.
4446 } elseif {[string range $arg 0 0] == "."} {
4447 set arg $testfile$arg
4451 lappend gdb_test_file_last_vars $varname
4453 if {$suffix == ""} {
4461 # The default timeout used when testing GDB commands. We want to use
4462 # the same timeout as the default dejagnu timeout, unless the user has
4463 # already provided a specific value (probably through a site.exp file).
4464 global gdb_test_timeout
4465 if ![info exists gdb_test_timeout] {
4466 set gdb_test_timeout $timeout
4469 # A list of global variables that GDB testcases should not use.
4470 # We try to prevent their use by monitoring write accesses and raising
4471 # an error when that happens.
4472 set banned_variables { bug_id prms_id }
4474 # A list of procedures that GDB testcases should not use.
4475 # We try to prevent their use by monitoring invocations and raising
4476 # an error when that happens.
4477 set banned_procedures { strace }
4479 # gdb_init is called by runtest at start, but also by several
4480 # tests directly; gdb_finish is only called from within runtest after
4481 # each test source execution.
4482 # Placing several traces by repetitive calls to gdb_init leads
4483 # to problems, as only one trace is removed in gdb_finish.
4484 # To overcome this possible problem, we add a variable that records
4485 # if the banned variables and procedures are already traced.
4488 proc gdb_init { test_file_name } {
4489 # Reset the timeout value to the default. This way, any testcase
4490 # that changes the timeout value without resetting it cannot affect
4491 # the timeout used in subsequent testcases.
4492 global gdb_test_timeout
4494 set timeout $gdb_test_timeout
4496 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4497 && [target_info exists gdb_reverse_timeout] } {
4498 set timeout [target_info gdb_reverse_timeout]
4501 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4502 # debugging tool to help confirm that the test suite is
4503 # parallel-safe. You need "inotifywait" from the
4504 # inotify-tools package to use this.
4505 global GDB_INOTIFY inotify_pid
4506 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4507 global outdir tool inotify_log_file
4509 set exclusions {outputs temp gdb[.](log|sum) cache}
4510 set exclusion_re ([join $exclusions |])
4512 set inotify_log_file [standard_temp_file inotify.out]
4513 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4514 --exclude $exclusion_re \
4515 |& tee -a $outdir/$tool.log $inotify_log_file &]
4517 # Wait for the watches; hopefully this is long enough.
4520 # Clear the log so that we don't emit a warning the first time
4522 set fd [open $inotify_log_file w]
4526 # Block writes to all banned variables, and invocation of all
4527 # banned procedures...
4528 global banned_variables
4529 global banned_procedures
4530 global banned_traced
4531 if (!$banned_traced) {
4532 foreach banned_var $banned_variables {
4533 global "$banned_var"
4534 trace add variable "$banned_var" write error
4536 foreach banned_proc $banned_procedures {
4537 global "$banned_proc"
4538 trace add execution "$banned_proc" enter error
4543 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4544 # messages as expected.
4549 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4550 # the test results. Even if /dev/null doesn't exist on the particular
4551 # platform, the readline library will use the default setting just by
4552 # failing to open the file. OTOH, opening /dev/null successfully will
4553 # also result in the default settings being used since nothing will be
4554 # read from this file.
4555 setenv INPUTRC "/dev/null"
4557 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4558 # bindings, so make sure that an appropriate terminal is selected.
4559 # The same bug doesn't show up if we use ^P / ^N instead.
4562 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4563 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4564 # especially having color output turned on can cause tests to fail.
4565 setenv GREP_OPTIONS ""
4567 # Clear $gdbserver_reconnect_p.
4568 global gdbserver_reconnect_p
4569 set gdbserver_reconnect_p 1
4570 unset gdbserver_reconnect_p
4572 return [default_gdb_init $test_file_name]
4575 proc gdb_finish { } {
4576 global gdbserver_reconnect_p
4580 # Exit first, so that the files are no longer in use.
4583 if { [llength $cleanfiles] > 0 } {
4584 eval remote_file target delete $cleanfiles
4588 # Unblock write access to the banned variables. Dejagnu typically
4589 # resets some of them between testcases.
4590 global banned_variables
4591 global banned_procedures
4592 global banned_traced
4593 if ($banned_traced) {
4594 foreach banned_var $banned_variables {
4595 global "$banned_var"
4596 trace remove variable "$banned_var" write error
4598 foreach banned_proc $banned_procedures {
4599 global "$banned_proc"
4600 trace remove execution "$banned_proc" enter error
4607 set debug_format "unknown"
4609 # Run the gdb command "info source" and extract the debugging format
4610 # information from the output and save it in debug_format.
4612 proc get_debug_format { } {
4618 set debug_format "unknown"
4619 send_gdb "info source\n"
4621 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4622 set debug_format $expect_out(1,string)
4623 verbose "debug format is $debug_format"
4626 -re "No current source file.\r\n$gdb_prompt $" {
4627 perror "get_debug_format used when no current source file"
4630 -re "$gdb_prompt $" {
4631 warning "couldn't check debug format (no valid response)."
4635 warning "couldn't check debug format (timeout)."
4641 # Return true if FORMAT matches the debug format the current test was
4642 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4643 # `*', `[...]', and so on.
4645 # This function depends on variables set by `get_debug_format', above.
4647 proc test_debug_format {format} {
4650 return [expr [string match $format $debug_format] != 0]
4653 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4654 # COFF, stabs, etc). If that format matches the format that the
4655 # current test was compiled with, then the next test is expected to
4656 # fail for any target. Returns 1 if the next test or set of tests is
4657 # expected to fail, 0 otherwise (or if it is unknown). Must have
4658 # previously called get_debug_format.
4659 proc setup_xfail_format { format } {
4660 set ret [test_debug_format $format]
4668 # gdb_get_line_number TEXT [FILE]
4670 # Search the source file FILE, and return the line number of the
4671 # first line containing TEXT. If no match is found, an error is thrown.
4673 # TEXT is a string literal, not a regular expression.
4675 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4676 # specified, and does not start with "/", then it is assumed to be in
4677 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4678 # by changing the callers and the interface at the same time.
4679 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4680 # gdb.base/ena-dis-br.exp.
4682 # Use this function to keep your test scripts independent of the
4683 # exact line numbering of the source file. Don't write:
4685 # send_gdb "break 20"
4687 # This means that if anyone ever edits your test's source file,
4688 # your test could break. Instead, put a comment like this on the
4689 # source file line you want to break at:
4691 # /* breakpoint spot: frotz.exp: test name */
4693 # and then write, in your test script (which we assume is named
4696 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4698 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4701 # % puts "foo [lindex "bar baz" 1]"
4704 # Tcl is quite clever, for a little stringy language.)
4708 # The previous implementation of this procedure used the gdb search command.
4709 # This version is different:
4711 # . It works with MI, and it also works when gdb is not running.
4713 # . It operates on the build machine, not the host machine.
4715 # . For now, this implementation fakes a current directory of
4716 # $srcdir/$subdir to be compatible with the old implementation.
4717 # This will go away eventually and some callers will need to
4720 # . The TEXT argument is literal text and matches literally,
4721 # not a regular expression as it was before.
4723 # . State changes in gdb, such as changing the current file
4724 # and setting $_, no longer happen.
4726 # After a bit of time we can forget about the differences from the
4727 # old implementation.
4729 # --chastain 2004-08-05
4731 proc gdb_get_line_number { text { file "" } } {
4736 if { "$file" == "" } then {
4739 if { ! [regexp "^/" "$file"] } then {
4740 set file "$srcdir/$subdir/$file"
4743 if { [ catch { set fd [open "$file"] } message ] } then {
4748 for { set line 1 } { 1 } { incr line } {
4749 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4752 if { $nchar < 0 } then {
4755 if { [string first "$text" "$body"] >= 0 } then {
4761 if { [ catch { close "$fd" } message ] } then {
4766 error "undefined tag \"$text\""
4772 # Continue the program until it ends.
4774 # MSSG is the error message that gets printed. If not given, a
4776 # COMMAND is the command to invoke. If not given, "continue" is
4778 # ALLOW_EXTRA is a flag indicating whether the test should expect
4779 # extra output between the "Continuing." line and the program
4780 # exiting. By default it is zero; if nonzero, any extra output
4783 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4784 global inferior_exited_re use_gdb_stub
4787 set text "continue until exit"
4789 set text "continue until exit at $mssg"
4797 # By default, we don't rely on exit() behavior of remote stubs --
4798 # it's common for exit() to be implemented as a simple infinite
4799 # loop, or a forced crash/reset. For native targets, by default, we
4800 # assume process exit is reported as such. If a non-reliable target
4801 # is used, we set a breakpoint at exit, and continue to that.
4802 if { [target_info exists exit_is_reliable] } {
4803 set exit_is_reliable [target_info exit_is_reliable]
4805 set exit_is_reliable [expr ! $use_gdb_stub]
4808 if { ! $exit_is_reliable } {
4809 if {![gdb_breakpoint "exit"]} {
4812 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4815 # Continue until we exit. Should not stop again.
4816 # Don't bother to check the output of the program, that may be
4817 # extremely tough for some remote systems.
4819 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4824 proc rerun_to_main {} {
4825 global gdb_prompt use_gdb_stub
4830 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4831 {pass "rerun to main" ; return 0}
4832 -re "$gdb_prompt $"\
4833 {fail "rerun to main" ; return 0}
4834 timeout {fail "(timeout) rerun to main" ; return 0}
4839 -re "The program .* has been started already.*y or n. $" {
4843 -re "Starting program.*$gdb_prompt $"\
4844 {pass "rerun to main" ; return 0}
4845 -re "$gdb_prompt $"\
4846 {fail "rerun to main" ; return 0}
4847 timeout {fail "(timeout) rerun to main" ; return 0}
4852 # Print a message and return true if a test should be skipped
4853 # due to lack of floating point suport.
4855 proc gdb_skip_float_test { msg } {
4856 if [target_info exists gdb,skip_float_tests] {
4857 verbose "Skipping test '$msg': no float tests."
4863 # Print a message and return true if a test should be skipped
4864 # due to lack of stdio support.
4866 proc gdb_skip_stdio_test { msg } {
4867 if [target_info exists gdb,noinferiorio] {
4868 verbose "Skipping test '$msg': no inferior i/o."
4874 proc gdb_skip_bogus_test { msg } {
4878 # Return true if a test should be skipped due to lack of XML support
4880 # NOTE: This must be called while gdb is *not* running.
4882 gdb_caching_proc gdb_skip_xml_test {
4886 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4890 gdb_test_multiple "set tdesc filename $xml_file" "" {
4891 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4894 -re ".*$gdb_prompt $" { }
4900 # Return true if argv[0] is available.
4902 gdb_caching_proc gdb_has_argv0 {
4905 # Set up, compile, and execute a test program to check whether
4906 # argv[0] is available.
4907 set src [standard_temp_file has_argv0[pid].c]
4908 set exe [standard_temp_file has_argv0[pid].x]
4910 gdb_produce_source $src {
4911 int main (int argc, char **argv) {
4916 gdb_compile $src $exe executable {debug}
4919 proc gdb_has_argv0_1 { exe } {
4920 global srcdir subdir
4921 global gdb_prompt hex
4925 gdb_reinitialize_dir $srcdir/$subdir
4928 # Set breakpoint on main.
4929 gdb_test_multiple "break main" "break main" {
4930 -re "Breakpoint.*${gdb_prompt} $" {
4932 -re "${gdb_prompt} $" {
4939 gdb_test_multiple "" "run to main" {
4940 -re "Breakpoint.*${gdb_prompt} $" {
4942 -re "${gdb_prompt} $" {
4947 set old_elements "200"
4948 set test "show print elements"
4949 gdb_test_multiple $test $test {
4950 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
4951 set old_elements $expect_out(1,string)
4954 set old_repeats "200"
4955 set test "show print repeats"
4956 gdb_test_multiple $test $test {
4957 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
4958 set old_repeats $expect_out(1,string)
4961 gdb_test_no_output "set print elements unlimited" ""
4962 gdb_test_no_output "set print repeats unlimited" ""
4965 # Check whether argc is 1.
4966 gdb_test_multiple "p argc" "p argc" {
4967 -re " = 1\r\n${gdb_prompt} $" {
4969 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4970 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4973 -re "${gdb_prompt} $" {
4977 -re "${gdb_prompt} $" {
4981 gdb_test_no_output "set print elements $old_elements" ""
4982 gdb_test_no_output "set print repeats $old_repeats" ""
4987 set result [gdb_has_argv0_1 $exe]
4994 && ([istarget *-*-linux*]
4995 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4996 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4997 || [istarget *-*-openbsd*]
4998 || [istarget *-*-darwin*]
4999 || [istarget *-*-solaris*]
5000 || [istarget *-*-aix*]
5001 || [istarget *-*-gnu*]
5002 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5003 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5004 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5005 || [istarget *-*-symbianelf*]
5006 || [istarget *-*-osf*]
5007 || [istarget *-*-dicos*]
5008 || [istarget *-*-nto*]
5009 || [istarget *-*-*vms*]
5010 || [istarget *-*-lynx*178]) } {
5011 fail "argv\[0\] should be available on this target"
5017 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5018 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5019 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5020 # the name of a debuginfo only file. This file will be stored in the same
5023 # Functions for separate debug info testing
5025 # starting with an executable:
5026 # foo --> original executable
5028 # at the end of the process we have:
5029 # foo.stripped --> foo w/o debug info
5030 # foo.debug --> foo's debug info
5031 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5033 # Fetch the build id from the file.
5034 # Returns "" if there is none.
5036 proc get_build_id { filename } {
5037 if { ([istarget "*-*-mingw*"]
5038 || [istarget *-*-cygwin*]) } {
5039 set objdump_program [gdb_find_objdump]
5040 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5041 verbose "result is $result"
5042 verbose "output is $output"
5048 set tmp [standard_output_file "${filename}-tmp"]
5049 set objcopy_program [gdb_find_objcopy]
5050 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5051 verbose "result is $result"
5052 verbose "output is $output"
5057 fconfigure $fi -translation binary
5058 # Skip the NOTE header.
5063 if ![string compare $data ""] then {
5066 # Convert it to hex.
5067 binary scan $data H* data
5072 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5073 # converted to the form: .build-id/ab/cdef1234...89.debug
5074 # Return "" if no build-id found.
5075 proc build_id_debug_filename_get { filename } {
5076 set data [get_build_id $filename]
5077 if { $data == "" } {
5080 regsub {^..} $data {\0/} data
5081 return ".build-id/${data}.debug"
5084 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5085 # list of optional flags. The only currently supported flag is no-main,
5086 # which removes the symbol entry for main from the separate debug file.
5088 # Function returns zero on success. Function will return non-zero failure code
5089 # on some targets not supporting separate debug info (such as i386-msdos).
5091 proc gdb_gnu_strip_debug { dest args } {
5093 # Use the first separate debug info file location searched by GDB so the
5094 # run cannot be broken by some stale file searched with higher precedence.
5095 set debug_file "${dest}.debug"
5097 set strip_to_file_program [transform strip]
5098 set objcopy_program [gdb_find_objcopy]
5100 set debug_link [file tail $debug_file]
5101 set stripped_file "${dest}.stripped"
5103 # Get rid of the debug info, and store result in stripped_file
5104 # something like gdb/testsuite/gdb.base/blah.stripped.
5105 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5106 verbose "result is $result"
5107 verbose "output is $output"
5112 # Workaround PR binutils/10802:
5113 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5114 set perm [file attributes ${dest} -permissions]
5115 file attributes ${stripped_file} -permissions $perm
5117 # Get rid of everything but the debug info, and store result in debug_file
5118 # This will be in the .debug subdirectory, see above.
5119 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5120 verbose "result is $result"
5121 verbose "output is $output"
5126 # If no-main is passed, strip the symbol for main from the separate
5127 # file. This is to simulate the behavior of elfutils's eu-strip, which
5128 # leaves the symtab in the original file only. There's no way to get
5129 # objcopy or strip to remove the symbol table without also removing the
5130 # debugging sections, so this is as close as we can get.
5131 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5132 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5133 verbose "result is $result"
5134 verbose "output is $output"
5138 file delete "${debug_file}"
5139 file rename "${debug_file}-tmp" "${debug_file}"
5142 # Link the two previous output files together, adding the .gnu_debuglink
5143 # section to the stripped_file, containing a pointer to the debug_file,
5144 # save the new file in dest.
5145 # This will be the regular executable filename, in the usual location.
5146 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5147 verbose "result is $result"
5148 verbose "output is $output"
5153 # Workaround PR binutils/10802:
5154 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5155 set perm [file attributes ${stripped_file} -permissions]
5156 file attributes ${dest} -permissions $perm
5161 # Test the output of GDB_COMMAND matches the pattern obtained
5162 # by concatenating all elements of EXPECTED_LINES. This makes
5163 # it possible to split otherwise very long string into pieces.
5164 # If third argument is not empty, it's used as the name of the
5165 # test to be printed on pass/fail.
5166 proc help_test_raw { gdb_command expected_lines args } {
5167 set message $gdb_command
5168 if [llength $args]>0 then {
5169 set message [lindex $args 0]
5171 set expected_output [join $expected_lines ""]
5172 gdb_test "${gdb_command}" "${expected_output}" $message
5175 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5176 # are regular expressions that should match the beginning of output,
5177 # before the list of commands in that class. The presence of
5178 # command list and standard epilogue will be tested automatically.
5179 # Notice that the '[' and ']' characters don't need to be escaped for strings
5180 # wrapped in {} braces.
5181 proc test_class_help { command_class expected_initial_lines args } {
5183 "List of commands\:.*[\r\n]+"
5184 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5185 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5186 "Command name abbreviations are allowed if unambiguous\."
5188 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5190 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5193 # COMMAND_LIST should have either one element -- command to test, or
5194 # two elements -- abbreviated command to test, and full command the first
5195 # element is abbreviation of.
5196 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5197 # are regular expressions that should match the beginning of output,
5198 # before the list of subcommands. The presence of
5199 # subcommand list and standard epilogue will be tested automatically.
5200 proc test_prefix_command_help { command_list expected_initial_lines args } {
5201 set command [lindex $command_list 0]
5202 if {[llength $command_list]>1} {
5203 set full_command [lindex $command_list 1]
5205 set full_command $command
5207 # Use 'list' and not just {} because we want variables to
5208 # be expanded in this list.
5209 set l_stock_body [list\
5210 "List of $full_command subcommands\:.*\[\r\n\]+"\
5211 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5212 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5213 "Command name abbreviations are allowed if unambiguous\."]
5214 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5215 if {[llength $args]>0} {
5216 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5218 help_test_raw "help ${command}" $l_entire_body
5222 # Build executable named EXECUTABLE from specifications that allow
5223 # different options to be passed to different sub-compilations.
5224 # TESTNAME is the name of the test; this is passed to 'untested' if
5226 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5227 # contains the option "pthreads", then gdb_compile_pthreads is used.
5228 # ARGS is a flat list of source specifications, of the form:
5229 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5230 # Each SOURCE is compiled to an object file using its OPTIONS,
5231 # using gdb_compile.
5232 # Returns 0 on success, -1 on failure.
5233 proc build_executable_from_specs {testname executable options args} {
5237 set binfile [standard_output_file $executable]
5240 if { [lsearch -exact $options "c++"] >= 0 } {
5241 set info_options "c++"
5243 if [get_compiler_info ${info_options}] {
5247 set func gdb_compile
5248 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5249 if {$func_index != -1} {
5250 set func "${func}_[lindex $options $func_index]"
5253 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5254 # parameter. They also requires $sources while gdb_compile and
5255 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5256 if [string match gdb_compile_shlib* $func] {
5258 foreach {s local_options} $args {
5259 if { [regexp "^/" "$s"] } then {
5260 lappend sources_path "$s"
5262 lappend sources_path "$srcdir/$subdir/$s"
5265 set ret [$func $sources_path "${binfile}" $options]
5266 } elseif {[lsearch -exact $options rust] != -1} {
5268 foreach {s local_options} $args {
5269 if { [regexp "^/" "$s"] } then {
5270 lappend sources_path "$s"
5272 lappend sources_path "$srcdir/$subdir/$s"
5275 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5279 foreach {s local_options} $args {
5280 if { ! [regexp "^/" "$s"] } then {
5281 set s "$srcdir/$subdir/$s"
5283 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5287 lappend objects "${binfile}${i}.o"
5290 set ret [$func $objects "${binfile}" executable $options]
5300 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5301 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5302 # to pass to untested, if something is wrong. OPTIONS are passed
5303 # to gdb_compile directly.
5304 proc build_executable { testname executable {sources ""} {options {debug}} } {
5305 if {[llength $sources]==0} {
5306 set sources ${executable}.c
5309 set arglist [list $testname $executable $options]
5310 foreach source $sources {
5311 lappend arglist $source $options
5314 return [eval build_executable_from_specs $arglist]
5317 # Starts fresh GDB binary and loads an optional executable into GDB.
5318 # Usage: clean_restart [executable]
5319 # EXECUTABLE is the basename of the binary.
5321 proc clean_restart { args } {
5325 if { [llength $args] > 1 } {
5326 error "bad number of args: [llength $args]"
5331 gdb_reinitialize_dir $srcdir/$subdir
5333 if { [llength $args] >= 1 } {
5334 set executable [lindex $args 0]
5335 set binfile [standard_output_file ${executable}]
5340 # Prepares for testing by calling build_executable_full, then
5342 # TESTNAME is the name of the test.
5343 # Each element in ARGS is a list of the form
5344 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5345 # These are passed to build_executable_from_specs, which see.
5346 # The last EXECUTABLE is passed to clean_restart.
5347 # Returns 0 on success, non-zero on failure.
5348 proc prepare_for_testing_full {testname args} {
5349 foreach spec $args {
5350 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5353 set executable [lindex $spec 0]
5355 clean_restart $executable
5359 # Prepares for testing, by calling build_executable, and then clean_restart.
5360 # Please refer to build_executable for parameter description.
5361 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5363 if {[build_executable $testname $executable $sources $options] == -1} {
5366 clean_restart $executable
5371 proc get_valueof { fmt exp default } {
5374 set test "get valueof \"${exp}\""
5376 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5377 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
5378 set val $expect_out(1,string)
5382 fail "$test (timeout)"
5388 proc get_integer_valueof { exp default } {
5391 set test "get integer valueof \"${exp}\""
5393 gdb_test_multiple "print /d ${exp}" "$test" {
5394 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5395 set val $expect_out(1,string)
5399 fail "$test (timeout)"
5405 proc get_hexadecimal_valueof { exp default } {
5407 send_gdb "print /x ${exp}\n"
5408 set test "get hexadecimal valueof \"${exp}\""
5410 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5411 set val $expect_out(1,string)
5416 fail "$test (timeout)"
5422 proc get_sizeof { type default } {
5423 return [get_integer_valueof "sizeof (${type})" $default]
5426 proc get_target_charset { } {
5429 gdb_test_multiple "show target-charset" "" {
5430 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5431 return $expect_out(1,string)
5433 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5434 return $expect_out(1,string)
5438 # Pick a reasonable default.
5439 warning "Unable to read target-charset."
5443 # Get the current value for remotetimeout and return it.
5444 proc get_remotetimeout { } {
5448 gdb_test_multiple "show remotetimeout" "" {
5449 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5450 return $expect_out(1,string)
5454 # Pick the default that gdb uses
5455 warning "Unable to read remotetimeout"
5459 # Set the remotetimeout to the specified timeout. Nothing is returned.
5460 proc set_remotetimeout { timeout } {
5463 gdb_test_multiple "set remotetimeout $timeout" "" {
5464 -re "$gdb_prompt $" {
5465 verbose "Set remotetimeout to $timeout\n"
5470 # ROOT and FULL are file names. Returns the relative path from ROOT
5471 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5472 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5475 proc relative_filename {root full} {
5476 set root_split [file split $root]
5477 set full_split [file split $full]
5479 set len [llength $root_split]
5481 if {[eval file join $root_split]
5482 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5483 error "$full not a subdir of $root"
5486 return [eval file join [lrange $full_split $len end]]
5489 # Log gdb command line and script if requested.
5490 if {[info exists TRANSCRIPT]} {
5491 rename send_gdb real_send_gdb
5492 rename remote_spawn real_remote_spawn
5493 rename remote_close real_remote_close
5495 global gdb_transcript
5496 set gdb_transcript ""
5498 global gdb_trans_count
5499 set gdb_trans_count 1
5501 proc remote_spawn {args} {
5502 global gdb_transcript gdb_trans_count outdir
5504 if {$gdb_transcript != ""} {
5505 close $gdb_transcript
5507 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5508 puts $gdb_transcript [lindex $args 1]
5509 incr gdb_trans_count
5511 return [uplevel real_remote_spawn $args]
5514 proc remote_close {args} {
5515 global gdb_transcript
5517 if {$gdb_transcript != ""} {
5518 close $gdb_transcript
5519 set gdb_transcript ""
5522 return [uplevel real_remote_close $args]
5525 proc send_gdb {args} {
5526 global gdb_transcript
5528 if {$gdb_transcript != ""} {
5529 puts -nonewline $gdb_transcript [lindex $args 0]
5532 return [uplevel real_send_gdb $args]
5536 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5537 if {[info exists GDB_PARALLEL]} {
5538 if {[is_remote host]} {
5542 [make_gdb_parallel_path outputs] \
5543 [make_gdb_parallel_path temp] \
5544 [make_gdb_parallel_path cache]
5548 proc core_find {binfile {deletefiles {}} {arg ""}} {
5549 global objdir subdir
5551 set destcore "$binfile.core"
5552 file delete $destcore
5554 # Create a core file named "$destcore" rather than just "core", to
5555 # avoid problems with sys admin types that like to regularly prune all
5556 # files named "core" from the system.
5558 # Arbitrarily try setting the core size limit to "unlimited" since
5559 # this does not hurt on systems where the command does not work and
5560 # allows us to generate a core on systems where it does.
5562 # Some systems append "core" to the name of the program; others append
5563 # the name of the program to "core"; still others (like Linux, as of
5564 # May 2003) create cores named "core.PID". In the latter case, we
5565 # could have many core files lying around, and it may be difficult to
5566 # tell which one is ours, so let's run the program in a subdirectory.
5568 set coredir [standard_output_file coredir.[getpid]]
5570 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5571 # remote_exec host "${binfile}"
5572 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5573 if [remote_file build exists $i] {
5574 remote_exec build "mv $i $destcore"
5578 # Check for "core.PID".
5579 if { $found == 0 } {
5580 set names [glob -nocomplain -directory $coredir core.*]
5581 if {[llength $names] == 1} {
5582 set corefile [file join $coredir [lindex $names 0]]
5583 remote_exec build "mv $corefile $destcore"
5587 if { $found == 0 } {
5588 # The braindamaged HPUX shell quits after the ulimit -c above
5589 # without executing ${binfile}. So we try again without the
5590 # ulimit here if we didn't find a core file above.
5591 # Oh, I should mention that any "braindamaged" non-Unix system has
5592 # the same problem. I like the cd bit too, it's really neat'n stuff.
5593 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5594 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5595 if [remote_file build exists $i] {
5596 remote_exec build "mv $i $destcore"
5602 # Try to clean up after ourselves.
5603 foreach deletefile $deletefiles {
5604 remote_file build delete [file join $coredir $deletefile]
5606 remote_exec build "rmdir $coredir"
5608 if { $found == 0 } {
5609 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5615 # gdb_target_symbol_prefix compiles a test program and then examines
5616 # the output from objdump to determine the prefix (such as underscore)
5617 # for linker symbol prefixes.
5619 gdb_caching_proc gdb_target_symbol_prefix {
5620 # Set up and compile a simple test program...
5621 set src [standard_temp_file main[pid].c]
5622 set exe [standard_temp_file main[pid].x]
5624 gdb_produce_source $src {
5630 verbose "compiling testfile $src" 2
5631 set compile_flags {debug nowarnings quiet}
5632 set lines [gdb_compile $src $exe executable $compile_flags]
5636 if ![string match "" $lines] then {
5637 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5639 set objdump_program [gdb_find_objdump]
5640 set result [catch "exec $objdump_program --syms $exe" output]
5643 && ![regexp -lineanchor \
5644 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5645 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5655 # gdb_target_symbol returns the provided symbol with the correct prefix
5656 # prepended. (See gdb_target_symbol_prefix, above.)
5658 proc gdb_target_symbol { symbol } {
5659 set prefix [gdb_target_symbol_prefix]
5660 return "${prefix}${symbol}"
5663 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5664 # added to gdb_compile options to define the C-preprocessor macro
5665 # SYMBOL_PREFIX with a value that can be prepended to symbols
5666 # for targets which require a prefix, such as underscore.
5668 # This version (_asm) defines the prefix without double quotes
5669 # surrounding the prefix. It is used to define the macro
5670 # SYMBOL_PREFIX for assembly language files. Another version, below,
5671 # is used for symbols in inline assembler in C/C++ files.
5673 # The lack of quotes in this version (_asm) makes it possible to
5674 # define supporting macros in the .S file. (The version which
5675 # uses quotes for the prefix won't work for such files since it's
5676 # impossible to define a quote-stripping macro in C.)
5678 # It's possible to use this version (_asm) for C/C++ source files too,
5679 # but a string is usually required in such files; providing a version
5680 # (no _asm) which encloses the prefix with double quotes makes it
5681 # somewhat easier to define the supporting macros in the test case.
5683 proc gdb_target_symbol_prefix_flags_asm {} {
5684 set prefix [gdb_target_symbol_prefix]
5685 if {$prefix ne ""} {
5686 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5692 # gdb_target_symbol_prefix_flags returns the same string as
5693 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5694 # enclosed in double quotes if there is a prefix.
5696 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5697 # extended discussion.
5699 proc gdb_target_symbol_prefix_flags {} {
5700 set prefix [gdb_target_symbol_prefix]
5701 if {$prefix ne ""} {
5702 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5708 # A wrapper for 'remote_exec host' that passes or fails a test.
5709 # Returns 0 if all went well, nonzero on failure.
5710 # TEST is the name of the test, other arguments are as for remote_exec.
5712 proc run_on_host { test program args } {
5713 verbose -log "run_on_host: $program $args"
5714 # remote_exec doesn't work properly if the output is set but the
5715 # input is the empty string -- so replace an empty input with
5717 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5718 set args [lreplace $args 1 1 "/dev/null"]
5720 set result [eval remote_exec host [list $program] $args]
5721 verbose "result is $result"
5722 set status [lindex $result 0]
5723 set output [lindex $result 1]
5728 verbose -log "run_on_host failed: $output"
5734 # Return non-zero if "board_info debug_flags" mentions Fission.
5735 # http://gcc.gnu.org/wiki/DebugFission
5736 # Fission doesn't support everything yet.
5737 # This supports working around bug 15954.
5739 proc using_fission { } {
5740 set debug_flags [board_info [target_info name] debug_flags]
5741 return [regexp -- "-gsplit-dwarf" $debug_flags]
5744 # Search the caller's ARGS list and set variables according to the list of
5745 # valid options described by ARGSET.
5747 # The first member of each one- or two-element list in ARGSET defines the
5748 # name of a variable that will be added to the caller's scope.
5750 # If only one element is given to describe an option, it the value is
5751 # 0 if the option is not present in (the caller's) ARGS or 1 if
5754 # If two elements are given, the second element is the default value of
5755 # the variable. This is then overwritten if the option exists in ARGS.
5757 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5758 # any optional components.
5761 # proc myproc {foo args} {
5762 # parse_args {{bar} {baz "abc"} {qux}}
5765 # myproc ABC -bar -baz DEF peanut butter
5766 # will define the following variables in myproc:
5767 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5768 # args will be the list {peanut butter}
5770 proc parse_args { argset } {
5773 foreach argument $argset {
5774 if {[llength $argument] == 1} {
5775 # No default specified, so we assume that we should set
5776 # the value to 1 if the arg is present and 0 if it's not.
5777 # It is assumed that no value is given with the argument.
5778 set result [lsearch -exact $args "-$argument"]
5779 if {$result != -1} then {
5780 uplevel 1 [list set $argument 1]
5781 set args [lreplace $args $result $result]
5783 uplevel 1 [list set $argument 0]
5785 } elseif {[llength $argument] == 2} {
5786 # There are two items in the argument. The second is a
5787 # default value to use if the item is not present.
5788 # Otherwise, the variable is set to whatever is provided
5789 # after the item in the args.
5790 set arg [lindex $argument 0]
5791 set result [lsearch -exact $args "-[lindex $arg 0]"]
5792 if {$result != -1} then {
5793 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5794 set args [lreplace $args $result [expr $result+1]]
5796 uplevel 1 [list set $arg [lindex $argument 1]]
5799 error "Badly formatted argument \"$argument\" in argument set"
5803 # The remaining args should be checked to see that they match the
5804 # number of items expected to be passed into the procedure...
5807 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
5808 # return that string.
5810 proc capture_command_output { command prefix } {
5814 set output_string ""
5815 gdb_test_multiple "$command" "capture_command_output for $command" {
5816 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5817 set output_string $expect_out(1,string)
5820 return $output_string
5823 # A convenience function that joins all the arguments together, with a
5824 # regexp that matches exactly one end of line in between each argument.
5825 # This function is ideal to write the expected output of a GDB command
5826 # that generates more than a couple of lines, as this allows us to write
5827 # each line as a separate string, which is easier to read by a human
5830 proc multi_line { args } {
5831 return [join $args "\r\n"]
5834 # Always load compatibility stuff.