1 # Copyright 1992-2018 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Fred Fish. (fnf@cygnus.com)
18 # Generic gdb subroutines that should work for any target. If these
19 # need to be modified for any target, it can be done with a variable
20 # or by passing arguments.
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
30 load_lib gdb-utils.exp
35 # The spawn ID used for I/O interaction with the inferior. For native
36 # targets, or remote targets that can do I/O through GDB
37 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
39 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
40 # so input/output is done on gdbserver's tty.
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
50 set GDB [transform gdb]
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
61 if ![info exists GDBFLAGS] {
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
77 # but it's not clear what removing one of them will break.
78 # See with_gdb_prompt for more details on prompt handling.
80 if ![info exists gdb_prompt] then {
81 set gdb_prompt "\\(gdb\\)"
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt [string_to_regexp "---Type <return> to continue, or q <return> to quit---"]
87 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
88 # absolute path ie. /foo/
89 set fullname_syntax_POSIX {/[^\n]*/}
90 # The variable fullname_syntax_UNC is a regexp which matches a Windows
91 # UNC path ie. \\D\foo\
92 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
93 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
94 # particular DOS case that GDB most likely will output
95 # ie. \foo\, but don't match \\.*\
96 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
97 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
98 # ie. a:\foo\ && a:foo\
99 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
100 # The variable fullname_syntax is a regexp which matches what GDB considers
101 # an absolute path. It is currently debatable if the Windows style paths
102 # d:foo and \abc should be considered valid as an absolute path.
103 # Also, the purpse of this regexp is not to recognize a well formed
104 # absolute path, but to say with certainty that a path is absolute.
105 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
107 # Needed for some tests under Cygwin.
111 if ![info exists env(EXEEXT)] {
114 set EXEEXT $env(EXEEXT)
119 set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
121 # A regular expression that matches a value history number.
123 set valnum_re "\\\$$decimal"
125 ### Only procedures should come after this point.
128 # gdb_version -- extract and print the version number of GDB
130 proc default_gdb_version {} {
132 global INTERNAL_GDBFLAGS GDBFLAGS
136 if {[info exists inotify_pid]} {
137 eval exec kill $inotify_pid
140 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
141 set tmp [lindex $output 1]
143 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
144 if ![is_remote host] {
145 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
147 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
151 proc gdb_version { } {
152 return [default_gdb_version]
156 # gdb_unload -- unload a file if one is loaded
157 # Return 0 on success, -1 on error.
166 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
167 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
172 -re "Discard symbol table from .*y or n.*$" {
176 -re "$gdb_prompt $" {}
178 perror "couldn't unload file in $GDB (timeout)."
185 # Many of the tests depend on setting breakpoints at various places and
186 # running until that breakpoint is reached. At times, we want to start
187 # with a clean-slate with respect to breakpoints, so this utility proc
188 # lets us do this without duplicating this code everywhere.
191 proc delete_breakpoints {} {
194 # we need a larger timeout value here or this thing just confuses
195 # itself. May need a better implementation if possible. - guo
199 set msg "delete all breakpoints in delete_breakpoints"
201 gdb_test_multiple "delete breakpoints" "$msg" {
202 -re "Delete all breakpoints.*y or n.*$" {
206 -re "$gdb_prompt $" {
212 # Confirm with "info breakpoints".
214 set msg "info breakpoints"
215 gdb_test_multiple $msg $msg {
216 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
219 -re "$gdb_prompt $" {
225 perror "breakpoints not deleted"
229 # Returns true iff the target supports using the "run" command.
231 proc target_can_use_run_cmd {} {
232 if [target_info exists use_gdb_stub] {
233 # In this case, when we connect, the inferior is already
242 # Generic run command.
244 # The second pattern below matches up to the first newline *only*.
245 # Using ``.*$'' could swallow up output that we attempt to match
248 # N.B. This function does not wait for gdb to return to the prompt,
249 # that is the caller's responsibility.
251 proc gdb_run_cmd {args} {
252 global gdb_prompt use_gdb_stub
254 foreach command [gdb_init_commands] {
255 send_gdb "$command\n"
257 -re "$gdb_prompt $" { }
259 perror "gdb_init_command for target failed"
266 if [target_info exists gdb,do_reload_on_run] {
267 if { [gdb_reload] != 0 } {
270 send_gdb "continue\n"
272 -re "Continu\[^\r\n\]*\[\r\n\]" {}
278 if [target_info exists gdb,start_symbol] {
279 set start [target_info gdb,start_symbol]
283 send_gdb "jump *$start\n"
285 while { $start_attempt } {
286 # Cap (re)start attempts at three to ensure that this loop
287 # always eventually fails. Don't worry about trying to be
288 # clever and not send a command when it has failed.
289 if [expr $start_attempt > 3] {
290 perror "Jump to start() failed (retry count exceeded)"
293 set start_attempt [expr $start_attempt + 1]
295 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
298 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
299 perror "Can't find start symbol to run in gdb_run"
302 -re "No symbol \"start\" in current.*$gdb_prompt $" {
303 send_gdb "jump *_start\n"
305 -re "No symbol.*context.*$gdb_prompt $" {
308 -re "Line.* Jump anyway.*y or n. $" {
311 -re "The program is not being run.*$gdb_prompt $" {
312 if { [gdb_reload] != 0 } {
315 send_gdb "jump *$start\n"
318 perror "Jump to start() failed (timeout)"
326 if [target_info exists gdb,do_reload_on_run] {
327 if { [gdb_reload] != 0 } {
331 send_gdb "run $args\n"
332 # This doesn't work quite right yet.
333 # Use -notransfer here so that test cases (like chng-sym.exp)
334 # may test for additional start-up messages.
336 -re "The program .* has been started already.*y or n. $" {
340 -notransfer -re "Starting program: \[^\r\n\]*" {}
341 -notransfer -re "$gdb_prompt $" {
342 # There is no more input expected.
347 # Generic start command. Return 0 if we could start the program, -1
350 # N.B. This function does not wait for gdb to return to the prompt,
351 # that is the caller's responsibility.
353 proc gdb_start_cmd {args} {
354 global gdb_prompt use_gdb_stub
356 foreach command [gdb_init_commands] {
357 send_gdb "$command\n"
359 -re "$gdb_prompt $" { }
361 perror "gdb_init_command for target failed"
371 send_gdb "start $args\n"
372 # Use -notransfer here so that test cases (like chng-sym.exp)
373 # may test for additional start-up messages.
375 -re "The program .* has been started already.*y or n. $" {
379 -notransfer -re "Starting program: \[^\r\n\]*" {
386 # Generic starti command. Return 0 if we could start the program, -1
389 # N.B. This function does not wait for gdb to return to the prompt,
390 # that is the caller's responsibility.
392 proc gdb_starti_cmd {args} {
393 global gdb_prompt use_gdb_stub
395 foreach command [gdb_init_commands] {
396 send_gdb "$command\n"
398 -re "$gdb_prompt $" { }
400 perror "gdb_init_command for target failed"
410 send_gdb "starti $args\n"
412 -re "The program .* has been started already.*y or n. $" {
416 -re "Starting program: \[^\r\n\]*" {
423 # Set a breakpoint at FUNCTION. If there is an additional argument it is
424 # a list of options; the supported options are allow-pending, temporary,
425 # message, no-message, passfail and qualified.
426 # The result is 1 for success, 0 for failure.
428 # Note: The handling of message vs no-message is messed up, but it's based
429 # on historical usage. By default this function does not print passes,
431 # no-message: turns off printing of fails (and passes, but they're already off)
432 # message: turns on printing of passes (and fails, but they're already on)
434 proc gdb_breakpoint { function args } {
438 set pending_response n
439 if {[lsearch -exact $args allow-pending] != -1} {
440 set pending_response y
443 set break_command "break"
444 set break_message "Breakpoint"
445 if {[lsearch -exact $args temporary] != -1} {
446 set break_command "tbreak"
447 set break_message "Temporary breakpoint"
450 if {[lsearch -exact $args qualified] != -1} {
451 append break_command " -qualified"
456 set no_message_loc [lsearch -exact $args no-message]
457 set message_loc [lsearch -exact $args message]
458 # The last one to appear in args wins.
459 if { $no_message_loc > $message_loc } {
461 } elseif { $message_loc > $no_message_loc } {
465 set test_name "setting breakpoint at $function"
467 send_gdb "$break_command $function\n"
468 # The first two regexps are what we get with -g, the third is without -g.
470 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
471 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
472 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
473 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
474 if {$pending_response == "n"} {
481 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
482 send_gdb "$pending_response\n"
485 -re "A problem internal to GDB has been detected" {
487 fail "$test_name (GDB internal error)"
489 gdb_internal_error_resync
492 -re "$gdb_prompt $" {
500 fail "$test_name (eof)"
506 fail "$test_name (timeout)"
517 # Set breakpoint at function and run gdb until it breaks there.
518 # Since this is the only breakpoint that will be set, if it stops
519 # at a breakpoint, we will assume it is the one we want. We can't
520 # just compare to "function" because it might be a fully qualified,
521 # single quoted C++ function specifier.
523 # If there are additional arguments, pass them to gdb_breakpoint.
524 # We recognize no-message/message ourselves.
525 # The default is no-message.
526 # no-message is messed up here, like gdb_breakpoint: to preserve
527 # historical usage fails are always printed by default.
528 # no-message: turns off printing of fails (and passes, but they're already off)
529 # message: turns on printing of passes (and fails, but they're already on)
531 proc runto { function args } {
537 # Default to "no-message".
538 set args "no-message $args"
542 set no_message_loc [lsearch -exact $args no-message]
543 set message_loc [lsearch -exact $args message]
544 # The last one to appear in args wins.
545 if { $no_message_loc > $message_loc } {
547 } elseif { $message_loc > $no_message_loc } {
551 set test_name "running to $function in runto"
553 # We need to use eval here to pass our varargs args to gdb_breakpoint
554 # which is also a varargs function.
555 # But we also have to be careful because $function may have multiple
556 # elements, and we don't want Tcl to move the remaining elements after
557 # the first to $args. That is why $function is wrapped in {}.
558 if ![eval gdb_breakpoint {$function} $args] {
564 # the "at foo.c:36" output we get with -g.
565 # the "in func" output we get without -g.
567 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
573 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
579 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
581 unsupported "non-stop mode not supported"
585 -re ".*A problem internal to GDB has been detected" {
587 fail "$test_name (GDB internal error)"
589 gdb_internal_error_resync
592 -re "$gdb_prompt $" {
600 fail "$test_name (eof)"
606 fail "$test_name (timeout)"
617 # Ask gdb to run until we hit a breakpoint at main.
619 # N.B. This function deletes all existing breakpoints.
620 # If you don't want that, use gdb_start_cmd.
622 proc runto_main { } {
623 return [runto main no-message]
626 ### Continue, and expect to hit a breakpoint.
627 ### Report a pass or fail, depending on whether it seems to have
628 ### worked. Use NAME as part of the test name; each call to
629 ### continue_to_breakpoint should use a NAME which is unique within
631 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
633 set full_name "continue to breakpoint: $name"
635 gdb_test_multiple "continue" $full_name {
636 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
643 # gdb_internal_error_resync:
645 # Answer the questions GDB asks after it reports an internal error
646 # until we get back to a GDB prompt. Decline to quit the debugging
647 # session, and decline to create a core file. Return non-zero if the
650 # This procedure just answers whatever questions come up until it sees
651 # a GDB prompt; it doesn't require you to have matched the input up to
652 # any specific point. However, it only answers questions it sees in
653 # the output itself, so if you've matched a question, you had better
654 # answer it yourself before calling this.
656 # You can use this function thus:
660 # -re ".*A problem internal to GDB has been detected" {
661 # gdb_internal_error_resync
666 proc gdb_internal_error_resync {} {
669 verbose -log "Resyncing due to internal error."
672 while {$count < 10} {
674 -re "Quit this debugging session\\? \\(y or n\\) $" {
678 -re "Create a core file of GDB\\? \\(y or n\\) $" {
682 -re "$gdb_prompt $" {
683 # We're resynchronized.
687 perror "Could not resync from internal error (timeout)"
692 perror "Could not resync from internal error (resync count exceeded)"
697 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
698 # Send a command to gdb; test the result.
700 # COMMAND is the command to execute, send to GDB with send_gdb. If
701 # this is the null string no command is sent.
702 # MESSAGE is a message to be printed with the built-in failure patterns
703 # if one of them matches. If MESSAGE is empty COMMAND will be used.
704 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
705 # patterns. Pattern elements will be evaluated in the caller's
706 # context; action elements will be executed in the caller's context.
707 # Unlike patterns for gdb_test, these patterns should generally include
708 # the final newline and prompt.
711 # 1 if the test failed, according to a built-in failure pattern
712 # 0 if only user-supplied patterns matched
713 # -1 if there was an internal error.
715 # You can use this function thus:
717 # gdb_test_multiple "print foo" "test foo" {
718 # -re "expected output 1" {
721 # -re "expected output 2" {
726 # Like with "expect", you can also specify the spawn id to match with
727 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
728 # $gdb_spawn_id. The former matches inferior I/O, while the latter
729 # matches GDB I/O. E.g.:
731 # send_inferior "hello\n"
732 # gdb_test_multiple "continue" "test echo" {
733 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
736 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
737 # fail "hit breakpoint"
741 # The standard patterns, such as "Inferior exited..." and "A problem
742 # ...", all being implicitly appended to that list. These are always
743 # expected from $gdb_spawn_id. IOW, callers do not need to worry
744 # about resetting "-i" back to $gdb_spawn_id explicitly.
746 proc gdb_test_multiple { command message user_code } {
747 global verbose use_gdb_stub
748 global gdb_prompt pagination_prompt
751 global inferior_exited_re
752 upvar timeout timeout
753 upvar expect_out expect_out
756 if { $message == "" } {
760 if [string match "*\[\r\n\]" $command] {
761 error "Invalid trailing newline in \"$message\" test"
764 if [string match "*\[\r\n\]*" $message] {
765 error "Invalid newline in \"$message\" test"
769 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
771 error "gdbserver does not support $command without extended-remote"
774 # TCL/EXPECT WART ALERT
775 # Expect does something very strange when it receives a single braced
776 # argument. It splits it along word separators and performs substitutions.
777 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
778 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
779 # double-quoted list item, "\[ab\]" is just a long way of representing
780 # "[ab]", because the backslashes will be removed by lindex.
782 # Unfortunately, there appears to be no easy way to duplicate the splitting
783 # that expect will do from within TCL. And many places make use of the
784 # "\[0-9\]" construct, so we need to support that; and some places make use
785 # of the "[func]" construct, so we need to support that too. In order to
786 # get this right we have to substitute quoted list elements differently
787 # from braced list elements.
789 # We do this roughly the same way that Expect does it. We have to use two
790 # lists, because if we leave unquoted newlines in the argument to uplevel
791 # they'll be treated as command separators, and if we escape newlines
792 # we mangle newlines inside of command blocks. This assumes that the
793 # input doesn't contain a pattern which contains actual embedded newlines
796 regsub -all {\n} ${user_code} { } subst_code
797 set subst_code [uplevel list $subst_code]
799 set processed_code ""
801 set expecting_action 0
803 foreach item $user_code subst_item $subst_code {
804 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
805 lappend processed_code $item
808 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
809 lappend processed_code $item
812 if { $item == "-timeout" || $item == "-i" } {
814 lappend processed_code $item
817 if { $expecting_arg } {
819 lappend processed_code $subst_item
822 if { $expecting_action } {
823 lappend processed_code "uplevel [list $item]"
824 set expecting_action 0
825 # Cosmetic, no effect on the list.
826 append processed_code "\n"
829 set expecting_action 1
830 lappend processed_code $subst_item
831 if {$patterns != ""} {
834 append patterns "\"$subst_item\""
837 # Also purely cosmetic.
838 regsub -all {\r} $patterns {\\r} patterns
839 regsub -all {\n} $patterns {\\n} patterns
842 send_user "Sending \"$command\" to gdb\n"
843 send_user "Looking to match \"$patterns\"\n"
844 send_user "Message is \"$message\"\n"
848 set string "${command}\n"
849 if { $command != "" } {
850 set multi_line_re "\[\r\n\] *>"
851 while { "$string" != "" } {
852 set foo [string first "\n" "$string"]
853 set len [string length "$string"]
854 if { $foo < [expr $len - 1] } {
855 set str [string range "$string" 0 $foo]
856 if { [send_gdb "$str"] != "" } {
859 if { ! $suppress_flag } {
860 perror "Couldn't send $command to GDB."
865 # since we're checking if each line of the multi-line
866 # command are 'accepted' by GDB here,
867 # we need to set -notransfer expect option so that
868 # command output is not lost for pattern matching
871 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
872 timeout { verbose "partial: timeout" 3 }
874 set string [string range "$string" [expr $foo + 1] end]
875 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
880 if { "$string" != "" } {
881 if { [send_gdb "$string"] != "" } {
884 if { ! $suppress_flag } {
885 perror "Couldn't send $command to GDB."
894 -re ".*A problem internal to GDB has been detected" {
895 fail "$message (GDB internal error)"
896 gdb_internal_error_resync
899 -re "\\*\\*\\* DOSEXIT code.*" {
900 if { $message != "" } {
903 gdb_suppress_entire_file "GDB died"
907 append code $processed_code
909 # Reset the spawn id, in case the processed code used -i.
912 -re "Ending remote debugging.*$gdb_prompt $" {
913 if ![isnative] then {
914 warning "Can`t communicate to remote target."
920 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
921 perror "Undefined command \"$command\"."
925 -re "Ambiguous command.*$gdb_prompt $" {
926 perror "\"$command\" is not a unique command name."
930 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
931 if ![string match "" $message] then {
932 set errmsg "$message (the program exited)"
934 set errmsg "$command (the program exited)"
939 -re "$inferior_exited_re normally.*$gdb_prompt $" {
940 if ![string match "" $message] then {
941 set errmsg "$message (the program exited)"
943 set errmsg "$command (the program exited)"
948 -re "The program is not being run.*$gdb_prompt $" {
949 if ![string match "" $message] then {
950 set errmsg "$message (the program is no longer running)"
952 set errmsg "$command (the program is no longer running)"
957 -re "\r\n$gdb_prompt $" {
958 if ![string match "" $message] then {
963 -re "$pagination_prompt" {
965 perror "Window too small."
969 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
971 gdb_expect -re "$gdb_prompt $"
972 fail "$message (got interactive prompt)"
975 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
977 gdb_expect -re "$gdb_prompt $"
978 fail "$message (got breakpoint menu)"
982 # Patterns below apply to any spawn id specified.
985 perror "Process no longer exists"
986 if { $message != "" } {
992 perror "internal buffer is full."
997 if ![string match "" $message] then {
998 fail "$message (timeout)"
1005 set code [catch {gdb_expect $code} string]
1007 global errorInfo errorCode
1008 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1009 } elseif {$code > 1} {
1010 return -code $code $string
1015 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1016 # Send a command to gdb; test the result.
1018 # COMMAND is the command to execute, send to GDB with send_gdb. If
1019 # this is the null string no command is sent.
1020 # PATTERN is the pattern to match for a PASS, and must NOT include
1021 # the \r\n sequence immediately before the gdb prompt. This argument
1022 # may be omitted to just match the prompt, ignoring whatever output
1024 # MESSAGE is an optional message to be printed. If this is
1025 # omitted, then the pass/fail messages use the command string as the
1026 # message. (If this is the empty string, then sometimes we don't
1027 # call pass or fail at all; I don't understand this at all.)
1028 # QUESTION is a question GDB may ask in response to COMMAND, like
1030 # RESPONSE is the response to send if QUESTION appears.
1033 # 1 if the test failed,
1034 # 0 if the test passes,
1035 # -1 if there was an internal error.
1037 proc gdb_test { args } {
1039 upvar timeout timeout
1041 if [llength $args]>2 then {
1042 set message [lindex $args 2]
1044 set message [lindex $args 0]
1046 set command [lindex $args 0]
1047 set pattern [lindex $args 1]
1049 if [llength $args]==5 {
1050 set question_string [lindex $args 3]
1051 set response_string [lindex $args 4]
1053 set question_string "^FOOBAR$"
1056 return [gdb_test_multiple $command $message {
1057 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1058 if ![string match "" $message] then {
1062 -re "(${question_string})$" {
1063 send_gdb "$response_string\n"
1069 # gdb_test_no_output COMMAND MESSAGE
1070 # Send a command to GDB and verify that this command generated no output.
1072 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1073 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1074 # the message. (If MESSAGE is the empty string, then sometimes we do not
1075 # call pass or fail at all; I don't understand this at all.)
1077 proc gdb_test_no_output { args } {
1079 set command [lindex $args 0]
1080 if [llength $args]>1 then {
1081 set message [lindex $args 1]
1083 set message $command
1086 set command_regex [string_to_regexp $command]
1087 gdb_test_multiple $command $message {
1088 -re "^$command_regex\r\n$gdb_prompt $" {
1089 if ![string match "" $message] then {
1096 # Send a command and then wait for a sequence of outputs.
1097 # This is useful when the sequence is long and contains ".*", a single
1098 # regexp to match the entire output can get a timeout much easier.
1100 # COMMAND is the command to execute, send to GDB with send_gdb. If
1101 # this is the null string no command is sent.
1102 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1103 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1104 # processed in order, and all must be present in the output.
1106 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1107 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1108 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1110 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1111 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1114 # 1 if the test failed,
1115 # 0 if the test passes,
1116 # -1 if there was an internal error.
1118 proc gdb_test_sequence { command test_name expected_output_list } {
1120 if { $test_name == "" } {
1121 set test_name $command
1123 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1124 if { $command != "" } {
1125 send_gdb "$command\n"
1127 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1131 # Test that a command gives an error. For pass or fail, return
1132 # a 1 to indicate that more tests can proceed. However a timeout
1133 # is a serious error, generates a special fail message, and causes
1134 # a 0 to be returned to indicate that more tests are likely to fail
1137 proc test_print_reject { args } {
1141 if [llength $args]==2 then {
1142 set expectthis [lindex $args 1]
1144 set expectthis "should never match this bogus string"
1146 set sendthis [lindex $args 0]
1147 if $verbose>2 then {
1148 send_user "Sending \"$sendthis\" to gdb\n"
1149 send_user "Looking to match \"$expectthis\"\n"
1151 send_gdb "$sendthis\n"
1152 #FIXME: Should add timeout as parameter.
1154 -re "A .* in expression.*\\.*$gdb_prompt $" {
1155 pass "reject $sendthis"
1158 -re "Invalid syntax in expression.*$gdb_prompt $" {
1159 pass "reject $sendthis"
1162 -re "Junk after end of expression.*$gdb_prompt $" {
1163 pass "reject $sendthis"
1166 -re "Invalid number.*$gdb_prompt $" {
1167 pass "reject $sendthis"
1170 -re "Invalid character constant.*$gdb_prompt $" {
1171 pass "reject $sendthis"
1174 -re "No symbol table is loaded.*$gdb_prompt $" {
1175 pass "reject $sendthis"
1178 -re "No symbol .* in current context.*$gdb_prompt $" {
1179 pass "reject $sendthis"
1182 -re "Unmatched single quote.*$gdb_prompt $" {
1183 pass "reject $sendthis"
1186 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1187 pass "reject $sendthis"
1190 -re "$expectthis.*$gdb_prompt $" {
1191 pass "reject $sendthis"
1194 -re ".*$gdb_prompt $" {
1195 fail "reject $sendthis"
1199 fail "reject $sendthis (eof or timeout)"
1206 # Same as gdb_test, but the second parameter is not a regexp,
1207 # but a string that must match exactly.
1209 proc gdb_test_exact { args } {
1210 upvar timeout timeout
1212 set command [lindex $args 0]
1214 # This applies a special meaning to a null string pattern. Without
1215 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1216 # messages from commands that should have no output except a new
1217 # prompt. With this, only results of a null string will match a null
1220 set pattern [lindex $args 1]
1221 if [string match $pattern ""] {
1222 set pattern [string_to_regexp [lindex $args 0]]
1224 set pattern [string_to_regexp [lindex $args 1]]
1227 # It is most natural to write the pattern argument with only
1228 # embedded \n's, especially if you are trying to avoid Tcl quoting
1229 # problems. But gdb_expect really wants to see \r\n in patterns. So
1230 # transform the pattern here. First transform \r\n back to \n, in
1231 # case some users of gdb_test_exact already do the right thing.
1232 regsub -all "\r\n" $pattern "\n" pattern
1233 regsub -all "\n" $pattern "\r\n" pattern
1234 if [llength $args]==3 then {
1235 set message [lindex $args 2]
1237 set message $command
1240 return [gdb_test $command $pattern $message]
1243 # Wrapper around gdb_test_multiple that looks for a list of expected
1244 # output elements, but which can appear in any order.
1245 # CMD is the gdb command.
1246 # NAME is the name of the test.
1247 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1249 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1250 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1251 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1253 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1254 # of text per element and then strip trailing \r\n's.
1256 # gdb_test_list_exact "foo" "bar" \
1257 # "\[^\r\n\]+\[\r\n\]+" \
1260 # {expected result 1} \
1261 # {expected result 2} \
1264 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1267 set matches [lsort $result_match_list]
1269 gdb_test_multiple $cmd $name {
1270 "$cmd\[\r\n\]" { exp_continue }
1271 -re $elm_find_regexp {
1272 set str $expect_out(0,string)
1273 verbose -log "seen: $str" 3
1274 regexp -- $elm_extract_regexp $str elm_seen
1275 verbose -log "extracted: $elm_seen" 3
1276 lappend seen $elm_seen
1279 -re "$gdb_prompt $" {
1281 foreach got [lsort $seen] have $matches {
1282 if {![string equal $got $have]} {
1287 if {[string length $failed] != 0} {
1288 fail "$name ($failed not found)"
1296 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1297 # Send a command to gdb; expect inferior and gdb output.
1299 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1302 # INFERIOR_PATTERN is the pattern to match against inferior output.
1304 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1305 # include the \r\n sequence immediately before the gdb prompt, nor the
1306 # prompt. The default is empty.
1308 # Both inferior and gdb patterns must match for a PASS.
1310 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1313 # 1 if the test failed,
1314 # 0 if the test passes,
1315 # -1 if there was an internal error.
1318 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1319 global inferior_spawn_id gdb_spawn_id
1322 if {$message == ""} {
1323 set message $command
1326 set inferior_matched 0
1329 # Use an indirect spawn id list, and remove the inferior spawn id
1330 # from the expected output as soon as it matches, in case
1331 # $inferior_pattern happens to be a prefix of the resulting full
1332 # gdb pattern below (e.g., "\r\n").
1333 global gdb_test_stdio_spawn_id_list
1334 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1336 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1337 # then we may see gdb's output arriving before the inferior's
1339 set res [gdb_test_multiple $command $message {
1340 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1341 set inferior_matched 1
1342 if {!$gdb_matched} {
1343 set gdb_test_stdio_spawn_id_list ""
1347 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1349 if {!$inferior_matched} {
1357 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1364 # Issue a PASS and return true if evaluating CONDITION in the caller's
1365 # frame returns true, and issue a FAIL and return false otherwise.
1366 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1367 # omitted or is empty, then the pass/fail messages use the condition
1368 # string as the message.
1370 proc gdb_assert { condition {message ""} } {
1371 if { $message == ""} {
1372 set message $condition
1375 set res [uplevel 1 expr $condition]
1384 proc gdb_reinitialize_dir { subdir } {
1387 if [is_remote host] {
1392 -re "Reinitialize source path to empty.*y or n. " {
1395 -re "Source directories searched.*$gdb_prompt $" {
1396 send_gdb "dir $subdir\n"
1398 -re "Source directories searched.*$gdb_prompt $" {
1399 verbose "Dir set to $subdir"
1401 -re "$gdb_prompt $" {
1402 perror "Dir \"$subdir\" failed."
1406 -re "$gdb_prompt $" {
1407 perror "Dir \"$subdir\" failed."
1411 -re "$gdb_prompt $" {
1412 perror "Dir \"$subdir\" failed."
1418 # gdb_exit -- exit the GDB, killing the target program if necessary
1420 proc default_gdb_exit {} {
1422 global INTERNAL_GDBFLAGS GDBFLAGS
1424 global gdb_spawn_id inferior_spawn_id
1425 global inotify_log_file
1427 gdb_stop_suppressing_tests
1429 if ![info exists gdb_spawn_id] {
1433 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1435 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1436 set fd [open $inotify_log_file]
1437 set data [read -nonewline $fd]
1440 if {[string compare $data ""] != 0} {
1441 warning "parallel-unsafe file creations noticed"
1444 set fd [open $inotify_log_file w]
1449 if { [is_remote host] && [board_info host exists fileid] } {
1456 -re "DOSEXIT code" { }
1461 if ![is_remote host] {
1465 unset inferior_spawn_id
1468 # Load a file into the debugger.
1469 # The return value is 0 for success, -1 for failure.
1471 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1472 # to one of these values:
1474 # debug file was loaded successfully and has debug information
1475 # nodebug file was loaded successfully and has no debug information
1476 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1478 # fail file was not loaded
1480 # I tried returning this information as part of the return value,
1481 # but ran into a mess because of the many re-implementations of
1482 # gdb_load in config/*.exp.
1484 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1485 # this if they can get more information set.
1487 proc gdb_file_cmd { arg } {
1491 global last_loaded_file
1493 # Save this for the benefit of gdbserver-support.exp.
1494 set last_loaded_file $arg
1496 # Set whether debug info was found.
1497 # Default to "fail".
1498 global gdb_file_cmd_debug_info
1499 set gdb_file_cmd_debug_info "fail"
1501 if [is_remote host] {
1502 set arg [remote_download host $arg]
1504 perror "download failed"
1509 # The file command used to kill the remote target. For the benefit
1510 # of the testsuite, preserve this behavior.
1513 -re "Kill the program being debugged. .y or n. $" {
1515 verbose "\t\tKilling previous program being debugged"
1518 -re "$gdb_prompt $" {
1523 send_gdb "file $arg\n"
1525 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1526 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1527 set gdb_file_cmd_debug_info "lzma"
1530 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1531 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1532 set gdb_file_cmd_debug_info "nodebug"
1535 -re "Reading symbols from.*done.*$gdb_prompt $" {
1536 verbose "\t\tLoaded $arg into $GDB"
1537 set gdb_file_cmd_debug_info "debug"
1540 -re "Load new symbol table from \".*\".*y or n. $" {
1543 -re "Reading symbols from.*done.*$gdb_prompt $" {
1544 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1545 set gdb_file_cmd_debug_info "debug"
1549 perror "Couldn't load $arg, other program already loaded (timeout)."
1553 perror "Couldn't load $arg, other program already loaded (eof)."
1558 -re "No such file or directory.*$gdb_prompt $" {
1559 perror "($arg) No such file or directory"
1562 -re "A problem internal to GDB has been detected" {
1563 fail "($arg) (GDB internal error)"
1564 gdb_internal_error_resync
1567 -re "$gdb_prompt $" {
1568 perror "Couldn't load $arg into $GDB."
1572 perror "Couldn't load $arg into $GDB (timeout)."
1576 # This is an attempt to detect a core dump, but seems not to
1577 # work. Perhaps we need to match .* followed by eof, in which
1578 # gdb_expect does not seem to have a way to do that.
1579 perror "Couldn't load $arg into $GDB (eof)."
1585 # Default gdb_spawn procedure.
1587 proc default_gdb_spawn { } {
1590 global INTERNAL_GDBFLAGS GDBFLAGS
1593 gdb_stop_suppressing_tests
1595 # Set the default value, it may be overriden later by specific testfile.
1597 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1598 # is already started after connecting and run/attach are not supported.
1599 # This is used for the "remote" protocol. After GDB starts you should
1600 # check global $use_gdb_stub instead of the board as the testfile may force
1601 # a specific different target protocol itself.
1602 set use_gdb_stub [target_info exists use_gdb_stub]
1604 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1606 if [info exists gdb_spawn_id] {
1610 if ![is_remote host] {
1611 if { [which $GDB] == 0 } then {
1612 perror "$GDB does not exist."
1616 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1617 if { $res < 0 || $res == "" } {
1618 perror "Spawning $GDB failed."
1622 set gdb_spawn_id $res
1626 # Default gdb_start procedure.
1628 proc default_gdb_start { } {
1629 global gdb_prompt pagination_prompt
1631 global inferior_spawn_id
1633 if [info exists gdb_spawn_id] {
1642 # Default to assuming inferior I/O is done on GDB's terminal.
1643 if {![info exists inferior_spawn_id]} {
1644 set inferior_spawn_id $gdb_spawn_id
1647 # When running over NFS, particularly if running many simultaneous
1648 # tests on different hosts all using the same server, things can
1649 # get really slow. Give gdb at least 3 minutes to start up.
1651 while { $loop_again } {
1654 -re "$pagination_prompt" {
1655 verbose "Hit pagination during startup. Pressing enter to continue."
1659 -re "\[\r\n\]$gdb_prompt $" {
1660 verbose "GDB initialized."
1662 -re "$gdb_prompt $" {
1663 perror "GDB never initialized."
1668 perror "(timeout) GDB never initialized after 10 seconds."
1676 # force the height to "unlimited", so no pagers get used
1678 send_gdb "set height 0\n"
1680 -re "$gdb_prompt $" {
1681 verbose "Setting height to 0." 2
1684 warning "Couldn't set the height to 0"
1687 # force the width to "unlimited", so no wraparound occurs
1688 send_gdb "set width 0\n"
1690 -re "$gdb_prompt $" {
1691 verbose "Setting width to 0." 2
1694 warning "Couldn't set the width to 0."
1700 # Utility procedure to give user control of the gdb prompt in a script. It is
1701 # meant to be used for debugging test cases, and should not be left in the
1704 proc gdb_interact { } {
1706 set spawn_id $gdb_spawn_id
1708 send_user "+------------------------------------------+\n"
1709 send_user "| Script interrupted, you can now interact |\n"
1710 send_user "| with by gdb. Type >>> to continue. |\n"
1711 send_user "+------------------------------------------+\n"
1718 # Examine the output of compilation to determine whether compilation
1719 # failed or not. If it failed determine whether it is due to missing
1720 # compiler or due to compiler error. Report pass, fail or unsupported
1723 proc gdb_compile_test {src output} {
1724 if { $output == "" } {
1725 pass "compilation [file tail $src]"
1726 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1727 unsupported "compilation [file tail $src]"
1728 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1729 unsupported "compilation [file tail $src]"
1730 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1731 unsupported "compilation [file tail $src]"
1733 verbose -log "compilation failed: $output" 2
1734 fail "compilation [file tail $src]"
1738 # Return a 1 for configurations for which we don't even want to try to
1741 proc skip_cplus_tests {} {
1742 if { [istarget "h8300-*-*"] } {
1746 # The C++ IO streams are too large for HC11/HC12 and are thus not
1747 # available. The gdb C++ tests use them and don't compile.
1748 if { [istarget "m6811-*-*"] } {
1751 if { [istarget "m6812-*-*"] } {
1757 # Return a 1 for configurations for which don't have both C++ and the STL.
1759 proc skip_stl_tests {} {
1760 # Symbian supports the C++ language, but the STL is missing
1761 # (both headers and libraries).
1762 if { [istarget "arm*-*-symbianelf*"] } {
1766 return [skip_cplus_tests]
1769 # Return a 1 if I don't even want to try to test FORTRAN.
1771 proc skip_fortran_tests {} {
1775 # Return a 1 if I don't even want to try to test ada.
1777 proc skip_ada_tests {} {
1781 # Return a 1 if I don't even want to try to test GO.
1783 proc skip_go_tests {} {
1787 # Return a 1 if I don't even want to try to test D.
1789 proc skip_d_tests {} {
1793 # Return 1 to skip Rust tests, 0 to try them.
1794 proc skip_rust_tests {} {
1795 return [expr {![isnative]}]
1798 # Return a 1 for configurations that do not support Python scripting.
1799 # PROMPT_REGEXP is the expected prompt.
1801 proc skip_python_tests_prompt { prompt_regexp } {
1802 global gdb_py_is_py3k
1803 global gdb_py_is_py24
1805 gdb_test_multiple "python print ('test')" "verify python support" {
1806 -re "not supported.*$prompt_regexp" {
1807 unsupported "Python support is disabled."
1810 -re "$prompt_regexp" {}
1813 set gdb_py_is_py24 0
1814 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1815 -re "3.*$prompt_regexp" {
1816 set gdb_py_is_py3k 1
1818 -re ".*$prompt_regexp" {
1819 set gdb_py_is_py3k 0
1822 if { $gdb_py_is_py3k == 0 } {
1823 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1824 -re "\[45\].*$prompt_regexp" {
1825 set gdb_py_is_py24 1
1827 -re ".*$prompt_regexp" {
1828 set gdb_py_is_py24 0
1836 # Return a 1 for configurations that do not support Python scripting.
1837 # Note: This also sets various globals that specify which version of Python
1838 # is in use. See skip_python_tests_prompt.
1840 proc skip_python_tests {} {
1842 return [skip_python_tests_prompt "$gdb_prompt $"]
1845 # Return a 1 if we should skip shared library tests.
1847 proc skip_shlib_tests {} {
1848 # Run the shared library tests on native systems.
1853 # An abbreviated list of remote targets where we should be able to
1854 # run shared library tests.
1855 if {([istarget *-*-linux*]
1856 || [istarget *-*-*bsd*]
1857 || [istarget *-*-solaris2*]
1858 || [istarget arm*-*-symbianelf*]
1859 || [istarget *-*-mingw*]
1860 || [istarget *-*-cygwin*]
1861 || [istarget *-*-pe*])} {
1868 # Return 1 if we should skip tui related tests.
1870 proc skip_tui_tests {} {
1873 gdb_test_multiple "help layout" "verify tui support" {
1874 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1877 -re "$gdb_prompt $" {
1884 # Test files shall make sure all the test result lines in gdb.sum are
1885 # unique in a test run, so that comparing the gdb.sum files of two
1886 # test runs gives correct results. Test files that exercise
1887 # variations of the same tests more than once, shall prefix the
1888 # different test invocations with different identifying strings in
1889 # order to make them unique.
1891 # About test prefixes:
1893 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1894 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1895 # underlined substring in
1897 # PASS: gdb.base/mytest.exp: some test
1898 # ^^^^^^^^^^^^^^^^^^^^
1902 # The easiest way to adjust the test prefix is to append a test
1903 # variation prefix to the $pf_prefix, using the with_test_prefix
1906 # proc do_tests {} {
1907 # gdb_test ... ... "test foo"
1908 # gdb_test ... ... "test bar"
1910 # with_test_prefix "subvariation a" {
1911 # gdb_test ... ... "test x"
1914 # with_test_prefix "subvariation b" {
1915 # gdb_test ... ... "test x"
1919 # with_test_prefix "variation1" {
1920 # ...do setup for variation 1...
1924 # with_test_prefix "variation2" {
1925 # ...do setup for variation 2...
1931 # PASS: gdb.base/mytest.exp: variation1: test foo
1932 # PASS: gdb.base/mytest.exp: variation1: test bar
1933 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1934 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1935 # PASS: gdb.base/mytest.exp: variation2: test foo
1936 # PASS: gdb.base/mytest.exp: variation2: test bar
1937 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1938 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1940 # If for some reason more flexibility is necessary, one can also
1941 # manipulate the pf_prefix global directly, treating it as a string.
1945 # set saved_pf_prefix
1946 # append pf_prefix "${foo}: bar"
1947 # ... actual tests ...
1948 # set pf_prefix $saved_pf_prefix
1951 # Run BODY in the context of the caller, with the current test prefix
1952 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1953 # Returns the result of BODY.
1955 proc with_test_prefix { prefix body } {
1958 set saved $pf_prefix
1959 append pf_prefix " " $prefix ":"
1960 set code [catch {uplevel 1 $body} result]
1961 set pf_prefix $saved
1964 global errorInfo errorCode
1965 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1967 return -code $code $result
1971 # Wrapper for foreach that calls with_test_prefix on each iteration,
1972 # including the iterator's name and current value in the prefix.
1974 proc foreach_with_prefix {var list body} {
1976 foreach myvar $list {
1977 with_test_prefix "$var=$myvar" {
1983 # Like TCL's native proc, but defines a procedure that wraps its body
1984 # within 'with_test_prefix "$proc_name" { ... }'.
1985 proc proc_with_prefix {name arguments body} {
1986 # Define the advertised proc.
1987 proc $name $arguments [list with_test_prefix $name $body]
1991 # Run BODY in the context of the caller. After BODY is run, the variables
1992 # listed in VARS will be reset to the values they had before BODY was run.
1994 # This is useful for providing a scope in which it is safe to temporarily
1995 # modify global variables, e.g.
1997 # global INTERNAL_GDBFLAGS
2000 # set foo GDBHISTSIZE
2002 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2003 # append INTERNAL_GDBFLAGS " -nx"
2004 # unset -nocomplain env(GDBHISTSIZE)
2009 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2010 # modified inside BODY, this proc guarantees that the modifications will be
2011 # undone after BODY finishes executing.
2013 proc save_vars { vars body } {
2014 array set saved_scalars { }
2015 array set saved_arrays { }
2019 # First evaluate VAR in the context of the caller in case the variable
2020 # name may be a not-yet-interpolated string like env($foo)
2021 set var [uplevel 1 list $var]
2023 if [uplevel 1 [list info exists $var]] {
2024 if [uplevel 1 [list array exists $var]] {
2025 set saved_arrays($var) [uplevel 1 [list array get $var]]
2027 set saved_scalars($var) [uplevel 1 [list set $var]]
2030 lappend unset_vars $var
2034 set code [catch {uplevel 1 $body} result]
2036 foreach {var value} [array get saved_scalars] {
2037 uplevel 1 [list set $var $value]
2040 foreach {var value} [array get saved_arrays] {
2041 uplevel 1 [list unset $var]
2042 uplevel 1 [list array set $var $value]
2045 foreach var $unset_vars {
2046 uplevel 1 [list unset -nocomplain $var]
2050 global errorInfo errorCode
2051 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2053 return -code $code $result
2058 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2059 # PROMPT. When BODY is finished, restore GDB prompt and variable
2061 # Returns the result of BODY.
2065 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2066 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2067 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2068 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2069 # a) It's more intuitive for callers to pass the plain text form.
2070 # b) We need two forms of the prompt:
2071 # - a regexp to use in output matching,
2072 # - a value to pass to the "set prompt" command.
2073 # c) It's easier to convert the plain text form to its regexp form.
2075 # 2) Don't add a trailing space, we do that here.
2077 proc with_gdb_prompt { prompt body } {
2080 # Convert "(foo)" to "\(foo\)".
2081 # We don't use string_to_regexp because while it works today it's not
2082 # clear it will work tomorrow: the value we need must work as both a
2083 # regexp *and* as the argument to the "set prompt" command, at least until
2084 # we start recording both forms separately instead of just $gdb_prompt.
2085 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2087 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2089 set saved $gdb_prompt
2091 verbose -log "Setting gdb prompt to \"$prompt \"."
2092 set gdb_prompt $prompt
2093 gdb_test_no_output "set prompt $prompt " ""
2095 set code [catch {uplevel 1 $body} result]
2097 verbose -log "Restoring gdb prompt to \"$saved \"."
2098 set gdb_prompt $saved
2099 gdb_test_no_output "set prompt $saved " ""
2102 global errorInfo errorCode
2103 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2105 return -code $code $result
2109 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2110 # BODY is finished, restore target-charset.
2112 proc with_target_charset { target_charset body } {
2116 gdb_test_multiple "show target-charset" "" {
2117 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2118 set saved $expect_out(1,string)
2120 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2121 set saved $expect_out(1,string)
2123 -re ".*$gdb_prompt " {
2124 fail "get target-charset"
2128 gdb_test_no_output "set target-charset $target_charset" ""
2130 set code [catch {uplevel 1 $body} result]
2132 gdb_test_no_output "set target-charset $saved" ""
2135 global errorInfo errorCode
2136 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2138 return -code $code $result
2142 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2143 # mi_gdb_test etc. default to using it.
2145 proc switch_gdb_spawn_id {spawn_id} {
2147 global board board_info
2149 set gdb_spawn_id $spawn_id
2150 set board [host_info name]
2151 set board_info($board,fileid) $spawn_id
2154 # Clear the default spawn id.
2156 proc clear_gdb_spawn_id {} {
2158 global board board_info
2160 unset -nocomplain gdb_spawn_id
2161 set board [host_info name]
2162 unset -nocomplain board_info($board,fileid)
2165 # Run BODY with SPAWN_ID as current spawn id.
2167 proc with_spawn_id { spawn_id body } {
2170 if [info exists gdb_spawn_id] {
2171 set saved_spawn_id $gdb_spawn_id
2174 switch_gdb_spawn_id $spawn_id
2176 set code [catch {uplevel 1 $body} result]
2178 if [info exists saved_spawn_id] {
2179 switch_gdb_spawn_id $saved_spawn_id
2185 global errorInfo errorCode
2186 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2188 return -code $code $result
2192 # Select the largest timeout from all the timeouts:
2193 # - the local "timeout" variable of the scope two levels above,
2194 # - the global "timeout" variable,
2195 # - the board variable "gdb,timeout".
2197 proc get_largest_timeout {} {
2198 upvar #0 timeout gtimeout
2199 upvar 2 timeout timeout
2202 if [info exists timeout] {
2205 if { [info exists gtimeout] && $gtimeout > $tmt } {
2208 if { [target_info exists gdb,timeout]
2209 && [target_info gdb,timeout] > $tmt } {
2210 set tmt [target_info gdb,timeout]
2220 # Run tests in BODY with timeout increased by factor of FACTOR. When
2221 # BODY is finished, restore timeout.
2223 proc with_timeout_factor { factor body } {
2226 set savedtimeout $timeout
2228 set timeout [expr [get_largest_timeout] * $factor]
2229 set code [catch {uplevel 1 $body} result]
2231 set timeout $savedtimeout
2233 global errorInfo errorCode
2234 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2236 return -code $code $result
2240 # Return 1 if _Complex types are supported, otherwise, return 0.
2242 gdb_caching_proc support_complex_tests {
2244 if { [gdb_skip_float_test] } {
2245 # If floating point is not supported, _Complex is not
2250 # Set up, compile, and execute a test program containing _Complex types.
2251 # Include the current process ID in the file names to prevent conflicts
2252 # with invocations for multiple testsuites.
2253 set src [standard_temp_file complex[pid].c]
2254 set exe [standard_temp_file complex[pid].x]
2256 gdb_produce_source $src {
2260 _Complex long double cld;
2265 verbose "compiling testfile $src" 2
2266 set compile_flags {debug nowarnings quiet}
2267 set lines [gdb_compile $src $exe executable $compile_flags]
2271 if ![string match "" $lines] then {
2272 verbose "testfile compilation failed, returning 0" 2
2281 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2284 proc supports_get_siginfo_type {} {
2285 if { [istarget "*-*-linux*"] } {
2292 # Return 1 if the target supports hardware single stepping.
2294 proc can_hardware_single_step {} {
2296 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2297 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2298 || [istarget "nios2-*-*"] } {
2305 # Return 1 if target hardware or OS supports single stepping to signal
2306 # handler, otherwise, return 0.
2308 proc can_single_step_to_signal_handler {} {
2309 # Targets don't have hardware single step. On these targets, when
2310 # a signal is delivered during software single step, gdb is unable
2311 # to determine the next instruction addresses, because start of signal
2312 # handler is one of them.
2313 return [can_hardware_single_step]
2316 # Return 1 if target supports process record, otherwise return 0.
2318 proc supports_process_record {} {
2320 if [target_info exists gdb,use_precord] {
2321 return [target_info gdb,use_precord]
2324 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2325 || [istarget "i\[34567\]86-*-linux*"]
2326 || [istarget "aarch64*-*-linux*"]
2327 || [istarget "powerpc*-*-linux*"]
2328 || [istarget "s390*-*-linux*"] } {
2335 # Return 1 if target supports reverse debugging, otherwise return 0.
2337 proc supports_reverse {} {
2339 if [target_info exists gdb,can_reverse] {
2340 return [target_info gdb,can_reverse]
2343 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2344 || [istarget "i\[34567\]86-*-linux*"]
2345 || [istarget "aarch64*-*-linux*"]
2346 || [istarget "powerpc*-*-linux*"]
2347 || [istarget "s390*-*-linux*"] } {
2354 # Return 1 if readline library is used.
2356 proc readline_is_used { } {
2359 gdb_test_multiple "show editing" "" {
2360 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2363 -re ".*$gdb_prompt $" {
2369 # Return 1 if target is ELF.
2370 gdb_caching_proc is_elf_target {
2371 set me "is_elf_target"
2373 set src [standard_temp_file is_elf_target[pid].c]
2374 set obj [standard_temp_file is_elf_target[pid].o]
2376 gdb_produce_source $src {
2377 int foo () {return 0;}
2380 verbose "$me: compiling testfile $src" 2
2381 set lines [gdb_compile $src $obj object {quiet}]
2385 if ![string match "" $lines] then {
2386 verbose "$me: testfile compilation failed, returning 0" 2
2390 set fp_obj [open $obj "r"]
2391 fconfigure $fp_obj -translation binary
2392 set data [read $fp_obj]
2397 set ELFMAG "\u007FELF"
2399 if {[string compare -length 4 $data $ELFMAG] != 0} {
2400 verbose "$me: returning 0" 2
2404 verbose "$me: returning 1" 2
2408 # Return 1 if the memory at address zero is readable.
2410 gdb_caching_proc is_address_zero_readable {
2414 gdb_test_multiple "x 0" "" {
2415 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2418 -re ".*$gdb_prompt $" {
2426 # Produce source file NAME and write SOURCES into it.
2428 proc gdb_produce_source { name sources } {
2430 set f [open $name "w"]
2436 # Return 1 if target is ILP32.
2437 # This cannot be decided simply from looking at the target string,
2438 # as it might depend on externally passed compiler options like -m64.
2439 gdb_caching_proc is_ilp32_target {
2440 set me "is_ilp32_target"
2442 set src [standard_temp_file ilp32[pid].c]
2443 set obj [standard_temp_file ilp32[pid].o]
2445 gdb_produce_source $src {
2446 int dummy[sizeof (int) == 4
2447 && sizeof (void *) == 4
2448 && sizeof (long) == 4 ? 1 : -1];
2451 verbose "$me: compiling testfile $src" 2
2452 set lines [gdb_compile $src $obj object {quiet}]
2456 if ![string match "" $lines] then {
2457 verbose "$me: testfile compilation failed, returning 0" 2
2461 verbose "$me: returning 1" 2
2465 # Return 1 if target is LP64.
2466 # This cannot be decided simply from looking at the target string,
2467 # as it might depend on externally passed compiler options like -m64.
2468 gdb_caching_proc is_lp64_target {
2469 set me "is_lp64_target"
2471 set src [standard_temp_file lp64[pid].c]
2472 set obj [standard_temp_file lp64[pid].o]
2474 gdb_produce_source $src {
2475 int dummy[sizeof (int) == 4
2476 && sizeof (void *) == 8
2477 && sizeof (long) == 8 ? 1 : -1];
2480 verbose "$me: compiling testfile $src" 2
2481 set lines [gdb_compile $src $obj object {quiet}]
2485 if ![string match "" $lines] then {
2486 verbose "$me: testfile compilation failed, returning 0" 2
2490 verbose "$me: returning 1" 2
2494 # Return 1 if target has 64 bit addresses.
2495 # This cannot be decided simply from looking at the target string,
2496 # as it might depend on externally passed compiler options like -m64.
2497 gdb_caching_proc is_64_target {
2498 set me "is_64_target"
2500 set src [standard_temp_file is64[pid].c]
2501 set obj [standard_temp_file is64[pid].o]
2503 gdb_produce_source $src {
2504 int function(void) { return 3; }
2505 int dummy[sizeof (&function) == 8 ? 1 : -1];
2508 verbose "$me: compiling testfile $src" 2
2509 set lines [gdb_compile $src $obj object {quiet}]
2513 if ![string match "" $lines] then {
2514 verbose "$me: testfile compilation failed, returning 0" 2
2518 verbose "$me: returning 1" 2
2522 # Return 1 if target has x86_64 registers - either amd64 or x32.
2523 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2524 # just from the target string.
2525 gdb_caching_proc is_amd64_regs_target {
2526 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2530 set me "is_amd64_regs_target"
2532 set src [standard_temp_file reg64[pid].s]
2533 set obj [standard_temp_file reg64[pid].o]
2537 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2538 lappend list "\tincq %$reg"
2540 gdb_produce_source $src [join $list \n]
2542 verbose "$me: compiling testfile $src" 2
2543 set lines [gdb_compile $src $obj object {quiet}]
2547 if ![string match "" $lines] then {
2548 verbose "$me: testfile compilation failed, returning 0" 2
2552 verbose "$me: returning 1" 2
2556 # Return 1 if this target is an x86 or x86-64 with -m32.
2557 proc is_x86_like_target {} {
2558 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2561 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2564 # Return 1 if this target is an arm or aarch32 on aarch64.
2566 gdb_caching_proc is_aarch32_target {
2567 if { [istarget "arm*-*-*"] } {
2571 if { ![istarget "aarch64*-*-*"] } {
2575 set me "is_aarch32_target"
2577 set src [standard_temp_file aarch32[pid].s]
2578 set obj [standard_temp_file aarch32[pid].o]
2583 lappend list "\tmov $reg, $reg"
2585 gdb_produce_source $src [join $list \n]
2587 verbose "$me: compiling testfile $src" 2
2588 set lines [gdb_compile $src $obj object {quiet}]
2592 if ![string match "" $lines] then {
2593 verbose "$me: testfile compilation failed, returning 0" 2
2597 verbose "$me: returning 1" 2
2601 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2603 proc is_aarch64_target {} {
2604 if { ![istarget "aarch64*-*-*"] } {
2608 return [expr ![is_aarch32_target]]
2611 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2612 proc support_displaced_stepping {} {
2614 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2615 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2616 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2617 || [istarget "aarch64*-*-linux*"] } {
2624 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2625 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2627 gdb_caching_proc skip_altivec_tests {
2628 global srcdir subdir gdb_prompt inferior_exited_re
2630 set me "skip_altivec_tests"
2632 # Some simulators are known to not support VMX instructions.
2633 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2634 verbose "$me: target known to not support VMX, returning 1" 2
2638 # Make sure we have a compiler that understands altivec.
2639 set compile_flags {debug nowarnings}
2640 if [get_compiler_info] {
2641 warning "Could not get compiler info"
2644 if [test_compiler_info gcc*] {
2645 set compile_flags "$compile_flags additional_flags=-maltivec"
2646 } elseif [test_compiler_info xlc*] {
2647 set compile_flags "$compile_flags additional_flags=-qaltivec"
2649 verbose "Could not compile with altivec support, returning 1" 2
2653 # Set up, compile, and execute a test program containing VMX instructions.
2654 # Include the current process ID in the file names to prevent conflicts
2655 # with invocations for multiple testsuites.
2656 set src [standard_temp_file vmx[pid].c]
2657 set exe [standard_temp_file vmx[pid].x]
2659 gdb_produce_source $src {
2662 asm volatile ("vor v0,v0,v0");
2664 asm volatile ("vor 0,0,0");
2670 verbose "$me: compiling testfile $src" 2
2671 set lines [gdb_compile $src $exe executable $compile_flags]
2674 if ![string match "" $lines] then {
2675 verbose "$me: testfile compilation failed, returning 1" 2
2679 # No error message, compilation succeeded so now run it via gdb.
2683 gdb_reinitialize_dir $srcdir/$subdir
2687 -re ".*Illegal instruction.*${gdb_prompt} $" {
2688 verbose -log "\n$me altivec hardware not detected"
2689 set skip_vmx_tests 1
2691 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2692 verbose -log "\n$me: altivec hardware detected"
2693 set skip_vmx_tests 0
2696 warning "\n$me: default case taken"
2697 set skip_vmx_tests 1
2701 remote_file build delete $exe
2703 verbose "$me: returning $skip_vmx_tests" 2
2704 return $skip_vmx_tests
2707 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2708 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2710 gdb_caching_proc skip_vsx_tests {
2711 global srcdir subdir gdb_prompt inferior_exited_re
2713 set me "skip_vsx_tests"
2715 # Some simulators are known to not support Altivec instructions, so
2716 # they won't support VSX instructions as well.
2717 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2718 verbose "$me: target known to not support VSX, returning 1" 2
2722 # Make sure we have a compiler that understands altivec.
2723 set compile_flags {debug nowarnings quiet}
2724 if [get_compiler_info] {
2725 warning "Could not get compiler info"
2728 if [test_compiler_info gcc*] {
2729 set compile_flags "$compile_flags additional_flags=-mvsx"
2730 } elseif [test_compiler_info xlc*] {
2731 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2733 verbose "Could not compile with vsx support, returning 1" 2
2737 set src [standard_temp_file vsx[pid].c]
2738 set exe [standard_temp_file vsx[pid].x]
2740 gdb_produce_source $src {
2742 double a[2] = { 1.0, 2.0 };
2744 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2746 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2752 verbose "$me: compiling testfile $src" 2
2753 set lines [gdb_compile $src $exe executable $compile_flags]
2756 if ![string match "" $lines] then {
2757 verbose "$me: testfile compilation failed, returning 1" 2
2761 # No error message, compilation succeeded so now run it via gdb.
2765 gdb_reinitialize_dir $srcdir/$subdir
2769 -re ".*Illegal instruction.*${gdb_prompt} $" {
2770 verbose -log "\n$me VSX hardware not detected"
2771 set skip_vsx_tests 1
2773 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2774 verbose -log "\n$me: VSX hardware detected"
2775 set skip_vsx_tests 0
2778 warning "\n$me: default case taken"
2779 set skip_vsx_tests 1
2783 remote_file build delete $exe
2785 verbose "$me: returning $skip_vsx_tests" 2
2786 return $skip_vsx_tests
2789 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2790 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2792 gdb_caching_proc skip_tsx_tests {
2793 global srcdir subdir gdb_prompt inferior_exited_re
2795 set me "skip_tsx_tests"
2797 set src [standard_temp_file tsx[pid].c]
2798 set exe [standard_temp_file tsx[pid].x]
2800 gdb_produce_source $src {
2802 asm volatile ("xbegin .L0");
2803 asm volatile ("xend");
2804 asm volatile (".L0: nop");
2809 verbose "$me: compiling testfile $src" 2
2810 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2813 if ![string match "" $lines] then {
2814 verbose "$me: testfile compilation failed." 2
2818 # No error message, compilation succeeded so now run it via gdb.
2822 gdb_reinitialize_dir $srcdir/$subdir
2826 -re ".*Illegal instruction.*${gdb_prompt} $" {
2827 verbose -log "$me: TSX hardware not detected."
2828 set skip_tsx_tests 1
2830 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2831 verbose -log "$me: TSX hardware detected."
2832 set skip_tsx_tests 0
2835 warning "\n$me: default case taken."
2836 set skip_tsx_tests 1
2840 remote_file build delete $exe
2842 verbose "$me: returning $skip_tsx_tests" 2
2843 return $skip_tsx_tests
2846 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2847 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2849 gdb_caching_proc skip_btrace_tests {
2850 global srcdir subdir gdb_prompt inferior_exited_re
2852 set me "skip_btrace_tests"
2853 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2854 verbose "$me: target does not support btrace, returning 1" 2
2858 # Set up, compile, and execute a test program.
2859 # Include the current process ID in the file names to prevent conflicts
2860 # with invocations for multiple testsuites.
2861 set src [standard_temp_file btrace[pid].c]
2862 set exe [standard_temp_file btrace[pid].x]
2864 gdb_produce_source $src {
2865 int main(void) { return 0; }
2868 verbose "$me: compiling testfile $src" 2
2869 set compile_flags {debug nowarnings quiet}
2870 set lines [gdb_compile $src $exe executable $compile_flags]
2872 if ![string match "" $lines] then {
2873 verbose "$me: testfile compilation failed, returning 1" 2
2878 # No error message, compilation succeeded so now run it via gdb.
2882 gdb_reinitialize_dir $srcdir/$subdir
2889 # In case of an unexpected output, we return 2 as a fail value.
2890 set skip_btrace_tests 2
2891 gdb_test_multiple "record btrace" "check btrace support" {
2892 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2893 set skip_btrace_tests 1
2895 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2896 set skip_btrace_tests 1
2898 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2899 set skip_btrace_tests 1
2901 -re "^record btrace\r\n$gdb_prompt $" {
2902 set skip_btrace_tests 0
2906 remote_file build delete $exe
2908 verbose "$me: returning $skip_btrace_tests" 2
2909 return $skip_btrace_tests
2912 # Run a test on the target to see if it supports btrace pt hardware.
2913 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2914 # from the GCC testsuite.
2916 gdb_caching_proc skip_btrace_pt_tests {
2917 global srcdir subdir gdb_prompt inferior_exited_re
2919 set me "skip_btrace_tests"
2920 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2921 verbose "$me: target does not support btrace, returning 1" 2
2925 # Set up, compile, and execute a test program.
2926 # Include the current process ID in the file names to prevent conflicts
2927 # with invocations for multiple testsuites.
2928 set src [standard_temp_file btrace[pid].c]
2929 set exe [standard_temp_file btrace[pid].x]
2931 gdb_produce_source $src {
2932 int main(void) { return 0; }
2935 verbose "$me: compiling testfile $src" 2
2936 set compile_flags {debug nowarnings quiet}
2937 set lines [gdb_compile $src $exe executable $compile_flags]
2939 if ![string match "" $lines] then {
2940 verbose "$me: testfile compilation failed, returning 1" 2
2945 # No error message, compilation succeeded so now run it via gdb.
2949 gdb_reinitialize_dir $srcdir/$subdir
2956 # In case of an unexpected output, we return 2 as a fail value.
2957 set skip_btrace_tests 2
2958 gdb_test_multiple "record btrace pt" "check btrace support" {
2959 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2960 set skip_btrace_tests 1
2962 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2963 set skip_btrace_tests 1
2965 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2966 set skip_btrace_tests 1
2968 -re "GDB does not support.*\r\n$gdb_prompt $" {
2969 set skip_btrace_tests 1
2971 -re "^record btrace pt\r\n$gdb_prompt $" {
2972 set skip_btrace_tests 0
2976 remote_file build delete $exe
2978 verbose "$me: returning $skip_btrace_tests" 2
2979 return $skip_btrace_tests
2982 # Return whether we should skip tests for showing inlined functions in
2983 # backtraces. Requires get_compiler_info and get_debug_format.
2985 proc skip_inline_frame_tests {} {
2986 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2987 if { ! [test_debug_format "DWARF 2"] } {
2991 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2992 if { ([test_compiler_info "gcc-2-*"]
2993 || [test_compiler_info "gcc-3-*"]
2994 || [test_compiler_info "gcc-4-0-*"]) } {
3001 # Return whether we should skip tests for showing variables from
3002 # inlined functions. Requires get_compiler_info and get_debug_format.
3004 proc skip_inline_var_tests {} {
3005 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3006 if { ! [test_debug_format "DWARF 2"] } {
3013 # Return a 1 if we should skip tests that require hardware breakpoints
3015 proc skip_hw_breakpoint_tests {} {
3016 # Skip tests if requested by the board (note that no_hardware_watchpoints
3017 # disables both watchpoints and breakpoints)
3018 if { [target_info exists gdb,no_hardware_watchpoints]} {
3022 # These targets support hardware breakpoints natively
3023 if { [istarget "i?86-*-*"]
3024 || [istarget "x86_64-*-*"]
3025 || [istarget "ia64-*-*"]
3026 || [istarget "arm*-*-*"]
3027 || [istarget "aarch64*-*-*"]
3028 || [istarget "s390*-*-*"] } {
3035 # Return a 1 if we should skip tests that require hardware watchpoints
3037 proc skip_hw_watchpoint_tests {} {
3038 # Skip tests if requested by the board
3039 if { [target_info exists gdb,no_hardware_watchpoints]} {
3043 # These targets support hardware watchpoints natively
3044 if { [istarget "i?86-*-*"]
3045 || [istarget "x86_64-*-*"]
3046 || [istarget "ia64-*-*"]
3047 || [istarget "arm*-*-*"]
3048 || [istarget "aarch64*-*-*"]
3049 || [istarget "powerpc*-*-linux*"]
3050 || [istarget "s390*-*-*"] } {
3057 # Return a 1 if we should skip tests that require *multiple* hardware
3058 # watchpoints to be active at the same time
3060 proc skip_hw_watchpoint_multi_tests {} {
3061 if { [skip_hw_watchpoint_tests] } {
3065 # These targets support just a single hardware watchpoint
3066 if { [istarget "arm*-*-*"]
3067 || [istarget "powerpc*-*-linux*"] } {
3074 # Return a 1 if we should skip tests that require read/access watchpoints
3076 proc skip_hw_watchpoint_access_tests {} {
3077 if { [skip_hw_watchpoint_tests] } {
3081 # These targets support just write watchpoints
3082 if { [istarget "s390*-*-*"] } {
3089 # Return 1 if we should skip tests that require the runtime unwinder
3090 # hook. This must be invoked while gdb is running, after shared
3091 # libraries have been loaded. This is needed because otherwise a
3092 # shared libgcc won't be visible.
3094 proc skip_unwinder_tests {} {
3098 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3099 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3101 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3104 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3108 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3109 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3112 -re "\r\n$gdb_prompt $" {
3119 # Return 0 if we should skip tests that require the libstdc++ stap
3120 # probes. This must be invoked while gdb is running, after shared
3121 # libraries have been loaded.
3123 proc skip_libstdcxx_probe_tests {} {
3127 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3128 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3131 -re "\r\n$gdb_prompt $" {
3137 # Return 1 if we should skip tests of the "compile" feature.
3138 # This must be invoked after the inferior has been started.
3140 proc skip_compile_feature_tests {} {
3144 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3145 "Could not load libcc1.*\r\n$gdb_prompt $" {
3148 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3151 -re "\r\n$gdb_prompt $" {
3157 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3160 proc gdb_is_target_remote_prompt { prompt_regexp } {
3162 set test "probe for target remote"
3163 gdb_test_multiple "maint print target-stack" $test {
3164 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3168 -re "$prompt_regexp" {
3175 # Check whether we're testing with the remote or extended-remote
3178 proc gdb_is_target_remote {} {
3181 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3184 # Return the effective value of use_gdb_stub.
3186 # If the use_gdb_stub global has been set (it is set when the gdb process is
3187 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3188 # property from the board file.
3190 # This is the preferred way of checking use_gdb_stub, since it allows to check
3191 # the value before the gdb has been spawned and it will return the correct value
3192 # even when it was overriden by the test.
3194 proc use_gdb_stub {} {
3197 if [info exists use_gdb_stub] {
3198 return $use_gdb_stub
3201 return [target_info exists use_gdb_stub]
3204 # Return 1 if the current remote target is an instance of our GDBserver, 0
3205 # otherwise. Return -1 if there was an error and we can't tell.
3207 gdb_caching_proc target_is_gdbserver {
3211 set test "probing for GDBserver"
3213 gdb_test_multiple "monitor help" $test {
3214 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3217 -re "$gdb_prompt $" {
3222 if { $is_gdbserver == -1 } {
3223 verbose -log "Unable to tell whether we are using GDBserver or not."
3226 return $is_gdbserver
3229 # N.B. compiler_info is intended to be local to this file.
3230 # Call test_compiler_info with no arguments to fetch its value.
3231 # Yes, this is counterintuitive when there's get_compiler_info,
3232 # but that's the current API.
3233 if [info exists compiler_info] {
3239 # Figure out what compiler I am using.
3240 # The result is cached so only the first invocation runs the compiler.
3242 # ARG can be empty or "C++". If empty, "C" is assumed.
3244 # There are several ways to do this, with various problems.
3246 # [ gdb_compile -E $ifile -o $binfile.ci ]
3247 # source $binfile.ci
3249 # Single Unix Spec v3 says that "-E -o ..." together are not
3250 # specified. And in fact, the native compiler on hp-ux 11 (among
3251 # others) does not work with "-E -o ...". Most targets used to do
3252 # this, and it mostly worked, because it works with gcc.
3254 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3255 # source $binfile.ci
3257 # This avoids the problem with -E and -o together. This almost works
3258 # if the build machine is the same as the host machine, which is
3259 # usually true of the targets which are not gcc. But this code does
3260 # not figure which compiler to call, and it always ends up using the C
3261 # compiler. Not good for setting hp_aCC_compiler. Target
3262 # hppa*-*-hpux* used to do this.
3264 # [ gdb_compile -E $ifile > $binfile.ci ]
3265 # source $binfile.ci
3267 # dejagnu target_compile says that it supports output redirection,
3268 # but the code is completely different from the normal path and I
3269 # don't want to sweep the mines from that path. So I didn't even try
3272 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3275 # I actually do this for all targets now. gdb_compile runs the right
3276 # compiler, and TCL captures the output, and I eval the output.
3278 # Unfortunately, expect logs the output of the command as it goes by,
3279 # and dejagnu helpfully prints a second copy of it right afterwards.
3280 # So I turn off expect logging for a moment.
3282 # [ gdb_compile $ifile $ciexe_file executable $args ]
3283 # [ remote_exec $ciexe_file ]
3284 # [ source $ci_file.out ]
3286 # I could give up on -E and just do this.
3287 # I didn't get desperate enough to try this.
3289 # -- chastain 2004-01-06
3291 proc get_compiler_info {{arg ""}} {
3292 # For compiler.c and compiler.cc
3295 # I am going to play with the log to keep noise out.
3299 # These come from compiler.c or compiler.cc
3300 global compiler_info
3302 # Legacy global data symbols.
3305 if [info exists compiler_info] {
3310 # Choose which file to preprocess.
3311 set ifile "${srcdir}/lib/compiler.c"
3312 if { $arg == "c++" } {
3313 set ifile "${srcdir}/lib/compiler.cc"
3316 # Run $ifile through the right preprocessor.
3317 # Toggle gdb.log to keep the compiler output out of the log.
3318 set saved_log [log_file -info]
3320 if [is_remote host] {
3321 # We have to use -E and -o together, despite the comments
3322 # above, because of how DejaGnu handles remote host testing.
3323 set ppout "$outdir/compiler.i"
3324 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3325 set file [open $ppout r]
3326 set cppout [read $file]
3329 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3331 eval log_file $saved_log
3335 foreach cppline [ split "$cppout" "\n" ] {
3336 if { [ regexp "^#" "$cppline" ] } {
3338 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3340 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3342 verbose "get_compiler_info: $cppline" 2
3346 verbose -log "get_compiler_info: $cppline"
3351 # Set to unknown if for some reason compiler_info didn't get defined.
3352 if ![info exists compiler_info] {
3353 verbose -log "get_compiler_info: compiler_info not provided"
3354 set compiler_info "unknown"
3356 # Also set to unknown compiler if any diagnostics happened.
3358 verbose -log "get_compiler_info: got unexpected diagnostics"
3359 set compiler_info "unknown"
3362 # Set the legacy symbols.
3364 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3366 # Log what happened.
3367 verbose -log "get_compiler_info: $compiler_info"
3369 # Most compilers will evaluate comparisons and other boolean
3370 # operations to 0 or 1.
3371 uplevel \#0 { set true 1 }
3372 uplevel \#0 { set false 0 }
3377 # Return the compiler_info string if no arg is provided.
3378 # Otherwise the argument is a glob-style expression to match against
3381 proc test_compiler_info { {compiler ""} } {
3382 global compiler_info
3385 # If no arg, return the compiler_info string.
3386 if [string match "" $compiler] {
3387 return $compiler_info
3390 return [string match $compiler $compiler_info]
3393 proc current_target_name { } {
3395 if [info exists target_info(target,name)] {
3396 set answer $target_info(target,name)
3403 set gdb_wrapper_initialized 0
3404 set gdb_wrapper_target ""
3406 proc gdb_wrapper_init { args } {
3407 global gdb_wrapper_initialized
3408 global gdb_wrapper_file
3409 global gdb_wrapper_flags
3410 global gdb_wrapper_target
3412 if { $gdb_wrapper_initialized == 1 } { return; }
3414 if {[target_info exists needs_status_wrapper] && \
3415 [target_info needs_status_wrapper] != "0"} {
3416 set result [build_wrapper "testglue.o"]
3417 if { $result != "" } {
3418 set gdb_wrapper_file [lindex $result 0]
3419 set gdb_wrapper_flags [lindex $result 1]
3421 warning "Status wrapper failed to build."
3424 set gdb_wrapper_initialized 1
3425 set gdb_wrapper_target [current_target_name]
3428 # Determine options that we always want to pass to the compiler.
3429 gdb_caching_proc universal_compile_options {
3430 set me "universal_compile_options"
3433 set src [standard_temp_file ccopts[pid].c]
3434 set obj [standard_temp_file ccopts[pid].o]
3436 gdb_produce_source $src {
3437 int foo(void) { return 0; }
3440 # Try an option for disabling colored diagnostics. Some compilers
3441 # yield colored diagnostics by default (when run from a tty) unless
3442 # such an option is specified.
3443 set opt "additional_flags=-fdiagnostics-color=never"
3444 set lines [target_compile $src $obj object [list "quiet" $opt]]
3445 if [string match "" $lines] then {
3446 # Seems to have worked; use the option.
3447 lappend options $opt
3452 verbose "$me: returning $options" 2
3456 # Some targets need to always link a special object in. Save its path here.
3457 global gdb_saved_set_unbuffered_mode_obj
3458 set gdb_saved_set_unbuffered_mode_obj ""
3460 # Compile source files specified by SOURCE into a binary of type TYPE at path
3461 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3462 # parameter and most options are passed directly to it.
3464 # The type can be one of the following:
3466 # - object: Compile into an object file.
3467 # - executable: Compile and link into an executable.
3468 # - preprocess: Preprocess the source files.
3469 # - assembly: Generate assembly listing.
3471 # The following options are understood and processed by gdb_compile:
3473 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3474 # quirks to be able to use shared libraries.
3475 # - shlib_load: Link with appropriate libraries to allow the test to
3476 # dynamically load libraries at runtime. For example, on Linux, this adds
3477 # -ldl so that the test can use dlopen.
3478 # - nowarnings: Inhibit all compiler warnings.
3480 # And here are some of the not too obscure options understood by DejaGnu that
3481 # influence the compilation:
3483 # - additional_flags=flag: Add FLAG to the compiler flags.
3484 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3485 # argument can be a file, in which case it's added to the sources, or a
3487 # - ldflags=flag: Add FLAG to the linker flags.
3488 # - incdir=path: Add PATH to the searched include directories.
3489 # - libdir=path: Add PATH to the linker searched directories.
3490 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3491 # - debug: Build with debug information.
3492 # - optimize: Build with optimization.
3494 proc gdb_compile {source dest type options} {
3495 global GDB_TESTCASE_OPTIONS
3496 global gdb_wrapper_file
3497 global gdb_wrapper_flags
3498 global gdb_wrapper_initialized
3501 global gdb_saved_set_unbuffered_mode_obj
3503 set outdir [file dirname $dest]
3505 # Add platform-specific options if a shared library was specified using
3506 # "shlib=librarypath" in OPTIONS.
3507 if {[lsearch -exact $options rust] != -1} {
3508 # -fdiagnostics-color is not a rustcc option.
3510 set new_options [universal_compile_options]
3515 foreach opt $options {
3516 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3517 if [test_compiler_info "xlc-*"] {
3518 # IBM xlc compiler doesn't accept shared library named other
3519 # than .so: use "-Wl," to bypass this
3520 lappend source "-Wl,$shlib_name"
3521 } elseif { ([istarget "*-*-mingw*"]
3522 || [istarget *-*-cygwin*]
3523 || [istarget *-*-pe*])} {
3524 lappend source "${shlib_name}.a"
3526 lappend source $shlib_name
3528 if { $shlib_found == 0 } {
3530 if { ([istarget "*-*-mingw*"]
3531 || [istarget *-*-cygwin*]) } {
3532 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3534 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3535 # Undo debian's change in the default.
3536 # Put it at the front to not override any user-provided
3537 # value, and to make sure it appears in front of all the
3539 lappend new_options "early_flags=-Wl,--no-as-needed"
3542 } elseif { $opt == "shlib_load" } {
3545 lappend new_options $opt
3549 # Because we link with libraries using their basename, we may need
3550 # (depending on the platform) to set a special rpath value, to allow
3551 # the executable to find the libraries it depends on.
3552 if { $shlib_load || $shlib_found } {
3553 if { ([istarget "*-*-mingw*"]
3554 || [istarget *-*-cygwin*]
3555 || [istarget *-*-pe*]) } {
3556 # Do not need anything.
3557 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3558 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3559 } elseif { [istarget arm*-*-symbianelf*] } {
3560 if { $shlib_load } {
3561 lappend new_options "libs=-ldl"
3564 if { $shlib_load } {
3565 lappend new_options "libs=-ldl"
3567 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3570 set options $new_options
3572 if [info exists GDB_TESTCASE_OPTIONS] {
3573 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3575 verbose "options are $options"
3576 verbose "source is $source $dest $type $options"
3578 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3580 if {[target_info exists needs_status_wrapper] && \
3581 [target_info needs_status_wrapper] != "0" && \
3582 [info exists gdb_wrapper_file]} {
3583 lappend options "libs=${gdb_wrapper_file}"
3584 lappend options "ldflags=${gdb_wrapper_flags}"
3587 # Replace the "nowarnings" option with the appropriate additional_flags
3588 # to disable compiler warnings.
3589 set nowarnings [lsearch -exact $options nowarnings]
3590 if {$nowarnings != -1} {
3591 if [target_info exists gdb,nowarnings_flag] {
3592 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3594 set flag "additional_flags=-w"
3596 set options [lreplace $options $nowarnings $nowarnings $flag]
3599 if { $type == "executable" } {
3600 if { ([istarget "*-*-mingw*"]
3601 || [istarget "*-*-*djgpp"]
3602 || [istarget "*-*-cygwin*"])} {
3603 # Force output to unbuffered mode, by linking in an object file
3604 # with a global contructor that calls setvbuf.
3606 # Compile the special object seperatelly for two reasons:
3607 # 1) Insulate it from $options.
3608 # 2) Avoid compiling it for every gdb_compile invocation,
3609 # which is time consuming, especially if we're remote
3612 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3613 verbose "compiling gdb_saved_set_unbuffered_obj"
3614 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3615 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3617 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3618 if { $result != "" } {
3621 if {[is_remote host]} {
3622 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3624 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3626 # Link a copy of the output object, because the
3627 # original may be automatically deleted.
3628 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3630 verbose "gdb_saved_set_unbuffered_obj already compiled"
3633 # Rely on the internal knowledge that the global ctors are ran in
3634 # reverse link order. In that case, we can use ldflags to
3635 # avoid copying the object file to the host multiple
3637 # This object can only be added if standard libraries are
3638 # used. Thus, we need to disable it if -nostdlib option is used
3639 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3640 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3645 set result [target_compile $source $dest $type $options]
3647 # Prune uninteresting compiler (and linker) output.
3648 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3650 regsub "\[\r\n\]*$" "$result" "" result
3651 regsub "^\[\r\n\]*" "$result" "" result
3653 if {[lsearch $options quiet] < 0} {
3654 # We shall update this on a per language basis, to avoid
3655 # changing the entire testsuite in one go.
3656 if {[lsearch $options f77] >= 0} {
3657 gdb_compile_test $source $result
3658 } elseif { $result != "" } {
3659 clone_output "gdb compile failed, $result"
3666 # This is just like gdb_compile, above, except that it tries compiling
3667 # against several different thread libraries, to see which one this
3669 proc gdb_compile_pthreads {source dest type options} {
3671 set why_msg "unrecognized error"
3672 foreach lib {-lpthreads -lpthread -lthread ""} {
3673 # This kind of wipes out whatever libs the caller may have
3674 # set. Or maybe theirs will override ours. How infelicitous.
3675 set options_with_lib [concat $options [list libs=$lib quiet]]
3676 set ccout [gdb_compile $source $dest $type $options_with_lib]
3677 switch -regexp -- $ccout {
3678 ".*no posix threads support.*" {
3679 set why_msg "missing threads include file"
3682 ".*cannot open -lpthread.*" {
3683 set why_msg "missing runtime threads library"
3685 ".*Can't find library for -lpthread.*" {
3686 set why_msg "missing runtime threads library"
3689 pass "successfully compiled posix threads test case"
3695 if {!$built_binfile} {
3696 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3701 # Build a shared library from SOURCES.
3703 proc gdb_compile_shlib {sources dest options} {
3704 set obj_options $options
3707 if { [lsearch -exact $options "c++"] >= 0 } {
3708 set info_options "c++"
3710 if [get_compiler_info ${info_options}] {
3714 switch -glob [test_compiler_info] {
3716 lappend obj_options "additional_flags=-qpic"
3719 if { !([istarget "*-*-cygwin*"]
3720 || [istarget "*-*-mingw*"]) } {
3721 lappend obj_options "additional_flags=-fpic"
3725 if { !([istarget "powerpc*-*-aix*"]
3726 || [istarget "rs6000*-*-aix*"]
3727 || [istarget "*-*-cygwin*"]
3728 || [istarget "*-*-mingw*"]
3729 || [istarget "*-*-pe*"]) } {
3730 lappend obj_options "additional_flags=-fpic"
3734 lappend obj_options "additional_flags=-fpic"
3737 # don't know what the compiler is...
3741 set outdir [file dirname $dest]
3743 foreach source $sources {
3744 set sourcebase [file tail $source]
3745 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3748 lappend objects ${outdir}/${sourcebase}.o
3751 set link_options $options
3752 if [test_compiler_info "xlc-*"] {
3753 lappend link_options "additional_flags=-qmkshrobj"
3755 lappend link_options "additional_flags=-shared"
3757 if { ([istarget "*-*-mingw*"]
3758 || [istarget *-*-cygwin*]
3759 || [istarget *-*-pe*]) } {
3760 if { [is_remote host] } {
3761 set name [file tail ${dest}]
3765 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3767 # Set the soname of the library. This causes the linker on ELF
3768 # systems to create the DT_NEEDED entry in the executable referring
3769 # to the soname of the library, and not its absolute path. This
3770 # (using the absolute path) would be problem when testing on a
3773 # In conjunction with setting the soname, we add the special
3774 # rpath=$ORIGIN value when building the executable, so that it's
3775 # able to find the library in its own directory.
3776 set destbase [file tail $dest]
3777 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3780 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3783 if { [is_remote host]
3784 && ([istarget "*-*-mingw*"]
3785 || [istarget *-*-cygwin*]
3786 || [istarget *-*-pe*]) } {
3787 set dest_tail_name [file tail ${dest}]
3788 remote_upload host $dest_tail_name.a ${dest}.a
3789 remote_file host delete $dest_tail_name.a
3795 # This is just like gdb_compile_shlib, above, except that it tries compiling
3796 # against several different thread libraries, to see which one this
3798 proc gdb_compile_shlib_pthreads {sources dest options} {
3800 set why_msg "unrecognized error"
3801 foreach lib {-lpthreads -lpthread -lthread ""} {
3802 # This kind of wipes out whatever libs the caller may have
3803 # set. Or maybe theirs will override ours. How infelicitous.
3804 set options_with_lib [concat $options [list libs=$lib quiet]]
3805 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3806 switch -regexp -- $ccout {
3807 ".*no posix threads support.*" {
3808 set why_msg "missing threads include file"
3811 ".*cannot open -lpthread.*" {
3812 set why_msg "missing runtime threads library"
3814 ".*Can't find library for -lpthread.*" {
3815 set why_msg "missing runtime threads library"
3818 pass "successfully compiled posix threads test case"
3824 if {!$built_binfile} {
3825 unsupported "couldn't compile $sources: ${why_msg}"
3830 # This is just like gdb_compile_pthreads, above, except that we always add the
3831 # objc library for compiling Objective-C programs
3832 proc gdb_compile_objc {source dest type options} {
3834 set why_msg "unrecognized error"
3835 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3836 # This kind of wipes out whatever libs the caller may have
3837 # set. Or maybe theirs will override ours. How infelicitous.
3838 if { $lib == "solaris" } {
3839 set lib "-lpthread -lposix4"
3841 if { $lib != "-lobjc" } {
3842 set lib "-lobjc $lib"
3844 set options_with_lib [concat $options [list libs=$lib quiet]]
3845 set ccout [gdb_compile $source $dest $type $options_with_lib]
3846 switch -regexp -- $ccout {
3847 ".*no posix threads support.*" {
3848 set why_msg "missing threads include file"
3851 ".*cannot open -lpthread.*" {
3852 set why_msg "missing runtime threads library"
3854 ".*Can't find library for -lpthread.*" {
3855 set why_msg "missing runtime threads library"
3858 pass "successfully compiled objc with posix threads test case"
3864 if {!$built_binfile} {
3865 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3870 proc send_gdb { string } {
3871 global suppress_flag
3872 if { $suppress_flag } {
3875 return [remote_send host "$string"]
3878 # Send STRING to the inferior's terminal.
3880 proc send_inferior { string } {
3881 global inferior_spawn_id
3883 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3893 proc gdb_expect { args } {
3894 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3895 set atimeout [lindex $args 0]
3896 set expcode [list [lindex $args 1]]
3901 # A timeout argument takes precedence, otherwise of all the timeouts
3902 # select the largest.
3903 if [info exists atimeout] {
3906 set tmt [get_largest_timeout]
3909 global suppress_flag
3910 global remote_suppress_flag
3911 if [info exists remote_suppress_flag] {
3912 set old_val $remote_suppress_flag
3914 if [info exists suppress_flag] {
3915 if { $suppress_flag } {
3916 set remote_suppress_flag 1
3920 {uplevel remote_expect host $tmt $expcode} string]
3921 if [info exists old_val] {
3922 set remote_suppress_flag $old_val
3924 if [info exists remote_suppress_flag] {
3925 unset remote_suppress_flag
3930 global errorInfo errorCode
3932 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3934 return -code $code $string
3938 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3940 # Check for long sequence of output by parts.
3941 # TEST: is the test message to be printed with the test success/fail.
3942 # SENTINEL: Is the terminal pattern indicating that output has finished.
3943 # LIST: is the sequence of outputs to match.
3944 # If the sentinel is recognized early, it is considered an error.
3947 # 1 if the test failed,
3948 # 0 if the test passes,
3949 # -1 if there was an internal error.
3951 proc gdb_expect_list {test sentinel list} {
3953 global suppress_flag
3956 if { $suppress_flag } {
3958 unresolved "${test}"
3960 while { ${index} < [llength ${list}] } {
3961 set pattern [lindex ${list} ${index}]
3962 set index [expr ${index} + 1]
3963 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3964 if { ${index} == [llength ${list}] } {
3967 -re "${pattern}${sentinel}" {
3968 # pass "${test}, pattern ${index} + sentinel"
3971 fail "${test} (pattern ${index} + sentinel)"
3974 -re ".*A problem internal to GDB has been detected" {
3975 fail "${test} (GDB internal error)"
3977 gdb_internal_error_resync
3980 fail "${test} (pattern ${index} + sentinel) (timeout)"
3985 # unresolved "${test}, pattern ${index} + sentinel"
3991 # pass "${test}, pattern ${index}"
3994 fail "${test} (pattern ${index})"
3997 -re ".*A problem internal to GDB has been detected" {
3998 fail "${test} (GDB internal error)"
4000 gdb_internal_error_resync
4003 fail "${test} (pattern ${index}) (timeout)"
4008 # unresolved "${test}, pattern ${index}"
4022 proc gdb_suppress_entire_file { reason } {
4023 global suppress_flag
4026 set suppress_flag -1
4030 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4031 # gdb_expect to fail immediately (until the next call to
4032 # gdb_stop_suppressing_tests).
4034 proc gdb_suppress_tests { args } {
4035 global suppress_flag
4037 return; # fnf - disable pending review of results where
4038 # testsuite ran better without this
4041 if { $suppress_flag == 1 } {
4042 if { [llength $args] > 0 } {
4043 warning "[lindex $args 0]\n"
4045 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4051 # Clear suppress_flag.
4053 proc gdb_stop_suppressing_tests { } {
4054 global suppress_flag
4056 if [info exists suppress_flag] {
4057 if { $suppress_flag > 0 } {
4059 clone_output "Tests restarted.\n"
4066 proc gdb_clear_suppressed { } {
4067 global suppress_flag
4072 # Spawn the gdb process.
4074 # This doesn't expect any output or do any other initialization,
4075 # leaving those to the caller.
4077 # Overridable function -- you can override this function in your
4080 proc gdb_spawn { } {
4084 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4086 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4089 set saved_gdbflags $GDBFLAGS
4091 if {$GDBFLAGS != ""} {
4094 append GDBFLAGS $cmdline_flags
4098 set GDBFLAGS $saved_gdbflags
4103 # Start gdb running, wait for prompt, and disable the pagers.
4105 # Overridable function -- you can override this function in your
4108 proc gdb_start { } {
4113 catch default_gdb_exit
4116 # Return true if we can spawn a program on the target and attach to
4119 proc can_spawn_for_attach { } {
4120 # We use exp_pid to get the inferior's pid, assuming that gives
4121 # back the pid of the program. On remote boards, that would give
4122 # us instead the PID of e.g., the ssh client, etc.
4123 if [is_remote target] then {
4127 # The "attach" command doesn't make sense when the target is
4128 # stub-like, where GDB finds the program already started on
4129 # initial connection.
4130 if {[target_info exists use_gdb_stub]} {
4138 # Kill a progress previously started with spawn_wait_for_attach, and
4139 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4142 proc kill_wait_spawned_process { proc_spawn_id } {
4143 set pid [exp_pid -i $proc_spawn_id]
4145 verbose -log "killing ${pid}"
4146 remote_exec build "kill -9 ${pid}"
4148 verbose -log "closing ${proc_spawn_id}"
4149 catch "close -i $proc_spawn_id"
4150 verbose -log "waiting for ${proc_spawn_id}"
4152 # If somehow GDB ends up still attached to the process here, a
4153 # blocking wait hangs until gdb is killed (or until gdb / the
4154 # ptracer reaps the exit status too, but that won't happen because
4155 # something went wrong.) Passing -nowait makes expect tell Tcl to
4156 # wait for the PID in the background. That's fine because we
4157 # don't care about the exit status. */
4158 wait -nowait -i $proc_spawn_id
4161 # Returns the process id corresponding to the given spawn id.
4163 proc spawn_id_get_pid { spawn_id } {
4164 set testpid [exp_pid -i $spawn_id]
4166 if { [istarget "*-*-cygwin*"] } {
4167 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4168 # might be different due to the way fork/exec works.
4169 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4175 # Start a set of programs running and then wait for a bit, to be sure
4176 # that they can be attached to. Return a list of processes spawn IDs,
4177 # one element for each process spawned. It's a test error to call
4178 # this when [can_spawn_for_attach] is false.
4180 proc spawn_wait_for_attach { executable_list } {
4181 set spawn_id_list {}
4183 if ![can_spawn_for_attach] {
4184 # The caller should have checked can_spawn_for_attach itself
4185 # before getting here.
4186 error "can't spawn for attach with this target/board"
4189 foreach {executable} $executable_list {
4190 # Note we use Expect's spawn, not Tcl's exec, because with
4191 # spawn we control when to wait for/reap the process. That
4192 # allows killing the process by PID without being subject to
4194 lappend spawn_id_list [remote_spawn target $executable]
4199 return $spawn_id_list
4203 # gdb_load_cmd -- load a file into the debugger.
4204 # ARGS - additional args to load command.
4205 # return a -1 if anything goes wrong.
4207 proc gdb_load_cmd { args } {
4210 if [target_info exists gdb_load_timeout] {
4211 set loadtimeout [target_info gdb_load_timeout]
4213 set loadtimeout 1600
4215 send_gdb "load $args\n"
4216 verbose "Timeout is now $loadtimeout seconds" 2
4217 gdb_expect $loadtimeout {
4218 -re "Loading section\[^\r\]*\r\n" {
4221 -re "Start address\[\r\]*\r\n" {
4224 -re "Transfer rate\[\r\]*\r\n" {
4227 -re "Memory access error\[^\r\]*\r\n" {
4228 perror "Failed to load program"
4231 -re "$gdb_prompt $" {
4234 -re "(.*)\r\n$gdb_prompt " {
4235 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4239 perror "Timed out trying to load $args."
4246 # Invoke "gcore". CORE is the name of the core file to write. TEST
4247 # is the name of the test case. This will return 1 if the core file
4248 # was created, 0 otherwise. If this fails to make a core file because
4249 # this configuration of gdb does not support making core files, it
4250 # will call "unsupported", not "fail". However, if this fails to make
4251 # a core file for some other reason, then it will call "fail".
4253 proc gdb_gcore_cmd {core test} {
4257 gdb_test_multiple "gcore $core" $test {
4258 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4262 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4270 # Load core file CORE. TEST is the name of the test case.
4271 # This will record a pass/fail for loading the core file.
4273 # 1 - core file is successfully loaded
4274 # 0 - core file loaded but has a non fatal error
4275 # -1 - core file failed to load
4277 proc gdb_core_cmd { core test } {
4280 gdb_test_multiple "core $core" "$test" {
4281 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4284 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4285 fail "$test (bad file format)"
4288 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4289 fail "$test (file not found)"
4292 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4293 fail "$test (incomplete note section)"
4296 -re "Core was generated by .*\r\n$gdb_prompt $" {
4300 -re ".*$gdb_prompt $" {
4305 fail "$test (timeout)"
4309 fail "unsupported output from 'core' command"
4313 # Return the filename to download to the target and load on the target
4314 # for this shared library. Normally just LIBNAME, unless shared libraries
4315 # for this target have separate link and load images.
4317 proc shlib_target_file { libname } {
4321 # Return the filename GDB will load symbols from when debugging this
4322 # shared library. Normally just LIBNAME, unless shared libraries for
4323 # this target have separate link and load images.
4325 proc shlib_symbol_file { libname } {
4329 # Return the filename to download to the target and load for this
4330 # executable. Normally just BINFILE unless it is renamed to something
4331 # else for this target.
4333 proc exec_target_file { binfile } {
4337 # Return the filename GDB will load symbols from when debugging this
4338 # executable. Normally just BINFILE unless executables for this target
4339 # have separate files for symbols.
4341 proc exec_symbol_file { binfile } {
4345 # Rename the executable file. Normally this is just BINFILE1 being renamed
4346 # to BINFILE2, but some targets require multiple binary files.
4347 proc gdb_rename_execfile { binfile1 binfile2 } {
4348 file rename -force [exec_target_file ${binfile1}] \
4349 [exec_target_file ${binfile2}]
4350 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4351 file rename -force [exec_symbol_file ${binfile1}] \
4352 [exec_symbol_file ${binfile2}]
4356 # "Touch" the executable file to update the date. Normally this is just
4357 # BINFILE, but some targets require multiple files.
4358 proc gdb_touch_execfile { binfile } {
4359 set time [clock seconds]
4360 file mtime [exec_target_file ${binfile}] $time
4361 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4362 file mtime [exec_symbol_file ${binfile}] $time
4366 # Like remote_download but provides a gdb-specific behavior.
4368 # If the destination board is remote, the local file FROMFILE is transferred as
4369 # usual with remote_download to TOFILE on the remote board. The destination
4370 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4373 # If the destination board is local, the destination path TOFILE is passed
4374 # through standard_output_file, and FROMFILE is copied there.
4376 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4379 proc gdb_remote_download {dest fromfile {tofile {}}} {
4380 # If TOFILE is not given, default to the same filename as FROMFILE.
4381 if {[string length $tofile] == 0} {
4382 set tofile [file tail $fromfile]
4385 if {[is_remote $dest]} {
4386 # When the DEST is remote, we simply send the file to DEST.
4389 set destname [remote_download $dest $fromfile $tofile]
4390 lappend cleanfiles $destname
4394 # When the DEST is local, we copy the file to the test directory (where
4395 # the executable is).
4397 # Note that we pass TOFILE through standard_output_file, regardless of
4398 # whether it is absolute or relative, because we don't want the tests
4399 # to be able to write outside their standard output directory.
4401 set tofile [standard_output_file $tofile]
4403 file copy -force $fromfile $tofile
4409 # gdb_load_shlib LIB...
4411 # Copy the listed library to the target.
4413 proc gdb_load_shlib { file } {
4414 set dest [gdb_remote_download target [shlib_target_file $file]]
4416 if {[is_remote target]} {
4417 # If the target is remote, we need to tell gdb where to find the
4420 # We could set this even when not testing remotely, but a user
4421 # generally won't set it unless necessary. In order to make the tests
4422 # more like the real-life scenarios, we don't set it for local testing.
4423 gdb_test "set solib-search-path [file dirname $file]" "" ""
4430 # gdb_load -- load a file into the debugger. Specifying no file
4431 # defaults to the executable currently being debugged.
4432 # The return value is 0 for success, -1 for failure.
4433 # Many files in config/*.exp override this procedure.
4435 proc gdb_load { arg } {
4437 return [gdb_file_cmd $arg]
4442 # gdb_reload -- load a file into the target. Called before "running",
4443 # either the first time or after already starting the program once,
4444 # for remote targets. Most files that override gdb_load should now
4445 # override this instead.
4447 proc gdb_reload { } {
4448 # For the benefit of existing configurations, default to gdb_load.
4449 # Specifying no file defaults to the executable currently being
4451 return [gdb_load ""]
4454 proc gdb_continue { function } {
4457 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4460 proc default_gdb_init { test_file_name } {
4461 global gdb_wrapper_initialized
4462 global gdb_wrapper_target
4463 global gdb_test_file_name
4469 gdb_clear_suppressed
4471 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4473 # Make sure that the wrapper is rebuilt
4474 # with the appropriate multilib option.
4475 if { $gdb_wrapper_target != [current_target_name] } {
4476 set gdb_wrapper_initialized 0
4479 # Unlike most tests, we have a small number of tests that generate
4480 # a very large amount of output. We therefore increase the expect
4481 # buffer size to be able to contain the entire test output. This
4482 # is especially needed by gdb.base/info-macros.exp.
4484 # Also set this value for the currently running GDB.
4485 match_max [match_max -d]
4487 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4488 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4491 if [target_info exists gdb_prompt] {
4492 set gdb_prompt [target_info gdb_prompt]
4494 set gdb_prompt "\\(gdb\\)"
4497 if [info exists use_gdb_stub] {
4502 # Return a path using GDB_PARALLEL.
4503 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4504 # GDB_PARALLEL must be defined, the caller must check.
4506 # The default value for GDB_PARALLEL is, canonically, ".".
4507 # The catch is that tests don't expect an additional "./" in file paths so
4508 # omit any directory for the default case.
4509 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4510 # its special handling.
4512 proc make_gdb_parallel_path { args } {
4513 global GDB_PARALLEL objdir
4514 set joiner [list "file" "join" $objdir]
4515 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4516 lappend joiner $GDB_PARALLEL
4518 set joiner [concat $joiner $args]
4519 return [eval $joiner]
4522 # Turn BASENAME into a full file name in the standard output
4523 # directory. It is ok if BASENAME is the empty string; in this case
4524 # the directory is returned.
4526 proc standard_output_file {basename} {
4527 global objdir subdir gdb_test_file_name
4529 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4531 return [file join $dir $basename]
4534 # Return the name of a file in our standard temporary directory.
4536 proc standard_temp_file {basename} {
4537 # Since a particular runtest invocation is only executing a single test
4538 # file at any given time, we can use the runtest pid to build the
4539 # path of the temp directory.
4540 set dir [make_gdb_parallel_path temp [pid]]
4542 return [file join $dir $basename]
4545 # Set 'testfile', 'srcfile', and 'binfile'.
4547 # ARGS is a list of source file specifications.
4548 # Without any arguments, the .exp file's base name is used to
4549 # compute the source file name. The ".c" extension is added in this case.
4550 # If ARGS is not empty, each entry is a source file specification.
4551 # If the specification starts with a ".", it is treated as a suffix
4552 # to append to the .exp file's base name.
4553 # If the specification is the empty string, it is treated as if it
4555 # Otherwise it is a file name.
4556 # The first file in the list is used to set the 'srcfile' global.
4557 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4559 # Most tests should call this without arguments.
4561 # If a completely different binary file name is needed, then it
4562 # should be handled in the .exp file with a suitable comment.
4564 proc standard_testfile {args} {
4565 global gdb_test_file_name
4567 global gdb_test_file_last_vars
4570 global testfile binfile
4572 set testfile $gdb_test_file_name
4573 set binfile [standard_output_file ${testfile}]
4575 if {[llength $args] == 0} {
4579 # Unset our previous output variables.
4580 # This can help catch hidden bugs.
4581 if {[info exists gdb_test_file_last_vars]} {
4582 foreach varname $gdb_test_file_last_vars {
4584 catch {unset $varname}
4587 # 'executable' is often set by tests.
4588 set gdb_test_file_last_vars {executable}
4592 set varname srcfile$suffix
4595 # Handle an extension.
4598 } elseif {[string range $arg 0 0] == "."} {
4599 set arg $testfile$arg
4603 lappend gdb_test_file_last_vars $varname
4605 if {$suffix == ""} {
4613 # The default timeout used when testing GDB commands. We want to use
4614 # the same timeout as the default dejagnu timeout, unless the user has
4615 # already provided a specific value (probably through a site.exp file).
4616 global gdb_test_timeout
4617 if ![info exists gdb_test_timeout] {
4618 set gdb_test_timeout $timeout
4621 # A list of global variables that GDB testcases should not use.
4622 # We try to prevent their use by monitoring write accesses and raising
4623 # an error when that happens.
4624 set banned_variables { bug_id prms_id }
4626 # A list of procedures that GDB testcases should not use.
4627 # We try to prevent their use by monitoring invocations and raising
4628 # an error when that happens.
4629 set banned_procedures { strace }
4631 # gdb_init is called by runtest at start, but also by several
4632 # tests directly; gdb_finish is only called from within runtest after
4633 # each test source execution.
4634 # Placing several traces by repetitive calls to gdb_init leads
4635 # to problems, as only one trace is removed in gdb_finish.
4636 # To overcome this possible problem, we add a variable that records
4637 # if the banned variables and procedures are already traced.
4640 proc gdb_init { test_file_name } {
4641 # Reset the timeout value to the default. This way, any testcase
4642 # that changes the timeout value without resetting it cannot affect
4643 # the timeout used in subsequent testcases.
4644 global gdb_test_timeout
4646 set timeout $gdb_test_timeout
4648 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4649 && [target_info exists gdb_reverse_timeout] } {
4650 set timeout [target_info gdb_reverse_timeout]
4653 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4654 # debugging tool to help confirm that the test suite is
4655 # parallel-safe. You need "inotifywait" from the
4656 # inotify-tools package to use this.
4657 global GDB_INOTIFY inotify_pid
4658 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4659 global outdir tool inotify_log_file
4661 set exclusions {outputs temp gdb[.](log|sum) cache}
4662 set exclusion_re ([join $exclusions |])
4664 set inotify_log_file [standard_temp_file inotify.out]
4665 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4666 --exclude $exclusion_re \
4667 |& tee -a $outdir/$tool.log $inotify_log_file &]
4669 # Wait for the watches; hopefully this is long enough.
4672 # Clear the log so that we don't emit a warning the first time
4674 set fd [open $inotify_log_file w]
4678 # Block writes to all banned variables, and invocation of all
4679 # banned procedures...
4680 global banned_variables
4681 global banned_procedures
4682 global banned_traced
4683 if (!$banned_traced) {
4684 foreach banned_var $banned_variables {
4685 global "$banned_var"
4686 trace add variable "$banned_var" write error
4688 foreach banned_proc $banned_procedures {
4689 global "$banned_proc"
4690 trace add execution "$banned_proc" enter error
4695 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4696 # messages as expected.
4701 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4702 # the test results. Even if /dev/null doesn't exist on the particular
4703 # platform, the readline library will use the default setting just by
4704 # failing to open the file. OTOH, opening /dev/null successfully will
4705 # also result in the default settings being used since nothing will be
4706 # read from this file.
4707 setenv INPUTRC "/dev/null"
4709 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4710 # bindings, so make sure that an appropriate terminal is selected.
4711 # The same bug doesn't show up if we use ^P / ^N instead.
4714 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4715 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4716 # especially having color output turned on can cause tests to fail.
4717 setenv GREP_OPTIONS ""
4719 # Clear $gdbserver_reconnect_p.
4720 global gdbserver_reconnect_p
4721 set gdbserver_reconnect_p 1
4722 unset gdbserver_reconnect_p
4724 return [default_gdb_init $test_file_name]
4727 proc gdb_finish { } {
4728 global gdbserver_reconnect_p
4732 # Exit first, so that the files are no longer in use.
4735 if { [llength $cleanfiles] > 0 } {
4736 eval remote_file target delete $cleanfiles
4740 # Unblock write access to the banned variables. Dejagnu typically
4741 # resets some of them between testcases.
4742 global banned_variables
4743 global banned_procedures
4744 global banned_traced
4745 if ($banned_traced) {
4746 foreach banned_var $banned_variables {
4747 global "$banned_var"
4748 trace remove variable "$banned_var" write error
4750 foreach banned_proc $banned_procedures {
4751 global "$banned_proc"
4752 trace remove execution "$banned_proc" enter error
4759 set debug_format "unknown"
4761 # Run the gdb command "info source" and extract the debugging format
4762 # information from the output and save it in debug_format.
4764 proc get_debug_format { } {
4770 set debug_format "unknown"
4771 send_gdb "info source\n"
4773 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4774 set debug_format $expect_out(1,string)
4775 verbose "debug format is $debug_format"
4778 -re "No current source file.\r\n$gdb_prompt $" {
4779 perror "get_debug_format used when no current source file"
4782 -re "$gdb_prompt $" {
4783 warning "couldn't check debug format (no valid response)."
4787 warning "couldn't check debug format (timeout)."
4793 # Return true if FORMAT matches the debug format the current test was
4794 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4795 # `*', `[...]', and so on.
4797 # This function depends on variables set by `get_debug_format', above.
4799 proc test_debug_format {format} {
4802 return [expr [string match $format $debug_format] != 0]
4805 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4806 # COFF, stabs, etc). If that format matches the format that the
4807 # current test was compiled with, then the next test is expected to
4808 # fail for any target. Returns 1 if the next test or set of tests is
4809 # expected to fail, 0 otherwise (or if it is unknown). Must have
4810 # previously called get_debug_format.
4811 proc setup_xfail_format { format } {
4812 set ret [test_debug_format $format]
4820 # gdb_get_line_number TEXT [FILE]
4822 # Search the source file FILE, and return the line number of the
4823 # first line containing TEXT. If no match is found, an error is thrown.
4825 # TEXT is a string literal, not a regular expression.
4827 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4828 # specified, and does not start with "/", then it is assumed to be in
4829 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4830 # by changing the callers and the interface at the same time.
4831 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4832 # gdb.base/ena-dis-br.exp.
4834 # Use this function to keep your test scripts independent of the
4835 # exact line numbering of the source file. Don't write:
4837 # send_gdb "break 20"
4839 # This means that if anyone ever edits your test's source file,
4840 # your test could break. Instead, put a comment like this on the
4841 # source file line you want to break at:
4843 # /* breakpoint spot: frotz.exp: test name */
4845 # and then write, in your test script (which we assume is named
4848 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4850 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4853 # % puts "foo [lindex "bar baz" 1]"
4856 # Tcl is quite clever, for a little stringy language.)
4860 # The previous implementation of this procedure used the gdb search command.
4861 # This version is different:
4863 # . It works with MI, and it also works when gdb is not running.
4865 # . It operates on the build machine, not the host machine.
4867 # . For now, this implementation fakes a current directory of
4868 # $srcdir/$subdir to be compatible with the old implementation.
4869 # This will go away eventually and some callers will need to
4872 # . The TEXT argument is literal text and matches literally,
4873 # not a regular expression as it was before.
4875 # . State changes in gdb, such as changing the current file
4876 # and setting $_, no longer happen.
4878 # After a bit of time we can forget about the differences from the
4879 # old implementation.
4881 # --chastain 2004-08-05
4883 proc gdb_get_line_number { text { file "" } } {
4888 if { "$file" == "" } then {
4891 if { ! [regexp "^/" "$file"] } then {
4892 set file "$srcdir/$subdir/$file"
4895 if { [ catch { set fd [open "$file"] } message ] } then {
4900 for { set line 1 } { 1 } { incr line } {
4901 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4904 if { $nchar < 0 } then {
4907 if { [string first "$text" "$body"] >= 0 } then {
4913 if { [ catch { close "$fd" } message ] } then {
4918 error "undefined tag \"$text\""
4924 # Continue the program until it ends.
4926 # MSSG is the error message that gets printed. If not given, a
4928 # COMMAND is the command to invoke. If not given, "continue" is
4930 # ALLOW_EXTRA is a flag indicating whether the test should expect
4931 # extra output between the "Continuing." line and the program
4932 # exiting. By default it is zero; if nonzero, any extra output
4935 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4936 global inferior_exited_re use_gdb_stub
4939 set text "continue until exit"
4941 set text "continue until exit at $mssg"
4949 # By default, we don't rely on exit() behavior of remote stubs --
4950 # it's common for exit() to be implemented as a simple infinite
4951 # loop, or a forced crash/reset. For native targets, by default, we
4952 # assume process exit is reported as such. If a non-reliable target
4953 # is used, we set a breakpoint at exit, and continue to that.
4954 if { [target_info exists exit_is_reliable] } {
4955 set exit_is_reliable [target_info exit_is_reliable]
4957 set exit_is_reliable [expr ! $use_gdb_stub]
4960 if { ! $exit_is_reliable } {
4961 if {![gdb_breakpoint "exit"]} {
4964 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4967 # Continue until we exit. Should not stop again.
4968 # Don't bother to check the output of the program, that may be
4969 # extremely tough for some remote systems.
4971 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4976 proc rerun_to_main {} {
4977 global gdb_prompt use_gdb_stub
4982 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4983 {pass "rerun to main" ; return 0}
4984 -re "$gdb_prompt $"\
4985 {fail "rerun to main" ; return 0}
4986 timeout {fail "(timeout) rerun to main" ; return 0}
4991 -re "The program .* has been started already.*y or n. $" {
4995 -re "Starting program.*$gdb_prompt $"\
4996 {pass "rerun to main" ; return 0}
4997 -re "$gdb_prompt $"\
4998 {fail "rerun to main" ; return 0}
4999 timeout {fail "(timeout) rerun to main" ; return 0}
5004 # Return true if a test should be skipped due to lack of floating
5005 # point support or GDB can't fetch the contents from floating point
5008 gdb_caching_proc gdb_skip_float_test {
5009 if [target_info exists gdb,skip_float_tests] {
5013 # There is an ARM kernel ptrace bug that hardware VFP registers
5014 # are not updated after GDB ptrace set VFP registers. The bug
5015 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5016 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5017 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5018 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5019 # This kernel bug is detected by check how does GDB change the
5020 # program result by changing one VFP register.
5021 if { [istarget "arm*-*-linux*"] } {
5023 set compile_flags {debug nowarnings }
5025 # Set up, compile, and execute a test program having VFP
5027 set src [standard_temp_file arm_vfp[pid].c]
5028 set exe [standard_temp_file arm_vfp[pid].x]
5030 gdb_produce_source $src {
5035 asm ("vldr d0, [%0]" : : "r" (&d));
5036 asm ("vldr d1, [%0]" : : "r" (&d));
5037 asm (".global break_here\n"
5039 asm ("vcmp.f64 d0, d1\n"
5040 "vmrs APSR_nzcv, fpscr\n"
5041 "bne L_value_different\n"
5044 "L_value_different:\n"
5046 "L_end:\n" : "=r" (ret) :);
5048 /* Return $d0 != $d1. */
5053 verbose "compiling testfile $src" 2
5054 set lines [gdb_compile $src $exe executable $compile_flags]
5057 if ![string match "" $lines] then {
5058 verbose "testfile compilation failed, returning 1" 2
5062 # No error message, compilation succeeded so now run it via gdb.
5063 # Run the test up to 5 times to detect whether ptrace can
5064 # correctly update VFP registers or not.
5066 for {set i 0} {$i < 5} {incr i} {
5067 global gdb_prompt srcdir subdir
5071 gdb_reinitialize_dir $srcdir/$subdir
5075 gdb_test "break *break_here"
5076 gdb_continue_to_breakpoint "break_here"
5078 # Modify $d0 to a different value, so the exit code should
5080 gdb_test "set \$d0 = 5.0"
5082 set test "continue to exit"
5083 gdb_test_multiple "continue" "$test" {
5084 -re "exited with code 01.*$gdb_prompt $" {
5086 -re "exited normally.*$gdb_prompt $" {
5087 # However, the exit code is 0. That means something
5088 # wrong in setting VFP registers.
5096 remote_file build delete $exe
5098 return $skip_vfp_test
5103 # Print a message and return true if a test should be skipped
5104 # due to lack of stdio support.
5106 proc gdb_skip_stdio_test { msg } {
5107 if [target_info exists gdb,noinferiorio] {
5108 verbose "Skipping test '$msg': no inferior i/o."
5114 proc gdb_skip_bogus_test { msg } {
5118 # Return true if a test should be skipped due to lack of XML support
5120 # NOTE: This must be called while gdb is *not* running.
5122 gdb_caching_proc gdb_skip_xml_test {
5127 if { [info exists gdb_spawn_id] } {
5128 error "GDB must not be running in gdb_skip_xml_tests."
5131 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5135 gdb_test_multiple "set tdesc filename $xml_file" "" {
5136 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5139 -re ".*$gdb_prompt $" { }
5145 # Return true if argv[0] is available.
5147 gdb_caching_proc gdb_has_argv0 {
5150 # Set up, compile, and execute a test program to check whether
5151 # argv[0] is available.
5152 set src [standard_temp_file has_argv0[pid].c]
5153 set exe [standard_temp_file has_argv0[pid].x]
5155 gdb_produce_source $src {
5156 int main (int argc, char **argv) {
5161 gdb_compile $src $exe executable {debug}
5164 proc gdb_has_argv0_1 { exe } {
5165 global srcdir subdir
5166 global gdb_prompt hex
5170 gdb_reinitialize_dir $srcdir/$subdir
5173 # Set breakpoint on main.
5174 gdb_test_multiple "break main" "break main" {
5175 -re "Breakpoint.*${gdb_prompt} $" {
5177 -re "${gdb_prompt} $" {
5184 gdb_test_multiple "" "run to main" {
5185 -re "Breakpoint.*${gdb_prompt} $" {
5187 -re "${gdb_prompt} $" {
5192 set old_elements "200"
5193 set test "show print elements"
5194 gdb_test_multiple $test $test {
5195 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5196 set old_elements $expect_out(1,string)
5199 set old_repeats "200"
5200 set test "show print repeats"
5201 gdb_test_multiple $test $test {
5202 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5203 set old_repeats $expect_out(1,string)
5206 gdb_test_no_output "set print elements unlimited" ""
5207 gdb_test_no_output "set print repeats unlimited" ""
5210 # Check whether argc is 1.
5211 gdb_test_multiple "p argc" "p argc" {
5212 -re " = 1\r\n${gdb_prompt} $" {
5214 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5215 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5218 -re "${gdb_prompt} $" {
5222 -re "${gdb_prompt} $" {
5226 gdb_test_no_output "set print elements $old_elements" ""
5227 gdb_test_no_output "set print repeats $old_repeats" ""
5232 set result [gdb_has_argv0_1 $exe]
5239 && ([istarget *-*-linux*]
5240 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5241 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5242 || [istarget *-*-openbsd*]
5243 || [istarget *-*-darwin*]
5244 || [istarget *-*-solaris*]
5245 || [istarget *-*-aix*]
5246 || [istarget *-*-gnu*]
5247 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5248 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5249 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5250 || [istarget *-*-symbianelf*]
5251 || [istarget *-*-osf*]
5252 || [istarget *-*-dicos*]
5253 || [istarget *-*-nto*]
5254 || [istarget *-*-*vms*]
5255 || [istarget *-*-lynx*178]) } {
5256 fail "argv\[0\] should be available on this target"
5262 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5263 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5264 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5265 # the name of a debuginfo only file. This file will be stored in the same
5268 # Functions for separate debug info testing
5270 # starting with an executable:
5271 # foo --> original executable
5273 # at the end of the process we have:
5274 # foo.stripped --> foo w/o debug info
5275 # foo.debug --> foo's debug info
5276 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5278 # Fetch the build id from the file.
5279 # Returns "" if there is none.
5281 proc get_build_id { filename } {
5282 if { ([istarget "*-*-mingw*"]
5283 || [istarget *-*-cygwin*]) } {
5284 set objdump_program [gdb_find_objdump]
5285 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5286 verbose "result is $result"
5287 verbose "output is $output"
5293 set tmp [standard_output_file "${filename}-tmp"]
5294 set objcopy_program [gdb_find_objcopy]
5295 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5296 verbose "result is $result"
5297 verbose "output is $output"
5302 fconfigure $fi -translation binary
5303 # Skip the NOTE header.
5308 if ![string compare $data ""] then {
5311 # Convert it to hex.
5312 binary scan $data H* data
5317 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5318 # converted to the form: .build-id/ab/cdef1234...89.debug
5319 # Return "" if no build-id found.
5320 proc build_id_debug_filename_get { filename } {
5321 set data [get_build_id $filename]
5322 if { $data == "" } {
5325 regsub {^..} $data {\0/} data
5326 return ".build-id/${data}.debug"
5329 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5330 # list of optional flags. The only currently supported flag is no-main,
5331 # which removes the symbol entry for main from the separate debug file.
5333 # Function returns zero on success. Function will return non-zero failure code
5334 # on some targets not supporting separate debug info (such as i386-msdos).
5336 proc gdb_gnu_strip_debug { dest args } {
5338 # Use the first separate debug info file location searched by GDB so the
5339 # run cannot be broken by some stale file searched with higher precedence.
5340 set debug_file "${dest}.debug"
5342 set strip_to_file_program [transform strip]
5343 set objcopy_program [gdb_find_objcopy]
5345 set debug_link [file tail $debug_file]
5346 set stripped_file "${dest}.stripped"
5348 # Get rid of the debug info, and store result in stripped_file
5349 # something like gdb/testsuite/gdb.base/blah.stripped.
5350 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5351 verbose "result is $result"
5352 verbose "output is $output"
5357 # Workaround PR binutils/10802:
5358 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5359 set perm [file attributes ${dest} -permissions]
5360 file attributes ${stripped_file} -permissions $perm
5362 # Get rid of everything but the debug info, and store result in debug_file
5363 # This will be in the .debug subdirectory, see above.
5364 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5365 verbose "result is $result"
5366 verbose "output is $output"
5371 # If no-main is passed, strip the symbol for main from the separate
5372 # file. This is to simulate the behavior of elfutils's eu-strip, which
5373 # leaves the symtab in the original file only. There's no way to get
5374 # objcopy or strip to remove the symbol table without also removing the
5375 # debugging sections, so this is as close as we can get.
5376 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5377 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5378 verbose "result is $result"
5379 verbose "output is $output"
5383 file delete "${debug_file}"
5384 file rename "${debug_file}-tmp" "${debug_file}"
5387 # Link the two previous output files together, adding the .gnu_debuglink
5388 # section to the stripped_file, containing a pointer to the debug_file,
5389 # save the new file in dest.
5390 # This will be the regular executable filename, in the usual location.
5391 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5392 verbose "result is $result"
5393 verbose "output is $output"
5398 # Workaround PR binutils/10802:
5399 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5400 set perm [file attributes ${stripped_file} -permissions]
5401 file attributes ${dest} -permissions $perm
5406 # Test the output of GDB_COMMAND matches the pattern obtained
5407 # by concatenating all elements of EXPECTED_LINES. This makes
5408 # it possible to split otherwise very long string into pieces.
5409 # If third argument is not empty, it's used as the name of the
5410 # test to be printed on pass/fail.
5411 proc help_test_raw { gdb_command expected_lines args } {
5412 set message $gdb_command
5413 if [llength $args]>0 then {
5414 set message [lindex $args 0]
5416 set expected_output [join $expected_lines ""]
5417 gdb_test "${gdb_command}" "${expected_output}" $message
5420 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5421 # are regular expressions that should match the beginning of output,
5422 # before the list of commands in that class. The presence of
5423 # command list and standard epilogue will be tested automatically.
5424 # Notice that the '[' and ']' characters don't need to be escaped for strings
5425 # wrapped in {} braces.
5426 proc test_class_help { command_class expected_initial_lines args } {
5428 "List of commands\:.*[\r\n]+"
5429 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5430 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5431 "Command name abbreviations are allowed if unambiguous\."
5433 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5435 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5438 # COMMAND_LIST should have either one element -- command to test, or
5439 # two elements -- abbreviated command to test, and full command the first
5440 # element is abbreviation of.
5441 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5442 # are regular expressions that should match the beginning of output,
5443 # before the list of subcommands. The presence of
5444 # subcommand list and standard epilogue will be tested automatically.
5445 proc test_prefix_command_help { command_list expected_initial_lines args } {
5446 set command [lindex $command_list 0]
5447 if {[llength $command_list]>1} {
5448 set full_command [lindex $command_list 1]
5450 set full_command $command
5452 # Use 'list' and not just {} because we want variables to
5453 # be expanded in this list.
5454 set l_stock_body [list\
5455 "List of $full_command subcommands\:.*\[\r\n\]+"\
5456 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5457 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5458 "Command name abbreviations are allowed if unambiguous\."]
5459 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5460 if {[llength $args]>0} {
5461 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5463 help_test_raw "help ${command}" $l_entire_body
5467 # Build executable named EXECUTABLE from specifications that allow
5468 # different options to be passed to different sub-compilations.
5469 # TESTNAME is the name of the test; this is passed to 'untested' if
5471 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5472 # contains the option "pthreads", then gdb_compile_pthreads is used.
5473 # ARGS is a flat list of source specifications, of the form:
5474 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5475 # Each SOURCE is compiled to an object file using its OPTIONS,
5476 # using gdb_compile.
5477 # Returns 0 on success, -1 on failure.
5478 proc build_executable_from_specs {testname executable options args} {
5482 set binfile [standard_output_file $executable]
5485 if { [lsearch -exact $options "c++"] >= 0 } {
5486 set info_options "c++"
5488 if [get_compiler_info ${info_options}] {
5492 set func gdb_compile
5493 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5494 if {$func_index != -1} {
5495 set func "${func}_[lindex $options $func_index]"
5498 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5499 # parameter. They also requires $sources while gdb_compile and
5500 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5501 if [string match gdb_compile_shlib* $func] {
5503 foreach {s local_options} $args {
5504 if { [regexp "^/" "$s"] } then {
5505 lappend sources_path "$s"
5507 lappend sources_path "$srcdir/$subdir/$s"
5510 set ret [$func $sources_path "${binfile}" $options]
5511 } elseif {[lsearch -exact $options rust] != -1} {
5513 foreach {s local_options} $args {
5514 if { [regexp "^/" "$s"] } then {
5515 lappend sources_path "$s"
5517 lappend sources_path "$srcdir/$subdir/$s"
5520 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5524 foreach {s local_options} $args {
5525 if { ! [regexp "^/" "$s"] } then {
5526 set s "$srcdir/$subdir/$s"
5528 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5532 lappend objects "${binfile}${i}.o"
5535 set ret [$func $objects "${binfile}" executable $options]
5545 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5546 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5547 # to pass to untested, if something is wrong. OPTIONS are passed
5548 # to gdb_compile directly.
5549 proc build_executable { testname executable {sources ""} {options {debug}} } {
5550 if {[llength $sources]==0} {
5551 set sources ${executable}.c
5554 set arglist [list $testname $executable $options]
5555 foreach source $sources {
5556 lappend arglist $source $options
5559 return [eval build_executable_from_specs $arglist]
5562 # Starts fresh GDB binary and loads an optional executable into GDB.
5563 # Usage: clean_restart [executable]
5564 # EXECUTABLE is the basename of the binary.
5566 proc clean_restart { args } {
5570 if { [llength $args] > 1 } {
5571 error "bad number of args: [llength $args]"
5576 gdb_reinitialize_dir $srcdir/$subdir
5578 if { [llength $args] >= 1 } {
5579 set executable [lindex $args 0]
5580 set binfile [standard_output_file ${executable}]
5585 # Prepares for testing by calling build_executable_full, then
5587 # TESTNAME is the name of the test.
5588 # Each element in ARGS is a list of the form
5589 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5590 # These are passed to build_executable_from_specs, which see.
5591 # The last EXECUTABLE is passed to clean_restart.
5592 # Returns 0 on success, non-zero on failure.
5593 proc prepare_for_testing_full {testname args} {
5594 foreach spec $args {
5595 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5598 set executable [lindex $spec 0]
5600 clean_restart $executable
5604 # Prepares for testing, by calling build_executable, and then clean_restart.
5605 # Please refer to build_executable for parameter description.
5606 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5608 if {[build_executable $testname $executable $sources $options] == -1} {
5611 clean_restart $executable
5616 # Retrieve the value of EXP in the inferior, represented in format
5617 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5618 # print fails. TEST is the test message to use. It can be omitted,
5619 # in which case a test message is built from EXP.
5621 proc get_valueof { fmt exp default {test ""} } {
5625 set test "get valueof \"${exp}\""
5629 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5630 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5631 set val $expect_out(1,string)
5635 fail "$test (timeout)"
5641 # Retrieve the value of EXP in the inferior, as a signed decimal value
5642 # (using "print /d"). DEFAULT is used as fallback if print fails.
5643 # TEST is the test message to use. It can be omitted, in which case
5644 # a test message is built from EXP.
5646 proc get_integer_valueof { exp default {test ""} } {
5650 set test "get integer valueof \"${exp}\""
5654 gdb_test_multiple "print /d ${exp}" "$test" {
5655 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5656 set val $expect_out(1,string)
5660 fail "$test (timeout)"
5666 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5667 # (using "print /x"). DEFAULT is used as fallback if print fails.
5668 # TEST is the test message to use. It can be omitted, in which case
5669 # a test message is built from EXP.
5671 proc get_hexadecimal_valueof { exp default {test ""} } {
5675 set test "get hexadecimal valueof \"${exp}\""
5679 gdb_test_multiple "print /x ${exp}" $test {
5680 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5681 set val $expect_out(1,string)
5688 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5689 # is used as fallback if print fails. TEST is the test message to use.
5690 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5692 proc get_sizeof { type default {test ""} } {
5693 return [get_integer_valueof "sizeof (${type})" $default $test]
5696 proc get_target_charset { } {
5699 gdb_test_multiple "show target-charset" "" {
5700 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5701 return $expect_out(1,string)
5703 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5704 return $expect_out(1,string)
5708 # Pick a reasonable default.
5709 warning "Unable to read target-charset."
5713 # Get the address of VAR.
5715 proc get_var_address { var } {
5716 global gdb_prompt hex
5718 # Match output like:
5720 # $5 = (int (*)()) 0
5721 # $6 = (int (*)()) 0x24 <function_bar>
5723 gdb_test_multiple "print &${var}" "get address of ${var}" {
5724 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5726 pass "get address of ${var}"
5727 if { $expect_out(1,string) == "0" } {
5730 return $expect_out(1,string)
5737 # Get the current value for remotetimeout and return it.
5738 proc get_remotetimeout { } {
5742 gdb_test_multiple "show remotetimeout" "" {
5743 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5744 return $expect_out(1,string)
5748 # Pick the default that gdb uses
5749 warning "Unable to read remotetimeout"
5753 # Set the remotetimeout to the specified timeout. Nothing is returned.
5754 proc set_remotetimeout { timeout } {
5757 gdb_test_multiple "set remotetimeout $timeout" "" {
5758 -re "$gdb_prompt $" {
5759 verbose "Set remotetimeout to $timeout\n"
5764 # Get the target's current endianness and return it.
5765 proc get_endianness { } {
5768 gdb_test_multiple "show endian" "determine endianness" {
5769 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5771 return $expect_out(1,string)
5777 # ROOT and FULL are file names. Returns the relative path from ROOT
5778 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5779 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5782 proc relative_filename {root full} {
5783 set root_split [file split $root]
5784 set full_split [file split $full]
5786 set len [llength $root_split]
5788 if {[eval file join $root_split]
5789 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5790 error "$full not a subdir of $root"
5793 return [eval file join [lrange $full_split $len end]]
5796 # Log gdb command line and script if requested.
5797 if {[info exists TRANSCRIPT]} {
5798 rename send_gdb real_send_gdb
5799 rename remote_spawn real_remote_spawn
5800 rename remote_close real_remote_close
5802 global gdb_transcript
5803 set gdb_transcript ""
5805 global gdb_trans_count
5806 set gdb_trans_count 1
5808 proc remote_spawn {args} {
5809 global gdb_transcript gdb_trans_count outdir
5811 if {$gdb_transcript != ""} {
5812 close $gdb_transcript
5814 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5815 puts $gdb_transcript [lindex $args 1]
5816 incr gdb_trans_count
5818 return [uplevel real_remote_spawn $args]
5821 proc remote_close {args} {
5822 global gdb_transcript
5824 if {$gdb_transcript != ""} {
5825 close $gdb_transcript
5826 set gdb_transcript ""
5829 return [uplevel real_remote_close $args]
5832 proc send_gdb {args} {
5833 global gdb_transcript
5835 if {$gdb_transcript != ""} {
5836 puts -nonewline $gdb_transcript [lindex $args 0]
5839 return [uplevel real_send_gdb $args]
5843 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5844 if {[info exists GDB_PARALLEL]} {
5845 if {[is_remote host]} {
5849 [make_gdb_parallel_path outputs] \
5850 [make_gdb_parallel_path temp] \
5851 [make_gdb_parallel_path cache]
5855 proc core_find {binfile {deletefiles {}} {arg ""}} {
5856 global objdir subdir
5858 set destcore "$binfile.core"
5859 file delete $destcore
5861 # Create a core file named "$destcore" rather than just "core", to
5862 # avoid problems with sys admin types that like to regularly prune all
5863 # files named "core" from the system.
5865 # Arbitrarily try setting the core size limit to "unlimited" since
5866 # this does not hurt on systems where the command does not work and
5867 # allows us to generate a core on systems where it does.
5869 # Some systems append "core" to the name of the program; others append
5870 # the name of the program to "core"; still others (like Linux, as of
5871 # May 2003) create cores named "core.PID". In the latter case, we
5872 # could have many core files lying around, and it may be difficult to
5873 # tell which one is ours, so let's run the program in a subdirectory.
5875 set coredir [standard_output_file coredir.[getpid]]
5877 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5878 # remote_exec host "${binfile}"
5879 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5880 if [remote_file build exists $i] {
5881 remote_exec build "mv $i $destcore"
5885 # Check for "core.PID".
5886 if { $found == 0 } {
5887 set names [glob -nocomplain -directory $coredir core.*]
5888 if {[llength $names] == 1} {
5889 set corefile [file join $coredir [lindex $names 0]]
5890 remote_exec build "mv $corefile $destcore"
5894 if { $found == 0 } {
5895 # The braindamaged HPUX shell quits after the ulimit -c above
5896 # without executing ${binfile}. So we try again without the
5897 # ulimit here if we didn't find a core file above.
5898 # Oh, I should mention that any "braindamaged" non-Unix system has
5899 # the same problem. I like the cd bit too, it's really neat'n stuff.
5900 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5901 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5902 if [remote_file build exists $i] {
5903 remote_exec build "mv $i $destcore"
5909 # Try to clean up after ourselves.
5910 foreach deletefile $deletefiles {
5911 remote_file build delete [file join $coredir $deletefile]
5913 remote_exec build "rmdir $coredir"
5915 if { $found == 0 } {
5916 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5922 # gdb_target_symbol_prefix compiles a test program and then examines
5923 # the output from objdump to determine the prefix (such as underscore)
5924 # for linker symbol prefixes.
5926 gdb_caching_proc gdb_target_symbol_prefix {
5927 # Set up and compile a simple test program...
5928 set src [standard_temp_file main[pid].c]
5929 set exe [standard_temp_file main[pid].x]
5931 gdb_produce_source $src {
5937 verbose "compiling testfile $src" 2
5938 set compile_flags {debug nowarnings quiet}
5939 set lines [gdb_compile $src $exe executable $compile_flags]
5943 if ![string match "" $lines] then {
5944 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5946 set objdump_program [gdb_find_objdump]
5947 set result [catch "exec $objdump_program --syms $exe" output]
5950 && ![regexp -lineanchor \
5951 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5952 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5962 # gdb_target_symbol returns the provided symbol with the correct prefix
5963 # prepended. (See gdb_target_symbol_prefix, above.)
5965 proc gdb_target_symbol { symbol } {
5966 set prefix [gdb_target_symbol_prefix]
5967 return "${prefix}${symbol}"
5970 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5971 # added to gdb_compile options to define the C-preprocessor macro
5972 # SYMBOL_PREFIX with a value that can be prepended to symbols
5973 # for targets which require a prefix, such as underscore.
5975 # This version (_asm) defines the prefix without double quotes
5976 # surrounding the prefix. It is used to define the macro
5977 # SYMBOL_PREFIX for assembly language files. Another version, below,
5978 # is used for symbols in inline assembler in C/C++ files.
5980 # The lack of quotes in this version (_asm) makes it possible to
5981 # define supporting macros in the .S file. (The version which
5982 # uses quotes for the prefix won't work for such files since it's
5983 # impossible to define a quote-stripping macro in C.)
5985 # It's possible to use this version (_asm) for C/C++ source files too,
5986 # but a string is usually required in such files; providing a version
5987 # (no _asm) which encloses the prefix with double quotes makes it
5988 # somewhat easier to define the supporting macros in the test case.
5990 proc gdb_target_symbol_prefix_flags_asm {} {
5991 set prefix [gdb_target_symbol_prefix]
5992 if {$prefix ne ""} {
5993 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5999 # gdb_target_symbol_prefix_flags returns the same string as
6000 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6001 # enclosed in double quotes if there is a prefix.
6003 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6004 # extended discussion.
6006 proc gdb_target_symbol_prefix_flags {} {
6007 set prefix [gdb_target_symbol_prefix]
6008 if {$prefix ne ""} {
6009 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6015 # A wrapper for 'remote_exec host' that passes or fails a test.
6016 # Returns 0 if all went well, nonzero on failure.
6017 # TEST is the name of the test, other arguments are as for remote_exec.
6019 proc run_on_host { test program args } {
6020 verbose -log "run_on_host: $program $args"
6021 # remote_exec doesn't work properly if the output is set but the
6022 # input is the empty string -- so replace an empty input with
6024 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6025 set args [lreplace $args 1 1 "/dev/null"]
6027 set result [eval remote_exec host [list $program] $args]
6028 verbose "result is $result"
6029 set status [lindex $result 0]
6030 set output [lindex $result 1]
6035 verbose -log "run_on_host failed: $output"
6041 # Return non-zero if "board_info debug_flags" mentions Fission.
6042 # http://gcc.gnu.org/wiki/DebugFission
6043 # Fission doesn't support everything yet.
6044 # This supports working around bug 15954.
6046 proc using_fission { } {
6047 set debug_flags [board_info [target_info name] debug_flags]
6048 return [regexp -- "-gsplit-dwarf" $debug_flags]
6051 # Search the caller's ARGS list and set variables according to the list of
6052 # valid options described by ARGSET.
6054 # The first member of each one- or two-element list in ARGSET defines the
6055 # name of a variable that will be added to the caller's scope.
6057 # If only one element is given to describe an option, it the value is
6058 # 0 if the option is not present in (the caller's) ARGS or 1 if
6061 # If two elements are given, the second element is the default value of
6062 # the variable. This is then overwritten if the option exists in ARGS.
6064 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6065 # any optional components.
6068 # proc myproc {foo args} {
6069 # parse_args {{bar} {baz "abc"} {qux}}
6072 # myproc ABC -bar -baz DEF peanut butter
6073 # will define the following variables in myproc:
6074 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6075 # args will be the list {peanut butter}
6077 proc parse_args { argset } {
6080 foreach argument $argset {
6081 if {[llength $argument] == 1} {
6082 # No default specified, so we assume that we should set
6083 # the value to 1 if the arg is present and 0 if it's not.
6084 # It is assumed that no value is given with the argument.
6085 set result [lsearch -exact $args "-$argument"]
6086 if {$result != -1} then {
6087 uplevel 1 [list set $argument 1]
6088 set args [lreplace $args $result $result]
6090 uplevel 1 [list set $argument 0]
6092 } elseif {[llength $argument] == 2} {
6093 # There are two items in the argument. The second is a
6094 # default value to use if the item is not present.
6095 # Otherwise, the variable is set to whatever is provided
6096 # after the item in the args.
6097 set arg [lindex $argument 0]
6098 set result [lsearch -exact $args "-[lindex $arg 0]"]
6099 if {$result != -1} then {
6100 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6101 set args [lreplace $args $result [expr $result+1]]
6103 uplevel 1 [list set $arg [lindex $argument 1]]
6106 error "Badly formatted argument \"$argument\" in argument set"
6110 # The remaining args should be checked to see that they match the
6111 # number of items expected to be passed into the procedure...
6114 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6115 # return that string.
6117 proc capture_command_output { command prefix } {
6121 set output_string ""
6122 gdb_test_multiple "$command" "capture_command_output for $command" {
6123 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6124 set output_string $expect_out(1,string)
6127 return $output_string
6130 # A convenience function that joins all the arguments together, with a
6131 # regexp that matches exactly one end of line in between each argument.
6132 # This function is ideal to write the expected output of a GDB command
6133 # that generates more than a couple of lines, as this allows us to write
6134 # each line as a separate string, which is easier to read by a human
6137 proc multi_line { args } {
6138 return [join $args "\r\n"]
6141 # Similar to the above, but while multi_line is meant to be used to
6142 # match GDB output, this one is meant to be used to build strings to
6143 # send as GDB input.
6145 proc multi_line_input { args } {
6146 return [join $args "\n"]
6149 # Return the version of the DejaGnu framework.
6151 # The return value is a list containing the major, minor and patch version
6152 # numbers. If the version does not contain a minor or patch number, they will
6153 # be set to 0. For example:
6159 proc dejagnu_version { } {
6160 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6161 global frame_version
6163 verbose -log "DejaGnu version: $frame_version"
6164 verbose -log "Expect version: [exp_version]"
6165 verbose -log "Tcl version: [info tclversion]"
6167 set dg_ver [split $frame_version .]
6169 while { [llength $dg_ver] < 3 } {
6176 # Define user-defined command COMMAND using the COMMAND_LIST as the
6177 # command's definition. The terminating "end" is added automatically.
6179 proc gdb_define_cmd {command command_list} {
6182 set input [multi_line_input {*}$command_list "end"]
6183 set test "define $command"
6185 gdb_test_multiple "define $command" $test {
6187 gdb_test_multiple $input $test {
6188 -re "\r\n$gdb_prompt " {
6195 # Always load compatibility stuff.