1 # Copyright 1992-2013 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"
32 if [info exists TOOL_EXECUTABLE] {
33 set GDB $TOOL_EXECUTABLE;
35 if ![info exists GDB] {
36 if ![is_remote host] {
37 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
39 set GDB [transform gdb];
42 verbose "using GDB = $GDB" 2
44 # GDBFLAGS is available for the user to set on the command line.
45 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
46 # Testcases may use it to add additional flags, but they must:
47 # - append new flags, not overwrite
48 # - restore the original value when done
50 if ![info exists GDBFLAGS] {
53 verbose "using GDBFLAGS = $GDBFLAGS" 2
55 # Make the build data directory available to tests.
56 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
58 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
59 global INTERNAL_GDBFLAGS
60 if ![info exists INTERNAL_GDBFLAGS] {
61 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
64 # The variable gdb_prompt is a regexp which matches the gdb prompt.
65 # Set it if it is not already set.
67 if ![info exists gdb_prompt] then {
68 set gdb_prompt "\[(\]gdb\[)\]"
71 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
72 # absolute path ie. /foo/
73 set fullname_syntax_POSIX {/[^\n]*/}
74 # The variable fullname_syntax_UNC is a regexp which matches a Windows
75 # UNC path ie. \\D\foo\
76 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
77 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
78 # particular DOS case that GDB most likely will output
79 # ie. \foo\, but don't match \\.*\
80 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
81 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
82 # ie. a:\foo\ && a:foo\
83 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
84 # The variable fullname_syntax is a regexp which matches what GDB considers
85 # an absolute path. It is currently debatable if the Windows style paths
86 # d:foo and \abc should be considered valid as an absolute path.
87 # Also, the purpse of this regexp is not to recognize a well formed
88 # absolute path, but to say with certainty that a path is absolute.
89 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
91 # Needed for some tests under Cygwin.
95 if ![info exists env(EXEEXT)] {
98 set EXEEXT $env(EXEEXT)
103 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
105 ### Only procedures should come after this point.
108 # gdb_version -- extract and print the version number of GDB
110 proc default_gdb_version {} {
112 global INTERNAL_GDBFLAGS GDBFLAGS
114 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
115 set tmp [lindex $output 1];
117 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
118 if ![is_remote host] {
119 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
121 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
125 proc gdb_version { } {
126 return [default_gdb_version]
130 # gdb_unload -- unload a file if one is loaded
131 # Return 0 on success, -1 on error.
140 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
141 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
142 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
146 -re "Discard symbol table from .*y or n.*$" {
150 -re "$gdb_prompt $" {}
152 perror "couldn't unload file in $GDB (timeout)."
159 # Many of the tests depend on setting breakpoints at various places and
160 # running until that breakpoint is reached. At times, we want to start
161 # with a clean-slate with respect to breakpoints, so this utility proc
162 # lets us do this without duplicating this code everywhere.
165 proc delete_breakpoints {} {
168 # we need a larger timeout value here or this thing just confuses
169 # itself. May need a better implementation if possible. - guo
171 send_gdb "delete breakpoints\n"
173 -re "Delete all breakpoints.*y or n.*$" {
177 -re "$gdb_prompt $" { # This happens if there were no breakpoints
179 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
181 send_gdb "info breakpoints\n"
183 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
184 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
185 -re "Delete all breakpoints.*or n.*$" {
189 timeout { perror "info breakpoints (timeout)" ; return }
193 # Generic run command.
195 # The second pattern below matches up to the first newline *only*.
196 # Using ``.*$'' could swallow up output that we attempt to match
199 # N.B. This function does not wait for gdb to return to the prompt,
200 # that is the caller's responsibility.
202 proc gdb_run_cmd {args} {
203 global gdb_prompt use_gdb_stub
205 if [target_info exists gdb_init_command] {
206 send_gdb "[target_info gdb_init_command]\n";
208 -re "$gdb_prompt $" { }
210 perror "gdb_init_command for target failed";
217 if [target_info exists gdb,do_reload_on_run] {
218 if { [gdb_reload] != 0 } {
221 send_gdb "continue\n";
223 -re "Continu\[^\r\n\]*\[\r\n\]" {}
229 if [target_info exists gdb,start_symbol] {
230 set start [target_info gdb,start_symbol];
234 send_gdb "jump *$start\n"
236 while { $start_attempt } {
237 # Cap (re)start attempts at three to ensure that this loop
238 # always eventually fails. Don't worry about trying to be
239 # clever and not send a command when it has failed.
240 if [expr $start_attempt > 3] {
241 perror "Jump to start() failed (retry count exceeded)";
244 set start_attempt [expr $start_attempt + 1];
246 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
249 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
250 perror "Can't find start symbol to run in gdb_run";
253 -re "No symbol \"start\" in current.*$gdb_prompt $" {
254 send_gdb "jump *_start\n";
256 -re "No symbol.*context.*$gdb_prompt $" {
259 -re "Line.* Jump anyway.*y or n. $" {
262 -re "The program is not being run.*$gdb_prompt $" {
263 if { [gdb_reload] != 0 } {
266 send_gdb "jump *$start\n";
269 perror "Jump to start() failed (timeout)";
277 if [target_info exists gdb,do_reload_on_run] {
278 if { [gdb_reload] != 0 } {
282 send_gdb "run $args\n"
283 # This doesn't work quite right yet.
284 # Use -notransfer here so that test cases (like chng-sym.exp)
285 # may test for additional start-up messages.
287 -re "The program .* has been started already.*y or n. $" {
291 -notransfer -re "Starting program: \[^\r\n\]*" {}
292 -notransfer -re "$gdb_prompt $" {
293 # There is no more input expected.
298 # Generic start command. Return 0 if we could start the program, -1
301 # N.B. This function does not wait for gdb to return to the prompt,
302 # that is the caller's responsibility.
304 proc gdb_start_cmd {args} {
305 global gdb_prompt use_gdb_stub
307 if [target_info exists gdb_init_command] {
308 send_gdb "[target_info gdb_init_command]\n";
310 -re "$gdb_prompt $" { }
312 perror "gdb_init_command for target failed";
322 send_gdb "start $args\n"
323 # Use -notransfer here so that test cases (like chng-sym.exp)
324 # may test for additional start-up messages.
326 -re "The program .* has been started already.*y or n. $" {
330 -notransfer -re "Starting program: \[^\r\n\]*" {
337 # Set a breakpoint at FUNCTION. If there is an additional argument it is
338 # a list of options; the supported options are allow-pending, temporary,
339 # message, no-message, and passfail.
340 # The result is 1 for success, 0 for failure.
342 # Note: The handling of message vs no-message is messed up, but it's based
343 # on historical usage. By default this function does not print passes,
345 # no-message: turns off printing of fails (and passes, but they're already off)
346 # message: turns on printing of passes (and fails, but they're already on)
348 proc gdb_breakpoint { function args } {
352 set pending_response n
353 if {[lsearch -exact $args allow-pending] != -1} {
354 set pending_response y
357 set break_command "break"
358 set break_message "Breakpoint"
359 if {[lsearch -exact $args temporary] != -1} {
360 set break_command "tbreak"
361 set break_message "Temporary breakpoint"
366 set no_message_loc [lsearch -exact $args no-message]
367 set message_loc [lsearch -exact $args message]
368 # The last one to appear in args wins.
369 if { $no_message_loc > $message_loc } {
371 } elseif { $message_loc > $no_message_loc } {
375 set test_name "setting breakpoint at $function"
377 send_gdb "$break_command $function\n"
378 # The first two regexps are what we get with -g, the third is without -g.
380 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
381 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
382 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
383 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
384 if {$pending_response == "n"} {
391 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
392 send_gdb "$pending_response\n"
395 -re "A problem internal to GDB has been detected" {
397 fail "$test_name (GDB internal error)"
399 gdb_internal_error_resync
402 -re "$gdb_prompt $" {
410 fail "$test_name (eof)"
416 fail "$test_name (timeout)"
427 # Set breakpoint at function and run gdb until it breaks there.
428 # Since this is the only breakpoint that will be set, if it stops
429 # at a breakpoint, we will assume it is the one we want. We can't
430 # just compare to "function" because it might be a fully qualified,
431 # single quoted C++ function specifier.
433 # If there are additional arguments, pass them to gdb_breakpoint.
434 # We recognize no-message/message ourselves.
435 # The default is no-message.
436 # no-message is messed up here, like gdb_breakpoint: to preserve
437 # historical usage fails are always printed by default.
438 # no-message: turns off printing of fails (and passes, but they're already off)
439 # message: turns on printing of passes (and fails, but they're already on)
441 proc runto { function args } {
447 # Default to "no-message".
448 set args "no-message $args"
452 set no_message_loc [lsearch -exact $args no-message]
453 set message_loc [lsearch -exact $args message]
454 # The last one to appear in args wins.
455 if { $no_message_loc > $message_loc } {
457 } elseif { $message_loc > $no_message_loc } {
461 set test_name "running to $function in runto"
463 # We need to use eval here to pass our varargs args to gdb_breakpoint
464 # which is also a varargs function.
465 # But we also have to be careful because $function may have multiple
466 # elements, and we don't want Tcl to move the remaining elements after
467 # the first to $args. That is why $function is wrapped in {}.
468 if ![eval gdb_breakpoint {$function} $args] {
474 # the "at foo.c:36" output we get with -g.
475 # the "in func" output we get without -g.
477 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
483 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
489 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
491 unsupported "Non-stop mode not supported"
495 -re ".*A problem internal to GDB has been detected" {
497 fail "$test_name (GDB internal error)"
499 gdb_internal_error_resync
502 -re "$gdb_prompt $" {
510 fail "$test_name (eof)"
516 fail "$test_name (timeout)"
527 # Ask gdb to run until we hit a breakpoint at main.
529 # N.B. This function deletes all existing breakpoints.
530 # If you don't want that, use gdb_start_cmd.
532 proc runto_main { } {
533 return [runto main no-message]
536 ### Continue, and expect to hit a breakpoint.
537 ### Report a pass or fail, depending on whether it seems to have
538 ### worked. Use NAME as part of the test name; each call to
539 ### continue_to_breakpoint should use a NAME which is unique within
541 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
543 set full_name "continue to breakpoint: $name"
545 send_gdb "continue\n"
547 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
550 -re ".*$gdb_prompt $" {
554 fail "$full_name (timeout)"
560 # gdb_internal_error_resync:
562 # Answer the questions GDB asks after it reports an internal error
563 # until we get back to a GDB prompt. Decline to quit the debugging
564 # session, and decline to create a core file. Return non-zero if the
567 # This procedure just answers whatever questions come up until it sees
568 # a GDB prompt; it doesn't require you to have matched the input up to
569 # any specific point. However, it only answers questions it sees in
570 # the output itself, so if you've matched a question, you had better
571 # answer it yourself before calling this.
573 # You can use this function thus:
577 # -re ".*A problem internal to GDB has been detected" {
578 # gdb_internal_error_resync
583 proc gdb_internal_error_resync {} {
586 verbose -log "Resyncing due to internal error."
589 while {$count < 10} {
591 -re "Quit this debugging session\\? \\(y or n\\) $" {
595 -re "Create a core file of GDB\\? \\(y or n\\) $" {
599 -re "$gdb_prompt $" {
600 # We're resynchronized.
604 perror "Could not resync from internal error (timeout)"
609 perror "Could not resync from internal error (resync count exceeded)"
614 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
615 # Send a command to gdb; test the result.
617 # COMMAND is the command to execute, send to GDB with send_gdb. If
618 # this is the null string no command is sent.
619 # MESSAGE is a message to be printed with the built-in failure patterns
620 # if one of them matches. If MESSAGE is empty COMMAND will be used.
621 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
622 # patterns. Pattern elements will be evaluated in the caller's
623 # context; action elements will be executed in the caller's context.
624 # Unlike patterns for gdb_test, these patterns should generally include
625 # the final newline and prompt.
628 # 1 if the test failed, according to a built-in failure pattern
629 # 0 if only user-supplied patterns matched
630 # -1 if there was an internal error.
632 # You can use this function thus:
634 # gdb_test_multiple "print foo" "test foo" {
635 # -re "expected output 1" {
638 # -re "expected output 2" {
643 # The standard patterns, such as "Inferior exited..." and "A problem
644 # ...", all being implicitly appended to that list.
646 proc gdb_test_multiple { command message user_code } {
647 global verbose use_gdb_stub
650 global inferior_exited_re
651 upvar timeout timeout
652 upvar expect_out expect_out
654 if { $message == "" } {
658 if [string match "*\[\r\n\]" $command] {
659 error "Invalid trailing newline in \"$message\" test"
662 if [string match "*\[\r\n\]*" $message] {
663 error "Invalid newline in \"$message\" test"
667 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
669 error "gdbserver does not support $command without extended-remote"
672 # TCL/EXPECT WART ALERT
673 # Expect does something very strange when it receives a single braced
674 # argument. It splits it along word separators and performs substitutions.
675 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
676 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
677 # double-quoted list item, "\[ab\]" is just a long way of representing
678 # "[ab]", because the backslashes will be removed by lindex.
680 # Unfortunately, there appears to be no easy way to duplicate the splitting
681 # that expect will do from within TCL. And many places make use of the
682 # "\[0-9\]" construct, so we need to support that; and some places make use
683 # of the "[func]" construct, so we need to support that too. In order to
684 # get this right we have to substitute quoted list elements differently
685 # from braced list elements.
687 # We do this roughly the same way that Expect does it. We have to use two
688 # lists, because if we leave unquoted newlines in the argument to uplevel
689 # they'll be treated as command separators, and if we escape newlines
690 # we mangle newlines inside of command blocks. This assumes that the
691 # input doesn't contain a pattern which contains actual embedded newlines
694 regsub -all {\n} ${user_code} { } subst_code
695 set subst_code [uplevel list $subst_code]
697 set processed_code ""
699 set expecting_action 0
701 foreach item $user_code subst_item $subst_code {
702 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
703 lappend processed_code $item
706 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
707 lappend processed_code $item
710 if { $item == "-timeout" } {
712 lappend processed_code $item
715 if { $expecting_arg } {
717 lappend processed_code $item
720 if { $expecting_action } {
721 lappend processed_code "uplevel [list $item]"
722 set expecting_action 0
723 # Cosmetic, no effect on the list.
724 append processed_code "\n"
727 set expecting_action 1
728 lappend processed_code $subst_item
729 if {$patterns != ""} {
732 append patterns "\"$subst_item\""
735 # Also purely cosmetic.
736 regsub -all {\r} $patterns {\\r} patterns
737 regsub -all {\n} $patterns {\\n} patterns
740 send_user "Sending \"$command\" to gdb\n"
741 send_user "Looking to match \"$patterns\"\n"
742 send_user "Message is \"$message\"\n"
746 set string "${command}\n";
747 if { $command != "" } {
748 set multi_line_re "\[\r\n\] *>"
749 while { "$string" != "" } {
750 set foo [string first "\n" "$string"];
751 set len [string length "$string"];
752 if { $foo < [expr $len - 1] } {
753 set str [string range "$string" 0 $foo];
754 if { [send_gdb "$str"] != "" } {
755 global suppress_flag;
757 if { ! $suppress_flag } {
758 perror "Couldn't send $command to GDB.";
763 # since we're checking if each line of the multi-line
764 # command are 'accepted' by GDB here,
765 # we need to set -notransfer expect option so that
766 # command output is not lost for pattern matching
769 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
770 timeout { verbose "partial: timeout" 3 }
772 set string [string range "$string" [expr $foo + 1] end];
773 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
778 if { "$string" != "" } {
779 if { [send_gdb "$string"] != "" } {
780 global suppress_flag;
782 if { ! $suppress_flag } {
783 perror "Couldn't send $command to GDB.";
791 if [target_info exists gdb,timeout] {
792 set tmt [target_info gdb,timeout];
794 if [info exists timeout] {
798 if [info exists timeout] {
807 -re ".*A problem internal to GDB has been detected" {
808 fail "$message (GDB internal error)"
809 gdb_internal_error_resync
811 -re "\\*\\*\\* DOSEXIT code.*" {
812 if { $message != "" } {
815 gdb_suppress_entire_file "GDB died";
819 append code $processed_code
821 -re "Ending remote debugging.*$gdb_prompt $" {
822 if ![isnative] then {
823 warning "Can`t communicate to remote target."
829 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
830 perror "Undefined command \"$command\"."
834 -re "Ambiguous command.*$gdb_prompt $" {
835 perror "\"$command\" is not a unique command name."
839 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
840 if ![string match "" $message] then {
841 set errmsg "$message (the program exited)"
843 set errmsg "$command (the program exited)"
848 -re "$inferior_exited_re normally.*$gdb_prompt $" {
849 if ![string match "" $message] then {
850 set errmsg "$message (the program exited)"
852 set errmsg "$command (the program exited)"
857 -re "The program is not being run.*$gdb_prompt $" {
858 if ![string match "" $message] then {
859 set errmsg "$message (the program is no longer running)"
861 set errmsg "$command (the program is no longer running)"
866 -re "\r\n$gdb_prompt $" {
867 if ![string match "" $message] then {
874 perror "Window too small."
878 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
880 gdb_expect -re "$gdb_prompt $"
881 fail "$message (got interactive prompt)"
884 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
886 gdb_expect -re "$gdb_prompt $"
887 fail "$message (got breakpoint menu)"
891 perror "Process no longer exists"
892 if { $message != "" } {
898 perror "internal buffer is full."
903 if ![string match "" $message] then {
904 fail "$message (timeout)"
911 set code [catch {gdb_expect $tmt $code} string]
913 global errorInfo errorCode;
914 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
915 } elseif {$code > 1} {
916 return -code $code $string
921 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
922 # Send a command to gdb; test the result.
924 # COMMAND is the command to execute, send to GDB with send_gdb. If
925 # this is the null string no command is sent.
926 # PATTERN is the pattern to match for a PASS, and must NOT include
927 # the \r\n sequence immediately before the gdb prompt.
928 # MESSAGE is an optional message to be printed. If this is
929 # omitted, then the pass/fail messages use the command string as the
930 # message. (If this is the empty string, then sometimes we don't
931 # call pass or fail at all; I don't understand this at all.)
932 # QUESTION is a question GDB may ask in response to COMMAND, like
934 # RESPONSE is the response to send if QUESTION appears.
937 # 1 if the test failed,
938 # 0 if the test passes,
939 # -1 if there was an internal error.
941 proc gdb_test { args } {
945 upvar timeout timeout
947 if [llength $args]>2 then {
948 set message [lindex $args 2]
950 set message [lindex $args 0]
952 set command [lindex $args 0]
953 set pattern [lindex $args 1]
955 if [llength $args]==5 {
956 set question_string [lindex $args 3];
957 set response_string [lindex $args 4];
959 set question_string "^FOOBAR$"
962 return [gdb_test_multiple $command $message {
963 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
964 if ![string match "" $message] then {
968 -re "(${question_string})$" {
969 send_gdb "$response_string\n";
975 # gdb_test_no_output COMMAND MESSAGE
976 # Send a command to GDB and verify that this command generated no output.
978 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
979 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
980 # the message. (If MESSAGE is the empty string, then sometimes we do not
981 # call pass or fail at all; I don't understand this at all.)
983 proc gdb_test_no_output { args } {
985 set command [lindex $args 0]
986 if [llength $args]>1 then {
987 set message [lindex $args 1]
992 set command_regex [string_to_regexp $command]
993 gdb_test_multiple $command $message {
994 -re "^$command_regex\r\n$gdb_prompt $" {
995 if ![string match "" $message] then {
1002 # Send a command and then wait for a sequence of outputs.
1003 # This is useful when the sequence is long and contains ".*", a single
1004 # regexp to match the entire output can get a timeout much easier.
1006 # COMMAND is the command to send.
1007 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1008 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1009 # processed in order, and all must be present in the output.
1011 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1012 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1013 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1015 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1016 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1019 # 1 if the test failed,
1020 # 0 if the test passes,
1021 # -1 if there was an internal error.
1023 proc gdb_test_sequence { command test_name expected_output_list } {
1025 if { $test_name == "" } {
1026 set test_name $command
1028 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1029 send_gdb "$command\n"
1030 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1034 # Test that a command gives an error. For pass or fail, return
1035 # a 1 to indicate that more tests can proceed. However a timeout
1036 # is a serious error, generates a special fail message, and causes
1037 # a 0 to be returned to indicate that more tests are likely to fail
1040 proc test_print_reject { args } {
1044 if [llength $args]==2 then {
1045 set expectthis [lindex $args 1]
1047 set expectthis "should never match this bogus string"
1049 set sendthis [lindex $args 0]
1050 if $verbose>2 then {
1051 send_user "Sending \"$sendthis\" to gdb\n"
1052 send_user "Looking to match \"$expectthis\"\n"
1054 send_gdb "$sendthis\n"
1055 #FIXME: Should add timeout as parameter.
1057 -re "A .* in expression.*\\.*$gdb_prompt $" {
1058 pass "reject $sendthis"
1061 -re "Invalid syntax in expression.*$gdb_prompt $" {
1062 pass "reject $sendthis"
1065 -re "Junk after end of expression.*$gdb_prompt $" {
1066 pass "reject $sendthis"
1069 -re "Invalid number.*$gdb_prompt $" {
1070 pass "reject $sendthis"
1073 -re "Invalid character constant.*$gdb_prompt $" {
1074 pass "reject $sendthis"
1077 -re "No symbol table is loaded.*$gdb_prompt $" {
1078 pass "reject $sendthis"
1081 -re "No symbol .* in current context.*$gdb_prompt $" {
1082 pass "reject $sendthis"
1085 -re "Unmatched single quote.*$gdb_prompt $" {
1086 pass "reject $sendthis"
1089 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1090 pass "reject $sendthis"
1093 -re "$expectthis.*$gdb_prompt $" {
1094 pass "reject $sendthis"
1097 -re ".*$gdb_prompt $" {
1098 fail "reject $sendthis"
1102 fail "reject $sendthis (eof or timeout)"
1108 # Given an input string, adds backslashes as needed to create a
1109 # regexp that will match the string.
1111 proc string_to_regexp {str} {
1113 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
1117 # Same as gdb_test, but the second parameter is not a regexp,
1118 # but a string that must match exactly.
1120 proc gdb_test_exact { args } {
1121 upvar timeout timeout
1123 set command [lindex $args 0]
1125 # This applies a special meaning to a null string pattern. Without
1126 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1127 # messages from commands that should have no output except a new
1128 # prompt. With this, only results of a null string will match a null
1131 set pattern [lindex $args 1]
1132 if [string match $pattern ""] {
1133 set pattern [string_to_regexp [lindex $args 0]]
1135 set pattern [string_to_regexp [lindex $args 1]]
1138 # It is most natural to write the pattern argument with only
1139 # embedded \n's, especially if you are trying to avoid Tcl quoting
1140 # problems. But gdb_expect really wants to see \r\n in patterns. So
1141 # transform the pattern here. First transform \r\n back to \n, in
1142 # case some users of gdb_test_exact already do the right thing.
1143 regsub -all "\r\n" $pattern "\n" pattern
1144 regsub -all "\n" $pattern "\r\n" pattern
1145 if [llength $args]==3 then {
1146 set message [lindex $args 2]
1148 set message $command
1151 return [gdb_test $command $pattern $message]
1154 # Wrapper around gdb_test_multiple that looks for a list of expected
1155 # output elements, but which can appear in any order.
1156 # CMD is the gdb command.
1157 # NAME is the name of the test.
1158 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1160 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1161 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1162 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1164 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1165 # of text per element and then strip trailing \r\n's.
1167 # gdb_test_list_exact "foo" "bar" \
1168 # "\[^\r\n\]+\[\r\n\]+" \
1171 # {expected result 1} \
1172 # {expected result 2} \
1175 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1178 set matches [lsort $result_match_list]
1180 gdb_test_multiple $cmd $name {
1181 "$cmd\[\r\n\]" { exp_continue }
1182 -re $elm_find_regexp {
1183 set str $expect_out(0,string)
1184 verbose -log "seen: $str" 3
1185 regexp -- $elm_extract_regexp $str elm_seen
1186 verbose -log "extracted: $elm_seen" 3
1187 lappend seen $elm_seen
1190 -re "$gdb_prompt $" {
1192 foreach got [lsort $seen] have $matches {
1193 if {![string equal $got $have]} {
1198 if {[string length $failed] != 0} {
1199 fail "$name ($failed not found)"
1207 proc gdb_reinitialize_dir { subdir } {
1210 if [is_remote host] {
1215 -re "Reinitialize source path to empty.*y or n. " {
1218 -re "Source directories searched.*$gdb_prompt $" {
1219 send_gdb "dir $subdir\n"
1221 -re "Source directories searched.*$gdb_prompt $" {
1222 verbose "Dir set to $subdir"
1224 -re "$gdb_prompt $" {
1225 perror "Dir \"$subdir\" failed."
1229 -re "$gdb_prompt $" {
1230 perror "Dir \"$subdir\" failed."
1234 -re "$gdb_prompt $" {
1235 perror "Dir \"$subdir\" failed."
1241 # gdb_exit -- exit the GDB, killing the target program if necessary
1243 proc default_gdb_exit {} {
1245 global INTERNAL_GDBFLAGS GDBFLAGS
1247 global gdb_spawn_id;
1249 gdb_stop_suppressing_tests;
1251 if ![info exists gdb_spawn_id] {
1255 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1257 if { [is_remote host] && [board_info host exists fileid] } {
1264 -re "DOSEXIT code" { }
1269 if ![is_remote host] {
1275 # Load a file into the debugger.
1276 # The return value is 0 for success, -1 for failure.
1278 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1279 # to one of these values:
1281 # debug file was loaded successfully and has debug information
1282 # nodebug file was loaded successfully and has no debug information
1283 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1285 # fail file was not loaded
1287 # I tried returning this information as part of the return value,
1288 # but ran into a mess because of the many re-implementations of
1289 # gdb_load in config/*.exp.
1291 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1292 # this if they can get more information set.
1294 proc gdb_file_cmd { arg } {
1298 global last_loaded_file
1300 # Save this for the benefit of gdbserver-support.exp.
1301 set last_loaded_file $arg
1303 # Set whether debug info was found.
1304 # Default to "fail".
1305 global gdb_file_cmd_debug_info
1306 set gdb_file_cmd_debug_info "fail"
1308 if [is_remote host] {
1309 set arg [remote_download host $arg]
1311 perror "download failed"
1316 # The file command used to kill the remote target. For the benefit
1317 # of the testsuite, preserve this behavior.
1320 -re "Kill the program being debugged. .y or n. $" {
1322 verbose "\t\tKilling previous program being debugged"
1325 -re "$gdb_prompt $" {
1330 send_gdb "file $arg\n"
1332 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1333 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1334 set gdb_file_cmd_debug_info "lzma"
1337 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1338 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1339 set gdb_file_cmd_debug_info "nodebug"
1342 -re "Reading symbols from.*done.*$gdb_prompt $" {
1343 verbose "\t\tLoaded $arg into $GDB"
1344 set gdb_file_cmd_debug_info "debug"
1347 -re "Load new symbol table from \".*\".*y or n. $" {
1350 -re "Reading symbols from.*done.*$gdb_prompt $" {
1351 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1352 set gdb_file_cmd_debug_info "debug"
1356 perror "Couldn't load $arg, other program already loaded (timeout)."
1360 perror "Couldn't load $arg, other program already loaded (eof)."
1365 -re "No such file or directory.*$gdb_prompt $" {
1366 perror "($arg) No such file or directory"
1369 -re "A problem internal to GDB has been detected" {
1370 fail "($arg) (GDB internal error)"
1371 gdb_internal_error_resync
1374 -re "$gdb_prompt $" {
1375 perror "Couldn't load $arg into $GDB."
1379 perror "Couldn't load $arg into $GDB (timeout)."
1383 # This is an attempt to detect a core dump, but seems not to
1384 # work. Perhaps we need to match .* followed by eof, in which
1385 # gdb_expect does not seem to have a way to do that.
1386 perror "Couldn't load $arg into $GDB (eof)."
1393 # start gdb -- start gdb running, default procedure
1395 # When running over NFS, particularly if running many simultaneous
1396 # tests on different hosts all using the same server, things can
1397 # get really slow. Give gdb at least 3 minutes to start up.
1399 proc default_gdb_start { } {
1400 global verbose use_gdb_stub
1402 global INTERNAL_GDBFLAGS GDBFLAGS
1405 global gdb_spawn_id;
1407 gdb_stop_suppressing_tests;
1409 # Set the default value, it may be overriden later by specific testfile.
1411 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1412 # is already started after connecting and run/attach are not supported.
1413 # This is used for the "remote" protocol. After GDB starts you should
1414 # check global $use_gdb_stub instead of the board as the testfile may force
1415 # a specific different target protocol itself.
1416 set use_gdb_stub [target_info exists use_gdb_stub]
1418 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1420 if [info exists gdb_spawn_id] {
1424 if ![is_remote host] {
1425 if { [which $GDB] == 0 } then {
1426 perror "$GDB does not exist."
1430 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"];
1431 if { $res < 0 || $res == "" } {
1432 perror "Spawning $GDB failed."
1436 -re "\[\r\n\]$gdb_prompt $" {
1437 verbose "GDB initialized."
1439 -re "$gdb_prompt $" {
1440 perror "GDB never initialized."
1444 perror "(timeout) GDB never initialized after 10 seconds."
1449 set gdb_spawn_id -1;
1450 # force the height to "unlimited", so no pagers get used
1452 send_gdb "set height 0\n"
1454 -re "$gdb_prompt $" {
1455 verbose "Setting height to 0." 2
1458 warning "Couldn't set the height to 0"
1461 # force the width to "unlimited", so no wraparound occurs
1462 send_gdb "set width 0\n"
1464 -re "$gdb_prompt $" {
1465 verbose "Setting width to 0." 2
1468 warning "Couldn't set the width to 0."
1474 # Examine the output of compilation to determine whether compilation
1475 # failed or not. If it failed determine whether it is due to missing
1476 # compiler or due to compiler error. Report pass, fail or unsupported
1479 proc gdb_compile_test {src output} {
1480 if { $output == "" } {
1481 pass "compilation [file tail $src]"
1482 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1483 unsupported "compilation [file tail $src]"
1484 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1485 unsupported "compilation [file tail $src]"
1486 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1487 unsupported "compilation [file tail $src]"
1489 verbose -log "compilation failed: $output" 2
1490 fail "compilation [file tail $src]"
1494 # Return a 1 for configurations for which we don't even want to try to
1497 proc skip_cplus_tests {} {
1498 if { [istarget "h8300-*-*"] } {
1502 # The C++ IO streams are too large for HC11/HC12 and are thus not
1503 # available. The gdb C++ tests use them and don't compile.
1504 if { [istarget "m6811-*-*"] } {
1507 if { [istarget "m6812-*-*"] } {
1513 # Return a 1 for configurations for which don't have both C++ and the STL.
1515 proc skip_stl_tests {} {
1516 # Symbian supports the C++ language, but the STL is missing
1517 # (both headers and libraries).
1518 if { [istarget "arm*-*-symbianelf*"] } {
1522 return [skip_cplus_tests]
1525 # Return a 1 if I don't even want to try to test FORTRAN.
1527 proc skip_fortran_tests {} {
1531 # Return a 1 if I don't even want to try to test ada.
1533 proc skip_ada_tests {} {
1537 # Return a 1 if I don't even want to try to test GO.
1539 proc skip_go_tests {} {
1543 # Return a 1 if I don't even want to try to test java.
1545 proc skip_java_tests {} {
1549 # Return a 1 for configurations that do not support Python scripting.
1551 proc skip_python_tests {} {
1553 global gdb_py_is_py3k
1554 global gdb_py_is_py24
1556 gdb_test_multiple "python print ('test')" "verify python support" {
1557 -re "not supported.*$gdb_prompt $" {
1558 unsupported "Python support is disabled."
1561 -re "$gdb_prompt $" {}
1564 set gdb_py_is_py24 0
1565 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1566 -re "3.*$gdb_prompt $" {
1567 set gdb_py_is_py3k 1
1569 -re ".*$gdb_prompt $" {
1570 set gdb_py_is_py3k 0
1573 if { $gdb_py_is_py3k == 0 } {
1574 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1575 -re "\[45\].*$gdb_prompt $" {
1576 set gdb_py_is_py24 1
1578 -re ".*$gdb_prompt $" {
1579 set gdb_py_is_py24 0
1587 # Return a 1 if we should skip shared library tests.
1589 proc skip_shlib_tests {} {
1590 # Run the shared library tests on native systems.
1595 # An abbreviated list of remote targets where we should be able to
1596 # run shared library tests.
1597 if {([istarget *-*-linux*]
1598 || [istarget *-*-*bsd*]
1599 || [istarget *-*-solaris2*]
1600 || [istarget arm*-*-symbianelf*]
1601 || [istarget *-*-mingw*]
1602 || [istarget *-*-cygwin*]
1603 || [istarget *-*-pe*])} {
1610 # Test files shall make sure all the test result lines in gdb.sum are
1611 # unique in a test run, so that comparing the gdb.sum files of two
1612 # test runs gives correct results. Test files that exercise
1613 # variations of the same tests more than once, shall prefix the
1614 # different test invocations with different identifying strings in
1615 # order to make them unique.
1617 # About test prefixes:
1619 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1620 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1621 # underlined substring in
1623 # PASS: gdb.base/mytest.exp: some test
1624 # ^^^^^^^^^^^^^^^^^^^^
1628 # The easiest way to adjust the test prefix is to append a test
1629 # variation prefix to the $pf_prefix, using the with_test_prefix
1632 # proc do_tests {} {
1633 # gdb_test ... ... "test foo"
1634 # gdb_test ... ... "test bar"
1636 # with_test_prefix "subvariation a" {
1637 # gdb_test ... ... "test x"
1640 # with_test_prefix "subvariation b" {
1641 # gdb_test ... ... "test x"
1645 # with_test_prefix "variation1" {
1646 # ...do setup for variation 1...
1650 # with_test_prefix "variation2" {
1651 # ...do setup for variation 2...
1657 # PASS: gdb.base/mytest.exp: variation1: test foo
1658 # PASS: gdb.base/mytest.exp: variation1: test bar
1659 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1660 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1661 # PASS: gdb.base/mytest.exp: variation2: test foo
1662 # PASS: gdb.base/mytest.exp: variation2: test bar
1663 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1664 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1666 # If for some reason more flexibility is necessary, one can also
1667 # manipulate the pf_prefix global directly, treating it as a string.
1671 # set saved_pf_prefix
1672 # append pf_prefix "${foo}: bar"
1673 # ... actual tests ...
1674 # set pf_prefix $saved_pf_prefix
1677 # Run BODY in the context of the caller, with the current test prefix
1678 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1679 # Returns the result of BODY.
1681 proc with_test_prefix { prefix body } {
1684 set saved $pf_prefix
1685 append pf_prefix " " $prefix ":"
1686 set code [catch {uplevel 1 $body} result]
1687 set pf_prefix $saved
1690 global errorInfo errorCode
1691 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1693 return -code $code $result
1697 # Return 1 if _Complex types are supported, otherwise, return 0.
1699 proc support_complex_tests {} {
1700 global support_complex_tests_saved
1702 # Use the cached value, if it exists.
1703 if [info exists support_complex_tests_saved] {
1704 verbose "returning saved $support_complex_tests_saved" 2
1705 return $support_complex_tests_saved
1708 # Set up, compile, and execute a test program containing _Complex types.
1709 # Include the current process ID in the file names to prevent conflicts
1710 # with invocations for multiple testsuites.
1711 set src complex[pid].c
1712 set exe complex[pid].x
1714 set f [open $src "w"]
1715 puts $f "int main() {"
1716 puts $f "_Complex float cf;"
1717 puts $f "_Complex double cd;"
1718 puts $f "_Complex long double cld;"
1719 puts $f " return 0; }"
1722 verbose "compiling testfile $src" 2
1723 set compile_flags {debug nowarnings quiet}
1724 set lines [gdb_compile $src $exe executable $compile_flags]
1728 if ![string match "" $lines] then {
1729 verbose "testfile compilation failed, returning 0" 2
1730 set support_complex_tests_saved 0
1732 set support_complex_tests_saved 1
1735 return $support_complex_tests_saved
1738 # Return 1 if target hardware or OS supports single stepping to signal
1739 # handler, otherwise, return 0.
1741 proc can_single_step_to_signal_handler {} {
1743 # Targets don't have hardware single step. On these targets, when
1744 # a signal is delivered during software single step, gdb is unable
1745 # to determine the next instruction addresses, because start of signal
1746 # handler is one of them.
1747 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
1748 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"] } {
1755 # Return 1 if target supports process record, otherwise return 0.
1757 proc supports_process_record {} {
1759 if [target_info exists gdb,use_precord] {
1760 return [target_info gdb,use_precord]
1763 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"] } {
1770 # Return 1 if target supports reverse debugging, otherwise return 0.
1772 proc supports_reverse {} {
1774 if [target_info exists gdb,can_reverse] {
1775 return [target_info gdb,can_reverse]
1778 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"] } {
1785 # Return 1 if target is ILP32.
1786 # This cannot be decided simply from looking at the target string,
1787 # as it might depend on externally passed compiler options like -m64.
1788 proc is_ilp32_target {} {
1789 global is_ilp32_target_saved
1791 # Use the cached value, if it exists. Cache value per "board" to handle
1792 # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1793 set me "is_ilp32_target"
1794 set board [target_info name]
1795 if [info exists is_ilp32_target_saved($board)] {
1796 verbose "$me: returning saved $is_ilp32_target_saved($board)" 2
1797 return $is_ilp32_target_saved($board)
1801 set src ilp32[pid].c
1802 set obj ilp32[pid].o
1804 set f [open $src "w"]
1805 puts $f "int dummy\[sizeof (int) == 4"
1806 puts $f " && sizeof (void *) == 4"
1807 puts $f " && sizeof (long) == 4 ? 1 : -1\];"
1810 verbose "$me: compiling testfile $src" 2
1811 set lines [gdb_compile $src $obj object {quiet}]
1815 if ![string match "" $lines] then {
1816 verbose "$me: testfile compilation failed, returning 0" 2
1817 return [set is_ilp32_target_saved($board) 0]
1820 verbose "$me: returning 1" 2
1821 return [set is_ilp32_target_saved($board) 1]
1824 # Return 1 if target is LP64.
1825 # This cannot be decided simply from looking at the target string,
1826 # as it might depend on externally passed compiler options like -m64.
1827 proc is_lp64_target {} {
1828 global is_lp64_target_saved
1830 # Use the cached value, if it exists. Cache value per "board" to handle
1831 # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1832 set me "is_lp64_target"
1833 set board [target_info name]
1834 if [info exists is_lp64_target_saved($board)] {
1835 verbose "$me: returning saved $is_lp64_target_saved($board)" 2
1836 return $is_lp64_target_saved($board)
1842 set f [open $src "w"]
1843 puts $f "int dummy\[sizeof (int) == 4"
1844 puts $f " && sizeof (void *) == 8"
1845 puts $f " && sizeof (long) == 8 ? 1 : -1\];"
1848 verbose "$me: compiling testfile $src" 2
1849 set lines [gdb_compile $src $obj object {quiet}]
1853 if ![string match "" $lines] then {
1854 verbose "$me: testfile compilation failed, returning 0" 2
1855 return [set is_lp64_target_saved($board) 0]
1858 verbose "$me: returning 1" 2
1859 return [set is_lp64_target_saved($board) 1]
1862 # Return 1 if target has x86_64 registers - either amd64 or x32.
1863 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
1864 # just from the target string.
1865 proc is_amd64_regs_target {} {
1866 global is_amd64_regs_target_saved
1868 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
1872 # Use the cached value, if it exists. Cache value per "board" to handle
1873 # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1874 set me "is_amd64_regs_target"
1875 set board [target_info name]
1876 if [info exists is_amd64_regs_target_saved($board)] {
1877 verbose "$me: returning saved $is_amd64_regs_target_saved($board)" 2
1878 return $is_amd64_regs_target_saved($board)
1881 set src reg64[pid].s
1882 set obj reg64[pid].o
1884 set f [open $src "w"]
1886 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
1887 puts $f "\tincq %$reg"
1891 verbose "$me: compiling testfile $src" 2
1892 set lines [gdb_compile $src $obj object {quiet}]
1896 if ![string match "" $lines] then {
1897 verbose "$me: testfile compilation failed, returning 0" 2
1898 return [set is_amd64_regs_target_saved($board) 0]
1901 verbose "$me: returning 1" 2
1902 return [set is_amd64_regs_target_saved($board) 1]
1905 # Return 1 if this target is an x86 or x86-64 with -m32.
1906 proc is_x86_like_target {} {
1907 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
1910 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
1913 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
1914 proc support_displaced_stepping {} {
1916 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
1917 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
1918 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
1925 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1926 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1928 proc skip_altivec_tests {} {
1929 global skip_vmx_tests_saved
1930 global srcdir subdir gdb_prompt inferior_exited_re
1932 # Use the cached value, if it exists.
1933 set me "skip_altivec_tests"
1934 if [info exists skip_vmx_tests_saved] {
1935 verbose "$me: returning saved $skip_vmx_tests_saved" 2
1936 return $skip_vmx_tests_saved
1939 # Some simulators are known to not support VMX instructions.
1940 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1941 verbose "$me: target known to not support VMX, returning 1" 2
1942 return [set skip_vmx_tests_saved 1]
1945 # Make sure we have a compiler that understands altivec.
1946 set compile_flags {debug nowarnings}
1947 if [get_compiler_info] {
1948 warning "Could not get compiler info"
1951 if [test_compiler_info gcc*] {
1952 set compile_flags "$compile_flags additional_flags=-maltivec"
1953 } elseif [test_compiler_info xlc*] {
1954 set compile_flags "$compile_flags additional_flags=-qaltivec"
1956 verbose "Could not compile with altivec support, returning 1" 2
1960 # Set up, compile, and execute a test program containing VMX instructions.
1961 # Include the current process ID in the file names to prevent conflicts
1962 # with invocations for multiple testsuites.
1966 set f [open $src "w"]
1967 puts $f "int main() {"
1968 puts $f "#ifdef __MACH__"
1969 puts $f " asm volatile (\"vor v0,v0,v0\");"
1971 puts $f " asm volatile (\"vor 0,0,0\");"
1973 puts $f " return 0; }"
1976 verbose "$me: compiling testfile $src" 2
1977 set lines [gdb_compile $src $exe executable $compile_flags]
1980 if ![string match "" $lines] then {
1981 verbose "$me: testfile compilation failed, returning 1" 2
1982 return [set skip_vmx_tests_saved 1]
1985 # No error message, compilation succeeded so now run it via gdb.
1989 gdb_reinitialize_dir $srcdir/$subdir
1993 -re ".*Illegal instruction.*${gdb_prompt} $" {
1994 verbose -log "\n$me altivec hardware not detected"
1995 set skip_vmx_tests_saved 1
1997 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
1998 verbose -log "\n$me: altivec hardware detected"
1999 set skip_vmx_tests_saved 0
2002 warning "\n$me: default case taken"
2003 set skip_vmx_tests_saved 1
2007 remote_file build delete $exe
2009 verbose "$me: returning $skip_vmx_tests_saved" 2
2010 return $skip_vmx_tests_saved
2013 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2014 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2016 proc skip_vsx_tests {} {
2017 global skip_vsx_tests_saved
2018 global srcdir subdir gdb_prompt inferior_exited_re
2020 # Use the cached value, if it exists.
2021 set me "skip_vsx_tests"
2022 if [info exists skip_vsx_tests_saved] {
2023 verbose "$me: returning saved $skip_vsx_tests_saved" 2
2024 return $skip_vsx_tests_saved
2027 # Some simulators are known to not support Altivec instructions, so
2028 # they won't support VSX instructions as well.
2029 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2030 verbose "$me: target known to not support VSX, returning 1" 2
2031 return [set skip_vsx_tests_saved 1]
2034 # Make sure we have a compiler that understands altivec.
2035 set compile_flags {debug nowarnings quiet}
2036 if [get_compiler_info] {
2037 warning "Could not get compiler info"
2040 if [test_compiler_info gcc*] {
2041 set compile_flags "$compile_flags additional_flags=-mvsx"
2042 } elseif [test_compiler_info xlc*] {
2043 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2045 verbose "Could not compile with vsx support, returning 1" 2
2052 set f [open $src "w"]
2053 puts $f "int main() {"
2054 puts $f " double a\[2\] = { 1.0, 2.0 };"
2055 puts $f "#ifdef __MACH__"
2056 puts $f " asm volatile (\"lxvd2x v0,v0,%\[addr\]\" : : \[addr\] \"r\" (a));"
2058 puts $f " asm volatile (\"lxvd2x 0,0,%\[addr\]\" : : \[addr\] \"r\" (a));"
2060 puts $f " return 0; }"
2063 verbose "$me: compiling testfile $src" 2
2064 set lines [gdb_compile $src $exe executable $compile_flags]
2067 if ![string match "" $lines] then {
2068 verbose "$me: testfile compilation failed, returning 1" 2
2069 return [set skip_vsx_tests_saved 1]
2072 # No error message, compilation succeeded so now run it via gdb.
2076 gdb_reinitialize_dir $srcdir/$subdir
2080 -re ".*Illegal instruction.*${gdb_prompt} $" {
2081 verbose -log "\n$me VSX hardware not detected"
2082 set skip_vsx_tests_saved 1
2084 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2085 verbose -log "\n$me: VSX hardware detected"
2086 set skip_vsx_tests_saved 0
2089 warning "\n$me: default case taken"
2090 set skip_vsx_tests_saved 1
2094 remote_file build delete $exe
2096 verbose "$me: returning $skip_vsx_tests_saved" 2
2097 return $skip_vsx_tests_saved
2100 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2101 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2103 proc skip_btrace_tests {} {
2104 global skip_btrace_tests_saved
2105 global srcdir subdir gdb_prompt inferior_exited_re
2107 # Use the cached value, if it exists.
2108 set me "skip_btrace_tests"
2109 if [info exists skip_btrace_tests_saved] {
2110 verbose "$me: returning saved $skip_btrace_tests_saved" 2
2111 return $skip_btrace_tests_saved
2114 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2115 verbose "$me: target does not support btrace, returning 1" 2
2116 return [set skip_btrace_tests_saved 1]
2119 # Set up, compile, and execute a test program.
2120 # Include the current process ID in the file names to prevent conflicts
2121 # with invocations for multiple testsuites.
2122 set src [standard_output_file btrace[pid].c]
2123 set exe [standard_output_file btrace[pid].x]
2125 set f [open $src "w"]
2126 puts $f "int main(void) { return 0; }"
2129 verbose "$me: compiling testfile $src" 2
2130 set compile_flags {debug nowarnings quiet}
2131 set lines [gdb_compile $src $exe executable $compile_flags]
2133 if ![string match "" $lines] then {
2134 verbose "$me: testfile compilation failed, returning 1" 2
2136 return [set skip_btrace_tests_saved 1]
2139 # No error message, compilation succeeded so now run it via gdb.
2141 clean_restart btrace[pid].x
2144 return [set skip_btrace_tests_saved 1]
2147 # In case of an unexpected output, we return 2 as a fail value.
2148 set skip_btrace_tests_saved 2
2149 gdb_test_multiple "record btrace" "check btrace support" {
2150 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2151 set skip_btrace_tests_saved 1
2153 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2154 set skip_btrace_tests_saved 1
2156 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2157 set skip_btrace_tests_saved 1
2159 -re "^record btrace\r\n$gdb_prompt $" {
2160 set skip_btrace_tests_saved 0
2164 remote_file build delete $exe
2166 verbose "$me: returning $skip_btrace_tests_saved" 2
2167 return $skip_btrace_tests_saved
2170 # Skip all the tests in the file if you are not on an hppa running
2173 proc skip_hp_tests {} {
2174 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
2175 verbose "Skip hp tests is $skip_hp"
2179 # Return whether we should skip tests for showing inlined functions in
2180 # backtraces. Requires get_compiler_info and get_debug_format.
2182 proc skip_inline_frame_tests {} {
2183 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2184 if { ! [test_debug_format "DWARF 2"] } {
2188 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2189 if { ([test_compiler_info "gcc-2-*"]
2190 || [test_compiler_info "gcc-3-*"]
2191 || [test_compiler_info "gcc-4-0-*"]) } {
2198 # Return whether we should skip tests for showing variables from
2199 # inlined functions. Requires get_compiler_info and get_debug_format.
2201 proc skip_inline_var_tests {} {
2202 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2203 if { ! [test_debug_format "DWARF 2"] } {
2210 # Return a 1 if we should skip tests that require hardware breakpoints
2212 proc skip_hw_breakpoint_tests {} {
2213 # Skip tests if requested by the board (note that no_hardware_watchpoints
2214 # disables both watchpoints and breakpoints)
2215 if { [target_info exists gdb,no_hardware_watchpoints]} {
2219 # These targets support hardware breakpoints natively
2220 if { [istarget "i?86-*-*"]
2221 || [istarget "x86_64-*-*"]
2222 || [istarget "ia64-*-*"]
2223 || [istarget "arm*-*-*"]} {
2230 # Return a 1 if we should skip tests that require hardware watchpoints
2232 proc skip_hw_watchpoint_tests {} {
2233 # Skip tests if requested by the board
2234 if { [target_info exists gdb,no_hardware_watchpoints]} {
2238 # These targets support hardware watchpoints natively
2239 if { [istarget "i?86-*-*"]
2240 || [istarget "x86_64-*-*"]
2241 || [istarget "ia64-*-*"]
2242 || [istarget "arm*-*-*"]
2243 || [istarget "powerpc*-*-linux*"]
2244 || [istarget "s390*-*-*"] } {
2251 # Return a 1 if we should skip tests that require *multiple* hardware
2252 # watchpoints to be active at the same time
2254 proc skip_hw_watchpoint_multi_tests {} {
2255 if { [skip_hw_watchpoint_tests] } {
2259 # These targets support just a single hardware watchpoint
2260 if { [istarget "arm*-*-*"]
2261 || [istarget "powerpc*-*-linux*"] } {
2268 # Return a 1 if we should skip tests that require read/access watchpoints
2270 proc skip_hw_watchpoint_access_tests {} {
2271 if { [skip_hw_watchpoint_tests] } {
2275 # These targets support just write watchpoints
2276 if { [istarget "s390*-*-*"] } {
2283 # Return 1 if we should skip tests that require the runtime unwinder
2284 # hook. This must be invoked while gdb is running, after shared
2285 # libraries have been loaded. This is needed because otherwise a
2286 # shared libgcc won't be visible.
2288 proc skip_unwinder_tests {} {
2292 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2293 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2295 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
2298 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
2302 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2303 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
2306 -re "\r\n$gdb_prompt $" {
2313 set compiler_info "unknown"
2315 set hp_cc_compiler 0
2316 set hp_aCC_compiler 0
2318 # Figure out what compiler I am using.
2320 # ARG can be empty or "C++". If empty, "C" is assumed.
2322 # There are several ways to do this, with various problems.
2324 # [ gdb_compile -E $ifile -o $binfile.ci ]
2325 # source $binfile.ci
2327 # Single Unix Spec v3 says that "-E -o ..." together are not
2328 # specified. And in fact, the native compiler on hp-ux 11 (among
2329 # others) does not work with "-E -o ...". Most targets used to do
2330 # this, and it mostly worked, because it works with gcc.
2332 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2333 # source $binfile.ci
2335 # This avoids the problem with -E and -o together. This almost works
2336 # if the build machine is the same as the host machine, which is
2337 # usually true of the targets which are not gcc. But this code does
2338 # not figure which compiler to call, and it always ends up using the C
2339 # compiler. Not good for setting hp_aCC_compiler. Targets
2340 # hppa*-*-hpux* and mips*-*-irix* used to do this.
2342 # [ gdb_compile -E $ifile > $binfile.ci ]
2343 # source $binfile.ci
2345 # dejagnu target_compile says that it supports output redirection,
2346 # but the code is completely different from the normal path and I
2347 # don't want to sweep the mines from that path. So I didn't even try
2350 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2353 # I actually do this for all targets now. gdb_compile runs the right
2354 # compiler, and TCL captures the output, and I eval the output.
2356 # Unfortunately, expect logs the output of the command as it goes by,
2357 # and dejagnu helpfully prints a second copy of it right afterwards.
2358 # So I turn off expect logging for a moment.
2360 # [ gdb_compile $ifile $ciexe_file executable $args ]
2361 # [ remote_exec $ciexe_file ]
2362 # [ source $ci_file.out ]
2364 # I could give up on -E and just do this.
2365 # I didn't get desperate enough to try this.
2367 # -- chastain 2004-01-06
2369 proc get_compiler_info {{arg ""}} {
2370 # For compiler.c and compiler.cc
2373 # I am going to play with the log to keep noise out.
2377 # These come from compiler.c or compiler.cc
2378 global compiler_info
2380 # Legacy global data symbols.
2382 global hp_cc_compiler
2383 global hp_aCC_compiler
2385 # Choose which file to preprocess.
2386 set ifile "${srcdir}/lib/compiler.c"
2387 if { $arg == "c++" } {
2388 set ifile "${srcdir}/lib/compiler.cc"
2391 # Run $ifile through the right preprocessor.
2392 # Toggle gdb.log to keep the compiler output out of the log.
2394 if [is_remote host] {
2395 # We have to use -E and -o together, despite the comments
2396 # above, because of how DejaGnu handles remote host testing.
2397 set ppout "$outdir/compiler.i"
2398 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
2399 set file [open $ppout r]
2400 set cppout [read $file]
2403 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
2405 log_file -a "$outdir/$tool.log"
2409 foreach cppline [ split "$cppout" "\n" ] {
2410 if { [ regexp "^#" "$cppline" ] } {
2412 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2414 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2416 verbose "get_compiler_info: $cppline" 2
2420 verbose -log "get_compiler_info: $cppline"
2425 # Reset to unknown compiler if any diagnostics happened.
2427 set compiler_info "unknown"
2430 # Set the legacy symbols.
2432 set hp_cc_compiler 0
2433 set hp_aCC_compiler 0
2434 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2435 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2436 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2437 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2438 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2439 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2440 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2442 # Log what happened.
2443 verbose -log "get_compiler_info: $compiler_info"
2445 # Most compilers will evaluate comparisons and other boolean
2446 # operations to 0 or 1.
2447 uplevel \#0 { set true 1 }
2448 uplevel \#0 { set false 0 }
2450 # Use of aCC results in boolean results being displayed as
2452 if { $hp_aCC_compiler } {
2453 uplevel \#0 { set true true }
2454 uplevel \#0 { set false false }
2460 proc test_compiler_info { {compiler ""} } {
2461 global compiler_info
2463 # if no arg, return the compiler_info string
2465 if [string match "" $compiler] {
2466 if [info exists compiler_info] {
2467 return $compiler_info
2469 perror "No compiler info found."
2473 return [string match $compiler $compiler_info]
2476 proc current_target_name { } {
2478 if [info exists target_info(target,name)] {
2479 set answer $target_info(target,name)
2486 set gdb_wrapper_initialized 0
2487 set gdb_wrapper_target ""
2489 proc gdb_wrapper_init { args } {
2490 global gdb_wrapper_initialized;
2491 global gdb_wrapper_file;
2492 global gdb_wrapper_flags;
2493 global gdb_wrapper_target
2495 if { $gdb_wrapper_initialized == 1 } { return; }
2497 if {[target_info exists needs_status_wrapper] && \
2498 [target_info needs_status_wrapper] != "0"} {
2499 set result [build_wrapper "testglue.o"];
2500 if { $result != "" } {
2501 set gdb_wrapper_file [lindex $result 0];
2502 set gdb_wrapper_flags [lindex $result 1];
2504 warning "Status wrapper failed to build."
2507 set gdb_wrapper_initialized 1
2508 set gdb_wrapper_target [current_target_name]
2511 # Some targets need to always link a special object in. Save its path here.
2512 global gdb_saved_set_unbuffered_mode_obj
2513 set gdb_saved_set_unbuffered_mode_obj ""
2515 proc gdb_compile {source dest type options} {
2516 global GDB_TESTCASE_OPTIONS;
2517 global gdb_wrapper_file;
2518 global gdb_wrapper_flags;
2519 global gdb_wrapper_initialized;
2522 global gdb_saved_set_unbuffered_mode_obj
2524 set outdir [file dirname $dest]
2526 # Add platform-specific options if a shared library was specified using
2527 # "shlib=librarypath" in OPTIONS.
2531 foreach opt $options {
2532 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2533 if [test_compiler_info "xlc-*"] {
2534 # IBM xlc compiler doesn't accept shared library named other
2535 # than .so: use "-Wl," to bypass this
2536 lappend source "-Wl,$shlib_name"
2537 } elseif { ([istarget "*-*-mingw*"]
2538 || [istarget *-*-cygwin*]
2539 || [istarget *-*-pe*])} {
2540 lappend source "${shlib_name}.a"
2542 lappend source $shlib_name
2544 if { $shlib_found == 0 } {
2546 if { ([istarget "*-*-mingw*"]
2547 || [istarget *-*-cygwin*]) } {
2548 lappend new_options "additional_flags=-Wl,--enable-auto-import"
2551 } elseif { $opt == "shlib_load" } {
2554 lappend new_options $opt
2558 # We typically link to shared libraries using an absolute path, and
2559 # that's how they are found at runtime. If we are going to
2560 # dynamically load one by basename, we must specify rpath. If we
2561 # are using a remote host, DejaGNU will link to the shared library
2562 # using a relative path, so again we must specify an rpath.
2563 if { $shlib_load || ($shlib_found && [is_remote target]) } {
2564 if { ([istarget "*-*-mingw*"]
2565 || [istarget *-*-cygwin*]
2566 || [istarget *-*-pe*]
2567 || [istarget hppa*-*-hpux*])} {
2568 # Do not need anything.
2569 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
2570 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
2571 } elseif { [istarget arm*-*-symbianelf*] } {
2572 if { $shlib_load } {
2573 lappend new_options "libs=-ldl"
2576 if { $shlib_load } {
2577 lappend new_options "libs=-ldl"
2579 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
2582 set options $new_options
2584 if [target_info exists is_vxworks] {
2585 set options2 { "additional_flags=-Dvxworks" }
2586 set options [concat $options2 $options]
2588 if [info exists GDB_TESTCASE_OPTIONS] {
2589 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
2591 verbose "options are $options"
2592 verbose "source is $source $dest $type $options"
2594 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2596 if {[target_info exists needs_status_wrapper] && \
2597 [target_info needs_status_wrapper] != "0" && \
2598 [info exists gdb_wrapper_file]} {
2599 lappend options "libs=${gdb_wrapper_file}"
2600 lappend options "ldflags=${gdb_wrapper_flags}"
2603 # Replace the "nowarnings" option with the appropriate additional_flags
2604 # to disable compiler warnings.
2605 set nowarnings [lsearch -exact $options nowarnings]
2606 if {$nowarnings != -1} {
2607 if [target_info exists gdb,nowarnings_flag] {
2608 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2610 set flag "additional_flags=-w"
2612 set options [lreplace $options $nowarnings $nowarnings $flag]
2615 if { $type == "executable" } {
2616 if { ([istarget "*-*-mingw*"]
2617 || [istarget "*-*-*djgpp"]
2618 || [istarget "*-*-cygwin*"])} {
2619 # Force output to unbuffered mode, by linking in an object file
2620 # with a global contructor that calls setvbuf.
2622 # Compile the special object seperatelly for two reasons:
2623 # 1) Insulate it from $options.
2624 # 2) Avoid compiling it for every gdb_compile invocation,
2625 # which is time consuming, especially if we're remote
2628 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2629 verbose "compiling gdb_saved_set_unbuffered_obj"
2630 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2631 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2633 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2634 if { $result != "" } {
2638 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2639 # Link a copy of the output object, because the
2640 # original may be automatically deleted.
2641 remote_exec host "cp -f $unbuf_obj $gdb_saved_set_unbuffered_mode_obj"
2643 verbose "gdb_saved_set_unbuffered_obj already compiled"
2646 # Rely on the internal knowledge that the global ctors are ran in
2647 # reverse link order. In that case, we can use ldflags to
2648 # avoid copying the object file to the host multiple
2650 # This object can only be added if standard libraries are
2651 # used. Thus, we need to disable it if -nostdlib option is used
2652 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2653 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2658 set result [target_compile $source $dest $type $options];
2660 # Prune uninteresting compiler (and linker) output.
2661 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2663 regsub "\[\r\n\]*$" "$result" "" result;
2664 regsub "^\[\r\n\]*" "$result" "" result;
2666 if {[lsearch $options quiet] < 0} {
2667 # We shall update this on a per language basis, to avoid
2668 # changing the entire testsuite in one go.
2669 if {[lsearch $options f77] >= 0} {
2670 gdb_compile_test $source $result
2671 } elseif { $result != "" } {
2672 clone_output "gdb compile failed, $result"
2679 # This is just like gdb_compile, above, except that it tries compiling
2680 # against several different thread libraries, to see which one this
2682 proc gdb_compile_pthreads {source dest type options} {
2684 set why_msg "unrecognized error"
2685 foreach lib {-lpthreads -lpthread -lthread ""} {
2686 # This kind of wipes out whatever libs the caller may have
2687 # set. Or maybe theirs will override ours. How infelicitous.
2688 set options_with_lib [concat $options [list libs=$lib quiet]]
2689 set ccout [gdb_compile $source $dest $type $options_with_lib]
2690 switch -regexp -- $ccout {
2691 ".*no posix threads support.*" {
2692 set why_msg "missing threads include file"
2695 ".*cannot open -lpthread.*" {
2696 set why_msg "missing runtime threads library"
2698 ".*Can't find library for -lpthread.*" {
2699 set why_msg "missing runtime threads library"
2702 pass "successfully compiled posix threads test case"
2708 if {!$built_binfile} {
2709 unsupported "Couldn't compile $source: ${why_msg}"
2714 # Build a shared library from SOURCES. You must use get_compiler_info
2717 proc gdb_compile_shlib {sources dest options} {
2718 set obj_options $options
2720 switch -glob [test_compiler_info] {
2722 lappend obj_options "additional_flags=-qpic"
2725 if { !([istarget "powerpc*-*-aix*"]
2726 || [istarget "rs6000*-*-aix*"]
2727 || [istarget "*-*-cygwin*"]
2728 || [istarget "*-*-mingw*"]
2729 || [istarget "*-*-pe*"]) } {
2730 lappend obj_options "additional_flags=-fpic"
2734 switch -glob [istarget] {
2736 lappend obj_options "additional_flags=+z"
2739 # Disable SGI compiler's implicit -Dsgi
2740 lappend obj_options "additional_flags=-Usgi"
2743 # don't know what the compiler is...
2749 set outdir [file dirname $dest]
2751 foreach source $sources {
2752 set sourcebase [file tail $source]
2753 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
2756 lappend objects ${outdir}/${sourcebase}.o
2759 if [istarget "hppa*-*-hpux*"] {
2760 remote_exec build "ld -b ${objects} -o ${dest}"
2762 set link_options $options
2763 if [test_compiler_info "xlc-*"] {
2764 lappend link_options "additional_flags=-qmkshrobj"
2766 lappend link_options "additional_flags=-shared"
2768 if { ([istarget "*-*-mingw*"]
2769 || [istarget *-*-cygwin*]
2770 || [istarget *-*-pe*])} {
2771 lappend link_options "additional_flags=-Wl,--out-implib,${dest}.a"
2772 } elseif [is_remote target] {
2773 # By default, we do not set the soname. This causes the linker
2774 # on ELF systems to create a DT_NEEDED entry in the executable
2775 # refering to the full path name of the library. This is a
2776 # problem in remote testing if the library is in a different
2777 # directory there. To fix this, we set a soname of just the
2778 # base filename for the library, and add an appropriate -rpath
2779 # to the main executable (in gdb_compile).
2780 set destbase [file tail $dest]
2781 lappend link_options "additional_flags=-Wl,-soname,$destbase"
2784 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
2790 # This is just like gdb_compile_shlib, above, except that it tries compiling
2791 # against several different thread libraries, to see which one this
2793 proc gdb_compile_shlib_pthreads {sources dest options} {
2795 set why_msg "unrecognized error"
2796 foreach lib {-lpthreads -lpthread -lthread ""} {
2797 # This kind of wipes out whatever libs the caller may have
2798 # set. Or maybe theirs will override ours. How infelicitous.
2799 set options_with_lib [concat $options [list libs=$lib quiet]]
2800 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
2801 switch -regexp -- $ccout {
2802 ".*no posix threads support.*" {
2803 set why_msg "missing threads include file"
2806 ".*cannot open -lpthread.*" {
2807 set why_msg "missing runtime threads library"
2809 ".*Can't find library for -lpthread.*" {
2810 set why_msg "missing runtime threads library"
2813 pass "successfully compiled posix threads test case"
2819 if {!$built_binfile} {
2820 unsupported "Couldn't compile $sources: ${why_msg}"
2825 # This is just like gdb_compile_pthreads, above, except that we always add the
2826 # objc library for compiling Objective-C programs
2827 proc gdb_compile_objc {source dest type options} {
2829 set why_msg "unrecognized error"
2830 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
2831 # This kind of wipes out whatever libs the caller may have
2832 # set. Or maybe theirs will override ours. How infelicitous.
2833 if { $lib == "solaris" } {
2834 set lib "-lpthread -lposix4"
2836 if { $lib != "-lobjc" } {
2837 set lib "-lobjc $lib"
2839 set options_with_lib [concat $options [list libs=$lib quiet]]
2840 set ccout [gdb_compile $source $dest $type $options_with_lib]
2841 switch -regexp -- $ccout {
2842 ".*no posix threads support.*" {
2843 set why_msg "missing threads include file"
2846 ".*cannot open -lpthread.*" {
2847 set why_msg "missing runtime threads library"
2849 ".*Can't find library for -lpthread.*" {
2850 set why_msg "missing runtime threads library"
2853 pass "successfully compiled objc with posix threads test case"
2859 if {!$built_binfile} {
2860 unsupported "Couldn't compile $source: ${why_msg}"
2865 proc send_gdb { string } {
2866 global suppress_flag;
2867 if { $suppress_flag } {
2870 return [remote_send host "$string"]
2876 proc gdb_expect { args } {
2877 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
2878 set atimeout [lindex $args 0];
2879 set expcode [list [lindex $args 1]];
2884 upvar timeout timeout;
2886 if [target_info exists gdb,timeout] {
2887 if [info exists timeout] {
2888 if { $timeout < [target_info gdb,timeout] } {
2889 set gtimeout [target_info gdb,timeout];
2891 set gtimeout $timeout;
2894 set gtimeout [target_info gdb,timeout];
2898 if ![info exists gtimeout] {
2900 if [info exists timeout] {
2901 set gtimeout $timeout;
2905 if [info exists atimeout] {
2906 if { ![info exists gtimeout] || $gtimeout < $atimeout } {
2907 set gtimeout $atimeout;
2910 if ![info exists gtimeout] {
2916 global suppress_flag;
2917 global remote_suppress_flag;
2918 if [info exists remote_suppress_flag] {
2919 set old_val $remote_suppress_flag;
2921 if [info exists suppress_flag] {
2922 if { $suppress_flag } {
2923 set remote_suppress_flag 1;
2927 {uplevel remote_expect host $gtimeout $expcode} string];
2928 if [info exists old_val] {
2929 set remote_suppress_flag $old_val;
2931 if [info exists remote_suppress_flag] {
2932 unset remote_suppress_flag;
2937 global errorInfo errorCode;
2939 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
2941 return -code $code $string
2945 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
2947 # Check for long sequence of output by parts.
2948 # TEST: is the test message to be printed with the test success/fail.
2949 # SENTINEL: Is the terminal pattern indicating that output has finished.
2950 # LIST: is the sequence of outputs to match.
2951 # If the sentinel is recognized early, it is considered an error.
2954 # 1 if the test failed,
2955 # 0 if the test passes,
2956 # -1 if there was an internal error.
2958 proc gdb_expect_list {test sentinel list} {
2960 global suppress_flag
2963 if { $suppress_flag } {
2965 unresolved "${test}"
2967 while { ${index} < [llength ${list}] } {
2968 set pattern [lindex ${list} ${index}]
2969 set index [expr ${index} + 1]
2970 verbose -log "gdb_expect_list pattern: /$pattern/" 2
2971 if { ${index} == [llength ${list}] } {
2974 -re "${pattern}${sentinel}" {
2975 # pass "${test}, pattern ${index} + sentinel"
2978 fail "${test} (pattern ${index} + sentinel)"
2981 -re ".*A problem internal to GDB has been detected" {
2982 fail "${test} (GDB internal error)"
2984 gdb_internal_error_resync
2987 fail "${test} (pattern ${index} + sentinel) (timeout)"
2992 # unresolved "${test}, pattern ${index} + sentinel"
2998 # pass "${test}, pattern ${index}"
3001 fail "${test} (pattern ${index})"
3004 -re ".*A problem internal to GDB has been detected" {
3005 fail "${test} (GDB internal error)"
3007 gdb_internal_error_resync
3010 fail "${test} (pattern ${index}) (timeout)"
3015 # unresolved "${test}, pattern ${index}"
3029 proc gdb_suppress_entire_file { reason } {
3030 global suppress_flag;
3032 warning "$reason\n";
3033 set suppress_flag -1;
3037 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
3038 # gdb_expect to fail immediately (until the next call to
3039 # gdb_stop_suppressing_tests).
3041 proc gdb_suppress_tests { args } {
3042 global suppress_flag;
3044 return; # fnf - disable pending review of results where
3045 # testsuite ran better without this
3048 if { $suppress_flag == 1 } {
3049 if { [llength $args] > 0 } {
3050 warning "[lindex $args 0]\n";
3052 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
3058 # Clear suppress_flag.
3060 proc gdb_stop_suppressing_tests { } {
3061 global suppress_flag;
3063 if [info exists suppress_flag] {
3064 if { $suppress_flag > 0 } {
3065 set suppress_flag 0;
3066 clone_output "Tests restarted.\n";
3069 set suppress_flag 0;
3073 proc gdb_clear_suppressed { } {
3074 global suppress_flag;
3076 set suppress_flag 0;
3079 proc gdb_start { } {
3084 catch default_gdb_exit
3088 # gdb_load_cmd -- load a file into the debugger.
3089 # ARGS - additional args to load command.
3090 # return a -1 if anything goes wrong.
3092 proc gdb_load_cmd { args } {
3095 if [target_info exists gdb_load_timeout] {
3096 set loadtimeout [target_info gdb_load_timeout]
3098 set loadtimeout 1600
3100 send_gdb "load $args\n"
3101 verbose "Timeout is now $loadtimeout seconds" 2
3102 gdb_expect $loadtimeout {
3103 -re "Loading section\[^\r\]*\r\n" {
3106 -re "Start address\[\r\]*\r\n" {
3109 -re "Transfer rate\[\r\]*\r\n" {
3112 -re "Memory access error\[^\r\]*\r\n" {
3113 perror "Failed to load program"
3116 -re "$gdb_prompt $" {
3119 -re "(.*)\r\n$gdb_prompt " {
3120 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3124 perror "Timed out trying to load $args."
3131 # Invoke "gcore". CORE is the name of the core file to write. TEST
3132 # is the name of the test case. This will return 1 if the core file
3133 # was created, 0 otherwise. If this fails to make a core file because
3134 # this configuration of gdb does not support making core files, it
3135 # will call "unsupported", not "fail". However, if this fails to make
3136 # a core file for some other reason, then it will call "fail".
3138 proc gdb_gcore_cmd {core test} {
3142 gdb_test_multiple "gcore $core" $test {
3143 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3148 -re "Undefined command.*$gdb_prompt $" {
3150 verbose -log "'gcore' command undefined in gdb_gcore_cmd"
3153 -re "Can't create a corefile\[\r\n\]+$gdb_prompt $" {
3161 # Return the filename to download to the target and load on the target
3162 # for this shared library. Normally just LIBNAME, unless shared libraries
3163 # for this target have separate link and load images.
3165 proc shlib_target_file { libname } {
3169 # Return the filename GDB will load symbols from when debugging this
3170 # shared library. Normally just LIBNAME, unless shared libraries for
3171 # this target have separate link and load images.
3173 proc shlib_symbol_file { libname } {
3177 # Return the filename to download to the target and load for this
3178 # executable. Normally just BINFILE unless it is renamed to something
3179 # else for this target.
3181 proc exec_target_file { binfile } {
3185 # Return the filename GDB will load symbols from when debugging this
3186 # executable. Normally just BINFILE unless executables for this target
3187 # have separate files for symbols.
3189 proc exec_symbol_file { binfile } {
3193 # Rename the executable file. Normally this is just BINFILE1 being renamed
3194 # to BINFILE2, but some targets require multiple binary files.
3195 proc gdb_rename_execfile { binfile1 binfile2 } {
3196 file rename -force [exec_target_file ${binfile1}] \
3197 [exec_target_file ${binfile2}]
3198 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
3199 file rename -force [exec_symbol_file ${binfile1}] \
3200 [exec_symbol_file ${binfile2}]
3204 # "Touch" the executable file to update the date. Normally this is just
3205 # BINFILE, but some targets require multiple files.
3206 proc gdb_touch_execfile { binfile } {
3207 set time [clock seconds]
3208 file mtime [exec_target_file ${binfile}] $time
3209 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
3210 file mtime [exec_symbol_file ${binfile}] $time
3216 # Copy a file to the remote target and return its target filename.
3217 # Schedule the file to be deleted at the end of this test.
3219 proc gdb_download { filename } {
3222 set destname [remote_download target $filename]
3223 lappend cleanfiles $destname
3227 # gdb_load_shlibs LIB...
3229 # Copy the listed libraries to the target.
3231 proc gdb_load_shlibs { args } {
3232 if {![is_remote target]} {
3236 foreach file $args {
3237 gdb_download [shlib_target_file $file]
3240 # Even if the target supplies full paths for shared libraries,
3241 # they may not be paths for this system.
3242 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3246 # gdb_load -- load a file into the debugger.
3247 # Many files in config/*.exp override this procedure.
3249 proc gdb_load { arg } {
3250 return [gdb_file_cmd $arg]
3253 # gdb_reload -- load a file into the target. Called before "running",
3254 # either the first time or after already starting the program once,
3255 # for remote targets. Most files that override gdb_load should now
3256 # override this instead.
3258 proc gdb_reload { } {
3259 # For the benefit of existing configurations, default to gdb_load.
3260 # Specifying no file defaults to the executable currently being
3262 return [gdb_load ""]
3265 proc gdb_continue { function } {
3268 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
3271 proc default_gdb_init { args } {
3272 global gdb_wrapper_initialized
3273 global gdb_wrapper_target
3274 global gdb_test_file_name
3279 gdb_clear_suppressed;
3281 set gdb_test_file_name [file rootname [file tail [lindex $args 0]]]
3283 # Make sure that the wrapper is rebuilt
3284 # with the appropriate multilib option.
3285 if { $gdb_wrapper_target != [current_target_name] } {
3286 set gdb_wrapper_initialized 0
3289 # Unlike most tests, we have a small number of tests that generate
3290 # a very large amount of output. We therefore increase the expect
3291 # buffer size to be able to contain the entire test output.
3293 # Also set this value for the currently running GDB.
3294 match_max [match_max -d]
3296 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
3297 if { [llength $args] > 0 } {
3300 set file [lindex $args 0];
3302 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
3305 if [target_info exists gdb_prompt] {
3306 set gdb_prompt [target_info gdb_prompt];
3308 set gdb_prompt "\\(gdb\\)"
3311 if [info exists use_gdb_stub] {
3316 # Turn BASENAME into a full file name in the standard output
3317 # directory. It is ok if BASENAME is the empty string; in this case
3318 # the directory is returned.
3320 proc standard_output_file {basename} {
3321 global objdir subdir
3323 return [file join $objdir $subdir $basename]
3326 # Set 'testfile', 'srcfile', and 'binfile'.
3328 # ARGS is a list of source file specifications.
3329 # Without any arguments, the .exp file's base name is used to
3330 # compute the source file name. The ".c" extension is added in this case.
3331 # If ARGS is not empty, each entry is a source file specification.
3332 # If the specification starts with a ".", it is treated as a suffix
3333 # to append to the .exp file's base name.
3334 # If the specification is the empty string, it is treated as if it
3336 # Otherwise it is a file name.
3337 # The first file in the list is used to set the 'srcfile' global.
3338 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3340 # Most tests should call this without arguments.
3342 # If a completely different binary file name is needed, then it
3343 # should be handled in the .exp file with a suitable comment.
3345 proc standard_testfile {args} {
3346 global gdb_test_file_name
3348 global gdb_test_file_last_vars
3351 global testfile binfile
3353 set testfile $gdb_test_file_name
3354 set binfile [standard_output_file ${testfile}]
3356 if {[llength $args] == 0} {
3360 # Unset our previous output variables.
3361 # This can help catch hidden bugs.
3362 if {[info exists gdb_test_file_last_vars]} {
3363 foreach varname $gdb_test_file_last_vars {
3365 catch {unset $varname}
3368 # 'executable' is often set by tests.
3369 set gdb_test_file_last_vars {executable}
3373 set varname srcfile$suffix
3376 # Handle an extension.
3379 } elseif {[string range $arg 0 0] == "."} {
3380 set arg $testfile$arg
3384 lappend gdb_test_file_last_vars $varname
3386 if {$suffix == ""} {
3394 # The default timeout used when testing GDB commands. We want to use
3395 # the same timeout as the default dejagnu timeout, unless the user has
3396 # already provided a specific value (probably through a site.exp file).
3397 global gdb_test_timeout
3398 if ![info exists gdb_test_timeout] {
3399 set gdb_test_timeout $timeout
3402 # A list of global variables that GDB testcases should not use.
3403 # We try to prevent their use by monitoring write accesses and raising
3404 # an error when that happens.
3405 set banned_variables { bug_id prms_id }
3407 # A list of procedures that GDB testcases should not use.
3408 # We try to prevent their use by monitoring invocations and raising
3409 # an error when that happens.
3410 set banned_procedures { strace }
3412 # gdb_init is called by runtest at start, but also by several
3413 # tests directly; gdb_finish is only called from within runtest after
3414 # each test source execution.
3415 # Placing several traces by repetitive calls to gdb_init leads
3416 # to problems, as only one trace is removed in gdb_finish.
3417 # To overcome this possible problem, we add a variable that records
3418 # if the banned variables and procedures are already traced.
3421 proc gdb_init { args } {
3422 # Reset the timeout value to the default. This way, any testcase
3423 # that changes the timeout value without resetting it cannot affect
3424 # the timeout used in subsequent testcases.
3425 global gdb_test_timeout
3427 set timeout $gdb_test_timeout
3429 # Block writes to all banned variables, and invocation of all
3430 # banned procedures...
3431 global banned_variables
3432 global banned_procedures
3433 global banned_traced
3434 if (!$banned_traced) {
3435 foreach banned_var $banned_variables {
3436 global "$banned_var"
3437 trace add variable "$banned_var" write error
3439 foreach banned_proc $banned_procedures {
3440 global "$banned_proc"
3441 trace add execution "$banned_proc" enter error
3446 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
3447 # messages as expected.
3452 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
3453 # the test results. Even if /dev/null doesn't exist on the particular
3454 # platform, the readline library will use the default setting just by
3455 # failing to open the file. OTOH, opening /dev/null successfully will
3456 # also result in the default settings being used since nothing will be
3457 # read from this file.
3458 setenv INPUTRC "/dev/null"
3460 # The gdb.base/readline.exp arrow key test relies on the standard VT100
3461 # bindings, so make sure that an appropriate terminal is selected.
3462 # The same bug doesn't show up if we use ^P / ^N instead.
3465 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
3466 # grep. Clear GREP_OPTIONS to make the behavoiur predictable,
3467 # especially having color output turned on can cause tests to fail.
3468 setenv GREP_OPTIONS ""
3470 # Clear $gdbserver_reconnect_p.
3471 global gdbserver_reconnect_p
3472 set gdbserver_reconnect_p 1
3473 unset gdbserver_reconnect_p
3475 return [eval default_gdb_init $args]
3478 proc gdb_finish { } {
3481 # Exit first, so that the files are no longer in use.
3484 if { [llength $cleanfiles] > 0 } {
3485 eval remote_file target delete $cleanfiles
3489 # Unblock write access to the banned variables. Dejagnu typically
3490 # resets some of them between testcases.
3491 global banned_variables
3492 global banned_procedures
3493 global banned_traced
3494 if ($banned_traced) {
3495 foreach banned_var $banned_variables {
3496 global "$banned_var"
3497 trace remove variable "$banned_var" write error
3499 foreach banned_proc $banned_procedures {
3500 global "$banned_proc"
3501 trace remove execution "$banned_proc" enter error
3508 set debug_format "unknown"
3510 # Run the gdb command "info source" and extract the debugging format
3511 # information from the output and save it in debug_format.
3513 proc get_debug_format { } {
3519 set debug_format "unknown"
3520 send_gdb "info source\n"
3522 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
3523 set debug_format $expect_out(1,string)
3524 verbose "debug format is $debug_format"
3527 -re "No current source file.\r\n$gdb_prompt $" {
3528 perror "get_debug_format used when no current source file"
3531 -re "$gdb_prompt $" {
3532 warning "couldn't check debug format (no valid response)."
3536 warning "couldn't check debug format (timeout)."
3542 # Return true if FORMAT matches the debug format the current test was
3543 # compiled with. FORMAT is a shell-style globbing pattern; it can use
3544 # `*', `[...]', and so on.
3546 # This function depends on variables set by `get_debug_format', above.
3548 proc test_debug_format {format} {
3551 return [expr [string match $format $debug_format] != 0]
3554 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
3555 # COFF, stabs, etc). If that format matches the format that the
3556 # current test was compiled with, then the next test is expected to
3557 # fail for any target. Returns 1 if the next test or set of tests is
3558 # expected to fail, 0 otherwise (or if it is unknown). Must have
3559 # previously called get_debug_format.
3560 proc setup_xfail_format { format } {
3561 set ret [test_debug_format $format];
3569 # gdb_get_line_number TEXT [FILE]
3571 # Search the source file FILE, and return the line number of the
3572 # first line containing TEXT. If no match is found, an error is thrown.
3574 # TEXT is a string literal, not a regular expression.
3576 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
3577 # specified, and does not start with "/", then it is assumed to be in
3578 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
3579 # by changing the callers and the interface at the same time.
3580 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
3581 # gdb.base/ena-dis-br.exp.
3583 # Use this function to keep your test scripts independent of the
3584 # exact line numbering of the source file. Don't write:
3586 # send_gdb "break 20"
3588 # This means that if anyone ever edits your test's source file,
3589 # your test could break. Instead, put a comment like this on the
3590 # source file line you want to break at:
3592 # /* breakpoint spot: frotz.exp: test name */
3594 # and then write, in your test script (which we assume is named
3597 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
3599 # (Yes, Tcl knows how to handle the nested quotes and brackets.
3602 # % puts "foo [lindex "bar baz" 1]"
3605 # Tcl is quite clever, for a little stringy language.)
3609 # The previous implementation of this procedure used the gdb search command.
3610 # This version is different:
3612 # . It works with MI, and it also works when gdb is not running.
3614 # . It operates on the build machine, not the host machine.
3616 # . For now, this implementation fakes a current directory of
3617 # $srcdir/$subdir to be compatible with the old implementation.
3618 # This will go away eventually and some callers will need to
3621 # . The TEXT argument is literal text and matches literally,
3622 # not a regular expression as it was before.
3624 # . State changes in gdb, such as changing the current file
3625 # and setting $_, no longer happen.
3627 # After a bit of time we can forget about the differences from the
3628 # old implementation.
3630 # --chastain 2004-08-05
3632 proc gdb_get_line_number { text { file "" } } {
3637 if { "$file" == "" } then {
3640 if { ! [regexp "^/" "$file"] } then {
3641 set file "$srcdir/$subdir/$file"
3644 if { [ catch { set fd [open "$file"] } message ] } then {
3649 for { set line 1 } { 1 } { incr line } {
3650 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
3653 if { $nchar < 0 } then {
3656 if { [string first "$text" "$body"] >= 0 } then {
3662 if { [ catch { close "$fd" } message ] } then {
3667 error "undefined tag \"$text\""
3673 # gdb_continue_to_end:
3674 # The case where the target uses stubs has to be handled specially. If a
3675 # stub is used, we set a breakpoint at exit because we cannot rely on
3676 # exit() behavior of a remote target.
3678 # MSSG is the error message that gets printed. If not given, a
3680 # COMMAND is the command to invoke. If not given, "continue" is
3682 # ALLOW_EXTRA is a flag indicating whether the test should expect
3683 # extra output between the "Continuing." line and the program
3684 # exiting. By default it is zero; if nonzero, any extra output
3687 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
3688 global inferior_exited_re use_gdb_stub
3691 set text "continue until exit"
3693 set text "continue until exit at $mssg"
3701 if {![gdb_breakpoint "exit"]} {
3704 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
3707 # Continue until we exit. Should not stop again.
3708 # Don't bother to check the output of the program, that may be
3709 # extremely tough for some remote systems.
3711 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
3716 proc rerun_to_main {} {
3717 global gdb_prompt use_gdb_stub
3722 -re ".*Breakpoint .*main .*$gdb_prompt $"\
3723 {pass "rerun to main" ; return 0}
3724 -re "$gdb_prompt $"\
3725 {fail "rerun to main" ; return 0}
3726 timeout {fail "(timeout) rerun to main" ; return 0}
3731 -re "The program .* has been started already.*y or n. $" {
3735 -re "Starting program.*$gdb_prompt $"\
3736 {pass "rerun to main" ; return 0}
3737 -re "$gdb_prompt $"\
3738 {fail "rerun to main" ; return 0}
3739 timeout {fail "(timeout) rerun to main" ; return 0}
3744 # Print a message and return true if a test should be skipped
3745 # due to lack of floating point suport.
3747 proc gdb_skip_float_test { msg } {
3748 if [target_info exists gdb,skip_float_tests] {
3749 verbose "Skipping test '$msg': no float tests.";
3755 # Print a message and return true if a test should be skipped
3756 # due to lack of stdio support.
3758 proc gdb_skip_stdio_test { msg } {
3759 if [target_info exists gdb,noinferiorio] {
3760 verbose "Skipping test '$msg': no inferior i/o.";
3766 proc gdb_skip_bogus_test { msg } {
3770 # Return true if a test should be skipped due to lack of XML support
3772 # NOTE: This must be called while gdb is *not* running.
3774 proc gdb_skip_xml_test { } {
3777 global xml_missing_cached
3779 if {[info exists xml_missing_cached]} {
3780 return $xml_missing_cached
3784 set xml_missing_cached 0
3785 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
3786 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
3787 set xml_missing_cached 1
3789 -re ".*$gdb_prompt $" { }
3792 return $xml_missing_cached
3795 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
3796 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
3797 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
3798 # the name of a debuginfo only file. This file will be stored in the same
3801 # Functions for separate debug info testing
3803 # starting with an executable:
3804 # foo --> original executable
3806 # at the end of the process we have:
3807 # foo.stripped --> foo w/o debug info
3808 # foo.debug --> foo's debug info
3809 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
3811 # Return the build-id hex string (usually 160 bits as 40 hex characters)
3812 # converted to the form: .build-id/ab/cdef1234...89.debug
3813 # Return "" if no build-id found.
3814 proc build_id_debug_filename_get { exec } {
3815 set tmp "${exec}-tmp"
3816 set objcopy_program [transform objcopy]
3818 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
3819 verbose "result is $result"
3820 verbose "output is $output"
3825 fconfigure $fi -translation binary
3826 # Skip the NOTE header.
3831 if ![string compare $data ""] then {
3834 # Convert it to hex.
3835 binary scan $data H* data
3836 regsub {^..} $data {\0/} data
3837 return ".build-id/${data}.debug"
3840 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
3841 # list of optional flags. The only currently supported flag is no-main,
3842 # which removes the symbol entry for main from the separate debug file.
3844 # Function returns zero on success. Function will return non-zero failure code
3845 # on some targets not supporting separate debug info (such as i386-msdos).
3847 proc gdb_gnu_strip_debug { dest args } {
3849 # Use the first separate debug info file location searched by GDB so the
3850 # run cannot be broken by some stale file searched with higher precedence.
3851 set debug_file "${dest}.debug"
3853 set strip_to_file_program [transform strip]
3854 set objcopy_program [transform objcopy]
3856 set debug_link [file tail $debug_file]
3857 set stripped_file "${dest}.stripped"
3859 # Get rid of the debug info, and store result in stripped_file
3860 # something like gdb/testsuite/gdb.base/blah.stripped.
3861 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
3862 verbose "result is $result"
3863 verbose "output is $output"
3868 # Workaround PR binutils/10802:
3869 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3870 set perm [file attributes ${dest} -permissions]
3871 file attributes ${stripped_file} -permissions $perm
3873 # Get rid of everything but the debug info, and store result in debug_file
3874 # This will be in the .debug subdirectory, see above.
3875 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
3876 verbose "result is $result"
3877 verbose "output is $output"
3882 # If no-main is passed, strip the symbol for main from the separate
3883 # file. This is to simulate the behavior of elfutils's eu-strip, which
3884 # leaves the symtab in the original file only. There's no way to get
3885 # objcopy or strip to remove the symbol table without also removing the
3886 # debugging sections, so this is as close as we can get.
3887 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
3888 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
3889 verbose "result is $result"
3890 verbose "output is $output"
3894 file delete "${debug_file}"
3895 file rename "${debug_file}-tmp" "${debug_file}"
3898 # Link the two previous output files together, adding the .gnu_debuglink
3899 # section to the stripped_file, containing a pointer to the debug_file,
3900 # save the new file in dest.
3901 # This will be the regular executable filename, in the usual location.
3902 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
3903 verbose "result is $result"
3904 verbose "output is $output"
3909 # Workaround PR binutils/10802:
3910 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3911 set perm [file attributes ${stripped_file} -permissions]
3912 file attributes ${dest} -permissions $perm
3917 # Test the output of GDB_COMMAND matches the pattern obtained
3918 # by concatenating all elements of EXPECTED_LINES. This makes
3919 # it possible to split otherwise very long string into pieces.
3920 # If third argument is not empty, it's used as the name of the
3921 # test to be printed on pass/fail.
3922 proc help_test_raw { gdb_command expected_lines args } {
3923 set message $gdb_command
3924 if [llength $args]>0 then {
3925 set message [lindex $args 0]
3927 set expected_output [join $expected_lines ""]
3928 gdb_test "${gdb_command}" "${expected_output}" $message
3931 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
3932 # are regular expressions that should match the beginning of output,
3933 # before the list of commands in that class. The presence of
3934 # command list and standard epilogue will be tested automatically.
3935 proc test_class_help { command_class expected_initial_lines args } {
3937 "List of commands\:.*\[\r\n\]+"
3938 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
3939 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
3940 "Command name abbreviations are allowed if unambiguous\."
3942 set l_entire_body [concat $expected_initial_lines $l_stock_body]
3944 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
3947 # COMMAND_LIST should have either one element -- command to test, or
3948 # two elements -- abbreviated command to test, and full command the first
3949 # element is abbreviation of.
3950 # The command must be a prefix command. EXPECTED_INITIAL_LINES
3951 # are regular expressions that should match the beginning of output,
3952 # before the list of subcommands. The presence of
3953 # subcommand list and standard epilogue will be tested automatically.
3954 proc test_prefix_command_help { command_list expected_initial_lines args } {
3955 set command [lindex $command_list 0]
3956 if {[llength $command_list]>1} {
3957 set full_command [lindex $command_list 1]
3959 set full_command $command
3961 # Use 'list' and not just {} because we want variables to
3962 # be expanded in this list.
3963 set l_stock_body [list\
3964 "List of $full_command subcommands\:.*\[\r\n\]+"\
3965 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
3966 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
3967 "Command name abbreviations are allowed if unambiguous\."]
3968 set l_entire_body [concat $expected_initial_lines $l_stock_body]
3969 if {[llength $args]>0} {
3970 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
3972 help_test_raw "help ${command}" $l_entire_body
3976 # Build executable named EXECUTABLE from specifications that allow
3977 # different options to be passed to different sub-compilations.
3978 # TESTNAME is the name of the test; this is passed to 'untested' if
3980 # OPTIONS is passed to the final link, using gdb_compile.
3981 # ARGS is a flat list of source specifications, of the form:
3982 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
3983 # Each SOURCE is compiled to an object file using its OPTIONS,
3984 # using gdb_compile.
3985 # Returns 0 on success, -1 on failure.
3986 proc build_executable_from_specs {testname executable options args} {
3990 set binfile [standard_output_file $executable]
3994 foreach {s local_options} $args {
3995 if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $local_options] != "" } {
3999 lappend objects "${binfile}${i}.o"
4003 if { [gdb_compile $objects "${binfile}" executable $options] != "" } {
4009 if { [lsearch -exact $options "c++"] >= 0 } {
4010 set info_options "c++"
4012 if [get_compiler_info ${info_options}] {
4018 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4019 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4020 # to pass to untested, if something is wrong. OPTIONS are passed
4021 # to gdb_compile directly.
4022 proc build_executable { testname executable {sources ""} {options {debug}} } {
4023 if {[llength $sources]==0} {
4024 set sources ${executable}.c
4027 set arglist [list $testname $executable $options]
4028 foreach source $sources {
4029 lappend arglist $source $options
4032 return [eval build_executable_from_specs $arglist]
4035 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
4036 # the basename of the binary.
4037 proc clean_restart { executable } {
4040 set binfile [standard_output_file ${executable}]
4044 gdb_reinitialize_dir $srcdir/$subdir
4048 # Prepares for testing by calling build_executable_full, then
4050 # TESTNAME is the name of the test.
4051 # Each element in ARGS is a list of the form
4052 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
4053 # These are passed to build_executable_from_specs, which see.
4054 # The last EXECUTABLE is passed to clean_restart.
4055 # Returns 0 on success, non-zero on failure.
4056 proc prepare_for_testing_full {testname args} {
4057 foreach spec $args {
4058 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4061 set executable [lindex $spec 0]
4063 clean_restart $executable
4067 # Prepares for testing, by calling build_executable, and then clean_restart.
4068 # Please refer to build_executable for parameter description.
4069 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4071 if {[build_executable $testname $executable $sources $options] == -1} {
4074 clean_restart $executable
4079 proc get_valueof { fmt exp default } {
4082 set test "get valueof \"${exp}\""
4084 gdb_test_multiple "print${fmt} ${exp}" "$test" {
4085 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4086 set val $expect_out(1,string)
4090 fail "$test (timeout)"
4096 proc get_integer_valueof { exp default } {
4099 set test "get integer valueof \"${exp}\""
4101 gdb_test_multiple "print /d ${exp}" "$test" {
4102 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4103 set val $expect_out(1,string)
4107 fail "$test (timeout)"
4113 proc get_hexadecimal_valueof { exp default } {
4115 send_gdb "print /x ${exp}\n"
4116 set test "get hexadecimal valueof \"${exp}\""
4118 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4119 set val $expect_out(1,string)
4124 fail "$test (timeout)"
4130 proc get_sizeof { type default } {
4131 return [get_integer_valueof "sizeof (${type})" $default]
4134 # Get the current value for remotetimeout and return it.
4135 proc get_remotetimeout { } {
4139 gdb_test_multiple "show remotetimeout" "" {
4140 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
4141 return $expect_out(1,string)
4145 # Pick the default that gdb uses
4146 warning "Unable to read remotetimeout"
4150 # Set the remotetimeout to the specified timeout. Nothing is returned.
4151 proc set_remotetimeout { timeout } {
4154 gdb_test_multiple "set remotetimeout $timeout" "" {
4155 -re "$gdb_prompt $" {
4156 verbose "Set remotetimeout to $timeout\n"
4161 # Log gdb command line and script if requested.
4162 if {[info exists TRANSCRIPT]} {
4163 rename send_gdb real_send_gdb
4164 rename remote_spawn real_remote_spawn
4165 rename remote_close real_remote_close
4167 global gdb_transcript
4168 set gdb_transcript ""
4170 global gdb_trans_count
4171 set gdb_trans_count 1
4173 proc remote_spawn {args} {
4174 global gdb_transcript gdb_trans_count outdir
4176 if {$gdb_transcript != ""} {
4177 close $gdb_transcript
4179 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
4180 puts $gdb_transcript [lindex $args 1]
4181 incr gdb_trans_count
4183 return [uplevel real_remote_spawn $args]
4186 proc remote_close {args} {
4187 global gdb_transcript
4189 if {$gdb_transcript != ""} {
4190 close $gdb_transcript
4191 set gdb_transcript ""
4194 return [uplevel real_remote_close $args]
4197 proc send_gdb {args} {
4198 global gdb_transcript
4200 if {$gdb_transcript != ""} {
4201 puts -nonewline $gdb_transcript [lindex $args 0]
4204 return [uplevel real_send_gdb $args]
4208 proc core_find {binfile {deletefiles {}} {arg ""}} {
4209 global objdir subdir
4211 set destcore "$binfile.core"
4212 file delete $destcore
4214 # Create a core file named "$destcore" rather than just "core", to
4215 # avoid problems with sys admin types that like to regularly prune all
4216 # files named "core" from the system.
4218 # Arbitrarily try setting the core size limit to "unlimited" since
4219 # this does not hurt on systems where the command does not work and
4220 # allows us to generate a core on systems where it does.
4222 # Some systems append "core" to the name of the program; others append
4223 # the name of the program to "core"; still others (like Linux, as of
4224 # May 2003) create cores named "core.PID". In the latter case, we
4225 # could have many core files lying around, and it may be difficult to
4226 # tell which one is ours, so let's run the program in a subdirectory.
4228 set coredir [standard_output_file coredir.[getpid]]
4230 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
4231 # remote_exec host "${binfile}"
4232 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
4233 if [remote_file build exists $i] {
4234 remote_exec build "mv $i $destcore"
4238 # Check for "core.PID".
4239 if { $found == 0 } {
4240 set names [glob -nocomplain -directory $coredir core.*]
4241 if {[llength $names] == 1} {
4242 set corefile [file join $coredir [lindex $names 0]]
4243 remote_exec build "mv $corefile $destcore"
4247 if { $found == 0 } {
4248 # The braindamaged HPUX shell quits after the ulimit -c above
4249 # without executing ${binfile}. So we try again without the
4250 # ulimit here if we didn't find a core file above.
4251 # Oh, I should mention that any "braindamaged" non-Unix system has
4252 # the same problem. I like the cd bit too, it's really neat'n stuff.
4253 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
4254 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
4255 if [remote_file build exists $i] {
4256 remote_exec build "mv $i $destcore"
4262 # Try to clean up after ourselves.
4263 foreach deletefile $deletefiles {
4264 remote_file build delete [file join $coredir $deletefile]
4266 remote_exec build "rmdir $coredir"
4268 if { $found == 0 } {
4269 warning "can't generate a core file - core tests suppressed - check ulimit -c"
4275 # gdb_target_symbol_prefix_flags returns a string that can be added
4276 # to gdb_compile options to define SYMBOL_PREFIX macro value
4277 # symbol_prefix_flags returns a string that can be added
4278 # for targets that use underscore as symbol prefix.
4279 # TODO: find out automatically if the target needs this.
4281 proc gdb_target_symbol_prefix_flags {} {
4282 if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"]
4283 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
4284 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
4290 # Always load compatibility stuff.