1 # Copyright 1992-2017 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 # Generic run command.
231 # The second pattern below matches up to the first newline *only*.
232 # Using ``.*$'' could swallow up output that we attempt to match
235 # N.B. This function does not wait for gdb to return to the prompt,
236 # that is the caller's responsibility.
238 proc gdb_run_cmd {args} {
239 global gdb_prompt use_gdb_stub
241 foreach command [gdb_init_commands] {
242 send_gdb "$command\n"
244 -re "$gdb_prompt $" { }
246 perror "gdb_init_command for target failed"
253 if [target_info exists gdb,do_reload_on_run] {
254 if { [gdb_reload] != 0 } {
257 send_gdb "continue\n"
259 -re "Continu\[^\r\n\]*\[\r\n\]" {}
265 if [target_info exists gdb,start_symbol] {
266 set start [target_info gdb,start_symbol]
270 send_gdb "jump *$start\n"
272 while { $start_attempt } {
273 # Cap (re)start attempts at three to ensure that this loop
274 # always eventually fails. Don't worry about trying to be
275 # clever and not send a command when it has failed.
276 if [expr $start_attempt > 3] {
277 perror "Jump to start() failed (retry count exceeded)"
280 set start_attempt [expr $start_attempt + 1]
282 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
285 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
286 perror "Can't find start symbol to run in gdb_run"
289 -re "No symbol \"start\" in current.*$gdb_prompt $" {
290 send_gdb "jump *_start\n"
292 -re "No symbol.*context.*$gdb_prompt $" {
295 -re "Line.* Jump anyway.*y or n. $" {
298 -re "The program is not being run.*$gdb_prompt $" {
299 if { [gdb_reload] != 0 } {
302 send_gdb "jump *$start\n"
305 perror "Jump to start() failed (timeout)"
313 if [target_info exists gdb,do_reload_on_run] {
314 if { [gdb_reload] != 0 } {
318 send_gdb "run $args\n"
319 # This doesn't work quite right yet.
320 # Use -notransfer here so that test cases (like chng-sym.exp)
321 # may test for additional start-up messages.
323 -re "The program .* has been started already.*y or n. $" {
327 -notransfer -re "Starting program: \[^\r\n\]*" {}
328 -notransfer -re "$gdb_prompt $" {
329 # There is no more input expected.
334 # Generic start command. Return 0 if we could start the program, -1
337 # N.B. This function does not wait for gdb to return to the prompt,
338 # that is the caller's responsibility.
340 proc gdb_start_cmd {args} {
341 global gdb_prompt use_gdb_stub
343 foreach command [gdb_init_commands] {
344 send_gdb "$command\n"
346 -re "$gdb_prompt $" { }
348 perror "gdb_init_command for target failed"
358 send_gdb "start $args\n"
359 # Use -notransfer here so that test cases (like chng-sym.exp)
360 # may test for additional start-up messages.
362 -re "The program .* has been started already.*y or n. $" {
366 -notransfer -re "Starting program: \[^\r\n\]*" {
373 # Generic starti command. Return 0 if we could start the program, -1
376 # N.B. This function does not wait for gdb to return to the prompt,
377 # that is the caller's responsibility.
379 proc gdb_starti_cmd {args} {
380 global gdb_prompt use_gdb_stub
382 foreach command [gdb_init_commands] {
383 send_gdb "$command\n"
385 -re "$gdb_prompt $" { }
387 perror "gdb_init_command for target failed"
397 send_gdb "starti $args\n"
399 -re "The program .* has been started already.*y or n. $" {
403 -re "Starting program: \[^\r\n\]*" {
410 # Set a breakpoint at FUNCTION. If there is an additional argument it is
411 # a list of options; the supported options are allow-pending, temporary,
412 # message, no-message, and passfail.
413 # The result is 1 for success, 0 for failure.
415 # Note: The handling of message vs no-message is messed up, but it's based
416 # on historical usage. By default this function does not print passes,
418 # no-message: turns off printing of fails (and passes, but they're already off)
419 # message: turns on printing of passes (and fails, but they're already on)
421 proc gdb_breakpoint { function args } {
425 set pending_response n
426 if {[lsearch -exact $args allow-pending] != -1} {
427 set pending_response y
430 set break_command "break"
431 set break_message "Breakpoint"
432 if {[lsearch -exact $args temporary] != -1} {
433 set break_command "tbreak"
434 set break_message "Temporary breakpoint"
439 set no_message_loc [lsearch -exact $args no-message]
440 set message_loc [lsearch -exact $args message]
441 # The last one to appear in args wins.
442 if { $no_message_loc > $message_loc } {
444 } elseif { $message_loc > $no_message_loc } {
448 set test_name "setting breakpoint at $function"
450 send_gdb "$break_command $function\n"
451 # The first two regexps are what we get with -g, the third is without -g.
453 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
454 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
455 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
456 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
457 if {$pending_response == "n"} {
464 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
465 send_gdb "$pending_response\n"
468 -re "A problem internal to GDB has been detected" {
470 fail "$test_name (GDB internal error)"
472 gdb_internal_error_resync
475 -re "$gdb_prompt $" {
483 fail "$test_name (eof)"
489 fail "$test_name (timeout)"
500 # Set breakpoint at function and run gdb until it breaks there.
501 # Since this is the only breakpoint that will be set, if it stops
502 # at a breakpoint, we will assume it is the one we want. We can't
503 # just compare to "function" because it might be a fully qualified,
504 # single quoted C++ function specifier.
506 # If there are additional arguments, pass them to gdb_breakpoint.
507 # We recognize no-message/message ourselves.
508 # The default is no-message.
509 # no-message is messed up here, like gdb_breakpoint: to preserve
510 # historical usage fails are always printed by default.
511 # no-message: turns off printing of fails (and passes, but they're already off)
512 # message: turns on printing of passes (and fails, but they're already on)
514 proc runto { function args } {
520 # Default to "no-message".
521 set args "no-message $args"
525 set no_message_loc [lsearch -exact $args no-message]
526 set message_loc [lsearch -exact $args message]
527 # The last one to appear in args wins.
528 if { $no_message_loc > $message_loc } {
530 } elseif { $message_loc > $no_message_loc } {
534 set test_name "running to $function in runto"
536 # We need to use eval here to pass our varargs args to gdb_breakpoint
537 # which is also a varargs function.
538 # But we also have to be careful because $function may have multiple
539 # elements, and we don't want Tcl to move the remaining elements after
540 # the first to $args. That is why $function is wrapped in {}.
541 if ![eval gdb_breakpoint {$function} $args] {
547 # the "at foo.c:36" output we get with -g.
548 # the "in func" output we get without -g.
550 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
556 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
562 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
564 unsupported "non-stop mode not supported"
568 -re ".*A problem internal to GDB has been detected" {
570 fail "$test_name (GDB internal error)"
572 gdb_internal_error_resync
575 -re "$gdb_prompt $" {
583 fail "$test_name (eof)"
589 fail "$test_name (timeout)"
600 # Ask gdb to run until we hit a breakpoint at main.
602 # N.B. This function deletes all existing breakpoints.
603 # If you don't want that, use gdb_start_cmd.
605 proc runto_main { } {
606 return [runto main no-message]
609 ### Continue, and expect to hit a breakpoint.
610 ### Report a pass or fail, depending on whether it seems to have
611 ### worked. Use NAME as part of the test name; each call to
612 ### continue_to_breakpoint should use a NAME which is unique within
614 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
616 set full_name "continue to breakpoint: $name"
618 gdb_test_multiple "continue" $full_name {
619 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
626 # gdb_internal_error_resync:
628 # Answer the questions GDB asks after it reports an internal error
629 # until we get back to a GDB prompt. Decline to quit the debugging
630 # session, and decline to create a core file. Return non-zero if the
633 # This procedure just answers whatever questions come up until it sees
634 # a GDB prompt; it doesn't require you to have matched the input up to
635 # any specific point. However, it only answers questions it sees in
636 # the output itself, so if you've matched a question, you had better
637 # answer it yourself before calling this.
639 # You can use this function thus:
643 # -re ".*A problem internal to GDB has been detected" {
644 # gdb_internal_error_resync
649 proc gdb_internal_error_resync {} {
652 verbose -log "Resyncing due to internal error."
655 while {$count < 10} {
657 -re "Quit this debugging session\\? \\(y or n\\) $" {
661 -re "Create a core file of GDB\\? \\(y or n\\) $" {
665 -re "$gdb_prompt $" {
666 # We're resynchronized.
670 perror "Could not resync from internal error (timeout)"
675 perror "Could not resync from internal error (resync count exceeded)"
680 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
681 # Send a command to gdb; test the result.
683 # COMMAND is the command to execute, send to GDB with send_gdb. If
684 # this is the null string no command is sent.
685 # MESSAGE is a message to be printed with the built-in failure patterns
686 # if one of them matches. If MESSAGE is empty COMMAND will be used.
687 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
688 # patterns. Pattern elements will be evaluated in the caller's
689 # context; action elements will be executed in the caller's context.
690 # Unlike patterns for gdb_test, these patterns should generally include
691 # the final newline and prompt.
694 # 1 if the test failed, according to a built-in failure pattern
695 # 0 if only user-supplied patterns matched
696 # -1 if there was an internal error.
698 # You can use this function thus:
700 # gdb_test_multiple "print foo" "test foo" {
701 # -re "expected output 1" {
704 # -re "expected output 2" {
709 # Like with "expect", you can also specify the spawn id to match with
710 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
711 # $gdb_spawn_id. The former matches inferior I/O, while the latter
712 # matches GDB I/O. E.g.:
714 # send_inferior "hello\n"
715 # gdb_test_multiple "continue" "test echo" {
716 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
719 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
720 # fail "hit breakpoint"
724 # The standard patterns, such as "Inferior exited..." and "A problem
725 # ...", all being implicitly appended to that list. These are always
726 # expected from $gdb_spawn_id. IOW, callers do not need to worry
727 # about resetting "-i" back to $gdb_spawn_id explicitly.
729 proc gdb_test_multiple { command message user_code } {
730 global verbose use_gdb_stub
731 global gdb_prompt pagination_prompt
734 global inferior_exited_re
735 upvar timeout timeout
736 upvar expect_out expect_out
739 if { $message == "" } {
743 if [string match "*\[\r\n\]" $command] {
744 error "Invalid trailing newline in \"$message\" test"
747 if [string match "*\[\r\n\]*" $message] {
748 error "Invalid newline in \"$message\" test"
752 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
754 error "gdbserver does not support $command without extended-remote"
757 # TCL/EXPECT WART ALERT
758 # Expect does something very strange when it receives a single braced
759 # argument. It splits it along word separators and performs substitutions.
760 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
761 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
762 # double-quoted list item, "\[ab\]" is just a long way of representing
763 # "[ab]", because the backslashes will be removed by lindex.
765 # Unfortunately, there appears to be no easy way to duplicate the splitting
766 # that expect will do from within TCL. And many places make use of the
767 # "\[0-9\]" construct, so we need to support that; and some places make use
768 # of the "[func]" construct, so we need to support that too. In order to
769 # get this right we have to substitute quoted list elements differently
770 # from braced list elements.
772 # We do this roughly the same way that Expect does it. We have to use two
773 # lists, because if we leave unquoted newlines in the argument to uplevel
774 # they'll be treated as command separators, and if we escape newlines
775 # we mangle newlines inside of command blocks. This assumes that the
776 # input doesn't contain a pattern which contains actual embedded newlines
779 regsub -all {\n} ${user_code} { } subst_code
780 set subst_code [uplevel list $subst_code]
782 set processed_code ""
784 set expecting_action 0
786 foreach item $user_code subst_item $subst_code {
787 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
788 lappend processed_code $item
791 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
792 lappend processed_code $item
795 if { $item == "-timeout" || $item == "-i" } {
797 lappend processed_code $item
800 if { $expecting_arg } {
802 lappend processed_code $subst_item
805 if { $expecting_action } {
806 lappend processed_code "uplevel [list $item]"
807 set expecting_action 0
808 # Cosmetic, no effect on the list.
809 append processed_code "\n"
812 set expecting_action 1
813 lappend processed_code $subst_item
814 if {$patterns != ""} {
817 append patterns "\"$subst_item\""
820 # Also purely cosmetic.
821 regsub -all {\r} $patterns {\\r} patterns
822 regsub -all {\n} $patterns {\\n} patterns
825 send_user "Sending \"$command\" to gdb\n"
826 send_user "Looking to match \"$patterns\"\n"
827 send_user "Message is \"$message\"\n"
831 set string "${command}\n"
832 if { $command != "" } {
833 set multi_line_re "\[\r\n\] *>"
834 while { "$string" != "" } {
835 set foo [string first "\n" "$string"]
836 set len [string length "$string"]
837 if { $foo < [expr $len - 1] } {
838 set str [string range "$string" 0 $foo]
839 if { [send_gdb "$str"] != "" } {
842 if { ! $suppress_flag } {
843 perror "Couldn't send $command to GDB."
848 # since we're checking if each line of the multi-line
849 # command are 'accepted' by GDB here,
850 # we need to set -notransfer expect option so that
851 # command output is not lost for pattern matching
854 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
855 timeout { verbose "partial: timeout" 3 }
857 set string [string range "$string" [expr $foo + 1] end]
858 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
863 if { "$string" != "" } {
864 if { [send_gdb "$string"] != "" } {
867 if { ! $suppress_flag } {
868 perror "Couldn't send $command to GDB."
877 -re ".*A problem internal to GDB has been detected" {
878 fail "$message (GDB internal error)"
879 gdb_internal_error_resync
882 -re "\\*\\*\\* DOSEXIT code.*" {
883 if { $message != "" } {
886 gdb_suppress_entire_file "GDB died"
890 append code $processed_code
892 # Reset the spawn id, in case the processed code used -i.
895 -re "Ending remote debugging.*$gdb_prompt $" {
896 if ![isnative] then {
897 warning "Can`t communicate to remote target."
903 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
904 perror "Undefined command \"$command\"."
908 -re "Ambiguous command.*$gdb_prompt $" {
909 perror "\"$command\" is not a unique command name."
913 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
914 if ![string match "" $message] then {
915 set errmsg "$message (the program exited)"
917 set errmsg "$command (the program exited)"
922 -re "$inferior_exited_re normally.*$gdb_prompt $" {
923 if ![string match "" $message] then {
924 set errmsg "$message (the program exited)"
926 set errmsg "$command (the program exited)"
931 -re "The program is not being run.*$gdb_prompt $" {
932 if ![string match "" $message] then {
933 set errmsg "$message (the program is no longer running)"
935 set errmsg "$command (the program is no longer running)"
940 -re "\r\n$gdb_prompt $" {
941 if ![string match "" $message] then {
946 -re "$pagination_prompt" {
948 perror "Window too small."
952 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
954 gdb_expect -re "$gdb_prompt $"
955 fail "$message (got interactive prompt)"
958 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
960 gdb_expect -re "$gdb_prompt $"
961 fail "$message (got breakpoint menu)"
965 # Patterns below apply to any spawn id specified.
968 perror "Process no longer exists"
969 if { $message != "" } {
975 perror "internal buffer is full."
980 if ![string match "" $message] then {
981 fail "$message (timeout)"
988 set code [catch {gdb_expect $code} string]
990 global errorInfo errorCode
991 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
992 } elseif {$code > 1} {
993 return -code $code $string
998 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
999 # Send a command to gdb; test the result.
1001 # COMMAND is the command to execute, send to GDB with send_gdb. If
1002 # this is the null string no command is sent.
1003 # PATTERN is the pattern to match for a PASS, and must NOT include
1004 # the \r\n sequence immediately before the gdb prompt. This argument
1005 # may be omitted to just match the prompt, ignoring whatever output
1007 # MESSAGE is an optional message to be printed. If this is
1008 # omitted, then the pass/fail messages use the command string as the
1009 # message. (If this is the empty string, then sometimes we don't
1010 # call pass or fail at all; I don't understand this at all.)
1011 # QUESTION is a question GDB may ask in response to COMMAND, like
1013 # RESPONSE is the response to send if QUESTION appears.
1016 # 1 if the test failed,
1017 # 0 if the test passes,
1018 # -1 if there was an internal error.
1020 proc gdb_test { args } {
1022 upvar timeout timeout
1024 if [llength $args]>2 then {
1025 set message [lindex $args 2]
1027 set message [lindex $args 0]
1029 set command [lindex $args 0]
1030 set pattern [lindex $args 1]
1032 if [llength $args]==5 {
1033 set question_string [lindex $args 3]
1034 set response_string [lindex $args 4]
1036 set question_string "^FOOBAR$"
1039 return [gdb_test_multiple $command $message {
1040 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1041 if ![string match "" $message] then {
1045 -re "(${question_string})$" {
1046 send_gdb "$response_string\n"
1052 # gdb_test_no_output COMMAND MESSAGE
1053 # Send a command to GDB and verify that this command generated no output.
1055 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1056 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1057 # the message. (If MESSAGE is the empty string, then sometimes we do not
1058 # call pass or fail at all; I don't understand this at all.)
1060 proc gdb_test_no_output { args } {
1062 set command [lindex $args 0]
1063 if [llength $args]>1 then {
1064 set message [lindex $args 1]
1066 set message $command
1069 set command_regex [string_to_regexp $command]
1070 gdb_test_multiple $command $message {
1071 -re "^$command_regex\r\n$gdb_prompt $" {
1072 if ![string match "" $message] then {
1079 # Send a command and then wait for a sequence of outputs.
1080 # This is useful when the sequence is long and contains ".*", a single
1081 # regexp to match the entire output can get a timeout much easier.
1083 # COMMAND is the command to send.
1084 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1085 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1086 # processed in order, and all must be present in the output.
1088 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1089 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1090 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1092 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1093 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1096 # 1 if the test failed,
1097 # 0 if the test passes,
1098 # -1 if there was an internal error.
1100 proc gdb_test_sequence { command test_name expected_output_list } {
1102 if { $test_name == "" } {
1103 set test_name $command
1105 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1106 send_gdb "$command\n"
1107 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1111 # Test that a command gives an error. For pass or fail, return
1112 # a 1 to indicate that more tests can proceed. However a timeout
1113 # is a serious error, generates a special fail message, and causes
1114 # a 0 to be returned to indicate that more tests are likely to fail
1117 proc test_print_reject { args } {
1121 if [llength $args]==2 then {
1122 set expectthis [lindex $args 1]
1124 set expectthis "should never match this bogus string"
1126 set sendthis [lindex $args 0]
1127 if $verbose>2 then {
1128 send_user "Sending \"$sendthis\" to gdb\n"
1129 send_user "Looking to match \"$expectthis\"\n"
1131 send_gdb "$sendthis\n"
1132 #FIXME: Should add timeout as parameter.
1134 -re "A .* in expression.*\\.*$gdb_prompt $" {
1135 pass "reject $sendthis"
1138 -re "Invalid syntax in expression.*$gdb_prompt $" {
1139 pass "reject $sendthis"
1142 -re "Junk after end of expression.*$gdb_prompt $" {
1143 pass "reject $sendthis"
1146 -re "Invalid number.*$gdb_prompt $" {
1147 pass "reject $sendthis"
1150 -re "Invalid character constant.*$gdb_prompt $" {
1151 pass "reject $sendthis"
1154 -re "No symbol table is loaded.*$gdb_prompt $" {
1155 pass "reject $sendthis"
1158 -re "No symbol .* in current context.*$gdb_prompt $" {
1159 pass "reject $sendthis"
1162 -re "Unmatched single quote.*$gdb_prompt $" {
1163 pass "reject $sendthis"
1166 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1167 pass "reject $sendthis"
1170 -re "$expectthis.*$gdb_prompt $" {
1171 pass "reject $sendthis"
1174 -re ".*$gdb_prompt $" {
1175 fail "reject $sendthis"
1179 fail "reject $sendthis (eof or timeout)"
1186 # Same as gdb_test, but the second parameter is not a regexp,
1187 # but a string that must match exactly.
1189 proc gdb_test_exact { args } {
1190 upvar timeout timeout
1192 set command [lindex $args 0]
1194 # This applies a special meaning to a null string pattern. Without
1195 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1196 # messages from commands that should have no output except a new
1197 # prompt. With this, only results of a null string will match a null
1200 set pattern [lindex $args 1]
1201 if [string match $pattern ""] {
1202 set pattern [string_to_regexp [lindex $args 0]]
1204 set pattern [string_to_regexp [lindex $args 1]]
1207 # It is most natural to write the pattern argument with only
1208 # embedded \n's, especially if you are trying to avoid Tcl quoting
1209 # problems. But gdb_expect really wants to see \r\n in patterns. So
1210 # transform the pattern here. First transform \r\n back to \n, in
1211 # case some users of gdb_test_exact already do the right thing.
1212 regsub -all "\r\n" $pattern "\n" pattern
1213 regsub -all "\n" $pattern "\r\n" pattern
1214 if [llength $args]==3 then {
1215 set message [lindex $args 2]
1217 set message $command
1220 return [gdb_test $command $pattern $message]
1223 # Wrapper around gdb_test_multiple that looks for a list of expected
1224 # output elements, but which can appear in any order.
1225 # CMD is the gdb command.
1226 # NAME is the name of the test.
1227 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1229 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1230 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1231 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1233 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1234 # of text per element and then strip trailing \r\n's.
1236 # gdb_test_list_exact "foo" "bar" \
1237 # "\[^\r\n\]+\[\r\n\]+" \
1240 # {expected result 1} \
1241 # {expected result 2} \
1244 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1247 set matches [lsort $result_match_list]
1249 gdb_test_multiple $cmd $name {
1250 "$cmd\[\r\n\]" { exp_continue }
1251 -re $elm_find_regexp {
1252 set str $expect_out(0,string)
1253 verbose -log "seen: $str" 3
1254 regexp -- $elm_extract_regexp $str elm_seen
1255 verbose -log "extracted: $elm_seen" 3
1256 lappend seen $elm_seen
1259 -re "$gdb_prompt $" {
1261 foreach got [lsort $seen] have $matches {
1262 if {![string equal $got $have]} {
1267 if {[string length $failed] != 0} {
1268 fail "$name ($failed not found)"
1276 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1277 # Send a command to gdb; expect inferior and gdb output.
1279 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1282 # INFERIOR_PATTERN is the pattern to match against inferior output.
1284 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1285 # include the \r\n sequence immediately before the gdb prompt, nor the
1286 # prompt. The default is empty.
1288 # Both inferior and gdb patterns must match for a PASS.
1290 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1293 # 1 if the test failed,
1294 # 0 if the test passes,
1295 # -1 if there was an internal error.
1298 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1299 global inferior_spawn_id gdb_spawn_id
1302 if {$message == ""} {
1303 set message $command
1306 set inferior_matched 0
1309 # Use an indirect spawn id list, and remove the inferior spawn id
1310 # from the expected output as soon as it matches, in case
1311 # $inferior_pattern happens to be a prefix of the resulting full
1312 # gdb pattern below (e.g., "\r\n").
1313 global gdb_test_stdio_spawn_id_list
1314 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1316 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1317 # then we may see gdb's output arriving before the inferior's
1319 set res [gdb_test_multiple $command $message {
1320 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1321 set inferior_matched 1
1322 if {!$gdb_matched} {
1323 set gdb_test_stdio_spawn_id_list ""
1327 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1329 if {!$inferior_matched} {
1337 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1344 # Issue a PASS and return true if evaluating CONDITION in the caller's
1345 # frame returns true, and issue a FAIL and return false otherwise.
1346 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1347 # omitted or is empty, then the pass/fail messages use the condition
1348 # string as the message.
1350 proc gdb_assert { condition {message ""} } {
1351 if { $message == ""} {
1352 set message $condition
1355 set res [uplevel 1 expr $condition]
1364 proc gdb_reinitialize_dir { subdir } {
1367 if [is_remote host] {
1372 -re "Reinitialize source path to empty.*y or n. " {
1375 -re "Source directories searched.*$gdb_prompt $" {
1376 send_gdb "dir $subdir\n"
1378 -re "Source directories searched.*$gdb_prompt $" {
1379 verbose "Dir set to $subdir"
1381 -re "$gdb_prompt $" {
1382 perror "Dir \"$subdir\" failed."
1386 -re "$gdb_prompt $" {
1387 perror "Dir \"$subdir\" failed."
1391 -re "$gdb_prompt $" {
1392 perror "Dir \"$subdir\" failed."
1398 # gdb_exit -- exit the GDB, killing the target program if necessary
1400 proc default_gdb_exit {} {
1402 global INTERNAL_GDBFLAGS GDBFLAGS
1404 global gdb_spawn_id inferior_spawn_id
1405 global inotify_log_file
1407 gdb_stop_suppressing_tests
1409 if ![info exists gdb_spawn_id] {
1413 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1415 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1416 set fd [open $inotify_log_file]
1417 set data [read -nonewline $fd]
1420 if {[string compare $data ""] != 0} {
1421 warning "parallel-unsafe file creations noticed"
1424 set fd [open $inotify_log_file w]
1429 if { [is_remote host] && [board_info host exists fileid] } {
1436 -re "DOSEXIT code" { }
1441 if ![is_remote host] {
1445 unset inferior_spawn_id
1448 # Load a file into the debugger.
1449 # The return value is 0 for success, -1 for failure.
1451 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1452 # to one of these values:
1454 # debug file was loaded successfully and has debug information
1455 # nodebug file was loaded successfully and has no debug information
1456 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1458 # fail file was not loaded
1460 # I tried returning this information as part of the return value,
1461 # but ran into a mess because of the many re-implementations of
1462 # gdb_load in config/*.exp.
1464 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1465 # this if they can get more information set.
1467 proc gdb_file_cmd { arg } {
1471 global last_loaded_file
1473 # Save this for the benefit of gdbserver-support.exp.
1474 set last_loaded_file $arg
1476 # Set whether debug info was found.
1477 # Default to "fail".
1478 global gdb_file_cmd_debug_info
1479 set gdb_file_cmd_debug_info "fail"
1481 if [is_remote host] {
1482 set arg [remote_download host $arg]
1484 perror "download failed"
1489 # The file command used to kill the remote target. For the benefit
1490 # of the testsuite, preserve this behavior.
1493 -re "Kill the program being debugged. .y or n. $" {
1495 verbose "\t\tKilling previous program being debugged"
1498 -re "$gdb_prompt $" {
1503 send_gdb "file $arg\n"
1505 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1506 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1507 set gdb_file_cmd_debug_info "lzma"
1510 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1511 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1512 set gdb_file_cmd_debug_info "nodebug"
1515 -re "Reading symbols from.*done.*$gdb_prompt $" {
1516 verbose "\t\tLoaded $arg into $GDB"
1517 set gdb_file_cmd_debug_info "debug"
1520 -re "Load new symbol table from \".*\".*y or n. $" {
1523 -re "Reading symbols from.*done.*$gdb_prompt $" {
1524 verbose "\t\tLoaded $arg with new symbol table into $GDB"
1525 set gdb_file_cmd_debug_info "debug"
1529 perror "Couldn't load $arg, other program already loaded (timeout)."
1533 perror "Couldn't load $arg, other program already loaded (eof)."
1538 -re "No such file or directory.*$gdb_prompt $" {
1539 perror "($arg) No such file or directory"
1542 -re "A problem internal to GDB has been detected" {
1543 fail "($arg) (GDB internal error)"
1544 gdb_internal_error_resync
1547 -re "$gdb_prompt $" {
1548 perror "Couldn't load $arg into $GDB."
1552 perror "Couldn't load $arg into $GDB (timeout)."
1556 # This is an attempt to detect a core dump, but seems not to
1557 # work. Perhaps we need to match .* followed by eof, in which
1558 # gdb_expect does not seem to have a way to do that.
1559 perror "Couldn't load $arg into $GDB (eof)."
1565 # Default gdb_spawn procedure.
1567 proc default_gdb_spawn { } {
1570 global INTERNAL_GDBFLAGS GDBFLAGS
1573 gdb_stop_suppressing_tests
1575 # Set the default value, it may be overriden later by specific testfile.
1577 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1578 # is already started after connecting and run/attach are not supported.
1579 # This is used for the "remote" protocol. After GDB starts you should
1580 # check global $use_gdb_stub instead of the board as the testfile may force
1581 # a specific different target protocol itself.
1582 set use_gdb_stub [target_info exists use_gdb_stub]
1584 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1586 if [info exists gdb_spawn_id] {
1590 if ![is_remote host] {
1591 if { [which $GDB] == 0 } then {
1592 perror "$GDB does not exist."
1596 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1597 if { $res < 0 || $res == "" } {
1598 perror "Spawning $GDB failed."
1602 set gdb_spawn_id $res
1606 # Default gdb_start procedure.
1608 proc default_gdb_start { } {
1609 global gdb_prompt pagination_prompt
1611 global inferior_spawn_id
1613 if [info exists gdb_spawn_id] {
1622 # Default to assuming inferior I/O is done on GDB's terminal.
1623 if {![info exists inferior_spawn_id]} {
1624 set inferior_spawn_id $gdb_spawn_id
1627 # When running over NFS, particularly if running many simultaneous
1628 # tests on different hosts all using the same server, things can
1629 # get really slow. Give gdb at least 3 minutes to start up.
1631 while { $loop_again } {
1634 -re "$pagination_prompt" {
1635 verbose "Hit pagination during startup. Pressing enter to continue."
1639 -re "\[\r\n\]$gdb_prompt $" {
1640 verbose "GDB initialized."
1642 -re "$gdb_prompt $" {
1643 perror "GDB never initialized."
1648 perror "(timeout) GDB never initialized after 10 seconds."
1656 # force the height to "unlimited", so no pagers get used
1658 send_gdb "set height 0\n"
1660 -re "$gdb_prompt $" {
1661 verbose "Setting height to 0." 2
1664 warning "Couldn't set the height to 0"
1667 # force the width to "unlimited", so no wraparound occurs
1668 send_gdb "set width 0\n"
1670 -re "$gdb_prompt $" {
1671 verbose "Setting width to 0." 2
1674 warning "Couldn't set the width to 0."
1680 # Utility procedure to give user control of the gdb prompt in a script. It is
1681 # meant to be used for debugging test cases, and should not be left in the
1684 proc gdb_interact { } {
1686 set spawn_id $gdb_spawn_id
1688 send_user "+------------------------------------------+\n"
1689 send_user "| Script interrupted, you can now interact |\n"
1690 send_user "| with by gdb. Type >>> to continue. |\n"
1691 send_user "+------------------------------------------+\n"
1698 # Examine the output of compilation to determine whether compilation
1699 # failed or not. If it failed determine whether it is due to missing
1700 # compiler or due to compiler error. Report pass, fail or unsupported
1703 proc gdb_compile_test {src output} {
1704 if { $output == "" } {
1705 pass "compilation [file tail $src]"
1706 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1707 unsupported "compilation [file tail $src]"
1708 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1709 unsupported "compilation [file tail $src]"
1710 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1711 unsupported "compilation [file tail $src]"
1713 verbose -log "compilation failed: $output" 2
1714 fail "compilation [file tail $src]"
1718 # Return a 1 for configurations for which we don't even want to try to
1721 proc skip_cplus_tests {} {
1722 if { [istarget "h8300-*-*"] } {
1726 # The C++ IO streams are too large for HC11/HC12 and are thus not
1727 # available. The gdb C++ tests use them and don't compile.
1728 if { [istarget "m6811-*-*"] } {
1731 if { [istarget "m6812-*-*"] } {
1737 # Return a 1 for configurations for which don't have both C++ and the STL.
1739 proc skip_stl_tests {} {
1740 # Symbian supports the C++ language, but the STL is missing
1741 # (both headers and libraries).
1742 if { [istarget "arm*-*-symbianelf*"] } {
1746 return [skip_cplus_tests]
1749 # Return a 1 if I don't even want to try to test FORTRAN.
1751 proc skip_fortran_tests {} {
1755 # Return a 1 if I don't even want to try to test ada.
1757 proc skip_ada_tests {} {
1761 # Return a 1 if I don't even want to try to test GO.
1763 proc skip_go_tests {} {
1767 # Return a 1 if I don't even want to try to test D.
1769 proc skip_d_tests {} {
1773 # Return 1 to skip Rust tests, 0 to try them.
1774 proc skip_rust_tests {} {
1775 return [expr {![isnative]}]
1778 # Return a 1 for configurations that do not support Python scripting.
1779 # PROMPT_REGEXP is the expected prompt.
1781 proc skip_python_tests_prompt { prompt_regexp } {
1782 global gdb_py_is_py3k
1783 global gdb_py_is_py24
1785 gdb_test_multiple "python print ('test')" "verify python support" {
1786 -re "not supported.*$prompt_regexp" {
1787 unsupported "Python support is disabled."
1790 -re "$prompt_regexp" {}
1793 set gdb_py_is_py24 0
1794 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1795 -re "3.*$prompt_regexp" {
1796 set gdb_py_is_py3k 1
1798 -re ".*$prompt_regexp" {
1799 set gdb_py_is_py3k 0
1802 if { $gdb_py_is_py3k == 0 } {
1803 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1804 -re "\[45\].*$prompt_regexp" {
1805 set gdb_py_is_py24 1
1807 -re ".*$prompt_regexp" {
1808 set gdb_py_is_py24 0
1816 # Return a 1 for configurations that do not support Python scripting.
1817 # Note: This also sets various globals that specify which version of Python
1818 # is in use. See skip_python_tests_prompt.
1820 proc skip_python_tests {} {
1822 return [skip_python_tests_prompt "$gdb_prompt $"]
1825 # Return a 1 if we should skip shared library tests.
1827 proc skip_shlib_tests {} {
1828 # Run the shared library tests on native systems.
1833 # An abbreviated list of remote targets where we should be able to
1834 # run shared library tests.
1835 if {([istarget *-*-linux*]
1836 || [istarget *-*-*bsd*]
1837 || [istarget *-*-solaris2*]
1838 || [istarget arm*-*-symbianelf*]
1839 || [istarget *-*-mingw*]
1840 || [istarget *-*-cygwin*]
1841 || [istarget *-*-pe*])} {
1848 # Return 1 if we should skip tui related tests.
1850 proc skip_tui_tests {} {
1853 gdb_test_multiple "help layout" "verify tui support" {
1854 -re "Undefined command: \"layout\".*$gdb_prompt $" {
1857 -re "$gdb_prompt $" {
1864 # Test files shall make sure all the test result lines in gdb.sum are
1865 # unique in a test run, so that comparing the gdb.sum files of two
1866 # test runs gives correct results. Test files that exercise
1867 # variations of the same tests more than once, shall prefix the
1868 # different test invocations with different identifying strings in
1869 # order to make them unique.
1871 # About test prefixes:
1873 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
1874 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1875 # underlined substring in
1877 # PASS: gdb.base/mytest.exp: some test
1878 # ^^^^^^^^^^^^^^^^^^^^
1882 # The easiest way to adjust the test prefix is to append a test
1883 # variation prefix to the $pf_prefix, using the with_test_prefix
1886 # proc do_tests {} {
1887 # gdb_test ... ... "test foo"
1888 # gdb_test ... ... "test bar"
1890 # with_test_prefix "subvariation a" {
1891 # gdb_test ... ... "test x"
1894 # with_test_prefix "subvariation b" {
1895 # gdb_test ... ... "test x"
1899 # with_test_prefix "variation1" {
1900 # ...do setup for variation 1...
1904 # with_test_prefix "variation2" {
1905 # ...do setup for variation 2...
1911 # PASS: gdb.base/mytest.exp: variation1: test foo
1912 # PASS: gdb.base/mytest.exp: variation1: test bar
1913 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1914 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1915 # PASS: gdb.base/mytest.exp: variation2: test foo
1916 # PASS: gdb.base/mytest.exp: variation2: test bar
1917 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1918 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1920 # If for some reason more flexibility is necessary, one can also
1921 # manipulate the pf_prefix global directly, treating it as a string.
1925 # set saved_pf_prefix
1926 # append pf_prefix "${foo}: bar"
1927 # ... actual tests ...
1928 # set pf_prefix $saved_pf_prefix
1931 # Run BODY in the context of the caller, with the current test prefix
1932 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
1933 # Returns the result of BODY.
1935 proc with_test_prefix { prefix body } {
1938 set saved $pf_prefix
1939 append pf_prefix " " $prefix ":"
1940 set code [catch {uplevel 1 $body} result]
1941 set pf_prefix $saved
1944 global errorInfo errorCode
1945 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1947 return -code $code $result
1951 # Wrapper for foreach that calls with_test_prefix on each iteration,
1952 # including the iterator's name and current value in the prefix.
1954 proc foreach_with_prefix {var list body} {
1956 foreach myvar $list {
1957 with_test_prefix "$var=$myvar" {
1963 # Like TCL's native proc, but defines a procedure that wraps its body
1964 # within 'with_test_prefix "$proc_name" { ... }'.
1965 proc proc_with_prefix {name arguments body} {
1966 # Define the advertised proc.
1967 proc $name $arguments [list with_test_prefix $name $body]
1971 # Run BODY in the context of the caller. After BODY is run, the variables
1972 # listed in VARS will be reset to the values they had before BODY was run.
1974 # This is useful for providing a scope in which it is safe to temporarily
1975 # modify global variables, e.g.
1977 # global INTERNAL_GDBFLAGS
1980 # set foo GDBHISTSIZE
1982 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
1983 # append INTERNAL_GDBFLAGS " -nx"
1984 # unset -nocomplain env(GDBHISTSIZE)
1989 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
1990 # modified inside BODY, this proc guarantees that the modifications will be
1991 # undone after BODY finishes executing.
1993 proc save_vars { vars body } {
1994 array set saved_scalars { }
1995 array set saved_arrays { }
1999 # First evaluate VAR in the context of the caller in case the variable
2000 # name may be a not-yet-interpolated string like env($foo)
2001 set var [uplevel 1 list $var]
2003 if [uplevel 1 [list info exists $var]] {
2004 if [uplevel 1 [list array exists $var]] {
2005 set saved_arrays($var) [uplevel 1 [list array get $var]]
2007 set saved_scalars($var) [uplevel 1 [list set $var]]
2010 lappend unset_vars $var
2014 set code [catch {uplevel 1 $body} result]
2016 foreach {var value} [array get saved_scalars] {
2017 uplevel 1 [list set $var $value]
2020 foreach {var value} [array get saved_arrays] {
2021 uplevel 1 [list unset $var]
2022 uplevel 1 [list array set $var $value]
2025 foreach var $unset_vars {
2026 uplevel 1 [list unset -nocomplain $var]
2030 global errorInfo errorCode
2031 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2033 return -code $code $result
2038 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2039 # PROMPT. When BODY is finished, restore GDB prompt and variable
2041 # Returns the result of BODY.
2045 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2046 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2047 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2048 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2049 # a) It's more intuitive for callers to pass the plain text form.
2050 # b) We need two forms of the prompt:
2051 # - a regexp to use in output matching,
2052 # - a value to pass to the "set prompt" command.
2053 # c) It's easier to convert the plain text form to its regexp form.
2055 # 2) Don't add a trailing space, we do that here.
2057 proc with_gdb_prompt { prompt body } {
2060 # Convert "(foo)" to "\(foo\)".
2061 # We don't use string_to_regexp because while it works today it's not
2062 # clear it will work tomorrow: the value we need must work as both a
2063 # regexp *and* as the argument to the "set prompt" command, at least until
2064 # we start recording both forms separately instead of just $gdb_prompt.
2065 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2067 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2069 set saved $gdb_prompt
2071 verbose -log "Setting gdb prompt to \"$prompt \"."
2072 set gdb_prompt $prompt
2073 gdb_test_no_output "set prompt $prompt " ""
2075 set code [catch {uplevel 1 $body} result]
2077 verbose -log "Restoring gdb prompt to \"$saved \"."
2078 set gdb_prompt $saved
2079 gdb_test_no_output "set prompt $saved " ""
2082 global errorInfo errorCode
2083 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2085 return -code $code $result
2089 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2090 # BODY is finished, restore target-charset.
2092 proc with_target_charset { target_charset body } {
2096 gdb_test_multiple "show target-charset" "" {
2097 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2098 set saved $expect_out(1,string)
2100 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2101 set saved $expect_out(1,string)
2103 -re ".*$gdb_prompt " {
2104 fail "get target-charset"
2108 gdb_test_no_output "set target-charset $target_charset" ""
2110 set code [catch {uplevel 1 $body} result]
2112 gdb_test_no_output "set target-charset $saved" ""
2115 global errorInfo errorCode
2116 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2118 return -code $code $result
2122 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2123 # mi_gdb_test etc. default to using it.
2125 proc switch_gdb_spawn_id {spawn_id} {
2127 global board board_info
2129 set gdb_spawn_id $spawn_id
2130 set board [host_info name]
2131 set board_info($board,fileid) $spawn_id
2134 # Clear the default spawn id.
2136 proc clear_gdb_spawn_id {} {
2138 global board board_info
2140 unset -nocomplain gdb_spawn_id
2141 set board [host_info name]
2142 unset -nocomplain board_info($board,fileid)
2145 # Run BODY with SPAWN_ID as current spawn id.
2147 proc with_spawn_id { spawn_id body } {
2150 if [info exists gdb_spawn_id] {
2151 set saved_spawn_id $gdb_spawn_id
2154 switch_gdb_spawn_id $spawn_id
2156 set code [catch {uplevel 1 $body} result]
2158 if [info exists saved_spawn_id] {
2159 switch_gdb_spawn_id $saved_spawn_id
2165 global errorInfo errorCode
2166 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2168 return -code $code $result
2172 # Select the largest timeout from all the timeouts:
2173 # - the local "timeout" variable of the scope two levels above,
2174 # - the global "timeout" variable,
2175 # - the board variable "gdb,timeout".
2177 proc get_largest_timeout {} {
2178 upvar #0 timeout gtimeout
2179 upvar 2 timeout timeout
2182 if [info exists timeout] {
2185 if { [info exists gtimeout] && $gtimeout > $tmt } {
2188 if { [target_info exists gdb,timeout]
2189 && [target_info gdb,timeout] > $tmt } {
2190 set tmt [target_info gdb,timeout]
2200 # Run tests in BODY with timeout increased by factor of FACTOR. When
2201 # BODY is finished, restore timeout.
2203 proc with_timeout_factor { factor body } {
2206 set savedtimeout $timeout
2208 set timeout [expr [get_largest_timeout] * $factor]
2209 set code [catch {uplevel 1 $body} result]
2211 set timeout $savedtimeout
2213 global errorInfo errorCode
2214 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2216 return -code $code $result
2220 # Return 1 if _Complex types are supported, otherwise, return 0.
2222 gdb_caching_proc support_complex_tests {
2224 if { [gdb_skip_float_test] } {
2225 # If floating point is not supported, _Complex is not
2230 # Set up, compile, and execute a test program containing _Complex types.
2231 # Include the current process ID in the file names to prevent conflicts
2232 # with invocations for multiple testsuites.
2233 set src [standard_temp_file complex[pid].c]
2234 set exe [standard_temp_file complex[pid].x]
2236 gdb_produce_source $src {
2240 _Complex long double cld;
2245 verbose "compiling testfile $src" 2
2246 set compile_flags {debug nowarnings quiet}
2247 set lines [gdb_compile $src $exe executable $compile_flags]
2251 if ![string match "" $lines] then {
2252 verbose "testfile compilation failed, returning 0" 2
2261 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2264 proc supports_get_siginfo_type {} {
2265 if { [istarget "*-*-linux*"] } {
2272 # Return 1 if the target supports hardware single stepping.
2274 proc can_hardware_single_step {} {
2276 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2277 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2278 || [istarget "nios2-*-*"] } {
2285 # Return 1 if target hardware or OS supports single stepping to signal
2286 # handler, otherwise, return 0.
2288 proc can_single_step_to_signal_handler {} {
2289 # Targets don't have hardware single step. On these targets, when
2290 # a signal is delivered during software single step, gdb is unable
2291 # to determine the next instruction addresses, because start of signal
2292 # handler is one of them.
2293 return [can_hardware_single_step]
2296 # Return 1 if target supports process record, otherwise return 0.
2298 proc supports_process_record {} {
2300 if [target_info exists gdb,use_precord] {
2301 return [target_info gdb,use_precord]
2304 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2305 || [istarget "i\[34567\]86-*-linux*"]
2306 || [istarget "aarch64*-*-linux*"]
2307 || [istarget "powerpc*-*-linux*"]
2308 || [istarget "s390*-*-linux*"] } {
2315 # Return 1 if target supports reverse debugging, otherwise return 0.
2317 proc supports_reverse {} {
2319 if [target_info exists gdb,can_reverse] {
2320 return [target_info gdb,can_reverse]
2323 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2324 || [istarget "i\[34567\]86-*-linux*"]
2325 || [istarget "aarch64*-*-linux*"]
2326 || [istarget "powerpc*-*-linux*"]
2327 || [istarget "s390*-*-linux*"] } {
2334 # Return 1 if readline library is used.
2336 proc readline_is_used { } {
2339 gdb_test_multiple "show editing" "" {
2340 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2343 -re ".*$gdb_prompt $" {
2349 # Return 1 if target is ELF.
2350 gdb_caching_proc is_elf_target {
2351 set me "is_elf_target"
2353 set src [standard_temp_file is_elf_target[pid].c]
2354 set obj [standard_temp_file is_elf_target[pid].o]
2356 gdb_produce_source $src {
2357 int foo () {return 0;}
2360 verbose "$me: compiling testfile $src" 2
2361 set lines [gdb_compile $src $obj object {quiet}]
2365 if ![string match "" $lines] then {
2366 verbose "$me: testfile compilation failed, returning 0" 2
2370 set fp_obj [open $obj "r"]
2371 fconfigure $fp_obj -translation binary
2372 set data [read $fp_obj]
2377 set ELFMAG "\u007FELF"
2379 if {[string compare -length 4 $data $ELFMAG] != 0} {
2380 verbose "$me: returning 0" 2
2384 verbose "$me: returning 1" 2
2388 # Return 1 if the memory at address zero is readable.
2390 gdb_caching_proc is_address_zero_readable {
2394 gdb_test_multiple "x 0" "" {
2395 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2398 -re ".*$gdb_prompt $" {
2406 # Produce source file NAME and write SOURCES into it.
2408 proc gdb_produce_source { name sources } {
2410 set f [open $name "w"]
2416 # Return 1 if target is ILP32.
2417 # This cannot be decided simply from looking at the target string,
2418 # as it might depend on externally passed compiler options like -m64.
2419 gdb_caching_proc is_ilp32_target {
2420 set me "is_ilp32_target"
2422 set src [standard_temp_file ilp32[pid].c]
2423 set obj [standard_temp_file ilp32[pid].o]
2425 gdb_produce_source $src {
2426 int dummy[sizeof (int) == 4
2427 && sizeof (void *) == 4
2428 && sizeof (long) == 4 ? 1 : -1];
2431 verbose "$me: compiling testfile $src" 2
2432 set lines [gdb_compile $src $obj object {quiet}]
2436 if ![string match "" $lines] then {
2437 verbose "$me: testfile compilation failed, returning 0" 2
2441 verbose "$me: returning 1" 2
2445 # Return 1 if target is LP64.
2446 # This cannot be decided simply from looking at the target string,
2447 # as it might depend on externally passed compiler options like -m64.
2448 gdb_caching_proc is_lp64_target {
2449 set me "is_lp64_target"
2451 set src [standard_temp_file lp64[pid].c]
2452 set obj [standard_temp_file lp64[pid].o]
2454 gdb_produce_source $src {
2455 int dummy[sizeof (int) == 4
2456 && sizeof (void *) == 8
2457 && sizeof (long) == 8 ? 1 : -1];
2460 verbose "$me: compiling testfile $src" 2
2461 set lines [gdb_compile $src $obj object {quiet}]
2465 if ![string match "" $lines] then {
2466 verbose "$me: testfile compilation failed, returning 0" 2
2470 verbose "$me: returning 1" 2
2474 # Return 1 if target has 64 bit addresses.
2475 # This cannot be decided simply from looking at the target string,
2476 # as it might depend on externally passed compiler options like -m64.
2477 gdb_caching_proc is_64_target {
2478 set me "is_64_target"
2480 set src [standard_temp_file is64[pid].c]
2481 set obj [standard_temp_file is64[pid].o]
2483 gdb_produce_source $src {
2484 int function(void) { return 3; }
2485 int dummy[sizeof (&function) == 8 ? 1 : -1];
2488 verbose "$me: compiling testfile $src" 2
2489 set lines [gdb_compile $src $obj object {quiet}]
2493 if ![string match "" $lines] then {
2494 verbose "$me: testfile compilation failed, returning 0" 2
2498 verbose "$me: returning 1" 2
2502 # Return 1 if target has x86_64 registers - either amd64 or x32.
2503 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2504 # just from the target string.
2505 gdb_caching_proc is_amd64_regs_target {
2506 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2510 set me "is_amd64_regs_target"
2512 set src [standard_temp_file reg64[pid].s]
2513 set obj [standard_temp_file reg64[pid].o]
2517 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2518 lappend list "\tincq %$reg"
2520 gdb_produce_source $src [join $list \n]
2522 verbose "$me: compiling testfile $src" 2
2523 set lines [gdb_compile $src $obj object {quiet}]
2527 if ![string match "" $lines] then {
2528 verbose "$me: testfile compilation failed, returning 0" 2
2532 verbose "$me: returning 1" 2
2536 # Return 1 if this target is an x86 or x86-64 with -m32.
2537 proc is_x86_like_target {} {
2538 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2541 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2544 # Return 1 if this target is an arm or aarch32 on aarch64.
2546 gdb_caching_proc is_aarch32_target {
2547 if { [istarget "arm*-*-*"] } {
2551 if { ![istarget "aarch64*-*-*"] } {
2555 set me "is_aarch32_target"
2557 set src [standard_temp_file aarch32[pid].s]
2558 set obj [standard_temp_file aarch32[pid].o]
2563 lappend list "\tmov $reg, $reg"
2565 gdb_produce_source $src [join $list \n]
2567 verbose "$me: compiling testfile $src" 2
2568 set lines [gdb_compile $src $obj object {quiet}]
2572 if ![string match "" $lines] then {
2573 verbose "$me: testfile compilation failed, returning 0" 2
2577 verbose "$me: returning 1" 2
2581 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2583 proc is_aarch64_target {} {
2584 if { ![istarget "aarch64*-*-*"] } {
2588 return [expr ![is_aarch32_target]]
2591 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2592 proc support_displaced_stepping {} {
2594 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2595 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2596 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2597 || [istarget "aarch64*-*-linux*"] } {
2604 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2605 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2607 gdb_caching_proc skip_altivec_tests {
2608 global srcdir subdir gdb_prompt inferior_exited_re
2610 set me "skip_altivec_tests"
2612 # Some simulators are known to not support VMX instructions.
2613 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2614 verbose "$me: target known to not support VMX, returning 1" 2
2618 # Make sure we have a compiler that understands altivec.
2619 set compile_flags {debug nowarnings}
2620 if [get_compiler_info] {
2621 warning "Could not get compiler info"
2624 if [test_compiler_info gcc*] {
2625 set compile_flags "$compile_flags additional_flags=-maltivec"
2626 } elseif [test_compiler_info xlc*] {
2627 set compile_flags "$compile_flags additional_flags=-qaltivec"
2629 verbose "Could not compile with altivec support, returning 1" 2
2633 # Set up, compile, and execute a test program containing VMX instructions.
2634 # Include the current process ID in the file names to prevent conflicts
2635 # with invocations for multiple testsuites.
2636 set src [standard_temp_file vmx[pid].c]
2637 set exe [standard_temp_file vmx[pid].x]
2639 gdb_produce_source $src {
2642 asm volatile ("vor v0,v0,v0");
2644 asm volatile ("vor 0,0,0");
2650 verbose "$me: compiling testfile $src" 2
2651 set lines [gdb_compile $src $exe executable $compile_flags]
2654 if ![string match "" $lines] then {
2655 verbose "$me: testfile compilation failed, returning 1" 2
2659 # No error message, compilation succeeded so now run it via gdb.
2663 gdb_reinitialize_dir $srcdir/$subdir
2667 -re ".*Illegal instruction.*${gdb_prompt} $" {
2668 verbose -log "\n$me altivec hardware not detected"
2669 set skip_vmx_tests 1
2671 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2672 verbose -log "\n$me: altivec hardware detected"
2673 set skip_vmx_tests 0
2676 warning "\n$me: default case taken"
2677 set skip_vmx_tests 1
2681 remote_file build delete $exe
2683 verbose "$me: returning $skip_vmx_tests" 2
2684 return $skip_vmx_tests
2687 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2688 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2690 gdb_caching_proc skip_vsx_tests {
2691 global srcdir subdir gdb_prompt inferior_exited_re
2693 set me "skip_vsx_tests"
2695 # Some simulators are known to not support Altivec instructions, so
2696 # they won't support VSX instructions as well.
2697 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2698 verbose "$me: target known to not support VSX, returning 1" 2
2702 # Make sure we have a compiler that understands altivec.
2703 set compile_flags {debug nowarnings quiet}
2704 if [get_compiler_info] {
2705 warning "Could not get compiler info"
2708 if [test_compiler_info gcc*] {
2709 set compile_flags "$compile_flags additional_flags=-mvsx"
2710 } elseif [test_compiler_info xlc*] {
2711 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
2713 verbose "Could not compile with vsx support, returning 1" 2
2717 set src [standard_temp_file vsx[pid].c]
2718 set exe [standard_temp_file vsx[pid].x]
2720 gdb_produce_source $src {
2722 double a[2] = { 1.0, 2.0 };
2724 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2726 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2732 verbose "$me: compiling testfile $src" 2
2733 set lines [gdb_compile $src $exe executable $compile_flags]
2736 if ![string match "" $lines] then {
2737 verbose "$me: testfile compilation failed, returning 1" 2
2741 # No error message, compilation succeeded so now run it via gdb.
2745 gdb_reinitialize_dir $srcdir/$subdir
2749 -re ".*Illegal instruction.*${gdb_prompt} $" {
2750 verbose -log "\n$me VSX hardware not detected"
2751 set skip_vsx_tests 1
2753 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2754 verbose -log "\n$me: VSX hardware detected"
2755 set skip_vsx_tests 0
2758 warning "\n$me: default case taken"
2759 set skip_vsx_tests 1
2763 remote_file build delete $exe
2765 verbose "$me: returning $skip_vsx_tests" 2
2766 return $skip_vsx_tests
2769 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2770 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2772 gdb_caching_proc skip_tsx_tests {
2773 global srcdir subdir gdb_prompt inferior_exited_re
2775 set me "skip_tsx_tests"
2777 set src [standard_temp_file tsx[pid].c]
2778 set exe [standard_temp_file tsx[pid].x]
2780 gdb_produce_source $src {
2782 asm volatile ("xbegin .L0");
2783 asm volatile ("xend");
2784 asm volatile (".L0: nop");
2789 verbose "$me: compiling testfile $src" 2
2790 set lines [gdb_compile $src $exe executable {nowarnings quiet}]
2793 if ![string match "" $lines] then {
2794 verbose "$me: testfile compilation failed." 2
2798 # No error message, compilation succeeded so now run it via gdb.
2802 gdb_reinitialize_dir $srcdir/$subdir
2806 -re ".*Illegal instruction.*${gdb_prompt} $" {
2807 verbose -log "$me: TSX hardware not detected."
2808 set skip_tsx_tests 1
2810 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2811 verbose -log "$me: TSX hardware detected."
2812 set skip_tsx_tests 0
2815 warning "\n$me: default case taken."
2816 set skip_tsx_tests 1
2820 remote_file build delete $exe
2822 verbose "$me: returning $skip_tsx_tests" 2
2823 return $skip_tsx_tests
2826 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2827 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2829 gdb_caching_proc skip_btrace_tests {
2830 global srcdir subdir gdb_prompt inferior_exited_re
2832 set me "skip_btrace_tests"
2833 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2834 verbose "$me: target does not support btrace, returning 1" 2
2838 # Set up, compile, and execute a test program.
2839 # Include the current process ID in the file names to prevent conflicts
2840 # with invocations for multiple testsuites.
2841 set src [standard_temp_file btrace[pid].c]
2842 set exe [standard_temp_file btrace[pid].x]
2844 gdb_produce_source $src {
2845 int main(void) { return 0; }
2848 verbose "$me: compiling testfile $src" 2
2849 set compile_flags {debug nowarnings quiet}
2850 set lines [gdb_compile $src $exe executable $compile_flags]
2852 if ![string match "" $lines] then {
2853 verbose "$me: testfile compilation failed, returning 1" 2
2858 # No error message, compilation succeeded so now run it via gdb.
2862 gdb_reinitialize_dir $srcdir/$subdir
2869 # In case of an unexpected output, we return 2 as a fail value.
2870 set skip_btrace_tests 2
2871 gdb_test_multiple "record btrace" "check btrace support" {
2872 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2873 set skip_btrace_tests 1
2875 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2876 set skip_btrace_tests 1
2878 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2879 set skip_btrace_tests 1
2881 -re "^record btrace\r\n$gdb_prompt $" {
2882 set skip_btrace_tests 0
2886 remote_file build delete $exe
2888 verbose "$me: returning $skip_btrace_tests" 2
2889 return $skip_btrace_tests
2892 # Run a test on the target to see if it supports btrace pt hardware.
2893 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
2894 # from the GCC testsuite.
2896 gdb_caching_proc skip_btrace_pt_tests {
2897 global srcdir subdir gdb_prompt inferior_exited_re
2899 set me "skip_btrace_tests"
2900 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2901 verbose "$me: target does not support btrace, returning 1" 2
2905 # Set up, compile, and execute a test program.
2906 # Include the current process ID in the file names to prevent conflicts
2907 # with invocations for multiple testsuites.
2908 set src [standard_temp_file btrace[pid].c]
2909 set exe [standard_temp_file btrace[pid].x]
2911 gdb_produce_source $src {
2912 int main(void) { return 0; }
2915 verbose "$me: compiling testfile $src" 2
2916 set compile_flags {debug nowarnings quiet}
2917 set lines [gdb_compile $src $exe executable $compile_flags]
2919 if ![string match "" $lines] then {
2920 verbose "$me: testfile compilation failed, returning 1" 2
2925 # No error message, compilation succeeded so now run it via gdb.
2929 gdb_reinitialize_dir $srcdir/$subdir
2936 # In case of an unexpected output, we return 2 as a fail value.
2937 set skip_btrace_tests 2
2938 gdb_test_multiple "record btrace pt" "check btrace support" {
2939 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
2940 set skip_btrace_tests 1
2942 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
2943 set skip_btrace_tests 1
2945 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
2946 set skip_btrace_tests 1
2948 -re "GDB does not support.*\r\n$gdb_prompt $" {
2949 set skip_btrace_tests 1
2951 -re "^record btrace pt\r\n$gdb_prompt $" {
2952 set skip_btrace_tests 0
2956 remote_file build delete $exe
2958 verbose "$me: returning $skip_btrace_tests" 2
2959 return $skip_btrace_tests
2962 # Return whether we should skip tests for showing inlined functions in
2963 # backtraces. Requires get_compiler_info and get_debug_format.
2965 proc skip_inline_frame_tests {} {
2966 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2967 if { ! [test_debug_format "DWARF 2"] } {
2971 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2972 if { ([test_compiler_info "gcc-2-*"]
2973 || [test_compiler_info "gcc-3-*"]
2974 || [test_compiler_info "gcc-4-0-*"]) } {
2981 # Return whether we should skip tests for showing variables from
2982 # inlined functions. Requires get_compiler_info and get_debug_format.
2984 proc skip_inline_var_tests {} {
2985 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2986 if { ! [test_debug_format "DWARF 2"] } {
2993 # Return a 1 if we should skip tests that require hardware breakpoints
2995 proc skip_hw_breakpoint_tests {} {
2996 # Skip tests if requested by the board (note that no_hardware_watchpoints
2997 # disables both watchpoints and breakpoints)
2998 if { [target_info exists gdb,no_hardware_watchpoints]} {
3002 # These targets support hardware breakpoints natively
3003 if { [istarget "i?86-*-*"]
3004 || [istarget "x86_64-*-*"]
3005 || [istarget "ia64-*-*"]
3006 || [istarget "arm*-*-*"]
3007 || [istarget "aarch64*-*-*"]
3008 || [istarget "s390*-*-*"] } {
3015 # Return a 1 if we should skip tests that require hardware watchpoints
3017 proc skip_hw_watchpoint_tests {} {
3018 # Skip tests if requested by the board
3019 if { [target_info exists gdb,no_hardware_watchpoints]} {
3023 # These targets support hardware watchpoints natively
3024 if { [istarget "i?86-*-*"]
3025 || [istarget "x86_64-*-*"]
3026 || [istarget "ia64-*-*"]
3027 || [istarget "arm*-*-*"]
3028 || [istarget "aarch64*-*-*"]
3029 || [istarget "powerpc*-*-linux*"]
3030 || [istarget "s390*-*-*"] } {
3037 # Return a 1 if we should skip tests that require *multiple* hardware
3038 # watchpoints to be active at the same time
3040 proc skip_hw_watchpoint_multi_tests {} {
3041 if { [skip_hw_watchpoint_tests] } {
3045 # These targets support just a single hardware watchpoint
3046 if { [istarget "arm*-*-*"]
3047 || [istarget "powerpc*-*-linux*"] } {
3054 # Return a 1 if we should skip tests that require read/access watchpoints
3056 proc skip_hw_watchpoint_access_tests {} {
3057 if { [skip_hw_watchpoint_tests] } {
3061 # These targets support just write watchpoints
3062 if { [istarget "s390*-*-*"] } {
3069 # Return 1 if we should skip tests that require the runtime unwinder
3070 # hook. This must be invoked while gdb is running, after shared
3071 # libraries have been loaded. This is needed because otherwise a
3072 # shared libgcc won't be visible.
3074 proc skip_unwinder_tests {} {
3078 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3079 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3081 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3084 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3088 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3089 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3092 -re "\r\n$gdb_prompt $" {
3099 # Return 0 if we should skip tests that require the libstdc++ stap
3100 # probes. This must be invoked while gdb is running, after shared
3101 # libraries have been loaded.
3103 proc skip_libstdcxx_probe_tests {} {
3107 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3108 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
3111 -re "\r\n$gdb_prompt $" {
3117 # Return 1 if we should skip tests of the "compile" feature.
3118 # This must be invoked after the inferior has been started.
3120 proc skip_compile_feature_tests {} {
3124 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3125 "Could not load libcc1.*\r\n$gdb_prompt $" {
3128 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3131 -re "\r\n$gdb_prompt $" {
3137 # Helper for gdb_is_target_remote. PROMPT_REGEXP is the expected
3140 proc gdb_is_target_remote_prompt { prompt_regexp } {
3142 set test "probe for target remote"
3143 gdb_test_multiple "maint print target-stack" $test {
3144 -re ".*emote serial target in gdb-specific protocol.*$prompt_regexp" {
3148 -re "$prompt_regexp" {
3155 # Check whether we're testing with the remote or extended-remote
3158 proc gdb_is_target_remote {} {
3161 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3164 # Return the effective value of use_gdb_stub.
3166 # If the use_gdb_stub global has been set (it is set when the gdb process is
3167 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3168 # property from the board file.
3170 # This is the preferred way of checking use_gdb_stub, since it allows to check
3171 # the value before the gdb has been spawned and it will return the correct value
3172 # even when it was overriden by the test.
3174 proc use_gdb_stub {} {
3177 if [info exists use_gdb_stub] {
3178 return $use_gdb_stub
3181 return [target_info exists use_gdb_stub]
3184 # Return 1 if the current remote target is an instance of our GDBserver, 0
3185 # otherwise. Return -1 if there was an error and we can't tell.
3187 gdb_caching_proc target_is_gdbserver {
3191 set test "probing for GDBserver"
3193 gdb_test_multiple "monitor help" $test {
3194 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3197 -re "$gdb_prompt $" {
3202 if { $is_gdbserver == -1 } {
3203 verbose -log "Unable to tell whether we are using GDBserver or not."
3206 return $is_gdbserver
3209 # N.B. compiler_info is intended to be local to this file.
3210 # Call test_compiler_info with no arguments to fetch its value.
3211 # Yes, this is counterintuitive when there's get_compiler_info,
3212 # but that's the current API.
3213 if [info exists compiler_info] {
3219 # Figure out what compiler I am using.
3220 # The result is cached so only the first invocation runs the compiler.
3222 # ARG can be empty or "C++". If empty, "C" is assumed.
3224 # There are several ways to do this, with various problems.
3226 # [ gdb_compile -E $ifile -o $binfile.ci ]
3227 # source $binfile.ci
3229 # Single Unix Spec v3 says that "-E -o ..." together are not
3230 # specified. And in fact, the native compiler on hp-ux 11 (among
3231 # others) does not work with "-E -o ...". Most targets used to do
3232 # this, and it mostly worked, because it works with gcc.
3234 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3235 # source $binfile.ci
3237 # This avoids the problem with -E and -o together. This almost works
3238 # if the build machine is the same as the host machine, which is
3239 # usually true of the targets which are not gcc. But this code does
3240 # not figure which compiler to call, and it always ends up using the C
3241 # compiler. Not good for setting hp_aCC_compiler. Target
3242 # hppa*-*-hpux* used to do this.
3244 # [ gdb_compile -E $ifile > $binfile.ci ]
3245 # source $binfile.ci
3247 # dejagnu target_compile says that it supports output redirection,
3248 # but the code is completely different from the normal path and I
3249 # don't want to sweep the mines from that path. So I didn't even try
3252 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3255 # I actually do this for all targets now. gdb_compile runs the right
3256 # compiler, and TCL captures the output, and I eval the output.
3258 # Unfortunately, expect logs the output of the command as it goes by,
3259 # and dejagnu helpfully prints a second copy of it right afterwards.
3260 # So I turn off expect logging for a moment.
3262 # [ gdb_compile $ifile $ciexe_file executable $args ]
3263 # [ remote_exec $ciexe_file ]
3264 # [ source $ci_file.out ]
3266 # I could give up on -E and just do this.
3267 # I didn't get desperate enough to try this.
3269 # -- chastain 2004-01-06
3271 proc get_compiler_info {{arg ""}} {
3272 # For compiler.c and compiler.cc
3275 # I am going to play with the log to keep noise out.
3279 # These come from compiler.c or compiler.cc
3280 global compiler_info
3282 # Legacy global data symbols.
3285 if [info exists compiler_info] {
3290 # Choose which file to preprocess.
3291 set ifile "${srcdir}/lib/compiler.c"
3292 if { $arg == "c++" } {
3293 set ifile "${srcdir}/lib/compiler.cc"
3296 # Run $ifile through the right preprocessor.
3297 # Toggle gdb.log to keep the compiler output out of the log.
3298 set saved_log [log_file -info]
3300 if [is_remote host] {
3301 # We have to use -E and -o together, despite the comments
3302 # above, because of how DejaGnu handles remote host testing.
3303 set ppout "$outdir/compiler.i"
3304 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
3305 set file [open $ppout r]
3306 set cppout [read $file]
3309 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
3311 eval log_file $saved_log
3315 foreach cppline [ split "$cppout" "\n" ] {
3316 if { [ regexp "^#" "$cppline" ] } {
3318 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3320 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3322 verbose "get_compiler_info: $cppline" 2
3326 verbose -log "get_compiler_info: $cppline"
3331 # Set to unknown if for some reason compiler_info didn't get defined.
3332 if ![info exists compiler_info] {
3333 verbose -log "get_compiler_info: compiler_info not provided"
3334 set compiler_info "unknown"
3336 # Also set to unknown compiler if any diagnostics happened.
3338 verbose -log "get_compiler_info: got unexpected diagnostics"
3339 set compiler_info "unknown"
3342 # Set the legacy symbols.
3344 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3346 # Log what happened.
3347 verbose -log "get_compiler_info: $compiler_info"
3349 # Most compilers will evaluate comparisons and other boolean
3350 # operations to 0 or 1.
3351 uplevel \#0 { set true 1 }
3352 uplevel \#0 { set false 0 }
3357 # Return the compiler_info string if no arg is provided.
3358 # Otherwise the argument is a glob-style expression to match against
3361 proc test_compiler_info { {compiler ""} } {
3362 global compiler_info
3365 # If no arg, return the compiler_info string.
3366 if [string match "" $compiler] {
3367 return $compiler_info
3370 return [string match $compiler $compiler_info]
3373 proc current_target_name { } {
3375 if [info exists target_info(target,name)] {
3376 set answer $target_info(target,name)
3383 set gdb_wrapper_initialized 0
3384 set gdb_wrapper_target ""
3386 proc gdb_wrapper_init { args } {
3387 global gdb_wrapper_initialized
3388 global gdb_wrapper_file
3389 global gdb_wrapper_flags
3390 global gdb_wrapper_target
3392 if { $gdb_wrapper_initialized == 1 } { return; }
3394 if {[target_info exists needs_status_wrapper] && \
3395 [target_info needs_status_wrapper] != "0"} {
3396 set result [build_wrapper "testglue.o"]
3397 if { $result != "" } {
3398 set gdb_wrapper_file [lindex $result 0]
3399 set gdb_wrapper_flags [lindex $result 1]
3401 warning "Status wrapper failed to build."
3404 set gdb_wrapper_initialized 1
3405 set gdb_wrapper_target [current_target_name]
3408 # Determine options that we always want to pass to the compiler.
3409 gdb_caching_proc universal_compile_options {
3410 set me "universal_compile_options"
3413 set src [standard_temp_file ccopts[pid].c]
3414 set obj [standard_temp_file ccopts[pid].o]
3416 gdb_produce_source $src {
3417 int foo(void) { return 0; }
3420 # Try an option for disabling colored diagnostics. Some compilers
3421 # yield colored diagnostics by default (when run from a tty) unless
3422 # such an option is specified.
3423 set opt "additional_flags=-fdiagnostics-color=never"
3424 set lines [target_compile $src $obj object [list "quiet" $opt]]
3425 if [string match "" $lines] then {
3426 # Seems to have worked; use the option.
3427 lappend options $opt
3432 verbose "$me: returning $options" 2
3436 # Some targets need to always link a special object in. Save its path here.
3437 global gdb_saved_set_unbuffered_mode_obj
3438 set gdb_saved_set_unbuffered_mode_obj ""
3440 # Compile source files specified by SOURCE into a binary of type TYPE at path
3441 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3442 # parameter and most options are passed directly to it.
3444 # The type can be one of the following:
3446 # - object: Compile into an object file.
3447 # - executable: Compile and link into an executable.
3448 # - preprocess: Preprocess the source files.
3449 # - assembly: Generate assembly listing.
3451 # The following options are understood and processed by gdb_compile:
3453 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3454 # quirks to be able to use shared libraries.
3455 # - shlib_load: Link with appropriate libraries to allow the test to
3456 # dynamically load libraries at runtime. For example, on Linux, this adds
3457 # -ldl so that the test can use dlopen.
3458 # - nowarnings: Inhibit all compiler warnings.
3460 # And here are some of the not too obscure options understood by DejaGnu that
3461 # influence the compilation:
3463 # - additional_flags=flag: Add FLAG to the compiler flags.
3464 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3465 # argument can be a file, in which case it's added to the sources, or a
3467 # - ldflags=flag: Add FLAG to the linker flags.
3468 # - incdir=path: Add PATH to the searched include directories.
3469 # - libdir=path: Add PATH to the linker searched directories.
3470 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3471 # - debug: Build with debug information.
3472 # - optimize: Build with optimization.
3474 proc gdb_compile {source dest type options} {
3475 global GDB_TESTCASE_OPTIONS
3476 global gdb_wrapper_file
3477 global gdb_wrapper_flags
3478 global gdb_wrapper_initialized
3481 global gdb_saved_set_unbuffered_mode_obj
3483 set outdir [file dirname $dest]
3485 # Add platform-specific options if a shared library was specified using
3486 # "shlib=librarypath" in OPTIONS.
3487 if {[lsearch -exact $options rust] != -1} {
3488 # -fdiagnostics-color is not a rustcc option.
3490 set new_options [universal_compile_options]
3495 foreach opt $options {
3496 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
3497 if [test_compiler_info "xlc-*"] {
3498 # IBM xlc compiler doesn't accept shared library named other
3499 # than .so: use "-Wl," to bypass this
3500 lappend source "-Wl,$shlib_name"
3501 } elseif { ([istarget "*-*-mingw*"]
3502 || [istarget *-*-cygwin*]
3503 || [istarget *-*-pe*])} {
3504 lappend source "${shlib_name}.a"
3506 lappend source $shlib_name
3508 if { $shlib_found == 0 } {
3510 if { ([istarget "*-*-mingw*"]
3511 || [istarget *-*-cygwin*]) } {
3512 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3514 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3515 # Undo debian's change in the default.
3516 # Put it at the front to not override any user-provided
3517 # value, and to make sure it appears in front of all the
3519 lappend new_options "early_flags=-Wl,--no-as-needed"
3522 } elseif { $opt == "shlib_load" } {
3525 lappend new_options $opt
3529 # Because we link with libraries using their basename, we may need
3530 # (depending on the platform) to set a special rpath value, to allow
3531 # the executable to find the libraries it depends on.
3532 if { $shlib_load || $shlib_found } {
3533 if { ([istarget "*-*-mingw*"]
3534 || [istarget *-*-cygwin*]
3535 || [istarget *-*-pe*]) } {
3536 # Do not need anything.
3537 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3538 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3539 } elseif { [istarget arm*-*-symbianelf*] } {
3540 if { $shlib_load } {
3541 lappend new_options "libs=-ldl"
3544 if { $shlib_load } {
3545 lappend new_options "libs=-ldl"
3547 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3550 set options $new_options
3552 if [info exists GDB_TESTCASE_OPTIONS] {
3553 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3555 verbose "options are $options"
3556 verbose "source is $source $dest $type $options"
3558 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3560 if {[target_info exists needs_status_wrapper] && \
3561 [target_info needs_status_wrapper] != "0" && \
3562 [info exists gdb_wrapper_file]} {
3563 lappend options "libs=${gdb_wrapper_file}"
3564 lappend options "ldflags=${gdb_wrapper_flags}"
3567 # Replace the "nowarnings" option with the appropriate additional_flags
3568 # to disable compiler warnings.
3569 set nowarnings [lsearch -exact $options nowarnings]
3570 if {$nowarnings != -1} {
3571 if [target_info exists gdb,nowarnings_flag] {
3572 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3574 set flag "additional_flags=-w"
3576 set options [lreplace $options $nowarnings $nowarnings $flag]
3579 if { $type == "executable" } {
3580 if { ([istarget "*-*-mingw*"]
3581 || [istarget "*-*-*djgpp"]
3582 || [istarget "*-*-cygwin*"])} {
3583 # Force output to unbuffered mode, by linking in an object file
3584 # with a global contructor that calls setvbuf.
3586 # Compile the special object seperatelly for two reasons:
3587 # 1) Insulate it from $options.
3588 # 2) Avoid compiling it for every gdb_compile invocation,
3589 # which is time consuming, especially if we're remote
3592 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3593 verbose "compiling gdb_saved_set_unbuffered_obj"
3594 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3595 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3597 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3598 if { $result != "" } {
3601 if {[is_remote host]} {
3602 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3604 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3606 # Link a copy of the output object, because the
3607 # original may be automatically deleted.
3608 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3610 verbose "gdb_saved_set_unbuffered_obj already compiled"
3613 # Rely on the internal knowledge that the global ctors are ran in
3614 # reverse link order. In that case, we can use ldflags to
3615 # avoid copying the object file to the host multiple
3617 # This object can only be added if standard libraries are
3618 # used. Thus, we need to disable it if -nostdlib option is used
3619 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3620 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3625 set result [target_compile $source $dest $type $options]
3627 # Prune uninteresting compiler (and linker) output.
3628 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3630 regsub "\[\r\n\]*$" "$result" "" result
3631 regsub "^\[\r\n\]*" "$result" "" result
3633 if {[lsearch $options quiet] < 0} {
3634 # We shall update this on a per language basis, to avoid
3635 # changing the entire testsuite in one go.
3636 if {[lsearch $options f77] >= 0} {
3637 gdb_compile_test $source $result
3638 } elseif { $result != "" } {
3639 clone_output "gdb compile failed, $result"
3646 # This is just like gdb_compile, above, except that it tries compiling
3647 # against several different thread libraries, to see which one this
3649 proc gdb_compile_pthreads {source dest type options} {
3651 set why_msg "unrecognized error"
3652 foreach lib {-lpthreads -lpthread -lthread ""} {
3653 # This kind of wipes out whatever libs the caller may have
3654 # set. Or maybe theirs will override ours. How infelicitous.
3655 set options_with_lib [concat $options [list libs=$lib quiet]]
3656 set ccout [gdb_compile $source $dest $type $options_with_lib]
3657 switch -regexp -- $ccout {
3658 ".*no posix threads support.*" {
3659 set why_msg "missing threads include file"
3662 ".*cannot open -lpthread.*" {
3663 set why_msg "missing runtime threads library"
3665 ".*Can't find library for -lpthread.*" {
3666 set why_msg "missing runtime threads library"
3669 pass "successfully compiled posix threads test case"
3675 if {!$built_binfile} {
3676 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3681 # Build a shared library from SOURCES.
3683 proc gdb_compile_shlib {sources dest options} {
3684 set obj_options $options
3687 if { [lsearch -exact $options "c++"] >= 0 } {
3688 set info_options "c++"
3690 if [get_compiler_info ${info_options}] {
3694 switch -glob [test_compiler_info] {
3696 lappend obj_options "additional_flags=-qpic"
3699 if { !([istarget "*-*-cygwin*"]
3700 || [istarget "*-*-mingw*"]) } {
3701 lappend obj_options "additional_flags=-fpic"
3705 if { !([istarget "powerpc*-*-aix*"]
3706 || [istarget "rs6000*-*-aix*"]
3707 || [istarget "*-*-cygwin*"]
3708 || [istarget "*-*-mingw*"]
3709 || [istarget "*-*-pe*"]) } {
3710 lappend obj_options "additional_flags=-fpic"
3714 lappend obj_options "additional_flags=-fpic"
3717 # don't know what the compiler is...
3721 set outdir [file dirname $dest]
3723 foreach source $sources {
3724 set sourcebase [file tail $source]
3725 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
3728 lappend objects ${outdir}/${sourcebase}.o
3731 set link_options $options
3732 if [test_compiler_info "xlc-*"] {
3733 lappend link_options "additional_flags=-qmkshrobj"
3735 lappend link_options "additional_flags=-shared"
3737 if { ([istarget "*-*-mingw*"]
3738 || [istarget *-*-cygwin*]
3739 || [istarget *-*-pe*]) } {
3740 if { [is_remote host] } {
3741 set name [file tail ${dest}]
3745 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3747 # Set the soname of the library. This causes the linker on ELF
3748 # systems to create the DT_NEEDED entry in the executable referring
3749 # to the soname of the library, and not its absolute path. This
3750 # (using the absolute path) would be problem when testing on a
3753 # In conjunction with setting the soname, we add the special
3754 # rpath=$ORIGIN value when building the executable, so that it's
3755 # able to find the library in its own directory.
3756 set destbase [file tail $dest]
3757 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3760 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
3763 if { [is_remote host]
3764 && ([istarget "*-*-mingw*"]
3765 || [istarget *-*-cygwin*]
3766 || [istarget *-*-pe*]) } {
3767 set dest_tail_name [file tail ${dest}]
3768 remote_upload host $dest_tail_name.a ${dest}.a
3769 remote_file host delete $dest_tail_name.a
3775 # This is just like gdb_compile_shlib, above, except that it tries compiling
3776 # against several different thread libraries, to see which one this
3778 proc gdb_compile_shlib_pthreads {sources dest options} {
3780 set why_msg "unrecognized error"
3781 foreach lib {-lpthreads -lpthread -lthread ""} {
3782 # This kind of wipes out whatever libs the caller may have
3783 # set. Or maybe theirs will override ours. How infelicitous.
3784 set options_with_lib [concat $options [list libs=$lib quiet]]
3785 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3786 switch -regexp -- $ccout {
3787 ".*no posix threads support.*" {
3788 set why_msg "missing threads include file"
3791 ".*cannot open -lpthread.*" {
3792 set why_msg "missing runtime threads library"
3794 ".*Can't find library for -lpthread.*" {
3795 set why_msg "missing runtime threads library"
3798 pass "successfully compiled posix threads test case"
3804 if {!$built_binfile} {
3805 unsupported "couldn't compile $sources: ${why_msg}"
3810 # This is just like gdb_compile_pthreads, above, except that we always add the
3811 # objc library for compiling Objective-C programs
3812 proc gdb_compile_objc {source dest type options} {
3814 set why_msg "unrecognized error"
3815 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3816 # This kind of wipes out whatever libs the caller may have
3817 # set. Or maybe theirs will override ours. How infelicitous.
3818 if { $lib == "solaris" } {
3819 set lib "-lpthread -lposix4"
3821 if { $lib != "-lobjc" } {
3822 set lib "-lobjc $lib"
3824 set options_with_lib [concat $options [list libs=$lib quiet]]
3825 set ccout [gdb_compile $source $dest $type $options_with_lib]
3826 switch -regexp -- $ccout {
3827 ".*no posix threads support.*" {
3828 set why_msg "missing threads include file"
3831 ".*cannot open -lpthread.*" {
3832 set why_msg "missing runtime threads library"
3834 ".*Can't find library for -lpthread.*" {
3835 set why_msg "missing runtime threads library"
3838 pass "successfully compiled objc with posix threads test case"
3844 if {!$built_binfile} {
3845 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3850 proc send_gdb { string } {
3851 global suppress_flag
3852 if { $suppress_flag } {
3855 return [remote_send host "$string"]
3858 # Send STRING to the inferior's terminal.
3860 proc send_inferior { string } {
3861 global inferior_spawn_id
3863 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3873 proc gdb_expect { args } {
3874 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3875 set atimeout [lindex $args 0]
3876 set expcode [list [lindex $args 1]]
3881 # A timeout argument takes precedence, otherwise of all the timeouts
3882 # select the largest.
3883 if [info exists atimeout] {
3886 set tmt [get_largest_timeout]
3889 global suppress_flag
3890 global remote_suppress_flag
3891 if [info exists remote_suppress_flag] {
3892 set old_val $remote_suppress_flag
3894 if [info exists suppress_flag] {
3895 if { $suppress_flag } {
3896 set remote_suppress_flag 1
3900 {uplevel remote_expect host $tmt $expcode} string]
3901 if [info exists old_val] {
3902 set remote_suppress_flag $old_val
3904 if [info exists remote_suppress_flag] {
3905 unset remote_suppress_flag
3910 global errorInfo errorCode
3912 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
3914 return -code $code $string
3918 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
3920 # Check for long sequence of output by parts.
3921 # TEST: is the test message to be printed with the test success/fail.
3922 # SENTINEL: Is the terminal pattern indicating that output has finished.
3923 # LIST: is the sequence of outputs to match.
3924 # If the sentinel is recognized early, it is considered an error.
3927 # 1 if the test failed,
3928 # 0 if the test passes,
3929 # -1 if there was an internal error.
3931 proc gdb_expect_list {test sentinel list} {
3933 global suppress_flag
3936 if { $suppress_flag } {
3938 unresolved "${test}"
3940 while { ${index} < [llength ${list}] } {
3941 set pattern [lindex ${list} ${index}]
3942 set index [expr ${index} + 1]
3943 verbose -log "gdb_expect_list pattern: /$pattern/" 2
3944 if { ${index} == [llength ${list}] } {
3947 -re "${pattern}${sentinel}" {
3948 # pass "${test}, pattern ${index} + sentinel"
3951 fail "${test} (pattern ${index} + sentinel)"
3954 -re ".*A problem internal to GDB has been detected" {
3955 fail "${test} (GDB internal error)"
3957 gdb_internal_error_resync
3960 fail "${test} (pattern ${index} + sentinel) (timeout)"
3965 # unresolved "${test}, pattern ${index} + sentinel"
3971 # pass "${test}, pattern ${index}"
3974 fail "${test} (pattern ${index})"
3977 -re ".*A problem internal to GDB has been detected" {
3978 fail "${test} (GDB internal error)"
3980 gdb_internal_error_resync
3983 fail "${test} (pattern ${index}) (timeout)"
3988 # unresolved "${test}, pattern ${index}"
4002 proc gdb_suppress_entire_file { reason } {
4003 global suppress_flag
4006 set suppress_flag -1
4010 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4011 # gdb_expect to fail immediately (until the next call to
4012 # gdb_stop_suppressing_tests).
4014 proc gdb_suppress_tests { args } {
4015 global suppress_flag
4017 return; # fnf - disable pending review of results where
4018 # testsuite ran better without this
4021 if { $suppress_flag == 1 } {
4022 if { [llength $args] > 0 } {
4023 warning "[lindex $args 0]\n"
4025 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4031 # Clear suppress_flag.
4033 proc gdb_stop_suppressing_tests { } {
4034 global suppress_flag
4036 if [info exists suppress_flag] {
4037 if { $suppress_flag > 0 } {
4039 clone_output "Tests restarted.\n"
4046 proc gdb_clear_suppressed { } {
4047 global suppress_flag
4052 # Spawn the gdb process.
4054 # This doesn't expect any output or do any other initialization,
4055 # leaving those to the caller.
4057 # Overridable function -- you can override this function in your
4060 proc gdb_spawn { } {
4064 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4066 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4069 set saved_gdbflags $GDBFLAGS
4071 if {$GDBFLAGS != ""} {
4074 append GDBFLAGS $cmdline_flags
4078 set GDBFLAGS $saved_gdbflags
4083 # Start gdb running, wait for prompt, and disable the pagers.
4085 # Overridable function -- you can override this function in your
4088 proc gdb_start { } {
4093 catch default_gdb_exit
4096 # Return true if we can spawn a program on the target and attach to
4099 proc can_spawn_for_attach { } {
4100 # We use exp_pid to get the inferior's pid, assuming that gives
4101 # back the pid of the program. On remote boards, that would give
4102 # us instead the PID of e.g., the ssh client, etc.
4103 if [is_remote target] then {
4107 # The "attach" command doesn't make sense when the target is
4108 # stub-like, where GDB finds the program already started on
4109 # initial connection.
4110 if {[target_info exists use_gdb_stub]} {
4118 # Kill a progress previously started with spawn_wait_for_attach, and
4119 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4122 proc kill_wait_spawned_process { proc_spawn_id } {
4123 set pid [exp_pid -i $proc_spawn_id]
4125 verbose -log "killing ${pid}"
4126 remote_exec build "kill -9 ${pid}"
4128 verbose -log "closing ${proc_spawn_id}"
4129 catch "close -i $proc_spawn_id"
4130 verbose -log "waiting for ${proc_spawn_id}"
4132 # If somehow GDB ends up still attached to the process here, a
4133 # blocking wait hangs until gdb is killed (or until gdb / the
4134 # ptracer reaps the exit status too, but that won't happen because
4135 # something went wrong.) Passing -nowait makes expect tell Tcl to
4136 # wait for the PID in the background. That's fine because we
4137 # don't care about the exit status. */
4138 wait -nowait -i $proc_spawn_id
4141 # Returns the process id corresponding to the given spawn id.
4143 proc spawn_id_get_pid { spawn_id } {
4144 set testpid [exp_pid -i $spawn_id]
4146 if { [istarget "*-*-cygwin*"] } {
4147 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4148 # might be different due to the way fork/exec works.
4149 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4155 # Start a set of programs running and then wait for a bit, to be sure
4156 # that they can be attached to. Return a list of processes spawn IDs,
4157 # one element for each process spawned. It's a test error to call
4158 # this when [can_spawn_for_attach] is false.
4160 proc spawn_wait_for_attach { executable_list } {
4161 set spawn_id_list {}
4163 if ![can_spawn_for_attach] {
4164 # The caller should have checked can_spawn_for_attach itself
4165 # before getting here.
4166 error "can't spawn for attach with this target/board"
4169 foreach {executable} $executable_list {
4170 # Note we use Expect's spawn, not Tcl's exec, because with
4171 # spawn we control when to wait for/reap the process. That
4172 # allows killing the process by PID without being subject to
4174 lappend spawn_id_list [remote_spawn target $executable]
4179 return $spawn_id_list
4183 # gdb_load_cmd -- load a file into the debugger.
4184 # ARGS - additional args to load command.
4185 # return a -1 if anything goes wrong.
4187 proc gdb_load_cmd { args } {
4190 if [target_info exists gdb_load_timeout] {
4191 set loadtimeout [target_info gdb_load_timeout]
4193 set loadtimeout 1600
4195 send_gdb "load $args\n"
4196 verbose "Timeout is now $loadtimeout seconds" 2
4197 gdb_expect $loadtimeout {
4198 -re "Loading section\[^\r\]*\r\n" {
4201 -re "Start address\[\r\]*\r\n" {
4204 -re "Transfer rate\[\r\]*\r\n" {
4207 -re "Memory access error\[^\r\]*\r\n" {
4208 perror "Failed to load program"
4211 -re "$gdb_prompt $" {
4214 -re "(.*)\r\n$gdb_prompt " {
4215 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4219 perror "Timed out trying to load $args."
4226 # Invoke "gcore". CORE is the name of the core file to write. TEST
4227 # is the name of the test case. This will return 1 if the core file
4228 # was created, 0 otherwise. If this fails to make a core file because
4229 # this configuration of gdb does not support making core files, it
4230 # will call "unsupported", not "fail". However, if this fails to make
4231 # a core file for some other reason, then it will call "fail".
4233 proc gdb_gcore_cmd {core test} {
4237 gdb_test_multiple "gcore $core" $test {
4238 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4242 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4250 # Load core file CORE. TEST is the name of the test case.
4251 # This will record a pass/fail for loading the core file.
4253 # 1 - core file is successfully loaded
4254 # 0 - core file loaded but has a non fatal error
4255 # -1 - core file failed to load
4257 proc gdb_core_cmd { core test } {
4260 gdb_test_multiple "core $core" "$test" {
4261 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4264 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4265 fail "$test (bad file format)"
4268 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4269 fail "$test (file not found)"
4272 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4273 fail "$test (incomplete note section)"
4276 -re "Core was generated by .*\r\n$gdb_prompt $" {
4280 -re ".*$gdb_prompt $" {
4285 fail "$test (timeout)"
4289 fail "unsupported output from 'core' command"
4293 # Return the filename to download to the target and load on the target
4294 # for this shared library. Normally just LIBNAME, unless shared libraries
4295 # for this target have separate link and load images.
4297 proc shlib_target_file { libname } {
4301 # Return the filename GDB will load symbols from when debugging this
4302 # shared library. Normally just LIBNAME, unless shared libraries for
4303 # this target have separate link and load images.
4305 proc shlib_symbol_file { libname } {
4309 # Return the filename to download to the target and load for this
4310 # executable. Normally just BINFILE unless it is renamed to something
4311 # else for this target.
4313 proc exec_target_file { binfile } {
4317 # Return the filename GDB will load symbols from when debugging this
4318 # executable. Normally just BINFILE unless executables for this target
4319 # have separate files for symbols.
4321 proc exec_symbol_file { binfile } {
4325 # Rename the executable file. Normally this is just BINFILE1 being renamed
4326 # to BINFILE2, but some targets require multiple binary files.
4327 proc gdb_rename_execfile { binfile1 binfile2 } {
4328 file rename -force [exec_target_file ${binfile1}] \
4329 [exec_target_file ${binfile2}]
4330 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4331 file rename -force [exec_symbol_file ${binfile1}] \
4332 [exec_symbol_file ${binfile2}]
4336 # "Touch" the executable file to update the date. Normally this is just
4337 # BINFILE, but some targets require multiple files.
4338 proc gdb_touch_execfile { binfile } {
4339 set time [clock seconds]
4340 file mtime [exec_target_file ${binfile}] $time
4341 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4342 file mtime [exec_symbol_file ${binfile}] $time
4346 # Like remote_download but provides a gdb-specific behavior.
4348 # If the destination board is remote, the local file FROMFILE is transferred as
4349 # usual with remote_download to TOFILE on the remote board. The destination
4350 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4353 # If the destination board is local, the destination path TOFILE is passed
4354 # through standard_output_file, and FROMFILE is copied there.
4356 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4359 proc gdb_remote_download {dest fromfile {tofile {}}} {
4360 # If TOFILE is not given, default to the same filename as FROMFILE.
4361 if {[string length $tofile] == 0} {
4362 set tofile [file tail $fromfile]
4365 if {[is_remote $dest]} {
4366 # When the DEST is remote, we simply send the file to DEST.
4369 set destname [remote_download $dest $fromfile $tofile]
4370 lappend cleanfiles $destname
4374 # When the DEST is local, we copy the file to the test directory (where
4375 # the executable is).
4377 # Note that we pass TOFILE through standard_output_file, regardless of
4378 # whether it is absolute or relative, because we don't want the tests
4379 # to be able to write outside their standard output directory.
4381 set tofile [standard_output_file $tofile]
4383 file copy -force $fromfile $tofile
4389 # gdb_load_shlib LIB...
4391 # Copy the listed library to the target.
4393 proc gdb_load_shlib { file } {
4394 set dest [gdb_remote_download target [shlib_target_file $file]]
4396 if {[is_remote target]} {
4397 # If the target is remote, we need to tell gdb where to find the
4400 # We could set this even when not testing remotely, but a user
4401 # generally won't set it unless necessary. In order to make the tests
4402 # more like the real-life scenarios, we don't set it for local testing.
4403 gdb_test "set solib-search-path [file dirname $file]" "" ""
4410 # gdb_load -- load a file into the debugger. Specifying no file
4411 # defaults to the executable currently being debugged.
4412 # The return value is 0 for success, -1 for failure.
4413 # Many files in config/*.exp override this procedure.
4415 proc gdb_load { arg } {
4417 return [gdb_file_cmd $arg]
4422 # gdb_reload -- load a file into the target. Called before "running",
4423 # either the first time or after already starting the program once,
4424 # for remote targets. Most files that override gdb_load should now
4425 # override this instead.
4427 proc gdb_reload { } {
4428 # For the benefit of existing configurations, default to gdb_load.
4429 # Specifying no file defaults to the executable currently being
4431 return [gdb_load ""]
4434 proc gdb_continue { function } {
4437 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4440 proc default_gdb_init { test_file_name } {
4441 global gdb_wrapper_initialized
4442 global gdb_wrapper_target
4443 global gdb_test_file_name
4449 gdb_clear_suppressed
4451 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4453 # Make sure that the wrapper is rebuilt
4454 # with the appropriate multilib option.
4455 if { $gdb_wrapper_target != [current_target_name] } {
4456 set gdb_wrapper_initialized 0
4459 # Unlike most tests, we have a small number of tests that generate
4460 # a very large amount of output. We therefore increase the expect
4461 # buffer size to be able to contain the entire test output. This
4462 # is especially needed by gdb.base/info-macros.exp.
4464 # Also set this value for the currently running GDB.
4465 match_max [match_max -d]
4467 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4468 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4471 if [target_info exists gdb_prompt] {
4472 set gdb_prompt [target_info gdb_prompt]
4474 set gdb_prompt "\\(gdb\\)"
4477 if [info exists use_gdb_stub] {
4482 # Return a path using GDB_PARALLEL.
4483 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4484 # GDB_PARALLEL must be defined, the caller must check.
4486 # The default value for GDB_PARALLEL is, canonically, ".".
4487 # The catch is that tests don't expect an additional "./" in file paths so
4488 # omit any directory for the default case.
4489 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4490 # its special handling.
4492 proc make_gdb_parallel_path { args } {
4493 global GDB_PARALLEL objdir
4494 set joiner [list "file" "join" $objdir]
4495 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4496 lappend joiner $GDB_PARALLEL
4498 set joiner [concat $joiner $args]
4499 return [eval $joiner]
4502 # Turn BASENAME into a full file name in the standard output
4503 # directory. It is ok if BASENAME is the empty string; in this case
4504 # the directory is returned.
4506 proc standard_output_file {basename} {
4507 global objdir subdir gdb_test_file_name
4509 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4511 return [file join $dir $basename]
4514 # Return the name of a file in our standard temporary directory.
4516 proc standard_temp_file {basename} {
4517 # Since a particular runtest invocation is only executing a single test
4518 # file at any given time, we can use the runtest pid to build the
4519 # path of the temp directory.
4520 set dir [make_gdb_parallel_path temp [pid]]
4522 return [file join $dir $basename]
4525 # Set 'testfile', 'srcfile', and 'binfile'.
4527 # ARGS is a list of source file specifications.
4528 # Without any arguments, the .exp file's base name is used to
4529 # compute the source file name. The ".c" extension is added in this case.
4530 # If ARGS is not empty, each entry is a source file specification.
4531 # If the specification starts with a ".", it is treated as a suffix
4532 # to append to the .exp file's base name.
4533 # If the specification is the empty string, it is treated as if it
4535 # Otherwise it is a file name.
4536 # The first file in the list is used to set the 'srcfile' global.
4537 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
4539 # Most tests should call this without arguments.
4541 # If a completely different binary file name is needed, then it
4542 # should be handled in the .exp file with a suitable comment.
4544 proc standard_testfile {args} {
4545 global gdb_test_file_name
4547 global gdb_test_file_last_vars
4550 global testfile binfile
4552 set testfile $gdb_test_file_name
4553 set binfile [standard_output_file ${testfile}]
4555 if {[llength $args] == 0} {
4559 # Unset our previous output variables.
4560 # This can help catch hidden bugs.
4561 if {[info exists gdb_test_file_last_vars]} {
4562 foreach varname $gdb_test_file_last_vars {
4564 catch {unset $varname}
4567 # 'executable' is often set by tests.
4568 set gdb_test_file_last_vars {executable}
4572 set varname srcfile$suffix
4575 # Handle an extension.
4578 } elseif {[string range $arg 0 0] == "."} {
4579 set arg $testfile$arg
4583 lappend gdb_test_file_last_vars $varname
4585 if {$suffix == ""} {
4593 # The default timeout used when testing GDB commands. We want to use
4594 # the same timeout as the default dejagnu timeout, unless the user has
4595 # already provided a specific value (probably through a site.exp file).
4596 global gdb_test_timeout
4597 if ![info exists gdb_test_timeout] {
4598 set gdb_test_timeout $timeout
4601 # A list of global variables that GDB testcases should not use.
4602 # We try to prevent their use by monitoring write accesses and raising
4603 # an error when that happens.
4604 set banned_variables { bug_id prms_id }
4606 # A list of procedures that GDB testcases should not use.
4607 # We try to prevent their use by monitoring invocations and raising
4608 # an error when that happens.
4609 set banned_procedures { strace }
4611 # gdb_init is called by runtest at start, but also by several
4612 # tests directly; gdb_finish is only called from within runtest after
4613 # each test source execution.
4614 # Placing several traces by repetitive calls to gdb_init leads
4615 # to problems, as only one trace is removed in gdb_finish.
4616 # To overcome this possible problem, we add a variable that records
4617 # if the banned variables and procedures are already traced.
4620 proc gdb_init { test_file_name } {
4621 # Reset the timeout value to the default. This way, any testcase
4622 # that changes the timeout value without resetting it cannot affect
4623 # the timeout used in subsequent testcases.
4624 global gdb_test_timeout
4626 set timeout $gdb_test_timeout
4628 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
4629 && [target_info exists gdb_reverse_timeout] } {
4630 set timeout [target_info gdb_reverse_timeout]
4633 # If GDB_INOTIFY is given, check for writes to '.'. This is a
4634 # debugging tool to help confirm that the test suite is
4635 # parallel-safe. You need "inotifywait" from the
4636 # inotify-tools package to use this.
4637 global GDB_INOTIFY inotify_pid
4638 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
4639 global outdir tool inotify_log_file
4641 set exclusions {outputs temp gdb[.](log|sum) cache}
4642 set exclusion_re ([join $exclusions |])
4644 set inotify_log_file [standard_temp_file inotify.out]
4645 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
4646 --exclude $exclusion_re \
4647 |& tee -a $outdir/$tool.log $inotify_log_file &]
4649 # Wait for the watches; hopefully this is long enough.
4652 # Clear the log so that we don't emit a warning the first time
4654 set fd [open $inotify_log_file w]
4658 # Block writes to all banned variables, and invocation of all
4659 # banned procedures...
4660 global banned_variables
4661 global banned_procedures
4662 global banned_traced
4663 if (!$banned_traced) {
4664 foreach banned_var $banned_variables {
4665 global "$banned_var"
4666 trace add variable "$banned_var" write error
4668 foreach banned_proc $banned_procedures {
4669 global "$banned_proc"
4670 trace add execution "$banned_proc" enter error
4675 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4676 # messages as expected.
4681 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4682 # the test results. Even if /dev/null doesn't exist on the particular
4683 # platform, the readline library will use the default setting just by
4684 # failing to open the file. OTOH, opening /dev/null successfully will
4685 # also result in the default settings being used since nothing will be
4686 # read from this file.
4687 setenv INPUTRC "/dev/null"
4689 # The gdb.base/readline.exp arrow key test relies on the standard VT100
4690 # bindings, so make sure that an appropriate terminal is selected.
4691 # The same bug doesn't show up if we use ^P / ^N instead.
4694 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
4695 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4696 # especially having color output turned on can cause tests to fail.
4697 setenv GREP_OPTIONS ""
4699 # Clear $gdbserver_reconnect_p.
4700 global gdbserver_reconnect_p
4701 set gdbserver_reconnect_p 1
4702 unset gdbserver_reconnect_p
4704 return [default_gdb_init $test_file_name]
4707 proc gdb_finish { } {
4708 global gdbserver_reconnect_p
4712 # Exit first, so that the files are no longer in use.
4715 if { [llength $cleanfiles] > 0 } {
4716 eval remote_file target delete $cleanfiles
4720 # Unblock write access to the banned variables. Dejagnu typically
4721 # resets some of them between testcases.
4722 global banned_variables
4723 global banned_procedures
4724 global banned_traced
4725 if ($banned_traced) {
4726 foreach banned_var $banned_variables {
4727 global "$banned_var"
4728 trace remove variable "$banned_var" write error
4730 foreach banned_proc $banned_procedures {
4731 global "$banned_proc"
4732 trace remove execution "$banned_proc" enter error
4739 set debug_format "unknown"
4741 # Run the gdb command "info source" and extract the debugging format
4742 # information from the output and save it in debug_format.
4744 proc get_debug_format { } {
4750 set debug_format "unknown"
4751 send_gdb "info source\n"
4753 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
4754 set debug_format $expect_out(1,string)
4755 verbose "debug format is $debug_format"
4758 -re "No current source file.\r\n$gdb_prompt $" {
4759 perror "get_debug_format used when no current source file"
4762 -re "$gdb_prompt $" {
4763 warning "couldn't check debug format (no valid response)."
4767 warning "couldn't check debug format (timeout)."
4773 # Return true if FORMAT matches the debug format the current test was
4774 # compiled with. FORMAT is a shell-style globbing pattern; it can use
4775 # `*', `[...]', and so on.
4777 # This function depends on variables set by `get_debug_format', above.
4779 proc test_debug_format {format} {
4782 return [expr [string match $format $debug_format] != 0]
4785 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4786 # COFF, stabs, etc). If that format matches the format that the
4787 # current test was compiled with, then the next test is expected to
4788 # fail for any target. Returns 1 if the next test or set of tests is
4789 # expected to fail, 0 otherwise (or if it is unknown). Must have
4790 # previously called get_debug_format.
4791 proc setup_xfail_format { format } {
4792 set ret [test_debug_format $format]
4800 # gdb_get_line_number TEXT [FILE]
4802 # Search the source file FILE, and return the line number of the
4803 # first line containing TEXT. If no match is found, an error is thrown.
4805 # TEXT is a string literal, not a regular expression.
4807 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4808 # specified, and does not start with "/", then it is assumed to be in
4809 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4810 # by changing the callers and the interface at the same time.
4811 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4812 # gdb.base/ena-dis-br.exp.
4814 # Use this function to keep your test scripts independent of the
4815 # exact line numbering of the source file. Don't write:
4817 # send_gdb "break 20"
4819 # This means that if anyone ever edits your test's source file,
4820 # your test could break. Instead, put a comment like this on the
4821 # source file line you want to break at:
4823 # /* breakpoint spot: frotz.exp: test name */
4825 # and then write, in your test script (which we assume is named
4828 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
4830 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4833 # % puts "foo [lindex "bar baz" 1]"
4836 # Tcl is quite clever, for a little stringy language.)
4840 # The previous implementation of this procedure used the gdb search command.
4841 # This version is different:
4843 # . It works with MI, and it also works when gdb is not running.
4845 # . It operates on the build machine, not the host machine.
4847 # . For now, this implementation fakes a current directory of
4848 # $srcdir/$subdir to be compatible with the old implementation.
4849 # This will go away eventually and some callers will need to
4852 # . The TEXT argument is literal text and matches literally,
4853 # not a regular expression as it was before.
4855 # . State changes in gdb, such as changing the current file
4856 # and setting $_, no longer happen.
4858 # After a bit of time we can forget about the differences from the
4859 # old implementation.
4861 # --chastain 2004-08-05
4863 proc gdb_get_line_number { text { file "" } } {
4868 if { "$file" == "" } then {
4871 if { ! [regexp "^/" "$file"] } then {
4872 set file "$srcdir/$subdir/$file"
4875 if { [ catch { set fd [open "$file"] } message ] } then {
4880 for { set line 1 } { 1 } { incr line } {
4881 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
4884 if { $nchar < 0 } then {
4887 if { [string first "$text" "$body"] >= 0 } then {
4893 if { [ catch { close "$fd" } message ] } then {
4898 error "undefined tag \"$text\""
4904 # Continue the program until it ends.
4906 # MSSG is the error message that gets printed. If not given, a
4908 # COMMAND is the command to invoke. If not given, "continue" is
4910 # ALLOW_EXTRA is a flag indicating whether the test should expect
4911 # extra output between the "Continuing." line and the program
4912 # exiting. By default it is zero; if nonzero, any extra output
4915 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
4916 global inferior_exited_re use_gdb_stub
4919 set text "continue until exit"
4921 set text "continue until exit at $mssg"
4929 # By default, we don't rely on exit() behavior of remote stubs --
4930 # it's common for exit() to be implemented as a simple infinite
4931 # loop, or a forced crash/reset. For native targets, by default, we
4932 # assume process exit is reported as such. If a non-reliable target
4933 # is used, we set a breakpoint at exit, and continue to that.
4934 if { [target_info exists exit_is_reliable] } {
4935 set exit_is_reliable [target_info exit_is_reliable]
4937 set exit_is_reliable [expr ! $use_gdb_stub]
4940 if { ! $exit_is_reliable } {
4941 if {![gdb_breakpoint "exit"]} {
4944 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
4947 # Continue until we exit. Should not stop again.
4948 # Don't bother to check the output of the program, that may be
4949 # extremely tough for some remote systems.
4951 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
4956 proc rerun_to_main {} {
4957 global gdb_prompt use_gdb_stub
4962 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4963 {pass "rerun to main" ; return 0}
4964 -re "$gdb_prompt $"\
4965 {fail "rerun to main" ; return 0}
4966 timeout {fail "(timeout) rerun to main" ; return 0}
4971 -re "The program .* has been started already.*y or n. $" {
4975 -re "Starting program.*$gdb_prompt $"\
4976 {pass "rerun to main" ; return 0}
4977 -re "$gdb_prompt $"\
4978 {fail "rerun to main" ; return 0}
4979 timeout {fail "(timeout) rerun to main" ; return 0}
4984 # Return true if a test should be skipped due to lack of floating
4985 # point support or GDB can't fetch the contents from floating point
4988 gdb_caching_proc gdb_skip_float_test {
4989 if [target_info exists gdb,skip_float_tests] {
4993 # There is an ARM kernel ptrace bug that hardware VFP registers
4994 # are not updated after GDB ptrace set VFP registers. The bug
4995 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
4996 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
4997 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
4998 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
4999 # This kernel bug is detected by check how does GDB change the
5000 # program result by changing one VFP register.
5001 if { [istarget "arm*-*-linux*"] } {
5003 set compile_flags {debug nowarnings }
5005 # Set up, compile, and execute a test program having VFP
5007 set src [standard_temp_file arm_vfp[pid].c]
5008 set exe [standard_temp_file arm_vfp[pid].x]
5010 gdb_produce_source $src {
5015 asm ("vldr d0, [%0]" : : "r" (&d));
5016 asm ("vldr d1, [%0]" : : "r" (&d));
5017 asm (".global break_here\n"
5019 asm ("vcmp.f64 d0, d1\n"
5020 "vmrs APSR_nzcv, fpscr\n"
5021 "bne L_value_different\n"
5024 "L_value_different:\n"
5026 "L_end:\n" : "=r" (ret) :);
5028 /* Return $d0 != $d1. */
5033 verbose "compiling testfile $src" 2
5034 set lines [gdb_compile $src $exe executable $compile_flags]
5037 if ![string match "" $lines] then {
5038 verbose "testfile compilation failed, returning 1" 2
5042 # No error message, compilation succeeded so now run it via gdb.
5043 # Run the test up to 5 times to detect whether ptrace can
5044 # correctly update VFP registers or not.
5046 for {set i 0} {$i < 5} {incr i} {
5047 global gdb_prompt srcdir subdir
5051 gdb_reinitialize_dir $srcdir/$subdir
5055 gdb_test "break *break_here"
5056 gdb_continue_to_breakpoint "break_here"
5058 # Modify $d0 to a different value, so the exit code should
5060 gdb_test "set \$d0 = 5.0"
5062 set test "continue to exit"
5063 gdb_test_multiple "continue" "$test" {
5064 -re "exited with code 01.*$gdb_prompt $" {
5066 -re "exited normally.*$gdb_prompt $" {
5067 # However, the exit code is 0. That means something
5068 # wrong in setting VFP registers.
5076 remote_file build delete $exe
5078 return $skip_vfp_test
5083 # Print a message and return true if a test should be skipped
5084 # due to lack of stdio support.
5086 proc gdb_skip_stdio_test { msg } {
5087 if [target_info exists gdb,noinferiorio] {
5088 verbose "Skipping test '$msg': no inferior i/o."
5094 proc gdb_skip_bogus_test { msg } {
5098 # Return true if a test should be skipped due to lack of XML support
5100 # NOTE: This must be called while gdb is *not* running.
5102 gdb_caching_proc gdb_skip_xml_test {
5107 if { [info exists gdb_spawn_id] } {
5108 error "GDB must not be running in gdb_skip_xml_tests."
5111 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5115 gdb_test_multiple "set tdesc filename $xml_file" "" {
5116 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5119 -re ".*$gdb_prompt $" { }
5125 # Return true if argv[0] is available.
5127 gdb_caching_proc gdb_has_argv0 {
5130 # Set up, compile, and execute a test program to check whether
5131 # argv[0] is available.
5132 set src [standard_temp_file has_argv0[pid].c]
5133 set exe [standard_temp_file has_argv0[pid].x]
5135 gdb_produce_source $src {
5136 int main (int argc, char **argv) {
5141 gdb_compile $src $exe executable {debug}
5144 proc gdb_has_argv0_1 { exe } {
5145 global srcdir subdir
5146 global gdb_prompt hex
5150 gdb_reinitialize_dir $srcdir/$subdir
5153 # Set breakpoint on main.
5154 gdb_test_multiple "break main" "break main" {
5155 -re "Breakpoint.*${gdb_prompt} $" {
5157 -re "${gdb_prompt} $" {
5164 gdb_test_multiple "" "run to main" {
5165 -re "Breakpoint.*${gdb_prompt} $" {
5167 -re "${gdb_prompt} $" {
5172 set old_elements "200"
5173 set test "show print elements"
5174 gdb_test_multiple $test $test {
5175 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5176 set old_elements $expect_out(1,string)
5179 set old_repeats "200"
5180 set test "show print repeats"
5181 gdb_test_multiple $test $test {
5182 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5183 set old_repeats $expect_out(1,string)
5186 gdb_test_no_output "set print elements unlimited" ""
5187 gdb_test_no_output "set print repeats unlimited" ""
5190 # Check whether argc is 1.
5191 gdb_test_multiple "p argc" "p argc" {
5192 -re " = 1\r\n${gdb_prompt} $" {
5194 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5195 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5198 -re "${gdb_prompt} $" {
5202 -re "${gdb_prompt} $" {
5206 gdb_test_no_output "set print elements $old_elements" ""
5207 gdb_test_no_output "set print repeats $old_repeats" ""
5212 set result [gdb_has_argv0_1 $exe]
5219 && ([istarget *-*-linux*]
5220 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5221 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5222 || [istarget *-*-openbsd*]
5223 || [istarget *-*-darwin*]
5224 || [istarget *-*-solaris*]
5225 || [istarget *-*-aix*]
5226 || [istarget *-*-gnu*]
5227 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5228 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5229 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5230 || [istarget *-*-symbianelf*]
5231 || [istarget *-*-osf*]
5232 || [istarget *-*-dicos*]
5233 || [istarget *-*-nto*]
5234 || [istarget *-*-*vms*]
5235 || [istarget *-*-lynx*178]) } {
5236 fail "argv\[0\] should be available on this target"
5242 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5243 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5244 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5245 # the name of a debuginfo only file. This file will be stored in the same
5248 # Functions for separate debug info testing
5250 # starting with an executable:
5251 # foo --> original executable
5253 # at the end of the process we have:
5254 # foo.stripped --> foo w/o debug info
5255 # foo.debug --> foo's debug info
5256 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5258 # Fetch the build id from the file.
5259 # Returns "" if there is none.
5261 proc get_build_id { filename } {
5262 if { ([istarget "*-*-mingw*"]
5263 || [istarget *-*-cygwin*]) } {
5264 set objdump_program [gdb_find_objdump]
5265 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5266 verbose "result is $result"
5267 verbose "output is $output"
5273 set tmp [standard_output_file "${filename}-tmp"]
5274 set objcopy_program [gdb_find_objcopy]
5275 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5276 verbose "result is $result"
5277 verbose "output is $output"
5282 fconfigure $fi -translation binary
5283 # Skip the NOTE header.
5288 if ![string compare $data ""] then {
5291 # Convert it to hex.
5292 binary scan $data H* data
5297 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5298 # converted to the form: .build-id/ab/cdef1234...89.debug
5299 # Return "" if no build-id found.
5300 proc build_id_debug_filename_get { filename } {
5301 set data [get_build_id $filename]
5302 if { $data == "" } {
5305 regsub {^..} $data {\0/} data
5306 return ".build-id/${data}.debug"
5309 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5310 # list of optional flags. The only currently supported flag is no-main,
5311 # which removes the symbol entry for main from the separate debug file.
5313 # Function returns zero on success. Function will return non-zero failure code
5314 # on some targets not supporting separate debug info (such as i386-msdos).
5316 proc gdb_gnu_strip_debug { dest args } {
5318 # Use the first separate debug info file location searched by GDB so the
5319 # run cannot be broken by some stale file searched with higher precedence.
5320 set debug_file "${dest}.debug"
5322 set strip_to_file_program [transform strip]
5323 set objcopy_program [gdb_find_objcopy]
5325 set debug_link [file tail $debug_file]
5326 set stripped_file "${dest}.stripped"
5328 # Get rid of the debug info, and store result in stripped_file
5329 # something like gdb/testsuite/gdb.base/blah.stripped.
5330 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5331 verbose "result is $result"
5332 verbose "output is $output"
5337 # Workaround PR binutils/10802:
5338 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5339 set perm [file attributes ${dest} -permissions]
5340 file attributes ${stripped_file} -permissions $perm
5342 # Get rid of everything but the debug info, and store result in debug_file
5343 # This will be in the .debug subdirectory, see above.
5344 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5345 verbose "result is $result"
5346 verbose "output is $output"
5351 # If no-main is passed, strip the symbol for main from the separate
5352 # file. This is to simulate the behavior of elfutils's eu-strip, which
5353 # leaves the symtab in the original file only. There's no way to get
5354 # objcopy or strip to remove the symbol table without also removing the
5355 # debugging sections, so this is as close as we can get.
5356 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5357 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5358 verbose "result is $result"
5359 verbose "output is $output"
5363 file delete "${debug_file}"
5364 file rename "${debug_file}-tmp" "${debug_file}"
5367 # Link the two previous output files together, adding the .gnu_debuglink
5368 # section to the stripped_file, containing a pointer to the debug_file,
5369 # save the new file in dest.
5370 # This will be the regular executable filename, in the usual location.
5371 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5372 verbose "result is $result"
5373 verbose "output is $output"
5378 # Workaround PR binutils/10802:
5379 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5380 set perm [file attributes ${stripped_file} -permissions]
5381 file attributes ${dest} -permissions $perm
5386 # Test the output of GDB_COMMAND matches the pattern obtained
5387 # by concatenating all elements of EXPECTED_LINES. This makes
5388 # it possible to split otherwise very long string into pieces.
5389 # If third argument is not empty, it's used as the name of the
5390 # test to be printed on pass/fail.
5391 proc help_test_raw { gdb_command expected_lines args } {
5392 set message $gdb_command
5393 if [llength $args]>0 then {
5394 set message [lindex $args 0]
5396 set expected_output [join $expected_lines ""]
5397 gdb_test "${gdb_command}" "${expected_output}" $message
5400 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5401 # are regular expressions that should match the beginning of output,
5402 # before the list of commands in that class. The presence of
5403 # command list and standard epilogue will be tested automatically.
5404 # Notice that the '[' and ']' characters don't need to be escaped for strings
5405 # wrapped in {} braces.
5406 proc test_class_help { command_class expected_initial_lines args } {
5408 "List of commands\:.*[\r\n]+"
5409 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5410 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5411 "Command name abbreviations are allowed if unambiguous\."
5413 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5415 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
5418 # COMMAND_LIST should have either one element -- command to test, or
5419 # two elements -- abbreviated command to test, and full command the first
5420 # element is abbreviation of.
5421 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5422 # are regular expressions that should match the beginning of output,
5423 # before the list of subcommands. The presence of
5424 # subcommand list and standard epilogue will be tested automatically.
5425 proc test_prefix_command_help { command_list expected_initial_lines args } {
5426 set command [lindex $command_list 0]
5427 if {[llength $command_list]>1} {
5428 set full_command [lindex $command_list 1]
5430 set full_command $command
5432 # Use 'list' and not just {} because we want variables to
5433 # be expanded in this list.
5434 set l_stock_body [list\
5435 "List of $full_command subcommands\:.*\[\r\n\]+"\
5436 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5437 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5438 "Command name abbreviations are allowed if unambiguous\."]
5439 set l_entire_body [concat $expected_initial_lines $l_stock_body]
5440 if {[llength $args]>0} {
5441 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5443 help_test_raw "help ${command}" $l_entire_body
5447 # Build executable named EXECUTABLE from specifications that allow
5448 # different options to be passed to different sub-compilations.
5449 # TESTNAME is the name of the test; this is passed to 'untested' if
5451 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
5452 # contains the option "pthreads", then gdb_compile_pthreads is used.
5453 # ARGS is a flat list of source specifications, of the form:
5454 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
5455 # Each SOURCE is compiled to an object file using its OPTIONS,
5456 # using gdb_compile.
5457 # Returns 0 on success, -1 on failure.
5458 proc build_executable_from_specs {testname executable options args} {
5462 set binfile [standard_output_file $executable]
5465 if { [lsearch -exact $options "c++"] >= 0 } {
5466 set info_options "c++"
5468 if [get_compiler_info ${info_options}] {
5472 set func gdb_compile
5473 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
5474 if {$func_index != -1} {
5475 set func "${func}_[lindex $options $func_index]"
5478 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
5479 # parameter. They also requires $sources while gdb_compile and
5480 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5481 if [string match gdb_compile_shlib* $func] {
5483 foreach {s local_options} $args {
5484 if { [regexp "^/" "$s"] } then {
5485 lappend sources_path "$s"
5487 lappend sources_path "$srcdir/$subdir/$s"
5490 set ret [$func $sources_path "${binfile}" $options]
5491 } elseif {[lsearch -exact $options rust] != -1} {
5493 foreach {s local_options} $args {
5494 if { [regexp "^/" "$s"] } then {
5495 lappend sources_path "$s"
5497 lappend sources_path "$srcdir/$subdir/$s"
5500 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
5504 foreach {s local_options} $args {
5505 if { ! [regexp "^/" "$s"] } then {
5506 set s "$srcdir/$subdir/$s"
5508 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
5512 lappend objects "${binfile}${i}.o"
5515 set ret [$func $objects "${binfile}" executable $options]
5525 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
5526 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
5527 # to pass to untested, if something is wrong. OPTIONS are passed
5528 # to gdb_compile directly.
5529 proc build_executable { testname executable {sources ""} {options {debug}} } {
5530 if {[llength $sources]==0} {
5531 set sources ${executable}.c
5534 set arglist [list $testname $executable $options]
5535 foreach source $sources {
5536 lappend arglist $source $options
5539 return [eval build_executable_from_specs $arglist]
5542 # Starts fresh GDB binary and loads an optional executable into GDB.
5543 # Usage: clean_restart [executable]
5544 # EXECUTABLE is the basename of the binary.
5546 proc clean_restart { args } {
5550 if { [llength $args] > 1 } {
5551 error "bad number of args: [llength $args]"
5556 gdb_reinitialize_dir $srcdir/$subdir
5558 if { [llength $args] >= 1 } {
5559 set executable [lindex $args 0]
5560 set binfile [standard_output_file ${executable}]
5565 # Prepares for testing by calling build_executable_full, then
5567 # TESTNAME is the name of the test.
5568 # Each element in ARGS is a list of the form
5569 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
5570 # These are passed to build_executable_from_specs, which see.
5571 # The last EXECUTABLE is passed to clean_restart.
5572 # Returns 0 on success, non-zero on failure.
5573 proc prepare_for_testing_full {testname args} {
5574 foreach spec $args {
5575 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
5578 set executable [lindex $spec 0]
5580 clean_restart $executable
5584 # Prepares for testing, by calling build_executable, and then clean_restart.
5585 # Please refer to build_executable for parameter description.
5586 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
5588 if {[build_executable $testname $executable $sources $options] == -1} {
5591 clean_restart $executable
5596 # Retrieve the value of EXP in the inferior, represented in format
5597 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
5598 # print fails. TEST is the test message to use. It can be omitted,
5599 # in which case a test message is built from EXP.
5601 proc get_valueof { fmt exp default {test ""} } {
5605 set test "get valueof \"${exp}\""
5609 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5610 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
5611 set val $expect_out(1,string)
5615 fail "$test (timeout)"
5621 # Retrieve the value of EXP in the inferior, as a signed decimal value
5622 # (using "print /d"). DEFAULT is used as fallback if print fails.
5623 # TEST is the test message to use. It can be omitted, in which case
5624 # a test message is built from EXP.
5626 proc get_integer_valueof { exp default {test ""} } {
5630 set test "get integer valueof \"${exp}\""
5634 gdb_test_multiple "print /d ${exp}" "$test" {
5635 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
5636 set val $expect_out(1,string)
5640 fail "$test (timeout)"
5646 # Retrieve the value of EXP in the inferior, as an hexadecimal value
5647 # (using "print /x"). DEFAULT is used as fallback if print fails.
5648 # TEST is the test message to use. It can be omitted, in which case
5649 # a test message is built from EXP.
5651 proc get_hexadecimal_valueof { exp default {test ""} } {
5655 set test "get hexadecimal valueof \"${exp}\""
5659 gdb_test_multiple "print /x ${exp}" $test {
5660 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
5661 set val $expect_out(1,string)
5668 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
5669 # is used as fallback if print fails. TEST is the test message to use.
5670 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
5672 proc get_sizeof { type default {test ""} } {
5673 return [get_integer_valueof "sizeof (${type})" $default $test]
5676 proc get_target_charset { } {
5679 gdb_test_multiple "show target-charset" "" {
5680 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
5681 return $expect_out(1,string)
5683 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
5684 return $expect_out(1,string)
5688 # Pick a reasonable default.
5689 warning "Unable to read target-charset."
5693 # Get the address of VAR.
5695 proc get_var_address { var } {
5696 global gdb_prompt hex
5698 # Match output like:
5700 # $5 = (int (*)()) 0
5701 # $6 = (int (*)()) 0x24 <function_bar>
5703 gdb_test_multiple "print &${var}" "get address of ${var}" {
5704 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
5706 pass "get address of ${var}"
5707 if { $expect_out(1,string) == "0" } {
5710 return $expect_out(1,string)
5717 # Get the current value for remotetimeout and return it.
5718 proc get_remotetimeout { } {
5722 gdb_test_multiple "show remotetimeout" "" {
5723 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
5724 return $expect_out(1,string)
5728 # Pick the default that gdb uses
5729 warning "Unable to read remotetimeout"
5733 # Set the remotetimeout to the specified timeout. Nothing is returned.
5734 proc set_remotetimeout { timeout } {
5737 gdb_test_multiple "set remotetimeout $timeout" "" {
5738 -re "$gdb_prompt $" {
5739 verbose "Set remotetimeout to $timeout\n"
5744 # Get the target's current endianness and return it.
5745 proc get_endianness { } {
5748 gdb_test_multiple "show endian" "determine endianness" {
5749 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
5751 return $expect_out(1,string)
5757 # ROOT and FULL are file names. Returns the relative path from ROOT
5758 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5759 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5762 proc relative_filename {root full} {
5763 set root_split [file split $root]
5764 set full_split [file split $full]
5766 set len [llength $root_split]
5768 if {[eval file join $root_split]
5769 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5770 error "$full not a subdir of $root"
5773 return [eval file join [lrange $full_split $len end]]
5776 # Log gdb command line and script if requested.
5777 if {[info exists TRANSCRIPT]} {
5778 rename send_gdb real_send_gdb
5779 rename remote_spawn real_remote_spawn
5780 rename remote_close real_remote_close
5782 global gdb_transcript
5783 set gdb_transcript ""
5785 global gdb_trans_count
5786 set gdb_trans_count 1
5788 proc remote_spawn {args} {
5789 global gdb_transcript gdb_trans_count outdir
5791 if {$gdb_transcript != ""} {
5792 close $gdb_transcript
5794 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5795 puts $gdb_transcript [lindex $args 1]
5796 incr gdb_trans_count
5798 return [uplevel real_remote_spawn $args]
5801 proc remote_close {args} {
5802 global gdb_transcript
5804 if {$gdb_transcript != ""} {
5805 close $gdb_transcript
5806 set gdb_transcript ""
5809 return [uplevel real_remote_close $args]
5812 proc send_gdb {args} {
5813 global gdb_transcript
5815 if {$gdb_transcript != ""} {
5816 puts -nonewline $gdb_transcript [lindex $args 0]
5819 return [uplevel real_send_gdb $args]
5823 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5824 if {[info exists GDB_PARALLEL]} {
5825 if {[is_remote host]} {
5829 [make_gdb_parallel_path outputs] \
5830 [make_gdb_parallel_path temp] \
5831 [make_gdb_parallel_path cache]
5835 proc core_find {binfile {deletefiles {}} {arg ""}} {
5836 global objdir subdir
5838 set destcore "$binfile.core"
5839 file delete $destcore
5841 # Create a core file named "$destcore" rather than just "core", to
5842 # avoid problems with sys admin types that like to regularly prune all
5843 # files named "core" from the system.
5845 # Arbitrarily try setting the core size limit to "unlimited" since
5846 # this does not hurt on systems where the command does not work and
5847 # allows us to generate a core on systems where it does.
5849 # Some systems append "core" to the name of the program; others append
5850 # the name of the program to "core"; still others (like Linux, as of
5851 # May 2003) create cores named "core.PID". In the latter case, we
5852 # could have many core files lying around, and it may be difficult to
5853 # tell which one is ours, so let's run the program in a subdirectory.
5855 set coredir [standard_output_file coredir.[getpid]]
5857 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
5858 # remote_exec host "${binfile}"
5859 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
5860 if [remote_file build exists $i] {
5861 remote_exec build "mv $i $destcore"
5865 # Check for "core.PID".
5866 if { $found == 0 } {
5867 set names [glob -nocomplain -directory $coredir core.*]
5868 if {[llength $names] == 1} {
5869 set corefile [file join $coredir [lindex $names 0]]
5870 remote_exec build "mv $corefile $destcore"
5874 if { $found == 0 } {
5875 # The braindamaged HPUX shell quits after the ulimit -c above
5876 # without executing ${binfile}. So we try again without the
5877 # ulimit here if we didn't find a core file above.
5878 # Oh, I should mention that any "braindamaged" non-Unix system has
5879 # the same problem. I like the cd bit too, it's really neat'n stuff.
5880 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
5881 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
5882 if [remote_file build exists $i] {
5883 remote_exec build "mv $i $destcore"
5889 # Try to clean up after ourselves.
5890 foreach deletefile $deletefiles {
5891 remote_file build delete [file join $coredir $deletefile]
5893 remote_exec build "rmdir $coredir"
5895 if { $found == 0 } {
5896 warning "can't generate a core file - core tests suppressed - check ulimit -c"
5902 # gdb_target_symbol_prefix compiles a test program and then examines
5903 # the output from objdump to determine the prefix (such as underscore)
5904 # for linker symbol prefixes.
5906 gdb_caching_proc gdb_target_symbol_prefix {
5907 # Set up and compile a simple test program...
5908 set src [standard_temp_file main[pid].c]
5909 set exe [standard_temp_file main[pid].x]
5911 gdb_produce_source $src {
5917 verbose "compiling testfile $src" 2
5918 set compile_flags {debug nowarnings quiet}
5919 set lines [gdb_compile $src $exe executable $compile_flags]
5923 if ![string match "" $lines] then {
5924 verbose "gdb_target_symbol_prefix: testfile compilation failed, returning null prefix" 2
5926 set objdump_program [gdb_find_objdump]
5927 set result [catch "exec $objdump_program --syms $exe" output]
5930 && ![regexp -lineanchor \
5931 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
5932 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
5942 # gdb_target_symbol returns the provided symbol with the correct prefix
5943 # prepended. (See gdb_target_symbol_prefix, above.)
5945 proc gdb_target_symbol { symbol } {
5946 set prefix [gdb_target_symbol_prefix]
5947 return "${prefix}${symbol}"
5950 # gdb_target_symbol_prefix_flags_asm returns a string that can be
5951 # added to gdb_compile options to define the C-preprocessor macro
5952 # SYMBOL_PREFIX with a value that can be prepended to symbols
5953 # for targets which require a prefix, such as underscore.
5955 # This version (_asm) defines the prefix without double quotes
5956 # surrounding the prefix. It is used to define the macro
5957 # SYMBOL_PREFIX for assembly language files. Another version, below,
5958 # is used for symbols in inline assembler in C/C++ files.
5960 # The lack of quotes in this version (_asm) makes it possible to
5961 # define supporting macros in the .S file. (The version which
5962 # uses quotes for the prefix won't work for such files since it's
5963 # impossible to define a quote-stripping macro in C.)
5965 # It's possible to use this version (_asm) for C/C++ source files too,
5966 # but a string is usually required in such files; providing a version
5967 # (no _asm) which encloses the prefix with double quotes makes it
5968 # somewhat easier to define the supporting macros in the test case.
5970 proc gdb_target_symbol_prefix_flags_asm {} {
5971 set prefix [gdb_target_symbol_prefix]
5972 if {$prefix ne ""} {
5973 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
5979 # gdb_target_symbol_prefix_flags returns the same string as
5980 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
5981 # enclosed in double quotes if there is a prefix.
5983 # See the comment for gdb_target_symbol_prefix_flags_asm for an
5984 # extended discussion.
5986 proc gdb_target_symbol_prefix_flags {} {
5987 set prefix [gdb_target_symbol_prefix]
5988 if {$prefix ne ""} {
5989 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
5995 # A wrapper for 'remote_exec host' that passes or fails a test.
5996 # Returns 0 if all went well, nonzero on failure.
5997 # TEST is the name of the test, other arguments are as for remote_exec.
5999 proc run_on_host { test program args } {
6000 verbose -log "run_on_host: $program $args"
6001 # remote_exec doesn't work properly if the output is set but the
6002 # input is the empty string -- so replace an empty input with
6004 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6005 set args [lreplace $args 1 1 "/dev/null"]
6007 set result [eval remote_exec host [list $program] $args]
6008 verbose "result is $result"
6009 set status [lindex $result 0]
6010 set output [lindex $result 1]
6015 verbose -log "run_on_host failed: $output"
6021 # Return non-zero if "board_info debug_flags" mentions Fission.
6022 # http://gcc.gnu.org/wiki/DebugFission
6023 # Fission doesn't support everything yet.
6024 # This supports working around bug 15954.
6026 proc using_fission { } {
6027 set debug_flags [board_info [target_info name] debug_flags]
6028 return [regexp -- "-gsplit-dwarf" $debug_flags]
6031 # Search the caller's ARGS list and set variables according to the list of
6032 # valid options described by ARGSET.
6034 # The first member of each one- or two-element list in ARGSET defines the
6035 # name of a variable that will be added to the caller's scope.
6037 # If only one element is given to describe an option, it the value is
6038 # 0 if the option is not present in (the caller's) ARGS or 1 if
6041 # If two elements are given, the second element is the default value of
6042 # the variable. This is then overwritten if the option exists in ARGS.
6044 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6045 # any optional components.
6048 # proc myproc {foo args} {
6049 # parse_args {{bar} {baz "abc"} {qux}}
6052 # myproc ABC -bar -baz DEF peanut butter
6053 # will define the following variables in myproc:
6054 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6055 # args will be the list {peanut butter}
6057 proc parse_args { argset } {
6060 foreach argument $argset {
6061 if {[llength $argument] == 1} {
6062 # No default specified, so we assume that we should set
6063 # the value to 1 if the arg is present and 0 if it's not.
6064 # It is assumed that no value is given with the argument.
6065 set result [lsearch -exact $args "-$argument"]
6066 if {$result != -1} then {
6067 uplevel 1 [list set $argument 1]
6068 set args [lreplace $args $result $result]
6070 uplevel 1 [list set $argument 0]
6072 } elseif {[llength $argument] == 2} {
6073 # There are two items in the argument. The second is a
6074 # default value to use if the item is not present.
6075 # Otherwise, the variable is set to whatever is provided
6076 # after the item in the args.
6077 set arg [lindex $argument 0]
6078 set result [lsearch -exact $args "-[lindex $arg 0]"]
6079 if {$result != -1} then {
6080 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6081 set args [lreplace $args $result [expr $result+1]]
6083 uplevel 1 [list set $arg [lindex $argument 1]]
6086 error "Badly formatted argument \"$argument\" in argument set"
6090 # The remaining args should be checked to see that they match the
6091 # number of items expected to be passed into the procedure...
6094 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6095 # return that string.
6097 proc capture_command_output { command prefix } {
6101 set output_string ""
6102 gdb_test_multiple "$command" "capture_command_output for $command" {
6103 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6104 set output_string $expect_out(1,string)
6107 return $output_string
6110 # A convenience function that joins all the arguments together, with a
6111 # regexp that matches exactly one end of line in between each argument.
6112 # This function is ideal to write the expected output of a GDB command
6113 # that generates more than a couple of lines, as this allows us to write
6114 # each line as a separate string, which is easier to read by a human
6117 proc multi_line { args } {
6118 return [join $args "\r\n"]
6121 # Similar to the above, but while multi_line is meant to be used to
6122 # match GDB output, this one is meant to be used to build strings to
6123 # send as GDB input.
6125 proc multi_line_input { args } {
6126 return [join $args "\n"]
6129 # Return the version of the DejaGnu framework.
6131 # The return value is a list containing the major, minor and patch version
6132 # numbers. If the version does not contain a minor or patch number, they will
6133 # be set to 0. For example:
6139 proc dejagnu_version { } {
6140 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6141 global frame_version
6143 verbose -log "DejaGnu version: $frame_version"
6144 verbose -log "Expect version: [exp_version]"
6145 verbose -log "Tcl version: [info tclversion]"
6147 set dg_ver [split $frame_version .]
6149 while { [llength $dg_ver] < 3 } {
6156 # Define user-defined command COMMAND using the COMMAND_LIST as the
6157 # command's definition. The terminating "end" is added automatically.
6159 proc gdb_define_cmd {command command_list} {
6162 set input [multi_line_input {*}$command_list "end"]
6163 set test "define $command"
6165 gdb_test_multiple "define $command" $test {
6167 gdb_test_multiple $input $test {
6168 -re "\r\n$gdb_prompt " {
6175 # Always load compatibility stuff.