1 # Copyright 1992-2015 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
34 if [info exists TOOL_EXECUTABLE] {
35 set GDB $TOOL_EXECUTABLE
37 if ![info exists GDB] {
38 if ![is_remote host] {
39 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
41 set GDB [transform gdb]
44 verbose "using GDB = $GDB" 2
46 # GDBFLAGS is available for the user to set on the command line.
47 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
48 # Testcases may use it to add additional flags, but they must:
49 # - append new flags, not overwrite
50 # - restore the original value when done
52 if ![info exists GDBFLAGS] {
55 verbose "using GDBFLAGS = $GDBFLAGS" 2
57 # Make the build data directory available to tests.
58 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
60 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
61 global INTERNAL_GDBFLAGS
62 if ![info exists INTERNAL_GDBFLAGS] {
63 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
66 # The variable gdb_prompt is a regexp which matches the gdb prompt.
67 # Set it if it is not already set. This is also set by default_gdb_init
68 # but it's not clear what removing one of them will break.
69 # See with_gdb_prompt for more details on prompt handling.
71 if ![info exists gdb_prompt] then {
72 set gdb_prompt "\\(gdb\\)"
75 # A regexp that matches the pagination prompt.
76 set pagination_prompt [string_to_regexp "---Type <return> to continue, or q <return> to quit---"]
78 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
79 # absolute path ie. /foo/
80 set fullname_syntax_POSIX {/[^\n]*/}
81 # The variable fullname_syntax_UNC is a regexp which matches a Windows
82 # UNC path ie. \\D\foo\
83 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
84 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
85 # particular DOS case that GDB most likely will output
86 # ie. \foo\, but don't match \\.*\
87 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
88 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
89 # ie. a:\foo\ && a:foo\
90 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
91 # The variable fullname_syntax is a regexp which matches what GDB considers
92 # an absolute path. It is currently debatable if the Windows style paths
93 # d:foo and \abc should be considered valid as an absolute path.
94 # Also, the purpse of this regexp is not to recognize a well formed
95 # absolute path, but to say with certainty that a path is absolute.
96 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
98 # Needed for some tests under Cygwin.
102 if ![info exists env(EXEEXT)] {
105 set EXEEXT $env(EXEEXT)
110 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
112 ### Only procedures should come after this point.
115 # gdb_version -- extract and print the version number of GDB
117 proc default_gdb_version {} {
119 global INTERNAL_GDBFLAGS GDBFLAGS
123 if {[info exists inotify_pid]} {
124 eval exec kill $inotify_pid
127 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
128 set tmp [lindex $output 1]
130 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
131 if ![is_remote host] {
132 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
134 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
138 proc gdb_version { } {
139 return [default_gdb_version]
143 # gdb_unload -- unload a file if one is loaded
144 # Return 0 on success, -1 on error.
153 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
154 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
155 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
159 -re "Discard symbol table from .*y or n.*$" {
163 -re "$gdb_prompt $" {}
165 perror "couldn't unload file in $GDB (timeout)."
172 # Many of the tests depend on setting breakpoints at various places and
173 # running until that breakpoint is reached. At times, we want to start
174 # with a clean-slate with respect to breakpoints, so this utility proc
175 # lets us do this without duplicating this code everywhere.
178 proc delete_breakpoints {} {
181 # we need a larger timeout value here or this thing just confuses
182 # itself. May need a better implementation if possible. - guo
184 send_gdb "delete breakpoints\n"
186 -re "Delete all breakpoints.*y or n.*$" {
190 -re "$gdb_prompt $" { # This happens if there were no breakpoints
192 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
194 send_gdb "info breakpoints\n"
196 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
197 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
198 -re "Delete all breakpoints.*or n.*$" {
202 timeout { perror "info breakpoints (timeout)" ; return }
206 # Generic run command.
208 # The second pattern below matches up to the first newline *only*.
209 # Using ``.*$'' could swallow up output that we attempt to match
212 # N.B. This function does not wait for gdb to return to the prompt,
213 # that is the caller's responsibility.
215 proc gdb_run_cmd {args} {
216 global gdb_prompt use_gdb_stub
218 foreach command [gdb_init_commands] {
219 send_gdb "$command\n"
221 -re "$gdb_prompt $" { }
223 perror "gdb_init_command for target failed"
230 if [target_info exists gdb,do_reload_on_run] {
231 if { [gdb_reload] != 0 } {
234 send_gdb "continue\n"
236 -re "Continu\[^\r\n\]*\[\r\n\]" {}
242 if [target_info exists gdb,start_symbol] {
243 set start [target_info gdb,start_symbol]
247 send_gdb "jump *$start\n"
249 while { $start_attempt } {
250 # Cap (re)start attempts at three to ensure that this loop
251 # always eventually fails. Don't worry about trying to be
252 # clever and not send a command when it has failed.
253 if [expr $start_attempt > 3] {
254 perror "Jump to start() failed (retry count exceeded)"
257 set start_attempt [expr $start_attempt + 1]
259 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
262 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
263 perror "Can't find start symbol to run in gdb_run"
266 -re "No symbol \"start\" in current.*$gdb_prompt $" {
267 send_gdb "jump *_start\n"
269 -re "No symbol.*context.*$gdb_prompt $" {
272 -re "Line.* Jump anyway.*y or n. $" {
275 -re "The program is not being run.*$gdb_prompt $" {
276 if { [gdb_reload] != 0 } {
279 send_gdb "jump *$start\n"
282 perror "Jump to start() failed (timeout)"
290 if [target_info exists gdb,do_reload_on_run] {
291 if { [gdb_reload] != 0 } {
295 send_gdb "run $args\n"
296 # This doesn't work quite right yet.
297 # Use -notransfer here so that test cases (like chng-sym.exp)
298 # may test for additional start-up messages.
300 -re "The program .* has been started already.*y or n. $" {
304 -notransfer -re "Starting program: \[^\r\n\]*" {}
305 -notransfer -re "$gdb_prompt $" {
306 # There is no more input expected.
311 # Generic start command. Return 0 if we could start the program, -1
314 # N.B. This function does not wait for gdb to return to the prompt,
315 # that is the caller's responsibility.
317 proc gdb_start_cmd {args} {
318 global gdb_prompt use_gdb_stub
320 foreach command [gdb_init_commands] {
321 send_gdb "$command\n"
323 -re "$gdb_prompt $" { }
325 perror "gdb_init_command for target failed"
335 send_gdb "start $args\n"
336 # Use -notransfer here so that test cases (like chng-sym.exp)
337 # may test for additional start-up messages.
339 -re "The program .* has been started already.*y or n. $" {
343 -notransfer -re "Starting program: \[^\r\n\]*" {
350 # Set a breakpoint at FUNCTION. If there is an additional argument it is
351 # a list of options; the supported options are allow-pending, temporary,
352 # message, no-message, and passfail.
353 # The result is 1 for success, 0 for failure.
355 # Note: The handling of message vs no-message is messed up, but it's based
356 # on historical usage. By default this function does not print passes,
358 # no-message: turns off printing of fails (and passes, but they're already off)
359 # message: turns on printing of passes (and fails, but they're already on)
361 proc gdb_breakpoint { function args } {
365 set pending_response n
366 if {[lsearch -exact $args allow-pending] != -1} {
367 set pending_response y
370 set break_command "break"
371 set break_message "Breakpoint"
372 if {[lsearch -exact $args temporary] != -1} {
373 set break_command "tbreak"
374 set break_message "Temporary breakpoint"
379 set no_message_loc [lsearch -exact $args no-message]
380 set message_loc [lsearch -exact $args message]
381 # The last one to appear in args wins.
382 if { $no_message_loc > $message_loc } {
384 } elseif { $message_loc > $no_message_loc } {
388 set test_name "setting breakpoint at $function"
390 send_gdb "$break_command $function\n"
391 # The first two regexps are what we get with -g, the third is without -g.
393 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
394 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
395 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
396 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
397 if {$pending_response == "n"} {
404 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
405 send_gdb "$pending_response\n"
408 -re "A problem internal to GDB has been detected" {
410 fail "$test_name (GDB internal error)"
412 gdb_internal_error_resync
415 -re "$gdb_prompt $" {
423 fail "$test_name (eof)"
429 fail "$test_name (timeout)"
440 # Set breakpoint at function and run gdb until it breaks there.
441 # Since this is the only breakpoint that will be set, if it stops
442 # at a breakpoint, we will assume it is the one we want. We can't
443 # just compare to "function" because it might be a fully qualified,
444 # single quoted C++ function specifier.
446 # If there are additional arguments, pass them to gdb_breakpoint.
447 # We recognize no-message/message ourselves.
448 # The default is no-message.
449 # no-message is messed up here, like gdb_breakpoint: to preserve
450 # historical usage fails are always printed by default.
451 # no-message: turns off printing of fails (and passes, but they're already off)
452 # message: turns on printing of passes (and fails, but they're already on)
454 proc runto { function args } {
460 # Default to "no-message".
461 set args "no-message $args"
465 set no_message_loc [lsearch -exact $args no-message]
466 set message_loc [lsearch -exact $args message]
467 # The last one to appear in args wins.
468 if { $no_message_loc > $message_loc } {
470 } elseif { $message_loc > $no_message_loc } {
474 set test_name "running to $function in runto"
476 # We need to use eval here to pass our varargs args to gdb_breakpoint
477 # which is also a varargs function.
478 # But we also have to be careful because $function may have multiple
479 # elements, and we don't want Tcl to move the remaining elements after
480 # the first to $args. That is why $function is wrapped in {}.
481 if ![eval gdb_breakpoint {$function} $args] {
487 # the "at foo.c:36" output we get with -g.
488 # the "in func" output we get without -g.
490 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
496 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
502 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
504 unsupported "Non-stop mode not supported"
508 -re ".*A problem internal to GDB has been detected" {
510 fail "$test_name (GDB internal error)"
512 gdb_internal_error_resync
515 -re "$gdb_prompt $" {
523 fail "$test_name (eof)"
529 fail "$test_name (timeout)"
540 # Ask gdb to run until we hit a breakpoint at main.
542 # N.B. This function deletes all existing breakpoints.
543 # If you don't want that, use gdb_start_cmd.
545 proc runto_main { } {
546 return [runto main no-message]
549 ### Continue, and expect to hit a breakpoint.
550 ### Report a pass or fail, depending on whether it seems to have
551 ### worked. Use NAME as part of the test name; each call to
552 ### continue_to_breakpoint should use a NAME which is unique within
554 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
556 set full_name "continue to breakpoint: $name"
558 gdb_test_multiple "continue" $full_name {
559 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
566 # gdb_internal_error_resync:
568 # Answer the questions GDB asks after it reports an internal error
569 # until we get back to a GDB prompt. Decline to quit the debugging
570 # session, and decline to create a core file. Return non-zero if the
573 # This procedure just answers whatever questions come up until it sees
574 # a GDB prompt; it doesn't require you to have matched the input up to
575 # any specific point. However, it only answers questions it sees in
576 # the output itself, so if you've matched a question, you had better
577 # answer it yourself before calling this.
579 # You can use this function thus:
583 # -re ".*A problem internal to GDB has been detected" {
584 # gdb_internal_error_resync
589 proc gdb_internal_error_resync {} {
592 verbose -log "Resyncing due to internal error."
595 while {$count < 10} {
597 -re "Quit this debugging session\\? \\(y or n\\) $" {
601 -re "Create a core file of GDB\\? \\(y or n\\) $" {
605 -re "$gdb_prompt $" {
606 # We're resynchronized.
610 perror "Could not resync from internal error (timeout)"
615 perror "Could not resync from internal error (resync count exceeded)"
620 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
621 # Send a command to gdb; test the result.
623 # COMMAND is the command to execute, send to GDB with send_gdb. If
624 # this is the null string no command is sent.
625 # MESSAGE is a message to be printed with the built-in failure patterns
626 # if one of them matches. If MESSAGE is empty COMMAND will be used.
627 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
628 # patterns. Pattern elements will be evaluated in the caller's
629 # context; action elements will be executed in the caller's context.
630 # Unlike patterns for gdb_test, these patterns should generally include
631 # the final newline and prompt.
634 # 1 if the test failed, according to a built-in failure pattern
635 # 0 if only user-supplied patterns matched
636 # -1 if there was an internal error.
638 # You can use this function thus:
640 # gdb_test_multiple "print foo" "test foo" {
641 # -re "expected output 1" {
644 # -re "expected output 2" {
649 # The standard patterns, such as "Inferior exited..." and "A problem
650 # ...", all being implicitly appended to that list.
652 proc gdb_test_multiple { command message user_code } {
653 global verbose use_gdb_stub
654 global gdb_prompt pagination_prompt
656 global inferior_exited_re
657 upvar timeout timeout
658 upvar expect_out expect_out
660 if { $message == "" } {
664 if [string match "*\[\r\n\]" $command] {
665 error "Invalid trailing newline in \"$message\" test"
668 if [string match "*\[\r\n\]*" $message] {
669 error "Invalid newline in \"$message\" test"
673 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
675 error "gdbserver does not support $command without extended-remote"
678 # TCL/EXPECT WART ALERT
679 # Expect does something very strange when it receives a single braced
680 # argument. It splits it along word separators and performs substitutions.
681 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
682 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
683 # double-quoted list item, "\[ab\]" is just a long way of representing
684 # "[ab]", because the backslashes will be removed by lindex.
686 # Unfortunately, there appears to be no easy way to duplicate the splitting
687 # that expect will do from within TCL. And many places make use of the
688 # "\[0-9\]" construct, so we need to support that; and some places make use
689 # of the "[func]" construct, so we need to support that too. In order to
690 # get this right we have to substitute quoted list elements differently
691 # from braced list elements.
693 # We do this roughly the same way that Expect does it. We have to use two
694 # lists, because if we leave unquoted newlines in the argument to uplevel
695 # they'll be treated as command separators, and if we escape newlines
696 # we mangle newlines inside of command blocks. This assumes that the
697 # input doesn't contain a pattern which contains actual embedded newlines
700 regsub -all {\n} ${user_code} { } subst_code
701 set subst_code [uplevel list $subst_code]
703 set processed_code ""
705 set expecting_action 0
707 foreach item $user_code subst_item $subst_code {
708 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
709 lappend processed_code $item
712 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
713 lappend processed_code $item
716 if { $item == "-timeout" } {
718 lappend processed_code $item
721 if { $expecting_arg } {
723 lappend processed_code $item
726 if { $expecting_action } {
727 lappend processed_code "uplevel [list $item]"
728 set expecting_action 0
729 # Cosmetic, no effect on the list.
730 append processed_code "\n"
733 set expecting_action 1
734 lappend processed_code $subst_item
735 if {$patterns != ""} {
738 append patterns "\"$subst_item\""
741 # Also purely cosmetic.
742 regsub -all {\r} $patterns {\\r} patterns
743 regsub -all {\n} $patterns {\\n} patterns
746 send_user "Sending \"$command\" to gdb\n"
747 send_user "Looking to match \"$patterns\"\n"
748 send_user "Message is \"$message\"\n"
752 set string "${command}\n"
753 if { $command != "" } {
754 set multi_line_re "\[\r\n\] *>"
755 while { "$string" != "" } {
756 set foo [string first "\n" "$string"]
757 set len [string length "$string"]
758 if { $foo < [expr $len - 1] } {
759 set str [string range "$string" 0 $foo]
760 if { [send_gdb "$str"] != "" } {
763 if { ! $suppress_flag } {
764 perror "Couldn't send $command to GDB."
769 # since we're checking if each line of the multi-line
770 # command are 'accepted' by GDB here,
771 # we need to set -notransfer expect option so that
772 # command output is not lost for pattern matching
775 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
776 timeout { verbose "partial: timeout" 3 }
778 set string [string range "$string" [expr $foo + 1] end]
779 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
784 if { "$string" != "" } {
785 if { [send_gdb "$string"] != "" } {
788 if { ! $suppress_flag } {
789 perror "Couldn't send $command to GDB."
798 -re ".*A problem internal to GDB has been detected" {
799 fail "$message (GDB internal error)"
800 gdb_internal_error_resync
802 -re "\\*\\*\\* DOSEXIT code.*" {
803 if { $message != "" } {
806 gdb_suppress_entire_file "GDB died"
810 append code $processed_code
812 -re "Ending remote debugging.*$gdb_prompt $" {
813 if ![isnative] then {
814 warning "Can`t communicate to remote target."
820 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
821 perror "Undefined command \"$command\"."
825 -re "Ambiguous command.*$gdb_prompt $" {
826 perror "\"$command\" is not a unique command name."
830 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
831 if ![string match "" $message] then {
832 set errmsg "$message (the program exited)"
834 set errmsg "$command (the program exited)"
839 -re "$inferior_exited_re normally.*$gdb_prompt $" {
840 if ![string match "" $message] then {
841 set errmsg "$message (the program exited)"
843 set errmsg "$command (the program exited)"
848 -re "The program is not being run.*$gdb_prompt $" {
849 if ![string match "" $message] then {
850 set errmsg "$message (the program is no longer running)"
852 set errmsg "$command (the program is no longer running)"
857 -re "\r\n$gdb_prompt $" {
858 if ![string match "" $message] then {
863 -re "$pagination_prompt" {
865 perror "Window too small."
869 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
871 gdb_expect -re "$gdb_prompt $"
872 fail "$message (got interactive prompt)"
875 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
877 gdb_expect -re "$gdb_prompt $"
878 fail "$message (got breakpoint menu)"
882 perror "Process no longer exists"
883 if { $message != "" } {
889 perror "internal buffer is full."
894 if ![string match "" $message] then {
895 fail "$message (timeout)"
902 set code [catch {gdb_expect $code} string]
904 global errorInfo errorCode
905 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
906 } elseif {$code > 1} {
907 return -code $code $string
912 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
913 # Send a command to gdb; test the result.
915 # COMMAND is the command to execute, send to GDB with send_gdb. If
916 # this is the null string no command is sent.
917 # PATTERN is the pattern to match for a PASS, and must NOT include
918 # the \r\n sequence immediately before the gdb prompt.
919 # MESSAGE is an optional message to be printed. If this is
920 # omitted, then the pass/fail messages use the command string as the
921 # message. (If this is the empty string, then sometimes we don't
922 # call pass or fail at all; I don't understand this at all.)
923 # QUESTION is a question GDB may ask in response to COMMAND, like
925 # RESPONSE is the response to send if QUESTION appears.
928 # 1 if the test failed,
929 # 0 if the test passes,
930 # -1 if there was an internal error.
932 proc gdb_test { args } {
936 upvar timeout timeout
938 if [llength $args]>2 then {
939 set message [lindex $args 2]
941 set message [lindex $args 0]
943 set command [lindex $args 0]
944 set pattern [lindex $args 1]
946 if [llength $args]==5 {
947 set question_string [lindex $args 3]
948 set response_string [lindex $args 4]
950 set question_string "^FOOBAR$"
953 return [gdb_test_multiple $command $message {
954 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
955 if ![string match "" $message] then {
959 -re "(${question_string})$" {
960 send_gdb "$response_string\n"
966 # gdb_test_no_output COMMAND MESSAGE
967 # Send a command to GDB and verify that this command generated no output.
969 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
970 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
971 # the message. (If MESSAGE is the empty string, then sometimes we do not
972 # call pass or fail at all; I don't understand this at all.)
974 proc gdb_test_no_output { args } {
976 set command [lindex $args 0]
977 if [llength $args]>1 then {
978 set message [lindex $args 1]
983 set command_regex [string_to_regexp $command]
984 gdb_test_multiple $command $message {
985 -re "^$command_regex\r\n$gdb_prompt $" {
986 if ![string match "" $message] then {
993 # Send a command and then wait for a sequence of outputs.
994 # This is useful when the sequence is long and contains ".*", a single
995 # regexp to match the entire output can get a timeout much easier.
997 # COMMAND is the command to send.
998 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
999 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1000 # processed in order, and all must be present in the output.
1002 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1003 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1004 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1006 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1007 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1010 # 1 if the test failed,
1011 # 0 if the test passes,
1012 # -1 if there was an internal error.
1014 proc gdb_test_sequence { command test_name expected_output_list } {
1016 if { $test_name == "" } {
1017 set test_name $command
1019 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1020 send_gdb "$command\n"
1021 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1025 # Test that a command gives an error. For pass or fail, return
1026 # a 1 to indicate that more tests can proceed. However a timeout
1027 # is a serious error, generates a special fail message, and causes
1028 # a 0 to be returned to indicate that more tests are likely to fail
1031 proc test_print_reject { args } {
1035 if [llength $args]==2 then {
1036 set expectthis [lindex $args 1]
1038 set expectthis "should never match this bogus string"
1040 set sendthis [lindex $args 0]
1041 if $verbose>2 then {
1042 send_user "Sending \"$sendthis\" to gdb\n"
1043 send_user "Looking to match \"$expectthis\"\n"
1045 send_gdb "$sendthis\n"
1046 #FIXME: Should add timeout as parameter.
1048 -re "A .* in expression.*\\.*$gdb_prompt $" {
1049 pass "reject $sendthis"
1052 -re "Invalid syntax in expression.*$gdb_prompt $" {
1053 pass "reject $sendthis"
1056 -re "Junk after end of expression.*$gdb_prompt $" {
1057 pass "reject $sendthis"
1060 -re "Invalid number.*$gdb_prompt $" {
1061 pass "reject $sendthis"
1064 -re "Invalid character constant.*$gdb_prompt $" {
1065 pass "reject $sendthis"
1068 -re "No symbol table is loaded.*$gdb_prompt $" {
1069 pass "reject $sendthis"
1072 -re "No symbol .* in current context.*$gdb_prompt $" {
1073 pass "reject $sendthis"
1076 -re "Unmatched single quote.*$gdb_prompt $" {
1077 pass "reject $sendthis"
1080 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1081 pass "reject $sendthis"
1084 -re "$expectthis.*$gdb_prompt $" {
1085 pass "reject $sendthis"
1088 -re ".*$gdb_prompt $" {
1089 fail "reject $sendthis"
1093 fail "reject $sendthis (eof or timeout)"
1100 # Same as gdb_test, but the second parameter is not a regexp,
1101 # but a string that must match exactly.
1103 proc gdb_test_exact { args } {
1104 upvar timeout timeout
1106 set command [lindex $args 0]
1108 # This applies a special meaning to a null string pattern. Without
1109 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1110 # messages from commands that should have no output except a new
1111 # prompt. With this, only results of a null string will match a null
1114 set pattern [lindex $args 1]
1115 if [string match $pattern ""] {
1116 set pattern [string_to_regexp [lindex $args 0]]
1118 set pattern [string_to_regexp [lindex $args 1]]
1121 # It is most natural to write the pattern argument with only
1122 # embedded \n's, especially if you are trying to avoid Tcl quoting
1123 # problems. But gdb_expect really wants to see \r\n in patterns. So
1124 # transform the pattern here. First transform \r\n back to \n, in
1125 # case some users of gdb_test_exact already do the right thing.
1126 regsub -all "\r\n" $pattern "\n" pattern
1127 regsub -all "\n" $pattern "\r\n" pattern
1128 if [llength $args]==3 then {
1129 set message [lindex $args 2]
1131 set message $command
1134 return [gdb_test $command $pattern $message]
1137 # Wrapper around gdb_test_multiple that looks for a list of expected
1138 # output elements, but which can appear in any order.
1139 # CMD is the gdb command.
1140 # NAME is the name of the test.
1141 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1143 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1144 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1145 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1147 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1148 # of text per element and then strip trailing \r\n's.
1150 # gdb_test_list_exact "foo" "bar" \
1151 # "\[^\r\n\]+\[\r\n\]+" \
1154 # {expected result 1} \
1155 # {expected result 2} \
1158 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1161 set matches [lsort $result_match_list]
1163 gdb_test_multiple $cmd $name {
1164 "$cmd\[\r\n\]" { exp_continue }
1165 -re $elm_find_regexp {
1166 set str $expect_out(0,string)
1167 verbose -log "seen: $str" 3
1168 regexp -- $elm_extract_regexp $str elm_seen
1169 verbose -log "extracted: $elm_seen" 3
1170 lappend seen $elm_seen
1173 -re "$gdb_prompt $" {
1175 foreach got [lsort $seen] have $matches {
1176 if {![string equal $got $have]} {
1181 if {[string length $failed] != 0} {
1182 fail "$name ($failed not found)"
1191 # Issue a PASS and return true if evaluating CONDITION in the caller's
1192 # frame returns true, and issue a FAIL and return false otherwise.
1193 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1194 # omitted or is empty, then the pass/fail messages use the condition
1195 # string as the message.
1197 proc gdb_assert { condition {message ""} } {
1198 if { $message == ""} {
1199 set message $condition
1202 set res [uplevel 1 expr $condition]
1211 proc gdb_reinitialize_dir { subdir } {
1214 if [is_remote host] {
1219 -re "Reinitialize source path to empty.*y or n. " {
1222 -re "Source directories searched.*$gdb_prompt $" {
1223 send_gdb "dir $subdir\n"
1225 -re "Source directories searched.*$gdb_prompt $" {
1226 verbose "Dir set to $subdir"
1228 -re "$gdb_prompt $" {
1229 perror "Dir \"$subdir\" failed."
1233 -re "$gdb_prompt $" {
1234 perror "Dir \"$subdir\" failed."
1238 -re "$gdb_prompt $" {
1239 perror "Dir \"$subdir\" failed."
1245 # gdb_exit -- exit the GDB, killing the target program if necessary
1247 proc default_gdb_exit {} {
1249 global INTERNAL_GDBFLAGS GDBFLAGS
1252 global inotify_log_file
1254 gdb_stop_suppressing_tests
1256 if ![info exists gdb_spawn_id] {
1260 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1262 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1263 set fd [open $inotify_log_file]
1264 set data [read -nonewline $fd]
1267 if {[string compare $data ""] != 0} {
1268 warning "parallel-unsafe file creations noticed"
1271 set fd [open $inotify_log_file w]
1276 if { [is_remote host] && [board_info host exists fileid] } {
1283 -re "DOSEXIT code" { }
1288 if ![is_remote host] {
1294 # Load a file into the debugger.
1295 # The return value is 0 for success, -1 for failure.
1297 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1298 # to one of these values:
1300 # debug file was loaded successfully and has debug information
1301 # nodebug file was loaded successfully and has no debug information
1302 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1304 # fail file was not loaded
1306 # I tried returning this information as part of the return value,
1307 # but ran into a mess because of the many re-implementations of
1308 # gdb_load in config/*.exp.
1310 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1311 # this if they can get more information set.
1313 proc gdb_file_cmd { arg } {
1317 global last_loaded_file
1319 # Save this for the benefit of gdbserver-support.exp.
1320 set last_loaded_file $arg
1322 # Set whether debug info was found.
1323 # Default to "fail".
1324 global gdb_file_cmd_debug_info
1325 set gdb_file_cmd_debug_info "fail"
1327 if [is_remote host] {
1328 set arg [remote_download host $arg]
1330 perror "download failed"
1335 # The file command used to kill the remote target. For the benefit
1336 # of the testsuite, preserve this behavior.
1339 -re "Kill the program being debugged. .y or n. $" {
1341 verbose "\t\tKilling previous program being debugged"
1344 -re "$gdb_prompt $" {
1349 send_gdb "file $arg\n"
1351 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1352 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1353 set gdb_file_cmd_debug_info "lzma"
1356 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1357 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1358 set gdb_file_cmd_debug_info "nodebug"
1361 -re "Reading symbols from.*done.*$gdb_prompt $" {
1362 verbose "\t\tLoaded $arg into $GDB"
1363 set gdb_file_cmd_debug_info "debug"
1366 -re "Load new symbol table from \".*\".*y or n. $" {
1369 -re "Reading symbols from.*done.*$gdb_prompt $" {
1370 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1371 set gdb_file_cmd_debug_info "debug"
1375 perror "Couldn't load $arg, other program already loaded (timeout)."
1379 perror "Couldn't load $arg, other program already loaded (eof)."
1384 -re "No such file or directory.*$gdb_prompt $" {
1385 perror "($arg) No such file or directory"
1388 -re "A problem internal to GDB has been detected" {
1389 fail "($arg) (GDB internal error)"
1390 gdb_internal_error_resync
1393 -re "$gdb_prompt $" {
1394 perror "Couldn't load $arg into $GDB."
1398 perror "Couldn't load $arg into $GDB (timeout)."
1402 # This is an attempt to detect a core dump, but seems not to
1403 # work. Perhaps we need to match .* followed by eof, in which
1404 # gdb_expect does not seem to have a way to do that.
1405 perror "Couldn't load $arg into $GDB (eof)."
1411 # Default gdb_spawn procedure.
1413 proc default_gdb_spawn { } {
1416 global INTERNAL_GDBFLAGS GDBFLAGS
1419 gdb_stop_suppressing_tests
1421 # Set the default value, it may be overriden later by specific testfile.
1423 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1424 # is already started after connecting and run/attach are not supported.
1425 # This is used for the "remote" protocol. After GDB starts you should
1426 # check global $use_gdb_stub instead of the board as the testfile may force
1427 # a specific different target protocol itself.
1428 set use_gdb_stub [target_info exists use_gdb_stub]
1430 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1432 if [info exists gdb_spawn_id] {
1436 if ![is_remote host] {
1437 if { [which $GDB] == 0 } then {
1438 perror "$GDB does not exist."
1442 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1443 if { $res < 0 || $res == "" } {
1444 perror "Spawning $GDB failed."
1448 set gdb_spawn_id $res
1452 # Default gdb_start procedure.
1454 proc default_gdb_start { } {
1455 global gdb_prompt pagination_prompt
1458 if [info exists gdb_spawn_id] {
1467 # When running over NFS, particularly if running many simultaneous
1468 # tests on different hosts all using the same server, things can
1469 # get really slow. Give gdb at least 3 minutes to start up.
1471 while { $loop_again } {
1474 -re "$pagination_prompt" {
1475 verbose "Hit pagination during startup. Pressing enter to continue."
1479 -re "\[\r\n\]$gdb_prompt $" {
1480 verbose "GDB initialized."
1482 -re "$gdb_prompt $" {
1483 perror "GDB never initialized."
1488 perror "(timeout) GDB never initialized after 10 seconds."
1496 # force the height to "unlimited", so no pagers get used
1498 send_gdb "set height 0\n"
1500 -re "$gdb_prompt $" {
1501 verbose "Setting height to 0." 2
1504 warning "Couldn't set the height to 0"
1507 # force the width to "unlimited", so no wraparound occurs
1508 send_gdb "set width 0\n"
1510 -re "$gdb_prompt $" {
1511 verbose "Setting width to 0." 2
1514 warning "Couldn't set the width to 0."
1520 # Utility procedure to give user control of the gdb prompt in a script. It is
1521 # meant to be used for debugging test cases, and should not be left in the
1524 proc gdb_interact { } {
1526 set spawn_id $gdb_spawn_id
1528 send_user "+------------------------------------------+\n"
1529 send_user "| Script interrupted, you can now interact |\n"
1530 send_user "| with by gdb. Type >>> to continue. |\n"
1531 send_user "+------------------------------------------+\n"
1538 # Examine the output of compilation to determine whether compilation
1539 # failed or not. If it failed determine whether it is due to missing
1540 # compiler or due to compiler error. Report pass, fail or unsupported
1543 proc gdb_compile_test {src output} {
1544 if { $output == "" } {
1545 pass "compilation [file tail $src]"
1546 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1547 unsupported "compilation [file tail $src]"
1548 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1549 unsupported "compilation [file tail $src]"
1550 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1551 unsupported "compilation [file tail $src]"
1553 verbose -log "compilation failed: $output" 2
1554 fail "compilation [file tail $src]"
1558 # Return a 1 for configurations for which we don't even want to try to
1561 proc skip_cplus_tests {} {
1562 if { [istarget "h8300-*-*"] } {
1566 # The C++ IO streams are too large for HC11/HC12 and are thus not
1567 # available. The gdb C++ tests use them and don't compile.
1568 if { [istarget "m6811-*-*"] } {
1571 if { [istarget "m6812-*-*"] } {
1577 # Return a 1 for configurations for which don't have both C++ and the STL.
1579 proc skip_stl_tests {} {
1580 # Symbian supports the C++ language, but the STL is missing
1581 # (both headers and libraries).
1582 if { [istarget "arm*-*-symbianelf*"] } {
1586 return [skip_cplus_tests]
1589 # Return a 1 if I don't even want to try to test FORTRAN.
1591 proc skip_fortran_tests {} {
1595 # Return a 1 if I don't even want to try to test ada.
1597 proc skip_ada_tests {} {
1601 # Return a 1 if I don't even want to try to test GO.
1603 proc skip_go_tests {} {
1607 # Return a 1 if I don't even want to try to test java.
1609 proc skip_java_tests {} {
1613 # Return a 1 if I don't even want to try to test D.
1615 proc skip_d_tests {} {
1619 # Return a 1 for configurations that do not support Python scripting.
1621 proc skip_python_tests {} {
1623 global gdb_py_is_py3k
1624 global gdb_py_is_py24
1626 gdb_test_multiple "python print ('test')" "verify python support" {
1627 -re "not supported.*$gdb_prompt $" {
1628 unsupported "Python support is disabled."
1631 -re "$gdb_prompt $" {}
1634 set gdb_py_is_py24 0
1635 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1636 -re "3.*$gdb_prompt $" {
1637 set gdb_py_is_py3k 1
1639 -re ".*$gdb_prompt $" {
1640 set gdb_py_is_py3k 0
1643 if { $gdb_py_is_py3k == 0 } {
1644 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1645 -re "\[45\].*$gdb_prompt $" {
1646 set gdb_py_is_py24 1
1648 -re ".*$gdb_prompt $" {
1649 set gdb_py_is_py24 0
1657 # Return a 1 if we should skip shared library tests.
1659 proc skip_shlib_tests {} {
1660 # Run the shared library tests on native systems.
1665 # An abbreviated list of remote targets where we should be able to
1666 # run shared library tests.
1667 if {([istarget *-*-linux*]
1668 || [istarget *-*-*bsd*]
1669 || [istarget *-*-solaris2*]
1670 || [istarget arm*-*-symbianelf*]
1671 || [istarget *-*-mingw*]
1672 || [istarget *-*-cygwin*]
1673 || [istarget *-*-pe*])} {
1680 # Test files shall make sure all the test result lines in gdb.sum are
1681 # unique in a test run, so that comparing the gdb.sum files of two
1682 # test runs gives correct results. Test files that exercise
1683 # variations of the same tests more than once, shall prefix the
1684 # different test invocations with different identifying strings in
1685 # order to make them unique.
1687 # About test prefixes:
1689 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1690 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1691 # underlined substring in
1693 # PASS: gdb.base/mytest.exp: some test
1694 # ^^^^^^^^^^^^^^^^^^^^
1698 # The easiest way to adjust the test prefix is to append a test
1699 # variation prefix to the $pf_prefix, using the with_test_prefix
1702 # proc do_tests {} {
1703 # gdb_test ... ... "test foo"
1704 # gdb_test ... ... "test bar"
1706 # with_test_prefix "subvariation a" {
1707 # gdb_test ... ... "test x"
1710 # with_test_prefix "subvariation b" {
1711 # gdb_test ... ... "test x"
1715 # with_test_prefix "variation1" {
1716 # ...do setup for variation 1...
1720 # with_test_prefix "variation2" {
1721 # ...do setup for variation 2...
1727 # PASS: gdb.base/mytest.exp: variation1: test foo
1728 # PASS: gdb.base/mytest.exp: variation1: test bar
1729 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1730 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1731 # PASS: gdb.base/mytest.exp: variation2: test foo
1732 # PASS: gdb.base/mytest.exp: variation2: test bar
1733 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1734 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1736 # If for some reason more flexibility is necessary, one can also
1737 # manipulate the pf_prefix global directly, treating it as a string.
1741 # set saved_pf_prefix
1742 # append pf_prefix "${foo}: bar"
1743 # ... actual tests ...
1744 # set pf_prefix $saved_pf_prefix
1747 # Run BODY in the context of the caller, with the current test prefix
1748 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1749 # Returns the result of BODY.
1751 proc with_test_prefix { prefix body } {
1754 set saved $pf_prefix
1755 append pf_prefix " " $prefix ":"
1756 set code [catch {uplevel 1 $body} result]
1757 set pf_prefix $saved
1760 global errorInfo errorCode
1761 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1763 return -code $code $result
1767 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1768 # PROMPT. When BODY is finished, restore GDB prompt and variable
1770 # Returns the result of BODY.
1774 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
1775 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
1776 # TCL). PROMPT is internally converted to a suitable regexp for matching.
1777 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
1778 # a) It's more intuitive for callers to pass the plain text form.
1779 # b) We need two forms of the prompt:
1780 # - a regexp to use in output matching,
1781 # - a value to pass to the "set prompt" command.
1782 # c) It's easier to convert the plain text form to its regexp form.
1784 # 2) Don't add a trailing space, we do that here.
1786 proc with_gdb_prompt { prompt body } {
1789 # Convert "(foo)" to "\(foo\)".
1790 # We don't use string_to_regexp because while it works today it's not
1791 # clear it will work tomorrow: the value we need must work as both a
1792 # regexp *and* as the argument to the "set prompt" command, at least until
1793 # we start recording both forms separately instead of just $gdb_prompt.
1794 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
1796 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
1798 set saved $gdb_prompt
1800 verbose -log "Setting gdb prompt to \"$prompt \"."
1801 set gdb_prompt $prompt
1802 gdb_test_no_output "set prompt $prompt " ""
1804 set code [catch {uplevel 1 $body} result]
1806 verbose -log "Restoring gdb prompt to \"$saved \"."
1807 set gdb_prompt $saved
1808 gdb_test_no_output "set prompt $saved " ""
1811 global errorInfo errorCode
1812 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1814 return -code $code $result
1818 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
1819 # BODY is finished, restore target-charset.
1821 proc with_target_charset { target_charset body } {
1825 gdb_test_multiple "show target-charset" "" {
1826 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
1827 set saved $expect_out(1,string)
1829 -re "The target character set is \"(.*)\".*$gdb_prompt " {
1830 set saved $expect_out(1,string)
1832 -re ".*$gdb_prompt " {
1833 fail "get target-charset"
1837 gdb_test_no_output "set target-charset $target_charset" ""
1839 set code [catch {uplevel 1 $body} result]
1841 gdb_test_no_output "set target-charset $saved" ""
1844 global errorInfo errorCode
1845 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1847 return -code $code $result
1851 # Return 1 if _Complex types are supported, otherwise, return 0.
1853 gdb_caching_proc support_complex_tests {
1854 # Set up, compile, and execute a test program containing _Complex types.
1855 # Include the current process ID in the file names to prevent conflicts
1856 # with invocations for multiple testsuites.
1857 set src [standard_temp_file complex[pid].c]
1858 set exe [standard_temp_file complex[pid].x]
1860 gdb_produce_source $src {
1864 _Complex long double cld;
1869 verbose "compiling testfile $src" 2
1870 set compile_flags {debug nowarnings quiet}
1871 set lines [gdb_compile $src $exe executable $compile_flags]
1875 if ![string match "" $lines] then {
1876 verbose "testfile compilation failed, returning 0" 2
1885 # Return 1 if target hardware or OS supports single stepping to signal
1886 # handler, otherwise, return 0.
1888 proc can_single_step_to_signal_handler {} {
1890 # Targets don't have hardware single step. On these targets, when
1891 # a signal is delivered during software single step, gdb is unable
1892 # to determine the next instruction addresses, because start of signal
1893 # handler is one of them.
1894 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
1895 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
1896 || [istarget "nios2-*-*"] } {
1903 # Return 1 if target supports process record, otherwise return 0.
1905 proc supports_process_record {} {
1907 if [target_info exists gdb,use_precord] {
1908 return [target_info gdb,use_precord]
1911 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1912 || [istarget "i\[34567\]86-*-linux*"]
1913 || [istarget "powerpc*-*-linux*"] } {
1920 # Return 1 if target supports reverse debugging, otherwise return 0.
1922 proc supports_reverse {} {
1924 if [target_info exists gdb,can_reverse] {
1925 return [target_info gdb,can_reverse]
1928 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1929 || [istarget "i\[34567\]86-*-linux*"]
1930 || [istarget "powerpc*-*-linux*"] } {
1937 # Return 1 if readline library is used.
1939 proc readline_is_used { } {
1942 gdb_test_multiple "show editing" "" {
1943 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
1946 -re ".*$gdb_prompt $" {
1952 # Return 1 if target is ELF.
1953 gdb_caching_proc is_elf_target {
1954 set me "is_elf_target"
1956 set src [standard_temp_file is_elf_target[pid].c]
1957 set obj [standard_temp_file is_elf_target[pid].o]
1959 gdb_produce_source $src {
1960 int foo () {return 0;}
1963 verbose "$me: compiling testfile $src" 2
1964 set lines [gdb_compile $src $obj object {quiet}]
1968 if ![string match "" $lines] then {
1969 verbose "$me: testfile compilation failed, returning 0" 2
1973 set fp_obj [open $obj "r"]
1974 fconfigure $fp_obj -translation binary
1975 set data [read $fp_obj]
1980 set ELFMAG "\u007FELF"
1982 if {[string compare -length 4 $data $ELFMAG] != 0} {
1983 verbose "$me: returning 0" 2
1987 verbose "$me: returning 1" 2
1991 # Return 1 if the memory at address zero is readable.
1993 gdb_caching_proc is_address_zero_readable {
1997 gdb_test_multiple "x 0" "" {
1998 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2001 -re ".*$gdb_prompt $" {
2009 # Produce source file NAME and write SOURCES into it.
2011 proc gdb_produce_source { name sources } {
2013 set f [open $name "w"]
2019 # Return 1 if target is ILP32.
2020 # This cannot be decided simply from looking at the target string,
2021 # as it might depend on externally passed compiler options like -m64.
2022 gdb_caching_proc is_ilp32_target {
2023 set me "is_ilp32_target"
2025 set src [standard_temp_file ilp32[pid].c]
2026 set obj [standard_temp_file ilp32[pid].o]
2028 gdb_produce_source $src {
2029 int dummy[sizeof (int) == 4
2030 && sizeof (void *) == 4
2031 && sizeof (long) == 4 ? 1 : -1];
2034 verbose "$me: compiling testfile $src" 2
2035 set lines [gdb_compile $src $obj object {quiet}]
2039 if ![string match "" $lines] then {
2040 verbose "$me: testfile compilation failed, returning 0" 2
2044 verbose "$me: returning 1" 2
2048 # Return 1 if target is LP64.
2049 # This cannot be decided simply from looking at the target string,
2050 # as it might depend on externally passed compiler options like -m64.
2051 gdb_caching_proc is_lp64_target {
2052 set me "is_lp64_target"
2054 set src [standard_temp_file lp64[pid].c]
2055 set obj [standard_temp_file lp64[pid].o]
2057 gdb_produce_source $src {
2058 int dummy[sizeof (int) == 4
2059 && sizeof (void *) == 8
2060 && sizeof (long) == 8 ? 1 : -1];
2063 verbose "$me: compiling testfile $src" 2
2064 set lines [gdb_compile $src $obj object {quiet}]
2068 if ![string match "" $lines] then {
2069 verbose "$me: testfile compilation failed, returning 0" 2
2073 verbose "$me: returning 1" 2
2077 # Return 1 if target has 64 bit addresses.
2078 # This cannot be decided simply from looking at the target string,
2079 # as it might depend on externally passed compiler options like -m64.
2080 gdb_caching_proc is_64_target {
2081 set me "is_64_target"
2083 set src [standard_temp_file is64[pid].c]
2084 set obj [standard_temp_file is64[pid].o]
2086 gdb_produce_source $src {
2087 int function(void) { return 3; }
2088 int dummy[sizeof (&function) == 8 ? 1 : -1];
2091 verbose "$me: compiling testfile $src" 2
2092 set lines [gdb_compile $src $obj object {quiet}]
2096 if ![string match "" $lines] then {
2097 verbose "$me: testfile compilation failed, returning 0" 2
2101 verbose "$me: returning 1" 2
2105 # Return 1 if target has x86_64 registers - either amd64 or x32.
2106 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2107 # just from the target string.
2108 gdb_caching_proc is_amd64_regs_target {
2109 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2113 set me "is_amd64_regs_target"
2115 set src [standard_temp_file reg64[pid].s]
2116 set obj [standard_temp_file reg64[pid].o]
2120 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2121 lappend list "\tincq %$reg"
2123 gdb_produce_source $src [join $list \n]
2125 verbose "$me: compiling testfile $src" 2
2126 set lines [gdb_compile $src $obj object {quiet}]
2130 if ![string match "" $lines] then {
2131 verbose "$me: testfile compilation failed, returning 0" 2
2135 verbose "$me: returning 1" 2
2139 # Return 1 if this target is an x86 or x86-64 with -m32.
2140 proc is_x86_like_target {} {
2141 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2144 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2147 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2148 proc support_displaced_stepping {} {
2150 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2151 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2152 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
2159 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2160 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2162 gdb_caching_proc skip_altivec_tests {
2163 global srcdir subdir gdb_prompt inferior_exited_re
2165 set me "skip_altivec_tests"
2167 # Some simulators are known to not support VMX instructions.
2168 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2169 verbose "$me: target known to not support VMX, returning 1" 2
2173 # Make sure we have a compiler that understands altivec.
2174 set compile_flags {debug nowarnings}
2175 if [get_compiler_info] {
2176 warning "Could not get compiler info"
2179 if [test_compiler_info gcc*] {
2180 set compile_flags "$compile_flags additional_flags=-maltivec"
2181 } elseif [test_compiler_info xlc*] {
2182 set compile_flags "$compile_flags additional_flags=-qaltivec"
2184 verbose "Could not compile with altivec support, returning 1" 2
2188 # Set up, compile, and execute a test program containing VMX instructions.
2189 # Include the current process ID in the file names to prevent conflicts
2190 # with invocations for multiple testsuites.
2191 set src [standard_temp_file vmx[pid].c]
2192 set exe [standard_temp_file vmx[pid].x]
2194 gdb_produce_source $src {
2197 asm volatile ("vor v0,v0,v0");
2199 asm volatile ("vor 0,0,0");
2205 verbose "$me: compiling testfile $src" 2
2206 set lines [gdb_compile $src $exe executable $compile_flags]
2209 if ![string match "" $lines] then {
2210 verbose "$me: testfile compilation failed, returning 1" 2
2214 # No error message, compilation succeeded so now run it via gdb.
2218 gdb_reinitialize_dir $srcdir/$subdir
2222 -re ".*Illegal instruction.*${gdb_prompt} $" {
2223 verbose -log "\n$me altivec hardware not detected"
2224 set skip_vmx_tests 1
2226 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2227 verbose -log "\n$me: altivec hardware detected"
2228 set skip_vmx_tests 0
2231 warning "\n$me: default case taken"
2232 set skip_vmx_tests 1
2236 remote_file build delete $exe
2238 verbose "$me: returning $skip_vmx_tests" 2
2239 return $skip_vmx_tests
2242 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2243 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2245 gdb_caching_proc skip_vsx_tests {
2246 global srcdir subdir gdb_prompt inferior_exited_re
2248 set me "skip_vsx_tests"
2250 # Some simulators are known to not support Altivec instructions, so
2251 # they won't support VSX instructions as well.
2252 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2253 verbose "$me: target known to not support VSX, returning 1" 2
2257 # Make sure we have a compiler that understands altivec.
2258 set compile_flags {debug nowarnings quiet}
2259 if [get_compiler_info] {
2260 warning "Could not get compiler info"
2263 if [test_compiler_info gcc*] {
2264 set compile_flags "$compile_flags additional_flags=-mvsx"
2265 } elseif [test_compiler_info xlc*] {
2266 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2268 verbose "Could not compile with vsx support, returning 1" 2
2272 set src [standard_temp_file vsx[pid].c]
2273 set exe [standard_temp_file vsx[pid].x]
2275 gdb_produce_source $src {
2277 double a[2] = { 1.0, 2.0 };
2279 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2281 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2287 verbose "$me: compiling testfile $src" 2
2288 set lines [gdb_compile $src $exe executable $compile_flags]
2291 if ![string match "" $lines] then {
2292 verbose "$me: testfile compilation failed, returning 1" 2
2296 # No error message, compilation succeeded so now run it via gdb.
2300 gdb_reinitialize_dir $srcdir/$subdir
2304 -re ".*Illegal instruction.*${gdb_prompt} $" {
2305 verbose -log "\n$me VSX hardware not detected"
2306 set skip_vsx_tests 1
2308 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2309 verbose -log "\n$me: VSX hardware detected"
2310 set skip_vsx_tests 0
2313 warning "\n$me: default case taken"
2314 set skip_vsx_tests 1
2318 remote_file build delete $exe
2320 verbose "$me: returning $skip_vsx_tests" 2
2321 return $skip_vsx_tests
2324 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2325 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2327 gdb_caching_proc skip_btrace_tests {
2328 global srcdir subdir gdb_prompt inferior_exited_re
2330 set me "skip_btrace_tests"
2331 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2332 verbose "$me: target does not support btrace, returning 1" 2
2336 # Set up, compile, and execute a test program.
2337 # Include the current process ID in the file names to prevent conflicts
2338 # with invocations for multiple testsuites.
2339 set src [standard_temp_file btrace[pid].c]
2340 set exe [standard_temp_file btrace[pid].x]
2342 gdb_produce_source $src {
2343 int main(void) { return 0; }
2346 verbose "$me: compiling testfile $src" 2
2347 set compile_flags {debug nowarnings quiet}
2348 set lines [gdb_compile $src $exe executable $compile_flags]
2350 if ![string match "" $lines] then {
2351 verbose "$me: testfile compilation failed, returning 1" 2
2356 # No error message, compilation succeeded so now run it via gdb.
2360 gdb_reinitialize_dir $srcdir/$subdir
2367 # In case of an unexpected output, we return 2 as a fail value.
2368 set skip_btrace_tests 2
2369 gdb_test_multiple "record btrace" "check btrace support" {
2370 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2371 set skip_btrace_tests 1
2373 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2374 set skip_btrace_tests 1
2376 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2377 set skip_btrace_tests 1
2379 -re "^record btrace\r\n$gdb_prompt $" {
2380 set skip_btrace_tests 0
2384 remote_file build delete $exe
2386 verbose "$me: returning $skip_btrace_tests" 2
2387 return $skip_btrace_tests
2390 # Skip all the tests in the file if you are not on an hppa running
2393 proc skip_hp_tests {} {
2394 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
2395 verbose "Skip hp tests is $skip_hp"
2399 # Return whether we should skip tests for showing inlined functions in
2400 # backtraces. Requires get_compiler_info and get_debug_format.
2402 proc skip_inline_frame_tests {} {
2403 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2404 if { ! [test_debug_format "DWARF 2"] } {
2408 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2409 if { ([test_compiler_info "gcc-2-*"]
2410 || [test_compiler_info "gcc-3-*"]
2411 || [test_compiler_info "gcc-4-0-*"]) } {
2418 # Return whether we should skip tests for showing variables from
2419 # inlined functions. Requires get_compiler_info and get_debug_format.
2421 proc skip_inline_var_tests {} {
2422 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2423 if { ! [test_debug_format "DWARF 2"] } {
2430 # Return a 1 if we should skip tests that require hardware breakpoints
2432 proc skip_hw_breakpoint_tests {} {
2433 # Skip tests if requested by the board (note that no_hardware_watchpoints
2434 # disables both watchpoints and breakpoints)
2435 if { [target_info exists gdb,no_hardware_watchpoints]} {
2439 # These targets support hardware breakpoints natively
2440 if { [istarget "i?86-*-*"]
2441 || [istarget "x86_64-*-*"]
2442 || [istarget "ia64-*-*"]
2443 || [istarget "arm*-*-*"]} {
2450 # Return a 1 if we should skip tests that require hardware watchpoints
2452 proc skip_hw_watchpoint_tests {} {
2453 # Skip tests if requested by the board
2454 if { [target_info exists gdb,no_hardware_watchpoints]} {
2458 # These targets support hardware watchpoints natively
2459 if { [istarget "i?86-*-*"]
2460 || [istarget "x86_64-*-*"]
2461 || [istarget "ia64-*-*"]
2462 || [istarget "arm*-*-*"]
2463 || [istarget "powerpc*-*-linux*"]
2464 || [istarget "s390*-*-*"] } {
2471 # Return a 1 if we should skip tests that require *multiple* hardware
2472 # watchpoints to be active at the same time
2474 proc skip_hw_watchpoint_multi_tests {} {
2475 if { [skip_hw_watchpoint_tests] } {
2479 # These targets support just a single hardware watchpoint
2480 if { [istarget "arm*-*-*"]
2481 || [istarget "powerpc*-*-linux*"] } {
2488 # Return a 1 if we should skip tests that require read/access watchpoints
2490 proc skip_hw_watchpoint_access_tests {} {
2491 if { [skip_hw_watchpoint_tests] } {
2495 # These targets support just write watchpoints
2496 if { [istarget "s390*-*-*"] } {
2503 # Return 1 if we should skip tests that require the runtime unwinder
2504 # hook. This must be invoked while gdb is running, after shared
2505 # libraries have been loaded. This is needed because otherwise a
2506 # shared libgcc won't be visible.
2508 proc skip_unwinder_tests {} {
2512 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2513 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2515 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2518 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2522 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2523 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2526 -re "\r\n$gdb_prompt $" {
2533 # Return 0 if we should skip tests that require the libstdc++ stap
2534 # probes. This must be invoked while gdb is running, after shared
2535 # libraries have been loaded.
2537 proc skip_libstdcxx_probe_tests {} {
2541 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2542 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2545 -re "\r\n$gdb_prompt $" {
2551 # Return 1 if we should skip tests of the "compile" feature.
2552 # This must be invoked after the inferior has been started.
2554 proc skip_compile_feature_tests {} {
2558 gdb_test_multiple "compile code -- ;" "check for working compile command" {
2559 "Could not load libcc1.*\r\n$gdb_prompt $" {
2562 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
2565 -re "\r\n$gdb_prompt $" {
2571 # Check whether we're testing with the remote or extended-remote
2574 proc gdb_is_target_remote {} {
2577 set test "probe for target remote"
2578 gdb_test_multiple "maint print target-stack" $test {
2579 -re ".*emote serial target in gdb-specific protocol.*$gdb_prompt $" {
2583 -re "$gdb_prompt $" {
2590 # Return 1 if the current remote target is an instance of our GDBserver, 0
2591 # otherwise. Return -1 if there was an error and we can't tell.
2593 gdb_caching_proc target_is_gdbserver {
2597 set test "Probing for GDBserver"
2599 gdb_test_multiple "monitor help" $test {
2600 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
2603 -re "$gdb_prompt $" {
2608 if { $is_gdbserver == -1 } {
2609 verbose -log "Unable to tell whether we are using GDBserver or not."
2612 return $is_gdbserver
2615 set compiler_info "unknown"
2617 set hp_cc_compiler 0
2618 set hp_aCC_compiler 0
2620 # Figure out what compiler I am using.
2622 # ARG can be empty or "C++". If empty, "C" is assumed.
2624 # There are several ways to do this, with various problems.
2626 # [ gdb_compile -E $ifile -o $binfile.ci ]
2627 # source $binfile.ci
2629 # Single Unix Spec v3 says that "-E -o ..." together are not
2630 # specified. And in fact, the native compiler on hp-ux 11 (among
2631 # others) does not work with "-E -o ...". Most targets used to do
2632 # this, and it mostly worked, because it works with gcc.
2634 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2635 # source $binfile.ci
2637 # This avoids the problem with -E and -o together. This almost works
2638 # if the build machine is the same as the host machine, which is
2639 # usually true of the targets which are not gcc. But this code does
2640 # not figure which compiler to call, and it always ends up using the C
2641 # compiler. Not good for setting hp_aCC_compiler. Target
2642 # hppa*-*-hpux* used to do this.
2644 # [ gdb_compile -E $ifile > $binfile.ci ]
2645 # source $binfile.ci
2647 # dejagnu target_compile says that it supports output redirection,
2648 # but the code is completely different from the normal path and I
2649 # don't want to sweep the mines from that path. So I didn't even try
2652 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2655 # I actually do this for all targets now. gdb_compile runs the right
2656 # compiler, and TCL captures the output, and I eval the output.
2658 # Unfortunately, expect logs the output of the command as it goes by,
2659 # and dejagnu helpfully prints a second copy of it right afterwards.
2660 # So I turn off expect logging for a moment.
2662 # [ gdb_compile $ifile $ciexe_file executable $args ]
2663 # [ remote_exec $ciexe_file ]
2664 # [ source $ci_file.out ]
2666 # I could give up on -E and just do this.
2667 # I didn't get desperate enough to try this.
2669 # -- chastain 2004-01-06
2671 proc get_compiler_info {{arg ""}} {
2672 # For compiler.c and compiler.cc
2675 # I am going to play with the log to keep noise out.
2679 # These come from compiler.c or compiler.cc
2680 global compiler_info
2682 # Legacy global data symbols.
2684 global hp_cc_compiler
2685 global hp_aCC_compiler
2687 # Choose which file to preprocess.
2688 set ifile "${srcdir}/lib/compiler.c"
2689 if { $arg == "c++" } {
2690 set ifile "${srcdir}/lib/compiler.cc"
2693 # Run $ifile through the right preprocessor.
2694 # Toggle gdb.log to keep the compiler output out of the log.
2695 set saved_log [log_file -info]
2697 if [is_remote host] {
2698 # We have to use -E and -o together, despite the comments
2699 # above, because of how DejaGnu handles remote host testing.
2700 set ppout "$outdir/compiler.i"
2701 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
2702 set file [open $ppout r]
2703 set cppout [read $file]
2706 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
2708 eval log_file $saved_log
2712 foreach cppline [ split "$cppout" "\n" ] {
2713 if { [ regexp "^#" "$cppline" ] } {
2715 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2717 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2719 verbose "get_compiler_info: $cppline" 2
2723 verbose -log "get_compiler_info: $cppline"
2728 # Reset to unknown compiler if any diagnostics happened.
2730 set compiler_info "unknown"
2733 # Set the legacy symbols.
2735 set hp_cc_compiler 0
2736 set hp_aCC_compiler 0
2737 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2738 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2739 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2740 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2741 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2742 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2743 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2745 # Log what happened.
2746 verbose -log "get_compiler_info: $compiler_info"
2748 # Most compilers will evaluate comparisons and other boolean
2749 # operations to 0 or 1.
2750 uplevel \#0 { set true 1 }
2751 uplevel \#0 { set false 0 }
2753 # Use of aCC results in boolean results being displayed as
2755 if { $hp_aCC_compiler } {
2756 uplevel \#0 { set true true }
2757 uplevel \#0 { set false false }
2763 proc test_compiler_info { {compiler ""} } {
2764 global compiler_info
2766 # if no arg, return the compiler_info string
2768 if [string match "" $compiler] {
2769 if [info exists compiler_info] {
2770 return $compiler_info
2772 perror "No compiler info found."
2776 return [string match $compiler $compiler_info]
2779 proc current_target_name { } {
2781 if [info exists target_info(target,name)] {
2782 set answer $target_info(target,name)
2789 set gdb_wrapper_initialized 0
2790 set gdb_wrapper_target ""
2792 proc gdb_wrapper_init { args } {
2793 global gdb_wrapper_initialized
2794 global gdb_wrapper_file
2795 global gdb_wrapper_flags
2796 global gdb_wrapper_target
2798 if { $gdb_wrapper_initialized == 1 } { return; }
2800 if {[target_info exists needs_status_wrapper] && \
2801 [target_info needs_status_wrapper] != "0"} {
2802 set result [build_wrapper "testglue.o"]
2803 if { $result != "" } {
2804 set gdb_wrapper_file [lindex $result 0]
2805 set gdb_wrapper_flags [lindex $result 1]
2807 warning "Status wrapper failed to build."
2810 set gdb_wrapper_initialized 1
2811 set gdb_wrapper_target [current_target_name]
2814 # Some targets need to always link a special object in. Save its path here.
2815 global gdb_saved_set_unbuffered_mode_obj
2816 set gdb_saved_set_unbuffered_mode_obj ""
2818 proc gdb_compile {source dest type options} {
2819 global GDB_TESTCASE_OPTIONS
2820 global gdb_wrapper_file
2821 global gdb_wrapper_flags
2822 global gdb_wrapper_initialized
2825 global gdb_saved_set_unbuffered_mode_obj
2827 set outdir [file dirname $dest]
2829 # Add platform-specific options if a shared library was specified using
2830 # "shlib=librarypath" in OPTIONS.
2834 foreach opt $options {
2835 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2836 if [test_compiler_info "xlc-*"] {
2837 # IBM xlc compiler doesn't accept shared library named other
2838 # than .so: use "-Wl," to bypass this
2839 lappend source "-Wl,$shlib_name"
2840 } elseif { ([istarget "*-*-mingw*"]
2841 || [istarget *-*-cygwin*]
2842 || [istarget *-*-pe*])} {
2843 lappend source "${shlib_name}.a"
2845 lappend source $shlib_name
2847 if { $shlib_found == 0 } {
2849 if { ([istarget "*-*-mingw*"]
2850 || [istarget *-*-cygwin*]) } {
2851 lappend new_options "additional_flags=-Wl,--enable-auto-import"
2854 } elseif { $opt == "shlib_load" } {
2857 lappend new_options $opt
2861 # We typically link to shared libraries using an absolute path, and
2862 # that's how they are found at runtime. If we are going to
2863 # dynamically load one by basename, we must specify rpath. If we
2864 # are using a remote host, DejaGNU will link to the shared library
2865 # using a relative path, so again we must specify an rpath.
2866 if { $shlib_load || ($shlib_found && [is_remote target]) } {
2867 if { ([istarget "*-*-mingw*"]
2868 || [istarget *-*-cygwin*]
2869 || [istarget *-*-pe*]
2870 || [istarget hppa*-*-hpux*])} {
2871 # Do not need anything.
2872 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
2873 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
2874 } elseif { [istarget arm*-*-symbianelf*] } {
2875 if { $shlib_load } {
2876 lappend new_options "libs=-ldl"
2879 if { $shlib_load } {
2880 lappend new_options "libs=-ldl"
2882 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
2885 set options $new_options
2887 if [info exists GDB_TESTCASE_OPTIONS] {
2888 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
2890 verbose "options are $options"
2891 verbose "source is $source $dest $type $options"
2893 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2895 if {[target_info exists needs_status_wrapper] && \
2896 [target_info needs_status_wrapper] != "0" && \
2897 [info exists gdb_wrapper_file]} {
2898 lappend options "libs=${gdb_wrapper_file}"
2899 lappend options "ldflags=${gdb_wrapper_flags}"
2902 # Replace the "nowarnings" option with the appropriate additional_flags
2903 # to disable compiler warnings.
2904 set nowarnings [lsearch -exact $options nowarnings]
2905 if {$nowarnings != -1} {
2906 if [target_info exists gdb,nowarnings_flag] {
2907 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2909 set flag "additional_flags=-w"
2911 set options [lreplace $options $nowarnings $nowarnings $flag]
2914 if { $type == "executable" } {
2915 if { ([istarget "*-*-mingw*"]
2916 || [istarget "*-*-*djgpp"]
2917 || [istarget "*-*-cygwin*"])} {
2918 # Force output to unbuffered mode, by linking in an object file
2919 # with a global contructor that calls setvbuf.
2921 # Compile the special object seperatelly for two reasons:
2922 # 1) Insulate it from $options.
2923 # 2) Avoid compiling it for every gdb_compile invocation,
2924 # which is time consuming, especially if we're remote
2927 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2928 verbose "compiling gdb_saved_set_unbuffered_obj"
2929 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2930 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2932 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2933 if { $result != "" } {
2936 if {[is_remote host]} {
2937 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
2939 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2941 # Link a copy of the output object, because the
2942 # original may be automatically deleted.
2943 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
2945 verbose "gdb_saved_set_unbuffered_obj already compiled"
2948 # Rely on the internal knowledge that the global ctors are ran in
2949 # reverse link order. In that case, we can use ldflags to
2950 # avoid copying the object file to the host multiple
2952 # This object can only be added if standard libraries are
2953 # used. Thus, we need to disable it if -nostdlib option is used
2954 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2955 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2960 set result [target_compile $source $dest $type $options]
2962 # Prune uninteresting compiler (and linker) output.
2963 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2965 regsub "\[\r\n\]*$" "$result" "" result
2966 regsub "^\[\r\n\]*" "$result" "" result
2968 if {[lsearch $options quiet] < 0} {
2969 # We shall update this on a per language basis, to avoid
2970 # changing the entire testsuite in one go.
2971 if {[lsearch $options f77] >= 0} {
2972 gdb_compile_test $source $result
2973 } elseif { $result != "" } {
2974 clone_output "gdb compile failed, $result"
2981 # This is just like gdb_compile, above, except that it tries compiling
2982 # against several different thread libraries, to see which one this
2984 proc gdb_compile_pthreads {source dest type options} {
2986 set why_msg "unrecognized error"
2987 foreach lib {-lpthreads -lpthread -lthread ""} {
2988 # This kind of wipes out whatever libs the caller may have
2989 # set. Or maybe theirs will override ours. How infelicitous.
2990 set options_with_lib [concat $options [list libs=$lib quiet]]
2991 set ccout [gdb_compile $source $dest $type $options_with_lib]
2992 switch -regexp -- $ccout {
2993 ".*no posix threads support.*" {
2994 set why_msg "missing threads include file"
2997 ".*cannot open -lpthread.*" {
2998 set why_msg "missing runtime threads library"
3000 ".*Can't find library for -lpthread.*" {
3001 set why_msg "missing runtime threads library"
3004 pass "successfully compiled posix threads test case"
3010 if {!$built_binfile} {
3011 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3016 # Build a shared library from SOURCES.
3018 proc gdb_compile_shlib {sources dest options} {
3019 set obj_options $options
3022 if { [lsearch -exact $options "c++"] >= 0 } {
3023 set info_options "c++"
3025 if [get_compiler_info ${info_options}] {
3029 switch -glob [test_compiler_info] {
3031 lappend obj_options "additional_flags=-qpic"
3034 if { !([istarget "*-*-cygwin*"]
3035 || [istarget "*-*-mingw*"]) } {
3036 lappend obj_options "additional_flags=-fpic"
3040 if { !([istarget "powerpc*-*-aix*"]
3041 || [istarget "rs6000*-*-aix*"]
3042 || [istarget "*-*-cygwin*"]
3043 || [istarget "*-*-mingw*"]
3044 || [istarget "*-*-pe*"]) } {
3045 lappend obj_options "additional_flags=-fpic"
3049 switch -glob [istarget] {
3051 lappend obj_options "additional_flags=+z"
3054 # don't know what the compiler is...
3060 set outdir [file dirname $dest]
3062 foreach source $sources {
3063 set sourcebase [file tail $source]
3064 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3067 lappend objects ${outdir}/${sourcebase}.o
3070 if [istarget "hppa*-*-hpux*"] {
3071 remote_exec build "ld -b ${objects} -o ${dest}"
3073 set link_options $options
3074 if [test_compiler_info "xlc-*"] {
3075 lappend link_options "additional_flags=-qmkshrobj"
3077 lappend link_options "additional_flags=-shared"
3079 if { ([istarget "*-*-mingw*"]
3080 || [istarget *-*-cygwin*]
3081 || [istarget *-*-pe*]) } {
3082 if { [is_remote host] } {
3083 set name [file tail ${dest}]
3087 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3088 } elseif [is_remote target] {
3089 # By default, we do not set the soname. This causes the linker
3090 # on ELF systems to create a DT_NEEDED entry in the executable
3091 # refering to the full path name of the library. This is a
3092 # problem in remote testing if the library is in a different
3093 # directory there. To fix this, we set a soname of just the
3094 # base filename for the library, and add an appropriate -rpath
3095 # to the main executable (in gdb_compile).
3096 set destbase [file tail $dest]
3097 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3100 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3103 if { [is_remote host]
3104 && ([istarget "*-*-mingw*"]
3105 || [istarget *-*-cygwin*]
3106 || [istarget *-*-pe*]) } {
3107 set dest_tail_name [file tail ${dest}]
3108 remote_upload host $dest_tail_name.a ${dest}.a
3109 remote_file host delete $dest_tail_name.a
3115 # This is just like gdb_compile_shlib, above, except that it tries compiling
3116 # against several different thread libraries, to see which one this
3118 proc gdb_compile_shlib_pthreads {sources dest options} {
3120 set why_msg "unrecognized error"
3121 foreach lib {-lpthreads -lpthread -lthread ""} {
3122 # This kind of wipes out whatever libs the caller may have
3123 # set. Or maybe theirs will override ours. How infelicitous.
3124 set options_with_lib [concat $options [list libs=$lib quiet]]
3125 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3126 switch -regexp -- $ccout {
3127 ".*no posix threads support.*" {
3128 set why_msg "missing threads include file"
3131 ".*cannot open -lpthread.*" {
3132 set why_msg "missing runtime threads library"
3134 ".*Can't find library for -lpthread.*" {
3135 set why_msg "missing runtime threads library"
3138 pass "successfully compiled posix threads test case"
3144 if {!$built_binfile} {
3145 unsupported "Couldn't compile $sources: ${why_msg}"
3150 # This is just like gdb_compile_pthreads, above, except that we always add the
3151 # objc library for compiling Objective-C programs
3152 proc gdb_compile_objc {source dest type options} {
3154 set why_msg "unrecognized error"
3155 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3156 # This kind of wipes out whatever libs the caller may have
3157 # set. Or maybe theirs will override ours. How infelicitous.
3158 if { $lib == "solaris" } {
3159 set lib "-lpthread -lposix4"
3161 if { $lib != "-lobjc" } {
3162 set lib "-lobjc $lib"
3164 set options_with_lib [concat $options [list libs=$lib quiet]]
3165 set ccout [gdb_compile $source $dest $type $options_with_lib]
3166 switch -regexp -- $ccout {
3167 ".*no posix threads support.*" {
3168 set why_msg "missing threads include file"
3171 ".*cannot open -lpthread.*" {
3172 set why_msg "missing runtime threads library"
3174 ".*Can't find library for -lpthread.*" {
3175 set why_msg "missing runtime threads library"
3178 pass "successfully compiled objc with posix threads test case"
3184 if {!$built_binfile} {
3185 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
3190 proc send_gdb { string } {
3191 global suppress_flag
3192 if { $suppress_flag } {
3195 return [remote_send host "$string"]
3201 proc gdb_expect { args } {
3202 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3203 set atimeout [lindex $args 0]
3204 set expcode [list [lindex $args 1]]
3209 # A timeout argument takes precedence, otherwise of all the timeouts
3210 # select the largest.
3211 upvar #0 timeout gtimeout
3212 upvar timeout timeout
3213 if [info exists atimeout] {
3217 if [info exists timeout] {
3220 if { [info exists gtimeout] && $gtimeout > $tmt } {
3223 if { [target_info exists gdb,timeout]
3224 && [target_info gdb,timeout] > $tmt } {
3225 set tmt [target_info gdb,timeout]
3233 global suppress_flag
3234 global remote_suppress_flag
3235 if [info exists remote_suppress_flag] {
3236 set old_val $remote_suppress_flag
3238 if [info exists suppress_flag] {
3239 if { $suppress_flag } {
3240 set remote_suppress_flag 1
3244 {uplevel remote_expect host $tmt $expcode} string]
3245 if [info exists old_val] {
3246 set remote_suppress_flag $old_val
3248 if [info exists remote_suppress_flag] {
3249 unset remote_suppress_flag
3254 global errorInfo errorCode
3256 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3258 return -code $code $string
3262 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3264 # Check for long sequence of output by parts.
3265 # TEST: is the test message to be printed with the test success/fail.
3266 # SENTINEL: Is the terminal pattern indicating that output has finished.
3267 # LIST: is the sequence of outputs to match.
3268 # If the sentinel is recognized early, it is considered an error.
3271 # 1 if the test failed,
3272 # 0 if the test passes,
3273 # -1 if there was an internal error.
3275 proc gdb_expect_list {test sentinel list} {
3277 global suppress_flag
3280 if { $suppress_flag } {
3282 unresolved "${test}"
3284 while { ${index} < [llength ${list}] } {
3285 set pattern [lindex ${list} ${index}]
3286 set index [expr ${index} + 1]
3287 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3288 if { ${index} == [llength ${list}] } {
3291 -re "${pattern}${sentinel}" {
3292 # pass "${test}, pattern ${index} + sentinel"
3295 fail "${test} (pattern ${index} + sentinel)"
3298 -re ".*A problem internal to GDB has been detected" {
3299 fail "${test} (GDB internal error)"
3301 gdb_internal_error_resync
3304 fail "${test} (pattern ${index} + sentinel) (timeout)"
3309 # unresolved "${test}, pattern ${index} + sentinel"
3315 # pass "${test}, pattern ${index}"
3318 fail "${test} (pattern ${index})"
3321 -re ".*A problem internal to GDB has been detected" {
3322 fail "${test} (GDB internal error)"
3324 gdb_internal_error_resync
3327 fail "${test} (pattern ${index}) (timeout)"
3332 # unresolved "${test}, pattern ${index}"
3346 proc gdb_suppress_entire_file { reason } {
3347 global suppress_flag
3350 set suppress_flag -1
3354 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3355 # gdb_expect to fail immediately (until the next call to
3356 # gdb_stop_suppressing_tests).
3358 proc gdb_suppress_tests { args } {
3359 global suppress_flag
3361 return; # fnf - disable pending review of results where
3362 # testsuite ran better without this
3365 if { $suppress_flag == 1 } {
3366 if { [llength $args] > 0 } {
3367 warning "[lindex $args 0]\n"
3369 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
3375 # Clear suppress_flag.
3377 proc gdb_stop_suppressing_tests { } {
3378 global suppress_flag
3380 if [info exists suppress_flag] {
3381 if { $suppress_flag > 0 } {
3383 clone_output "Tests restarted.\n"
3390 proc gdb_clear_suppressed { } {
3391 global suppress_flag
3396 # Spawn the gdb process.
3398 # This doesn't expect any output or do any other initialization,
3399 # leaving those to the caller.
3401 # Overridable function -- you can override this function in your
3404 proc gdb_spawn { } {
3408 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
3410 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
3413 set saved_gdbflags $GDBFLAGS
3415 append GDBFLAGS $cmdline_flags
3419 set GDBFLAGS $saved_gdbflags
3424 # Start gdb running, wait for prompt, and disable the pagers.
3426 # Overridable function -- you can override this function in your
3429 proc gdb_start { } {
3434 catch default_gdb_exit
3437 # Return true if we can spawn a program on the target and attach to
3440 proc can_spawn_for_attach { } {
3441 # We use TCL's exec to get the inferior's pid.
3442 if [is_remote target] then {
3446 # The "attach" command doesn't make sense when the target is
3447 # stub-like, where GDB finds the program already started on
3448 # initial connection.
3449 if {[target_info exists use_gdb_stub]} {
3457 # Start a set of programs running and then wait for a bit, to be sure
3458 # that they can be attached to. Return a list of the processes' PIDs.
3459 # It's a test error to call this when [can_spawn_for_attach] is false.
3461 proc spawn_wait_for_attach { executable_list } {
3464 if ![can_spawn_for_attach] {
3465 # The caller should have checked can_spawn_for_attach itself
3466 # before getting here.
3467 error "can't spawn for attach with this target/board"
3470 foreach {executable} $executable_list {
3471 lappend pid_list [eval exec $executable &]
3476 if { [istarget "*-*-cygwin*"] } {
3477 for {set i 0} {$i < [llength $pid_list]} {incr i} {
3478 # testpid is the Cygwin PID, GDB uses the Windows PID,
3479 # which might be different due to the way fork/exec works.
3480 set testpid [lindex $pid_list $i]
3481 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
3482 set pid_list [lreplace $pid_list $i $i $testpid]
3490 # gdb_load_cmd -- load a file into the debugger.
3491 # ARGS - additional args to load command.
3492 # return a -1 if anything goes wrong.
3494 proc gdb_load_cmd { args } {
3497 if [target_info exists gdb_load_timeout] {
3498 set loadtimeout [target_info gdb_load_timeout]
3500 set loadtimeout 1600
3502 send_gdb "load $args\n"
3503 verbose "Timeout is now $loadtimeout seconds" 2
3504 gdb_expect $loadtimeout {
3505 -re "Loading section\[^\r\]*\r\n" {
3508 -re "Start address\[\r\]*\r\n" {
3511 -re "Transfer rate\[\r\]*\r\n" {
3514 -re "Memory access error\[^\r\]*\r\n" {
3515 perror "Failed to load program"
3518 -re "$gdb_prompt $" {
3521 -re "(.*)\r\n$gdb_prompt " {
3522 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3526 perror "Timed out trying to load $args."
3533 # Invoke "gcore". CORE is the name of the core file to write. TEST
3534 # is the name of the test case. This will return 1 if the core file
3535 # was created, 0 otherwise. If this fails to make a core file because
3536 # this configuration of gdb does not support making core files, it
3537 # will call "unsupported", not "fail". However, if this fails to make
3538 # a core file for some other reason, then it will call "fail".
3540 proc gdb_gcore_cmd {core test} {
3544 gdb_test_multiple "gcore $core" $test {
3545 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3549 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
3557 # Load core file CORE. TEST is the name of the test case.
3558 # This will record a pass/fail for loading the core file.
3560 # 1 - core file is successfully loaded
3561 # 0 - core file loaded but has a non fatal error
3562 # -1 - core file failed to load
3564 proc gdb_core_cmd { core test } {
3567 gdb_test_multiple "core $core" "$test" {
3568 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
3571 -re " is not a core dump:.*\r\n$gdb_prompt $" {
3572 fail "$test (bad file format)"
3575 -re ": No such file or directory.*\r\n$gdb_prompt $" {
3576 fail "$test (file not found)"
3579 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
3580 fail "$test (incomplete note section)"
3583 -re "Core was generated by .*\r\n$gdb_prompt $" {
3587 -re ".*$gdb_prompt $" {
3592 fail "$test (timeout)"
3596 fail "unsupported output from 'core' command"
3600 # Return the filename to download to the target and load on the target
3601 # for this shared library. Normally just LIBNAME, unless shared libraries
3602 # for this target have separate link and load images.
3604 proc shlib_target_file { libname } {
3608 # Return the filename GDB will load symbols from when debugging this
3609 # shared library. Normally just LIBNAME, unless shared libraries for
3610 # this target have separate link and load images.
3612 proc shlib_symbol_file { libname } {
3616 # Return the filename to download to the target and load for this
3617 # executable. Normally just BINFILE unless it is renamed to something
3618 # else for this target.
3620 proc exec_target_file { binfile } {
3624 # Return the filename GDB will load symbols from when debugging this
3625 # executable. Normally just BINFILE unless executables for this target
3626 # have separate files for symbols.
3628 proc exec_symbol_file { binfile } {
3632 # Rename the executable file. Normally this is just BINFILE1 being renamed
3633 # to BINFILE2, but some targets require multiple binary files.
3634 proc gdb_rename_execfile { binfile1 binfile2 } {
3635 file rename -force [exec_target_file ${binfile1}] \
3636 [exec_target_file ${binfile2}]
3637 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
3638 file rename -force [exec_symbol_file ${binfile1}] \
3639 [exec_symbol_file ${binfile2}]
3643 # "Touch" the executable file to update the date. Normally this is just
3644 # BINFILE, but some targets require multiple files.
3645 proc gdb_touch_execfile { binfile } {
3646 set time [clock seconds]
3647 file mtime [exec_target_file ${binfile}] $time
3648 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
3649 file mtime [exec_symbol_file ${binfile}] $time
3653 # Like remote_download but provides a gdb-specific behavior. If DEST
3654 # is "host", and the host is not remote, and TOFILE is not specified,
3655 # then the [file tail] of FROMFILE is passed through
3656 # standard_output_file to compute the destination.
3658 proc gdb_remote_download {dest fromfile {tofile {}}} {
3659 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
3660 set tofile [standard_output_file [file tail $fromfile]]
3663 if { $tofile == "" } {
3664 return [remote_download $dest $fromfile]
3666 return [remote_download $dest $fromfile $tofile]
3672 # Copy a file to the remote target and return its target filename.
3673 # Schedule the file to be deleted at the end of this test.
3675 proc gdb_download { filename } {
3678 set destname [remote_download target $filename]
3679 lappend cleanfiles $destname
3683 # gdb_load_shlibs LIB...
3685 # Copy the listed libraries to the target.
3687 proc gdb_load_shlibs { args } {
3688 if {![is_remote target]} {
3692 foreach file $args {
3693 gdb_download [shlib_target_file $file]
3696 # Even if the target supplies full paths for shared libraries,
3697 # they may not be paths for this system.
3698 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3702 # gdb_load -- load a file into the debugger. Specifying no file
3703 # defaults to the executable currently being debugged.
3704 # Many files in config/*.exp override this procedure.
3706 proc gdb_load { arg } {
3708 return [gdb_file_cmd $arg]
3712 # gdb_reload -- load a file into the target. Called before "running",
3713 # either the first time or after already starting the program once,
3714 # for remote targets. Most files that override gdb_load should now
3715 # override this instead.
3717 proc gdb_reload { } {
3718 # For the benefit of existing configurations, default to gdb_load.
3719 # Specifying no file defaults to the executable currently being
3721 return [gdb_load ""]
3724 proc gdb_continue { function } {
3727 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
3730 proc default_gdb_init { test_file_name } {
3731 global gdb_wrapper_initialized
3732 global gdb_wrapper_target
3733 global gdb_test_file_name
3739 gdb_clear_suppressed
3741 set gdb_test_file_name [file rootname [file tail $test_file_name]]
3743 # Make sure that the wrapper is rebuilt
3744 # with the appropriate multilib option.
3745 if { $gdb_wrapper_target != [current_target_name] } {
3746 set gdb_wrapper_initialized 0
3749 # Unlike most tests, we have a small number of tests that generate
3750 # a very large amount of output. We therefore increase the expect
3751 # buffer size to be able to contain the entire test output. This
3752 # is especially needed by gdb.base/info-macros.exp.
3754 # Also set this value for the currently running GDB.
3755 match_max [match_max -d]
3757 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
3758 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
3761 if [target_info exists gdb_prompt] {
3762 set gdb_prompt [target_info gdb_prompt]
3764 set gdb_prompt "\\(gdb\\)"
3767 if [info exists use_gdb_stub] {
3772 # Turn BASENAME into a full file name in the standard output
3773 # directory. It is ok if BASENAME is the empty string; in this case
3774 # the directory is returned.
3776 proc standard_output_file {basename} {
3777 global objdir subdir gdb_test_file_name GDB_PARALLEL
3779 if {[info exists GDB_PARALLEL]} {
3780 set dir [file join $objdir outputs $subdir $gdb_test_file_name]
3782 return [file join $dir $basename]
3784 return [file join $objdir $subdir $basename]
3788 # Return the name of a file in our standard temporary directory.
3790 proc standard_temp_file {basename} {
3791 global objdir GDB_PARALLEL
3793 if {[info exists GDB_PARALLEL]} {
3794 return [file join $objdir temp $basename]
3800 # Set 'testfile', 'srcfile', and 'binfile'.
3802 # ARGS is a list of source file specifications.
3803 # Without any arguments, the .exp file's base name is used to
3804 # compute the source file name. The ".c" extension is added in this case.
3805 # If ARGS is not empty, each entry is a source file specification.
3806 # If the specification starts with a ".", it is treated as a suffix
3807 # to append to the .exp file's base name.
3808 # If the specification is the empty string, it is treated as if it
3810 # Otherwise it is a file name.
3811 # The first file in the list is used to set the 'srcfile' global.
3812 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3814 # Most tests should call this without arguments.
3816 # If a completely different binary file name is needed, then it
3817 # should be handled in the .exp file with a suitable comment.
3819 proc standard_testfile {args} {
3820 global gdb_test_file_name
3822 global gdb_test_file_last_vars
3825 global testfile binfile
3827 set testfile $gdb_test_file_name
3828 set binfile [standard_output_file ${testfile}]
3830 if {[llength $args] == 0} {
3834 # Unset our previous output variables.
3835 # This can help catch hidden bugs.
3836 if {[info exists gdb_test_file_last_vars]} {
3837 foreach varname $gdb_test_file_last_vars {
3839 catch {unset $varname}
3842 # 'executable' is often set by tests.
3843 set gdb_test_file_last_vars {executable}
3847 set varname srcfile$suffix
3850 # Handle an extension.
3853 } elseif {[string range $arg 0 0] == "."} {
3854 set arg $testfile$arg
3858 lappend gdb_test_file_last_vars $varname
3860 if {$suffix == ""} {
3868 # The default timeout used when testing GDB commands. We want to use
3869 # the same timeout as the default dejagnu timeout, unless the user has
3870 # already provided a specific value (probably through a site.exp file).
3871 global gdb_test_timeout
3872 if ![info exists gdb_test_timeout] {
3873 set gdb_test_timeout $timeout
3876 # A list of global variables that GDB testcases should not use.
3877 # We try to prevent their use by monitoring write accesses and raising
3878 # an error when that happens.
3879 set banned_variables { bug_id prms_id }
3881 # A list of procedures that GDB testcases should not use.
3882 # We try to prevent their use by monitoring invocations and raising
3883 # an error when that happens.
3884 set banned_procedures { strace }
3886 # gdb_init is called by runtest at start, but also by several
3887 # tests directly; gdb_finish is only called from within runtest after
3888 # each test source execution.
3889 # Placing several traces by repetitive calls to gdb_init leads
3890 # to problems, as only one trace is removed in gdb_finish.
3891 # To overcome this possible problem, we add a variable that records
3892 # if the banned variables and procedures are already traced.
3895 proc gdb_init { test_file_name } {
3896 # Reset the timeout value to the default. This way, any testcase
3897 # that changes the timeout value without resetting it cannot affect
3898 # the timeout used in subsequent testcases.
3899 global gdb_test_timeout
3901 set timeout $gdb_test_timeout
3903 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
3904 && [target_info exists gdb_reverse_timeout] } {
3905 set timeout [target_info gdb_reverse_timeout]
3908 # If GDB_INOTIFY is given, check for writes to '.'. This is a
3909 # debugging tool to help confirm that the test suite is
3910 # parallel-safe. You need "inotifywait" from the
3911 # inotify-tools package to use this.
3912 global GDB_INOTIFY inotify_pid
3913 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
3914 global outdir tool inotify_log_file
3916 set exclusions {outputs temp gdb[.](log|sum) cache}
3917 set exclusion_re ([join $exclusions |])
3919 set inotify_log_file [standard_temp_file inotify.out]
3920 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
3921 --exclude $exclusion_re \
3922 |& tee -a $outdir/$tool.log $inotify_log_file &]
3924 # Wait for the watches; hopefully this is long enough.
3927 # Clear the log so that we don't emit a warning the first time
3929 set fd [open $inotify_log_file w]
3933 # Block writes to all banned variables, and invocation of all
3934 # banned procedures...
3935 global banned_variables
3936 global banned_procedures
3937 global banned_traced
3938 if (!$banned_traced) {
3939 foreach banned_var $banned_variables {
3940 global "$banned_var"
3941 trace add variable "$banned_var" write error
3943 foreach banned_proc $banned_procedures {
3944 global "$banned_proc"
3945 trace add execution "$banned_proc" enter error
3950 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
3951 # messages as expected.
3956 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
3957 # the test results. Even if /dev/null doesn't exist on the particular
3958 # platform, the readline library will use the default setting just by
3959 # failing to open the file. OTOH, opening /dev/null successfully will
3960 # also result in the default settings being used since nothing will be
3961 # read from this file.
3962 setenv INPUTRC "/dev/null"
3964 # The gdb.base/readline.exp arrow key test relies on the standard VT100
3965 # bindings, so make sure that an appropriate terminal is selected.
3966 # The same bug doesn't show up if we use ^P / ^N instead.
3969 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
3970 # grep. Clear GREP_OPTIONS to make the behavior predictable,
3971 # especially having color output turned on can cause tests to fail.
3972 setenv GREP_OPTIONS ""
3974 # Clear $gdbserver_reconnect_p.
3975 global gdbserver_reconnect_p
3976 set gdbserver_reconnect_p 1
3977 unset gdbserver_reconnect_p
3979 return [default_gdb_init $test_file_name]
3982 proc gdb_finish { } {
3983 global gdbserver_reconnect_p
3987 # Give persistent gdbserver a chance to terminate before GDB is killed.
3988 if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p
3989 && [info exists gdb_spawn_id]} {
3996 -re "$gdb_prompt $" {
4001 # Exit first, so that the files are no longer in use.
4004 if { [llength $cleanfiles] > 0 } {
4005 eval remote_file target delete $cleanfiles
4009 # Unblock write access to the banned variables. Dejagnu typically
4010 # resets some of them between testcases.
4011 global banned_variables
4012 global banned_procedures
4013 global banned_traced
4014 if ($banned_traced) {
4015 foreach banned_var $banned_variables {
4016 global "$banned_var"
4017 trace remove variable "$banned_var" write error
4019 foreach banned_proc $banned_procedures {
4020 global "$banned_proc"
4021 trace remove execution "$banned_proc" enter error
4028 set debug_format "unknown"
4030 # Run the gdb command "info source" and extract the debugging format
4031 # information from the output and save it in debug_format.
4033 proc get_debug_format { } {
4039 set debug_format "unknown"
4040 send_gdb "info source\n"
4042 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4043 set debug_format $expect_out(1,string)
4044 verbose "debug format is $debug_format"
4047 -re "No current source file.\r\n$gdb_prompt $" {
4048 perror "get_debug_format used when no current source file"
4051 -re "$gdb_prompt $" {
4052 warning "couldn't check debug format (no valid response)."
4056 warning "couldn't check debug format (timeout)."
4062 # Return true if FORMAT matches the debug format the current test was
4063 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4064 # `*', `[...]', and so on.
4066 # This function depends on variables set by `get_debug_format', above.
4068 proc test_debug_format {format} {
4071 return [expr [string match $format $debug_format] != 0]
4074 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4075 # COFF, stabs, etc). If that format matches the format that the
4076 # current test was compiled with, then the next test is expected to
4077 # fail for any target. Returns 1 if the next test or set of tests is
4078 # expected to fail, 0 otherwise (or if it is unknown). Must have
4079 # previously called get_debug_format.
4080 proc setup_xfail_format { format } {
4081 set ret [test_debug_format $format]
4089 # gdb_get_line_number TEXT [FILE]
4091 # Search the source file FILE, and return the line number of the
4092 # first line containing TEXT. If no match is found, an error is thrown.
4094 # TEXT is a string literal, not a regular expression.
4096 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4097 # specified, and does not start with "/", then it is assumed to be in
4098 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4099 # by changing the callers and the interface at the same time.
4100 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4101 # gdb.base/ena-dis-br.exp.
4103 # Use this function to keep your test scripts independent of the
4104 # exact line numbering of the source file. Don't write:
4106 # send_gdb "break 20"
4108 # This means that if anyone ever edits your test's source file,
4109 # your test could break. Instead, put a comment like this on the
4110 # source file line you want to break at:
4112 # /* breakpoint spot: frotz.exp: test name */
4114 # and then write, in your test script (which we assume is named
4117 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4119 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4122 # % puts "foo [lindex "bar baz" 1]"
4125 # Tcl is quite clever, for a little stringy language.)
4129 # The previous implementation of this procedure used the gdb search command.
4130 # This version is different:
4132 # . It works with MI, and it also works when gdb is not running.
4134 # . It operates on the build machine, not the host machine.
4136 # . For now, this implementation fakes a current directory of
4137 # $srcdir/$subdir to be compatible with the old implementation.
4138 # This will go away eventually and some callers will need to
4141 # . The TEXT argument is literal text and matches literally,
4142 # not a regular expression as it was before.
4144 # . State changes in gdb, such as changing the current file
4145 # and setting $_, no longer happen.
4147 # After a bit of time we can forget about the differences from the
4148 # old implementation.
4150 # --chastain 2004-08-05
4152 proc gdb_get_line_number { text { file "" } } {
4157 if { "$file" == "" } then {
4160 if { ! [regexp "^/" "$file"] } then {
4161 set file "$srcdir/$subdir/$file"
4164 if { [ catch { set fd [open "$file"] } message ] } then {
4169 for { set line 1 } { 1 } { incr line } {
4170 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4173 if { $nchar < 0 } then {
4176 if { [string first "$text" "$body"] >= 0 } then {
4182 if { [ catch { close "$fd" } message ] } then {
4187 error "undefined tag \"$text\""
4193 # Continue the program until it ends.
4195 # MSSG is the error message that gets printed. If not given, a
4197 # COMMAND is the command to invoke. If not given, "continue" is
4199 # ALLOW_EXTRA is a flag indicating whether the test should expect
4200 # extra output between the "Continuing." line and the program
4201 # exiting. By default it is zero; if nonzero, any extra output
4204 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4205 global inferior_exited_re use_gdb_stub
4208 set text "continue until exit"
4210 set text "continue until exit at $mssg"
4218 # By default, we don't rely on exit() behavior of remote stubs --
4219 # it's common for exit() to be implemented as a simple infinite
4220 # loop, or a forced crash/reset. For native targets, by default, we
4221 # assume process exit is reported as such. If a non-reliable target
4222 # is used, we set a breakpoint at exit, and continue to that.
4223 if { [target_info exists exit_is_reliable] } {
4224 set exit_is_reliable [target_info exit_is_reliable]
4226 set exit_is_reliable [expr ! $use_gdb_stub]
4229 if { ! $exit_is_reliable } {
4230 if {![gdb_breakpoint "exit"]} {
4233 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4236 # Continue until we exit. Should not stop again.
4237 # Don't bother to check the output of the program, that may be
4238 # extremely tough for some remote systems.
4240 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4245 proc rerun_to_main {} {
4246 global gdb_prompt use_gdb_stub
4251 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4252 {pass "rerun to main" ; return 0}
4253 -re "$gdb_prompt $"\
4254 {fail "rerun to main" ; return 0}
4255 timeout {fail "(timeout) rerun to main" ; return 0}
4260 -re "The program .* has been started already.*y or n. $" {
4264 -re "Starting program.*$gdb_prompt $"\
4265 {pass "rerun to main" ; return 0}
4266 -re "$gdb_prompt $"\
4267 {fail "rerun to main" ; return 0}
4268 timeout {fail "(timeout) rerun to main" ; return 0}
4273 # Print a message and return true if a test should be skipped
4274 # due to lack of floating point suport.
4276 proc gdb_skip_float_test { msg } {
4277 if [target_info exists gdb,skip_float_tests] {
4278 verbose "Skipping test '$msg': no float tests."
4284 # Print a message and return true if a test should be skipped
4285 # due to lack of stdio support.
4287 proc gdb_skip_stdio_test { msg } {
4288 if [target_info exists gdb,noinferiorio] {
4289 verbose "Skipping test '$msg': no inferior i/o."
4295 proc gdb_skip_bogus_test { msg } {
4299 # Return true if a test should be skipped due to lack of XML support
4301 # NOTE: This must be called while gdb is *not* running.
4303 gdb_caching_proc gdb_skip_xml_test {
4307 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
4311 gdb_test_multiple "set tdesc filename $xml_file" "" {
4312 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
4315 -re ".*$gdb_prompt $" { }
4321 # Return true if argv[0] is available.
4323 gdb_caching_proc gdb_has_argv0 {
4326 # Set up, compile, and execute a test program to check whether
4327 # argv[0] is available.
4328 set src [standard_temp_file has_argv0[pid].c]
4329 set exe [standard_temp_file has_argv0[pid].x]
4331 gdb_produce_source $src {
4332 int main (int argc, char **argv) {
4337 gdb_compile $src $exe executable {debug}
4340 proc gdb_has_argv0_1 { exe } {
4341 global srcdir subdir
4342 global gdb_prompt hex
4346 gdb_reinitialize_dir $srcdir/$subdir
4349 # Set breakpoint on main.
4350 gdb_test_multiple "break main" "break main" {
4351 -re "Breakpoint.*${gdb_prompt} $" {
4353 -re "${gdb_prompt} $" {
4360 gdb_test_multiple "" "run to main" {
4361 -re "Breakpoint.*${gdb_prompt} $" {
4363 -re "${gdb_prompt} $" {
4368 # Check whether argc is 1.
4369 gdb_test_multiple "p argc" "p argc" {
4370 -re " = 1\r\n${gdb_prompt} $" {
4372 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
4373 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
4376 -re "${gdb_prompt} $" {
4381 -re "${gdb_prompt} $" {
4388 set result [gdb_has_argv0_1 $exe]
4395 && ([istarget *-*-linux*]
4396 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
4397 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
4398 || [istarget *-*-openbsd*]
4399 || [istarget *-*-darwin*]
4400 || [istarget *-*-solaris*]
4401 || [istarget *-*-aix*]
4402 || [istarget *-*-gnu*]
4403 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
4404 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
4405 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
4406 || [istarget *-*-symbianelf*]
4407 || [istarget *-*-osf*]
4408 || [istarget *-*-hpux*]
4409 || [istarget *-*-dicos*]
4410 || [istarget *-*-nto*]
4411 || [istarget *-*-*vms*]
4412 || [istarget *-*-lynx*178]) } {
4413 fail "argv\[0\] should be available on this target"
4419 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
4420 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4421 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
4422 # the name of a debuginfo only file. This file will be stored in the same
4425 # Functions for separate debug info testing
4427 # starting with an executable:
4428 # foo --> original executable
4430 # at the end of the process we have:
4431 # foo.stripped --> foo w/o debug info
4432 # foo.debug --> foo's debug info
4433 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4435 # Fetch the build id from the file.
4436 # Returns "" if there is none.
4438 proc get_build_id { filename } {
4439 set tmp [standard_output_file "${filename}-tmp"]
4440 set objcopy_program [gdb_find_objcopy]
4442 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
4443 verbose "result is $result"
4444 verbose "output is $output"
4449 fconfigure $fi -translation binary
4450 # Skip the NOTE header.
4455 if ![string compare $data ""] then {
4458 # Convert it to hex.
4459 binary scan $data H* data
4463 # Return the build-id hex string (usually 160 bits as 40 hex characters)
4464 # converted to the form: .build-id/ab/cdef1234...89.debug
4465 # Return "" if no build-id found.
4466 proc build_id_debug_filename_get { filename } {
4467 set data [get_build_id $filename]
4468 if { $data == "" } {
4471 regsub {^..} $data {\0/} data
4472 return ".build-id/${data}.debug"
4475 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
4476 # list of optional flags. The only currently supported flag is no-main,
4477 # which removes the symbol entry for main from the separate debug file.
4479 # Function returns zero on success. Function will return non-zero failure code
4480 # on some targets not supporting separate debug info (such as i386-msdos).
4482 proc gdb_gnu_strip_debug { dest args } {
4484 # Use the first separate debug info file location searched by GDB so the
4485 # run cannot be broken by some stale file searched with higher precedence.
4486 set debug_file "${dest}.debug"
4488 set strip_to_file_program [transform strip]
4489 set objcopy_program [gdb_find_objcopy]
4491 set debug_link [file tail $debug_file]
4492 set stripped_file "${dest}.stripped"
4494 # Get rid of the debug info, and store result in stripped_file
4495 # something like gdb/testsuite/gdb.base/blah.stripped.
4496 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
4497 verbose "result is $result"
4498 verbose "output is $output"
4503 # Workaround PR binutils/10802:
4504 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4505 set perm [file attributes ${dest} -permissions]
4506 file attributes ${stripped_file} -permissions $perm
4508 # Get rid of everything but the debug info, and store result in debug_file
4509 # This will be in the .debug subdirectory, see above.
4510 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
4511 verbose "result is $result"
4512 verbose "output is $output"
4517 # If no-main is passed, strip the symbol for main from the separate
4518 # file. This is to simulate the behavior of elfutils's eu-strip, which
4519 # leaves the symtab in the original file only. There's no way to get
4520 # objcopy or strip to remove the symbol table without also removing the
4521 # debugging sections, so this is as close as we can get.
4522 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
4523 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
4524 verbose "result is $result"
4525 verbose "output is $output"
4529 file delete "${debug_file}"
4530 file rename "${debug_file}-tmp" "${debug_file}"
4533 # Link the two previous output files together, adding the .gnu_debuglink
4534 # section to the stripped_file, containing a pointer to the debug_file,
4535 # save the new file in dest.
4536 # This will be the regular executable filename, in the usual location.
4537 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
4538 verbose "result is $result"
4539 verbose "output is $output"
4544 # Workaround PR binutils/10802:
4545 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4546 set perm [file attributes ${stripped_file} -permissions]
4547 file attributes ${dest} -permissions $perm
4552 # Test the output of GDB_COMMAND matches the pattern obtained
4553 # by concatenating all elements of EXPECTED_LINES. This makes
4554 # it possible to split otherwise very long string into pieces.
4555 # If third argument is not empty, it's used as the name of the
4556 # test to be printed on pass/fail.
4557 proc help_test_raw { gdb_command expected_lines args } {
4558 set message $gdb_command
4559 if [llength $args]>0 then {
4560 set message [lindex $args 0]
4562 set expected_output [join $expected_lines ""]
4563 gdb_test "${gdb_command}" "${expected_output}" $message
4566 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
4567 # are regular expressions that should match the beginning of output,
4568 # before the list of commands in that class. The presence of
4569 # command list and standard epilogue will be tested automatically.
4570 proc test_class_help { command_class expected_initial_lines args } {
4572 "List of commands\:.*\[\r\n\]+"
4573 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
4574 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
4575 "Command name abbreviations are allowed if unambiguous\."
4577 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4579 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
4582 # COMMAND_LIST should have either one element -- command to test, or
4583 # two elements -- abbreviated command to test, and full command the first
4584 # element is abbreviation of.
4585 # The command must be a prefix command. EXPECTED_INITIAL_LINES
4586 # are regular expressions that should match the beginning of output,
4587 # before the list of subcommands. The presence of
4588 # subcommand list and standard epilogue will be tested automatically.
4589 proc test_prefix_command_help { command_list expected_initial_lines args } {
4590 set command [lindex $command_list 0]
4591 if {[llength $command_list]>1} {
4592 set full_command [lindex $command_list 1]
4594 set full_command $command
4596 # Use 'list' and not just {} because we want variables to
4597 # be expanded in this list.
4598 set l_stock_body [list\
4599 "List of $full_command subcommands\:.*\[\r\n\]+"\
4600 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
4601 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
4602 "Command name abbreviations are allowed if unambiguous\."]
4603 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4604 if {[llength $args]>0} {
4605 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
4607 help_test_raw "help ${command}" $l_entire_body
4611 # Build executable named EXECUTABLE from specifications that allow
4612 # different options to be passed to different sub-compilations.
4613 # TESTNAME is the name of the test; this is passed to 'untested' if
4615 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
4616 # contains the option "pthreads", then gdb_compile_pthreads is used.
4617 # ARGS is a flat list of source specifications, of the form:
4618 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
4619 # Each SOURCE is compiled to an object file using its OPTIONS,
4620 # using gdb_compile.
4621 # Returns 0 on success, -1 on failure.
4622 proc build_executable_from_specs {testname executable options args} {
4626 set binfile [standard_output_file $executable]
4629 if { [lsearch -exact $options "c++"] >= 0 } {
4630 set info_options "c++"
4632 if [get_compiler_info ${info_options}] {
4636 set func gdb_compile
4637 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
4638 if {$func_index != -1} {
4639 set func "${func}_[lindex $options $func_index]"
4642 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
4643 # parameter. They also requires $sources while gdb_compile and
4644 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
4645 if [string match gdb_compile_shlib* $func] {
4647 foreach {s local_options} $args {
4648 if { [regexp "^/" "$s"] } then {
4649 lappend sources_path "$s"
4651 lappend sources_path "$srcdir/$subdir/$s"
4654 set ret [$func $sources_path "${binfile}" $options]
4658 foreach {s local_options} $args {
4659 if { ! [regexp "^/" "$s"] } then {
4660 set s "$srcdir/$subdir/$s"
4662 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
4666 lappend objects "${binfile}${i}.o"
4669 set ret [$func $objects "${binfile}" executable $options]
4679 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4680 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4681 # to pass to untested, if something is wrong. OPTIONS are passed
4682 # to gdb_compile directly.
4683 proc build_executable { testname executable {sources ""} {options {debug}} } {
4684 if {[llength $sources]==0} {
4685 set sources ${executable}.c
4688 set arglist [list $testname $executable $options]
4689 foreach source $sources {
4690 lappend arglist $source $options
4693 return [eval build_executable_from_specs $arglist]
4696 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
4697 # the basename of the binary.
4698 proc clean_restart { executable } {
4701 set binfile [standard_output_file ${executable}]
4705 gdb_reinitialize_dir $srcdir/$subdir
4709 # Prepares for testing by calling build_executable_full, then
4711 # TESTNAME is the name of the test.
4712 # Each element in ARGS is a list of the form
4713 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
4714 # These are passed to build_executable_from_specs, which see.
4715 # The last EXECUTABLE is passed to clean_restart.
4716 # Returns 0 on success, non-zero on failure.
4717 proc prepare_for_testing_full {testname args} {
4718 foreach spec $args {
4719 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4722 set executable [lindex $spec 0]
4724 clean_restart $executable
4728 # Prepares for testing, by calling build_executable, and then clean_restart.
4729 # Please refer to build_executable for parameter description.
4730 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4732 if {[build_executable $testname $executable $sources $options] == -1} {
4735 clean_restart $executable
4740 proc get_valueof { fmt exp default } {
4743 set test "get valueof \"${exp}\""
4745 gdb_test_multiple "print${fmt} ${exp}" "$test" {
4746 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4747 set val $expect_out(1,string)
4751 fail "$test (timeout)"
4757 proc get_integer_valueof { exp default } {
4760 set test "get integer valueof \"${exp}\""
4762 gdb_test_multiple "print /d ${exp}" "$test" {
4763 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4764 set val $expect_out(1,string)
4768 fail "$test (timeout)"
4774 proc get_hexadecimal_valueof { exp default } {
4776 send_gdb "print /x ${exp}\n"
4777 set test "get hexadecimal valueof \"${exp}\""
4779 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4780 set val $expect_out(1,string)
4785 fail "$test (timeout)"
4791 proc get_sizeof { type default } {
4792 return [get_integer_valueof "sizeof (${type})" $default]
4795 proc get_target_charset { } {
4798 gdb_test_multiple "show target-charset" "" {
4799 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
4800 return $expect_out(1,string)
4802 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
4803 return $expect_out(1,string)
4807 # Pick a reasonable default.
4808 warning "Unable to read target-charset."
4812 # Get the current value for remotetimeout and return it.
4813 proc get_remotetimeout { } {
4817 gdb_test_multiple "show remotetimeout" "" {
4818 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
4819 return $expect_out(1,string)
4823 # Pick the default that gdb uses
4824 warning "Unable to read remotetimeout"
4828 # Set the remotetimeout to the specified timeout. Nothing is returned.
4829 proc set_remotetimeout { timeout } {
4832 gdb_test_multiple "set remotetimeout $timeout" "" {
4833 -re "$gdb_prompt $" {
4834 verbose "Set remotetimeout to $timeout\n"
4839 # ROOT and FULL are file names. Returns the relative path from ROOT
4840 # to FULL. Note that FULL must be in a subdirectory of ROOT.
4841 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
4844 proc relative_filename {root full} {
4845 set root_split [file split $root]
4846 set full_split [file split $full]
4848 set len [llength $root_split]
4850 if {[eval file join $root_split]
4851 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
4852 error "$full not a subdir of $root"
4855 return [eval file join [lrange $full_split $len end]]
4858 # Log gdb command line and script if requested.
4859 if {[info exists TRANSCRIPT]} {
4860 rename send_gdb real_send_gdb
4861 rename remote_spawn real_remote_spawn
4862 rename remote_close real_remote_close
4864 global gdb_transcript
4865 set gdb_transcript ""
4867 global gdb_trans_count
4868 set gdb_trans_count 1
4870 proc remote_spawn {args} {
4871 global gdb_transcript gdb_trans_count outdir
4873 if {$gdb_transcript != ""} {
4874 close $gdb_transcript
4876 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
4877 puts $gdb_transcript [lindex $args 1]
4878 incr gdb_trans_count
4880 return [uplevel real_remote_spawn $args]
4883 proc remote_close {args} {
4884 global gdb_transcript
4886 if {$gdb_transcript != ""} {
4887 close $gdb_transcript
4888 set gdb_transcript ""
4891 return [uplevel real_remote_close $args]
4894 proc send_gdb {args} {
4895 global gdb_transcript
4897 if {$gdb_transcript != ""} {
4898 puts -nonewline $gdb_transcript [lindex $args 0]
4901 return [uplevel real_send_gdb $args]
4905 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
4906 if {[info exists GDB_PARALLEL]} {
4907 if {[is_remote host]} {
4910 file mkdir outputs temp cache
4914 proc core_find {binfile {deletefiles {}} {arg ""}} {
4915 global objdir subdir
4917 set destcore "$binfile.core"
4918 file delete $destcore
4920 # Create a core file named "$destcore" rather than just "core", to
4921 # avoid problems with sys admin types that like to regularly prune all
4922 # files named "core" from the system.
4924 # Arbitrarily try setting the core size limit to "unlimited" since
4925 # this does not hurt on systems where the command does not work and
4926 # allows us to generate a core on systems where it does.
4928 # Some systems append "core" to the name of the program; others append
4929 # the name of the program to "core"; still others (like Linux, as of
4930 # May 2003) create cores named "core.PID". In the latter case, we
4931 # could have many core files lying around, and it may be difficult to
4932 # tell which one is ours, so let's run the program in a subdirectory.
4934 set coredir [standard_output_file coredir.[getpid]]
4936 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
4937 # remote_exec host "${binfile}"
4938 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
4939 if [remote_file build exists $i] {
4940 remote_exec build "mv $i $destcore"
4944 # Check for "core.PID".
4945 if { $found == 0 } {
4946 set names [glob -nocomplain -directory $coredir core.*]
4947 if {[llength $names] == 1} {
4948 set corefile [file join $coredir [lindex $names 0]]
4949 remote_exec build "mv $corefile $destcore"
4953 if { $found == 0 } {
4954 # The braindamaged HPUX shell quits after the ulimit -c above
4955 # without executing ${binfile}. So we try again without the
4956 # ulimit here if we didn't find a core file above.
4957 # Oh, I should mention that any "braindamaged" non-Unix system has
4958 # the same problem. I like the cd bit too, it's really neat'n stuff.
4959 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
4960 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
4961 if [remote_file build exists $i] {
4962 remote_exec build "mv $i $destcore"
4968 # Try to clean up after ourselves.
4969 foreach deletefile $deletefiles {
4970 remote_file build delete [file join $coredir $deletefile]
4972 remote_exec build "rmdir $coredir"
4974 if { $found == 0 } {
4975 warning "can't generate a core file - core tests suppressed - check ulimit -c"
4981 # gdb_target_symbol_prefix_flags returns a string that can be added
4982 # to gdb_compile options to define SYMBOL_PREFIX macro value
4983 # symbol_prefix_flags returns a string that can be added
4984 # for targets that use underscore as symbol prefix.
4985 # TODO: find out automatically if the target needs this.
4987 proc gdb_target_symbol_prefix_flags {} {
4988 if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"]
4989 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
4990 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
4996 # A wrapper for 'remote_exec host' that passes or fails a test.
4997 # Returns 0 if all went well, nonzero on failure.
4998 # TEST is the name of the test, other arguments are as for remote_exec.
5000 proc run_on_host { test program args } {
5001 verbose -log "run_on_host: $program $args"
5002 # remote_exec doesn't work properly if the output is set but the
5003 # input is the empty string -- so replace an empty input with
5005 if {[llength $args] > 1 && [lindex $args 1] == ""} {
5006 set args [lreplace $args 1 1 "/dev/null"]
5008 set result [eval remote_exec host [list $program] $args]
5009 verbose "result is $result"
5010 set status [lindex $result 0]
5011 set output [lindex $result 1]
5016 verbose -log "run_on_host failed: $output"
5022 # Return non-zero if "board_info debug_flags" mentions Fission.
5023 # http://gcc.gnu.org/wiki/DebugFission
5024 # Fission doesn't support everything yet.
5025 # This supports working around bug 15954.
5027 proc using_fission { } {
5028 set debug_flags [board_info [target_info name] debug_flags]
5029 return [regexp -- "-gsplit-dwarf" $debug_flags]
5032 # Search the caller's ARGS list and set variables according to the list of
5033 # valid options described by ARGSET.
5035 # The first member of each one- or two-element list in ARGSET defines the
5036 # name of a variable that will be added to the caller's scope.
5038 # If only one element is given to describe an option, it the value is
5039 # 0 if the option is not present in (the caller's) ARGS or 1 if
5042 # If two elements are given, the second element is the default value of
5043 # the variable. This is then overwritten if the option exists in ARGS.
5045 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
5046 # any optional components.
5049 # proc myproc {foo args} {
5050 # parse_args {{bar} {baz "abc"} {qux}}
5053 # myproc ABC -bar -baz DEF peanut butter
5054 # will define the following variables in myproc:
5055 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
5056 # args will be the list {peanut butter}
5058 proc parse_args { argset } {
5061 foreach argument $argset {
5062 if {[llength $argument] == 1} {
5063 # No default specified, so we assume that we should set
5064 # the value to 1 if the arg is present and 0 if it's not.
5065 # It is assumed that no value is given with the argument.
5066 set result [lsearch -exact $args "-$argument"]
5067 if {$result != -1} then {
5068 uplevel 1 [list set $argument 1]
5069 set args [lreplace $args $result $result]
5071 uplevel 1 [list set $argument 0]
5073 } elseif {[llength $argument] == 2} {
5074 # There are two items in the argument. The second is a
5075 # default value to use if the item is not present.
5076 # Otherwise, the variable is set to whatever is provided
5077 # after the item in the args.
5078 set arg [lindex $argument 0]
5079 set result [lsearch -exact $args "-[lindex $arg 0]"]
5080 if {$result != -1} then {
5081 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
5082 set args [lreplace $args $result [expr $result+1]]
5084 uplevel 1 [list set $arg [lindex $argument 1]]
5087 error "Badly formatted argument \"$argument\" in argument set"
5091 # The remaining args should be checked to see that they match the
5092 # number of items expected to be passed into the procedure...
5095 # Capture the output of COMMAND in a string ignoring PREFIX; return that string.
5096 proc capture_command_output { command prefix } {
5100 set output_string ""
5101 gdb_test_multiple "$command" "capture_command_output for $command" {
5102 -re "${command}\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
5103 set output_string $expect_out(1,string)
5106 return $output_string
5109 # Always load compatibility stuff.